diff --git a/clients/client-accessanalyzer/src/AccessAnalyzer.ts b/clients/client-accessanalyzer/src/AccessAnalyzer.ts index 1b060e94c6f6..3c653d6e747b 100644 --- a/clients/client-accessanalyzer/src/AccessAnalyzer.ts +++ b/clients/client-accessanalyzer/src/AccessAnalyzer.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { AccessAnalyzerClient } from "./AccessAnalyzerClient"; +import { AccessAnalyzerClient, AccessAnalyzerClientConfig } from "./AccessAnalyzerClient"; import { ApplyArchiveRuleCommand, ApplyArchiveRuleCommandInput, @@ -131,932 +132,475 @@ import { ValidatePolicyCommandOutput, } from "./commands/ValidatePolicyCommand"; -/** - * @public - *

Identity and Access Management Access Analyzer helps identify potential resource-access risks by enabling you to - * identify any policies that grant access to an external principal. It does this by using - * logic-based reasoning to analyze resource-based policies in your Amazon Web Services environment. An - * external principal can be another Amazon Web Services account, a root user, an IAM user or role, a - * federated user, an Amazon Web Services service, or an anonymous user. You can also use IAM Access Analyzer to - * preview and validate public and cross-account access to your resources before deploying - * permissions changes. This guide describes the Identity and Access Management Access Analyzer operations that you can - * call programmatically. For general information about IAM Access Analyzer, see Identity and Access Management Access Analyzer in the IAM User Guide.

- *

To start using IAM Access Analyzer, you first need to create an analyzer.

- */ -export class AccessAnalyzer extends AccessAnalyzerClient { +const commands = { + ApplyArchiveRuleCommand, + CancelPolicyGenerationCommand, + CreateAccessPreviewCommand, + CreateAnalyzerCommand, + CreateArchiveRuleCommand, + DeleteAnalyzerCommand, + DeleteArchiveRuleCommand, + GetAccessPreviewCommand, + GetAnalyzedResourceCommand, + GetAnalyzerCommand, + GetArchiveRuleCommand, + GetFindingCommand, + GetGeneratedPolicyCommand, + ListAccessPreviewFindingsCommand, + ListAccessPreviewsCommand, + ListAnalyzedResourcesCommand, + ListAnalyzersCommand, + ListArchiveRulesCommand, + ListFindingsCommand, + ListPolicyGenerationsCommand, + ListTagsForResourceCommand, + StartPolicyGenerationCommand, + StartResourceScanCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateArchiveRuleCommand, + UpdateFindingsCommand, + ValidatePolicyCommand, +}; + +export interface AccessAnalyzer { /** - * @public - *

Retroactively applies the archive rule to existing findings that meet the archive rule - * criteria.

+ * @see {@link ApplyArchiveRuleCommand} */ - public applyArchiveRule( + applyArchiveRule( args: ApplyArchiveRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public applyArchiveRule( + applyArchiveRule( args: ApplyArchiveRuleCommandInput, cb: (err: any, data?: ApplyArchiveRuleCommandOutput) => void ): void; - public applyArchiveRule( + applyArchiveRule( args: ApplyArchiveRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ApplyArchiveRuleCommandOutput) => void ): void; - public applyArchiveRule( - args: ApplyArchiveRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ApplyArchiveRuleCommandOutput) => void), - cb?: (err: any, data?: ApplyArchiveRuleCommandOutput) => void - ): Promise | void { - const command = new ApplyArchiveRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels the requested policy generation.

+ * @see {@link CancelPolicyGenerationCommand} */ - public cancelPolicyGeneration( + cancelPolicyGeneration( args: CancelPolicyGenerationCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelPolicyGeneration( + cancelPolicyGeneration( args: CancelPolicyGenerationCommandInput, cb: (err: any, data?: CancelPolicyGenerationCommandOutput) => void ): void; - public cancelPolicyGeneration( + cancelPolicyGeneration( args: CancelPolicyGenerationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelPolicyGenerationCommandOutput) => void ): void; - public cancelPolicyGeneration( - args: CancelPolicyGenerationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelPolicyGenerationCommandOutput) => void), - cb?: (err: any, data?: CancelPolicyGenerationCommandOutput) => void - ): Promise | void { - const command = new CancelPolicyGenerationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an access preview that allows you to preview IAM Access Analyzer findings for your - * resource before deploying resource permissions.

+ * @see {@link CreateAccessPreviewCommand} */ - public createAccessPreview( + createAccessPreview( args: CreateAccessPreviewCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAccessPreview( + createAccessPreview( args: CreateAccessPreviewCommandInput, cb: (err: any, data?: CreateAccessPreviewCommandOutput) => void ): void; - public createAccessPreview( + createAccessPreview( args: CreateAccessPreviewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessPreviewCommandOutput) => void ): void; - public createAccessPreview( - args: CreateAccessPreviewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAccessPreviewCommandOutput) => void), - cb?: (err: any, data?: CreateAccessPreviewCommandOutput) => void - ): Promise | void { - const command = new CreateAccessPreviewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an analyzer for your account.

+ * @see {@link CreateAnalyzerCommand} */ - public createAnalyzer( + createAnalyzer( args: CreateAnalyzerCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAnalyzer( - args: CreateAnalyzerCommandInput, - cb: (err: any, data?: CreateAnalyzerCommandOutput) => void - ): void; - public createAnalyzer( + createAnalyzer(args: CreateAnalyzerCommandInput, cb: (err: any, data?: CreateAnalyzerCommandOutput) => void): void; + createAnalyzer( args: CreateAnalyzerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAnalyzerCommandOutput) => void ): void; - public createAnalyzer( - args: CreateAnalyzerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAnalyzerCommandOutput) => void), - cb?: (err: any, data?: CreateAnalyzerCommandOutput) => void - ): Promise | void { - const command = new CreateAnalyzerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

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.

- *

To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide.

+ * @see {@link CreateArchiveRuleCommand} */ - public createArchiveRule( + createArchiveRule( args: CreateArchiveRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createArchiveRule( + createArchiveRule( args: CreateArchiveRuleCommandInput, cb: (err: any, data?: CreateArchiveRuleCommandOutput) => void ): void; - public createArchiveRule( + createArchiveRule( args: CreateArchiveRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateArchiveRuleCommandOutput) => void ): void; - public createArchiveRule( - args: CreateArchiveRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateArchiveRuleCommandOutput) => void), - cb?: (err: any, data?: CreateArchiveRuleCommandOutput) => void - ): Promise | void { - const command = new CreateArchiveRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

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.

+ * @see {@link DeleteAnalyzerCommand} */ - public deleteAnalyzer( + deleteAnalyzer( args: DeleteAnalyzerCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAnalyzer( - args: DeleteAnalyzerCommandInput, - cb: (err: any, data?: DeleteAnalyzerCommandOutput) => void - ): void; - public deleteAnalyzer( + deleteAnalyzer(args: DeleteAnalyzerCommandInput, cb: (err: any, data?: DeleteAnalyzerCommandOutput) => void): void; + deleteAnalyzer( args: DeleteAnalyzerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAnalyzerCommandOutput) => void ): void; - public deleteAnalyzer( - args: DeleteAnalyzerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAnalyzerCommandOutput) => void), - cb?: (err: any, data?: DeleteAnalyzerCommandOutput) => void - ): Promise | void { - const command = new DeleteAnalyzerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified archive rule.

+ * @see {@link DeleteArchiveRuleCommand} */ - public deleteArchiveRule( + deleteArchiveRule( args: DeleteArchiveRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteArchiveRule( + deleteArchiveRule( args: DeleteArchiveRuleCommandInput, cb: (err: any, data?: DeleteArchiveRuleCommandOutput) => void ): void; - public deleteArchiveRule( + deleteArchiveRule( args: DeleteArchiveRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteArchiveRuleCommandOutput) => void ): void; - public deleteArchiveRule( - args: DeleteArchiveRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteArchiveRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteArchiveRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteArchiveRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about an access preview for the specified analyzer.

+ * @see {@link GetAccessPreviewCommand} */ - public getAccessPreview( + getAccessPreview( args: GetAccessPreviewCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccessPreview( + getAccessPreview( args: GetAccessPreviewCommandInput, cb: (err: any, data?: GetAccessPreviewCommandOutput) => void ): void; - public getAccessPreview( + getAccessPreview( args: GetAccessPreviewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessPreviewCommandOutput) => void ): void; - public getAccessPreview( - args: GetAccessPreviewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccessPreviewCommandOutput) => void), - cb?: (err: any, data?: GetAccessPreviewCommandOutput) => void - ): Promise | void { - const command = new GetAccessPreviewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a resource that was analyzed.

+ * @see {@link GetAnalyzedResourceCommand} */ - public getAnalyzedResource( + getAnalyzedResource( args: GetAnalyzedResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAnalyzedResource( + getAnalyzedResource( args: GetAnalyzedResourceCommandInput, cb: (err: any, data?: GetAnalyzedResourceCommandOutput) => void ): void; - public getAnalyzedResource( + getAnalyzedResource( args: GetAnalyzedResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAnalyzedResourceCommandOutput) => void ): void; - public getAnalyzedResource( - args: GetAnalyzedResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAnalyzedResourceCommandOutput) => void), - cb?: (err: any, data?: GetAnalyzedResourceCommandOutput) => void - ): Promise | void { - const command = new GetAnalyzedResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the specified analyzer.

+ * @see {@link GetAnalyzerCommand} */ - public getAnalyzer(args: GetAnalyzerCommandInput, options?: __HttpHandlerOptions): Promise; - public getAnalyzer(args: GetAnalyzerCommandInput, cb: (err: any, data?: GetAnalyzerCommandOutput) => void): void; - public getAnalyzer( + getAnalyzer(args: GetAnalyzerCommandInput, options?: __HttpHandlerOptions): Promise; + getAnalyzer(args: GetAnalyzerCommandInput, cb: (err: any, data?: GetAnalyzerCommandOutput) => void): void; + getAnalyzer( args: GetAnalyzerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAnalyzerCommandOutput) => void ): void; - public getAnalyzer( - args: GetAnalyzerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAnalyzerCommandOutput) => void), - cb?: (err: any, data?: GetAnalyzerCommandOutput) => void - ): Promise | void { - const command = new GetAnalyzerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about an archive rule.

- *

To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide.

+ * @see {@link GetArchiveRuleCommand} */ - public getArchiveRule( + getArchiveRule( args: GetArchiveRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public getArchiveRule( - args: GetArchiveRuleCommandInput, - cb: (err: any, data?: GetArchiveRuleCommandOutput) => void - ): void; - public getArchiveRule( + getArchiveRule(args: GetArchiveRuleCommandInput, cb: (err: any, data?: GetArchiveRuleCommandOutput) => void): void; + getArchiveRule( args: GetArchiveRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetArchiveRuleCommandOutput) => void ): void; - public getArchiveRule( - args: GetArchiveRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetArchiveRuleCommandOutput) => void), - cb?: (err: any, data?: GetArchiveRuleCommandOutput) => void - ): Promise | void { - const command = new GetArchiveRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the specified finding.

+ * @see {@link GetFindingCommand} */ - public getFinding(args: GetFindingCommandInput, options?: __HttpHandlerOptions): Promise; - public getFinding(args: GetFindingCommandInput, cb: (err: any, data?: GetFindingCommandOutput) => void): void; - public getFinding( + getFinding(args: GetFindingCommandInput, options?: __HttpHandlerOptions): Promise; + getFinding(args: GetFindingCommandInput, cb: (err: any, data?: GetFindingCommandOutput) => void): void; + getFinding( args: GetFindingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFindingCommandOutput) => void ): void; - public getFinding( - args: GetFindingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFindingCommandOutput) => void), - cb?: (err: any, data?: GetFindingCommandOutput) => void - ): Promise | void { - const command = new GetFindingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the policy that was generated using StartPolicyGeneration. - *

+ * @see {@link GetGeneratedPolicyCommand} */ - public getGeneratedPolicy( + getGeneratedPolicy( args: GetGeneratedPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getGeneratedPolicy( + getGeneratedPolicy( args: GetGeneratedPolicyCommandInput, cb: (err: any, data?: GetGeneratedPolicyCommandOutput) => void ): void; - public getGeneratedPolicy( + getGeneratedPolicy( args: GetGeneratedPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGeneratedPolicyCommandOutput) => void ): void; - public getGeneratedPolicy( - args: GetGeneratedPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGeneratedPolicyCommandOutput) => void), - cb?: (err: any, data?: GetGeneratedPolicyCommandOutput) => void - ): Promise | void { - const command = new GetGeneratedPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of access preview findings generated by the specified access - * preview.

+ * @see {@link ListAccessPreviewFindingsCommand} */ - public listAccessPreviewFindings( + listAccessPreviewFindings( args: ListAccessPreviewFindingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAccessPreviewFindings( + listAccessPreviewFindings( args: ListAccessPreviewFindingsCommandInput, cb: (err: any, data?: ListAccessPreviewFindingsCommandOutput) => void ): void; - public listAccessPreviewFindings( + listAccessPreviewFindings( args: ListAccessPreviewFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessPreviewFindingsCommandOutput) => void ): void; - public listAccessPreviewFindings( - args: ListAccessPreviewFindingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccessPreviewFindingsCommandOutput) => void), - cb?: (err: any, data?: ListAccessPreviewFindingsCommandOutput) => void - ): Promise | void { - const command = new ListAccessPreviewFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of access previews for the specified analyzer.

+ * @see {@link ListAccessPreviewsCommand} */ - public listAccessPreviews( + listAccessPreviews( args: ListAccessPreviewsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAccessPreviews( + listAccessPreviews( args: ListAccessPreviewsCommandInput, cb: (err: any, data?: ListAccessPreviewsCommandOutput) => void ): void; - public listAccessPreviews( + listAccessPreviews( args: ListAccessPreviewsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessPreviewsCommandOutput) => void ): void; - public listAccessPreviews( - args: ListAccessPreviewsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccessPreviewsCommandOutput) => void), - cb?: (err: any, data?: ListAccessPreviewsCommandOutput) => void - ): Promise | void { - const command = new ListAccessPreviewsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of resources of the specified type that have been analyzed by the - * specified analyzer..

+ * @see {@link ListAnalyzedResourcesCommand} */ - public listAnalyzedResources( + listAnalyzedResources( args: ListAnalyzedResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAnalyzedResources( + listAnalyzedResources( args: ListAnalyzedResourcesCommandInput, cb: (err: any, data?: ListAnalyzedResourcesCommandOutput) => void ): void; - public listAnalyzedResources( + listAnalyzedResources( args: ListAnalyzedResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAnalyzedResourcesCommandOutput) => void ): void; - public listAnalyzedResources( - args: ListAnalyzedResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAnalyzedResourcesCommandOutput) => void), - cb?: (err: any, data?: ListAnalyzedResourcesCommandOutput) => void - ): Promise | void { - const command = new ListAnalyzedResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of analyzers.

+ * @see {@link ListAnalyzersCommand} */ - public listAnalyzers( - args: ListAnalyzersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listAnalyzers( - args: ListAnalyzersCommandInput, - cb: (err: any, data?: ListAnalyzersCommandOutput) => void - ): void; - public listAnalyzers( + listAnalyzers(args: ListAnalyzersCommandInput, options?: __HttpHandlerOptions): Promise; + listAnalyzers(args: ListAnalyzersCommandInput, cb: (err: any, data?: ListAnalyzersCommandOutput) => void): void; + listAnalyzers( args: ListAnalyzersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAnalyzersCommandOutput) => void ): void; - public listAnalyzers( - args: ListAnalyzersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAnalyzersCommandOutput) => void), - cb?: (err: any, data?: ListAnalyzersCommandOutput) => void - ): Promise | void { - const command = new ListAnalyzersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of archive rules created for the specified analyzer.

+ * @see {@link ListArchiveRulesCommand} */ - public listArchiveRules( + listArchiveRules( args: ListArchiveRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listArchiveRules( + listArchiveRules( args: ListArchiveRulesCommandInput, cb: (err: any, data?: ListArchiveRulesCommandOutput) => void ): void; - public listArchiveRules( + listArchiveRules( args: ListArchiveRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListArchiveRulesCommandOutput) => void ): void; - public listArchiveRules( - args: ListArchiveRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListArchiveRulesCommandOutput) => void), - cb?: (err: any, data?: ListArchiveRulesCommandOutput) => void - ): Promise | void { - const command = new ListArchiveRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of findings generated by the specified analyzer.

- *

To learn about filter keys that you can use to retrieve a list of findings, see IAM Access Analyzer filter keys in the IAM User Guide.

+ * @see {@link ListFindingsCommand} */ - public listFindings( - args: ListFindingsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listFindings(args: ListFindingsCommandInput, cb: (err: any, data?: ListFindingsCommandOutput) => void): void; - public listFindings( + listFindings(args: ListFindingsCommandInput, options?: __HttpHandlerOptions): Promise; + listFindings(args: ListFindingsCommandInput, cb: (err: any, data?: ListFindingsCommandOutput) => void): void; + listFindings( args: ListFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFindingsCommandOutput) => void ): void; - public listFindings( - args: ListFindingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFindingsCommandOutput) => void), - cb?: (err: any, data?: ListFindingsCommandOutput) => void - ): Promise | void { - const command = new ListFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all of the policy generations requested in the last seven days.

+ * @see {@link ListPolicyGenerationsCommand} */ - public listPolicyGenerations( + listPolicyGenerations( args: ListPolicyGenerationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPolicyGenerations( + listPolicyGenerations( args: ListPolicyGenerationsCommandInput, cb: (err: any, data?: ListPolicyGenerationsCommandOutput) => void ): void; - public listPolicyGenerations( + listPolicyGenerations( args: ListPolicyGenerationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPolicyGenerationsCommandOutput) => void ): void; - public listPolicyGenerations( - args: ListPolicyGenerationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPolicyGenerationsCommandOutput) => void), - cb?: (err: any, data?: ListPolicyGenerationsCommandOutput) => void - ): Promise | void { - const command = new ListPolicyGenerationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of tags applied to the specified resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts the policy generation request.

+ * @see {@link StartPolicyGenerationCommand} */ - public startPolicyGeneration( + startPolicyGeneration( args: StartPolicyGenerationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startPolicyGeneration( + startPolicyGeneration( args: StartPolicyGenerationCommandInput, cb: (err: any, data?: StartPolicyGenerationCommandOutput) => void ): void; - public startPolicyGeneration( + startPolicyGeneration( args: StartPolicyGenerationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartPolicyGenerationCommandOutput) => void ): void; - public startPolicyGeneration( - args: StartPolicyGenerationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartPolicyGenerationCommandOutput) => void), - cb?: (err: any, data?: StartPolicyGenerationCommandOutput) => void - ): Promise | void { - const command = new StartPolicyGenerationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Immediately starts a scan of the policies applied to the specified resource.

+ * @see {@link StartResourceScanCommand} */ - public startResourceScan( + startResourceScan( args: StartResourceScanCommandInput, options?: __HttpHandlerOptions ): Promise; - public startResourceScan( + startResourceScan( args: StartResourceScanCommandInput, cb: (err: any, data?: StartResourceScanCommandOutput) => void ): void; - public startResourceScan( + startResourceScan( args: StartResourceScanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartResourceScanCommandOutput) => void ): void; - public startResourceScan( - args: StartResourceScanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartResourceScanCommandOutput) => void), - cb?: (err: any, data?: StartResourceScanCommandOutput) => void - ): Promise | void { - const command = new StartResourceScanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a tag to the specified resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a tag from the specified resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the criteria and values for the specified archive rule.

+ * @see {@link UpdateArchiveRuleCommand} */ - public updateArchiveRule( + updateArchiveRule( args: UpdateArchiveRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateArchiveRule( + updateArchiveRule( args: UpdateArchiveRuleCommandInput, cb: (err: any, data?: UpdateArchiveRuleCommandOutput) => void ): void; - public updateArchiveRule( + updateArchiveRule( args: UpdateArchiveRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateArchiveRuleCommandOutput) => void ): void; - public updateArchiveRule( - args: UpdateArchiveRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateArchiveRuleCommandOutput) => void), - cb?: (err: any, data?: UpdateArchiveRuleCommandOutput) => void - ): Promise | void { - const command = new UpdateArchiveRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the status for the specified findings.

+ * @see {@link UpdateFindingsCommand} */ - public updateFindings( + updateFindings( args: UpdateFindingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFindings( - args: UpdateFindingsCommandInput, - cb: (err: any, data?: UpdateFindingsCommandOutput) => void - ): void; - public updateFindings( + updateFindings(args: UpdateFindingsCommandInput, cb: (err: any, data?: UpdateFindingsCommandOutput) => void): void; + updateFindings( args: UpdateFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFindingsCommandOutput) => void ): void; - public updateFindings( - args: UpdateFindingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFindingsCommandOutput) => void), - cb?: (err: any, data?: UpdateFindingsCommandOutput) => void - ): Promise | void { - const command = new UpdateFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

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.

+ * @see {@link ValidatePolicyCommand} */ - public validatePolicy( + validatePolicy( args: ValidatePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public validatePolicy( - args: ValidatePolicyCommandInput, - cb: (err: any, data?: ValidatePolicyCommandOutput) => void - ): void; - public validatePolicy( + validatePolicy(args: ValidatePolicyCommandInput, cb: (err: any, data?: ValidatePolicyCommandOutput) => void): void; + validatePolicy( args: ValidatePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidatePolicyCommandOutput) => void ): void; - public validatePolicy( - args: ValidatePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ValidatePolicyCommandOutput) => void), - cb?: (err: any, data?: ValidatePolicyCommandOutput) => void - ): Promise | void { - const command = new ValidatePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Identity and Access Management Access Analyzer helps identify potential resource-access risks by enabling you to + * identify any policies that grant access to an external principal. It does this by using + * logic-based reasoning to analyze resource-based policies in your Amazon Web Services environment. An + * external principal can be another Amazon Web Services account, a root user, an IAM user or role, a + * federated user, an Amazon Web Services service, or an anonymous user. You can also use IAM Access Analyzer to + * preview and validate public and cross-account access to your resources before deploying + * permissions changes. This guide describes the Identity and Access Management Access Analyzer operations that you can + * call programmatically. For general information about IAM Access Analyzer, see Identity and Access Management Access Analyzer in the IAM User Guide.

+ *

To start using IAM Access Analyzer, you first need to create an analyzer.

+ */ +export class AccessAnalyzer extends AccessAnalyzerClient implements AccessAnalyzer {} +createAggregatedClient(commands, AccessAnalyzer); diff --git a/clients/client-account/src/Account.ts b/clients/client-account/src/Account.ts index 5e059500033e..63bb4f696458 100644 --- a/clients/client-account/src/Account.ts +++ b/clients/client-account/src/Account.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { AccountClient } from "./AccountClient"; +import { AccountClient, AccountClientConfig } from "./AccountClient"; import { DeleteAlternateContactCommand, DeleteAlternateContactCommandInput, @@ -44,326 +45,158 @@ import { PutContactInformationCommandOutput, } from "./commands/PutContactInformationCommand"; -/** - * @public - *

Operations for Amazon Web Services Account Management

- */ -export class Account extends AccountClient { +const commands = { + DeleteAlternateContactCommand, + DisableRegionCommand, + EnableRegionCommand, + GetAlternateContactCommand, + GetContactInformationCommand, + GetRegionOptStatusCommand, + ListRegionsCommand, + PutAlternateContactCommand, + PutContactInformationCommand, +}; + +export interface Account { /** - * @public - *

Deletes the specified alternate contact from an Amazon Web Services account.

- *

For complete details about how to use the alternate contact operations, see Access or - * updating the alternate contacts.

- * - *

Before you can update the alternate contact information for an - * Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management - * and Organizations. For more information, see Enabling trusted access for - * Amazon Web Services Account Management.

- *
+ * @see {@link DeleteAlternateContactCommand} */ - public deleteAlternateContact( + deleteAlternateContact( args: DeleteAlternateContactCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAlternateContact( + deleteAlternateContact( args: DeleteAlternateContactCommandInput, cb: (err: any, data?: DeleteAlternateContactCommandOutput) => void ): void; - public deleteAlternateContact( + deleteAlternateContact( args: DeleteAlternateContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAlternateContactCommandOutput) => void ): void; - public deleteAlternateContact( - args: DeleteAlternateContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAlternateContactCommandOutput) => void), - cb?: (err: any, data?: DeleteAlternateContactCommandOutput) => void - ): Promise | void { - const command = new DeleteAlternateContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables (opts-out) a particular Region for an account.

+ * @see {@link DisableRegionCommand} */ - public disableRegion( - args: DisableRegionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public disableRegion( - args: DisableRegionCommandInput, - cb: (err: any, data?: DisableRegionCommandOutput) => void - ): void; - public disableRegion( + disableRegion(args: DisableRegionCommandInput, options?: __HttpHandlerOptions): Promise; + disableRegion(args: DisableRegionCommandInput, cb: (err: any, data?: DisableRegionCommandOutput) => void): void; + disableRegion( args: DisableRegionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableRegionCommandOutput) => void ): void; - public disableRegion( - args: DisableRegionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableRegionCommandOutput) => void), - cb?: (err: any, data?: DisableRegionCommandOutput) => void - ): Promise | void { - const command = new DisableRegionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables (opts-in) a particular Region for an account.

+ * @see {@link EnableRegionCommand} */ - public enableRegion( - args: EnableRegionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public enableRegion(args: EnableRegionCommandInput, cb: (err: any, data?: EnableRegionCommandOutput) => void): void; - public enableRegion( + enableRegion(args: EnableRegionCommandInput, options?: __HttpHandlerOptions): Promise; + enableRegion(args: EnableRegionCommandInput, cb: (err: any, data?: EnableRegionCommandOutput) => void): void; + enableRegion( args: EnableRegionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableRegionCommandOutput) => void ): void; - public enableRegion( - args: EnableRegionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableRegionCommandOutput) => void), - cb?: (err: any, data?: EnableRegionCommandOutput) => void - ): Promise | void { - const command = new EnableRegionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the specified alternate contact attached to an Amazon Web Services account.

- *

For complete details about how to use the alternate contact operations, see Access or - * updating the alternate contacts.

- * - *

Before you can update the alternate contact information for an - * Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management - * and Organizations. For more information, see Enabling trusted access for - * Amazon Web Services Account Management.

- *
+ * @see {@link GetAlternateContactCommand} */ - public getAlternateContact( + getAlternateContact( args: GetAlternateContactCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAlternateContact( + getAlternateContact( args: GetAlternateContactCommandInput, cb: (err: any, data?: GetAlternateContactCommandOutput) => void ): void; - public getAlternateContact( + getAlternateContact( args: GetAlternateContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAlternateContactCommandOutput) => void ): void; - public getAlternateContact( - args: GetAlternateContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAlternateContactCommandOutput) => void), - cb?: (err: any, data?: GetAlternateContactCommandOutput) => void - ): Promise | void { - const command = new GetAlternateContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the primary contact information of an Amazon Web Services account.

- *

For complete details about how to use the primary contact operations, see Update - * the primary and alternate contact information.

+ * @see {@link GetContactInformationCommand} */ - public getContactInformation( + getContactInformation( args: GetContactInformationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getContactInformation( + getContactInformation( args: GetContactInformationCommandInput, cb: (err: any, data?: GetContactInformationCommandOutput) => void ): void; - public getContactInformation( + getContactInformation( args: GetContactInformationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContactInformationCommandOutput) => void ): void; - public getContactInformation( - args: GetContactInformationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContactInformationCommandOutput) => void), - cb?: (err: any, data?: GetContactInformationCommandOutput) => void - ): Promise | void { - const command = new GetContactInformationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the opt-in status of a particular Region.

+ * @see {@link GetRegionOptStatusCommand} */ - public getRegionOptStatus( + getRegionOptStatus( args: GetRegionOptStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRegionOptStatus( + getRegionOptStatus( args: GetRegionOptStatusCommandInput, cb: (err: any, data?: GetRegionOptStatusCommandOutput) => void ): void; - public getRegionOptStatus( + getRegionOptStatus( args: GetRegionOptStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRegionOptStatusCommandOutput) => void ): void; - public getRegionOptStatus( - args: GetRegionOptStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRegionOptStatusCommandOutput) => void), - cb?: (err: any, data?: GetRegionOptStatusCommandOutput) => void - ): Promise | void { - const command = new GetRegionOptStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the Regions for a given account and their respective opt-in statuses. - * Optionally, this list can be filtered by the region-opt-status-contains - * parameter.

+ * @see {@link ListRegionsCommand} */ - public listRegions(args: ListRegionsCommandInput, options?: __HttpHandlerOptions): Promise; - public listRegions(args: ListRegionsCommandInput, cb: (err: any, data?: ListRegionsCommandOutput) => void): void; - public listRegions( + listRegions(args: ListRegionsCommandInput, options?: __HttpHandlerOptions): Promise; + listRegions(args: ListRegionsCommandInput, cb: (err: any, data?: ListRegionsCommandOutput) => void): void; + listRegions( args: ListRegionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRegionsCommandOutput) => void ): void; - public listRegions( - args: ListRegionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRegionsCommandOutput) => void), - cb?: (err: any, data?: ListRegionsCommandOutput) => void - ): Promise | void { - const command = new ListRegionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the specified alternate contact attached to an Amazon Web Services account.

- *

For complete details about how to use the alternate contact operations, see Access or - * updating the alternate contacts.

- * - *

Before you can update the alternate contact information for an - * Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management - * and Organizations. For more information, see Enabling trusted access for - * Amazon Web Services Account Management.

- *
+ * @see {@link PutAlternateContactCommand} */ - public putAlternateContact( + putAlternateContact( args: PutAlternateContactCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAlternateContact( + putAlternateContact( args: PutAlternateContactCommandInput, cb: (err: any, data?: PutAlternateContactCommandOutput) => void ): void; - public putAlternateContact( + putAlternateContact( args: PutAlternateContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAlternateContactCommandOutput) => void ): void; - public putAlternateContact( - args: PutAlternateContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAlternateContactCommandOutput) => void), - cb?: (err: any, data?: PutAlternateContactCommandOutput) => void - ): Promise | void { - const command = new PutAlternateContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the primary contact information of an Amazon Web Services account.

- *

For complete details about how to use the primary contact operations, see Update - * the primary and alternate contact information.

+ * @see {@link PutContactInformationCommand} */ - public putContactInformation( + putContactInformation( args: PutContactInformationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putContactInformation( + putContactInformation( args: PutContactInformationCommandInput, cb: (err: any, data?: PutContactInformationCommandOutput) => void ): void; - public putContactInformation( + putContactInformation( args: PutContactInformationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutContactInformationCommandOutput) => void ): void; - public putContactInformation( - args: PutContactInformationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutContactInformationCommandOutput) => void), - cb?: (err: any, data?: PutContactInformationCommandOutput) => void - ): Promise | void { - const command = new PutContactInformationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Operations for Amazon Web Services Account Management

+ */ +export class Account extends AccountClient implements Account {} +createAggregatedClient(commands, Account); diff --git a/clients/client-acm-pca/src/ACMPCA.ts b/clients/client-acm-pca/src/ACMPCA.ts index be5959f3ff92..7f04eee3e297 100644 --- a/clients/client-acm-pca/src/ACMPCA.ts +++ b/clients/client-acm-pca/src/ACMPCA.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { ACMPCAClient } from "./ACMPCAClient"; +import { ACMPCAClient, ACMPCAClientConfig } from "./ACMPCAClient"; import { CreateCertificateAuthorityAuditReportCommand, CreateCertificateAuthorityAuditReportCommandInput, @@ -106,1248 +107,413 @@ import { UpdateCertificateAuthorityCommandOutput, } from "./commands/UpdateCertificateAuthorityCommand"; -/** - * @public - *

This is the Amazon Web Services Private Certificate Authority API Reference. It provides descriptions, - * syntax, and usage examples for each of the actions and data types involved in creating - * and managing a private certificate authority (CA) for your organization.

- *

The documentation for each action shows the API request parameters and the JSON - * response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is - * tailored to the programming language or platform that you prefer. For more information, - * see Amazon Web Services SDKs.

- *

Each Amazon Web Services Private CA API operation has a quota that determines the number of times the - * operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates - * depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid - * request because the request exceeds the operation's quota for the number of requests per - * second. When a request is throttled, Amazon Web Services Private CA returns a ThrottlingException error. Amazon Web Services Private CA does not guarantee a minimum request - * rate for APIs.

- *

To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase, - * log into your Amazon Web Services account and visit the Service Quotas - * console.

- */ -export class ACMPCA extends ACMPCAClient { +const commands = { + CreateCertificateAuthorityCommand, + CreateCertificateAuthorityAuditReportCommand, + CreatePermissionCommand, + DeleteCertificateAuthorityCommand, + DeletePermissionCommand, + DeletePolicyCommand, + DescribeCertificateAuthorityCommand, + DescribeCertificateAuthorityAuditReportCommand, + GetCertificateCommand, + GetCertificateAuthorityCertificateCommand, + GetCertificateAuthorityCsrCommand, + GetPolicyCommand, + ImportCertificateAuthorityCertificateCommand, + IssueCertificateCommand, + ListCertificateAuthoritiesCommand, + ListPermissionsCommand, + ListTagsCommand, + PutPolicyCommand, + RestoreCertificateAuthorityCommand, + RevokeCertificateCommand, + TagCertificateAuthorityCommand, + UntagCertificateAuthorityCommand, + UpdateCertificateAuthorityCommand, +}; + +export interface ACMPCA { /** - * @public - *

Creates a root or subordinate private certificate authority (CA). You must specify the - * CA configuration, an optional configuration for Online Certificate Status Protocol - * (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional - * idempotency token to avoid accidental creation of multiple CAs. The CA configuration - * specifies the name of the algorithm and key size to be used to create the CA private - * key, the type of signing algorithm that the CA uses, and X.500 subject information. The - * OCSP configuration can optionally specify a custom URL for the OCSP responder. The CRL - * configuration specifies the CRL expiration period in days (the validity period of the - * CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 - * bucket that is included in certificates issued by the CA. If successful, this action - * returns the Amazon Resource Name (ARN) of the CA.

- * - *

Both Amazon Web Services Private CA and the IAM principal must have permission to write to - * the S3 bucket that you specify. If the IAM principal making the call - * does not have permission to write to the bucket, then an exception is - * thrown. For more information, see Access - * policies for CRLs in Amazon S3.

- *
- *

Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. - * For more information, see Encrypting Your - * CRLs.

+ * @see {@link CreateCertificateAuthorityCommand} */ - public createCertificateAuthority( + createCertificateAuthority( args: CreateCertificateAuthorityCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCertificateAuthority( + createCertificateAuthority( args: CreateCertificateAuthorityCommandInput, cb: (err: any, data?: CreateCertificateAuthorityCommandOutput) => void ): void; - public createCertificateAuthority( + createCertificateAuthority( args: CreateCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCertificateAuthorityCommandOutput) => void ): void; - public createCertificateAuthority( - args: CreateCertificateAuthorityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCertificateAuthorityCommandOutput) => void), - cb?: (err: any, data?: CreateCertificateAuthorityCommandOutput) => void - ): Promise | void { - const command = new CreateCertificateAuthorityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an audit report that lists every time that your CA private key is used. The - * report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate actions use - * the private key.

- * - *

Both Amazon Web Services Private CA and the IAM principal must have permission to write to - * the S3 bucket that you specify. If the IAM principal making the call - * does not have permission to write to the bucket, then an exception is - * thrown. For more information, see Access - * policies for CRLs in Amazon S3.

- *
- *

Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. - * For more information, see Encrypting Your Audit - * Reports.

- * - *

You can generate a maximum of one report every 30 minutes.

- *
+ * @see {@link CreateCertificateAuthorityAuditReportCommand} */ - public createCertificateAuthorityAuditReport( + createCertificateAuthorityAuditReport( args: CreateCertificateAuthorityAuditReportCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCertificateAuthorityAuditReport( + createCertificateAuthorityAuditReport( args: CreateCertificateAuthorityAuditReportCommandInput, cb: (err: any, data?: CreateCertificateAuthorityAuditReportCommandOutput) => void ): void; - public createCertificateAuthorityAuditReport( + createCertificateAuthorityAuditReport( args: CreateCertificateAuthorityAuditReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCertificateAuthorityAuditReportCommandOutput) => void ): void; - public createCertificateAuthorityAuditReport( - args: CreateCertificateAuthorityAuditReportCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateCertificateAuthorityAuditReportCommandOutput) => void), - cb?: (err: any, data?: CreateCertificateAuthorityAuditReportCommandOutput) => void - ): Promise | void { - const command = new CreateCertificateAuthorityAuditReportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Grants one or more permissions on a private CA to the Certificate Manager (ACM) service - * principal (acm.amazonaws.com). These permissions allow ACM to issue and - * renew ACM certificates that reside in the same Amazon Web Services account as the CA.

- *

You can list current permissions with the ListPermissions action and - * revoke them with the DeletePermission action.

- *

- * About Permissions - *

- *
    - *
  • - *

    If the private CA and the certificates it issues reside in the same - * account, you can use CreatePermission to grant permissions for ACM to - * carry out automatic certificate renewals.

    - *
  • - *
  • - *

    For automatic certificate renewal to succeed, the ACM service principal - * needs permissions to create, retrieve, and list certificates.

    - *
  • - *
  • - *

    If the private CA and the ACM certificates reside in different accounts, - * then permissions cannot be used to enable automatic renewals. Instead, - * the ACM certificate owner must set up a resource-based policy to enable - * cross-account issuance and renewals. For more information, see - * Using a Resource - * Based Policy with Amazon Web Services Private CA.

    - *
  • - *
+ * @see {@link CreatePermissionCommand} */ - public createPermission( + createPermission( args: CreatePermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPermission( + createPermission( args: CreatePermissionCommandInput, cb: (err: any, data?: CreatePermissionCommandOutput) => void ): void; - public createPermission( + createPermission( args: CreatePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePermissionCommandOutput) => void ): void; - public createPermission( - args: CreatePermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePermissionCommandOutput) => void), - cb?: (err: any, data?: CreatePermissionCommandOutput) => void - ): Promise | void { - const command = new CreatePermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a private certificate authority (CA). You must provide the Amazon Resource - * Name (ARN) of the private CA that you want to delete. You can find the ARN by calling - * the ListCertificateAuthorities action.

- * - *

Deleting a CA will invalidate other CAs and certificates below it in your CA - * hierarchy.

- *
- *

Before you can delete a CA that you have created and activated, you must disable it. - * To do this, call the UpdateCertificateAuthority action and set the CertificateAuthorityStatus parameter to DISABLED.

- *

Additionally, you can delete a CA if you are waiting for it to be created (that is, - * the status of the CA is CREATING). You can also delete it if the CA has - * been created but you haven't yet imported the signed certificate into Amazon Web Services Private CA (that - * is, the status of the CA is PENDING_CERTIFICATE).

- *

When you successfully call DeleteCertificateAuthority, the CA's status changes to - * DELETED. However, the CA won't be permanently deleted until the restoration - * period has passed. By default, if you do not set the - * PermanentDeletionTimeInDays parameter, the CA remains restorable for 30 - * days. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority action returns the time remaining in the - * restoration window of a private CA in the DELETED state. To restore an - * eligible CA, call the RestoreCertificateAuthority action.

+ * @see {@link DeleteCertificateAuthorityCommand} */ - public deleteCertificateAuthority( + deleteCertificateAuthority( args: DeleteCertificateAuthorityCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCertificateAuthority( + deleteCertificateAuthority( args: DeleteCertificateAuthorityCommandInput, cb: (err: any, data?: DeleteCertificateAuthorityCommandOutput) => void ): void; - public deleteCertificateAuthority( + deleteCertificateAuthority( args: DeleteCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCertificateAuthorityCommandOutput) => void ): void; - public deleteCertificateAuthority( - args: DeleteCertificateAuthorityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCertificateAuthorityCommandOutput) => void), - cb?: (err: any, data?: DeleteCertificateAuthorityCommandOutput) => void - ): Promise | void { - const command = new DeleteCertificateAuthorityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal - * (acm.amazonaws.com).

- *

These permissions allow ACM to issue and renew ACM certificates that reside in the - * same Amazon Web Services account as the CA. If you revoke these permissions, ACM will no longer - * renew the affected certificates automatically.

- *

Permissions can be granted with the CreatePermission action and - * listed with the ListPermissions action.

- *

- * About Permissions - *

- *
    - *
  • - *

    If the private CA and the certificates it issues reside in the same - * account, you can use CreatePermission to grant permissions for ACM to - * carry out automatic certificate renewals.

    - *
  • - *
  • - *

    For automatic certificate renewal to succeed, the ACM service principal - * needs permissions to create, retrieve, and list certificates.

    - *
  • - *
  • - *

    If the private CA and the ACM certificates reside in different accounts, - * then permissions cannot be used to enable automatic renewals. Instead, - * the ACM certificate owner must set up a resource-based policy to enable - * cross-account issuance and renewals. For more information, see - * Using a Resource - * Based Policy with Amazon Web Services Private CA.

    - *
  • - *
+ * @see {@link DeletePermissionCommand} */ - public deletePermission( + deletePermission( args: DeletePermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePermission( + deletePermission( args: DeletePermissionCommandInput, cb: (err: any, data?: DeletePermissionCommandOutput) => void ): void; - public deletePermission( + deletePermission( args: DeletePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePermissionCommandOutput) => void ): void; - public deletePermission( - args: DeletePermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePermissionCommandOutput) => void), - cb?: (err: any, data?: DeletePermissionCommandOutput) => void - ): Promise | void { - const command = new DeletePermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the resource-based policy attached to a private CA. Deletion will remove any - * access that the policy has granted. If there is no policy attached to the private CA, - * this action will return successful.

- *

If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM), - * the CA will be removed from all shares in which it was included.

- *

The Certificate Manager Service Linked Role that the policy supports is not affected when you - * delete the policy.

- *

The current policy can be shown with GetPolicy and updated with PutPolicy.

- *

- * About Policies - *

- *
    - *
  • - *

    A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to - * an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, - * see Using a Resource Based Policy with Amazon Web Services Private CA.

    - *
  • - *
  • - *

    A policy permits a user of Certificate Manager (ACM) to issue ACM certificates - * signed by a CA in another account.

    - *
  • - *
  • - *

    For ACM to manage automatic renewal of these certificates, - * the ACM user must configure a Service Linked Role (SLR). The SLR allows - * the ACM service to assume the identity of the user, subject to confirmation against the - * Amazon Web Services Private CA policy. For more information, see - * Using a - * Service Linked Role with ACM.

    - *
  • - *
  • - *

    Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, - * see Attach a Policy for Cross-Account - * Access.

    - *
  • - *
+ * @see {@link DeletePolicyCommand} */ - public deletePolicy( - args: DeletePolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deletePolicy(args: DeletePolicyCommandInput, cb: (err: any, data?: DeletePolicyCommandOutput) => void): void; - public deletePolicy( + deletePolicy(args: DeletePolicyCommandInput, options?: __HttpHandlerOptions): Promise; + deletePolicy(args: DeletePolicyCommandInput, cb: (err: any, data?: DeletePolicyCommandOutput) => void): void; + deletePolicy( args: DeletePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePolicyCommandOutput) => void ): void; - public deletePolicy( - args: DeletePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePolicyCommandOutput) => void), - cb?: (err: any, data?: DeletePolicyCommandOutput) => void - ): Promise | void { - const command = new DeletePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists information about your private certificate authority (CA) or one that has been - * shared with you. You specify the private CA on input by its ARN (Amazon Resource Name). - * The output contains the status of your CA. This can be any of the following:

- *
    - *
  • - *

    - * CREATING - Amazon Web Services Private CA is creating your private certificate - * authority.

    - *
  • - *
  • - *

    - * PENDING_CERTIFICATE - The certificate is pending. You must use - * your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA to sign your - * private CA CSR and then import it into Amazon Web Services Private CA.

    - *
  • - *
  • - *

    - * ACTIVE - Your private CA is active.

    - *
  • - *
  • - *

    - * DISABLED - Your private CA has been disabled.

    - *
  • - *
  • - *

    - * EXPIRED - Your private CA certificate has expired.

    - *
  • - *
  • - *

    - * FAILED - Your private CA has failed. Your CA can fail because of - * problems such a network outage or back-end Amazon Web Services failure or other errors. A - * failed CA can never return to the pending state. You must create a new CA. - *

    - *
  • - *
  • - *

    - * DELETED - Your private CA is within the restoration period, after - * which it is permanently deleted. The length of time remaining in the CA's - * restoration period is also included in this action's output.

    - *
  • - *
+ * @see {@link DescribeCertificateAuthorityCommand} */ - public describeCertificateAuthority( + describeCertificateAuthority( args: DescribeCertificateAuthorityCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCertificateAuthority( + describeCertificateAuthority( args: DescribeCertificateAuthorityCommandInput, cb: (err: any, data?: DescribeCertificateAuthorityCommandOutput) => void ): void; - public describeCertificateAuthority( + describeCertificateAuthority( args: DescribeCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCertificateAuthorityCommandOutput) => void ): void; - public describeCertificateAuthority( - args: DescribeCertificateAuthorityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCertificateAuthorityCommandOutput) => void), - cb?: (err: any, data?: DescribeCertificateAuthorityCommandOutput) => void - ): Promise | void { - const command = new DescribeCertificateAuthorityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action. Audit information is created - * every time the certificate authority (CA) private key is used. The private key is used - * when you call the IssueCertificate action or the - * RevokeCertificate action.

+ * @see {@link DescribeCertificateAuthorityAuditReportCommand} */ - public describeCertificateAuthorityAuditReport( + describeCertificateAuthorityAuditReport( args: DescribeCertificateAuthorityAuditReportCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCertificateAuthorityAuditReport( + describeCertificateAuthorityAuditReport( args: DescribeCertificateAuthorityAuditReportCommandInput, cb: (err: any, data?: DescribeCertificateAuthorityAuditReportCommandOutput) => void ): void; - public describeCertificateAuthorityAuditReport( + describeCertificateAuthorityAuditReport( args: DescribeCertificateAuthorityAuditReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCertificateAuthorityAuditReportCommandOutput) => void ): void; - public describeCertificateAuthorityAuditReport( - args: DescribeCertificateAuthorityAuditReportCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeCertificateAuthorityAuditReportCommandOutput) => void), - cb?: (err: any, data?: DescribeCertificateAuthorityAuditReportCommandOutput) => void - ): Promise | void { - const command = new DescribeCertificateAuthorityAuditReportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a certificate from your private CA or one that has been shared with you. The - * ARN of the certificate is returned when you call the IssueCertificate action. You - * must specify both the ARN of your private CA and the ARN of the issued certificate when - * calling the GetCertificate action. You can retrieve the - * certificate if it is in the ISSUED state. You can call - * the CreateCertificateAuthorityAuditReport action to create a report that - * contains information about all of the certificates issued and revoked by your private - * CA.

+ * @see {@link GetCertificateCommand} */ - public getCertificate( + getCertificate( args: GetCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCertificate( - args: GetCertificateCommandInput, - cb: (err: any, data?: GetCertificateCommandOutput) => void - ): void; - public getCertificate( + getCertificate(args: GetCertificateCommandInput, cb: (err: any, data?: GetCertificateCommandOutput) => void): void; + getCertificate( args: GetCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCertificateCommandOutput) => void ): void; - public getCertificate( - args: GetCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCertificateCommandOutput) => void), - cb?: (err: any, data?: GetCertificateCommandOutput) => void - ): Promise | void { - const command = new GetCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the certificate and certificate chain for your private certificate authority - * (CA) or one that has been shared with you. Both the certificate and the chain are base64 - * PEM-encoded. The chain does not include the CA certificate. Each certificate in the - * chain signs the one before it.

+ * @see {@link GetCertificateAuthorityCertificateCommand} */ - public getCertificateAuthorityCertificate( + getCertificateAuthorityCertificate( args: GetCertificateAuthorityCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCertificateAuthorityCertificate( + getCertificateAuthorityCertificate( args: GetCertificateAuthorityCertificateCommandInput, cb: (err: any, data?: GetCertificateAuthorityCertificateCommandOutput) => void ): void; - public getCertificateAuthorityCertificate( + getCertificateAuthorityCertificate( args: GetCertificateAuthorityCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCertificateAuthorityCertificateCommandOutput) => void ): void; - public getCertificateAuthorityCertificate( - args: GetCertificateAuthorityCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCertificateAuthorityCertificateCommandOutput) => void), - cb?: (err: any, data?: GetCertificateAuthorityCertificateCommandOutput) => void - ): Promise | void { - const command = new GetCertificateAuthorityCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the certificate signing request (CSR) for your private certificate authority - * (CA). The CSR is created when you call the CreateCertificateAuthority action. Sign the CSR with your Amazon Web Services Private CA-hosted - * or on-premises root or subordinate CA. Then import the signed certificate back into - * Amazon Web Services Private CA by calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a - * base64 PEM-encoded string.

+ * @see {@link GetCertificateAuthorityCsrCommand} */ - public getCertificateAuthorityCsr( + getCertificateAuthorityCsr( args: GetCertificateAuthorityCsrCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCertificateAuthorityCsr( + getCertificateAuthorityCsr( args: GetCertificateAuthorityCsrCommandInput, cb: (err: any, data?: GetCertificateAuthorityCsrCommandOutput) => void ): void; - public getCertificateAuthorityCsr( + getCertificateAuthorityCsr( args: GetCertificateAuthorityCsrCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCertificateAuthorityCsrCommandOutput) => void ): void; - public getCertificateAuthorityCsr( - args: GetCertificateAuthorityCsrCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCertificateAuthorityCsrCommandOutput) => void), - cb?: (err: any, data?: GetCertificateAuthorityCsrCommandOutput) => void - ): Promise | void { - const command = new GetCertificateAuthorityCsrCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the resource-based policy attached to a private CA. If either the private CA - * resource or the policy cannot be found, this action returns a - * ResourceNotFoundException.

- *

The policy can be attached or updated with PutPolicy and removed with DeletePolicy.

- *

- * About Policies - *

- *
    - *
  • - *

    A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to - * an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, - * see Using a Resource Based Policy with Amazon Web Services Private CA.

    - *
  • - *
  • - *

    A policy permits a user of Certificate Manager (ACM) to issue ACM certificates - * signed by a CA in another account.

    - *
  • - *
  • - *

    For ACM to manage automatic renewal of these certificates, - * the ACM user must configure a Service Linked Role (SLR). The SLR allows - * the ACM service to assume the identity of the user, subject to confirmation against the - * Amazon Web Services Private CA policy. For more information, see - * Using a - * Service Linked Role with ACM.

    - *
  • - *
  • - *

    Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, - * see Attach a Policy for Cross-Account - * Access.

    - *
  • - *
+ * @see {@link GetPolicyCommand} */ - public getPolicy(args: GetPolicyCommandInput, options?: __HttpHandlerOptions): Promise; - public getPolicy(args: GetPolicyCommandInput, cb: (err: any, data?: GetPolicyCommandOutput) => void): void; - public getPolicy( + getPolicy(args: GetPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + getPolicy(args: GetPolicyCommandInput, cb: (err: any, data?: GetPolicyCommandOutput) => void): void; + getPolicy( args: GetPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPolicyCommandOutput) => void ): void; - public getPolicy( - args: GetPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPolicyCommandOutput) => void), - cb?: (err: any, data?: GetPolicyCommandOutput) => void - ): Promise | void { - const command = new GetPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Imports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you - * are using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call - * this action, the following preparations must in place:

- *
    - *
  1. - *

    In Amazon Web Services Private CA, call the CreateCertificateAuthority action to create the private CA that you - * plan to back with the imported certificate.

    - *
  2. - *
  3. - *

    Call the GetCertificateAuthorityCsr action to generate a certificate signing - * request (CSR).

    - *
  4. - *
  5. - *

    Sign the CSR using a root or intermediate CA hosted by either an on-premises - * PKI hierarchy or by a commercial CA.

    - *
  6. - *
  7. - *

    Create a certificate chain and copy the signed certificate and the certificate - * chain to your working directory.

    - *
  8. - *
- *

Amazon Web Services Private CA supports three scenarios for installing a CA certificate:

- *
    - *
  • - *

    Installing a certificate for a root CA hosted by Amazon Web Services Private CA.

    - *
  • - *
  • - *

    Installing a subordinate CA certificate whose parent authority is hosted by - * Amazon Web Services Private CA.

    - *
  • - *
  • - *

    Installing a subordinate CA certificate whose parent authority is externally - * hosted.

    - *
  • - *
- *

The following additional requirements apply when you import a CA certificate.

- *
    - *
  • - *

    Only a self-signed certificate can be imported as a root CA.

    - *
  • - *
  • - *

    A self-signed certificate cannot be imported as a subordinate CA.

    - *
  • - *
  • - *

    Your certificate chain must not include the private CA certificate that you - * are importing.

    - *
  • - *
  • - *

    Your root CA must be the last certificate in your chain. The subordinate - * certificate, if any, that your root CA signed must be next to last. The - * subordinate certificate signed by the preceding subordinate CA must come next, - * and so on until your chain is built.

    - *
  • - *
  • - *

    The chain must be PEM-encoded.

    - *
  • - *
  • - *

    The maximum allowed size of a certificate is 32 KB.

    - *
  • - *
  • - *

    The maximum allowed size of a certificate chain is 2 MB.

    - *
  • - *
- *

- * Enforcement of Critical Constraints - *

- *

Amazon Web Services Private CA allows the following extensions to be marked critical in the imported CA - * certificate or chain.

- *
    - *
  • - *

    Basic constraints (must be marked critical)

    - *
  • - *
  • - *

    Subject alternative names

    - *
  • - *
  • - *

    Key usage

    - *
  • - *
  • - *

    Extended key usage

    - *
  • - *
  • - *

    Authority key identifier

    - *
  • - *
  • - *

    Subject key identifier

    - *
  • - *
  • - *

    Issuer alternative name

    - *
  • - *
  • - *

    Subject directory attributes

    - *
  • - *
  • - *

    Subject information access

    - *
  • - *
  • - *

    Certificate policies

    - *
  • - *
  • - *

    Policy mappings

    - *
  • - *
  • - *

    Inhibit anyPolicy

    - *
  • - *
- *

Amazon Web Services Private CA rejects the following extensions when they are marked critical in an - * imported CA certificate or chain.

- *
    - *
  • - *

    Name constraints

    - *
  • - *
  • - *

    Policy constraints

    - *
  • - *
  • - *

    CRL distribution points

    - *
  • - *
  • - *

    Authority information access

    - *
  • - *
  • - *

    Freshest CRL

    - *
  • - *
  • - *

    Any other extension

    - *
  • - *
+ * @see {@link ImportCertificateAuthorityCertificateCommand} */ - public importCertificateAuthorityCertificate( + importCertificateAuthorityCertificate( args: ImportCertificateAuthorityCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public importCertificateAuthorityCertificate( + importCertificateAuthorityCertificate( args: ImportCertificateAuthorityCertificateCommandInput, cb: (err: any, data?: ImportCertificateAuthorityCertificateCommandOutput) => void ): void; - public importCertificateAuthorityCertificate( + importCertificateAuthorityCertificate( args: ImportCertificateAuthorityCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportCertificateAuthorityCertificateCommandOutput) => void ): void; - public importCertificateAuthorityCertificate( - args: ImportCertificateAuthorityCertificateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ImportCertificateAuthorityCertificateCommandOutput) => void), - cb?: (err: any, data?: ImportCertificateAuthorityCertificateCommandOutput) => void - ): Promise | void { - const command = new ImportCertificateAuthorityCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Uses your private certificate authority (CA), or one that has been shared with you, to - * issue a client certificate. This action returns the Amazon Resource Name (ARN) of the - * certificate. You can retrieve the certificate by calling the GetCertificate action and - * specifying the ARN.

- * - *

You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the - * certificates that you issue by using Amazon Web Services Private CA.

- *
+ * @see {@link IssueCertificateCommand} */ - public issueCertificate( + issueCertificate( args: IssueCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public issueCertificate( + issueCertificate( args: IssueCertificateCommandInput, cb: (err: any, data?: IssueCertificateCommandOutput) => void ): void; - public issueCertificate( + issueCertificate( args: IssueCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IssueCertificateCommandOutput) => void ): void; - public issueCertificate( - args: IssueCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: IssueCertificateCommandOutput) => void), - cb?: (err: any, data?: IssueCertificateCommandOutput) => void - ): Promise | void { - const command = new IssueCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the private certificate authorities that you created by using the CreateCertificateAuthority action.

+ * @see {@link ListCertificateAuthoritiesCommand} */ - public listCertificateAuthorities( + listCertificateAuthorities( args: ListCertificateAuthoritiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCertificateAuthorities( + listCertificateAuthorities( args: ListCertificateAuthoritiesCommandInput, cb: (err: any, data?: ListCertificateAuthoritiesCommandOutput) => void ): void; - public listCertificateAuthorities( + listCertificateAuthorities( args: ListCertificateAuthoritiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCertificateAuthoritiesCommandOutput) => void ): void; - public listCertificateAuthorities( - args: ListCertificateAuthoritiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCertificateAuthoritiesCommandOutput) => void), - cb?: (err: any, data?: ListCertificateAuthoritiesCommandOutput) => void - ): Promise | void { - const command = new ListCertificateAuthoritiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service - * principal (acm.amazonaws.com).

- *

These permissions allow ACM to issue and renew ACM certificates that reside in the - * same Amazon Web Services account as the CA.

- *

Permissions can be granted with the CreatePermission action and - * revoked with the DeletePermission action.

- *

- * About Permissions - *

- *
    - *
  • - *

    If the private CA and the certificates it issues reside in the same - * account, you can use CreatePermission to grant permissions for ACM to - * carry out automatic certificate renewals.

    - *
  • - *
  • - *

    For automatic certificate renewal to succeed, the ACM service principal - * needs permissions to create, retrieve, and list certificates.

    - *
  • - *
  • - *

    If the private CA and the ACM certificates reside in different accounts, - * then permissions cannot be used to enable automatic renewals. Instead, - * the ACM certificate owner must set up a resource-based policy to enable - * cross-account issuance and renewals. For more information, see - * Using a Resource - * Based Policy with Amazon Web Services Private CA.

    - *
  • - *
+ * @see {@link ListPermissionsCommand} */ - public listPermissions( + listPermissions( args: ListPermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPermissions( - args: ListPermissionsCommandInput, - cb: (err: any, data?: ListPermissionsCommandOutput) => void - ): void; - public listPermissions( + listPermissions(args: ListPermissionsCommandInput, cb: (err: any, data?: ListPermissionsCommandOutput) => void): void; + listPermissions( args: ListPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPermissionsCommandOutput) => void ): void; - public listPermissions( - args: ListPermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPermissionsCommandOutput) => void), - cb?: (err: any, data?: ListPermissionsCommandOutput) => void - ): Promise | void { - const command = new ListPermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags, if any, that are associated with your private CA or one that has been - * shared with you. Tags are labels that you can use to identify and organize your CAs. - * Each tag consists of a key and an optional value. Call the TagCertificateAuthority - * action to add one or more tags to your CA. Call the UntagCertificateAuthority action to remove tags.

+ * @see {@link ListTagsCommand} */ - public listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; - public listTags( + listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; + listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; + listTags( args: ListTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsCommandOutput) => void ): void; - public listTags( - args: ListTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsCommandOutput) => void), - cb?: (err: any, data?: ListTagsCommandOutput) => void - ): Promise | void { - const command = new ListTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Attaches a resource-based policy to a private CA.

- *

A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access - * Manager (RAM). For more information, see Attach a Policy for Cross-Account - * Access.

- *

The policy can be displayed with GetPolicy and removed with DeletePolicy.

- *

- * About Policies - *

- *
    - *
  • - *

    A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to - * an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, - * see Using a Resource Based Policy with Amazon Web Services Private CA.

    - *
  • - *
  • - *

    A policy permits a user of Certificate Manager (ACM) to issue ACM certificates - * signed by a CA in another account.

    - *
  • - *
  • - *

    For ACM to manage automatic renewal of these certificates, - * the ACM user must configure a Service Linked Role (SLR). The SLR allows - * the ACM service to assume the identity of the user, subject to confirmation against the - * Amazon Web Services Private CA policy. For more information, see - * Using a - * Service Linked Role with ACM.

    - *
  • - *
  • - *

    Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, - * see Attach a Policy for Cross-Account - * Access.

    - *
  • - *
+ * @see {@link PutPolicyCommand} */ - public putPolicy(args: PutPolicyCommandInput, options?: __HttpHandlerOptions): Promise; - public putPolicy(args: PutPolicyCommandInput, cb: (err: any, data?: PutPolicyCommandOutput) => void): void; - public putPolicy( + putPolicy(args: PutPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + putPolicy(args: PutPolicyCommandInput, cb: (err: any, data?: PutPolicyCommandOutput) => void): void; + putPolicy( args: PutPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPolicyCommandOutput) => void ): void; - public putPolicy( - args: PutPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutPolicyCommandOutput) => void), - cb?: (err: any, data?: PutPolicyCommandOutput) => void - ): Promise | void { - const command = new PutPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Restores a certificate authority (CA) that is in the DELETED state. You - * can restore a CA during the period that you defined in the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority action. Currently, you can specify 7 to 30 days. - * If you did not specify a PermanentDeletionTimeInDays - * value, by default you can restore the CA at any time in a 30 day period. You can check - * the time remaining in the restoration period of a private CA in the DELETED - * state by calling the DescribeCertificateAuthority or ListCertificateAuthorities actions. The status of a restored CA is set to - * its pre-deletion status when the RestoreCertificateAuthority action returns. To change its status to - * ACTIVE, call the UpdateCertificateAuthority action. If the private CA was in the - * PENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate action to import a certificate - * authority into the private CA before it can be activated. You cannot restore a CA after - * the restoration period has ended.

+ * @see {@link RestoreCertificateAuthorityCommand} */ - public restoreCertificateAuthority( + restoreCertificateAuthority( args: RestoreCertificateAuthorityCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreCertificateAuthority( + restoreCertificateAuthority( args: RestoreCertificateAuthorityCommandInput, cb: (err: any, data?: RestoreCertificateAuthorityCommandOutput) => void ): void; - public restoreCertificateAuthority( + restoreCertificateAuthority( args: RestoreCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreCertificateAuthorityCommandOutput) => void ): void; - public restoreCertificateAuthority( - args: RestoreCertificateAuthorityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreCertificateAuthorityCommandOutput) => void), - cb?: (err: any, data?: RestoreCertificateAuthorityCommandOutput) => void - ): Promise | void { - const command = new RestoreCertificateAuthorityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Revokes a certificate that was issued inside Amazon Web Services Private CA. If you enable a certificate - * revocation list (CRL) when you create or update your private CA, information about the - * revoked certificates will be included in the CRL. Amazon Web Services Private CA writes the CRL to an S3 - * bucket that you specify. A CRL is typically updated approximately 30 minutes after a - * certificate is revoked. If for any reason the CRL update fails, Amazon Web Services Private CA attempts - * makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms - * for the metrics CRLGenerated and MisconfiguredCRLBucket. For - * more information, see Supported CloudWatch Metrics.

- * - *

Both Amazon Web Services Private CA and the IAM principal must have permission to write to - * the S3 bucket that you specify. If the IAM principal making the call - * does not have permission to write to the bucket, then an exception is - * thrown. For more information, see Access - * policies for CRLs in Amazon S3.

- *
- *

Amazon Web Services Private CA also writes revocation information to the audit report. For more - * information, see CreateCertificateAuthorityAuditReport.

- * - *

You cannot revoke a root CA self-signed certificate.

- *
+ * @see {@link RevokeCertificateCommand} */ - public revokeCertificate( + revokeCertificate( args: RevokeCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public revokeCertificate( + revokeCertificate( args: RevokeCertificateCommandInput, cb: (err: any, data?: RevokeCertificateCommandOutput) => void ): void; - public revokeCertificate( + revokeCertificate( args: RevokeCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeCertificateCommandOutput) => void ): void; - public revokeCertificate( - args: RevokeCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RevokeCertificateCommandOutput) => void), - cb?: (err: any, data?: RevokeCertificateCommandOutput) => void - ): Promise | void { - const command = new RevokeCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more tags to your private CA. Tags are labels that you can use to identify - * and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You - * specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag - * by using a key-value pair. You can apply a tag to just one private CA if you want to - * identify a specific characteristic of that CA, or you can apply the same tag to multiple - * private CAs if you want to filter for a common relationship among those CAs. To remove - * one or more tags, use the UntagCertificateAuthority action. Call the ListTags action to see what tags are - * associated with your CA.

- * - *

To attach tags to a private CA during the creation procedure, a CA administrator - * must first associate an inline IAM policy with the - * CreateCertificateAuthority action and explicitly allow tagging. For - * more information, see Attaching tags to a CA - * at the time of creation.

- *
+ * @see {@link TagCertificateAuthorityCommand} */ - public tagCertificateAuthority( + tagCertificateAuthority( args: TagCertificateAuthorityCommandInput, options?: __HttpHandlerOptions ): Promise; - public tagCertificateAuthority( + tagCertificateAuthority( args: TagCertificateAuthorityCommandInput, cb: (err: any, data?: TagCertificateAuthorityCommandOutput) => void ): void; - public tagCertificateAuthority( + tagCertificateAuthority( args: TagCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagCertificateAuthorityCommandOutput) => void ): void; - public tagCertificateAuthority( - args: TagCertificateAuthorityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagCertificateAuthorityCommandOutput) => void), - cb?: (err: any, data?: TagCertificateAuthorityCommandOutput) => void - ): Promise | void { - const command = new TagCertificateAuthorityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Remove one or more tags from your private CA. A tag consists of a key-value pair. If - * you do not specify the value portion of the tag when calling this action, the tag will - * be removed regardless of value. If you specify a value, the tag is removed only if it is - * associated with the specified value. To add tags to a private CA, use the TagCertificateAuthority. Call the ListTags action to see what tags are - * associated with your CA.

+ * @see {@link UntagCertificateAuthorityCommand} */ - public untagCertificateAuthority( + untagCertificateAuthority( args: UntagCertificateAuthorityCommandInput, options?: __HttpHandlerOptions ): Promise; - public untagCertificateAuthority( + untagCertificateAuthority( args: UntagCertificateAuthorityCommandInput, cb: (err: any, data?: UntagCertificateAuthorityCommandOutput) => void ): void; - public untagCertificateAuthority( + untagCertificateAuthority( args: UntagCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagCertificateAuthorityCommandOutput) => void ): void; - public untagCertificateAuthority( - args: UntagCertificateAuthorityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagCertificateAuthorityCommandOutput) => void), - cb?: (err: any, data?: UntagCertificateAuthorityCommandOutput) => void - ): Promise | void { - const command = new UntagCertificateAuthorityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the status or configuration of a private certificate authority (CA). Your - * private CA must be in the ACTIVE or DISABLED state before you - * can update it. You can disable a private CA that is in the ACTIVE state or - * make a CA that is in the DISABLED state active again.

- * - *

Both Amazon Web Services Private CA and the IAM principal must have permission to write to - * the S3 bucket that you specify. If the IAM principal making the call - * does not have permission to write to the bucket, then an exception is - * thrown. For more information, see Access - * policies for CRLs in Amazon S3.

- *
+ * @see {@link UpdateCertificateAuthorityCommand} */ - public updateCertificateAuthority( + updateCertificateAuthority( args: UpdateCertificateAuthorityCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCertificateAuthority( + updateCertificateAuthority( args: UpdateCertificateAuthorityCommandInput, cb: (err: any, data?: UpdateCertificateAuthorityCommandOutput) => void ): void; - public updateCertificateAuthority( + updateCertificateAuthority( args: UpdateCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCertificateAuthorityCommandOutput) => void ): void; - public updateCertificateAuthority( - args: UpdateCertificateAuthorityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCertificateAuthorityCommandOutput) => void), - cb?: (err: any, data?: UpdateCertificateAuthorityCommandOutput) => void - ): Promise | void { - const command = new UpdateCertificateAuthorityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

This is the Amazon Web Services Private Certificate Authority API Reference. It provides descriptions, + * syntax, and usage examples for each of the actions and data types involved in creating + * and managing a private certificate authority (CA) for your organization.

+ *

The documentation for each action shows the API request parameters and the JSON + * response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is + * tailored to the programming language or platform that you prefer. For more information, + * see Amazon Web Services SDKs.

+ *

Each Amazon Web Services Private CA API operation has a quota that determines the number of times the + * operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates + * depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid + * request because the request exceeds the operation's quota for the number of requests per + * second. When a request is throttled, Amazon Web Services Private CA returns a ThrottlingException error. Amazon Web Services Private CA does not guarantee a minimum request + * rate for APIs.

+ *

To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase, + * log into your Amazon Web Services account and visit the Service Quotas + * console.

+ */ +export class ACMPCA extends ACMPCAClient implements ACMPCA {} +createAggregatedClient(commands, ACMPCA); diff --git a/clients/client-acm/src/ACM.ts b/clients/client-acm/src/ACM.ts index 27ade0a70b8e..4babb127f827 100644 --- a/clients/client-acm/src/ACM.ts +++ b/clients/client-acm/src/ACM.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { ACMClient } from "./ACMClient"; +import { ACMClient, ACMClientConfig } from "./ACMClient"; import { AddTagsToCertificateCommand, AddTagsToCertificateCommandInput, @@ -78,648 +79,283 @@ import { UpdateCertificateOptionsCommandOutput, } from "./commands/UpdateCertificateOptionsCommand"; -/** - * @public - * Certificate Manager - *

You can use Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites - * and applications. For more information about using ACM, see the Certificate Manager User Guide.

- */ -export class ACM extends ACMClient { +const commands = { + AddTagsToCertificateCommand, + DeleteCertificateCommand, + DescribeCertificateCommand, + ExportCertificateCommand, + GetAccountConfigurationCommand, + GetCertificateCommand, + ImportCertificateCommand, + ListCertificatesCommand, + ListTagsForCertificateCommand, + PutAccountConfigurationCommand, + RemoveTagsFromCertificateCommand, + RenewCertificateCommand, + RequestCertificateCommand, + ResendValidationEmailCommand, + UpdateCertificateOptionsCommand, +}; + +export interface ACM { /** - * @public - *

Adds one or more tags to an ACM certificate. Tags are labels that you can use to - * identify and organize your Amazon Web Services resources. Each tag consists of a key and an - * optional value. You specify the certificate on input by its Amazon Resource Name - * (ARN). You specify the tag by using a key-value pair.

- *

You can apply a tag to just one certificate if you want to identify a specific - * characteristic of that certificate, or you can apply the same tag to multiple certificates if - * you want to filter for a common relationship among those certificates. Similarly, you can - * apply the same tag to multiple resources if you want to specify a relationship among those - * resources. For example, you can add the same tag to an ACM certificate and an Elastic Load - * Balancing load balancer to indicate that they are both used by the same website. For more - * information, see Tagging ACM - * certificates.

- *

To remove one or more tags, use the RemoveTagsFromCertificate action. To - * view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.

+ * @see {@link AddTagsToCertificateCommand} */ - public addTagsToCertificate( + addTagsToCertificate( args: AddTagsToCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public addTagsToCertificate( + addTagsToCertificate( args: AddTagsToCertificateCommandInput, cb: (err: any, data?: AddTagsToCertificateCommandOutput) => void ): void; - public addTagsToCertificate( + addTagsToCertificate( args: AddTagsToCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsToCertificateCommandOutput) => void ): void; - public addTagsToCertificate( - args: AddTagsToCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddTagsToCertificateCommandOutput) => void), - cb?: (err: any, data?: AddTagsToCertificateCommandOutput) => void - ): Promise | void { - const command = new AddTagsToCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a certificate and its associated private key. If this action succeeds, the - * certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by Amazon Web Services - * services integrated with ACM.

- * - *

You cannot delete an ACM certificate that is being used by another Amazon Web Services service. To - * delete a certificate that is in use, the certificate association must first be - * removed.

- *
+ * @see {@link DeleteCertificateCommand} */ - public deleteCertificate( + deleteCertificate( args: DeleteCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCertificate( + deleteCertificate( args: DeleteCertificateCommandInput, cb: (err: any, data?: DeleteCertificateCommandOutput) => void ): void; - public deleteCertificate( + deleteCertificate( args: DeleteCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCertificateCommandOutput) => void ): void; - public deleteCertificate( - args: DeleteCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCertificateCommandOutput) => void), - cb?: (err: any, data?: DeleteCertificateCommandOutput) => void - ): Promise | void { - const command = new DeleteCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns detailed metadata about the specified ACM certificate.

- *

If you have just created a certificate using the RequestCertificate action, - * there is a delay of several seconds before you can retrieve information about it.

+ * @see {@link DescribeCertificateCommand} */ - public describeCertificate( + describeCertificate( args: DescribeCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCertificate( + describeCertificate( args: DescribeCertificateCommandInput, cb: (err: any, data?: DescribeCertificateCommandOutput) => void ): void; - public describeCertificate( + describeCertificate( args: DescribeCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCertificateCommandOutput) => void ): void; - public describeCertificate( - args: DescribeCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCertificateCommandOutput) => void), - cb?: (err: any, data?: DescribeCertificateCommandOutput) => void - ): Promise | void { - const command = new DescribeCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Exports a private certificate issued by a private certificate authority (CA) for use - * anywhere. The exported file contains the certificate, the certificate chain, and the encrypted - * private 2048-bit RSA key associated with the public key that is embedded in the certificate. - * For security, you must assign a passphrase for the private key when exporting it.

- *

For information about exporting and formatting a certificate using the ACM console or - * CLI, see Export a - * Private Certificate.

+ * @see {@link ExportCertificateCommand} */ - public exportCertificate( + exportCertificate( args: ExportCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public exportCertificate( + exportCertificate( args: ExportCertificateCommandInput, cb: (err: any, data?: ExportCertificateCommandOutput) => void ): void; - public exportCertificate( + exportCertificate( args: ExportCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportCertificateCommandOutput) => void ): void; - public exportCertificate( - args: ExportCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportCertificateCommandOutput) => void), - cb?: (err: any, data?: ExportCertificateCommandOutput) => void - ): Promise | void { - const command = new ExportCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the account configuration options associated with an Amazon Web Services account.

+ * @see {@link GetAccountConfigurationCommand} */ - public getAccountConfiguration( + getAccountConfiguration( args: GetAccountConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccountConfiguration( + getAccountConfiguration( args: GetAccountConfigurationCommandInput, cb: (err: any, data?: GetAccountConfigurationCommandOutput) => void ): void; - public getAccountConfiguration( + getAccountConfiguration( args: GetAccountConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountConfigurationCommandOutput) => void ): void; - public getAccountConfiguration( - args: GetAccountConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccountConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetAccountConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetAccountConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves an Amazon-issued certificate and its certificate chain. The chain consists of - * the certificate of the issuing CA and the intermediate certificates of any other subordinate - * CAs. All of the certificates are base64 encoded. You can use OpenSSL to decode - * the certificates and inspect individual fields.

+ * @see {@link GetCertificateCommand} */ - public getCertificate( + getCertificate( args: GetCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCertificate( - args: GetCertificateCommandInput, - cb: (err: any, data?: GetCertificateCommandOutput) => void - ): void; - public getCertificate( + getCertificate(args: GetCertificateCommandInput, cb: (err: any, data?: GetCertificateCommandOutput) => void): void; + getCertificate( args: GetCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCertificateCommandOutput) => void ): void; - public getCertificate( - args: GetCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCertificateCommandOutput) => void), - cb?: (err: any, data?: GetCertificateCommandOutput) => void - ): Promise | void { - const command = new GetCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with - * ACM. Note that integrated - * services allow only certificate types and keys they support to be associated with - * their resources. Further, their support differs depending on whether the certificate is - * imported into IAM or into ACM. For more information, see the documentation for each - * service. For more information about importing certificates into ACM, see Importing - * Certificates in the Certificate Manager User Guide.

- * - *

ACM does not provide managed renewal for certificates that you import.

- *
- *

Note the following guidelines when importing third party certificates:

- *
    - *
  • - *

    You must enter the private key that matches the certificate you are importing.

    - *
  • - *
  • - *

    The private key must be unencrypted. You cannot import a private key that is protected - * by a password or a passphrase.

    - *
  • - *
  • - *

    The private key must be no larger than 5 KB (5,120 bytes).

    - *
  • - *
  • - *

    If the certificate you are importing is not self-signed, you must enter its - * certificate chain.

    - *
  • - *
  • - *

    If a certificate chain is included, the issuer must be the subject of one of the - * certificates in the chain.

    - *
  • - *
  • - *

    The certificate, private key, and certificate chain must be PEM-encoded.

    - *
  • - *
  • - *

    The current time must be between the Not Before and Not - * After certificate fields.

    - *
  • - *
  • - *

    The Issuer field must not be empty.

    - *
  • - *
  • - *

    The OCSP authority URL, if present, must not exceed 1000 characters.

    - *
  • - *
  • - *

    To import a new certificate, omit the CertificateArn argument. Include - * this argument only when you want to replace a previously imported certificate.

    - *
  • - *
  • - *

    When you import a certificate by using the CLI, you must specify the certificate, the - * certificate chain, and the private key by their file names preceded by - * fileb://. For example, you can specify a certificate saved in the - * C:\temp folder as fileb://C:\temp\certificate_to_import.pem. - * If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs. - *

    - *
  • - *
  • - *

    When you import a certificate by using an SDK, you must specify the certificate, the - * certificate chain, and the private key files in the manner required by the programming - * language you're using.

    - *
  • - *
  • - *

    The cryptographic algorithm of an imported certificate must match the algorithm of the - * signing CA. For example, if the signing CA key type is RSA, then the certificate key type - * must also be RSA.

    - *
  • - *
- *

This operation returns the Amazon - * Resource Name (ARN) of the imported certificate.

+ * @see {@link ImportCertificateCommand} */ - public importCertificate( + importCertificate( args: ImportCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public importCertificate( + importCertificate( args: ImportCertificateCommandInput, cb: (err: any, data?: ImportCertificateCommandOutput) => void ): void; - public importCertificate( + importCertificate( args: ImportCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportCertificateCommandOutput) => void ): void; - public importCertificate( - args: ImportCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportCertificateCommandOutput) => void), - cb?: (err: any, data?: ImportCertificateCommandOutput) => void - ): Promise | void { - const command = new ImportCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of certificate ARNs and domain names. You can request that only - * certificates that match a specific status be listed. You can also filter by specific - * attributes of the certificate. Default filtering returns only RSA_2048 - * certificates. For more information, see Filters.

+ * @see {@link ListCertificatesCommand} */ - public listCertificates( + listCertificates( args: ListCertificatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCertificates( + listCertificates( args: ListCertificatesCommandInput, cb: (err: any, data?: ListCertificatesCommandOutput) => void ): void; - public listCertificates( + listCertificates( args: ListCertificatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCertificatesCommandOutput) => void ): void; - public listCertificates( - args: ListCertificatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCertificatesCommandOutput) => void), - cb?: (err: any, data?: ListCertificatesCommandOutput) => void - ): Promise | void { - const command = new ListCertificatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags that have been applied to the ACM certificate. Use the certificate's - * Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, - * use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.

+ * @see {@link ListTagsForCertificateCommand} */ - public listTagsForCertificate( + listTagsForCertificate( args: ListTagsForCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForCertificate( + listTagsForCertificate( args: ListTagsForCertificateCommandInput, cb: (err: any, data?: ListTagsForCertificateCommandOutput) => void ): void; - public listTagsForCertificate( + listTagsForCertificate( args: ListTagsForCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForCertificateCommandOutput) => void ): void; - public listTagsForCertificate( - args: ListTagsForCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForCertificateCommandOutput) => void), - cb?: (err: any, data?: ListTagsForCertificateCommandOutput) => void - ): Promise | void { - const command = new ListTagsForCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or modifies account-level configurations in ACM.

- *

The supported configuration option is DaysBeforeExpiry. This option specifies - * the number of days prior to certificate expiration when ACM starts generating - * EventBridge events. ACM sends one event per day per certificate until the - * certificate expires. By default, accounts receive events starting 45 days before certificate - * expiration.

+ * @see {@link PutAccountConfigurationCommand} */ - public putAccountConfiguration( + putAccountConfiguration( args: PutAccountConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAccountConfiguration( + putAccountConfiguration( args: PutAccountConfigurationCommandInput, cb: (err: any, data?: PutAccountConfigurationCommandOutput) => void ): void; - public putAccountConfiguration( + putAccountConfiguration( args: PutAccountConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccountConfigurationCommandOutput) => void ): void; - public putAccountConfiguration( - args: PutAccountConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAccountConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutAccountConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutAccountConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If - * you do not specify the value portion of the tag when calling this function, the tag will be - * removed regardless of value. If you specify a value, the tag is removed only if it is - * associated with the specified value.

- *

To add tags to a certificate, use the AddTagsToCertificate action. To - * view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.

+ * @see {@link RemoveTagsFromCertificateCommand} */ - public removeTagsFromCertificate( + removeTagsFromCertificate( args: RemoveTagsFromCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeTagsFromCertificate( + removeTagsFromCertificate( args: RemoveTagsFromCertificateCommandInput, cb: (err: any, data?: RemoveTagsFromCertificateCommandOutput) => void ): void; - public removeTagsFromCertificate( + removeTagsFromCertificate( args: RemoveTagsFromCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsFromCertificateCommandOutput) => void ): void; - public removeTagsFromCertificate( - args: RemoveTagsFromCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveTagsFromCertificateCommandOutput) => void), - cb?: (err: any, data?: RemoveTagsFromCertificateCommandOutput) => void - ): Promise | void { - const command = new RemoveTagsFromCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Renews an eligible ACM certificate. At this time, only exported private certificates can - * be renewed with this operation. In order to renew your Amazon Web Services Private CA certificates with ACM, you - * must first grant the ACM - * service principal permission to do so. For more information, see Testing Managed Renewal - * in the ACM User Guide.

+ * @see {@link RenewCertificateCommand} */ - public renewCertificate( + renewCertificate( args: RenewCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public renewCertificate( + renewCertificate( args: RenewCertificateCommandInput, cb: (err: any, data?: RenewCertificateCommandOutput) => void ): void; - public renewCertificate( + renewCertificate( args: RenewCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RenewCertificateCommandOutput) => void ): void; - public renewCertificate( - args: RenewCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RenewCertificateCommandOutput) => void), - cb?: (err: any, data?: RenewCertificateCommandOutput) => void - ): Promise | void { - const command = new RenewCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Requests an ACM certificate for use with other Amazon Web Services services. To request an ACM - * certificate, you must specify a fully qualified domain name (FQDN) in the - * DomainName parameter. You can also specify additional FQDNs in the - * SubjectAlternativeNames parameter.

- *

If you are requesting a private certificate, domain validation is not required. If you are - * requesting a public certificate, each domain name that you specify must be validated to verify - * that you own or control the domain. You can use DNS validation or email validation. - * We recommend that you use DNS validation. ACM issues public certificates after receiving - * approval from the domain owner.

- * - *

ACM behavior differs from the RFC 6125 - * specification of the certificate validation process. ACM first checks for a Subject - * Alternative Name, and, if it finds one, ignores the common name (CN).

- *
- *

After successful completion of the RequestCertificate action, there is a - * delay of several seconds before you can retrieve information about the new certificate.

+ * @see {@link RequestCertificateCommand} */ - public requestCertificate( + requestCertificate( args: RequestCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public requestCertificate( + requestCertificate( args: RequestCertificateCommandInput, cb: (err: any, data?: RequestCertificateCommandOutput) => void ): void; - public requestCertificate( + requestCertificate( args: RequestCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RequestCertificateCommandOutput) => void ): void; - public requestCertificate( - args: RequestCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RequestCertificateCommandOutput) => void), - cb?: (err: any, data?: RequestCertificateCommandOutput) => void - ): Promise | void { - const command = new RequestCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Resends the email that requests domain ownership validation. The domain owner or an - * authorized representative must approve the ACM certificate before it can be issued. The - * certificate can be approved by clicking a link in the mail to navigate to the Amazon - * certificate approval website and then clicking I Approve. - * However, the validation email can be blocked by spam filters. Therefore, if you do not receive - * the original mail, you can request that the mail be resent within 72 hours of requesting the - * ACM certificate. If more than 72 hours have elapsed since your original request or since - * your last attempt to resend validation mail, you must request a new certificate. For more - * information about setting up your contact email addresses, see Configure Email for your Domain.

+ * @see {@link ResendValidationEmailCommand} */ - public resendValidationEmail( + resendValidationEmail( args: ResendValidationEmailCommandInput, options?: __HttpHandlerOptions ): Promise; - public resendValidationEmail( + resendValidationEmail( args: ResendValidationEmailCommandInput, cb: (err: any, data?: ResendValidationEmailCommandOutput) => void ): void; - public resendValidationEmail( + resendValidationEmail( args: ResendValidationEmailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResendValidationEmailCommandOutput) => void ): void; - public resendValidationEmail( - args: ResendValidationEmailCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResendValidationEmailCommandOutput) => void), - cb?: (err: any, data?: ResendValidationEmailCommandOutput) => void - ): Promise | void { - const command = new ResendValidationEmailCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a certificate. Currently, you can use this function to specify whether to opt in - * to or out of recording your certificate in a certificate transparency log. For more - * information, see Opting Out of - * Certificate Transparency Logging.

+ * @see {@link UpdateCertificateOptionsCommand} */ - public updateCertificateOptions( + updateCertificateOptions( args: UpdateCertificateOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCertificateOptions( + updateCertificateOptions( args: UpdateCertificateOptionsCommandInput, cb: (err: any, data?: UpdateCertificateOptionsCommandOutput) => void ): void; - public updateCertificateOptions( + updateCertificateOptions( args: UpdateCertificateOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCertificateOptionsCommandOutput) => void ): void; - public updateCertificateOptions( - args: UpdateCertificateOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCertificateOptionsCommandOutput) => void), - cb?: (err: any, data?: UpdateCertificateOptionsCommandOutput) => void - ): Promise | void { - const command = new UpdateCertificateOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Certificate Manager + *

You can use Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites + * and applications. For more information about using ACM, see the Certificate Manager User Guide.

+ */ +export class ACM extends ACMClient implements ACM {} +createAggregatedClient(commands, ACM); diff --git a/clients/client-alexa-for-business/src/AlexaForBusiness.ts b/clients/client-alexa-for-business/src/AlexaForBusiness.ts index 99ab65b7e641..9dce8b57ea03 100644 --- a/clients/client-alexa-for-business/src/AlexaForBusiness.ts +++ b/clients/client-alexa-for-business/src/AlexaForBusiness.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { AlexaForBusinessClient } from "./AlexaForBusinessClient"; +import { AlexaForBusinessClient, AlexaForBusinessClientConfig } from "./AlexaForBusinessClient"; import { ApproveSkillCommand, ApproveSkillCommandInput, @@ -400,3035 +401,1491 @@ import { UpdateSkillGroupCommandOutput, } from "./commands/UpdateSkillGroupCommand"; -/** - * @public - *

Alexa for Business helps you use Alexa in your organization. Alexa for Business provides you with the tools - * to manage Alexa devices, enroll your users, and assign skills, at scale. You can build your - * own context-aware voice skills using the Alexa Skills Kit and the Alexa for Business API operations. - * You can also make these available as private skills for your organization. Alexa for Business makes it - * efficient to voice-enable your products and services, thus providing context-aware voice - * experiences for your customers. Device makers building with the Alexa Voice Service (AVS) - * can create fully integrated solutions, register their products with Alexa for Business, and manage them - * as shared devices in their organization.

- */ -export class AlexaForBusiness extends AlexaForBusinessClient { +const commands = { + ApproveSkillCommand, + AssociateContactWithAddressBookCommand, + AssociateDeviceWithNetworkProfileCommand, + AssociateDeviceWithRoomCommand, + AssociateSkillGroupWithRoomCommand, + AssociateSkillWithSkillGroupCommand, + AssociateSkillWithUsersCommand, + CreateAddressBookCommand, + CreateBusinessReportScheduleCommand, + CreateConferenceProviderCommand, + CreateContactCommand, + CreateGatewayGroupCommand, + CreateNetworkProfileCommand, + CreateProfileCommand, + CreateRoomCommand, + CreateSkillGroupCommand, + CreateUserCommand, + DeleteAddressBookCommand, + DeleteBusinessReportScheduleCommand, + DeleteConferenceProviderCommand, + DeleteContactCommand, + DeleteDeviceCommand, + DeleteDeviceUsageDataCommand, + DeleteGatewayGroupCommand, + DeleteNetworkProfileCommand, + DeleteProfileCommand, + DeleteRoomCommand, + DeleteRoomSkillParameterCommand, + DeleteSkillAuthorizationCommand, + DeleteSkillGroupCommand, + DeleteUserCommand, + DisassociateContactFromAddressBookCommand, + DisassociateDeviceFromRoomCommand, + DisassociateSkillFromSkillGroupCommand, + DisassociateSkillFromUsersCommand, + DisassociateSkillGroupFromRoomCommand, + ForgetSmartHomeAppliancesCommand, + GetAddressBookCommand, + GetConferencePreferenceCommand, + GetConferenceProviderCommand, + GetContactCommand, + GetDeviceCommand, + GetGatewayCommand, + GetGatewayGroupCommand, + GetInvitationConfigurationCommand, + GetNetworkProfileCommand, + GetProfileCommand, + GetRoomCommand, + GetRoomSkillParameterCommand, + GetSkillGroupCommand, + ListBusinessReportSchedulesCommand, + ListConferenceProvidersCommand, + ListDeviceEventsCommand, + ListGatewayGroupsCommand, + ListGatewaysCommand, + ListSkillsCommand, + ListSkillsStoreCategoriesCommand, + ListSkillsStoreSkillsByCategoryCommand, + ListSmartHomeAppliancesCommand, + ListTagsCommand, + PutConferencePreferenceCommand, + PutInvitationConfigurationCommand, + PutRoomSkillParameterCommand, + PutSkillAuthorizationCommand, + RegisterAVSDeviceCommand, + RejectSkillCommand, + ResolveRoomCommand, + RevokeInvitationCommand, + SearchAddressBooksCommand, + SearchContactsCommand, + SearchDevicesCommand, + SearchNetworkProfilesCommand, + SearchProfilesCommand, + SearchRoomsCommand, + SearchSkillGroupsCommand, + SearchUsersCommand, + SendAnnouncementCommand, + SendInvitationCommand, + StartDeviceSyncCommand, + StartSmartHomeApplianceDiscoveryCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAddressBookCommand, + UpdateBusinessReportScheduleCommand, + UpdateConferenceProviderCommand, + UpdateContactCommand, + UpdateDeviceCommand, + UpdateGatewayCommand, + UpdateGatewayGroupCommand, + UpdateNetworkProfileCommand, + UpdateProfileCommand, + UpdateRoomCommand, + UpdateSkillGroupCommand, +}; + +export interface AlexaForBusiness { /** - * @public - *

Associates a skill with the organization under the customer's AWS account. If a skill - * is private, the user implicitly accepts access to this skill during enablement.

+ * @see {@link ApproveSkillCommand} */ - public approveSkill( - args: ApproveSkillCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public approveSkill(args: ApproveSkillCommandInput, cb: (err: any, data?: ApproveSkillCommandOutput) => void): void; - public approveSkill( + approveSkill(args: ApproveSkillCommandInput, options?: __HttpHandlerOptions): Promise; + approveSkill(args: ApproveSkillCommandInput, cb: (err: any, data?: ApproveSkillCommandOutput) => void): void; + approveSkill( args: ApproveSkillCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ApproveSkillCommandOutput) => void ): void; - public approveSkill( - args: ApproveSkillCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ApproveSkillCommandOutput) => void), - cb?: (err: any, data?: ApproveSkillCommandOutput) => void - ): Promise | void { - const command = new ApproveSkillCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a contact with a given address book.

- */ - public associateContactWithAddressBook( + + /** + * @see {@link AssociateContactWithAddressBookCommand} + */ + associateContactWithAddressBook( args: AssociateContactWithAddressBookCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateContactWithAddressBook( + associateContactWithAddressBook( args: AssociateContactWithAddressBookCommandInput, cb: (err: any, data?: AssociateContactWithAddressBookCommandOutput) => void ): void; - public associateContactWithAddressBook( + associateContactWithAddressBook( args: AssociateContactWithAddressBookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateContactWithAddressBookCommandOutput) => void ): void; - public associateContactWithAddressBook( - args: AssociateContactWithAddressBookCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateContactWithAddressBookCommandOutput) => void), - cb?: (err: any, data?: AssociateContactWithAddressBookCommandOutput) => void - ): Promise | void { - const command = new AssociateContactWithAddressBookCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a device with the specified network profile.

- */ - public associateDeviceWithNetworkProfile( + + /** + * @see {@link AssociateDeviceWithNetworkProfileCommand} + */ + associateDeviceWithNetworkProfile( args: AssociateDeviceWithNetworkProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateDeviceWithNetworkProfile( + associateDeviceWithNetworkProfile( args: AssociateDeviceWithNetworkProfileCommandInput, cb: (err: any, data?: AssociateDeviceWithNetworkProfileCommandOutput) => void ): void; - public associateDeviceWithNetworkProfile( + associateDeviceWithNetworkProfile( args: AssociateDeviceWithNetworkProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateDeviceWithNetworkProfileCommandOutput) => void ): void; - public associateDeviceWithNetworkProfile( - args: AssociateDeviceWithNetworkProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateDeviceWithNetworkProfileCommandOutput) => void), - cb?: (err: any, data?: AssociateDeviceWithNetworkProfileCommandOutput) => void - ): Promise | void { - const command = new AssociateDeviceWithNetworkProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a device with a given room. This applies all the settings from the room - * profile to the device, and all the skills in any skill groups added to that room. This - * operation requires the device to be online, or else a manual sync is required.

- */ - public associateDeviceWithRoom( + + /** + * @see {@link AssociateDeviceWithRoomCommand} + */ + associateDeviceWithRoom( args: AssociateDeviceWithRoomCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateDeviceWithRoom( + associateDeviceWithRoom( args: AssociateDeviceWithRoomCommandInput, cb: (err: any, data?: AssociateDeviceWithRoomCommandOutput) => void ): void; - public associateDeviceWithRoom( + associateDeviceWithRoom( args: AssociateDeviceWithRoomCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateDeviceWithRoomCommandOutput) => void ): void; - public associateDeviceWithRoom( - args: AssociateDeviceWithRoomCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateDeviceWithRoomCommandOutput) => void), - cb?: (err: any, data?: AssociateDeviceWithRoomCommandOutput) => void - ): Promise | void { - const command = new AssociateDeviceWithRoomCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a skill group with a given room. This enables all skills in the associated - * skill group on all devices in the room.

- */ - public associateSkillGroupWithRoom( + + /** + * @see {@link AssociateSkillGroupWithRoomCommand} + */ + associateSkillGroupWithRoom( args: AssociateSkillGroupWithRoomCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateSkillGroupWithRoom( + associateSkillGroupWithRoom( args: AssociateSkillGroupWithRoomCommandInput, cb: (err: any, data?: AssociateSkillGroupWithRoomCommandOutput) => void ): void; - public associateSkillGroupWithRoom( + associateSkillGroupWithRoom( args: AssociateSkillGroupWithRoomCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateSkillGroupWithRoomCommandOutput) => void ): void; - public associateSkillGroupWithRoom( - args: AssociateSkillGroupWithRoomCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateSkillGroupWithRoomCommandOutput) => void), - cb?: (err: any, data?: AssociateSkillGroupWithRoomCommandOutput) => void - ): Promise | void { - const command = new AssociateSkillGroupWithRoomCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a skill with a skill group.

- */ - public associateSkillWithSkillGroup( + + /** + * @see {@link AssociateSkillWithSkillGroupCommand} + */ + associateSkillWithSkillGroup( args: AssociateSkillWithSkillGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateSkillWithSkillGroup( + associateSkillWithSkillGroup( args: AssociateSkillWithSkillGroupCommandInput, cb: (err: any, data?: AssociateSkillWithSkillGroupCommandOutput) => void ): void; - public associateSkillWithSkillGroup( + associateSkillWithSkillGroup( args: AssociateSkillWithSkillGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateSkillWithSkillGroupCommandOutput) => void ): void; - public associateSkillWithSkillGroup( - args: AssociateSkillWithSkillGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateSkillWithSkillGroupCommandOutput) => void), - cb?: (err: any, data?: AssociateSkillWithSkillGroupCommandOutput) => void - ): Promise | void { - const command = new AssociateSkillWithSkillGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Makes a private skill available for enrolled users to enable on their devices.

- */ - public associateSkillWithUsers( + + /** + * @see {@link AssociateSkillWithUsersCommand} + */ + associateSkillWithUsers( args: AssociateSkillWithUsersCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateSkillWithUsers( + associateSkillWithUsers( args: AssociateSkillWithUsersCommandInput, cb: (err: any, data?: AssociateSkillWithUsersCommandOutput) => void ): void; - public associateSkillWithUsers( + associateSkillWithUsers( args: AssociateSkillWithUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateSkillWithUsersCommandOutput) => void ): void; - public associateSkillWithUsers( - args: AssociateSkillWithUsersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateSkillWithUsersCommandOutput) => void), - cb?: (err: any, data?: AssociateSkillWithUsersCommandOutput) => void - ): Promise | void { - const command = new AssociateSkillWithUsersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an address book with the specified details.

- */ - public createAddressBook( + + /** + * @see {@link CreateAddressBookCommand} + */ + createAddressBook( args: CreateAddressBookCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAddressBook( + createAddressBook( args: CreateAddressBookCommandInput, cb: (err: any, data?: CreateAddressBookCommandOutput) => void ): void; - public createAddressBook( + createAddressBook( args: CreateAddressBookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAddressBookCommandOutput) => void ): void; - public createAddressBook( - args: CreateAddressBookCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAddressBookCommandOutput) => void), - cb?: (err: any, data?: CreateAddressBookCommandOutput) => void - ): Promise | void { - const command = new CreateAddressBookCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a recurring schedule for usage reports to deliver to the specified S3 - * location with a specified daily or weekly interval.

- */ - public createBusinessReportSchedule( + + /** + * @see {@link CreateBusinessReportScheduleCommand} + */ + createBusinessReportSchedule( args: CreateBusinessReportScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBusinessReportSchedule( + createBusinessReportSchedule( args: CreateBusinessReportScheduleCommandInput, cb: (err: any, data?: CreateBusinessReportScheduleCommandOutput) => void ): void; - public createBusinessReportSchedule( + createBusinessReportSchedule( args: CreateBusinessReportScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBusinessReportScheduleCommandOutput) => void ): void; - public createBusinessReportSchedule( - args: CreateBusinessReportScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBusinessReportScheduleCommandOutput) => void), - cb?: (err: any, data?: CreateBusinessReportScheduleCommandOutput) => void - ): Promise | void { - const command = new CreateBusinessReportScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds a new conference provider under the user's AWS account.

- */ - public createConferenceProvider( + + /** + * @see {@link CreateConferenceProviderCommand} + */ + createConferenceProvider( args: CreateConferenceProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConferenceProvider( + createConferenceProvider( args: CreateConferenceProviderCommandInput, cb: (err: any, data?: CreateConferenceProviderCommandOutput) => void ): void; - public createConferenceProvider( + createConferenceProvider( args: CreateConferenceProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConferenceProviderCommandOutput) => void ): void; - public createConferenceProvider( - args: CreateConferenceProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConferenceProviderCommandOutput) => void), - cb?: (err: any, data?: CreateConferenceProviderCommandOutput) => void - ): Promise | void { - const command = new CreateConferenceProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a contact with the specified details.

- */ - public createContact( - args: CreateContactCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createContact( - args: CreateContactCommandInput, - cb: (err: any, data?: CreateContactCommandOutput) => void - ): void; - public createContact( + + /** + * @see {@link CreateContactCommand} + */ + createContact(args: CreateContactCommandInput, options?: __HttpHandlerOptions): Promise; + createContact(args: CreateContactCommandInput, cb: (err: any, data?: CreateContactCommandOutput) => void): void; + createContact( args: CreateContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateContactCommandOutput) => void ): void; - public createContact( - args: CreateContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateContactCommandOutput) => void), - cb?: (err: any, data?: CreateContactCommandOutput) => void - ): Promise | void { - const command = new CreateContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a gateway group with the specified details.

- */ - public createGatewayGroup( + + /** + * @see {@link CreateGatewayGroupCommand} + */ + createGatewayGroup( args: CreateGatewayGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createGatewayGroup( + createGatewayGroup( args: CreateGatewayGroupCommandInput, cb: (err: any, data?: CreateGatewayGroupCommandOutput) => void ): void; - public createGatewayGroup( + createGatewayGroup( args: CreateGatewayGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGatewayGroupCommandOutput) => void ): void; - public createGatewayGroup( - args: CreateGatewayGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGatewayGroupCommandOutput) => void), - cb?: (err: any, data?: CreateGatewayGroupCommandOutput) => void - ): Promise | void { - const command = new CreateGatewayGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a network profile with the specified details.

- */ - public createNetworkProfile( + + /** + * @see {@link CreateNetworkProfileCommand} + */ + createNetworkProfile( args: CreateNetworkProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNetworkProfile( + createNetworkProfile( args: CreateNetworkProfileCommandInput, cb: (err: any, data?: CreateNetworkProfileCommandOutput) => void ): void; - public createNetworkProfile( + createNetworkProfile( args: CreateNetworkProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNetworkProfileCommandOutput) => void ): void; - public createNetworkProfile( - args: CreateNetworkProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNetworkProfileCommandOutput) => void), - cb?: (err: any, data?: CreateNetworkProfileCommandOutput) => void - ): Promise | void { - const command = new CreateNetworkProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new room profile with the specified details.

- */ - public createProfile( - args: CreateProfileCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createProfile( - args: CreateProfileCommandInput, - cb: (err: any, data?: CreateProfileCommandOutput) => void - ): void; - public createProfile( + + /** + * @see {@link CreateProfileCommand} + */ + createProfile(args: CreateProfileCommandInput, options?: __HttpHandlerOptions): Promise; + createProfile(args: CreateProfileCommandInput, cb: (err: any, data?: CreateProfileCommandOutput) => void): void; + createProfile( args: CreateProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProfileCommandOutput) => void ): void; - public createProfile( - args: CreateProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProfileCommandOutput) => void), - cb?: (err: any, data?: CreateProfileCommandOutput) => void - ): Promise | void { - const command = new CreateProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a room with the specified details.

- */ - public createRoom(args: CreateRoomCommandInput, options?: __HttpHandlerOptions): Promise; - public createRoom(args: CreateRoomCommandInput, cb: (err: any, data?: CreateRoomCommandOutput) => void): void; - public createRoom( + + /** + * @see {@link CreateRoomCommand} + */ + createRoom(args: CreateRoomCommandInput, options?: __HttpHandlerOptions): Promise; + createRoom(args: CreateRoomCommandInput, cb: (err: any, data?: CreateRoomCommandOutput) => void): void; + createRoom( args: CreateRoomCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRoomCommandOutput) => void ): void; - public createRoom( - args: CreateRoomCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRoomCommandOutput) => void), - cb?: (err: any, data?: CreateRoomCommandOutput) => void - ): Promise | void { - const command = new CreateRoomCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a skill group with a specified name and description.

- */ - public createSkillGroup( + + /** + * @see {@link CreateSkillGroupCommand} + */ + createSkillGroup( args: CreateSkillGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSkillGroup( + createSkillGroup( args: CreateSkillGroupCommandInput, cb: (err: any, data?: CreateSkillGroupCommandOutput) => void ): void; - public createSkillGroup( + createSkillGroup( args: CreateSkillGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSkillGroupCommandOutput) => void ): void; - public createSkillGroup( - args: CreateSkillGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSkillGroupCommandOutput) => void), - cb?: (err: any, data?: CreateSkillGroupCommandOutput) => void - ): Promise | void { - const command = new CreateSkillGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a user.

- */ - public createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; - public createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; - public createUser( + + /** + * @see {@link CreateUserCommand} + */ + createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; + createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; + createUser( args: CreateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserCommandOutput) => void ): void; - public createUser( - args: CreateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserCommandOutput) => void), - cb?: (err: any, data?: CreateUserCommandOutput) => void - ): Promise | void { - const command = new CreateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an address book by the address book ARN.

- */ - public deleteAddressBook( + + /** + * @see {@link DeleteAddressBookCommand} + */ + deleteAddressBook( args: DeleteAddressBookCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAddressBook( + deleteAddressBook( args: DeleteAddressBookCommandInput, cb: (err: any, data?: DeleteAddressBookCommandOutput) => void ): void; - public deleteAddressBook( + deleteAddressBook( args: DeleteAddressBookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAddressBookCommandOutput) => void ): void; - public deleteAddressBook( - args: DeleteAddressBookCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAddressBookCommandOutput) => void), - cb?: (err: any, data?: DeleteAddressBookCommandOutput) => void - ): Promise | void { - const command = new DeleteAddressBookCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the recurring report delivery schedule with the specified schedule - * ARN.

- */ - public deleteBusinessReportSchedule( + + /** + * @see {@link DeleteBusinessReportScheduleCommand} + */ + deleteBusinessReportSchedule( args: DeleteBusinessReportScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBusinessReportSchedule( + deleteBusinessReportSchedule( args: DeleteBusinessReportScheduleCommandInput, cb: (err: any, data?: DeleteBusinessReportScheduleCommandOutput) => void ): void; - public deleteBusinessReportSchedule( + deleteBusinessReportSchedule( args: DeleteBusinessReportScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBusinessReportScheduleCommandOutput) => void ): void; - public deleteBusinessReportSchedule( - args: DeleteBusinessReportScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBusinessReportScheduleCommandOutput) => void), - cb?: (err: any, data?: DeleteBusinessReportScheduleCommandOutput) => void - ): Promise | void { - const command = new DeleteBusinessReportScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a conference provider.

- */ - public deleteConferenceProvider( + + /** + * @see {@link DeleteConferenceProviderCommand} + */ + deleteConferenceProvider( args: DeleteConferenceProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConferenceProvider( + deleteConferenceProvider( args: DeleteConferenceProviderCommandInput, cb: (err: any, data?: DeleteConferenceProviderCommandOutput) => void ): void; - public deleteConferenceProvider( + deleteConferenceProvider( args: DeleteConferenceProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConferenceProviderCommandOutput) => void ): void; - public deleteConferenceProvider( - args: DeleteConferenceProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConferenceProviderCommandOutput) => void), - cb?: (err: any, data?: DeleteConferenceProviderCommandOutput) => void - ): Promise | void { - const command = new DeleteConferenceProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a contact by the contact ARN.

- */ - public deleteContact( - args: DeleteContactCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteContact( - args: DeleteContactCommandInput, - cb: (err: any, data?: DeleteContactCommandOutput) => void - ): void; - public deleteContact( + + /** + * @see {@link DeleteContactCommand} + */ + deleteContact(args: DeleteContactCommandInput, options?: __HttpHandlerOptions): Promise; + deleteContact(args: DeleteContactCommandInput, cb: (err: any, data?: DeleteContactCommandOutput) => void): void; + deleteContact( args: DeleteContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteContactCommandOutput) => void ): void; - public deleteContact( - args: DeleteContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteContactCommandOutput) => void), - cb?: (err: any, data?: DeleteContactCommandOutput) => void - ): Promise | void { - const command = new DeleteContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a device from Alexa For Business.

- */ - public deleteDevice( - args: DeleteDeviceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDevice(args: DeleteDeviceCommandInput, cb: (err: any, data?: DeleteDeviceCommandOutput) => void): void; - public deleteDevice( + + /** + * @see {@link DeleteDeviceCommand} + */ + deleteDevice(args: DeleteDeviceCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDevice(args: DeleteDeviceCommandInput, cb: (err: any, data?: DeleteDeviceCommandOutput) => void): void; + deleteDevice( args: DeleteDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDeviceCommandOutput) => void ): void; - public deleteDevice( - args: DeleteDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDeviceCommandOutput) => void), - cb?: (err: any, data?: DeleteDeviceCommandOutput) => void - ): Promise | void { - const command = new DeleteDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

When this action is called for a specified shared device, it allows authorized users to - * delete the device's entire previous history of voice input data and associated response - * data. This action can be called once every 24 hours for a specific shared device.

- */ - public deleteDeviceUsageData( + + /** + * @see {@link DeleteDeviceUsageDataCommand} + */ + deleteDeviceUsageData( args: DeleteDeviceUsageDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDeviceUsageData( + deleteDeviceUsageData( args: DeleteDeviceUsageDataCommandInput, cb: (err: any, data?: DeleteDeviceUsageDataCommandOutput) => void ): void; - public deleteDeviceUsageData( + deleteDeviceUsageData( args: DeleteDeviceUsageDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDeviceUsageDataCommandOutput) => void ): void; - public deleteDeviceUsageData( - args: DeleteDeviceUsageDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDeviceUsageDataCommandOutput) => void), - cb?: (err: any, data?: DeleteDeviceUsageDataCommandOutput) => void - ): Promise | void { - const command = new DeleteDeviceUsageDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a gateway group.

- */ - public deleteGatewayGroup( + + /** + * @see {@link DeleteGatewayGroupCommand} + */ + deleteGatewayGroup( args: DeleteGatewayGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteGatewayGroup( + deleteGatewayGroup( args: DeleteGatewayGroupCommandInput, cb: (err: any, data?: DeleteGatewayGroupCommandOutput) => void ): void; - public deleteGatewayGroup( + deleteGatewayGroup( args: DeleteGatewayGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGatewayGroupCommandOutput) => void ): void; - public deleteGatewayGroup( - args: DeleteGatewayGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGatewayGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteGatewayGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteGatewayGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a network profile by the network profile ARN.

- */ - public deleteNetworkProfile( + + /** + * @see {@link DeleteNetworkProfileCommand} + */ + deleteNetworkProfile( args: DeleteNetworkProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNetworkProfile( + deleteNetworkProfile( args: DeleteNetworkProfileCommandInput, cb: (err: any, data?: DeleteNetworkProfileCommandOutput) => void ): void; - public deleteNetworkProfile( + deleteNetworkProfile( args: DeleteNetworkProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNetworkProfileCommandOutput) => void ): void; - public deleteNetworkProfile( - args: DeleteNetworkProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNetworkProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteNetworkProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteNetworkProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a room profile by the profile ARN.

- */ - public deleteProfile( - args: DeleteProfileCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteProfile( - args: DeleteProfileCommandInput, - cb: (err: any, data?: DeleteProfileCommandOutput) => void - ): void; - public deleteProfile( + + /** + * @see {@link DeleteProfileCommand} + */ + deleteProfile(args: DeleteProfileCommandInput, options?: __HttpHandlerOptions): Promise; + deleteProfile(args: DeleteProfileCommandInput, cb: (err: any, data?: DeleteProfileCommandOutput) => void): void; + deleteProfile( args: DeleteProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProfileCommandOutput) => void ): void; - public deleteProfile( - args: DeleteProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a room by the room ARN.

- */ - public deleteRoom(args: DeleteRoomCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteRoom(args: DeleteRoomCommandInput, cb: (err: any, data?: DeleteRoomCommandOutput) => void): void; - public deleteRoom( + + /** + * @see {@link DeleteRoomCommand} + */ + deleteRoom(args: DeleteRoomCommandInput, options?: __HttpHandlerOptions): Promise; + deleteRoom(args: DeleteRoomCommandInput, cb: (err: any, data?: DeleteRoomCommandOutput) => void): void; + deleteRoom( args: DeleteRoomCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRoomCommandOutput) => void ): void; - public deleteRoom( - args: DeleteRoomCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRoomCommandOutput) => void), - cb?: (err: any, data?: DeleteRoomCommandOutput) => void - ): Promise | void { - const command = new DeleteRoomCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes room skill parameter details by room, skill, and parameter key ID.

- */ - public deleteRoomSkillParameter( + + /** + * @see {@link DeleteRoomSkillParameterCommand} + */ + deleteRoomSkillParameter( args: DeleteRoomSkillParameterCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRoomSkillParameter( + deleteRoomSkillParameter( args: DeleteRoomSkillParameterCommandInput, cb: (err: any, data?: DeleteRoomSkillParameterCommandOutput) => void ): void; - public deleteRoomSkillParameter( + deleteRoomSkillParameter( args: DeleteRoomSkillParameterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRoomSkillParameterCommandOutput) => void ): void; - public deleteRoomSkillParameter( - args: DeleteRoomSkillParameterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRoomSkillParameterCommandOutput) => void), - cb?: (err: any, data?: DeleteRoomSkillParameterCommandOutput) => void - ): Promise | void { - const command = new DeleteRoomSkillParameterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Unlinks a third-party account from a skill.

- */ - public deleteSkillAuthorization( + + /** + * @see {@link DeleteSkillAuthorizationCommand} + */ + deleteSkillAuthorization( args: DeleteSkillAuthorizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSkillAuthorization( + deleteSkillAuthorization( args: DeleteSkillAuthorizationCommandInput, cb: (err: any, data?: DeleteSkillAuthorizationCommandOutput) => void ): void; - public deleteSkillAuthorization( + deleteSkillAuthorization( args: DeleteSkillAuthorizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSkillAuthorizationCommandOutput) => void ): void; - public deleteSkillAuthorization( - args: DeleteSkillAuthorizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSkillAuthorizationCommandOutput) => void), - cb?: (err: any, data?: DeleteSkillAuthorizationCommandOutput) => void - ): Promise | void { - const command = new DeleteSkillAuthorizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a skill group by skill group ARN.

- */ - public deleteSkillGroup( + + /** + * @see {@link DeleteSkillGroupCommand} + */ + deleteSkillGroup( args: DeleteSkillGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSkillGroup( + deleteSkillGroup( args: DeleteSkillGroupCommandInput, cb: (err: any, data?: DeleteSkillGroupCommandOutput) => void ): void; - public deleteSkillGroup( + deleteSkillGroup( args: DeleteSkillGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSkillGroupCommandOutput) => void ): void; - public deleteSkillGroup( - args: DeleteSkillGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSkillGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteSkillGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteSkillGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specified user by user ARN and enrollment ARN.

- */ - public deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; - public deleteUser( + + /** + * @see {@link DeleteUserCommand} + */ + deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; + deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; + deleteUser( args: DeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserCommandOutput) => void ): void; - public deleteUser( - args: DeleteUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserCommandOutput) => void), - cb?: (err: any, data?: DeleteUserCommandOutput) => void - ): Promise | void { - const command = new DeleteUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a contact from a given address book.

- */ - public disassociateContactFromAddressBook( + + /** + * @see {@link DisassociateContactFromAddressBookCommand} + */ + disassociateContactFromAddressBook( args: DisassociateContactFromAddressBookCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateContactFromAddressBook( + disassociateContactFromAddressBook( args: DisassociateContactFromAddressBookCommandInput, cb: (err: any, data?: DisassociateContactFromAddressBookCommandOutput) => void ): void; - public disassociateContactFromAddressBook( + disassociateContactFromAddressBook( args: DisassociateContactFromAddressBookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateContactFromAddressBookCommandOutput) => void ): void; - public disassociateContactFromAddressBook( - args: DisassociateContactFromAddressBookCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateContactFromAddressBookCommandOutput) => void), - cb?: (err: any, data?: DisassociateContactFromAddressBookCommandOutput) => void - ): Promise | void { - const command = new DisassociateContactFromAddressBookCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a device from its current room. The device continues to be connected to - * the Wi-Fi network and is still registered to the account. The device settings and skills - * are removed from the room.

- */ - public disassociateDeviceFromRoom( + + /** + * @see {@link DisassociateDeviceFromRoomCommand} + */ + disassociateDeviceFromRoom( args: DisassociateDeviceFromRoomCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateDeviceFromRoom( + disassociateDeviceFromRoom( args: DisassociateDeviceFromRoomCommandInput, cb: (err: any, data?: DisassociateDeviceFromRoomCommandOutput) => void ): void; - public disassociateDeviceFromRoom( + disassociateDeviceFromRoom( args: DisassociateDeviceFromRoomCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateDeviceFromRoomCommandOutput) => void ): void; - public disassociateDeviceFromRoom( - args: DisassociateDeviceFromRoomCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateDeviceFromRoomCommandOutput) => void), - cb?: (err: any, data?: DisassociateDeviceFromRoomCommandOutput) => void - ): Promise | void { - const command = new DisassociateDeviceFromRoomCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a skill from a skill group.

- */ - public disassociateSkillFromSkillGroup( + + /** + * @see {@link DisassociateSkillFromSkillGroupCommand} + */ + disassociateSkillFromSkillGroup( args: DisassociateSkillFromSkillGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateSkillFromSkillGroup( + disassociateSkillFromSkillGroup( args: DisassociateSkillFromSkillGroupCommandInput, cb: (err: any, data?: DisassociateSkillFromSkillGroupCommandOutput) => void ): void; - public disassociateSkillFromSkillGroup( + disassociateSkillFromSkillGroup( args: DisassociateSkillFromSkillGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateSkillFromSkillGroupCommandOutput) => void ): void; - public disassociateSkillFromSkillGroup( - args: DisassociateSkillFromSkillGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateSkillFromSkillGroupCommandOutput) => void), - cb?: (err: any, data?: DisassociateSkillFromSkillGroupCommandOutput) => void - ): Promise | void { - const command = new DisassociateSkillFromSkillGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Makes a private skill unavailable for enrolled users and prevents them from enabling it - * on their devices.

- */ - public disassociateSkillFromUsers( + + /** + * @see {@link DisassociateSkillFromUsersCommand} + */ + disassociateSkillFromUsers( args: DisassociateSkillFromUsersCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateSkillFromUsers( + disassociateSkillFromUsers( args: DisassociateSkillFromUsersCommandInput, cb: (err: any, data?: DisassociateSkillFromUsersCommandOutput) => void ): void; - public disassociateSkillFromUsers( + disassociateSkillFromUsers( args: DisassociateSkillFromUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateSkillFromUsersCommandOutput) => void ): void; - public disassociateSkillFromUsers( - args: DisassociateSkillFromUsersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateSkillFromUsersCommandOutput) => void), - cb?: (err: any, data?: DisassociateSkillFromUsersCommandOutput) => void - ): Promise | void { - const command = new DisassociateSkillFromUsersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a skill group from a specified room. This disables all skills in the - * skill group on all devices in the room.

- */ - public disassociateSkillGroupFromRoom( + + /** + * @see {@link DisassociateSkillGroupFromRoomCommand} + */ + disassociateSkillGroupFromRoom( args: DisassociateSkillGroupFromRoomCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateSkillGroupFromRoom( + disassociateSkillGroupFromRoom( args: DisassociateSkillGroupFromRoomCommandInput, cb: (err: any, data?: DisassociateSkillGroupFromRoomCommandOutput) => void ): void; - public disassociateSkillGroupFromRoom( + disassociateSkillGroupFromRoom( args: DisassociateSkillGroupFromRoomCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateSkillGroupFromRoomCommandOutput) => void ): void; - public disassociateSkillGroupFromRoom( - args: DisassociateSkillGroupFromRoomCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateSkillGroupFromRoomCommandOutput) => void), - cb?: (err: any, data?: DisassociateSkillGroupFromRoomCommandOutput) => void - ): Promise | void { - const command = new DisassociateSkillGroupFromRoomCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Forgets smart home appliances associated to a room.

- */ - public forgetSmartHomeAppliances( + + /** + * @see {@link ForgetSmartHomeAppliancesCommand} + */ + forgetSmartHomeAppliances( args: ForgetSmartHomeAppliancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public forgetSmartHomeAppliances( + forgetSmartHomeAppliances( args: ForgetSmartHomeAppliancesCommandInput, cb: (err: any, data?: ForgetSmartHomeAppliancesCommandOutput) => void ): void; - public forgetSmartHomeAppliances( + forgetSmartHomeAppliances( args: ForgetSmartHomeAppliancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ForgetSmartHomeAppliancesCommandOutput) => void ): void; - public forgetSmartHomeAppliances( - args: ForgetSmartHomeAppliancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ForgetSmartHomeAppliancesCommandOutput) => void), - cb?: (err: any, data?: ForgetSmartHomeAppliancesCommandOutput) => void - ): Promise | void { - const command = new ForgetSmartHomeAppliancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets address the book details by the address book ARN.

- */ - public getAddressBook( + + /** + * @see {@link GetAddressBookCommand} + */ + getAddressBook( args: GetAddressBookCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAddressBook( - args: GetAddressBookCommandInput, - cb: (err: any, data?: GetAddressBookCommandOutput) => void - ): void; - public getAddressBook( + getAddressBook(args: GetAddressBookCommandInput, cb: (err: any, data?: GetAddressBookCommandOutput) => void): void; + getAddressBook( args: GetAddressBookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAddressBookCommandOutput) => void ): void; - public getAddressBook( - args: GetAddressBookCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAddressBookCommandOutput) => void), - cb?: (err: any, data?: GetAddressBookCommandOutput) => void - ): Promise | void { - const command = new GetAddressBookCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the existing conference preferences.

- */ - public getConferencePreference( + + /** + * @see {@link GetConferencePreferenceCommand} + */ + getConferencePreference( args: GetConferencePreferenceCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConferencePreference( + getConferencePreference( args: GetConferencePreferenceCommandInput, cb: (err: any, data?: GetConferencePreferenceCommandOutput) => void ): void; - public getConferencePreference( + getConferencePreference( args: GetConferencePreferenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConferencePreferenceCommandOutput) => void ): void; - public getConferencePreference( - args: GetConferencePreferenceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConferencePreferenceCommandOutput) => void), - cb?: (err: any, data?: GetConferencePreferenceCommandOutput) => void - ): Promise | void { - const command = new GetConferencePreferenceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets details about a specific conference provider.

- */ - public getConferenceProvider( + + /** + * @see {@link GetConferenceProviderCommand} + */ + getConferenceProvider( args: GetConferenceProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConferenceProvider( + getConferenceProvider( args: GetConferenceProviderCommandInput, cb: (err: any, data?: GetConferenceProviderCommandOutput) => void ): void; - public getConferenceProvider( + getConferenceProvider( args: GetConferenceProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConferenceProviderCommandOutput) => void ): void; - public getConferenceProvider( - args: GetConferenceProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConferenceProviderCommandOutput) => void), - cb?: (err: any, data?: GetConferenceProviderCommandOutput) => void - ): Promise | void { - const command = new GetConferenceProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the contact details by the contact ARN.

- */ - public getContact(args: GetContactCommandInput, options?: __HttpHandlerOptions): Promise; - public getContact(args: GetContactCommandInput, cb: (err: any, data?: GetContactCommandOutput) => void): void; - public getContact( + + /** + * @see {@link GetContactCommand} + */ + getContact(args: GetContactCommandInput, options?: __HttpHandlerOptions): Promise; + getContact(args: GetContactCommandInput, cb: (err: any, data?: GetContactCommandOutput) => void): void; + getContact( args: GetContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContactCommandOutput) => void ): void; - public getContact( - args: GetContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContactCommandOutput) => void), - cb?: (err: any, data?: GetContactCommandOutput) => void - ): Promise | void { - const command = new GetContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the details of a device by device ARN.

- */ - public getDevice(args: GetDeviceCommandInput, options?: __HttpHandlerOptions): Promise; - public getDevice(args: GetDeviceCommandInput, cb: (err: any, data?: GetDeviceCommandOutput) => void): void; - public getDevice( + + /** + * @see {@link GetDeviceCommand} + */ + getDevice(args: GetDeviceCommandInput, options?: __HttpHandlerOptions): Promise; + getDevice(args: GetDeviceCommandInput, cb: (err: any, data?: GetDeviceCommandOutput) => void): void; + getDevice( args: GetDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeviceCommandOutput) => void ): void; - public getDevice( - args: GetDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeviceCommandOutput) => void), - cb?: (err: any, data?: GetDeviceCommandOutput) => void - ): Promise | void { - const command = new GetDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the details of a gateway.

- */ - public getGateway(args: GetGatewayCommandInput, options?: __HttpHandlerOptions): Promise; - public getGateway(args: GetGatewayCommandInput, cb: (err: any, data?: GetGatewayCommandOutput) => void): void; - public getGateway( + + /** + * @see {@link GetGatewayCommand} + */ + getGateway(args: GetGatewayCommandInput, options?: __HttpHandlerOptions): Promise; + getGateway(args: GetGatewayCommandInput, cb: (err: any, data?: GetGatewayCommandOutput) => void): void; + getGateway( args: GetGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGatewayCommandOutput) => void ): void; - public getGateway( - args: GetGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGatewayCommandOutput) => void), - cb?: (err: any, data?: GetGatewayCommandOutput) => void - ): Promise | void { - const command = new GetGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the details of a gateway group.

- */ - public getGatewayGroup( + + /** + * @see {@link GetGatewayGroupCommand} + */ + getGatewayGroup( args: GetGatewayGroupCommandInput, options?: __HttpHandlerOptions - ): Promise; - public getGatewayGroup( - args: GetGatewayGroupCommandInput, - cb: (err: any, data?: GetGatewayGroupCommandOutput) => void - ): void; - public getGatewayGroup( + ): Promise; + getGatewayGroup(args: GetGatewayGroupCommandInput, cb: (err: any, data?: GetGatewayGroupCommandOutput) => void): void; + getGatewayGroup( args: GetGatewayGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGatewayGroupCommandOutput) => void ): void; - public getGatewayGroup( - args: GetGatewayGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGatewayGroupCommandOutput) => void), - cb?: (err: any, data?: GetGatewayGroupCommandOutput) => void - ): Promise | void { - const command = new GetGatewayGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the configured values for the user enrollment invitation email - * template.

- */ - public getInvitationConfiguration( + + /** + * @see {@link GetInvitationConfigurationCommand} + */ + getInvitationConfiguration( args: GetInvitationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInvitationConfiguration( + getInvitationConfiguration( args: GetInvitationConfigurationCommandInput, cb: (err: any, data?: GetInvitationConfigurationCommandOutput) => void ): void; - public getInvitationConfiguration( + getInvitationConfiguration( args: GetInvitationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInvitationConfigurationCommandOutput) => void ): void; - public getInvitationConfiguration( - args: GetInvitationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInvitationConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetInvitationConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetInvitationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the network profile details by the network profile ARN.

- */ - public getNetworkProfile( + + /** + * @see {@link GetNetworkProfileCommand} + */ + getNetworkProfile( args: GetNetworkProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public getNetworkProfile( + getNetworkProfile( args: GetNetworkProfileCommandInput, cb: (err: any, data?: GetNetworkProfileCommandOutput) => void ): void; - public getNetworkProfile( + getNetworkProfile( args: GetNetworkProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNetworkProfileCommandOutput) => void ): void; - public getNetworkProfile( - args: GetNetworkProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetNetworkProfileCommandOutput) => void), - cb?: (err: any, data?: GetNetworkProfileCommandOutput) => void - ): Promise | void { - const command = new GetNetworkProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the details of a room profile by profile ARN.

- */ - public getProfile(args: GetProfileCommandInput, options?: __HttpHandlerOptions): Promise; - public getProfile(args: GetProfileCommandInput, cb: (err: any, data?: GetProfileCommandOutput) => void): void; - public getProfile( + + /** + * @see {@link GetProfileCommand} + */ + getProfile(args: GetProfileCommandInput, options?: __HttpHandlerOptions): Promise; + getProfile(args: GetProfileCommandInput, cb: (err: any, data?: GetProfileCommandOutput) => void): void; + getProfile( args: GetProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProfileCommandOutput) => void ): void; - public getProfile( - args: GetProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetProfileCommandOutput) => void), - cb?: (err: any, data?: GetProfileCommandOutput) => void - ): Promise | void { - const command = new GetProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets room details by room ARN.

- */ - public getRoom(args: GetRoomCommandInput, options?: __HttpHandlerOptions): Promise; - public getRoom(args: GetRoomCommandInput, cb: (err: any, data?: GetRoomCommandOutput) => void): void; - public getRoom( + + /** + * @see {@link GetRoomCommand} + */ + getRoom(args: GetRoomCommandInput, options?: __HttpHandlerOptions): Promise; + getRoom(args: GetRoomCommandInput, cb: (err: any, data?: GetRoomCommandOutput) => void): void; + getRoom( args: GetRoomCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRoomCommandOutput) => void ): void; - public getRoom( - args: GetRoomCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRoomCommandOutput) => void), - cb?: (err: any, data?: GetRoomCommandOutput) => void - ): Promise | void { - const command = new GetRoomCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets room skill parameter details by room, skill, and parameter key ARN.

- */ - public getRoomSkillParameter( + + /** + * @see {@link GetRoomSkillParameterCommand} + */ + getRoomSkillParameter( args: GetRoomSkillParameterCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRoomSkillParameter( + getRoomSkillParameter( args: GetRoomSkillParameterCommandInput, cb: (err: any, data?: GetRoomSkillParameterCommandOutput) => void ): void; - public getRoomSkillParameter( + getRoomSkillParameter( args: GetRoomSkillParameterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRoomSkillParameterCommandOutput) => void ): void; - public getRoomSkillParameter( - args: GetRoomSkillParameterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRoomSkillParameterCommandOutput) => void), - cb?: (err: any, data?: GetRoomSkillParameterCommandOutput) => void - ): Promise | void { - const command = new GetRoomSkillParameterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets skill group details by skill group ARN.

- */ - public getSkillGroup( - args: GetSkillGroupCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getSkillGroup( - args: GetSkillGroupCommandInput, - cb: (err: any, data?: GetSkillGroupCommandOutput) => void - ): void; - public getSkillGroup( + + /** + * @see {@link GetSkillGroupCommand} + */ + getSkillGroup(args: GetSkillGroupCommandInput, options?: __HttpHandlerOptions): Promise; + getSkillGroup(args: GetSkillGroupCommandInput, cb: (err: any, data?: GetSkillGroupCommandOutput) => void): void; + getSkillGroup( args: GetSkillGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSkillGroupCommandOutput) => void ): void; - public getSkillGroup( - args: GetSkillGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSkillGroupCommandOutput) => void), - cb?: (err: any, data?: GetSkillGroupCommandOutput) => void - ): Promise | void { - const command = new GetSkillGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the details of the schedules that a user configured. A download URL of the report associated with each schedule is returned every time this action is called. A new download URL is returned each time, and is valid for 24 hours.

- */ - public listBusinessReportSchedules( + + /** + * @see {@link ListBusinessReportSchedulesCommand} + */ + listBusinessReportSchedules( args: ListBusinessReportSchedulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBusinessReportSchedules( + listBusinessReportSchedules( args: ListBusinessReportSchedulesCommandInput, cb: (err: any, data?: ListBusinessReportSchedulesCommandOutput) => void ): void; - public listBusinessReportSchedules( + listBusinessReportSchedules( args: ListBusinessReportSchedulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBusinessReportSchedulesCommandOutput) => void ): void; - public listBusinessReportSchedules( - args: ListBusinessReportSchedulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBusinessReportSchedulesCommandOutput) => void), - cb?: (err: any, data?: ListBusinessReportSchedulesCommandOutput) => void - ): Promise | void { - const command = new ListBusinessReportSchedulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists conference providers under a specific AWS account.

- */ - public listConferenceProviders( + + /** + * @see {@link ListConferenceProvidersCommand} + */ + listConferenceProviders( args: ListConferenceProvidersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConferenceProviders( + listConferenceProviders( args: ListConferenceProvidersCommandInput, cb: (err: any, data?: ListConferenceProvidersCommandOutput) => void ): void; - public listConferenceProviders( + listConferenceProviders( args: ListConferenceProvidersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConferenceProvidersCommandOutput) => void ): void; - public listConferenceProviders( - args: ListConferenceProvidersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConferenceProvidersCommandOutput) => void), - cb?: (err: any, data?: ListConferenceProvidersCommandOutput) => void - ): Promise | void { - const command = new ListConferenceProvidersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the device event history, including device connection status, for up to 30 - * days.

- */ - public listDeviceEvents( + + /** + * @see {@link ListDeviceEventsCommand} + */ + listDeviceEvents( args: ListDeviceEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeviceEvents( + listDeviceEvents( args: ListDeviceEventsCommandInput, cb: (err: any, data?: ListDeviceEventsCommandOutput) => void ): void; - public listDeviceEvents( + listDeviceEvents( args: ListDeviceEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeviceEventsCommandOutput) => void ): void; - public listDeviceEvents( - args: ListDeviceEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeviceEventsCommandOutput) => void), - cb?: (err: any, data?: ListDeviceEventsCommandOutput) => void - ): Promise | void { - const command = new ListDeviceEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of - * a specific gateway group.

- */ - public listGatewayGroups( + + /** + * @see {@link ListGatewayGroupsCommand} + */ + listGatewayGroups( args: ListGatewayGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGatewayGroups( + listGatewayGroups( args: ListGatewayGroupsCommandInput, cb: (err: any, data?: ListGatewayGroupsCommandOutput) => void ): void; - public listGatewayGroups( + listGatewayGroups( args: ListGatewayGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGatewayGroupsCommandOutput) => void ): void; - public listGatewayGroups( - args: ListGatewayGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGatewayGroupsCommandOutput) => void), - cb?: (err: any, data?: ListGatewayGroupsCommandOutput) => void - ): Promise | void { - const command = new ListGatewayGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific - * gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries - * of gateways that are associated with that gateway group ARN.

- */ - public listGateways( - args: ListGatewaysCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listGateways(args: ListGatewaysCommandInput, cb: (err: any, data?: ListGatewaysCommandOutput) => void): void; - public listGateways( + + /** + * @see {@link ListGatewaysCommand} + */ + listGateways(args: ListGatewaysCommandInput, options?: __HttpHandlerOptions): Promise; + listGateways(args: ListGatewaysCommandInput, cb: (err: any, data?: ListGatewaysCommandOutput) => void): void; + listGateways( args: ListGatewaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGatewaysCommandOutput) => void ): void; - public listGateways( - args: ListGatewaysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGatewaysCommandOutput) => void), - cb?: (err: any, data?: ListGatewaysCommandOutput) => void - ): Promise | void { - const command = new ListGatewaysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all enabled skills in a specific skill group.

- */ - public listSkills(args: ListSkillsCommandInput, options?: __HttpHandlerOptions): Promise; - public listSkills(args: ListSkillsCommandInput, cb: (err: any, data?: ListSkillsCommandOutput) => void): void; - public listSkills( + + /** + * @see {@link ListSkillsCommand} + */ + listSkills(args: ListSkillsCommandInput, options?: __HttpHandlerOptions): Promise; + listSkills(args: ListSkillsCommandInput, cb: (err: any, data?: ListSkillsCommandOutput) => void): void; + listSkills( args: ListSkillsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSkillsCommandOutput) => void ): void; - public listSkills( - args: ListSkillsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSkillsCommandOutput) => void), - cb?: (err: any, data?: ListSkillsCommandOutput) => void - ): Promise | void { - const command = new ListSkillsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all categories in the Alexa skill store.

- */ - public listSkillsStoreCategories( + + /** + * @see {@link ListSkillsStoreCategoriesCommand} + */ + listSkillsStoreCategories( args: ListSkillsStoreCategoriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSkillsStoreCategories( + listSkillsStoreCategories( args: ListSkillsStoreCategoriesCommandInput, cb: (err: any, data?: ListSkillsStoreCategoriesCommandOutput) => void ): void; - public listSkillsStoreCategories( + listSkillsStoreCategories( args: ListSkillsStoreCategoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSkillsStoreCategoriesCommandOutput) => void ): void; - public listSkillsStoreCategories( - args: ListSkillsStoreCategoriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSkillsStoreCategoriesCommandOutput) => void), - cb?: (err: any, data?: ListSkillsStoreCategoriesCommandOutput) => void - ): Promise | void { - const command = new ListSkillsStoreCategoriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all skills in the Alexa skill store by category.

- */ - public listSkillsStoreSkillsByCategory( + + /** + * @see {@link ListSkillsStoreSkillsByCategoryCommand} + */ + listSkillsStoreSkillsByCategory( args: ListSkillsStoreSkillsByCategoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSkillsStoreSkillsByCategory( + listSkillsStoreSkillsByCategory( args: ListSkillsStoreSkillsByCategoryCommandInput, cb: (err: any, data?: ListSkillsStoreSkillsByCategoryCommandOutput) => void ): void; - public listSkillsStoreSkillsByCategory( + listSkillsStoreSkillsByCategory( args: ListSkillsStoreSkillsByCategoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSkillsStoreSkillsByCategoryCommandOutput) => void ): void; - public listSkillsStoreSkillsByCategory( - args: ListSkillsStoreSkillsByCategoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSkillsStoreSkillsByCategoryCommandOutput) => void), - cb?: (err: any, data?: ListSkillsStoreSkillsByCategoryCommandOutput) => void - ): Promise | void { - const command = new ListSkillsStoreSkillsByCategoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all of the smart home appliances associated with a room.

- */ - public listSmartHomeAppliances( + + /** + * @see {@link ListSmartHomeAppliancesCommand} + */ + listSmartHomeAppliances( args: ListSmartHomeAppliancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSmartHomeAppliances( + listSmartHomeAppliances( args: ListSmartHomeAppliancesCommandInput, cb: (err: any, data?: ListSmartHomeAppliancesCommandOutput) => void ): void; - public listSmartHomeAppliances( + listSmartHomeAppliances( args: ListSmartHomeAppliancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSmartHomeAppliancesCommandOutput) => void ): void; - public listSmartHomeAppliances( - args: ListSmartHomeAppliancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSmartHomeAppliancesCommandOutput) => void), - cb?: (err: any, data?: ListSmartHomeAppliancesCommandOutput) => void - ): Promise | void { - const command = new ListSmartHomeAppliancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all tags for the specified resource.

- */ - public listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; - public listTags( + + /** + * @see {@link ListTagsCommand} + */ + listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; + listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; + listTags( args: ListTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsCommandOutput) => void ): void; - public listTags( - args: ListTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsCommandOutput) => void), - cb?: (err: any, data?: ListTagsCommandOutput) => void - ): Promise | void { - const command = new ListTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the conference preferences on a specific conference provider at the account - * level.

- */ - public putConferencePreference( + + /** + * @see {@link PutConferencePreferenceCommand} + */ + putConferencePreference( args: PutConferencePreferenceCommandInput, options?: __HttpHandlerOptions ): Promise; - public putConferencePreference( + putConferencePreference( args: PutConferencePreferenceCommandInput, cb: (err: any, data?: PutConferencePreferenceCommandOutput) => void ): void; - public putConferencePreference( + putConferencePreference( args: PutConferencePreferenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConferencePreferenceCommandOutput) => void ): void; - public putConferencePreference( - args: PutConferencePreferenceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutConferencePreferenceCommandOutput) => void), - cb?: (err: any, data?: PutConferencePreferenceCommandOutput) => void - ): Promise | void { - const command = new PutConferencePreferenceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Configures the email template for the user enrollment invitation with the specified - * attributes.

- */ - public putInvitationConfiguration( + + /** + * @see {@link PutInvitationConfigurationCommand} + */ + putInvitationConfiguration( args: PutInvitationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putInvitationConfiguration( + putInvitationConfiguration( args: PutInvitationConfigurationCommandInput, cb: (err: any, data?: PutInvitationConfigurationCommandOutput) => void ): void; - public putInvitationConfiguration( + putInvitationConfiguration( args: PutInvitationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutInvitationConfigurationCommandOutput) => void ): void; - public putInvitationConfiguration( - args: PutInvitationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutInvitationConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutInvitationConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutInvitationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates room skill parameter details by room, skill, and parameter key ID. Not all - * skills have a room skill parameter.

- */ - public putRoomSkillParameter( + + /** + * @see {@link PutRoomSkillParameterCommand} + */ + putRoomSkillParameter( args: PutRoomSkillParameterCommandInput, options?: __HttpHandlerOptions ): Promise; - public putRoomSkillParameter( + putRoomSkillParameter( args: PutRoomSkillParameterCommandInput, cb: (err: any, data?: PutRoomSkillParameterCommandOutput) => void ): void; - public putRoomSkillParameter( + putRoomSkillParameter( args: PutRoomSkillParameterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRoomSkillParameterCommandOutput) => void ): void; - public putRoomSkillParameter( - args: PutRoomSkillParameterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRoomSkillParameterCommandOutput) => void), - cb?: (err: any, data?: PutRoomSkillParameterCommandOutput) => void - ): Promise | void { - const command = new PutRoomSkillParameterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Links a user's account to a third-party skill provider. If this API operation is - * called by an assumed IAM role, the skill being linked must be a private skill. Also, the - * skill must be owned by the AWS account that assumed the IAM role.

- */ - public putSkillAuthorization( + + /** + * @see {@link PutSkillAuthorizationCommand} + */ + putSkillAuthorization( args: PutSkillAuthorizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putSkillAuthorization( + putSkillAuthorization( args: PutSkillAuthorizationCommandInput, cb: (err: any, data?: PutSkillAuthorizationCommandOutput) => void ): void; - public putSkillAuthorization( + putSkillAuthorization( args: PutSkillAuthorizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSkillAuthorizationCommandOutput) => void ): void; - public putSkillAuthorization( - args: PutSkillAuthorizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutSkillAuthorizationCommandOutput) => void), - cb?: (err: any, data?: PutSkillAuthorizationCommandOutput) => void - ): Promise | void { - const command = new PutSkillAuthorizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) - * using Alexa Voice Service (AVS).

- */ - public registerAVSDevice( + + /** + * @see {@link RegisterAVSDeviceCommand} + */ + registerAVSDevice( args: RegisterAVSDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerAVSDevice( + registerAVSDevice( args: RegisterAVSDeviceCommandInput, cb: (err: any, data?: RegisterAVSDeviceCommandOutput) => void ): void; - public registerAVSDevice( + registerAVSDevice( args: RegisterAVSDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterAVSDeviceCommandOutput) => void ): void; - public registerAVSDevice( - args: RegisterAVSDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterAVSDeviceCommandOutput) => void), - cb?: (err: any, data?: RegisterAVSDeviceCommandOutput) => void - ): Promise | void { - const command = new RegisterAVSDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a skill from the organization under a user's AWS account. If the skill - * is a private skill, it moves to an AcceptStatus of PENDING. Any private or public skill - * that is rejected can be added later by calling the ApproveSkill API.

- */ - public rejectSkill(args: RejectSkillCommandInput, options?: __HttpHandlerOptions): Promise; - public rejectSkill(args: RejectSkillCommandInput, cb: (err: any, data?: RejectSkillCommandOutput) => void): void; - public rejectSkill( + + /** + * @see {@link RejectSkillCommand} + */ + rejectSkill(args: RejectSkillCommandInput, options?: __HttpHandlerOptions): Promise; + rejectSkill(args: RejectSkillCommandInput, cb: (err: any, data?: RejectSkillCommandOutput) => void): void; + rejectSkill( args: RejectSkillCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectSkillCommandOutput) => void ): void; - public rejectSkill( - args: RejectSkillCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RejectSkillCommandOutput) => void), - cb?: (err: any, data?: RejectSkillCommandOutput) => void - ): Promise | void { - const command = new RejectSkillCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Determines the details for the room from which a skill request was invoked. This - * operation is used by skill developers.

- *

To query ResolveRoom from an Alexa skill, the skill ID needs to be authorized. When - * the skill is using an AWS Lambda function, the skill is automatically authorized when you - * publish your skill as a private skill to your AWS account. Skills that are hosted using a - * custom web service must be manually authorized. To get your skill authorized, contact AWS - * Support with your AWS account ID that queries the ResolveRoom API and skill ID.

- */ - public resolveRoom(args: ResolveRoomCommandInput, options?: __HttpHandlerOptions): Promise; - public resolveRoom(args: ResolveRoomCommandInput, cb: (err: any, data?: ResolveRoomCommandOutput) => void): void; - public resolveRoom( + + /** + * @see {@link ResolveRoomCommand} + */ + resolveRoom(args: ResolveRoomCommandInput, options?: __HttpHandlerOptions): Promise; + resolveRoom(args: ResolveRoomCommandInput, cb: (err: any, data?: ResolveRoomCommandOutput) => void): void; + resolveRoom( args: ResolveRoomCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResolveRoomCommandOutput) => void ): void; - public resolveRoom( - args: ResolveRoomCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResolveRoomCommandOutput) => void), - cb?: (err: any, data?: ResolveRoomCommandOutput) => void - ): Promise | void { - const command = new ResolveRoomCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Revokes an invitation and invalidates the enrollment URL.

- */ - public revokeInvitation( + + /** + * @see {@link RevokeInvitationCommand} + */ + revokeInvitation( args: RevokeInvitationCommandInput, options?: __HttpHandlerOptions ): Promise; - public revokeInvitation( + revokeInvitation( args: RevokeInvitationCommandInput, cb: (err: any, data?: RevokeInvitationCommandOutput) => void ): void; - public revokeInvitation( + revokeInvitation( args: RevokeInvitationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeInvitationCommandOutput) => void ): void; - public revokeInvitation( - args: RevokeInvitationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RevokeInvitationCommandOutput) => void), - cb?: (err: any, data?: RevokeInvitationCommandOutput) => void - ): Promise | void { - const command = new RevokeInvitationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Searches address books and lists the ones that meet a set of filter and sort - * criteria.

- */ - public searchAddressBooks( + + /** + * @see {@link SearchAddressBooksCommand} + */ + searchAddressBooks( args: SearchAddressBooksCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchAddressBooks( + searchAddressBooks( args: SearchAddressBooksCommandInput, cb: (err: any, data?: SearchAddressBooksCommandOutput) => void ): void; - public searchAddressBooks( + searchAddressBooks( args: SearchAddressBooksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchAddressBooksCommandOutput) => void ): void; - public searchAddressBooks( - args: SearchAddressBooksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchAddressBooksCommandOutput) => void), - cb?: (err: any, data?: SearchAddressBooksCommandOutput) => void - ): Promise | void { - const command = new SearchAddressBooksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Searches contacts and lists the ones that meet a set of filter and sort - * criteria.

- */ - public searchContacts( + + /** + * @see {@link SearchContactsCommand} + */ + searchContacts( args: SearchContactsCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchContacts( - args: SearchContactsCommandInput, - cb: (err: any, data?: SearchContactsCommandOutput) => void - ): void; - public searchContacts( + searchContacts(args: SearchContactsCommandInput, cb: (err: any, data?: SearchContactsCommandOutput) => void): void; + searchContacts( args: SearchContactsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchContactsCommandOutput) => void ): void; - public searchContacts( - args: SearchContactsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchContactsCommandOutput) => void), - cb?: (err: any, data?: SearchContactsCommandOutput) => void - ): Promise | void { - const command = new SearchContactsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Searches devices and lists the ones that meet a set of filter criteria.

- */ - public searchDevices( - args: SearchDevicesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public searchDevices( - args: SearchDevicesCommandInput, - cb: (err: any, data?: SearchDevicesCommandOutput) => void - ): void; - public searchDevices( + + /** + * @see {@link SearchDevicesCommand} + */ + searchDevices(args: SearchDevicesCommandInput, options?: __HttpHandlerOptions): Promise; + searchDevices(args: SearchDevicesCommandInput, cb: (err: any, data?: SearchDevicesCommandOutput) => void): void; + searchDevices( args: SearchDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchDevicesCommandOutput) => void ): void; - public searchDevices( - args: SearchDevicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchDevicesCommandOutput) => void), - cb?: (err: any, data?: SearchDevicesCommandOutput) => void - ): Promise | void { - const command = new SearchDevicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Searches network profiles and lists the ones that meet a set of filter and sort - * criteria.

- */ - public searchNetworkProfiles( + + /** + * @see {@link SearchNetworkProfilesCommand} + */ + searchNetworkProfiles( args: SearchNetworkProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchNetworkProfiles( + searchNetworkProfiles( args: SearchNetworkProfilesCommandInput, cb: (err: any, data?: SearchNetworkProfilesCommandOutput) => void ): void; - public searchNetworkProfiles( + searchNetworkProfiles( args: SearchNetworkProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchNetworkProfilesCommandOutput) => void ): void; - public searchNetworkProfiles( - args: SearchNetworkProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchNetworkProfilesCommandOutput) => void), - cb?: (err: any, data?: SearchNetworkProfilesCommandOutput) => void - ): Promise | void { - const command = new SearchNetworkProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Searches room profiles and lists the ones that meet a set of filter - * criteria.

- */ - public searchProfiles( + + /** + * @see {@link SearchProfilesCommand} + */ + searchProfiles( args: SearchProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchProfiles( - args: SearchProfilesCommandInput, - cb: (err: any, data?: SearchProfilesCommandOutput) => void - ): void; - public searchProfiles( + searchProfiles(args: SearchProfilesCommandInput, cb: (err: any, data?: SearchProfilesCommandOutput) => void): void; + searchProfiles( args: SearchProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchProfilesCommandOutput) => void ): void; - public searchProfiles( - args: SearchProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchProfilesCommandOutput) => void), - cb?: (err: any, data?: SearchProfilesCommandOutput) => void - ): Promise | void { - const command = new SearchProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Searches rooms and lists the ones that meet a set of filter and sort - * criteria.

- */ - public searchRooms(args: SearchRoomsCommandInput, options?: __HttpHandlerOptions): Promise; - public searchRooms(args: SearchRoomsCommandInput, cb: (err: any, data?: SearchRoomsCommandOutput) => void): void; - public searchRooms( + + /** + * @see {@link SearchRoomsCommand} + */ + searchRooms(args: SearchRoomsCommandInput, options?: __HttpHandlerOptions): Promise; + searchRooms(args: SearchRoomsCommandInput, cb: (err: any, data?: SearchRoomsCommandOutput) => void): void; + searchRooms( args: SearchRoomsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchRoomsCommandOutput) => void ): void; - public searchRooms( - args: SearchRoomsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchRoomsCommandOutput) => void), - cb?: (err: any, data?: SearchRoomsCommandOutput) => void - ): Promise | void { - const command = new SearchRoomsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Searches skill groups and lists the ones that meet a set of filter and sort - * criteria.

- */ - public searchSkillGroups( + + /** + * @see {@link SearchSkillGroupsCommand} + */ + searchSkillGroups( args: SearchSkillGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchSkillGroups( + searchSkillGroups( args: SearchSkillGroupsCommandInput, cb: (err: any, data?: SearchSkillGroupsCommandOutput) => void ): void; - public searchSkillGroups( + searchSkillGroups( args: SearchSkillGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchSkillGroupsCommandOutput) => void ): void; - public searchSkillGroups( - args: SearchSkillGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchSkillGroupsCommandOutput) => void), - cb?: (err: any, data?: SearchSkillGroupsCommandOutput) => void - ): Promise | void { - const command = new SearchSkillGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Searches users and lists the ones that meet a set of filter and sort - * criteria.

- */ - public searchUsers(args: SearchUsersCommandInput, options?: __HttpHandlerOptions): Promise; - public searchUsers(args: SearchUsersCommandInput, cb: (err: any, data?: SearchUsersCommandOutput) => void): void; - public searchUsers( + + /** + * @see {@link SearchUsersCommand} + */ + searchUsers(args: SearchUsersCommandInput, options?: __HttpHandlerOptions): Promise; + searchUsers(args: SearchUsersCommandInput, cb: (err: any, data?: SearchUsersCommandOutput) => void): void; + searchUsers( args: SearchUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchUsersCommandOutput) => void ): void; - public searchUsers( - args: SearchUsersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchUsersCommandOutput) => void), - cb?: (err: any, data?: SearchUsersCommandOutput) => void - ): Promise | void { - const command = new SearchUsersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that - * are identified by a search or filter.

- */ - public sendAnnouncement( + + /** + * @see {@link SendAnnouncementCommand} + */ + sendAnnouncement( args: SendAnnouncementCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendAnnouncement( + sendAnnouncement( args: SendAnnouncementCommandInput, cb: (err: any, data?: SendAnnouncementCommandOutput) => void ): void; - public sendAnnouncement( + sendAnnouncement( args: SendAnnouncementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendAnnouncementCommandOutput) => void ): void; - public sendAnnouncement( - args: SendAnnouncementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendAnnouncementCommandOutput) => void), - cb?: (err: any, data?: SendAnnouncementCommandOutput) => void - ): Promise | void { - const command = new SendAnnouncementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sends an enrollment invitation email with a URL to a user. The URL is valid for 30 - * days or until you call this operation again, whichever comes first.

- */ - public sendInvitation( + + /** + * @see {@link SendInvitationCommand} + */ + sendInvitation( args: SendInvitationCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendInvitation( - args: SendInvitationCommandInput, - cb: (err: any, data?: SendInvitationCommandOutput) => void - ): void; - public sendInvitation( + sendInvitation(args: SendInvitationCommandInput, cb: (err: any, data?: SendInvitationCommandOutput) => void): void; + sendInvitation( args: SendInvitationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendInvitationCommandOutput) => void ): void; - public sendInvitation( - args: SendInvitationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendInvitationCommandOutput) => void), - cb?: (err: any, data?: SendInvitationCommandOutput) => void - ): Promise | void { - const command = new SendInvitationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Resets a device and its account to the known default settings. This clears all - * information and settings set by previous users in the following ways:

- *
    - *
  • - *

    Bluetooth - This unpairs all bluetooth devices paired with your echo - * device.

    - *
  • - *
  • - *

    Volume - This resets the echo device's volume to the default value.

    - *
  • - *
  • - *

    Notifications - This clears all notifications from your echo device.

    - *
  • - *
  • - *

    Lists - This clears all to-do items from your echo device.

    - *
  • - *
  • - *

    Settings - This internally syncs the room's profile (if the device is assigned to - * a room), contacts, address books, delegation access for account linking, and - * communications (if enabled on the room profile).

    - *
  • - *
- */ - public startDeviceSync( + + /** + * @see {@link StartDeviceSyncCommand} + */ + startDeviceSync( args: StartDeviceSyncCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDeviceSync( - args: StartDeviceSyncCommandInput, - cb: (err: any, data?: StartDeviceSyncCommandOutput) => void - ): void; - public startDeviceSync( + startDeviceSync(args: StartDeviceSyncCommandInput, cb: (err: any, data?: StartDeviceSyncCommandOutput) => void): void; + startDeviceSync( args: StartDeviceSyncCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDeviceSyncCommandOutput) => void ): void; - public startDeviceSync( - args: StartDeviceSyncCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDeviceSyncCommandOutput) => void), - cb?: (err: any, data?: StartDeviceSyncCommandOutput) => void - ): Promise | void { - const command = new StartDeviceSyncCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Initiates the discovery of any smart home appliances associated with the - * room.

- */ - public startSmartHomeApplianceDiscovery( + + /** + * @see {@link StartSmartHomeApplianceDiscoveryCommand} + */ + startSmartHomeApplianceDiscovery( args: StartSmartHomeApplianceDiscoveryCommandInput, options?: __HttpHandlerOptions ): Promise; - public startSmartHomeApplianceDiscovery( + startSmartHomeApplianceDiscovery( args: StartSmartHomeApplianceDiscoveryCommandInput, cb: (err: any, data?: StartSmartHomeApplianceDiscoveryCommandOutput) => void ): void; - public startSmartHomeApplianceDiscovery( + startSmartHomeApplianceDiscovery( args: StartSmartHomeApplianceDiscoveryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSmartHomeApplianceDiscoveryCommandOutput) => void ): void; - public startSmartHomeApplianceDiscovery( - args: StartSmartHomeApplianceDiscoveryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartSmartHomeApplianceDiscoveryCommandOutput) => void), - cb?: (err: any, data?: StartSmartHomeApplianceDiscoveryCommandOutput) => void - ): Promise | void { - const command = new StartSmartHomeApplianceDiscoveryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds metadata tags to a specified resource.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes metadata tags from a specified resource.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates address book details by the address book ARN.

- */ - public updateAddressBook( + + /** + * @see {@link UpdateAddressBookCommand} + */ + updateAddressBook( args: UpdateAddressBookCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAddressBook( + updateAddressBook( args: UpdateAddressBookCommandInput, cb: (err: any, data?: UpdateAddressBookCommandOutput) => void ): void; - public updateAddressBook( + updateAddressBook( args: UpdateAddressBookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAddressBookCommandOutput) => void ): void; - public updateAddressBook( - args: UpdateAddressBookCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAddressBookCommandOutput) => void), - cb?: (err: any, data?: UpdateAddressBookCommandOutput) => void - ): Promise | void { - const command = new UpdateAddressBookCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the configuration of the report delivery schedule with the specified schedule - * ARN.

- */ - public updateBusinessReportSchedule( + + /** + * @see {@link UpdateBusinessReportScheduleCommand} + */ + updateBusinessReportSchedule( args: UpdateBusinessReportScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBusinessReportSchedule( + updateBusinessReportSchedule( args: UpdateBusinessReportScheduleCommandInput, cb: (err: any, data?: UpdateBusinessReportScheduleCommandOutput) => void ): void; - public updateBusinessReportSchedule( + updateBusinessReportSchedule( args: UpdateBusinessReportScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBusinessReportScheduleCommandOutput) => void ): void; - public updateBusinessReportSchedule( - args: UpdateBusinessReportScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBusinessReportScheduleCommandOutput) => void), - cb?: (err: any, data?: UpdateBusinessReportScheduleCommandOutput) => void - ): Promise | void { - const command = new UpdateBusinessReportScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing conference provider's settings.

- */ - public updateConferenceProvider( + + /** + * @see {@link UpdateConferenceProviderCommand} + */ + updateConferenceProvider( args: UpdateConferenceProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConferenceProvider( + updateConferenceProvider( args: UpdateConferenceProviderCommandInput, cb: (err: any, data?: UpdateConferenceProviderCommandOutput) => void ): void; - public updateConferenceProvider( + updateConferenceProvider( args: UpdateConferenceProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConferenceProviderCommandOutput) => void ): void; - public updateConferenceProvider( - args: UpdateConferenceProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConferenceProviderCommandOutput) => void), - cb?: (err: any, data?: UpdateConferenceProviderCommandOutput) => void - ): Promise | void { - const command = new UpdateConferenceProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the contact details by the contact ARN.

- */ - public updateContact( - args: UpdateContactCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateContact( - args: UpdateContactCommandInput, - cb: (err: any, data?: UpdateContactCommandOutput) => void - ): void; - public updateContact( + + /** + * @see {@link UpdateContactCommand} + */ + updateContact(args: UpdateContactCommandInput, options?: __HttpHandlerOptions): Promise; + updateContact(args: UpdateContactCommandInput, cb: (err: any, data?: UpdateContactCommandOutput) => void): void; + updateContact( args: UpdateContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContactCommandOutput) => void ): void; - public updateContact( - args: UpdateContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateContactCommandOutput) => void), - cb?: (err: any, data?: UpdateContactCommandOutput) => void - ): Promise | void { - const command = new UpdateContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the device name by device ARN.

- */ - public updateDevice( - args: UpdateDeviceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateDevice(args: UpdateDeviceCommandInput, cb: (err: any, data?: UpdateDeviceCommandOutput) => void): void; - public updateDevice( + + /** + * @see {@link UpdateDeviceCommand} + */ + updateDevice(args: UpdateDeviceCommandInput, options?: __HttpHandlerOptions): Promise; + updateDevice(args: UpdateDeviceCommandInput, cb: (err: any, data?: UpdateDeviceCommandOutput) => void): void; + updateDevice( args: UpdateDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDeviceCommandOutput) => void ): void; - public updateDevice( - args: UpdateDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDeviceCommandOutput) => void), - cb?: (err: any, data?: UpdateDeviceCommandOutput) => void - ): Promise | void { - const command = new UpdateDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the details of a gateway. If any optional field is not provided, the existing - * corresponding value is left unmodified.

- */ - public updateGateway( - args: UpdateGatewayCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateGateway( - args: UpdateGatewayCommandInput, - cb: (err: any, data?: UpdateGatewayCommandOutput) => void - ): void; - public updateGateway( + + /** + * @see {@link UpdateGatewayCommand} + */ + updateGateway(args: UpdateGatewayCommandInput, options?: __HttpHandlerOptions): Promise; + updateGateway(args: UpdateGatewayCommandInput, cb: (err: any, data?: UpdateGatewayCommandOutput) => void): void; + updateGateway( args: UpdateGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGatewayCommandOutput) => void ): void; - public updateGateway( - args: UpdateGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGatewayCommandOutput) => void), - cb?: (err: any, data?: UpdateGatewayCommandOutput) => void - ): Promise | void { - const command = new UpdateGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the details of a gateway group. If any optional field is not provided, the - * existing corresponding value is left unmodified.

- */ - public updateGatewayGroup( + + /** + * @see {@link UpdateGatewayGroupCommand} + */ + updateGatewayGroup( args: UpdateGatewayGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGatewayGroup( + updateGatewayGroup( args: UpdateGatewayGroupCommandInput, cb: (err: any, data?: UpdateGatewayGroupCommandOutput) => void ): void; - public updateGatewayGroup( + updateGatewayGroup( args: UpdateGatewayGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGatewayGroupCommandOutput) => void ): void; - public updateGatewayGroup( - args: UpdateGatewayGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGatewayGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateGatewayGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateGatewayGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a network profile by the network profile ARN.

- */ - public updateNetworkProfile( + + /** + * @see {@link UpdateNetworkProfileCommand} + */ + updateNetworkProfile( args: UpdateNetworkProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateNetworkProfile( + updateNetworkProfile( args: UpdateNetworkProfileCommandInput, cb: (err: any, data?: UpdateNetworkProfileCommandOutput) => void ): void; - public updateNetworkProfile( + updateNetworkProfile( args: UpdateNetworkProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNetworkProfileCommandOutput) => void ): void; - public updateNetworkProfile( - args: UpdateNetworkProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateNetworkProfileCommandOutput) => void), - cb?: (err: any, data?: UpdateNetworkProfileCommandOutput) => void - ): Promise | void { - const command = new UpdateNetworkProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing room profile by room profile ARN.

- */ - public updateProfile( - args: UpdateProfileCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateProfile( - args: UpdateProfileCommandInput, - cb: (err: any, data?: UpdateProfileCommandOutput) => void - ): void; - public updateProfile( + + /** + * @see {@link UpdateProfileCommand} + */ + updateProfile(args: UpdateProfileCommandInput, options?: __HttpHandlerOptions): Promise; + updateProfile(args: UpdateProfileCommandInput, cb: (err: any, data?: UpdateProfileCommandOutput) => void): void; + updateProfile( args: UpdateProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProfileCommandOutput) => void ): void; - public updateProfile( - args: UpdateProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProfileCommandOutput) => void), - cb?: (err: any, data?: UpdateProfileCommandOutput) => void - ): Promise | void { - const command = new UpdateProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates room details by room ARN.

- */ - public updateRoom(args: UpdateRoomCommandInput, options?: __HttpHandlerOptions): Promise; - public updateRoom(args: UpdateRoomCommandInput, cb: (err: any, data?: UpdateRoomCommandOutput) => void): void; - public updateRoom( + + /** + * @see {@link UpdateRoomCommand} + */ + updateRoom(args: UpdateRoomCommandInput, options?: __HttpHandlerOptions): Promise; + updateRoom(args: UpdateRoomCommandInput, cb: (err: any, data?: UpdateRoomCommandOutput) => void): void; + updateRoom( args: UpdateRoomCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRoomCommandOutput) => void ): void; - public updateRoom( - args: UpdateRoomCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRoomCommandOutput) => void), - cb?: (err: any, data?: UpdateRoomCommandOutput) => void - ): Promise | void { - const command = new UpdateRoomCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates skill group details by skill group ARN.

- */ - public updateSkillGroup( + + /** + * @see {@link UpdateSkillGroupCommand} + */ + updateSkillGroup( args: UpdateSkillGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSkillGroup( + updateSkillGroup( args: UpdateSkillGroupCommandInput, cb: (err: any, data?: UpdateSkillGroupCommandOutput) => void ): void; - public updateSkillGroup( + updateSkillGroup( args: UpdateSkillGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSkillGroupCommandOutput) => void ): void; - public updateSkillGroup( - args: UpdateSkillGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSkillGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateSkillGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateSkillGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Alexa for Business helps you use Alexa in your organization. Alexa for Business provides you with the tools + * to manage Alexa devices, enroll your users, and assign skills, at scale. You can build your + * own context-aware voice skills using the Alexa Skills Kit and the Alexa for Business API operations. + * You can also make these available as private skills for your organization. Alexa for Business makes it + * efficient to voice-enable your products and services, thus providing context-aware voice + * experiences for your customers. Device makers building with the Alexa Voice Service (AVS) + * can create fully integrated solutions, register their products with Alexa for Business, and manage them + * as shared devices in their organization.

+ */ +export class AlexaForBusiness extends AlexaForBusinessClient implements AlexaForBusiness {} +createAggregatedClient(commands, AlexaForBusiness); diff --git a/clients/client-amp/src/Amp.ts b/clients/client-amp/src/Amp.ts index 3b146dd64ebe..501da935bcd3 100644 --- a/clients/client-amp/src/Amp.ts +++ b/clients/client-amp/src/Amp.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { AmpClient } from "./AmpClient"; +import { AmpClient, AmpClientConfig } from "./AmpClient"; import { CreateAlertManagerDefinitionCommand, CreateAlertManagerDefinitionCommandInput, @@ -104,695 +105,371 @@ import { UpdateWorkspaceAliasCommandOutput, } from "./commands/UpdateWorkspaceAliasCommand"; -/** - * @public - * Amazon Managed Service for Prometheus - */ -export class Amp extends AmpClient { +const commands = { + CreateAlertManagerDefinitionCommand, + CreateLoggingConfigurationCommand, + CreateRuleGroupsNamespaceCommand, + CreateWorkspaceCommand, + DeleteAlertManagerDefinitionCommand, + DeleteLoggingConfigurationCommand, + DeleteRuleGroupsNamespaceCommand, + DeleteWorkspaceCommand, + DescribeAlertManagerDefinitionCommand, + DescribeLoggingConfigurationCommand, + DescribeRuleGroupsNamespaceCommand, + DescribeWorkspaceCommand, + ListRuleGroupsNamespacesCommand, + ListTagsForResourceCommand, + ListWorkspacesCommand, + PutAlertManagerDefinitionCommand, + PutRuleGroupsNamespaceCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateLoggingConfigurationCommand, + UpdateWorkspaceAliasCommand, +}; + +export interface Amp { /** - * @public - * Create an alert manager definition. + * @see {@link CreateAlertManagerDefinitionCommand} */ - public createAlertManagerDefinition( + createAlertManagerDefinition( args: CreateAlertManagerDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAlertManagerDefinition( + createAlertManagerDefinition( args: CreateAlertManagerDefinitionCommandInput, cb: (err: any, data?: CreateAlertManagerDefinitionCommandOutput) => void ): void; - public createAlertManagerDefinition( + createAlertManagerDefinition( args: CreateAlertManagerDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAlertManagerDefinitionCommandOutput) => void ): void; - public createAlertManagerDefinition( - args: CreateAlertManagerDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAlertManagerDefinitionCommandOutput) => void), - cb?: (err: any, data?: CreateAlertManagerDefinitionCommandOutput) => void - ): Promise | void { - const command = new CreateAlertManagerDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Create logging configuration. + * @see {@link CreateLoggingConfigurationCommand} */ - public createLoggingConfiguration( + createLoggingConfiguration( args: CreateLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLoggingConfiguration( + createLoggingConfiguration( args: CreateLoggingConfigurationCommandInput, cb: (err: any, data?: CreateLoggingConfigurationCommandOutput) => void ): void; - public createLoggingConfiguration( + createLoggingConfiguration( args: CreateLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLoggingConfigurationCommandOutput) => void ): void; - public createLoggingConfiguration( - args: CreateLoggingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Create a rule group namespace. + * @see {@link CreateRuleGroupsNamespaceCommand} */ - public createRuleGroupsNamespace( + createRuleGroupsNamespace( args: CreateRuleGroupsNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRuleGroupsNamespace( + createRuleGroupsNamespace( args: CreateRuleGroupsNamespaceCommandInput, cb: (err: any, data?: CreateRuleGroupsNamespaceCommandOutput) => void ): void; - public createRuleGroupsNamespace( + createRuleGroupsNamespace( args: CreateRuleGroupsNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRuleGroupsNamespaceCommandOutput) => void ): void; - public createRuleGroupsNamespace( - args: CreateRuleGroupsNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRuleGroupsNamespaceCommandOutput) => void), - cb?: (err: any, data?: CreateRuleGroupsNamespaceCommandOutput) => void - ): Promise | void { - const command = new CreateRuleGroupsNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Creates a new AMP workspace. + * @see {@link CreateWorkspaceCommand} */ - public createWorkspace( + createWorkspace( args: CreateWorkspaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorkspace( - args: CreateWorkspaceCommandInput, - cb: (err: any, data?: CreateWorkspaceCommandOutput) => void - ): void; - public createWorkspace( + createWorkspace(args: CreateWorkspaceCommandInput, cb: (err: any, data?: CreateWorkspaceCommandOutput) => void): void; + createWorkspace( args: CreateWorkspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkspaceCommandOutput) => void ): void; - public createWorkspace( - args: CreateWorkspaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorkspaceCommandOutput) => void), - cb?: (err: any, data?: CreateWorkspaceCommandOutput) => void - ): Promise | void { - const command = new CreateWorkspaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Deletes an alert manager definition. + * @see {@link DeleteAlertManagerDefinitionCommand} */ - public deleteAlertManagerDefinition( + deleteAlertManagerDefinition( args: DeleteAlertManagerDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAlertManagerDefinition( + deleteAlertManagerDefinition( args: DeleteAlertManagerDefinitionCommandInput, cb: (err: any, data?: DeleteAlertManagerDefinitionCommandOutput) => void ): void; - public deleteAlertManagerDefinition( + deleteAlertManagerDefinition( args: DeleteAlertManagerDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAlertManagerDefinitionCommandOutput) => void ): void; - public deleteAlertManagerDefinition( - args: DeleteAlertManagerDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAlertManagerDefinitionCommandOutput) => void), - cb?: (err: any, data?: DeleteAlertManagerDefinitionCommandOutput) => void - ): Promise | void { - const command = new DeleteAlertManagerDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Delete logging configuration. + * @see {@link DeleteLoggingConfigurationCommand} */ - public deleteLoggingConfiguration( + deleteLoggingConfiguration( args: DeleteLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLoggingConfiguration( + deleteLoggingConfiguration( args: DeleteLoggingConfigurationCommandInput, cb: (err: any, data?: DeleteLoggingConfigurationCommandOutput) => void ): void; - public deleteLoggingConfiguration( + deleteLoggingConfiguration( args: DeleteLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLoggingConfigurationCommandOutput) => void ): void; - public deleteLoggingConfiguration( - args: DeleteLoggingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Delete a rule groups namespace. + * @see {@link DeleteRuleGroupsNamespaceCommand} */ - public deleteRuleGroupsNamespace( + deleteRuleGroupsNamespace( args: DeleteRuleGroupsNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRuleGroupsNamespace( + deleteRuleGroupsNamespace( args: DeleteRuleGroupsNamespaceCommandInput, cb: (err: any, data?: DeleteRuleGroupsNamespaceCommandOutput) => void ): void; - public deleteRuleGroupsNamespace( + deleteRuleGroupsNamespace( args: DeleteRuleGroupsNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRuleGroupsNamespaceCommandOutput) => void ): void; - public deleteRuleGroupsNamespace( - args: DeleteRuleGroupsNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRuleGroupsNamespaceCommandOutput) => void), - cb?: (err: any, data?: DeleteRuleGroupsNamespaceCommandOutput) => void - ): Promise | void { - const command = new DeleteRuleGroupsNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Deletes an AMP workspace. + * @see {@link DeleteWorkspaceCommand} */ - public deleteWorkspace( + deleteWorkspace( args: DeleteWorkspaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWorkspace( - args: DeleteWorkspaceCommandInput, - cb: (err: any, data?: DeleteWorkspaceCommandOutput) => void - ): void; - public deleteWorkspace( + deleteWorkspace(args: DeleteWorkspaceCommandInput, cb: (err: any, data?: DeleteWorkspaceCommandOutput) => void): void; + deleteWorkspace( args: DeleteWorkspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkspaceCommandOutput) => void ): void; - public deleteWorkspace( - args: DeleteWorkspaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorkspaceCommandOutput) => void), - cb?: (err: any, data?: DeleteWorkspaceCommandOutput) => void - ): Promise | void { - const command = new DeleteWorkspaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Describes an alert manager definition. + * @see {@link DescribeAlertManagerDefinitionCommand} */ - public describeAlertManagerDefinition( + describeAlertManagerDefinition( args: DescribeAlertManagerDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAlertManagerDefinition( + describeAlertManagerDefinition( args: DescribeAlertManagerDefinitionCommandInput, cb: (err: any, data?: DescribeAlertManagerDefinitionCommandOutput) => void ): void; - public describeAlertManagerDefinition( + describeAlertManagerDefinition( args: DescribeAlertManagerDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAlertManagerDefinitionCommandOutput) => void ): void; - public describeAlertManagerDefinition( - args: DescribeAlertManagerDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAlertManagerDefinitionCommandOutput) => void), - cb?: (err: any, data?: DescribeAlertManagerDefinitionCommandOutput) => void - ): Promise | void { - const command = new DescribeAlertManagerDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Describes logging configuration. + * @see {@link DescribeLoggingConfigurationCommand} */ - public describeLoggingConfiguration( + describeLoggingConfiguration( args: DescribeLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLoggingConfiguration( + describeLoggingConfiguration( args: DescribeLoggingConfigurationCommandInput, cb: (err: any, data?: DescribeLoggingConfigurationCommandOutput) => void ): void; - public describeLoggingConfiguration( + describeLoggingConfiguration( args: DescribeLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLoggingConfigurationCommandOutput) => void ): void; - public describeLoggingConfiguration( - args: DescribeLoggingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Describe a rule groups namespace. + * @see {@link DescribeRuleGroupsNamespaceCommand} */ - public describeRuleGroupsNamespace( + describeRuleGroupsNamespace( args: DescribeRuleGroupsNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRuleGroupsNamespace( + describeRuleGroupsNamespace( args: DescribeRuleGroupsNamespaceCommandInput, cb: (err: any, data?: DescribeRuleGroupsNamespaceCommandOutput) => void ): void; - public describeRuleGroupsNamespace( + describeRuleGroupsNamespace( args: DescribeRuleGroupsNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRuleGroupsNamespaceCommandOutput) => void ): void; - public describeRuleGroupsNamespace( - args: DescribeRuleGroupsNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRuleGroupsNamespaceCommandOutput) => void), - cb?: (err: any, data?: DescribeRuleGroupsNamespaceCommandOutput) => void - ): Promise | void { - const command = new DescribeRuleGroupsNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Describes an existing AMP workspace. + * @see {@link DescribeWorkspaceCommand} */ - public describeWorkspace( + describeWorkspace( args: DescribeWorkspaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWorkspace( + describeWorkspace( args: DescribeWorkspaceCommandInput, cb: (err: any, data?: DescribeWorkspaceCommandOutput) => void ): void; - public describeWorkspace( + describeWorkspace( args: DescribeWorkspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspaceCommandOutput) => void ): void; - public describeWorkspace( - args: DescribeWorkspaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWorkspaceCommandOutput) => void), - cb?: (err: any, data?: DescribeWorkspaceCommandOutput) => void - ): Promise | void { - const command = new DescribeWorkspaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Lists rule groups namespaces. + * @see {@link ListRuleGroupsNamespacesCommand} */ - public listRuleGroupsNamespaces( + listRuleGroupsNamespaces( args: ListRuleGroupsNamespacesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRuleGroupsNamespaces( + listRuleGroupsNamespaces( args: ListRuleGroupsNamespacesCommandInput, cb: (err: any, data?: ListRuleGroupsNamespacesCommandOutput) => void ): void; - public listRuleGroupsNamespaces( + listRuleGroupsNamespaces( args: ListRuleGroupsNamespacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRuleGroupsNamespacesCommandOutput) => void ): void; - public listRuleGroupsNamespaces( - args: ListRuleGroupsNamespacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRuleGroupsNamespacesCommandOutput) => void), - cb?: (err: any, data?: ListRuleGroupsNamespacesCommandOutput) => void - ): Promise | void { - const command = new ListRuleGroupsNamespacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Lists the tags you have assigned to the resource. + * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Lists all AMP workspaces, including workspaces being created or deleted. + * @see {@link ListWorkspacesCommand} */ - public listWorkspaces( + listWorkspaces( args: ListWorkspacesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWorkspaces( - args: ListWorkspacesCommandInput, - cb: (err: any, data?: ListWorkspacesCommandOutput) => void - ): void; - public listWorkspaces( + listWorkspaces(args: ListWorkspacesCommandInput, cb: (err: any, data?: ListWorkspacesCommandOutput) => void): void; + listWorkspaces( args: ListWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkspacesCommandOutput) => void ): void; - public listWorkspaces( - args: ListWorkspacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkspacesCommandOutput) => void), - cb?: (err: any, data?: ListWorkspacesCommandOutput) => void - ): Promise | void { - const command = new ListWorkspacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Update an alert manager definition. + * @see {@link PutAlertManagerDefinitionCommand} */ - public putAlertManagerDefinition( + putAlertManagerDefinition( args: PutAlertManagerDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAlertManagerDefinition( + putAlertManagerDefinition( args: PutAlertManagerDefinitionCommandInput, cb: (err: any, data?: PutAlertManagerDefinitionCommandOutput) => void ): void; - public putAlertManagerDefinition( + putAlertManagerDefinition( args: PutAlertManagerDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAlertManagerDefinitionCommandOutput) => void ): void; - public putAlertManagerDefinition( - args: PutAlertManagerDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAlertManagerDefinitionCommandOutput) => void), - cb?: (err: any, data?: PutAlertManagerDefinitionCommandOutput) => void - ): Promise | void { - const command = new PutAlertManagerDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Update a rule groups namespace. + * @see {@link PutRuleGroupsNamespaceCommand} */ - public putRuleGroupsNamespace( + putRuleGroupsNamespace( args: PutRuleGroupsNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public putRuleGroupsNamespace( + putRuleGroupsNamespace( args: PutRuleGroupsNamespaceCommandInput, cb: (err: any, data?: PutRuleGroupsNamespaceCommandOutput) => void ): void; - public putRuleGroupsNamespace( + putRuleGroupsNamespace( args: PutRuleGroupsNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRuleGroupsNamespaceCommandOutput) => void ): void; - public putRuleGroupsNamespace( - args: PutRuleGroupsNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRuleGroupsNamespaceCommandOutput) => void), - cb?: (err: any, data?: PutRuleGroupsNamespaceCommandOutput) => void - ): Promise | void { - const command = new PutRuleGroupsNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Creates tags for the specified resource. + * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Deletes tags from the specified resource. + * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Update logging configuration. + * @see {@link UpdateLoggingConfigurationCommand} */ - public updateLoggingConfiguration( + updateLoggingConfiguration( args: UpdateLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLoggingConfiguration( + updateLoggingConfiguration( args: UpdateLoggingConfigurationCommandInput, cb: (err: any, data?: UpdateLoggingConfigurationCommandOutput) => void ): void; - public updateLoggingConfiguration( + updateLoggingConfiguration( args: UpdateLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLoggingConfigurationCommandOutput) => void ): void; - public updateLoggingConfiguration( - args: UpdateLoggingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Updates an AMP workspace alias. + * @see {@link UpdateWorkspaceAliasCommand} */ - public updateWorkspaceAlias( + updateWorkspaceAlias( args: UpdateWorkspaceAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWorkspaceAlias( + updateWorkspaceAlias( args: UpdateWorkspaceAliasCommandInput, cb: (err: any, data?: UpdateWorkspaceAliasCommandOutput) => void ): void; - public updateWorkspaceAlias( + updateWorkspaceAlias( args: UpdateWorkspaceAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkspaceAliasCommandOutput) => void ): void; - public updateWorkspaceAlias( - args: UpdateWorkspaceAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWorkspaceAliasCommandOutput) => void), - cb?: (err: any, data?: UpdateWorkspaceAliasCommandOutput) => void - ): Promise | void { - const command = new UpdateWorkspaceAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Managed Service for Prometheus + */ +export class Amp extends AmpClient implements Amp {} +createAggregatedClient(commands, Amp); diff --git a/clients/client-amplify/src/Amplify.ts b/clients/client-amplify/src/Amplify.ts index c69edb07cecb..c95d0ba9b69f 100644 --- a/clients/client-amplify/src/Amplify.ts +++ b/clients/client-amplify/src/Amplify.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { AmplifyClient } from "./AmplifyClient"; +import { AmplifyClient, AmplifyClientConfig } from "./AmplifyClient"; import { CreateAppCommand, CreateAppCommandInput, CreateAppCommandOutput } from "./commands/CreateAppCommand"; import { CreateBackendEnvironmentCommand, @@ -136,1145 +137,541 @@ import { UpdateWebhookCommandOutput, } from "./commands/UpdateWebhookCommand"; -/** - * @public - *

Amplify enables developers to develop and deploy cloud-powered mobile and web apps. - * The Amplify Console provides a continuous delivery and hosting service for web - * applications. For more information, see the Amplify Console User Guide. The - * Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation - * for client app development. For more information, see the Amplify Framework. - *

- */ -export class Amplify extends AmplifyClient { +const commands = { + CreateAppCommand, + CreateBackendEnvironmentCommand, + CreateBranchCommand, + CreateDeploymentCommand, + CreateDomainAssociationCommand, + CreateWebhookCommand, + DeleteAppCommand, + DeleteBackendEnvironmentCommand, + DeleteBranchCommand, + DeleteDomainAssociationCommand, + DeleteJobCommand, + DeleteWebhookCommand, + GenerateAccessLogsCommand, + GetAppCommand, + GetArtifactUrlCommand, + GetBackendEnvironmentCommand, + GetBranchCommand, + GetDomainAssociationCommand, + GetJobCommand, + GetWebhookCommand, + ListAppsCommand, + ListArtifactsCommand, + ListBackendEnvironmentsCommand, + ListBranchesCommand, + ListDomainAssociationsCommand, + ListJobsCommand, + ListTagsForResourceCommand, + ListWebhooksCommand, + StartDeploymentCommand, + StartJobCommand, + StopJobCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAppCommand, + UpdateBranchCommand, + UpdateDomainAssociationCommand, + UpdateWebhookCommand, +}; + +export interface Amplify { /** - * @public - *

Creates a new Amplify app.

+ * @see {@link CreateAppCommand} */ - public createApp(args: CreateAppCommandInput, options?: __HttpHandlerOptions): Promise; - public createApp(args: CreateAppCommandInput, cb: (err: any, data?: CreateAppCommandOutput) => void): void; - public createApp( + createApp(args: CreateAppCommandInput, options?: __HttpHandlerOptions): Promise; + createApp(args: CreateAppCommandInput, cb: (err: any, data?: CreateAppCommandOutput) => void): void; + createApp( args: CreateAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppCommandOutput) => void ): void; - public createApp( - args: CreateAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAppCommandOutput) => void), - cb?: (err: any, data?: CreateAppCommandOutput) => void - ): Promise | void { - const command = new CreateAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new backend environment for an Amplify app.

+ * @see {@link CreateBackendEnvironmentCommand} */ - public createBackendEnvironment( + createBackendEnvironment( args: CreateBackendEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBackendEnvironment( + createBackendEnvironment( args: CreateBackendEnvironmentCommandInput, cb: (err: any, data?: CreateBackendEnvironmentCommandOutput) => void ): void; - public createBackendEnvironment( + createBackendEnvironment( args: CreateBackendEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBackendEnvironmentCommandOutput) => void ): void; - public createBackendEnvironment( - args: CreateBackendEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBackendEnvironmentCommandOutput) => void), - cb?: (err: any, data?: CreateBackendEnvironmentCommandOutput) => void - ): Promise | void { - const command = new CreateBackendEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new branch for an Amplify app.

+ * @see {@link CreateBranchCommand} */ - public createBranch( - args: CreateBranchCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createBranch(args: CreateBranchCommandInput, cb: (err: any, data?: CreateBranchCommandOutput) => void): void; - public createBranch( + createBranch(args: CreateBranchCommandInput, options?: __HttpHandlerOptions): Promise; + createBranch(args: CreateBranchCommandInput, cb: (err: any, data?: CreateBranchCommandOutput) => void): void; + createBranch( args: CreateBranchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBranchCommandOutput) => void ): void; - public createBranch( - args: CreateBranchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBranchCommandOutput) => void), - cb?: (err: any, data?: CreateBranchCommandOutput) => void - ): Promise | void { - const command = new CreateBranchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a deployment for a manually deployed Amplify app. Manually deployed apps are - * not connected to a repository.

+ * @see {@link CreateDeploymentCommand} */ - public createDeployment( + createDeployment( args: CreateDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDeployment( + createDeployment( args: CreateDeploymentCommandInput, cb: (err: any, data?: CreateDeploymentCommandOutput) => void ): void; - public createDeployment( + createDeployment( args: CreateDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeploymentCommandOutput) => void ): void; - public createDeployment( - args: CreateDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDeploymentCommandOutput) => void), - cb?: (err: any, data?: CreateDeploymentCommandOutput) => void - ): Promise | void { - const command = new CreateDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new domain association for an Amplify app. This action associates a custom - * domain with the Amplify app

+ * @see {@link CreateDomainAssociationCommand} */ - public createDomainAssociation( + createDomainAssociation( args: CreateDomainAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDomainAssociation( + createDomainAssociation( args: CreateDomainAssociationCommandInput, cb: (err: any, data?: CreateDomainAssociationCommandOutput) => void ): void; - public createDomainAssociation( + createDomainAssociation( args: CreateDomainAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDomainAssociationCommandOutput) => void ): void; - public createDomainAssociation( - args: CreateDomainAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDomainAssociationCommandOutput) => void), - cb?: (err: any, data?: CreateDomainAssociationCommandOutput) => void - ): Promise | void { - const command = new CreateDomainAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new webhook on an Amplify app.

+ * @see {@link CreateWebhookCommand} */ - public createWebhook( - args: CreateWebhookCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createWebhook( - args: CreateWebhookCommandInput, - cb: (err: any, data?: CreateWebhookCommandOutput) => void - ): void; - public createWebhook( + createWebhook(args: CreateWebhookCommandInput, options?: __HttpHandlerOptions): Promise; + createWebhook(args: CreateWebhookCommandInput, cb: (err: any, data?: CreateWebhookCommandOutput) => void): void; + createWebhook( args: CreateWebhookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWebhookCommandOutput) => void ): void; - public createWebhook( - args: CreateWebhookCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWebhookCommandOutput) => void), - cb?: (err: any, data?: CreateWebhookCommandOutput) => void - ): Promise | void { - const command = new CreateWebhookCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing Amplify app specified by an app ID.

+ * @see {@link DeleteAppCommand} */ - public deleteApp(args: DeleteAppCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteApp(args: DeleteAppCommandInput, cb: (err: any, data?: DeleteAppCommandOutput) => void): void; - public deleteApp( + deleteApp(args: DeleteAppCommandInput, options?: __HttpHandlerOptions): Promise; + deleteApp(args: DeleteAppCommandInput, cb: (err: any, data?: DeleteAppCommandOutput) => void): void; + deleteApp( args: DeleteAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppCommandOutput) => void ): void; - public deleteApp( - args: DeleteAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppCommandOutput) => void), - cb?: (err: any, data?: DeleteAppCommandOutput) => void - ): Promise | void { - const command = new DeleteAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a backend environment for an Amplify app.

+ * @see {@link DeleteBackendEnvironmentCommand} */ - public deleteBackendEnvironment( + deleteBackendEnvironment( args: DeleteBackendEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBackendEnvironment( + deleteBackendEnvironment( args: DeleteBackendEnvironmentCommandInput, cb: (err: any, data?: DeleteBackendEnvironmentCommandOutput) => void ): void; - public deleteBackendEnvironment( + deleteBackendEnvironment( args: DeleteBackendEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackendEnvironmentCommandOutput) => void ): void; - public deleteBackendEnvironment( - args: DeleteBackendEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBackendEnvironmentCommandOutput) => void), - cb?: (err: any, data?: DeleteBackendEnvironmentCommandOutput) => void - ): Promise | void { - const command = new DeleteBackendEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a branch for an Amplify app.

+ * @see {@link DeleteBranchCommand} */ - public deleteBranch( - args: DeleteBranchCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteBranch(args: DeleteBranchCommandInput, cb: (err: any, data?: DeleteBranchCommandOutput) => void): void; - public deleteBranch( + deleteBranch(args: DeleteBranchCommandInput, options?: __HttpHandlerOptions): Promise; + deleteBranch(args: DeleteBranchCommandInput, cb: (err: any, data?: DeleteBranchCommandOutput) => void): void; + deleteBranch( args: DeleteBranchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBranchCommandOutput) => void ): void; - public deleteBranch( - args: DeleteBranchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBranchCommandOutput) => void), - cb?: (err: any, data?: DeleteBranchCommandOutput) => void - ): Promise | void { - const command = new DeleteBranchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a domain association for an Amplify app.

+ * @see {@link DeleteDomainAssociationCommand} */ - public deleteDomainAssociation( + deleteDomainAssociation( args: DeleteDomainAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDomainAssociation( + deleteDomainAssociation( args: DeleteDomainAssociationCommandInput, cb: (err: any, data?: DeleteDomainAssociationCommandOutput) => void ): void; - public deleteDomainAssociation( + deleteDomainAssociation( args: DeleteDomainAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDomainAssociationCommandOutput) => void ): void; - public deleteDomainAssociation( - args: DeleteDomainAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDomainAssociationCommandOutput) => void), - cb?: (err: any, data?: DeleteDomainAssociationCommandOutput) => void - ): Promise | void { - const command = new DeleteDomainAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a job for a branch of an Amplify app.

+ * @see {@link DeleteJobCommand} */ - public deleteJob(args: DeleteJobCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteJob(args: DeleteJobCommandInput, cb: (err: any, data?: DeleteJobCommandOutput) => void): void; - public deleteJob( + deleteJob(args: DeleteJobCommandInput, options?: __HttpHandlerOptions): Promise; + deleteJob(args: DeleteJobCommandInput, cb: (err: any, data?: DeleteJobCommandOutput) => void): void; + deleteJob( args: DeleteJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteJobCommandOutput) => void ): void; - public deleteJob( - args: DeleteJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteJobCommandOutput) => void), - cb?: (err: any, data?: DeleteJobCommandOutput) => void - ): Promise | void { - const command = new DeleteJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a webhook.

+ * @see {@link DeleteWebhookCommand} */ - public deleteWebhook( - args: DeleteWebhookCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteWebhook( - args: DeleteWebhookCommandInput, - cb: (err: any, data?: DeleteWebhookCommandOutput) => void - ): void; - public deleteWebhook( + deleteWebhook(args: DeleteWebhookCommandInput, options?: __HttpHandlerOptions): Promise; + deleteWebhook(args: DeleteWebhookCommandInput, cb: (err: any, data?: DeleteWebhookCommandOutput) => void): void; + deleteWebhook( args: DeleteWebhookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWebhookCommandOutput) => void ): void; - public deleteWebhook( - args: DeleteWebhookCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWebhookCommandOutput) => void), - cb?: (err: any, data?: DeleteWebhookCommandOutput) => void - ): Promise | void { - const command = new DeleteWebhookCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the website access logs for a specific time range using a presigned URL. - *

+ * @see {@link GenerateAccessLogsCommand} */ - public generateAccessLogs( + generateAccessLogs( args: GenerateAccessLogsCommandInput, options?: __HttpHandlerOptions ): Promise; - public generateAccessLogs( + generateAccessLogs( args: GenerateAccessLogsCommandInput, cb: (err: any, data?: GenerateAccessLogsCommandOutput) => void ): void; - public generateAccessLogs( + generateAccessLogs( args: GenerateAccessLogsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateAccessLogsCommandOutput) => void ): void; - public generateAccessLogs( - args: GenerateAccessLogsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GenerateAccessLogsCommandOutput) => void), - cb?: (err: any, data?: GenerateAccessLogsCommandOutput) => void - ): Promise | void { - const command = new GenerateAccessLogsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an existing Amplify app by appID.

+ * @see {@link GetAppCommand} */ - public getApp(args: GetAppCommandInput, options?: __HttpHandlerOptions): Promise; - public getApp(args: GetAppCommandInput, cb: (err: any, data?: GetAppCommandOutput) => void): void; - public getApp( + getApp(args: GetAppCommandInput, options?: __HttpHandlerOptions): Promise; + getApp(args: GetAppCommandInput, cb: (err: any, data?: GetAppCommandOutput) => void): void; + getApp( args: GetAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAppCommandOutput) => void ): void; - public getApp( - args: GetAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAppCommandOutput) => void), - cb?: (err: any, data?: GetAppCommandOutput) => void - ): Promise | void { - const command = new GetAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the artifact info that corresponds to an artifact id.

+ * @see {@link GetArtifactUrlCommand} */ - public getArtifactUrl( + getArtifactUrl( args: GetArtifactUrlCommandInput, options?: __HttpHandlerOptions ): Promise; - public getArtifactUrl( - args: GetArtifactUrlCommandInput, - cb: (err: any, data?: GetArtifactUrlCommandOutput) => void - ): void; - public getArtifactUrl( + getArtifactUrl(args: GetArtifactUrlCommandInput, cb: (err: any, data?: GetArtifactUrlCommandOutput) => void): void; + getArtifactUrl( args: GetArtifactUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetArtifactUrlCommandOutput) => void ): void; - public getArtifactUrl( - args: GetArtifactUrlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetArtifactUrlCommandOutput) => void), - cb?: (err: any, data?: GetArtifactUrlCommandOutput) => void - ): Promise | void { - const command = new GetArtifactUrlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a backend environment for an Amplify app.

+ * @see {@link GetBackendEnvironmentCommand} */ - public getBackendEnvironment( + getBackendEnvironment( args: GetBackendEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBackendEnvironment( + getBackendEnvironment( args: GetBackendEnvironmentCommandInput, cb: (err: any, data?: GetBackendEnvironmentCommandOutput) => void ): void; - public getBackendEnvironment( + getBackendEnvironment( args: GetBackendEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBackendEnvironmentCommandOutput) => void ): void; - public getBackendEnvironment( - args: GetBackendEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBackendEnvironmentCommandOutput) => void), - cb?: (err: any, data?: GetBackendEnvironmentCommandOutput) => void - ): Promise | void { - const command = new GetBackendEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a branch for an Amplify app.

+ * @see {@link GetBranchCommand} */ - public getBranch(args: GetBranchCommandInput, options?: __HttpHandlerOptions): Promise; - public getBranch(args: GetBranchCommandInput, cb: (err: any, data?: GetBranchCommandOutput) => void): void; - public getBranch( + getBranch(args: GetBranchCommandInput, options?: __HttpHandlerOptions): Promise; + getBranch(args: GetBranchCommandInput, cb: (err: any, data?: GetBranchCommandOutput) => void): void; + getBranch( args: GetBranchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBranchCommandOutput) => void ): void; - public getBranch( - args: GetBranchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBranchCommandOutput) => void), - cb?: (err: any, data?: GetBranchCommandOutput) => void - ): Promise | void { - const command = new GetBranchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the domain information for an Amplify app.

+ * @see {@link GetDomainAssociationCommand} */ - public getDomainAssociation( + getDomainAssociation( args: GetDomainAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDomainAssociation( + getDomainAssociation( args: GetDomainAssociationCommandInput, cb: (err: any, data?: GetDomainAssociationCommandOutput) => void ): void; - public getDomainAssociation( + getDomainAssociation( args: GetDomainAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDomainAssociationCommandOutput) => void ): void; - public getDomainAssociation( - args: GetDomainAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDomainAssociationCommandOutput) => void), - cb?: (err: any, data?: GetDomainAssociationCommandOutput) => void - ): Promise | void { - const command = new GetDomainAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a job for a branch of an Amplify app.

+ * @see {@link GetJobCommand} */ - public getJob(args: GetJobCommandInput, options?: __HttpHandlerOptions): Promise; - public getJob(args: GetJobCommandInput, cb: (err: any, data?: GetJobCommandOutput) => void): void; - public getJob( + getJob(args: GetJobCommandInput, options?: __HttpHandlerOptions): Promise; + getJob(args: GetJobCommandInput, cb: (err: any, data?: GetJobCommandOutput) => void): void; + getJob( args: GetJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobCommandOutput) => void ): void; - public getJob( - args: GetJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetJobCommandOutput) => void), - cb?: (err: any, data?: GetJobCommandOutput) => void - ): Promise | void { - const command = new GetJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the webhook information that corresponds to a specified webhook ID.

+ * @see {@link GetWebhookCommand} */ - public getWebhook(args: GetWebhookCommandInput, options?: __HttpHandlerOptions): Promise; - public getWebhook(args: GetWebhookCommandInput, cb: (err: any, data?: GetWebhookCommandOutput) => void): void; - public getWebhook( + getWebhook(args: GetWebhookCommandInput, options?: __HttpHandlerOptions): Promise; + getWebhook(args: GetWebhookCommandInput, cb: (err: any, data?: GetWebhookCommandOutput) => void): void; + getWebhook( args: GetWebhookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWebhookCommandOutput) => void ): void; - public getWebhook( - args: GetWebhookCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWebhookCommandOutput) => void), - cb?: (err: any, data?: GetWebhookCommandOutput) => void - ): Promise | void { - const command = new GetWebhookCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the existing Amplify apps.

+ * @see {@link ListAppsCommand} */ - public listApps(args: ListAppsCommandInput, options?: __HttpHandlerOptions): Promise; - public listApps(args: ListAppsCommandInput, cb: (err: any, data?: ListAppsCommandOutput) => void): void; - public listApps( + listApps(args: ListAppsCommandInput, options?: __HttpHandlerOptions): Promise; + listApps(args: ListAppsCommandInput, cb: (err: any, data?: ListAppsCommandOutput) => void): void; + listApps( args: ListAppsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppsCommandOutput) => void ): void; - public listApps( - args: ListAppsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppsCommandOutput) => void), - cb?: (err: any, data?: ListAppsCommandOutput) => void - ): Promise | void { - const command = new ListAppsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of artifacts for a specified app, branch, and job.

+ * @see {@link ListArtifactsCommand} */ - public listArtifacts( - args: ListArtifactsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listArtifacts( - args: ListArtifactsCommandInput, - cb: (err: any, data?: ListArtifactsCommandOutput) => void - ): void; - public listArtifacts( + listArtifacts(args: ListArtifactsCommandInput, options?: __HttpHandlerOptions): Promise; + listArtifacts(args: ListArtifactsCommandInput, cb: (err: any, data?: ListArtifactsCommandOutput) => void): void; + listArtifacts( args: ListArtifactsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListArtifactsCommandOutput) => void ): void; - public listArtifacts( - args: ListArtifactsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListArtifactsCommandOutput) => void), - cb?: (err: any, data?: ListArtifactsCommandOutput) => void - ): Promise | void { - const command = new ListArtifactsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the backend environments for an Amplify app.

+ * @see {@link ListBackendEnvironmentsCommand} */ - public listBackendEnvironments( + listBackendEnvironments( args: ListBackendEnvironmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBackendEnvironments( + listBackendEnvironments( args: ListBackendEnvironmentsCommandInput, cb: (err: any, data?: ListBackendEnvironmentsCommandOutput) => void ): void; - public listBackendEnvironments( + listBackendEnvironments( args: ListBackendEnvironmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBackendEnvironmentsCommandOutput) => void ): void; - public listBackendEnvironments( - args: ListBackendEnvironmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBackendEnvironmentsCommandOutput) => void), - cb?: (err: any, data?: ListBackendEnvironmentsCommandOutput) => void - ): Promise | void { - const command = new ListBackendEnvironmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the branches of an Amplify app.

+ * @see {@link ListBranchesCommand} */ - public listBranches( - args: ListBranchesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listBranches(args: ListBranchesCommandInput, cb: (err: any, data?: ListBranchesCommandOutput) => void): void; - public listBranches( + listBranches(args: ListBranchesCommandInput, options?: __HttpHandlerOptions): Promise; + listBranches(args: ListBranchesCommandInput, cb: (err: any, data?: ListBranchesCommandOutput) => void): void; + listBranches( args: ListBranchesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBranchesCommandOutput) => void ): void; - public listBranches( - args: ListBranchesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBranchesCommandOutput) => void), - cb?: (err: any, data?: ListBranchesCommandOutput) => void - ): Promise | void { - const command = new ListBranchesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the domain associations for an Amplify app.

+ * @see {@link ListDomainAssociationsCommand} */ - public listDomainAssociations( + listDomainAssociations( args: ListDomainAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDomainAssociations( + listDomainAssociations( args: ListDomainAssociationsCommandInput, cb: (err: any, data?: ListDomainAssociationsCommandOutput) => void ): void; - public listDomainAssociations( + listDomainAssociations( args: ListDomainAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainAssociationsCommandOutput) => void ): void; - public listDomainAssociations( - args: ListDomainAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDomainAssociationsCommandOutput) => void), - cb?: (err: any, data?: ListDomainAssociationsCommandOutput) => void - ): Promise | void { - const command = new ListDomainAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the jobs for a branch of an Amplify app.

+ * @see {@link ListJobsCommand} */ - public listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise; - public listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void; - public listJobs( + listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise; + listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void; + listJobs( args: ListJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobsCommandOutput) => void ): void; - public listJobs( - args: ListJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJobsCommandOutput) => void), - cb?: (err: any, data?: ListJobsCommandOutput) => void - ): Promise | void { - const command = new ListJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of tags for a specified Amazon Resource Name (ARN).

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of webhooks for an Amplify app.

+ * @see {@link ListWebhooksCommand} */ - public listWebhooks( - args: ListWebhooksCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listWebhooks(args: ListWebhooksCommandInput, cb: (err: any, data?: ListWebhooksCommandOutput) => void): void; - public listWebhooks( + listWebhooks(args: ListWebhooksCommandInput, options?: __HttpHandlerOptions): Promise; + listWebhooks(args: ListWebhooksCommandInput, cb: (err: any, data?: ListWebhooksCommandOutput) => void): void; + listWebhooks( args: ListWebhooksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWebhooksCommandOutput) => void ): void; - public listWebhooks( - args: ListWebhooksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWebhooksCommandOutput) => void), - cb?: (err: any, data?: ListWebhooksCommandOutput) => void - ): Promise | void { - const command = new ListWebhooksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a deployment for a manually deployed app. Manually deployed apps are not - * connected to a repository.

+ * @see {@link StartDeploymentCommand} */ - public startDeployment( + startDeployment( args: StartDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDeployment( - args: StartDeploymentCommandInput, - cb: (err: any, data?: StartDeploymentCommandOutput) => void - ): void; - public startDeployment( + startDeployment(args: StartDeploymentCommandInput, cb: (err: any, data?: StartDeploymentCommandOutput) => void): void; + startDeployment( args: StartDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDeploymentCommandOutput) => void ): void; - public startDeployment( - args: StartDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDeploymentCommandOutput) => void), - cb?: (err: any, data?: StartDeploymentCommandOutput) => void - ): Promise | void { - const command = new StartDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a new job for a branch of an Amplify app.

+ * @see {@link StartJobCommand} */ - public startJob(args: StartJobCommandInput, options?: __HttpHandlerOptions): Promise; - public startJob(args: StartJobCommandInput, cb: (err: any, data?: StartJobCommandOutput) => void): void; - public startJob( + startJob(args: StartJobCommandInput, options?: __HttpHandlerOptions): Promise; + startJob(args: StartJobCommandInput, cb: (err: any, data?: StartJobCommandOutput) => void): void; + startJob( args: StartJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartJobCommandOutput) => void ): void; - public startJob( - args: StartJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartJobCommandOutput) => void), - cb?: (err: any, data?: StartJobCommandOutput) => void - ): Promise | void { - const command = new StartJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops a job that is in progress for a branch of an Amplify app.

+ * @see {@link StopJobCommand} */ - public stopJob(args: StopJobCommandInput, options?: __HttpHandlerOptions): Promise; - public stopJob(args: StopJobCommandInput, cb: (err: any, data?: StopJobCommandOutput) => void): void; - public stopJob( + stopJob(args: StopJobCommandInput, options?: __HttpHandlerOptions): Promise; + stopJob(args: StopJobCommandInput, cb: (err: any, data?: StopJobCommandOutput) => void): void; + stopJob( args: StopJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopJobCommandOutput) => void ): void; - public stopJob( - args: StopJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopJobCommandOutput) => void), - cb?: (err: any, data?: StopJobCommandOutput) => void - ): Promise | void { - const command = new StopJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Tags the resource with a tag key and value.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Untags a resource with a specified Amazon Resource Name (ARN).

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing Amplify app.

+ * @see {@link UpdateAppCommand} */ - public updateApp(args: UpdateAppCommandInput, options?: __HttpHandlerOptions): Promise; - public updateApp(args: UpdateAppCommandInput, cb: (err: any, data?: UpdateAppCommandOutput) => void): void; - public updateApp( + updateApp(args: UpdateAppCommandInput, options?: __HttpHandlerOptions): Promise; + updateApp(args: UpdateAppCommandInput, cb: (err: any, data?: UpdateAppCommandOutput) => void): void; + updateApp( args: UpdateAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAppCommandOutput) => void ): void; - public updateApp( - args: UpdateAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAppCommandOutput) => void), - cb?: (err: any, data?: UpdateAppCommandOutput) => void - ): Promise | void { - const command = new UpdateAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a branch for an Amplify app.

+ * @see {@link UpdateBranchCommand} */ - public updateBranch( - args: UpdateBranchCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateBranch(args: UpdateBranchCommandInput, cb: (err: any, data?: UpdateBranchCommandOutput) => void): void; - public updateBranch( + updateBranch(args: UpdateBranchCommandInput, options?: __HttpHandlerOptions): Promise; + updateBranch(args: UpdateBranchCommandInput, cb: (err: any, data?: UpdateBranchCommandOutput) => void): void; + updateBranch( args: UpdateBranchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBranchCommandOutput) => void ): void; - public updateBranch( - args: UpdateBranchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBranchCommandOutput) => void), - cb?: (err: any, data?: UpdateBranchCommandOutput) => void - ): Promise | void { - const command = new UpdateBranchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new domain association for an Amplify app.

+ * @see {@link UpdateDomainAssociationCommand} */ - public updateDomainAssociation( + updateDomainAssociation( args: UpdateDomainAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDomainAssociation( + updateDomainAssociation( args: UpdateDomainAssociationCommandInput, cb: (err: any, data?: UpdateDomainAssociationCommandOutput) => void ): void; - public updateDomainAssociation( + updateDomainAssociation( args: UpdateDomainAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDomainAssociationCommandOutput) => void ): void; - public updateDomainAssociation( - args: UpdateDomainAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDomainAssociationCommandOutput) => void), - cb?: (err: any, data?: UpdateDomainAssociationCommandOutput) => void - ): Promise | void { - const command = new UpdateDomainAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a webhook.

+ * @see {@link UpdateWebhookCommand} */ - public updateWebhook( - args: UpdateWebhookCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateWebhook( - args: UpdateWebhookCommandInput, - cb: (err: any, data?: UpdateWebhookCommandOutput) => void - ): void; - public updateWebhook( + updateWebhook(args: UpdateWebhookCommandInput, options?: __HttpHandlerOptions): Promise; + updateWebhook(args: UpdateWebhookCommandInput, cb: (err: any, data?: UpdateWebhookCommandOutput) => void): void; + updateWebhook( args: UpdateWebhookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWebhookCommandOutput) => void ): void; - public updateWebhook( - args: UpdateWebhookCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWebhookCommandOutput) => void), - cb?: (err: any, data?: UpdateWebhookCommandOutput) => void - ): Promise | void { - const command = new UpdateWebhookCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amplify enables developers to develop and deploy cloud-powered mobile and web apps. + * The Amplify Console provides a continuous delivery and hosting service for web + * applications. For more information, see the Amplify Console User Guide. The + * Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation + * for client app development. For more information, see the Amplify Framework. + *

+ */ +export class Amplify extends AmplifyClient implements Amplify {} +createAggregatedClient(commands, Amplify); diff --git a/clients/client-amplifybackend/src/AmplifyBackend.ts b/clients/client-amplifybackend/src/AmplifyBackend.ts index 0cca3d49edea..ab0848e414b4 100644 --- a/clients/client-amplifybackend/src/AmplifyBackend.ts +++ b/clients/client-amplifybackend/src/AmplifyBackend.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { AmplifyBackendClient } from "./AmplifyBackendClient"; +import { AmplifyBackendClient, AmplifyBackendClientConfig } from "./AmplifyBackendClient"; import { CloneBackendCommand, CloneBackendCommandInput, @@ -142,1004 +143,506 @@ import { UpdateBackendStorageCommandOutput, } from "./commands/UpdateBackendStorageCommand"; -/** - * @public - *

AWS Amplify Admin API

- */ -export class AmplifyBackend extends AmplifyBackendClient { +const commands = { + CloneBackendCommand, + CreateBackendCommand, + CreateBackendAPICommand, + CreateBackendAuthCommand, + CreateBackendConfigCommand, + CreateBackendStorageCommand, + CreateTokenCommand, + DeleteBackendCommand, + DeleteBackendAPICommand, + DeleteBackendAuthCommand, + DeleteBackendStorageCommand, + DeleteTokenCommand, + GenerateBackendAPIModelsCommand, + GetBackendCommand, + GetBackendAPICommand, + GetBackendAPIModelsCommand, + GetBackendAuthCommand, + GetBackendJobCommand, + GetBackendStorageCommand, + GetTokenCommand, + ImportBackendAuthCommand, + ImportBackendStorageCommand, + ListBackendJobsCommand, + ListS3BucketsCommand, + RemoveAllBackendsCommand, + RemoveBackendConfigCommand, + UpdateBackendAPICommand, + UpdateBackendAuthCommand, + UpdateBackendConfigCommand, + UpdateBackendJobCommand, + UpdateBackendStorageCommand, +}; + +export interface AmplifyBackend { /** - * @public - *

This operation clones an existing backend.

+ * @see {@link CloneBackendCommand} */ - public cloneBackend( - args: CloneBackendCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public cloneBackend(args: CloneBackendCommandInput, cb: (err: any, data?: CloneBackendCommandOutput) => void): void; - public cloneBackend( + cloneBackend(args: CloneBackendCommandInput, options?: __HttpHandlerOptions): Promise; + cloneBackend(args: CloneBackendCommandInput, cb: (err: any, data?: CloneBackendCommandOutput) => void): void; + cloneBackend( args: CloneBackendCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CloneBackendCommandOutput) => void ): void; - public cloneBackend( - args: CloneBackendCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CloneBackendCommandOutput) => void), - cb?: (err: any, data?: CloneBackendCommandOutput) => void - ): Promise | void { - const command = new CloneBackendCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.

+ * @see {@link CreateBackendCommand} */ - public createBackend( - args: CreateBackendCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createBackend( - args: CreateBackendCommandInput, - cb: (err: any, data?: CreateBackendCommandOutput) => void - ): void; - public createBackend( + createBackend(args: CreateBackendCommandInput, options?: __HttpHandlerOptions): Promise; + createBackend(args: CreateBackendCommandInput, cb: (err: any, data?: CreateBackendCommandOutput) => void): void; + createBackend( args: CreateBackendCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBackendCommandOutput) => void ): void; - public createBackend( - args: CreateBackendCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBackendCommandOutput) => void), - cb?: (err: any, data?: CreateBackendCommandOutput) => void - ): Promise | void { - const command = new CreateBackendCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new backend API resource.

+ * @see {@link CreateBackendAPICommand} */ - public createBackendAPI( + createBackendAPI( args: CreateBackendAPICommandInput, options?: __HttpHandlerOptions ): Promise; - public createBackendAPI( + createBackendAPI( args: CreateBackendAPICommandInput, cb: (err: any, data?: CreateBackendAPICommandOutput) => void ): void; - public createBackendAPI( + createBackendAPI( args: CreateBackendAPICommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBackendAPICommandOutput) => void ): void; - public createBackendAPI( - args: CreateBackendAPICommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBackendAPICommandOutput) => void), - cb?: (err: any, data?: CreateBackendAPICommandOutput) => void - ): Promise | void { - const command = new CreateBackendAPICommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new backend authentication resource.

+ * @see {@link CreateBackendAuthCommand} */ - public createBackendAuth( + createBackendAuth( args: CreateBackendAuthCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBackendAuth( + createBackendAuth( args: CreateBackendAuthCommandInput, cb: (err: any, data?: CreateBackendAuthCommandOutput) => void ): void; - public createBackendAuth( + createBackendAuth( args: CreateBackendAuthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBackendAuthCommandOutput) => void ): void; - public createBackendAuth( - args: CreateBackendAuthCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBackendAuthCommandOutput) => void), - cb?: (err: any, data?: CreateBackendAuthCommandOutput) => void - ): Promise | void { - const command = new CreateBackendAuthCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a config object for a backend.

+ * @see {@link CreateBackendConfigCommand} */ - public createBackendConfig( + createBackendConfig( args: CreateBackendConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBackendConfig( + createBackendConfig( args: CreateBackendConfigCommandInput, cb: (err: any, data?: CreateBackendConfigCommandOutput) => void ): void; - public createBackendConfig( + createBackendConfig( args: CreateBackendConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBackendConfigCommandOutput) => void ): void; - public createBackendConfig( - args: CreateBackendConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBackendConfigCommandOutput) => void), - cb?: (err: any, data?: CreateBackendConfigCommandOutput) => void - ): Promise | void { - const command = new CreateBackendConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a backend storage resource.

+ * @see {@link CreateBackendStorageCommand} */ - public createBackendStorage( + createBackendStorage( args: CreateBackendStorageCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBackendStorage( + createBackendStorage( args: CreateBackendStorageCommandInput, cb: (err: any, data?: CreateBackendStorageCommandOutput) => void ): void; - public createBackendStorage( + createBackendStorage( args: CreateBackendStorageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBackendStorageCommandOutput) => void ): void; - public createBackendStorage( - args: CreateBackendStorageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBackendStorageCommandOutput) => void), - cb?: (err: any, data?: CreateBackendStorageCommandOutput) => void - ): Promise | void { - const command = new CreateBackendStorageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.

+ * @see {@link CreateTokenCommand} */ - public createToken(args: CreateTokenCommandInput, options?: __HttpHandlerOptions): Promise; - public createToken(args: CreateTokenCommandInput, cb: (err: any, data?: CreateTokenCommandOutput) => void): void; - public createToken( + createToken(args: CreateTokenCommandInput, options?: __HttpHandlerOptions): Promise; + createToken(args: CreateTokenCommandInput, cb: (err: any, data?: CreateTokenCommandOutput) => void): void; + createToken( args: CreateTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTokenCommandOutput) => void ): void; - public createToken( - args: CreateTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTokenCommandOutput) => void), - cb?: (err: any, data?: CreateTokenCommandOutput) => void - ): Promise | void { - const command = new CreateTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes an existing environment from your Amplify project.

+ * @see {@link DeleteBackendCommand} */ - public deleteBackend( - args: DeleteBackendCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteBackend( - args: DeleteBackendCommandInput, - cb: (err: any, data?: DeleteBackendCommandOutput) => void - ): void; - public deleteBackend( + deleteBackend(args: DeleteBackendCommandInput, options?: __HttpHandlerOptions): Promise; + deleteBackend(args: DeleteBackendCommandInput, cb: (err: any, data?: DeleteBackendCommandOutput) => void): void; + deleteBackend( args: DeleteBackendCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackendCommandOutput) => void ): void; - public deleteBackend( - args: DeleteBackendCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBackendCommandOutput) => void), - cb?: (err: any, data?: DeleteBackendCommandOutput) => void - ): Promise | void { - const command = new DeleteBackendCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing backend API resource.

+ * @see {@link DeleteBackendAPICommand} */ - public deleteBackendAPI( + deleteBackendAPI( args: DeleteBackendAPICommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBackendAPI( + deleteBackendAPI( args: DeleteBackendAPICommandInput, cb: (err: any, data?: DeleteBackendAPICommandOutput) => void ): void; - public deleteBackendAPI( + deleteBackendAPI( args: DeleteBackendAPICommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackendAPICommandOutput) => void ): void; - public deleteBackendAPI( - args: DeleteBackendAPICommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBackendAPICommandOutput) => void), - cb?: (err: any, data?: DeleteBackendAPICommandOutput) => void - ): Promise | void { - const command = new DeleteBackendAPICommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing backend authentication resource.

+ * @see {@link DeleteBackendAuthCommand} */ - public deleteBackendAuth( + deleteBackendAuth( args: DeleteBackendAuthCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBackendAuth( + deleteBackendAuth( args: DeleteBackendAuthCommandInput, cb: (err: any, data?: DeleteBackendAuthCommandOutput) => void ): void; - public deleteBackendAuth( + deleteBackendAuth( args: DeleteBackendAuthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackendAuthCommandOutput) => void ): void; - public deleteBackendAuth( - args: DeleteBackendAuthCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBackendAuthCommandOutput) => void), - cb?: (err: any, data?: DeleteBackendAuthCommandOutput) => void - ): Promise | void { - const command = new DeleteBackendAuthCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified backend storage resource.

+ * @see {@link DeleteBackendStorageCommand} */ - public deleteBackendStorage( + deleteBackendStorage( args: DeleteBackendStorageCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBackendStorage( + deleteBackendStorage( args: DeleteBackendStorageCommandInput, cb: (err: any, data?: DeleteBackendStorageCommandOutput) => void ): void; - public deleteBackendStorage( + deleteBackendStorage( args: DeleteBackendStorageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackendStorageCommandOutput) => void ): void; - public deleteBackendStorage( - args: DeleteBackendStorageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBackendStorageCommandOutput) => void), - cb?: (err: any, data?: DeleteBackendStorageCommandOutput) => void - ): Promise | void { - const command = new DeleteBackendStorageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the challenge token based on the given appId and sessionId.

+ * @see {@link DeleteTokenCommand} */ - public deleteToken(args: DeleteTokenCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteToken(args: DeleteTokenCommandInput, cb: (err: any, data?: DeleteTokenCommandOutput) => void): void; - public deleteToken( + deleteToken(args: DeleteTokenCommandInput, options?: __HttpHandlerOptions): Promise; + deleteToken(args: DeleteTokenCommandInput, cb: (err: any, data?: DeleteTokenCommandOutput) => void): void; + deleteToken( args: DeleteTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTokenCommandOutput) => void ): void; - public deleteToken( - args: DeleteTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTokenCommandOutput) => void), - cb?: (err: any, data?: DeleteTokenCommandOutput) => void - ): Promise | void { - const command = new DeleteTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Generates a model schema for an existing backend API resource.

+ * @see {@link GenerateBackendAPIModelsCommand} */ - public generateBackendAPIModels( + generateBackendAPIModels( args: GenerateBackendAPIModelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public generateBackendAPIModels( + generateBackendAPIModels( args: GenerateBackendAPIModelsCommandInput, cb: (err: any, data?: GenerateBackendAPIModelsCommandOutput) => void ): void; - public generateBackendAPIModels( + generateBackendAPIModels( args: GenerateBackendAPIModelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateBackendAPIModelsCommandOutput) => void ): void; - public generateBackendAPIModels( - args: GenerateBackendAPIModelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GenerateBackendAPIModelsCommandOutput) => void), - cb?: (err: any, data?: GenerateBackendAPIModelsCommandOutput) => void - ): Promise | void { - const command = new GenerateBackendAPIModelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides project-level details for your Amplify UI project.

+ * @see {@link GetBackendCommand} */ - public getBackend(args: GetBackendCommandInput, options?: __HttpHandlerOptions): Promise; - public getBackend(args: GetBackendCommandInput, cb: (err: any, data?: GetBackendCommandOutput) => void): void; - public getBackend( + getBackend(args: GetBackendCommandInput, options?: __HttpHandlerOptions): Promise; + getBackend(args: GetBackendCommandInput, cb: (err: any, data?: GetBackendCommandOutput) => void): void; + getBackend( args: GetBackendCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBackendCommandOutput) => void ): void; - public getBackend( - args: GetBackendCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBackendCommandOutput) => void), - cb?: (err: any, data?: GetBackendCommandOutput) => void - ): Promise | void { - const command = new GetBackendCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the details for a backend API.

+ * @see {@link GetBackendAPICommand} */ - public getBackendAPI( - args: GetBackendAPICommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getBackendAPI( - args: GetBackendAPICommandInput, - cb: (err: any, data?: GetBackendAPICommandOutput) => void - ): void; - public getBackendAPI( + getBackendAPI(args: GetBackendAPICommandInput, options?: __HttpHandlerOptions): Promise; + getBackendAPI(args: GetBackendAPICommandInput, cb: (err: any, data?: GetBackendAPICommandOutput) => void): void; + getBackendAPI( args: GetBackendAPICommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBackendAPICommandOutput) => void ): void; - public getBackendAPI( - args: GetBackendAPICommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBackendAPICommandOutput) => void), - cb?: (err: any, data?: GetBackendAPICommandOutput) => void - ): Promise | void { - const command = new GetBackendAPICommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a model introspection schema for an existing backend API resource.

+ * @see {@link GetBackendAPIModelsCommand} */ - public getBackendAPIModels( + getBackendAPIModels( args: GetBackendAPIModelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBackendAPIModels( + getBackendAPIModels( args: GetBackendAPIModelsCommandInput, cb: (err: any, data?: GetBackendAPIModelsCommandOutput) => void ): void; - public getBackendAPIModels( + getBackendAPIModels( args: GetBackendAPIModelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBackendAPIModelsCommandOutput) => void ): void; - public getBackendAPIModels( - args: GetBackendAPIModelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBackendAPIModelsCommandOutput) => void), - cb?: (err: any, data?: GetBackendAPIModelsCommandOutput) => void - ): Promise | void { - const command = new GetBackendAPIModelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a backend auth details.

+ * @see {@link GetBackendAuthCommand} */ - public getBackendAuth( + getBackendAuth( args: GetBackendAuthCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBackendAuth( - args: GetBackendAuthCommandInput, - cb: (err: any, data?: GetBackendAuthCommandOutput) => void - ): void; - public getBackendAuth( + getBackendAuth(args: GetBackendAuthCommandInput, cb: (err: any, data?: GetBackendAuthCommandOutput) => void): void; + getBackendAuth( args: GetBackendAuthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBackendAuthCommandOutput) => void ): void; - public getBackendAuth( - args: GetBackendAuthCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBackendAuthCommandOutput) => void), - cb?: (err: any, data?: GetBackendAuthCommandOutput) => void - ): Promise | void { - const command = new GetBackendAuthCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a specific job.

+ * @see {@link GetBackendJobCommand} */ - public getBackendJob( - args: GetBackendJobCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getBackendJob( - args: GetBackendJobCommandInput, - cb: (err: any, data?: GetBackendJobCommandOutput) => void - ): void; - public getBackendJob( + getBackendJob(args: GetBackendJobCommandInput, options?: __HttpHandlerOptions): Promise; + getBackendJob(args: GetBackendJobCommandInput, cb: (err: any, data?: GetBackendJobCommandOutput) => void): void; + getBackendJob( args: GetBackendJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBackendJobCommandOutput) => void ): void; - public getBackendJob( - args: GetBackendJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBackendJobCommandOutput) => void), - cb?: (err: any, data?: GetBackendJobCommandOutput) => void - ): Promise | void { - const command = new GetBackendJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets details for a backend storage resource.

+ * @see {@link GetBackendStorageCommand} */ - public getBackendStorage( + getBackendStorage( args: GetBackendStorageCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBackendStorage( + getBackendStorage( args: GetBackendStorageCommandInput, cb: (err: any, data?: GetBackendStorageCommandOutput) => void ): void; - public getBackendStorage( + getBackendStorage( args: GetBackendStorageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBackendStorageCommandOutput) => void ): void; - public getBackendStorage( - args: GetBackendStorageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBackendStorageCommandOutput) => void), - cb?: (err: any, data?: GetBackendStorageCommandOutput) => void - ): Promise | void { - const command = new GetBackendStorageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the challenge token based on the given appId and sessionId.

+ * @see {@link GetTokenCommand} */ - public getToken(args: GetTokenCommandInput, options?: __HttpHandlerOptions): Promise; - public getToken(args: GetTokenCommandInput, cb: (err: any, data?: GetTokenCommandOutput) => void): void; - public getToken( + getToken(args: GetTokenCommandInput, options?: __HttpHandlerOptions): Promise; + getToken(args: GetTokenCommandInput, cb: (err: any, data?: GetTokenCommandOutput) => void): void; + getToken( args: GetTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTokenCommandOutput) => void ): void; - public getToken( - args: GetTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTokenCommandOutput) => void), - cb?: (err: any, data?: GetTokenCommandOutput) => void - ): Promise | void { - const command = new GetTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Imports an existing backend authentication resource.

+ * @see {@link ImportBackendAuthCommand} */ - public importBackendAuth( + importBackendAuth( args: ImportBackendAuthCommandInput, options?: __HttpHandlerOptions ): Promise; - public importBackendAuth( + importBackendAuth( args: ImportBackendAuthCommandInput, cb: (err: any, data?: ImportBackendAuthCommandOutput) => void ): void; - public importBackendAuth( + importBackendAuth( args: ImportBackendAuthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportBackendAuthCommandOutput) => void ): void; - public importBackendAuth( - args: ImportBackendAuthCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportBackendAuthCommandOutput) => void), - cb?: (err: any, data?: ImportBackendAuthCommandOutput) => void - ): Promise | void { - const command = new ImportBackendAuthCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Imports an existing backend storage resource.

+ * @see {@link ImportBackendStorageCommand} */ - public importBackendStorage( + importBackendStorage( args: ImportBackendStorageCommandInput, options?: __HttpHandlerOptions ): Promise; - public importBackendStorage( + importBackendStorage( args: ImportBackendStorageCommandInput, cb: (err: any, data?: ImportBackendStorageCommandOutput) => void ): void; - public importBackendStorage( + importBackendStorage( args: ImportBackendStorageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportBackendStorageCommandOutput) => void ): void; - public importBackendStorage( - args: ImportBackendStorageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportBackendStorageCommandOutput) => void), - cb?: (err: any, data?: ImportBackendStorageCommandOutput) => void - ): Promise | void { - const command = new ImportBackendStorageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the jobs for the backend of an Amplify app.

+ * @see {@link ListBackendJobsCommand} */ - public listBackendJobs( + listBackendJobs( args: ListBackendJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBackendJobs( - args: ListBackendJobsCommandInput, - cb: (err: any, data?: ListBackendJobsCommandOutput) => void - ): void; - public listBackendJobs( + listBackendJobs(args: ListBackendJobsCommandInput, cb: (err: any, data?: ListBackendJobsCommandOutput) => void): void; + listBackendJobs( args: ListBackendJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBackendJobsCommandOutput) => void ): void; - public listBackendJobs( - args: ListBackendJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBackendJobsCommandOutput) => void), - cb?: (err: any, data?: ListBackendJobsCommandOutput) => void - ): Promise | void { - const command = new ListBackendJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The list of S3 buckets in your account.

+ * @see {@link ListS3BucketsCommand} */ - public listS3Buckets( - args: ListS3BucketsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listS3Buckets( - args: ListS3BucketsCommandInput, - cb: (err: any, data?: ListS3BucketsCommandOutput) => void - ): void; - public listS3Buckets( + listS3Buckets(args: ListS3BucketsCommandInput, options?: __HttpHandlerOptions): Promise; + listS3Buckets(args: ListS3BucketsCommandInput, cb: (err: any, data?: ListS3BucketsCommandOutput) => void): void; + listS3Buckets( args: ListS3BucketsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListS3BucketsCommandOutput) => void ): void; - public listS3Buckets( - args: ListS3BucketsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListS3BucketsCommandOutput) => void), - cb?: (err: any, data?: ListS3BucketsCommandOutput) => void - ): Promise | void { - const command = new ListS3BucketsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes all backend environments from your Amplify project.

+ * @see {@link RemoveAllBackendsCommand} */ - public removeAllBackends( + removeAllBackends( args: RemoveAllBackendsCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeAllBackends( + removeAllBackends( args: RemoveAllBackendsCommandInput, cb: (err: any, data?: RemoveAllBackendsCommandOutput) => void ): void; - public removeAllBackends( + removeAllBackends( args: RemoveAllBackendsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveAllBackendsCommandOutput) => void ): void; - public removeAllBackends( - args: RemoveAllBackendsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveAllBackendsCommandOutput) => void), - cb?: (err: any, data?: RemoveAllBackendsCommandOutput) => void - ): Promise | void { - const command = new RemoveAllBackendsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the AWS resources required to access the Amplify Admin UI.

+ * @see {@link RemoveBackendConfigCommand} */ - public removeBackendConfig( + removeBackendConfig( args: RemoveBackendConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeBackendConfig( + removeBackendConfig( args: RemoveBackendConfigCommandInput, cb: (err: any, data?: RemoveBackendConfigCommandOutput) => void ): void; - public removeBackendConfig( + removeBackendConfig( args: RemoveBackendConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveBackendConfigCommandOutput) => void ): void; - public removeBackendConfig( - args: RemoveBackendConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveBackendConfigCommandOutput) => void), - cb?: (err: any, data?: RemoveBackendConfigCommandOutput) => void - ): Promise | void { - const command = new RemoveBackendConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing backend API resource.

+ * @see {@link UpdateBackendAPICommand} */ - public updateBackendAPI( + updateBackendAPI( args: UpdateBackendAPICommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBackendAPI( + updateBackendAPI( args: UpdateBackendAPICommandInput, cb: (err: any, data?: UpdateBackendAPICommandOutput) => void ): void; - public updateBackendAPI( + updateBackendAPI( args: UpdateBackendAPICommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBackendAPICommandOutput) => void ): void; - public updateBackendAPI( - args: UpdateBackendAPICommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBackendAPICommandOutput) => void), - cb?: (err: any, data?: UpdateBackendAPICommandOutput) => void - ): Promise | void { - const command = new UpdateBackendAPICommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing backend authentication resource.

+ * @see {@link UpdateBackendAuthCommand} */ - public updateBackendAuth( + updateBackendAuth( args: UpdateBackendAuthCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBackendAuth( + updateBackendAuth( args: UpdateBackendAuthCommandInput, cb: (err: any, data?: UpdateBackendAuthCommandOutput) => void ): void; - public updateBackendAuth( + updateBackendAuth( args: UpdateBackendAuthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBackendAuthCommandOutput) => void ): void; - public updateBackendAuth( - args: UpdateBackendAuthCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBackendAuthCommandOutput) => void), - cb?: (err: any, data?: UpdateBackendAuthCommandOutput) => void - ): Promise | void { - const command = new UpdateBackendAuthCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the AWS resources required to access the Amplify Admin UI.

+ * @see {@link UpdateBackendConfigCommand} */ - public updateBackendConfig( + updateBackendConfig( args: UpdateBackendConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBackendConfig( + updateBackendConfig( args: UpdateBackendConfigCommandInput, cb: (err: any, data?: UpdateBackendConfigCommandOutput) => void ): void; - public updateBackendConfig( + updateBackendConfig( args: UpdateBackendConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBackendConfigCommandOutput) => void ): void; - public updateBackendConfig( - args: UpdateBackendConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBackendConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateBackendConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateBackendConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a specific job.

+ * @see {@link UpdateBackendJobCommand} */ - public updateBackendJob( + updateBackendJob( args: UpdateBackendJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBackendJob( + updateBackendJob( args: UpdateBackendJobCommandInput, cb: (err: any, data?: UpdateBackendJobCommandOutput) => void ): void; - public updateBackendJob( + updateBackendJob( args: UpdateBackendJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBackendJobCommandOutput) => void ): void; - public updateBackendJob( - args: UpdateBackendJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBackendJobCommandOutput) => void), - cb?: (err: any, data?: UpdateBackendJobCommandOutput) => void - ): Promise | void { - const command = new UpdateBackendJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing backend storage resource.

+ * @see {@link UpdateBackendStorageCommand} */ - public updateBackendStorage( + updateBackendStorage( args: UpdateBackendStorageCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBackendStorage( + updateBackendStorage( args: UpdateBackendStorageCommandInput, cb: (err: any, data?: UpdateBackendStorageCommandOutput) => void ): void; - public updateBackendStorage( + updateBackendStorage( args: UpdateBackendStorageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBackendStorageCommandOutput) => void ): void; - public updateBackendStorage( - args: UpdateBackendStorageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBackendStorageCommandOutput) => void), - cb?: (err: any, data?: UpdateBackendStorageCommandOutput) => void - ): Promise | void { - const command = new UpdateBackendStorageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

AWS Amplify Admin API

+ */ +export class AmplifyBackend extends AmplifyBackendClient implements AmplifyBackend {} +createAggregatedClient(commands, AmplifyBackend); diff --git a/clients/client-amplifyuibuilder/src/AmplifyUIBuilder.ts b/clients/client-amplifyuibuilder/src/AmplifyUIBuilder.ts index f06c50f06b7e..c2e95f44b15b 100644 --- a/clients/client-amplifyuibuilder/src/AmplifyUIBuilder.ts +++ b/clients/client-amplifyuibuilder/src/AmplifyUIBuilder.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { AmplifyUIBuilderClient } from "./AmplifyUIBuilderClient"; +import { AmplifyUIBuilderClient, AmplifyUIBuilderClientConfig } from "./AmplifyUIBuilderClient"; import { CreateComponentCommand, CreateComponentCommandInput, @@ -65,663 +66,313 @@ import { import { UpdateFormCommand, UpdateFormCommandInput, UpdateFormCommandOutput } from "./commands/UpdateFormCommand"; import { UpdateThemeCommand, UpdateThemeCommandInput, UpdateThemeCommandOutput } from "./commands/UpdateThemeCommand"; -/** - * @public - *

The Amplify UI Builder API provides a programmatic interface for creating - * and configuring user interface (UI) component libraries and themes for use in your Amplify applications. You can then connect these UI components to an application's - * backend Amazon Web Services resources.

- *

You can also use the Amplify Studio visual designer to create UI components - * and model data for an app. For more information, see Introduction in the - * Amplify Docs.

- *

The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and - * documentation for client app development. For more information, see the Amplify Framework. For more information about - * deploying an Amplify application to Amazon Web Services, see the Amplify User Guide.

- */ -export class AmplifyUIBuilder extends AmplifyUIBuilderClient { +const commands = { + CreateComponentCommand, + CreateFormCommand, + CreateThemeCommand, + DeleteComponentCommand, + DeleteFormCommand, + DeleteThemeCommand, + ExchangeCodeForTokenCommand, + ExportComponentsCommand, + ExportFormsCommand, + ExportThemesCommand, + GetComponentCommand, + GetFormCommand, + GetMetadataCommand, + GetThemeCommand, + ListComponentsCommand, + ListFormsCommand, + ListThemesCommand, + PutMetadataFlagCommand, + RefreshTokenCommand, + UpdateComponentCommand, + UpdateFormCommand, + UpdateThemeCommand, +}; + +export interface AmplifyUIBuilder { /** - * @public - *

Creates a new component for an Amplify app.

+ * @see {@link CreateComponentCommand} */ - public createComponent( + createComponent( args: CreateComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createComponent( - args: CreateComponentCommandInput, - cb: (err: any, data?: CreateComponentCommandOutput) => void - ): void; - public createComponent( + createComponent(args: CreateComponentCommandInput, cb: (err: any, data?: CreateComponentCommandOutput) => void): void; + createComponent( args: CreateComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateComponentCommandOutput) => void ): void; - public createComponent( - args: CreateComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateComponentCommandOutput) => void), - cb?: (err: any, data?: CreateComponentCommandOutput) => void - ): Promise | void { - const command = new CreateComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new form for an Amplify app.

+ * @see {@link CreateFormCommand} */ - public createForm(args: CreateFormCommandInput, options?: __HttpHandlerOptions): Promise; - public createForm(args: CreateFormCommandInput, cb: (err: any, data?: CreateFormCommandOutput) => void): void; - public createForm( + createForm(args: CreateFormCommandInput, options?: __HttpHandlerOptions): Promise; + createForm(args: CreateFormCommandInput, cb: (err: any, data?: CreateFormCommandOutput) => void): void; + createForm( args: CreateFormCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFormCommandOutput) => void ): void; - public createForm( - args: CreateFormCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFormCommandOutput) => void), - cb?: (err: any, data?: CreateFormCommandOutput) => void - ): Promise | void { - const command = new CreateFormCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a theme to apply to the components in an Amplify app.

+ * @see {@link CreateThemeCommand} */ - public createTheme(args: CreateThemeCommandInput, options?: __HttpHandlerOptions): Promise; - public createTheme(args: CreateThemeCommandInput, cb: (err: any, data?: CreateThemeCommandOutput) => void): void; - public createTheme( + createTheme(args: CreateThemeCommandInput, options?: __HttpHandlerOptions): Promise; + createTheme(args: CreateThemeCommandInput, cb: (err: any, data?: CreateThemeCommandOutput) => void): void; + createTheme( args: CreateThemeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateThemeCommandOutput) => void ): void; - public createTheme( - args: CreateThemeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateThemeCommandOutput) => void), - cb?: (err: any, data?: CreateThemeCommandOutput) => void - ): Promise | void { - const command = new CreateThemeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a component from an Amplify app.

+ * @see {@link DeleteComponentCommand} */ - public deleteComponent( + deleteComponent( args: DeleteComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteComponent( - args: DeleteComponentCommandInput, - cb: (err: any, data?: DeleteComponentCommandOutput) => void - ): void; - public deleteComponent( + deleteComponent(args: DeleteComponentCommandInput, cb: (err: any, data?: DeleteComponentCommandOutput) => void): void; + deleteComponent( args: DeleteComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteComponentCommandOutput) => void ): void; - public deleteComponent( - args: DeleteComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteComponentCommandOutput) => void), - cb?: (err: any, data?: DeleteComponentCommandOutput) => void - ): Promise | void { - const command = new DeleteComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a form from an Amplify app.

+ * @see {@link DeleteFormCommand} */ - public deleteForm(args: DeleteFormCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteForm(args: DeleteFormCommandInput, cb: (err: any, data?: DeleteFormCommandOutput) => void): void; - public deleteForm( + deleteForm(args: DeleteFormCommandInput, options?: __HttpHandlerOptions): Promise; + deleteForm(args: DeleteFormCommandInput, cb: (err: any, data?: DeleteFormCommandOutput) => void): void; + deleteForm( args: DeleteFormCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFormCommandOutput) => void ): void; - public deleteForm( - args: DeleteFormCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFormCommandOutput) => void), - cb?: (err: any, data?: DeleteFormCommandOutput) => void - ): Promise | void { - const command = new DeleteFormCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a theme from an Amplify app.

+ * @see {@link DeleteThemeCommand} */ - public deleteTheme(args: DeleteThemeCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteTheme(args: DeleteThemeCommandInput, cb: (err: any, data?: DeleteThemeCommandOutput) => void): void; - public deleteTheme( + deleteTheme(args: DeleteThemeCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTheme(args: DeleteThemeCommandInput, cb: (err: any, data?: DeleteThemeCommandOutput) => void): void; + deleteTheme( args: DeleteThemeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteThemeCommandOutput) => void ): void; - public deleteTheme( - args: DeleteThemeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteThemeCommandOutput) => void), - cb?: (err: any, data?: DeleteThemeCommandOutput) => void - ): Promise | void { - const command = new DeleteThemeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Exchanges an access code for a token.

+ * @see {@link ExchangeCodeForTokenCommand} */ - public exchangeCodeForToken( + exchangeCodeForToken( args: ExchangeCodeForTokenCommandInput, options?: __HttpHandlerOptions ): Promise; - public exchangeCodeForToken( + exchangeCodeForToken( args: ExchangeCodeForTokenCommandInput, cb: (err: any, data?: ExchangeCodeForTokenCommandOutput) => void ): void; - public exchangeCodeForToken( + exchangeCodeForToken( args: ExchangeCodeForTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExchangeCodeForTokenCommandOutput) => void ): void; - public exchangeCodeForToken( - args: ExchangeCodeForTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExchangeCodeForTokenCommandOutput) => void), - cb?: (err: any, data?: ExchangeCodeForTokenCommandOutput) => void - ): Promise | void { - const command = new ExchangeCodeForTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Exports component configurations to code that is ready to integrate into an Amplify app.

+ * @see {@link ExportComponentsCommand} */ - public exportComponents( + exportComponents( args: ExportComponentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public exportComponents( + exportComponents( args: ExportComponentsCommandInput, cb: (err: any, data?: ExportComponentsCommandOutput) => void ): void; - public exportComponents( + exportComponents( args: ExportComponentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportComponentsCommandOutput) => void ): void; - public exportComponents( - args: ExportComponentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportComponentsCommandOutput) => void), - cb?: (err: any, data?: ExportComponentsCommandOutput) => void - ): Promise | void { - const command = new ExportComponentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Exports form configurations to code that is ready to integrate into an Amplify app.

+ * @see {@link ExportFormsCommand} */ - public exportForms(args: ExportFormsCommandInput, options?: __HttpHandlerOptions): Promise; - public exportForms(args: ExportFormsCommandInput, cb: (err: any, data?: ExportFormsCommandOutput) => void): void; - public exportForms( + exportForms(args: ExportFormsCommandInput, options?: __HttpHandlerOptions): Promise; + exportForms(args: ExportFormsCommandInput, cb: (err: any, data?: ExportFormsCommandOutput) => void): void; + exportForms( args: ExportFormsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportFormsCommandOutput) => void ): void; - public exportForms( - args: ExportFormsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportFormsCommandOutput) => void), - cb?: (err: any, data?: ExportFormsCommandOutput) => void - ): Promise | void { - const command = new ExportFormsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Exports theme configurations to code that is ready to integrate into an Amplify app.

+ * @see {@link ExportThemesCommand} */ - public exportThemes( - args: ExportThemesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public exportThemes(args: ExportThemesCommandInput, cb: (err: any, data?: ExportThemesCommandOutput) => void): void; - public exportThemes( + exportThemes(args: ExportThemesCommandInput, options?: __HttpHandlerOptions): Promise; + exportThemes(args: ExportThemesCommandInput, cb: (err: any, data?: ExportThemesCommandOutput) => void): void; + exportThemes( args: ExportThemesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportThemesCommandOutput) => void ): void; - public exportThemes( - args: ExportThemesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportThemesCommandOutput) => void), - cb?: (err: any, data?: ExportThemesCommandOutput) => void - ): Promise | void { - const command = new ExportThemesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an existing component for an Amplify app.

+ * @see {@link GetComponentCommand} */ - public getComponent( - args: GetComponentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getComponent(args: GetComponentCommandInput, cb: (err: any, data?: GetComponentCommandOutput) => void): void; - public getComponent( + getComponent(args: GetComponentCommandInput, options?: __HttpHandlerOptions): Promise; + getComponent(args: GetComponentCommandInput, cb: (err: any, data?: GetComponentCommandOutput) => void): void; + getComponent( args: GetComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComponentCommandOutput) => void ): void; - public getComponent( - args: GetComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetComponentCommandOutput) => void), - cb?: (err: any, data?: GetComponentCommandOutput) => void - ): Promise | void { - const command = new GetComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an existing form for an Amplify app.

+ * @see {@link GetFormCommand} */ - public getForm(args: GetFormCommandInput, options?: __HttpHandlerOptions): Promise; - public getForm(args: GetFormCommandInput, cb: (err: any, data?: GetFormCommandOutput) => void): void; - public getForm( + getForm(args: GetFormCommandInput, options?: __HttpHandlerOptions): Promise; + getForm(args: GetFormCommandInput, cb: (err: any, data?: GetFormCommandOutput) => void): void; + getForm( args: GetFormCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFormCommandOutput) => void ): void; - public getForm( - args: GetFormCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFormCommandOutput) => void), - cb?: (err: any, data?: GetFormCommandOutput) => void - ): Promise | void { - const command = new GetFormCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns existing metadata for an Amplify app.

+ * @see {@link GetMetadataCommand} */ - public getMetadata(args: GetMetadataCommandInput, options?: __HttpHandlerOptions): Promise; - public getMetadata(args: GetMetadataCommandInput, cb: (err: any, data?: GetMetadataCommandOutput) => void): void; - public getMetadata( + getMetadata(args: GetMetadataCommandInput, options?: __HttpHandlerOptions): Promise; + getMetadata(args: GetMetadataCommandInput, cb: (err: any, data?: GetMetadataCommandOutput) => void): void; + getMetadata( args: GetMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMetadataCommandOutput) => void ): void; - public getMetadata( - args: GetMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMetadataCommandOutput) => void), - cb?: (err: any, data?: GetMetadataCommandOutput) => void - ): Promise | void { - const command = new GetMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an existing theme for an Amplify app.

+ * @see {@link GetThemeCommand} */ - public getTheme(args: GetThemeCommandInput, options?: __HttpHandlerOptions): Promise; - public getTheme(args: GetThemeCommandInput, cb: (err: any, data?: GetThemeCommandOutput) => void): void; - public getTheme( + getTheme(args: GetThemeCommandInput, options?: __HttpHandlerOptions): Promise; + getTheme(args: GetThemeCommandInput, cb: (err: any, data?: GetThemeCommandOutput) => void): void; + getTheme( args: GetThemeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetThemeCommandOutput) => void ): void; - public getTheme( - args: GetThemeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetThemeCommandOutput) => void), - cb?: (err: any, data?: GetThemeCommandOutput) => void - ): Promise | void { - const command = new GetThemeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of components for a specified Amplify app and backend - * environment.

+ * @see {@link ListComponentsCommand} */ - public listComponents( + listComponents( args: ListComponentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listComponents( - args: ListComponentsCommandInput, - cb: (err: any, data?: ListComponentsCommandOutput) => void - ): void; - public listComponents( + listComponents(args: ListComponentsCommandInput, cb: (err: any, data?: ListComponentsCommandOutput) => void): void; + listComponents( args: ListComponentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComponentsCommandOutput) => void ): void; - public listComponents( - args: ListComponentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListComponentsCommandOutput) => void), - cb?: (err: any, data?: ListComponentsCommandOutput) => void - ): Promise | void { - const command = new ListComponentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of forms for a specified Amplify app and backend environment.

+ * @see {@link ListFormsCommand} */ - public listForms(args: ListFormsCommandInput, options?: __HttpHandlerOptions): Promise; - public listForms(args: ListFormsCommandInput, cb: (err: any, data?: ListFormsCommandOutput) => void): void; - public listForms( + listForms(args: ListFormsCommandInput, options?: __HttpHandlerOptions): Promise; + listForms(args: ListFormsCommandInput, cb: (err: any, data?: ListFormsCommandOutput) => void): void; + listForms( args: ListFormsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFormsCommandOutput) => void ): void; - public listForms( - args: ListFormsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFormsCommandOutput) => void), - cb?: (err: any, data?: ListFormsCommandOutput) => void - ): Promise | void { - const command = new ListFormsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of themes for a specified Amplify app and backend - * environment.

+ * @see {@link ListThemesCommand} */ - public listThemes(args: ListThemesCommandInput, options?: __HttpHandlerOptions): Promise; - public listThemes(args: ListThemesCommandInput, cb: (err: any, data?: ListThemesCommandOutput) => void): void; - public listThemes( + listThemes(args: ListThemesCommandInput, options?: __HttpHandlerOptions): Promise; + listThemes(args: ListThemesCommandInput, cb: (err: any, data?: ListThemesCommandOutput) => void): void; + listThemes( args: ListThemesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListThemesCommandOutput) => void ): void; - public listThemes( - args: ListThemesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListThemesCommandOutput) => void), - cb?: (err: any, data?: ListThemesCommandOutput) => void - ): Promise | void { - const command = new ListThemesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stores the metadata information about a feature on a form.

+ * @see {@link PutMetadataFlagCommand} */ - public putMetadataFlag( + putMetadataFlag( args: PutMetadataFlagCommandInput, options?: __HttpHandlerOptions ): Promise; - public putMetadataFlag( - args: PutMetadataFlagCommandInput, - cb: (err: any, data?: PutMetadataFlagCommandOutput) => void - ): void; - public putMetadataFlag( + putMetadataFlag(args: PutMetadataFlagCommandInput, cb: (err: any, data?: PutMetadataFlagCommandOutput) => void): void; + putMetadataFlag( args: PutMetadataFlagCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMetadataFlagCommandOutput) => void ): void; - public putMetadataFlag( - args: PutMetadataFlagCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutMetadataFlagCommandOutput) => void), - cb?: (err: any, data?: PutMetadataFlagCommandOutput) => void - ): Promise | void { - const command = new PutMetadataFlagCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Refreshes a previously issued access token that might have expired.

+ * @see {@link RefreshTokenCommand} */ - public refreshToken( - args: RefreshTokenCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public refreshToken(args: RefreshTokenCommandInput, cb: (err: any, data?: RefreshTokenCommandOutput) => void): void; - public refreshToken( + refreshToken(args: RefreshTokenCommandInput, options?: __HttpHandlerOptions): Promise; + refreshToken(args: RefreshTokenCommandInput, cb: (err: any, data?: RefreshTokenCommandOutput) => void): void; + refreshToken( args: RefreshTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RefreshTokenCommandOutput) => void ): void; - public refreshToken( - args: RefreshTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RefreshTokenCommandOutput) => void), - cb?: (err: any, data?: RefreshTokenCommandOutput) => void - ): Promise | void { - const command = new RefreshTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing component.

+ * @see {@link UpdateComponentCommand} */ - public updateComponent( + updateComponent( args: UpdateComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateComponent( - args: UpdateComponentCommandInput, - cb: (err: any, data?: UpdateComponentCommandOutput) => void - ): void; - public updateComponent( + updateComponent(args: UpdateComponentCommandInput, cb: (err: any, data?: UpdateComponentCommandOutput) => void): void; + updateComponent( args: UpdateComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateComponentCommandOutput) => void ): void; - public updateComponent( - args: UpdateComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateComponentCommandOutput) => void), - cb?: (err: any, data?: UpdateComponentCommandOutput) => void - ): Promise | void { - const command = new UpdateComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing form.

+ * @see {@link UpdateFormCommand} */ - public updateForm(args: UpdateFormCommandInput, options?: __HttpHandlerOptions): Promise; - public updateForm(args: UpdateFormCommandInput, cb: (err: any, data?: UpdateFormCommandOutput) => void): void; - public updateForm( + updateForm(args: UpdateFormCommandInput, options?: __HttpHandlerOptions): Promise; + updateForm(args: UpdateFormCommandInput, cb: (err: any, data?: UpdateFormCommandOutput) => void): void; + updateForm( args: UpdateFormCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFormCommandOutput) => void ): void; - public updateForm( - args: UpdateFormCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFormCommandOutput) => void), - cb?: (err: any, data?: UpdateFormCommandOutput) => void - ): Promise | void { - const command = new UpdateFormCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing theme.

+ * @see {@link UpdateThemeCommand} */ - public updateTheme(args: UpdateThemeCommandInput, options?: __HttpHandlerOptions): Promise; - public updateTheme(args: UpdateThemeCommandInput, cb: (err: any, data?: UpdateThemeCommandOutput) => void): void; - public updateTheme( + updateTheme(args: UpdateThemeCommandInput, options?: __HttpHandlerOptions): Promise; + updateTheme(args: UpdateThemeCommandInput, cb: (err: any, data?: UpdateThemeCommandOutput) => void): void; + updateTheme( args: UpdateThemeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateThemeCommandOutput) => void ): void; - public updateTheme( - args: UpdateThemeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateThemeCommandOutput) => void), - cb?: (err: any, data?: UpdateThemeCommandOutput) => void - ): Promise | void { - const command = new UpdateThemeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The Amplify UI Builder API provides a programmatic interface for creating + * and configuring user interface (UI) component libraries and themes for use in your Amplify applications. You can then connect these UI components to an application's + * backend Amazon Web Services resources.

+ *

You can also use the Amplify Studio visual designer to create UI components + * and model data for an app. For more information, see Introduction in the + * Amplify Docs.

+ *

The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and + * documentation for client app development. For more information, see the Amplify Framework. For more information about + * deploying an Amplify application to Amazon Web Services, see the Amplify User Guide.

+ */ +export class AmplifyUIBuilder extends AmplifyUIBuilderClient implements AmplifyUIBuilder {} +createAggregatedClient(commands, AmplifyUIBuilder); diff --git a/clients/client-api-gateway/src/APIGateway.ts b/clients/client-api-gateway/src/APIGateway.ts index 0a07f9dc5089..d2b24eca257b 100644 --- a/clients/client-api-gateway/src/APIGateway.ts +++ b/clients/client-api-gateway/src/APIGateway.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { APIGatewayClient } from "./APIGatewayClient"; +import { APIGatewayClient, APIGatewayClientConfig } from "./APIGatewayClient"; import { CreateApiKeyCommand, CreateApiKeyCommandInput, @@ -487,3775 +488,1836 @@ import { UpdateVpcLinkCommandOutput, } from "./commands/UpdateVpcLinkCommand"; -/** - * @public - * Amazon API Gateway - *

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

- */ -export class APIGateway extends APIGatewayClient { +const commands = { + CreateApiKeyCommand, + CreateAuthorizerCommand, + CreateBasePathMappingCommand, + CreateDeploymentCommand, + CreateDocumentationPartCommand, + CreateDocumentationVersionCommand, + CreateDomainNameCommand, + CreateModelCommand, + CreateRequestValidatorCommand, + CreateResourceCommand, + CreateRestApiCommand, + CreateStageCommand, + CreateUsagePlanCommand, + CreateUsagePlanKeyCommand, + CreateVpcLinkCommand, + DeleteApiKeyCommand, + DeleteAuthorizerCommand, + DeleteBasePathMappingCommand, + DeleteClientCertificateCommand, + DeleteDeploymentCommand, + DeleteDocumentationPartCommand, + DeleteDocumentationVersionCommand, + DeleteDomainNameCommand, + DeleteGatewayResponseCommand, + DeleteIntegrationCommand, + DeleteIntegrationResponseCommand, + DeleteMethodCommand, + DeleteMethodResponseCommand, + DeleteModelCommand, + DeleteRequestValidatorCommand, + DeleteResourceCommand, + DeleteRestApiCommand, + DeleteStageCommand, + DeleteUsagePlanCommand, + DeleteUsagePlanKeyCommand, + DeleteVpcLinkCommand, + FlushStageAuthorizersCacheCommand, + FlushStageCacheCommand, + GenerateClientCertificateCommand, + GetAccountCommand, + GetApiKeyCommand, + GetApiKeysCommand, + GetAuthorizerCommand, + GetAuthorizersCommand, + GetBasePathMappingCommand, + GetBasePathMappingsCommand, + GetClientCertificateCommand, + GetClientCertificatesCommand, + GetDeploymentCommand, + GetDeploymentsCommand, + GetDocumentationPartCommand, + GetDocumentationPartsCommand, + GetDocumentationVersionCommand, + GetDocumentationVersionsCommand, + GetDomainNameCommand, + GetDomainNamesCommand, + GetExportCommand, + GetGatewayResponseCommand, + GetGatewayResponsesCommand, + GetIntegrationCommand, + GetIntegrationResponseCommand, + GetMethodCommand, + GetMethodResponseCommand, + GetModelCommand, + GetModelsCommand, + GetModelTemplateCommand, + GetRequestValidatorCommand, + GetRequestValidatorsCommand, + GetResourceCommand, + GetResourcesCommand, + GetRestApiCommand, + GetRestApisCommand, + GetSdkCommand, + GetSdkTypeCommand, + GetSdkTypesCommand, + GetStageCommand, + GetStagesCommand, + GetTagsCommand, + GetUsageCommand, + GetUsagePlanCommand, + GetUsagePlanKeyCommand, + GetUsagePlanKeysCommand, + GetUsagePlansCommand, + GetVpcLinkCommand, + GetVpcLinksCommand, + ImportApiKeysCommand, + ImportDocumentationPartsCommand, + ImportRestApiCommand, + PutGatewayResponseCommand, + PutIntegrationCommand, + PutIntegrationResponseCommand, + PutMethodCommand, + PutMethodResponseCommand, + PutRestApiCommand, + TagResourceCommand, + TestInvokeAuthorizerCommand, + TestInvokeMethodCommand, + UntagResourceCommand, + UpdateAccountCommand, + UpdateApiKeyCommand, + UpdateAuthorizerCommand, + UpdateBasePathMappingCommand, + UpdateClientCertificateCommand, + UpdateDeploymentCommand, + UpdateDocumentationPartCommand, + UpdateDocumentationVersionCommand, + UpdateDomainNameCommand, + UpdateGatewayResponseCommand, + UpdateIntegrationCommand, + UpdateIntegrationResponseCommand, + UpdateMethodCommand, + UpdateMethodResponseCommand, + UpdateModelCommand, + UpdateRequestValidatorCommand, + UpdateResourceCommand, + UpdateRestApiCommand, + UpdateStageCommand, + UpdateUsageCommand, + UpdateUsagePlanCommand, + UpdateVpcLinkCommand, +}; + +export interface APIGateway { /** - * @public - *

Create an ApiKey resource.

+ * @see {@link CreateApiKeyCommand} */ - public createApiKey( - args: CreateApiKeyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createApiKey(args: CreateApiKeyCommandInput, cb: (err: any, data?: CreateApiKeyCommandOutput) => void): void; - public createApiKey( + createApiKey(args: CreateApiKeyCommandInput, options?: __HttpHandlerOptions): Promise; + createApiKey(args: CreateApiKeyCommandInput, cb: (err: any, data?: CreateApiKeyCommandOutput) => void): void; + createApiKey( args: CreateApiKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApiKeyCommandOutput) => void ): void; - public createApiKey( - args: CreateApiKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApiKeyCommandOutput) => void), - cb?: (err: any, data?: CreateApiKeyCommandOutput) => void - ): Promise | void { - const command = new CreateApiKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a new Authorizer resource to an existing RestApi resource.

+ * @see {@link CreateAuthorizerCommand} */ - public createAuthorizer( + createAuthorizer( args: CreateAuthorizerCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAuthorizer( + createAuthorizer( args: CreateAuthorizerCommandInput, cb: (err: any, data?: CreateAuthorizerCommandOutput) => void ): void; - public createAuthorizer( + createAuthorizer( args: CreateAuthorizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAuthorizerCommandOutput) => void ): void; - public createAuthorizer( - args: CreateAuthorizerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAuthorizerCommandOutput) => void), - cb?: (err: any, data?: CreateAuthorizerCommandOutput) => void - ): Promise | void { - const command = new CreateAuthorizerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new BasePathMapping resource.

+ * @see {@link CreateBasePathMappingCommand} */ - public createBasePathMapping( + createBasePathMapping( args: CreateBasePathMappingCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBasePathMapping( + createBasePathMapping( args: CreateBasePathMappingCommandInput, cb: (err: any, data?: CreateBasePathMappingCommandOutput) => void ): void; - public createBasePathMapping( + createBasePathMapping( args: CreateBasePathMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBasePathMappingCommandOutput) => void ): void; - public createBasePathMapping( - args: CreateBasePathMappingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBasePathMappingCommandOutput) => void), - cb?: (err: any, data?: CreateBasePathMappingCommandOutput) => void - ): Promise | void { - const command = new CreateBasePathMappingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a Deployment resource, which makes a specified RestApi callable over the internet.

+ * @see {@link CreateDeploymentCommand} */ - public createDeployment( + createDeployment( args: CreateDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDeployment( + createDeployment( args: CreateDeploymentCommandInput, cb: (err: any, data?: CreateDeploymentCommandOutput) => void ): void; - public createDeployment( + createDeployment( args: CreateDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeploymentCommandOutput) => void ): void; - public createDeployment( - args: CreateDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDeploymentCommandOutput) => void), - cb?: (err: any, data?: CreateDeploymentCommandOutput) => void - ): Promise | void { - const command = new CreateDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a documentation part.

+ * @see {@link CreateDocumentationPartCommand} */ - public createDocumentationPart( + createDocumentationPart( args: CreateDocumentationPartCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDocumentationPart( + createDocumentationPart( args: CreateDocumentationPartCommandInput, cb: (err: any, data?: CreateDocumentationPartCommandOutput) => void ): void; - public createDocumentationPart( + createDocumentationPart( args: CreateDocumentationPartCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDocumentationPartCommandOutput) => void ): void; - public createDocumentationPart( - args: CreateDocumentationPartCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDocumentationPartCommandOutput) => void), - cb?: (err: any, data?: CreateDocumentationPartCommandOutput) => void - ): Promise | void { - const command = new CreateDocumentationPartCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a documentation version

+ * @see {@link CreateDocumentationVersionCommand} */ - public createDocumentationVersion( + createDocumentationVersion( args: CreateDocumentationVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDocumentationVersion( + createDocumentationVersion( args: CreateDocumentationVersionCommandInput, cb: (err: any, data?: CreateDocumentationVersionCommandOutput) => void ): void; - public createDocumentationVersion( + createDocumentationVersion( args: CreateDocumentationVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDocumentationVersionCommandOutput) => void ): void; - public createDocumentationVersion( - args: CreateDocumentationVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDocumentationVersionCommandOutput) => void), - cb?: (err: any, data?: CreateDocumentationVersionCommandOutput) => void - ): Promise | void { - const command = new CreateDocumentationVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new domain name.

+ * @see {@link CreateDomainNameCommand} */ - public createDomainName( + createDomainName( args: CreateDomainNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDomainName( + createDomainName( args: CreateDomainNameCommandInput, cb: (err: any, data?: CreateDomainNameCommandOutput) => void ): void; - public createDomainName( + createDomainName( args: CreateDomainNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDomainNameCommandOutput) => void ): void; - public createDomainName( - args: CreateDomainNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDomainNameCommandOutput) => void), - cb?: (err: any, data?: CreateDomainNameCommandOutput) => void - ): Promise | void { - const command = new CreateDomainNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a new Model resource to an existing RestApi resource.

+ * @see {@link CreateModelCommand} */ - public createModel(args: CreateModelCommandInput, options?: __HttpHandlerOptions): Promise; - public createModel(args: CreateModelCommandInput, cb: (err: any, data?: CreateModelCommandOutput) => void): void; - public createModel( + createModel(args: CreateModelCommandInput, options?: __HttpHandlerOptions): Promise; + createModel(args: CreateModelCommandInput, cb: (err: any, data?: CreateModelCommandOutput) => void): void; + createModel( args: CreateModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateModelCommandOutput) => void ): void; - public createModel( - args: CreateModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateModelCommandOutput) => void), - cb?: (err: any, data?: CreateModelCommandOutput) => void - ): Promise | void { - const command = new CreateModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a RequestValidator of a given RestApi.

+ * @see {@link CreateRequestValidatorCommand} */ - public createRequestValidator( + createRequestValidator( args: CreateRequestValidatorCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRequestValidator( + createRequestValidator( args: CreateRequestValidatorCommandInput, cb: (err: any, data?: CreateRequestValidatorCommandOutput) => void ): void; - public createRequestValidator( + createRequestValidator( args: CreateRequestValidatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRequestValidatorCommandOutput) => void ): void; - public createRequestValidator( - args: CreateRequestValidatorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRequestValidatorCommandOutput) => void), - cb?: (err: any, data?: CreateRequestValidatorCommandOutput) => void - ): Promise | void { - const command = new CreateRequestValidatorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a Resource resource.

+ * @see {@link CreateResourceCommand} */ - public createResource( + createResource( args: CreateResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createResource( - args: CreateResourceCommandInput, - cb: (err: any, data?: CreateResourceCommandOutput) => void - ): void; - public createResource( + createResource(args: CreateResourceCommandInput, cb: (err: any, data?: CreateResourceCommandOutput) => void): void; + createResource( args: CreateResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResourceCommandOutput) => void ): void; - public createResource( - args: CreateResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateResourceCommandOutput) => void), - cb?: (err: any, data?: CreateResourceCommandOutput) => void - ): Promise | void { - const command = new CreateResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new RestApi resource.

+ * @see {@link CreateRestApiCommand} */ - public createRestApi( - args: CreateRestApiCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createRestApi( - args: CreateRestApiCommandInput, - cb: (err: any, data?: CreateRestApiCommandOutput) => void - ): void; - public createRestApi( + createRestApi(args: CreateRestApiCommandInput, options?: __HttpHandlerOptions): Promise; + createRestApi(args: CreateRestApiCommandInput, cb: (err: any, data?: CreateRestApiCommandOutput) => void): void; + createRestApi( args: CreateRestApiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRestApiCommandOutput) => void ): void; - public createRestApi( - args: CreateRestApiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRestApiCommandOutput) => void), - cb?: (err: any, data?: CreateRestApiCommandOutput) => void - ): Promise | void { - const command = new CreateRestApiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new Stage resource that references a pre-existing Deployment for the API.

+ * @see {@link CreateStageCommand} */ - public createStage(args: CreateStageCommandInput, options?: __HttpHandlerOptions): Promise; - public createStage(args: CreateStageCommandInput, cb: (err: any, data?: CreateStageCommandOutput) => void): void; - public createStage( + createStage(args: CreateStageCommandInput, options?: __HttpHandlerOptions): Promise; + createStage(args: CreateStageCommandInput, cb: (err: any, data?: CreateStageCommandOutput) => void): void; + createStage( args: CreateStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStageCommandOutput) => void ): void; - public createStage( - args: CreateStageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStageCommandOutput) => void), - cb?: (err: any, data?: CreateStageCommandOutput) => void - ): Promise | void { - const command = new CreateStageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.

+ * @see {@link CreateUsagePlanCommand} */ - public createUsagePlan( + createUsagePlan( args: CreateUsagePlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public createUsagePlan( - args: CreateUsagePlanCommandInput, - cb: (err: any, data?: CreateUsagePlanCommandOutput) => void - ): void; - public createUsagePlan( + createUsagePlan(args: CreateUsagePlanCommandInput, cb: (err: any, data?: CreateUsagePlanCommandOutput) => void): void; + createUsagePlan( args: CreateUsagePlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUsagePlanCommandOutput) => void ): void; - public createUsagePlan( - args: CreateUsagePlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUsagePlanCommandOutput) => void), - cb?: (err: any, data?: CreateUsagePlanCommandOutput) => void - ): Promise | void { - const command = new CreateUsagePlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a usage plan key for adding an existing API key to a usage plan.

+ * @see {@link CreateUsagePlanKeyCommand} */ - public createUsagePlanKey( + createUsagePlanKey( args: CreateUsagePlanKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createUsagePlanKey( + createUsagePlanKey( args: CreateUsagePlanKeyCommandInput, cb: (err: any, data?: CreateUsagePlanKeyCommandOutput) => void ): void; - public createUsagePlanKey( + createUsagePlanKey( args: CreateUsagePlanKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUsagePlanKeyCommandOutput) => void ): void; - public createUsagePlanKey( - args: CreateUsagePlanKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUsagePlanKeyCommandOutput) => void), - cb?: (err: any, data?: CreateUsagePlanKeyCommandOutput) => void - ): Promise | void { - const command = new CreateUsagePlanKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.

+ * @see {@link CreateVpcLinkCommand} */ - public createVpcLink( - args: CreateVpcLinkCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createVpcLink( - args: CreateVpcLinkCommandInput, - cb: (err: any, data?: CreateVpcLinkCommandOutput) => void - ): void; - public createVpcLink( + createVpcLink(args: CreateVpcLinkCommandInput, options?: __HttpHandlerOptions): Promise; + createVpcLink(args: CreateVpcLinkCommandInput, cb: (err: any, data?: CreateVpcLinkCommandOutput) => void): void; + createVpcLink( args: CreateVpcLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVpcLinkCommandOutput) => void ): void; - public createVpcLink( - args: CreateVpcLinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVpcLinkCommandOutput) => void), - cb?: (err: any, data?: CreateVpcLinkCommandOutput) => void - ): Promise | void { - const command = new CreateVpcLinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the ApiKey resource.

+ * @see {@link DeleteApiKeyCommand} */ - public deleteApiKey( - args: DeleteApiKeyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteApiKey(args: DeleteApiKeyCommandInput, cb: (err: any, data?: DeleteApiKeyCommandOutput) => void): void; - public deleteApiKey( + deleteApiKey(args: DeleteApiKeyCommandInput, options?: __HttpHandlerOptions): Promise; + deleteApiKey(args: DeleteApiKeyCommandInput, cb: (err: any, data?: DeleteApiKeyCommandOutput) => void): void; + deleteApiKey( args: DeleteApiKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApiKeyCommandOutput) => void ): void; - public deleteApiKey( - args: DeleteApiKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApiKeyCommandOutput) => void), - cb?: (err: any, data?: DeleteApiKeyCommandOutput) => void - ): Promise | void { - const command = new DeleteApiKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing Authorizer resource.

+ * @see {@link DeleteAuthorizerCommand} */ - public deleteAuthorizer( + deleteAuthorizer( args: DeleteAuthorizerCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAuthorizer( + deleteAuthorizer( args: DeleteAuthorizerCommandInput, cb: (err: any, data?: DeleteAuthorizerCommandOutput) => void ): void; - public deleteAuthorizer( + deleteAuthorizer( args: DeleteAuthorizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAuthorizerCommandOutput) => void ): void; - public deleteAuthorizer( - args: DeleteAuthorizerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAuthorizerCommandOutput) => void), - cb?: (err: any, data?: DeleteAuthorizerCommandOutput) => void - ): Promise | void { - const command = new DeleteAuthorizerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the BasePathMapping resource.

+ * @see {@link DeleteBasePathMappingCommand} */ - public deleteBasePathMapping( + deleteBasePathMapping( args: DeleteBasePathMappingCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBasePathMapping( + deleteBasePathMapping( args: DeleteBasePathMappingCommandInput, cb: (err: any, data?: DeleteBasePathMappingCommandOutput) => void ): void; - public deleteBasePathMapping( + deleteBasePathMapping( args: DeleteBasePathMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBasePathMappingCommandOutput) => void ): void; - public deleteBasePathMapping( - args: DeleteBasePathMappingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBasePathMappingCommandOutput) => void), - cb?: (err: any, data?: DeleteBasePathMappingCommandOutput) => void - ): Promise | void { - const command = new DeleteBasePathMappingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the ClientCertificate resource.

+ * @see {@link DeleteClientCertificateCommand} */ - public deleteClientCertificate( + deleteClientCertificate( args: DeleteClientCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteClientCertificate( + deleteClientCertificate( args: DeleteClientCertificateCommandInput, cb: (err: any, data?: DeleteClientCertificateCommandOutput) => void ): void; - public deleteClientCertificate( + deleteClientCertificate( args: DeleteClientCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClientCertificateCommandOutput) => void ): void; - public deleteClientCertificate( - args: DeleteClientCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteClientCertificateCommandOutput) => void), - cb?: (err: any, data?: DeleteClientCertificateCommandOutput) => void - ): Promise | void { - const command = new DeleteClientCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.

+ * @see {@link DeleteDeploymentCommand} */ - public deleteDeployment( + deleteDeployment( args: DeleteDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDeployment( + deleteDeployment( args: DeleteDeploymentCommandInput, cb: (err: any, data?: DeleteDeploymentCommandOutput) => void ): void; - public deleteDeployment( + deleteDeployment( args: DeleteDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDeploymentCommandOutput) => void ): void; - public deleteDeployment( - args: DeleteDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDeploymentCommandOutput) => void), - cb?: (err: any, data?: DeleteDeploymentCommandOutput) => void - ): Promise | void { - const command = new DeleteDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a documentation part

+ * @see {@link DeleteDocumentationPartCommand} */ - public deleteDocumentationPart( + deleteDocumentationPart( args: DeleteDocumentationPartCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDocumentationPart( + deleteDocumentationPart( args: DeleteDocumentationPartCommandInput, cb: (err: any, data?: DeleteDocumentationPartCommandOutput) => void ): void; - public deleteDocumentationPart( + deleteDocumentationPart( args: DeleteDocumentationPartCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDocumentationPartCommandOutput) => void ): void; - public deleteDocumentationPart( - args: DeleteDocumentationPartCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDocumentationPartCommandOutput) => void), - cb?: (err: any, data?: DeleteDocumentationPartCommandOutput) => void - ): Promise | void { - const command = new DeleteDocumentationPartCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a documentation version.

+ * @see {@link DeleteDocumentationVersionCommand} */ - public deleteDocumentationVersion( + deleteDocumentationVersion( args: DeleteDocumentationVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDocumentationVersion( + deleteDocumentationVersion( args: DeleteDocumentationVersionCommandInput, cb: (err: any, data?: DeleteDocumentationVersionCommandOutput) => void ): void; - public deleteDocumentationVersion( + deleteDocumentationVersion( args: DeleteDocumentationVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDocumentationVersionCommandOutput) => void ): void; - public deleteDocumentationVersion( - args: DeleteDocumentationVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDocumentationVersionCommandOutput) => void), - cb?: (err: any, data?: DeleteDocumentationVersionCommandOutput) => void - ): Promise | void { - const command = new DeleteDocumentationVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the DomainName resource.

+ * @see {@link DeleteDomainNameCommand} */ - public deleteDomainName( + deleteDomainName( args: DeleteDomainNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDomainName( + deleteDomainName( args: DeleteDomainNameCommandInput, cb: (err: any, data?: DeleteDomainNameCommandOutput) => void ): void; - public deleteDomainName( + deleteDomainName( args: DeleteDomainNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDomainNameCommandOutput) => void ): void; - public deleteDomainName( - args: DeleteDomainNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDomainNameCommandOutput) => void), - cb?: (err: any, data?: DeleteDomainNameCommandOutput) => void - ): Promise | void { - const command = new DeleteDomainNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.

+ * @see {@link DeleteGatewayResponseCommand} */ - public deleteGatewayResponse( + deleteGatewayResponse( args: DeleteGatewayResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteGatewayResponse( + deleteGatewayResponse( args: DeleteGatewayResponseCommandInput, cb: (err: any, data?: DeleteGatewayResponseCommandOutput) => void ): void; - public deleteGatewayResponse( + deleteGatewayResponse( args: DeleteGatewayResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGatewayResponseCommandOutput) => void ): void; - public deleteGatewayResponse( - args: DeleteGatewayResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGatewayResponseCommandOutput) => void), - cb?: (err: any, data?: DeleteGatewayResponseCommandOutput) => void - ): Promise | void { - const command = new DeleteGatewayResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Represents a delete integration.

+ * @see {@link DeleteIntegrationCommand} */ - public deleteIntegration( + deleteIntegration( args: DeleteIntegrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteIntegration( + deleteIntegration( args: DeleteIntegrationCommandInput, cb: (err: any, data?: DeleteIntegrationCommandOutput) => void ): void; - public deleteIntegration( + deleteIntegration( args: DeleteIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIntegrationCommandOutput) => void ): void; - public deleteIntegration( - args: DeleteIntegrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIntegrationCommandOutput) => void), - cb?: (err: any, data?: DeleteIntegrationCommandOutput) => void - ): Promise | void { - const command = new DeleteIntegrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Represents a delete integration response.

+ * @see {@link DeleteIntegrationResponseCommand} */ - public deleteIntegrationResponse( + deleteIntegrationResponse( args: DeleteIntegrationResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteIntegrationResponse( + deleteIntegrationResponse( args: DeleteIntegrationResponseCommandInput, cb: (err: any, data?: DeleteIntegrationResponseCommandOutput) => void ): void; - public deleteIntegrationResponse( + deleteIntegrationResponse( args: DeleteIntegrationResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIntegrationResponseCommandOutput) => void ): void; - public deleteIntegrationResponse( - args: DeleteIntegrationResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIntegrationResponseCommandOutput) => void), - cb?: (err: any, data?: DeleteIntegrationResponseCommandOutput) => void - ): Promise | void { - const command = new DeleteIntegrationResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing Method resource.

+ * @see {@link DeleteMethodCommand} */ - public deleteMethod( - args: DeleteMethodCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteMethod(args: DeleteMethodCommandInput, cb: (err: any, data?: DeleteMethodCommandOutput) => void): void; - public deleteMethod( + deleteMethod(args: DeleteMethodCommandInput, options?: __HttpHandlerOptions): Promise; + deleteMethod(args: DeleteMethodCommandInput, cb: (err: any, data?: DeleteMethodCommandOutput) => void): void; + deleteMethod( args: DeleteMethodCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMethodCommandOutput) => void ): void; - public deleteMethod( - args: DeleteMethodCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMethodCommandOutput) => void), - cb?: (err: any, data?: DeleteMethodCommandOutput) => void - ): Promise | void { - const command = new DeleteMethodCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing MethodResponse resource.

+ * @see {@link DeleteMethodResponseCommand} */ - public deleteMethodResponse( + deleteMethodResponse( args: DeleteMethodResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMethodResponse( + deleteMethodResponse( args: DeleteMethodResponseCommandInput, cb: (err: any, data?: DeleteMethodResponseCommandOutput) => void ): void; - public deleteMethodResponse( + deleteMethodResponse( args: DeleteMethodResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMethodResponseCommandOutput) => void ): void; - public deleteMethodResponse( - args: DeleteMethodResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMethodResponseCommandOutput) => void), - cb?: (err: any, data?: DeleteMethodResponseCommandOutput) => void - ): Promise | void { - const command = new DeleteMethodResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a model.

+ * @see {@link DeleteModelCommand} */ - public deleteModel(args: DeleteModelCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteModel(args: DeleteModelCommandInput, cb: (err: any, data?: DeleteModelCommandOutput) => void): void; - public deleteModel( + deleteModel(args: DeleteModelCommandInput, options?: __HttpHandlerOptions): Promise; + deleteModel(args: DeleteModelCommandInput, cb: (err: any, data?: DeleteModelCommandOutput) => void): void; + deleteModel( args: DeleteModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteModelCommandOutput) => void ): void; - public deleteModel( - args: DeleteModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteModelCommandOutput) => void), - cb?: (err: any, data?: DeleteModelCommandOutput) => void - ): Promise | void { - const command = new DeleteModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a RequestValidator of a given RestApi.

+ * @see {@link DeleteRequestValidatorCommand} */ - public deleteRequestValidator( + deleteRequestValidator( args: DeleteRequestValidatorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRequestValidator( + deleteRequestValidator( args: DeleteRequestValidatorCommandInput, cb: (err: any, data?: DeleteRequestValidatorCommandOutput) => void ): void; - public deleteRequestValidator( + deleteRequestValidator( args: DeleteRequestValidatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRequestValidatorCommandOutput) => void ): void; - public deleteRequestValidator( - args: DeleteRequestValidatorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRequestValidatorCommandOutput) => void), - cb?: (err: any, data?: DeleteRequestValidatorCommandOutput) => void - ): Promise | void { - const command = new DeleteRequestValidatorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Resource resource.

+ * @see {@link DeleteResourceCommand} */ - public deleteResource( + deleteResource( args: DeleteResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResource( - args: DeleteResourceCommandInput, - cb: (err: any, data?: DeleteResourceCommandOutput) => void - ): void; - public deleteResource( + deleteResource(args: DeleteResourceCommandInput, cb: (err: any, data?: DeleteResourceCommandOutput) => void): void; + deleteResource( args: DeleteResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourceCommandOutput) => void ): void; - public deleteResource( - args: DeleteResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourceCommandOutput) => void), - cb?: (err: any, data?: DeleteResourceCommandOutput) => void - ): Promise | void { - const command = new DeleteResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified API.

+ * @see {@link DeleteRestApiCommand} */ - public deleteRestApi( - args: DeleteRestApiCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteRestApi( - args: DeleteRestApiCommandInput, - cb: (err: any, data?: DeleteRestApiCommandOutput) => void - ): void; - public deleteRestApi( + deleteRestApi(args: DeleteRestApiCommandInput, options?: __HttpHandlerOptions): Promise; + deleteRestApi(args: DeleteRestApiCommandInput, cb: (err: any, data?: DeleteRestApiCommandOutput) => void): void; + deleteRestApi( args: DeleteRestApiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRestApiCommandOutput) => void ): void; - public deleteRestApi( - args: DeleteRestApiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRestApiCommandOutput) => void), - cb?: (err: any, data?: DeleteRestApiCommandOutput) => void - ): Promise | void { - const command = new DeleteRestApiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Stage resource.

+ * @see {@link DeleteStageCommand} */ - public deleteStage(args: DeleteStageCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteStage(args: DeleteStageCommandInput, cb: (err: any, data?: DeleteStageCommandOutput) => void): void; - public deleteStage( + deleteStage(args: DeleteStageCommandInput, options?: __HttpHandlerOptions): Promise; + deleteStage(args: DeleteStageCommandInput, cb: (err: any, data?: DeleteStageCommandOutput) => void): void; + deleteStage( args: DeleteStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStageCommandOutput) => void ): void; - public deleteStage( - args: DeleteStageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStageCommandOutput) => void), - cb?: (err: any, data?: DeleteStageCommandOutput) => void - ): Promise | void { - const command = new DeleteStageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a usage plan of a given plan Id.

+ * @see {@link DeleteUsagePlanCommand} */ - public deleteUsagePlan( + deleteUsagePlan( args: DeleteUsagePlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteUsagePlan( - args: DeleteUsagePlanCommandInput, - cb: (err: any, data?: DeleteUsagePlanCommandOutput) => void - ): void; - public deleteUsagePlan( + deleteUsagePlan(args: DeleteUsagePlanCommandInput, cb: (err: any, data?: DeleteUsagePlanCommandOutput) => void): void; + deleteUsagePlan( args: DeleteUsagePlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUsagePlanCommandOutput) => void ): void; - public deleteUsagePlan( - args: DeleteUsagePlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUsagePlanCommandOutput) => void), - cb?: (err: any, data?: DeleteUsagePlanCommandOutput) => void - ): Promise | void { - const command = new DeleteUsagePlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a usage plan key and remove the underlying API key from the associated usage plan.

+ * @see {@link DeleteUsagePlanKeyCommand} */ - public deleteUsagePlanKey( + deleteUsagePlanKey( args: DeleteUsagePlanKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteUsagePlanKey( + deleteUsagePlanKey( args: DeleteUsagePlanKeyCommandInput, cb: (err: any, data?: DeleteUsagePlanKeyCommandOutput) => void ): void; - public deleteUsagePlanKey( + deleteUsagePlanKey( args: DeleteUsagePlanKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUsagePlanKeyCommandOutput) => void ): void; - public deleteUsagePlanKey( - args: DeleteUsagePlanKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUsagePlanKeyCommandOutput) => void), - cb?: (err: any, data?: DeleteUsagePlanKeyCommandOutput) => void - ): Promise | void { - const command = new DeleteUsagePlanKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing VpcLink of a specified identifier.

+ * @see {@link DeleteVpcLinkCommand} */ - public deleteVpcLink( - args: DeleteVpcLinkCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteVpcLink( - args: DeleteVpcLinkCommandInput, - cb: (err: any, data?: DeleteVpcLinkCommandOutput) => void - ): void; - public deleteVpcLink( + deleteVpcLink(args: DeleteVpcLinkCommandInput, options?: __HttpHandlerOptions): Promise; + deleteVpcLink(args: DeleteVpcLinkCommandInput, cb: (err: any, data?: DeleteVpcLinkCommandOutput) => void): void; + deleteVpcLink( args: DeleteVpcLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVpcLinkCommandOutput) => void ): void; - public deleteVpcLink( - args: DeleteVpcLinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVpcLinkCommandOutput) => void), - cb?: (err: any, data?: DeleteVpcLinkCommandOutput) => void - ): Promise | void { - const command = new DeleteVpcLinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Flushes all authorizer cache entries on a stage.

+ * @see {@link FlushStageAuthorizersCacheCommand} */ - public flushStageAuthorizersCache( + flushStageAuthorizersCache( args: FlushStageAuthorizersCacheCommandInput, options?: __HttpHandlerOptions ): Promise; - public flushStageAuthorizersCache( + flushStageAuthorizersCache( args: FlushStageAuthorizersCacheCommandInput, cb: (err: any, data?: FlushStageAuthorizersCacheCommandOutput) => void ): void; - public flushStageAuthorizersCache( + flushStageAuthorizersCache( args: FlushStageAuthorizersCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FlushStageAuthorizersCacheCommandOutput) => void ): void; - public flushStageAuthorizersCache( - args: FlushStageAuthorizersCacheCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FlushStageAuthorizersCacheCommandOutput) => void), - cb?: (err: any, data?: FlushStageAuthorizersCacheCommandOutput) => void - ): Promise | void { - const command = new FlushStageAuthorizersCacheCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Flushes a stage's cache.

+ * @see {@link FlushStageCacheCommand} */ - public flushStageCache( + flushStageCache( args: FlushStageCacheCommandInput, options?: __HttpHandlerOptions ): Promise; - public flushStageCache( - args: FlushStageCacheCommandInput, - cb: (err: any, data?: FlushStageCacheCommandOutput) => void - ): void; - public flushStageCache( + flushStageCache(args: FlushStageCacheCommandInput, cb: (err: any, data?: FlushStageCacheCommandOutput) => void): void; + flushStageCache( args: FlushStageCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FlushStageCacheCommandOutput) => void ): void; - public flushStageCache( - args: FlushStageCacheCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FlushStageCacheCommandOutput) => void), - cb?: (err: any, data?: FlushStageCacheCommandOutput) => void - ): Promise | void { - const command = new FlushStageCacheCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Generates a ClientCertificate resource.

+ * @see {@link GenerateClientCertificateCommand} */ - public generateClientCertificate( + generateClientCertificate( args: GenerateClientCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public generateClientCertificate( + generateClientCertificate( args: GenerateClientCertificateCommandInput, cb: (err: any, data?: GenerateClientCertificateCommandOutput) => void ): void; - public generateClientCertificate( + generateClientCertificate( args: GenerateClientCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateClientCertificateCommandOutput) => void ): void; - public generateClientCertificate( - args: GenerateClientCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GenerateClientCertificateCommandOutput) => void), - cb?: (err: any, data?: GenerateClientCertificateCommandOutput) => void - ): Promise | void { - const command = new GenerateClientCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about the current Account resource.

+ * @see {@link GetAccountCommand} */ - public getAccount(args: GetAccountCommandInput, options?: __HttpHandlerOptions): Promise; - public getAccount(args: GetAccountCommandInput, cb: (err: any, data?: GetAccountCommandOutput) => void): void; - public getAccount( + getAccount(args: GetAccountCommandInput, options?: __HttpHandlerOptions): Promise; + getAccount(args: GetAccountCommandInput, cb: (err: any, data?: GetAccountCommandOutput) => void): void; + getAccount( args: GetAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountCommandOutput) => void ): void; - public getAccount( - args: GetAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccountCommandOutput) => void), - cb?: (err: any, data?: GetAccountCommandOutput) => void - ): Promise | void { - const command = new GetAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about the current ApiKey resource.

+ * @see {@link GetApiKeyCommand} */ - public getApiKey(args: GetApiKeyCommandInput, options?: __HttpHandlerOptions): Promise; - public getApiKey(args: GetApiKeyCommandInput, cb: (err: any, data?: GetApiKeyCommandOutput) => void): void; - public getApiKey( + getApiKey(args: GetApiKeyCommandInput, options?: __HttpHandlerOptions): Promise; + getApiKey(args: GetApiKeyCommandInput, cb: (err: any, data?: GetApiKeyCommandOutput) => void): void; + getApiKey( args: GetApiKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApiKeyCommandOutput) => void ): void; - public getApiKey( - args: GetApiKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApiKeyCommandOutput) => void), - cb?: (err: any, data?: GetApiKeyCommandOutput) => void - ): Promise | void { - const command = new GetApiKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about the current ApiKeys resource.

+ * @see {@link GetApiKeysCommand} */ - public getApiKeys(args: GetApiKeysCommandInput, options?: __HttpHandlerOptions): Promise; - public getApiKeys(args: GetApiKeysCommandInput, cb: (err: any, data?: GetApiKeysCommandOutput) => void): void; - public getApiKeys( + getApiKeys(args: GetApiKeysCommandInput, options?: __HttpHandlerOptions): Promise; + getApiKeys(args: GetApiKeysCommandInput, cb: (err: any, data?: GetApiKeysCommandOutput) => void): void; + getApiKeys( args: GetApiKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApiKeysCommandOutput) => void ): void; - public getApiKeys( - args: GetApiKeysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApiKeysCommandOutput) => void), - cb?: (err: any, data?: GetApiKeysCommandOutput) => void - ): Promise | void { - const command = new GetApiKeysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describe an existing Authorizer resource.

+ * @see {@link GetAuthorizerCommand} */ - public getAuthorizer( - args: GetAuthorizerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getAuthorizer( - args: GetAuthorizerCommandInput, - cb: (err: any, data?: GetAuthorizerCommandOutput) => void - ): void; - public getAuthorizer( + getAuthorizer(args: GetAuthorizerCommandInput, options?: __HttpHandlerOptions): Promise; + getAuthorizer(args: GetAuthorizerCommandInput, cb: (err: any, data?: GetAuthorizerCommandOutput) => void): void; + getAuthorizer( args: GetAuthorizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAuthorizerCommandOutput) => void ): void; - public getAuthorizer( - args: GetAuthorizerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAuthorizerCommandOutput) => void), - cb?: (err: any, data?: GetAuthorizerCommandOutput) => void - ): Promise | void { - const command = new GetAuthorizerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describe an existing Authorizers resource.

+ * @see {@link GetAuthorizersCommand} */ - public getAuthorizers( + getAuthorizers( args: GetAuthorizersCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAuthorizers( - args: GetAuthorizersCommandInput, - cb: (err: any, data?: GetAuthorizersCommandOutput) => void - ): void; - public getAuthorizers( + getAuthorizers(args: GetAuthorizersCommandInput, cb: (err: any, data?: GetAuthorizersCommandOutput) => void): void; + getAuthorizers( args: GetAuthorizersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAuthorizersCommandOutput) => void ): void; - public getAuthorizers( - args: GetAuthorizersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAuthorizersCommandOutput) => void), - cb?: (err: any, data?: GetAuthorizersCommandOutput) => void - ): Promise | void { - const command = new GetAuthorizersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describe a BasePathMapping resource.

+ * @see {@link GetBasePathMappingCommand} */ - public getBasePathMapping( + getBasePathMapping( args: GetBasePathMappingCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBasePathMapping( + getBasePathMapping( args: GetBasePathMappingCommandInput, cb: (err: any, data?: GetBasePathMappingCommandOutput) => void ): void; - public getBasePathMapping( + getBasePathMapping( args: GetBasePathMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBasePathMappingCommandOutput) => void ): void; - public getBasePathMapping( - args: GetBasePathMappingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBasePathMappingCommandOutput) => void), - cb?: (err: any, data?: GetBasePathMappingCommandOutput) => void - ): Promise | void { - const command = new GetBasePathMappingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Represents a collection of BasePathMapping resources.

+ * @see {@link GetBasePathMappingsCommand} */ - public getBasePathMappings( + getBasePathMappings( args: GetBasePathMappingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBasePathMappings( + getBasePathMappings( args: GetBasePathMappingsCommandInput, cb: (err: any, data?: GetBasePathMappingsCommandOutput) => void ): void; - public getBasePathMappings( + getBasePathMappings( args: GetBasePathMappingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBasePathMappingsCommandOutput) => void ): void; - public getBasePathMappings( - args: GetBasePathMappingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBasePathMappingsCommandOutput) => void), - cb?: (err: any, data?: GetBasePathMappingsCommandOutput) => void - ): Promise | void { - const command = new GetBasePathMappingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about the current ClientCertificate resource.

+ * @see {@link GetClientCertificateCommand} */ - public getClientCertificate( + getClientCertificate( args: GetClientCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getClientCertificate( + getClientCertificate( args: GetClientCertificateCommandInput, cb: (err: any, data?: GetClientCertificateCommandOutput) => void ): void; - public getClientCertificate( + getClientCertificate( args: GetClientCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetClientCertificateCommandOutput) => void ): void; - public getClientCertificate( - args: GetClientCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetClientCertificateCommandOutput) => void), - cb?: (err: any, data?: GetClientCertificateCommandOutput) => void - ): Promise | void { - const command = new GetClientCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a collection of ClientCertificate resources.

+ * @see {@link GetClientCertificatesCommand} */ - public getClientCertificates( + getClientCertificates( args: GetClientCertificatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getClientCertificates( + getClientCertificates( args: GetClientCertificatesCommandInput, cb: (err: any, data?: GetClientCertificatesCommandOutput) => void ): void; - public getClientCertificates( + getClientCertificates( args: GetClientCertificatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetClientCertificatesCommandOutput) => void ): void; - public getClientCertificates( - args: GetClientCertificatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetClientCertificatesCommandOutput) => void), - cb?: (err: any, data?: GetClientCertificatesCommandOutput) => void - ): Promise | void { - const command = new GetClientCertificatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a Deployment resource.

+ * @see {@link GetDeploymentCommand} */ - public getDeployment( - args: GetDeploymentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getDeployment( - args: GetDeploymentCommandInput, - cb: (err: any, data?: GetDeploymentCommandOutput) => void - ): void; - public getDeployment( + getDeployment(args: GetDeploymentCommandInput, options?: __HttpHandlerOptions): Promise; + getDeployment(args: GetDeploymentCommandInput, cb: (err: any, data?: GetDeploymentCommandOutput) => void): void; + getDeployment( args: GetDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeploymentCommandOutput) => void ): void; - public getDeployment( - args: GetDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeploymentCommandOutput) => void), - cb?: (err: any, data?: GetDeploymentCommandOutput) => void - ): Promise | void { - const command = new GetDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a Deployments collection.

+ * @see {@link GetDeploymentsCommand} */ - public getDeployments( + getDeployments( args: GetDeploymentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDeployments( - args: GetDeploymentsCommandInput, - cb: (err: any, data?: GetDeploymentsCommandOutput) => void - ): void; - public getDeployments( + getDeployments(args: GetDeploymentsCommandInput, cb: (err: any, data?: GetDeploymentsCommandOutput) => void): void; + getDeployments( args: GetDeploymentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeploymentsCommandOutput) => void ): void; - public getDeployments( - args: GetDeploymentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeploymentsCommandOutput) => void), - cb?: (err: any, data?: GetDeploymentsCommandOutput) => void - ): Promise | void { - const command = new GetDeploymentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a documentation part.

+ * @see {@link GetDocumentationPartCommand} */ - public getDocumentationPart( + getDocumentationPart( args: GetDocumentationPartCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDocumentationPart( + getDocumentationPart( args: GetDocumentationPartCommandInput, cb: (err: any, data?: GetDocumentationPartCommandOutput) => void ): void; - public getDocumentationPart( + getDocumentationPart( args: GetDocumentationPartCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentationPartCommandOutput) => void ): void; - public getDocumentationPart( - args: GetDocumentationPartCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDocumentationPartCommandOutput) => void), - cb?: (err: any, data?: GetDocumentationPartCommandOutput) => void - ): Promise | void { - const command = new GetDocumentationPartCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets documentation parts.

+ * @see {@link GetDocumentationPartsCommand} */ - public getDocumentationParts( + getDocumentationParts( args: GetDocumentationPartsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDocumentationParts( + getDocumentationParts( args: GetDocumentationPartsCommandInput, cb: (err: any, data?: GetDocumentationPartsCommandOutput) => void ): void; - public getDocumentationParts( + getDocumentationParts( args: GetDocumentationPartsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentationPartsCommandOutput) => void ): void; - public getDocumentationParts( - args: GetDocumentationPartsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDocumentationPartsCommandOutput) => void), - cb?: (err: any, data?: GetDocumentationPartsCommandOutput) => void - ): Promise | void { - const command = new GetDocumentationPartsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a documentation version.

+ * @see {@link GetDocumentationVersionCommand} */ - public getDocumentationVersion( + getDocumentationVersion( args: GetDocumentationVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDocumentationVersion( + getDocumentationVersion( args: GetDocumentationVersionCommandInput, cb: (err: any, data?: GetDocumentationVersionCommandOutput) => void ): void; - public getDocumentationVersion( + getDocumentationVersion( args: GetDocumentationVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentationVersionCommandOutput) => void ): void; - public getDocumentationVersion( - args: GetDocumentationVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDocumentationVersionCommandOutput) => void), - cb?: (err: any, data?: GetDocumentationVersionCommandOutput) => void - ): Promise | void { - const command = new GetDocumentationVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets documentation versions.

+ * @see {@link GetDocumentationVersionsCommand} */ - public getDocumentationVersions( + getDocumentationVersions( args: GetDocumentationVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDocumentationVersions( + getDocumentationVersions( args: GetDocumentationVersionsCommandInput, cb: (err: any, data?: GetDocumentationVersionsCommandOutput) => void ): void; - public getDocumentationVersions( + getDocumentationVersions( args: GetDocumentationVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentationVersionsCommandOutput) => void ): void; - public getDocumentationVersions( - args: GetDocumentationVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDocumentationVersionsCommandOutput) => void), - cb?: (err: any, data?: GetDocumentationVersionsCommandOutput) => void - ): Promise | void { - const command = new GetDocumentationVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

+ * @see {@link GetDomainNameCommand} */ - public getDomainName( - args: GetDomainNameCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getDomainName( - args: GetDomainNameCommandInput, - cb: (err: any, data?: GetDomainNameCommandOutput) => void - ): void; - public getDomainName( + getDomainName(args: GetDomainNameCommandInput, options?: __HttpHandlerOptions): Promise; + getDomainName(args: GetDomainNameCommandInput, cb: (err: any, data?: GetDomainNameCommandOutput) => void): void; + getDomainName( args: GetDomainNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDomainNameCommandOutput) => void ): void; - public getDomainName( - args: GetDomainNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDomainNameCommandOutput) => void), - cb?: (err: any, data?: GetDomainNameCommandOutput) => void - ): Promise | void { - const command = new GetDomainNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Represents a collection of DomainName resources.

+ * @see {@link GetDomainNamesCommand} */ - public getDomainNames( + getDomainNames( args: GetDomainNamesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDomainNames( - args: GetDomainNamesCommandInput, - cb: (err: any, data?: GetDomainNamesCommandOutput) => void - ): void; - public getDomainNames( + getDomainNames(args: GetDomainNamesCommandInput, cb: (err: any, data?: GetDomainNamesCommandOutput) => void): void; + getDomainNames( args: GetDomainNamesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDomainNamesCommandOutput) => void ): void; - public getDomainNames( - args: GetDomainNamesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDomainNamesCommandOutput) => void), - cb?: (err: any, data?: GetDomainNamesCommandOutput) => void - ): Promise | void { - const command = new GetDomainNamesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Exports a deployed version of a RestApi in a specified format.

+ * @see {@link GetExportCommand} */ - public getExport(args: GetExportCommandInput, options?: __HttpHandlerOptions): Promise; - public getExport(args: GetExportCommandInput, cb: (err: any, data?: GetExportCommandOutput) => void): void; - public getExport( + getExport(args: GetExportCommandInput, options?: __HttpHandlerOptions): Promise; + getExport(args: GetExportCommandInput, cb: (err: any, data?: GetExportCommandOutput) => void): void; + getExport( args: GetExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExportCommandOutput) => void ): void; - public getExport( - args: GetExportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetExportCommandOutput) => void), - cb?: (err: any, data?: GetExportCommandOutput) => void - ): Promise | void { - const command = new GetExportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a GatewayResponse of a specified response type on the given RestApi.

+ * @see {@link GetGatewayResponseCommand} */ - public getGatewayResponse( + getGatewayResponse( args: GetGatewayResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public getGatewayResponse( + getGatewayResponse( args: GetGatewayResponseCommandInput, cb: (err: any, data?: GetGatewayResponseCommandOutput) => void ): void; - public getGatewayResponse( + getGatewayResponse( args: GetGatewayResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGatewayResponseCommandOutput) => void ): void; - public getGatewayResponse( - args: GetGatewayResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGatewayResponseCommandOutput) => void), - cb?: (err: any, data?: GetGatewayResponseCommandOutput) => void - ): Promise | void { - const command = new GetGatewayResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.

+ * @see {@link GetGatewayResponsesCommand} */ - public getGatewayResponses( + getGatewayResponses( args: GetGatewayResponsesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getGatewayResponses( + getGatewayResponses( args: GetGatewayResponsesCommandInput, cb: (err: any, data?: GetGatewayResponsesCommandOutput) => void ): void; - public getGatewayResponses( + getGatewayResponses( args: GetGatewayResponsesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGatewayResponsesCommandOutput) => void ): void; - public getGatewayResponses( - args: GetGatewayResponsesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGatewayResponsesCommandOutput) => void), - cb?: (err: any, data?: GetGatewayResponsesCommandOutput) => void - ): Promise | void { - const command = new GetGatewayResponsesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the integration settings.

+ * @see {@link GetIntegrationCommand} */ - public getIntegration( + getIntegration( args: GetIntegrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIntegration( - args: GetIntegrationCommandInput, - cb: (err: any, data?: GetIntegrationCommandOutput) => void - ): void; - public getIntegration( + getIntegration(args: GetIntegrationCommandInput, cb: (err: any, data?: GetIntegrationCommandOutput) => void): void; + getIntegration( args: GetIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIntegrationCommandOutput) => void ): void; - public getIntegration( - args: GetIntegrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIntegrationCommandOutput) => void), - cb?: (err: any, data?: GetIntegrationCommandOutput) => void - ): Promise | void { - const command = new GetIntegrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Represents a get integration response.

+ * @see {@link GetIntegrationResponseCommand} */ - public getIntegrationResponse( + getIntegrationResponse( args: GetIntegrationResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIntegrationResponse( + getIntegrationResponse( args: GetIntegrationResponseCommandInput, cb: (err: any, data?: GetIntegrationResponseCommandOutput) => void ): void; - public getIntegrationResponse( + getIntegrationResponse( args: GetIntegrationResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIntegrationResponseCommandOutput) => void ): void; - public getIntegrationResponse( - args: GetIntegrationResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIntegrationResponseCommandOutput) => void), - cb?: (err: any, data?: GetIntegrationResponseCommandOutput) => void - ): Promise | void { - const command = new GetIntegrationResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describe an existing Method resource.

+ * @see {@link GetMethodCommand} */ - public getMethod(args: GetMethodCommandInput, options?: __HttpHandlerOptions): Promise; - public getMethod(args: GetMethodCommandInput, cb: (err: any, data?: GetMethodCommandOutput) => void): void; - public getMethod( + getMethod(args: GetMethodCommandInput, options?: __HttpHandlerOptions): Promise; + getMethod(args: GetMethodCommandInput, cb: (err: any, data?: GetMethodCommandOutput) => void): void; + getMethod( args: GetMethodCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMethodCommandOutput) => void ): void; - public getMethod( - args: GetMethodCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMethodCommandOutput) => void), - cb?: (err: any, data?: GetMethodCommandOutput) => void - ): Promise | void { - const command = new GetMethodCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a MethodResponse resource.

+ * @see {@link GetMethodResponseCommand} */ - public getMethodResponse( + getMethodResponse( args: GetMethodResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMethodResponse( + getMethodResponse( args: GetMethodResponseCommandInput, cb: (err: any, data?: GetMethodResponseCommandOutput) => void ): void; - public getMethodResponse( + getMethodResponse( args: GetMethodResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMethodResponseCommandOutput) => void ): void; - public getMethodResponse( - args: GetMethodResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMethodResponseCommandOutput) => void), - cb?: (err: any, data?: GetMethodResponseCommandOutput) => void - ): Promise | void { - const command = new GetMethodResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an existing model defined for a RestApi resource.

+ * @see {@link GetModelCommand} */ - public getModel(args: GetModelCommandInput, options?: __HttpHandlerOptions): Promise; - public getModel(args: GetModelCommandInput, cb: (err: any, data?: GetModelCommandOutput) => void): void; - public getModel( + getModel(args: GetModelCommandInput, options?: __HttpHandlerOptions): Promise; + getModel(args: GetModelCommandInput, cb: (err: any, data?: GetModelCommandOutput) => void): void; + getModel( args: GetModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetModelCommandOutput) => void ): void; - public getModel( - args: GetModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetModelCommandOutput) => void), - cb?: (err: any, data?: GetModelCommandOutput) => void - ): Promise | void { - const command = new GetModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes existing Models defined for a RestApi resource.

+ * @see {@link GetModelsCommand} */ - public getModels(args: GetModelsCommandInput, options?: __HttpHandlerOptions): Promise; - public getModels(args: GetModelsCommandInput, cb: (err: any, data?: GetModelsCommandOutput) => void): void; - public getModels( + getModels(args: GetModelsCommandInput, options?: __HttpHandlerOptions): Promise; + getModels(args: GetModelsCommandInput, cb: (err: any, data?: GetModelsCommandOutput) => void): void; + getModels( args: GetModelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetModelsCommandOutput) => void ): void; - public getModels( - args: GetModelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetModelsCommandOutput) => void), - cb?: (err: any, data?: GetModelsCommandOutput) => void - ): Promise | void { - const command = new GetModelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Generates a sample mapping template that can be used to transform a payload into the structure of a model.

+ * @see {@link GetModelTemplateCommand} */ - public getModelTemplate( + getModelTemplate( args: GetModelTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getModelTemplate( + getModelTemplate( args: GetModelTemplateCommandInput, cb: (err: any, data?: GetModelTemplateCommandOutput) => void ): void; - public getModelTemplate( + getModelTemplate( args: GetModelTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetModelTemplateCommandOutput) => void ): void; - public getModelTemplate( - args: GetModelTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetModelTemplateCommandOutput) => void), - cb?: (err: any, data?: GetModelTemplateCommandOutput) => void - ): Promise | void { - const command = new GetModelTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a RequestValidator of a given RestApi.

+ * @see {@link GetRequestValidatorCommand} */ - public getRequestValidator( + getRequestValidator( args: GetRequestValidatorCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRequestValidator( + getRequestValidator( args: GetRequestValidatorCommandInput, cb: (err: any, data?: GetRequestValidatorCommandOutput) => void ): void; - public getRequestValidator( + getRequestValidator( args: GetRequestValidatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRequestValidatorCommandOutput) => void ): void; - public getRequestValidator( - args: GetRequestValidatorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRequestValidatorCommandOutput) => void), - cb?: (err: any, data?: GetRequestValidatorCommandOutput) => void - ): Promise | void { - const command = new GetRequestValidatorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the RequestValidators collection of a given RestApi.

+ * @see {@link GetRequestValidatorsCommand} */ - public getRequestValidators( + getRequestValidators( args: GetRequestValidatorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRequestValidators( + getRequestValidators( args: GetRequestValidatorsCommandInput, cb: (err: any, data?: GetRequestValidatorsCommandOutput) => void ): void; - public getRequestValidators( + getRequestValidators( args: GetRequestValidatorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRequestValidatorsCommandOutput) => void ): void; - public getRequestValidators( - args: GetRequestValidatorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRequestValidatorsCommandOutput) => void), - cb?: (err: any, data?: GetRequestValidatorsCommandOutput) => void - ): Promise | void { - const command = new GetRequestValidatorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists information about a resource.

+ * @see {@link GetResourceCommand} */ - public getResource(args: GetResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public getResource(args: GetResourceCommandInput, cb: (err: any, data?: GetResourceCommandOutput) => void): void; - public getResource( + getResource(args: GetResourceCommandInput, options?: __HttpHandlerOptions): Promise; + getResource(args: GetResourceCommandInput, cb: (err: any, data?: GetResourceCommandOutput) => void): void; + getResource( args: GetResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceCommandOutput) => void ): void; - public getResource( - args: GetResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourceCommandOutput) => void), - cb?: (err: any, data?: GetResourceCommandOutput) => void - ): Promise | void { - const command = new GetResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists information about a collection of Resource resources.

+ * @see {@link GetResourcesCommand} */ - public getResources( - args: GetResourcesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getResources(args: GetResourcesCommandInput, cb: (err: any, data?: GetResourcesCommandOutput) => void): void; - public getResources( + getResources(args: GetResourcesCommandInput, options?: __HttpHandlerOptions): Promise; + getResources(args: GetResourcesCommandInput, cb: (err: any, data?: GetResourcesCommandOutput) => void): void; + getResources( args: GetResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcesCommandOutput) => void ): void; - public getResources( - args: GetResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourcesCommandOutput) => void), - cb?: (err: any, data?: GetResourcesCommandOutput) => void - ): Promise | void { - const command = new GetResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the RestApi resource in the collection.

+ * @see {@link GetRestApiCommand} */ - public getRestApi(args: GetRestApiCommandInput, options?: __HttpHandlerOptions): Promise; - public getRestApi(args: GetRestApiCommandInput, cb: (err: any, data?: GetRestApiCommandOutput) => void): void; - public getRestApi( + getRestApi(args: GetRestApiCommandInput, options?: __HttpHandlerOptions): Promise; + getRestApi(args: GetRestApiCommandInput, cb: (err: any, data?: GetRestApiCommandOutput) => void): void; + getRestApi( args: GetRestApiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRestApiCommandOutput) => void ): void; - public getRestApi( - args: GetRestApiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRestApiCommandOutput) => void), - cb?: (err: any, data?: GetRestApiCommandOutput) => void - ): Promise | void { - const command = new GetRestApiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the RestApis resources for your collection.

+ * @see {@link GetRestApisCommand} */ - public getRestApis(args: GetRestApisCommandInput, options?: __HttpHandlerOptions): Promise; - public getRestApis(args: GetRestApisCommandInput, cb: (err: any, data?: GetRestApisCommandOutput) => void): void; - public getRestApis( + getRestApis(args: GetRestApisCommandInput, options?: __HttpHandlerOptions): Promise; + getRestApis(args: GetRestApisCommandInput, cb: (err: any, data?: GetRestApisCommandOutput) => void): void; + getRestApis( args: GetRestApisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRestApisCommandOutput) => void ): void; - public getRestApis( - args: GetRestApisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRestApisCommandOutput) => void), - cb?: (err: any, data?: GetRestApisCommandOutput) => void - ): Promise | void { - const command = new GetRestApisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Generates a client SDK for a RestApi and Stage.

+ * @see {@link GetSdkCommand} */ - public getSdk(args: GetSdkCommandInput, options?: __HttpHandlerOptions): Promise; - public getSdk(args: GetSdkCommandInput, cb: (err: any, data?: GetSdkCommandOutput) => void): void; - public getSdk( + getSdk(args: GetSdkCommandInput, options?: __HttpHandlerOptions): Promise; + getSdk(args: GetSdkCommandInput, cb: (err: any, data?: GetSdkCommandOutput) => void): void; + getSdk( args: GetSdkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSdkCommandOutput) => void ): void; - public getSdk( - args: GetSdkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSdkCommandOutput) => void), - cb?: (err: any, data?: GetSdkCommandOutput) => void - ): Promise | void { - const command = new GetSdkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets an SDK type.

+ * @see {@link GetSdkTypeCommand} */ - public getSdkType(args: GetSdkTypeCommandInput, options?: __HttpHandlerOptions): Promise; - public getSdkType(args: GetSdkTypeCommandInput, cb: (err: any, data?: GetSdkTypeCommandOutput) => void): void; - public getSdkType( + getSdkType(args: GetSdkTypeCommandInput, options?: __HttpHandlerOptions): Promise; + getSdkType(args: GetSdkTypeCommandInput, cb: (err: any, data?: GetSdkTypeCommandOutput) => void): void; + getSdkType( args: GetSdkTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSdkTypeCommandOutput) => void ): void; - public getSdkType( - args: GetSdkTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSdkTypeCommandOutput) => void), - cb?: (err: any, data?: GetSdkTypeCommandOutput) => void - ): Promise | void { - const command = new GetSdkTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets SDK types

+ * @see {@link GetSdkTypesCommand} */ - public getSdkTypes(args: GetSdkTypesCommandInput, options?: __HttpHandlerOptions): Promise; - public getSdkTypes(args: GetSdkTypesCommandInput, cb: (err: any, data?: GetSdkTypesCommandOutput) => void): void; - public getSdkTypes( + getSdkTypes(args: GetSdkTypesCommandInput, options?: __HttpHandlerOptions): Promise; + getSdkTypes(args: GetSdkTypesCommandInput, cb: (err: any, data?: GetSdkTypesCommandOutput) => void): void; + getSdkTypes( args: GetSdkTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSdkTypesCommandOutput) => void ): void; - public getSdkTypes( - args: GetSdkTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSdkTypesCommandOutput) => void), - cb?: (err: any, data?: GetSdkTypesCommandOutput) => void - ): Promise | void { - const command = new GetSdkTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a Stage resource.

+ * @see {@link GetStageCommand} */ - public getStage(args: GetStageCommandInput, options?: __HttpHandlerOptions): Promise; - public getStage(args: GetStageCommandInput, cb: (err: any, data?: GetStageCommandOutput) => void): void; - public getStage( + getStage(args: GetStageCommandInput, options?: __HttpHandlerOptions): Promise; + getStage(args: GetStageCommandInput, cb: (err: any, data?: GetStageCommandOutput) => void): void; + getStage( args: GetStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStageCommandOutput) => void ): void; - public getStage( - args: GetStageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStageCommandOutput) => void), - cb?: (err: any, data?: GetStageCommandOutput) => void - ): Promise | void { - const command = new GetStageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about one or more Stage resources.

+ * @see {@link GetStagesCommand} */ - public getStages(args: GetStagesCommandInput, options?: __HttpHandlerOptions): Promise; - public getStages(args: GetStagesCommandInput, cb: (err: any, data?: GetStagesCommandOutput) => void): void; - public getStages( + getStages(args: GetStagesCommandInput, options?: __HttpHandlerOptions): Promise; + getStages(args: GetStagesCommandInput, cb: (err: any, data?: GetStagesCommandOutput) => void): void; + getStages( args: GetStagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStagesCommandOutput) => void ): void; - public getStages( - args: GetStagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStagesCommandOutput) => void), - cb?: (err: any, data?: GetStagesCommandOutput) => void - ): Promise | void { - const command = new GetStagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the Tags collection for a given resource.

+ * @see {@link GetTagsCommand} */ - public getTags(args: GetTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public getTags(args: GetTagsCommandInput, cb: (err: any, data?: GetTagsCommandOutput) => void): void; - public getTags( + getTags(args: GetTagsCommandInput, options?: __HttpHandlerOptions): Promise; + getTags(args: GetTagsCommandInput, cb: (err: any, data?: GetTagsCommandOutput) => void): void; + getTags( args: GetTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTagsCommandOutput) => void ): void; - public getTags( - args: GetTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTagsCommandOutput) => void), - cb?: (err: any, data?: GetTagsCommandOutput) => void - ): Promise | void { - const command = new GetTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the usage data of a usage plan in a specified time interval.

+ * @see {@link GetUsageCommand} */ - public getUsage(args: GetUsageCommandInput, options?: __HttpHandlerOptions): Promise; - public getUsage(args: GetUsageCommandInput, cb: (err: any, data?: GetUsageCommandOutput) => void): void; - public getUsage( + getUsage(args: GetUsageCommandInput, options?: __HttpHandlerOptions): Promise; + getUsage(args: GetUsageCommandInput, cb: (err: any, data?: GetUsageCommandOutput) => void): void; + getUsage( args: GetUsageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUsageCommandOutput) => void ): void; - public getUsage( - args: GetUsageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUsageCommandOutput) => void), - cb?: (err: any, data?: GetUsageCommandOutput) => void - ): Promise | void { - const command = new GetUsageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a usage plan of a given plan identifier.

+ * @see {@link GetUsagePlanCommand} */ - public getUsagePlan( - args: GetUsagePlanCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getUsagePlan(args: GetUsagePlanCommandInput, cb: (err: any, data?: GetUsagePlanCommandOutput) => void): void; - public getUsagePlan( + getUsagePlan(args: GetUsagePlanCommandInput, options?: __HttpHandlerOptions): Promise; + getUsagePlan(args: GetUsagePlanCommandInput, cb: (err: any, data?: GetUsagePlanCommandOutput) => void): void; + getUsagePlan( args: GetUsagePlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUsagePlanCommandOutput) => void ): void; - public getUsagePlan( - args: GetUsagePlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUsagePlanCommandOutput) => void), - cb?: (err: any, data?: GetUsagePlanCommandOutput) => void - ): Promise | void { - const command = new GetUsagePlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a usage plan key of a given key identifier.

+ * @see {@link GetUsagePlanKeyCommand} */ - public getUsagePlanKey( + getUsagePlanKey( args: GetUsagePlanKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUsagePlanKey( - args: GetUsagePlanKeyCommandInput, - cb: (err: any, data?: GetUsagePlanKeyCommandOutput) => void - ): void; - public getUsagePlanKey( + getUsagePlanKey(args: GetUsagePlanKeyCommandInput, cb: (err: any, data?: GetUsagePlanKeyCommandOutput) => void): void; + getUsagePlanKey( args: GetUsagePlanKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUsagePlanKeyCommandOutput) => void ): void; - public getUsagePlanKey( - args: GetUsagePlanKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUsagePlanKeyCommandOutput) => void), - cb?: (err: any, data?: GetUsagePlanKeyCommandOutput) => void - ): Promise | void { - const command = new GetUsagePlanKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets all the usage plan keys representing the API keys added to a specified usage plan.

+ * @see {@link GetUsagePlanKeysCommand} */ - public getUsagePlanKeys( + getUsagePlanKeys( args: GetUsagePlanKeysCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUsagePlanKeys( + getUsagePlanKeys( args: GetUsagePlanKeysCommandInput, cb: (err: any, data?: GetUsagePlanKeysCommandOutput) => void ): void; - public getUsagePlanKeys( + getUsagePlanKeys( args: GetUsagePlanKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUsagePlanKeysCommandOutput) => void ): void; - public getUsagePlanKeys( - args: GetUsagePlanKeysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUsagePlanKeysCommandOutput) => void), - cb?: (err: any, data?: GetUsagePlanKeysCommandOutput) => void - ): Promise | void { - const command = new GetUsagePlanKeysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets all the usage plans of the caller's account.

+ * @see {@link GetUsagePlansCommand} */ - public getUsagePlans( - args: GetUsagePlansCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getUsagePlans( - args: GetUsagePlansCommandInput, - cb: (err: any, data?: GetUsagePlansCommandOutput) => void - ): void; - public getUsagePlans( + getUsagePlans(args: GetUsagePlansCommandInput, options?: __HttpHandlerOptions): Promise; + getUsagePlans(args: GetUsagePlansCommandInput, cb: (err: any, data?: GetUsagePlansCommandOutput) => void): void; + getUsagePlans( args: GetUsagePlansCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUsagePlansCommandOutput) => void ): void; - public getUsagePlans( - args: GetUsagePlansCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUsagePlansCommandOutput) => void), - cb?: (err: any, data?: GetUsagePlansCommandOutput) => void - ): Promise | void { - const command = new GetUsagePlansCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a specified VPC link under the caller's account in a region.

+ * @see {@link GetVpcLinkCommand} */ - public getVpcLink(args: GetVpcLinkCommandInput, options?: __HttpHandlerOptions): Promise; - public getVpcLink(args: GetVpcLinkCommandInput, cb: (err: any, data?: GetVpcLinkCommandOutput) => void): void; - public getVpcLink( + getVpcLink(args: GetVpcLinkCommandInput, options?: __HttpHandlerOptions): Promise; + getVpcLink(args: GetVpcLinkCommandInput, cb: (err: any, data?: GetVpcLinkCommandOutput) => void): void; + getVpcLink( args: GetVpcLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVpcLinkCommandOutput) => void ): void; - public getVpcLink( - args: GetVpcLinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVpcLinkCommandOutput) => void), - cb?: (err: any, data?: GetVpcLinkCommandOutput) => void - ): Promise | void { - const command = new GetVpcLinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the VpcLinks collection under the caller's account in a selected region.

+ * @see {@link GetVpcLinksCommand} */ - public getVpcLinks(args: GetVpcLinksCommandInput, options?: __HttpHandlerOptions): Promise; - public getVpcLinks(args: GetVpcLinksCommandInput, cb: (err: any, data?: GetVpcLinksCommandOutput) => void): void; - public getVpcLinks( + getVpcLinks(args: GetVpcLinksCommandInput, options?: __HttpHandlerOptions): Promise; + getVpcLinks(args: GetVpcLinksCommandInput, cb: (err: any, data?: GetVpcLinksCommandOutput) => void): void; + getVpcLinks( args: GetVpcLinksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVpcLinksCommandOutput) => void ): void; - public getVpcLinks( - args: GetVpcLinksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVpcLinksCommandOutput) => void), - cb?: (err: any, data?: GetVpcLinksCommandOutput) => void - ): Promise | void { - const command = new GetVpcLinksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Import API keys from an external source, such as a CSV-formatted file.

+ * @see {@link ImportApiKeysCommand} */ - public importApiKeys( - args: ImportApiKeysCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public importApiKeys( - args: ImportApiKeysCommandInput, - cb: (err: any, data?: ImportApiKeysCommandOutput) => void - ): void; - public importApiKeys( + importApiKeys(args: ImportApiKeysCommandInput, options?: __HttpHandlerOptions): Promise; + importApiKeys(args: ImportApiKeysCommandInput, cb: (err: any, data?: ImportApiKeysCommandOutput) => void): void; + importApiKeys( args: ImportApiKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportApiKeysCommandOutput) => void ): void; - public importApiKeys( - args: ImportApiKeysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportApiKeysCommandOutput) => void), - cb?: (err: any, data?: ImportApiKeysCommandOutput) => void - ): Promise | void { - const command = new ImportApiKeysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Imports documentation parts

+ * @see {@link ImportDocumentationPartsCommand} */ - public importDocumentationParts( + importDocumentationParts( args: ImportDocumentationPartsCommandInput, options?: __HttpHandlerOptions ): Promise; - public importDocumentationParts( + importDocumentationParts( args: ImportDocumentationPartsCommandInput, cb: (err: any, data?: ImportDocumentationPartsCommandOutput) => void ): void; - public importDocumentationParts( + importDocumentationParts( args: ImportDocumentationPartsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportDocumentationPartsCommandOutput) => void ): void; - public importDocumentationParts( - args: ImportDocumentationPartsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportDocumentationPartsCommandOutput) => void), - cb?: (err: any, data?: ImportDocumentationPartsCommandOutput) => void - ): Promise | void { - const command = new ImportDocumentationPartsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A feature of the API Gateway control service for creating a new API from an external API definition file.

+ * @see {@link ImportRestApiCommand} */ - public importRestApi( - args: ImportRestApiCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public importRestApi( - args: ImportRestApiCommandInput, - cb: (err: any, data?: ImportRestApiCommandOutput) => void - ): void; - public importRestApi( + importRestApi(args: ImportRestApiCommandInput, options?: __HttpHandlerOptions): Promise; + importRestApi(args: ImportRestApiCommandInput, cb: (err: any, data?: ImportRestApiCommandOutput) => void): void; + importRestApi( args: ImportRestApiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportRestApiCommandOutput) => void ): void; - public importRestApi( - args: ImportRestApiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportRestApiCommandOutput) => void), - cb?: (err: any, data?: ImportRestApiCommandOutput) => void - ): Promise | void { - const command = new ImportRestApiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

+ * @see {@link PutGatewayResponseCommand} */ - public putGatewayResponse( + putGatewayResponse( args: PutGatewayResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public putGatewayResponse( + putGatewayResponse( args: PutGatewayResponseCommandInput, cb: (err: any, data?: PutGatewayResponseCommandOutput) => void ): void; - public putGatewayResponse( + putGatewayResponse( args: PutGatewayResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutGatewayResponseCommandOutput) => void ): void; - public putGatewayResponse( - args: PutGatewayResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutGatewayResponseCommandOutput) => void), - cb?: (err: any, data?: PutGatewayResponseCommandOutput) => void - ): Promise | void { - const command = new PutGatewayResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets up a method's integration.

+ * @see {@link PutIntegrationCommand} */ - public putIntegration( + putIntegration( args: PutIntegrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putIntegration( - args: PutIntegrationCommandInput, - cb: (err: any, data?: PutIntegrationCommandOutput) => void - ): void; - public putIntegration( + putIntegration(args: PutIntegrationCommandInput, cb: (err: any, data?: PutIntegrationCommandOutput) => void): void; + putIntegration( args: PutIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutIntegrationCommandOutput) => void ): void; - public putIntegration( - args: PutIntegrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutIntegrationCommandOutput) => void), - cb?: (err: any, data?: PutIntegrationCommandOutput) => void - ): Promise | void { - const command = new PutIntegrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Represents a put integration.

+ * @see {@link PutIntegrationResponseCommand} */ - public putIntegrationResponse( + putIntegrationResponse( args: PutIntegrationResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public putIntegrationResponse( + putIntegrationResponse( args: PutIntegrationResponseCommandInput, cb: (err: any, data?: PutIntegrationResponseCommandOutput) => void ): void; - public putIntegrationResponse( + putIntegrationResponse( args: PutIntegrationResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutIntegrationResponseCommandOutput) => void ): void; - public putIntegrationResponse( - args: PutIntegrationResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutIntegrationResponseCommandOutput) => void), - cb?: (err: any, data?: PutIntegrationResponseCommandOutput) => void - ): Promise | void { - const command = new PutIntegrationResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Add a method to an existing Resource resource.

+ * @see {@link PutMethodCommand} */ - public putMethod(args: PutMethodCommandInput, options?: __HttpHandlerOptions): Promise; - public putMethod(args: PutMethodCommandInput, cb: (err: any, data?: PutMethodCommandOutput) => void): void; - public putMethod( + putMethod(args: PutMethodCommandInput, options?: __HttpHandlerOptions): Promise; + putMethod(args: PutMethodCommandInput, cb: (err: any, data?: PutMethodCommandOutput) => void): void; + putMethod( args: PutMethodCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMethodCommandOutput) => void ): void; - public putMethod( - args: PutMethodCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutMethodCommandOutput) => void), - cb?: (err: any, data?: PutMethodCommandOutput) => void - ): Promise | void { - const command = new PutMethodCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a MethodResponse to an existing Method resource.

+ * @see {@link PutMethodResponseCommand} */ - public putMethodResponse( + putMethodResponse( args: PutMethodResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public putMethodResponse( + putMethodResponse( args: PutMethodResponseCommandInput, cb: (err: any, data?: PutMethodResponseCommandOutput) => void ): void; - public putMethodResponse( + putMethodResponse( args: PutMethodResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMethodResponseCommandOutput) => void ): void; - public putMethodResponse( - args: PutMethodResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutMethodResponseCommandOutput) => void), - cb?: (err: any, data?: PutMethodResponseCommandOutput) => void - ): Promise | void { - const command = new PutMethodResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A feature of the API Gateway control service for updating an existing API with an input of external API definitions. - * The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.

+ * @see {@link PutRestApiCommand} */ - public putRestApi(args: PutRestApiCommandInput, options?: __HttpHandlerOptions): Promise; - public putRestApi(args: PutRestApiCommandInput, cb: (err: any, data?: PutRestApiCommandOutput) => void): void; - public putRestApi( + putRestApi(args: PutRestApiCommandInput, options?: __HttpHandlerOptions): Promise; + putRestApi(args: PutRestApiCommandInput, cb: (err: any, data?: PutRestApiCommandOutput) => void): void; + putRestApi( args: PutRestApiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRestApiCommandOutput) => void ): void; - public putRestApi( - args: PutRestApiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRestApiCommandOutput) => void), - cb?: (err: any, data?: PutRestApiCommandOutput) => void - ): Promise | void { - const command = new PutRestApiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or updates a tag on a given resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.

+ * @see {@link TestInvokeAuthorizerCommand} */ - public testInvokeAuthorizer( + testInvokeAuthorizer( args: TestInvokeAuthorizerCommandInput, options?: __HttpHandlerOptions ): Promise; - public testInvokeAuthorizer( + testInvokeAuthorizer( args: TestInvokeAuthorizerCommandInput, cb: (err: any, data?: TestInvokeAuthorizerCommandOutput) => void ): void; - public testInvokeAuthorizer( + testInvokeAuthorizer( args: TestInvokeAuthorizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestInvokeAuthorizerCommandOutput) => void ): void; - public testInvokeAuthorizer( - args: TestInvokeAuthorizerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestInvokeAuthorizerCommandOutput) => void), - cb?: (err: any, data?: TestInvokeAuthorizerCommandOutput) => void - ): Promise | void { - const command = new TestInvokeAuthorizerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.

+ * @see {@link TestInvokeMethodCommand} */ - public testInvokeMethod( + testInvokeMethod( args: TestInvokeMethodCommandInput, options?: __HttpHandlerOptions ): Promise; - public testInvokeMethod( + testInvokeMethod( args: TestInvokeMethodCommandInput, cb: (err: any, data?: TestInvokeMethodCommandOutput) => void ): void; - public testInvokeMethod( + testInvokeMethod( args: TestInvokeMethodCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestInvokeMethodCommandOutput) => void ): void; - public testInvokeMethod( - args: TestInvokeMethodCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestInvokeMethodCommandOutput) => void), - cb?: (err: any, data?: TestInvokeMethodCommandOutput) => void - ): Promise | void { - const command = new TestInvokeMethodCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a tag from a given resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes information about the current Account resource.

+ * @see {@link UpdateAccountCommand} */ - public updateAccount( - args: UpdateAccountCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateAccount( - args: UpdateAccountCommandInput, - cb: (err: any, data?: UpdateAccountCommandOutput) => void - ): void; - public updateAccount( + updateAccount(args: UpdateAccountCommandInput, options?: __HttpHandlerOptions): Promise; + updateAccount(args: UpdateAccountCommandInput, cb: (err: any, data?: UpdateAccountCommandOutput) => void): void; + updateAccount( args: UpdateAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccountCommandOutput) => void ): void; - public updateAccount( - args: UpdateAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAccountCommandOutput) => void), - cb?: (err: any, data?: UpdateAccountCommandOutput) => void - ): Promise | void { - const command = new UpdateAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes information about an ApiKey resource.

+ * @see {@link UpdateApiKeyCommand} */ - public updateApiKey( - args: UpdateApiKeyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateApiKey(args: UpdateApiKeyCommandInput, cb: (err: any, data?: UpdateApiKeyCommandOutput) => void): void; - public updateApiKey( + updateApiKey(args: UpdateApiKeyCommandInput, options?: __HttpHandlerOptions): Promise; + updateApiKey(args: UpdateApiKeyCommandInput, cb: (err: any, data?: UpdateApiKeyCommandOutput) => void): void; + updateApiKey( args: UpdateApiKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApiKeyCommandOutput) => void ): void; - public updateApiKey( - args: UpdateApiKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApiKeyCommandOutput) => void), - cb?: (err: any, data?: UpdateApiKeyCommandOutput) => void - ): Promise | void { - const command = new UpdateApiKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing Authorizer resource.

+ * @see {@link UpdateAuthorizerCommand} */ - public updateAuthorizer( + updateAuthorizer( args: UpdateAuthorizerCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAuthorizer( + updateAuthorizer( args: UpdateAuthorizerCommandInput, cb: (err: any, data?: UpdateAuthorizerCommandOutput) => void ): void; - public updateAuthorizer( + updateAuthorizer( args: UpdateAuthorizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAuthorizerCommandOutput) => void ): void; - public updateAuthorizer( - args: UpdateAuthorizerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAuthorizerCommandOutput) => void), - cb?: (err: any, data?: UpdateAuthorizerCommandOutput) => void - ): Promise | void { - const command = new UpdateAuthorizerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes information about the BasePathMapping resource.

+ * @see {@link UpdateBasePathMappingCommand} */ - public updateBasePathMapping( + updateBasePathMapping( args: UpdateBasePathMappingCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBasePathMapping( + updateBasePathMapping( args: UpdateBasePathMappingCommandInput, cb: (err: any, data?: UpdateBasePathMappingCommandOutput) => void ): void; - public updateBasePathMapping( + updateBasePathMapping( args: UpdateBasePathMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBasePathMappingCommandOutput) => void ): void; - public updateBasePathMapping( - args: UpdateBasePathMappingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBasePathMappingCommandOutput) => void), - cb?: (err: any, data?: UpdateBasePathMappingCommandOutput) => void - ): Promise | void { - const command = new UpdateBasePathMappingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes information about an ClientCertificate resource.

+ * @see {@link UpdateClientCertificateCommand} */ - public updateClientCertificate( + updateClientCertificate( args: UpdateClientCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateClientCertificate( + updateClientCertificate( args: UpdateClientCertificateCommandInput, cb: (err: any, data?: UpdateClientCertificateCommandOutput) => void ): void; - public updateClientCertificate( + updateClientCertificate( args: UpdateClientCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateClientCertificateCommandOutput) => void ): void; - public updateClientCertificate( - args: UpdateClientCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateClientCertificateCommandOutput) => void), - cb?: (err: any, data?: UpdateClientCertificateCommandOutput) => void - ): Promise | void { - const command = new UpdateClientCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes information about a Deployment resource.

+ * @see {@link UpdateDeploymentCommand} */ - public updateDeployment( + updateDeployment( args: UpdateDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDeployment( + updateDeployment( args: UpdateDeploymentCommandInput, cb: (err: any, data?: UpdateDeploymentCommandOutput) => void ): void; - public updateDeployment( + updateDeployment( args: UpdateDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDeploymentCommandOutput) => void ): void; - public updateDeployment( - args: UpdateDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDeploymentCommandOutput) => void), - cb?: (err: any, data?: UpdateDeploymentCommandOutput) => void - ): Promise | void { - const command = new UpdateDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a documentation part.

+ * @see {@link UpdateDocumentationPartCommand} */ - public updateDocumentationPart( + updateDocumentationPart( args: UpdateDocumentationPartCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDocumentationPart( + updateDocumentationPart( args: UpdateDocumentationPartCommandInput, cb: (err: any, data?: UpdateDocumentationPartCommandOutput) => void ): void; - public updateDocumentationPart( + updateDocumentationPart( args: UpdateDocumentationPartCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDocumentationPartCommandOutput) => void ): void; - public updateDocumentationPart( - args: UpdateDocumentationPartCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDocumentationPartCommandOutput) => void), - cb?: (err: any, data?: UpdateDocumentationPartCommandOutput) => void - ): Promise | void { - const command = new UpdateDocumentationPartCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a documentation version.

+ * @see {@link UpdateDocumentationVersionCommand} */ - public updateDocumentationVersion( + updateDocumentationVersion( args: UpdateDocumentationVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDocumentationVersion( + updateDocumentationVersion( args: UpdateDocumentationVersionCommandInput, cb: (err: any, data?: UpdateDocumentationVersionCommandOutput) => void ): void; - public updateDocumentationVersion( + updateDocumentationVersion( args: UpdateDocumentationVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDocumentationVersionCommandOutput) => void ): void; - public updateDocumentationVersion( - args: UpdateDocumentationVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDocumentationVersionCommandOutput) => void), - cb?: (err: any, data?: UpdateDocumentationVersionCommandOutput) => void - ): Promise | void { - const command = new UpdateDocumentationVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes information about the DomainName resource.

+ * @see {@link UpdateDomainNameCommand} */ - public updateDomainName( + updateDomainName( args: UpdateDomainNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDomainName( + updateDomainName( args: UpdateDomainNameCommandInput, cb: (err: any, data?: UpdateDomainNameCommandOutput) => void ): void; - public updateDomainName( + updateDomainName( args: UpdateDomainNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDomainNameCommandOutput) => void ): void; - public updateDomainName( - args: UpdateDomainNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDomainNameCommandOutput) => void), - cb?: (err: any, data?: UpdateDomainNameCommandOutput) => void - ): Promise | void { - const command = new UpdateDomainNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a GatewayResponse of a specified response type on the given RestApi.

+ * @see {@link UpdateGatewayResponseCommand} */ - public updateGatewayResponse( + updateGatewayResponse( args: UpdateGatewayResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGatewayResponse( + updateGatewayResponse( args: UpdateGatewayResponseCommandInput, cb: (err: any, data?: UpdateGatewayResponseCommandOutput) => void ): void; - public updateGatewayResponse( + updateGatewayResponse( args: UpdateGatewayResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGatewayResponseCommandOutput) => void ): void; - public updateGatewayResponse( - args: UpdateGatewayResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGatewayResponseCommandOutput) => void), - cb?: (err: any, data?: UpdateGatewayResponseCommandOutput) => void - ): Promise | void { - const command = new UpdateGatewayResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Represents an update integration.

+ * @see {@link UpdateIntegrationCommand} */ - public updateIntegration( + updateIntegration( args: UpdateIntegrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateIntegration( + updateIntegration( args: UpdateIntegrationCommandInput, cb: (err: any, data?: UpdateIntegrationCommandOutput) => void ): void; - public updateIntegration( + updateIntegration( args: UpdateIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIntegrationCommandOutput) => void ): void; - public updateIntegration( - args: UpdateIntegrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateIntegrationCommandOutput) => void), - cb?: (err: any, data?: UpdateIntegrationCommandOutput) => void - ): Promise | void { - const command = new UpdateIntegrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Represents an update integration response.

+ * @see {@link UpdateIntegrationResponseCommand} */ - public updateIntegrationResponse( + updateIntegrationResponse( args: UpdateIntegrationResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateIntegrationResponse( + updateIntegrationResponse( args: UpdateIntegrationResponseCommandInput, cb: (err: any, data?: UpdateIntegrationResponseCommandOutput) => void ): void; - public updateIntegrationResponse( + updateIntegrationResponse( args: UpdateIntegrationResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIntegrationResponseCommandOutput) => void ): void; - public updateIntegrationResponse( - args: UpdateIntegrationResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateIntegrationResponseCommandOutput) => void), - cb?: (err: any, data?: UpdateIntegrationResponseCommandOutput) => void - ): Promise | void { - const command = new UpdateIntegrationResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing Method resource.

+ * @see {@link UpdateMethodCommand} */ - public updateMethod( - args: UpdateMethodCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateMethod(args: UpdateMethodCommandInput, cb: (err: any, data?: UpdateMethodCommandOutput) => void): void; - public updateMethod( + updateMethod(args: UpdateMethodCommandInput, options?: __HttpHandlerOptions): Promise; + updateMethod(args: UpdateMethodCommandInput, cb: (err: any, data?: UpdateMethodCommandOutput) => void): void; + updateMethod( args: UpdateMethodCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMethodCommandOutput) => void ): void; - public updateMethod( - args: UpdateMethodCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMethodCommandOutput) => void), - cb?: (err: any, data?: UpdateMethodCommandOutput) => void - ): Promise | void { - const command = new UpdateMethodCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing MethodResponse resource.

+ * @see {@link UpdateMethodResponseCommand} */ - public updateMethodResponse( + updateMethodResponse( args: UpdateMethodResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMethodResponse( + updateMethodResponse( args: UpdateMethodResponseCommandInput, cb: (err: any, data?: UpdateMethodResponseCommandOutput) => void ): void; - public updateMethodResponse( + updateMethodResponse( args: UpdateMethodResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMethodResponseCommandOutput) => void ): void; - public updateMethodResponse( - args: UpdateMethodResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMethodResponseCommandOutput) => void), - cb?: (err: any, data?: UpdateMethodResponseCommandOutput) => void - ): Promise | void { - const command = new UpdateMethodResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes information about a model.

+ * @see {@link UpdateModelCommand} */ - public updateModel(args: UpdateModelCommandInput, options?: __HttpHandlerOptions): Promise; - public updateModel(args: UpdateModelCommandInput, cb: (err: any, data?: UpdateModelCommandOutput) => void): void; - public updateModel( + updateModel(args: UpdateModelCommandInput, options?: __HttpHandlerOptions): Promise; + updateModel(args: UpdateModelCommandInput, cb: (err: any, data?: UpdateModelCommandOutput) => void): void; + updateModel( args: UpdateModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateModelCommandOutput) => void ): void; - public updateModel( - args: UpdateModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateModelCommandOutput) => void), - cb?: (err: any, data?: UpdateModelCommandOutput) => void - ): Promise | void { - const command = new UpdateModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a RequestValidator of a given RestApi.

+ * @see {@link UpdateRequestValidatorCommand} */ - public updateRequestValidator( + updateRequestValidator( args: UpdateRequestValidatorCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRequestValidator( + updateRequestValidator( args: UpdateRequestValidatorCommandInput, cb: (err: any, data?: UpdateRequestValidatorCommandOutput) => void ): void; - public updateRequestValidator( + updateRequestValidator( args: UpdateRequestValidatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRequestValidatorCommandOutput) => void ): void; - public updateRequestValidator( - args: UpdateRequestValidatorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRequestValidatorCommandOutput) => void), - cb?: (err: any, data?: UpdateRequestValidatorCommandOutput) => void - ): Promise | void { - const command = new UpdateRequestValidatorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes information about a Resource resource.

+ * @see {@link UpdateResourceCommand} */ - public updateResource( + updateResource( args: UpdateResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateResource( - args: UpdateResourceCommandInput, - cb: (err: any, data?: UpdateResourceCommandOutput) => void - ): void; - public updateResource( + updateResource(args: UpdateResourceCommandInput, cb: (err: any, data?: UpdateResourceCommandOutput) => void): void; + updateResource( args: UpdateResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResourceCommandOutput) => void ): void; - public updateResource( - args: UpdateResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResourceCommandOutput) => void), - cb?: (err: any, data?: UpdateResourceCommandOutput) => void - ): Promise | void { - const command = new UpdateResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes information about the specified API.

+ * @see {@link UpdateRestApiCommand} */ - public updateRestApi( - args: UpdateRestApiCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateRestApi( - args: UpdateRestApiCommandInput, - cb: (err: any, data?: UpdateRestApiCommandOutput) => void - ): void; - public updateRestApi( + updateRestApi(args: UpdateRestApiCommandInput, options?: __HttpHandlerOptions): Promise; + updateRestApi(args: UpdateRestApiCommandInput, cb: (err: any, data?: UpdateRestApiCommandOutput) => void): void; + updateRestApi( args: UpdateRestApiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRestApiCommandOutput) => void ): void; - public updateRestApi( - args: UpdateRestApiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRestApiCommandOutput) => void), - cb?: (err: any, data?: UpdateRestApiCommandOutput) => void - ): Promise | void { - const command = new UpdateRestApiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes information about a Stage resource.

+ * @see {@link UpdateStageCommand} */ - public updateStage(args: UpdateStageCommandInput, options?: __HttpHandlerOptions): Promise; - public updateStage(args: UpdateStageCommandInput, cb: (err: any, data?: UpdateStageCommandOutput) => void): void; - public updateStage( + updateStage(args: UpdateStageCommandInput, options?: __HttpHandlerOptions): Promise; + updateStage(args: UpdateStageCommandInput, cb: (err: any, data?: UpdateStageCommandOutput) => void): void; + updateStage( args: UpdateStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStageCommandOutput) => void ): void; - public updateStage( - args: UpdateStageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStageCommandOutput) => void), - cb?: (err: any, data?: UpdateStageCommandOutput) => void - ): Promise | void { - const command = new UpdateStageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.

+ * @see {@link UpdateUsageCommand} */ - public updateUsage(args: UpdateUsageCommandInput, options?: __HttpHandlerOptions): Promise; - public updateUsage(args: UpdateUsageCommandInput, cb: (err: any, data?: UpdateUsageCommandOutput) => void): void; - public updateUsage( + updateUsage(args: UpdateUsageCommandInput, options?: __HttpHandlerOptions): Promise; + updateUsage(args: UpdateUsageCommandInput, cb: (err: any, data?: UpdateUsageCommandOutput) => void): void; + updateUsage( args: UpdateUsageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUsageCommandOutput) => void ): void; - public updateUsage( - args: UpdateUsageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUsageCommandOutput) => void), - cb?: (err: any, data?: UpdateUsageCommandOutput) => void - ): Promise | void { - const command = new UpdateUsageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a usage plan of a given plan Id.

+ * @see {@link UpdateUsagePlanCommand} */ - public updateUsagePlan( + updateUsagePlan( args: UpdateUsagePlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateUsagePlan( - args: UpdateUsagePlanCommandInput, - cb: (err: any, data?: UpdateUsagePlanCommandOutput) => void - ): void; - public updateUsagePlan( + updateUsagePlan(args: UpdateUsagePlanCommandInput, cb: (err: any, data?: UpdateUsagePlanCommandOutput) => void): void; + updateUsagePlan( args: UpdateUsagePlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUsagePlanCommandOutput) => void ): void; - public updateUsagePlan( - args: UpdateUsagePlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUsagePlanCommandOutput) => void), - cb?: (err: any, data?: UpdateUsagePlanCommandOutput) => void - ): Promise | void { - const command = new UpdateUsagePlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing VpcLink of a specified identifier.

+ * @see {@link UpdateVpcLinkCommand} */ - public updateVpcLink( - args: UpdateVpcLinkCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateVpcLink( - args: UpdateVpcLinkCommandInput, - cb: (err: any, data?: UpdateVpcLinkCommandOutput) => void - ): void; - public updateVpcLink( + updateVpcLink(args: UpdateVpcLinkCommandInput, options?: __HttpHandlerOptions): Promise; + updateVpcLink(args: UpdateVpcLinkCommandInput, cb: (err: any, data?: UpdateVpcLinkCommandOutput) => void): void; + updateVpcLink( args: UpdateVpcLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVpcLinkCommandOutput) => void ): void; - public updateVpcLink( - args: UpdateVpcLinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVpcLinkCommandOutput) => void), - cb?: (err: any, data?: UpdateVpcLinkCommandOutput) => void - ): Promise | void { - const command = new UpdateVpcLinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon API Gateway + *

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

+ */ +export class APIGateway extends APIGatewayClient implements APIGateway {} +createAggregatedClient(commands, APIGateway); diff --git a/clients/client-apigatewaymanagementapi/src/ApiGatewayManagementApi.ts b/clients/client-apigatewaymanagementapi/src/ApiGatewayManagementApi.ts index 609ac4bb37cd..455c372459a2 100644 --- a/clients/client-apigatewaymanagementapi/src/ApiGatewayManagementApi.ts +++ b/clients/client-apigatewaymanagementapi/src/ApiGatewayManagementApi.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { ApiGatewayManagementApiClient } from "./ApiGatewayManagementApiClient"; +import { ApiGatewayManagementApiClient, ApiGatewayManagementApiClientConfig } from "./ApiGatewayManagementApiClient"; import { DeleteConnectionCommand, DeleteConnectionCommandInput, @@ -18,107 +19,62 @@ import { PostToConnectionCommandOutput, } from "./commands/PostToConnectionCommand"; -/** - * @public - *

The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://\{api-id\}.execute-api.\{region\}.amazonaws.com/\{stage\}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.

- */ -export class ApiGatewayManagementApi extends ApiGatewayManagementApiClient { +const commands = { + DeleteConnectionCommand, + GetConnectionCommand, + PostToConnectionCommand, +}; + +export interface ApiGatewayManagementApi { /** - * @public - *

Delete the connection with the provided id.

+ * @see {@link DeleteConnectionCommand} */ - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, cb: (err: any, data?: DeleteConnectionCommandOutput) => void ): void; - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectionCommandOutput) => void ): void; - public deleteConnection( - args: DeleteConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConnectionCommandOutput) => void), - cb?: (err: any, data?: DeleteConnectionCommandOutput) => void - ): Promise | void { - const command = new DeleteConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get information about the connection with the provided id.

+ * @see {@link GetConnectionCommand} */ - public getConnection( - args: GetConnectionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getConnection( - args: GetConnectionCommandInput, - cb: (err: any, data?: GetConnectionCommandOutput) => void - ): void; - public getConnection( + getConnection(args: GetConnectionCommandInput, options?: __HttpHandlerOptions): Promise; + getConnection(args: GetConnectionCommandInput, cb: (err: any, data?: GetConnectionCommandOutput) => void): void; + getConnection( args: GetConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConnectionCommandOutput) => void ): void; - public getConnection( - args: GetConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConnectionCommandOutput) => void), - cb?: (err: any, data?: GetConnectionCommandOutput) => void - ): Promise | void { - const command = new GetConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sends the provided data to the specified connection.

+ * @see {@link PostToConnectionCommand} */ - public postToConnection( + postToConnection( args: PostToConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public postToConnection( + postToConnection( args: PostToConnectionCommandInput, cb: (err: any, data?: PostToConnectionCommandOutput) => void ): void; - public postToConnection( + postToConnection( args: PostToConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PostToConnectionCommandOutput) => void ): void; - public postToConnection( - args: PostToConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PostToConnectionCommandOutput) => void), - cb?: (err: any, data?: PostToConnectionCommandOutput) => void - ): Promise | void { - const command = new PostToConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://\{api-id\}.execute-api.\{region\}.amazonaws.com/\{stage\}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.

+ */ +export class ApiGatewayManagementApi extends ApiGatewayManagementApiClient implements ApiGatewayManagementApi {} +createAggregatedClient(commands, ApiGatewayManagementApi); diff --git a/clients/client-apigatewayv2/src/ApiGatewayV2.ts b/clients/client-apigatewayv2/src/ApiGatewayV2.ts index 0710a6046f8f..275257951d09 100644 --- a/clients/client-apigatewayv2/src/ApiGatewayV2.ts +++ b/clients/client-apigatewayv2/src/ApiGatewayV2.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { ApiGatewayV2Client } from "./ApiGatewayV2Client"; +import { ApiGatewayV2Client, ApiGatewayV2ClientConfig } from "./ApiGatewayV2Client"; import { CreateApiCommand, CreateApiCommandInput, CreateApiCommandOutput } from "./commands/CreateApiCommand"; import { CreateApiMappingCommand, @@ -255,2221 +256,1082 @@ import { UpdateVpcLinkCommandOutput, } from "./commands/UpdateVpcLinkCommand"; -/** - * @public - *

Amazon API Gateway V2

- */ -export class ApiGatewayV2 extends ApiGatewayV2Client { +const commands = { + CreateApiCommand, + CreateApiMappingCommand, + CreateAuthorizerCommand, + CreateDeploymentCommand, + CreateDomainNameCommand, + CreateIntegrationCommand, + CreateIntegrationResponseCommand, + CreateModelCommand, + CreateRouteCommand, + CreateRouteResponseCommand, + CreateStageCommand, + CreateVpcLinkCommand, + DeleteAccessLogSettingsCommand, + DeleteApiCommand, + DeleteApiMappingCommand, + DeleteAuthorizerCommand, + DeleteCorsConfigurationCommand, + DeleteDeploymentCommand, + DeleteDomainNameCommand, + DeleteIntegrationCommand, + DeleteIntegrationResponseCommand, + DeleteModelCommand, + DeleteRouteCommand, + DeleteRouteRequestParameterCommand, + DeleteRouteResponseCommand, + DeleteRouteSettingsCommand, + DeleteStageCommand, + DeleteVpcLinkCommand, + ExportApiCommand, + GetApiCommand, + GetApiMappingCommand, + GetApiMappingsCommand, + GetApisCommand, + GetAuthorizerCommand, + GetAuthorizersCommand, + GetDeploymentCommand, + GetDeploymentsCommand, + GetDomainNameCommand, + GetDomainNamesCommand, + GetIntegrationCommand, + GetIntegrationResponseCommand, + GetIntegrationResponsesCommand, + GetIntegrationsCommand, + GetModelCommand, + GetModelsCommand, + GetModelTemplateCommand, + GetRouteCommand, + GetRouteResponseCommand, + GetRouteResponsesCommand, + GetRoutesCommand, + GetStageCommand, + GetStagesCommand, + GetTagsCommand, + GetVpcLinkCommand, + GetVpcLinksCommand, + ImportApiCommand, + ReimportApiCommand, + ResetAuthorizersCacheCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateApiCommand, + UpdateApiMappingCommand, + UpdateAuthorizerCommand, + UpdateDeploymentCommand, + UpdateDomainNameCommand, + UpdateIntegrationCommand, + UpdateIntegrationResponseCommand, + UpdateModelCommand, + UpdateRouteCommand, + UpdateRouteResponseCommand, + UpdateStageCommand, + UpdateVpcLinkCommand, +}; + +export interface ApiGatewayV2 { /** - * @public - *

Creates an Api resource.

+ * @see {@link CreateApiCommand} */ - public createApi(args: CreateApiCommandInput, options?: __HttpHandlerOptions): Promise; - public createApi(args: CreateApiCommandInput, cb: (err: any, data?: CreateApiCommandOutput) => void): void; - public createApi( + createApi(args: CreateApiCommandInput, options?: __HttpHandlerOptions): Promise; + createApi(args: CreateApiCommandInput, cb: (err: any, data?: CreateApiCommandOutput) => void): void; + createApi( args: CreateApiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApiCommandOutput) => void ): void; - public createApi( - args: CreateApiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApiCommandOutput) => void), - cb?: (err: any, data?: CreateApiCommandOutput) => void - ): Promise | void { - const command = new CreateApiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an API mapping.

- */ - public createApiMapping( + + /** + * @see {@link CreateApiMappingCommand} + */ + createApiMapping( args: CreateApiMappingCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApiMapping( + createApiMapping( args: CreateApiMappingCommandInput, cb: (err: any, data?: CreateApiMappingCommandOutput) => void ): void; - public createApiMapping( + createApiMapping( args: CreateApiMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApiMappingCommandOutput) => void ): void; - public createApiMapping( - args: CreateApiMappingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApiMappingCommandOutput) => void), - cb?: (err: any, data?: CreateApiMappingCommandOutput) => void - ): Promise | void { - const command = new CreateApiMappingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Authorizer for an API.

- */ - public createAuthorizer( + + /** + * @see {@link CreateAuthorizerCommand} + */ + createAuthorizer( args: CreateAuthorizerCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAuthorizer( + createAuthorizer( args: CreateAuthorizerCommandInput, cb: (err: any, data?: CreateAuthorizerCommandOutput) => void ): void; - public createAuthorizer( + createAuthorizer( args: CreateAuthorizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAuthorizerCommandOutput) => void ): void; - public createAuthorizer( - args: CreateAuthorizerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAuthorizerCommandOutput) => void), - cb?: (err: any, data?: CreateAuthorizerCommandOutput) => void - ): Promise | void { - const command = new CreateAuthorizerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Deployment for an API.

- */ - public createDeployment( + + /** + * @see {@link CreateDeploymentCommand} + */ + createDeployment( args: CreateDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDeployment( + createDeployment( args: CreateDeploymentCommandInput, cb: (err: any, data?: CreateDeploymentCommandOutput) => void ): void; - public createDeployment( + createDeployment( args: CreateDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeploymentCommandOutput) => void ): void; - public createDeployment( - args: CreateDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDeploymentCommandOutput) => void), - cb?: (err: any, data?: CreateDeploymentCommandOutput) => void - ): Promise | void { - const command = new CreateDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a domain name.

- */ - public createDomainName( + + /** + * @see {@link CreateDomainNameCommand} + */ + createDomainName( args: CreateDomainNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDomainName( + createDomainName( args: CreateDomainNameCommandInput, cb: (err: any, data?: CreateDomainNameCommandOutput) => void ): void; - public createDomainName( + createDomainName( args: CreateDomainNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDomainNameCommandOutput) => void ): void; - public createDomainName( - args: CreateDomainNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDomainNameCommandOutput) => void), - cb?: (err: any, data?: CreateDomainNameCommandOutput) => void - ): Promise | void { - const command = new CreateDomainNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Integration.

- */ - public createIntegration( + + /** + * @see {@link CreateIntegrationCommand} + */ + createIntegration( args: CreateIntegrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createIntegration( + createIntegration( args: CreateIntegrationCommandInput, cb: (err: any, data?: CreateIntegrationCommandOutput) => void ): void; - public createIntegration( + createIntegration( args: CreateIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIntegrationCommandOutput) => void ): void; - public createIntegration( - args: CreateIntegrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIntegrationCommandOutput) => void), - cb?: (err: any, data?: CreateIntegrationCommandOutput) => void - ): Promise | void { - const command = new CreateIntegrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an IntegrationResponses.

- */ - public createIntegrationResponse( + + /** + * @see {@link CreateIntegrationResponseCommand} + */ + createIntegrationResponse( args: CreateIntegrationResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public createIntegrationResponse( + createIntegrationResponse( args: CreateIntegrationResponseCommandInput, cb: (err: any, data?: CreateIntegrationResponseCommandOutput) => void ): void; - public createIntegrationResponse( + createIntegrationResponse( args: CreateIntegrationResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIntegrationResponseCommandOutput) => void ): void; - public createIntegrationResponse( - args: CreateIntegrationResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIntegrationResponseCommandOutput) => void), - cb?: (err: any, data?: CreateIntegrationResponseCommandOutput) => void - ): Promise | void { - const command = new CreateIntegrationResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Model for an API.

- */ - public createModel(args: CreateModelCommandInput, options?: __HttpHandlerOptions): Promise; - public createModel(args: CreateModelCommandInput, cb: (err: any, data?: CreateModelCommandOutput) => void): void; - public createModel( + + /** + * @see {@link CreateModelCommand} + */ + createModel(args: CreateModelCommandInput, options?: __HttpHandlerOptions): Promise; + createModel(args: CreateModelCommandInput, cb: (err: any, data?: CreateModelCommandOutput) => void): void; + createModel( args: CreateModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateModelCommandOutput) => void ): void; - public createModel( - args: CreateModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateModelCommandOutput) => void), - cb?: (err: any, data?: CreateModelCommandOutput) => void - ): Promise | void { - const command = new CreateModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Route for an API.

- */ - public createRoute(args: CreateRouteCommandInput, options?: __HttpHandlerOptions): Promise; - public createRoute(args: CreateRouteCommandInput, cb: (err: any, data?: CreateRouteCommandOutput) => void): void; - public createRoute( + + /** + * @see {@link CreateRouteCommand} + */ + createRoute(args: CreateRouteCommandInput, options?: __HttpHandlerOptions): Promise; + createRoute(args: CreateRouteCommandInput, cb: (err: any, data?: CreateRouteCommandOutput) => void): void; + createRoute( args: CreateRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRouteCommandOutput) => void ): void; - public createRoute( - args: CreateRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRouteCommandOutput) => void), - cb?: (err: any, data?: CreateRouteCommandOutput) => void - ): Promise | void { - const command = new CreateRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a RouteResponse for a Route.

- */ - public createRouteResponse( + + /** + * @see {@link CreateRouteResponseCommand} + */ + createRouteResponse( args: CreateRouteResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRouteResponse( + createRouteResponse( args: CreateRouteResponseCommandInput, cb: (err: any, data?: CreateRouteResponseCommandOutput) => void ): void; - public createRouteResponse( + createRouteResponse( args: CreateRouteResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRouteResponseCommandOutput) => void ): void; - public createRouteResponse( - args: CreateRouteResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRouteResponseCommandOutput) => void), - cb?: (err: any, data?: CreateRouteResponseCommandOutput) => void - ): Promise | void { - const command = new CreateRouteResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Stage for an API.

- */ - public createStage(args: CreateStageCommandInput, options?: __HttpHandlerOptions): Promise; - public createStage(args: CreateStageCommandInput, cb: (err: any, data?: CreateStageCommandOutput) => void): void; - public createStage( + + /** + * @see {@link CreateStageCommand} + */ + createStage(args: CreateStageCommandInput, options?: __HttpHandlerOptions): Promise; + createStage(args: CreateStageCommandInput, cb: (err: any, data?: CreateStageCommandOutput) => void): void; + createStage( args: CreateStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStageCommandOutput) => void ): void; - public createStage( - args: CreateStageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStageCommandOutput) => void), - cb?: (err: any, data?: CreateStageCommandOutput) => void - ): Promise | void { - const command = new CreateStageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a VPC link.

- */ - public createVpcLink( - args: CreateVpcLinkCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createVpcLink( - args: CreateVpcLinkCommandInput, - cb: (err: any, data?: CreateVpcLinkCommandOutput) => void - ): void; - public createVpcLink( + + /** + * @see {@link CreateVpcLinkCommand} + */ + createVpcLink(args: CreateVpcLinkCommandInput, options?: __HttpHandlerOptions): Promise; + createVpcLink(args: CreateVpcLinkCommandInput, cb: (err: any, data?: CreateVpcLinkCommandOutput) => void): void; + createVpcLink( args: CreateVpcLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVpcLinkCommandOutput) => void ): void; - public createVpcLink( - args: CreateVpcLinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVpcLinkCommandOutput) => void), - cb?: (err: any, data?: CreateVpcLinkCommandOutput) => void - ): Promise | void { - const command = new CreateVpcLinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.

- */ - public deleteAccessLogSettings( + + /** + * @see {@link DeleteAccessLogSettingsCommand} + */ + deleteAccessLogSettings( args: DeleteAccessLogSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAccessLogSettings( + deleteAccessLogSettings( args: DeleteAccessLogSettingsCommandInput, cb: (err: any, data?: DeleteAccessLogSettingsCommandOutput) => void ): void; - public deleteAccessLogSettings( + deleteAccessLogSettings( args: DeleteAccessLogSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessLogSettingsCommandOutput) => void ): void; - public deleteAccessLogSettings( - args: DeleteAccessLogSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAccessLogSettingsCommandOutput) => void), - cb?: (err: any, data?: DeleteAccessLogSettingsCommandOutput) => void - ): Promise | void { - const command = new DeleteAccessLogSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an Api resource.

- */ - public deleteApi(args: DeleteApiCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteApi(args: DeleteApiCommandInput, cb: (err: any, data?: DeleteApiCommandOutput) => void): void; - public deleteApi( + + /** + * @see {@link DeleteApiCommand} + */ + deleteApi(args: DeleteApiCommandInput, options?: __HttpHandlerOptions): Promise; + deleteApi(args: DeleteApiCommandInput, cb: (err: any, data?: DeleteApiCommandOutput) => void): void; + deleteApi( args: DeleteApiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApiCommandOutput) => void ): void; - public deleteApi( - args: DeleteApiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApiCommandOutput) => void), - cb?: (err: any, data?: DeleteApiCommandOutput) => void - ): Promise | void { - const command = new DeleteApiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an API mapping.

- */ - public deleteApiMapping( + + /** + * @see {@link DeleteApiMappingCommand} + */ + deleteApiMapping( args: DeleteApiMappingCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApiMapping( + deleteApiMapping( args: DeleteApiMappingCommandInput, cb: (err: any, data?: DeleteApiMappingCommandOutput) => void ): void; - public deleteApiMapping( + deleteApiMapping( args: DeleteApiMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApiMappingCommandOutput) => void ): void; - public deleteApiMapping( - args: DeleteApiMappingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApiMappingCommandOutput) => void), - cb?: (err: any, data?: DeleteApiMappingCommandOutput) => void - ): Promise | void { - const command = new DeleteApiMappingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an Authorizer.

- */ - public deleteAuthorizer( + + /** + * @see {@link DeleteAuthorizerCommand} + */ + deleteAuthorizer( args: DeleteAuthorizerCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAuthorizer( + deleteAuthorizer( args: DeleteAuthorizerCommandInput, cb: (err: any, data?: DeleteAuthorizerCommandOutput) => void ): void; - public deleteAuthorizer( + deleteAuthorizer( args: DeleteAuthorizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAuthorizerCommandOutput) => void ): void; - public deleteAuthorizer( - args: DeleteAuthorizerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAuthorizerCommandOutput) => void), - cb?: (err: any, data?: DeleteAuthorizerCommandOutput) => void - ): Promise | void { - const command = new DeleteAuthorizerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a CORS configuration.

- */ - public deleteCorsConfiguration( + + /** + * @see {@link DeleteCorsConfigurationCommand} + */ + deleteCorsConfiguration( args: DeleteCorsConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCorsConfiguration( + deleteCorsConfiguration( args: DeleteCorsConfigurationCommandInput, cb: (err: any, data?: DeleteCorsConfigurationCommandOutput) => void ): void; - public deleteCorsConfiguration( + deleteCorsConfiguration( args: DeleteCorsConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCorsConfigurationCommandOutput) => void ): void; - public deleteCorsConfiguration( - args: DeleteCorsConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCorsConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteCorsConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteCorsConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a Deployment.

- */ - public deleteDeployment( + + /** + * @see {@link DeleteDeploymentCommand} + */ + deleteDeployment( args: DeleteDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDeployment( + deleteDeployment( args: DeleteDeploymentCommandInput, cb: (err: any, data?: DeleteDeploymentCommandOutput) => void ): void; - public deleteDeployment( + deleteDeployment( args: DeleteDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDeploymentCommandOutput) => void ): void; - public deleteDeployment( - args: DeleteDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDeploymentCommandOutput) => void), - cb?: (err: any, data?: DeleteDeploymentCommandOutput) => void - ): Promise | void { - const command = new DeleteDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a domain name.

- */ - public deleteDomainName( + + /** + * @see {@link DeleteDomainNameCommand} + */ + deleteDomainName( args: DeleteDomainNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDomainName( + deleteDomainName( args: DeleteDomainNameCommandInput, cb: (err: any, data?: DeleteDomainNameCommandOutput) => void ): void; - public deleteDomainName( + deleteDomainName( args: DeleteDomainNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDomainNameCommandOutput) => void ): void; - public deleteDomainName( - args: DeleteDomainNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDomainNameCommandOutput) => void), - cb?: (err: any, data?: DeleteDomainNameCommandOutput) => void - ): Promise | void { - const command = new DeleteDomainNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an Integration.

- */ - public deleteIntegration( + + /** + * @see {@link DeleteIntegrationCommand} + */ + deleteIntegration( args: DeleteIntegrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteIntegration( + deleteIntegration( args: DeleteIntegrationCommandInput, cb: (err: any, data?: DeleteIntegrationCommandOutput) => void ): void; - public deleteIntegration( + deleteIntegration( args: DeleteIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIntegrationCommandOutput) => void ): void; - public deleteIntegration( - args: DeleteIntegrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIntegrationCommandOutput) => void), - cb?: (err: any, data?: DeleteIntegrationCommandOutput) => void - ): Promise | void { - const command = new DeleteIntegrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an IntegrationResponses.

- */ - public deleteIntegrationResponse( + + /** + * @see {@link DeleteIntegrationResponseCommand} + */ + deleteIntegrationResponse( args: DeleteIntegrationResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteIntegrationResponse( + deleteIntegrationResponse( args: DeleteIntegrationResponseCommandInput, cb: (err: any, data?: DeleteIntegrationResponseCommandOutput) => void ): void; - public deleteIntegrationResponse( + deleteIntegrationResponse( args: DeleteIntegrationResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIntegrationResponseCommandOutput) => void ): void; - public deleteIntegrationResponse( - args: DeleteIntegrationResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIntegrationResponseCommandOutput) => void), - cb?: (err: any, data?: DeleteIntegrationResponseCommandOutput) => void - ): Promise | void { - const command = new DeleteIntegrationResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a Model.

- */ - public deleteModel(args: DeleteModelCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteModel(args: DeleteModelCommandInput, cb: (err: any, data?: DeleteModelCommandOutput) => void): void; - public deleteModel( + + /** + * @see {@link DeleteModelCommand} + */ + deleteModel(args: DeleteModelCommandInput, options?: __HttpHandlerOptions): Promise; + deleteModel(args: DeleteModelCommandInput, cb: (err: any, data?: DeleteModelCommandOutput) => void): void; + deleteModel( args: DeleteModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteModelCommandOutput) => void ): void; - public deleteModel( - args: DeleteModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteModelCommandOutput) => void), - cb?: (err: any, data?: DeleteModelCommandOutput) => void - ): Promise | void { - const command = new DeleteModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a Route.

- */ - public deleteRoute(args: DeleteRouteCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteRoute(args: DeleteRouteCommandInput, cb: (err: any, data?: DeleteRouteCommandOutput) => void): void; - public deleteRoute( + + /** + * @see {@link DeleteRouteCommand} + */ + deleteRoute(args: DeleteRouteCommandInput, options?: __HttpHandlerOptions): Promise; + deleteRoute(args: DeleteRouteCommandInput, cb: (err: any, data?: DeleteRouteCommandOutput) => void): void; + deleteRoute( args: DeleteRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRouteCommandOutput) => void ): void; - public deleteRoute( - args: DeleteRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRouteCommandOutput) => void), - cb?: (err: any, data?: DeleteRouteCommandOutput) => void - ): Promise | void { - const command = new DeleteRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a route request parameter.

- */ - public deleteRouteRequestParameter( + + /** + * @see {@link DeleteRouteRequestParameterCommand} + */ + deleteRouteRequestParameter( args: DeleteRouteRequestParameterCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRouteRequestParameter( + deleteRouteRequestParameter( args: DeleteRouteRequestParameterCommandInput, cb: (err: any, data?: DeleteRouteRequestParameterCommandOutput) => void ): void; - public deleteRouteRequestParameter( + deleteRouteRequestParameter( args: DeleteRouteRequestParameterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRouteRequestParameterCommandOutput) => void ): void; - public deleteRouteRequestParameter( - args: DeleteRouteRequestParameterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRouteRequestParameterCommandOutput) => void), - cb?: (err: any, data?: DeleteRouteRequestParameterCommandOutput) => void - ): Promise | void { - const command = new DeleteRouteRequestParameterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a RouteResponse.

- */ - public deleteRouteResponse( + + /** + * @see {@link DeleteRouteResponseCommand} + */ + deleteRouteResponse( args: DeleteRouteResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRouteResponse( + deleteRouteResponse( args: DeleteRouteResponseCommandInput, cb: (err: any, data?: DeleteRouteResponseCommandOutput) => void ): void; - public deleteRouteResponse( + deleteRouteResponse( args: DeleteRouteResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRouteResponseCommandOutput) => void ): void; - public deleteRouteResponse( - args: DeleteRouteResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRouteResponseCommandOutput) => void), - cb?: (err: any, data?: DeleteRouteResponseCommandOutput) => void - ): Promise | void { - const command = new DeleteRouteResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the RouteSettings for a stage.

- */ - public deleteRouteSettings( + + /** + * @see {@link DeleteRouteSettingsCommand} + */ + deleteRouteSettings( args: DeleteRouteSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRouteSettings( + deleteRouteSettings( args: DeleteRouteSettingsCommandInput, cb: (err: any, data?: DeleteRouteSettingsCommandOutput) => void ): void; - public deleteRouteSettings( + deleteRouteSettings( args: DeleteRouteSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRouteSettingsCommandOutput) => void ): void; - public deleteRouteSettings( - args: DeleteRouteSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRouteSettingsCommandOutput) => void), - cb?: (err: any, data?: DeleteRouteSettingsCommandOutput) => void - ): Promise | void { - const command = new DeleteRouteSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a Stage.

- */ - public deleteStage(args: DeleteStageCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteStage(args: DeleteStageCommandInput, cb: (err: any, data?: DeleteStageCommandOutput) => void): void; - public deleteStage( + + /** + * @see {@link DeleteStageCommand} + */ + deleteStage(args: DeleteStageCommandInput, options?: __HttpHandlerOptions): Promise; + deleteStage(args: DeleteStageCommandInput, cb: (err: any, data?: DeleteStageCommandOutput) => void): void; + deleteStage( args: DeleteStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStageCommandOutput) => void ): void; - public deleteStage( - args: DeleteStageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStageCommandOutput) => void), - cb?: (err: any, data?: DeleteStageCommandOutput) => void - ): Promise | void { - const command = new DeleteStageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a VPC link.

- */ - public deleteVpcLink( - args: DeleteVpcLinkCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteVpcLink( - args: DeleteVpcLinkCommandInput, - cb: (err: any, data?: DeleteVpcLinkCommandOutput) => void - ): void; - public deleteVpcLink( + + /** + * @see {@link DeleteVpcLinkCommand} + */ + deleteVpcLink(args: DeleteVpcLinkCommandInput, options?: __HttpHandlerOptions): Promise; + deleteVpcLink(args: DeleteVpcLinkCommandInput, cb: (err: any, data?: DeleteVpcLinkCommandOutput) => void): void; + deleteVpcLink( args: DeleteVpcLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVpcLinkCommandOutput) => void ): void; - public deleteVpcLink( - args: DeleteVpcLinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVpcLinkCommandOutput) => void), - cb?: (err: any, data?: DeleteVpcLinkCommandOutput) => void - ): Promise | void { - const command = new DeleteVpcLinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public exportApi(args: ExportApiCommandInput, options?: __HttpHandlerOptions): Promise; - public exportApi(args: ExportApiCommandInput, cb: (err: any, data?: ExportApiCommandOutput) => void): void; - public exportApi( + + /** + * @see {@link ExportApiCommand} + */ + exportApi(args: ExportApiCommandInput, options?: __HttpHandlerOptions): Promise; + exportApi(args: ExportApiCommandInput, cb: (err: any, data?: ExportApiCommandOutput) => void): void; + exportApi( args: ExportApiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportApiCommandOutput) => void ): void; - public exportApi( - args: ExportApiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportApiCommandOutput) => void), - cb?: (err: any, data?: ExportApiCommandOutput) => void - ): Promise | void { - const command = new ExportApiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets an Api resource.

- */ - public getApi(args: GetApiCommandInput, options?: __HttpHandlerOptions): Promise; - public getApi(args: GetApiCommandInput, cb: (err: any, data?: GetApiCommandOutput) => void): void; - public getApi( + + /** + * @see {@link GetApiCommand} + */ + getApi(args: GetApiCommandInput, options?: __HttpHandlerOptions): Promise; + getApi(args: GetApiCommandInput, cb: (err: any, data?: GetApiCommandOutput) => void): void; + getApi( args: GetApiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApiCommandOutput) => void ): void; - public getApi( - args: GetApiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApiCommandOutput) => void), - cb?: (err: any, data?: GetApiCommandOutput) => void - ): Promise | void { - const command = new GetApiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets an API mapping.

- */ - public getApiMapping( - args: GetApiMappingCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getApiMapping( - args: GetApiMappingCommandInput, - cb: (err: any, data?: GetApiMappingCommandOutput) => void - ): void; - public getApiMapping( + + /** + * @see {@link GetApiMappingCommand} + */ + getApiMapping(args: GetApiMappingCommandInput, options?: __HttpHandlerOptions): Promise; + getApiMapping(args: GetApiMappingCommandInput, cb: (err: any, data?: GetApiMappingCommandOutput) => void): void; + getApiMapping( args: GetApiMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApiMappingCommandOutput) => void ): void; - public getApiMapping( - args: GetApiMappingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApiMappingCommandOutput) => void), - cb?: (err: any, data?: GetApiMappingCommandOutput) => void - ): Promise | void { - const command = new GetApiMappingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets API mappings.

- */ - public getApiMappings( + + /** + * @see {@link GetApiMappingsCommand} + */ + getApiMappings( args: GetApiMappingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getApiMappings( - args: GetApiMappingsCommandInput, - cb: (err: any, data?: GetApiMappingsCommandOutput) => void - ): void; - public getApiMappings( + getApiMappings(args: GetApiMappingsCommandInput, cb: (err: any, data?: GetApiMappingsCommandOutput) => void): void; + getApiMappings( args: GetApiMappingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApiMappingsCommandOutput) => void ): void; - public getApiMappings( - args: GetApiMappingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApiMappingsCommandOutput) => void), - cb?: (err: any, data?: GetApiMappingsCommandOutput) => void - ): Promise | void { - const command = new GetApiMappingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a collection of Api resources.

- */ - public getApis(args: GetApisCommandInput, options?: __HttpHandlerOptions): Promise; - public getApis(args: GetApisCommandInput, cb: (err: any, data?: GetApisCommandOutput) => void): void; - public getApis( + + /** + * @see {@link GetApisCommand} + */ + getApis(args: GetApisCommandInput, options?: __HttpHandlerOptions): Promise; + getApis(args: GetApisCommandInput, cb: (err: any, data?: GetApisCommandOutput) => void): void; + getApis( args: GetApisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApisCommandOutput) => void ): void; - public getApis( - args: GetApisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApisCommandOutput) => void), - cb?: (err: any, data?: GetApisCommandOutput) => void - ): Promise | void { - const command = new GetApisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets an Authorizer.

- */ - public getAuthorizer( - args: GetAuthorizerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getAuthorizer( - args: GetAuthorizerCommandInput, - cb: (err: any, data?: GetAuthorizerCommandOutput) => void - ): void; - public getAuthorizer( + + /** + * @see {@link GetAuthorizerCommand} + */ + getAuthorizer(args: GetAuthorizerCommandInput, options?: __HttpHandlerOptions): Promise; + getAuthorizer(args: GetAuthorizerCommandInput, cb: (err: any, data?: GetAuthorizerCommandOutput) => void): void; + getAuthorizer( args: GetAuthorizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAuthorizerCommandOutput) => void ): void; - public getAuthorizer( - args: GetAuthorizerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAuthorizerCommandOutput) => void), - cb?: (err: any, data?: GetAuthorizerCommandOutput) => void - ): Promise | void { - const command = new GetAuthorizerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the Authorizers for an API.

- */ - public getAuthorizers( + + /** + * @see {@link GetAuthorizersCommand} + */ + getAuthorizers( args: GetAuthorizersCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAuthorizers( - args: GetAuthorizersCommandInput, - cb: (err: any, data?: GetAuthorizersCommandOutput) => void - ): void; - public getAuthorizers( + getAuthorizers(args: GetAuthorizersCommandInput, cb: (err: any, data?: GetAuthorizersCommandOutput) => void): void; + getAuthorizers( args: GetAuthorizersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAuthorizersCommandOutput) => void ): void; - public getAuthorizers( - args: GetAuthorizersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAuthorizersCommandOutput) => void), - cb?: (err: any, data?: GetAuthorizersCommandOutput) => void - ): Promise | void { - const command = new GetAuthorizersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a Deployment.

- */ - public getDeployment( - args: GetDeploymentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getDeployment( - args: GetDeploymentCommandInput, - cb: (err: any, data?: GetDeploymentCommandOutput) => void - ): void; - public getDeployment( + + /** + * @see {@link GetDeploymentCommand} + */ + getDeployment(args: GetDeploymentCommandInput, options?: __HttpHandlerOptions): Promise; + getDeployment(args: GetDeploymentCommandInput, cb: (err: any, data?: GetDeploymentCommandOutput) => void): void; + getDeployment( args: GetDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeploymentCommandOutput) => void ): void; - public getDeployment( - args: GetDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeploymentCommandOutput) => void), - cb?: (err: any, data?: GetDeploymentCommandOutput) => void - ): Promise | void { - const command = new GetDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the Deployments for an API.

- */ - public getDeployments( + + /** + * @see {@link GetDeploymentsCommand} + */ + getDeployments( args: GetDeploymentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDeployments( - args: GetDeploymentsCommandInput, - cb: (err: any, data?: GetDeploymentsCommandOutput) => void - ): void; - public getDeployments( + getDeployments(args: GetDeploymentsCommandInput, cb: (err: any, data?: GetDeploymentsCommandOutput) => void): void; + getDeployments( args: GetDeploymentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeploymentsCommandOutput) => void ): void; - public getDeployments( - args: GetDeploymentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeploymentsCommandOutput) => void), - cb?: (err: any, data?: GetDeploymentsCommandOutput) => void - ): Promise | void { - const command = new GetDeploymentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a domain name.

- */ - public getDomainName( - args: GetDomainNameCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getDomainName( - args: GetDomainNameCommandInput, - cb: (err: any, data?: GetDomainNameCommandOutput) => void - ): void; - public getDomainName( + + /** + * @see {@link GetDomainNameCommand} + */ + getDomainName(args: GetDomainNameCommandInput, options?: __HttpHandlerOptions): Promise; + getDomainName(args: GetDomainNameCommandInput, cb: (err: any, data?: GetDomainNameCommandOutput) => void): void; + getDomainName( args: GetDomainNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDomainNameCommandOutput) => void ): void; - public getDomainName( - args: GetDomainNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDomainNameCommandOutput) => void), - cb?: (err: any, data?: GetDomainNameCommandOutput) => void - ): Promise | void { - const command = new GetDomainNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the domain names for an AWS account.

- */ - public getDomainNames( + + /** + * @see {@link GetDomainNamesCommand} + */ + getDomainNames( args: GetDomainNamesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDomainNames( - args: GetDomainNamesCommandInput, - cb: (err: any, data?: GetDomainNamesCommandOutput) => void - ): void; - public getDomainNames( + getDomainNames(args: GetDomainNamesCommandInput, cb: (err: any, data?: GetDomainNamesCommandOutput) => void): void; + getDomainNames( args: GetDomainNamesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDomainNamesCommandOutput) => void ): void; - public getDomainNames( - args: GetDomainNamesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDomainNamesCommandOutput) => void), - cb?: (err: any, data?: GetDomainNamesCommandOutput) => void - ): Promise | void { - const command = new GetDomainNamesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets an Integration.

- */ - public getIntegration( + + /** + * @see {@link GetIntegrationCommand} + */ + getIntegration( args: GetIntegrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIntegration( - args: GetIntegrationCommandInput, - cb: (err: any, data?: GetIntegrationCommandOutput) => void - ): void; - public getIntegration( + getIntegration(args: GetIntegrationCommandInput, cb: (err: any, data?: GetIntegrationCommandOutput) => void): void; + getIntegration( args: GetIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIntegrationCommandOutput) => void ): void; - public getIntegration( - args: GetIntegrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIntegrationCommandOutput) => void), - cb?: (err: any, data?: GetIntegrationCommandOutput) => void - ): Promise | void { - const command = new GetIntegrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets an IntegrationResponses.

- */ - public getIntegrationResponse( + + /** + * @see {@link GetIntegrationResponseCommand} + */ + getIntegrationResponse( args: GetIntegrationResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIntegrationResponse( + getIntegrationResponse( args: GetIntegrationResponseCommandInput, cb: (err: any, data?: GetIntegrationResponseCommandOutput) => void ): void; - public getIntegrationResponse( + getIntegrationResponse( args: GetIntegrationResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIntegrationResponseCommandOutput) => void ): void; - public getIntegrationResponse( - args: GetIntegrationResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIntegrationResponseCommandOutput) => void), - cb?: (err: any, data?: GetIntegrationResponseCommandOutput) => void - ): Promise | void { - const command = new GetIntegrationResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the IntegrationResponses for an Integration.

- */ - public getIntegrationResponses( + + /** + * @see {@link GetIntegrationResponsesCommand} + */ + getIntegrationResponses( args: GetIntegrationResponsesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIntegrationResponses( + getIntegrationResponses( args: GetIntegrationResponsesCommandInput, cb: (err: any, data?: GetIntegrationResponsesCommandOutput) => void ): void; - public getIntegrationResponses( + getIntegrationResponses( args: GetIntegrationResponsesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIntegrationResponsesCommandOutput) => void ): void; - public getIntegrationResponses( - args: GetIntegrationResponsesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIntegrationResponsesCommandOutput) => void), - cb?: (err: any, data?: GetIntegrationResponsesCommandOutput) => void - ): Promise | void { - const command = new GetIntegrationResponsesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the Integrations for an API.

- */ - public getIntegrations( + + /** + * @see {@link GetIntegrationsCommand} + */ + getIntegrations( args: GetIntegrationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIntegrations( - args: GetIntegrationsCommandInput, - cb: (err: any, data?: GetIntegrationsCommandOutput) => void - ): void; - public getIntegrations( + getIntegrations(args: GetIntegrationsCommandInput, cb: (err: any, data?: GetIntegrationsCommandOutput) => void): void; + getIntegrations( args: GetIntegrationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIntegrationsCommandOutput) => void ): void; - public getIntegrations( - args: GetIntegrationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIntegrationsCommandOutput) => void), - cb?: (err: any, data?: GetIntegrationsCommandOutput) => void - ): Promise | void { - const command = new GetIntegrationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a Model.

- */ - public getModel(args: GetModelCommandInput, options?: __HttpHandlerOptions): Promise; - public getModel(args: GetModelCommandInput, cb: (err: any, data?: GetModelCommandOutput) => void): void; - public getModel( + + /** + * @see {@link GetModelCommand} + */ + getModel(args: GetModelCommandInput, options?: __HttpHandlerOptions): Promise; + getModel(args: GetModelCommandInput, cb: (err: any, data?: GetModelCommandOutput) => void): void; + getModel( args: GetModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetModelCommandOutput) => void ): void; - public getModel( - args: GetModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetModelCommandOutput) => void), - cb?: (err: any, data?: GetModelCommandOutput) => void - ): Promise | void { - const command = new GetModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the Models for an API.

- */ - public getModels(args: GetModelsCommandInput, options?: __HttpHandlerOptions): Promise; - public getModels(args: GetModelsCommandInput, cb: (err: any, data?: GetModelsCommandOutput) => void): void; - public getModels( + + /** + * @see {@link GetModelsCommand} + */ + getModels(args: GetModelsCommandInput, options?: __HttpHandlerOptions): Promise; + getModels(args: GetModelsCommandInput, cb: (err: any, data?: GetModelsCommandOutput) => void): void; + getModels( args: GetModelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetModelsCommandOutput) => void ): void; - public getModels( - args: GetModelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetModelsCommandOutput) => void), - cb?: (err: any, data?: GetModelsCommandOutput) => void - ): Promise | void { - const command = new GetModelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a model template.

- */ - public getModelTemplate( + + /** + * @see {@link GetModelTemplateCommand} + */ + getModelTemplate( args: GetModelTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getModelTemplate( + getModelTemplate( args: GetModelTemplateCommandInput, cb: (err: any, data?: GetModelTemplateCommandOutput) => void ): void; - public getModelTemplate( + getModelTemplate( args: GetModelTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetModelTemplateCommandOutput) => void ): void; - public getModelTemplate( - args: GetModelTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetModelTemplateCommandOutput) => void), - cb?: (err: any, data?: GetModelTemplateCommandOutput) => void - ): Promise | void { - const command = new GetModelTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a Route.

- */ - public getRoute(args: GetRouteCommandInput, options?: __HttpHandlerOptions): Promise; - public getRoute(args: GetRouteCommandInput, cb: (err: any, data?: GetRouteCommandOutput) => void): void; - public getRoute( + + /** + * @see {@link GetRouteCommand} + */ + getRoute(args: GetRouteCommandInput, options?: __HttpHandlerOptions): Promise; + getRoute(args: GetRouteCommandInput, cb: (err: any, data?: GetRouteCommandOutput) => void): void; + getRoute( args: GetRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRouteCommandOutput) => void ): void; - public getRoute( - args: GetRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRouteCommandOutput) => void), - cb?: (err: any, data?: GetRouteCommandOutput) => void - ): Promise | void { - const command = new GetRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a RouteResponse.

- */ - public getRouteResponse( + + /** + * @see {@link GetRouteResponseCommand} + */ + getRouteResponse( args: GetRouteResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRouteResponse( + getRouteResponse( args: GetRouteResponseCommandInput, cb: (err: any, data?: GetRouteResponseCommandOutput) => void ): void; - public getRouteResponse( + getRouteResponse( args: GetRouteResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRouteResponseCommandOutput) => void ): void; - public getRouteResponse( - args: GetRouteResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRouteResponseCommandOutput) => void), - cb?: (err: any, data?: GetRouteResponseCommandOutput) => void - ): Promise | void { - const command = new GetRouteResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the RouteResponses for a Route.

- */ - public getRouteResponses( + + /** + * @see {@link GetRouteResponsesCommand} + */ + getRouteResponses( args: GetRouteResponsesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRouteResponses( + getRouteResponses( args: GetRouteResponsesCommandInput, cb: (err: any, data?: GetRouteResponsesCommandOutput) => void ): void; - public getRouteResponses( + getRouteResponses( args: GetRouteResponsesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRouteResponsesCommandOutput) => void ): void; - public getRouteResponses( - args: GetRouteResponsesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRouteResponsesCommandOutput) => void), - cb?: (err: any, data?: GetRouteResponsesCommandOutput) => void - ): Promise | void { - const command = new GetRouteResponsesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the Routes for an API.

- */ - public getRoutes(args: GetRoutesCommandInput, options?: __HttpHandlerOptions): Promise; - public getRoutes(args: GetRoutesCommandInput, cb: (err: any, data?: GetRoutesCommandOutput) => void): void; - public getRoutes( + + /** + * @see {@link GetRoutesCommand} + */ + getRoutes(args: GetRoutesCommandInput, options?: __HttpHandlerOptions): Promise; + getRoutes(args: GetRoutesCommandInput, cb: (err: any, data?: GetRoutesCommandOutput) => void): void; + getRoutes( args: GetRoutesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRoutesCommandOutput) => void ): void; - public getRoutes( - args: GetRoutesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRoutesCommandOutput) => void), - cb?: (err: any, data?: GetRoutesCommandOutput) => void - ): Promise | void { - const command = new GetRoutesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a Stage.

- */ - public getStage(args: GetStageCommandInput, options?: __HttpHandlerOptions): Promise; - public getStage(args: GetStageCommandInput, cb: (err: any, data?: GetStageCommandOutput) => void): void; - public getStage( + + /** + * @see {@link GetStageCommand} + */ + getStage(args: GetStageCommandInput, options?: __HttpHandlerOptions): Promise; + getStage(args: GetStageCommandInput, cb: (err: any, data?: GetStageCommandOutput) => void): void; + getStage( args: GetStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStageCommandOutput) => void ): void; - public getStage( - args: GetStageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStageCommandOutput) => void), - cb?: (err: any, data?: GetStageCommandOutput) => void - ): Promise | void { - const command = new GetStageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the Stages for an API.

- */ - public getStages(args: GetStagesCommandInput, options?: __HttpHandlerOptions): Promise; - public getStages(args: GetStagesCommandInput, cb: (err: any, data?: GetStagesCommandOutput) => void): void; - public getStages( + + /** + * @see {@link GetStagesCommand} + */ + getStages(args: GetStagesCommandInput, options?: __HttpHandlerOptions): Promise; + getStages(args: GetStagesCommandInput, cb: (err: any, data?: GetStagesCommandOutput) => void): void; + getStages( args: GetStagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStagesCommandOutput) => void ): void; - public getStages( - args: GetStagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStagesCommandOutput) => void), - cb?: (err: any, data?: GetStagesCommandOutput) => void - ): Promise | void { - const command = new GetStagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a collection of Tag resources.

- */ - public getTags(args: GetTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public getTags(args: GetTagsCommandInput, cb: (err: any, data?: GetTagsCommandOutput) => void): void; - public getTags( + + /** + * @see {@link GetTagsCommand} + */ + getTags(args: GetTagsCommandInput, options?: __HttpHandlerOptions): Promise; + getTags(args: GetTagsCommandInput, cb: (err: any, data?: GetTagsCommandOutput) => void): void; + getTags( args: GetTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTagsCommandOutput) => void ): void; - public getTags( - args: GetTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTagsCommandOutput) => void), - cb?: (err: any, data?: GetTagsCommandOutput) => void - ): Promise | void { - const command = new GetTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a VPC link.

- */ - public getVpcLink(args: GetVpcLinkCommandInput, options?: __HttpHandlerOptions): Promise; - public getVpcLink(args: GetVpcLinkCommandInput, cb: (err: any, data?: GetVpcLinkCommandOutput) => void): void; - public getVpcLink( + + /** + * @see {@link GetVpcLinkCommand} + */ + getVpcLink(args: GetVpcLinkCommandInput, options?: __HttpHandlerOptions): Promise; + getVpcLink(args: GetVpcLinkCommandInput, cb: (err: any, data?: GetVpcLinkCommandOutput) => void): void; + getVpcLink( args: GetVpcLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVpcLinkCommandOutput) => void ): void; - public getVpcLink( - args: GetVpcLinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVpcLinkCommandOutput) => void), - cb?: (err: any, data?: GetVpcLinkCommandOutput) => void - ): Promise | void { - const command = new GetVpcLinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a collection of VPC links.

- */ - public getVpcLinks(args: GetVpcLinksCommandInput, options?: __HttpHandlerOptions): Promise; - public getVpcLinks(args: GetVpcLinksCommandInput, cb: (err: any, data?: GetVpcLinksCommandOutput) => void): void; - public getVpcLinks( + + /** + * @see {@link GetVpcLinksCommand} + */ + getVpcLinks(args: GetVpcLinksCommandInput, options?: __HttpHandlerOptions): Promise; + getVpcLinks(args: GetVpcLinksCommandInput, cb: (err: any, data?: GetVpcLinksCommandOutput) => void): void; + getVpcLinks( args: GetVpcLinksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVpcLinksCommandOutput) => void ): void; - public getVpcLinks( - args: GetVpcLinksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVpcLinksCommandOutput) => void), - cb?: (err: any, data?: GetVpcLinksCommandOutput) => void - ): Promise | void { - const command = new GetVpcLinksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Imports an API.

- */ - public importApi(args: ImportApiCommandInput, options?: __HttpHandlerOptions): Promise; - public importApi(args: ImportApiCommandInput, cb: (err: any, data?: ImportApiCommandOutput) => void): void; - public importApi( + + /** + * @see {@link ImportApiCommand} + */ + importApi(args: ImportApiCommandInput, options?: __HttpHandlerOptions): Promise; + importApi(args: ImportApiCommandInput, cb: (err: any, data?: ImportApiCommandOutput) => void): void; + importApi( args: ImportApiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportApiCommandOutput) => void ): void; - public importApi( - args: ImportApiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportApiCommandOutput) => void), - cb?: (err: any, data?: ImportApiCommandOutput) => void - ): Promise | void { - const command = new ImportApiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Puts an Api resource.

- */ - public reimportApi(args: ReimportApiCommandInput, options?: __HttpHandlerOptions): Promise; - public reimportApi(args: ReimportApiCommandInput, cb: (err: any, data?: ReimportApiCommandOutput) => void): void; - public reimportApi( + + /** + * @see {@link ReimportApiCommand} + */ + reimportApi(args: ReimportApiCommandInput, options?: __HttpHandlerOptions): Promise; + reimportApi(args: ReimportApiCommandInput, cb: (err: any, data?: ReimportApiCommandOutput) => void): void; + reimportApi( args: ReimportApiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReimportApiCommandOutput) => void ): void; - public reimportApi( - args: ReimportApiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReimportApiCommandOutput) => void), - cb?: (err: any, data?: ReimportApiCommandOutput) => void - ): Promise | void { - const command = new ReimportApiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Resets all authorizer cache entries on a stage. Supported only for HTTP APIs.

- */ - public resetAuthorizersCache( + + /** + * @see {@link ResetAuthorizersCacheCommand} + */ + resetAuthorizersCache( args: ResetAuthorizersCacheCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetAuthorizersCache( + resetAuthorizersCache( args: ResetAuthorizersCacheCommandInput, cb: (err: any, data?: ResetAuthorizersCacheCommandOutput) => void ): void; - public resetAuthorizersCache( + resetAuthorizersCache( args: ResetAuthorizersCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetAuthorizersCacheCommandOutput) => void ): void; - public resetAuthorizersCache( - args: ResetAuthorizersCacheCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetAuthorizersCacheCommandOutput) => void), - cb?: (err: any, data?: ResetAuthorizersCacheCommandOutput) => void - ): Promise | void { - const command = new ResetAuthorizersCacheCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new Tag resource to represent a tag.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a Tag.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an Api resource.

- */ - public updateApi(args: UpdateApiCommandInput, options?: __HttpHandlerOptions): Promise; - public updateApi(args: UpdateApiCommandInput, cb: (err: any, data?: UpdateApiCommandOutput) => void): void; - public updateApi( + + /** + * @see {@link UpdateApiCommand} + */ + updateApi(args: UpdateApiCommandInput, options?: __HttpHandlerOptions): Promise; + updateApi(args: UpdateApiCommandInput, cb: (err: any, data?: UpdateApiCommandOutput) => void): void; + updateApi( args: UpdateApiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApiCommandOutput) => void ): void; - public updateApi( - args: UpdateApiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApiCommandOutput) => void), - cb?: (err: any, data?: UpdateApiCommandOutput) => void - ): Promise | void { - const command = new UpdateApiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

The API mapping.

- */ - public updateApiMapping( + + /** + * @see {@link UpdateApiMappingCommand} + */ + updateApiMapping( args: UpdateApiMappingCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApiMapping( + updateApiMapping( args: UpdateApiMappingCommandInput, cb: (err: any, data?: UpdateApiMappingCommandOutput) => void ): void; - public updateApiMapping( + updateApiMapping( args: UpdateApiMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApiMappingCommandOutput) => void ): void; - public updateApiMapping( - args: UpdateApiMappingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApiMappingCommandOutput) => void), - cb?: (err: any, data?: UpdateApiMappingCommandOutput) => void - ): Promise | void { - const command = new UpdateApiMappingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an Authorizer.

- */ - public updateAuthorizer( + + /** + * @see {@link UpdateAuthorizerCommand} + */ + updateAuthorizer( args: UpdateAuthorizerCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAuthorizer( + updateAuthorizer( args: UpdateAuthorizerCommandInput, cb: (err: any, data?: UpdateAuthorizerCommandOutput) => void ): void; - public updateAuthorizer( + updateAuthorizer( args: UpdateAuthorizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAuthorizerCommandOutput) => void ): void; - public updateAuthorizer( - args: UpdateAuthorizerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAuthorizerCommandOutput) => void), - cb?: (err: any, data?: UpdateAuthorizerCommandOutput) => void - ): Promise | void { - const command = new UpdateAuthorizerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a Deployment.

- */ - public updateDeployment( + + /** + * @see {@link UpdateDeploymentCommand} + */ + updateDeployment( args: UpdateDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDeployment( + updateDeployment( args: UpdateDeploymentCommandInput, cb: (err: any, data?: UpdateDeploymentCommandOutput) => void ): void; - public updateDeployment( + updateDeployment( args: UpdateDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDeploymentCommandOutput) => void ): void; - public updateDeployment( - args: UpdateDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDeploymentCommandOutput) => void), - cb?: (err: any, data?: UpdateDeploymentCommandOutput) => void - ): Promise | void { - const command = new UpdateDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a domain name.

- */ - public updateDomainName( + + /** + * @see {@link UpdateDomainNameCommand} + */ + updateDomainName( args: UpdateDomainNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDomainName( + updateDomainName( args: UpdateDomainNameCommandInput, cb: (err: any, data?: UpdateDomainNameCommandOutput) => void ): void; - public updateDomainName( + updateDomainName( args: UpdateDomainNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDomainNameCommandOutput) => void ): void; - public updateDomainName( - args: UpdateDomainNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDomainNameCommandOutput) => void), - cb?: (err: any, data?: UpdateDomainNameCommandOutput) => void - ): Promise | void { - const command = new UpdateDomainNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an Integration.

- */ - public updateIntegration( + + /** + * @see {@link UpdateIntegrationCommand} + */ + updateIntegration( args: UpdateIntegrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateIntegration( + updateIntegration( args: UpdateIntegrationCommandInput, cb: (err: any, data?: UpdateIntegrationCommandOutput) => void ): void; - public updateIntegration( + updateIntegration( args: UpdateIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIntegrationCommandOutput) => void ): void; - public updateIntegration( - args: UpdateIntegrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateIntegrationCommandOutput) => void), - cb?: (err: any, data?: UpdateIntegrationCommandOutput) => void - ): Promise | void { - const command = new UpdateIntegrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an IntegrationResponses.

- */ - public updateIntegrationResponse( + + /** + * @see {@link UpdateIntegrationResponseCommand} + */ + updateIntegrationResponse( args: UpdateIntegrationResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateIntegrationResponse( + updateIntegrationResponse( args: UpdateIntegrationResponseCommandInput, cb: (err: any, data?: UpdateIntegrationResponseCommandOutput) => void ): void; - public updateIntegrationResponse( + updateIntegrationResponse( args: UpdateIntegrationResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIntegrationResponseCommandOutput) => void ): void; - public updateIntegrationResponse( - args: UpdateIntegrationResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateIntegrationResponseCommandOutput) => void), - cb?: (err: any, data?: UpdateIntegrationResponseCommandOutput) => void - ): Promise | void { - const command = new UpdateIntegrationResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a Model.

- */ - public updateModel(args: UpdateModelCommandInput, options?: __HttpHandlerOptions): Promise; - public updateModel(args: UpdateModelCommandInput, cb: (err: any, data?: UpdateModelCommandOutput) => void): void; - public updateModel( + + /** + * @see {@link UpdateModelCommand} + */ + updateModel(args: UpdateModelCommandInput, options?: __HttpHandlerOptions): Promise; + updateModel(args: UpdateModelCommandInput, cb: (err: any, data?: UpdateModelCommandOutput) => void): void; + updateModel( args: UpdateModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateModelCommandOutput) => void ): void; - public updateModel( - args: UpdateModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateModelCommandOutput) => void), - cb?: (err: any, data?: UpdateModelCommandOutput) => void - ): Promise | void { - const command = new UpdateModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a Route.

- */ - public updateRoute(args: UpdateRouteCommandInput, options?: __HttpHandlerOptions): Promise; - public updateRoute(args: UpdateRouteCommandInput, cb: (err: any, data?: UpdateRouteCommandOutput) => void): void; - public updateRoute( + + /** + * @see {@link UpdateRouteCommand} + */ + updateRoute(args: UpdateRouteCommandInput, options?: __HttpHandlerOptions): Promise; + updateRoute(args: UpdateRouteCommandInput, cb: (err: any, data?: UpdateRouteCommandOutput) => void): void; + updateRoute( args: UpdateRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRouteCommandOutput) => void ): void; - public updateRoute( - args: UpdateRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRouteCommandOutput) => void), - cb?: (err: any, data?: UpdateRouteCommandOutput) => void - ): Promise | void { - const command = new UpdateRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a RouteResponse.

- */ - public updateRouteResponse( + + /** + * @see {@link UpdateRouteResponseCommand} + */ + updateRouteResponse( args: UpdateRouteResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRouteResponse( + updateRouteResponse( args: UpdateRouteResponseCommandInput, cb: (err: any, data?: UpdateRouteResponseCommandOutput) => void ): void; - public updateRouteResponse( + updateRouteResponse( args: UpdateRouteResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRouteResponseCommandOutput) => void ): void; - public updateRouteResponse( - args: UpdateRouteResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRouteResponseCommandOutput) => void), - cb?: (err: any, data?: UpdateRouteResponseCommandOutput) => void - ): Promise | void { - const command = new UpdateRouteResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a Stage.

- */ - public updateStage(args: UpdateStageCommandInput, options?: __HttpHandlerOptions): Promise; - public updateStage(args: UpdateStageCommandInput, cb: (err: any, data?: UpdateStageCommandOutput) => void): void; - public updateStage( + + /** + * @see {@link UpdateStageCommand} + */ + updateStage(args: UpdateStageCommandInput, options?: __HttpHandlerOptions): Promise; + updateStage(args: UpdateStageCommandInput, cb: (err: any, data?: UpdateStageCommandOutput) => void): void; + updateStage( args: UpdateStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStageCommandOutput) => void ): void; - public updateStage( - args: UpdateStageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStageCommandOutput) => void), - cb?: (err: any, data?: UpdateStageCommandOutput) => void - ): Promise | void { - const command = new UpdateStageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a VPC link.

- */ - public updateVpcLink( - args: UpdateVpcLinkCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateVpcLink( - args: UpdateVpcLinkCommandInput, - cb: (err: any, data?: UpdateVpcLinkCommandOutput) => void - ): void; - public updateVpcLink( + + /** + * @see {@link UpdateVpcLinkCommand} + */ + updateVpcLink(args: UpdateVpcLinkCommandInput, options?: __HttpHandlerOptions): Promise; + updateVpcLink(args: UpdateVpcLinkCommandInput, cb: (err: any, data?: UpdateVpcLinkCommandOutput) => void): void; + updateVpcLink( args: UpdateVpcLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVpcLinkCommandOutput) => void ): void; - public updateVpcLink( - args: UpdateVpcLinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVpcLinkCommandOutput) => void), - cb?: (err: any, data?: UpdateVpcLinkCommandOutput) => void - ): Promise | void { - const command = new UpdateVpcLinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon API Gateway V2

+ */ +export class ApiGatewayV2 extends ApiGatewayV2Client implements ApiGatewayV2 {} +createAggregatedClient(commands, ApiGatewayV2); diff --git a/clients/client-app-mesh/src/AppMesh.ts b/clients/client-app-mesh/src/AppMesh.ts index b74411a01a73..699270cc7989 100644 --- a/clients/client-app-mesh/src/AppMesh.ts +++ b/clients/client-app-mesh/src/AppMesh.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { AppMeshClient } from "./AppMeshClient"; +import { AppMeshClient, AppMeshClientConfig } from "./AppMeshClient"; import { CreateGatewayRouteCommand, CreateGatewayRouteCommandInput, @@ -157,1283 +158,640 @@ import { UpdateVirtualServiceCommandOutput, } from "./commands/UpdateVirtualServiceCommand"; -/** - * @public - *

App Mesh is a service mesh based on the Envoy proxy that makes it easy to - * monitor and control microservices. App Mesh standardizes how your microservices - * communicate, giving you end-to-end visibility and helping to ensure high availability for - * your applications.

- *

App Mesh gives you consistent visibility and network traffic controls for - * every microservice in an application. You can use App Mesh with Amazon Web Services Fargate, Amazon ECS, Amazon EKS, Kubernetes on Amazon Web Services, and - * Amazon EC2.

- * - *

App Mesh supports microservice applications that use service discovery - * naming for their components. For more information about service discovery on Amazon ECS, see Service - * Discovery in the Amazon Elastic Container Service Developer Guide. Kubernetes - * kube-dns and coredns are supported. For more information, - * see DNS - * for Services and Pods in the Kubernetes documentation.

- *
- */ -export class AppMesh extends AppMeshClient { +const commands = { + CreateGatewayRouteCommand, + CreateMeshCommand, + CreateRouteCommand, + CreateVirtualGatewayCommand, + CreateVirtualNodeCommand, + CreateVirtualRouterCommand, + CreateVirtualServiceCommand, + DeleteGatewayRouteCommand, + DeleteMeshCommand, + DeleteRouteCommand, + DeleteVirtualGatewayCommand, + DeleteVirtualNodeCommand, + DeleteVirtualRouterCommand, + DeleteVirtualServiceCommand, + DescribeGatewayRouteCommand, + DescribeMeshCommand, + DescribeRouteCommand, + DescribeVirtualGatewayCommand, + DescribeVirtualNodeCommand, + DescribeVirtualRouterCommand, + DescribeVirtualServiceCommand, + ListGatewayRoutesCommand, + ListMeshesCommand, + ListRoutesCommand, + ListTagsForResourceCommand, + ListVirtualGatewaysCommand, + ListVirtualNodesCommand, + ListVirtualRoutersCommand, + ListVirtualServicesCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateGatewayRouteCommand, + UpdateMeshCommand, + UpdateRouteCommand, + UpdateVirtualGatewayCommand, + UpdateVirtualNodeCommand, + UpdateVirtualRouterCommand, + UpdateVirtualServiceCommand, +}; + +export interface AppMesh { /** - * @public - *

Creates a gateway route.

- *

A gateway route is attached to a virtual gateway and routes traffic to an existing - * virtual service. If a route matches a request, it can distribute traffic to a target - * virtual service.

- *

For more information about gateway routes, see Gateway routes.

+ * @see {@link CreateGatewayRouteCommand} */ - public createGatewayRoute( + createGatewayRoute( args: CreateGatewayRouteCommandInput, options?: __HttpHandlerOptions ): Promise; - public createGatewayRoute( + createGatewayRoute( args: CreateGatewayRouteCommandInput, cb: (err: any, data?: CreateGatewayRouteCommandOutput) => void ): void; - public createGatewayRoute( + createGatewayRoute( args: CreateGatewayRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGatewayRouteCommandOutput) => void ): void; - public createGatewayRoute( - args: CreateGatewayRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGatewayRouteCommandOutput) => void), - cb?: (err: any, data?: CreateGatewayRouteCommandOutput) => void - ): Promise | void { - const command = new CreateGatewayRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a service mesh.

- *

A service mesh is a logical boundary for network traffic between services that are - * represented by resources within the mesh. After you create your service mesh, you can - * create virtual services, virtual nodes, virtual routers, and routes to distribute traffic - * between the applications in your mesh.

- *

For more information about service meshes, see Service meshes.

+ * @see {@link CreateMeshCommand} */ - public createMesh(args: CreateMeshCommandInput, options?: __HttpHandlerOptions): Promise; - public createMesh(args: CreateMeshCommandInput, cb: (err: any, data?: CreateMeshCommandOutput) => void): void; - public createMesh( + createMesh(args: CreateMeshCommandInput, options?: __HttpHandlerOptions): Promise; + createMesh(args: CreateMeshCommandInput, cb: (err: any, data?: CreateMeshCommandOutput) => void): void; + createMesh( args: CreateMeshCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMeshCommandOutput) => void ): void; - public createMesh( - args: CreateMeshCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMeshCommandOutput) => void), - cb?: (err: any, data?: CreateMeshCommandOutput) => void - ): Promise | void { - const command = new CreateMeshCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a route that is associated with a virtual router.

- *

You can route several different protocols and define a retry policy for a route. - * Traffic can be routed to one or more virtual nodes.

- *

For more information about routes, see Routes.

+ * @see {@link CreateRouteCommand} */ - public createRoute(args: CreateRouteCommandInput, options?: __HttpHandlerOptions): Promise; - public createRoute(args: CreateRouteCommandInput, cb: (err: any, data?: CreateRouteCommandOutput) => void): void; - public createRoute( + createRoute(args: CreateRouteCommandInput, options?: __HttpHandlerOptions): Promise; + createRoute(args: CreateRouteCommandInput, cb: (err: any, data?: CreateRouteCommandOutput) => void): void; + createRoute( args: CreateRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRouteCommandOutput) => void ): void; - public createRoute( - args: CreateRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRouteCommandOutput) => void), - cb?: (err: any, data?: CreateRouteCommandOutput) => void - ): Promise | void { - const command = new CreateRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a virtual gateway.

- *

A virtual gateway allows resources outside your mesh to communicate to resources that - * are inside your mesh. The virtual gateway represents an Envoy proxy running in an Amazon ECS task, in a Kubernetes service, or on an Amazon EC2 instance. Unlike a - * virtual node, which represents an Envoy running with an application, a virtual gateway - * represents Envoy deployed by itself.

- *

For more information about virtual gateways, see Virtual gateways.

+ * @see {@link CreateVirtualGatewayCommand} */ - public createVirtualGateway( + createVirtualGateway( args: CreateVirtualGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVirtualGateway( + createVirtualGateway( args: CreateVirtualGatewayCommandInput, cb: (err: any, data?: CreateVirtualGatewayCommandOutput) => void ): void; - public createVirtualGateway( + createVirtualGateway( args: CreateVirtualGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVirtualGatewayCommandOutput) => void ): void; - public createVirtualGateway( - args: CreateVirtualGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVirtualGatewayCommandOutput) => void), - cb?: (err: any, data?: CreateVirtualGatewayCommandOutput) => void - ): Promise | void { - const command = new CreateVirtualGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a virtual node within a service mesh.

- *

A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you can - * specify the service discovery information for your task group, and whether the proxy - * running in a task group will communicate with other proxies using Transport Layer Security - * (TLS).

- *

You define a listener for any inbound traffic that your virtual node - * expects. Any virtual service that your virtual node expects to communicate to is specified - * as a backend.

- *

The response metadata for your new virtual node contains the arn that is - * associated with the virtual node. Set this value to the full ARN; for example, - * arn:aws:appmesh:us-west-2:123456789012:myMesh/default/virtualNode/myApp) - * as the APPMESH_RESOURCE_ARN environment variable for your task group's Envoy - * proxy container in your task definition or pod spec. This is then mapped to the - * node.id and node.cluster Envoy parameters.

- * - *

By default, App Mesh uses the name of the resource you specified in - * APPMESH_RESOURCE_ARN when Envoy is referring to itself in metrics and - * traces. You can override this behavior by setting the - * APPMESH_RESOURCE_CLUSTER environment variable with your own name.

- *
- *

For more information about virtual nodes, see Virtual nodes. You must be using 1.15.0 or later of the Envoy image when - * setting these variables. For more information aboutApp Mesh Envoy variables, see - * Envoy - * image in the App Mesh User Guide.

+ * @see {@link CreateVirtualNodeCommand} */ - public createVirtualNode( + createVirtualNode( args: CreateVirtualNodeCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVirtualNode( + createVirtualNode( args: CreateVirtualNodeCommandInput, cb: (err: any, data?: CreateVirtualNodeCommandOutput) => void ): void; - public createVirtualNode( + createVirtualNode( args: CreateVirtualNodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVirtualNodeCommandOutput) => void ): void; - public createVirtualNode( - args: CreateVirtualNodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVirtualNodeCommandOutput) => void), - cb?: (err: any, data?: CreateVirtualNodeCommandOutput) => void - ): Promise | void { - const command = new CreateVirtualNodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a virtual router within a service mesh.

- *

Specify a listener for any inbound traffic that your virtual router - * receives. Create a virtual router for each protocol and port that you need to route. - * Virtual routers handle traffic for one or more virtual services within your mesh. After you - * create your virtual router, create and associate routes for your virtual router that direct - * incoming requests to different virtual nodes.

- *

For more information about virtual routers, see Virtual routers.

+ * @see {@link CreateVirtualRouterCommand} */ - public createVirtualRouter( + createVirtualRouter( args: CreateVirtualRouterCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVirtualRouter( + createVirtualRouter( args: CreateVirtualRouterCommandInput, cb: (err: any, data?: CreateVirtualRouterCommandOutput) => void ): void; - public createVirtualRouter( + createVirtualRouter( args: CreateVirtualRouterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVirtualRouterCommandOutput) => void ): void; - public createVirtualRouter( - args: CreateVirtualRouterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVirtualRouterCommandOutput) => void), - cb?: (err: any, data?: CreateVirtualRouterCommandOutput) => void - ): Promise | void { - const command = new CreateVirtualRouterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a virtual service within a service mesh.

- *

A virtual service is an abstraction of a real service that is provided by a virtual node - * directly or indirectly by means of a virtual router. Dependent services call your virtual - * service by its virtualServiceName, and those requests are routed to the - * virtual node or virtual router that is specified as the provider for the virtual - * service.

- *

For more information about virtual services, see Virtual services.

+ * @see {@link CreateVirtualServiceCommand} */ - public createVirtualService( + createVirtualService( args: CreateVirtualServiceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVirtualService( + createVirtualService( args: CreateVirtualServiceCommandInput, cb: (err: any, data?: CreateVirtualServiceCommandOutput) => void ): void; - public createVirtualService( + createVirtualService( args: CreateVirtualServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVirtualServiceCommandOutput) => void ): void; - public createVirtualService( - args: CreateVirtualServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVirtualServiceCommandOutput) => void), - cb?: (err: any, data?: CreateVirtualServiceCommandOutput) => void - ): Promise | void { - const command = new CreateVirtualServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing gateway route.

+ * @see {@link DeleteGatewayRouteCommand} */ - public deleteGatewayRoute( + deleteGatewayRoute( args: DeleteGatewayRouteCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteGatewayRoute( + deleteGatewayRoute( args: DeleteGatewayRouteCommandInput, cb: (err: any, data?: DeleteGatewayRouteCommandOutput) => void ): void; - public deleteGatewayRoute( + deleteGatewayRoute( args: DeleteGatewayRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGatewayRouteCommandOutput) => void ): void; - public deleteGatewayRoute( - args: DeleteGatewayRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGatewayRouteCommandOutput) => void), - cb?: (err: any, data?: DeleteGatewayRouteCommandOutput) => void - ): Promise | void { - const command = new DeleteGatewayRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing service mesh.

- *

You must delete all resources (virtual services, routes, virtual routers, and virtual - * nodes) in the service mesh before you can delete the mesh itself.

+ * @see {@link DeleteMeshCommand} */ - public deleteMesh(args: DeleteMeshCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteMesh(args: DeleteMeshCommandInput, cb: (err: any, data?: DeleteMeshCommandOutput) => void): void; - public deleteMesh( + deleteMesh(args: DeleteMeshCommandInput, options?: __HttpHandlerOptions): Promise; + deleteMesh(args: DeleteMeshCommandInput, cb: (err: any, data?: DeleteMeshCommandOutput) => void): void; + deleteMesh( args: DeleteMeshCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMeshCommandOutput) => void ): void; - public deleteMesh( - args: DeleteMeshCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMeshCommandOutput) => void), - cb?: (err: any, data?: DeleteMeshCommandOutput) => void - ): Promise | void { - const command = new DeleteMeshCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing route.

+ * @see {@link DeleteRouteCommand} */ - public deleteRoute(args: DeleteRouteCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteRoute(args: DeleteRouteCommandInput, cb: (err: any, data?: DeleteRouteCommandOutput) => void): void; - public deleteRoute( + deleteRoute(args: DeleteRouteCommandInput, options?: __HttpHandlerOptions): Promise; + deleteRoute(args: DeleteRouteCommandInput, cb: (err: any, data?: DeleteRouteCommandOutput) => void): void; + deleteRoute( args: DeleteRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRouteCommandOutput) => void ): void; - public deleteRoute( - args: DeleteRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRouteCommandOutput) => void), - cb?: (err: any, data?: DeleteRouteCommandOutput) => void - ): Promise | void { - const command = new DeleteRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing virtual gateway. You cannot delete a virtual gateway if any gateway - * routes are associated to it.

+ * @see {@link DeleteVirtualGatewayCommand} */ - public deleteVirtualGateway( + deleteVirtualGateway( args: DeleteVirtualGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVirtualGateway( + deleteVirtualGateway( args: DeleteVirtualGatewayCommandInput, cb: (err: any, data?: DeleteVirtualGatewayCommandOutput) => void ): void; - public deleteVirtualGateway( + deleteVirtualGateway( args: DeleteVirtualGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVirtualGatewayCommandOutput) => void ): void; - public deleteVirtualGateway( - args: DeleteVirtualGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVirtualGatewayCommandOutput) => void), - cb?: (err: any, data?: DeleteVirtualGatewayCommandOutput) => void - ): Promise | void { - const command = new DeleteVirtualGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing virtual node.

- *

You must delete any virtual services that list a virtual node as a service provider - * before you can delete the virtual node itself.

+ * @see {@link DeleteVirtualNodeCommand} */ - public deleteVirtualNode( + deleteVirtualNode( args: DeleteVirtualNodeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVirtualNode( + deleteVirtualNode( args: DeleteVirtualNodeCommandInput, cb: (err: any, data?: DeleteVirtualNodeCommandOutput) => void ): void; - public deleteVirtualNode( + deleteVirtualNode( args: DeleteVirtualNodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVirtualNodeCommandOutput) => void ): void; - public deleteVirtualNode( - args: DeleteVirtualNodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVirtualNodeCommandOutput) => void), - cb?: (err: any, data?: DeleteVirtualNodeCommandOutput) => void - ): Promise | void { - const command = new DeleteVirtualNodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing virtual router.

- *

You must delete any routes associated with the virtual router before you can delete the - * router itself.

+ * @see {@link DeleteVirtualRouterCommand} */ - public deleteVirtualRouter( + deleteVirtualRouter( args: DeleteVirtualRouterCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVirtualRouter( + deleteVirtualRouter( args: DeleteVirtualRouterCommandInput, cb: (err: any, data?: DeleteVirtualRouterCommandOutput) => void ): void; - public deleteVirtualRouter( + deleteVirtualRouter( args: DeleteVirtualRouterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVirtualRouterCommandOutput) => void ): void; - public deleteVirtualRouter( - args: DeleteVirtualRouterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVirtualRouterCommandOutput) => void), - cb?: (err: any, data?: DeleteVirtualRouterCommandOutput) => void - ): Promise | void { - const command = new DeleteVirtualRouterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing virtual service.

+ * @see {@link DeleteVirtualServiceCommand} */ - public deleteVirtualService( + deleteVirtualService( args: DeleteVirtualServiceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVirtualService( + deleteVirtualService( args: DeleteVirtualServiceCommandInput, cb: (err: any, data?: DeleteVirtualServiceCommandOutput) => void ): void; - public deleteVirtualService( + deleteVirtualService( args: DeleteVirtualServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVirtualServiceCommandOutput) => void ): void; - public deleteVirtualService( - args: DeleteVirtualServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVirtualServiceCommandOutput) => void), - cb?: (err: any, data?: DeleteVirtualServiceCommandOutput) => void - ): Promise | void { - const command = new DeleteVirtualServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an existing gateway route.

+ * @see {@link DescribeGatewayRouteCommand} */ - public describeGatewayRoute( + describeGatewayRoute( args: DescribeGatewayRouteCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGatewayRoute( + describeGatewayRoute( args: DescribeGatewayRouteCommandInput, cb: (err: any, data?: DescribeGatewayRouteCommandOutput) => void ): void; - public describeGatewayRoute( + describeGatewayRoute( args: DescribeGatewayRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGatewayRouteCommandOutput) => void ): void; - public describeGatewayRoute( - args: DescribeGatewayRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGatewayRouteCommandOutput) => void), - cb?: (err: any, data?: DescribeGatewayRouteCommandOutput) => void - ): Promise | void { - const command = new DescribeGatewayRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an existing service mesh.

+ * @see {@link DescribeMeshCommand} */ - public describeMesh( - args: DescribeMeshCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeMesh(args: DescribeMeshCommandInput, cb: (err: any, data?: DescribeMeshCommandOutput) => void): void; - public describeMesh( + describeMesh(args: DescribeMeshCommandInput, options?: __HttpHandlerOptions): Promise; + describeMesh(args: DescribeMeshCommandInput, cb: (err: any, data?: DescribeMeshCommandOutput) => void): void; + describeMesh( args: DescribeMeshCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMeshCommandOutput) => void ): void; - public describeMesh( - args: DescribeMeshCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMeshCommandOutput) => void), - cb?: (err: any, data?: DescribeMeshCommandOutput) => void - ): Promise | void { - const command = new DescribeMeshCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an existing route.

+ * @see {@link DescribeRouteCommand} */ - public describeRoute( - args: DescribeRouteCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeRoute( - args: DescribeRouteCommandInput, - cb: (err: any, data?: DescribeRouteCommandOutput) => void - ): void; - public describeRoute( + describeRoute(args: DescribeRouteCommandInput, options?: __HttpHandlerOptions): Promise; + describeRoute(args: DescribeRouteCommandInput, cb: (err: any, data?: DescribeRouteCommandOutput) => void): void; + describeRoute( args: DescribeRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRouteCommandOutput) => void ): void; - public describeRoute( - args: DescribeRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRouteCommandOutput) => void), - cb?: (err: any, data?: DescribeRouteCommandOutput) => void - ): Promise | void { - const command = new DescribeRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an existing virtual gateway.

+ * @see {@link DescribeVirtualGatewayCommand} */ - public describeVirtualGateway( + describeVirtualGateway( args: DescribeVirtualGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVirtualGateway( + describeVirtualGateway( args: DescribeVirtualGatewayCommandInput, cb: (err: any, data?: DescribeVirtualGatewayCommandOutput) => void ): void; - public describeVirtualGateway( + describeVirtualGateway( args: DescribeVirtualGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVirtualGatewayCommandOutput) => void ): void; - public describeVirtualGateway( - args: DescribeVirtualGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVirtualGatewayCommandOutput) => void), - cb?: (err: any, data?: DescribeVirtualGatewayCommandOutput) => void - ): Promise | void { - const command = new DescribeVirtualGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an existing virtual node.

+ * @see {@link DescribeVirtualNodeCommand} */ - public describeVirtualNode( + describeVirtualNode( args: DescribeVirtualNodeCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVirtualNode( + describeVirtualNode( args: DescribeVirtualNodeCommandInput, cb: (err: any, data?: DescribeVirtualNodeCommandOutput) => void ): void; - public describeVirtualNode( + describeVirtualNode( args: DescribeVirtualNodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVirtualNodeCommandOutput) => void ): void; - public describeVirtualNode( - args: DescribeVirtualNodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVirtualNodeCommandOutput) => void), - cb?: (err: any, data?: DescribeVirtualNodeCommandOutput) => void - ): Promise | void { - const command = new DescribeVirtualNodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an existing virtual router.

+ * @see {@link DescribeVirtualRouterCommand} */ - public describeVirtualRouter( + describeVirtualRouter( args: DescribeVirtualRouterCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVirtualRouter( + describeVirtualRouter( args: DescribeVirtualRouterCommandInput, cb: (err: any, data?: DescribeVirtualRouterCommandOutput) => void ): void; - public describeVirtualRouter( + describeVirtualRouter( args: DescribeVirtualRouterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVirtualRouterCommandOutput) => void ): void; - public describeVirtualRouter( - args: DescribeVirtualRouterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVirtualRouterCommandOutput) => void), - cb?: (err: any, data?: DescribeVirtualRouterCommandOutput) => void - ): Promise | void { - const command = new DescribeVirtualRouterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an existing virtual service.

+ * @see {@link DescribeVirtualServiceCommand} */ - public describeVirtualService( + describeVirtualService( args: DescribeVirtualServiceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVirtualService( + describeVirtualService( args: DescribeVirtualServiceCommandInput, cb: (err: any, data?: DescribeVirtualServiceCommandOutput) => void ): void; - public describeVirtualService( + describeVirtualService( args: DescribeVirtualServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVirtualServiceCommandOutput) => void ): void; - public describeVirtualService( - args: DescribeVirtualServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVirtualServiceCommandOutput) => void), - cb?: (err: any, data?: DescribeVirtualServiceCommandOutput) => void - ): Promise | void { - const command = new DescribeVirtualServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of existing gateway routes that are associated to a virtual - * gateway.

+ * @see {@link ListGatewayRoutesCommand} */ - public listGatewayRoutes( + listGatewayRoutes( args: ListGatewayRoutesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGatewayRoutes( + listGatewayRoutes( args: ListGatewayRoutesCommandInput, cb: (err: any, data?: ListGatewayRoutesCommandOutput) => void ): void; - public listGatewayRoutes( + listGatewayRoutes( args: ListGatewayRoutesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGatewayRoutesCommandOutput) => void ): void; - public listGatewayRoutes( - args: ListGatewayRoutesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGatewayRoutesCommandOutput) => void), - cb?: (err: any, data?: ListGatewayRoutesCommandOutput) => void - ): Promise | void { - const command = new ListGatewayRoutesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of existing service meshes.

+ * @see {@link ListMeshesCommand} */ - public listMeshes(args: ListMeshesCommandInput, options?: __HttpHandlerOptions): Promise; - public listMeshes(args: ListMeshesCommandInput, cb: (err: any, data?: ListMeshesCommandOutput) => void): void; - public listMeshes( + listMeshes(args: ListMeshesCommandInput, options?: __HttpHandlerOptions): Promise; + listMeshes(args: ListMeshesCommandInput, cb: (err: any, data?: ListMeshesCommandOutput) => void): void; + listMeshes( args: ListMeshesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMeshesCommandOutput) => void ): void; - public listMeshes( - args: ListMeshesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMeshesCommandOutput) => void), - cb?: (err: any, data?: ListMeshesCommandOutput) => void - ): Promise | void { - const command = new ListMeshesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of existing routes in a service mesh.

+ * @see {@link ListRoutesCommand} */ - public listRoutes(args: ListRoutesCommandInput, options?: __HttpHandlerOptions): Promise; - public listRoutes(args: ListRoutesCommandInput, cb: (err: any, data?: ListRoutesCommandOutput) => void): void; - public listRoutes( + listRoutes(args: ListRoutesCommandInput, options?: __HttpHandlerOptions): Promise; + listRoutes(args: ListRoutesCommandInput, cb: (err: any, data?: ListRoutesCommandOutput) => void): void; + listRoutes( args: ListRoutesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRoutesCommandOutput) => void ): void; - public listRoutes( - args: ListRoutesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRoutesCommandOutput) => void), - cb?: (err: any, data?: ListRoutesCommandOutput) => void - ): Promise | void { - const command = new ListRoutesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the tags for an App Mesh resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of existing virtual gateways in a service mesh.

+ * @see {@link ListVirtualGatewaysCommand} */ - public listVirtualGateways( + listVirtualGateways( args: ListVirtualGatewaysCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVirtualGateways( + listVirtualGateways( args: ListVirtualGatewaysCommandInput, cb: (err: any, data?: ListVirtualGatewaysCommandOutput) => void ): void; - public listVirtualGateways( + listVirtualGateways( args: ListVirtualGatewaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVirtualGatewaysCommandOutput) => void ): void; - public listVirtualGateways( - args: ListVirtualGatewaysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVirtualGatewaysCommandOutput) => void), - cb?: (err: any, data?: ListVirtualGatewaysCommandOutput) => void - ): Promise | void { - const command = new ListVirtualGatewaysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of existing virtual nodes.

+ * @see {@link ListVirtualNodesCommand} */ - public listVirtualNodes( + listVirtualNodes( args: ListVirtualNodesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVirtualNodes( + listVirtualNodes( args: ListVirtualNodesCommandInput, cb: (err: any, data?: ListVirtualNodesCommandOutput) => void ): void; - public listVirtualNodes( + listVirtualNodes( args: ListVirtualNodesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVirtualNodesCommandOutput) => void ): void; - public listVirtualNodes( - args: ListVirtualNodesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVirtualNodesCommandOutput) => void), - cb?: (err: any, data?: ListVirtualNodesCommandOutput) => void - ): Promise | void { - const command = new ListVirtualNodesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of existing virtual routers in a service mesh.

+ * @see {@link ListVirtualRoutersCommand} */ - public listVirtualRouters( + listVirtualRouters( args: ListVirtualRoutersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVirtualRouters( + listVirtualRouters( args: ListVirtualRoutersCommandInput, cb: (err: any, data?: ListVirtualRoutersCommandOutput) => void ): void; - public listVirtualRouters( + listVirtualRouters( args: ListVirtualRoutersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVirtualRoutersCommandOutput) => void ): void; - public listVirtualRouters( - args: ListVirtualRoutersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVirtualRoutersCommandOutput) => void), - cb?: (err: any, data?: ListVirtualRoutersCommandOutput) => void - ): Promise | void { - const command = new ListVirtualRoutersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of existing virtual services in a service mesh.

+ * @see {@link ListVirtualServicesCommand} */ - public listVirtualServices( + listVirtualServices( args: ListVirtualServicesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVirtualServices( + listVirtualServices( args: ListVirtualServicesCommandInput, cb: (err: any, data?: ListVirtualServicesCommandOutput) => void ): void; - public listVirtualServices( + listVirtualServices( args: ListVirtualServicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVirtualServicesCommandOutput) => void ): void; - public listVirtualServices( - args: ListVirtualServicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVirtualServicesCommandOutput) => void), - cb?: (err: any, data?: ListVirtualServicesCommandOutput) => void - ): Promise | void { - const command = new ListVirtualServicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates the specified tags to a resource with the specified resourceArn. - * If existing tags on a resource aren't specified in the request parameters, they aren't - * changed. When a resource is deleted, the tags associated with that resource are also - * deleted.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes specified tags from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing gateway route that is associated to a specified virtual gateway in a - * service mesh.

+ * @see {@link UpdateGatewayRouteCommand} */ - public updateGatewayRoute( + updateGatewayRoute( args: UpdateGatewayRouteCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGatewayRoute( + updateGatewayRoute( args: UpdateGatewayRouteCommandInput, cb: (err: any, data?: UpdateGatewayRouteCommandOutput) => void ): void; - public updateGatewayRoute( + updateGatewayRoute( args: UpdateGatewayRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGatewayRouteCommandOutput) => void ): void; - public updateGatewayRoute( - args: UpdateGatewayRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGatewayRouteCommandOutput) => void), - cb?: (err: any, data?: UpdateGatewayRouteCommandOutput) => void - ): Promise | void { - const command = new UpdateGatewayRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing service mesh.

+ * @see {@link UpdateMeshCommand} */ - public updateMesh(args: UpdateMeshCommandInput, options?: __HttpHandlerOptions): Promise; - public updateMesh(args: UpdateMeshCommandInput, cb: (err: any, data?: UpdateMeshCommandOutput) => void): void; - public updateMesh( + updateMesh(args: UpdateMeshCommandInput, options?: __HttpHandlerOptions): Promise; + updateMesh(args: UpdateMeshCommandInput, cb: (err: any, data?: UpdateMeshCommandOutput) => void): void; + updateMesh( args: UpdateMeshCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMeshCommandOutput) => void ): void; - public updateMesh( - args: UpdateMeshCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMeshCommandOutput) => void), - cb?: (err: any, data?: UpdateMeshCommandOutput) => void - ): Promise | void { - const command = new UpdateMeshCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing route for a specified service mesh and virtual router.

+ * @see {@link UpdateRouteCommand} */ - public updateRoute(args: UpdateRouteCommandInput, options?: __HttpHandlerOptions): Promise; - public updateRoute(args: UpdateRouteCommandInput, cb: (err: any, data?: UpdateRouteCommandOutput) => void): void; - public updateRoute( + updateRoute(args: UpdateRouteCommandInput, options?: __HttpHandlerOptions): Promise; + updateRoute(args: UpdateRouteCommandInput, cb: (err: any, data?: UpdateRouteCommandOutput) => void): void; + updateRoute( args: UpdateRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRouteCommandOutput) => void ): void; - public updateRoute( - args: UpdateRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRouteCommandOutput) => void), - cb?: (err: any, data?: UpdateRouteCommandOutput) => void - ): Promise | void { - const command = new UpdateRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing virtual gateway in a specified service mesh.

+ * @see {@link UpdateVirtualGatewayCommand} */ - public updateVirtualGateway( + updateVirtualGateway( args: UpdateVirtualGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVirtualGateway( + updateVirtualGateway( args: UpdateVirtualGatewayCommandInput, cb: (err: any, data?: UpdateVirtualGatewayCommandOutput) => void ): void; - public updateVirtualGateway( + updateVirtualGateway( args: UpdateVirtualGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVirtualGatewayCommandOutput) => void ): void; - public updateVirtualGateway( - args: UpdateVirtualGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVirtualGatewayCommandOutput) => void), - cb?: (err: any, data?: UpdateVirtualGatewayCommandOutput) => void - ): Promise | void { - const command = new UpdateVirtualGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing virtual node in a specified service mesh.

+ * @see {@link UpdateVirtualNodeCommand} */ - public updateVirtualNode( + updateVirtualNode( args: UpdateVirtualNodeCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVirtualNode( + updateVirtualNode( args: UpdateVirtualNodeCommandInput, cb: (err: any, data?: UpdateVirtualNodeCommandOutput) => void ): void; - public updateVirtualNode( + updateVirtualNode( args: UpdateVirtualNodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVirtualNodeCommandOutput) => void ): void; - public updateVirtualNode( - args: UpdateVirtualNodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVirtualNodeCommandOutput) => void), - cb?: (err: any, data?: UpdateVirtualNodeCommandOutput) => void - ): Promise | void { - const command = new UpdateVirtualNodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing virtual router in a specified service mesh.

+ * @see {@link UpdateVirtualRouterCommand} */ - public updateVirtualRouter( + updateVirtualRouter( args: UpdateVirtualRouterCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVirtualRouter( + updateVirtualRouter( args: UpdateVirtualRouterCommandInput, cb: (err: any, data?: UpdateVirtualRouterCommandOutput) => void ): void; - public updateVirtualRouter( + updateVirtualRouter( args: UpdateVirtualRouterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVirtualRouterCommandOutput) => void ): void; - public updateVirtualRouter( - args: UpdateVirtualRouterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVirtualRouterCommandOutput) => void), - cb?: (err: any, data?: UpdateVirtualRouterCommandOutput) => void - ): Promise | void { - const command = new UpdateVirtualRouterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing virtual service in a specified service mesh.

+ * @see {@link UpdateVirtualServiceCommand} */ - public updateVirtualService( + updateVirtualService( args: UpdateVirtualServiceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVirtualService( + updateVirtualService( args: UpdateVirtualServiceCommandInput, cb: (err: any, data?: UpdateVirtualServiceCommandOutput) => void ): void; - public updateVirtualService( + updateVirtualService( args: UpdateVirtualServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVirtualServiceCommandOutput) => void ): void; - public updateVirtualService( - args: UpdateVirtualServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVirtualServiceCommandOutput) => void), - cb?: (err: any, data?: UpdateVirtualServiceCommandOutput) => void - ): Promise | void { - const command = new UpdateVirtualServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

App Mesh is a service mesh based on the Envoy proxy that makes it easy to + * monitor and control microservices. App Mesh standardizes how your microservices + * communicate, giving you end-to-end visibility and helping to ensure high availability for + * your applications.

+ *

App Mesh gives you consistent visibility and network traffic controls for + * every microservice in an application. You can use App Mesh with Amazon Web Services Fargate, Amazon ECS, Amazon EKS, Kubernetes on Amazon Web Services, and + * Amazon EC2.

+ * + *

App Mesh supports microservice applications that use service discovery + * naming for their components. For more information about service discovery on Amazon ECS, see Service + * Discovery in the Amazon Elastic Container Service Developer Guide. Kubernetes + * kube-dns and coredns are supported. For more information, + * see DNS + * for Services and Pods in the Kubernetes documentation.

+ *
+ */ +export class AppMesh extends AppMeshClient implements AppMesh {} +createAggregatedClient(commands, AppMesh); diff --git a/clients/client-appconfig/src/AppConfig.ts b/clients/client-appconfig/src/AppConfig.ts index 8edd577558f3..b56d996515fe 100644 --- a/clients/client-appconfig/src/AppConfig.ts +++ b/clients/client-appconfig/src/AppConfig.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { AppConfigClient } from "./AppConfigClient"; +import { AppConfigClient, AppConfigClientConfig } from "./AppConfigClient"; import { CreateApplicationCommand, CreateApplicationCommandInput, @@ -214,1589 +215,782 @@ import { ValidateConfigurationCommandOutput, } from "./commands/ValidateConfigurationCommand"; -/** - * @public - *

Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly - * deploy application configurations. AppConfig supports controlled deployments to - * applications of any size and includes built-in validation checks and monitoring. You can - * use AppConfig with applications hosted on Amazon EC2 instances, Lambda, containers, - * mobile applications, or IoT devices.

- *

To prevent errors when deploying application configurations, especially for production - * systems where a simple typo could cause an unexpected outage, AppConfig includes - * validators. A validator provides a syntactic or semantic check to ensure that the - * configuration you want to deploy works as intended. To validate your application - * configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against - * the configuration. The configuration deployment or update can only proceed when the - * configuration data is valid.

- *

During a configuration deployment, AppConfig monitors the application to - * ensure that the deployment is successful. If the system encounters an error, AppConfig rolls back the change to minimize impact for your application users. You can - * configure a deployment strategy for each application or environment that includes - * deployment criteria, including velocity, bake time, and alarms to monitor. Similar to error - * monitoring, if a deployment triggers an alarm, AppConfig automatically rolls back - * to the previous version.

- *

AppConfig supports multiple use cases. Here are some examples:

- *
    - *
  • - *

    - * Feature flags: Use AppConfig to turn on - * new features that require a timely deployment, such as a product launch or - * announcement.

    - *
  • - *
  • - *

    - * Application tuning: Use AppConfig to - * carefully introduce changes to your application that can only be tested with - * production traffic.

    - *
  • - *
  • - *

    - * Allow list: Use AppConfig to allow - * premium subscribers to access paid content.

    - *
  • - *
  • - *

    - * Operational issues: Use AppConfig to - * reduce stress on your application when a dependency or other external factor impacts - * the system.

    - *
  • - *
- *

This reference is intended to be used with the AppConfig User - * Guide.

- */ -export class AppConfig extends AppConfigClient { +const commands = { + CreateApplicationCommand, + CreateConfigurationProfileCommand, + CreateDeploymentStrategyCommand, + CreateEnvironmentCommand, + CreateExtensionCommand, + CreateExtensionAssociationCommand, + CreateHostedConfigurationVersionCommand, + DeleteApplicationCommand, + DeleteConfigurationProfileCommand, + DeleteDeploymentStrategyCommand, + DeleteEnvironmentCommand, + DeleteExtensionCommand, + DeleteExtensionAssociationCommand, + DeleteHostedConfigurationVersionCommand, + GetApplicationCommand, + GetConfigurationCommand, + GetConfigurationProfileCommand, + GetDeploymentCommand, + GetDeploymentStrategyCommand, + GetEnvironmentCommand, + GetExtensionCommand, + GetExtensionAssociationCommand, + GetHostedConfigurationVersionCommand, + ListApplicationsCommand, + ListConfigurationProfilesCommand, + ListDeploymentsCommand, + ListDeploymentStrategiesCommand, + ListEnvironmentsCommand, + ListExtensionAssociationsCommand, + ListExtensionsCommand, + ListHostedConfigurationVersionsCommand, + ListTagsForResourceCommand, + StartDeploymentCommand, + StopDeploymentCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateApplicationCommand, + UpdateConfigurationProfileCommand, + UpdateDeploymentStrategyCommand, + UpdateEnvironmentCommand, + UpdateExtensionCommand, + UpdateExtensionAssociationCommand, + ValidateConfigurationCommand, +}; + +export interface AppConfig { /** - * @public - *

Creates an application. In AppConfig, an application is simply an - * organizational construct like a folder. This organizational construct has a relationship - * with some unit of executable code. For example, you could create an application called - * MyMobileApp to organize and manage configuration data for a mobile application installed by - * your users.

+ * @see {@link CreateApplicationCommand} */ - public createApplication( + createApplication( args: CreateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApplication( + createApplication( args: CreateApplicationCommandInput, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( + createApplication( args: CreateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( - args: CreateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApplicationCommandOutput) => void), - cb?: (err: any, data?: CreateApplicationCommandOutput) => void - ): Promise | void { - const command = new CreateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a configuration profile, which is information that enables AppConfig - * to access the configuration source. Valid configuration sources include the - * following:

- *
    - *
  • - *

    Configuration data in YAML, JSON, and other formats stored in the AppConfig hosted configuration store

    - *
  • - *
  • - *

    Configuration data stored as objects in an Amazon Simple Storage Service (Amazon S3) - * bucket

    - *
  • - *
  • - *

    Pipelines stored in CodePipeline

    - *
  • - *
  • - *

    Secrets stored in Secrets Manager

    - *
  • - *
  • - *

    Standard and secure string parameters stored in Amazon Web Services Systems Manager Parameter Store

    - *
  • - *
  • - *

    Configuration data in SSM documents stored in the Systems Manager document store

    - *
  • - *
- *

A configuration profile includes the following information:

- *
    - *
  • - *

    The URI location of the configuration data.

    - *
  • - *
  • - *

    The Identity and Access Management (IAM) role that provides access to the configuration data.

    - *
  • - *
  • - *

    A validator for the configuration data. Available validators include either a JSON - * Schema or an Amazon Web Services Lambda function.

    - *
  • - *
- *

For more information, see Create a - * Configuration and a Configuration Profile in the AppConfig - * User Guide.

+ * @see {@link CreateConfigurationProfileCommand} */ - public createConfigurationProfile( + createConfigurationProfile( args: CreateConfigurationProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConfigurationProfile( + createConfigurationProfile( args: CreateConfigurationProfileCommandInput, cb: (err: any, data?: CreateConfigurationProfileCommandOutput) => void ): void; - public createConfigurationProfile( + createConfigurationProfile( args: CreateConfigurationProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfigurationProfileCommandOutput) => void ): void; - public createConfigurationProfile( - args: CreateConfigurationProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConfigurationProfileCommandOutput) => void), - cb?: (err: any, data?: CreateConfigurationProfileCommandOutput) => void - ): Promise | void { - const command = new CreateConfigurationProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a deployment strategy that defines important criteria for rolling out your - * configuration to the designated targets. A deployment strategy includes the overall - * duration required, a percentage of targets to receive the deployment during each interval, - * an algorithm that defines how percentage grows, and bake time.

+ * @see {@link CreateDeploymentStrategyCommand} */ - public createDeploymentStrategy( + createDeploymentStrategy( args: CreateDeploymentStrategyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDeploymentStrategy( + createDeploymentStrategy( args: CreateDeploymentStrategyCommandInput, cb: (err: any, data?: CreateDeploymentStrategyCommandOutput) => void ): void; - public createDeploymentStrategy( + createDeploymentStrategy( args: CreateDeploymentStrategyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeploymentStrategyCommandOutput) => void ): void; - public createDeploymentStrategy( - args: CreateDeploymentStrategyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDeploymentStrategyCommandOutput) => void), - cb?: (err: any, data?: CreateDeploymentStrategyCommandOutput) => void - ): Promise | void { - const command = new CreateDeploymentStrategyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an environment. For each application, you define one or more environments. An - * environment is a deployment group of AppConfig targets, such as applications in a - * Beta or Production environment. You can also define - * environments for application subcomponents such as the Web, - * Mobile and Back-end components for your application. You can - * configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a - * configuration deployment. If an alarm is triggered, the system rolls back the - * configuration.

+ * @see {@link CreateEnvironmentCommand} */ - public createEnvironment( + createEnvironment( args: CreateEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEnvironment( + createEnvironment( args: CreateEnvironmentCommandInput, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void ): void; - public createEnvironment( + createEnvironment( args: CreateEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void ): void; - public createEnvironment( - args: CreateEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEnvironmentCommandOutput) => void), - cb?: (err: any, data?: CreateEnvironmentCommandOutput) => void - ): Promise | void { - const command = new CreateEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an AppConfig extension. An extension augments your ability to inject - * logic or behavior at different points during the AppConfig workflow of creating - * or deploying a configuration.

- *

You can create your own extensions or use the Amazon Web Services authored extensions provided by - * AppConfig. For most use cases, to create your own extension, you must create - * an Lambda function to perform any computation and processing defined in the - * extension. For more information about extensions, see Working with - * AppConfig extensions in the - * AppConfig User Guide.

+ * @see {@link CreateExtensionCommand} */ - public createExtension( + createExtension( args: CreateExtensionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createExtension( - args: CreateExtensionCommandInput, - cb: (err: any, data?: CreateExtensionCommandOutput) => void - ): void; - public createExtension( + createExtension(args: CreateExtensionCommandInput, cb: (err: any, data?: CreateExtensionCommandOutput) => void): void; + createExtension( args: CreateExtensionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExtensionCommandOutput) => void ): void; - public createExtension( - args: CreateExtensionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateExtensionCommandOutput) => void), - cb?: (err: any, data?: CreateExtensionCommandOutput) => void - ): Promise | void { - const command = new CreateExtensionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

When you create an extension or configure an Amazon Web Services authored extension, you - * associate the extension with an AppConfig application, environment, or - * configuration profile. For example, you can choose to run the AppConfig - * deployment events to Amazon SNS - * Amazon Web Services authored extension and receive notifications on an Amazon SNS - * topic anytime a configuration deployment is started for a specific application. Defining - * which extension to associate with an AppConfig resource is called an - * extension association. An extension association is a specified - * relationship between an extension and an AppConfig resource, such as an - * application or a configuration profile. For more information about extensions and - * associations, see Working with - * AppConfig extensions in the - * AppConfig User Guide.

+ * @see {@link CreateExtensionAssociationCommand} */ - public createExtensionAssociation( + createExtensionAssociation( args: CreateExtensionAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createExtensionAssociation( + createExtensionAssociation( args: CreateExtensionAssociationCommandInput, cb: (err: any, data?: CreateExtensionAssociationCommandOutput) => void ): void; - public createExtensionAssociation( + createExtensionAssociation( args: CreateExtensionAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExtensionAssociationCommandOutput) => void ): void; - public createExtensionAssociation( - args: CreateExtensionAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateExtensionAssociationCommandOutput) => void), - cb?: (err: any, data?: CreateExtensionAssociationCommandOutput) => void - ): Promise | void { - const command = new CreateExtensionAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new configuration in the AppConfig hosted configuration - * store.

+ * @see {@link CreateHostedConfigurationVersionCommand} */ - public createHostedConfigurationVersion( + createHostedConfigurationVersion( args: CreateHostedConfigurationVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createHostedConfigurationVersion( + createHostedConfigurationVersion( args: CreateHostedConfigurationVersionCommandInput, cb: (err: any, data?: CreateHostedConfigurationVersionCommandOutput) => void ): void; - public createHostedConfigurationVersion( + createHostedConfigurationVersion( args: CreateHostedConfigurationVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHostedConfigurationVersionCommandOutput) => void ): void; - public createHostedConfigurationVersion( - args: CreateHostedConfigurationVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateHostedConfigurationVersionCommandOutput) => void), - cb?: (err: any, data?: CreateHostedConfigurationVersionCommandOutput) => void - ): Promise | void { - const command = new CreateHostedConfigurationVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an application. Deleting an application does not delete a configuration from a - * host.

+ * @see {@link DeleteApplicationCommand} */ - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( - args: DeleteApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApplicationCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a configuration profile. Deleting a configuration profile does not delete a - * configuration from a host.

+ * @see {@link DeleteConfigurationProfileCommand} */ - public deleteConfigurationProfile( + deleteConfigurationProfile( args: DeleteConfigurationProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConfigurationProfile( + deleteConfigurationProfile( args: DeleteConfigurationProfileCommandInput, cb: (err: any, data?: DeleteConfigurationProfileCommandOutput) => void ): void; - public deleteConfigurationProfile( + deleteConfigurationProfile( args: DeleteConfigurationProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationProfileCommandOutput) => void ): void; - public deleteConfigurationProfile( - args: DeleteConfigurationProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConfigurationProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteConfigurationProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteConfigurationProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a deployment strategy. Deleting a deployment strategy does not delete a - * configuration from a host.

+ * @see {@link DeleteDeploymentStrategyCommand} */ - public deleteDeploymentStrategy( + deleteDeploymentStrategy( args: DeleteDeploymentStrategyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDeploymentStrategy( + deleteDeploymentStrategy( args: DeleteDeploymentStrategyCommandInput, cb: (err: any, data?: DeleteDeploymentStrategyCommandOutput) => void ): void; - public deleteDeploymentStrategy( + deleteDeploymentStrategy( args: DeleteDeploymentStrategyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDeploymentStrategyCommandOutput) => void ): void; - public deleteDeploymentStrategy( - args: DeleteDeploymentStrategyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDeploymentStrategyCommandOutput) => void), - cb?: (err: any, data?: DeleteDeploymentStrategyCommandOutput) => void - ): Promise | void { - const command = new DeleteDeploymentStrategyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an environment. Deleting an environment does not delete a configuration from a - * host.

+ * @see {@link DeleteEnvironmentCommand} */ - public deleteEnvironment( + deleteEnvironment( args: DeleteEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEnvironment( + deleteEnvironment( args: DeleteEnvironmentCommandInput, cb: (err: any, data?: DeleteEnvironmentCommandOutput) => void ): void; - public deleteEnvironment( + deleteEnvironment( args: DeleteEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEnvironmentCommandOutput) => void ): void; - public deleteEnvironment( - args: DeleteEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEnvironmentCommandOutput) => void), - cb?: (err: any, data?: DeleteEnvironmentCommandOutput) => void - ): Promise | void { - const command = new DeleteEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an AppConfig extension. You must delete all associations to an - * extension before you delete the extension.

+ * @see {@link DeleteExtensionCommand} */ - public deleteExtension( + deleteExtension( args: DeleteExtensionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteExtension( - args: DeleteExtensionCommandInput, - cb: (err: any, data?: DeleteExtensionCommandOutput) => void - ): void; - public deleteExtension( + deleteExtension(args: DeleteExtensionCommandInput, cb: (err: any, data?: DeleteExtensionCommandOutput) => void): void; + deleteExtension( args: DeleteExtensionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteExtensionCommandOutput) => void ): void; - public deleteExtension( - args: DeleteExtensionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteExtensionCommandOutput) => void), - cb?: (err: any, data?: DeleteExtensionCommandOutput) => void - ): Promise | void { - const command = new DeleteExtensionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an extension association. This action doesn't delete extensions defined in the - * association.

+ * @see {@link DeleteExtensionAssociationCommand} */ - public deleteExtensionAssociation( + deleteExtensionAssociation( args: DeleteExtensionAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteExtensionAssociation( + deleteExtensionAssociation( args: DeleteExtensionAssociationCommandInput, cb: (err: any, data?: DeleteExtensionAssociationCommandOutput) => void ): void; - public deleteExtensionAssociation( + deleteExtensionAssociation( args: DeleteExtensionAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteExtensionAssociationCommandOutput) => void ): void; - public deleteExtensionAssociation( - args: DeleteExtensionAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteExtensionAssociationCommandOutput) => void), - cb?: (err: any, data?: DeleteExtensionAssociationCommandOutput) => void - ): Promise | void { - const command = new DeleteExtensionAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a version of a configuration from the AppConfig hosted configuration - * store.

+ * @see {@link DeleteHostedConfigurationVersionCommand} */ - public deleteHostedConfigurationVersion( + deleteHostedConfigurationVersion( args: DeleteHostedConfigurationVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteHostedConfigurationVersion( + deleteHostedConfigurationVersion( args: DeleteHostedConfigurationVersionCommandInput, cb: (err: any, data?: DeleteHostedConfigurationVersionCommandOutput) => void ): void; - public deleteHostedConfigurationVersion( + deleteHostedConfigurationVersion( args: DeleteHostedConfigurationVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHostedConfigurationVersionCommandOutput) => void ): void; - public deleteHostedConfigurationVersion( - args: DeleteHostedConfigurationVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteHostedConfigurationVersionCommandOutput) => void), - cb?: (err: any, data?: DeleteHostedConfigurationVersionCommandOutput) => void - ): Promise | void { - const command = new DeleteHostedConfigurationVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about an application.

+ * @see {@link GetApplicationCommand} */ - public getApplication( + getApplication( args: GetApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getApplication( - args: GetApplicationCommandInput, - cb: (err: any, data?: GetApplicationCommandOutput) => void - ): void; - public getApplication( + getApplication(args: GetApplicationCommandInput, cb: (err: any, data?: GetApplicationCommandOutput) => void): void; + getApplication( args: GetApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApplicationCommandOutput) => void ): void; - public getApplication( - args: GetApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApplicationCommandOutput) => void), - cb?: (err: any, data?: GetApplicationCommandOutput) => void - ): Promise | void { - const command = new GetApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

(Deprecated) Retrieves the latest deployed configuration.

- * - *

Note the following important information.

- * - *
+ * @see {@link GetConfigurationCommand} */ - public getConfiguration( + getConfiguration( args: GetConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConfiguration( + getConfiguration( args: GetConfigurationCommandInput, cb: (err: any, data?: GetConfigurationCommandOutput) => void ): void; - public getConfiguration( + getConfiguration( args: GetConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConfigurationCommandOutput) => void ): void; - public getConfiguration( - args: GetConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a configuration profile.

+ * @see {@link GetConfigurationProfileCommand} */ - public getConfigurationProfile( + getConfigurationProfile( args: GetConfigurationProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConfigurationProfile( + getConfigurationProfile( args: GetConfigurationProfileCommandInput, cb: (err: any, data?: GetConfigurationProfileCommandOutput) => void ): void; - public getConfigurationProfile( + getConfigurationProfile( args: GetConfigurationProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConfigurationProfileCommandOutput) => void ): void; - public getConfigurationProfile( - args: GetConfigurationProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConfigurationProfileCommandOutput) => void), - cb?: (err: any, data?: GetConfigurationProfileCommandOutput) => void - ): Promise | void { - const command = new GetConfigurationProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a configuration deployment.

+ * @see {@link GetDeploymentCommand} */ - public getDeployment( - args: GetDeploymentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getDeployment( - args: GetDeploymentCommandInput, - cb: (err: any, data?: GetDeploymentCommandOutput) => void - ): void; - public getDeployment( + getDeployment(args: GetDeploymentCommandInput, options?: __HttpHandlerOptions): Promise; + getDeployment(args: GetDeploymentCommandInput, cb: (err: any, data?: GetDeploymentCommandOutput) => void): void; + getDeployment( args: GetDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeploymentCommandOutput) => void ): void; - public getDeployment( - args: GetDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeploymentCommandOutput) => void), - cb?: (err: any, data?: GetDeploymentCommandOutput) => void - ): Promise | void { - const command = new GetDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a deployment strategy. A deployment strategy defines - * important criteria for rolling out your configuration to the designated targets. A - * deployment strategy includes the overall duration required, a percentage of targets to - * receive the deployment during each interval, an algorithm that defines how percentage - * grows, and bake time.

+ * @see {@link GetDeploymentStrategyCommand} */ - public getDeploymentStrategy( + getDeploymentStrategy( args: GetDeploymentStrategyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDeploymentStrategy( + getDeploymentStrategy( args: GetDeploymentStrategyCommandInput, cb: (err: any, data?: GetDeploymentStrategyCommandOutput) => void ): void; - public getDeploymentStrategy( + getDeploymentStrategy( args: GetDeploymentStrategyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeploymentStrategyCommandOutput) => void ): void; - public getDeploymentStrategy( - args: GetDeploymentStrategyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeploymentStrategyCommandOutput) => void), - cb?: (err: any, data?: GetDeploymentStrategyCommandOutput) => void - ): Promise | void { - const command = new GetDeploymentStrategyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about an environment. An environment is a deployment group of - * AppConfig applications, such as applications in a Production - * environment or in an EU_Region environment. Each configuration deployment - * targets an environment. You can enable one or more Amazon CloudWatch alarms for an environment. If - * an alarm is triggered during a deployment, AppConfig roles back the - * configuration.

+ * @see {@link GetEnvironmentCommand} */ - public getEnvironment( + getEnvironment( args: GetEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEnvironment( - args: GetEnvironmentCommandInput, - cb: (err: any, data?: GetEnvironmentCommandOutput) => void - ): void; - public getEnvironment( + getEnvironment(args: GetEnvironmentCommandInput, cb: (err: any, data?: GetEnvironmentCommandOutput) => void): void; + getEnvironment( args: GetEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEnvironmentCommandOutput) => void ): void; - public getEnvironment( - args: GetEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEnvironmentCommandOutput) => void), - cb?: (err: any, data?: GetEnvironmentCommandOutput) => void - ): Promise | void { - const command = new GetEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about an AppConfig extension.

+ * @see {@link GetExtensionCommand} */ - public getExtension( - args: GetExtensionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getExtension(args: GetExtensionCommandInput, cb: (err: any, data?: GetExtensionCommandOutput) => void): void; - public getExtension( + getExtension(args: GetExtensionCommandInput, options?: __HttpHandlerOptions): Promise; + getExtension(args: GetExtensionCommandInput, cb: (err: any, data?: GetExtensionCommandOutput) => void): void; + getExtension( args: GetExtensionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExtensionCommandOutput) => void ): void; - public getExtension( - args: GetExtensionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetExtensionCommandOutput) => void), - cb?: (err: any, data?: GetExtensionCommandOutput) => void - ): Promise | void { - const command = new GetExtensionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about an AppConfig extension association. For more - * information about extensions and associations, see Working with - * AppConfig extensions in the - * AppConfig User Guide.

+ * @see {@link GetExtensionAssociationCommand} */ - public getExtensionAssociation( + getExtensionAssociation( args: GetExtensionAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getExtensionAssociation( + getExtensionAssociation( args: GetExtensionAssociationCommandInput, cb: (err: any, data?: GetExtensionAssociationCommandOutput) => void ): void; - public getExtensionAssociation( + getExtensionAssociation( args: GetExtensionAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExtensionAssociationCommandOutput) => void ): void; - public getExtensionAssociation( - args: GetExtensionAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetExtensionAssociationCommandOutput) => void), - cb?: (err: any, data?: GetExtensionAssociationCommandOutput) => void - ): Promise | void { - const command = new GetExtensionAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a specific configuration version.

+ * @see {@link GetHostedConfigurationVersionCommand} */ - public getHostedConfigurationVersion( + getHostedConfigurationVersion( args: GetHostedConfigurationVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getHostedConfigurationVersion( + getHostedConfigurationVersion( args: GetHostedConfigurationVersionCommandInput, cb: (err: any, data?: GetHostedConfigurationVersionCommandOutput) => void ): void; - public getHostedConfigurationVersion( + getHostedConfigurationVersion( args: GetHostedConfigurationVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHostedConfigurationVersionCommandOutput) => void ): void; - public getHostedConfigurationVersion( - args: GetHostedConfigurationVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetHostedConfigurationVersionCommandOutput) => void), - cb?: (err: any, data?: GetHostedConfigurationVersionCommandOutput) => void - ): Promise | void { - const command = new GetHostedConfigurationVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all applications in your Amazon Web Services account.

+ * @see {@link ListApplicationsCommand} */ - public listApplications( + listApplications( args: ListApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplications( + listApplications( args: ListApplicationsCommandInput, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( + listApplications( args: ListApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( - args: ListApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationsCommandOutput) => void), - cb?: (err: any, data?: ListApplicationsCommandOutput) => void - ): Promise | void { - const command = new ListApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the configuration profiles for an application.

+ * @see {@link ListConfigurationProfilesCommand} */ - public listConfigurationProfiles( + listConfigurationProfiles( args: ListConfigurationProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConfigurationProfiles( + listConfigurationProfiles( args: ListConfigurationProfilesCommandInput, cb: (err: any, data?: ListConfigurationProfilesCommandOutput) => void ): void; - public listConfigurationProfiles( + listConfigurationProfiles( args: ListConfigurationProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConfigurationProfilesCommandOutput) => void ): void; - public listConfigurationProfiles( - args: ListConfigurationProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConfigurationProfilesCommandOutput) => void), - cb?: (err: any, data?: ListConfigurationProfilesCommandOutput) => void - ): Promise | void { - const command = new ListConfigurationProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the deployments for an environment in descending deployment number order.

+ * @see {@link ListDeploymentsCommand} */ - public listDeployments( + listDeployments( args: ListDeploymentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeployments( - args: ListDeploymentsCommandInput, - cb: (err: any, data?: ListDeploymentsCommandOutput) => void - ): void; - public listDeployments( + listDeployments(args: ListDeploymentsCommandInput, cb: (err: any, data?: ListDeploymentsCommandOutput) => void): void; + listDeployments( args: ListDeploymentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeploymentsCommandOutput) => void ): void; - public listDeployments( - args: ListDeploymentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeploymentsCommandOutput) => void), - cb?: (err: any, data?: ListDeploymentsCommandOutput) => void - ): Promise | void { - const command = new ListDeploymentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists deployment strategies.

+ * @see {@link ListDeploymentStrategiesCommand} */ - public listDeploymentStrategies( + listDeploymentStrategies( args: ListDeploymentStrategiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeploymentStrategies( + listDeploymentStrategies( args: ListDeploymentStrategiesCommandInput, cb: (err: any, data?: ListDeploymentStrategiesCommandOutput) => void ): void; - public listDeploymentStrategies( + listDeploymentStrategies( args: ListDeploymentStrategiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeploymentStrategiesCommandOutput) => void ): void; - public listDeploymentStrategies( - args: ListDeploymentStrategiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeploymentStrategiesCommandOutput) => void), - cb?: (err: any, data?: ListDeploymentStrategiesCommandOutput) => void - ): Promise | void { - const command = new ListDeploymentStrategiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the environments for an application.

+ * @see {@link ListEnvironmentsCommand} */ - public listEnvironments( + listEnvironments( args: ListEnvironmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEnvironments( + listEnvironments( args: ListEnvironmentsCommandInput, cb: (err: any, data?: ListEnvironmentsCommandOutput) => void ): void; - public listEnvironments( + listEnvironments( args: ListEnvironmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnvironmentsCommandOutput) => void ): void; - public listEnvironments( - args: ListEnvironmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEnvironmentsCommandOutput) => void), - cb?: (err: any, data?: ListEnvironmentsCommandOutput) => void - ): Promise | void { - const command = new ListEnvironmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all AppConfig extension associations in the account. For more - * information about extensions and associations, see Working with - * AppConfig extensions in the - * AppConfig User Guide.

+ * @see {@link ListExtensionAssociationsCommand} */ - public listExtensionAssociations( + listExtensionAssociations( args: ListExtensionAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listExtensionAssociations( + listExtensionAssociations( args: ListExtensionAssociationsCommandInput, cb: (err: any, data?: ListExtensionAssociationsCommandOutput) => void ): void; - public listExtensionAssociations( + listExtensionAssociations( args: ListExtensionAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExtensionAssociationsCommandOutput) => void ): void; - public listExtensionAssociations( - args: ListExtensionAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListExtensionAssociationsCommandOutput) => void), - cb?: (err: any, data?: ListExtensionAssociationsCommandOutput) => void - ): Promise | void { - const command = new ListExtensionAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all custom and Amazon Web Services authored AppConfig extensions in the - * account. For more information about extensions, see Working with - * AppConfig extensions in the - * AppConfig User Guide.

+ * @see {@link ListExtensionsCommand} */ - public listExtensions( + listExtensions( args: ListExtensionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listExtensions( - args: ListExtensionsCommandInput, - cb: (err: any, data?: ListExtensionsCommandOutput) => void - ): void; - public listExtensions( + listExtensions(args: ListExtensionsCommandInput, cb: (err: any, data?: ListExtensionsCommandOutput) => void): void; + listExtensions( args: ListExtensionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExtensionsCommandOutput) => void ): void; - public listExtensions( - args: ListExtensionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListExtensionsCommandOutput) => void), - cb?: (err: any, data?: ListExtensionsCommandOutput) => void - ): Promise | void { - const command = new ListExtensionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists configurations stored in the AppConfig hosted configuration store by - * version.

+ * @see {@link ListHostedConfigurationVersionsCommand} */ - public listHostedConfigurationVersions( + listHostedConfigurationVersions( args: ListHostedConfigurationVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listHostedConfigurationVersions( + listHostedConfigurationVersions( args: ListHostedConfigurationVersionsCommandInput, cb: (err: any, data?: ListHostedConfigurationVersionsCommandOutput) => void ): void; - public listHostedConfigurationVersions( + listHostedConfigurationVersions( args: ListHostedConfigurationVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHostedConfigurationVersionsCommandOutput) => void ): void; - public listHostedConfigurationVersions( - args: ListHostedConfigurationVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListHostedConfigurationVersionsCommandOutput) => void), - cb?: (err: any, data?: ListHostedConfigurationVersionsCommandOutput) => void - ): Promise | void { - const command = new ListHostedConfigurationVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the list of key-value tags assigned to the resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a deployment.

+ * @see {@link StartDeploymentCommand} */ - public startDeployment( + startDeployment( args: StartDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDeployment( - args: StartDeploymentCommandInput, - cb: (err: any, data?: StartDeploymentCommandOutput) => void - ): void; - public startDeployment( + startDeployment(args: StartDeploymentCommandInput, cb: (err: any, data?: StartDeploymentCommandOutput) => void): void; + startDeployment( args: StartDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDeploymentCommandOutput) => void ): void; - public startDeployment( - args: StartDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDeploymentCommandOutput) => void), - cb?: (err: any, data?: StartDeploymentCommandOutput) => void - ): Promise | void { - const command = new StartDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops a deployment. This API action works only on deployments that have a status of - * DEPLOYING. This action moves the deployment to a status of - * ROLLED_BACK.

+ * @see {@link StopDeploymentCommand} */ - public stopDeployment( + stopDeployment( args: StopDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopDeployment( - args: StopDeploymentCommandInput, - cb: (err: any, data?: StopDeploymentCommandOutput) => void - ): void; - public stopDeployment( + stopDeployment(args: StopDeploymentCommandInput, cb: (err: any, data?: StopDeploymentCommandOutput) => void): void; + stopDeployment( args: StopDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDeploymentCommandOutput) => void ): void; - public stopDeployment( - args: StopDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopDeploymentCommandOutput) => void), - cb?: (err: any, data?: StopDeploymentCommandOutput) => void - ): Promise | void { - const command = new StopDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns metadata to an AppConfig resource. Tags help organize and categorize - * your AppConfig resources. Each tag consists of a key and an optional value, both - * of which you define. You can specify a maximum of 50 tags for a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a tag key and value from an AppConfig resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an application.

+ * @see {@link UpdateApplicationCommand} */ - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( - args: UpdateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApplicationCommandOutput) => void), - cb?: (err: any, data?: UpdateApplicationCommandOutput) => void - ): Promise | void { - const command = new UpdateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a configuration profile.

+ * @see {@link UpdateConfigurationProfileCommand} */ - public updateConfigurationProfile( + updateConfigurationProfile( args: UpdateConfigurationProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConfigurationProfile( + updateConfigurationProfile( args: UpdateConfigurationProfileCommandInput, cb: (err: any, data?: UpdateConfigurationProfileCommandOutput) => void ): void; - public updateConfigurationProfile( + updateConfigurationProfile( args: UpdateConfigurationProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConfigurationProfileCommandOutput) => void ): void; - public updateConfigurationProfile( - args: UpdateConfigurationProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConfigurationProfileCommandOutput) => void), - cb?: (err: any, data?: UpdateConfigurationProfileCommandOutput) => void - ): Promise | void { - const command = new UpdateConfigurationProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a deployment strategy.

+ * @see {@link UpdateDeploymentStrategyCommand} */ - public updateDeploymentStrategy( + updateDeploymentStrategy( args: UpdateDeploymentStrategyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDeploymentStrategy( + updateDeploymentStrategy( args: UpdateDeploymentStrategyCommandInput, cb: (err: any, data?: UpdateDeploymentStrategyCommandOutput) => void ): void; - public updateDeploymentStrategy( + updateDeploymentStrategy( args: UpdateDeploymentStrategyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDeploymentStrategyCommandOutput) => void ): void; - public updateDeploymentStrategy( - args: UpdateDeploymentStrategyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDeploymentStrategyCommandOutput) => void), - cb?: (err: any, data?: UpdateDeploymentStrategyCommandOutput) => void - ): Promise | void { - const command = new UpdateDeploymentStrategyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an environment.

+ * @see {@link UpdateEnvironmentCommand} */ - public updateEnvironment( + updateEnvironment( args: UpdateEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEnvironment( + updateEnvironment( args: UpdateEnvironmentCommandInput, cb: (err: any, data?: UpdateEnvironmentCommandOutput) => void ): void; - public updateEnvironment( + updateEnvironment( args: UpdateEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEnvironmentCommandOutput) => void ): void; - public updateEnvironment( - args: UpdateEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEnvironmentCommandOutput) => void), - cb?: (err: any, data?: UpdateEnvironmentCommandOutput) => void - ): Promise | void { - const command = new UpdateEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an AppConfig extension. For more information about extensions, see - * Working with - * AppConfig extensions in the - * AppConfig User Guide.

+ * @see {@link UpdateExtensionCommand} */ - public updateExtension( + updateExtension( args: UpdateExtensionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateExtension( - args: UpdateExtensionCommandInput, - cb: (err: any, data?: UpdateExtensionCommandOutput) => void - ): void; - public updateExtension( + updateExtension(args: UpdateExtensionCommandInput, cb: (err: any, data?: UpdateExtensionCommandOutput) => void): void; + updateExtension( args: UpdateExtensionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateExtensionCommandOutput) => void ): void; - public updateExtension( - args: UpdateExtensionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateExtensionCommandOutput) => void), - cb?: (err: any, data?: UpdateExtensionCommandOutput) => void - ): Promise | void { - const command = new UpdateExtensionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an association. For more information about extensions and associations, see - * Working with - * AppConfig extensions in the - * AppConfig User Guide.

+ * @see {@link UpdateExtensionAssociationCommand} */ - public updateExtensionAssociation( + updateExtensionAssociation( args: UpdateExtensionAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateExtensionAssociation( + updateExtensionAssociation( args: UpdateExtensionAssociationCommandInput, cb: (err: any, data?: UpdateExtensionAssociationCommandOutput) => void ): void; - public updateExtensionAssociation( + updateExtensionAssociation( args: UpdateExtensionAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateExtensionAssociationCommandOutput) => void ): void; - public updateExtensionAssociation( - args: UpdateExtensionAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateExtensionAssociationCommandOutput) => void), - cb?: (err: any, data?: UpdateExtensionAssociationCommandOutput) => void - ): Promise | void { - const command = new UpdateExtensionAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Uses the validators in a configuration profile to validate a configuration.

+ * @see {@link ValidateConfigurationCommand} */ - public validateConfiguration( + validateConfiguration( args: ValidateConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public validateConfiguration( + validateConfiguration( args: ValidateConfigurationCommandInput, cb: (err: any, data?: ValidateConfigurationCommandOutput) => void ): void; - public validateConfiguration( + validateConfiguration( args: ValidateConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidateConfigurationCommandOutput) => void ): void; - public validateConfiguration( - args: ValidateConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ValidateConfigurationCommandOutput) => void), - cb?: (err: any, data?: ValidateConfigurationCommandOutput) => void - ): Promise | void { - const command = new ValidateConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly + * deploy application configurations. AppConfig supports controlled deployments to + * applications of any size and includes built-in validation checks and monitoring. You can + * use AppConfig with applications hosted on Amazon EC2 instances, Lambda, containers, + * mobile applications, or IoT devices.

+ *

To prevent errors when deploying application configurations, especially for production + * systems where a simple typo could cause an unexpected outage, AppConfig includes + * validators. A validator provides a syntactic or semantic check to ensure that the + * configuration you want to deploy works as intended. To validate your application + * configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against + * the configuration. The configuration deployment or update can only proceed when the + * configuration data is valid.

+ *

During a configuration deployment, AppConfig monitors the application to + * ensure that the deployment is successful. If the system encounters an error, AppConfig rolls back the change to minimize impact for your application users. You can + * configure a deployment strategy for each application or environment that includes + * deployment criteria, including velocity, bake time, and alarms to monitor. Similar to error + * monitoring, if a deployment triggers an alarm, AppConfig automatically rolls back + * to the previous version.

+ *

AppConfig supports multiple use cases. Here are some examples:

+ *
    + *
  • + *

    + * Feature flags: Use AppConfig to turn on + * new features that require a timely deployment, such as a product launch or + * announcement.

    + *
  • + *
  • + *

    + * Application tuning: Use AppConfig to + * carefully introduce changes to your application that can only be tested with + * production traffic.

    + *
  • + *
  • + *

    + * Allow list: Use AppConfig to allow + * premium subscribers to access paid content.

    + *
  • + *
  • + *

    + * Operational issues: Use AppConfig to + * reduce stress on your application when a dependency or other external factor impacts + * the system.

    + *
  • + *
+ *

This reference is intended to be used with the AppConfig User + * Guide.

+ */ +export class AppConfig extends AppConfigClient implements AppConfig {} +createAggregatedClient(commands, AppConfig); diff --git a/clients/client-appconfigdata/src/AppConfigData.ts b/clients/client-appconfigdata/src/AppConfigData.ts index d1f5ff3666de..89d160b18299 100644 --- a/clients/client-appconfigdata/src/AppConfigData.ts +++ b/clients/client-appconfigdata/src/AppConfigData.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { AppConfigDataClient } from "./AppConfigDataClient"; +import { AppConfigDataClient, AppConfigDataClientConfig } from "./AppConfigDataClient"; import { GetLatestConfigurationCommand, GetLatestConfigurationCommandInput, @@ -13,6 +14,47 @@ import { StartConfigurationSessionCommandOutput, } from "./commands/StartConfigurationSessionCommand"; +const commands = { + GetLatestConfigurationCommand, + StartConfigurationSessionCommand, +}; + +export interface AppConfigData { + /** + * @see {@link GetLatestConfigurationCommand} + */ + getLatestConfiguration( + args: GetLatestConfigurationCommandInput, + options?: __HttpHandlerOptions + ): Promise; + getLatestConfiguration( + args: GetLatestConfigurationCommandInput, + cb: (err: any, data?: GetLatestConfigurationCommandOutput) => void + ): void; + getLatestConfiguration( + args: GetLatestConfigurationCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: GetLatestConfigurationCommandOutput) => void + ): void; + + /** + * @see {@link StartConfigurationSessionCommand} + */ + startConfigurationSession( + args: StartConfigurationSessionCommandInput, + options?: __HttpHandlerOptions + ): Promise; + startConfigurationSession( + args: StartConfigurationSessionCommandInput, + cb: (err: any, data?: StartConfigurationSessionCommandOutput) => void + ): void; + startConfigurationSession( + args: StartConfigurationSessionCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: StartConfigurationSessionCommandOutput) => void + ): void; +} + /** * @public *

AppConfig Data provides the data plane APIs your application uses to retrieve @@ -75,93 +117,5 @@ import { * GetLatestConfiguration API actions, see Retrieving the * configuration in the AppConfig User Guide.

*/ -export class AppConfigData extends AppConfigDataClient { - /** - * @public - *

Retrieves the latest deployed configuration. This API may return empty configuration - * data if the client already has the latest version. For more information about this API - * action and to view example CLI commands that show how to use it with the StartConfigurationSession API action, see Retrieving the - * configuration in the AppConfig User Guide.

- * - *

Note the following important information.

- *
    - *
  • - *

    Each configuration token is only valid for one call to - * GetLatestConfiguration. The GetLatestConfiguration - * response includes a NextPollConfigurationToken that should always - * replace the token used for the just-completed call in preparation for the next - * one.

    - *
  • - *
  • - *

    - * GetLatestConfiguration is a priced call. For more information, see - * Pricing.

    - *
  • - *
- *
- */ - public getLatestConfiguration( - args: GetLatestConfigurationCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getLatestConfiguration( - args: GetLatestConfigurationCommandInput, - cb: (err: any, data?: GetLatestConfigurationCommandOutput) => void - ): void; - public getLatestConfiguration( - args: GetLatestConfigurationCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: GetLatestConfigurationCommandOutput) => void - ): void; - public getLatestConfiguration( - args: GetLatestConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLatestConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetLatestConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetLatestConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a configuration session used to retrieve a deployed configuration. For more - * information about this API action and to view example CLI commands that show how to use - * it with the GetLatestConfiguration API action, see Retrieving the - * configuration in the AppConfig User Guide.

- */ - public startConfigurationSession( - args: StartConfigurationSessionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public startConfigurationSession( - args: StartConfigurationSessionCommandInput, - cb: (err: any, data?: StartConfigurationSessionCommandOutput) => void - ): void; - public startConfigurationSession( - args: StartConfigurationSessionCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: StartConfigurationSessionCommandOutput) => void - ): void; - public startConfigurationSession( - args: StartConfigurationSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartConfigurationSessionCommandOutput) => void), - cb?: (err: any, data?: StartConfigurationSessionCommandOutput) => void - ): Promise | void { - const command = new StartConfigurationSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } -} +export class AppConfigData extends AppConfigDataClient implements AppConfigData {} +createAggregatedClient(commands, AppConfigData); diff --git a/clients/client-appflow/src/Appflow.ts b/clients/client-appflow/src/Appflow.ts index be18ee8d996c..004aa016a6cd 100644 --- a/clients/client-appflow/src/Appflow.ts +++ b/clients/client-appflow/src/Appflow.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { AppflowClient } from "./AppflowClient"; +import { AppflowClient, AppflowClientConfig } from "./AppflowClient"; import { CreateConnectorProfileCommand, CreateConnectorProfileCommandInput, @@ -90,795 +91,405 @@ import { } from "./commands/UpdateConnectorRegistrationCommand"; import { UpdateFlowCommand, UpdateFlowCommandInput, UpdateFlowCommandOutput } from "./commands/UpdateFlowCommand"; -/** - * @public - *

Welcome to the Amazon AppFlow API reference. This guide is for developers who need - * detailed information about the Amazon AppFlow API operations, data types, and errors.

- *

Amazon AppFlow is a fully managed integration service that enables you to securely - * transfer data between software as a service (SaaS) applications like Salesforce, Marketo, - * Slack, and ServiceNow, and Amazon Web Services like Amazon S3 and Amazon Redshift.

- *

Use the following links to get started on the Amazon AppFlow API:

- *
    - *
  • - *

    - * Actions: An alphabetical list of all Amazon AppFlow API operations.

    - *
  • - *
  • - *

    - * Data - * types: An alphabetical list of all Amazon AppFlow data types.

    - *
  • - *
  • - *

    - * Common parameters: Parameters that all Query operations can use.

    - *
  • - *
  • - *

    - * Common - * errors: Client and server errors that all operations can return.

    - *
  • - *
- *

If you're new to Amazon AppFlow, we recommend that you review the Amazon AppFlow - * User Guide.

- *

Amazon AppFlow API users can use vendor-specific mechanisms for OAuth, and include - * applicable OAuth attributes (such as auth-code and redirecturi) with - * the connector-specific ConnectorProfileProperties when creating a new connector - * profile using Amazon AppFlow API operations. For example, Salesforce users can refer to - * the - * Authorize Apps with OAuth - * documentation.

- */ -export class Appflow extends AppflowClient { +const commands = { + CreateConnectorProfileCommand, + CreateFlowCommand, + DeleteConnectorProfileCommand, + DeleteFlowCommand, + DescribeConnectorCommand, + DescribeConnectorEntityCommand, + DescribeConnectorProfilesCommand, + DescribeConnectorsCommand, + DescribeFlowCommand, + DescribeFlowExecutionRecordsCommand, + ListConnectorEntitiesCommand, + ListConnectorsCommand, + ListFlowsCommand, + ListTagsForResourceCommand, + RegisterConnectorCommand, + StartFlowCommand, + StopFlowCommand, + TagResourceCommand, + UnregisterConnectorCommand, + UntagResourceCommand, + UpdateConnectorProfileCommand, + UpdateConnectorRegistrationCommand, + UpdateFlowCommand, +}; + +export interface Appflow { /** - * @public - *

Creates a new connector profile associated with your Amazon Web Services account. There is - * a soft quota of 100 connector profiles per Amazon Web Services account. If you need more - * connector profiles than this quota allows, you can submit a request to the Amazon AppFlow - * team through the Amazon AppFlow support channel. In each connector profile that you - * create, you can provide the credentials and properties for only one connector.

+ * @see {@link CreateConnectorProfileCommand} */ - public createConnectorProfile( + createConnectorProfile( args: CreateConnectorProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConnectorProfile( + createConnectorProfile( args: CreateConnectorProfileCommandInput, cb: (err: any, data?: CreateConnectorProfileCommandOutput) => void ): void; - public createConnectorProfile( + createConnectorProfile( args: CreateConnectorProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectorProfileCommandOutput) => void ): void; - public createConnectorProfile( - args: CreateConnectorProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConnectorProfileCommandOutput) => void), - cb?: (err: any, data?: CreateConnectorProfileCommandOutput) => void - ): Promise | void { - const command = new CreateConnectorProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables your application to create a new flow using Amazon AppFlow. You must create - * a connector profile before calling this API. Please note that the Request Syntax below shows - * syntax for multiple destinations, however, you can only transfer data to one item in this list - * at a time. Amazon AppFlow does not currently support flows to multiple destinations at - * once.

+ * @see {@link CreateFlowCommand} */ - public createFlow(args: CreateFlowCommandInput, options?: __HttpHandlerOptions): Promise; - public createFlow(args: CreateFlowCommandInput, cb: (err: any, data?: CreateFlowCommandOutput) => void): void; - public createFlow( + createFlow(args: CreateFlowCommandInput, options?: __HttpHandlerOptions): Promise; + createFlow(args: CreateFlowCommandInput, cb: (err: any, data?: CreateFlowCommandOutput) => void): void; + createFlow( args: CreateFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFlowCommandOutput) => void ): void; - public createFlow( - args: CreateFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFlowCommandOutput) => void), - cb?: (err: any, data?: CreateFlowCommandOutput) => void - ): Promise | void { - const command = new CreateFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables you to delete an existing connector profile.

+ * @see {@link DeleteConnectorProfileCommand} */ - public deleteConnectorProfile( + deleteConnectorProfile( args: DeleteConnectorProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConnectorProfile( + deleteConnectorProfile( args: DeleteConnectorProfileCommandInput, cb: (err: any, data?: DeleteConnectorProfileCommandOutput) => void ): void; - public deleteConnectorProfile( + deleteConnectorProfile( args: DeleteConnectorProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectorProfileCommandOutput) => void ): void; - public deleteConnectorProfile( - args: DeleteConnectorProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConnectorProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteConnectorProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteConnectorProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables your application to delete an existing flow. Before deleting the flow, Amazon AppFlow validates the request by checking the flow configuration and status. You can - * delete flows one at a time.

+ * @see {@link DeleteFlowCommand} */ - public deleteFlow(args: DeleteFlowCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteFlow(args: DeleteFlowCommandInput, cb: (err: any, data?: DeleteFlowCommandOutput) => void): void; - public deleteFlow( + deleteFlow(args: DeleteFlowCommandInput, options?: __HttpHandlerOptions): Promise; + deleteFlow(args: DeleteFlowCommandInput, cb: (err: any, data?: DeleteFlowCommandOutput) => void): void; + deleteFlow( args: DeleteFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFlowCommandOutput) => void ): void; - public deleteFlow( - args: DeleteFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFlowCommandOutput) => void), - cb?: (err: any, data?: DeleteFlowCommandOutput) => void - ): Promise | void { - const command = new DeleteFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the given custom connector registered in your Amazon Web Services account. This - * API can be used for custom connectors that are registered in your account and also for Amazon - * authored connectors.

+ * @see {@link DescribeConnectorCommand} */ - public describeConnector( + describeConnector( args: DescribeConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConnector( + describeConnector( args: DescribeConnectorCommandInput, cb: (err: any, data?: DescribeConnectorCommandOutput) => void ): void; - public describeConnector( + describeConnector( args: DescribeConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectorCommandOutput) => void ): void; - public describeConnector( - args: DescribeConnectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConnectorCommandOutput) => void), - cb?: (err: any, data?: DescribeConnectorCommandOutput) => void - ): Promise | void { - const command = new DescribeConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides details regarding the entity used with the connector, with a description of the - * data model for each field in that entity.

+ * @see {@link DescribeConnectorEntityCommand} */ - public describeConnectorEntity( + describeConnectorEntity( args: DescribeConnectorEntityCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConnectorEntity( + describeConnectorEntity( args: DescribeConnectorEntityCommandInput, cb: (err: any, data?: DescribeConnectorEntityCommandOutput) => void ): void; - public describeConnectorEntity( + describeConnectorEntity( args: DescribeConnectorEntityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectorEntityCommandOutput) => void ): void; - public describeConnectorEntity( - args: DescribeConnectorEntityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConnectorEntityCommandOutput) => void), - cb?: (err: any, data?: DescribeConnectorEntityCommandOutput) => void - ): Promise | void { - const command = new DescribeConnectorEntityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of connector-profile details matching the provided - * connector-profile names and connector-types. Both input lists are - * optional, and you can use them to filter the result.

- *

If no names or connector-types are provided, returns all connector profiles - * in a paginated form. If there is no match, this operation returns an empty list.

+ * @see {@link DescribeConnectorProfilesCommand} */ - public describeConnectorProfiles( + describeConnectorProfiles( args: DescribeConnectorProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConnectorProfiles( + describeConnectorProfiles( args: DescribeConnectorProfilesCommandInput, cb: (err: any, data?: DescribeConnectorProfilesCommandOutput) => void ): void; - public describeConnectorProfiles( + describeConnectorProfiles( args: DescribeConnectorProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectorProfilesCommandOutput) => void ): void; - public describeConnectorProfiles( - args: DescribeConnectorProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConnectorProfilesCommandOutput) => void), - cb?: (err: any, data?: DescribeConnectorProfilesCommandOutput) => void - ): Promise | void { - const command = new DescribeConnectorProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the connectors vended by Amazon AppFlow for specified connector types. If - * you don't specify a connector type, this operation describes all connectors vended by Amazon AppFlow. If there are more connectors than can be returned in one page, the response - * contains a nextToken object, which can be be passed in to the next call to the - * DescribeConnectors API operation to retrieve the next page.

+ * @see {@link DescribeConnectorsCommand} */ - public describeConnectors( + describeConnectors( args: DescribeConnectorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConnectors( + describeConnectors( args: DescribeConnectorsCommandInput, cb: (err: any, data?: DescribeConnectorsCommandOutput) => void ): void; - public describeConnectors( + describeConnectors( args: DescribeConnectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectorsCommandOutput) => void ): void; - public describeConnectors( - args: DescribeConnectorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConnectorsCommandOutput) => void), - cb?: (err: any, data?: DescribeConnectorsCommandOutput) => void - ): Promise | void { - const command = new DescribeConnectorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a description of the specified flow.

+ * @see {@link DescribeFlowCommand} */ - public describeFlow( - args: DescribeFlowCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeFlow(args: DescribeFlowCommandInput, cb: (err: any, data?: DescribeFlowCommandOutput) => void): void; - public describeFlow( + describeFlow(args: DescribeFlowCommandInput, options?: __HttpHandlerOptions): Promise; + describeFlow(args: DescribeFlowCommandInput, cb: (err: any, data?: DescribeFlowCommandOutput) => void): void; + describeFlow( args: DescribeFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFlowCommandOutput) => void ): void; - public describeFlow( - args: DescribeFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFlowCommandOutput) => void), - cb?: (err: any, data?: DescribeFlowCommandOutput) => void - ): Promise | void { - const command = new DescribeFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Fetches the execution history of the flow.

+ * @see {@link DescribeFlowExecutionRecordsCommand} */ - public describeFlowExecutionRecords( + describeFlowExecutionRecords( args: DescribeFlowExecutionRecordsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFlowExecutionRecords( + describeFlowExecutionRecords( args: DescribeFlowExecutionRecordsCommandInput, cb: (err: any, data?: DescribeFlowExecutionRecordsCommandOutput) => void ): void; - public describeFlowExecutionRecords( + describeFlowExecutionRecords( args: DescribeFlowExecutionRecordsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFlowExecutionRecordsCommandOutput) => void ): void; - public describeFlowExecutionRecords( - args: DescribeFlowExecutionRecordsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFlowExecutionRecordsCommandOutput) => void), - cb?: (err: any, data?: DescribeFlowExecutionRecordsCommandOutput) => void - ): Promise | void { - const command = new DescribeFlowExecutionRecordsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the list of available connector entities supported by Amazon AppFlow. For - * example, you can query Salesforce for Account and - * Opportunity entities, or query ServiceNow for the - * Incident entity.

+ * @see {@link ListConnectorEntitiesCommand} */ - public listConnectorEntities( + listConnectorEntities( args: ListConnectorEntitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConnectorEntities( + listConnectorEntities( args: ListConnectorEntitiesCommandInput, cb: (err: any, data?: ListConnectorEntitiesCommandOutput) => void ): void; - public listConnectorEntities( + listConnectorEntities( args: ListConnectorEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConnectorEntitiesCommandOutput) => void ): void; - public listConnectorEntities( - args: ListConnectorEntitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConnectorEntitiesCommandOutput) => void), - cb?: (err: any, data?: ListConnectorEntitiesCommandOutput) => void - ): Promise | void { - const command = new ListConnectorEntitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the list of all registered custom connectors in your Amazon Web Services account. - * This API lists only custom connectors registered in this account, not the Amazon Web Services - * authored connectors.

+ * @see {@link ListConnectorsCommand} */ - public listConnectors( + listConnectors( args: ListConnectorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConnectors( - args: ListConnectorsCommandInput, - cb: (err: any, data?: ListConnectorsCommandOutput) => void - ): void; - public listConnectors( + listConnectors(args: ListConnectorsCommandInput, cb: (err: any, data?: ListConnectorsCommandOutput) => void): void; + listConnectors( args: ListConnectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConnectorsCommandOutput) => void ): void; - public listConnectors( - args: ListConnectorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConnectorsCommandOutput) => void), - cb?: (err: any, data?: ListConnectorsCommandOutput) => void - ): Promise | void { - const command = new ListConnectorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all of the flows associated with your account.

+ * @see {@link ListFlowsCommand} */ - public listFlows(args: ListFlowsCommandInput, options?: __HttpHandlerOptions): Promise; - public listFlows(args: ListFlowsCommandInput, cb: (err: any, data?: ListFlowsCommandOutput) => void): void; - public listFlows( + listFlows(args: ListFlowsCommandInput, options?: __HttpHandlerOptions): Promise; + listFlows(args: ListFlowsCommandInput, cb: (err: any, data?: ListFlowsCommandOutput) => void): void; + listFlows( args: ListFlowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFlowsCommandOutput) => void ): void; - public listFlows( - args: ListFlowsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFlowsCommandOutput) => void), - cb?: (err: any, data?: ListFlowsCommandOutput) => void - ): Promise | void { - const command = new ListFlowsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the tags that are associated with a specified flow.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers a new custom connector with your Amazon Web Services account. Before you can - * register the connector, you must deploy the associated AWS lambda function in your - * account.

+ * @see {@link RegisterConnectorCommand} */ - public registerConnector( + registerConnector( args: RegisterConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerConnector( + registerConnector( args: RegisterConnectorCommandInput, cb: (err: any, data?: RegisterConnectorCommandOutput) => void ): void; - public registerConnector( + registerConnector( args: RegisterConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterConnectorCommandOutput) => void ): void; - public registerConnector( - args: RegisterConnectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterConnectorCommandOutput) => void), - cb?: (err: any, data?: RegisterConnectorCommandOutput) => void - ): Promise | void { - const command = new RegisterConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Activates an existing flow. For on-demand flows, this operation runs the flow - * immediately. For schedule and event-triggered flows, this operation activates the flow.

+ * @see {@link StartFlowCommand} */ - public startFlow(args: StartFlowCommandInput, options?: __HttpHandlerOptions): Promise; - public startFlow(args: StartFlowCommandInput, cb: (err: any, data?: StartFlowCommandOutput) => void): void; - public startFlow( + startFlow(args: StartFlowCommandInput, options?: __HttpHandlerOptions): Promise; + startFlow(args: StartFlowCommandInput, cb: (err: any, data?: StartFlowCommandOutput) => void): void; + startFlow( args: StartFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFlowCommandOutput) => void ): void; - public startFlow( - args: StartFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartFlowCommandOutput) => void), - cb?: (err: any, data?: StartFlowCommandOutput) => void - ): Promise | void { - const command = new StartFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deactivates the existing flow. For on-demand flows, this operation returns an - * unsupportedOperationException error message. For schedule and event-triggered - * flows, this operation deactivates the flow.

+ * @see {@link StopFlowCommand} */ - public stopFlow(args: StopFlowCommandInput, options?: __HttpHandlerOptions): Promise; - public stopFlow(args: StopFlowCommandInput, cb: (err: any, data?: StopFlowCommandOutput) => void): void; - public stopFlow( + stopFlow(args: StopFlowCommandInput, options?: __HttpHandlerOptions): Promise; + stopFlow(args: StopFlowCommandInput, cb: (err: any, data?: StopFlowCommandOutput) => void): void; + stopFlow( args: StopFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopFlowCommandOutput) => void ): void; - public stopFlow( - args: StopFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopFlowCommandOutput) => void), - cb?: (err: any, data?: StopFlowCommandOutput) => void - ): Promise | void { - const command = new StopFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Applies a tag to the specified flow.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Unregisters the custom connector registered in your account that matches the connector - * label provided in the request.

+ * @see {@link UnregisterConnectorCommand} */ - public unregisterConnector( + unregisterConnector( args: UnregisterConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public unregisterConnector( + unregisterConnector( args: UnregisterConnectorCommandInput, cb: (err: any, data?: UnregisterConnectorCommandOutput) => void ): void; - public unregisterConnector( + unregisterConnector( args: UnregisterConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnregisterConnectorCommandOutput) => void ): void; - public unregisterConnector( - args: UnregisterConnectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnregisterConnectorCommandOutput) => void), - cb?: (err: any, data?: UnregisterConnectorCommandOutput) => void - ): Promise | void { - const command = new UnregisterConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a tag from the specified flow.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a given connector profile associated with your account.

+ * @see {@link UpdateConnectorProfileCommand} */ - public updateConnectorProfile( + updateConnectorProfile( args: UpdateConnectorProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConnectorProfile( + updateConnectorProfile( args: UpdateConnectorProfileCommandInput, cb: (err: any, data?: UpdateConnectorProfileCommandOutput) => void ): void; - public updateConnectorProfile( + updateConnectorProfile( args: UpdateConnectorProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectorProfileCommandOutput) => void ): void; - public updateConnectorProfile( - args: UpdateConnectorProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConnectorProfileCommandOutput) => void), - cb?: (err: any, data?: UpdateConnectorProfileCommandOutput) => void - ): Promise | void { - const command = new UpdateConnectorProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a custom connector that you've previously registered. This operation updates the - * connector with one of the following:

- *
    - *
  • - *

    The latest version of the AWS Lambda function that's assigned to the connector

    - *
  • - *
  • - *

    A new AWS Lambda function that you specify

    - *
  • - *
+ * @see {@link UpdateConnectorRegistrationCommand} */ - public updateConnectorRegistration( + updateConnectorRegistration( args: UpdateConnectorRegistrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConnectorRegistration( + updateConnectorRegistration( args: UpdateConnectorRegistrationCommandInput, cb: (err: any, data?: UpdateConnectorRegistrationCommandOutput) => void ): void; - public updateConnectorRegistration( + updateConnectorRegistration( args: UpdateConnectorRegistrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectorRegistrationCommandOutput) => void ): void; - public updateConnectorRegistration( - args: UpdateConnectorRegistrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConnectorRegistrationCommandOutput) => void), - cb?: (err: any, data?: UpdateConnectorRegistrationCommandOutput) => void - ): Promise | void { - const command = new UpdateConnectorRegistrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing flow.

+ * @see {@link UpdateFlowCommand} */ - public updateFlow(args: UpdateFlowCommandInput, options?: __HttpHandlerOptions): Promise; - public updateFlow(args: UpdateFlowCommandInput, cb: (err: any, data?: UpdateFlowCommandOutput) => void): void; - public updateFlow( + updateFlow(args: UpdateFlowCommandInput, options?: __HttpHandlerOptions): Promise; + updateFlow(args: UpdateFlowCommandInput, cb: (err: any, data?: UpdateFlowCommandOutput) => void): void; + updateFlow( args: UpdateFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFlowCommandOutput) => void ): void; - public updateFlow( - args: UpdateFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFlowCommandOutput) => void), - cb?: (err: any, data?: UpdateFlowCommandOutput) => void - ): Promise | void { - const command = new UpdateFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Welcome to the Amazon AppFlow API reference. This guide is for developers who need + * detailed information about the Amazon AppFlow API operations, data types, and errors.

+ *

Amazon AppFlow is a fully managed integration service that enables you to securely + * transfer data between software as a service (SaaS) applications like Salesforce, Marketo, + * Slack, and ServiceNow, and Amazon Web Services like Amazon S3 and Amazon Redshift.

+ *

Use the following links to get started on the Amazon AppFlow API:

+ *
    + *
  • + *

    + * Actions: An alphabetical list of all Amazon AppFlow API operations.

    + *
  • + *
  • + *

    + * Data + * types: An alphabetical list of all Amazon AppFlow data types.

    + *
  • + *
  • + *

    + * Common parameters: Parameters that all Query operations can use.

    + *
  • + *
  • + *

    + * Common + * errors: Client and server errors that all operations can return.

    + *
  • + *
+ *

If you're new to Amazon AppFlow, we recommend that you review the Amazon AppFlow + * User Guide.

+ *

Amazon AppFlow API users can use vendor-specific mechanisms for OAuth, and include + * applicable OAuth attributes (such as auth-code and redirecturi) with + * the connector-specific ConnectorProfileProperties when creating a new connector + * profile using Amazon AppFlow API operations. For example, Salesforce users can refer to + * the + * Authorize Apps with OAuth + * documentation.

+ */ +export class Appflow extends AppflowClient implements Appflow {} +createAggregatedClient(commands, Appflow); diff --git a/clients/client-appintegrations/src/AppIntegrations.ts b/clients/client-appintegrations/src/AppIntegrations.ts index b2d147a230c2..219a8b79a17b 100644 --- a/clients/client-appintegrations/src/AppIntegrations.ts +++ b/clients/client-appintegrations/src/AppIntegrations.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { AppIntegrationsClient } from "./AppIntegrationsClient"; +import { AppIntegrationsClient, AppIntegrationsClientConfig } from "./AppIntegrationsClient"; import { CreateDataIntegrationCommand, CreateDataIntegrationCommandInput, @@ -74,539 +75,278 @@ import { UpdateEventIntegrationCommandOutput, } from "./commands/UpdateEventIntegrationCommand"; -/** - * @public - *

The Amazon AppIntegrations service enables you to configure and reuse connections to external - * applications.

- *

For information about how you can use external applications with Amazon Connect, see - * Set up pre-built - * integrations and Deliver information to agents - * using Amazon Connect Wisdom in the Amazon Connect Administrator - * Guide.

- */ -export class AppIntegrations extends AppIntegrationsClient { +const commands = { + CreateDataIntegrationCommand, + CreateEventIntegrationCommand, + DeleteDataIntegrationCommand, + DeleteEventIntegrationCommand, + GetDataIntegrationCommand, + GetEventIntegrationCommand, + ListDataIntegrationAssociationsCommand, + ListDataIntegrationsCommand, + ListEventIntegrationAssociationsCommand, + ListEventIntegrationsCommand, + ListTagsForResourceCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateDataIntegrationCommand, + UpdateEventIntegrationCommand, +}; + +export interface AppIntegrations { /** - * @public - *

Creates and persists a DataIntegration resource.

- * - *

You cannot create a DataIntegration association for a DataIntegration that has been - * previously associated. Use a different DataIntegration, or recreate the DataIntegration - * using the CreateDataIntegration API.

- *
+ * @see {@link CreateDataIntegrationCommand} */ - public createDataIntegration( + createDataIntegration( args: CreateDataIntegrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDataIntegration( + createDataIntegration( args: CreateDataIntegrationCommandInput, cb: (err: any, data?: CreateDataIntegrationCommandOutput) => void ): void; - public createDataIntegration( + createDataIntegration( args: CreateDataIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataIntegrationCommandOutput) => void ): void; - public createDataIntegration( - args: CreateDataIntegrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDataIntegrationCommandOutput) => void), - cb?: (err: any, data?: CreateDataIntegrationCommandOutput) => void - ): Promise | void { - const command = new CreateDataIntegrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an EventIntegration, given a specified name, description, and a reference to an - * Amazon EventBridge bus in your account and a partner event source that pushes events to - * that bus. No objects are created in the your account, only metadata that is persisted on the - * EventIntegration control plane.

+ * @see {@link CreateEventIntegrationCommand} */ - public createEventIntegration( + createEventIntegration( args: CreateEventIntegrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEventIntegration( + createEventIntegration( args: CreateEventIntegrationCommandInput, cb: (err: any, data?: CreateEventIntegrationCommandOutput) => void ): void; - public createEventIntegration( + createEventIntegration( args: CreateEventIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEventIntegrationCommandOutput) => void ): void; - public createEventIntegration( - args: CreateEventIntegrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEventIntegrationCommandOutput) => void), - cb?: (err: any, data?: CreateEventIntegrationCommandOutput) => void - ): Promise | void { - const command = new CreateEventIntegrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the DataIntegration. Only DataIntegrations that don't have any - * DataIntegrationAssociations can be deleted. Deleting a DataIntegration also deletes the - * underlying Amazon AppFlow flow and service linked role.

- * - *

You cannot create a DataIntegration association for a DataIntegration that has been previously associated. - * Use a different DataIntegration, or recreate the DataIntegration using the - * CreateDataIntegration API.

- *
+ * @see {@link DeleteDataIntegrationCommand} */ - public deleteDataIntegration( + deleteDataIntegration( args: DeleteDataIntegrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDataIntegration( + deleteDataIntegration( args: DeleteDataIntegrationCommandInput, cb: (err: any, data?: DeleteDataIntegrationCommandOutput) => void ): void; - public deleteDataIntegration( + deleteDataIntegration( args: DeleteDataIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataIntegrationCommandOutput) => void ): void; - public deleteDataIntegration( - args: DeleteDataIntegrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDataIntegrationCommandOutput) => void), - cb?: (err: any, data?: DeleteDataIntegrationCommandOutput) => void - ): Promise | void { - const command = new DeleteDataIntegrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified existing event integration. If the event integration is associated - * with clients, the request is rejected.

+ * @see {@link DeleteEventIntegrationCommand} */ - public deleteEventIntegration( + deleteEventIntegration( args: DeleteEventIntegrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEventIntegration( + deleteEventIntegration( args: DeleteEventIntegrationCommandInput, cb: (err: any, data?: DeleteEventIntegrationCommandOutput) => void ): void; - public deleteEventIntegration( + deleteEventIntegration( args: DeleteEventIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventIntegrationCommandOutput) => void ): void; - public deleteEventIntegration( - args: DeleteEventIntegrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEventIntegrationCommandOutput) => void), - cb?: (err: any, data?: DeleteEventIntegrationCommandOutput) => void - ): Promise | void { - const command = new DeleteEventIntegrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the DataIntegration.

- * - *

You cannot create a DataIntegration association for a DataIntegration that has been previously associated. - * Use a different DataIntegration, or recreate the DataIntegration using the - * CreateDataIntegration API.

- *
+ * @see {@link GetDataIntegrationCommand} */ - public getDataIntegration( + getDataIntegration( args: GetDataIntegrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDataIntegration( + getDataIntegration( args: GetDataIntegrationCommandInput, cb: (err: any, data?: GetDataIntegrationCommandOutput) => void ): void; - public getDataIntegration( + getDataIntegration( args: GetDataIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataIntegrationCommandOutput) => void ): void; - public getDataIntegration( - args: GetDataIntegrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDataIntegrationCommandOutput) => void), - cb?: (err: any, data?: GetDataIntegrationCommandOutput) => void - ): Promise | void { - const command = new GetDataIntegrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the event integration.

+ * @see {@link GetEventIntegrationCommand} */ - public getEventIntegration( + getEventIntegration( args: GetEventIntegrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEventIntegration( + getEventIntegration( args: GetEventIntegrationCommandInput, cb: (err: any, data?: GetEventIntegrationCommandOutput) => void ): void; - public getEventIntegration( + getEventIntegration( args: GetEventIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEventIntegrationCommandOutput) => void ): void; - public getEventIntegration( - args: GetEventIntegrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEventIntegrationCommandOutput) => void), - cb?: (err: any, data?: GetEventIntegrationCommandOutput) => void - ): Promise | void { - const command = new GetEventIntegrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a paginated list of DataIntegration associations in the account.

- * - *

You cannot create a DataIntegration association for a DataIntegration that has been previously associated. - * Use a different DataIntegration, or recreate the DataIntegration using the - * CreateDataIntegration API.

- *
+ * @see {@link ListDataIntegrationAssociationsCommand} */ - public listDataIntegrationAssociations( + listDataIntegrationAssociations( args: ListDataIntegrationAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDataIntegrationAssociations( + listDataIntegrationAssociations( args: ListDataIntegrationAssociationsCommandInput, cb: (err: any, data?: ListDataIntegrationAssociationsCommandOutput) => void ): void; - public listDataIntegrationAssociations( + listDataIntegrationAssociations( args: ListDataIntegrationAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataIntegrationAssociationsCommandOutput) => void ): void; - public listDataIntegrationAssociations( - args: ListDataIntegrationAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDataIntegrationAssociationsCommandOutput) => void), - cb?: (err: any, data?: ListDataIntegrationAssociationsCommandOutput) => void - ): Promise | void { - const command = new ListDataIntegrationAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a paginated list of DataIntegrations in the account.

- * - *

You cannot create a DataIntegration association for a DataIntegration that has been previously associated. - * Use a different DataIntegration, or recreate the DataIntegration using the - * CreateDataIntegration API.

- *
+ * @see {@link ListDataIntegrationsCommand} */ - public listDataIntegrations( + listDataIntegrations( args: ListDataIntegrationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDataIntegrations( + listDataIntegrations( args: ListDataIntegrationsCommandInput, cb: (err: any, data?: ListDataIntegrationsCommandOutput) => void ): void; - public listDataIntegrations( + listDataIntegrations( args: ListDataIntegrationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataIntegrationsCommandOutput) => void ): void; - public listDataIntegrations( - args: ListDataIntegrationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDataIntegrationsCommandOutput) => void), - cb?: (err: any, data?: ListDataIntegrationsCommandOutput) => void - ): Promise | void { - const command = new ListDataIntegrationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a paginated list of event integration associations in the account.

+ * @see {@link ListEventIntegrationAssociationsCommand} */ - public listEventIntegrationAssociations( + listEventIntegrationAssociations( args: ListEventIntegrationAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEventIntegrationAssociations( + listEventIntegrationAssociations( args: ListEventIntegrationAssociationsCommandInput, cb: (err: any, data?: ListEventIntegrationAssociationsCommandOutput) => void ): void; - public listEventIntegrationAssociations( + listEventIntegrationAssociations( args: ListEventIntegrationAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventIntegrationAssociationsCommandOutput) => void ): void; - public listEventIntegrationAssociations( - args: ListEventIntegrationAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEventIntegrationAssociationsCommandOutput) => void), - cb?: (err: any, data?: ListEventIntegrationAssociationsCommandOutput) => void - ): Promise | void { - const command = new ListEventIntegrationAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a paginated list of event integrations in the account.

+ * @see {@link ListEventIntegrationsCommand} */ - public listEventIntegrations( + listEventIntegrations( args: ListEventIntegrationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEventIntegrations( + listEventIntegrations( args: ListEventIntegrationsCommandInput, cb: (err: any, data?: ListEventIntegrationsCommandOutput) => void ): void; - public listEventIntegrations( + listEventIntegrations( args: ListEventIntegrationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventIntegrationsCommandOutput) => void ): void; - public listEventIntegrations( - args: ListEventIntegrationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEventIntegrationsCommandOutput) => void), - cb?: (err: any, data?: ListEventIntegrationsCommandOutput) => void - ): Promise | void { - const command = new ListEventIntegrationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags for the specified resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds the specified tags to the specified resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified tags from the specified resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the description of a DataIntegration.

- * - *

You cannot create a DataIntegration association for a DataIntegration that has been previously associated. - * Use a different DataIntegration, or recreate the DataIntegration using the - * CreateDataIntegration API.

- *
+ * @see {@link UpdateDataIntegrationCommand} */ - public updateDataIntegration( + updateDataIntegration( args: UpdateDataIntegrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDataIntegration( + updateDataIntegration( args: UpdateDataIntegrationCommandInput, cb: (err: any, data?: UpdateDataIntegrationCommandOutput) => void ): void; - public updateDataIntegration( + updateDataIntegration( args: UpdateDataIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDataIntegrationCommandOutput) => void ): void; - public updateDataIntegration( - args: UpdateDataIntegrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDataIntegrationCommandOutput) => void), - cb?: (err: any, data?: UpdateDataIntegrationCommandOutput) => void - ): Promise | void { - const command = new UpdateDataIntegrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the description of an event integration.

+ * @see {@link UpdateEventIntegrationCommand} */ - public updateEventIntegration( + updateEventIntegration( args: UpdateEventIntegrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEventIntegration( + updateEventIntegration( args: UpdateEventIntegrationCommandInput, cb: (err: any, data?: UpdateEventIntegrationCommandOutput) => void ): void; - public updateEventIntegration( + updateEventIntegration( args: UpdateEventIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEventIntegrationCommandOutput) => void ): void; - public updateEventIntegration( - args: UpdateEventIntegrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEventIntegrationCommandOutput) => void), - cb?: (err: any, data?: UpdateEventIntegrationCommandOutput) => void - ): Promise | void { - const command = new UpdateEventIntegrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The Amazon AppIntegrations service enables you to configure and reuse connections to external + * applications.

+ *

For information about how you can use external applications with Amazon Connect, see + * Set up pre-built + * integrations and Deliver information to agents + * using Amazon Connect Wisdom in the Amazon Connect Administrator + * Guide.

+ */ +export class AppIntegrations extends AppIntegrationsClient implements AppIntegrations {} +createAggregatedClient(commands, AppIntegrations); diff --git a/clients/client-application-auto-scaling/src/ApplicationAutoScaling.ts b/clients/client-application-auto-scaling/src/ApplicationAutoScaling.ts index 01b6ca21b7d1..4418589d04d0 100644 --- a/clients/client-application-auto-scaling/src/ApplicationAutoScaling.ts +++ b/clients/client-application-auto-scaling/src/ApplicationAutoScaling.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { ApplicationAutoScalingClient } from "./ApplicationAutoScalingClient"; +import { ApplicationAutoScalingClient, ApplicationAutoScalingClientConfig } from "./ApplicationAutoScalingClient"; import { DeleteScalingPolicyCommand, DeleteScalingPolicyCommandInput, @@ -64,608 +65,306 @@ import { UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; -/** - * @public - *

With Application Auto Scaling, you can configure automatic scaling for the following - * resources:

- *
    - *
  • - *

    Amazon AppStream 2.0 fleets

    - *
  • - *
  • - *

    Amazon Aurora Replicas

    - *
  • - *
  • - *

    Amazon Comprehend document classification and entity recognizer endpoints

    - *
  • - *
  • - *

    Amazon DynamoDB tables and global secondary indexes throughput capacity

    - *
  • - *
  • - *

    Amazon ECS services

    - *
  • - *
  • - *

    Amazon ElastiCache for Redis clusters (replication groups)

    - *
  • - *
  • - *

    Amazon EMR clusters

    - *
  • - *
  • - *

    Amazon Keyspaces (for Apache Cassandra) tables

    - *
  • - *
  • - *

    Lambda function provisioned concurrency

    - *
  • - *
  • - *

    Amazon Managed Streaming for Apache Kafka broker storage

    - *
  • - *
  • - *

    Amazon Neptune clusters

    - *
  • - *
  • - *

    Amazon SageMaker endpoint variants

    - *
  • - *
  • - *

    Spot Fleets (Amazon EC2)

    - *
  • - *
  • - *

    Custom resources provided by your own applications or services

    - *
  • - *
- *

To learn more about Application Auto Scaling, see the Application Auto Scaling User - * Guide.

- *

- * API Summary - *

- *

The Application Auto Scaling service API includes three key sets of actions:

- *
    - *
  • - *

    Register and manage scalable targets - Register Amazon Web Services or custom resources as scalable - * targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and - * retrieve information on existing scalable targets.

    - *
  • - *
  • - *

    Configure and manage automatic scaling - Define scaling policies to dynamically scale - * your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions, - * and retrieve your recent scaling activity history.

    - *
  • - *
  • - *

    Suspend and resume scaling - Temporarily suspend and later resume automatic scaling by - * calling the RegisterScalableTarget API action for any Application Auto Scaling scalable target. You can - * suspend and resume (individually or in combination) scale-out activities that are - * triggered by a scaling policy, scale-in activities that are triggered by a scaling policy, - * and scheduled scaling.

    - *
  • - *
- */ -export class ApplicationAutoScaling extends ApplicationAutoScalingClient { +const commands = { + DeleteScalingPolicyCommand, + DeleteScheduledActionCommand, + DeregisterScalableTargetCommand, + DescribeScalableTargetsCommand, + DescribeScalingActivitiesCommand, + DescribeScalingPoliciesCommand, + DescribeScheduledActionsCommand, + ListTagsForResourceCommand, + PutScalingPolicyCommand, + PutScheduledActionCommand, + RegisterScalableTargetCommand, + TagResourceCommand, + UntagResourceCommand, +}; + +export interface ApplicationAutoScaling { /** - * @public - *

Deletes the specified scaling policy for an Application Auto Scaling scalable target.

- *

Deleting a step scaling policy deletes the underlying alarm action, but does not delete - * the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated - * action.

- *

For more information, see Delete a step scaling policy and Delete a target tracking scaling policy in the - * Application Auto Scaling User Guide.

+ * @see {@link DeleteScalingPolicyCommand} */ - public deleteScalingPolicy( + deleteScalingPolicy( args: DeleteScalingPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteScalingPolicy( + deleteScalingPolicy( args: DeleteScalingPolicyCommandInput, cb: (err: any, data?: DeleteScalingPolicyCommandOutput) => void ): void; - public deleteScalingPolicy( + deleteScalingPolicy( args: DeleteScalingPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteScalingPolicyCommandOutput) => void ): void; - public deleteScalingPolicy( - args: DeleteScalingPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteScalingPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteScalingPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteScalingPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified scheduled action for an Application Auto Scaling scalable target.

- *

For more information, see Delete a scheduled action in the Application Auto Scaling User Guide.

+ * @see {@link DeleteScheduledActionCommand} */ - public deleteScheduledAction( + deleteScheduledAction( args: DeleteScheduledActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteScheduledAction( + deleteScheduledAction( args: DeleteScheduledActionCommandInput, cb: (err: any, data?: DeleteScheduledActionCommandOutput) => void ): void; - public deleteScheduledAction( + deleteScheduledAction( args: DeleteScheduledActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteScheduledActionCommandOutput) => void ): void; - public deleteScheduledAction( - args: DeleteScheduledActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteScheduledActionCommandOutput) => void), - cb?: (err: any, data?: DeleteScheduledActionCommandOutput) => void - ): Promise | void { - const command = new DeleteScheduledActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deregisters an Application Auto Scaling scalable target when you have finished using it. To see which - * resources have been registered, use DescribeScalableTargets.

- * - *

Deregistering a scalable target deletes the scaling policies and the scheduled - * actions that are associated with it.

- *
+ * @see {@link DeregisterScalableTargetCommand} */ - public deregisterScalableTarget( + deregisterScalableTarget( args: DeregisterScalableTargetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterScalableTarget( + deregisterScalableTarget( args: DeregisterScalableTargetCommandInput, cb: (err: any, data?: DeregisterScalableTargetCommandOutput) => void ): void; - public deregisterScalableTarget( + deregisterScalableTarget( args: DeregisterScalableTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterScalableTargetCommandOutput) => void ): void; - public deregisterScalableTarget( - args: DeregisterScalableTargetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterScalableTargetCommandOutput) => void), - cb?: (err: any, data?: DeregisterScalableTargetCommandOutput) => void - ): Promise | void { - const command = new DeregisterScalableTargetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about the scalable targets in the specified namespace.

- *

You can filter the results using ResourceIds and - * ScalableDimension.

+ * @see {@link DescribeScalableTargetsCommand} */ - public describeScalableTargets( + describeScalableTargets( args: DescribeScalableTargetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeScalableTargets( + describeScalableTargets( args: DescribeScalableTargetsCommandInput, cb: (err: any, data?: DescribeScalableTargetsCommandOutput) => void ): void; - public describeScalableTargets( + describeScalableTargets( args: DescribeScalableTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScalableTargetsCommandOutput) => void ): void; - public describeScalableTargets( - args: DescribeScalableTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeScalableTargetsCommandOutput) => void), - cb?: (err: any, data?: DescribeScalableTargetsCommandOutput) => void - ): Promise | void { - const command = new DescribeScalableTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides descriptive information about the scaling activities in the specified namespace - * from the previous six weeks.

- *

You can filter the results using ResourceId and - * ScalableDimension.

- *

For information about viewing scaling activities using the Amazon Web Services CLI, see Scaling activities for Application Auto Scaling.

+ * @see {@link DescribeScalingActivitiesCommand} */ - public describeScalingActivities( + describeScalingActivities( args: DescribeScalingActivitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeScalingActivities( + describeScalingActivities( args: DescribeScalingActivitiesCommandInput, cb: (err: any, data?: DescribeScalingActivitiesCommandOutput) => void ): void; - public describeScalingActivities( + describeScalingActivities( args: DescribeScalingActivitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScalingActivitiesCommandOutput) => void ): void; - public describeScalingActivities( - args: DescribeScalingActivitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeScalingActivitiesCommandOutput) => void), - cb?: (err: any, data?: DescribeScalingActivitiesCommandOutput) => void - ): Promise | void { - const command = new DescribeScalingActivitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the Application Auto Scaling scaling policies for the specified service namespace.

- *

You can filter the results using ResourceId, - * ScalableDimension, and PolicyNames.

- *

For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.

+ * @see {@link DescribeScalingPoliciesCommand} */ - public describeScalingPolicies( + describeScalingPolicies( args: DescribeScalingPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeScalingPolicies( + describeScalingPolicies( args: DescribeScalingPoliciesCommandInput, cb: (err: any, data?: DescribeScalingPoliciesCommandOutput) => void ): void; - public describeScalingPolicies( + describeScalingPolicies( args: DescribeScalingPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScalingPoliciesCommandOutput) => void ): void; - public describeScalingPolicies( - args: DescribeScalingPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeScalingPoliciesCommandOutput) => void), - cb?: (err: any, data?: DescribeScalingPoliciesCommandOutput) => void - ): Promise | void { - const command = new DescribeScalingPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the Application Auto Scaling scheduled actions for the specified service namespace.

- *

You can filter the results using the ResourceId, - * ScalableDimension, and ScheduledActionNames parameters.

- *

For more information, see Scheduled scaling and Managing scheduled scaling in the - * Application Auto Scaling User Guide.

+ * @see {@link DescribeScheduledActionsCommand} */ - public describeScheduledActions( + describeScheduledActions( args: DescribeScheduledActionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeScheduledActions( + describeScheduledActions( args: DescribeScheduledActionsCommandInput, cb: (err: any, data?: DescribeScheduledActionsCommandOutput) => void ): void; - public describeScheduledActions( + describeScheduledActions( args: DescribeScheduledActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScheduledActionsCommandOutput) => void ): void; - public describeScheduledActions( - args: DescribeScheduledActionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeScheduledActionsCommandOutput) => void), - cb?: (err: any, data?: DescribeScheduledActionsCommandOutput) => void - ): Promise | void { - const command = new DescribeScheduledActionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns all the tags on the specified Application Auto Scaling scalable target.

- *

For general information about tags, including the format and syntax, see Tagging Amazon Web Services - * resources in the Amazon Web Services General Reference.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates a scaling policy for an Application Auto Scaling scalable target.

- *

Each scalable target is identified by a service namespace, resource ID, and scalable - * dimension. A scaling policy applies to the scalable target identified by those three - * attributes. You cannot create a scaling policy until you have registered the resource as a - * scalable target.

- *

Multiple scaling policies can be in force at the same time for the same scalable target. - * You can have one or more target tracking scaling policies, one or more step scaling - * policies, or both. However, there is a chance that multiple policies could conflict, - * instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives - * precedence to the policy that provides the largest capacity for both scale out and scale - * in. For example, if one policy increases capacity by 3, another policy increases capacity - * by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest - * calculated capacity (200% of 10 = 20) and scales out to 30.

- *

We recommend caution, however, when using target tracking scaling policies with step - * scaling policies because conflicts between these policies can cause undesirable behavior. - * For example, if the step scaling policy initiates a scale-in activity before the target - * tracking policy is ready to scale in, the scale-in activity will not be blocked. After the - * scale-in activity completes, the target tracking policy could instruct the scalable target - * to scale out again.

- *

For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.

- * - *

If a scalable target is deregistered, the scalable target is no longer available to - * use scaling policies. Any scaling policies that were specified for the scalable target - * are deleted.

- *
+ * @see {@link PutScalingPolicyCommand} */ - public putScalingPolicy( + putScalingPolicy( args: PutScalingPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putScalingPolicy( + putScalingPolicy( args: PutScalingPolicyCommandInput, cb: (err: any, data?: PutScalingPolicyCommandOutput) => void ): void; - public putScalingPolicy( + putScalingPolicy( args: PutScalingPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutScalingPolicyCommandOutput) => void ): void; - public putScalingPolicy( - args: PutScalingPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutScalingPolicyCommandOutput) => void), - cb?: (err: any, data?: PutScalingPolicyCommandOutput) => void - ): Promise | void { - const command = new PutScalingPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates a scheduled action for an Application Auto Scaling scalable target.

- *

Each scalable target is identified by a service namespace, resource ID, and scalable - * dimension. A scheduled action applies to the scalable target identified by those three - * attributes. You cannot create a scheduled action until you have registered the resource as - * a scalable target.

- *

When you specify start and end times with a recurring schedule using a cron expression - * or rates, they form the boundaries for when the recurring action starts and stops.

- *

To update a scheduled action, specify the parameters that you want to change. If you - * don't specify start and end times, the old values are deleted.

- *

For more information, see Scheduled scaling in the Application Auto Scaling User Guide.

- * - *

If a scalable target is deregistered, the scalable target is no longer available to - * run scheduled actions. Any scheduled actions that were specified for the scalable target - * are deleted.

- *
+ * @see {@link PutScheduledActionCommand} */ - public putScheduledAction( + putScheduledAction( args: PutScheduledActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public putScheduledAction( + putScheduledAction( args: PutScheduledActionCommandInput, cb: (err: any, data?: PutScheduledActionCommandOutput) => void ): void; - public putScheduledAction( + putScheduledAction( args: PutScheduledActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutScheduledActionCommandOutput) => void ): void; - public putScheduledAction( - args: PutScheduledActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutScheduledActionCommandOutput) => void), - cb?: (err: any, data?: PutScheduledActionCommandOutput) => void - ): Promise | void { - const command = new PutScheduledActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers or updates a scalable target, which is the resource that you want to - * scale.

- *

Scalable targets are uniquely identified by the combination of resource ID, scalable - * dimension, and namespace, which represents some capacity dimension of the underlying - * service.

- *

When you register a new scalable target, you must specify values for the minimum and - * maximum capacity. If the specified resource is not active in the target service, this - * operation does not change the resource's current capacity. Otherwise, it changes the - * resource's current capacity to a value that is inside of this range.

- *

If you add a scaling policy, current capacity is adjustable within the specified range - * when scaling starts. Application Auto Scaling scaling policies will not scale capacity to values that are - * outside of the minimum and maximum range.

- *

After you register a scalable target, you do not need to register it again to use other - * Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service - * namespace by using DescribeScalableTargets. If you no longer need a scalable target, you can - * deregister it by using DeregisterScalableTarget.

- *

To update a scalable target, specify the parameters that you want to change. Include the - * parameters that identify the scalable target: resource ID, scalable dimension, and - * namespace. Any parameters that you don't specify are not changed by this update request.

- * - *

If you call the RegisterScalableTarget API operation to create a - * scalable target, there might be a brief delay until the operation achieves eventual - * consistency. You might become aware of this brief delay if you get unexpected - * errors when performing sequential operations. The typical strategy is to retry the - * request, and some Amazon Web Services SDKs include automatic backoff and retry logic.

- *

If you call the RegisterScalableTarget API operation to update an - * existing scalable target, Application Auto Scaling retrieves the current capacity of the resource. If - * it's below the minimum capacity or above the maximum capacity, Application Auto Scaling adjusts the - * capacity of the scalable target to place it within these bounds, even if you don't - * include the MinCapacity or MaxCapacity request - * parameters.

- *
+ * @see {@link RegisterScalableTargetCommand} */ - public registerScalableTarget( + registerScalableTarget( args: RegisterScalableTargetCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerScalableTarget( + registerScalableTarget( args: RegisterScalableTargetCommandInput, cb: (err: any, data?: RegisterScalableTargetCommandOutput) => void ): void; - public registerScalableTarget( + registerScalableTarget( args: RegisterScalableTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterScalableTargetCommandOutput) => void ): void; - public registerScalableTarget( - args: RegisterScalableTargetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterScalableTargetCommandOutput) => void), - cb?: (err: any, data?: RegisterScalableTargetCommandOutput) => void - ): Promise | void { - const command = new RegisterScalableTargetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or edits tags on an Application Auto Scaling scalable target.

- *

Each tag consists of a tag key and a tag value, which are both case-sensitive strings. - * To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag - * key and a new tag value.

- *

You can use this operation to tag an Application Auto Scaling scalable target, but you cannot tag a - * scaling policy or scheduled action.

- *

You can also add tags to an Application Auto Scaling scalable target while creating it - * (RegisterScalableTarget).

- *

For general information about tags, including the format and syntax, see Tagging Amazon Web Services - * resources in the Amazon Web Services General Reference.

- *

Use tags to control access to a scalable target. For more information, see Tagging support - * for Application Auto Scaling in the Application Auto Scaling User Guide.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes tags from an Application Auto Scaling scalable target. To delete a tag, specify the tag key and - * the Application Auto Scaling scalable target.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

With Application Auto Scaling, you can configure automatic scaling for the following + * resources:

+ *
    + *
  • + *

    Amazon AppStream 2.0 fleets

    + *
  • + *
  • + *

    Amazon Aurora Replicas

    + *
  • + *
  • + *

    Amazon Comprehend document classification and entity recognizer endpoints

    + *
  • + *
  • + *

    Amazon DynamoDB tables and global secondary indexes throughput capacity

    + *
  • + *
  • + *

    Amazon ECS services

    + *
  • + *
  • + *

    Amazon ElastiCache for Redis clusters (replication groups)

    + *
  • + *
  • + *

    Amazon EMR clusters

    + *
  • + *
  • + *

    Amazon Keyspaces (for Apache Cassandra) tables

    + *
  • + *
  • + *

    Lambda function provisioned concurrency

    + *
  • + *
  • + *

    Amazon Managed Streaming for Apache Kafka broker storage

    + *
  • + *
  • + *

    Amazon Neptune clusters

    + *
  • + *
  • + *

    Amazon SageMaker endpoint variants

    + *
  • + *
  • + *

    Spot Fleets (Amazon EC2)

    + *
  • + *
  • + *

    Custom resources provided by your own applications or services

    + *
  • + *
+ *

To learn more about Application Auto Scaling, see the Application Auto Scaling User + * Guide.

+ *

+ * API Summary + *

+ *

The Application Auto Scaling service API includes three key sets of actions:

+ *
    + *
  • + *

    Register and manage scalable targets - Register Amazon Web Services or custom resources as scalable + * targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and + * retrieve information on existing scalable targets.

    + *
  • + *
  • + *

    Configure and manage automatic scaling - Define scaling policies to dynamically scale + * your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions, + * and retrieve your recent scaling activity history.

    + *
  • + *
  • + *

    Suspend and resume scaling - Temporarily suspend and later resume automatic scaling by + * calling the RegisterScalableTarget API action for any Application Auto Scaling scalable target. You can + * suspend and resume (individually or in combination) scale-out activities that are + * triggered by a scaling policy, scale-in activities that are triggered by a scaling policy, + * and scheduled scaling.

    + *
  • + *
+ */ +export class ApplicationAutoScaling extends ApplicationAutoScalingClient implements ApplicationAutoScaling {} +createAggregatedClient(commands, ApplicationAutoScaling); diff --git a/clients/client-application-discovery-service/src/ApplicationDiscoveryService.ts b/clients/client-application-discovery-service/src/ApplicationDiscoveryService.ts index 1475688a5764..72506ff11920 100644 --- a/clients/client-application-discovery-service/src/ApplicationDiscoveryService.ts +++ b/clients/client-application-discovery-service/src/ApplicationDiscoveryService.ts @@ -1,7 +1,11 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { ApplicationDiscoveryServiceClient } from "./ApplicationDiscoveryServiceClient"; +import { + ApplicationDiscoveryServiceClient, + ApplicationDiscoveryServiceClientConfig, +} from "./ApplicationDiscoveryServiceClient"; import { AssociateConfigurationItemsToApplicationCommand, AssociateConfigurationItemsToApplicationCommandInput, @@ -120,1044 +124,551 @@ import { UpdateApplicationCommandOutput, } from "./commands/UpdateApplicationCommand"; -/** - * @public - * Amazon Web Services Application Discovery Service - *

Amazon Web Services Application Discovery Service helps you plan application migration projects. It - * automatically identifies servers, virtual machines (VMs), and network dependencies in your - * on-premises data centers. For more information, see the Amazon Web Services Application Discovery Service FAQ. - * Application Discovery Service offers three ways of performing discovery and - * collecting data about your on-premises servers:

- *
    - *
  • - *

    - * Agentless discovery is recommended for environments - * that use VMware vCenter Server. This mode doesn't require you to install an agent on each - * host. It does not work in non-VMware environments.

    - *
      - *
    • - *

      Agentless discovery gathers server information regardless of the operating - * systems, which minimizes the time required for initial on-premises infrastructure - * assessment.

      - *
    • - *
    • - *

      Agentless discovery doesn't collect information about network dependencies, only - * agent-based discovery collects that information.

      - *
    • - *
    - *
  • - *
- *
    - *
  • - *

    - * Agent-based discovery collects a richer set of data - * than agentless discovery by using the Amazon Web Services Application Discovery Agent, which you install - * on one or more hosts in your data center.

    - *
      - *
    • - *

      The agent captures infrastructure and application information, including an - * inventory of running processes, system performance information, resource utilization, - * and network dependencies.

      - *
    • - *
    • - *

      The information collected by agents is secured at rest and in transit to the - * Application Discovery Service database in the cloud.

      - *
    • - *
    - *
  • - *
- *
    - *
  • - *

    - * Amazon Web Services Partner Network (APN) solutions integrate with - * Application Discovery Service, enabling you to import details of your on-premises - * environment directly into Migration Hub without using the discovery connector or discovery - * agent.

    - *
      - *
    • - *

      Third-party application discovery tools can query Amazon Web Services Application Discovery - * Service, and they can write to the Application Discovery Service database using the - * public API.

      - *
    • - *
    • - *

      In this way, you can import data into Migration Hub and view it, so that you can - * associate applications with servers and track migrations.

      - *
    • - *
    - *
  • - *
- *

- * Recommendations - *

- *

We recommend that you use agent-based discovery for non-VMware environments, and - * whenever you want to collect information about network dependencies. You can run agent-based - * and agentless discovery simultaneously. Use agentless discovery to complete the initial - * infrastructure assessment quickly, and then install agents on select hosts to collect - * additional information.

- *

- * Working With This Guide - *

- *

This API reference provides descriptions, syntax, and usage examples for each of the - * actions and data types for Application Discovery Service. The topic for each action shows the - * API request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to - * access an API that is tailored to the programming language or platform that you're using. For - * more information, see Amazon Web Services - * SDKs.

- * - *
    - *
  • - *

    Remember that you must set your Migration Hub home region before you call any of - * these APIs.

    - *
  • - *
  • - *

    You must make API calls for write actions (create, notify, associate, disassociate, - * import, or put) while in your home region, or a HomeRegionNotSetException - * error is returned.

    - *
  • - *
  • - *

    API calls for read actions (list, describe, stop, and delete) are permitted outside - * of your home region.

    - *
  • - *
  • - *

    Although it is unlikely, the Migration Hub home region could change. If you call - * APIs outside the home region, an InvalidInputException is returned.

    - *
  • - *
  • - *

    You must call GetHomeRegion to obtain the latest Migration Hub home - * region.

    - *
  • - *
- *
- *

This guide is intended for use with the Amazon Web Services Application - * Discovery Service User Guide.

- * - *

All data is handled according to the Amazon Web Services - * Privacy Policy. You can operate Application Discovery Service offline to inspect - * collected data before it is shared with the service.

- *
- */ -export class ApplicationDiscoveryService extends ApplicationDiscoveryServiceClient { +const commands = { + AssociateConfigurationItemsToApplicationCommand, + BatchDeleteImportDataCommand, + CreateApplicationCommand, + CreateTagsCommand, + DeleteApplicationsCommand, + DeleteTagsCommand, + DescribeAgentsCommand, + DescribeConfigurationsCommand, + DescribeContinuousExportsCommand, + DescribeExportConfigurationsCommand, + DescribeExportTasksCommand, + DescribeImportTasksCommand, + DescribeTagsCommand, + DisassociateConfigurationItemsFromApplicationCommand, + ExportConfigurationsCommand, + GetDiscoverySummaryCommand, + ListConfigurationsCommand, + ListServerNeighborsCommand, + StartContinuousExportCommand, + StartDataCollectionByAgentIdsCommand, + StartExportTaskCommand, + StartImportTaskCommand, + StopContinuousExportCommand, + StopDataCollectionByAgentIdsCommand, + UpdateApplicationCommand, +}; + +export interface ApplicationDiscoveryService { /** - * @public - *

Associates one or more configuration items with an application.

+ * @see {@link AssociateConfigurationItemsToApplicationCommand} */ - public associateConfigurationItemsToApplication( + associateConfigurationItemsToApplication( args: AssociateConfigurationItemsToApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateConfigurationItemsToApplication( + associateConfigurationItemsToApplication( args: AssociateConfigurationItemsToApplicationCommandInput, cb: (err: any, data?: AssociateConfigurationItemsToApplicationCommandOutput) => void ): void; - public associateConfigurationItemsToApplication( + associateConfigurationItemsToApplication( args: AssociateConfigurationItemsToApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateConfigurationItemsToApplicationCommandOutput) => void ): void; - public associateConfigurationItemsToApplication( - args: AssociateConfigurationItemsToApplicationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AssociateConfigurationItemsToApplicationCommandOutput) => void), - cb?: (err: any, data?: AssociateConfigurationItemsToApplicationCommandOutput) => void - ): Promise | void { - const command = new AssociateConfigurationItemsToApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes one or more import tasks, each identified by their import ID. Each import task has - * a number of records that can identify servers or applications.

- *

Amazon Web Services Application Discovery Service has built-in matching logic that will identify when - * discovered servers match existing entries that you've previously discovered, the information - * for the already-existing discovered server is updated. When you delete an import task that - * contains records that were used to match, the information in those matched records that comes - * from the deleted records will also be deleted.

+ * @see {@link BatchDeleteImportDataCommand} */ - public batchDeleteImportData( + batchDeleteImportData( args: BatchDeleteImportDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeleteImportData( + batchDeleteImportData( args: BatchDeleteImportDataCommandInput, cb: (err: any, data?: BatchDeleteImportDataCommandOutput) => void ): void; - public batchDeleteImportData( + batchDeleteImportData( args: BatchDeleteImportDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteImportDataCommandOutput) => void ): void; - public batchDeleteImportData( - args: BatchDeleteImportDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeleteImportDataCommandOutput) => void), - cb?: (err: any, data?: BatchDeleteImportDataCommandOutput) => void - ): Promise | void { - const command = new BatchDeleteImportDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an application with the given name and description.

+ * @see {@link CreateApplicationCommand} */ - public createApplication( + createApplication( args: CreateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApplication( + createApplication( args: CreateApplicationCommandInput, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( + createApplication( args: CreateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( - args: CreateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApplicationCommandOutput) => void), - cb?: (err: any, data?: CreateApplicationCommandOutput) => void - ): Promise | void { - const command = new CreateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates one or more tags for configuration items. Tags are metadata that help you - * categorize IT assets. This API accepts a list of multiple configuration items.

- * - *

Do not store sensitive information (like personal data) in tags.

- *
+ * @see {@link CreateTagsCommand} */ - public createTags(args: CreateTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public createTags(args: CreateTagsCommandInput, cb: (err: any, data?: CreateTagsCommandOutput) => void): void; - public createTags( + createTags(args: CreateTagsCommandInput, options?: __HttpHandlerOptions): Promise; + createTags(args: CreateTagsCommandInput, cb: (err: any, data?: CreateTagsCommandOutput) => void): void; + createTags( args: CreateTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTagsCommandOutput) => void ): void; - public createTags( - args: CreateTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTagsCommandOutput) => void), - cb?: (err: any, data?: CreateTagsCommandOutput) => void - ): Promise | void { - const command = new CreateTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a list of applications and their associations with configuration - * items.

+ * @see {@link DeleteApplicationsCommand} */ - public deleteApplications( + deleteApplications( args: DeleteApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplications( + deleteApplications( args: DeleteApplicationsCommandInput, cb: (err: any, data?: DeleteApplicationsCommandOutput) => void ): void; - public deleteApplications( + deleteApplications( args: DeleteApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationsCommandOutput) => void ): void; - public deleteApplications( - args: DeleteApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApplicationsCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationsCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the association between configuration items and one or more tags. This API - * accepts a list of multiple configuration items.

+ * @see {@link DeleteTagsCommand} */ - public deleteTags(args: DeleteTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteTags(args: DeleteTagsCommandInput, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void; - public deleteTags( + deleteTags(args: DeleteTagsCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTags(args: DeleteTagsCommandInput, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void; + deleteTags( args: DeleteTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTagsCommandOutput) => void ): void; - public deleteTags( - args: DeleteTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTagsCommandOutput) => void), - cb?: (err: any, data?: DeleteTagsCommandOutput) => void - ): Promise | void { - const command = new DeleteTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists agents or connectors as specified by ID or other filters. All agents/connectors - * associated with your user account can be listed if you call DescribeAgents as is - * without passing any parameters.

+ * @see {@link DescribeAgentsCommand} */ - public describeAgents( + describeAgents( args: DescribeAgentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAgents( - args: DescribeAgentsCommandInput, - cb: (err: any, data?: DescribeAgentsCommandOutput) => void - ): void; - public describeAgents( + describeAgents(args: DescribeAgentsCommandInput, cb: (err: any, data?: DescribeAgentsCommandOutput) => void): void; + describeAgents( args: DescribeAgentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAgentsCommandOutput) => void ): void; - public describeAgents( - args: DescribeAgentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAgentsCommandOutput) => void), - cb?: (err: any, data?: DescribeAgentsCommandOutput) => void - ): Promise | void { - const command = new DescribeAgentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves attributes for a list of configuration item IDs.

- * - *

All of the supplied IDs must be for the same asset type from one of the - * following:

- *
    - *
  • - *

    server

    - *
  • - *
  • - *

    application

    - *
  • - *
  • - *

    process

    - *
  • - *
  • - *

    connection

    - *
  • - *
- *

Output fields are specific to the asset type specified. For example, the output for a - * server configuration item includes a list of attributes about the - * server, such as host name, operating system, number of network cards, etc.

- *

For a complete list of outputs for each asset type, see Using the DescribeConfigurations Action in the Amazon Web Services Application - * Discovery Service User Guide.

- *
+ * @see {@link DescribeConfigurationsCommand} */ - public describeConfigurations( + describeConfigurations( args: DescribeConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConfigurations( + describeConfigurations( args: DescribeConfigurationsCommandInput, cb: (err: any, data?: DescribeConfigurationsCommandOutput) => void ): void; - public describeConfigurations( + describeConfigurations( args: DescribeConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigurationsCommandOutput) => void ): void; - public describeConfigurations( - args: DescribeConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConfigurationsCommandOutput) => void), - cb?: (err: any, data?: DescribeConfigurationsCommandOutput) => void - ): Promise | void { - const command = new DescribeConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists exports as specified by ID. All continuous exports associated with your user - * account can be listed if you call DescribeContinuousExports as is without passing - * any parameters.

+ * @see {@link DescribeContinuousExportsCommand} */ - public describeContinuousExports( + describeContinuousExports( args: DescribeContinuousExportsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeContinuousExports( + describeContinuousExports( args: DescribeContinuousExportsCommandInput, cb: (err: any, data?: DescribeContinuousExportsCommandOutput) => void ): void; - public describeContinuousExports( + describeContinuousExports( args: DescribeContinuousExportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeContinuousExportsCommandOutput) => void ): void; - public describeContinuousExports( - args: DescribeContinuousExportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeContinuousExportsCommandOutput) => void), - cb?: (err: any, data?: DescribeContinuousExportsCommandOutput) => void - ): Promise | void { - const command = new DescribeContinuousExportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

- * DescribeExportConfigurations is deprecated. Use DescribeExportTasks, instead.

+ * @see {@link DescribeExportConfigurationsCommand} */ - public describeExportConfigurations( + describeExportConfigurations( args: DescribeExportConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeExportConfigurations( + describeExportConfigurations( args: DescribeExportConfigurationsCommandInput, cb: (err: any, data?: DescribeExportConfigurationsCommandOutput) => void ): void; - public describeExportConfigurations( + describeExportConfigurations( args: DescribeExportConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExportConfigurationsCommandOutput) => void ): void; - public describeExportConfigurations( - args: DescribeExportConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeExportConfigurationsCommandOutput) => void), - cb?: (err: any, data?: DescribeExportConfigurationsCommandOutput) => void - ): Promise | void { - const command = new DescribeExportConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieve status of one or more export tasks. You can retrieve the status of up to 100 - * export tasks.

+ * @see {@link DescribeExportTasksCommand} */ - public describeExportTasks( + describeExportTasks( args: DescribeExportTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeExportTasks( + describeExportTasks( args: DescribeExportTasksCommandInput, cb: (err: any, data?: DescribeExportTasksCommandOutput) => void ): void; - public describeExportTasks( + describeExportTasks( args: DescribeExportTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExportTasksCommandOutput) => void ): void; - public describeExportTasks( - args: DescribeExportTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeExportTasksCommandOutput) => void), - cb?: (err: any, data?: DescribeExportTasksCommandOutput) => void - ): Promise | void { - const command = new DescribeExportTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of import tasks for your account, including status information, times, - * IDs, the Amazon S3 Object URL for the import file, and more.

+ * @see {@link DescribeImportTasksCommand} */ - public describeImportTasks( + describeImportTasks( args: DescribeImportTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeImportTasks( + describeImportTasks( args: DescribeImportTasksCommandInput, cb: (err: any, data?: DescribeImportTasksCommandOutput) => void ): void; - public describeImportTasks( + describeImportTasks( args: DescribeImportTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImportTasksCommandOutput) => void ): void; - public describeImportTasks( - args: DescribeImportTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeImportTasksCommandOutput) => void), - cb?: (err: any, data?: DescribeImportTasksCommandOutput) => void - ): Promise | void { - const command = new DescribeImportTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of configuration items that have tags as specified by the key-value - * pairs, name and value, passed to the optional parameter filters.

- *

There are three valid tag filter names:

- *
    - *
  • - *

    tagKey

    - *
  • - *
  • - *

    tagValue

    - *
  • - *
  • - *

    configurationId

    - *
  • - *
- *

Also, all configuration items associated with your user account that have tags can be - * listed if you call DescribeTags as is without passing any parameters.

+ * @see {@link DescribeTagsCommand} */ - public describeTags( - args: DescribeTagsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeTags(args: DescribeTagsCommandInput, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void; - public describeTags( + describeTags(args: DescribeTagsCommandInput, options?: __HttpHandlerOptions): Promise; + describeTags(args: DescribeTagsCommandInput, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void; + describeTags( args: DescribeTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTagsCommandOutput) => void ): void; - public describeTags( - args: DescribeTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTagsCommandOutput) => void), - cb?: (err: any, data?: DescribeTagsCommandOutput) => void - ): Promise | void { - const command = new DescribeTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates one or more configuration items from an application.

+ * @see {@link DisassociateConfigurationItemsFromApplicationCommand} */ - public disassociateConfigurationItemsFromApplication( + disassociateConfigurationItemsFromApplication( args: DisassociateConfigurationItemsFromApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateConfigurationItemsFromApplication( + disassociateConfigurationItemsFromApplication( args: DisassociateConfigurationItemsFromApplicationCommandInput, cb: (err: any, data?: DisassociateConfigurationItemsFromApplicationCommandOutput) => void ): void; - public disassociateConfigurationItemsFromApplication( + disassociateConfigurationItemsFromApplication( args: DisassociateConfigurationItemsFromApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateConfigurationItemsFromApplicationCommandOutput) => void ): void; - public disassociateConfigurationItemsFromApplication( - args: DisassociateConfigurationItemsFromApplicationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociateConfigurationItemsFromApplicationCommandOutput) => void), - cb?: (err: any, data?: DisassociateConfigurationItemsFromApplicationCommandOutput) => void - ): Promise | void { - const command = new DisassociateConfigurationItemsFromApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Deprecated. Use StartExportTask instead.

- *

Exports all discovered configuration data to an Amazon S3 bucket or an application that - * enables you to view and evaluate the data. Data includes tags and tag associations, processes, - * connections, servers, and system performance. This API returns an export ID that you can query - * using the DescribeExportConfigurations API. The system imposes a limit of - * two configuration exports in six hours.

+ * @see {@link ExportConfigurationsCommand} */ - public exportConfigurations( + exportConfigurations( args: ExportConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public exportConfigurations( + exportConfigurations( args: ExportConfigurationsCommandInput, cb: (err: any, data?: ExportConfigurationsCommandOutput) => void ): void; - public exportConfigurations( + exportConfigurations( args: ExportConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportConfigurationsCommandOutput) => void ): void; - public exportConfigurations( - args: ExportConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ExportConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ExportConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a short summary of discovered assets.

- *

This API operation takes no request parameters and is called as is at the command - * prompt as shown in the example.

+ * @see {@link GetDiscoverySummaryCommand} */ - public getDiscoverySummary( + getDiscoverySummary( args: GetDiscoverySummaryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDiscoverySummary( + getDiscoverySummary( args: GetDiscoverySummaryCommandInput, cb: (err: any, data?: GetDiscoverySummaryCommandOutput) => void ): void; - public getDiscoverySummary( + getDiscoverySummary( args: GetDiscoverySummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDiscoverySummaryCommandOutput) => void ): void; - public getDiscoverySummary( - args: GetDiscoverySummaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDiscoverySummaryCommandOutput) => void), - cb?: (err: any, data?: GetDiscoverySummaryCommandOutput) => void - ): Promise | void { - const command = new GetDiscoverySummaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of configuration items as specified by the value passed to the - * required parameter configurationType. Optional filtering may be applied to refine - * search results.

+ * @see {@link ListConfigurationsCommand} */ - public listConfigurations( + listConfigurations( args: ListConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConfigurations( + listConfigurations( args: ListConfigurationsCommandInput, cb: (err: any, data?: ListConfigurationsCommandOutput) => void ): void; - public listConfigurations( + listConfigurations( args: ListConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConfigurationsCommandOutput) => void ): void; - public listConfigurations( - args: ListConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of servers that are one network hop away from a specified - * server.

+ * @see {@link ListServerNeighborsCommand} */ - public listServerNeighbors( + listServerNeighbors( args: ListServerNeighborsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listServerNeighbors( + listServerNeighbors( args: ListServerNeighborsCommandInput, cb: (err: any, data?: ListServerNeighborsCommandOutput) => void ): void; - public listServerNeighbors( + listServerNeighbors( args: ListServerNeighborsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServerNeighborsCommandOutput) => void ): void; - public listServerNeighbors( - args: ListServerNeighborsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServerNeighborsCommandOutput) => void), - cb?: (err: any, data?: ListServerNeighborsCommandOutput) => void - ): Promise | void { - const command = new ListServerNeighborsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Start the continuous flow of agent's discovered data into Amazon Athena.

+ * @see {@link StartContinuousExportCommand} */ - public startContinuousExport( + startContinuousExport( args: StartContinuousExportCommandInput, options?: __HttpHandlerOptions ): Promise; - public startContinuousExport( + startContinuousExport( args: StartContinuousExportCommandInput, cb: (err: any, data?: StartContinuousExportCommandOutput) => void ): void; - public startContinuousExport( + startContinuousExport( args: StartContinuousExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartContinuousExportCommandOutput) => void ): void; - public startContinuousExport( - args: StartContinuousExportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartContinuousExportCommandOutput) => void), - cb?: (err: any, data?: StartContinuousExportCommandOutput) => void - ): Promise | void { - const command = new StartContinuousExportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Instructs the specified agents or connectors to start collecting data.

+ * @see {@link StartDataCollectionByAgentIdsCommand} */ - public startDataCollectionByAgentIds( + startDataCollectionByAgentIds( args: StartDataCollectionByAgentIdsCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDataCollectionByAgentIds( + startDataCollectionByAgentIds( args: StartDataCollectionByAgentIdsCommandInput, cb: (err: any, data?: StartDataCollectionByAgentIdsCommandOutput) => void ): void; - public startDataCollectionByAgentIds( + startDataCollectionByAgentIds( args: StartDataCollectionByAgentIdsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDataCollectionByAgentIdsCommandOutput) => void ): void; - public startDataCollectionByAgentIds( - args: StartDataCollectionByAgentIdsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDataCollectionByAgentIdsCommandOutput) => void), - cb?: (err: any, data?: StartDataCollectionByAgentIdsCommandOutput) => void - ): Promise | void { - const command = new StartDataCollectionByAgentIdsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Begins the export of discovered data to an S3 bucket.

- *

If you specify agentIds in a filter, the task exports up to 72 hours of - * detailed data collected by the identified Application Discovery Agent, including network, - * process, and performance details. A time range for exported agent data may be set by using - * startTime and endTime. Export of detailed agent data is limited to - * five concurrently running exports.

- *

If you do not include an agentIds filter, summary data is exported that - * includes both Amazon Web Services Agentless Discovery Connector data and summary data from Amazon Web Services Discovery - * Agents. Export of summary data is limited to two exports per day.

+ * @see {@link StartExportTaskCommand} */ - public startExportTask( + startExportTask( args: StartExportTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public startExportTask( - args: StartExportTaskCommandInput, - cb: (err: any, data?: StartExportTaskCommandOutput) => void - ): void; - public startExportTask( + startExportTask(args: StartExportTaskCommandInput, cb: (err: any, data?: StartExportTaskCommandOutput) => void): void; + startExportTask( args: StartExportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartExportTaskCommandOutput) => void ): void; - public startExportTask( - args: StartExportTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartExportTaskCommandOutput) => void), - cb?: (err: any, data?: StartExportTaskCommandOutput) => void - ): Promise | void { - const command = new StartExportTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts an import task, which allows you to import details of your on-premises environment - * directly into Amazon Web Services Migration Hub without having to use the Application Discovery Service (ADS) - * tools such as the Discovery Connector or Discovery Agent. This gives you the option to perform - * migration assessment and planning directly from your imported data, including the ability to - * group your devices as applications and track their migration status.

- *

To start an import request, do this:

- *
    - *
  1. - *

    Download the specially formatted comma separated value (CSV) import template, which - * you can find here: https://s3.us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv.

    - *
  2. - *
  3. - *

    Fill out the template with your server and application data.

    - *
  4. - *
  5. - *

    Upload your import file to an Amazon S3 bucket, and make a note of it's Object URL. - * Your import file must be in the CSV format.

    - *
  6. - *
  7. - *

    Use the console or the StartImportTask command with the Amazon Web Services CLI or one of - * the Amazon Web Services SDKs to import the records from your file.

    - *
  8. - *
- *

For more information, including step-by-step procedures, see Migration Hub - * Import in the Amazon Web Services Application Discovery Service User - * Guide.

- * - *

There are limits to the number of import tasks you can create (and delete) in an Amazon Web Services - * account. For more information, see Amazon Web Services Application - * Discovery Service Limits in the Amazon Web Services Application Discovery Service User - * Guide.

- *
+ * @see {@link StartImportTaskCommand} */ - public startImportTask( + startImportTask( args: StartImportTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public startImportTask( - args: StartImportTaskCommandInput, - cb: (err: any, data?: StartImportTaskCommandOutput) => void - ): void; - public startImportTask( + startImportTask(args: StartImportTaskCommandInput, cb: (err: any, data?: StartImportTaskCommandOutput) => void): void; + startImportTask( args: StartImportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartImportTaskCommandOutput) => void ): void; - public startImportTask( - args: StartImportTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartImportTaskCommandOutput) => void), - cb?: (err: any, data?: StartImportTaskCommandOutput) => void - ): Promise | void { - const command = new StartImportTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stop the continuous flow of agent's discovered data into Amazon Athena.

+ * @see {@link StopContinuousExportCommand} */ - public stopContinuousExport( + stopContinuousExport( args: StopContinuousExportCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopContinuousExport( + stopContinuousExport( args: StopContinuousExportCommandInput, cb: (err: any, data?: StopContinuousExportCommandOutput) => void ): void; - public stopContinuousExport( + stopContinuousExport( args: StopContinuousExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopContinuousExportCommandOutput) => void ): void; - public stopContinuousExport( - args: StopContinuousExportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopContinuousExportCommandOutput) => void), - cb?: (err: any, data?: StopContinuousExportCommandOutput) => void - ): Promise | void { - const command = new StopContinuousExportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Instructs the specified agents or connectors to stop collecting data.

+ * @see {@link StopDataCollectionByAgentIdsCommand} */ - public stopDataCollectionByAgentIds( + stopDataCollectionByAgentIds( args: StopDataCollectionByAgentIdsCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopDataCollectionByAgentIds( + stopDataCollectionByAgentIds( args: StopDataCollectionByAgentIdsCommandInput, cb: (err: any, data?: StopDataCollectionByAgentIdsCommandOutput) => void ): void; - public stopDataCollectionByAgentIds( + stopDataCollectionByAgentIds( args: StopDataCollectionByAgentIdsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDataCollectionByAgentIdsCommandOutput) => void ): void; - public stopDataCollectionByAgentIds( - args: StopDataCollectionByAgentIdsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopDataCollectionByAgentIdsCommandOutput) => void), - cb?: (err: any, data?: StopDataCollectionByAgentIdsCommandOutput) => void - ): Promise | void { - const command = new StopDataCollectionByAgentIdsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates metadata about an application.

+ * @see {@link UpdateApplicationCommand} */ - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( - args: UpdateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApplicationCommandOutput) => void), - cb?: (err: any, data?: UpdateApplicationCommandOutput) => void - ): Promise | void { - const command = new UpdateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Web Services Application Discovery Service + *

Amazon Web Services Application Discovery Service helps you plan application migration projects. It + * automatically identifies servers, virtual machines (VMs), and network dependencies in your + * on-premises data centers. For more information, see the Amazon Web Services Application Discovery Service FAQ. + * Application Discovery Service offers three ways of performing discovery and + * collecting data about your on-premises servers:

+ *
    + *
  • + *

    + * Agentless discovery is recommended for environments + * that use VMware vCenter Server. This mode doesn't require you to install an agent on each + * host. It does not work in non-VMware environments.

    + *
      + *
    • + *

      Agentless discovery gathers server information regardless of the operating + * systems, which minimizes the time required for initial on-premises infrastructure + * assessment.

      + *
    • + *
    • + *

      Agentless discovery doesn't collect information about network dependencies, only + * agent-based discovery collects that information.

      + *
    • + *
    + *
  • + *
+ *
    + *
  • + *

    + * Agent-based discovery collects a richer set of data + * than agentless discovery by using the Amazon Web Services Application Discovery Agent, which you install + * on one or more hosts in your data center.

    + *
      + *
    • + *

      The agent captures infrastructure and application information, including an + * inventory of running processes, system performance information, resource utilization, + * and network dependencies.

      + *
    • + *
    • + *

      The information collected by agents is secured at rest and in transit to the + * Application Discovery Service database in the cloud.

      + *
    • + *
    + *
  • + *
+ *
    + *
  • + *

    + * Amazon Web Services Partner Network (APN) solutions integrate with + * Application Discovery Service, enabling you to import details of your on-premises + * environment directly into Migration Hub without using the discovery connector or discovery + * agent.

    + *
      + *
    • + *

      Third-party application discovery tools can query Amazon Web Services Application Discovery + * Service, and they can write to the Application Discovery Service database using the + * public API.

      + *
    • + *
    • + *

      In this way, you can import data into Migration Hub and view it, so that you can + * associate applications with servers and track migrations.

      + *
    • + *
    + *
  • + *
+ *

+ * Recommendations + *

+ *

We recommend that you use agent-based discovery for non-VMware environments, and + * whenever you want to collect information about network dependencies. You can run agent-based + * and agentless discovery simultaneously. Use agentless discovery to complete the initial + * infrastructure assessment quickly, and then install agents on select hosts to collect + * additional information.

+ *

+ * Working With This Guide + *

+ *

This API reference provides descriptions, syntax, and usage examples for each of the + * actions and data types for Application Discovery Service. The topic for each action shows the + * API request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to + * access an API that is tailored to the programming language or platform that you're using. For + * more information, see Amazon Web Services + * SDKs.

+ * + *
    + *
  • + *

    Remember that you must set your Migration Hub home region before you call any of + * these APIs.

    + *
  • + *
  • + *

    You must make API calls for write actions (create, notify, associate, disassociate, + * import, or put) while in your home region, or a HomeRegionNotSetException + * error is returned.

    + *
  • + *
  • + *

    API calls for read actions (list, describe, stop, and delete) are permitted outside + * of your home region.

    + *
  • + *
  • + *

    Although it is unlikely, the Migration Hub home region could change. If you call + * APIs outside the home region, an InvalidInputException is returned.

    + *
  • + *
  • + *

    You must call GetHomeRegion to obtain the latest Migration Hub home + * region.

    + *
  • + *
+ *
+ *

This guide is intended for use with the Amazon Web Services Application + * Discovery Service User Guide.

+ * + *

All data is handled according to the Amazon Web Services + * Privacy Policy. You can operate Application Discovery Service offline to inspect + * collected data before it is shared with the service.

+ *
+ */ +export class ApplicationDiscoveryService + extends ApplicationDiscoveryServiceClient + implements ApplicationDiscoveryService {} +createAggregatedClient(commands, ApplicationDiscoveryService); diff --git a/clients/client-application-insights/src/ApplicationInsights.ts b/clients/client-application-insights/src/ApplicationInsights.ts index bd23511f7d8f..711dd4379133 100644 --- a/clients/client-application-insights/src/ApplicationInsights.ts +++ b/clients/client-application-insights/src/ApplicationInsights.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { ApplicationInsightsClient } from "./ApplicationInsightsClient"; +import { ApplicationInsightsClient, ApplicationInsightsClientConfig } from "./ApplicationInsightsClient"; import { CreateApplicationCommand, CreateApplicationCommandInput, @@ -134,935 +135,475 @@ import { UpdateLogPatternCommandOutput, } from "./commands/UpdateLogPatternCommand"; -/** - * @public - * Amazon CloudWatch Application Insights - *

Amazon CloudWatch Application Insights is a service that helps you detect common - * problems with your applications. It enables you to pinpoint the source of issues in your - * applications (built with technologies such as Microsoft IIS, .NET, and Microsoft SQL - * Server), by providing key insights into detected problems.

- *

After you onboard your application, CloudWatch Application Insights identifies, - * recommends, and sets up metrics and logs. It continuously analyzes and correlates your - * metrics and logs for unusual behavior to surface actionable problems with your application. - * For example, if your application is slow and unresponsive and leading to HTTP 500 errors in - * your Application Load Balancer (ALB), Application Insights informs you that a memory - * pressure problem with your SQL Server database is occurring. It bases this analysis on - * impactful metrics and log errors.

- */ -export class ApplicationInsights extends ApplicationInsightsClient { +const commands = { + CreateApplicationCommand, + CreateComponentCommand, + CreateLogPatternCommand, + DeleteApplicationCommand, + DeleteComponentCommand, + DeleteLogPatternCommand, + DescribeApplicationCommand, + DescribeComponentCommand, + DescribeComponentConfigurationCommand, + DescribeComponentConfigurationRecommendationCommand, + DescribeLogPatternCommand, + DescribeObservationCommand, + DescribeProblemCommand, + DescribeProblemObservationsCommand, + ListApplicationsCommand, + ListComponentsCommand, + ListConfigurationHistoryCommand, + ListLogPatternsCommand, + ListLogPatternSetsCommand, + ListProblemsCommand, + ListTagsForResourceCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateApplicationCommand, + UpdateComponentCommand, + UpdateComponentConfigurationCommand, + UpdateLogPatternCommand, +}; + +export interface ApplicationInsights { /** - * @public - *

Adds an application that is created from a resource group.

+ * @see {@link CreateApplicationCommand} */ - public createApplication( + createApplication( args: CreateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApplication( + createApplication( args: CreateApplicationCommandInput, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( + createApplication( args: CreateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( - args: CreateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApplicationCommandOutput) => void), - cb?: (err: any, data?: CreateApplicationCommandOutput) => void - ): Promise | void { - const command = new CreateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a custom component by grouping similar standalone instances to monitor.

+ * @see {@link CreateComponentCommand} */ - public createComponent( + createComponent( args: CreateComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createComponent( - args: CreateComponentCommandInput, - cb: (err: any, data?: CreateComponentCommandOutput) => void - ): void; - public createComponent( + createComponent(args: CreateComponentCommandInput, cb: (err: any, data?: CreateComponentCommandOutput) => void): void; + createComponent( args: CreateComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateComponentCommandOutput) => void ): void; - public createComponent( - args: CreateComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateComponentCommandOutput) => void), - cb?: (err: any, data?: CreateComponentCommandOutput) => void - ): Promise | void { - const command = new CreateComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds an log pattern to a LogPatternSet.

+ * @see {@link CreateLogPatternCommand} */ - public createLogPattern( + createLogPattern( args: CreateLogPatternCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLogPattern( + createLogPattern( args: CreateLogPatternCommandInput, cb: (err: any, data?: CreateLogPatternCommandOutput) => void ): void; - public createLogPattern( + createLogPattern( args: CreateLogPatternCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLogPatternCommandOutput) => void ): void; - public createLogPattern( - args: CreateLogPatternCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLogPatternCommandOutput) => void), - cb?: (err: any, data?: CreateLogPatternCommandOutput) => void - ): Promise | void { - const command = new CreateLogPatternCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified application from monitoring. Does not delete the - * application.

+ * @see {@link DeleteApplicationCommand} */ - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( - args: DeleteApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApplicationCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Ungroups a custom component. When you ungroup custom components, all applicable monitors - * that are set up for the component are removed and the instances revert to their standalone - * status.

+ * @see {@link DeleteComponentCommand} */ - public deleteComponent( + deleteComponent( args: DeleteComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteComponent( - args: DeleteComponentCommandInput, - cb: (err: any, data?: DeleteComponentCommandOutput) => void - ): void; - public deleteComponent( + deleteComponent(args: DeleteComponentCommandInput, cb: (err: any, data?: DeleteComponentCommandOutput) => void): void; + deleteComponent( args: DeleteComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteComponentCommandOutput) => void ): void; - public deleteComponent( - args: DeleteComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteComponentCommandOutput) => void), - cb?: (err: any, data?: DeleteComponentCommandOutput) => void - ): Promise | void { - const command = new DeleteComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified log pattern from a LogPatternSet.

+ * @see {@link DeleteLogPatternCommand} */ - public deleteLogPattern( + deleteLogPattern( args: DeleteLogPatternCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLogPattern( + deleteLogPattern( args: DeleteLogPatternCommandInput, cb: (err: any, data?: DeleteLogPatternCommandOutput) => void ): void; - public deleteLogPattern( + deleteLogPattern( args: DeleteLogPatternCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLogPatternCommandOutput) => void ): void; - public deleteLogPattern( - args: DeleteLogPatternCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLogPatternCommandOutput) => void), - cb?: (err: any, data?: DeleteLogPatternCommandOutput) => void - ): Promise | void { - const command = new DeleteLogPatternCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the application.

+ * @see {@link DescribeApplicationCommand} */ - public describeApplication( + describeApplication( args: DescribeApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeApplication( + describeApplication( args: DescribeApplicationCommandInput, cb: (err: any, data?: DescribeApplicationCommandOutput) => void ): void; - public describeApplication( + describeApplication( args: DescribeApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeApplicationCommandOutput) => void ): void; - public describeApplication( - args: DescribeApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeApplicationCommandOutput) => void), - cb?: (err: any, data?: DescribeApplicationCommandOutput) => void - ): Promise | void { - const command = new DescribeApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a component and lists the resources that are grouped together in a - * component.

+ * @see {@link DescribeComponentCommand} */ - public describeComponent( + describeComponent( args: DescribeComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeComponent( + describeComponent( args: DescribeComponentCommandInput, cb: (err: any, data?: DescribeComponentCommandOutput) => void ): void; - public describeComponent( + describeComponent( args: DescribeComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeComponentCommandOutput) => void ): void; - public describeComponent( - args: DescribeComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeComponentCommandOutput) => void), - cb?: (err: any, data?: DescribeComponentCommandOutput) => void - ): Promise | void { - const command = new DescribeComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the monitoring configuration of the component.

+ * @see {@link DescribeComponentConfigurationCommand} */ - public describeComponentConfiguration( + describeComponentConfiguration( args: DescribeComponentConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeComponentConfiguration( + describeComponentConfiguration( args: DescribeComponentConfigurationCommandInput, cb: (err: any, data?: DescribeComponentConfigurationCommandOutput) => void ): void; - public describeComponentConfiguration( + describeComponentConfiguration( args: DescribeComponentConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeComponentConfigurationCommandOutput) => void ): void; - public describeComponentConfiguration( - args: DescribeComponentConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeComponentConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeComponentConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeComponentConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the recommended monitoring configuration of the component.

+ * @see {@link DescribeComponentConfigurationRecommendationCommand} */ - public describeComponentConfigurationRecommendation( + describeComponentConfigurationRecommendation( args: DescribeComponentConfigurationRecommendationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeComponentConfigurationRecommendation( + describeComponentConfigurationRecommendation( args: DescribeComponentConfigurationRecommendationCommandInput, cb: (err: any, data?: DescribeComponentConfigurationRecommendationCommandOutput) => void ): void; - public describeComponentConfigurationRecommendation( + describeComponentConfigurationRecommendation( args: DescribeComponentConfigurationRecommendationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeComponentConfigurationRecommendationCommandOutput) => void ): void; - public describeComponentConfigurationRecommendation( - args: DescribeComponentConfigurationRecommendationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeComponentConfigurationRecommendationCommandOutput) => void), - cb?: (err: any, data?: DescribeComponentConfigurationRecommendationCommandOutput) => void - ): Promise | void { - const command = new DescribeComponentConfigurationRecommendationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describe a specific log pattern from a LogPatternSet.

+ * @see {@link DescribeLogPatternCommand} */ - public describeLogPattern( + describeLogPattern( args: DescribeLogPatternCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLogPattern( + describeLogPattern( args: DescribeLogPatternCommandInput, cb: (err: any, data?: DescribeLogPatternCommandOutput) => void ): void; - public describeLogPattern( + describeLogPattern( args: DescribeLogPatternCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLogPatternCommandOutput) => void ): void; - public describeLogPattern( - args: DescribeLogPatternCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLogPatternCommandOutput) => void), - cb?: (err: any, data?: DescribeLogPatternCommandOutput) => void - ): Promise | void { - const command = new DescribeLogPatternCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an anomaly or error with the application.

+ * @see {@link DescribeObservationCommand} */ - public describeObservation( + describeObservation( args: DescribeObservationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeObservation( + describeObservation( args: DescribeObservationCommandInput, cb: (err: any, data?: DescribeObservationCommandOutput) => void ): void; - public describeObservation( + describeObservation( args: DescribeObservationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeObservationCommandOutput) => void ): void; - public describeObservation( - args: DescribeObservationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeObservationCommandOutput) => void), - cb?: (err: any, data?: DescribeObservationCommandOutput) => void - ): Promise | void { - const command = new DescribeObservationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an application problem.

+ * @see {@link DescribeProblemCommand} */ - public describeProblem( + describeProblem( args: DescribeProblemCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProblem( - args: DescribeProblemCommandInput, - cb: (err: any, data?: DescribeProblemCommandOutput) => void - ): void; - public describeProblem( + describeProblem(args: DescribeProblemCommandInput, cb: (err: any, data?: DescribeProblemCommandOutput) => void): void; + describeProblem( args: DescribeProblemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProblemCommandOutput) => void ): void; - public describeProblem( - args: DescribeProblemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProblemCommandOutput) => void), - cb?: (err: any, data?: DescribeProblemCommandOutput) => void - ): Promise | void { - const command = new DescribeProblemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the anomalies or errors associated with the problem.

+ * @see {@link DescribeProblemObservationsCommand} */ - public describeProblemObservations( + describeProblemObservations( args: DescribeProblemObservationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProblemObservations( + describeProblemObservations( args: DescribeProblemObservationsCommandInput, cb: (err: any, data?: DescribeProblemObservationsCommandOutput) => void ): void; - public describeProblemObservations( + describeProblemObservations( args: DescribeProblemObservationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProblemObservationsCommandOutput) => void ): void; - public describeProblemObservations( - args: DescribeProblemObservationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProblemObservationsCommandOutput) => void), - cb?: (err: any, data?: DescribeProblemObservationsCommandOutput) => void - ): Promise | void { - const command = new DescribeProblemObservationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the IDs of the applications that you are monitoring.

+ * @see {@link ListApplicationsCommand} */ - public listApplications( + listApplications( args: ListApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplications( + listApplications( args: ListApplicationsCommandInput, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( + listApplications( args: ListApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( - args: ListApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationsCommandOutput) => void), - cb?: (err: any, data?: ListApplicationsCommandOutput) => void - ): Promise | void { - const command = new ListApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the auto-grouped, standalone, and custom components of the application.

+ * @see {@link ListComponentsCommand} */ - public listComponents( + listComponents( args: ListComponentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listComponents( - args: ListComponentsCommandInput, - cb: (err: any, data?: ListComponentsCommandOutput) => void - ): void; - public listComponents( + listComponents(args: ListComponentsCommandInput, cb: (err: any, data?: ListComponentsCommandOutput) => void): void; + listComponents( args: ListComponentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComponentsCommandOutput) => void ): void; - public listComponents( - args: ListComponentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListComponentsCommandOutput) => void), - cb?: (err: any, data?: ListComponentsCommandOutput) => void - ): Promise | void { - const command = new ListComponentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by - * Application Insights. Examples of events represented are:

- *
    - *
  • - *

    INFO: creating a new alarm or updating an alarm threshold.

    - *
  • - *
  • - *

    WARN: alarm not created due to insufficient data points used to predict - * thresholds.

    - *
  • - *
  • - *

    ERROR: alarm not created due to permission errors or exceeding quotas.

    - *
  • - *
+ * @see {@link ListConfigurationHistoryCommand} */ - public listConfigurationHistory( + listConfigurationHistory( args: ListConfigurationHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConfigurationHistory( + listConfigurationHistory( args: ListConfigurationHistoryCommandInput, cb: (err: any, data?: ListConfigurationHistoryCommandOutput) => void ): void; - public listConfigurationHistory( + listConfigurationHistory( args: ListConfigurationHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConfigurationHistoryCommandOutput) => void ): void; - public listConfigurationHistory( - args: ListConfigurationHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConfigurationHistoryCommandOutput) => void), - cb?: (err: any, data?: ListConfigurationHistoryCommandOutput) => void - ): Promise | void { - const command = new ListConfigurationHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the log patterns in the specific log LogPatternSet.

+ * @see {@link ListLogPatternsCommand} */ - public listLogPatterns( + listLogPatterns( args: ListLogPatternsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLogPatterns( - args: ListLogPatternsCommandInput, - cb: (err: any, data?: ListLogPatternsCommandOutput) => void - ): void; - public listLogPatterns( + listLogPatterns(args: ListLogPatternsCommandInput, cb: (err: any, data?: ListLogPatternsCommandOutput) => void): void; + listLogPatterns( args: ListLogPatternsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLogPatternsCommandOutput) => void ): void; - public listLogPatterns( - args: ListLogPatternsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLogPatternsCommandOutput) => void), - cb?: (err: any, data?: ListLogPatternsCommandOutput) => void - ): Promise | void { - const command = new ListLogPatternsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the log pattern sets in the specific application.

+ * @see {@link ListLogPatternSetsCommand} */ - public listLogPatternSets( + listLogPatternSets( args: ListLogPatternSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLogPatternSets( + listLogPatternSets( args: ListLogPatternSetsCommandInput, cb: (err: any, data?: ListLogPatternSetsCommandOutput) => void ): void; - public listLogPatternSets( + listLogPatternSets( args: ListLogPatternSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLogPatternSetsCommandOutput) => void ): void; - public listLogPatternSets( - args: ListLogPatternSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLogPatternSetsCommandOutput) => void), - cb?: (err: any, data?: ListLogPatternSetsCommandOutput) => void - ): Promise | void { - const command = new ListLogPatternSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the problems with your application.

+ * @see {@link ListProblemsCommand} */ - public listProblems( - args: ListProblemsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listProblems(args: ListProblemsCommandInput, cb: (err: any, data?: ListProblemsCommandOutput) => void): void; - public listProblems( + listProblems(args: ListProblemsCommandInput, options?: __HttpHandlerOptions): Promise; + listProblems(args: ListProblemsCommandInput, cb: (err: any, data?: ListProblemsCommandOutput) => void): void; + listProblems( args: ListProblemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProblemsCommandOutput) => void ): void; - public listProblems( - args: ListProblemsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProblemsCommandOutput) => void), - cb?: (err: any, data?: ListProblemsCommandOutput) => void - ): Promise | void { - const command = new ListProblemsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieve a list of the tags (keys and values) that are associated with a specified - * application. A tag is a label that you optionally define and associate - * with an application. Each tag consists of a required tag key and an - * optional associated tag value. A tag key is a general label that acts - * as a category for more specific tag values. A tag value acts as a descriptor within a tag - * key.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Add one or more tags (keys and values) to a specified application. A - * tag is a label that you optionally define and associate with an - * application. Tags can help you categorize and manage application in different ways, such as - * by purpose, owner, environment, or other criteria.

- *

Each tag consists of a required tag key and an associated - * tag value, both of which you define. A tag key is a general label - * that acts as a category for more specific tag values. A tag value acts as a descriptor - * within a tag key.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Remove one or more tags (keys and values) from a specified application.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the application.

+ * @see {@link UpdateApplicationCommand} */ - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( - args: UpdateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApplicationCommandOutput) => void), - cb?: (err: any, data?: UpdateApplicationCommandOutput) => void - ): Promise | void { - const command = new UpdateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the custom component name and/or the list of resources that make up the - * component.

+ * @see {@link UpdateComponentCommand} */ - public updateComponent( + updateComponent( args: UpdateComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateComponent( - args: UpdateComponentCommandInput, - cb: (err: any, data?: UpdateComponentCommandOutput) => void - ): void; - public updateComponent( + updateComponent(args: UpdateComponentCommandInput, cb: (err: any, data?: UpdateComponentCommandOutput) => void): void; + updateComponent( args: UpdateComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateComponentCommandOutput) => void ): void; - public updateComponent( - args: UpdateComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateComponentCommandOutput) => void), - cb?: (err: any, data?: UpdateComponentCommandOutput) => void - ): Promise | void { - const command = new UpdateComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the monitoring configurations for the component. The configuration input - * parameter is an escaped JSON of the configuration and should match the schema of what is - * returned by DescribeComponentConfigurationRecommendation.

+ * @see {@link UpdateComponentConfigurationCommand} */ - public updateComponentConfiguration( + updateComponentConfiguration( args: UpdateComponentConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateComponentConfiguration( + updateComponentConfiguration( args: UpdateComponentConfigurationCommandInput, cb: (err: any, data?: UpdateComponentConfigurationCommandOutput) => void ): void; - public updateComponentConfiguration( + updateComponentConfiguration( args: UpdateComponentConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateComponentConfigurationCommandOutput) => void ): void; - public updateComponentConfiguration( - args: UpdateComponentConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateComponentConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateComponentConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateComponentConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a log pattern to a LogPatternSet.

+ * @see {@link UpdateLogPatternCommand} */ - public updateLogPattern( + updateLogPattern( args: UpdateLogPatternCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLogPattern( + updateLogPattern( args: UpdateLogPatternCommandInput, cb: (err: any, data?: UpdateLogPatternCommandOutput) => void ): void; - public updateLogPattern( + updateLogPattern( args: UpdateLogPatternCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLogPatternCommandOutput) => void ): void; - public updateLogPattern( - args: UpdateLogPatternCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLogPatternCommandOutput) => void), - cb?: (err: any, data?: UpdateLogPatternCommandOutput) => void - ): Promise | void { - const command = new UpdateLogPatternCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon CloudWatch Application Insights + *

Amazon CloudWatch Application Insights is a service that helps you detect common + * problems with your applications. It enables you to pinpoint the source of issues in your + * applications (built with technologies such as Microsoft IIS, .NET, and Microsoft SQL + * Server), by providing key insights into detected problems.

+ *

After you onboard your application, CloudWatch Application Insights identifies, + * recommends, and sets up metrics and logs. It continuously analyzes and correlates your + * metrics and logs for unusual behavior to surface actionable problems with your application. + * For example, if your application is slow and unresponsive and leading to HTTP 500 errors in + * your Application Load Balancer (ALB), Application Insights informs you that a memory + * pressure problem with your SQL Server database is occurring. It bases this analysis on + * impactful metrics and log errors.

+ */ +export class ApplicationInsights extends ApplicationInsightsClient implements ApplicationInsights {} +createAggregatedClient(commands, ApplicationInsights); diff --git a/clients/client-applicationcostprofiler/src/ApplicationCostProfiler.ts b/clients/client-applicationcostprofiler/src/ApplicationCostProfiler.ts index 3f07c42efc48..77a161186284 100644 --- a/clients/client-applicationcostprofiler/src/ApplicationCostProfiler.ts +++ b/clients/client-applicationcostprofiler/src/ApplicationCostProfiler.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { ApplicationCostProfilerClient } from "./ApplicationCostProfilerClient"; +import { ApplicationCostProfilerClient, ApplicationCostProfilerClientConfig } from "./ApplicationCostProfilerClient"; import { DeleteReportDefinitionCommand, DeleteReportDefinitionCommandInput, @@ -33,216 +34,127 @@ import { UpdateReportDefinitionCommandOutput, } from "./commands/UpdateReportDefinitionCommand"; -/** - * @public - *

This reference provides descriptions of the AWS Application Cost Profiler API.

- *

The AWS Application Cost Profiler API provides programmatic access to view, create, update, and delete - * application cost report definitions, as well as to import your usage data into the Application Cost Profiler - * service.

- *

For more information about using this service, see the AWS Application Cost - * Profiler User Guide.

- */ -export class ApplicationCostProfiler extends ApplicationCostProfilerClient { +const commands = { + DeleteReportDefinitionCommand, + GetReportDefinitionCommand, + ImportApplicationUsageCommand, + ListReportDefinitionsCommand, + PutReportDefinitionCommand, + UpdateReportDefinitionCommand, +}; + +export interface ApplicationCostProfiler { /** - * @public - *

Deletes the specified report definition in AWS Application Cost Profiler. This stops the report from being - * generated.

+ * @see {@link DeleteReportDefinitionCommand} */ - public deleteReportDefinition( + deleteReportDefinition( args: DeleteReportDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteReportDefinition( + deleteReportDefinition( args: DeleteReportDefinitionCommandInput, cb: (err: any, data?: DeleteReportDefinitionCommandOutput) => void ): void; - public deleteReportDefinition( + deleteReportDefinition( args: DeleteReportDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReportDefinitionCommandOutput) => void ): void; - public deleteReportDefinition( - args: DeleteReportDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteReportDefinitionCommandOutput) => void), - cb?: (err: any, data?: DeleteReportDefinitionCommandOutput) => void - ): Promise | void { - const command = new DeleteReportDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the definition of a report already configured in AWS Application Cost Profiler.

+ * @see {@link GetReportDefinitionCommand} */ - public getReportDefinition( + getReportDefinition( args: GetReportDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReportDefinition( + getReportDefinition( args: GetReportDefinitionCommandInput, cb: (err: any, data?: GetReportDefinitionCommandOutput) => void ): void; - public getReportDefinition( + getReportDefinition( args: GetReportDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReportDefinitionCommandOutput) => void ): void; - public getReportDefinition( - args: GetReportDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReportDefinitionCommandOutput) => void), - cb?: (err: any, data?: GetReportDefinitionCommandOutput) => void - ): Promise | void { - const command = new GetReportDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Ingests application usage data from Amazon Simple Storage Service (Amazon S3).

- *

The data must already exist in the S3 location. As part of the action, AWS Application Cost Profiler - * copies the object from your S3 bucket to an S3 bucket owned by Amazon for processing - * asynchronously.

+ * @see {@link ImportApplicationUsageCommand} */ - public importApplicationUsage( + importApplicationUsage( args: ImportApplicationUsageCommandInput, options?: __HttpHandlerOptions ): Promise; - public importApplicationUsage( + importApplicationUsage( args: ImportApplicationUsageCommandInput, cb: (err: any, data?: ImportApplicationUsageCommandOutput) => void ): void; - public importApplicationUsage( + importApplicationUsage( args: ImportApplicationUsageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportApplicationUsageCommandOutput) => void ): void; - public importApplicationUsage( - args: ImportApplicationUsageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportApplicationUsageCommandOutput) => void), - cb?: (err: any, data?: ImportApplicationUsageCommandOutput) => void - ): Promise | void { - const command = new ImportApplicationUsageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of all reports and their configurations for your AWS account.

- *

The maximum number of reports is one.

+ * @see {@link ListReportDefinitionsCommand} */ - public listReportDefinitions( + listReportDefinitions( args: ListReportDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReportDefinitions( + listReportDefinitions( args: ListReportDefinitionsCommandInput, cb: (err: any, data?: ListReportDefinitionsCommandOutput) => void ): void; - public listReportDefinitions( + listReportDefinitions( args: ListReportDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReportDefinitionsCommandOutput) => void ): void; - public listReportDefinitions( - args: ListReportDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReportDefinitionsCommandOutput) => void), - cb?: (err: any, data?: ListReportDefinitionsCommandOutput) => void - ): Promise | void { - const command = new ListReportDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates the report definition for a report in Application Cost Profiler.

+ * @see {@link PutReportDefinitionCommand} */ - public putReportDefinition( + putReportDefinition( args: PutReportDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public putReportDefinition( + putReportDefinition( args: PutReportDefinitionCommandInput, cb: (err: any, data?: PutReportDefinitionCommandOutput) => void ): void; - public putReportDefinition( + putReportDefinition( args: PutReportDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutReportDefinitionCommandOutput) => void ): void; - public putReportDefinition( - args: PutReportDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutReportDefinitionCommandOutput) => void), - cb?: (err: any, data?: PutReportDefinitionCommandOutput) => void - ): Promise | void { - const command = new PutReportDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates existing report in AWS Application Cost Profiler.

+ * @see {@link UpdateReportDefinitionCommand} */ - public updateReportDefinition( + updateReportDefinition( args: UpdateReportDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateReportDefinition( + updateReportDefinition( args: UpdateReportDefinitionCommandInput, cb: (err: any, data?: UpdateReportDefinitionCommandOutput) => void ): void; - public updateReportDefinition( + updateReportDefinition( args: UpdateReportDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateReportDefinitionCommandOutput) => void ): void; - public updateReportDefinition( - args: UpdateReportDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateReportDefinitionCommandOutput) => void), - cb?: (err: any, data?: UpdateReportDefinitionCommandOutput) => void - ): Promise | void { - const command = new UpdateReportDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

This reference provides descriptions of the AWS Application Cost Profiler API.

+ *

The AWS Application Cost Profiler API provides programmatic access to view, create, update, and delete + * application cost report definitions, as well as to import your usage data into the Application Cost Profiler + * service.

+ *

For more information about using this service, see the AWS Application Cost + * Profiler User Guide.

+ */ +export class ApplicationCostProfiler extends ApplicationCostProfilerClient implements ApplicationCostProfiler {} +createAggregatedClient(commands, ApplicationCostProfiler); diff --git a/clients/client-apprunner/src/AppRunner.ts b/clients/client-apprunner/src/AppRunner.ts index ab9dc9a67c7c..661d7a892887 100644 --- a/clients/client-apprunner/src/AppRunner.ts +++ b/clients/client-apprunner/src/AppRunner.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { AppRunnerClient } from "./AppRunnerClient"; +import { AppRunnerClient, AppRunnerClientConfig } from "./AppRunnerClient"; import { AssociateCustomDomainCommand, AssociateCustomDomainCommandInput, @@ -174,1270 +175,600 @@ import { UpdateVpcIngressConnectionCommandOutput, } from "./commands/UpdateVpcIngressConnectionCommand"; -/** - * @public - * App Runner - *

App Runner is an application service that provides a fast, simple, and cost-effective way to go directly from an existing container image or source code - * to a running service in the Amazon Web Services Cloud in seconds. You don't need to learn new technologies, decide which compute service to use, or understand how to - * provision and configure Amazon Web Services resources.

- *

App Runner connects directly to your container registry or source code repository. It provides an automatic delivery pipeline with fully managed operations, - * high performance, scalability, and security.

- *

For more information about App Runner, see the App Runner Developer Guide. - * For release information, see the App Runner Release Notes.

- *

- * To install the Software Development Kits (SDKs), Integrated - * Development Environment (IDE) Toolkits, and command line tools that you can use to access the API, see Tools for - * Amazon Web Services.

- *

- * Endpoints - *

- *

For a list of Region-specific endpoints that App Runner supports, see App Runner - * endpoints and quotas in the Amazon Web Services General Reference.

- */ -export class AppRunner extends AppRunnerClient { +const commands = { + AssociateCustomDomainCommand, + CreateAutoScalingConfigurationCommand, + CreateConnectionCommand, + CreateObservabilityConfigurationCommand, + CreateServiceCommand, + CreateVpcConnectorCommand, + CreateVpcIngressConnectionCommand, + DeleteAutoScalingConfigurationCommand, + DeleteConnectionCommand, + DeleteObservabilityConfigurationCommand, + DeleteServiceCommand, + DeleteVpcConnectorCommand, + DeleteVpcIngressConnectionCommand, + DescribeAutoScalingConfigurationCommand, + DescribeCustomDomainsCommand, + DescribeObservabilityConfigurationCommand, + DescribeServiceCommand, + DescribeVpcConnectorCommand, + DescribeVpcIngressConnectionCommand, + DisassociateCustomDomainCommand, + ListAutoScalingConfigurationsCommand, + ListConnectionsCommand, + ListObservabilityConfigurationsCommand, + ListOperationsCommand, + ListServicesCommand, + ListTagsForResourceCommand, + ListVpcConnectorsCommand, + ListVpcIngressConnectionsCommand, + PauseServiceCommand, + ResumeServiceCommand, + StartDeploymentCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateServiceCommand, + UpdateVpcIngressConnectionCommand, +}; + +export interface AppRunner { /** - * @public - *

Associate your own domain name with the App Runner subdomain URL of your App Runner service.

- *

After you call AssociateCustomDomain and receive a successful response, use the information in the CustomDomain record - * that's returned to add CNAME records to your Domain Name System (DNS). For each mapped domain name, add a mapping to the target App Runner subdomain and one or - * more certificate validation records. App Runner then performs DNS validation to verify that you own or control the domain name that you associated. App Runner tracks - * domain validity in a certificate stored in AWS Certificate Manager (ACM).

+ * @see {@link AssociateCustomDomainCommand} */ - public associateCustomDomain( + associateCustomDomain( args: AssociateCustomDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateCustomDomain( + associateCustomDomain( args: AssociateCustomDomainCommandInput, cb: (err: any, data?: AssociateCustomDomainCommandOutput) => void ): void; - public associateCustomDomain( + associateCustomDomain( args: AssociateCustomDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateCustomDomainCommandOutput) => void ): void; - public associateCustomDomain( - args: AssociateCustomDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateCustomDomainCommandOutput) => void), - cb?: (err: any, data?: AssociateCustomDomainCommandOutput) => void - ): Promise | void { - const command = new AssociateCustomDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create an App Runner automatic scaling configuration resource. App Runner requires this resource when you create or update App Runner services and you require - * non-default auto scaling settings. You can share an auto scaling configuration across multiple services.

- *

Create multiple revisions of a configuration by calling this action multiple times using the same AutoScalingConfigurationName. The call - * returns incremental AutoScalingConfigurationRevision values. When you create a service and configure an auto scaling configuration resource, - * the service uses the latest active revision of the auto scaling configuration by default. You can optionally configure the service to use a specific - * revision.

- *

Configure a higher MinSize to increase the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is - * a higher minimal cost.

- *

Configure a lower MaxSize to control your cost. The tradeoff is lower responsiveness during peak demand.

+ * @see {@link CreateAutoScalingConfigurationCommand} */ - public createAutoScalingConfiguration( + createAutoScalingConfiguration( args: CreateAutoScalingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAutoScalingConfiguration( + createAutoScalingConfiguration( args: CreateAutoScalingConfigurationCommandInput, cb: (err: any, data?: CreateAutoScalingConfigurationCommandOutput) => void ): void; - public createAutoScalingConfiguration( + createAutoScalingConfiguration( args: CreateAutoScalingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAutoScalingConfigurationCommandOutput) => void ): void; - public createAutoScalingConfiguration( - args: CreateAutoScalingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAutoScalingConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateAutoScalingConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateAutoScalingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create an App Runner connection resource. App Runner requires a connection resource when you create App Runner services that access private repositories from - * certain third-party providers. You can share a connection across multiple services.

- *

A connection resource is needed to access GitHub repositories. GitHub requires a user interface approval process through the App Runner console before you - * can use the connection.

+ * @see {@link CreateConnectionCommand} */ - public createConnection( + createConnection( args: CreateConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConnection( + createConnection( args: CreateConnectionCommandInput, cb: (err: any, data?: CreateConnectionCommandOutput) => void ): void; - public createConnection( + createConnection( args: CreateConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectionCommandOutput) => void ): void; - public createConnection( - args: CreateConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConnectionCommandOutput) => void), - cb?: (err: any, data?: CreateConnectionCommandOutput) => void - ): Promise | void { - const command = new CreateConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create an App Runner observability configuration resource. App Runner requires this resource when you create or update App Runner services and you want to enable - * non-default observability features. You can share an observability configuration across multiple services.

- *

Create multiple revisions of a configuration by calling this action multiple times using the same ObservabilityConfigurationName. The - * call returns incremental ObservabilityConfigurationRevision values. When you create a service and configure an observability configuration - * resource, the service uses the latest active revision of the observability configuration by default. You can optionally configure the service to use a - * specific revision.

- *

The observability configuration resource is designed to configure multiple features (currently one feature, tracing). This action takes optional - * parameters that describe the configuration of these features (currently one parameter, TraceConfiguration). If you don't specify a feature - * parameter, App Runner doesn't enable the feature.

+ * @see {@link CreateObservabilityConfigurationCommand} */ - public createObservabilityConfiguration( + createObservabilityConfiguration( args: CreateObservabilityConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createObservabilityConfiguration( + createObservabilityConfiguration( args: CreateObservabilityConfigurationCommandInput, cb: (err: any, data?: CreateObservabilityConfigurationCommandOutput) => void ): void; - public createObservabilityConfiguration( + createObservabilityConfiguration( args: CreateObservabilityConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateObservabilityConfigurationCommandOutput) => void ): void; - public createObservabilityConfiguration( - args: CreateObservabilityConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateObservabilityConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateObservabilityConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateObservabilityConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create an App Runner service. After the service is created, the action also automatically starts a deployment.

- *

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.

+ * @see {@link CreateServiceCommand} */ - public createService( - args: CreateServiceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createService( - args: CreateServiceCommandInput, - cb: (err: any, data?: CreateServiceCommandOutput) => void - ): void; - public createService( + createService(args: CreateServiceCommandInput, options?: __HttpHandlerOptions): Promise; + createService(args: CreateServiceCommandInput, cb: (err: any, data?: CreateServiceCommandOutput) => void): void; + createService( args: CreateServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceCommandOutput) => void ): void; - public createService( - args: CreateServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateServiceCommandOutput) => void), - cb?: (err: any, data?: CreateServiceCommandOutput) => void - ): Promise | void { - const command = new CreateServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create an App Runner VPC connector resource. App Runner requires this resource when you want to associate your App Runner service to a custom Amazon Virtual Private Cloud - * (Amazon VPC).

+ * @see {@link CreateVpcConnectorCommand} */ - public createVpcConnector( + createVpcConnector( args: CreateVpcConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVpcConnector( + createVpcConnector( args: CreateVpcConnectorCommandInput, cb: (err: any, data?: CreateVpcConnectorCommandOutput) => void ): void; - public createVpcConnector( + createVpcConnector( args: CreateVpcConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVpcConnectorCommandOutput) => void ): void; - public createVpcConnector( - args: CreateVpcConnectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVpcConnectorCommandOutput) => void), - cb?: (err: any, data?: CreateVpcConnectorCommandOutput) => void - ): Promise | void { - const command = new CreateVpcConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create an App Runner VPC Ingress Connection resource. App Runner requires this resource when you want to associate your App Runner service with an Amazon VPC endpoint.

+ * @see {@link CreateVpcIngressConnectionCommand} */ - public createVpcIngressConnection( + createVpcIngressConnection( args: CreateVpcIngressConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVpcIngressConnection( + createVpcIngressConnection( args: CreateVpcIngressConnectionCommandInput, cb: (err: any, data?: CreateVpcIngressConnectionCommandOutput) => void ): void; - public createVpcIngressConnection( + createVpcIngressConnection( args: CreateVpcIngressConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVpcIngressConnectionCommandOutput) => void ): void; - public createVpcIngressConnection( - args: CreateVpcIngressConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVpcIngressConnectionCommandOutput) => void), - cb?: (err: any, data?: CreateVpcIngressConnectionCommandOutput) => void - ): Promise | void { - const command = new CreateVpcIngressConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete an App Runner automatic scaling configuration resource. You can delete a specific revision or the latest active revision. You can't delete a - * configuration that's used by one or more App Runner services.

+ * @see {@link DeleteAutoScalingConfigurationCommand} */ - public deleteAutoScalingConfiguration( + deleteAutoScalingConfiguration( args: DeleteAutoScalingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAutoScalingConfiguration( + deleteAutoScalingConfiguration( args: DeleteAutoScalingConfigurationCommandInput, cb: (err: any, data?: DeleteAutoScalingConfigurationCommandOutput) => void ): void; - public deleteAutoScalingConfiguration( + deleteAutoScalingConfiguration( args: DeleteAutoScalingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAutoScalingConfigurationCommandOutput) => void ): void; - public deleteAutoScalingConfiguration( - args: DeleteAutoScalingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAutoScalingConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteAutoScalingConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteAutoScalingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete an App Runner connection. You must first ensure that there are no running App Runner services that use this connection. If there are any, the - * DeleteConnection action fails.

+ * @see {@link DeleteConnectionCommand} */ - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, cb: (err: any, data?: DeleteConnectionCommandOutput) => void ): void; - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectionCommandOutput) => void ): void; - public deleteConnection( - args: DeleteConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConnectionCommandOutput) => void), - cb?: (err: any, data?: DeleteConnectionCommandOutput) => void - ): Promise | void { - const command = new DeleteConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete an App Runner observability configuration resource. You can delete a specific revision or the latest active revision. You can't delete a - * configuration that's used by one or more App Runner services.

+ * @see {@link DeleteObservabilityConfigurationCommand} */ - public deleteObservabilityConfiguration( + deleteObservabilityConfiguration( args: DeleteObservabilityConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteObservabilityConfiguration( + deleteObservabilityConfiguration( args: DeleteObservabilityConfigurationCommandInput, cb: (err: any, data?: DeleteObservabilityConfigurationCommandOutput) => void ): void; - public deleteObservabilityConfiguration( + deleteObservabilityConfiguration( args: DeleteObservabilityConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteObservabilityConfigurationCommandOutput) => void ): void; - public deleteObservabilityConfiguration( - args: DeleteObservabilityConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteObservabilityConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteObservabilityConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteObservabilityConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete an App Runner service.

- *

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations - * call to track the operation's progress.

- * - *

Make sure that you don't have any active VPCIngressConnections associated with the service you want to delete. - *

- *
+ * @see {@link DeleteServiceCommand} */ - public deleteService( - args: DeleteServiceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteService( - args: DeleteServiceCommandInput, - cb: (err: any, data?: DeleteServiceCommandOutput) => void - ): void; - public deleteService( + deleteService(args: DeleteServiceCommandInput, options?: __HttpHandlerOptions): Promise; + deleteService(args: DeleteServiceCommandInput, cb: (err: any, data?: DeleteServiceCommandOutput) => void): void; + deleteService( args: DeleteServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceCommandOutput) => void ): void; - public deleteService( - args: DeleteServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteServiceCommandOutput) => void), - cb?: (err: any, data?: DeleteServiceCommandOutput) => void - ): Promise | void { - const command = new DeleteServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete an App Runner VPC connector resource. You can't delete a - * connector that's used by one or more App Runner services.

+ * @see {@link DeleteVpcConnectorCommand} */ - public deleteVpcConnector( + deleteVpcConnector( args: DeleteVpcConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVpcConnector( + deleteVpcConnector( args: DeleteVpcConnectorCommandInput, cb: (err: any, data?: DeleteVpcConnectorCommandOutput) => void ): void; - public deleteVpcConnector( + deleteVpcConnector( args: DeleteVpcConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVpcConnectorCommandOutput) => void ): void; - public deleteVpcConnector( - args: DeleteVpcConnectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVpcConnectorCommandOutput) => void), - cb?: (err: any, data?: DeleteVpcConnectorCommandOutput) => void - ): Promise | void { - const command = new DeleteVpcConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete an App Runner VPC Ingress Connection resource that's associated with an App Runner service. The VPC Ingress Connection must be in one of the following states to be deleted: - *

- *
    - *
  • - *

    - * AVAILABLE - *

    - *
  • - *
  • - *

    - * FAILED_CREATION - *

    - *
  • - *
  • - *

    - * FAILED_UPDATE - *

    - *
  • - *
  • - *

    - * FAILED_DELETION - *

    - *
  • - *
+ * @see {@link DeleteVpcIngressConnectionCommand} */ - public deleteVpcIngressConnection( + deleteVpcIngressConnection( args: DeleteVpcIngressConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVpcIngressConnection( + deleteVpcIngressConnection( args: DeleteVpcIngressConnectionCommandInput, cb: (err: any, data?: DeleteVpcIngressConnectionCommandOutput) => void ): void; - public deleteVpcIngressConnection( + deleteVpcIngressConnection( args: DeleteVpcIngressConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVpcIngressConnectionCommandOutput) => void ): void; - public deleteVpcIngressConnection( - args: DeleteVpcIngressConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVpcIngressConnectionCommandOutput) => void), - cb?: (err: any, data?: DeleteVpcIngressConnectionCommandOutput) => void - ): Promise | void { - const command = new DeleteVpcIngressConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Return a full description of an App Runner automatic scaling configuration resource.

+ * @see {@link DescribeAutoScalingConfigurationCommand} */ - public describeAutoScalingConfiguration( + describeAutoScalingConfiguration( args: DescribeAutoScalingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAutoScalingConfiguration( + describeAutoScalingConfiguration( args: DescribeAutoScalingConfigurationCommandInput, cb: (err: any, data?: DescribeAutoScalingConfigurationCommandOutput) => void ): void; - public describeAutoScalingConfiguration( + describeAutoScalingConfiguration( args: DescribeAutoScalingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAutoScalingConfigurationCommandOutput) => void ): void; - public describeAutoScalingConfiguration( - args: DescribeAutoScalingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAutoScalingConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeAutoScalingConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeAutoScalingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Return a description of custom domain names that are associated with an App Runner service.

+ * @see {@link DescribeCustomDomainsCommand} */ - public describeCustomDomains( + describeCustomDomains( args: DescribeCustomDomainsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCustomDomains( + describeCustomDomains( args: DescribeCustomDomainsCommandInput, cb: (err: any, data?: DescribeCustomDomainsCommandOutput) => void ): void; - public describeCustomDomains( + describeCustomDomains( args: DescribeCustomDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCustomDomainsCommandOutput) => void ): void; - public describeCustomDomains( - args: DescribeCustomDomainsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCustomDomainsCommandOutput) => void), - cb?: (err: any, data?: DescribeCustomDomainsCommandOutput) => void - ): Promise | void { - const command = new DescribeCustomDomainsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Return a full description of an App Runner observability configuration resource.

+ * @see {@link DescribeObservabilityConfigurationCommand} */ - public describeObservabilityConfiguration( + describeObservabilityConfiguration( args: DescribeObservabilityConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeObservabilityConfiguration( + describeObservabilityConfiguration( args: DescribeObservabilityConfigurationCommandInput, cb: (err: any, data?: DescribeObservabilityConfigurationCommandOutput) => void ): void; - public describeObservabilityConfiguration( + describeObservabilityConfiguration( args: DescribeObservabilityConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeObservabilityConfigurationCommandOutput) => void ): void; - public describeObservabilityConfiguration( - args: DescribeObservabilityConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeObservabilityConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeObservabilityConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeObservabilityConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Return a full description of an App Runner service.

+ * @see {@link DescribeServiceCommand} */ - public describeService( + describeService( args: DescribeServiceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeService( - args: DescribeServiceCommandInput, - cb: (err: any, data?: DescribeServiceCommandOutput) => void - ): void; - public describeService( + describeService(args: DescribeServiceCommandInput, cb: (err: any, data?: DescribeServiceCommandOutput) => void): void; + describeService( args: DescribeServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeServiceCommandOutput) => void ): void; - public describeService( - args: DescribeServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeServiceCommandOutput) => void), - cb?: (err: any, data?: DescribeServiceCommandOutput) => void - ): Promise | void { - const command = new DescribeServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Return a description of an App Runner VPC connector resource.

+ * @see {@link DescribeVpcConnectorCommand} */ - public describeVpcConnector( + describeVpcConnector( args: DescribeVpcConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVpcConnector( + describeVpcConnector( args: DescribeVpcConnectorCommandInput, cb: (err: any, data?: DescribeVpcConnectorCommandOutput) => void ): void; - public describeVpcConnector( + describeVpcConnector( args: DescribeVpcConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVpcConnectorCommandOutput) => void ): void; - public describeVpcConnector( - args: DescribeVpcConnectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVpcConnectorCommandOutput) => void), - cb?: (err: any, data?: DescribeVpcConnectorCommandOutput) => void - ): Promise | void { - const command = new DescribeVpcConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Return a full description of an App Runner VPC Ingress Connection resource.

+ * @see {@link DescribeVpcIngressConnectionCommand} */ - public describeVpcIngressConnection( + describeVpcIngressConnection( args: DescribeVpcIngressConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVpcIngressConnection( + describeVpcIngressConnection( args: DescribeVpcIngressConnectionCommandInput, cb: (err: any, data?: DescribeVpcIngressConnectionCommandOutput) => void ): void; - public describeVpcIngressConnection( + describeVpcIngressConnection( args: DescribeVpcIngressConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVpcIngressConnectionCommandOutput) => void ): void; - public describeVpcIngressConnection( - args: DescribeVpcIngressConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVpcIngressConnectionCommandOutput) => void), - cb?: (err: any, data?: DescribeVpcIngressConnectionCommandOutput) => void - ): Promise | void { - const command = new DescribeVpcIngressConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociate a custom domain name from an App Runner service.

- *

Certificates tracking domain validity are associated with a custom domain and are stored in AWS - * Certificate Manager (ACM). These certificates aren't deleted as part of this action. App Runner delays certificate deletion for - * 30 days after a domain is disassociated from your service.

+ * @see {@link DisassociateCustomDomainCommand} */ - public disassociateCustomDomain( + disassociateCustomDomain( args: DisassociateCustomDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateCustomDomain( + disassociateCustomDomain( args: DisassociateCustomDomainCommandInput, cb: (err: any, data?: DisassociateCustomDomainCommandOutput) => void ): void; - public disassociateCustomDomain( + disassociateCustomDomain( args: DisassociateCustomDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateCustomDomainCommandOutput) => void ): void; - public disassociateCustomDomain( - args: DisassociateCustomDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateCustomDomainCommandOutput) => void), - cb?: (err: any, data?: DisassociateCustomDomainCommandOutput) => void - ): Promise | void { - const command = new DisassociateCustomDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of active App Runner automatic scaling configurations in your Amazon Web Services account. You can query the revisions for a specific - * configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested - * name.

- *

To retrieve a full description of a particular configuration revision, call and provide one of - * the ARNs returned by ListAutoScalingConfigurations.

+ * @see {@link ListAutoScalingConfigurationsCommand} */ - public listAutoScalingConfigurations( + listAutoScalingConfigurations( args: ListAutoScalingConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAutoScalingConfigurations( + listAutoScalingConfigurations( args: ListAutoScalingConfigurationsCommandInput, cb: (err: any, data?: ListAutoScalingConfigurationsCommandOutput) => void ): void; - public listAutoScalingConfigurations( + listAutoScalingConfigurations( args: ListAutoScalingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAutoScalingConfigurationsCommandOutput) => void ): void; - public listAutoScalingConfigurations( - args: ListAutoScalingConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAutoScalingConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListAutoScalingConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListAutoScalingConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of App Runner connections that are associated with your Amazon Web Services account.

+ * @see {@link ListConnectionsCommand} */ - public listConnections( + listConnections( args: ListConnectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConnections( - args: ListConnectionsCommandInput, - cb: (err: any, data?: ListConnectionsCommandOutput) => void - ): void; - public listConnections( + listConnections(args: ListConnectionsCommandInput, cb: (err: any, data?: ListConnectionsCommandOutput) => void): void; + listConnections( args: ListConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConnectionsCommandOutput) => void ): void; - public listConnections( - args: ListConnectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConnectionsCommandOutput) => void), - cb?: (err: any, data?: ListConnectionsCommandOutput) => void - ): Promise | void { - const command = new ListConnectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of active App Runner observability configurations in your Amazon Web Services account. You can query the revisions for a specific - * configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested - * name.

- *

To retrieve a full description of a particular configuration revision, call and provide one - * of the ARNs returned by ListObservabilityConfigurations.

+ * @see {@link ListObservabilityConfigurationsCommand} */ - public listObservabilityConfigurations( + listObservabilityConfigurations( args: ListObservabilityConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listObservabilityConfigurations( + listObservabilityConfigurations( args: ListObservabilityConfigurationsCommandInput, cb: (err: any, data?: ListObservabilityConfigurationsCommandOutput) => void ): void; - public listObservabilityConfigurations( + listObservabilityConfigurations( args: ListObservabilityConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListObservabilityConfigurationsCommandOutput) => void ): void; - public listObservabilityConfigurations( - args: ListObservabilityConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListObservabilityConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListObservabilityConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListObservabilityConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Return a list of operations that occurred on an App Runner service.

- *

The resulting list of OperationSummary objects is sorted in reverse chronological order. The first object on the list represents the - * last started operation.

+ * @see {@link ListOperationsCommand} */ - public listOperations( + listOperations( args: ListOperationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOperations( - args: ListOperationsCommandInput, - cb: (err: any, data?: ListOperationsCommandOutput) => void - ): void; - public listOperations( + listOperations(args: ListOperationsCommandInput, cb: (err: any, data?: ListOperationsCommandOutput) => void): void; + listOperations( args: ListOperationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOperationsCommandOutput) => void ): void; - public listOperations( - args: ListOperationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOperationsCommandOutput) => void), - cb?: (err: any, data?: ListOperationsCommandOutput) => void - ): Promise | void { - const command = new ListOperationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of running App Runner services in your Amazon Web Services account.

+ * @see {@link ListServicesCommand} */ - public listServices( - args: ListServicesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listServices(args: ListServicesCommandInput, cb: (err: any, data?: ListServicesCommandOutput) => void): void; - public listServices( + listServices(args: ListServicesCommandInput, options?: __HttpHandlerOptions): Promise; + listServices(args: ListServicesCommandInput, cb: (err: any, data?: ListServicesCommandOutput) => void): void; + listServices( args: ListServicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServicesCommandOutput) => void ): void; - public listServices( - args: ListServicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServicesCommandOutput) => void), - cb?: (err: any, data?: ListServicesCommandOutput) => void - ): Promise | void { - const command = new ListServicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List tags that are associated with for an App Runner resource. The response contains a list of tag key-value pairs.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of App Runner VPC connectors in your Amazon Web Services account.

+ * @see {@link ListVpcConnectorsCommand} */ - public listVpcConnectors( + listVpcConnectors( args: ListVpcConnectorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVpcConnectors( + listVpcConnectors( args: ListVpcConnectorsCommandInput, cb: (err: any, data?: ListVpcConnectorsCommandOutput) => void ): void; - public listVpcConnectors( + listVpcConnectors( args: ListVpcConnectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVpcConnectorsCommandOutput) => void ): void; - public listVpcConnectors( - args: ListVpcConnectorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVpcConnectorsCommandOutput) => void), - cb?: (err: any, data?: ListVpcConnectorsCommandOutput) => void - ): Promise | void { - const command = new ListVpcConnectorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Return a list of App Runner VPC Ingress Connections in your Amazon Web Services account.

+ * @see {@link ListVpcIngressConnectionsCommand} */ - public listVpcIngressConnections( + listVpcIngressConnections( args: ListVpcIngressConnectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVpcIngressConnections( + listVpcIngressConnections( args: ListVpcIngressConnectionsCommandInput, cb: (err: any, data?: ListVpcIngressConnectionsCommandOutput) => void ): void; - public listVpcIngressConnections( + listVpcIngressConnections( args: ListVpcIngressConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVpcIngressConnectionsCommandOutput) => void ): void; - public listVpcIngressConnections( - args: ListVpcIngressConnectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVpcIngressConnectionsCommandOutput) => void), - cb?: (err: any, data?: ListVpcIngressConnectionsCommandOutput) => void - ): Promise | void { - const command = new ListVpcIngressConnectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Pause an active App Runner service. App Runner reduces compute capacity for the service to zero and loses state (for example, ephemeral storage is - * removed).

- *

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations - * call to track the operation's progress.

+ * @see {@link PauseServiceCommand} */ - public pauseService( - args: PauseServiceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public pauseService(args: PauseServiceCommandInput, cb: (err: any, data?: PauseServiceCommandOutput) => void): void; - public pauseService( + pauseService(args: PauseServiceCommandInput, options?: __HttpHandlerOptions): Promise; + pauseService(args: PauseServiceCommandInput, cb: (err: any, data?: PauseServiceCommandOutput) => void): void; + pauseService( args: PauseServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PauseServiceCommandOutput) => void ): void; - public pauseService( - args: PauseServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PauseServiceCommandOutput) => void), - cb?: (err: any, data?: PauseServiceCommandOutput) => void - ): Promise | void { - const command = new PauseServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Resume an active App Runner service. App Runner provisions compute capacity for the service.

- *

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations - * call to track the operation's progress.

+ * @see {@link ResumeServiceCommand} */ - public resumeService( - args: ResumeServiceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public resumeService( - args: ResumeServiceCommandInput, - cb: (err: any, data?: ResumeServiceCommandOutput) => void - ): void; - public resumeService( + resumeService(args: ResumeServiceCommandInput, options?: __HttpHandlerOptions): Promise; + resumeService(args: ResumeServiceCommandInput, cb: (err: any, data?: ResumeServiceCommandOutput) => void): void; + resumeService( args: ResumeServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResumeServiceCommandOutput) => void ): void; - public resumeService( - args: ResumeServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResumeServiceCommandOutput) => void), - cb?: (err: any, data?: ResumeServiceCommandOutput) => void - ): Promise | void { - const command = new ResumeServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Initiate a manual deployment of the latest commit in a source code repository or the latest image in a source image repository to an App Runner - * service.

- *

For a source code repository, App Runner retrieves the commit and builds a Docker image. For a source image repository, App Runner retrieves the latest Docker - * image. In both cases, App Runner then deploys the new image to your service and starts a new container instance.

- *

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations - * call to track the operation's progress.

+ * @see {@link StartDeploymentCommand} */ - public startDeployment( + startDeployment( args: StartDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDeployment( - args: StartDeploymentCommandInput, - cb: (err: any, data?: StartDeploymentCommandOutput) => void - ): void; - public startDeployment( + startDeployment(args: StartDeploymentCommandInput, cb: (err: any, data?: StartDeploymentCommandOutput) => void): void; + startDeployment( args: StartDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDeploymentCommandOutput) => void ): void; - public startDeployment( - args: StartDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDeploymentCommandOutput) => void), - cb?: (err: any, data?: StartDeploymentCommandOutput) => void - ): Promise | void { - const command = new StartDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Add tags to, or update the tag values of, an App Runner resource. A tag is a key-value pair.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Remove tags from an App Runner resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update an App Runner service. You can update the source configuration and instance configuration of the service. You can also update the ARN of the auto - * scaling configuration resource that's associated with the service. However, you can't change the name or the encryption configuration of the service. - * These can be set only when you create the service.

- *

To update the tags applied to your service, use the separate actions TagResource and UntagResource.

- *

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations - * call to track the operation's progress.

+ * @see {@link UpdateServiceCommand} */ - public updateService( - args: UpdateServiceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateService( - args: UpdateServiceCommandInput, - cb: (err: any, data?: UpdateServiceCommandOutput) => void - ): void; - public updateService( + updateService(args: UpdateServiceCommandInput, options?: __HttpHandlerOptions): Promise; + updateService(args: UpdateServiceCommandInput, cb: (err: any, data?: UpdateServiceCommandOutput) => void): void; + updateService( args: UpdateServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceCommandOutput) => void ): void; - public updateService( - args: UpdateServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServiceCommandOutput) => void), - cb?: (err: any, data?: UpdateServiceCommandOutput) => void - ): Promise | void { - const command = new UpdateServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update an existing App Runner VPC Ingress Connection resource. The VPC Ingress Connection must be in one of the following states to be updated:

- *
    - *
  • - *

    - * AVAILABLE - *

    - *
  • - *
  • - *

    - * FAILED_CREATION - *

    - *
  • - *
  • - *

    - * FAILED_UPDATE - *

    - *
  • - *
+ * @see {@link UpdateVpcIngressConnectionCommand} */ - public updateVpcIngressConnection( + updateVpcIngressConnection( args: UpdateVpcIngressConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVpcIngressConnection( + updateVpcIngressConnection( args: UpdateVpcIngressConnectionCommandInput, cb: (err: any, data?: UpdateVpcIngressConnectionCommandOutput) => void ): void; - public updateVpcIngressConnection( + updateVpcIngressConnection( args: UpdateVpcIngressConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVpcIngressConnectionCommandOutput) => void ): void; - public updateVpcIngressConnection( - args: UpdateVpcIngressConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVpcIngressConnectionCommandOutput) => void), - cb?: (err: any, data?: UpdateVpcIngressConnectionCommandOutput) => void - ): Promise | void { - const command = new UpdateVpcIngressConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * App Runner + *

App Runner is an application service that provides a fast, simple, and cost-effective way to go directly from an existing container image or source code + * to a running service in the Amazon Web Services Cloud in seconds. You don't need to learn new technologies, decide which compute service to use, or understand how to + * provision and configure Amazon Web Services resources.

+ *

App Runner connects directly to your container registry or source code repository. It provides an automatic delivery pipeline with fully managed operations, + * high performance, scalability, and security.

+ *

For more information about App Runner, see the App Runner Developer Guide. + * For release information, see the App Runner Release Notes.

+ *

+ * To install the Software Development Kits (SDKs), Integrated + * Development Environment (IDE) Toolkits, and command line tools that you can use to access the API, see Tools for + * Amazon Web Services.

+ *

+ * Endpoints + *

+ *

For a list of Region-specific endpoints that App Runner supports, see App Runner + * endpoints and quotas in the Amazon Web Services General Reference.

+ */ +export class AppRunner extends AppRunnerClient implements AppRunner {} +createAggregatedClient(commands, AppRunner); diff --git a/clients/client-appstream/src/AppStream.ts b/clients/client-appstream/src/AppStream.ts index 87f145efd5a9..70dddc3bcfb8 100644 --- a/clients/client-appstream/src/AppStream.ts +++ b/clients/client-appstream/src/AppStream.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { AppStreamClient } from "./AppStreamClient"; +import { AppStreamClient, AppStreamClientConfig } from "./AppStreamClient"; import { AssociateApplicationFleetCommand, AssociateApplicationFleetCommandInput, @@ -268,2144 +269,1075 @@ import { } from "./commands/UpdateImagePermissionsCommand"; import { UpdateStackCommand, UpdateStackCommandInput, UpdateStackCommandOutput } from "./commands/UpdateStackCommand"; -/** - * @public - * Amazon AppStream 2.0 - *

This is the Amazon AppStream 2.0 API Reference. This documentation provides descriptions and syntax for each of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. AppStream 2.0 manages the AWS resources that are required to host and run your applications, scales automatically, and provides access to your users on demand.

- * - *

You can call the AppStream 2.0 API operations by using an interface VPC endpoint (interface endpoint). For more information, see Access AppStream 2.0 API Operations and CLI Commands Through an Interface VPC Endpoint in the Amazon AppStream 2.0 Administration Guide.

- *
- *

To learn more about AppStream 2.0, see the following resources:

- * - */ -export class AppStream extends AppStreamClient { +const commands = { + AssociateApplicationFleetCommand, + AssociateApplicationToEntitlementCommand, + AssociateFleetCommand, + BatchAssociateUserStackCommand, + BatchDisassociateUserStackCommand, + CopyImageCommand, + CreateAppBlockCommand, + CreateApplicationCommand, + CreateDirectoryConfigCommand, + CreateEntitlementCommand, + CreateFleetCommand, + CreateImageBuilderCommand, + CreateImageBuilderStreamingURLCommand, + CreateStackCommand, + CreateStreamingURLCommand, + CreateUpdatedImageCommand, + CreateUsageReportSubscriptionCommand, + CreateUserCommand, + DeleteAppBlockCommand, + DeleteApplicationCommand, + DeleteDirectoryConfigCommand, + DeleteEntitlementCommand, + DeleteFleetCommand, + DeleteImageCommand, + DeleteImageBuilderCommand, + DeleteImagePermissionsCommand, + DeleteStackCommand, + DeleteUsageReportSubscriptionCommand, + DeleteUserCommand, + DescribeAppBlocksCommand, + DescribeApplicationFleetAssociationsCommand, + DescribeApplicationsCommand, + DescribeDirectoryConfigsCommand, + DescribeEntitlementsCommand, + DescribeFleetsCommand, + DescribeImageBuildersCommand, + DescribeImagePermissionsCommand, + DescribeImagesCommand, + DescribeSessionsCommand, + DescribeStacksCommand, + DescribeUsageReportSubscriptionsCommand, + DescribeUsersCommand, + DescribeUserStackAssociationsCommand, + DisableUserCommand, + DisassociateApplicationFleetCommand, + DisassociateApplicationFromEntitlementCommand, + DisassociateFleetCommand, + EnableUserCommand, + ExpireSessionCommand, + ListAssociatedFleetsCommand, + ListAssociatedStacksCommand, + ListEntitledApplicationsCommand, + ListTagsForResourceCommand, + StartFleetCommand, + StartImageBuilderCommand, + StopFleetCommand, + StopImageBuilderCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateApplicationCommand, + UpdateDirectoryConfigCommand, + UpdateEntitlementCommand, + UpdateFleetCommand, + UpdateImagePermissionsCommand, + UpdateStackCommand, +}; + +export interface AppStream { /** - * @public - *

Associates the specified application with the specified fleet. This is only supported for Elastic fleets.

+ * @see {@link AssociateApplicationFleetCommand} */ - public associateApplicationFleet( + associateApplicationFleet( args: AssociateApplicationFleetCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateApplicationFleet( + associateApplicationFleet( args: AssociateApplicationFleetCommandInput, cb: (err: any, data?: AssociateApplicationFleetCommandOutput) => void ): void; - public associateApplicationFleet( + associateApplicationFleet( args: AssociateApplicationFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateApplicationFleetCommandOutput) => void ): void; - public associateApplicationFleet( - args: AssociateApplicationFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateApplicationFleetCommandOutput) => void), - cb?: (err: any, data?: AssociateApplicationFleetCommandOutput) => void - ): Promise | void { - const command = new AssociateApplicationFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates an application to entitle.

- */ - public associateApplicationToEntitlement( + + /** + * @see {@link AssociateApplicationToEntitlementCommand} + */ + associateApplicationToEntitlement( args: AssociateApplicationToEntitlementCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateApplicationToEntitlement( + associateApplicationToEntitlement( args: AssociateApplicationToEntitlementCommandInput, cb: (err: any, data?: AssociateApplicationToEntitlementCommandOutput) => void ): void; - public associateApplicationToEntitlement( + associateApplicationToEntitlement( args: AssociateApplicationToEntitlementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateApplicationToEntitlementCommandOutput) => void ): void; - public associateApplicationToEntitlement( - args: AssociateApplicationToEntitlementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateApplicationToEntitlementCommandOutput) => void), - cb?: (err: any, data?: AssociateApplicationToEntitlementCommandOutput) => void - ): Promise | void { - const command = new AssociateApplicationToEntitlementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates the specified fleet with the specified stack.

- */ - public associateFleet( + + /** + * @see {@link AssociateFleetCommand} + */ + associateFleet( args: AssociateFleetCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateFleet( - args: AssociateFleetCommandInput, - cb: (err: any, data?: AssociateFleetCommandOutput) => void - ): void; - public associateFleet( + associateFleet(args: AssociateFleetCommandInput, cb: (err: any, data?: AssociateFleetCommandOutput) => void): void; + associateFleet( args: AssociateFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateFleetCommandOutput) => void ): void; - public associateFleet( - args: AssociateFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateFleetCommandOutput) => void), - cb?: (err: any, data?: AssociateFleetCommandOutput) => void - ): Promise | void { - const command = new AssociateFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain.

- */ - public batchAssociateUserStack( + + /** + * @see {@link BatchAssociateUserStackCommand} + */ + batchAssociateUserStack( args: BatchAssociateUserStackCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchAssociateUserStack( + batchAssociateUserStack( args: BatchAssociateUserStackCommandInput, cb: (err: any, data?: BatchAssociateUserStackCommandOutput) => void ): void; - public batchAssociateUserStack( + batchAssociateUserStack( args: BatchAssociateUserStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchAssociateUserStackCommandOutput) => void ): void; - public batchAssociateUserStack( - args: BatchAssociateUserStackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchAssociateUserStackCommandOutput) => void), - cb?: (err: any, data?: BatchAssociateUserStackCommandOutput) => void - ): Promise | void { - const command = new BatchAssociateUserStackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates the specified users from the specified stacks.

- */ - public batchDisassociateUserStack( + + /** + * @see {@link BatchDisassociateUserStackCommand} + */ + batchDisassociateUserStack( args: BatchDisassociateUserStackCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDisassociateUserStack( + batchDisassociateUserStack( args: BatchDisassociateUserStackCommandInput, cb: (err: any, data?: BatchDisassociateUserStackCommandOutput) => void ): void; - public batchDisassociateUserStack( + batchDisassociateUserStack( args: BatchDisassociateUserStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDisassociateUserStackCommandOutput) => void ): void; - public batchDisassociateUserStack( - args: BatchDisassociateUserStackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDisassociateUserStackCommandOutput) => void), - cb?: (err: any, data?: BatchDisassociateUserStackCommandOutput) => void - ): Promise | void { - const command = new BatchDisassociateUserStackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied.

- */ - public copyImage(args: CopyImageCommandInput, options?: __HttpHandlerOptions): Promise; - public copyImage(args: CopyImageCommandInput, cb: (err: any, data?: CopyImageCommandOutput) => void): void; - public copyImage( + + /** + * @see {@link CopyImageCommand} + */ + copyImage(args: CopyImageCommandInput, options?: __HttpHandlerOptions): Promise; + copyImage(args: CopyImageCommandInput, cb: (err: any, data?: CopyImageCommandOutput) => void): void; + copyImage( args: CopyImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyImageCommandOutput) => void ): void; - public copyImage( - args: CopyImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopyImageCommandOutput) => void), - cb?: (err: any, data?: CopyImageCommandOutput) => void - ): Promise | void { - const command = new CopyImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an app block.

- *

App blocks are an Amazon AppStream 2.0 resource that stores the details about the - * virtual hard disk in an S3 bucket. It also stores the setup script with details about - * how to mount the virtual hard disk. The virtual hard disk includes the application - * binaries and other files necessary to launch your applications. Multiple applications - * can be assigned to a single app block.

- *

This is only supported for Elastic fleets.

- */ - public createAppBlock( + + /** + * @see {@link CreateAppBlockCommand} + */ + createAppBlock( args: CreateAppBlockCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAppBlock( - args: CreateAppBlockCommandInput, - cb: (err: any, data?: CreateAppBlockCommandOutput) => void - ): void; - public createAppBlock( + createAppBlock(args: CreateAppBlockCommandInput, cb: (err: any, data?: CreateAppBlockCommandOutput) => void): void; + createAppBlock( args: CreateAppBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppBlockCommandOutput) => void ): void; - public createAppBlock( - args: CreateAppBlockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAppBlockCommandOutput) => void), - cb?: (err: any, data?: CreateAppBlockCommandOutput) => void - ): Promise | void { - const command = new CreateAppBlockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an application.

- *

Applications are an Amazon AppStream 2.0 resource that stores the details about how to - * launch applications on Elastic fleet streaming instances. An application consists of the - * launch details, icon, and display name. Applications are associated with an app block - * that contains the application binaries and other files. The applications assigned to an - * Elastic fleet are the applications users can launch.

- *

This is only supported for Elastic fleets.

- */ - public createApplication( + + /** + * @see {@link CreateApplicationCommand} + */ + createApplication( args: CreateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApplication( + createApplication( args: CreateApplicationCommandInput, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( + createApplication( args: CreateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( - args: CreateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApplicationCommandOutput) => void), - cb?: (err: any, data?: CreateApplicationCommandOutput) => void - ): Promise | void { - const command = new CreateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

- */ - public createDirectoryConfig( + + /** + * @see {@link CreateDirectoryConfigCommand} + */ + createDirectoryConfig( args: CreateDirectoryConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDirectoryConfig( + createDirectoryConfig( args: CreateDirectoryConfigCommandInput, cb: (err: any, data?: CreateDirectoryConfigCommandOutput) => void ): void; - public createDirectoryConfig( + createDirectoryConfig( args: CreateDirectoryConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDirectoryConfigCommandOutput) => void ): void; - public createDirectoryConfig( - args: CreateDirectoryConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDirectoryConfigCommandOutput) => void), - cb?: (err: any, data?: CreateDirectoryConfigCommandOutput) => void - ): Promise | void { - const command = new CreateDirectoryConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new entitlement. Entitlements control access to specific applications within - * a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user - * identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all - * applications in a stack. Entitlements don't apply to the desktop stream view - * application, or to applications managed by a dynamic app provider using the Dynamic - * Application Framework.

- */ - public createEntitlement( + + /** + * @see {@link CreateEntitlementCommand} + */ + createEntitlement( args: CreateEntitlementCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEntitlement( + createEntitlement( args: CreateEntitlementCommandInput, cb: (err: any, data?: CreateEntitlementCommandOutput) => void ): void; - public createEntitlement( + createEntitlement( args: CreateEntitlementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEntitlementCommandOutput) => void ): void; - public createEntitlement( - args: CreateEntitlementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEntitlementCommandOutput) => void), - cb?: (err: any, data?: CreateEntitlementCommandOutput) => void - ): Promise | void { - const command = new CreateEntitlementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops.

- */ - public createFleet(args: CreateFleetCommandInput, options?: __HttpHandlerOptions): Promise; - public createFleet(args: CreateFleetCommandInput, cb: (err: any, data?: CreateFleetCommandOutput) => void): void; - public createFleet( + + /** + * @see {@link CreateFleetCommand} + */ + createFleet(args: CreateFleetCommandInput, options?: __HttpHandlerOptions): Promise; + createFleet(args: CreateFleetCommandInput, cb: (err: any, data?: CreateFleetCommandOutput) => void): void; + createFleet( args: CreateFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFleetCommandOutput) => void ): void; - public createFleet( - args: CreateFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFleetCommandOutput) => void), - cb?: (err: any, data?: CreateFleetCommandOutput) => void - ): Promise | void { - const command = new CreateFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an image builder. An image builder is a virtual machine that is used to create an image.

- *

The initial state of the builder is PENDING. When it is ready, the state is RUNNING.

- */ - public createImageBuilder( + + /** + * @see {@link CreateImageBuilderCommand} + */ + createImageBuilder( args: CreateImageBuilderCommandInput, options?: __HttpHandlerOptions ): Promise; - public createImageBuilder( + createImageBuilder( args: CreateImageBuilderCommandInput, cb: (err: any, data?: CreateImageBuilderCommandOutput) => void ): void; - public createImageBuilder( + createImageBuilder( args: CreateImageBuilderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateImageBuilderCommandOutput) => void ): void; - public createImageBuilder( - args: CreateImageBuilderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateImageBuilderCommandOutput) => void), - cb?: (err: any, data?: CreateImageBuilderCommandOutput) => void - ): Promise | void { - const command = new CreateImageBuilderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a URL to start an image builder streaming session.

- */ - public createImageBuilderStreamingURL( + + /** + * @see {@link CreateImageBuilderStreamingURLCommand} + */ + createImageBuilderStreamingURL( args: CreateImageBuilderStreamingURLCommandInput, options?: __HttpHandlerOptions ): Promise; - public createImageBuilderStreamingURL( + createImageBuilderStreamingURL( args: CreateImageBuilderStreamingURLCommandInput, cb: (err: any, data?: CreateImageBuilderStreamingURLCommandOutput) => void ): void; - public createImageBuilderStreamingURL( + createImageBuilderStreamingURL( args: CreateImageBuilderStreamingURLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateImageBuilderStreamingURLCommandOutput) => void ): void; - public createImageBuilderStreamingURL( - args: CreateImageBuilderStreamingURLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateImageBuilderStreamingURLCommandOutput) => void), - cb?: (err: any, data?: CreateImageBuilderStreamingURLCommandOutput) => void - ): Promise | void { - const command = new CreateImageBuilderStreamingURLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.

- */ - public createStack(args: CreateStackCommandInput, options?: __HttpHandlerOptions): Promise; - public createStack(args: CreateStackCommandInput, cb: (err: any, data?: CreateStackCommandOutput) => void): void; - public createStack( + + /** + * @see {@link CreateStackCommand} + */ + createStack(args: CreateStackCommandInput, options?: __HttpHandlerOptions): Promise; + createStack(args: CreateStackCommandInput, cb: (err: any, data?: CreateStackCommandOutput) => void): void; + createStack( args: CreateStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStackCommandOutput) => void ): void; - public createStack( - args: CreateStackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStackCommandOutput) => void), - cb?: (err: any, data?: CreateStackCommandOutput) => void - ): Promise | void { - const command = new CreateStackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup.

- */ - public createStreamingURL( + + /** + * @see {@link CreateStreamingURLCommand} + */ + createStreamingURL( args: CreateStreamingURLCommandInput, options?: __HttpHandlerOptions ): Promise; - public createStreamingURL( + createStreamingURL( args: CreateStreamingURLCommandInput, cb: (err: any, data?: CreateStreamingURLCommandOutput) => void ): void; - public createStreamingURL( + createStreamingURL( args: CreateStreamingURLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStreamingURLCommandOutput) => void ): void; - public createStreamingURL( - args: CreateStreamingURLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStreamingURLCommandOutput) => void), - cb?: (err: any, data?: CreateStreamingURLCommandOutput) => void - ): Promise | void { - const command = new CreateStreamingURLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software.

- *

For more information, see the "Update an Image by Using - * Managed AppStream 2.0 Image Updates" section in Administer Your AppStream 2.0 Images, in the Amazon AppStream 2.0 Administration Guide.

- */ - public createUpdatedImage( + + /** + * @see {@link CreateUpdatedImageCommand} + */ + createUpdatedImage( args: CreateUpdatedImageCommandInput, options?: __HttpHandlerOptions ): Promise; - public createUpdatedImage( + createUpdatedImage( args: CreateUpdatedImageCommandInput, cb: (err: any, data?: CreateUpdatedImageCommandOutput) => void ): void; - public createUpdatedImage( + createUpdatedImage( args: CreateUpdatedImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUpdatedImageCommandOutput) => void ): void; - public createUpdatedImage( - args: CreateUpdatedImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUpdatedImageCommandOutput) => void), - cb?: (err: any, data?: CreateUpdatedImageCommandOutput) => void - ): Promise | void { - const command = new CreateUpdatedImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a usage report subscription. Usage reports are generated daily.

- */ - public createUsageReportSubscription( + + /** + * @see {@link CreateUsageReportSubscriptionCommand} + */ + createUsageReportSubscription( args: CreateUsageReportSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createUsageReportSubscription( + createUsageReportSubscription( args: CreateUsageReportSubscriptionCommandInput, cb: (err: any, data?: CreateUsageReportSubscriptionCommandOutput) => void ): void; - public createUsageReportSubscription( + createUsageReportSubscription( args: CreateUsageReportSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUsageReportSubscriptionCommandOutput) => void ): void; - public createUsageReportSubscription( - args: CreateUsageReportSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUsageReportSubscriptionCommandOutput) => void), - cb?: (err: any, data?: CreateUsageReportSubscriptionCommandOutput) => void - ): Promise | void { - const command = new CreateUsageReportSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new user in the user pool.

- */ - public createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; - public createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; - public createUser( + + /** + * @see {@link CreateUserCommand} + */ + createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; + createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; + createUser( args: CreateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserCommandOutput) => void ): void; - public createUser( - args: CreateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserCommandOutput) => void), - cb?: (err: any, data?: CreateUserCommandOutput) => void - ): Promise | void { - const command = new CreateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an app block.

- */ - public deleteAppBlock( + + /** + * @see {@link DeleteAppBlockCommand} + */ + deleteAppBlock( args: DeleteAppBlockCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAppBlock( - args: DeleteAppBlockCommandInput, - cb: (err: any, data?: DeleteAppBlockCommandOutput) => void - ): void; - public deleteAppBlock( + deleteAppBlock(args: DeleteAppBlockCommandInput, cb: (err: any, data?: DeleteAppBlockCommandOutput) => void): void; + deleteAppBlock( args: DeleteAppBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppBlockCommandOutput) => void ): void; - public deleteAppBlock( - args: DeleteAppBlockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppBlockCommandOutput) => void), - cb?: (err: any, data?: DeleteAppBlockCommandOutput) => void - ): Promise | void { - const command = new DeleteAppBlockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an application.

- */ - public deleteApplication( + + /** + * @see {@link DeleteApplicationCommand} + */ + deleteApplication( args: DeleteApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( - args: DeleteApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApplicationCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.

- */ - public deleteDirectoryConfig( + + /** + * @see {@link DeleteDirectoryConfigCommand} + */ + deleteDirectoryConfig( args: DeleteDirectoryConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDirectoryConfig( + deleteDirectoryConfig( args: DeleteDirectoryConfigCommandInput, cb: (err: any, data?: DeleteDirectoryConfigCommandOutput) => void ): void; - public deleteDirectoryConfig( + deleteDirectoryConfig( args: DeleteDirectoryConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDirectoryConfigCommandOutput) => void ): void; - public deleteDirectoryConfig( - args: DeleteDirectoryConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDirectoryConfigCommandOutput) => void), - cb?: (err: any, data?: DeleteDirectoryConfigCommandOutput) => void - ): Promise | void { - const command = new DeleteDirectoryConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified entitlement.

- */ - public deleteEntitlement( + + /** + * @see {@link DeleteEntitlementCommand} + */ + deleteEntitlement( args: DeleteEntitlementCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEntitlement( + deleteEntitlement( args: DeleteEntitlementCommandInput, cb: (err: any, data?: DeleteEntitlementCommandOutput) => void ): void; - public deleteEntitlement( + deleteEntitlement( args: DeleteEntitlementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEntitlementCommandOutput) => void ): void; - public deleteEntitlement( - args: DeleteEntitlementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEntitlementCommandOutput) => void), - cb?: (err: any, data?: DeleteEntitlementCommandOutput) => void - ): Promise | void { - const command = new DeleteEntitlementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified fleet.

- */ - public deleteFleet(args: DeleteFleetCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteFleet(args: DeleteFleetCommandInput, cb: (err: any, data?: DeleteFleetCommandOutput) => void): void; - public deleteFleet( + + /** + * @see {@link DeleteFleetCommand} + */ + deleteFleet(args: DeleteFleetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteFleet(args: DeleteFleetCommandInput, cb: (err: any, data?: DeleteFleetCommandOutput) => void): void; + deleteFleet( args: DeleteFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFleetCommandOutput) => void ): void; - public deleteFleet( - args: DeleteFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFleetCommandOutput) => void), - cb?: (err: any, data?: DeleteFleetCommandOutput) => void - ): Promise | void { - const command = new DeleteFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified image. You cannot delete an image when it is in use. - * After you delete an image, you cannot provision new capacity using the image.

- */ - public deleteImage(args: DeleteImageCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteImage(args: DeleteImageCommandInput, cb: (err: any, data?: DeleteImageCommandOutput) => void): void; - public deleteImage( + + /** + * @see {@link DeleteImageCommand} + */ + deleteImage(args: DeleteImageCommandInput, options?: __HttpHandlerOptions): Promise; + deleteImage(args: DeleteImageCommandInput, cb: (err: any, data?: DeleteImageCommandOutput) => void): void; + deleteImage( args: DeleteImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteImageCommandOutput) => void ): void; - public deleteImage( - args: DeleteImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteImageCommandOutput) => void), - cb?: (err: any, data?: DeleteImageCommandOutput) => void - ): Promise | void { - const command = new DeleteImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified image builder and releases the capacity.

- */ - public deleteImageBuilder( + + /** + * @see {@link DeleteImageBuilderCommand} + */ + deleteImageBuilder( args: DeleteImageBuilderCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteImageBuilder( + deleteImageBuilder( args: DeleteImageBuilderCommandInput, cb: (err: any, data?: DeleteImageBuilderCommandOutput) => void ): void; - public deleteImageBuilder( + deleteImageBuilder( args: DeleteImageBuilderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteImageBuilderCommandOutput) => void ): void; - public deleteImageBuilder( - args: DeleteImageBuilderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteImageBuilderCommandOutput) => void), - cb?: (err: any, data?: DeleteImageBuilderCommandOutput) => void - ): Promise | void { - const command = new DeleteImageBuilderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image.

- */ - public deleteImagePermissions( + + /** + * @see {@link DeleteImagePermissionsCommand} + */ + deleteImagePermissions( args: DeleteImagePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteImagePermissions( + deleteImagePermissions( args: DeleteImagePermissionsCommandInput, cb: (err: any, data?: DeleteImagePermissionsCommandOutput) => void ): void; - public deleteImagePermissions( + deleteImagePermissions( args: DeleteImagePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteImagePermissionsCommandOutput) => void ): void; - public deleteImagePermissions( - args: DeleteImagePermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteImagePermissionsCommandOutput) => void), - cb?: (err: any, data?: DeleteImagePermissionsCommandOutput) => void - ): Promise | void { - const command = new DeleteImagePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.

- */ - public deleteStack(args: DeleteStackCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteStack(args: DeleteStackCommandInput, cb: (err: any, data?: DeleteStackCommandOutput) => void): void; - public deleteStack( + + /** + * @see {@link DeleteStackCommand} + */ + deleteStack(args: DeleteStackCommandInput, options?: __HttpHandlerOptions): Promise; + deleteStack(args: DeleteStackCommandInput, cb: (err: any, data?: DeleteStackCommandOutput) => void): void; + deleteStack( args: DeleteStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStackCommandOutput) => void ): void; - public deleteStack( - args: DeleteStackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStackCommandOutput) => void), - cb?: (err: any, data?: DeleteStackCommandOutput) => void - ): Promise | void { - const command = new DeleteStackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables usage report generation.

- */ - public deleteUsageReportSubscription( + + /** + * @see {@link DeleteUsageReportSubscriptionCommand} + */ + deleteUsageReportSubscription( args: DeleteUsageReportSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteUsageReportSubscription( + deleteUsageReportSubscription( args: DeleteUsageReportSubscriptionCommandInput, cb: (err: any, data?: DeleteUsageReportSubscriptionCommandOutput) => void ): void; - public deleteUsageReportSubscription( + deleteUsageReportSubscription( args: DeleteUsageReportSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUsageReportSubscriptionCommandOutput) => void ): void; - public deleteUsageReportSubscription( - args: DeleteUsageReportSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUsageReportSubscriptionCommandOutput) => void), - cb?: (err: any, data?: DeleteUsageReportSubscriptionCommandOutput) => void - ): Promise | void { - const command = new DeleteUsageReportSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a user from the user pool.

- */ - public deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; - public deleteUser( + + /** + * @see {@link DeleteUserCommand} + */ + deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; + deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; + deleteUser( args: DeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserCommandOutput) => void ): void; - public deleteUser( - args: DeleteUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserCommandOutput) => void), - cb?: (err: any, data?: DeleteUserCommandOutput) => void - ): Promise | void { - const command = new DeleteUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list that describes one or more app blocks.

- */ - public describeAppBlocks( + + /** + * @see {@link DescribeAppBlocksCommand} + */ + describeAppBlocks( args: DescribeAppBlocksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAppBlocks( + describeAppBlocks( args: DescribeAppBlocksCommandInput, cb: (err: any, data?: DescribeAppBlocksCommandOutput) => void ): void; - public describeAppBlocks( + describeAppBlocks( args: DescribeAppBlocksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppBlocksCommandOutput) => void ): void; - public describeAppBlocks( - args: DescribeAppBlocksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAppBlocksCommandOutput) => void), - cb?: (err: any, data?: DescribeAppBlocksCommandOutput) => void - ): Promise | void { - const command = new DescribeAppBlocksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified.

- */ - public describeApplicationFleetAssociations( + + /** + * @see {@link DescribeApplicationFleetAssociationsCommand} + */ + describeApplicationFleetAssociations( args: DescribeApplicationFleetAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeApplicationFleetAssociations( + describeApplicationFleetAssociations( args: DescribeApplicationFleetAssociationsCommandInput, cb: (err: any, data?: DescribeApplicationFleetAssociationsCommandOutput) => void ): void; - public describeApplicationFleetAssociations( + describeApplicationFleetAssociations( args: DescribeApplicationFleetAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeApplicationFleetAssociationsCommandOutput) => void ): void; - public describeApplicationFleetAssociations( - args: DescribeApplicationFleetAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeApplicationFleetAssociationsCommandOutput) => void), - cb?: (err: any, data?: DescribeApplicationFleetAssociationsCommandOutput) => void - ): Promise | void { - const command = new DescribeApplicationFleetAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list that describes one or more applications.

- */ - public describeApplications( + + /** + * @see {@link DescribeApplicationsCommand} + */ + describeApplications( args: DescribeApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeApplications( + describeApplications( args: DescribeApplicationsCommandInput, cb: (err: any, data?: DescribeApplicationsCommandOutput) => void ): void; - public describeApplications( + describeApplications( args: DescribeApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeApplicationsCommandOutput) => void ): void; - public describeApplications( - args: DescribeApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeApplicationsCommandOutput) => void), - cb?: (err: any, data?: DescribeApplicationsCommandOutput) => void - ): Promise | void { - const command = new DescribeApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains. - *

- *

Although the response syntax in this topic includes the account password, this password is not returned in the actual response.

- */ - public describeDirectoryConfigs( + + /** + * @see {@link DescribeDirectoryConfigsCommand} + */ + describeDirectoryConfigs( args: DescribeDirectoryConfigsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDirectoryConfigs( + describeDirectoryConfigs( args: DescribeDirectoryConfigsCommandInput, cb: (err: any, data?: DescribeDirectoryConfigsCommandOutput) => void ): void; - public describeDirectoryConfigs( + describeDirectoryConfigs( args: DescribeDirectoryConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDirectoryConfigsCommandOutput) => void ): void; - public describeDirectoryConfigs( - args: DescribeDirectoryConfigsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDirectoryConfigsCommandOutput) => void), - cb?: (err: any, data?: DescribeDirectoryConfigsCommandOutput) => void - ): Promise | void { - const command = new DescribeDirectoryConfigsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list that describes one of more entitlements.

- */ - public describeEntitlements( + + /** + * @see {@link DescribeEntitlementsCommand} + */ + describeEntitlements( args: DescribeEntitlementsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEntitlements( + describeEntitlements( args: DescribeEntitlementsCommandInput, cb: (err: any, data?: DescribeEntitlementsCommandOutput) => void ): void; - public describeEntitlements( + describeEntitlements( args: DescribeEntitlementsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEntitlementsCommandOutput) => void ): void; - public describeEntitlements( - args: DescribeEntitlementsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEntitlementsCommandOutput) => void), - cb?: (err: any, data?: DescribeEntitlementsCommandOutput) => void - ): Promise | void { - const command = new DescribeEntitlementsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.

- */ - public describeFleets( + + /** + * @see {@link DescribeFleetsCommand} + */ + describeFleets( args: DescribeFleetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFleets( - args: DescribeFleetsCommandInput, - cb: (err: any, data?: DescribeFleetsCommandOutput) => void - ): void; - public describeFleets( + describeFleets(args: DescribeFleetsCommandInput, cb: (err: any, data?: DescribeFleetsCommandOutput) => void): void; + describeFleets( args: DescribeFleetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetsCommandOutput) => void ): void; - public describeFleets( - args: DescribeFleetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFleetsCommandOutput) => void), - cb?: (err: any, data?: DescribeFleetsCommandOutput) => void - ): Promise | void { - const command = new DescribeFleetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.

- */ - public describeImageBuilders( + + /** + * @see {@link DescribeImageBuildersCommand} + */ + describeImageBuilders( args: DescribeImageBuildersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeImageBuilders( + describeImageBuilders( args: DescribeImageBuildersCommandInput, cb: (err: any, data?: DescribeImageBuildersCommandOutput) => void ): void; - public describeImageBuilders( + describeImageBuilders( args: DescribeImageBuildersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImageBuildersCommandOutput) => void ): void; - public describeImageBuilders( - args: DescribeImageBuildersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeImageBuildersCommandOutput) => void), - cb?: (err: any, data?: DescribeImageBuildersCommandOutput) => void - ): Promise | void { - const command = new DescribeImageBuildersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.

- */ - public describeImagePermissions( + + /** + * @see {@link DescribeImagePermissionsCommand} + */ + describeImagePermissions( args: DescribeImagePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeImagePermissions( + describeImagePermissions( args: DescribeImagePermissionsCommandInput, cb: (err: any, data?: DescribeImagePermissionsCommandOutput) => void ): void; - public describeImagePermissions( + describeImagePermissions( args: DescribeImagePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImagePermissionsCommandOutput) => void ): void; - public describeImagePermissions( - args: DescribeImagePermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeImagePermissionsCommandOutput) => void), - cb?: (err: any, data?: DescribeImagePermissionsCommandOutput) => void - ): Promise | void { - const command = new DescribeImagePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.

- */ - public describeImages( + + /** + * @see {@link DescribeImagesCommand} + */ + describeImages( args: DescribeImagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeImages( - args: DescribeImagesCommandInput, - cb: (err: any, data?: DescribeImagesCommandOutput) => void - ): void; - public describeImages( + describeImages(args: DescribeImagesCommandInput, cb: (err: any, data?: DescribeImagesCommandOutput) => void): void; + describeImages( args: DescribeImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImagesCommandOutput) => void ): void; - public describeImages( - args: DescribeImagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeImagesCommandOutput) => void), - cb?: (err: any, data?: DescribeImagesCommandOutput) => void - ): Promise | void { - const command = new DescribeImagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, - * only streaming sessions for that user are described. If an authentication type is not provided, - * the default is to authenticate users using a streaming URL.

- */ - public describeSessions( + + /** + * @see {@link DescribeSessionsCommand} + */ + describeSessions( args: DescribeSessionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSessions( + describeSessions( args: DescribeSessionsCommandInput, cb: (err: any, data?: DescribeSessionsCommandOutput) => void ): void; - public describeSessions( + describeSessions( args: DescribeSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSessionsCommandOutput) => void ): void; - public describeSessions( - args: DescribeSessionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSessionsCommandOutput) => void), - cb?: (err: any, data?: DescribeSessionsCommandOutput) => void - ): Promise | void { - const command = new DescribeSessionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.

- */ - public describeStacks( + + /** + * @see {@link DescribeStacksCommand} + */ + describeStacks( args: DescribeStacksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStacks( - args: DescribeStacksCommandInput, - cb: (err: any, data?: DescribeStacksCommandOutput) => void - ): void; - public describeStacks( + describeStacks(args: DescribeStacksCommandInput, cb: (err: any, data?: DescribeStacksCommandOutput) => void): void; + describeStacks( args: DescribeStacksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStacksCommandOutput) => void ): void; - public describeStacks( - args: DescribeStacksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStacksCommandOutput) => void), - cb?: (err: any, data?: DescribeStacksCommandOutput) => void - ): Promise | void { - const command = new DescribeStacksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list that describes one or more usage report subscriptions.

- */ - public describeUsageReportSubscriptions( + + /** + * @see {@link DescribeUsageReportSubscriptionsCommand} + */ + describeUsageReportSubscriptions( args: DescribeUsageReportSubscriptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeUsageReportSubscriptions( + describeUsageReportSubscriptions( args: DescribeUsageReportSubscriptionsCommandInput, cb: (err: any, data?: DescribeUsageReportSubscriptionsCommandOutput) => void ): void; - public describeUsageReportSubscriptions( + describeUsageReportSubscriptions( args: DescribeUsageReportSubscriptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUsageReportSubscriptionsCommandOutput) => void ): void; - public describeUsageReportSubscriptions( - args: DescribeUsageReportSubscriptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUsageReportSubscriptionsCommandOutput) => void), - cb?: (err: any, data?: DescribeUsageReportSubscriptionsCommandOutput) => void - ): Promise | void { - const command = new DescribeUsageReportSubscriptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list that describes one or more specified users in the user pool.

- */ - public describeUsers( - args: DescribeUsersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeUsers( - args: DescribeUsersCommandInput, - cb: (err: any, data?: DescribeUsersCommandOutput) => void - ): void; - public describeUsers( + + /** + * @see {@link DescribeUsersCommand} + */ + describeUsers(args: DescribeUsersCommandInput, options?: __HttpHandlerOptions): Promise; + describeUsers(args: DescribeUsersCommandInput, cb: (err: any, data?: DescribeUsersCommandOutput) => void): void; + describeUsers( args: DescribeUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUsersCommandOutput) => void ): void; - public describeUsers( - args: DescribeUsersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUsersCommandOutput) => void), - cb?: (err: any, data?: DescribeUsersCommandOutput) => void - ): Promise | void { - const command = new DescribeUsersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following:

- *
    - *
  • - *

    The stack name

    - *
  • - *
  • - *

    The user name (email address of the user associated with the stack) and the authentication type for the user

    - *
  • - *
- */ - public describeUserStackAssociations( + + /** + * @see {@link DescribeUserStackAssociationsCommand} + */ + describeUserStackAssociations( args: DescribeUserStackAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeUserStackAssociations( + describeUserStackAssociations( args: DescribeUserStackAssociationsCommandInput, cb: (err: any, data?: DescribeUserStackAssociationsCommandOutput) => void ): void; - public describeUserStackAssociations( + describeUserStackAssociations( args: DescribeUserStackAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserStackAssociationsCommandOutput) => void ): void; - public describeUserStackAssociations( - args: DescribeUserStackAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUserStackAssociationsCommandOutput) => void), - cb?: (err: any, data?: DescribeUserStackAssociationsCommandOutput) => void - ): Promise | void { - const command = new DescribeUserStackAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user.

- */ - public disableUser(args: DisableUserCommandInput, options?: __HttpHandlerOptions): Promise; - public disableUser(args: DisableUserCommandInput, cb: (err: any, data?: DisableUserCommandOutput) => void): void; - public disableUser( + + /** + * @see {@link DisableUserCommand} + */ + disableUser(args: DisableUserCommandInput, options?: __HttpHandlerOptions): Promise; + disableUser(args: DisableUserCommandInput, cb: (err: any, data?: DisableUserCommandOutput) => void): void; + disableUser( args: DisableUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableUserCommandOutput) => void ): void; - public disableUser( - args: DisableUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableUserCommandOutput) => void), - cb?: (err: any, data?: DisableUserCommandOutput) => void - ): Promise | void { - const command = new DisableUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates the specified application from the fleet.

- */ - public disassociateApplicationFleet( + + /** + * @see {@link DisassociateApplicationFleetCommand} + */ + disassociateApplicationFleet( args: DisassociateApplicationFleetCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateApplicationFleet( + disassociateApplicationFleet( args: DisassociateApplicationFleetCommandInput, cb: (err: any, data?: DisassociateApplicationFleetCommandOutput) => void ): void; - public disassociateApplicationFleet( + disassociateApplicationFleet( args: DisassociateApplicationFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateApplicationFleetCommandOutput) => void ): void; - public disassociateApplicationFleet( - args: DisassociateApplicationFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateApplicationFleetCommandOutput) => void), - cb?: (err: any, data?: DisassociateApplicationFleetCommandOutput) => void - ): Promise | void { - const command = new DisassociateApplicationFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified application from the specified entitlement.

- */ - public disassociateApplicationFromEntitlement( + + /** + * @see {@link DisassociateApplicationFromEntitlementCommand} + */ + disassociateApplicationFromEntitlement( args: DisassociateApplicationFromEntitlementCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateApplicationFromEntitlement( + disassociateApplicationFromEntitlement( args: DisassociateApplicationFromEntitlementCommandInput, cb: (err: any, data?: DisassociateApplicationFromEntitlementCommandOutput) => void ): void; - public disassociateApplicationFromEntitlement( + disassociateApplicationFromEntitlement( args: DisassociateApplicationFromEntitlementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateApplicationFromEntitlementCommandOutput) => void ): void; - public disassociateApplicationFromEntitlement( - args: DisassociateApplicationFromEntitlementCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociateApplicationFromEntitlementCommandOutput) => void), - cb?: (err: any, data?: DisassociateApplicationFromEntitlementCommandOutput) => void - ): Promise | void { - const command = new DisassociateApplicationFromEntitlementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates the specified fleet from the specified stack.

- */ - public disassociateFleet( + + /** + * @see {@link DisassociateFleetCommand} + */ + disassociateFleet( args: DisassociateFleetCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateFleet( + disassociateFleet( args: DisassociateFleetCommandInput, cb: (err: any, data?: DisassociateFleetCommandOutput) => void ): void; - public disassociateFleet( + disassociateFleet( args: DisassociateFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateFleetCommandOutput) => void ): void; - public disassociateFleet( - args: DisassociateFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateFleetCommandOutput) => void), - cb?: (err: any, data?: DisassociateFleetCommandOutput) => void - ): Promise | void { - const command = new DisassociateFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables a user in the user pool. After being enabled, users can sign in to AppStream 2.0 and open applications from the stacks to which they are assigned.

- */ - public enableUser(args: EnableUserCommandInput, options?: __HttpHandlerOptions): Promise; - public enableUser(args: EnableUserCommandInput, cb: (err: any, data?: EnableUserCommandOutput) => void): void; - public enableUser( + + /** + * @see {@link EnableUserCommand} + */ + enableUser(args: EnableUserCommandInput, options?: __HttpHandlerOptions): Promise; + enableUser(args: EnableUserCommandInput, cb: (err: any, data?: EnableUserCommandOutput) => void): void; + enableUser( args: EnableUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableUserCommandOutput) => void ): void; - public enableUser( - args: EnableUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableUserCommandOutput) => void), - cb?: (err: any, data?: EnableUserCommandOutput) => void - ): Promise | void { - const command = new EnableUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Immediately stops the specified streaming session.

- */ - public expireSession( - args: ExpireSessionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public expireSession( - args: ExpireSessionCommandInput, - cb: (err: any, data?: ExpireSessionCommandOutput) => void - ): void; - public expireSession( + + /** + * @see {@link ExpireSessionCommand} + */ + expireSession(args: ExpireSessionCommandInput, options?: __HttpHandlerOptions): Promise; + expireSession(args: ExpireSessionCommandInput, cb: (err: any, data?: ExpireSessionCommandOutput) => void): void; + expireSession( args: ExpireSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExpireSessionCommandOutput) => void ): void; - public expireSession( - args: ExpireSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExpireSessionCommandOutput) => void), - cb?: (err: any, data?: ExpireSessionCommandOutput) => void - ): Promise | void { - const command = new ExpireSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the name of the fleet that is associated with the specified stack.

- */ - public listAssociatedFleets( + + /** + * @see {@link ListAssociatedFleetsCommand} + */ + listAssociatedFleets( args: ListAssociatedFleetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssociatedFleets( + listAssociatedFleets( args: ListAssociatedFleetsCommandInput, cb: (err: any, data?: ListAssociatedFleetsCommandOutput) => void ): void; - public listAssociatedFleets( + listAssociatedFleets( args: ListAssociatedFleetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssociatedFleetsCommandOutput) => void ): void; - public listAssociatedFleets( - args: ListAssociatedFleetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssociatedFleetsCommandOutput) => void), - cb?: (err: any, data?: ListAssociatedFleetsCommandOutput) => void - ): Promise | void { - const command = new ListAssociatedFleetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the name of the stack with which the specified fleet is associated.

- */ - public listAssociatedStacks( + + /** + * @see {@link ListAssociatedStacksCommand} + */ + listAssociatedStacks( args: ListAssociatedStacksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssociatedStacks( + listAssociatedStacks( args: ListAssociatedStacksCommandInput, cb: (err: any, data?: ListAssociatedStacksCommandOutput) => void ): void; - public listAssociatedStacks( + listAssociatedStacks( args: ListAssociatedStacksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssociatedStacksCommandOutput) => void ): void; - public listAssociatedStacks( - args: ListAssociatedStacksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssociatedStacksCommandOutput) => void), - cb?: (err: any, data?: ListAssociatedStacksCommandOutput) => void - ): Promise | void { - const command = new ListAssociatedStacksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of entitled applications.

- */ - public listEntitledApplications( + + /** + * @see {@link ListEntitledApplicationsCommand} + */ + listEntitledApplications( args: ListEntitledApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEntitledApplications( + listEntitledApplications( args: ListEntitledApplicationsCommandInput, cb: (err: any, data?: ListEntitledApplicationsCommandOutput) => void ): void; - public listEntitledApplications( + listEntitledApplications( args: ListEntitledApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEntitledApplicationsCommandOutput) => void ): void; - public listEntitledApplications( - args: ListEntitledApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEntitledApplicationsCommandOutput) => void), - cb?: (err: any, data?: ListEntitledApplicationsCommandOutput) => void - ): Promise | void { - const command = new ListEntitledApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.

- *

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts the specified fleet.

- */ - public startFleet(args: StartFleetCommandInput, options?: __HttpHandlerOptions): Promise; - public startFleet(args: StartFleetCommandInput, cb: (err: any, data?: StartFleetCommandOutput) => void): void; - public startFleet( + + /** + * @see {@link StartFleetCommand} + */ + startFleet(args: StartFleetCommandInput, options?: __HttpHandlerOptions): Promise; + startFleet(args: StartFleetCommandInput, cb: (err: any, data?: StartFleetCommandOutput) => void): void; + startFleet( args: StartFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFleetCommandOutput) => void ): void; - public startFleet( - args: StartFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartFleetCommandOutput) => void), - cb?: (err: any, data?: StartFleetCommandOutput) => void - ): Promise | void { - const command = new StartFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts the specified image builder.

- */ - public startImageBuilder( + + /** + * @see {@link StartImageBuilderCommand} + */ + startImageBuilder( args: StartImageBuilderCommandInput, options?: __HttpHandlerOptions ): Promise; - public startImageBuilder( + startImageBuilder( args: StartImageBuilderCommandInput, cb: (err: any, data?: StartImageBuilderCommandOutput) => void ): void; - public startImageBuilder( + startImageBuilder( args: StartImageBuilderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartImageBuilderCommandOutput) => void ): void; - public startImageBuilder( - args: StartImageBuilderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartImageBuilderCommandOutput) => void), - cb?: (err: any, data?: StartImageBuilderCommandOutput) => void - ): Promise | void { - const command = new StartImageBuilderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops the specified fleet.

- */ - public stopFleet(args: StopFleetCommandInput, options?: __HttpHandlerOptions): Promise; - public stopFleet(args: StopFleetCommandInput, cb: (err: any, data?: StopFleetCommandOutput) => void): void; - public stopFleet( + + /** + * @see {@link StopFleetCommand} + */ + stopFleet(args: StopFleetCommandInput, options?: __HttpHandlerOptions): Promise; + stopFleet(args: StopFleetCommandInput, cb: (err: any, data?: StopFleetCommandOutput) => void): void; + stopFleet( args: StopFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopFleetCommandOutput) => void ): void; - public stopFleet( - args: StopFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopFleetCommandOutput) => void), - cb?: (err: any, data?: StopFleetCommandOutput) => void - ): Promise | void { - const command = new StopFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops the specified image builder.

- */ - public stopImageBuilder( + + /** + * @see {@link StopImageBuilderCommand} + */ + stopImageBuilder( args: StopImageBuilderCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopImageBuilder( + stopImageBuilder( args: StopImageBuilderCommandInput, cb: (err: any, data?: StopImageBuilderCommandOutput) => void ): void; - public stopImageBuilder( + stopImageBuilder( args: StopImageBuilderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopImageBuilderCommandOutput) => void ): void; - public stopImageBuilder( - args: StopImageBuilderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopImageBuilderCommandOutput) => void), - cb?: (err: any, data?: StopImageBuilderCommandOutput) => void - ): Promise | void { - const command = new StopImageBuilderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.

- *

Each tag consists of a key and an optional value. If a resource already has a tag with the same key, - * this operation updates its value.

- *

To list the current tags for your resources, use ListTagsForResource. - * To disassociate tags from your resources, use UntagResource.

- *

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates one or more specified tags from the specified AppStream 2.0 resource.

- *

To list the current tags for your resources, use ListTagsForResource.

- *

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the specified application.

- */ - public updateApplication( + + /** + * @see {@link UpdateApplicationCommand} + */ + updateApplication( args: UpdateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( - args: UpdateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApplicationCommandOutput) => void), - cb?: (err: any, data?: UpdateApplicationCommandOutput) => void - ): Promise | void { - const command = new UpdateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

- */ - public updateDirectoryConfig( + + /** + * @see {@link UpdateDirectoryConfigCommand} + */ + updateDirectoryConfig( args: UpdateDirectoryConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDirectoryConfig( + updateDirectoryConfig( args: UpdateDirectoryConfigCommandInput, cb: (err: any, data?: UpdateDirectoryConfigCommandOutput) => void ): void; - public updateDirectoryConfig( + updateDirectoryConfig( args: UpdateDirectoryConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDirectoryConfigCommandOutput) => void ): void; - public updateDirectoryConfig( - args: UpdateDirectoryConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDirectoryConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateDirectoryConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateDirectoryConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the specified entitlement.

- */ - public updateEntitlement( + + /** + * @see {@link UpdateEntitlementCommand} + */ + updateEntitlement( args: UpdateEntitlementCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEntitlement( + updateEntitlement( args: UpdateEntitlementCommandInput, cb: (err: any, data?: UpdateEntitlementCommandOutput) => void ): void; - public updateEntitlement( + updateEntitlement( args: UpdateEntitlementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEntitlementCommandOutput) => void ): void; - public updateEntitlement( - args: UpdateEntitlementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEntitlementCommandOutput) => void), - cb?: (err: any, data?: UpdateEntitlementCommandOutput) => void - ): Promise | void { - const command = new UpdateEntitlementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the specified fleet.

- *

If the fleet is in the STOPPED state, you can update any attribute except - * the fleet name.

- *

If the fleet is in the RUNNING state, you can update the following based - * on the fleet type:

- *
    - *
  • - *

    Always-On and On-Demand fleet types

    - *

    You can update the DisplayName, ComputeCapacity, - * ImageARN, ImageName, - * IdleDisconnectTimeoutInSeconds, and - * DisconnectTimeoutInSeconds attributes.

    - *
  • - *
  • - *

    Elastic fleet type

    - *

    You can update the DisplayName, - * IdleDisconnectTimeoutInSeconds, - * DisconnectTimeoutInSeconds, MaxConcurrentSessions, SessionScriptS3Location - * and UsbDeviceFilterStrings attributes.

    - *
  • - *
- *

If the fleet is in the STARTING or STOPPED state, you can't update it.

- */ - public updateFleet(args: UpdateFleetCommandInput, options?: __HttpHandlerOptions): Promise; - public updateFleet(args: UpdateFleetCommandInput, cb: (err: any, data?: UpdateFleetCommandOutput) => void): void; - public updateFleet( + + /** + * @see {@link UpdateFleetCommand} + */ + updateFleet(args: UpdateFleetCommandInput, options?: __HttpHandlerOptions): Promise; + updateFleet(args: UpdateFleetCommandInput, cb: (err: any, data?: UpdateFleetCommandOutput) => void): void; + updateFleet( args: UpdateFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFleetCommandOutput) => void ): void; - public updateFleet( - args: UpdateFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFleetCommandOutput) => void), - cb?: (err: any, data?: UpdateFleetCommandOutput) => void - ): Promise | void { - const command = new UpdateFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds or updates permissions for the specified private image.

- */ - public updateImagePermissions( + + /** + * @see {@link UpdateImagePermissionsCommand} + */ + updateImagePermissions( args: UpdateImagePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateImagePermissions( + updateImagePermissions( args: UpdateImagePermissionsCommandInput, cb: (err: any, data?: UpdateImagePermissionsCommandOutput) => void ): void; - public updateImagePermissions( + updateImagePermissions( args: UpdateImagePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateImagePermissionsCommandOutput) => void ): void; - public updateImagePermissions( - args: UpdateImagePermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateImagePermissionsCommandOutput) => void), - cb?: (err: any, data?: UpdateImagePermissionsCommandOutput) => void - ): Promise | void { - const command = new UpdateImagePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the specified fields for the specified stack.

- */ - public updateStack(args: UpdateStackCommandInput, options?: __HttpHandlerOptions): Promise; - public updateStack(args: UpdateStackCommandInput, cb: (err: any, data?: UpdateStackCommandOutput) => void): void; - public updateStack( + + /** + * @see {@link UpdateStackCommand} + */ + updateStack(args: UpdateStackCommandInput, options?: __HttpHandlerOptions): Promise; + updateStack(args: UpdateStackCommandInput, cb: (err: any, data?: UpdateStackCommandOutput) => void): void; + updateStack( args: UpdateStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStackCommandOutput) => void ): void; - public updateStack( - args: UpdateStackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStackCommandOutput) => void), - cb?: (err: any, data?: UpdateStackCommandOutput) => void - ): Promise | void { - const command = new UpdateStackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon AppStream 2.0 + *

This is the Amazon AppStream 2.0 API Reference. This documentation provides descriptions and syntax for each of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. AppStream 2.0 manages the AWS resources that are required to host and run your applications, scales automatically, and provides access to your users on demand.

+ * + *

You can call the AppStream 2.0 API operations by using an interface VPC endpoint (interface endpoint). For more information, see Access AppStream 2.0 API Operations and CLI Commands Through an Interface VPC Endpoint in the Amazon AppStream 2.0 Administration Guide.

+ *
+ *

To learn more about AppStream 2.0, see the following resources:

+ * + */ +export class AppStream extends AppStreamClient implements AppStream {} +createAggregatedClient(commands, AppStream); diff --git a/clients/client-appsync/src/AppSync.ts b/clients/client-appsync/src/AppSync.ts index fde39548badb..39f56994c650 100644 --- a/clients/client-appsync/src/AppSync.ts +++ b/clients/client-appsync/src/AppSync.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { AppSyncClient } from "./AppSyncClient"; +import { AppSyncClient, AppSyncClientConfig } from "./AppSyncClient"; import { AssociateApiCommand, AssociateApiCommandInput, @@ -218,1636 +219,762 @@ import { } from "./commands/UpdateResolverCommand"; import { UpdateTypeCommand, UpdateTypeCommandInput, UpdateTypeCommandOutput } from "./commands/UpdateTypeCommand"; -/** - * @public - *

AppSync provides API actions for creating and interacting with data sources using GraphQL - * from your application.

- */ -export class AppSync extends AppSyncClient { +const commands = { + AssociateApiCommand, + CreateApiCacheCommand, + CreateApiKeyCommand, + CreateDataSourceCommand, + CreateDomainNameCommand, + CreateFunctionCommand, + CreateGraphqlApiCommand, + CreateResolverCommand, + CreateTypeCommand, + DeleteApiCacheCommand, + DeleteApiKeyCommand, + DeleteDataSourceCommand, + DeleteDomainNameCommand, + DeleteFunctionCommand, + DeleteGraphqlApiCommand, + DeleteResolverCommand, + DeleteTypeCommand, + DisassociateApiCommand, + EvaluateCodeCommand, + EvaluateMappingTemplateCommand, + FlushApiCacheCommand, + GetApiAssociationCommand, + GetApiCacheCommand, + GetDataSourceCommand, + GetDomainNameCommand, + GetFunctionCommand, + GetGraphqlApiCommand, + GetIntrospectionSchemaCommand, + GetResolverCommand, + GetSchemaCreationStatusCommand, + GetTypeCommand, + ListApiKeysCommand, + ListDataSourcesCommand, + ListDomainNamesCommand, + ListFunctionsCommand, + ListGraphqlApisCommand, + ListResolversCommand, + ListResolversByFunctionCommand, + ListTagsForResourceCommand, + ListTypesCommand, + StartSchemaCreationCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateApiCacheCommand, + UpdateApiKeyCommand, + UpdateDataSourceCommand, + UpdateDomainNameCommand, + UpdateFunctionCommand, + UpdateGraphqlApiCommand, + UpdateResolverCommand, + UpdateTypeCommand, +}; + +export interface AppSync { /** - * @public - *

Maps an endpoint to your custom domain.

+ * @see {@link AssociateApiCommand} */ - public associateApi( - args: AssociateApiCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public associateApi(args: AssociateApiCommandInput, cb: (err: any, data?: AssociateApiCommandOutput) => void): void; - public associateApi( + associateApi(args: AssociateApiCommandInput, options?: __HttpHandlerOptions): Promise; + associateApi(args: AssociateApiCommandInput, cb: (err: any, data?: AssociateApiCommandOutput) => void): void; + associateApi( args: AssociateApiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateApiCommandOutput) => void ): void; - public associateApi( - args: AssociateApiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateApiCommandOutput) => void), - cb?: (err: any, data?: AssociateApiCommandOutput) => void - ): Promise | void { - const command = new AssociateApiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a cache for the GraphQL API.

+ * @see {@link CreateApiCacheCommand} */ - public createApiCache( + createApiCache( args: CreateApiCacheCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApiCache( - args: CreateApiCacheCommandInput, - cb: (err: any, data?: CreateApiCacheCommandOutput) => void - ): void; - public createApiCache( + createApiCache(args: CreateApiCacheCommandInput, cb: (err: any, data?: CreateApiCacheCommandOutput) => void): void; + createApiCache( args: CreateApiCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApiCacheCommandOutput) => void ): void; - public createApiCache( - args: CreateApiCacheCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApiCacheCommandOutput) => void), - cb?: (err: any, data?: CreateApiCacheCommandOutput) => void - ): Promise | void { - const command = new CreateApiCacheCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a unique key that you can distribute to clients who invoke your API.

+ * @see {@link CreateApiKeyCommand} */ - public createApiKey( - args: CreateApiKeyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createApiKey(args: CreateApiKeyCommandInput, cb: (err: any, data?: CreateApiKeyCommandOutput) => void): void; - public createApiKey( + createApiKey(args: CreateApiKeyCommandInput, options?: __HttpHandlerOptions): Promise; + createApiKey(args: CreateApiKeyCommandInput, cb: (err: any, data?: CreateApiKeyCommandOutput) => void): void; + createApiKey( args: CreateApiKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApiKeyCommandOutput) => void ): void; - public createApiKey( - args: CreateApiKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApiKeyCommandOutput) => void), - cb?: (err: any, data?: CreateApiKeyCommandOutput) => void - ): Promise | void { - const command = new CreateApiKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a DataSource object.

+ * @see {@link CreateDataSourceCommand} */ - public createDataSource( + createDataSource( args: CreateDataSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDataSource( + createDataSource( args: CreateDataSourceCommandInput, cb: (err: any, data?: CreateDataSourceCommandOutput) => void ): void; - public createDataSource( + createDataSource( args: CreateDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataSourceCommandOutput) => void ): void; - public createDataSource( - args: CreateDataSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDataSourceCommandOutput) => void), - cb?: (err: any, data?: CreateDataSourceCommandOutput) => void - ): Promise | void { - const command = new CreateDataSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a custom DomainName object.

+ * @see {@link CreateDomainNameCommand} */ - public createDomainName( + createDomainName( args: CreateDomainNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDomainName( + createDomainName( args: CreateDomainNameCommandInput, cb: (err: any, data?: CreateDomainNameCommandOutput) => void ): void; - public createDomainName( + createDomainName( args: CreateDomainNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDomainNameCommandOutput) => void ): void; - public createDomainName( - args: CreateDomainNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDomainNameCommandOutput) => void), - cb?: (err: any, data?: CreateDomainNameCommandOutput) => void - ): Promise | void { - const command = new CreateDomainNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a Function object.

- *

A function is a reusable entity. You can use multiple functions to compose the resolver logic.

+ * @see {@link CreateFunctionCommand} */ - public createFunction( + createFunction( args: CreateFunctionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFunction( - args: CreateFunctionCommandInput, - cb: (err: any, data?: CreateFunctionCommandOutput) => void - ): void; - public createFunction( + createFunction(args: CreateFunctionCommandInput, cb: (err: any, data?: CreateFunctionCommandOutput) => void): void; + createFunction( args: CreateFunctionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFunctionCommandOutput) => void ): void; - public createFunction( - args: CreateFunctionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFunctionCommandOutput) => void), - cb?: (err: any, data?: CreateFunctionCommandOutput) => void - ): Promise | void { - const command = new CreateFunctionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a GraphqlApi object.

+ * @see {@link CreateGraphqlApiCommand} */ - public createGraphqlApi( + createGraphqlApi( args: CreateGraphqlApiCommandInput, options?: __HttpHandlerOptions ): Promise; - public createGraphqlApi( + createGraphqlApi( args: CreateGraphqlApiCommandInput, cb: (err: any, data?: CreateGraphqlApiCommandOutput) => void ): void; - public createGraphqlApi( + createGraphqlApi( args: CreateGraphqlApiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGraphqlApiCommandOutput) => void ): void; - public createGraphqlApi( - args: CreateGraphqlApiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGraphqlApiCommandOutput) => void), - cb?: (err: any, data?: CreateGraphqlApiCommandOutput) => void - ): Promise | void { - const command = new CreateGraphqlApiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a Resolver object.

- *

A resolver converts incoming requests into a format that a data source can understand, and converts the data - * source's responses into GraphQL.

+ * @see {@link CreateResolverCommand} */ - public createResolver( + createResolver( args: CreateResolverCommandInput, options?: __HttpHandlerOptions ): Promise; - public createResolver( - args: CreateResolverCommandInput, - cb: (err: any, data?: CreateResolverCommandOutput) => void - ): void; - public createResolver( + createResolver(args: CreateResolverCommandInput, cb: (err: any, data?: CreateResolverCommandOutput) => void): void; + createResolver( args: CreateResolverCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResolverCommandOutput) => void ): void; - public createResolver( - args: CreateResolverCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateResolverCommandOutput) => void), - cb?: (err: any, data?: CreateResolverCommandOutput) => void - ): Promise | void { - const command = new CreateResolverCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a Type object.

+ * @see {@link CreateTypeCommand} */ - public createType(args: CreateTypeCommandInput, options?: __HttpHandlerOptions): Promise; - public createType(args: CreateTypeCommandInput, cb: (err: any, data?: CreateTypeCommandOutput) => void): void; - public createType( + createType(args: CreateTypeCommandInput, options?: __HttpHandlerOptions): Promise; + createType(args: CreateTypeCommandInput, cb: (err: any, data?: CreateTypeCommandOutput) => void): void; + createType( args: CreateTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTypeCommandOutput) => void ): void; - public createType( - args: CreateTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTypeCommandOutput) => void), - cb?: (err: any, data?: CreateTypeCommandOutput) => void - ): Promise | void { - const command = new CreateTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an ApiCache object.

+ * @see {@link DeleteApiCacheCommand} */ - public deleteApiCache( + deleteApiCache( args: DeleteApiCacheCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApiCache( - args: DeleteApiCacheCommandInput, - cb: (err: any, data?: DeleteApiCacheCommandOutput) => void - ): void; - public deleteApiCache( + deleteApiCache(args: DeleteApiCacheCommandInput, cb: (err: any, data?: DeleteApiCacheCommandOutput) => void): void; + deleteApiCache( args: DeleteApiCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApiCacheCommandOutput) => void ): void; - public deleteApiCache( - args: DeleteApiCacheCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApiCacheCommandOutput) => void), - cb?: (err: any, data?: DeleteApiCacheCommandOutput) => void - ): Promise | void { - const command = new DeleteApiCacheCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an API key.

+ * @see {@link DeleteApiKeyCommand} */ - public deleteApiKey( - args: DeleteApiKeyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteApiKey(args: DeleteApiKeyCommandInput, cb: (err: any, data?: DeleteApiKeyCommandOutput) => void): void; - public deleteApiKey( + deleteApiKey(args: DeleteApiKeyCommandInput, options?: __HttpHandlerOptions): Promise; + deleteApiKey(args: DeleteApiKeyCommandInput, cb: (err: any, data?: DeleteApiKeyCommandOutput) => void): void; + deleteApiKey( args: DeleteApiKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApiKeyCommandOutput) => void ): void; - public deleteApiKey( - args: DeleteApiKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApiKeyCommandOutput) => void), - cb?: (err: any, data?: DeleteApiKeyCommandOutput) => void - ): Promise | void { - const command = new DeleteApiKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a DataSource object.

+ * @see {@link DeleteDataSourceCommand} */ - public deleteDataSource( + deleteDataSource( args: DeleteDataSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDataSource( + deleteDataSource( args: DeleteDataSourceCommandInput, cb: (err: any, data?: DeleteDataSourceCommandOutput) => void ): void; - public deleteDataSource( + deleteDataSource( args: DeleteDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataSourceCommandOutput) => void ): void; - public deleteDataSource( - args: DeleteDataSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDataSourceCommandOutput) => void), - cb?: (err: any, data?: DeleteDataSourceCommandOutput) => void - ): Promise | void { - const command = new DeleteDataSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a custom DomainName object.

+ * @see {@link DeleteDomainNameCommand} */ - public deleteDomainName( + deleteDomainName( args: DeleteDomainNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDomainName( + deleteDomainName( args: DeleteDomainNameCommandInput, cb: (err: any, data?: DeleteDomainNameCommandOutput) => void ): void; - public deleteDomainName( + deleteDomainName( args: DeleteDomainNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDomainNameCommandOutput) => void ): void; - public deleteDomainName( - args: DeleteDomainNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDomainNameCommandOutput) => void), - cb?: (err: any, data?: DeleteDomainNameCommandOutput) => void - ): Promise | void { - const command = new DeleteDomainNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Function.

+ * @see {@link DeleteFunctionCommand} */ - public deleteFunction( + deleteFunction( args: DeleteFunctionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFunction( - args: DeleteFunctionCommandInput, - cb: (err: any, data?: DeleteFunctionCommandOutput) => void - ): void; - public deleteFunction( + deleteFunction(args: DeleteFunctionCommandInput, cb: (err: any, data?: DeleteFunctionCommandOutput) => void): void; + deleteFunction( args: DeleteFunctionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFunctionCommandOutput) => void ): void; - public deleteFunction( - args: DeleteFunctionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFunctionCommandOutput) => void), - cb?: (err: any, data?: DeleteFunctionCommandOutput) => void - ): Promise | void { - const command = new DeleteFunctionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a GraphqlApi object.

+ * @see {@link DeleteGraphqlApiCommand} */ - public deleteGraphqlApi( + deleteGraphqlApi( args: DeleteGraphqlApiCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteGraphqlApi( + deleteGraphqlApi( args: DeleteGraphqlApiCommandInput, cb: (err: any, data?: DeleteGraphqlApiCommandOutput) => void ): void; - public deleteGraphqlApi( + deleteGraphqlApi( args: DeleteGraphqlApiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGraphqlApiCommandOutput) => void ): void; - public deleteGraphqlApi( - args: DeleteGraphqlApiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGraphqlApiCommandOutput) => void), - cb?: (err: any, data?: DeleteGraphqlApiCommandOutput) => void - ): Promise | void { - const command = new DeleteGraphqlApiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Resolver object.

+ * @see {@link DeleteResolverCommand} */ - public deleteResolver( + deleteResolver( args: DeleteResolverCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResolver( - args: DeleteResolverCommandInput, - cb: (err: any, data?: DeleteResolverCommandOutput) => void - ): void; - public deleteResolver( + deleteResolver(args: DeleteResolverCommandInput, cb: (err: any, data?: DeleteResolverCommandOutput) => void): void; + deleteResolver( args: DeleteResolverCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResolverCommandOutput) => void ): void; - public deleteResolver( - args: DeleteResolverCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResolverCommandOutput) => void), - cb?: (err: any, data?: DeleteResolverCommandOutput) => void - ): Promise | void { - const command = new DeleteResolverCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Type object.

+ * @see {@link DeleteTypeCommand} */ - public deleteType(args: DeleteTypeCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteType(args: DeleteTypeCommandInput, cb: (err: any, data?: DeleteTypeCommandOutput) => void): void; - public deleteType( + deleteType(args: DeleteTypeCommandInput, options?: __HttpHandlerOptions): Promise; + deleteType(args: DeleteTypeCommandInput, cb: (err: any, data?: DeleteTypeCommandOutput) => void): void; + deleteType( args: DeleteTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTypeCommandOutput) => void ): void; - public deleteType( - args: DeleteTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTypeCommandOutput) => void), - cb?: (err: any, data?: DeleteTypeCommandOutput) => void - ): Promise | void { - const command = new DeleteTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes an ApiAssociation object from a custom domain.

+ * @see {@link DisassociateApiCommand} */ - public disassociateApi( + disassociateApi( args: DisassociateApiCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateApi( - args: DisassociateApiCommandInput, - cb: (err: any, data?: DisassociateApiCommandOutput) => void - ): void; - public disassociateApi( + disassociateApi(args: DisassociateApiCommandInput, cb: (err: any, data?: DisassociateApiCommandOutput) => void): void; + disassociateApi( args: DisassociateApiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateApiCommandOutput) => void ): void; - public disassociateApi( - args: DisassociateApiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateApiCommandOutput) => void), - cb?: (err: any, data?: DisassociateApiCommandOutput) => void - ): Promise | void { - const command = new DisassociateApiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Evaluates the given code and returns the response. The code definition requirements depend on the specified - * runtime. For APPSYNC_JS runtimes, the code defines the request and response functions. The request - * function takes the incoming request after a GraphQL operation is parsed and converts it into a request - * configuration for the selected data source operation. The response function interprets responses from the data - * source and maps it to the shape of the GraphQL field output type.

+ * @see {@link EvaluateCodeCommand} */ - public evaluateCode( - args: EvaluateCodeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public evaluateCode(args: EvaluateCodeCommandInput, cb: (err: any, data?: EvaluateCodeCommandOutput) => void): void; - public evaluateCode( + evaluateCode(args: EvaluateCodeCommandInput, options?: __HttpHandlerOptions): Promise; + evaluateCode(args: EvaluateCodeCommandInput, cb: (err: any, data?: EvaluateCodeCommandOutput) => void): void; + evaluateCode( args: EvaluateCodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EvaluateCodeCommandOutput) => void ): void; - public evaluateCode( - args: EvaluateCodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EvaluateCodeCommandOutput) => void), - cb?: (err: any, data?: EvaluateCodeCommandOutput) => void - ): Promise | void { - const command = new EvaluateCodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Evaluates a given template and returns the response. The mapping template can be a request or response - * template.

- *

Request templates take the incoming request after a GraphQL operation is parsed and convert it into a - * request configuration for the selected data source operation. Response templates interpret responses from the - * data source and map it to the shape of the GraphQL field output type.

- *

Mapping templates are written in the Apache Velocity Template Language (VTL).

+ * @see {@link EvaluateMappingTemplateCommand} */ - public evaluateMappingTemplate( + evaluateMappingTemplate( args: EvaluateMappingTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public evaluateMappingTemplate( + evaluateMappingTemplate( args: EvaluateMappingTemplateCommandInput, cb: (err: any, data?: EvaluateMappingTemplateCommandOutput) => void ): void; - public evaluateMappingTemplate( + evaluateMappingTemplate( args: EvaluateMappingTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EvaluateMappingTemplateCommandOutput) => void ): void; - public evaluateMappingTemplate( - args: EvaluateMappingTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EvaluateMappingTemplateCommandOutput) => void), - cb?: (err: any, data?: EvaluateMappingTemplateCommandOutput) => void - ): Promise | void { - const command = new EvaluateMappingTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Flushes an ApiCache object.

+ * @see {@link FlushApiCacheCommand} */ - public flushApiCache( - args: FlushApiCacheCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public flushApiCache( - args: FlushApiCacheCommandInput, - cb: (err: any, data?: FlushApiCacheCommandOutput) => void - ): void; - public flushApiCache( + flushApiCache(args: FlushApiCacheCommandInput, options?: __HttpHandlerOptions): Promise; + flushApiCache(args: FlushApiCacheCommandInput, cb: (err: any, data?: FlushApiCacheCommandOutput) => void): void; + flushApiCache( args: FlushApiCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FlushApiCacheCommandOutput) => void ): void; - public flushApiCache( - args: FlushApiCacheCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FlushApiCacheCommandOutput) => void), - cb?: (err: any, data?: FlushApiCacheCommandOutput) => void - ): Promise | void { - const command = new FlushApiCacheCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves an ApiAssociation object.

+ * @see {@link GetApiAssociationCommand} */ - public getApiAssociation( + getApiAssociation( args: GetApiAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getApiAssociation( + getApiAssociation( args: GetApiAssociationCommandInput, cb: (err: any, data?: GetApiAssociationCommandOutput) => void ): void; - public getApiAssociation( + getApiAssociation( args: GetApiAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApiAssociationCommandOutput) => void ): void; - public getApiAssociation( - args: GetApiAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApiAssociationCommandOutput) => void), - cb?: (err: any, data?: GetApiAssociationCommandOutput) => void - ): Promise | void { - const command = new GetApiAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves an ApiCache object.

+ * @see {@link GetApiCacheCommand} */ - public getApiCache(args: GetApiCacheCommandInput, options?: __HttpHandlerOptions): Promise; - public getApiCache(args: GetApiCacheCommandInput, cb: (err: any, data?: GetApiCacheCommandOutput) => void): void; - public getApiCache( + getApiCache(args: GetApiCacheCommandInput, options?: __HttpHandlerOptions): Promise; + getApiCache(args: GetApiCacheCommandInput, cb: (err: any, data?: GetApiCacheCommandOutput) => void): void; + getApiCache( args: GetApiCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApiCacheCommandOutput) => void ): void; - public getApiCache( - args: GetApiCacheCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApiCacheCommandOutput) => void), - cb?: (err: any, data?: GetApiCacheCommandOutput) => void - ): Promise | void { - const command = new GetApiCacheCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a DataSource object.

+ * @see {@link GetDataSourceCommand} */ - public getDataSource( - args: GetDataSourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getDataSource( - args: GetDataSourceCommandInput, - cb: (err: any, data?: GetDataSourceCommandOutput) => void - ): void; - public getDataSource( + getDataSource(args: GetDataSourceCommandInput, options?: __HttpHandlerOptions): Promise; + getDataSource(args: GetDataSourceCommandInput, cb: (err: any, data?: GetDataSourceCommandOutput) => void): void; + getDataSource( args: GetDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataSourceCommandOutput) => void ): void; - public getDataSource( - args: GetDataSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDataSourceCommandOutput) => void), - cb?: (err: any, data?: GetDataSourceCommandOutput) => void - ): Promise | void { - const command = new GetDataSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a custom DomainName object.

+ * @see {@link GetDomainNameCommand} */ - public getDomainName( - args: GetDomainNameCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getDomainName( - args: GetDomainNameCommandInput, - cb: (err: any, data?: GetDomainNameCommandOutput) => void - ): void; - public getDomainName( + getDomainName(args: GetDomainNameCommandInput, options?: __HttpHandlerOptions): Promise; + getDomainName(args: GetDomainNameCommandInput, cb: (err: any, data?: GetDomainNameCommandOutput) => void): void; + getDomainName( args: GetDomainNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDomainNameCommandOutput) => void ): void; - public getDomainName( - args: GetDomainNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDomainNameCommandOutput) => void), - cb?: (err: any, data?: GetDomainNameCommandOutput) => void - ): Promise | void { - const command = new GetDomainNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get a Function.

+ * @see {@link GetFunctionCommand} */ - public getFunction(args: GetFunctionCommandInput, options?: __HttpHandlerOptions): Promise; - public getFunction(args: GetFunctionCommandInput, cb: (err: any, data?: GetFunctionCommandOutput) => void): void; - public getFunction( + getFunction(args: GetFunctionCommandInput, options?: __HttpHandlerOptions): Promise; + getFunction(args: GetFunctionCommandInput, cb: (err: any, data?: GetFunctionCommandOutput) => void): void; + getFunction( args: GetFunctionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFunctionCommandOutput) => void ): void; - public getFunction( - args: GetFunctionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFunctionCommandOutput) => void), - cb?: (err: any, data?: GetFunctionCommandOutput) => void - ): Promise | void { - const command = new GetFunctionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a GraphqlApi object.

+ * @see {@link GetGraphqlApiCommand} */ - public getGraphqlApi( - args: GetGraphqlApiCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getGraphqlApi( - args: GetGraphqlApiCommandInput, - cb: (err: any, data?: GetGraphqlApiCommandOutput) => void - ): void; - public getGraphqlApi( + getGraphqlApi(args: GetGraphqlApiCommandInput, options?: __HttpHandlerOptions): Promise; + getGraphqlApi(args: GetGraphqlApiCommandInput, cb: (err: any, data?: GetGraphqlApiCommandOutput) => void): void; + getGraphqlApi( args: GetGraphqlApiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGraphqlApiCommandOutput) => void ): void; - public getGraphqlApi( - args: GetGraphqlApiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGraphqlApiCommandOutput) => void), - cb?: (err: any, data?: GetGraphqlApiCommandOutput) => void - ): Promise | void { - const command = new GetGraphqlApiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the introspection schema for a GraphQL API.

+ * @see {@link GetIntrospectionSchemaCommand} */ - public getIntrospectionSchema( + getIntrospectionSchema( args: GetIntrospectionSchemaCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIntrospectionSchema( + getIntrospectionSchema( args: GetIntrospectionSchemaCommandInput, cb: (err: any, data?: GetIntrospectionSchemaCommandOutput) => void ): void; - public getIntrospectionSchema( + getIntrospectionSchema( args: GetIntrospectionSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIntrospectionSchemaCommandOutput) => void ): void; - public getIntrospectionSchema( - args: GetIntrospectionSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIntrospectionSchemaCommandOutput) => void), - cb?: (err: any, data?: GetIntrospectionSchemaCommandOutput) => void - ): Promise | void { - const command = new GetIntrospectionSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a Resolver object.

+ * @see {@link GetResolverCommand} */ - public getResolver(args: GetResolverCommandInput, options?: __HttpHandlerOptions): Promise; - public getResolver(args: GetResolverCommandInput, cb: (err: any, data?: GetResolverCommandOutput) => void): void; - public getResolver( + getResolver(args: GetResolverCommandInput, options?: __HttpHandlerOptions): Promise; + getResolver(args: GetResolverCommandInput, cb: (err: any, data?: GetResolverCommandOutput) => void): void; + getResolver( args: GetResolverCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResolverCommandOutput) => void ): void; - public getResolver( - args: GetResolverCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResolverCommandOutput) => void), - cb?: (err: any, data?: GetResolverCommandOutput) => void - ): Promise | void { - const command = new GetResolverCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the current status of a schema creation operation.

+ * @see {@link GetSchemaCreationStatusCommand} */ - public getSchemaCreationStatus( + getSchemaCreationStatus( args: GetSchemaCreationStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSchemaCreationStatus( + getSchemaCreationStatus( args: GetSchemaCreationStatusCommandInput, cb: (err: any, data?: GetSchemaCreationStatusCommandOutput) => void ): void; - public getSchemaCreationStatus( + getSchemaCreationStatus( args: GetSchemaCreationStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSchemaCreationStatusCommandOutput) => void ): void; - public getSchemaCreationStatus( - args: GetSchemaCreationStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSchemaCreationStatusCommandOutput) => void), - cb?: (err: any, data?: GetSchemaCreationStatusCommandOutput) => void - ): Promise | void { - const command = new GetSchemaCreationStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a Type object.

+ * @see {@link GetTypeCommand} */ - public getType(args: GetTypeCommandInput, options?: __HttpHandlerOptions): Promise; - public getType(args: GetTypeCommandInput, cb: (err: any, data?: GetTypeCommandOutput) => void): void; - public getType( + getType(args: GetTypeCommandInput, options?: __HttpHandlerOptions): Promise; + getType(args: GetTypeCommandInput, cb: (err: any, data?: GetTypeCommandOutput) => void): void; + getType( args: GetTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTypeCommandOutput) => void ): void; - public getType( - args: GetTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTypeCommandOutput) => void), - cb?: (err: any, data?: GetTypeCommandOutput) => void - ): Promise | void { - const command = new GetTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the API keys for a given API.

- * - *

API keys are deleted automatically 60 days after they expire. However, they may still be included in the - * response until they have actually been deleted. You can safely call DeleteApiKey to manually - * delete a key before it's automatically deleted.

- *
+ * @see {@link ListApiKeysCommand} */ - public listApiKeys(args: ListApiKeysCommandInput, options?: __HttpHandlerOptions): Promise; - public listApiKeys(args: ListApiKeysCommandInput, cb: (err: any, data?: ListApiKeysCommandOutput) => void): void; - public listApiKeys( + listApiKeys(args: ListApiKeysCommandInput, options?: __HttpHandlerOptions): Promise; + listApiKeys(args: ListApiKeysCommandInput, cb: (err: any, data?: ListApiKeysCommandOutput) => void): void; + listApiKeys( args: ListApiKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApiKeysCommandOutput) => void ): void; - public listApiKeys( - args: ListApiKeysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApiKeysCommandOutput) => void), - cb?: (err: any, data?: ListApiKeysCommandOutput) => void - ): Promise | void { - const command = new ListApiKeysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the data sources for a given API.

+ * @see {@link ListDataSourcesCommand} */ - public listDataSources( + listDataSources( args: ListDataSourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDataSources( - args: ListDataSourcesCommandInput, - cb: (err: any, data?: ListDataSourcesCommandOutput) => void - ): void; - public listDataSources( + listDataSources(args: ListDataSourcesCommandInput, cb: (err: any, data?: ListDataSourcesCommandOutput) => void): void; + listDataSources( args: ListDataSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataSourcesCommandOutput) => void ): void; - public listDataSources( - args: ListDataSourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDataSourcesCommandOutput) => void), - cb?: (err: any, data?: ListDataSourcesCommandOutput) => void - ): Promise | void { - const command = new ListDataSourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists multiple custom domain names.

+ * @see {@link ListDomainNamesCommand} */ - public listDomainNames( + listDomainNames( args: ListDomainNamesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDomainNames( - args: ListDomainNamesCommandInput, - cb: (err: any, data?: ListDomainNamesCommandOutput) => void - ): void; - public listDomainNames( + listDomainNames(args: ListDomainNamesCommandInput, cb: (err: any, data?: ListDomainNamesCommandOutput) => void): void; + listDomainNames( args: ListDomainNamesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainNamesCommandOutput) => void ): void; - public listDomainNames( - args: ListDomainNamesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDomainNamesCommandOutput) => void), - cb?: (err: any, data?: ListDomainNamesCommandOutput) => void - ): Promise | void { - const command = new ListDomainNamesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List multiple functions.

+ * @see {@link ListFunctionsCommand} */ - public listFunctions( - args: ListFunctionsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listFunctions( - args: ListFunctionsCommandInput, - cb: (err: any, data?: ListFunctionsCommandOutput) => void - ): void; - public listFunctions( + listFunctions(args: ListFunctionsCommandInput, options?: __HttpHandlerOptions): Promise; + listFunctions(args: ListFunctionsCommandInput, cb: (err: any, data?: ListFunctionsCommandOutput) => void): void; + listFunctions( args: ListFunctionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFunctionsCommandOutput) => void ): void; - public listFunctions( - args: ListFunctionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFunctionsCommandOutput) => void), - cb?: (err: any, data?: ListFunctionsCommandOutput) => void - ): Promise | void { - const command = new ListFunctionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists your GraphQL APIs.

+ * @see {@link ListGraphqlApisCommand} */ - public listGraphqlApis( + listGraphqlApis( args: ListGraphqlApisCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGraphqlApis( - args: ListGraphqlApisCommandInput, - cb: (err: any, data?: ListGraphqlApisCommandOutput) => void - ): void; - public listGraphqlApis( + listGraphqlApis(args: ListGraphqlApisCommandInput, cb: (err: any, data?: ListGraphqlApisCommandOutput) => void): void; + listGraphqlApis( args: ListGraphqlApisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGraphqlApisCommandOutput) => void ): void; - public listGraphqlApis( - args: ListGraphqlApisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGraphqlApisCommandOutput) => void), - cb?: (err: any, data?: ListGraphqlApisCommandOutput) => void - ): Promise | void { - const command = new ListGraphqlApisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the resolvers for a given API and type.

+ * @see {@link ListResolversCommand} */ - public listResolvers( - args: ListResolversCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listResolvers( - args: ListResolversCommandInput, - cb: (err: any, data?: ListResolversCommandOutput) => void - ): void; - public listResolvers( + listResolvers(args: ListResolversCommandInput, options?: __HttpHandlerOptions): Promise; + listResolvers(args: ListResolversCommandInput, cb: (err: any, data?: ListResolversCommandOutput) => void): void; + listResolvers( args: ListResolversCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResolversCommandOutput) => void ): void; - public listResolvers( - args: ListResolversCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResolversCommandOutput) => void), - cb?: (err: any, data?: ListResolversCommandOutput) => void - ): Promise | void { - const command = new ListResolversCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the resolvers that are associated with a specific function.

+ * @see {@link ListResolversByFunctionCommand} */ - public listResolversByFunction( + listResolversByFunction( args: ListResolversByFunctionCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResolversByFunction( + listResolversByFunction( args: ListResolversByFunctionCommandInput, cb: (err: any, data?: ListResolversByFunctionCommandOutput) => void ): void; - public listResolversByFunction( + listResolversByFunction( args: ListResolversByFunctionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResolversByFunctionCommandOutput) => void ): void; - public listResolversByFunction( - args: ListResolversByFunctionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResolversByFunctionCommandOutput) => void), - cb?: (err: any, data?: ListResolversByFunctionCommandOutput) => void - ): Promise | void { - const command = new ListResolversByFunctionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags for a resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the types for a given API.

+ * @see {@link ListTypesCommand} */ - public listTypes(args: ListTypesCommandInput, options?: __HttpHandlerOptions): Promise; - public listTypes(args: ListTypesCommandInput, cb: (err: any, data?: ListTypesCommandOutput) => void): void; - public listTypes( + listTypes(args: ListTypesCommandInput, options?: __HttpHandlerOptions): Promise; + listTypes(args: ListTypesCommandInput, cb: (err: any, data?: ListTypesCommandOutput) => void): void; + listTypes( args: ListTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTypesCommandOutput) => void ): void; - public listTypes( - args: ListTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTypesCommandOutput) => void), - cb?: (err: any, data?: ListTypesCommandOutput) => void - ): Promise | void { - const command = new ListTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a new schema to your GraphQL API.

- *

This operation is asynchronous. Use to determine when it has - * completed.

+ * @see {@link StartSchemaCreationCommand} */ - public startSchemaCreation( + startSchemaCreation( args: StartSchemaCreationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startSchemaCreation( + startSchemaCreation( args: StartSchemaCreationCommandInput, cb: (err: any, data?: StartSchemaCreationCommandOutput) => void ): void; - public startSchemaCreation( + startSchemaCreation( args: StartSchemaCreationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSchemaCreationCommandOutput) => void ): void; - public startSchemaCreation( - args: StartSchemaCreationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartSchemaCreationCommandOutput) => void), - cb?: (err: any, data?: StartSchemaCreationCommandOutput) => void - ): Promise | void { - const command = new StartSchemaCreationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Tags a resource with user-supplied tags.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Untags a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the cache for the GraphQL API.

+ * @see {@link UpdateApiCacheCommand} */ - public updateApiCache( + updateApiCache( args: UpdateApiCacheCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApiCache( - args: UpdateApiCacheCommandInput, - cb: (err: any, data?: UpdateApiCacheCommandOutput) => void - ): void; - public updateApiCache( + updateApiCache(args: UpdateApiCacheCommandInput, cb: (err: any, data?: UpdateApiCacheCommandOutput) => void): void; + updateApiCache( args: UpdateApiCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApiCacheCommandOutput) => void ): void; - public updateApiCache( - args: UpdateApiCacheCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApiCacheCommandOutput) => void), - cb?: (err: any, data?: UpdateApiCacheCommandOutput) => void - ): Promise | void { - const command = new UpdateApiCacheCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an API key. You can update the key as long as it's not deleted.

+ * @see {@link UpdateApiKeyCommand} */ - public updateApiKey( - args: UpdateApiKeyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateApiKey(args: UpdateApiKeyCommandInput, cb: (err: any, data?: UpdateApiKeyCommandOutput) => void): void; - public updateApiKey( + updateApiKey(args: UpdateApiKeyCommandInput, options?: __HttpHandlerOptions): Promise; + updateApiKey(args: UpdateApiKeyCommandInput, cb: (err: any, data?: UpdateApiKeyCommandOutput) => void): void; + updateApiKey( args: UpdateApiKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApiKeyCommandOutput) => void ): void; - public updateApiKey( - args: UpdateApiKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApiKeyCommandOutput) => void), - cb?: (err: any, data?: UpdateApiKeyCommandOutput) => void - ): Promise | void { - const command = new UpdateApiKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a DataSource object.

+ * @see {@link UpdateDataSourceCommand} */ - public updateDataSource( + updateDataSource( args: UpdateDataSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDataSource( + updateDataSource( args: UpdateDataSourceCommandInput, cb: (err: any, data?: UpdateDataSourceCommandOutput) => void ): void; - public updateDataSource( + updateDataSource( args: UpdateDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDataSourceCommandOutput) => void ): void; - public updateDataSource( - args: UpdateDataSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDataSourceCommandOutput) => void), - cb?: (err: any, data?: UpdateDataSourceCommandOutput) => void - ): Promise | void { - const command = new UpdateDataSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a custom DomainName object.

+ * @see {@link UpdateDomainNameCommand} */ - public updateDomainName( + updateDomainName( args: UpdateDomainNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDomainName( + updateDomainName( args: UpdateDomainNameCommandInput, cb: (err: any, data?: UpdateDomainNameCommandOutput) => void ): void; - public updateDomainName( + updateDomainName( args: UpdateDomainNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDomainNameCommandOutput) => void ): void; - public updateDomainName( - args: UpdateDomainNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDomainNameCommandOutput) => void), - cb?: (err: any, data?: UpdateDomainNameCommandOutput) => void - ): Promise | void { - const command = new UpdateDomainNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a Function object.

+ * @see {@link UpdateFunctionCommand} */ - public updateFunction( + updateFunction( args: UpdateFunctionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFunction( - args: UpdateFunctionCommandInput, - cb: (err: any, data?: UpdateFunctionCommandOutput) => void - ): void; - public updateFunction( + updateFunction(args: UpdateFunctionCommandInput, cb: (err: any, data?: UpdateFunctionCommandOutput) => void): void; + updateFunction( args: UpdateFunctionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFunctionCommandOutput) => void ): void; - public updateFunction( - args: UpdateFunctionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFunctionCommandOutput) => void), - cb?: (err: any, data?: UpdateFunctionCommandOutput) => void - ): Promise | void { - const command = new UpdateFunctionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a GraphqlApi object.

+ * @see {@link UpdateGraphqlApiCommand} */ - public updateGraphqlApi( + updateGraphqlApi( args: UpdateGraphqlApiCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGraphqlApi( + updateGraphqlApi( args: UpdateGraphqlApiCommandInput, cb: (err: any, data?: UpdateGraphqlApiCommandOutput) => void ): void; - public updateGraphqlApi( + updateGraphqlApi( args: UpdateGraphqlApiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGraphqlApiCommandOutput) => void ): void; - public updateGraphqlApi( - args: UpdateGraphqlApiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGraphqlApiCommandOutput) => void), - cb?: (err: any, data?: UpdateGraphqlApiCommandOutput) => void - ): Promise | void { - const command = new UpdateGraphqlApiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a Resolver object.

+ * @see {@link UpdateResolverCommand} */ - public updateResolver( + updateResolver( args: UpdateResolverCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateResolver( - args: UpdateResolverCommandInput, - cb: (err: any, data?: UpdateResolverCommandOutput) => void - ): void; - public updateResolver( + updateResolver(args: UpdateResolverCommandInput, cb: (err: any, data?: UpdateResolverCommandOutput) => void): void; + updateResolver( args: UpdateResolverCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResolverCommandOutput) => void ): void; - public updateResolver( - args: UpdateResolverCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResolverCommandOutput) => void), - cb?: (err: any, data?: UpdateResolverCommandOutput) => void - ): Promise | void { - const command = new UpdateResolverCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a Type object.

+ * @see {@link UpdateTypeCommand} */ - public updateType(args: UpdateTypeCommandInput, options?: __HttpHandlerOptions): Promise; - public updateType(args: UpdateTypeCommandInput, cb: (err: any, data?: UpdateTypeCommandOutput) => void): void; - public updateType( + updateType(args: UpdateTypeCommandInput, options?: __HttpHandlerOptions): Promise; + updateType(args: UpdateTypeCommandInput, cb: (err: any, data?: UpdateTypeCommandOutput) => void): void; + updateType( args: UpdateTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTypeCommandOutput) => void ): void; - public updateType( - args: UpdateTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTypeCommandOutput) => void), - cb?: (err: any, data?: UpdateTypeCommandOutput) => void - ): Promise | void { - const command = new UpdateTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

AppSync provides API actions for creating and interacting with data sources using GraphQL + * from your application.

+ */ +export class AppSync extends AppSyncClient implements AppSync {} +createAggregatedClient(commands, AppSync); diff --git a/clients/client-arc-zonal-shift/src/ARCZonalShift.ts b/clients/client-arc-zonal-shift/src/ARCZonalShift.ts index f4e6fd77b4ba..39e5efdd7ea1 100644 --- a/clients/client-arc-zonal-shift/src/ARCZonalShift.ts +++ b/clients/client-arc-zonal-shift/src/ARCZonalShift.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { ARCZonalShiftClient } from "./ARCZonalShiftClient"; +import { ARCZonalShiftClient, ARCZonalShiftClientConfig } from "./ARCZonalShiftClient"; import { CancelZonalShiftCommand, CancelZonalShiftCommandInput, @@ -33,234 +34,130 @@ import { UpdateZonalShiftCommandOutput, } from "./commands/UpdateZonalShiftCommand"; -/** - * @public - *

This is the API Reference Guide for the zonal shift feature of Amazon Route 53 Application Recovery Controller. This guide is for developers who need detailed information about - * zonal shift API actions, data types, and errors.

- *

Zonal shift is in preview release for Amazon Route 53 Application Recovery Controller and is subject to change.

- *

Zonal shift in Route 53 ARC enables you to move traffic for a load balancer resource away from an Availability Zone. Starting - * a zonal shift helps your application recover immediately, for example, from a developer's bad code deployment - * or from an AWS infrastructure failure in a single Availability Zone, reducing the impact and time lost from an issue - * in one zone.

- *

Supported AWS resources are automatically registered with Route 53 ARC. Resources that are registered for zonal shifts - * in Route 53 ARC are managed resources in Route 53 ARC. You can start a zonal shift for any managed resource in your account in a Region. - * At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

- *

Zonal shifts are temporary. You must specify an expiration when you start a zonal shift, of up to three days initially. - * If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. - * You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.

- *

For more information about using zonal shift, see the - * Amazon Route 53 Application Recovery Controller Developer Guide.

- */ -export class ARCZonalShift extends ARCZonalShiftClient { +const commands = { + CancelZonalShiftCommand, + GetManagedResourceCommand, + ListManagedResourcesCommand, + ListZonalShiftsCommand, + StartZonalShiftCommand, + UpdateZonalShiftCommand, +}; + +export interface ARCZonalShift { /** - * @public - *

Cancel a zonal shift in Amazon Route 53 Application Recovery Controller that you've started for a resource in your AWS account in an AWS Region.

+ * @see {@link CancelZonalShiftCommand} */ - public cancelZonalShift( + cancelZonalShift( args: CancelZonalShiftCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelZonalShift( + cancelZonalShift( args: CancelZonalShiftCommandInput, cb: (err: any, data?: CancelZonalShiftCommandOutput) => void ): void; - public cancelZonalShift( + cancelZonalShift( args: CancelZonalShiftCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelZonalShiftCommandOutput) => void ): void; - public cancelZonalShift( - args: CancelZonalShiftCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelZonalShiftCommandOutput) => void), - cb?: (err: any, data?: CancelZonalShiftCommandOutput) => void - ): Promise | void { - const command = new CancelZonalShiftCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this AWS Region. Resources that are registered for - * zonal shifts are managed resources in Route 53 ARC.

- *

At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

+ * @see {@link GetManagedResourceCommand} */ - public getManagedResource( + getManagedResource( args: GetManagedResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public getManagedResource( + getManagedResource( args: GetManagedResourceCommandInput, cb: (err: any, data?: GetManagedResourceCommandOutput) => void ): void; - public getManagedResource( + getManagedResource( args: GetManagedResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetManagedResourceCommandOutput) => void ): void; - public getManagedResource( - args: GetManagedResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetManagedResourceCommandOutput) => void), - cb?: (err: any, data?: GetManagedResourceCommandOutput) => void - ): Promise | void { - const command = new GetManagedResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the resources in your AWS account in this AWS Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information - * about them. The information includes their Amazon Resource Names (ARNs), the Availability Zones the resources are deployed in, and - * the resource name.

+ * @see {@link ListManagedResourcesCommand} */ - public listManagedResources( + listManagedResources( args: ListManagedResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listManagedResources( + listManagedResources( args: ListManagedResourcesCommandInput, cb: (err: any, data?: ListManagedResourcesCommandOutput) => void ): void; - public listManagedResources( + listManagedResources( args: ListManagedResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListManagedResourcesCommandOutput) => void ): void; - public listManagedResources( - args: ListManagedResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListManagedResourcesCommandOutput) => void), - cb?: (err: any, data?: ListManagedResourcesCommandOutput) => void - ): Promise | void { - const command = new ListManagedResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.

+ * @see {@link ListZonalShiftsCommand} */ - public listZonalShifts( + listZonalShifts( args: ListZonalShiftsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listZonalShifts( - args: ListZonalShiftsCommandInput, - cb: (err: any, data?: ListZonalShiftsCommandOutput) => void - ): void; - public listZonalShifts( + listZonalShifts(args: ListZonalShiftsCommandInput, cb: (err: any, data?: ListZonalShiftsCommandOutput) => void): void; + listZonalShifts( args: ListZonalShiftsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListZonalShiftsCommandOutput) => void ): void; - public listZonalShifts( - args: ListZonalShiftsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListZonalShiftsCommandOutput) => void), - cb?: (err: any, data?: ListZonalShiftsCommandOutput) => void - ): Promise | void { - const command = new ListZonalShiftsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in a AWS Region, - * to help your application recover immediately, for example, from a developer's bad code deployment or from an AWS - * infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed - * resources in your account in an AWS Region. Resources are automatically registered with Route 53 ARC by AWS services.

- *

At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

- *

When you start a zonal shift, traffic for the resource is no longer routed to the Availability Zone. The - * zonal shift is created immediately in Route 53 ARC. However, it can take a short time, typically up to a few minutes, - * for existing, in-progress connections in the Availability Zone to complete.

- *

For more information, see Zonal shift - * in the Amazon Route 53 Application Recovery Controller Developer Guide.

+ * @see {@link StartZonalShiftCommand} */ - public startZonalShift( + startZonalShift( args: StartZonalShiftCommandInput, options?: __HttpHandlerOptions ): Promise; - public startZonalShift( - args: StartZonalShiftCommandInput, - cb: (err: any, data?: StartZonalShiftCommandOutput) => void - ): void; - public startZonalShift( + startZonalShift(args: StartZonalShiftCommandInput, cb: (err: any, data?: StartZonalShiftCommandOutput) => void): void; + startZonalShift( args: StartZonalShiftCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartZonalShiftCommandOutput) => void ): void; - public startZonalShift( - args: StartZonalShiftCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartZonalShiftCommandOutput) => void), - cb?: (err: any, data?: StartZonalShiftCommandOutput) => void - ): Promise | void { - const command = new StartZonalShiftCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your AWS account. You can update a zonal shift to set a new expiration, or - * edit or replace the comment for the zonal shift.

+ * @see {@link UpdateZonalShiftCommand} */ - public updateZonalShift( + updateZonalShift( args: UpdateZonalShiftCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateZonalShift( + updateZonalShift( args: UpdateZonalShiftCommandInput, cb: (err: any, data?: UpdateZonalShiftCommandOutput) => void ): void; - public updateZonalShift( + updateZonalShift( args: UpdateZonalShiftCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateZonalShiftCommandOutput) => void ): void; - public updateZonalShift( - args: UpdateZonalShiftCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateZonalShiftCommandOutput) => void), - cb?: (err: any, data?: UpdateZonalShiftCommandOutput) => void - ): Promise | void { - const command = new UpdateZonalShiftCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

This is the API Reference Guide for the zonal shift feature of Amazon Route 53 Application Recovery Controller. This guide is for developers who need detailed information about + * zonal shift API actions, data types, and errors.

+ *

Zonal shift is in preview release for Amazon Route 53 Application Recovery Controller and is subject to change.

+ *

Zonal shift in Route 53 ARC enables you to move traffic for a load balancer resource away from an Availability Zone. Starting + * a zonal shift helps your application recover immediately, for example, from a developer's bad code deployment + * or from an AWS infrastructure failure in a single Availability Zone, reducing the impact and time lost from an issue + * in one zone.

+ *

Supported AWS resources are automatically registered with Route 53 ARC. Resources that are registered for zonal shifts + * in Route 53 ARC are managed resources in Route 53 ARC. You can start a zonal shift for any managed resource in your account in a Region. + * At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

+ *

Zonal shifts are temporary. You must specify an expiration when you start a zonal shift, of up to three days initially. + * If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. + * You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.

+ *

For more information about using zonal shift, see the + * Amazon Route 53 Application Recovery Controller Developer Guide.

+ */ +export class ARCZonalShift extends ARCZonalShiftClient implements ARCZonalShift {} +createAggregatedClient(commands, ARCZonalShift); diff --git a/clients/client-athena/src/Athena.ts b/clients/client-athena/src/Athena.ts index 4e088116814a..24e9f51f3aad 100644 --- a/clients/client-athena/src/Athena.ts +++ b/clients/client-athena/src/Athena.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { AthenaClient } from "./AthenaClient"; +import { AthenaClient, AthenaClientConfig } from "./AthenaClient"; import { BatchGetNamedQueryCommand, BatchGetNamedQueryCommandInput, @@ -291,2099 +292,1014 @@ import { UpdateWorkGroupCommandOutput, } from "./commands/UpdateWorkGroupCommand"; -/** - * @public - *

Amazon Athena is an interactive query service that lets you use standard SQL - * to analyze data directly in Amazon S3. You can point Athena at your - * data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay - * only for the queries you run. Athena scales automatically—executing queries - * in parallel—so results are fast, even with large datasets and complex queries. For more - * information, see What is Amazon Athena in the Amazon Athena User - * Guide.

- *

If you connect to Athena using the JDBC driver, use version 1.1.0 of the - * driver or later with the Amazon Athena API. Earlier version drivers do not - * support the API. For more information and to download the driver, see Accessing - * Amazon Athena with JDBC.

- *

For code samples using the Amazon Web Services SDK for Java, see Examples and - * Code Samples in the Amazon Athena User - * Guide.

- */ -export class Athena extends AthenaClient { +const commands = { + BatchGetNamedQueryCommand, + BatchGetPreparedStatementCommand, + BatchGetQueryExecutionCommand, + CreateDataCatalogCommand, + CreateNamedQueryCommand, + CreateNotebookCommand, + CreatePreparedStatementCommand, + CreatePresignedNotebookUrlCommand, + CreateWorkGroupCommand, + DeleteDataCatalogCommand, + DeleteNamedQueryCommand, + DeleteNotebookCommand, + DeletePreparedStatementCommand, + DeleteWorkGroupCommand, + ExportNotebookCommand, + GetCalculationExecutionCommand, + GetCalculationExecutionCodeCommand, + GetCalculationExecutionStatusCommand, + GetDatabaseCommand, + GetDataCatalogCommand, + GetNamedQueryCommand, + GetNotebookMetadataCommand, + GetPreparedStatementCommand, + GetQueryExecutionCommand, + GetQueryResultsCommand, + GetQueryRuntimeStatisticsCommand, + GetSessionCommand, + GetSessionStatusCommand, + GetTableMetadataCommand, + GetWorkGroupCommand, + ImportNotebookCommand, + ListApplicationDPUSizesCommand, + ListCalculationExecutionsCommand, + ListDatabasesCommand, + ListDataCatalogsCommand, + ListEngineVersionsCommand, + ListExecutorsCommand, + ListNamedQueriesCommand, + ListNotebookMetadataCommand, + ListNotebookSessionsCommand, + ListPreparedStatementsCommand, + ListQueryExecutionsCommand, + ListSessionsCommand, + ListTableMetadataCommand, + ListTagsForResourceCommand, + ListWorkGroupsCommand, + StartCalculationExecutionCommand, + StartQueryExecutionCommand, + StartSessionCommand, + StopCalculationExecutionCommand, + StopQueryExecutionCommand, + TagResourceCommand, + TerminateSessionCommand, + UntagResourceCommand, + UpdateDataCatalogCommand, + UpdateNamedQueryCommand, + UpdateNotebookCommand, + UpdateNotebookMetadataCommand, + UpdatePreparedStatementCommand, + UpdateWorkGroupCommand, +}; + +export interface Athena { /** - * @public - *

Returns the details of a single named query or a list of up to 50 queries, which you - * provide as an array of query ID strings. Requires you to have access to the workgroup in - * which the queries were saved. Use ListNamedQueriesInput to get the - * list of named query IDs in the specified workgroup. If information could not be - * retrieved for a submitted query ID, information about the query ID submitted is listed - * under UnprocessedNamedQueryId. Named queries differ from executed - * queries. Use BatchGetQueryExecutionInput to get details about each - * unique query execution, and ListQueryExecutionsInput to get a list of - * query execution IDs.

+ * @see {@link BatchGetNamedQueryCommand} */ - public batchGetNamedQuery( + batchGetNamedQuery( args: BatchGetNamedQueryCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetNamedQuery( + batchGetNamedQuery( args: BatchGetNamedQueryCommandInput, cb: (err: any, data?: BatchGetNamedQueryCommandOutput) => void ): void; - public batchGetNamedQuery( + batchGetNamedQuery( args: BatchGetNamedQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetNamedQueryCommandOutput) => void ): void; - public batchGetNamedQuery( - args: BatchGetNamedQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetNamedQueryCommandOutput) => void), - cb?: (err: any, data?: BatchGetNamedQueryCommandOutput) => void - ): Promise | void { - const command = new BatchGetNamedQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the details of a single prepared statement or a list of up to 256 prepared - * statements for the array of prepared statement names that you provide. Requires you to - * have access to the workgroup to which the prepared statements belong. If a prepared - * statement cannot be retrieved for the name specified, the statement is listed in - * UnprocessedPreparedStatementNames.

+ * @see {@link BatchGetPreparedStatementCommand} */ - public batchGetPreparedStatement( + batchGetPreparedStatement( args: BatchGetPreparedStatementCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetPreparedStatement( + batchGetPreparedStatement( args: BatchGetPreparedStatementCommandInput, cb: (err: any, data?: BatchGetPreparedStatementCommandOutput) => void ): void; - public batchGetPreparedStatement( + batchGetPreparedStatement( args: BatchGetPreparedStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetPreparedStatementCommandOutput) => void ): void; - public batchGetPreparedStatement( - args: BatchGetPreparedStatementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetPreparedStatementCommandOutput) => void), - cb?: (err: any, data?: BatchGetPreparedStatementCommandOutput) => void - ): Promise | void { - const command = new BatchGetPreparedStatementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the details of a single query execution or a list of up to 50 query - * executions, which you provide as an array of query execution ID strings. Requires you to - * have access to the workgroup in which the queries ran. To get a list of query execution - * IDs, use ListQueryExecutionsInput$WorkGroup. Query executions differ - * from named (saved) queries. Use BatchGetNamedQueryInput to get details - * about named queries.

+ * @see {@link BatchGetQueryExecutionCommand} */ - public batchGetQueryExecution( + batchGetQueryExecution( args: BatchGetQueryExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetQueryExecution( + batchGetQueryExecution( args: BatchGetQueryExecutionCommandInput, cb: (err: any, data?: BatchGetQueryExecutionCommandOutput) => void ): void; - public batchGetQueryExecution( + batchGetQueryExecution( args: BatchGetQueryExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetQueryExecutionCommandOutput) => void ): void; - public batchGetQueryExecution( - args: BatchGetQueryExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetQueryExecutionCommandOutput) => void), - cb?: (err: any, data?: BatchGetQueryExecutionCommandOutput) => void - ): Promise | void { - const command = new BatchGetQueryExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates (registers) a data catalog with the specified name and properties. Catalogs - * created are visible to all users of the same Amazon Web Services account.

+ * @see {@link CreateDataCatalogCommand} */ - public createDataCatalog( + createDataCatalog( args: CreateDataCatalogCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDataCatalog( + createDataCatalog( args: CreateDataCatalogCommandInput, cb: (err: any, data?: CreateDataCatalogCommandOutput) => void ): void; - public createDataCatalog( + createDataCatalog( args: CreateDataCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataCatalogCommandOutput) => void ): void; - public createDataCatalog( - args: CreateDataCatalogCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDataCatalogCommandOutput) => void), - cb?: (err: any, data?: CreateDataCatalogCommandOutput) => void - ): Promise | void { - const command = new CreateDataCatalogCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a named query in the specified workgroup. Requires that you have access to the - * workgroup.

- *

For code samples using the Amazon Web Services SDK for Java, see Examples and - * Code Samples in the Amazon Athena User - * Guide.

+ * @see {@link CreateNamedQueryCommand} */ - public createNamedQuery( + createNamedQuery( args: CreateNamedQueryCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNamedQuery( + createNamedQuery( args: CreateNamedQueryCommandInput, cb: (err: any, data?: CreateNamedQueryCommandOutput) => void ): void; - public createNamedQuery( + createNamedQuery( args: CreateNamedQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNamedQueryCommandOutput) => void ): void; - public createNamedQuery( - args: CreateNamedQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNamedQueryCommandOutput) => void), - cb?: (err: any, data?: CreateNamedQueryCommandOutput) => void - ): Promise | void { - const command = new CreateNamedQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an empty ipynb file in the specified Apache Spark enabled - * workgroup. Throws an error if a file in the workgroup with the same name already - * exists.

+ * @see {@link CreateNotebookCommand} */ - public createNotebook( + createNotebook( args: CreateNotebookCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNotebook( - args: CreateNotebookCommandInput, - cb: (err: any, data?: CreateNotebookCommandOutput) => void - ): void; - public createNotebook( + createNotebook(args: CreateNotebookCommandInput, cb: (err: any, data?: CreateNotebookCommandOutput) => void): void; + createNotebook( args: CreateNotebookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNotebookCommandOutput) => void ): void; - public createNotebook( - args: CreateNotebookCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNotebookCommandOutput) => void), - cb?: (err: any, data?: CreateNotebookCommandOutput) => void - ): Promise | void { - const command = new CreateNotebookCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a prepared statement for use with SQL queries in Athena.

+ * @see {@link CreatePreparedStatementCommand} */ - public createPreparedStatement( + createPreparedStatement( args: CreatePreparedStatementCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPreparedStatement( + createPreparedStatement( args: CreatePreparedStatementCommandInput, cb: (err: any, data?: CreatePreparedStatementCommandOutput) => void ): void; - public createPreparedStatement( + createPreparedStatement( args: CreatePreparedStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePreparedStatementCommandOutput) => void ): void; - public createPreparedStatement( - args: CreatePreparedStatementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePreparedStatementCommandOutput) => void), - cb?: (err: any, data?: CreatePreparedStatementCommandOutput) => void - ): Promise | void { - const command = new CreatePreparedStatementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets an authentication token and the URL at which the notebook can be accessed. During - * programmatic access, CreatePresignedNotebookUrl must be called every 10 - * minutes to refresh the authentication token. For information about granting programmatic - * access, see Grant - * programmatic access.

+ * @see {@link CreatePresignedNotebookUrlCommand} */ - public createPresignedNotebookUrl( + createPresignedNotebookUrl( args: CreatePresignedNotebookUrlCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPresignedNotebookUrl( + createPresignedNotebookUrl( args: CreatePresignedNotebookUrlCommandInput, cb: (err: any, data?: CreatePresignedNotebookUrlCommandOutput) => void ): void; - public createPresignedNotebookUrl( + createPresignedNotebookUrl( args: CreatePresignedNotebookUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePresignedNotebookUrlCommandOutput) => void ): void; - public createPresignedNotebookUrl( - args: CreatePresignedNotebookUrlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePresignedNotebookUrlCommandOutput) => void), - cb?: (err: any, data?: CreatePresignedNotebookUrlCommandOutput) => void - ): Promise | void { - const command = new CreatePresignedNotebookUrlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a workgroup with the specified name. A workgroup can be an Apache Spark - * enabled workgroup or an Athena SQL workgroup.

+ * @see {@link CreateWorkGroupCommand} */ - public createWorkGroup( + createWorkGroup( args: CreateWorkGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorkGroup( - args: CreateWorkGroupCommandInput, - cb: (err: any, data?: CreateWorkGroupCommandOutput) => void - ): void; - public createWorkGroup( + createWorkGroup(args: CreateWorkGroupCommandInput, cb: (err: any, data?: CreateWorkGroupCommandOutput) => void): void; + createWorkGroup( args: CreateWorkGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkGroupCommandOutput) => void ): void; - public createWorkGroup( - args: CreateWorkGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorkGroupCommandOutput) => void), - cb?: (err: any, data?: CreateWorkGroupCommandOutput) => void - ): Promise | void { - const command = new CreateWorkGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a data catalog.

+ * @see {@link DeleteDataCatalogCommand} */ - public deleteDataCatalog( + deleteDataCatalog( args: DeleteDataCatalogCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDataCatalog( + deleteDataCatalog( args: DeleteDataCatalogCommandInput, cb: (err: any, data?: DeleteDataCatalogCommandOutput) => void ): void; - public deleteDataCatalog( + deleteDataCatalog( args: DeleteDataCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataCatalogCommandOutput) => void ): void; - public deleteDataCatalog( - args: DeleteDataCatalogCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDataCatalogCommandOutput) => void), - cb?: (err: any, data?: DeleteDataCatalogCommandOutput) => void - ): Promise | void { - const command = new DeleteDataCatalogCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the named query if you have access to the workgroup in which the query was - * saved.

- *

For code samples using the Amazon Web Services SDK for Java, see Examples and - * Code Samples in the Amazon Athena User - * Guide.

+ * @see {@link DeleteNamedQueryCommand} */ - public deleteNamedQuery( + deleteNamedQuery( args: DeleteNamedQueryCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNamedQuery( + deleteNamedQuery( args: DeleteNamedQueryCommandInput, cb: (err: any, data?: DeleteNamedQueryCommandOutput) => void ): void; - public deleteNamedQuery( + deleteNamedQuery( args: DeleteNamedQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNamedQueryCommandOutput) => void ): void; - public deleteNamedQuery( - args: DeleteNamedQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNamedQueryCommandOutput) => void), - cb?: (err: any, data?: DeleteNamedQueryCommandOutput) => void - ): Promise | void { - const command = new DeleteNamedQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified notebook.

+ * @see {@link DeleteNotebookCommand} */ - public deleteNotebook( + deleteNotebook( args: DeleteNotebookCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNotebook( - args: DeleteNotebookCommandInput, - cb: (err: any, data?: DeleteNotebookCommandOutput) => void - ): void; - public deleteNotebook( + deleteNotebook(args: DeleteNotebookCommandInput, cb: (err: any, data?: DeleteNotebookCommandOutput) => void): void; + deleteNotebook( args: DeleteNotebookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNotebookCommandOutput) => void ): void; - public deleteNotebook( - args: DeleteNotebookCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNotebookCommandOutput) => void), - cb?: (err: any, data?: DeleteNotebookCommandOutput) => void - ): Promise | void { - const command = new DeleteNotebookCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the prepared statement with the specified name from the specified - * workgroup.

+ * @see {@link DeletePreparedStatementCommand} */ - public deletePreparedStatement( + deletePreparedStatement( args: DeletePreparedStatementCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePreparedStatement( + deletePreparedStatement( args: DeletePreparedStatementCommandInput, cb: (err: any, data?: DeletePreparedStatementCommandOutput) => void ): void; - public deletePreparedStatement( + deletePreparedStatement( args: DeletePreparedStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePreparedStatementCommandOutput) => void ): void; - public deletePreparedStatement( - args: DeletePreparedStatementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePreparedStatementCommandOutput) => void), - cb?: (err: any, data?: DeletePreparedStatementCommandOutput) => void - ): Promise | void { - const command = new DeletePreparedStatementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the workgroup with the specified name. The primary workgroup cannot be - * deleted.

+ * @see {@link DeleteWorkGroupCommand} */ - public deleteWorkGroup( + deleteWorkGroup( args: DeleteWorkGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWorkGroup( - args: DeleteWorkGroupCommandInput, - cb: (err: any, data?: DeleteWorkGroupCommandOutput) => void - ): void; - public deleteWorkGroup( + deleteWorkGroup(args: DeleteWorkGroupCommandInput, cb: (err: any, data?: DeleteWorkGroupCommandOutput) => void): void; + deleteWorkGroup( args: DeleteWorkGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkGroupCommandOutput) => void ): void; - public deleteWorkGroup( - args: DeleteWorkGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorkGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteWorkGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteWorkGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Exports the specified notebook and its metadata.

+ * @see {@link ExportNotebookCommand} */ - public exportNotebook( + exportNotebook( args: ExportNotebookCommandInput, options?: __HttpHandlerOptions ): Promise; - public exportNotebook( - args: ExportNotebookCommandInput, - cb: (err: any, data?: ExportNotebookCommandOutput) => void - ): void; - public exportNotebook( + exportNotebook(args: ExportNotebookCommandInput, cb: (err: any, data?: ExportNotebookCommandOutput) => void): void; + exportNotebook( args: ExportNotebookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportNotebookCommandOutput) => void ): void; - public exportNotebook( - args: ExportNotebookCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportNotebookCommandOutput) => void), - cb?: (err: any, data?: ExportNotebookCommandOutput) => void - ): Promise | void { - const command = new ExportNotebookCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a previously submitted calculation execution.

+ * @see {@link GetCalculationExecutionCommand} */ - public getCalculationExecution( + getCalculationExecution( args: GetCalculationExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCalculationExecution( + getCalculationExecution( args: GetCalculationExecutionCommandInput, cb: (err: any, data?: GetCalculationExecutionCommandOutput) => void ): void; - public getCalculationExecution( + getCalculationExecution( args: GetCalculationExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCalculationExecutionCommandOutput) => void ): void; - public getCalculationExecution( - args: GetCalculationExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCalculationExecutionCommandOutput) => void), - cb?: (err: any, data?: GetCalculationExecutionCommandOutput) => void - ): Promise | void { - const command = new GetCalculationExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the unencrypted code that was executed for the calculation.

+ * @see {@link GetCalculationExecutionCodeCommand} */ - public getCalculationExecutionCode( + getCalculationExecutionCode( args: GetCalculationExecutionCodeCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCalculationExecutionCode( + getCalculationExecutionCode( args: GetCalculationExecutionCodeCommandInput, cb: (err: any, data?: GetCalculationExecutionCodeCommandOutput) => void ): void; - public getCalculationExecutionCode( + getCalculationExecutionCode( args: GetCalculationExecutionCodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCalculationExecutionCodeCommandOutput) => void ): void; - public getCalculationExecutionCode( - args: GetCalculationExecutionCodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCalculationExecutionCodeCommandOutput) => void), - cb?: (err: any, data?: GetCalculationExecutionCodeCommandOutput) => void - ): Promise | void { - const command = new GetCalculationExecutionCodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the status of a current calculation.

+ * @see {@link GetCalculationExecutionStatusCommand} */ - public getCalculationExecutionStatus( + getCalculationExecutionStatus( args: GetCalculationExecutionStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCalculationExecutionStatus( + getCalculationExecutionStatus( args: GetCalculationExecutionStatusCommandInput, cb: (err: any, data?: GetCalculationExecutionStatusCommandOutput) => void ): void; - public getCalculationExecutionStatus( + getCalculationExecutionStatus( args: GetCalculationExecutionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCalculationExecutionStatusCommandOutput) => void ): void; - public getCalculationExecutionStatus( - args: GetCalculationExecutionStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCalculationExecutionStatusCommandOutput) => void), - cb?: (err: any, data?: GetCalculationExecutionStatusCommandOutput) => void - ): Promise | void { - const command = new GetCalculationExecutionStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a database object for the specified database and data catalog.

+ * @see {@link GetDatabaseCommand} */ - public getDatabase(args: GetDatabaseCommandInput, options?: __HttpHandlerOptions): Promise; - public getDatabase(args: GetDatabaseCommandInput, cb: (err: any, data?: GetDatabaseCommandOutput) => void): void; - public getDatabase( + getDatabase(args: GetDatabaseCommandInput, options?: __HttpHandlerOptions): Promise; + getDatabase(args: GetDatabaseCommandInput, cb: (err: any, data?: GetDatabaseCommandOutput) => void): void; + getDatabase( args: GetDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDatabaseCommandOutput) => void ): void; - public getDatabase( - args: GetDatabaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDatabaseCommandOutput) => void), - cb?: (err: any, data?: GetDatabaseCommandOutput) => void - ): Promise | void { - const command = new GetDatabaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the specified data catalog.

+ * @see {@link GetDataCatalogCommand} */ - public getDataCatalog( + getDataCatalog( args: GetDataCatalogCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDataCatalog( - args: GetDataCatalogCommandInput, - cb: (err: any, data?: GetDataCatalogCommandOutput) => void - ): void; - public getDataCatalog( + getDataCatalog(args: GetDataCatalogCommandInput, cb: (err: any, data?: GetDataCatalogCommandOutput) => void): void; + getDataCatalog( args: GetDataCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataCatalogCommandOutput) => void ): void; - public getDataCatalog( - args: GetDataCatalogCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDataCatalogCommandOutput) => void), - cb?: (err: any, data?: GetDataCatalogCommandOutput) => void - ): Promise | void { - const command = new GetDataCatalogCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a single query. Requires that you have access to the - * workgroup in which the query was saved.

+ * @see {@link GetNamedQueryCommand} */ - public getNamedQuery( - args: GetNamedQueryCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getNamedQuery( - args: GetNamedQueryCommandInput, - cb: (err: any, data?: GetNamedQueryCommandOutput) => void - ): void; - public getNamedQuery( + getNamedQuery(args: GetNamedQueryCommandInput, options?: __HttpHandlerOptions): Promise; + getNamedQuery(args: GetNamedQueryCommandInput, cb: (err: any, data?: GetNamedQueryCommandOutput) => void): void; + getNamedQuery( args: GetNamedQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNamedQueryCommandOutput) => void ): void; - public getNamedQuery( - args: GetNamedQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetNamedQueryCommandOutput) => void), - cb?: (err: any, data?: GetNamedQueryCommandOutput) => void - ): Promise | void { - const command = new GetNamedQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves notebook metadata for the specified notebook ID.

+ * @see {@link GetNotebookMetadataCommand} */ - public getNotebookMetadata( + getNotebookMetadata( args: GetNotebookMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getNotebookMetadata( + getNotebookMetadata( args: GetNotebookMetadataCommandInput, cb: (err: any, data?: GetNotebookMetadataCommandOutput) => void ): void; - public getNotebookMetadata( + getNotebookMetadata( args: GetNotebookMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNotebookMetadataCommandOutput) => void ): void; - public getNotebookMetadata( - args: GetNotebookMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetNotebookMetadataCommandOutput) => void), - cb?: (err: any, data?: GetNotebookMetadataCommandOutput) => void - ): Promise | void { - const command = new GetNotebookMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the prepared statement with the specified name from the specified - * workgroup.

+ * @see {@link GetPreparedStatementCommand} */ - public getPreparedStatement( + getPreparedStatement( args: GetPreparedStatementCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPreparedStatement( + getPreparedStatement( args: GetPreparedStatementCommandInput, cb: (err: any, data?: GetPreparedStatementCommandOutput) => void ): void; - public getPreparedStatement( + getPreparedStatement( args: GetPreparedStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPreparedStatementCommandOutput) => void ): void; - public getPreparedStatement( - args: GetPreparedStatementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPreparedStatementCommandOutput) => void), - cb?: (err: any, data?: GetPreparedStatementCommandOutput) => void - ): Promise | void { - const command = new GetPreparedStatementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a single execution of a query if you have access to the - * workgroup in which the query ran. Each time a query executes, information about the - * query execution is saved with a unique ID.

+ * @see {@link GetQueryExecutionCommand} */ - public getQueryExecution( + getQueryExecution( args: GetQueryExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getQueryExecution( + getQueryExecution( args: GetQueryExecutionCommandInput, cb: (err: any, data?: GetQueryExecutionCommandOutput) => void ): void; - public getQueryExecution( + getQueryExecution( args: GetQueryExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueryExecutionCommandOutput) => void ): void; - public getQueryExecution( - args: GetQueryExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetQueryExecutionCommandOutput) => void), - cb?: (err: any, data?: GetQueryExecutionCommandOutput) => void - ): Promise | void { - const command = new GetQueryExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Streams the results of a single query execution specified by - * QueryExecutionId from the Athena query results location in - * Amazon S3. For more information, see Working with query results, recent queries, and - * output files in the Amazon Athena User Guide. - * This request does not execute the query but returns results. Use StartQueryExecution to run a query.

- *

To stream query results successfully, the IAM principal with permission to call - * GetQueryResults also must have permissions to the Amazon S3 - * GetObject action for the Athena query results location.

- * - *

IAM principals with permission to the Amazon S3 - * GetObject action for the query results location are able to retrieve - * query results from Amazon S3 even if permission to the - * GetQueryResults action is denied. To restrict user or role access, - * ensure that Amazon S3 permissions to the Athena query location - * are denied.

- *
+ * @see {@link GetQueryResultsCommand} */ - public getQueryResults( + getQueryResults( args: GetQueryResultsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getQueryResults( - args: GetQueryResultsCommandInput, - cb: (err: any, data?: GetQueryResultsCommandOutput) => void - ): void; - public getQueryResults( + getQueryResults(args: GetQueryResultsCommandInput, cb: (err: any, data?: GetQueryResultsCommandOutput) => void): void; + getQueryResults( args: GetQueryResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueryResultsCommandOutput) => void ): void; - public getQueryResults( - args: GetQueryResultsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetQueryResultsCommandOutput) => void), - cb?: (err: any, data?: GetQueryResultsCommandOutput) => void - ): Promise | void { - const command = new GetQueryResultsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns query execution runtime statistics related to a single execution of a query if - * you have access to the workgroup in which the query ran. Query execution runtime - * statistics are returned only when QueryExecutionStatus$State is in a - * SUCCEEDED or FAILED state. Stage-level input and output row count and data size - * statistics are not shown when a query has row-level filters defined in Lake - * Formation.

+ * @see {@link GetQueryRuntimeStatisticsCommand} */ - public getQueryRuntimeStatistics( + getQueryRuntimeStatistics( args: GetQueryRuntimeStatisticsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getQueryRuntimeStatistics( + getQueryRuntimeStatistics( args: GetQueryRuntimeStatisticsCommandInput, cb: (err: any, data?: GetQueryRuntimeStatisticsCommandOutput) => void ): void; - public getQueryRuntimeStatistics( + getQueryRuntimeStatistics( args: GetQueryRuntimeStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueryRuntimeStatisticsCommandOutput) => void ): void; - public getQueryRuntimeStatistics( - args: GetQueryRuntimeStatisticsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetQueryRuntimeStatisticsCommandOutput) => void), - cb?: (err: any, data?: GetQueryRuntimeStatisticsCommandOutput) => void - ): Promise | void { - const command = new GetQueryRuntimeStatisticsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the full details of a previously created session, including the session status - * and configuration.

+ * @see {@link GetSessionCommand} */ - public getSession(args: GetSessionCommandInput, options?: __HttpHandlerOptions): Promise; - public getSession(args: GetSessionCommandInput, cb: (err: any, data?: GetSessionCommandOutput) => void): void; - public getSession( + getSession(args: GetSessionCommandInput, options?: __HttpHandlerOptions): Promise; + getSession(args: GetSessionCommandInput, cb: (err: any, data?: GetSessionCommandOutput) => void): void; + getSession( args: GetSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSessionCommandOutput) => void ): void; - public getSession( - args: GetSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSessionCommandOutput) => void), - cb?: (err: any, data?: GetSessionCommandOutput) => void - ): Promise | void { - const command = new GetSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the current status of a session.

+ * @see {@link GetSessionStatusCommand} */ - public getSessionStatus( + getSessionStatus( args: GetSessionStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSessionStatus( + getSessionStatus( args: GetSessionStatusCommandInput, cb: (err: any, data?: GetSessionStatusCommandOutput) => void ): void; - public getSessionStatus( + getSessionStatus( args: GetSessionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSessionStatusCommandOutput) => void ): void; - public getSessionStatus( - args: GetSessionStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSessionStatusCommandOutput) => void), - cb?: (err: any, data?: GetSessionStatusCommandOutput) => void - ): Promise | void { - const command = new GetSessionStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns table metadata for the specified catalog, database, and table.

+ * @see {@link GetTableMetadataCommand} */ - public getTableMetadata( + getTableMetadata( args: GetTableMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTableMetadata( + getTableMetadata( args: GetTableMetadataCommandInput, cb: (err: any, data?: GetTableMetadataCommandOutput) => void ): void; - public getTableMetadata( + getTableMetadata( args: GetTableMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTableMetadataCommandOutput) => void ): void; - public getTableMetadata( - args: GetTableMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTableMetadataCommandOutput) => void), - cb?: (err: any, data?: GetTableMetadataCommandOutput) => void - ): Promise | void { - const command = new GetTableMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the workgroup with the specified name.

+ * @see {@link GetWorkGroupCommand} */ - public getWorkGroup( - args: GetWorkGroupCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getWorkGroup(args: GetWorkGroupCommandInput, cb: (err: any, data?: GetWorkGroupCommandOutput) => void): void; - public getWorkGroup( + getWorkGroup(args: GetWorkGroupCommandInput, options?: __HttpHandlerOptions): Promise; + getWorkGroup(args: GetWorkGroupCommandInput, cb: (err: any, data?: GetWorkGroupCommandOutput) => void): void; + getWorkGroup( args: GetWorkGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkGroupCommandOutput) => void ): void; - public getWorkGroup( - args: GetWorkGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkGroupCommandOutput) => void), - cb?: (err: any, data?: GetWorkGroupCommandOutput) => void - ): Promise | void { - const command = new GetWorkGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Imports a single ipynb file to a Spark enabled workgroup. The maximum - * file size that can be imported is 10 megabytes. If an ipynb file with the - * same name already exists in the workgroup, throws an error.

+ * @see {@link ImportNotebookCommand} */ - public importNotebook( + importNotebook( args: ImportNotebookCommandInput, options?: __HttpHandlerOptions ): Promise; - public importNotebook( - args: ImportNotebookCommandInput, - cb: (err: any, data?: ImportNotebookCommandOutput) => void - ): void; - public importNotebook( + importNotebook(args: ImportNotebookCommandInput, cb: (err: any, data?: ImportNotebookCommandOutput) => void): void; + importNotebook( args: ImportNotebookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportNotebookCommandOutput) => void ): void; - public importNotebook( - args: ImportNotebookCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportNotebookCommandOutput) => void), - cb?: (err: any, data?: ImportNotebookCommandOutput) => void - ): Promise | void { - const command = new ImportNotebookCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the supported DPU sizes for the supported application runtimes (for example, - * Athena notebook version 1).

+ * @see {@link ListApplicationDPUSizesCommand} */ - public listApplicationDPUSizes( + listApplicationDPUSizes( args: ListApplicationDPUSizesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplicationDPUSizes( + listApplicationDPUSizes( args: ListApplicationDPUSizesCommandInput, cb: (err: any, data?: ListApplicationDPUSizesCommandOutput) => void ): void; - public listApplicationDPUSizes( + listApplicationDPUSizes( args: ListApplicationDPUSizesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationDPUSizesCommandOutput) => void ): void; - public listApplicationDPUSizes( - args: ListApplicationDPUSizesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationDPUSizesCommandOutput) => void), - cb?: (err: any, data?: ListApplicationDPUSizesCommandOutput) => void - ): Promise | void { - const command = new ListApplicationDPUSizesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the calculations that have been submitted to a session in descending order. - * Newer calculations are listed first; older calculations are listed later.

+ * @see {@link ListCalculationExecutionsCommand} */ - public listCalculationExecutions( + listCalculationExecutions( args: ListCalculationExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCalculationExecutions( + listCalculationExecutions( args: ListCalculationExecutionsCommandInput, cb: (err: any, data?: ListCalculationExecutionsCommandOutput) => void ): void; - public listCalculationExecutions( + listCalculationExecutions( args: ListCalculationExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCalculationExecutionsCommandOutput) => void ): void; - public listCalculationExecutions( - args: ListCalculationExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCalculationExecutionsCommandOutput) => void), - cb?: (err: any, data?: ListCalculationExecutionsCommandOutput) => void - ): Promise | void { - const command = new ListCalculationExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the databases in the specified data catalog.

+ * @see {@link ListDatabasesCommand} */ - public listDatabases( - args: ListDatabasesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listDatabases( - args: ListDatabasesCommandInput, - cb: (err: any, data?: ListDatabasesCommandOutput) => void - ): void; - public listDatabases( + listDatabases(args: ListDatabasesCommandInput, options?: __HttpHandlerOptions): Promise; + listDatabases(args: ListDatabasesCommandInput, cb: (err: any, data?: ListDatabasesCommandOutput) => void): void; + listDatabases( args: ListDatabasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatabasesCommandOutput) => void ): void; - public listDatabases( - args: ListDatabasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatabasesCommandOutput) => void), - cb?: (err: any, data?: ListDatabasesCommandOutput) => void - ): Promise | void { - const command = new ListDatabasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the data catalogs in the current Amazon Web Services account.

- * - *

In the Athena console, data catalogs are listed as "data sources" on - * the Data sources page under the Data source name column.

- *
+ * @see {@link ListDataCatalogsCommand} */ - public listDataCatalogs( + listDataCatalogs( args: ListDataCatalogsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDataCatalogs( + listDataCatalogs( args: ListDataCatalogsCommandInput, cb: (err: any, data?: ListDataCatalogsCommandOutput) => void ): void; - public listDataCatalogs( + listDataCatalogs( args: ListDataCatalogsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataCatalogsCommandOutput) => void ): void; - public listDataCatalogs( - args: ListDataCatalogsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDataCatalogsCommandOutput) => void), - cb?: (err: any, data?: ListDataCatalogsCommandOutput) => void - ): Promise | void { - const command = new ListDataCatalogsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of engine versions that are available to choose from, including the - * Auto option.

+ * @see {@link ListEngineVersionsCommand} */ - public listEngineVersions( + listEngineVersions( args: ListEngineVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEngineVersions( + listEngineVersions( args: ListEngineVersionsCommandInput, cb: (err: any, data?: ListEngineVersionsCommandOutput) => void ): void; - public listEngineVersions( + listEngineVersions( args: ListEngineVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEngineVersionsCommandOutput) => void ): void; - public listEngineVersions( - args: ListEngineVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEngineVersionsCommandOutput) => void), - cb?: (err: any, data?: ListEngineVersionsCommandOutput) => void - ): Promise | void { - const command = new ListEngineVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists, in descending order, the executors that joined a session. Newer executors are - * listed first; older executors are listed later. The result can be optionally filtered by - * state.

+ * @see {@link ListExecutorsCommand} */ - public listExecutors( - args: ListExecutorsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listExecutors( - args: ListExecutorsCommandInput, - cb: (err: any, data?: ListExecutorsCommandOutput) => void - ): void; - public listExecutors( + listExecutors(args: ListExecutorsCommandInput, options?: __HttpHandlerOptions): Promise; + listExecutors(args: ListExecutorsCommandInput, cb: (err: any, data?: ListExecutorsCommandOutput) => void): void; + listExecutors( args: ListExecutorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExecutorsCommandOutput) => void ): void; - public listExecutors( - args: ListExecutorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListExecutorsCommandOutput) => void), - cb?: (err: any, data?: ListExecutorsCommandOutput) => void - ): Promise | void { - const command = new ListExecutorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a list of available query IDs only for queries saved in the specified - * workgroup. Requires that you have access to the specified workgroup. If a workgroup is - * not specified, lists the saved queries for the primary workgroup.

- *

For code samples using the Amazon Web Services SDK for Java, see Examples and - * Code Samples in the Amazon Athena User - * Guide.

+ * @see {@link ListNamedQueriesCommand} */ - public listNamedQueries( + listNamedQueries( args: ListNamedQueriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listNamedQueries( + listNamedQueries( args: ListNamedQueriesCommandInput, cb: (err: any, data?: ListNamedQueriesCommandOutput) => void ): void; - public listNamedQueries( + listNamedQueries( args: ListNamedQueriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNamedQueriesCommandOutput) => void ): void; - public listNamedQueries( - args: ListNamedQueriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNamedQueriesCommandOutput) => void), - cb?: (err: any, data?: ListNamedQueriesCommandOutput) => void - ): Promise | void { - const command = new ListNamedQueriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays the notebook files for the specified workgroup in paginated format.

+ * @see {@link ListNotebookMetadataCommand} */ - public listNotebookMetadata( + listNotebookMetadata( args: ListNotebookMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public listNotebookMetadata( + listNotebookMetadata( args: ListNotebookMetadataCommandInput, cb: (err: any, data?: ListNotebookMetadataCommandOutput) => void ): void; - public listNotebookMetadata( + listNotebookMetadata( args: ListNotebookMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNotebookMetadataCommandOutput) => void ): void; - public listNotebookMetadata( - args: ListNotebookMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNotebookMetadataCommandOutput) => void), - cb?: (err: any, data?: ListNotebookMetadataCommandOutput) => void - ): Promise | void { - const command = new ListNotebookMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists, in descending order, the sessions that have been created in a notebook that are - * in an active state like CREATING, CREATED, IDLE - * or BUSY. Newer sessions are listed first; older sessions are listed - * later.

+ * @see {@link ListNotebookSessionsCommand} */ - public listNotebookSessions( + listNotebookSessions( args: ListNotebookSessionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listNotebookSessions( + listNotebookSessions( args: ListNotebookSessionsCommandInput, cb: (err: any, data?: ListNotebookSessionsCommandOutput) => void ): void; - public listNotebookSessions( + listNotebookSessions( args: ListNotebookSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNotebookSessionsCommandOutput) => void ): void; - public listNotebookSessions( - args: ListNotebookSessionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNotebookSessionsCommandOutput) => void), - cb?: (err: any, data?: ListNotebookSessionsCommandOutput) => void - ): Promise | void { - const command = new ListNotebookSessionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the prepared statements in the specified workgroup.

+ * @see {@link ListPreparedStatementsCommand} */ - public listPreparedStatements( + listPreparedStatements( args: ListPreparedStatementsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPreparedStatements( + listPreparedStatements( args: ListPreparedStatementsCommandInput, cb: (err: any, data?: ListPreparedStatementsCommandOutput) => void ): void; - public listPreparedStatements( + listPreparedStatements( args: ListPreparedStatementsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPreparedStatementsCommandOutput) => void ): void; - public listPreparedStatements( - args: ListPreparedStatementsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPreparedStatementsCommandOutput) => void), - cb?: (err: any, data?: ListPreparedStatementsCommandOutput) => void - ): Promise | void { - const command = new ListPreparedStatementsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a list of available query execution IDs for the queries in the specified - * workgroup. If a workgroup is not specified, returns a list of query execution IDs for - * the primary workgroup. Requires you to have access to the workgroup in which the queries - * ran.

- *

For code samples using the Amazon Web Services SDK for Java, see Examples and - * Code Samples in the Amazon Athena User - * Guide.

+ * @see {@link ListQueryExecutionsCommand} */ - public listQueryExecutions( + listQueryExecutions( args: ListQueryExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listQueryExecutions( + listQueryExecutions( args: ListQueryExecutionsCommandInput, cb: (err: any, data?: ListQueryExecutionsCommandOutput) => void ): void; - public listQueryExecutions( + listQueryExecutions( args: ListQueryExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQueryExecutionsCommandOutput) => void ): void; - public listQueryExecutions( - args: ListQueryExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListQueryExecutionsCommandOutput) => void), - cb?: (err: any, data?: ListQueryExecutionsCommandOutput) => void - ): Promise | void { - const command = new ListQueryExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the sessions in a workgroup that are in an active state like - * CREATING, CREATED, IDLE, or - * BUSY. Newer sessions are listed first; older sessions are listed - * later.

+ * @see {@link ListSessionsCommand} */ - public listSessions( - args: ListSessionsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listSessions(args: ListSessionsCommandInput, cb: (err: any, data?: ListSessionsCommandOutput) => void): void; - public listSessions( + listSessions(args: ListSessionsCommandInput, options?: __HttpHandlerOptions): Promise; + listSessions(args: ListSessionsCommandInput, cb: (err: any, data?: ListSessionsCommandOutput) => void): void; + listSessions( args: ListSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSessionsCommandOutput) => void ): void; - public listSessions( - args: ListSessionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSessionsCommandOutput) => void), - cb?: (err: any, data?: ListSessionsCommandOutput) => void - ): Promise | void { - const command = new ListSessionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the metadata for the tables in the specified data catalog database.

+ * @see {@link ListTableMetadataCommand} */ - public listTableMetadata( + listTableMetadata( args: ListTableMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTableMetadata( + listTableMetadata( args: ListTableMetadataCommandInput, cb: (err: any, data?: ListTableMetadataCommandOutput) => void ): void; - public listTableMetadata( + listTableMetadata( args: ListTableMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTableMetadataCommandOutput) => void ): void; - public listTableMetadata( - args: ListTableMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTableMetadataCommandOutput) => void), - cb?: (err: any, data?: ListTableMetadataCommandOutput) => void - ): Promise | void { - const command = new ListTableMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags associated with an Athena workgroup or data catalog - * resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists available workgroups for the account.

+ * @see {@link ListWorkGroupsCommand} */ - public listWorkGroups( + listWorkGroups( args: ListWorkGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWorkGroups( - args: ListWorkGroupsCommandInput, - cb: (err: any, data?: ListWorkGroupsCommandOutput) => void - ): void; - public listWorkGroups( + listWorkGroups(args: ListWorkGroupsCommandInput, cb: (err: any, data?: ListWorkGroupsCommandOutput) => void): void; + listWorkGroups( args: ListWorkGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkGroupsCommandOutput) => void ): void; - public listWorkGroups( - args: ListWorkGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkGroupsCommandOutput) => void), - cb?: (err: any, data?: ListWorkGroupsCommandOutput) => void - ): Promise | void { - const command = new ListWorkGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Submits calculations for execution within a session. You can supply the code to run as - * an inline code block within the request.

+ * @see {@link StartCalculationExecutionCommand} */ - public startCalculationExecution( + startCalculationExecution( args: StartCalculationExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startCalculationExecution( + startCalculationExecution( args: StartCalculationExecutionCommandInput, cb: (err: any, data?: StartCalculationExecutionCommandOutput) => void ): void; - public startCalculationExecution( + startCalculationExecution( args: StartCalculationExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCalculationExecutionCommandOutput) => void ): void; - public startCalculationExecution( - args: StartCalculationExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartCalculationExecutionCommandOutput) => void), - cb?: (err: any, data?: StartCalculationExecutionCommandOutput) => void - ): Promise | void { - const command = new StartCalculationExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Runs the SQL query statements contained in the Query. Requires you to - * have access to the workgroup in which the query ran. Running queries against an external - * catalog requires GetDataCatalog permission to the catalog. For code - * samples using the Amazon Web Services SDK for Java, see Examples and - * Code Samples in the Amazon Athena User - * Guide.

+ * @see {@link StartQueryExecutionCommand} */ - public startQueryExecution( + startQueryExecution( args: StartQueryExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startQueryExecution( + startQueryExecution( args: StartQueryExecutionCommandInput, cb: (err: any, data?: StartQueryExecutionCommandOutput) => void ): void; - public startQueryExecution( + startQueryExecution( args: StartQueryExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartQueryExecutionCommandOutput) => void ): void; - public startQueryExecution( - args: StartQueryExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartQueryExecutionCommandOutput) => void), - cb?: (err: any, data?: StartQueryExecutionCommandOutput) => void - ): Promise | void { - const command = new StartQueryExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a session for running calculations within a workgroup. The session is ready - * when it reaches an IDLE state.

+ * @see {@link StartSessionCommand} */ - public startSession( - args: StartSessionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public startSession(args: StartSessionCommandInput, cb: (err: any, data?: StartSessionCommandOutput) => void): void; - public startSession( + startSession(args: StartSessionCommandInput, options?: __HttpHandlerOptions): Promise; + startSession(args: StartSessionCommandInput, cb: (err: any, data?: StartSessionCommandOutput) => void): void; + startSession( args: StartSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSessionCommandOutput) => void ): void; - public startSession( - args: StartSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartSessionCommandOutput) => void), - cb?: (err: any, data?: StartSessionCommandOutput) => void - ): Promise | void { - const command = new StartSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Requests the cancellation of a calculation. A StopCalculationExecution - * call on a calculation that is already in a terminal state (for example, - * STOPPED, FAILED, or COMPLETED) succeeds but - * has no effect.

- * - *

Cancelling a calculation is done on a best effort basis. If a calculation cannot - * be cancelled, you can be charged for its completion. If you are concerned about - * being charged for a calculation that cannot be cancelled, consider terminating the - * session in which the calculation is running.

- *
+ * @see {@link StopCalculationExecutionCommand} */ - public stopCalculationExecution( + stopCalculationExecution( args: StopCalculationExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopCalculationExecution( + stopCalculationExecution( args: StopCalculationExecutionCommandInput, cb: (err: any, data?: StopCalculationExecutionCommandOutput) => void ): void; - public stopCalculationExecution( + stopCalculationExecution( args: StopCalculationExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopCalculationExecutionCommandOutput) => void ): void; - public stopCalculationExecution( - args: StopCalculationExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopCalculationExecutionCommandOutput) => void), - cb?: (err: any, data?: StopCalculationExecutionCommandOutput) => void - ): Promise | void { - const command = new StopCalculationExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops a query execution. Requires you to have access to the workgroup in which the - * query ran.

- *

For code samples using the Amazon Web Services SDK for Java, see Examples and - * Code Samples in the Amazon Athena User - * Guide.

+ * @see {@link StopQueryExecutionCommand} */ - public stopQueryExecution( + stopQueryExecution( args: StopQueryExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopQueryExecution( + stopQueryExecution( args: StopQueryExecutionCommandInput, cb: (err: any, data?: StopQueryExecutionCommandOutput) => void ): void; - public stopQueryExecution( + stopQueryExecution( args: StopQueryExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopQueryExecutionCommandOutput) => void ): void; - public stopQueryExecution( - args: StopQueryExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopQueryExecutionCommandOutput) => void), - cb?: (err: any, data?: StopQueryExecutionCommandOutput) => void - ): Promise | void { - const command = new StopQueryExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more tags to an Athena resource. A tag is a label that you - * assign to a resource. In Athena, a resource can be a workgroup or data - * catalog. Each tag consists of a key and an optional value, both of which you define. For - * example, you can use tags to categorize Athena workgroups or data catalogs - * by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to - * search and filter workgroups or data catalogs in your account. For best practices, see - * Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode - * characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use - * letters and numbers representable in UTF-8, and the following characters: + - = . _ : / - * @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you - * specify more than one tag, separate them by commas.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Terminates an active session. A TerminateSession call on a session that - * is already inactive (for example, in a FAILED, TERMINATED or - * TERMINATING state) succeeds but has no effect. Calculations running in - * the session when TerminateSession is called are forcefully stopped, but may - * display as FAILED instead of STOPPED.

+ * @see {@link TerminateSessionCommand} */ - public terminateSession( + terminateSession( args: TerminateSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public terminateSession( + terminateSession( args: TerminateSessionCommandInput, cb: (err: any, data?: TerminateSessionCommandOutput) => void ): void; - public terminateSession( + terminateSession( args: TerminateSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TerminateSessionCommandOutput) => void ): void; - public terminateSession( - args: TerminateSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TerminateSessionCommandOutput) => void), - cb?: (err: any, data?: TerminateSessionCommandOutput) => void - ): Promise | void { - const command = new TerminateSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from a data catalog or workgroup resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the data catalog that has the specified name.

+ * @see {@link UpdateDataCatalogCommand} */ - public updateDataCatalog( + updateDataCatalog( args: UpdateDataCatalogCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDataCatalog( + updateDataCatalog( args: UpdateDataCatalogCommandInput, cb: (err: any, data?: UpdateDataCatalogCommandOutput) => void ): void; - public updateDataCatalog( + updateDataCatalog( args: UpdateDataCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDataCatalogCommandOutput) => void ): void; - public updateDataCatalog( - args: UpdateDataCatalogCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDataCatalogCommandOutput) => void), - cb?: (err: any, data?: UpdateDataCatalogCommandOutput) => void - ): Promise | void { - const command = new UpdateDataCatalogCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a NamedQuery object. The database or workgroup cannot be - * updated.

+ * @see {@link UpdateNamedQueryCommand} */ - public updateNamedQuery( + updateNamedQuery( args: UpdateNamedQueryCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateNamedQuery( + updateNamedQuery( args: UpdateNamedQueryCommandInput, cb: (err: any, data?: UpdateNamedQueryCommandOutput) => void ): void; - public updateNamedQuery( + updateNamedQuery( args: UpdateNamedQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNamedQueryCommandOutput) => void ): void; - public updateNamedQuery( - args: UpdateNamedQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateNamedQueryCommandOutput) => void), - cb?: (err: any, data?: UpdateNamedQueryCommandOutput) => void - ): Promise | void { - const command = new UpdateNamedQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the contents of a Spark notebook.

+ * @see {@link UpdateNotebookCommand} */ - public updateNotebook( + updateNotebook( args: UpdateNotebookCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateNotebook( - args: UpdateNotebookCommandInput, - cb: (err: any, data?: UpdateNotebookCommandOutput) => void - ): void; - public updateNotebook( + updateNotebook(args: UpdateNotebookCommandInput, cb: (err: any, data?: UpdateNotebookCommandOutput) => void): void; + updateNotebook( args: UpdateNotebookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNotebookCommandOutput) => void ): void; - public updateNotebook( - args: UpdateNotebookCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateNotebookCommandOutput) => void), - cb?: (err: any, data?: UpdateNotebookCommandOutput) => void - ): Promise | void { - const command = new UpdateNotebookCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the metadata for a notebook.

+ * @see {@link UpdateNotebookMetadataCommand} */ - public updateNotebookMetadata( + updateNotebookMetadata( args: UpdateNotebookMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateNotebookMetadata( + updateNotebookMetadata( args: UpdateNotebookMetadataCommandInput, cb: (err: any, data?: UpdateNotebookMetadataCommandOutput) => void ): void; - public updateNotebookMetadata( + updateNotebookMetadata( args: UpdateNotebookMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNotebookMetadataCommandOutput) => void ): void; - public updateNotebookMetadata( - args: UpdateNotebookMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateNotebookMetadataCommandOutput) => void), - cb?: (err: any, data?: UpdateNotebookMetadataCommandOutput) => void - ): Promise | void { - const command = new UpdateNotebookMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a prepared statement.

+ * @see {@link UpdatePreparedStatementCommand} */ - public updatePreparedStatement( + updatePreparedStatement( args: UpdatePreparedStatementCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePreparedStatement( + updatePreparedStatement( args: UpdatePreparedStatementCommandInput, cb: (err: any, data?: UpdatePreparedStatementCommandOutput) => void ): void; - public updatePreparedStatement( + updatePreparedStatement( args: UpdatePreparedStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePreparedStatementCommandOutput) => void ): void; - public updatePreparedStatement( - args: UpdatePreparedStatementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePreparedStatementCommandOutput) => void), - cb?: (err: any, data?: UpdatePreparedStatementCommandOutput) => void - ): Promise | void { - const command = new UpdatePreparedStatementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the workgroup with the specified name. The workgroup's name cannot be changed. - * Only ConfigurationUpdates can be specified.

+ * @see {@link UpdateWorkGroupCommand} */ - public updateWorkGroup( + updateWorkGroup( args: UpdateWorkGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWorkGroup( - args: UpdateWorkGroupCommandInput, - cb: (err: any, data?: UpdateWorkGroupCommandOutput) => void - ): void; - public updateWorkGroup( + updateWorkGroup(args: UpdateWorkGroupCommandInput, cb: (err: any, data?: UpdateWorkGroupCommandOutput) => void): void; + updateWorkGroup( args: UpdateWorkGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkGroupCommandOutput) => void ): void; - public updateWorkGroup( - args: UpdateWorkGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWorkGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateWorkGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateWorkGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Athena is an interactive query service that lets you use standard SQL + * to analyze data directly in Amazon S3. You can point Athena at your + * data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay + * only for the queries you run. Athena scales automatically—executing queries + * in parallel—so results are fast, even with large datasets and complex queries. For more + * information, see What is Amazon Athena in the Amazon Athena User + * Guide.

+ *

If you connect to Athena using the JDBC driver, use version 1.1.0 of the + * driver or later with the Amazon Athena API. Earlier version drivers do not + * support the API. For more information and to download the driver, see Accessing + * Amazon Athena with JDBC.

+ *

For code samples using the Amazon Web Services SDK for Java, see Examples and + * Code Samples in the Amazon Athena User + * Guide.

+ */ +export class Athena extends AthenaClient implements Athena {} +createAggregatedClient(commands, Athena); diff --git a/clients/client-auditmanager/src/AuditManager.ts b/clients/client-auditmanager/src/AuditManager.ts index 44367ae0abd5..797cc76835b2 100644 --- a/clients/client-auditmanager/src/AuditManager.ts +++ b/clients/client-auditmanager/src/AuditManager.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { AuditManagerClient } from "./AuditManagerClient"; +import { AuditManagerClient, AuditManagerClientConfig } from "./AuditManagerClient"; import { AssociateAssessmentReportEvidenceFolderCommand, AssociateAssessmentReportEvidenceFolderCommandInput, @@ -288,2224 +289,1063 @@ import { ValidateAssessmentReportIntegrityCommandOutput, } from "./commands/ValidateAssessmentReportIntegrityCommand"; -/** - * @public - *

Welcome to the Audit Manager API reference. This guide is for developers who - * need detailed information about the Audit Manager API operations, data types, and - * errors.

- *

Audit Manager is a service that provides automated evidence collection so that you - * can continually audit your Amazon Web Services usage. You can use it to assess the - * effectiveness of your controls, manage risk, and simplify compliance.

- *

Audit Manager provides prebuilt frameworks that structure and automate assessments - * for a given compliance standard. Frameworks include a prebuilt collection of controls with - * descriptions and testing procedures. These controls are grouped according to the - * requirements of the specified compliance standard or regulation. You can also customize - * frameworks and controls to support internal audits with specific requirements.

- *

Use the following links to get started with the Audit Manager API:

- *
    - *
  • - *

    - * Actions: An - * alphabetical list of all Audit Manager API operations.

    - *
  • - *
  • - *

    - * Data types: An alphabetical list of all Audit Manager data - * types.

    - *
  • - *
  • - *

    - * Common - * parameters: Parameters that all operations can use.

    - *
  • - *
  • - *

    - * Common errors: - * Client and server errors that all operations can return.

    - *
  • - *
- *

If you're new to Audit Manager, we recommend that you review the - * Audit Manager User Guide.

- */ -export class AuditManager extends AuditManagerClient { +const commands = { + AssociateAssessmentReportEvidenceFolderCommand, + BatchAssociateAssessmentReportEvidenceCommand, + BatchCreateDelegationByAssessmentCommand, + BatchDeleteDelegationByAssessmentCommand, + BatchDisassociateAssessmentReportEvidenceCommand, + BatchImportEvidenceToAssessmentControlCommand, + CreateAssessmentCommand, + CreateAssessmentFrameworkCommand, + CreateAssessmentReportCommand, + CreateControlCommand, + DeleteAssessmentCommand, + DeleteAssessmentFrameworkCommand, + DeleteAssessmentFrameworkShareCommand, + DeleteAssessmentReportCommand, + DeleteControlCommand, + DeregisterAccountCommand, + DeregisterOrganizationAdminAccountCommand, + DisassociateAssessmentReportEvidenceFolderCommand, + GetAccountStatusCommand, + GetAssessmentCommand, + GetAssessmentFrameworkCommand, + GetAssessmentReportUrlCommand, + GetChangeLogsCommand, + GetControlCommand, + GetDelegationsCommand, + GetEvidenceCommand, + GetEvidenceByEvidenceFolderCommand, + GetEvidenceFolderCommand, + GetEvidenceFoldersByAssessmentCommand, + GetEvidenceFoldersByAssessmentControlCommand, + GetInsightsCommand, + GetInsightsByAssessmentCommand, + GetOrganizationAdminAccountCommand, + GetServicesInScopeCommand, + GetSettingsCommand, + ListAssessmentControlInsightsByControlDomainCommand, + ListAssessmentFrameworksCommand, + ListAssessmentFrameworkShareRequestsCommand, + ListAssessmentReportsCommand, + ListAssessmentsCommand, + ListControlDomainInsightsCommand, + ListControlDomainInsightsByAssessmentCommand, + ListControlInsightsByControlDomainCommand, + ListControlsCommand, + ListKeywordsForDataSourceCommand, + ListNotificationsCommand, + ListTagsForResourceCommand, + RegisterAccountCommand, + RegisterOrganizationAdminAccountCommand, + StartAssessmentFrameworkShareCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAssessmentCommand, + UpdateAssessmentControlCommand, + UpdateAssessmentControlSetStatusCommand, + UpdateAssessmentFrameworkCommand, + UpdateAssessmentFrameworkShareCommand, + UpdateAssessmentStatusCommand, + UpdateControlCommand, + UpdateSettingsCommand, + ValidateAssessmentReportIntegrityCommand, +}; + +export interface AuditManager { /** - * @public - *

Associates an evidence folder to an assessment report in an Audit Manager - * assessment.

+ * @see {@link AssociateAssessmentReportEvidenceFolderCommand} */ - public associateAssessmentReportEvidenceFolder( + associateAssessmentReportEvidenceFolder( args: AssociateAssessmentReportEvidenceFolderCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateAssessmentReportEvidenceFolder( + associateAssessmentReportEvidenceFolder( args: AssociateAssessmentReportEvidenceFolderCommandInput, cb: (err: any, data?: AssociateAssessmentReportEvidenceFolderCommandOutput) => void ): void; - public associateAssessmentReportEvidenceFolder( + associateAssessmentReportEvidenceFolder( args: AssociateAssessmentReportEvidenceFolderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateAssessmentReportEvidenceFolderCommandOutput) => void ): void; - public associateAssessmentReportEvidenceFolder( - args: AssociateAssessmentReportEvidenceFolderCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AssociateAssessmentReportEvidenceFolderCommandOutput) => void), - cb?: (err: any, data?: AssociateAssessmentReportEvidenceFolderCommandOutput) => void - ): Promise | void { - const command = new AssociateAssessmentReportEvidenceFolderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a list of evidence to an assessment report in an Audit Manager - * assessment.

+ * @see {@link BatchAssociateAssessmentReportEvidenceCommand} */ - public batchAssociateAssessmentReportEvidence( + batchAssociateAssessmentReportEvidence( args: BatchAssociateAssessmentReportEvidenceCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchAssociateAssessmentReportEvidence( + batchAssociateAssessmentReportEvidence( args: BatchAssociateAssessmentReportEvidenceCommandInput, cb: (err: any, data?: BatchAssociateAssessmentReportEvidenceCommandOutput) => void ): void; - public batchAssociateAssessmentReportEvidence( + batchAssociateAssessmentReportEvidence( args: BatchAssociateAssessmentReportEvidenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchAssociateAssessmentReportEvidenceCommandOutput) => void ): void; - public batchAssociateAssessmentReportEvidence( - args: BatchAssociateAssessmentReportEvidenceCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: BatchAssociateAssessmentReportEvidenceCommandOutput) => void), - cb?: (err: any, data?: BatchAssociateAssessmentReportEvidenceCommandOutput) => void - ): Promise | void { - const command = new BatchAssociateAssessmentReportEvidenceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a batch of delegations for an assessment in Audit Manager.

+ * @see {@link BatchCreateDelegationByAssessmentCommand} */ - public batchCreateDelegationByAssessment( + batchCreateDelegationByAssessment( args: BatchCreateDelegationByAssessmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchCreateDelegationByAssessment( + batchCreateDelegationByAssessment( args: BatchCreateDelegationByAssessmentCommandInput, cb: (err: any, data?: BatchCreateDelegationByAssessmentCommandOutput) => void ): void; - public batchCreateDelegationByAssessment( + batchCreateDelegationByAssessment( args: BatchCreateDelegationByAssessmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCreateDelegationByAssessmentCommandOutput) => void ): void; - public batchCreateDelegationByAssessment( - args: BatchCreateDelegationByAssessmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchCreateDelegationByAssessmentCommandOutput) => void), - cb?: (err: any, data?: BatchCreateDelegationByAssessmentCommandOutput) => void - ): Promise | void { - const command = new BatchCreateDelegationByAssessmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a batch of delegations for an assessment in Audit Manager.

+ * @see {@link BatchDeleteDelegationByAssessmentCommand} */ - public batchDeleteDelegationByAssessment( + batchDeleteDelegationByAssessment( args: BatchDeleteDelegationByAssessmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeleteDelegationByAssessment( + batchDeleteDelegationByAssessment( args: BatchDeleteDelegationByAssessmentCommandInput, cb: (err: any, data?: BatchDeleteDelegationByAssessmentCommandOutput) => void ): void; - public batchDeleteDelegationByAssessment( + batchDeleteDelegationByAssessment( args: BatchDeleteDelegationByAssessmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteDelegationByAssessmentCommandOutput) => void ): void; - public batchDeleteDelegationByAssessment( - args: BatchDeleteDelegationByAssessmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeleteDelegationByAssessmentCommandOutput) => void), - cb?: (err: any, data?: BatchDeleteDelegationByAssessmentCommandOutput) => void - ): Promise | void { - const command = new BatchDeleteDelegationByAssessmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates a list of evidence from an assessment report in Audit Manager. - *

+ * @see {@link BatchDisassociateAssessmentReportEvidenceCommand} */ - public batchDisassociateAssessmentReportEvidence( + batchDisassociateAssessmentReportEvidence( args: BatchDisassociateAssessmentReportEvidenceCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDisassociateAssessmentReportEvidence( + batchDisassociateAssessmentReportEvidence( args: BatchDisassociateAssessmentReportEvidenceCommandInput, cb: (err: any, data?: BatchDisassociateAssessmentReportEvidenceCommandOutput) => void ): void; - public batchDisassociateAssessmentReportEvidence( + batchDisassociateAssessmentReportEvidence( args: BatchDisassociateAssessmentReportEvidenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDisassociateAssessmentReportEvidenceCommandOutput) => void ): void; - public batchDisassociateAssessmentReportEvidence( - args: BatchDisassociateAssessmentReportEvidenceCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: BatchDisassociateAssessmentReportEvidenceCommandOutput) => void), - cb?: (err: any, data?: BatchDisassociateAssessmentReportEvidenceCommandOutput) => void - ): Promise | void { - const command = new BatchDisassociateAssessmentReportEvidenceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Uploads one or more pieces of evidence to a control in an Audit Manager assessment. - * You can upload manual evidence from any Amazon Simple Storage Service (Amazon S3) bucket by - * specifying the S3 URI of the evidence.

- *

You must upload manual evidence to your S3 bucket before you can upload it to your - * assessment. For instructions, see CreateBucket and PutObject in - * the Amazon Simple Storage Service API Reference. - *

- *

The following restrictions apply to this action:

- *
    - *
  • - *

    Maximum size of an individual evidence file: 100 MB

    - *
  • - *
  • - *

    Number of daily manual evidence uploads per control: 100

    - *
  • - *
  • - *

    Supported file formats: See Supported file types for manual evidence in the Audit Manager User Guide - *

    - *
  • - *
- *

For more information about Audit Manager service restrictions, see Quotas and - * restrictions for Audit Manager.

+ * @see {@link BatchImportEvidenceToAssessmentControlCommand} */ - public batchImportEvidenceToAssessmentControl( + batchImportEvidenceToAssessmentControl( args: BatchImportEvidenceToAssessmentControlCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchImportEvidenceToAssessmentControl( + batchImportEvidenceToAssessmentControl( args: BatchImportEvidenceToAssessmentControlCommandInput, cb: (err: any, data?: BatchImportEvidenceToAssessmentControlCommandOutput) => void ): void; - public batchImportEvidenceToAssessmentControl( + batchImportEvidenceToAssessmentControl( args: BatchImportEvidenceToAssessmentControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchImportEvidenceToAssessmentControlCommandOutput) => void ): void; - public batchImportEvidenceToAssessmentControl( - args: BatchImportEvidenceToAssessmentControlCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: BatchImportEvidenceToAssessmentControlCommandOutput) => void), - cb?: (err: any, data?: BatchImportEvidenceToAssessmentControlCommandOutput) => void - ): Promise | void { - const command = new BatchImportEvidenceToAssessmentControlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an assessment in Audit Manager.

+ * @see {@link CreateAssessmentCommand} */ - public createAssessment( + createAssessment( args: CreateAssessmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAssessment( + createAssessment( args: CreateAssessmentCommandInput, cb: (err: any, data?: CreateAssessmentCommandOutput) => void ): void; - public createAssessment( + createAssessment( args: CreateAssessmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAssessmentCommandOutput) => void ): void; - public createAssessment( - args: CreateAssessmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAssessmentCommandOutput) => void), - cb?: (err: any, data?: CreateAssessmentCommandOutput) => void - ): Promise | void { - const command = new CreateAssessmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a custom framework in Audit Manager.

+ * @see {@link CreateAssessmentFrameworkCommand} */ - public createAssessmentFramework( + createAssessmentFramework( args: CreateAssessmentFrameworkCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAssessmentFramework( + createAssessmentFramework( args: CreateAssessmentFrameworkCommandInput, cb: (err: any, data?: CreateAssessmentFrameworkCommandOutput) => void ): void; - public createAssessmentFramework( + createAssessmentFramework( args: CreateAssessmentFrameworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAssessmentFrameworkCommandOutput) => void ): void; - public createAssessmentFramework( - args: CreateAssessmentFrameworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAssessmentFrameworkCommandOutput) => void), - cb?: (err: any, data?: CreateAssessmentFrameworkCommandOutput) => void - ): Promise | void { - const command = new CreateAssessmentFrameworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an assessment report for the specified assessment.

+ * @see {@link CreateAssessmentReportCommand} */ - public createAssessmentReport( + createAssessmentReport( args: CreateAssessmentReportCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAssessmentReport( + createAssessmentReport( args: CreateAssessmentReportCommandInput, cb: (err: any, data?: CreateAssessmentReportCommandOutput) => void ): void; - public createAssessmentReport( + createAssessmentReport( args: CreateAssessmentReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAssessmentReportCommandOutput) => void ): void; - public createAssessmentReport( - args: CreateAssessmentReportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAssessmentReportCommandOutput) => void), - cb?: (err: any, data?: CreateAssessmentReportCommandOutput) => void - ): Promise | void { - const command = new CreateAssessmentReportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new custom control in Audit Manager.

+ * @see {@link CreateControlCommand} */ - public createControl( - args: CreateControlCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createControl( - args: CreateControlCommandInput, - cb: (err: any, data?: CreateControlCommandOutput) => void - ): void; - public createControl( + createControl(args: CreateControlCommandInput, options?: __HttpHandlerOptions): Promise; + createControl(args: CreateControlCommandInput, cb: (err: any, data?: CreateControlCommandOutput) => void): void; + createControl( args: CreateControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateControlCommandOutput) => void ): void; - public createControl( - args: CreateControlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateControlCommandOutput) => void), - cb?: (err: any, data?: CreateControlCommandOutput) => void - ): Promise | void { - const command = new CreateControlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an assessment in Audit Manager.

+ * @see {@link DeleteAssessmentCommand} */ - public deleteAssessment( + deleteAssessment( args: DeleteAssessmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAssessment( + deleteAssessment( args: DeleteAssessmentCommandInput, cb: (err: any, data?: DeleteAssessmentCommandOutput) => void ): void; - public deleteAssessment( + deleteAssessment( args: DeleteAssessmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAssessmentCommandOutput) => void ): void; - public deleteAssessment( - args: DeleteAssessmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAssessmentCommandOutput) => void), - cb?: (err: any, data?: DeleteAssessmentCommandOutput) => void - ): Promise | void { - const command = new DeleteAssessmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a custom framework in Audit Manager.

+ * @see {@link DeleteAssessmentFrameworkCommand} */ - public deleteAssessmentFramework( + deleteAssessmentFramework( args: DeleteAssessmentFrameworkCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAssessmentFramework( + deleteAssessmentFramework( args: DeleteAssessmentFrameworkCommandInput, cb: (err: any, data?: DeleteAssessmentFrameworkCommandOutput) => void ): void; - public deleteAssessmentFramework( + deleteAssessmentFramework( args: DeleteAssessmentFrameworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAssessmentFrameworkCommandOutput) => void ): void; - public deleteAssessmentFramework( - args: DeleteAssessmentFrameworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAssessmentFrameworkCommandOutput) => void), - cb?: (err: any, data?: DeleteAssessmentFrameworkCommandOutput) => void - ): Promise | void { - const command = new DeleteAssessmentFrameworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a share request for a custom framework in Audit Manager.

+ * @see {@link DeleteAssessmentFrameworkShareCommand} */ - public deleteAssessmentFrameworkShare( + deleteAssessmentFrameworkShare( args: DeleteAssessmentFrameworkShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAssessmentFrameworkShare( + deleteAssessmentFrameworkShare( args: DeleteAssessmentFrameworkShareCommandInput, cb: (err: any, data?: DeleteAssessmentFrameworkShareCommandOutput) => void ): void; - public deleteAssessmentFrameworkShare( + deleteAssessmentFrameworkShare( args: DeleteAssessmentFrameworkShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAssessmentFrameworkShareCommandOutput) => void ): void; - public deleteAssessmentFrameworkShare( - args: DeleteAssessmentFrameworkShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAssessmentFrameworkShareCommandOutput) => void), - cb?: (err: any, data?: DeleteAssessmentFrameworkShareCommandOutput) => void - ): Promise | void { - const command = new DeleteAssessmentFrameworkShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an assessment report in Audit Manager.

- *

When you run the DeleteAssessmentReport operation, Audit Manager - * attempts to delete the following data:

- *
    - *
  1. - *

    The specified assessment report that’s stored in your S3 bucket

    - *
  2. - *
  3. - *

    The associated metadata that’s stored in Audit Manager

    - *
  4. - *
- *

If Audit Manager can’t access the assessment report in your S3 bucket, the report - * isn’t deleted. In this event, the DeleteAssessmentReport operation doesn’t - * fail. Instead, it proceeds to delete the associated metadata only. You must then delete the - * assessment report from the S3 bucket yourself.

- *

This scenario happens when Audit Manager receives a 403 (Forbidden) or - * 404 (Not Found) error from Amazon S3. To avoid this, make sure that - * your S3 bucket is available, and that you configured the correct permissions for Audit Manager to delete resources in your S3 bucket. For an example permissions policy that - * you can use, see Assessment report destination permissions in the Audit Manager User Guide. For information about the issues that could cause a 403 - * (Forbidden) or 404 (Not Found) error from Amazon S3, see - * List of Error Codes in the Amazon Simple Storage Service API - * Reference.

+ * @see {@link DeleteAssessmentReportCommand} */ - public deleteAssessmentReport( + deleteAssessmentReport( args: DeleteAssessmentReportCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAssessmentReport( + deleteAssessmentReport( args: DeleteAssessmentReportCommandInput, cb: (err: any, data?: DeleteAssessmentReportCommandOutput) => void ): void; - public deleteAssessmentReport( + deleteAssessmentReport( args: DeleteAssessmentReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAssessmentReportCommandOutput) => void ): void; - public deleteAssessmentReport( - args: DeleteAssessmentReportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAssessmentReportCommandOutput) => void), - cb?: (err: any, data?: DeleteAssessmentReportCommandOutput) => void - ): Promise | void { - const command = new DeleteAssessmentReportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a custom control in Audit Manager.

+ * @see {@link DeleteControlCommand} */ - public deleteControl( - args: DeleteControlCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteControl( - args: DeleteControlCommandInput, - cb: (err: any, data?: DeleteControlCommandOutput) => void - ): void; - public deleteControl( + deleteControl(args: DeleteControlCommandInput, options?: __HttpHandlerOptions): Promise; + deleteControl(args: DeleteControlCommandInput, cb: (err: any, data?: DeleteControlCommandOutput) => void): void; + deleteControl( args: DeleteControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteControlCommandOutput) => void ): void; - public deleteControl( - args: DeleteControlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteControlCommandOutput) => void), - cb?: (err: any, data?: DeleteControlCommandOutput) => void - ): Promise | void { - const command = new DeleteControlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deregisters an account in Audit Manager.

- * - *

Before you deregister, you can use the UpdateSettings API operation to set your preferred data retention policy. By - * default, Audit Manager retains your data. If you want to delete your data, you can - * use the DeregistrationPolicy attribute to request the deletion of your - * data.

- *

For more information about data retention, see Data - * Protection in the Audit Manager User Guide. - *

- *
+ * @see {@link DeregisterAccountCommand} */ - public deregisterAccount( + deregisterAccount( args: DeregisterAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterAccount( + deregisterAccount( args: DeregisterAccountCommandInput, cb: (err: any, data?: DeregisterAccountCommandOutput) => void ): void; - public deregisterAccount( + deregisterAccount( args: DeregisterAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterAccountCommandOutput) => void ): void; - public deregisterAccount( - args: DeregisterAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterAccountCommandOutput) => void), - cb?: (err: any, data?: DeregisterAccountCommandOutput) => void - ): Promise | void { - const command = new DeregisterAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified Amazon Web Services account as a delegated administrator for - * Audit Manager.

- *

When you remove a delegated administrator from your Audit Manager settings, you - * continue to have access to the evidence that you previously collected under that account. - * This is also the case when you deregister a delegated administrator from Organizations. However, Audit Manager stops collecting and attaching evidence to - * that delegated administrator account moving forward.

- * - *

Keep in mind the following cleanup task if you use evidence finder:

- *

Before you use your management account to remove a delegated administrator, make sure - * that the current delegated administrator account signs in to Audit Manager and - * disables evidence finder first. Disabling evidence finder automatically deletes the - * event data store that was created in their account when they enabled evidence finder. If - * this task isn’t completed, the event data store remains in their account. In this case, - * we recommend that the original delegated administrator goes to CloudTrail Lake - * and manually deletes the - * event data store.

- *

This cleanup task is necessary to ensure that you don't end up with multiple event - * data stores. Audit Manager ignores an unused event data store after you remove or - * change a delegated administrator account. However, the unused event data store continues - * to incur storage costs from CloudTrail Lake if you don't delete it.

- *
- *

When you deregister a delegated administrator account for Audit Manager, the data - * for that account isn’t deleted. If you want to delete resource data for a delegated - * administrator account, you must perform that task separately before you deregister the - * account. Either, you can do this in the Audit Manager console. Or, you can use one of - * the delete API operations that are provided by Audit Manager.

- *

To delete your Audit Manager resource data, see the following instructions:

- * - *

At this time, Audit Manager doesn't provide an option to delete evidence for a - * specific delegated administrator. Instead, when your management account deregisters Audit Manager, we perform a cleanup for the current delegated administrator account at the - * time of deregistration.

+ * @see {@link DeregisterOrganizationAdminAccountCommand} */ - public deregisterOrganizationAdminAccount( + deregisterOrganizationAdminAccount( args: DeregisterOrganizationAdminAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterOrganizationAdminAccount( + deregisterOrganizationAdminAccount( args: DeregisterOrganizationAdminAccountCommandInput, cb: (err: any, data?: DeregisterOrganizationAdminAccountCommandOutput) => void ): void; - public deregisterOrganizationAdminAccount( + deregisterOrganizationAdminAccount( args: DeregisterOrganizationAdminAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterOrganizationAdminAccountCommandOutput) => void ): void; - public deregisterOrganizationAdminAccount( - args: DeregisterOrganizationAdminAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterOrganizationAdminAccountCommandOutput) => void), - cb?: (err: any, data?: DeregisterOrganizationAdminAccountCommandOutput) => void - ): Promise | void { - const command = new DeregisterOrganizationAdminAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates an evidence folder from the specified assessment report in Audit Manager.

+ * @see {@link DisassociateAssessmentReportEvidenceFolderCommand} */ - public disassociateAssessmentReportEvidenceFolder( + disassociateAssessmentReportEvidenceFolder( args: DisassociateAssessmentReportEvidenceFolderCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateAssessmentReportEvidenceFolder( + disassociateAssessmentReportEvidenceFolder( args: DisassociateAssessmentReportEvidenceFolderCommandInput, cb: (err: any, data?: DisassociateAssessmentReportEvidenceFolderCommandOutput) => void ): void; - public disassociateAssessmentReportEvidenceFolder( + disassociateAssessmentReportEvidenceFolder( args: DisassociateAssessmentReportEvidenceFolderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateAssessmentReportEvidenceFolderCommandOutput) => void ): void; - public disassociateAssessmentReportEvidenceFolder( - args: DisassociateAssessmentReportEvidenceFolderCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociateAssessmentReportEvidenceFolderCommandOutput) => void), - cb?: (err: any, data?: DisassociateAssessmentReportEvidenceFolderCommandOutput) => void - ): Promise | void { - const command = new DisassociateAssessmentReportEvidenceFolderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the registration status of an account in Audit Manager.

+ * @see {@link GetAccountStatusCommand} */ - public getAccountStatus( + getAccountStatus( args: GetAccountStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccountStatus( + getAccountStatus( args: GetAccountStatusCommandInput, cb: (err: any, data?: GetAccountStatusCommandOutput) => void ): void; - public getAccountStatus( + getAccountStatus( args: GetAccountStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountStatusCommandOutput) => void ): void; - public getAccountStatus( - args: GetAccountStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccountStatusCommandOutput) => void), - cb?: (err: any, data?: GetAccountStatusCommandOutput) => void - ): Promise | void { - const command = new GetAccountStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an assessment from Audit Manager.

+ * @see {@link GetAssessmentCommand} */ - public getAssessment( - args: GetAssessmentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getAssessment( - args: GetAssessmentCommandInput, - cb: (err: any, data?: GetAssessmentCommandOutput) => void - ): void; - public getAssessment( + getAssessment(args: GetAssessmentCommandInput, options?: __HttpHandlerOptions): Promise; + getAssessment(args: GetAssessmentCommandInput, cb: (err: any, data?: GetAssessmentCommandOutput) => void): void; + getAssessment( args: GetAssessmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAssessmentCommandOutput) => void ): void; - public getAssessment( - args: GetAssessmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAssessmentCommandOutput) => void), - cb?: (err: any, data?: GetAssessmentCommandOutput) => void - ): Promise | void { - const command = new GetAssessmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a framework from Audit Manager.

+ * @see {@link GetAssessmentFrameworkCommand} */ - public getAssessmentFramework( + getAssessmentFramework( args: GetAssessmentFrameworkCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAssessmentFramework( + getAssessmentFramework( args: GetAssessmentFrameworkCommandInput, cb: (err: any, data?: GetAssessmentFrameworkCommandOutput) => void ): void; - public getAssessmentFramework( + getAssessmentFramework( args: GetAssessmentFrameworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAssessmentFrameworkCommandOutput) => void ): void; - public getAssessmentFramework( - args: GetAssessmentFrameworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAssessmentFrameworkCommandOutput) => void), - cb?: (err: any, data?: GetAssessmentFrameworkCommandOutput) => void - ): Promise | void { - const command = new GetAssessmentFrameworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the URL of an assessment report in Audit Manager.

+ * @see {@link GetAssessmentReportUrlCommand} */ - public getAssessmentReportUrl( + getAssessmentReportUrl( args: GetAssessmentReportUrlCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAssessmentReportUrl( + getAssessmentReportUrl( args: GetAssessmentReportUrlCommandInput, cb: (err: any, data?: GetAssessmentReportUrlCommandOutput) => void ): void; - public getAssessmentReportUrl( + getAssessmentReportUrl( args: GetAssessmentReportUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAssessmentReportUrlCommandOutput) => void ): void; - public getAssessmentReportUrl( - args: GetAssessmentReportUrlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAssessmentReportUrlCommandOutput) => void), - cb?: (err: any, data?: GetAssessmentReportUrlCommandOutput) => void - ): Promise | void { - const command = new GetAssessmentReportUrlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of changelogs from Audit Manager.

+ * @see {@link GetChangeLogsCommand} */ - public getChangeLogs( - args: GetChangeLogsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getChangeLogs( - args: GetChangeLogsCommandInput, - cb: (err: any, data?: GetChangeLogsCommandOutput) => void - ): void; - public getChangeLogs( + getChangeLogs(args: GetChangeLogsCommandInput, options?: __HttpHandlerOptions): Promise; + getChangeLogs(args: GetChangeLogsCommandInput, cb: (err: any, data?: GetChangeLogsCommandOutput) => void): void; + getChangeLogs( args: GetChangeLogsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChangeLogsCommandOutput) => void ): void; - public getChangeLogs( - args: GetChangeLogsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetChangeLogsCommandOutput) => void), - cb?: (err: any, data?: GetChangeLogsCommandOutput) => void - ): Promise | void { - const command = new GetChangeLogsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a control from Audit Manager.

+ * @see {@link GetControlCommand} */ - public getControl(args: GetControlCommandInput, options?: __HttpHandlerOptions): Promise; - public getControl(args: GetControlCommandInput, cb: (err: any, data?: GetControlCommandOutput) => void): void; - public getControl( + getControl(args: GetControlCommandInput, options?: __HttpHandlerOptions): Promise; + getControl(args: GetControlCommandInput, cb: (err: any, data?: GetControlCommandOutput) => void): void; + getControl( args: GetControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetControlCommandOutput) => void ): void; - public getControl( - args: GetControlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetControlCommandOutput) => void), - cb?: (err: any, data?: GetControlCommandOutput) => void - ): Promise | void { - const command = new GetControlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of delegations from an audit owner to a delegate.

+ * @see {@link GetDelegationsCommand} */ - public getDelegations( + getDelegations( args: GetDelegationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDelegations( - args: GetDelegationsCommandInput, - cb: (err: any, data?: GetDelegationsCommandOutput) => void - ): void; - public getDelegations( + getDelegations(args: GetDelegationsCommandInput, cb: (err: any, data?: GetDelegationsCommandOutput) => void): void; + getDelegations( args: GetDelegationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDelegationsCommandOutput) => void ): void; - public getDelegations( - args: GetDelegationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDelegationsCommandOutput) => void), - cb?: (err: any, data?: GetDelegationsCommandOutput) => void - ): Promise | void { - const command = new GetDelegationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns evidence from Audit Manager.

+ * @see {@link GetEvidenceCommand} */ - public getEvidence(args: GetEvidenceCommandInput, options?: __HttpHandlerOptions): Promise; - public getEvidence(args: GetEvidenceCommandInput, cb: (err: any, data?: GetEvidenceCommandOutput) => void): void; - public getEvidence( + getEvidence(args: GetEvidenceCommandInput, options?: __HttpHandlerOptions): Promise; + getEvidence(args: GetEvidenceCommandInput, cb: (err: any, data?: GetEvidenceCommandOutput) => void): void; + getEvidence( args: GetEvidenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEvidenceCommandOutput) => void ): void; - public getEvidence( - args: GetEvidenceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEvidenceCommandOutput) => void), - cb?: (err: any, data?: GetEvidenceCommandOutput) => void - ): Promise | void { - const command = new GetEvidenceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns all evidence from a specified evidence folder in Audit Manager.

+ * @see {@link GetEvidenceByEvidenceFolderCommand} */ - public getEvidenceByEvidenceFolder( + getEvidenceByEvidenceFolder( args: GetEvidenceByEvidenceFolderCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEvidenceByEvidenceFolder( + getEvidenceByEvidenceFolder( args: GetEvidenceByEvidenceFolderCommandInput, cb: (err: any, data?: GetEvidenceByEvidenceFolderCommandOutput) => void ): void; - public getEvidenceByEvidenceFolder( + getEvidenceByEvidenceFolder( args: GetEvidenceByEvidenceFolderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEvidenceByEvidenceFolderCommandOutput) => void ): void; - public getEvidenceByEvidenceFolder( - args: GetEvidenceByEvidenceFolderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEvidenceByEvidenceFolderCommandOutput) => void), - cb?: (err: any, data?: GetEvidenceByEvidenceFolderCommandOutput) => void - ): Promise | void { - const command = new GetEvidenceByEvidenceFolderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an evidence folder from the specified assessment in Audit Manager. - *

+ * @see {@link GetEvidenceFolderCommand} */ - public getEvidenceFolder( + getEvidenceFolder( args: GetEvidenceFolderCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEvidenceFolder( + getEvidenceFolder( args: GetEvidenceFolderCommandInput, cb: (err: any, data?: GetEvidenceFolderCommandOutput) => void ): void; - public getEvidenceFolder( + getEvidenceFolder( args: GetEvidenceFolderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEvidenceFolderCommandOutput) => void ): void; - public getEvidenceFolder( - args: GetEvidenceFolderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEvidenceFolderCommandOutput) => void), - cb?: (err: any, data?: GetEvidenceFolderCommandOutput) => void - ): Promise | void { - const command = new GetEvidenceFolderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the evidence folders from a specified assessment in Audit Manager. - *

+ * @see {@link GetEvidenceFoldersByAssessmentCommand} */ - public getEvidenceFoldersByAssessment( + getEvidenceFoldersByAssessment( args: GetEvidenceFoldersByAssessmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEvidenceFoldersByAssessment( + getEvidenceFoldersByAssessment( args: GetEvidenceFoldersByAssessmentCommandInput, cb: (err: any, data?: GetEvidenceFoldersByAssessmentCommandOutput) => void ): void; - public getEvidenceFoldersByAssessment( + getEvidenceFoldersByAssessment( args: GetEvidenceFoldersByAssessmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEvidenceFoldersByAssessmentCommandOutput) => void ): void; - public getEvidenceFoldersByAssessment( - args: GetEvidenceFoldersByAssessmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEvidenceFoldersByAssessmentCommandOutput) => void), - cb?: (err: any, data?: GetEvidenceFoldersByAssessmentCommandOutput) => void - ): Promise | void { - const command = new GetEvidenceFoldersByAssessmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of evidence folders that are associated with a specified control in an - * Audit Manager assessment.

+ * @see {@link GetEvidenceFoldersByAssessmentControlCommand} */ - public getEvidenceFoldersByAssessmentControl( + getEvidenceFoldersByAssessmentControl( args: GetEvidenceFoldersByAssessmentControlCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEvidenceFoldersByAssessmentControl( + getEvidenceFoldersByAssessmentControl( args: GetEvidenceFoldersByAssessmentControlCommandInput, cb: (err: any, data?: GetEvidenceFoldersByAssessmentControlCommandOutput) => void ): void; - public getEvidenceFoldersByAssessmentControl( + getEvidenceFoldersByAssessmentControl( args: GetEvidenceFoldersByAssessmentControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEvidenceFoldersByAssessmentControlCommandOutput) => void ): void; - public getEvidenceFoldersByAssessmentControl( - args: GetEvidenceFoldersByAssessmentControlCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetEvidenceFoldersByAssessmentControlCommandOutput) => void), - cb?: (err: any, data?: GetEvidenceFoldersByAssessmentControlCommandOutput) => void - ): Promise | void { - const command = new GetEvidenceFoldersByAssessmentControlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the latest analytics data for all your current active assessments.

+ * @see {@link GetInsightsCommand} */ - public getInsights(args: GetInsightsCommandInput, options?: __HttpHandlerOptions): Promise; - public getInsights(args: GetInsightsCommandInput, cb: (err: any, data?: GetInsightsCommandOutput) => void): void; - public getInsights( + getInsights(args: GetInsightsCommandInput, options?: __HttpHandlerOptions): Promise; + getInsights(args: GetInsightsCommandInput, cb: (err: any, data?: GetInsightsCommandOutput) => void): void; + getInsights( args: GetInsightsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInsightsCommandOutput) => void ): void; - public getInsights( - args: GetInsightsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInsightsCommandOutput) => void), - cb?: (err: any, data?: GetInsightsCommandOutput) => void - ): Promise | void { - const command = new GetInsightsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the latest analytics data for a specific active assessment.

+ * @see {@link GetInsightsByAssessmentCommand} */ - public getInsightsByAssessment( + getInsightsByAssessment( args: GetInsightsByAssessmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInsightsByAssessment( + getInsightsByAssessment( args: GetInsightsByAssessmentCommandInput, cb: (err: any, data?: GetInsightsByAssessmentCommandOutput) => void ): void; - public getInsightsByAssessment( + getInsightsByAssessment( args: GetInsightsByAssessmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInsightsByAssessmentCommandOutput) => void ): void; - public getInsightsByAssessment( - args: GetInsightsByAssessmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInsightsByAssessmentCommandOutput) => void), - cb?: (err: any, data?: GetInsightsByAssessmentCommandOutput) => void - ): Promise | void { - const command = new GetInsightsByAssessmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the name of the delegated Amazon Web Services administrator account for the - * organization.

+ * @see {@link GetOrganizationAdminAccountCommand} */ - public getOrganizationAdminAccount( + getOrganizationAdminAccount( args: GetOrganizationAdminAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public getOrganizationAdminAccount( + getOrganizationAdminAccount( args: GetOrganizationAdminAccountCommandInput, cb: (err: any, data?: GetOrganizationAdminAccountCommandOutput) => void ): void; - public getOrganizationAdminAccount( + getOrganizationAdminAccount( args: GetOrganizationAdminAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOrganizationAdminAccountCommandOutput) => void ): void; - public getOrganizationAdminAccount( - args: GetOrganizationAdminAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOrganizationAdminAccountCommandOutput) => void), - cb?: (err: any, data?: GetOrganizationAdminAccountCommandOutput) => void - ): Promise | void { - const command = new GetOrganizationAdminAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all of the Amazon Web Services that you can choose to include - * in your assessment. When you create an assessment, specify which of these services you want to include to - * narrow the assessment's scope.

+ * @see {@link GetServicesInScopeCommand} */ - public getServicesInScope( + getServicesInScope( args: GetServicesInScopeCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServicesInScope( + getServicesInScope( args: GetServicesInScopeCommandInput, cb: (err: any, data?: GetServicesInScopeCommandOutput) => void ): void; - public getServicesInScope( + getServicesInScope( args: GetServicesInScopeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServicesInScopeCommandOutput) => void ): void; - public getServicesInScope( - args: GetServicesInScopeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServicesInScopeCommandOutput) => void), - cb?: (err: any, data?: GetServicesInScopeCommandOutput) => void - ): Promise | void { - const command = new GetServicesInScopeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the settings for the specified Amazon Web Services account.

+ * @see {@link GetSettingsCommand} */ - public getSettings(args: GetSettingsCommandInput, options?: __HttpHandlerOptions): Promise; - public getSettings(args: GetSettingsCommandInput, cb: (err: any, data?: GetSettingsCommandOutput) => void): void; - public getSettings( + getSettings(args: GetSettingsCommandInput, options?: __HttpHandlerOptions): Promise; + getSettings(args: GetSettingsCommandInput, cb: (err: any, data?: GetSettingsCommandOutput) => void): void; + getSettings( args: GetSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSettingsCommandOutput) => void ): void; - public getSettings( - args: GetSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSettingsCommandOutput) => void), - cb?: (err: any, data?: GetSettingsCommandOutput) => void - ): Promise | void { - const command = new GetSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the latest analytics data for controls within a specific control domain and a - * specific active assessment.

- * - *

Control insights are listed only if the control belongs to the control domain and - * assessment that was specified. Moreover, the control must have collected evidence on the - * lastUpdated date of controlInsightsByAssessment. If neither - * of these conditions are met, no data is listed for that control.

- *
+ * @see {@link ListAssessmentControlInsightsByControlDomainCommand} */ - public listAssessmentControlInsightsByControlDomain( + listAssessmentControlInsightsByControlDomain( args: ListAssessmentControlInsightsByControlDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssessmentControlInsightsByControlDomain( + listAssessmentControlInsightsByControlDomain( args: ListAssessmentControlInsightsByControlDomainCommandInput, cb: (err: any, data?: ListAssessmentControlInsightsByControlDomainCommandOutput) => void ): void; - public listAssessmentControlInsightsByControlDomain( + listAssessmentControlInsightsByControlDomain( args: ListAssessmentControlInsightsByControlDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssessmentControlInsightsByControlDomainCommandOutput) => void ): void; - public listAssessmentControlInsightsByControlDomain( - args: ListAssessmentControlInsightsByControlDomainCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListAssessmentControlInsightsByControlDomainCommandOutput) => void), - cb?: (err: any, data?: ListAssessmentControlInsightsByControlDomainCommandOutput) => void - ): Promise | void { - const command = new ListAssessmentControlInsightsByControlDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the frameworks that are available in the Audit Manager framework - * library.

+ * @see {@link ListAssessmentFrameworksCommand} */ - public listAssessmentFrameworks( + listAssessmentFrameworks( args: ListAssessmentFrameworksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssessmentFrameworks( + listAssessmentFrameworks( args: ListAssessmentFrameworksCommandInput, cb: (err: any, data?: ListAssessmentFrameworksCommandOutput) => void ): void; - public listAssessmentFrameworks( + listAssessmentFrameworks( args: ListAssessmentFrameworksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssessmentFrameworksCommandOutput) => void ): void; - public listAssessmentFrameworks( - args: ListAssessmentFrameworksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssessmentFrameworksCommandOutput) => void), - cb?: (err: any, data?: ListAssessmentFrameworksCommandOutput) => void - ): Promise | void { - const command = new ListAssessmentFrameworksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of sent or received share requests for custom frameworks in Audit Manager.

+ * @see {@link ListAssessmentFrameworkShareRequestsCommand} */ - public listAssessmentFrameworkShareRequests( + listAssessmentFrameworkShareRequests( args: ListAssessmentFrameworkShareRequestsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssessmentFrameworkShareRequests( + listAssessmentFrameworkShareRequests( args: ListAssessmentFrameworkShareRequestsCommandInput, cb: (err: any, data?: ListAssessmentFrameworkShareRequestsCommandOutput) => void ): void; - public listAssessmentFrameworkShareRequests( + listAssessmentFrameworkShareRequests( args: ListAssessmentFrameworkShareRequestsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssessmentFrameworkShareRequestsCommandOutput) => void ): void; - public listAssessmentFrameworkShareRequests( - args: ListAssessmentFrameworkShareRequestsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssessmentFrameworkShareRequestsCommandOutput) => void), - cb?: (err: any, data?: ListAssessmentFrameworkShareRequestsCommandOutput) => void - ): Promise | void { - const command = new ListAssessmentFrameworkShareRequestsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of assessment reports created in Audit Manager.

+ * @see {@link ListAssessmentReportsCommand} */ - public listAssessmentReports( + listAssessmentReports( args: ListAssessmentReportsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssessmentReports( + listAssessmentReports( args: ListAssessmentReportsCommandInput, cb: (err: any, data?: ListAssessmentReportsCommandOutput) => void ): void; - public listAssessmentReports( + listAssessmentReports( args: ListAssessmentReportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssessmentReportsCommandOutput) => void ): void; - public listAssessmentReports( - args: ListAssessmentReportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssessmentReportsCommandOutput) => void), - cb?: (err: any, data?: ListAssessmentReportsCommandOutput) => void - ): Promise | void { - const command = new ListAssessmentReportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of current and past assessments from Audit Manager.

+ * @see {@link ListAssessmentsCommand} */ - public listAssessments( + listAssessments( args: ListAssessmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssessments( - args: ListAssessmentsCommandInput, - cb: (err: any, data?: ListAssessmentsCommandOutput) => void - ): void; - public listAssessments( + listAssessments(args: ListAssessmentsCommandInput, cb: (err: any, data?: ListAssessmentsCommandOutput) => void): void; + listAssessments( args: ListAssessmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssessmentsCommandOutput) => void ): void; - public listAssessments( - args: ListAssessmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssessmentsCommandOutput) => void), - cb?: (err: any, data?: ListAssessmentsCommandOutput) => void - ): Promise | void { - const command = new ListAssessmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the latest analytics data for control domains across all of your active - * assessments.

- * - *

A control domain is listed only if at least one of the controls within that domain - * collected evidence on the lastUpdated date of - * controlDomainInsights. If this condition isn’t met, no data is listed - * for that control domain.

- *
+ * @see {@link ListControlDomainInsightsCommand} */ - public listControlDomainInsights( + listControlDomainInsights( args: ListControlDomainInsightsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listControlDomainInsights( + listControlDomainInsights( args: ListControlDomainInsightsCommandInput, cb: (err: any, data?: ListControlDomainInsightsCommandOutput) => void ): void; - public listControlDomainInsights( + listControlDomainInsights( args: ListControlDomainInsightsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListControlDomainInsightsCommandOutput) => void ): void; - public listControlDomainInsights( - args: ListControlDomainInsightsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListControlDomainInsightsCommandOutput) => void), - cb?: (err: any, data?: ListControlDomainInsightsCommandOutput) => void - ): Promise | void { - const command = new ListControlDomainInsightsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists analytics data for control domains within a specified active assessment.

- * - *

A control domain is listed only if at least one of the controls within that domain - * collected evidence on the lastUpdated date of - * controlDomainInsights. If this condition isn’t met, no data is listed - * for that domain.

- *
+ * @see {@link ListControlDomainInsightsByAssessmentCommand} */ - public listControlDomainInsightsByAssessment( + listControlDomainInsightsByAssessment( args: ListControlDomainInsightsByAssessmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public listControlDomainInsightsByAssessment( + listControlDomainInsightsByAssessment( args: ListControlDomainInsightsByAssessmentCommandInput, cb: (err: any, data?: ListControlDomainInsightsByAssessmentCommandOutput) => void ): void; - public listControlDomainInsightsByAssessment( + listControlDomainInsightsByAssessment( args: ListControlDomainInsightsByAssessmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListControlDomainInsightsByAssessmentCommandOutput) => void ): void; - public listControlDomainInsightsByAssessment( - args: ListControlDomainInsightsByAssessmentCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListControlDomainInsightsByAssessmentCommandOutput) => void), - cb?: (err: any, data?: ListControlDomainInsightsByAssessmentCommandOutput) => void - ): Promise | void { - const command = new ListControlDomainInsightsByAssessmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the latest analytics data for controls within a specific control domain across all - * active assessments.

- * - *

Control insights are listed only if the control belongs to the control domain that - * was specified and the control collected evidence on the lastUpdated date of - * controlInsightsMetadata. If neither of these conditions are met, no data - * is listed for that control.

- *
+ * @see {@link ListControlInsightsByControlDomainCommand} */ - public listControlInsightsByControlDomain( + listControlInsightsByControlDomain( args: ListControlInsightsByControlDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public listControlInsightsByControlDomain( + listControlInsightsByControlDomain( args: ListControlInsightsByControlDomainCommandInput, cb: (err: any, data?: ListControlInsightsByControlDomainCommandOutput) => void ): void; - public listControlInsightsByControlDomain( + listControlInsightsByControlDomain( args: ListControlInsightsByControlDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListControlInsightsByControlDomainCommandOutput) => void ): void; - public listControlInsightsByControlDomain( - args: ListControlInsightsByControlDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListControlInsightsByControlDomainCommandOutput) => void), - cb?: (err: any, data?: ListControlInsightsByControlDomainCommandOutput) => void - ): Promise | void { - const command = new ListControlInsightsByControlDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of controls from Audit Manager.

+ * @see {@link ListControlsCommand} */ - public listControls( - args: ListControlsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listControls(args: ListControlsCommandInput, cb: (err: any, data?: ListControlsCommandOutput) => void): void; - public listControls( + listControls(args: ListControlsCommandInput, options?: __HttpHandlerOptions): Promise; + listControls(args: ListControlsCommandInput, cb: (err: any, data?: ListControlsCommandOutput) => void): void; + listControls( args: ListControlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListControlsCommandOutput) => void ): void; - public listControls( - args: ListControlsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListControlsCommandOutput) => void), - cb?: (err: any, data?: ListControlsCommandOutput) => void - ): Promise | void { - const command = new ListControlsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of keywords that are pre-mapped to the specified control data source. - *

+ * @see {@link ListKeywordsForDataSourceCommand} */ - public listKeywordsForDataSource( + listKeywordsForDataSource( args: ListKeywordsForDataSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listKeywordsForDataSource( + listKeywordsForDataSource( args: ListKeywordsForDataSourceCommandInput, cb: (err: any, data?: ListKeywordsForDataSourceCommandOutput) => void ): void; - public listKeywordsForDataSource( + listKeywordsForDataSource( args: ListKeywordsForDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKeywordsForDataSourceCommandOutput) => void ): void; - public listKeywordsForDataSource( - args: ListKeywordsForDataSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListKeywordsForDataSourceCommandOutput) => void), - cb?: (err: any, data?: ListKeywordsForDataSourceCommandOutput) => void - ): Promise | void { - const command = new ListKeywordsForDataSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all Audit Manager notifications.

+ * @see {@link ListNotificationsCommand} */ - public listNotifications( + listNotifications( args: ListNotificationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listNotifications( + listNotifications( args: ListNotificationsCommandInput, cb: (err: any, data?: ListNotificationsCommandOutput) => void ): void; - public listNotifications( + listNotifications( args: ListNotificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNotificationsCommandOutput) => void ): void; - public listNotifications( - args: ListNotificationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNotificationsCommandOutput) => void), - cb?: (err: any, data?: ListNotificationsCommandOutput) => void - ): Promise | void { - const command = new ListNotificationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of tags for the specified resource in Audit Manager.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables Audit Manager for the specified Amazon Web Services account.

+ * @see {@link RegisterAccountCommand} */ - public registerAccount( + registerAccount( args: RegisterAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerAccount( - args: RegisterAccountCommandInput, - cb: (err: any, data?: RegisterAccountCommandOutput) => void - ): void; - public registerAccount( + registerAccount(args: RegisterAccountCommandInput, cb: (err: any, data?: RegisterAccountCommandOutput) => void): void; + registerAccount( args: RegisterAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterAccountCommandOutput) => void ): void; - public registerAccount( - args: RegisterAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterAccountCommandOutput) => void), - cb?: (err: any, data?: RegisterAccountCommandOutput) => void - ): Promise | void { - const command = new RegisterAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables an Amazon Web Services account within the organization as the delegated - * administrator for Audit Manager.

+ * @see {@link RegisterOrganizationAdminAccountCommand} */ - public registerOrganizationAdminAccount( + registerOrganizationAdminAccount( args: RegisterOrganizationAdminAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerOrganizationAdminAccount( + registerOrganizationAdminAccount( args: RegisterOrganizationAdminAccountCommandInput, cb: (err: any, data?: RegisterOrganizationAdminAccountCommandOutput) => void ): void; - public registerOrganizationAdminAccount( + registerOrganizationAdminAccount( args: RegisterOrganizationAdminAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterOrganizationAdminAccountCommandOutput) => void ): void; - public registerOrganizationAdminAccount( - args: RegisterOrganizationAdminAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterOrganizationAdminAccountCommandOutput) => void), - cb?: (err: any, data?: RegisterOrganizationAdminAccountCommandOutput) => void - ): Promise | void { - const command = new RegisterOrganizationAdminAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a share request for a custom framework in Audit Manager.

- *

The share request specifies a recipient and notifies them that a custom framework is - * available. Recipients have 120 days to accept or decline the request. If no action is - * taken, the share request expires.

- *

When you create a share request, Audit Manager stores a snapshot of your custom - * framework in the US East (N. Virginia) Amazon Web Services Region. Audit Manager also - * stores a backup of the same snapshot in the US West (Oregon) Amazon Web Services Region.

- *

Audit Manager deletes the snapshot and the backup snapshot when one of the following - * events occurs:

- *
    - *
  • - *

    The sender revokes the share request.

    - *
  • - *
  • - *

    The recipient declines the share request.

    - *
  • - *
  • - *

    The recipient encounters an error and doesn't successfully accept the share - * request.

    - *
  • - *
  • - *

    The share request expires before the recipient responds to the request.

    - *
  • - *
- *

When a sender resends a share request, the snapshot is replaced with an updated version that - * corresponds with the latest version of the custom framework.

- *

When a recipient accepts a share request, the snapshot is replicated into their Amazon Web Services account under the Amazon Web Services Region that was specified in the share - * request.

- * - *

When you invoke the StartAssessmentFrameworkShare API, you are about to - * share a custom framework with another Amazon Web Services account. You may not share a - * custom framework that is derived from a standard framework if the standard framework is - * designated as not eligible for sharing by Amazon Web Services, unless you have obtained - * permission to do so from the owner of the standard framework. To learn more about which - * standard frameworks are eligible for sharing, see Framework sharing eligibility in the Audit Manager User - * Guide.

- *
+ * @see {@link StartAssessmentFrameworkShareCommand} */ - public startAssessmentFrameworkShare( + startAssessmentFrameworkShare( args: StartAssessmentFrameworkShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public startAssessmentFrameworkShare( + startAssessmentFrameworkShare( args: StartAssessmentFrameworkShareCommandInput, cb: (err: any, data?: StartAssessmentFrameworkShareCommandOutput) => void ): void; - public startAssessmentFrameworkShare( + startAssessmentFrameworkShare( args: StartAssessmentFrameworkShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartAssessmentFrameworkShareCommandOutput) => void ): void; - public startAssessmentFrameworkShare( - args: StartAssessmentFrameworkShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartAssessmentFrameworkShareCommandOutput) => void), - cb?: (err: any, data?: StartAssessmentFrameworkShareCommandOutput) => void - ): Promise | void { - const command = new StartAssessmentFrameworkShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Tags the specified resource in Audit Manager.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a tag from a resource in Audit Manager.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Edits an Audit Manager assessment.

+ * @see {@link UpdateAssessmentCommand} */ - public updateAssessment( + updateAssessment( args: UpdateAssessmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAssessment( + updateAssessment( args: UpdateAssessmentCommandInput, cb: (err: any, data?: UpdateAssessmentCommandOutput) => void ): void; - public updateAssessment( + updateAssessment( args: UpdateAssessmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAssessmentCommandOutput) => void ): void; - public updateAssessment( - args: UpdateAssessmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAssessmentCommandOutput) => void), - cb?: (err: any, data?: UpdateAssessmentCommandOutput) => void - ): Promise | void { - const command = new UpdateAssessmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a control within an assessment in Audit Manager.

+ * @see {@link UpdateAssessmentControlCommand} */ - public updateAssessmentControl( + updateAssessmentControl( args: UpdateAssessmentControlCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAssessmentControl( + updateAssessmentControl( args: UpdateAssessmentControlCommandInput, cb: (err: any, data?: UpdateAssessmentControlCommandOutput) => void ): void; - public updateAssessmentControl( + updateAssessmentControl( args: UpdateAssessmentControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAssessmentControlCommandOutput) => void ): void; - public updateAssessmentControl( - args: UpdateAssessmentControlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAssessmentControlCommandOutput) => void), - cb?: (err: any, data?: UpdateAssessmentControlCommandOutput) => void - ): Promise | void { - const command = new UpdateAssessmentControlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the status of a control set in an Audit Manager assessment.

+ * @see {@link UpdateAssessmentControlSetStatusCommand} */ - public updateAssessmentControlSetStatus( + updateAssessmentControlSetStatus( args: UpdateAssessmentControlSetStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAssessmentControlSetStatus( + updateAssessmentControlSetStatus( args: UpdateAssessmentControlSetStatusCommandInput, cb: (err: any, data?: UpdateAssessmentControlSetStatusCommandOutput) => void ): void; - public updateAssessmentControlSetStatus( + updateAssessmentControlSetStatus( args: UpdateAssessmentControlSetStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAssessmentControlSetStatusCommandOutput) => void ): void; - public updateAssessmentControlSetStatus( - args: UpdateAssessmentControlSetStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAssessmentControlSetStatusCommandOutput) => void), - cb?: (err: any, data?: UpdateAssessmentControlSetStatusCommandOutput) => void - ): Promise | void { - const command = new UpdateAssessmentControlSetStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a custom framework in Audit Manager.

+ * @see {@link UpdateAssessmentFrameworkCommand} */ - public updateAssessmentFramework( + updateAssessmentFramework( args: UpdateAssessmentFrameworkCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAssessmentFramework( + updateAssessmentFramework( args: UpdateAssessmentFrameworkCommandInput, cb: (err: any, data?: UpdateAssessmentFrameworkCommandOutput) => void ): void; - public updateAssessmentFramework( + updateAssessmentFramework( args: UpdateAssessmentFrameworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAssessmentFrameworkCommandOutput) => void ): void; - public updateAssessmentFramework( - args: UpdateAssessmentFrameworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAssessmentFrameworkCommandOutput) => void), - cb?: (err: any, data?: UpdateAssessmentFrameworkCommandOutput) => void - ): Promise | void { - const command = new UpdateAssessmentFrameworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a share request for a custom framework in Audit Manager.

+ * @see {@link UpdateAssessmentFrameworkShareCommand} */ - public updateAssessmentFrameworkShare( + updateAssessmentFrameworkShare( args: UpdateAssessmentFrameworkShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAssessmentFrameworkShare( + updateAssessmentFrameworkShare( args: UpdateAssessmentFrameworkShareCommandInput, cb: (err: any, data?: UpdateAssessmentFrameworkShareCommandOutput) => void ): void; - public updateAssessmentFrameworkShare( + updateAssessmentFrameworkShare( args: UpdateAssessmentFrameworkShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAssessmentFrameworkShareCommandOutput) => void ): void; - public updateAssessmentFrameworkShare( - args: UpdateAssessmentFrameworkShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAssessmentFrameworkShareCommandOutput) => void), - cb?: (err: any, data?: UpdateAssessmentFrameworkShareCommandOutput) => void - ): Promise | void { - const command = new UpdateAssessmentFrameworkShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the status of an assessment in Audit Manager.

+ * @see {@link UpdateAssessmentStatusCommand} */ - public updateAssessmentStatus( + updateAssessmentStatus( args: UpdateAssessmentStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAssessmentStatus( + updateAssessmentStatus( args: UpdateAssessmentStatusCommandInput, cb: (err: any, data?: UpdateAssessmentStatusCommandOutput) => void ): void; - public updateAssessmentStatus( + updateAssessmentStatus( args: UpdateAssessmentStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAssessmentStatusCommandOutput) => void ): void; - public updateAssessmentStatus( - args: UpdateAssessmentStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAssessmentStatusCommandOutput) => void), - cb?: (err: any, data?: UpdateAssessmentStatusCommandOutput) => void - ): Promise | void { - const command = new UpdateAssessmentStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a custom control in Audit Manager.

+ * @see {@link UpdateControlCommand} */ - public updateControl( - args: UpdateControlCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateControl( - args: UpdateControlCommandInput, - cb: (err: any, data?: UpdateControlCommandOutput) => void - ): void; - public updateControl( + updateControl(args: UpdateControlCommandInput, options?: __HttpHandlerOptions): Promise; + updateControl(args: UpdateControlCommandInput, cb: (err: any, data?: UpdateControlCommandOutput) => void): void; + updateControl( args: UpdateControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateControlCommandOutput) => void ): void; - public updateControl( - args: UpdateControlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateControlCommandOutput) => void), - cb?: (err: any, data?: UpdateControlCommandOutput) => void - ): Promise | void { - const command = new UpdateControlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates Audit Manager settings for the current account.

+ * @see {@link UpdateSettingsCommand} */ - public updateSettings( + updateSettings( args: UpdateSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSettings( - args: UpdateSettingsCommandInput, - cb: (err: any, data?: UpdateSettingsCommandOutput) => void - ): void; - public updateSettings( + updateSettings(args: UpdateSettingsCommandInput, cb: (err: any, data?: UpdateSettingsCommandOutput) => void): void; + updateSettings( args: UpdateSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSettingsCommandOutput) => void ): void; - public updateSettings( - args: UpdateSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Validates the integrity of an assessment report in Audit Manager.

+ * @see {@link ValidateAssessmentReportIntegrityCommand} */ - public validateAssessmentReportIntegrity( + validateAssessmentReportIntegrity( args: ValidateAssessmentReportIntegrityCommandInput, options?: __HttpHandlerOptions ): Promise; - public validateAssessmentReportIntegrity( + validateAssessmentReportIntegrity( args: ValidateAssessmentReportIntegrityCommandInput, cb: (err: any, data?: ValidateAssessmentReportIntegrityCommandOutput) => void ): void; - public validateAssessmentReportIntegrity( + validateAssessmentReportIntegrity( args: ValidateAssessmentReportIntegrityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidateAssessmentReportIntegrityCommandOutput) => void ): void; - public validateAssessmentReportIntegrity( - args: ValidateAssessmentReportIntegrityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ValidateAssessmentReportIntegrityCommandOutput) => void), - cb?: (err: any, data?: ValidateAssessmentReportIntegrityCommandOutput) => void - ): Promise | void { - const command = new ValidateAssessmentReportIntegrityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Welcome to the Audit Manager API reference. This guide is for developers who + * need detailed information about the Audit Manager API operations, data types, and + * errors.

+ *

Audit Manager is a service that provides automated evidence collection so that you + * can continually audit your Amazon Web Services usage. You can use it to assess the + * effectiveness of your controls, manage risk, and simplify compliance.

+ *

Audit Manager provides prebuilt frameworks that structure and automate assessments + * for a given compliance standard. Frameworks include a prebuilt collection of controls with + * descriptions and testing procedures. These controls are grouped according to the + * requirements of the specified compliance standard or regulation. You can also customize + * frameworks and controls to support internal audits with specific requirements.

+ *

Use the following links to get started with the Audit Manager API:

+ *
    + *
  • + *

    + * Actions: An + * alphabetical list of all Audit Manager API operations.

    + *
  • + *
  • + *

    + * Data types: An alphabetical list of all Audit Manager data + * types.

    + *
  • + *
  • + *

    + * Common + * parameters: Parameters that all operations can use.

    + *
  • + *
  • + *

    + * Common errors: + * Client and server errors that all operations can return.

    + *
  • + *
+ *

If you're new to Audit Manager, we recommend that you review the + * Audit Manager User Guide.

+ */ +export class AuditManager extends AuditManagerClient implements AuditManager {} +createAggregatedClient(commands, AuditManager); diff --git a/clients/client-auto-scaling-plans/src/AutoScalingPlans.ts b/clients/client-auto-scaling-plans/src/AutoScalingPlans.ts index 4b12250d2df3..faa3db7df6aa 100644 --- a/clients/client-auto-scaling-plans/src/AutoScalingPlans.ts +++ b/clients/client-auto-scaling-plans/src/AutoScalingPlans.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { AutoScalingPlansClient } from "./AutoScalingPlansClient"; +import { AutoScalingPlansClient, AutoScalingPlansClientConfig } from "./AutoScalingPlansClient"; import { CreateScalingPlanCommand, CreateScalingPlanCommandInput, @@ -33,249 +34,156 @@ import { UpdateScalingPlanCommandOutput, } from "./commands/UpdateScalingPlanCommand"; -/** - * @public - * AWS Auto Scaling - * - * - *

Use AWS Auto Scaling to create scaling plans for your applications to - * automatically scale your scalable AWS resources.

- *

- * API Summary - *

- *

You can use the AWS Auto Scaling service API to accomplish the following tasks:

- *
    - *
  • - *

    Create and manage scaling plans

    - *
  • - *
  • - *

    Define target tracking scaling policies to dynamically scale your resources based - * on utilization

    - *
  • - *
  • - *

    Scale Amazon EC2 Auto Scaling groups using predictive scaling and dynamic scaling to scale your - * Amazon EC2 capacity faster

    - *
  • - *
  • - *

    Set minimum and maximum capacity limits

    - *
  • - *
  • - *

    Retrieve information on existing scaling plans

    - *
  • - *
  • - *

    Access current forecast data and historical forecast data for up to 56 days - * previous

    - *
  • - *
- * - *

To learn more about AWS Auto Scaling, including information about granting IAM users required - * permissions for AWS Auto Scaling actions, see the AWS Auto Scaling User Guide.

- */ -export class AutoScalingPlans extends AutoScalingPlansClient { +const commands = { + CreateScalingPlanCommand, + DeleteScalingPlanCommand, + DescribeScalingPlanResourcesCommand, + DescribeScalingPlansCommand, + GetScalingPlanResourceForecastDataCommand, + UpdateScalingPlanCommand, +}; + +export interface AutoScalingPlans { /** - * @public - *

Creates a scaling plan.

+ * @see {@link CreateScalingPlanCommand} */ - public createScalingPlan( + createScalingPlan( args: CreateScalingPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public createScalingPlan( + createScalingPlan( args: CreateScalingPlanCommandInput, cb: (err: any, data?: CreateScalingPlanCommandOutput) => void ): void; - public createScalingPlan( + createScalingPlan( args: CreateScalingPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateScalingPlanCommandOutput) => void ): void; - public createScalingPlan( - args: CreateScalingPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateScalingPlanCommandOutput) => void), - cb?: (err: any, data?: CreateScalingPlanCommandOutput) => void - ): Promise | void { - const command = new CreateScalingPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified scaling plan.

- *

Deleting a scaling plan deletes the underlying ScalingInstruction for - * all of the scalable resources that are covered by the plan.

- *

If the plan has launched resources or has scaling activities in progress, you must - * delete those resources separately.

+ * @see {@link DeleteScalingPlanCommand} */ - public deleteScalingPlan( + deleteScalingPlan( args: DeleteScalingPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteScalingPlan( + deleteScalingPlan( args: DeleteScalingPlanCommandInput, cb: (err: any, data?: DeleteScalingPlanCommandOutput) => void ): void; - public deleteScalingPlan( + deleteScalingPlan( args: DeleteScalingPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteScalingPlanCommandOutput) => void ): void; - public deleteScalingPlan( - args: DeleteScalingPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteScalingPlanCommandOutput) => void), - cb?: (err: any, data?: DeleteScalingPlanCommandOutput) => void - ): Promise | void { - const command = new DeleteScalingPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the scalable resources in the specified scaling plan.

+ * @see {@link DescribeScalingPlanResourcesCommand} */ - public describeScalingPlanResources( + describeScalingPlanResources( args: DescribeScalingPlanResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeScalingPlanResources( + describeScalingPlanResources( args: DescribeScalingPlanResourcesCommandInput, cb: (err: any, data?: DescribeScalingPlanResourcesCommandOutput) => void ): void; - public describeScalingPlanResources( + describeScalingPlanResources( args: DescribeScalingPlanResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScalingPlanResourcesCommandOutput) => void ): void; - public describeScalingPlanResources( - args: DescribeScalingPlanResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeScalingPlanResourcesCommandOutput) => void), - cb?: (err: any, data?: DescribeScalingPlanResourcesCommandOutput) => void - ): Promise | void { - const command = new DescribeScalingPlanResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes one or more of your scaling plans.

+ * @see {@link DescribeScalingPlansCommand} */ - public describeScalingPlans( + describeScalingPlans( args: DescribeScalingPlansCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeScalingPlans( + describeScalingPlans( args: DescribeScalingPlansCommandInput, cb: (err: any, data?: DescribeScalingPlansCommandOutput) => void ): void; - public describeScalingPlans( + describeScalingPlans( args: DescribeScalingPlansCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScalingPlansCommandOutput) => void ): void; - public describeScalingPlans( - args: DescribeScalingPlansCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeScalingPlansCommandOutput) => void), - cb?: (err: any, data?: DescribeScalingPlansCommandOutput) => void - ): Promise | void { - const command = new DescribeScalingPlansCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the forecast data for a scalable resource.

- *

Capacity forecasts are represented as predicted values, or data points, that are - * calculated using historical data points from a specified CloudWatch load metric. Data points are - * available for up to 56 days.

+ * @see {@link GetScalingPlanResourceForecastDataCommand} */ - public getScalingPlanResourceForecastData( + getScalingPlanResourceForecastData( args: GetScalingPlanResourceForecastDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getScalingPlanResourceForecastData( + getScalingPlanResourceForecastData( args: GetScalingPlanResourceForecastDataCommandInput, cb: (err: any, data?: GetScalingPlanResourceForecastDataCommandOutput) => void ): void; - public getScalingPlanResourceForecastData( + getScalingPlanResourceForecastData( args: GetScalingPlanResourceForecastDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetScalingPlanResourceForecastDataCommandOutput) => void ): void; - public getScalingPlanResourceForecastData( - args: GetScalingPlanResourceForecastDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetScalingPlanResourceForecastDataCommandOutput) => void), - cb?: (err: any, data?: GetScalingPlanResourceForecastDataCommandOutput) => void - ): Promise | void { - const command = new GetScalingPlanResourceForecastDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified scaling plan.

- *

You cannot update a scaling plan if it is in the process of being created, updated, or - * deleted.

+ * @see {@link UpdateScalingPlanCommand} */ - public updateScalingPlan( + updateScalingPlan( args: UpdateScalingPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateScalingPlan( + updateScalingPlan( args: UpdateScalingPlanCommandInput, cb: (err: any, data?: UpdateScalingPlanCommandOutput) => void ): void; - public updateScalingPlan( + updateScalingPlan( args: UpdateScalingPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateScalingPlanCommandOutput) => void ): void; - public updateScalingPlan( - args: UpdateScalingPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateScalingPlanCommandOutput) => void), - cb?: (err: any, data?: UpdateScalingPlanCommandOutput) => void - ): Promise | void { - const command = new UpdateScalingPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * AWS Auto Scaling + * + * + *

Use AWS Auto Scaling to create scaling plans for your applications to + * automatically scale your scalable AWS resources.

+ *

+ * API Summary + *

+ *

You can use the AWS Auto Scaling service API to accomplish the following tasks:

+ *
    + *
  • + *

    Create and manage scaling plans

    + *
  • + *
  • + *

    Define target tracking scaling policies to dynamically scale your resources based + * on utilization

    + *
  • + *
  • + *

    Scale Amazon EC2 Auto Scaling groups using predictive scaling and dynamic scaling to scale your + * Amazon EC2 capacity faster

    + *
  • + *
  • + *

    Set minimum and maximum capacity limits

    + *
  • + *
  • + *

    Retrieve information on existing scaling plans

    + *
  • + *
  • + *

    Access current forecast data and historical forecast data for up to 56 days + * previous

    + *
  • + *
+ * + *

To learn more about AWS Auto Scaling, including information about granting IAM users required + * permissions for AWS Auto Scaling actions, see the AWS Auto Scaling User Guide.

+ */ +export class AutoScalingPlans extends AutoScalingPlansClient implements AutoScalingPlans {} +createAggregatedClient(commands, AutoScalingPlans); diff --git a/clients/client-auto-scaling/src/AutoScaling.ts b/clients/client-auto-scaling/src/AutoScaling.ts index c481243eb4ed..ebca064300d9 100644 --- a/clients/client-auto-scaling/src/AutoScaling.ts +++ b/clients/client-auto-scaling/src/AutoScaling.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { AutoScalingClient } from "./AutoScalingClient"; +import { AutoScalingClient, AutoScalingClientConfig } from "./AutoScalingClient"; import { AttachInstancesCommand, AttachInstancesCommandInput, @@ -316,2754 +317,1133 @@ import { UpdateAutoScalingGroupCommandOutput, } from "./commands/UpdateAutoScalingGroupCommand"; -/** - * @public - * Amazon EC2 Auto Scaling - *

Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances - * based on user-defined scaling policies, scheduled actions, and health checks.

- *

For more information, see the Amazon EC2 Auto Scaling User Guide and the Amazon EC2 Auto Scaling API Reference.

- */ -export class AutoScaling extends AutoScalingClient { - /** - * @public - *

Attaches one or more EC2 instances to the specified Auto Scaling group.

- *

When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the - * number of instances being attached. If the number of instances being attached plus the - * desired capacity of the group exceeds the maximum size of the group, the operation - * fails.

- *

If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are - * also registered with the load balancer. If there are target groups attached to your Auto Scaling - * group, the instances are also registered with the target groups.

- *

For more information, see Attach EC2 instances to - * your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

- */ - public attachInstances( +const commands = { + AttachInstancesCommand, + AttachLoadBalancersCommand, + AttachLoadBalancerTargetGroupsCommand, + AttachTrafficSourcesCommand, + BatchDeleteScheduledActionCommand, + BatchPutScheduledUpdateGroupActionCommand, + CancelInstanceRefreshCommand, + CompleteLifecycleActionCommand, + CreateAutoScalingGroupCommand, + CreateLaunchConfigurationCommand, + CreateOrUpdateTagsCommand, + DeleteAutoScalingGroupCommand, + DeleteLaunchConfigurationCommand, + DeleteLifecycleHookCommand, + DeleteNotificationConfigurationCommand, + DeletePolicyCommand, + DeleteScheduledActionCommand, + DeleteTagsCommand, + DeleteWarmPoolCommand, + DescribeAccountLimitsCommand, + DescribeAdjustmentTypesCommand, + DescribeAutoScalingGroupsCommand, + DescribeAutoScalingInstancesCommand, + DescribeAutoScalingNotificationTypesCommand, + DescribeInstanceRefreshesCommand, + DescribeLaunchConfigurationsCommand, + DescribeLifecycleHooksCommand, + DescribeLifecycleHookTypesCommand, + DescribeLoadBalancersCommand, + DescribeLoadBalancerTargetGroupsCommand, + DescribeMetricCollectionTypesCommand, + DescribeNotificationConfigurationsCommand, + DescribePoliciesCommand, + DescribeScalingActivitiesCommand, + DescribeScalingProcessTypesCommand, + DescribeScheduledActionsCommand, + DescribeTagsCommand, + DescribeTerminationPolicyTypesCommand, + DescribeTrafficSourcesCommand, + DescribeWarmPoolCommand, + DetachInstancesCommand, + DetachLoadBalancersCommand, + DetachLoadBalancerTargetGroupsCommand, + DetachTrafficSourcesCommand, + DisableMetricsCollectionCommand, + EnableMetricsCollectionCommand, + EnterStandbyCommand, + ExecutePolicyCommand, + ExitStandbyCommand, + GetPredictiveScalingForecastCommand, + PutLifecycleHookCommand, + PutNotificationConfigurationCommand, + PutScalingPolicyCommand, + PutScheduledUpdateGroupActionCommand, + PutWarmPoolCommand, + RecordLifecycleActionHeartbeatCommand, + ResumeProcessesCommand, + RollbackInstanceRefreshCommand, + SetDesiredCapacityCommand, + SetInstanceHealthCommand, + SetInstanceProtectionCommand, + StartInstanceRefreshCommand, + SuspendProcessesCommand, + TerminateInstanceInAutoScalingGroupCommand, + UpdateAutoScalingGroupCommand, +}; + +export interface AutoScaling { + /** + * @see {@link AttachInstancesCommand} + */ + attachInstances( args: AttachInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachInstances( - args: AttachInstancesCommandInput, - cb: (err: any, data?: AttachInstancesCommandOutput) => void - ): void; - public attachInstances( + attachInstances(args: AttachInstancesCommandInput, cb: (err: any, data?: AttachInstancesCommandOutput) => void): void; + attachInstances( args: AttachInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachInstancesCommandOutput) => void ): void; - public attachInstances( - args: AttachInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachInstancesCommandOutput) => void), - cb?: (err: any, data?: AttachInstancesCommandOutput) => void - ): Promise | void { - const command = new AttachInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This API operation is superseded by AttachTrafficSources, which - * can attach multiple traffic sources types. We recommend using - * AttachTrafficSources to simplify how you manage traffic sources. - * However, we continue to support AttachLoadBalancers. You can use both - * the original AttachLoadBalancers API operation and - * AttachTrafficSources on the same Auto Scaling group.

- *
- *

Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the - * running instances with these Classic Load Balancers.

- *

To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach a load balancer from the Auto Scaling - * group, call the DetachLoadBalancers API.

- *

This operation is additive and does not detach existing Classic Load Balancers or - * target groups from the Auto Scaling group.

- *

For more information, see Use Elastic Load Balancing to - * distribute traffic across the instances in your Auto Scaling group in the - * Amazon EC2 Auto Scaling User Guide.

- */ - public attachLoadBalancers( + + /** + * @see {@link AttachLoadBalancersCommand} + */ + attachLoadBalancers( args: AttachLoadBalancersCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachLoadBalancers( + attachLoadBalancers( args: AttachLoadBalancersCommandInput, cb: (err: any, data?: AttachLoadBalancersCommandOutput) => void ): void; - public attachLoadBalancers( + attachLoadBalancers( args: AttachLoadBalancersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachLoadBalancersCommandOutput) => void ): void; - public attachLoadBalancers( - args: AttachLoadBalancersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachLoadBalancersCommandOutput) => void), - cb?: (err: any, data?: AttachLoadBalancersCommandOutput) => void - ): Promise | void { - const command = new AttachLoadBalancersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This API operation is superseded by AttachTrafficSources, which - * can attach multiple traffic sources types. We recommend using - * AttachTrafficSources to simplify how you manage traffic sources. - * However, we continue to support AttachLoadBalancerTargetGroups. You can - * use both the original AttachLoadBalancerTargetGroups API operation and - * AttachTrafficSources on the same Auto Scaling group.

- *
- *

Attaches one or more target groups to the specified Auto Scaling group.

- *

This operation is used with the following load balancer types:

- *
    - *
  • - *

    Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and - * HTTPS.

    - *
  • - *
  • - *

    Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and - * UDP.

    - *
  • - *
  • - *

    Gateway Load Balancer - Operates at the network layer (layer 3).

    - *
  • - *
- *

To describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from - * the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.

- *

This operation is additive and does not detach existing target groups or Classic Load - * Balancers from the Auto Scaling group.

- *

For more information, see Use Elastic Load Balancing to - * distribute traffic across the instances in your Auto Scaling group in the - * Amazon EC2 Auto Scaling User Guide.

- */ - public attachLoadBalancerTargetGroups( + + /** + * @see {@link AttachLoadBalancerTargetGroupsCommand} + */ + attachLoadBalancerTargetGroups( args: AttachLoadBalancerTargetGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachLoadBalancerTargetGroups( + attachLoadBalancerTargetGroups( args: AttachLoadBalancerTargetGroupsCommandInput, cb: (err: any, data?: AttachLoadBalancerTargetGroupsCommandOutput) => void ): void; - public attachLoadBalancerTargetGroups( + attachLoadBalancerTargetGroups( args: AttachLoadBalancerTargetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachLoadBalancerTargetGroupsCommandOutput) => void ): void; - public attachLoadBalancerTargetGroups( - args: AttachLoadBalancerTargetGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachLoadBalancerTargetGroupsCommandOutput) => void), - cb?: (err: any, data?: AttachLoadBalancerTargetGroupsCommandOutput) => void - ): Promise | void { - const command = new AttachLoadBalancerTargetGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attaches one or more traffic sources to the specified Auto Scaling group.

- *

You can use any of the following as traffic sources for an Auto Scaling group:

- *
    - *
  • - *

    Application Load Balancer

    - *
  • - *
  • - *

    Classic Load Balancer

    - *
  • - *
  • - *

    Gateway Load Balancer

    - *
  • - *
  • - *

    Network Load Balancer

    - *
  • - *
  • - *

    VPC Lattice

    - *
  • - *
- *

This operation is additive and does not detach existing traffic sources from the Auto Scaling - * group.

- *

After the operation completes, use the DescribeTrafficSources API to - * return details about the state of the attachments between traffic sources and your Auto Scaling - * group. To detach a traffic source from the Auto Scaling group, call the DetachTrafficSources API.

- */ - public attachTrafficSources( + + /** + * @see {@link AttachTrafficSourcesCommand} + */ + attachTrafficSources( args: AttachTrafficSourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachTrafficSources( + attachTrafficSources( args: AttachTrafficSourcesCommandInput, cb: (err: any, data?: AttachTrafficSourcesCommandOutput) => void ): void; - public attachTrafficSources( + attachTrafficSources( args: AttachTrafficSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachTrafficSourcesCommandOutput) => void ): void; - public attachTrafficSources( - args: AttachTrafficSourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachTrafficSourcesCommandOutput) => void), - cb?: (err: any, data?: AttachTrafficSourcesCommandOutput) => void - ): Promise | void { - const command = new AttachTrafficSourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes one or more scheduled actions for the specified Auto Scaling group.

- */ - public batchDeleteScheduledAction( + + /** + * @see {@link BatchDeleteScheduledActionCommand} + */ + batchDeleteScheduledAction( args: BatchDeleteScheduledActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeleteScheduledAction( + batchDeleteScheduledAction( args: BatchDeleteScheduledActionCommandInput, cb: (err: any, data?: BatchDeleteScheduledActionCommandOutput) => void ): void; - public batchDeleteScheduledAction( + batchDeleteScheduledAction( args: BatchDeleteScheduledActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteScheduledActionCommandOutput) => void ): void; - public batchDeleteScheduledAction( - args: BatchDeleteScheduledActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeleteScheduledActionCommandOutput) => void), - cb?: (err: any, data?: BatchDeleteScheduledActionCommandOutput) => void - ): Promise | void { - const command = new BatchDeleteScheduledActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or updates one or more scheduled scaling actions for an Auto Scaling group.

- */ - public batchPutScheduledUpdateGroupAction( + + /** + * @see {@link BatchPutScheduledUpdateGroupActionCommand} + */ + batchPutScheduledUpdateGroupAction( args: BatchPutScheduledUpdateGroupActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchPutScheduledUpdateGroupAction( + batchPutScheduledUpdateGroupAction( args: BatchPutScheduledUpdateGroupActionCommandInput, cb: (err: any, data?: BatchPutScheduledUpdateGroupActionCommandOutput) => void ): void; - public batchPutScheduledUpdateGroupAction( + batchPutScheduledUpdateGroupAction( args: BatchPutScheduledUpdateGroupActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchPutScheduledUpdateGroupActionCommandOutput) => void ): void; - public batchPutScheduledUpdateGroupAction( - args: BatchPutScheduledUpdateGroupActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchPutScheduledUpdateGroupActionCommandOutput) => void), - cb?: (err: any, data?: BatchPutScheduledUpdateGroupActionCommandOutput) => void - ): Promise | void { - const command = new BatchPutScheduledUpdateGroupActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels an instance refresh or rollback that is in progress. If an instance refresh or - * rollback is not in progress, an ActiveInstanceRefreshNotFound error - * occurs.

- *

This operation is part of the instance refresh - * feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group - * after you make configuration changes.

- *

When you cancel an instance refresh, this does not roll back any changes that it made. - * Use the RollbackInstanceRefresh API to roll back instead.

- */ - public cancelInstanceRefresh( + + /** + * @see {@link CancelInstanceRefreshCommand} + */ + cancelInstanceRefresh( args: CancelInstanceRefreshCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelInstanceRefresh( + cancelInstanceRefresh( args: CancelInstanceRefreshCommandInput, cb: (err: any, data?: CancelInstanceRefreshCommandOutput) => void ): void; - public cancelInstanceRefresh( + cancelInstanceRefresh( args: CancelInstanceRefreshCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelInstanceRefreshCommandOutput) => void ): void; - public cancelInstanceRefresh( - args: CancelInstanceRefreshCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelInstanceRefreshCommandOutput) => void), - cb?: (err: any, data?: CancelInstanceRefreshCommandOutput) => void - ): Promise | void { - const command = new CancelInstanceRefreshCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Completes the lifecycle action for the specified token or instance with the specified - * result.

- *

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling - * group:

- *
    - *
  1. - *

    (Optional) Create a launch template or launch configuration with a user data - * script that runs while an instance is in a wait state due to a lifecycle - * hook.

    - *
  2. - *
  3. - *

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke - * your Lambda function when an instance is put into a wait state due to a - * lifecycle hook.

    - *
  4. - *
  5. - *

    (Optional) Create a notification target and an IAM role. The target can be - * either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish - * lifecycle notifications to the target.

    - *
  6. - *
  7. - *

    Create the lifecycle hook. Specify whether the hook is used when the instances - * launch or terminate.

    - *
  8. - *
  9. - *

    If you need more time, record the lifecycle action heartbeat to keep the - * instance in a wait state.

    - *
  10. - *
  11. - *

    - * If you finish before the timeout period ends, send a - * callback by using the CompleteLifecycleAction API - * call. - *

    - *
  12. - *
- *

For more information, see Amazon EC2 Auto Scaling lifecycle - * hooks in the Amazon EC2 Auto Scaling User Guide.

- */ - public completeLifecycleAction( + + /** + * @see {@link CompleteLifecycleActionCommand} + */ + completeLifecycleAction( args: CompleteLifecycleActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public completeLifecycleAction( + completeLifecycleAction( args: CompleteLifecycleActionCommandInput, cb: (err: any, data?: CompleteLifecycleActionCommandOutput) => void ): void; - public completeLifecycleAction( + completeLifecycleAction( args: CompleteLifecycleActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteLifecycleActionCommandOutput) => void ): void; - public completeLifecycleAction( - args: CompleteLifecycleActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CompleteLifecycleActionCommandOutput) => void), - cb?: (err: any, data?: CompleteLifecycleActionCommandOutput) => void - ): Promise | void { - const command = new CompleteLifecycleActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2. - *

- *

Creates an Auto Scaling group with the specified name and attributes.

- *

If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit, - * call the DescribeAccountLimits API. For information about updating - * this limit, see Quotas for - * Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

- *

For introductory exercises for creating an Auto Scaling group, see Getting started with - * Amazon EC2 Auto Scaling and Tutorial: Set up a - * scaled and load-balanced application in the - * Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling - * groups in the Amazon EC2 Auto Scaling User Guide.

- *

Every Auto Scaling group has three size properties (DesiredCapacity, - * MaxSize, and MinSize). Usually, you set these sizes based - * on a specific number of instances. However, if you configure a mixed instances policy - * that defines weights for the instance types, you must specify these sizes with the same - * units that you use for weighting instances.

- */ - public createAutoScalingGroup( + + /** + * @see {@link CreateAutoScalingGroupCommand} + */ + createAutoScalingGroup( args: CreateAutoScalingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAutoScalingGroup( + createAutoScalingGroup( args: CreateAutoScalingGroupCommandInput, cb: (err: any, data?: CreateAutoScalingGroupCommandOutput) => void ): void; - public createAutoScalingGroup( + createAutoScalingGroup( args: CreateAutoScalingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAutoScalingGroupCommandOutput) => void ): void; - public createAutoScalingGroup( - args: CreateAutoScalingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAutoScalingGroupCommandOutput) => void), - cb?: (err: any, data?: CreateAutoScalingGroupCommandOutput) => void - ): Promise | void { - const command = new CreateAutoScalingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a launch configuration.

- *

If you exceed your maximum limit of launch configurations, the call fails. To query - * this limit, call the DescribeAccountLimits API. For information about - * updating this limit, see Quotas for - * Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

- *

For more information, see Launch - * configurations in the Amazon EC2 Auto Scaling User Guide.

- * - *

Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a - * launch template or a launch configuration. We strongly recommend that you do not use - * launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. - * For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.

- *
- */ - public createLaunchConfiguration( + + /** + * @see {@link CreateLaunchConfigurationCommand} + */ + createLaunchConfiguration( args: CreateLaunchConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLaunchConfiguration( + createLaunchConfiguration( args: CreateLaunchConfigurationCommandInput, cb: (err: any, data?: CreateLaunchConfigurationCommandOutput) => void ): void; - public createLaunchConfiguration( + createLaunchConfiguration( args: CreateLaunchConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLaunchConfigurationCommandOutput) => void ): void; - public createLaunchConfiguration( - args: CreateLaunchConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLaunchConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateLaunchConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateLaunchConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or updates tags for the specified Auto Scaling group.

- *

When you specify a tag with a key that already exists, the operation overwrites the - * previous tag definition, and you do not get an error message.

- *

For more information, see Tag Auto Scaling groups and - * instances in the Amazon EC2 Auto Scaling User Guide.

- */ - public createOrUpdateTags( + + /** + * @see {@link CreateOrUpdateTagsCommand} + */ + createOrUpdateTags( args: CreateOrUpdateTagsCommandInput, options?: __HttpHandlerOptions ): Promise; - public createOrUpdateTags( + createOrUpdateTags( args: CreateOrUpdateTagsCommandInput, cb: (err: any, data?: CreateOrUpdateTagsCommandOutput) => void ): void; - public createOrUpdateTags( + createOrUpdateTags( args: CreateOrUpdateTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateOrUpdateTagsCommandOutput) => void ): void; - public createOrUpdateTags( - args: CreateOrUpdateTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateOrUpdateTagsCommandOutput) => void), - cb?: (err: any, data?: CreateOrUpdateTagsCommandOutput) => void - ): Promise | void { - const command = new CreateOrUpdateTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified Auto Scaling group.

- *

If the group has instances or scaling activities in progress, you must specify the - * option to force the deletion in order for it to succeed. The force delete operation will - * also terminate the EC2 instances. If the group has a warm pool, the force delete option - * also deletes the warm pool.

- *

To remove instances from the Auto Scaling group before deleting it, call the DetachInstances API with the list of instances and the option to - * decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement - * instances.

- *

To terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity - * of the Auto Scaling group to - * zero.

- *

If the group has scaling policies, deleting the group deletes the policies, the - * underlying alarm actions, and any alarm that no longer has an associated action.

- *

For more information, see Delete your Auto Scaling - * infrastructure in the Amazon EC2 Auto Scaling User Guide.

- */ - public deleteAutoScalingGroup( + + /** + * @see {@link DeleteAutoScalingGroupCommand} + */ + deleteAutoScalingGroup( args: DeleteAutoScalingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAutoScalingGroup( + deleteAutoScalingGroup( args: DeleteAutoScalingGroupCommandInput, cb: (err: any, data?: DeleteAutoScalingGroupCommandOutput) => void ): void; - public deleteAutoScalingGroup( + deleteAutoScalingGroup( args: DeleteAutoScalingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAutoScalingGroupCommandOutput) => void ): void; - public deleteAutoScalingGroup( - args: DeleteAutoScalingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAutoScalingGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteAutoScalingGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteAutoScalingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified launch configuration.

- *

The launch configuration must not be attached to an Auto Scaling group. When this call - * completes, the launch configuration is no longer available for use.

- */ - public deleteLaunchConfiguration( + + /** + * @see {@link DeleteLaunchConfigurationCommand} + */ + deleteLaunchConfiguration( args: DeleteLaunchConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLaunchConfiguration( + deleteLaunchConfiguration( args: DeleteLaunchConfigurationCommandInput, cb: (err: any, data?: DeleteLaunchConfigurationCommandOutput) => void ): void; - public deleteLaunchConfiguration( + deleteLaunchConfiguration( args: DeleteLaunchConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLaunchConfigurationCommandOutput) => void ): void; - public deleteLaunchConfiguration( - args: DeleteLaunchConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLaunchConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteLaunchConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteLaunchConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified lifecycle hook.

- *

If there are any outstanding lifecycle actions, they are completed first - * (ABANDON for launching instances, CONTINUE for terminating - * instances).

- */ - public deleteLifecycleHook( + + /** + * @see {@link DeleteLifecycleHookCommand} + */ + deleteLifecycleHook( args: DeleteLifecycleHookCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLifecycleHook( + deleteLifecycleHook( args: DeleteLifecycleHookCommandInput, cb: (err: any, data?: DeleteLifecycleHookCommandOutput) => void ): void; - public deleteLifecycleHook( + deleteLifecycleHook( args: DeleteLifecycleHookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLifecycleHookCommandOutput) => void ): void; - public deleteLifecycleHook( - args: DeleteLifecycleHookCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLifecycleHookCommandOutput) => void), - cb?: (err: any, data?: DeleteLifecycleHookCommandOutput) => void - ): Promise | void { - const command = new DeleteLifecycleHookCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified notification.

- */ - public deleteNotificationConfiguration( + + /** + * @see {@link DeleteNotificationConfigurationCommand} + */ + deleteNotificationConfiguration( args: DeleteNotificationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNotificationConfiguration( + deleteNotificationConfiguration( args: DeleteNotificationConfigurationCommandInput, cb: (err: any, data?: DeleteNotificationConfigurationCommandOutput) => void ): void; - public deleteNotificationConfiguration( + deleteNotificationConfiguration( args: DeleteNotificationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNotificationConfigurationCommandOutput) => void ): void; - public deleteNotificationConfiguration( - args: DeleteNotificationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNotificationConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteNotificationConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteNotificationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified scaling policy.

- *

Deleting either a step scaling policy or a simple scaling policy deletes the - * underlying alarm action, but does not delete the alarm, even if it no longer has an - * associated action.

- *

For more information, see Deleting a scaling - * policy in the Amazon EC2 Auto Scaling User Guide.

- */ - public deletePolicy( - args: DeletePolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deletePolicy(args: DeletePolicyCommandInput, cb: (err: any, data?: DeletePolicyCommandOutput) => void): void; - public deletePolicy( + + /** + * @see {@link DeletePolicyCommand} + */ + deletePolicy(args: DeletePolicyCommandInput, options?: __HttpHandlerOptions): Promise; + deletePolicy(args: DeletePolicyCommandInput, cb: (err: any, data?: DeletePolicyCommandOutput) => void): void; + deletePolicy( args: DeletePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePolicyCommandOutput) => void ): void; - public deletePolicy( - args: DeletePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePolicyCommandOutput) => void), - cb?: (err: any, data?: DeletePolicyCommandOutput) => void - ): Promise | void { - const command = new DeletePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified scheduled action.

- */ - public deleteScheduledAction( + + /** + * @see {@link DeleteScheduledActionCommand} + */ + deleteScheduledAction( args: DeleteScheduledActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteScheduledAction( + deleteScheduledAction( args: DeleteScheduledActionCommandInput, cb: (err: any, data?: DeleteScheduledActionCommandOutput) => void ): void; - public deleteScheduledAction( + deleteScheduledAction( args: DeleteScheduledActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteScheduledActionCommandOutput) => void ): void; - public deleteScheduledAction( - args: DeleteScheduledActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteScheduledActionCommandOutput) => void), - cb?: (err: any, data?: DeleteScheduledActionCommandOutput) => void - ): Promise | void { - const command = new DeleteScheduledActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified tags.

- */ - public deleteTags(args: DeleteTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteTags(args: DeleteTagsCommandInput, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void; - public deleteTags( + + /** + * @see {@link DeleteTagsCommand} + */ + deleteTags(args: DeleteTagsCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTags(args: DeleteTagsCommandInput, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void; + deleteTags( args: DeleteTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTagsCommandOutput) => void ): void; - public deleteTags( - args: DeleteTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTagsCommandOutput) => void), - cb?: (err: any, data?: DeleteTagsCommandOutput) => void - ): Promise | void { - const command = new DeleteTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the warm pool for the specified Auto Scaling group.

- *

For more information, see Warm pools for - * Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

- */ - public deleteWarmPool( + + /** + * @see {@link DeleteWarmPoolCommand} + */ + deleteWarmPool( args: DeleteWarmPoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWarmPool( - args: DeleteWarmPoolCommandInput, - cb: (err: any, data?: DeleteWarmPoolCommandOutput) => void - ): void; - public deleteWarmPool( + deleteWarmPool(args: DeleteWarmPoolCommandInput, cb: (err: any, data?: DeleteWarmPoolCommandOutput) => void): void; + deleteWarmPool( args: DeleteWarmPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWarmPoolCommandOutput) => void ): void; - public deleteWarmPool( - args: DeleteWarmPoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWarmPoolCommandOutput) => void), - cb?: (err: any, data?: DeleteWarmPoolCommandOutput) => void - ): Promise | void { - const command = new DeleteWarmPoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the current Amazon EC2 Auto Scaling resource quotas for your account.

- *

When you establish an Amazon Web Services account, the account has initial quotas on the maximum - * number of Auto Scaling groups and launch configurations that you can create in a given Region. - * For more information, see Quotas for - * Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

- */ - public describeAccountLimits( + + /** + * @see {@link DescribeAccountLimitsCommand} + */ + describeAccountLimits( args: DescribeAccountLimitsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccountLimits( + describeAccountLimits( args: DescribeAccountLimitsCommandInput, cb: (err: any, data?: DescribeAccountLimitsCommandOutput) => void ): void; - public describeAccountLimits( + describeAccountLimits( args: DescribeAccountLimitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountLimitsCommandOutput) => void ): void; - public describeAccountLimits( - args: DescribeAccountLimitsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccountLimitsCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountLimitsCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountLimitsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the available adjustment types for step scaling and simple scaling - * policies.

- *

The following adjustment types are supported:

- *
    - *
  • - *

    - * ChangeInCapacity - *

    - *
  • - *
  • - *

    - * ExactCapacity - *

    - *
  • - *
  • - *

    - * PercentChangeInCapacity - *

    - *
  • - *
- */ - public describeAdjustmentTypes( + + /** + * @see {@link DescribeAdjustmentTypesCommand} + */ + describeAdjustmentTypes( args: DescribeAdjustmentTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAdjustmentTypes( + describeAdjustmentTypes( args: DescribeAdjustmentTypesCommandInput, cb: (err: any, data?: DescribeAdjustmentTypesCommandOutput) => void ): void; - public describeAdjustmentTypes( + describeAdjustmentTypes( args: DescribeAdjustmentTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAdjustmentTypesCommandOutput) => void ): void; - public describeAdjustmentTypes( - args: DescribeAdjustmentTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAdjustmentTypesCommandOutput) => void), - cb?: (err: any, data?: DescribeAdjustmentTypesCommandOutput) => void - ): Promise | void { - const command = new DescribeAdjustmentTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the Auto Scaling groups in the account and Region.

- *

If you specify Auto Scaling group names, the output includes information for only the - * specified Auto Scaling groups. If you specify filters, the output includes information for only - * those Auto Scaling groups that meet the filter criteria. If you do not specify group names or - * filters, the output includes information for all Auto Scaling groups.

- *

This operation also returns information about instances in Auto Scaling groups. To retrieve - * information about the instances in a warm pool, you must call the DescribeWarmPool API.

- */ - public describeAutoScalingGroups( + + /** + * @see {@link DescribeAutoScalingGroupsCommand} + */ + describeAutoScalingGroups( args: DescribeAutoScalingGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAutoScalingGroups( + describeAutoScalingGroups( args: DescribeAutoScalingGroupsCommandInput, cb: (err: any, data?: DescribeAutoScalingGroupsCommandOutput) => void ): void; - public describeAutoScalingGroups( + describeAutoScalingGroups( args: DescribeAutoScalingGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAutoScalingGroupsCommandOutput) => void ): void; - public describeAutoScalingGroups( - args: DescribeAutoScalingGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAutoScalingGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeAutoScalingGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeAutoScalingGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the Auto Scaling instances in the account and Region.

- */ - public describeAutoScalingInstances( + + /** + * @see {@link DescribeAutoScalingInstancesCommand} + */ + describeAutoScalingInstances( args: DescribeAutoScalingInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAutoScalingInstances( + describeAutoScalingInstances( args: DescribeAutoScalingInstancesCommandInput, cb: (err: any, data?: DescribeAutoScalingInstancesCommandOutput) => void ): void; - public describeAutoScalingInstances( + describeAutoScalingInstances( args: DescribeAutoScalingInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAutoScalingInstancesCommandOutput) => void ): void; - public describeAutoScalingInstances( - args: DescribeAutoScalingInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAutoScalingInstancesCommandOutput) => void), - cb?: (err: any, data?: DescribeAutoScalingInstancesCommandOutput) => void - ): Promise | void { - const command = new DescribeAutoScalingInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the notification types that are supported by Amazon EC2 Auto Scaling.

- */ - public describeAutoScalingNotificationTypes( + + /** + * @see {@link DescribeAutoScalingNotificationTypesCommand} + */ + describeAutoScalingNotificationTypes( args: DescribeAutoScalingNotificationTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAutoScalingNotificationTypes( + describeAutoScalingNotificationTypes( args: DescribeAutoScalingNotificationTypesCommandInput, cb: (err: any, data?: DescribeAutoScalingNotificationTypesCommandOutput) => void ): void; - public describeAutoScalingNotificationTypes( + describeAutoScalingNotificationTypes( args: DescribeAutoScalingNotificationTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAutoScalingNotificationTypesCommandOutput) => void ): void; - public describeAutoScalingNotificationTypes( - args: DescribeAutoScalingNotificationTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAutoScalingNotificationTypesCommandOutput) => void), - cb?: (err: any, data?: DescribeAutoScalingNotificationTypesCommandOutput) => void - ): Promise | void { - const command = new DescribeAutoScalingNotificationTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the instance refreshes for the specified Auto Scaling group.

- *

This operation is part of the instance refresh - * feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group - * after you make configuration changes.

- *

To help you determine the status of an instance refresh, Amazon EC2 Auto Scaling returns information - * about the instance refreshes you previously initiated, including their status, start - * time, end time, the percentage of the instance refresh that is complete, and the number - * of instances remaining to update before the instance refresh is complete. If a rollback - * is initiated while an instance refresh is in progress, Amazon EC2 Auto Scaling also returns information - * about the rollback of the instance refresh.

- */ - public describeInstanceRefreshes( + + /** + * @see {@link DescribeInstanceRefreshesCommand} + */ + describeInstanceRefreshes( args: DescribeInstanceRefreshesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInstanceRefreshes( + describeInstanceRefreshes( args: DescribeInstanceRefreshesCommandInput, cb: (err: any, data?: DescribeInstanceRefreshesCommandOutput) => void ): void; - public describeInstanceRefreshes( + describeInstanceRefreshes( args: DescribeInstanceRefreshesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstanceRefreshesCommandOutput) => void ): void; - public describeInstanceRefreshes( - args: DescribeInstanceRefreshesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInstanceRefreshesCommandOutput) => void), - cb?: (err: any, data?: DescribeInstanceRefreshesCommandOutput) => void - ): Promise | void { - const command = new DescribeInstanceRefreshesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the launch configurations in the account and Region.

- */ - public describeLaunchConfigurations( + + /** + * @see {@link DescribeLaunchConfigurationsCommand} + */ + describeLaunchConfigurations( args: DescribeLaunchConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLaunchConfigurations( + describeLaunchConfigurations( args: DescribeLaunchConfigurationsCommandInput, cb: (err: any, data?: DescribeLaunchConfigurationsCommandOutput) => void ): void; - public describeLaunchConfigurations( + describeLaunchConfigurations( args: DescribeLaunchConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLaunchConfigurationsCommandOutput) => void ): void; - public describeLaunchConfigurations( - args: DescribeLaunchConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLaunchConfigurationsCommandOutput) => void), - cb?: (err: any, data?: DescribeLaunchConfigurationsCommandOutput) => void - ): Promise | void { - const command = new DescribeLaunchConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the lifecycle hooks for the specified Auto Scaling group.

- */ - public describeLifecycleHooks( + + /** + * @see {@link DescribeLifecycleHooksCommand} + */ + describeLifecycleHooks( args: DescribeLifecycleHooksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLifecycleHooks( + describeLifecycleHooks( args: DescribeLifecycleHooksCommandInput, cb: (err: any, data?: DescribeLifecycleHooksCommandOutput) => void ): void; - public describeLifecycleHooks( + describeLifecycleHooks( args: DescribeLifecycleHooksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLifecycleHooksCommandOutput) => void ): void; - public describeLifecycleHooks( - args: DescribeLifecycleHooksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLifecycleHooksCommandOutput) => void), - cb?: (err: any, data?: DescribeLifecycleHooksCommandOutput) => void - ): Promise | void { - const command = new DescribeLifecycleHooksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the available types of lifecycle hooks.

- *

The following hook types are supported:

- *
    - *
  • - *

    - * autoscaling:EC2_INSTANCE_LAUNCHING - *

    - *
  • - *
  • - *

    - * autoscaling:EC2_INSTANCE_TERMINATING - *

    - *
  • - *
- */ - public describeLifecycleHookTypes( + + /** + * @see {@link DescribeLifecycleHookTypesCommand} + */ + describeLifecycleHookTypes( args: DescribeLifecycleHookTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLifecycleHookTypes( + describeLifecycleHookTypes( args: DescribeLifecycleHookTypesCommandInput, cb: (err: any, data?: DescribeLifecycleHookTypesCommandOutput) => void ): void; - public describeLifecycleHookTypes( + describeLifecycleHookTypes( args: DescribeLifecycleHookTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLifecycleHookTypesCommandOutput) => void ): void; - public describeLifecycleHookTypes( - args: DescribeLifecycleHookTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLifecycleHookTypesCommandOutput) => void), - cb?: (err: any, data?: DescribeLifecycleHookTypesCommandOutput) => void - ): Promise | void { - const command = new DescribeLifecycleHookTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This API operation is superseded by DescribeTrafficSources, - * which can describe multiple traffic sources types. We recommend using - * DescribeTrafficSources to simplify how you manage traffic sources. - * However, we continue to support DescribeLoadBalancers. You can use both - * the original DescribeLoadBalancers API operation and - * DescribeTrafficSources on the same Auto Scaling group.

- *
- *

Gets information about the load balancers for the specified Auto Scaling group.

- *

This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the - * DescribeLoadBalancerTargetGroups API instead.

- *

To determine the attachment status of the load balancer, use the State - * element in the response. When you attach a load balancer to an Auto Scaling group, the initial - * State value is Adding. The state transitions to - * Added after all Auto Scaling instances are registered with the load balancer. - * If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to - * InService after at least one Auto Scaling instance passes the health check. - * When the load balancer is in the InService state, Amazon EC2 Auto Scaling can terminate - * and replace any instances that are reported as unhealthy. If no registered instances - * pass the health checks, the load balancer doesn't enter the InService - * state.

- *

Load balancers also have an InService state if you attach them in the - * CreateAutoScalingGroup API call. If your load balancer state is - * InService, but it is not working properly, check the scaling activities - * by calling DescribeScalingActivities and take any corrective actions - * necessary.

- *

For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: - * Health checks in the Amazon EC2 Auto Scaling User Guide. For more - * information, see Use Elastic Load Balancing to - * distribute traffic across the instances in your Auto Scaling group in the - * Amazon EC2 Auto Scaling User Guide.

- */ - public describeLoadBalancers( + + /** + * @see {@link DescribeLoadBalancersCommand} + */ + describeLoadBalancers( args: DescribeLoadBalancersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLoadBalancers( + describeLoadBalancers( args: DescribeLoadBalancersCommandInput, cb: (err: any, data?: DescribeLoadBalancersCommandOutput) => void ): void; - public describeLoadBalancers( + describeLoadBalancers( args: DescribeLoadBalancersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLoadBalancersCommandOutput) => void ): void; - public describeLoadBalancers( - args: DescribeLoadBalancersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLoadBalancersCommandOutput) => void), - cb?: (err: any, data?: DescribeLoadBalancersCommandOutput) => void - ): Promise | void { - const command = new DescribeLoadBalancersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This API operation is superseded by DescribeTrafficSources, - * which can describe multiple traffic sources types. We recommend using - * DetachTrafficSources to simplify how you manage traffic sources. - * However, we continue to support DescribeLoadBalancerTargetGroups. You - * can use both the original DescribeLoadBalancerTargetGroups API - * operation and DescribeTrafficSources on the same Auto Scaling group.

- *
- *

Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.

- *

To determine the attachment status of the target group, use the State - * element in the response. When you attach a target group to an Auto Scaling group, the initial - * State value is Adding. The state transitions to - * Added after all Auto Scaling instances are registered with the target group. If - * Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to - * InService after at least one Auto Scaling instance passes the health check. - * When the target group is in the InService state, Amazon EC2 Auto Scaling can terminate and - * replace any instances that are reported as unhealthy. If no registered instances pass - * the health checks, the target group doesn't enter the InService state.

- *

Target groups also have an InService state if you attach them in the - * CreateAutoScalingGroup API call. If your target group state is - * InService, but it is not working properly, check the scaling activities - * by calling DescribeScalingActivities and take any corrective actions - * necessary.

- *

For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: - * Health checks in the Amazon EC2 Auto Scaling User Guide. For more - * information, see Use Elastic Load Balancing to - * distribute traffic across the instances in your Auto Scaling group in the - * Amazon EC2 Auto Scaling User Guide.

- * - *

You can use this operation to describe target groups that were attached by using - * AttachLoadBalancerTargetGroups, but not for target groups that - * were attached by using AttachTrafficSources.

- *
- */ - public describeLoadBalancerTargetGroups( + + /** + * @see {@link DescribeLoadBalancerTargetGroupsCommand} + */ + describeLoadBalancerTargetGroups( args: DescribeLoadBalancerTargetGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLoadBalancerTargetGroups( + describeLoadBalancerTargetGroups( args: DescribeLoadBalancerTargetGroupsCommandInput, cb: (err: any, data?: DescribeLoadBalancerTargetGroupsCommandOutput) => void ): void; - public describeLoadBalancerTargetGroups( + describeLoadBalancerTargetGroups( args: DescribeLoadBalancerTargetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLoadBalancerTargetGroupsCommandOutput) => void ): void; - public describeLoadBalancerTargetGroups( - args: DescribeLoadBalancerTargetGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLoadBalancerTargetGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeLoadBalancerTargetGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeLoadBalancerTargetGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.

- */ - public describeMetricCollectionTypes( + + /** + * @see {@link DescribeMetricCollectionTypesCommand} + */ + describeMetricCollectionTypes( args: DescribeMetricCollectionTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMetricCollectionTypes( + describeMetricCollectionTypes( args: DescribeMetricCollectionTypesCommandInput, cb: (err: any, data?: DescribeMetricCollectionTypesCommandOutput) => void ): void; - public describeMetricCollectionTypes( + describeMetricCollectionTypes( args: DescribeMetricCollectionTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMetricCollectionTypesCommandOutput) => void ): void; - public describeMetricCollectionTypes( - args: DescribeMetricCollectionTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMetricCollectionTypesCommandOutput) => void), - cb?: (err: any, data?: DescribeMetricCollectionTypesCommandOutput) => void - ): Promise | void { - const command = new DescribeMetricCollectionTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the Amazon SNS notifications that are configured for one or more - * Auto Scaling groups.

- */ - public describeNotificationConfigurations( + + /** + * @see {@link DescribeNotificationConfigurationsCommand} + */ + describeNotificationConfigurations( args: DescribeNotificationConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNotificationConfigurations( + describeNotificationConfigurations( args: DescribeNotificationConfigurationsCommandInput, cb: (err: any, data?: DescribeNotificationConfigurationsCommandOutput) => void ): void; - public describeNotificationConfigurations( + describeNotificationConfigurations( args: DescribeNotificationConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNotificationConfigurationsCommandOutput) => void ): void; - public describeNotificationConfigurations( - args: DescribeNotificationConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeNotificationConfigurationsCommandOutput) => void), - cb?: (err: any, data?: DescribeNotificationConfigurationsCommandOutput) => void - ): Promise | void { - const command = new DescribeNotificationConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the scaling policies in the account and Region.

- */ - public describePolicies( + + /** + * @see {@link DescribePoliciesCommand} + */ + describePolicies( args: DescribePoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePolicies( + describePolicies( args: DescribePoliciesCommandInput, cb: (err: any, data?: DescribePoliciesCommandOutput) => void ): void; - public describePolicies( + describePolicies( args: DescribePoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePoliciesCommandOutput) => void ): void; - public describePolicies( - args: DescribePoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePoliciesCommandOutput) => void), - cb?: (err: any, data?: DescribePoliciesCommandOutput) => void - ): Promise | void { - const command = new DescribePoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the scaling activities in the account and Region.

- *

When scaling events occur, you see a record of the scaling activity in the scaling - * activities. For more information, see Verifying a scaling - * activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

- *

If the scaling event succeeds, the value of the StatusCode element in the - * response is Successful. If an attempt to launch instances failed, the - * StatusCode value is Failed or Cancelled and - * the StatusMessage element in the response indicates the cause of the - * failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

- */ - public describeScalingActivities( + + /** + * @see {@link DescribeScalingActivitiesCommand} + */ + describeScalingActivities( args: DescribeScalingActivitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeScalingActivities( + describeScalingActivities( args: DescribeScalingActivitiesCommandInput, cb: (err: any, data?: DescribeScalingActivitiesCommandOutput) => void ): void; - public describeScalingActivities( + describeScalingActivities( args: DescribeScalingActivitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScalingActivitiesCommandOutput) => void ): void; - public describeScalingActivities( - args: DescribeScalingActivitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeScalingActivitiesCommandOutput) => void), - cb?: (err: any, data?: DescribeScalingActivitiesCommandOutput) => void - ): Promise | void { - const command = new DescribeScalingActivitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the scaling process types for use with the ResumeProcesses - * and SuspendProcesses APIs.

- */ - public describeScalingProcessTypes( + + /** + * @see {@link DescribeScalingProcessTypesCommand} + */ + describeScalingProcessTypes( args: DescribeScalingProcessTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeScalingProcessTypes( + describeScalingProcessTypes( args: DescribeScalingProcessTypesCommandInput, cb: (err: any, data?: DescribeScalingProcessTypesCommandOutput) => void ): void; - public describeScalingProcessTypes( + describeScalingProcessTypes( args: DescribeScalingProcessTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScalingProcessTypesCommandOutput) => void ): void; - public describeScalingProcessTypes( - args: DescribeScalingProcessTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeScalingProcessTypesCommandOutput) => void), - cb?: (err: any, data?: DescribeScalingProcessTypesCommandOutput) => void - ): Promise | void { - const command = new DescribeScalingProcessTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the scheduled actions that haven't run or that have not reached - * their end time.

- *

To describe the scaling activities for scheduled actions that have already run, call - * the DescribeScalingActivities API.

- */ - public describeScheduledActions( + + /** + * @see {@link DescribeScheduledActionsCommand} + */ + describeScheduledActions( args: DescribeScheduledActionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeScheduledActions( + describeScheduledActions( args: DescribeScheduledActionsCommandInput, cb: (err: any, data?: DescribeScheduledActionsCommandOutput) => void ): void; - public describeScheduledActions( + describeScheduledActions( args: DescribeScheduledActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScheduledActionsCommandOutput) => void ): void; - public describeScheduledActions( - args: DescribeScheduledActionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeScheduledActionsCommandOutput) => void), - cb?: (err: any, data?: DescribeScheduledActionsCommandOutput) => void - ): Promise | void { - const command = new DescribeScheduledActionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified tags.

- *

You can use filters to limit the results. For example, you can query for the tags for - * a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at - * least one of the specified values for it to be included in the results.

- *

You can also specify multiple filters. The result includes information for a - * particular tag only if it matches all the filters. If there's no match, no special - * message is returned.

- *

For more information, see Tag Auto Scaling groups and - * instances in the Amazon EC2 Auto Scaling User Guide.

- */ - public describeTags( - args: DescribeTagsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeTags(args: DescribeTagsCommandInput, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void; - public describeTags( + + /** + * @see {@link DescribeTagsCommand} + */ + describeTags(args: DescribeTagsCommandInput, options?: __HttpHandlerOptions): Promise; + describeTags(args: DescribeTagsCommandInput, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void; + describeTags( args: DescribeTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTagsCommandOutput) => void ): void; - public describeTags( - args: DescribeTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTagsCommandOutput) => void), - cb?: (err: any, data?: DescribeTagsCommandOutput) => void - ): Promise | void { - const command = new DescribeTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the termination policies supported by Amazon EC2 Auto Scaling.

- *

For more information, see Work with - * Amazon EC2 Auto Scaling termination policies in the - * Amazon EC2 Auto Scaling User Guide.

- */ - public describeTerminationPolicyTypes( + + /** + * @see {@link DescribeTerminationPolicyTypesCommand} + */ + describeTerminationPolicyTypes( args: DescribeTerminationPolicyTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTerminationPolicyTypes( + describeTerminationPolicyTypes( args: DescribeTerminationPolicyTypesCommandInput, cb: (err: any, data?: DescribeTerminationPolicyTypesCommandOutput) => void ): void; - public describeTerminationPolicyTypes( + describeTerminationPolicyTypes( args: DescribeTerminationPolicyTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTerminationPolicyTypesCommandOutput) => void ): void; - public describeTerminationPolicyTypes( - args: DescribeTerminationPolicyTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTerminationPolicyTypesCommandOutput) => void), - cb?: (err: any, data?: DescribeTerminationPolicyTypesCommandOutput) => void - ): Promise | void { - const command = new DescribeTerminationPolicyTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the traffic sources for the specified Auto Scaling group.

- *

You can optionally provide a traffic source type. If you provide a traffic source - * type, then the results only include that traffic source type.

- *

If you do not provide a traffic source type, then the results include all the traffic - * sources for the specified Auto Scaling group.

- */ - public describeTrafficSources( + + /** + * @see {@link DescribeTrafficSourcesCommand} + */ + describeTrafficSources( args: DescribeTrafficSourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTrafficSources( + describeTrafficSources( args: DescribeTrafficSourcesCommandInput, cb: (err: any, data?: DescribeTrafficSourcesCommandOutput) => void ): void; - public describeTrafficSources( + describeTrafficSources( args: DescribeTrafficSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrafficSourcesCommandOutput) => void ): void; - public describeTrafficSources( - args: DescribeTrafficSourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTrafficSourcesCommandOutput) => void), - cb?: (err: any, data?: DescribeTrafficSourcesCommandOutput) => void - ): Promise | void { - const command = new DescribeTrafficSourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a warm pool and its instances.

- *

For more information, see Warm pools for - * Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

- */ - public describeWarmPool( + + /** + * @see {@link DescribeWarmPoolCommand} + */ + describeWarmPool( args: DescribeWarmPoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWarmPool( + describeWarmPool( args: DescribeWarmPoolCommandInput, cb: (err: any, data?: DescribeWarmPoolCommandOutput) => void ): void; - public describeWarmPool( + describeWarmPool( args: DescribeWarmPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWarmPoolCommandOutput) => void ): void; - public describeWarmPool( - args: DescribeWarmPoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWarmPoolCommandOutput) => void), - cb?: (err: any, data?: DescribeWarmPoolCommandOutput) => void - ): Promise | void { - const command = new DescribeWarmPoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes one or more instances from the specified Auto Scaling group.

- *

After the instances are detached, you can manage them independent of the Auto Scaling - * group.

- *

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches - * instances to replace the ones that are detached.

- *

If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are - * deregistered from the load balancer. If there are target groups attached to the Auto Scaling - * group, the instances are deregistered from the target groups.

- *

For more information, see Detach EC2 instances from - * your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

- */ - public detachInstances( + + /** + * @see {@link DetachInstancesCommand} + */ + detachInstances( args: DetachInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachInstances( - args: DetachInstancesCommandInput, - cb: (err: any, data?: DetachInstancesCommandOutput) => void - ): void; - public detachInstances( + detachInstances(args: DetachInstancesCommandInput, cb: (err: any, data?: DetachInstancesCommandOutput) => void): void; + detachInstances( args: DetachInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachInstancesCommandOutput) => void ): void; - public detachInstances( - args: DetachInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachInstancesCommandOutput) => void), - cb?: (err: any, data?: DetachInstancesCommandOutput) => void - ): Promise | void { - const command = new DetachInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This API operation is superseded by DetachTrafficSources, which - * can detach multiple traffic sources types. We recommend using - * DetachTrafficSources to simplify how you manage traffic sources. - * However, we continue to support DetachLoadBalancers. You can use both - * the original DetachLoadBalancers API operation and - * DetachTrafficSources on the same Auto Scaling group.

- *
- *

Detaches one or more Classic Load Balancers from the specified Auto Scaling group.

- *

This operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or - * Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API instead.

- *

When you detach a load balancer, it enters the Removing state while - * deregistering the instances in the group. When all instances are deregistered, then you - * can no longer describe the load balancer using the DescribeLoadBalancers API call. The instances remain running.

- */ - public detachLoadBalancers( + + /** + * @see {@link DetachLoadBalancersCommand} + */ + detachLoadBalancers( args: DetachLoadBalancersCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachLoadBalancers( + detachLoadBalancers( args: DetachLoadBalancersCommandInput, cb: (err: any, data?: DetachLoadBalancersCommandOutput) => void ): void; - public detachLoadBalancers( + detachLoadBalancers( args: DetachLoadBalancersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachLoadBalancersCommandOutput) => void ): void; - public detachLoadBalancers( - args: DetachLoadBalancersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachLoadBalancersCommandOutput) => void), - cb?: (err: any, data?: DetachLoadBalancersCommandOutput) => void - ): Promise | void { - const command = new DetachLoadBalancersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This API operation is superseded by DetachTrafficSources, which - * can detach multiple traffic sources types. We recommend using - * DetachTrafficSources to simplify how you manage traffic sources. - * However, we continue to support DetachLoadBalancerTargetGroups. You can - * use both the original DetachLoadBalancerTargetGroups API operation and - * DetachTrafficSources on the same Auto Scaling group.

- *
- *

Detaches one or more target groups from the specified Auto Scaling group.

- *

When you detach a target group, it enters the Removing state while - * deregistering the instances in the group. When all instances are deregistered, then you - * can no longer describe the target group using the DescribeLoadBalancerTargetGroups API call. The instances remain - * running.

- * - *

You can use this operation to detach target groups that were attached by using - * AttachLoadBalancerTargetGroups, but not for target groups that - * were attached by using AttachTrafficSources.

- *
- */ - public detachLoadBalancerTargetGroups( + + /** + * @see {@link DetachLoadBalancerTargetGroupsCommand} + */ + detachLoadBalancerTargetGroups( args: DetachLoadBalancerTargetGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachLoadBalancerTargetGroups( + detachLoadBalancerTargetGroups( args: DetachLoadBalancerTargetGroupsCommandInput, cb: (err: any, data?: DetachLoadBalancerTargetGroupsCommandOutput) => void ): void; - public detachLoadBalancerTargetGroups( + detachLoadBalancerTargetGroups( args: DetachLoadBalancerTargetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachLoadBalancerTargetGroupsCommandOutput) => void ): void; - public detachLoadBalancerTargetGroups( - args: DetachLoadBalancerTargetGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachLoadBalancerTargetGroupsCommandOutput) => void), - cb?: (err: any, data?: DetachLoadBalancerTargetGroupsCommandOutput) => void - ): Promise | void { - const command = new DetachLoadBalancerTargetGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detaches one or more traffic sources from the specified Auto Scaling group.

- *

When you detach a taffic, it enters the Removing state while - * deregistering the instances in the group. When all instances are deregistered, then you - * can no longer describe the traffic source using the DescribeTrafficSources API call. The instances continue to run.

- */ - public detachTrafficSources( + + /** + * @see {@link DetachTrafficSourcesCommand} + */ + detachTrafficSources( args: DetachTrafficSourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachTrafficSources( + detachTrafficSources( args: DetachTrafficSourcesCommandInput, cb: (err: any, data?: DetachTrafficSourcesCommandOutput) => void ): void; - public detachTrafficSources( + detachTrafficSources( args: DetachTrafficSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachTrafficSourcesCommandOutput) => void ): void; - public detachTrafficSources( - args: DetachTrafficSourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachTrafficSourcesCommandOutput) => void), - cb?: (err: any, data?: DetachTrafficSourcesCommandOutput) => void - ): Promise | void { - const command = new DetachTrafficSourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables group metrics collection for the specified Auto Scaling group.

- */ - public disableMetricsCollection( + + /** + * @see {@link DisableMetricsCollectionCommand} + */ + disableMetricsCollection( args: DisableMetricsCollectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableMetricsCollection( + disableMetricsCollection( args: DisableMetricsCollectionCommandInput, cb: (err: any, data?: DisableMetricsCollectionCommandOutput) => void ): void; - public disableMetricsCollection( + disableMetricsCollection( args: DisableMetricsCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableMetricsCollectionCommandOutput) => void ): void; - public disableMetricsCollection( - args: DisableMetricsCollectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableMetricsCollectionCommandOutput) => void), - cb?: (err: any, data?: DisableMetricsCollectionCommandOutput) => void - ): Promise | void { - const command = new DisableMetricsCollectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables group metrics collection for the specified Auto Scaling group.

- *

You can use these metrics to track changes in an Auto Scaling group and to set alarms on - * threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch - * console. For more information, see Monitor - * CloudWatch metrics for your Auto Scaling groups and instances in the - * Amazon EC2 Auto Scaling User Guide.

- */ - public enableMetricsCollection( + + /** + * @see {@link EnableMetricsCollectionCommand} + */ + enableMetricsCollection( args: EnableMetricsCollectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableMetricsCollection( + enableMetricsCollection( args: EnableMetricsCollectionCommandInput, cb: (err: any, data?: EnableMetricsCollectionCommandOutput) => void ): void; - public enableMetricsCollection( + enableMetricsCollection( args: EnableMetricsCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableMetricsCollectionCommandOutput) => void ): void; - public enableMetricsCollection( - args: EnableMetricsCollectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableMetricsCollectionCommandOutput) => void), - cb?: (err: any, data?: EnableMetricsCollectionCommandOutput) => void - ): Promise | void { - const command = new EnableMetricsCollectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Moves the specified instances into the standby state.

- *

If you choose to decrement the desired capacity of the Auto Scaling group, the instances can - * enter standby as long as the desired capacity of the Auto Scaling group after the instances are - * placed into standby is equal to or greater than the minimum capacity of the - * group.

- *

If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group - * launches new instances to replace the instances on standby.

- *

For more information, see Temporarily removing - * instances from your Auto Scaling group in the - * Amazon EC2 Auto Scaling User Guide.

- */ - public enterStandby( - args: EnterStandbyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public enterStandby(args: EnterStandbyCommandInput, cb: (err: any, data?: EnterStandbyCommandOutput) => void): void; - public enterStandby( + + /** + * @see {@link EnterStandbyCommand} + */ + enterStandby(args: EnterStandbyCommandInput, options?: __HttpHandlerOptions): Promise; + enterStandby(args: EnterStandbyCommandInput, cb: (err: any, data?: EnterStandbyCommandOutput) => void): void; + enterStandby( args: EnterStandbyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnterStandbyCommandOutput) => void ): void; - public enterStandby( - args: EnterStandbyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnterStandbyCommandOutput) => void), - cb?: (err: any, data?: EnterStandbyCommandOutput) => void - ): Promise | void { - const command = new EnterStandbyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Executes the specified policy. This can be useful for testing the design of your - * scaling policy.

- */ - public executePolicy( - args: ExecutePolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public executePolicy( - args: ExecutePolicyCommandInput, - cb: (err: any, data?: ExecutePolicyCommandOutput) => void - ): void; - public executePolicy( + + /** + * @see {@link ExecutePolicyCommand} + */ + executePolicy(args: ExecutePolicyCommandInput, options?: __HttpHandlerOptions): Promise; + executePolicy(args: ExecutePolicyCommandInput, cb: (err: any, data?: ExecutePolicyCommandOutput) => void): void; + executePolicy( args: ExecutePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecutePolicyCommandOutput) => void ): void; - public executePolicy( - args: ExecutePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExecutePolicyCommandOutput) => void), - cb?: (err: any, data?: ExecutePolicyCommandOutput) => void - ): Promise | void { - const command = new ExecutePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Moves the specified instances out of the standby state.

- *

After you put the instances back in service, the desired capacity is - * incremented.

- *

For more information, see Temporarily removing - * instances from your Auto Scaling group in the - * Amazon EC2 Auto Scaling User Guide.

- */ - public exitStandby(args: ExitStandbyCommandInput, options?: __HttpHandlerOptions): Promise; - public exitStandby(args: ExitStandbyCommandInput, cb: (err: any, data?: ExitStandbyCommandOutput) => void): void; - public exitStandby( + + /** + * @see {@link ExitStandbyCommand} + */ + exitStandby(args: ExitStandbyCommandInput, options?: __HttpHandlerOptions): Promise; + exitStandby(args: ExitStandbyCommandInput, cb: (err: any, data?: ExitStandbyCommandOutput) => void): void; + exitStandby( args: ExitStandbyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExitStandbyCommandOutput) => void ): void; - public exitStandby( - args: ExitStandbyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExitStandbyCommandOutput) => void), - cb?: (err: any, data?: ExitStandbyCommandOutput) => void - ): Promise | void { - const command = new ExitStandbyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the forecast data for a predictive scaling policy.

- *

Load forecasts are predictions of the hourly load values using historical load data - * from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as - * predicted values for the minimum capacity that is needed on an hourly basis, based on - * the hourly load forecast.

- *

A minimum of 24 hours of data is required to create the initial forecasts. However, - * having a full 14 days of historical data results in more accurate forecasts.

- *

For more information, see Predictive - * scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

- */ - public getPredictiveScalingForecast( + + /** + * @see {@link GetPredictiveScalingForecastCommand} + */ + getPredictiveScalingForecast( args: GetPredictiveScalingForecastCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPredictiveScalingForecast( + getPredictiveScalingForecast( args: GetPredictiveScalingForecastCommandInput, cb: (err: any, data?: GetPredictiveScalingForecastCommandOutput) => void ): void; - public getPredictiveScalingForecast( + getPredictiveScalingForecast( args: GetPredictiveScalingForecastCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPredictiveScalingForecastCommandOutput) => void ): void; - public getPredictiveScalingForecast( - args: GetPredictiveScalingForecastCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPredictiveScalingForecastCommandOutput) => void), - cb?: (err: any, data?: GetPredictiveScalingForecastCommandOutput) => void - ): Promise | void { - const command = new GetPredictiveScalingForecastCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or updates a lifecycle hook for the specified Auto Scaling group.

- *

Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance - * lifecycle, and then perform a custom action on instances when the corresponding - * lifecycle event occurs.

- *

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling - * group:

- *
    - *
  1. - *

    (Optional) Create a launch template or launch configuration with a user data - * script that runs while an instance is in a wait state due to a lifecycle - * hook.

    - *
  2. - *
  3. - *

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke - * your Lambda function when an instance is put into a wait state due to a - * lifecycle hook.

    - *
  4. - *
  5. - *

    (Optional) Create a notification target and an IAM role. The target can be - * either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish - * lifecycle notifications to the target.

    - *
  6. - *
  7. - *

    - * Create the lifecycle hook. Specify whether the hook is - * used when the instances launch or terminate. - *

    - *
  8. - *
  9. - *

    If you need more time, record the lifecycle action heartbeat to keep the - * instance in a wait state using the RecordLifecycleActionHeartbeat API call.

    - *
  10. - *
  11. - *

    If you finish before the timeout period ends, send a callback by using the - * CompleteLifecycleAction API call.

    - *
  12. - *
- *

For more information, see Amazon EC2 Auto Scaling lifecycle - * hooks in the Amazon EC2 Auto Scaling User Guide.

- *

If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling - * group, the call fails.

- *

You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle - * hook, you can delete it by calling the DeleteLifecycleHook API.

- */ - public putLifecycleHook( + + /** + * @see {@link PutLifecycleHookCommand} + */ + putLifecycleHook( args: PutLifecycleHookCommandInput, options?: __HttpHandlerOptions ): Promise; - public putLifecycleHook( + putLifecycleHook( args: PutLifecycleHookCommandInput, cb: (err: any, data?: PutLifecycleHookCommandOutput) => void ): void; - public putLifecycleHook( + putLifecycleHook( args: PutLifecycleHookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLifecycleHookCommandOutput) => void ): void; - public putLifecycleHook( - args: PutLifecycleHookCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutLifecycleHookCommandOutput) => void), - cb?: (err: any, data?: PutLifecycleHookCommandOutput) => void - ): Promise | void { - const command = new PutLifecycleHookCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Configures an Auto Scaling group to send notifications when specified events take place. - * Subscribers to the specified topic can have messages delivered to an endpoint such as a - * web server or an email address.

- *

This configuration overwrites any existing configuration.

- *

For more information, see Getting Amazon SNS - * notifications when your Auto Scaling group scales in the - * Amazon EC2 Auto Scaling User Guide.

- *

If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call - * fails.

- */ - public putNotificationConfiguration( + + /** + * @see {@link PutNotificationConfigurationCommand} + */ + putNotificationConfiguration( args: PutNotificationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putNotificationConfiguration( + putNotificationConfiguration( args: PutNotificationConfigurationCommandInput, cb: (err: any, data?: PutNotificationConfigurationCommandOutput) => void ): void; - public putNotificationConfiguration( + putNotificationConfiguration( args: PutNotificationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutNotificationConfigurationCommandOutput) => void ): void; - public putNotificationConfiguration( - args: PutNotificationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutNotificationConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutNotificationConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutNotificationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to - * scale an Auto Scaling group based on configurable metrics. If no policies are defined, the - * dynamic scaling and predictive scaling features are not used.

- *

For more information about using dynamic scaling, see Target tracking - * scaling policies and Step and simple scaling - * policies in the Amazon EC2 Auto Scaling User Guide.

- *

For more information about using predictive scaling, see Predictive - * scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

- *

You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy, - * you can delete it by calling the DeletePolicy API.

- */ - public putScalingPolicy( + + /** + * @see {@link PutScalingPolicyCommand} + */ + putScalingPolicy( args: PutScalingPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putScalingPolicy( + putScalingPolicy( args: PutScalingPolicyCommandInput, cb: (err: any, data?: PutScalingPolicyCommandOutput) => void ): void; - public putScalingPolicy( + putScalingPolicy( args: PutScalingPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutScalingPolicyCommandOutput) => void ): void; - public putScalingPolicy( - args: PutScalingPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutScalingPolicyCommandOutput) => void), - cb?: (err: any, data?: PutScalingPolicyCommandOutput) => void - ): Promise | void { - const command = new PutScalingPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or updates a scheduled scaling action for an Auto Scaling group.

- *

For more information, see Scheduled scaling in the - * Amazon EC2 Auto Scaling User Guide.

- *

You can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a - * scheduled action, you can delete it by calling the DeleteScheduledAction API.

- *

If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error - * message.

- */ - public putScheduledUpdateGroupAction( + + /** + * @see {@link PutScheduledUpdateGroupActionCommand} + */ + putScheduledUpdateGroupAction( args: PutScheduledUpdateGroupActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public putScheduledUpdateGroupAction( + putScheduledUpdateGroupAction( args: PutScheduledUpdateGroupActionCommandInput, cb: (err: any, data?: PutScheduledUpdateGroupActionCommandOutput) => void ): void; - public putScheduledUpdateGroupAction( + putScheduledUpdateGroupAction( args: PutScheduledUpdateGroupActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutScheduledUpdateGroupActionCommandOutput) => void ): void; - public putScheduledUpdateGroupAction( - args: PutScheduledUpdateGroupActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutScheduledUpdateGroupActionCommandOutput) => void), - cb?: (err: any, data?: PutScheduledUpdateGroupActionCommandOutput) => void - ): Promise | void { - const command = new PutScheduledUpdateGroupActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of - * pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your - * application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new - * desired capacity. For more information and example configurations, see Warm pools for - * Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

- *

This operation must be called from the Region in which the Auto Scaling group was created. - * This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a - * launch template or launch configuration that requests Spot Instances.

- *

You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the - * DeleteWarmPool API.

- */ - public putWarmPool(args: PutWarmPoolCommandInput, options?: __HttpHandlerOptions): Promise; - public putWarmPool(args: PutWarmPoolCommandInput, cb: (err: any, data?: PutWarmPoolCommandOutput) => void): void; - public putWarmPool( + + /** + * @see {@link PutWarmPoolCommand} + */ + putWarmPool(args: PutWarmPoolCommandInput, options?: __HttpHandlerOptions): Promise; + putWarmPool(args: PutWarmPoolCommandInput, cb: (err: any, data?: PutWarmPoolCommandOutput) => void): void; + putWarmPool( args: PutWarmPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutWarmPoolCommandOutput) => void ): void; - public putWarmPool( - args: PutWarmPoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutWarmPoolCommandOutput) => void), - cb?: (err: any, data?: PutWarmPoolCommandOutput) => void - ): Promise | void { - const command = new PutWarmPoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Records a heartbeat for the lifecycle action associated with the specified token or - * instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.

- *

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling - * group:

- *
    - *
  1. - *

    (Optional) Create a launch template or launch configuration with a user data - * script that runs while an instance is in a wait state due to a lifecycle - * hook.

    - *
  2. - *
  3. - *

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke - * your Lambda function when an instance is put into a wait state due to a - * lifecycle hook.

    - *
  4. - *
  5. - *

    (Optional) Create a notification target and an IAM role. The target can be - * either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish - * lifecycle notifications to the target.

    - *
  6. - *
  7. - *

    Create the lifecycle hook. Specify whether the hook is used when the instances - * launch or terminate.

    - *
  8. - *
  9. - *

    - * If you need more time, record the lifecycle action - * heartbeat to keep the instance in a wait state. - *

    - *
  10. - *
  11. - *

    If you finish before the timeout period ends, send a callback by using the - * CompleteLifecycleAction API call.

    - *
  12. - *
- *

For more information, see Amazon EC2 Auto Scaling lifecycle - * hooks in the Amazon EC2 Auto Scaling User Guide.

- */ - public recordLifecycleActionHeartbeat( + + /** + * @see {@link RecordLifecycleActionHeartbeatCommand} + */ + recordLifecycleActionHeartbeat( args: RecordLifecycleActionHeartbeatCommandInput, options?: __HttpHandlerOptions ): Promise; - public recordLifecycleActionHeartbeat( + recordLifecycleActionHeartbeat( args: RecordLifecycleActionHeartbeatCommandInput, cb: (err: any, data?: RecordLifecycleActionHeartbeatCommandOutput) => void ): void; - public recordLifecycleActionHeartbeat( + recordLifecycleActionHeartbeat( args: RecordLifecycleActionHeartbeatCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RecordLifecycleActionHeartbeatCommandOutput) => void ): void; - public recordLifecycleActionHeartbeat( - args: RecordLifecycleActionHeartbeatCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RecordLifecycleActionHeartbeatCommandOutput) => void), - cb?: (err: any, data?: RecordLifecycleActionHeartbeatCommandOutput) => void - ): Promise | void { - const command = new RecordLifecycleActionHeartbeatCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Resumes the specified suspended auto scaling processes, or all suspended process, for - * the specified Auto Scaling group.

- *

For more information, see Suspending and - * resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.

- */ - public resumeProcesses( + + /** + * @see {@link ResumeProcessesCommand} + */ + resumeProcesses( args: ResumeProcessesCommandInput, options?: __HttpHandlerOptions ): Promise; - public resumeProcesses( - args: ResumeProcessesCommandInput, - cb: (err: any, data?: ResumeProcessesCommandOutput) => void - ): void; - public resumeProcesses( + resumeProcesses(args: ResumeProcessesCommandInput, cb: (err: any, data?: ResumeProcessesCommandOutput) => void): void; + resumeProcesses( args: ResumeProcessesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResumeProcessesCommandOutput) => void ): void; - public resumeProcesses( - args: ResumeProcessesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResumeProcessesCommandOutput) => void), - cb?: (err: any, data?: ResumeProcessesCommandOutput) => void - ): Promise | void { - const command = new ResumeProcessesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels an instance refresh that is in progress and rolls back any changes that it - * made. Amazon EC2 Auto Scaling replaces any instances that were replaced during the instance refresh. - * This restores your Auto Scaling group to the configuration that it was using before the start of - * the instance refresh.

- *

This operation is part of the instance refresh - * feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group - * after you make configuration changes.

- *

A rollback is not supported in the following situations:

- *
    - *
  • - *

    There is no desired configuration specified for the instance refresh.

    - *
  • - *
  • - *

    The Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager parameter instead - * of an AMI ID for the ImageId property.

    - *
  • - *
  • - *

    The Auto Scaling group uses the launch template's $Latest or - * $Default version.

    - *
  • - *
- *

When you receive a successful response from this operation, Amazon EC2 Auto Scaling immediately - * begins replacing instances. You can check the status of this operation through the DescribeInstanceRefreshes API operation.

- */ - public rollbackInstanceRefresh( + + /** + * @see {@link RollbackInstanceRefreshCommand} + */ + rollbackInstanceRefresh( args: RollbackInstanceRefreshCommandInput, options?: __HttpHandlerOptions ): Promise; - public rollbackInstanceRefresh( + rollbackInstanceRefresh( args: RollbackInstanceRefreshCommandInput, cb: (err: any, data?: RollbackInstanceRefreshCommandOutput) => void ): void; - public rollbackInstanceRefresh( + rollbackInstanceRefresh( args: RollbackInstanceRefreshCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RollbackInstanceRefreshCommandOutput) => void ): void; - public rollbackInstanceRefresh( - args: RollbackInstanceRefreshCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RollbackInstanceRefreshCommandOutput) => void), - cb?: (err: any, data?: RollbackInstanceRefreshCommandOutput) => void - ): Promise | void { - const command = new RollbackInstanceRefreshCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the size of the specified Auto Scaling group.

- *

If a scale-in activity occurs as a result of a new DesiredCapacity value - * that is lower than the current size of the group, the Auto Scaling group uses its termination - * policy to determine which instances to terminate.

- *

For more information, see Manual scaling in the - * Amazon EC2 Auto Scaling User Guide.

- */ - public setDesiredCapacity( + + /** + * @see {@link SetDesiredCapacityCommand} + */ + setDesiredCapacity( args: SetDesiredCapacityCommandInput, options?: __HttpHandlerOptions ): Promise; - public setDesiredCapacity( + setDesiredCapacity( args: SetDesiredCapacityCommandInput, cb: (err: any, data?: SetDesiredCapacityCommandOutput) => void ): void; - public setDesiredCapacity( + setDesiredCapacity( args: SetDesiredCapacityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetDesiredCapacityCommandOutput) => void ): void; - public setDesiredCapacity( - args: SetDesiredCapacityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetDesiredCapacityCommandOutput) => void), - cb?: (err: any, data?: SetDesiredCapacityCommandOutput) => void - ): Promise | void { - const command = new SetDesiredCapacityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the health status of the specified instance.

- *

For more information, see Health checks for Auto Scaling - * instances in the Amazon EC2 Auto Scaling User Guide.

- */ - public setInstanceHealth( + + /** + * @see {@link SetInstanceHealthCommand} + */ + setInstanceHealth( args: SetInstanceHealthCommandInput, options?: __HttpHandlerOptions ): Promise; - public setInstanceHealth( + setInstanceHealth( args: SetInstanceHealthCommandInput, cb: (err: any, data?: SetInstanceHealthCommandOutput) => void ): void; - public setInstanceHealth( + setInstanceHealth( args: SetInstanceHealthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetInstanceHealthCommandOutput) => void ): void; - public setInstanceHealth( - args: SetInstanceHealthCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetInstanceHealthCommandOutput) => void), - cb?: (err: any, data?: SetInstanceHealthCommandOutput) => void - ): Promise | void { - const command = new SetInstanceHealthCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the instance protection settings of the specified instances. This operation - * cannot be called on instances in a warm pool.

- *

For more information about preventing instances that are part of an Auto Scaling group from - * terminating on scale in, see Using - * instance scale-in protection in the - * Amazon EC2 Auto Scaling User Guide.

- *

If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call - * fails.

- */ - public setInstanceProtection( + + /** + * @see {@link SetInstanceProtectionCommand} + */ + setInstanceProtection( args: SetInstanceProtectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public setInstanceProtection( + setInstanceProtection( args: SetInstanceProtectionCommandInput, cb: (err: any, data?: SetInstanceProtectionCommandOutput) => void ): void; - public setInstanceProtection( + setInstanceProtection( args: SetInstanceProtectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetInstanceProtectionCommandOutput) => void ): void; - public setInstanceProtection( - args: SetInstanceProtectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetInstanceProtectionCommandOutput) => void), - cb?: (err: any, data?: SetInstanceProtectionCommandOutput) => void - ): Promise | void { - const command = new SetInstanceProtectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts an instance refresh. During an instance refresh, Amazon EC2 Auto Scaling performs a rolling - * update of instances in an Auto Scaling group. Instances are terminated first and then replaced, - * which temporarily reduces the capacity available within your Auto Scaling group.

- *

This operation is part of the instance refresh - * feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group. - * This feature is helpful, for example, when you have a new AMI or a new user data script. - * You just need to create a new launch template that specifies the new AMI or user data - * script. Then start an instance refresh to immediately begin the process of updating - * instances in the group.

- *

If successful, the request's response contains a unique ID that you can use to track - * the progress of the instance refresh. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that - * have already run, call the DescribeInstanceRefreshes API. To cancel an - * instance refresh that is in progress, use the CancelInstanceRefresh - * API.

- *

An instance refresh might fail for several reasons, such as EC2 launch failures, - * misconfigured health checks, or not ignoring or allowing the termination of instances - * that are in Standby state or protected from scale in. You can monitor for - * failed EC2 launches using the scaling activities. To find the scaling activities, call - * the DescribeScalingActivities API.

- *

If you enable auto rollback, your Auto Scaling group will be rolled back automatically when - * the instance refresh fails. You can enable this feature before starting an instance - * refresh by specifying the AutoRollback property in the instance refresh - * preferences. Otherwise, to roll back an instance refresh before it finishes, use the - * RollbackInstanceRefresh API.

- */ - public startInstanceRefresh( + + /** + * @see {@link StartInstanceRefreshCommand} + */ + startInstanceRefresh( args: StartInstanceRefreshCommandInput, options?: __HttpHandlerOptions ): Promise; - public startInstanceRefresh( + startInstanceRefresh( args: StartInstanceRefreshCommandInput, cb: (err: any, data?: StartInstanceRefreshCommandOutput) => void ): void; - public startInstanceRefresh( + startInstanceRefresh( args: StartInstanceRefreshCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartInstanceRefreshCommandOutput) => void ): void; - public startInstanceRefresh( - args: StartInstanceRefreshCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartInstanceRefreshCommandOutput) => void), - cb?: (err: any, data?: StartInstanceRefreshCommandOutput) => void - ): Promise | void { - const command = new StartInstanceRefreshCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Suspends the specified auto scaling processes, or all processes, for the specified - * Auto Scaling group.

- *

If you suspend either the Launch or Terminate process types, - * it can prevent other process types from functioning properly. For more information, see - * Suspending and - * resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.

- *

To resume processes that have been suspended, call the ResumeProcesses API.

- */ - public suspendProcesses( + + /** + * @see {@link SuspendProcessesCommand} + */ + suspendProcesses( args: SuspendProcessesCommandInput, options?: __HttpHandlerOptions ): Promise; - public suspendProcesses( + suspendProcesses( args: SuspendProcessesCommandInput, cb: (err: any, data?: SuspendProcessesCommandOutput) => void ): void; - public suspendProcesses( + suspendProcesses( args: SuspendProcessesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SuspendProcessesCommandOutput) => void ): void; - public suspendProcesses( - args: SuspendProcessesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SuspendProcessesCommandOutput) => void), - cb?: (err: any, data?: SuspendProcessesCommandOutput) => void - ): Promise | void { - const command = new SuspendProcessesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Terminates the specified instance and optionally adjusts the desired group size. This - * operation cannot be called on instances in a warm pool.

- *

This call simply makes a termination request. The instance is not terminated - * immediately. When an instance is terminated, the instance status changes to - * terminated. You can't connect to or start an instance after you've - * terminated it.

- *

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches - * instances to replace the ones that are terminated.

- *

By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you - * decrement the desired capacity, your Auto Scaling group can become unbalanced between - * Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might - * terminate instances in other zones. For more information, see Rebalancing activities in the Amazon EC2 Auto Scaling User Guide.

- */ - public terminateInstanceInAutoScalingGroup( + + /** + * @see {@link TerminateInstanceInAutoScalingGroupCommand} + */ + terminateInstanceInAutoScalingGroup( args: TerminateInstanceInAutoScalingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public terminateInstanceInAutoScalingGroup( + terminateInstanceInAutoScalingGroup( args: TerminateInstanceInAutoScalingGroupCommandInput, cb: (err: any, data?: TerminateInstanceInAutoScalingGroupCommandOutput) => void ): void; - public terminateInstanceInAutoScalingGroup( + terminateInstanceInAutoScalingGroup( args: TerminateInstanceInAutoScalingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TerminateInstanceInAutoScalingGroupCommandOutput) => void ): void; - public terminateInstanceInAutoScalingGroup( - args: TerminateInstanceInAutoScalingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TerminateInstanceInAutoScalingGroupCommandOutput) => void), - cb?: (err: any, data?: TerminateInstanceInAutoScalingGroupCommandOutput) => void - ): Promise | void { - const command = new TerminateInstanceInAutoScalingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2. - *

- *

Updates the configuration for the specified Auto Scaling group.

- *

To update an Auto Scaling group, specify the name of the group and the property that you want - * to change. Any properties that you don't specify are not changed by this update request. - * The new settings take effect on any scaling activities after this call returns. - *

- *

If you associate a new launch configuration or template with an Auto Scaling group, all new - * instances will get the updated configuration. Existing instances continue to run with - * the configuration that they were originally launched with. When you update a group to - * specify a mixed instances policy instead of a launch configuration or template, existing - * instances may be replaced to match the new purchasing options that you specified in the - * policy. For example, if the group currently has 100% On-Demand capacity and the policy - * specifies 50% Spot capacity, this means that half of your instances will be gradually - * terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches - * new instances before terminating the old ones, so that updating your group does not - * compromise the performance or availability of your application.

- *

Note the following about changing DesiredCapacity, MaxSize, - * or MinSize:

- *
    - *
  • - *

    If a scale-in activity occurs as a result of a new - * DesiredCapacity value that is lower than the current size of - * the group, the Auto Scaling group uses its termination policy to determine which - * instances to terminate.

    - *
  • - *
  • - *

    If you specify a new value for MinSize without specifying a value - * for DesiredCapacity, and the new MinSize is larger - * than the current size of the group, this sets the group's - * DesiredCapacity to the new MinSize value.

    - *
  • - *
  • - *

    If you specify a new value for MaxSize without specifying a value - * for DesiredCapacity, and the new MaxSize is smaller - * than the current size of the group, this sets the group's - * DesiredCapacity to the new MaxSize value.

    - *
  • - *
- *

To see which properties have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling - * group, call the DescribePolicies API. If the group has scaling - * policies, you can update them by calling the PutScalingPolicy - * API.

- */ - public updateAutoScalingGroup( + + /** + * @see {@link UpdateAutoScalingGroupCommand} + */ + updateAutoScalingGroup( args: UpdateAutoScalingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAutoScalingGroup( + updateAutoScalingGroup( args: UpdateAutoScalingGroupCommandInput, cb: (err: any, data?: UpdateAutoScalingGroupCommandOutput) => void ): void; - public updateAutoScalingGroup( + updateAutoScalingGroup( args: UpdateAutoScalingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAutoScalingGroupCommandOutput) => void ): void; - public updateAutoScalingGroup( - args: UpdateAutoScalingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAutoScalingGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateAutoScalingGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateAutoScalingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon EC2 Auto Scaling + *

Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances + * based on user-defined scaling policies, scheduled actions, and health checks.

+ *

For more information, see the Amazon EC2 Auto Scaling User Guide and the Amazon EC2 Auto Scaling API Reference.

+ */ +export class AutoScaling extends AutoScalingClient implements AutoScaling {} +createAggregatedClient(commands, AutoScaling); diff --git a/clients/client-backup-gateway/src/BackupGateway.ts b/clients/client-backup-gateway/src/BackupGateway.ts index f05b4cd8be1c..07b0d23a7e4b 100644 --- a/clients/client-backup-gateway/src/BackupGateway.ts +++ b/clients/client-backup-gateway/src/BackupGateway.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { BackupGatewayClient } from "./BackupGatewayClient"; +import { BackupGatewayClient, BackupGatewayClientConfig } from "./BackupGatewayClient"; import { AssociateGatewayToServerCommand, AssociateGatewayToServerCommandInput, @@ -120,853 +121,427 @@ import { UpdateHypervisorCommandOutput, } from "./commands/UpdateHypervisorCommand"; -/** - * @public - * Backup gateway - *

Backup gateway connects Backup to your hypervisor, so you can - * create, store, and restore backups of your virtual machines (VMs) anywhere, whether - * on-premises or in the VMware Cloud (VMC) on Amazon Web Services.

- *

Add on-premises resources by connecting to a hypervisor through a gateway. Backup will automatically discover the resources in your hypervisor.

- *

Use Backup to assign virtual or on-premises resources to a backup plan, or run - * on-demand backups. Once you have backed up your resources, you can view them and restore them - * like any resource supported by Backup.

- *

To download the Amazon Web Services software to get started, navigate to the Backup console, choose Gateways, then choose Create gateway.

- */ -export class BackupGateway extends BackupGatewayClient { +const commands = { + AssociateGatewayToServerCommand, + CreateGatewayCommand, + DeleteGatewayCommand, + DeleteHypervisorCommand, + DisassociateGatewayFromServerCommand, + GetBandwidthRateLimitScheduleCommand, + GetGatewayCommand, + GetHypervisorCommand, + GetHypervisorPropertyMappingsCommand, + GetVirtualMachineCommand, + ImportHypervisorConfigurationCommand, + ListGatewaysCommand, + ListHypervisorsCommand, + ListTagsForResourceCommand, + ListVirtualMachinesCommand, + PutBandwidthRateLimitScheduleCommand, + PutHypervisorPropertyMappingsCommand, + PutMaintenanceStartTimeCommand, + StartVirtualMachinesMetadataSyncCommand, + TagResourceCommand, + TestHypervisorConfigurationCommand, + UntagResourceCommand, + UpdateGatewayInformationCommand, + UpdateGatewaySoftwareNowCommand, + UpdateHypervisorCommand, +}; + +export interface BackupGateway { /** - * @public - *

Associates a backup gateway with your server. After you complete the association process, - * you can back up and restore your VMs through the gateway.

+ * @see {@link AssociateGatewayToServerCommand} */ - public associateGatewayToServer( + associateGatewayToServer( args: AssociateGatewayToServerCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateGatewayToServer( + associateGatewayToServer( args: AssociateGatewayToServerCommandInput, cb: (err: any, data?: AssociateGatewayToServerCommandOutput) => void ): void; - public associateGatewayToServer( + associateGatewayToServer( args: AssociateGatewayToServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateGatewayToServerCommandOutput) => void ): void; - public associateGatewayToServer( - args: AssociateGatewayToServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateGatewayToServerCommandOutput) => void), - cb?: (err: any, data?: AssociateGatewayToServerCommandOutput) => void - ): Promise | void { - const command = new AssociateGatewayToServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a backup gateway. After you create a gateway, you can associate it with a server - * using the AssociateGatewayToServer operation.

+ * @see {@link CreateGatewayCommand} */ - public createGateway( - args: CreateGatewayCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createGateway( - args: CreateGatewayCommandInput, - cb: (err: any, data?: CreateGatewayCommandOutput) => void - ): void; - public createGateway( + createGateway(args: CreateGatewayCommandInput, options?: __HttpHandlerOptions): Promise; + createGateway(args: CreateGatewayCommandInput, cb: (err: any, data?: CreateGatewayCommandOutput) => void): void; + createGateway( args: CreateGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGatewayCommandOutput) => void ): void; - public createGateway( - args: CreateGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGatewayCommandOutput) => void), - cb?: (err: any, data?: CreateGatewayCommandOutput) => void - ): Promise | void { - const command = new CreateGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a backup gateway.

+ * @see {@link DeleteGatewayCommand} */ - public deleteGateway( - args: DeleteGatewayCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteGateway( - args: DeleteGatewayCommandInput, - cb: (err: any, data?: DeleteGatewayCommandOutput) => void - ): void; - public deleteGateway( + deleteGateway(args: DeleteGatewayCommandInput, options?: __HttpHandlerOptions): Promise; + deleteGateway(args: DeleteGatewayCommandInput, cb: (err: any, data?: DeleteGatewayCommandOutput) => void): void; + deleteGateway( args: DeleteGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGatewayCommandOutput) => void ): void; - public deleteGateway( - args: DeleteGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGatewayCommandOutput) => void), - cb?: (err: any, data?: DeleteGatewayCommandOutput) => void - ): Promise | void { - const command = new DeleteGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a hypervisor.

+ * @see {@link DeleteHypervisorCommand} */ - public deleteHypervisor( + deleteHypervisor( args: DeleteHypervisorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteHypervisor( + deleteHypervisor( args: DeleteHypervisorCommandInput, cb: (err: any, data?: DeleteHypervisorCommandOutput) => void ): void; - public deleteHypervisor( + deleteHypervisor( args: DeleteHypervisorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHypervisorCommandOutput) => void ): void; - public deleteHypervisor( - args: DeleteHypervisorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteHypervisorCommandOutput) => void), - cb?: (err: any, data?: DeleteHypervisorCommandOutput) => void - ): Promise | void { - const command = new DeleteHypervisorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates a backup gateway from the specified server. After the disassociation process - * finishes, the gateway can no longer access the virtual machines on the server.

+ * @see {@link DisassociateGatewayFromServerCommand} */ - public disassociateGatewayFromServer( + disassociateGatewayFromServer( args: DisassociateGatewayFromServerCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateGatewayFromServer( + disassociateGatewayFromServer( args: DisassociateGatewayFromServerCommandInput, cb: (err: any, data?: DisassociateGatewayFromServerCommandOutput) => void ): void; - public disassociateGatewayFromServer( + disassociateGatewayFromServer( args: DisassociateGatewayFromServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateGatewayFromServerCommandOutput) => void ): void; - public disassociateGatewayFromServer( - args: DisassociateGatewayFromServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateGatewayFromServerCommandOutput) => void), - cb?: (err: any, data?: DisassociateGatewayFromServerCommandOutput) => void - ): Promise | void { - const command = new DisassociateGatewayFromServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the bandwidth rate limit schedule for a specified gateway. - * By default, gateways do not have bandwidth rate limit schedules, which means - * no bandwidth rate limiting is in effect. Use this to get a gateway's - * bandwidth rate limit schedule.

+ * @see {@link GetBandwidthRateLimitScheduleCommand} */ - public getBandwidthRateLimitSchedule( + getBandwidthRateLimitSchedule( args: GetBandwidthRateLimitScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBandwidthRateLimitSchedule( + getBandwidthRateLimitSchedule( args: GetBandwidthRateLimitScheduleCommandInput, cb: (err: any, data?: GetBandwidthRateLimitScheduleCommandOutput) => void ): void; - public getBandwidthRateLimitSchedule( + getBandwidthRateLimitSchedule( args: GetBandwidthRateLimitScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBandwidthRateLimitScheduleCommandOutput) => void ): void; - public getBandwidthRateLimitSchedule( - args: GetBandwidthRateLimitScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBandwidthRateLimitScheduleCommandOutput) => void), - cb?: (err: any, data?: GetBandwidthRateLimitScheduleCommandOutput) => void - ): Promise | void { - const command = new GetBandwidthRateLimitScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

By providing the ARN (Amazon Resource Name), this - * API returns the gateway.

+ * @see {@link GetGatewayCommand} */ - public getGateway(args: GetGatewayCommandInput, options?: __HttpHandlerOptions): Promise; - public getGateway(args: GetGatewayCommandInput, cb: (err: any, data?: GetGatewayCommandOutput) => void): void; - public getGateway( + getGateway(args: GetGatewayCommandInput, options?: __HttpHandlerOptions): Promise; + getGateway(args: GetGatewayCommandInput, cb: (err: any, data?: GetGatewayCommandOutput) => void): void; + getGateway( args: GetGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGatewayCommandOutput) => void ): void; - public getGateway( - args: GetGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGatewayCommandOutput) => void), - cb?: (err: any, data?: GetGatewayCommandOutput) => void - ): Promise | void { - const command = new GetGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This action requests information about the specified hypervisor to which the gateway will connect. - * A hypervisor is hardware, software, or firmware that creates and manages virtual machines, - * and allocates resources to them.

+ * @see {@link GetHypervisorCommand} */ - public getHypervisor( - args: GetHypervisorCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getHypervisor( - args: GetHypervisorCommandInput, - cb: (err: any, data?: GetHypervisorCommandOutput) => void - ): void; - public getHypervisor( + getHypervisor(args: GetHypervisorCommandInput, options?: __HttpHandlerOptions): Promise; + getHypervisor(args: GetHypervisorCommandInput, cb: (err: any, data?: GetHypervisorCommandOutput) => void): void; + getHypervisor( args: GetHypervisorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHypervisorCommandOutput) => void ): void; - public getHypervisor( - args: GetHypervisorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetHypervisorCommandOutput) => void), - cb?: (err: any, data?: GetHypervisorCommandOutput) => void - ): Promise | void { - const command = new GetHypervisorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This action retrieves the property mappings for the specified hypervisor. - * A hypervisor property mapping displays the relationship of entity properties - * available from the on-premises hypervisor to the properties available in Amazon Web Services.

+ * @see {@link GetHypervisorPropertyMappingsCommand} */ - public getHypervisorPropertyMappings( + getHypervisorPropertyMappings( args: GetHypervisorPropertyMappingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getHypervisorPropertyMappings( + getHypervisorPropertyMappings( args: GetHypervisorPropertyMappingsCommandInput, cb: (err: any, data?: GetHypervisorPropertyMappingsCommandOutput) => void ): void; - public getHypervisorPropertyMappings( + getHypervisorPropertyMappings( args: GetHypervisorPropertyMappingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHypervisorPropertyMappingsCommandOutput) => void ): void; - public getHypervisorPropertyMappings( - args: GetHypervisorPropertyMappingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetHypervisorPropertyMappingsCommandOutput) => void), - cb?: (err: any, data?: GetHypervisorPropertyMappingsCommandOutput) => void - ): Promise | void { - const command = new GetHypervisorPropertyMappingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

By providing the ARN (Amazon Resource Name), this API returns the virtual machine.

+ * @see {@link GetVirtualMachineCommand} */ - public getVirtualMachine( + getVirtualMachine( args: GetVirtualMachineCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVirtualMachine( + getVirtualMachine( args: GetVirtualMachineCommandInput, cb: (err: any, data?: GetVirtualMachineCommandOutput) => void ): void; - public getVirtualMachine( + getVirtualMachine( args: GetVirtualMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVirtualMachineCommandOutput) => void ): void; - public getVirtualMachine( - args: GetVirtualMachineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVirtualMachineCommandOutput) => void), - cb?: (err: any, data?: GetVirtualMachineCommandOutput) => void - ): Promise | void { - const command = new GetVirtualMachineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Connect to a hypervisor by importing its configuration.

+ * @see {@link ImportHypervisorConfigurationCommand} */ - public importHypervisorConfiguration( + importHypervisorConfiguration( args: ImportHypervisorConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public importHypervisorConfiguration( + importHypervisorConfiguration( args: ImportHypervisorConfigurationCommandInput, cb: (err: any, data?: ImportHypervisorConfigurationCommandOutput) => void ): void; - public importHypervisorConfiguration( + importHypervisorConfiguration( args: ImportHypervisorConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportHypervisorConfigurationCommandOutput) => void ): void; - public importHypervisorConfiguration( - args: ImportHypervisorConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportHypervisorConfigurationCommandOutput) => void), - cb?: (err: any, data?: ImportHypervisorConfigurationCommandOutput) => void - ): Promise | void { - const command = new ImportHypervisorConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).

+ * @see {@link ListGatewaysCommand} */ - public listGateways( - args: ListGatewaysCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listGateways(args: ListGatewaysCommandInput, cb: (err: any, data?: ListGatewaysCommandOutput) => void): void; - public listGateways( + listGateways(args: ListGatewaysCommandInput, options?: __HttpHandlerOptions): Promise; + listGateways(args: ListGatewaysCommandInput, cb: (err: any, data?: ListGatewaysCommandOutput) => void): void; + listGateways( args: ListGatewaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGatewaysCommandOutput) => void ): void; - public listGateways( - args: ListGatewaysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGatewaysCommandOutput) => void), - cb?: (err: any, data?: ListGatewaysCommandOutput) => void - ): Promise | void { - const command = new ListGatewaysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists your hypervisors.

+ * @see {@link ListHypervisorsCommand} */ - public listHypervisors( + listHypervisors( args: ListHypervisorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listHypervisors( - args: ListHypervisorsCommandInput, - cb: (err: any, data?: ListHypervisorsCommandOutput) => void - ): void; - public listHypervisors( + listHypervisors(args: ListHypervisorsCommandInput, cb: (err: any, data?: ListHypervisorsCommandOutput) => void): void; + listHypervisors( args: ListHypervisorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHypervisorsCommandOutput) => void ): void; - public listHypervisors( - args: ListHypervisorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListHypervisorsCommandOutput) => void), - cb?: (err: any, data?: ListHypervisorsCommandOutput) => void - ): Promise | void { - const command = new ListHypervisorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags applied to the resource identified by its Amazon Resource Name - * (ARN).

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists your virtual machines.

+ * @see {@link ListVirtualMachinesCommand} */ - public listVirtualMachines( + listVirtualMachines( args: ListVirtualMachinesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVirtualMachines( + listVirtualMachines( args: ListVirtualMachinesCommandInput, cb: (err: any, data?: ListVirtualMachinesCommandOutput) => void ): void; - public listVirtualMachines( + listVirtualMachines( args: ListVirtualMachinesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVirtualMachinesCommandOutput) => void ): void; - public listVirtualMachines( - args: ListVirtualMachinesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVirtualMachinesCommandOutput) => void), - cb?: (err: any, data?: ListVirtualMachinesCommandOutput) => void - ): Promise | void { - const command = new ListVirtualMachinesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This action sets the bandwidth rate limit schedule for a specified gateway. - * By default, gateways do not have a bandwidth rate limit schedule, which means - * no bandwidth rate limiting is in effect. Use this to initiate a - * gateway's bandwidth rate limit schedule.

+ * @see {@link PutBandwidthRateLimitScheduleCommand} */ - public putBandwidthRateLimitSchedule( + putBandwidthRateLimitSchedule( args: PutBandwidthRateLimitScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBandwidthRateLimitSchedule( + putBandwidthRateLimitSchedule( args: PutBandwidthRateLimitScheduleCommandInput, cb: (err: any, data?: PutBandwidthRateLimitScheduleCommandOutput) => void ): void; - public putBandwidthRateLimitSchedule( + putBandwidthRateLimitSchedule( args: PutBandwidthRateLimitScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBandwidthRateLimitScheduleCommandOutput) => void ): void; - public putBandwidthRateLimitSchedule( - args: PutBandwidthRateLimitScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBandwidthRateLimitScheduleCommandOutput) => void), - cb?: (err: any, data?: PutBandwidthRateLimitScheduleCommandOutput) => void - ): Promise | void { - const command = new PutBandwidthRateLimitScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This action sets the property mappings for the specified hypervisor. - * A hypervisor property mapping displays the relationship of entity properties - * available from the on-premises hypervisor to the properties available in Amazon Web Services.

+ * @see {@link PutHypervisorPropertyMappingsCommand} */ - public putHypervisorPropertyMappings( + putHypervisorPropertyMappings( args: PutHypervisorPropertyMappingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putHypervisorPropertyMappings( + putHypervisorPropertyMappings( args: PutHypervisorPropertyMappingsCommandInput, cb: (err: any, data?: PutHypervisorPropertyMappingsCommandOutput) => void ): void; - public putHypervisorPropertyMappings( + putHypervisorPropertyMappings( args: PutHypervisorPropertyMappingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutHypervisorPropertyMappingsCommandOutput) => void ): void; - public putHypervisorPropertyMappings( - args: PutHypervisorPropertyMappingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutHypervisorPropertyMappingsCommandOutput) => void), - cb?: (err: any, data?: PutHypervisorPropertyMappingsCommandOutput) => void - ): Promise | void { - const command = new PutHypervisorPropertyMappingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Set the maintenance start time for a gateway.

+ * @see {@link PutMaintenanceStartTimeCommand} */ - public putMaintenanceStartTime( + putMaintenanceStartTime( args: PutMaintenanceStartTimeCommandInput, options?: __HttpHandlerOptions ): Promise; - public putMaintenanceStartTime( + putMaintenanceStartTime( args: PutMaintenanceStartTimeCommandInput, cb: (err: any, data?: PutMaintenanceStartTimeCommandOutput) => void ): void; - public putMaintenanceStartTime( + putMaintenanceStartTime( args: PutMaintenanceStartTimeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMaintenanceStartTimeCommandOutput) => void ): void; - public putMaintenanceStartTime( - args: PutMaintenanceStartTimeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutMaintenanceStartTimeCommandOutput) => void), - cb?: (err: any, data?: PutMaintenanceStartTimeCommandOutput) => void - ): Promise | void { - const command = new PutMaintenanceStartTimeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This action sends a request to sync metadata across the specified virtual machines.

+ * @see {@link StartVirtualMachinesMetadataSyncCommand} */ - public startVirtualMachinesMetadataSync( + startVirtualMachinesMetadataSync( args: StartVirtualMachinesMetadataSyncCommandInput, options?: __HttpHandlerOptions ): Promise; - public startVirtualMachinesMetadataSync( + startVirtualMachinesMetadataSync( args: StartVirtualMachinesMetadataSyncCommandInput, cb: (err: any, data?: StartVirtualMachinesMetadataSyncCommandOutput) => void ): void; - public startVirtualMachinesMetadataSync( + startVirtualMachinesMetadataSync( args: StartVirtualMachinesMetadataSyncCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartVirtualMachinesMetadataSyncCommandOutput) => void ): void; - public startVirtualMachinesMetadataSync( - args: StartVirtualMachinesMetadataSyncCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartVirtualMachinesMetadataSyncCommandOutput) => void), - cb?: (err: any, data?: StartVirtualMachinesMetadataSyncCommandOutput) => void - ): Promise | void { - const command = new StartVirtualMachinesMetadataSyncCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Tag the resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Tests your hypervisor configuration to validate that backup gateway can connect with the - * hypervisor and its resources.

+ * @see {@link TestHypervisorConfigurationCommand} */ - public testHypervisorConfiguration( + testHypervisorConfiguration( args: TestHypervisorConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public testHypervisorConfiguration( + testHypervisorConfiguration( args: TestHypervisorConfigurationCommandInput, cb: (err: any, data?: TestHypervisorConfigurationCommandOutput) => void ): void; - public testHypervisorConfiguration( + testHypervisorConfiguration( args: TestHypervisorConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestHypervisorConfigurationCommandOutput) => void ): void; - public testHypervisorConfiguration( - args: TestHypervisorConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestHypervisorConfigurationCommandOutput) => void), - cb?: (err: any, data?: TestHypervisorConfigurationCommandOutput) => void - ): Promise | void { - const command = new TestHypervisorConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from the resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name - * (ARN) of the gateway in your request.

+ * @see {@link UpdateGatewayInformationCommand} */ - public updateGatewayInformation( + updateGatewayInformation( args: UpdateGatewayInformationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGatewayInformation( + updateGatewayInformation( args: UpdateGatewayInformationCommandInput, cb: (err: any, data?: UpdateGatewayInformationCommandOutput) => void ): void; - public updateGatewayInformation( + updateGatewayInformation( args: UpdateGatewayInformationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGatewayInformationCommandOutput) => void ): void; - public updateGatewayInformation( - args: UpdateGatewayInformationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGatewayInformationCommandOutput) => void), - cb?: (err: any, data?: UpdateGatewayInformationCommandOutput) => void - ): Promise | void { - const command = new UpdateGatewayInformationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the gateway virtual machine (VM) software. - * The request immediately triggers the software update.

- * - *

When you make this request, you get a 200 OK - * success response immediately. However, it might take some - * time for the update to complete.

- *
+ * @see {@link UpdateGatewaySoftwareNowCommand} */ - public updateGatewaySoftwareNow( + updateGatewaySoftwareNow( args: UpdateGatewaySoftwareNowCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGatewaySoftwareNow( + updateGatewaySoftwareNow( args: UpdateGatewaySoftwareNowCommandInput, cb: (err: any, data?: UpdateGatewaySoftwareNowCommandOutput) => void ): void; - public updateGatewaySoftwareNow( + updateGatewaySoftwareNow( args: UpdateGatewaySoftwareNowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGatewaySoftwareNowCommandOutput) => void ): void; - public updateGatewaySoftwareNow( - args: UpdateGatewaySoftwareNowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGatewaySoftwareNowCommandOutput) => void), - cb?: (err: any, data?: UpdateGatewaySoftwareNowCommandOutput) => void - ): Promise | void { - const command = new UpdateGatewaySoftwareNowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a hypervisor metadata, including its host, username, and password. Specify which - * hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your - * request.

+ * @see {@link UpdateHypervisorCommand} */ - public updateHypervisor( + updateHypervisor( args: UpdateHypervisorCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateHypervisor( + updateHypervisor( args: UpdateHypervisorCommandInput, cb: (err: any, data?: UpdateHypervisorCommandOutput) => void ): void; - public updateHypervisor( + updateHypervisor( args: UpdateHypervisorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateHypervisorCommandOutput) => void ): void; - public updateHypervisor( - args: UpdateHypervisorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateHypervisorCommandOutput) => void), - cb?: (err: any, data?: UpdateHypervisorCommandOutput) => void - ): Promise | void { - const command = new UpdateHypervisorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Backup gateway + *

Backup gateway connects Backup to your hypervisor, so you can + * create, store, and restore backups of your virtual machines (VMs) anywhere, whether + * on-premises or in the VMware Cloud (VMC) on Amazon Web Services.

+ *

Add on-premises resources by connecting to a hypervisor through a gateway. Backup will automatically discover the resources in your hypervisor.

+ *

Use Backup to assign virtual or on-premises resources to a backup plan, or run + * on-demand backups. Once you have backed up your resources, you can view them and restore them + * like any resource supported by Backup.

+ *

To download the Amazon Web Services software to get started, navigate to the Backup console, choose Gateways, then choose Create gateway.

+ */ +export class BackupGateway extends BackupGatewayClient implements BackupGateway {} +createAggregatedClient(commands, BackupGateway); diff --git a/clients/client-backup/src/Backup.ts b/clients/client-backup/src/Backup.ts index a92d4c23d9fe..56ca1d9d3339 100644 --- a/clients/client-backup/src/Backup.ts +++ b/clients/client-backup/src/Backup.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { BackupClient } from "./BackupClient"; +import { BackupClient, BackupClientConfig } from "./BackupClient"; import { CancelLegalHoldCommand, CancelLegalHoldCommandInput, @@ -355,2494 +356,1218 @@ import { UpdateReportPlanCommandOutput, } from "./commands/UpdateReportPlanCommand"; -/** - * @public - * Backup - *

Backup is a unified backup service designed to protect Amazon Web Services - * services and their associated data. Backup simplifies the creation, migration, - * restoration, and deletion of backups, while also providing reporting and - * auditing.

- */ -export class Backup extends BackupClient { +const commands = { + CancelLegalHoldCommand, + CreateBackupPlanCommand, + CreateBackupSelectionCommand, + CreateBackupVaultCommand, + CreateFrameworkCommand, + CreateLegalHoldCommand, + CreateReportPlanCommand, + DeleteBackupPlanCommand, + DeleteBackupSelectionCommand, + DeleteBackupVaultCommand, + DeleteBackupVaultAccessPolicyCommand, + DeleteBackupVaultLockConfigurationCommand, + DeleteBackupVaultNotificationsCommand, + DeleteFrameworkCommand, + DeleteRecoveryPointCommand, + DeleteReportPlanCommand, + DescribeBackupJobCommand, + DescribeBackupVaultCommand, + DescribeCopyJobCommand, + DescribeFrameworkCommand, + DescribeGlobalSettingsCommand, + DescribeProtectedResourceCommand, + DescribeRecoveryPointCommand, + DescribeRegionSettingsCommand, + DescribeReportJobCommand, + DescribeReportPlanCommand, + DescribeRestoreJobCommand, + DisassociateRecoveryPointCommand, + DisassociateRecoveryPointFromParentCommand, + ExportBackupPlanTemplateCommand, + GetBackupPlanCommand, + GetBackupPlanFromJSONCommand, + GetBackupPlanFromTemplateCommand, + GetBackupSelectionCommand, + GetBackupVaultAccessPolicyCommand, + GetBackupVaultNotificationsCommand, + GetLegalHoldCommand, + GetRecoveryPointRestoreMetadataCommand, + GetSupportedResourceTypesCommand, + ListBackupJobsCommand, + ListBackupPlansCommand, + ListBackupPlanTemplatesCommand, + ListBackupPlanVersionsCommand, + ListBackupSelectionsCommand, + ListBackupVaultsCommand, + ListCopyJobsCommand, + ListFrameworksCommand, + ListLegalHoldsCommand, + ListProtectedResourcesCommand, + ListRecoveryPointsByBackupVaultCommand, + ListRecoveryPointsByLegalHoldCommand, + ListRecoveryPointsByResourceCommand, + ListReportJobsCommand, + ListReportPlansCommand, + ListRestoreJobsCommand, + ListTagsCommand, + PutBackupVaultAccessPolicyCommand, + PutBackupVaultLockConfigurationCommand, + PutBackupVaultNotificationsCommand, + StartBackupJobCommand, + StartCopyJobCommand, + StartReportJobCommand, + StartRestoreJobCommand, + StopBackupJobCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateBackupPlanCommand, + UpdateFrameworkCommand, + UpdateGlobalSettingsCommand, + UpdateRecoveryPointLifecycleCommand, + UpdateRegionSettingsCommand, + UpdateReportPlanCommand, +}; + +export interface Backup { /** - * @public - *

This action removes the specified legal hold on a recovery point. - * This action can only be performed by a user with sufficient permissions.

+ * @see {@link CancelLegalHoldCommand} */ - public cancelLegalHold( + cancelLegalHold( args: CancelLegalHoldCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelLegalHold( - args: CancelLegalHoldCommandInput, - cb: (err: any, data?: CancelLegalHoldCommandOutput) => void - ): void; - public cancelLegalHold( + cancelLegalHold(args: CancelLegalHoldCommandInput, cb: (err: any, data?: CancelLegalHoldCommandOutput) => void): void; + cancelLegalHold( args: CancelLegalHoldCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelLegalHoldCommandOutput) => void ): void; - public cancelLegalHold( - args: CancelLegalHoldCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelLegalHoldCommandOutput) => void), - cb?: (err: any, data?: CancelLegalHoldCommandOutput) => void - ): Promise | void { - const command = new CancelLegalHoldCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a backup plan using a backup plan name and backup rules. A backup plan is a - * document that contains information that Backup uses to schedule tasks that - * create recovery points for resources.

- *

If you call CreateBackupPlan with a plan that already exists, you receive - * an AlreadyExistsException exception.

- */ - public createBackupPlan( + + /** + * @see {@link CreateBackupPlanCommand} + */ + createBackupPlan( args: CreateBackupPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBackupPlan( + createBackupPlan( args: CreateBackupPlanCommandInput, cb: (err: any, data?: CreateBackupPlanCommandOutput) => void ): void; - public createBackupPlan( + createBackupPlan( args: CreateBackupPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBackupPlanCommandOutput) => void ): void; - public createBackupPlan( - args: CreateBackupPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBackupPlanCommandOutput) => void), - cb?: (err: any, data?: CreateBackupPlanCommandOutput) => void - ): Promise | void { - const command = new CreateBackupPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a JSON document that specifies a set of resources to assign to a backup plan. - * For examples, see Assigning resources programmatically.

- */ - public createBackupSelection( + + /** + * @see {@link CreateBackupSelectionCommand} + */ + createBackupSelection( args: CreateBackupSelectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBackupSelection( + createBackupSelection( args: CreateBackupSelectionCommandInput, cb: (err: any, data?: CreateBackupSelectionCommandOutput) => void ): void; - public createBackupSelection( + createBackupSelection( args: CreateBackupSelectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBackupSelectionCommandOutput) => void ): void; - public createBackupSelection( - args: CreateBackupSelectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBackupSelectionCommandOutput) => void), - cb?: (err: any, data?: CreateBackupSelectionCommandOutput) => void - ): Promise | void { - const command = new CreateBackupSelectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a logical container where backups are stored. A CreateBackupVault - * request includes a name, optionally one or more resource tags, an encryption key, and a - * request ID.

- * - *

Do not include sensitive data, such as passport numbers, in the name of a backup - * vault.

- *
- */ - public createBackupVault( + + /** + * @see {@link CreateBackupVaultCommand} + */ + createBackupVault( args: CreateBackupVaultCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBackupVault( + createBackupVault( args: CreateBackupVaultCommandInput, cb: (err: any, data?: CreateBackupVaultCommandOutput) => void ): void; - public createBackupVault( + createBackupVault( args: CreateBackupVaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBackupVaultCommandOutput) => void ): void; - public createBackupVault( - args: CreateBackupVaultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBackupVaultCommandOutput) => void), - cb?: (err: any, data?: CreateBackupVaultCommandOutput) => void - ): Promise | void { - const command = new CreateBackupVaultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a framework with one or more controls. A framework is a collection of controls - * that you can use to evaluate your backup practices. By using pre-built customizable - * controls to define your policies, you can evaluate whether your backup practices comply - * with your policies and which resources are not yet in compliance.

- */ - public createFramework( + + /** + * @see {@link CreateFrameworkCommand} + */ + createFramework( args: CreateFrameworkCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFramework( - args: CreateFrameworkCommandInput, - cb: (err: any, data?: CreateFrameworkCommandOutput) => void - ): void; - public createFramework( + createFramework(args: CreateFrameworkCommandInput, cb: (err: any, data?: CreateFrameworkCommandOutput) => void): void; + createFramework( args: CreateFrameworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFrameworkCommandOutput) => void ): void; - public createFramework( - args: CreateFrameworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFrameworkCommandOutput) => void), - cb?: (err: any, data?: CreateFrameworkCommandOutput) => void - ): Promise | void { - const command = new CreateFrameworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This action creates a legal hold on a recovery point (backup). A legal hold - * is a restraint on altering or deleting a backup until an authorized user cancels the - * legal hold. Any actions to delete or disassociate a recovery point will fail with - * an error if one or more active legal holds are on the recovery point.

- */ - public createLegalHold( + + /** + * @see {@link CreateLegalHoldCommand} + */ + createLegalHold( args: CreateLegalHoldCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLegalHold( - args: CreateLegalHoldCommandInput, - cb: (err: any, data?: CreateLegalHoldCommandOutput) => void - ): void; - public createLegalHold( + createLegalHold(args: CreateLegalHoldCommandInput, cb: (err: any, data?: CreateLegalHoldCommandOutput) => void): void; + createLegalHold( args: CreateLegalHoldCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLegalHoldCommandOutput) => void ): void; - public createLegalHold( - args: CreateLegalHoldCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLegalHoldCommandOutput) => void), - cb?: (err: any, data?: CreateLegalHoldCommandOutput) => void - ): Promise | void { - const command = new CreateLegalHoldCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a report plan. A report plan is a document that contains information about the - * contents of the report and where Backup will deliver it.

- *

If you call CreateReportPlan with a plan that already exists, you receive - * an AlreadyExistsException exception.

- */ - public createReportPlan( + + /** + * @see {@link CreateReportPlanCommand} + */ + createReportPlan( args: CreateReportPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public createReportPlan( + createReportPlan( args: CreateReportPlanCommandInput, cb: (err: any, data?: CreateReportPlanCommandOutput) => void ): void; - public createReportPlan( + createReportPlan( args: CreateReportPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReportPlanCommandOutput) => void ): void; - public createReportPlan( - args: CreateReportPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateReportPlanCommandOutput) => void), - cb?: (err: any, data?: CreateReportPlanCommandOutput) => void - ): Promise | void { - const command = new CreateReportPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a backup plan. A backup plan can only be deleted after all associated selections - * of resources have been deleted. Deleting a backup plan deletes the current version of a - * backup plan. Previous versions, if any, will still exist.

- */ - public deleteBackupPlan( + + /** + * @see {@link DeleteBackupPlanCommand} + */ + deleteBackupPlan( args: DeleteBackupPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBackupPlan( + deleteBackupPlan( args: DeleteBackupPlanCommandInput, cb: (err: any, data?: DeleteBackupPlanCommandOutput) => void ): void; - public deleteBackupPlan( + deleteBackupPlan( args: DeleteBackupPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackupPlanCommandOutput) => void ): void; - public deleteBackupPlan( - args: DeleteBackupPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBackupPlanCommandOutput) => void), - cb?: (err: any, data?: DeleteBackupPlanCommandOutput) => void - ): Promise | void { - const command = new DeleteBackupPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the resource selection associated with a backup plan that is specified by the - * SelectionId.

- */ - public deleteBackupSelection( + + /** + * @see {@link DeleteBackupSelectionCommand} + */ + deleteBackupSelection( args: DeleteBackupSelectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBackupSelection( + deleteBackupSelection( args: DeleteBackupSelectionCommandInput, cb: (err: any, data?: DeleteBackupSelectionCommandOutput) => void ): void; - public deleteBackupSelection( + deleteBackupSelection( args: DeleteBackupSelectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackupSelectionCommandOutput) => void ): void; - public deleteBackupSelection( - args: DeleteBackupSelectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBackupSelectionCommandOutput) => void), - cb?: (err: any, data?: DeleteBackupSelectionCommandOutput) => void - ): Promise | void { - const command = new DeleteBackupSelectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the backup vault identified by its name. A vault can be deleted only if it is - * empty.

- */ - public deleteBackupVault( + + /** + * @see {@link DeleteBackupVaultCommand} + */ + deleteBackupVault( args: DeleteBackupVaultCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBackupVault( + deleteBackupVault( args: DeleteBackupVaultCommandInput, cb: (err: any, data?: DeleteBackupVaultCommandOutput) => void ): void; - public deleteBackupVault( + deleteBackupVault( args: DeleteBackupVaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackupVaultCommandOutput) => void ): void; - public deleteBackupVault( - args: DeleteBackupVaultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBackupVaultCommandOutput) => void), - cb?: (err: any, data?: DeleteBackupVaultCommandOutput) => void - ): Promise | void { - const command = new DeleteBackupVaultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the policy document that manages permissions on a backup vault.

- */ - public deleteBackupVaultAccessPolicy( + + /** + * @see {@link DeleteBackupVaultAccessPolicyCommand} + */ + deleteBackupVaultAccessPolicy( args: DeleteBackupVaultAccessPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBackupVaultAccessPolicy( + deleteBackupVaultAccessPolicy( args: DeleteBackupVaultAccessPolicyCommandInput, cb: (err: any, data?: DeleteBackupVaultAccessPolicyCommandOutput) => void ): void; - public deleteBackupVaultAccessPolicy( + deleteBackupVaultAccessPolicy( args: DeleteBackupVaultAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackupVaultAccessPolicyCommandOutput) => void ): void; - public deleteBackupVaultAccessPolicy( - args: DeleteBackupVaultAccessPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBackupVaultAccessPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteBackupVaultAccessPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteBackupVaultAccessPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes Backup Vault Lock from a backup vault specified by a backup vault - * name.

- *

If the Vault Lock configuration is immutable, then you cannot delete Vault Lock using - * API operations, and you will receive an InvalidRequestException if you attempt - * to do so. For more information, see Vault Lock in the - * Backup Developer Guide.

- */ - public deleteBackupVaultLockConfiguration( + + /** + * @see {@link DeleteBackupVaultLockConfigurationCommand} + */ + deleteBackupVaultLockConfiguration( args: DeleteBackupVaultLockConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBackupVaultLockConfiguration( + deleteBackupVaultLockConfiguration( args: DeleteBackupVaultLockConfigurationCommandInput, cb: (err: any, data?: DeleteBackupVaultLockConfigurationCommandOutput) => void ): void; - public deleteBackupVaultLockConfiguration( + deleteBackupVaultLockConfiguration( args: DeleteBackupVaultLockConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackupVaultLockConfigurationCommandOutput) => void ): void; - public deleteBackupVaultLockConfiguration( - args: DeleteBackupVaultLockConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBackupVaultLockConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteBackupVaultLockConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteBackupVaultLockConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes event notifications for the specified backup vault.

- */ - public deleteBackupVaultNotifications( + + /** + * @see {@link DeleteBackupVaultNotificationsCommand} + */ + deleteBackupVaultNotifications( args: DeleteBackupVaultNotificationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBackupVaultNotifications( + deleteBackupVaultNotifications( args: DeleteBackupVaultNotificationsCommandInput, cb: (err: any, data?: DeleteBackupVaultNotificationsCommandOutput) => void ): void; - public deleteBackupVaultNotifications( + deleteBackupVaultNotifications( args: DeleteBackupVaultNotificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackupVaultNotificationsCommandOutput) => void ): void; - public deleteBackupVaultNotifications( - args: DeleteBackupVaultNotificationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBackupVaultNotificationsCommandOutput) => void), - cb?: (err: any, data?: DeleteBackupVaultNotificationsCommandOutput) => void - ): Promise | void { - const command = new DeleteBackupVaultNotificationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the framework specified by a framework name.

- */ - public deleteFramework( + + /** + * @see {@link DeleteFrameworkCommand} + */ + deleteFramework( args: DeleteFrameworkCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFramework( - args: DeleteFrameworkCommandInput, - cb: (err: any, data?: DeleteFrameworkCommandOutput) => void - ): void; - public deleteFramework( + deleteFramework(args: DeleteFrameworkCommandInput, cb: (err: any, data?: DeleteFrameworkCommandOutput) => void): void; + deleteFramework( args: DeleteFrameworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFrameworkCommandOutput) => void ): void; - public deleteFramework( - args: DeleteFrameworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFrameworkCommandOutput) => void), - cb?: (err: any, data?: DeleteFrameworkCommandOutput) => void - ): Promise | void { - const command = new DeleteFrameworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the recovery point specified by a recovery point ID.

- *

If the recovery point ID belongs to a continuous backup, calling this endpoint deletes - * the existing continuous backup and stops future continuous backup.

- *

When an IAM role's permissions are insufficient to call this API, the service sends back - * an HTTP 200 response with an empty HTTP body, but the recovery point is not deleted. - * Instead, it enters an EXPIRED state.

- *

- * EXPIRED recovery points can be deleted with this API once the IAM role - * has the iam:CreateServiceLinkedRole action. To learn more about adding this role, see - * - * Troubleshooting manual deletions.

- *

If the user or role is deleted or the permission within the role is removed, - * the deletion will not be successful and will enter an EXPIRED state.

- */ - public deleteRecoveryPoint( + + /** + * @see {@link DeleteRecoveryPointCommand} + */ + deleteRecoveryPoint( args: DeleteRecoveryPointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRecoveryPoint( + deleteRecoveryPoint( args: DeleteRecoveryPointCommandInput, cb: (err: any, data?: DeleteRecoveryPointCommandOutput) => void ): void; - public deleteRecoveryPoint( + deleteRecoveryPoint( args: DeleteRecoveryPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRecoveryPointCommandOutput) => void ): void; - public deleteRecoveryPoint( - args: DeleteRecoveryPointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRecoveryPointCommandOutput) => void), - cb?: (err: any, data?: DeleteRecoveryPointCommandOutput) => void - ): Promise | void { - const command = new DeleteRecoveryPointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the report plan specified by a report plan name.

- */ - public deleteReportPlan( + + /** + * @see {@link DeleteReportPlanCommand} + */ + deleteReportPlan( args: DeleteReportPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteReportPlan( + deleteReportPlan( args: DeleteReportPlanCommandInput, cb: (err: any, data?: DeleteReportPlanCommandOutput) => void ): void; - public deleteReportPlan( + deleteReportPlan( args: DeleteReportPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReportPlanCommandOutput) => void ): void; - public deleteReportPlan( - args: DeleteReportPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteReportPlanCommandOutput) => void), - cb?: (err: any, data?: DeleteReportPlanCommandOutput) => void - ): Promise | void { - const command = new DeleteReportPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns backup job details for the specified BackupJobId.

- */ - public describeBackupJob( + + /** + * @see {@link DescribeBackupJobCommand} + */ + describeBackupJob( args: DescribeBackupJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBackupJob( + describeBackupJob( args: DescribeBackupJobCommandInput, cb: (err: any, data?: DescribeBackupJobCommandOutput) => void ): void; - public describeBackupJob( + describeBackupJob( args: DescribeBackupJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBackupJobCommandOutput) => void ): void; - public describeBackupJob( - args: DescribeBackupJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBackupJobCommandOutput) => void), - cb?: (err: any, data?: DescribeBackupJobCommandOutput) => void - ): Promise | void { - const command = new DescribeBackupJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns metadata about a backup vault specified by its name.

- */ - public describeBackupVault( + + /** + * @see {@link DescribeBackupVaultCommand} + */ + describeBackupVault( args: DescribeBackupVaultCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBackupVault( + describeBackupVault( args: DescribeBackupVaultCommandInput, cb: (err: any, data?: DescribeBackupVaultCommandOutput) => void ): void; - public describeBackupVault( + describeBackupVault( args: DescribeBackupVaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBackupVaultCommandOutput) => void ): void; - public describeBackupVault( - args: DescribeBackupVaultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBackupVaultCommandOutput) => void), - cb?: (err: any, data?: DescribeBackupVaultCommandOutput) => void - ): Promise | void { - const command = new DescribeBackupVaultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns metadata associated with creating a copy of a resource.

- */ - public describeCopyJob( + + /** + * @see {@link DescribeCopyJobCommand} + */ + describeCopyJob( args: DescribeCopyJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCopyJob( - args: DescribeCopyJobCommandInput, - cb: (err: any, data?: DescribeCopyJobCommandOutput) => void - ): void; - public describeCopyJob( + describeCopyJob(args: DescribeCopyJobCommandInput, cb: (err: any, data?: DescribeCopyJobCommandOutput) => void): void; + describeCopyJob( args: DescribeCopyJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCopyJobCommandOutput) => void ): void; - public describeCopyJob( - args: DescribeCopyJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCopyJobCommandOutput) => void), - cb?: (err: any, data?: DescribeCopyJobCommandOutput) => void - ): Promise | void { - const command = new DescribeCopyJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the framework details for the specified FrameworkName.

- */ - public describeFramework( + + /** + * @see {@link DescribeFrameworkCommand} + */ + describeFramework( args: DescribeFrameworkCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFramework( + describeFramework( args: DescribeFrameworkCommandInput, cb: (err: any, data?: DescribeFrameworkCommandOutput) => void ): void; - public describeFramework( + describeFramework( args: DescribeFrameworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFrameworkCommandOutput) => void ): void; - public describeFramework( - args: DescribeFrameworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFrameworkCommandOutput) => void), - cb?: (err: any, data?: DescribeFrameworkCommandOutput) => void - ): Promise | void { - const command = new DescribeFrameworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes whether the Amazon Web Services account is opted in to cross-account backup. - * Returns an error if the account is not a member of an Organizations organization. - * Example: describe-global-settings --region us-west-2 - *

- */ - public describeGlobalSettings( + + /** + * @see {@link DescribeGlobalSettingsCommand} + */ + describeGlobalSettings( args: DescribeGlobalSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGlobalSettings( + describeGlobalSettings( args: DescribeGlobalSettingsCommandInput, cb: (err: any, data?: DescribeGlobalSettingsCommandOutput) => void ): void; - public describeGlobalSettings( + describeGlobalSettings( args: DescribeGlobalSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGlobalSettingsCommandOutput) => void ): void; - public describeGlobalSettings( - args: DescribeGlobalSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGlobalSettingsCommandOutput) => void), - cb?: (err: any, data?: DescribeGlobalSettingsCommandOutput) => void - ): Promise | void { - const command = new DescribeGlobalSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a saved resource, including the last time it was backed up, - * its Amazon Resource Name (ARN), and the Amazon Web Services service type of the saved - * resource.

- */ - public describeProtectedResource( + + /** + * @see {@link DescribeProtectedResourceCommand} + */ + describeProtectedResource( args: DescribeProtectedResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProtectedResource( + describeProtectedResource( args: DescribeProtectedResourceCommandInput, cb: (err: any, data?: DescribeProtectedResourceCommandOutput) => void ): void; - public describeProtectedResource( + describeProtectedResource( args: DescribeProtectedResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProtectedResourceCommandOutput) => void ): void; - public describeProtectedResource( - args: DescribeProtectedResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProtectedResourceCommandOutput) => void), - cb?: (err: any, data?: DescribeProtectedResourceCommandOutput) => void - ): Promise | void { - const command = new DescribeProtectedResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns metadata associated with a recovery point, including ID, status, encryption, and - * lifecycle.

- */ - public describeRecoveryPoint( + + /** + * @see {@link DescribeRecoveryPointCommand} + */ + describeRecoveryPoint( args: DescribeRecoveryPointCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRecoveryPoint( + describeRecoveryPoint( args: DescribeRecoveryPointCommandInput, cb: (err: any, data?: DescribeRecoveryPointCommandOutput) => void ): void; - public describeRecoveryPoint( + describeRecoveryPoint( args: DescribeRecoveryPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRecoveryPointCommandOutput) => void ): void; - public describeRecoveryPoint( - args: DescribeRecoveryPointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRecoveryPointCommandOutput) => void), - cb?: (err: any, data?: DescribeRecoveryPointCommandOutput) => void - ): Promise | void { - const command = new DescribeRecoveryPointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the current service opt-in settings for the Region. If service opt-in is enabled - * for a service, Backup tries to protect that service's resources in this Region, - * when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, - * Backup does not try to protect that service's resources in this - * Region.

- */ - public describeRegionSettings( + + /** + * @see {@link DescribeRegionSettingsCommand} + */ + describeRegionSettings( args: DescribeRegionSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRegionSettings( + describeRegionSettings( args: DescribeRegionSettingsCommandInput, cb: (err: any, data?: DescribeRegionSettingsCommandOutput) => void ): void; - public describeRegionSettings( + describeRegionSettings( args: DescribeRegionSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRegionSettingsCommandOutput) => void ): void; - public describeRegionSettings( - args: DescribeRegionSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRegionSettingsCommandOutput) => void), - cb?: (err: any, data?: DescribeRegionSettingsCommandOutput) => void - ): Promise | void { - const command = new DescribeRegionSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the details associated with creating a report as specified by its - * ReportJobId.

- */ - public describeReportJob( + + /** + * @see {@link DescribeReportJobCommand} + */ + describeReportJob( args: DescribeReportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReportJob( + describeReportJob( args: DescribeReportJobCommandInput, cb: (err: any, data?: DescribeReportJobCommandOutput) => void ): void; - public describeReportJob( + describeReportJob( args: DescribeReportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReportJobCommandOutput) => void ): void; - public describeReportJob( - args: DescribeReportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReportJobCommandOutput) => void), - cb?: (err: any, data?: DescribeReportJobCommandOutput) => void - ): Promise | void { - const command = new DescribeReportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.

- */ - public describeReportPlan( + + /** + * @see {@link DescribeReportPlanCommand} + */ + describeReportPlan( args: DescribeReportPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReportPlan( + describeReportPlan( args: DescribeReportPlanCommandInput, cb: (err: any, data?: DescribeReportPlanCommandOutput) => void ): void; - public describeReportPlan( + describeReportPlan( args: DescribeReportPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReportPlanCommandOutput) => void ): void; - public describeReportPlan( - args: DescribeReportPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReportPlanCommandOutput) => void), - cb?: (err: any, data?: DescribeReportPlanCommandOutput) => void - ): Promise | void { - const command = new DescribeReportPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns metadata associated with a restore job that is specified by a job ID.

- */ - public describeRestoreJob( + + /** + * @see {@link DescribeRestoreJobCommand} + */ + describeRestoreJob( args: DescribeRestoreJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRestoreJob( + describeRestoreJob( args: DescribeRestoreJobCommandInput, cb: (err: any, data?: DescribeRestoreJobCommandOutput) => void ): void; - public describeRestoreJob( + describeRestoreJob( args: DescribeRestoreJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRestoreJobCommandOutput) => void ): void; - public describeRestoreJob( - args: DescribeRestoreJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRestoreJobCommandOutput) => void), - cb?: (err: any, data?: DescribeRestoreJobCommandOutput) => void - ): Promise | void { - const command = new DescribeRestoreJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified continuous backup recovery point from Backup and - * releases control of that continuous backup to the source service, such as Amazon RDS. The source service will continue to create and retain continuous backups using the - * lifecycle that you specified in your original backup plan.

- *

Does not support snapshot backup recovery points.

- */ - public disassociateRecoveryPoint( + + /** + * @see {@link DisassociateRecoveryPointCommand} + */ + disassociateRecoveryPoint( args: DisassociateRecoveryPointCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateRecoveryPoint( + disassociateRecoveryPoint( args: DisassociateRecoveryPointCommandInput, cb: (err: any, data?: DisassociateRecoveryPointCommandOutput) => void ): void; - public disassociateRecoveryPoint( + disassociateRecoveryPoint( args: DisassociateRecoveryPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateRecoveryPointCommandOutput) => void ): void; - public disassociateRecoveryPoint( - args: DisassociateRecoveryPointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateRecoveryPointCommandOutput) => void), - cb?: (err: any, data?: DisassociateRecoveryPointCommandOutput) => void - ): Promise | void { - const command = new DisassociateRecoveryPointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This action to a specific child (nested) recovery point removes the relationship - * between the specified recovery point and its parent (composite) recovery point.

- */ - public disassociateRecoveryPointFromParent( + + /** + * @see {@link DisassociateRecoveryPointFromParentCommand} + */ + disassociateRecoveryPointFromParent( args: DisassociateRecoveryPointFromParentCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateRecoveryPointFromParent( + disassociateRecoveryPointFromParent( args: DisassociateRecoveryPointFromParentCommandInput, cb: (err: any, data?: DisassociateRecoveryPointFromParentCommandOutput) => void ): void; - public disassociateRecoveryPointFromParent( + disassociateRecoveryPointFromParent( args: DisassociateRecoveryPointFromParentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateRecoveryPointFromParentCommandOutput) => void ): void; - public disassociateRecoveryPointFromParent( - args: DisassociateRecoveryPointFromParentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateRecoveryPointFromParentCommandOutput) => void), - cb?: (err: any, data?: DisassociateRecoveryPointFromParentCommandOutput) => void - ): Promise | void { - const command = new DisassociateRecoveryPointFromParentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the backup plan that is specified by the plan ID as a backup template.

- */ - public exportBackupPlanTemplate( + + /** + * @see {@link ExportBackupPlanTemplateCommand} + */ + exportBackupPlanTemplate( args: ExportBackupPlanTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public exportBackupPlanTemplate( + exportBackupPlanTemplate( args: ExportBackupPlanTemplateCommandInput, cb: (err: any, data?: ExportBackupPlanTemplateCommandOutput) => void ): void; - public exportBackupPlanTemplate( + exportBackupPlanTemplate( args: ExportBackupPlanTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportBackupPlanTemplateCommandOutput) => void ): void; - public exportBackupPlanTemplate( - args: ExportBackupPlanTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportBackupPlanTemplateCommandOutput) => void), - cb?: (err: any, data?: ExportBackupPlanTemplateCommandOutput) => void - ): Promise | void { - const command = new ExportBackupPlanTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns BackupPlan details for the specified BackupPlanId. The - * details are the body of a backup plan in JSON format, in addition to plan metadata.

- */ - public getBackupPlan( - args: GetBackupPlanCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getBackupPlan( - args: GetBackupPlanCommandInput, - cb: (err: any, data?: GetBackupPlanCommandOutput) => void - ): void; - public getBackupPlan( + + /** + * @see {@link GetBackupPlanCommand} + */ + getBackupPlan(args: GetBackupPlanCommandInput, options?: __HttpHandlerOptions): Promise; + getBackupPlan(args: GetBackupPlanCommandInput, cb: (err: any, data?: GetBackupPlanCommandOutput) => void): void; + getBackupPlan( args: GetBackupPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBackupPlanCommandOutput) => void ): void; - public getBackupPlan( - args: GetBackupPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBackupPlanCommandOutput) => void), - cb?: (err: any, data?: GetBackupPlanCommandOutput) => void - ): Promise | void { - const command = new GetBackupPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a valid JSON document specifying a backup plan or an error.

- */ - public getBackupPlanFromJSON( + + /** + * @see {@link GetBackupPlanFromJSONCommand} + */ + getBackupPlanFromJSON( args: GetBackupPlanFromJSONCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBackupPlanFromJSON( + getBackupPlanFromJSON( args: GetBackupPlanFromJSONCommandInput, cb: (err: any, data?: GetBackupPlanFromJSONCommandOutput) => void ): void; - public getBackupPlanFromJSON( + getBackupPlanFromJSON( args: GetBackupPlanFromJSONCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBackupPlanFromJSONCommandOutput) => void ): void; - public getBackupPlanFromJSON( - args: GetBackupPlanFromJSONCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBackupPlanFromJSONCommandOutput) => void), - cb?: (err: any, data?: GetBackupPlanFromJSONCommandOutput) => void - ): Promise | void { - const command = new GetBackupPlanFromJSONCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the template specified by its templateId as a backup plan.

- */ - public getBackupPlanFromTemplate( + + /** + * @see {@link GetBackupPlanFromTemplateCommand} + */ + getBackupPlanFromTemplate( args: GetBackupPlanFromTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBackupPlanFromTemplate( + getBackupPlanFromTemplate( args: GetBackupPlanFromTemplateCommandInput, cb: (err: any, data?: GetBackupPlanFromTemplateCommandOutput) => void ): void; - public getBackupPlanFromTemplate( + getBackupPlanFromTemplate( args: GetBackupPlanFromTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBackupPlanFromTemplateCommandOutput) => void ): void; - public getBackupPlanFromTemplate( - args: GetBackupPlanFromTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBackupPlanFromTemplateCommandOutput) => void), - cb?: (err: any, data?: GetBackupPlanFromTemplateCommandOutput) => void - ): Promise | void { - const command = new GetBackupPlanFromTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns selection metadata and a document in JSON format that specifies a list of - * resources that are associated with a backup plan.

- */ - public getBackupSelection( + + /** + * @see {@link GetBackupSelectionCommand} + */ + getBackupSelection( args: GetBackupSelectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBackupSelection( + getBackupSelection( args: GetBackupSelectionCommandInput, cb: (err: any, data?: GetBackupSelectionCommandOutput) => void ): void; - public getBackupSelection( + getBackupSelection( args: GetBackupSelectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBackupSelectionCommandOutput) => void ): void; - public getBackupSelection( - args: GetBackupSelectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBackupSelectionCommandOutput) => void), - cb?: (err: any, data?: GetBackupSelectionCommandOutput) => void - ): Promise | void { - const command = new GetBackupSelectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the access policy document that is associated with the named backup - * vault.

- */ - public getBackupVaultAccessPolicy( + + /** + * @see {@link GetBackupVaultAccessPolicyCommand} + */ + getBackupVaultAccessPolicy( args: GetBackupVaultAccessPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBackupVaultAccessPolicy( + getBackupVaultAccessPolicy( args: GetBackupVaultAccessPolicyCommandInput, cb: (err: any, data?: GetBackupVaultAccessPolicyCommandOutput) => void ): void; - public getBackupVaultAccessPolicy( + getBackupVaultAccessPolicy( args: GetBackupVaultAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBackupVaultAccessPolicyCommandOutput) => void ): void; - public getBackupVaultAccessPolicy( - args: GetBackupVaultAccessPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBackupVaultAccessPolicyCommandOutput) => void), - cb?: (err: any, data?: GetBackupVaultAccessPolicyCommandOutput) => void - ): Promise | void { - const command = new GetBackupVaultAccessPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns event notifications for the specified backup vault.

- */ - public getBackupVaultNotifications( + + /** + * @see {@link GetBackupVaultNotificationsCommand} + */ + getBackupVaultNotifications( args: GetBackupVaultNotificationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBackupVaultNotifications( + getBackupVaultNotifications( args: GetBackupVaultNotificationsCommandInput, cb: (err: any, data?: GetBackupVaultNotificationsCommandOutput) => void ): void; - public getBackupVaultNotifications( + getBackupVaultNotifications( args: GetBackupVaultNotificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBackupVaultNotificationsCommandOutput) => void ): void; - public getBackupVaultNotifications( - args: GetBackupVaultNotificationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBackupVaultNotificationsCommandOutput) => void), - cb?: (err: any, data?: GetBackupVaultNotificationsCommandOutput) => void - ): Promise | void { - const command = new GetBackupVaultNotificationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This action returns details for a specified legal hold. The details are the - * body of a legal hold in JSON format, in addition to metadata.

- */ - public getLegalHold( - args: GetLegalHoldCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getLegalHold(args: GetLegalHoldCommandInput, cb: (err: any, data?: GetLegalHoldCommandOutput) => void): void; - public getLegalHold( + + /** + * @see {@link GetLegalHoldCommand} + */ + getLegalHold(args: GetLegalHoldCommandInput, options?: __HttpHandlerOptions): Promise; + getLegalHold(args: GetLegalHoldCommandInput, cb: (err: any, data?: GetLegalHoldCommandOutput) => void): void; + getLegalHold( args: GetLegalHoldCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLegalHoldCommandOutput) => void ): void; - public getLegalHold( - args: GetLegalHoldCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLegalHoldCommandOutput) => void), - cb?: (err: any, data?: GetLegalHoldCommandOutput) => void - ): Promise | void { - const command = new GetLegalHoldCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a set of metadata key-value pairs that were used to create the backup.

- */ - public getRecoveryPointRestoreMetadata( + + /** + * @see {@link GetRecoveryPointRestoreMetadataCommand} + */ + getRecoveryPointRestoreMetadata( args: GetRecoveryPointRestoreMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRecoveryPointRestoreMetadata( + getRecoveryPointRestoreMetadata( args: GetRecoveryPointRestoreMetadataCommandInput, cb: (err: any, data?: GetRecoveryPointRestoreMetadataCommandOutput) => void ): void; - public getRecoveryPointRestoreMetadata( + getRecoveryPointRestoreMetadata( args: GetRecoveryPointRestoreMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRecoveryPointRestoreMetadataCommandOutput) => void ): void; - public getRecoveryPointRestoreMetadata( - args: GetRecoveryPointRestoreMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRecoveryPointRestoreMetadataCommandOutput) => void), - cb?: (err: any, data?: GetRecoveryPointRestoreMetadataCommandOutput) => void - ): Promise | void { - const command = new GetRecoveryPointRestoreMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the Amazon Web Services resource types supported by Backup.

- */ - public getSupportedResourceTypes( + + /** + * @see {@link GetSupportedResourceTypesCommand} + */ + getSupportedResourceTypes( args: GetSupportedResourceTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSupportedResourceTypes( + getSupportedResourceTypes( args: GetSupportedResourceTypesCommandInput, cb: (err: any, data?: GetSupportedResourceTypesCommandOutput) => void ): void; - public getSupportedResourceTypes( + getSupportedResourceTypes( args: GetSupportedResourceTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSupportedResourceTypesCommandOutput) => void ): void; - public getSupportedResourceTypes( - args: GetSupportedResourceTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSupportedResourceTypesCommandOutput) => void), - cb?: (err: any, data?: GetSupportedResourceTypesCommandOutput) => void - ): Promise | void { - const command = new GetSupportedResourceTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of existing backup jobs for an authenticated account for the last 30 - * days. For a longer period of time, consider using these monitoring tools.

- */ - public listBackupJobs( + + /** + * @see {@link ListBackupJobsCommand} + */ + listBackupJobs( args: ListBackupJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBackupJobs( - args: ListBackupJobsCommandInput, - cb: (err: any, data?: ListBackupJobsCommandOutput) => void - ): void; - public listBackupJobs( + listBackupJobs(args: ListBackupJobsCommandInput, cb: (err: any, data?: ListBackupJobsCommandOutput) => void): void; + listBackupJobs( args: ListBackupJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBackupJobsCommandOutput) => void ): void; - public listBackupJobs( - args: ListBackupJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBackupJobsCommandOutput) => void), - cb?: (err: any, data?: ListBackupJobsCommandOutput) => void - ): Promise | void { - const command = new ListBackupJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of all active backup plans for an authenticated account. The list - * contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion - * dates, version IDs, plan names, and creator request IDs.

- */ - public listBackupPlans( + + /** + * @see {@link ListBackupPlansCommand} + */ + listBackupPlans( args: ListBackupPlansCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBackupPlans( - args: ListBackupPlansCommandInput, - cb: (err: any, data?: ListBackupPlansCommandOutput) => void - ): void; - public listBackupPlans( + listBackupPlans(args: ListBackupPlansCommandInput, cb: (err: any, data?: ListBackupPlansCommandOutput) => void): void; + listBackupPlans( args: ListBackupPlansCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBackupPlansCommandOutput) => void ): void; - public listBackupPlans( - args: ListBackupPlansCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBackupPlansCommandOutput) => void), - cb?: (err: any, data?: ListBackupPlansCommandOutput) => void - ): Promise | void { - const command = new ListBackupPlansCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns metadata of your saved backup plan templates, including the template ID, name, - * and the creation and deletion dates.

- */ - public listBackupPlanTemplates( + + /** + * @see {@link ListBackupPlanTemplatesCommand} + */ + listBackupPlanTemplates( args: ListBackupPlanTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBackupPlanTemplates( + listBackupPlanTemplates( args: ListBackupPlanTemplatesCommandInput, cb: (err: any, data?: ListBackupPlanTemplatesCommandOutput) => void ): void; - public listBackupPlanTemplates( + listBackupPlanTemplates( args: ListBackupPlanTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBackupPlanTemplatesCommandOutput) => void ): void; - public listBackupPlanTemplates( - args: ListBackupPlanTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBackupPlanTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListBackupPlanTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListBackupPlanTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), - * backup plan IDs, creation and deletion dates, plan names, and version IDs.

- */ - public listBackupPlanVersions( + + /** + * @see {@link ListBackupPlanVersionsCommand} + */ + listBackupPlanVersions( args: ListBackupPlanVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBackupPlanVersions( + listBackupPlanVersions( args: ListBackupPlanVersionsCommandInput, cb: (err: any, data?: ListBackupPlanVersionsCommandOutput) => void ): void; - public listBackupPlanVersions( + listBackupPlanVersions( args: ListBackupPlanVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBackupPlanVersionsCommandOutput) => void ): void; - public listBackupPlanVersions( - args: ListBackupPlanVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBackupPlanVersionsCommandOutput) => void), - cb?: (err: any, data?: ListBackupPlanVersionsCommandOutput) => void - ): Promise | void { - const command = new ListBackupPlanVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns an array containing metadata of the resources associated with the target backup - * plan.

- */ - public listBackupSelections( + + /** + * @see {@link ListBackupSelectionsCommand} + */ + listBackupSelections( args: ListBackupSelectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBackupSelections( + listBackupSelections( args: ListBackupSelectionsCommandInput, cb: (err: any, data?: ListBackupSelectionsCommandOutput) => void ): void; - public listBackupSelections( + listBackupSelections( args: ListBackupSelectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBackupSelectionsCommandOutput) => void ): void; - public listBackupSelections( - args: ListBackupSelectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBackupSelectionsCommandOutput) => void), - cb?: (err: any, data?: ListBackupSelectionsCommandOutput) => void - ): Promise | void { - const command = new ListBackupSelectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of recovery point storage containers along with information about - * them.

- */ - public listBackupVaults( + + /** + * @see {@link ListBackupVaultsCommand} + */ + listBackupVaults( args: ListBackupVaultsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBackupVaults( + listBackupVaults( args: ListBackupVaultsCommandInput, cb: (err: any, data?: ListBackupVaultsCommandOutput) => void ): void; - public listBackupVaults( + listBackupVaults( args: ListBackupVaultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBackupVaultsCommandOutput) => void ): void; - public listBackupVaults( - args: ListBackupVaultsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBackupVaultsCommandOutput) => void), - cb?: (err: any, data?: ListBackupVaultsCommandOutput) => void - ): Promise | void { - const command = new ListBackupVaultsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns metadata about your copy jobs.

- */ - public listCopyJobs( - args: ListCopyJobsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listCopyJobs(args: ListCopyJobsCommandInput, cb: (err: any, data?: ListCopyJobsCommandOutput) => void): void; - public listCopyJobs( + + /** + * @see {@link ListCopyJobsCommand} + */ + listCopyJobs(args: ListCopyJobsCommandInput, options?: __HttpHandlerOptions): Promise; + listCopyJobs(args: ListCopyJobsCommandInput, cb: (err: any, data?: ListCopyJobsCommandOutput) => void): void; + listCopyJobs( args: ListCopyJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCopyJobsCommandOutput) => void ): void; - public listCopyJobs( - args: ListCopyJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCopyJobsCommandOutput) => void), - cb?: (err: any, data?: ListCopyJobsCommandOutput) => void - ): Promise | void { - const command = new ListCopyJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.

- */ - public listFrameworks( + + /** + * @see {@link ListFrameworksCommand} + */ + listFrameworks( args: ListFrameworksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFrameworks( - args: ListFrameworksCommandInput, - cb: (err: any, data?: ListFrameworksCommandOutput) => void - ): void; - public listFrameworks( + listFrameworks(args: ListFrameworksCommandInput, cb: (err: any, data?: ListFrameworksCommandOutput) => void): void; + listFrameworks( args: ListFrameworksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFrameworksCommandOutput) => void ): void; - public listFrameworks( - args: ListFrameworksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFrameworksCommandOutput) => void), - cb?: (err: any, data?: ListFrameworksCommandOutput) => void - ): Promise | void { - const command = new ListFrameworksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This action returns metadata about active and previous legal holds.

- */ - public listLegalHolds( + + /** + * @see {@link ListLegalHoldsCommand} + */ + listLegalHolds( args: ListLegalHoldsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLegalHolds( - args: ListLegalHoldsCommandInput, - cb: (err: any, data?: ListLegalHoldsCommandOutput) => void - ): void; - public listLegalHolds( + listLegalHolds(args: ListLegalHoldsCommandInput, cb: (err: any, data?: ListLegalHoldsCommandOutput) => void): void; + listLegalHolds( args: ListLegalHoldsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLegalHoldsCommandOutput) => void ): void; - public listLegalHolds( - args: ListLegalHoldsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLegalHoldsCommandOutput) => void), - cb?: (err: any, data?: ListLegalHoldsCommandOutput) => void - ): Promise | void { - const command = new ListLegalHoldsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns an array of resources successfully backed up by Backup, including - * the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a - * resource type.

- */ - public listProtectedResources( + + /** + * @see {@link ListProtectedResourcesCommand} + */ + listProtectedResources( args: ListProtectedResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProtectedResources( + listProtectedResources( args: ListProtectedResourcesCommandInput, cb: (err: any, data?: ListProtectedResourcesCommandOutput) => void ): void; - public listProtectedResources( + listProtectedResources( args: ListProtectedResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProtectedResourcesCommandOutput) => void ): void; - public listProtectedResources( - args: ListProtectedResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProtectedResourcesCommandOutput) => void), - cb?: (err: any, data?: ListProtectedResourcesCommandOutput) => void - ): Promise | void { - const command = new ListProtectedResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns detailed information about the recovery points stored in a backup vault.

- */ - public listRecoveryPointsByBackupVault( + + /** + * @see {@link ListRecoveryPointsByBackupVaultCommand} + */ + listRecoveryPointsByBackupVault( args: ListRecoveryPointsByBackupVaultCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRecoveryPointsByBackupVault( + listRecoveryPointsByBackupVault( args: ListRecoveryPointsByBackupVaultCommandInput, cb: (err: any, data?: ListRecoveryPointsByBackupVaultCommandOutput) => void ): void; - public listRecoveryPointsByBackupVault( + listRecoveryPointsByBackupVault( args: ListRecoveryPointsByBackupVaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecoveryPointsByBackupVaultCommandOutput) => void ): void; - public listRecoveryPointsByBackupVault( - args: ListRecoveryPointsByBackupVaultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRecoveryPointsByBackupVaultCommandOutput) => void), - cb?: (err: any, data?: ListRecoveryPointsByBackupVaultCommandOutput) => void - ): Promise | void { - const command = new ListRecoveryPointsByBackupVaultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This action returns recovery point ARNs (Amazon Resource Names) of the - * specified legal hold.

- */ - public listRecoveryPointsByLegalHold( + + /** + * @see {@link ListRecoveryPointsByLegalHoldCommand} + */ + listRecoveryPointsByLegalHold( args: ListRecoveryPointsByLegalHoldCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRecoveryPointsByLegalHold( + listRecoveryPointsByLegalHold( args: ListRecoveryPointsByLegalHoldCommandInput, cb: (err: any, data?: ListRecoveryPointsByLegalHoldCommandOutput) => void ): void; - public listRecoveryPointsByLegalHold( + listRecoveryPointsByLegalHold( args: ListRecoveryPointsByLegalHoldCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecoveryPointsByLegalHoldCommandOutput) => void ): void; - public listRecoveryPointsByLegalHold( - args: ListRecoveryPointsByLegalHoldCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRecoveryPointsByLegalHoldCommandOutput) => void), - cb?: (err: any, data?: ListRecoveryPointsByLegalHoldCommandOutput) => void - ): Promise | void { - const command = new ListRecoveryPointsByLegalHoldCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns detailed information about all the recovery points of the type specified by a - * resource Amazon Resource Name (ARN).

- * - *

For Amazon EFS and Amazon EC2, this action only lists recovery points - * created by Backup.

- *
- */ - public listRecoveryPointsByResource( + + /** + * @see {@link ListRecoveryPointsByResourceCommand} + */ + listRecoveryPointsByResource( args: ListRecoveryPointsByResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRecoveryPointsByResource( + listRecoveryPointsByResource( args: ListRecoveryPointsByResourceCommandInput, cb: (err: any, data?: ListRecoveryPointsByResourceCommandOutput) => void ): void; - public listRecoveryPointsByResource( + listRecoveryPointsByResource( args: ListRecoveryPointsByResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecoveryPointsByResourceCommandOutput) => void ): void; - public listRecoveryPointsByResource( - args: ListRecoveryPointsByResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRecoveryPointsByResourceCommandOutput) => void), - cb?: (err: any, data?: ListRecoveryPointsByResourceCommandOutput) => void - ): Promise | void { - const command = new ListRecoveryPointsByResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns details about your report jobs.

- */ - public listReportJobs( + + /** + * @see {@link ListReportJobsCommand} + */ + listReportJobs( args: ListReportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReportJobs( - args: ListReportJobsCommandInput, - cb: (err: any, data?: ListReportJobsCommandOutput) => void - ): void; - public listReportJobs( + listReportJobs(args: ListReportJobsCommandInput, cb: (err: any, data?: ListReportJobsCommandOutput) => void): void; + listReportJobs( args: ListReportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReportJobsCommandOutput) => void ): void; - public listReportJobs( - args: ListReportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReportJobsCommandOutput) => void), - cb?: (err: any, data?: ListReportJobsCommandOutput) => void - ): Promise | void { - const command = new ListReportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of your report plans. For detailed information about a single report - * plan, use DescribeReportPlan.

- */ - public listReportPlans( + + /** + * @see {@link ListReportPlansCommand} + */ + listReportPlans( args: ListReportPlansCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReportPlans( - args: ListReportPlansCommandInput, - cb: (err: any, data?: ListReportPlansCommandOutput) => void - ): void; - public listReportPlans( + listReportPlans(args: ListReportPlansCommandInput, cb: (err: any, data?: ListReportPlansCommandOutput) => void): void; + listReportPlans( args: ListReportPlansCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReportPlansCommandOutput) => void ): void; - public listReportPlans( - args: ListReportPlansCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReportPlansCommandOutput) => void), - cb?: (err: any, data?: ListReportPlansCommandOutput) => void - ): Promise | void { - const command = new ListReportPlansCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of jobs that Backup initiated to restore a saved resource, - * including details about the recovery process.

- */ - public listRestoreJobs( + + /** + * @see {@link ListRestoreJobsCommand} + */ + listRestoreJobs( args: ListRestoreJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRestoreJobs( - args: ListRestoreJobsCommandInput, - cb: (err: any, data?: ListRestoreJobsCommandOutput) => void - ): void; - public listRestoreJobs( + listRestoreJobs(args: ListRestoreJobsCommandInput, cb: (err: any, data?: ListRestoreJobsCommandOutput) => void): void; + listRestoreJobs( args: ListRestoreJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRestoreJobsCommandOutput) => void ): void; - public listRestoreJobs( - args: ListRestoreJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRestoreJobsCommandOutput) => void), - cb?: (err: any, data?: ListRestoreJobsCommandOutput) => void - ): Promise | void { - const command = new ListRestoreJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of key-value pairs assigned to a target recovery point, backup plan, or - * backup vault.

- *

- * ListTags only works for resource types that support full Backup - * management of their backups. Those resource types are listed in the "Full Backup management" section of the Feature - * availability by resource table.

- */ - public listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; - public listTags( + + /** + * @see {@link ListTagsCommand} + */ + listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; + listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; + listTags( args: ListTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsCommandOutput) => void ): void; - public listTags( - args: ListTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsCommandOutput) => void), - cb?: (err: any, data?: ListTagsCommandOutput) => void - ): Promise | void { - const command = new ListTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets a resource-based policy that is used to manage access permissions on the target - * backup vault. Requires a backup vault name and an access policy document in JSON - * format.

- */ - public putBackupVaultAccessPolicy( + + /** + * @see {@link PutBackupVaultAccessPolicyCommand} + */ + putBackupVaultAccessPolicy( args: PutBackupVaultAccessPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBackupVaultAccessPolicy( + putBackupVaultAccessPolicy( args: PutBackupVaultAccessPolicyCommandInput, cb: (err: any, data?: PutBackupVaultAccessPolicyCommandOutput) => void ): void; - public putBackupVaultAccessPolicy( + putBackupVaultAccessPolicy( args: PutBackupVaultAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBackupVaultAccessPolicyCommandOutput) => void ): void; - public putBackupVaultAccessPolicy( - args: PutBackupVaultAccessPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBackupVaultAccessPolicyCommandOutput) => void), - cb?: (err: any, data?: PutBackupVaultAccessPolicyCommandOutput) => void - ): Promise | void { - const command = new PutBackupVaultAccessPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Applies Backup Vault Lock to a backup vault, preventing attempts to delete - * any recovery point stored in or created in a backup vault. Vault Lock also prevents - * attempts to update the lifecycle policy that controls the retention period of any recovery - * point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and - * maximum retention period for future backup and copy jobs that target a backup vault.

- * - *

Backup Vault Lock has been assessed by Cohasset Associates for use in environments - * that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about - * how Backup Vault Lock relates to these regulations, see the - * Cohasset Associates - * Compliance Assessment. - *

- *
- */ - public putBackupVaultLockConfiguration( + + /** + * @see {@link PutBackupVaultLockConfigurationCommand} + */ + putBackupVaultLockConfiguration( args: PutBackupVaultLockConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBackupVaultLockConfiguration( + putBackupVaultLockConfiguration( args: PutBackupVaultLockConfigurationCommandInput, cb: (err: any, data?: PutBackupVaultLockConfigurationCommandOutput) => void ): void; - public putBackupVaultLockConfiguration( + putBackupVaultLockConfiguration( args: PutBackupVaultLockConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBackupVaultLockConfigurationCommandOutput) => void ): void; - public putBackupVaultLockConfiguration( - args: PutBackupVaultLockConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBackupVaultLockConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutBackupVaultLockConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutBackupVaultLockConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Turns on notifications on a backup vault for the specified topic and events.

- */ - public putBackupVaultNotifications( + + /** + * @see {@link PutBackupVaultNotificationsCommand} + */ + putBackupVaultNotifications( args: PutBackupVaultNotificationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBackupVaultNotifications( + putBackupVaultNotifications( args: PutBackupVaultNotificationsCommandInput, cb: (err: any, data?: PutBackupVaultNotificationsCommandOutput) => void ): void; - public putBackupVaultNotifications( + putBackupVaultNotifications( args: PutBackupVaultNotificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBackupVaultNotificationsCommandOutput) => void ): void; - public putBackupVaultNotifications( - args: PutBackupVaultNotificationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBackupVaultNotificationsCommandOutput) => void), - cb?: (err: any, data?: PutBackupVaultNotificationsCommandOutput) => void - ): Promise | void { - const command = new PutBackupVaultNotificationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts an on-demand backup job for the specified resource.

- */ - public startBackupJob( + + /** + * @see {@link StartBackupJobCommand} + */ + startBackupJob( args: StartBackupJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startBackupJob( - args: StartBackupJobCommandInput, - cb: (err: any, data?: StartBackupJobCommandOutput) => void - ): void; - public startBackupJob( + startBackupJob(args: StartBackupJobCommandInput, cb: (err: any, data?: StartBackupJobCommandOutput) => void): void; + startBackupJob( args: StartBackupJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartBackupJobCommandOutput) => void ): void; - public startBackupJob( - args: StartBackupJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartBackupJobCommandOutput) => void), - cb?: (err: any, data?: StartBackupJobCommandOutput) => void - ): Promise | void { - const command = new StartBackupJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a job to create a one-time copy of the specified resource.

- *

Does not support continuous backups.

- */ - public startCopyJob( - args: StartCopyJobCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public startCopyJob(args: StartCopyJobCommandInput, cb: (err: any, data?: StartCopyJobCommandOutput) => void): void; - public startCopyJob( + + /** + * @see {@link StartCopyJobCommand} + */ + startCopyJob(args: StartCopyJobCommandInput, options?: __HttpHandlerOptions): Promise; + startCopyJob(args: StartCopyJobCommandInput, cb: (err: any, data?: StartCopyJobCommandOutput) => void): void; + startCopyJob( args: StartCopyJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCopyJobCommandOutput) => void ): void; - public startCopyJob( - args: StartCopyJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartCopyJobCommandOutput) => void), - cb?: (err: any, data?: StartCopyJobCommandOutput) => void - ): Promise | void { - const command = new StartCopyJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts an on-demand report job for the specified report plan.

- */ - public startReportJob( + + /** + * @see {@link StartReportJobCommand} + */ + startReportJob( args: StartReportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startReportJob( - args: StartReportJobCommandInput, - cb: (err: any, data?: StartReportJobCommandOutput) => void - ): void; - public startReportJob( + startReportJob(args: StartReportJobCommandInput, cb: (err: any, data?: StartReportJobCommandOutput) => void): void; + startReportJob( args: StartReportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartReportJobCommandOutput) => void ): void; - public startReportJob( - args: StartReportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartReportJobCommandOutput) => void), - cb?: (err: any, data?: StartReportJobCommandOutput) => void - ): Promise | void { - const command = new StartReportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Recovers the saved resource identified by an Amazon Resource Name (ARN).

- */ - public startRestoreJob( + + /** + * @see {@link StartRestoreJobCommand} + */ + startRestoreJob( args: StartRestoreJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startRestoreJob( - args: StartRestoreJobCommandInput, - cb: (err: any, data?: StartRestoreJobCommandOutput) => void - ): void; - public startRestoreJob( + startRestoreJob(args: StartRestoreJobCommandInput, cb: (err: any, data?: StartRestoreJobCommandOutput) => void): void; + startRestoreJob( args: StartRestoreJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartRestoreJobCommandOutput) => void ): void; - public startRestoreJob( - args: StartRestoreJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartRestoreJobCommandOutput) => void), - cb?: (err: any, data?: StartRestoreJobCommandOutput) => void - ): Promise | void { - const command = new StartRestoreJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attempts to cancel a job to create a one-time backup of a resource.

- *

This action is not supported for the following services: - * Amazon FSx for Windows File Server, Amazon FSx for Lustre, FSx for ONTAP - * , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, - * and Amazon Neptune.

- */ - public stopBackupJob( - args: StopBackupJobCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public stopBackupJob( - args: StopBackupJobCommandInput, - cb: (err: any, data?: StopBackupJobCommandOutput) => void - ): void; - public stopBackupJob( + + /** + * @see {@link StopBackupJobCommand} + */ + stopBackupJob(args: StopBackupJobCommandInput, options?: __HttpHandlerOptions): Promise; + stopBackupJob(args: StopBackupJobCommandInput, cb: (err: any, data?: StopBackupJobCommandOutput) => void): void; + stopBackupJob( args: StopBackupJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopBackupJobCommandOutput) => void ): void; - public stopBackupJob( - args: StopBackupJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopBackupJobCommandOutput) => void), - cb?: (err: any, data?: StopBackupJobCommandOutput) => void - ): Promise | void { - const command = new StopBackupJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault - * identified by an Amazon Resource Name (ARN).

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a set of key-value pairs from a recovery point, backup plan, or backup vault - * identified by an Amazon Resource Name (ARN)

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing backup plan identified by its backupPlanId with the - * input document in JSON format. The new version is uniquely identified by a - * VersionId.

- */ - public updateBackupPlan( + + /** + * @see {@link UpdateBackupPlanCommand} + */ + updateBackupPlan( args: UpdateBackupPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBackupPlan( + updateBackupPlan( args: UpdateBackupPlanCommandInput, cb: (err: any, data?: UpdateBackupPlanCommandOutput) => void ): void; - public updateBackupPlan( + updateBackupPlan( args: UpdateBackupPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBackupPlanCommandOutput) => void ): void; - public updateBackupPlan( - args: UpdateBackupPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBackupPlanCommandOutput) => void), - cb?: (err: any, data?: UpdateBackupPlanCommandOutput) => void - ): Promise | void { - const command = new UpdateBackupPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing framework identified by its FrameworkName with the - * input document in JSON format.

- */ - public updateFramework( + + /** + * @see {@link UpdateFrameworkCommand} + */ + updateFramework( args: UpdateFrameworkCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFramework( - args: UpdateFrameworkCommandInput, - cb: (err: any, data?: UpdateFrameworkCommandOutput) => void - ): void; - public updateFramework( + updateFramework(args: UpdateFrameworkCommandInput, cb: (err: any, data?: UpdateFrameworkCommandOutput) => void): void; + updateFramework( args: UpdateFrameworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFrameworkCommandOutput) => void ): void; - public updateFramework( - args: UpdateFrameworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFrameworkCommandOutput) => void), - cb?: (err: any, data?: UpdateFrameworkCommandOutput) => void - ): Promise | void { - const command = new UpdateFrameworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates whether the Amazon Web Services account is opted in to cross-account backup. - * Returns an error if the account is not an Organizations management account. Use the - * DescribeGlobalSettings API to determine the current settings.

- */ - public updateGlobalSettings( + + /** + * @see {@link UpdateGlobalSettingsCommand} + */ + updateGlobalSettings( args: UpdateGlobalSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGlobalSettings( + updateGlobalSettings( args: UpdateGlobalSettingsCommandInput, cb: (err: any, data?: UpdateGlobalSettingsCommandOutput) => void ): void; - public updateGlobalSettings( + updateGlobalSettings( args: UpdateGlobalSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGlobalSettingsCommandOutput) => void ): void; - public updateGlobalSettings( - args: UpdateGlobalSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGlobalSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateGlobalSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateGlobalSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the transition lifecycle of a recovery point.

- *

The lifecycle defines when a protected resource is transitioned to cold storage and when - * it expires. Backup transitions and expires backups automatically according to - * the lifecycle that you define.

- *

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 - * days. Therefore, the “retention” setting must be 90 days greater than the “transition to - * cold after days” setting. The “transition to cold after days” setting cannot be changed - * after a backup has been transitioned to cold.

- *

Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" - * section of the - * Feature availability by resource table. Backup ignores this expression for - * other resource types.

- *

This operation does not support continuous backups.

- */ - public updateRecoveryPointLifecycle( + + /** + * @see {@link UpdateRecoveryPointLifecycleCommand} + */ + updateRecoveryPointLifecycle( args: UpdateRecoveryPointLifecycleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRecoveryPointLifecycle( + updateRecoveryPointLifecycle( args: UpdateRecoveryPointLifecycleCommandInput, cb: (err: any, data?: UpdateRecoveryPointLifecycleCommandOutput) => void ): void; - public updateRecoveryPointLifecycle( + updateRecoveryPointLifecycle( args: UpdateRecoveryPointLifecycleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRecoveryPointLifecycleCommandOutput) => void ): void; - public updateRecoveryPointLifecycle( - args: UpdateRecoveryPointLifecycleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRecoveryPointLifecycleCommandOutput) => void), - cb?: (err: any, data?: UpdateRecoveryPointLifecycleCommandOutput) => void - ): Promise | void { - const command = new UpdateRecoveryPointLifecycleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the current service opt-in settings for the Region. If service-opt-in is enabled - * for a service, Backup tries to protect that service's resources in this Region, - * when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, - * Backup does not try to protect that service's resources in this Region. Use - * the DescribeRegionSettings API to determine the resource types that are - * supported.

- */ - public updateRegionSettings( + + /** + * @see {@link UpdateRegionSettingsCommand} + */ + updateRegionSettings( args: UpdateRegionSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRegionSettings( + updateRegionSettings( args: UpdateRegionSettingsCommandInput, cb: (err: any, data?: UpdateRegionSettingsCommandOutput) => void ): void; - public updateRegionSettings( + updateRegionSettings( args: UpdateRegionSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRegionSettingsCommandOutput) => void ): void; - public updateRegionSettings( - args: UpdateRegionSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRegionSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateRegionSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateRegionSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing report plan identified by its ReportPlanName with the - * input document in JSON format.

- */ - public updateReportPlan( + + /** + * @see {@link UpdateReportPlanCommand} + */ + updateReportPlan( args: UpdateReportPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateReportPlan( + updateReportPlan( args: UpdateReportPlanCommandInput, cb: (err: any, data?: UpdateReportPlanCommandOutput) => void ): void; - public updateReportPlan( + updateReportPlan( args: UpdateReportPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateReportPlanCommandOutput) => void ): void; - public updateReportPlan( - args: UpdateReportPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateReportPlanCommandOutput) => void), - cb?: (err: any, data?: UpdateReportPlanCommandOutput) => void - ): Promise | void { - const command = new UpdateReportPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Backup + *

Backup is a unified backup service designed to protect Amazon Web Services + * services and their associated data. Backup simplifies the creation, migration, + * restoration, and deletion of backups, while also providing reporting and + * auditing.

+ */ +export class Backup extends BackupClient implements Backup {} +createAggregatedClient(commands, Backup); diff --git a/clients/client-backupstorage/src/BackupStorage.ts b/clients/client-backupstorage/src/BackupStorage.ts index 31c2e00c8b94..2f1e0347e205 100644 --- a/clients/client-backupstorage/src/BackupStorage.ts +++ b/clients/client-backupstorage/src/BackupStorage.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { BackupStorageClient } from "./BackupStorageClient"; +import { BackupStorageClient, BackupStorageClientConfig } from "./BackupStorageClient"; import { DeleteObjectCommand, DeleteObjectCommandInput, @@ -24,266 +25,134 @@ import { PutChunkCommand, PutChunkCommandInput, PutChunkCommandOutput } from "./ import { PutObjectCommand, PutObjectCommandInput, PutObjectCommandOutput } from "./commands/PutObjectCommand"; import { StartObjectCommand, StartObjectCommandInput, StartObjectCommandOutput } from "./commands/StartObjectCommand"; -/** - * @public - * The frontend service for Cryo Storage. - */ -export class BackupStorage extends BackupStorageClient { +const commands = { + DeleteObjectCommand, + GetChunkCommand, + GetObjectMetadataCommand, + ListChunksCommand, + ListObjectsCommand, + NotifyObjectCompleteCommand, + PutChunkCommand, + PutObjectCommand, + StartObjectCommand, +}; + +export interface BackupStorage { /** - * @public - * Delete Object from the incremental base Backup. + * @see {@link DeleteObjectCommand} */ - public deleteObject( - args: DeleteObjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteObject(args: DeleteObjectCommandInput, cb: (err: any, data?: DeleteObjectCommandOutput) => void): void; - public deleteObject( + deleteObject(args: DeleteObjectCommandInput, options?: __HttpHandlerOptions): Promise; + deleteObject(args: DeleteObjectCommandInput, cb: (err: any, data?: DeleteObjectCommandOutput) => void): void; + deleteObject( args: DeleteObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteObjectCommandOutput) => void ): void; - public deleteObject( - args: DeleteObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteObjectCommandOutput) => void), - cb?: (err: any, data?: DeleteObjectCommandOutput) => void - ): Promise | void { - const command = new DeleteObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Gets the specified object's chunk. + * @see {@link GetChunkCommand} */ - public getChunk(args: GetChunkCommandInput, options?: __HttpHandlerOptions): Promise; - public getChunk(args: GetChunkCommandInput, cb: (err: any, data?: GetChunkCommandOutput) => void): void; - public getChunk( + getChunk(args: GetChunkCommandInput, options?: __HttpHandlerOptions): Promise; + getChunk(args: GetChunkCommandInput, cb: (err: any, data?: GetChunkCommandOutput) => void): void; + getChunk( args: GetChunkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChunkCommandOutput) => void ): void; - public getChunk( - args: GetChunkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetChunkCommandOutput) => void), - cb?: (err: any, data?: GetChunkCommandOutput) => void - ): Promise | void { - const command = new GetChunkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Get metadata associated with an Object. + * @see {@link GetObjectMetadataCommand} */ - public getObjectMetadata( + getObjectMetadata( args: GetObjectMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getObjectMetadata( + getObjectMetadata( args: GetObjectMetadataCommandInput, cb: (err: any, data?: GetObjectMetadataCommandOutput) => void ): void; - public getObjectMetadata( + getObjectMetadata( args: GetObjectMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetObjectMetadataCommandOutput) => void ): void; - public getObjectMetadata( - args: GetObjectMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetObjectMetadataCommandOutput) => void), - cb?: (err: any, data?: GetObjectMetadataCommandOutput) => void - ): Promise | void { - const command = new GetObjectMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * List chunks in a given Object + * @see {@link ListChunksCommand} */ - public listChunks(args: ListChunksCommandInput, options?: __HttpHandlerOptions): Promise; - public listChunks(args: ListChunksCommandInput, cb: (err: any, data?: ListChunksCommandOutput) => void): void; - public listChunks( + listChunks(args: ListChunksCommandInput, options?: __HttpHandlerOptions): Promise; + listChunks(args: ListChunksCommandInput, cb: (err: any, data?: ListChunksCommandOutput) => void): void; + listChunks( args: ListChunksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChunksCommandOutput) => void ): void; - public listChunks( - args: ListChunksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListChunksCommandOutput) => void), - cb?: (err: any, data?: ListChunksCommandOutput) => void - ): Promise | void { - const command = new ListChunksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * List all Objects in a given Backup. + * @see {@link ListObjectsCommand} */ - public listObjects(args: ListObjectsCommandInput, options?: __HttpHandlerOptions): Promise; - public listObjects(args: ListObjectsCommandInput, cb: (err: any, data?: ListObjectsCommandOutput) => void): void; - public listObjects( + listObjects(args: ListObjectsCommandInput, options?: __HttpHandlerOptions): Promise; + listObjects(args: ListObjectsCommandInput, cb: (err: any, data?: ListObjectsCommandOutput) => void): void; + listObjects( args: ListObjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListObjectsCommandOutput) => void ): void; - public listObjects( - args: ListObjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListObjectsCommandOutput) => void), - cb?: (err: any, data?: ListObjectsCommandOutput) => void - ): Promise | void { - const command = new ListObjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Complete upload + * @see {@link NotifyObjectCompleteCommand} */ - public notifyObjectComplete( + notifyObjectComplete( args: NotifyObjectCompleteCommandInput, options?: __HttpHandlerOptions ): Promise; - public notifyObjectComplete( + notifyObjectComplete( args: NotifyObjectCompleteCommandInput, cb: (err: any, data?: NotifyObjectCompleteCommandOutput) => void ): void; - public notifyObjectComplete( + notifyObjectComplete( args: NotifyObjectCompleteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NotifyObjectCompleteCommandOutput) => void ): void; - public notifyObjectComplete( - args: NotifyObjectCompleteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NotifyObjectCompleteCommandOutput) => void), - cb?: (err: any, data?: NotifyObjectCompleteCommandOutput) => void - ): Promise | void { - const command = new NotifyObjectCompleteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Upload chunk. + * @see {@link PutChunkCommand} */ - public putChunk(args: PutChunkCommandInput, options?: __HttpHandlerOptions): Promise; - public putChunk(args: PutChunkCommandInput, cb: (err: any, data?: PutChunkCommandOutput) => void): void; - public putChunk( + putChunk(args: PutChunkCommandInput, options?: __HttpHandlerOptions): Promise; + putChunk(args: PutChunkCommandInput, cb: (err: any, data?: PutChunkCommandOutput) => void): void; + putChunk( args: PutChunkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutChunkCommandOutput) => void ): void; - public putChunk( - args: PutChunkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutChunkCommandOutput) => void), - cb?: (err: any, data?: PutChunkCommandOutput) => void - ): Promise | void { - const command = new PutChunkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Upload object that can store object metadata String and data blob in single API call using inline chunk field. + * @see {@link PutObjectCommand} */ - public putObject(args: PutObjectCommandInput, options?: __HttpHandlerOptions): Promise; - public putObject(args: PutObjectCommandInput, cb: (err: any, data?: PutObjectCommandOutput) => void): void; - public putObject( + putObject(args: PutObjectCommandInput, options?: __HttpHandlerOptions): Promise; + putObject(args: PutObjectCommandInput, cb: (err: any, data?: PutObjectCommandOutput) => void): void; + putObject( args: PutObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutObjectCommandOutput) => void ): void; - public putObject( - args: PutObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutObjectCommandOutput) => void), - cb?: (err: any, data?: PutObjectCommandOutput) => void - ): Promise | void { - const command = new PutObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Start upload containing one or many chunks. + * @see {@link StartObjectCommand} */ - public startObject(args: StartObjectCommandInput, options?: __HttpHandlerOptions): Promise; - public startObject(args: StartObjectCommandInput, cb: (err: any, data?: StartObjectCommandOutput) => void): void; - public startObject( + startObject(args: StartObjectCommandInput, options?: __HttpHandlerOptions): Promise; + startObject(args: StartObjectCommandInput, cb: (err: any, data?: StartObjectCommandOutput) => void): void; + startObject( args: StartObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartObjectCommandOutput) => void ): void; - public startObject( - args: StartObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartObjectCommandOutput) => void), - cb?: (err: any, data?: StartObjectCommandOutput) => void - ): Promise | void { - const command = new StartObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * The frontend service for Cryo Storage. + */ +export class BackupStorage extends BackupStorageClient implements BackupStorage {} +createAggregatedClient(commands, BackupStorage); diff --git a/clients/client-batch/src/Batch.ts b/clients/client-batch/src/Batch.ts index eb0d1a7a5788..b9be5af5f9a6 100644 --- a/clients/client-batch/src/Batch.ts +++ b/clients/client-batch/src/Batch.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { BatchClient } from "./BatchClient"; +import { BatchClient, BatchClientConfig } from "./BatchClient"; import { CancelJobCommand, CancelJobCommandInput, CancelJobCommandOutput } from "./commands/CancelJobCommand"; import { CreateComputeEnvironmentCommand, @@ -107,918 +108,405 @@ import { UpdateSchedulingPolicyCommandOutput, } from "./commands/UpdateSchedulingPolicyCommand"; -/** - * @public - * Batch - *

Using Batch, you can run batch computing workloads on the Amazon Web Services Cloud. Batch computing is a common means for - * developers, scientists, and engineers to access large amounts of compute resources. Batch uses the advantages of - * the batch computing to remove the undifferentiated heavy lifting of configuring and managing required infrastructure. - * At the same time, it also adopts a familiar batch computing software approach. You can use Batch to efficiently - * provision resources d, and work toward eliminating capacity constraints, reducing your overall compute costs, and - * delivering results more quickly.

- *

As a fully managed service, Batch can run batch computing workloads of any scale. Batch automatically - * provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific - * workloads. With Batch, there's no need to install or manage batch computing software. This means that you can focus - * on analyzing results and solving your specific problems instead.

- */ -export class Batch extends BatchClient { +const commands = { + CancelJobCommand, + CreateComputeEnvironmentCommand, + CreateJobQueueCommand, + CreateSchedulingPolicyCommand, + DeleteComputeEnvironmentCommand, + DeleteJobQueueCommand, + DeleteSchedulingPolicyCommand, + DeregisterJobDefinitionCommand, + DescribeComputeEnvironmentsCommand, + DescribeJobDefinitionsCommand, + DescribeJobQueuesCommand, + DescribeJobsCommand, + DescribeSchedulingPoliciesCommand, + ListJobsCommand, + ListSchedulingPoliciesCommand, + ListTagsForResourceCommand, + RegisterJobDefinitionCommand, + SubmitJobCommand, + TagResourceCommand, + TerminateJobCommand, + UntagResourceCommand, + UpdateComputeEnvironmentCommand, + UpdateJobQueueCommand, + UpdateSchedulingPolicyCommand, +}; + +export interface Batch { /** - * @public - *

Cancels a job in an Batch job queue. Jobs that are in the - * SUBMITTED - * or - * PENDING - * are - * canceled. A job - * inRUNNABLE remains in RUNNABLE until it reaches the head of the - * job queue. Then the job status is updated to - * FAILED.

- *

Jobs that progressed to the STARTING or - * RUNNING state aren't canceled. However, the API operation still succeeds, even - * if no job is canceled. These jobs must be terminated with the TerminateJob - * operation.

+ * @see {@link CancelJobCommand} */ - public cancelJob(args: CancelJobCommandInput, options?: __HttpHandlerOptions): Promise; - public cancelJob(args: CancelJobCommandInput, cb: (err: any, data?: CancelJobCommandOutput) => void): void; - public cancelJob( + cancelJob(args: CancelJobCommandInput, options?: __HttpHandlerOptions): Promise; + cancelJob(args: CancelJobCommandInput, cb: (err: any, data?: CancelJobCommandOutput) => void): void; + cancelJob( args: CancelJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelJobCommandOutput) => void ): void; - public cancelJob( - args: CancelJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelJobCommandOutput) => void), - cb?: (err: any, data?: CancelJobCommandOutput) => void - ): Promise | void { - const command = new CancelJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute - * environments. MANAGED compute environments can use Amazon EC2 or Fargate resources. - * UNMANAGED compute environments can only use EC2 resources.

- *

In a managed compute environment, Batch manages the capacity and instance types of the compute resources - * within the environment. This is based on the compute resource specification that you define or the launch template that you - * specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot - * Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can - * optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a - * specified percentage of the On-Demand price.

- * - *

Multi-node parallel jobs aren't supported on Spot Instances.

- *
- *

In an unmanaged compute environment, you can manage your own EC2 compute resources and have flexibility with how - * you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of - * your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the - * Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch - * your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the - * Amazon Elastic Container Service Developer Guide.

- * - *

To create a compute environment that uses EKS resources, the caller must have permissions to call - * eks:DescribeCluster.

- *
- * - *

Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it - * also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is - * available. You're responsible for the management of the guest operating system. This includes any updates and - * security patches. You're also responsible for any additional application software or utilities that you install on - * the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete - * these steps:

- *
    - *
  1. - *

    Create a new compute environment with the new AMI.

    - *
  2. - *
  3. - *

    Add the compute environment to an existing job queue.

    - *
  4. - *
  5. - *

    Remove the earlier compute environment from your job queue.

    - *
  6. - *
  7. - *

    Delete the earlier compute environment.

    - *
  8. - *
- *

In April 2022, Batch added enhanced support for updating compute environments. For more information, see - * Updating compute - * environments. To use the enhanced updating of compute environments to update AMIs, follow these - * rules:

- *
    - *
  • - *

    Either don't set the service role (serviceRole) parameter or set it to the AWSBatchServiceRole service-linked role.

    - *
  • - *
  • - *

    Set the allocation strategy (allocationStrategy) parameter to BEST_FIT_PROGRESSIVE - * or SPOT_CAPACITY_OPTIMIZED.

    - *
  • - *
  • - *

    Set the update to latest image version (updateToLatestImageVersion) parameter to - * true.

    - *
  • - *
  • - *

    Don't specify an AMI ID in imageId, imageIdOverride (in - * ec2Configuration - * ), or in the launch - * template (launchTemplate). In that case, Batch selects the latest Amazon ECS optimized AMI that's - * supported by Batch at the time the infrastructure update is initiated. Alternatively, you can specify the AMI ID - * in the imageId or imageIdOverride parameters, or the launch template identified by the - * LaunchTemplate properties. Changing any of these properties starts an infrastructure update. If the - * AMI ID is specified in the launch template, it can't be replaced by specifying an AMI ID in either the - * imageId or imageIdOverride parameters. It can only be replaced by specifying a different - * launch template, or if the launch template version is set to $Default or $Latest, by - * setting either a new default version for the launch template (if $Default) or by adding a new version - * to the launch template (if $Latest).

    - *
  • - *
- *

If these rules are followed, any update that starts an infrastructure update causes the AMI ID to be - * re-selected. If the version setting in the launch template (launchTemplate) is set to - * $Latest or $Default, the latest or default version of the launch template is evaluated up - * at the time of the infrastructure update, even if the launchTemplate wasn't updated.

- *
+ * @see {@link CreateComputeEnvironmentCommand} */ - public createComputeEnvironment( + createComputeEnvironment( args: CreateComputeEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createComputeEnvironment( + createComputeEnvironment( args: CreateComputeEnvironmentCommandInput, cb: (err: any, data?: CreateComputeEnvironmentCommandOutput) => void ): void; - public createComputeEnvironment( + createComputeEnvironment( args: CreateComputeEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateComputeEnvironmentCommandOutput) => void ): void; - public createComputeEnvironment( - args: CreateComputeEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateComputeEnvironmentCommandOutput) => void), - cb?: (err: any, data?: CreateComputeEnvironmentCommandOutput) => void - ): Promise | void { - const command = new CreateComputeEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Batch job queue. When you create a job queue, you associate one or more compute environments to the - * queue and assign an order of preference for the compute environments.

- *

You also set a priority to the job queue that determines the order that the Batch scheduler places jobs onto - * its associated compute environments. For example, if a compute environment is associated with more than one job - * queue, the job queue with a higher priority is given preference for scheduling jobs to that compute - * environment.

+ * @see {@link CreateJobQueueCommand} */ - public createJobQueue( + createJobQueue( args: CreateJobQueueCommandInput, options?: __HttpHandlerOptions ): Promise; - public createJobQueue( - args: CreateJobQueueCommandInput, - cb: (err: any, data?: CreateJobQueueCommandOutput) => void - ): void; - public createJobQueue( + createJobQueue(args: CreateJobQueueCommandInput, cb: (err: any, data?: CreateJobQueueCommandOutput) => void): void; + createJobQueue( args: CreateJobQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateJobQueueCommandOutput) => void ): void; - public createJobQueue( - args: CreateJobQueueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateJobQueueCommandOutput) => void), - cb?: (err: any, data?: CreateJobQueueCommandOutput) => void - ): Promise | void { - const command = new CreateJobQueueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Batch scheduling policy.

+ * @see {@link CreateSchedulingPolicyCommand} */ - public createSchedulingPolicy( + createSchedulingPolicy( args: CreateSchedulingPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSchedulingPolicy( + createSchedulingPolicy( args: CreateSchedulingPolicyCommandInput, cb: (err: any, data?: CreateSchedulingPolicyCommandOutput) => void ): void; - public createSchedulingPolicy( + createSchedulingPolicy( args: CreateSchedulingPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSchedulingPolicyCommandOutput) => void ): void; - public createSchedulingPolicy( - args: CreateSchedulingPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSchedulingPolicyCommandOutput) => void), - cb?: (err: any, data?: CreateSchedulingPolicyCommandOutput) => void - ): Promise | void { - const command = new CreateSchedulingPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Batch compute environment.

- *

Before you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation. Compute environments that use Fargate resources must terminate all - * active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute - * environment enters an invalid state.

+ * @see {@link DeleteComputeEnvironmentCommand} */ - public deleteComputeEnvironment( + deleteComputeEnvironment( args: DeleteComputeEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteComputeEnvironment( + deleteComputeEnvironment( args: DeleteComputeEnvironmentCommandInput, cb: (err: any, data?: DeleteComputeEnvironmentCommandOutput) => void ): void; - public deleteComputeEnvironment( + deleteComputeEnvironment( args: DeleteComputeEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteComputeEnvironmentCommandOutput) => void ): void; - public deleteComputeEnvironment( - args: DeleteComputeEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteComputeEnvironmentCommandOutput) => void), - cb?: (err: any, data?: DeleteComputeEnvironmentCommandOutput) => void - ): Promise | void { - const command = new DeleteComputeEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are eventually terminated when you delete a job queue. - * The jobs are terminated at a rate of about 16 jobs each second.

- *

It's not necessary to disassociate compute environments from a queue before submitting a - * DeleteJobQueue request.

+ * @see {@link DeleteJobQueueCommand} */ - public deleteJobQueue( + deleteJobQueue( args: DeleteJobQueueCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteJobQueue( - args: DeleteJobQueueCommandInput, - cb: (err: any, data?: DeleteJobQueueCommandOutput) => void - ): void; - public deleteJobQueue( + deleteJobQueue(args: DeleteJobQueueCommandInput, cb: (err: any, data?: DeleteJobQueueCommandOutput) => void): void; + deleteJobQueue( args: DeleteJobQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteJobQueueCommandOutput) => void ): void; - public deleteJobQueue( - args: DeleteJobQueueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteJobQueueCommandOutput) => void), - cb?: (err: any, data?: DeleteJobQueueCommandOutput) => void - ): Promise | void { - const command = new DeleteJobQueueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified scheduling policy.

- *

You can't delete a scheduling policy that's used in any job queues.

+ * @see {@link DeleteSchedulingPolicyCommand} */ - public deleteSchedulingPolicy( + deleteSchedulingPolicy( args: DeleteSchedulingPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSchedulingPolicy( + deleteSchedulingPolicy( args: DeleteSchedulingPolicyCommandInput, cb: (err: any, data?: DeleteSchedulingPolicyCommandOutput) => void ): void; - public deleteSchedulingPolicy( + deleteSchedulingPolicy( args: DeleteSchedulingPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSchedulingPolicyCommandOutput) => void ): void; - public deleteSchedulingPolicy( - args: DeleteSchedulingPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSchedulingPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteSchedulingPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteSchedulingPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days.

+ * @see {@link DeregisterJobDefinitionCommand} */ - public deregisterJobDefinition( + deregisterJobDefinition( args: DeregisterJobDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterJobDefinition( + deregisterJobDefinition( args: DeregisterJobDefinitionCommandInput, cb: (err: any, data?: DeregisterJobDefinitionCommandOutput) => void ): void; - public deregisterJobDefinition( + deregisterJobDefinition( args: DeregisterJobDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterJobDefinitionCommandOutput) => void ): void; - public deregisterJobDefinition( - args: DeregisterJobDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterJobDefinitionCommandOutput) => void), - cb?: (err: any, data?: DeregisterJobDefinitionCommandOutput) => void - ): Promise | void { - const command = new DeregisterJobDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes one or more of your compute environments.

- *

If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment - * operation to determine the ecsClusterArn that you launch your Amazon ECS container instances - * into.

+ * @see {@link DescribeComputeEnvironmentsCommand} */ - public describeComputeEnvironments( + describeComputeEnvironments( args: DescribeComputeEnvironmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeComputeEnvironments( + describeComputeEnvironments( args: DescribeComputeEnvironmentsCommandInput, cb: (err: any, data?: DescribeComputeEnvironmentsCommandOutput) => void ): void; - public describeComputeEnvironments( + describeComputeEnvironments( args: DescribeComputeEnvironmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeComputeEnvironmentsCommandOutput) => void ): void; - public describeComputeEnvironments( - args: DescribeComputeEnvironmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeComputeEnvironmentsCommandOutput) => void), - cb?: (err: any, data?: DescribeComputeEnvironmentsCommandOutput) => void - ): Promise | void { - const command = new DescribeComputeEnvironmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a list of job definitions. You can specify a status (such as ACTIVE) to only - * return job definitions that match that status.

+ * @see {@link DescribeJobDefinitionsCommand} */ - public describeJobDefinitions( + describeJobDefinitions( args: DescribeJobDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeJobDefinitions( + describeJobDefinitions( args: DescribeJobDefinitionsCommandInput, cb: (err: any, data?: DescribeJobDefinitionsCommandOutput) => void ): void; - public describeJobDefinitions( + describeJobDefinitions( args: DescribeJobDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobDefinitionsCommandOutput) => void ): void; - public describeJobDefinitions( - args: DescribeJobDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeJobDefinitionsCommandOutput) => void), - cb?: (err: any, data?: DescribeJobDefinitionsCommandOutput) => void - ): Promise | void { - const command = new DescribeJobDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes one or more of your job queues.

+ * @see {@link DescribeJobQueuesCommand} */ - public describeJobQueues( + describeJobQueues( args: DescribeJobQueuesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeJobQueues( + describeJobQueues( args: DescribeJobQueuesCommandInput, cb: (err: any, data?: DescribeJobQueuesCommandOutput) => void ): void; - public describeJobQueues( + describeJobQueues( args: DescribeJobQueuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobQueuesCommandOutput) => void ): void; - public describeJobQueues( - args: DescribeJobQueuesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeJobQueuesCommandOutput) => void), - cb?: (err: any, data?: DescribeJobQueuesCommandOutput) => void - ): Promise | void { - const command = new DescribeJobQueuesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a list of Batch jobs.

+ * @see {@link DescribeJobsCommand} */ - public describeJobs( - args: DescribeJobsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeJobs(args: DescribeJobsCommandInput, cb: (err: any, data?: DescribeJobsCommandOutput) => void): void; - public describeJobs( + describeJobs(args: DescribeJobsCommandInput, options?: __HttpHandlerOptions): Promise; + describeJobs(args: DescribeJobsCommandInput, cb: (err: any, data?: DescribeJobsCommandOutput) => void): void; + describeJobs( args: DescribeJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobsCommandOutput) => void ): void; - public describeJobs( - args: DescribeJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeJobsCommandOutput) => void), - cb?: (err: any, data?: DescribeJobsCommandOutput) => void - ): Promise | void { - const command = new DescribeJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes one or more of your scheduling policies.

+ * @see {@link DescribeSchedulingPoliciesCommand} */ - public describeSchedulingPolicies( + describeSchedulingPolicies( args: DescribeSchedulingPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSchedulingPolicies( + describeSchedulingPolicies( args: DescribeSchedulingPoliciesCommandInput, cb: (err: any, data?: DescribeSchedulingPoliciesCommandOutput) => void ): void; - public describeSchedulingPolicies( + describeSchedulingPolicies( args: DescribeSchedulingPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSchedulingPoliciesCommandOutput) => void ): void; - public describeSchedulingPolicies( - args: DescribeSchedulingPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSchedulingPoliciesCommandOutput) => void), - cb?: (err: any, data?: DescribeSchedulingPoliciesCommandOutput) => void - ): Promise | void { - const command = new DescribeSchedulingPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of Batch jobs.

- *

You must specify only one of the following items:

- *
    - *
  • - *

    A job queue ID to return a list of jobs in that job queue

    - *
  • - *
  • - *

    A multi-node parallel job ID to return a list of nodes for that job

    - *
  • - *
  • - *

    An array job ID to return a list of the children for that job

    - *
  • - *
- *

You can filter the results by job status with the jobStatus parameter. If you don't specify a - * status, only RUNNING jobs are returned.

+ * @see {@link ListJobsCommand} */ - public listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise; - public listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void; - public listJobs( + listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise; + listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void; + listJobs( args: ListJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobsCommandOutput) => void ): void; - public listJobs( - args: ListJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJobsCommandOutput) => void), - cb?: (err: any, data?: ListJobsCommandOutput) => void - ): Promise | void { - const command = new ListJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of Batch scheduling policies.

+ * @see {@link ListSchedulingPoliciesCommand} */ - public listSchedulingPolicies( + listSchedulingPolicies( args: ListSchedulingPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSchedulingPolicies( + listSchedulingPolicies( args: ListSchedulingPoliciesCommandInput, cb: (err: any, data?: ListSchedulingPoliciesCommandOutput) => void ): void; - public listSchedulingPolicies( + listSchedulingPolicies( args: ListSchedulingPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSchedulingPoliciesCommandOutput) => void ): void; - public listSchedulingPolicies( - args: ListSchedulingPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSchedulingPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListSchedulingPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListSchedulingPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, job queues, - * and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers an Batch job definition.

+ * @see {@link RegisterJobDefinitionCommand} */ - public registerJobDefinition( + registerJobDefinition( args: RegisterJobDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerJobDefinition( + registerJobDefinition( args: RegisterJobDefinitionCommandInput, cb: (err: any, data?: RegisterJobDefinitionCommandOutput) => void ): void; - public registerJobDefinition( + registerJobDefinition( args: RegisterJobDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterJobDefinitionCommandOutput) => void ): void; - public registerJobDefinition( - args: RegisterJobDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterJobDefinitionCommandOutput) => void), - cb?: (err: any, data?: RegisterJobDefinitionCommandOutput) => void - ): Promise | void { - const command = new RegisterJobDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Submits an Batch job from a job definition. Parameters that are specified during SubmitJob - * override parameters defined in the job definition. vCPU and memory requirements that are specified in the - * resourceRequirements objects in the job definition are the exception. They can't be overridden this way - * using the memory and vcpus parameters. Rather, you must specify updates to job definition - * parameters in a resourceRequirements object that's included in the containerOverrides - * parameter.

- * - *

Job queues with a scheduling policy are limited to 500 active fair share identifiers at a time.

- *
- * - *

Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14 - * days, Fargate resources might become unavailable and job might be terminated.

- *
+ * @see {@link SubmitJobCommand} */ - public submitJob(args: SubmitJobCommandInput, options?: __HttpHandlerOptions): Promise; - public submitJob(args: SubmitJobCommandInput, cb: (err: any, data?: SubmitJobCommandOutput) => void): void; - public submitJob( + submitJob(args: SubmitJobCommandInput, options?: __HttpHandlerOptions): Promise; + submitJob(args: SubmitJobCommandInput, cb: (err: any, data?: SubmitJobCommandOutput) => void): void; + submitJob( args: SubmitJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubmitJobCommandOutput) => void ): void; - public submitJob( - args: SubmitJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SubmitJobCommandOutput) => void), - cb?: (err: any, data?: SubmitJobCommandOutput) => void - ): Promise | void { - const command = new SubmitJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a - * resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that - * are associated with that resource are deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, job queues, - * and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are - * terminated, which causes them to transition to FAILED. Jobs that have not progressed to the - * STARTING state are cancelled.

+ * @see {@link TerminateJobCommand} */ - public terminateJob( - args: TerminateJobCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public terminateJob(args: TerminateJobCommandInput, cb: (err: any, data?: TerminateJobCommandOutput) => void): void; - public terminateJob( + terminateJob(args: TerminateJobCommandInput, options?: __HttpHandlerOptions): Promise; + terminateJob(args: TerminateJobCommandInput, cb: (err: any, data?: TerminateJobCommandOutput) => void): void; + terminateJob( args: TerminateJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TerminateJobCommandOutput) => void ): void; - public terminateJob( - args: TerminateJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TerminateJobCommandOutput) => void), - cb?: (err: any, data?: TerminateJobCommandOutput) => void - ): Promise | void { - const command = new TerminateJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes specified tags from an Batch resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an Batch compute environment.

+ * @see {@link UpdateComputeEnvironmentCommand} */ - public updateComputeEnvironment( + updateComputeEnvironment( args: UpdateComputeEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateComputeEnvironment( + updateComputeEnvironment( args: UpdateComputeEnvironmentCommandInput, cb: (err: any, data?: UpdateComputeEnvironmentCommandOutput) => void ): void; - public updateComputeEnvironment( + updateComputeEnvironment( args: UpdateComputeEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateComputeEnvironmentCommandOutput) => void ): void; - public updateComputeEnvironment( - args: UpdateComputeEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateComputeEnvironmentCommandOutput) => void), - cb?: (err: any, data?: UpdateComputeEnvironmentCommandOutput) => void - ): Promise | void { - const command = new UpdateComputeEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a job queue.

+ * @see {@link UpdateJobQueueCommand} */ - public updateJobQueue( + updateJobQueue( args: UpdateJobQueueCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateJobQueue( - args: UpdateJobQueueCommandInput, - cb: (err: any, data?: UpdateJobQueueCommandOutput) => void - ): void; - public updateJobQueue( + updateJobQueue(args: UpdateJobQueueCommandInput, cb: (err: any, data?: UpdateJobQueueCommandOutput) => void): void; + updateJobQueue( args: UpdateJobQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateJobQueueCommandOutput) => void ): void; - public updateJobQueue( - args: UpdateJobQueueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateJobQueueCommandOutput) => void), - cb?: (err: any, data?: UpdateJobQueueCommandOutput) => void - ): Promise | void { - const command = new UpdateJobQueueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a scheduling policy.

+ * @see {@link UpdateSchedulingPolicyCommand} */ - public updateSchedulingPolicy( + updateSchedulingPolicy( args: UpdateSchedulingPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSchedulingPolicy( + updateSchedulingPolicy( args: UpdateSchedulingPolicyCommandInput, cb: (err: any, data?: UpdateSchedulingPolicyCommandOutput) => void ): void; - public updateSchedulingPolicy( + updateSchedulingPolicy( args: UpdateSchedulingPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSchedulingPolicyCommandOutput) => void ): void; - public updateSchedulingPolicy( - args: UpdateSchedulingPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSchedulingPolicyCommandOutput) => void), - cb?: (err: any, data?: UpdateSchedulingPolicyCommandOutput) => void - ): Promise | void { - const command = new UpdateSchedulingPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Batch + *

Using Batch, you can run batch computing workloads on the Amazon Web Services Cloud. Batch computing is a common means for + * developers, scientists, and engineers to access large amounts of compute resources. Batch uses the advantages of + * the batch computing to remove the undifferentiated heavy lifting of configuring and managing required infrastructure. + * At the same time, it also adopts a familiar batch computing software approach. You can use Batch to efficiently + * provision resources d, and work toward eliminating capacity constraints, reducing your overall compute costs, and + * delivering results more quickly.

+ *

As a fully managed service, Batch can run batch computing workloads of any scale. Batch automatically + * provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific + * workloads. With Batch, there's no need to install or manage batch computing software. This means that you can focus + * on analyzing results and solving your specific problems instead.

+ */ +export class Batch extends BatchClient implements Batch {} +createAggregatedClient(commands, Batch); diff --git a/clients/client-billingconductor/src/Billingconductor.ts b/clients/client-billingconductor/src/Billingconductor.ts index 920139fd9fdc..8ddd46518446 100644 --- a/clients/client-billingconductor/src/Billingconductor.ts +++ b/clients/client-billingconductor/src/Billingconductor.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { BillingconductorClient } from "./BillingconductorClient"; +import { BillingconductorClient, BillingconductorClientConfig } from "./BillingconductorClient"; import { AssociateAccountsCommand, AssociateAccountsCommandInput, @@ -154,1095 +155,571 @@ import { UpdatePricingRuleCommandOutput, } from "./commands/UpdatePricingRuleCommand"; -/** - * @public - *

Amazon Web Services Billing Conductor is a fully managed service that you can use - * to customize a pro forma version of your billing data each month, to accurately show or chargeback - * your end customers. Amazon Web Services Billing Conductor doesn't change the way - * you're billed by Amazon Web Services each month by design. Instead, it provides you with a - * mechanism to configure, generate, and display rates to certain customers over a given billing - * period. You can also analyze the difference between the rates you apply to your accounting - * groupings relative to your actual rates from Amazon Web Services. As a result of your Amazon Web Services Billing Conductor configuration, the payer account can also see the - * custom rate applied on the billing details page of the Amazon Web Services Billing console, or configure a cost and usage report per - * billing group.

- *

This documentation shows how you can configure Amazon Web Services Billing Conductor using its - * API. For more information about using the Amazon Web Services - * Billing Conductor user interface, see the Amazon Web Services Billing Conductor User Guide.

- */ -export class Billingconductor extends BillingconductorClient { +const commands = { + AssociateAccountsCommand, + AssociatePricingRulesCommand, + BatchAssociateResourcesToCustomLineItemCommand, + BatchDisassociateResourcesFromCustomLineItemCommand, + CreateBillingGroupCommand, + CreateCustomLineItemCommand, + CreatePricingPlanCommand, + CreatePricingRuleCommand, + DeleteBillingGroupCommand, + DeleteCustomLineItemCommand, + DeletePricingPlanCommand, + DeletePricingRuleCommand, + DisassociateAccountsCommand, + DisassociatePricingRulesCommand, + ListAccountAssociationsCommand, + ListBillingGroupCostReportsCommand, + ListBillingGroupsCommand, + ListCustomLineItemsCommand, + ListCustomLineItemVersionsCommand, + ListPricingPlansCommand, + ListPricingPlansAssociatedWithPricingRuleCommand, + ListPricingRulesCommand, + ListPricingRulesAssociatedToPricingPlanCommand, + ListResourcesAssociatedToCustomLineItemCommand, + ListTagsForResourceCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateBillingGroupCommand, + UpdateCustomLineItemCommand, + UpdatePricingPlanCommand, + UpdatePricingRuleCommand, +}; + +export interface Billingconductor { /** - * @public - *

Connects an array of account IDs in a consolidated billing family to a predefined - * billing group. The account IDs must be a part of the consolidated billing family during the - * current month, and not already associated with another billing group. The maximum number of - * accounts that can be associated in one call is 30.

+ * @see {@link AssociateAccountsCommand} */ - public associateAccounts( + associateAccounts( args: AssociateAccountsCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateAccounts( + associateAccounts( args: AssociateAccountsCommandInput, cb: (err: any, data?: AssociateAccountsCommandOutput) => void ): void; - public associateAccounts( + associateAccounts( args: AssociateAccountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateAccountsCommandOutput) => void ): void; - public associateAccounts( - args: AssociateAccountsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateAccountsCommandOutput) => void), - cb?: (err: any, data?: AssociateAccountsCommandOutput) => void - ): Promise | void { - const command = new AssociateAccountsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Connects an array of PricingRuleArns to a defined PricingPlan. - * The maximum number PricingRuleArn that can be associated in one call is 30.

+ * @see {@link AssociatePricingRulesCommand} */ - public associatePricingRules( + associatePricingRules( args: AssociatePricingRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public associatePricingRules( + associatePricingRules( args: AssociatePricingRulesCommandInput, cb: (err: any, data?: AssociatePricingRulesCommandOutput) => void ): void; - public associatePricingRules( + associatePricingRules( args: AssociatePricingRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociatePricingRulesCommandOutput) => void ): void; - public associatePricingRules( - args: AssociatePricingRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociatePricingRulesCommandOutput) => void), - cb?: (err: any, data?: AssociatePricingRulesCommandOutput) => void - ): Promise | void { - const command = new AssociatePricingRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Associates a batch of resources to a percentage custom line item. - *

+ * @see {@link BatchAssociateResourcesToCustomLineItemCommand} */ - public batchAssociateResourcesToCustomLineItem( + batchAssociateResourcesToCustomLineItem( args: BatchAssociateResourcesToCustomLineItemCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchAssociateResourcesToCustomLineItem( + batchAssociateResourcesToCustomLineItem( args: BatchAssociateResourcesToCustomLineItemCommandInput, cb: (err: any, data?: BatchAssociateResourcesToCustomLineItemCommandOutput) => void ): void; - public batchAssociateResourcesToCustomLineItem( + batchAssociateResourcesToCustomLineItem( args: BatchAssociateResourcesToCustomLineItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchAssociateResourcesToCustomLineItemCommandOutput) => void ): void; - public batchAssociateResourcesToCustomLineItem( - args: BatchAssociateResourcesToCustomLineItemCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: BatchAssociateResourcesToCustomLineItemCommandOutput) => void), - cb?: (err: any, data?: BatchAssociateResourcesToCustomLineItemCommandOutput) => void - ): Promise | void { - const command = new BatchAssociateResourcesToCustomLineItemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Disassociates a batch of resources from a percentage custom line item. - *

+ * @see {@link BatchDisassociateResourcesFromCustomLineItemCommand} */ - public batchDisassociateResourcesFromCustomLineItem( + batchDisassociateResourcesFromCustomLineItem( args: BatchDisassociateResourcesFromCustomLineItemCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDisassociateResourcesFromCustomLineItem( + batchDisassociateResourcesFromCustomLineItem( args: BatchDisassociateResourcesFromCustomLineItemCommandInput, cb: (err: any, data?: BatchDisassociateResourcesFromCustomLineItemCommandOutput) => void ): void; - public batchDisassociateResourcesFromCustomLineItem( + batchDisassociateResourcesFromCustomLineItem( args: BatchDisassociateResourcesFromCustomLineItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDisassociateResourcesFromCustomLineItemCommandOutput) => void ): void; - public batchDisassociateResourcesFromCustomLineItem( - args: BatchDisassociateResourcesFromCustomLineItemCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: BatchDisassociateResourcesFromCustomLineItemCommandOutput) => void), - cb?: (err: any, data?: BatchDisassociateResourcesFromCustomLineItemCommandOutput) => void - ): Promise | void { - const command = new BatchDisassociateResourcesFromCustomLineItemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Creates a billing group that resembles a consolidated billing family that Amazon Web Services charges, based off of the predefined pricing plan computation. - *

+ * @see {@link CreateBillingGroupCommand} */ - public createBillingGroup( + createBillingGroup( args: CreateBillingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBillingGroup( + createBillingGroup( args: CreateBillingGroupCommandInput, cb: (err: any, data?: CreateBillingGroupCommandOutput) => void ): void; - public createBillingGroup( + createBillingGroup( args: CreateBillingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBillingGroupCommandOutput) => void ): void; - public createBillingGroup( - args: CreateBillingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBillingGroupCommandOutput) => void), - cb?: (err: any, data?: CreateBillingGroupCommandOutput) => void - ): Promise | void { - const command = new CreateBillingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Creates a custom line item that can be used to create a one-time fixed charge that can be applied to a single billing group for the current or previous billing period. The one-time fixed charge is either a fee or discount. - *

+ * @see {@link CreateCustomLineItemCommand} */ - public createCustomLineItem( + createCustomLineItem( args: CreateCustomLineItemCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCustomLineItem( + createCustomLineItem( args: CreateCustomLineItemCommandInput, cb: (err: any, data?: CreateCustomLineItemCommandOutput) => void ): void; - public createCustomLineItem( + createCustomLineItem( args: CreateCustomLineItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomLineItemCommandOutput) => void ): void; - public createCustomLineItem( - args: CreateCustomLineItemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCustomLineItemCommandOutput) => void), - cb?: (err: any, data?: CreateCustomLineItemCommandOutput) => void - ): Promise | void { - const command = new CreateCustomLineItemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a pricing plan that is used for computing Amazon Web Services charges for billing groups. - *

+ * @see {@link CreatePricingPlanCommand} */ - public createPricingPlan( + createPricingPlan( args: CreatePricingPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPricingPlan( + createPricingPlan( args: CreatePricingPlanCommandInput, cb: (err: any, data?: CreatePricingPlanCommandOutput) => void ): void; - public createPricingPlan( + createPricingPlan( args: CreatePricingPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePricingPlanCommandOutput) => void ): void; - public createPricingPlan( - args: CreatePricingPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePricingPlanCommandOutput) => void), - cb?: (err: any, data?: CreatePricingPlanCommandOutput) => void - ): Promise | void { - const command = new CreatePricingPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Creates a pricing rule can be associated to a pricing plan, or a set of pricing plans. - *

+ * @see {@link CreatePricingRuleCommand} */ - public createPricingRule( + createPricingRule( args: CreatePricingRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPricingRule( + createPricingRule( args: CreatePricingRuleCommandInput, cb: (err: any, data?: CreatePricingRuleCommandOutput) => void ): void; - public createPricingRule( + createPricingRule( args: CreatePricingRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePricingRuleCommandOutput) => void ): void; - public createPricingRule( - args: CreatePricingRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePricingRuleCommandOutput) => void), - cb?: (err: any, data?: CreatePricingRuleCommandOutput) => void - ): Promise | void { - const command = new CreatePricingRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Deletes a billing group. - *

+ * @see {@link DeleteBillingGroupCommand} */ - public deleteBillingGroup( + deleteBillingGroup( args: DeleteBillingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBillingGroup( + deleteBillingGroup( args: DeleteBillingGroupCommandInput, cb: (err: any, data?: DeleteBillingGroupCommandOutput) => void ): void; - public deleteBillingGroup( + deleteBillingGroup( args: DeleteBillingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBillingGroupCommandOutput) => void ): void; - public deleteBillingGroup( - args: DeleteBillingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBillingGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteBillingGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteBillingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Deletes the custom line item identified by the given ARN in the current, or previous billing period. - *

+ * @see {@link DeleteCustomLineItemCommand} */ - public deleteCustomLineItem( + deleteCustomLineItem( args: DeleteCustomLineItemCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCustomLineItem( + deleteCustomLineItem( args: DeleteCustomLineItemCommandInput, cb: (err: any, data?: DeleteCustomLineItemCommandOutput) => void ): void; - public deleteCustomLineItem( + deleteCustomLineItem( args: DeleteCustomLineItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomLineItemCommandOutput) => void ): void; - public deleteCustomLineItem( - args: DeleteCustomLineItemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCustomLineItemCommandOutput) => void), - cb?: (err: any, data?: DeleteCustomLineItemCommandOutput) => void - ): Promise | void { - const command = new DeleteCustomLineItemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a pricing plan. The pricing plan must not be associated with any billing groups to - * delete successfully.

+ * @see {@link DeletePricingPlanCommand} */ - public deletePricingPlan( + deletePricingPlan( args: DeletePricingPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePricingPlan( + deletePricingPlan( args: DeletePricingPlanCommandInput, cb: (err: any, data?: DeletePricingPlanCommandOutput) => void ): void; - public deletePricingPlan( + deletePricingPlan( args: DeletePricingPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePricingPlanCommandOutput) => void ): void; - public deletePricingPlan( - args: DeletePricingPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePricingPlanCommandOutput) => void), - cb?: (err: any, data?: DeletePricingPlanCommandOutput) => void - ): Promise | void { - const command = new DeletePricingPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the pricing rule that's identified by the input Amazon Resource Name (ARN).

+ * @see {@link DeletePricingRuleCommand} */ - public deletePricingRule( + deletePricingRule( args: DeletePricingRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePricingRule( + deletePricingRule( args: DeletePricingRuleCommandInput, cb: (err: any, data?: DeletePricingRuleCommandOutput) => void ): void; - public deletePricingRule( + deletePricingRule( args: DeletePricingRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePricingRuleCommandOutput) => void ): void; - public deletePricingRule( - args: DeletePricingRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePricingRuleCommandOutput) => void), - cb?: (err: any, data?: DeletePricingRuleCommandOutput) => void - ): Promise | void { - const command = new DeletePricingRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified list of account IDs from the given billing group.

+ * @see {@link DisassociateAccountsCommand} */ - public disassociateAccounts( + disassociateAccounts( args: DisassociateAccountsCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateAccounts( + disassociateAccounts( args: DisassociateAccountsCommandInput, cb: (err: any, data?: DisassociateAccountsCommandOutput) => void ): void; - public disassociateAccounts( + disassociateAccounts( args: DisassociateAccountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateAccountsCommandOutput) => void ): void; - public disassociateAccounts( - args: DisassociateAccountsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateAccountsCommandOutput) => void), - cb?: (err: any, data?: DisassociateAccountsCommandOutput) => void - ): Promise | void { - const command = new DisassociateAccountsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Disassociates a list of pricing rules from a pricing plan. - *

+ * @see {@link DisassociatePricingRulesCommand} */ - public disassociatePricingRules( + disassociatePricingRules( args: DisassociatePricingRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociatePricingRules( + disassociatePricingRules( args: DisassociatePricingRulesCommandInput, cb: (err: any, data?: DisassociatePricingRulesCommandOutput) => void ): void; - public disassociatePricingRules( + disassociatePricingRules( args: DisassociatePricingRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociatePricingRulesCommandOutput) => void ): void; - public disassociatePricingRules( - args: DisassociatePricingRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociatePricingRulesCommandOutput) => void), - cb?: (err: any, data?: DisassociatePricingRulesCommandOutput) => void - ): Promise | void { - const command = new DisassociatePricingRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This is a paginated call to list linked accounts that are linked to the payer account for - * the specified time period. If no information is provided, the current billing period is used. - * The response will optionally include the billing group that's associated with the linked - * account.

+ * @see {@link ListAccountAssociationsCommand} */ - public listAccountAssociations( + listAccountAssociations( args: ListAccountAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAccountAssociations( + listAccountAssociations( args: ListAccountAssociationsCommandInput, cb: (err: any, data?: ListAccountAssociationsCommandOutput) => void ): void; - public listAccountAssociations( + listAccountAssociations( args: ListAccountAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccountAssociationsCommandOutput) => void ): void; - public listAccountAssociations( - args: ListAccountAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccountAssociationsCommandOutput) => void), - cb?: (err: any, data?: ListAccountAssociationsCommandOutput) => void - ): Promise | void { - const command = new ListAccountAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A paginated call to retrieve a summary report of actual Amazon Web Services charges and the calculated - * Amazon Web Services charges based on the associated pricing plan of a billing group.

+ * @see {@link ListBillingGroupCostReportsCommand} */ - public listBillingGroupCostReports( + listBillingGroupCostReports( args: ListBillingGroupCostReportsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBillingGroupCostReports( + listBillingGroupCostReports( args: ListBillingGroupCostReportsCommandInput, cb: (err: any, data?: ListBillingGroupCostReportsCommandOutput) => void ): void; - public listBillingGroupCostReports( + listBillingGroupCostReports( args: ListBillingGroupCostReportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBillingGroupCostReportsCommandOutput) => void ): void; - public listBillingGroupCostReports( - args: ListBillingGroupCostReportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBillingGroupCostReportsCommandOutput) => void), - cb?: (err: any, data?: ListBillingGroupCostReportsCommandOutput) => void - ): Promise | void { - const command = new ListBillingGroupCostReportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A paginated call to retrieve a list of billing groups for the given billing period. If you don't provide a billing group, the current billing period is used.

+ * @see {@link ListBillingGroupsCommand} */ - public listBillingGroups( + listBillingGroups( args: ListBillingGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBillingGroups( + listBillingGroups( args: ListBillingGroupsCommandInput, cb: (err: any, data?: ListBillingGroupsCommandOutput) => void ): void; - public listBillingGroups( + listBillingGroups( args: ListBillingGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBillingGroupsCommandOutput) => void ): void; - public listBillingGroups( - args: ListBillingGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBillingGroupsCommandOutput) => void), - cb?: (err: any, data?: ListBillingGroupsCommandOutput) => void - ): Promise | void { - const command = new ListBillingGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * A paginated call to get a list of all custom line items (FFLIs) for the given billing period. If you don't provide a billing period, the current billing period is used. - *

+ * @see {@link ListCustomLineItemsCommand} */ - public listCustomLineItems( + listCustomLineItems( args: ListCustomLineItemsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCustomLineItems( + listCustomLineItems( args: ListCustomLineItemsCommandInput, cb: (err: any, data?: ListCustomLineItemsCommandOutput) => void ): void; - public listCustomLineItems( + listCustomLineItems( args: ListCustomLineItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCustomLineItemsCommandOutput) => void ): void; - public listCustomLineItems( - args: ListCustomLineItemsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCustomLineItemsCommandOutput) => void), - cb?: (err: any, data?: ListCustomLineItemsCommandOutput) => void - ): Promise | void { - const command = new ListCustomLineItemsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A paginated call to get a list of all custom line item versions.

+ * @see {@link ListCustomLineItemVersionsCommand} */ - public listCustomLineItemVersions( + listCustomLineItemVersions( args: ListCustomLineItemVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCustomLineItemVersions( + listCustomLineItemVersions( args: ListCustomLineItemVersionsCommandInput, cb: (err: any, data?: ListCustomLineItemVersionsCommandOutput) => void ): void; - public listCustomLineItemVersions( + listCustomLineItemVersions( args: ListCustomLineItemVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCustomLineItemVersionsCommandOutput) => void ): void; - public listCustomLineItemVersions( - args: ListCustomLineItemVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCustomLineItemVersionsCommandOutput) => void), - cb?: (err: any, data?: ListCustomLineItemVersionsCommandOutput) => void - ): Promise | void { - const command = new ListCustomLineItemVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A paginated call to get pricing plans for the given billing period. If you don't provide a billing period, the current billing period is used. - *

+ * @see {@link ListPricingPlansCommand} */ - public listPricingPlans( + listPricingPlans( args: ListPricingPlansCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPricingPlans( + listPricingPlans( args: ListPricingPlansCommandInput, cb: (err: any, data?: ListPricingPlansCommandOutput) => void ): void; - public listPricingPlans( + listPricingPlans( args: ListPricingPlansCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPricingPlansCommandOutput) => void ): void; - public listPricingPlans( - args: ListPricingPlansCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPricingPlansCommandOutput) => void), - cb?: (err: any, data?: ListPricingPlansCommandOutput) => void - ): Promise | void { - const command = new ListPricingPlansCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * A list of the pricing plans that are associated with a pricing rule. - *

+ * @see {@link ListPricingPlansAssociatedWithPricingRuleCommand} */ - public listPricingPlansAssociatedWithPricingRule( + listPricingPlansAssociatedWithPricingRule( args: ListPricingPlansAssociatedWithPricingRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPricingPlansAssociatedWithPricingRule( + listPricingPlansAssociatedWithPricingRule( args: ListPricingPlansAssociatedWithPricingRuleCommandInput, cb: (err: any, data?: ListPricingPlansAssociatedWithPricingRuleCommandOutput) => void ): void; - public listPricingPlansAssociatedWithPricingRule( + listPricingPlansAssociatedWithPricingRule( args: ListPricingPlansAssociatedWithPricingRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPricingPlansAssociatedWithPricingRuleCommandOutput) => void ): void; - public listPricingPlansAssociatedWithPricingRule( - args: ListPricingPlansAssociatedWithPricingRuleCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListPricingPlansAssociatedWithPricingRuleCommandOutput) => void), - cb?: (err: any, data?: ListPricingPlansAssociatedWithPricingRuleCommandOutput) => void - ): Promise | void { - const command = new ListPricingPlansAssociatedWithPricingRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans. - *

+ * @see {@link ListPricingRulesCommand} */ - public listPricingRules( + listPricingRules( args: ListPricingRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPricingRules( + listPricingRules( args: ListPricingRulesCommandInput, cb: (err: any, data?: ListPricingRulesCommandOutput) => void ): void; - public listPricingRules( + listPricingRules( args: ListPricingRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPricingRulesCommandOutput) => void ): void; - public listPricingRules( - args: ListPricingRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPricingRulesCommandOutput) => void), - cb?: (err: any, data?: ListPricingRulesCommandOutput) => void - ): Promise | void { - const command = new ListPricingRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Lists the pricing rules that are associated with a pricing plan. - *

+ * @see {@link ListPricingRulesAssociatedToPricingPlanCommand} */ - public listPricingRulesAssociatedToPricingPlan( + listPricingRulesAssociatedToPricingPlan( args: ListPricingRulesAssociatedToPricingPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPricingRulesAssociatedToPricingPlan( + listPricingRulesAssociatedToPricingPlan( args: ListPricingRulesAssociatedToPricingPlanCommandInput, cb: (err: any, data?: ListPricingRulesAssociatedToPricingPlanCommandOutput) => void ): void; - public listPricingRulesAssociatedToPricingPlan( + listPricingRulesAssociatedToPricingPlan( args: ListPricingRulesAssociatedToPricingPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPricingRulesAssociatedToPricingPlanCommandOutput) => void ): void; - public listPricingRulesAssociatedToPricingPlan( - args: ListPricingRulesAssociatedToPricingPlanCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListPricingRulesAssociatedToPricingPlanCommandOutput) => void), - cb?: (err: any, data?: ListPricingRulesAssociatedToPricingPlanCommandOutput) => void - ): Promise | void { - const command = new ListPricingRulesAssociatedToPricingPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * List the resources that are associated to a custom line item. - *

+ * @see {@link ListResourcesAssociatedToCustomLineItemCommand} */ - public listResourcesAssociatedToCustomLineItem( + listResourcesAssociatedToCustomLineItem( args: ListResourcesAssociatedToCustomLineItemCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourcesAssociatedToCustomLineItem( + listResourcesAssociatedToCustomLineItem( args: ListResourcesAssociatedToCustomLineItemCommandInput, cb: (err: any, data?: ListResourcesAssociatedToCustomLineItemCommandOutput) => void ): void; - public listResourcesAssociatedToCustomLineItem( + listResourcesAssociatedToCustomLineItem( args: ListResourcesAssociatedToCustomLineItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourcesAssociatedToCustomLineItemCommandOutput) => void ): void; - public listResourcesAssociatedToCustomLineItem( - args: ListResourcesAssociatedToCustomLineItemCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListResourcesAssociatedToCustomLineItemCommandOutput) => void), - cb?: (err: any, data?: ListResourcesAssociatedToCustomLineItemCommandOutput) => void - ): Promise | void { - const command = new ListResourcesAssociatedToCustomLineItemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * A list the tags for a resource. - *

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates the specified tags to a resource with the specified resourceArn. - * If existing tags on a resource are not specified in the request parameters, they are not - * changed.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Deletes specified tags from a resource. - *

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This updates an existing billing group. - *

+ * @see {@link UpdateBillingGroupCommand} */ - public updateBillingGroup( + updateBillingGroup( args: UpdateBillingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBillingGroup( + updateBillingGroup( args: UpdateBillingGroupCommandInput, cb: (err: any, data?: UpdateBillingGroupCommandOutput) => void ): void; - public updateBillingGroup( + updateBillingGroup( args: UpdateBillingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBillingGroupCommandOutput) => void ): void; - public updateBillingGroup( - args: UpdateBillingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBillingGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateBillingGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateBillingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Update an existing custom line item in the current or previous billing period. - *

+ * @see {@link UpdateCustomLineItemCommand} */ - public updateCustomLineItem( + updateCustomLineItem( args: UpdateCustomLineItemCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCustomLineItem( + updateCustomLineItem( args: UpdateCustomLineItemCommandInput, cb: (err: any, data?: UpdateCustomLineItemCommandOutput) => void ): void; - public updateCustomLineItem( + updateCustomLineItem( args: UpdateCustomLineItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCustomLineItemCommandOutput) => void ): void; - public updateCustomLineItem( - args: UpdateCustomLineItemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCustomLineItemCommandOutput) => void), - cb?: (err: any, data?: UpdateCustomLineItemCommandOutput) => void - ): Promise | void { - const command = new UpdateCustomLineItemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This updates an existing pricing plan. - *

+ * @see {@link UpdatePricingPlanCommand} */ - public updatePricingPlan( + updatePricingPlan( args: UpdatePricingPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePricingPlan( + updatePricingPlan( args: UpdatePricingPlanCommandInput, cb: (err: any, data?: UpdatePricingPlanCommandOutput) => void ): void; - public updatePricingPlan( + updatePricingPlan( args: UpdatePricingPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePricingPlanCommandOutput) => void ): void; - public updatePricingPlan( - args: UpdatePricingPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePricingPlanCommandOutput) => void), - cb?: (err: any, data?: UpdatePricingPlanCommandOutput) => void - ): Promise | void { - const command = new UpdatePricingPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Updates an existing pricing rule. - *

+ * @see {@link UpdatePricingRuleCommand} */ - public updatePricingRule( + updatePricingRule( args: UpdatePricingRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePricingRule( + updatePricingRule( args: UpdatePricingRuleCommandInput, cb: (err: any, data?: UpdatePricingRuleCommandOutput) => void ): void; - public updatePricingRule( + updatePricingRule( args: UpdatePricingRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePricingRuleCommandOutput) => void ): void; - public updatePricingRule( - args: UpdatePricingRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePricingRuleCommandOutput) => void), - cb?: (err: any, data?: UpdatePricingRuleCommandOutput) => void - ): Promise | void { - const command = new UpdatePricingRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Web Services Billing Conductor is a fully managed service that you can use + * to customize a pro forma version of your billing data each month, to accurately show or chargeback + * your end customers. Amazon Web Services Billing Conductor doesn't change the way + * you're billed by Amazon Web Services each month by design. Instead, it provides you with a + * mechanism to configure, generate, and display rates to certain customers over a given billing + * period. You can also analyze the difference between the rates you apply to your accounting + * groupings relative to your actual rates from Amazon Web Services. As a result of your Amazon Web Services Billing Conductor configuration, the payer account can also see the + * custom rate applied on the billing details page of the Amazon Web Services Billing console, or configure a cost and usage report per + * billing group.

+ *

This documentation shows how you can configure Amazon Web Services Billing Conductor using its + * API. For more information about using the Amazon Web Services + * Billing Conductor user interface, see the Amazon Web Services Billing Conductor User Guide.

+ */ +export class Billingconductor extends BillingconductorClient implements Billingconductor {} +createAggregatedClient(commands, Billingconductor); diff --git a/clients/client-braket/src/Braket.ts b/clients/client-braket/src/Braket.ts index c97feadaa5bc..b2d7a332c58f 100644 --- a/clients/client-braket/src/Braket.ts +++ b/clients/client-braket/src/Braket.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { BraketClient } from "./BraketClient"; +import { BraketClient, BraketClientConfig } from "./BraketClient"; import { CancelJobCommand, CancelJobCommandInput, CancelJobCommandOutput } from "./commands/CancelJobCommand"; import { CancelQuantumTaskCommand, @@ -44,419 +45,206 @@ import { UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; -/** - * @public - *

The Amazon Braket API Reference provides information about the operations and structures - * supported in Amazon Braket.

- *

Additional Resources:

- * - */ -export class Braket extends BraketClient { +const commands = { + CancelJobCommand, + CancelQuantumTaskCommand, + CreateJobCommand, + CreateQuantumTaskCommand, + GetDeviceCommand, + GetJobCommand, + GetQuantumTaskCommand, + ListTagsForResourceCommand, + SearchDevicesCommand, + SearchJobsCommand, + SearchQuantumTasksCommand, + TagResourceCommand, + UntagResourceCommand, +}; + +export interface Braket { /** - * @public - *

Cancels an Amazon Braket job.

+ * @see {@link CancelJobCommand} */ - public cancelJob(args: CancelJobCommandInput, options?: __HttpHandlerOptions): Promise; - public cancelJob(args: CancelJobCommandInput, cb: (err: any, data?: CancelJobCommandOutput) => void): void; - public cancelJob( + cancelJob(args: CancelJobCommandInput, options?: __HttpHandlerOptions): Promise; + cancelJob(args: CancelJobCommandInput, cb: (err: any, data?: CancelJobCommandOutput) => void): void; + cancelJob( args: CancelJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelJobCommandOutput) => void ): void; - public cancelJob( - args: CancelJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelJobCommandOutput) => void), - cb?: (err: any, data?: CancelJobCommandOutput) => void - ): Promise | void { - const command = new CancelJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels the specified task.

+ * @see {@link CancelQuantumTaskCommand} */ - public cancelQuantumTask( + cancelQuantumTask( args: CancelQuantumTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelQuantumTask( + cancelQuantumTask( args: CancelQuantumTaskCommandInput, cb: (err: any, data?: CancelQuantumTaskCommandOutput) => void ): void; - public cancelQuantumTask( + cancelQuantumTask( args: CancelQuantumTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelQuantumTaskCommandOutput) => void ): void; - public cancelQuantumTask( - args: CancelQuantumTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelQuantumTaskCommandOutput) => void), - cb?: (err: any, data?: CancelQuantumTaskCommandOutput) => void - ): Promise | void { - const command = new CancelQuantumTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Amazon Braket job.

+ * @see {@link CreateJobCommand} */ - public createJob(args: CreateJobCommandInput, options?: __HttpHandlerOptions): Promise; - public createJob(args: CreateJobCommandInput, cb: (err: any, data?: CreateJobCommandOutput) => void): void; - public createJob( + createJob(args: CreateJobCommandInput, options?: __HttpHandlerOptions): Promise; + createJob(args: CreateJobCommandInput, cb: (err: any, data?: CreateJobCommandOutput) => void): void; + createJob( args: CreateJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateJobCommandOutput) => void ): void; - public createJob( - args: CreateJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateJobCommandOutput) => void), - cb?: (err: any, data?: CreateJobCommandOutput) => void - ): Promise | void { - const command = new CreateJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a quantum task.

+ * @see {@link CreateQuantumTaskCommand} */ - public createQuantumTask( + createQuantumTask( args: CreateQuantumTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public createQuantumTask( + createQuantumTask( args: CreateQuantumTaskCommandInput, cb: (err: any, data?: CreateQuantumTaskCommandOutput) => void ): void; - public createQuantumTask( + createQuantumTask( args: CreateQuantumTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateQuantumTaskCommandOutput) => void ): void; - public createQuantumTask( - args: CreateQuantumTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateQuantumTaskCommandOutput) => void), - cb?: (err: any, data?: CreateQuantumTaskCommandOutput) => void - ): Promise | void { - const command = new CreateQuantumTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the devices available in Amazon Braket.

- * - *

For backwards compatibility with older versions of BraketSchemas, OpenQASM - * information is omitted from GetDevice API calls. To get this information the user-agent - * needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK - * automatically reports this for you. If you do not see OpenQASM results in the GetDevice - * response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment - * variable to configure user-agent. See the code examples provided below for how to do - * this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs.

- *
+ * @see {@link GetDeviceCommand} */ - public getDevice(args: GetDeviceCommandInput, options?: __HttpHandlerOptions): Promise; - public getDevice(args: GetDeviceCommandInput, cb: (err: any, data?: GetDeviceCommandOutput) => void): void; - public getDevice( + getDevice(args: GetDeviceCommandInput, options?: __HttpHandlerOptions): Promise; + getDevice(args: GetDeviceCommandInput, cb: (err: any, data?: GetDeviceCommandOutput) => void): void; + getDevice( args: GetDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeviceCommandOutput) => void ): void; - public getDevice( - args: GetDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeviceCommandOutput) => void), - cb?: (err: any, data?: GetDeviceCommandOutput) => void - ): Promise | void { - const command = new GetDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the specified Amazon Braket job.

+ * @see {@link GetJobCommand} */ - public getJob(args: GetJobCommandInput, options?: __HttpHandlerOptions): Promise; - public getJob(args: GetJobCommandInput, cb: (err: any, data?: GetJobCommandOutput) => void): void; - public getJob( + getJob(args: GetJobCommandInput, options?: __HttpHandlerOptions): Promise; + getJob(args: GetJobCommandInput, cb: (err: any, data?: GetJobCommandOutput) => void): void; + getJob( args: GetJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobCommandOutput) => void ): void; - public getJob( - args: GetJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetJobCommandOutput) => void), - cb?: (err: any, data?: GetJobCommandOutput) => void - ): Promise | void { - const command = new GetJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the specified quantum task.

+ * @see {@link GetQuantumTaskCommand} */ - public getQuantumTask( + getQuantumTask( args: GetQuantumTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public getQuantumTask( - args: GetQuantumTaskCommandInput, - cb: (err: any, data?: GetQuantumTaskCommandOutput) => void - ): void; - public getQuantumTask( + getQuantumTask(args: GetQuantumTaskCommandInput, cb: (err: any, data?: GetQuantumTaskCommandOutput) => void): void; + getQuantumTask( args: GetQuantumTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQuantumTaskCommandOutput) => void ): void; - public getQuantumTask( - args: GetQuantumTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetQuantumTaskCommandOutput) => void), - cb?: (err: any, data?: GetQuantumTaskCommandOutput) => void - ): Promise | void { - const command = new GetQuantumTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Shows the tags associated with this resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Searches for devices using the specified filters.

+ * @see {@link SearchDevicesCommand} */ - public searchDevices( - args: SearchDevicesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public searchDevices( - args: SearchDevicesCommandInput, - cb: (err: any, data?: SearchDevicesCommandOutput) => void - ): void; - public searchDevices( + searchDevices(args: SearchDevicesCommandInput, options?: __HttpHandlerOptions): Promise; + searchDevices(args: SearchDevicesCommandInput, cb: (err: any, data?: SearchDevicesCommandOutput) => void): void; + searchDevices( args: SearchDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchDevicesCommandOutput) => void ): void; - public searchDevices( - args: SearchDevicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchDevicesCommandOutput) => void), - cb?: (err: any, data?: SearchDevicesCommandOutput) => void - ): Promise | void { - const command = new SearchDevicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Searches for Amazon Braket jobs that match the specified filter values.

+ * @see {@link SearchJobsCommand} */ - public searchJobs(args: SearchJobsCommandInput, options?: __HttpHandlerOptions): Promise; - public searchJobs(args: SearchJobsCommandInput, cb: (err: any, data?: SearchJobsCommandOutput) => void): void; - public searchJobs( + searchJobs(args: SearchJobsCommandInput, options?: __HttpHandlerOptions): Promise; + searchJobs(args: SearchJobsCommandInput, cb: (err: any, data?: SearchJobsCommandOutput) => void): void; + searchJobs( args: SearchJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchJobsCommandOutput) => void ): void; - public searchJobs( - args: SearchJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchJobsCommandOutput) => void), - cb?: (err: any, data?: SearchJobsCommandOutput) => void - ): Promise | void { - const command = new SearchJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Searches for tasks that match the specified filter values.

+ * @see {@link SearchQuantumTasksCommand} */ - public searchQuantumTasks( + searchQuantumTasks( args: SearchQuantumTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchQuantumTasks( + searchQuantumTasks( args: SearchQuantumTasksCommandInput, cb: (err: any, data?: SearchQuantumTasksCommandOutput) => void ): void; - public searchQuantumTasks( + searchQuantumTasks( args: SearchQuantumTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchQuantumTasksCommandOutput) => void ): void; - public searchQuantumTasks( - args: SearchQuantumTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchQuantumTasksCommandOutput) => void), - cb?: (err: any, data?: SearchQuantumTasksCommandOutput) => void - ): Promise | void { - const command = new SearchQuantumTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Add a tag to the specified resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Remove tags from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The Amazon Braket API Reference provides information about the operations and structures + * supported in Amazon Braket.

+ *

Additional Resources:

+ * + */ +export class Braket extends BraketClient implements Braket {} +createAggregatedClient(commands, Braket); diff --git a/clients/client-budgets/src/Budgets.ts b/clients/client-budgets/src/Budgets.ts index 04660b343124..3ffae364bf32 100644 --- a/clients/client-budgets/src/Budgets.ts +++ b/clients/client-budgets/src/Budgets.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { BudgetsClient } from "./BudgetsClient"; +import { BudgetsClient, BudgetsClientConfig } from "./BudgetsClient"; import { CreateBudgetActionCommand, CreateBudgetActionCommandInput, @@ -118,841 +119,446 @@ import { UpdateSubscriberCommandOutput, } from "./commands/UpdateSubscriberCommand"; -/** - * @public - *

Use the Amazon Web Services Budgets API to plan your service usage, service costs, and instance reservations. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Amazon Web Services Budgets feature.

- *

Budgets provide you with a way to see the following information:

- *
    - *
  • - *

    How close your plan is to your budgeted amount or to the free tier limits

    - *
  • - *
  • - *

    Your usage-to-date, including how much you've used of your Reserved Instances (RIs)

    - *
  • - *
  • - *

    Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month

    - *
  • - *
  • - *

    How much of your budget has been used

    - *
  • - *
- *

Amazon Web Services updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:

- *
    - *
  • - *

    - * Cost budgets - Plan how much you want to spend on a service.

    - *
  • - *
  • - *

    - * Usage budgets - Plan how much you want to use one or more services.

    - *
  • - *
  • - *

    - * RI utilization budgets - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized.

    - *
  • - *
  • - *

    - * RI coverage budgets - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation.

    - *
  • - *
- *

Service Endpoint

- *

The Amazon Web Services Budgets API provides the following endpoint:

- *
    - *
  • - *

    https://budgets.amazonaws.com

    - *
  • - *
- *

For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing.

- */ -export class Budgets extends BudgetsClient { +const commands = { + CreateBudgetCommand, + CreateBudgetActionCommand, + CreateNotificationCommand, + CreateSubscriberCommand, + DeleteBudgetCommand, + DeleteBudgetActionCommand, + DeleteNotificationCommand, + DeleteSubscriberCommand, + DescribeBudgetCommand, + DescribeBudgetActionCommand, + DescribeBudgetActionHistoriesCommand, + DescribeBudgetActionsForAccountCommand, + DescribeBudgetActionsForBudgetCommand, + DescribeBudgetNotificationsForAccountCommand, + DescribeBudgetPerformanceHistoryCommand, + DescribeBudgetsCommand, + DescribeNotificationsForBudgetCommand, + DescribeSubscribersForNotificationCommand, + ExecuteBudgetActionCommand, + UpdateBudgetCommand, + UpdateBudgetActionCommand, + UpdateNotificationCommand, + UpdateSubscriberCommand, +}; + +export interface Budgets { /** - * @public - *

Creates a budget and, if included, notifications and subscribers.

- * - *

Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

- *
+ * @see {@link CreateBudgetCommand} */ - public createBudget( - args: CreateBudgetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createBudget(args: CreateBudgetCommandInput, cb: (err: any, data?: CreateBudgetCommandOutput) => void): void; - public createBudget( + createBudget(args: CreateBudgetCommandInput, options?: __HttpHandlerOptions): Promise; + createBudget(args: CreateBudgetCommandInput, cb: (err: any, data?: CreateBudgetCommandOutput) => void): void; + createBudget( args: CreateBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBudgetCommandOutput) => void ): void; - public createBudget( - args: CreateBudgetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBudgetCommandOutput) => void), - cb?: (err: any, data?: CreateBudgetCommandOutput) => void - ): Promise | void { - const command = new CreateBudgetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Creates a budget action. - *

+ * @see {@link CreateBudgetActionCommand} */ - public createBudgetAction( + createBudgetAction( args: CreateBudgetActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBudgetAction( + createBudgetAction( args: CreateBudgetActionCommandInput, cb: (err: any, data?: CreateBudgetActionCommandOutput) => void ): void; - public createBudgetAction( + createBudgetAction( args: CreateBudgetActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBudgetActionCommandOutput) => void ): void; - public createBudgetAction( - args: CreateBudgetActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBudgetActionCommandOutput) => void), - cb?: (err: any, data?: CreateBudgetActionCommandOutput) => void - ): Promise | void { - const command = new CreateBudgetActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a notification. You must create the budget before you create the associated notification.

+ * @see {@link CreateNotificationCommand} */ - public createNotification( + createNotification( args: CreateNotificationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNotification( + createNotification( args: CreateNotificationCommandInput, cb: (err: any, data?: CreateNotificationCommandOutput) => void ): void; - public createNotification( + createNotification( args: CreateNotificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNotificationCommandOutput) => void ): void; - public createNotification( - args: CreateNotificationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNotificationCommandOutput) => void), - cb?: (err: any, data?: CreateNotificationCommandOutput) => void - ): Promise | void { - const command = new CreateNotificationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a subscriber. You must create the associated budget and notification before you create the subscriber.

+ * @see {@link CreateSubscriberCommand} */ - public createSubscriber( + createSubscriber( args: CreateSubscriberCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSubscriber( + createSubscriber( args: CreateSubscriberCommandInput, cb: (err: any, data?: CreateSubscriberCommandOutput) => void ): void; - public createSubscriber( + createSubscriber( args: CreateSubscriberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSubscriberCommandOutput) => void ): void; - public createSubscriber( - args: CreateSubscriberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSubscriberCommandOutput) => void), - cb?: (err: any, data?: CreateSubscriberCommandOutput) => void - ): Promise | void { - const command = new CreateSubscriberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a budget. You can delete your budget at any time.

- * - *

Deleting a budget also deletes the notifications and subscribers that are associated with that budget.

- *
+ * @see {@link DeleteBudgetCommand} */ - public deleteBudget( - args: DeleteBudgetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteBudget(args: DeleteBudgetCommandInput, cb: (err: any, data?: DeleteBudgetCommandOutput) => void): void; - public deleteBudget( + deleteBudget(args: DeleteBudgetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteBudget(args: DeleteBudgetCommandInput, cb: (err: any, data?: DeleteBudgetCommandOutput) => void): void; + deleteBudget( args: DeleteBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBudgetCommandOutput) => void ): void; - public deleteBudget( - args: DeleteBudgetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBudgetCommandOutput) => void), - cb?: (err: any, data?: DeleteBudgetCommandOutput) => void - ): Promise | void { - const command = new DeleteBudgetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Deletes a budget action. - *

+ * @see {@link DeleteBudgetActionCommand} */ - public deleteBudgetAction( + deleteBudgetAction( args: DeleteBudgetActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBudgetAction( + deleteBudgetAction( args: DeleteBudgetActionCommandInput, cb: (err: any, data?: DeleteBudgetActionCommandOutput) => void ): void; - public deleteBudgetAction( + deleteBudgetAction( args: DeleteBudgetActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBudgetActionCommandOutput) => void ): void; - public deleteBudgetAction( - args: DeleteBudgetActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBudgetActionCommandOutput) => void), - cb?: (err: any, data?: DeleteBudgetActionCommandOutput) => void - ): Promise | void { - const command = new DeleteBudgetActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a notification.

- * - *

Deleting a notification also deletes the subscribers that are associated with the notification.

- *
+ * @see {@link DeleteNotificationCommand} */ - public deleteNotification( + deleteNotification( args: DeleteNotificationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNotification( + deleteNotification( args: DeleteNotificationCommandInput, cb: (err: any, data?: DeleteNotificationCommandOutput) => void ): void; - public deleteNotification( + deleteNotification( args: DeleteNotificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNotificationCommandOutput) => void ): void; - public deleteNotification( - args: DeleteNotificationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNotificationCommandOutput) => void), - cb?: (err: any, data?: DeleteNotificationCommandOutput) => void - ): Promise | void { - const command = new DeleteNotificationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a subscriber.

- * - *

Deleting the last subscriber to a notification also deletes the notification.

- *
+ * @see {@link DeleteSubscriberCommand} */ - public deleteSubscriber( + deleteSubscriber( args: DeleteSubscriberCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSubscriber( + deleteSubscriber( args: DeleteSubscriberCommandInput, cb: (err: any, data?: DeleteSubscriberCommandOutput) => void ): void; - public deleteSubscriber( + deleteSubscriber( args: DeleteSubscriberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSubscriberCommandOutput) => void ): void; - public deleteSubscriber( - args: DeleteSubscriberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSubscriberCommandOutput) => void), - cb?: (err: any, data?: DeleteSubscriberCommandOutput) => void - ): Promise | void { - const command = new DeleteSubscriberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a budget.

- * - *

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

- *
+ * @see {@link DescribeBudgetCommand} */ - public describeBudget( + describeBudget( args: DescribeBudgetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBudget( - args: DescribeBudgetCommandInput, - cb: (err: any, data?: DescribeBudgetCommandOutput) => void - ): void; - public describeBudget( + describeBudget(args: DescribeBudgetCommandInput, cb: (err: any, data?: DescribeBudgetCommandOutput) => void): void; + describeBudget( args: DescribeBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetCommandOutput) => void ): void; - public describeBudget( - args: DescribeBudgetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBudgetCommandOutput) => void), - cb?: (err: any, data?: DescribeBudgetCommandOutput) => void - ): Promise | void { - const command = new DescribeBudgetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Describes a budget action detail. - *

+ * @see {@link DescribeBudgetActionCommand} */ - public describeBudgetAction( + describeBudgetAction( args: DescribeBudgetActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBudgetAction( + describeBudgetAction( args: DescribeBudgetActionCommandInput, cb: (err: any, data?: DescribeBudgetActionCommandOutput) => void ): void; - public describeBudgetAction( + describeBudgetAction( args: DescribeBudgetActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetActionCommandOutput) => void ): void; - public describeBudgetAction( - args: DescribeBudgetActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBudgetActionCommandOutput) => void), - cb?: (err: any, data?: DescribeBudgetActionCommandOutput) => void - ): Promise | void { - const command = new DescribeBudgetActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Describes a budget action history detail. - *

+ * @see {@link DescribeBudgetActionHistoriesCommand} */ - public describeBudgetActionHistories( + describeBudgetActionHistories( args: DescribeBudgetActionHistoriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBudgetActionHistories( + describeBudgetActionHistories( args: DescribeBudgetActionHistoriesCommandInput, cb: (err: any, data?: DescribeBudgetActionHistoriesCommandOutput) => void ): void; - public describeBudgetActionHistories( + describeBudgetActionHistories( args: DescribeBudgetActionHistoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetActionHistoriesCommandOutput) => void ): void; - public describeBudgetActionHistories( - args: DescribeBudgetActionHistoriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBudgetActionHistoriesCommandOutput) => void), - cb?: (err: any, data?: DescribeBudgetActionHistoriesCommandOutput) => void - ): Promise | void { - const command = new DescribeBudgetActionHistoriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Describes all of the budget actions for an account. - *

+ * @see {@link DescribeBudgetActionsForAccountCommand} */ - public describeBudgetActionsForAccount( + describeBudgetActionsForAccount( args: DescribeBudgetActionsForAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBudgetActionsForAccount( + describeBudgetActionsForAccount( args: DescribeBudgetActionsForAccountCommandInput, cb: (err: any, data?: DescribeBudgetActionsForAccountCommandOutput) => void ): void; - public describeBudgetActionsForAccount( + describeBudgetActionsForAccount( args: DescribeBudgetActionsForAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetActionsForAccountCommandOutput) => void ): void; - public describeBudgetActionsForAccount( - args: DescribeBudgetActionsForAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBudgetActionsForAccountCommandOutput) => void), - cb?: (err: any, data?: DescribeBudgetActionsForAccountCommandOutput) => void - ): Promise | void { - const command = new DescribeBudgetActionsForAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Describes all of the budget actions for a budget. - *

+ * @see {@link DescribeBudgetActionsForBudgetCommand} */ - public describeBudgetActionsForBudget( + describeBudgetActionsForBudget( args: DescribeBudgetActionsForBudgetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBudgetActionsForBudget( + describeBudgetActionsForBudget( args: DescribeBudgetActionsForBudgetCommandInput, cb: (err: any, data?: DescribeBudgetActionsForBudgetCommandOutput) => void ): void; - public describeBudgetActionsForBudget( + describeBudgetActionsForBudget( args: DescribeBudgetActionsForBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetActionsForBudgetCommandOutput) => void ): void; - public describeBudgetActionsForBudget( - args: DescribeBudgetActionsForBudgetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBudgetActionsForBudgetCommandOutput) => void), - cb?: (err: any, data?: DescribeBudgetActionsForBudgetCommandOutput) => void - ): Promise | void { - const command = new DescribeBudgetActionsForBudgetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Lists the budget names and notifications that are associated with an account. - *

+ * @see {@link DescribeBudgetNotificationsForAccountCommand} */ - public describeBudgetNotificationsForAccount( + describeBudgetNotificationsForAccount( args: DescribeBudgetNotificationsForAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBudgetNotificationsForAccount( + describeBudgetNotificationsForAccount( args: DescribeBudgetNotificationsForAccountCommandInput, cb: (err: any, data?: DescribeBudgetNotificationsForAccountCommandOutput) => void ): void; - public describeBudgetNotificationsForAccount( + describeBudgetNotificationsForAccount( args: DescribeBudgetNotificationsForAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetNotificationsForAccountCommandOutput) => void ): void; - public describeBudgetNotificationsForAccount( - args: DescribeBudgetNotificationsForAccountCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeBudgetNotificationsForAccountCommandOutput) => void), - cb?: (err: any, data?: DescribeBudgetNotificationsForAccountCommandOutput) => void - ): Promise | void { - const command = new DescribeBudgetNotificationsForAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history isn't available for ANNUAL budgets.

+ * @see {@link DescribeBudgetPerformanceHistoryCommand} */ - public describeBudgetPerformanceHistory( + describeBudgetPerformanceHistory( args: DescribeBudgetPerformanceHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBudgetPerformanceHistory( + describeBudgetPerformanceHistory( args: DescribeBudgetPerformanceHistoryCommandInput, cb: (err: any, data?: DescribeBudgetPerformanceHistoryCommandOutput) => void ): void; - public describeBudgetPerformanceHistory( + describeBudgetPerformanceHistory( args: DescribeBudgetPerformanceHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetPerformanceHistoryCommandOutput) => void ): void; - public describeBudgetPerformanceHistory( - args: DescribeBudgetPerformanceHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBudgetPerformanceHistoryCommandOutput) => void), - cb?: (err: any, data?: DescribeBudgetPerformanceHistoryCommandOutput) => void - ): Promise | void { - const command = new DescribeBudgetPerformanceHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the budgets that are associated with an account.

- * - *

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

- *
+ * @see {@link DescribeBudgetsCommand} */ - public describeBudgets( + describeBudgets( args: DescribeBudgetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBudgets( - args: DescribeBudgetsCommandInput, - cb: (err: any, data?: DescribeBudgetsCommandOutput) => void - ): void; - public describeBudgets( + describeBudgets(args: DescribeBudgetsCommandInput, cb: (err: any, data?: DescribeBudgetsCommandOutput) => void): void; + describeBudgets( args: DescribeBudgetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetsCommandOutput) => void ): void; - public describeBudgets( - args: DescribeBudgetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBudgetsCommandOutput) => void), - cb?: (err: any, data?: DescribeBudgetsCommandOutput) => void - ): Promise | void { - const command = new DescribeBudgetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the notifications that are associated with a budget.

+ * @see {@link DescribeNotificationsForBudgetCommand} */ - public describeNotificationsForBudget( + describeNotificationsForBudget( args: DescribeNotificationsForBudgetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNotificationsForBudget( + describeNotificationsForBudget( args: DescribeNotificationsForBudgetCommandInput, cb: (err: any, data?: DescribeNotificationsForBudgetCommandOutput) => void ): void; - public describeNotificationsForBudget( + describeNotificationsForBudget( args: DescribeNotificationsForBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNotificationsForBudgetCommandOutput) => void ): void; - public describeNotificationsForBudget( - args: DescribeNotificationsForBudgetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeNotificationsForBudgetCommandOutput) => void), - cb?: (err: any, data?: DescribeNotificationsForBudgetCommandOutput) => void - ): Promise | void { - const command = new DescribeNotificationsForBudgetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the subscribers that are associated with a notification.

+ * @see {@link DescribeSubscribersForNotificationCommand} */ - public describeSubscribersForNotification( + describeSubscribersForNotification( args: DescribeSubscribersForNotificationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSubscribersForNotification( + describeSubscribersForNotification( args: DescribeSubscribersForNotificationCommandInput, cb: (err: any, data?: DescribeSubscribersForNotificationCommandOutput) => void ): void; - public describeSubscribersForNotification( + describeSubscribersForNotification( args: DescribeSubscribersForNotificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSubscribersForNotificationCommandOutput) => void ): void; - public describeSubscribersForNotification( - args: DescribeSubscribersForNotificationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSubscribersForNotificationCommandOutput) => void), - cb?: (err: any, data?: DescribeSubscribersForNotificationCommandOutput) => void - ): Promise | void { - const command = new DescribeSubscribersForNotificationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Executes a budget action. - *

+ * @see {@link ExecuteBudgetActionCommand} */ - public executeBudgetAction( + executeBudgetAction( args: ExecuteBudgetActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public executeBudgetAction( + executeBudgetAction( args: ExecuteBudgetActionCommandInput, cb: (err: any, data?: ExecuteBudgetActionCommandOutput) => void ): void; - public executeBudgetAction( + executeBudgetAction( args: ExecuteBudgetActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteBudgetActionCommandOutput) => void ): void; - public executeBudgetAction( - args: ExecuteBudgetActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExecuteBudgetActionCommandOutput) => void), - cb?: (err: any, data?: ExecuteBudgetActionCommandOutput) => void - ): Promise | void { - const command = new ExecuteBudgetActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a budget. You can change every part of a budget except for the budgetName and the calculatedSpend. When you modify a budget, the calculatedSpend drops to zero until Amazon Web Services has new usage data to use for forecasting.

- * - *

Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

- *
+ * @see {@link UpdateBudgetCommand} */ - public updateBudget( - args: UpdateBudgetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateBudget(args: UpdateBudgetCommandInput, cb: (err: any, data?: UpdateBudgetCommandOutput) => void): void; - public updateBudget( + updateBudget(args: UpdateBudgetCommandInput, options?: __HttpHandlerOptions): Promise; + updateBudget(args: UpdateBudgetCommandInput, cb: (err: any, data?: UpdateBudgetCommandOutput) => void): void; + updateBudget( args: UpdateBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBudgetCommandOutput) => void ): void; - public updateBudget( - args: UpdateBudgetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBudgetCommandOutput) => void), - cb?: (err: any, data?: UpdateBudgetCommandOutput) => void - ): Promise | void { - const command = new UpdateBudgetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Updates a budget action. - *

+ * @see {@link UpdateBudgetActionCommand} */ - public updateBudgetAction( + updateBudgetAction( args: UpdateBudgetActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBudgetAction( + updateBudgetAction( args: UpdateBudgetActionCommandInput, cb: (err: any, data?: UpdateBudgetActionCommandOutput) => void ): void; - public updateBudgetAction( + updateBudgetAction( args: UpdateBudgetActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBudgetActionCommandOutput) => void ): void; - public updateBudgetAction( - args: UpdateBudgetActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBudgetActionCommandOutput) => void), - cb?: (err: any, data?: UpdateBudgetActionCommandOutput) => void - ): Promise | void { - const command = new UpdateBudgetActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a notification.

+ * @see {@link UpdateNotificationCommand} */ - public updateNotification( + updateNotification( args: UpdateNotificationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateNotification( + updateNotification( args: UpdateNotificationCommandInput, cb: (err: any, data?: UpdateNotificationCommandOutput) => void ): void; - public updateNotification( + updateNotification( args: UpdateNotificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNotificationCommandOutput) => void ): void; - public updateNotification( - args: UpdateNotificationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateNotificationCommandOutput) => void), - cb?: (err: any, data?: UpdateNotificationCommandOutput) => void - ): Promise | void { - const command = new UpdateNotificationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a subscriber.

+ * @see {@link UpdateSubscriberCommand} */ - public updateSubscriber( + updateSubscriber( args: UpdateSubscriberCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSubscriber( + updateSubscriber( args: UpdateSubscriberCommandInput, cb: (err: any, data?: UpdateSubscriberCommandOutput) => void ): void; - public updateSubscriber( + updateSubscriber( args: UpdateSubscriberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSubscriberCommandOutput) => void ): void; - public updateSubscriber( - args: UpdateSubscriberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSubscriberCommandOutput) => void), - cb?: (err: any, data?: UpdateSubscriberCommandOutput) => void - ): Promise | void { - const command = new UpdateSubscriberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Use the Amazon Web Services Budgets API to plan your service usage, service costs, and instance reservations. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Amazon Web Services Budgets feature.

+ *

Budgets provide you with a way to see the following information:

+ *
    + *
  • + *

    How close your plan is to your budgeted amount or to the free tier limits

    + *
  • + *
  • + *

    Your usage-to-date, including how much you've used of your Reserved Instances (RIs)

    + *
  • + *
  • + *

    Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month

    + *
  • + *
  • + *

    How much of your budget has been used

    + *
  • + *
+ *

Amazon Web Services updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:

+ *
    + *
  • + *

    + * Cost budgets - Plan how much you want to spend on a service.

    + *
  • + *
  • + *

    + * Usage budgets - Plan how much you want to use one or more services.

    + *
  • + *
  • + *

    + * RI utilization budgets - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized.

    + *
  • + *
  • + *

    + * RI coverage budgets - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation.

    + *
  • + *
+ *

Service Endpoint

+ *

The Amazon Web Services Budgets API provides the following endpoint:

+ *
    + *
  • + *

    https://budgets.amazonaws.com

    + *
  • + *
+ *

For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing.

+ */ +export class Budgets extends BudgetsClient implements Budgets {} +createAggregatedClient(commands, Budgets); diff --git a/clients/client-chime-sdk-identity/src/ChimeSDKIdentity.ts b/clients/client-chime-sdk-identity/src/ChimeSDKIdentity.ts index 90c7eb66cf10..e13a4a4e21e8 100644 --- a/clients/client-chime-sdk-identity/src/ChimeSDKIdentity.ts +++ b/clients/client-chime-sdk-identity/src/ChimeSDKIdentity.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { ChimeSDKIdentityClient } from "./ChimeSDKIdentityClient"; +import { ChimeSDKIdentityClient, ChimeSDKIdentityClientConfig } from "./ChimeSDKIdentityClient"; import { CreateAppInstanceAdminCommand, CreateAppInstanceAdminCommandInput, @@ -149,1027 +150,545 @@ import { UpdateAppInstanceUserEndpointCommandOutput, } from "./commands/UpdateAppInstanceUserEndpointCommand"; -/** - * @public - *

The Amazon Chime SDK Identity APIs in this section allow software developers to create - * and manage unique instances of their messaging applications. These APIs provide the - * overarching framework for creating and sending messages. For more information about the - * identity APIs, refer to Amazon Chime SDK identity.

- */ -export class ChimeSDKIdentity extends ChimeSDKIdentityClient { +const commands = { + CreateAppInstanceCommand, + CreateAppInstanceAdminCommand, + CreateAppInstanceBotCommand, + CreateAppInstanceUserCommand, + DeleteAppInstanceCommand, + DeleteAppInstanceAdminCommand, + DeleteAppInstanceBotCommand, + DeleteAppInstanceUserCommand, + DeregisterAppInstanceUserEndpointCommand, + DescribeAppInstanceCommand, + DescribeAppInstanceAdminCommand, + DescribeAppInstanceBotCommand, + DescribeAppInstanceUserCommand, + DescribeAppInstanceUserEndpointCommand, + GetAppInstanceRetentionSettingsCommand, + ListAppInstanceAdminsCommand, + ListAppInstanceBotsCommand, + ListAppInstancesCommand, + ListAppInstanceUserEndpointsCommand, + ListAppInstanceUsersCommand, + ListTagsForResourceCommand, + PutAppInstanceRetentionSettingsCommand, + PutAppInstanceUserExpirationSettingsCommand, + RegisterAppInstanceUserEndpointCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAppInstanceCommand, + UpdateAppInstanceBotCommand, + UpdateAppInstanceUserCommand, + UpdateAppInstanceUserEndpointCommand, +}; + +export interface ChimeSDKIdentity { /** - * @public - *

Creates an Amazon Chime SDK messaging AppInstance under an AWS account. - * Only SDK messaging customers use this API. CreateAppInstance supports - * idempotency behavior as described in the AWS API Standard.

- *

identity

+ * @see {@link CreateAppInstanceCommand} */ - public createAppInstance( + createAppInstance( args: CreateAppInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAppInstance( + createAppInstance( args: CreateAppInstanceCommandInput, cb: (err: any, data?: CreateAppInstanceCommandOutput) => void ): void; - public createAppInstance( + createAppInstance( args: CreateAppInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppInstanceCommandOutput) => void ): void; - public createAppInstance( - args: CreateAppInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAppInstanceCommandOutput) => void), - cb?: (err: any, data?: CreateAppInstanceCommandOutput) => void - ): Promise | void { - const command = new CreateAppInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Promotes an AppInstanceUser or AppInstanceBot to an - * AppInstanceAdmin. The - * promoted entity can perform the following actions.

- *
    - *
  • - *

    - * ChannelModerator actions across all channels in the - * AppInstance.

    - *
  • - *
  • - *

    - * DeleteChannelMessage actions.

    - *
  • - *
- *

Only an AppInstanceUser and AppInstanceBot can be promoted to an AppInstanceAdmin - * role.

+ * @see {@link CreateAppInstanceAdminCommand} */ - public createAppInstanceAdmin( + createAppInstanceAdmin( args: CreateAppInstanceAdminCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAppInstanceAdmin( + createAppInstanceAdmin( args: CreateAppInstanceAdminCommandInput, cb: (err: any, data?: CreateAppInstanceAdminCommandOutput) => void ): void; - public createAppInstanceAdmin( + createAppInstanceAdmin( args: CreateAppInstanceAdminCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppInstanceAdminCommandOutput) => void ): void; - public createAppInstanceAdmin( - args: CreateAppInstanceAdminCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAppInstanceAdminCommandOutput) => void), - cb?: (err: any, data?: CreateAppInstanceAdminCommandOutput) => void - ): Promise | void { - const command = new CreateAppInstanceAdminCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a bot under an Amazon Chime AppInstance. The request consists of a - * unique Configuration and Name for that bot.

+ * @see {@link CreateAppInstanceBotCommand} */ - public createAppInstanceBot( + createAppInstanceBot( args: CreateAppInstanceBotCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAppInstanceBot( + createAppInstanceBot( args: CreateAppInstanceBotCommandInput, cb: (err: any, data?: CreateAppInstanceBotCommandOutput) => void ): void; - public createAppInstanceBot( + createAppInstanceBot( args: CreateAppInstanceBotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppInstanceBotCommandOutput) => void ): void; - public createAppInstanceBot( - args: CreateAppInstanceBotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAppInstanceBotCommandOutput) => void), - cb?: (err: any, data?: CreateAppInstanceBotCommandOutput) => void - ): Promise | void { - const command = new CreateAppInstanceBotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a user under an Amazon Chime AppInstance. The request consists of a - * unique appInstanceUserId and Name for that user.

+ * @see {@link CreateAppInstanceUserCommand} */ - public createAppInstanceUser( + createAppInstanceUser( args: CreateAppInstanceUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAppInstanceUser( + createAppInstanceUser( args: CreateAppInstanceUserCommandInput, cb: (err: any, data?: CreateAppInstanceUserCommandOutput) => void ): void; - public createAppInstanceUser( + createAppInstanceUser( args: CreateAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppInstanceUserCommandOutput) => void ): void; - public createAppInstanceUser( - args: CreateAppInstanceUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAppInstanceUserCommandOutput) => void), - cb?: (err: any, data?: CreateAppInstanceUserCommandOutput) => void - ): Promise | void { - const command = new CreateAppInstanceUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an AppInstance and all associated data asynchronously.

+ * @see {@link DeleteAppInstanceCommand} */ - public deleteAppInstance( + deleteAppInstance( args: DeleteAppInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAppInstance( + deleteAppInstance( args: DeleteAppInstanceCommandInput, cb: (err: any, data?: DeleteAppInstanceCommandOutput) => void ): void; - public deleteAppInstance( + deleteAppInstance( args: DeleteAppInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppInstanceCommandOutput) => void ): void; - public deleteAppInstance( - args: DeleteAppInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppInstanceCommandOutput) => void), - cb?: (err: any, data?: DeleteAppInstanceCommandOutput) => void - ): Promise | void { - const command = new DeleteAppInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Demotes an AppInstanceAdmin to an AppInstanceUser or - * AppInstanceBot. This action - * does not delete the user.

+ * @see {@link DeleteAppInstanceAdminCommand} */ - public deleteAppInstanceAdmin( + deleteAppInstanceAdmin( args: DeleteAppInstanceAdminCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAppInstanceAdmin( + deleteAppInstanceAdmin( args: DeleteAppInstanceAdminCommandInput, cb: (err: any, data?: DeleteAppInstanceAdminCommandOutput) => void ): void; - public deleteAppInstanceAdmin( + deleteAppInstanceAdmin( args: DeleteAppInstanceAdminCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppInstanceAdminCommandOutput) => void ): void; - public deleteAppInstanceAdmin( - args: DeleteAppInstanceAdminCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppInstanceAdminCommandOutput) => void), - cb?: (err: any, data?: DeleteAppInstanceAdminCommandOutput) => void - ): Promise | void { - const command = new DeleteAppInstanceAdminCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an AppInstanceBot.

+ * @see {@link DeleteAppInstanceBotCommand} */ - public deleteAppInstanceBot( + deleteAppInstanceBot( args: DeleteAppInstanceBotCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAppInstanceBot( + deleteAppInstanceBot( args: DeleteAppInstanceBotCommandInput, cb: (err: any, data?: DeleteAppInstanceBotCommandOutput) => void ): void; - public deleteAppInstanceBot( + deleteAppInstanceBot( args: DeleteAppInstanceBotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppInstanceBotCommandOutput) => void ): void; - public deleteAppInstanceBot( - args: DeleteAppInstanceBotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppInstanceBotCommandOutput) => void), - cb?: (err: any, data?: DeleteAppInstanceBotCommandOutput) => void - ): Promise | void { - const command = new DeleteAppInstanceBotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an AppInstanceUser.

+ * @see {@link DeleteAppInstanceUserCommand} */ - public deleteAppInstanceUser( + deleteAppInstanceUser( args: DeleteAppInstanceUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAppInstanceUser( + deleteAppInstanceUser( args: DeleteAppInstanceUserCommandInput, cb: (err: any, data?: DeleteAppInstanceUserCommandOutput) => void ): void; - public deleteAppInstanceUser( + deleteAppInstanceUser( args: DeleteAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppInstanceUserCommandOutput) => void ): void; - public deleteAppInstanceUser( - args: DeleteAppInstanceUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppInstanceUserCommandOutput) => void), - cb?: (err: any, data?: DeleteAppInstanceUserCommandOutput) => void - ): Promise | void { - const command = new DeleteAppInstanceUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deregisters an AppInstanceUserEndpoint.

+ * @see {@link DeregisterAppInstanceUserEndpointCommand} */ - public deregisterAppInstanceUserEndpoint( + deregisterAppInstanceUserEndpoint( args: DeregisterAppInstanceUserEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterAppInstanceUserEndpoint( + deregisterAppInstanceUserEndpoint( args: DeregisterAppInstanceUserEndpointCommandInput, cb: (err: any, data?: DeregisterAppInstanceUserEndpointCommandOutput) => void ): void; - public deregisterAppInstanceUserEndpoint( + deregisterAppInstanceUserEndpoint( args: DeregisterAppInstanceUserEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterAppInstanceUserEndpointCommandOutput) => void ): void; - public deregisterAppInstanceUserEndpoint( - args: DeregisterAppInstanceUserEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterAppInstanceUserEndpointCommandOutput) => void), - cb?: (err: any, data?: DeregisterAppInstanceUserEndpointCommandOutput) => void - ): Promise | void { - const command = new DeregisterAppInstanceUserEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the full details of an AppInstance.

+ * @see {@link DescribeAppInstanceCommand} */ - public describeAppInstance( + describeAppInstance( args: DescribeAppInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAppInstance( + describeAppInstance( args: DescribeAppInstanceCommandInput, cb: (err: any, data?: DescribeAppInstanceCommandOutput) => void ): void; - public describeAppInstance( + describeAppInstance( args: DescribeAppInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppInstanceCommandOutput) => void ): void; - public describeAppInstance( - args: DescribeAppInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAppInstanceCommandOutput) => void), - cb?: (err: any, data?: DescribeAppInstanceCommandOutput) => void - ): Promise | void { - const command = new DescribeAppInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the full details of an AppInstanceAdmin.

+ * @see {@link DescribeAppInstanceAdminCommand} */ - public describeAppInstanceAdmin( + describeAppInstanceAdmin( args: DescribeAppInstanceAdminCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAppInstanceAdmin( + describeAppInstanceAdmin( args: DescribeAppInstanceAdminCommandInput, cb: (err: any, data?: DescribeAppInstanceAdminCommandOutput) => void ): void; - public describeAppInstanceAdmin( + describeAppInstanceAdmin( args: DescribeAppInstanceAdminCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppInstanceAdminCommandOutput) => void ): void; - public describeAppInstanceAdmin( - args: DescribeAppInstanceAdminCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAppInstanceAdminCommandOutput) => void), - cb?: (err: any, data?: DescribeAppInstanceAdminCommandOutput) => void - ): Promise | void { - const command = new DescribeAppInstanceAdminCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The AppInstanceBot's information.

+ * @see {@link DescribeAppInstanceBotCommand} */ - public describeAppInstanceBot( + describeAppInstanceBot( args: DescribeAppInstanceBotCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAppInstanceBot( + describeAppInstanceBot( args: DescribeAppInstanceBotCommandInput, cb: (err: any, data?: DescribeAppInstanceBotCommandOutput) => void ): void; - public describeAppInstanceBot( + describeAppInstanceBot( args: DescribeAppInstanceBotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppInstanceBotCommandOutput) => void ): void; - public describeAppInstanceBot( - args: DescribeAppInstanceBotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAppInstanceBotCommandOutput) => void), - cb?: (err: any, data?: DescribeAppInstanceBotCommandOutput) => void - ): Promise | void { - const command = new DescribeAppInstanceBotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the full details of an AppInstanceUser.

+ * @see {@link DescribeAppInstanceUserCommand} */ - public describeAppInstanceUser( + describeAppInstanceUser( args: DescribeAppInstanceUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAppInstanceUser( + describeAppInstanceUser( args: DescribeAppInstanceUserCommandInput, cb: (err: any, data?: DescribeAppInstanceUserCommandOutput) => void ): void; - public describeAppInstanceUser( + describeAppInstanceUser( args: DescribeAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppInstanceUserCommandOutput) => void ): void; - public describeAppInstanceUser( - args: DescribeAppInstanceUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAppInstanceUserCommandOutput) => void), - cb?: (err: any, data?: DescribeAppInstanceUserCommandOutput) => void - ): Promise | void { - const command = new DescribeAppInstanceUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the full details of an AppInstanceUserEndpoint.

+ * @see {@link DescribeAppInstanceUserEndpointCommand} */ - public describeAppInstanceUserEndpoint( + describeAppInstanceUserEndpoint( args: DescribeAppInstanceUserEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAppInstanceUserEndpoint( + describeAppInstanceUserEndpoint( args: DescribeAppInstanceUserEndpointCommandInput, cb: (err: any, data?: DescribeAppInstanceUserEndpointCommandOutput) => void ): void; - public describeAppInstanceUserEndpoint( + describeAppInstanceUserEndpoint( args: DescribeAppInstanceUserEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppInstanceUserEndpointCommandOutput) => void ): void; - public describeAppInstanceUserEndpoint( - args: DescribeAppInstanceUserEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAppInstanceUserEndpointCommandOutput) => void), - cb?: (err: any, data?: DescribeAppInstanceUserEndpointCommandOutput) => void - ): Promise | void { - const command = new DescribeAppInstanceUserEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the retention settings for an AppInstance.

+ * @see {@link GetAppInstanceRetentionSettingsCommand} */ - public getAppInstanceRetentionSettings( + getAppInstanceRetentionSettings( args: GetAppInstanceRetentionSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAppInstanceRetentionSettings( + getAppInstanceRetentionSettings( args: GetAppInstanceRetentionSettingsCommandInput, cb: (err: any, data?: GetAppInstanceRetentionSettingsCommandOutput) => void ): void; - public getAppInstanceRetentionSettings( + getAppInstanceRetentionSettings( args: GetAppInstanceRetentionSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAppInstanceRetentionSettingsCommandOutput) => void ): void; - public getAppInstanceRetentionSettings( - args: GetAppInstanceRetentionSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAppInstanceRetentionSettingsCommandOutput) => void), - cb?: (err: any, data?: GetAppInstanceRetentionSettingsCommandOutput) => void - ): Promise | void { - const command = new GetAppInstanceRetentionSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the administrators in the AppInstance.

+ * @see {@link ListAppInstanceAdminsCommand} */ - public listAppInstanceAdmins( + listAppInstanceAdmins( args: ListAppInstanceAdminsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAppInstanceAdmins( + listAppInstanceAdmins( args: ListAppInstanceAdminsCommandInput, cb: (err: any, data?: ListAppInstanceAdminsCommandOutput) => void ): void; - public listAppInstanceAdmins( + listAppInstanceAdmins( args: ListAppInstanceAdminsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppInstanceAdminsCommandOutput) => void ): void; - public listAppInstanceAdmins( - args: ListAppInstanceAdminsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppInstanceAdminsCommandOutput) => void), - cb?: (err: any, data?: ListAppInstanceAdminsCommandOutput) => void - ): Promise | void { - const command = new ListAppInstanceAdminsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all AppInstanceBots created under a single AppInstance.

+ * @see {@link ListAppInstanceBotsCommand} */ - public listAppInstanceBots( + listAppInstanceBots( args: ListAppInstanceBotsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAppInstanceBots( + listAppInstanceBots( args: ListAppInstanceBotsCommandInput, cb: (err: any, data?: ListAppInstanceBotsCommandOutput) => void ): void; - public listAppInstanceBots( + listAppInstanceBots( args: ListAppInstanceBotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppInstanceBotsCommandOutput) => void ): void; - public listAppInstanceBots( - args: ListAppInstanceBotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppInstanceBotsCommandOutput) => void), - cb?: (err: any, data?: ListAppInstanceBotsCommandOutput) => void - ): Promise | void { - const command = new ListAppInstanceBotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all Amazon Chime AppInstances created under a single AWS - * account.

+ * @see {@link ListAppInstancesCommand} */ - public listAppInstances( + listAppInstances( args: ListAppInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAppInstances( + listAppInstances( args: ListAppInstancesCommandInput, cb: (err: any, data?: ListAppInstancesCommandOutput) => void ): void; - public listAppInstances( + listAppInstances( args: ListAppInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppInstancesCommandOutput) => void ): void; - public listAppInstances( - args: ListAppInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppInstancesCommandOutput) => void), - cb?: (err: any, data?: ListAppInstancesCommandOutput) => void - ): Promise | void { - const command = new ListAppInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.

+ * @see {@link ListAppInstanceUserEndpointsCommand} */ - public listAppInstanceUserEndpoints( + listAppInstanceUserEndpoints( args: ListAppInstanceUserEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAppInstanceUserEndpoints( + listAppInstanceUserEndpoints( args: ListAppInstanceUserEndpointsCommandInput, cb: (err: any, data?: ListAppInstanceUserEndpointsCommandOutput) => void ): void; - public listAppInstanceUserEndpoints( + listAppInstanceUserEndpoints( args: ListAppInstanceUserEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppInstanceUserEndpointsCommandOutput) => void ): void; - public listAppInstanceUserEndpoints( - args: ListAppInstanceUserEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppInstanceUserEndpointsCommandOutput) => void), - cb?: (err: any, data?: ListAppInstanceUserEndpointsCommandOutput) => void - ): Promise | void { - const command = new ListAppInstanceUserEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all AppInstanceUsers created under a single - * AppInstance.

+ * @see {@link ListAppInstanceUsersCommand} */ - public listAppInstanceUsers( + listAppInstanceUsers( args: ListAppInstanceUsersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAppInstanceUsers( + listAppInstanceUsers( args: ListAppInstanceUsersCommandInput, cb: (err: any, data?: ListAppInstanceUsersCommandOutput) => void ): void; - public listAppInstanceUsers( + listAppInstanceUsers( args: ListAppInstanceUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppInstanceUsersCommandOutput) => void ): void; - public listAppInstanceUsers( - args: ListAppInstanceUsersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppInstanceUsersCommandOutput) => void), - cb?: (err: any, data?: ListAppInstanceUsersCommandOutput) => void - ): Promise | void { - const command = new ListAppInstanceUsersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags applied to an Amazon Chime SDK identity resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the amount of time in days that a given AppInstance retains - * data.

+ * @see {@link PutAppInstanceRetentionSettingsCommand} */ - public putAppInstanceRetentionSettings( + putAppInstanceRetentionSettings( args: PutAppInstanceRetentionSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAppInstanceRetentionSettings( + putAppInstanceRetentionSettings( args: PutAppInstanceRetentionSettingsCommandInput, cb: (err: any, data?: PutAppInstanceRetentionSettingsCommandOutput) => void ): void; - public putAppInstanceRetentionSettings( + putAppInstanceRetentionSettings( args: PutAppInstanceRetentionSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAppInstanceRetentionSettingsCommandOutput) => void ): void; - public putAppInstanceRetentionSettings( - args: PutAppInstanceRetentionSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAppInstanceRetentionSettingsCommandOutput) => void), - cb?: (err: any, data?: PutAppInstanceRetentionSettingsCommandOutput) => void - ): Promise | void { - const command = new PutAppInstanceRetentionSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the number of days before the AppInstanceUser is automatically deleted.

- * - *

A background process deletes expired AppInstanceUsers within 6 hours of expiration. - * Actual deletion times may vary.

- *

Expired AppInstanceUsers that have not yet been deleted appear as active, and you can update - * their expiration settings. The system honors the new settings.

- *
+ * @see {@link PutAppInstanceUserExpirationSettingsCommand} */ - public putAppInstanceUserExpirationSettings( + putAppInstanceUserExpirationSettings( args: PutAppInstanceUserExpirationSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAppInstanceUserExpirationSettings( + putAppInstanceUserExpirationSettings( args: PutAppInstanceUserExpirationSettingsCommandInput, cb: (err: any, data?: PutAppInstanceUserExpirationSettingsCommandOutput) => void ): void; - public putAppInstanceUserExpirationSettings( + putAppInstanceUserExpirationSettings( args: PutAppInstanceUserExpirationSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAppInstanceUserExpirationSettingsCommandOutput) => void ): void; - public putAppInstanceUserExpirationSettings( - args: PutAppInstanceUserExpirationSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAppInstanceUserExpirationSettingsCommandOutput) => void), - cb?: (err: any, data?: PutAppInstanceUserExpirationSettingsCommandOutput) => void - ): Promise | void { - const command = new PutAppInstanceUserExpirationSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers an endpoint under an Amazon Chime AppInstanceUser. The endpoint receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.

+ * @see {@link RegisterAppInstanceUserEndpointCommand} */ - public registerAppInstanceUserEndpoint( + registerAppInstanceUserEndpoint( args: RegisterAppInstanceUserEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerAppInstanceUserEndpoint( + registerAppInstanceUserEndpoint( args: RegisterAppInstanceUserEndpointCommandInput, cb: (err: any, data?: RegisterAppInstanceUserEndpointCommandOutput) => void ): void; - public registerAppInstanceUserEndpoint( + registerAppInstanceUserEndpoint( args: RegisterAppInstanceUserEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterAppInstanceUserEndpointCommandOutput) => void ): void; - public registerAppInstanceUserEndpoint( - args: RegisterAppInstanceUserEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterAppInstanceUserEndpointCommandOutput) => void), - cb?: (err: any, data?: RegisterAppInstanceUserEndpointCommandOutput) => void - ): Promise | void { - const command = new RegisterAppInstanceUserEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Applies the specified tags to the specified Amazon Chime SDK identity resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified tags from the specified Amazon Chime SDK identity resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates AppInstance metadata.

+ * @see {@link UpdateAppInstanceCommand} */ - public updateAppInstance( + updateAppInstance( args: UpdateAppInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAppInstance( + updateAppInstance( args: UpdateAppInstanceCommandInput, cb: (err: any, data?: UpdateAppInstanceCommandOutput) => void ): void; - public updateAppInstance( + updateAppInstance( args: UpdateAppInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAppInstanceCommandOutput) => void ): void; - public updateAppInstance( - args: UpdateAppInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAppInstanceCommandOutput) => void), - cb?: (err: any, data?: UpdateAppInstanceCommandOutput) => void - ): Promise | void { - const command = new UpdateAppInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the name and metadata of an AppInstanceBot.

+ * @see {@link UpdateAppInstanceBotCommand} */ - public updateAppInstanceBot( + updateAppInstanceBot( args: UpdateAppInstanceBotCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAppInstanceBot( + updateAppInstanceBot( args: UpdateAppInstanceBotCommandInput, cb: (err: any, data?: UpdateAppInstanceBotCommandOutput) => void ): void; - public updateAppInstanceBot( + updateAppInstanceBot( args: UpdateAppInstanceBotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAppInstanceBotCommandOutput) => void ): void; - public updateAppInstanceBot( - args: UpdateAppInstanceBotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAppInstanceBotCommandOutput) => void), - cb?: (err: any, data?: UpdateAppInstanceBotCommandOutput) => void - ): Promise | void { - const command = new UpdateAppInstanceBotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the details of an AppInstanceUser. You can update names and - * metadata.

+ * @see {@link UpdateAppInstanceUserCommand} */ - public updateAppInstanceUser( + updateAppInstanceUser( args: UpdateAppInstanceUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAppInstanceUser( + updateAppInstanceUser( args: UpdateAppInstanceUserCommandInput, cb: (err: any, data?: UpdateAppInstanceUserCommandOutput) => void ): void; - public updateAppInstanceUser( + updateAppInstanceUser( args: UpdateAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAppInstanceUserCommandOutput) => void ): void; - public updateAppInstanceUser( - args: UpdateAppInstanceUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAppInstanceUserCommandOutput) => void), - cb?: (err: any, data?: UpdateAppInstanceUserCommandOutput) => void - ): Promise | void { - const command = new UpdateAppInstanceUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the details of an AppInstanceUserEndpoint. You can update the name and AllowMessage values.

+ * @see {@link UpdateAppInstanceUserEndpointCommand} */ - public updateAppInstanceUserEndpoint( + updateAppInstanceUserEndpoint( args: UpdateAppInstanceUserEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAppInstanceUserEndpoint( + updateAppInstanceUserEndpoint( args: UpdateAppInstanceUserEndpointCommandInput, cb: (err: any, data?: UpdateAppInstanceUserEndpointCommandOutput) => void ): void; - public updateAppInstanceUserEndpoint( + updateAppInstanceUserEndpoint( args: UpdateAppInstanceUserEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAppInstanceUserEndpointCommandOutput) => void ): void; - public updateAppInstanceUserEndpoint( - args: UpdateAppInstanceUserEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAppInstanceUserEndpointCommandOutput) => void), - cb?: (err: any, data?: UpdateAppInstanceUserEndpointCommandOutput) => void - ): Promise | void { - const command = new UpdateAppInstanceUserEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The Amazon Chime SDK Identity APIs in this section allow software developers to create + * and manage unique instances of their messaging applications. These APIs provide the + * overarching framework for creating and sending messages. For more information about the + * identity APIs, refer to Amazon Chime SDK identity.

+ */ +export class ChimeSDKIdentity extends ChimeSDKIdentityClient implements ChimeSDKIdentity {} +createAggregatedClient(commands, ChimeSDKIdentity); diff --git a/clients/client-chime-sdk-media-pipelines/src/ChimeSDKMediaPipelines.ts b/clients/client-chime-sdk-media-pipelines/src/ChimeSDKMediaPipelines.ts index 37d85f79b6bc..bee9e290c999 100644 --- a/clients/client-chime-sdk-media-pipelines/src/ChimeSDKMediaPipelines.ts +++ b/clients/client-chime-sdk-media-pipelines/src/ChimeSDKMediaPipelines.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { ChimeSDKMediaPipelinesClient } from "./ChimeSDKMediaPipelinesClient"; +import { ChimeSDKMediaPipelinesClient, ChimeSDKMediaPipelinesClientConfig } from "./ChimeSDKMediaPipelinesClient"; import { CreateMediaCapturePipelineCommand, CreateMediaCapturePipelineCommandInput, @@ -94,641 +95,345 @@ import { UpdateMediaInsightsPipelineStatusCommandOutput, } from "./commands/UpdateMediaInsightsPipelineStatusCommand"; -/** - * @public - *

The Amazon Chime SDK media pipeline APIs in this section allow software developers to - * create Amazon Chime SDK media pipelines that capture, concatenate, or stream your Amazon Chime SDK meetings. For more information about media pipelines, see Amazon Chime SDK media pipelines.

- */ -export class ChimeSDKMediaPipelines extends ChimeSDKMediaPipelinesClient { +const commands = { + CreateMediaCapturePipelineCommand, + CreateMediaConcatenationPipelineCommand, + CreateMediaInsightsPipelineCommand, + CreateMediaInsightsPipelineConfigurationCommand, + CreateMediaLiveConnectorPipelineCommand, + DeleteMediaCapturePipelineCommand, + DeleteMediaInsightsPipelineConfigurationCommand, + DeleteMediaPipelineCommand, + GetMediaCapturePipelineCommand, + GetMediaInsightsPipelineConfigurationCommand, + GetMediaPipelineCommand, + ListMediaCapturePipelinesCommand, + ListMediaInsightsPipelineConfigurationsCommand, + ListMediaPipelinesCommand, + ListTagsForResourceCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateMediaInsightsPipelineConfigurationCommand, + UpdateMediaInsightsPipelineStatusCommand, +}; + +export interface ChimeSDKMediaPipelines { /** - * @public - *

Creates a media pipeline.

+ * @see {@link CreateMediaCapturePipelineCommand} */ - public createMediaCapturePipeline( + createMediaCapturePipeline( args: CreateMediaCapturePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMediaCapturePipeline( + createMediaCapturePipeline( args: CreateMediaCapturePipelineCommandInput, cb: (err: any, data?: CreateMediaCapturePipelineCommandOutput) => void ): void; - public createMediaCapturePipeline( + createMediaCapturePipeline( args: CreateMediaCapturePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMediaCapturePipelineCommandOutput) => void ): void; - public createMediaCapturePipeline( - args: CreateMediaCapturePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMediaCapturePipelineCommandOutput) => void), - cb?: (err: any, data?: CreateMediaCapturePipelineCommandOutput) => void - ): Promise | void { - const command = new CreateMediaCapturePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a media concatenation pipeline.

+ * @see {@link CreateMediaConcatenationPipelineCommand} */ - public createMediaConcatenationPipeline( + createMediaConcatenationPipeline( args: CreateMediaConcatenationPipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMediaConcatenationPipeline( + createMediaConcatenationPipeline( args: CreateMediaConcatenationPipelineCommandInput, cb: (err: any, data?: CreateMediaConcatenationPipelineCommandOutput) => void ): void; - public createMediaConcatenationPipeline( + createMediaConcatenationPipeline( args: CreateMediaConcatenationPipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMediaConcatenationPipelineCommandOutput) => void ): void; - public createMediaConcatenationPipeline( - args: CreateMediaConcatenationPipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMediaConcatenationPipelineCommandOutput) => void), - cb?: (err: any, data?: CreateMediaConcatenationPipelineCommandOutput) => void - ): Promise | void { - const command = new CreateMediaConcatenationPipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a media insights pipeline.

+ * @see {@link CreateMediaInsightsPipelineCommand} */ - public createMediaInsightsPipeline( + createMediaInsightsPipeline( args: CreateMediaInsightsPipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMediaInsightsPipeline( + createMediaInsightsPipeline( args: CreateMediaInsightsPipelineCommandInput, cb: (err: any, data?: CreateMediaInsightsPipelineCommandOutput) => void ): void; - public createMediaInsightsPipeline( + createMediaInsightsPipeline( args: CreateMediaInsightsPipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMediaInsightsPipelineCommandOutput) => void ): void; - public createMediaInsightsPipeline( - args: CreateMediaInsightsPipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMediaInsightsPipelineCommandOutput) => void), - cb?: (err: any, data?: CreateMediaInsightsPipelineCommandOutput) => void - ): Promise | void { - const command = new CreateMediaInsightsPipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A structure that contains the static configurations for a media insights - * pipeline.

+ * @see {@link CreateMediaInsightsPipelineConfigurationCommand} */ - public createMediaInsightsPipelineConfiguration( + createMediaInsightsPipelineConfiguration( args: CreateMediaInsightsPipelineConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMediaInsightsPipelineConfiguration( + createMediaInsightsPipelineConfiguration( args: CreateMediaInsightsPipelineConfigurationCommandInput, cb: (err: any, data?: CreateMediaInsightsPipelineConfigurationCommandOutput) => void ): void; - public createMediaInsightsPipelineConfiguration( + createMediaInsightsPipelineConfiguration( args: CreateMediaInsightsPipelineConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMediaInsightsPipelineConfigurationCommandOutput) => void ): void; - public createMediaInsightsPipelineConfiguration( - args: CreateMediaInsightsPipelineConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateMediaInsightsPipelineConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateMediaInsightsPipelineConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateMediaInsightsPipelineConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a media live connector pipeline in an Amazon Chime SDK meeting.

+ * @see {@link CreateMediaLiveConnectorPipelineCommand} */ - public createMediaLiveConnectorPipeline( + createMediaLiveConnectorPipeline( args: CreateMediaLiveConnectorPipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMediaLiveConnectorPipeline( + createMediaLiveConnectorPipeline( args: CreateMediaLiveConnectorPipelineCommandInput, cb: (err: any, data?: CreateMediaLiveConnectorPipelineCommandOutput) => void ): void; - public createMediaLiveConnectorPipeline( + createMediaLiveConnectorPipeline( args: CreateMediaLiveConnectorPipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMediaLiveConnectorPipelineCommandOutput) => void ): void; - public createMediaLiveConnectorPipeline( - args: CreateMediaLiveConnectorPipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMediaLiveConnectorPipelineCommandOutput) => void), - cb?: (err: any, data?: CreateMediaLiveConnectorPipelineCommandOutput) => void - ): Promise | void { - const command = new CreateMediaLiveConnectorPipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the media pipeline.

+ * @see {@link DeleteMediaCapturePipelineCommand} */ - public deleteMediaCapturePipeline( + deleteMediaCapturePipeline( args: DeleteMediaCapturePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMediaCapturePipeline( + deleteMediaCapturePipeline( args: DeleteMediaCapturePipelineCommandInput, cb: (err: any, data?: DeleteMediaCapturePipelineCommandOutput) => void ): void; - public deleteMediaCapturePipeline( + deleteMediaCapturePipeline( args: DeleteMediaCapturePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMediaCapturePipelineCommandOutput) => void ): void; - public deleteMediaCapturePipeline( - args: DeleteMediaCapturePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMediaCapturePipelineCommandOutput) => void), - cb?: (err: any, data?: DeleteMediaCapturePipelineCommandOutput) => void - ): Promise | void { - const command = new DeleteMediaCapturePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified configuration settings.

+ * @see {@link DeleteMediaInsightsPipelineConfigurationCommand} */ - public deleteMediaInsightsPipelineConfiguration( + deleteMediaInsightsPipelineConfiguration( args: DeleteMediaInsightsPipelineConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMediaInsightsPipelineConfiguration( + deleteMediaInsightsPipelineConfiguration( args: DeleteMediaInsightsPipelineConfigurationCommandInput, cb: (err: any, data?: DeleteMediaInsightsPipelineConfigurationCommandOutput) => void ): void; - public deleteMediaInsightsPipelineConfiguration( + deleteMediaInsightsPipelineConfiguration( args: DeleteMediaInsightsPipelineConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMediaInsightsPipelineConfigurationCommandOutput) => void ): void; - public deleteMediaInsightsPipelineConfiguration( - args: DeleteMediaInsightsPipelineConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteMediaInsightsPipelineConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteMediaInsightsPipelineConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteMediaInsightsPipelineConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the media pipeline.

+ * @see {@link DeleteMediaPipelineCommand} */ - public deleteMediaPipeline( + deleteMediaPipeline( args: DeleteMediaPipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMediaPipeline( + deleteMediaPipeline( args: DeleteMediaPipelineCommandInput, cb: (err: any, data?: DeleteMediaPipelineCommandOutput) => void ): void; - public deleteMediaPipeline( + deleteMediaPipeline( args: DeleteMediaPipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMediaPipelineCommandOutput) => void ): void; - public deleteMediaPipeline( - args: DeleteMediaPipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMediaPipelineCommandOutput) => void), - cb?: (err: any, data?: DeleteMediaPipelineCommandOutput) => void - ): Promise | void { - const command = new DeleteMediaPipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets an existing media pipeline.

+ * @see {@link GetMediaCapturePipelineCommand} */ - public getMediaCapturePipeline( + getMediaCapturePipeline( args: GetMediaCapturePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMediaCapturePipeline( + getMediaCapturePipeline( args: GetMediaCapturePipelineCommandInput, cb: (err: any, data?: GetMediaCapturePipelineCommandOutput) => void ): void; - public getMediaCapturePipeline( + getMediaCapturePipeline( args: GetMediaCapturePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMediaCapturePipelineCommandOutput) => void ): void; - public getMediaCapturePipeline( - args: GetMediaCapturePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMediaCapturePipelineCommandOutput) => void), - cb?: (err: any, data?: GetMediaCapturePipelineCommandOutput) => void - ): Promise | void { - const command = new GetMediaCapturePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the configuration settings for a media insights pipeline.

+ * @see {@link GetMediaInsightsPipelineConfigurationCommand} */ - public getMediaInsightsPipelineConfiguration( + getMediaInsightsPipelineConfiguration( args: GetMediaInsightsPipelineConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMediaInsightsPipelineConfiguration( + getMediaInsightsPipelineConfiguration( args: GetMediaInsightsPipelineConfigurationCommandInput, cb: (err: any, data?: GetMediaInsightsPipelineConfigurationCommandOutput) => void ): void; - public getMediaInsightsPipelineConfiguration( + getMediaInsightsPipelineConfiguration( args: GetMediaInsightsPipelineConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMediaInsightsPipelineConfigurationCommandOutput) => void ): void; - public getMediaInsightsPipelineConfiguration( - args: GetMediaInsightsPipelineConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetMediaInsightsPipelineConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetMediaInsightsPipelineConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetMediaInsightsPipelineConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets an existing media pipeline.

+ * @see {@link GetMediaPipelineCommand} */ - public getMediaPipeline( + getMediaPipeline( args: GetMediaPipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMediaPipeline( + getMediaPipeline( args: GetMediaPipelineCommandInput, cb: (err: any, data?: GetMediaPipelineCommandOutput) => void ): void; - public getMediaPipeline( + getMediaPipeline( args: GetMediaPipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMediaPipelineCommandOutput) => void ): void; - public getMediaPipeline( - args: GetMediaPipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMediaPipelineCommandOutput) => void), - cb?: (err: any, data?: GetMediaPipelineCommandOutput) => void - ): Promise | void { - const command = new GetMediaPipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of media pipelines.

+ * @see {@link ListMediaCapturePipelinesCommand} */ - public listMediaCapturePipelines( + listMediaCapturePipelines( args: ListMediaCapturePipelinesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMediaCapturePipelines( + listMediaCapturePipelines( args: ListMediaCapturePipelinesCommandInput, cb: (err: any, data?: ListMediaCapturePipelinesCommandOutput) => void ): void; - public listMediaCapturePipelines( + listMediaCapturePipelines( args: ListMediaCapturePipelinesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMediaCapturePipelinesCommandOutput) => void ): void; - public listMediaCapturePipelines( - args: ListMediaCapturePipelinesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMediaCapturePipelinesCommandOutput) => void), - cb?: (err: any, data?: ListMediaCapturePipelinesCommandOutput) => void - ): Promise | void { - const command = new ListMediaCapturePipelinesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the available media insights pipeline configurations.

+ * @see {@link ListMediaInsightsPipelineConfigurationsCommand} */ - public listMediaInsightsPipelineConfigurations( + listMediaInsightsPipelineConfigurations( args: ListMediaInsightsPipelineConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMediaInsightsPipelineConfigurations( + listMediaInsightsPipelineConfigurations( args: ListMediaInsightsPipelineConfigurationsCommandInput, cb: (err: any, data?: ListMediaInsightsPipelineConfigurationsCommandOutput) => void ): void; - public listMediaInsightsPipelineConfigurations( + listMediaInsightsPipelineConfigurations( args: ListMediaInsightsPipelineConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMediaInsightsPipelineConfigurationsCommandOutput) => void ): void; - public listMediaInsightsPipelineConfigurations( - args: ListMediaInsightsPipelineConfigurationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListMediaInsightsPipelineConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListMediaInsightsPipelineConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListMediaInsightsPipelineConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of media pipelines.

+ * @see {@link ListMediaPipelinesCommand} */ - public listMediaPipelines( + listMediaPipelines( args: ListMediaPipelinesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMediaPipelines( + listMediaPipelines( args: ListMediaPipelinesCommandInput, cb: (err: any, data?: ListMediaPipelinesCommandOutput) => void ): void; - public listMediaPipelines( + listMediaPipelines( args: ListMediaPipelinesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMediaPipelinesCommandOutput) => void ): void; - public listMediaPipelines( - args: ListMediaPipelinesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMediaPipelinesCommandOutput) => void), - cb?: (err: any, data?: ListMediaPipelinesCommandOutput) => void - ): Promise | void { - const command = new ListMediaPipelinesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags available for a media pipeline.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The ARN of the media pipeline that you want to tag. Consists of the pipeline's endpoint region, resource ID, and pipeline ID.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes any tags from a media pipeline.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the media insights pipeline's configuration settings.

+ * @see {@link UpdateMediaInsightsPipelineConfigurationCommand} */ - public updateMediaInsightsPipelineConfiguration( + updateMediaInsightsPipelineConfiguration( args: UpdateMediaInsightsPipelineConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMediaInsightsPipelineConfiguration( + updateMediaInsightsPipelineConfiguration( args: UpdateMediaInsightsPipelineConfigurationCommandInput, cb: (err: any, data?: UpdateMediaInsightsPipelineConfigurationCommandOutput) => void ): void; - public updateMediaInsightsPipelineConfiguration( + updateMediaInsightsPipelineConfiguration( args: UpdateMediaInsightsPipelineConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMediaInsightsPipelineConfigurationCommandOutput) => void ): void; - public updateMediaInsightsPipelineConfiguration( - args: UpdateMediaInsightsPipelineConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateMediaInsightsPipelineConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateMediaInsightsPipelineConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateMediaInsightsPipelineConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the status of a media insights pipeline.

+ * @see {@link UpdateMediaInsightsPipelineStatusCommand} */ - public updateMediaInsightsPipelineStatus( + updateMediaInsightsPipelineStatus( args: UpdateMediaInsightsPipelineStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMediaInsightsPipelineStatus( + updateMediaInsightsPipelineStatus( args: UpdateMediaInsightsPipelineStatusCommandInput, cb: (err: any, data?: UpdateMediaInsightsPipelineStatusCommandOutput) => void ): void; - public updateMediaInsightsPipelineStatus( + updateMediaInsightsPipelineStatus( args: UpdateMediaInsightsPipelineStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMediaInsightsPipelineStatusCommandOutput) => void ): void; - public updateMediaInsightsPipelineStatus( - args: UpdateMediaInsightsPipelineStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMediaInsightsPipelineStatusCommandOutput) => void), - cb?: (err: any, data?: UpdateMediaInsightsPipelineStatusCommandOutput) => void - ): Promise | void { - const command = new UpdateMediaInsightsPipelineStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The Amazon Chime SDK media pipeline APIs in this section allow software developers to + * create Amazon Chime SDK media pipelines that capture, concatenate, or stream your Amazon Chime SDK meetings. For more information about media pipelines, see Amazon Chime SDK media pipelines.

+ */ +export class ChimeSDKMediaPipelines extends ChimeSDKMediaPipelinesClient implements ChimeSDKMediaPipelines {} +createAggregatedClient(commands, ChimeSDKMediaPipelines); diff --git a/clients/client-chime-sdk-meetings/src/ChimeSDKMeetings.ts b/clients/client-chime-sdk-meetings/src/ChimeSDKMeetings.ts index b7a0f75ca288..22f54c13ccfa 100644 --- a/clients/client-chime-sdk-meetings/src/ChimeSDKMeetings.ts +++ b/clients/client-chime-sdk-meetings/src/ChimeSDKMeetings.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { ChimeSDKMeetingsClient } from "./ChimeSDKMeetingsClient"; +import { ChimeSDKMeetingsClient, ChimeSDKMeetingsClientConfig } from "./ChimeSDKMeetingsClient"; import { BatchCreateAttendeeCommand, BatchCreateAttendeeCommandInput, @@ -71,629 +72,256 @@ import { UpdateAttendeeCapabilitiesCommandOutput, } from "./commands/UpdateAttendeeCapabilitiesCommand"; -/** - * @public - *

The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and - * receive meeting notifications. For more information about the meeting APIs, see - * Amazon Chime SDK meetings.

- */ -export class ChimeSDKMeetings extends ChimeSDKMeetingsClient { +const commands = { + BatchCreateAttendeeCommand, + BatchUpdateAttendeeCapabilitiesExceptCommand, + CreateAttendeeCommand, + CreateMeetingCommand, + CreateMeetingWithAttendeesCommand, + DeleteAttendeeCommand, + DeleteMeetingCommand, + GetAttendeeCommand, + GetMeetingCommand, + ListAttendeesCommand, + ListTagsForResourceCommand, + StartMeetingTranscriptionCommand, + StopMeetingTranscriptionCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAttendeeCapabilitiesCommand, +}; + +export interface ChimeSDKMeetings { /** - * @public - *

Creates up to 100 attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see - * Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

+ * @see {@link BatchCreateAttendeeCommand} */ - public batchCreateAttendee( + batchCreateAttendee( args: BatchCreateAttendeeCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchCreateAttendee( + batchCreateAttendee( args: BatchCreateAttendeeCommandInput, cb: (err: any, data?: BatchCreateAttendeeCommandOutput) => void ): void; - public batchCreateAttendee( + batchCreateAttendee( args: BatchCreateAttendeeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCreateAttendeeCommandOutput) => void ): void; - public batchCreateAttendee( - args: BatchCreateAttendeeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchCreateAttendeeCommandOutput) => void), - cb?: (err: any, data?: BatchCreateAttendeeCommandOutput) => void - ): Promise | void { - const command = new BatchCreateAttendeeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.

- * - *

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see - * .

- *
- *

When using capabilities, be aware of these corner cases:

- *
    - *
  • - *

    You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive - * or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability - * to receive and you set your content capability to not receive.

    - *
  • - *
  • - *

    When you change an audio capability from None or Receive to Send or SendReceive , - * and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

    - *
  • - *
  • - *

    When you change a video or content capability from None or Receive to Send or SendReceive , - * and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

    - *
  • - *
+ * @see {@link BatchUpdateAttendeeCapabilitiesExceptCommand} */ - public batchUpdateAttendeeCapabilitiesExcept( + batchUpdateAttendeeCapabilitiesExcept( args: BatchUpdateAttendeeCapabilitiesExceptCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchUpdateAttendeeCapabilitiesExcept( + batchUpdateAttendeeCapabilitiesExcept( args: BatchUpdateAttendeeCapabilitiesExceptCommandInput, cb: (err: any, data?: BatchUpdateAttendeeCapabilitiesExceptCommandOutput) => void ): void; - public batchUpdateAttendeeCapabilitiesExcept( + batchUpdateAttendeeCapabilitiesExcept( args: BatchUpdateAttendeeCapabilitiesExceptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchUpdateAttendeeCapabilitiesExceptCommandOutput) => void ): void; - public batchUpdateAttendeeCapabilitiesExcept( - args: BatchUpdateAttendeeCapabilitiesExceptCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: BatchUpdateAttendeeCapabilitiesExceptCommandOutput) => void), - cb?: (err: any, data?: BatchUpdateAttendeeCapabilitiesExceptCommandOutput) => void - ): Promise | void { - const command = new BatchUpdateAttendeeCapabilitiesExceptCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see - * Using the Amazon Chime SDK - * in the - * Amazon Chime Developer Guide. - *

+ * @see {@link CreateAttendeeCommand} */ - public createAttendee( + createAttendee( args: CreateAttendeeCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAttendee( - args: CreateAttendeeCommandInput, - cb: (err: any, data?: CreateAttendeeCommandOutput) => void - ): void; - public createAttendee( + createAttendee(args: CreateAttendeeCommandInput, cb: (err: any, data?: CreateAttendeeCommandOutput) => void): void; + createAttendee( args: CreateAttendeeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAttendeeCommandOutput) => void ): void; - public createAttendee( - args: CreateAttendeeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAttendeeCommandOutput) => void), - cb?: (err: any, data?: CreateAttendeeCommandOutput) => void - ): Promise | void { - const command = new CreateAttendeeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see - * Amazon Chime SDK Media Regions - * in the Amazon Chime Developer Guide. For more information about the Amazon Chime SDK, see - * Using the Amazon Chime SDK - * in the - * Amazon Chime Developer Guide. - *

+ * @see {@link CreateMeetingCommand} */ - public createMeeting( - args: CreateMeetingCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createMeeting( - args: CreateMeetingCommandInput, - cb: (err: any, data?: CreateMeetingCommandOutput) => void - ): void; - public createMeeting( + createMeeting(args: CreateMeetingCommandInput, options?: __HttpHandlerOptions): Promise; + createMeeting(args: CreateMeetingCommandInput, cb: (err: any, data?: CreateMeetingCommandOutput) => void): void; + createMeeting( args: CreateMeetingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMeetingCommandOutput) => void ): void; - public createMeeting( - args: CreateMeetingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMeetingCommandOutput) => void), - cb?: (err: any, data?: CreateMeetingCommandOutput) => void - ): Promise | void { - const command = new CreateMeetingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see - * Amazon Chime SDK Media Regions - * in the Amazon Chime Developer Guide. For more information about the Amazon Chime SDK, see - * Using the Amazon Chime SDK - * in the Amazon Chime Developer Guide. - *

+ * @see {@link CreateMeetingWithAttendeesCommand} */ - public createMeetingWithAttendees( + createMeetingWithAttendees( args: CreateMeetingWithAttendeesCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMeetingWithAttendees( + createMeetingWithAttendees( args: CreateMeetingWithAttendeesCommandInput, cb: (err: any, data?: CreateMeetingWithAttendeesCommandOutput) => void ): void; - public createMeetingWithAttendees( + createMeetingWithAttendees( args: CreateMeetingWithAttendeesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMeetingWithAttendeesCommandOutput) => void ): void; - public createMeetingWithAttendees( - args: CreateMeetingWithAttendeesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMeetingWithAttendeesCommandOutput) => void), - cb?: (err: any, data?: CreateMeetingWithAttendeesCommandOutput) => void - ): Promise | void { - const command = new CreateMeetingWithAttendeesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their - * JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see - * Using the Amazon Chime SDK - * in the Amazon Chime Developer Guide.

+ * @see {@link DeleteAttendeeCommand} */ - public deleteAttendee( + deleteAttendee( args: DeleteAttendeeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAttendee( - args: DeleteAttendeeCommandInput, - cb: (err: any, data?: DeleteAttendeeCommandOutput) => void - ): void; - public deleteAttendee( + deleteAttendee(args: DeleteAttendeeCommandInput, cb: (err: any, data?: DeleteAttendeeCommandOutput) => void): void; + deleteAttendee( args: DeleteAttendeeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAttendeeCommandOutput) => void ): void; - public deleteAttendee( - args: DeleteAttendeeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAttendeeCommandOutput) => void), - cb?: (err: any, data?: DeleteAttendeeCommandOutput) => void - ): Promise | void { - const command = new DeleteAttendeeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from - * joining the meeting. For more information about the Amazon Chime SDK, see - * Using the Amazon Chime SDK in the - * Amazon Chime Developer Guide.

+ * @see {@link DeleteMeetingCommand} */ - public deleteMeeting( - args: DeleteMeetingCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteMeeting( - args: DeleteMeetingCommandInput, - cb: (err: any, data?: DeleteMeetingCommandOutput) => void - ): void; - public deleteMeeting( + deleteMeeting(args: DeleteMeetingCommandInput, options?: __HttpHandlerOptions): Promise; + deleteMeeting(args: DeleteMeetingCommandInput, cb: (err: any, data?: DeleteMeetingCommandOutput) => void): void; + deleteMeeting( args: DeleteMeetingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMeetingCommandOutput) => void ): void; - public deleteMeeting( - args: DeleteMeetingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMeetingCommandOutput) => void), - cb?: (err: any, data?: DeleteMeetingCommandOutput) => void - ): Promise | void { - const command = new DeleteMeetingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see - * Using the Amazon Chime SDK - * in the Amazon Chime Developer Guide. - *

+ * @see {@link GetAttendeeCommand} */ - public getAttendee(args: GetAttendeeCommandInput, options?: __HttpHandlerOptions): Promise; - public getAttendee(args: GetAttendeeCommandInput, cb: (err: any, data?: GetAttendeeCommandOutput) => void): void; - public getAttendee( + getAttendee(args: GetAttendeeCommandInput, options?: __HttpHandlerOptions): Promise; + getAttendee(args: GetAttendeeCommandInput, cb: (err: any, data?: GetAttendeeCommandOutput) => void): void; + getAttendee( args: GetAttendeeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAttendeeCommandOutput) => void ): void; - public getAttendee( - args: GetAttendeeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAttendeeCommandOutput) => void), - cb?: (err: any, data?: GetAttendeeCommandOutput) => void - ): Promise | void { - const command = new GetAttendeeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see - * Using the Amazon Chime SDK - * in the Amazon Chime Developer Guide.

+ * @see {@link GetMeetingCommand} */ - public getMeeting(args: GetMeetingCommandInput, options?: __HttpHandlerOptions): Promise; - public getMeeting(args: GetMeetingCommandInput, cb: (err: any, data?: GetMeetingCommandOutput) => void): void; - public getMeeting( + getMeeting(args: GetMeetingCommandInput, options?: __HttpHandlerOptions): Promise; + getMeeting(args: GetMeetingCommandInput, cb: (err: any, data?: GetMeetingCommandOutput) => void): void; + getMeeting( args: GetMeetingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMeetingCommandOutput) => void ): void; - public getMeeting( - args: GetMeetingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMeetingCommandOutput) => void), - cb?: (err: any, data?: GetMeetingCommandOutput) => void - ): Promise | void { - const command = new GetMeetingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see - * Using the Amazon Chime SDK - * in the Amazon Chime Developer Guide. - *

+ * @see {@link ListAttendeesCommand} */ - public listAttendees( - args: ListAttendeesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listAttendees( - args: ListAttendeesCommandInput, - cb: (err: any, data?: ListAttendeesCommandOutput) => void - ): void; - public listAttendees( + listAttendees(args: ListAttendeesCommandInput, options?: __HttpHandlerOptions): Promise; + listAttendees(args: ListAttendeesCommandInput, cb: (err: any, data?: ListAttendeesCommandOutput) => void): void; + listAttendees( args: ListAttendeesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAttendeesCommandOutput) => void ): void; - public listAttendees( - args: ListAttendeesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAttendeesCommandOutput) => void), - cb?: (err: any, data?: ListAttendeesCommandOutput) => void - ): Promise | void { - const command = new ListAttendeesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the tags available for the specified resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts transcription for the specified meetingId. For more information, refer to - * Using Amazon Chime SDK live transcription - * in the Amazon Chime SDK Developer Guide.

- * - *

Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the - * AWS Service Terms, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services.

- *
+ * @see {@link StartMeetingTranscriptionCommand} */ - public startMeetingTranscription( + startMeetingTranscription( args: StartMeetingTranscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startMeetingTranscription( + startMeetingTranscription( args: StartMeetingTranscriptionCommandInput, cb: (err: any, data?: StartMeetingTranscriptionCommandOutput) => void ): void; - public startMeetingTranscription( + startMeetingTranscription( args: StartMeetingTranscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMeetingTranscriptionCommandOutput) => void ): void; - public startMeetingTranscription( - args: StartMeetingTranscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartMeetingTranscriptionCommandOutput) => void), - cb?: (err: any, data?: StartMeetingTranscriptionCommandOutput) => void - ): Promise | void { - const command = new StartMeetingTranscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops transcription for the specified meetingId. For more information, refer to - * Using Amazon Chime SDK live transcription - * in the Amazon Chime SDK Developer Guide.

- * - *

Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the - * AWS Service Terms, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services.

- *
+ * @see {@link StopMeetingTranscriptionCommand} */ - public stopMeetingTranscription( + stopMeetingTranscription( args: StopMeetingTranscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopMeetingTranscription( + stopMeetingTranscription( args: StopMeetingTranscriptionCommandInput, cb: (err: any, data?: StopMeetingTranscriptionCommandOutput) => void ): void; - public stopMeetingTranscription( + stopMeetingTranscription( args: StopMeetingTranscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopMeetingTranscriptionCommandOutput) => void ): void; - public stopMeetingTranscription( - args: StopMeetingTranscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopMeetingTranscriptionCommandOutput) => void), - cb?: (err: any, data?: StopMeetingTranscriptionCommandOutput) => void - ): Promise | void { - const command = new StopMeetingTranscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The resource that supports tags.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you - * attempt to remove tags from a resource that were already removed. Note the following:

- *
    - *
  • - *

    To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, - * see the documentation for the service whose resource you want to untag.

    - *
  • - *
  • - *

    You can only tag resources that are located in the specified AWS Region for the calling AWS account.

    - *
  • - *
- *

- * Minimum permissions - *

- *

In addition to the tag:UntagResources permission required by this operation, you must also have the remove tags permission defined by the service that created the resource. - * For example, to remove the tags from an Amazon EC2 instance using the UntagResources operation, you must have both of the following permissions:

- *

- * tag:UntagResource - *

- *

- * ChimeSDKMeetings:DeleteTags - *

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The capabilties that you want to update.

- * - *

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see - * .

- *
- *

When using capabilities, be aware of these corner cases:

- *
    - *
  • - *

    You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive - * or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability - * to receive and you set your content capability to not receive.

    - *
  • - *
  • - *

    When you change an audio capability from None or Receive to Send or SendReceive , - * and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

    - *
  • - *
  • - *

    When you change a video or content capability from None or Receive to Send or SendReceive , - * and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

    - *
  • - *
+ * @see {@link UpdateAttendeeCapabilitiesCommand} */ - public updateAttendeeCapabilities( + updateAttendeeCapabilities( args: UpdateAttendeeCapabilitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAttendeeCapabilities( + updateAttendeeCapabilities( args: UpdateAttendeeCapabilitiesCommandInput, cb: (err: any, data?: UpdateAttendeeCapabilitiesCommandOutput) => void ): void; - public updateAttendeeCapabilities( + updateAttendeeCapabilities( args: UpdateAttendeeCapabilitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAttendeeCapabilitiesCommandOutput) => void ): void; - public updateAttendeeCapabilities( - args: UpdateAttendeeCapabilitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAttendeeCapabilitiesCommandOutput) => void), - cb?: (err: any, data?: UpdateAttendeeCapabilitiesCommandOutput) => void - ): Promise | void { - const command = new UpdateAttendeeCapabilitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and + * receive meeting notifications. For more information about the meeting APIs, see + * Amazon Chime SDK meetings.

+ */ +export class ChimeSDKMeetings extends ChimeSDKMeetingsClient implements ChimeSDKMeetings {} +createAggregatedClient(commands, ChimeSDKMeetings); diff --git a/clients/client-chime-sdk-messaging/src/ChimeSDKMessaging.ts b/clients/client-chime-sdk-messaging/src/ChimeSDKMessaging.ts index 554ec03c8245..664ca42c6618 100644 --- a/clients/client-chime-sdk-messaging/src/ChimeSDKMessaging.ts +++ b/clients/client-chime-sdk-messaging/src/ChimeSDKMessaging.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { ChimeSDKMessagingClient } from "./ChimeSDKMessagingClient"; +import { ChimeSDKMessagingClient, ChimeSDKMessagingClientConfig } from "./ChimeSDKMessagingClient"; import { AssociateChannelFlowCommand, AssociateChannelFlowCommandInput, @@ -254,2050 +255,887 @@ import { UpdateChannelReadMarkerCommandOutput, } from "./commands/UpdateChannelReadMarkerCommand"; -/** - * @public - *

The Amazon Chime SDK Messaging APIs in this section allow software developers to send - * and receive messages in custom messaging applications. These APIs depend on the frameworks - * provided by the Amazon Chime SDK Identity APIs. For more information about the messaging - * APIs, see Amazon Chime SDK messaging.

- */ -export class ChimeSDKMessaging extends ChimeSDKMessagingClient { +const commands = { + AssociateChannelFlowCommand, + BatchCreateChannelMembershipCommand, + ChannelFlowCallbackCommand, + CreateChannelCommand, + CreateChannelBanCommand, + CreateChannelFlowCommand, + CreateChannelMembershipCommand, + CreateChannelModeratorCommand, + DeleteChannelCommand, + DeleteChannelBanCommand, + DeleteChannelFlowCommand, + DeleteChannelMembershipCommand, + DeleteChannelMessageCommand, + DeleteChannelModeratorCommand, + DeleteMessagingStreamingConfigurationsCommand, + DescribeChannelCommand, + DescribeChannelBanCommand, + DescribeChannelFlowCommand, + DescribeChannelMembershipCommand, + DescribeChannelMembershipForAppInstanceUserCommand, + DescribeChannelModeratedByAppInstanceUserCommand, + DescribeChannelModeratorCommand, + DisassociateChannelFlowCommand, + GetChannelMembershipPreferencesCommand, + GetChannelMessageCommand, + GetChannelMessageStatusCommand, + GetMessagingSessionEndpointCommand, + GetMessagingStreamingConfigurationsCommand, + ListChannelBansCommand, + ListChannelFlowsCommand, + ListChannelMembershipsCommand, + ListChannelMembershipsForAppInstanceUserCommand, + ListChannelMessagesCommand, + ListChannelModeratorsCommand, + ListChannelsCommand, + ListChannelsAssociatedWithChannelFlowCommand, + ListChannelsModeratedByAppInstanceUserCommand, + ListSubChannelsCommand, + ListTagsForResourceCommand, + PutChannelExpirationSettingsCommand, + PutChannelMembershipPreferencesCommand, + PutMessagingStreamingConfigurationsCommand, + RedactChannelMessageCommand, + SearchChannelsCommand, + SendChannelMessageCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateChannelCommand, + UpdateChannelFlowCommand, + UpdateChannelMessageCommand, + UpdateChannelReadMarkerCommand, +}; + +export interface ChimeSDKMessaging { /** - * @public - *

Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the - * DisassociateChannelFlow API.

- * - *

Only administrators or channel moderators can associate a channel flow. The - * x-amz-chime-bearer request header is mandatory. Use the ARN of the - * AppInstanceUser or AppInstanceBot - * that makes the API call as the value in the header.

- *
+ * @see {@link AssociateChannelFlowCommand} */ - public associateChannelFlow( + associateChannelFlow( args: AssociateChannelFlowCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateChannelFlow( + associateChannelFlow( args: AssociateChannelFlowCommandInput, cb: (err: any, data?: AssociateChannelFlowCommandOutput) => void ): void; - public associateChannelFlow( + associateChannelFlow( args: AssociateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateChannelFlowCommandOutput) => void ): void; - public associateChannelFlow( - args: AssociateChannelFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateChannelFlowCommandOutput) => void), - cb?: (err: any, data?: AssociateChannelFlowCommandOutput) => void - ): Promise | void { - const command = new AssociateChannelFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a specified number of users and bots to a channel.

+ * @see {@link BatchCreateChannelMembershipCommand} */ - public batchCreateChannelMembership( + batchCreateChannelMembership( args: BatchCreateChannelMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchCreateChannelMembership( + batchCreateChannelMembership( args: BatchCreateChannelMembershipCommandInput, cb: (err: any, data?: BatchCreateChannelMembershipCommandOutput) => void ): void; - public batchCreateChannelMembership( + batchCreateChannelMembership( args: BatchCreateChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCreateChannelMembershipCommandOutput) => void ): void; - public batchCreateChannelMembership( - args: BatchCreateChannelMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchCreateChannelMembershipCommandOutput) => void), - cb?: (err: any, data?: BatchCreateChannelMembershipCommandOutput) => void - ): Promise | void { - const command = new BatchCreateChannelMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Calls back Chime SDK Messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.

- *

You can return one of the following processing responses:

- *
    - *
  • - *

    Update message content or metadata

    - *
  • - *
  • - *

    Deny a message

    - *
  • - *
  • - *

    Make no changes to the message

    - *
  • - *
+ * @see {@link ChannelFlowCallbackCommand} */ - public channelFlowCallback( + channelFlowCallback( args: ChannelFlowCallbackCommandInput, options?: __HttpHandlerOptions ): Promise; - public channelFlowCallback( + channelFlowCallback( args: ChannelFlowCallbackCommandInput, cb: (err: any, data?: ChannelFlowCallbackCommandOutput) => void ): void; - public channelFlowCallback( + channelFlowCallback( args: ChannelFlowCallbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChannelFlowCallbackCommandOutput) => void ): void; - public channelFlowCallback( - args: ChannelFlowCallbackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ChannelFlowCallbackCommandOutput) => void), - cb?: (err: any, data?: ChannelFlowCallbackCommandOutput) => void - ): Promise | void { - const command = new ChannelFlowCallbackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a channel to which you can add users and send messages.

- *

- * Restriction: You can't change a channel's - * privacy.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link CreateChannelCommand} */ - public createChannel( - args: CreateChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createChannel( - args: CreateChannelCommandInput, - cb: (err: any, data?: CreateChannelCommandOutput) => void - ): void; - public createChannel( + createChannel(args: CreateChannelCommandInput, options?: __HttpHandlerOptions): Promise; + createChannel(args: CreateChannelCommandInput, cb: (err: any, data?: CreateChannelCommandOutput) => void): void; + createChannel( args: CreateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelCommandOutput) => void ): void; - public createChannel( - args: CreateChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateChannelCommandOutput) => void), - cb?: (err: any, data?: CreateChannelCommandOutput) => void - ): Promise | void { - const command = new CreateChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Permanently bans a member from a channel. Moderators can't add banned members to a - * channel. To undo a ban, you first have to DeleteChannelBan, and then - * CreateChannelMembership. Bans are cleaned up when you delete users or - * channels.

- *

If you ban a user who is already part of a channel, that user is automatically kicked - * from the channel.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link CreateChannelBanCommand} */ - public createChannelBan( + createChannelBan( args: CreateChannelBanCommandInput, options?: __HttpHandlerOptions ): Promise; - public createChannelBan( + createChannelBan( args: CreateChannelBanCommandInput, cb: (err: any, data?: CreateChannelBanCommandOutput) => void ): void; - public createChannelBan( + createChannelBan( args: CreateChannelBanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelBanCommandOutput) => void ): void; - public createChannelBan( - args: CreateChannelBanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateChannelBanCommandOutput) => void), - cb?: (err: any, data?: CreateChannelBanCommandOutput) => void - ): Promise | void { - const command = new CreateChannelBanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a channel flow, a container for processors. Processors are AWS Lambda functions - * that perform actions on chat messages, such as stripping out profanity. You can associate - * channel flows with channels, and the processors in the channel flow then take action on all - * messages sent to that channel. This is a developer API.

- *

Channel flows process the following items:

- *
    - *
  1. - *

    New and updated messages

    - *
  2. - *
  3. - *

    Persistent and non-persistent messages

    - *
  4. - *
  5. - *

    The Standard message type

    - *
  6. - *
- * - *

Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK Messaging, refer to - * Message types in the Amazon Chime developer guide.

- *
+ * @see {@link CreateChannelFlowCommand} */ - public createChannelFlow( + createChannelFlow( args: CreateChannelFlowCommandInput, options?: __HttpHandlerOptions ): Promise; - public createChannelFlow( + createChannelFlow( args: CreateChannelFlowCommandInput, cb: (err: any, data?: CreateChannelFlowCommandOutput) => void ): void; - public createChannelFlow( + createChannelFlow( args: CreateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelFlowCommandOutput) => void ): void; - public createChannelFlow( - args: CreateChannelFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateChannelFlowCommandOutput) => void), - cb?: (err: any, data?: CreateChannelFlowCommandOutput) => void - ): Promise | void { - const command = new CreateChannelFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a member to a channel. The InvitedBy field in ChannelMembership - * is derived from the request header. A channel member can:

- *
    - *
  • - *

    List messages

    - *
  • - *
  • - *

    Send messages

    - *
  • - *
  • - *

    Receive messages

    - *
  • - *
  • - *

    Edit their own messages

    - *
  • - *
  • - *

    Leave the channel

    - *
  • - *
- *

Privacy settings impact this action as follows:

- *
    - *
  • - *

    Public Channels: You do not need to be a member to list messages, but you must be - * a member to send messages.

    - *
  • - *
  • - *

    Private Channels: You must be a member to list or send messages.

    - *
  • - *
- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUserArn or AppInstanceBot that makes the API call - * as the value in the header.

- *
+ * @see {@link CreateChannelMembershipCommand} */ - public createChannelMembership( + createChannelMembership( args: CreateChannelMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public createChannelMembership( + createChannelMembership( args: CreateChannelMembershipCommandInput, cb: (err: any, data?: CreateChannelMembershipCommandOutput) => void ): void; - public createChannelMembership( + createChannelMembership( args: CreateChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelMembershipCommandOutput) => void ): void; - public createChannelMembership( - args: CreateChannelMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateChannelMembershipCommandOutput) => void), - cb?: (err: any, data?: CreateChannelMembershipCommandOutput) => void - ): Promise | void { - const command = new CreateChannelMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new ChannelModerator. A channel moderator can:

- *
    - *
  • - *

    Add and remove other members of the channel.

    - *
  • - *
  • - *

    Add and remove other moderators of the channel.

    - *
  • - *
  • - *

    Add and remove user bans for the channel.

    - *
  • - *
  • - *

    Redact messages in the channel.

    - *
  • - *
  • - *

    List messages in the channel.

    - *
  • - *
- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBotof the user that makes the API call as the value in - * the header.

- *
+ * @see {@link CreateChannelModeratorCommand} */ - public createChannelModerator( + createChannelModerator( args: CreateChannelModeratorCommandInput, options?: __HttpHandlerOptions ): Promise; - public createChannelModerator( + createChannelModerator( args: CreateChannelModeratorCommandInput, cb: (err: any, data?: CreateChannelModeratorCommandOutput) => void ): void; - public createChannelModerator( + createChannelModerator( args: CreateChannelModeratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelModeratorCommandOutput) => void ): void; - public createChannelModerator( - args: CreateChannelModeratorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateChannelModeratorCommandOutput) => void), - cb?: (err: any, data?: CreateChannelModeratorCommandOutput) => void - ): Promise | void { - const command = new CreateChannelModeratorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Immediately makes a channel and its memberships inaccessible and marks them for - * deletion. This is an irreversible process.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUserArn or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link DeleteChannelCommand} */ - public deleteChannel( - args: DeleteChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteChannel( - args: DeleteChannelCommandInput, - cb: (err: any, data?: DeleteChannelCommandOutput) => void - ): void; - public deleteChannel( + deleteChannel(args: DeleteChannelCommandInput, options?: __HttpHandlerOptions): Promise; + deleteChannel(args: DeleteChannelCommandInput, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void; + deleteChannel( args: DeleteChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelCommandOutput) => void ): void; - public deleteChannel( - args: DeleteChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteChannelCommandOutput) => void), - cb?: (err: any, data?: DeleteChannelCommandOutput) => void - ): Promise | void { - const command = new DeleteChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a member from a channel's ban list.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link DeleteChannelBanCommand} */ - public deleteChannelBan( + deleteChannelBan( args: DeleteChannelBanCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteChannelBan( + deleteChannelBan( args: DeleteChannelBanCommandInput, cb: (err: any, data?: DeleteChannelBanCommandOutput) => void ): void; - public deleteChannelBan( + deleteChannelBan( args: DeleteChannelBanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelBanCommandOutput) => void ): void; - public deleteChannelBan( - args: DeleteChannelBanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteChannelBanCommandOutput) => void), - cb?: (err: any, data?: DeleteChannelBanCommandOutput) => void - ): Promise | void { - const command = new DeleteChannelBanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a channel flow, an irreversible process. This is a developer API.

- * - *

This API works only when the channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with, use the - * ListChannelsAssociatedWithChannelFlow API. Use the DisassociateChannelFlow API to disassociate a channel flow from all channels.

- *
+ * @see {@link DeleteChannelFlowCommand} */ - public deleteChannelFlow( + deleteChannelFlow( args: DeleteChannelFlowCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteChannelFlow( + deleteChannelFlow( args: DeleteChannelFlowCommandInput, cb: (err: any, data?: DeleteChannelFlowCommandOutput) => void ): void; - public deleteChannelFlow( + deleteChannelFlow( args: DeleteChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelFlowCommandOutput) => void ): void; - public deleteChannelFlow( - args: DeleteChannelFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteChannelFlowCommandOutput) => void), - cb?: (err: any, data?: DeleteChannelFlowCommandOutput) => void - ): Promise | void { - const command = new DeleteChannelFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a member from a channel.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
+ * @see {@link DeleteChannelMembershipCommand} */ - public deleteChannelMembership( + deleteChannelMembership( args: DeleteChannelMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteChannelMembership( + deleteChannelMembership( args: DeleteChannelMembershipCommandInput, cb: (err: any, data?: DeleteChannelMembershipCommandOutput) => void ): void; - public deleteChannelMembership( + deleteChannelMembership( args: DeleteChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelMembershipCommandOutput) => void ): void; - public deleteChannelMembership( - args: DeleteChannelMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteChannelMembershipCommandOutput) => void), - cb?: (err: any, data?: DeleteChannelMembershipCommandOutput) => void - ): Promise | void { - const command = new DeleteChannelMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a channel message. Only admins can perform this action. Deletion makes messages - * inaccessible immediately. A background process deletes any revisions created by - * UpdateChannelMessage.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link DeleteChannelMessageCommand} */ - public deleteChannelMessage( + deleteChannelMessage( args: DeleteChannelMessageCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteChannelMessage( + deleteChannelMessage( args: DeleteChannelMessageCommandInput, cb: (err: any, data?: DeleteChannelMessageCommandOutput) => void ): void; - public deleteChannelMessage( + deleteChannelMessage( args: DeleteChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelMessageCommandOutput) => void ): void; - public deleteChannelMessage( - args: DeleteChannelMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteChannelMessageCommandOutput) => void), - cb?: (err: any, data?: DeleteChannelMessageCommandOutput) => void - ): Promise | void { - const command = new DeleteChannelMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a channel moderator.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link DeleteChannelModeratorCommand} */ - public deleteChannelModerator( + deleteChannelModerator( args: DeleteChannelModeratorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteChannelModerator( + deleteChannelModerator( args: DeleteChannelModeratorCommandInput, cb: (err: any, data?: DeleteChannelModeratorCommandOutput) => void ): void; - public deleteChannelModerator( + deleteChannelModerator( args: DeleteChannelModeratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelModeratorCommandOutput) => void ): void; - public deleteChannelModerator( - args: DeleteChannelModeratorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteChannelModeratorCommandOutput) => void), - cb?: (err: any, data?: DeleteChannelModeratorCommandOutput) => void - ): Promise | void { - const command = new DeleteChannelModeratorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the streaming configurations for an AppInstance. For more information, see - * Streaming messaging data in the Amazon Chime SDK Developer Guide.

+ * @see {@link DeleteMessagingStreamingConfigurationsCommand} */ - public deleteMessagingStreamingConfigurations( + deleteMessagingStreamingConfigurations( args: DeleteMessagingStreamingConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMessagingStreamingConfigurations( + deleteMessagingStreamingConfigurations( args: DeleteMessagingStreamingConfigurationsCommandInput, cb: (err: any, data?: DeleteMessagingStreamingConfigurationsCommandOutput) => void ): void; - public deleteMessagingStreamingConfigurations( + deleteMessagingStreamingConfigurations( args: DeleteMessagingStreamingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMessagingStreamingConfigurationsCommandOutput) => void ): void; - public deleteMessagingStreamingConfigurations( - args: DeleteMessagingStreamingConfigurationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteMessagingStreamingConfigurationsCommandOutput) => void), - cb?: (err: any, data?: DeleteMessagingStreamingConfigurationsCommandOutput) => void - ): Promise | void { - const command = new DeleteMessagingStreamingConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the full details of a channel in an Amazon Chime - * AppInstance.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link DescribeChannelCommand} */ - public describeChannel( + describeChannel( args: DescribeChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeChannel( - args: DescribeChannelCommandInput, - cb: (err: any, data?: DescribeChannelCommandOutput) => void - ): void; - public describeChannel( + describeChannel(args: DescribeChannelCommandInput, cb: (err: any, data?: DescribeChannelCommandOutput) => void): void; + describeChannel( args: DescribeChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelCommandOutput) => void ): void; - public describeChannel( - args: DescribeChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeChannelCommandOutput) => void), - cb?: (err: any, data?: DescribeChannelCommandOutput) => void - ): Promise | void { - const command = new DescribeChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the full details of a channel ban.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link DescribeChannelBanCommand} */ - public describeChannelBan( + describeChannelBan( args: DescribeChannelBanCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeChannelBan( + describeChannelBan( args: DescribeChannelBanCommandInput, cb: (err: any, data?: DescribeChannelBanCommandOutput) => void ): void; - public describeChannelBan( + describeChannelBan( args: DescribeChannelBanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelBanCommandOutput) => void ): void; - public describeChannelBan( - args: DescribeChannelBanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeChannelBanCommandOutput) => void), - cb?: (err: any, data?: DescribeChannelBanCommandOutput) => void - ): Promise | void { - const command = new DescribeChannelBanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API.

+ * @see {@link DescribeChannelFlowCommand} */ - public describeChannelFlow( + describeChannelFlow( args: DescribeChannelFlowCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeChannelFlow( + describeChannelFlow( args: DescribeChannelFlowCommandInput, cb: (err: any, data?: DescribeChannelFlowCommandOutput) => void ): void; - public describeChannelFlow( + describeChannelFlow( args: DescribeChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelFlowCommandOutput) => void ): void; - public describeChannelFlow( - args: DescribeChannelFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeChannelFlowCommandOutput) => void), - cb?: (err: any, data?: DescribeChannelFlowCommandOutput) => void - ): Promise | void { - const command = new DescribeChannelFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the full details of a user's channel membership.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link DescribeChannelMembershipCommand} */ - public describeChannelMembership( + describeChannelMembership( args: DescribeChannelMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeChannelMembership( + describeChannelMembership( args: DescribeChannelMembershipCommandInput, cb: (err: any, data?: DescribeChannelMembershipCommandOutput) => void ): void; - public describeChannelMembership( + describeChannelMembership( args: DescribeChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelMembershipCommandOutput) => void ): void; - public describeChannelMembership( - args: DescribeChannelMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeChannelMembershipCommandOutput) => void), - cb?: (err: any, data?: DescribeChannelMembershipCommandOutput) => void - ): Promise | void { - const command = new DescribeChannelMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the details of a channel based on the membership of the specified - * AppInstanceUser or AppInstanceBot.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link DescribeChannelMembershipForAppInstanceUserCommand} */ - public describeChannelMembershipForAppInstanceUser( + describeChannelMembershipForAppInstanceUser( args: DescribeChannelMembershipForAppInstanceUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeChannelMembershipForAppInstanceUser( + describeChannelMembershipForAppInstanceUser( args: DescribeChannelMembershipForAppInstanceUserCommandInput, cb: (err: any, data?: DescribeChannelMembershipForAppInstanceUserCommandOutput) => void ): void; - public describeChannelMembershipForAppInstanceUser( + describeChannelMembershipForAppInstanceUser( args: DescribeChannelMembershipForAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelMembershipForAppInstanceUserCommandOutput) => void ): void; - public describeChannelMembershipForAppInstanceUser( - args: DescribeChannelMembershipForAppInstanceUserCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeChannelMembershipForAppInstanceUserCommandOutput) => void), - cb?: (err: any, data?: DescribeChannelMembershipForAppInstanceUserCommandOutput) => void - ): Promise | void { - const command = new DescribeChannelMembershipForAppInstanceUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the full details of a channel moderated by the specified - * AppInstanceUser or AppInstanceBot.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link DescribeChannelModeratedByAppInstanceUserCommand} */ - public describeChannelModeratedByAppInstanceUser( + describeChannelModeratedByAppInstanceUser( args: DescribeChannelModeratedByAppInstanceUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeChannelModeratedByAppInstanceUser( + describeChannelModeratedByAppInstanceUser( args: DescribeChannelModeratedByAppInstanceUserCommandInput, cb: (err: any, data?: DescribeChannelModeratedByAppInstanceUserCommandOutput) => void ): void; - public describeChannelModeratedByAppInstanceUser( + describeChannelModeratedByAppInstanceUser( args: DescribeChannelModeratedByAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelModeratedByAppInstanceUserCommandOutput) => void ): void; - public describeChannelModeratedByAppInstanceUser( - args: DescribeChannelModeratedByAppInstanceUserCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeChannelModeratedByAppInstanceUserCommandOutput) => void), - cb?: (err: any, data?: DescribeChannelModeratedByAppInstanceUserCommandOutput) => void - ): Promise | void { - const command = new DescribeChannelModeratedByAppInstanceUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the full details of a single ChannelModerator.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
+ * @see {@link DescribeChannelModeratorCommand} */ - public describeChannelModerator( + describeChannelModerator( args: DescribeChannelModeratorCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeChannelModerator( + describeChannelModerator( args: DescribeChannelModeratorCommandInput, cb: (err: any, data?: DescribeChannelModeratorCommandOutput) => void ): void; - public describeChannelModerator( + describeChannelModerator( args: DescribeChannelModeratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelModeratorCommandOutput) => void ): void; - public describeChannelModerator( - args: DescribeChannelModeratorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeChannelModeratorCommandOutput) => void), - cb?: (err: any, data?: DescribeChannelModeratorCommandOutput) => void - ): Promise | void { - const command = new DescribeChannelModeratorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates a channel flow from all its channels. Once disassociated, all messages to - * that channel stop going through the channel flow processor.

- * - *

Only administrators or channel moderators can disassociate a channel flow.

- *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link DisassociateChannelFlowCommand} */ - public disassociateChannelFlow( + disassociateChannelFlow( args: DisassociateChannelFlowCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateChannelFlow( + disassociateChannelFlow( args: DisassociateChannelFlowCommandInput, cb: (err: any, data?: DisassociateChannelFlowCommandOutput) => void ): void; - public disassociateChannelFlow( + disassociateChannelFlow( args: DisassociateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateChannelFlowCommandOutput) => void ): void; - public disassociateChannelFlow( - args: DisassociateChannelFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateChannelFlowCommandOutput) => void), - cb?: (err: any, data?: DisassociateChannelFlowCommandOutput) => void - ): Promise | void { - const command = new DisassociateChannelFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the membership preferences of an AppInstanceUser or AppInstanceBot - * for the specified channel. A user or a bot must be a member of the channel and own the membership to be able - * to retrieve membership preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't - * retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the - * channel from which they are banned.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link GetChannelMembershipPreferencesCommand} */ - public getChannelMembershipPreferences( + getChannelMembershipPreferences( args: GetChannelMembershipPreferencesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getChannelMembershipPreferences( + getChannelMembershipPreferences( args: GetChannelMembershipPreferencesCommandInput, cb: (err: any, data?: GetChannelMembershipPreferencesCommandOutput) => void ): void; - public getChannelMembershipPreferences( + getChannelMembershipPreferences( args: GetChannelMembershipPreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelMembershipPreferencesCommandOutput) => void ): void; - public getChannelMembershipPreferences( - args: GetChannelMembershipPreferencesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetChannelMembershipPreferencesCommandOutput) => void), - cb?: (err: any, data?: GetChannelMembershipPreferencesCommandOutput) => void - ): Promise | void { - const command = new GetChannelMembershipPreferencesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the full details of a channel message.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link GetChannelMessageCommand} */ - public getChannelMessage( + getChannelMessage( args: GetChannelMessageCommandInput, options?: __HttpHandlerOptions ): Promise; - public getChannelMessage( + getChannelMessage( args: GetChannelMessageCommandInput, cb: (err: any, data?: GetChannelMessageCommandOutput) => void ): void; - public getChannelMessage( + getChannelMessage( args: GetChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelMessageCommandOutput) => void ): void; - public getChannelMessage( - args: GetChannelMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetChannelMessageCommandOutput) => void), - cb?: (err: any, data?: GetChannelMessageCommandOutput) => void - ): Promise | void { - const command = new GetChannelMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets message status for a specified messageId. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to - * retrieving message status if the event was not received because a client wasn't connected to a websocket.

- *

Messages can have any one of these statuses.

- *
- *
SENT
- *
- *

Message processed successfully

- *
- *
PENDING
- *
- *

Ongoing processing

- *
- *
FAILED
- *
- *

Processing failed

- *
- *
DENIED
- *
- *

Messasge denied by the processor

- *
- *
- * - *
    - *
  • - *

    This API does not return statuses for denied messages, because we don't store them once the processor denies them.

    - *
  • - *
  • - *

    Only the message sender can invoke this API.

    - *
  • - *
  • - *

    The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

    - *
  • - *
- *
+ * @see {@link GetChannelMessageStatusCommand} */ - public getChannelMessageStatus( + getChannelMessageStatus( args: GetChannelMessageStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getChannelMessageStatus( + getChannelMessageStatus( args: GetChannelMessageStatusCommandInput, cb: (err: any, data?: GetChannelMessageStatusCommandOutput) => void ): void; - public getChannelMessageStatus( + getChannelMessageStatus( args: GetChannelMessageStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelMessageStatusCommandOutput) => void ): void; - public getChannelMessageStatus( - args: GetChannelMessageStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetChannelMessageStatusCommandOutput) => void), - cb?: (err: any, data?: GetChannelMessageStatusCommandOutput) => void - ): Promise | void { - const command = new GetChannelMessageStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The details of the endpoint for the messaging session.

+ * @see {@link GetMessagingSessionEndpointCommand} */ - public getMessagingSessionEndpoint( + getMessagingSessionEndpoint( args: GetMessagingSessionEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMessagingSessionEndpoint( + getMessagingSessionEndpoint( args: GetMessagingSessionEndpointCommandInput, cb: (err: any, data?: GetMessagingSessionEndpointCommandOutput) => void ): void; - public getMessagingSessionEndpoint( + getMessagingSessionEndpoint( args: GetMessagingSessionEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMessagingSessionEndpointCommandOutput) => void ): void; - public getMessagingSessionEndpoint( - args: GetMessagingSessionEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMessagingSessionEndpointCommandOutput) => void), - cb?: (err: any, data?: GetMessagingSessionEndpointCommandOutput) => void - ): Promise | void { - const command = new GetMessagingSessionEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the data streaming configuration for an AppInstance. For more information, see - * Streaming messaging data in the Amazon Chime SDK Developer Guide.

+ * @see {@link GetMessagingStreamingConfigurationsCommand} */ - public getMessagingStreamingConfigurations( + getMessagingStreamingConfigurations( args: GetMessagingStreamingConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMessagingStreamingConfigurations( + getMessagingStreamingConfigurations( args: GetMessagingStreamingConfigurationsCommandInput, cb: (err: any, data?: GetMessagingStreamingConfigurationsCommandOutput) => void ): void; - public getMessagingStreamingConfigurations( + getMessagingStreamingConfigurations( args: GetMessagingStreamingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMessagingStreamingConfigurationsCommandOutput) => void ): void; - public getMessagingStreamingConfigurations( - args: GetMessagingStreamingConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMessagingStreamingConfigurationsCommandOutput) => void), - cb?: (err: any, data?: GetMessagingStreamingConfigurationsCommandOutput) => void - ): Promise | void { - const command = new GetMessagingStreamingConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the users and bots banned from a particular channel.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link ListChannelBansCommand} */ - public listChannelBans( + listChannelBans( args: ListChannelBansCommandInput, options?: __HttpHandlerOptions ): Promise; - public listChannelBans( - args: ListChannelBansCommandInput, - cb: (err: any, data?: ListChannelBansCommandOutput) => void - ): void; - public listChannelBans( + listChannelBans(args: ListChannelBansCommandInput, cb: (err: any, data?: ListChannelBansCommandOutput) => void): void; + listChannelBans( args: ListChannelBansCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelBansCommandOutput) => void ): void; - public listChannelBans( - args: ListChannelBansCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListChannelBansCommandOutput) => void), - cb?: (err: any, data?: ListChannelBansCommandOutput) => void - ): Promise | void { - const command = new ListChannelBansCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.

+ * @see {@link ListChannelFlowsCommand} */ - public listChannelFlows( + listChannelFlows( args: ListChannelFlowsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listChannelFlows( + listChannelFlows( args: ListChannelFlowsCommandInput, cb: (err: any, data?: ListChannelFlowsCommandOutput) => void ): void; - public listChannelFlows( + listChannelFlows( args: ListChannelFlowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelFlowsCommandOutput) => void ): void; - public listChannelFlows( - args: ListChannelFlowsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListChannelFlowsCommandOutput) => void), - cb?: (err: any, data?: ListChannelFlowsCommandOutput) => void - ): Promise | void { - const command = new ListChannelFlowsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all channel memberships in a channel.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
- *

If you want to list the channels to which a specific app instance user belongs, see the - * ListChannelMembershipsForAppInstanceUser API.

+ * @see {@link ListChannelMembershipsCommand} */ - public listChannelMemberships( + listChannelMemberships( args: ListChannelMembershipsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listChannelMemberships( + listChannelMemberships( args: ListChannelMembershipsCommandInput, cb: (err: any, data?: ListChannelMembershipsCommandOutput) => void ): void; - public listChannelMemberships( + listChannelMemberships( args: ListChannelMembershipsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelMembershipsCommandOutput) => void ): void; - public listChannelMemberships( - args: ListChannelMembershipsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListChannelMembershipsCommandOutput) => void), - cb?: (err: any, data?: ListChannelMembershipsCommandOutput) => void - ): Promise | void { - const command = new ListChannelMembershipsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all channels that anr AppInstanceUser or AppInstanceBot is a part of. - * Only an AppInstanceAdmin can call the API with a user ARN that is not their own.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link ListChannelMembershipsForAppInstanceUserCommand} */ - public listChannelMembershipsForAppInstanceUser( + listChannelMembershipsForAppInstanceUser( args: ListChannelMembershipsForAppInstanceUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public listChannelMembershipsForAppInstanceUser( + listChannelMembershipsForAppInstanceUser( args: ListChannelMembershipsForAppInstanceUserCommandInput, cb: (err: any, data?: ListChannelMembershipsForAppInstanceUserCommandOutput) => void ): void; - public listChannelMembershipsForAppInstanceUser( + listChannelMembershipsForAppInstanceUser( args: ListChannelMembershipsForAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelMembershipsForAppInstanceUserCommandOutput) => void ): void; - public listChannelMembershipsForAppInstanceUser( - args: ListChannelMembershipsForAppInstanceUserCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListChannelMembershipsForAppInstanceUserCommandOutput) => void), - cb?: (err: any, data?: ListChannelMembershipsForAppInstanceUserCommandOutput) => void - ): Promise | void { - const command = new ListChannelMembershipsForAppInstanceUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all the messages in a channel. Returns a paginated list of - * ChannelMessages. By default, sorted by creation timestamp in descending - * order.

- * - *

Redacted messages appear in the results as empty, since they are only redacted, not - * deleted. Deleted messages do not appear in the results. This action always returns the - * latest version of an edited message.

- *

Also, the x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link ListChannelMessagesCommand} */ - public listChannelMessages( + listChannelMessages( args: ListChannelMessagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listChannelMessages( + listChannelMessages( args: ListChannelMessagesCommandInput, cb: (err: any, data?: ListChannelMessagesCommandOutput) => void ): void; - public listChannelMessages( + listChannelMessages( args: ListChannelMessagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelMessagesCommandOutput) => void ): void; - public listChannelMessages( - args: ListChannelMessagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListChannelMessagesCommandOutput) => void), - cb?: (err: any, data?: ListChannelMessagesCommandOutput) => void - ): Promise | void { - const command = new ListChannelMessagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the moderators for a channel.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link ListChannelModeratorsCommand} */ - public listChannelModerators( + listChannelModerators( args: ListChannelModeratorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listChannelModerators( + listChannelModerators( args: ListChannelModeratorsCommandInput, cb: (err: any, data?: ListChannelModeratorsCommandOutput) => void ): void; - public listChannelModerators( + listChannelModerators( args: ListChannelModeratorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelModeratorsCommandOutput) => void ): void; - public listChannelModerators( - args: ListChannelModeratorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListChannelModeratorsCommandOutput) => void), - cb?: (err: any, data?: ListChannelModeratorsCommandOutput) => void - ): Promise | void { - const command = new ListChannelModeratorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all Channels created under a single Chime App as a paginated list. You can specify - * filters to narrow results.

- *

- * Functionality & restrictions - *

- *
    - *
  • - *

    Use privacy = PUBLIC to retrieve all public channels in the - * account.

    - *
  • - *
  • - *

    Only an AppInstanceAdmin can set privacy = PRIVATE to - * list the private channels in an account.

    - *
  • - *
- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link ListChannelsCommand} */ - public listChannels( - args: ListChannelsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void; - public listChannels( + listChannels(args: ListChannelsCommandInput, options?: __HttpHandlerOptions): Promise; + listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void; + listChannels( args: ListChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsCommandOutput) => void ): void; - public listChannels( - args: ListChannelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListChannelsCommandOutput) => void), - cb?: (err: any, data?: ListChannelsCommandOutput) => void - ): Promise | void { - const command = new ListChannelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API.

+ * @see {@link ListChannelsAssociatedWithChannelFlowCommand} */ - public listChannelsAssociatedWithChannelFlow( + listChannelsAssociatedWithChannelFlow( args: ListChannelsAssociatedWithChannelFlowCommandInput, options?: __HttpHandlerOptions ): Promise; - public listChannelsAssociatedWithChannelFlow( + listChannelsAssociatedWithChannelFlow( args: ListChannelsAssociatedWithChannelFlowCommandInput, cb: (err: any, data?: ListChannelsAssociatedWithChannelFlowCommandOutput) => void ): void; - public listChannelsAssociatedWithChannelFlow( + listChannelsAssociatedWithChannelFlow( args: ListChannelsAssociatedWithChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsAssociatedWithChannelFlowCommandOutput) => void ): void; - public listChannelsAssociatedWithChannelFlow( - args: ListChannelsAssociatedWithChannelFlowCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListChannelsAssociatedWithChannelFlowCommandOutput) => void), - cb?: (err: any, data?: ListChannelsAssociatedWithChannelFlowCommandOutput) => void - ): Promise | void { - const command = new ListChannelsAssociatedWithChannelFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A list of the channels moderated by an AppInstanceUser.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link ListChannelsModeratedByAppInstanceUserCommand} */ - public listChannelsModeratedByAppInstanceUser( + listChannelsModeratedByAppInstanceUser( args: ListChannelsModeratedByAppInstanceUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public listChannelsModeratedByAppInstanceUser( + listChannelsModeratedByAppInstanceUser( args: ListChannelsModeratedByAppInstanceUserCommandInput, cb: (err: any, data?: ListChannelsModeratedByAppInstanceUserCommandOutput) => void ): void; - public listChannelsModeratedByAppInstanceUser( + listChannelsModeratedByAppInstanceUser( args: ListChannelsModeratedByAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsModeratedByAppInstanceUserCommandOutput) => void ): void; - public listChannelsModeratedByAppInstanceUser( - args: ListChannelsModeratedByAppInstanceUserCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListChannelsModeratedByAppInstanceUserCommandOutput) => void), - cb?: (err: any, data?: ListChannelsModeratedByAppInstanceUserCommandOutput) => void - ): Promise | void { - const command = new ListChannelsModeratedByAppInstanceUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.

+ * @see {@link ListSubChannelsCommand} */ - public listSubChannels( + listSubChannels( args: ListSubChannelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSubChannels( - args: ListSubChannelsCommandInput, - cb: (err: any, data?: ListSubChannelsCommandOutput) => void - ): void; - public listSubChannels( + listSubChannels(args: ListSubChannelsCommandInput, cb: (err: any, data?: ListSubChannelsCommandOutput) => void): void; + listSubChannels( args: ListSubChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSubChannelsCommandOutput) => void ): void; - public listSubChannels( - args: ListSubChannelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSubChannelsCommandOutput) => void), - cb?: (err: any, data?: ListSubChannelsCommandOutput) => void - ): Promise | void { - const command = new ListSubChannelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags applied to an Amazon Chime SDK messaging resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the number of days before the channel is automatically deleted.

- * - *
    - *
  • - *

    A background process deletes expired channels within 6 hours of expiration. - * Actual deletion times may vary.

    - *
  • - *
  • - *

    Expired channels that have not yet been deleted appear as active, and you can update - * their expiration settings. The system honors the new settings.

    - *
  • - *
  • - *

    The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

    - *
  • - *
- *
+ * @see {@link PutChannelExpirationSettingsCommand} */ - public putChannelExpirationSettings( + putChannelExpirationSettings( args: PutChannelExpirationSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putChannelExpirationSettings( + putChannelExpirationSettings( args: PutChannelExpirationSettingsCommandInput, cb: (err: any, data?: PutChannelExpirationSettingsCommandOutput) => void ): void; - public putChannelExpirationSettings( + putChannelExpirationSettings( args: PutChannelExpirationSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutChannelExpirationSettingsCommandOutput) => void ): void; - public putChannelExpirationSettings( - args: PutChannelExpirationSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutChannelExpirationSettingsCommandOutput) => void), - cb?: (err: any, data?: PutChannelExpirationSettingsCommandOutput) => void - ): Promise | void { - const command = new PutChannelExpirationSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the membership preferences of an AppInstanceUser or AppIntanceBot - * for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the - * membership can set preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't set - * preferences for other users or users. Banned users or bots can't set membership preferences for the channel from - * which they are banned.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the ARN of an - * AppInstanceUser or AppInstanceBot that makes the API call as the value in the - * header.

- *
+ * @see {@link PutChannelMembershipPreferencesCommand} */ - public putChannelMembershipPreferences( + putChannelMembershipPreferences( args: PutChannelMembershipPreferencesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putChannelMembershipPreferences( + putChannelMembershipPreferences( args: PutChannelMembershipPreferencesCommandInput, cb: (err: any, data?: PutChannelMembershipPreferencesCommandOutput) => void ): void; - public putChannelMembershipPreferences( + putChannelMembershipPreferences( args: PutChannelMembershipPreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutChannelMembershipPreferencesCommandOutput) => void ): void; - public putChannelMembershipPreferences( - args: PutChannelMembershipPreferencesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutChannelMembershipPreferencesCommandOutput) => void), - cb?: (err: any, data?: PutChannelMembershipPreferencesCommandOutput) => void - ): Promise | void { - const command = new PutChannelMembershipPreferencesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the data streaming configuration for an AppInstance. For more information, see - * Streaming messaging data in the Amazon Chime SDK Developer Guide.

+ * @see {@link PutMessagingStreamingConfigurationsCommand} */ - public putMessagingStreamingConfigurations( + putMessagingStreamingConfigurations( args: PutMessagingStreamingConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putMessagingStreamingConfigurations( + putMessagingStreamingConfigurations( args: PutMessagingStreamingConfigurationsCommandInput, cb: (err: any, data?: PutMessagingStreamingConfigurationsCommandOutput) => void ): void; - public putMessagingStreamingConfigurations( + putMessagingStreamingConfigurations( args: PutMessagingStreamingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMessagingStreamingConfigurationsCommandOutput) => void ): void; - public putMessagingStreamingConfigurations( - args: PutMessagingStreamingConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutMessagingStreamingConfigurationsCommandOutput) => void), - cb?: (err: any, data?: PutMessagingStreamingConfigurationsCommandOutput) => void - ): Promise | void { - const command = new PutMessagingStreamingConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Redacts message content, but not metadata. The message exists in the back end, but the - * action returns null content, and the state shows as redacted.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link RedactChannelMessageCommand} */ - public redactChannelMessage( + redactChannelMessage( args: RedactChannelMessageCommandInput, options?: __HttpHandlerOptions ): Promise; - public redactChannelMessage( + redactChannelMessage( args: RedactChannelMessageCommandInput, cb: (err: any, data?: RedactChannelMessageCommandOutput) => void ): void; - public redactChannelMessage( + redactChannelMessage( args: RedactChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RedactChannelMessageCommandOutput) => void ): void; - public redactChannelMessage( - args: RedactChannelMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RedactChannelMessageCommandOutput) => void), - cb?: (err: any, data?: RedactChannelMessageCommandOutput) => void - ): Promise | void { - const command = new RedactChannelMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows the ChimeBearer to search channels by channel members. Users or bots can search - * across the channels that they belong to. Users in the AppInstanceAdmin role can search across - * all channels.

- *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

+ * @see {@link SearchChannelsCommand} */ - public searchChannels( + searchChannels( args: SearchChannelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchChannels( - args: SearchChannelsCommandInput, - cb: (err: any, data?: SearchChannelsCommandOutput) => void - ): void; - public searchChannels( + searchChannels(args: SearchChannelsCommandInput, cb: (err: any, data?: SearchChannelsCommandOutput) => void): void; + searchChannels( args: SearchChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchChannelsCommandOutput) => void ): void; - public searchChannels( - args: SearchChannelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchChannelsCommandOutput) => void), - cb?: (err: any, data?: SearchChannelsCommandOutput) => void - ): Promise | void { - const command = new SearchChannelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sends a message to a particular channel that the member is a part of.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *

Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. - * CONTROL messages can contain 30 bytes of data and no metadata.

- *
+ * @see {@link SendChannelMessageCommand} */ - public sendChannelMessage( + sendChannelMessage( args: SendChannelMessageCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendChannelMessage( + sendChannelMessage( args: SendChannelMessageCommandInput, cb: (err: any, data?: SendChannelMessageCommandOutput) => void ): void; - public sendChannelMessage( + sendChannelMessage( args: SendChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendChannelMessageCommandOutput) => void ): void; - public sendChannelMessage( - args: SendChannelMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendChannelMessageCommandOutput) => void), - cb?: (err: any, data?: SendChannelMessageCommandOutput) => void - ): Promise | void { - const command = new SendChannelMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Applies the specified tags to the specified Amazon Chime SDK messaging resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified tags from the specified Amazon Chime SDK messaging resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update a channel's attributes.

- *

- * Restriction: You can't change a channel's privacy.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link UpdateChannelCommand} */ - public updateChannel( - args: UpdateChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateChannel( - args: UpdateChannelCommandInput, - cb: (err: any, data?: UpdateChannelCommandOutput) => void - ): void; - public updateChannel( + updateChannel(args: UpdateChannelCommandInput, options?: __HttpHandlerOptions): Promise; + updateChannel(args: UpdateChannelCommandInput, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void; + updateChannel( args: UpdateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelCommandOutput) => void ): void; - public updateChannel( - args: UpdateChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateChannelCommandOutput) => void), - cb?: (err: any, data?: UpdateChannelCommandOutput) => void - ): Promise | void { - const command = new UpdateChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates channel flow attributes. This is a developer API.

+ * @see {@link UpdateChannelFlowCommand} */ - public updateChannelFlow( + updateChannelFlow( args: UpdateChannelFlowCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateChannelFlow( + updateChannelFlow( args: UpdateChannelFlowCommandInput, cb: (err: any, data?: UpdateChannelFlowCommandOutput) => void ): void; - public updateChannelFlow( + updateChannelFlow( args: UpdateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelFlowCommandOutput) => void ): void; - public updateChannelFlow( - args: UpdateChannelFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateChannelFlowCommandOutput) => void), - cb?: (err: any, data?: UpdateChannelFlowCommandOutput) => void - ): Promise | void { - const command = new UpdateChannelFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the content of a message.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link UpdateChannelMessageCommand} */ - public updateChannelMessage( + updateChannelMessage( args: UpdateChannelMessageCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateChannelMessage( + updateChannelMessage( args: UpdateChannelMessageCommandInput, cb: (err: any, data?: UpdateChannelMessageCommandOutput) => void ): void; - public updateChannelMessage( + updateChannelMessage( args: UpdateChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelMessageCommandOutput) => void ): void; - public updateChannelMessage( - args: UpdateChannelMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateChannelMessageCommandOutput) => void), - cb?: (err: any, data?: UpdateChannelMessageCommandOutput) => void - ): Promise | void { - const command = new UpdateChannelMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The details of the time when a user last read messages in a channel.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in - * the header.

- *
+ * @see {@link UpdateChannelReadMarkerCommand} */ - public updateChannelReadMarker( + updateChannelReadMarker( args: UpdateChannelReadMarkerCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateChannelReadMarker( + updateChannelReadMarker( args: UpdateChannelReadMarkerCommandInput, cb: (err: any, data?: UpdateChannelReadMarkerCommandOutput) => void ): void; - public updateChannelReadMarker( + updateChannelReadMarker( args: UpdateChannelReadMarkerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelReadMarkerCommandOutput) => void ): void; - public updateChannelReadMarker( - args: UpdateChannelReadMarkerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateChannelReadMarkerCommandOutput) => void), - cb?: (err: any, data?: UpdateChannelReadMarkerCommandOutput) => void - ): Promise | void { - const command = new UpdateChannelReadMarkerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The Amazon Chime SDK Messaging APIs in this section allow software developers to send + * and receive messages in custom messaging applications. These APIs depend on the frameworks + * provided by the Amazon Chime SDK Identity APIs. For more information about the messaging + * APIs, see Amazon Chime SDK messaging.

+ */ +export class ChimeSDKMessaging extends ChimeSDKMessagingClient implements ChimeSDKMessaging {} +createAggregatedClient(commands, ChimeSDKMessaging); diff --git a/clients/client-chime-sdk-voice/src/ChimeSDKVoice.ts b/clients/client-chime-sdk-voice/src/ChimeSDKVoice.ts index 0e64d14849d3..970e0c1fa6f2 100644 --- a/clients/client-chime-sdk-voice/src/ChimeSDKVoice.ts +++ b/clients/client-chime-sdk-voice/src/ChimeSDKVoice.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { ChimeSDKVoiceClient } from "./ChimeSDKVoiceClient"; +import { ChimeSDKVoiceClient, ChimeSDKVoiceClientConfig } from "./ChimeSDKVoiceClient"; import { AssociatePhoneNumbersWithVoiceConnectorCommand, AssociatePhoneNumbersWithVoiceConnectorCommandInput, @@ -460,3209 +461,1638 @@ import { ValidateE911AddressCommandOutput, } from "./commands/ValidateE911AddressCommand"; -/** - * @public - *

The Amazon Chime SDK telephony APIs in this section enable developers to create PSTN calling solutions that use Amazon Chime SDK Voice Connectors, and Amazon Chime SDK SIP media applications. Developers can - * also order and manage phone numbers, create and manage Voice Connectors and SIP media applications, and run voice analytics.

- */ -export class ChimeSDKVoice extends ChimeSDKVoiceClient { +const commands = { + AssociatePhoneNumbersWithVoiceConnectorCommand, + AssociatePhoneNumbersWithVoiceConnectorGroupCommand, + BatchDeletePhoneNumberCommand, + BatchUpdatePhoneNumberCommand, + CreatePhoneNumberOrderCommand, + CreateProxySessionCommand, + CreateSipMediaApplicationCommand, + CreateSipMediaApplicationCallCommand, + CreateSipRuleCommand, + CreateVoiceConnectorCommand, + CreateVoiceConnectorGroupCommand, + CreateVoiceProfileCommand, + CreateVoiceProfileDomainCommand, + DeletePhoneNumberCommand, + DeleteProxySessionCommand, + DeleteSipMediaApplicationCommand, + DeleteSipRuleCommand, + DeleteVoiceConnectorCommand, + DeleteVoiceConnectorEmergencyCallingConfigurationCommand, + DeleteVoiceConnectorGroupCommand, + DeleteVoiceConnectorOriginationCommand, + DeleteVoiceConnectorProxyCommand, + DeleteVoiceConnectorStreamingConfigurationCommand, + DeleteVoiceConnectorTerminationCommand, + DeleteVoiceConnectorTerminationCredentialsCommand, + DeleteVoiceProfileCommand, + DeleteVoiceProfileDomainCommand, + DisassociatePhoneNumbersFromVoiceConnectorCommand, + DisassociatePhoneNumbersFromVoiceConnectorGroupCommand, + GetGlobalSettingsCommand, + GetPhoneNumberCommand, + GetPhoneNumberOrderCommand, + GetPhoneNumberSettingsCommand, + GetProxySessionCommand, + GetSipMediaApplicationCommand, + GetSipMediaApplicationAlexaSkillConfigurationCommand, + GetSipMediaApplicationLoggingConfigurationCommand, + GetSipRuleCommand, + GetSpeakerSearchTaskCommand, + GetVoiceConnectorCommand, + GetVoiceConnectorEmergencyCallingConfigurationCommand, + GetVoiceConnectorGroupCommand, + GetVoiceConnectorLoggingConfigurationCommand, + GetVoiceConnectorOriginationCommand, + GetVoiceConnectorProxyCommand, + GetVoiceConnectorStreamingConfigurationCommand, + GetVoiceConnectorTerminationCommand, + GetVoiceConnectorTerminationHealthCommand, + GetVoiceProfileCommand, + GetVoiceProfileDomainCommand, + GetVoiceToneAnalysisTaskCommand, + ListAvailableVoiceConnectorRegionsCommand, + ListPhoneNumberOrdersCommand, + ListPhoneNumbersCommand, + ListProxySessionsCommand, + ListSipMediaApplicationsCommand, + ListSipRulesCommand, + ListSupportedPhoneNumberCountriesCommand, + ListTagsForResourceCommand, + ListVoiceConnectorGroupsCommand, + ListVoiceConnectorsCommand, + ListVoiceConnectorTerminationCredentialsCommand, + ListVoiceProfileDomainsCommand, + ListVoiceProfilesCommand, + PutSipMediaApplicationAlexaSkillConfigurationCommand, + PutSipMediaApplicationLoggingConfigurationCommand, + PutVoiceConnectorEmergencyCallingConfigurationCommand, + PutVoiceConnectorLoggingConfigurationCommand, + PutVoiceConnectorOriginationCommand, + PutVoiceConnectorProxyCommand, + PutVoiceConnectorStreamingConfigurationCommand, + PutVoiceConnectorTerminationCommand, + PutVoiceConnectorTerminationCredentialsCommand, + RestorePhoneNumberCommand, + SearchAvailablePhoneNumbersCommand, + StartSpeakerSearchTaskCommand, + StartVoiceToneAnalysisTaskCommand, + StopSpeakerSearchTaskCommand, + StopVoiceToneAnalysisTaskCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateGlobalSettingsCommand, + UpdatePhoneNumberCommand, + UpdatePhoneNumberSettingsCommand, + UpdateProxySessionCommand, + UpdateSipMediaApplicationCommand, + UpdateSipMediaApplicationCallCommand, + UpdateSipRuleCommand, + UpdateVoiceConnectorCommand, + UpdateVoiceConnectorGroupCommand, + UpdateVoiceProfileCommand, + UpdateVoiceProfileDomainCommand, + ValidateE911AddressCommand, +}; + +export interface ChimeSDKVoice { /** - * @public - *

Associates phone numbers with the specified Amazon Chime SDK Voice Connector.

+ * @see {@link AssociatePhoneNumbersWithVoiceConnectorCommand} */ - public associatePhoneNumbersWithVoiceConnector( + associatePhoneNumbersWithVoiceConnector( args: AssociatePhoneNumbersWithVoiceConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public associatePhoneNumbersWithVoiceConnector( + associatePhoneNumbersWithVoiceConnector( args: AssociatePhoneNumbersWithVoiceConnectorCommandInput, cb: (err: any, data?: AssociatePhoneNumbersWithVoiceConnectorCommandOutput) => void ): void; - public associatePhoneNumbersWithVoiceConnector( + associatePhoneNumbersWithVoiceConnector( args: AssociatePhoneNumbersWithVoiceConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociatePhoneNumbersWithVoiceConnectorCommandOutput) => void ): void; - public associatePhoneNumbersWithVoiceConnector( - args: AssociatePhoneNumbersWithVoiceConnectorCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AssociatePhoneNumbersWithVoiceConnectorCommandOutput) => void), - cb?: (err: any, data?: AssociatePhoneNumbersWithVoiceConnectorCommandOutput) => void - ): Promise | void { - const command = new AssociatePhoneNumbersWithVoiceConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates phone numbers with the specified Amazon Chime SDK Voice Connector group.

- */ - public associatePhoneNumbersWithVoiceConnectorGroup( + + /** + * @see {@link AssociatePhoneNumbersWithVoiceConnectorGroupCommand} + */ + associatePhoneNumbersWithVoiceConnectorGroup( args: AssociatePhoneNumbersWithVoiceConnectorGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public associatePhoneNumbersWithVoiceConnectorGroup( + associatePhoneNumbersWithVoiceConnectorGroup( args: AssociatePhoneNumbersWithVoiceConnectorGroupCommandInput, cb: (err: any, data?: AssociatePhoneNumbersWithVoiceConnectorGroupCommandOutput) => void ): void; - public associatePhoneNumbersWithVoiceConnectorGroup( + associatePhoneNumbersWithVoiceConnectorGroup( args: AssociatePhoneNumbersWithVoiceConnectorGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociatePhoneNumbersWithVoiceConnectorGroupCommandOutput) => void ): void; - public associatePhoneNumbersWithVoiceConnectorGroup( - args: AssociatePhoneNumbersWithVoiceConnectorGroupCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AssociatePhoneNumbersWithVoiceConnectorGroupCommandOutput) => void), - cb?: (err: any, data?: AssociatePhoneNumbersWithVoiceConnectorGroupCommandOutput) => void - ): Promise | void { - const command = new AssociatePhoneNumbersWithVoiceConnectorGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Moves phone numbers into the - * Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime SDK Voice Connectors before they can be deleted. - *

- *

- * Phone numbers remain in the - * Deletion queue for 7 days before they are deleted permanently. - *

- */ - public batchDeletePhoneNumber( + + /** + * @see {@link BatchDeletePhoneNumberCommand} + */ + batchDeletePhoneNumber( args: BatchDeletePhoneNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeletePhoneNumber( + batchDeletePhoneNumber( args: BatchDeletePhoneNumberCommandInput, cb: (err: any, data?: BatchDeletePhoneNumberCommandOutput) => void ): void; - public batchDeletePhoneNumber( + batchDeletePhoneNumber( args: BatchDeletePhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeletePhoneNumberCommandOutput) => void ): void; - public batchDeletePhoneNumber( - args: BatchDeletePhoneNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeletePhoneNumberCommandOutput) => void), - cb?: (err: any, data?: BatchDeletePhoneNumberCommandOutput) => void - ): Promise | void { - const command = new BatchDeletePhoneNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates one or more phone numbers.

- */ - public batchUpdatePhoneNumber( + + /** + * @see {@link BatchUpdatePhoneNumberCommand} + */ + batchUpdatePhoneNumber( args: BatchUpdatePhoneNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchUpdatePhoneNumber( + batchUpdatePhoneNumber( args: BatchUpdatePhoneNumberCommandInput, cb: (err: any, data?: BatchUpdatePhoneNumberCommandOutput) => void ): void; - public batchUpdatePhoneNumber( + batchUpdatePhoneNumber( args: BatchUpdatePhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchUpdatePhoneNumberCommandOutput) => void ): void; - public batchUpdatePhoneNumber( - args: BatchUpdatePhoneNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchUpdatePhoneNumberCommandOutput) => void), - cb?: (err: any, data?: BatchUpdatePhoneNumberCommandOutput) => void - ): Promise | void { - const command = new BatchUpdatePhoneNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an order for phone numbers to be provisioned. For numbers outside the U.S., you must use the Amazon Chime SDK SIP media application dial-in product type.

- */ - public createPhoneNumberOrder( + + /** + * @see {@link CreatePhoneNumberOrderCommand} + */ + createPhoneNumberOrder( args: CreatePhoneNumberOrderCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPhoneNumberOrder( + createPhoneNumberOrder( args: CreatePhoneNumberOrderCommandInput, cb: (err: any, data?: CreatePhoneNumberOrderCommandOutput) => void ): void; - public createPhoneNumberOrder( + createPhoneNumberOrder( args: CreatePhoneNumberOrderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePhoneNumberOrderCommandOutput) => void ): void; - public createPhoneNumberOrder( - args: CreatePhoneNumberOrderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePhoneNumberOrderCommandOutput) => void), - cb?: (err: any, data?: CreatePhoneNumberOrderCommandOutput) => void - ): Promise | void { - const command = new CreatePhoneNumberOrderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a proxy session for the specified Amazon Chime SDK Voice Connector for - * the specified participant phone numbers.

- */ - public createProxySession( + + /** + * @see {@link CreateProxySessionCommand} + */ + createProxySession( args: CreateProxySessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createProxySession( + createProxySession( args: CreateProxySessionCommandInput, cb: (err: any, data?: CreateProxySessionCommandOutput) => void ): void; - public createProxySession( + createProxySession( args: CreateProxySessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProxySessionCommandOutput) => void ): void; - public createProxySession( - args: CreateProxySessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProxySessionCommandOutput) => void), - cb?: (err: any, data?: CreateProxySessionCommandOutput) => void - ): Promise | void { - const command = new CreateProxySessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a SIP media application. For more information about SIP media applications, see Managing SIP media applications - * and rules in the Amazon Chime SDK Administrator Guide.

- */ - public createSipMediaApplication( + + /** + * @see {@link CreateSipMediaApplicationCommand} + */ + createSipMediaApplication( args: CreateSipMediaApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSipMediaApplication( + createSipMediaApplication( args: CreateSipMediaApplicationCommandInput, cb: (err: any, data?: CreateSipMediaApplicationCommandOutput) => void ): void; - public createSipMediaApplication( + createSipMediaApplication( args: CreateSipMediaApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSipMediaApplicationCommandOutput) => void ): void; - public createSipMediaApplication( - args: CreateSipMediaApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSipMediaApplicationCommandOutput) => void), - cb?: (err: any, data?: CreateSipMediaApplicationCommandOutput) => void - ): Promise | void { - const command = new CreateSipMediaApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an outbound call to a phone number from the phone number specified - * in the request, and it invokes the endpoint of the specified - * sipMediaApplicationId.

- */ - public createSipMediaApplicationCall( + + /** + * @see {@link CreateSipMediaApplicationCallCommand} + */ + createSipMediaApplicationCall( args: CreateSipMediaApplicationCallCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSipMediaApplicationCall( + createSipMediaApplicationCall( args: CreateSipMediaApplicationCallCommandInput, cb: (err: any, data?: CreateSipMediaApplicationCallCommandOutput) => void ): void; - public createSipMediaApplicationCall( + createSipMediaApplicationCall( args: CreateSipMediaApplicationCallCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSipMediaApplicationCallCommandOutput) => void ): void; - public createSipMediaApplicationCall( - args: CreateSipMediaApplicationCallCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSipMediaApplicationCallCommandOutput) => void), - cb?: (err: any, data?: CreateSipMediaApplicationCallCommandOutput) => void - ): Promise | void { - const command = new CreateSipMediaApplicationCallCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a SIP rule, which can be used to run a SIP media application as a target for a specific trigger type. For more information about SIP rules, see Managing SIP media applications - * and rules in the Amazon Chime SDK Administrator Guide.

- */ - public createSipRule( - args: CreateSipRuleCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createSipRule( - args: CreateSipRuleCommandInput, - cb: (err: any, data?: CreateSipRuleCommandOutput) => void - ): void; - public createSipRule( + + /** + * @see {@link CreateSipRuleCommand} + */ + createSipRule(args: CreateSipRuleCommandInput, options?: __HttpHandlerOptions): Promise; + createSipRule(args: CreateSipRuleCommandInput, cb: (err: any, data?: CreateSipRuleCommandOutput) => void): void; + createSipRule( args: CreateSipRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSipRuleCommandOutput) => void ): void; - public createSipRule( - args: CreateSipRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSipRuleCommandOutput) => void), - cb?: (err: any, data?: CreateSipRuleCommandOutput) => void - ): Promise | void { - const command = new CreateSipRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon Chime SDK Voice Connector. For more information about - * Voice Connectors, - * see Managing Amazon Chime SDK Voice Connector groups in the Amazon Chime SDK - * Administrator Guide.

- */ - public createVoiceConnector( + + /** + * @see {@link CreateVoiceConnectorCommand} + */ + createVoiceConnector( args: CreateVoiceConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVoiceConnector( + createVoiceConnector( args: CreateVoiceConnectorCommandInput, cb: (err: any, data?: CreateVoiceConnectorCommandOutput) => void ): void; - public createVoiceConnector( + createVoiceConnector( args: CreateVoiceConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVoiceConnectorCommandOutput) => void ): void; - public createVoiceConnector( - args: CreateVoiceConnectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVoiceConnectorCommandOutput) => void), - cb?: (err: any, data?: CreateVoiceConnectorCommandOutput) => void - ): Promise | void { - const command = new CreateVoiceConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon Chime SDK Voice Connector group under the administrator's - * AWS account. You can associate Amazon Chime SDK Voice Connectors with the - * Voice Connector group by including VoiceConnectorItems in the - * request.

- *

You can include Voice Connectors from different AWS Regions in your group. - * This creates a fault tolerant mechanism for fallback in case of availability events.

- */ - public createVoiceConnectorGroup( + + /** + * @see {@link CreateVoiceConnectorGroupCommand} + */ + createVoiceConnectorGroup( args: CreateVoiceConnectorGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVoiceConnectorGroup( + createVoiceConnectorGroup( args: CreateVoiceConnectorGroupCommandInput, cb: (err: any, data?: CreateVoiceConnectorGroupCommandOutput) => void ): void; - public createVoiceConnectorGroup( + createVoiceConnectorGroup( args: CreateVoiceConnectorGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVoiceConnectorGroupCommandOutput) => void ): void; - public createVoiceConnectorGroup( - args: CreateVoiceConnectorGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVoiceConnectorGroupCommandOutput) => void), - cb?: (err: any, data?: CreateVoiceConnectorGroupCommandOutput) => void - ): Promise | void { - const command = new CreateVoiceConnectorGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a voice profile, which consists of an enrolled user and their latest voice print.

- * - *

Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the - * AWS service terms for the Amazon Chime SDK.

- *
- *

For more information about voice profiles and voice analytics, see Using Amazon Chime SDK Voice Analytics - * in the Amazon Chime SDK Developer Guide.

- */ - public createVoiceProfile( + + /** + * @see {@link CreateVoiceProfileCommand} + */ + createVoiceProfile( args: CreateVoiceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVoiceProfile( + createVoiceProfile( args: CreateVoiceProfileCommandInput, cb: (err: any, data?: CreateVoiceProfileCommandOutput) => void ): void; - public createVoiceProfile( + createVoiceProfile( args: CreateVoiceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVoiceProfileCommandOutput) => void ): void; - public createVoiceProfile( - args: CreateVoiceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVoiceProfileCommandOutput) => void), - cb?: (err: any, data?: CreateVoiceProfileCommandOutput) => void - ): Promise | void { - const command = new CreateVoiceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio.

- * - *

Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the - * AWS service terms for the Amazon Chime SDK.

- *
- *

For more information about voice profile domains, see Using Amazon Chime SDK Voice Analytics - * in the Amazon Chime SDK Developer Guide.

- */ - public createVoiceProfileDomain( + + /** + * @see {@link CreateVoiceProfileDomainCommand} + */ + createVoiceProfileDomain( args: CreateVoiceProfileDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVoiceProfileDomain( + createVoiceProfileDomain( args: CreateVoiceProfileDomainCommandInput, cb: (err: any, data?: CreateVoiceProfileDomainCommandOutput) => void ): void; - public createVoiceProfileDomain( + createVoiceProfileDomain( args: CreateVoiceProfileDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVoiceProfileDomainCommandOutput) => void ): void; - public createVoiceProfileDomain( - args: CreateVoiceProfileDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVoiceProfileDomainCommandOutput) => void), - cb?: (err: any, data?: CreateVoiceProfileDomainCommandOutput) => void - ): Promise | void { - const command = new CreateVoiceProfileDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Moves the specified phone number into the - * Deletion queue. A phone number must - * be disassociated from any users or Amazon Chime SDK Voice Connectors before it can be - * deleted.

- *

Deleted phone numbers remain in the - * Deletion queue queue for 7 days before - * they are deleted permanently.

- */ - public deletePhoneNumber( + + /** + * @see {@link DeletePhoneNumberCommand} + */ + deletePhoneNumber( args: DeletePhoneNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePhoneNumber( + deletePhoneNumber( args: DeletePhoneNumberCommandInput, cb: (err: any, data?: DeletePhoneNumberCommandOutput) => void ): void; - public deletePhoneNumber( + deletePhoneNumber( args: DeletePhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePhoneNumberCommandOutput) => void ): void; - public deletePhoneNumber( - args: DeletePhoneNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePhoneNumberCommandOutput) => void), - cb?: (err: any, data?: DeletePhoneNumberCommandOutput) => void - ): Promise | void { - const command = new DeletePhoneNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified proxy session from the specified Amazon Chime SDK Voice - * Connector.

- */ - public deleteProxySession( + + /** + * @see {@link DeleteProxySessionCommand} + */ + deleteProxySession( args: DeleteProxySessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteProxySession( + deleteProxySession( args: DeleteProxySessionCommandInput, cb: (err: any, data?: DeleteProxySessionCommandOutput) => void ): void; - public deleteProxySession( + deleteProxySession( args: DeleteProxySessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProxySessionCommandOutput) => void ): void; - public deleteProxySession( - args: DeleteProxySessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProxySessionCommandOutput) => void), - cb?: (err: any, data?: DeleteProxySessionCommandOutput) => void - ): Promise | void { - const command = new DeleteProxySessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a SIP media application.

- */ - public deleteSipMediaApplication( + + /** + * @see {@link DeleteSipMediaApplicationCommand} + */ + deleteSipMediaApplication( args: DeleteSipMediaApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSipMediaApplication( + deleteSipMediaApplication( args: DeleteSipMediaApplicationCommandInput, cb: (err: any, data?: DeleteSipMediaApplicationCommandOutput) => void ): void; - public deleteSipMediaApplication( + deleteSipMediaApplication( args: DeleteSipMediaApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSipMediaApplicationCommandOutput) => void ): void; - public deleteSipMediaApplication( - args: DeleteSipMediaApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSipMediaApplicationCommandOutput) => void), - cb?: (err: any, data?: DeleteSipMediaApplicationCommandOutput) => void - ): Promise | void { - const command = new DeleteSipMediaApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a SIP rule.

- */ - public deleteSipRule( - args: DeleteSipRuleCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteSipRule( - args: DeleteSipRuleCommandInput, - cb: (err: any, data?: DeleteSipRuleCommandOutput) => void - ): void; - public deleteSipRule( + + /** + * @see {@link DeleteSipRuleCommand} + */ + deleteSipRule(args: DeleteSipRuleCommandInput, options?: __HttpHandlerOptions): Promise; + deleteSipRule(args: DeleteSipRuleCommandInput, cb: (err: any, data?: DeleteSipRuleCommandOutput) => void): void; + deleteSipRule( args: DeleteSipRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSipRuleCommandOutput) => void ): void; - public deleteSipRule( - args: DeleteSipRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSipRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteSipRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteSipRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an Amazon Chime SDK Voice Connector. Any phone numbers associated - * with the Amazon Chime SDK Voice Connector must be disassociated from it before it - * can be deleted.

- */ - public deleteVoiceConnector( + + /** + * @see {@link DeleteVoiceConnectorCommand} + */ + deleteVoiceConnector( args: DeleteVoiceConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVoiceConnector( + deleteVoiceConnector( args: DeleteVoiceConnectorCommandInput, cb: (err: any, data?: DeleteVoiceConnectorCommandOutput) => void ): void; - public deleteVoiceConnector( + deleteVoiceConnector( args: DeleteVoiceConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVoiceConnectorCommandOutput) => void ): void; - public deleteVoiceConnector( - args: DeleteVoiceConnectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVoiceConnectorCommandOutput) => void), - cb?: (err: any, data?: DeleteVoiceConnectorCommandOutput) => void - ): Promise | void { - const command = new DeleteVoiceConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the emergency calling details from the specified Amazon Chime SDK Voice - * Connector.

- */ - public deleteVoiceConnectorEmergencyCallingConfiguration( + + /** + * @see {@link DeleteVoiceConnectorEmergencyCallingConfigurationCommand} + */ + deleteVoiceConnectorEmergencyCallingConfiguration( args: DeleteVoiceConnectorEmergencyCallingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVoiceConnectorEmergencyCallingConfiguration( + deleteVoiceConnectorEmergencyCallingConfiguration( args: DeleteVoiceConnectorEmergencyCallingConfigurationCommandInput, cb: (err: any, data?: DeleteVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void ): void; - public deleteVoiceConnectorEmergencyCallingConfiguration( + deleteVoiceConnectorEmergencyCallingConfiguration( args: DeleteVoiceConnectorEmergencyCallingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void ): void; - public deleteVoiceConnectorEmergencyCallingConfiguration( - args: DeleteVoiceConnectorEmergencyCallingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteVoiceConnectorEmergencyCallingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an Amazon Chime SDK Voice Connector group. Any VoiceConnectorItems - * and phone numbers associated with the group must be removed before it can be - * deleted.

- */ - public deleteVoiceConnectorGroup( + + /** + * @see {@link DeleteVoiceConnectorGroupCommand} + */ + deleteVoiceConnectorGroup( args: DeleteVoiceConnectorGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVoiceConnectorGroup( + deleteVoiceConnectorGroup( args: DeleteVoiceConnectorGroupCommandInput, cb: (err: any, data?: DeleteVoiceConnectorGroupCommandOutput) => void ): void; - public deleteVoiceConnectorGroup( + deleteVoiceConnectorGroup( args: DeleteVoiceConnectorGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVoiceConnectorGroupCommandOutput) => void ): void; - public deleteVoiceConnectorGroup( - args: DeleteVoiceConnectorGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVoiceConnectorGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteVoiceConnectorGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteVoiceConnectorGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the origination settings for the specified Amazon Chime SDK Voice Connector.

- * - *

If emergency calling is configured for the Voice Connector, it must be - * deleted prior to deleting the origination settings.

- *
- */ - public deleteVoiceConnectorOrigination( + + /** + * @see {@link DeleteVoiceConnectorOriginationCommand} + */ + deleteVoiceConnectorOrigination( args: DeleteVoiceConnectorOriginationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVoiceConnectorOrigination( + deleteVoiceConnectorOrigination( args: DeleteVoiceConnectorOriginationCommandInput, cb: (err: any, data?: DeleteVoiceConnectorOriginationCommandOutput) => void ): void; - public deleteVoiceConnectorOrigination( + deleteVoiceConnectorOrigination( args: DeleteVoiceConnectorOriginationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVoiceConnectorOriginationCommandOutput) => void ): void; - public deleteVoiceConnectorOrigination( - args: DeleteVoiceConnectorOriginationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVoiceConnectorOriginationCommandOutput) => void), - cb?: (err: any, data?: DeleteVoiceConnectorOriginationCommandOutput) => void - ): Promise | void { - const command = new DeleteVoiceConnectorOriginationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector.

- */ - public deleteVoiceConnectorProxy( + + /** + * @see {@link DeleteVoiceConnectorProxyCommand} + */ + deleteVoiceConnectorProxy( args: DeleteVoiceConnectorProxyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVoiceConnectorProxy( + deleteVoiceConnectorProxy( args: DeleteVoiceConnectorProxyCommandInput, cb: (err: any, data?: DeleteVoiceConnectorProxyCommandOutput) => void ): void; - public deleteVoiceConnectorProxy( + deleteVoiceConnectorProxy( args: DeleteVoiceConnectorProxyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVoiceConnectorProxyCommandOutput) => void ): void; - public deleteVoiceConnectorProxy( - args: DeleteVoiceConnectorProxyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVoiceConnectorProxyCommandOutput) => void), - cb?: (err: any, data?: DeleteVoiceConnectorProxyCommandOutput) => void - ): Promise | void { - const command = new DeleteVoiceConnectorProxyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a Voice Connector's streaming configuration.

- */ - public deleteVoiceConnectorStreamingConfiguration( + + /** + * @see {@link DeleteVoiceConnectorStreamingConfigurationCommand} + */ + deleteVoiceConnectorStreamingConfiguration( args: DeleteVoiceConnectorStreamingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVoiceConnectorStreamingConfiguration( + deleteVoiceConnectorStreamingConfiguration( args: DeleteVoiceConnectorStreamingConfigurationCommandInput, cb: (err: any, data?: DeleteVoiceConnectorStreamingConfigurationCommandOutput) => void ): void; - public deleteVoiceConnectorStreamingConfiguration( + deleteVoiceConnectorStreamingConfiguration( args: DeleteVoiceConnectorStreamingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVoiceConnectorStreamingConfigurationCommandOutput) => void ): void; - public deleteVoiceConnectorStreamingConfiguration( - args: DeleteVoiceConnectorStreamingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteVoiceConnectorStreamingConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteVoiceConnectorStreamingConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteVoiceConnectorStreamingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the termination settings for the specified Amazon Chime SDK Voice Connector.

- * - *

If emergency calling is configured for the Voice Connector, it must be - * deleted prior to deleting the termination settings.

- *
- */ - public deleteVoiceConnectorTermination( + + /** + * @see {@link DeleteVoiceConnectorTerminationCommand} + */ + deleteVoiceConnectorTermination( args: DeleteVoiceConnectorTerminationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVoiceConnectorTermination( + deleteVoiceConnectorTermination( args: DeleteVoiceConnectorTerminationCommandInput, cb: (err: any, data?: DeleteVoiceConnectorTerminationCommandOutput) => void ): void; - public deleteVoiceConnectorTermination( + deleteVoiceConnectorTermination( args: DeleteVoiceConnectorTerminationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVoiceConnectorTerminationCommandOutput) => void ): void; - public deleteVoiceConnectorTermination( - args: DeleteVoiceConnectorTerminationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVoiceConnectorTerminationCommandOutput) => void), - cb?: (err: any, data?: DeleteVoiceConnectorTerminationCommandOutput) => void - ): Promise | void { - const command = new DeleteVoiceConnectorTerminationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified SIP credentials used by your equipment to - * authenticate during call termination.

- */ - public deleteVoiceConnectorTerminationCredentials( + + /** + * @see {@link DeleteVoiceConnectorTerminationCredentialsCommand} + */ + deleteVoiceConnectorTerminationCredentials( args: DeleteVoiceConnectorTerminationCredentialsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVoiceConnectorTerminationCredentials( + deleteVoiceConnectorTerminationCredentials( args: DeleteVoiceConnectorTerminationCredentialsCommandInput, cb: (err: any, data?: DeleteVoiceConnectorTerminationCredentialsCommandOutput) => void ): void; - public deleteVoiceConnectorTerminationCredentials( + deleteVoiceConnectorTerminationCredentials( args: DeleteVoiceConnectorTerminationCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVoiceConnectorTerminationCredentialsCommandOutput) => void ): void; - public deleteVoiceConnectorTerminationCredentials( - args: DeleteVoiceConnectorTerminationCredentialsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteVoiceConnectorTerminationCredentialsCommandOutput) => void), - cb?: (err: any, data?: DeleteVoiceConnectorTerminationCredentialsCommandOutput) => void - ): Promise | void { - const command = new DeleteVoiceConnectorTerminationCredentialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a voice profile, including its voice print and enrollment data. WARNING: This action is not reversible.

- */ - public deleteVoiceProfile( + + /** + * @see {@link DeleteVoiceProfileCommand} + */ + deleteVoiceProfile( args: DeleteVoiceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVoiceProfile( + deleteVoiceProfile( args: DeleteVoiceProfileCommandInput, cb: (err: any, data?: DeleteVoiceProfileCommandOutput) => void ): void; - public deleteVoiceProfile( + deleteVoiceProfile( args: DeleteVoiceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVoiceProfileCommandOutput) => void ): void; - public deleteVoiceProfile( - args: DeleteVoiceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVoiceProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteVoiceProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteVoiceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes all voice profiles in the domain. WARNING: This action is not reversible.

- */ - public deleteVoiceProfileDomain( + + /** + * @see {@link DeleteVoiceProfileDomainCommand} + */ + deleteVoiceProfileDomain( args: DeleteVoiceProfileDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVoiceProfileDomain( + deleteVoiceProfileDomain( args: DeleteVoiceProfileDomainCommandInput, cb: (err: any, data?: DeleteVoiceProfileDomainCommandOutput) => void ): void; - public deleteVoiceProfileDomain( + deleteVoiceProfileDomain( args: DeleteVoiceProfileDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVoiceProfileDomainCommandOutput) => void ): void; - public deleteVoiceProfileDomain( - args: DeleteVoiceProfileDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVoiceProfileDomainCommandOutput) => void), - cb?: (err: any, data?: DeleteVoiceProfileDomainCommandOutput) => void - ): Promise | void { - const command = new DeleteVoiceProfileDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates the specified phone numbers from the specified - * Amazon Chime SDK Voice Connector.

- */ - public disassociatePhoneNumbersFromVoiceConnector( + + /** + * @see {@link DisassociatePhoneNumbersFromVoiceConnectorCommand} + */ + disassociatePhoneNumbersFromVoiceConnector( args: DisassociatePhoneNumbersFromVoiceConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociatePhoneNumbersFromVoiceConnector( + disassociatePhoneNumbersFromVoiceConnector( args: DisassociatePhoneNumbersFromVoiceConnectorCommandInput, cb: (err: any, data?: DisassociatePhoneNumbersFromVoiceConnectorCommandOutput) => void ): void; - public disassociatePhoneNumbersFromVoiceConnector( + disassociatePhoneNumbersFromVoiceConnector( args: DisassociatePhoneNumbersFromVoiceConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociatePhoneNumbersFromVoiceConnectorCommandOutput) => void ): void; - public disassociatePhoneNumbersFromVoiceConnector( - args: DisassociatePhoneNumbersFromVoiceConnectorCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociatePhoneNumbersFromVoiceConnectorCommandOutput) => void), - cb?: (err: any, data?: DisassociatePhoneNumbersFromVoiceConnectorCommandOutput) => void - ): Promise | void { - const command = new DisassociatePhoneNumbersFromVoiceConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice - * Connector group.

- */ - public disassociatePhoneNumbersFromVoiceConnectorGroup( + + /** + * @see {@link DisassociatePhoneNumbersFromVoiceConnectorGroupCommand} + */ + disassociatePhoneNumbersFromVoiceConnectorGroup( args: DisassociatePhoneNumbersFromVoiceConnectorGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociatePhoneNumbersFromVoiceConnectorGroup( + disassociatePhoneNumbersFromVoiceConnectorGroup( args: DisassociatePhoneNumbersFromVoiceConnectorGroupCommandInput, cb: (err: any, data?: DisassociatePhoneNumbersFromVoiceConnectorGroupCommandOutput) => void ): void; - public disassociatePhoneNumbersFromVoiceConnectorGroup( + disassociatePhoneNumbersFromVoiceConnectorGroup( args: DisassociatePhoneNumbersFromVoiceConnectorGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociatePhoneNumbersFromVoiceConnectorGroupCommandOutput) => void ): void; - public disassociatePhoneNumbersFromVoiceConnectorGroup( - args: DisassociatePhoneNumbersFromVoiceConnectorGroupCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociatePhoneNumbersFromVoiceConnectorGroupCommandOutput) => void), - cb?: (err: any, data?: DisassociatePhoneNumbersFromVoiceConnectorGroupCommandOutput) => void - ): Promise | void { - const command = new DisassociatePhoneNumbersFromVoiceConnectorGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

- */ - public getGlobalSettings( + + /** + * @see {@link GetGlobalSettingsCommand} + */ + getGlobalSettings( args: GetGlobalSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getGlobalSettings( + getGlobalSettings( args: GetGlobalSettingsCommandInput, cb: (err: any, data?: GetGlobalSettingsCommandOutput) => void ): void; - public getGlobalSettings( + getGlobalSettings( args: GetGlobalSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGlobalSettingsCommandOutput) => void ): void; - public getGlobalSettings( - args: GetGlobalSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGlobalSettingsCommandOutput) => void), - cb?: (err: any, data?: GetGlobalSettingsCommandOutput) => void - ): Promise | void { - const command = new GetGlobalSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves details for the specified phone number ID, such as associations, - * capabilities, and product type.

- */ - public getPhoneNumber( + + /** + * @see {@link GetPhoneNumberCommand} + */ + getPhoneNumber( args: GetPhoneNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPhoneNumber( - args: GetPhoneNumberCommandInput, - cb: (err: any, data?: GetPhoneNumberCommandOutput) => void - ): void; - public getPhoneNumber( + getPhoneNumber(args: GetPhoneNumberCommandInput, cb: (err: any, data?: GetPhoneNumberCommandOutput) => void): void; + getPhoneNumber( args: GetPhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPhoneNumberCommandOutput) => void ): void; - public getPhoneNumber( - args: GetPhoneNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPhoneNumberCommandOutput) => void), - cb?: (err: any, data?: GetPhoneNumberCommandOutput) => void - ): Promise | void { - const command = new GetPhoneNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves details for the specified phone number order, such as the order - * creation timestamp, phone numbers in E.164 format, product type, and - * order status.

- */ - public getPhoneNumberOrder( + + /** + * @see {@link GetPhoneNumberOrderCommand} + */ + getPhoneNumberOrder( args: GetPhoneNumberOrderCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPhoneNumberOrder( + getPhoneNumberOrder( args: GetPhoneNumberOrderCommandInput, cb: (err: any, data?: GetPhoneNumberOrderCommandOutput) => void ): void; - public getPhoneNumberOrder( + getPhoneNumberOrder( args: GetPhoneNumberOrderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPhoneNumberOrderCommandOutput) => void ): void; - public getPhoneNumberOrder( - args: GetPhoneNumberOrderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPhoneNumberOrderCommandOutput) => void), - cb?: (err: any, data?: GetPhoneNumberOrderCommandOutput) => void - ): Promise | void { - const command = new GetPhoneNumberOrderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the phone number settings for the administrator's AWS account, - * such as the default outbound calling name.

- */ - public getPhoneNumberSettings( + + /** + * @see {@link GetPhoneNumberSettingsCommand} + */ + getPhoneNumberSettings( args: GetPhoneNumberSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPhoneNumberSettings( + getPhoneNumberSettings( args: GetPhoneNumberSettingsCommandInput, cb: (err: any, data?: GetPhoneNumberSettingsCommandOutput) => void ): void; - public getPhoneNumberSettings( + getPhoneNumberSettings( args: GetPhoneNumberSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPhoneNumberSettingsCommandOutput) => void ): void; - public getPhoneNumberSettings( - args: GetPhoneNumberSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPhoneNumberSettingsCommandOutput) => void), - cb?: (err: any, data?: GetPhoneNumberSettingsCommandOutput) => void - ): Promise | void { - const command = new GetPhoneNumberSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector.

- */ - public getProxySession( + + /** + * @see {@link GetProxySessionCommand} + */ + getProxySession( args: GetProxySessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getProxySession( - args: GetProxySessionCommandInput, - cb: (err: any, data?: GetProxySessionCommandOutput) => void - ): void; - public getProxySession( + getProxySession(args: GetProxySessionCommandInput, cb: (err: any, data?: GetProxySessionCommandOutput) => void): void; + getProxySession( args: GetProxySessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProxySessionCommandOutput) => void ): void; - public getProxySession( - args: GetProxySessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetProxySessionCommandOutput) => void), - cb?: (err: any, data?: GetProxySessionCommandOutput) => void - ): Promise | void { - const command = new GetProxySessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the information for a SIP media application, including name, - * AWS Region, and endpoints.

- */ - public getSipMediaApplication( + + /** + * @see {@link GetSipMediaApplicationCommand} + */ + getSipMediaApplication( args: GetSipMediaApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSipMediaApplication( + getSipMediaApplication( args: GetSipMediaApplicationCommandInput, cb: (err: any, data?: GetSipMediaApplicationCommandOutput) => void ): void; - public getSipMediaApplication( + getSipMediaApplication( args: GetSipMediaApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSipMediaApplicationCommandOutput) => void ): void; - public getSipMediaApplication( - args: GetSipMediaApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSipMediaApplicationCommandOutput) => void), - cb?: (err: any, data?: GetSipMediaApplicationCommandOutput) => void - ): Promise | void { - const command = new GetSipMediaApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the Alexa Skill configuration for the SIP media application.

- */ - public getSipMediaApplicationAlexaSkillConfiguration( + + /** + * @see {@link GetSipMediaApplicationAlexaSkillConfigurationCommand} + */ + getSipMediaApplicationAlexaSkillConfiguration( args: GetSipMediaApplicationAlexaSkillConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSipMediaApplicationAlexaSkillConfiguration( + getSipMediaApplicationAlexaSkillConfiguration( args: GetSipMediaApplicationAlexaSkillConfigurationCommandInput, cb: (err: any, data?: GetSipMediaApplicationAlexaSkillConfigurationCommandOutput) => void ): void; - public getSipMediaApplicationAlexaSkillConfiguration( + getSipMediaApplicationAlexaSkillConfiguration( args: GetSipMediaApplicationAlexaSkillConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSipMediaApplicationAlexaSkillConfigurationCommandOutput) => void ): void; - public getSipMediaApplicationAlexaSkillConfiguration( - args: GetSipMediaApplicationAlexaSkillConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetSipMediaApplicationAlexaSkillConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetSipMediaApplicationAlexaSkillConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetSipMediaApplicationAlexaSkillConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the logging configuration for the specified SIP media application.

- */ - public getSipMediaApplicationLoggingConfiguration( + + /** + * @see {@link GetSipMediaApplicationLoggingConfigurationCommand} + */ + getSipMediaApplicationLoggingConfiguration( args: GetSipMediaApplicationLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSipMediaApplicationLoggingConfiguration( + getSipMediaApplicationLoggingConfiguration( args: GetSipMediaApplicationLoggingConfigurationCommandInput, cb: (err: any, data?: GetSipMediaApplicationLoggingConfigurationCommandOutput) => void ): void; - public getSipMediaApplicationLoggingConfiguration( + getSipMediaApplicationLoggingConfiguration( args: GetSipMediaApplicationLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSipMediaApplicationLoggingConfigurationCommandOutput) => void ): void; - public getSipMediaApplicationLoggingConfiguration( - args: GetSipMediaApplicationLoggingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetSipMediaApplicationLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetSipMediaApplicationLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetSipMediaApplicationLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and - * target endpoints.

- */ - public getSipRule(args: GetSipRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public getSipRule(args: GetSipRuleCommandInput, cb: (err: any, data?: GetSipRuleCommandOutput) => void): void; - public getSipRule( + + /** + * @see {@link GetSipRuleCommand} + */ + getSipRule(args: GetSipRuleCommandInput, options?: __HttpHandlerOptions): Promise; + getSipRule(args: GetSipRuleCommandInput, cb: (err: any, data?: GetSipRuleCommandOutput) => void): void; + getSipRule( args: GetSipRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSipRuleCommandOutput) => void ): void; - public getSipRule( - args: GetSipRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSipRuleCommandOutput) => void), - cb?: (err: any, data?: GetSipRuleCommandOutput) => void - ): Promise | void { - const command = new GetSipRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the details of the specified speaker search task.

- */ - public getSpeakerSearchTask( + + /** + * @see {@link GetSpeakerSearchTaskCommand} + */ + getSpeakerSearchTask( args: GetSpeakerSearchTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSpeakerSearchTask( + getSpeakerSearchTask( args: GetSpeakerSearchTaskCommandInput, cb: (err: any, data?: GetSpeakerSearchTaskCommandOutput) => void ): void; - public getSpeakerSearchTask( + getSpeakerSearchTask( args: GetSpeakerSearchTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSpeakerSearchTaskCommandOutput) => void ): void; - public getSpeakerSearchTask( - args: GetSpeakerSearchTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSpeakerSearchTaskCommandOutput) => void), - cb?: (err: any, data?: GetSpeakerSearchTaskCommandOutput) => void - ): Promise | void { - const command = new GetSpeakerSearchTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves details for the specified Amazon Chime SDK Voice Connector, such as - * timestamps,name, outbound host, and encryption requirements.

- */ - public getVoiceConnector( + + /** + * @see {@link GetVoiceConnectorCommand} + */ + getVoiceConnector( args: GetVoiceConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVoiceConnector( + getVoiceConnector( args: GetVoiceConnectorCommandInput, cb: (err: any, data?: GetVoiceConnectorCommandOutput) => void ): void; - public getVoiceConnector( + getVoiceConnector( args: GetVoiceConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceConnectorCommandOutput) => void ): void; - public getVoiceConnector( - args: GetVoiceConnectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVoiceConnectorCommandOutput) => void), - cb?: (err: any, data?: GetVoiceConnectorCommandOutput) => void - ): Promise | void { - const command = new GetVoiceConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the emergency calling configuration details for the specified Voice Connector.

- */ - public getVoiceConnectorEmergencyCallingConfiguration( + + /** + * @see {@link GetVoiceConnectorEmergencyCallingConfigurationCommand} + */ + getVoiceConnectorEmergencyCallingConfiguration( args: GetVoiceConnectorEmergencyCallingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVoiceConnectorEmergencyCallingConfiguration( + getVoiceConnectorEmergencyCallingConfiguration( args: GetVoiceConnectorEmergencyCallingConfigurationCommandInput, cb: (err: any, data?: GetVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void ): void; - public getVoiceConnectorEmergencyCallingConfiguration( + getVoiceConnectorEmergencyCallingConfiguration( args: GetVoiceConnectorEmergencyCallingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void ): void; - public getVoiceConnectorEmergencyCallingConfiguration( - args: GetVoiceConnectorEmergencyCallingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetVoiceConnectorEmergencyCallingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves details for the specified Amazon Chime SDK Voice Connector group, - * such as timestamps,name, and associated VoiceConnectorItems.

- */ - public getVoiceConnectorGroup( + + /** + * @see {@link GetVoiceConnectorGroupCommand} + */ + getVoiceConnectorGroup( args: GetVoiceConnectorGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVoiceConnectorGroup( + getVoiceConnectorGroup( args: GetVoiceConnectorGroupCommandInput, cb: (err: any, data?: GetVoiceConnectorGroupCommandOutput) => void ): void; - public getVoiceConnectorGroup( + getVoiceConnectorGroup( args: GetVoiceConnectorGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceConnectorGroupCommandOutput) => void ): void; - public getVoiceConnectorGroup( - args: GetVoiceConnectorGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVoiceConnectorGroupCommandOutput) => void), - cb?: (err: any, data?: GetVoiceConnectorGroupCommandOutput) => void - ): Promise | void { - const command = new GetVoiceConnectorGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the logging configuration settings for the specified Voice Connector. - * Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

- */ - public getVoiceConnectorLoggingConfiguration( + + /** + * @see {@link GetVoiceConnectorLoggingConfigurationCommand} + */ + getVoiceConnectorLoggingConfiguration( args: GetVoiceConnectorLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVoiceConnectorLoggingConfiguration( + getVoiceConnectorLoggingConfiguration( args: GetVoiceConnectorLoggingConfigurationCommandInput, cb: (err: any, data?: GetVoiceConnectorLoggingConfigurationCommandOutput) => void ): void; - public getVoiceConnectorLoggingConfiguration( + getVoiceConnectorLoggingConfiguration( args: GetVoiceConnectorLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceConnectorLoggingConfigurationCommandOutput) => void ): void; - public getVoiceConnectorLoggingConfiguration( - args: GetVoiceConnectorLoggingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetVoiceConnectorLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetVoiceConnectorLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetVoiceConnectorLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the origination settings for the specified Voice Connector.

- */ - public getVoiceConnectorOrigination( + + /** + * @see {@link GetVoiceConnectorOriginationCommand} + */ + getVoiceConnectorOrigination( args: GetVoiceConnectorOriginationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVoiceConnectorOrigination( + getVoiceConnectorOrigination( args: GetVoiceConnectorOriginationCommandInput, cb: (err: any, data?: GetVoiceConnectorOriginationCommandOutput) => void ): void; - public getVoiceConnectorOrigination( + getVoiceConnectorOrigination( args: GetVoiceConnectorOriginationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceConnectorOriginationCommandOutput) => void ): void; - public getVoiceConnectorOrigination( - args: GetVoiceConnectorOriginationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVoiceConnectorOriginationCommandOutput) => void), - cb?: (err: any, data?: GetVoiceConnectorOriginationCommandOutput) => void - ): Promise | void { - const command = new GetVoiceConnectorOriginationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice - * Connector.

- */ - public getVoiceConnectorProxy( + + /** + * @see {@link GetVoiceConnectorProxyCommand} + */ + getVoiceConnectorProxy( args: GetVoiceConnectorProxyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVoiceConnectorProxy( + getVoiceConnectorProxy( args: GetVoiceConnectorProxyCommandInput, cb: (err: any, data?: GetVoiceConnectorProxyCommandOutput) => void ): void; - public getVoiceConnectorProxy( + getVoiceConnectorProxy( args: GetVoiceConnectorProxyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceConnectorProxyCommandOutput) => void ): void; - public getVoiceConnectorProxy( - args: GetVoiceConnectorProxyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVoiceConnectorProxyCommandOutput) => void), - cb?: (err: any, data?: GetVoiceConnectorProxyCommandOutput) => void - ): Promise | void { - const command = new GetVoiceConnectorProxyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the streaming configuration details for the specified Amazon Chime SDK - * Voice Connector. Shows whether media streaming is enabled for sending to Amazon - * Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

- */ - public getVoiceConnectorStreamingConfiguration( + + /** + * @see {@link GetVoiceConnectorStreamingConfigurationCommand} + */ + getVoiceConnectorStreamingConfiguration( args: GetVoiceConnectorStreamingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVoiceConnectorStreamingConfiguration( + getVoiceConnectorStreamingConfiguration( args: GetVoiceConnectorStreamingConfigurationCommandInput, cb: (err: any, data?: GetVoiceConnectorStreamingConfigurationCommandOutput) => void ): void; - public getVoiceConnectorStreamingConfiguration( + getVoiceConnectorStreamingConfiguration( args: GetVoiceConnectorStreamingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceConnectorStreamingConfigurationCommandOutput) => void ): void; - public getVoiceConnectorStreamingConfiguration( - args: GetVoiceConnectorStreamingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetVoiceConnectorStreamingConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetVoiceConnectorStreamingConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetVoiceConnectorStreamingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the termination setting details for the specified Voice Connector.

- */ - public getVoiceConnectorTermination( + + /** + * @see {@link GetVoiceConnectorTerminationCommand} + */ + getVoiceConnectorTermination( args: GetVoiceConnectorTerminationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVoiceConnectorTermination( + getVoiceConnectorTermination( args: GetVoiceConnectorTerminationCommandInput, cb: (err: any, data?: GetVoiceConnectorTerminationCommandOutput) => void ): void; - public getVoiceConnectorTermination( + getVoiceConnectorTermination( args: GetVoiceConnectorTerminationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceConnectorTerminationCommandOutput) => void ): void; - public getVoiceConnectorTermination( - args: GetVoiceConnectorTerminationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVoiceConnectorTerminationCommandOutput) => void), - cb?: (err: any, data?: GetVoiceConnectorTerminationCommandOutput) => void - ): Promise | void { - const command = new GetVoiceConnectorTerminationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about the last time a SIP OPTIONS ping - * was received from your SIP infrastructure for the specified Amazon Chime SDK Voice - * Connector.

- */ - public getVoiceConnectorTerminationHealth( + + /** + * @see {@link GetVoiceConnectorTerminationHealthCommand} + */ + getVoiceConnectorTerminationHealth( args: GetVoiceConnectorTerminationHealthCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVoiceConnectorTerminationHealth( + getVoiceConnectorTerminationHealth( args: GetVoiceConnectorTerminationHealthCommandInput, cb: (err: any, data?: GetVoiceConnectorTerminationHealthCommandOutput) => void ): void; - public getVoiceConnectorTerminationHealth( + getVoiceConnectorTerminationHealth( args: GetVoiceConnectorTerminationHealthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceConnectorTerminationHealthCommandOutput) => void ): void; - public getVoiceConnectorTerminationHealth( - args: GetVoiceConnectorTerminationHealthCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVoiceConnectorTerminationHealthCommandOutput) => void), - cb?: (err: any, data?: GetVoiceConnectorTerminationHealthCommandOutput) => void - ): Promise | void { - const command = new GetVoiceConnectorTerminationHealthCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the details of the specified voice profile.

- */ - public getVoiceProfile( + + /** + * @see {@link GetVoiceProfileCommand} + */ + getVoiceProfile( args: GetVoiceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVoiceProfile( - args: GetVoiceProfileCommandInput, - cb: (err: any, data?: GetVoiceProfileCommandOutput) => void - ): void; - public getVoiceProfile( + getVoiceProfile(args: GetVoiceProfileCommandInput, cb: (err: any, data?: GetVoiceProfileCommandOutput) => void): void; + getVoiceProfile( args: GetVoiceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceProfileCommandOutput) => void ): void; - public getVoiceProfile( - args: GetVoiceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVoiceProfileCommandOutput) => void), - cb?: (err: any, data?: GetVoiceProfileCommandOutput) => void - ): Promise | void { - const command = new GetVoiceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the details of the specified voice profile domain.

- */ - public getVoiceProfileDomain( + + /** + * @see {@link GetVoiceProfileDomainCommand} + */ + getVoiceProfileDomain( args: GetVoiceProfileDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVoiceProfileDomain( + getVoiceProfileDomain( args: GetVoiceProfileDomainCommandInput, cb: (err: any, data?: GetVoiceProfileDomainCommandOutput) => void ): void; - public getVoiceProfileDomain( + getVoiceProfileDomain( args: GetVoiceProfileDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceProfileDomainCommandOutput) => void ): void; - public getVoiceProfileDomain( - args: GetVoiceProfileDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVoiceProfileDomainCommandOutput) => void), - cb?: (err: any, data?: GetVoiceProfileDomainCommandOutput) => void - ): Promise | void { - const command = new GetVoiceProfileDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the details of a voice tone analysis task.

- */ - public getVoiceToneAnalysisTask( + + /** + * @see {@link GetVoiceToneAnalysisTaskCommand} + */ + getVoiceToneAnalysisTask( args: GetVoiceToneAnalysisTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVoiceToneAnalysisTask( + getVoiceToneAnalysisTask( args: GetVoiceToneAnalysisTaskCommandInput, cb: (err: any, data?: GetVoiceToneAnalysisTaskCommandOutput) => void ): void; - public getVoiceToneAnalysisTask( + getVoiceToneAnalysisTask( args: GetVoiceToneAnalysisTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceToneAnalysisTaskCommandOutput) => void ): void; - public getVoiceToneAnalysisTask( - args: GetVoiceToneAnalysisTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVoiceToneAnalysisTaskCommandOutput) => void), - cb?: (err: any, data?: GetVoiceToneAnalysisTaskCommandOutput) => void - ): Promise | void { - const command = new GetVoiceToneAnalysisTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector.

- */ - public listAvailableVoiceConnectorRegions( + + /** + * @see {@link ListAvailableVoiceConnectorRegionsCommand} + */ + listAvailableVoiceConnectorRegions( args: ListAvailableVoiceConnectorRegionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAvailableVoiceConnectorRegions( + listAvailableVoiceConnectorRegions( args: ListAvailableVoiceConnectorRegionsCommandInput, cb: (err: any, data?: ListAvailableVoiceConnectorRegionsCommandOutput) => void ): void; - public listAvailableVoiceConnectorRegions( + listAvailableVoiceConnectorRegions( args: ListAvailableVoiceConnectorRegionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAvailableVoiceConnectorRegionsCommandOutput) => void ): void; - public listAvailableVoiceConnectorRegions( - args: ListAvailableVoiceConnectorRegionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAvailableVoiceConnectorRegionsCommandOutput) => void), - cb?: (err: any, data?: ListAvailableVoiceConnectorRegionsCommandOutput) => void - ): Promise | void { - const command = new ListAvailableVoiceConnectorRegionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the phone numbers for an administrator's Amazon Chime SDK account.

- */ - public listPhoneNumberOrders( + + /** + * @see {@link ListPhoneNumberOrdersCommand} + */ + listPhoneNumberOrders( args: ListPhoneNumberOrdersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPhoneNumberOrders( + listPhoneNumberOrders( args: ListPhoneNumberOrdersCommandInput, cb: (err: any, data?: ListPhoneNumberOrdersCommandOutput) => void ): void; - public listPhoneNumberOrders( + listPhoneNumberOrders( args: ListPhoneNumberOrdersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPhoneNumberOrdersCommandOutput) => void ): void; - public listPhoneNumberOrders( - args: ListPhoneNumberOrdersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPhoneNumberOrdersCommandOutput) => void), - cb?: (err: any, data?: ListPhoneNumberOrdersCommandOutput) => void - ): Promise | void { - const command = new ListPhoneNumberOrdersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the phone numbers for the specified Amazon Chime SDK account, - * Amazon Chime SDK user, Amazon Chime SDK Voice Connector, or Amazon Chime SDK Voice - * Connector group.

- */ - public listPhoneNumbers( + + /** + * @see {@link ListPhoneNumbersCommand} + */ + listPhoneNumbers( args: ListPhoneNumbersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPhoneNumbers( + listPhoneNumbers( args: ListPhoneNumbersCommandInput, cb: (err: any, data?: ListPhoneNumbersCommandOutput) => void ): void; - public listPhoneNumbers( + listPhoneNumbers( args: ListPhoneNumbersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPhoneNumbersCommandOutput) => void ): void; - public listPhoneNumbers( - args: ListPhoneNumbersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPhoneNumbersCommandOutput) => void), - cb?: (err: any, data?: ListPhoneNumbersCommandOutput) => void - ): Promise | void { - const command = new ListPhoneNumbersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector.

- */ - public listProxySessions( + + /** + * @see {@link ListProxySessionsCommand} + */ + listProxySessions( args: ListProxySessionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProxySessions( + listProxySessions( args: ListProxySessionsCommandInput, cb: (err: any, data?: ListProxySessionsCommandOutput) => void ): void; - public listProxySessions( + listProxySessions( args: ListProxySessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProxySessionsCommandOutput) => void ): void; - public listProxySessions( - args: ListProxySessionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProxySessionsCommandOutput) => void), - cb?: (err: any, data?: ListProxySessionsCommandOutput) => void - ): Promise | void { - const command = new ListProxySessionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the SIP media applications under the administrator's AWS account.

- */ - public listSipMediaApplications( + + /** + * @see {@link ListSipMediaApplicationsCommand} + */ + listSipMediaApplications( args: ListSipMediaApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSipMediaApplications( + listSipMediaApplications( args: ListSipMediaApplicationsCommandInput, cb: (err: any, data?: ListSipMediaApplicationsCommandOutput) => void ): void; - public listSipMediaApplications( + listSipMediaApplications( args: ListSipMediaApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSipMediaApplicationsCommandOutput) => void ): void; - public listSipMediaApplications( - args: ListSipMediaApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSipMediaApplicationsCommandOutput) => void), - cb?: (err: any, data?: ListSipMediaApplicationsCommandOutput) => void - ): Promise | void { - const command = new ListSipMediaApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the SIP rules under the administrator's AWS account.

- */ - public listSipRules( - args: ListSipRulesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listSipRules(args: ListSipRulesCommandInput, cb: (err: any, data?: ListSipRulesCommandOutput) => void): void; - public listSipRules( + + /** + * @see {@link ListSipRulesCommand} + */ + listSipRules(args: ListSipRulesCommandInput, options?: __HttpHandlerOptions): Promise; + listSipRules(args: ListSipRulesCommandInput, cb: (err: any, data?: ListSipRulesCommandOutput) => void): void; + listSipRules( args: ListSipRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSipRulesCommandOutput) => void ): void; - public listSipRules( - args: ListSipRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSipRulesCommandOutput) => void), - cb?: (err: any, data?: ListSipRulesCommandOutput) => void - ): Promise | void { - const command = new ListSipRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the countries that you can order phone numbers from.

- */ - public listSupportedPhoneNumberCountries( + + /** + * @see {@link ListSupportedPhoneNumberCountriesCommand} + */ + listSupportedPhoneNumberCountries( args: ListSupportedPhoneNumberCountriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSupportedPhoneNumberCountries( + listSupportedPhoneNumberCountries( args: ListSupportedPhoneNumberCountriesCommandInput, cb: (err: any, data?: ListSupportedPhoneNumberCountriesCommandOutput) => void ): void; - public listSupportedPhoneNumberCountries( + listSupportedPhoneNumberCountries( args: ListSupportedPhoneNumberCountriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSupportedPhoneNumberCountriesCommandOutput) => void ): void; - public listSupportedPhoneNumberCountries( - args: ListSupportedPhoneNumberCountriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSupportedPhoneNumberCountriesCommandOutput) => void), - cb?: (err: any, data?: ListSupportedPhoneNumberCountriesCommandOutput) => void - ): Promise | void { - const command = new ListSupportedPhoneNumberCountriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of the tags in a given resource.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the Amazon Chime SDK Voice Connector groups in the administrator's AWS - * account.

- */ - public listVoiceConnectorGroups( + + /** + * @see {@link ListVoiceConnectorGroupsCommand} + */ + listVoiceConnectorGroups( args: ListVoiceConnectorGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVoiceConnectorGroups( + listVoiceConnectorGroups( args: ListVoiceConnectorGroupsCommandInput, cb: (err: any, data?: ListVoiceConnectorGroupsCommandOutput) => void ): void; - public listVoiceConnectorGroups( + listVoiceConnectorGroups( args: ListVoiceConnectorGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVoiceConnectorGroupsCommandOutput) => void ): void; - public listVoiceConnectorGroups( - args: ListVoiceConnectorGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVoiceConnectorGroupsCommandOutput) => void), - cb?: (err: any, data?: ListVoiceConnectorGroupsCommandOutput) => void - ): Promise | void { - const command = new ListVoiceConnectorGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the Amazon Chime SDK Voice Connectors in the administrators - * AWS account.

- */ - public listVoiceConnectors( + + /** + * @see {@link ListVoiceConnectorsCommand} + */ + listVoiceConnectors( args: ListVoiceConnectorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVoiceConnectors( + listVoiceConnectors( args: ListVoiceConnectorsCommandInput, cb: (err: any, data?: ListVoiceConnectorsCommandOutput) => void ): void; - public listVoiceConnectors( + listVoiceConnectors( args: ListVoiceConnectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVoiceConnectorsCommandOutput) => void ): void; - public listVoiceConnectors( - args: ListVoiceConnectorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVoiceConnectorsCommandOutput) => void), - cb?: (err: any, data?: ListVoiceConnectorsCommandOutput) => void - ): Promise | void { - const command = new ListVoiceConnectorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the SIP credentials for the specified Amazon Chime SDK Voice Connector.

- */ - public listVoiceConnectorTerminationCredentials( + + /** + * @see {@link ListVoiceConnectorTerminationCredentialsCommand} + */ + listVoiceConnectorTerminationCredentials( args: ListVoiceConnectorTerminationCredentialsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVoiceConnectorTerminationCredentials( + listVoiceConnectorTerminationCredentials( args: ListVoiceConnectorTerminationCredentialsCommandInput, cb: (err: any, data?: ListVoiceConnectorTerminationCredentialsCommandOutput) => void ): void; - public listVoiceConnectorTerminationCredentials( + listVoiceConnectorTerminationCredentials( args: ListVoiceConnectorTerminationCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVoiceConnectorTerminationCredentialsCommandOutput) => void ): void; - public listVoiceConnectorTerminationCredentials( - args: ListVoiceConnectorTerminationCredentialsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListVoiceConnectorTerminationCredentialsCommandOutput) => void), - cb?: (err: any, data?: ListVoiceConnectorTerminationCredentialsCommandOutput) => void - ): Promise | void { - const command = new ListVoiceConnectorTerminationCredentialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the specified voice profile domains in the administrator's AWS account. - *

- */ - public listVoiceProfileDomains( + + /** + * @see {@link ListVoiceProfileDomainsCommand} + */ + listVoiceProfileDomains( args: ListVoiceProfileDomainsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVoiceProfileDomains( + listVoiceProfileDomains( args: ListVoiceProfileDomainsCommandInput, cb: (err: any, data?: ListVoiceProfileDomainsCommandOutput) => void ): void; - public listVoiceProfileDomains( + listVoiceProfileDomains( args: ListVoiceProfileDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVoiceProfileDomainsCommandOutput) => void ): void; - public listVoiceProfileDomains( - args: ListVoiceProfileDomainsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVoiceProfileDomainsCommandOutput) => void), - cb?: (err: any, data?: ListVoiceProfileDomainsCommandOutput) => void - ): Promise | void { - const command = new ListVoiceProfileDomainsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the voice profiles in a voice profile domain.

- */ - public listVoiceProfiles( + + /** + * @see {@link ListVoiceProfilesCommand} + */ + listVoiceProfiles( args: ListVoiceProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVoiceProfiles( + listVoiceProfiles( args: ListVoiceProfilesCommandInput, cb: (err: any, data?: ListVoiceProfilesCommandOutput) => void ): void; - public listVoiceProfiles( + listVoiceProfiles( args: ListVoiceProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVoiceProfilesCommandOutput) => void ): void; - public listVoiceProfiles( - args: ListVoiceProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVoiceProfilesCommandOutput) => void), - cb?: (err: any, data?: ListVoiceProfilesCommandOutput) => void - ): Promise | void { - const command = new ListVoiceProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the Alexa Skill configuration for the SIP media application.

- */ - public putSipMediaApplicationAlexaSkillConfiguration( + + /** + * @see {@link PutSipMediaApplicationAlexaSkillConfigurationCommand} + */ + putSipMediaApplicationAlexaSkillConfiguration( args: PutSipMediaApplicationAlexaSkillConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putSipMediaApplicationAlexaSkillConfiguration( + putSipMediaApplicationAlexaSkillConfiguration( args: PutSipMediaApplicationAlexaSkillConfigurationCommandInput, cb: (err: any, data?: PutSipMediaApplicationAlexaSkillConfigurationCommandOutput) => void ): void; - public putSipMediaApplicationAlexaSkillConfiguration( + putSipMediaApplicationAlexaSkillConfiguration( args: PutSipMediaApplicationAlexaSkillConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSipMediaApplicationAlexaSkillConfigurationCommandOutput) => void ): void; - public putSipMediaApplicationAlexaSkillConfiguration( - args: PutSipMediaApplicationAlexaSkillConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PutSipMediaApplicationAlexaSkillConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutSipMediaApplicationAlexaSkillConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutSipMediaApplicationAlexaSkillConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the logging configuration for the specified SIP media application.

- */ - public putSipMediaApplicationLoggingConfiguration( + + /** + * @see {@link PutSipMediaApplicationLoggingConfigurationCommand} + */ + putSipMediaApplicationLoggingConfiguration( args: PutSipMediaApplicationLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putSipMediaApplicationLoggingConfiguration( + putSipMediaApplicationLoggingConfiguration( args: PutSipMediaApplicationLoggingConfigurationCommandInput, cb: (err: any, data?: PutSipMediaApplicationLoggingConfigurationCommandOutput) => void ): void; - public putSipMediaApplicationLoggingConfiguration( + putSipMediaApplicationLoggingConfiguration( args: PutSipMediaApplicationLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSipMediaApplicationLoggingConfigurationCommandOutput) => void ): void; - public putSipMediaApplicationLoggingConfiguration( - args: PutSipMediaApplicationLoggingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PutSipMediaApplicationLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutSipMediaApplicationLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutSipMediaApplicationLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a Voice Connector's emergency calling configuration.

- */ - public putVoiceConnectorEmergencyCallingConfiguration( + + /** + * @see {@link PutVoiceConnectorEmergencyCallingConfigurationCommand} + */ + putVoiceConnectorEmergencyCallingConfiguration( args: PutVoiceConnectorEmergencyCallingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putVoiceConnectorEmergencyCallingConfiguration( + putVoiceConnectorEmergencyCallingConfiguration( args: PutVoiceConnectorEmergencyCallingConfigurationCommandInput, cb: (err: any, data?: PutVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void ): void; - public putVoiceConnectorEmergencyCallingConfiguration( + putVoiceConnectorEmergencyCallingConfiguration( args: PutVoiceConnectorEmergencyCallingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void ): void; - public putVoiceConnectorEmergencyCallingConfiguration( - args: PutVoiceConnectorEmergencyCallingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PutVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutVoiceConnectorEmergencyCallingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a Voice Connector's logging configuration.

- */ - public putVoiceConnectorLoggingConfiguration( + + /** + * @see {@link PutVoiceConnectorLoggingConfigurationCommand} + */ + putVoiceConnectorLoggingConfiguration( args: PutVoiceConnectorLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putVoiceConnectorLoggingConfiguration( + putVoiceConnectorLoggingConfiguration( args: PutVoiceConnectorLoggingConfigurationCommandInput, cb: (err: any, data?: PutVoiceConnectorLoggingConfigurationCommandOutput) => void ): void; - public putVoiceConnectorLoggingConfiguration( + putVoiceConnectorLoggingConfiguration( args: PutVoiceConnectorLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutVoiceConnectorLoggingConfigurationCommandOutput) => void ): void; - public putVoiceConnectorLoggingConfiguration( - args: PutVoiceConnectorLoggingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PutVoiceConnectorLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutVoiceConnectorLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutVoiceConnectorLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a Voice Connector's origination settings.

- */ - public putVoiceConnectorOrigination( + + /** + * @see {@link PutVoiceConnectorOriginationCommand} + */ + putVoiceConnectorOrigination( args: PutVoiceConnectorOriginationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putVoiceConnectorOrigination( + putVoiceConnectorOrigination( args: PutVoiceConnectorOriginationCommandInput, cb: (err: any, data?: PutVoiceConnectorOriginationCommandOutput) => void ): void; - public putVoiceConnectorOrigination( + putVoiceConnectorOrigination( args: PutVoiceConnectorOriginationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutVoiceConnectorOriginationCommandOutput) => void ): void; - public putVoiceConnectorOrigination( - args: PutVoiceConnectorOriginationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutVoiceConnectorOriginationCommandOutput) => void), - cb?: (err: any, data?: PutVoiceConnectorOriginationCommandOutput) => void - ): Promise | void { - const command = new PutVoiceConnectorOriginationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector.

- */ - public putVoiceConnectorProxy( + + /** + * @see {@link PutVoiceConnectorProxyCommand} + */ + putVoiceConnectorProxy( args: PutVoiceConnectorProxyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putVoiceConnectorProxy( + putVoiceConnectorProxy( args: PutVoiceConnectorProxyCommandInput, cb: (err: any, data?: PutVoiceConnectorProxyCommandOutput) => void ): void; - public putVoiceConnectorProxy( + putVoiceConnectorProxy( args: PutVoiceConnectorProxyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutVoiceConnectorProxyCommandOutput) => void ): void; - public putVoiceConnectorProxy( - args: PutVoiceConnectorProxyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutVoiceConnectorProxyCommandOutput) => void), - cb?: (err: any, data?: PutVoiceConnectorProxyCommandOutput) => void - ): Promise | void { - const command = new PutVoiceConnectorProxyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a Voice Connector's streaming configuration settings.

- */ - public putVoiceConnectorStreamingConfiguration( + + /** + * @see {@link PutVoiceConnectorStreamingConfigurationCommand} + */ + putVoiceConnectorStreamingConfiguration( args: PutVoiceConnectorStreamingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putVoiceConnectorStreamingConfiguration( + putVoiceConnectorStreamingConfiguration( args: PutVoiceConnectorStreamingConfigurationCommandInput, cb: (err: any, data?: PutVoiceConnectorStreamingConfigurationCommandOutput) => void ): void; - public putVoiceConnectorStreamingConfiguration( + putVoiceConnectorStreamingConfiguration( args: PutVoiceConnectorStreamingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutVoiceConnectorStreamingConfigurationCommandOutput) => void ): void; - public putVoiceConnectorStreamingConfiguration( - args: PutVoiceConnectorStreamingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PutVoiceConnectorStreamingConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutVoiceConnectorStreamingConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutVoiceConnectorStreamingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a Voice Connector's termination settings.

- */ - public putVoiceConnectorTermination( + + /** + * @see {@link PutVoiceConnectorTerminationCommand} + */ + putVoiceConnectorTermination( args: PutVoiceConnectorTerminationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putVoiceConnectorTermination( + putVoiceConnectorTermination( args: PutVoiceConnectorTerminationCommandInput, cb: (err: any, data?: PutVoiceConnectorTerminationCommandOutput) => void ): void; - public putVoiceConnectorTermination( + putVoiceConnectorTermination( args: PutVoiceConnectorTerminationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutVoiceConnectorTerminationCommandOutput) => void ): void; - public putVoiceConnectorTermination( - args: PutVoiceConnectorTerminationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutVoiceConnectorTerminationCommandOutput) => void), - cb?: (err: any, data?: PutVoiceConnectorTerminationCommandOutput) => void - ): Promise | void { - const command = new PutVoiceConnectorTerminationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a Voice Connector's termination credentials.

- */ - public putVoiceConnectorTerminationCredentials( + + /** + * @see {@link PutVoiceConnectorTerminationCredentialsCommand} + */ + putVoiceConnectorTerminationCredentials( args: PutVoiceConnectorTerminationCredentialsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putVoiceConnectorTerminationCredentials( + putVoiceConnectorTerminationCredentials( args: PutVoiceConnectorTerminationCredentialsCommandInput, cb: (err: any, data?: PutVoiceConnectorTerminationCredentialsCommandOutput) => void ): void; - public putVoiceConnectorTerminationCredentials( + putVoiceConnectorTerminationCredentials( args: PutVoiceConnectorTerminationCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutVoiceConnectorTerminationCredentialsCommandOutput) => void ): void; - public putVoiceConnectorTerminationCredentials( - args: PutVoiceConnectorTerminationCredentialsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PutVoiceConnectorTerminationCredentialsCommandOutput) => void), - cb?: (err: any, data?: PutVoiceConnectorTerminationCredentialsCommandOutput) => void - ): Promise | void { - const command = new PutVoiceConnectorTerminationCredentialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Restores a deleted phone number.

- */ - public restorePhoneNumber( + + /** + * @see {@link RestorePhoneNumberCommand} + */ + restorePhoneNumber( args: RestorePhoneNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public restorePhoneNumber( + restorePhoneNumber( args: RestorePhoneNumberCommandInput, cb: (err: any, data?: RestorePhoneNumberCommandOutput) => void ): void; - public restorePhoneNumber( + restorePhoneNumber( args: RestorePhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestorePhoneNumberCommandOutput) => void ): void; - public restorePhoneNumber( - args: RestorePhoneNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestorePhoneNumberCommandOutput) => void), - cb?: (err: any, data?: RestorePhoneNumberCommandOutput) => void - ): Promise | void { - const command = new RestorePhoneNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Searches the provisioned phone numbers in an organization.

- */ - public searchAvailablePhoneNumbers( + + /** + * @see {@link SearchAvailablePhoneNumbersCommand} + */ + searchAvailablePhoneNumbers( args: SearchAvailablePhoneNumbersCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchAvailablePhoneNumbers( + searchAvailablePhoneNumbers( args: SearchAvailablePhoneNumbersCommandInput, cb: (err: any, data?: SearchAvailablePhoneNumbersCommandOutput) => void ): void; - public searchAvailablePhoneNumbers( + searchAvailablePhoneNumbers( args: SearchAvailablePhoneNumbersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchAvailablePhoneNumbersCommandOutput) => void ): void; - public searchAvailablePhoneNumbers( - args: SearchAvailablePhoneNumbersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchAvailablePhoneNumbersCommandOutput) => void), - cb?: (err: any, data?: SearchAvailablePhoneNumbersCommandOutput) => void - ): Promise | void { - const command = new SearchAvailablePhoneNumbersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a speaker search task.

- * - *

Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the - * AWS service terms for the Amazon Chime SDK.

- *
- */ - public startSpeakerSearchTask( + + /** + * @see {@link StartSpeakerSearchTaskCommand} + */ + startSpeakerSearchTask( args: StartSpeakerSearchTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public startSpeakerSearchTask( + startSpeakerSearchTask( args: StartSpeakerSearchTaskCommandInput, cb: (err: any, data?: StartSpeakerSearchTaskCommandOutput) => void ): void; - public startSpeakerSearchTask( + startSpeakerSearchTask( args: StartSpeakerSearchTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSpeakerSearchTaskCommandOutput) => void ): void; - public startSpeakerSearchTask( - args: StartSpeakerSearchTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartSpeakerSearchTaskCommandOutput) => void), - cb?: (err: any, data?: StartSpeakerSearchTaskCommandOutput) => void - ): Promise | void { - const command = new StartSpeakerSearchTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a voice tone analysis task. For more information about voice tone analysis, see - * Using Amazon Chime SDK voice analytics - * in the Amazon Chime SDK Developer Guide.

- * - *

Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the - * AWS service terms for the Amazon Chime SDK.

- *
- */ - public startVoiceToneAnalysisTask( + + /** + * @see {@link StartVoiceToneAnalysisTaskCommand} + */ + startVoiceToneAnalysisTask( args: StartVoiceToneAnalysisTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public startVoiceToneAnalysisTask( + startVoiceToneAnalysisTask( args: StartVoiceToneAnalysisTaskCommandInput, cb: (err: any, data?: StartVoiceToneAnalysisTaskCommandOutput) => void ): void; - public startVoiceToneAnalysisTask( + startVoiceToneAnalysisTask( args: StartVoiceToneAnalysisTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartVoiceToneAnalysisTaskCommandOutput) => void ): void; - public startVoiceToneAnalysisTask( - args: StartVoiceToneAnalysisTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartVoiceToneAnalysisTaskCommandOutput) => void), - cb?: (err: any, data?: StartVoiceToneAnalysisTaskCommandOutput) => void - ): Promise | void { - const command = new StartVoiceToneAnalysisTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a speaker search task.

- */ - public stopSpeakerSearchTask( + + /** + * @see {@link StopSpeakerSearchTaskCommand} + */ + stopSpeakerSearchTask( args: StopSpeakerSearchTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopSpeakerSearchTask( + stopSpeakerSearchTask( args: StopSpeakerSearchTaskCommandInput, cb: (err: any, data?: StopSpeakerSearchTaskCommandOutput) => void ): void; - public stopSpeakerSearchTask( + stopSpeakerSearchTask( args: StopSpeakerSearchTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopSpeakerSearchTaskCommandOutput) => void ): void; - public stopSpeakerSearchTask( - args: StopSpeakerSearchTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopSpeakerSearchTaskCommandOutput) => void), - cb?: (err: any, data?: StopSpeakerSearchTaskCommandOutput) => void - ): Promise | void { - const command = new StopSpeakerSearchTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a voice tone analysis task.

- */ - public stopVoiceToneAnalysisTask( + + /** + * @see {@link StopVoiceToneAnalysisTaskCommand} + */ + stopVoiceToneAnalysisTask( args: StopVoiceToneAnalysisTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopVoiceToneAnalysisTask( + stopVoiceToneAnalysisTask( args: StopVoiceToneAnalysisTaskCommandInput, cb: (err: any, data?: StopVoiceToneAnalysisTaskCommandOutput) => void ): void; - public stopVoiceToneAnalysisTask( + stopVoiceToneAnalysisTask( args: StopVoiceToneAnalysisTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopVoiceToneAnalysisTaskCommandOutput) => void ): void; - public stopVoiceToneAnalysisTask( - args: StopVoiceToneAnalysisTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopVoiceToneAnalysisTaskCommandOutput) => void), - cb?: (err: any, data?: StopVoiceToneAnalysisTaskCommandOutput) => void - ): Promise | void { - const command = new StopVoiceToneAnalysisTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds a tag to the specified resource.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes tags from a resource.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

- */ - public updateGlobalSettings( + + /** + * @see {@link UpdateGlobalSettingsCommand} + */ + updateGlobalSettings( args: UpdateGlobalSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGlobalSettings( + updateGlobalSettings( args: UpdateGlobalSettingsCommandInput, cb: (err: any, data?: UpdateGlobalSettingsCommandOutput) => void ): void; - public updateGlobalSettings( + updateGlobalSettings( args: UpdateGlobalSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGlobalSettingsCommandOutput) => void ): void; - public updateGlobalSettings( - args: UpdateGlobalSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGlobalSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateGlobalSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateGlobalSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates phone number details, such as product type or calling name, for the - * specified phone number ID. You can update one phone number detail at a time. For - * example, you can update either the product type or the calling name in one action.

- *

For numbers outside the U.S., you must use the Amazon Chime SDK SIP Media - * Application Dial-In product type.

- *

Updates to outbound calling names can take 72 hours to complete. Pending - * updates to outbound calling names must be complete before you can request another - * update.

- */ - public updatePhoneNumber( + + /** + * @see {@link UpdatePhoneNumberCommand} + */ + updatePhoneNumber( args: UpdatePhoneNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePhoneNumber( + updatePhoneNumber( args: UpdatePhoneNumberCommandInput, cb: (err: any, data?: UpdatePhoneNumberCommandOutput) => void ): void; - public updatePhoneNumber( + updatePhoneNumber( args: UpdatePhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePhoneNumberCommandOutput) => void ): void; - public updatePhoneNumber( - args: UpdatePhoneNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePhoneNumberCommandOutput) => void), - cb?: (err: any, data?: UpdatePhoneNumberCommandOutput) => void - ): Promise | void { - const command = new UpdatePhoneNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the phone number settings for the administrator's AWS account, such - * as the default outbound calling name. You can update the default outbound calling - * name once every seven days. Outbound calling names can take up to 72 hours to - * update.

- */ - public updatePhoneNumberSettings( + + /** + * @see {@link UpdatePhoneNumberSettingsCommand} + */ + updatePhoneNumberSettings( args: UpdatePhoneNumberSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePhoneNumberSettings( + updatePhoneNumberSettings( args: UpdatePhoneNumberSettingsCommandInput, cb: (err: any, data?: UpdatePhoneNumberSettingsCommandOutput) => void ): void; - public updatePhoneNumberSettings( + updatePhoneNumberSettings( args: UpdatePhoneNumberSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePhoneNumberSettingsCommandOutput) => void ): void; - public updatePhoneNumberSettings( - args: UpdatePhoneNumberSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePhoneNumberSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdatePhoneNumberSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdatePhoneNumberSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the specified proxy session details, such as voice or SMS capabilities.

- */ - public updateProxySession( + + /** + * @see {@link UpdateProxySessionCommand} + */ + updateProxySession( args: UpdateProxySessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateProxySession( + updateProxySession( args: UpdateProxySessionCommandInput, cb: (err: any, data?: UpdateProxySessionCommandOutput) => void ): void; - public updateProxySession( + updateProxySession( args: UpdateProxySessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProxySessionCommandOutput) => void ): void; - public updateProxySession( - args: UpdateProxySessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProxySessionCommandOutput) => void), - cb?: (err: any, data?: UpdateProxySessionCommandOutput) => void - ): Promise | void { - const command = new UpdateProxySessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the details of the specified SIP media application.

- */ - public updateSipMediaApplication( + + /** + * @see {@link UpdateSipMediaApplicationCommand} + */ + updateSipMediaApplication( args: UpdateSipMediaApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSipMediaApplication( + updateSipMediaApplication( args: UpdateSipMediaApplicationCommandInput, cb: (err: any, data?: UpdateSipMediaApplicationCommandOutput) => void ): void; - public updateSipMediaApplication( + updateSipMediaApplication( args: UpdateSipMediaApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSipMediaApplicationCommandOutput) => void ): void; - public updateSipMediaApplication( - args: UpdateSipMediaApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSipMediaApplicationCommandOutput) => void), - cb?: (err: any, data?: UpdateSipMediaApplicationCommandOutput) => void - ): Promise | void { - const command = new UpdateSipMediaApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Invokes the AWS Lambda function associated with the SIP media application and - * transaction ID in an update request. The Lambda function can then return a new set - * of actions.

- */ - public updateSipMediaApplicationCall( + + /** + * @see {@link UpdateSipMediaApplicationCallCommand} + */ + updateSipMediaApplicationCall( args: UpdateSipMediaApplicationCallCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSipMediaApplicationCall( + updateSipMediaApplicationCall( args: UpdateSipMediaApplicationCallCommandInput, cb: (err: any, data?: UpdateSipMediaApplicationCallCommandOutput) => void ): void; - public updateSipMediaApplicationCall( + updateSipMediaApplicationCall( args: UpdateSipMediaApplicationCallCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSipMediaApplicationCallCommandOutput) => void ): void; - public updateSipMediaApplicationCall( - args: UpdateSipMediaApplicationCallCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSipMediaApplicationCallCommandOutput) => void), - cb?: (err: any, data?: UpdateSipMediaApplicationCallCommandOutput) => void - ): Promise | void { - const command = new UpdateSipMediaApplicationCallCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the details of the specified SIP rule.

- */ - public updateSipRule( - args: UpdateSipRuleCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateSipRule( - args: UpdateSipRuleCommandInput, - cb: (err: any, data?: UpdateSipRuleCommandOutput) => void - ): void; - public updateSipRule( + + /** + * @see {@link UpdateSipRuleCommand} + */ + updateSipRule(args: UpdateSipRuleCommandInput, options?: __HttpHandlerOptions): Promise; + updateSipRule(args: UpdateSipRuleCommandInput, cb: (err: any, data?: UpdateSipRuleCommandOutput) => void): void; + updateSipRule( args: UpdateSipRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSipRuleCommandOutput) => void ): void; - public updateSipRule( - args: UpdateSipRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSipRuleCommandOutput) => void), - cb?: (err: any, data?: UpdateSipRuleCommandOutput) => void - ): Promise | void { - const command = new UpdateSipRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the details for the specified Amazon Chime SDK Voice Connector.

- */ - public updateVoiceConnector( + + /** + * @see {@link UpdateVoiceConnectorCommand} + */ + updateVoiceConnector( args: UpdateVoiceConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVoiceConnector( + updateVoiceConnector( args: UpdateVoiceConnectorCommandInput, cb: (err: any, data?: UpdateVoiceConnectorCommandOutput) => void ): void; - public updateVoiceConnector( + updateVoiceConnector( args: UpdateVoiceConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVoiceConnectorCommandOutput) => void ): void; - public updateVoiceConnector( - args: UpdateVoiceConnectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVoiceConnectorCommandOutput) => void), - cb?: (err: any, data?: UpdateVoiceConnectorCommandOutput) => void - ): Promise | void { - const command = new UpdateVoiceConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the settings for the specified Amazon Chime SDK Voice Connector group.

- */ - public updateVoiceConnectorGroup( + + /** + * @see {@link UpdateVoiceConnectorGroupCommand} + */ + updateVoiceConnectorGroup( args: UpdateVoiceConnectorGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVoiceConnectorGroup( + updateVoiceConnectorGroup( args: UpdateVoiceConnectorGroupCommandInput, cb: (err: any, data?: UpdateVoiceConnectorGroupCommandOutput) => void ): void; - public updateVoiceConnectorGroup( + updateVoiceConnectorGroup( args: UpdateVoiceConnectorGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVoiceConnectorGroupCommandOutput) => void ): void; - public updateVoiceConnectorGroup( - args: UpdateVoiceConnectorGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVoiceConnectorGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateVoiceConnectorGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateVoiceConnectorGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the specified voice profile’s voice print and refreshes its expiration timestamp.

- * - *

As a condition of using this feature, you acknowledge that the collection, use, storage, and retention of - * your caller’s biometric identifiers and biometric information (“biometric data”) in the form of a digital voiceprint - * requires the caller’s informed consent via a written release. Such consent is required under various state laws, - * including biometrics laws in Illinois, Texas, Washington and other state privacy laws.

- *

You must provide a written release to each caller through a process that clearly reflects each caller’s informed - * consent before using Amazon Chime SDK Voice Insights service, as required under the terms of your agreement - * with AWS governing your use of the service.

- *
- */ - public updateVoiceProfile( + + /** + * @see {@link UpdateVoiceProfileCommand} + */ + updateVoiceProfile( args: UpdateVoiceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVoiceProfile( + updateVoiceProfile( args: UpdateVoiceProfileCommandInput, cb: (err: any, data?: UpdateVoiceProfileCommandOutput) => void ): void; - public updateVoiceProfile( + updateVoiceProfile( args: UpdateVoiceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVoiceProfileCommandOutput) => void ): void; - public updateVoiceProfile( - args: UpdateVoiceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVoiceProfileCommandOutput) => void), - cb?: (err: any, data?: UpdateVoiceProfileCommandOutput) => void - ): Promise | void { - const command = new UpdateVoiceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the settings for the specified voice profile domain.

- */ - public updateVoiceProfileDomain( + + /** + * @see {@link UpdateVoiceProfileDomainCommand} + */ + updateVoiceProfileDomain( args: UpdateVoiceProfileDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVoiceProfileDomain( + updateVoiceProfileDomain( args: UpdateVoiceProfileDomainCommandInput, cb: (err: any, data?: UpdateVoiceProfileDomainCommandOutput) => void ): void; - public updateVoiceProfileDomain( + updateVoiceProfileDomain( args: UpdateVoiceProfileDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVoiceProfileDomainCommandOutput) => void ): void; - public updateVoiceProfileDomain( - args: UpdateVoiceProfileDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVoiceProfileDomainCommandOutput) => void), - cb?: (err: any, data?: UpdateVoiceProfileDomainCommandOutput) => void - ): Promise | void { - const command = new UpdateVoiceProfileDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Validates an address to be used for 911 calls made with Amazon Chime SDK Voice - * Connectors. You can use validated addresses in a Presence Information Data Format - * Location Object file that you include in SIP requests. That helps ensure that addresses - * are routed to the appropriate Public Safety Answering Point.

- */ - public validateE911Address( + + /** + * @see {@link ValidateE911AddressCommand} + */ + validateE911Address( args: ValidateE911AddressCommandInput, options?: __HttpHandlerOptions ): Promise; - public validateE911Address( + validateE911Address( args: ValidateE911AddressCommandInput, cb: (err: any, data?: ValidateE911AddressCommandOutput) => void ): void; - public validateE911Address( + validateE911Address( args: ValidateE911AddressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidateE911AddressCommandOutput) => void ): void; - public validateE911Address( - args: ValidateE911AddressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ValidateE911AddressCommandOutput) => void), - cb?: (err: any, data?: ValidateE911AddressCommandOutput) => void - ): Promise | void { - const command = new ValidateE911AddressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The Amazon Chime SDK telephony APIs in this section enable developers to create PSTN calling solutions that use Amazon Chime SDK Voice Connectors, and Amazon Chime SDK SIP media applications. Developers can + * also order and manage phone numbers, create and manage Voice Connectors and SIP media applications, and run voice analytics.

+ */ +export class ChimeSDKVoice extends ChimeSDKVoiceClient implements ChimeSDKVoice {} +createAggregatedClient(commands, ChimeSDKVoice); diff --git a/clients/client-chime/src/Chime.ts b/clients/client-chime/src/Chime.ts index 086f8d6a8afe..33e19b81b88e 100644 --- a/clients/client-chime/src/Chime.ts +++ b/clients/client-chime/src/Chime.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { ChimeClient } from "./ChimeClient"; +import { ChimeClient, ChimeClientConfig } from "./ChimeClient"; import { AssociatePhoneNumbersWithVoiceConnectorCommand, AssociatePhoneNumbersWithVoiceConnectorCommandInput, @@ -870,6742 +871,3217 @@ import { ValidateE911AddressCommandOutput, } from "./commands/ValidateE911AddressCommand"; -/** - * @public - *

The Amazon Chime API (application programming interface) is designed for developers to - * perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice - * Connectors. This guide provides detailed information about the Amazon Chime API, - * including operations, types, inputs and outputs, and error codes. It also includes API actions for use with the Amazon Chime SDK, which developers use to build their own communication applications. For more information about the - * Amazon Chime SDK, see - * Using the Amazon Chime SDK - * in the Amazon Chime Developer Guide.

- *

You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the - * AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.

- *
- *
Using an AWS SDK
- *
- *

- * You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the - * AWS Developer Center. - *

- *
- *
Using the AWS CLI
- *
- *

Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see - * Installing the AWS Command Line Interface - * in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the - * Amazon Chime commands in the - * AWS CLI Command Reference. - *

- *
- *
Using REST APIs
- *
- *

If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports signature version 4. For more information, see - * Signature Version 4 Signing Process - * in the Amazon Web Services General Reference.

- * - *

When making REST API calls, use the service name chime and REST endpoint https://service.chime.aws.amazon.com.

- *
- *
- * - *

Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see - * Identity and Access Management for Amazon Chime - * in the Amazon Chime Administration Guide.

- */ -export class Chime extends ChimeClient { +const commands = { + AssociatePhoneNumbersWithVoiceConnectorCommand, + AssociatePhoneNumbersWithVoiceConnectorGroupCommand, + AssociatePhoneNumberWithUserCommand, + AssociateSigninDelegateGroupsWithAccountCommand, + BatchCreateAttendeeCommand, + BatchCreateChannelMembershipCommand, + BatchCreateRoomMembershipCommand, + BatchDeletePhoneNumberCommand, + BatchSuspendUserCommand, + BatchUnsuspendUserCommand, + BatchUpdatePhoneNumberCommand, + BatchUpdateUserCommand, + CreateAccountCommand, + CreateAppInstanceCommand, + CreateAppInstanceAdminCommand, + CreateAppInstanceUserCommand, + CreateAttendeeCommand, + CreateBotCommand, + CreateChannelCommand, + CreateChannelBanCommand, + CreateChannelMembershipCommand, + CreateChannelModeratorCommand, + CreateMediaCapturePipelineCommand, + CreateMeetingCommand, + CreateMeetingDialOutCommand, + CreateMeetingWithAttendeesCommand, + CreatePhoneNumberOrderCommand, + CreateProxySessionCommand, + CreateRoomCommand, + CreateRoomMembershipCommand, + CreateSipMediaApplicationCommand, + CreateSipMediaApplicationCallCommand, + CreateSipRuleCommand, + CreateUserCommand, + CreateVoiceConnectorCommand, + CreateVoiceConnectorGroupCommand, + DeleteAccountCommand, + DeleteAppInstanceCommand, + DeleteAppInstanceAdminCommand, + DeleteAppInstanceStreamingConfigurationsCommand, + DeleteAppInstanceUserCommand, + DeleteAttendeeCommand, + DeleteChannelCommand, + DeleteChannelBanCommand, + DeleteChannelMembershipCommand, + DeleteChannelMessageCommand, + DeleteChannelModeratorCommand, + DeleteEventsConfigurationCommand, + DeleteMediaCapturePipelineCommand, + DeleteMeetingCommand, + DeletePhoneNumberCommand, + DeleteProxySessionCommand, + DeleteRoomCommand, + DeleteRoomMembershipCommand, + DeleteSipMediaApplicationCommand, + DeleteSipRuleCommand, + DeleteVoiceConnectorCommand, + DeleteVoiceConnectorEmergencyCallingConfigurationCommand, + DeleteVoiceConnectorGroupCommand, + DeleteVoiceConnectorOriginationCommand, + DeleteVoiceConnectorProxyCommand, + DeleteVoiceConnectorStreamingConfigurationCommand, + DeleteVoiceConnectorTerminationCommand, + DeleteVoiceConnectorTerminationCredentialsCommand, + DescribeAppInstanceCommand, + DescribeAppInstanceAdminCommand, + DescribeAppInstanceUserCommand, + DescribeChannelCommand, + DescribeChannelBanCommand, + DescribeChannelMembershipCommand, + DescribeChannelMembershipForAppInstanceUserCommand, + DescribeChannelModeratedByAppInstanceUserCommand, + DescribeChannelModeratorCommand, + DisassociatePhoneNumberFromUserCommand, + DisassociatePhoneNumbersFromVoiceConnectorCommand, + DisassociatePhoneNumbersFromVoiceConnectorGroupCommand, + DisassociateSigninDelegateGroupsFromAccountCommand, + GetAccountCommand, + GetAccountSettingsCommand, + GetAppInstanceRetentionSettingsCommand, + GetAppInstanceStreamingConfigurationsCommand, + GetAttendeeCommand, + GetBotCommand, + GetChannelMessageCommand, + GetEventsConfigurationCommand, + GetGlobalSettingsCommand, + GetMediaCapturePipelineCommand, + GetMeetingCommand, + GetMessagingSessionEndpointCommand, + GetPhoneNumberCommand, + GetPhoneNumberOrderCommand, + GetPhoneNumberSettingsCommand, + GetProxySessionCommand, + GetRetentionSettingsCommand, + GetRoomCommand, + GetSipMediaApplicationCommand, + GetSipMediaApplicationLoggingConfigurationCommand, + GetSipRuleCommand, + GetUserCommand, + GetUserSettingsCommand, + GetVoiceConnectorCommand, + GetVoiceConnectorEmergencyCallingConfigurationCommand, + GetVoiceConnectorGroupCommand, + GetVoiceConnectorLoggingConfigurationCommand, + GetVoiceConnectorOriginationCommand, + GetVoiceConnectorProxyCommand, + GetVoiceConnectorStreamingConfigurationCommand, + GetVoiceConnectorTerminationCommand, + GetVoiceConnectorTerminationHealthCommand, + InviteUsersCommand, + ListAccountsCommand, + ListAppInstanceAdminsCommand, + ListAppInstancesCommand, + ListAppInstanceUsersCommand, + ListAttendeesCommand, + ListAttendeeTagsCommand, + ListBotsCommand, + ListChannelBansCommand, + ListChannelMembershipsCommand, + ListChannelMembershipsForAppInstanceUserCommand, + ListChannelMessagesCommand, + ListChannelModeratorsCommand, + ListChannelsCommand, + ListChannelsModeratedByAppInstanceUserCommand, + ListMediaCapturePipelinesCommand, + ListMeetingsCommand, + ListMeetingTagsCommand, + ListPhoneNumberOrdersCommand, + ListPhoneNumbersCommand, + ListProxySessionsCommand, + ListRoomMembershipsCommand, + ListRoomsCommand, + ListSipMediaApplicationsCommand, + ListSipRulesCommand, + ListSupportedPhoneNumberCountriesCommand, + ListTagsForResourceCommand, + ListUsersCommand, + ListVoiceConnectorGroupsCommand, + ListVoiceConnectorsCommand, + ListVoiceConnectorTerminationCredentialsCommand, + LogoutUserCommand, + PutAppInstanceRetentionSettingsCommand, + PutAppInstanceStreamingConfigurationsCommand, + PutEventsConfigurationCommand, + PutRetentionSettingsCommand, + PutSipMediaApplicationLoggingConfigurationCommand, + PutVoiceConnectorEmergencyCallingConfigurationCommand, + PutVoiceConnectorLoggingConfigurationCommand, + PutVoiceConnectorOriginationCommand, + PutVoiceConnectorProxyCommand, + PutVoiceConnectorStreamingConfigurationCommand, + PutVoiceConnectorTerminationCommand, + PutVoiceConnectorTerminationCredentialsCommand, + RedactChannelMessageCommand, + RedactConversationMessageCommand, + RedactRoomMessageCommand, + RegenerateSecurityTokenCommand, + ResetPersonalPINCommand, + RestorePhoneNumberCommand, + SearchAvailablePhoneNumbersCommand, + SendChannelMessageCommand, + StartMeetingTranscriptionCommand, + StopMeetingTranscriptionCommand, + TagAttendeeCommand, + TagMeetingCommand, + TagResourceCommand, + UntagAttendeeCommand, + UntagMeetingCommand, + UntagResourceCommand, + UpdateAccountCommand, + UpdateAccountSettingsCommand, + UpdateAppInstanceCommand, + UpdateAppInstanceUserCommand, + UpdateBotCommand, + UpdateChannelCommand, + UpdateChannelMessageCommand, + UpdateChannelReadMarkerCommand, + UpdateGlobalSettingsCommand, + UpdatePhoneNumberCommand, + UpdatePhoneNumberSettingsCommand, + UpdateProxySessionCommand, + UpdateRoomCommand, + UpdateRoomMembershipCommand, + UpdateSipMediaApplicationCommand, + UpdateSipMediaApplicationCallCommand, + UpdateSipRuleCommand, + UpdateUserCommand, + UpdateUserSettingsCommand, + UpdateVoiceConnectorCommand, + UpdateVoiceConnectorGroupCommand, + ValidateE911AddressCommand, +}; + +export interface Chime { /** - * @public - *

Associates phone numbers with the specified Amazon Chime Voice Connector.

+ * @see {@link AssociatePhoneNumbersWithVoiceConnectorCommand} */ - public associatePhoneNumbersWithVoiceConnector( + associatePhoneNumbersWithVoiceConnector( args: AssociatePhoneNumbersWithVoiceConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public associatePhoneNumbersWithVoiceConnector( + associatePhoneNumbersWithVoiceConnector( args: AssociatePhoneNumbersWithVoiceConnectorCommandInput, cb: (err: any, data?: AssociatePhoneNumbersWithVoiceConnectorCommandOutput) => void ): void; - public associatePhoneNumbersWithVoiceConnector( + associatePhoneNumbersWithVoiceConnector( args: AssociatePhoneNumbersWithVoiceConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociatePhoneNumbersWithVoiceConnectorCommandOutput) => void ): void; - public associatePhoneNumbersWithVoiceConnector( - args: AssociatePhoneNumbersWithVoiceConnectorCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AssociatePhoneNumbersWithVoiceConnectorCommandOutput) => void), - cb?: (err: any, data?: AssociatePhoneNumbersWithVoiceConnectorCommandOutput) => void - ): Promise | void { - const command = new AssociatePhoneNumbersWithVoiceConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates phone numbers with the specified Amazon Chime Voice Connector group.

- */ - public associatePhoneNumbersWithVoiceConnectorGroup( + + /** + * @see {@link AssociatePhoneNumbersWithVoiceConnectorGroupCommand} + */ + associatePhoneNumbersWithVoiceConnectorGroup( args: AssociatePhoneNumbersWithVoiceConnectorGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public associatePhoneNumbersWithVoiceConnectorGroup( + associatePhoneNumbersWithVoiceConnectorGroup( args: AssociatePhoneNumbersWithVoiceConnectorGroupCommandInput, cb: (err: any, data?: AssociatePhoneNumbersWithVoiceConnectorGroupCommandOutput) => void ): void; - public associatePhoneNumbersWithVoiceConnectorGroup( + associatePhoneNumbersWithVoiceConnectorGroup( args: AssociatePhoneNumbersWithVoiceConnectorGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociatePhoneNumbersWithVoiceConnectorGroupCommandOutput) => void ): void; - public associatePhoneNumbersWithVoiceConnectorGroup( - args: AssociatePhoneNumbersWithVoiceConnectorGroupCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AssociatePhoneNumbersWithVoiceConnectorGroupCommandOutput) => void), - cb?: (err: any, data?: AssociatePhoneNumbersWithVoiceConnectorGroupCommandOutput) => void - ): Promise | void { - const command = new AssociatePhoneNumbersWithVoiceConnectorGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a phone number with the specified Amazon Chime user.

- */ - public associatePhoneNumberWithUser( + + /** + * @see {@link AssociatePhoneNumberWithUserCommand} + */ + associatePhoneNumberWithUser( args: AssociatePhoneNumberWithUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public associatePhoneNumberWithUser( + associatePhoneNumberWithUser( args: AssociatePhoneNumberWithUserCommandInput, cb: (err: any, data?: AssociatePhoneNumberWithUserCommandOutput) => void ): void; - public associatePhoneNumberWithUser( + associatePhoneNumberWithUser( args: AssociatePhoneNumberWithUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociatePhoneNumberWithUserCommandOutput) => void ): void; - public associatePhoneNumberWithUser( - args: AssociatePhoneNumberWithUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociatePhoneNumberWithUserCommandOutput) => void), - cb?: (err: any, data?: AssociatePhoneNumberWithUserCommandOutput) => void - ): Promise | void { - const command = new AssociatePhoneNumberWithUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates the specified sign-in delegate groups with the specified Amazon Chime account.

- */ - public associateSigninDelegateGroupsWithAccount( + + /** + * @see {@link AssociateSigninDelegateGroupsWithAccountCommand} + */ + associateSigninDelegateGroupsWithAccount( args: AssociateSigninDelegateGroupsWithAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateSigninDelegateGroupsWithAccount( + associateSigninDelegateGroupsWithAccount( args: AssociateSigninDelegateGroupsWithAccountCommandInput, cb: (err: any, data?: AssociateSigninDelegateGroupsWithAccountCommandOutput) => void ): void; - public associateSigninDelegateGroupsWithAccount( + associateSigninDelegateGroupsWithAccount( args: AssociateSigninDelegateGroupsWithAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateSigninDelegateGroupsWithAccountCommandOutput) => void ): void; - public associateSigninDelegateGroupsWithAccount( - args: AssociateSigninDelegateGroupsWithAccountCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AssociateSigninDelegateGroupsWithAccountCommandOutput) => void), - cb?: (err: any, data?: AssociateSigninDelegateGroupsWithAccountCommandOutput) => void - ): Promise | void { - const command = new AssociateSigninDelegateGroupsWithAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see - * Using the Amazon Chime SDK - * in the - * Amazon Chime Developer Guide. - *

- */ - public batchCreateAttendee( + + /** + * @see {@link BatchCreateAttendeeCommand} + */ + batchCreateAttendee( args: BatchCreateAttendeeCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchCreateAttendee( + batchCreateAttendee( args: BatchCreateAttendeeCommandInput, cb: (err: any, data?: BatchCreateAttendeeCommandOutput) => void ): void; - public batchCreateAttendee( + batchCreateAttendee( args: BatchCreateAttendeeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCreateAttendeeCommandOutput) => void ): void; - public batchCreateAttendee( - args: BatchCreateAttendeeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchCreateAttendeeCommandOutput) => void), - cb?: (err: any, data?: BatchCreateAttendeeCommandOutput) => void - ): Promise | void { - const command = new BatchCreateAttendeeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds a specified number of users to a channel.

- */ - public batchCreateChannelMembership( + + /** + * @see {@link BatchCreateChannelMembershipCommand} + */ + batchCreateChannelMembership( args: BatchCreateChannelMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchCreateChannelMembership( + batchCreateChannelMembership( args: BatchCreateChannelMembershipCommandInput, cb: (err: any, data?: BatchCreateChannelMembershipCommandOutput) => void ): void; - public batchCreateChannelMembership( + batchCreateChannelMembership( args: BatchCreateChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCreateChannelMembershipCommandOutput) => void ): void; - public batchCreateChannelMembership( - args: BatchCreateChannelMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchCreateChannelMembershipCommandOutput) => void), - cb?: (err: any, data?: BatchCreateChannelMembershipCommandOutput) => void - ): Promise | void { - const command = new BatchCreateChannelMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.

- */ - public batchCreateRoomMembership( + + /** + * @see {@link BatchCreateRoomMembershipCommand} + */ + batchCreateRoomMembership( args: BatchCreateRoomMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchCreateRoomMembership( + batchCreateRoomMembership( args: BatchCreateRoomMembershipCommandInput, cb: (err: any, data?: BatchCreateRoomMembershipCommandOutput) => void ): void; - public batchCreateRoomMembership( + batchCreateRoomMembership( args: BatchCreateRoomMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCreateRoomMembershipCommandOutput) => void ): void; - public batchCreateRoomMembership( - args: BatchCreateRoomMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchCreateRoomMembershipCommandOutput) => void), - cb?: (err: any, data?: BatchCreateRoomMembershipCommandOutput) => void - ): Promise | void { - const command = new BatchCreateRoomMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Moves phone numbers into the - * Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted. - *

- * - *

- * Phone numbers remain in the - * Deletion queue for 7 days before they are deleted permanently. - *

- */ - public batchDeletePhoneNumber( + + /** + * @see {@link BatchDeletePhoneNumberCommand} + */ + batchDeletePhoneNumber( args: BatchDeletePhoneNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeletePhoneNumber( + batchDeletePhoneNumber( args: BatchDeletePhoneNumberCommandInput, cb: (err: any, data?: BatchDeletePhoneNumberCommandOutput) => void ): void; - public batchDeletePhoneNumber( + batchDeletePhoneNumber( args: BatchDeletePhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeletePhoneNumberCommandOutput) => void ): void; - public batchDeletePhoneNumber( - args: BatchDeletePhoneNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeletePhoneNumberCommandOutput) => void), - cb?: (err: any, data?: BatchDeletePhoneNumberCommandOutput) => void - ): Promise | void { - const command = new BatchDeletePhoneNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime - * account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration - * Guide.

- * - *

Users suspended from a Team account are disassociated from the account,but they - * can continue to use Amazon Chime as free users. To remove the suspension from suspended - * Team account users, invite them to the Team account again. - * You can use the InviteUsers action to do so.

- * - *

Users suspended from an EnterpriseLWA account are immediately signed out of - * Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action.

- * - *

- * To sign out users without suspending them, use the - * LogoutUser - * action. - *

- */ - public batchSuspendUser( + + /** + * @see {@link BatchSuspendUserCommand} + */ + batchSuspendUser( args: BatchSuspendUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchSuspendUser( + batchSuspendUser( args: BatchSuspendUserCommandInput, cb: (err: any, data?: BatchSuspendUserCommandOutput) => void ): void; - public batchSuspendUser( + batchSuspendUser( args: BatchSuspendUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchSuspendUserCommandOutput) => void ): void; - public batchSuspendUser( - args: BatchSuspendUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchSuspendUserCommandOutput) => void), - cb?: (err: any, data?: BatchSuspendUserCommandOutput) => void - ): Promise | void { - const command = new BatchSuspendUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the suspension from up to 50 previously suspended users for the specified Amazon - * Chime EnterpriseLWA account. Only users on EnterpriseLWA - * accounts can be unsuspended using this action. For more information about different account types, see - * - * Managing Your Amazon Chime Accounts - * in the account types, in the Amazon Chime Administration Guide. - *

- * - *

- * Previously suspended users who are unsuspended using this action are returned to - * Registered - * status. Users who are not previously suspended are ignored. - *

- */ - public batchUnsuspendUser( + + /** + * @see {@link BatchUnsuspendUserCommand} + */ + batchUnsuspendUser( args: BatchUnsuspendUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchUnsuspendUser( + batchUnsuspendUser( args: BatchUnsuspendUserCommandInput, cb: (err: any, data?: BatchUnsuspendUserCommandOutput) => void ): void; - public batchUnsuspendUser( + batchUnsuspendUser( args: BatchUnsuspendUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchUnsuspendUserCommandOutput) => void ): void; - public batchUnsuspendUser( - args: BatchUnsuspendUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchUnsuspendUserCommandOutput) => void), - cb?: (err: any, data?: BatchUnsuspendUserCommandOutput) => void - ): Promise | void { - const command = new BatchUnsuspendUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update the product type or the calling name.

- *

For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.

- *

Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

- */ - public batchUpdatePhoneNumber( + + /** + * @see {@link BatchUpdatePhoneNumberCommand} + */ + batchUpdatePhoneNumber( args: BatchUpdatePhoneNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchUpdatePhoneNumber( + batchUpdatePhoneNumber( args: BatchUpdatePhoneNumberCommandInput, cb: (err: any, data?: BatchUpdatePhoneNumberCommandOutput) => void ): void; - public batchUpdatePhoneNumber( + batchUpdatePhoneNumber( args: BatchUpdatePhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchUpdatePhoneNumberCommandOutput) => void ): void; - public batchUpdatePhoneNumber( - args: BatchUpdatePhoneNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchUpdatePhoneNumberCommandOutput) => void), - cb?: (err: any, data?: BatchUpdatePhoneNumberCommandOutput) => void - ): Promise | void { - const command = new BatchUpdatePhoneNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.

- */ - public batchUpdateUser( + + /** + * @see {@link BatchUpdateUserCommand} + */ + batchUpdateUser( args: BatchUpdateUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchUpdateUser( - args: BatchUpdateUserCommandInput, - cb: (err: any, data?: BatchUpdateUserCommandOutput) => void - ): void; - public batchUpdateUser( + batchUpdateUser(args: BatchUpdateUserCommandInput, cb: (err: any, data?: BatchUpdateUserCommandOutput) => void): void; + batchUpdateUser( args: BatchUpdateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchUpdateUserCommandOutput) => void ): void; - public batchUpdateUser( - args: BatchUpdateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchUpdateUserCommandOutput) => void), - cb?: (err: any, data?: BatchUpdateUserCommandOutput) => void - ): Promise | void { - const command = new BatchUpdateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon Chime account under the administrator's AWS account. Only Team - * account types are currently supported for this action. For more information about different account types, see - * Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

- */ - public createAccount( - args: CreateAccountCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createAccount( - args: CreateAccountCommandInput, - cb: (err: any, data?: CreateAccountCommandOutput) => void - ): void; - public createAccount( + + /** + * @see {@link CreateAccountCommand} + */ + createAccount(args: CreateAccountCommandInput, options?: __HttpHandlerOptions): Promise; + createAccount(args: CreateAccountCommandInput, cb: (err: any, data?: CreateAccountCommandOutput) => void): void; + createAccount( args: CreateAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccountCommandOutput) => void ): void; - public createAccount( - args: CreateAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAccountCommandOutput) => void), - cb?: (err: any, data?: CreateAccountCommandOutput) => void - ): Promise | void { - const command = new CreateAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. - * CreateAppInstance supports idempotency behavior as described in the AWS API Standard.

- */ - public createAppInstance( + + /** + * @see {@link CreateAppInstanceCommand} + */ + createAppInstance( args: CreateAppInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAppInstance( + createAppInstance( args: CreateAppInstanceCommandInput, cb: (err: any, data?: CreateAppInstanceCommandOutput) => void ): void; - public createAppInstance( + createAppInstance( args: CreateAppInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppInstanceCommandOutput) => void ): void; - public createAppInstance( - args: CreateAppInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAppInstanceCommandOutput) => void), - cb?: (err: any, data?: CreateAppInstanceCommandOutput) => void - ): Promise | void { - const command = new CreateAppInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the following actions. - *

- * - *
    - *
  • - *

    - * ChannelModerator actions across all channels in the AppInstance.

    - *
  • - *
  • - *

    - * DeleteChannelMessage actions.

    - *
  • - *
- * - *

Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.

- */ - public createAppInstanceAdmin( + + /** + * @see {@link CreateAppInstanceAdminCommand} + */ + createAppInstanceAdmin( args: CreateAppInstanceAdminCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAppInstanceAdmin( + createAppInstanceAdmin( args: CreateAppInstanceAdminCommandInput, cb: (err: any, data?: CreateAppInstanceAdminCommandOutput) => void ): void; - public createAppInstanceAdmin( + createAppInstanceAdmin( args: CreateAppInstanceAdminCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppInstanceAdminCommandOutput) => void ): void; - public createAppInstanceAdmin( - args: CreateAppInstanceAdminCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAppInstanceAdminCommandOutput) => void), - cb?: (err: any, data?: CreateAppInstanceAdminCommandOutput) => void - ): Promise | void { - const command = new CreateAppInstanceAdminCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and - * Name for that user.

- */ - public createAppInstanceUser( + + /** + * @see {@link CreateAppInstanceUserCommand} + */ + createAppInstanceUser( args: CreateAppInstanceUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAppInstanceUser( + createAppInstanceUser( args: CreateAppInstanceUserCommandInput, cb: (err: any, data?: CreateAppInstanceUserCommandOutput) => void ): void; - public createAppInstanceUser( + createAppInstanceUser( args: CreateAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppInstanceUserCommandOutput) => void ): void; - public createAppInstanceUser( - args: CreateAppInstanceUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAppInstanceUserCommandOutput) => void), - cb?: (err: any, data?: CreateAppInstanceUserCommandOutput) => void - ): Promise | void { - const command = new CreateAppInstanceUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see - * Using the Amazon Chime SDK - * in the - * Amazon Chime Developer Guide. - *

- */ - public createAttendee( + + /** + * @see {@link CreateAttendeeCommand} + */ + createAttendee( args: CreateAttendeeCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAttendee( - args: CreateAttendeeCommandInput, - cb: (err: any, data?: CreateAttendeeCommandOutput) => void - ): void; - public createAttendee( + createAttendee(args: CreateAttendeeCommandInput, cb: (err: any, data?: CreateAttendeeCommandOutput) => void): void; + createAttendee( args: CreateAttendeeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAttendeeCommandOutput) => void ): void; - public createAttendee( - args: CreateAttendeeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAttendeeCommandOutput) => void), - cb?: (err: any, data?: CreateAttendeeCommandOutput) => void - ): Promise | void { - const command = new CreateAttendeeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a bot for an Amazon Chime Enterprise account.

- */ - public createBot(args: CreateBotCommandInput, options?: __HttpHandlerOptions): Promise; - public createBot(args: CreateBotCommandInput, cb: (err: any, data?: CreateBotCommandOutput) => void): void; - public createBot( + + /** + * @see {@link CreateBotCommand} + */ + createBot(args: CreateBotCommandInput, options?: __HttpHandlerOptions): Promise; + createBot(args: CreateBotCommandInput, cb: (err: any, data?: CreateBotCommandOutput) => void): void; + createBot( args: CreateBotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBotCommandOutput) => void ): void; - public createBot( - args: CreateBotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBotCommandOutput) => void), - cb?: (err: any, data?: CreateBotCommandOutput) => void - ): Promise | void { - const command = new CreateBotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a channel to which you can add users and send messages.

- * - *

- * Restriction: You can't change a channel's - * privacy.

- * - * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public createChannel( - args: CreateChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createChannel( - args: CreateChannelCommandInput, - cb: (err: any, data?: CreateChannelCommandOutput) => void - ): void; - public createChannel( + + /** + * @see {@link CreateChannelCommand} + */ + createChannel(args: CreateChannelCommandInput, options?: __HttpHandlerOptions): Promise; + createChannel(args: CreateChannelCommandInput, cb: (err: any, data?: CreateChannelCommandOutput) => void): void; + createChannel( args: CreateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelCommandOutput) => void ): void; - public createChannel( - args: CreateChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateChannelCommandOutput) => void), - cb?: (err: any, data?: CreateChannelCommandOutput) => void - ): Promise | void { - const command = new CreateChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Permanently bans a member from a channel. Moderators can't add banned members to a - * channel. To undo a ban, you first have to DeleteChannelBan, and then - * CreateChannelMembership. Bans are cleaned up when you delete users or - * channels.

- *

If you ban a user who is already part of a channel, that user is automatically kicked - * from the channel.

- * - * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public createChannelBan( + + /** + * @see {@link CreateChannelBanCommand} + */ + createChannelBan( args: CreateChannelBanCommandInput, options?: __HttpHandlerOptions ): Promise; - public createChannelBan( + createChannelBan( args: CreateChannelBanCommandInput, cb: (err: any, data?: CreateChannelBanCommandOutput) => void ): void; - public createChannelBan( + createChannelBan( args: CreateChannelBanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelBanCommandOutput) => void ): void; - public createChannelBan( - args: CreateChannelBanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateChannelBanCommandOutput) => void), - cb?: (err: any, data?: CreateChannelBanCommandOutput) => void - ): Promise | void { - const command = new CreateChannelBanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds a user to a channel. The InvitedBy response field is derived from the - * request header. A channel member can:

- * - *
    - *
  • - *

    List messages

    - *
  • - *
  • - *

    Send messages

    - *
  • - *
  • - *

    Receive messages

    - *
  • - *
  • - *

    Edit their own messages

    - *
  • - *
  • - *

    Leave the channel

    - *
  • - *
- * - *

Privacy settings impact this action as follows:

- * - *
    - *
  • - *

    Public Channels: You do not need to be a member to list messages, but you must be - * a member to send messages.

    - *
  • - *
  • - *

    Private Channels: You must be a member to list or send messages.

    - *
  • - *
- * - * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public createChannelMembership( + + /** + * @see {@link CreateChannelMembershipCommand} + */ + createChannelMembership( args: CreateChannelMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public createChannelMembership( + createChannelMembership( args: CreateChannelMembershipCommandInput, cb: (err: any, data?: CreateChannelMembershipCommandOutput) => void ): void; - public createChannelMembership( + createChannelMembership( args: CreateChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelMembershipCommandOutput) => void ): void; - public createChannelMembership( - args: CreateChannelMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateChannelMembershipCommandOutput) => void), - cb?: (err: any, data?: CreateChannelMembershipCommandOutput) => void - ): Promise | void { - const command = new CreateChannelMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new ChannelModerator. A channel moderator can:

- * - *
    - *
  • - *

    Add and remove other members of the channel.

    - *
  • - *
  • - *

    Add and remove other moderators of the channel.

    - *
  • - *
  • - *

    Add and remove user bans for the channel.

    - *
  • - *
  • - *

    Redact messages in the channel.

    - *
  • - *
  • - *

    List messages in the channel.

    - *
  • - *
- * - * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public createChannelModerator( + + /** + * @see {@link CreateChannelModeratorCommand} + */ + createChannelModerator( args: CreateChannelModeratorCommandInput, options?: __HttpHandlerOptions ): Promise; - public createChannelModerator( + createChannelModerator( args: CreateChannelModeratorCommandInput, cb: (err: any, data?: CreateChannelModeratorCommandOutput) => void ): void; - public createChannelModerator( + createChannelModerator( args: CreateChannelModeratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelModeratorCommandOutput) => void ): void; - public createChannelModerator( - args: CreateChannelModeratorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateChannelModeratorCommandOutput) => void), - cb?: (err: any, data?: CreateChannelModeratorCommandOutput) => void - ): Promise | void { - const command = new CreateChannelModeratorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a media capture pipeline.

- */ - public createMediaCapturePipeline( + + /** + * @see {@link CreateMediaCapturePipelineCommand} + */ + createMediaCapturePipeline( args: CreateMediaCapturePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMediaCapturePipeline( + createMediaCapturePipeline( args: CreateMediaCapturePipelineCommandInput, cb: (err: any, data?: CreateMediaCapturePipelineCommandOutput) => void ): void; - public createMediaCapturePipeline( + createMediaCapturePipeline( args: CreateMediaCapturePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMediaCapturePipelineCommandOutput) => void ): void; - public createMediaCapturePipeline( - args: CreateMediaCapturePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMediaCapturePipelineCommandOutput) => void), - cb?: (err: any, data?: CreateMediaCapturePipelineCommandOutput) => void - ): Promise | void { - const command = new CreateMediaCapturePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see - * Amazon Chime SDK Media Regions - * in the - * Amazon Chime Developer Guide - * . For more information about the Amazon Chime SDK, see - * Using the Amazon Chime SDK - * in the - * Amazon Chime Developer Guide - * . - *

- */ - public createMeeting( - args: CreateMeetingCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createMeeting( - args: CreateMeetingCommandInput, - cb: (err: any, data?: CreateMeetingCommandOutput) => void - ): void; - public createMeeting( + + /** + * @see {@link CreateMeetingCommand} + */ + createMeeting(args: CreateMeetingCommandInput, options?: __HttpHandlerOptions): Promise; + createMeeting(args: CreateMeetingCommandInput, cb: (err: any, data?: CreateMeetingCommandOutput) => void): void; + createMeeting( args: CreateMeetingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMeetingCommandOutput) => void ): void; - public createMeeting( - args: CreateMeetingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMeetingCommandOutput) => void), - cb?: (err: any, data?: CreateMeetingCommandOutput) => void - ): Promise | void { - const command = new CreateMeetingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public - * switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer.

- * - *

To play welcome audio or implement an interactive voice response (IVR), use the - * CreateSipMediaApplicationCall action with the corresponding SIP media application ID.

- */ - public createMeetingDialOut( + + /** + * @see {@link CreateMeetingDialOutCommand} + */ + createMeetingDialOut( args: CreateMeetingDialOutCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMeetingDialOut( + createMeetingDialOut( args: CreateMeetingDialOutCommandInput, cb: (err: any, data?: CreateMeetingDialOutCommandOutput) => void ): void; - public createMeetingDialOut( + createMeetingDialOut( args: CreateMeetingDialOutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMeetingDialOutCommandOutput) => void ): void; - public createMeetingDialOut( - args: CreateMeetingDialOutCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMeetingDialOutCommandOutput) => void), - cb?: (err: any, data?: CreateMeetingDialOutCommandOutput) => void - ): Promise | void { - const command = new CreateMeetingDialOutCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see - * Amazon Chime SDK Media Regions - * in the - * Amazon Chime Developer Guide - * . For more information about the Amazon Chime SDK, see - * Using the Amazon Chime SDK - * in the - * Amazon Chime Developer Guide - * . - *

- */ - public createMeetingWithAttendees( + + /** + * @see {@link CreateMeetingWithAttendeesCommand} + */ + createMeetingWithAttendees( args: CreateMeetingWithAttendeesCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMeetingWithAttendees( + createMeetingWithAttendees( args: CreateMeetingWithAttendeesCommandInput, cb: (err: any, data?: CreateMeetingWithAttendeesCommandOutput) => void ): void; - public createMeetingWithAttendees( + createMeetingWithAttendees( args: CreateMeetingWithAttendeesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMeetingWithAttendeesCommandOutput) => void ): void; - public createMeetingWithAttendees( - args: CreateMeetingWithAttendeesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMeetingWithAttendeesCommandOutput) => void), - cb?: (err: any, data?: CreateMeetingWithAttendeesCommandOutput) => void - ): Promise | void { - const command = new CreateMeetingWithAttendeesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an order for phone numbers to be provisioned. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. - * For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.

- */ - public createPhoneNumberOrder( + + /** + * @see {@link CreatePhoneNumberOrderCommand} + */ + createPhoneNumberOrder( args: CreatePhoneNumberOrderCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPhoneNumberOrder( + createPhoneNumberOrder( args: CreatePhoneNumberOrderCommandInput, cb: (err: any, data?: CreatePhoneNumberOrderCommandOutput) => void ): void; - public createPhoneNumberOrder( + createPhoneNumberOrder( args: CreatePhoneNumberOrderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePhoneNumberOrderCommandOutput) => void ): void; - public createPhoneNumberOrder( - args: CreatePhoneNumberOrderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePhoneNumberOrderCommandOutput) => void), - cb?: (err: any, data?: CreatePhoneNumberOrderCommandOutput) => void - ): Promise | void { - const command = new CreatePhoneNumberOrderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.

- */ - public createProxySession( + + /** + * @see {@link CreateProxySessionCommand} + */ + createProxySession( args: CreateProxySessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createProxySession( + createProxySession( args: CreateProxySessionCommandInput, cb: (err: any, data?: CreateProxySessionCommandOutput) => void ): void; - public createProxySession( + createProxySession( args: CreateProxySessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProxySessionCommandOutput) => void ): void; - public createProxySession( - args: CreateProxySessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProxySessionCommandOutput) => void), - cb?: (err: any, data?: CreateProxySessionCommandOutput) => void - ): Promise | void { - const command = new CreateProxySessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a chat room for the specified Amazon Chime Enterprise account.

- */ - public createRoom(args: CreateRoomCommandInput, options?: __HttpHandlerOptions): Promise; - public createRoom(args: CreateRoomCommandInput, cb: (err: any, data?: CreateRoomCommandOutput) => void): void; - public createRoom( + + /** + * @see {@link CreateRoomCommand} + */ + createRoom(args: CreateRoomCommandInput, options?: __HttpHandlerOptions): Promise; + createRoom(args: CreateRoomCommandInput, cb: (err: any, data?: CreateRoomCommandOutput) => void): void; + createRoom( args: CreateRoomCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRoomCommandOutput) => void ): void; - public createRoom( - args: CreateRoomCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRoomCommandOutput) => void), - cb?: (err: any, data?: CreateRoomCommandOutput) => void - ): Promise | void { - const command = new CreateRoomCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.

- */ - public createRoomMembership( + + /** + * @see {@link CreateRoomMembershipCommand} + */ + createRoomMembership( args: CreateRoomMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRoomMembership( + createRoomMembership( args: CreateRoomMembershipCommandInput, cb: (err: any, data?: CreateRoomMembershipCommandOutput) => void ): void; - public createRoomMembership( + createRoomMembership( args: CreateRoomMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRoomMembershipCommandOutput) => void ): void; - public createRoomMembership( - args: CreateRoomMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRoomMembershipCommandOutput) => void), - cb?: (err: any, data?: CreateRoomMembershipCommandOutput) => void - ): Promise | void { - const command = new CreateRoomMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a SIP media application.

- */ - public createSipMediaApplication( + + /** + * @see {@link CreateSipMediaApplicationCommand} + */ + createSipMediaApplication( args: CreateSipMediaApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSipMediaApplication( + createSipMediaApplication( args: CreateSipMediaApplicationCommandInput, cb: (err: any, data?: CreateSipMediaApplicationCommandOutput) => void ): void; - public createSipMediaApplication( + createSipMediaApplication( args: CreateSipMediaApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSipMediaApplicationCommandOutput) => void ): void; - public createSipMediaApplication( - args: CreateSipMediaApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSipMediaApplicationCommandOutput) => void), - cb?: (err: any, data?: CreateSipMediaApplicationCommandOutput) => void - ): Promise | void { - const command = new CreateSipMediaApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified - * sipMediaApplicationId.

- */ - public createSipMediaApplicationCall( + + /** + * @see {@link CreateSipMediaApplicationCallCommand} + */ + createSipMediaApplicationCall( args: CreateSipMediaApplicationCallCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSipMediaApplicationCall( + createSipMediaApplicationCall( args: CreateSipMediaApplicationCallCommandInput, cb: (err: any, data?: CreateSipMediaApplicationCallCommandOutput) => void ): void; - public createSipMediaApplicationCall( + createSipMediaApplicationCall( args: CreateSipMediaApplicationCallCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSipMediaApplicationCallCommandOutput) => void ): void; - public createSipMediaApplicationCall( - args: CreateSipMediaApplicationCallCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSipMediaApplicationCallCommandOutput) => void), - cb?: (err: any, data?: CreateSipMediaApplicationCallCommandOutput) => void - ): Promise | void { - const command = new CreateSipMediaApplicationCallCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.

- */ - public createSipRule( - args: CreateSipRuleCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createSipRule( - args: CreateSipRuleCommandInput, - cb: (err: any, data?: CreateSipRuleCommandOutput) => void - ): void; - public createSipRule( + + /** + * @see {@link CreateSipRuleCommand} + */ + createSipRule(args: CreateSipRuleCommandInput, options?: __HttpHandlerOptions): Promise; + createSipRule(args: CreateSipRuleCommandInput, cb: (err: any, data?: CreateSipRuleCommandOutput) => void): void; + createSipRule( args: CreateSipRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSipRuleCommandOutput) => void ): void; - public createSipRule( - args: CreateSipRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSipRuleCommandOutput) => void), - cb?: (err: any, data?: CreateSipRuleCommandOutput) => void - ): Promise | void { - const command = new CreateSipRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a user under the specified Amazon Chime account.

- */ - public createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; - public createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; - public createUser( + + /** + * @see {@link CreateUserCommand} + */ + createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; + createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; + createUser( args: CreateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserCommandOutput) => void ): void; - public createUser( - args: CreateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserCommandOutput) => void), - cb?: (err: any, data?: CreateUserCommandOutput) => void - ): Promise | void { - const command = new CreateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region.

- * - *

- * Enabling - * CreateVoiceConnectorRequest$RequireEncryption - * configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked. - *

- */ - public createVoiceConnector( + + /** + * @see {@link CreateVoiceConnectorCommand} + */ + createVoiceConnector( args: CreateVoiceConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVoiceConnector( + createVoiceConnector( args: CreateVoiceConnectorCommandInput, cb: (err: any, data?: CreateVoiceConnectorCommandOutput) => void ): void; - public createVoiceConnector( + createVoiceConnector( args: CreateVoiceConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVoiceConnectorCommandOutput) => void ): void; - public createVoiceConnector( - args: CreateVoiceConnectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVoiceConnectorCommandOutput) => void), - cb?: (err: any, data?: CreateVoiceConnectorCommandOutput) => void - ): Promise | void { - const command = new CreateVoiceConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can - * associate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by - * including VoiceConnectorItems in the request.

- *

You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This - * creates a fault tolerant mechanism for fallback in case of availability events.

- */ - public createVoiceConnectorGroup( + + /** + * @see {@link CreateVoiceConnectorGroupCommand} + */ + createVoiceConnectorGroup( args: CreateVoiceConnectorGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVoiceConnectorGroup( + createVoiceConnectorGroup( args: CreateVoiceConnectorGroupCommandInput, cb: (err: any, data?: CreateVoiceConnectorGroupCommandOutput) => void ): void; - public createVoiceConnectorGroup( + createVoiceConnectorGroup( args: CreateVoiceConnectorGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVoiceConnectorGroupCommandOutput) => void ): void; - public createVoiceConnectorGroup( - args: CreateVoiceConnectorGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVoiceConnectorGroupCommandOutput) => void), - cb?: (err: any, data?: CreateVoiceConnectorGroupCommandOutput) => void - ): Promise | void { - const command = new CreateVoiceConnectorGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified Amazon Chime account. You must suspend all users before deleting - * Team account. You can use the BatchSuspendUser action - * to dodo.

- * - *

For EnterpriseLWA and EnterpriseAD accounts, you must release the - * claimed domains for your Amazon Chime account before deletion. As soon as you release - * the domain, all users under that account are suspended.

- * - *

Deleted accounts appear in your Disabled accounts list for 90 days. To restore - * deleted account from your Disabled accounts list, you must contact AWS - * Support.

- * - *

After 90 days, deleted accounts are permanently removed from your - * Disabled accounts list.

- */ - public deleteAccount( - args: DeleteAccountCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteAccount( - args: DeleteAccountCommandInput, - cb: (err: any, data?: DeleteAccountCommandOutput) => void - ): void; - public deleteAccount( + + /** + * @see {@link DeleteAccountCommand} + */ + deleteAccount(args: DeleteAccountCommandInput, options?: __HttpHandlerOptions): Promise; + deleteAccount(args: DeleteAccountCommandInput, cb: (err: any, data?: DeleteAccountCommandOutput) => void): void; + deleteAccount( args: DeleteAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccountCommandOutput) => void ): void; - public deleteAccount( - args: DeleteAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAccountCommandOutput) => void), - cb?: (err: any, data?: DeleteAccountCommandOutput) => void - ): Promise | void { - const command = new DeleteAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an AppInstance and all associated data asynchronously.

- */ - public deleteAppInstance( + + /** + * @see {@link DeleteAppInstanceCommand} + */ + deleteAppInstance( args: DeleteAppInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAppInstance( + deleteAppInstance( args: DeleteAppInstanceCommandInput, cb: (err: any, data?: DeleteAppInstanceCommandOutput) => void ): void; - public deleteAppInstance( + deleteAppInstance( args: DeleteAppInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppInstanceCommandOutput) => void ): void; - public deleteAppInstance( - args: DeleteAppInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppInstanceCommandOutput) => void), - cb?: (err: any, data?: DeleteAppInstanceCommandOutput) => void - ): Promise | void { - const command = new DeleteAppInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user.

- */ - public deleteAppInstanceAdmin( + + /** + * @see {@link DeleteAppInstanceAdminCommand} + */ + deleteAppInstanceAdmin( args: DeleteAppInstanceAdminCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAppInstanceAdmin( + deleteAppInstanceAdmin( args: DeleteAppInstanceAdminCommandInput, cb: (err: any, data?: DeleteAppInstanceAdminCommandOutput) => void ): void; - public deleteAppInstanceAdmin( + deleteAppInstanceAdmin( args: DeleteAppInstanceAdminCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppInstanceAdminCommandOutput) => void ): void; - public deleteAppInstanceAdmin( - args: DeleteAppInstanceAdminCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppInstanceAdminCommandOutput) => void), - cb?: (err: any, data?: DeleteAppInstanceAdminCommandOutput) => void - ): Promise | void { - const command = new DeleteAppInstanceAdminCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the streaming configurations of an AppInstance.

- */ - public deleteAppInstanceStreamingConfigurations( + + /** + * @see {@link DeleteAppInstanceStreamingConfigurationsCommand} + */ + deleteAppInstanceStreamingConfigurations( args: DeleteAppInstanceStreamingConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAppInstanceStreamingConfigurations( + deleteAppInstanceStreamingConfigurations( args: DeleteAppInstanceStreamingConfigurationsCommandInput, cb: (err: any, data?: DeleteAppInstanceStreamingConfigurationsCommandOutput) => void ): void; - public deleteAppInstanceStreamingConfigurations( + deleteAppInstanceStreamingConfigurations( args: DeleteAppInstanceStreamingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppInstanceStreamingConfigurationsCommandOutput) => void ): void; - public deleteAppInstanceStreamingConfigurations( - args: DeleteAppInstanceStreamingConfigurationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteAppInstanceStreamingConfigurationsCommandOutput) => void), - cb?: (err: any, data?: DeleteAppInstanceStreamingConfigurationsCommandOutput) => void - ): Promise | void { - const command = new DeleteAppInstanceStreamingConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an AppInstanceUser.

- */ - public deleteAppInstanceUser( + + /** + * @see {@link DeleteAppInstanceUserCommand} + */ + deleteAppInstanceUser( args: DeleteAppInstanceUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAppInstanceUser( + deleteAppInstanceUser( args: DeleteAppInstanceUserCommandInput, cb: (err: any, data?: DeleteAppInstanceUserCommandOutput) => void ): void; - public deleteAppInstanceUser( + deleteAppInstanceUser( args: DeleteAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppInstanceUserCommandOutput) => void ): void; - public deleteAppInstanceUser( - args: DeleteAppInstanceUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppInstanceUserCommandOutput) => void), - cb?: (err: any, data?: DeleteAppInstanceUserCommandOutput) => void - ): Promise | void { - const command = new DeleteAppInstanceUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their - * JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see - * Using the Amazon Chime SDK - * in the Amazon Chime Developer Guide.

- */ - public deleteAttendee( + + /** + * @see {@link DeleteAttendeeCommand} + */ + deleteAttendee( args: DeleteAttendeeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAttendee( - args: DeleteAttendeeCommandInput, - cb: (err: any, data?: DeleteAttendeeCommandOutput) => void - ): void; - public deleteAttendee( + deleteAttendee(args: DeleteAttendeeCommandInput, cb: (err: any, data?: DeleteAttendeeCommandOutput) => void): void; + deleteAttendee( args: DeleteAttendeeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAttendeeCommandOutput) => void ): void; - public deleteAttendee( - args: DeleteAttendeeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAttendeeCommandOutput) => void), - cb?: (err: any, data?: DeleteAttendeeCommandOutput) => void - ): Promise | void { - const command = new DeleteAttendeeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Immediately makes a channel and its memberships inaccessible and marks them for - * deletion. This is an irreversible process.

- * - * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public deleteChannel( - args: DeleteChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteChannel( - args: DeleteChannelCommandInput, - cb: (err: any, data?: DeleteChannelCommandOutput) => void - ): void; - public deleteChannel( + + /** + * @see {@link DeleteChannelCommand} + */ + deleteChannel(args: DeleteChannelCommandInput, options?: __HttpHandlerOptions): Promise; + deleteChannel(args: DeleteChannelCommandInput, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void; + deleteChannel( args: DeleteChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelCommandOutput) => void ): void; - public deleteChannel( - args: DeleteChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteChannelCommandOutput) => void), - cb?: (err: any, data?: DeleteChannelCommandOutput) => void - ): Promise | void { - const command = new DeleteChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a user from a channel's ban list.

- * - * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public deleteChannelBan( + + /** + * @see {@link DeleteChannelBanCommand} + */ + deleteChannelBan( args: DeleteChannelBanCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteChannelBan( + deleteChannelBan( args: DeleteChannelBanCommandInput, cb: (err: any, data?: DeleteChannelBanCommandOutput) => void ): void; - public deleteChannelBan( + deleteChannelBan( args: DeleteChannelBanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelBanCommandOutput) => void ): void; - public deleteChannelBan( - args: DeleteChannelBanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteChannelBanCommandOutput) => void), - cb?: (err: any, data?: DeleteChannelBanCommandOutput) => void - ): Promise | void { - const command = new DeleteChannelBanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a member from a channel.

- * - * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public deleteChannelMembership( + + /** + * @see {@link DeleteChannelMembershipCommand} + */ + deleteChannelMembership( args: DeleteChannelMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteChannelMembership( + deleteChannelMembership( args: DeleteChannelMembershipCommandInput, cb: (err: any, data?: DeleteChannelMembershipCommandOutput) => void ): void; - public deleteChannelMembership( + deleteChannelMembership( args: DeleteChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelMembershipCommandOutput) => void ): void; - public deleteChannelMembership( - args: DeleteChannelMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteChannelMembershipCommandOutput) => void), - cb?: (err: any, data?: DeleteChannelMembershipCommandOutput) => void - ): Promise | void { - const command = new DeleteChannelMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a channel message. Only admins can perform this action. Deletion makes messages - * inaccessible immediately. A background process deletes any revisions created by - * UpdateChannelMessage.

- * - * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public deleteChannelMessage( + + /** + * @see {@link DeleteChannelMessageCommand} + */ + deleteChannelMessage( args: DeleteChannelMessageCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteChannelMessage( + deleteChannelMessage( args: DeleteChannelMessageCommandInput, cb: (err: any, data?: DeleteChannelMessageCommandOutput) => void ): void; - public deleteChannelMessage( + deleteChannelMessage( args: DeleteChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelMessageCommandOutput) => void ): void; - public deleteChannelMessage( - args: DeleteChannelMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteChannelMessageCommandOutput) => void), - cb?: (err: any, data?: DeleteChannelMessageCommandOutput) => void - ): Promise | void { - const command = new DeleteChannelMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a channel moderator.

- * - * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public deleteChannelModerator( + + /** + * @see {@link DeleteChannelModeratorCommand} + */ + deleteChannelModerator( args: DeleteChannelModeratorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteChannelModerator( + deleteChannelModerator( args: DeleteChannelModeratorCommandInput, cb: (err: any, data?: DeleteChannelModeratorCommandOutput) => void ): void; - public deleteChannelModerator( + deleteChannelModerator( args: DeleteChannelModeratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelModeratorCommandOutput) => void ): void; - public deleteChannelModerator( - args: DeleteChannelModeratorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteChannelModeratorCommandOutput) => void), - cb?: (err: any, data?: DeleteChannelModeratorCommandOutput) => void - ): Promise | void { - const command = new DeleteChannelModeratorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the events configuration that allows a bot to receive outgoing events.

- */ - public deleteEventsConfiguration( + + /** + * @see {@link DeleteEventsConfigurationCommand} + */ + deleteEventsConfiguration( args: DeleteEventsConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEventsConfiguration( + deleteEventsConfiguration( args: DeleteEventsConfigurationCommandInput, cb: (err: any, data?: DeleteEventsConfigurationCommandOutput) => void ): void; - public deleteEventsConfiguration( + deleteEventsConfiguration( args: DeleteEventsConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventsConfigurationCommandOutput) => void ): void; - public deleteEventsConfiguration( - args: DeleteEventsConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEventsConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteEventsConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteEventsConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the media capture pipeline.

- */ - public deleteMediaCapturePipeline( + + /** + * @see {@link DeleteMediaCapturePipelineCommand} + */ + deleteMediaCapturePipeline( args: DeleteMediaCapturePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMediaCapturePipeline( + deleteMediaCapturePipeline( args: DeleteMediaCapturePipelineCommandInput, cb: (err: any, data?: DeleteMediaCapturePipelineCommandOutput) => void ): void; - public deleteMediaCapturePipeline( + deleteMediaCapturePipeline( args: DeleteMediaCapturePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMediaCapturePipelineCommandOutput) => void ): void; - public deleteMediaCapturePipeline( - args: DeleteMediaCapturePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMediaCapturePipelineCommandOutput) => void), - cb?: (err: any, data?: DeleteMediaCapturePipelineCommandOutput) => void - ): Promise | void { - const command = new DeleteMediaCapturePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from - * joining the meeting. For more information about the Amazon Chime SDK, see - * Using the Amazon Chime SDK in the - * Amazon Chime Developer Guide.

- */ - public deleteMeeting( - args: DeleteMeetingCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteMeeting( - args: DeleteMeetingCommandInput, - cb: (err: any, data?: DeleteMeetingCommandOutput) => void - ): void; - public deleteMeeting( + + /** + * @see {@link DeleteMeetingCommand} + */ + deleteMeeting(args: DeleteMeetingCommandInput, options?: __HttpHandlerOptions): Promise; + deleteMeeting(args: DeleteMeetingCommandInput, cb: (err: any, data?: DeleteMeetingCommandOutput) => void): void; + deleteMeeting( args: DeleteMeetingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMeetingCommandOutput) => void ): void; - public deleteMeeting( - args: DeleteMeetingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMeetingCommandOutput) => void), - cb?: (err: any, data?: DeleteMeetingCommandOutput) => void - ): Promise | void { - const command = new DeleteMeetingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Moves the specified phone number into the Deletion queue. A - * phone number must be disassociated from any users or Amazon Chime Voice Connectors - * before it can be deleted.

- * - *

Deleted phone numbers remain in the - * Deletion queue - * for 7 days before they are deleted permanently.

- */ - public deletePhoneNumber( + + /** + * @see {@link DeletePhoneNumberCommand} + */ + deletePhoneNumber( args: DeletePhoneNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePhoneNumber( + deletePhoneNumber( args: DeletePhoneNumberCommandInput, cb: (err: any, data?: DeletePhoneNumberCommandOutput) => void ): void; - public deletePhoneNumber( + deletePhoneNumber( args: DeletePhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePhoneNumberCommandOutput) => void ): void; - public deletePhoneNumber( - args: DeletePhoneNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePhoneNumberCommandOutput) => void), - cb?: (err: any, data?: DeletePhoneNumberCommandOutput) => void - ): Promise | void { - const command = new DeletePhoneNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified proxy session from the specified Amazon Chime Voice Connector.

- */ - public deleteProxySession( + + /** + * @see {@link DeleteProxySessionCommand} + */ + deleteProxySession( args: DeleteProxySessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteProxySession( + deleteProxySession( args: DeleteProxySessionCommandInput, cb: (err: any, data?: DeleteProxySessionCommandOutput) => void ): void; - public deleteProxySession( + deleteProxySession( args: DeleteProxySessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProxySessionCommandOutput) => void ): void; - public deleteProxySession( - args: DeleteProxySessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProxySessionCommandOutput) => void), - cb?: (err: any, data?: DeleteProxySessionCommandOutput) => void - ): Promise | void { - const command = new DeleteProxySessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a chat room in an Amazon Chime Enterprise account.

- */ - public deleteRoom(args: DeleteRoomCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteRoom(args: DeleteRoomCommandInput, cb: (err: any, data?: DeleteRoomCommandOutput) => void): void; - public deleteRoom( + + /** + * @see {@link DeleteRoomCommand} + */ + deleteRoom(args: DeleteRoomCommandInput, options?: __HttpHandlerOptions): Promise; + deleteRoom(args: DeleteRoomCommandInput, cb: (err: any, data?: DeleteRoomCommandOutput) => void): void; + deleteRoom( args: DeleteRoomCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRoomCommandOutput) => void ): void; - public deleteRoom( - args: DeleteRoomCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRoomCommandOutput) => void), - cb?: (err: any, data?: DeleteRoomCommandOutput) => void - ): Promise | void { - const command = new DeleteRoomCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a member from a chat room in an Amazon Chime Enterprise account.

- */ - public deleteRoomMembership( + + /** + * @see {@link DeleteRoomMembershipCommand} + */ + deleteRoomMembership( args: DeleteRoomMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRoomMembership( + deleteRoomMembership( args: DeleteRoomMembershipCommandInput, cb: (err: any, data?: DeleteRoomMembershipCommandOutput) => void ): void; - public deleteRoomMembership( + deleteRoomMembership( args: DeleteRoomMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRoomMembershipCommandOutput) => void ): void; - public deleteRoomMembership( - args: DeleteRoomMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRoomMembershipCommandOutput) => void), - cb?: (err: any, data?: DeleteRoomMembershipCommandOutput) => void - ): Promise | void { - const command = new DeleteRoomMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a SIP media application.

- */ - public deleteSipMediaApplication( + + /** + * @see {@link DeleteSipMediaApplicationCommand} + */ + deleteSipMediaApplication( args: DeleteSipMediaApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSipMediaApplication( + deleteSipMediaApplication( args: DeleteSipMediaApplicationCommandInput, cb: (err: any, data?: DeleteSipMediaApplicationCommandOutput) => void ): void; - public deleteSipMediaApplication( + deleteSipMediaApplication( args: DeleteSipMediaApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSipMediaApplicationCommandOutput) => void ): void; - public deleteSipMediaApplication( - args: DeleteSipMediaApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSipMediaApplicationCommandOutput) => void), - cb?: (err: any, data?: DeleteSipMediaApplicationCommandOutput) => void - ): Promise | void { - const command = new DeleteSipMediaApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a SIP rule. You must disable a SIP rule before you can delete it.

- */ - public deleteSipRule( - args: DeleteSipRuleCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteSipRule( - args: DeleteSipRuleCommandInput, - cb: (err: any, data?: DeleteSipRuleCommandOutput) => void - ): void; - public deleteSipRule( + + /** + * @see {@link DeleteSipRuleCommand} + */ + deleteSipRule(args: DeleteSipRuleCommandInput, options?: __HttpHandlerOptions): Promise; + deleteSipRule(args: DeleteSipRuleCommandInput, cb: (err: any, data?: DeleteSipRuleCommandOutput) => void): void; + deleteSipRule( args: DeleteSipRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSipRuleCommandOutput) => void ): void; - public deleteSipRule( - args: DeleteSipRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSipRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteSipRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteSipRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the - * Amazon Chime Voice Connector must be disassociated from it before it can be - * deleted.

- */ - public deleteVoiceConnector( + + /** + * @see {@link DeleteVoiceConnectorCommand} + */ + deleteVoiceConnector( args: DeleteVoiceConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVoiceConnector( + deleteVoiceConnector( args: DeleteVoiceConnectorCommandInput, cb: (err: any, data?: DeleteVoiceConnectorCommandOutput) => void ): void; - public deleteVoiceConnector( + deleteVoiceConnector( args: DeleteVoiceConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVoiceConnectorCommandOutput) => void ): void; - public deleteVoiceConnector( - args: DeleteVoiceConnectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVoiceConnectorCommandOutput) => void), - cb?: (err: any, data?: DeleteVoiceConnectorCommandOutput) => void - ): Promise | void { - const command = new DeleteVoiceConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.

- */ - public deleteVoiceConnectorEmergencyCallingConfiguration( + + /** + * @see {@link DeleteVoiceConnectorEmergencyCallingConfigurationCommand} + */ + deleteVoiceConnectorEmergencyCallingConfiguration( args: DeleteVoiceConnectorEmergencyCallingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVoiceConnectorEmergencyCallingConfiguration( + deleteVoiceConnectorEmergencyCallingConfiguration( args: DeleteVoiceConnectorEmergencyCallingConfigurationCommandInput, cb: (err: any, data?: DeleteVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void ): void; - public deleteVoiceConnectorEmergencyCallingConfiguration( + deleteVoiceConnectorEmergencyCallingConfiguration( args: DeleteVoiceConnectorEmergencyCallingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void ): void; - public deleteVoiceConnectorEmergencyCallingConfiguration( - args: DeleteVoiceConnectorEmergencyCallingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteVoiceConnectorEmergencyCallingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified Amazon Chime Voice Connector group. Any - * VoiceConnectorItems - * and phone numbers associated with the group must be removed before it can be deleted.

- */ - public deleteVoiceConnectorGroup( + + /** + * @see {@link DeleteVoiceConnectorGroupCommand} + */ + deleteVoiceConnectorGroup( args: DeleteVoiceConnectorGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVoiceConnectorGroup( + deleteVoiceConnectorGroup( args: DeleteVoiceConnectorGroupCommandInput, cb: (err: any, data?: DeleteVoiceConnectorGroupCommandOutput) => void ): void; - public deleteVoiceConnectorGroup( + deleteVoiceConnectorGroup( args: DeleteVoiceConnectorGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVoiceConnectorGroupCommandOutput) => void ): void; - public deleteVoiceConnectorGroup( - args: DeleteVoiceConnectorGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVoiceConnectorGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteVoiceConnectorGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteVoiceConnectorGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the origination settings for the specified Amazon Chime Voice Connector.

- * - * - *

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the origination settings.

- *
- */ - public deleteVoiceConnectorOrigination( + + /** + * @see {@link DeleteVoiceConnectorOriginationCommand} + */ + deleteVoiceConnectorOrigination( args: DeleteVoiceConnectorOriginationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVoiceConnectorOrigination( + deleteVoiceConnectorOrigination( args: DeleteVoiceConnectorOriginationCommandInput, cb: (err: any, data?: DeleteVoiceConnectorOriginationCommandOutput) => void ): void; - public deleteVoiceConnectorOrigination( + deleteVoiceConnectorOrigination( args: DeleteVoiceConnectorOriginationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVoiceConnectorOriginationCommandOutput) => void ): void; - public deleteVoiceConnectorOrigination( - args: DeleteVoiceConnectorOriginationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVoiceConnectorOriginationCommandOutput) => void), - cb?: (err: any, data?: DeleteVoiceConnectorOriginationCommandOutput) => void - ): Promise | void { - const command = new DeleteVoiceConnectorOriginationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the proxy configuration from the specified Amazon Chime Voice Connector.

- */ - public deleteVoiceConnectorProxy( + + /** + * @see {@link DeleteVoiceConnectorProxyCommand} + */ + deleteVoiceConnectorProxy( args: DeleteVoiceConnectorProxyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVoiceConnectorProxy( + deleteVoiceConnectorProxy( args: DeleteVoiceConnectorProxyCommandInput, cb: (err: any, data?: DeleteVoiceConnectorProxyCommandOutput) => void ): void; - public deleteVoiceConnectorProxy( + deleteVoiceConnectorProxy( args: DeleteVoiceConnectorProxyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVoiceConnectorProxyCommandOutput) => void ): void; - public deleteVoiceConnectorProxy( - args: DeleteVoiceConnectorProxyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVoiceConnectorProxyCommandOutput) => void), - cb?: (err: any, data?: DeleteVoiceConnectorProxyCommandOutput) => void - ): Promise | void { - const command = new DeleteVoiceConnectorProxyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the streaming configuration for the specified Amazon Chime Voice Connector.

- */ - public deleteVoiceConnectorStreamingConfiguration( + + /** + * @see {@link DeleteVoiceConnectorStreamingConfigurationCommand} + */ + deleteVoiceConnectorStreamingConfiguration( args: DeleteVoiceConnectorStreamingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVoiceConnectorStreamingConfiguration( + deleteVoiceConnectorStreamingConfiguration( args: DeleteVoiceConnectorStreamingConfigurationCommandInput, cb: (err: any, data?: DeleteVoiceConnectorStreamingConfigurationCommandOutput) => void ): void; - public deleteVoiceConnectorStreamingConfiguration( + deleteVoiceConnectorStreamingConfiguration( args: DeleteVoiceConnectorStreamingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVoiceConnectorStreamingConfigurationCommandOutput) => void ): void; - public deleteVoiceConnectorStreamingConfiguration( - args: DeleteVoiceConnectorStreamingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteVoiceConnectorStreamingConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteVoiceConnectorStreamingConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteVoiceConnectorStreamingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the termination settings for the specified Amazon Chime Voice Connector.

- * - * - *

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the termination settings.

- *
- */ - public deleteVoiceConnectorTermination( + + /** + * @see {@link DeleteVoiceConnectorTerminationCommand} + */ + deleteVoiceConnectorTermination( args: DeleteVoiceConnectorTerminationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVoiceConnectorTermination( + deleteVoiceConnectorTermination( args: DeleteVoiceConnectorTerminationCommandInput, cb: (err: any, data?: DeleteVoiceConnectorTerminationCommandOutput) => void ): void; - public deleteVoiceConnectorTermination( + deleteVoiceConnectorTermination( args: DeleteVoiceConnectorTerminationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVoiceConnectorTerminationCommandOutput) => void ): void; - public deleteVoiceConnectorTermination( - args: DeleteVoiceConnectorTerminationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVoiceConnectorTerminationCommandOutput) => void), - cb?: (err: any, data?: DeleteVoiceConnectorTerminationCommandOutput) => void - ): Promise | void { - const command = new DeleteVoiceConnectorTerminationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

- */ - public deleteVoiceConnectorTerminationCredentials( + + /** + * @see {@link DeleteVoiceConnectorTerminationCredentialsCommand} + */ + deleteVoiceConnectorTerminationCredentials( args: DeleteVoiceConnectorTerminationCredentialsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVoiceConnectorTerminationCredentials( + deleteVoiceConnectorTerminationCredentials( args: DeleteVoiceConnectorTerminationCredentialsCommandInput, cb: (err: any, data?: DeleteVoiceConnectorTerminationCredentialsCommandOutput) => void ): void; - public deleteVoiceConnectorTerminationCredentials( + deleteVoiceConnectorTerminationCredentials( args: DeleteVoiceConnectorTerminationCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVoiceConnectorTerminationCredentialsCommandOutput) => void ): void; - public deleteVoiceConnectorTerminationCredentials( - args: DeleteVoiceConnectorTerminationCredentialsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteVoiceConnectorTerminationCredentialsCommandOutput) => void), - cb?: (err: any, data?: DeleteVoiceConnectorTerminationCredentialsCommandOutput) => void - ): Promise | void { - const command = new DeleteVoiceConnectorTerminationCredentialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the full details of an AppInstance.

- */ - public describeAppInstance( + + /** + * @see {@link DescribeAppInstanceCommand} + */ + describeAppInstance( args: DescribeAppInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAppInstance( + describeAppInstance( args: DescribeAppInstanceCommandInput, cb: (err: any, data?: DescribeAppInstanceCommandOutput) => void ): void; - public describeAppInstance( + describeAppInstance( args: DescribeAppInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppInstanceCommandOutput) => void ): void; - public describeAppInstance( - args: DescribeAppInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAppInstanceCommandOutput) => void), - cb?: (err: any, data?: DescribeAppInstanceCommandOutput) => void - ): Promise | void { - const command = new DescribeAppInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the full details of an AppInstanceAdmin.

- */ - public describeAppInstanceAdmin( + + /** + * @see {@link DescribeAppInstanceAdminCommand} + */ + describeAppInstanceAdmin( args: DescribeAppInstanceAdminCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAppInstanceAdmin( + describeAppInstanceAdmin( args: DescribeAppInstanceAdminCommandInput, cb: (err: any, data?: DescribeAppInstanceAdminCommandOutput) => void ): void; - public describeAppInstanceAdmin( + describeAppInstanceAdmin( args: DescribeAppInstanceAdminCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppInstanceAdminCommandOutput) => void ): void; - public describeAppInstanceAdmin( - args: DescribeAppInstanceAdminCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAppInstanceAdminCommandOutput) => void), - cb?: (err: any, data?: DescribeAppInstanceAdminCommandOutput) => void - ): Promise | void { - const command = new DescribeAppInstanceAdminCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the full details of an AppInstanceUser.

- */ - public describeAppInstanceUser( + + /** + * @see {@link DescribeAppInstanceUserCommand} + */ + describeAppInstanceUser( args: DescribeAppInstanceUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAppInstanceUser( + describeAppInstanceUser( args: DescribeAppInstanceUserCommandInput, cb: (err: any, data?: DescribeAppInstanceUserCommandOutput) => void ): void; - public describeAppInstanceUser( + describeAppInstanceUser( args: DescribeAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppInstanceUserCommandOutput) => void ): void; - public describeAppInstanceUser( - args: DescribeAppInstanceUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAppInstanceUserCommandOutput) => void), - cb?: (err: any, data?: DescribeAppInstanceUserCommandOutput) => void - ): Promise | void { - const command = new DescribeAppInstanceUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the full details of a channel in an Amazon Chime - * AppInstance.

- * - * - * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public describeChannel( + + /** + * @see {@link DescribeChannelCommand} + */ + describeChannel( args: DescribeChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeChannel( - args: DescribeChannelCommandInput, - cb: (err: any, data?: DescribeChannelCommandOutput) => void - ): void; - public describeChannel( + describeChannel(args: DescribeChannelCommandInput, cb: (err: any, data?: DescribeChannelCommandOutput) => void): void; + describeChannel( args: DescribeChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelCommandOutput) => void ): void; - public describeChannel( - args: DescribeChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeChannelCommandOutput) => void), - cb?: (err: any, data?: DescribeChannelCommandOutput) => void - ): Promise | void { - const command = new DescribeChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the full details of a channel ban.

- * - * - * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public describeChannelBan( + + /** + * @see {@link DescribeChannelBanCommand} + */ + describeChannelBan( args: DescribeChannelBanCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeChannelBan( + describeChannelBan( args: DescribeChannelBanCommandInput, cb: (err: any, data?: DescribeChannelBanCommandOutput) => void ): void; - public describeChannelBan( + describeChannelBan( args: DescribeChannelBanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelBanCommandOutput) => void ): void; - public describeChannelBan( - args: DescribeChannelBanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeChannelBanCommandOutput) => void), - cb?: (err: any, data?: DescribeChannelBanCommandOutput) => void - ): Promise | void { - const command = new DescribeChannelBanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the full details of a user's channel membership.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public describeChannelMembership( + + /** + * @see {@link DescribeChannelMembershipCommand} + */ + describeChannelMembership( args: DescribeChannelMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeChannelMembership( + describeChannelMembership( args: DescribeChannelMembershipCommandInput, cb: (err: any, data?: DescribeChannelMembershipCommandOutput) => void ): void; - public describeChannelMembership( + describeChannelMembership( args: DescribeChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelMembershipCommandOutput) => void ): void; - public describeChannelMembership( - args: DescribeChannelMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeChannelMembershipCommandOutput) => void), - cb?: (err: any, data?: DescribeChannelMembershipCommandOutput) => void - ): Promise | void { - const command = new DescribeChannelMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the details of a channel based on the membership of the specified - * AppInstanceUser.

- * - * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public describeChannelMembershipForAppInstanceUser( + + /** + * @see {@link DescribeChannelMembershipForAppInstanceUserCommand} + */ + describeChannelMembershipForAppInstanceUser( args: DescribeChannelMembershipForAppInstanceUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeChannelMembershipForAppInstanceUser( + describeChannelMembershipForAppInstanceUser( args: DescribeChannelMembershipForAppInstanceUserCommandInput, cb: (err: any, data?: DescribeChannelMembershipForAppInstanceUserCommandOutput) => void ): void; - public describeChannelMembershipForAppInstanceUser( + describeChannelMembershipForAppInstanceUser( args: DescribeChannelMembershipForAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelMembershipForAppInstanceUserCommandOutput) => void ): void; - public describeChannelMembershipForAppInstanceUser( - args: DescribeChannelMembershipForAppInstanceUserCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeChannelMembershipForAppInstanceUserCommandOutput) => void), - cb?: (err: any, data?: DescribeChannelMembershipForAppInstanceUserCommandOutput) => void - ): Promise | void { - const command = new DescribeChannelMembershipForAppInstanceUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the full details of a channel moderated by the specified - * AppInstanceUser.

- * - * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public describeChannelModeratedByAppInstanceUser( + + /** + * @see {@link DescribeChannelModeratedByAppInstanceUserCommand} + */ + describeChannelModeratedByAppInstanceUser( args: DescribeChannelModeratedByAppInstanceUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeChannelModeratedByAppInstanceUser( + describeChannelModeratedByAppInstanceUser( args: DescribeChannelModeratedByAppInstanceUserCommandInput, cb: (err: any, data?: DescribeChannelModeratedByAppInstanceUserCommandOutput) => void ): void; - public describeChannelModeratedByAppInstanceUser( + describeChannelModeratedByAppInstanceUser( args: DescribeChannelModeratedByAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelModeratedByAppInstanceUserCommandOutput) => void ): void; - public describeChannelModeratedByAppInstanceUser( - args: DescribeChannelModeratedByAppInstanceUserCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeChannelModeratedByAppInstanceUserCommandOutput) => void), - cb?: (err: any, data?: DescribeChannelModeratedByAppInstanceUserCommandOutput) => void - ): Promise | void { - const command = new DescribeChannelModeratedByAppInstanceUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the full details of a single ChannelModerator.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public describeChannelModerator( + + /** + * @see {@link DescribeChannelModeratorCommand} + */ + describeChannelModerator( args: DescribeChannelModeratorCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeChannelModerator( + describeChannelModerator( args: DescribeChannelModeratorCommandInput, cb: (err: any, data?: DescribeChannelModeratorCommandOutput) => void ): void; - public describeChannelModerator( + describeChannelModerator( args: DescribeChannelModeratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelModeratorCommandOutput) => void ): void; - public describeChannelModerator( - args: DescribeChannelModeratorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeChannelModeratorCommandOutput) => void), - cb?: (err: any, data?: DescribeChannelModeratorCommandOutput) => void - ): Promise | void { - const command = new DescribeChannelModeratorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates the primary provisioned phone number from the specified Amazon Chime user.

- */ - public disassociatePhoneNumberFromUser( + + /** + * @see {@link DisassociatePhoneNumberFromUserCommand} + */ + disassociatePhoneNumberFromUser( args: DisassociatePhoneNumberFromUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociatePhoneNumberFromUser( + disassociatePhoneNumberFromUser( args: DisassociatePhoneNumberFromUserCommandInput, cb: (err: any, data?: DisassociatePhoneNumberFromUserCommandOutput) => void ): void; - public disassociatePhoneNumberFromUser( + disassociatePhoneNumberFromUser( args: DisassociatePhoneNumberFromUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociatePhoneNumberFromUserCommandOutput) => void ): void; - public disassociatePhoneNumberFromUser( - args: DisassociatePhoneNumberFromUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociatePhoneNumberFromUserCommandOutput) => void), - cb?: (err: any, data?: DisassociatePhoneNumberFromUserCommandOutput) => void - ): Promise | void { - const command = new DisassociatePhoneNumberFromUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.

- */ - public disassociatePhoneNumbersFromVoiceConnector( + + /** + * @see {@link DisassociatePhoneNumbersFromVoiceConnectorCommand} + */ + disassociatePhoneNumbersFromVoiceConnector( args: DisassociatePhoneNumbersFromVoiceConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociatePhoneNumbersFromVoiceConnector( + disassociatePhoneNumbersFromVoiceConnector( args: DisassociatePhoneNumbersFromVoiceConnectorCommandInput, cb: (err: any, data?: DisassociatePhoneNumbersFromVoiceConnectorCommandOutput) => void ): void; - public disassociatePhoneNumbersFromVoiceConnector( + disassociatePhoneNumbersFromVoiceConnector( args: DisassociatePhoneNumbersFromVoiceConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociatePhoneNumbersFromVoiceConnectorCommandOutput) => void ): void; - public disassociatePhoneNumbersFromVoiceConnector( - args: DisassociatePhoneNumbersFromVoiceConnectorCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociatePhoneNumbersFromVoiceConnectorCommandOutput) => void), - cb?: (err: any, data?: DisassociatePhoneNumbersFromVoiceConnectorCommandOutput) => void - ): Promise | void { - const command = new DisassociatePhoneNumbersFromVoiceConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.

- */ - public disassociatePhoneNumbersFromVoiceConnectorGroup( + + /** + * @see {@link DisassociatePhoneNumbersFromVoiceConnectorGroupCommand} + */ + disassociatePhoneNumbersFromVoiceConnectorGroup( args: DisassociatePhoneNumbersFromVoiceConnectorGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociatePhoneNumbersFromVoiceConnectorGroup( + disassociatePhoneNumbersFromVoiceConnectorGroup( args: DisassociatePhoneNumbersFromVoiceConnectorGroupCommandInput, cb: (err: any, data?: DisassociatePhoneNumbersFromVoiceConnectorGroupCommandOutput) => void ): void; - public disassociatePhoneNumbersFromVoiceConnectorGroup( + disassociatePhoneNumbersFromVoiceConnectorGroup( args: DisassociatePhoneNumbersFromVoiceConnectorGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociatePhoneNumbersFromVoiceConnectorGroupCommandOutput) => void ): void; - public disassociatePhoneNumbersFromVoiceConnectorGroup( - args: DisassociatePhoneNumbersFromVoiceConnectorGroupCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociatePhoneNumbersFromVoiceConnectorGroupCommandOutput) => void), - cb?: (err: any, data?: DisassociatePhoneNumbersFromVoiceConnectorGroupCommandOutput) => void - ): Promise | void { - const command = new DisassociatePhoneNumbersFromVoiceConnectorGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.

- */ - public disassociateSigninDelegateGroupsFromAccount( + + /** + * @see {@link DisassociateSigninDelegateGroupsFromAccountCommand} + */ + disassociateSigninDelegateGroupsFromAccount( args: DisassociateSigninDelegateGroupsFromAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateSigninDelegateGroupsFromAccount( + disassociateSigninDelegateGroupsFromAccount( args: DisassociateSigninDelegateGroupsFromAccountCommandInput, cb: (err: any, data?: DisassociateSigninDelegateGroupsFromAccountCommandOutput) => void ): void; - public disassociateSigninDelegateGroupsFromAccount( + disassociateSigninDelegateGroupsFromAccount( args: DisassociateSigninDelegateGroupsFromAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateSigninDelegateGroupsFromAccountCommandOutput) => void ): void; - public disassociateSigninDelegateGroupsFromAccount( - args: DisassociateSigninDelegateGroupsFromAccountCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociateSigninDelegateGroupsFromAccountCommandOutput) => void), - cb?: (err: any, data?: DisassociateSigninDelegateGroupsFromAccountCommandOutput) => void - ): Promise | void { - const command = new DisassociateSigninDelegateGroupsFromAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves details for the specified Amazon Chime account, such as account type and supported - * licenses.

- */ - public getAccount(args: GetAccountCommandInput, options?: __HttpHandlerOptions): Promise; - public getAccount(args: GetAccountCommandInput, cb: (err: any, data?: GetAccountCommandOutput) => void): void; - public getAccount( + + /** + * @see {@link GetAccountCommand} + */ + getAccount(args: GetAccountCommandInput, options?: __HttpHandlerOptions): Promise; + getAccount(args: GetAccountCommandInput, cb: (err: any, data?: GetAccountCommandOutput) => void): void; + getAccount( args: GetAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountCommandOutput) => void ): void; - public getAccount( - args: GetAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccountCommandOutput) => void), - cb?: (err: any, data?: GetAccountCommandOutput) => void - ): Promise | void { - const command = new GetAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves account settings for the specified Amazon Chime account ID, such as remote control - * and dialout settings. For more information about these settings, see - * Use the Policies Page in the Amazon Chime Administration Guide. - *

- */ - public getAccountSettings( + + /** + * @see {@link GetAccountSettingsCommand} + */ + getAccountSettings( args: GetAccountSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccountSettings( + getAccountSettings( args: GetAccountSettingsCommandInput, cb: (err: any, data?: GetAccountSettingsCommandOutput) => void ): void; - public getAccountSettings( + getAccountSettings( args: GetAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountSettingsCommandOutput) => void ): void; - public getAccountSettings( - args: GetAccountSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccountSettingsCommandOutput) => void), - cb?: (err: any, data?: GetAccountSettingsCommandOutput) => void - ): Promise | void { - const command = new GetAccountSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the retention settings for an AppInstance.

- */ - public getAppInstanceRetentionSettings( + + /** + * @see {@link GetAppInstanceRetentionSettingsCommand} + */ + getAppInstanceRetentionSettings( args: GetAppInstanceRetentionSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAppInstanceRetentionSettings( + getAppInstanceRetentionSettings( args: GetAppInstanceRetentionSettingsCommandInput, cb: (err: any, data?: GetAppInstanceRetentionSettingsCommandOutput) => void ): void; - public getAppInstanceRetentionSettings( + getAppInstanceRetentionSettings( args: GetAppInstanceRetentionSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAppInstanceRetentionSettingsCommandOutput) => void ): void; - public getAppInstanceRetentionSettings( - args: GetAppInstanceRetentionSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAppInstanceRetentionSettingsCommandOutput) => void), - cb?: (err: any, data?: GetAppInstanceRetentionSettingsCommandOutput) => void - ): Promise | void { - const command = new GetAppInstanceRetentionSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the streaming settings for an AppInstance.

- */ - public getAppInstanceStreamingConfigurations( + + /** + * @see {@link GetAppInstanceStreamingConfigurationsCommand} + */ + getAppInstanceStreamingConfigurations( args: GetAppInstanceStreamingConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAppInstanceStreamingConfigurations( + getAppInstanceStreamingConfigurations( args: GetAppInstanceStreamingConfigurationsCommandInput, cb: (err: any, data?: GetAppInstanceStreamingConfigurationsCommandOutput) => void ): void; - public getAppInstanceStreamingConfigurations( + getAppInstanceStreamingConfigurations( args: GetAppInstanceStreamingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAppInstanceStreamingConfigurationsCommandOutput) => void ): void; - public getAppInstanceStreamingConfigurations( - args: GetAppInstanceStreamingConfigurationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetAppInstanceStreamingConfigurationsCommandOutput) => void), - cb?: (err: any, data?: GetAppInstanceStreamingConfigurationsCommandOutput) => void - ): Promise | void { - const command = new GetAppInstanceStreamingConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see - * Using the Amazon Chime SDK - * in the - * Amazon Chime Developer Guide - * . - *

- */ - public getAttendee(args: GetAttendeeCommandInput, options?: __HttpHandlerOptions): Promise; - public getAttendee(args: GetAttendeeCommandInput, cb: (err: any, data?: GetAttendeeCommandOutput) => void): void; - public getAttendee( + + /** + * @see {@link GetAttendeeCommand} + */ + getAttendee(args: GetAttendeeCommandInput, options?: __HttpHandlerOptions): Promise; + getAttendee(args: GetAttendeeCommandInput, cb: (err: any, data?: GetAttendeeCommandOutput) => void): void; + getAttendee( args: GetAttendeeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAttendeeCommandOutput) => void ): void; - public getAttendee( - args: GetAttendeeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAttendeeCommandOutput) => void), - cb?: (err: any, data?: GetAttendeeCommandOutput) => void - ): Promise | void { - const command = new GetAttendeeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.

- */ - public getBot(args: GetBotCommandInput, options?: __HttpHandlerOptions): Promise; - public getBot(args: GetBotCommandInput, cb: (err: any, data?: GetBotCommandOutput) => void): void; - public getBot( + + /** + * @see {@link GetBotCommand} + */ + getBot(args: GetBotCommandInput, options?: __HttpHandlerOptions): Promise; + getBot(args: GetBotCommandInput, cb: (err: any, data?: GetBotCommandOutput) => void): void; + getBot( args: GetBotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBotCommandOutput) => void ): void; - public getBot( - args: GetBotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBotCommandOutput) => void), - cb?: (err: any, data?: GetBotCommandOutput) => void - ): Promise | void { - const command = new GetBotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the full details of a channel message.

- * - * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public getChannelMessage( + + /** + * @see {@link GetChannelMessageCommand} + */ + getChannelMessage( args: GetChannelMessageCommandInput, options?: __HttpHandlerOptions ): Promise; - public getChannelMessage( + getChannelMessage( args: GetChannelMessageCommandInput, cb: (err: any, data?: GetChannelMessageCommandOutput) => void ): void; - public getChannelMessage( + getChannelMessage( args: GetChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelMessageCommandOutput) => void ): void; - public getChannelMessage( - args: GetChannelMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetChannelMessageCommandOutput) => void), - cb?: (err: any, data?: GetChannelMessageCommandOutput) => void - ): Promise | void { - const command = new GetChannelMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.

- */ - public getEventsConfiguration( + + /** + * @see {@link GetEventsConfigurationCommand} + */ + getEventsConfiguration( args: GetEventsConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEventsConfiguration( + getEventsConfiguration( args: GetEventsConfigurationCommandInput, cb: (err: any, data?: GetEventsConfigurationCommandOutput) => void ): void; - public getEventsConfiguration( + getEventsConfiguration( args: GetEventsConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEventsConfigurationCommandOutput) => void ): void; - public getEventsConfiguration( - args: GetEventsConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEventsConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetEventsConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetEventsConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business - * Calling and Amazon Chime Voice Connector settings.

- */ - public getGlobalSettings( + + /** + * @see {@link GetGlobalSettingsCommand} + */ + getGlobalSettings( args: GetGlobalSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getGlobalSettings( + getGlobalSettings( args: GetGlobalSettingsCommandInput, cb: (err: any, data?: GetGlobalSettingsCommandOutput) => void ): void; - public getGlobalSettings( + getGlobalSettings( args: GetGlobalSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGlobalSettingsCommandOutput) => void ): void; - public getGlobalSettings( - args: GetGlobalSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGlobalSettingsCommandOutput) => void), - cb?: (err: any, data?: GetGlobalSettingsCommandOutput) => void - ): Promise | void { - const command = new GetGlobalSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets an existing media capture pipeline.

- */ - public getMediaCapturePipeline( + + /** + * @see {@link GetMediaCapturePipelineCommand} + */ + getMediaCapturePipeline( args: GetMediaCapturePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMediaCapturePipeline( + getMediaCapturePipeline( args: GetMediaCapturePipelineCommandInput, cb: (err: any, data?: GetMediaCapturePipelineCommandOutput) => void ): void; - public getMediaCapturePipeline( + getMediaCapturePipeline( args: GetMediaCapturePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMediaCapturePipelineCommandOutput) => void ): void; - public getMediaCapturePipeline( - args: GetMediaCapturePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMediaCapturePipelineCommandOutput) => void), - cb?: (err: any, data?: GetMediaCapturePipelineCommandOutput) => void - ): Promise | void { - const command = new GetMediaCapturePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see - * Using the Amazon Chime SDK - * in the - * Amazon Chime Developer Guide - * . - *

- */ - public getMeeting(args: GetMeetingCommandInput, options?: __HttpHandlerOptions): Promise; - public getMeeting(args: GetMeetingCommandInput, cb: (err: any, data?: GetMeetingCommandOutput) => void): void; - public getMeeting( + + /** + * @see {@link GetMeetingCommand} + */ + getMeeting(args: GetMeetingCommandInput, options?: __HttpHandlerOptions): Promise; + getMeeting(args: GetMeetingCommandInput, cb: (err: any, data?: GetMeetingCommandOutput) => void): void; + getMeeting( args: GetMeetingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMeetingCommandOutput) => void ): void; - public getMeeting( - args: GetMeetingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMeetingCommandOutput) => void), - cb?: (err: any, data?: GetMeetingCommandOutput) => void - ): Promise | void { - const command = new GetMeetingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

The details of the endpoint for the messaging session.

- */ - public getMessagingSessionEndpoint( + + /** + * @see {@link GetMessagingSessionEndpointCommand} + */ + getMessagingSessionEndpoint( args: GetMessagingSessionEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMessagingSessionEndpoint( + getMessagingSessionEndpoint( args: GetMessagingSessionEndpointCommandInput, cb: (err: any, data?: GetMessagingSessionEndpointCommandOutput) => void ): void; - public getMessagingSessionEndpoint( + getMessagingSessionEndpoint( args: GetMessagingSessionEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMessagingSessionEndpointCommandOutput) => void ): void; - public getMessagingSessionEndpoint( - args: GetMessagingSessionEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMessagingSessionEndpointCommandOutput) => void), - cb?: (err: any, data?: GetMessagingSessionEndpointCommandOutput) => void - ): Promise | void { - const command = new GetMessagingSessionEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

- */ - public getPhoneNumber( + + /** + * @see {@link GetPhoneNumberCommand} + */ + getPhoneNumber( args: GetPhoneNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPhoneNumber( - args: GetPhoneNumberCommandInput, - cb: (err: any, data?: GetPhoneNumberCommandOutput) => void - ): void; - public getPhoneNumber( + getPhoneNumber(args: GetPhoneNumberCommandInput, cb: (err: any, data?: GetPhoneNumberCommandOutput) => void): void; + getPhoneNumber( args: GetPhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPhoneNumberCommandOutput) => void ): void; - public getPhoneNumber( - args: GetPhoneNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPhoneNumberCommandOutput) => void), - cb?: (err: any, data?: GetPhoneNumberCommandOutput) => void - ): Promise | void { - const command = new GetPhoneNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves details for the specified phone number order, such as the order creation timestamp, phone - * numbers in E.164 format, product type, and order status.

- */ - public getPhoneNumberOrder( + + /** + * @see {@link GetPhoneNumberOrderCommand} + */ + getPhoneNumberOrder( args: GetPhoneNumberOrderCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPhoneNumberOrder( + getPhoneNumberOrder( args: GetPhoneNumberOrderCommandInput, cb: (err: any, data?: GetPhoneNumberOrderCommandOutput) => void ): void; - public getPhoneNumberOrder( + getPhoneNumberOrder( args: GetPhoneNumberOrderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPhoneNumberOrderCommandOutput) => void ): void; - public getPhoneNumberOrder( - args: GetPhoneNumberOrderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPhoneNumberOrderCommandOutput) => void), - cb?: (err: any, data?: GetPhoneNumberOrderCommandOutput) => void - ): Promise | void { - const command = new GetPhoneNumberOrderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

- */ - public getPhoneNumberSettings( + + /** + * @see {@link GetPhoneNumberSettingsCommand} + */ + getPhoneNumberSettings( args: GetPhoneNumberSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPhoneNumberSettings( + getPhoneNumberSettings( args: GetPhoneNumberSettingsCommandInput, cb: (err: any, data?: GetPhoneNumberSettingsCommandOutput) => void ): void; - public getPhoneNumberSettings( + getPhoneNumberSettings( args: GetPhoneNumberSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPhoneNumberSettingsCommandOutput) => void ): void; - public getPhoneNumberSettings( - args: GetPhoneNumberSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPhoneNumberSettingsCommandOutput) => void), - cb?: (err: any, data?: GetPhoneNumberSettingsCommandOutput) => void - ): Promise | void { - const command = new GetPhoneNumberSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the specified proxy session details for the specified Amazon Chime Voice Connector.

- */ - public getProxySession( + + /** + * @see {@link GetProxySessionCommand} + */ + getProxySession( args: GetProxySessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getProxySession( - args: GetProxySessionCommandInput, - cb: (err: any, data?: GetProxySessionCommandOutput) => void - ): void; - public getProxySession( + getProxySession(args: GetProxySessionCommandInput, cb: (err: any, data?: GetProxySessionCommandOutput) => void): void; + getProxySession( args: GetProxySessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProxySessionCommandOutput) => void ): void; - public getProxySession( - args: GetProxySessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetProxySessionCommandOutput) => void), - cb?: (err: any, data?: GetProxySessionCommandOutput) => void - ): Promise | void { - const command = new GetProxySessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see - * Managing Chat Retention Policies in the Amazon Chime Administration Guide. - *

- */ - public getRetentionSettings( + + /** + * @see {@link GetRetentionSettingsCommand} + */ + getRetentionSettings( args: GetRetentionSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRetentionSettings( + getRetentionSettings( args: GetRetentionSettingsCommandInput, cb: (err: any, data?: GetRetentionSettingsCommandOutput) => void ): void; - public getRetentionSettings( + getRetentionSettings( args: GetRetentionSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRetentionSettingsCommandOutput) => void ): void; - public getRetentionSettings( - args: GetRetentionSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRetentionSettingsCommandOutput) => void), - cb?: (err: any, data?: GetRetentionSettingsCommandOutput) => void - ): Promise | void { - const command = new GetRetentionSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.

- */ - public getRoom(args: GetRoomCommandInput, options?: __HttpHandlerOptions): Promise; - public getRoom(args: GetRoomCommandInput, cb: (err: any, data?: GetRoomCommandOutput) => void): void; - public getRoom( + + /** + * @see {@link GetRoomCommand} + */ + getRoom(args: GetRoomCommandInput, options?: __HttpHandlerOptions): Promise; + getRoom(args: GetRoomCommandInput, cb: (err: any, data?: GetRoomCommandOutput) => void): void; + getRoom( args: GetRoomCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRoomCommandOutput) => void ): void; - public getRoom( - args: GetRoomCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRoomCommandOutput) => void), - cb?: (err: any, data?: GetRoomCommandOutput) => void - ): Promise | void { - const command = new GetRoomCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

- */ - public getSipMediaApplication( + + /** + * @see {@link GetSipMediaApplicationCommand} + */ + getSipMediaApplication( args: GetSipMediaApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSipMediaApplication( + getSipMediaApplication( args: GetSipMediaApplicationCommandInput, cb: (err: any, data?: GetSipMediaApplicationCommandOutput) => void ): void; - public getSipMediaApplication( + getSipMediaApplication( args: GetSipMediaApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSipMediaApplicationCommandOutput) => void ): void; - public getSipMediaApplication( - args: GetSipMediaApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSipMediaApplicationCommandOutput) => void), - cb?: (err: any, data?: GetSipMediaApplicationCommandOutput) => void - ): Promise | void { - const command = new GetSipMediaApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the logging configuration for the specified SIP media application.

- */ - public getSipMediaApplicationLoggingConfiguration( + + /** + * @see {@link GetSipMediaApplicationLoggingConfigurationCommand} + */ + getSipMediaApplicationLoggingConfiguration( args: GetSipMediaApplicationLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSipMediaApplicationLoggingConfiguration( + getSipMediaApplicationLoggingConfiguration( args: GetSipMediaApplicationLoggingConfigurationCommandInput, cb: (err: any, data?: GetSipMediaApplicationLoggingConfigurationCommandOutput) => void ): void; - public getSipMediaApplicationLoggingConfiguration( + getSipMediaApplicationLoggingConfiguration( args: GetSipMediaApplicationLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSipMediaApplicationLoggingConfigurationCommandOutput) => void ): void; - public getSipMediaApplicationLoggingConfiguration( - args: GetSipMediaApplicationLoggingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetSipMediaApplicationLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetSipMediaApplicationLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetSipMediaApplicationLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

- */ - public getSipRule(args: GetSipRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public getSipRule(args: GetSipRuleCommandInput, cb: (err: any, data?: GetSipRuleCommandOutput) => void): void; - public getSipRule( + + /** + * @see {@link GetSipRuleCommand} + */ + getSipRule(args: GetSipRuleCommandInput, options?: __HttpHandlerOptions): Promise; + getSipRule(args: GetSipRuleCommandInput, cb: (err: any, data?: GetSipRuleCommandOutput) => void): void; + getSipRule( args: GetSipRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSipRuleCommandOutput) => void ): void; - public getSipRule( - args: GetSipRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSipRuleCommandOutput) => void), - cb?: (err: any, data?: GetSipRuleCommandOutput) => void - ): Promise | void { - const command = new GetSipRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.

- * - *

- * To retrieve user details with an email address instead of a user ID, use the - * ListUsers action, and then filter by email address. - *

- */ - public getUser(args: GetUserCommandInput, options?: __HttpHandlerOptions): Promise; - public getUser(args: GetUserCommandInput, cb: (err: any, data?: GetUserCommandOutput) => void): void; - public getUser( + + /** + * @see {@link GetUserCommand} + */ + getUser(args: GetUserCommandInput, options?: __HttpHandlerOptions): Promise; + getUser(args: GetUserCommandInput, cb: (err: any, data?: GetUserCommandOutput) => void): void; + getUser( args: GetUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserCommandOutput) => void ): void; - public getUser( - args: GetUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUserCommandOutput) => void), - cb?: (err: any, data?: GetUserCommandOutput) => void - ): Promise | void { - const command = new GetUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves settings for the specified user ID, such as any associated phone number settings.

- */ - public getUserSettings( + + /** + * @see {@link GetUserSettingsCommand} + */ + getUserSettings( args: GetUserSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUserSettings( - args: GetUserSettingsCommandInput, - cb: (err: any, data?: GetUserSettingsCommandOutput) => void - ): void; - public getUserSettings( + getUserSettings(args: GetUserSettingsCommandInput, cb: (err: any, data?: GetUserSettingsCommandOutput) => void): void; + getUserSettings( args: GetUserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserSettingsCommandOutput) => void ): void; - public getUserSettings( - args: GetUserSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUserSettingsCommandOutput) => void), - cb?: (err: any, data?: GetUserSettingsCommandOutput) => void - ): Promise | void { - const command = new GetUserSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

- */ - public getVoiceConnector( + + /** + * @see {@link GetVoiceConnectorCommand} + */ + getVoiceConnector( args: GetVoiceConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVoiceConnector( + getVoiceConnector( args: GetVoiceConnectorCommandInput, cb: (err: any, data?: GetVoiceConnectorCommandOutput) => void ): void; - public getVoiceConnector( + getVoiceConnector( args: GetVoiceConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceConnectorCommandOutput) => void ): void; - public getVoiceConnector( - args: GetVoiceConnectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVoiceConnectorCommandOutput) => void), - cb?: (err: any, data?: GetVoiceConnectorCommandOutput) => void - ): Promise | void { - const command = new GetVoiceConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.

- */ - public getVoiceConnectorEmergencyCallingConfiguration( + + /** + * @see {@link GetVoiceConnectorEmergencyCallingConfigurationCommand} + */ + getVoiceConnectorEmergencyCallingConfiguration( args: GetVoiceConnectorEmergencyCallingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVoiceConnectorEmergencyCallingConfiguration( + getVoiceConnectorEmergencyCallingConfiguration( args: GetVoiceConnectorEmergencyCallingConfigurationCommandInput, cb: (err: any, data?: GetVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void ): void; - public getVoiceConnectorEmergencyCallingConfiguration( + getVoiceConnectorEmergencyCallingConfiguration( args: GetVoiceConnectorEmergencyCallingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void ): void; - public getVoiceConnectorEmergencyCallingConfiguration( - args: GetVoiceConnectorEmergencyCallingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetVoiceConnectorEmergencyCallingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.

- */ - public getVoiceConnectorGroup( + + /** + * @see {@link GetVoiceConnectorGroupCommand} + */ + getVoiceConnectorGroup( args: GetVoiceConnectorGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVoiceConnectorGroup( + getVoiceConnectorGroup( args: GetVoiceConnectorGroupCommandInput, cb: (err: any, data?: GetVoiceConnectorGroupCommandOutput) => void ): void; - public getVoiceConnectorGroup( + getVoiceConnectorGroup( args: GetVoiceConnectorGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceConnectorGroupCommandOutput) => void ): void; - public getVoiceConnectorGroup( - args: GetVoiceConnectorGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVoiceConnectorGroupCommandOutput) => void), - cb?: (err: any, data?: GetVoiceConnectorGroupCommandOutput) => void - ): Promise | void { - const command = new GetVoiceConnectorGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

- */ - public getVoiceConnectorLoggingConfiguration( + + /** + * @see {@link GetVoiceConnectorLoggingConfigurationCommand} + */ + getVoiceConnectorLoggingConfiguration( args: GetVoiceConnectorLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVoiceConnectorLoggingConfiguration( + getVoiceConnectorLoggingConfiguration( args: GetVoiceConnectorLoggingConfigurationCommandInput, cb: (err: any, data?: GetVoiceConnectorLoggingConfigurationCommandOutput) => void ): void; - public getVoiceConnectorLoggingConfiguration( + getVoiceConnectorLoggingConfiguration( args: GetVoiceConnectorLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceConnectorLoggingConfigurationCommandOutput) => void ): void; - public getVoiceConnectorLoggingConfiguration( - args: GetVoiceConnectorLoggingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetVoiceConnectorLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetVoiceConnectorLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetVoiceConnectorLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves origination setting details for the specified Amazon Chime Voice Connector.

- */ - public getVoiceConnectorOrigination( + + /** + * @see {@link GetVoiceConnectorOriginationCommand} + */ + getVoiceConnectorOrigination( args: GetVoiceConnectorOriginationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVoiceConnectorOrigination( + getVoiceConnectorOrigination( args: GetVoiceConnectorOriginationCommandInput, cb: (err: any, data?: GetVoiceConnectorOriginationCommandOutput) => void ): void; - public getVoiceConnectorOrigination( + getVoiceConnectorOrigination( args: GetVoiceConnectorOriginationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceConnectorOriginationCommandOutput) => void ): void; - public getVoiceConnectorOrigination( - args: GetVoiceConnectorOriginationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVoiceConnectorOriginationCommandOutput) => void), - cb?: (err: any, data?: GetVoiceConnectorOriginationCommandOutput) => void - ): Promise | void { - const command = new GetVoiceConnectorOriginationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the proxy configuration details for the specified Amazon Chime Voice Connector.

- */ - public getVoiceConnectorProxy( + + /** + * @see {@link GetVoiceConnectorProxyCommand} + */ + getVoiceConnectorProxy( args: GetVoiceConnectorProxyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVoiceConnectorProxy( + getVoiceConnectorProxy( args: GetVoiceConnectorProxyCommandInput, cb: (err: any, data?: GetVoiceConnectorProxyCommandOutput) => void ): void; - public getVoiceConnectorProxy( + getVoiceConnectorProxy( args: GetVoiceConnectorProxyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceConnectorProxyCommandOutput) => void ): void; - public getVoiceConnectorProxy( - args: GetVoiceConnectorProxyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVoiceConnectorProxyCommandOutput) => void), - cb?: (err: any, data?: GetVoiceConnectorProxyCommandOutput) => void - ): Promise | void { - const command = new GetVoiceConnectorProxyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. - * Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows - * the retention period, in hours, for the Amazon Kinesis data.

- */ - public getVoiceConnectorStreamingConfiguration( + + /** + * @see {@link GetVoiceConnectorStreamingConfigurationCommand} + */ + getVoiceConnectorStreamingConfiguration( args: GetVoiceConnectorStreamingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVoiceConnectorStreamingConfiguration( + getVoiceConnectorStreamingConfiguration( args: GetVoiceConnectorStreamingConfigurationCommandInput, cb: (err: any, data?: GetVoiceConnectorStreamingConfigurationCommandOutput) => void ): void; - public getVoiceConnectorStreamingConfiguration( + getVoiceConnectorStreamingConfiguration( args: GetVoiceConnectorStreamingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceConnectorStreamingConfigurationCommandOutput) => void ): void; - public getVoiceConnectorStreamingConfiguration( - args: GetVoiceConnectorStreamingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetVoiceConnectorStreamingConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetVoiceConnectorStreamingConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetVoiceConnectorStreamingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves termination setting details for the specified Amazon Chime Voice Connector.

- */ - public getVoiceConnectorTermination( + + /** + * @see {@link GetVoiceConnectorTerminationCommand} + */ + getVoiceConnectorTermination( args: GetVoiceConnectorTerminationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVoiceConnectorTermination( + getVoiceConnectorTermination( args: GetVoiceConnectorTerminationCommandInput, cb: (err: any, data?: GetVoiceConnectorTerminationCommandOutput) => void ): void; - public getVoiceConnectorTermination( + getVoiceConnectorTermination( args: GetVoiceConnectorTerminationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceConnectorTerminationCommandOutput) => void ): void; - public getVoiceConnectorTermination( - args: GetVoiceConnectorTerminationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVoiceConnectorTerminationCommandOutput) => void), - cb?: (err: any, data?: GetVoiceConnectorTerminationCommandOutput) => void - ): Promise | void { - const command = new GetVoiceConnectorTerminationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about the last time a SIP OPTIONS ping was received from - * your SIP infrastructure for the specified Amazon Chime Voice Connector.

- */ - public getVoiceConnectorTerminationHealth( + + /** + * @see {@link GetVoiceConnectorTerminationHealthCommand} + */ + getVoiceConnectorTerminationHealth( args: GetVoiceConnectorTerminationHealthCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVoiceConnectorTerminationHealth( + getVoiceConnectorTerminationHealth( args: GetVoiceConnectorTerminationHealthCommandInput, cb: (err: any, data?: GetVoiceConnectorTerminationHealthCommandOutput) => void ): void; - public getVoiceConnectorTerminationHealth( + getVoiceConnectorTerminationHealth( args: GetVoiceConnectorTerminationHealthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceConnectorTerminationHealthCommandOutput) => void ): void; - public getVoiceConnectorTerminationHealth( - args: GetVoiceConnectorTerminationHealthCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVoiceConnectorTerminationHealthCommandOutput) => void), - cb?: (err: any, data?: GetVoiceConnectorTerminationHealthCommandOutput) => void - ): Promise | void { - const command = new GetVoiceConnectorTerminationHealthCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime - * Team account. Only Team account types are currently - * supported for this action.

- */ - public inviteUsers(args: InviteUsersCommandInput, options?: __HttpHandlerOptions): Promise; - public inviteUsers(args: InviteUsersCommandInput, cb: (err: any, data?: InviteUsersCommandOutput) => void): void; - public inviteUsers( + + /** + * @see {@link InviteUsersCommand} + */ + inviteUsers(args: InviteUsersCommandInput, options?: __HttpHandlerOptions): Promise; + inviteUsers(args: InviteUsersCommandInput, cb: (err: any, data?: InviteUsersCommandOutput) => void): void; + inviteUsers( args: InviteUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InviteUsersCommandOutput) => void ): void; - public inviteUsers( - args: InviteUsersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InviteUsersCommandOutput) => void), - cb?: (err: any, data?: InviteUsersCommandOutput) => void - ): Promise | void { - const command = new InviteUsersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts - * by account name prefix. To find out which Amazon Chime account a user belongs to, you can - * filter by the user's email address, which returns one account result.

- */ - public listAccounts( - args: ListAccountsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listAccounts(args: ListAccountsCommandInput, cb: (err: any, data?: ListAccountsCommandOutput) => void): void; - public listAccounts( + + /** + * @see {@link ListAccountsCommand} + */ + listAccounts(args: ListAccountsCommandInput, options?: __HttpHandlerOptions): Promise; + listAccounts(args: ListAccountsCommandInput, cb: (err: any, data?: ListAccountsCommandOutput) => void): void; + listAccounts( args: ListAccountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccountsCommandOutput) => void ): void; - public listAccounts( - args: ListAccountsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccountsCommandOutput) => void), - cb?: (err: any, data?: ListAccountsCommandOutput) => void - ): Promise | void { - const command = new ListAccountsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of the administrators in the AppInstance.

- */ - public listAppInstanceAdmins( + + /** + * @see {@link ListAppInstanceAdminsCommand} + */ + listAppInstanceAdmins( args: ListAppInstanceAdminsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAppInstanceAdmins( + listAppInstanceAdmins( args: ListAppInstanceAdminsCommandInput, cb: (err: any, data?: ListAppInstanceAdminsCommandOutput) => void ): void; - public listAppInstanceAdmins( + listAppInstanceAdmins( args: ListAppInstanceAdminsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppInstanceAdminsCommandOutput) => void ): void; - public listAppInstanceAdmins( - args: ListAppInstanceAdminsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppInstanceAdminsCommandOutput) => void), - cb?: (err: any, data?: ListAppInstanceAdminsCommandOutput) => void - ): Promise | void { - const command = new ListAppInstanceAdminsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all Amazon Chime AppInstances created under a single AWS account.

- */ - public listAppInstances( + + /** + * @see {@link ListAppInstancesCommand} + */ + listAppInstances( args: ListAppInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAppInstances( + listAppInstances( args: ListAppInstancesCommandInput, cb: (err: any, data?: ListAppInstancesCommandOutput) => void ): void; - public listAppInstances( + listAppInstances( args: ListAppInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppInstancesCommandOutput) => void ): void; - public listAppInstances( - args: ListAppInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppInstancesCommandOutput) => void), - cb?: (err: any, data?: ListAppInstancesCommandOutput) => void - ): Promise | void { - const command = new ListAppInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List all AppInstanceUsers - * created under a single AppInstance. - *

- */ - public listAppInstanceUsers( + + /** + * @see {@link ListAppInstanceUsersCommand} + */ + listAppInstanceUsers( args: ListAppInstanceUsersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAppInstanceUsers( + listAppInstanceUsers( args: ListAppInstanceUsersCommandInput, cb: (err: any, data?: ListAppInstanceUsersCommandOutput) => void ): void; - public listAppInstanceUsers( + listAppInstanceUsers( args: ListAppInstanceUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppInstanceUsersCommandOutput) => void ): void; - public listAppInstanceUsers( - args: ListAppInstanceUsersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppInstanceUsersCommandOutput) => void), - cb?: (err: any, data?: ListAppInstanceUsersCommandOutput) => void - ): Promise | void { - const command = new ListAppInstanceUsersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see - * Using the Amazon Chime SDK - * in the Amazon Chime Developer Guide. - *

- */ - public listAttendees( - args: ListAttendeesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listAttendees( - args: ListAttendeesCommandInput, - cb: (err: any, data?: ListAttendeesCommandOutput) => void - ): void; - public listAttendees( + + /** + * @see {@link ListAttendeesCommand} + */ + listAttendees(args: ListAttendeesCommandInput, options?: __HttpHandlerOptions): Promise; + listAttendees(args: ListAttendeesCommandInput, cb: (err: any, data?: ListAttendeesCommandOutput) => void): void; + listAttendees( args: ListAttendeesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAttendeesCommandOutput) => void ): void; - public listAttendees( - args: ListAttendeesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAttendeesCommandOutput) => void), - cb?: (err: any, data?: ListAttendeesCommandOutput) => void - ): Promise | void { - const command = new ListAttendeesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the tags applied to an Amazon Chime SDK attendee resource.

- */ - public listAttendeeTags( + + /** + * @see {@link ListAttendeeTagsCommand} + */ + listAttendeeTags( args: ListAttendeeTagsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAttendeeTags( + listAttendeeTags( args: ListAttendeeTagsCommandInput, cb: (err: any, data?: ListAttendeeTagsCommandOutput) => void ): void; - public listAttendeeTags( + listAttendeeTags( args: ListAttendeeTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAttendeeTagsCommandOutput) => void ): void; - public listAttendeeTags( - args: ListAttendeeTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAttendeeTagsCommandOutput) => void), - cb?: (err: any, data?: ListAttendeeTagsCommandOutput) => void - ): Promise | void { - const command = new ListAttendeeTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

- */ - public listBots(args: ListBotsCommandInput, options?: __HttpHandlerOptions): Promise; - public listBots(args: ListBotsCommandInput, cb: (err: any, data?: ListBotsCommandOutput) => void): void; - public listBots( + + /** + * @see {@link ListBotsCommand} + */ + listBots(args: ListBotsCommandInput, options?: __HttpHandlerOptions): Promise; + listBots(args: ListBotsCommandInput, cb: (err: any, data?: ListBotsCommandOutput) => void): void; + listBots( args: ListBotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBotsCommandOutput) => void ): void; - public listBots( - args: ListBotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBotsCommandOutput) => void), - cb?: (err: any, data?: ListBotsCommandOutput) => void - ): Promise | void { - const command = new ListBotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all the users banned from a particular channel.

- * - * - * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public listChannelBans( + + /** + * @see {@link ListChannelBansCommand} + */ + listChannelBans( args: ListChannelBansCommandInput, options?: __HttpHandlerOptions ): Promise; - public listChannelBans( - args: ListChannelBansCommandInput, - cb: (err: any, data?: ListChannelBansCommandOutput) => void - ): void; - public listChannelBans( + listChannelBans(args: ListChannelBansCommandInput, cb: (err: any, data?: ListChannelBansCommandOutput) => void): void; + listChannelBans( args: ListChannelBansCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelBansCommandOutput) => void ): void; - public listChannelBans( - args: ListChannelBansCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListChannelBansCommandOutput) => void), - cb?: (err: any, data?: ListChannelBansCommandOutput) => void - ): Promise | void { - const command = new ListChannelBansCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all channel memberships in a channel.

- * - * - * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public listChannelMemberships( + + /** + * @see {@link ListChannelMembershipsCommand} + */ + listChannelMemberships( args: ListChannelMembershipsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listChannelMemberships( + listChannelMemberships( args: ListChannelMembershipsCommandInput, cb: (err: any, data?: ListChannelMembershipsCommandOutput) => void ): void; - public listChannelMemberships( + listChannelMemberships( args: ListChannelMembershipsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelMembershipsCommandOutput) => void ): void; - public listChannelMemberships( - args: ListChannelMembershipsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListChannelMembershipsCommandOutput) => void), - cb?: (err: any, data?: ListChannelMembershipsCommandOutput) => void - ): Promise | void { - const command = new ListChannelMembershipsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all channels that a particular AppInstanceUser is a part of. Only an - * AppInstanceAdmin can call the API with a user ARN that is not their own.

- * - * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public listChannelMembershipsForAppInstanceUser( + + /** + * @see {@link ListChannelMembershipsForAppInstanceUserCommand} + */ + listChannelMembershipsForAppInstanceUser( args: ListChannelMembershipsForAppInstanceUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public listChannelMembershipsForAppInstanceUser( + listChannelMembershipsForAppInstanceUser( args: ListChannelMembershipsForAppInstanceUserCommandInput, cb: (err: any, data?: ListChannelMembershipsForAppInstanceUserCommandOutput) => void ): void; - public listChannelMembershipsForAppInstanceUser( + listChannelMembershipsForAppInstanceUser( args: ListChannelMembershipsForAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelMembershipsForAppInstanceUserCommandOutput) => void ): void; - public listChannelMembershipsForAppInstanceUser( - args: ListChannelMembershipsForAppInstanceUserCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListChannelMembershipsForAppInstanceUserCommandOutput) => void), - cb?: (err: any, data?: ListChannelMembershipsForAppInstanceUserCommandOutput) => void - ): Promise | void { - const command = new ListChannelMembershipsForAppInstanceUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List all the messages in a channel. Returns a paginated list of - * ChannelMessages. By default, sorted by creation timestamp in descending - * order.

- * - *

Redacted messages appear in the results as empty, since they are only redacted, not - * deleted. Deleted messages do not appear in the results. This action always returns the - * latest version of an edited message.

- *

Also, the x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public listChannelMessages( + + /** + * @see {@link ListChannelMessagesCommand} + */ + listChannelMessages( args: ListChannelMessagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listChannelMessages( + listChannelMessages( args: ListChannelMessagesCommandInput, cb: (err: any, data?: ListChannelMessagesCommandOutput) => void ): void; - public listChannelMessages( + listChannelMessages( args: ListChannelMessagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelMessagesCommandOutput) => void ): void; - public listChannelMessages( - args: ListChannelMessagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListChannelMessagesCommandOutput) => void), - cb?: (err: any, data?: ListChannelMessagesCommandOutput) => void - ): Promise | void { - const command = new ListChannelMessagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all the moderators for a channel.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public listChannelModerators( + + /** + * @see {@link ListChannelModeratorsCommand} + */ + listChannelModerators( args: ListChannelModeratorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listChannelModerators( + listChannelModerators( args: ListChannelModeratorsCommandInput, cb: (err: any, data?: ListChannelModeratorsCommandOutput) => void ): void; - public listChannelModerators( + listChannelModerators( args: ListChannelModeratorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelModeratorsCommandOutput) => void ): void; - public listChannelModerators( - args: ListChannelModeratorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListChannelModeratorsCommandOutput) => void), - cb?: (err: any, data?: ListChannelModeratorsCommandOutput) => void - ): Promise | void { - const command = new ListChannelModeratorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all Channels created under a single Chime App as a paginated list. You can specify - * filters to narrow results.

- * - *

- * Functionality & restrictions - *

- *
    - *
  • - *

    Use privacy = PUBLIC to retrieve all public channels in the - * account.

    - *
  • - *
  • - *

    Only an AppInstanceAdmin can set privacy = PRIVATE to - * list the private channels in an account.

    - *
  • - *
- * - * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public listChannels( - args: ListChannelsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void; - public listChannels( + + /** + * @see {@link ListChannelsCommand} + */ + listChannels(args: ListChannelsCommandInput, options?: __HttpHandlerOptions): Promise; + listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void; + listChannels( args: ListChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsCommandOutput) => void ): void; - public listChannels( - args: ListChannelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListChannelsCommandOutput) => void), - cb?: (err: any, data?: ListChannelsCommandOutput) => void - ): Promise | void { - const command = new ListChannelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

A list of the channels moderated by an AppInstanceUser.

- * - * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public listChannelsModeratedByAppInstanceUser( + + /** + * @see {@link ListChannelsModeratedByAppInstanceUserCommand} + */ + listChannelsModeratedByAppInstanceUser( args: ListChannelsModeratedByAppInstanceUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public listChannelsModeratedByAppInstanceUser( + listChannelsModeratedByAppInstanceUser( args: ListChannelsModeratedByAppInstanceUserCommandInput, cb: (err: any, data?: ListChannelsModeratedByAppInstanceUserCommandOutput) => void ): void; - public listChannelsModeratedByAppInstanceUser( + listChannelsModeratedByAppInstanceUser( args: ListChannelsModeratedByAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsModeratedByAppInstanceUserCommandOutput) => void ): void; - public listChannelsModeratedByAppInstanceUser( - args: ListChannelsModeratedByAppInstanceUserCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListChannelsModeratedByAppInstanceUserCommandOutput) => void), - cb?: (err: any, data?: ListChannelsModeratedByAppInstanceUserCommandOutput) => void - ): Promise | void { - const command = new ListChannelsModeratedByAppInstanceUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of media capture pipelines.

- */ - public listMediaCapturePipelines( + + /** + * @see {@link ListMediaCapturePipelinesCommand} + */ + listMediaCapturePipelines( args: ListMediaCapturePipelinesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMediaCapturePipelines( + listMediaCapturePipelines( args: ListMediaCapturePipelinesCommandInput, cb: (err: any, data?: ListMediaCapturePipelinesCommandOutput) => void ): void; - public listMediaCapturePipelines( + listMediaCapturePipelines( args: ListMediaCapturePipelinesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMediaCapturePipelinesCommandOutput) => void ): void; - public listMediaCapturePipelines( - args: ListMediaCapturePipelinesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMediaCapturePipelinesCommandOutput) => void), - cb?: (err: any, data?: ListMediaCapturePipelinesCommandOutput) => void - ): Promise | void { - const command = new ListMediaCapturePipelinesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see - * Using the Amazon Chime SDK - * in the Amazon Chime Developer Guide.

- */ - public listMeetings( - args: ListMeetingsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listMeetings(args: ListMeetingsCommandInput, cb: (err: any, data?: ListMeetingsCommandOutput) => void): void; - public listMeetings( + + /** + * @see {@link ListMeetingsCommand} + */ + listMeetings(args: ListMeetingsCommandInput, options?: __HttpHandlerOptions): Promise; + listMeetings(args: ListMeetingsCommandInput, cb: (err: any, data?: ListMeetingsCommandOutput) => void): void; + listMeetings( args: ListMeetingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMeetingsCommandOutput) => void ): void; - public listMeetings( - args: ListMeetingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMeetingsCommandOutput) => void), - cb?: (err: any, data?: ListMeetingsCommandOutput) => void - ): Promise | void { - const command = new ListMeetingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the tags applied to an Amazon Chime SDK meeting resource.

- */ - public listMeetingTags( + + /** + * @see {@link ListMeetingTagsCommand} + */ + listMeetingTags( args: ListMeetingTagsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMeetingTags( - args: ListMeetingTagsCommandInput, - cb: (err: any, data?: ListMeetingTagsCommandOutput) => void - ): void; - public listMeetingTags( + listMeetingTags(args: ListMeetingTagsCommandInput, cb: (err: any, data?: ListMeetingTagsCommandOutput) => void): void; + listMeetingTags( args: ListMeetingTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMeetingTagsCommandOutput) => void ): void; - public listMeetingTags( - args: ListMeetingTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMeetingTagsCommandOutput) => void), - cb?: (err: any, data?: ListMeetingTagsCommandOutput) => void - ): Promise | void { - const command = new ListMeetingTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the phone number orders for the administrator's Amazon Chime account.

- */ - public listPhoneNumberOrders( + + /** + * @see {@link ListPhoneNumberOrdersCommand} + */ + listPhoneNumberOrders( args: ListPhoneNumberOrdersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPhoneNumberOrders( + listPhoneNumberOrders( args: ListPhoneNumberOrdersCommandInput, cb: (err: any, data?: ListPhoneNumberOrdersCommandOutput) => void ): void; - public listPhoneNumberOrders( + listPhoneNumberOrders( args: ListPhoneNumberOrdersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPhoneNumberOrdersCommandOutput) => void ): void; - public listPhoneNumberOrders( - args: ListPhoneNumberOrdersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPhoneNumberOrdersCommandOutput) => void), - cb?: (err: any, data?: ListPhoneNumberOrdersCommandOutput) => void - ): Promise | void { - const command = new ListPhoneNumberOrdersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.

- */ - public listPhoneNumbers( + + /** + * @see {@link ListPhoneNumbersCommand} + */ + listPhoneNumbers( args: ListPhoneNumbersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPhoneNumbers( + listPhoneNumbers( args: ListPhoneNumbersCommandInput, cb: (err: any, data?: ListPhoneNumbersCommandOutput) => void ): void; - public listPhoneNumbers( + listPhoneNumbers( args: ListPhoneNumbersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPhoneNumbersCommandOutput) => void ): void; - public listPhoneNumbers( - args: ListPhoneNumbersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPhoneNumbersCommandOutput) => void), - cb?: (err: any, data?: ListPhoneNumbersCommandOutput) => void - ): Promise | void { - const command = new ListPhoneNumbersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the proxy sessions for the specified Amazon Chime Voice Connector.

- */ - public listProxySessions( + + /** + * @see {@link ListProxySessionsCommand} + */ + listProxySessions( args: ListProxySessionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProxySessions( + listProxySessions( args: ListProxySessionsCommandInput, cb: (err: any, data?: ListProxySessionsCommandOutput) => void ): void; - public listProxySessions( + listProxySessions( args: ListProxySessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProxySessionsCommandOutput) => void ): void; - public listProxySessions( - args: ListProxySessionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProxySessionsCommandOutput) => void), - cb?: (err: any, data?: ListProxySessionsCommandOutput) => void - ): Promise | void { - const command = new ListProxySessionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the membership details for the specified room in an Amazon Chime Enterprise account, - * such as the members' IDs, email addresses, and names.

- */ - public listRoomMemberships( + + /** + * @see {@link ListRoomMembershipsCommand} + */ + listRoomMemberships( args: ListRoomMembershipsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRoomMemberships( + listRoomMemberships( args: ListRoomMembershipsCommandInput, cb: (err: any, data?: ListRoomMembershipsCommandOutput) => void ): void; - public listRoomMemberships( + listRoomMemberships( args: ListRoomMembershipsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRoomMembershipsCommandOutput) => void ): void; - public listRoomMemberships( - args: ListRoomMembershipsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRoomMembershipsCommandOutput) => void), - cb?: (err: any, data?: ListRoomMembershipsCommandOutput) => void - ): Promise | void { - const command = new ListRoomMembershipsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.

- */ - public listRooms(args: ListRoomsCommandInput, options?: __HttpHandlerOptions): Promise; - public listRooms(args: ListRoomsCommandInput, cb: (err: any, data?: ListRoomsCommandOutput) => void): void; - public listRooms( + + /** + * @see {@link ListRoomsCommand} + */ + listRooms(args: ListRoomsCommandInput, options?: __HttpHandlerOptions): Promise; + listRooms(args: ListRoomsCommandInput, cb: (err: any, data?: ListRoomsCommandOutput) => void): void; + listRooms( args: ListRoomsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRoomsCommandOutput) => void ): void; - public listRooms( - args: ListRoomsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRoomsCommandOutput) => void), - cb?: (err: any, data?: ListRoomsCommandOutput) => void - ): Promise | void { - const command = new ListRoomsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the SIP media applications under the administrator's AWS account.

- */ - public listSipMediaApplications( + + /** + * @see {@link ListSipMediaApplicationsCommand} + */ + listSipMediaApplications( args: ListSipMediaApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSipMediaApplications( + listSipMediaApplications( args: ListSipMediaApplicationsCommandInput, cb: (err: any, data?: ListSipMediaApplicationsCommandOutput) => void ): void; - public listSipMediaApplications( + listSipMediaApplications( args: ListSipMediaApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSipMediaApplicationsCommandOutput) => void ): void; - public listSipMediaApplications( - args: ListSipMediaApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSipMediaApplicationsCommandOutput) => void), - cb?: (err: any, data?: ListSipMediaApplicationsCommandOutput) => void - ): Promise | void { - const command = new ListSipMediaApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the SIP rules under the administrator's AWS account.

- */ - public listSipRules( - args: ListSipRulesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listSipRules(args: ListSipRulesCommandInput, cb: (err: any, data?: ListSipRulesCommandOutput) => void): void; - public listSipRules( + + /** + * @see {@link ListSipRulesCommand} + */ + listSipRules(args: ListSipRulesCommandInput, options?: __HttpHandlerOptions): Promise; + listSipRules(args: ListSipRulesCommandInput, cb: (err: any, data?: ListSipRulesCommandOutput) => void): void; + listSipRules( args: ListSipRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSipRulesCommandOutput) => void ): void; - public listSipRules( - args: ListSipRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSipRulesCommandOutput) => void), - cb?: (err: any, data?: ListSipRulesCommandOutput) => void - ): Promise | void { - const command = new ListSipRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists supported phone number countries.

- */ - public listSupportedPhoneNumberCountries( + + /** + * @see {@link ListSupportedPhoneNumberCountriesCommand} + */ + listSupportedPhoneNumberCountries( args: ListSupportedPhoneNumberCountriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSupportedPhoneNumberCountries( + listSupportedPhoneNumberCountries( args: ListSupportedPhoneNumberCountriesCommandInput, cb: (err: any, data?: ListSupportedPhoneNumberCountriesCommandOutput) => void ): void; - public listSupportedPhoneNumberCountries( + listSupportedPhoneNumberCountries( args: ListSupportedPhoneNumberCountriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSupportedPhoneNumberCountriesCommandOutput) => void ): void; - public listSupportedPhoneNumberCountries( - args: ListSupportedPhoneNumberCountriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSupportedPhoneNumberCountriesCommandOutput) => void), - cb?: (err: any, data?: ListSupportedPhoneNumberCountriesCommandOutput) => void - ): Promise | void { - const command = new ListSupportedPhoneNumberCountriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the tags applied to an Amazon Chime SDK meeting resource.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the users that belong to the specified Amazon Chime account. You can specify an email - * address to list only the user that the email address belongs to.

- */ - public listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise; - public listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void; - public listUsers( + + /** + * @see {@link ListUsersCommand} + */ + listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise; + listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void; + listUsers( args: ListUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersCommandOutput) => void ): void; - public listUsers( - args: ListUsersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUsersCommandOutput) => void), - cb?: (err: any, data?: ListUsersCommandOutput) => void - ): Promise | void { - const command = new ListUsersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.

- */ - public listVoiceConnectorGroups( + + /** + * @see {@link ListVoiceConnectorGroupsCommand} + */ + listVoiceConnectorGroups( args: ListVoiceConnectorGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVoiceConnectorGroups( + listVoiceConnectorGroups( args: ListVoiceConnectorGroupsCommandInput, cb: (err: any, data?: ListVoiceConnectorGroupsCommandOutput) => void ): void; - public listVoiceConnectorGroups( + listVoiceConnectorGroups( args: ListVoiceConnectorGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVoiceConnectorGroupsCommandOutput) => void ): void; - public listVoiceConnectorGroups( - args: ListVoiceConnectorGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVoiceConnectorGroupsCommandOutput) => void), - cb?: (err: any, data?: ListVoiceConnectorGroupsCommandOutput) => void - ): Promise | void { - const command = new ListVoiceConnectorGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the Amazon Chime Voice Connectors for the administrator's AWS account.

- */ - public listVoiceConnectors( + + /** + * @see {@link ListVoiceConnectorsCommand} + */ + listVoiceConnectors( args: ListVoiceConnectorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVoiceConnectors( + listVoiceConnectors( args: ListVoiceConnectorsCommandInput, cb: (err: any, data?: ListVoiceConnectorsCommandOutput) => void ): void; - public listVoiceConnectors( + listVoiceConnectors( args: ListVoiceConnectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVoiceConnectorsCommandOutput) => void ): void; - public listVoiceConnectors( - args: ListVoiceConnectorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVoiceConnectorsCommandOutput) => void), - cb?: (err: any, data?: ListVoiceConnectorsCommandOutput) => void - ): Promise | void { - const command = new ListVoiceConnectorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the SIP credentials for the specified Amazon Chime Voice Connector.

- */ - public listVoiceConnectorTerminationCredentials( + + /** + * @see {@link ListVoiceConnectorTerminationCredentialsCommand} + */ + listVoiceConnectorTerminationCredentials( args: ListVoiceConnectorTerminationCredentialsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVoiceConnectorTerminationCredentials( + listVoiceConnectorTerminationCredentials( args: ListVoiceConnectorTerminationCredentialsCommandInput, cb: (err: any, data?: ListVoiceConnectorTerminationCredentialsCommandOutput) => void ): void; - public listVoiceConnectorTerminationCredentials( + listVoiceConnectorTerminationCredentials( args: ListVoiceConnectorTerminationCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVoiceConnectorTerminationCredentialsCommandOutput) => void ): void; - public listVoiceConnectorTerminationCredentials( - args: ListVoiceConnectorTerminationCredentialsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListVoiceConnectorTerminationCredentialsCommandOutput) => void), - cb?: (err: any, data?: ListVoiceConnectorTerminationCredentialsCommandOutput) => void - ): Promise | void { - const command = new ListVoiceConnectorTerminationCredentialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Logs out the specified user from all of the devices they are currently logged into.

- */ - public logoutUser(args: LogoutUserCommandInput, options?: __HttpHandlerOptions): Promise; - public logoutUser(args: LogoutUserCommandInput, cb: (err: any, data?: LogoutUserCommandOutput) => void): void; - public logoutUser( + + /** + * @see {@link LogoutUserCommand} + */ + logoutUser(args: LogoutUserCommandInput, options?: __HttpHandlerOptions): Promise; + logoutUser(args: LogoutUserCommandInput, cb: (err: any, data?: LogoutUserCommandOutput) => void): void; + logoutUser( args: LogoutUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: LogoutUserCommandOutput) => void ): void; - public logoutUser( - args: LogoutUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: LogoutUserCommandOutput) => void), - cb?: (err: any, data?: LogoutUserCommandOutput) => void - ): Promise | void { - const command = new LogoutUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the amount of time in days that a given AppInstance retains data.

- */ - public putAppInstanceRetentionSettings( + + /** + * @see {@link PutAppInstanceRetentionSettingsCommand} + */ + putAppInstanceRetentionSettings( args: PutAppInstanceRetentionSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAppInstanceRetentionSettings( + putAppInstanceRetentionSettings( args: PutAppInstanceRetentionSettingsCommandInput, cb: (err: any, data?: PutAppInstanceRetentionSettingsCommandOutput) => void ): void; - public putAppInstanceRetentionSettings( + putAppInstanceRetentionSettings( args: PutAppInstanceRetentionSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAppInstanceRetentionSettingsCommandOutput) => void ): void; - public putAppInstanceRetentionSettings( - args: PutAppInstanceRetentionSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAppInstanceRetentionSettingsCommandOutput) => void), - cb?: (err: any, data?: PutAppInstanceRetentionSettingsCommandOutput) => void - ): Promise | void { - const command = new PutAppInstanceRetentionSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

The data streaming configurations of an AppInstance.

- */ - public putAppInstanceStreamingConfigurations( + + /** + * @see {@link PutAppInstanceStreamingConfigurationsCommand} + */ + putAppInstanceStreamingConfigurations( args: PutAppInstanceStreamingConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAppInstanceStreamingConfigurations( + putAppInstanceStreamingConfigurations( args: PutAppInstanceStreamingConfigurationsCommandInput, cb: (err: any, data?: PutAppInstanceStreamingConfigurationsCommandOutput) => void ): void; - public putAppInstanceStreamingConfigurations( + putAppInstanceStreamingConfigurations( args: PutAppInstanceStreamingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAppInstanceStreamingConfigurationsCommandOutput) => void ): void; - public putAppInstanceStreamingConfigurations( - args: PutAppInstanceStreamingConfigurationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PutAppInstanceStreamingConfigurationsCommandOutput) => void), - cb?: (err: any, data?: PutAppInstanceStreamingConfigurationsCommandOutput) => void - ): Promise | void { - const command = new PutAppInstanceStreamingConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an events configuration that allows a bot to receive outgoing events sent by Amazon - * Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, - * see Bot.

- */ - public putEventsConfiguration( + + /** + * @see {@link PutEventsConfigurationCommand} + */ + putEventsConfiguration( args: PutEventsConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putEventsConfiguration( + putEventsConfiguration( args: PutEventsConfigurationCommandInput, cb: (err: any, data?: PutEventsConfigurationCommandOutput) => void ): void; - public putEventsConfiguration( + putEventsConfiguration( args: PutEventsConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEventsConfigurationCommandOutput) => void ): void; - public putEventsConfiguration( - args: PutEventsConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutEventsConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutEventsConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutEventsConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see - * Logging Amazon Chime API Calls with AWS CloudTrail - * in the Amazon Chime Administration Guide.

- * - *

- * To turn off existing retention settings, remove the number of days from the corresponding - * RetentionDays - * field in the - * RetentionSettings - * object. For more information about retention settings, see - * Managing Chat Retention Policies - * in the Amazon Chime Administration Guide.

- */ - public putRetentionSettings( + + /** + * @see {@link PutRetentionSettingsCommand} + */ + putRetentionSettings( args: PutRetentionSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putRetentionSettings( + putRetentionSettings( args: PutRetentionSettingsCommandInput, cb: (err: any, data?: PutRetentionSettingsCommandOutput) => void ): void; - public putRetentionSettings( + putRetentionSettings( args: PutRetentionSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRetentionSettingsCommandOutput) => void ): void; - public putRetentionSettings( - args: PutRetentionSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRetentionSettingsCommandOutput) => void), - cb?: (err: any, data?: PutRetentionSettingsCommandOutput) => void - ): Promise | void { - const command = new PutRetentionSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the logging configuration for the specified SIP media application.

- */ - public putSipMediaApplicationLoggingConfiguration( + + /** + * @see {@link PutSipMediaApplicationLoggingConfigurationCommand} + */ + putSipMediaApplicationLoggingConfiguration( args: PutSipMediaApplicationLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putSipMediaApplicationLoggingConfiguration( + putSipMediaApplicationLoggingConfiguration( args: PutSipMediaApplicationLoggingConfigurationCommandInput, cb: (err: any, data?: PutSipMediaApplicationLoggingConfigurationCommandOutput) => void ): void; - public putSipMediaApplicationLoggingConfiguration( + putSipMediaApplicationLoggingConfiguration( args: PutSipMediaApplicationLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSipMediaApplicationLoggingConfigurationCommandOutput) => void ): void; - public putSipMediaApplicationLoggingConfiguration( - args: PutSipMediaApplicationLoggingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PutSipMediaApplicationLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutSipMediaApplicationLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutSipMediaApplicationLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries. Origination and termination settings must be enabled for - * the Amazon Chime Voice Connector before emergency calling can be configured.

- */ - public putVoiceConnectorEmergencyCallingConfiguration( + + /** + * @see {@link PutVoiceConnectorEmergencyCallingConfigurationCommand} + */ + putVoiceConnectorEmergencyCallingConfiguration( args: PutVoiceConnectorEmergencyCallingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putVoiceConnectorEmergencyCallingConfiguration( + putVoiceConnectorEmergencyCallingConfiguration( args: PutVoiceConnectorEmergencyCallingConfigurationCommandInput, cb: (err: any, data?: PutVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void ): void; - public putVoiceConnectorEmergencyCallingConfiguration( + putVoiceConnectorEmergencyCallingConfiguration( args: PutVoiceConnectorEmergencyCallingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void ): void; - public putVoiceConnectorEmergencyCallingConfiguration( - args: PutVoiceConnectorEmergencyCallingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PutVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutVoiceConnectorEmergencyCallingConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutVoiceConnectorEmergencyCallingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

- */ - public putVoiceConnectorLoggingConfiguration( + + /** + * @see {@link PutVoiceConnectorLoggingConfigurationCommand} + */ + putVoiceConnectorLoggingConfiguration( args: PutVoiceConnectorLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putVoiceConnectorLoggingConfiguration( + putVoiceConnectorLoggingConfiguration( args: PutVoiceConnectorLoggingConfigurationCommandInput, cb: (err: any, data?: PutVoiceConnectorLoggingConfigurationCommandOutput) => void ): void; - public putVoiceConnectorLoggingConfiguration( + putVoiceConnectorLoggingConfiguration( args: PutVoiceConnectorLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutVoiceConnectorLoggingConfigurationCommandOutput) => void ): void; - public putVoiceConnectorLoggingConfiguration( - args: PutVoiceConnectorLoggingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PutVoiceConnectorLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutVoiceConnectorLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutVoiceConnectorLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds origination settings for the specified Amazon Chime Voice Connector.

- * - * - *

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off origination settings.

- *
- */ - public putVoiceConnectorOrigination( + + /** + * @see {@link PutVoiceConnectorOriginationCommand} + */ + putVoiceConnectorOrigination( args: PutVoiceConnectorOriginationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putVoiceConnectorOrigination( + putVoiceConnectorOrigination( args: PutVoiceConnectorOriginationCommandInput, cb: (err: any, data?: PutVoiceConnectorOriginationCommandOutput) => void ): void; - public putVoiceConnectorOrigination( + putVoiceConnectorOrigination( args: PutVoiceConnectorOriginationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutVoiceConnectorOriginationCommandOutput) => void ): void; - public putVoiceConnectorOrigination( - args: PutVoiceConnectorOriginationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutVoiceConnectorOriginationCommandOutput) => void), - cb?: (err: any, data?: PutVoiceConnectorOriginationCommandOutput) => void - ): Promise | void { - const command = new PutVoiceConnectorOriginationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.

- */ - public putVoiceConnectorProxy( + + /** + * @see {@link PutVoiceConnectorProxyCommand} + */ + putVoiceConnectorProxy( args: PutVoiceConnectorProxyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putVoiceConnectorProxy( + putVoiceConnectorProxy( args: PutVoiceConnectorProxyCommandInput, cb: (err: any, data?: PutVoiceConnectorProxyCommandOutput) => void ): void; - public putVoiceConnectorProxy( + putVoiceConnectorProxy( args: PutVoiceConnectorProxyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutVoiceConnectorProxyCommandOutput) => void ): void; - public putVoiceConnectorProxy( - args: PutVoiceConnectorProxyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutVoiceConnectorProxyCommandOutput) => void), - cb?: (err: any, data?: PutVoiceConnectorProxyCommandOutput) => void - ): Promise | void { - const command = new PutVoiceConnectorProxyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming - * configuration specifies whether media streaming is enabled for sending to Kinesis. - * It also sets the retention period, in hours, for the Amazon Kinesis data.

- */ - public putVoiceConnectorStreamingConfiguration( + + /** + * @see {@link PutVoiceConnectorStreamingConfigurationCommand} + */ + putVoiceConnectorStreamingConfiguration( args: PutVoiceConnectorStreamingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putVoiceConnectorStreamingConfiguration( + putVoiceConnectorStreamingConfiguration( args: PutVoiceConnectorStreamingConfigurationCommandInput, cb: (err: any, data?: PutVoiceConnectorStreamingConfigurationCommandOutput) => void ): void; - public putVoiceConnectorStreamingConfiguration( + putVoiceConnectorStreamingConfiguration( args: PutVoiceConnectorStreamingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutVoiceConnectorStreamingConfigurationCommandOutput) => void ): void; - public putVoiceConnectorStreamingConfiguration( - args: PutVoiceConnectorStreamingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PutVoiceConnectorStreamingConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutVoiceConnectorStreamingConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutVoiceConnectorStreamingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds termination settings for the specified Amazon Chime Voice Connector.

- * - * - *

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off termination settings.

- *
- */ - public putVoiceConnectorTermination( + + /** + * @see {@link PutVoiceConnectorTerminationCommand} + */ + putVoiceConnectorTermination( args: PutVoiceConnectorTerminationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putVoiceConnectorTermination( + putVoiceConnectorTermination( args: PutVoiceConnectorTerminationCommandInput, cb: (err: any, data?: PutVoiceConnectorTerminationCommandOutput) => void ): void; - public putVoiceConnectorTermination( + putVoiceConnectorTermination( args: PutVoiceConnectorTerminationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutVoiceConnectorTerminationCommandOutput) => void ): void; - public putVoiceConnectorTermination( - args: PutVoiceConnectorTerminationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutVoiceConnectorTerminationCommandOutput) => void), - cb?: (err: any, data?: PutVoiceConnectorTerminationCommandOutput) => void - ): Promise | void { - const command = new PutVoiceConnectorTerminationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds termination SIP credentials for the specified Amazon Chime Voice Connector.

- */ - public putVoiceConnectorTerminationCredentials( + + /** + * @see {@link PutVoiceConnectorTerminationCredentialsCommand} + */ + putVoiceConnectorTerminationCredentials( args: PutVoiceConnectorTerminationCredentialsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putVoiceConnectorTerminationCredentials( + putVoiceConnectorTerminationCredentials( args: PutVoiceConnectorTerminationCredentialsCommandInput, cb: (err: any, data?: PutVoiceConnectorTerminationCredentialsCommandOutput) => void ): void; - public putVoiceConnectorTerminationCredentials( + putVoiceConnectorTerminationCredentials( args: PutVoiceConnectorTerminationCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutVoiceConnectorTerminationCredentialsCommandOutput) => void ): void; - public putVoiceConnectorTerminationCredentials( - args: PutVoiceConnectorTerminationCredentialsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PutVoiceConnectorTerminationCredentialsCommandOutput) => void), - cb?: (err: any, data?: PutVoiceConnectorTerminationCredentialsCommandOutput) => void - ): Promise | void { - const command = new PutVoiceConnectorTerminationCredentialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Redacts message content, but not metadata. The message exists in the back end, but the - * action returns null content, and the state shows as redacted.

- * - * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public redactChannelMessage( + + /** + * @see {@link RedactChannelMessageCommand} + */ + redactChannelMessage( args: RedactChannelMessageCommandInput, options?: __HttpHandlerOptions ): Promise; - public redactChannelMessage( + redactChannelMessage( args: RedactChannelMessageCommandInput, cb: (err: any, data?: RedactChannelMessageCommandOutput) => void ): void; - public redactChannelMessage( + redactChannelMessage( args: RedactChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RedactChannelMessageCommandOutput) => void ): void; - public redactChannelMessage( - args: RedactChannelMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RedactChannelMessageCommandOutput) => void), - cb?: (err: any, data?: RedactChannelMessageCommandOutput) => void - ): Promise | void { - const command = new RedactChannelMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Redacts the specified message from the specified Amazon Chime conversation.

- */ - public redactConversationMessage( + + /** + * @see {@link RedactConversationMessageCommand} + */ + redactConversationMessage( args: RedactConversationMessageCommandInput, options?: __HttpHandlerOptions ): Promise; - public redactConversationMessage( + redactConversationMessage( args: RedactConversationMessageCommandInput, cb: (err: any, data?: RedactConversationMessageCommandOutput) => void ): void; - public redactConversationMessage( + redactConversationMessage( args: RedactConversationMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RedactConversationMessageCommandOutput) => void ): void; - public redactConversationMessage( - args: RedactConversationMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RedactConversationMessageCommandOutput) => void), - cb?: (err: any, data?: RedactConversationMessageCommandOutput) => void - ): Promise | void { - const command = new RedactConversationMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Redacts the specified message from the specified Amazon Chime channel.

- */ - public redactRoomMessage( + + /** + * @see {@link RedactRoomMessageCommand} + */ + redactRoomMessage( args: RedactRoomMessageCommandInput, options?: __HttpHandlerOptions ): Promise; - public redactRoomMessage( + redactRoomMessage( args: RedactRoomMessageCommandInput, cb: (err: any, data?: RedactRoomMessageCommandOutput) => void ): void; - public redactRoomMessage( + redactRoomMessage( args: RedactRoomMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RedactRoomMessageCommandOutput) => void ): void; - public redactRoomMessage( - args: RedactRoomMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RedactRoomMessageCommandOutput) => void), - cb?: (err: any, data?: RedactRoomMessageCommandOutput) => void - ): Promise | void { - const command = new RedactRoomMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Regenerates the security token for a bot.

- */ - public regenerateSecurityToken( + + /** + * @see {@link RegenerateSecurityTokenCommand} + */ + regenerateSecurityToken( args: RegenerateSecurityTokenCommandInput, options?: __HttpHandlerOptions ): Promise; - public regenerateSecurityToken( + regenerateSecurityToken( args: RegenerateSecurityTokenCommandInput, cb: (err: any, data?: RegenerateSecurityTokenCommandOutput) => void ): void; - public regenerateSecurityToken( + regenerateSecurityToken( args: RegenerateSecurityTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegenerateSecurityTokenCommandOutput) => void ): void; - public regenerateSecurityToken( - args: RegenerateSecurityTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegenerateSecurityTokenCommandOutput) => void), - cb?: (err: any, data?: RegenerateSecurityTokenCommandOutput) => void - ): Promise | void { - const command = new RegenerateSecurityTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns - * the User object with the updated personal meeting PIN.

- */ - public resetPersonalPIN( + + /** + * @see {@link ResetPersonalPINCommand} + */ + resetPersonalPIN( args: ResetPersonalPINCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetPersonalPIN( + resetPersonalPIN( args: ResetPersonalPINCommandInput, cb: (err: any, data?: ResetPersonalPINCommandOutput) => void ): void; - public resetPersonalPIN( + resetPersonalPIN( args: ResetPersonalPINCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetPersonalPINCommandOutput) => void ): void; - public resetPersonalPIN( - args: ResetPersonalPINCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetPersonalPINCommandOutput) => void), - cb?: (err: any, data?: ResetPersonalPINCommandOutput) => void - ): Promise | void { - const command = new ResetPersonalPINCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Moves a phone number from the Deletion queue back into the - * phone number Inventory.

- */ - public restorePhoneNumber( + + /** + * @see {@link RestorePhoneNumberCommand} + */ + restorePhoneNumber( args: RestorePhoneNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public restorePhoneNumber( + restorePhoneNumber( args: RestorePhoneNumberCommandInput, cb: (err: any, data?: RestorePhoneNumberCommandOutput) => void ): void; - public restorePhoneNumber( + restorePhoneNumber( args: RestorePhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestorePhoneNumberCommandOutput) => void ): void; - public restorePhoneNumber( - args: RestorePhoneNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestorePhoneNumberCommandOutput) => void), - cb?: (err: any, data?: RestorePhoneNumberCommandOutput) => void - ): Promise | void { - const command = new RestorePhoneNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Searches for phone numbers that can be ordered. For US numbers, provide at least one of - * the following search filters: AreaCode, City, - * State, or TollFreePrefix. If you provide - * City, you must also provide State. Numbers outside the US only - * support the PhoneNumberType filter, which you must use.

- */ - public searchAvailablePhoneNumbers( + + /** + * @see {@link SearchAvailablePhoneNumbersCommand} + */ + searchAvailablePhoneNumbers( args: SearchAvailablePhoneNumbersCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchAvailablePhoneNumbers( + searchAvailablePhoneNumbers( args: SearchAvailablePhoneNumbersCommandInput, cb: (err: any, data?: SearchAvailablePhoneNumbersCommandOutput) => void ): void; - public searchAvailablePhoneNumbers( + searchAvailablePhoneNumbers( args: SearchAvailablePhoneNumbersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchAvailablePhoneNumbersCommandOutput) => void ): void; - public searchAvailablePhoneNumbers( - args: SearchAvailablePhoneNumbersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchAvailablePhoneNumbersCommandOutput) => void), - cb?: (err: any, data?: SearchAvailablePhoneNumbersCommandOutput) => void - ): Promise | void { - const command = new SearchAvailablePhoneNumbersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sends a message to a particular channel that the member is a part of.

- * - * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- * - *

Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. - * CONTROL messages can contain 30 bytes of data and no metadata.

- *
- */ - public sendChannelMessage( + + /** + * @see {@link SendChannelMessageCommand} + */ + sendChannelMessage( args: SendChannelMessageCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendChannelMessage( + sendChannelMessage( args: SendChannelMessageCommandInput, cb: (err: any, data?: SendChannelMessageCommandOutput) => void ): void; - public sendChannelMessage( + sendChannelMessage( args: SendChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendChannelMessageCommandOutput) => void ): void; - public sendChannelMessage( - args: SendChannelMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendChannelMessageCommandOutput) => void), - cb?: (err: any, data?: SendChannelMessageCommandOutput) => void - ): Promise | void { - const command = new SendChannelMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts transcription for the specified meetingId.

- */ - public startMeetingTranscription( + + /** + * @see {@link StartMeetingTranscriptionCommand} + */ + startMeetingTranscription( args: StartMeetingTranscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startMeetingTranscription( + startMeetingTranscription( args: StartMeetingTranscriptionCommandInput, cb: (err: any, data?: StartMeetingTranscriptionCommandOutput) => void ): void; - public startMeetingTranscription( + startMeetingTranscription( args: StartMeetingTranscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMeetingTranscriptionCommandOutput) => void ): void; - public startMeetingTranscription( - args: StartMeetingTranscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartMeetingTranscriptionCommandOutput) => void), - cb?: (err: any, data?: StartMeetingTranscriptionCommandOutput) => void - ): Promise | void { - const command = new StartMeetingTranscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops transcription for the specified meetingId.

- */ - public stopMeetingTranscription( + + /** + * @see {@link StopMeetingTranscriptionCommand} + */ + stopMeetingTranscription( args: StopMeetingTranscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopMeetingTranscription( + stopMeetingTranscription( args: StopMeetingTranscriptionCommandInput, cb: (err: any, data?: StopMeetingTranscriptionCommandOutput) => void ): void; - public stopMeetingTranscription( + stopMeetingTranscription( args: StopMeetingTranscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopMeetingTranscriptionCommandOutput) => void ): void; - public stopMeetingTranscription( - args: StopMeetingTranscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopMeetingTranscriptionCommandOutput) => void), - cb?: (err: any, data?: StopMeetingTranscriptionCommandOutput) => void - ): Promise | void { - const command = new StopMeetingTranscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Applies the specified tags to the specified Amazon Chime SDK attendee.

- */ - public tagAttendee(args: TagAttendeeCommandInput, options?: __HttpHandlerOptions): Promise; - public tagAttendee(args: TagAttendeeCommandInput, cb: (err: any, data?: TagAttendeeCommandOutput) => void): void; - public tagAttendee( + + /** + * @see {@link TagAttendeeCommand} + */ + tagAttendee(args: TagAttendeeCommandInput, options?: __HttpHandlerOptions): Promise; + tagAttendee(args: TagAttendeeCommandInput, cb: (err: any, data?: TagAttendeeCommandOutput) => void): void; + tagAttendee( args: TagAttendeeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagAttendeeCommandOutput) => void ): void; - public tagAttendee( - args: TagAttendeeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagAttendeeCommandOutput) => void), - cb?: (err: any, data?: TagAttendeeCommandOutput) => void - ): Promise | void { - const command = new TagAttendeeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Applies the specified tags to the specified Amazon Chime SDK meeting.

- */ - public tagMeeting(args: TagMeetingCommandInput, options?: __HttpHandlerOptions): Promise; - public tagMeeting(args: TagMeetingCommandInput, cb: (err: any, data?: TagMeetingCommandOutput) => void): void; - public tagMeeting( + + /** + * @see {@link TagMeetingCommand} + */ + tagMeeting(args: TagMeetingCommandInput, options?: __HttpHandlerOptions): Promise; + tagMeeting(args: TagMeetingCommandInput, cb: (err: any, data?: TagMeetingCommandOutput) => void): void; + tagMeeting( args: TagMeetingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagMeetingCommandOutput) => void ): void; - public tagMeeting( - args: TagMeetingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagMeetingCommandOutput) => void), - cb?: (err: any, data?: TagMeetingCommandOutput) => void - ): Promise | void { - const command = new TagMeetingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Applies the specified tags to the specified Amazon Chime SDK meeting resource.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Untags the specified tags from the specified Amazon Chime SDK attendee.

- */ - public untagAttendee( - args: UntagAttendeeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagAttendee( - args: UntagAttendeeCommandInput, - cb: (err: any, data?: UntagAttendeeCommandOutput) => void - ): void; - public untagAttendee( + + /** + * @see {@link UntagAttendeeCommand} + */ + untagAttendee(args: UntagAttendeeCommandInput, options?: __HttpHandlerOptions): Promise; + untagAttendee(args: UntagAttendeeCommandInput, cb: (err: any, data?: UntagAttendeeCommandOutput) => void): void; + untagAttendee( args: UntagAttendeeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagAttendeeCommandOutput) => void ): void; - public untagAttendee( - args: UntagAttendeeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagAttendeeCommandOutput) => void), - cb?: (err: any, data?: UntagAttendeeCommandOutput) => void - ): Promise | void { - const command = new UntagAttendeeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Untags the specified tags from the specified Amazon Chime SDK meeting.

- */ - public untagMeeting( - args: UntagMeetingCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagMeeting(args: UntagMeetingCommandInput, cb: (err: any, data?: UntagMeetingCommandOutput) => void): void; - public untagMeeting( + + /** + * @see {@link UntagMeetingCommand} + */ + untagMeeting(args: UntagMeetingCommandInput, options?: __HttpHandlerOptions): Promise; + untagMeeting(args: UntagMeetingCommandInput, cb: (err: any, data?: UntagMeetingCommandOutput) => void): void; + untagMeeting( args: UntagMeetingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagMeetingCommandOutput) => void ): void; - public untagMeeting( - args: UntagMeetingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagMeetingCommandOutput) => void), - cb?: (err: any, data?: UntagMeetingCommandOutput) => void - ): Promise | void { - const command = new UntagMeetingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Untags the specified tags from the specified Amazon Chime SDK meeting resource.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.

- */ - public updateAccount( - args: UpdateAccountCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateAccount( - args: UpdateAccountCommandInput, - cb: (err: any, data?: UpdateAccountCommandOutput) => void - ): void; - public updateAccount( + + /** + * @see {@link UpdateAccountCommand} + */ + updateAccount(args: UpdateAccountCommandInput, options?: __HttpHandlerOptions): Promise; + updateAccount(args: UpdateAccountCommandInput, cb: (err: any, data?: UpdateAccountCommandOutput) => void): void; + updateAccount( args: UpdateAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccountCommandOutput) => void ): void; - public updateAccount( - args: UpdateAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAccountCommandOutput) => void), - cb?: (err: any, data?: UpdateAccountCommandOutput) => void - ): Promise | void { - const command = new UpdateAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the settings for the specified Amazon Chime account. You can update settings for - * remote control of shared screens, or for the dial-out option. For more information about - * these settings, see Use - * the Policies Page in the Amazon Chime Administration - * Guide.

- */ - public updateAccountSettings( + + /** + * @see {@link UpdateAccountSettingsCommand} + */ + updateAccountSettings( args: UpdateAccountSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAccountSettings( + updateAccountSettings( args: UpdateAccountSettingsCommandInput, cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void ): void; - public updateAccountSettings( + updateAccountSettings( args: UpdateAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void ): void; - public updateAccountSettings( - args: UpdateAccountSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAccountSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateAccountSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateAccountSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates AppInstance metadata.

- */ - public updateAppInstance( + + /** + * @see {@link UpdateAppInstanceCommand} + */ + updateAppInstance( args: UpdateAppInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAppInstance( + updateAppInstance( args: UpdateAppInstanceCommandInput, cb: (err: any, data?: UpdateAppInstanceCommandOutput) => void ): void; - public updateAppInstance( + updateAppInstance( args: UpdateAppInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAppInstanceCommandOutput) => void ): void; - public updateAppInstance( - args: UpdateAppInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAppInstanceCommandOutput) => void), - cb?: (err: any, data?: UpdateAppInstanceCommandOutput) => void - ): Promise | void { - const command = new UpdateAppInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the details of an AppInstanceUser. You can update names and metadata.

- */ - public updateAppInstanceUser( + + /** + * @see {@link UpdateAppInstanceUserCommand} + */ + updateAppInstanceUser( args: UpdateAppInstanceUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAppInstanceUser( + updateAppInstanceUser( args: UpdateAppInstanceUserCommandInput, cb: (err: any, data?: UpdateAppInstanceUserCommandOutput) => void ): void; - public updateAppInstanceUser( + updateAppInstanceUser( args: UpdateAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAppInstanceUserCommandOutput) => void ): void; - public updateAppInstanceUser( - args: UpdateAppInstanceUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAppInstanceUserCommandOutput) => void), - cb?: (err: any, data?: UpdateAppInstanceUserCommandOutput) => void - ): Promise | void { - const command = new UpdateAppInstanceUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.

- */ - public updateBot(args: UpdateBotCommandInput, options?: __HttpHandlerOptions): Promise; - public updateBot(args: UpdateBotCommandInput, cb: (err: any, data?: UpdateBotCommandOutput) => void): void; - public updateBot( + + /** + * @see {@link UpdateBotCommand} + */ + updateBot(args: UpdateBotCommandInput, options?: __HttpHandlerOptions): Promise; + updateBot(args: UpdateBotCommandInput, cb: (err: any, data?: UpdateBotCommandOutput) => void): void; + updateBot( args: UpdateBotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBotCommandOutput) => void ): void; - public updateBot( - args: UpdateBotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBotCommandOutput) => void), - cb?: (err: any, data?: UpdateBotCommandOutput) => void - ): Promise | void { - const command = new UpdateBotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update a channel's attributes.

- *

- * Restriction: You can't change a channel's privacy.

- * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public updateChannel( - args: UpdateChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateChannel( - args: UpdateChannelCommandInput, - cb: (err: any, data?: UpdateChannelCommandOutput) => void - ): void; - public updateChannel( + + /** + * @see {@link UpdateChannelCommand} + */ + updateChannel(args: UpdateChannelCommandInput, options?: __HttpHandlerOptions): Promise; + updateChannel(args: UpdateChannelCommandInput, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void; + updateChannel( args: UpdateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelCommandOutput) => void ): void; - public updateChannel( - args: UpdateChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateChannelCommandOutput) => void), - cb?: (err: any, data?: UpdateChannelCommandOutput) => void - ): Promise | void { - const command = new UpdateChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the content of a message.

- * - * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public updateChannelMessage( + + /** + * @see {@link UpdateChannelMessageCommand} + */ + updateChannelMessage( args: UpdateChannelMessageCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateChannelMessage( + updateChannelMessage( args: UpdateChannelMessageCommandInput, cb: (err: any, data?: UpdateChannelMessageCommandOutput) => void ): void; - public updateChannelMessage( + updateChannelMessage( args: UpdateChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelMessageCommandOutput) => void ): void; - public updateChannelMessage( - args: UpdateChannelMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateChannelMessageCommandOutput) => void), - cb?: (err: any, data?: UpdateChannelMessageCommandOutput) => void - ): Promise | void { - const command = new UpdateChannelMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

The details of the time when a user last read messages in a channel.

- * - * - *

The x-amz-chime-bearer request header is mandatory. Use the - * AppInstanceUserArn of the user that makes the API call as the value in - * the header.

- *
- */ - public updateChannelReadMarker( + + /** + * @see {@link UpdateChannelReadMarkerCommand} + */ + updateChannelReadMarker( args: UpdateChannelReadMarkerCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateChannelReadMarker( + updateChannelReadMarker( args: UpdateChannelReadMarkerCommandInput, cb: (err: any, data?: UpdateChannelReadMarkerCommandOutput) => void ): void; - public updateChannelReadMarker( + updateChannelReadMarker( args: UpdateChannelReadMarkerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelReadMarkerCommandOutput) => void ): void; - public updateChannelReadMarker( - args: UpdateChannelReadMarkerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateChannelReadMarkerCommandOutput) => void), - cb?: (err: any, data?: UpdateChannelReadMarkerCommandOutput) => void - ): Promise | void { - const command = new UpdateChannelReadMarkerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

- */ - public updateGlobalSettings( + + /** + * @see {@link UpdateGlobalSettingsCommand} + */ + updateGlobalSettings( args: UpdateGlobalSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGlobalSettings( + updateGlobalSettings( args: UpdateGlobalSettingsCommandInput, cb: (err: any, data?: UpdateGlobalSettingsCommandOutput) => void ): void; - public updateGlobalSettings( + updateGlobalSettings( args: UpdateGlobalSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGlobalSettingsCommandOutput) => void ): void; - public updateGlobalSettings( - args: UpdateGlobalSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGlobalSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateGlobalSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateGlobalSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.

- *

For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.

- *

Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

- */ - public updatePhoneNumber( + + /** + * @see {@link UpdatePhoneNumberCommand} + */ + updatePhoneNumber( args: UpdatePhoneNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePhoneNumber( + updatePhoneNumber( args: UpdatePhoneNumberCommandInput, cb: (err: any, data?: UpdatePhoneNumberCommandOutput) => void ): void; - public updatePhoneNumber( + updatePhoneNumber( args: UpdatePhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePhoneNumberCommandOutput) => void ): void; - public updatePhoneNumber( - args: UpdatePhoneNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePhoneNumberCommandOutput) => void), - cb?: (err: any, data?: UpdatePhoneNumberCommandOutput) => void - ): Promise | void { - const command = new UpdatePhoneNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the phone number settings for the administrator's AWS account, such as the default - * outbound calling name. You can update the default outbound calling name once every seven - * days. Outbound calling names can take up to 72 hours to update.

- */ - public updatePhoneNumberSettings( + + /** + * @see {@link UpdatePhoneNumberSettingsCommand} + */ + updatePhoneNumberSettings( args: UpdatePhoneNumberSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePhoneNumberSettings( + updatePhoneNumberSettings( args: UpdatePhoneNumberSettingsCommandInput, cb: (err: any, data?: UpdatePhoneNumberSettingsCommandOutput) => void ): void; - public updatePhoneNumberSettings( + updatePhoneNumberSettings( args: UpdatePhoneNumberSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePhoneNumberSettingsCommandOutput) => void ): void; - public updatePhoneNumberSettings( - args: UpdatePhoneNumberSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePhoneNumberSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdatePhoneNumberSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdatePhoneNumberSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the specified proxy session details, such as voice or SMS capabilities.

- */ - public updateProxySession( + + /** + * @see {@link UpdateProxySessionCommand} + */ + updateProxySession( args: UpdateProxySessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateProxySession( + updateProxySession( args: UpdateProxySessionCommandInput, cb: (err: any, data?: UpdateProxySessionCommandOutput) => void ): void; - public updateProxySession( + updateProxySession( args: UpdateProxySessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProxySessionCommandOutput) => void ): void; - public updateProxySession( - args: UpdateProxySessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProxySessionCommandOutput) => void), - cb?: (err: any, data?: UpdateProxySessionCommandOutput) => void - ): Promise | void { - const command = new UpdateProxySessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.

- */ - public updateRoom(args: UpdateRoomCommandInput, options?: __HttpHandlerOptions): Promise; - public updateRoom(args: UpdateRoomCommandInput, cb: (err: any, data?: UpdateRoomCommandOutput) => void): void; - public updateRoom( + + /** + * @see {@link UpdateRoomCommand} + */ + updateRoom(args: UpdateRoomCommandInput, options?: __HttpHandlerOptions): Promise; + updateRoom(args: UpdateRoomCommandInput, cb: (err: any, data?: UpdateRoomCommandOutput) => void): void; + updateRoom( args: UpdateRoomCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRoomCommandOutput) => void ): void; - public updateRoom( - args: UpdateRoomCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRoomCommandOutput) => void), - cb?: (err: any, data?: UpdateRoomCommandOutput) => void - ): Promise | void { - const command = new UpdateRoomCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates room membership details, such as the member role, for a room in an Amazon Chime - * Enterprise account. The member role designates whether the member is a chat room - * administrator or a general chat room member. The member role can be updated only for - * user IDs.

- */ - public updateRoomMembership( + + /** + * @see {@link UpdateRoomMembershipCommand} + */ + updateRoomMembership( args: UpdateRoomMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRoomMembership( + updateRoomMembership( args: UpdateRoomMembershipCommandInput, cb: (err: any, data?: UpdateRoomMembershipCommandOutput) => void ): void; - public updateRoomMembership( + updateRoomMembership( args: UpdateRoomMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRoomMembershipCommandOutput) => void ): void; - public updateRoomMembership( - args: UpdateRoomMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRoomMembershipCommandOutput) => void), - cb?: (err: any, data?: UpdateRoomMembershipCommandOutput) => void - ): Promise | void { - const command = new UpdateRoomMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the details of the specified SIP media application.

- */ - public updateSipMediaApplication( + + /** + * @see {@link UpdateSipMediaApplicationCommand} + */ + updateSipMediaApplication( args: UpdateSipMediaApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSipMediaApplication( + updateSipMediaApplication( args: UpdateSipMediaApplicationCommandInput, cb: (err: any, data?: UpdateSipMediaApplicationCommandOutput) => void ): void; - public updateSipMediaApplication( + updateSipMediaApplication( args: UpdateSipMediaApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSipMediaApplicationCommandOutput) => void ): void; - public updateSipMediaApplication( - args: UpdateSipMediaApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSipMediaApplicationCommandOutput) => void), - cb?: (err: any, data?: UpdateSipMediaApplicationCommandOutput) => void - ): Promise | void { - const command = new UpdateSipMediaApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.

- */ - public updateSipMediaApplicationCall( + + /** + * @see {@link UpdateSipMediaApplicationCallCommand} + */ + updateSipMediaApplicationCall( args: UpdateSipMediaApplicationCallCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSipMediaApplicationCall( + updateSipMediaApplicationCall( args: UpdateSipMediaApplicationCallCommandInput, cb: (err: any, data?: UpdateSipMediaApplicationCallCommandOutput) => void ): void; - public updateSipMediaApplicationCall( + updateSipMediaApplicationCall( args: UpdateSipMediaApplicationCallCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSipMediaApplicationCallCommandOutput) => void ): void; - public updateSipMediaApplicationCall( - args: UpdateSipMediaApplicationCallCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSipMediaApplicationCallCommandOutput) => void), - cb?: (err: any, data?: UpdateSipMediaApplicationCallCommandOutput) => void - ): Promise | void { - const command = new UpdateSipMediaApplicationCallCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the details of the specified SIP rule.

- */ - public updateSipRule( - args: UpdateSipRuleCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateSipRule( - args: UpdateSipRuleCommandInput, - cb: (err: any, data?: UpdateSipRuleCommandOutput) => void - ): void; - public updateSipRule( + + /** + * @see {@link UpdateSipRuleCommand} + */ + updateSipRule(args: UpdateSipRuleCommandInput, options?: __HttpHandlerOptions): Promise; + updateSipRule(args: UpdateSipRuleCommandInput, cb: (err: any, data?: UpdateSipRuleCommandOutput) => void): void; + updateSipRule( args: UpdateSipRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSipRuleCommandOutput) => void ): void; - public updateSipRule( - args: UpdateSipRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSipRuleCommandOutput) => void), - cb?: (err: any, data?: UpdateSipRuleCommandOutput) => void - ): Promise | void { - const command = new UpdateSipRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.

- */ - public updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise; - public updateUser(args: UpdateUserCommandInput, cb: (err: any, data?: UpdateUserCommandOutput) => void): void; - public updateUser( + + /** + * @see {@link UpdateUserCommand} + */ + updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise; + updateUser(args: UpdateUserCommandInput, cb: (err: any, data?: UpdateUserCommandOutput) => void): void; + updateUser( args: UpdateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserCommandOutput) => void ): void; - public updateUser( - args: UpdateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserCommandOutput) => void), - cb?: (err: any, data?: UpdateUserCommandOutput) => void - ): Promise | void { - const command = new UpdateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the settings for the specified user, such as phone number settings.

- */ - public updateUserSettings( + + /** + * @see {@link UpdateUserSettingsCommand} + */ + updateUserSettings( args: UpdateUserSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateUserSettings( + updateUserSettings( args: UpdateUserSettingsCommandInput, cb: (err: any, data?: UpdateUserSettingsCommandOutput) => void ): void; - public updateUserSettings( + updateUserSettings( args: UpdateUserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserSettingsCommandOutput) => void ): void; - public updateUserSettings( - args: UpdateUserSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateUserSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateUserSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates details for the specified Amazon Chime Voice Connector.

- */ - public updateVoiceConnector( + + /** + * @see {@link UpdateVoiceConnectorCommand} + */ + updateVoiceConnector( args: UpdateVoiceConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVoiceConnector( + updateVoiceConnector( args: UpdateVoiceConnectorCommandInput, cb: (err: any, data?: UpdateVoiceConnectorCommandOutput) => void ): void; - public updateVoiceConnector( + updateVoiceConnector( args: UpdateVoiceConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVoiceConnectorCommandOutput) => void ): void; - public updateVoiceConnector( - args: UpdateVoiceConnectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVoiceConnectorCommandOutput) => void), - cb?: (err: any, data?: UpdateVoiceConnectorCommandOutput) => void - ): Promise | void { - const command = new UpdateVoiceConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates details of the specified Amazon Chime Voice Connector group, such as the name and - * Amazon Chime Voice Connector priority ranking.

- */ - public updateVoiceConnectorGroup( + + /** + * @see {@link UpdateVoiceConnectorGroupCommand} + */ + updateVoiceConnectorGroup( args: UpdateVoiceConnectorGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVoiceConnectorGroup( + updateVoiceConnectorGroup( args: UpdateVoiceConnectorGroupCommandInput, cb: (err: any, data?: UpdateVoiceConnectorGroupCommandOutput) => void ): void; - public updateVoiceConnectorGroup( + updateVoiceConnectorGroup( args: UpdateVoiceConnectorGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVoiceConnectorGroupCommandOutput) => void ): void; - public updateVoiceConnectorGroup( - args: UpdateVoiceConnectorGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVoiceConnectorGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateVoiceConnectorGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateVoiceConnectorGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Validates an address to be used for 911 calls made with Amazon - * Chime Voice Connectors. You can use validated addresses - * in a Presence Information Data Format Location Object file that you include in SIP requests. - * That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.

- */ - public validateE911Address( + + /** + * @see {@link ValidateE911AddressCommand} + */ + validateE911Address( args: ValidateE911AddressCommandInput, options?: __HttpHandlerOptions ): Promise; - public validateE911Address( + validateE911Address( args: ValidateE911AddressCommandInput, cb: (err: any, data?: ValidateE911AddressCommandOutput) => void ): void; - public validateE911Address( + validateE911Address( args: ValidateE911AddressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidateE911AddressCommandOutput) => void ): void; - public validateE911Address( - args: ValidateE911AddressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ValidateE911AddressCommandOutput) => void), - cb?: (err: any, data?: ValidateE911AddressCommandOutput) => void - ): Promise | void { - const command = new ValidateE911AddressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The Amazon Chime API (application programming interface) is designed for developers to + * perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice + * Connectors. This guide provides detailed information about the Amazon Chime API, + * including operations, types, inputs and outputs, and error codes. It also includes API actions for use with the Amazon Chime SDK, which developers use to build their own communication applications. For more information about the + * Amazon Chime SDK, see + * Using the Amazon Chime SDK + * in the Amazon Chime Developer Guide.

+ *

You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the + * AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.

+ *
+ *
Using an AWS SDK
+ *
+ *

+ * You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the + * AWS Developer Center. + *

+ *
+ *
Using the AWS CLI
+ *
+ *

Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see + * Installing the AWS Command Line Interface + * in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the + * Amazon Chime commands in the + * AWS CLI Command Reference. + *

+ *
+ *
Using REST APIs
+ *
+ *

If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports signature version 4. For more information, see + * Signature Version 4 Signing Process + * in the Amazon Web Services General Reference.

+ * + *

When making REST API calls, use the service name chime and REST endpoint https://service.chime.aws.amazon.com.

+ *
+ *
+ * + *

Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see + * Identity and Access Management for Amazon Chime + * in the Amazon Chime Administration Guide.

+ */ +export class Chime extends ChimeClient implements Chime {} +createAggregatedClient(commands, Chime); diff --git a/clients/client-cleanrooms/src/CleanRooms.ts b/clients/client-cleanrooms/src/CleanRooms.ts index ca668ac729cc..fe461bbce1de 100644 --- a/clients/client-cleanrooms/src/CleanRooms.ts +++ b/clients/client-cleanrooms/src/CleanRooms.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CleanRoomsClient } from "./CleanRoomsClient"; +import { CleanRoomsClient, CleanRoomsClientConfig } from "./CleanRoomsClient"; import { BatchGetSchemaCommand, BatchGetSchemaCommandInput, @@ -172,1214 +173,639 @@ import { UpdateProtectedQueryCommandOutput, } from "./commands/UpdateProtectedQueryCommand"; -/** - * @public - *

Welcome to the AWS Clean Rooms API Reference.

- *

AWS Clean Rooms is an AWS service that helps multiple parties to join their data - * together in a secure collaboration workspace. In the collaboration, members who can query - * and receive results can get insights into the collective datasets without either party getting - * access to the other party's raw data.

- *

To learn more about AWS Clean Rooms concepts, procedures, and best practices, see the - * AWS Clean - * Rooms User Guide.

- */ -export class CleanRooms extends CleanRoomsClient { +const commands = { + BatchGetSchemaCommand, + CreateCollaborationCommand, + CreateConfiguredTableCommand, + CreateConfiguredTableAnalysisRuleCommand, + CreateConfiguredTableAssociationCommand, + CreateMembershipCommand, + DeleteCollaborationCommand, + DeleteConfiguredTableCommand, + DeleteConfiguredTableAnalysisRuleCommand, + DeleteConfiguredTableAssociationCommand, + DeleteMemberCommand, + DeleteMembershipCommand, + GetCollaborationCommand, + GetConfiguredTableCommand, + GetConfiguredTableAnalysisRuleCommand, + GetConfiguredTableAssociationCommand, + GetMembershipCommand, + GetProtectedQueryCommand, + GetSchemaCommand, + GetSchemaAnalysisRuleCommand, + ListCollaborationsCommand, + ListConfiguredTableAssociationsCommand, + ListConfiguredTablesCommand, + ListMembersCommand, + ListMembershipsCommand, + ListProtectedQueriesCommand, + ListSchemasCommand, + ListTagsForResourceCommand, + StartProtectedQueryCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateCollaborationCommand, + UpdateConfiguredTableCommand, + UpdateConfiguredTableAnalysisRuleCommand, + UpdateConfiguredTableAssociationCommand, + UpdateMembershipCommand, + UpdateProtectedQueryCommand, +}; + +export interface CleanRooms { /** - * @public - *

Retrieves multiple schemas by their identifiers.

+ * @see {@link BatchGetSchemaCommand} */ - public batchGetSchema( + batchGetSchema( args: BatchGetSchemaCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetSchema( - args: BatchGetSchemaCommandInput, - cb: (err: any, data?: BatchGetSchemaCommandOutput) => void - ): void; - public batchGetSchema( + batchGetSchema(args: BatchGetSchemaCommandInput, cb: (err: any, data?: BatchGetSchemaCommandOutput) => void): void; + batchGetSchema( args: BatchGetSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetSchemaCommandOutput) => void ): void; - public batchGetSchema( - args: BatchGetSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetSchemaCommandOutput) => void), - cb?: (err: any, data?: BatchGetSchemaCommandOutput) => void - ): Promise | void { - const command = new BatchGetSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new collaboration.

+ * @see {@link CreateCollaborationCommand} */ - public createCollaboration( + createCollaboration( args: CreateCollaborationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCollaboration( + createCollaboration( args: CreateCollaborationCommandInput, cb: (err: any, data?: CreateCollaborationCommandOutput) => void ): void; - public createCollaboration( + createCollaboration( args: CreateCollaborationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCollaborationCommandOutput) => void ): void; - public createCollaboration( - args: CreateCollaborationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCollaborationCommandOutput) => void), - cb?: (err: any, data?: CreateCollaborationCommandOutput) => void - ): Promise | void { - const command = new CreateCollaborationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new configured table resource.

+ * @see {@link CreateConfiguredTableCommand} */ - public createConfiguredTable( + createConfiguredTable( args: CreateConfiguredTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConfiguredTable( + createConfiguredTable( args: CreateConfiguredTableCommandInput, cb: (err: any, data?: CreateConfiguredTableCommandOutput) => void ): void; - public createConfiguredTable( + createConfiguredTable( args: CreateConfiguredTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfiguredTableCommandOutput) => void ): void; - public createConfiguredTable( - args: CreateConfiguredTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConfiguredTableCommandOutput) => void), - cb?: (err: any, data?: CreateConfiguredTableCommandOutput) => void - ): Promise | void { - const command = new CreateConfiguredTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new analysis rule for a configured table. Currently, only one analysis rule - * can be created for a given configured table.

+ * @see {@link CreateConfiguredTableAnalysisRuleCommand} */ - public createConfiguredTableAnalysisRule( + createConfiguredTableAnalysisRule( args: CreateConfiguredTableAnalysisRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConfiguredTableAnalysisRule( + createConfiguredTableAnalysisRule( args: CreateConfiguredTableAnalysisRuleCommandInput, cb: (err: any, data?: CreateConfiguredTableAnalysisRuleCommandOutput) => void ): void; - public createConfiguredTableAnalysisRule( + createConfiguredTableAnalysisRule( args: CreateConfiguredTableAnalysisRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfiguredTableAnalysisRuleCommandOutput) => void ): void; - public createConfiguredTableAnalysisRule( - args: CreateConfiguredTableAnalysisRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConfiguredTableAnalysisRuleCommandOutput) => void), - cb?: (err: any, data?: CreateConfiguredTableAnalysisRuleCommandOutput) => void - ): Promise | void { - const command = new CreateConfiguredTableAnalysisRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a configured table association. A configured table association links a - * configured table with a collaboration.

+ * @see {@link CreateConfiguredTableAssociationCommand} */ - public createConfiguredTableAssociation( + createConfiguredTableAssociation( args: CreateConfiguredTableAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConfiguredTableAssociation( + createConfiguredTableAssociation( args: CreateConfiguredTableAssociationCommandInput, cb: (err: any, data?: CreateConfiguredTableAssociationCommandOutput) => void ): void; - public createConfiguredTableAssociation( + createConfiguredTableAssociation( args: CreateConfiguredTableAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfiguredTableAssociationCommandOutput) => void ): void; - public createConfiguredTableAssociation( - args: CreateConfiguredTableAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConfiguredTableAssociationCommandOutput) => void), - cb?: (err: any, data?: CreateConfiguredTableAssociationCommandOutput) => void - ): Promise | void { - const command = new CreateConfiguredTableAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a membership for a specific collaboration identifier and joins the - * collaboration.

+ * @see {@link CreateMembershipCommand} */ - public createMembership( + createMembership( args: CreateMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMembership( + createMembership( args: CreateMembershipCommandInput, cb: (err: any, data?: CreateMembershipCommandOutput) => void ): void; - public createMembership( + createMembership( args: CreateMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMembershipCommandOutput) => void ): void; - public createMembership( - args: CreateMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMembershipCommandOutput) => void), - cb?: (err: any, data?: CreateMembershipCommandOutput) => void - ): Promise | void { - const command = new CreateMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a collaboration. It can only be called by the collaboration owner.

+ * @see {@link DeleteCollaborationCommand} */ - public deleteCollaboration( + deleteCollaboration( args: DeleteCollaborationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCollaboration( + deleteCollaboration( args: DeleteCollaborationCommandInput, cb: (err: any, data?: DeleteCollaborationCommandOutput) => void ): void; - public deleteCollaboration( + deleteCollaboration( args: DeleteCollaborationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCollaborationCommandOutput) => void ): void; - public deleteCollaboration( - args: DeleteCollaborationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCollaborationCommandOutput) => void), - cb?: (err: any, data?: DeleteCollaborationCommandOutput) => void - ): Promise | void { - const command = new DeleteCollaborationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a configured table.

+ * @see {@link DeleteConfiguredTableCommand} */ - public deleteConfiguredTable( + deleteConfiguredTable( args: DeleteConfiguredTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConfiguredTable( + deleteConfiguredTable( args: DeleteConfiguredTableCommandInput, cb: (err: any, data?: DeleteConfiguredTableCommandOutput) => void ): void; - public deleteConfiguredTable( + deleteConfiguredTable( args: DeleteConfiguredTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfiguredTableCommandOutput) => void ): void; - public deleteConfiguredTable( - args: DeleteConfiguredTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConfiguredTableCommandOutput) => void), - cb?: (err: any, data?: DeleteConfiguredTableCommandOutput) => void - ): Promise | void { - const command = new DeleteConfiguredTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a configured table analysis rule.

+ * @see {@link DeleteConfiguredTableAnalysisRuleCommand} */ - public deleteConfiguredTableAnalysisRule( + deleteConfiguredTableAnalysisRule( args: DeleteConfiguredTableAnalysisRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConfiguredTableAnalysisRule( + deleteConfiguredTableAnalysisRule( args: DeleteConfiguredTableAnalysisRuleCommandInput, cb: (err: any, data?: DeleteConfiguredTableAnalysisRuleCommandOutput) => void ): void; - public deleteConfiguredTableAnalysisRule( + deleteConfiguredTableAnalysisRule( args: DeleteConfiguredTableAnalysisRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfiguredTableAnalysisRuleCommandOutput) => void ): void; - public deleteConfiguredTableAnalysisRule( - args: DeleteConfiguredTableAnalysisRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConfiguredTableAnalysisRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteConfiguredTableAnalysisRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteConfiguredTableAnalysisRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a configured table association.

+ * @see {@link DeleteConfiguredTableAssociationCommand} */ - public deleteConfiguredTableAssociation( + deleteConfiguredTableAssociation( args: DeleteConfiguredTableAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConfiguredTableAssociation( + deleteConfiguredTableAssociation( args: DeleteConfiguredTableAssociationCommandInput, cb: (err: any, data?: DeleteConfiguredTableAssociationCommandOutput) => void ): void; - public deleteConfiguredTableAssociation( + deleteConfiguredTableAssociation( args: DeleteConfiguredTableAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfiguredTableAssociationCommandOutput) => void ): void; - public deleteConfiguredTableAssociation( - args: DeleteConfiguredTableAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConfiguredTableAssociationCommandOutput) => void), - cb?: (err: any, data?: DeleteConfiguredTableAssociationCommandOutput) => void - ): Promise | void { - const command = new DeleteConfiguredTableAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified member from a collaboration. The removed member is placed in the - * Removed status and can't interact with the collaboration. The removed member's data is - * inaccessible to active members of the collaboration.

+ * @see {@link DeleteMemberCommand} */ - public deleteMember( - args: DeleteMemberCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteMember(args: DeleteMemberCommandInput, cb: (err: any, data?: DeleteMemberCommandOutput) => void): void; - public deleteMember( + deleteMember(args: DeleteMemberCommandInput, options?: __HttpHandlerOptions): Promise; + deleteMember(args: DeleteMemberCommandInput, cb: (err: any, data?: DeleteMemberCommandOutput) => void): void; + deleteMember( args: DeleteMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMemberCommandOutput) => void ): void; - public deleteMember( - args: DeleteMemberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMemberCommandOutput) => void), - cb?: (err: any, data?: DeleteMemberCommandOutput) => void - ): Promise | void { - const command = new DeleteMemberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a specified membership. All resources under a membership must be deleted.

+ * @see {@link DeleteMembershipCommand} */ - public deleteMembership( + deleteMembership( args: DeleteMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMembership( + deleteMembership( args: DeleteMembershipCommandInput, cb: (err: any, data?: DeleteMembershipCommandOutput) => void ): void; - public deleteMembership( + deleteMembership( args: DeleteMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMembershipCommandOutput) => void ): void; - public deleteMembership( - args: DeleteMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMembershipCommandOutput) => void), - cb?: (err: any, data?: DeleteMembershipCommandOutput) => void - ): Promise | void { - const command = new DeleteMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns metadata about a collaboration.

+ * @see {@link GetCollaborationCommand} */ - public getCollaboration( + getCollaboration( args: GetCollaborationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCollaboration( + getCollaboration( args: GetCollaborationCommandInput, cb: (err: any, data?: GetCollaborationCommandOutput) => void ): void; - public getCollaboration( + getCollaboration( args: GetCollaborationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCollaborationCommandOutput) => void ): void; - public getCollaboration( - args: GetCollaborationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCollaborationCommandOutput) => void), - cb?: (err: any, data?: GetCollaborationCommandOutput) => void - ): Promise | void { - const command = new GetCollaborationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a configured table.

+ * @see {@link GetConfiguredTableCommand} */ - public getConfiguredTable( + getConfiguredTable( args: GetConfiguredTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConfiguredTable( + getConfiguredTable( args: GetConfiguredTableCommandInput, cb: (err: any, data?: GetConfiguredTableCommandOutput) => void ): void; - public getConfiguredTable( + getConfiguredTable( args: GetConfiguredTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConfiguredTableCommandOutput) => void ): void; - public getConfiguredTable( - args: GetConfiguredTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConfiguredTableCommandOutput) => void), - cb?: (err: any, data?: GetConfiguredTableCommandOutput) => void - ): Promise | void { - const command = new GetConfiguredTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a configured table analysis rule.

+ * @see {@link GetConfiguredTableAnalysisRuleCommand} */ - public getConfiguredTableAnalysisRule( + getConfiguredTableAnalysisRule( args: GetConfiguredTableAnalysisRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConfiguredTableAnalysisRule( + getConfiguredTableAnalysisRule( args: GetConfiguredTableAnalysisRuleCommandInput, cb: (err: any, data?: GetConfiguredTableAnalysisRuleCommandOutput) => void ): void; - public getConfiguredTableAnalysisRule( + getConfiguredTableAnalysisRule( args: GetConfiguredTableAnalysisRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConfiguredTableAnalysisRuleCommandOutput) => void ): void; - public getConfiguredTableAnalysisRule( - args: GetConfiguredTableAnalysisRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConfiguredTableAnalysisRuleCommandOutput) => void), - cb?: (err: any, data?: GetConfiguredTableAnalysisRuleCommandOutput) => void - ): Promise | void { - const command = new GetConfiguredTableAnalysisRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a configured table association.

+ * @see {@link GetConfiguredTableAssociationCommand} */ - public getConfiguredTableAssociation( + getConfiguredTableAssociation( args: GetConfiguredTableAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConfiguredTableAssociation( + getConfiguredTableAssociation( args: GetConfiguredTableAssociationCommandInput, cb: (err: any, data?: GetConfiguredTableAssociationCommandOutput) => void ): void; - public getConfiguredTableAssociation( + getConfiguredTableAssociation( args: GetConfiguredTableAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConfiguredTableAssociationCommandOutput) => void ): void; - public getConfiguredTableAssociation( - args: GetConfiguredTableAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConfiguredTableAssociationCommandOutput) => void), - cb?: (err: any, data?: GetConfiguredTableAssociationCommandOutput) => void - ): Promise | void { - const command = new GetConfiguredTableAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a specified membership for an identifier.

+ * @see {@link GetMembershipCommand} */ - public getMembership( - args: GetMembershipCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getMembership( - args: GetMembershipCommandInput, - cb: (err: any, data?: GetMembershipCommandOutput) => void - ): void; - public getMembership( + getMembership(args: GetMembershipCommandInput, options?: __HttpHandlerOptions): Promise; + getMembership(args: GetMembershipCommandInput, cb: (err: any, data?: GetMembershipCommandOutput) => void): void; + getMembership( args: GetMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMembershipCommandOutput) => void ): void; - public getMembership( - args: GetMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMembershipCommandOutput) => void), - cb?: (err: any, data?: GetMembershipCommandOutput) => void - ): Promise | void { - const command = new GetMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns query processing metadata.

+ * @see {@link GetProtectedQueryCommand} */ - public getProtectedQuery( + getProtectedQuery( args: GetProtectedQueryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getProtectedQuery( + getProtectedQuery( args: GetProtectedQueryCommandInput, cb: (err: any, data?: GetProtectedQueryCommandOutput) => void ): void; - public getProtectedQuery( + getProtectedQuery( args: GetProtectedQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProtectedQueryCommandOutput) => void ): void; - public getProtectedQuery( - args: GetProtectedQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetProtectedQueryCommandOutput) => void), - cb?: (err: any, data?: GetProtectedQueryCommandOutput) => void - ): Promise | void { - const command = new GetProtectedQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the schema for a relation within a collaboration.

+ * @see {@link GetSchemaCommand} */ - public getSchema(args: GetSchemaCommandInput, options?: __HttpHandlerOptions): Promise; - public getSchema(args: GetSchemaCommandInput, cb: (err: any, data?: GetSchemaCommandOutput) => void): void; - public getSchema( + getSchema(args: GetSchemaCommandInput, options?: __HttpHandlerOptions): Promise; + getSchema(args: GetSchemaCommandInput, cb: (err: any, data?: GetSchemaCommandOutput) => void): void; + getSchema( args: GetSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSchemaCommandOutput) => void ): void; - public getSchema( - args: GetSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSchemaCommandOutput) => void), - cb?: (err: any, data?: GetSchemaCommandOutput) => void - ): Promise | void { - const command = new GetSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a schema analysis rule.

+ * @see {@link GetSchemaAnalysisRuleCommand} */ - public getSchemaAnalysisRule( + getSchemaAnalysisRule( args: GetSchemaAnalysisRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSchemaAnalysisRule( + getSchemaAnalysisRule( args: GetSchemaAnalysisRuleCommandInput, cb: (err: any, data?: GetSchemaAnalysisRuleCommandOutput) => void ): void; - public getSchemaAnalysisRule( + getSchemaAnalysisRule( args: GetSchemaAnalysisRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSchemaAnalysisRuleCommandOutput) => void ): void; - public getSchemaAnalysisRule( - args: GetSchemaAnalysisRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSchemaAnalysisRuleCommandOutput) => void), - cb?: (err: any, data?: GetSchemaAnalysisRuleCommandOutput) => void - ): Promise | void { - const command = new GetSchemaAnalysisRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists collaborations the caller owns, is active in, or has been invited to.

+ * @see {@link ListCollaborationsCommand} */ - public listCollaborations( + listCollaborations( args: ListCollaborationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCollaborations( + listCollaborations( args: ListCollaborationsCommandInput, cb: (err: any, data?: ListCollaborationsCommandOutput) => void ): void; - public listCollaborations( + listCollaborations( args: ListCollaborationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCollaborationsCommandOutput) => void ): void; - public listCollaborations( - args: ListCollaborationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCollaborationsCommandOutput) => void), - cb?: (err: any, data?: ListCollaborationsCommandOutput) => void - ): Promise | void { - const command = new ListCollaborationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists configured table associations for a membership.

+ * @see {@link ListConfiguredTableAssociationsCommand} */ - public listConfiguredTableAssociations( + listConfiguredTableAssociations( args: ListConfiguredTableAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConfiguredTableAssociations( + listConfiguredTableAssociations( args: ListConfiguredTableAssociationsCommandInput, cb: (err: any, data?: ListConfiguredTableAssociationsCommandOutput) => void ): void; - public listConfiguredTableAssociations( + listConfiguredTableAssociations( args: ListConfiguredTableAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConfiguredTableAssociationsCommandOutput) => void ): void; - public listConfiguredTableAssociations( - args: ListConfiguredTableAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConfiguredTableAssociationsCommandOutput) => void), - cb?: (err: any, data?: ListConfiguredTableAssociationsCommandOutput) => void - ): Promise | void { - const command = new ListConfiguredTableAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists configured tables.

+ * @see {@link ListConfiguredTablesCommand} */ - public listConfiguredTables( + listConfiguredTables( args: ListConfiguredTablesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConfiguredTables( + listConfiguredTables( args: ListConfiguredTablesCommandInput, cb: (err: any, data?: ListConfiguredTablesCommandOutput) => void ): void; - public listConfiguredTables( + listConfiguredTables( args: ListConfiguredTablesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConfiguredTablesCommandOutput) => void ): void; - public listConfiguredTables( - args: ListConfiguredTablesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConfiguredTablesCommandOutput) => void), - cb?: (err: any, data?: ListConfiguredTablesCommandOutput) => void - ): Promise | void { - const command = new ListConfiguredTablesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all members within a collaboration.

+ * @see {@link ListMembersCommand} */ - public listMembers(args: ListMembersCommandInput, options?: __HttpHandlerOptions): Promise; - public listMembers(args: ListMembersCommandInput, cb: (err: any, data?: ListMembersCommandOutput) => void): void; - public listMembers( + listMembers(args: ListMembersCommandInput, options?: __HttpHandlerOptions): Promise; + listMembers(args: ListMembersCommandInput, cb: (err: any, data?: ListMembersCommandOutput) => void): void; + listMembers( args: ListMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMembersCommandOutput) => void ): void; - public listMembers( - args: ListMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMembersCommandOutput) => void), - cb?: (err: any, data?: ListMembersCommandOutput) => void - ): Promise | void { - const command = new ListMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all memberships resources within the caller's account.

+ * @see {@link ListMembershipsCommand} */ - public listMemberships( + listMemberships( args: ListMembershipsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMemberships( - args: ListMembershipsCommandInput, - cb: (err: any, data?: ListMembershipsCommandOutput) => void - ): void; - public listMemberships( + listMemberships(args: ListMembershipsCommandInput, cb: (err: any, data?: ListMembershipsCommandOutput) => void): void; + listMemberships( args: ListMembershipsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMembershipsCommandOutput) => void ): void; - public listMemberships( - args: ListMembershipsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMembershipsCommandOutput) => void), - cb?: (err: any, data?: ListMembershipsCommandOutput) => void - ): Promise | void { - const command = new ListMembershipsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists protected queries, sorted by the most recent query.

+ * @see {@link ListProtectedQueriesCommand} */ - public listProtectedQueries( + listProtectedQueries( args: ListProtectedQueriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProtectedQueries( + listProtectedQueries( args: ListProtectedQueriesCommandInput, cb: (err: any, data?: ListProtectedQueriesCommandOutput) => void ): void; - public listProtectedQueries( + listProtectedQueries( args: ListProtectedQueriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProtectedQueriesCommandOutput) => void ): void; - public listProtectedQueries( - args: ListProtectedQueriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProtectedQueriesCommandOutput) => void), - cb?: (err: any, data?: ListProtectedQueriesCommandOutput) => void - ): Promise | void { - const command = new ListProtectedQueriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the schemas for relations within a collaboration.

+ * @see {@link ListSchemasCommand} */ - public listSchemas(args: ListSchemasCommandInput, options?: __HttpHandlerOptions): Promise; - public listSchemas(args: ListSchemasCommandInput, cb: (err: any, data?: ListSchemasCommandOutput) => void): void; - public listSchemas( + listSchemas(args: ListSchemasCommandInput, options?: __HttpHandlerOptions): Promise; + listSchemas(args: ListSchemasCommandInput, cb: (err: any, data?: ListSchemasCommandOutput) => void): void; + listSchemas( args: ListSchemasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSchemasCommandOutput) => void ): void; - public listSchemas( - args: ListSchemasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSchemasCommandOutput) => void), - cb?: (err: any, data?: ListSchemasCommandOutput) => void - ): Promise | void { - const command = new ListSchemasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all of the tags that have been added to a resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a protected query that is started by AWS Clean Rooms.

+ * @see {@link StartProtectedQueryCommand} */ - public startProtectedQuery( + startProtectedQuery( args: StartProtectedQueryCommandInput, options?: __HttpHandlerOptions ): Promise; - public startProtectedQuery( + startProtectedQuery( args: StartProtectedQueryCommandInput, cb: (err: any, data?: StartProtectedQueryCommandOutput) => void ): void; - public startProtectedQuery( + startProtectedQuery( args: StartProtectedQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartProtectedQueryCommandOutput) => void ): void; - public startProtectedQuery( - args: StartProtectedQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartProtectedQueryCommandOutput) => void), - cb?: (err: any, data?: StartProtectedQueryCommandOutput) => void - ): Promise | void { - const command = new StartProtectedQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Tags a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a tag or list of tags from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates collaboration metadata and can only be called by the collaboration owner.

+ * @see {@link UpdateCollaborationCommand} */ - public updateCollaboration( + updateCollaboration( args: UpdateCollaborationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCollaboration( + updateCollaboration( args: UpdateCollaborationCommandInput, cb: (err: any, data?: UpdateCollaborationCommandOutput) => void ): void; - public updateCollaboration( + updateCollaboration( args: UpdateCollaborationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCollaborationCommandOutput) => void ): void; - public updateCollaboration( - args: UpdateCollaborationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCollaborationCommandOutput) => void), - cb?: (err: any, data?: UpdateCollaborationCommandOutput) => void - ): Promise | void { - const command = new UpdateCollaborationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a configured table.

+ * @see {@link UpdateConfiguredTableCommand} */ - public updateConfiguredTable( + updateConfiguredTable( args: UpdateConfiguredTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConfiguredTable( + updateConfiguredTable( args: UpdateConfiguredTableCommandInput, cb: (err: any, data?: UpdateConfiguredTableCommandOutput) => void ): void; - public updateConfiguredTable( + updateConfiguredTable( args: UpdateConfiguredTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConfiguredTableCommandOutput) => void ): void; - public updateConfiguredTable( - args: UpdateConfiguredTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConfiguredTableCommandOutput) => void), - cb?: (err: any, data?: UpdateConfiguredTableCommandOutput) => void - ): Promise | void { - const command = new UpdateConfiguredTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a configured table analysis rule.

+ * @see {@link UpdateConfiguredTableAnalysisRuleCommand} */ - public updateConfiguredTableAnalysisRule( + updateConfiguredTableAnalysisRule( args: UpdateConfiguredTableAnalysisRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConfiguredTableAnalysisRule( + updateConfiguredTableAnalysisRule( args: UpdateConfiguredTableAnalysisRuleCommandInput, cb: (err: any, data?: UpdateConfiguredTableAnalysisRuleCommandOutput) => void ): void; - public updateConfiguredTableAnalysisRule( + updateConfiguredTableAnalysisRule( args: UpdateConfiguredTableAnalysisRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConfiguredTableAnalysisRuleCommandOutput) => void ): void; - public updateConfiguredTableAnalysisRule( - args: UpdateConfiguredTableAnalysisRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConfiguredTableAnalysisRuleCommandOutput) => void), - cb?: (err: any, data?: UpdateConfiguredTableAnalysisRuleCommandOutput) => void - ): Promise | void { - const command = new UpdateConfiguredTableAnalysisRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a configured table association.

+ * @see {@link UpdateConfiguredTableAssociationCommand} */ - public updateConfiguredTableAssociation( + updateConfiguredTableAssociation( args: UpdateConfiguredTableAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConfiguredTableAssociation( + updateConfiguredTableAssociation( args: UpdateConfiguredTableAssociationCommandInput, cb: (err: any, data?: UpdateConfiguredTableAssociationCommandOutput) => void ): void; - public updateConfiguredTableAssociation( + updateConfiguredTableAssociation( args: UpdateConfiguredTableAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConfiguredTableAssociationCommandOutput) => void ): void; - public updateConfiguredTableAssociation( - args: UpdateConfiguredTableAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConfiguredTableAssociationCommandOutput) => void), - cb?: (err: any, data?: UpdateConfiguredTableAssociationCommandOutput) => void - ): Promise | void { - const command = new UpdateConfiguredTableAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a membership.

+ * @see {@link UpdateMembershipCommand} */ - public updateMembership( + updateMembership( args: UpdateMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMembership( + updateMembership( args: UpdateMembershipCommandInput, cb: (err: any, data?: UpdateMembershipCommandOutput) => void ): void; - public updateMembership( + updateMembership( args: UpdateMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMembershipCommandOutput) => void ): void; - public updateMembership( - args: UpdateMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMembershipCommandOutput) => void), - cb?: (err: any, data?: UpdateMembershipCommandOutput) => void - ): Promise | void { - const command = new UpdateMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the processing of a currently running query.

+ * @see {@link UpdateProtectedQueryCommand} */ - public updateProtectedQuery( + updateProtectedQuery( args: UpdateProtectedQueryCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateProtectedQuery( + updateProtectedQuery( args: UpdateProtectedQueryCommandInput, cb: (err: any, data?: UpdateProtectedQueryCommandOutput) => void ): void; - public updateProtectedQuery( + updateProtectedQuery( args: UpdateProtectedQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProtectedQueryCommandOutput) => void ): void; - public updateProtectedQuery( - args: UpdateProtectedQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProtectedQueryCommandOutput) => void), - cb?: (err: any, data?: UpdateProtectedQueryCommandOutput) => void - ): Promise | void { - const command = new UpdateProtectedQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Welcome to the AWS Clean Rooms API Reference.

+ *

AWS Clean Rooms is an AWS service that helps multiple parties to join their data + * together in a secure collaboration workspace. In the collaboration, members who can query + * and receive results can get insights into the collective datasets without either party getting + * access to the other party's raw data.

+ *

To learn more about AWS Clean Rooms concepts, procedures, and best practices, see the + * AWS Clean + * Rooms User Guide.

+ */ +export class CleanRooms extends CleanRoomsClient implements CleanRooms {} +createAggregatedClient(commands, CleanRooms); diff --git a/clients/client-cloud9/src/Cloud9.ts b/clients/client-cloud9/src/Cloud9.ts index f72964742142..e8746e339167 100644 --- a/clients/client-cloud9/src/Cloud9.ts +++ b/clients/client-cloud9/src/Cloud9.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { Cloud9Client } from "./Cloud9Client"; +import { Cloud9Client, Cloud9ClientConfig } from "./Cloud9Client"; import { CreateEnvironmentEC2Command, CreateEnvironmentEC2CommandInput, @@ -64,504 +65,302 @@ import { UpdateEnvironmentMembershipCommandOutput, } from "./commands/UpdateEnvironmentMembershipCommand"; -/** - * @public - * Cloud9 - *

Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and - * release software in the cloud.

- *

For more information about Cloud9, see the Cloud9 User Guide.

- *

Cloud9 supports these operations:

- *
    - *
  • - *

    - * CreateEnvironmentEC2: Creates an Cloud9 development environment, launches - * an Amazon EC2 instance, and then connects from the instance to the environment.

    - *
  • - *
  • - *

    - * CreateEnvironmentMembership: Adds an environment member to an - * environment.

    - *
  • - *
  • - *

    - * DeleteEnvironment: Deletes an environment. If an Amazon EC2 instance is - * connected to the environment, also terminates the instance.

    - *
  • - *
  • - *

    - * DeleteEnvironmentMembership: Deletes an environment member from an - * environment.

    - *
  • - *
  • - *

    - * DescribeEnvironmentMemberships: Gets information about environment - * members for an environment.

    - *
  • - *
  • - *

    - * DescribeEnvironments: Gets information about environments.

    - *
  • - *
  • - *

    - * DescribeEnvironmentStatus: Gets status information for an - * environment.

    - *
  • - *
  • - *

    - * ListEnvironments: Gets a list of environment identifiers.

    - *
  • - *
  • - *

    - * ListTagsForResource: Gets the tags for an environment.

    - *
  • - *
  • - *

    - * TagResource: Adds tags to an environment.

    - *
  • - *
  • - *

    - * UntagResource: Removes tags from an environment.

    - *
  • - *
  • - *

    - * UpdateEnvironment: Changes the settings of an existing - * environment.

    - *
  • - *
  • - *

    - * UpdateEnvironmentMembership: Changes the settings of an existing - * environment member for an environment.

    - *
  • - *
- */ -export class Cloud9 extends Cloud9Client { +const commands = { + CreateEnvironmentEC2Command, + CreateEnvironmentMembershipCommand, + DeleteEnvironmentCommand, + DeleteEnvironmentMembershipCommand, + DescribeEnvironmentMembershipsCommand, + DescribeEnvironmentsCommand, + DescribeEnvironmentStatusCommand, + ListEnvironmentsCommand, + ListTagsForResourceCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateEnvironmentCommand, + UpdateEnvironmentMembershipCommand, +}; + +export interface Cloud9 { /** - * @public - *

Creates an Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and - * then connects from the instance to the environment.

+ * @see {@link CreateEnvironmentEC2Command} */ - public createEnvironmentEC2( + createEnvironmentEC2( args: CreateEnvironmentEC2CommandInput, options?: __HttpHandlerOptions ): Promise; - public createEnvironmentEC2( + createEnvironmentEC2( args: CreateEnvironmentEC2CommandInput, cb: (err: any, data?: CreateEnvironmentEC2CommandOutput) => void ): void; - public createEnvironmentEC2( + createEnvironmentEC2( args: CreateEnvironmentEC2CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentEC2CommandOutput) => void ): void; - public createEnvironmentEC2( - args: CreateEnvironmentEC2CommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEnvironmentEC2CommandOutput) => void), - cb?: (err: any, data?: CreateEnvironmentEC2CommandOutput) => void - ): Promise | void { - const command = new CreateEnvironmentEC2Command(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds an environment member to an Cloud9 development environment.

+ * @see {@link CreateEnvironmentMembershipCommand} */ - public createEnvironmentMembership( + createEnvironmentMembership( args: CreateEnvironmentMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEnvironmentMembership( + createEnvironmentMembership( args: CreateEnvironmentMembershipCommandInput, cb: (err: any, data?: CreateEnvironmentMembershipCommandOutput) => void ): void; - public createEnvironmentMembership( + createEnvironmentMembership( args: CreateEnvironmentMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentMembershipCommandOutput) => void ): void; - public createEnvironmentMembership( - args: CreateEnvironmentMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEnvironmentMembershipCommandOutput) => void), - cb?: (err: any, data?: CreateEnvironmentMembershipCommandOutput) => void - ): Promise | void { - const command = new CreateEnvironmentMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Cloud9 development environment. If an Amazon EC2 instance is connected to the - * environment, also terminates the instance.

+ * @see {@link DeleteEnvironmentCommand} */ - public deleteEnvironment( + deleteEnvironment( args: DeleteEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEnvironment( + deleteEnvironment( args: DeleteEnvironmentCommandInput, cb: (err: any, data?: DeleteEnvironmentCommandOutput) => void ): void; - public deleteEnvironment( + deleteEnvironment( args: DeleteEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEnvironmentCommandOutput) => void ): void; - public deleteEnvironment( - args: DeleteEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEnvironmentCommandOutput) => void), - cb?: (err: any, data?: DeleteEnvironmentCommandOutput) => void - ): Promise | void { - const command = new DeleteEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an environment member from a development environment.

+ * @see {@link DeleteEnvironmentMembershipCommand} */ - public deleteEnvironmentMembership( + deleteEnvironmentMembership( args: DeleteEnvironmentMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEnvironmentMembership( + deleteEnvironmentMembership( args: DeleteEnvironmentMembershipCommandInput, cb: (err: any, data?: DeleteEnvironmentMembershipCommandOutput) => void ): void; - public deleteEnvironmentMembership( + deleteEnvironmentMembership( args: DeleteEnvironmentMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEnvironmentMembershipCommandOutput) => void ): void; - public deleteEnvironmentMembership( - args: DeleteEnvironmentMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEnvironmentMembershipCommandOutput) => void), - cb?: (err: any, data?: DeleteEnvironmentMembershipCommandOutput) => void - ): Promise | void { - const command = new DeleteEnvironmentMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about environment members for an Cloud9 development environment.

+ * @see {@link DescribeEnvironmentMembershipsCommand} */ - public describeEnvironmentMemberships( + describeEnvironmentMemberships( args: DescribeEnvironmentMembershipsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEnvironmentMemberships( + describeEnvironmentMemberships( args: DescribeEnvironmentMembershipsCommandInput, cb: (err: any, data?: DescribeEnvironmentMembershipsCommandOutput) => void ): void; - public describeEnvironmentMemberships( + describeEnvironmentMemberships( args: DescribeEnvironmentMembershipsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEnvironmentMembershipsCommandOutput) => void ): void; - public describeEnvironmentMemberships( - args: DescribeEnvironmentMembershipsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEnvironmentMembershipsCommandOutput) => void), - cb?: (err: any, data?: DescribeEnvironmentMembershipsCommandOutput) => void - ): Promise | void { - const command = new DescribeEnvironmentMembershipsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about Cloud9 development environments.

+ * @see {@link DescribeEnvironmentsCommand} */ - public describeEnvironments( + describeEnvironments( args: DescribeEnvironmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEnvironments( + describeEnvironments( args: DescribeEnvironmentsCommandInput, cb: (err: any, data?: DescribeEnvironmentsCommandOutput) => void ): void; - public describeEnvironments( + describeEnvironments( args: DescribeEnvironmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEnvironmentsCommandOutput) => void ): void; - public describeEnvironments( - args: DescribeEnvironmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEnvironmentsCommandOutput) => void), - cb?: (err: any, data?: DescribeEnvironmentsCommandOutput) => void - ): Promise | void { - const command = new DescribeEnvironmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets status information for an Cloud9 development environment.

+ * @see {@link DescribeEnvironmentStatusCommand} */ - public describeEnvironmentStatus( + describeEnvironmentStatus( args: DescribeEnvironmentStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEnvironmentStatus( + describeEnvironmentStatus( args: DescribeEnvironmentStatusCommandInput, cb: (err: any, data?: DescribeEnvironmentStatusCommandOutput) => void ): void; - public describeEnvironmentStatus( + describeEnvironmentStatus( args: DescribeEnvironmentStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEnvironmentStatusCommandOutput) => void ): void; - public describeEnvironmentStatus( - args: DescribeEnvironmentStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEnvironmentStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeEnvironmentStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeEnvironmentStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of Cloud9 development environment identifiers.

+ * @see {@link ListEnvironmentsCommand} */ - public listEnvironments( + listEnvironments( args: ListEnvironmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEnvironments( + listEnvironments( args: ListEnvironmentsCommandInput, cb: (err: any, data?: ListEnvironmentsCommandOutput) => void ): void; - public listEnvironments( + listEnvironments( args: ListEnvironmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnvironmentsCommandOutput) => void ): void; - public listEnvironments( - args: ListEnvironmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEnvironmentsCommandOutput) => void), - cb?: (err: any, data?: ListEnvironmentsCommandOutput) => void - ): Promise | void { - const command = new ListEnvironmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of the tags associated with an Cloud9 development environment.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds tags to an Cloud9 development environment.

- * - *

Tags that you add to an Cloud9 environment by using this method will NOT be - * automatically propagated to underlying resources.

- *
+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from an Cloud9 development environment.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes the settings of an existing Cloud9 development environment.

+ * @see {@link UpdateEnvironmentCommand} */ - public updateEnvironment( + updateEnvironment( args: UpdateEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEnvironment( + updateEnvironment( args: UpdateEnvironmentCommandInput, cb: (err: any, data?: UpdateEnvironmentCommandOutput) => void ): void; - public updateEnvironment( + updateEnvironment( args: UpdateEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEnvironmentCommandOutput) => void ): void; - public updateEnvironment( - args: UpdateEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEnvironmentCommandOutput) => void), - cb?: (err: any, data?: UpdateEnvironmentCommandOutput) => void - ): Promise | void { - const command = new UpdateEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes the settings of an existing environment member for an Cloud9 development - * environment.

+ * @see {@link UpdateEnvironmentMembershipCommand} */ - public updateEnvironmentMembership( + updateEnvironmentMembership( args: UpdateEnvironmentMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEnvironmentMembership( + updateEnvironmentMembership( args: UpdateEnvironmentMembershipCommandInput, cb: (err: any, data?: UpdateEnvironmentMembershipCommandOutput) => void ): void; - public updateEnvironmentMembership( + updateEnvironmentMembership( args: UpdateEnvironmentMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEnvironmentMembershipCommandOutput) => void ): void; - public updateEnvironmentMembership( - args: UpdateEnvironmentMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEnvironmentMembershipCommandOutput) => void), - cb?: (err: any, data?: UpdateEnvironmentMembershipCommandOutput) => void - ): Promise | void { - const command = new UpdateEnvironmentMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Cloud9 + *

Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and + * release software in the cloud.

+ *

For more information about Cloud9, see the Cloud9 User Guide.

+ *

Cloud9 supports these operations:

+ *
    + *
  • + *

    + * CreateEnvironmentEC2: Creates an Cloud9 development environment, launches + * an Amazon EC2 instance, and then connects from the instance to the environment.

    + *
  • + *
  • + *

    + * CreateEnvironmentMembership: Adds an environment member to an + * environment.

    + *
  • + *
  • + *

    + * DeleteEnvironment: Deletes an environment. If an Amazon EC2 instance is + * connected to the environment, also terminates the instance.

    + *
  • + *
  • + *

    + * DeleteEnvironmentMembership: Deletes an environment member from an + * environment.

    + *
  • + *
  • + *

    + * DescribeEnvironmentMemberships: Gets information about environment + * members for an environment.

    + *
  • + *
  • + *

    + * DescribeEnvironments: Gets information about environments.

    + *
  • + *
  • + *

    + * DescribeEnvironmentStatus: Gets status information for an + * environment.

    + *
  • + *
  • + *

    + * ListEnvironments: Gets a list of environment identifiers.

    + *
  • + *
  • + *

    + * ListTagsForResource: Gets the tags for an environment.

    + *
  • + *
  • + *

    + * TagResource: Adds tags to an environment.

    + *
  • + *
  • + *

    + * UntagResource: Removes tags from an environment.

    + *
  • + *
  • + *

    + * UpdateEnvironment: Changes the settings of an existing + * environment.

    + *
  • + *
  • + *

    + * UpdateEnvironmentMembership: Changes the settings of an existing + * environment member for an environment.

    + *
  • + *
+ */ +export class Cloud9 extends Cloud9Client implements Cloud9 {} +createAggregatedClient(commands, Cloud9); diff --git a/clients/client-cloudcontrol/src/CloudControl.ts b/clients/client-cloudcontrol/src/CloudControl.ts index a714074a499a..9deba757edc7 100644 --- a/clients/client-cloudcontrol/src/CloudControl.ts +++ b/clients/client-cloudcontrol/src/CloudControl.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CloudControlClient } from "./CloudControlClient"; +import { CloudControlClient, CloudControlClientConfig } from "./CloudControlClient"; import { CancelResourceRequestCommand, CancelResourceRequestCommandInput, @@ -39,301 +40,138 @@ import { UpdateResourceCommandOutput, } from "./commands/UpdateResourceCommand"; -/** - * @public - *

For more information about Amazon Web Services Cloud Control API, see the Amazon Web Services Cloud Control API User - * Guide.

- */ -export class CloudControl extends CloudControlClient { +const commands = { + CancelResourceRequestCommand, + CreateResourceCommand, + DeleteResourceCommand, + GetResourceCommand, + GetResourceRequestStatusCommand, + ListResourceRequestsCommand, + ListResourcesCommand, + UpdateResourceCommand, +}; + +export interface CloudControl { /** - * @public - *

Cancels the specified resource operation request. For more information, see Canceling resource operation requests in the - * Amazon Web Services Cloud Control API User Guide.

- *

Only resource operations requests with a status of PENDING or - * IN_PROGRESS can be canceled.

+ * @see {@link CancelResourceRequestCommand} */ - public cancelResourceRequest( + cancelResourceRequest( args: CancelResourceRequestCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelResourceRequest( + cancelResourceRequest( args: CancelResourceRequestCommandInput, cb: (err: any, data?: CancelResourceRequestCommandOutput) => void ): void; - public cancelResourceRequest( + cancelResourceRequest( args: CancelResourceRequestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelResourceRequestCommandOutput) => void ): void; - public cancelResourceRequest( - args: CancelResourceRequestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelResourceRequestCommandOutput) => void), - cb?: (err: any, data?: CancelResourceRequestCommandOutput) => void - ): Promise | void { - const command = new CancelResourceRequestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates the specified resource. For more information, see Creating a - * resource in the Amazon Web Services Cloud Control API User Guide.

- *

After you have initiated a resource creation request, you can monitor the progress of your - * request by calling GetResourceRequestStatus using the RequestToken of the - * ProgressEvent type returned by CreateResource.

+ * @see {@link CreateResourceCommand} */ - public createResource( + createResource( args: CreateResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createResource( - args: CreateResourceCommandInput, - cb: (err: any, data?: CreateResourceCommandOutput) => void - ): void; - public createResource( + createResource(args: CreateResourceCommandInput, cb: (err: any, data?: CreateResourceCommandOutput) => void): void; + createResource( args: CreateResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResourceCommandOutput) => void ): void; - public createResource( - args: CreateResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateResourceCommandOutput) => void), - cb?: (err: any, data?: CreateResourceCommandOutput) => void - ): Promise | void { - const command = new CreateResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified resource. For details, see Deleting a - * resource in the Amazon Web Services Cloud Control API User Guide.

- *

After you have initiated a resource deletion request, you can monitor the progress of your - * request by calling GetResourceRequestStatus using the RequestToken of the - * ProgressEvent returned by DeleteResource.

+ * @see {@link DeleteResourceCommand} */ - public deleteResource( + deleteResource( args: DeleteResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResource( - args: DeleteResourceCommandInput, - cb: (err: any, data?: DeleteResourceCommandOutput) => void - ): void; - public deleteResource( + deleteResource(args: DeleteResourceCommandInput, cb: (err: any, data?: DeleteResourceCommandOutput) => void): void; + deleteResource( args: DeleteResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourceCommandOutput) => void ): void; - public deleteResource( - args: DeleteResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourceCommandOutput) => void), - cb?: (err: any, data?: DeleteResourceCommandOutput) => void - ): Promise | void { - const command = new DeleteResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the current state of the specified resource. For details, see - * Reading a resource's current state.

- *

You can use this action to return information about an existing resource in your account - * and Amazon Web Services Region, whether those resources were provisioned using Cloud Control API.

+ * @see {@link GetResourceCommand} */ - public getResource(args: GetResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public getResource(args: GetResourceCommandInput, cb: (err: any, data?: GetResourceCommandOutput) => void): void; - public getResource( + getResource(args: GetResourceCommandInput, options?: __HttpHandlerOptions): Promise; + getResource(args: GetResourceCommandInput, cb: (err: any, data?: GetResourceCommandOutput) => void): void; + getResource( args: GetResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceCommandOutput) => void ): void; - public getResource( - args: GetResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourceCommandOutput) => void), - cb?: (err: any, data?: GetResourceCommandOutput) => void - ): Promise | void { - const command = new GetResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the current status of a resource operation request. For more information, see - * Tracking the progress of resource operation requests in the - * Amazon Web Services Cloud Control API User Guide.

+ * @see {@link GetResourceRequestStatusCommand} */ - public getResourceRequestStatus( + getResourceRequestStatus( args: GetResourceRequestStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourceRequestStatus( + getResourceRequestStatus( args: GetResourceRequestStatusCommandInput, cb: (err: any, data?: GetResourceRequestStatusCommandOutput) => void ): void; - public getResourceRequestStatus( + getResourceRequestStatus( args: GetResourceRequestStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceRequestStatusCommandOutput) => void ): void; - public getResourceRequestStatus( - args: GetResourceRequestStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourceRequestStatusCommandOutput) => void), - cb?: (err: any, data?: GetResourceRequestStatusCommandOutput) => void - ): Promise | void { - const command = new GetResourceRequestStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns existing resource operation requests. This includes requests of all status types. - * For more information, see Listing active resource operation requests in the - * Amazon Web Services Cloud Control API User Guide.

- * - *

Resource operation requests expire after 7 days.

- *
+ * @see {@link ListResourceRequestsCommand} */ - public listResourceRequests( + listResourceRequests( args: ListResourceRequestsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourceRequests( + listResourceRequests( args: ListResourceRequestsCommandInput, cb: (err: any, data?: ListResourceRequestsCommandOutput) => void ): void; - public listResourceRequests( + listResourceRequests( args: ListResourceRequestsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceRequestsCommandOutput) => void ): void; - public listResourceRequests( - args: ListResourceRequestsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourceRequestsCommandOutput) => void), - cb?: (err: any, data?: ListResourceRequestsCommandOutput) => void - ): Promise | void { - const command = new ListResourceRequestsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the specified resources. For more information, see Discovering resources in the Amazon Web Services Cloud Control API User Guide.

- *

You can use this action to return information about existing resources in your account and - * Amazon Web Services Region, whether those resources were provisioned using Cloud Control API.

+ * @see {@link ListResourcesCommand} */ - public listResources( - args: ListResourcesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listResources( - args: ListResourcesCommandInput, - cb: (err: any, data?: ListResourcesCommandOutput) => void - ): void; - public listResources( + listResources(args: ListResourcesCommandInput, options?: __HttpHandlerOptions): Promise; + listResources(args: ListResourcesCommandInput, cb: (err: any, data?: ListResourcesCommandOutput) => void): void; + listResources( args: ListResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourcesCommandOutput) => void ): void; - public listResources( - args: ListResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourcesCommandOutput) => void), - cb?: (err: any, data?: ListResourcesCommandOutput) => void - ): Promise | void { - const command = new ListResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified property values in the resource.

- *

You specify your resource property updates as a list of patch operations contained in a - * JSON patch document that adheres to the - * RFC 6902 - JavaScript Object - * Notation (JSON) Patch - * standard.

- *

For details on how Cloud Control API performs resource update operations, see Updating a resource in the Amazon Web Services Cloud Control API User Guide.

- *

After you have initiated a resource update request, you can monitor the progress of your - * request by calling GetResourceRequestStatus using the RequestToken of the - * ProgressEvent returned by UpdateResource.

- *

For more information about the properties of a specific resource, refer to the related - * topic for the resource in the Resource and property types reference in the CloudFormation Users Guide.

+ * @see {@link UpdateResourceCommand} */ - public updateResource( + updateResource( args: UpdateResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateResource( - args: UpdateResourceCommandInput, - cb: (err: any, data?: UpdateResourceCommandOutput) => void - ): void; - public updateResource( + updateResource(args: UpdateResourceCommandInput, cb: (err: any, data?: UpdateResourceCommandOutput) => void): void; + updateResource( args: UpdateResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResourceCommandOutput) => void ): void; - public updateResource( - args: UpdateResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResourceCommandOutput) => void), - cb?: (err: any, data?: UpdateResourceCommandOutput) => void - ): Promise | void { - const command = new UpdateResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

For more information about Amazon Web Services Cloud Control API, see the Amazon Web Services Cloud Control API User + * Guide.

+ */ +export class CloudControl extends CloudControlClient implements CloudControl {} +createAggregatedClient(commands, CloudControl); diff --git a/clients/client-clouddirectory/src/CloudDirectory.ts b/clients/client-clouddirectory/src/CloudDirectory.ts index 5ea55307df19..2cb4ccca7438 100644 --- a/clients/client-clouddirectory/src/CloudDirectory.ts +++ b/clients/client-clouddirectory/src/CloudDirectory.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CloudDirectoryClient } from "./CloudDirectoryClient"; +import { CloudDirectoryClient, CloudDirectoryClientConfig } from "./CloudDirectoryClient"; import { AddFacetToObjectCommand, AddFacetToObjectCommandInput, @@ -293,2182 +294,1036 @@ import { UpgradePublishedSchemaCommandOutput, } from "./commands/UpgradePublishedSchemaCommand"; -/** - * @public - * Amazon Cloud Directory - *

Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the - * development and management of cloud-scale web, mobile, and IoT applications. This guide - * describes the Cloud Directory operations that you can call programmatically and includes - * detailed information on data types and errors. For information about Cloud Directory features, see AWS Directory - * Service and the Amazon Cloud Directory Developer Guide.

- */ -export class CloudDirectory extends CloudDirectoryClient { +const commands = { + AddFacetToObjectCommand, + ApplySchemaCommand, + AttachObjectCommand, + AttachPolicyCommand, + AttachToIndexCommand, + AttachTypedLinkCommand, + BatchReadCommand, + BatchWriteCommand, + CreateDirectoryCommand, + CreateFacetCommand, + CreateIndexCommand, + CreateObjectCommand, + CreateSchemaCommand, + CreateTypedLinkFacetCommand, + DeleteDirectoryCommand, + DeleteFacetCommand, + DeleteObjectCommand, + DeleteSchemaCommand, + DeleteTypedLinkFacetCommand, + DetachFromIndexCommand, + DetachObjectCommand, + DetachPolicyCommand, + DetachTypedLinkCommand, + DisableDirectoryCommand, + EnableDirectoryCommand, + GetAppliedSchemaVersionCommand, + GetDirectoryCommand, + GetFacetCommand, + GetLinkAttributesCommand, + GetObjectAttributesCommand, + GetObjectInformationCommand, + GetSchemaAsJsonCommand, + GetTypedLinkFacetInformationCommand, + ListAppliedSchemaArnsCommand, + ListAttachedIndicesCommand, + ListDevelopmentSchemaArnsCommand, + ListDirectoriesCommand, + ListFacetAttributesCommand, + ListFacetNamesCommand, + ListIncomingTypedLinksCommand, + ListIndexCommand, + ListManagedSchemaArnsCommand, + ListObjectAttributesCommand, + ListObjectChildrenCommand, + ListObjectParentPathsCommand, + ListObjectParentsCommand, + ListObjectPoliciesCommand, + ListOutgoingTypedLinksCommand, + ListPolicyAttachmentsCommand, + ListPublishedSchemaArnsCommand, + ListTagsForResourceCommand, + ListTypedLinkFacetAttributesCommand, + ListTypedLinkFacetNamesCommand, + LookupPolicyCommand, + PublishSchemaCommand, + PutSchemaFromJsonCommand, + RemoveFacetFromObjectCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateFacetCommand, + UpdateLinkAttributesCommand, + UpdateObjectAttributesCommand, + UpdateSchemaCommand, + UpdateTypedLinkFacetCommand, + UpgradeAppliedSchemaCommand, + UpgradePublishedSchemaCommand, +}; + +export interface CloudDirectory { /** - * @public - *

Adds a new Facet to an object. An object can have more than one facet applied on it.

+ * @see {@link AddFacetToObjectCommand} */ - public addFacetToObject( + addFacetToObject( args: AddFacetToObjectCommandInput, options?: __HttpHandlerOptions ): Promise; - public addFacetToObject( + addFacetToObject( args: AddFacetToObjectCommandInput, cb: (err: any, data?: AddFacetToObjectCommandOutput) => void ): void; - public addFacetToObject( + addFacetToObject( args: AddFacetToObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddFacetToObjectCommandOutput) => void ): void; - public addFacetToObject( - args: AddFacetToObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddFacetToObjectCommandOutput) => void), - cb?: (err: any, data?: AddFacetToObjectCommandOutput) => void - ): Promise | void { - const command = new AddFacetToObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Copies the input published schema, at the specified version, into the Directory with the same - * name and version as that of the published schema.

- */ - public applySchema(args: ApplySchemaCommandInput, options?: __HttpHandlerOptions): Promise; - public applySchema(args: ApplySchemaCommandInput, cb: (err: any, data?: ApplySchemaCommandOutput) => void): void; - public applySchema( + + /** + * @see {@link ApplySchemaCommand} + */ + applySchema(args: ApplySchemaCommandInput, options?: __HttpHandlerOptions): Promise; + applySchema(args: ApplySchemaCommandInput, cb: (err: any, data?: ApplySchemaCommandOutput) => void): void; + applySchema( args: ApplySchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ApplySchemaCommandOutput) => void ): void; - public applySchema( - args: ApplySchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ApplySchemaCommandOutput) => void), - cb?: (err: any, data?: ApplySchemaCommandOutput) => void - ): Promise | void { - const command = new ApplySchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attaches an existing object to another object. An object can be accessed in two - * ways:

- *
    - *
  1. - *

    Using the path

    - *
  2. - *
  3. - *

    Using ObjectIdentifier - *

    - *
  4. - *
- */ - public attachObject( - args: AttachObjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public attachObject(args: AttachObjectCommandInput, cb: (err: any, data?: AttachObjectCommandOutput) => void): void; - public attachObject( + + /** + * @see {@link AttachObjectCommand} + */ + attachObject(args: AttachObjectCommandInput, options?: __HttpHandlerOptions): Promise; + attachObject(args: AttachObjectCommandInput, cb: (err: any, data?: AttachObjectCommandOutput) => void): void; + attachObject( args: AttachObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachObjectCommandOutput) => void ): void; - public attachObject( - args: AttachObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachObjectCommandOutput) => void), - cb?: (err: any, data?: AttachObjectCommandOutput) => void - ): Promise | void { - const command = new AttachObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attaches a policy object to a regular object. An object can have a limited number of attached - * policies.

- */ - public attachPolicy( - args: AttachPolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public attachPolicy(args: AttachPolicyCommandInput, cb: (err: any, data?: AttachPolicyCommandOutput) => void): void; - public attachPolicy( + + /** + * @see {@link AttachPolicyCommand} + */ + attachPolicy(args: AttachPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + attachPolicy(args: AttachPolicyCommandInput, cb: (err: any, data?: AttachPolicyCommandOutput) => void): void; + attachPolicy( args: AttachPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachPolicyCommandOutput) => void ): void; - public attachPolicy( - args: AttachPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachPolicyCommandOutput) => void), - cb?: (err: any, data?: AttachPolicyCommandOutput) => void - ): Promise | void { - const command = new AttachPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attaches the specified object to the specified index.

- */ - public attachToIndex( - args: AttachToIndexCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public attachToIndex( - args: AttachToIndexCommandInput, - cb: (err: any, data?: AttachToIndexCommandOutput) => void - ): void; - public attachToIndex( + + /** + * @see {@link AttachToIndexCommand} + */ + attachToIndex(args: AttachToIndexCommandInput, options?: __HttpHandlerOptions): Promise; + attachToIndex(args: AttachToIndexCommandInput, cb: (err: any, data?: AttachToIndexCommandOutput) => void): void; + attachToIndex( args: AttachToIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachToIndexCommandOutput) => void ): void; - public attachToIndex( - args: AttachToIndexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachToIndexCommandOutput) => void), - cb?: (err: any, data?: AttachToIndexCommandOutput) => void - ): Promise | void { - const command = new AttachToIndexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attaches a typed link to a specified source and target object. For more information, see Typed Links.

- */ - public attachTypedLink( + + /** + * @see {@link AttachTypedLinkCommand} + */ + attachTypedLink( args: AttachTypedLinkCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachTypedLink( - args: AttachTypedLinkCommandInput, - cb: (err: any, data?: AttachTypedLinkCommandOutput) => void - ): void; - public attachTypedLink( + attachTypedLink(args: AttachTypedLinkCommandInput, cb: (err: any, data?: AttachTypedLinkCommandOutput) => void): void; + attachTypedLink( args: AttachTypedLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachTypedLinkCommandOutput) => void ): void; - public attachTypedLink( - args: AttachTypedLinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachTypedLinkCommandOutput) => void), - cb?: (err: any, data?: AttachTypedLinkCommandOutput) => void - ): Promise | void { - const command = new AttachTypedLinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Performs all the read operations in a batch.

- */ - public batchRead(args: BatchReadCommandInput, options?: __HttpHandlerOptions): Promise; - public batchRead(args: BatchReadCommandInput, cb: (err: any, data?: BatchReadCommandOutput) => void): void; - public batchRead( + + /** + * @see {@link BatchReadCommand} + */ + batchRead(args: BatchReadCommandInput, options?: __HttpHandlerOptions): Promise; + batchRead(args: BatchReadCommandInput, cb: (err: any, data?: BatchReadCommandOutput) => void): void; + batchRead( args: BatchReadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchReadCommandOutput) => void ): void; - public batchRead( - args: BatchReadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchReadCommandOutput) => void), - cb?: (err: any, data?: BatchReadCommandOutput) => void - ): Promise | void { - const command = new BatchReadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Performs all the write operations in a batch. Either all the operations succeed or - * none.

- */ - public batchWrite(args: BatchWriteCommandInput, options?: __HttpHandlerOptions): Promise; - public batchWrite(args: BatchWriteCommandInput, cb: (err: any, data?: BatchWriteCommandOutput) => void): void; - public batchWrite( + + /** + * @see {@link BatchWriteCommand} + */ + batchWrite(args: BatchWriteCommandInput, options?: __HttpHandlerOptions): Promise; + batchWrite(args: BatchWriteCommandInput, cb: (err: any, data?: BatchWriteCommandOutput) => void): void; + batchWrite( args: BatchWriteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchWriteCommandOutput) => void ): void; - public batchWrite( - args: BatchWriteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchWriteCommandOutput) => void), - cb?: (err: any, data?: BatchWriteCommandOutput) => void - ): Promise | void { - const command = new BatchWriteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Directory by copying the published schema into the - * directory. A directory cannot be created without a schema.

- *

You can also quickly create a directory using a managed schema, called the - * QuickStartSchema. For more information, see Managed Schema in the Amazon Cloud Directory Developer Guide.

- */ - public createDirectory( + + /** + * @see {@link CreateDirectoryCommand} + */ + createDirectory( args: CreateDirectoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDirectory( - args: CreateDirectoryCommandInput, - cb: (err: any, data?: CreateDirectoryCommandOutput) => void - ): void; - public createDirectory( + createDirectory(args: CreateDirectoryCommandInput, cb: (err: any, data?: CreateDirectoryCommandOutput) => void): void; + createDirectory( args: CreateDirectoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDirectoryCommandOutput) => void ): void; - public createDirectory( - args: CreateDirectoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDirectoryCommandOutput) => void), - cb?: (err: any, data?: CreateDirectoryCommandOutput) => void - ): Promise | void { - const command = new CreateDirectoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new Facet in a schema. Facet creation is allowed only - * in development or applied schemas.

- */ - public createFacet(args: CreateFacetCommandInput, options?: __HttpHandlerOptions): Promise; - public createFacet(args: CreateFacetCommandInput, cb: (err: any, data?: CreateFacetCommandOutput) => void): void; - public createFacet( + + /** + * @see {@link CreateFacetCommand} + */ + createFacet(args: CreateFacetCommandInput, options?: __HttpHandlerOptions): Promise; + createFacet(args: CreateFacetCommandInput, cb: (err: any, data?: CreateFacetCommandOutput) => void): void; + createFacet( args: CreateFacetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFacetCommandOutput) => void ): void; - public createFacet( - args: CreateFacetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFacetCommandOutput) => void), - cb?: (err: any, data?: CreateFacetCommandOutput) => void - ): Promise | void { - const command = new CreateFacetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an index object. See Indexing and search for more information.

- */ - public createIndex(args: CreateIndexCommandInput, options?: __HttpHandlerOptions): Promise; - public createIndex(args: CreateIndexCommandInput, cb: (err: any, data?: CreateIndexCommandOutput) => void): void; - public createIndex( + + /** + * @see {@link CreateIndexCommand} + */ + createIndex(args: CreateIndexCommandInput, options?: __HttpHandlerOptions): Promise; + createIndex(args: CreateIndexCommandInput, cb: (err: any, data?: CreateIndexCommandOutput) => void): void; + createIndex( args: CreateIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIndexCommandOutput) => void ): void; - public createIndex( - args: CreateIndexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIndexCommandOutput) => void), - cb?: (err: any, data?: CreateIndexCommandOutput) => void - ): Promise | void { - const command = new CreateIndexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an object in a Directory. Additionally attaches the object to - * a parent, if a parent reference and LinkName is specified. An object is simply a - * collection of Facet attributes. You can also use this API call to create a - * policy object, if the facet from which you create the object is a policy facet.

- */ - public createObject( - args: CreateObjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createObject(args: CreateObjectCommandInput, cb: (err: any, data?: CreateObjectCommandOutput) => void): void; - public createObject( + + /** + * @see {@link CreateObjectCommand} + */ + createObject(args: CreateObjectCommandInput, options?: __HttpHandlerOptions): Promise; + createObject(args: CreateObjectCommandInput, cb: (err: any, data?: CreateObjectCommandOutput) => void): void; + createObject( args: CreateObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateObjectCommandOutput) => void ): void; - public createObject( - args: CreateObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateObjectCommandOutput) => void), - cb?: (err: any, data?: CreateObjectCommandOutput) => void - ): Promise | void { - const command = new CreateObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new schema in a development state. A schema can exist in three - * phases:

- *
    - *
  • - *

    - * Development: This is a mutable phase of the schema. All new - * schemas are in the development phase. Once the schema is finalized, it can be - * published.

    - *
  • - *
  • - *

    - * Published: Published schemas are immutable and have a version - * associated with them.

    - *
  • - *
  • - *

    - * Applied: Applied schemas are mutable in a way that allows you - * to add new schema facets. You can also add new, nonrequired attributes to existing schema - * facets. You can apply only published schemas to directories.

    - *
  • - *
- */ - public createSchema( - args: CreateSchemaCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createSchema(args: CreateSchemaCommandInput, cb: (err: any, data?: CreateSchemaCommandOutput) => void): void; - public createSchema( + + /** + * @see {@link CreateSchemaCommand} + */ + createSchema(args: CreateSchemaCommandInput, options?: __HttpHandlerOptions): Promise; + createSchema(args: CreateSchemaCommandInput, cb: (err: any, data?: CreateSchemaCommandOutput) => void): void; + createSchema( args: CreateSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSchemaCommandOutput) => void ): void; - public createSchema( - args: CreateSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSchemaCommandOutput) => void), - cb?: (err: any, data?: CreateSchemaCommandOutput) => void - ): Promise | void { - const command = new CreateSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a TypedLinkFacet. For more information, see Typed Links.

- */ - public createTypedLinkFacet( + + /** + * @see {@link CreateTypedLinkFacetCommand} + */ + createTypedLinkFacet( args: CreateTypedLinkFacetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTypedLinkFacet( + createTypedLinkFacet( args: CreateTypedLinkFacetCommandInput, cb: (err: any, data?: CreateTypedLinkFacetCommandOutput) => void ): void; - public createTypedLinkFacet( + createTypedLinkFacet( args: CreateTypedLinkFacetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTypedLinkFacetCommandOutput) => void ): void; - public createTypedLinkFacet( - args: CreateTypedLinkFacetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTypedLinkFacetCommandOutput) => void), - cb?: (err: any, data?: CreateTypedLinkFacetCommandOutput) => void - ): Promise | void { - const command = new CreateTypedLinkFacetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme - * caution - * when deleting directories.

- */ - public deleteDirectory( + + /** + * @see {@link DeleteDirectoryCommand} + */ + deleteDirectory( args: DeleteDirectoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDirectory( - args: DeleteDirectoryCommandInput, - cb: (err: any, data?: DeleteDirectoryCommandOutput) => void - ): void; - public deleteDirectory( + deleteDirectory(args: DeleteDirectoryCommandInput, cb: (err: any, data?: DeleteDirectoryCommandOutput) => void): void; + deleteDirectory( args: DeleteDirectoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDirectoryCommandOutput) => void ): void; - public deleteDirectory( - args: DeleteDirectoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDirectoryCommandOutput) => void), - cb?: (err: any, data?: DeleteDirectoryCommandOutput) => void - ): Promise | void { - const command = new DeleteDirectoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a given Facet. All attributes and Rules - * that are associated with the facet will be deleted. Only development schema facets are allowed - * deletion.

- */ - public deleteFacet(args: DeleteFacetCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteFacet(args: DeleteFacetCommandInput, cb: (err: any, data?: DeleteFacetCommandOutput) => void): void; - public deleteFacet( + + /** + * @see {@link DeleteFacetCommand} + */ + deleteFacet(args: DeleteFacetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteFacet(args: DeleteFacetCommandInput, cb: (err: any, data?: DeleteFacetCommandOutput) => void): void; + deleteFacet( args: DeleteFacetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFacetCommandOutput) => void ): void; - public deleteFacet( - args: DeleteFacetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFacetCommandOutput) => void), - cb?: (err: any, data?: DeleteFacetCommandOutput) => void - ): Promise | void { - const command = new DeleteFacetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an object and its associated attributes. Only objects with no children and no - * parents can be deleted. The maximum number of attributes that can be deleted during an object deletion is 30. For more information, see Amazon Cloud Directory Limits.

- */ - public deleteObject( - args: DeleteObjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteObject(args: DeleteObjectCommandInput, cb: (err: any, data?: DeleteObjectCommandOutput) => void): void; - public deleteObject( + + /** + * @see {@link DeleteObjectCommand} + */ + deleteObject(args: DeleteObjectCommandInput, options?: __HttpHandlerOptions): Promise; + deleteObject(args: DeleteObjectCommandInput, cb: (err: any, data?: DeleteObjectCommandOutput) => void): void; + deleteObject( args: DeleteObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteObjectCommandOutput) => void ): void; - public deleteObject( - args: DeleteObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteObjectCommandOutput) => void), - cb?: (err: any, data?: DeleteObjectCommandOutput) => void - ): Promise | void { - const command = new DeleteObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a given schema. Schemas in a development and published state can only be deleted.

- */ - public deleteSchema( - args: DeleteSchemaCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteSchema(args: DeleteSchemaCommandInput, cb: (err: any, data?: DeleteSchemaCommandOutput) => void): void; - public deleteSchema( + + /** + * @see {@link DeleteSchemaCommand} + */ + deleteSchema(args: DeleteSchemaCommandInput, options?: __HttpHandlerOptions): Promise; + deleteSchema(args: DeleteSchemaCommandInput, cb: (err: any, data?: DeleteSchemaCommandOutput) => void): void; + deleteSchema( args: DeleteSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSchemaCommandOutput) => void ): void; - public deleteSchema( - args: DeleteSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSchemaCommandOutput) => void), - cb?: (err: any, data?: DeleteSchemaCommandOutput) => void - ): Promise | void { - const command = new DeleteSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a TypedLinkFacet. For more information, see Typed Links.

- */ - public deleteTypedLinkFacet( + + /** + * @see {@link DeleteTypedLinkFacetCommand} + */ + deleteTypedLinkFacet( args: DeleteTypedLinkFacetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTypedLinkFacet( + deleteTypedLinkFacet( args: DeleteTypedLinkFacetCommandInput, cb: (err: any, data?: DeleteTypedLinkFacetCommandOutput) => void ): void; - public deleteTypedLinkFacet( + deleteTypedLinkFacet( args: DeleteTypedLinkFacetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTypedLinkFacetCommandOutput) => void ): void; - public deleteTypedLinkFacet( - args: DeleteTypedLinkFacetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTypedLinkFacetCommandOutput) => void), - cb?: (err: any, data?: DeleteTypedLinkFacetCommandOutput) => void - ): Promise | void { - const command = new DeleteTypedLinkFacetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detaches the specified object from the specified index.

- */ - public detachFromIndex( + + /** + * @see {@link DetachFromIndexCommand} + */ + detachFromIndex( args: DetachFromIndexCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachFromIndex( - args: DetachFromIndexCommandInput, - cb: (err: any, data?: DetachFromIndexCommandOutput) => void - ): void; - public detachFromIndex( + detachFromIndex(args: DetachFromIndexCommandInput, cb: (err: any, data?: DetachFromIndexCommandOutput) => void): void; + detachFromIndex( args: DetachFromIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachFromIndexCommandOutput) => void ): void; - public detachFromIndex( - args: DetachFromIndexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachFromIndexCommandOutput) => void), - cb?: (err: any, data?: DetachFromIndexCommandOutput) => void - ): Promise | void { - const command = new DetachFromIndexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detaches a given object from the parent object. The object that is to be detached from the - * parent is specified by the link name.

- */ - public detachObject( - args: DetachObjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public detachObject(args: DetachObjectCommandInput, cb: (err: any, data?: DetachObjectCommandOutput) => void): void; - public detachObject( + + /** + * @see {@link DetachObjectCommand} + */ + detachObject(args: DetachObjectCommandInput, options?: __HttpHandlerOptions): Promise; + detachObject(args: DetachObjectCommandInput, cb: (err: any, data?: DetachObjectCommandOutput) => void): void; + detachObject( args: DetachObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachObjectCommandOutput) => void ): void; - public detachObject( - args: DetachObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachObjectCommandOutput) => void), - cb?: (err: any, data?: DetachObjectCommandOutput) => void - ): Promise | void { - const command = new DetachObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detaches a policy from an object.

- */ - public detachPolicy( - args: DetachPolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public detachPolicy(args: DetachPolicyCommandInput, cb: (err: any, data?: DetachPolicyCommandOutput) => void): void; - public detachPolicy( + + /** + * @see {@link DetachPolicyCommand} + */ + detachPolicy(args: DetachPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + detachPolicy(args: DetachPolicyCommandInput, cb: (err: any, data?: DetachPolicyCommandOutput) => void): void; + detachPolicy( args: DetachPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachPolicyCommandOutput) => void ): void; - public detachPolicy( - args: DetachPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachPolicyCommandOutput) => void), - cb?: (err: any, data?: DetachPolicyCommandOutput) => void - ): Promise | void { - const command = new DetachPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detaches a typed link from a specified source and target object. For more information, see Typed Links.

- */ - public detachTypedLink( + + /** + * @see {@link DetachTypedLinkCommand} + */ + detachTypedLink( args: DetachTypedLinkCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachTypedLink( - args: DetachTypedLinkCommandInput, - cb: (err: any, data?: DetachTypedLinkCommandOutput) => void - ): void; - public detachTypedLink( + detachTypedLink(args: DetachTypedLinkCommandInput, cb: (err: any, data?: DetachTypedLinkCommandOutput) => void): void; + detachTypedLink( args: DetachTypedLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachTypedLinkCommandOutput) => void ): void; - public detachTypedLink( - args: DetachTypedLinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachTypedLinkCommandOutput) => void), - cb?: (err: any, data?: DetachTypedLinkCommandOutput) => void - ): Promise | void { - const command = new DetachTypedLinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables the specified directory. Disabled directories cannot be read or written to. - * Only enabled directories can be disabled. Disabled directories may be reenabled.

- */ - public disableDirectory( + + /** + * @see {@link DisableDirectoryCommand} + */ + disableDirectory( args: DisableDirectoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableDirectory( + disableDirectory( args: DisableDirectoryCommandInput, cb: (err: any, data?: DisableDirectoryCommandOutput) => void ): void; - public disableDirectory( + disableDirectory( args: DisableDirectoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableDirectoryCommandOutput) => void ): void; - public disableDirectory( - args: DisableDirectoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableDirectoryCommandOutput) => void), - cb?: (err: any, data?: DisableDirectoryCommandOutput) => void - ): Promise | void { - const command = new DisableDirectoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables the specified directory. Only disabled directories can be enabled. Once - * enabled, the directory can then be read and written to.

- */ - public enableDirectory( + + /** + * @see {@link EnableDirectoryCommand} + */ + enableDirectory( args: EnableDirectoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableDirectory( - args: EnableDirectoryCommandInput, - cb: (err: any, data?: EnableDirectoryCommandOutput) => void - ): void; - public enableDirectory( + enableDirectory(args: EnableDirectoryCommandInput, cb: (err: any, data?: EnableDirectoryCommandOutput) => void): void; + enableDirectory( args: EnableDirectoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableDirectoryCommandOutput) => void ): void; - public enableDirectory( - args: EnableDirectoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableDirectoryCommandOutput) => void), - cb?: (err: any, data?: EnableDirectoryCommandOutput) => void - ): Promise | void { - const command = new EnableDirectoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns current applied schema version ARN, including the minor version in use.

- */ - public getAppliedSchemaVersion( + + /** + * @see {@link GetAppliedSchemaVersionCommand} + */ + getAppliedSchemaVersion( args: GetAppliedSchemaVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAppliedSchemaVersion( + getAppliedSchemaVersion( args: GetAppliedSchemaVersionCommandInput, cb: (err: any, data?: GetAppliedSchemaVersionCommandOutput) => void ): void; - public getAppliedSchemaVersion( + getAppliedSchemaVersion( args: GetAppliedSchemaVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAppliedSchemaVersionCommandOutput) => void ): void; - public getAppliedSchemaVersion( - args: GetAppliedSchemaVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAppliedSchemaVersionCommandOutput) => void), - cb?: (err: any, data?: GetAppliedSchemaVersionCommandOutput) => void - ): Promise | void { - const command = new GetAppliedSchemaVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves metadata about a directory.

- */ - public getDirectory( - args: GetDirectoryCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getDirectory(args: GetDirectoryCommandInput, cb: (err: any, data?: GetDirectoryCommandOutput) => void): void; - public getDirectory( + + /** + * @see {@link GetDirectoryCommand} + */ + getDirectory(args: GetDirectoryCommandInput, options?: __HttpHandlerOptions): Promise; + getDirectory(args: GetDirectoryCommandInput, cb: (err: any, data?: GetDirectoryCommandOutput) => void): void; + getDirectory( args: GetDirectoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDirectoryCommandOutput) => void ): void; - public getDirectory( - args: GetDirectoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDirectoryCommandOutput) => void), - cb?: (err: any, data?: GetDirectoryCommandOutput) => void - ): Promise | void { - const command = new GetDirectoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets details of the Facet, such as facet name, attributes, Rules, or ObjectType. You can call this on all kinds of schema - * facets -- published, development, or applied.

- */ - public getFacet(args: GetFacetCommandInput, options?: __HttpHandlerOptions): Promise; - public getFacet(args: GetFacetCommandInput, cb: (err: any, data?: GetFacetCommandOutput) => void): void; - public getFacet( + + /** + * @see {@link GetFacetCommand} + */ + getFacet(args: GetFacetCommandInput, options?: __HttpHandlerOptions): Promise; + getFacet(args: GetFacetCommandInput, cb: (err: any, data?: GetFacetCommandOutput) => void): void; + getFacet( args: GetFacetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFacetCommandOutput) => void ): void; - public getFacet( - args: GetFacetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFacetCommandOutput) => void), - cb?: (err: any, data?: GetFacetCommandOutput) => void - ): Promise | void { - const command = new GetFacetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves attributes that are associated with a typed link.

- */ - public getLinkAttributes( + + /** + * @see {@link GetLinkAttributesCommand} + */ + getLinkAttributes( args: GetLinkAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLinkAttributes( + getLinkAttributes( args: GetLinkAttributesCommandInput, cb: (err: any, data?: GetLinkAttributesCommandOutput) => void ): void; - public getLinkAttributes( + getLinkAttributes( args: GetLinkAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLinkAttributesCommandOutput) => void ): void; - public getLinkAttributes( - args: GetLinkAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLinkAttributesCommandOutput) => void), - cb?: (err: any, data?: GetLinkAttributesCommandOutput) => void - ): Promise | void { - const command = new GetLinkAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves attributes within a facet that are associated with an object.

- */ - public getObjectAttributes( + + /** + * @see {@link GetObjectAttributesCommand} + */ + getObjectAttributes( args: GetObjectAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getObjectAttributes( + getObjectAttributes( args: GetObjectAttributesCommandInput, cb: (err: any, data?: GetObjectAttributesCommandOutput) => void ): void; - public getObjectAttributes( + getObjectAttributes( args: GetObjectAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetObjectAttributesCommandOutput) => void ): void; - public getObjectAttributes( - args: GetObjectAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetObjectAttributesCommandOutput) => void), - cb?: (err: any, data?: GetObjectAttributesCommandOutput) => void - ): Promise | void { - const command = new GetObjectAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves metadata about an object.

- */ - public getObjectInformation( + + /** + * @see {@link GetObjectInformationCommand} + */ + getObjectInformation( args: GetObjectInformationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getObjectInformation( + getObjectInformation( args: GetObjectInformationCommandInput, cb: (err: any, data?: GetObjectInformationCommandOutput) => void ): void; - public getObjectInformation( + getObjectInformation( args: GetObjectInformationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetObjectInformationCommandOutput) => void ): void; - public getObjectInformation( - args: GetObjectInformationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetObjectInformationCommandOutput) => void), - cb?: (err: any, data?: GetObjectInformationCommandOutput) => void - ): Promise | void { - const command = new GetObjectInformationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a JSON representation of the schema. See JSON Schema Format for more information.

- */ - public getSchemaAsJson( + + /** + * @see {@link GetSchemaAsJsonCommand} + */ + getSchemaAsJson( args: GetSchemaAsJsonCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSchemaAsJson( - args: GetSchemaAsJsonCommandInput, - cb: (err: any, data?: GetSchemaAsJsonCommandOutput) => void - ): void; - public getSchemaAsJson( + getSchemaAsJson(args: GetSchemaAsJsonCommandInput, cb: (err: any, data?: GetSchemaAsJsonCommandOutput) => void): void; + getSchemaAsJson( args: GetSchemaAsJsonCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSchemaAsJsonCommandOutput) => void ): void; - public getSchemaAsJson( - args: GetSchemaAsJsonCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSchemaAsJsonCommandOutput) => void), - cb?: (err: any, data?: GetSchemaAsJsonCommandOutput) => void - ): Promise | void { - const command = new GetSchemaAsJsonCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed Links.

- */ - public getTypedLinkFacetInformation( + + /** + * @see {@link GetTypedLinkFacetInformationCommand} + */ + getTypedLinkFacetInformation( args: GetTypedLinkFacetInformationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTypedLinkFacetInformation( + getTypedLinkFacetInformation( args: GetTypedLinkFacetInformationCommandInput, cb: (err: any, data?: GetTypedLinkFacetInformationCommandOutput) => void ): void; - public getTypedLinkFacetInformation( + getTypedLinkFacetInformation( args: GetTypedLinkFacetInformationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTypedLinkFacetInformationCommandOutput) => void ): void; - public getTypedLinkFacetInformation( - args: GetTypedLinkFacetInformationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTypedLinkFacetInformationCommandOutput) => void), - cb?: (err: any, data?: GetTypedLinkFacetInformationCommandOutput) => void - ): Promise | void { - const command = new GetTypedLinkFacetInformationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists schema major versions applied to a directory. If SchemaArn is provided, lists the minor version.

- */ - public listAppliedSchemaArns( + + /** + * @see {@link ListAppliedSchemaArnsCommand} + */ + listAppliedSchemaArns( args: ListAppliedSchemaArnsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAppliedSchemaArns( + listAppliedSchemaArns( args: ListAppliedSchemaArnsCommandInput, cb: (err: any, data?: ListAppliedSchemaArnsCommandOutput) => void ): void; - public listAppliedSchemaArns( + listAppliedSchemaArns( args: ListAppliedSchemaArnsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppliedSchemaArnsCommandOutput) => void ): void; - public listAppliedSchemaArns( - args: ListAppliedSchemaArnsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppliedSchemaArnsCommandOutput) => void), - cb?: (err: any, data?: ListAppliedSchemaArnsCommandOutput) => void - ): Promise | void { - const command = new ListAppliedSchemaArnsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists indices attached to the specified object.

- */ - public listAttachedIndices( + + /** + * @see {@link ListAttachedIndicesCommand} + */ + listAttachedIndices( args: ListAttachedIndicesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAttachedIndices( + listAttachedIndices( args: ListAttachedIndicesCommandInput, cb: (err: any, data?: ListAttachedIndicesCommandOutput) => void ): void; - public listAttachedIndices( + listAttachedIndices( args: ListAttachedIndicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAttachedIndicesCommandOutput) => void ): void; - public listAttachedIndices( - args: ListAttachedIndicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAttachedIndicesCommandOutput) => void), - cb?: (err: any, data?: ListAttachedIndicesCommandOutput) => void - ): Promise | void { - const command = new ListAttachedIndicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves each Amazon Resource Name (ARN) of schemas in the development - * state.

- */ - public listDevelopmentSchemaArns( + + /** + * @see {@link ListDevelopmentSchemaArnsCommand} + */ + listDevelopmentSchemaArns( args: ListDevelopmentSchemaArnsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDevelopmentSchemaArns( + listDevelopmentSchemaArns( args: ListDevelopmentSchemaArnsCommandInput, cb: (err: any, data?: ListDevelopmentSchemaArnsCommandOutput) => void ): void; - public listDevelopmentSchemaArns( + listDevelopmentSchemaArns( args: ListDevelopmentSchemaArnsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDevelopmentSchemaArnsCommandOutput) => void ): void; - public listDevelopmentSchemaArns( - args: ListDevelopmentSchemaArnsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDevelopmentSchemaArnsCommandOutput) => void), - cb?: (err: any, data?: ListDevelopmentSchemaArnsCommandOutput) => void - ): Promise | void { - const command = new ListDevelopmentSchemaArnsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists directories created within an account.

- */ - public listDirectories( + + /** + * @see {@link ListDirectoriesCommand} + */ + listDirectories( args: ListDirectoriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDirectories( - args: ListDirectoriesCommandInput, - cb: (err: any, data?: ListDirectoriesCommandOutput) => void - ): void; - public listDirectories( + listDirectories(args: ListDirectoriesCommandInput, cb: (err: any, data?: ListDirectoriesCommandOutput) => void): void; + listDirectories( args: ListDirectoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDirectoriesCommandOutput) => void ): void; - public listDirectories( - args: ListDirectoriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDirectoriesCommandOutput) => void), - cb?: (err: any, data?: ListDirectoriesCommandOutput) => void - ): Promise | void { - const command = new ListDirectoriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves attributes attached to the facet.

- */ - public listFacetAttributes( + + /** + * @see {@link ListFacetAttributesCommand} + */ + listFacetAttributes( args: ListFacetAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFacetAttributes( + listFacetAttributes( args: ListFacetAttributesCommandInput, cb: (err: any, data?: ListFacetAttributesCommandOutput) => void ): void; - public listFacetAttributes( + listFacetAttributes( args: ListFacetAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFacetAttributesCommandOutput) => void ): void; - public listFacetAttributes( - args: ListFacetAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFacetAttributesCommandOutput) => void), - cb?: (err: any, data?: ListFacetAttributesCommandOutput) => void - ): Promise | void { - const command = new ListFacetAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the names of facets that exist in a schema.

- */ - public listFacetNames( + + /** + * @see {@link ListFacetNamesCommand} + */ + listFacetNames( args: ListFacetNamesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFacetNames( - args: ListFacetNamesCommandInput, - cb: (err: any, data?: ListFacetNamesCommandOutput) => void - ): void; - public listFacetNames( + listFacetNames(args: ListFacetNamesCommandInput, cb: (err: any, data?: ListFacetNamesCommandOutput) => void): void; + listFacetNames( args: ListFacetNamesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFacetNamesCommandOutput) => void ): void; - public listFacetNames( - args: ListFacetNamesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFacetNamesCommandOutput) => void), - cb?: (err: any, data?: ListFacetNamesCommandOutput) => void - ): Promise | void { - const command = new ListFacetNamesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a paginated list of all the incoming TypedLinkSpecifier - * information for an object. It also supports filtering by typed link facet and identity - * attributes. For more information, see Typed Links.

- */ - public listIncomingTypedLinks( + + /** + * @see {@link ListIncomingTypedLinksCommand} + */ + listIncomingTypedLinks( args: ListIncomingTypedLinksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listIncomingTypedLinks( + listIncomingTypedLinks( args: ListIncomingTypedLinksCommandInput, cb: (err: any, data?: ListIncomingTypedLinksCommandOutput) => void ): void; - public listIncomingTypedLinks( + listIncomingTypedLinks( args: ListIncomingTypedLinksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIncomingTypedLinksCommandOutput) => void ): void; - public listIncomingTypedLinks( - args: ListIncomingTypedLinksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIncomingTypedLinksCommandOutput) => void), - cb?: (err: any, data?: ListIncomingTypedLinksCommandOutput) => void - ): Promise | void { - const command = new ListIncomingTypedLinksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists objects attached to the specified index.

- */ - public listIndex(args: ListIndexCommandInput, options?: __HttpHandlerOptions): Promise; - public listIndex(args: ListIndexCommandInput, cb: (err: any, data?: ListIndexCommandOutput) => void): void; - public listIndex( + + /** + * @see {@link ListIndexCommand} + */ + listIndex(args: ListIndexCommandInput, options?: __HttpHandlerOptions): Promise; + listIndex(args: ListIndexCommandInput, cb: (err: any, data?: ListIndexCommandOutput) => void): void; + listIndex( args: ListIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIndexCommandOutput) => void ): void; - public listIndex( - args: ListIndexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIndexCommandOutput) => void), - cb?: (err: any, data?: ListIndexCommandOutput) => void - ): Promise | void { - const command = new ListIndexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the major version families of each managed schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.

- */ - public listManagedSchemaArns( + + /** + * @see {@link ListManagedSchemaArnsCommand} + */ + listManagedSchemaArns( args: ListManagedSchemaArnsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listManagedSchemaArns( + listManagedSchemaArns( args: ListManagedSchemaArnsCommandInput, cb: (err: any, data?: ListManagedSchemaArnsCommandOutput) => void ): void; - public listManagedSchemaArns( + listManagedSchemaArns( args: ListManagedSchemaArnsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListManagedSchemaArnsCommandOutput) => void ): void; - public listManagedSchemaArns( - args: ListManagedSchemaArnsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListManagedSchemaArnsCommandOutput) => void), - cb?: (err: any, data?: ListManagedSchemaArnsCommandOutput) => void - ): Promise | void { - const command = new ListManagedSchemaArnsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all attributes that are associated with an object. - *

- */ - public listObjectAttributes( + + /** + * @see {@link ListObjectAttributesCommand} + */ + listObjectAttributes( args: ListObjectAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listObjectAttributes( + listObjectAttributes( args: ListObjectAttributesCommandInput, cb: (err: any, data?: ListObjectAttributesCommandOutput) => void ): void; - public listObjectAttributes( + listObjectAttributes( args: ListObjectAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListObjectAttributesCommandOutput) => void ): void; - public listObjectAttributes( - args: ListObjectAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListObjectAttributesCommandOutput) => void), - cb?: (err: any, data?: ListObjectAttributesCommandOutput) => void - ): Promise | void { - const command = new ListObjectAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a paginated list of child objects that are associated with a given - * object.

- */ - public listObjectChildren( + + /** + * @see {@link ListObjectChildrenCommand} + */ + listObjectChildren( args: ListObjectChildrenCommandInput, options?: __HttpHandlerOptions ): Promise; - public listObjectChildren( + listObjectChildren( args: ListObjectChildrenCommandInput, cb: (err: any, data?: ListObjectChildrenCommandOutput) => void ): void; - public listObjectChildren( + listObjectChildren( args: ListObjectChildrenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListObjectChildrenCommandOutput) => void ): void; - public listObjectChildren( - args: ListObjectChildrenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListObjectChildrenCommandOutput) => void), - cb?: (err: any, data?: ListObjectChildrenCommandOutput) => void - ): Promise | void { - const command = new ListObjectChildrenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves all available parent paths for any object type such as node, leaf node, - * policy node, and index node objects. For more information about objects, see Directory Structure.

- *

Use this API to evaluate all parents for an object. The call returns all objects from - * the root of the directory up to the requested object. The API returns the number of paths - * based on user-defined MaxResults, in case there are multiple paths to the parent. - * The order of the paths and nodes returned is consistent among multiple API calls unless the - * objects are deleted or moved. Paths not leading to the directory root are ignored from the - * target object.

- */ - public listObjectParentPaths( + + /** + * @see {@link ListObjectParentPathsCommand} + */ + listObjectParentPaths( args: ListObjectParentPathsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listObjectParentPaths( + listObjectParentPaths( args: ListObjectParentPathsCommandInput, cb: (err: any, data?: ListObjectParentPathsCommandOutput) => void ): void; - public listObjectParentPaths( + listObjectParentPaths( args: ListObjectParentPathsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListObjectParentPathsCommandOutput) => void ): void; - public listObjectParentPaths( - args: ListObjectParentPathsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListObjectParentPathsCommandOutput) => void), - cb?: (err: any, data?: ListObjectParentPathsCommandOutput) => void - ): Promise | void { - const command = new ListObjectParentPathsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists parent objects that are associated with a given object in pagination - * fashion.

- */ - public listObjectParents( + + /** + * @see {@link ListObjectParentsCommand} + */ + listObjectParents( args: ListObjectParentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listObjectParents( + listObjectParents( args: ListObjectParentsCommandInput, cb: (err: any, data?: ListObjectParentsCommandOutput) => void ): void; - public listObjectParents( + listObjectParents( args: ListObjectParentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListObjectParentsCommandOutput) => void ): void; - public listObjectParents( - args: ListObjectParentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListObjectParentsCommandOutput) => void), - cb?: (err: any, data?: ListObjectParentsCommandOutput) => void - ): Promise | void { - const command = new ListObjectParentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns policies attached to an object in pagination fashion.

- */ - public listObjectPolicies( + + /** + * @see {@link ListObjectPoliciesCommand} + */ + listObjectPolicies( args: ListObjectPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listObjectPolicies( + listObjectPolicies( args: ListObjectPoliciesCommandInput, cb: (err: any, data?: ListObjectPoliciesCommandOutput) => void ): void; - public listObjectPolicies( + listObjectPolicies( args: ListObjectPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListObjectPoliciesCommandOutput) => void ): void; - public listObjectPolicies( - args: ListObjectPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListObjectPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListObjectPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListObjectPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a paginated list of all the outgoing TypedLinkSpecifier - * information for an object. It also supports filtering by typed link facet and identity - * attributes. For more information, see Typed Links.

- */ - public listOutgoingTypedLinks( + + /** + * @see {@link ListOutgoingTypedLinksCommand} + */ + listOutgoingTypedLinks( args: ListOutgoingTypedLinksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOutgoingTypedLinks( + listOutgoingTypedLinks( args: ListOutgoingTypedLinksCommandInput, cb: (err: any, data?: ListOutgoingTypedLinksCommandOutput) => void ): void; - public listOutgoingTypedLinks( + listOutgoingTypedLinks( args: ListOutgoingTypedLinksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOutgoingTypedLinksCommandOutput) => void ): void; - public listOutgoingTypedLinks( - args: ListOutgoingTypedLinksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOutgoingTypedLinksCommandOutput) => void), - cb?: (err: any, data?: ListOutgoingTypedLinksCommandOutput) => void - ): Promise | void { - const command = new ListOutgoingTypedLinksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns all of the ObjectIdentifiers to which a given policy is attached.

- */ - public listPolicyAttachments( + + /** + * @see {@link ListPolicyAttachmentsCommand} + */ + listPolicyAttachments( args: ListPolicyAttachmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPolicyAttachments( + listPolicyAttachments( args: ListPolicyAttachmentsCommandInput, cb: (err: any, data?: ListPolicyAttachmentsCommandOutput) => void ): void; - public listPolicyAttachments( + listPolicyAttachments( args: ListPolicyAttachmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPolicyAttachmentsCommandOutput) => void ): void; - public listPolicyAttachments( - args: ListPolicyAttachmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPolicyAttachmentsCommandOutput) => void), - cb?: (err: any, data?: ListPolicyAttachmentsCommandOutput) => void - ): Promise | void { - const command = new ListPolicyAttachmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the major version families of each published schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.

- */ - public listPublishedSchemaArns( + + /** + * @see {@link ListPublishedSchemaArnsCommand} + */ + listPublishedSchemaArns( args: ListPublishedSchemaArnsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPublishedSchemaArns( + listPublishedSchemaArns( args: ListPublishedSchemaArnsCommandInput, cb: (err: any, data?: ListPublishedSchemaArnsCommandOutput) => void ): void; - public listPublishedSchemaArns( + listPublishedSchemaArns( args: ListPublishedSchemaArnsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPublishedSchemaArnsCommandOutput) => void ): void; - public listPublishedSchemaArns( - args: ListPublishedSchemaArnsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPublishedSchemaArnsCommandOutput) => void), - cb?: (err: any, data?: ListPublishedSchemaArnsCommandOutput) => void - ): Promise | void { - const command = new ListPublishedSchemaArnsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns tags for a resource. Tagging is currently supported only for directories with a - * limit of 50 tags per directory. All 50 tags are returned for a given directory with this API - * call.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed Links.

- */ - public listTypedLinkFacetAttributes( + + /** + * @see {@link ListTypedLinkFacetAttributesCommand} + */ + listTypedLinkFacetAttributes( args: ListTypedLinkFacetAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTypedLinkFacetAttributes( + listTypedLinkFacetAttributes( args: ListTypedLinkFacetAttributesCommandInput, cb: (err: any, data?: ListTypedLinkFacetAttributesCommandOutput) => void ): void; - public listTypedLinkFacetAttributes( + listTypedLinkFacetAttributes( args: ListTypedLinkFacetAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTypedLinkFacetAttributesCommandOutput) => void ): void; - public listTypedLinkFacetAttributes( - args: ListTypedLinkFacetAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTypedLinkFacetAttributesCommandOutput) => void), - cb?: (err: any, data?: ListTypedLinkFacetAttributesCommandOutput) => void - ): Promise | void { - const command = new ListTypedLinkFacetAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a paginated list of TypedLink facet names for a particular schema. - * For more information, see Typed Links.

- */ - public listTypedLinkFacetNames( + + /** + * @see {@link ListTypedLinkFacetNamesCommand} + */ + listTypedLinkFacetNames( args: ListTypedLinkFacetNamesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTypedLinkFacetNames( + listTypedLinkFacetNames( args: ListTypedLinkFacetNamesCommandInput, cb: (err: any, data?: ListTypedLinkFacetNamesCommandOutput) => void ): void; - public listTypedLinkFacetNames( + listTypedLinkFacetNames( args: ListTypedLinkFacetNamesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTypedLinkFacetNamesCommandOutput) => void ): void; - public listTypedLinkFacetNames( - args: ListTypedLinkFacetNamesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTypedLinkFacetNamesCommandOutput) => void), - cb?: (err: any, data?: ListTypedLinkFacetNamesCommandOutput) => void - ): Promise | void { - const command = new ListTypedLinkFacetNamesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all policies from the root of the Directory to the object - * specified. If there are no policies present, an empty list is returned. If policies are - * present, and if some objects don't have the policies attached, it returns the ObjectIdentifier - * for such objects. If policies are present, it returns ObjectIdentifier, policyId, and - * policyType. Paths that don't lead to the root from the target object are ignored. For more - * information, see Policies.

- */ - public lookupPolicy( - args: LookupPolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public lookupPolicy(args: LookupPolicyCommandInput, cb: (err: any, data?: LookupPolicyCommandOutput) => void): void; - public lookupPolicy( + + /** + * @see {@link LookupPolicyCommand} + */ + lookupPolicy(args: LookupPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + lookupPolicy(args: LookupPolicyCommandInput, cb: (err: any, data?: LookupPolicyCommandOutput) => void): void; + lookupPolicy( args: LookupPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: LookupPolicyCommandOutput) => void ): void; - public lookupPolicy( - args: LookupPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: LookupPolicyCommandOutput) => void), - cb?: (err: any, data?: LookupPolicyCommandOutput) => void - ): Promise | void { - const command = new LookupPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Publishes a development schema with a major version and a recommended minor version.

- */ - public publishSchema( - args: PublishSchemaCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public publishSchema( - args: PublishSchemaCommandInput, - cb: (err: any, data?: PublishSchemaCommandOutput) => void - ): void; - public publishSchema( + + /** + * @see {@link PublishSchemaCommand} + */ + publishSchema(args: PublishSchemaCommandInput, options?: __HttpHandlerOptions): Promise; + publishSchema(args: PublishSchemaCommandInput, cb: (err: any, data?: PublishSchemaCommandOutput) => void): void; + publishSchema( args: PublishSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishSchemaCommandOutput) => void ): void; - public publishSchema( - args: PublishSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PublishSchemaCommandOutput) => void), - cb?: (err: any, data?: PublishSchemaCommandOutput) => void - ): Promise | void { - const command = new PublishSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information.

- */ - public putSchemaFromJson( + + /** + * @see {@link PutSchemaFromJsonCommand} + */ + putSchemaFromJson( args: PutSchemaFromJsonCommandInput, options?: __HttpHandlerOptions ): Promise; - public putSchemaFromJson( + putSchemaFromJson( args: PutSchemaFromJsonCommandInput, cb: (err: any, data?: PutSchemaFromJsonCommandOutput) => void ): void; - public putSchemaFromJson( + putSchemaFromJson( args: PutSchemaFromJsonCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSchemaFromJsonCommandOutput) => void ): void; - public putSchemaFromJson( - args: PutSchemaFromJsonCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutSchemaFromJsonCommandOutput) => void), - cb?: (err: any, data?: PutSchemaFromJsonCommandOutput) => void - ): Promise | void { - const command = new PutSchemaFromJsonCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the specified facet from the specified object.

- */ - public removeFacetFromObject( + + /** + * @see {@link RemoveFacetFromObjectCommand} + */ + removeFacetFromObject( args: RemoveFacetFromObjectCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeFacetFromObject( + removeFacetFromObject( args: RemoveFacetFromObjectCommandInput, cb: (err: any, data?: RemoveFacetFromObjectCommandOutput) => void ): void; - public removeFacetFromObject( + removeFacetFromObject( args: RemoveFacetFromObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveFacetFromObjectCommandOutput) => void ): void; - public removeFacetFromObject( - args: RemoveFacetFromObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveFacetFromObjectCommandOutput) => void), - cb?: (err: any, data?: RemoveFacetFromObjectCommandOutput) => void - ): Promise | void { - const command = new RemoveFacetFromObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

An API operation for adding tags to a resource.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

An API operation for removing tags from a resource.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Does the following:

- *
    - *
  1. - *

    Adds new Attributes, Rules, or ObjectTypes.

    - *
  2. - *
  3. - *

    Updates existing Attributes, Rules, or ObjectTypes.

    - *
  4. - *
  5. - *

    Deletes existing Attributes, Rules, or ObjectTypes.

    - *
  6. - *
- */ - public updateFacet(args: UpdateFacetCommandInput, options?: __HttpHandlerOptions): Promise; - public updateFacet(args: UpdateFacetCommandInput, cb: (err: any, data?: UpdateFacetCommandOutput) => void): void; - public updateFacet( + + /** + * @see {@link UpdateFacetCommand} + */ + updateFacet(args: UpdateFacetCommandInput, options?: __HttpHandlerOptions): Promise; + updateFacet(args: UpdateFacetCommandInput, cb: (err: any, data?: UpdateFacetCommandOutput) => void): void; + updateFacet( args: UpdateFacetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFacetCommandOutput) => void ): void; - public updateFacet( - args: UpdateFacetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFacetCommandOutput) => void), - cb?: (err: any, data?: UpdateFacetCommandOutput) => void - ): Promise | void { - const command = new UpdateFacetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a given typed link’s attributes. Attributes to be updated must not contribute to the typed link’s identity, as defined by its IdentityAttributeOrder.

- */ - public updateLinkAttributes( + + /** + * @see {@link UpdateLinkAttributesCommand} + */ + updateLinkAttributes( args: UpdateLinkAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLinkAttributes( + updateLinkAttributes( args: UpdateLinkAttributesCommandInput, cb: (err: any, data?: UpdateLinkAttributesCommandOutput) => void ): void; - public updateLinkAttributes( + updateLinkAttributes( args: UpdateLinkAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLinkAttributesCommandOutput) => void ): void; - public updateLinkAttributes( - args: UpdateLinkAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLinkAttributesCommandOutput) => void), - cb?: (err: any, data?: UpdateLinkAttributesCommandOutput) => void - ): Promise | void { - const command = new UpdateLinkAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a given object's attributes.

- */ - public updateObjectAttributes( + + /** + * @see {@link UpdateObjectAttributesCommand} + */ + updateObjectAttributes( args: UpdateObjectAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateObjectAttributes( + updateObjectAttributes( args: UpdateObjectAttributesCommandInput, cb: (err: any, data?: UpdateObjectAttributesCommandOutput) => void ): void; - public updateObjectAttributes( + updateObjectAttributes( args: UpdateObjectAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateObjectAttributesCommandOutput) => void ): void; - public updateObjectAttributes( - args: UpdateObjectAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateObjectAttributesCommandOutput) => void), - cb?: (err: any, data?: UpdateObjectAttributesCommandOutput) => void - ): Promise | void { - const command = new UpdateObjectAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the schema name with a new name. Only development schema names can be - * updated.

- */ - public updateSchema( - args: UpdateSchemaCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateSchema(args: UpdateSchemaCommandInput, cb: (err: any, data?: UpdateSchemaCommandOutput) => void): void; - public updateSchema( + + /** + * @see {@link UpdateSchemaCommand} + */ + updateSchema(args: UpdateSchemaCommandInput, options?: __HttpHandlerOptions): Promise; + updateSchema(args: UpdateSchemaCommandInput, cb: (err: any, data?: UpdateSchemaCommandOutput) => void): void; + updateSchema( args: UpdateSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSchemaCommandOutput) => void ): void; - public updateSchema( - args: UpdateSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSchemaCommandOutput) => void), - cb?: (err: any, data?: UpdateSchemaCommandOutput) => void - ): Promise | void { - const command = new UpdateSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a TypedLinkFacet. For more information, see Typed Links.

- */ - public updateTypedLinkFacet( + + /** + * @see {@link UpdateTypedLinkFacetCommand} + */ + updateTypedLinkFacet( args: UpdateTypedLinkFacetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTypedLinkFacet( + updateTypedLinkFacet( args: UpdateTypedLinkFacetCommandInput, cb: (err: any, data?: UpdateTypedLinkFacetCommandOutput) => void ): void; - public updateTypedLinkFacet( + updateTypedLinkFacet( args: UpdateTypedLinkFacetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTypedLinkFacetCommandOutput) => void ): void; - public updateTypedLinkFacet( - args: UpdateTypedLinkFacetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTypedLinkFacetCommandOutput) => void), - cb?: (err: any, data?: UpdateTypedLinkFacetCommandOutput) => void - ): Promise | void { - const command = new UpdateTypedLinkFacetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Upgrades a single directory in-place using the PublishedSchemaArn with schema updates found in MinorVersion. Backwards-compatible minor version upgrades are instantaneously available for readers on all objects in the directory. Note: This is a synchronous API call and upgrades only one schema on a given directory per call. To upgrade multiple directories from one schema, you would need to call this API on each directory.

- */ - public upgradeAppliedSchema( + + /** + * @see {@link UpgradeAppliedSchemaCommand} + */ + upgradeAppliedSchema( args: UpgradeAppliedSchemaCommandInput, options?: __HttpHandlerOptions ): Promise; - public upgradeAppliedSchema( + upgradeAppliedSchema( args: UpgradeAppliedSchemaCommandInput, cb: (err: any, data?: UpgradeAppliedSchemaCommandOutput) => void ): void; - public upgradeAppliedSchema( + upgradeAppliedSchema( args: UpgradeAppliedSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpgradeAppliedSchemaCommandOutput) => void ): void; - public upgradeAppliedSchema( - args: UpgradeAppliedSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpgradeAppliedSchemaCommandOutput) => void), - cb?: (err: any, data?: UpgradeAppliedSchemaCommandOutput) => void - ): Promise | void { - const command = new UpgradeAppliedSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Upgrades a published schema under a new minor version revision using the current contents of DevelopmentSchemaArn.

- */ - public upgradePublishedSchema( + + /** + * @see {@link UpgradePublishedSchemaCommand} + */ + upgradePublishedSchema( args: UpgradePublishedSchemaCommandInput, options?: __HttpHandlerOptions ): Promise; - public upgradePublishedSchema( + upgradePublishedSchema( args: UpgradePublishedSchemaCommandInput, cb: (err: any, data?: UpgradePublishedSchemaCommandOutput) => void ): void; - public upgradePublishedSchema( + upgradePublishedSchema( args: UpgradePublishedSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpgradePublishedSchemaCommandOutput) => void ): void; - public upgradePublishedSchema( - args: UpgradePublishedSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpgradePublishedSchemaCommandOutput) => void), - cb?: (err: any, data?: UpgradePublishedSchemaCommandOutput) => void - ): Promise | void { - const command = new UpgradePublishedSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Cloud Directory + *

Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the + * development and management of cloud-scale web, mobile, and IoT applications. This guide + * describes the Cloud Directory operations that you can call programmatically and includes + * detailed information on data types and errors. For information about Cloud Directory features, see AWS Directory + * Service and the Amazon Cloud Directory Developer Guide.

+ */ +export class CloudDirectory extends CloudDirectoryClient implements CloudDirectory {} +createAggregatedClient(commands, CloudDirectory); diff --git a/clients/client-cloudformation/src/CloudFormation.ts b/clients/client-cloudformation/src/CloudFormation.ts index a0cf3ef90ccd..c223e49917c6 100644 --- a/clients/client-cloudformation/src/CloudFormation.ts +++ b/clients/client-cloudformation/src/CloudFormation.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CloudFormationClient } from "./CloudFormationClient"; +import { CloudFormationClient, CloudFormationClientConfig } from "./CloudFormationClient"; import { ActivateTypeCommand, ActivateTypeCommandInput, @@ -293,2577 +294,1092 @@ import { ValidateTemplateCommandOutput, } from "./commands/ValidateTemplateCommand"; -/** - * @public - * CloudFormation - *

CloudFormation allows you to create and manage Amazon Web Services infrastructure - * deployments predictably and repeatedly. You can use CloudFormation to leverage - * Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, - * Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly - * reliable, highly scalable, cost-effective applications without creating or configuring the - * underlying Amazon Web Services infrastructure.

- *

With CloudFormation, you declare all your resources and dependencies in a template - * file. The template defines a collection of resources as a single unit called a stack. - * CloudFormation creates and deletes all member resources of the stack together and - * manages all dependencies between the resources for you.

- *

For more information about CloudFormation, see the CloudFormation product page.

- *

CloudFormation makes use of other Amazon Web Services products. If you need - * additional technical information about a specific Amazon Web Services product, you can find - * the product's technical documentation at - * docs.aws.amazon.com - * .

- */ -export class CloudFormation extends CloudFormationClient { +const commands = { + ActivateTypeCommand, + BatchDescribeTypeConfigurationsCommand, + CancelUpdateStackCommand, + ContinueUpdateRollbackCommand, + CreateChangeSetCommand, + CreateStackCommand, + CreateStackInstancesCommand, + CreateStackSetCommand, + DeactivateTypeCommand, + DeleteChangeSetCommand, + DeleteStackCommand, + DeleteStackInstancesCommand, + DeleteStackSetCommand, + DeregisterTypeCommand, + DescribeAccountLimitsCommand, + DescribeChangeSetCommand, + DescribeChangeSetHooksCommand, + DescribePublisherCommand, + DescribeStackDriftDetectionStatusCommand, + DescribeStackEventsCommand, + DescribeStackInstanceCommand, + DescribeStackResourceCommand, + DescribeStackResourceDriftsCommand, + DescribeStackResourcesCommand, + DescribeStacksCommand, + DescribeStackSetCommand, + DescribeStackSetOperationCommand, + DescribeTypeCommand, + DescribeTypeRegistrationCommand, + DetectStackDriftCommand, + DetectStackResourceDriftCommand, + DetectStackSetDriftCommand, + EstimateTemplateCostCommand, + ExecuteChangeSetCommand, + GetStackPolicyCommand, + GetTemplateCommand, + GetTemplateSummaryCommand, + ImportStacksToStackSetCommand, + ListChangeSetsCommand, + ListExportsCommand, + ListImportsCommand, + ListStackInstancesCommand, + ListStackResourcesCommand, + ListStacksCommand, + ListStackSetOperationResultsCommand, + ListStackSetOperationsCommand, + ListStackSetsCommand, + ListTypeRegistrationsCommand, + ListTypesCommand, + ListTypeVersionsCommand, + PublishTypeCommand, + RecordHandlerProgressCommand, + RegisterPublisherCommand, + RegisterTypeCommand, + RollbackStackCommand, + SetStackPolicyCommand, + SetTypeConfigurationCommand, + SetTypeDefaultVersionCommand, + SignalResourceCommand, + StopStackSetOperationCommand, + TestTypeCommand, + UpdateStackCommand, + UpdateStackInstancesCommand, + UpdateStackSetCommand, + UpdateTerminationProtectionCommand, + ValidateTemplateCommand, +}; + +export interface CloudFormation { /** - * @public - *

Activates a public third-party extension, making it available for use in stack - * templates. For more information, see Using - * public extensions in the CloudFormation User Guide.

- *

Once you have activated a public third-party extension in your account and region, use - * SetTypeConfiguration to specify configuration properties for the extension. For - * more information, see Configuring extensions at the account level in the CloudFormation User Guide.

+ * @see {@link ActivateTypeCommand} */ - public activateType( - args: ActivateTypeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public activateType(args: ActivateTypeCommandInput, cb: (err: any, data?: ActivateTypeCommandOutput) => void): void; - public activateType( + activateType(args: ActivateTypeCommandInput, options?: __HttpHandlerOptions): Promise; + activateType(args: ActivateTypeCommandInput, cb: (err: any, data?: ActivateTypeCommandOutput) => void): void; + activateType( args: ActivateTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ActivateTypeCommandOutput) => void ): void; - public activateType( - args: ActivateTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ActivateTypeCommandOutput) => void), - cb?: (err: any, data?: ActivateTypeCommandOutput) => void - ): Promise | void { - const command = new ActivateTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns configuration data for the specified CloudFormation extensions, from - * the CloudFormation registry for the account and region.

- *

For more information, see Configuring extensions at the account level in the - * CloudFormation User Guide.

- */ - public batchDescribeTypeConfigurations( + + /** + * @see {@link BatchDescribeTypeConfigurationsCommand} + */ + batchDescribeTypeConfigurations( args: BatchDescribeTypeConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDescribeTypeConfigurations( + batchDescribeTypeConfigurations( args: BatchDescribeTypeConfigurationsCommandInput, cb: (err: any, data?: BatchDescribeTypeConfigurationsCommandOutput) => void ): void; - public batchDescribeTypeConfigurations( + batchDescribeTypeConfigurations( args: BatchDescribeTypeConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDescribeTypeConfigurationsCommandOutput) => void ): void; - public batchDescribeTypeConfigurations( - args: BatchDescribeTypeConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDescribeTypeConfigurationsCommandOutput) => void), - cb?: (err: any, data?: BatchDescribeTypeConfigurationsCommandOutput) => void - ): Promise | void { - const command = new BatchDescribeTypeConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels an update on the specified stack. If the call completes successfully, the stack - * rolls back the update and reverts to the previous stack configuration.

- * - *

You can cancel only stacks that are in the UPDATE_IN_PROGRESS - * state.

- *
- */ - public cancelUpdateStack( + + /** + * @see {@link CancelUpdateStackCommand} + */ + cancelUpdateStack( args: CancelUpdateStackCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelUpdateStack( + cancelUpdateStack( args: CancelUpdateStackCommandInput, cb: (err: any, data?: CancelUpdateStackCommandOutput) => void ): void; - public cancelUpdateStack( + cancelUpdateStack( args: CancelUpdateStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelUpdateStackCommandOutput) => void ): void; - public cancelUpdateStack( - args: CancelUpdateStackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelUpdateStackCommandOutput) => void), - cb?: (err: any, data?: CancelUpdateStackCommandOutput) => void - ): Promise | void { - const command = new CancelUpdateStackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues - * rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause - * of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can - * return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and - * then try to update the stack again.

- *

A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll back all changes after a failed stack update. For example, you - * might have a stack that's rolling back to an old database instance that was deleted outside - * of CloudFormation. Because CloudFormation doesn't know the database was deleted, it - * assumes that the database instance still exists and attempts to roll back to it, causing - * the update rollback to fail.

- */ - public continueUpdateRollback( + + /** + * @see {@link ContinueUpdateRollbackCommand} + */ + continueUpdateRollback( args: ContinueUpdateRollbackCommandInput, options?: __HttpHandlerOptions ): Promise; - public continueUpdateRollback( + continueUpdateRollback( args: ContinueUpdateRollbackCommandInput, cb: (err: any, data?: ContinueUpdateRollbackCommandOutput) => void ): void; - public continueUpdateRollback( + continueUpdateRollback( args: ContinueUpdateRollbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ContinueUpdateRollbackCommandOutput) => void ): void; - public continueUpdateRollback( - args: ContinueUpdateRollbackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ContinueUpdateRollbackCommandOutput) => void), - cb?: (err: any, data?: ContinueUpdateRollbackCommandOutput) => void - ): Promise | void { - const command = new ContinueUpdateRollbackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a list of changes that will be applied to a stack so that you can review the - * changes before executing them. You can create a change set for a stack that doesn't exist - * or an existing stack. If you create a change set for a stack that doesn't exist, the change - * set shows all of the resources that CloudFormation will create. If you create a change - * set for an existing stack, CloudFormation compares the stack's information with the - * information that you submit in the change set and lists the differences. Use change sets to - * understand which resources CloudFormation will create or change, and how it will change - * resources in an existing stack, before you create or update a stack.

- *

To create a change set for a stack that doesn't exist, for the - * ChangeSetType parameter, specify CREATE. To create a change - * set for an existing stack, specify UPDATE for the ChangeSetType - * parameter. To create a change set for an import operation, specify IMPORT for - * the ChangeSetType parameter. After the CreateChangeSet call - * successfully completes, CloudFormation starts creating the change set. To check the - * status of the change set or to review it, use the DescribeChangeSet - * action.

- *

When you are satisfied with the changes the change set will make, execute the change set - * by using the ExecuteChangeSet action. CloudFormation doesn't make - * changes until you execute the change set.

- *

To create a change set for the entire stack hierarchy, set - * IncludeNestedStacks to True.

- */ - public createChangeSet( + + /** + * @see {@link CreateChangeSetCommand} + */ + createChangeSet( args: CreateChangeSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createChangeSet( - args: CreateChangeSetCommandInput, - cb: (err: any, data?: CreateChangeSetCommandOutput) => void - ): void; - public createChangeSet( + createChangeSet(args: CreateChangeSetCommandInput, cb: (err: any, data?: CreateChangeSetCommandOutput) => void): void; + createChangeSet( args: CreateChangeSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChangeSetCommandOutput) => void ): void; - public createChangeSet( - args: CreateChangeSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateChangeSetCommandOutput) => void), - cb?: (err: any, data?: CreateChangeSetCommandOutput) => void - ): Promise | void { - const command = new CreateChangeSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a stack as specified in the template. After the call completes successfully, the - * stack creation starts. You can check the status of the stack through the DescribeStacksoperation.

- */ - public createStack(args: CreateStackCommandInput, options?: __HttpHandlerOptions): Promise; - public createStack(args: CreateStackCommandInput, cb: (err: any, data?: CreateStackCommandOutput) => void): void; - public createStack( + + /** + * @see {@link CreateStackCommand} + */ + createStack(args: CreateStackCommandInput, options?: __HttpHandlerOptions): Promise; + createStack(args: CreateStackCommandInput, cb: (err: any, data?: CreateStackCommandOutput) => void): void; + createStack( args: CreateStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStackCommandOutput) => void ): void; - public createStack( - args: CreateStackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStackCommandOutput) => void), - cb?: (err: any, data?: CreateStackCommandOutput) => void - ): Promise | void { - const command = new CreateStackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region. - * You must specify at least one value for either Accounts or - * DeploymentTargets, and you must specify at least one value for - * Regions.

- */ - public createStackInstances( + + /** + * @see {@link CreateStackInstancesCommand} + */ + createStackInstances( args: CreateStackInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public createStackInstances( + createStackInstances( args: CreateStackInstancesCommandInput, cb: (err: any, data?: CreateStackInstancesCommandOutput) => void ): void; - public createStackInstances( + createStackInstances( args: CreateStackInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStackInstancesCommandOutput) => void ): void; - public createStackInstances( - args: CreateStackInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStackInstancesCommandOutput) => void), - cb?: (err: any, data?: CreateStackInstancesCommandOutput) => void - ): Promise | void { - const command = new CreateStackInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a stack set.

- */ - public createStackSet( + + /** + * @see {@link CreateStackSetCommand} + */ + createStackSet( args: CreateStackSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createStackSet( - args: CreateStackSetCommandInput, - cb: (err: any, data?: CreateStackSetCommandOutput) => void - ): void; - public createStackSet( + createStackSet(args: CreateStackSetCommandInput, cb: (err: any, data?: CreateStackSetCommandOutput) => void): void; + createStackSet( args: CreateStackSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStackSetCommandOutput) => void ): void; - public createStackSet( - args: CreateStackSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStackSetCommandOutput) => void), - cb?: (err: any, data?: CreateStackSetCommandOutput) => void - ): Promise | void { - const command = new CreateStackSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deactivates a public extension that was previously activated in this account and - * region.

- *

Once deactivated, an extension can't be used in any CloudFormation operation. - * This includes stack update operations where the stack template includes the extension, even - * if no updates are being made to the extension. In addition, deactivated extensions aren't - * automatically updated if a new version of the extension is released.

- */ - public deactivateType( + + /** + * @see {@link DeactivateTypeCommand} + */ + deactivateType( args: DeactivateTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deactivateType( - args: DeactivateTypeCommandInput, - cb: (err: any, data?: DeactivateTypeCommandOutput) => void - ): void; - public deactivateType( + deactivateType(args: DeactivateTypeCommandInput, cb: (err: any, data?: DeactivateTypeCommandOutput) => void): void; + deactivateType( args: DeactivateTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeactivateTypeCommandOutput) => void ): void; - public deactivateType( - args: DeactivateTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeactivateTypeCommandOutput) => void), - cb?: (err: any, data?: DeactivateTypeCommandOutput) => void - ): Promise | void { - const command = new DeactivateTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified change set. Deleting change sets ensures that no one executes the - * wrong change set.

- *

If the call successfully completes, CloudFormation successfully deleted the change - * set.

- *

If IncludeNestedStacks specifies True during the creation of - * the nested change set, then DeleteChangeSet will delete all change sets that - * belong to the stacks hierarchy and will also delete all change sets for nested stacks with - * the status of REVIEW_IN_PROGRESS.

- */ - public deleteChangeSet( + + /** + * @see {@link DeleteChangeSetCommand} + */ + deleteChangeSet( args: DeleteChangeSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteChangeSet( - args: DeleteChangeSetCommandInput, - cb: (err: any, data?: DeleteChangeSetCommandOutput) => void - ): void; - public deleteChangeSet( + deleteChangeSet(args: DeleteChangeSetCommandInput, cb: (err: any, data?: DeleteChangeSetCommandOutput) => void): void; + deleteChangeSet( args: DeleteChangeSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChangeSetCommandOutput) => void ): void; - public deleteChangeSet( - args: DeleteChangeSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteChangeSetCommandOutput) => void), - cb?: (err: any, data?: DeleteChangeSetCommandOutput) => void - ): Promise | void { - const command = new DeleteChangeSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specified stack. Once the call completes successfully, stack deletion starts. - * Deleted stacks don't show up in the DescribeStacks operation if the - * deletion has been completed successfully.

- */ - public deleteStack(args: DeleteStackCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteStack(args: DeleteStackCommandInput, cb: (err: any, data?: DeleteStackCommandOutput) => void): void; - public deleteStack( + + /** + * @see {@link DeleteStackCommand} + */ + deleteStack(args: DeleteStackCommandInput, options?: __HttpHandlerOptions): Promise; + deleteStack(args: DeleteStackCommandInput, cb: (err: any, data?: DeleteStackCommandOutput) => void): void; + deleteStack( args: DeleteStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStackCommandOutput) => void ): void; - public deleteStack( - args: DeleteStackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStackCommandOutput) => void), - cb?: (err: any, data?: DeleteStackCommandOutput) => void - ): Promise | void { - const command = new DeleteStackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.

- */ - public deleteStackInstances( + + /** + * @see {@link DeleteStackInstancesCommand} + */ + deleteStackInstances( args: DeleteStackInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteStackInstances( + deleteStackInstances( args: DeleteStackInstancesCommandInput, cb: (err: any, data?: DeleteStackInstancesCommandOutput) => void ): void; - public deleteStackInstances( + deleteStackInstances( args: DeleteStackInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStackInstancesCommandOutput) => void ): void; - public deleteStackInstances( - args: DeleteStackInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStackInstancesCommandOutput) => void), - cb?: (err: any, data?: DeleteStackInstancesCommandOutput) => void - ): Promise | void { - const command = new DeleteStackInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a stack set. Before you can delete a stack set, all its member stack instances - * must be deleted. For more information about how to complete this, see DeleteStackInstances.

- */ - public deleteStackSet( + + /** + * @see {@link DeleteStackSetCommand} + */ + deleteStackSet( args: DeleteStackSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteStackSet( - args: DeleteStackSetCommandInput, - cb: (err: any, data?: DeleteStackSetCommandOutput) => void - ): void; - public deleteStackSet( + deleteStackSet(args: DeleteStackSetCommandInput, cb: (err: any, data?: DeleteStackSetCommandOutput) => void): void; + deleteStackSet( args: DeleteStackSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStackSetCommandOutput) => void ): void; - public deleteStackSet( - args: DeleteStackSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStackSetCommandOutput) => void), - cb?: (err: any, data?: DeleteStackSetCommandOutput) => void - ): Promise | void { - const command = new DeleteStackSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from active use. Deprecated extensions or - * extension versions cannot be used in CloudFormation operations.

- *

To deregister an entire extension, you must individually deregister all active versions - * of that extension. If an extension has only a single active version, deregistering that - * version results in the extension itself being deregistered and marked as deprecated in the - * registry.

- *

You can't deregister the default version of an extension if there are other active - * version of that extension. If you do deregister the default version of an extension, the - * extension type itself is deregistered as well and marked as deprecated.

- *

To view the deprecation status of an extension or extension version, use DescribeType.

- */ - public deregisterType( + + /** + * @see {@link DeregisterTypeCommand} + */ + deregisterType( args: DeregisterTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterType( - args: DeregisterTypeCommandInput, - cb: (err: any, data?: DeregisterTypeCommandOutput) => void - ): void; - public deregisterType( + deregisterType(args: DeregisterTypeCommandInput, cb: (err: any, data?: DeregisterTypeCommandOutput) => void): void; + deregisterType( args: DeregisterTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterTypeCommandOutput) => void ): void; - public deregisterType( - args: DeregisterTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterTypeCommandOutput) => void), - cb?: (err: any, data?: DeregisterTypeCommandOutput) => void - ): Promise | void { - const command = new DeregisterTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves your account's CloudFormation limits, such as the maximum number of stacks - * that you can create in your account. For more information about account limits, see CloudFormation Quotas in the - * CloudFormation User Guide.

- */ - public describeAccountLimits( + + /** + * @see {@link DescribeAccountLimitsCommand} + */ + describeAccountLimits( args: DescribeAccountLimitsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccountLimits( + describeAccountLimits( args: DescribeAccountLimitsCommandInput, cb: (err: any, data?: DescribeAccountLimitsCommandOutput) => void ): void; - public describeAccountLimits( + describeAccountLimits( args: DescribeAccountLimitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountLimitsCommandOutput) => void ): void; - public describeAccountLimits( - args: DescribeAccountLimitsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccountLimitsCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountLimitsCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountLimitsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the inputs for the change set and a list of changes that CloudFormation will - * make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the CloudFormation User Guide.

- */ - public describeChangeSet( + + /** + * @see {@link DescribeChangeSetCommand} + */ + describeChangeSet( args: DescribeChangeSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeChangeSet( + describeChangeSet( args: DescribeChangeSetCommandInput, cb: (err: any, data?: DescribeChangeSetCommandOutput) => void ): void; - public describeChangeSet( + describeChangeSet( args: DescribeChangeSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChangeSetCommandOutput) => void ): void; - public describeChangeSet( - args: DescribeChangeSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeChangeSetCommandOutput) => void), - cb?: (err: any, data?: DescribeChangeSetCommandOutput) => void - ): Promise | void { - const command = new DescribeChangeSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.

- */ - public describeChangeSetHooks( + + /** + * @see {@link DescribeChangeSetHooksCommand} + */ + describeChangeSetHooks( args: DescribeChangeSetHooksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeChangeSetHooks( + describeChangeSetHooks( args: DescribeChangeSetHooksCommandInput, cb: (err: any, data?: DescribeChangeSetHooksCommandOutput) => void ): void; - public describeChangeSetHooks( + describeChangeSetHooks( args: DescribeChangeSetHooksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChangeSetHooksCommandOutput) => void ): void; - public describeChangeSetHooks( - args: DescribeChangeSetHooksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeChangeSetHooksCommandOutput) => void), - cb?: (err: any, data?: DescribeChangeSetHooksCommandOutput) => void - ): Promise | void { - const command = new DescribeChangeSetHooksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a CloudFormation extension publisher.

- *

If you don't supply a PublisherId, and you have registered as an extension - * publisher, DescribePublisher returns information about your own publisher - * account.

- *

For more information about registering as a publisher, see:

- * - */ - public describePublisher( + + /** + * @see {@link DescribePublisherCommand} + */ + describePublisher( args: DescribePublisherCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePublisher( + describePublisher( args: DescribePublisherCommandInput, cb: (err: any, data?: DescribePublisherCommandOutput) => void ): void; - public describePublisher( + describePublisher( args: DescribePublisherCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePublisherCommandOutput) => void ): void; - public describePublisher( - args: DescribePublisherCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePublisherCommandOutput) => void), - cb?: (err: any, data?: DescribePublisherCommandOutput) => void - ): Promise | void { - const command = new DescribePublisherCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a stack drift detection operation. A stack drift detection - * operation detects whether a stack's actual configuration differs, or has - * drifted, from it's expected configuration, as defined in the stack - * template and any values specified as template parameters. A stack is considered to have - * drifted if one or more of its resources have drifted. For more information about stack and - * resource drift, see Detecting - * Unregulated Configuration Changes to Stacks and Resources.

- *

Use DetectStackDrift to initiate a stack drift detection operation. - * DetectStackDrift returns a StackDriftDetectionId you can use - * to monitor the progress of the operation using - * DescribeStackDriftDetectionStatus. Once the drift detection operation has - * completed, use DescribeStackResourceDrifts to return drift information - * about the stack and its resources.

- */ - public describeStackDriftDetectionStatus( + + /** + * @see {@link DescribeStackDriftDetectionStatusCommand} + */ + describeStackDriftDetectionStatus( args: DescribeStackDriftDetectionStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStackDriftDetectionStatus( + describeStackDriftDetectionStatus( args: DescribeStackDriftDetectionStatusCommandInput, cb: (err: any, data?: DescribeStackDriftDetectionStatusCommandOutput) => void ): void; - public describeStackDriftDetectionStatus( + describeStackDriftDetectionStatus( args: DescribeStackDriftDetectionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStackDriftDetectionStatusCommandOutput) => void ): void; - public describeStackDriftDetectionStatus( - args: DescribeStackDriftDetectionStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStackDriftDetectionStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeStackDriftDetectionStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeStackDriftDetectionStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns all stack related events for a specified stack in reverse chronological order. - * For more information about a stack's event history, go to Stacks in the - * CloudFormation User Guide.

- * - *

You can list events for stacks that have failed to create or have been deleted by - * specifying the unique stack identifier (stack ID).

- *
- */ - public describeStackEvents( + + /** + * @see {@link DescribeStackEventsCommand} + */ + describeStackEvents( args: DescribeStackEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStackEvents( + describeStackEvents( args: DescribeStackEventsCommandInput, cb: (err: any, data?: DescribeStackEventsCommandOutput) => void ): void; - public describeStackEvents( + describeStackEvents( args: DescribeStackEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStackEventsCommandOutput) => void ): void; - public describeStackEvents( - args: DescribeStackEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStackEventsCommandOutput) => void), - cb?: (err: any, data?: DescribeStackEventsCommandOutput) => void - ): Promise | void { - const command = new DescribeStackEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the stack instance that's associated with the specified stack set, Amazon Web Services account, and Region.

- *

For a list of stack instances that are associated with a specific stack set, use ListStackInstances.

- */ - public describeStackInstance( + + /** + * @see {@link DescribeStackInstanceCommand} + */ + describeStackInstance( args: DescribeStackInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStackInstance( + describeStackInstance( args: DescribeStackInstanceCommandInput, cb: (err: any, data?: DescribeStackInstanceCommandOutput) => void ): void; - public describeStackInstance( + describeStackInstance( args: DescribeStackInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStackInstanceCommandOutput) => void ): void; - public describeStackInstance( - args: DescribeStackInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStackInstanceCommandOutput) => void), - cb?: (err: any, data?: DescribeStackInstanceCommandOutput) => void - ): Promise | void { - const command = new DescribeStackInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a description of the specified resource in the specified stack.

- *

For deleted stacks, DescribeStackResource returns resource information for up to 90 days - * after the stack has been deleted.

- */ - public describeStackResource( + + /** + * @see {@link DescribeStackResourceCommand} + */ + describeStackResource( args: DescribeStackResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStackResource( + describeStackResource( args: DescribeStackResourceCommandInput, cb: (err: any, data?: DescribeStackResourceCommandOutput) => void ): void; - public describeStackResource( + describeStackResource( args: DescribeStackResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStackResourceCommandOutput) => void ): void; - public describeStackResource( - args: DescribeStackResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStackResourceCommandOutput) => void), - cb?: (err: any, data?: DescribeStackResourceCommandOutput) => void - ): Promise | void { - const command = new DescribeStackResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns drift information for the resources that have been checked for drift in the - * specified stack. This includes actual and expected configuration values for resources where - * CloudFormation detects configuration drift.

- *

For a given stack, there will be one StackResourceDrift for each stack - * resource that has been checked for drift. Resources that haven't yet been checked for drift - * aren't included. Resources that don't currently support drift detection aren't checked, and - * so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection.

- *

Use DetectStackResourceDrift to detect drift on individual resources, - * or DetectStackDrift to detect drift on all supported resources for a - * given stack.

- */ - public describeStackResourceDrifts( + + /** + * @see {@link DescribeStackResourceDriftsCommand} + */ + describeStackResourceDrifts( args: DescribeStackResourceDriftsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStackResourceDrifts( + describeStackResourceDrifts( args: DescribeStackResourceDriftsCommandInput, cb: (err: any, data?: DescribeStackResourceDriftsCommandOutput) => void ): void; - public describeStackResourceDrifts( + describeStackResourceDrifts( args: DescribeStackResourceDriftsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStackResourceDriftsCommandOutput) => void ): void; - public describeStackResourceDrifts( - args: DescribeStackResourceDriftsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStackResourceDriftsCommandOutput) => void), - cb?: (err: any, data?: DescribeStackResourceDriftsCommandOutput) => void - ): Promise | void { - const command = new DescribeStackResourceDriftsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns Amazon Web Services resource descriptions for running and deleted stacks. If - * StackName is specified, all the associated resources that are part of the - * stack are returned. If PhysicalResourceId is specified, the associated - * resources of the stack that the resource belongs to are returned.

- * - *

Only the first 100 resources will be returned. If your stack has more resources than - * this, you should use ListStackResources instead.

- *
- *

For deleted stacks, DescribeStackResources returns resource information for - * up to 90 days after the stack has been deleted.

- *

You must specify either StackName or PhysicalResourceId, but - * not both. In addition, you can specify LogicalResourceId to filter the - * returned result. For more information about resources, the LogicalResourceId - * and PhysicalResourceId, go to the CloudFormation User - * Guide.

- * - *

A ValidationError is returned if you specify both StackName - * and PhysicalResourceId in the same request.

- *
- */ - public describeStackResources( + + /** + * @see {@link DescribeStackResourcesCommand} + */ + describeStackResources( args: DescribeStackResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStackResources( + describeStackResources( args: DescribeStackResourcesCommandInput, cb: (err: any, data?: DescribeStackResourcesCommandOutput) => void ): void; - public describeStackResources( + describeStackResources( args: DescribeStackResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStackResourcesCommandOutput) => void ): void; - public describeStackResources( - args: DescribeStackResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStackResourcesCommandOutput) => void), - cb?: (err: any, data?: DescribeStackResourcesCommandOutput) => void - ): Promise | void { - const command = new DescribeStackResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the description for the specified stack; if no stack name was specified, then it - * returns the description for all the stacks created.

- * - *

If the stack doesn't exist, an ValidationError is returned.

- *
- */ - public describeStacks( + + /** + * @see {@link DescribeStacksCommand} + */ + describeStacks( args: DescribeStacksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStacks( - args: DescribeStacksCommandInput, - cb: (err: any, data?: DescribeStacksCommandOutput) => void - ): void; - public describeStacks( + describeStacks(args: DescribeStacksCommandInput, cb: (err: any, data?: DescribeStacksCommandOutput) => void): void; + describeStacks( args: DescribeStacksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStacksCommandOutput) => void ): void; - public describeStacks( - args: DescribeStacksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStacksCommandOutput) => void), - cb?: (err: any, data?: DescribeStacksCommandOutput) => void - ): Promise | void { - const command = new DescribeStacksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the description of the specified stack set.

- */ - public describeStackSet( + + /** + * @see {@link DescribeStackSetCommand} + */ + describeStackSet( args: DescribeStackSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStackSet( + describeStackSet( args: DescribeStackSetCommandInput, cb: (err: any, data?: DescribeStackSetCommandOutput) => void ): void; - public describeStackSet( + describeStackSet( args: DescribeStackSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStackSetCommandOutput) => void ): void; - public describeStackSet( - args: DescribeStackSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStackSetCommandOutput) => void), - cb?: (err: any, data?: DescribeStackSetCommandOutput) => void - ): Promise | void { - const command = new DescribeStackSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the description of the specified stack set operation.

- */ - public describeStackSetOperation( + + /** + * @see {@link DescribeStackSetOperationCommand} + */ + describeStackSetOperation( args: DescribeStackSetOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStackSetOperation( + describeStackSetOperation( args: DescribeStackSetOperationCommandInput, cb: (err: any, data?: DescribeStackSetOperationCommandOutput) => void ): void; - public describeStackSetOperation( + describeStackSetOperation( args: DescribeStackSetOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStackSetOperationCommandOutput) => void ): void; - public describeStackSetOperation( - args: DescribeStackSetOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStackSetOperationCommandOutput) => void), - cb?: (err: any, data?: DescribeStackSetOperationCommandOutput) => void - ): Promise | void { - const command = new DescribeStackSetOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns detailed information about an extension that has been registered.

- *

If you specify a VersionId, DescribeType returns information - * about that specific extension version. Otherwise, it returns information about the default - * extension version.

- */ - public describeType( - args: DescribeTypeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeType(args: DescribeTypeCommandInput, cb: (err: any, data?: DescribeTypeCommandOutput) => void): void; - public describeType( + + /** + * @see {@link DescribeTypeCommand} + */ + describeType(args: DescribeTypeCommandInput, options?: __HttpHandlerOptions): Promise; + describeType(args: DescribeTypeCommandInput, cb: (err: any, data?: DescribeTypeCommandOutput) => void): void; + describeType( args: DescribeTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTypeCommandOutput) => void ): void; - public describeType( - args: DescribeTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTypeCommandOutput) => void), - cb?: (err: any, data?: DescribeTypeCommandOutput) => void - ): Promise | void { - const command = new DescribeTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about an extension's registration, including its current status and - * type and version identifiers.

- *

When you initiate a registration request using - * RegisterType - * , you can then use - * DescribeTypeRegistration - * to - * monitor the progress of that registration request.

- *

Once the registration request has completed, use - * DescribeType - * to return detailed information about an extension.

- */ - public describeTypeRegistration( + + /** + * @see {@link DescribeTypeRegistrationCommand} + */ + describeTypeRegistration( args: DescribeTypeRegistrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTypeRegistration( + describeTypeRegistration( args: DescribeTypeRegistrationCommandInput, cb: (err: any, data?: DescribeTypeRegistrationCommandOutput) => void ): void; - public describeTypeRegistration( + describeTypeRegistration( args: DescribeTypeRegistrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTypeRegistrationCommandOutput) => void ): void; - public describeTypeRegistration( - args: DescribeTypeRegistrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTypeRegistrationCommandOutput) => void), - cb?: (err: any, data?: DescribeTypeRegistrationCommandOutput) => void - ): Promise | void { - const command = new DescribeTypeRegistrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detects whether a stack's actual configuration differs, or has - * drifted, from it's expected configuration, as defined in the stack - * template and any values specified as template parameters. For each resource in the stack - * that supports drift detection, CloudFormation compares the actual configuration of the resource with - * its expected template configuration. Only resource properties explicitly defined in the - * stack template are checked for drift. A stack is considered to have drifted if one or more - * of its resources differ from their expected template configurations. For more information, - * see Detecting - * Unregulated Configuration Changes to Stacks and Resources.

- *

Use DetectStackDrift to detect drift on all supported resources for a given - * stack, or DetectStackResourceDrift to detect drift on individual - * resources.

- *

For a list of stack resources that currently support drift detection, see Resources that Support Drift Detection.

- *

- * DetectStackDrift can take up to several minutes, depending on the number of - * resources contained within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack drift operation. Once the drift detection - * operation has completed, use DescribeStackResourceDrifts to return drift - * information about the stack and its resources.

- *

When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks - * belonging to that stack. Perform DetectStackDrift directly on the nested stack - * itself.

- */ - public detectStackDrift( + + /** + * @see {@link DetectStackDriftCommand} + */ + detectStackDrift( args: DetectStackDriftCommandInput, options?: __HttpHandlerOptions ): Promise; - public detectStackDrift( + detectStackDrift( args: DetectStackDriftCommandInput, cb: (err: any, data?: DetectStackDriftCommandOutput) => void ): void; - public detectStackDrift( + detectStackDrift( args: DetectStackDriftCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectStackDriftCommandOutput) => void ): void; - public detectStackDrift( - args: DetectStackDriftCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectStackDriftCommandOutput) => void), - cb?: (err: any, data?: DetectStackDriftCommandOutput) => void - ): Promise | void { - const command = new DetectStackDriftCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about whether a resource's actual configuration differs, or has - * drifted, from it's expected configuration, as defined in the stack - * template and any values specified as template parameters. This information includes actual - * and expected property values for resources in which CloudFormation detects drift. Only resource - * properties explicitly defined in the stack template are checked for drift. For more - * information about stack and resource drift, see Detecting - * Unregulated Configuration Changes to Stacks and Resources.

- *

Use DetectStackResourceDrift to detect drift on individual resources, or - * DetectStackDrift to detect drift on all resources in a given stack - * that support drift detection.

- *

Resources that don't currently support drift detection can't be checked. For a list of - * resources that support drift detection, see Resources that Support Drift Detection.

- */ - public detectStackResourceDrift( + + /** + * @see {@link DetectStackResourceDriftCommand} + */ + detectStackResourceDrift( args: DetectStackResourceDriftCommandInput, options?: __HttpHandlerOptions ): Promise; - public detectStackResourceDrift( + detectStackResourceDrift( args: DetectStackResourceDriftCommandInput, cb: (err: any, data?: DetectStackResourceDriftCommandOutput) => void ): void; - public detectStackResourceDrift( + detectStackResourceDrift( args: DetectStackResourceDriftCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectStackResourceDriftCommandOutput) => void ): void; - public detectStackResourceDrift( - args: DetectStackResourceDriftCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectStackResourceDriftCommandOutput) => void), - cb?: (err: any, data?: DetectStackResourceDriftCommandOutput) => void - ): Promise | void { - const command = new DetectStackResourceDriftCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detect drift on a stack set. When CloudFormation performs drift detection on a - * stack set, it performs drift detection on the stack associated with each stack instance in - * the stack set. For more information, see How CloudFormation performs drift detection on a stack set.

- *

- * DetectStackSetDrift returns the OperationId of the stack set - * drift detection operation. Use this operation id with - * DescribeStackSetOperation - * to monitor the progress of the drift - * detection operation. The drift detection operation may take some time, depending on the - * number of stack instances included in the stack set, in addition to the number of resources - * included in each stack.

- *

Once the operation has completed, use the following actions to return drift - * information:

- *
    - *
  • - *

    Use - * DescribeStackSet - * to return detailed information - * about the stack set, including detailed information about the last - * completed drift operation performed on the stack set. - * (Information about drift operations that are in progress isn't included.)

    - *
  • - *
  • - *

    Use - * ListStackInstances - * to return a list of stack - * instances belonging to the stack set, including the drift status and last drift time - * checked of each instance.

    - *
  • - *
  • - *

    Use - * DescribeStackInstance - * to return detailed - * information about a specific stack instance, including its drift status and last - * drift time checked.

    - *
  • - *
- *

For more information about performing a drift detection operation on a stack set, see - * Detecting unmanaged - * changes in stack sets.

- *

You can only run a single drift detection operation on a given stack set at one - * time.

- *

To stop a drift detection stack set operation, use - * StopStackSetOperation - * .

- */ - public detectStackSetDrift( + + /** + * @see {@link DetectStackSetDriftCommand} + */ + detectStackSetDrift( args: DetectStackSetDriftCommandInput, options?: __HttpHandlerOptions ): Promise; - public detectStackSetDrift( + detectStackSetDrift( args: DetectStackSetDriftCommandInput, cb: (err: any, data?: DetectStackSetDriftCommandOutput) => void ): void; - public detectStackSetDrift( + detectStackSetDrift( args: DetectStackSetDriftCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectStackSetDriftCommandOutput) => void ): void; - public detectStackSetDrift( - args: DetectStackSetDriftCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectStackSetDriftCommandOutput) => void), - cb?: (err: any, data?: DetectStackSetDriftCommandOutput) => void - ): Promise | void { - const command = new DetectStackSetDriftCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes the - * resources required to run the template.

- */ - public estimateTemplateCost( + + /** + * @see {@link EstimateTemplateCostCommand} + */ + estimateTemplateCost( args: EstimateTemplateCostCommandInput, options?: __HttpHandlerOptions ): Promise; - public estimateTemplateCost( + estimateTemplateCost( args: EstimateTemplateCostCommandInput, cb: (err: any, data?: EstimateTemplateCostCommandOutput) => void ): void; - public estimateTemplateCost( + estimateTemplateCost( args: EstimateTemplateCostCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EstimateTemplateCostCommandOutput) => void ): void; - public estimateTemplateCost( - args: EstimateTemplateCostCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EstimateTemplateCostCommandOutput) => void), - cb?: (err: any, data?: EstimateTemplateCostCommandOutput) => void - ): Promise | void { - const command = new EstimateTemplateCostCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a stack using the input information that was provided when the specified change - * set was created. After the call successfully completes, CloudFormation starts updating - * the stack. Use the DescribeStacks action to view the status of the - * update.

- *

When you execute a change set, CloudFormation deletes all other change sets - * associated with the stack because they aren't valid for the updated stack.

- *

If a stack policy is associated with the stack, CloudFormation enforces the policy - * during the update. You can't specify a temporary stack policy that overrides the current - * policy.

- *

To create a change set for the entire stack hierarchy, IncludeNestedStacks - * must have been set to True.

- */ - public executeChangeSet( + + /** + * @see {@link ExecuteChangeSetCommand} + */ + executeChangeSet( args: ExecuteChangeSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public executeChangeSet( + executeChangeSet( args: ExecuteChangeSetCommandInput, cb: (err: any, data?: ExecuteChangeSetCommandOutput) => void ): void; - public executeChangeSet( + executeChangeSet( args: ExecuteChangeSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteChangeSetCommandOutput) => void ): void; - public executeChangeSet( - args: ExecuteChangeSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExecuteChangeSetCommandOutput) => void), - cb?: (err: any, data?: ExecuteChangeSetCommandOutput) => void - ): Promise | void { - const command = new ExecuteChangeSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null - * value is returned.

- */ - public getStackPolicy( + + /** + * @see {@link GetStackPolicyCommand} + */ + getStackPolicy( args: GetStackPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getStackPolicy( - args: GetStackPolicyCommandInput, - cb: (err: any, data?: GetStackPolicyCommandOutput) => void - ): void; - public getStackPolicy( + getStackPolicy(args: GetStackPolicyCommandInput, cb: (err: any, data?: GetStackPolicyCommandOutput) => void): void; + getStackPolicy( args: GetStackPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStackPolicyCommandOutput) => void ): void; - public getStackPolicy( - args: GetStackPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStackPolicyCommandOutput) => void), - cb?: (err: any, data?: GetStackPolicyCommandOutput) => void - ): Promise | void { - const command = new GetStackPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the template body for a specified stack. You can get the template for running or - * deleted stacks.

- *

For deleted stacks, GetTemplate returns the template for up to 90 days - * after the stack has been deleted.

- * - *

If the template doesn't exist, a ValidationError is returned.

- *
- */ - public getTemplate(args: GetTemplateCommandInput, options?: __HttpHandlerOptions): Promise; - public getTemplate(args: GetTemplateCommandInput, cb: (err: any, data?: GetTemplateCommandOutput) => void): void; - public getTemplate( + + /** + * @see {@link GetTemplateCommand} + */ + getTemplate(args: GetTemplateCommandInput, options?: __HttpHandlerOptions): Promise; + getTemplate(args: GetTemplateCommandInput, cb: (err: any, data?: GetTemplateCommandOutput) => void): void; + getTemplate( args: GetTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTemplateCommandOutput) => void ): void; - public getTemplate( - args: GetTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTemplateCommandOutput) => void), - cb?: (err: any, data?: GetTemplateCommandOutput) => void - ): Promise | void { - const command = new GetTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a new or existing template. The - * GetTemplateSummary action is useful for viewing parameter information, such - * as default parameter values and parameter types, before you create or update a stack or - * stack set.

- *

You can use the GetTemplateSummary action when you submit a template, or - * you can get template information for a stack set, or a running or deleted stack.

- *

For deleted stacks, GetTemplateSummary returns the template information for - * up to 90 days after the stack has been deleted. If the template doesn't exist, a - * ValidationError is returned.

- */ - public getTemplateSummary( + + /** + * @see {@link GetTemplateSummaryCommand} + */ + getTemplateSummary( args: GetTemplateSummaryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTemplateSummary( + getTemplateSummary( args: GetTemplateSummaryCommandInput, cb: (err: any, data?: GetTemplateSummaryCommandOutput) => void ): void; - public getTemplateSummary( + getTemplateSummary( args: GetTemplateSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTemplateSummaryCommandOutput) => void ): void; - public getTemplateSummary( - args: GetTemplateSummaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTemplateSummaryCommandOutput) => void), - cb?: (err: any, data?: GetTemplateSummaryCommandOutput) => void - ): Promise | void { - const command = new GetTemplateSummaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Import existing stacks into a new stack sets. Use the stack import operation to import - * up to 10 stacks into a new stack set in the same account as the source stack or in a - * different administrator account and Region, by specifying the stack ID of the stack you - * intend to import.

- * - *

- * ImportStacksToStackSet is only supported by self-managed - * permissions.

- *
- */ - public importStacksToStackSet( + + /** + * @see {@link ImportStacksToStackSetCommand} + */ + importStacksToStackSet( args: ImportStacksToStackSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public importStacksToStackSet( + importStacksToStackSet( args: ImportStacksToStackSetCommandInput, cb: (err: any, data?: ImportStacksToStackSetCommandOutput) => void ): void; - public importStacksToStackSet( + importStacksToStackSet( args: ImportStacksToStackSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportStacksToStackSetCommandOutput) => void ): void; - public importStacksToStackSet( - args: ImportStacksToStackSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportStacksToStackSetCommandOutput) => void), - cb?: (err: any, data?: ImportStacksToStackSetCommandOutput) => void - ): Promise | void { - const command = new ImportStacksToStackSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or - * CREATE_PENDING state.

- */ - public listChangeSets( + + /** + * @see {@link ListChangeSetsCommand} + */ + listChangeSets( args: ListChangeSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listChangeSets( - args: ListChangeSetsCommandInput, - cb: (err: any, data?: ListChangeSetsCommandOutput) => void - ): void; - public listChangeSets( + listChangeSets(args: ListChangeSetsCommandInput, cb: (err: any, data?: ListChangeSetsCommandOutput) => void): void; + listChangeSets( args: ListChangeSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChangeSetsCommandOutput) => void ): void; - public listChangeSets( - args: ListChangeSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListChangeSetsCommandOutput) => void), - cb?: (err: any, data?: ListChangeSetsCommandOutput) => void - ): Promise | void { - const command = new ListChangeSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all exported output values in the account and Region in which you call this - * action. Use this action to see the exported output values that you can import into other - * stacks. To import values, use the - * Fn::ImportValue - * function.

- *

For more information, see - * CloudFormation export stack output values.

- */ - public listExports(args: ListExportsCommandInput, options?: __HttpHandlerOptions): Promise; - public listExports(args: ListExportsCommandInput, cb: (err: any, data?: ListExportsCommandOutput) => void): void; - public listExports( + + /** + * @see {@link ListExportsCommand} + */ + listExports(args: ListExportsCommandInput, options?: __HttpHandlerOptions): Promise; + listExports(args: ListExportsCommandInput, cb: (err: any, data?: ListExportsCommandOutput) => void): void; + listExports( args: ListExportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExportsCommandOutput) => void ): void; - public listExports( - args: ListExportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListExportsCommandOutput) => void), - cb?: (err: any, data?: ListExportsCommandOutput) => void - ): Promise | void { - const command = new ListExportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all stacks that are importing an exported output value. To modify or remove an - * exported output value, first use this action to see which stacks are using it. To see the - * exported output values in your account, see ListExports.

- *

For more information about importing an exported output value, see the - * Fn::ImportValue - * function.

- */ - public listImports(args: ListImportsCommandInput, options?: __HttpHandlerOptions): Promise; - public listImports(args: ListImportsCommandInput, cb: (err: any, data?: ListImportsCommandOutput) => void): void; - public listImports( + + /** + * @see {@link ListImportsCommand} + */ + listImports(args: ListImportsCommandInput, options?: __HttpHandlerOptions): Promise; + listImports(args: ListImportsCommandInput, cb: (err: any, data?: ListImportsCommandOutput) => void): void; + listImports( args: ListImportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImportsCommandOutput) => void ): void; - public listImports( - args: ListImportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListImportsCommandOutput) => void), - cb?: (err: any, data?: ListImportsCommandOutput) => void - ): Promise | void { - const command = new ListImportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns summary information about stack instances that are associated with the specified - * stack set. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that have a specific status.

- */ - public listStackInstances( + + /** + * @see {@link ListStackInstancesCommand} + */ + listStackInstances( args: ListStackInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStackInstances( + listStackInstances( args: ListStackInstancesCommandInput, cb: (err: any, data?: ListStackInstancesCommandOutput) => void ): void; - public listStackInstances( + listStackInstances( args: ListStackInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStackInstancesCommandOutput) => void ): void; - public listStackInstances( - args: ListStackInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStackInstancesCommandOutput) => void), - cb?: (err: any, data?: ListStackInstancesCommandOutput) => void - ): Promise | void { - const command = new ListStackInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns descriptions of all resources of the specified stack.

- *

For deleted stacks, ListStackResources returns resource information for up to 90 days - * after the stack has been deleted.

- */ - public listStackResources( + + /** + * @see {@link ListStackResourcesCommand} + */ + listStackResources( args: ListStackResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStackResources( + listStackResources( args: ListStackResourcesCommandInput, cb: (err: any, data?: ListStackResourcesCommandOutput) => void ): void; - public listStackResources( + listStackResources( args: ListStackResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStackResourcesCommandOutput) => void ): void; - public listStackResources( - args: ListStackResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStackResourcesCommandOutput) => void), - cb?: (err: any, data?: ListStackResourcesCommandOutput) => void - ): Promise | void { - const command = new ListStackResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the summary information for stacks whose status matches the specified - * StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 - * days after the stack is deleted. If no StackStatusFilter is specified, summary information - * for all stacks is returned (including existing stacks and stacks that have been - * deleted).

- */ - public listStacks(args: ListStacksCommandInput, options?: __HttpHandlerOptions): Promise; - public listStacks(args: ListStacksCommandInput, cb: (err: any, data?: ListStacksCommandOutput) => void): void; - public listStacks( + + /** + * @see {@link ListStacksCommand} + */ + listStacks(args: ListStacksCommandInput, options?: __HttpHandlerOptions): Promise; + listStacks(args: ListStacksCommandInput, cb: (err: any, data?: ListStacksCommandOutput) => void): void; + listStacks( args: ListStacksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStacksCommandOutput) => void ): void; - public listStacks( - args: ListStacksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStacksCommandOutput) => void), - cb?: (err: any, data?: ListStacksCommandOutput) => void - ): Promise | void { - const command = new ListStacksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns summary information about the results of a stack set operation.

- */ - public listStackSetOperationResults( + + /** + * @see {@link ListStackSetOperationResultsCommand} + */ + listStackSetOperationResults( args: ListStackSetOperationResultsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStackSetOperationResults( + listStackSetOperationResults( args: ListStackSetOperationResultsCommandInput, cb: (err: any, data?: ListStackSetOperationResultsCommandOutput) => void ): void; - public listStackSetOperationResults( + listStackSetOperationResults( args: ListStackSetOperationResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStackSetOperationResultsCommandOutput) => void ): void; - public listStackSetOperationResults( - args: ListStackSetOperationResultsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStackSetOperationResultsCommandOutput) => void), - cb?: (err: any, data?: ListStackSetOperationResultsCommandOutput) => void - ): Promise | void { - const command = new ListStackSetOperationResultsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns summary information about operations performed on a stack set.

- */ - public listStackSetOperations( + + /** + * @see {@link ListStackSetOperationsCommand} + */ + listStackSetOperations( args: ListStackSetOperationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStackSetOperations( + listStackSetOperations( args: ListStackSetOperationsCommandInput, cb: (err: any, data?: ListStackSetOperationsCommandOutput) => void ): void; - public listStackSetOperations( + listStackSetOperations( args: ListStackSetOperationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStackSetOperationsCommandOutput) => void ): void; - public listStackSetOperations( - args: ListStackSetOperationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStackSetOperationsCommandOutput) => void), - cb?: (err: any, data?: ListStackSetOperationsCommandOutput) => void - ): Promise | void { - const command = new ListStackSetOperationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns summary information about stack sets that are associated with the user.

- *
    - *
  • - *

    [Self-managed permissions] If you set the CallAs parameter to - * SELF while signed in to your Amazon Web Services account, - * ListStackSets returns all self-managed stack sets in your Amazon Web Services account.

    - *
  • - *
  • - *

    [Service-managed permissions] If you set the CallAs parameter to - * SELF while signed in to the organization's management account, ListStackSets returns all stack sets in the - * management account.

    - *
  • - *
  • - *

    [Service-managed permissions] If you set the CallAs parameter to - * DELEGATED_ADMIN while signed in to your member account, - * ListStackSets returns all stack sets with service-managed permissions - * in the management account.

    - *
  • - *
- */ - public listStackSets( - args: ListStackSetsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listStackSets( - args: ListStackSetsCommandInput, - cb: (err: any, data?: ListStackSetsCommandOutput) => void - ): void; - public listStackSets( + + /** + * @see {@link ListStackSetsCommand} + */ + listStackSets(args: ListStackSetsCommandInput, options?: __HttpHandlerOptions): Promise; + listStackSets(args: ListStackSetsCommandInput, cb: (err: any, data?: ListStackSetsCommandOutput) => void): void; + listStackSets( args: ListStackSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStackSetsCommandOutput) => void ): void; - public listStackSets( - args: ListStackSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStackSetsCommandOutput) => void), - cb?: (err: any, data?: ListStackSetsCommandOutput) => void - ): Promise | void { - const command = new ListStackSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of registration tokens for the specified extension(s).

- */ - public listTypeRegistrations( + + /** + * @see {@link ListTypeRegistrationsCommand} + */ + listTypeRegistrations( args: ListTypeRegistrationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTypeRegistrations( + listTypeRegistrations( args: ListTypeRegistrationsCommandInput, cb: (err: any, data?: ListTypeRegistrationsCommandOutput) => void ): void; - public listTypeRegistrations( + listTypeRegistrations( args: ListTypeRegistrationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTypeRegistrationsCommandOutput) => void ): void; - public listTypeRegistrations( - args: ListTypeRegistrationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTypeRegistrationsCommandOutput) => void), - cb?: (err: any, data?: ListTypeRegistrationsCommandOutput) => void - ): Promise | void { - const command = new ListTypeRegistrationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns summary information about extension that have been registered with CloudFormation.

- */ - public listTypes(args: ListTypesCommandInput, options?: __HttpHandlerOptions): Promise; - public listTypes(args: ListTypesCommandInput, cb: (err: any, data?: ListTypesCommandOutput) => void): void; - public listTypes( + + /** + * @see {@link ListTypesCommand} + */ + listTypes(args: ListTypesCommandInput, options?: __HttpHandlerOptions): Promise; + listTypes(args: ListTypesCommandInput, cb: (err: any, data?: ListTypesCommandOutput) => void): void; + listTypes( args: ListTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTypesCommandOutput) => void ): void; - public listTypes( - args: ListTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTypesCommandOutput) => void), - cb?: (err: any, data?: ListTypesCommandOutput) => void - ): Promise | void { - const command = new ListTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns summary information about the versions of an extension.

- */ - public listTypeVersions( + + /** + * @see {@link ListTypeVersionsCommand} + */ + listTypeVersions( args: ListTypeVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTypeVersions( + listTypeVersions( args: ListTypeVersionsCommandInput, cb: (err: any, data?: ListTypeVersionsCommandOutput) => void ): void; - public listTypeVersions( + listTypeVersions( args: ListTypeVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTypeVersionsCommandOutput) => void ): void; - public listTypeVersions( - args: ListTypeVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTypeVersionsCommandOutput) => void), - cb?: (err: any, data?: ListTypeVersionsCommandOutput) => void - ): Promise | void { - const command = new ListTypeVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Publishes the specified extension to the CloudFormation registry as a public - * extension in this region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use in the - * CloudFormation CLI User Guide.

- *

To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.

- */ - public publishType(args: PublishTypeCommandInput, options?: __HttpHandlerOptions): Promise; - public publishType(args: PublishTypeCommandInput, cb: (err: any, data?: PublishTypeCommandOutput) => void): void; - public publishType( + + /** + * @see {@link PublishTypeCommand} + */ + publishType(args: PublishTypeCommandInput, options?: __HttpHandlerOptions): Promise; + publishType(args: PublishTypeCommandInput, cb: (err: any, data?: PublishTypeCommandOutput) => void): void; + publishType( args: PublishTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishTypeCommandOutput) => void ): void; - public publishType( - args: PublishTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PublishTypeCommandOutput) => void), - cb?: (err: any, data?: PublishTypeCommandOutput) => void - ): Promise | void { - const command = new PublishTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Reports progress of a resource handler to CloudFormation.

- *

Reserved for use by the CloudFormation CLI. Don't use this API in your code.

- */ - public recordHandlerProgress( + + /** + * @see {@link RecordHandlerProgressCommand} + */ + recordHandlerProgress( args: RecordHandlerProgressCommandInput, options?: __HttpHandlerOptions ): Promise; - public recordHandlerProgress( + recordHandlerProgress( args: RecordHandlerProgressCommandInput, cb: (err: any, data?: RecordHandlerProgressCommandOutput) => void ): void; - public recordHandlerProgress( + recordHandlerProgress( args: RecordHandlerProgressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RecordHandlerProgressCommandOutput) => void ): void; - public recordHandlerProgress( - args: RecordHandlerProgressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RecordHandlerProgressCommandOutput) => void), - cb?: (err: any, data?: RecordHandlerProgressCommandOutput) => void - ): Promise | void { - const command = new RecordHandlerProgressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. - * This publisher ID applies to your account in all Amazon Web Services Regions.

- *

For information about requirements for registering as a public extension publisher, see - * Registering your account to publish CloudFormation - * extensions in the CloudFormation CLI User - * Guide.

- *

- */ - public registerPublisher( + + /** + * @see {@link RegisterPublisherCommand} + */ + registerPublisher( args: RegisterPublisherCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerPublisher( + registerPublisher( args: RegisterPublisherCommandInput, cb: (err: any, data?: RegisterPublisherCommandOutput) => void ): void; - public registerPublisher( + registerPublisher( args: RegisterPublisherCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterPublisherCommandOutput) => void ): void; - public registerPublisher( - args: RegisterPublisherCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterPublisherCommandOutput) => void), - cb?: (err: any, data?: RegisterPublisherCommandOutput) => void - ): Promise | void { - const command = new RegisterPublisherCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers an extension with the CloudFormation service. Registering an - * extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:

- *
    - *
  • - *

    Validating the extension schema.

    - *
  • - *
  • - *

    Determining which handlers, if any, have been specified for the extension.

    - *
  • - *
  • - *

    Making the extension available for use in your account.

    - *
  • - *
- *

For more information about how to develop extensions and ready them for registration, - * see Creating Resource - * Providers in the CloudFormation CLI User - * Guide.

- *

You can have a maximum of 50 resource extension versions registered at a time. This - * maximum is per account and per region. Use DeregisterType to deregister specific extension versions if necessary.

- *

Once you have initiated a registration request using - * RegisterType - * , you can use - * DescribeTypeRegistration - * to - * monitor the progress of the registration request.

- *

Once you have registered a private extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For - * more information, see Configuring extensions at the account level in the CloudFormation User Guide.

- */ - public registerType( - args: RegisterTypeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public registerType(args: RegisterTypeCommandInput, cb: (err: any, data?: RegisterTypeCommandOutput) => void): void; - public registerType( + + /** + * @see {@link RegisterTypeCommand} + */ + registerType(args: RegisterTypeCommandInput, options?: __HttpHandlerOptions): Promise; + registerType(args: RegisterTypeCommandInput, cb: (err: any, data?: RegisterTypeCommandOutput) => void): void; + registerType( args: RegisterTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterTypeCommandOutput) => void ): void; - public registerType( - args: RegisterTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterTypeCommandOutput) => void), - cb?: (err: any, data?: RegisterTypeCommandOutput) => void - ): Promise | void { - const command = new RegisterTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

When specifying RollbackStack, you preserve the state of previously - * provisioned resources when an operation fails. You can check the status of the stack - * through the DescribeStacks operation.

- *

Rolls back the specified stack to the last known stable state from - * CREATE_FAILED or UPDATE_FAILED stack statuses.

- *

This operation will delete a stack if it doesn't contain a last known stable state. A - * last known stable state includes any status in a *_COMPLETE. This includes the - * following stack statuses.

- *
    - *
  • - *

    - * CREATE_COMPLETE - *

    - *
  • - *
  • - *

    - * UPDATE_COMPLETE - *

    - *
  • - *
  • - *

    - * UPDATE_ROLLBACK_COMPLETE - *

    - *
  • - *
  • - *

    - * IMPORT_COMPLETE - *

    - *
  • - *
  • - *

    - * IMPORT_ROLLBACK_COMPLETE - *

    - *
  • - *
- */ - public rollbackStack( - args: RollbackStackCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public rollbackStack( - args: RollbackStackCommandInput, - cb: (err: any, data?: RollbackStackCommandOutput) => void - ): void; - public rollbackStack( + + /** + * @see {@link RollbackStackCommand} + */ + rollbackStack(args: RollbackStackCommandInput, options?: __HttpHandlerOptions): Promise; + rollbackStack(args: RollbackStackCommandInput, cb: (err: any, data?: RollbackStackCommandOutput) => void): void; + rollbackStack( args: RollbackStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RollbackStackCommandOutput) => void ): void; - public rollbackStack( - args: RollbackStackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RollbackStackCommandOutput) => void), - cb?: (err: any, data?: RollbackStackCommandOutput) => void - ): Promise | void { - const command = new RollbackStackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets a stack policy for a specified stack.

- */ - public setStackPolicy( + + /** + * @see {@link SetStackPolicyCommand} + */ + setStackPolicy( args: SetStackPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public setStackPolicy( - args: SetStackPolicyCommandInput, - cb: (err: any, data?: SetStackPolicyCommandOutput) => void - ): void; - public setStackPolicy( + setStackPolicy(args: SetStackPolicyCommandInput, cb: (err: any, data?: SetStackPolicyCommandOutput) => void): void; + setStackPolicy( args: SetStackPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetStackPolicyCommandOutput) => void ): void; - public setStackPolicy( - args: SetStackPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetStackPolicyCommandOutput) => void), - cb?: (err: any, data?: SetStackPolicyCommandOutput) => void - ): Promise | void { - const command = new SetStackPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Specifies the configuration data for a registered CloudFormation extension, in - * the given account and region.

- *

To view the current configuration data for an extension, refer to the - * ConfigurationSchema element of DescribeType. - * For more information, see Configuring extensions at the account level in the - * CloudFormation User Guide.

- * - *

It's strongly recommended that you use dynamic references to restrict sensitive - * configuration definitions, such as third-party credentials. For more details on dynamic - * references, see Using dynamic references to specify - * template values in the CloudFormation User - * Guide.

- *
- */ - public setTypeConfiguration( + + /** + * @see {@link SetTypeConfigurationCommand} + */ + setTypeConfiguration( args: SetTypeConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public setTypeConfiguration( + setTypeConfiguration( args: SetTypeConfigurationCommandInput, cb: (err: any, data?: SetTypeConfigurationCommandOutput) => void ): void; - public setTypeConfiguration( + setTypeConfiguration( args: SetTypeConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetTypeConfigurationCommandOutput) => void ): void; - public setTypeConfiguration( - args: SetTypeConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetTypeConfigurationCommandOutput) => void), - cb?: (err: any, data?: SetTypeConfigurationCommandOutput) => void - ): Promise | void { - const command = new SetTypeConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Specify the default version of an extension. The default version of an extension will be - * used in CloudFormation operations.

- */ - public setTypeDefaultVersion( + + /** + * @see {@link SetTypeDefaultVersionCommand} + */ + setTypeDefaultVersion( args: SetTypeDefaultVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public setTypeDefaultVersion( + setTypeDefaultVersion( args: SetTypeDefaultVersionCommandInput, cb: (err: any, data?: SetTypeDefaultVersionCommandOutput) => void ): void; - public setTypeDefaultVersion( + setTypeDefaultVersion( args: SetTypeDefaultVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetTypeDefaultVersionCommandOutput) => void ): void; - public setTypeDefaultVersion( - args: SetTypeDefaultVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetTypeDefaultVersionCommandOutput) => void), - cb?: (err: any, data?: SetTypeDefaultVersionCommandOutput) => void - ): Promise | void { - const command = new SetTypeDefaultVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sends a signal to the specified resource with a success or failure status. You can use - * the SignalResource operation in conjunction with a creation policy or update - * policy. CloudFormation doesn't proceed with a stack creation or update until - * resources receive the required number of signals or the timeout period is exceeded. The - * SignalResource operation is useful in cases where you want to send signals - * from anywhere other than an Amazon EC2 instance.

- */ - public signalResource( + + /** + * @see {@link SignalResourceCommand} + */ + signalResource( args: SignalResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public signalResource( - args: SignalResourceCommandInput, - cb: (err: any, data?: SignalResourceCommandOutput) => void - ): void; - public signalResource( + signalResource(args: SignalResourceCommandInput, cb: (err: any, data?: SignalResourceCommandOutput) => void): void; + signalResource( args: SignalResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SignalResourceCommandOutput) => void ): void; - public signalResource( - args: SignalResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SignalResourceCommandOutput) => void), - cb?: (err: any, data?: SignalResourceCommandOutput) => void - ): Promise | void { - const command = new SignalResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops an in-progress operation on a stack set and its associated stack instances. - * StackSets will cancel all the unstarted stack instance deployments and wait for those are - * in-progress to complete.

- */ - public stopStackSetOperation( + + /** + * @see {@link StopStackSetOperationCommand} + */ + stopStackSetOperation( args: StopStackSetOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopStackSetOperation( + stopStackSetOperation( args: StopStackSetOperationCommandInput, cb: (err: any, data?: StopStackSetOperationCommandOutput) => void ): void; - public stopStackSetOperation( + stopStackSetOperation( args: StopStackSetOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopStackSetOperationCommandOutput) => void ): void; - public stopStackSetOperation( - args: StopStackSetOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopStackSetOperationCommandOutput) => void), - cb?: (err: any, data?: StopStackSetOperationCommandOutput) => void - ): Promise | void { - const command = new StopStackSetOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Tests a registered extension to make sure it meets all necessary requirements for being - * published in the CloudFormation registry.

- *
    - *
  • - *

    For resource types, this includes passing all contracts tests defined for the - * type.

    - *
  • - *
  • - *

    For modules, this includes determining if the module's model meets all necessary - * requirements.

    - *
  • - *
- *

For more information, see Testing your public extension prior to publishing in the CloudFormation CLI User Guide.

- *

If you don't specify a version, CloudFormation uses the default version of the - * extension in your account and region for testing.

- *

To perform testing, CloudFormation assumes the execution role specified when - * the type was registered. For more information, see RegisterType.

- *

Once you've initiated testing on an extension using TestType, you can pass - * the returned TypeVersionArn into DescribeType to monitor the current test status and test status description for - * the extension.

- *

An extension must have a test status of PASSED before it can be published. - * For more information, see Publishing extensions to make them available for public use - * in the CloudFormation CLI User Guide.

- */ - public testType(args: TestTypeCommandInput, options?: __HttpHandlerOptions): Promise; - public testType(args: TestTypeCommandInput, cb: (err: any, data?: TestTypeCommandOutput) => void): void; - public testType( + + /** + * @see {@link TestTypeCommand} + */ + testType(args: TestTypeCommandInput, options?: __HttpHandlerOptions): Promise; + testType(args: TestTypeCommandInput, cb: (err: any, data?: TestTypeCommandOutput) => void): void; + testType( args: TestTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestTypeCommandOutput) => void ): void; - public testType( - args: TestTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestTypeCommandOutput) => void), - cb?: (err: any, data?: TestTypeCommandOutput) => void - ): Promise | void { - const command = new TestTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a stack as specified in the template. After the call completes successfully, the - * stack update starts. You can check the status of the stack through the DescribeStacks action.

- *

To get a copy of the template for an existing stack, you can use the GetTemplate action.

- *

For more information about creating an update template, updating a stack, and monitoring - * the progress of the update, see Updating a - * Stack.

- */ - public updateStack(args: UpdateStackCommandInput, options?: __HttpHandlerOptions): Promise; - public updateStack(args: UpdateStackCommandInput, cb: (err: any, data?: UpdateStackCommandOutput) => void): void; - public updateStack( + + /** + * @see {@link UpdateStackCommand} + */ + updateStack(args: UpdateStackCommandInput, options?: __HttpHandlerOptions): Promise; + updateStack(args: UpdateStackCommandInput, cb: (err: any, data?: UpdateStackCommandOutput) => void): void; + updateStack( args: UpdateStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStackCommandOutput) => void ): void; - public updateStack( - args: UpdateStackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStackCommandOutput) => void), - cb?: (err: any, data?: UpdateStackCommandOutput) => void - ): Promise | void { - const command = new UpdateStackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the parameter values for stack instances for the specified accounts, within the - * specified Amazon Web Services Regions. A stack instance refers to a stack in a specific - * account and Region.

- *

You can only update stack instances in Amazon Web Services Regions and accounts where - * they already exist; to create additional stack instances, use CreateStackInstances.

- *

During stack set updates, any parameters overridden for a stack instance aren't updated, - * but retain their overridden value.

- *

You can only update the parameter values that are specified in the - * stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a - * template, before you can override the parameter value specified in the stack set you must - * first use UpdateStackSet to update all stack instances with the updated template and - * parameter value specified in the stack set. Once a stack instance has been updated with the - * new parameter, you can then override the parameter value using - * UpdateStackInstances.

- */ - public updateStackInstances( + + /** + * @see {@link UpdateStackInstancesCommand} + */ + updateStackInstances( args: UpdateStackInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateStackInstances( + updateStackInstances( args: UpdateStackInstancesCommandInput, cb: (err: any, data?: UpdateStackInstancesCommandOutput) => void ): void; - public updateStackInstances( + updateStackInstances( args: UpdateStackInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStackInstancesCommandOutput) => void ): void; - public updateStackInstances( - args: UpdateStackInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStackInstancesCommandOutput) => void), - cb?: (err: any, data?: UpdateStackInstancesCommandOutput) => void - ): Promise | void { - const command = new UpdateStackInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the stack set, and associated stack instances in the specified accounts and - * Amazon Web Services Regions.

- *

Even if the stack set operation created by updating the stack set fails (completely or - * partially, below or above a specified failure tolerance), the stack set is updated with - * your changes. Subsequent CreateStackInstances calls on the specified - * stack set use the updated stack set.

- */ - public updateStackSet( + + /** + * @see {@link UpdateStackSetCommand} + */ + updateStackSet( args: UpdateStackSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateStackSet( - args: UpdateStackSetCommandInput, - cb: (err: any, data?: UpdateStackSetCommandOutput) => void - ): void; - public updateStackSet( + updateStackSet(args: UpdateStackSetCommandInput, cb: (err: any, data?: UpdateStackSetCommandOutput) => void): void; + updateStackSet( args: UpdateStackSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStackSetCommandOutput) => void ): void; - public updateStackSet( - args: UpdateStackSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStackSetCommandOutput) => void), - cb?: (err: any, data?: UpdateStackSetCommandOutput) => void - ): Promise | void { - const command = new UpdateStackSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates termination protection for the specified stack. If a user attempts to delete a - * stack with termination protection enabled, the operation fails and the stack remains - * unchanged. For more information, see Protecting a - * Stack From Being Deleted in the CloudFormation User Guide.

- *

For nested - * stacks, termination protection is set on the root stack and can't be changed - * directly on the nested stack.

- */ - public updateTerminationProtection( + + /** + * @see {@link UpdateTerminationProtectionCommand} + */ + updateTerminationProtection( args: UpdateTerminationProtectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTerminationProtection( + updateTerminationProtection( args: UpdateTerminationProtectionCommandInput, cb: (err: any, data?: UpdateTerminationProtectionCommandOutput) => void ): void; - public updateTerminationProtection( + updateTerminationProtection( args: UpdateTerminationProtectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTerminationProtectionCommandOutput) => void ): void; - public updateTerminationProtection( - args: UpdateTerminationProtectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTerminationProtectionCommandOutput) => void), - cb?: (err: any, data?: UpdateTerminationProtectionCommandOutput) => void - ): Promise | void { - const command = new UpdateTerminationProtectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Validates a specified template. CloudFormation first checks if the template is - * valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If - * both these checks fail, CloudFormation returns a template validation error.

- */ - public validateTemplate( + + /** + * @see {@link ValidateTemplateCommand} + */ + validateTemplate( args: ValidateTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public validateTemplate( + validateTemplate( args: ValidateTemplateCommandInput, cb: (err: any, data?: ValidateTemplateCommandOutput) => void ): void; - public validateTemplate( + validateTemplate( args: ValidateTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidateTemplateCommandOutput) => void ): void; - public validateTemplate( - args: ValidateTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ValidateTemplateCommandOutput) => void), - cb?: (err: any, data?: ValidateTemplateCommandOutput) => void - ): Promise | void { - const command = new ValidateTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * CloudFormation + *

CloudFormation allows you to create and manage Amazon Web Services infrastructure + * deployments predictably and repeatedly. You can use CloudFormation to leverage + * Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, + * Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly + * reliable, highly scalable, cost-effective applications without creating or configuring the + * underlying Amazon Web Services infrastructure.

+ *

With CloudFormation, you declare all your resources and dependencies in a template + * file. The template defines a collection of resources as a single unit called a stack. + * CloudFormation creates and deletes all member resources of the stack together and + * manages all dependencies between the resources for you.

+ *

For more information about CloudFormation, see the CloudFormation product page.

+ *

CloudFormation makes use of other Amazon Web Services products. If you need + * additional technical information about a specific Amazon Web Services product, you can find + * the product's technical documentation at + * docs.aws.amazon.com + * .

+ */ +export class CloudFormation extends CloudFormationClient implements CloudFormation {} +createAggregatedClient(commands, CloudFormation); diff --git a/clients/client-cloudfront/src/CloudFront.ts b/clients/client-cloudfront/src/CloudFront.ts index d0f61232c5e4..e635875b992e 100644 --- a/clients/client-cloudfront/src/CloudFront.ts +++ b/clients/client-cloudfront/src/CloudFront.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CloudFrontClient } from "./CloudFrontClient"; +import { CloudFrontClient, CloudFrontClientConfig } from "./CloudFrontClient"; import { AssociateAliasCommand, AssociateAliasCommandInput, @@ -521,4063 +522,1833 @@ import { UpdateStreamingDistributionCommandOutput, } from "./commands/UpdateStreamingDistributionCommand"; -/** - * @public - * Amazon CloudFront - *

This is the Amazon CloudFront API Reference. This guide is for developers - * who need detailed information about CloudFront API actions, data types, and errors. For - * detailed information about CloudFront features, see the - * Amazon CloudFront Developer Guide.

- */ -export class CloudFront extends CloudFrontClient { +const commands = { + AssociateAliasCommand, + CopyDistributionCommand, + CreateCachePolicyCommand, + CreateCloudFrontOriginAccessIdentityCommand, + CreateContinuousDeploymentPolicyCommand, + CreateDistributionCommand, + CreateDistributionWithTagsCommand, + CreateFieldLevelEncryptionConfigCommand, + CreateFieldLevelEncryptionProfileCommand, + CreateFunctionCommand, + CreateInvalidationCommand, + CreateKeyGroupCommand, + CreateMonitoringSubscriptionCommand, + CreateOriginAccessControlCommand, + CreateOriginRequestPolicyCommand, + CreatePublicKeyCommand, + CreateRealtimeLogConfigCommand, + CreateResponseHeadersPolicyCommand, + CreateStreamingDistributionCommand, + CreateStreamingDistributionWithTagsCommand, + DeleteCachePolicyCommand, + DeleteCloudFrontOriginAccessIdentityCommand, + DeleteContinuousDeploymentPolicyCommand, + DeleteDistributionCommand, + DeleteFieldLevelEncryptionConfigCommand, + DeleteFieldLevelEncryptionProfileCommand, + DeleteFunctionCommand, + DeleteKeyGroupCommand, + DeleteMonitoringSubscriptionCommand, + DeleteOriginAccessControlCommand, + DeleteOriginRequestPolicyCommand, + DeletePublicKeyCommand, + DeleteRealtimeLogConfigCommand, + DeleteResponseHeadersPolicyCommand, + DeleteStreamingDistributionCommand, + DescribeFunctionCommand, + GetCachePolicyCommand, + GetCachePolicyConfigCommand, + GetCloudFrontOriginAccessIdentityCommand, + GetCloudFrontOriginAccessIdentityConfigCommand, + GetContinuousDeploymentPolicyCommand, + GetContinuousDeploymentPolicyConfigCommand, + GetDistributionCommand, + GetDistributionConfigCommand, + GetFieldLevelEncryptionCommand, + GetFieldLevelEncryptionConfigCommand, + GetFieldLevelEncryptionProfileCommand, + GetFieldLevelEncryptionProfileConfigCommand, + GetFunctionCommand, + GetInvalidationCommand, + GetKeyGroupCommand, + GetKeyGroupConfigCommand, + GetMonitoringSubscriptionCommand, + GetOriginAccessControlCommand, + GetOriginAccessControlConfigCommand, + GetOriginRequestPolicyCommand, + GetOriginRequestPolicyConfigCommand, + GetPublicKeyCommand, + GetPublicKeyConfigCommand, + GetRealtimeLogConfigCommand, + GetResponseHeadersPolicyCommand, + GetResponseHeadersPolicyConfigCommand, + GetStreamingDistributionCommand, + GetStreamingDistributionConfigCommand, + ListCachePoliciesCommand, + ListCloudFrontOriginAccessIdentitiesCommand, + ListConflictingAliasesCommand, + ListContinuousDeploymentPoliciesCommand, + ListDistributionsCommand, + ListDistributionsByCachePolicyIdCommand, + ListDistributionsByKeyGroupCommand, + ListDistributionsByOriginRequestPolicyIdCommand, + ListDistributionsByRealtimeLogConfigCommand, + ListDistributionsByResponseHeadersPolicyIdCommand, + ListDistributionsByWebACLIdCommand, + ListFieldLevelEncryptionConfigsCommand, + ListFieldLevelEncryptionProfilesCommand, + ListFunctionsCommand, + ListInvalidationsCommand, + ListKeyGroupsCommand, + ListOriginAccessControlsCommand, + ListOriginRequestPoliciesCommand, + ListPublicKeysCommand, + ListRealtimeLogConfigsCommand, + ListResponseHeadersPoliciesCommand, + ListStreamingDistributionsCommand, + ListTagsForResourceCommand, + PublishFunctionCommand, + TagResourceCommand, + TestFunctionCommand, + UntagResourceCommand, + UpdateCachePolicyCommand, + UpdateCloudFrontOriginAccessIdentityCommand, + UpdateContinuousDeploymentPolicyCommand, + UpdateDistributionCommand, + UpdateDistributionWithStagingConfigCommand, + UpdateFieldLevelEncryptionConfigCommand, + UpdateFieldLevelEncryptionProfileCommand, + UpdateFunctionCommand, + UpdateKeyGroupCommand, + UpdateOriginAccessControlCommand, + UpdateOriginRequestPolicyCommand, + UpdatePublicKeyCommand, + UpdateRealtimeLogConfigCommand, + UpdateResponseHeadersPolicyCommand, + UpdateStreamingDistributionCommand, +}; + +export interface CloudFront { /** - * @public - *

Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront - * distribution.

- *

With this operation you can move an alias that's already in use on a CloudFront distribution - * to a different distribution in one step. This prevents the downtime that could occur if - * you first remove the alias from one distribution and then separately add the alias to - * another distribution.

- *

To use this operation to associate an alias with a distribution, you provide the alias - * and the ID of the target distribution for the alias. For more information, including how - * to set up the target distribution, prerequisites that you must complete, and other - * restrictions, see Moving an alternate domain name to a different - * distribution in the Amazon CloudFront Developer Guide.

+ * @see {@link AssociateAliasCommand} */ - public associateAlias( + associateAlias( args: AssociateAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateAlias( - args: AssociateAliasCommandInput, - cb: (err: any, data?: AssociateAliasCommandOutput) => void - ): void; - public associateAlias( + associateAlias(args: AssociateAliasCommandInput, cb: (err: any, data?: AssociateAliasCommandOutput) => void): void; + associateAlias( args: AssociateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateAliasCommandOutput) => void ): void; - public associateAlias( - args: AssociateAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateAliasCommandOutput) => void), - cb?: (err: any, data?: AssociateAliasCommandOutput) => void - ): Promise | void { - const command = new AssociateAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a staging distribution using the configuration of the provided primary - * distribution. A staging distribution is a copy of an existing distribution (called the - * primary distribution) that you can use in a continuous deployment workflow.

- *

After you create a staging distribution, you can use UpdateDistribution - * to modify the staging distribution's configuration. Then you can use - * CreateContinuousDeploymentPolicy to incrementally move traffic to the - * staging distribution.

+ * @see {@link CopyDistributionCommand} */ - public copyDistribution( + copyDistribution( args: CopyDistributionCommandInput, options?: __HttpHandlerOptions ): Promise; - public copyDistribution( + copyDistribution( args: CopyDistributionCommandInput, cb: (err: any, data?: CopyDistributionCommandOutput) => void ): void; - public copyDistribution( + copyDistribution( args: CopyDistributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyDistributionCommandOutput) => void ): void; - public copyDistribution( - args: CopyDistributionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopyDistributionCommandOutput) => void), - cb?: (err: any, data?: CopyDistributionCommandOutput) => void - ): Promise | void { - const command = new CopyDistributionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a cache policy.

- *

After you create a cache policy, you can attach it to one or more cache behaviors. - * When it's attached to a cache behavior, the cache policy determines the - * following:

- *
    - *
  • - *

    The values that CloudFront includes in the cache key. These - * values can include HTTP headers, cookies, and URL query strings. CloudFront uses the - * cache key to find an object in its cache that it can return to the - * viewer.

    - *
  • - *
  • - *

    The default, minimum, and maximum time to live (TTL) values that you want - * objects to stay in the CloudFront cache.

    - *
  • - *
- *

The headers, cookies, and query strings that are included in the cache key are also included - * in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find an - * object in its cache that matches the request's cache key. If you want to send values to - * the origin but not include them in the cache key, use - * OriginRequestPolicy.

- *

For more information about cache policies, see Controlling the cache key in the - * Amazon CloudFront Developer Guide.

+ * @see {@link CreateCachePolicyCommand} */ - public createCachePolicy( + createCachePolicy( args: CreateCachePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCachePolicy( + createCachePolicy( args: CreateCachePolicyCommandInput, cb: (err: any, data?: CreateCachePolicyCommandOutput) => void ): void; - public createCachePolicy( + createCachePolicy( args: CreateCachePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCachePolicyCommandOutput) => void ): void; - public createCachePolicy( - args: CreateCachePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCachePolicyCommandOutput) => void), - cb?: (err: any, data?: CreateCachePolicyCommandOutput) => void - ): Promise | void { - const command = new CreateCachePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new origin access identity. If you're using Amazon S3 for your origin, you can - * use an origin access identity to require users to access your content using a CloudFront URL - * instead of the Amazon S3 URL. For more information about how to use origin access identities, - * see Serving Private - * Content through CloudFront in the Amazon CloudFront Developer Guide.

+ * @see {@link CreateCloudFrontOriginAccessIdentityCommand} */ - public createCloudFrontOriginAccessIdentity( + createCloudFrontOriginAccessIdentity( args: CreateCloudFrontOriginAccessIdentityCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCloudFrontOriginAccessIdentity( + createCloudFrontOriginAccessIdentity( args: CreateCloudFrontOriginAccessIdentityCommandInput, cb: (err: any, data?: CreateCloudFrontOriginAccessIdentityCommandOutput) => void ): void; - public createCloudFrontOriginAccessIdentity( + createCloudFrontOriginAccessIdentity( args: CreateCloudFrontOriginAccessIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCloudFrontOriginAccessIdentityCommandOutput) => void ): void; - public createCloudFrontOriginAccessIdentity( - args: CreateCloudFrontOriginAccessIdentityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCloudFrontOriginAccessIdentityCommandOutput) => void), - cb?: (err: any, data?: CreateCloudFrontOriginAccessIdentityCommandOutput) => void - ): Promise | void { - const command = new CreateCloudFrontOriginAccessIdentityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a continuous deployment policy that distributes traffic for a custom domain - * name to two different CloudFront distributions.

- *

To use a continuous deployment policy, first use CopyDistribution to - * create a staging distribution, then use UpdateDistribution to modify the - * staging distribution's configuration.

- *

After you create and update a staging distribution, you can use a continuous - * deployment policy to incrementally move traffic to the staging distribution. This - * workflow enables you to test changes to a distribution's configuration before moving all - * of your domain's production traffic to the new configuration.

+ * @see {@link CreateContinuousDeploymentPolicyCommand} */ - public createContinuousDeploymentPolicy( + createContinuousDeploymentPolicy( args: CreateContinuousDeploymentPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createContinuousDeploymentPolicy( + createContinuousDeploymentPolicy( args: CreateContinuousDeploymentPolicyCommandInput, cb: (err: any, data?: CreateContinuousDeploymentPolicyCommandOutput) => void ): void; - public createContinuousDeploymentPolicy( + createContinuousDeploymentPolicy( args: CreateContinuousDeploymentPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateContinuousDeploymentPolicyCommandOutput) => void ): void; - public createContinuousDeploymentPolicy( - args: CreateContinuousDeploymentPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateContinuousDeploymentPolicyCommandOutput) => void), - cb?: (err: any, data?: CreateContinuousDeploymentPolicyCommandOutput) => void - ): Promise | void { - const command = new CreateContinuousDeploymentPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a CloudFront distribution.

+ * @see {@link CreateDistributionCommand} */ - public createDistribution( + createDistribution( args: CreateDistributionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDistribution( + createDistribution( args: CreateDistributionCommandInput, cb: (err: any, data?: CreateDistributionCommandOutput) => void ): void; - public createDistribution( + createDistribution( args: CreateDistributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDistributionCommandOutput) => void ): void; - public createDistribution( - args: CreateDistributionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDistributionCommandOutput) => void), - cb?: (err: any, data?: CreateDistributionCommandOutput) => void - ): Promise | void { - const command = new CreateDistributionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create a new distribution with tags.

+ * @see {@link CreateDistributionWithTagsCommand} */ - public createDistributionWithTags( + createDistributionWithTags( args: CreateDistributionWithTagsCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDistributionWithTags( + createDistributionWithTags( args: CreateDistributionWithTagsCommandInput, cb: (err: any, data?: CreateDistributionWithTagsCommandOutput) => void ): void; - public createDistributionWithTags( + createDistributionWithTags( args: CreateDistributionWithTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDistributionWithTagsCommandOutput) => void ): void; - public createDistributionWithTags( - args: CreateDistributionWithTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDistributionWithTagsCommandOutput) => void), - cb?: (err: any, data?: CreateDistributionWithTagsCommandOutput) => void - ): Promise | void { - const command = new CreateDistributionWithTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create a new field-level encryption configuration.

+ * @see {@link CreateFieldLevelEncryptionConfigCommand} */ - public createFieldLevelEncryptionConfig( + createFieldLevelEncryptionConfig( args: CreateFieldLevelEncryptionConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFieldLevelEncryptionConfig( + createFieldLevelEncryptionConfig( args: CreateFieldLevelEncryptionConfigCommandInput, cb: (err: any, data?: CreateFieldLevelEncryptionConfigCommandOutput) => void ): void; - public createFieldLevelEncryptionConfig( + createFieldLevelEncryptionConfig( args: CreateFieldLevelEncryptionConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFieldLevelEncryptionConfigCommandOutput) => void ): void; - public createFieldLevelEncryptionConfig( - args: CreateFieldLevelEncryptionConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFieldLevelEncryptionConfigCommandOutput) => void), - cb?: (err: any, data?: CreateFieldLevelEncryptionConfigCommandOutput) => void - ): Promise | void { - const command = new CreateFieldLevelEncryptionConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create a field-level encryption profile.

+ * @see {@link CreateFieldLevelEncryptionProfileCommand} */ - public createFieldLevelEncryptionProfile( + createFieldLevelEncryptionProfile( args: CreateFieldLevelEncryptionProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFieldLevelEncryptionProfile( + createFieldLevelEncryptionProfile( args: CreateFieldLevelEncryptionProfileCommandInput, cb: (err: any, data?: CreateFieldLevelEncryptionProfileCommandOutput) => void ): void; - public createFieldLevelEncryptionProfile( + createFieldLevelEncryptionProfile( args: CreateFieldLevelEncryptionProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFieldLevelEncryptionProfileCommandOutput) => void ): void; - public createFieldLevelEncryptionProfile( - args: CreateFieldLevelEncryptionProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFieldLevelEncryptionProfileCommandOutput) => void), - cb?: (err: any, data?: CreateFieldLevelEncryptionProfileCommandOutput) => void - ): Promise | void { - const command = new CreateFieldLevelEncryptionProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a CloudFront function.

- *

To create a function, you provide the function code and some configuration information - * about the function. The response contains an Amazon Resource Name (ARN) that uniquely - * identifies the function.

- *

When you create a function, it's in the DEVELOPMENT stage. In this stage, - * you can test the function with TestFunction, and update it with - * UpdateFunction.

- *

When you're ready to use your function with a CloudFront distribution, use - * PublishFunction to copy the function from the DEVELOPMENT - * stage to LIVE. When it's live, you can attach the function to a - * distribution's cache behavior, using the function's ARN.

+ * @see {@link CreateFunctionCommand} */ - public createFunction( + createFunction( args: CreateFunctionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFunction( - args: CreateFunctionCommandInput, - cb: (err: any, data?: CreateFunctionCommandOutput) => void - ): void; - public createFunction( + createFunction(args: CreateFunctionCommandInput, cb: (err: any, data?: CreateFunctionCommandOutput) => void): void; + createFunction( args: CreateFunctionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFunctionCommandOutput) => void ): void; - public createFunction( - args: CreateFunctionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFunctionCommandOutput) => void), - cb?: (err: any, data?: CreateFunctionCommandOutput) => void - ): Promise | void { - const command = new CreateFunctionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create a new invalidation.

+ * @see {@link CreateInvalidationCommand} */ - public createInvalidation( + createInvalidation( args: CreateInvalidationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createInvalidation( + createInvalidation( args: CreateInvalidationCommandInput, cb: (err: any, data?: CreateInvalidationCommandOutput) => void ): void; - public createInvalidation( + createInvalidation( args: CreateInvalidationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInvalidationCommandOutput) => void ): void; - public createInvalidation( - args: CreateInvalidationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateInvalidationCommandOutput) => void), - cb?: (err: any, data?: CreateInvalidationCommandOutput) => void - ): Promise | void { - const command = new CreateInvalidationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a key group that you can use with CloudFront signed URLs and signed cookies.

- *

To create a key group, you must specify at least one public key for the key group. - * After you create a key group, you can reference it from one or more cache behaviors. - * When you reference a key group in a cache behavior, CloudFront requires signed URLs or signed - * cookies for all requests that match the cache behavior. The URLs or cookies must be - * signed with a private key whose corresponding public key is in the key group. The signed - * URL or cookie contains information about which public key CloudFront should use to verify the - * signature. For more information, see Serving private content in the - * Amazon CloudFront Developer Guide.

+ * @see {@link CreateKeyGroupCommand} */ - public createKeyGroup( + createKeyGroup( args: CreateKeyGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createKeyGroup( - args: CreateKeyGroupCommandInput, - cb: (err: any, data?: CreateKeyGroupCommandOutput) => void - ): void; - public createKeyGroup( + createKeyGroup(args: CreateKeyGroupCommandInput, cb: (err: any, data?: CreateKeyGroupCommandOutput) => void): void; + createKeyGroup( args: CreateKeyGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateKeyGroupCommandOutput) => void ): void; - public createKeyGroup( - args: CreateKeyGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateKeyGroupCommandOutput) => void), - cb?: (err: any, data?: CreateKeyGroupCommandOutput) => void - ): Promise | void { - const command = new CreateKeyGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables additional CloudWatch metrics for the specified CloudFront distribution. The - * additional metrics incur an additional cost.

- *

For more information, see Viewing additional CloudFront distribution metrics in - * the Amazon CloudFront Developer Guide.

+ * @see {@link CreateMonitoringSubscriptionCommand} */ - public createMonitoringSubscription( + createMonitoringSubscription( args: CreateMonitoringSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMonitoringSubscription( + createMonitoringSubscription( args: CreateMonitoringSubscriptionCommandInput, cb: (err: any, data?: CreateMonitoringSubscriptionCommandOutput) => void ): void; - public createMonitoringSubscription( + createMonitoringSubscription( args: CreateMonitoringSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMonitoringSubscriptionCommandOutput) => void ): void; - public createMonitoringSubscription( - args: CreateMonitoringSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMonitoringSubscriptionCommandOutput) => void), - cb?: (err: any, data?: CreateMonitoringSubscriptionCommandOutput) => void - ): Promise | void { - const command = new CreateMonitoringSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new origin access control in CloudFront. After you create an origin access - * control, you can add it to an origin in a CloudFront distribution so that CloudFront sends - * authenticated (signed) requests to the origin.

- *

This makes it possible to block public access to the origin, allowing viewers (users) to - * access the origin's content only through CloudFront.

- *

For more information about using a CloudFront origin access control, see Restricting access to an Amazon Web Services origin in the - * Amazon CloudFront Developer Guide.

+ * @see {@link CreateOriginAccessControlCommand} */ - public createOriginAccessControl( + createOriginAccessControl( args: CreateOriginAccessControlCommandInput, options?: __HttpHandlerOptions ): Promise; - public createOriginAccessControl( + createOriginAccessControl( args: CreateOriginAccessControlCommandInput, cb: (err: any, data?: CreateOriginAccessControlCommandOutput) => void ): void; - public createOriginAccessControl( + createOriginAccessControl( args: CreateOriginAccessControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateOriginAccessControlCommandOutput) => void ): void; - public createOriginAccessControl( - args: CreateOriginAccessControlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateOriginAccessControlCommandOutput) => void), - cb?: (err: any, data?: CreateOriginAccessControlCommandOutput) => void - ): Promise | void { - const command = new CreateOriginAccessControlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an origin request policy.

- *

After you create an origin request policy, you can attach it to one or more cache - * behaviors. When it's attached to a cache behavior, the origin request policy determines - * the values that CloudFront includes in requests that it sends to the origin. Each request that - * CloudFront sends to the origin includes the following:

- *
    - *
  • - *

    The request body and the URL path (without the domain name) from the viewer - * request.

    - *
  • - *
  • - *

    The headers that CloudFront automatically includes in every origin request, - * including Host, User-Agent, and - * X-Amz-Cf-Id.

    - *
  • - *
  • - *

    All HTTP headers, cookies, and URL query strings that are specified in the - * cache policy or the origin request policy. These can include items from the - * viewer request and, in the case of headers, additional ones that are added by - * CloudFront.

    - *
  • - *
- *

CloudFront sends a request when it can't find a valid object in its cache that matches the - * request. If you want to send values to the origin and also include them in the cache - * key, use CachePolicy.

- *

For more information about origin request policies, see Controlling origin requests in the - * Amazon CloudFront Developer Guide.

+ * @see {@link CreateOriginRequestPolicyCommand} */ - public createOriginRequestPolicy( + createOriginRequestPolicy( args: CreateOriginRequestPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createOriginRequestPolicy( + createOriginRequestPolicy( args: CreateOriginRequestPolicyCommandInput, cb: (err: any, data?: CreateOriginRequestPolicyCommandOutput) => void ): void; - public createOriginRequestPolicy( + createOriginRequestPolicy( args: CreateOriginRequestPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateOriginRequestPolicyCommandOutput) => void ): void; - public createOriginRequestPolicy( - args: CreateOriginRequestPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateOriginRequestPolicyCommandOutput) => void), - cb?: (err: any, data?: CreateOriginRequestPolicyCommandOutput) => void - ): Promise | void { - const command = new CreateOriginRequestPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.

+ * @see {@link CreatePublicKeyCommand} */ - public createPublicKey( + createPublicKey( args: CreatePublicKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPublicKey( - args: CreatePublicKeyCommandInput, - cb: (err: any, data?: CreatePublicKeyCommandOutput) => void - ): void; - public createPublicKey( + createPublicKey(args: CreatePublicKeyCommandInput, cb: (err: any, data?: CreatePublicKeyCommandOutput) => void): void; + createPublicKey( args: CreatePublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePublicKeyCommandOutput) => void ): void; - public createPublicKey( - args: CreatePublicKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePublicKeyCommandOutput) => void), - cb?: (err: any, data?: CreatePublicKeyCommandOutput) => void - ): Promise | void { - const command = new CreatePublicKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a real-time log configuration.

- *

After you create a real-time log configuration, you can attach it to one or more cache - * behaviors to send real-time log data to the specified Amazon Kinesis data stream.

- *

For more information about real-time log configurations, see Real-time logs in the - * Amazon CloudFront Developer Guide.

+ * @see {@link CreateRealtimeLogConfigCommand} */ - public createRealtimeLogConfig( + createRealtimeLogConfig( args: CreateRealtimeLogConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRealtimeLogConfig( + createRealtimeLogConfig( args: CreateRealtimeLogConfigCommandInput, cb: (err: any, data?: CreateRealtimeLogConfigCommandOutput) => void ): void; - public createRealtimeLogConfig( + createRealtimeLogConfig( args: CreateRealtimeLogConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRealtimeLogConfigCommandOutput) => void ): void; - public createRealtimeLogConfig( - args: CreateRealtimeLogConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRealtimeLogConfigCommandOutput) => void), - cb?: (err: any, data?: CreateRealtimeLogConfigCommandOutput) => void - ): Promise | void { - const command = new CreateRealtimeLogConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a response headers policy.

- *

A response headers policy contains information about a set of HTTP headers. To create a - * response headers policy, you provide some metadata about the policy and a set of - * configurations that specify the headers.

- *

After you create a response headers policy, you can use its ID to attach it to one or more - * cache behaviors in a CloudFront distribution. When it's attached to a cache behavior, the - * response headers policy affects the HTTP headers that CloudFront includes in HTTP responses to - * requests that match the cache behavior. CloudFront adds or removes response headers according - * to the configuration of the response headers policy.

- *

For more information, see Adding or removing HTTP headers in CloudFront responses in the - * Amazon CloudFront Developer Guide.

+ * @see {@link CreateResponseHeadersPolicyCommand} */ - public createResponseHeadersPolicy( + createResponseHeadersPolicy( args: CreateResponseHeadersPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createResponseHeadersPolicy( + createResponseHeadersPolicy( args: CreateResponseHeadersPolicyCommandInput, cb: (err: any, data?: CreateResponseHeadersPolicyCommandOutput) => void ): void; - public createResponseHeadersPolicy( + createResponseHeadersPolicy( args: CreateResponseHeadersPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResponseHeadersPolicyCommandOutput) => void ): void; - public createResponseHeadersPolicy( - args: CreateResponseHeadersPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateResponseHeadersPolicyCommandOutput) => void), - cb?: (err: any, data?: CreateResponseHeadersPolicyCommandOutput) => void - ): Promise | void { - const command = new CreateResponseHeadersPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) - * distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion - * forum.

+ * @see {@link CreateStreamingDistributionCommand} */ - public createStreamingDistribution( + createStreamingDistribution( args: CreateStreamingDistributionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createStreamingDistribution( + createStreamingDistribution( args: CreateStreamingDistributionCommandInput, cb: (err: any, data?: CreateStreamingDistributionCommandOutput) => void ): void; - public createStreamingDistribution( + createStreamingDistribution( args: CreateStreamingDistributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStreamingDistributionCommandOutput) => void ): void; - public createStreamingDistribution( - args: CreateStreamingDistributionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStreamingDistributionCommandOutput) => void), - cb?: (err: any, data?: CreateStreamingDistributionCommandOutput) => void - ): Promise | void { - const command = new CreateStreamingDistributionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) - * distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion - * forum.

+ * @see {@link CreateStreamingDistributionWithTagsCommand} */ - public createStreamingDistributionWithTags( + createStreamingDistributionWithTags( args: CreateStreamingDistributionWithTagsCommandInput, options?: __HttpHandlerOptions ): Promise; - public createStreamingDistributionWithTags( + createStreamingDistributionWithTags( args: CreateStreamingDistributionWithTagsCommandInput, cb: (err: any, data?: CreateStreamingDistributionWithTagsCommandOutput) => void ): void; - public createStreamingDistributionWithTags( + createStreamingDistributionWithTags( args: CreateStreamingDistributionWithTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStreamingDistributionWithTagsCommandOutput) => void ): void; - public createStreamingDistributionWithTags( - args: CreateStreamingDistributionWithTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStreamingDistributionWithTagsCommandOutput) => void), - cb?: (err: any, data?: CreateStreamingDistributionWithTagsCommandOutput) => void - ): Promise | void { - const command = new CreateStreamingDistributionWithTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a cache policy.

- *

You cannot delete a cache policy if it's attached to a cache behavior. First update - * your distributions to remove the cache policy from all cache behaviors, then delete the - * cache policy.

- *

To delete a cache policy, you must provide the policy's identifier and version. To get - * these values, you can use ListCachePolicies or - * GetCachePolicy.

+ * @see {@link DeleteCachePolicyCommand} */ - public deleteCachePolicy( + deleteCachePolicy( args: DeleteCachePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCachePolicy( + deleteCachePolicy( args: DeleteCachePolicyCommandInput, cb: (err: any, data?: DeleteCachePolicyCommandOutput) => void ): void; - public deleteCachePolicy( + deleteCachePolicy( args: DeleteCachePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCachePolicyCommandOutput) => void ): void; - public deleteCachePolicy( - args: DeleteCachePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCachePolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteCachePolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteCachePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete an origin access identity.

+ * @see {@link DeleteCloudFrontOriginAccessIdentityCommand} */ - public deleteCloudFrontOriginAccessIdentity( + deleteCloudFrontOriginAccessIdentity( args: DeleteCloudFrontOriginAccessIdentityCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCloudFrontOriginAccessIdentity( + deleteCloudFrontOriginAccessIdentity( args: DeleteCloudFrontOriginAccessIdentityCommandInput, cb: (err: any, data?: DeleteCloudFrontOriginAccessIdentityCommandOutput) => void ): void; - public deleteCloudFrontOriginAccessIdentity( + deleteCloudFrontOriginAccessIdentity( args: DeleteCloudFrontOriginAccessIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCloudFrontOriginAccessIdentityCommandOutput) => void ): void; - public deleteCloudFrontOriginAccessIdentity( - args: DeleteCloudFrontOriginAccessIdentityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCloudFrontOriginAccessIdentityCommandOutput) => void), - cb?: (err: any, data?: DeleteCloudFrontOriginAccessIdentityCommandOutput) => void - ): Promise | void { - const command = new DeleteCloudFrontOriginAccessIdentityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a continuous deployment policy.

- *

You cannot delete a continuous deployment policy that's attached to a primary - * distribution. First update your distribution to remove the continuous deployment policy, - * then you can delete the policy.

+ * @see {@link DeleteContinuousDeploymentPolicyCommand} */ - public deleteContinuousDeploymentPolicy( + deleteContinuousDeploymentPolicy( args: DeleteContinuousDeploymentPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteContinuousDeploymentPolicy( + deleteContinuousDeploymentPolicy( args: DeleteContinuousDeploymentPolicyCommandInput, cb: (err: any, data?: DeleteContinuousDeploymentPolicyCommandOutput) => void ): void; - public deleteContinuousDeploymentPolicy( + deleteContinuousDeploymentPolicy( args: DeleteContinuousDeploymentPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteContinuousDeploymentPolicyCommandOutput) => void ): void; - public deleteContinuousDeploymentPolicy( - args: DeleteContinuousDeploymentPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteContinuousDeploymentPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteContinuousDeploymentPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteContinuousDeploymentPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete a distribution.

+ * @see {@link DeleteDistributionCommand} */ - public deleteDistribution( + deleteDistribution( args: DeleteDistributionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDistribution( + deleteDistribution( args: DeleteDistributionCommandInput, cb: (err: any, data?: DeleteDistributionCommandOutput) => void ): void; - public deleteDistribution( + deleteDistribution( args: DeleteDistributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDistributionCommandOutput) => void ): void; - public deleteDistribution( - args: DeleteDistributionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDistributionCommandOutput) => void), - cb?: (err: any, data?: DeleteDistributionCommandOutput) => void - ): Promise | void { - const command = new DeleteDistributionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Remove a field-level encryption configuration.

+ * @see {@link DeleteFieldLevelEncryptionConfigCommand} */ - public deleteFieldLevelEncryptionConfig( + deleteFieldLevelEncryptionConfig( args: DeleteFieldLevelEncryptionConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFieldLevelEncryptionConfig( + deleteFieldLevelEncryptionConfig( args: DeleteFieldLevelEncryptionConfigCommandInput, cb: (err: any, data?: DeleteFieldLevelEncryptionConfigCommandOutput) => void ): void; - public deleteFieldLevelEncryptionConfig( + deleteFieldLevelEncryptionConfig( args: DeleteFieldLevelEncryptionConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFieldLevelEncryptionConfigCommandOutput) => void ): void; - public deleteFieldLevelEncryptionConfig( - args: DeleteFieldLevelEncryptionConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFieldLevelEncryptionConfigCommandOutput) => void), - cb?: (err: any, data?: DeleteFieldLevelEncryptionConfigCommandOutput) => void - ): Promise | void { - const command = new DeleteFieldLevelEncryptionConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Remove a field-level encryption profile.

+ * @see {@link DeleteFieldLevelEncryptionProfileCommand} */ - public deleteFieldLevelEncryptionProfile( + deleteFieldLevelEncryptionProfile( args: DeleteFieldLevelEncryptionProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFieldLevelEncryptionProfile( + deleteFieldLevelEncryptionProfile( args: DeleteFieldLevelEncryptionProfileCommandInput, cb: (err: any, data?: DeleteFieldLevelEncryptionProfileCommandOutput) => void ): void; - public deleteFieldLevelEncryptionProfile( + deleteFieldLevelEncryptionProfile( args: DeleteFieldLevelEncryptionProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFieldLevelEncryptionProfileCommandOutput) => void ): void; - public deleteFieldLevelEncryptionProfile( - args: DeleteFieldLevelEncryptionProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFieldLevelEncryptionProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteFieldLevelEncryptionProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteFieldLevelEncryptionProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a CloudFront function.

- *

You cannot delete a function if it's associated with a cache behavior. First, update - * your distributions to remove the function association from all cache behaviors, then - * delete the function.

- *

To delete a function, you must provide the function's name and version - * (ETag value). To get these values, you can use - * ListFunctions and DescribeFunction.

+ * @see {@link DeleteFunctionCommand} */ - public deleteFunction( + deleteFunction( args: DeleteFunctionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFunction( - args: DeleteFunctionCommandInput, - cb: (err: any, data?: DeleteFunctionCommandOutput) => void - ): void; - public deleteFunction( + deleteFunction(args: DeleteFunctionCommandInput, cb: (err: any, data?: DeleteFunctionCommandOutput) => void): void; + deleteFunction( args: DeleteFunctionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFunctionCommandOutput) => void ): void; - public deleteFunction( - args: DeleteFunctionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFunctionCommandOutput) => void), - cb?: (err: any, data?: DeleteFunctionCommandOutput) => void - ): Promise | void { - const command = new DeleteFunctionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a key group.

- *

You cannot delete a key group that is referenced in a cache behavior. First update - * your distributions to remove the key group from all cache behaviors, then delete the key - * group.

- *

To delete a key group, you must provide the key group's identifier and version. To get - * these values, use ListKeyGroups followed by GetKeyGroup or - * GetKeyGroupConfig.

+ * @see {@link DeleteKeyGroupCommand} */ - public deleteKeyGroup( + deleteKeyGroup( args: DeleteKeyGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteKeyGroup( - args: DeleteKeyGroupCommandInput, - cb: (err: any, data?: DeleteKeyGroupCommandOutput) => void - ): void; - public deleteKeyGroup( + deleteKeyGroup(args: DeleteKeyGroupCommandInput, cb: (err: any, data?: DeleteKeyGroupCommandOutput) => void): void; + deleteKeyGroup( args: DeleteKeyGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteKeyGroupCommandOutput) => void ): void; - public deleteKeyGroup( - args: DeleteKeyGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteKeyGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteKeyGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteKeyGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables additional CloudWatch metrics for the specified CloudFront - * distribution.

+ * @see {@link DeleteMonitoringSubscriptionCommand} */ - public deleteMonitoringSubscription( + deleteMonitoringSubscription( args: DeleteMonitoringSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMonitoringSubscription( + deleteMonitoringSubscription( args: DeleteMonitoringSubscriptionCommandInput, cb: (err: any, data?: DeleteMonitoringSubscriptionCommandOutput) => void ): void; - public deleteMonitoringSubscription( + deleteMonitoringSubscription( args: DeleteMonitoringSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMonitoringSubscriptionCommandOutput) => void ): void; - public deleteMonitoringSubscription( - args: DeleteMonitoringSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMonitoringSubscriptionCommandOutput) => void), - cb?: (err: any, data?: DeleteMonitoringSubscriptionCommandOutput) => void - ): Promise | void { - const command = new DeleteMonitoringSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a CloudFront origin access control.

- *

You cannot delete an origin access control if it's in use. First, update all - * distributions to remove the origin access control from all origins, then delete the - * origin access control.

+ * @see {@link DeleteOriginAccessControlCommand} */ - public deleteOriginAccessControl( + deleteOriginAccessControl( args: DeleteOriginAccessControlCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteOriginAccessControl( + deleteOriginAccessControl( args: DeleteOriginAccessControlCommandInput, cb: (err: any, data?: DeleteOriginAccessControlCommandOutput) => void ): void; - public deleteOriginAccessControl( + deleteOriginAccessControl( args: DeleteOriginAccessControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOriginAccessControlCommandOutput) => void ): void; - public deleteOriginAccessControl( - args: DeleteOriginAccessControlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteOriginAccessControlCommandOutput) => void), - cb?: (err: any, data?: DeleteOriginAccessControlCommandOutput) => void - ): Promise | void { - const command = new DeleteOriginAccessControlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an origin request policy.

- *

You cannot delete an origin request policy if it's attached to any cache behaviors. - * First update your distributions to remove the origin request policy from all cache - * behaviors, then delete the origin request policy.

- *

To delete an origin request policy, you must provide the policy's identifier and - * version. To get the identifier, you can use ListOriginRequestPolicies or - * GetOriginRequestPolicy.

+ * @see {@link DeleteOriginRequestPolicyCommand} */ - public deleteOriginRequestPolicy( + deleteOriginRequestPolicy( args: DeleteOriginRequestPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteOriginRequestPolicy( + deleteOriginRequestPolicy( args: DeleteOriginRequestPolicyCommandInput, cb: (err: any, data?: DeleteOriginRequestPolicyCommandOutput) => void ): void; - public deleteOriginRequestPolicy( + deleteOriginRequestPolicy( args: DeleteOriginRequestPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOriginRequestPolicyCommandOutput) => void ): void; - public deleteOriginRequestPolicy( - args: DeleteOriginRequestPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteOriginRequestPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteOriginRequestPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteOriginRequestPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Remove a public key you previously added to CloudFront.

+ * @see {@link DeletePublicKeyCommand} */ - public deletePublicKey( + deletePublicKey( args: DeletePublicKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePublicKey( - args: DeletePublicKeyCommandInput, - cb: (err: any, data?: DeletePublicKeyCommandOutput) => void - ): void; - public deletePublicKey( + deletePublicKey(args: DeletePublicKeyCommandInput, cb: (err: any, data?: DeletePublicKeyCommandOutput) => void): void; + deletePublicKey( args: DeletePublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePublicKeyCommandOutput) => void ): void; - public deletePublicKey( - args: DeletePublicKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePublicKeyCommandOutput) => void), - cb?: (err: any, data?: DeletePublicKeyCommandOutput) => void - ): Promise | void { - const command = new DeletePublicKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a real-time log configuration.

- *

You cannot delete a real-time log configuration if it's attached to a cache behavior. - * First update your distributions to remove the real-time log configuration from all cache - * behaviors, then delete the real-time log configuration.

- *

To delete a real-time log configuration, you can provide the configuration's name or - * its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront - * uses the name to identify the real-time log configuration to delete.

+ * @see {@link DeleteRealtimeLogConfigCommand} */ - public deleteRealtimeLogConfig( + deleteRealtimeLogConfig( args: DeleteRealtimeLogConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRealtimeLogConfig( + deleteRealtimeLogConfig( args: DeleteRealtimeLogConfigCommandInput, cb: (err: any, data?: DeleteRealtimeLogConfigCommandOutput) => void ): void; - public deleteRealtimeLogConfig( + deleteRealtimeLogConfig( args: DeleteRealtimeLogConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRealtimeLogConfigCommandOutput) => void ): void; - public deleteRealtimeLogConfig( - args: DeleteRealtimeLogConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRealtimeLogConfigCommandOutput) => void), - cb?: (err: any, data?: DeleteRealtimeLogConfigCommandOutput) => void - ): Promise | void { - const command = new DeleteRealtimeLogConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a response headers policy.

- *

You cannot delete a response headers policy if it's attached to a cache behavior. - * First update your distributions to remove the response headers policy from all cache - * behaviors, then delete the response headers policy.

- *

To delete a response headers policy, you must provide the policy's identifier and - * version. To get these values, you can use ListResponseHeadersPolicies or - * GetResponseHeadersPolicy.

+ * @see {@link DeleteResponseHeadersPolicyCommand} */ - public deleteResponseHeadersPolicy( + deleteResponseHeadersPolicy( args: DeleteResponseHeadersPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResponseHeadersPolicy( + deleteResponseHeadersPolicy( args: DeleteResponseHeadersPolicyCommandInput, cb: (err: any, data?: DeleteResponseHeadersPolicyCommandOutput) => void ): void; - public deleteResponseHeadersPolicy( + deleteResponseHeadersPolicy( args: DeleteResponseHeadersPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResponseHeadersPolicyCommandOutput) => void ): void; - public deleteResponseHeadersPolicy( - args: DeleteResponseHeadersPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResponseHeadersPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteResponseHeadersPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteResponseHeadersPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, - * perform the following steps.

- *

- * To delete an RTMP distribution using the CloudFront - * API:

- *
    - *
  1. - *

    Disable the RTMP distribution.

    - *
  2. - *
  3. - *

    Submit a GET Streaming Distribution Config request to get the - * current configuration and the Etag header for the distribution. - *

    - *
  4. - *
  5. - *

    Update the XML document that was returned in the response to your GET - * Streaming Distribution Config request to change the value of - * Enabled to false.

    - *
  6. - *
  7. - *

    Submit a PUT Streaming Distribution Config request to update the - * configuration for your distribution. In the request body, include the XML - * document that you updated in Step 3. Then set the value of the HTTP - * If-Match header to the value of the ETag header - * that CloudFront returned when you submitted the GET Streaming Distribution - * Config request in Step 2.

    - *
  8. - *
  9. - *

    Review the response to the PUT Streaming Distribution Config - * request to confirm that the distribution was successfully disabled.

    - *
  10. - *
  11. - *

    Submit a GET Streaming Distribution Config request to confirm - * that your changes have propagated. When propagation is complete, the value of - * Status is Deployed.

    - *
  12. - *
  13. - *

    Submit a DELETE Streaming Distribution request. Set the value of - * the HTTP If-Match header to the value of the ETag - * header that CloudFront returned when you submitted the GET Streaming - * Distribution Config request in Step 2.

    - *
  14. - *
  15. - *

    Review the response to your DELETE Streaming Distribution request - * to confirm that the distribution was successfully deleted.

    - *
  16. - *
- *

For information about deleting a distribution using the CloudFront console, see Deleting a - * Distribution in the Amazon CloudFront Developer Guide.

+ * @see {@link DeleteStreamingDistributionCommand} */ - public deleteStreamingDistribution( + deleteStreamingDistribution( args: DeleteStreamingDistributionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteStreamingDistribution( + deleteStreamingDistribution( args: DeleteStreamingDistributionCommandInput, cb: (err: any, data?: DeleteStreamingDistributionCommandOutput) => void ): void; - public deleteStreamingDistribution( + deleteStreamingDistribution( args: DeleteStreamingDistributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStreamingDistributionCommandOutput) => void ): void; - public deleteStreamingDistribution( - args: DeleteStreamingDistributionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStreamingDistributionCommandOutput) => void), - cb?: (err: any, data?: DeleteStreamingDistributionCommandOutput) => void - ): Promise | void { - const command = new DeleteStreamingDistributionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets configuration information and metadata about a CloudFront function, but not the - * function's code. To get a function's code, use GetFunction.

- *

To get configuration information and metadata about a function, you must provide the - * function's name and stage. To get these values, you can use - * ListFunctions.

+ * @see {@link DescribeFunctionCommand} */ - public describeFunction( + describeFunction( args: DescribeFunctionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFunction( + describeFunction( args: DescribeFunctionCommandInput, cb: (err: any, data?: DescribeFunctionCommandOutput) => void ): void; - public describeFunction( + describeFunction( args: DescribeFunctionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFunctionCommandOutput) => void ): void; - public describeFunction( - args: DescribeFunctionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFunctionCommandOutput) => void), - cb?: (err: any, data?: DescribeFunctionCommandOutput) => void - ): Promise | void { - const command = new DescribeFunctionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a cache policy, including the following metadata:

- *
    - *
  • - *

    The policy's identifier.

    - *
  • - *
  • - *

    The date and time when the policy was last modified.

    - *
  • - *
- *

To get a cache policy, you must provide the policy's identifier. If the cache policy - * is attached to a distribution's cache behavior, you can get the policy's identifier - * using ListDistributions or GetDistribution. If the cache - * policy is not attached to a cache behavior, you can get the identifier using - * ListCachePolicies.

+ * @see {@link GetCachePolicyCommand} */ - public getCachePolicy( + getCachePolicy( args: GetCachePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCachePolicy( - args: GetCachePolicyCommandInput, - cb: (err: any, data?: GetCachePolicyCommandOutput) => void - ): void; - public getCachePolicy( + getCachePolicy(args: GetCachePolicyCommandInput, cb: (err: any, data?: GetCachePolicyCommandOutput) => void): void; + getCachePolicy( args: GetCachePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCachePolicyCommandOutput) => void ): void; - public getCachePolicy( - args: GetCachePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCachePolicyCommandOutput) => void), - cb?: (err: any, data?: GetCachePolicyCommandOutput) => void - ): Promise | void { - const command = new GetCachePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a cache policy configuration.

- *

To get a cache policy configuration, you must provide the policy's identifier. If the - * cache policy is attached to a distribution's cache behavior, you can get the policy's - * identifier using ListDistributions or GetDistribution. If the - * cache policy is not attached to a cache behavior, you can get the identifier using - * ListCachePolicies.

+ * @see {@link GetCachePolicyConfigCommand} */ - public getCachePolicyConfig( + getCachePolicyConfig( args: GetCachePolicyConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCachePolicyConfig( + getCachePolicyConfig( args: GetCachePolicyConfigCommandInput, cb: (err: any, data?: GetCachePolicyConfigCommandOutput) => void ): void; - public getCachePolicyConfig( + getCachePolicyConfig( args: GetCachePolicyConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCachePolicyConfigCommandOutput) => void ): void; - public getCachePolicyConfig( - args: GetCachePolicyConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCachePolicyConfigCommandOutput) => void), - cb?: (err: any, data?: GetCachePolicyConfigCommandOutput) => void - ): Promise | void { - const command = new GetCachePolicyConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the information about an origin access identity.

+ * @see {@link GetCloudFrontOriginAccessIdentityCommand} */ - public getCloudFrontOriginAccessIdentity( + getCloudFrontOriginAccessIdentity( args: GetCloudFrontOriginAccessIdentityCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCloudFrontOriginAccessIdentity( + getCloudFrontOriginAccessIdentity( args: GetCloudFrontOriginAccessIdentityCommandInput, cb: (err: any, data?: GetCloudFrontOriginAccessIdentityCommandOutput) => void ): void; - public getCloudFrontOriginAccessIdentity( + getCloudFrontOriginAccessIdentity( args: GetCloudFrontOriginAccessIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCloudFrontOriginAccessIdentityCommandOutput) => void ): void; - public getCloudFrontOriginAccessIdentity( - args: GetCloudFrontOriginAccessIdentityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCloudFrontOriginAccessIdentityCommandOutput) => void), - cb?: (err: any, data?: GetCloudFrontOriginAccessIdentityCommandOutput) => void - ): Promise | void { - const command = new GetCloudFrontOriginAccessIdentityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the configuration information about an origin access identity.

+ * @see {@link GetCloudFrontOriginAccessIdentityConfigCommand} */ - public getCloudFrontOriginAccessIdentityConfig( + getCloudFrontOriginAccessIdentityConfig( args: GetCloudFrontOriginAccessIdentityConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCloudFrontOriginAccessIdentityConfig( + getCloudFrontOriginAccessIdentityConfig( args: GetCloudFrontOriginAccessIdentityConfigCommandInput, cb: (err: any, data?: GetCloudFrontOriginAccessIdentityConfigCommandOutput) => void ): void; - public getCloudFrontOriginAccessIdentityConfig( + getCloudFrontOriginAccessIdentityConfig( args: GetCloudFrontOriginAccessIdentityConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCloudFrontOriginAccessIdentityConfigCommandOutput) => void ): void; - public getCloudFrontOriginAccessIdentityConfig( - args: GetCloudFrontOriginAccessIdentityConfigCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetCloudFrontOriginAccessIdentityConfigCommandOutput) => void), - cb?: (err: any, data?: GetCloudFrontOriginAccessIdentityConfigCommandOutput) => void - ): Promise | void { - const command = new GetCloudFrontOriginAccessIdentityConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a continuous deployment policy, including metadata (the policy's identifier and - * the date and time when the policy was last modified).

+ * @see {@link GetContinuousDeploymentPolicyCommand} */ - public getContinuousDeploymentPolicy( + getContinuousDeploymentPolicy( args: GetContinuousDeploymentPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getContinuousDeploymentPolicy( + getContinuousDeploymentPolicy( args: GetContinuousDeploymentPolicyCommandInput, cb: (err: any, data?: GetContinuousDeploymentPolicyCommandOutput) => void ): void; - public getContinuousDeploymentPolicy( + getContinuousDeploymentPolicy( args: GetContinuousDeploymentPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContinuousDeploymentPolicyCommandOutput) => void ): void; - public getContinuousDeploymentPolicy( - args: GetContinuousDeploymentPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContinuousDeploymentPolicyCommandOutput) => void), - cb?: (err: any, data?: GetContinuousDeploymentPolicyCommandOutput) => void - ): Promise | void { - const command = new GetContinuousDeploymentPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets configuration information about a continuous deployment policy.

+ * @see {@link GetContinuousDeploymentPolicyConfigCommand} */ - public getContinuousDeploymentPolicyConfig( + getContinuousDeploymentPolicyConfig( args: GetContinuousDeploymentPolicyConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getContinuousDeploymentPolicyConfig( + getContinuousDeploymentPolicyConfig( args: GetContinuousDeploymentPolicyConfigCommandInput, cb: (err: any, data?: GetContinuousDeploymentPolicyConfigCommandOutput) => void ): void; - public getContinuousDeploymentPolicyConfig( + getContinuousDeploymentPolicyConfig( args: GetContinuousDeploymentPolicyConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContinuousDeploymentPolicyConfigCommandOutput) => void ): void; - public getContinuousDeploymentPolicyConfig( - args: GetContinuousDeploymentPolicyConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContinuousDeploymentPolicyConfigCommandOutput) => void), - cb?: (err: any, data?: GetContinuousDeploymentPolicyConfigCommandOutput) => void - ): Promise | void { - const command = new GetContinuousDeploymentPolicyConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the information about a distribution.

+ * @see {@link GetDistributionCommand} */ - public getDistribution( + getDistribution( args: GetDistributionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDistribution( - args: GetDistributionCommandInput, - cb: (err: any, data?: GetDistributionCommandOutput) => void - ): void; - public getDistribution( + getDistribution(args: GetDistributionCommandInput, cb: (err: any, data?: GetDistributionCommandOutput) => void): void; + getDistribution( args: GetDistributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDistributionCommandOutput) => void ): void; - public getDistribution( - args: GetDistributionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDistributionCommandOutput) => void), - cb?: (err: any, data?: GetDistributionCommandOutput) => void - ): Promise | void { - const command = new GetDistributionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the configuration information about a distribution.

+ * @see {@link GetDistributionConfigCommand} */ - public getDistributionConfig( + getDistributionConfig( args: GetDistributionConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDistributionConfig( + getDistributionConfig( args: GetDistributionConfigCommandInput, cb: (err: any, data?: GetDistributionConfigCommandOutput) => void ): void; - public getDistributionConfig( + getDistributionConfig( args: GetDistributionConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDistributionConfigCommandOutput) => void ): void; - public getDistributionConfig( - args: GetDistributionConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDistributionConfigCommandOutput) => void), - cb?: (err: any, data?: GetDistributionConfigCommandOutput) => void - ): Promise | void { - const command = new GetDistributionConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the field-level encryption configuration information.

+ * @see {@link GetFieldLevelEncryptionCommand} */ - public getFieldLevelEncryption( + getFieldLevelEncryption( args: GetFieldLevelEncryptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFieldLevelEncryption( + getFieldLevelEncryption( args: GetFieldLevelEncryptionCommandInput, cb: (err: any, data?: GetFieldLevelEncryptionCommandOutput) => void ): void; - public getFieldLevelEncryption( + getFieldLevelEncryption( args: GetFieldLevelEncryptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFieldLevelEncryptionCommandOutput) => void ): void; - public getFieldLevelEncryption( - args: GetFieldLevelEncryptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFieldLevelEncryptionCommandOutput) => void), - cb?: (err: any, data?: GetFieldLevelEncryptionCommandOutput) => void - ): Promise | void { - const command = new GetFieldLevelEncryptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the field-level encryption configuration information.

+ * @see {@link GetFieldLevelEncryptionConfigCommand} */ - public getFieldLevelEncryptionConfig( + getFieldLevelEncryptionConfig( args: GetFieldLevelEncryptionConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFieldLevelEncryptionConfig( + getFieldLevelEncryptionConfig( args: GetFieldLevelEncryptionConfigCommandInput, cb: (err: any, data?: GetFieldLevelEncryptionConfigCommandOutput) => void ): void; - public getFieldLevelEncryptionConfig( + getFieldLevelEncryptionConfig( args: GetFieldLevelEncryptionConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFieldLevelEncryptionConfigCommandOutput) => void ): void; - public getFieldLevelEncryptionConfig( - args: GetFieldLevelEncryptionConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFieldLevelEncryptionConfigCommandOutput) => void), - cb?: (err: any, data?: GetFieldLevelEncryptionConfigCommandOutput) => void - ): Promise | void { - const command = new GetFieldLevelEncryptionConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the field-level encryption profile information.

+ * @see {@link GetFieldLevelEncryptionProfileCommand} */ - public getFieldLevelEncryptionProfile( + getFieldLevelEncryptionProfile( args: GetFieldLevelEncryptionProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFieldLevelEncryptionProfile( + getFieldLevelEncryptionProfile( args: GetFieldLevelEncryptionProfileCommandInput, cb: (err: any, data?: GetFieldLevelEncryptionProfileCommandOutput) => void ): void; - public getFieldLevelEncryptionProfile( + getFieldLevelEncryptionProfile( args: GetFieldLevelEncryptionProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFieldLevelEncryptionProfileCommandOutput) => void ): void; - public getFieldLevelEncryptionProfile( - args: GetFieldLevelEncryptionProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFieldLevelEncryptionProfileCommandOutput) => void), - cb?: (err: any, data?: GetFieldLevelEncryptionProfileCommandOutput) => void - ): Promise | void { - const command = new GetFieldLevelEncryptionProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the field-level encryption profile configuration information.

+ * @see {@link GetFieldLevelEncryptionProfileConfigCommand} */ - public getFieldLevelEncryptionProfileConfig( + getFieldLevelEncryptionProfileConfig( args: GetFieldLevelEncryptionProfileConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFieldLevelEncryptionProfileConfig( + getFieldLevelEncryptionProfileConfig( args: GetFieldLevelEncryptionProfileConfigCommandInput, cb: (err: any, data?: GetFieldLevelEncryptionProfileConfigCommandOutput) => void ): void; - public getFieldLevelEncryptionProfileConfig( + getFieldLevelEncryptionProfileConfig( args: GetFieldLevelEncryptionProfileConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFieldLevelEncryptionProfileConfigCommandOutput) => void ): void; - public getFieldLevelEncryptionProfileConfig( - args: GetFieldLevelEncryptionProfileConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFieldLevelEncryptionProfileConfigCommandOutput) => void), - cb?: (err: any, data?: GetFieldLevelEncryptionProfileConfigCommandOutput) => void - ): Promise | void { - const command = new GetFieldLevelEncryptionProfileConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the code of a CloudFront function. To get configuration information and metadata about - * a function, use DescribeFunction.

- *

To get a function's code, you must provide the function's name and stage. To get these - * values, you can use ListFunctions.

+ * @see {@link GetFunctionCommand} */ - public getFunction(args: GetFunctionCommandInput, options?: __HttpHandlerOptions): Promise; - public getFunction(args: GetFunctionCommandInput, cb: (err: any, data?: GetFunctionCommandOutput) => void): void; - public getFunction( + getFunction(args: GetFunctionCommandInput, options?: __HttpHandlerOptions): Promise; + getFunction(args: GetFunctionCommandInput, cb: (err: any, data?: GetFunctionCommandOutput) => void): void; + getFunction( args: GetFunctionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFunctionCommandOutput) => void ): void; - public getFunction( - args: GetFunctionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFunctionCommandOutput) => void), - cb?: (err: any, data?: GetFunctionCommandOutput) => void - ): Promise | void { - const command = new GetFunctionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the information about an invalidation.

+ * @see {@link GetInvalidationCommand} */ - public getInvalidation( + getInvalidation( args: GetInvalidationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInvalidation( - args: GetInvalidationCommandInput, - cb: (err: any, data?: GetInvalidationCommandOutput) => void - ): void; - public getInvalidation( + getInvalidation(args: GetInvalidationCommandInput, cb: (err: any, data?: GetInvalidationCommandOutput) => void): void; + getInvalidation( args: GetInvalidationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInvalidationCommandOutput) => void ): void; - public getInvalidation( - args: GetInvalidationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInvalidationCommandOutput) => void), - cb?: (err: any, data?: GetInvalidationCommandOutput) => void - ): Promise | void { - const command = new GetInvalidationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a key group, including the date and time when the key group was last - * modified.

- *

To get a key group, you must provide the key group's identifier. If the key group is - * referenced in a distribution's cache behavior, you can get the key group's identifier - * using ListDistributions or GetDistribution. If the key group - * is not referenced in a cache behavior, you can get the identifier using - * ListKeyGroups.

+ * @see {@link GetKeyGroupCommand} */ - public getKeyGroup(args: GetKeyGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public getKeyGroup(args: GetKeyGroupCommandInput, cb: (err: any, data?: GetKeyGroupCommandOutput) => void): void; - public getKeyGroup( + getKeyGroup(args: GetKeyGroupCommandInput, options?: __HttpHandlerOptions): Promise; + getKeyGroup(args: GetKeyGroupCommandInput, cb: (err: any, data?: GetKeyGroupCommandOutput) => void): void; + getKeyGroup( args: GetKeyGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetKeyGroupCommandOutput) => void ): void; - public getKeyGroup( - args: GetKeyGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetKeyGroupCommandOutput) => void), - cb?: (err: any, data?: GetKeyGroupCommandOutput) => void - ): Promise | void { - const command = new GetKeyGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a key group configuration.

- *

To get a key group configuration, you must provide the key group's identifier. If the - * key group is referenced in a distribution's cache behavior, you can get the key group's - * identifier using ListDistributions or GetDistribution. If the - * key group is not referenced in a cache behavior, you can get the identifier using - * ListKeyGroups.

+ * @see {@link GetKeyGroupConfigCommand} */ - public getKeyGroupConfig( + getKeyGroupConfig( args: GetKeyGroupConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getKeyGroupConfig( + getKeyGroupConfig( args: GetKeyGroupConfigCommandInput, cb: (err: any, data?: GetKeyGroupConfigCommandOutput) => void ): void; - public getKeyGroupConfig( + getKeyGroupConfig( args: GetKeyGroupConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetKeyGroupConfigCommandOutput) => void ): void; - public getKeyGroupConfig( - args: GetKeyGroupConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetKeyGroupConfigCommandOutput) => void), - cb?: (err: any, data?: GetKeyGroupConfigCommandOutput) => void - ): Promise | void { - const command = new GetKeyGroupConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about whether additional CloudWatch metrics are enabled for the - * specified CloudFront distribution.

+ * @see {@link GetMonitoringSubscriptionCommand} */ - public getMonitoringSubscription( + getMonitoringSubscription( args: GetMonitoringSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMonitoringSubscription( + getMonitoringSubscription( args: GetMonitoringSubscriptionCommandInput, cb: (err: any, data?: GetMonitoringSubscriptionCommandOutput) => void ): void; - public getMonitoringSubscription( + getMonitoringSubscription( args: GetMonitoringSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMonitoringSubscriptionCommandOutput) => void ): void; - public getMonitoringSubscription( - args: GetMonitoringSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMonitoringSubscriptionCommandOutput) => void), - cb?: (err: any, data?: GetMonitoringSubscriptionCommandOutput) => void - ): Promise | void { - const command = new GetMonitoringSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a CloudFront origin access control, including its unique identifier.

+ * @see {@link GetOriginAccessControlCommand} */ - public getOriginAccessControl( + getOriginAccessControl( args: GetOriginAccessControlCommandInput, options?: __HttpHandlerOptions ): Promise; - public getOriginAccessControl( + getOriginAccessControl( args: GetOriginAccessControlCommandInput, cb: (err: any, data?: GetOriginAccessControlCommandOutput) => void ): void; - public getOriginAccessControl( + getOriginAccessControl( args: GetOriginAccessControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOriginAccessControlCommandOutput) => void ): void; - public getOriginAccessControl( - args: GetOriginAccessControlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOriginAccessControlCommandOutput) => void), - cb?: (err: any, data?: GetOriginAccessControlCommandOutput) => void - ): Promise | void { - const command = new GetOriginAccessControlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a CloudFront origin access control configuration.

+ * @see {@link GetOriginAccessControlConfigCommand} */ - public getOriginAccessControlConfig( + getOriginAccessControlConfig( args: GetOriginAccessControlConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getOriginAccessControlConfig( + getOriginAccessControlConfig( args: GetOriginAccessControlConfigCommandInput, cb: (err: any, data?: GetOriginAccessControlConfigCommandOutput) => void ): void; - public getOriginAccessControlConfig( + getOriginAccessControlConfig( args: GetOriginAccessControlConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOriginAccessControlConfigCommandOutput) => void ): void; - public getOriginAccessControlConfig( - args: GetOriginAccessControlConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOriginAccessControlConfigCommandOutput) => void), - cb?: (err: any, data?: GetOriginAccessControlConfigCommandOutput) => void - ): Promise | void { - const command = new GetOriginAccessControlConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets an origin request policy, including the following metadata:

- *
    - *
  • - *

    The policy's identifier.

    - *
  • - *
  • - *

    The date and time when the policy was last modified.

    - *
  • - *
- *

To get an origin request policy, you must provide the policy's identifier. If the - * origin request policy is attached to a distribution's cache behavior, you can get the - * policy's identifier using ListDistributions or - * GetDistribution. If the origin request policy is not attached to a cache - * behavior, you can get the identifier using - * ListOriginRequestPolicies.

+ * @see {@link GetOriginRequestPolicyCommand} */ - public getOriginRequestPolicy( + getOriginRequestPolicy( args: GetOriginRequestPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getOriginRequestPolicy( + getOriginRequestPolicy( args: GetOriginRequestPolicyCommandInput, cb: (err: any, data?: GetOriginRequestPolicyCommandOutput) => void ): void; - public getOriginRequestPolicy( + getOriginRequestPolicy( args: GetOriginRequestPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOriginRequestPolicyCommandOutput) => void ): void; - public getOriginRequestPolicy( - args: GetOriginRequestPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOriginRequestPolicyCommandOutput) => void), - cb?: (err: any, data?: GetOriginRequestPolicyCommandOutput) => void - ): Promise | void { - const command = new GetOriginRequestPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets an origin request policy configuration.

- *

To get an origin request policy configuration, you must provide the policy's - * identifier. If the origin request policy is attached to a distribution's cache behavior, - * you can get the policy's identifier using ListDistributions or - * GetDistribution. If the origin request policy is not attached to a - * cache behavior, you can get the identifier using - * ListOriginRequestPolicies.

+ * @see {@link GetOriginRequestPolicyConfigCommand} */ - public getOriginRequestPolicyConfig( + getOriginRequestPolicyConfig( args: GetOriginRequestPolicyConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getOriginRequestPolicyConfig( + getOriginRequestPolicyConfig( args: GetOriginRequestPolicyConfigCommandInput, cb: (err: any, data?: GetOriginRequestPolicyConfigCommandOutput) => void ): void; - public getOriginRequestPolicyConfig( + getOriginRequestPolicyConfig( args: GetOriginRequestPolicyConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOriginRequestPolicyConfigCommandOutput) => void ): void; - public getOriginRequestPolicyConfig( - args: GetOriginRequestPolicyConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOriginRequestPolicyConfigCommandOutput) => void), - cb?: (err: any, data?: GetOriginRequestPolicyConfigCommandOutput) => void - ): Promise | void { - const command = new GetOriginRequestPolicyConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a public key.

+ * @see {@link GetPublicKeyCommand} */ - public getPublicKey( - args: GetPublicKeyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getPublicKey(args: GetPublicKeyCommandInput, cb: (err: any, data?: GetPublicKeyCommandOutput) => void): void; - public getPublicKey( + getPublicKey(args: GetPublicKeyCommandInput, options?: __HttpHandlerOptions): Promise; + getPublicKey(args: GetPublicKeyCommandInput, cb: (err: any, data?: GetPublicKeyCommandOutput) => void): void; + getPublicKey( args: GetPublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPublicKeyCommandOutput) => void ): void; - public getPublicKey( - args: GetPublicKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPublicKeyCommandOutput) => void), - cb?: (err: any, data?: GetPublicKeyCommandOutput) => void - ): Promise | void { - const command = new GetPublicKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a public key configuration.

+ * @see {@link GetPublicKeyConfigCommand} */ - public getPublicKeyConfig( + getPublicKeyConfig( args: GetPublicKeyConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPublicKeyConfig( + getPublicKeyConfig( args: GetPublicKeyConfigCommandInput, cb: (err: any, data?: GetPublicKeyConfigCommandOutput) => void ): void; - public getPublicKeyConfig( + getPublicKeyConfig( args: GetPublicKeyConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPublicKeyConfigCommandOutput) => void ): void; - public getPublicKeyConfig( - args: GetPublicKeyConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPublicKeyConfigCommandOutput) => void), - cb?: (err: any, data?: GetPublicKeyConfigCommandOutput) => void - ): Promise | void { - const command = new GetPublicKeyConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a real-time log configuration.

- *

To get a real-time log configuration, you can provide the configuration's name or its - * Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront - * uses the name to identify the real-time log configuration to get.

+ * @see {@link GetRealtimeLogConfigCommand} */ - public getRealtimeLogConfig( + getRealtimeLogConfig( args: GetRealtimeLogConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRealtimeLogConfig( + getRealtimeLogConfig( args: GetRealtimeLogConfigCommandInput, cb: (err: any, data?: GetRealtimeLogConfigCommandOutput) => void ): void; - public getRealtimeLogConfig( + getRealtimeLogConfig( args: GetRealtimeLogConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRealtimeLogConfigCommandOutput) => void ): void; - public getRealtimeLogConfig( - args: GetRealtimeLogConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRealtimeLogConfigCommandOutput) => void), - cb?: (err: any, data?: GetRealtimeLogConfigCommandOutput) => void - ): Promise | void { - const command = new GetRealtimeLogConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a response headers policy, including metadata (the policy's identifier and the - * date and time when the policy was last modified).

- *

To get a response headers policy, you must provide the policy's identifier. If the - * response headers policy is attached to a distribution's cache behavior, you can get the - * policy's identifier using ListDistributions or - * GetDistribution. If the response headers policy is not attached to a cache - * behavior, you can get the identifier using - * ListResponseHeadersPolicies.

+ * @see {@link GetResponseHeadersPolicyCommand} */ - public getResponseHeadersPolicy( + getResponseHeadersPolicy( args: GetResponseHeadersPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResponseHeadersPolicy( + getResponseHeadersPolicy( args: GetResponseHeadersPolicyCommandInput, cb: (err: any, data?: GetResponseHeadersPolicyCommandOutput) => void ): void; - public getResponseHeadersPolicy( + getResponseHeadersPolicy( args: GetResponseHeadersPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResponseHeadersPolicyCommandOutput) => void ): void; - public getResponseHeadersPolicy( - args: GetResponseHeadersPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResponseHeadersPolicyCommandOutput) => void), - cb?: (err: any, data?: GetResponseHeadersPolicyCommandOutput) => void - ): Promise | void { - const command = new GetResponseHeadersPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a response headers policy configuration.

- *

To get a response headers policy configuration, you must provide the policy's - * identifier. If the response headers policy is attached to a distribution's cache - * behavior, you can get the policy's identifier using ListDistributions or - * GetDistribution. If the response headers policy is not attached to a - * cache behavior, you can get the identifier using - * ListResponseHeadersPolicies.

+ * @see {@link GetResponseHeadersPolicyConfigCommand} */ - public getResponseHeadersPolicyConfig( + getResponseHeadersPolicyConfig( args: GetResponseHeadersPolicyConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResponseHeadersPolicyConfig( + getResponseHeadersPolicyConfig( args: GetResponseHeadersPolicyConfigCommandInput, cb: (err: any, data?: GetResponseHeadersPolicyConfigCommandOutput) => void ): void; - public getResponseHeadersPolicyConfig( + getResponseHeadersPolicyConfig( args: GetResponseHeadersPolicyConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResponseHeadersPolicyConfigCommandOutput) => void ): void; - public getResponseHeadersPolicyConfig( - args: GetResponseHeadersPolicyConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResponseHeadersPolicyConfigCommandOutput) => void), - cb?: (err: any, data?: GetResponseHeadersPolicyConfigCommandOutput) => void - ): Promise | void { - const command = new GetResponseHeadersPolicyConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a specified RTMP distribution, including the distribution - * configuration.

+ * @see {@link GetStreamingDistributionCommand} */ - public getStreamingDistribution( + getStreamingDistribution( args: GetStreamingDistributionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getStreamingDistribution( + getStreamingDistribution( args: GetStreamingDistributionCommandInput, cb: (err: any, data?: GetStreamingDistributionCommandOutput) => void ): void; - public getStreamingDistribution( + getStreamingDistribution( args: GetStreamingDistributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStreamingDistributionCommandOutput) => void ): void; - public getStreamingDistribution( - args: GetStreamingDistributionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStreamingDistributionCommandOutput) => void), - cb?: (err: any, data?: GetStreamingDistributionCommandOutput) => void - ): Promise | void { - const command = new GetStreamingDistributionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the configuration information about a streaming distribution.

+ * @see {@link GetStreamingDistributionConfigCommand} */ - public getStreamingDistributionConfig( + getStreamingDistributionConfig( args: GetStreamingDistributionConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getStreamingDistributionConfig( + getStreamingDistributionConfig( args: GetStreamingDistributionConfigCommandInput, cb: (err: any, data?: GetStreamingDistributionConfigCommandOutput) => void ): void; - public getStreamingDistributionConfig( + getStreamingDistributionConfig( args: GetStreamingDistributionConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStreamingDistributionConfigCommandOutput) => void ): void; - public getStreamingDistributionConfig( - args: GetStreamingDistributionConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStreamingDistributionConfigCommandOutput) => void), - cb?: (err: any, data?: GetStreamingDistributionConfigCommandOutput) => void - ): Promise | void { - const command = new GetStreamingDistributionConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of cache policies.

- *

You can optionally apply a filter to return only the managed policies created by - * Amazon Web Services, or only the custom policies created in your Amazon Web Services account.

- *

You can optionally specify the maximum number of items to receive in the response. If - * the total number of items in the list exceeds the maximum that you specify, or the - * default maximum, the response is paginated. To get the next page of items, send a - * subsequent request that specifies the NextMarker value from the current - * response as the Marker value in the subsequent request.

+ * @see {@link ListCachePoliciesCommand} */ - public listCachePolicies( + listCachePolicies( args: ListCachePoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCachePolicies( + listCachePolicies( args: ListCachePoliciesCommandInput, cb: (err: any, data?: ListCachePoliciesCommandOutput) => void ): void; - public listCachePolicies( + listCachePolicies( args: ListCachePoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCachePoliciesCommandOutput) => void ): void; - public listCachePolicies( - args: ListCachePoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCachePoliciesCommandOutput) => void), - cb?: (err: any, data?: ListCachePoliciesCommandOutput) => void - ): Promise | void { - const command = new ListCachePoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists origin access identities.

+ * @see {@link ListCloudFrontOriginAccessIdentitiesCommand} */ - public listCloudFrontOriginAccessIdentities( + listCloudFrontOriginAccessIdentities( args: ListCloudFrontOriginAccessIdentitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCloudFrontOriginAccessIdentities( + listCloudFrontOriginAccessIdentities( args: ListCloudFrontOriginAccessIdentitiesCommandInput, cb: (err: any, data?: ListCloudFrontOriginAccessIdentitiesCommandOutput) => void ): void; - public listCloudFrontOriginAccessIdentities( + listCloudFrontOriginAccessIdentities( args: ListCloudFrontOriginAccessIdentitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCloudFrontOriginAccessIdentitiesCommandOutput) => void ): void; - public listCloudFrontOriginAccessIdentities( - args: ListCloudFrontOriginAccessIdentitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCloudFrontOriginAccessIdentitiesCommandOutput) => void), - cb?: (err: any, data?: ListCloudFrontOriginAccessIdentitiesCommandOutput) => void - ): Promise | void { - const command = new ListCloudFrontOriginAccessIdentitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or - * overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services - * accounts for each conflicting alias. In the returned list, the distribution and account - * IDs are partially hidden, which allows you to identify the distributions and accounts - * that you own, but helps to protect the information of ones that you don't own.

- *

Use this operation to find aliases that are in use in CloudFront that conflict or overlap - * with the provided alias. For example, if you provide www.example.com as - * input, the returned list can include www.example.com and the overlapping - * wildcard alternate domain name (*.example.com), if they exist. If you - * provide *.example.com as input, the returned list can include - * *.example.com and any alternate domain names covered by that wildcard - * (for example, www.example.com, test.example.com, - * dev.example.com, and so on), if they exist.

- *

To list conflicting aliases, you provide the alias to search and the ID of a - * distribution in your account that has an attached SSL/TLS certificate that includes the - * provided alias. For more information, including how to set up the distribution and - * certificate, see Moving an alternate domain name to a different - * distribution in the Amazon CloudFront Developer Guide.

- *

You can optionally specify the maximum number of items to receive in the response. If - * the total number of items in the list exceeds the maximum that you specify, or the - * default maximum, the response is paginated. To get the next page of items, send a - * subsequent request that specifies the NextMarker value from the current - * response as the Marker value in the subsequent request.

+ * @see {@link ListConflictingAliasesCommand} */ - public listConflictingAliases( + listConflictingAliases( args: ListConflictingAliasesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConflictingAliases( + listConflictingAliases( args: ListConflictingAliasesCommandInput, cb: (err: any, data?: ListConflictingAliasesCommandOutput) => void ): void; - public listConflictingAliases( + listConflictingAliases( args: ListConflictingAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConflictingAliasesCommandOutput) => void ): void; - public listConflictingAliases( - args: ListConflictingAliasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConflictingAliasesCommandOutput) => void), - cb?: (err: any, data?: ListConflictingAliasesCommandOutput) => void - ): Promise | void { - const command = new ListConflictingAliasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of the continuous deployment policies in your Amazon Web Services account.

- *

You can optionally specify the maximum number of items to receive in the response. If - * the total number of items in the list exceeds the maximum that you specify, or the - * default maximum, the response is paginated. To get the next page of items, send a - * subsequent request that specifies the NextMarker value from the current - * response as the Marker value in the subsequent request.

+ * @see {@link ListContinuousDeploymentPoliciesCommand} */ - public listContinuousDeploymentPolicies( + listContinuousDeploymentPolicies( args: ListContinuousDeploymentPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listContinuousDeploymentPolicies( + listContinuousDeploymentPolicies( args: ListContinuousDeploymentPoliciesCommandInput, cb: (err: any, data?: ListContinuousDeploymentPoliciesCommandOutput) => void ): void; - public listContinuousDeploymentPolicies( + listContinuousDeploymentPolicies( args: ListContinuousDeploymentPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListContinuousDeploymentPoliciesCommandOutput) => void ): void; - public listContinuousDeploymentPolicies( - args: ListContinuousDeploymentPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListContinuousDeploymentPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListContinuousDeploymentPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListContinuousDeploymentPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List CloudFront distributions.

+ * @see {@link ListDistributionsCommand} */ - public listDistributions( + listDistributions( args: ListDistributionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDistributions( + listDistributions( args: ListDistributionsCommandInput, cb: (err: any, data?: ListDistributionsCommandOutput) => void ): void; - public listDistributions( + listDistributions( args: ListDistributionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDistributionsCommandOutput) => void ): void; - public listDistributions( - args: ListDistributionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDistributionsCommandOutput) => void), - cb?: (err: any, data?: ListDistributionsCommandOutput) => void - ): Promise | void { - const command = new ListDistributionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of distribution IDs for distributions that have a cache behavior that's - * associated with the specified cache policy.

- *

You can optionally specify the maximum number of items to receive in the response. If - * the total number of items in the list exceeds the maximum that you specify, or the - * default maximum, the response is paginated. To get the next page of items, send a - * subsequent request that specifies the NextMarker value from the current - * response as the Marker value in the subsequent request.

+ * @see {@link ListDistributionsByCachePolicyIdCommand} */ - public listDistributionsByCachePolicyId( + listDistributionsByCachePolicyId( args: ListDistributionsByCachePolicyIdCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDistributionsByCachePolicyId( + listDistributionsByCachePolicyId( args: ListDistributionsByCachePolicyIdCommandInput, cb: (err: any, data?: ListDistributionsByCachePolicyIdCommandOutput) => void ): void; - public listDistributionsByCachePolicyId( + listDistributionsByCachePolicyId( args: ListDistributionsByCachePolicyIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDistributionsByCachePolicyIdCommandOutput) => void ): void; - public listDistributionsByCachePolicyId( - args: ListDistributionsByCachePolicyIdCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDistributionsByCachePolicyIdCommandOutput) => void), - cb?: (err: any, data?: ListDistributionsByCachePolicyIdCommandOutput) => void - ): Promise | void { - const command = new ListDistributionsByCachePolicyIdCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of distribution IDs for distributions that have a cache behavior that - * references the specified key group.

- *

You can optionally specify the maximum number of items to receive in the response. If - * the total number of items in the list exceeds the maximum that you specify, or the - * default maximum, the response is paginated. To get the next page of items, send a - * subsequent request that specifies the NextMarker value from the current - * response as the Marker value in the subsequent request.

+ * @see {@link ListDistributionsByKeyGroupCommand} */ - public listDistributionsByKeyGroup( + listDistributionsByKeyGroup( args: ListDistributionsByKeyGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDistributionsByKeyGroup( + listDistributionsByKeyGroup( args: ListDistributionsByKeyGroupCommandInput, cb: (err: any, data?: ListDistributionsByKeyGroupCommandOutput) => void ): void; - public listDistributionsByKeyGroup( + listDistributionsByKeyGroup( args: ListDistributionsByKeyGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDistributionsByKeyGroupCommandOutput) => void ): void; - public listDistributionsByKeyGroup( - args: ListDistributionsByKeyGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDistributionsByKeyGroupCommandOutput) => void), - cb?: (err: any, data?: ListDistributionsByKeyGroupCommandOutput) => void - ): Promise | void { - const command = new ListDistributionsByKeyGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of distribution IDs for distributions that have a cache behavior that's - * associated with the specified origin request policy.

- *

You can optionally specify the maximum number of items to receive in the response. If - * the total number of items in the list exceeds the maximum that you specify, or the - * default maximum, the response is paginated. To get the next page of items, send a - * subsequent request that specifies the NextMarker value from the current - * response as the Marker value in the subsequent request.

+ * @see {@link ListDistributionsByOriginRequestPolicyIdCommand} */ - public listDistributionsByOriginRequestPolicyId( + listDistributionsByOriginRequestPolicyId( args: ListDistributionsByOriginRequestPolicyIdCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDistributionsByOriginRequestPolicyId( + listDistributionsByOriginRequestPolicyId( args: ListDistributionsByOriginRequestPolicyIdCommandInput, cb: (err: any, data?: ListDistributionsByOriginRequestPolicyIdCommandOutput) => void ): void; - public listDistributionsByOriginRequestPolicyId( + listDistributionsByOriginRequestPolicyId( args: ListDistributionsByOriginRequestPolicyIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDistributionsByOriginRequestPolicyIdCommandOutput) => void ): void; - public listDistributionsByOriginRequestPolicyId( - args: ListDistributionsByOriginRequestPolicyIdCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListDistributionsByOriginRequestPolicyIdCommandOutput) => void), - cb?: (err: any, data?: ListDistributionsByOriginRequestPolicyIdCommandOutput) => void - ): Promise | void { - const command = new ListDistributionsByOriginRequestPolicyIdCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of distributions that have a cache behavior that's associated with the - * specified real-time log configuration.

- *

You can specify the real-time log configuration by its name or its Amazon Resource - * Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to - * identify the real-time log configuration to list distributions for.

- *

You can optionally specify the maximum number of items to receive in the response. If - * the total number of items in the list exceeds the maximum that you specify, or the - * default maximum, the response is paginated. To get the next page of items, send a - * subsequent request that specifies the NextMarker value from the current - * response as the Marker value in the subsequent request.

+ * @see {@link ListDistributionsByRealtimeLogConfigCommand} */ - public listDistributionsByRealtimeLogConfig( + listDistributionsByRealtimeLogConfig( args: ListDistributionsByRealtimeLogConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDistributionsByRealtimeLogConfig( + listDistributionsByRealtimeLogConfig( args: ListDistributionsByRealtimeLogConfigCommandInput, cb: (err: any, data?: ListDistributionsByRealtimeLogConfigCommandOutput) => void ): void; - public listDistributionsByRealtimeLogConfig( + listDistributionsByRealtimeLogConfig( args: ListDistributionsByRealtimeLogConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDistributionsByRealtimeLogConfigCommandOutput) => void ): void; - public listDistributionsByRealtimeLogConfig( - args: ListDistributionsByRealtimeLogConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDistributionsByRealtimeLogConfigCommandOutput) => void), - cb?: (err: any, data?: ListDistributionsByRealtimeLogConfigCommandOutput) => void - ): Promise | void { - const command = new ListDistributionsByRealtimeLogConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of distribution IDs for distributions that have a cache behavior that's - * associated with the specified response headers policy.

- *

You can optionally specify the maximum number of items to receive in the response. If - * the total number of items in the list exceeds the maximum that you specify, or the - * default maximum, the response is paginated. To get the next page of items, send a - * subsequent request that specifies the NextMarker value from the current - * response as the Marker value in the subsequent request.

+ * @see {@link ListDistributionsByResponseHeadersPolicyIdCommand} */ - public listDistributionsByResponseHeadersPolicyId( + listDistributionsByResponseHeadersPolicyId( args: ListDistributionsByResponseHeadersPolicyIdCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDistributionsByResponseHeadersPolicyId( + listDistributionsByResponseHeadersPolicyId( args: ListDistributionsByResponseHeadersPolicyIdCommandInput, cb: (err: any, data?: ListDistributionsByResponseHeadersPolicyIdCommandOutput) => void ): void; - public listDistributionsByResponseHeadersPolicyId( + listDistributionsByResponseHeadersPolicyId( args: ListDistributionsByResponseHeadersPolicyIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDistributionsByResponseHeadersPolicyIdCommandOutput) => void ): void; - public listDistributionsByResponseHeadersPolicyId( - args: ListDistributionsByResponseHeadersPolicyIdCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListDistributionsByResponseHeadersPolicyIdCommandOutput) => void), - cb?: (err: any, data?: ListDistributionsByResponseHeadersPolicyIdCommandOutput) => void - ): Promise | void { - const command = new ListDistributionsByResponseHeadersPolicyIdCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the distributions that are associated with a specified WAF web ACL.

+ * @see {@link ListDistributionsByWebACLIdCommand} */ - public listDistributionsByWebACLId( + listDistributionsByWebACLId( args: ListDistributionsByWebACLIdCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDistributionsByWebACLId( + listDistributionsByWebACLId( args: ListDistributionsByWebACLIdCommandInput, cb: (err: any, data?: ListDistributionsByWebACLIdCommandOutput) => void ): void; - public listDistributionsByWebACLId( + listDistributionsByWebACLId( args: ListDistributionsByWebACLIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDistributionsByWebACLIdCommandOutput) => void ): void; - public listDistributionsByWebACLId( - args: ListDistributionsByWebACLIdCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDistributionsByWebACLIdCommandOutput) => void), - cb?: (err: any, data?: ListDistributionsByWebACLIdCommandOutput) => void - ): Promise | void { - const command = new ListDistributionsByWebACLIdCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all field-level encryption configurations that have been created in CloudFront for this - * account.

+ * @see {@link ListFieldLevelEncryptionConfigsCommand} */ - public listFieldLevelEncryptionConfigs( + listFieldLevelEncryptionConfigs( args: ListFieldLevelEncryptionConfigsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFieldLevelEncryptionConfigs( + listFieldLevelEncryptionConfigs( args: ListFieldLevelEncryptionConfigsCommandInput, cb: (err: any, data?: ListFieldLevelEncryptionConfigsCommandOutput) => void ): void; - public listFieldLevelEncryptionConfigs( + listFieldLevelEncryptionConfigs( args: ListFieldLevelEncryptionConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFieldLevelEncryptionConfigsCommandOutput) => void ): void; - public listFieldLevelEncryptionConfigs( - args: ListFieldLevelEncryptionConfigsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFieldLevelEncryptionConfigsCommandOutput) => void), - cb?: (err: any, data?: ListFieldLevelEncryptionConfigsCommandOutput) => void - ): Promise | void { - const command = new ListFieldLevelEncryptionConfigsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Request a list of field-level encryption profiles that have been created in CloudFront for - * this account.

+ * @see {@link ListFieldLevelEncryptionProfilesCommand} */ - public listFieldLevelEncryptionProfiles( + listFieldLevelEncryptionProfiles( args: ListFieldLevelEncryptionProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFieldLevelEncryptionProfiles( + listFieldLevelEncryptionProfiles( args: ListFieldLevelEncryptionProfilesCommandInput, cb: (err: any, data?: ListFieldLevelEncryptionProfilesCommandOutput) => void ): void; - public listFieldLevelEncryptionProfiles( + listFieldLevelEncryptionProfiles( args: ListFieldLevelEncryptionProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFieldLevelEncryptionProfilesCommandOutput) => void ): void; - public listFieldLevelEncryptionProfiles( - args: ListFieldLevelEncryptionProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFieldLevelEncryptionProfilesCommandOutput) => void), - cb?: (err: any, data?: ListFieldLevelEncryptionProfilesCommandOutput) => void - ): Promise | void { - const command = new ListFieldLevelEncryptionProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of all CloudFront functions in your Amazon Web Services account.

- *

You can optionally apply a filter to return only the functions that are in the - * specified stage, either DEVELOPMENT or LIVE.

- *

You can optionally specify the maximum number of items to receive in the response. If - * the total number of items in the list exceeds the maximum that you specify, or the - * default maximum, the response is paginated. To get the next page of items, send a - * subsequent request that specifies the NextMarker value from the current - * response as the Marker value in the subsequent request.

+ * @see {@link ListFunctionsCommand} */ - public listFunctions( - args: ListFunctionsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listFunctions( - args: ListFunctionsCommandInput, - cb: (err: any, data?: ListFunctionsCommandOutput) => void - ): void; - public listFunctions( + listFunctions(args: ListFunctionsCommandInput, options?: __HttpHandlerOptions): Promise; + listFunctions(args: ListFunctionsCommandInput, cb: (err: any, data?: ListFunctionsCommandOutput) => void): void; + listFunctions( args: ListFunctionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFunctionsCommandOutput) => void ): void; - public listFunctions( - args: ListFunctionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFunctionsCommandOutput) => void), - cb?: (err: any, data?: ListFunctionsCommandOutput) => void - ): Promise | void { - const command = new ListFunctionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists invalidation batches.

+ * @see {@link ListInvalidationsCommand} */ - public listInvalidations( + listInvalidations( args: ListInvalidationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInvalidations( + listInvalidations( args: ListInvalidationsCommandInput, cb: (err: any, data?: ListInvalidationsCommandOutput) => void ): void; - public listInvalidations( + listInvalidations( args: ListInvalidationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInvalidationsCommandOutput) => void ): void; - public listInvalidations( - args: ListInvalidationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInvalidationsCommandOutput) => void), - cb?: (err: any, data?: ListInvalidationsCommandOutput) => void - ): Promise | void { - const command = new ListInvalidationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of key groups.

- *

You can optionally specify the maximum number of items to receive in the response. If - * the total number of items in the list exceeds the maximum that you specify, or the - * default maximum, the response is paginated. To get the next page of items, send a - * subsequent request that specifies the NextMarker value from the current - * response as the Marker value in the subsequent request.

+ * @see {@link ListKeyGroupsCommand} */ - public listKeyGroups( - args: ListKeyGroupsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listKeyGroups( - args: ListKeyGroupsCommandInput, - cb: (err: any, data?: ListKeyGroupsCommandOutput) => void - ): void; - public listKeyGroups( + listKeyGroups(args: ListKeyGroupsCommandInput, options?: __HttpHandlerOptions): Promise; + listKeyGroups(args: ListKeyGroupsCommandInput, cb: (err: any, data?: ListKeyGroupsCommandOutput) => void): void; + listKeyGroups( args: ListKeyGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKeyGroupsCommandOutput) => void ): void; - public listKeyGroups( - args: ListKeyGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListKeyGroupsCommandOutput) => void), - cb?: (err: any, data?: ListKeyGroupsCommandOutput) => void - ): Promise | void { - const command = new ListKeyGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the list of CloudFront origin access controls in this Amazon Web Services account.

- *

You can optionally specify the maximum number of items to receive in the response. If - * the total number of items in the list exceeds the maximum that you specify, or the - * default maximum, the response is paginated. To get the next page of items, send another - * request that specifies the NextMarker value from the current response as - * the Marker value in the next request.

+ * @see {@link ListOriginAccessControlsCommand} */ - public listOriginAccessControls( + listOriginAccessControls( args: ListOriginAccessControlsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOriginAccessControls( + listOriginAccessControls( args: ListOriginAccessControlsCommandInput, cb: (err: any, data?: ListOriginAccessControlsCommandOutput) => void ): void; - public listOriginAccessControls( + listOriginAccessControls( args: ListOriginAccessControlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOriginAccessControlsCommandOutput) => void ): void; - public listOriginAccessControls( - args: ListOriginAccessControlsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOriginAccessControlsCommandOutput) => void), - cb?: (err: any, data?: ListOriginAccessControlsCommandOutput) => void - ): Promise | void { - const command = new ListOriginAccessControlsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of origin request policies.

- *

You can optionally apply a filter to return only the managed policies created by - * Amazon Web Services, or only the custom policies created in your Amazon Web Services account.

- *

You can optionally specify the maximum number of items to receive in the response. If - * the total number of items in the list exceeds the maximum that you specify, or the - * default maximum, the response is paginated. To get the next page of items, send a - * subsequent request that specifies the NextMarker value from the current - * response as the Marker value in the subsequent request.

+ * @see {@link ListOriginRequestPoliciesCommand} */ - public listOriginRequestPolicies( + listOriginRequestPolicies( args: ListOriginRequestPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOriginRequestPolicies( + listOriginRequestPolicies( args: ListOriginRequestPoliciesCommandInput, cb: (err: any, data?: ListOriginRequestPoliciesCommandOutput) => void ): void; - public listOriginRequestPolicies( + listOriginRequestPolicies( args: ListOriginRequestPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOriginRequestPoliciesCommandOutput) => void ): void; - public listOriginRequestPolicies( - args: ListOriginRequestPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOriginRequestPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListOriginRequestPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListOriginRequestPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all public keys that have been added to CloudFront for this account.

+ * @see {@link ListPublicKeysCommand} */ - public listPublicKeys( + listPublicKeys( args: ListPublicKeysCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPublicKeys( - args: ListPublicKeysCommandInput, - cb: (err: any, data?: ListPublicKeysCommandOutput) => void - ): void; - public listPublicKeys( + listPublicKeys(args: ListPublicKeysCommandInput, cb: (err: any, data?: ListPublicKeysCommandOutput) => void): void; + listPublicKeys( args: ListPublicKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPublicKeysCommandOutput) => void ): void; - public listPublicKeys( - args: ListPublicKeysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPublicKeysCommandOutput) => void), - cb?: (err: any, data?: ListPublicKeysCommandOutput) => void - ): Promise | void { - const command = new ListPublicKeysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of real-time log configurations.

- *

You can optionally specify the maximum number of items to receive in the response. If - * the total number of items in the list exceeds the maximum that you specify, or the - * default maximum, the response is paginated. To get the next page of items, send a - * subsequent request that specifies the NextMarker value from the current - * response as the Marker value in the subsequent request.

+ * @see {@link ListRealtimeLogConfigsCommand} */ - public listRealtimeLogConfigs( + listRealtimeLogConfigs( args: ListRealtimeLogConfigsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRealtimeLogConfigs( + listRealtimeLogConfigs( args: ListRealtimeLogConfigsCommandInput, cb: (err: any, data?: ListRealtimeLogConfigsCommandOutput) => void ): void; - public listRealtimeLogConfigs( + listRealtimeLogConfigs( args: ListRealtimeLogConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRealtimeLogConfigsCommandOutput) => void ): void; - public listRealtimeLogConfigs( - args: ListRealtimeLogConfigsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRealtimeLogConfigsCommandOutput) => void), - cb?: (err: any, data?: ListRealtimeLogConfigsCommandOutput) => void - ): Promise | void { - const command = new ListRealtimeLogConfigsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of response headers policies.

- *

You can optionally apply a filter to get only the managed policies created by Amazon Web Services, - * or only the custom policies created in your Amazon Web Services account.

- *

You can optionally specify the maximum number of items to receive in the response. If - * the total number of items in the list exceeds the maximum that you specify, or the - * default maximum, the response is paginated. To get the next page of items, send a - * subsequent request that specifies the NextMarker value from the current - * response as the Marker value in the subsequent request.

+ * @see {@link ListResponseHeadersPoliciesCommand} */ - public listResponseHeadersPolicies( + listResponseHeadersPolicies( args: ListResponseHeadersPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResponseHeadersPolicies( + listResponseHeadersPolicies( args: ListResponseHeadersPoliciesCommandInput, cb: (err: any, data?: ListResponseHeadersPoliciesCommandOutput) => void ): void; - public listResponseHeadersPolicies( + listResponseHeadersPolicies( args: ListResponseHeadersPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResponseHeadersPoliciesCommandOutput) => void ): void; - public listResponseHeadersPolicies( - args: ListResponseHeadersPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResponseHeadersPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListResponseHeadersPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListResponseHeadersPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List streaming distributions.

+ * @see {@link ListStreamingDistributionsCommand} */ - public listStreamingDistributions( + listStreamingDistributions( args: ListStreamingDistributionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStreamingDistributions( + listStreamingDistributions( args: ListStreamingDistributionsCommandInput, cb: (err: any, data?: ListStreamingDistributionsCommandOutput) => void ): void; - public listStreamingDistributions( + listStreamingDistributions( args: ListStreamingDistributionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamingDistributionsCommandOutput) => void ): void; - public listStreamingDistributions( - args: ListStreamingDistributionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStreamingDistributionsCommandOutput) => void), - cb?: (err: any, data?: ListStreamingDistributionsCommandOutput) => void - ): Promise | void { - const command = new ListStreamingDistributionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List tags for a CloudFront resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Publishes a CloudFront function by copying the function code from the - * DEVELOPMENT stage to LIVE. This automatically updates all - * cache behaviors that are using this function to use the newly published copy in the - * LIVE stage.

- *

When a function is published to the LIVE stage, you can attach the - * function to a distribution's cache behavior, using the function's Amazon Resource Name - * (ARN).

- *

To publish a function, you must provide the function's name and version - * (ETag value). To get these values, you can use - * ListFunctions and DescribeFunction.

+ * @see {@link PublishFunctionCommand} */ - public publishFunction( + publishFunction( args: PublishFunctionCommandInput, options?: __HttpHandlerOptions ): Promise; - public publishFunction( - args: PublishFunctionCommandInput, - cb: (err: any, data?: PublishFunctionCommandOutput) => void - ): void; - public publishFunction( + publishFunction(args: PublishFunctionCommandInput, cb: (err: any, data?: PublishFunctionCommandOutput) => void): void; + publishFunction( args: PublishFunctionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishFunctionCommandOutput) => void ): void; - public publishFunction( - args: PublishFunctionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PublishFunctionCommandOutput) => void), - cb?: (err: any, data?: PublishFunctionCommandOutput) => void - ): Promise | void { - const command = new PublishFunctionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Add tags to a CloudFront resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Tests a CloudFront function.

- *

To test a function, you provide an event object that represents - * an HTTP request or response that your CloudFront distribution could receive in production. - * CloudFront runs the function, passing it the event object that you provided, and returns the - * function's result (the modified event object) in the response. The response also - * contains function logs and error messages, if any exist. For more information about - * testing functions, see Testing functions in the Amazon CloudFront Developer Guide.

- *

To test a function, you provide the function's name and version (ETag - * value) along with the event object. To get the function's name and version, you can use - * ListFunctions and DescribeFunction.

+ * @see {@link TestFunctionCommand} */ - public testFunction( - args: TestFunctionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public testFunction(args: TestFunctionCommandInput, cb: (err: any, data?: TestFunctionCommandOutput) => void): void; - public testFunction( + testFunction(args: TestFunctionCommandInput, options?: __HttpHandlerOptions): Promise; + testFunction(args: TestFunctionCommandInput, cb: (err: any, data?: TestFunctionCommandOutput) => void): void; + testFunction( args: TestFunctionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestFunctionCommandOutput) => void ): void; - public testFunction( - args: TestFunctionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestFunctionCommandOutput) => void), - cb?: (err: any, data?: TestFunctionCommandOutput) => void - ): Promise | void { - const command = new TestFunctionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Remove tags from a CloudFront resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a cache policy configuration.

- *

When you update a cache policy configuration, all the fields are updated with the - * values provided in the request. You cannot update some fields independent of others. To - * update a cache policy configuration:

- *
    - *
  1. - *

    Use GetCachePolicyConfig to get the current configuration.

    - *
  2. - *
  3. - *

    Locally modify the fields in the cache policy configuration that you want to - * update.

    - *
  4. - *
  5. - *

    Call UpdateCachePolicy by providing the entire cache policy - * configuration, including the fields that you modified and those that you - * didn't.

    - *
  6. - *
+ * @see {@link UpdateCachePolicyCommand} */ - public updateCachePolicy( + updateCachePolicy( args: UpdateCachePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCachePolicy( + updateCachePolicy( args: UpdateCachePolicyCommandInput, cb: (err: any, data?: UpdateCachePolicyCommandOutput) => void ): void; - public updateCachePolicy( + updateCachePolicy( args: UpdateCachePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCachePolicyCommandOutput) => void ): void; - public updateCachePolicy( - args: UpdateCachePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCachePolicyCommandOutput) => void), - cb?: (err: any, data?: UpdateCachePolicyCommandOutput) => void - ): Promise | void { - const command = new UpdateCachePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update an origin access identity.

+ * @see {@link UpdateCloudFrontOriginAccessIdentityCommand} */ - public updateCloudFrontOriginAccessIdentity( + updateCloudFrontOriginAccessIdentity( args: UpdateCloudFrontOriginAccessIdentityCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCloudFrontOriginAccessIdentity( + updateCloudFrontOriginAccessIdentity( args: UpdateCloudFrontOriginAccessIdentityCommandInput, cb: (err: any, data?: UpdateCloudFrontOriginAccessIdentityCommandOutput) => void ): void; - public updateCloudFrontOriginAccessIdentity( + updateCloudFrontOriginAccessIdentity( args: UpdateCloudFrontOriginAccessIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCloudFrontOriginAccessIdentityCommandOutput) => void ): void; - public updateCloudFrontOriginAccessIdentity( - args: UpdateCloudFrontOriginAccessIdentityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCloudFrontOriginAccessIdentityCommandOutput) => void), - cb?: (err: any, data?: UpdateCloudFrontOriginAccessIdentityCommandOutput) => void - ): Promise | void { - const command = new UpdateCloudFrontOriginAccessIdentityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a continuous deployment policy. You can update a continuous deployment policy - * to enable or disable it, to change the percentage of traffic that it sends to the - * staging distribution, or to change the staging distribution that it sends traffic - * to.

- *

When you update a continuous deployment policy configuration, all the fields are - * updated with the values that are provided in the request. You cannot update some fields - * independent of others. To update a continuous deployment policy configuration:

- *
    - *
  1. - *

    Use GetContinuousDeploymentPolicyConfig to get the current - * configuration.

    - *
  2. - *
  3. - *

    Locally modify the fields in the continuous deployment policy configuration - * that you want to update.

    - *
  4. - *
  5. - *

    Use UpdateContinuousDeploymentPolicy, providing the entire - * continuous deployment policy configuration, including the fields that you - * modified and those that you didn't.

    - *
  6. - *
+ * @see {@link UpdateContinuousDeploymentPolicyCommand} */ - public updateContinuousDeploymentPolicy( + updateContinuousDeploymentPolicy( args: UpdateContinuousDeploymentPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateContinuousDeploymentPolicy( + updateContinuousDeploymentPolicy( args: UpdateContinuousDeploymentPolicyCommandInput, cb: (err: any, data?: UpdateContinuousDeploymentPolicyCommandOutput) => void ): void; - public updateContinuousDeploymentPolicy( + updateContinuousDeploymentPolicy( args: UpdateContinuousDeploymentPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContinuousDeploymentPolicyCommandOutput) => void ): void; - public updateContinuousDeploymentPolicy( - args: UpdateContinuousDeploymentPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateContinuousDeploymentPolicyCommandOutput) => void), - cb?: (err: any, data?: UpdateContinuousDeploymentPolicyCommandOutput) => void - ): Promise | void { - const command = new UpdateContinuousDeploymentPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the configuration for a CloudFront distribution.

- *

The update process includes getting the current distribution configuration, updating - * it to make your changes, and then submitting an UpdateDistribution request - * to make the updates.

- *

- * To update a web distribution using the CloudFront - * API - *

- *
    - *
  1. - *

    Use GetDistributionConfig to get the current configuration, - * including the version identifier (ETag).

    - *
  2. - *
  3. - *

    Update the distribution configuration that was returned in the response. Note - * the following important requirements and restrictions:

    - *
      - *
    • - *

      You must rename the ETag field to IfMatch, - * leaving the value unchanged. (Set the value of IfMatch to - * the value of ETag, then remove the ETag - * field.)

      - *
    • - *
    • - *

      You can't change the value of CallerReference.

      - *
    • - *
    - *
  4. - *
  5. - *

    Submit an UpdateDistribution request, providing the distribution - * configuration. The new configuration replaces the existing configuration. The - * values that you specify in an UpdateDistribution request are not - * merged into your existing configuration. Make sure to include all fields: the - * ones that you modified and also the ones that you didn't.

    - *
  6. - *
+ * @see {@link UpdateDistributionCommand} */ - public updateDistribution( + updateDistribution( args: UpdateDistributionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDistribution( + updateDistribution( args: UpdateDistributionCommandInput, cb: (err: any, data?: UpdateDistributionCommandOutput) => void ): void; - public updateDistribution( + updateDistribution( args: UpdateDistributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDistributionCommandOutput) => void ): void; - public updateDistribution( - args: UpdateDistributionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDistributionCommandOutput) => void), - cb?: (err: any, data?: UpdateDistributionCommandOutput) => void - ): Promise | void { - const command = new UpdateDistributionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Copies the staging distribution's configuration to its corresponding primary - * distribution. The primary distribution retains its Aliases (also known as - * alternate domain names or CNAMEs) and ContinuousDeploymentPolicyId value, - * but otherwise its configuration is overwritten to match the staging distribution.

- *

You can use this operation in a continuous deployment workflow after you have tested - * configuration changes on the staging distribution. After using a continuous deployment - * policy to move a portion of your domain name's traffic to the staging distribution and - * verifying that it works as intended, you can use this operation to copy the staging - * distribution's configuration to the primary distribution. This action will disable the - * continuous deployment policy and move your domain's traffic back to the primary distribution.

+ * @see {@link UpdateDistributionWithStagingConfigCommand} */ - public updateDistributionWithStagingConfig( + updateDistributionWithStagingConfig( args: UpdateDistributionWithStagingConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDistributionWithStagingConfig( + updateDistributionWithStagingConfig( args: UpdateDistributionWithStagingConfigCommandInput, cb: (err: any, data?: UpdateDistributionWithStagingConfigCommandOutput) => void ): void; - public updateDistributionWithStagingConfig( + updateDistributionWithStagingConfig( args: UpdateDistributionWithStagingConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDistributionWithStagingConfigCommandOutput) => void ): void; - public updateDistributionWithStagingConfig( - args: UpdateDistributionWithStagingConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDistributionWithStagingConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateDistributionWithStagingConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateDistributionWithStagingConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update a field-level encryption configuration.

+ * @see {@link UpdateFieldLevelEncryptionConfigCommand} */ - public updateFieldLevelEncryptionConfig( + updateFieldLevelEncryptionConfig( args: UpdateFieldLevelEncryptionConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFieldLevelEncryptionConfig( + updateFieldLevelEncryptionConfig( args: UpdateFieldLevelEncryptionConfigCommandInput, cb: (err: any, data?: UpdateFieldLevelEncryptionConfigCommandOutput) => void ): void; - public updateFieldLevelEncryptionConfig( + updateFieldLevelEncryptionConfig( args: UpdateFieldLevelEncryptionConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFieldLevelEncryptionConfigCommandOutput) => void ): void; - public updateFieldLevelEncryptionConfig( - args: UpdateFieldLevelEncryptionConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFieldLevelEncryptionConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateFieldLevelEncryptionConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateFieldLevelEncryptionConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update a field-level encryption profile.

+ * @see {@link UpdateFieldLevelEncryptionProfileCommand} */ - public updateFieldLevelEncryptionProfile( + updateFieldLevelEncryptionProfile( args: UpdateFieldLevelEncryptionProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFieldLevelEncryptionProfile( + updateFieldLevelEncryptionProfile( args: UpdateFieldLevelEncryptionProfileCommandInput, cb: (err: any, data?: UpdateFieldLevelEncryptionProfileCommandOutput) => void ): void; - public updateFieldLevelEncryptionProfile( + updateFieldLevelEncryptionProfile( args: UpdateFieldLevelEncryptionProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFieldLevelEncryptionProfileCommandOutput) => void ): void; - public updateFieldLevelEncryptionProfile( - args: UpdateFieldLevelEncryptionProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFieldLevelEncryptionProfileCommandOutput) => void), - cb?: (err: any, data?: UpdateFieldLevelEncryptionProfileCommandOutput) => void - ): Promise | void { - const command = new UpdateFieldLevelEncryptionProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a CloudFront function.

- *

You can update a function's code or the comment that describes the function. You - * cannot update a function's name.

- *

To update a function, you provide the function's name and version (ETag - * value) along with the updated function code. To get the name and version, you can use - * ListFunctions and DescribeFunction.

+ * @see {@link UpdateFunctionCommand} */ - public updateFunction( + updateFunction( args: UpdateFunctionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFunction( - args: UpdateFunctionCommandInput, - cb: (err: any, data?: UpdateFunctionCommandOutput) => void - ): void; - public updateFunction( + updateFunction(args: UpdateFunctionCommandInput, cb: (err: any, data?: UpdateFunctionCommandOutput) => void): void; + updateFunction( args: UpdateFunctionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFunctionCommandOutput) => void ): void; - public updateFunction( - args: UpdateFunctionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFunctionCommandOutput) => void), - cb?: (err: any, data?: UpdateFunctionCommandOutput) => void - ): Promise | void { - const command = new UpdateFunctionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a key group.

- *

When you update a key group, all the fields are updated with the values provided in - * the request. You cannot update some fields independent of others. To update a key - * group:

- *
    - *
  1. - *

    Get the current key group with GetKeyGroup or - * GetKeyGroupConfig.

    - *
  2. - *
  3. - *

    Locally modify the fields in the key group that you want to update. For - * example, add or remove public key IDs.

    - *
  4. - *
  5. - *

    Call UpdateKeyGroup with the entire key group object, including - * the fields that you modified and those that you didn't.

    - *
  6. - *
+ * @see {@link UpdateKeyGroupCommand} */ - public updateKeyGroup( + updateKeyGroup( args: UpdateKeyGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateKeyGroup( - args: UpdateKeyGroupCommandInput, - cb: (err: any, data?: UpdateKeyGroupCommandOutput) => void - ): void; - public updateKeyGroup( + updateKeyGroup(args: UpdateKeyGroupCommandInput, cb: (err: any, data?: UpdateKeyGroupCommandOutput) => void): void; + updateKeyGroup( args: UpdateKeyGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateKeyGroupCommandOutput) => void ): void; - public updateKeyGroup( - args: UpdateKeyGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateKeyGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateKeyGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateKeyGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a CloudFront origin access control.

+ * @see {@link UpdateOriginAccessControlCommand} */ - public updateOriginAccessControl( + updateOriginAccessControl( args: UpdateOriginAccessControlCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateOriginAccessControl( + updateOriginAccessControl( args: UpdateOriginAccessControlCommandInput, cb: (err: any, data?: UpdateOriginAccessControlCommandOutput) => void ): void; - public updateOriginAccessControl( + updateOriginAccessControl( args: UpdateOriginAccessControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateOriginAccessControlCommandOutput) => void ): void; - public updateOriginAccessControl( - args: UpdateOriginAccessControlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateOriginAccessControlCommandOutput) => void), - cb?: (err: any, data?: UpdateOriginAccessControlCommandOutput) => void - ): Promise | void { - const command = new UpdateOriginAccessControlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an origin request policy configuration.

- *

When you update an origin request policy configuration, all the fields are updated - * with the values provided in the request. You cannot update some fields independent of - * others. To update an origin request policy configuration:

- *
    - *
  1. - *

    Use GetOriginRequestPolicyConfig to get the current - * configuration.

    - *
  2. - *
  3. - *

    Locally modify the fields in the origin request policy configuration that you - * want to update.

    - *
  4. - *
  5. - *

    Call UpdateOriginRequestPolicy by providing the entire origin - * request policy configuration, including the fields that you modified and those - * that you didn't.

    - *
  6. - *
+ * @see {@link UpdateOriginRequestPolicyCommand} */ - public updateOriginRequestPolicy( + updateOriginRequestPolicy( args: UpdateOriginRequestPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateOriginRequestPolicy( + updateOriginRequestPolicy( args: UpdateOriginRequestPolicyCommandInput, cb: (err: any, data?: UpdateOriginRequestPolicyCommandOutput) => void ): void; - public updateOriginRequestPolicy( + updateOriginRequestPolicy( args: UpdateOriginRequestPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateOriginRequestPolicyCommandOutput) => void ): void; - public updateOriginRequestPolicy( - args: UpdateOriginRequestPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateOriginRequestPolicyCommandOutput) => void), - cb?: (err: any, data?: UpdateOriginRequestPolicyCommandOutput) => void - ): Promise | void { - const command = new UpdateOriginRequestPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update public key information. Note that the only value you can change is the - * comment.

+ * @see {@link UpdatePublicKeyCommand} */ - public updatePublicKey( + updatePublicKey( args: UpdatePublicKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePublicKey( - args: UpdatePublicKeyCommandInput, - cb: (err: any, data?: UpdatePublicKeyCommandOutput) => void - ): void; - public updatePublicKey( + updatePublicKey(args: UpdatePublicKeyCommandInput, cb: (err: any, data?: UpdatePublicKeyCommandOutput) => void): void; + updatePublicKey( args: UpdatePublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePublicKeyCommandOutput) => void ): void; - public updatePublicKey( - args: UpdatePublicKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePublicKeyCommandOutput) => void), - cb?: (err: any, data?: UpdatePublicKeyCommandOutput) => void - ): Promise | void { - const command = new UpdatePublicKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a real-time log configuration.

- *

When you update a real-time log configuration, all the parameters are updated with the - * values provided in the request. You cannot update some parameters independent of others. - * To update a real-time log configuration:

- *
    - *
  1. - *

    Call GetRealtimeLogConfig to get the current real-time log - * configuration.

    - *
  2. - *
  3. - *

    Locally modify the parameters in the real-time log configuration that you want - * to update.

    - *
  4. - *
  5. - *

    Call this API (UpdateRealtimeLogConfig) by providing the entire - * real-time log configuration, including the parameters that you modified and - * those that you didn't.

    - *
  6. - *
- *

You cannot update a real-time log configuration's Name or - * ARN.

+ * @see {@link UpdateRealtimeLogConfigCommand} */ - public updateRealtimeLogConfig( + updateRealtimeLogConfig( args: UpdateRealtimeLogConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRealtimeLogConfig( + updateRealtimeLogConfig( args: UpdateRealtimeLogConfigCommandInput, cb: (err: any, data?: UpdateRealtimeLogConfigCommandOutput) => void ): void; - public updateRealtimeLogConfig( + updateRealtimeLogConfig( args: UpdateRealtimeLogConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRealtimeLogConfigCommandOutput) => void ): void; - public updateRealtimeLogConfig( - args: UpdateRealtimeLogConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRealtimeLogConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateRealtimeLogConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateRealtimeLogConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a response headers policy.

- *

When you update a response headers policy, the entire policy is replaced. You cannot - * update some policy fields independent of others. To update a response headers policy - * configuration:

- *
    - *
  1. - *

    Use GetResponseHeadersPolicyConfig to get the current policy's - * configuration.

    - *
  2. - *
  3. - *

    Modify the fields in the response headers policy configuration that you want - * to update.

    - *
  4. - *
  5. - *

    Call UpdateResponseHeadersPolicy, providing the entire response - * headers policy configuration, including the fields that you modified and those - * that you didn't.

    - *
  6. - *
+ * @see {@link UpdateResponseHeadersPolicyCommand} */ - public updateResponseHeadersPolicy( + updateResponseHeadersPolicy( args: UpdateResponseHeadersPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateResponseHeadersPolicy( + updateResponseHeadersPolicy( args: UpdateResponseHeadersPolicyCommandInput, cb: (err: any, data?: UpdateResponseHeadersPolicyCommandOutput) => void ): void; - public updateResponseHeadersPolicy( + updateResponseHeadersPolicy( args: UpdateResponseHeadersPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResponseHeadersPolicyCommandOutput) => void ): void; - public updateResponseHeadersPolicy( - args: UpdateResponseHeadersPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResponseHeadersPolicyCommandOutput) => void), - cb?: (err: any, data?: UpdateResponseHeadersPolicyCommandOutput) => void - ): Promise | void { - const command = new UpdateResponseHeadersPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update a streaming distribution.

+ * @see {@link UpdateStreamingDistributionCommand} */ - public updateStreamingDistribution( + updateStreamingDistribution( args: UpdateStreamingDistributionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateStreamingDistribution( + updateStreamingDistribution( args: UpdateStreamingDistributionCommandInput, cb: (err: any, data?: UpdateStreamingDistributionCommandOutput) => void ): void; - public updateStreamingDistribution( + updateStreamingDistribution( args: UpdateStreamingDistributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStreamingDistributionCommandOutput) => void ): void; - public updateStreamingDistribution( - args: UpdateStreamingDistributionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStreamingDistributionCommandOutput) => void), - cb?: (err: any, data?: UpdateStreamingDistributionCommandOutput) => void - ): Promise | void { - const command = new UpdateStreamingDistributionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon CloudFront + *

This is the Amazon CloudFront API Reference. This guide is for developers + * who need detailed information about CloudFront API actions, data types, and errors. For + * detailed information about CloudFront features, see the + * Amazon CloudFront Developer Guide.

+ */ +export class CloudFront extends CloudFrontClient implements CloudFront {} +createAggregatedClient(commands, CloudFront); diff --git a/clients/client-cloudhsm-v2/src/CloudHSMV2.ts b/clients/client-cloudhsm-v2/src/CloudHSMV2.ts index d0cd81b2a5b6..07f749f6ac01 100644 --- a/clients/client-cloudhsm-v2/src/CloudHSMV2.ts +++ b/clients/client-cloudhsm-v2/src/CloudHSMV2.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CloudHSMV2Client } from "./CloudHSMV2Client"; +import { CloudHSMV2Client, CloudHSMV2ClientConfig } from "./CloudHSMV2Client"; import { CopyBackupToRegionCommand, CopyBackupToRegionCommandInput, @@ -62,503 +63,222 @@ import { UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; -/** - * @public - *

For more information about AWS CloudHSM, see AWS CloudHSM and the AWS - * CloudHSM User Guide.

- */ -export class CloudHSMV2 extends CloudHSMV2Client { +const commands = { + CopyBackupToRegionCommand, + CreateClusterCommand, + CreateHsmCommand, + DeleteBackupCommand, + DeleteClusterCommand, + DeleteHsmCommand, + DescribeBackupsCommand, + DescribeClustersCommand, + InitializeClusterCommand, + ListTagsCommand, + ModifyBackupAttributesCommand, + ModifyClusterCommand, + RestoreBackupCommand, + TagResourceCommand, + UntagResourceCommand, +}; + +export interface CloudHSMV2 { /** - * @public - *

Copy an AWS CloudHSM cluster backup to a different region.

+ * @see {@link CopyBackupToRegionCommand} */ - public copyBackupToRegion( + copyBackupToRegion( args: CopyBackupToRegionCommandInput, options?: __HttpHandlerOptions ): Promise; - public copyBackupToRegion( + copyBackupToRegion( args: CopyBackupToRegionCommandInput, cb: (err: any, data?: CopyBackupToRegionCommandOutput) => void ): void; - public copyBackupToRegion( + copyBackupToRegion( args: CopyBackupToRegionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyBackupToRegionCommandOutput) => void ): void; - public copyBackupToRegion( - args: CopyBackupToRegionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopyBackupToRegionCommandOutput) => void), - cb?: (err: any, data?: CopyBackupToRegionCommandOutput) => void - ): Promise | void { - const command = new CopyBackupToRegionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new AWS CloudHSM cluster.

+ * @see {@link CreateClusterCommand} */ - public createCluster( - args: CreateClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createCluster( - args: CreateClusterCommandInput, - cb: (err: any, data?: CreateClusterCommandOutput) => void - ): void; - public createCluster( + createCluster(args: CreateClusterCommandInput, options?: __HttpHandlerOptions): Promise; + createCluster(args: CreateClusterCommandInput, cb: (err: any, data?: CreateClusterCommandOutput) => void): void; + createCluster( args: CreateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterCommandOutput) => void ): void; - public createCluster( - args: CreateClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateClusterCommandOutput) => void), - cb?: (err: any, data?: CreateClusterCommandOutput) => void - ): Promise | void { - const command = new CreateClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new hardware security module (HSM) in the specified AWS CloudHSM - * cluster.

+ * @see {@link CreateHsmCommand} */ - public createHsm(args: CreateHsmCommandInput, options?: __HttpHandlerOptions): Promise; - public createHsm(args: CreateHsmCommandInput, cb: (err: any, data?: CreateHsmCommandOutput) => void): void; - public createHsm( + createHsm(args: CreateHsmCommandInput, options?: __HttpHandlerOptions): Promise; + createHsm(args: CreateHsmCommandInput, cb: (err: any, data?: CreateHsmCommandOutput) => void): void; + createHsm( args: CreateHsmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHsmCommandOutput) => void ): void; - public createHsm( - args: CreateHsmCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateHsmCommandOutput) => void), - cb?: (err: any, data?: CreateHsmCommandOutput) => void - ): Promise | void { - const command = new CreateHsmCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days - * after the DeleteBackup request is made. For more information on restoring a backup, see - * RestoreBackup.

+ * @see {@link DeleteBackupCommand} */ - public deleteBackup( - args: DeleteBackupCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteBackup(args: DeleteBackupCommandInput, cb: (err: any, data?: DeleteBackupCommandOutput) => void): void; - public deleteBackup( + deleteBackup(args: DeleteBackupCommandInput, options?: __HttpHandlerOptions): Promise; + deleteBackup(args: DeleteBackupCommandInput, cb: (err: any, data?: DeleteBackupCommandOutput) => void): void; + deleteBackup( args: DeleteBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackupCommandOutput) => void ): void; - public deleteBackup( - args: DeleteBackupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBackupCommandOutput) => void), - cb?: (err: any, data?: DeleteBackupCommandOutput) => void - ): Promise | void { - const command = new DeleteBackupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must - * delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.

+ * @see {@link DeleteClusterCommand} */ - public deleteCluster( - args: DeleteClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteCluster( - args: DeleteClusterCommandInput, - cb: (err: any, data?: DeleteClusterCommandOutput) => void - ): void; - public deleteCluster( + deleteCluster(args: DeleteClusterCommandInput, options?: __HttpHandlerOptions): Promise; + deleteCluster(args: DeleteClusterCommandInput, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void; + deleteCluster( args: DeleteClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClusterCommandOutput) => void ): void; - public deleteCluster( - args: DeleteClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteClusterCommandOutput) => void), - cb?: (err: any, data?: DeleteClusterCommandOutput) => void - ): Promise | void { - const command = new DeleteClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP - * address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to - * specify only one of these values. To find these values, use DescribeClusters.

+ * @see {@link DeleteHsmCommand} */ - public deleteHsm(args: DeleteHsmCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteHsm(args: DeleteHsmCommandInput, cb: (err: any, data?: DeleteHsmCommandOutput) => void): void; - public deleteHsm( + deleteHsm(args: DeleteHsmCommandInput, options?: __HttpHandlerOptions): Promise; + deleteHsm(args: DeleteHsmCommandInput, cb: (err: any, data?: DeleteHsmCommandOutput) => void): void; + deleteHsm( args: DeleteHsmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHsmCommandOutput) => void ): void; - public deleteHsm( - args: DeleteHsmCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteHsmCommandOutput) => void), - cb?: (err: any, data?: DeleteHsmCommandOutput) => void - ): Promise | void { - const command = new DeleteHsmCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about backups of AWS CloudHSM clusters.

- *

This is a paginated operation, which means that each response might contain only a - * subset of all the backups. When the response contains only a subset of backups, it includes a - * NextToken value. Use this value in a subsequent DescribeBackups - * request to get more backups. When you receive a response with no NextToken (or an - * empty or null value), that means there are no more backups to get.

+ * @see {@link DescribeBackupsCommand} */ - public describeBackups( + describeBackups( args: DescribeBackupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBackups( - args: DescribeBackupsCommandInput, - cb: (err: any, data?: DescribeBackupsCommandOutput) => void - ): void; - public describeBackups( + describeBackups(args: DescribeBackupsCommandInput, cb: (err: any, data?: DescribeBackupsCommandOutput) => void): void; + describeBackups( args: DescribeBackupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBackupsCommandOutput) => void ): void; - public describeBackups( - args: DescribeBackupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBackupsCommandOutput) => void), - cb?: (err: any, data?: DescribeBackupsCommandOutput) => void - ): Promise | void { - const command = new DescribeBackupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about AWS CloudHSM clusters.

- *

This is a paginated operation, which means that each response might contain only a - * subset of all the clusters. When the response contains only a subset of clusters, it includes - * a NextToken value. Use this value in a subsequent DescribeClusters - * request to get more clusters. When you receive a response with no NextToken (or - * an empty or null value), that means there are no more clusters to get.

+ * @see {@link DescribeClustersCommand} */ - public describeClusters( + describeClusters( args: DescribeClustersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClusters( + describeClusters( args: DescribeClustersCommandInput, cb: (err: any, data?: DescribeClustersCommandOutput) => void ): void; - public describeClusters( + describeClusters( args: DescribeClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClustersCommandOutput) => void ): void; - public describeClusters( - args: DescribeClustersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClustersCommandOutput) => void), - cb?: (err: any, data?: DescribeClustersCommandOutput) => void - ): Promise | void { - const command = new DescribeClustersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your - * issuing certificate authority (CA) and the CA's root certificate. Before you can claim a - * cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. - * To get the cluster's CSR, use DescribeClusters.

+ * @see {@link InitializeClusterCommand} */ - public initializeCluster( + initializeCluster( args: InitializeClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public initializeCluster( + initializeCluster( args: InitializeClusterCommandInput, cb: (err: any, data?: InitializeClusterCommandOutput) => void ): void; - public initializeCluster( + initializeCluster( args: InitializeClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InitializeClusterCommandOutput) => void ): void; - public initializeCluster( - args: InitializeClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InitializeClusterCommandOutput) => void), - cb?: (err: any, data?: InitializeClusterCommandOutput) => void - ): Promise | void { - const command = new InitializeClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of tags for the specified AWS CloudHSM cluster.

- *

This is a paginated operation, which means that each response might contain only a - * subset of all the tags. When the response contains only a subset of tags, it includes a - * NextToken value. Use this value in a subsequent ListTags request to - * get more tags. When you receive a response with no NextToken (or an empty or null - * value), that means there are no more tags to get.

+ * @see {@link ListTagsCommand} */ - public listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; - public listTags( + listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; + listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; + listTags( args: ListTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsCommandOutput) => void ): void; - public listTags( - args: ListTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsCommandOutput) => void), - cb?: (err: any, data?: ListTagsCommandOutput) => void - ): Promise | void { - const command = new ListTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies attributes for AWS CloudHSM backup.

+ * @see {@link ModifyBackupAttributesCommand} */ - public modifyBackupAttributes( + modifyBackupAttributes( args: ModifyBackupAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyBackupAttributes( + modifyBackupAttributes( args: ModifyBackupAttributesCommandInput, cb: (err: any, data?: ModifyBackupAttributesCommandOutput) => void ): void; - public modifyBackupAttributes( + modifyBackupAttributes( args: ModifyBackupAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyBackupAttributesCommandOutput) => void ): void; - public modifyBackupAttributes( - args: ModifyBackupAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyBackupAttributesCommandOutput) => void), - cb?: (err: any, data?: ModifyBackupAttributesCommandOutput) => void - ): Promise | void { - const command = new ModifyBackupAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies AWS CloudHSM cluster.

+ * @see {@link ModifyClusterCommand} */ - public modifyCluster( - args: ModifyClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public modifyCluster( - args: ModifyClusterCommandInput, - cb: (err: any, data?: ModifyClusterCommandOutput) => void - ): void; - public modifyCluster( + modifyCluster(args: ModifyClusterCommandInput, options?: __HttpHandlerOptions): Promise; + modifyCluster(args: ModifyClusterCommandInput, cb: (err: any, data?: ModifyClusterCommandOutput) => void): void; + modifyCluster( args: ModifyClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyClusterCommandOutput) => void ): void; - public modifyCluster( - args: ModifyClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyClusterCommandOutput) => void), - cb?: (err: any, data?: ModifyClusterCommandOutput) => void - ): Promise | void { - const command = new ModifyClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Restores a specified AWS CloudHSM backup that is in the - * PENDING_DELETION state. For mor information on deleting a backup, see - * DeleteBackup.

+ * @see {@link RestoreBackupCommand} */ - public restoreBackup( - args: RestoreBackupCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public restoreBackup( - args: RestoreBackupCommandInput, - cb: (err: any, data?: RestoreBackupCommandOutput) => void - ): void; - public restoreBackup( + restoreBackup(args: RestoreBackupCommandInput, options?: __HttpHandlerOptions): Promise; + restoreBackup(args: RestoreBackupCommandInput, cb: (err: any, data?: RestoreBackupCommandOutput) => void): void; + restoreBackup( args: RestoreBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreBackupCommandOutput) => void ): void; - public restoreBackup( - args: RestoreBackupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreBackupCommandOutput) => void), - cb?: (err: any, data?: RestoreBackupCommandOutput) => void - ): Promise | void { - const command = new RestoreBackupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified tag or tags from the specified AWS CloudHSM cluster.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

For more information about AWS CloudHSM, see AWS CloudHSM and the AWS + * CloudHSM User Guide.

+ */ +export class CloudHSMV2 extends CloudHSMV2Client implements CloudHSMV2 {} +createAggregatedClient(commands, CloudHSMV2); diff --git a/clients/client-cloudhsm/src/CloudHSM.ts b/clients/client-cloudhsm/src/CloudHSM.ts index a565319e2ac2..318f9c058347 100644 --- a/clients/client-cloudhsm/src/CloudHSM.ts +++ b/clients/client-cloudhsm/src/CloudHSM.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CloudHSMClient } from "./CloudHSMClient"; +import { CloudHSMClient, CloudHSMClientConfig } from "./CloudHSMClient"; import { AddTagsToResourceCommand, AddTagsToResourceCommandInput, @@ -63,853 +64,315 @@ import { RemoveTagsFromResourceCommandOutput, } from "./commands/RemoveTagsFromResourceCommand"; -/** - * @public - * AWS CloudHSM Service - *

This is documentation for AWS CloudHSM Classic. For - * more information, see AWS CloudHSM - * Classic FAQs, the AWS - * CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

- *

- * For information about the current version of AWS - * CloudHSM, see AWS CloudHSM, the - * AWS CloudHSM User Guide, - * and the AWS CloudHSM API - * Reference.

- */ -export class CloudHSM extends CloudHSMClient { +const commands = { + AddTagsToResourceCommand, + CreateHapgCommand, + CreateHsmCommand, + CreateLunaClientCommand, + DeleteHapgCommand, + DeleteHsmCommand, + DeleteLunaClientCommand, + DescribeHapgCommand, + DescribeHsmCommand, + DescribeLunaClientCommand, + GetConfigCommand, + ListAvailableZonesCommand, + ListHapgsCommand, + ListHsmsCommand, + ListLunaClientsCommand, + ListTagsForResourceCommand, + ModifyHapgCommand, + ModifyHsmCommand, + ModifyLunaClientCommand, + RemoveTagsFromResourceCommand, +}; + +export interface CloudHSM { /** - * @public - *

This is documentation for AWS CloudHSM Classic. For - * more information, see AWS CloudHSM - * Classic FAQs, the AWS - * CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

- *

- * For information about the current version of AWS - * CloudHSM, see AWS CloudHSM, the - * AWS CloudHSM User Guide, - * and the AWS CloudHSM API - * Reference.

- *

Adds or overwrites one or more tags for the specified AWS CloudHSM resource.

- *

Each tag consists of a key and a value. Tag keys must be unique to each - * resource.

+ * @see {@link AddTagsToResourceCommand} */ - public addTagsToResource( + addTagsToResource( args: AddTagsToResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public addTagsToResource( + addTagsToResource( args: AddTagsToResourceCommandInput, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void ): void; - public addTagsToResource( + addTagsToResource( args: AddTagsToResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void ): void; - public addTagsToResource( - args: AddTagsToResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddTagsToResourceCommandOutput) => void), - cb?: (err: any, data?: AddTagsToResourceCommandOutput) => void - ): Promise | void { - const command = new AddTagsToResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This is documentation for AWS CloudHSM Classic. For - * more information, see AWS CloudHSM - * Classic FAQs, the AWS - * CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

- *

- * For information about the current version of AWS - * CloudHSM, see AWS CloudHSM, the - * AWS CloudHSM User Guide, - * and the AWS CloudHSM API - * Reference.

- *

Creates a high-availability partition group. A high-availability partition group is a - * group of partitions that spans multiple physical HSMs.

+ * @see {@link CreateHapgCommand} */ - public createHapg(args: CreateHapgCommandInput, options?: __HttpHandlerOptions): Promise; - public createHapg(args: CreateHapgCommandInput, cb: (err: any, data?: CreateHapgCommandOutput) => void): void; - public createHapg( + createHapg(args: CreateHapgCommandInput, options?: __HttpHandlerOptions): Promise; + createHapg(args: CreateHapgCommandInput, cb: (err: any, data?: CreateHapgCommandOutput) => void): void; + createHapg( args: CreateHapgCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHapgCommandOutput) => void ): void; - public createHapg( - args: CreateHapgCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateHapgCommandOutput) => void), - cb?: (err: any, data?: CreateHapgCommandOutput) => void - ): Promise | void { - const command = new CreateHapgCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This is documentation for AWS CloudHSM Classic. For - * more information, see AWS CloudHSM - * Classic FAQs, the AWS - * CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

- *

- * For information about the current version of AWS - * CloudHSM, see AWS CloudHSM, the - * AWS CloudHSM User Guide, - * and the AWS CloudHSM API - * Reference.

- *

Creates an uninitialized HSM instance.

- *

There is an upfront fee charged for each HSM instance that you create with the - * CreateHsm operation. If you accidentally provision an HSM and want to request a - * refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center, create a new case, and select - * Account and Billing Support.

- * - *

It can take up to 20 minutes to create and provision an HSM. You can monitor the - * status of the HSM with the DescribeHsm operation. The HSM is ready to be - * initialized when the status changes to RUNNING.

- *
+ * @see {@link CreateHsmCommand} */ - public createHsm(args: CreateHsmCommandInput, options?: __HttpHandlerOptions): Promise; - public createHsm(args: CreateHsmCommandInput, cb: (err: any, data?: CreateHsmCommandOutput) => void): void; - public createHsm( + createHsm(args: CreateHsmCommandInput, options?: __HttpHandlerOptions): Promise; + createHsm(args: CreateHsmCommandInput, cb: (err: any, data?: CreateHsmCommandOutput) => void): void; + createHsm( args: CreateHsmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHsmCommandOutput) => void ): void; - public createHsm( - args: CreateHsmCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateHsmCommandOutput) => void), - cb?: (err: any, data?: CreateHsmCommandOutput) => void - ): Promise | void { - const command = new CreateHsmCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This is documentation for AWS CloudHSM Classic. For - * more information, see AWS CloudHSM - * Classic FAQs, the AWS - * CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

- *

- * For information about the current version of AWS - * CloudHSM, see AWS CloudHSM, the - * AWS CloudHSM User Guide, - * and the AWS CloudHSM API - * Reference.

- *

Creates an HSM client.

+ * @see {@link CreateLunaClientCommand} */ - public createLunaClient( + createLunaClient( args: CreateLunaClientCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLunaClient( + createLunaClient( args: CreateLunaClientCommandInput, cb: (err: any, data?: CreateLunaClientCommandOutput) => void ): void; - public createLunaClient( + createLunaClient( args: CreateLunaClientCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLunaClientCommandOutput) => void ): void; - public createLunaClient( - args: CreateLunaClientCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLunaClientCommandOutput) => void), - cb?: (err: any, data?: CreateLunaClientCommandOutput) => void - ): Promise | void { - const command = new CreateLunaClientCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This is documentation for AWS CloudHSM Classic. For - * more information, see AWS CloudHSM - * Classic FAQs, the AWS - * CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

- *

- * For information about the current version of AWS - * CloudHSM, see AWS CloudHSM, the - * AWS CloudHSM User Guide, - * and the AWS CloudHSM API - * Reference.

- *

Deletes a high-availability partition group.

+ * @see {@link DeleteHapgCommand} */ - public deleteHapg(args: DeleteHapgCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteHapg(args: DeleteHapgCommandInput, cb: (err: any, data?: DeleteHapgCommandOutput) => void): void; - public deleteHapg( + deleteHapg(args: DeleteHapgCommandInput, options?: __HttpHandlerOptions): Promise; + deleteHapg(args: DeleteHapgCommandInput, cb: (err: any, data?: DeleteHapgCommandOutput) => void): void; + deleteHapg( args: DeleteHapgCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHapgCommandOutput) => void ): void; - public deleteHapg( - args: DeleteHapgCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteHapgCommandOutput) => void), - cb?: (err: any, data?: DeleteHapgCommandOutput) => void - ): Promise | void { - const command = new DeleteHapgCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This is documentation for AWS CloudHSM Classic. For - * more information, see AWS CloudHSM - * Classic FAQs, the AWS - * CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

- *

- * For information about the current version of AWS - * CloudHSM, see AWS CloudHSM, the - * AWS CloudHSM User Guide, - * and the AWS CloudHSM API - * Reference.

- *

Deletes an HSM. After completion, this operation cannot be undone and your key material - * cannot be recovered.

+ * @see {@link DeleteHsmCommand} */ - public deleteHsm(args: DeleteHsmCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteHsm(args: DeleteHsmCommandInput, cb: (err: any, data?: DeleteHsmCommandOutput) => void): void; - public deleteHsm( + deleteHsm(args: DeleteHsmCommandInput, options?: __HttpHandlerOptions): Promise; + deleteHsm(args: DeleteHsmCommandInput, cb: (err: any, data?: DeleteHsmCommandOutput) => void): void; + deleteHsm( args: DeleteHsmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHsmCommandOutput) => void ): void; - public deleteHsm( - args: DeleteHsmCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteHsmCommandOutput) => void), - cb?: (err: any, data?: DeleteHsmCommandOutput) => void - ): Promise | void { - const command = new DeleteHsmCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This is documentation for AWS CloudHSM Classic. For - * more information, see AWS CloudHSM - * Classic FAQs, the AWS - * CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

- *

- * For information about the current version of AWS - * CloudHSM, see AWS CloudHSM, the - * AWS CloudHSM User Guide, - * and the AWS CloudHSM API - * Reference.

- *

Deletes a client.

+ * @see {@link DeleteLunaClientCommand} */ - public deleteLunaClient( + deleteLunaClient( args: DeleteLunaClientCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLunaClient( + deleteLunaClient( args: DeleteLunaClientCommandInput, cb: (err: any, data?: DeleteLunaClientCommandOutput) => void ): void; - public deleteLunaClient( + deleteLunaClient( args: DeleteLunaClientCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLunaClientCommandOutput) => void ): void; - public deleteLunaClient( - args: DeleteLunaClientCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLunaClientCommandOutput) => void), - cb?: (err: any, data?: DeleteLunaClientCommandOutput) => void - ): Promise | void { - const command = new DeleteLunaClientCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This is documentation for AWS CloudHSM Classic. For - * more information, see AWS CloudHSM - * Classic FAQs, the AWS - * CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

- *

- * For information about the current version of AWS - * CloudHSM, see AWS CloudHSM, the - * AWS CloudHSM User Guide, - * and the AWS CloudHSM API - * Reference.

- *

Retrieves information about a high-availability partition group.

+ * @see {@link DescribeHapgCommand} */ - public describeHapg( - args: DescribeHapgCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeHapg(args: DescribeHapgCommandInput, cb: (err: any, data?: DescribeHapgCommandOutput) => void): void; - public describeHapg( + describeHapg(args: DescribeHapgCommandInput, options?: __HttpHandlerOptions): Promise; + describeHapg(args: DescribeHapgCommandInput, cb: (err: any, data?: DescribeHapgCommandOutput) => void): void; + describeHapg( args: DescribeHapgCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHapgCommandOutput) => void ): void; - public describeHapg( - args: DescribeHapgCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeHapgCommandOutput) => void), - cb?: (err: any, data?: DescribeHapgCommandOutput) => void - ): Promise | void { - const command = new DescribeHapgCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This is documentation for AWS CloudHSM Classic. For - * more information, see AWS CloudHSM - * Classic FAQs, the AWS - * CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

- *

- * For information about the current version of AWS - * CloudHSM, see AWS CloudHSM, the - * AWS CloudHSM User Guide, - * and the AWS CloudHSM API - * Reference.

- *

Retrieves information about an HSM. You can identify the HSM by its ARN or its serial - * number.

+ * @see {@link DescribeHsmCommand} */ - public describeHsm(args: DescribeHsmCommandInput, options?: __HttpHandlerOptions): Promise; - public describeHsm(args: DescribeHsmCommandInput, cb: (err: any, data?: DescribeHsmCommandOutput) => void): void; - public describeHsm( + describeHsm(args: DescribeHsmCommandInput, options?: __HttpHandlerOptions): Promise; + describeHsm(args: DescribeHsmCommandInput, cb: (err: any, data?: DescribeHsmCommandOutput) => void): void; + describeHsm( args: DescribeHsmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHsmCommandOutput) => void ): void; - public describeHsm( - args: DescribeHsmCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeHsmCommandOutput) => void), - cb?: (err: any, data?: DescribeHsmCommandOutput) => void - ): Promise | void { - const command = new DescribeHsmCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This is documentation for AWS CloudHSM Classic. For - * more information, see AWS CloudHSM - * Classic FAQs, the AWS - * CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

- *

- * For information about the current version of AWS - * CloudHSM, see AWS CloudHSM, the - * AWS CloudHSM User Guide, - * and the AWS CloudHSM API - * Reference.

- *

Retrieves information about an HSM client.

+ * @see {@link DescribeLunaClientCommand} */ - public describeLunaClient( + describeLunaClient( args: DescribeLunaClientCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLunaClient( + describeLunaClient( args: DescribeLunaClientCommandInput, cb: (err: any, data?: DescribeLunaClientCommandOutput) => void ): void; - public describeLunaClient( + describeLunaClient( args: DescribeLunaClientCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLunaClientCommandOutput) => void ): void; - public describeLunaClient( - args: DescribeLunaClientCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLunaClientCommandOutput) => void), - cb?: (err: any, data?: DescribeLunaClientCommandOutput) => void - ): Promise | void { - const command = new DescribeLunaClientCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This is documentation for AWS CloudHSM Classic. For - * more information, see AWS CloudHSM - * Classic FAQs, the AWS - * CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

- *

- * For information about the current version of AWS - * CloudHSM, see AWS CloudHSM, the - * AWS CloudHSM User Guide, - * and the AWS CloudHSM API - * Reference.

- *

Gets the configuration files necessary to connect to all high availability partition - * groups the client is associated with.

+ * @see {@link GetConfigCommand} */ - public getConfig(args: GetConfigCommandInput, options?: __HttpHandlerOptions): Promise; - public getConfig(args: GetConfigCommandInput, cb: (err: any, data?: GetConfigCommandOutput) => void): void; - public getConfig( + getConfig(args: GetConfigCommandInput, options?: __HttpHandlerOptions): Promise; + getConfig(args: GetConfigCommandInput, cb: (err: any, data?: GetConfigCommandOutput) => void): void; + getConfig( args: GetConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConfigCommandOutput) => void ): void; - public getConfig( - args: GetConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConfigCommandOutput) => void), - cb?: (err: any, data?: GetConfigCommandOutput) => void - ): Promise | void { - const command = new GetConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This is documentation for AWS CloudHSM Classic. For - * more information, see AWS CloudHSM - * Classic FAQs, the AWS - * CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

- *

- * For information about the current version of AWS - * CloudHSM, see AWS CloudHSM, the - * AWS CloudHSM User Guide, - * and the AWS CloudHSM API - * Reference.

- *

Lists the Availability Zones that have available AWS CloudHSM capacity.

+ * @see {@link ListAvailableZonesCommand} */ - public listAvailableZones( + listAvailableZones( args: ListAvailableZonesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAvailableZones( + listAvailableZones( args: ListAvailableZonesCommandInput, cb: (err: any, data?: ListAvailableZonesCommandOutput) => void ): void; - public listAvailableZones( + listAvailableZones( args: ListAvailableZonesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAvailableZonesCommandOutput) => void ): void; - public listAvailableZones( - args: ListAvailableZonesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAvailableZonesCommandOutput) => void), - cb?: (err: any, data?: ListAvailableZonesCommandOutput) => void - ): Promise | void { - const command = new ListAvailableZonesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This is documentation for AWS CloudHSM Classic. For - * more information, see AWS CloudHSM - * Classic FAQs, the AWS - * CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

- *

- * For information about the current version of AWS - * CloudHSM, see AWS CloudHSM, the - * AWS CloudHSM User Guide, - * and the AWS CloudHSM API - * Reference.

- *

Lists the high-availability partition groups for the account.

- *

This operation supports pagination with the use of the NextToken member. - * If more results are available, the NextToken member of the response contains a - * token that you pass in the next call to ListHapgs to retrieve the next set of - * items.

+ * @see {@link ListHapgsCommand} */ - public listHapgs(args: ListHapgsCommandInput, options?: __HttpHandlerOptions): Promise; - public listHapgs(args: ListHapgsCommandInput, cb: (err: any, data?: ListHapgsCommandOutput) => void): void; - public listHapgs( + listHapgs(args: ListHapgsCommandInput, options?: __HttpHandlerOptions): Promise; + listHapgs(args: ListHapgsCommandInput, cb: (err: any, data?: ListHapgsCommandOutput) => void): void; + listHapgs( args: ListHapgsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHapgsCommandOutput) => void ): void; - public listHapgs( - args: ListHapgsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListHapgsCommandOutput) => void), - cb?: (err: any, data?: ListHapgsCommandOutput) => void - ): Promise | void { - const command = new ListHapgsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This is documentation for AWS CloudHSM Classic. For - * more information, see AWS CloudHSM - * Classic FAQs, the AWS - * CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

- *

- * For information about the current version of AWS - * CloudHSM, see AWS CloudHSM, the - * AWS CloudHSM User Guide, - * and the AWS CloudHSM API - * Reference.

- *

Retrieves the identifiers of all of the HSMs provisioned for the current - * customer.

- *

This operation supports pagination with the use of the NextToken member. - * If more results are available, the NextToken member of the response contains a - * token that you pass in the next call to ListHsms to retrieve the next set of - * items.

+ * @see {@link ListHsmsCommand} */ - public listHsms(args: ListHsmsCommandInput, options?: __HttpHandlerOptions): Promise; - public listHsms(args: ListHsmsCommandInput, cb: (err: any, data?: ListHsmsCommandOutput) => void): void; - public listHsms( + listHsms(args: ListHsmsCommandInput, options?: __HttpHandlerOptions): Promise; + listHsms(args: ListHsmsCommandInput, cb: (err: any, data?: ListHsmsCommandOutput) => void): void; + listHsms( args: ListHsmsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHsmsCommandOutput) => void ): void; - public listHsms( - args: ListHsmsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListHsmsCommandOutput) => void), - cb?: (err: any, data?: ListHsmsCommandOutput) => void - ): Promise | void { - const command = new ListHsmsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This is documentation for AWS CloudHSM Classic. For - * more information, see AWS CloudHSM - * Classic FAQs, the AWS - * CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

- *

- * For information about the current version of AWS - * CloudHSM, see AWS CloudHSM, the - * AWS CloudHSM User Guide, - * and the AWS CloudHSM API - * Reference.

- *

Lists all of the clients.

- *

This operation supports pagination with the use of the NextToken member. - * If more results are available, the NextToken member of the response contains a - * token that you pass in the next call to ListLunaClients to retrieve the next set - * of items.

+ * @see {@link ListLunaClientsCommand} */ - public listLunaClients( + listLunaClients( args: ListLunaClientsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLunaClients( - args: ListLunaClientsCommandInput, - cb: (err: any, data?: ListLunaClientsCommandOutput) => void - ): void; - public listLunaClients( + listLunaClients(args: ListLunaClientsCommandInput, cb: (err: any, data?: ListLunaClientsCommandOutput) => void): void; + listLunaClients( args: ListLunaClientsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLunaClientsCommandOutput) => void ): void; - public listLunaClients( - args: ListLunaClientsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLunaClientsCommandOutput) => void), - cb?: (err: any, data?: ListLunaClientsCommandOutput) => void - ): Promise | void { - const command = new ListLunaClientsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This is documentation for AWS CloudHSM Classic. For - * more information, see AWS CloudHSM - * Classic FAQs, the AWS - * CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

- *

- * For information about the current version of AWS - * CloudHSM, see AWS CloudHSM, the - * AWS CloudHSM User Guide, - * and the AWS CloudHSM API - * Reference.

- *

Returns a list of all tags for the specified AWS CloudHSM resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This is documentation for AWS CloudHSM Classic. For - * more information, see AWS CloudHSM - * Classic FAQs, the AWS - * CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

- *

- * For information about the current version of AWS - * CloudHSM, see AWS CloudHSM, the - * AWS CloudHSM User Guide, - * and the AWS CloudHSM API - * Reference.

- *

Modifies an existing high-availability partition group.

+ * @see {@link ModifyHapgCommand} */ - public modifyHapg(args: ModifyHapgCommandInput, options?: __HttpHandlerOptions): Promise; - public modifyHapg(args: ModifyHapgCommandInput, cb: (err: any, data?: ModifyHapgCommandOutput) => void): void; - public modifyHapg( + modifyHapg(args: ModifyHapgCommandInput, options?: __HttpHandlerOptions): Promise; + modifyHapg(args: ModifyHapgCommandInput, cb: (err: any, data?: ModifyHapgCommandOutput) => void): void; + modifyHapg( args: ModifyHapgCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyHapgCommandOutput) => void ): void; - public modifyHapg( - args: ModifyHapgCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyHapgCommandOutput) => void), - cb?: (err: any, data?: ModifyHapgCommandOutput) => void - ): Promise | void { - const command = new ModifyHapgCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This is documentation for AWS CloudHSM Classic. For - * more information, see AWS CloudHSM - * Classic FAQs, the AWS - * CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

- *

- * For information about the current version of AWS - * CloudHSM, see AWS CloudHSM, the - * AWS CloudHSM User Guide, - * and the AWS CloudHSM API - * Reference.

- *

Modifies an HSM.

- * - *

This operation can result in the HSM being offline for up to 15 minutes while the AWS - * CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure - * that your AWS CloudHSM service is configured for high availability, and consider executing this - * operation during a maintenance window.

- *
+ * @see {@link ModifyHsmCommand} */ - public modifyHsm(args: ModifyHsmCommandInput, options?: __HttpHandlerOptions): Promise; - public modifyHsm(args: ModifyHsmCommandInput, cb: (err: any, data?: ModifyHsmCommandOutput) => void): void; - public modifyHsm( + modifyHsm(args: ModifyHsmCommandInput, options?: __HttpHandlerOptions): Promise; + modifyHsm(args: ModifyHsmCommandInput, cb: (err: any, data?: ModifyHsmCommandOutput) => void): void; + modifyHsm( args: ModifyHsmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyHsmCommandOutput) => void ): void; - public modifyHsm( - args: ModifyHsmCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyHsmCommandOutput) => void), - cb?: (err: any, data?: ModifyHsmCommandOutput) => void - ): Promise | void { - const command = new ModifyHsmCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This is documentation for AWS CloudHSM Classic. For - * more information, see AWS CloudHSM - * Classic FAQs, the AWS - * CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

- *

- * For information about the current version of AWS - * CloudHSM, see AWS CloudHSM, the - * AWS CloudHSM User Guide, - * and the AWS CloudHSM API - * Reference.

- *

Modifies the certificate used by the client.

- *

This action can potentially start a workflow to install the new certificate on the - * client's HSMs.

+ * @see {@link ModifyLunaClientCommand} */ - public modifyLunaClient( + modifyLunaClient( args: ModifyLunaClientCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyLunaClient( + modifyLunaClient( args: ModifyLunaClientCommandInput, cb: (err: any, data?: ModifyLunaClientCommandOutput) => void ): void; - public modifyLunaClient( + modifyLunaClient( args: ModifyLunaClientCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyLunaClientCommandOutput) => void ): void; - public modifyLunaClient( - args: ModifyLunaClientCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyLunaClientCommandOutput) => void), - cb?: (err: any, data?: ModifyLunaClientCommandOutput) => void - ): Promise | void { - const command = new ModifyLunaClientCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This is documentation for AWS CloudHSM Classic. For - * more information, see AWS CloudHSM - * Classic FAQs, the AWS - * CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

- *

- * For information about the current version of AWS - * CloudHSM, see AWS CloudHSM, the - * AWS CloudHSM User Guide, - * and the AWS CloudHSM API - * Reference.

- *

Removes one or more tags from the specified AWS CloudHSM resource.

- *

To remove a tag, specify only the tag key to remove (not the value). To overwrite the - * value for an existing tag, use AddTagsToResource.

+ * @see {@link RemoveTagsFromResourceCommand} */ - public removeTagsFromResource( + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeTagsFromResource( + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void ): void; - public removeTagsFromResource( + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void ): void; - public removeTagsFromResource( - args: RemoveTagsFromResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveTagsFromResourceCommandOutput) => void), - cb?: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void - ): Promise | void { - const command = new RemoveTagsFromResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * AWS CloudHSM Service + *

This is documentation for AWS CloudHSM Classic. For + * more information, see AWS CloudHSM + * Classic FAQs, the AWS + * CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

+ *

+ * For information about the current version of AWS + * CloudHSM, see AWS CloudHSM, the + * AWS CloudHSM User Guide, + * and the AWS CloudHSM API + * Reference.

+ */ +export class CloudHSM extends CloudHSMClient implements CloudHSM {} +createAggregatedClient(commands, CloudHSM); diff --git a/clients/client-cloudsearch-domain/src/CloudSearchDomain.ts b/clients/client-cloudsearch-domain/src/CloudSearchDomain.ts index 2099e1085f15..b587d65ce295 100644 --- a/clients/client-cloudsearch-domain/src/CloudSearchDomain.ts +++ b/clients/client-cloudsearch-domain/src/CloudSearchDomain.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CloudSearchDomainClient } from "./CloudSearchDomainClient"; +import { CloudSearchDomainClient, CloudSearchDomainClientConfig } from "./CloudSearchDomainClient"; import { SearchCommand, SearchCommandInput, SearchCommandOutput } from "./commands/SearchCommand"; import { SuggestCommand, SuggestCommandInput, SuggestCommandOutput } from "./commands/SuggestCommand"; import { @@ -10,112 +11,56 @@ import { UploadDocumentsCommandOutput, } from "./commands/UploadDocumentsCommand"; -/** - * @public - *

You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents.

- * - *

The endpoints for submitting UploadDocuments, Search, and Suggest requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint.

- *

For more information, see the Amazon CloudSearch Developer Guide.

- */ -export class CloudSearchDomain extends CloudSearchDomainClient { +const commands = { + SearchCommand, + SuggestCommand, + UploadDocumentsCommand, +}; + +export interface CloudSearchDomain { /** - * @public - *

Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers:

- *
    - *
  • simple: search all text and text-array fields for the specified string. Search for phrases, individual terms, and prefixes.
  • - *
  • structured: search specific fields, construct compound queries using Boolean operators, and use advanced features such as term boosting and proximity searching.
  • - *
  • lucene: specify search criteria using the Apache Lucene query parser syntax.
  • - *
  • dismax: specify search criteria using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser.
  • - *
- *

For more information, see Searching Your Data in the Amazon CloudSearch Developer Guide.

- *

The endpoint for submitting Search requests is domain-specific. You submit search requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

+ * @see {@link SearchCommand} */ - public search(args: SearchCommandInput, options?: __HttpHandlerOptions): Promise; - public search(args: SearchCommandInput, cb: (err: any, data?: SearchCommandOutput) => void): void; - public search( + search(args: SearchCommandInput, options?: __HttpHandlerOptions): Promise; + search(args: SearchCommandInput, cb: (err: any, data?: SearchCommandOutput) => void): void; + search( args: SearchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchCommandOutput) => void ): void; - public search( - args: SearchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchCommandOutput) => void), - cb?: (err: any, data?: SearchCommandOutput) => void - ): Promise | void { - const command = new SearchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match.

- *

For more information about configuring suggesters and retrieving suggestions, see Getting Suggestions in the Amazon CloudSearch Developer Guide.

- * - *

The endpoint for submitting Suggest requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

+ * @see {@link SuggestCommand} */ - public suggest(args: SuggestCommandInput, options?: __HttpHandlerOptions): Promise; - public suggest(args: SuggestCommandInput, cb: (err: any, data?: SuggestCommandOutput) => void): void; - public suggest( + suggest(args: SuggestCommandInput, options?: __HttpHandlerOptions): Promise; + suggest(args: SuggestCommandInput, cb: (err: any, data?: SuggestCommandOutput) => void): void; + suggest( args: SuggestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SuggestCommandOutput) => void ): void; - public suggest( - args: SuggestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SuggestCommandOutput) => void), - cb?: (err: any, data?: SuggestCommandOutput) => void - ): Promise | void { - const command = new SuggestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service.

- *

The endpoint for submitting UploadDocuments requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

- *

For more information about formatting your data for Amazon CloudSearch, see Preparing Your Data in the Amazon CloudSearch Developer Guide. - * For more information about uploading data for indexing, see Uploading Data in the Amazon CloudSearch Developer Guide.

+ * @see {@link UploadDocumentsCommand} */ - public uploadDocuments( + uploadDocuments( args: UploadDocumentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public uploadDocuments( - args: UploadDocumentsCommandInput, - cb: (err: any, data?: UploadDocumentsCommandOutput) => void - ): void; - public uploadDocuments( + uploadDocuments(args: UploadDocumentsCommandInput, cb: (err: any, data?: UploadDocumentsCommandOutput) => void): void; + uploadDocuments( args: UploadDocumentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UploadDocumentsCommandOutput) => void ): void; - public uploadDocuments( - args: UploadDocumentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UploadDocumentsCommandOutput) => void), - cb?: (err: any, data?: UploadDocumentsCommandOutput) => void - ): Promise | void { - const command = new UploadDocumentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents.

+ * + *

The endpoints for submitting UploadDocuments, Search, and Suggest requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint.

+ *

For more information, see the Amazon CloudSearch Developer Guide.

+ */ +export class CloudSearchDomain extends CloudSearchDomainClient implements CloudSearchDomain {} +createAggregatedClient(commands, CloudSearchDomain); diff --git a/clients/client-cloudsearch/src/CloudSearch.ts b/clients/client-cloudsearch/src/CloudSearch.ts index b4ccbe883569..c27f5b0e1cc1 100644 --- a/clients/client-cloudsearch/src/CloudSearch.ts +++ b/clients/client-cloudsearch/src/CloudSearch.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CloudSearchClient } from "./CloudSearchClient"; +import { CloudSearchClient, CloudSearchClientConfig } from "./CloudSearchClient"; import { BuildSuggestersCommand, BuildSuggestersCommandInput, @@ -133,875 +134,458 @@ import { UpdateServiceAccessPoliciesCommandOutput, } from "./commands/UpdateServiceAccessPoliciesCommand"; -/** - * @public - * Amazon CloudSearch Configuration Service - *

You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. - * Configuration service requests are submitted using the AWS Query protocol. AWS Query requests - * are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.

- *

The endpoint for configuration service requests is region-specific: cloudsearch.region.amazonaws.com. - * For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, - * see Regions and Endpoints.

- */ -export class CloudSearch extends CloudSearchClient { +const commands = { + BuildSuggestersCommand, + CreateDomainCommand, + DefineAnalysisSchemeCommand, + DefineExpressionCommand, + DefineIndexFieldCommand, + DefineSuggesterCommand, + DeleteAnalysisSchemeCommand, + DeleteDomainCommand, + DeleteExpressionCommand, + DeleteIndexFieldCommand, + DeleteSuggesterCommand, + DescribeAnalysisSchemesCommand, + DescribeAvailabilityOptionsCommand, + DescribeDomainEndpointOptionsCommand, + DescribeDomainsCommand, + DescribeExpressionsCommand, + DescribeIndexFieldsCommand, + DescribeScalingParametersCommand, + DescribeServiceAccessPoliciesCommand, + DescribeSuggestersCommand, + IndexDocumentsCommand, + ListDomainNamesCommand, + UpdateAvailabilityOptionsCommand, + UpdateDomainEndpointOptionsCommand, + UpdateScalingParametersCommand, + UpdateServiceAccessPoliciesCommand, +}; + +export interface CloudSearch { /** - * @public - *

Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.

+ * @see {@link BuildSuggestersCommand} */ - public buildSuggesters( + buildSuggesters( args: BuildSuggestersCommandInput, options?: __HttpHandlerOptions ): Promise; - public buildSuggesters( - args: BuildSuggestersCommandInput, - cb: (err: any, data?: BuildSuggestersCommandOutput) => void - ): void; - public buildSuggesters( + buildSuggesters(args: BuildSuggestersCommandInput, cb: (err: any, data?: BuildSuggestersCommandOutput) => void): void; + buildSuggesters( args: BuildSuggestersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BuildSuggestersCommandOutput) => void ): void; - public buildSuggesters( - args: BuildSuggestersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BuildSuggestersCommandOutput) => void), - cb?: (err: any, data?: BuildSuggestersCommandOutput) => void - ): Promise | void { - const command = new BuildSuggestersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new search domain. For more information, - * see Creating a Search Domain in the Amazon CloudSearch Developer Guide.

+ * @see {@link CreateDomainCommand} */ - public createDomain( - args: CreateDomainCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createDomain(args: CreateDomainCommandInput, cb: (err: any, data?: CreateDomainCommandOutput) => void): void; - public createDomain( + createDomain(args: CreateDomainCommandInput, options?: __HttpHandlerOptions): Promise; + createDomain(args: CreateDomainCommandInput, cb: (err: any, data?: CreateDomainCommandOutput) => void): void; + createDomain( args: CreateDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDomainCommandOutput) => void ): void; - public createDomain( - args: CreateDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDomainCommandOutput) => void), - cb?: (err: any, data?: CreateDomainCommandOutput) => void - ): Promise | void { - const command = new CreateDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

+ * @see {@link DefineAnalysisSchemeCommand} */ - public defineAnalysisScheme( + defineAnalysisScheme( args: DefineAnalysisSchemeCommandInput, options?: __HttpHandlerOptions ): Promise; - public defineAnalysisScheme( + defineAnalysisScheme( args: DefineAnalysisSchemeCommandInput, cb: (err: any, data?: DefineAnalysisSchemeCommandOutput) => void ): void; - public defineAnalysisScheme( + defineAnalysisScheme( args: DefineAnalysisSchemeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DefineAnalysisSchemeCommandOutput) => void ): void; - public defineAnalysisScheme( - args: DefineAnalysisSchemeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DefineAnalysisSchemeCommandOutput) => void), - cb?: (err: any, data?: DefineAnalysisSchemeCommandOutput) => void - ): Promise | void { - const command = new DefineAnalysisSchemeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Configures an Expression for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

+ * @see {@link DefineExpressionCommand} */ - public defineExpression( + defineExpression( args: DefineExpressionCommandInput, options?: __HttpHandlerOptions ): Promise; - public defineExpression( + defineExpression( args: DefineExpressionCommandInput, cb: (err: any, data?: DefineExpressionCommandOutput) => void ): void; - public defineExpression( + defineExpression( args: DefineExpressionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DefineExpressionCommandOutput) => void ): void; - public defineExpression( - args: DefineExpressionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DefineExpressionCommandOutput) => void), - cb?: (err: any, data?: DefineExpressionCommandOutput) => void - ): Promise | void { - const command = new DefineExpressionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Configures an IndexField for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the IndexFieldType. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

+ * @see {@link DefineIndexFieldCommand} */ - public defineIndexField( + defineIndexField( args: DefineIndexFieldCommandInput, options?: __HttpHandlerOptions ): Promise; - public defineIndexField( + defineIndexField( args: DefineIndexFieldCommandInput, cb: (err: any, data?: DefineIndexFieldCommandOutput) => void ): void; - public defineIndexField( + defineIndexField( args: DefineIndexFieldCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DefineIndexFieldCommandOutput) => void ): void; - public defineIndexField( - args: DefineIndexFieldCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DefineIndexFieldCommandOutput) => void), - cb?: (err: any, data?: DefineIndexFieldCommandOutput) => void - ): Promise | void { - const command = new DefineIndexFieldCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

+ * @see {@link DefineSuggesterCommand} */ - public defineSuggester( + defineSuggester( args: DefineSuggesterCommandInput, options?: __HttpHandlerOptions ): Promise; - public defineSuggester( - args: DefineSuggesterCommandInput, - cb: (err: any, data?: DefineSuggesterCommandOutput) => void - ): void; - public defineSuggester( + defineSuggester(args: DefineSuggesterCommandInput, cb: (err: any, data?: DefineSuggesterCommandOutput) => void): void; + defineSuggester( args: DefineSuggesterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DefineSuggesterCommandOutput) => void ): void; - public defineSuggester( - args: DefineSuggesterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DefineSuggesterCommandOutput) => void), - cb?: (err: any, data?: DefineSuggesterCommandOutput) => void - ): Promise | void { - const command = new DefineSuggesterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

+ * @see {@link DeleteAnalysisSchemeCommand} */ - public deleteAnalysisScheme( + deleteAnalysisScheme( args: DeleteAnalysisSchemeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAnalysisScheme( + deleteAnalysisScheme( args: DeleteAnalysisSchemeCommandInput, cb: (err: any, data?: DeleteAnalysisSchemeCommandOutput) => void ): void; - public deleteAnalysisScheme( + deleteAnalysisScheme( args: DeleteAnalysisSchemeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAnalysisSchemeCommandOutput) => void ): void; - public deleteAnalysisScheme( - args: DeleteAnalysisSchemeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAnalysisSchemeCommandOutput) => void), - cb?: (err: any, data?: DeleteAnalysisSchemeCommandOutput) => void - ): Promise | void { - const command = new DeleteAnalysisSchemeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, - * see Deleting a Search Domain in the Amazon CloudSearch Developer Guide.

+ * @see {@link DeleteDomainCommand} */ - public deleteDomain( - args: DeleteDomainCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDomain(args: DeleteDomainCommandInput, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void; - public deleteDomain( + deleteDomain(args: DeleteDomainCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDomain(args: DeleteDomainCommandInput, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void; + deleteDomain( args: DeleteDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDomainCommandOutput) => void ): void; - public deleteDomain( - args: DeleteDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDomainCommandOutput) => void), - cb?: (err: any, data?: DeleteDomainCommandOutput) => void - ): Promise | void { - const command = new DeleteDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

+ * @see {@link DeleteExpressionCommand} */ - public deleteExpression( + deleteExpression( args: DeleteExpressionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteExpression( + deleteExpression( args: DeleteExpressionCommandInput, cb: (err: any, data?: DeleteExpressionCommandOutput) => void ): void; - public deleteExpression( + deleteExpression( args: DeleteExpressionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteExpressionCommandOutput) => void ): void; - public deleteExpression( - args: DeleteExpressionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteExpressionCommandOutput) => void), - cb?: (err: any, data?: DeleteExpressionCommandOutput) => void - ): Promise | void { - const command = new DeleteExpressionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

+ * @see {@link DeleteIndexFieldCommand} */ - public deleteIndexField( + deleteIndexField( args: DeleteIndexFieldCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteIndexField( + deleteIndexField( args: DeleteIndexFieldCommandInput, cb: (err: any, data?: DeleteIndexFieldCommandOutput) => void ): void; - public deleteIndexField( + deleteIndexField( args: DeleteIndexFieldCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIndexFieldCommandOutput) => void ): void; - public deleteIndexField( - args: DeleteIndexFieldCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIndexFieldCommandOutput) => void), - cb?: (err: any, data?: DeleteIndexFieldCommandOutput) => void - ): Promise | void { - const command = new DeleteIndexFieldCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

+ * @see {@link DeleteSuggesterCommand} */ - public deleteSuggester( + deleteSuggester( args: DeleteSuggesterCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSuggester( - args: DeleteSuggesterCommandInput, - cb: (err: any, data?: DeleteSuggesterCommandOutput) => void - ): void; - public deleteSuggester( + deleteSuggester(args: DeleteSuggesterCommandInput, cb: (err: any, data?: DeleteSuggesterCommandOutput) => void): void; + deleteSuggester( args: DeleteSuggesterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSuggesterCommandOutput) => void ): void; - public deleteSuggester( - args: DeleteSuggesterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSuggesterCommandOutput) => void), - cb?: (err: any, data?: DeleteSuggesterCommandOutput) => void - ): Promise | void { - const command = new DeleteSuggesterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

+ * @see {@link DescribeAnalysisSchemesCommand} */ - public describeAnalysisSchemes( + describeAnalysisSchemes( args: DescribeAnalysisSchemesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAnalysisSchemes( + describeAnalysisSchemes( args: DescribeAnalysisSchemesCommandInput, cb: (err: any, data?: DescribeAnalysisSchemesCommandOutput) => void ): void; - public describeAnalysisSchemes( + describeAnalysisSchemes( args: DescribeAnalysisSchemesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAnalysisSchemesCommandOutput) => void ): void; - public describeAnalysisSchemes( - args: DescribeAnalysisSchemesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAnalysisSchemesCommandOutput) => void), - cb?: (err: any, data?: DescribeAnalysisSchemesCommandOutput) => void - ): Promise | void { - const command = new DescribeAnalysisSchemesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

+ * @see {@link DescribeAvailabilityOptionsCommand} */ - public describeAvailabilityOptions( + describeAvailabilityOptions( args: DescribeAvailabilityOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAvailabilityOptions( + describeAvailabilityOptions( args: DescribeAvailabilityOptionsCommandInput, cb: (err: any, data?: DescribeAvailabilityOptionsCommandOutput) => void ): void; - public describeAvailabilityOptions( + describeAvailabilityOptions( args: DescribeAvailabilityOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAvailabilityOptionsCommandOutput) => void ): void; - public describeAvailabilityOptions( - args: DescribeAvailabilityOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAvailabilityOptionsCommandOutput) => void), - cb?: (err: any, data?: DescribeAvailabilityOptionsCommandOutput) => void - ): Promise | void { - const command = new DescribeAvailabilityOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.

+ * @see {@link DescribeDomainEndpointOptionsCommand} */ - public describeDomainEndpointOptions( + describeDomainEndpointOptions( args: DescribeDomainEndpointOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDomainEndpointOptions( + describeDomainEndpointOptions( args: DescribeDomainEndpointOptionsCommandInput, cb: (err: any, data?: DescribeDomainEndpointOptionsCommandOutput) => void ): void; - public describeDomainEndpointOptions( + describeDomainEndpointOptions( args: DescribeDomainEndpointOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDomainEndpointOptionsCommandOutput) => void ): void; - public describeDomainEndpointOptions( - args: DescribeDomainEndpointOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDomainEndpointOptionsCommandOutput) => void), - cb?: (err: any, data?: DescribeDomainEndpointOptionsCommandOutput) => void - ): Promise | void { - const command = new DescribeDomainEndpointOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows - * all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: q=matchall&q.parser=structured&size=0. For more information, - * see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.

+ * @see {@link DescribeDomainsCommand} */ - public describeDomains( + describeDomains( args: DescribeDomainsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDomains( - args: DescribeDomainsCommandInput, - cb: (err: any, data?: DescribeDomainsCommandOutput) => void - ): void; - public describeDomains( + describeDomains(args: DescribeDomainsCommandInput, cb: (err: any, data?: DescribeDomainsCommandOutput) => void): void; + describeDomains( args: DescribeDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDomainsCommandOutput) => void ): void; - public describeDomains( - args: DescribeDomainsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDomainsCommandOutput) => void), - cb?: (err: any, data?: DescribeDomainsCommandOutput) => void - ): Promise | void { - const command = new DescribeDomainsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

+ * @see {@link DescribeExpressionsCommand} */ - public describeExpressions( + describeExpressions( args: DescribeExpressionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeExpressions( + describeExpressions( args: DescribeExpressionsCommandInput, cb: (err: any, data?: DescribeExpressionsCommandOutput) => void ): void; - public describeExpressions( + describeExpressions( args: DescribeExpressionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExpressionsCommandOutput) => void ): void; - public describeExpressions( - args: DescribeExpressionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeExpressionsCommandOutput) => void), - cb?: (err: any, data?: DescribeExpressionsCommandOutput) => void - ): Promise | void { - const command = new DescribeExpressionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about the index fields configured for the search domain. - * Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, - * see Getting Domain Information in the Amazon CloudSearch Developer Guide.

+ * @see {@link DescribeIndexFieldsCommand} */ - public describeIndexFields( + describeIndexFields( args: DescribeIndexFieldsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeIndexFields( + describeIndexFields( args: DescribeIndexFieldsCommandInput, cb: (err: any, data?: DescribeIndexFieldsCommandOutput) => void ): void; - public describeIndexFields( + describeIndexFields( args: DescribeIndexFieldsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIndexFieldsCommandOutput) => void ): void; - public describeIndexFields( - args: DescribeIndexFieldsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeIndexFieldsCommandOutput) => void), - cb?: (err: any, data?: DescribeIndexFieldsCommandOutput) => void - ): Promise | void { - const command = new DescribeIndexFieldsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.

+ * @see {@link DescribeScalingParametersCommand} */ - public describeScalingParameters( + describeScalingParameters( args: DescribeScalingParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeScalingParameters( + describeScalingParameters( args: DescribeScalingParametersCommandInput, cb: (err: any, data?: DescribeScalingParametersCommandOutput) => void ): void; - public describeScalingParameters( + describeScalingParameters( args: DescribeScalingParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScalingParametersCommandOutput) => void ): void; - public describeScalingParameters( - args: DescribeScalingParametersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeScalingParametersCommandOutput) => void), - cb?: (err: any, data?: DescribeScalingParametersCommandOutput) => void - ): Promise | void { - const command = new DescribeScalingParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, - * see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide.

+ * @see {@link DescribeServiceAccessPoliciesCommand} */ - public describeServiceAccessPolicies( + describeServiceAccessPolicies( args: DescribeServiceAccessPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeServiceAccessPolicies( + describeServiceAccessPolicies( args: DescribeServiceAccessPoliciesCommandInput, cb: (err: any, data?: DescribeServiceAccessPoliciesCommandOutput) => void ): void; - public describeServiceAccessPolicies( + describeServiceAccessPolicies( args: DescribeServiceAccessPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeServiceAccessPoliciesCommandOutput) => void ): void; - public describeServiceAccessPolicies( - args: DescribeServiceAccessPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeServiceAccessPoliciesCommandOutput) => void), - cb?: (err: any, data?: DescribeServiceAccessPoliciesCommandOutput) => void - ): Promise | void { - const command = new DescribeServiceAccessPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

+ * @see {@link DescribeSuggestersCommand} */ - public describeSuggesters( + describeSuggesters( args: DescribeSuggestersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSuggesters( + describeSuggesters( args: DescribeSuggestersCommandInput, cb: (err: any, data?: DescribeSuggestersCommandOutput) => void ): void; - public describeSuggesters( + describeSuggesters( args: DescribeSuggestersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSuggestersCommandOutput) => void ): void; - public describeSuggesters( - args: DescribeSuggestersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSuggestersCommandOutput) => void), - cb?: (err: any, data?: DescribeSuggestersCommandOutput) => void - ): Promise | void { - const command = new DescribeSuggestersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is RequiresIndexDocuments.

+ * @see {@link IndexDocumentsCommand} */ - public indexDocuments( + indexDocuments( args: IndexDocumentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public indexDocuments( - args: IndexDocumentsCommandInput, - cb: (err: any, data?: IndexDocumentsCommandOutput) => void - ): void; - public indexDocuments( + indexDocuments(args: IndexDocumentsCommandInput, cb: (err: any, data?: IndexDocumentsCommandOutput) => void): void; + indexDocuments( args: IndexDocumentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IndexDocumentsCommandOutput) => void ): void; - public indexDocuments( - args: IndexDocumentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: IndexDocumentsCommandOutput) => void), - cb?: (err: any, data?: IndexDocumentsCommandOutput) => void - ): Promise | void { - const command = new IndexDocumentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all search domains owned by an account.

+ * @see {@link ListDomainNamesCommand} */ - public listDomainNames( + listDomainNames( args: ListDomainNamesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDomainNames( - args: ListDomainNamesCommandInput, - cb: (err: any, data?: ListDomainNamesCommandOutput) => void - ): void; - public listDomainNames( + listDomainNames(args: ListDomainNamesCommandInput, cb: (err: any, data?: ListDomainNamesCommandOutput) => void): void; + listDomainNames( args: ListDomainNamesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainNamesCommandOutput) => void ): void; - public listDomainNames( - args: ListDomainNamesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDomainNamesCommandOutput) => void), - cb?: (err: any, data?: ListDomainNamesCommandOutput) => void - ): Promise | void { - const command = new ListDomainNamesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

+ * @see {@link UpdateAvailabilityOptionsCommand} */ - public updateAvailabilityOptions( + updateAvailabilityOptions( args: UpdateAvailabilityOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAvailabilityOptions( + updateAvailabilityOptions( args: UpdateAvailabilityOptionsCommandInput, cb: (err: any, data?: UpdateAvailabilityOptionsCommandOutput) => void ): void; - public updateAvailabilityOptions( + updateAvailabilityOptions( args: UpdateAvailabilityOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAvailabilityOptionsCommandOutput) => void ): void; - public updateAvailabilityOptions( - args: UpdateAvailabilityOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAvailabilityOptionsCommandOutput) => void), - cb?: (err: any, data?: UpdateAvailabilityOptionsCommandOutput) => void - ): Promise | void { - const command = new UpdateAvailabilityOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.

+ * @see {@link UpdateDomainEndpointOptionsCommand} */ - public updateDomainEndpointOptions( + updateDomainEndpointOptions( args: UpdateDomainEndpointOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDomainEndpointOptions( + updateDomainEndpointOptions( args: UpdateDomainEndpointOptionsCommandInput, cb: (err: any, data?: UpdateDomainEndpointOptionsCommandOutput) => void ): void; - public updateDomainEndpointOptions( + updateDomainEndpointOptions( args: UpdateDomainEndpointOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDomainEndpointOptionsCommandOutput) => void ): void; - public updateDomainEndpointOptions( - args: UpdateDomainEndpointOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDomainEndpointOptionsCommandOutput) => void), - cb?: (err: any, data?: UpdateDomainEndpointOptionsCommandOutput) => void - ): Promise | void { - const command = new UpdateDomainEndpointOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.

+ * @see {@link UpdateScalingParametersCommand} */ - public updateScalingParameters( + updateScalingParameters( args: UpdateScalingParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateScalingParameters( + updateScalingParameters( args: UpdateScalingParametersCommandInput, cb: (err: any, data?: UpdateScalingParametersCommandOutput) => void ): void; - public updateScalingParameters( + updateScalingParameters( args: UpdateScalingParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateScalingParametersCommandOutput) => void ): void; - public updateScalingParameters( - args: UpdateScalingParametersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateScalingParametersCommandOutput) => void), - cb?: (err: any, data?: UpdateScalingParametersCommandOutput) => void - ): Promise | void { - const command = new UpdateScalingParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Configures the access rules that control access to the domain's document and search endpoints. - * For more information, see - * Configuring Access for an Amazon CloudSearch Domain.

+ * @see {@link UpdateServiceAccessPoliciesCommand} */ - public updateServiceAccessPolicies( + updateServiceAccessPolicies( args: UpdateServiceAccessPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateServiceAccessPolicies( + updateServiceAccessPolicies( args: UpdateServiceAccessPoliciesCommandInput, cb: (err: any, data?: UpdateServiceAccessPoliciesCommandOutput) => void ): void; - public updateServiceAccessPolicies( + updateServiceAccessPolicies( args: UpdateServiceAccessPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceAccessPoliciesCommandOutput) => void ): void; - public updateServiceAccessPolicies( - args: UpdateServiceAccessPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServiceAccessPoliciesCommandOutput) => void), - cb?: (err: any, data?: UpdateServiceAccessPoliciesCommandOutput) => void - ): Promise | void { - const command = new UpdateServiceAccessPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon CloudSearch Configuration Service + *

You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. + * Configuration service requests are submitted using the AWS Query protocol. AWS Query requests + * are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.

+ *

The endpoint for configuration service requests is region-specific: cloudsearch.region.amazonaws.com. + * For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, + * see Regions and Endpoints.

+ */ +export class CloudSearch extends CloudSearchClient implements CloudSearch {} +createAggregatedClient(commands, CloudSearch); diff --git a/clients/client-cloudtrail-data/src/CloudTrailData.ts b/clients/client-cloudtrail-data/src/CloudTrailData.ts index db671320535d..f6fd9812531a 100644 --- a/clients/client-cloudtrail-data/src/CloudTrailData.ts +++ b/clients/client-cloudtrail-data/src/CloudTrailData.ts @@ -1,57 +1,42 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CloudTrailDataClient } from "./CloudTrailDataClient"; +import { CloudTrailDataClient, CloudTrailDataClientConfig } from "./CloudTrailDataClient"; import { PutAuditEventsCommand, PutAuditEventsCommandInput, PutAuditEventsCommandOutput, } from "./commands/PutAuditEventsCommand"; -/** - * @public - *

The CloudTrail Data Service lets you ingest events into CloudTrail from any source in your - * hybrid environments, such as in-house or SaaS applications hosted on-premises or in the cloud, - * virtual machines, or containers. You can store, access, analyze, troubleshoot and take action on - * this data without maintaining multiple log aggregators and reporting tools. After you run - * PutAuditEvents to ingest your application activity into CloudTrail, you can use CloudTrail Lake to search, query, and analyze the data that is logged - * from your applications.

- */ -export class CloudTrailData extends CloudTrailDataClient { +const commands = { + PutAuditEventsCommand, +}; + +export interface CloudTrailData { /** - * @public - *

Ingests your application events into CloudTrail Lake. A required parameter, - * auditEvents, accepts the JSON records (also called - * payload) of events that you want CloudTrail to ingest. You - * can add up to 100 of these events (or up to 1 MB) per PutAuditEvents - * request.

+ * @see {@link PutAuditEventsCommand} */ - public putAuditEvents( + putAuditEvents( args: PutAuditEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAuditEvents( - args: PutAuditEventsCommandInput, - cb: (err: any, data?: PutAuditEventsCommandOutput) => void - ): void; - public putAuditEvents( + putAuditEvents(args: PutAuditEventsCommandInput, cb: (err: any, data?: PutAuditEventsCommandOutput) => void): void; + putAuditEvents( args: PutAuditEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAuditEventsCommandOutput) => void ): void; - public putAuditEvents( - args: PutAuditEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAuditEventsCommandOutput) => void), - cb?: (err: any, data?: PutAuditEventsCommandOutput) => void - ): Promise | void { - const command = new PutAuditEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The CloudTrail Data Service lets you ingest events into CloudTrail from any source in your + * hybrid environments, such as in-house or SaaS applications hosted on-premises or in the cloud, + * virtual machines, or containers. You can store, access, analyze, troubleshoot and take action on + * this data without maintaining multiple log aggregators and reporting tools. After you run + * PutAuditEvents to ingest your application activity into CloudTrail, you can use CloudTrail Lake to search, query, and analyze the data that is logged + * from your applications.

+ */ +export class CloudTrailData extends CloudTrailDataClient implements CloudTrailData {} +createAggregatedClient(commands, CloudTrailData); diff --git a/clients/client-cloudtrail/src/CloudTrail.ts b/clients/client-cloudtrail/src/CloudTrail.ts index 91f3977f20d4..bb953e76f877 100644 --- a/clients/client-cloudtrail/src/CloudTrail.ts +++ b/clients/client-cloudtrail/src/CloudTrail.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CloudTrailClient } from "./CloudTrailClient"; +import { CloudTrailClient, CloudTrailClientConfig } from "./CloudTrailClient"; import { AddTagsCommand, AddTagsCommandInput, AddTagsCommandOutput } from "./commands/AddTagsCommand"; import { CancelQueryCommand, CancelQueryCommandInput, CancelQueryCommandOutput } from "./commands/CancelQueryCommand"; import { @@ -155,1600 +156,665 @@ import { } from "./commands/UpdateEventDataStoreCommand"; import { UpdateTrailCommand, UpdateTrailCommandInput, UpdateTrailCommandOutput } from "./commands/UpdateTrailCommand"; -/** - * @public - * CloudTrail - *

This is the CloudTrail API Reference. It provides descriptions of actions, data - * types, common parameters, and common errors for CloudTrail.

- *

CloudTrail is a web service that records Amazon Web Services API calls for your - * Amazon Web Services account and delivers log files to an Amazon S3 bucket. The - * recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response - * elements returned by the service.

- * - *

As an alternative to the API, you can use one of the Amazon Web Services SDKs, which - * consist of libraries and sample code for various programming languages and platforms - * (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests, - * managing errors, and retrying requests automatically. For more information about the - * Amazon Web Services SDKs, including how to download and install them, see Tools to Build on Amazon Web Services.

- *
- *

See the CloudTrail - * User Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.

- */ -export class CloudTrail extends CloudTrailClient { +const commands = { + AddTagsCommand, + CancelQueryCommand, + CreateChannelCommand, + CreateEventDataStoreCommand, + CreateTrailCommand, + DeleteChannelCommand, + DeleteEventDataStoreCommand, + DeleteResourcePolicyCommand, + DeleteTrailCommand, + DeregisterOrganizationDelegatedAdminCommand, + DescribeQueryCommand, + DescribeTrailsCommand, + GetChannelCommand, + GetEventDataStoreCommand, + GetEventSelectorsCommand, + GetImportCommand, + GetInsightSelectorsCommand, + GetQueryResultsCommand, + GetResourcePolicyCommand, + GetTrailCommand, + GetTrailStatusCommand, + ListChannelsCommand, + ListEventDataStoresCommand, + ListImportFailuresCommand, + ListImportsCommand, + ListPublicKeysCommand, + ListQueriesCommand, + ListTagsCommand, + ListTrailsCommand, + LookupEventsCommand, + PutEventSelectorsCommand, + PutInsightSelectorsCommand, + PutResourcePolicyCommand, + RegisterOrganizationDelegatedAdminCommand, + RemoveTagsCommand, + RestoreEventDataStoreCommand, + StartImportCommand, + StartLoggingCommand, + StartQueryCommand, + StopImportCommand, + StopLoggingCommand, + UpdateChannelCommand, + UpdateEventDataStoreCommand, + UpdateTrailCommand, +}; + +export interface CloudTrail { /** - * @public - *

Adds one or more tags to a trail, event data store, or channel, up to a limit of 50. Overwrites an - * existing tag's value when a new value is specified for an existing tag key. Tag key names - * must be unique; you cannot have two keys with the same name but different - * values. If you specify a key without a value, the tag will be created with the specified - * key and a value of null. You can tag a trail or event data store that applies to all - * Amazon Web Services Regions only from the Region in which the trail or event data store - * was created (also known as its home region).

+ * @see {@link AddTagsCommand} */ - public addTags(args: AddTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public addTags(args: AddTagsCommandInput, cb: (err: any, data?: AddTagsCommandOutput) => void): void; - public addTags( + addTags(args: AddTagsCommandInput, options?: __HttpHandlerOptions): Promise; + addTags(args: AddTagsCommandInput, cb: (err: any, data?: AddTagsCommandOutput) => void): void; + addTags( args: AddTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsCommandOutput) => void ): void; - public addTags( - args: AddTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddTagsCommandOutput) => void), - cb?: (err: any, data?: AddTagsCommandOutput) => void - ): Promise | void { - const command = new AddTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels a query if the query is not in a terminated state, such as - * CANCELLED, FAILED, TIMED_OUT, or - * FINISHED. You must specify an ARN value for EventDataStore. - * The ID of the query that you want to cancel is also required. When you run - * CancelQuery, the query status might show as CANCELLED even if - * the operation is not yet finished.

+ * @see {@link CancelQueryCommand} */ - public cancelQuery(args: CancelQueryCommandInput, options?: __HttpHandlerOptions): Promise; - public cancelQuery(args: CancelQueryCommandInput, cb: (err: any, data?: CancelQueryCommandOutput) => void): void; - public cancelQuery( + cancelQuery(args: CancelQueryCommandInput, options?: __HttpHandlerOptions): Promise; + cancelQuery(args: CancelQueryCommandInput, cb: (err: any, data?: CancelQueryCommandOutput) => void): void; + cancelQuery( args: CancelQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelQueryCommandOutput) => void ): void; - public cancelQuery( - args: CancelQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelQueryCommandOutput) => void), - cb?: (err: any, data?: CancelQueryCommandOutput) => void - ): Promise | void { - const command = new CancelQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a channel for CloudTrail to ingest events from a partner or external source. - * After you create a channel, a CloudTrail Lake event data store can log events - * from the partner or source that you specify.

+ * @see {@link CreateChannelCommand} */ - public createChannel( - args: CreateChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createChannel( - args: CreateChannelCommandInput, - cb: (err: any, data?: CreateChannelCommandOutput) => void - ): void; - public createChannel( + createChannel(args: CreateChannelCommandInput, options?: __HttpHandlerOptions): Promise; + createChannel(args: CreateChannelCommandInput, cb: (err: any, data?: CreateChannelCommandOutput) => void): void; + createChannel( args: CreateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelCommandOutput) => void ): void; - public createChannel( - args: CreateChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateChannelCommandOutput) => void), - cb?: (err: any, data?: CreateChannelCommandOutput) => void - ): Promise | void { - const command = new CreateChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new event data store.

+ * @see {@link CreateEventDataStoreCommand} */ - public createEventDataStore( + createEventDataStore( args: CreateEventDataStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEventDataStore( + createEventDataStore( args: CreateEventDataStoreCommandInput, cb: (err: any, data?: CreateEventDataStoreCommandOutput) => void ): void; - public createEventDataStore( + createEventDataStore( args: CreateEventDataStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEventDataStoreCommandOutput) => void ): void; - public createEventDataStore( - args: CreateEventDataStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEventDataStoreCommandOutput) => void), - cb?: (err: any, data?: CreateEventDataStoreCommandOutput) => void - ): Promise | void { - const command = new CreateEventDataStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. - *

+ * @see {@link CreateTrailCommand} */ - public createTrail(args: CreateTrailCommandInput, options?: __HttpHandlerOptions): Promise; - public createTrail(args: CreateTrailCommandInput, cb: (err: any, data?: CreateTrailCommandOutput) => void): void; - public createTrail( + createTrail(args: CreateTrailCommandInput, options?: __HttpHandlerOptions): Promise; + createTrail(args: CreateTrailCommandInput, cb: (err: any, data?: CreateTrailCommandOutput) => void): void; + createTrail( args: CreateTrailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTrailCommandOutput) => void ): void; - public createTrail( - args: CreateTrailCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTrailCommandOutput) => void), - cb?: (err: any, data?: CreateTrailCommandOutput) => void - ): Promise | void { - const command = new CreateTrailCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a channel.

+ * @see {@link DeleteChannelCommand} */ - public deleteChannel( - args: DeleteChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteChannel( - args: DeleteChannelCommandInput, - cb: (err: any, data?: DeleteChannelCommandOutput) => void - ): void; - public deleteChannel( + deleteChannel(args: DeleteChannelCommandInput, options?: __HttpHandlerOptions): Promise; + deleteChannel(args: DeleteChannelCommandInput, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void; + deleteChannel( args: DeleteChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelCommandOutput) => void ): void; - public deleteChannel( - args: DeleteChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteChannelCommandOutput) => void), - cb?: (err: any, data?: DeleteChannelCommandOutput) => void - ): Promise | void { - const command = new DeleteChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables the event data store specified by EventDataStore, which accepts an - * event data store ARN. After you run DeleteEventDataStore, the event data store - * enters a PENDING_DELETION state, and is automatically deleted after a wait - * period of seven days. TerminationProtectionEnabled must be set to - * False on the event data store; this operation cannot work if - * TerminationProtectionEnabled is True.

- *

After you run DeleteEventDataStore on an event data store, you cannot run - * ListQueries, DescribeQuery, or GetQueryResults on - * queries that are using an event data store in a PENDING_DELETION state. An - * event data store in the PENDING_DELETION state does not incur costs.

+ * @see {@link DeleteEventDataStoreCommand} */ - public deleteEventDataStore( + deleteEventDataStore( args: DeleteEventDataStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEventDataStore( + deleteEventDataStore( args: DeleteEventDataStoreCommandInput, cb: (err: any, data?: DeleteEventDataStoreCommandOutput) => void ): void; - public deleteEventDataStore( + deleteEventDataStore( args: DeleteEventDataStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventDataStoreCommandOutput) => void ): void; - public deleteEventDataStore( - args: DeleteEventDataStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEventDataStoreCommandOutput) => void), - cb?: (err: any, data?: DeleteEventDataStoreCommandOutput) => void - ): Promise | void { - const command = new DeleteEventDataStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Deletes the resource-based policy attached to the CloudTrail channel. - *

+ * @see {@link DeleteResourcePolicyCommand} */ - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( - args: DeleteResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a trail. This operation must be called from the region in which the trail was - * created. DeleteTrail cannot be called on the shadow trails (replicated trails - * in other regions) of a trail that is enabled in all regions.

+ * @see {@link DeleteTrailCommand} */ - public deleteTrail(args: DeleteTrailCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteTrail(args: DeleteTrailCommandInput, cb: (err: any, data?: DeleteTrailCommandOutput) => void): void; - public deleteTrail( + deleteTrail(args: DeleteTrailCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTrail(args: DeleteTrailCommandInput, cb: (err: any, data?: DeleteTrailCommandOutput) => void): void; + deleteTrail( args: DeleteTrailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTrailCommandOutput) => void ): void; - public deleteTrail( - args: DeleteTrailCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTrailCommandOutput) => void), - cb?: (err: any, data?: DeleteTrailCommandOutput) => void - ): Promise | void { - const command = new DeleteTrailCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes CloudTrail delegated administrator permissions from a member account in - * an organization.

+ * @see {@link DeregisterOrganizationDelegatedAdminCommand} */ - public deregisterOrganizationDelegatedAdmin( + deregisterOrganizationDelegatedAdmin( args: DeregisterOrganizationDelegatedAdminCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterOrganizationDelegatedAdmin( + deregisterOrganizationDelegatedAdmin( args: DeregisterOrganizationDelegatedAdminCommandInput, cb: (err: any, data?: DeregisterOrganizationDelegatedAdminCommandOutput) => void ): void; - public deregisterOrganizationDelegatedAdmin( + deregisterOrganizationDelegatedAdmin( args: DeregisterOrganizationDelegatedAdminCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterOrganizationDelegatedAdminCommandOutput) => void ): void; - public deregisterOrganizationDelegatedAdmin( - args: DeregisterOrganizationDelegatedAdminCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterOrganizationDelegatedAdminCommandOutput) => void), - cb?: (err: any, data?: DeregisterOrganizationDelegatedAdminCommandOutput) => void - ): Promise | void { - const command = new DeregisterOrganizationDelegatedAdminCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns metadata about a query, including query run time in milliseconds, number of - * events scanned and matched, and query status. You must specify an ARN for - * EventDataStore, and a value for QueryID.

+ * @see {@link DescribeQueryCommand} */ - public describeQuery( - args: DescribeQueryCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeQuery( - args: DescribeQueryCommandInput, - cb: (err: any, data?: DescribeQueryCommandOutput) => void - ): void; - public describeQuery( + describeQuery(args: DescribeQueryCommandInput, options?: __HttpHandlerOptions): Promise; + describeQuery(args: DescribeQueryCommandInput, cb: (err: any, data?: DescribeQueryCommandOutput) => void): void; + describeQuery( args: DescribeQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeQueryCommandOutput) => void ): void; - public describeQuery( - args: DescribeQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeQueryCommandOutput) => void), - cb?: (err: any, data?: DescribeQueryCommandOutput) => void - ): Promise | void { - const command = new DescribeQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves settings for one or more trails associated with the current region for your - * account.

+ * @see {@link DescribeTrailsCommand} */ - public describeTrails( + describeTrails( args: DescribeTrailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTrails( - args: DescribeTrailsCommandInput, - cb: (err: any, data?: DescribeTrailsCommandOutput) => void - ): void; - public describeTrails( + describeTrails(args: DescribeTrailsCommandInput, cb: (err: any, data?: DescribeTrailsCommandOutput) => void): void; + describeTrails( args: DescribeTrailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrailsCommandOutput) => void ): void; - public describeTrails( - args: DescribeTrailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTrailsCommandOutput) => void), - cb?: (err: any, data?: DescribeTrailsCommandOutput) => void - ): Promise | void { - const command = new DescribeTrailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a specific channel. - *

+ * @see {@link GetChannelCommand} */ - public getChannel(args: GetChannelCommandInput, options?: __HttpHandlerOptions): Promise; - public getChannel(args: GetChannelCommandInput, cb: (err: any, data?: GetChannelCommandOutput) => void): void; - public getChannel( + getChannel(args: GetChannelCommandInput, options?: __HttpHandlerOptions): Promise; + getChannel(args: GetChannelCommandInput, cb: (err: any, data?: GetChannelCommandOutput) => void): void; + getChannel( args: GetChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelCommandOutput) => void ): void; - public getChannel( - args: GetChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetChannelCommandOutput) => void), - cb?: (err: any, data?: GetChannelCommandOutput) => void - ): Promise | void { - const command = new GetChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about an event data store specified as either an ARN or the ID - * portion of the ARN.

+ * @see {@link GetEventDataStoreCommand} */ - public getEventDataStore( + getEventDataStore( args: GetEventDataStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEventDataStore( + getEventDataStore( args: GetEventDataStoreCommandInput, cb: (err: any, data?: GetEventDataStoreCommandOutput) => void ): void; - public getEventDataStore( + getEventDataStore( args: GetEventDataStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEventDataStoreCommandOutput) => void ): void; - public getEventDataStore( - args: GetEventDataStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEventDataStoreCommandOutput) => void), - cb?: (err: any, data?: GetEventDataStoreCommandOutput) => void - ): Promise | void { - const command = new GetEventDataStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the settings for the event selectors that you configured for your trail. The - * information returned for your event selectors includes the following:

- *
    - *
  • - *

    If your event selector includes read-only events, write-only events, or all - * events. This applies to both management events and data events.

    - *
  • - *
  • - *

    If your event selector includes management events.

    - *
  • - *
  • - *

    If your event selector includes data events, the resources on which you are - * logging data events.

    - *
  • - *
- *

For more information about logging management and data events, see the following topics - * in the CloudTrail User Guide:

- * + * @see {@link GetEventSelectorsCommand} */ - public getEventSelectors( + getEventSelectors( args: GetEventSelectorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEventSelectors( + getEventSelectors( args: GetEventSelectorsCommandInput, cb: (err: any, data?: GetEventSelectorsCommandOutput) => void ): void; - public getEventSelectors( + getEventSelectors( args: GetEventSelectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEventSelectorsCommandOutput) => void ): void; - public getEventSelectors( - args: GetEventSelectorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEventSelectorsCommandOutput) => void), - cb?: (err: any, data?: GetEventSelectorsCommandOutput) => void - ): Promise | void { - const command = new GetEventSelectorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a specific import.

+ * @see {@link GetImportCommand} */ - public getImport(args: GetImportCommandInput, options?: __HttpHandlerOptions): Promise; - public getImport(args: GetImportCommandInput, cb: (err: any, data?: GetImportCommandOutput) => void): void; - public getImport( + getImport(args: GetImportCommandInput, options?: __HttpHandlerOptions): Promise; + getImport(args: GetImportCommandInput, cb: (err: any, data?: GetImportCommandOutput) => void): void; + getImport( args: GetImportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetImportCommandOutput) => void ): void; - public getImport( - args: GetImportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetImportCommandOutput) => void), - cb?: (err: any, data?: GetImportCommandOutput) => void - ): Promise | void { - const command = new GetImportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the settings for the Insights event selectors that you configured for your - * trail. GetInsightSelectors shows if CloudTrail Insights event logging - * is enabled on the trail, and if it is, which insight types are enabled. If you run - * GetInsightSelectors on a trail that does not have Insights events enabled, - * the operation throws the exception InsightNotEnabledException - *

- *

For more information, see Logging CloudTrail Insights Events for Trails in the CloudTrail User Guide.

+ * @see {@link GetInsightSelectorsCommand} */ - public getInsightSelectors( + getInsightSelectors( args: GetInsightSelectorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInsightSelectors( + getInsightSelectors( args: GetInsightSelectorsCommandInput, cb: (err: any, data?: GetInsightSelectorsCommandOutput) => void ): void; - public getInsightSelectors( + getInsightSelectors( args: GetInsightSelectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInsightSelectorsCommandOutput) => void ): void; - public getInsightSelectors( - args: GetInsightSelectorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInsightSelectorsCommandOutput) => void), - cb?: (err: any, data?: GetInsightSelectorsCommandOutput) => void - ): Promise | void { - const command = new GetInsightSelectorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets event data results of a query. You must specify the QueryID value - * returned by the StartQuery operation, and an ARN for - * EventDataStore.

+ * @see {@link GetQueryResultsCommand} */ - public getQueryResults( + getQueryResults( args: GetQueryResultsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getQueryResults( - args: GetQueryResultsCommandInput, - cb: (err: any, data?: GetQueryResultsCommandOutput) => void - ): void; - public getQueryResults( + getQueryResults(args: GetQueryResultsCommandInput, cb: (err: any, data?: GetQueryResultsCommandOutput) => void): void; + getQueryResults( args: GetQueryResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueryResultsCommandOutput) => void ): void; - public getQueryResults( - args: GetQueryResultsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetQueryResultsCommandOutput) => void), - cb?: (err: any, data?: GetQueryResultsCommandOutput) => void - ): Promise | void { - const command = new GetQueryResultsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel. - *

+ * @see {@link GetResourcePolicyCommand} */ - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void ): void; - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void ): void; - public getResourcePolicy( - args: GetResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: GetResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new GetResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns settings information for a specified trail.

+ * @see {@link GetTrailCommand} */ - public getTrail(args: GetTrailCommandInput, options?: __HttpHandlerOptions): Promise; - public getTrail(args: GetTrailCommandInput, cb: (err: any, data?: GetTrailCommandOutput) => void): void; - public getTrail( + getTrail(args: GetTrailCommandInput, options?: __HttpHandlerOptions): Promise; + getTrail(args: GetTrailCommandInput, cb: (err: any, data?: GetTrailCommandOutput) => void): void; + getTrail( args: GetTrailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTrailCommandOutput) => void ): void; - public getTrail( - args: GetTrailCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTrailCommandOutput) => void), - cb?: (err: any, data?: GetTrailCommandOutput) => void - ): Promise | void { - const command = new GetTrailCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a JSON-formatted list of information about the specified trail. Fields include - * information on delivery errors, Amazon SNS and Amazon S3 errors, and start - * and stop logging times for each trail. This operation returns trail status from a single - * region. To return trail status from all regions, you must call the operation on each - * region.

+ * @see {@link GetTrailStatusCommand} */ - public getTrailStatus( + getTrailStatus( args: GetTrailStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTrailStatus( - args: GetTrailStatusCommandInput, - cb: (err: any, data?: GetTrailStatusCommandOutput) => void - ): void; - public getTrailStatus( + getTrailStatus(args: GetTrailStatusCommandInput, cb: (err: any, data?: GetTrailStatusCommandOutput) => void): void; + getTrailStatus( args: GetTrailStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTrailStatusCommandOutput) => void ): void; - public getTrailStatus( - args: GetTrailStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTrailStatusCommandOutput) => void), - cb?: (err: any, data?: GetTrailStatusCommandOutput) => void - ): Promise | void { - const command = new GetTrailStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the channels in the current account, and their source names. - *

+ * @see {@link ListChannelsCommand} */ - public listChannels( - args: ListChannelsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void; - public listChannels( + listChannels(args: ListChannelsCommandInput, options?: __HttpHandlerOptions): Promise; + listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void; + listChannels( args: ListChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsCommandOutput) => void ): void; - public listChannels( - args: ListChannelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListChannelsCommandOutput) => void), - cb?: (err: any, data?: ListChannelsCommandOutput) => void - ): Promise | void { - const command = new ListChannelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about all event data stores in the account, in the current - * region.

+ * @see {@link ListEventDataStoresCommand} */ - public listEventDataStores( + listEventDataStores( args: ListEventDataStoresCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEventDataStores( + listEventDataStores( args: ListEventDataStoresCommandInput, cb: (err: any, data?: ListEventDataStoresCommandOutput) => void ): void; - public listEventDataStores( + listEventDataStores( args: ListEventDataStoresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventDataStoresCommandOutput) => void ): void; - public listEventDataStores( - args: ListEventDataStoresCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEventDataStoresCommandOutput) => void), - cb?: (err: any, data?: ListEventDataStoresCommandOutput) => void - ): Promise | void { - const command = new ListEventDataStoresCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of failures for the specified import.

+ * @see {@link ListImportFailuresCommand} */ - public listImportFailures( + listImportFailures( args: ListImportFailuresCommandInput, options?: __HttpHandlerOptions ): Promise; - public listImportFailures( + listImportFailures( args: ListImportFailuresCommandInput, cb: (err: any, data?: ListImportFailuresCommandOutput) => void ): void; - public listImportFailures( + listImportFailures( args: ListImportFailuresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImportFailuresCommandOutput) => void ): void; - public listImportFailures( - args: ListImportFailuresCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListImportFailuresCommandOutput) => void), - cb?: (err: any, data?: ListImportFailuresCommandOutput) => void - ): Promise | void { - const command = new ListImportFailuresCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information on all imports, or a select set of imports by - * ImportStatus or Destination.

+ * @see {@link ListImportsCommand} */ - public listImports(args: ListImportsCommandInput, options?: __HttpHandlerOptions): Promise; - public listImports(args: ListImportsCommandInput, cb: (err: any, data?: ListImportsCommandOutput) => void): void; - public listImports( + listImports(args: ListImportsCommandInput, options?: __HttpHandlerOptions): Promise; + listImports(args: ListImportsCommandInput, cb: (err: any, data?: ListImportsCommandOutput) => void): void; + listImports( args: ListImportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImportsCommandOutput) => void ): void; - public listImports( - args: ListImportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListImportsCommandOutput) => void), - cb?: (err: any, data?: ListImportsCommandOutput) => void - ): Promise | void { - const command = new ListImportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns all public keys whose private keys were used to sign the digest files within the - * specified time range. The public key is needed to validate digest files that were signed - * with its corresponding private key.

- * - *

CloudTrail uses different private and public key pairs per region. Each digest - * file is signed with a private key unique to its region. When you validate a digest file - * from a specific region, you must look in the same region for its corresponding public - * key.

- *
+ * @see {@link ListPublicKeysCommand} */ - public listPublicKeys( + listPublicKeys( args: ListPublicKeysCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPublicKeys( - args: ListPublicKeysCommandInput, - cb: (err: any, data?: ListPublicKeysCommandOutput) => void - ): void; - public listPublicKeys( + listPublicKeys(args: ListPublicKeysCommandInput, cb: (err: any, data?: ListPublicKeysCommandOutput) => void): void; + listPublicKeys( args: ListPublicKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPublicKeysCommandOutput) => void ): void; - public listPublicKeys( - args: ListPublicKeysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPublicKeysCommandOutput) => void), - cb?: (err: any, data?: ListPublicKeysCommandOutput) => void - ): Promise | void { - const command = new ListPublicKeysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of queries and query statuses for the past seven days. You must specify - * an ARN value for EventDataStore. Optionally, to shorten the list of results, - * you can specify a time range, formatted as timestamps, by adding StartTime and - * EndTime parameters, and a QueryStatus value. Valid values for - * QueryStatus include QUEUED, RUNNING, - * FINISHED, FAILED, TIMED_OUT, or - * CANCELLED.

+ * @see {@link ListQueriesCommand} */ - public listQueries(args: ListQueriesCommandInput, options?: __HttpHandlerOptions): Promise; - public listQueries(args: ListQueriesCommandInput, cb: (err: any, data?: ListQueriesCommandOutput) => void): void; - public listQueries( + listQueries(args: ListQueriesCommandInput, options?: __HttpHandlerOptions): Promise; + listQueries(args: ListQueriesCommandInput, cb: (err: any, data?: ListQueriesCommandOutput) => void): void; + listQueries( args: ListQueriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQueriesCommandOutput) => void ): void; - public listQueries( - args: ListQueriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListQueriesCommandOutput) => void), - cb?: (err: any, data?: ListQueriesCommandOutput) => void - ): Promise | void { - const command = new ListQueriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags for the trail, event data store, or channel in the current region.

+ * @see {@link ListTagsCommand} */ - public listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; - public listTags( + listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; + listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; + listTags( args: ListTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsCommandOutput) => void ): void; - public listTags( - args: ListTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsCommandOutput) => void), - cb?: (err: any, data?: ListTagsCommandOutput) => void - ): Promise | void { - const command = new ListTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists trails that are in the current account.

+ * @see {@link ListTrailsCommand} */ - public listTrails(args: ListTrailsCommandInput, options?: __HttpHandlerOptions): Promise; - public listTrails(args: ListTrailsCommandInput, cb: (err: any, data?: ListTrailsCommandOutput) => void): void; - public listTrails( + listTrails(args: ListTrailsCommandInput, options?: __HttpHandlerOptions): Promise; + listTrails(args: ListTrailsCommandInput, cb: (err: any, data?: ListTrailsCommandOutput) => void): void; + listTrails( args: ListTrailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTrailsCommandOutput) => void ): void; - public listTrails( - args: ListTrailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTrailsCommandOutput) => void), - cb?: (err: any, data?: ListTrailsCommandOutput) => void - ): Promise | void { - const command = new ListTrailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Looks up management events or CloudTrail Insights events that are captured by CloudTrail. - * You can look up events that occurred in a region within the last 90 days. Lookup supports - * the following attributes for management events:

- *
    - *
  • - *

    Amazon Web Services access key

    - *
  • - *
  • - *

    Event ID

    - *
  • - *
  • - *

    Event name

    - *
  • - *
  • - *

    Event source

    - *
  • - *
  • - *

    Read only

    - *
  • - *
  • - *

    Resource name

    - *
  • - *
  • - *

    Resource type

    - *
  • - *
  • - *

    User name

    - *
  • - *
- *

Lookup supports the following attributes for Insights events:

- *
    - *
  • - *

    Event ID

    - *
  • - *
  • - *

    Event name

    - *
  • - *
  • - *

    Event source

    - *
  • - *
- *

All attributes are optional. The default number of results returned is 50, with a - * maximum of 50 possible. The response includes a token that you can use to get the next page - * of results.

- * - *

The rate of lookup requests is limited to two per second, per account, per region. If - * this limit is exceeded, a throttling error occurs.

- *
+ * @see {@link LookupEventsCommand} */ - public lookupEvents( - args: LookupEventsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public lookupEvents(args: LookupEventsCommandInput, cb: (err: any, data?: LookupEventsCommandOutput) => void): void; - public lookupEvents( + lookupEvents(args: LookupEventsCommandInput, options?: __HttpHandlerOptions): Promise; + lookupEvents(args: LookupEventsCommandInput, cb: (err: any, data?: LookupEventsCommandOutput) => void): void; + lookupEvents( args: LookupEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: LookupEventsCommandOutput) => void ): void; - public lookupEvents( - args: LookupEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: LookupEventsCommandOutput) => void), - cb?: (err: any, data?: LookupEventsCommandOutput) => void - ): Promise | void { - const command = new LookupEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Configures an event selector or advanced event selectors for your trail. Use event - * selectors or advanced event selectors to specify management and data event settings for - * your trail. By default, trails created without specific event selectors are configured to - * log all read and write management events, and no data events.

- *

When an event occurs in your account, CloudTrail evaluates the event selectors or - * advanced event selectors in all trails. For each trail, if the event matches any event - * selector, the trail processes and logs the event. If the event doesn't match any event - * selector, the trail doesn't log the event.

- *

Example

- *
    - *
  1. - *

    You create an event selector for a trail and specify that you want write-only - * events.

    - *
  2. - *
  3. - *

    The EC2 GetConsoleOutput and RunInstances API operations - * occur in your account.

    - *
  4. - *
  5. - *

    CloudTrail evaluates whether the events match your event selectors.

    - *
  6. - *
  7. - *

    The RunInstances is a write-only event and it matches your event - * selector. The trail logs the event.

    - *
  8. - *
  9. - *

    The GetConsoleOutput is a read-only event that doesn't match your - * event selector. The trail doesn't log the event.

    - *
  10. - *
- *

The PutEventSelectors operation must be called from the region in which the - * trail was created; otherwise, an InvalidHomeRegionException exception is - * thrown.

- *

You can configure up to five event selectors for each trail. For more information, see - * Logging management events for trails , Logging - * data events for trails , and Quotas in CloudTrail in the CloudTrail User - * Guide.

- *

You can add advanced event selectors, and conditions for your advanced event selectors, - * up to a maximum of 500 values for all conditions and selectors on a trail. You can use - * either AdvancedEventSelectors or EventSelectors, but not both. If - * you apply AdvancedEventSelectors to a trail, any existing - * EventSelectors are overwritten. For more information about advanced event - * selectors, see Logging data events for trails in the CloudTrail User Guide.

+ * @see {@link PutEventSelectorsCommand} */ - public putEventSelectors( + putEventSelectors( args: PutEventSelectorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putEventSelectors( + putEventSelectors( args: PutEventSelectorsCommandInput, cb: (err: any, data?: PutEventSelectorsCommandOutput) => void ): void; - public putEventSelectors( + putEventSelectors( args: PutEventSelectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEventSelectorsCommandOutput) => void ): void; - public putEventSelectors( - args: PutEventSelectorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutEventSelectorsCommandOutput) => void), - cb?: (err: any, data?: PutEventSelectorsCommandOutput) => void - ): Promise | void { - const command = new PutEventSelectorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lets you enable Insights event logging by specifying the Insights selectors that you - * want to enable on an existing trail. You also use PutInsightSelectors to turn - * off Insights event logging, by passing an empty list of insight types. The valid Insights - * event types in this release are ApiErrorRateInsight and - * ApiCallRateInsight.

+ * @see {@link PutInsightSelectorsCommand} */ - public putInsightSelectors( + putInsightSelectors( args: PutInsightSelectorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putInsightSelectors( + putInsightSelectors( args: PutInsightSelectorsCommandInput, cb: (err: any, data?: PutInsightSelectorsCommandOutput) => void ): void; - public putInsightSelectors( + putInsightSelectors( args: PutInsightSelectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutInsightSelectorsCommandOutput) => void ): void; - public putInsightSelectors( - args: PutInsightSelectorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutInsightSelectorsCommandOutput) => void), - cb?: (err: any, data?: PutInsightSelectorsCommandOutput) => void - ): Promise | void { - const command = new PutInsightSelectorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Attaches a resource-based permission policy to a CloudTrail channel that is used for an integration with an event source outside of Amazon Web Services. For more information about resource-based policies, see - * CloudTrail resource-based policy examples - * in the CloudTrail User Guide. - *

+ * @see {@link PutResourcePolicyCommand} */ - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( - args: PutResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: PutResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new PutResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers an organization’s member account as the CloudTrail delegated - * administrator.

+ * @see {@link RegisterOrganizationDelegatedAdminCommand} */ - public registerOrganizationDelegatedAdmin( + registerOrganizationDelegatedAdmin( args: RegisterOrganizationDelegatedAdminCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerOrganizationDelegatedAdmin( + registerOrganizationDelegatedAdmin( args: RegisterOrganizationDelegatedAdminCommandInput, cb: (err: any, data?: RegisterOrganizationDelegatedAdminCommandOutput) => void ): void; - public registerOrganizationDelegatedAdmin( + registerOrganizationDelegatedAdmin( args: RegisterOrganizationDelegatedAdminCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterOrganizationDelegatedAdminCommandOutput) => void ): void; - public registerOrganizationDelegatedAdmin( - args: RegisterOrganizationDelegatedAdminCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterOrganizationDelegatedAdminCommandOutput) => void), - cb?: (err: any, data?: RegisterOrganizationDelegatedAdminCommandOutput) => void - ): Promise | void { - const command = new RegisterOrganizationDelegatedAdminCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified tags from a trail, event data store, or channel.

+ * @see {@link RemoveTagsCommand} */ - public removeTags(args: RemoveTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public removeTags(args: RemoveTagsCommandInput, cb: (err: any, data?: RemoveTagsCommandOutput) => void): void; - public removeTags( + removeTags(args: RemoveTagsCommandInput, options?: __HttpHandlerOptions): Promise; + removeTags(args: RemoveTagsCommandInput, cb: (err: any, data?: RemoveTagsCommandOutput) => void): void; + removeTags( args: RemoveTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsCommandOutput) => void ): void; - public removeTags( - args: RemoveTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveTagsCommandOutput) => void), - cb?: (err: any, data?: RemoveTagsCommandOutput) => void - ): Promise | void { - const command = new RemoveTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Restores a deleted event data store specified by EventDataStore, which - * accepts an event data store ARN. You can only restore a deleted event data store within the - * seven-day wait period after deletion. Restoring an event data store can take several - * minutes, depending on the size of the event data store.

+ * @see {@link RestoreEventDataStoreCommand} */ - public restoreEventDataStore( + restoreEventDataStore( args: RestoreEventDataStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreEventDataStore( + restoreEventDataStore( args: RestoreEventDataStoreCommandInput, cb: (err: any, data?: RestoreEventDataStoreCommandOutput) => void ): void; - public restoreEventDataStore( + restoreEventDataStore( args: RestoreEventDataStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreEventDataStoreCommandOutput) => void ): void; - public restoreEventDataStore( - args: RestoreEventDataStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreEventDataStoreCommandOutput) => void), - cb?: (err: any, data?: RestoreEventDataStoreCommandOutput) => void - ): Promise | void { - const command = new RestoreEventDataStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts an import of logged trail events from a source S3 bucket to a destination event - * data store. By default, CloudTrail only imports events contained in the S3 bucket's - * CloudTrail prefix and the prefixes inside the CloudTrail prefix, and does not check prefixes for other Amazon Web Services - * services. If you want to import CloudTrail events contained in another prefix, you - * must include the prefix in the S3LocationUri. For more considerations about - * importing trail events, see Considerations.

- *

When you start a new import, the Destinations and - * ImportSource parameters are required. Before starting a new import, disable - * any access control lists (ACLs) attached to the source S3 bucket. For more information - * about disabling ACLs, see Controlling ownership of - * objects and disabling ACLs for your bucket.

- *

When you retry an import, the ImportID parameter is required.

- * - *

If the destination event data store is for an organization, you must use the - * management account to import trail events. You cannot use the delegated administrator - * account for the organization.

- *
+ * @see {@link StartImportCommand} */ - public startImport(args: StartImportCommandInput, options?: __HttpHandlerOptions): Promise; - public startImport(args: StartImportCommandInput, cb: (err: any, data?: StartImportCommandOutput) => void): void; - public startImport( + startImport(args: StartImportCommandInput, options?: __HttpHandlerOptions): Promise; + startImport(args: StartImportCommandInput, cb: (err: any, data?: StartImportCommandOutput) => void): void; + startImport( args: StartImportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartImportCommandOutput) => void ): void; - public startImport( - args: StartImportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartImportCommandOutput) => void), - cb?: (err: any, data?: StartImportCommandOutput) => void - ): Promise | void { - const command = new StartImportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts the recording of Amazon Web Services API calls and log file delivery for a trail. - * For a trail that is enabled in all regions, this operation must be called from the region - * in which the trail was created. This operation cannot be called on the shadow trails - * (replicated trails in other regions) of a trail that is enabled in all regions.

+ * @see {@link StartLoggingCommand} */ - public startLogging( - args: StartLoggingCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public startLogging(args: StartLoggingCommandInput, cb: (err: any, data?: StartLoggingCommandOutput) => void): void; - public startLogging( + startLogging(args: StartLoggingCommandInput, options?: __HttpHandlerOptions): Promise; + startLogging(args: StartLoggingCommandInput, cb: (err: any, data?: StartLoggingCommandOutput) => void): void; + startLogging( args: StartLoggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartLoggingCommandOutput) => void ): void; - public startLogging( - args: StartLoggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartLoggingCommandOutput) => void), - cb?: (err: any, data?: StartLoggingCommandOutput) => void - ): Promise | void { - const command = new StartLoggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a CloudTrail Lake query. The required QueryStatement - * parameter provides your SQL query, enclosed in single quotation marks. Use the optional - * DeliveryS3Uri parameter to deliver the query results to an S3 - * bucket.

+ * @see {@link StartQueryCommand} */ - public startQuery(args: StartQueryCommandInput, options?: __HttpHandlerOptions): Promise; - public startQuery(args: StartQueryCommandInput, cb: (err: any, data?: StartQueryCommandOutput) => void): void; - public startQuery( + startQuery(args: StartQueryCommandInput, options?: __HttpHandlerOptions): Promise; + startQuery(args: StartQueryCommandInput, cb: (err: any, data?: StartQueryCommandOutput) => void): void; + startQuery( args: StartQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartQueryCommandOutput) => void ): void; - public startQuery( - args: StartQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartQueryCommandOutput) => void), - cb?: (err: any, data?: StartQueryCommandOutput) => void - ): Promise | void { - const command = new StartQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops a specified import.

+ * @see {@link StopImportCommand} */ - public stopImport(args: StopImportCommandInput, options?: __HttpHandlerOptions): Promise; - public stopImport(args: StopImportCommandInput, cb: (err: any, data?: StopImportCommandOutput) => void): void; - public stopImport( + stopImport(args: StopImportCommandInput, options?: __HttpHandlerOptions): Promise; + stopImport(args: StopImportCommandInput, cb: (err: any, data?: StopImportCommandOutput) => void): void; + stopImport( args: StopImportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopImportCommandOutput) => void ): void; - public stopImport( - args: StopImportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopImportCommandOutput) => void), - cb?: (err: any, data?: StopImportCommandOutput) => void - ): Promise | void { - const command = new StopImportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Suspends the recording of Amazon Web Services API calls and log file delivery for the - * specified trail. Under most circumstances, there is no need to use this action. You can - * update a trail without stopping it first. This action is the only way to stop recording. - * For a trail enabled in all regions, this operation must be called from the region in which - * the trail was created, or an InvalidHomeRegionException will occur. This - * operation cannot be called on the shadow trails (replicated trails in other regions) of a - * trail enabled in all regions.

+ * @see {@link StopLoggingCommand} */ - public stopLogging(args: StopLoggingCommandInput, options?: __HttpHandlerOptions): Promise; - public stopLogging(args: StopLoggingCommandInput, cb: (err: any, data?: StopLoggingCommandOutput) => void): void; - public stopLogging( + stopLogging(args: StopLoggingCommandInput, options?: __HttpHandlerOptions): Promise; + stopLogging(args: StopLoggingCommandInput, cb: (err: any, data?: StopLoggingCommandOutput) => void): void; + stopLogging( args: StopLoggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopLoggingCommandOutput) => void ): void; - public stopLogging( - args: StopLoggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopLoggingCommandOutput) => void), - cb?: (err: any, data?: StopLoggingCommandOutput) => void - ): Promise | void { - const command = new StopLoggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a channel specified by a required channel ARN or UUID.

+ * @see {@link UpdateChannelCommand} */ - public updateChannel( - args: UpdateChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateChannel( - args: UpdateChannelCommandInput, - cb: (err: any, data?: UpdateChannelCommandOutput) => void - ): void; - public updateChannel( + updateChannel(args: UpdateChannelCommandInput, options?: __HttpHandlerOptions): Promise; + updateChannel(args: UpdateChannelCommandInput, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void; + updateChannel( args: UpdateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelCommandOutput) => void ): void; - public updateChannel( - args: UpdateChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateChannelCommandOutput) => void), - cb?: (err: any, data?: UpdateChannelCommandOutput) => void - ): Promise | void { - const command = new UpdateChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an event data store. The required EventDataStore value is an ARN or - * the ID portion of the ARN. Other parameters are optional, but at least one optional - * parameter must be specified, or CloudTrail throws an error. - * RetentionPeriod is in days, and valid values are integers between 90 and - * 2557. By default, TerminationProtection is enabled.

- *

For event data stores for CloudTrail events, AdvancedEventSelectors - * includes or excludes management and data events in your event data store. For more - * information about AdvancedEventSelectors, see PutEventSelectorsRequest$AdvancedEventSelectors.

- *

For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, - * AdvancedEventSelectors includes events of that type in your event data - * store.

+ * @see {@link UpdateEventDataStoreCommand} */ - public updateEventDataStore( + updateEventDataStore( args: UpdateEventDataStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEventDataStore( + updateEventDataStore( args: UpdateEventDataStoreCommandInput, cb: (err: any, data?: UpdateEventDataStoreCommandOutput) => void ): void; - public updateEventDataStore( + updateEventDataStore( args: UpdateEventDataStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEventDataStoreCommandOutput) => void ): void; - public updateEventDataStore( - args: UpdateEventDataStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEventDataStoreCommandOutput) => void), - cb?: (err: any, data?: UpdateEventDataStoreCommandOutput) => void - ): Promise | void { - const command = new UpdateEventDataStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates trail settings that control what events you are logging, and how to handle log - * files. Changes to a trail do not require stopping the CloudTrail service. Use this - * action to designate an existing bucket for log delivery. If the existing bucket has - * previously been a target for CloudTrail log files, an IAM policy - * exists for the bucket. UpdateTrail must be called from the region in which the - * trail was created; otherwise, an InvalidHomeRegionException is thrown.

+ * @see {@link UpdateTrailCommand} */ - public updateTrail(args: UpdateTrailCommandInput, options?: __HttpHandlerOptions): Promise; - public updateTrail(args: UpdateTrailCommandInput, cb: (err: any, data?: UpdateTrailCommandOutput) => void): void; - public updateTrail( + updateTrail(args: UpdateTrailCommandInput, options?: __HttpHandlerOptions): Promise; + updateTrail(args: UpdateTrailCommandInput, cb: (err: any, data?: UpdateTrailCommandOutput) => void): void; + updateTrail( args: UpdateTrailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTrailCommandOutput) => void ): void; - public updateTrail( - args: UpdateTrailCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTrailCommandOutput) => void), - cb?: (err: any, data?: UpdateTrailCommandOutput) => void - ): Promise | void { - const command = new UpdateTrailCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * CloudTrail + *

This is the CloudTrail API Reference. It provides descriptions of actions, data + * types, common parameters, and common errors for CloudTrail.

+ *

CloudTrail is a web service that records Amazon Web Services API calls for your + * Amazon Web Services account and delivers log files to an Amazon S3 bucket. The + * recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response + * elements returned by the service.

+ * + *

As an alternative to the API, you can use one of the Amazon Web Services SDKs, which + * consist of libraries and sample code for various programming languages and platforms + * (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests, + * managing errors, and retrying requests automatically. For more information about the + * Amazon Web Services SDKs, including how to download and install them, see Tools to Build on Amazon Web Services.

+ *
+ *

See the CloudTrail + * User Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.

+ */ +export class CloudTrail extends CloudTrailClient implements CloudTrail {} +createAggregatedClient(commands, CloudTrail); diff --git a/clients/client-cloudwatch-events/src/CloudWatchEvents.ts b/clients/client-cloudwatch-events/src/CloudWatchEvents.ts index 4dfce5591873..66da168d670d 100644 --- a/clients/client-cloudwatch-events/src/CloudWatchEvents.ts +++ b/clients/client-cloudwatch-events/src/CloudWatchEvents.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CloudWatchEventsClient } from "./CloudWatchEventsClient"; +import { CloudWatchEventsClient, CloudWatchEventsClientConfig } from "./CloudWatchEventsClient"; import { ActivateEventSourceCommand, ActivateEventSourceCommandInput, @@ -218,2002 +219,820 @@ import { UpdateConnectionCommandOutput, } from "./commands/UpdateConnectionCommand"; -/** - * @public - *

Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your - * resources change state, they automatically send events to an event stream. You can create - * rules that match selected events in the stream and route them to targets to take action. You - * can also use rules to take action on a predetermined schedule. For example, you can configure - * rules to:

- *
    - *
  • - *

    Automatically invoke an Lambda function to update DNS entries when an event - * notifies you that Amazon EC2 instance enters the running state.

    - *
  • - *
  • - *

    Direct specific API records from CloudTrail to an Amazon Kinesis data stream for - * detailed analysis of potential security or availability risks.

    - *
  • - *
  • - *

    Periodically invoke a built-in target to create a snapshot of an Amazon EBS - * volume.

    - *
  • - *
- *

For more information about the features of Amazon EventBridge, see the Amazon EventBridge User - * Guide.

- */ -export class CloudWatchEvents extends CloudWatchEventsClient { +const commands = { + ActivateEventSourceCommand, + CancelReplayCommand, + CreateApiDestinationCommand, + CreateArchiveCommand, + CreateConnectionCommand, + CreateEventBusCommand, + CreatePartnerEventSourceCommand, + DeactivateEventSourceCommand, + DeauthorizeConnectionCommand, + DeleteApiDestinationCommand, + DeleteArchiveCommand, + DeleteConnectionCommand, + DeleteEventBusCommand, + DeletePartnerEventSourceCommand, + DeleteRuleCommand, + DescribeApiDestinationCommand, + DescribeArchiveCommand, + DescribeConnectionCommand, + DescribeEventBusCommand, + DescribeEventSourceCommand, + DescribePartnerEventSourceCommand, + DescribeReplayCommand, + DescribeRuleCommand, + DisableRuleCommand, + EnableRuleCommand, + ListApiDestinationsCommand, + ListArchivesCommand, + ListConnectionsCommand, + ListEventBusesCommand, + ListEventSourcesCommand, + ListPartnerEventSourceAccountsCommand, + ListPartnerEventSourcesCommand, + ListReplaysCommand, + ListRuleNamesByTargetCommand, + ListRulesCommand, + ListTagsForResourceCommand, + ListTargetsByRuleCommand, + PutEventsCommand, + PutPartnerEventsCommand, + PutPermissionCommand, + PutRuleCommand, + PutTargetsCommand, + RemovePermissionCommand, + RemoveTargetsCommand, + StartReplayCommand, + TagResourceCommand, + TestEventPatternCommand, + UntagResourceCommand, + UpdateApiDestinationCommand, + UpdateArchiveCommand, + UpdateConnectionCommand, +}; + +export interface CloudWatchEvents { /** - * @public - *

Activates a partner event source that has been deactivated. Once activated, your matching - * event bus will start receiving events from the event source.

+ * @see {@link ActivateEventSourceCommand} */ - public activateEventSource( + activateEventSource( args: ActivateEventSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public activateEventSource( + activateEventSource( args: ActivateEventSourceCommandInput, cb: (err: any, data?: ActivateEventSourceCommandOutput) => void ): void; - public activateEventSource( + activateEventSource( args: ActivateEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ActivateEventSourceCommandOutput) => void ): void; - public activateEventSource( - args: ActivateEventSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ActivateEventSourceCommandOutput) => void), - cb?: (err: any, data?: ActivateEventSourceCommandOutput) => void - ): Promise | void { - const command = new ActivateEventSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels the specified replay.

+ * @see {@link CancelReplayCommand} */ - public cancelReplay( - args: CancelReplayCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public cancelReplay(args: CancelReplayCommandInput, cb: (err: any, data?: CancelReplayCommandOutput) => void): void; - public cancelReplay( + cancelReplay(args: CancelReplayCommandInput, options?: __HttpHandlerOptions): Promise; + cancelReplay(args: CancelReplayCommandInput, cb: (err: any, data?: CancelReplayCommandOutput) => void): void; + cancelReplay( args: CancelReplayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelReplayCommandOutput) => void ): void; - public cancelReplay( - args: CancelReplayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelReplayCommandOutput) => void), - cb?: (err: any, data?: CancelReplayCommandOutput) => void - ): Promise | void { - const command = new CancelReplayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an API destination, which is an HTTP invocation endpoint configured as a target - * for events.

+ * @see {@link CreateApiDestinationCommand} */ - public createApiDestination( + createApiDestination( args: CreateApiDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApiDestination( + createApiDestination( args: CreateApiDestinationCommandInput, cb: (err: any, data?: CreateApiDestinationCommandOutput) => void ): void; - public createApiDestination( + createApiDestination( args: CreateApiDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApiDestinationCommandOutput) => void ): void; - public createApiDestination( - args: CreateApiDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApiDestinationCommandOutput) => void), - cb?: (err: any, data?: CreateApiDestinationCommandOutput) => void - ): Promise | void { - const command = new CreateApiDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an archive of events with the specified settings. When you create an archive, - * incoming events might not immediately start being sent to the archive. Allow a short period of - * time for changes to take effect. If you do not specify a pattern to filter events sent to the - * archive, all events are sent to the archive except replayed events. Replayed events are not - * sent to an archive.

+ * @see {@link CreateArchiveCommand} */ - public createArchive( - args: CreateArchiveCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createArchive( - args: CreateArchiveCommandInput, - cb: (err: any, data?: CreateArchiveCommandOutput) => void - ): void; - public createArchive( + createArchive(args: CreateArchiveCommandInput, options?: __HttpHandlerOptions): Promise; + createArchive(args: CreateArchiveCommandInput, cb: (err: any, data?: CreateArchiveCommandOutput) => void): void; + createArchive( args: CreateArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateArchiveCommandOutput) => void ): void; - public createArchive( - args: CreateArchiveCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateArchiveCommandOutput) => void), - cb?: (err: any, data?: CreateArchiveCommandOutput) => void - ): Promise | void { - const command = new CreateArchiveCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a connection. A connection defines the authorization type and credentials to use - * for authorization with an API destination HTTP endpoint.

+ * @see {@link CreateConnectionCommand} */ - public createConnection( + createConnection( args: CreateConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConnection( + createConnection( args: CreateConnectionCommandInput, cb: (err: any, data?: CreateConnectionCommandOutput) => void ): void; - public createConnection( + createConnection( args: CreateConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectionCommandOutput) => void ): void; - public createConnection( - args: CreateConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConnectionCommandOutput) => void), - cb?: (err: any, data?: CreateConnectionCommandOutput) => void - ): Promise | void { - const command = new CreateConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new event bus within your account. This can be a custom event bus which you can - * use to receive events from your custom applications and services, or it can be a partner event - * bus which can be matched to a partner event source.

+ * @see {@link CreateEventBusCommand} */ - public createEventBus( + createEventBus( args: CreateEventBusCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEventBus( - args: CreateEventBusCommandInput, - cb: (err: any, data?: CreateEventBusCommandOutput) => void - ): void; - public createEventBus( + createEventBus(args: CreateEventBusCommandInput, cb: (err: any, data?: CreateEventBusCommandOutput) => void): void; + createEventBus( args: CreateEventBusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEventBusCommandOutput) => void ): void; - public createEventBus( - args: CreateEventBusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEventBusCommandOutput) => void), - cb?: (err: any, data?: CreateEventBusCommandOutput) => void - ): Promise | void { - const command = new CreateEventBusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Called by an SaaS partner to create a partner event source. This operation is not used by - * Amazon Web Services customers.

- *

Each partner event source can be used by one Amazon Web Services account to create a matching partner - * event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each - * Amazon Web Services account that wants to receive those event types.

- *

A partner event source creates events based on resources within the SaaS partner's service - * or application.

- *

An Amazon Web Services account that creates a partner event bus that matches the partner event source can - * use that event bus to receive events from the partner, and then process them using Amazon Web Services Events - * rules and targets.

- *

Partner event source names follow this format:

- *

- * - * partner_name/event_namespace/event_name - * - *

- *

- * partner_name is determined during partner registration and identifies - * the partner to Amazon Web Services customers. event_namespace is determined by the - * partner and is a way for the partner to categorize their events. - * event_name is determined by the partner, and should uniquely identify - * an event-generating resource within the partner system. The combination of - * event_namespace and event_name should help Amazon Web Services - * customers decide whether to create an event bus to receive these events.

+ * @see {@link CreatePartnerEventSourceCommand} */ - public createPartnerEventSource( + createPartnerEventSource( args: CreatePartnerEventSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPartnerEventSource( + createPartnerEventSource( args: CreatePartnerEventSourceCommandInput, cb: (err: any, data?: CreatePartnerEventSourceCommandOutput) => void ): void; - public createPartnerEventSource( + createPartnerEventSource( args: CreatePartnerEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePartnerEventSourceCommandOutput) => void ): void; - public createPartnerEventSource( - args: CreatePartnerEventSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePartnerEventSourceCommandOutput) => void), - cb?: (err: any, data?: CreatePartnerEventSourceCommandOutput) => void - ): Promise | void { - const command = new CreatePartnerEventSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

You can use this operation to temporarily stop receiving events from the specified partner - * event source. The matching event bus is not deleted.

- *

When you deactivate a partner event source, the source goes into PENDING state. If it - * remains in PENDING state for more than two weeks, it is deleted.

- *

To activate a deactivated partner event source, use ActivateEventSource.

+ * @see {@link DeactivateEventSourceCommand} */ - public deactivateEventSource( + deactivateEventSource( args: DeactivateEventSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deactivateEventSource( + deactivateEventSource( args: DeactivateEventSourceCommandInput, cb: (err: any, data?: DeactivateEventSourceCommandOutput) => void ): void; - public deactivateEventSource( + deactivateEventSource( args: DeactivateEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeactivateEventSourceCommandOutput) => void ): void; - public deactivateEventSource( - args: DeactivateEventSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeactivateEventSourceCommandOutput) => void), - cb?: (err: any, data?: DeactivateEventSourceCommandOutput) => void - ): Promise | void { - const command = new DeactivateEventSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes all authorization parameters from the connection. This lets you remove the secret - * from the connection so you can reuse it without having to create a new connection.

+ * @see {@link DeauthorizeConnectionCommand} */ - public deauthorizeConnection( + deauthorizeConnection( args: DeauthorizeConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deauthorizeConnection( + deauthorizeConnection( args: DeauthorizeConnectionCommandInput, cb: (err: any, data?: DeauthorizeConnectionCommandOutput) => void ): void; - public deauthorizeConnection( + deauthorizeConnection( args: DeauthorizeConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeauthorizeConnectionCommandOutput) => void ): void; - public deauthorizeConnection( - args: DeauthorizeConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeauthorizeConnectionCommandOutput) => void), - cb?: (err: any, data?: DeauthorizeConnectionCommandOutput) => void - ): Promise | void { - const command = new DeauthorizeConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified API destination.

+ * @see {@link DeleteApiDestinationCommand} */ - public deleteApiDestination( + deleteApiDestination( args: DeleteApiDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApiDestination( + deleteApiDestination( args: DeleteApiDestinationCommandInput, cb: (err: any, data?: DeleteApiDestinationCommandOutput) => void ): void; - public deleteApiDestination( + deleteApiDestination( args: DeleteApiDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApiDestinationCommandOutput) => void ): void; - public deleteApiDestination( - args: DeleteApiDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApiDestinationCommandOutput) => void), - cb?: (err: any, data?: DeleteApiDestinationCommandOutput) => void - ): Promise | void { - const command = new DeleteApiDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified archive.

+ * @see {@link DeleteArchiveCommand} */ - public deleteArchive( - args: DeleteArchiveCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteArchive( - args: DeleteArchiveCommandInput, - cb: (err: any, data?: DeleteArchiveCommandOutput) => void - ): void; - public deleteArchive( + deleteArchive(args: DeleteArchiveCommandInput, options?: __HttpHandlerOptions): Promise; + deleteArchive(args: DeleteArchiveCommandInput, cb: (err: any, data?: DeleteArchiveCommandOutput) => void): void; + deleteArchive( args: DeleteArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteArchiveCommandOutput) => void ): void; - public deleteArchive( - args: DeleteArchiveCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteArchiveCommandOutput) => void), - cb?: (err: any, data?: DeleteArchiveCommandOutput) => void - ): Promise | void { - const command = new DeleteArchiveCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a connection.

+ * @see {@link DeleteConnectionCommand} */ - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, cb: (err: any, data?: DeleteConnectionCommandOutput) => void ): void; - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectionCommandOutput) => void ): void; - public deleteConnection( - args: DeleteConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConnectionCommandOutput) => void), - cb?: (err: any, data?: DeleteConnectionCommandOutput) => void - ): Promise | void { - const command = new DeleteConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified custom event bus or partner event bus. All rules associated with - * this event bus need to be deleted. You can't delete your account's default event bus.

+ * @see {@link DeleteEventBusCommand} */ - public deleteEventBus( + deleteEventBus( args: DeleteEventBusCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEventBus( - args: DeleteEventBusCommandInput, - cb: (err: any, data?: DeleteEventBusCommandOutput) => void - ): void; - public deleteEventBus( + deleteEventBus(args: DeleteEventBusCommandInput, cb: (err: any, data?: DeleteEventBusCommandOutput) => void): void; + deleteEventBus( args: DeleteEventBusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventBusCommandOutput) => void ): void; - public deleteEventBus( - args: DeleteEventBusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEventBusCommandOutput) => void), - cb?: (err: any, data?: DeleteEventBusCommandOutput) => void - ): Promise | void { - const command = new DeleteEventBusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation is used by SaaS partners to delete a partner event source. This operation - * is not used by Amazon Web Services customers.

- *

When you delete an event source, the status of the corresponding partner event bus in the - * Amazon Web Services customer account becomes DELETED.

- *

+ * @see {@link DeletePartnerEventSourceCommand} */ - public deletePartnerEventSource( + deletePartnerEventSource( args: DeletePartnerEventSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePartnerEventSource( + deletePartnerEventSource( args: DeletePartnerEventSourceCommandInput, cb: (err: any, data?: DeletePartnerEventSourceCommandOutput) => void ): void; - public deletePartnerEventSource( + deletePartnerEventSource( args: DeletePartnerEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePartnerEventSourceCommandOutput) => void ): void; - public deletePartnerEventSource( - args: DeletePartnerEventSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePartnerEventSourceCommandOutput) => void), - cb?: (err: any, data?: DeletePartnerEventSourceCommandOutput) => void - ): Promise | void { - const command = new DeletePartnerEventSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified rule.

- *

Before you can delete the rule, you must remove all targets, using RemoveTargets.

- * - *

When you delete a rule, incoming events might continue to match to the deleted rule. Allow - * a short period of time for changes to take effect.

- * - *

If you call delete rule multiple times for the same rule, all calls will succeed. When you - * call delete rule for a non-existent custom eventbus, ResourceNotFoundException is - * returned.

- * - *

Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These - * rules are created by those other Amazon Web Services services to support functionality in those services. You - * can delete these rules using the Force option, but you should do so only if you - * are sure the other service is not still using that rule.

+ * @see {@link DeleteRuleCommand} */ - public deleteRule(args: DeleteRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteRule(args: DeleteRuleCommandInput, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void; - public deleteRule( + deleteRule(args: DeleteRuleCommandInput, options?: __HttpHandlerOptions): Promise; + deleteRule(args: DeleteRuleCommandInput, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void; + deleteRule( args: DeleteRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRuleCommandOutput) => void ): void; - public deleteRule( - args: DeleteRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves details about an API destination.

+ * @see {@link DescribeApiDestinationCommand} */ - public describeApiDestination( + describeApiDestination( args: DescribeApiDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeApiDestination( + describeApiDestination( args: DescribeApiDestinationCommandInput, cb: (err: any, data?: DescribeApiDestinationCommandOutput) => void ): void; - public describeApiDestination( + describeApiDestination( args: DescribeApiDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeApiDestinationCommandOutput) => void ): void; - public describeApiDestination( - args: DescribeApiDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeApiDestinationCommandOutput) => void), - cb?: (err: any, data?: DescribeApiDestinationCommandOutput) => void - ): Promise | void { - const command = new DescribeApiDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves details about an archive.

+ * @see {@link DescribeArchiveCommand} */ - public describeArchive( + describeArchive( args: DescribeArchiveCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeArchive( - args: DescribeArchiveCommandInput, - cb: (err: any, data?: DescribeArchiveCommandOutput) => void - ): void; - public describeArchive( + describeArchive(args: DescribeArchiveCommandInput, cb: (err: any, data?: DescribeArchiveCommandOutput) => void): void; + describeArchive( args: DescribeArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeArchiveCommandOutput) => void ): void; - public describeArchive( - args: DescribeArchiveCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeArchiveCommandOutput) => void), - cb?: (err: any, data?: DescribeArchiveCommandOutput) => void - ): Promise | void { - const command = new DescribeArchiveCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves details about a connection.

+ * @see {@link DescribeConnectionCommand} */ - public describeConnection( + describeConnection( args: DescribeConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConnection( + describeConnection( args: DescribeConnectionCommandInput, cb: (err: any, data?: DescribeConnectionCommandOutput) => void ): void; - public describeConnection( + describeConnection( args: DescribeConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectionCommandOutput) => void ): void; - public describeConnection( - args: DescribeConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConnectionCommandOutput) => void), - cb?: (err: any, data?: DescribeConnectionCommandOutput) => void - ): Promise | void { - const command = new DescribeConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays details about an event bus in your account. This can include the external Amazon Web Services - * accounts that are permitted to write events to your default event bus, and the associated - * policy. For custom event buses and partner event buses, it displays the name, ARN, policy, - * state, and creation time.

- *

To enable your account to receive events from other accounts on its default event bus, - * use PutPermission.

- *

For more information about partner event buses, see CreateEventBus.

+ * @see {@link DescribeEventBusCommand} */ - public describeEventBus( + describeEventBus( args: DescribeEventBusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventBus( + describeEventBus( args: DescribeEventBusCommandInput, cb: (err: any, data?: DescribeEventBusCommandOutput) => void ): void; - public describeEventBus( + describeEventBus( args: DescribeEventBusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventBusCommandOutput) => void ): void; - public describeEventBus( - args: DescribeEventBusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventBusCommandOutput) => void), - cb?: (err: any, data?: DescribeEventBusCommandOutput) => void - ): Promise | void { - const command = new DescribeEventBusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation lists details about a partner event source that is shared with your - * account.

+ * @see {@link DescribeEventSourceCommand} */ - public describeEventSource( + describeEventSource( args: DescribeEventSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventSource( + describeEventSource( args: DescribeEventSourceCommandInput, cb: (err: any, data?: DescribeEventSourceCommandOutput) => void ): void; - public describeEventSource( + describeEventSource( args: DescribeEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventSourceCommandOutput) => void ): void; - public describeEventSource( - args: DescribeEventSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventSourceCommandOutput) => void), - cb?: (err: any, data?: DescribeEventSourceCommandOutput) => void - ): Promise | void { - const command = new DescribeEventSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

An SaaS partner can use this operation to list details about a partner event source that - * they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource - * to see details about a partner event source that is - * shared with them.

+ * @see {@link DescribePartnerEventSourceCommand} */ - public describePartnerEventSource( + describePartnerEventSource( args: DescribePartnerEventSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePartnerEventSource( + describePartnerEventSource( args: DescribePartnerEventSourceCommandInput, cb: (err: any, data?: DescribePartnerEventSourceCommandOutput) => void ): void; - public describePartnerEventSource( + describePartnerEventSource( args: DescribePartnerEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePartnerEventSourceCommandOutput) => void ): void; - public describePartnerEventSource( - args: DescribePartnerEventSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePartnerEventSourceCommandOutput) => void), - cb?: (err: any, data?: DescribePartnerEventSourceCommandOutput) => void - ): Promise | void { - const command = new DescribePartnerEventSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves details about a replay. Use DescribeReplay to determine the - * progress of a running replay. A replay processes events to replay based on the time in the - * event, and replays them using 1 minute intervals. If you use StartReplay and - * specify an EventStartTime and an EventEndTime that covers a 20 - * minute time range, the events are replayed from the first minute of that 20 minute range - * first. Then the events from the second minute are replayed. You can use - * DescribeReplay to determine the progress of a replay. The value returned for - * EventLastReplayedTime indicates the time within the specified time range - * associated with the last event replayed.

+ * @see {@link DescribeReplayCommand} */ - public describeReplay( + describeReplay( args: DescribeReplayCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReplay( - args: DescribeReplayCommandInput, - cb: (err: any, data?: DescribeReplayCommandOutput) => void - ): void; - public describeReplay( + describeReplay(args: DescribeReplayCommandInput, cb: (err: any, data?: DescribeReplayCommandOutput) => void): void; + describeReplay( args: DescribeReplayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReplayCommandOutput) => void ): void; - public describeReplay( - args: DescribeReplayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReplayCommandOutput) => void), - cb?: (err: any, data?: DescribeReplayCommandOutput) => void - ): Promise | void { - const command = new DescribeReplayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified rule.

- *

DescribeRule does not list the targets of a rule. To see the targets associated with a - * rule, use ListTargetsByRule.

+ * @see {@link DescribeRuleCommand} */ - public describeRule( - args: DescribeRuleCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeRule(args: DescribeRuleCommandInput, cb: (err: any, data?: DescribeRuleCommandOutput) => void): void; - public describeRule( + describeRule(args: DescribeRuleCommandInput, options?: __HttpHandlerOptions): Promise; + describeRule(args: DescribeRuleCommandInput, cb: (err: any, data?: DescribeRuleCommandOutput) => void): void; + describeRule( args: DescribeRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRuleCommandOutput) => void ): void; - public describeRule( - args: DescribeRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRuleCommandOutput) => void), - cb?: (err: any, data?: DescribeRuleCommandOutput) => void - ): Promise | void { - const command = new DescribeRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables the specified rule. A disabled rule won't match any events, and won't - * self-trigger if it has a schedule expression.

- * - *

When you disable a rule, incoming events might continue to match to the disabled rule. - * Allow a short period of time for changes to take effect.

+ * @see {@link DisableRuleCommand} */ - public disableRule(args: DisableRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public disableRule(args: DisableRuleCommandInput, cb: (err: any, data?: DisableRuleCommandOutput) => void): void; - public disableRule( + disableRule(args: DisableRuleCommandInput, options?: __HttpHandlerOptions): Promise; + disableRule(args: DisableRuleCommandInput, cb: (err: any, data?: DisableRuleCommandOutput) => void): void; + disableRule( args: DisableRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableRuleCommandOutput) => void ): void; - public disableRule( - args: DisableRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableRuleCommandOutput) => void), - cb?: (err: any, data?: DisableRuleCommandOutput) => void - ): Promise | void { - const command = new DisableRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the specified rule. If the rule does not exist, the operation fails.

- * - *

When you enable a rule, incoming events might not immediately start matching to a newly - * enabled rule. Allow a short period of time for changes to take effect.

+ * @see {@link EnableRuleCommand} */ - public enableRule(args: EnableRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public enableRule(args: EnableRuleCommandInput, cb: (err: any, data?: EnableRuleCommandOutput) => void): void; - public enableRule( + enableRule(args: EnableRuleCommandInput, options?: __HttpHandlerOptions): Promise; + enableRule(args: EnableRuleCommandInput, cb: (err: any, data?: EnableRuleCommandOutput) => void): void; + enableRule( args: EnableRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableRuleCommandOutput) => void ): void; - public enableRule( - args: EnableRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableRuleCommandOutput) => void), - cb?: (err: any, data?: EnableRuleCommandOutput) => void - ): Promise | void { - const command = new EnableRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of API destination in the account in the current Region.

+ * @see {@link ListApiDestinationsCommand} */ - public listApiDestinations( + listApiDestinations( args: ListApiDestinationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApiDestinations( + listApiDestinations( args: ListApiDestinationsCommandInput, cb: (err: any, data?: ListApiDestinationsCommandOutput) => void ): void; - public listApiDestinations( + listApiDestinations( args: ListApiDestinationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApiDestinationsCommandOutput) => void ): void; - public listApiDestinations( - args: ListApiDestinationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApiDestinationsCommandOutput) => void), - cb?: (err: any, data?: ListApiDestinationsCommandOutput) => void - ): Promise | void { - const command = new ListApiDestinationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists your archives. You can either list all the archives or you can provide a prefix to - * match to the archive names. Filter parameters are exclusive.

+ * @see {@link ListArchivesCommand} */ - public listArchives( - args: ListArchivesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listArchives(args: ListArchivesCommandInput, cb: (err: any, data?: ListArchivesCommandOutput) => void): void; - public listArchives( + listArchives(args: ListArchivesCommandInput, options?: __HttpHandlerOptions): Promise; + listArchives(args: ListArchivesCommandInput, cb: (err: any, data?: ListArchivesCommandOutput) => void): void; + listArchives( args: ListArchivesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListArchivesCommandOutput) => void ): void; - public listArchives( - args: ListArchivesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListArchivesCommandOutput) => void), - cb?: (err: any, data?: ListArchivesCommandOutput) => void - ): Promise | void { - const command = new ListArchivesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of connections from the account.

+ * @see {@link ListConnectionsCommand} */ - public listConnections( + listConnections( args: ListConnectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConnections( - args: ListConnectionsCommandInput, - cb: (err: any, data?: ListConnectionsCommandOutput) => void - ): void; - public listConnections( + listConnections(args: ListConnectionsCommandInput, cb: (err: any, data?: ListConnectionsCommandOutput) => void): void; + listConnections( args: ListConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConnectionsCommandOutput) => void ): void; - public listConnections( - args: ListConnectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConnectionsCommandOutput) => void), - cb?: (err: any, data?: ListConnectionsCommandOutput) => void - ): Promise | void { - const command = new ListConnectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the event buses in your account, including the default event bus, custom event - * buses, and partner event buses.

+ * @see {@link ListEventBusesCommand} */ - public listEventBuses( + listEventBuses( args: ListEventBusesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEventBuses( - args: ListEventBusesCommandInput, - cb: (err: any, data?: ListEventBusesCommandOutput) => void - ): void; - public listEventBuses( + listEventBuses(args: ListEventBusesCommandInput, cb: (err: any, data?: ListEventBusesCommandOutput) => void): void; + listEventBuses( args: ListEventBusesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventBusesCommandOutput) => void ): void; - public listEventBuses( - args: ListEventBusesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEventBusesCommandOutput) => void), - cb?: (err: any, data?: ListEventBusesCommandOutput) => void - ): Promise | void { - const command = new ListEventBusesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

You can use this to see all the partner event sources that have been shared with your Amazon Web Services - * account. For more information about partner event sources, see CreateEventBus.

+ * @see {@link ListEventSourcesCommand} */ - public listEventSources( + listEventSources( args: ListEventSourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEventSources( + listEventSources( args: ListEventSourcesCommandInput, cb: (err: any, data?: ListEventSourcesCommandOutput) => void ): void; - public listEventSources( + listEventSources( args: ListEventSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventSourcesCommandOutput) => void ): void; - public listEventSources( - args: ListEventSourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEventSourcesCommandOutput) => void), - cb?: (err: any, data?: ListEventSourcesCommandOutput) => void - ): Promise | void { - const command = new ListEventSourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular - * partner event source name is associated with. This operation is not used by Amazon Web Services - * customers.

+ * @see {@link ListPartnerEventSourceAccountsCommand} */ - public listPartnerEventSourceAccounts( + listPartnerEventSourceAccounts( args: ListPartnerEventSourceAccountsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPartnerEventSourceAccounts( + listPartnerEventSourceAccounts( args: ListPartnerEventSourceAccountsCommandInput, cb: (err: any, data?: ListPartnerEventSourceAccountsCommandOutput) => void ): void; - public listPartnerEventSourceAccounts( + listPartnerEventSourceAccounts( args: ListPartnerEventSourceAccountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPartnerEventSourceAccountsCommandOutput) => void ): void; - public listPartnerEventSourceAccounts( - args: ListPartnerEventSourceAccountsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPartnerEventSourceAccountsCommandOutput) => void), - cb?: (err: any, data?: ListPartnerEventSourceAccountsCommandOutput) => void - ): Promise | void { - const command = new ListPartnerEventSourceAccountsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

An SaaS partner can use this operation to list all the partner event source names that - * they have created. This operation is not used by Amazon Web Services customers.

+ * @see {@link ListPartnerEventSourcesCommand} */ - public listPartnerEventSources( + listPartnerEventSources( args: ListPartnerEventSourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPartnerEventSources( + listPartnerEventSources( args: ListPartnerEventSourcesCommandInput, cb: (err: any, data?: ListPartnerEventSourcesCommandOutput) => void ): void; - public listPartnerEventSources( + listPartnerEventSources( args: ListPartnerEventSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPartnerEventSourcesCommandOutput) => void ): void; - public listPartnerEventSources( - args: ListPartnerEventSourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPartnerEventSourcesCommandOutput) => void), - cb?: (err: any, data?: ListPartnerEventSourcesCommandOutput) => void - ): Promise | void { - const command = new ListPartnerEventSourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists your replays. You can either list all the replays or you can provide a prefix to - * match to the replay names. Filter parameters are exclusive.

+ * @see {@link ListReplaysCommand} */ - public listReplays(args: ListReplaysCommandInput, options?: __HttpHandlerOptions): Promise; - public listReplays(args: ListReplaysCommandInput, cb: (err: any, data?: ListReplaysCommandOutput) => void): void; - public listReplays( + listReplays(args: ListReplaysCommandInput, options?: __HttpHandlerOptions): Promise; + listReplays(args: ListReplaysCommandInput, cb: (err: any, data?: ListReplaysCommandOutput) => void): void; + listReplays( args: ListReplaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReplaysCommandOutput) => void ): void; - public listReplays( - args: ListReplaysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReplaysCommandOutput) => void), - cb?: (err: any, data?: ListReplaysCommandOutput) => void - ): Promise | void { - const command = new ListReplaysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the rules for the specified target. You can see which of the rules in Amazon - * EventBridge can invoke a specific target in your account.

+ * @see {@link ListRuleNamesByTargetCommand} */ - public listRuleNamesByTarget( + listRuleNamesByTarget( args: ListRuleNamesByTargetCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRuleNamesByTarget( + listRuleNamesByTarget( args: ListRuleNamesByTargetCommandInput, cb: (err: any, data?: ListRuleNamesByTargetCommandOutput) => void ): void; - public listRuleNamesByTarget( + listRuleNamesByTarget( args: ListRuleNamesByTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRuleNamesByTargetCommandOutput) => void ): void; - public listRuleNamesByTarget( - args: ListRuleNamesByTargetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRuleNamesByTargetCommandOutput) => void), - cb?: (err: any, data?: ListRuleNamesByTargetCommandOutput) => void - ): Promise | void { - const command = new ListRuleNamesByTargetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists your Amazon EventBridge rules. You can either list all the rules or you can provide - * a prefix to match to the rule names.

- * - *

ListRules does not list the targets of a rule. To see the targets associated with a rule, - * use ListTargetsByRule.

+ * @see {@link ListRulesCommand} */ - public listRules(args: ListRulesCommandInput, options?: __HttpHandlerOptions): Promise; - public listRules(args: ListRulesCommandInput, cb: (err: any, data?: ListRulesCommandOutput) => void): void; - public listRules( + listRules(args: ListRulesCommandInput, options?: __HttpHandlerOptions): Promise; + listRules(args: ListRulesCommandInput, cb: (err: any, data?: ListRulesCommandOutput) => void): void; + listRules( args: ListRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRulesCommandOutput) => void ): void; - public listRules( - args: ListRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRulesCommandOutput) => void), - cb?: (err: any, data?: ListRulesCommandOutput) => void - ): Promise | void { - const command = new ListRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays the tags associated with an EventBridge resource. In EventBridge, rules and event - * buses can be tagged.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the targets assigned to the specified rule.

+ * @see {@link ListTargetsByRuleCommand} */ - public listTargetsByRule( + listTargetsByRule( args: ListTargetsByRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTargetsByRule( + listTargetsByRule( args: ListTargetsByRuleCommandInput, cb: (err: any, data?: ListTargetsByRuleCommandOutput) => void ): void; - public listTargetsByRule( + listTargetsByRule( args: ListTargetsByRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTargetsByRuleCommandOutput) => void ): void; - public listTargetsByRule( - args: ListTargetsByRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTargetsByRuleCommandOutput) => void), - cb?: (err: any, data?: ListTargetsByRuleCommandOutput) => void - ): Promise | void { - const command = new ListTargetsByRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sends custom events to Amazon EventBridge so that they can be matched to rules.

+ * @see {@link PutEventsCommand} */ - public putEvents(args: PutEventsCommandInput, options?: __HttpHandlerOptions): Promise; - public putEvents(args: PutEventsCommandInput, cb: (err: any, data?: PutEventsCommandOutput) => void): void; - public putEvents( + putEvents(args: PutEventsCommandInput, options?: __HttpHandlerOptions): Promise; + putEvents(args: PutEventsCommandInput, cb: (err: any, data?: PutEventsCommandOutput) => void): void; + putEvents( args: PutEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEventsCommandOutput) => void ): void; - public putEvents( - args: PutEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutEventsCommandOutput) => void), - cb?: (err: any, data?: PutEventsCommandOutput) => void - ): Promise | void { - const command = new PutEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services - * customers do not use this operation.

+ * @see {@link PutPartnerEventsCommand} */ - public putPartnerEvents( + putPartnerEvents( args: PutPartnerEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putPartnerEvents( + putPartnerEvents( args: PutPartnerEventsCommandInput, cb: (err: any, data?: PutPartnerEventsCommandOutput) => void ): void; - public putPartnerEvents( + putPartnerEvents( args: PutPartnerEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPartnerEventsCommandOutput) => void ): void; - public putPartnerEvents( - args: PutPartnerEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutPartnerEventsCommandOutput) => void), - cb?: (err: any, data?: PutPartnerEventsCommandOutput) => void - ): Promise | void { - const command = new PutPartnerEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization - * to put events to the specified event bus. Amazon EventBridge (CloudWatch - * Events) rules in your account are triggered by these events arriving to an event bus in your - * account.

- *

For another account to send events to your account, that external account must have an - * EventBridge rule with your account's event bus as a target.

- * - *

To enable multiple Amazon Web Services accounts to put events to your event bus, run - * PutPermission once for each of these accounts. Or, if all the accounts are - * members of the same Amazon Web Services organization, you can run PutPermission once specifying - * Principal as "*" and specifying the Amazon Web Services organization ID in - * Condition, to grant permissions to all accounts in that organization.

- * - *

If you grant permissions using an organization, then accounts in that organization must - * specify a RoleArn with proper permissions when they use PutTarget to - * add your account's event bus as a target. For more information, see Sending and - * Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User - * Guide.

- * - *

The permission policy on the event bus cannot exceed 10 KB in size.

+ * @see {@link PutPermissionCommand} */ - public putPermission( - args: PutPermissionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putPermission( - args: PutPermissionCommandInput, - cb: (err: any, data?: PutPermissionCommandOutput) => void - ): void; - public putPermission( + putPermission(args: PutPermissionCommandInput, options?: __HttpHandlerOptions): Promise; + putPermission(args: PutPermissionCommandInput, cb: (err: any, data?: PutPermissionCommandOutput) => void): void; + putPermission( args: PutPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPermissionCommandOutput) => void ): void; - public putPermission( - args: PutPermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutPermissionCommandOutput) => void), - cb?: (err: any, data?: PutPermissionCommandOutput) => void - ): Promise | void { - const command = new PutPermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates the specified rule. Rules are enabled by default, or based on value of - * the state. You can disable a rule using DisableRule.

- * - *

A single rule watches for events from a single event bus. Events generated by Amazon Web Services services - * go to your account's default event bus. Events generated by SaaS partner services or - * applications go to the matching partner event bus. If you have custom applications or - * services, you can specify whether their events go to your default event bus or a custom event - * bus that you have created. For more information, see CreateEventBus.

- * - *

If you are updating an existing rule, the rule is replaced with what you specify in this - * PutRule command. If you omit arguments in PutRule, the old values - * for those arguments are not kept. Instead, they are replaced with null values.

- * - *

When you create or update a rule, incoming events might not immediately start matching to - * new or updated rules. Allow a short period of time for changes to take effect.

- * - *

A rule must contain at least an EventPattern or ScheduleExpression. Rules with - * EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions - * self-trigger based on the given schedule. A rule can have both an EventPattern and a - * ScheduleExpression, in which case the rule triggers on matching events as well as on a - * schedule.

- * - *

When you initially create a rule, you can optionally assign one or more tags to the rule. - * Tags can help you organize and categorize your resources. You can also use them to scope user - * permissions, by granting a user permission to access or change only rules with certain tag - * values. To use the PutRule operation and assign tags, you must have both the - * events:PutRule and events:TagResource permissions.

- *

If you are updating an existing rule, any tags you specify in the PutRule - * operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.

- * - *

Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). - * However, EventBridge uses an exact match in event patterns and rules. Be sure to use the - * correct ARN characters when creating event patterns so that they match the ARN syntax in the - * event you want to match.

- * - *

In EventBridge, it is possible to create rules that lead to infinite loops, where a rule - * is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, - * and trigger software to change them to the desired state. If the rule is not written - * carefully, the subsequent change to the ACLs fires the rule again, creating an infinite - * loop.

- *

To prevent this, write the rules so that the triggered actions do not re-fire the same - * rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead - * of after any change.

- *

An infinite loop can quickly cause higher than expected charges. We recommend that you use - * budgeting, which alerts you when charges exceed your specified limit. For more information, - * see Managing Your Costs with - * Budgets.

+ * @see {@link PutRuleCommand} */ - public putRule(args: PutRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public putRule(args: PutRuleCommandInput, cb: (err: any, data?: PutRuleCommandOutput) => void): void; - public putRule( + putRule(args: PutRuleCommandInput, options?: __HttpHandlerOptions): Promise; + putRule(args: PutRuleCommandInput, cb: (err: any, data?: PutRuleCommandOutput) => void): void; + putRule( args: PutRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRuleCommandOutput) => void ): void; - public putRule( - args: PutRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRuleCommandOutput) => void), - cb?: (err: any, data?: PutRuleCommandOutput) => void - ): Promise | void { - const command = new PutRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds the specified targets to the specified rule, or updates the targets if they are - * already associated with the rule.

- *

Targets are the resources that are invoked when a rule is triggered.

- *

You can configure the following as targets for Events:

- * - *
    - *
  • - *

    - * API - * destination - *

    - *
  • - *
  • - *

    Amazon API Gateway REST API endpoints

    - *
  • - *
  • - *

    API Gateway

    - *
  • - *
  • - *

    Batch job queue

    - *
  • - *
  • - *

    CloudWatch Logs group

    - *
  • - *
  • - *

    CodeBuild project

    - *
  • - *
  • - *

    CodePipeline

    - *
  • - *
  • - *

    Amazon EC2 CreateSnapshot API call

    - *
  • - *
  • - *

    Amazon EC2 RebootInstances API call

    - *
  • - *
  • - *

    Amazon EC2 StopInstances API call

    - *
  • - *
  • - *

    Amazon EC2 TerminateInstances API call

    - *
  • - *
  • - *

    Amazon ECS tasks

    - *
  • - *
  • - *

    Event bus in a different Amazon Web Services account or Region.

    - *

    You can use an event bus in the US East (N. Virginia) us-east-1, US West (Oregon) - * us-west-2, or Europe (Ireland) eu-west-1 Regions as a target for a rule.

    - *
  • - *
  • - *

    Firehose delivery stream (Kinesis Data Firehose)

    - *
  • - *
  • - *

    Inspector assessment template (Amazon Inspector)

    - *
  • - *
  • - *

    Kinesis stream (Kinesis Data Stream)

    - *
  • - *
  • - *

    Lambda function

    - *
  • - *
  • - *

    Redshift clusters (Data API statement execution)

    - *
  • - *
  • - *

    Amazon SNS topic

    - *
  • - *
  • - *

    Amazon SQS queues (includes FIFO queues

    - *
  • - *
  • - *

    SSM Automation

    - *
  • - *
  • - *

    SSM OpsItem

    - *
  • - *
  • - *

    SSM Run Command

    - *
  • - *
  • - *

    Step Functions state machines

    - *
  • - *
- * - *

Creating rules with built-in targets is supported only in the Management Console. The - * built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API - * call, EC2 StopInstances API call, and EC2 TerminateInstances API - * call.

- * - *

For some target types, PutTargets provides target-specific parameters. If the - * target is a Kinesis data stream, you can optionally specify which shard the event goes to by - * using the KinesisParameters argument. To invoke a command on multiple EC2 - * instances with one rule, you can use the RunCommandParameters field.

- * - *

To be able to make API calls against the resources that you own, Amazon EventBridge - * needs the appropriate permissions. For Lambda and Amazon SNS - * resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, - * Step Functions state machines and API Gateway REST APIs, EventBridge relies on - * IAM roles that you specify in the RoleARN argument in PutTargets. - * For more information, see Authentication - * and Access Control in the Amazon EventBridge User Guide.

- * - *

If another Amazon Web Services account is in the same region and has granted you permission (using - * PutPermission), you can send events to that account. Set that account's event - * bus as a target of the rules in your account. To send the matched events to the other account, - * specify that account's event bus as the Arn value when you run - * PutTargets. If your account sends events to another account, your account is - * charged for each sent event. Each event sent to another account is charged as a custom event. - * The account receiving the event is not charged. For more information, see Amazon EventBridge - * Pricing.

- * - * - *

- * Input, InputPath, and InputTransformer are not - * available with PutTarget if the target is an event bus of a different Amazon Web Services - * account.

- *
- * - *

If you are setting the event bus of another account as the target, and that account - * granted permission to your account through an organization instead of directly by the account - * ID, then you must specify a RoleArn with proper permissions in the - * Target structure. For more information, see Sending and - * Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User - * Guide.

- * - *

For more information about enabling cross-account events, see PutPermission.

- * - *

- * Input, InputPath, and - * InputTransformer are mutually exclusive and optional - * parameters of a target. When a rule is triggered due to a matched event:

- * - *
    - *
  • - *

    If none of the following arguments are specified for a target, then the entire event - * is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or - * Amazon ECS task, in which case nothing from the event is passed to the target).

    - *
  • - *
  • - *

    If Input is specified in the form of valid JSON, then - * the matched event is overridden with this constant.

    - *
  • - *
  • - *

    If InputPath is specified in the form of JSONPath - * (for example, $.detail), then only the part of the event specified in the - * path is passed to the target (for example, only the detail part of the event is - * passed).

    - *
  • - *
  • - *

    If InputTransformer is specified, then one or more - * specified JSONPaths are extracted from the event and used as values in a template that you - * specify as the input to the target.

    - *
  • - *
- * - *

When you specify InputPath or InputTransformer, you must use - * JSON dot notation, not bracket notation.

- * - *

When you add targets to a rule and the associated rule triggers soon after, new or updated - * targets might not be immediately invoked. Allow a short period of time for changes to take - * effect.

- * - *

This action can partially fail if too many requests are made at the same time. If that - * happens, FailedEntryCount is non-zero in the response and each entry in - * FailedEntries provides the ID of the failed target and the error code.

+ * @see {@link PutTargetsCommand} */ - public putTargets(args: PutTargetsCommandInput, options?: __HttpHandlerOptions): Promise; - public putTargets(args: PutTargetsCommandInput, cb: (err: any, data?: PutTargetsCommandOutput) => void): void; - public putTargets( + putTargets(args: PutTargetsCommandInput, options?: __HttpHandlerOptions): Promise; + putTargets(args: PutTargetsCommandInput, cb: (err: any, data?: PutTargetsCommandOutput) => void): void; + putTargets( args: PutTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutTargetsCommandOutput) => void ): void; - public putTargets( - args: PutTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutTargetsCommandOutput) => void), - cb?: (err: any, data?: PutTargetsCommandOutput) => void - ): Promise | void { - const command = new PutTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Revokes the permission of another Amazon Web Services account to be able to put events to the specified - * event bus. Specify the account to revoke by the StatementId value that you - * associated with the account when you granted it permission with PutPermission. - * You can find the StatementId by using DescribeEventBus.

+ * @see {@link RemovePermissionCommand} */ - public removePermission( + removePermission( args: RemovePermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public removePermission( + removePermission( args: RemovePermissionCommandInput, cb: (err: any, data?: RemovePermissionCommandOutput) => void ): void; - public removePermission( + removePermission( args: RemovePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemovePermissionCommandOutput) => void ): void; - public removePermission( - args: RemovePermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemovePermissionCommandOutput) => void), - cb?: (err: any, data?: RemovePermissionCommandOutput) => void - ): Promise | void { - const command = new RemovePermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified targets from the specified rule. When the rule is triggered, those - * targets are no longer be invoked.

- * - *

When you remove a target, when the associated rule triggers, removed targets might - * continue to be invoked. Allow a short period of time for changes to take effect.

- * - *

This action can partially fail if too many requests are made at the same time. If that - * happens, FailedEntryCount is non-zero in the response and each entry in - * FailedEntries provides the ID of the failed target and the error code.

+ * @see {@link RemoveTargetsCommand} */ - public removeTargets( - args: RemoveTargetsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public removeTargets( - args: RemoveTargetsCommandInput, - cb: (err: any, data?: RemoveTargetsCommandOutput) => void - ): void; - public removeTargets( + removeTargets(args: RemoveTargetsCommandInput, options?: __HttpHandlerOptions): Promise; + removeTargets(args: RemoveTargetsCommandInput, cb: (err: any, data?: RemoveTargetsCommandOutput) => void): void; + removeTargets( args: RemoveTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTargetsCommandOutput) => void ): void; - public removeTargets( - args: RemoveTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveTargetsCommandOutput) => void), - cb?: (err: any, data?: RemoveTargetsCommandOutput) => void - ): Promise | void { - const command = new RemoveTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts the specified replay. Events are not necessarily replayed in the exact same order - * that they were added to the archive. A replay processes events to replay based on the time in - * the event, and replays them using 1 minute intervals. If you specify an - * EventStartTime and an EventEndTime that covers a 20 minute time - * range, the events are replayed from the first minute of that 20 minute range first. Then the - * events from the second minute are replayed. You can use DescribeReplay to - * determine the progress of a replay. The value returned for EventLastReplayedTime - * indicates the time within the specified time range associated with the last event - * replayed.

+ * @see {@link StartReplayCommand} */ - public startReplay(args: StartReplayCommandInput, options?: __HttpHandlerOptions): Promise; - public startReplay(args: StartReplayCommandInput, cb: (err: any, data?: StartReplayCommandOutput) => void): void; - public startReplay( + startReplay(args: StartReplayCommandInput, options?: __HttpHandlerOptions): Promise; + startReplay(args: StartReplayCommandInput, cb: (err: any, data?: StartReplayCommandOutput) => void): void; + startReplay( args: StartReplayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartReplayCommandOutput) => void ): void; - public startReplay( - args: StartReplayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartReplayCommandOutput) => void), - cb?: (err: any, data?: StartReplayCommandOutput) => void - ): Promise | void { - const command = new StartReplayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can - * help you organize and categorize your resources. You can also use them to scope user - * permissions by granting a user permission to access or change only resources with certain tag - * values. In EventBridge, rules and event buses can be tagged.

- *

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of - * characters.

- *

You can use the TagResource action with a resource that already has tags. If - * you specify a new tag key, this tag is appended to the list of tags associated with the - * resource. If you specify a tag key that is already associated with the resource, the new tag - * value that you specify replaces the previous value for that tag.

- *

You can associate as many as 50 tags with a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Tests whether the specified event pattern matches the provided event.

- *

Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). - * However, EventBridge uses an exact match in event patterns and rules. Be sure to use the - * correct ARN characters when creating event patterns so that they match the ARN syntax in the - * event you want to match.

+ * @see {@link TestEventPatternCommand} */ - public testEventPattern( + testEventPattern( args: TestEventPatternCommandInput, options?: __HttpHandlerOptions ): Promise; - public testEventPattern( + testEventPattern( args: TestEventPatternCommandInput, cb: (err: any, data?: TestEventPatternCommandOutput) => void ): void; - public testEventPattern( + testEventPattern( args: TestEventPatternCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestEventPatternCommandOutput) => void ): void; - public testEventPattern( - args: TestEventPatternCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestEventPatternCommandOutput) => void), - cb?: (err: any, data?: TestEventPatternCommandOutput) => void - ): Promise | void { - const command = new TestEventPatternCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge - * (CloudWatch Events), rules and event buses can be tagged.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an API destination.

+ * @see {@link UpdateApiDestinationCommand} */ - public updateApiDestination( + updateApiDestination( args: UpdateApiDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApiDestination( + updateApiDestination( args: UpdateApiDestinationCommandInput, cb: (err: any, data?: UpdateApiDestinationCommandOutput) => void ): void; - public updateApiDestination( + updateApiDestination( args: UpdateApiDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApiDestinationCommandOutput) => void ): void; - public updateApiDestination( - args: UpdateApiDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApiDestinationCommandOutput) => void), - cb?: (err: any, data?: UpdateApiDestinationCommandOutput) => void - ): Promise | void { - const command = new UpdateApiDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified archive.

+ * @see {@link UpdateArchiveCommand} */ - public updateArchive( - args: UpdateArchiveCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateArchive( - args: UpdateArchiveCommandInput, - cb: (err: any, data?: UpdateArchiveCommandOutput) => void - ): void; - public updateArchive( + updateArchive(args: UpdateArchiveCommandInput, options?: __HttpHandlerOptions): Promise; + updateArchive(args: UpdateArchiveCommandInput, cb: (err: any, data?: UpdateArchiveCommandOutput) => void): void; + updateArchive( args: UpdateArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateArchiveCommandOutput) => void ): void; - public updateArchive( - args: UpdateArchiveCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateArchiveCommandOutput) => void), - cb?: (err: any, data?: UpdateArchiveCommandOutput) => void - ): Promise | void { - const command = new UpdateArchiveCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates settings for a connection.

+ * @see {@link UpdateConnectionCommand} */ - public updateConnection( + updateConnection( args: UpdateConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConnection( + updateConnection( args: UpdateConnectionCommandInput, cb: (err: any, data?: UpdateConnectionCommandOutput) => void ): void; - public updateConnection( + updateConnection( args: UpdateConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectionCommandOutput) => void ): void; - public updateConnection( - args: UpdateConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConnectionCommandOutput) => void), - cb?: (err: any, data?: UpdateConnectionCommandOutput) => void - ): Promise | void { - const command = new UpdateConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your + * resources change state, they automatically send events to an event stream. You can create + * rules that match selected events in the stream and route them to targets to take action. You + * can also use rules to take action on a predetermined schedule. For example, you can configure + * rules to:

+ *
    + *
  • + *

    Automatically invoke an Lambda function to update DNS entries when an event + * notifies you that Amazon EC2 instance enters the running state.

    + *
  • + *
  • + *

    Direct specific API records from CloudTrail to an Amazon Kinesis data stream for + * detailed analysis of potential security or availability risks.

    + *
  • + *
  • + *

    Periodically invoke a built-in target to create a snapshot of an Amazon EBS + * volume.

    + *
  • + *
+ *

For more information about the features of Amazon EventBridge, see the Amazon EventBridge User + * Guide.

+ */ +export class CloudWatchEvents extends CloudWatchEventsClient implements CloudWatchEvents {} +createAggregatedClient(commands, CloudWatchEvents); diff --git a/clients/client-cloudwatch-logs/src/CloudWatchLogs.ts b/clients/client-cloudwatch-logs/src/CloudWatchLogs.ts index 5af876703b0e..16dd9f0ad06f 100644 --- a/clients/client-cloudwatch-logs/src/CloudWatchLogs.ts +++ b/clients/client-cloudwatch-logs/src/CloudWatchLogs.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CloudWatchLogsClient } from "./CloudWatchLogsClient"; +import { CloudWatchLogsClient, CloudWatchLogsClientConfig } from "./CloudWatchLogsClient"; import { AssociateKmsKeyCommand, AssociateKmsKeyCommandInput, @@ -227,1971 +228,828 @@ import { UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; -/** - * @public - *

You can use Amazon CloudWatch Logs to monitor, store, and access your log files from - * EC2 instances, CloudTrail, and other sources. You can then retrieve the associated - * log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use - * CloudWatch Logs commands in the Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch - * Logs SDK.

- *

You can use CloudWatch Logs to:

- *
    - *
  • - *

    - * Monitor logs from EC2 instances in real time: You - * can use CloudWatch Logs to monitor applications and systems using log data. For example, - * CloudWatch Logs can track the number of errors that occur in your application logs. Then, - * it can send you a notification whenever the rate of errors exceeds a threshold that you - * specify. CloudWatch Logs uses your log data for monitoring so no code changes are - * required. For example, you can monitor application logs for specific literal terms (such - * as "NullReferenceException"). You can also count the number of occurrences of a literal - * term at a particular position in log data (such as "404" status codes in an Apache access - * log). When the term you are searching for is found, CloudWatch Logs reports the data to a - * CloudWatch metric that you specify.

    - *
  • - *
  • - *

    - * Monitor CloudTrail logged events: You can - * create alarms in CloudWatch and receive notifications of particular API activity as - * captured by CloudTrail. You can use the notification to perform troubleshooting.

    - *
  • - *
  • - *

    - * Archive log data: You can use CloudWatch Logs to - * store your log data in highly durable storage. You can change the log retention setting so - * that any log events earlier than this setting are automatically deleted. The CloudWatch - * Logs agent helps to quickly send both rotated and non-rotated log data off of a host and - * into the log service. You can then access the raw log data when you need it.

    - *
  • - *
- */ -export class CloudWatchLogs extends CloudWatchLogsClient { +const commands = { + AssociateKmsKeyCommand, + CancelExportTaskCommand, + CreateExportTaskCommand, + CreateLogGroupCommand, + CreateLogStreamCommand, + DeleteDataProtectionPolicyCommand, + DeleteDestinationCommand, + DeleteLogGroupCommand, + DeleteLogStreamCommand, + DeleteMetricFilterCommand, + DeleteQueryDefinitionCommand, + DeleteResourcePolicyCommand, + DeleteRetentionPolicyCommand, + DeleteSubscriptionFilterCommand, + DescribeDestinationsCommand, + DescribeExportTasksCommand, + DescribeLogGroupsCommand, + DescribeLogStreamsCommand, + DescribeMetricFiltersCommand, + DescribeQueriesCommand, + DescribeQueryDefinitionsCommand, + DescribeResourcePoliciesCommand, + DescribeSubscriptionFiltersCommand, + DisassociateKmsKeyCommand, + FilterLogEventsCommand, + GetDataProtectionPolicyCommand, + GetLogEventsCommand, + GetLogGroupFieldsCommand, + GetLogRecordCommand, + GetQueryResultsCommand, + ListTagsForResourceCommand, + ListTagsLogGroupCommand, + PutDataProtectionPolicyCommand, + PutDestinationCommand, + PutDestinationPolicyCommand, + PutLogEventsCommand, + PutMetricFilterCommand, + PutQueryDefinitionCommand, + PutResourcePolicyCommand, + PutRetentionPolicyCommand, + PutSubscriptionFilterCommand, + StartQueryCommand, + StopQueryCommand, + TagLogGroupCommand, + TagResourceCommand, + TestMetricFilterCommand, + UntagLogGroupCommand, + UntagResourceCommand, +}; + +export interface CloudWatchLogs { /** - * @public - *

Associates the specified KMS key with the specified log - * group.

- *

Associating a KMS key with a log group overrides any existing - * associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted - * using the KMS key. This association is stored as long as the data encrypted - * with the KMS keyis still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.

- * - *

CloudWatch Logs supports only symmetric KMS keys. Do not use an associate - * an asymmetric KMS key with your log group. For more information, see Using - * Symmetric and Asymmetric Keys.

- *
- *

It can take up to 5 minutes for this operation to take effect.

- *

If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an - * InvalidParameterException error.

+ * @see {@link AssociateKmsKeyCommand} */ - public associateKmsKey( + associateKmsKey( args: AssociateKmsKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateKmsKey( - args: AssociateKmsKeyCommandInput, - cb: (err: any, data?: AssociateKmsKeyCommandOutput) => void - ): void; - public associateKmsKey( + associateKmsKey(args: AssociateKmsKeyCommandInput, cb: (err: any, data?: AssociateKmsKeyCommandOutput) => void): void; + associateKmsKey( args: AssociateKmsKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateKmsKeyCommandOutput) => void ): void; - public associateKmsKey( - args: AssociateKmsKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateKmsKeyCommandOutput) => void), - cb?: (err: any, data?: AssociateKmsKeyCommandOutput) => void - ): Promise | void { - const command = new AssociateKmsKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels the specified export task.

- *

The task must be in the PENDING or RUNNING state.

+ * @see {@link CancelExportTaskCommand} */ - public cancelExportTask( + cancelExportTask( args: CancelExportTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelExportTask( + cancelExportTask( args: CancelExportTaskCommandInput, cb: (err: any, data?: CancelExportTaskCommandOutput) => void ): void; - public cancelExportTask( + cancelExportTask( args: CancelExportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelExportTaskCommandOutput) => void ): void; - public cancelExportTask( - args: CancelExportTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelExportTaskCommandOutput) => void), - cb?: (err: any, data?: CancelExportTaskCommandOutput) => void - ): Promise | void { - const command = new CancelExportTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an export task so that you can efficiently export data from a log group to an - * Amazon S3 bucket. When you perform a CreateExportTask operation, you must use - * credentials that have permission to write to the S3 bucket that you specify as the - * destination.

- *

Exporting log data to S3 buckets that are encrypted by KMS is supported. - * Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a - * retention period is also supported.

- *

Exporting to S3 buckets that are encrypted with AES-256 is supported.

- *

This is an asynchronous call. If all the required information is provided, this - * operation initiates an export task and responds with the ID of the task. After the task has started, - * you can use DescribeExportTasks to get the status of the export task. Each account can - * only have one active (RUNNING or PENDING) export task at a time. - * To cancel an export task, use CancelExportTask.

- *

You can export logs from multiple log groups or multiple time ranges to the same S3 - * bucket. To separate log data for each export task, specify a prefix to be used as the Amazon - * S3 key prefix for all exported objects.

- * - *

Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can - * sort the exported log field data by using Linux utilities.

- *
+ * @see {@link CreateExportTaskCommand} */ - public createExportTask( + createExportTask( args: CreateExportTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public createExportTask( + createExportTask( args: CreateExportTaskCommandInput, cb: (err: any, data?: CreateExportTaskCommandOutput) => void ): void; - public createExportTask( + createExportTask( args: CreateExportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExportTaskCommandOutput) => void ): void; - public createExportTask( - args: CreateExportTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateExportTaskCommandOutput) => void), - cb?: (err: any, data?: CreateExportTaskCommandOutput) => void - ): Promise | void { - const command = new CreateExportTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a log group with the specified name. You can create up to 20,000 log groups per account.

- *

You must use the following guidelines when naming a log group:

- *
    - *
  • - *

    Log group names must be unique within a Region for an Amazon Web Services - * account.

    - *
  • - *
  • - *

    Log group names can be between 1 and 512 characters long.

    - *
  • - *
  • - *

    Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), - * '/' (forward slash), '.' (period), and '#' (number sign)

    - *
  • - *
- *

When you create a log group, by default the log events in the log group do not expire. - * To set a retention policy so that events expire and are deleted after a specified time, use - * PutRetentionPolicy.

- *

If you associate an KMS key with the log group, ingested data is - * encrypted using the KMS key. This association is stored as long as the data - * encrypted with the KMS key is still within CloudWatch Logs. This enables - * CloudWatch Logs to decrypt this data whenever it is requested.

- *

If you attempt to associate a KMS key with the log group but the KMS keydoes not exist or the KMS key is disabled, you receive an - * InvalidParameterException error.

- * - *

CloudWatch Logs supports only symmetric KMS keys. Do not associate an - * asymmetric KMS key with your log group. For more information, see Using - * Symmetric and Asymmetric Keys.

- *
+ * @see {@link CreateLogGroupCommand} */ - public createLogGroup( + createLogGroup( args: CreateLogGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLogGroup( - args: CreateLogGroupCommandInput, - cb: (err: any, data?: CreateLogGroupCommandOutput) => void - ): void; - public createLogGroup( + createLogGroup(args: CreateLogGroupCommandInput, cb: (err: any, data?: CreateLogGroupCommandOutput) => void): void; + createLogGroup( args: CreateLogGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLogGroupCommandOutput) => void ): void; - public createLogGroup( - args: CreateLogGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLogGroupCommandOutput) => void), - cb?: (err: any, data?: CreateLogGroupCommandOutput) => void - ): Promise | void { - const command = new CreateLogGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a log stream for the specified log group. A log stream is a sequence of log events - * that originate from a single source, such as an application instance or a resource that is - * being monitored.

- *

There is no limit on the number of log streams that you can create for a log group. There is a limit - * of 50 TPS on CreateLogStream operations, after which transactions are throttled.

- *

You must use the following guidelines when naming a log stream:

- *
    - *
  • - *

    Log stream names must be unique within the log group.

    - *
  • - *
  • - *

    Log stream names can be between 1 and 512 characters long.

    - *
  • - *
  • - *

    Don't use ':' (colon) or '*' (asterisk) characters.

    - *
  • - *
+ * @see {@link CreateLogStreamCommand} */ - public createLogStream( + createLogStream( args: CreateLogStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLogStream( - args: CreateLogStreamCommandInput, - cb: (err: any, data?: CreateLogStreamCommandOutput) => void - ): void; - public createLogStream( + createLogStream(args: CreateLogStreamCommandInput, cb: (err: any, data?: CreateLogStreamCommandOutput) => void): void; + createLogStream( args: CreateLogStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLogStreamCommandOutput) => void ): void; - public createLogStream( - args: CreateLogStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLogStreamCommandOutput) => void), - cb?: (err: any, data?: CreateLogStreamCommandOutput) => void - ): Promise | void { - const command = new CreateLogStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the data protection policy from the specified log group.

- *

For more information about data protection policies, see PutDataProtectionPolicy.

+ * @see {@link DeleteDataProtectionPolicyCommand} */ - public deleteDataProtectionPolicy( + deleteDataProtectionPolicy( args: DeleteDataProtectionPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDataProtectionPolicy( + deleteDataProtectionPolicy( args: DeleteDataProtectionPolicyCommandInput, cb: (err: any, data?: DeleteDataProtectionPolicyCommandOutput) => void ): void; - public deleteDataProtectionPolicy( + deleteDataProtectionPolicy( args: DeleteDataProtectionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataProtectionPolicyCommandOutput) => void ): void; - public deleteDataProtectionPolicy( - args: DeleteDataProtectionPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDataProtectionPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteDataProtectionPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteDataProtectionPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified destination, and eventually disables all the - * subscription filters that publish to it. This operation does not delete the - * physical resource encapsulated by the destination.

+ * @see {@link DeleteDestinationCommand} */ - public deleteDestination( + deleteDestination( args: DeleteDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDestination( + deleteDestination( args: DeleteDestinationCommandInput, cb: (err: any, data?: DeleteDestinationCommandOutput) => void ): void; - public deleteDestination( + deleteDestination( args: DeleteDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDestinationCommandOutput) => void ): void; - public deleteDestination( - args: DeleteDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDestinationCommandOutput) => void), - cb?: (err: any, data?: DeleteDestinationCommandOutput) => void - ): Promise | void { - const command = new DeleteDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified log group and permanently deletes all the archived - * log events associated with the log group.

+ * @see {@link DeleteLogGroupCommand} */ - public deleteLogGroup( + deleteLogGroup( args: DeleteLogGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLogGroup( - args: DeleteLogGroupCommandInput, - cb: (err: any, data?: DeleteLogGroupCommandOutput) => void - ): void; - public deleteLogGroup( + deleteLogGroup(args: DeleteLogGroupCommandInput, cb: (err: any, data?: DeleteLogGroupCommandOutput) => void): void; + deleteLogGroup( args: DeleteLogGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLogGroupCommandOutput) => void ): void; - public deleteLogGroup( - args: DeleteLogGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLogGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteLogGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteLogGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified log stream and permanently deletes all the archived log events associated - * with the log stream.

+ * @see {@link DeleteLogStreamCommand} */ - public deleteLogStream( + deleteLogStream( args: DeleteLogStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLogStream( - args: DeleteLogStreamCommandInput, - cb: (err: any, data?: DeleteLogStreamCommandOutput) => void - ): void; - public deleteLogStream( + deleteLogStream(args: DeleteLogStreamCommandInput, cb: (err: any, data?: DeleteLogStreamCommandOutput) => void): void; + deleteLogStream( args: DeleteLogStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLogStreamCommandOutput) => void ): void; - public deleteLogStream( - args: DeleteLogStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLogStreamCommandOutput) => void), - cb?: (err: any, data?: DeleteLogStreamCommandOutput) => void - ): Promise | void { - const command = new DeleteLogStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified metric filter.

+ * @see {@link DeleteMetricFilterCommand} */ - public deleteMetricFilter( + deleteMetricFilter( args: DeleteMetricFilterCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMetricFilter( + deleteMetricFilter( args: DeleteMetricFilterCommandInput, cb: (err: any, data?: DeleteMetricFilterCommandOutput) => void ): void; - public deleteMetricFilter( + deleteMetricFilter( args: DeleteMetricFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMetricFilterCommandOutput) => void ): void; - public deleteMetricFilter( - args: DeleteMetricFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMetricFilterCommandOutput) => void), - cb?: (err: any, data?: DeleteMetricFilterCommandOutput) => void - ): Promise | void { - const command = new DeleteMetricFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a saved CloudWatch Logs Insights query definition. - * A query definition contains details about a saved CloudWatch Logs Insights query.

- *

Each DeleteQueryDefinition operation can delete one query definition.

- *

You must have the logs:DeleteQueryDefinition permission to be able to perform - * this operation.

+ * @see {@link DeleteQueryDefinitionCommand} */ - public deleteQueryDefinition( + deleteQueryDefinition( args: DeleteQueryDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteQueryDefinition( + deleteQueryDefinition( args: DeleteQueryDefinitionCommandInput, cb: (err: any, data?: DeleteQueryDefinitionCommandOutput) => void ): void; - public deleteQueryDefinition( + deleteQueryDefinition( args: DeleteQueryDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteQueryDefinitionCommandOutput) => void ): void; - public deleteQueryDefinition( - args: DeleteQueryDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteQueryDefinitionCommandOutput) => void), - cb?: (err: any, data?: DeleteQueryDefinitionCommandOutput) => void - ): Promise | void { - const command = new DeleteQueryDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a resource policy from this account. This revokes - * the access of the identities in that policy to put log events to this account.

+ * @see {@link DeleteResourcePolicyCommand} */ - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( - args: DeleteResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified retention policy.

- *

Log events do not expire if they belong to log groups without a retention policy.

+ * @see {@link DeleteRetentionPolicyCommand} */ - public deleteRetentionPolicy( + deleteRetentionPolicy( args: DeleteRetentionPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRetentionPolicy( + deleteRetentionPolicy( args: DeleteRetentionPolicyCommandInput, cb: (err: any, data?: DeleteRetentionPolicyCommandOutput) => void ): void; - public deleteRetentionPolicy( + deleteRetentionPolicy( args: DeleteRetentionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRetentionPolicyCommandOutput) => void ): void; - public deleteRetentionPolicy( - args: DeleteRetentionPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRetentionPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteRetentionPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteRetentionPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified subscription filter.

+ * @see {@link DeleteSubscriptionFilterCommand} */ - public deleteSubscriptionFilter( + deleteSubscriptionFilter( args: DeleteSubscriptionFilterCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSubscriptionFilter( + deleteSubscriptionFilter( args: DeleteSubscriptionFilterCommandInput, cb: (err: any, data?: DeleteSubscriptionFilterCommandOutput) => void ): void; - public deleteSubscriptionFilter( + deleteSubscriptionFilter( args: DeleteSubscriptionFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSubscriptionFilterCommandOutput) => void ): void; - public deleteSubscriptionFilter( - args: DeleteSubscriptionFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSubscriptionFilterCommandOutput) => void), - cb?: (err: any, data?: DeleteSubscriptionFilterCommandOutput) => void - ): Promise | void { - const command = new DeleteSubscriptionFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all your destinations. The results are ASCII-sorted by destination name.

+ * @see {@link DescribeDestinationsCommand} */ - public describeDestinations( + describeDestinations( args: DescribeDestinationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDestinations( + describeDestinations( args: DescribeDestinationsCommandInput, cb: (err: any, data?: DescribeDestinationsCommandOutput) => void ): void; - public describeDestinations( + describeDestinations( args: DescribeDestinationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDestinationsCommandOutput) => void ): void; - public describeDestinations( - args: DescribeDestinationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDestinationsCommandOutput) => void), - cb?: (err: any, data?: DescribeDestinationsCommandOutput) => void - ): Promise | void { - const command = new DescribeDestinationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the specified export tasks. You can list all your export tasks or filter - * the results based on task ID or task status.

+ * @see {@link DescribeExportTasksCommand} */ - public describeExportTasks( + describeExportTasks( args: DescribeExportTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeExportTasks( + describeExportTasks( args: DescribeExportTasksCommandInput, cb: (err: any, data?: DescribeExportTasksCommandOutput) => void ): void; - public describeExportTasks( + describeExportTasks( args: DescribeExportTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExportTasksCommandOutput) => void ): void; - public describeExportTasks( - args: DescribeExportTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeExportTasksCommandOutput) => void), - cb?: (err: any, data?: DescribeExportTasksCommandOutput) => void - ): Promise | void { - const command = new DescribeExportTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the specified log groups. You can list all your log groups or filter the results by prefix. - * The results are ASCII-sorted by log group name.

- *

CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups action by using the - * aws:ResourceTag/key-name - * condition key. Other CloudWatch Logs actions - * do support the use of the aws:ResourceTag/key-name - * condition key to control access. - * For more information about using tags to control access, see - * Controlling access to Amazon Web Services resources using tags.

- *

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and - * view data from the linked source accounts. For more information, see - * CloudWatch cross-account observability.

+ * @see {@link DescribeLogGroupsCommand} */ - public describeLogGroups( + describeLogGroups( args: DescribeLogGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLogGroups( + describeLogGroups( args: DescribeLogGroupsCommandInput, cb: (err: any, data?: DescribeLogGroupsCommandOutput) => void ): void; - public describeLogGroups( + describeLogGroups( args: DescribeLogGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLogGroupsCommandOutput) => void ): void; - public describeLogGroups( - args: DescribeLogGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLogGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeLogGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeLogGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the log streams for the specified log group. - * You can list all the log streams or filter the results by prefix. - * You can also control how the results are ordered.

- *

You can specify the log group to search by using either logGroupIdentifier or logGroupName. - * You must include one of these two parameters, but you can't include both. - *

- *

This operation has a limit of five transactions per second, after which transactions are throttled.

- *

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and - * view data from the linked source accounts. For more information, see - * CloudWatch cross-account observability.

+ * @see {@link DescribeLogStreamsCommand} */ - public describeLogStreams( + describeLogStreams( args: DescribeLogStreamsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLogStreams( + describeLogStreams( args: DescribeLogStreamsCommandInput, cb: (err: any, data?: DescribeLogStreamsCommandOutput) => void ): void; - public describeLogStreams( + describeLogStreams( args: DescribeLogStreamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLogStreamsCommandOutput) => void ): void; - public describeLogStreams( - args: DescribeLogStreamsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLogStreamsCommandOutput) => void), - cb?: (err: any, data?: DescribeLogStreamsCommandOutput) => void - ): Promise | void { - const command = new DescribeLogStreamsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the specified metric filters. You can list all of the metric filters or filter - * the results by log name, prefix, metric name, or metric namespace. The results are - * ASCII-sorted by filter name.

+ * @see {@link DescribeMetricFiltersCommand} */ - public describeMetricFilters( + describeMetricFilters( args: DescribeMetricFiltersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMetricFilters( + describeMetricFilters( args: DescribeMetricFiltersCommandInput, cb: (err: any, data?: DescribeMetricFiltersCommandOutput) => void ): void; - public describeMetricFilters( + describeMetricFilters( args: DescribeMetricFiltersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMetricFiltersCommandOutput) => void ): void; - public describeMetricFilters( - args: DescribeMetricFiltersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMetricFiltersCommandOutput) => void), - cb?: (err: any, data?: DescribeMetricFiltersCommandOutput) => void - ): Promise | void { - const command = new DescribeMetricFiltersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have - * been run recently in this account. You can request all queries or limit it to queries of a - * specific log group or queries with a certain status.

+ * @see {@link DescribeQueriesCommand} */ - public describeQueries( + describeQueries( args: DescribeQueriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeQueries( - args: DescribeQueriesCommandInput, - cb: (err: any, data?: DescribeQueriesCommandOutput) => void - ): void; - public describeQueries( + describeQueries(args: DescribeQueriesCommandInput, cb: (err: any, data?: DescribeQueriesCommandOutput) => void): void; + describeQueries( args: DescribeQueriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeQueriesCommandOutput) => void ): void; - public describeQueries( - args: DescribeQueriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeQueriesCommandOutput) => void), - cb?: (err: any, data?: DescribeQueriesCommandOutput) => void - ): Promise | void { - const command = new DescribeQueriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.

- *

You can use the queryDefinitionNamePrefix parameter to limit the results to only the - * query definitions that have names that start with a certain string.

+ * @see {@link DescribeQueryDefinitionsCommand} */ - public describeQueryDefinitions( + describeQueryDefinitions( args: DescribeQueryDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeQueryDefinitions( + describeQueryDefinitions( args: DescribeQueryDefinitionsCommandInput, cb: (err: any, data?: DescribeQueryDefinitionsCommandOutput) => void ): void; - public describeQueryDefinitions( + describeQueryDefinitions( args: DescribeQueryDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeQueryDefinitionsCommandOutput) => void ): void; - public describeQueryDefinitions( - args: DescribeQueryDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeQueryDefinitionsCommandOutput) => void), - cb?: (err: any, data?: DescribeQueryDefinitionsCommandOutput) => void - ): Promise | void { - const command = new DescribeQueryDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the resource policies in this account.

+ * @see {@link DescribeResourcePoliciesCommand} */ - public describeResourcePolicies( + describeResourcePolicies( args: DescribeResourcePoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeResourcePolicies( + describeResourcePolicies( args: DescribeResourcePoliciesCommandInput, cb: (err: any, data?: DescribeResourcePoliciesCommandOutput) => void ): void; - public describeResourcePolicies( + describeResourcePolicies( args: DescribeResourcePoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeResourcePoliciesCommandOutput) => void ): void; - public describeResourcePolicies( - args: DescribeResourcePoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeResourcePoliciesCommandOutput) => void), - cb?: (err: any, data?: DescribeResourcePoliciesCommandOutput) => void - ): Promise | void { - const command = new DescribeResourcePoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. - * The results are ASCII-sorted by filter name.

+ * @see {@link DescribeSubscriptionFiltersCommand} */ - public describeSubscriptionFilters( + describeSubscriptionFilters( args: DescribeSubscriptionFiltersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSubscriptionFilters( + describeSubscriptionFilters( args: DescribeSubscriptionFiltersCommandInput, cb: (err: any, data?: DescribeSubscriptionFiltersCommandOutput) => void ): void; - public describeSubscriptionFilters( + describeSubscriptionFilters( args: DescribeSubscriptionFiltersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSubscriptionFiltersCommandOutput) => void ): void; - public describeSubscriptionFilters( - args: DescribeSubscriptionFiltersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSubscriptionFiltersCommandOutput) => void), - cb?: (err: any, data?: DescribeSubscriptionFiltersCommandOutput) => void - ): Promise | void { - const command = new DescribeSubscriptionFiltersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates the associated KMS key from the specified log - * group.

- *

After the KMS key is disassociated from the log group, CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data - * remains encrypted, and CloudWatch Logs requires permissions for the KMS key - * whenever the encrypted data is requested.

- *

Note that it can take up to 5 minutes for this operation to take effect.

+ * @see {@link DisassociateKmsKeyCommand} */ - public disassociateKmsKey( + disassociateKmsKey( args: DisassociateKmsKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateKmsKey( + disassociateKmsKey( args: DisassociateKmsKeyCommandInput, cb: (err: any, data?: DisassociateKmsKeyCommandOutput) => void ): void; - public disassociateKmsKey( + disassociateKmsKey( args: DisassociateKmsKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateKmsKeyCommandOutput) => void ): void; - public disassociateKmsKey( - args: DisassociateKmsKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateKmsKeyCommandOutput) => void), - cb?: (err: any, data?: DisassociateKmsKeyCommandOutput) => void - ): Promise | void { - const command = new DisassociateKmsKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists log events from the specified log group. You can list all the log events or filter the results - * using a filter pattern, a time range, and the name of the log stream.

- *

You must have the logs;FilterLogEvents permission to perform this operation.

- *

You can specify the log group to search by using either logGroupIdentifier or logGroupName. - * You must include one of these two parameters, but you can't include both. - *

- *

By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 - * log events) or all the events found within the specified time range. If the results include a - * token, that means there are more log events available. You can get additional results by - * specifying the token in a subsequent call. This operation can return empty results while there - * are more log events available through the token.

- *

The returned log events are sorted by event timestamp, the timestamp when the event was ingested - * by CloudWatch Logs, and the ID of the PutLogEvents request.

- *

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and - * view data from the linked source accounts. For more information, see - * CloudWatch cross-account observability.

+ * @see {@link FilterLogEventsCommand} */ - public filterLogEvents( + filterLogEvents( args: FilterLogEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public filterLogEvents( - args: FilterLogEventsCommandInput, - cb: (err: any, data?: FilterLogEventsCommandOutput) => void - ): void; - public filterLogEvents( + filterLogEvents(args: FilterLogEventsCommandInput, cb: (err: any, data?: FilterLogEventsCommandOutput) => void): void; + filterLogEvents( args: FilterLogEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FilterLogEventsCommandOutput) => void ): void; - public filterLogEvents( - args: FilterLogEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FilterLogEventsCommandOutput) => void), - cb?: (err: any, data?: FilterLogEventsCommandOutput) => void - ): Promise | void { - const command = new FilterLogEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a log group data protection policy.

+ * @see {@link GetDataProtectionPolicyCommand} */ - public getDataProtectionPolicy( + getDataProtectionPolicy( args: GetDataProtectionPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDataProtectionPolicy( + getDataProtectionPolicy( args: GetDataProtectionPolicyCommandInput, cb: (err: any, data?: GetDataProtectionPolicyCommandOutput) => void ): void; - public getDataProtectionPolicy( + getDataProtectionPolicy( args: GetDataProtectionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataProtectionPolicyCommandOutput) => void ): void; - public getDataProtectionPolicy( - args: GetDataProtectionPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDataProtectionPolicyCommandOutput) => void), - cb?: (err: any, data?: GetDataProtectionPolicyCommandOutput) => void - ): Promise | void { - const command = new GetDataProtectionPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists log events from the specified log stream. You can list all of the log events or - * filter using a time range.

- *

By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). - * You can get additional log events by specifying one of the tokens in a subsequent call. - * This operation can return empty results while there are more log events available through the token.

- *

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and - * view data from the linked source accounts. For more information, see - * CloudWatch cross-account observability.

- *

You can specify the log group to search by using either logGroupIdentifier or logGroupName. - * You must include one of these two parameters, but you can't include both. - *

+ * @see {@link GetLogEventsCommand} */ - public getLogEvents( - args: GetLogEventsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getLogEvents(args: GetLogEventsCommandInput, cb: (err: any, data?: GetLogEventsCommandOutput) => void): void; - public getLogEvents( + getLogEvents(args: GetLogEventsCommandInput, options?: __HttpHandlerOptions): Promise; + getLogEvents(args: GetLogEventsCommandInput, cb: (err: any, data?: GetLogEventsCommandOutput) => void): void; + getLogEvents( args: GetLogEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLogEventsCommandOutput) => void ): void; - public getLogEvents( - args: GetLogEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLogEventsCommandOutput) => void), - cb?: (err: any, data?: GetLogEventsCommandOutput) => void - ): Promise | void { - const command = new GetLogEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the fields that are included in log events in the specified log group. - * Includes the percentage of log events that contain each field. The search is limited to a time - * period that you specify.

- *

You can specify the log group to search by using either logGroupIdentifier or logGroupName. - * You must specify one of these parameters, but you can't specify both. - *

- *

In the results, fields that start with @ are fields generated by CloudWatch - * Logs. For example, @timestamp is the timestamp of each log event. For more - * information about the fields that are generated by CloudWatch logs, see Supported - * Logs and Discovered Fields.

- *

The response results are sorted by the frequency percentage, starting - * with the highest percentage.

- *

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and - * view data from the linked source accounts. For more information, see - * CloudWatch cross-account observability.

+ * @see {@link GetLogGroupFieldsCommand} */ - public getLogGroupFields( + getLogGroupFields( args: GetLogGroupFieldsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLogGroupFields( + getLogGroupFields( args: GetLogGroupFieldsCommandInput, cb: (err: any, data?: GetLogGroupFieldsCommandOutput) => void ): void; - public getLogGroupFields( + getLogGroupFields( args: GetLogGroupFieldsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLogGroupFieldsCommandOutput) => void ): void; - public getLogGroupFields( - args: GetLogGroupFieldsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLogGroupFieldsCommandOutput) => void), - cb?: (err: any, data?: GetLogGroupFieldsCommandOutput) => void - ): Promise | void { - const command = new GetLogGroupFieldsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves all of the fields and values of a single log event. All fields are retrieved, - * even if the original query that produced the logRecordPointer retrieved only a - * subset of fields. Fields are returned as field name/field value pairs.

- *

The full unparsed log event is returned within @message.

+ * @see {@link GetLogRecordCommand} */ - public getLogRecord( - args: GetLogRecordCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getLogRecord(args: GetLogRecordCommandInput, cb: (err: any, data?: GetLogRecordCommandOutput) => void): void; - public getLogRecord( + getLogRecord(args: GetLogRecordCommandInput, options?: __HttpHandlerOptions): Promise; + getLogRecord(args: GetLogRecordCommandInput, cb: (err: any, data?: GetLogRecordCommandOutput) => void): void; + getLogRecord( args: GetLogRecordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLogRecordCommandOutput) => void ): void; - public getLogRecord( - args: GetLogRecordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLogRecordCommandOutput) => void), - cb?: (err: any, data?: GetLogRecordCommandOutput) => void - ): Promise | void { - const command = new GetLogRecordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the results from the specified query.

- *

Only the fields requested in the query are returned, along with a @ptr - * field, which is the identifier for the log record. You can use the value of @ptr - * in a GetLogRecord - * operation to get the full log record.

- *

- * GetQueryResults does not start running a query. To run a query, use StartQuery.

- *

If the value of the Status field in the output is Running, this operation - * returns only partial results. If you see a value of Scheduled or Running for the status, - * you can retry the operation later to see the final results.

- *

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start - * queries in linked source accounts. For more information, see - * CloudWatch cross-account observability.

+ * @see {@link GetQueryResultsCommand} */ - public getQueryResults( + getQueryResults( args: GetQueryResultsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getQueryResults( - args: GetQueryResultsCommandInput, - cb: (err: any, data?: GetQueryResultsCommandOutput) => void - ): void; - public getQueryResults( + getQueryResults(args: GetQueryResultsCommandInput, cb: (err: any, data?: GetQueryResultsCommandOutput) => void): void; + getQueryResults( args: GetQueryResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueryResultsCommandOutput) => void ): void; - public getQueryResults( - args: GetQueryResultsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetQueryResultsCommandOutput) => void), - cb?: (err: any, data?: GetQueryResultsCommandOutput) => void - ): Promise | void { - const command = new GetQueryResultsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays the tags associated with a CloudWatch Logs resource. Currently, log groups - * and destinations support tagging.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - * - *

The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use - * ListTagsForResource instead.

- *
- *

Lists the tags for the specified log group.

+ * @see {@link ListTagsLogGroupCommand} */ - public listTagsLogGroup( + listTagsLogGroup( args: ListTagsLogGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsLogGroup( + listTagsLogGroup( args: ListTagsLogGroupCommandInput, cb: (err: any, data?: ListTagsLogGroupCommandOutput) => void ): void; - public listTagsLogGroup( + listTagsLogGroup( args: ListTagsLogGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsLogGroupCommandOutput) => void ): void; - public listTagsLogGroup( - args: ListTagsLogGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsLogGroupCommandOutput) => void), - cb?: (err: any, data?: ListTagsLogGroupCommandOutput) => void - ): Promise | void { - const command = new ListTagsLogGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive - * data that's ingested by the log group by auditing and masking the sensitive log data.

- * - *

Sensitive data is detected and masked when it is ingested into the log group. When you set a - * data protection policy, log events ingested into the log group before that time are not masked.

- *
- *

By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. - * A user who has the logs:Unmask permission can use a - * GetLogEvents or - * FilterLogEvents - * operation with the unmask parameter set to true to view the unmasked - * log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs - * console by running a CloudWatch Logs Insights query with the unmask query command.

- *

For more information, including a list of types of data that can be audited and masked, see - * Protect sensitive log data with masking.

+ * @see {@link PutDataProtectionPolicyCommand} */ - public putDataProtectionPolicy( + putDataProtectionPolicy( args: PutDataProtectionPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putDataProtectionPolicy( + putDataProtectionPolicy( args: PutDataProtectionPolicyCommandInput, cb: (err: any, data?: PutDataProtectionPolicyCommandOutput) => void ): void; - public putDataProtectionPolicy( + putDataProtectionPolicy( args: PutDataProtectionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDataProtectionPolicyCommandOutput) => void ): void; - public putDataProtectionPolicy( - args: PutDataProtectionPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutDataProtectionPolicyCommandOutput) => void), - cb?: (err: any, data?: PutDataProtectionPolicyCommandOutput) => void - ): Promise | void { - const command = new PutDataProtectionPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.

- *

A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With - * a destination, you can subscribe to a real-time stream of log events for a different account, - * ingested using PutLogEvents.

- *

Through an access policy, a destination controls what is written to it. - * By default, PutDestination does not set any access policy with the destination, - * which means a cross-account user cannot call PutSubscriptionFilter against - * this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.

- *

To perform a PutDestination operation, you must also have the - * iam:PassRole permission.

+ * @see {@link PutDestinationCommand} */ - public putDestination( + putDestination( args: PutDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putDestination( - args: PutDestinationCommandInput, - cb: (err: any, data?: PutDestinationCommandOutput) => void - ): void; - public putDestination( + putDestination(args: PutDestinationCommandInput, cb: (err: any, data?: PutDestinationCommandOutput) => void): void; + putDestination( args: PutDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDestinationCommandOutput) => void ): void; - public putDestination( - args: PutDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutDestinationCommandOutput) => void), - cb?: (err: any, data?: PutDestinationCommandOutput) => void - ): Promise | void { - const command = new PutDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates an access policy associated with an existing - * destination. An access policy is an IAM policy document that is used - * to authorize claims to register a subscription filter against a given destination.

+ * @see {@link PutDestinationPolicyCommand} */ - public putDestinationPolicy( + putDestinationPolicy( args: PutDestinationPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putDestinationPolicy( + putDestinationPolicy( args: PutDestinationPolicyCommandInput, cb: (err: any, data?: PutDestinationPolicyCommandOutput) => void ): void; - public putDestinationPolicy( + putDestinationPolicy( args: PutDestinationPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDestinationPolicyCommandOutput) => void ): void; - public putDestinationPolicy( - args: PutDestinationPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutDestinationPolicyCommandOutput) => void), - cb?: (err: any, data?: PutDestinationPolicyCommandOutput) => void - ): Promise | void { - const command = new PutDestinationPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Uploads a batch of log events to the specified log stream.

- * - *

The sequence token is now ignored in PutLogEvents - * actions. PutLogEvents - * actions are always accepted and never return InvalidSequenceTokenException or - * DataAlreadyAcceptedException even if the sequence token is not valid. You can use - * parallel PutLogEvents actions on the same log stream.

- *
- *

The batch of events must satisfy the following constraints:

- *
    - *
  • - *

    The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of - * all event messages in UTF-8, plus 26 bytes for each log event.

    - *
  • - *
  • - *

    None of the log events in the batch can be more than 2 hours in the future.

    - *
  • - *
  • - *

    None of the log events in the batch can be more than 14 days in the past. Also, - * none of the log events can be from earlier than the retention period of the log - * group.

    - *
  • - *
  • - *

    The log events in the batch must be in chronological order by their timestamp. The - * timestamp is the time that the event occurred, expressed as the number of milliseconds - * after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell - * and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format: - * yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)

    - *
  • - *
  • - *

    A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.

    - *
  • - *
  • - *

    The maximum number of log events in a batch is 10,000.

    - *
  • - *
  • - * - *

    The quota of five requests per second per log stream - * has been removed. Instead, PutLogEvents actions are throttled based on a - * per-second per-account quota. You can request an increase to the per-second throttling - * quota by using the Service Quotas service.

    - *
    - *
  • - *
- *

If a call to PutLogEvents returns "UnrecognizedClientException" the most - * likely cause is a non-valid Amazon Web Services access key ID or secret key.

+ * @see {@link PutLogEventsCommand} */ - public putLogEvents( - args: PutLogEventsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putLogEvents(args: PutLogEventsCommandInput, cb: (err: any, data?: PutLogEventsCommandOutput) => void): void; - public putLogEvents( + putLogEvents(args: PutLogEventsCommandInput, options?: __HttpHandlerOptions): Promise; + putLogEvents(args: PutLogEventsCommandInput, cb: (err: any, data?: PutLogEventsCommandOutput) => void): void; + putLogEvents( args: PutLogEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLogEventsCommandOutput) => void ): void; - public putLogEvents( - args: PutLogEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutLogEventsCommandOutput) => void), - cb?: (err: any, data?: PutLogEventsCommandOutput) => void - ): Promise | void { - const command = new PutLogEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates a metric filter and associates it with the specified log group. With - * metric filters, you can configure rules to extract metric data from log events ingested - * through PutLogEvents.

- *

The maximum number of metric filters that can be associated with a log group is - * 100.

- *

When you create a metric filter, you can also optionally assign a unit and dimensions - * to the metric that is created.

- * - *

Metrics extracted from log events are charged as custom metrics. - * To prevent unexpected high charges, do not specify high-cardinality fields such as - * IPAddress or requestID as dimensions. Each different value - * found for - * a dimension is treated as a separate metric and accrues charges as a separate custom metric. - *

- *

CloudWatch Logs disables a metric filter if it generates 1,000 different name/value pairs for - * your specified dimensions within a certain amount of time. This helps to prevent accidental - * high charges.

- *

You can also set up a billing alarm to alert you if your charges are higher than - * expected. For more information, - * see - * Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges. - *

- *
+ * @see {@link PutMetricFilterCommand} */ - public putMetricFilter( + putMetricFilter( args: PutMetricFilterCommandInput, options?: __HttpHandlerOptions ): Promise; - public putMetricFilter( - args: PutMetricFilterCommandInput, - cb: (err: any, data?: PutMetricFilterCommandOutput) => void - ): void; - public putMetricFilter( + putMetricFilter(args: PutMetricFilterCommandInput, cb: (err: any, data?: PutMetricFilterCommandOutput) => void): void; + putMetricFilter( args: PutMetricFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMetricFilterCommandOutput) => void ): void; - public putMetricFilter( - args: PutMetricFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutMetricFilterCommandOutput) => void), - cb?: (err: any, data?: PutMetricFilterCommandOutput) => void - ): Promise | void { - const command = new PutMetricFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates a query definition for CloudWatch Logs Insights. For - * more information, see Analyzing Log Data with CloudWatch Logs Insights.

- *

To update a query definition, specify its queryDefinitionId in your request. - * The values of name, queryString, and logGroupNames are - * changed to the values that you specify in your update operation. No current values are - * retained from the current query definition. For example, imagine updating a current query - * definition that includes log groups. If you don't specify the logGroupNames - * parameter in your update operation, the query definition changes to contain no log - * groups.

- *

You must have the logs:PutQueryDefinition permission to be able to perform - * this operation.

+ * @see {@link PutQueryDefinitionCommand} */ - public putQueryDefinition( + putQueryDefinition( args: PutQueryDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public putQueryDefinition( + putQueryDefinition( args: PutQueryDefinitionCommandInput, cb: (err: any, data?: PutQueryDefinitionCommandOutput) => void ): void; - public putQueryDefinition( + putQueryDefinition( args: PutQueryDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutQueryDefinitionCommandOutput) => void ): void; - public putQueryDefinition( - args: PutQueryDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutQueryDefinitionCommandOutput) => void), - cb?: (err: any, data?: PutQueryDefinitionCommandOutput) => void - ): Promise | void { - const command = new PutQueryDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates a resource policy allowing other Amazon Web Services services to put log events to - * this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services - * Region.

+ * @see {@link PutResourcePolicyCommand} */ - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( - args: PutResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: PutResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new PutResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the retention of the specified log group. With a retention policy, you can - * configure the number of days for which to retain log events in the specified log - * group.

- * - *

CloudWatch Logs doesn’t immediately delete log events when they reach their retention - * setting. It typically takes up to 72 hours after that before log events are deleted, but in - * rare situations might take longer.

- *

To illustrate, imagine that you change a log group to have a longer retention setting - * when it contains log events that are past the expiration date, but haven’t been deleted. - * Those log events will take up to 72 hours to be deleted after the new retention date is - * reached. To make sure that log data is deleted permanently, keep a log group at its lower - * retention setting until 72 hours after the previous retention period ends. Alternatively, - * wait to change the retention setting until you confirm that the earlier log events are - * deleted.

- *
+ * @see {@link PutRetentionPolicyCommand} */ - public putRetentionPolicy( + putRetentionPolicy( args: PutRetentionPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putRetentionPolicy( + putRetentionPolicy( args: PutRetentionPolicyCommandInput, cb: (err: any, data?: PutRetentionPolicyCommandOutput) => void ): void; - public putRetentionPolicy( + putRetentionPolicy( args: PutRetentionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRetentionPolicyCommandOutput) => void ): void; - public putRetentionPolicy( - args: PutRetentionPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRetentionPolicyCommandOutput) => void), - cb?: (err: any, data?: PutRetentionPolicyCommandOutput) => void - ): Promise | void { - const command = new PutRetentionPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates a subscription filter and associates it with the specified log - * group. With subscription filters, you can subscribe to a real-time stream of log events - * ingested through PutLogEvents - * and have them delivered to a specific destination. When log events are sent to the receiving - * service, they are Base64 encoded and compressed with the GZIP format.

- *

The following destinations are supported for subscription filters:

- *
    - *
  • - *

    An Amazon Kinesis data stream belonging to the same account as the subscription - * filter, for same-account delivery.

    - *
  • - *
  • - *

    A logical destination that belongs to a different account, for cross-account delivery.

    - *
  • - *
  • - *

    An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as - * the subscription filter, for same-account delivery.

    - *
  • - *
  • - *

    An Lambda function that belongs to the same account as the - * subscription filter, for same-account delivery.

    - *
  • - *
- *

Each log group can have up to two subscription filters associated with it. If you are - * updating an existing filter, you must specify the correct name in filterName. - *

- *

To perform a PutSubscriptionFilter operation, you must also have the - * iam:PassRole permission.

+ * @see {@link PutSubscriptionFilterCommand} */ - public putSubscriptionFilter( + putSubscriptionFilter( args: PutSubscriptionFilterCommandInput, options?: __HttpHandlerOptions ): Promise; - public putSubscriptionFilter( + putSubscriptionFilter( args: PutSubscriptionFilterCommandInput, cb: (err: any, data?: PutSubscriptionFilterCommandOutput) => void ): void; - public putSubscriptionFilter( + putSubscriptionFilter( args: PutSubscriptionFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSubscriptionFilterCommandOutput) => void ): void; - public putSubscriptionFilter( - args: PutSubscriptionFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutSubscriptionFilterCommandOutput) => void), - cb?: (err: any, data?: PutSubscriptionFilterCommandOutput) => void - ): Promise | void { - const command = new PutSubscriptionFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group - * and time range to query and the query string to use.

- *

For more information, see CloudWatch Logs Insights Query Syntax.

- *

Queries time out after 15 minutes of runtime. If your queries are timing out, reduce the - * time range being searched or partition your query into a number of queries.

- *

If you are using CloudWatch cross-account observability, you can use this operation in a - * monitoring account to start a query in a linked source account. For more information, see - * CloudWatch - * cross-account observability. For a cross-account StartQuery operation, - * the query definition must be defined in the monitoring account.

- *

You can have up to 20 concurrent CloudWatch Logs insights queries, including queries - * that have been added to dashboards.

+ * @see {@link StartQueryCommand} */ - public startQuery(args: StartQueryCommandInput, options?: __HttpHandlerOptions): Promise; - public startQuery(args: StartQueryCommandInput, cb: (err: any, data?: StartQueryCommandOutput) => void): void; - public startQuery( + startQuery(args: StartQueryCommandInput, options?: __HttpHandlerOptions): Promise; + startQuery(args: StartQueryCommandInput, cb: (err: any, data?: StartQueryCommandOutput) => void): void; + startQuery( args: StartQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartQueryCommandOutput) => void ): void; - public startQuery( - args: StartQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartQueryCommandOutput) => void), - cb?: (err: any, data?: StartQueryCommandOutput) => void - ): Promise | void { - const command = new StartQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation - * returns an error indicating that the specified query is not running.

+ * @see {@link StopQueryCommand} */ - public stopQuery(args: StopQueryCommandInput, options?: __HttpHandlerOptions): Promise; - public stopQuery(args: StopQueryCommandInput, cb: (err: any, data?: StopQueryCommandOutput) => void): void; - public stopQuery( + stopQuery(args: StopQueryCommandInput, options?: __HttpHandlerOptions): Promise; + stopQuery(args: StopQueryCommandInput, cb: (err: any, data?: StopQueryCommandOutput) => void): void; + stopQuery( args: StopQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopQueryCommandOutput) => void ): void; - public stopQuery( - args: StopQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopQueryCommandOutput) => void), - cb?: (err: any, data?: StopQueryCommandOutput) => void - ): Promise | void { - const command = new StopQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - * - *

The TagLogGroup operation is on the path to deprecation. We recommend that you use - * TagResource instead.

- *
- *

Adds or updates the specified tags for the specified log group.

- *

To list the tags for a log group, use ListTagsForResource. - * To remove tags, use UntagResource.

- *

For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs - * in the Amazon CloudWatch Logs User Guide.

- *

CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to - * log groups using the aws:Resource/key-name - * or aws:TagKeys condition keys. - * For more information about using tags to control access, see - * Controlling access to Amazon Web Services resources using tags.

+ * @see {@link TagLogGroupCommand} */ - public tagLogGroup(args: TagLogGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public tagLogGroup(args: TagLogGroupCommandInput, cb: (err: any, data?: TagLogGroupCommandOutput) => void): void; - public tagLogGroup( + tagLogGroup(args: TagLogGroupCommandInput, options?: __HttpHandlerOptions): Promise; + tagLogGroup(args: TagLogGroupCommandInput, cb: (err: any, data?: TagLogGroupCommandOutput) => void): void; + tagLogGroup( args: TagLogGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagLogGroupCommandOutput) => void ): void; - public tagLogGroup( - args: TagLogGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagLogGroupCommandOutput) => void), - cb?: (err: any, data?: TagLogGroupCommandOutput) => void - ): Promise | void { - const command = new TagLogGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. - * Currently, the only CloudWatch Logs resources that - * can be tagged are log groups and destinations.

- *

Tags can help you organize and categorize your resources. You can also use them to scope user - * permissions by granting a user - * permission to access or change only resources with certain tag values.

- *

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

- *

You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, - * this tag is appended to the list of tags associated - * with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces - * the previous value for that tag.

- *

You can associate as many as 50 tags with a CloudWatch Logs resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Tests the filter pattern of a metric filter against a sample of log event messages. You - * can use this operation to validate the correctness of a metric filter pattern.

+ * @see {@link TestMetricFilterCommand} */ - public testMetricFilter( + testMetricFilter( args: TestMetricFilterCommandInput, options?: __HttpHandlerOptions ): Promise; - public testMetricFilter( + testMetricFilter( args: TestMetricFilterCommandInput, cb: (err: any, data?: TestMetricFilterCommandOutput) => void ): void; - public testMetricFilter( + testMetricFilter( args: TestMetricFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestMetricFilterCommandOutput) => void ): void; - public testMetricFilter( - args: TestMetricFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestMetricFilterCommandOutput) => void), - cb?: (err: any, data?: TestMetricFilterCommandOutput) => void - ): Promise | void { - const command = new TestMetricFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - * - *

The UntagLogGroup operation is on the path to deprecation. We recommend that you use - * UntagResource instead.

- *
- *

Removes the specified tags from the specified log group.

- *

To list the tags for a log group, use ListTagsForResource. - * To add tags, use TagResource.

- *

CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to - * log groups using the aws:Resource/key-name - * or aws:TagKeys condition keys. - *

+ * @see {@link UntagLogGroupCommand} */ - public untagLogGroup( - args: UntagLogGroupCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagLogGroup( - args: UntagLogGroupCommandInput, - cb: (err: any, data?: UntagLogGroupCommandOutput) => void - ): void; - public untagLogGroup( + untagLogGroup(args: UntagLogGroupCommandInput, options?: __HttpHandlerOptions): Promise; + untagLogGroup(args: UntagLogGroupCommandInput, cb: (err: any, data?: UntagLogGroupCommandOutput) => void): void; + untagLogGroup( args: UntagLogGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagLogGroupCommandOutput) => void ): void; - public untagLogGroup( - args: UntagLogGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagLogGroupCommandOutput) => void), - cb?: (err: any, data?: UntagLogGroupCommandOutput) => void - ): Promise | void { - const command = new UntagLogGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from the specified resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

You can use Amazon CloudWatch Logs to monitor, store, and access your log files from + * EC2 instances, CloudTrail, and other sources. You can then retrieve the associated + * log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use + * CloudWatch Logs commands in the Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch + * Logs SDK.

+ *

You can use CloudWatch Logs to:

+ *
    + *
  • + *

    + * Monitor logs from EC2 instances in real time: You + * can use CloudWatch Logs to monitor applications and systems using log data. For example, + * CloudWatch Logs can track the number of errors that occur in your application logs. Then, + * it can send you a notification whenever the rate of errors exceeds a threshold that you + * specify. CloudWatch Logs uses your log data for monitoring so no code changes are + * required. For example, you can monitor application logs for specific literal terms (such + * as "NullReferenceException"). You can also count the number of occurrences of a literal + * term at a particular position in log data (such as "404" status codes in an Apache access + * log). When the term you are searching for is found, CloudWatch Logs reports the data to a + * CloudWatch metric that you specify.

    + *
  • + *
  • + *

    + * Monitor CloudTrail logged events: You can + * create alarms in CloudWatch and receive notifications of particular API activity as + * captured by CloudTrail. You can use the notification to perform troubleshooting.

    + *
  • + *
  • + *

    + * Archive log data: You can use CloudWatch Logs to + * store your log data in highly durable storage. You can change the log retention setting so + * that any log events earlier than this setting are automatically deleted. The CloudWatch + * Logs agent helps to quickly send both rotated and non-rotated log data off of a host and + * into the log service. You can then access the raw log data when you need it.

    + *
  • + *
+ */ +export class CloudWatchLogs extends CloudWatchLogsClient implements CloudWatchLogs {} +createAggregatedClient(commands, CloudWatchLogs); diff --git a/clients/client-cloudwatch/src/CloudWatch.ts b/clients/client-cloudwatch/src/CloudWatch.ts index ecae44ec467f..c4c5e6070432 100644 --- a/clients/client-cloudwatch/src/CloudWatch.ts +++ b/clients/client-cloudwatch/src/CloudWatch.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CloudWatchClient } from "./CloudWatchClient"; +import { CloudWatchClient, CloudWatchClientConfig } from "./CloudWatchClient"; import { DeleteAlarmsCommand, DeleteAlarmsCommandInput, @@ -185,1704 +186,638 @@ import { UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; -/** - * @public - *

Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the - * applications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track - * metrics, which are the variables you want to measure for your resources and - * applications.

- *

CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules - * that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2 - * instances. Then, use this data to determine whether you should launch - * additional instances to handle increased load. You can also use this data to stop - * under-used instances to save - * money.

- *

In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor - * your own custom metrics. With CloudWatch, you gain system-wide visibility into resource - * utilization, application performance, and operational health.

- */ -export class CloudWatch extends CloudWatchClient { +const commands = { + DeleteAlarmsCommand, + DeleteAnomalyDetectorCommand, + DeleteDashboardsCommand, + DeleteInsightRulesCommand, + DeleteMetricStreamCommand, + DescribeAlarmHistoryCommand, + DescribeAlarmsCommand, + DescribeAlarmsForMetricCommand, + DescribeAnomalyDetectorsCommand, + DescribeInsightRulesCommand, + DisableAlarmActionsCommand, + DisableInsightRulesCommand, + EnableAlarmActionsCommand, + EnableInsightRulesCommand, + GetDashboardCommand, + GetInsightRuleReportCommand, + GetMetricDataCommand, + GetMetricStatisticsCommand, + GetMetricStreamCommand, + GetMetricWidgetImageCommand, + ListDashboardsCommand, + ListManagedInsightRulesCommand, + ListMetricsCommand, + ListMetricStreamsCommand, + ListTagsForResourceCommand, + PutAnomalyDetectorCommand, + PutCompositeAlarmCommand, + PutDashboardCommand, + PutInsightRuleCommand, + PutManagedInsightRulesCommand, + PutMetricAlarmCommand, + PutMetricDataCommand, + PutMetricStreamCommand, + SetAlarmStateCommand, + StartMetricStreamsCommand, + StopMetricStreamsCommand, + TagResourceCommand, + UntagResourceCommand, +}; + +export interface CloudWatch { /** - * @public - *

Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more - * than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't - * delete two composite alarms with one operation.

- *

- * If you specify an incorrect alarm name or make any other error in the operation, no alarms are - * deleted. To confirm that alarms were deleted successfully, you can use - * the DescribeAlarms operation after using - * DeleteAlarms.

- * - *

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and - * composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle - * because there is always still a composite alarm that depends on that alarm that you want to delete.

- *

To get out of such a situation, you must - * break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest - * change to make to break a cycle is to change the AlarmRule of one of the alarms to false.

- *

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path. - *

- *
+ * @see {@link DeleteAlarmsCommand} */ - public deleteAlarms( - args: DeleteAlarmsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteAlarms(args: DeleteAlarmsCommandInput, cb: (err: any, data?: DeleteAlarmsCommandOutput) => void): void; - public deleteAlarms( + deleteAlarms(args: DeleteAlarmsCommandInput, options?: __HttpHandlerOptions): Promise; + deleteAlarms(args: DeleteAlarmsCommandInput, cb: (err: any, data?: DeleteAlarmsCommandOutput) => void): void; + deleteAlarms( args: DeleteAlarmsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAlarmsCommandOutput) => void ): void; - public deleteAlarms( - args: DeleteAlarmsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAlarmsCommandOutput) => void), - cb?: (err: any, data?: DeleteAlarmsCommandOutput) => void - ): Promise | void { - const command = new DeleteAlarmsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Deletes the specified anomaly detection model - * from your account. - * For more information - * about - * how to delete an anomaly detection model, - * see Deleting an anomaly detection model - * in the CloudWatch User Guide. - *

+ * @see {@link DeleteAnomalyDetectorCommand} */ - public deleteAnomalyDetector( + deleteAnomalyDetector( args: DeleteAnomalyDetectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAnomalyDetector( + deleteAnomalyDetector( args: DeleteAnomalyDetectorCommandInput, cb: (err: any, data?: DeleteAnomalyDetectorCommandOutput) => void ): void; - public deleteAnomalyDetector( + deleteAnomalyDetector( args: DeleteAnomalyDetectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAnomalyDetectorCommandOutput) => void ): void; - public deleteAnomalyDetector( - args: DeleteAnomalyDetectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAnomalyDetectorCommandOutput) => void), - cb?: (err: any, data?: DeleteAnomalyDetectorCommandOutput) => void - ): Promise | void { - const command = new DeleteAnomalyDetectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes all dashboards that you specify. You - * can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are - * deleted.

+ * @see {@link DeleteDashboardsCommand} */ - public deleteDashboards( + deleteDashboards( args: DeleteDashboardsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDashboards( + deleteDashboards( args: DeleteDashboardsCommandInput, cb: (err: any, data?: DeleteDashboardsCommandOutput) => void ): void; - public deleteDashboards( + deleteDashboards( args: DeleteDashboardsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDashboardsCommandOutput) => void ): void; - public deleteDashboards( - args: DeleteDashboardsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDashboardsCommandOutput) => void), - cb?: (err: any, data?: DeleteDashboardsCommandOutput) => void - ): Promise | void { - const command = new DeleteDashboardsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Permanently deletes the specified Contributor Insights rules.

- *

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time - * the rule was created might - * not be available.

+ * @see {@link DeleteInsightRulesCommand} */ - public deleteInsightRules( + deleteInsightRules( args: DeleteInsightRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInsightRules( + deleteInsightRules( args: DeleteInsightRulesCommandInput, cb: (err: any, data?: DeleteInsightRulesCommandOutput) => void ): void; - public deleteInsightRules( + deleteInsightRules( args: DeleteInsightRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInsightRulesCommandOutput) => void ): void; - public deleteInsightRules( - args: DeleteInsightRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInsightRulesCommandOutput) => void), - cb?: (err: any, data?: DeleteInsightRulesCommandOutput) => void - ): Promise | void { - const command = new DeleteInsightRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Permanently deletes the metric stream that you specify.

+ * @see {@link DeleteMetricStreamCommand} */ - public deleteMetricStream( + deleteMetricStream( args: DeleteMetricStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMetricStream( + deleteMetricStream( args: DeleteMetricStreamCommandInput, cb: (err: any, data?: DeleteMetricStreamCommandOutput) => void ): void; - public deleteMetricStream( + deleteMetricStream( args: DeleteMetricStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMetricStreamCommandOutput) => void ): void; - public deleteMetricStream( - args: DeleteMetricStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMetricStreamCommandOutput) => void), - cb?: (err: any, data?: DeleteMetricStreamCommandOutput) => void - ): Promise | void { - const command = new DeleteMetricStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the history for the specified alarm. You can filter the results by date range or item type. - * If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

- *

CloudWatch retains the history of an alarm even if you delete the alarm.

- *

To use this operation and return information about a composite alarm, you must be signed on with - * the cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return information - * about composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower scope.

+ * @see {@link DescribeAlarmHistoryCommand} */ - public describeAlarmHistory( + describeAlarmHistory( args: DescribeAlarmHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAlarmHistory( + describeAlarmHistory( args: DescribeAlarmHistoryCommandInput, cb: (err: any, data?: DescribeAlarmHistoryCommandOutput) => void ): void; - public describeAlarmHistory( + describeAlarmHistory( args: DescribeAlarmHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAlarmHistoryCommandOutput) => void ): void; - public describeAlarmHistory( - args: DescribeAlarmHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAlarmHistoryCommandOutput) => void), - cb?: (err: any, data?: DescribeAlarmHistoryCommandOutput) => void - ): Promise | void { - const command = new DescribeAlarmHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm - * name, the alarm state, or a prefix for any action.

- *

To use this operation and return information about composite alarms, you must be signed on with - * the cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information - * about composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.

+ * @see {@link DescribeAlarmsCommand} */ - public describeAlarms( + describeAlarms( args: DescribeAlarmsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAlarms( - args: DescribeAlarmsCommandInput, - cb: (err: any, data?: DescribeAlarmsCommandOutput) => void - ): void; - public describeAlarms( + describeAlarms(args: DescribeAlarmsCommandInput, cb: (err: any, data?: DescribeAlarmsCommandOutput) => void): void; + describeAlarms( args: DescribeAlarmsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAlarmsCommandOutput) => void ): void; - public describeAlarms( - args: DescribeAlarmsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAlarmsCommandOutput) => void), - cb?: (err: any, data?: DescribeAlarmsCommandOutput) => void - ): Promise | void { - const command = new DescribeAlarmsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the alarms for the specified metric. To - * filter the results, specify a statistic, period, or unit.

- *

This operation retrieves only standard alarms that are based on - * the specified metric. It does not return alarms based on math expressions that - * use the specified metric, or composite alarms that use the specified metric.

+ * @see {@link DescribeAlarmsForMetricCommand} */ - public describeAlarmsForMetric( + describeAlarmsForMetric( args: DescribeAlarmsForMetricCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAlarmsForMetric( + describeAlarmsForMetric( args: DescribeAlarmsForMetricCommandInput, cb: (err: any, data?: DescribeAlarmsForMetricCommandOutput) => void ): void; - public describeAlarmsForMetric( + describeAlarmsForMetric( args: DescribeAlarmsForMetricCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAlarmsForMetricCommandOutput) => void ): void; - public describeAlarmsForMetric( - args: DescribeAlarmsForMetricCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAlarmsForMetricCommandOutput) => void), - cb?: (err: any, data?: DescribeAlarmsForMetricCommandOutput) => void - ): Promise | void { - const command = new DescribeAlarmsForMetricCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the anomaly detection models that you have created in your account. - * For single metric anomaly detectors, - * you can list all of the models in your account or filter the results - * to only the models that are related to a certain namespace, metric name, or metric dimension. - * For metric math anomaly detectors, - * you can list them by adding METRIC_MATH to the AnomalyDetectorTypes array. - * This will return all metric math anomaly detectors in your account.

+ * @see {@link DescribeAnomalyDetectorsCommand} */ - public describeAnomalyDetectors( + describeAnomalyDetectors( args: DescribeAnomalyDetectorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAnomalyDetectors( + describeAnomalyDetectors( args: DescribeAnomalyDetectorsCommandInput, cb: (err: any, data?: DescribeAnomalyDetectorsCommandOutput) => void ): void; - public describeAnomalyDetectors( + describeAnomalyDetectors( args: DescribeAnomalyDetectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAnomalyDetectorsCommandOutput) => void ): void; - public describeAnomalyDetectors( - args: DescribeAnomalyDetectorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAnomalyDetectorsCommandOutput) => void), - cb?: (err: any, data?: DescribeAnomalyDetectorsCommandOutput) => void - ): Promise | void { - const command = new DescribeAnomalyDetectorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all the Contributor Insights rules in your account.

- *

For more information about Contributor Insights, see - * Using Contributor Insights to Analyze High-Cardinality Data.

+ * @see {@link DescribeInsightRulesCommand} */ - public describeInsightRules( + describeInsightRules( args: DescribeInsightRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInsightRules( + describeInsightRules( args: DescribeInsightRulesCommandInput, cb: (err: any, data?: DescribeInsightRulesCommandOutput) => void ): void; - public describeInsightRules( + describeInsightRules( args: DescribeInsightRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInsightRulesCommandOutput) => void ): void; - public describeInsightRules( - args: DescribeInsightRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInsightRulesCommandOutput) => void), - cb?: (err: any, data?: DescribeInsightRulesCommandOutput) => void - ): Promise | void { - const command = new DescribeInsightRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables the actions for the specified alarms. When an alarm's actions are disabled, the - * alarm actions do not execute when the alarm state changes.

+ * @see {@link DisableAlarmActionsCommand} */ - public disableAlarmActions( + disableAlarmActions( args: DisableAlarmActionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableAlarmActions( + disableAlarmActions( args: DisableAlarmActionsCommandInput, cb: (err: any, data?: DisableAlarmActionsCommandOutput) => void ): void; - public disableAlarmActions( + disableAlarmActions( args: DisableAlarmActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableAlarmActionsCommandOutput) => void ): void; - public disableAlarmActions( - args: DisableAlarmActionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableAlarmActionsCommandOutput) => void), - cb?: (err: any, data?: DisableAlarmActionsCommandOutput) => void - ): Promise | void { - const command = new DisableAlarmActionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do - * not incur costs.

+ * @see {@link DisableInsightRulesCommand} */ - public disableInsightRules( + disableInsightRules( args: DisableInsightRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableInsightRules( + disableInsightRules( args: DisableInsightRulesCommandInput, cb: (err: any, data?: DisableInsightRulesCommandOutput) => void ): void; - public disableInsightRules( + disableInsightRules( args: DisableInsightRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableInsightRulesCommandOutput) => void ): void; - public disableInsightRules( - args: DisableInsightRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableInsightRulesCommandOutput) => void), - cb?: (err: any, data?: DisableInsightRulesCommandOutput) => void - ): Promise | void { - const command = new DisableInsightRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the actions for the specified alarms.

+ * @see {@link EnableAlarmActionsCommand} */ - public enableAlarmActions( + enableAlarmActions( args: EnableAlarmActionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableAlarmActions( + enableAlarmActions( args: EnableAlarmActionsCommandInput, cb: (err: any, data?: EnableAlarmActionsCommandOutput) => void ): void; - public enableAlarmActions( + enableAlarmActions( args: EnableAlarmActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableAlarmActionsCommandOutput) => void ): void; - public enableAlarmActions( - args: EnableAlarmActionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableAlarmActionsCommandOutput) => void), - cb?: (err: any, data?: EnableAlarmActionsCommandOutput) => void - ): Promise | void { - const command = new EnableAlarmActionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.

+ * @see {@link EnableInsightRulesCommand} */ - public enableInsightRules( + enableInsightRules( args: EnableInsightRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableInsightRules( + enableInsightRules( args: EnableInsightRulesCommandInput, cb: (err: any, data?: EnableInsightRulesCommandOutput) => void ): void; - public enableInsightRules( + enableInsightRules( args: EnableInsightRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableInsightRulesCommandOutput) => void ): void; - public enableInsightRules( - args: EnableInsightRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableInsightRulesCommandOutput) => void), - cb?: (err: any, data?: EnableInsightRulesCommandOutput) => void - ): Promise | void { - const command = new EnableInsightRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays the details of the dashboard that you specify.

- *

To copy an existing dashboard, use GetDashboard, and then use the data returned - * within DashboardBody as the template for the new dashboard when you call PutDashboard to create - * the copy.

+ * @see {@link GetDashboardCommand} */ - public getDashboard( - args: GetDashboardCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getDashboard(args: GetDashboardCommandInput, cb: (err: any, data?: GetDashboardCommandOutput) => void): void; - public getDashboard( + getDashboard(args: GetDashboardCommandInput, options?: __HttpHandlerOptions): Promise; + getDashboard(args: GetDashboardCommandInput, cb: (err: any, data?: GetDashboardCommandOutput) => void): void; + getDashboard( args: GetDashboardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDashboardCommandOutput) => void ): void; - public getDashboard( - args: GetDashboardCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDashboardCommandOutput) => void), - cb?: (err: any, data?: GetDashboardCommandOutput) => void - ): Promise | void { - const command = new GetDashboardCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of - * contributors to the log group.

- *

You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:

- *
    - *
  • - *

    - * UniqueContributors -- the number of unique contributors for each data point.

    - *
  • - *
  • - *

    - * MaxContributorValue -- the value of the top contributor for each data point. The identity of the - * contributor might change for each data point in the graph.

    - *

    If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the - * most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified - * by the rule's Value, during that period.

    - *
  • - *
  • - *

    - * SampleCount -- the number of data points matched by the rule.

    - *
  • - *
  • - *

    - * Sum -- the sum of the values from all contributors during the time period represented by that data point.

    - *
  • - *
  • - *

    - * Minimum -- the minimum value from a single observation during the time period represented by that data point.

    - *
  • - *
  • - *

    - * Maximum -- the maximum value from a single observation during the time period represented by that data point.

    - *
  • - *
  • - *

    - * Average -- the average value from all contributors during the time period represented by that data point.

    - *
  • - *
+ * @see {@link GetInsightRuleReportCommand} */ - public getInsightRuleReport( + getInsightRuleReport( args: GetInsightRuleReportCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInsightRuleReport( + getInsightRuleReport( args: GetInsightRuleReportCommandInput, cb: (err: any, data?: GetInsightRuleReportCommandOutput) => void ): void; - public getInsightRuleReport( + getInsightRuleReport( args: GetInsightRuleReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInsightRuleReportCommandOutput) => void ): void; - public getInsightRuleReport( - args: GetInsightRuleReportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInsightRuleReportCommandOutput) => void), - cb?: (err: any, data?: GetInsightRuleReportCommandOutput) => void - ): Promise | void { - const command = new GetInsightRuleReportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

You can use the GetMetricData API to retrieve CloudWatch metric values. The operation - * can also include a CloudWatch Metrics Insights query, and one or more metric math functions.

- *

A GetMetricData operation that does not include a query can retrieve as many as 500 different - * metrics in a single request, with a total of as many as 100,800 data points. You can also - * optionally perform metric math expressions on the values of the returned statistics, to create - * new time series that represent new insights into your data. For example, using Lambda - * metrics, you could divide the Errors metric by the Invocations metric to get an error - * rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User - * Guide.

- *

If you include a Metrics Insights query, each GetMetricData operation can include only one - * query. But the same GetMetricData operation can also retrieve other metrics. Metrics Insights queries - * can query only the most recent three hours of metric data. For more information about Metrics Insights, - * see Query your metrics with CloudWatch Metrics Insights.

- *

Calls to the GetMetricData API have a different pricing structure than - * calls to GetMetricStatistics. For more information about pricing, see - * Amazon CloudWatch Pricing.

- *

Amazon CloudWatch retains metric data as follows:

- *
    - *
  • - *

    Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution - * metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

    - *
  • - *
  • - *

    Data points with a period of 60 seconds (1-minute) are available for 15 days.

    - *
  • - *
  • - *

    Data points with a period of 300 seconds (5-minute) are available for 63 days.

    - *
  • - *
  • - *

    Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

    - *
  • - *
- *

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect - * data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, - * but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with - * a resolution of 1 hour.

- *

If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified - * when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. - * If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

- *

- * Using Metrics Insights queries with metric math - *

- *

You can't mix a Metric Insights query and metric math syntax in the same expression, but - * you can reference results from a Metrics Insights query within other Metric math expressions. A Metrics Insights - * query without a GROUP BY clause returns a single time-series (TS), - * and can be used as input for a metric math expression that expects a single time series. A Metrics Insights - * query with a GROUP BY clause returns an array of time-series (TS[]), - * and can be used as input for a metric math expression that expects an array of time series.

+ * @see {@link GetMetricDataCommand} */ - public getMetricData( - args: GetMetricDataCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getMetricData( - args: GetMetricDataCommandInput, - cb: (err: any, data?: GetMetricDataCommandOutput) => void - ): void; - public getMetricData( + getMetricData(args: GetMetricDataCommandInput, options?: __HttpHandlerOptions): Promise; + getMetricData(args: GetMetricDataCommandInput, cb: (err: any, data?: GetMetricDataCommandOutput) => void): void; + getMetricData( args: GetMetricDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMetricDataCommandOutput) => void ): void; - public getMetricData( - args: GetMetricDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMetricDataCommandOutput) => void), - cb?: (err: any, data?: GetMetricDataCommandOutput) => void - ): Promise | void { - const command = new GetMetricDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets statistics for the specified metric.

- *

The maximum number of data points returned from a single call is 1,440. If - * you request more than 1,440 data points, CloudWatch returns an error. - * To reduce the number of data points, you can narrow the specified time range and make - * multiple requests across adjacent time ranges, or you can increase the specified period. - * Data points are not returned in chronological order.

- *

CloudWatch aggregates data points based on the length of the period - * that you specify. For example, if you request statistics with a one-hour period, - * CloudWatch aggregates all data points with time stamps that fall within each - * one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than - * the number of data points returned.

- *

CloudWatch needs raw data points to calculate percentile statistics. If you publish - * data using a statistic set instead, you can only retrieve - * percentile statistics for this data if one of the following conditions is true:

- *
    - *
  • - *

    The SampleCount value of the statistic set is 1.

    - *
  • - *
  • - *

    The Min and the Max values of the statistic set are equal.

    - *
  • - *
- *

Percentile statistics are not available for metrics when any of the metric values are negative numbers.

- *

Amazon CloudWatch retains metric data as follows:

- *
    - *
  • - *

    Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution - * metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

    - *
  • - *
  • - *

    Data points with a period of 60 seconds (1-minute) are available for 15 days.

    - *
  • - *
  • - *

    Data points with a period of 300 seconds (5-minute) are available for 63 days.

    - *
  • - *
  • - *

    Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

    - *
  • - *
- *

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect - * data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, - * but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with - * a resolution of 1 hour.

- *

CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.

- *

For information about metrics and dimensions supported by Amazon Web Services services, see the - * Amazon CloudWatch Metrics and Dimensions Reference in the - * Amazon CloudWatch User Guide.

+ * @see {@link GetMetricStatisticsCommand} */ - public getMetricStatistics( + getMetricStatistics( args: GetMetricStatisticsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMetricStatistics( + getMetricStatistics( args: GetMetricStatisticsCommandInput, cb: (err: any, data?: GetMetricStatisticsCommandOutput) => void ): void; - public getMetricStatistics( + getMetricStatistics( args: GetMetricStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMetricStatisticsCommandOutput) => void ): void; - public getMetricStatistics( - args: GetMetricStatisticsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMetricStatisticsCommandOutput) => void), - cb?: (err: any, data?: GetMetricStatisticsCommandOutput) => void - ): Promise | void { - const command = new GetMetricStatisticsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the metric stream that you specify.

+ * @see {@link GetMetricStreamCommand} */ - public getMetricStream( + getMetricStream( args: GetMetricStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMetricStream( - args: GetMetricStreamCommandInput, - cb: (err: any, data?: GetMetricStreamCommandOutput) => void - ): void; - public getMetricStream( + getMetricStream(args: GetMetricStreamCommandInput, cb: (err: any, data?: GetMetricStreamCommandOutput) => void): void; + getMetricStream( args: GetMetricStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMetricStreamCommandOutput) => void ): void; - public getMetricStream( - args: GetMetricStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMetricStreamCommandOutput) => void), - cb?: (err: any, data?: GetMetricStreamCommandOutput) => void - ): Promise | void { - const command = new GetMetricStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

You can use the GetMetricWidgetImage API to retrieve a snapshot graph of - * one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this - * image into your services and products, such as wiki pages, reports, and documents. - * You could also retrieve images regularly, such as every minute, and create your own - * custom live dashboard.

- *

The graph you retrieve can include all CloudWatch metric graph features, including metric math - * and horizontal and vertical annotations.

- *

There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:

- *
    - *
  • - *

    As many as 100 metrics in the graph.

    - *
  • - *
  • - *

    Up to 100 KB uncompressed payload.

    - *
  • - *
+ * @see {@link GetMetricWidgetImageCommand} */ - public getMetricWidgetImage( + getMetricWidgetImage( args: GetMetricWidgetImageCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMetricWidgetImage( + getMetricWidgetImage( args: GetMetricWidgetImageCommandInput, cb: (err: any, data?: GetMetricWidgetImageCommandOutput) => void ): void; - public getMetricWidgetImage( + getMetricWidgetImage( args: GetMetricWidgetImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMetricWidgetImageCommandOutput) => void ): void; - public getMetricWidgetImage( - args: GetMetricWidgetImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMetricWidgetImageCommandOutput) => void), - cb?: (err: any, data?: GetMetricWidgetImageCommandOutput) => void - ): Promise | void { - const command = new GetMetricWidgetImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only - * those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are - * listed. - *

- *

- * ListDashboards returns up to 1000 results on one page. If there - * are more than 1000 dashboards, you can call ListDashboards again and - * include the value you received for NextToken in the first call, to receive - * the next 1000 results.

+ * @see {@link ListDashboardsCommand} */ - public listDashboards( + listDashboards( args: ListDashboardsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDashboards( - args: ListDashboardsCommandInput, - cb: (err: any, data?: ListDashboardsCommandOutput) => void - ): void; - public listDashboards( + listDashboards(args: ListDashboardsCommandInput, cb: (err: any, data?: ListDashboardsCommandOutput) => void): void; + listDashboards( args: ListDashboardsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDashboardsCommandOutput) => void ): void; - public listDashboards( - args: ListDashboardsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDashboardsCommandOutput) => void), - cb?: (err: any, data?: ListDashboardsCommandOutput) => void - ): Promise | void { - const command = new ListDashboardsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns a list - * that contains the number - * of managed Contributor Insights rules - * in your account. - * - *

+ * @see {@link ListManagedInsightRulesCommand} */ - public listManagedInsightRules( + listManagedInsightRules( args: ListManagedInsightRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listManagedInsightRules( + listManagedInsightRules( args: ListManagedInsightRulesCommandInput, cb: (err: any, data?: ListManagedInsightRulesCommandOutput) => void ): void; - public listManagedInsightRules( + listManagedInsightRules( args: ListManagedInsightRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListManagedInsightRulesCommandOutput) => void ): void; - public listManagedInsightRules( - args: ListManagedInsightRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListManagedInsightRulesCommandOutput) => void), - cb?: (err: any, data?: ListManagedInsightRulesCommandOutput) => void - ): Promise | void { - const command = new ListManagedInsightRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to get statistical data.

- *

Up to 500 results are returned for any one call. To retrieve additional results, - * use the returned token with subsequent calls.

- *

After you create a metric, allow up to 15 minutes for the metric to appear. To see metric - * statistics sooner, use GetMetricData or GetMetricStatistics.

- *

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and - * view metrics from the linked source accounts. For more information, see - * CloudWatch cross-account observability.

- *

- * ListMetrics doesn't return information about metrics if those metrics haven't - * reported data in the past two weeks. To retrieve those metrics, use - * GetMetricData or - * GetMetricStatistics.

+ * @see {@link ListMetricsCommand} */ - public listMetrics(args: ListMetricsCommandInput, options?: __HttpHandlerOptions): Promise; - public listMetrics(args: ListMetricsCommandInput, cb: (err: any, data?: ListMetricsCommandOutput) => void): void; - public listMetrics( + listMetrics(args: ListMetricsCommandInput, options?: __HttpHandlerOptions): Promise; + listMetrics(args: ListMetricsCommandInput, cb: (err: any, data?: ListMetricsCommandOutput) => void): void; + listMetrics( args: ListMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMetricsCommandOutput) => void ): void; - public listMetrics( - args: ListMetricsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMetricsCommandOutput) => void), - cb?: (err: any, data?: ListMetricsCommandOutput) => void - ): Promise | void { - const command = new ListMetricsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of metric streams in this account.

+ * @see {@link ListMetricStreamsCommand} */ - public listMetricStreams( + listMetricStreams( args: ListMetricStreamsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMetricStreams( + listMetricStreams( args: ListMetricStreamsCommandInput, cb: (err: any, data?: ListMetricStreamsCommandOutput) => void ): void; - public listMetricStreams( + listMetricStreams( args: ListMetricStreamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMetricStreamsCommandOutput) => void ): void; - public listMetricStreams( - args: ListMetricStreamsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMetricStreamsCommandOutput) => void), - cb?: (err: any, data?: ListMetricStreamsCommandOutput) => void - ): Promise | void { - const command = new ListMetricStreamsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays the tags associated with a CloudWatch resource. Currently, alarms - * and Contributor Insights rules support tagging.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an anomaly detection model for a CloudWatch metric. You can use the model - * to display a band of expected normal values when the metric is graphed.

- *

For more information, see CloudWatch Anomaly Detection.

+ * @see {@link PutAnomalyDetectorCommand} */ - public putAnomalyDetector( + putAnomalyDetector( args: PutAnomalyDetectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAnomalyDetector( + putAnomalyDetector( args: PutAnomalyDetectorCommandInput, cb: (err: any, data?: PutAnomalyDetectorCommandOutput) => void ): void; - public putAnomalyDetector( + putAnomalyDetector( args: PutAnomalyDetectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAnomalyDetectorCommandOutput) => void ): void; - public putAnomalyDetector( - args: PutAnomalyDetectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAnomalyDetectorCommandOutput) => void), - cb?: (err: any, data?: PutAnomalyDetectorCommandOutput) => void - ): Promise | void { - const command = new PutAnomalyDetectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates a composite alarm. When you create a composite - * alarm, you specify a rule expression for the alarm that takes into account the alarm - * states of other alarms that you have created. The composite alarm goes into ALARM state - * only if all conditions of the rule are met.

- *

The alarms specified in a composite alarm's rule expression can include metric alarms - * and other composite alarms. The rule expression of a composite alarm can include as many as 100 underlying alarms. - * Any single alarm can be included in the rule expressions of as many as 150 composite alarms.

- *

Using composite alarms can reduce - * alarm noise. You can create multiple metric alarms, - * and also create a composite alarm and - * set up alerts only - * for the composite alarm. For example, you could create a composite - * alarm that goes into ALARM state only when more than one of the underlying metric alarms - * are in ALARM state.

- *

Currently, the only alarm actions that can be taken by composite alarms are notifying - * SNS topics.

- * - *

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and - * composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle - * because there is always still a composite alarm that depends on that alarm that you want to delete.

- *

To get out of such a situation, you must - * break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest - * change to make to break a cycle is to change the AlarmRule of one of the alarms to false.

- *

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path. - *

- *
- *

When this operation creates an alarm, the alarm state is immediately set to - * INSUFFICIENT_DATA. The alarm is then evaluated and its state is set - * appropriately. Any actions associated with the new state are then executed. For a - * composite alarm, this initial time after creation is the only time that - * the - * alarm can be in INSUFFICIENT_DATA state.

- *

When you update an existing alarm, its state is left unchanged, but the update - * completely overwrites the previous configuration of the alarm.

- *

To use this operation, you must be signed on with - * the cloudwatch:PutCompositeAlarm permission that is scoped to *. You can't create a - * composite alarms if your cloudwatch:PutCompositeAlarm permission has a narrower scope.

- *

If you are an IAM user, you must have iam:CreateServiceLinkedRole to create - * a composite alarm that has Systems Manager OpsItem actions.

+ * @see {@link PutCompositeAlarmCommand} */ - public putCompositeAlarm( + putCompositeAlarm( args: PutCompositeAlarmCommandInput, options?: __HttpHandlerOptions ): Promise; - public putCompositeAlarm( + putCompositeAlarm( args: PutCompositeAlarmCommandInput, cb: (err: any, data?: PutCompositeAlarmCommandOutput) => void ): void; - public putCompositeAlarm( + putCompositeAlarm( args: PutCompositeAlarmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutCompositeAlarmCommandOutput) => void ): void; - public putCompositeAlarm( - args: PutCompositeAlarmCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutCompositeAlarmCommandOutput) => void), - cb?: (err: any, data?: PutCompositeAlarmCommandOutput) => void - ): Promise | void { - const command = new PutCompositeAlarmCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, - * the entire contents are replaced with what you specify here.

- *

All dashboards in your account are global, not region-specific.

- *

A simple way to create a dashboard using PutDashboard is to copy an - * existing dashboard. To copy an existing dashboard using the console, you can load the dashboard - * and then use the View/edit source command in the Actions menu to display the JSON block - * for that dashboard. Another way to copy a dashboard is to - * use GetDashboard, and then use the data returned - * within DashboardBody as the template for the new dashboard when you call PutDashboard.

- *

When you create a dashboard with PutDashboard, a good practice is to - * add a text widget at the top of the dashboard with a message that the dashboard was created by script and should - * not be changed in the console. This message could also point console users to the location - * of the DashboardBody script or the CloudFormation template used to create the - * dashboard.

+ * @see {@link PutDashboardCommand} */ - public putDashboard( - args: PutDashboardCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putDashboard(args: PutDashboardCommandInput, cb: (err: any, data?: PutDashboardCommandOutput) => void): void; - public putDashboard( + putDashboard(args: PutDashboardCommandInput, options?: __HttpHandlerOptions): Promise; + putDashboard(args: PutDashboardCommandInput, cb: (err: any, data?: PutDashboardCommandOutput) => void): void; + putDashboard( args: PutDashboardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDashboardCommandOutput) => void ): void; - public putDashboard( - args: PutDashboardCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutDashboardCommandOutput) => void), - cb?: (err: any, data?: PutDashboardCommandOutput) => void - ): Promise | void { - const command = new PutDashboardCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a Contributor Insights rule. Rules evaluate log events in a - * CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, - * see Using Contributor Insights to Analyze High-Cardinality Data.

- *

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time - * the rule was created might not be available.

+ * @see {@link PutInsightRuleCommand} */ - public putInsightRule( + putInsightRule( args: PutInsightRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public putInsightRule( - args: PutInsightRuleCommandInput, - cb: (err: any, data?: PutInsightRuleCommandOutput) => void - ): void; - public putInsightRule( + putInsightRule(args: PutInsightRuleCommandInput, cb: (err: any, data?: PutInsightRuleCommandOutput) => void): void; + putInsightRule( args: PutInsightRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutInsightRuleCommandOutput) => void ): void; - public putInsightRule( - args: PutInsightRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutInsightRuleCommandOutput) => void), - cb?: (err: any, data?: PutInsightRuleCommandOutput) => void - ): Promise | void { - const command = new PutInsightRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Creates a managed Contributor Insights rule - * for a specified Amazon Web Services resource. - * When you enable a managed rule, - * you create a Contributor Insights rule - * that collects data - * from Amazon Web Services services. - * You cannot edit these rules - * with PutInsightRule. - * The rules can be enabled, disabled, and deleted using EnableInsightRules, DisableInsightRules, and DeleteInsightRules. - * If a previously created managed rule is currently disabled, - * a subsequent call - * to this API will re-enable it. - * Use ListManagedInsightRules - * to describe all available rules. - * - *

+ * @see {@link PutManagedInsightRulesCommand} */ - public putManagedInsightRules( + putManagedInsightRules( args: PutManagedInsightRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putManagedInsightRules( + putManagedInsightRules( args: PutManagedInsightRulesCommandInput, cb: (err: any, data?: PutManagedInsightRulesCommandOutput) => void ): void; - public putManagedInsightRules( + putManagedInsightRules( args: PutManagedInsightRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutManagedInsightRulesCommandOutput) => void ): void; - public putManagedInsightRules( - args: PutManagedInsightRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutManagedInsightRulesCommandOutput) => void), - cb?: (err: any, data?: PutManagedInsightRulesCommandOutput) => void - ): Promise | void { - const command = new PutManagedInsightRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates an alarm and associates it with the specified metric, metric math expression, - * anomaly detection model, or Metrics Insights query. For more information about using - * a Metrics Insights query for an alarm, see Create alarms on Metrics Insights queries.

- *

Alarms based on anomaly detection models cannot have Auto Scaling actions.

- *

When this operation creates an alarm, the alarm state is immediately set to - * INSUFFICIENT_DATA. The alarm is then evaluated and its state is set - * appropriately. Any actions associated with the new state are then executed.

- *

When you update an existing alarm, its state is left unchanged, but the - * update completely overwrites the previous configuration of the alarm.

- *

If you are an IAM user, you must have - * Amazon EC2 permissions for some alarm operations:

- *
    - *
  • - *

    The iam:CreateServiceLinkedRole permission for all alarms with EC2 actions

    - *
  • - *
  • - *

    The iam:CreateServiceLinkedRole permissions to create an alarm - * with Systems Manager OpsItem or response plan actions.

    - *
  • - *
- *

The first time you create an alarm in the - * Amazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch - * creates the necessary service-linked role for you. The service-linked roles - * are called AWSServiceRoleForCloudWatchEvents and - * AWSServiceRoleForCloudWatchAlarms_ActionSSM. - * For more information, see Amazon Web Services service-linked role.

- *

- * Cross-account alarms - *

- *

You can set an alarm on metrics in the current account, or in another - * account. To create a cross-account alarm that watches a metric in a different account, you must have completed the following - * pre-requisites:

- *
    - *
  • - *

    The account where the metrics are located (the sharing account) must - * already have a sharing role named CloudWatch-CrossAccountSharingRole. If it does not already - * have this role, you must create it using the instructions in Set up a - * sharing account in - * Cross-account cross-Region CloudWatch console. The policy for that - * role must grant access - * to the ID of the account where you are creating the alarm. - *

    - *
  • - *
  • - *

    The account where you are creating the alarm (the monitoring account) must - * already have a service-linked role named - * AWSServiceRoleForCloudWatchCrossAccount to allow - * CloudWatch to assume the sharing role in the sharing account. If it does not, you must create it following the directions in Set up a - * monitoring account in - * Cross-account cross-Region CloudWatch console.

    - *
  • - *
+ * @see {@link PutMetricAlarmCommand} */ - public putMetricAlarm( + putMetricAlarm( args: PutMetricAlarmCommandInput, options?: __HttpHandlerOptions ): Promise; - public putMetricAlarm( - args: PutMetricAlarmCommandInput, - cb: (err: any, data?: PutMetricAlarmCommandOutput) => void - ): void; - public putMetricAlarm( + putMetricAlarm(args: PutMetricAlarmCommandInput, cb: (err: any, data?: PutMetricAlarmCommandOutput) => void): void; + putMetricAlarm( args: PutMetricAlarmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMetricAlarmCommandOutput) => void ): void; - public putMetricAlarm( - args: PutMetricAlarmCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutMetricAlarmCommandOutput) => void), - cb?: (err: any, data?: PutMetricAlarmCommandOutput) => void - ): Promise | void { - const command = new PutMetricAlarmCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Publishes metric data points to Amazon CloudWatch. CloudWatch associates - * the data points with the specified metric. If the specified metric does not exist, - * CloudWatch creates the metric. When CloudWatch creates a metric, it can - * take up to fifteen minutes for the metric to appear in calls to ListMetrics.

- *

You can publish either individual data points in the Value field, or - * arrays of values and the number of times each value occurred during the period by using the - * Values and Counts fields in the MetricDatum structure. Using - * the Values and Counts method enables you to publish up to 150 values per metric - * with one PutMetricData request, and - * supports retrieving percentile statistics on this data.

- *

Each PutMetricData request is limited to 1 MB in size for HTTP POST requests. You can - * send a payload compressed by gzip. Each request - * is also limited to no more than 1000 different metrics.

- *

Although the Value parameter accepts numbers of type - * Double, CloudWatch rejects values that are either too small - * or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, - * -Infinity) are not supported.

- *

You can use up to 30 dimensions per metric to further clarify what data the metric collects. Each dimension - * consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the - * Amazon CloudWatch User Guide.

- *

You specify the time stamp to be associated with each data point. You can specify - * time stamps that are as much as two weeks before the current date, and as much as 2 hours after - * the current day and time.

- *

Data points with time stamps from 24 hours ago or longer can take at least 48 - * hours to become available for GetMetricData or - * GetMetricStatistics from the time they - * are submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available - * for for GetMetricData or - * GetMetricStatistics.

- *

CloudWatch needs raw data points to calculate percentile statistics. If you publish - * data using a statistic set instead, you can only retrieve - * percentile statistics for this data if one of the following conditions is true:

- *
    - *
  • - *

    The SampleCount value of the statistic set is 1 and Min, - * Max, and Sum are all equal.

    - *
  • - *
  • - *

    The Min and - * Max are equal, and Sum is equal to Min - * multiplied by SampleCount.

    - *
  • - *
+ * @see {@link PutMetricDataCommand} */ - public putMetricData( - args: PutMetricDataCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putMetricData( - args: PutMetricDataCommandInput, - cb: (err: any, data?: PutMetricDataCommandOutput) => void - ): void; - public putMetricData( + putMetricData(args: PutMetricDataCommandInput, options?: __HttpHandlerOptions): Promise; + putMetricData(args: PutMetricDataCommandInput, cb: (err: any, data?: PutMetricDataCommandOutput) => void): void; + putMetricData( args: PutMetricDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMetricDataCommandOutput) => void ): void; - public putMetricData( - args: PutMetricDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutMetricDataCommandOutput) => void), - cb?: (err: any, data?: PutMetricDataCommandOutput) => void - ): Promise | void { - const command = new PutMetricDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates a metric stream. Metric streams can automatically stream CloudWatch - * metrics to Amazon Web Services destinations, including Amazon S3, and to many third-party - * solutions.

- *

For more information, see - * Using Metric Streams.

- *

To create a metric stream, you must be signed in to an account that has the - * iam:PassRole permission and either the - * CloudWatchFullAccess policy or the - * cloudwatch:PutMetricStream permission.

- *

When you create or update a metric stream, you choose one of the following:

- *
    - *
  • - *

    Stream metrics from all metric namespaces in the account.

    - *
  • - *
  • - *

    Stream metrics from all metric namespaces in the account, except - * for the namespaces that you list in ExcludeFilters.

    - *
  • - *
  • - *

    Stream metrics from only the metric namespaces that you list in - * IncludeFilters.

    - *
  • - *
- *

By default, a metric stream always sends the MAX, MIN, - * SUM, and SAMPLECOUNT statistics for each metric that is - * streamed. You can use the StatisticsConfigurations parameter to have the - * metric stream send additional statistics in the stream. Streaming additional statistics - * incurs additional costs. For more information, see Amazon CloudWatch Pricing.

- *

When you use PutMetricStream to create a new metric stream, the stream - * is created in the running state. If you use it to update an existing stream, - * the state of the stream is not changed.

- *

If you are using CloudWatch cross-account observability and you create a metric stream in a monitoring account, - * you can choose whether to include metrics from source accounts in the stream. For more information, see - * CloudWatch cross-account observability.

+ * @see {@link PutMetricStreamCommand} */ - public putMetricStream( + putMetricStream( args: PutMetricStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public putMetricStream( - args: PutMetricStreamCommandInput, - cb: (err: any, data?: PutMetricStreamCommandOutput) => void - ): void; - public putMetricStream( + putMetricStream(args: PutMetricStreamCommandInput, cb: (err: any, data?: PutMetricStreamCommandOutput) => void): void; + putMetricStream( args: PutMetricStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMetricStreamCommandOutput) => void ): void; - public putMetricStream( - args: PutMetricStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutMetricStreamCommandOutput) => void), - cb?: (err: any, data?: PutMetricStreamCommandOutput) => void - ): Promise | void { - const command = new PutMetricStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Temporarily sets the state of an alarm for testing purposes. When the updated - * state differs from the previous value, the action configured for - * the appropriate state is invoked. For example, if your alarm is configured to send an - * Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to - * ALARM sends an SNS message.

- *

Metric alarms - * returns to their actual state quickly, often within seconds. Because the metric alarm state change - * happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through - * DescribeAlarmHistory.

- *

If you use SetAlarmState on a composite alarm, the composite alarm is not guaranteed to return - * to its actual state. It - * returns to its actual state only once any of its children alarms change state. It is also - * reevaluated if you update its - * configuration.

- *

If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include - * information in the StateReasonData parameter to enable the policy to take the correct action.

+ * @see {@link SetAlarmStateCommand} */ - public setAlarmState( - args: SetAlarmStateCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public setAlarmState( - args: SetAlarmStateCommandInput, - cb: (err: any, data?: SetAlarmStateCommandOutput) => void - ): void; - public setAlarmState( + setAlarmState(args: SetAlarmStateCommandInput, options?: __HttpHandlerOptions): Promise; + setAlarmState(args: SetAlarmStateCommandInput, cb: (err: any, data?: SetAlarmStateCommandOutput) => void): void; + setAlarmState( args: SetAlarmStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetAlarmStateCommandOutput) => void ): void; - public setAlarmState( - args: SetAlarmStateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetAlarmStateCommandOutput) => void), - cb?: (err: any, data?: SetAlarmStateCommandOutput) => void - ): Promise | void { - const command = new SetAlarmStateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts the streaming of metrics for one or more of your metric streams.

+ * @see {@link StartMetricStreamsCommand} */ - public startMetricStreams( + startMetricStreams( args: StartMetricStreamsCommandInput, options?: __HttpHandlerOptions ): Promise; - public startMetricStreams( + startMetricStreams( args: StartMetricStreamsCommandInput, cb: (err: any, data?: StartMetricStreamsCommandOutput) => void ): void; - public startMetricStreams( + startMetricStreams( args: StartMetricStreamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMetricStreamsCommandOutput) => void ): void; - public startMetricStreams( - args: StartMetricStreamsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartMetricStreamsCommandOutput) => void), - cb?: (err: any, data?: StartMetricStreamsCommandOutput) => void - ): Promise | void { - const command = new StartMetricStreamsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops the streaming of metrics for one or more of your metric streams.

+ * @see {@link StopMetricStreamsCommand} */ - public stopMetricStreams( + stopMetricStreams( args: StopMetricStreamsCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopMetricStreams( + stopMetricStreams( args: StopMetricStreamsCommandInput, cb: (err: any, data?: StopMetricStreamsCommandOutput) => void ): void; - public stopMetricStreams( + stopMetricStreams( args: StopMetricStreamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopMetricStreamsCommandOutput) => void ): void; - public stopMetricStreams( - args: StopMetricStreamsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopMetricStreamsCommandOutput) => void), - cb?: (err: any, data?: StopMetricStreamsCommandOutput) => void - ): Promise | void { - const command = new StopMetricStreamsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that - * can be tagged are alarms and Contributor Insights rules.

- *

Tags can help you organize and categorize your resources. You can also use them to scope user - * permissions by granting a user - * permission to access or change only resources with certain tag values.

- *

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

- *

You can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, - * this tag is appended to the list of tags associated - * with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces - * the previous value for that tag.

- *

You can associate as many as 50 tags with a CloudWatch resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from the specified resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the + * applications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track + * metrics, which are the variables you want to measure for your resources and + * applications.

+ *

CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules + * that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2 + * instances. Then, use this data to determine whether you should launch + * additional instances to handle increased load. You can also use this data to stop + * under-used instances to save + * money.

+ *

In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor + * your own custom metrics. With CloudWatch, you gain system-wide visibility into resource + * utilization, application performance, and operational health.

+ */ +export class CloudWatch extends CloudWatchClient implements CloudWatch {} +createAggregatedClient(commands, CloudWatch); diff --git a/clients/client-codeartifact/src/Codeartifact.ts b/clients/client-codeartifact/src/Codeartifact.ts index 4511684ab415..618affeda7b4 100644 --- a/clients/client-codeartifact/src/Codeartifact.ts +++ b/clients/client-codeartifact/src/Codeartifact.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CodeartifactClient } from "./CodeartifactClient"; +import { CodeartifactClient, CodeartifactClientConfig } from "./CodeartifactClient"; import { AssociateExternalConnectionCommand, AssociateExternalConnectionCommandInput, @@ -185,1716 +186,923 @@ import { UpdateRepositoryCommandOutput, } from "./commands/UpdateRepositoryCommand"; -/** - * @public - *

CodeArtifact is a fully managed artifact repository compatible with language-native - * package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to - * share packages with development teams and pull packages. Packages can be pulled from both - * public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact - * repository and another repository, which effectively merges their contents from the point of - * view of a package manager client.

- *

- * CodeArtifact Components - *

- *

Use the information in this guide to help you work with the following CodeArtifact components:

- *
    - *
  • - *

    - * Repository: A CodeArtifact repository contains a set of package - * versions, each of which maps to a set of assets, or files. Repositories are - * polyglot, so a single repository can contain packages of any supported type. Each - * repository exposes endpoints for fetching and publishing packages using tools like the - * - * npm - * CLI, the Maven CLI ( - * mvn - * ), Python CLIs ( - * pip - * and twine), and NuGet CLIs (nuget and dotnet).

    - *
  • - *
  • - *

    - * Domain: Repositories are aggregated into a higher-level entity known as a - * domain. All package assets and metadata are stored in the domain, - * but are consumed through repositories. A given package asset, such as a Maven JAR file, is - * stored once per domain, no matter how many repositories it's present in. All of the assets - * and metadata in a domain are encrypted with the same customer master key (CMK) stored in - * Key Management Service (KMS).

    - *

    Each repository is a member of a single domain and can't be moved to a - * different domain.

    - *

    The domain allows organizational policy to be applied across multiple - * repositories, such as which accounts can access repositories in the domain, and - * which public repositories can be used as sources of packages.

    - *

    Although an organization can have multiple domains, we recommend a single production - * domain that contains all published artifacts so that teams can find and share packages - * across their organization.

    - *
  • - *
  • - *

    - * Package: A package is a bundle of software and the metadata required to - * resolve dependencies and install the software. CodeArtifact supports npm, PyPI, Maven, and NuGet package formats.

    - *

    In CodeArtifact, a package consists of:

    - *
      - *
    • - *

      A name (for example, webpack is the name of a - * popular npm package)

      - *
    • - *
    • - *

      An optional namespace (for example, @types in @types/node)

      - *
    • - *
    • - *

      A set of versions (for example, 1.0.0, 1.0.1, - * 1.0.2, etc.)

      - *
    • - *
    • - *

      Package-level metadata (for example, npm tags)

      - *
    • - *
    - *
  • - *
  • - *

    - * Package version: A version of a package, such as @types/node 12.6.9. The version number - * format and semantics vary for different package formats. For example, npm package versions - * must conform to the Semantic Versioning - * specification. In CodeArtifact, a package version consists of the version identifier, - * metadata at the package version level, and a set of assets.

    - *
  • - *
  • - *

    - * Upstream repository: One repository is upstream of another when the package versions in - * it can be accessed from the repository endpoint of the downstream repository, effectively - * merging the contents of the two repositories from the point of view of a client. CodeArtifact - * allows creating an upstream relationship between two repositories.

    - *
  • - *
  • - *

    - * Asset: An individual file stored in CodeArtifact associated with a package version, such as an npm - * .tgz file or Maven POM and JAR files.

    - *
  • - *
- *

CodeArtifact supports these operations:

- *
    - *
  • - *

    - * AssociateExternalConnection: Adds an existing external - * connection to a repository. - *

    - *
  • - *
  • - *

    - * CopyPackageVersions: Copies package versions from one - * repository to another repository in the same domain.

    - *
  • - *
  • - *

    - * CreateDomain: Creates a domain

    - *
  • - *
  • - *

    - * CreateRepository: Creates a CodeArtifact repository in a domain.

    - *
  • - *
  • - *

    - * DeleteDomain: Deletes a domain. You cannot delete a domain that contains - * repositories.

    - *
  • - *
  • - *

    - * DeleteDomainPermissionsPolicy: Deletes the resource policy that is set on a domain.

    - *
  • - *
  • - *

    - * DeletePackage: Deletes a package and all associated package versions.

    - *
  • - *
  • - *

    - * DeletePackageVersions: Deletes versions of a package. After a package has - * been deleted, it can be republished, but its assets and metadata cannot be restored - * because they have been permanently removed from storage.

    - *
  • - *
  • - *

    - * DeleteRepository: Deletes a repository. - *

    - *
  • - *
  • - *

    - * DeleteRepositoryPermissionsPolicy: Deletes the resource policy that is set on a repository.

    - *
  • - *
  • - *

    - * DescribeDomain: Returns a DomainDescription object that - * contains information about the requested domain.

    - *
  • - *
  • - *

    - * DescribePackage: Returns a PackageDescription - * object that contains details about a package.

    - *
  • - *
  • - *

    - * DescribePackageVersion: Returns a PackageVersionDescription - * object that contains details about a package version.

    - *
  • - *
  • - *

    - * DescribeRepository: Returns a RepositoryDescription object - * that contains detailed information about the requested repository.

    - *
  • - *
  • - *

    - * DisposePackageVersions: Disposes versions of a package. A package version - * with the status Disposed cannot be restored because they have been - * permanently removed from storage.

    - *
  • - *
  • - *

    - * DisassociateExternalConnection: Removes an existing external connection from a repository. - *

    - *
  • - *
  • - *

    - * GetAuthorizationToken: Generates a temporary authorization token for accessing repositories in the domain. The token expires the authorization period has passed. - * The default authorization period is 12 hours and can be customized to any length with a maximum of 12 hours.

    - *
  • - *
  • - *

    - * GetDomainPermissionsPolicy: Returns the policy of a resource - * that is attached to the specified domain.

    - *
  • - *
  • - *

    - * GetPackageVersionAsset: Returns the contents of an asset that is in a package version.

    - *
  • - *
  • - *

    - * GetPackageVersionReadme: Gets the readme file or descriptive text for a package version.

    - *
  • - *
  • - *

    - * GetRepositoryEndpoint: Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each - * package format: - *

    - *
      - *
    • - *

      - * maven - *

      - *
    • - *
    • - *

      - * npm - *

      - *
    • - *
    • - *

      - * nuget - *

      - *
    • - *
    • - *

      - * pypi - *

      - *
    • - *
    - *
  • - *
  • - *

    - * GetRepositoryPermissionsPolicy: Returns the resource policy that is set on a repository. - *

    - *
  • - *
  • - *

    - * ListDomains: Returns a list of DomainSummary objects. Each - * returned DomainSummary object contains information about a domain.

    - *
  • - *
  • - *

    - * ListPackages: Lists the packages in a repository.

    - *
  • - *
  • - *

    - * ListPackageVersionAssets: Lists the assets for a given package version.

    - *
  • - *
  • - *

    - * ListPackageVersionDependencies: Returns a list of the direct dependencies for a - * package version.

    - *
  • - *
  • - *

    - * ListPackageVersions: Returns a list of package versions for a specified - * package in a repository.

    - *
  • - *
  • - *

    - * ListRepositories: Returns a list of repositories owned by the Amazon Web Services account that called this method.

    - *
  • - *
  • - *

    - * ListRepositoriesInDomain: Returns a list of the repositories in a domain.

    - *
  • - *
  • - *

    - * PublishPackageVersion: Creates a new package version containing one or more assets.

    - *
  • - *
  • - *

    - * PutDomainPermissionsPolicy: Attaches a resource policy to a domain.

    - *
  • - *
  • - *

    - * PutPackageOriginConfiguration: Sets the package origin configuration for a package, which determine - * how new versions of the package can be added to a specific repository.

    - *
  • - *
  • - *

    - * PutRepositoryPermissionsPolicy: Sets the resource policy on a repository - * that specifies permissions to access it.

    - *
  • - *
  • - *

    - * UpdatePackageVersionsStatus: Updates the status of one or more versions of a package.

    - *
  • - *
  • - *

    - * UpdateRepository: Updates the properties of a repository.

    - *
  • - *
- */ -export class Codeartifact extends CodeartifactClient { +const commands = { + AssociateExternalConnectionCommand, + CopyPackageVersionsCommand, + CreateDomainCommand, + CreateRepositoryCommand, + DeleteDomainCommand, + DeleteDomainPermissionsPolicyCommand, + DeletePackageCommand, + DeletePackageVersionsCommand, + DeleteRepositoryCommand, + DeleteRepositoryPermissionsPolicyCommand, + DescribeDomainCommand, + DescribePackageCommand, + DescribePackageVersionCommand, + DescribeRepositoryCommand, + DisassociateExternalConnectionCommand, + DisposePackageVersionsCommand, + GetAuthorizationTokenCommand, + GetDomainPermissionsPolicyCommand, + GetPackageVersionAssetCommand, + GetPackageVersionReadmeCommand, + GetRepositoryEndpointCommand, + GetRepositoryPermissionsPolicyCommand, + ListDomainsCommand, + ListPackagesCommand, + ListPackageVersionAssetsCommand, + ListPackageVersionDependenciesCommand, + ListPackageVersionsCommand, + ListRepositoriesCommand, + ListRepositoriesInDomainCommand, + ListTagsForResourceCommand, + PublishPackageVersionCommand, + PutDomainPermissionsPolicyCommand, + PutPackageOriginConfigurationCommand, + PutRepositoryPermissionsPolicyCommand, + TagResourceCommand, + UntagResourceCommand, + UpdatePackageVersionsStatusCommand, + UpdateRepositoryCommand, +}; + +export interface Codeartifact { /** - * @public - *

Adds an existing external connection to a repository. One external connection is allowed - * per repository.

- * - *

A repository can have one or more upstream repositories, or an external connection.

- *
+ * @see {@link AssociateExternalConnectionCommand} */ - public associateExternalConnection( + associateExternalConnection( args: AssociateExternalConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateExternalConnection( + associateExternalConnection( args: AssociateExternalConnectionCommandInput, cb: (err: any, data?: AssociateExternalConnectionCommandOutput) => void ): void; - public associateExternalConnection( + associateExternalConnection( args: AssociateExternalConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateExternalConnectionCommandOutput) => void ): void; - public associateExternalConnection( - args: AssociateExternalConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateExternalConnectionCommandOutput) => void), - cb?: (err: any, data?: AssociateExternalConnectionCommandOutput) => void - ): Promise | void { - const command = new AssociateExternalConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Copies package versions from one repository to another repository in the same domain. - *

- * - *

- * You must specify versions or versionRevisions. You cannot specify both. - *

- *
+ * @see {@link CopyPackageVersionsCommand} */ - public copyPackageVersions( + copyPackageVersions( args: CopyPackageVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public copyPackageVersions( + copyPackageVersions( args: CopyPackageVersionsCommandInput, cb: (err: any, data?: CopyPackageVersionsCommandOutput) => void ): void; - public copyPackageVersions( + copyPackageVersions( args: CopyPackageVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyPackageVersionsCommandOutput) => void ): void; - public copyPackageVersions( - args: CopyPackageVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopyPackageVersionsCommandOutput) => void), - cb?: (err: any, data?: CopyPackageVersionsCommandOutput) => void - ): Promise | void { - const command = new CopyPackageVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Creates a domain. CodeArtifact domains make it easier to manage multiple repositories across an - * organization. You can use a domain to apply permissions across many - * repositories owned by different Amazon Web Services accounts. An asset is stored only once - * in a domain, even if it's in multiple repositories. - *

- *

Although you can have multiple domains, we recommend a single production domain that contains all - * published artifacts so that your development teams can find and share packages. You can use a second - * pre-production domain to test changes to the production domain configuration. - *

+ * @see {@link CreateDomainCommand} */ - public createDomain( - args: CreateDomainCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createDomain(args: CreateDomainCommandInput, cb: (err: any, data?: CreateDomainCommandOutput) => void): void; - public createDomain( + createDomain(args: CreateDomainCommandInput, options?: __HttpHandlerOptions): Promise; + createDomain(args: CreateDomainCommandInput, cb: (err: any, data?: CreateDomainCommandOutput) => void): void; + createDomain( args: CreateDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDomainCommandOutput) => void ): void; - public createDomain( - args: CreateDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDomainCommandOutput) => void), - cb?: (err: any, data?: CreateDomainCommandOutput) => void - ): Promise | void { - const command = new CreateDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Creates a repository. - *

+ * @see {@link CreateRepositoryCommand} */ - public createRepository( + createRepository( args: CreateRepositoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRepository( + createRepository( args: CreateRepositoryCommandInput, cb: (err: any, data?: CreateRepositoryCommandOutput) => void ): void; - public createRepository( + createRepository( args: CreateRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRepositoryCommandOutput) => void ): void; - public createRepository( - args: CreateRepositoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRepositoryCommandOutput) => void), - cb?: (err: any, data?: CreateRepositoryCommandOutput) => void - ): Promise | void { - const command = new CreateRepositoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain - * with repositories, first delete its repositories. - *

+ * @see {@link DeleteDomainCommand} */ - public deleteDomain( - args: DeleteDomainCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDomain(args: DeleteDomainCommandInput, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void; - public deleteDomain( + deleteDomain(args: DeleteDomainCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDomain(args: DeleteDomainCommandInput, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void; + deleteDomain( args: DeleteDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDomainCommandOutput) => void ): void; - public deleteDomain( - args: DeleteDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDomainCommandOutput) => void), - cb?: (err: any, data?: DeleteDomainCommandOutput) => void - ): Promise | void { - const command = new DeleteDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Deletes the resource policy set on a domain. - *

+ * @see {@link DeleteDomainPermissionsPolicyCommand} */ - public deleteDomainPermissionsPolicy( + deleteDomainPermissionsPolicy( args: DeleteDomainPermissionsPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDomainPermissionsPolicy( + deleteDomainPermissionsPolicy( args: DeleteDomainPermissionsPolicyCommandInput, cb: (err: any, data?: DeleteDomainPermissionsPolicyCommandOutput) => void ): void; - public deleteDomainPermissionsPolicy( + deleteDomainPermissionsPolicy( args: DeleteDomainPermissionsPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDomainPermissionsPolicyCommandOutput) => void ): void; - public deleteDomainPermissionsPolicy( - args: DeleteDomainPermissionsPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDomainPermissionsPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteDomainPermissionsPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteDomainPermissionsPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a package and all associated package versions. A deleted package cannot be restored. To delete one or more package versions, use the - * DeletePackageVersions API.

+ * @see {@link DeletePackageCommand} */ - public deletePackage( - args: DeletePackageCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deletePackage( - args: DeletePackageCommandInput, - cb: (err: any, data?: DeletePackageCommandOutput) => void - ): void; - public deletePackage( + deletePackage(args: DeletePackageCommandInput, options?: __HttpHandlerOptions): Promise; + deletePackage(args: DeletePackageCommandInput, cb: (err: any, data?: DeletePackageCommandOutput) => void): void; + deletePackage( args: DeletePackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePackageCommandOutput) => void ): void; - public deletePackage( - args: DeletePackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePackageCommandOutput) => void), - cb?: (err: any, data?: DeletePackageCommandOutput) => void - ): Promise | void { - const command = new DeletePackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes one or more versions of a package. A deleted package version cannot be restored - * in your repository. If you want to remove a package version from your repository and be able - * to restore it later, set its status to Archived. Archived packages cannot be - * downloaded from a repository and don't show up with list package APIs (for example, - * ListPackageVersions), but you can restore them using UpdatePackageVersionsStatus.

+ * @see {@link DeletePackageVersionsCommand} */ - public deletePackageVersions( + deletePackageVersions( args: DeletePackageVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePackageVersions( + deletePackageVersions( args: DeletePackageVersionsCommandInput, cb: (err: any, data?: DeletePackageVersionsCommandOutput) => void ): void; - public deletePackageVersions( + deletePackageVersions( args: DeletePackageVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePackageVersionsCommandOutput) => void ): void; - public deletePackageVersions( - args: DeletePackageVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePackageVersionsCommandOutput) => void), - cb?: (err: any, data?: DeletePackageVersionsCommandOutput) => void - ): Promise | void { - const command = new DeletePackageVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Deletes a repository. - *

+ * @see {@link DeleteRepositoryCommand} */ - public deleteRepository( + deleteRepository( args: DeleteRepositoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRepository( + deleteRepository( args: DeleteRepositoryCommandInput, cb: (err: any, data?: DeleteRepositoryCommandOutput) => void ): void; - public deleteRepository( + deleteRepository( args: DeleteRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRepositoryCommandOutput) => void ): void; - public deleteRepository( - args: DeleteRepositoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRepositoryCommandOutput) => void), - cb?: (err: any, data?: DeleteRepositoryCommandOutput) => void - ): Promise | void { - const command = new DeleteRepositoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Deletes the resource policy that is set on a repository. After a resource policy is deleted, the - * permissions allowed and denied by the deleted policy are removed. The effect of deleting a resource policy might not be immediate. - *

- * - *

- * Use DeleteRepositoryPermissionsPolicy with caution. After a policy is deleted, Amazon Web Services users, roles, and accounts lose permissions to perform - * the repository actions granted by the deleted policy. - *

- *
+ * @see {@link DeleteRepositoryPermissionsPolicyCommand} */ - public deleteRepositoryPermissionsPolicy( + deleteRepositoryPermissionsPolicy( args: DeleteRepositoryPermissionsPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRepositoryPermissionsPolicy( + deleteRepositoryPermissionsPolicy( args: DeleteRepositoryPermissionsPolicyCommandInput, cb: (err: any, data?: DeleteRepositoryPermissionsPolicyCommandOutput) => void ): void; - public deleteRepositoryPermissionsPolicy( + deleteRepositoryPermissionsPolicy( args: DeleteRepositoryPermissionsPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRepositoryPermissionsPolicyCommandOutput) => void ): void; - public deleteRepositoryPermissionsPolicy( - args: DeleteRepositoryPermissionsPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRepositoryPermissionsPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteRepositoryPermissionsPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteRepositoryPermissionsPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns a - * DomainDescription - * object that contains information about the requested domain. - *

+ * @see {@link DescribeDomainCommand} */ - public describeDomain( + describeDomain( args: DescribeDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDomain( - args: DescribeDomainCommandInput, - cb: (err: any, data?: DescribeDomainCommandOutput) => void - ): void; - public describeDomain( + describeDomain(args: DescribeDomainCommandInput, cb: (err: any, data?: DescribeDomainCommandOutput) => void): void; + describeDomain( args: DescribeDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDomainCommandOutput) => void ): void; - public describeDomain( - args: DescribeDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDomainCommandOutput) => void), - cb?: (err: any, data?: DescribeDomainCommandOutput) => void - ): Promise | void { - const command = new DescribeDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a - * PackageDescription - * object that contains information about the requested package.

+ * @see {@link DescribePackageCommand} */ - public describePackage( + describePackage( args: DescribePackageCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePackage( - args: DescribePackageCommandInput, - cb: (err: any, data?: DescribePackageCommandOutput) => void - ): void; - public describePackage( + describePackage(args: DescribePackageCommandInput, cb: (err: any, data?: DescribePackageCommandOutput) => void): void; + describePackage( args: DescribePackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePackageCommandOutput) => void ): void; - public describePackage( - args: DescribePackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePackageCommandOutput) => void), - cb?: (err: any, data?: DescribePackageCommandOutput) => void - ): Promise | void { - const command = new DescribePackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns a - * PackageVersionDescription - * object that contains information about the requested package version. - *

+ * @see {@link DescribePackageVersionCommand} */ - public describePackageVersion( + describePackageVersion( args: DescribePackageVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePackageVersion( + describePackageVersion( args: DescribePackageVersionCommandInput, cb: (err: any, data?: DescribePackageVersionCommandOutput) => void ): void; - public describePackageVersion( + describePackageVersion( args: DescribePackageVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePackageVersionCommandOutput) => void ): void; - public describePackageVersion( - args: DescribePackageVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePackageVersionCommandOutput) => void), - cb?: (err: any, data?: DescribePackageVersionCommandOutput) => void - ): Promise | void { - const command = new DescribePackageVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns a RepositoryDescription object that contains detailed information - * about the requested repository. - *

+ * @see {@link DescribeRepositoryCommand} */ - public describeRepository( + describeRepository( args: DescribeRepositoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRepository( + describeRepository( args: DescribeRepositoryCommandInput, cb: (err: any, data?: DescribeRepositoryCommandOutput) => void ): void; - public describeRepository( + describeRepository( args: DescribeRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRepositoryCommandOutput) => void ): void; - public describeRepository( - args: DescribeRepositoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRepositoryCommandOutput) => void), - cb?: (err: any, data?: DescribeRepositoryCommandOutput) => void - ): Promise | void { - const command = new DescribeRepositoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Removes an existing external connection from a repository. - *

+ * @see {@link DisassociateExternalConnectionCommand} */ - public disassociateExternalConnection( + disassociateExternalConnection( args: DisassociateExternalConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateExternalConnection( + disassociateExternalConnection( args: DisassociateExternalConnectionCommandInput, cb: (err: any, data?: DisassociateExternalConnectionCommandOutput) => void ): void; - public disassociateExternalConnection( + disassociateExternalConnection( args: DisassociateExternalConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateExternalConnectionCommandOutput) => void ): void; - public disassociateExternalConnection( - args: DisassociateExternalConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateExternalConnectionCommandOutput) => void), - cb?: (err: any, data?: DisassociateExternalConnectionCommandOutput) => void - ): Promise | void { - const command = new DisassociateExternalConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Deletes the assets in package versions and sets the package versions' status to Disposed. - * A disposed package version cannot be restored in your repository because its assets are deleted. - *

- *

- * To view all disposed package versions in a repository, use ListPackageVersions and set the - * status parameter - * to Disposed. - *

- *

- * To view information about a disposed package version, use DescribePackageVersion. - *

+ * @see {@link DisposePackageVersionsCommand} */ - public disposePackageVersions( + disposePackageVersions( args: DisposePackageVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public disposePackageVersions( + disposePackageVersions( args: DisposePackageVersionsCommandInput, cb: (err: any, data?: DisposePackageVersionsCommandOutput) => void ): void; - public disposePackageVersions( + disposePackageVersions( args: DisposePackageVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisposePackageVersionsCommandOutput) => void ): void; - public disposePackageVersions( - args: DisposePackageVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisposePackageVersionsCommandOutput) => void), - cb?: (err: any, data?: DisposePackageVersionsCommandOutput) => void - ): Promise | void { - const command = new DisposePackageVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Generates a temporary authorization token for accessing repositories in the domain. - * This API requires the codeartifact:GetAuthorizationToken and sts:GetServiceBearerToken permissions. - * For more information about authorization tokens, see - * CodeArtifact authentication and tokens. - *

- * - *

CodeArtifact authorization tokens are valid for a period of 12 hours when created with the login command. - * You can call login periodically to refresh the token. When - * you create an authorization token with the GetAuthorizationToken API, you can set a custom authorization period, - * up to a maximum of 12 hours, with the durationSeconds parameter.

- *

The authorization period begins after login - * or GetAuthorizationToken is called. If login or GetAuthorizationToken is called while - * assuming a role, the token lifetime is independent of the maximum session duration - * of the role. For example, if you call sts assume-role and specify a session duration of 15 minutes, then - * generate a CodeArtifact authorization token, the token will be valid for the full authorization period - * even though this is longer than the 15-minute session duration.

- *

See - * Using IAM Roles - * for more information on controlling session duration.

- *
+ * @see {@link GetAuthorizationTokenCommand} */ - public getAuthorizationToken( + getAuthorizationToken( args: GetAuthorizationTokenCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAuthorizationToken( + getAuthorizationToken( args: GetAuthorizationTokenCommandInput, cb: (err: any, data?: GetAuthorizationTokenCommandOutput) => void ): void; - public getAuthorizationToken( + getAuthorizationToken( args: GetAuthorizationTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAuthorizationTokenCommandOutput) => void ): void; - public getAuthorizationToken( - args: GetAuthorizationTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAuthorizationTokenCommandOutput) => void), - cb?: (err: any, data?: GetAuthorizationTokenCommandOutput) => void - ): Promise | void { - const command = new GetAuthorizationTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns the resource policy attached to the specified domain. - *

- * - *

- * The policy is a resource-based policy, not an identity-based policy. For more information, see - * Identity-based policies - * and resource-based policies in the IAM User Guide. - *

- *
+ * @see {@link GetDomainPermissionsPolicyCommand} */ - public getDomainPermissionsPolicy( + getDomainPermissionsPolicy( args: GetDomainPermissionsPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDomainPermissionsPolicy( + getDomainPermissionsPolicy( args: GetDomainPermissionsPolicyCommandInput, cb: (err: any, data?: GetDomainPermissionsPolicyCommandOutput) => void ): void; - public getDomainPermissionsPolicy( + getDomainPermissionsPolicy( args: GetDomainPermissionsPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDomainPermissionsPolicyCommandOutput) => void ): void; - public getDomainPermissionsPolicy( - args: GetDomainPermissionsPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDomainPermissionsPolicyCommandOutput) => void), - cb?: (err: any, data?: GetDomainPermissionsPolicyCommandOutput) => void - ): Promise | void { - const command = new GetDomainPermissionsPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns an asset (or file) that is in a package. For example, for a Maven package version, use - * GetPackageVersionAsset to download a JAR file, a POM file, - * or any other assets in the package version. - *

+ * @see {@link GetPackageVersionAssetCommand} */ - public getPackageVersionAsset( + getPackageVersionAsset( args: GetPackageVersionAssetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPackageVersionAsset( + getPackageVersionAsset( args: GetPackageVersionAssetCommandInput, cb: (err: any, data?: GetPackageVersionAssetCommandOutput) => void ): void; - public getPackageVersionAsset( + getPackageVersionAsset( args: GetPackageVersionAssetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPackageVersionAssetCommandOutput) => void ): void; - public getPackageVersionAsset( - args: GetPackageVersionAssetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPackageVersionAssetCommandOutput) => void), - cb?: (err: any, data?: GetPackageVersionAssetCommandOutput) => void - ): Promise | void { - const command = new GetPackageVersionAssetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Gets the readme file or descriptive text for a package version. - *

- *

- * The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText. - *

+ * @see {@link GetPackageVersionReadmeCommand} */ - public getPackageVersionReadme( + getPackageVersionReadme( args: GetPackageVersionReadmeCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPackageVersionReadme( + getPackageVersionReadme( args: GetPackageVersionReadmeCommandInput, cb: (err: any, data?: GetPackageVersionReadmeCommandOutput) => void ): void; - public getPackageVersionReadme( + getPackageVersionReadme( args: GetPackageVersionReadmeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPackageVersionReadmeCommandOutput) => void ): void; - public getPackageVersionReadme( - args: GetPackageVersionReadmeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPackageVersionReadmeCommandOutput) => void), - cb?: (err: any, data?: GetPackageVersionReadmeCommandOutput) => void - ): Promise | void { - const command = new GetPackageVersionReadmeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each - * package format: - *

- *
    - *
  • - *

    - * maven - *

    - *
  • - *
  • - *

    - * npm - *

    - *
  • - *
  • - *

    - * nuget - *

    - *
  • - *
  • - *

    - * pypi - *

    - *
  • - *
+ * @see {@link GetRepositoryEndpointCommand} */ - public getRepositoryEndpoint( + getRepositoryEndpoint( args: GetRepositoryEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRepositoryEndpoint( + getRepositoryEndpoint( args: GetRepositoryEndpointCommandInput, cb: (err: any, data?: GetRepositoryEndpointCommandOutput) => void ): void; - public getRepositoryEndpoint( + getRepositoryEndpoint( args: GetRepositoryEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRepositoryEndpointCommandOutput) => void ): void; - public getRepositoryEndpoint( - args: GetRepositoryEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRepositoryEndpointCommandOutput) => void), - cb?: (err: any, data?: GetRepositoryEndpointCommandOutput) => void - ): Promise | void { - const command = new GetRepositoryEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns the resource policy that is set on a repository. - *

+ * @see {@link GetRepositoryPermissionsPolicyCommand} */ - public getRepositoryPermissionsPolicy( + getRepositoryPermissionsPolicy( args: GetRepositoryPermissionsPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRepositoryPermissionsPolicy( + getRepositoryPermissionsPolicy( args: GetRepositoryPermissionsPolicyCommandInput, cb: (err: any, data?: GetRepositoryPermissionsPolicyCommandOutput) => void ): void; - public getRepositoryPermissionsPolicy( + getRepositoryPermissionsPolicy( args: GetRepositoryPermissionsPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRepositoryPermissionsPolicyCommandOutput) => void ): void; - public getRepositoryPermissionsPolicy( - args: GetRepositoryPermissionsPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRepositoryPermissionsPolicyCommandOutput) => void), - cb?: (err: any, data?: GetRepositoryPermissionsPolicyCommandOutput) => void - ): Promise | void { - const command = new GetRepositoryPermissionsPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of DomainSummary objects for all domains owned by the Amazon Web Services account that makes - * this call. Each returned DomainSummary object contains information about a - * domain.

+ * @see {@link ListDomainsCommand} */ - public listDomains(args: ListDomainsCommandInput, options?: __HttpHandlerOptions): Promise; - public listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void; - public listDomains( + listDomains(args: ListDomainsCommandInput, options?: __HttpHandlerOptions): Promise; + listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void; + listDomains( args: ListDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainsCommandOutput) => void ): void; - public listDomains( - args: ListDomainsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDomainsCommandOutput) => void), - cb?: (err: any, data?: ListDomainsCommandOutput) => void - ): Promise | void { - const command = new ListDomainsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns a list of - * PackageSummary - * objects for packages in a repository that match the request parameters. - *

+ * @see {@link ListPackagesCommand} */ - public listPackages( - args: ListPackagesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listPackages(args: ListPackagesCommandInput, cb: (err: any, data?: ListPackagesCommandOutput) => void): void; - public listPackages( + listPackages(args: ListPackagesCommandInput, options?: __HttpHandlerOptions): Promise; + listPackages(args: ListPackagesCommandInput, cb: (err: any, data?: ListPackagesCommandOutput) => void): void; + listPackages( args: ListPackagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPackagesCommandOutput) => void ): void; - public listPackages( - args: ListPackagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPackagesCommandOutput) => void), - cb?: (err: any, data?: ListPackagesCommandOutput) => void - ): Promise | void { - const command = new ListPackagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns a list of - * AssetSummary - * objects for assets in a package version. - *

+ * @see {@link ListPackageVersionAssetsCommand} */ - public listPackageVersionAssets( + listPackageVersionAssets( args: ListPackageVersionAssetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPackageVersionAssets( + listPackageVersionAssets( args: ListPackageVersionAssetsCommandInput, cb: (err: any, data?: ListPackageVersionAssetsCommandOutput) => void ): void; - public listPackageVersionAssets( + listPackageVersionAssets( args: ListPackageVersionAssetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPackageVersionAssetsCommandOutput) => void ): void; - public listPackageVersionAssets( - args: ListPackageVersionAssetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPackageVersionAssetsCommandOutput) => void), - cb?: (err: any, data?: ListPackageVersionAssetsCommandOutput) => void - ): Promise | void { - const command = new ListPackageVersionAssetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns the direct dependencies for a package version. The dependencies are returned as - * PackageDependency - * objects. CodeArtifact extracts the dependencies for a package version from the metadata file for the package - * format (for example, the package.json file for npm packages and the pom.xml file - * for Maven). Any package version dependencies that are not listed in the configuration file are not returned. - *

+ * @see {@link ListPackageVersionDependenciesCommand} */ - public listPackageVersionDependencies( + listPackageVersionDependencies( args: ListPackageVersionDependenciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPackageVersionDependencies( + listPackageVersionDependencies( args: ListPackageVersionDependenciesCommandInput, cb: (err: any, data?: ListPackageVersionDependenciesCommandOutput) => void ): void; - public listPackageVersionDependencies( + listPackageVersionDependencies( args: ListPackageVersionDependenciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPackageVersionDependenciesCommandOutput) => void ): void; - public listPackageVersionDependencies( - args: ListPackageVersionDependenciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPackageVersionDependenciesCommandOutput) => void), - cb?: (err: any, data?: ListPackageVersionDependenciesCommandOutput) => void - ): Promise | void { - const command = new ListPackageVersionDependenciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns a list of - * PackageVersionSummary - * objects for package versions in a repository that match the request parameters. Package versions of all statuses will be returned by default when calling list-package-versions with no --status parameter. - *

+ * @see {@link ListPackageVersionsCommand} */ - public listPackageVersions( + listPackageVersions( args: ListPackageVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPackageVersions( + listPackageVersions( args: ListPackageVersionsCommandInput, cb: (err: any, data?: ListPackageVersionsCommandOutput) => void ): void; - public listPackageVersions( + listPackageVersions( args: ListPackageVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPackageVersionsCommandOutput) => void ): void; - public listPackageVersions( - args: ListPackageVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPackageVersionsCommandOutput) => void), - cb?: (err: any, data?: ListPackageVersionsCommandOutput) => void - ): Promise | void { - const command = new ListPackageVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns a list of - * RepositorySummary - * objects. Each RepositorySummary contains information about a repository in the specified Amazon Web Services account and that matches the input - * parameters. - *

+ * @see {@link ListRepositoriesCommand} */ - public listRepositories( + listRepositories( args: ListRepositoriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRepositories( + listRepositories( args: ListRepositoriesCommandInput, cb: (err: any, data?: ListRepositoriesCommandOutput) => void ): void; - public listRepositories( + listRepositories( args: ListRepositoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRepositoriesCommandOutput) => void ): void; - public listRepositories( - args: ListRepositoriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRepositoriesCommandOutput) => void), - cb?: (err: any, data?: ListRepositoriesCommandOutput) => void - ): Promise | void { - const command = new ListRepositoriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns a list of - * RepositorySummary - * objects. Each RepositorySummary contains information about a repository in the specified domain and that matches the input - * parameters. - *

+ * @see {@link ListRepositoriesInDomainCommand} */ - public listRepositoriesInDomain( + listRepositoriesInDomain( args: ListRepositoriesInDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRepositoriesInDomain( + listRepositoriesInDomain( args: ListRepositoriesInDomainCommandInput, cb: (err: any, data?: ListRepositoriesInDomainCommandOutput) => void ): void; - public listRepositoriesInDomain( + listRepositoriesInDomain( args: ListRepositoriesInDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRepositoriesInDomainCommandOutput) => void ): void; - public listRepositoriesInDomain( - args: ListRepositoriesInDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRepositoriesInDomainCommandOutput) => void), - cb?: (err: any, data?: ListRepositoriesInDomainCommandOutput) => void - ): Promise | void { - const command = new ListRepositoriesInDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new package version containing one or more assets (or files).

- *

The unfinished flag can be used to keep the package version in the - * Unfinished state until all of its assets have been uploaded (see Package version status in the CodeArtifact user guide). To set - * the package version’s status to Published, omit the unfinished flag - * when uploading the final asset, or set the status using UpdatePackageVersionStatus. Once a package version’s status is set to - * Published, it cannot change back to Unfinished.

- * - *

Only generic packages can be published using this API. For more information, see Using generic - * packages in the CodeArtifact User Guide.

- *
+ * @see {@link PublishPackageVersionCommand} */ - public publishPackageVersion( + publishPackageVersion( args: PublishPackageVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public publishPackageVersion( + publishPackageVersion( args: PublishPackageVersionCommandInput, cb: (err: any, data?: PublishPackageVersionCommandOutput) => void ): void; - public publishPackageVersion( + publishPackageVersion( args: PublishPackageVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishPackageVersionCommandOutput) => void ): void; - public publishPackageVersion( - args: PublishPackageVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PublishPackageVersionCommandOutput) => void), - cb?: (err: any, data?: PublishPackageVersionCommandOutput) => void - ): Promise | void { - const command = new PublishPackageVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Sets a resource policy on a domain that specifies permissions to access it. - *

- *

- * When you call PutDomainPermissionsPolicy, the resource policy on the domain is ignored when evaluting permissions. - * This ensures that the owner of a domain cannot lock themselves out of the domain, which would prevent them from being - * able to update the resource policy. - *

+ * @see {@link PutDomainPermissionsPolicyCommand} */ - public putDomainPermissionsPolicy( + putDomainPermissionsPolicy( args: PutDomainPermissionsPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putDomainPermissionsPolicy( + putDomainPermissionsPolicy( args: PutDomainPermissionsPolicyCommandInput, cb: (err: any, data?: PutDomainPermissionsPolicyCommandOutput) => void ): void; - public putDomainPermissionsPolicy( + putDomainPermissionsPolicy( args: PutDomainPermissionsPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDomainPermissionsPolicyCommandOutput) => void ): void; - public putDomainPermissionsPolicy( - args: PutDomainPermissionsPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutDomainPermissionsPolicyCommandOutput) => void), - cb?: (err: any, data?: PutDomainPermissionsPolicyCommandOutput) => void - ): Promise | void { - const command = new PutDomainPermissionsPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the package origin configuration for a package.

- *

The package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct - * publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source. - * For more information about package origin controls and configuration, see Editing package origin controls in the CodeArtifact User Guide.

- *

- * PutPackageOriginConfiguration can be called on a package that doesn't yet exist in the repository. When called - * on a package that does not exist, a package is created in the repository with no versions and the requested restrictions are set on the package. - * This can be used to preemptively block ingesting or retaining any versions from external connections or upstream repositories, or to block - * publishing any versions of the package into the repository before connecting any package managers or publishers to the repository.

+ * @see {@link PutPackageOriginConfigurationCommand} */ - public putPackageOriginConfiguration( + putPackageOriginConfiguration( args: PutPackageOriginConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putPackageOriginConfiguration( + putPackageOriginConfiguration( args: PutPackageOriginConfigurationCommandInput, cb: (err: any, data?: PutPackageOriginConfigurationCommandOutput) => void ): void; - public putPackageOriginConfiguration( + putPackageOriginConfiguration( args: PutPackageOriginConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPackageOriginConfigurationCommandOutput) => void ): void; - public putPackageOriginConfiguration( - args: PutPackageOriginConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutPackageOriginConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutPackageOriginConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutPackageOriginConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Sets the resource policy on a repository that specifies permissions to access it. - *

- *

- * When you call PutRepositoryPermissionsPolicy, the resource policy on the repository is ignored when evaluting permissions. - * This ensures that the owner of a repository cannot lock themselves out of the repository, which would prevent them from being - * able to update the resource policy. - *

+ * @see {@link PutRepositoryPermissionsPolicyCommand} */ - public putRepositoryPermissionsPolicy( + putRepositoryPermissionsPolicy( args: PutRepositoryPermissionsPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putRepositoryPermissionsPolicy( + putRepositoryPermissionsPolicy( args: PutRepositoryPermissionsPolicyCommandInput, cb: (err: any, data?: PutRepositoryPermissionsPolicyCommandOutput) => void ): void; - public putRepositoryPermissionsPolicy( + putRepositoryPermissionsPolicy( args: PutRepositoryPermissionsPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRepositoryPermissionsPolicyCommandOutput) => void ): void; - public putRepositoryPermissionsPolicy( - args: PutRepositoryPermissionsPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRepositoryPermissionsPolicyCommandOutput) => void), - cb?: (err: any, data?: PutRepositoryPermissionsPolicyCommandOutput) => void - ): Promise | void { - const command = new PutRepositoryPermissionsPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or updates tags for a resource in CodeArtifact.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from a resource in CodeArtifact.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Updates the status of one or more versions of a package. Using UpdatePackageVersionsStatus, - * you can update the status of package versions to Archived, Published, or Unlisted. - * To set the status of a package version to Disposed, use - * DisposePackageVersions. - *

+ * @see {@link UpdatePackageVersionsStatusCommand} */ - public updatePackageVersionsStatus( + updatePackageVersionsStatus( args: UpdatePackageVersionsStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePackageVersionsStatus( + updatePackageVersionsStatus( args: UpdatePackageVersionsStatusCommandInput, cb: (err: any, data?: UpdatePackageVersionsStatusCommandOutput) => void ): void; - public updatePackageVersionsStatus( + updatePackageVersionsStatus( args: UpdatePackageVersionsStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePackageVersionsStatusCommandOutput) => void ): void; - public updatePackageVersionsStatus( - args: UpdatePackageVersionsStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePackageVersionsStatusCommandOutput) => void), - cb?: (err: any, data?: UpdatePackageVersionsStatusCommandOutput) => void - ): Promise | void { - const command = new UpdatePackageVersionsStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Update the properties of a repository. - *

+ * @see {@link UpdateRepositoryCommand} */ - public updateRepository( + updateRepository( args: UpdateRepositoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRepository( + updateRepository( args: UpdateRepositoryCommandInput, cb: (err: any, data?: UpdateRepositoryCommandOutput) => void ): void; - public updateRepository( + updateRepository( args: UpdateRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRepositoryCommandOutput) => void ): void; - public updateRepository( - args: UpdateRepositoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRepositoryCommandOutput) => void), - cb?: (err: any, data?: UpdateRepositoryCommandOutput) => void - ): Promise | void { - const command = new UpdateRepositoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

CodeArtifact is a fully managed artifact repository compatible with language-native + * package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to + * share packages with development teams and pull packages. Packages can be pulled from both + * public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact + * repository and another repository, which effectively merges their contents from the point of + * view of a package manager client.

+ *

+ * CodeArtifact Components + *

+ *

Use the information in this guide to help you work with the following CodeArtifact components:

+ *
    + *
  • + *

    + * Repository: A CodeArtifact repository contains a set of package + * versions, each of which maps to a set of assets, or files. Repositories are + * polyglot, so a single repository can contain packages of any supported type. Each + * repository exposes endpoints for fetching and publishing packages using tools like the + * + * npm + * CLI, the Maven CLI ( + * mvn + * ), Python CLIs ( + * pip + * and twine), and NuGet CLIs (nuget and dotnet).

    + *
  • + *
  • + *

    + * Domain: Repositories are aggregated into a higher-level entity known as a + * domain. All package assets and metadata are stored in the domain, + * but are consumed through repositories. A given package asset, such as a Maven JAR file, is + * stored once per domain, no matter how many repositories it's present in. All of the assets + * and metadata in a domain are encrypted with the same customer master key (CMK) stored in + * Key Management Service (KMS).

    + *

    Each repository is a member of a single domain and can't be moved to a + * different domain.

    + *

    The domain allows organizational policy to be applied across multiple + * repositories, such as which accounts can access repositories in the domain, and + * which public repositories can be used as sources of packages.

    + *

    Although an organization can have multiple domains, we recommend a single production + * domain that contains all published artifacts so that teams can find and share packages + * across their organization.

    + *
  • + *
  • + *

    + * Package: A package is a bundle of software and the metadata required to + * resolve dependencies and install the software. CodeArtifact supports npm, PyPI, Maven, and NuGet package formats.

    + *

    In CodeArtifact, a package consists of:

    + *
      + *
    • + *

      A name (for example, webpack is the name of a + * popular npm package)

      + *
    • + *
    • + *

      An optional namespace (for example, @types in @types/node)

      + *
    • + *
    • + *

      A set of versions (for example, 1.0.0, 1.0.1, + * 1.0.2, etc.)

      + *
    • + *
    • + *

      Package-level metadata (for example, npm tags)

      + *
    • + *
    + *
  • + *
  • + *

    + * Package version: A version of a package, such as @types/node 12.6.9. The version number + * format and semantics vary for different package formats. For example, npm package versions + * must conform to the Semantic Versioning + * specification. In CodeArtifact, a package version consists of the version identifier, + * metadata at the package version level, and a set of assets.

    + *
  • + *
  • + *

    + * Upstream repository: One repository is upstream of another when the package versions in + * it can be accessed from the repository endpoint of the downstream repository, effectively + * merging the contents of the two repositories from the point of view of a client. CodeArtifact + * allows creating an upstream relationship between two repositories.

    + *
  • + *
  • + *

    + * Asset: An individual file stored in CodeArtifact associated with a package version, such as an npm + * .tgz file or Maven POM and JAR files.

    + *
  • + *
+ *

CodeArtifact supports these operations:

+ *
    + *
  • + *

    + * AssociateExternalConnection: Adds an existing external + * connection to a repository. + *

    + *
  • + *
  • + *

    + * CopyPackageVersions: Copies package versions from one + * repository to another repository in the same domain.

    + *
  • + *
  • + *

    + * CreateDomain: Creates a domain

    + *
  • + *
  • + *

    + * CreateRepository: Creates a CodeArtifact repository in a domain.

    + *
  • + *
  • + *

    + * DeleteDomain: Deletes a domain. You cannot delete a domain that contains + * repositories.

    + *
  • + *
  • + *

    + * DeleteDomainPermissionsPolicy: Deletes the resource policy that is set on a domain.

    + *
  • + *
  • + *

    + * DeletePackage: Deletes a package and all associated package versions.

    + *
  • + *
  • + *

    + * DeletePackageVersions: Deletes versions of a package. After a package has + * been deleted, it can be republished, but its assets and metadata cannot be restored + * because they have been permanently removed from storage.

    + *
  • + *
  • + *

    + * DeleteRepository: Deletes a repository. + *

    + *
  • + *
  • + *

    + * DeleteRepositoryPermissionsPolicy: Deletes the resource policy that is set on a repository.

    + *
  • + *
  • + *

    + * DescribeDomain: Returns a DomainDescription object that + * contains information about the requested domain.

    + *
  • + *
  • + *

    + * DescribePackage: Returns a PackageDescription + * object that contains details about a package.

    + *
  • + *
  • + *

    + * DescribePackageVersion: Returns a PackageVersionDescription + * object that contains details about a package version.

    + *
  • + *
  • + *

    + * DescribeRepository: Returns a RepositoryDescription object + * that contains detailed information about the requested repository.

    + *
  • + *
  • + *

    + * DisposePackageVersions: Disposes versions of a package. A package version + * with the status Disposed cannot be restored because they have been + * permanently removed from storage.

    + *
  • + *
  • + *

    + * DisassociateExternalConnection: Removes an existing external connection from a repository. + *

    + *
  • + *
  • + *

    + * GetAuthorizationToken: Generates a temporary authorization token for accessing repositories in the domain. The token expires the authorization period has passed. + * The default authorization period is 12 hours and can be customized to any length with a maximum of 12 hours.

    + *
  • + *
  • + *

    + * GetDomainPermissionsPolicy: Returns the policy of a resource + * that is attached to the specified domain.

    + *
  • + *
  • + *

    + * GetPackageVersionAsset: Returns the contents of an asset that is in a package version.

    + *
  • + *
  • + *

    + * GetPackageVersionReadme: Gets the readme file or descriptive text for a package version.

    + *
  • + *
  • + *

    + * GetRepositoryEndpoint: Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each + * package format: + *

    + *
      + *
    • + *

      + * maven + *

      + *
    • + *
    • + *

      + * npm + *

      + *
    • + *
    • + *

      + * nuget + *

      + *
    • + *
    • + *

      + * pypi + *

      + *
    • + *
    + *
  • + *
  • + *

    + * GetRepositoryPermissionsPolicy: Returns the resource policy that is set on a repository. + *

    + *
  • + *
  • + *

    + * ListDomains: Returns a list of DomainSummary objects. Each + * returned DomainSummary object contains information about a domain.

    + *
  • + *
  • + *

    + * ListPackages: Lists the packages in a repository.

    + *
  • + *
  • + *

    + * ListPackageVersionAssets: Lists the assets for a given package version.

    + *
  • + *
  • + *

    + * ListPackageVersionDependencies: Returns a list of the direct dependencies for a + * package version.

    + *
  • + *
  • + *

    + * ListPackageVersions: Returns a list of package versions for a specified + * package in a repository.

    + *
  • + *
  • + *

    + * ListRepositories: Returns a list of repositories owned by the Amazon Web Services account that called this method.

    + *
  • + *
  • + *

    + * ListRepositoriesInDomain: Returns a list of the repositories in a domain.

    + *
  • + *
  • + *

    + * PublishPackageVersion: Creates a new package version containing one or more assets.

    + *
  • + *
  • + *

    + * PutDomainPermissionsPolicy: Attaches a resource policy to a domain.

    + *
  • + *
  • + *

    + * PutPackageOriginConfiguration: Sets the package origin configuration for a package, which determine + * how new versions of the package can be added to a specific repository.

    + *
  • + *
  • + *

    + * PutRepositoryPermissionsPolicy: Sets the resource policy on a repository + * that specifies permissions to access it.

    + *
  • + *
  • + *

    + * UpdatePackageVersionsStatus: Updates the status of one or more versions of a package.

    + *
  • + *
  • + *

    + * UpdateRepository: Updates the properties of a repository.

    + *
  • + *
+ */ +export class Codeartifact extends CodeartifactClient implements Codeartifact {} +createAggregatedClient(commands, Codeartifact); diff --git a/clients/client-codebuild/src/CodeBuild.ts b/clients/client-codebuild/src/CodeBuild.ts index 6912cb1c2f6d..371a836ac468 100644 --- a/clients/client-codebuild/src/CodeBuild.ts +++ b/clients/client-codebuild/src/CodeBuild.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CodeBuildClient } from "./CodeBuildClient"; +import { CodeBuildClient, CodeBuildClientConfig } from "./CodeBuildClient"; import { BatchDeleteBuildsCommand, BatchDeleteBuildsCommandInput, @@ -208,1544 +209,741 @@ import { UpdateWebhookCommandOutput, } from "./commands/UpdateWebhookCommand"; -/** - * @public - * CodeBuild - *

CodeBuild is a fully managed build service in the cloud. CodeBuild compiles your source code, - * runs unit tests, and produces artifacts that are ready to deploy. CodeBuild eliminates the - * need to provision, manage, and scale your own build servers. It provides prepackaged - * build environments for the most popular programming languages and build tools, such as - * Apache Maven, Gradle, and more. You can also fully customize build environments in CodeBuild - * to use your own build tools. CodeBuild scales automatically to meet peak build requests. You - * pay only for the build time you consume. For more information about CodeBuild, see the - * CodeBuild User - * Guide. - *

- */ -export class CodeBuild extends CodeBuildClient { +const commands = { + BatchDeleteBuildsCommand, + BatchGetBuildBatchesCommand, + BatchGetBuildsCommand, + BatchGetProjectsCommand, + BatchGetReportGroupsCommand, + BatchGetReportsCommand, + CreateProjectCommand, + CreateReportGroupCommand, + CreateWebhookCommand, + DeleteBuildBatchCommand, + DeleteProjectCommand, + DeleteReportCommand, + DeleteReportGroupCommand, + DeleteResourcePolicyCommand, + DeleteSourceCredentialsCommand, + DeleteWebhookCommand, + DescribeCodeCoveragesCommand, + DescribeTestCasesCommand, + GetReportGroupTrendCommand, + GetResourcePolicyCommand, + ImportSourceCredentialsCommand, + InvalidateProjectCacheCommand, + ListBuildBatchesCommand, + ListBuildBatchesForProjectCommand, + ListBuildsCommand, + ListBuildsForProjectCommand, + ListCuratedEnvironmentImagesCommand, + ListProjectsCommand, + ListReportGroupsCommand, + ListReportsCommand, + ListReportsForReportGroupCommand, + ListSharedProjectsCommand, + ListSharedReportGroupsCommand, + ListSourceCredentialsCommand, + PutResourcePolicyCommand, + RetryBuildCommand, + RetryBuildBatchCommand, + StartBuildCommand, + StartBuildBatchCommand, + StopBuildCommand, + StopBuildBatchCommand, + UpdateProjectCommand, + UpdateProjectVisibilityCommand, + UpdateReportGroupCommand, + UpdateWebhookCommand, +}; + +export interface CodeBuild { /** - * @public - *

Deletes one or more builds.

+ * @see {@link BatchDeleteBuildsCommand} */ - public batchDeleteBuilds( + batchDeleteBuilds( args: BatchDeleteBuildsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeleteBuilds( + batchDeleteBuilds( args: BatchDeleteBuildsCommandInput, cb: (err: any, data?: BatchDeleteBuildsCommandOutput) => void ): void; - public batchDeleteBuilds( + batchDeleteBuilds( args: BatchDeleteBuildsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteBuildsCommandOutput) => void ): void; - public batchDeleteBuilds( - args: BatchDeleteBuildsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeleteBuildsCommandOutput) => void), - cb?: (err: any, data?: BatchDeleteBuildsCommandOutput) => void - ): Promise | void { - const command = new BatchDeleteBuildsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about one or more batch builds.

+ * @see {@link BatchGetBuildBatchesCommand} */ - public batchGetBuildBatches( + batchGetBuildBatches( args: BatchGetBuildBatchesCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetBuildBatches( + batchGetBuildBatches( args: BatchGetBuildBatchesCommandInput, cb: (err: any, data?: BatchGetBuildBatchesCommandOutput) => void ): void; - public batchGetBuildBatches( + batchGetBuildBatches( args: BatchGetBuildBatchesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetBuildBatchesCommandOutput) => void ): void; - public batchGetBuildBatches( - args: BatchGetBuildBatchesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetBuildBatchesCommandOutput) => void), - cb?: (err: any, data?: BatchGetBuildBatchesCommandOutput) => void - ): Promise | void { - const command = new BatchGetBuildBatchesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about one or more builds.

+ * @see {@link BatchGetBuildsCommand} */ - public batchGetBuilds( + batchGetBuilds( args: BatchGetBuildsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetBuilds( - args: BatchGetBuildsCommandInput, - cb: (err: any, data?: BatchGetBuildsCommandOutput) => void - ): void; - public batchGetBuilds( + batchGetBuilds(args: BatchGetBuildsCommandInput, cb: (err: any, data?: BatchGetBuildsCommandOutput) => void): void; + batchGetBuilds( args: BatchGetBuildsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetBuildsCommandOutput) => void ): void; - public batchGetBuilds( - args: BatchGetBuildsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetBuildsCommandOutput) => void), - cb?: (err: any, data?: BatchGetBuildsCommandOutput) => void - ): Promise | void { - const command = new BatchGetBuildsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about one or more build projects.

+ * @see {@link BatchGetProjectsCommand} */ - public batchGetProjects( + batchGetProjects( args: BatchGetProjectsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetProjects( + batchGetProjects( args: BatchGetProjectsCommandInput, cb: (err: any, data?: BatchGetProjectsCommandOutput) => void ): void; - public batchGetProjects( + batchGetProjects( args: BatchGetProjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetProjectsCommandOutput) => void ): void; - public batchGetProjects( - args: BatchGetProjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetProjectsCommandOutput) => void), - cb?: (err: any, data?: BatchGetProjectsCommandOutput) => void - ): Promise | void { - const command = new BatchGetProjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns an array of report groups. - *

+ * @see {@link BatchGetReportGroupsCommand} */ - public batchGetReportGroups( + batchGetReportGroups( args: BatchGetReportGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetReportGroups( + batchGetReportGroups( args: BatchGetReportGroupsCommandInput, cb: (err: any, data?: BatchGetReportGroupsCommandOutput) => void ): void; - public batchGetReportGroups( + batchGetReportGroups( args: BatchGetReportGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetReportGroupsCommandOutput) => void ): void; - public batchGetReportGroups( - args: BatchGetReportGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetReportGroupsCommandOutput) => void), - cb?: (err: any, data?: BatchGetReportGroupsCommandOutput) => void - ): Promise | void { - const command = new BatchGetReportGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns an array of reports. - *

+ * @see {@link BatchGetReportsCommand} */ - public batchGetReports( + batchGetReports( args: BatchGetReportsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetReports( - args: BatchGetReportsCommandInput, - cb: (err: any, data?: BatchGetReportsCommandOutput) => void - ): void; - public batchGetReports( + batchGetReports(args: BatchGetReportsCommandInput, cb: (err: any, data?: BatchGetReportsCommandOutput) => void): void; + batchGetReports( args: BatchGetReportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetReportsCommandOutput) => void ): void; - public batchGetReports( - args: BatchGetReportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetReportsCommandOutput) => void), - cb?: (err: any, data?: BatchGetReportsCommandOutput) => void - ): Promise | void { - const command = new BatchGetReportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a build project.

+ * @see {@link CreateProjectCommand} */ - public createProject( - args: CreateProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createProject( - args: CreateProjectCommandInput, - cb: (err: any, data?: CreateProjectCommandOutput) => void - ): void; - public createProject( + createProject(args: CreateProjectCommandInput, options?: __HttpHandlerOptions): Promise; + createProject(args: CreateProjectCommandInput, cb: (err: any, data?: CreateProjectCommandOutput) => void): void; + createProject( args: CreateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectCommandOutput) => void ): void; - public createProject( - args: CreateProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProjectCommandOutput) => void), - cb?: (err: any, data?: CreateProjectCommandOutput) => void - ): Promise | void { - const command = new CreateProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Creates a report group. A report group contains a collection of reports. - *

+ * @see {@link CreateReportGroupCommand} */ - public createReportGroup( + createReportGroup( args: CreateReportGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createReportGroup( + createReportGroup( args: CreateReportGroupCommandInput, cb: (err: any, data?: CreateReportGroupCommandOutput) => void ): void; - public createReportGroup( + createReportGroup( args: CreateReportGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReportGroupCommandOutput) => void ): void; - public createReportGroup( - args: CreateReportGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateReportGroupCommandOutput) => void), - cb?: (err: any, data?: CreateReportGroupCommandOutput) => void - ): Promise | void { - const command = new CreateReportGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

For an existing CodeBuild build project that has its source code stored in a GitHub or - * Bitbucket repository, enables CodeBuild to start rebuilding the source code every time a - * code change is pushed to the repository.

- * - *

If you enable webhooks for an CodeBuild project, and the project is used as a build - * step in CodePipeline, then two identical builds are created for each commit. One build is - * triggered through webhooks, and one through CodePipeline. Because billing is on a per-build - * basis, you are billed for both builds. Therefore, if you are using CodePipeline, we - * recommend that you disable webhooks in CodeBuild. In the CodeBuild console, clear the - * Webhook box. For more information, see step 5 in Change a Build Project's Settings.

- *
+ * @see {@link CreateWebhookCommand} */ - public createWebhook( - args: CreateWebhookCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createWebhook( - args: CreateWebhookCommandInput, - cb: (err: any, data?: CreateWebhookCommandOutput) => void - ): void; - public createWebhook( + createWebhook(args: CreateWebhookCommandInput, options?: __HttpHandlerOptions): Promise; + createWebhook(args: CreateWebhookCommandInput, cb: (err: any, data?: CreateWebhookCommandOutput) => void): void; + createWebhook( args: CreateWebhookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWebhookCommandOutput) => void ): void; - public createWebhook( - args: CreateWebhookCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWebhookCommandOutput) => void), - cb?: (err: any, data?: CreateWebhookCommandOutput) => void - ): Promise | void { - const command = new CreateWebhookCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a batch build.

+ * @see {@link DeleteBuildBatchCommand} */ - public deleteBuildBatch( + deleteBuildBatch( args: DeleteBuildBatchCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBuildBatch( + deleteBuildBatch( args: DeleteBuildBatchCommandInput, cb: (err: any, data?: DeleteBuildBatchCommandOutput) => void ): void; - public deleteBuildBatch( + deleteBuildBatch( args: DeleteBuildBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBuildBatchCommandOutput) => void ): void; - public deleteBuildBatch( - args: DeleteBuildBatchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBuildBatchCommandOutput) => void), - cb?: (err: any, data?: DeleteBuildBatchCommandOutput) => void - ): Promise | void { - const command = new DeleteBuildBatchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a build project. When you delete a project, its builds are not deleted. - *

+ * @see {@link DeleteProjectCommand} */ - public deleteProject( - args: DeleteProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteProject( - args: DeleteProjectCommandInput, - cb: (err: any, data?: DeleteProjectCommandOutput) => void - ): void; - public deleteProject( + deleteProject(args: DeleteProjectCommandInput, options?: __HttpHandlerOptions): Promise; + deleteProject(args: DeleteProjectCommandInput, cb: (err: any, data?: DeleteProjectCommandOutput) => void): void; + deleteProject( args: DeleteProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProjectCommandOutput) => void ): void; - public deleteProject( - args: DeleteProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProjectCommandOutput) => void), - cb?: (err: any, data?: DeleteProjectCommandOutput) => void - ): Promise | void { - const command = new DeleteProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Deletes a report. - *

+ * @see {@link DeleteReportCommand} */ - public deleteReport( - args: DeleteReportCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteReport(args: DeleteReportCommandInput, cb: (err: any, data?: DeleteReportCommandOutput) => void): void; - public deleteReport( + deleteReport(args: DeleteReportCommandInput, options?: __HttpHandlerOptions): Promise; + deleteReport(args: DeleteReportCommandInput, cb: (err: any, data?: DeleteReportCommandOutput) => void): void; + deleteReport( args: DeleteReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReportCommandOutput) => void ): void; - public deleteReport( - args: DeleteReportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteReportCommandOutput) => void), - cb?: (err: any, data?: DeleteReportCommandOutput) => void - ): Promise | void { - const command = new DeleteReportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a report group. Before you delete a report group, you must delete its reports.

+ * @see {@link DeleteReportGroupCommand} */ - public deleteReportGroup( + deleteReportGroup( args: DeleteReportGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteReportGroup( + deleteReportGroup( args: DeleteReportGroupCommandInput, cb: (err: any, data?: DeleteReportGroupCommandOutput) => void ): void; - public deleteReportGroup( + deleteReportGroup( args: DeleteReportGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReportGroupCommandOutput) => void ): void; - public deleteReportGroup( - args: DeleteReportGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteReportGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteReportGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteReportGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a resource policy that is identified by its resource ARN.

+ * @see {@link DeleteResourcePolicyCommand} */ - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( - args: DeleteResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.

+ * @see {@link DeleteSourceCredentialsCommand} */ - public deleteSourceCredentials( + deleteSourceCredentials( args: DeleteSourceCredentialsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSourceCredentials( + deleteSourceCredentials( args: DeleteSourceCredentialsCommandInput, cb: (err: any, data?: DeleteSourceCredentialsCommandOutput) => void ): void; - public deleteSourceCredentials( + deleteSourceCredentials( args: DeleteSourceCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSourceCredentialsCommandOutput) => void ): void; - public deleteSourceCredentials( - args: DeleteSourceCredentialsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSourceCredentialsCommandOutput) => void), - cb?: (err: any, data?: DeleteSourceCredentialsCommandOutput) => void - ): Promise | void { - const command = new DeleteSourceCredentialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

For an existing CodeBuild build project that has its source code stored in a GitHub or - * Bitbucket repository, stops CodeBuild from rebuilding the source code every time a code - * change is pushed to the repository.

+ * @see {@link DeleteWebhookCommand} */ - public deleteWebhook( - args: DeleteWebhookCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteWebhook( - args: DeleteWebhookCommandInput, - cb: (err: any, data?: DeleteWebhookCommandOutput) => void - ): void; - public deleteWebhook( + deleteWebhook(args: DeleteWebhookCommandInput, options?: __HttpHandlerOptions): Promise; + deleteWebhook(args: DeleteWebhookCommandInput, cb: (err: any, data?: DeleteWebhookCommandOutput) => void): void; + deleteWebhook( args: DeleteWebhookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWebhookCommandOutput) => void ): void; - public deleteWebhook( - args: DeleteWebhookCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWebhookCommandOutput) => void), - cb?: (err: any, data?: DeleteWebhookCommandOutput) => void - ): Promise | void { - const command = new DeleteWebhookCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves one or more code coverage reports.

+ * @see {@link DescribeCodeCoveragesCommand} */ - public describeCodeCoverages( + describeCodeCoverages( args: DescribeCodeCoveragesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCodeCoverages( + describeCodeCoverages( args: DescribeCodeCoveragesCommandInput, cb: (err: any, data?: DescribeCodeCoveragesCommandOutput) => void ): void; - public describeCodeCoverages( + describeCodeCoverages( args: DescribeCodeCoveragesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCodeCoveragesCommandOutput) => void ): void; - public describeCodeCoverages( - args: DescribeCodeCoveragesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCodeCoveragesCommandOutput) => void), - cb?: (err: any, data?: DescribeCodeCoveragesCommandOutput) => void - ): Promise | void { - const command = new DescribeCodeCoveragesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns a list of details about test cases for a report. - *

+ * @see {@link DescribeTestCasesCommand} */ - public describeTestCases( + describeTestCases( args: DescribeTestCasesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTestCases( + describeTestCases( args: DescribeTestCasesCommandInput, cb: (err: any, data?: DescribeTestCasesCommandOutput) => void ): void; - public describeTestCases( + describeTestCases( args: DescribeTestCasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTestCasesCommandOutput) => void ): void; - public describeTestCases( - args: DescribeTestCasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTestCasesCommandOutput) => void), - cb?: (err: any, data?: DescribeTestCasesCommandOutput) => void - ): Promise | void { - const command = new DescribeTestCasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Analyzes and accumulates test report values for the specified test reports.

+ * @see {@link GetReportGroupTrendCommand} */ - public getReportGroupTrend( + getReportGroupTrend( args: GetReportGroupTrendCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReportGroupTrend( + getReportGroupTrend( args: GetReportGroupTrendCommandInput, cb: (err: any, data?: GetReportGroupTrendCommandOutput) => void ): void; - public getReportGroupTrend( + getReportGroupTrend( args: GetReportGroupTrendCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReportGroupTrendCommandOutput) => void ): void; - public getReportGroupTrend( - args: GetReportGroupTrendCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReportGroupTrendCommandOutput) => void), - cb?: (err: any, data?: GetReportGroupTrendCommandOutput) => void - ): Promise | void { - const command = new GetReportGroupTrendCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a resource policy that is identified by its resource ARN.

+ * @see {@link GetResourcePolicyCommand} */ - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void ): void; - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void ): void; - public getResourcePolicy( - args: GetResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: GetResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new GetResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Imports the source repository credentials for an CodeBuild project that has its - * source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.

+ * @see {@link ImportSourceCredentialsCommand} */ - public importSourceCredentials( + importSourceCredentials( args: ImportSourceCredentialsCommandInput, options?: __HttpHandlerOptions ): Promise; - public importSourceCredentials( + importSourceCredentials( args: ImportSourceCredentialsCommandInput, cb: (err: any, data?: ImportSourceCredentialsCommandOutput) => void ): void; - public importSourceCredentials( + importSourceCredentials( args: ImportSourceCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportSourceCredentialsCommandOutput) => void ): void; - public importSourceCredentials( - args: ImportSourceCredentialsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportSourceCredentialsCommandOutput) => void), - cb?: (err: any, data?: ImportSourceCredentialsCommandOutput) => void - ): Promise | void { - const command = new ImportSourceCredentialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Resets the cache for a project.

+ * @see {@link InvalidateProjectCacheCommand} */ - public invalidateProjectCache( + invalidateProjectCache( args: InvalidateProjectCacheCommandInput, options?: __HttpHandlerOptions ): Promise; - public invalidateProjectCache( + invalidateProjectCache( args: InvalidateProjectCacheCommandInput, cb: (err: any, data?: InvalidateProjectCacheCommandOutput) => void ): void; - public invalidateProjectCache( + invalidateProjectCache( args: InvalidateProjectCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InvalidateProjectCacheCommandOutput) => void ): void; - public invalidateProjectCache( - args: InvalidateProjectCacheCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InvalidateProjectCacheCommandOutput) => void), - cb?: (err: any, data?: InvalidateProjectCacheCommandOutput) => void - ): Promise | void { - const command = new InvalidateProjectCacheCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the identifiers of your build batches in the current region.

+ * @see {@link ListBuildBatchesCommand} */ - public listBuildBatches( + listBuildBatches( args: ListBuildBatchesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBuildBatches( + listBuildBatches( args: ListBuildBatchesCommandInput, cb: (err: any, data?: ListBuildBatchesCommandOutput) => void ): void; - public listBuildBatches( + listBuildBatches( args: ListBuildBatchesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBuildBatchesCommandOutput) => void ): void; - public listBuildBatches( - args: ListBuildBatchesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBuildBatchesCommandOutput) => void), - cb?: (err: any, data?: ListBuildBatchesCommandOutput) => void - ): Promise | void { - const command = new ListBuildBatchesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the identifiers of the build batches for a specific project.

+ * @see {@link ListBuildBatchesForProjectCommand} */ - public listBuildBatchesForProject( + listBuildBatchesForProject( args: ListBuildBatchesForProjectCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBuildBatchesForProject( + listBuildBatchesForProject( args: ListBuildBatchesForProjectCommandInput, cb: (err: any, data?: ListBuildBatchesForProjectCommandOutput) => void ): void; - public listBuildBatchesForProject( + listBuildBatchesForProject( args: ListBuildBatchesForProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBuildBatchesForProjectCommandOutput) => void ): void; - public listBuildBatchesForProject( - args: ListBuildBatchesForProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBuildBatchesForProjectCommandOutput) => void), - cb?: (err: any, data?: ListBuildBatchesForProjectCommandOutput) => void - ): Promise | void { - const command = new ListBuildBatchesForProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of build IDs, with each build ID representing a single build.

+ * @see {@link ListBuildsCommand} */ - public listBuilds(args: ListBuildsCommandInput, options?: __HttpHandlerOptions): Promise; - public listBuilds(args: ListBuildsCommandInput, cb: (err: any, data?: ListBuildsCommandOutput) => void): void; - public listBuilds( + listBuilds(args: ListBuildsCommandInput, options?: __HttpHandlerOptions): Promise; + listBuilds(args: ListBuildsCommandInput, cb: (err: any, data?: ListBuildsCommandOutput) => void): void; + listBuilds( args: ListBuildsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBuildsCommandOutput) => void ): void; - public listBuilds( - args: ListBuildsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBuildsCommandOutput) => void), - cb?: (err: any, data?: ListBuildsCommandOutput) => void - ): Promise | void { - const command = new ListBuildsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of build identifiers for the specified build project, with each build - * identifier representing a single build.

+ * @see {@link ListBuildsForProjectCommand} */ - public listBuildsForProject( + listBuildsForProject( args: ListBuildsForProjectCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBuildsForProject( + listBuildsForProject( args: ListBuildsForProjectCommandInput, cb: (err: any, data?: ListBuildsForProjectCommandOutput) => void ): void; - public listBuildsForProject( + listBuildsForProject( args: ListBuildsForProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBuildsForProjectCommandOutput) => void ): void; - public listBuildsForProject( - args: ListBuildsForProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBuildsForProjectCommandOutput) => void), - cb?: (err: any, data?: ListBuildsForProjectCommandOutput) => void - ): Promise | void { - const command = new ListBuildsForProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about Docker images that are managed by CodeBuild.

+ * @see {@link ListCuratedEnvironmentImagesCommand} */ - public listCuratedEnvironmentImages( + listCuratedEnvironmentImages( args: ListCuratedEnvironmentImagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCuratedEnvironmentImages( + listCuratedEnvironmentImages( args: ListCuratedEnvironmentImagesCommandInput, cb: (err: any, data?: ListCuratedEnvironmentImagesCommandOutput) => void ): void; - public listCuratedEnvironmentImages( + listCuratedEnvironmentImages( args: ListCuratedEnvironmentImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCuratedEnvironmentImagesCommandOutput) => void ): void; - public listCuratedEnvironmentImages( - args: ListCuratedEnvironmentImagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCuratedEnvironmentImagesCommandOutput) => void), - cb?: (err: any, data?: ListCuratedEnvironmentImagesCommandOutput) => void - ): Promise | void { - const command = new ListCuratedEnvironmentImagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of build project names, with each build project name representing a single - * build project.

+ * @see {@link ListProjectsCommand} */ - public listProjects( - args: ListProjectsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void; - public listProjects( + listProjects(args: ListProjectsCommandInput, options?: __HttpHandlerOptions): Promise; + listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void; + listProjects( args: ListProjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProjectsCommandOutput) => void ): void; - public listProjects( - args: ListProjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProjectsCommandOutput) => void), - cb?: (err: any, data?: ListProjectsCommandOutput) => void - ): Promise | void { - const command = new ListProjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Gets a list ARNs for the report groups in the current Amazon Web Services account. - *

+ * @see {@link ListReportGroupsCommand} */ - public listReportGroups( + listReportGroups( args: ListReportGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReportGroups( + listReportGroups( args: ListReportGroupsCommandInput, cb: (err: any, data?: ListReportGroupsCommandOutput) => void ): void; - public listReportGroups( + listReportGroups( args: ListReportGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReportGroupsCommandOutput) => void ): void; - public listReportGroups( - args: ListReportGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReportGroupsCommandOutput) => void), - cb?: (err: any, data?: ListReportGroupsCommandOutput) => void - ): Promise | void { - const command = new ListReportGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns a list of ARNs for the reports in the current Amazon Web Services account. - *

+ * @see {@link ListReportsCommand} */ - public listReports(args: ListReportsCommandInput, options?: __HttpHandlerOptions): Promise; - public listReports(args: ListReportsCommandInput, cb: (err: any, data?: ListReportsCommandOutput) => void): void; - public listReports( + listReports(args: ListReportsCommandInput, options?: __HttpHandlerOptions): Promise; + listReports(args: ListReportsCommandInput, cb: (err: any, data?: ListReportsCommandOutput) => void): void; + listReports( args: ListReportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReportsCommandOutput) => void ): void; - public listReports( - args: ListReportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReportsCommandOutput) => void), - cb?: (err: any, data?: ListReportsCommandOutput) => void - ): Promise | void { - const command = new ListReportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns a list of ARNs for the reports that belong to a ReportGroup. - *

+ * @see {@link ListReportsForReportGroupCommand} */ - public listReportsForReportGroup( + listReportsForReportGroup( args: ListReportsForReportGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReportsForReportGroup( + listReportsForReportGroup( args: ListReportsForReportGroupCommandInput, cb: (err: any, data?: ListReportsForReportGroupCommandOutput) => void ): void; - public listReportsForReportGroup( + listReportsForReportGroup( args: ListReportsForReportGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReportsForReportGroupCommandOutput) => void ): void; - public listReportsForReportGroup( - args: ListReportsForReportGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReportsForReportGroupCommandOutput) => void), - cb?: (err: any, data?: ListReportsForReportGroupCommandOutput) => void - ): Promise | void { - const command = new ListReportsForReportGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of projects that are shared with other Amazon Web Services accounts or users.

+ * @see {@link ListSharedProjectsCommand} */ - public listSharedProjects( + listSharedProjects( args: ListSharedProjectsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSharedProjects( + listSharedProjects( args: ListSharedProjectsCommandInput, cb: (err: any, data?: ListSharedProjectsCommandOutput) => void ): void; - public listSharedProjects( + listSharedProjects( args: ListSharedProjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSharedProjectsCommandOutput) => void ): void; - public listSharedProjects( - args: ListSharedProjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSharedProjectsCommandOutput) => void), - cb?: (err: any, data?: ListSharedProjectsCommandOutput) => void - ): Promise | void { - const command = new ListSharedProjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of report groups that are shared with other Amazon Web Services accounts or users. - *

+ * @see {@link ListSharedReportGroupsCommand} */ - public listSharedReportGroups( + listSharedReportGroups( args: ListSharedReportGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSharedReportGroups( + listSharedReportGroups( args: ListSharedReportGroupsCommandInput, cb: (err: any, data?: ListSharedReportGroupsCommandOutput) => void ): void; - public listSharedReportGroups( + listSharedReportGroups( args: ListSharedReportGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSharedReportGroupsCommandOutput) => void ): void; - public listSharedReportGroups( - args: ListSharedReportGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSharedReportGroupsCommandOutput) => void), - cb?: (err: any, data?: ListSharedReportGroupsCommandOutput) => void - ): Promise | void { - const command = new ListSharedReportGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of SourceCredentialsInfo objects.

+ * @see {@link ListSourceCredentialsCommand} */ - public listSourceCredentials( + listSourceCredentials( args: ListSourceCredentialsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSourceCredentials( + listSourceCredentials( args: ListSourceCredentialsCommandInput, cb: (err: any, data?: ListSourceCredentialsCommandOutput) => void ): void; - public listSourceCredentials( + listSourceCredentials( args: ListSourceCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSourceCredentialsCommandOutput) => void ): void; - public listSourceCredentials( - args: ListSourceCredentialsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSourceCredentialsCommandOutput) => void), - cb?: (err: any, data?: ListSourceCredentialsCommandOutput) => void - ): Promise | void { - const command = new ListSourceCredentialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stores a resource policy for the ARN of a Project or - * ReportGroup object.

+ * @see {@link PutResourcePolicyCommand} */ - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( - args: PutResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: PutResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new PutResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Restarts a build.

+ * @see {@link RetryBuildCommand} */ - public retryBuild(args: RetryBuildCommandInput, options?: __HttpHandlerOptions): Promise; - public retryBuild(args: RetryBuildCommandInput, cb: (err: any, data?: RetryBuildCommandOutput) => void): void; - public retryBuild( + retryBuild(args: RetryBuildCommandInput, options?: __HttpHandlerOptions): Promise; + retryBuild(args: RetryBuildCommandInput, cb: (err: any, data?: RetryBuildCommandOutput) => void): void; + retryBuild( args: RetryBuildCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RetryBuildCommandOutput) => void ): void; - public retryBuild( - args: RetryBuildCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RetryBuildCommandOutput) => void), - cb?: (err: any, data?: RetryBuildCommandOutput) => void - ): Promise | void { - const command = new RetryBuildCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Restarts a failed batch build. Only batch builds that have failed can be retried.

+ * @see {@link RetryBuildBatchCommand} */ - public retryBuildBatch( + retryBuildBatch( args: RetryBuildBatchCommandInput, options?: __HttpHandlerOptions ): Promise; - public retryBuildBatch( - args: RetryBuildBatchCommandInput, - cb: (err: any, data?: RetryBuildBatchCommandOutput) => void - ): void; - public retryBuildBatch( + retryBuildBatch(args: RetryBuildBatchCommandInput, cb: (err: any, data?: RetryBuildBatchCommandOutput) => void): void; + retryBuildBatch( args: RetryBuildBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RetryBuildBatchCommandOutput) => void ): void; - public retryBuildBatch( - args: RetryBuildBatchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RetryBuildBatchCommandOutput) => void), - cb?: (err: any, data?: RetryBuildBatchCommandOutput) => void - ): Promise | void { - const command = new RetryBuildBatchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts running a build.

+ * @see {@link StartBuildCommand} */ - public startBuild(args: StartBuildCommandInput, options?: __HttpHandlerOptions): Promise; - public startBuild(args: StartBuildCommandInput, cb: (err: any, data?: StartBuildCommandOutput) => void): void; - public startBuild( + startBuild(args: StartBuildCommandInput, options?: __HttpHandlerOptions): Promise; + startBuild(args: StartBuildCommandInput, cb: (err: any, data?: StartBuildCommandOutput) => void): void; + startBuild( args: StartBuildCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartBuildCommandOutput) => void ): void; - public startBuild( - args: StartBuildCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartBuildCommandOutput) => void), - cb?: (err: any, data?: StartBuildCommandOutput) => void - ): Promise | void { - const command = new StartBuildCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a batch build for a project.

+ * @see {@link StartBuildBatchCommand} */ - public startBuildBatch( + startBuildBatch( args: StartBuildBatchCommandInput, options?: __HttpHandlerOptions ): Promise; - public startBuildBatch( - args: StartBuildBatchCommandInput, - cb: (err: any, data?: StartBuildBatchCommandOutput) => void - ): void; - public startBuildBatch( + startBuildBatch(args: StartBuildBatchCommandInput, cb: (err: any, data?: StartBuildBatchCommandOutput) => void): void; + startBuildBatch( args: StartBuildBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartBuildBatchCommandOutput) => void ): void; - public startBuildBatch( - args: StartBuildBatchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartBuildBatchCommandOutput) => void), - cb?: (err: any, data?: StartBuildBatchCommandOutput) => void - ): Promise | void { - const command = new StartBuildBatchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Attempts to stop running a build.

+ * @see {@link StopBuildCommand} */ - public stopBuild(args: StopBuildCommandInput, options?: __HttpHandlerOptions): Promise; - public stopBuild(args: StopBuildCommandInput, cb: (err: any, data?: StopBuildCommandOutput) => void): void; - public stopBuild( + stopBuild(args: StopBuildCommandInput, options?: __HttpHandlerOptions): Promise; + stopBuild(args: StopBuildCommandInput, cb: (err: any, data?: StopBuildCommandOutput) => void): void; + stopBuild( args: StopBuildCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopBuildCommandOutput) => void ): void; - public stopBuild( - args: StopBuildCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopBuildCommandOutput) => void), - cb?: (err: any, data?: StopBuildCommandOutput) => void - ): Promise | void { - const command = new StopBuildCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops a running batch build.

+ * @see {@link StopBuildBatchCommand} */ - public stopBuildBatch( + stopBuildBatch( args: StopBuildBatchCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopBuildBatch( - args: StopBuildBatchCommandInput, - cb: (err: any, data?: StopBuildBatchCommandOutput) => void - ): void; - public stopBuildBatch( + stopBuildBatch(args: StopBuildBatchCommandInput, cb: (err: any, data?: StopBuildBatchCommandOutput) => void): void; + stopBuildBatch( args: StopBuildBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopBuildBatchCommandOutput) => void ): void; - public stopBuildBatch( - args: StopBuildBatchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopBuildBatchCommandOutput) => void), - cb?: (err: any, data?: StopBuildBatchCommandOutput) => void - ): Promise | void { - const command = new StopBuildBatchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes the settings of a build project.

+ * @see {@link UpdateProjectCommand} */ - public updateProject( - args: UpdateProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateProject( - args: UpdateProjectCommandInput, - cb: (err: any, data?: UpdateProjectCommandOutput) => void - ): void; - public updateProject( + updateProject(args: UpdateProjectCommandInput, options?: __HttpHandlerOptions): Promise; + updateProject(args: UpdateProjectCommandInput, cb: (err: any, data?: UpdateProjectCommandOutput) => void): void; + updateProject( args: UpdateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProjectCommandOutput) => void ): void; - public updateProject( - args: UpdateProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProjectCommandOutput) => void), - cb?: (err: any, data?: UpdateProjectCommandOutput) => void - ): Promise | void { - const command = new UpdateProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes the public visibility for a project. The project's build results, logs, and - * artifacts are available to the general public. For more information, see Public build - * projects in the CodeBuild User Guide.

- * - *

The following should be kept in mind when making your projects public:

- *
    - *
  • - *

    All of a project's build results, logs, and artifacts, including builds that were run - * when the project was private, are available to the general public.

    - *
  • - *
  • - *

    All build logs and artifacts are available to the public. Environment variables, source - * code, and other sensitive information may have been output to the build logs and artifacts. - * You must be careful about what information is output to the build logs. Some best practice - * are:

    - *
      - *
    • - *

      Do not store sensitive values, especially Amazon Web Services access key IDs and secret access - * keys, in environment variables. We recommend that you use an Amazon EC2 Systems Manager Parameter Store - * or Secrets Manager to store sensitive values.

      - *
    • - *
    • - *

      Follow Best - * practices for using webhooks in the CodeBuild User - * Guide to limit which entities can trigger a build, and do - * not store the buildspec in the project itself, to ensure that your webhooks are as - * secure as possible.

      - *
    • - *
    - *
  • - *
  • - *

    A malicious user can use public builds to distribute malicious artifacts. We recommend - * that you review all pull requests to verify that the pull request is a legitimate change. We - * also recommend that you validate any artifacts with their checksums to make sure that the - * correct artifacts are being downloaded.

    - *
  • - *
- *
+ * @see {@link UpdateProjectVisibilityCommand} */ - public updateProjectVisibility( + updateProjectVisibility( args: UpdateProjectVisibilityCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateProjectVisibility( + updateProjectVisibility( args: UpdateProjectVisibilityCommandInput, cb: (err: any, data?: UpdateProjectVisibilityCommandOutput) => void ): void; - public updateProjectVisibility( + updateProjectVisibility( args: UpdateProjectVisibilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProjectVisibilityCommandOutput) => void ): void; - public updateProjectVisibility( - args: UpdateProjectVisibilityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProjectVisibilityCommandOutput) => void), - cb?: (err: any, data?: UpdateProjectVisibilityCommandOutput) => void - ): Promise | void { - const command = new UpdateProjectVisibilityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Updates a report group. - *

+ * @see {@link UpdateReportGroupCommand} */ - public updateReportGroup( + updateReportGroup( args: UpdateReportGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateReportGroup( + updateReportGroup( args: UpdateReportGroupCommandInput, cb: (err: any, data?: UpdateReportGroupCommandOutput) => void ): void; - public updateReportGroup( + updateReportGroup( args: UpdateReportGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateReportGroupCommandOutput) => void ): void; - public updateReportGroup( - args: UpdateReportGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateReportGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateReportGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateReportGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the webhook associated with an CodeBuild build project.

- * - *

If you use Bitbucket for your repository, rotateSecret is ignored. - *

- *
+ * @see {@link UpdateWebhookCommand} */ - public updateWebhook( - args: UpdateWebhookCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateWebhook( - args: UpdateWebhookCommandInput, - cb: (err: any, data?: UpdateWebhookCommandOutput) => void - ): void; - public updateWebhook( + updateWebhook(args: UpdateWebhookCommandInput, options?: __HttpHandlerOptions): Promise; + updateWebhook(args: UpdateWebhookCommandInput, cb: (err: any, data?: UpdateWebhookCommandOutput) => void): void; + updateWebhook( args: UpdateWebhookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWebhookCommandOutput) => void ): void; - public updateWebhook( - args: UpdateWebhookCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWebhookCommandOutput) => void), - cb?: (err: any, data?: UpdateWebhookCommandOutput) => void - ): Promise | void { - const command = new UpdateWebhookCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * CodeBuild + *

CodeBuild is a fully managed build service in the cloud. CodeBuild compiles your source code, + * runs unit tests, and produces artifacts that are ready to deploy. CodeBuild eliminates the + * need to provision, manage, and scale your own build servers. It provides prepackaged + * build environments for the most popular programming languages and build tools, such as + * Apache Maven, Gradle, and more. You can also fully customize build environments in CodeBuild + * to use your own build tools. CodeBuild scales automatically to meet peak build requests. You + * pay only for the build time you consume. For more information about CodeBuild, see the + * CodeBuild User + * Guide. + *

+ */ +export class CodeBuild extends CodeBuildClient implements CodeBuild {} +createAggregatedClient(commands, CodeBuild); diff --git a/clients/client-codecatalyst/src/CodeCatalyst.ts b/clients/client-codecatalyst/src/CodeCatalyst.ts index 71fcb2cdd321..78e9249af36b 100644 --- a/clients/client-codecatalyst/src/CodeCatalyst.ts +++ b/clients/client-codecatalyst/src/CodeCatalyst.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CodeCatalystClient } from "./CodeCatalystClient"; +import { CodeCatalystClient, CodeCatalystClientConfig } from "./CodeCatalystClient"; import { CreateAccessTokenCommand, CreateAccessTokenCommandInput, @@ -116,936 +117,527 @@ import { VerifySessionCommandOutput, } from "./commands/VerifySessionCommand"; -/** - * @public - * - *

- * Amazon CodeCatalyst is in preview release and subject to change. - *

- *
- *

Welcome to the Amazon CodeCatalyst API reference. This reference provides descriptions of operations and data types for Amazon CodeCatalyst. You can use the Amazon CodeCatalyst - * API to work with the following objects.

- *

Dev Environments and the Amazon Web Services Toolkits, by calling the following:

- *
    - *
  • - *

    - * CreateAccessToken, which creates a personal access token (PAT) for the current user.

    - *
  • - *
  • - *

    - * CreateDevEnvironment, which creates a Dev Environment, - * where you can quickly work on the code stored in the source repositories of your project.

    - *
  • - *
  • - *

    - * CreateProject which creates a project in a specified space.

    - *
  • - *
  • - *

    - * CreateSourceRepositoryBranch, which creates a branch in a specified repository where you can work on code.

    - *
  • - *
  • - *

    - * DeleteDevEnvironment, which deletes a Dev Environment.

    - *
  • - *
  • - *

    - * GetDevEnvironment, which returns information about a Dev Environment.

    - *
  • - *
  • - *

    - * GetProject, which returns information about a project.

    - *
  • - *
  • - *

    - * GetSourceRepositoryCloneUrls, which returns information about the URLs that can be used with a Git client to clone a source - * repository.

    - *
  • - *
  • - *

    - * GetSubscription, which returns information about the Amazon Web Services account used for billing purposes - * and the billing plan for the space.

    - *
  • - *
  • - *

    - * GetUserDetails, which returns information about a user in Amazon CodeCatalyst.

    - *
  • - *
  • - *

    - * ListDevEnvironments, which retrives a list of Dev Environments in a project.

    - *
  • - *
  • - *

    - * ListProjects, which retrieves a list of projects in a space.

    - *
  • - *
  • - *

    - * ListSourceRepositories, which retrieves a list of source repositories in a project.

    - *
  • - *
  • - *

    - * ListSourceRepositoryBranches, which retrieves a list of branches in a source repository.

    - *
  • - *
  • - *

    - * ListSpaces, which retrieves a list of spaces.

    - *
  • - *
  • - *

    - * StartDevEnvironment, which starts a specified Dev Environment and puts it into an active state.

    - *
  • - *
  • - *

    - * StartDevEnvironmentSession, which starts a session to a specified Dev Environment.

    - *
  • - *
  • - *

    - * StopDevEnvironment, which stops a specified Dev Environment and puts it into an stopped state.

    - *
  • - *
  • - *

    - * StopDevEnvironmentSession, which stops a session for a specified Dev Environment.

    - *
  • - *
  • - *

    - * UpdateDevEnvironment, which changes one or more values for a Dev Environment.

    - *
  • - *
  • - *

    - * VerifySession, which verifies whether the calling user has a valid Amazon CodeCatalyst login and session.

    - *
  • - *
- *

Security, activity, and resource management in Amazon CodeCatalyst, by calling the following:

- *
    - *
  • - *

    - * DeleteAccessToken, which deletes a specified personal access token (PAT).

    - *
  • - *
  • - *

    - * ListAccessTokens, which lists all personal access tokens (PATs) associated with a user.

    - *
  • - *
  • - *

    - * ListEventLogs, which retrieves a list of events that occurred during a specified time period in a space.

    - *
  • - *
- */ -export class CodeCatalyst extends CodeCatalystClient { +const commands = { + CreateAccessTokenCommand, + CreateDevEnvironmentCommand, + CreateProjectCommand, + CreateSourceRepositoryBranchCommand, + DeleteAccessTokenCommand, + DeleteDevEnvironmentCommand, + GetDevEnvironmentCommand, + GetProjectCommand, + GetSourceRepositoryCloneUrlsCommand, + GetSpaceCommand, + GetSubscriptionCommand, + GetUserDetailsCommand, + ListAccessTokensCommand, + ListDevEnvironmentsCommand, + ListEventLogsCommand, + ListProjectsCommand, + ListSourceRepositoriesCommand, + ListSourceRepositoryBranchesCommand, + ListSpacesCommand, + StartDevEnvironmentCommand, + StartDevEnvironmentSessionCommand, + StopDevEnvironmentCommand, + StopDevEnvironmentSessionCommand, + UpdateDevEnvironmentCommand, + VerifySessionCommand, +}; + +export interface CodeCatalyst { /** - * @public - *

Creates a personal access token (PAT) for the current user. A personal access token (PAT) is similar to a password. - * It is associated with your user account. You use PATs to access Amazon CodeCatalyst resources such as source repositories from third-party applications - * like Git and integrated development environments (IDEs). For more information, see - * Managing personal access tokens in Amazon CodeCatalyst.

+ * @see {@link CreateAccessTokenCommand} */ - public createAccessToken( + createAccessToken( args: CreateAccessTokenCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAccessToken( + createAccessToken( args: CreateAccessTokenCommandInput, cb: (err: any, data?: CreateAccessTokenCommandOutput) => void ): void; - public createAccessToken( + createAccessToken( args: CreateAccessTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessTokenCommandOutput) => void ): void; - public createAccessToken( - args: CreateAccessTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAccessTokenCommandOutput) => void), - cb?: (err: any, data?: CreateAccessTokenCommandOutput) => void - ): Promise | void { - const command = new CreateAccessTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development Dev Environment that you can use to quickly work on the code stored in the source repositories of your project. - *

- * - *

When created in the Amazon CodeCatalyst console, by default a Dev Environment is configured to have a 2 core processor, 4GB of RAM, and 16GB of persistent storage. None of these - * defaults apply to a Dev Environment created programmatically.

- *
+ * @see {@link CreateDevEnvironmentCommand} */ - public createDevEnvironment( + createDevEnvironment( args: CreateDevEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDevEnvironment( + createDevEnvironment( args: CreateDevEnvironmentCommandInput, cb: (err: any, data?: CreateDevEnvironmentCommandOutput) => void ): void; - public createDevEnvironment( + createDevEnvironment( args: CreateDevEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDevEnvironmentCommandOutput) => void ): void; - public createDevEnvironment( - args: CreateDevEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDevEnvironmentCommandOutput) => void), - cb?: (err: any, data?: CreateDevEnvironmentCommandOutput) => void - ): Promise | void { - const command = new CreateDevEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a project in a specified space.

+ * @see {@link CreateProjectCommand} */ - public createProject( - args: CreateProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createProject( - args: CreateProjectCommandInput, - cb: (err: any, data?: CreateProjectCommandOutput) => void - ): void; - public createProject( + createProject(args: CreateProjectCommandInput, options?: __HttpHandlerOptions): Promise; + createProject(args: CreateProjectCommandInput, cb: (err: any, data?: CreateProjectCommandOutput) => void): void; + createProject( args: CreateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectCommandOutput) => void ): void; - public createProject( - args: CreateProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProjectCommandOutput) => void), - cb?: (err: any, data?: CreateProjectCommandOutput) => void - ): Promise | void { - const command = new CreateProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a branch in a specified source repository in Amazon CodeCatalyst.

- * - *

This API only creates a branch in a source repository hosted in Amazon CodeCatalyst. You cannot use this API to create a branch in a linked repository.

- *
+ * @see {@link CreateSourceRepositoryBranchCommand} */ - public createSourceRepositoryBranch( + createSourceRepositoryBranch( args: CreateSourceRepositoryBranchCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSourceRepositoryBranch( + createSourceRepositoryBranch( args: CreateSourceRepositoryBranchCommandInput, cb: (err: any, data?: CreateSourceRepositoryBranchCommandOutput) => void ): void; - public createSourceRepositoryBranch( + createSourceRepositoryBranch( args: CreateSourceRepositoryBranchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSourceRepositoryBranchCommandOutput) => void ): void; - public createSourceRepositoryBranch( - args: CreateSourceRepositoryBranchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSourceRepositoryBranchCommandOutput) => void), - cb?: (err: any, data?: CreateSourceRepositoryBranchCommandOutput) => void - ): Promise | void { - const command = new CreateSourceRepositoryBranchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a specified personal access token (PAT). A personal access token can only be deleted by the user who created it.

+ * @see {@link DeleteAccessTokenCommand} */ - public deleteAccessToken( + deleteAccessToken( args: DeleteAccessTokenCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAccessToken( + deleteAccessToken( args: DeleteAccessTokenCommandInput, cb: (err: any, data?: DeleteAccessTokenCommandOutput) => void ): void; - public deleteAccessToken( + deleteAccessToken( args: DeleteAccessTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessTokenCommandOutput) => void ): void; - public deleteAccessToken( - args: DeleteAccessTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAccessTokenCommandOutput) => void), - cb?: (err: any, data?: DeleteAccessTokenCommandOutput) => void - ): Promise | void { - const command = new DeleteAccessTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Dev Environment.

+ * @see {@link DeleteDevEnvironmentCommand} */ - public deleteDevEnvironment( + deleteDevEnvironment( args: DeleteDevEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDevEnvironment( + deleteDevEnvironment( args: DeleteDevEnvironmentCommandInput, cb: (err: any, data?: DeleteDevEnvironmentCommandOutput) => void ): void; - public deleteDevEnvironment( + deleteDevEnvironment( args: DeleteDevEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDevEnvironmentCommandOutput) => void ): void; - public deleteDevEnvironment( - args: DeleteDevEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDevEnvironmentCommandOutput) => void), - cb?: (err: any, data?: DeleteDevEnvironmentCommandOutput) => void - ): Promise | void { - const command = new DeleteDevEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a Dev Environment for a source repository in a project. Dev Environments are specific to the user who creates them.

+ * @see {@link GetDevEnvironmentCommand} */ - public getDevEnvironment( + getDevEnvironment( args: GetDevEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDevEnvironment( + getDevEnvironment( args: GetDevEnvironmentCommandInput, cb: (err: any, data?: GetDevEnvironmentCommandOutput) => void ): void; - public getDevEnvironment( + getDevEnvironment( args: GetDevEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDevEnvironmentCommandOutput) => void ): void; - public getDevEnvironment( - args: GetDevEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDevEnvironmentCommandOutput) => void), - cb?: (err: any, data?: GetDevEnvironmentCommandOutput) => void - ): Promise | void { - const command = new GetDevEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a project.

+ * @see {@link GetProjectCommand} */ - public getProject(args: GetProjectCommandInput, options?: __HttpHandlerOptions): Promise; - public getProject(args: GetProjectCommandInput, cb: (err: any, data?: GetProjectCommandOutput) => void): void; - public getProject( + getProject(args: GetProjectCommandInput, options?: __HttpHandlerOptions): Promise; + getProject(args: GetProjectCommandInput, cb: (err: any, data?: GetProjectCommandOutput) => void): void; + getProject( args: GetProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProjectCommandOutput) => void ): void; - public getProject( - args: GetProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetProjectCommandOutput) => void), - cb?: (err: any, data?: GetProjectCommandOutput) => void - ): Promise | void { - const command = new GetProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the URLs that can be used with a Git client to clone a source - * repository.

+ * @see {@link GetSourceRepositoryCloneUrlsCommand} */ - public getSourceRepositoryCloneUrls( + getSourceRepositoryCloneUrls( args: GetSourceRepositoryCloneUrlsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSourceRepositoryCloneUrls( + getSourceRepositoryCloneUrls( args: GetSourceRepositoryCloneUrlsCommandInput, cb: (err: any, data?: GetSourceRepositoryCloneUrlsCommandOutput) => void ): void; - public getSourceRepositoryCloneUrls( + getSourceRepositoryCloneUrls( args: GetSourceRepositoryCloneUrlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSourceRepositoryCloneUrlsCommandOutput) => void ): void; - public getSourceRepositoryCloneUrls( - args: GetSourceRepositoryCloneUrlsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSourceRepositoryCloneUrlsCommandOutput) => void), - cb?: (err: any, data?: GetSourceRepositoryCloneUrlsCommandOutput) => void - ): Promise | void { - const command = new GetSourceRepositoryCloneUrlsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about an space.

+ * @see {@link GetSpaceCommand} */ - public getSpace(args: GetSpaceCommandInput, options?: __HttpHandlerOptions): Promise; - public getSpace(args: GetSpaceCommandInput, cb: (err: any, data?: GetSpaceCommandOutput) => void): void; - public getSpace( + getSpace(args: GetSpaceCommandInput, options?: __HttpHandlerOptions): Promise; + getSpace(args: GetSpaceCommandInput, cb: (err: any, data?: GetSpaceCommandOutput) => void): void; + getSpace( args: GetSpaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSpaceCommandOutput) => void ): void; - public getSpace( - args: GetSpaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSpaceCommandOutput) => void), - cb?: (err: any, data?: GetSpaceCommandOutput) => void - ): Promise | void { - const command = new GetSpaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the Amazon Web Services account used for billing purposes - * and the billing plan for the space.

+ * @see {@link GetSubscriptionCommand} */ - public getSubscription( + getSubscription( args: GetSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSubscription( - args: GetSubscriptionCommandInput, - cb: (err: any, data?: GetSubscriptionCommandOutput) => void - ): void; - public getSubscription( + getSubscription(args: GetSubscriptionCommandInput, cb: (err: any, data?: GetSubscriptionCommandOutput) => void): void; + getSubscription( args: GetSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSubscriptionCommandOutput) => void ): void; - public getSubscription( - args: GetSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSubscriptionCommandOutput) => void), - cb?: (err: any, data?: GetSubscriptionCommandOutput) => void - ): Promise | void { - const command = new GetSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a user.

+ * @see {@link GetUserDetailsCommand} */ - public getUserDetails( + getUserDetails( args: GetUserDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUserDetails( - args: GetUserDetailsCommandInput, - cb: (err: any, data?: GetUserDetailsCommandOutput) => void - ): void; - public getUserDetails( + getUserDetails(args: GetUserDetailsCommandInput, cb: (err: any, data?: GetUserDetailsCommandOutput) => void): void; + getUserDetails( args: GetUserDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserDetailsCommandOutput) => void ): void; - public getUserDetails( - args: GetUserDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUserDetailsCommandOutput) => void), - cb?: (err: any, data?: GetUserDetailsCommandOutput) => void - ): Promise | void { - const command = new GetUserDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all personal access tokens (PATs) associated with the user who calls the API. You can only list PATs associated with your user account.

+ * @see {@link ListAccessTokensCommand} */ - public listAccessTokens( + listAccessTokens( args: ListAccessTokensCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAccessTokens( + listAccessTokens( args: ListAccessTokensCommandInput, cb: (err: any, data?: ListAccessTokensCommandOutput) => void ): void; - public listAccessTokens( + listAccessTokens( args: ListAccessTokensCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessTokensCommandOutput) => void ): void; - public listAccessTokens( - args: ListAccessTokensCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccessTokensCommandOutput) => void), - cb?: (err: any, data?: ListAccessTokensCommandOutput) => void - ): Promise | void { - const command = new ListAccessTokensCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrives a list of Dev Environments in a project.

+ * @see {@link ListDevEnvironmentsCommand} */ - public listDevEnvironments( + listDevEnvironments( args: ListDevEnvironmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDevEnvironments( + listDevEnvironments( args: ListDevEnvironmentsCommandInput, cb: (err: any, data?: ListDevEnvironmentsCommandOutput) => void ): void; - public listDevEnvironments( + listDevEnvironments( args: ListDevEnvironmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDevEnvironmentsCommandOutput) => void ): void; - public listDevEnvironments( - args: ListDevEnvironmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDevEnvironmentsCommandOutput) => void), - cb?: (err: any, data?: ListDevEnvironmentsCommandOutput) => void - ): Promise | void { - const command = new ListDevEnvironmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of events that occurred during a specified time period in a space. You can use these events to audit user and system activity in a space.

+ * @see {@link ListEventLogsCommand} */ - public listEventLogs( - args: ListEventLogsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listEventLogs( - args: ListEventLogsCommandInput, - cb: (err: any, data?: ListEventLogsCommandOutput) => void - ): void; - public listEventLogs( + listEventLogs(args: ListEventLogsCommandInput, options?: __HttpHandlerOptions): Promise; + listEventLogs(args: ListEventLogsCommandInput, cb: (err: any, data?: ListEventLogsCommandOutput) => void): void; + listEventLogs( args: ListEventLogsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventLogsCommandOutput) => void ): void; - public listEventLogs( - args: ListEventLogsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEventLogsCommandOutput) => void), - cb?: (err: any, data?: ListEventLogsCommandOutput) => void - ): Promise | void { - const command = new ListEventLogsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of projects.

+ * @see {@link ListProjectsCommand} */ - public listProjects( - args: ListProjectsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void; - public listProjects( + listProjects(args: ListProjectsCommandInput, options?: __HttpHandlerOptions): Promise; + listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void; + listProjects( args: ListProjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProjectsCommandOutput) => void ): void; - public listProjects( - args: ListProjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProjectsCommandOutput) => void), - cb?: (err: any, data?: ListProjectsCommandOutput) => void - ): Promise | void { - const command = new ListProjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of source repositories in a project.

+ * @see {@link ListSourceRepositoriesCommand} */ - public listSourceRepositories( + listSourceRepositories( args: ListSourceRepositoriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSourceRepositories( + listSourceRepositories( args: ListSourceRepositoriesCommandInput, cb: (err: any, data?: ListSourceRepositoriesCommandOutput) => void ): void; - public listSourceRepositories( + listSourceRepositories( args: ListSourceRepositoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSourceRepositoriesCommandOutput) => void ): void; - public listSourceRepositories( - args: ListSourceRepositoriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSourceRepositoriesCommandOutput) => void), - cb?: (err: any, data?: ListSourceRepositoriesCommandOutput) => void - ): Promise | void { - const command = new ListSourceRepositoriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of branches in a specified source repository.

+ * @see {@link ListSourceRepositoryBranchesCommand} */ - public listSourceRepositoryBranches( + listSourceRepositoryBranches( args: ListSourceRepositoryBranchesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSourceRepositoryBranches( + listSourceRepositoryBranches( args: ListSourceRepositoryBranchesCommandInput, cb: (err: any, data?: ListSourceRepositoryBranchesCommandOutput) => void ): void; - public listSourceRepositoryBranches( + listSourceRepositoryBranches( args: ListSourceRepositoryBranchesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSourceRepositoryBranchesCommandOutput) => void ): void; - public listSourceRepositoryBranches( - args: ListSourceRepositoryBranchesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSourceRepositoryBranchesCommandOutput) => void), - cb?: (err: any, data?: ListSourceRepositoryBranchesCommandOutput) => void - ): Promise | void { - const command = new ListSourceRepositoryBranchesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of spaces.

+ * @see {@link ListSpacesCommand} */ - public listSpaces(args: ListSpacesCommandInput, options?: __HttpHandlerOptions): Promise; - public listSpaces(args: ListSpacesCommandInput, cb: (err: any, data?: ListSpacesCommandOutput) => void): void; - public listSpaces( + listSpaces(args: ListSpacesCommandInput, options?: __HttpHandlerOptions): Promise; + listSpaces(args: ListSpacesCommandInput, cb: (err: any, data?: ListSpacesCommandOutput) => void): void; + listSpaces( args: ListSpacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSpacesCommandOutput) => void ): void; - public listSpaces( - args: ListSpacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSpacesCommandOutput) => void), - cb?: (err: any, data?: ListSpacesCommandOutput) => void - ): Promise | void { - const command = new ListSpacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a specified Dev Environment and puts it into an active state.

+ * @see {@link StartDevEnvironmentCommand} */ - public startDevEnvironment( + startDevEnvironment( args: StartDevEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDevEnvironment( + startDevEnvironment( args: StartDevEnvironmentCommandInput, cb: (err: any, data?: StartDevEnvironmentCommandOutput) => void ): void; - public startDevEnvironment( + startDevEnvironment( args: StartDevEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDevEnvironmentCommandOutput) => void ): void; - public startDevEnvironment( - args: StartDevEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDevEnvironmentCommandOutput) => void), - cb?: (err: any, data?: StartDevEnvironmentCommandOutput) => void - ): Promise | void { - const command = new StartDevEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a session for a specified Dev Environment.

+ * @see {@link StartDevEnvironmentSessionCommand} */ - public startDevEnvironmentSession( + startDevEnvironmentSession( args: StartDevEnvironmentSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDevEnvironmentSession( + startDevEnvironmentSession( args: StartDevEnvironmentSessionCommandInput, cb: (err: any, data?: StartDevEnvironmentSessionCommandOutput) => void ): void; - public startDevEnvironmentSession( + startDevEnvironmentSession( args: StartDevEnvironmentSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDevEnvironmentSessionCommandOutput) => void ): void; - public startDevEnvironmentSession( - args: StartDevEnvironmentSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDevEnvironmentSessionCommandOutput) => void), - cb?: (err: any, data?: StartDevEnvironmentSessionCommandOutput) => void - ): Promise | void { - const command = new StartDevEnvironmentSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Pauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes.

+ * @see {@link StopDevEnvironmentCommand} */ - public stopDevEnvironment( + stopDevEnvironment( args: StopDevEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopDevEnvironment( + stopDevEnvironment( args: StopDevEnvironmentCommandInput, cb: (err: any, data?: StopDevEnvironmentCommandOutput) => void ): void; - public stopDevEnvironment( + stopDevEnvironment( args: StopDevEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDevEnvironmentCommandOutput) => void ): void; - public stopDevEnvironment( - args: StopDevEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopDevEnvironmentCommandOutput) => void), - cb?: (err: any, data?: StopDevEnvironmentCommandOutput) => void - ): Promise | void { - const command = new StopDevEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops a session for a specified Dev Environment.

+ * @see {@link StopDevEnvironmentSessionCommand} */ - public stopDevEnvironmentSession( + stopDevEnvironmentSession( args: StopDevEnvironmentSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopDevEnvironmentSession( + stopDevEnvironmentSession( args: StopDevEnvironmentSessionCommandInput, cb: (err: any, data?: StopDevEnvironmentSessionCommandOutput) => void ): void; - public stopDevEnvironmentSession( + stopDevEnvironmentSession( args: StopDevEnvironmentSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDevEnvironmentSessionCommandOutput) => void ): void; - public stopDevEnvironmentSession( - args: StopDevEnvironmentSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopDevEnvironmentSessionCommandOutput) => void), - cb?: (err: any, data?: StopDevEnvironmentSessionCommandOutput) => void - ): Promise | void { - const command = new StopDevEnvironmentSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes one or more values for a Dev Environment. Updating certain values of the Dev Environment will cause a restart.

+ * @see {@link UpdateDevEnvironmentCommand} */ - public updateDevEnvironment( + updateDevEnvironment( args: UpdateDevEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDevEnvironment( + updateDevEnvironment( args: UpdateDevEnvironmentCommandInput, cb: (err: any, data?: UpdateDevEnvironmentCommandOutput) => void ): void; - public updateDevEnvironment( + updateDevEnvironment( args: UpdateDevEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDevEnvironmentCommandOutput) => void ): void; - public updateDevEnvironment( - args: UpdateDevEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDevEnvironmentCommandOutput) => void), - cb?: (err: any, data?: UpdateDevEnvironmentCommandOutput) => void - ): Promise | void { - const command = new UpdateDevEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Verifies whether the calling user has a valid Amazon CodeCatalyst login and session. If successful, this returns the ID of the user in Amazon CodeCatalyst.

+ * @see {@link VerifySessionCommand} */ - public verifySession( - args: VerifySessionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public verifySession( - args: VerifySessionCommandInput, - cb: (err: any, data?: VerifySessionCommandOutput) => void - ): void; - public verifySession( + verifySession(args: VerifySessionCommandInput, options?: __HttpHandlerOptions): Promise; + verifySession(args: VerifySessionCommandInput, cb: (err: any, data?: VerifySessionCommandOutput) => void): void; + verifySession( args: VerifySessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifySessionCommandOutput) => void ): void; - public verifySession( - args: VerifySessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: VerifySessionCommandOutput) => void), - cb?: (err: any, data?: VerifySessionCommandOutput) => void - ): Promise | void { - const command = new VerifySessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * + *

+ * Amazon CodeCatalyst is in preview release and subject to change. + *

+ *
+ *

Welcome to the Amazon CodeCatalyst API reference. This reference provides descriptions of operations and data types for Amazon CodeCatalyst. You can use the Amazon CodeCatalyst + * API to work with the following objects.

+ *

Dev Environments and the Amazon Web Services Toolkits, by calling the following:

+ *
    + *
  • + *

    + * CreateAccessToken, which creates a personal access token (PAT) for the current user.

    + *
  • + *
  • + *

    + * CreateDevEnvironment, which creates a Dev Environment, + * where you can quickly work on the code stored in the source repositories of your project.

    + *
  • + *
  • + *

    + * CreateProject which creates a project in a specified space.

    + *
  • + *
  • + *

    + * CreateSourceRepositoryBranch, which creates a branch in a specified repository where you can work on code.

    + *
  • + *
  • + *

    + * DeleteDevEnvironment, which deletes a Dev Environment.

    + *
  • + *
  • + *

    + * GetDevEnvironment, which returns information about a Dev Environment.

    + *
  • + *
  • + *

    + * GetProject, which returns information about a project.

    + *
  • + *
  • + *

    + * GetSourceRepositoryCloneUrls, which returns information about the URLs that can be used with a Git client to clone a source + * repository.

    + *
  • + *
  • + *

    + * GetSubscription, which returns information about the Amazon Web Services account used for billing purposes + * and the billing plan for the space.

    + *
  • + *
  • + *

    + * GetUserDetails, which returns information about a user in Amazon CodeCatalyst.

    + *
  • + *
  • + *

    + * ListDevEnvironments, which retrives a list of Dev Environments in a project.

    + *
  • + *
  • + *

    + * ListProjects, which retrieves a list of projects in a space.

    + *
  • + *
  • + *

    + * ListSourceRepositories, which retrieves a list of source repositories in a project.

    + *
  • + *
  • + *

    + * ListSourceRepositoryBranches, which retrieves a list of branches in a source repository.

    + *
  • + *
  • + *

    + * ListSpaces, which retrieves a list of spaces.

    + *
  • + *
  • + *

    + * StartDevEnvironment, which starts a specified Dev Environment and puts it into an active state.

    + *
  • + *
  • + *

    + * StartDevEnvironmentSession, which starts a session to a specified Dev Environment.

    + *
  • + *
  • + *

    + * StopDevEnvironment, which stops a specified Dev Environment and puts it into an stopped state.

    + *
  • + *
  • + *

    + * StopDevEnvironmentSession, which stops a session for a specified Dev Environment.

    + *
  • + *
  • + *

    + * UpdateDevEnvironment, which changes one or more values for a Dev Environment.

    + *
  • + *
  • + *

    + * VerifySession, which verifies whether the calling user has a valid Amazon CodeCatalyst login and session.

    + *
  • + *
+ *

Security, activity, and resource management in Amazon CodeCatalyst, by calling the following:

+ *
    + *
  • + *

    + * DeleteAccessToken, which deletes a specified personal access token (PAT).

    + *
  • + *
  • + *

    + * ListAccessTokens, which lists all personal access tokens (PATs) associated with a user.

    + *
  • + *
  • + *

    + * ListEventLogs, which retrieves a list of events that occurred during a specified time period in a space.

    + *
  • + *
+ */ +export class CodeCatalyst extends CodeCatalystClient implements CodeCatalyst {} +createAggregatedClient(commands, CodeCatalyst); diff --git a/clients/client-codecommit/src/CodeCommit.ts b/clients/client-codecommit/src/CodeCommit.ts index 3b7f15997bb3..d9c8062e94a8 100644 --- a/clients/client-codecommit/src/CodeCommit.ts +++ b/clients/client-codecommit/src/CodeCommit.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CodeCommitClient } from "./CodeCommitClient"; +import { CodeCommitClient, CodeCommitClientConfig } from "./CodeCommitClient"; import { AssociateApprovalRuleTemplateWithRepositoryCommand, AssociateApprovalRuleTemplateWithRepositoryCommandInput, @@ -352,2991 +353,1685 @@ import { UpdateRepositoryNameCommandOutput, } from "./commands/UpdateRepositoryNameCommand"; -/** - * @public - * AWS CodeCommit - *

This is the AWS CodeCommit API Reference. This reference provides descriptions of the operations and data types for - * AWS CodeCommit API along with usage examples.

- *

You can use the AWS CodeCommit API to work with the following objects:

- * - *

Repositories, by calling the following:

- *
    - *
  • - *

    - * BatchGetRepositories, which returns information about one or more repositories associated with your AWS account.

    - *
  • - *
  • - *

    - * CreateRepository, which creates an AWS CodeCommit repository.

    - *
  • - *
  • - *

    - * DeleteRepository, which deletes an AWS CodeCommit repository.

    - *
  • - *
  • - *

    - * GetRepository, which returns information about a specified repository.

    - *
  • - *
  • - *

    - * ListRepositories, which lists all AWS CodeCommit repositories associated with your AWS account.

    - *
  • - *
  • - *

    - * UpdateRepositoryDescription, which sets or updates the description of the repository.

    - *
  • - *
  • - *

    - * UpdateRepositoryName, which changes the name of the - * repository. If you change the name of a repository, no other users of that - * repository can access it until you send them the new HTTPS or SSH URL to - * use.

    - *
  • - *
- * - *

Branches, by calling the following:

- *
    - *
  • - *

    - * CreateBranch, which creates a branch in a specified - * repository.

    - *
  • - *
  • - *

    - * DeleteBranch, which deletes the specified branch in a repository unless it is the default branch.

    - *
  • - *
  • - *

    - * GetBranch, which returns information about a specified branch.

    - *
  • - *
  • - *

    - * ListBranches, which lists all branches for a specified repository.

    - *
  • - *
  • - *

    - * UpdateDefaultBranch, which changes the default branch for a repository.

    - *
  • - *
- * - *

Files, by calling the following:

- *
    - *
  • - *

    - * DeleteFile, which deletes the content of a specified file from a specified branch.

    - *
  • - *
  • - *

    - * GetBlob, which returns the base-64 encoded content of an - * individual Git blob object in a repository.

    - *
  • - *
  • - *

    - * GetFile, which returns the base-64 encoded content of a specified file.

    - *
  • - *
  • - *

    - * GetFolder, which returns the contents of a specified folder or directory.

    - *
  • - *
  • - *

    - * PutFile, which adds or modifies a single file in a specified repository and branch.

    - *
  • - *
- * - * - *

Commits, by calling the following:

- *
    - *
  • - *

    - * BatchGetCommits, which returns information about one or more commits in a repository.

    - *
  • - *
  • - *

    - * CreateCommit, which creates a commit for changes to a repository.

    - *
  • - *
  • - *

    - * GetCommit, which returns information about a commit, including commit - * messages and author and committer information.

    - *
  • - *
  • - *

    - * GetDifferences, which returns information about the - * differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID, - * or other fully qualified reference).

    - *
  • - *
- * - * - *

Merges, by calling the following:

- *
    - *
  • - *

    - * BatchDescribeMergeConflicts, which returns information about conflicts in a merge between commits in a repository.

    - *
  • - *
  • - *

    - * CreateUnreferencedMergeCommit, which creates an unreferenced commit between two branches or commits for the - * purpose of comparing them and identifying any potential conflicts.

    - *
  • - *
  • - *

    - * DescribeMergeConflicts, which returns information about merge conflicts between the base, source, and destination versions - * of a file in a potential merge.

    - *
  • - *
  • - *

    - * GetMergeCommit, which returns information about the merge between a source and destination commit.

    - * - *
  • - *
  • - *

    - * GetMergeConflicts, which returns information about merge conflicts - * between the source and destination branch in a pull request.

    - *
  • - *
  • - * - *

    - * GetMergeOptions, which returns information about the available merge options between two branches or commit specifiers.

    - *
  • - *
  • - *

    - * MergeBranchesByFastForward, which merges two branches using the fast-forward merge option.

    - *
  • - *
  • - *

    - * MergeBranchesBySquash, which merges two branches using the squash merge option.

    - *
  • - *
  • - *

    - * MergeBranchesByThreeWay, which merges two branches using the three-way merge option.

    - *
  • - *
- * - * - *

Pull requests, by calling the following:

- *
    - *
  • - *

    - * CreatePullRequest, which creates a pull request in a specified repository.

    - *
  • - *
  • - *

    - * CreatePullRequestApprovalRule, which creates an approval rule for a specified pull request.

    - *
  • - *
  • - *

    - * DeletePullRequestApprovalRule, which deletes an approval rule for a specified pull request.

    - *
  • - *
  • - *

    - * DescribePullRequestEvents, which returns information about one or more pull request events.

    - *
  • - *
  • - *

    - * EvaluatePullRequestApprovalRules, which evaluates whether a pull request has met all the conditions specified in its associated approval rules.

    - *
  • - *
  • - *

    - * GetCommentsForPullRequest, which returns information about comments on a specified pull request.

    - *
  • - *
  • - * - *

    - * GetPullRequest, which returns information about a specified pull request.

    - *
  • - *
  • - *

    - * GetPullRequestApprovalStates, which returns information about the approval states for a specified pull request.

    - *
  • - *
  • - *

    - * GetPullRequestOverrideState, which returns information about whether approval rules have been set aside (overriden) for a - * pull request, and if so, the Amazon Resource Name (ARN) of the user or identity that overrode the rules and their requirements for the pull request.

    - *
  • - *
  • - *

    - * ListPullRequests, which lists all pull requests for a repository.

    - *
  • - *
  • - *

    - * MergePullRequestByFastForward, which merges the source destination branch of a pull request into the specified destination - * branch for that pull request using the fast-forward merge option.

    - *
  • - *
  • - *

    - * MergePullRequestBySquash, which merges the source destination branch of a pull request into the specified destination - * branch for that pull request using the squash merge option.

    - *
  • - *
  • - *

    - * MergePullRequestByThreeWay. which merges the source destination branch of a pull request into the specified destination - * branch for that pull request using the three-way merge option.

    - *
  • - *
  • - *

    - * OverridePullRequestApprovalRules, which sets aside all approval rule requirements for a pull request.

    - *
  • - *
  • - *

    - * PostCommentForPullRequest, which posts a comment to a pull request at the specified line, file, or request.

    - *
  • - *
  • - *

    - * UpdatePullRequestApprovalRuleContent, which updates the structure of an approval rule for a pull request.

    - *
  • - *
  • - *

    - * UpdatePullRequestApprovalState, which updates the state of an approval on a pull request.

    - *
  • - *
  • - *

    - * UpdatePullRequestDescription, which updates the description of a pull request.

    - *
  • - *
  • - *

    - * UpdatePullRequestStatus, which updates the status of a pull request.

    - *
  • - *
  • - *

    - * UpdatePullRequestTitle, which updates the title of a pull request.

    - *
  • - *
- * - *

Approval rule templates, by calling the following:

- *
    - *
  • - *

    - * AssociateApprovalRuleTemplateWithRepository, which associates a template - * with a specified repository. After the template is associated with a repository, - * AWS CodeCommit creates approval rules that match the template conditions on - * every pull request created in the specified repository.

    - *
  • - *
  • - *

    - * BatchAssociateApprovalRuleTemplateWithRepositories, which associates a - * template with one or more specified repositories. After the template is - * associated with a repository, AWS CodeCommit creates approval rules that match - * the template conditions on every pull request created in the specified - * repositories.

    - *
  • - *
  • - *

    - * BatchDisassociateApprovalRuleTemplateFromRepositories, which removes the - * association between a template and specified repositories so that approval rules - * based on the template are not automatically created when pull requests are - * created in those repositories.

    - *
  • - *
  • - *

    - * CreateApprovalRuleTemplate, which creates a template for approval rules that can then be associated with one or more repositories - * in your AWS account.

    - *
  • - *
  • - *

    - * DeleteApprovalRuleTemplate, which deletes the specified template. It does not remove approval rules on pull requests already created with the template.

    - *
  • - *
  • - *

    - * DisassociateApprovalRuleTemplateFromRepository, which removes the - * association between a template and a repository so that approval rules based on - * the template are not automatically created when pull requests are created in the - * specified repository.

    - *
  • - *
  • - *

    - * GetApprovalRuleTemplate, which returns information about an approval rule template.

    - *
  • - *
  • - *

    - * ListApprovalRuleTemplates, which lists all approval rule templates in the AWS Region in your AWS account.

    - *
  • - *
  • - *

    - * ListAssociatedApprovalRuleTemplatesForRepository, which lists all approval rule templates that are associated with a specified repository.

    - *
  • - *
  • - *

    - * ListRepositoriesForApprovalRuleTemplate, which lists all repositories associated with the specified approval rule template.

    - *
  • - *
  • - *

    - * UpdateApprovalRuleTemplateDescription, which updates the description of an - * approval rule template.

    - *
  • - *
  • - *

    - * UpdateApprovalRuleTemplateName, which updates the name of an approval rule template.

    - *
  • - *
  • - *

    - * UpdateApprovalRuleTemplateContent, which updates the content of an approval rule template.

    - *
  • - *
- * - *

Comments in a repository, by calling the following:

- *
    - *
  • - *

    - * DeleteCommentContent, which deletes the content of a comment on a commit in a repository.

    - *
  • - *
  • - *

    - * GetComment, which returns information about a comment on a commit.

    - *
  • - *
  • - *

    - * GetCommentReactions, which returns information about emoji reactions to comments.

    - *
  • - *
  • - *

    - * GetCommentsForComparedCommit, which returns information about comments on the comparison between two commit specifiers - * in a repository.

    - *
  • - *
  • - *

    - * PostCommentForComparedCommit, which creates a comment on the comparison between two commit specifiers in a repository.

    - *
  • - *
  • - *

    - * PostCommentReply, which creates a reply to a comment.

    - *
  • - *
  • - *

    - * PutCommentReaction, which creates or updates an emoji reaction to a comment.

    - *
  • - *
  • - *

    - * UpdateComment, which updates the content of a comment on a commit in a repository.

    - *
  • - *
- * - *

Tags used to tag resources in AWS CodeCommit (not Git tags), by calling the following:

- *
    - *
  • - *

    - * ListTagsForResource, which gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeCommit.

    - *
  • - *
  • - *

    - * TagResource, which adds or updates tags for a resource in AWS CodeCommit.

    - *
  • - *
  • - *

    - * UntagResource, which removes tags for a resource in AWS CodeCommit.

    - *
  • - *
- * - *

Triggers, by calling the following:

- *
    - *
  • - *

    - * GetRepositoryTriggers, which returns information about triggers configured - * for a repository.

    - *
  • - *
  • - *

    - * PutRepositoryTriggers, which replaces all triggers for a repository and can - * be used to create or delete triggers.

    - *
  • - *
  • - *

    - * TestRepositoryTriggers, which tests the functionality of a repository trigger - * by sending data to the trigger target.

    - *
  • - *
- * - * - * - * - *

For information about how to use AWS CodeCommit, see the AWS CodeCommit User Guide.

- */ -export class CodeCommit extends CodeCommitClient { - /** - * @public - *

Creates an association between an approval rule template and a specified repository. - * Then, the next time a pull request is created in the repository where the destination - * reference (if specified) matches the destination reference (branch) for the pull - * request, an approval rule that matches the template conditions is automatically created - * for that pull request. If no destination references are specified in the template, an - * approval rule that matches the template contents is created for all pull requests in - * that repository.

- */ - public associateApprovalRuleTemplateWithRepository( +const commands = { + AssociateApprovalRuleTemplateWithRepositoryCommand, + BatchAssociateApprovalRuleTemplateWithRepositoriesCommand, + BatchDescribeMergeConflictsCommand, + BatchDisassociateApprovalRuleTemplateFromRepositoriesCommand, + BatchGetCommitsCommand, + BatchGetRepositoriesCommand, + CreateApprovalRuleTemplateCommand, + CreateBranchCommand, + CreateCommitCommand, + CreatePullRequestCommand, + CreatePullRequestApprovalRuleCommand, + CreateRepositoryCommand, + CreateUnreferencedMergeCommitCommand, + DeleteApprovalRuleTemplateCommand, + DeleteBranchCommand, + DeleteCommentContentCommand, + DeleteFileCommand, + DeletePullRequestApprovalRuleCommand, + DeleteRepositoryCommand, + DescribeMergeConflictsCommand, + DescribePullRequestEventsCommand, + DisassociateApprovalRuleTemplateFromRepositoryCommand, + EvaluatePullRequestApprovalRulesCommand, + GetApprovalRuleTemplateCommand, + GetBlobCommand, + GetBranchCommand, + GetCommentCommand, + GetCommentReactionsCommand, + GetCommentsForComparedCommitCommand, + GetCommentsForPullRequestCommand, + GetCommitCommand, + GetDifferencesCommand, + GetFileCommand, + GetFolderCommand, + GetMergeCommitCommand, + GetMergeConflictsCommand, + GetMergeOptionsCommand, + GetPullRequestCommand, + GetPullRequestApprovalStatesCommand, + GetPullRequestOverrideStateCommand, + GetRepositoryCommand, + GetRepositoryTriggersCommand, + ListApprovalRuleTemplatesCommand, + ListAssociatedApprovalRuleTemplatesForRepositoryCommand, + ListBranchesCommand, + ListPullRequestsCommand, + ListRepositoriesCommand, + ListRepositoriesForApprovalRuleTemplateCommand, + ListTagsForResourceCommand, + MergeBranchesByFastForwardCommand, + MergeBranchesBySquashCommand, + MergeBranchesByThreeWayCommand, + MergePullRequestByFastForwardCommand, + MergePullRequestBySquashCommand, + MergePullRequestByThreeWayCommand, + OverridePullRequestApprovalRulesCommand, + PostCommentForComparedCommitCommand, + PostCommentForPullRequestCommand, + PostCommentReplyCommand, + PutCommentReactionCommand, + PutFileCommand, + PutRepositoryTriggersCommand, + TagResourceCommand, + TestRepositoryTriggersCommand, + UntagResourceCommand, + UpdateApprovalRuleTemplateContentCommand, + UpdateApprovalRuleTemplateDescriptionCommand, + UpdateApprovalRuleTemplateNameCommand, + UpdateCommentCommand, + UpdateDefaultBranchCommand, + UpdatePullRequestApprovalRuleContentCommand, + UpdatePullRequestApprovalStateCommand, + UpdatePullRequestDescriptionCommand, + UpdatePullRequestStatusCommand, + UpdatePullRequestTitleCommand, + UpdateRepositoryDescriptionCommand, + UpdateRepositoryNameCommand, +}; + +export interface CodeCommit { + /** + * @see {@link AssociateApprovalRuleTemplateWithRepositoryCommand} + */ + associateApprovalRuleTemplateWithRepository( args: AssociateApprovalRuleTemplateWithRepositoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateApprovalRuleTemplateWithRepository( + associateApprovalRuleTemplateWithRepository( args: AssociateApprovalRuleTemplateWithRepositoryCommandInput, cb: (err: any, data?: AssociateApprovalRuleTemplateWithRepositoryCommandOutput) => void ): void; - public associateApprovalRuleTemplateWithRepository( + associateApprovalRuleTemplateWithRepository( args: AssociateApprovalRuleTemplateWithRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateApprovalRuleTemplateWithRepositoryCommandOutput) => void ): void; - public associateApprovalRuleTemplateWithRepository( - args: AssociateApprovalRuleTemplateWithRepositoryCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AssociateApprovalRuleTemplateWithRepositoryCommandOutput) => void), - cb?: (err: any, data?: AssociateApprovalRuleTemplateWithRepositoryCommandOutput) => void - ): Promise | void { - const command = new AssociateApprovalRuleTemplateWithRepositoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an association between an approval rule template and one or more specified repositories.

- */ - public batchAssociateApprovalRuleTemplateWithRepositories( + + /** + * @see {@link BatchAssociateApprovalRuleTemplateWithRepositoriesCommand} + */ + batchAssociateApprovalRuleTemplateWithRepositories( args: BatchAssociateApprovalRuleTemplateWithRepositoriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchAssociateApprovalRuleTemplateWithRepositories( + batchAssociateApprovalRuleTemplateWithRepositories( args: BatchAssociateApprovalRuleTemplateWithRepositoriesCommandInput, cb: (err: any, data?: BatchAssociateApprovalRuleTemplateWithRepositoriesCommandOutput) => void ): void; - public batchAssociateApprovalRuleTemplateWithRepositories( + batchAssociateApprovalRuleTemplateWithRepositories( args: BatchAssociateApprovalRuleTemplateWithRepositoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchAssociateApprovalRuleTemplateWithRepositoriesCommandOutput) => void ): void; - public batchAssociateApprovalRuleTemplateWithRepositories( - args: BatchAssociateApprovalRuleTemplateWithRepositoriesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: BatchAssociateApprovalRuleTemplateWithRepositoriesCommandOutput) => void), - cb?: (err: any, data?: BatchAssociateApprovalRuleTemplateWithRepositoriesCommandOutput) => void - ): Promise | void { - const command = new BatchAssociateApprovalRuleTemplateWithRepositoriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about one or more merge conflicts in the attempted merge of two commit specifiers using the squash or three-way merge strategy.

- */ - public batchDescribeMergeConflicts( + + /** + * @see {@link BatchDescribeMergeConflictsCommand} + */ + batchDescribeMergeConflicts( args: BatchDescribeMergeConflictsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDescribeMergeConflicts( + batchDescribeMergeConflicts( args: BatchDescribeMergeConflictsCommandInput, cb: (err: any, data?: BatchDescribeMergeConflictsCommandOutput) => void ): void; - public batchDescribeMergeConflicts( + batchDescribeMergeConflicts( args: BatchDescribeMergeConflictsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDescribeMergeConflictsCommandOutput) => void ): void; - public batchDescribeMergeConflicts( - args: BatchDescribeMergeConflictsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDescribeMergeConflictsCommandOutput) => void), - cb?: (err: any, data?: BatchDescribeMergeConflictsCommandOutput) => void - ): Promise | void { - const command = new BatchDescribeMergeConflictsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the association between an approval rule template and one or more specified repositories.

- */ - public batchDisassociateApprovalRuleTemplateFromRepositories( + + /** + * @see {@link BatchDisassociateApprovalRuleTemplateFromRepositoriesCommand} + */ + batchDisassociateApprovalRuleTemplateFromRepositories( args: BatchDisassociateApprovalRuleTemplateFromRepositoriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDisassociateApprovalRuleTemplateFromRepositories( + batchDisassociateApprovalRuleTemplateFromRepositories( args: BatchDisassociateApprovalRuleTemplateFromRepositoriesCommandInput, cb: (err: any, data?: BatchDisassociateApprovalRuleTemplateFromRepositoriesCommandOutput) => void ): void; - public batchDisassociateApprovalRuleTemplateFromRepositories( + batchDisassociateApprovalRuleTemplateFromRepositories( args: BatchDisassociateApprovalRuleTemplateFromRepositoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDisassociateApprovalRuleTemplateFromRepositoriesCommandOutput) => void ): void; - public batchDisassociateApprovalRuleTemplateFromRepositories( - args: BatchDisassociateApprovalRuleTemplateFromRepositoriesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: BatchDisassociateApprovalRuleTemplateFromRepositoriesCommandOutput) => void), - cb?: (err: any, data?: BatchDisassociateApprovalRuleTemplateFromRepositoriesCommandOutput) => void - ): Promise | void { - const command = new BatchDisassociateApprovalRuleTemplateFromRepositoriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the contents of one or more commits in a repository.

- */ - public batchGetCommits( + + /** + * @see {@link BatchGetCommitsCommand} + */ + batchGetCommits( args: BatchGetCommitsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetCommits( - args: BatchGetCommitsCommandInput, - cb: (err: any, data?: BatchGetCommitsCommandOutput) => void - ): void; - public batchGetCommits( + batchGetCommits(args: BatchGetCommitsCommandInput, cb: (err: any, data?: BatchGetCommitsCommandOutput) => void): void; + batchGetCommits( args: BatchGetCommitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetCommitsCommandOutput) => void ): void; - public batchGetCommits( - args: BatchGetCommitsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetCommitsCommandOutput) => void), - cb?: (err: any, data?: BatchGetCommitsCommandOutput) => void - ): Promise | void { - const command = new BatchGetCommitsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about one or more repositories.

- * - *

The description field for a repository accepts all HTML characters and all valid - * Unicode characters. Applications that do not HTML-encode the description and display - * it in a webpage can expose users to potentially malicious code. Make sure that you - * HTML-encode the description field in any application that uses this API to display - * the repository description on a webpage.

- *
- */ - public batchGetRepositories( + + /** + * @see {@link BatchGetRepositoriesCommand} + */ + batchGetRepositories( args: BatchGetRepositoriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetRepositories( + batchGetRepositories( args: BatchGetRepositoriesCommandInput, cb: (err: any, data?: BatchGetRepositoriesCommandOutput) => void ): void; - public batchGetRepositories( + batchGetRepositories( args: BatchGetRepositoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetRepositoriesCommandOutput) => void ): void; - public batchGetRepositories( - args: BatchGetRepositoriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetRepositoriesCommandOutput) => void), - cb?: (err: any, data?: BatchGetRepositoriesCommandOutput) => void - ): Promise | void { - const command = new BatchGetRepositoriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a template for approval rules that can then be associated with one or more - * repositories in your AWS account. When you associate a template with a repository, AWS - * CodeCommit creates an approval rule that matches the conditions of the template for all - * pull requests that meet the conditions of the template. For more information, see - * AssociateApprovalRuleTemplateWithRepository.

- */ - public createApprovalRuleTemplate( + + /** + * @see {@link CreateApprovalRuleTemplateCommand} + */ + createApprovalRuleTemplate( args: CreateApprovalRuleTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApprovalRuleTemplate( + createApprovalRuleTemplate( args: CreateApprovalRuleTemplateCommandInput, cb: (err: any, data?: CreateApprovalRuleTemplateCommandOutput) => void ): void; - public createApprovalRuleTemplate( + createApprovalRuleTemplate( args: CreateApprovalRuleTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApprovalRuleTemplateCommandOutput) => void ): void; - public createApprovalRuleTemplate( - args: CreateApprovalRuleTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApprovalRuleTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateApprovalRuleTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateApprovalRuleTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a branch in a repository and points the branch to a commit.

- * - *

Calling the create branch operation does not set a repository's default branch. To do this, call the update default branch operation.

- *
- */ - public createBranch( - args: CreateBranchCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createBranch(args: CreateBranchCommandInput, cb: (err: any, data?: CreateBranchCommandOutput) => void): void; - public createBranch( + + /** + * @see {@link CreateBranchCommand} + */ + createBranch(args: CreateBranchCommandInput, options?: __HttpHandlerOptions): Promise; + createBranch(args: CreateBranchCommandInput, cb: (err: any, data?: CreateBranchCommandOutput) => void): void; + createBranch( args: CreateBranchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBranchCommandOutput) => void ): void; - public createBranch( - args: CreateBranchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBranchCommandOutput) => void), - cb?: (err: any, data?: CreateBranchCommandOutput) => void - ): Promise | void { - const command = new CreateBranchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a commit for a repository on the tip of a specified branch.

- */ - public createCommit( - args: CreateCommitCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createCommit(args: CreateCommitCommandInput, cb: (err: any, data?: CreateCommitCommandOutput) => void): void; - public createCommit( + + /** + * @see {@link CreateCommitCommand} + */ + createCommit(args: CreateCommitCommandInput, options?: __HttpHandlerOptions): Promise; + createCommit(args: CreateCommitCommandInput, cb: (err: any, data?: CreateCommitCommandOutput) => void): void; + createCommit( args: CreateCommitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCommitCommandOutput) => void ): void; - public createCommit( - args: CreateCommitCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCommitCommandOutput) => void), - cb?: (err: any, data?: CreateCommitCommandOutput) => void - ): Promise | void { - const command = new CreateCommitCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a pull request in the specified repository.

- */ - public createPullRequest( + + /** + * @see {@link CreatePullRequestCommand} + */ + createPullRequest( args: CreatePullRequestCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPullRequest( + createPullRequest( args: CreatePullRequestCommandInput, cb: (err: any, data?: CreatePullRequestCommandOutput) => void ): void; - public createPullRequest( + createPullRequest( args: CreatePullRequestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePullRequestCommandOutput) => void ): void; - public createPullRequest( - args: CreatePullRequestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePullRequestCommandOutput) => void), - cb?: (err: any, data?: CreatePullRequestCommandOutput) => void - ): Promise | void { - const command = new CreatePullRequestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an approval rule for a pull request.

- */ - public createPullRequestApprovalRule( + + /** + * @see {@link CreatePullRequestApprovalRuleCommand} + */ + createPullRequestApprovalRule( args: CreatePullRequestApprovalRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPullRequestApprovalRule( + createPullRequestApprovalRule( args: CreatePullRequestApprovalRuleCommandInput, cb: (err: any, data?: CreatePullRequestApprovalRuleCommandOutput) => void ): void; - public createPullRequestApprovalRule( + createPullRequestApprovalRule( args: CreatePullRequestApprovalRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePullRequestApprovalRuleCommandOutput) => void ): void; - public createPullRequestApprovalRule( - args: CreatePullRequestApprovalRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePullRequestApprovalRuleCommandOutput) => void), - cb?: (err: any, data?: CreatePullRequestApprovalRuleCommandOutput) => void - ): Promise | void { - const command = new CreatePullRequestApprovalRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new, empty repository.

- */ - public createRepository( + + /** + * @see {@link CreateRepositoryCommand} + */ + createRepository( args: CreateRepositoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRepository( + createRepository( args: CreateRepositoryCommandInput, cb: (err: any, data?: CreateRepositoryCommandOutput) => void ): void; - public createRepository( + createRepository( args: CreateRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRepositoryCommandOutput) => void ): void; - public createRepository( - args: CreateRepositoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRepositoryCommandOutput) => void), - cb?: (err: any, data?: CreateRepositoryCommandOutput) => void - ): Promise | void { - const command = new CreateRepositoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an unreferenced commit that represents the result of merging two branches - * using a specified merge strategy. This can help you determine the outcome of a potential - * merge. This API cannot be used with the fast-forward merge strategy because that - * strategy does not create a merge commit.

- * - *

This unreferenced merge commit - * can only be accessed using the GetCommit API or through git commands such as git fetch. To retrieve this commit, you must specify its commit ID or otherwise reference it.

- *
- */ - public createUnreferencedMergeCommit( + + /** + * @see {@link CreateUnreferencedMergeCommitCommand} + */ + createUnreferencedMergeCommit( args: CreateUnreferencedMergeCommitCommandInput, options?: __HttpHandlerOptions ): Promise; - public createUnreferencedMergeCommit( + createUnreferencedMergeCommit( args: CreateUnreferencedMergeCommitCommandInput, cb: (err: any, data?: CreateUnreferencedMergeCommitCommandOutput) => void ): void; - public createUnreferencedMergeCommit( + createUnreferencedMergeCommit( args: CreateUnreferencedMergeCommitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUnreferencedMergeCommitCommandOutput) => void ): void; - public createUnreferencedMergeCommit( - args: CreateUnreferencedMergeCommitCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUnreferencedMergeCommitCommandOutput) => void), - cb?: (err: any, data?: CreateUnreferencedMergeCommitCommandOutput) => void - ): Promise | void { - const command = new CreateUnreferencedMergeCommitCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specified approval rule template. Deleting a template does not remove approval rules on pull requests already created with the template.

- */ - public deleteApprovalRuleTemplate( + + /** + * @see {@link DeleteApprovalRuleTemplateCommand} + */ + deleteApprovalRuleTemplate( args: DeleteApprovalRuleTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApprovalRuleTemplate( + deleteApprovalRuleTemplate( args: DeleteApprovalRuleTemplateCommandInput, cb: (err: any, data?: DeleteApprovalRuleTemplateCommandOutput) => void ): void; - public deleteApprovalRuleTemplate( + deleteApprovalRuleTemplate( args: DeleteApprovalRuleTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApprovalRuleTemplateCommandOutput) => void ): void; - public deleteApprovalRuleTemplate( - args: DeleteApprovalRuleTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApprovalRuleTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteApprovalRuleTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteApprovalRuleTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a branch from a repository, unless that branch is the default branch for the repository.

- */ - public deleteBranch( - args: DeleteBranchCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteBranch(args: DeleteBranchCommandInput, cb: (err: any, data?: DeleteBranchCommandOutput) => void): void; - public deleteBranch( + + /** + * @see {@link DeleteBranchCommand} + */ + deleteBranch(args: DeleteBranchCommandInput, options?: __HttpHandlerOptions): Promise; + deleteBranch(args: DeleteBranchCommandInput, cb: (err: any, data?: DeleteBranchCommandOutput) => void): void; + deleteBranch( args: DeleteBranchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBranchCommandOutput) => void ): void; - public deleteBranch( - args: DeleteBranchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBranchCommandOutput) => void), - cb?: (err: any, data?: DeleteBranchCommandOutput) => void - ): Promise | void { - const command = new DeleteBranchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the content of a comment made on a change, file, or commit in a repository.

- */ - public deleteCommentContent( + + /** + * @see {@link DeleteCommentContentCommand} + */ + deleteCommentContent( args: DeleteCommentContentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCommentContent( + deleteCommentContent( args: DeleteCommentContentCommandInput, cb: (err: any, data?: DeleteCommentContentCommandOutput) => void ): void; - public deleteCommentContent( + deleteCommentContent( args: DeleteCommentContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCommentContentCommandOutput) => void ): void; - public deleteCommentContent( - args: DeleteCommentContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCommentContentCommandOutput) => void), - cb?: (err: any, data?: DeleteCommentContentCommandOutput) => void - ): Promise | void { - const command = new DeleteCommentContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specified file from a specified branch. A commit is created on the branch - * that contains the revision. The file still exists in the commits earlier to the commit - * that contains the deletion.

- */ - public deleteFile(args: DeleteFileCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteFile(args: DeleteFileCommandInput, cb: (err: any, data?: DeleteFileCommandOutput) => void): void; - public deleteFile( + + /** + * @see {@link DeleteFileCommand} + */ + deleteFile(args: DeleteFileCommandInput, options?: __HttpHandlerOptions): Promise; + deleteFile(args: DeleteFileCommandInput, cb: (err: any, data?: DeleteFileCommandOutput) => void): void; + deleteFile( args: DeleteFileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFileCommandOutput) => void ): void; - public deleteFile( - args: DeleteFileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFileCommandOutput) => void), - cb?: (err: any, data?: DeleteFileCommandOutput) => void - ): Promise | void { - const command = new DeleteFileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an approval rule from a specified pull request. Approval rules can be deleted from a pull request only if the pull request is open, and if the - * approval rule was created specifically for a pull request and not generated from an approval rule template associated with the repository where the - * pull request was created. You cannot delete an approval rule from a merged or closed pull request.

- */ - public deletePullRequestApprovalRule( + + /** + * @see {@link DeletePullRequestApprovalRuleCommand} + */ + deletePullRequestApprovalRule( args: DeletePullRequestApprovalRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePullRequestApprovalRule( + deletePullRequestApprovalRule( args: DeletePullRequestApprovalRuleCommandInput, cb: (err: any, data?: DeletePullRequestApprovalRuleCommandOutput) => void ): void; - public deletePullRequestApprovalRule( + deletePullRequestApprovalRule( args: DeletePullRequestApprovalRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePullRequestApprovalRuleCommandOutput) => void ): void; - public deletePullRequestApprovalRule( - args: DeletePullRequestApprovalRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePullRequestApprovalRuleCommandOutput) => void), - cb?: (err: any, data?: DeletePullRequestApprovalRuleCommandOutput) => void - ): Promise | void { - const command = new DeletePullRequestApprovalRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a repository. If a specified repository was already deleted, a null repository - * ID is returned.

- * - *

Deleting a repository also deletes all associated objects and metadata. After a repository is - * deleted, all future push calls to the deleted repository fail.

- *
- */ - public deleteRepository( + + /** + * @see {@link DeleteRepositoryCommand} + */ + deleteRepository( args: DeleteRepositoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRepository( + deleteRepository( args: DeleteRepositoryCommandInput, cb: (err: any, data?: DeleteRepositoryCommandOutput) => void ): void; - public deleteRepository( + deleteRepository( args: DeleteRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRepositoryCommandOutput) => void ): void; - public deleteRepository( - args: DeleteRepositoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRepositoryCommandOutput) => void), - cb?: (err: any, data?: DeleteRepositoryCommandOutput) => void - ): Promise | void { - const command = new DeleteRepositoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about one or more merge conflicts in the attempted merge of two - * commit specifiers using the squash or three-way merge strategy. If the merge option for - * the attempted merge is specified as FAST_FORWARD_MERGE, an exception is thrown.

- */ - public describeMergeConflicts( + + /** + * @see {@link DescribeMergeConflictsCommand} + */ + describeMergeConflicts( args: DescribeMergeConflictsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMergeConflicts( + describeMergeConflicts( args: DescribeMergeConflictsCommandInput, cb: (err: any, data?: DescribeMergeConflictsCommandOutput) => void ): void; - public describeMergeConflicts( + describeMergeConflicts( args: DescribeMergeConflictsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMergeConflictsCommandOutput) => void ): void; - public describeMergeConflicts( - args: DescribeMergeConflictsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMergeConflictsCommandOutput) => void), - cb?: (err: any, data?: DescribeMergeConflictsCommandOutput) => void - ): Promise | void { - const command = new DescribeMergeConflictsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about one or more pull request events.

- */ - public describePullRequestEvents( + + /** + * @see {@link DescribePullRequestEventsCommand} + */ + describePullRequestEvents( args: DescribePullRequestEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePullRequestEvents( + describePullRequestEvents( args: DescribePullRequestEventsCommandInput, cb: (err: any, data?: DescribePullRequestEventsCommandOutput) => void ): void; - public describePullRequestEvents( + describePullRequestEvents( args: DescribePullRequestEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePullRequestEventsCommandOutput) => void ): void; - public describePullRequestEvents( - args: DescribePullRequestEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePullRequestEventsCommandOutput) => void), - cb?: (err: any, data?: DescribePullRequestEventsCommandOutput) => void - ): Promise | void { - const command = new DescribePullRequestEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the association between a template and a repository so that approval rules - * based on the template are not automatically created when pull requests are created in - * the specified repository. This does not delete any approval rules previously created for - * pull requests through the template association.

- */ - public disassociateApprovalRuleTemplateFromRepository( + + /** + * @see {@link DisassociateApprovalRuleTemplateFromRepositoryCommand} + */ + disassociateApprovalRuleTemplateFromRepository( args: DisassociateApprovalRuleTemplateFromRepositoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateApprovalRuleTemplateFromRepository( + disassociateApprovalRuleTemplateFromRepository( args: DisassociateApprovalRuleTemplateFromRepositoryCommandInput, cb: (err: any, data?: DisassociateApprovalRuleTemplateFromRepositoryCommandOutput) => void ): void; - public disassociateApprovalRuleTemplateFromRepository( + disassociateApprovalRuleTemplateFromRepository( args: DisassociateApprovalRuleTemplateFromRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateApprovalRuleTemplateFromRepositoryCommandOutput) => void ): void; - public disassociateApprovalRuleTemplateFromRepository( - args: DisassociateApprovalRuleTemplateFromRepositoryCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociateApprovalRuleTemplateFromRepositoryCommandOutput) => void), - cb?: (err: any, data?: DisassociateApprovalRuleTemplateFromRepositoryCommandOutput) => void - ): Promise | void { - const command = new DisassociateApprovalRuleTemplateFromRepositoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Evaluates whether a pull request has met all the conditions specified in its associated approval rules.

- */ - public evaluatePullRequestApprovalRules( + + /** + * @see {@link EvaluatePullRequestApprovalRulesCommand} + */ + evaluatePullRequestApprovalRules( args: EvaluatePullRequestApprovalRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public evaluatePullRequestApprovalRules( + evaluatePullRequestApprovalRules( args: EvaluatePullRequestApprovalRulesCommandInput, cb: (err: any, data?: EvaluatePullRequestApprovalRulesCommandOutput) => void ): void; - public evaluatePullRequestApprovalRules( + evaluatePullRequestApprovalRules( args: EvaluatePullRequestApprovalRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EvaluatePullRequestApprovalRulesCommandOutput) => void ): void; - public evaluatePullRequestApprovalRules( - args: EvaluatePullRequestApprovalRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EvaluatePullRequestApprovalRulesCommandOutput) => void), - cb?: (err: any, data?: EvaluatePullRequestApprovalRulesCommandOutput) => void - ): Promise | void { - const command = new EvaluatePullRequestApprovalRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a specified approval rule template.

- */ - public getApprovalRuleTemplate( + + /** + * @see {@link GetApprovalRuleTemplateCommand} + */ + getApprovalRuleTemplate( args: GetApprovalRuleTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getApprovalRuleTemplate( + getApprovalRuleTemplate( args: GetApprovalRuleTemplateCommandInput, cb: (err: any, data?: GetApprovalRuleTemplateCommandOutput) => void ): void; - public getApprovalRuleTemplate( + getApprovalRuleTemplate( args: GetApprovalRuleTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApprovalRuleTemplateCommandOutput) => void ): void; - public getApprovalRuleTemplate( - args: GetApprovalRuleTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApprovalRuleTemplateCommandOutput) => void), - cb?: (err: any, data?: GetApprovalRuleTemplateCommandOutput) => void - ): Promise | void { - const command = new GetApprovalRuleTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the base-64 encoded content of an individual blob in a repository.

- */ - public getBlob(args: GetBlobCommandInput, options?: __HttpHandlerOptions): Promise; - public getBlob(args: GetBlobCommandInput, cb: (err: any, data?: GetBlobCommandOutput) => void): void; - public getBlob( + + /** + * @see {@link GetBlobCommand} + */ + getBlob(args: GetBlobCommandInput, options?: __HttpHandlerOptions): Promise; + getBlob(args: GetBlobCommandInput, cb: (err: any, data?: GetBlobCommandOutput) => void): void; + getBlob( args: GetBlobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBlobCommandOutput) => void ): void; - public getBlob( - args: GetBlobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBlobCommandOutput) => void), - cb?: (err: any, data?: GetBlobCommandOutput) => void - ): Promise | void { - const command = new GetBlobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a repository branch, including its name and the last commit ID.

- */ - public getBranch(args: GetBranchCommandInput, options?: __HttpHandlerOptions): Promise; - public getBranch(args: GetBranchCommandInput, cb: (err: any, data?: GetBranchCommandOutput) => void): void; - public getBranch( + + /** + * @see {@link GetBranchCommand} + */ + getBranch(args: GetBranchCommandInput, options?: __HttpHandlerOptions): Promise; + getBranch(args: GetBranchCommandInput, cb: (err: any, data?: GetBranchCommandOutput) => void): void; + getBranch( args: GetBranchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBranchCommandOutput) => void ): void; - public getBranch( - args: GetBranchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBranchCommandOutput) => void), - cb?: (err: any, data?: GetBranchCommandOutput) => void - ): Promise | void { - const command = new GetBranchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the content of a comment made on a change, file, or commit in a repository.

- * - *

Reaction counts might include numbers from user identities who were deleted after the reaction was made. For a count of - * reactions from active identities, use GetCommentReactions.

- *
- */ - public getComment(args: GetCommentCommandInput, options?: __HttpHandlerOptions): Promise; - public getComment(args: GetCommentCommandInput, cb: (err: any, data?: GetCommentCommandOutput) => void): void; - public getComment( + + /** + * @see {@link GetCommentCommand} + */ + getComment(args: GetCommentCommandInput, options?: __HttpHandlerOptions): Promise; + getComment(args: GetCommentCommandInput, cb: (err: any, data?: GetCommentCommandOutput) => void): void; + getComment( args: GetCommentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCommentCommandOutput) => void ): void; - public getComment( - args: GetCommentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCommentCommandOutput) => void), - cb?: (err: any, data?: GetCommentCommandOutput) => void - ): Promise | void { - const command = new GetCommentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about reactions to a specified comment ID. Reactions from users who have been deleted will not be included in the count.

- */ - public getCommentReactions( + + /** + * @see {@link GetCommentReactionsCommand} + */ + getCommentReactions( args: GetCommentReactionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCommentReactions( + getCommentReactions( args: GetCommentReactionsCommandInput, cb: (err: any, data?: GetCommentReactionsCommandOutput) => void ): void; - public getCommentReactions( + getCommentReactions( args: GetCommentReactionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCommentReactionsCommandOutput) => void ): void; - public getCommentReactions( - args: GetCommentReactionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCommentReactionsCommandOutput) => void), - cb?: (err: any, data?: GetCommentReactionsCommandOutput) => void - ): Promise | void { - const command = new GetCommentReactionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about comments made on the comparison between two commits.

- * - *

Reaction counts might include numbers from user identities who were deleted after the reaction was made. For a count of - * reactions from active identities, use GetCommentReactions.

- *
- */ - public getCommentsForComparedCommit( + + /** + * @see {@link GetCommentsForComparedCommitCommand} + */ + getCommentsForComparedCommit( args: GetCommentsForComparedCommitCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCommentsForComparedCommit( + getCommentsForComparedCommit( args: GetCommentsForComparedCommitCommandInput, cb: (err: any, data?: GetCommentsForComparedCommitCommandOutput) => void ): void; - public getCommentsForComparedCommit( + getCommentsForComparedCommit( args: GetCommentsForComparedCommitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCommentsForComparedCommitCommandOutput) => void ): void; - public getCommentsForComparedCommit( - args: GetCommentsForComparedCommitCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCommentsForComparedCommitCommandOutput) => void), - cb?: (err: any, data?: GetCommentsForComparedCommitCommandOutput) => void - ): Promise | void { - const command = new GetCommentsForComparedCommitCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns comments made on a pull request.

- * - *

Reaction counts might include numbers from user identities who were deleted after the reaction was made. For a count of - * reactions from active identities, use GetCommentReactions.

- *
- */ - public getCommentsForPullRequest( + + /** + * @see {@link GetCommentsForPullRequestCommand} + */ + getCommentsForPullRequest( args: GetCommentsForPullRequestCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCommentsForPullRequest( + getCommentsForPullRequest( args: GetCommentsForPullRequestCommandInput, cb: (err: any, data?: GetCommentsForPullRequestCommandOutput) => void ): void; - public getCommentsForPullRequest( + getCommentsForPullRequest( args: GetCommentsForPullRequestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCommentsForPullRequestCommandOutput) => void ): void; - public getCommentsForPullRequest( - args: GetCommentsForPullRequestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCommentsForPullRequestCommandOutput) => void), - cb?: (err: any, data?: GetCommentsForPullRequestCommandOutput) => void - ): Promise | void { - const command = new GetCommentsForPullRequestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a commit, including commit message and committer information.

- */ - public getCommit(args: GetCommitCommandInput, options?: __HttpHandlerOptions): Promise; - public getCommit(args: GetCommitCommandInput, cb: (err: any, data?: GetCommitCommandOutput) => void): void; - public getCommit( + + /** + * @see {@link GetCommitCommand} + */ + getCommit(args: GetCommitCommandInput, options?: __HttpHandlerOptions): Promise; + getCommit(args: GetCommitCommandInput, cb: (err: any, data?: GetCommitCommandOutput) => void): void; + getCommit( args: GetCommitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCommitCommandOutput) => void ): void; - public getCommit( - args: GetCommitCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCommitCommandOutput) => void), - cb?: (err: any, data?: GetCommitCommandOutput) => void - ): Promise | void { - const command = new GetCommitCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the differences in a valid commit specifier (such as a - * branch, tag, HEAD, commit ID, or other fully qualified reference). Results can be - * limited to a specified path.

- */ - public getDifferences( + + /** + * @see {@link GetDifferencesCommand} + */ + getDifferences( args: GetDifferencesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDifferences( - args: GetDifferencesCommandInput, - cb: (err: any, data?: GetDifferencesCommandOutput) => void - ): void; - public getDifferences( + getDifferences(args: GetDifferencesCommandInput, cb: (err: any, data?: GetDifferencesCommandOutput) => void): void; + getDifferences( args: GetDifferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDifferencesCommandOutput) => void ): void; - public getDifferences( - args: GetDifferencesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDifferencesCommandOutput) => void), - cb?: (err: any, data?: GetDifferencesCommandOutput) => void - ): Promise | void { - const command = new GetDifferencesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the base-64 encoded contents of a specified file and its metadata.

- */ - public getFile(args: GetFileCommandInput, options?: __HttpHandlerOptions): Promise; - public getFile(args: GetFileCommandInput, cb: (err: any, data?: GetFileCommandOutput) => void): void; - public getFile( + + /** + * @see {@link GetFileCommand} + */ + getFile(args: GetFileCommandInput, options?: __HttpHandlerOptions): Promise; + getFile(args: GetFileCommandInput, cb: (err: any, data?: GetFileCommandOutput) => void): void; + getFile( args: GetFileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFileCommandOutput) => void ): void; - public getFile( - args: GetFileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFileCommandOutput) => void), - cb?: (err: any, data?: GetFileCommandOutput) => void - ): Promise | void { - const command = new GetFileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the contents of a specified folder in a repository.

- */ - public getFolder(args: GetFolderCommandInput, options?: __HttpHandlerOptions): Promise; - public getFolder(args: GetFolderCommandInput, cb: (err: any, data?: GetFolderCommandOutput) => void): void; - public getFolder( + + /** + * @see {@link GetFolderCommand} + */ + getFolder(args: GetFolderCommandInput, options?: __HttpHandlerOptions): Promise; + getFolder(args: GetFolderCommandInput, cb: (err: any, data?: GetFolderCommandOutput) => void): void; + getFolder( args: GetFolderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFolderCommandOutput) => void ): void; - public getFolder( - args: GetFolderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFolderCommandOutput) => void), - cb?: (err: any, data?: GetFolderCommandOutput) => void - ): Promise | void { - const command = new GetFolderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a specified merge commit.

- */ - public getMergeCommit( + + /** + * @see {@link GetMergeCommitCommand} + */ + getMergeCommit( args: GetMergeCommitCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMergeCommit( - args: GetMergeCommitCommandInput, - cb: (err: any, data?: GetMergeCommitCommandOutput) => void - ): void; - public getMergeCommit( + getMergeCommit(args: GetMergeCommitCommandInput, cb: (err: any, data?: GetMergeCommitCommandOutput) => void): void; + getMergeCommit( args: GetMergeCommitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMergeCommitCommandOutput) => void ): void; - public getMergeCommit( - args: GetMergeCommitCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMergeCommitCommandOutput) => void), - cb?: (err: any, data?: GetMergeCommitCommandOutput) => void - ): Promise | void { - const command = new GetMergeCommitCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about merge conflicts between the before and after commit IDs for a pull request in a repository.

- */ - public getMergeConflicts( + + /** + * @see {@link GetMergeConflictsCommand} + */ + getMergeConflicts( args: GetMergeConflictsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMergeConflicts( + getMergeConflicts( args: GetMergeConflictsCommandInput, cb: (err: any, data?: GetMergeConflictsCommandOutput) => void ): void; - public getMergeConflicts( + getMergeConflicts( args: GetMergeConflictsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMergeConflictsCommandOutput) => void ): void; - public getMergeConflicts( - args: GetMergeConflictsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMergeConflictsCommandOutput) => void), - cb?: (err: any, data?: GetMergeConflictsCommandOutput) => void - ): Promise | void { - const command = new GetMergeConflictsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the merge options available for merging two specified - * branches. For details about why a merge option is not available, use GetMergeConflicts - * or DescribeMergeConflicts.

- */ - public getMergeOptions( + + /** + * @see {@link GetMergeOptionsCommand} + */ + getMergeOptions( args: GetMergeOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMergeOptions( - args: GetMergeOptionsCommandInput, - cb: (err: any, data?: GetMergeOptionsCommandOutput) => void - ): void; - public getMergeOptions( + getMergeOptions(args: GetMergeOptionsCommandInput, cb: (err: any, data?: GetMergeOptionsCommandOutput) => void): void; + getMergeOptions( args: GetMergeOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMergeOptionsCommandOutput) => void ): void; - public getMergeOptions( - args: GetMergeOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMergeOptionsCommandOutput) => void), - cb?: (err: any, data?: GetMergeOptionsCommandOutput) => void - ): Promise | void { - const command = new GetMergeOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a pull request in a specified repository.

- */ - public getPullRequest( + + /** + * @see {@link GetPullRequestCommand} + */ + getPullRequest( args: GetPullRequestCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPullRequest( - args: GetPullRequestCommandInput, - cb: (err: any, data?: GetPullRequestCommandOutput) => void - ): void; - public getPullRequest( + getPullRequest(args: GetPullRequestCommandInput, cb: (err: any, data?: GetPullRequestCommandOutput) => void): void; + getPullRequest( args: GetPullRequestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPullRequestCommandOutput) => void ): void; - public getPullRequest( - args: GetPullRequestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPullRequestCommandOutput) => void), - cb?: (err: any, data?: GetPullRequestCommandOutput) => void - ): Promise | void { - const command = new GetPullRequestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the approval states for a specified pull request. Approval states only apply to pull requests that have one or more - * approval rules applied to them.

- */ - public getPullRequestApprovalStates( + + /** + * @see {@link GetPullRequestApprovalStatesCommand} + */ + getPullRequestApprovalStates( args: GetPullRequestApprovalStatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPullRequestApprovalStates( + getPullRequestApprovalStates( args: GetPullRequestApprovalStatesCommandInput, cb: (err: any, data?: GetPullRequestApprovalStatesCommandOutput) => void ): void; - public getPullRequestApprovalStates( + getPullRequestApprovalStates( args: GetPullRequestApprovalStatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPullRequestApprovalStatesCommandOutput) => void ): void; - public getPullRequestApprovalStates( - args: GetPullRequestApprovalStatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPullRequestApprovalStatesCommandOutput) => void), - cb?: (err: any, data?: GetPullRequestApprovalStatesCommandOutput) => void - ): Promise | void { - const command = new GetPullRequestApprovalStatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about whether approval rules have been set aside (overridden) for a - * pull request, and if so, the Amazon Resource Name (ARN) of the user or identity that overrode the rules and their requirements for the pull request.

- */ - public getPullRequestOverrideState( + + /** + * @see {@link GetPullRequestOverrideStateCommand} + */ + getPullRequestOverrideState( args: GetPullRequestOverrideStateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPullRequestOverrideState( + getPullRequestOverrideState( args: GetPullRequestOverrideStateCommandInput, cb: (err: any, data?: GetPullRequestOverrideStateCommandOutput) => void ): void; - public getPullRequestOverrideState( + getPullRequestOverrideState( args: GetPullRequestOverrideStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPullRequestOverrideStateCommandOutput) => void ): void; - public getPullRequestOverrideState( - args: GetPullRequestOverrideStateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPullRequestOverrideStateCommandOutput) => void), - cb?: (err: any, data?: GetPullRequestOverrideStateCommandOutput) => void - ): Promise | void { - const command = new GetPullRequestOverrideStateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a repository.

- * - * - *

The description field for a repository accepts all HTML characters and all valid - * Unicode characters. Applications that do not HTML-encode the description and display - * it in a webpage can expose users to potentially malicious code. Make sure that you - * HTML-encode the description field in any application that uses this API to display - * the repository description on a webpage.

- *
- */ - public getRepository( - args: GetRepositoryCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getRepository( - args: GetRepositoryCommandInput, - cb: (err: any, data?: GetRepositoryCommandOutput) => void - ): void; - public getRepository( + + /** + * @see {@link GetRepositoryCommand} + */ + getRepository(args: GetRepositoryCommandInput, options?: __HttpHandlerOptions): Promise; + getRepository(args: GetRepositoryCommandInput, cb: (err: any, data?: GetRepositoryCommandOutput) => void): void; + getRepository( args: GetRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRepositoryCommandOutput) => void ): void; - public getRepository( - args: GetRepositoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRepositoryCommandOutput) => void), - cb?: (err: any, data?: GetRepositoryCommandOutput) => void - ): Promise | void { - const command = new GetRepositoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about triggers configured for a repository.

- */ - public getRepositoryTriggers( + + /** + * @see {@link GetRepositoryTriggersCommand} + */ + getRepositoryTriggers( args: GetRepositoryTriggersCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRepositoryTriggers( + getRepositoryTriggers( args: GetRepositoryTriggersCommandInput, cb: (err: any, data?: GetRepositoryTriggersCommandOutput) => void ): void; - public getRepositoryTriggers( + getRepositoryTriggers( args: GetRepositoryTriggersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRepositoryTriggersCommandOutput) => void ): void; - public getRepositoryTriggers( - args: GetRepositoryTriggersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRepositoryTriggersCommandOutput) => void), - cb?: (err: any, data?: GetRepositoryTriggersCommandOutput) => void - ): Promise | void { - const command = new GetRepositoryTriggersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all approval rule templates in the specified AWS Region in your AWS account. If - * an AWS Region is not specified, the AWS Region where you are signed in is used.

- */ - public listApprovalRuleTemplates( + + /** + * @see {@link ListApprovalRuleTemplatesCommand} + */ + listApprovalRuleTemplates( args: ListApprovalRuleTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApprovalRuleTemplates( + listApprovalRuleTemplates( args: ListApprovalRuleTemplatesCommandInput, cb: (err: any, data?: ListApprovalRuleTemplatesCommandOutput) => void ): void; - public listApprovalRuleTemplates( + listApprovalRuleTemplates( args: ListApprovalRuleTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApprovalRuleTemplatesCommandOutput) => void ): void; - public listApprovalRuleTemplates( - args: ListApprovalRuleTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApprovalRuleTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListApprovalRuleTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListApprovalRuleTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all approval rule templates that are associated with a specified repository.

- */ - public listAssociatedApprovalRuleTemplatesForRepository( + + /** + * @see {@link ListAssociatedApprovalRuleTemplatesForRepositoryCommand} + */ + listAssociatedApprovalRuleTemplatesForRepository( args: ListAssociatedApprovalRuleTemplatesForRepositoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssociatedApprovalRuleTemplatesForRepository( + listAssociatedApprovalRuleTemplatesForRepository( args: ListAssociatedApprovalRuleTemplatesForRepositoryCommandInput, cb: (err: any, data?: ListAssociatedApprovalRuleTemplatesForRepositoryCommandOutput) => void ): void; - public listAssociatedApprovalRuleTemplatesForRepository( + listAssociatedApprovalRuleTemplatesForRepository( args: ListAssociatedApprovalRuleTemplatesForRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssociatedApprovalRuleTemplatesForRepositoryCommandOutput) => void ): void; - public listAssociatedApprovalRuleTemplatesForRepository( - args: ListAssociatedApprovalRuleTemplatesForRepositoryCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListAssociatedApprovalRuleTemplatesForRepositoryCommandOutput) => void), - cb?: (err: any, data?: ListAssociatedApprovalRuleTemplatesForRepositoryCommandOutput) => void - ): Promise | void { - const command = new ListAssociatedApprovalRuleTemplatesForRepositoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about one or more branches in a repository.

- */ - public listBranches( - args: ListBranchesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listBranches(args: ListBranchesCommandInput, cb: (err: any, data?: ListBranchesCommandOutput) => void): void; - public listBranches( + + /** + * @see {@link ListBranchesCommand} + */ + listBranches(args: ListBranchesCommandInput, options?: __HttpHandlerOptions): Promise; + listBranches(args: ListBranchesCommandInput, cb: (err: any, data?: ListBranchesCommandOutput) => void): void; + listBranches( args: ListBranchesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBranchesCommandOutput) => void ): void; - public listBranches( - args: ListBranchesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBranchesCommandOutput) => void), - cb?: (err: any, data?: ListBranchesCommandOutput) => void - ): Promise | void { - const command = new ListBranchesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of pull requests for a specified repository. The return list can be refined by pull request - * status or pull request author ARN.

- */ - public listPullRequests( + + /** + * @see {@link ListPullRequestsCommand} + */ + listPullRequests( args: ListPullRequestsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPullRequests( + listPullRequests( args: ListPullRequestsCommandInput, cb: (err: any, data?: ListPullRequestsCommandOutput) => void ): void; - public listPullRequests( + listPullRequests( args: ListPullRequestsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPullRequestsCommandOutput) => void ): void; - public listPullRequests( - args: ListPullRequestsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPullRequestsCommandOutput) => void), - cb?: (err: any, data?: ListPullRequestsCommandOutput) => void - ): Promise | void { - const command = new ListPullRequestsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about one or more repositories.

- */ - public listRepositories( + + /** + * @see {@link ListRepositoriesCommand} + */ + listRepositories( args: ListRepositoriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRepositories( + listRepositories( args: ListRepositoriesCommandInput, cb: (err: any, data?: ListRepositoriesCommandOutput) => void ): void; - public listRepositories( + listRepositories( args: ListRepositoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRepositoriesCommandOutput) => void ): void; - public listRepositories( - args: ListRepositoriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRepositoriesCommandOutput) => void), - cb?: (err: any, data?: ListRepositoriesCommandOutput) => void - ): Promise | void { - const command = new ListRepositoriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all repositories associated with the specified approval rule template.

- */ - public listRepositoriesForApprovalRuleTemplate( + + /** + * @see {@link ListRepositoriesForApprovalRuleTemplateCommand} + */ + listRepositoriesForApprovalRuleTemplate( args: ListRepositoriesForApprovalRuleTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRepositoriesForApprovalRuleTemplate( + listRepositoriesForApprovalRuleTemplate( args: ListRepositoriesForApprovalRuleTemplateCommandInput, cb: (err: any, data?: ListRepositoriesForApprovalRuleTemplateCommandOutput) => void ): void; - public listRepositoriesForApprovalRuleTemplate( + listRepositoriesForApprovalRuleTemplate( args: ListRepositoriesForApprovalRuleTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRepositoriesForApprovalRuleTemplateCommandOutput) => void ): void; - public listRepositoriesForApprovalRuleTemplate( - args: ListRepositoriesForApprovalRuleTemplateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListRepositoriesForApprovalRuleTemplateCommandOutput) => void), - cb?: (err: any, data?: ListRepositoriesForApprovalRuleTemplateCommandOutput) => void - ): Promise | void { - const command = new ListRepositoriesForApprovalRuleTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS - * CodeCommit. For a list of valid resources in AWS CodeCommit, see CodeCommit Resources and Operations in the AWS CodeCommit User - * Guide.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Merges two branches using the fast-forward merge strategy.

- */ - public mergeBranchesByFastForward( + + /** + * @see {@link MergeBranchesByFastForwardCommand} + */ + mergeBranchesByFastForward( args: MergeBranchesByFastForwardCommandInput, options?: __HttpHandlerOptions ): Promise; - public mergeBranchesByFastForward( + mergeBranchesByFastForward( args: MergeBranchesByFastForwardCommandInput, cb: (err: any, data?: MergeBranchesByFastForwardCommandOutput) => void ): void; - public mergeBranchesByFastForward( + mergeBranchesByFastForward( args: MergeBranchesByFastForwardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MergeBranchesByFastForwardCommandOutput) => void ): void; - public mergeBranchesByFastForward( - args: MergeBranchesByFastForwardCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MergeBranchesByFastForwardCommandOutput) => void), - cb?: (err: any, data?: MergeBranchesByFastForwardCommandOutput) => void - ): Promise | void { - const command = new MergeBranchesByFastForwardCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Merges two branches using the squash merge strategy.

- */ - public mergeBranchesBySquash( + + /** + * @see {@link MergeBranchesBySquashCommand} + */ + mergeBranchesBySquash( args: MergeBranchesBySquashCommandInput, options?: __HttpHandlerOptions ): Promise; - public mergeBranchesBySquash( + mergeBranchesBySquash( args: MergeBranchesBySquashCommandInput, cb: (err: any, data?: MergeBranchesBySquashCommandOutput) => void ): void; - public mergeBranchesBySquash( + mergeBranchesBySquash( args: MergeBranchesBySquashCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MergeBranchesBySquashCommandOutput) => void ): void; - public mergeBranchesBySquash( - args: MergeBranchesBySquashCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MergeBranchesBySquashCommandOutput) => void), - cb?: (err: any, data?: MergeBranchesBySquashCommandOutput) => void - ): Promise | void { - const command = new MergeBranchesBySquashCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Merges two specified branches using the three-way merge strategy.

- */ - public mergeBranchesByThreeWay( + + /** + * @see {@link MergeBranchesByThreeWayCommand} + */ + mergeBranchesByThreeWay( args: MergeBranchesByThreeWayCommandInput, options?: __HttpHandlerOptions ): Promise; - public mergeBranchesByThreeWay( + mergeBranchesByThreeWay( args: MergeBranchesByThreeWayCommandInput, cb: (err: any, data?: MergeBranchesByThreeWayCommandOutput) => void ): void; - public mergeBranchesByThreeWay( + mergeBranchesByThreeWay( args: MergeBranchesByThreeWayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MergeBranchesByThreeWayCommandOutput) => void ): void; - public mergeBranchesByThreeWay( - args: MergeBranchesByThreeWayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MergeBranchesByThreeWayCommandOutput) => void), - cb?: (err: any, data?: MergeBranchesByThreeWayCommandOutput) => void - ): Promise | void { - const command = new MergeBranchesByThreeWayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attempts to merge the source commit of a pull request into the specified destination - * branch for that pull request at the specified commit using the fast-forward merge strategy. If the merge is successful, it closes the pull request.

- */ - public mergePullRequestByFastForward( + + /** + * @see {@link MergePullRequestByFastForwardCommand} + */ + mergePullRequestByFastForward( args: MergePullRequestByFastForwardCommandInput, options?: __HttpHandlerOptions ): Promise; - public mergePullRequestByFastForward( + mergePullRequestByFastForward( args: MergePullRequestByFastForwardCommandInput, cb: (err: any, data?: MergePullRequestByFastForwardCommandOutput) => void ): void; - public mergePullRequestByFastForward( + mergePullRequestByFastForward( args: MergePullRequestByFastForwardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MergePullRequestByFastForwardCommandOutput) => void ): void; - public mergePullRequestByFastForward( - args: MergePullRequestByFastForwardCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MergePullRequestByFastForwardCommandOutput) => void), - cb?: (err: any, data?: MergePullRequestByFastForwardCommandOutput) => void - ): Promise | void { - const command = new MergePullRequestByFastForwardCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attempts to merge the source commit of a pull request into the specified destination - * branch for that pull request at the specified commit using the squash merge strategy. If the merge is successful, it closes the pull request.

- */ - public mergePullRequestBySquash( + + /** + * @see {@link MergePullRequestBySquashCommand} + */ + mergePullRequestBySquash( args: MergePullRequestBySquashCommandInput, options?: __HttpHandlerOptions ): Promise; - public mergePullRequestBySquash( + mergePullRequestBySquash( args: MergePullRequestBySquashCommandInput, cb: (err: any, data?: MergePullRequestBySquashCommandOutput) => void ): void; - public mergePullRequestBySquash( + mergePullRequestBySquash( args: MergePullRequestBySquashCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MergePullRequestBySquashCommandOutput) => void ): void; - public mergePullRequestBySquash( - args: MergePullRequestBySquashCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MergePullRequestBySquashCommandOutput) => void), - cb?: (err: any, data?: MergePullRequestBySquashCommandOutput) => void - ): Promise | void { - const command = new MergePullRequestBySquashCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attempts to merge the source commit of a pull request into the specified destination - * branch for that pull request at the specified commit using the three-way merge strategy. If the merge is successful, it closes the pull request.

- */ - public mergePullRequestByThreeWay( + + /** + * @see {@link MergePullRequestByThreeWayCommand} + */ + mergePullRequestByThreeWay( args: MergePullRequestByThreeWayCommandInput, options?: __HttpHandlerOptions ): Promise; - public mergePullRequestByThreeWay( + mergePullRequestByThreeWay( args: MergePullRequestByThreeWayCommandInput, cb: (err: any, data?: MergePullRequestByThreeWayCommandOutput) => void ): void; - public mergePullRequestByThreeWay( + mergePullRequestByThreeWay( args: MergePullRequestByThreeWayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MergePullRequestByThreeWayCommandOutput) => void ): void; - public mergePullRequestByThreeWay( - args: MergePullRequestByThreeWayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MergePullRequestByThreeWayCommandOutput) => void), - cb?: (err: any, data?: MergePullRequestByThreeWayCommandOutput) => void - ): Promise | void { - const command = new MergePullRequestByThreeWayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets aside (overrides) all approval rule requirements for a specified pull request.

- */ - public overridePullRequestApprovalRules( + + /** + * @see {@link OverridePullRequestApprovalRulesCommand} + */ + overridePullRequestApprovalRules( args: OverridePullRequestApprovalRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public overridePullRequestApprovalRules( + overridePullRequestApprovalRules( args: OverridePullRequestApprovalRulesCommandInput, cb: (err: any, data?: OverridePullRequestApprovalRulesCommandOutput) => void ): void; - public overridePullRequestApprovalRules( + overridePullRequestApprovalRules( args: OverridePullRequestApprovalRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: OverridePullRequestApprovalRulesCommandOutput) => void ): void; - public overridePullRequestApprovalRules( - args: OverridePullRequestApprovalRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: OverridePullRequestApprovalRulesCommandOutput) => void), - cb?: (err: any, data?: OverridePullRequestApprovalRulesCommandOutput) => void - ): Promise | void { - const command = new OverridePullRequestApprovalRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Posts a comment on the comparison between two commits.

- */ - public postCommentForComparedCommit( + + /** + * @see {@link PostCommentForComparedCommitCommand} + */ + postCommentForComparedCommit( args: PostCommentForComparedCommitCommandInput, options?: __HttpHandlerOptions ): Promise; - public postCommentForComparedCommit( + postCommentForComparedCommit( args: PostCommentForComparedCommitCommandInput, cb: (err: any, data?: PostCommentForComparedCommitCommandOutput) => void ): void; - public postCommentForComparedCommit( + postCommentForComparedCommit( args: PostCommentForComparedCommitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PostCommentForComparedCommitCommandOutput) => void ): void; - public postCommentForComparedCommit( - args: PostCommentForComparedCommitCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PostCommentForComparedCommitCommandOutput) => void), - cb?: (err: any, data?: PostCommentForComparedCommitCommandOutput) => void - ): Promise | void { - const command = new PostCommentForComparedCommitCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Posts a comment on a pull request.

- */ - public postCommentForPullRequest( + + /** + * @see {@link PostCommentForPullRequestCommand} + */ + postCommentForPullRequest( args: PostCommentForPullRequestCommandInput, options?: __HttpHandlerOptions ): Promise; - public postCommentForPullRequest( + postCommentForPullRequest( args: PostCommentForPullRequestCommandInput, cb: (err: any, data?: PostCommentForPullRequestCommandOutput) => void ): void; - public postCommentForPullRequest( + postCommentForPullRequest( args: PostCommentForPullRequestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PostCommentForPullRequestCommandOutput) => void ): void; - public postCommentForPullRequest( - args: PostCommentForPullRequestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PostCommentForPullRequestCommandOutput) => void), - cb?: (err: any, data?: PostCommentForPullRequestCommandOutput) => void - ): Promise | void { - const command = new PostCommentForPullRequestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Posts a comment in reply to an existing comment on a comparison between commits or a pull request.

- */ - public postCommentReply( + + /** + * @see {@link PostCommentReplyCommand} + */ + postCommentReply( args: PostCommentReplyCommandInput, options?: __HttpHandlerOptions ): Promise; - public postCommentReply( + postCommentReply( args: PostCommentReplyCommandInput, cb: (err: any, data?: PostCommentReplyCommandOutput) => void ): void; - public postCommentReply( + postCommentReply( args: PostCommentReplyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PostCommentReplyCommandOutput) => void ): void; - public postCommentReply( - args: PostCommentReplyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PostCommentReplyCommandOutput) => void), - cb?: (err: any, data?: PostCommentReplyCommandOutput) => void - ): Promise | void { - const command = new PostCommentReplyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds or updates a reaction to a specified comment for the user whose identity is used to make the request. You can only add or - * update a reaction for yourself. You cannot add, modify, or delete a reaction for another user.

- */ - public putCommentReaction( + + /** + * @see {@link PutCommentReactionCommand} + */ + putCommentReaction( args: PutCommentReactionCommandInput, options?: __HttpHandlerOptions ): Promise; - public putCommentReaction( + putCommentReaction( args: PutCommentReactionCommandInput, cb: (err: any, data?: PutCommentReactionCommandOutput) => void ): void; - public putCommentReaction( + putCommentReaction( args: PutCommentReactionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutCommentReactionCommandOutput) => void ): void; - public putCommentReaction( - args: PutCommentReactionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutCommentReactionCommandOutput) => void), - cb?: (err: any, data?: PutCommentReactionCommandOutput) => void - ): Promise | void { - const command = new PutCommentReactionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds or updates a file in a branch in an AWS CodeCommit repository, and generates a commit for the addition in the specified branch.

- */ - public putFile(args: PutFileCommandInput, options?: __HttpHandlerOptions): Promise; - public putFile(args: PutFileCommandInput, cb: (err: any, data?: PutFileCommandOutput) => void): void; - public putFile( + + /** + * @see {@link PutFileCommand} + */ + putFile(args: PutFileCommandInput, options?: __HttpHandlerOptions): Promise; + putFile(args: PutFileCommandInput, cb: (err: any, data?: PutFileCommandOutput) => void): void; + putFile( args: PutFileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutFileCommandOutput) => void ): void; - public putFile( - args: PutFileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutFileCommandOutput) => void), - cb?: (err: any, data?: PutFileCommandOutput) => void - ): Promise | void { - const command = new PutFileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Replaces all triggers for a repository. Used to create or delete triggers.

- */ - public putRepositoryTriggers( + + /** + * @see {@link PutRepositoryTriggersCommand} + */ + putRepositoryTriggers( args: PutRepositoryTriggersCommandInput, options?: __HttpHandlerOptions ): Promise; - public putRepositoryTriggers( + putRepositoryTriggers( args: PutRepositoryTriggersCommandInput, cb: (err: any, data?: PutRepositoryTriggersCommandOutput) => void ): void; - public putRepositoryTriggers( + putRepositoryTriggers( args: PutRepositoryTriggersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRepositoryTriggersCommandOutput) => void ): void; - public putRepositoryTriggers( - args: PutRepositoryTriggersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRepositoryTriggersCommandOutput) => void), - cb?: (err: any, data?: PutRepositoryTriggersCommandOutput) => void - ): Promise | void { - const command = new PutRepositoryTriggersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds or updates tags for a resource in AWS CodeCommit. For a list of valid resources - * in AWS CodeCommit, see CodeCommit Resources and Operations in the AWS CodeCommit User - * Guide.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Tests the functionality of repository triggers by sending information to the trigger - * target. If real data is available in the repository, the test sends data from the last - * commit. If no data is available, sample data is generated.

- */ - public testRepositoryTriggers( + + /** + * @see {@link TestRepositoryTriggersCommand} + */ + testRepositoryTriggers( args: TestRepositoryTriggersCommandInput, options?: __HttpHandlerOptions ): Promise; - public testRepositoryTriggers( + testRepositoryTriggers( args: TestRepositoryTriggersCommandInput, cb: (err: any, data?: TestRepositoryTriggersCommandOutput) => void ): void; - public testRepositoryTriggers( + testRepositoryTriggers( args: TestRepositoryTriggersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestRepositoryTriggersCommandOutput) => void ): void; - public testRepositoryTriggers( - args: TestRepositoryTriggersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestRepositoryTriggersCommandOutput) => void), - cb?: (err: any, data?: TestRepositoryTriggersCommandOutput) => void - ): Promise | void { - const command = new TestRepositoryTriggersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes tags for a resource in AWS CodeCommit. For a list of valid resources in AWS - * CodeCommit, see CodeCommit Resources and Operations in the AWS CodeCommit User - * Guide.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the content of an approval rule template. You can change the number of - * required approvals, the membership of the approval rule, and whether an approval pool is - * defined.

- */ - public updateApprovalRuleTemplateContent( + + /** + * @see {@link UpdateApprovalRuleTemplateContentCommand} + */ + updateApprovalRuleTemplateContent( args: UpdateApprovalRuleTemplateContentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApprovalRuleTemplateContent( + updateApprovalRuleTemplateContent( args: UpdateApprovalRuleTemplateContentCommandInput, cb: (err: any, data?: UpdateApprovalRuleTemplateContentCommandOutput) => void ): void; - public updateApprovalRuleTemplateContent( + updateApprovalRuleTemplateContent( args: UpdateApprovalRuleTemplateContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApprovalRuleTemplateContentCommandOutput) => void ): void; - public updateApprovalRuleTemplateContent( - args: UpdateApprovalRuleTemplateContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApprovalRuleTemplateContentCommandOutput) => void), - cb?: (err: any, data?: UpdateApprovalRuleTemplateContentCommandOutput) => void - ): Promise | void { - const command = new UpdateApprovalRuleTemplateContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the description for a specified approval rule template.

- */ - public updateApprovalRuleTemplateDescription( + + /** + * @see {@link UpdateApprovalRuleTemplateDescriptionCommand} + */ + updateApprovalRuleTemplateDescription( args: UpdateApprovalRuleTemplateDescriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApprovalRuleTemplateDescription( + updateApprovalRuleTemplateDescription( args: UpdateApprovalRuleTemplateDescriptionCommandInput, cb: (err: any, data?: UpdateApprovalRuleTemplateDescriptionCommandOutput) => void ): void; - public updateApprovalRuleTemplateDescription( + updateApprovalRuleTemplateDescription( args: UpdateApprovalRuleTemplateDescriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApprovalRuleTemplateDescriptionCommandOutput) => void ): void; - public updateApprovalRuleTemplateDescription( - args: UpdateApprovalRuleTemplateDescriptionCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateApprovalRuleTemplateDescriptionCommandOutput) => void), - cb?: (err: any, data?: UpdateApprovalRuleTemplateDescriptionCommandOutput) => void - ): Promise | void { - const command = new UpdateApprovalRuleTemplateDescriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the name of a specified approval rule template.

- */ - public updateApprovalRuleTemplateName( + + /** + * @see {@link UpdateApprovalRuleTemplateNameCommand} + */ + updateApprovalRuleTemplateName( args: UpdateApprovalRuleTemplateNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApprovalRuleTemplateName( + updateApprovalRuleTemplateName( args: UpdateApprovalRuleTemplateNameCommandInput, cb: (err: any, data?: UpdateApprovalRuleTemplateNameCommandOutput) => void ): void; - public updateApprovalRuleTemplateName( + updateApprovalRuleTemplateName( args: UpdateApprovalRuleTemplateNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApprovalRuleTemplateNameCommandOutput) => void ): void; - public updateApprovalRuleTemplateName( - args: UpdateApprovalRuleTemplateNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApprovalRuleTemplateNameCommandOutput) => void), - cb?: (err: any, data?: UpdateApprovalRuleTemplateNameCommandOutput) => void - ): Promise | void { - const command = new UpdateApprovalRuleTemplateNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Replaces the contents of a comment.

- */ - public updateComment( - args: UpdateCommentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateComment( - args: UpdateCommentCommandInput, - cb: (err: any, data?: UpdateCommentCommandOutput) => void - ): void; - public updateComment( + + /** + * @see {@link UpdateCommentCommand} + */ + updateComment(args: UpdateCommentCommandInput, options?: __HttpHandlerOptions): Promise; + updateComment(args: UpdateCommentCommandInput, cb: (err: any, data?: UpdateCommentCommandOutput) => void): void; + updateComment( args: UpdateCommentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCommentCommandOutput) => void ): void; - public updateComment( - args: UpdateCommentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCommentCommandOutput) => void), - cb?: (err: any, data?: UpdateCommentCommandOutput) => void - ): Promise | void { - const command = new UpdateCommentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets or changes the default branch name for the specified repository.

- * - *

If you use this operation to change the default branch name to the current default branch name, a success message is returned even though the default branch did not change.

- *
- */ - public updateDefaultBranch( + + /** + * @see {@link UpdateDefaultBranchCommand} + */ + updateDefaultBranch( args: UpdateDefaultBranchCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDefaultBranch( + updateDefaultBranch( args: UpdateDefaultBranchCommandInput, cb: (err: any, data?: UpdateDefaultBranchCommandOutput) => void ): void; - public updateDefaultBranch( + updateDefaultBranch( args: UpdateDefaultBranchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDefaultBranchCommandOutput) => void ): void; - public updateDefaultBranch( - args: UpdateDefaultBranchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDefaultBranchCommandOutput) => void), - cb?: (err: any, data?: UpdateDefaultBranchCommandOutput) => void - ): Promise | void { - const command = new UpdateDefaultBranchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the structure of an approval rule created specifically for a pull request. For example, you can change the number of required approvers and - * the approval pool for approvers.

- */ - public updatePullRequestApprovalRuleContent( + + /** + * @see {@link UpdatePullRequestApprovalRuleContentCommand} + */ + updatePullRequestApprovalRuleContent( args: UpdatePullRequestApprovalRuleContentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePullRequestApprovalRuleContent( + updatePullRequestApprovalRuleContent( args: UpdatePullRequestApprovalRuleContentCommandInput, cb: (err: any, data?: UpdatePullRequestApprovalRuleContentCommandOutput) => void ): void; - public updatePullRequestApprovalRuleContent( + updatePullRequestApprovalRuleContent( args: UpdatePullRequestApprovalRuleContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePullRequestApprovalRuleContentCommandOutput) => void ): void; - public updatePullRequestApprovalRuleContent( - args: UpdatePullRequestApprovalRuleContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePullRequestApprovalRuleContentCommandOutput) => void), - cb?: (err: any, data?: UpdatePullRequestApprovalRuleContentCommandOutput) => void - ): Promise | void { - const command = new UpdatePullRequestApprovalRuleContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the state of a user's approval on a pull request. The user is derived from the signed-in account when the request is made.

- */ - public updatePullRequestApprovalState( + + /** + * @see {@link UpdatePullRequestApprovalStateCommand} + */ + updatePullRequestApprovalState( args: UpdatePullRequestApprovalStateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePullRequestApprovalState( + updatePullRequestApprovalState( args: UpdatePullRequestApprovalStateCommandInput, cb: (err: any, data?: UpdatePullRequestApprovalStateCommandOutput) => void ): void; - public updatePullRequestApprovalState( + updatePullRequestApprovalState( args: UpdatePullRequestApprovalStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePullRequestApprovalStateCommandOutput) => void ): void; - public updatePullRequestApprovalState( - args: UpdatePullRequestApprovalStateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePullRequestApprovalStateCommandOutput) => void), - cb?: (err: any, data?: UpdatePullRequestApprovalStateCommandOutput) => void - ): Promise | void { - const command = new UpdatePullRequestApprovalStateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Replaces the contents of the description of a pull request.

- */ - public updatePullRequestDescription( + + /** + * @see {@link UpdatePullRequestDescriptionCommand} + */ + updatePullRequestDescription( args: UpdatePullRequestDescriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePullRequestDescription( + updatePullRequestDescription( args: UpdatePullRequestDescriptionCommandInput, cb: (err: any, data?: UpdatePullRequestDescriptionCommandOutput) => void ): void; - public updatePullRequestDescription( + updatePullRequestDescription( args: UpdatePullRequestDescriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePullRequestDescriptionCommandOutput) => void ): void; - public updatePullRequestDescription( - args: UpdatePullRequestDescriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePullRequestDescriptionCommandOutput) => void), - cb?: (err: any, data?: UpdatePullRequestDescriptionCommandOutput) => void - ): Promise | void { - const command = new UpdatePullRequestDescriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the status of a pull request.

- */ - public updatePullRequestStatus( + + /** + * @see {@link UpdatePullRequestStatusCommand} + */ + updatePullRequestStatus( args: UpdatePullRequestStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePullRequestStatus( + updatePullRequestStatus( args: UpdatePullRequestStatusCommandInput, cb: (err: any, data?: UpdatePullRequestStatusCommandOutput) => void ): void; - public updatePullRequestStatus( + updatePullRequestStatus( args: UpdatePullRequestStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePullRequestStatusCommandOutput) => void ): void; - public updatePullRequestStatus( - args: UpdatePullRequestStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePullRequestStatusCommandOutput) => void), - cb?: (err: any, data?: UpdatePullRequestStatusCommandOutput) => void - ): Promise | void { - const command = new UpdatePullRequestStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Replaces the title of a pull request.

- */ - public updatePullRequestTitle( + + /** + * @see {@link UpdatePullRequestTitleCommand} + */ + updatePullRequestTitle( args: UpdatePullRequestTitleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePullRequestTitle( + updatePullRequestTitle( args: UpdatePullRequestTitleCommandInput, cb: (err: any, data?: UpdatePullRequestTitleCommandOutput) => void ): void; - public updatePullRequestTitle( + updatePullRequestTitle( args: UpdatePullRequestTitleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePullRequestTitleCommandOutput) => void ): void; - public updatePullRequestTitle( - args: UpdatePullRequestTitleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePullRequestTitleCommandOutput) => void), - cb?: (err: any, data?: UpdatePullRequestTitleCommandOutput) => void - ): Promise | void { - const command = new UpdatePullRequestTitleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets or changes the comment or description for a repository.

- * - *

The description field for a repository accepts all HTML characters and all valid - * Unicode characters. Applications that do not HTML-encode the description and display - * it in a webpage can expose users to potentially malicious code. Make sure that you - * HTML-encode the description field in any application that uses this API to display - * the repository description on a webpage.

- *
- */ - public updateRepositoryDescription( + + /** + * @see {@link UpdateRepositoryDescriptionCommand} + */ + updateRepositoryDescription( args: UpdateRepositoryDescriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRepositoryDescription( + updateRepositoryDescription( args: UpdateRepositoryDescriptionCommandInput, cb: (err: any, data?: UpdateRepositoryDescriptionCommandOutput) => void ): void; - public updateRepositoryDescription( + updateRepositoryDescription( args: UpdateRepositoryDescriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRepositoryDescriptionCommandOutput) => void ): void; - public updateRepositoryDescription( - args: UpdateRepositoryDescriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRepositoryDescriptionCommandOutput) => void), - cb?: (err: any, data?: UpdateRepositoryDescriptionCommandOutput) => void - ): Promise | void { - const command = new UpdateRepositoryDescriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Renames a repository. The repository name must be unique across the calling AWS - * account. Repository names are limited to 100 alphanumeric, dash, and underscore - * characters, and cannot include certain characters. The suffix .git is prohibited. For - * more information about the limits on repository names, see Limits in the AWS CodeCommit - * User Guide.

- */ - public updateRepositoryName( + + /** + * @see {@link UpdateRepositoryNameCommand} + */ + updateRepositoryName( args: UpdateRepositoryNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRepositoryName( + updateRepositoryName( args: UpdateRepositoryNameCommandInput, cb: (err: any, data?: UpdateRepositoryNameCommandOutput) => void ): void; - public updateRepositoryName( + updateRepositoryName( args: UpdateRepositoryNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRepositoryNameCommandOutput) => void ): void; - public updateRepositoryName( - args: UpdateRepositoryNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRepositoryNameCommandOutput) => void), - cb?: (err: any, data?: UpdateRepositoryNameCommandOutput) => void - ): Promise | void { - const command = new UpdateRepositoryNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * AWS CodeCommit + *

This is the AWS CodeCommit API Reference. This reference provides descriptions of the operations and data types for + * AWS CodeCommit API along with usage examples.

+ *

You can use the AWS CodeCommit API to work with the following objects:

+ * + *

Repositories, by calling the following:

+ *
    + *
  • + *

    + * BatchGetRepositories, which returns information about one or more repositories associated with your AWS account.

    + *
  • + *
  • + *

    + * CreateRepository, which creates an AWS CodeCommit repository.

    + *
  • + *
  • + *

    + * DeleteRepository, which deletes an AWS CodeCommit repository.

    + *
  • + *
  • + *

    + * GetRepository, which returns information about a specified repository.

    + *
  • + *
  • + *

    + * ListRepositories, which lists all AWS CodeCommit repositories associated with your AWS account.

    + *
  • + *
  • + *

    + * UpdateRepositoryDescription, which sets or updates the description of the repository.

    + *
  • + *
  • + *

    + * UpdateRepositoryName, which changes the name of the + * repository. If you change the name of a repository, no other users of that + * repository can access it until you send them the new HTTPS or SSH URL to + * use.

    + *
  • + *
+ * + *

Branches, by calling the following:

+ *
    + *
  • + *

    + * CreateBranch, which creates a branch in a specified + * repository.

    + *
  • + *
  • + *

    + * DeleteBranch, which deletes the specified branch in a repository unless it is the default branch.

    + *
  • + *
  • + *

    + * GetBranch, which returns information about a specified branch.

    + *
  • + *
  • + *

    + * ListBranches, which lists all branches for a specified repository.

    + *
  • + *
  • + *

    + * UpdateDefaultBranch, which changes the default branch for a repository.

    + *
  • + *
+ * + *

Files, by calling the following:

+ *
    + *
  • + *

    + * DeleteFile, which deletes the content of a specified file from a specified branch.

    + *
  • + *
  • + *

    + * GetBlob, which returns the base-64 encoded content of an + * individual Git blob object in a repository.

    + *
  • + *
  • + *

    + * GetFile, which returns the base-64 encoded content of a specified file.

    + *
  • + *
  • + *

    + * GetFolder, which returns the contents of a specified folder or directory.

    + *
  • + *
  • + *

    + * PutFile, which adds or modifies a single file in a specified repository and branch.

    + *
  • + *
+ * + * + *

Commits, by calling the following:

+ *
    + *
  • + *

    + * BatchGetCommits, which returns information about one or more commits in a repository.

    + *
  • + *
  • + *

    + * CreateCommit, which creates a commit for changes to a repository.

    + *
  • + *
  • + *

    + * GetCommit, which returns information about a commit, including commit + * messages and author and committer information.

    + *
  • + *
  • + *

    + * GetDifferences, which returns information about the + * differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID, + * or other fully qualified reference).

    + *
  • + *
+ * + * + *

Merges, by calling the following:

+ *
    + *
  • + *

    + * BatchDescribeMergeConflicts, which returns information about conflicts in a merge between commits in a repository.

    + *
  • + *
  • + *

    + * CreateUnreferencedMergeCommit, which creates an unreferenced commit between two branches or commits for the + * purpose of comparing them and identifying any potential conflicts.

    + *
  • + *
  • + *

    + * DescribeMergeConflicts, which returns information about merge conflicts between the base, source, and destination versions + * of a file in a potential merge.

    + *
  • + *
  • + *

    + * GetMergeCommit, which returns information about the merge between a source and destination commit.

    + * + *
  • + *
  • + *

    + * GetMergeConflicts, which returns information about merge conflicts + * between the source and destination branch in a pull request.

    + *
  • + *
  • + * + *

    + * GetMergeOptions, which returns information about the available merge options between two branches or commit specifiers.

    + *
  • + *
  • + *

    + * MergeBranchesByFastForward, which merges two branches using the fast-forward merge option.

    + *
  • + *
  • + *

    + * MergeBranchesBySquash, which merges two branches using the squash merge option.

    + *
  • + *
  • + *

    + * MergeBranchesByThreeWay, which merges two branches using the three-way merge option.

    + *
  • + *
+ * + * + *

Pull requests, by calling the following:

+ *
    + *
  • + *

    + * CreatePullRequest, which creates a pull request in a specified repository.

    + *
  • + *
  • + *

    + * CreatePullRequestApprovalRule, which creates an approval rule for a specified pull request.

    + *
  • + *
  • + *

    + * DeletePullRequestApprovalRule, which deletes an approval rule for a specified pull request.

    + *
  • + *
  • + *

    + * DescribePullRequestEvents, which returns information about one or more pull request events.

    + *
  • + *
  • + *

    + * EvaluatePullRequestApprovalRules, which evaluates whether a pull request has met all the conditions specified in its associated approval rules.

    + *
  • + *
  • + *

    + * GetCommentsForPullRequest, which returns information about comments on a specified pull request.

    + *
  • + *
  • + * + *

    + * GetPullRequest, which returns information about a specified pull request.

    + *
  • + *
  • + *

    + * GetPullRequestApprovalStates, which returns information about the approval states for a specified pull request.

    + *
  • + *
  • + *

    + * GetPullRequestOverrideState, which returns information about whether approval rules have been set aside (overriden) for a + * pull request, and if so, the Amazon Resource Name (ARN) of the user or identity that overrode the rules and their requirements for the pull request.

    + *
  • + *
  • + *

    + * ListPullRequests, which lists all pull requests for a repository.

    + *
  • + *
  • + *

    + * MergePullRequestByFastForward, which merges the source destination branch of a pull request into the specified destination + * branch for that pull request using the fast-forward merge option.

    + *
  • + *
  • + *

    + * MergePullRequestBySquash, which merges the source destination branch of a pull request into the specified destination + * branch for that pull request using the squash merge option.

    + *
  • + *
  • + *

    + * MergePullRequestByThreeWay. which merges the source destination branch of a pull request into the specified destination + * branch for that pull request using the three-way merge option.

    + *
  • + *
  • + *

    + * OverridePullRequestApprovalRules, which sets aside all approval rule requirements for a pull request.

    + *
  • + *
  • + *

    + * PostCommentForPullRequest, which posts a comment to a pull request at the specified line, file, or request.

    + *
  • + *
  • + *

    + * UpdatePullRequestApprovalRuleContent, which updates the structure of an approval rule for a pull request.

    + *
  • + *
  • + *

    + * UpdatePullRequestApprovalState, which updates the state of an approval on a pull request.

    + *
  • + *
  • + *

    + * UpdatePullRequestDescription, which updates the description of a pull request.

    + *
  • + *
  • + *

    + * UpdatePullRequestStatus, which updates the status of a pull request.

    + *
  • + *
  • + *

    + * UpdatePullRequestTitle, which updates the title of a pull request.

    + *
  • + *
+ * + *

Approval rule templates, by calling the following:

+ *
    + *
  • + *

    + * AssociateApprovalRuleTemplateWithRepository, which associates a template + * with a specified repository. After the template is associated with a repository, + * AWS CodeCommit creates approval rules that match the template conditions on + * every pull request created in the specified repository.

    + *
  • + *
  • + *

    + * BatchAssociateApprovalRuleTemplateWithRepositories, which associates a + * template with one or more specified repositories. After the template is + * associated with a repository, AWS CodeCommit creates approval rules that match + * the template conditions on every pull request created in the specified + * repositories.

    + *
  • + *
  • + *

    + * BatchDisassociateApprovalRuleTemplateFromRepositories, which removes the + * association between a template and specified repositories so that approval rules + * based on the template are not automatically created when pull requests are + * created in those repositories.

    + *
  • + *
  • + *

    + * CreateApprovalRuleTemplate, which creates a template for approval rules that can then be associated with one or more repositories + * in your AWS account.

    + *
  • + *
  • + *

    + * DeleteApprovalRuleTemplate, which deletes the specified template. It does not remove approval rules on pull requests already created with the template.

    + *
  • + *
  • + *

    + * DisassociateApprovalRuleTemplateFromRepository, which removes the + * association between a template and a repository so that approval rules based on + * the template are not automatically created when pull requests are created in the + * specified repository.

    + *
  • + *
  • + *

    + * GetApprovalRuleTemplate, which returns information about an approval rule template.

    + *
  • + *
  • + *

    + * ListApprovalRuleTemplates, which lists all approval rule templates in the AWS Region in your AWS account.

    + *
  • + *
  • + *

    + * ListAssociatedApprovalRuleTemplatesForRepository, which lists all approval rule templates that are associated with a specified repository.

    + *
  • + *
  • + *

    + * ListRepositoriesForApprovalRuleTemplate, which lists all repositories associated with the specified approval rule template.

    + *
  • + *
  • + *

    + * UpdateApprovalRuleTemplateDescription, which updates the description of an + * approval rule template.

    + *
  • + *
  • + *

    + * UpdateApprovalRuleTemplateName, which updates the name of an approval rule template.

    + *
  • + *
  • + *

    + * UpdateApprovalRuleTemplateContent, which updates the content of an approval rule template.

    + *
  • + *
+ * + *

Comments in a repository, by calling the following:

+ *
    + *
  • + *

    + * DeleteCommentContent, which deletes the content of a comment on a commit in a repository.

    + *
  • + *
  • + *

    + * GetComment, which returns information about a comment on a commit.

    + *
  • + *
  • + *

    + * GetCommentReactions, which returns information about emoji reactions to comments.

    + *
  • + *
  • + *

    + * GetCommentsForComparedCommit, which returns information about comments on the comparison between two commit specifiers + * in a repository.

    + *
  • + *
  • + *

    + * PostCommentForComparedCommit, which creates a comment on the comparison between two commit specifiers in a repository.

    + *
  • + *
  • + *

    + * PostCommentReply, which creates a reply to a comment.

    + *
  • + *
  • + *

    + * PutCommentReaction, which creates or updates an emoji reaction to a comment.

    + *
  • + *
  • + *

    + * UpdateComment, which updates the content of a comment on a commit in a repository.

    + *
  • + *
+ * + *

Tags used to tag resources in AWS CodeCommit (not Git tags), by calling the following:

+ *
    + *
  • + *

    + * ListTagsForResource, which gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeCommit.

    + *
  • + *
  • + *

    + * TagResource, which adds or updates tags for a resource in AWS CodeCommit.

    + *
  • + *
  • + *

    + * UntagResource, which removes tags for a resource in AWS CodeCommit.

    + *
  • + *
+ * + *

Triggers, by calling the following:

+ *
    + *
  • + *

    + * GetRepositoryTriggers, which returns information about triggers configured + * for a repository.

    + *
  • + *
  • + *

    + * PutRepositoryTriggers, which replaces all triggers for a repository and can + * be used to create or delete triggers.

    + *
  • + *
  • + *

    + * TestRepositoryTriggers, which tests the functionality of a repository trigger + * by sending data to the trigger target.

    + *
  • + *
+ * + * + * + * + *

For information about how to use AWS CodeCommit, see the AWS CodeCommit User Guide.

+ */ +export class CodeCommit extends CodeCommitClient implements CodeCommit {} +createAggregatedClient(commands, CodeCommit); diff --git a/clients/client-codedeploy/src/CodeDeploy.ts b/clients/client-codedeploy/src/CodeDeploy.ts index 47fc0e532919..5338fb6faa1c 100644 --- a/clients/client-codedeploy/src/CodeDeploy.ts +++ b/clients/client-codedeploy/src/CodeDeploy.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CodeDeployClient } from "./CodeDeployClient"; +import { CodeDeployClient, CodeDeployClientConfig } from "./CodeDeployClient"; import { AddTagsToOnPremisesInstancesCommand, AddTagsToOnPremisesInstancesCommandInput, @@ -234,1732 +235,925 @@ import { UpdateDeploymentGroupCommandOutput, } from "./commands/UpdateDeploymentGroupCommand"; -/** - * @public - *

CodeDeploy is a deployment service that automates application deployments - * to Amazon EC2 instances, on-premises instances running in your own facility, - * serverless Lambda functions, or applications in an Amazon ECS - * service.

- *

You can deploy a nearly unlimited variety of application content, such as an updated - * Lambda function, updated applications in an Amazon ECS service, - * code, web and configuration files, executables, packages, scripts, multimedia files, and - * so on. CodeDeploy can deploy application content stored in Amazon S3 - * buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes - * to your existing code before you can use CodeDeploy.

- *

CodeDeploy makes it easier for you to rapidly release new features, helps - * you avoid downtime during application deployment, and handles the complexity of updating - * your applications, without many of the risks associated with error-prone manual - * deployments.

- *

- * CodeDeploy Components - *

- *

Use the information in this guide to help you work with the following CodeDeploy components:

- *
    - *
  • - *

    - * Application: A name that uniquely identifies - * the application you want to deploy. CodeDeploy uses this name, which - * functions as a container, to ensure the correct combination of revision, - * deployment configuration, and deployment group are referenced during a - * deployment.

    - *
  • - *
  • - *

    - * Deployment group: A set of individual - * instances, CodeDeploy - * Lambda deployment configuration settings, or an Amazon ECS - * service and network details. A Lambda deployment group specifies how - * to route traffic to a new version of a Lambda function. An Amazon ECS deployment group specifies the service created in Amazon ECS to deploy, a load balancer, and a listener to reroute production - * traffic to an updated containerized application. An Amazon EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Amazon EC2 Auto Scaling groups, or both. All - * deployment groups can specify optional trigger, alarm, and rollback - * settings.

    - *
  • - *
  • - *

    - * Deployment configuration: A set of deployment - * rules and deployment success and failure conditions used by CodeDeploy during a deployment.

    - *
  • - *
  • - *

    - * Deployment: The process and the components used - * when updating a Lambda function, a containerized application in an - * Amazon ECS service, or of installing content on one or more - * instances.

    - *
  • - *
  • - *

    - * Application revisions: For an Lambda deployment, this is an AppSpec file that specifies the - * Lambda function to be updated and one or more functions to - * validate deployment lifecycle events. For an Amazon ECS deployment, this - * is an AppSpec file that specifies the Amazon ECS task definition, - * container, and port where production traffic is rerouted. For an EC2/On-premises - * deployment, this is an archive file that contains source content—source code, - * webpages, executable files, and deployment scripts—along with an AppSpec file. - * Revisions are stored in Amazon S3 buckets or GitHub repositories. For - * Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely - * identified by its commit ID.

    - *
  • - *
- *

This guide also contains information to help you get details about the instances in - * your deployments, to make on-premises instances available for CodeDeploy - * deployments, to get details about a Lambda function deployment, and to get - * details about Amazon ECS service deployments.

- *

- * CodeDeploy Information Resources - *

- * - */ -export class CodeDeploy extends CodeDeployClient { +const commands = { + AddTagsToOnPremisesInstancesCommand, + BatchGetApplicationRevisionsCommand, + BatchGetApplicationsCommand, + BatchGetDeploymentGroupsCommand, + BatchGetDeploymentInstancesCommand, + BatchGetDeploymentsCommand, + BatchGetDeploymentTargetsCommand, + BatchGetOnPremisesInstancesCommand, + ContinueDeploymentCommand, + CreateApplicationCommand, + CreateDeploymentCommand, + CreateDeploymentConfigCommand, + CreateDeploymentGroupCommand, + DeleteApplicationCommand, + DeleteDeploymentConfigCommand, + DeleteDeploymentGroupCommand, + DeleteGitHubAccountTokenCommand, + DeleteResourcesByExternalIdCommand, + DeregisterOnPremisesInstanceCommand, + GetApplicationCommand, + GetApplicationRevisionCommand, + GetDeploymentCommand, + GetDeploymentConfigCommand, + GetDeploymentGroupCommand, + GetDeploymentInstanceCommand, + GetDeploymentTargetCommand, + GetOnPremisesInstanceCommand, + ListApplicationRevisionsCommand, + ListApplicationsCommand, + ListDeploymentConfigsCommand, + ListDeploymentGroupsCommand, + ListDeploymentInstancesCommand, + ListDeploymentsCommand, + ListDeploymentTargetsCommand, + ListGitHubAccountTokenNamesCommand, + ListOnPremisesInstancesCommand, + ListTagsForResourceCommand, + PutLifecycleEventHookExecutionStatusCommand, + RegisterApplicationRevisionCommand, + RegisterOnPremisesInstanceCommand, + RemoveTagsFromOnPremisesInstancesCommand, + SkipWaitTimeForInstanceTerminationCommand, + StopDeploymentCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateApplicationCommand, + UpdateDeploymentGroupCommand, +}; + +export interface CodeDeploy { /** - * @public - *

Adds tags to on-premises instances.

+ * @see {@link AddTagsToOnPremisesInstancesCommand} */ - public addTagsToOnPremisesInstances( + addTagsToOnPremisesInstances( args: AddTagsToOnPremisesInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public addTagsToOnPremisesInstances( + addTagsToOnPremisesInstances( args: AddTagsToOnPremisesInstancesCommandInput, cb: (err: any, data?: AddTagsToOnPremisesInstancesCommandOutput) => void ): void; - public addTagsToOnPremisesInstances( + addTagsToOnPremisesInstances( args: AddTagsToOnPremisesInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsToOnPremisesInstancesCommandOutput) => void ): void; - public addTagsToOnPremisesInstances( - args: AddTagsToOnPremisesInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddTagsToOnPremisesInstancesCommandOutput) => void), - cb?: (err: any, data?: AddTagsToOnPremisesInstancesCommandOutput) => void - ): Promise | void { - const command = new AddTagsToOnPremisesInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about one or more application revisions. The maximum number of - * application revisions that can be returned is 25.

+ * @see {@link BatchGetApplicationRevisionsCommand} */ - public batchGetApplicationRevisions( + batchGetApplicationRevisions( args: BatchGetApplicationRevisionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetApplicationRevisions( + batchGetApplicationRevisions( args: BatchGetApplicationRevisionsCommandInput, cb: (err: any, data?: BatchGetApplicationRevisionsCommandOutput) => void ): void; - public batchGetApplicationRevisions( + batchGetApplicationRevisions( args: BatchGetApplicationRevisionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetApplicationRevisionsCommandOutput) => void ): void; - public batchGetApplicationRevisions( - args: BatchGetApplicationRevisionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetApplicationRevisionsCommandOutput) => void), - cb?: (err: any, data?: BatchGetApplicationRevisionsCommandOutput) => void - ): Promise | void { - const command = new BatchGetApplicationRevisionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about one or more applications. The maximum number of applications - * that can be returned is 100.

+ * @see {@link BatchGetApplicationsCommand} */ - public batchGetApplications( + batchGetApplications( args: BatchGetApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetApplications( + batchGetApplications( args: BatchGetApplicationsCommandInput, cb: (err: any, data?: BatchGetApplicationsCommandOutput) => void ): void; - public batchGetApplications( + batchGetApplications( args: BatchGetApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetApplicationsCommandOutput) => void ): void; - public batchGetApplications( - args: BatchGetApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetApplicationsCommandOutput) => void), - cb?: (err: any, data?: BatchGetApplicationsCommandOutput) => void - ): Promise | void { - const command = new BatchGetApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about one or more deployment groups.

+ * @see {@link BatchGetDeploymentGroupsCommand} */ - public batchGetDeploymentGroups( + batchGetDeploymentGroups( args: BatchGetDeploymentGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetDeploymentGroups( + batchGetDeploymentGroups( args: BatchGetDeploymentGroupsCommandInput, cb: (err: any, data?: BatchGetDeploymentGroupsCommandOutput) => void ): void; - public batchGetDeploymentGroups( + batchGetDeploymentGroups( args: BatchGetDeploymentGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetDeploymentGroupsCommandOutput) => void ): void; - public batchGetDeploymentGroups( - args: BatchGetDeploymentGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetDeploymentGroupsCommandOutput) => void), - cb?: (err: any, data?: BatchGetDeploymentGroupsCommandOutput) => void - ): Promise | void { - const command = new BatchGetDeploymentGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - * - *

This method works, but is deprecated. Use BatchGetDeploymentTargets - * instead.

- *
- *

Returns an array of one or more instances associated with a deployment. This method - * works with EC2/On-premises and Lambda compute platforms. The newer - * BatchGetDeploymentTargets works with all compute platforms. The maximum - * number of instances that can be returned is 25.

+ * @see {@link BatchGetDeploymentInstancesCommand} */ - public batchGetDeploymentInstances( + batchGetDeploymentInstances( args: BatchGetDeploymentInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetDeploymentInstances( + batchGetDeploymentInstances( args: BatchGetDeploymentInstancesCommandInput, cb: (err: any, data?: BatchGetDeploymentInstancesCommandOutput) => void ): void; - public batchGetDeploymentInstances( + batchGetDeploymentInstances( args: BatchGetDeploymentInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetDeploymentInstancesCommandOutput) => void ): void; - public batchGetDeploymentInstances( - args: BatchGetDeploymentInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetDeploymentInstancesCommandOutput) => void), - cb?: (err: any, data?: BatchGetDeploymentInstancesCommandOutput) => void - ): Promise | void { - const command = new BatchGetDeploymentInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about one or more deployments. The maximum number of deployments that - * can be returned is 25.

+ * @see {@link BatchGetDeploymentsCommand} */ - public batchGetDeployments( + batchGetDeployments( args: BatchGetDeploymentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetDeployments( + batchGetDeployments( args: BatchGetDeploymentsCommandInput, cb: (err: any, data?: BatchGetDeploymentsCommandOutput) => void ): void; - public batchGetDeployments( + batchGetDeployments( args: BatchGetDeploymentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetDeploymentsCommandOutput) => void ): void; - public batchGetDeployments( - args: BatchGetDeploymentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetDeploymentsCommandOutput) => void), - cb?: (err: any, data?: BatchGetDeploymentsCommandOutput) => void - ): Promise | void { - const command = new BatchGetDeploymentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of one or more targets associated with a deployment. This method - * works with all compute types and should be used instead of the deprecated - * BatchGetDeploymentInstances. The maximum number of targets that can be - * returned is 25.

- *

The type of targets returned depends on the deployment's compute platform or - * deployment method:

- *
    - *
  • - *

    - * EC2/On-premises: Information about Amazon EC2 instance targets.

    - *
  • - *
  • - *

    - * Lambda: Information about - * Lambda functions targets.

    - *
  • - *
  • - *

    - * Amazon ECS: Information about Amazon ECS service targets.

    - *
  • - *
  • - *

    - * CloudFormation: Information about - * targets of blue/green deployments initiated by a CloudFormation stack - * update.

    - *
  • - *
+ * @see {@link BatchGetDeploymentTargetsCommand} */ - public batchGetDeploymentTargets( + batchGetDeploymentTargets( args: BatchGetDeploymentTargetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetDeploymentTargets( + batchGetDeploymentTargets( args: BatchGetDeploymentTargetsCommandInput, cb: (err: any, data?: BatchGetDeploymentTargetsCommandOutput) => void ): void; - public batchGetDeploymentTargets( + batchGetDeploymentTargets( args: BatchGetDeploymentTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetDeploymentTargetsCommandOutput) => void ): void; - public batchGetDeploymentTargets( - args: BatchGetDeploymentTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetDeploymentTargetsCommandOutput) => void), - cb?: (err: any, data?: BatchGetDeploymentTargetsCommandOutput) => void - ): Promise | void { - const command = new BatchGetDeploymentTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about one or more on-premises instances. The maximum number of - * on-premises instances that can be returned is 25.

+ * @see {@link BatchGetOnPremisesInstancesCommand} */ - public batchGetOnPremisesInstances( + batchGetOnPremisesInstances( args: BatchGetOnPremisesInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetOnPremisesInstances( + batchGetOnPremisesInstances( args: BatchGetOnPremisesInstancesCommandInput, cb: (err: any, data?: BatchGetOnPremisesInstancesCommandOutput) => void ): void; - public batchGetOnPremisesInstances( + batchGetOnPremisesInstances( args: BatchGetOnPremisesInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetOnPremisesInstancesCommandOutput) => void ): void; - public batchGetOnPremisesInstances( - args: BatchGetOnPremisesInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetOnPremisesInstancesCommandOutput) => void), - cb?: (err: any, data?: BatchGetOnPremisesInstancesCommandOutput) => void - ): Promise | void { - const command = new BatchGetOnPremisesInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

For a blue/green deployment, starts the process of rerouting traffic from instances in - * the original environment to instances in the replacement environment without waiting for - * a specified wait time to elapse. (Traffic rerouting, which is achieved by registering - * instances in the replacement environment with the load balancer, can start as soon as - * all instances have a status of Ready.)

+ * @see {@link ContinueDeploymentCommand} */ - public continueDeployment( + continueDeployment( args: ContinueDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public continueDeployment( + continueDeployment( args: ContinueDeploymentCommandInput, cb: (err: any, data?: ContinueDeploymentCommandOutput) => void ): void; - public continueDeployment( + continueDeployment( args: ContinueDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ContinueDeploymentCommandOutput) => void ): void; - public continueDeployment( - args: ContinueDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ContinueDeploymentCommandOutput) => void), - cb?: (err: any, data?: ContinueDeploymentCommandOutput) => void - ): Promise | void { - const command = new ContinueDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an application.

+ * @see {@link CreateApplicationCommand} */ - public createApplication( + createApplication( args: CreateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApplication( + createApplication( args: CreateApplicationCommandInput, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( + createApplication( args: CreateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( - args: CreateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApplicationCommandOutput) => void), - cb?: (err: any, data?: CreateApplicationCommandOutput) => void - ): Promise | void { - const command = new CreateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deploys an application revision through the specified deployment group.

+ * @see {@link CreateDeploymentCommand} */ - public createDeployment( + createDeployment( args: CreateDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDeployment( + createDeployment( args: CreateDeploymentCommandInput, cb: (err: any, data?: CreateDeploymentCommandOutput) => void ): void; - public createDeployment( + createDeployment( args: CreateDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeploymentCommandOutput) => void ): void; - public createDeployment( - args: CreateDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDeploymentCommandOutput) => void), - cb?: (err: any, data?: CreateDeploymentCommandOutput) => void - ): Promise | void { - const command = new CreateDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a deployment configuration.

+ * @see {@link CreateDeploymentConfigCommand} */ - public createDeploymentConfig( + createDeploymentConfig( args: CreateDeploymentConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDeploymentConfig( + createDeploymentConfig( args: CreateDeploymentConfigCommandInput, cb: (err: any, data?: CreateDeploymentConfigCommandOutput) => void ): void; - public createDeploymentConfig( + createDeploymentConfig( args: CreateDeploymentConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeploymentConfigCommandOutput) => void ): void; - public createDeploymentConfig( - args: CreateDeploymentConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDeploymentConfigCommandOutput) => void), - cb?: (err: any, data?: CreateDeploymentConfigCommandOutput) => void - ): Promise | void { - const command = new CreateDeploymentConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a deployment group to which application revisions are deployed.

+ * @see {@link CreateDeploymentGroupCommand} */ - public createDeploymentGroup( + createDeploymentGroup( args: CreateDeploymentGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDeploymentGroup( + createDeploymentGroup( args: CreateDeploymentGroupCommandInput, cb: (err: any, data?: CreateDeploymentGroupCommandOutput) => void ): void; - public createDeploymentGroup( + createDeploymentGroup( args: CreateDeploymentGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeploymentGroupCommandOutput) => void ): void; - public createDeploymentGroup( - args: CreateDeploymentGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDeploymentGroupCommandOutput) => void), - cb?: (err: any, data?: CreateDeploymentGroupCommandOutput) => void - ): Promise | void { - const command = new CreateDeploymentGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an application.

+ * @see {@link DeleteApplicationCommand} */ - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( - args: DeleteApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApplicationCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a deployment configuration.

- * - *

A deployment configuration cannot be deleted if it is currently in use. Predefined - * configurations cannot be deleted.

- *
+ * @see {@link DeleteDeploymentConfigCommand} */ - public deleteDeploymentConfig( + deleteDeploymentConfig( args: DeleteDeploymentConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDeploymentConfig( + deleteDeploymentConfig( args: DeleteDeploymentConfigCommandInput, cb: (err: any, data?: DeleteDeploymentConfigCommandOutput) => void ): void; - public deleteDeploymentConfig( + deleteDeploymentConfig( args: DeleteDeploymentConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDeploymentConfigCommandOutput) => void ): void; - public deleteDeploymentConfig( - args: DeleteDeploymentConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDeploymentConfigCommandOutput) => void), - cb?: (err: any, data?: DeleteDeploymentConfigCommandOutput) => void - ): Promise | void { - const command = new DeleteDeploymentConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a deployment group.

+ * @see {@link DeleteDeploymentGroupCommand} */ - public deleteDeploymentGroup( + deleteDeploymentGroup( args: DeleteDeploymentGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDeploymentGroup( + deleteDeploymentGroup( args: DeleteDeploymentGroupCommandInput, cb: (err: any, data?: DeleteDeploymentGroupCommandOutput) => void ): void; - public deleteDeploymentGroup( + deleteDeploymentGroup( args: DeleteDeploymentGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDeploymentGroupCommandOutput) => void ): void; - public deleteDeploymentGroup( - args: DeleteDeploymentGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDeploymentGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteDeploymentGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteDeploymentGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a GitHub account connection.

+ * @see {@link DeleteGitHubAccountTokenCommand} */ - public deleteGitHubAccountToken( + deleteGitHubAccountToken( args: DeleteGitHubAccountTokenCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteGitHubAccountToken( + deleteGitHubAccountToken( args: DeleteGitHubAccountTokenCommandInput, cb: (err: any, data?: DeleteGitHubAccountTokenCommandOutput) => void ): void; - public deleteGitHubAccountToken( + deleteGitHubAccountToken( args: DeleteGitHubAccountTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGitHubAccountTokenCommandOutput) => void ): void; - public deleteGitHubAccountToken( - args: DeleteGitHubAccountTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGitHubAccountTokenCommandOutput) => void), - cb?: (err: any, data?: DeleteGitHubAccountTokenCommandOutput) => void - ): Promise | void { - const command = new DeleteGitHubAccountTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes resources linked to an external ID.

+ * @see {@link DeleteResourcesByExternalIdCommand} */ - public deleteResourcesByExternalId( + deleteResourcesByExternalId( args: DeleteResourcesByExternalIdCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourcesByExternalId( + deleteResourcesByExternalId( args: DeleteResourcesByExternalIdCommandInput, cb: (err: any, data?: DeleteResourcesByExternalIdCommandOutput) => void ): void; - public deleteResourcesByExternalId( + deleteResourcesByExternalId( args: DeleteResourcesByExternalIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcesByExternalIdCommandOutput) => void ): void; - public deleteResourcesByExternalId( - args: DeleteResourcesByExternalIdCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourcesByExternalIdCommandOutput) => void), - cb?: (err: any, data?: DeleteResourcesByExternalIdCommandOutput) => void - ): Promise | void { - const command = new DeleteResourcesByExternalIdCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deregisters an on-premises instance.

+ * @see {@link DeregisterOnPremisesInstanceCommand} */ - public deregisterOnPremisesInstance( + deregisterOnPremisesInstance( args: DeregisterOnPremisesInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterOnPremisesInstance( + deregisterOnPremisesInstance( args: DeregisterOnPremisesInstanceCommandInput, cb: (err: any, data?: DeregisterOnPremisesInstanceCommandOutput) => void ): void; - public deregisterOnPremisesInstance( + deregisterOnPremisesInstance( args: DeregisterOnPremisesInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterOnPremisesInstanceCommandOutput) => void ): void; - public deregisterOnPremisesInstance( - args: DeregisterOnPremisesInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterOnPremisesInstanceCommandOutput) => void), - cb?: (err: any, data?: DeregisterOnPremisesInstanceCommandOutput) => void - ): Promise | void { - const command = new DeregisterOnPremisesInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about an application.

+ * @see {@link GetApplicationCommand} */ - public getApplication( + getApplication( args: GetApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getApplication( - args: GetApplicationCommandInput, - cb: (err: any, data?: GetApplicationCommandOutput) => void - ): void; - public getApplication( + getApplication(args: GetApplicationCommandInput, cb: (err: any, data?: GetApplicationCommandOutput) => void): void; + getApplication( args: GetApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApplicationCommandOutput) => void ): void; - public getApplication( - args: GetApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApplicationCommandOutput) => void), - cb?: (err: any, data?: GetApplicationCommandOutput) => void - ): Promise | void { - const command = new GetApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about an application revision.

+ * @see {@link GetApplicationRevisionCommand} */ - public getApplicationRevision( + getApplicationRevision( args: GetApplicationRevisionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getApplicationRevision( + getApplicationRevision( args: GetApplicationRevisionCommandInput, cb: (err: any, data?: GetApplicationRevisionCommandOutput) => void ): void; - public getApplicationRevision( + getApplicationRevision( args: GetApplicationRevisionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApplicationRevisionCommandOutput) => void ): void; - public getApplicationRevision( - args: GetApplicationRevisionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApplicationRevisionCommandOutput) => void), - cb?: (err: any, data?: GetApplicationRevisionCommandOutput) => void - ): Promise | void { - const command = new GetApplicationRevisionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a deployment.

- * - *

The content property of the appSpecContent object in - * the returned revision is always null. Use GetApplicationRevision and - * the sha256 property of the returned appSpecContent object - * to get the content of the deployment’s AppSpec file.

- *
+ * @see {@link GetDeploymentCommand} */ - public getDeployment( - args: GetDeploymentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getDeployment( - args: GetDeploymentCommandInput, - cb: (err: any, data?: GetDeploymentCommandOutput) => void - ): void; - public getDeployment( + getDeployment(args: GetDeploymentCommandInput, options?: __HttpHandlerOptions): Promise; + getDeployment(args: GetDeploymentCommandInput, cb: (err: any, data?: GetDeploymentCommandOutput) => void): void; + getDeployment( args: GetDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeploymentCommandOutput) => void ): void; - public getDeployment( - args: GetDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeploymentCommandOutput) => void), - cb?: (err: any, data?: GetDeploymentCommandOutput) => void - ): Promise | void { - const command = new GetDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a deployment configuration.

+ * @see {@link GetDeploymentConfigCommand} */ - public getDeploymentConfig( + getDeploymentConfig( args: GetDeploymentConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDeploymentConfig( + getDeploymentConfig( args: GetDeploymentConfigCommandInput, cb: (err: any, data?: GetDeploymentConfigCommandOutput) => void ): void; - public getDeploymentConfig( + getDeploymentConfig( args: GetDeploymentConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeploymentConfigCommandOutput) => void ): void; - public getDeploymentConfig( - args: GetDeploymentConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeploymentConfigCommandOutput) => void), - cb?: (err: any, data?: GetDeploymentConfigCommandOutput) => void - ): Promise | void { - const command = new GetDeploymentConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a deployment group.

+ * @see {@link GetDeploymentGroupCommand} */ - public getDeploymentGroup( + getDeploymentGroup( args: GetDeploymentGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDeploymentGroup( + getDeploymentGroup( args: GetDeploymentGroupCommandInput, cb: (err: any, data?: GetDeploymentGroupCommandOutput) => void ): void; - public getDeploymentGroup( + getDeploymentGroup( args: GetDeploymentGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeploymentGroupCommandOutput) => void ): void; - public getDeploymentGroup( - args: GetDeploymentGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeploymentGroupCommandOutput) => void), - cb?: (err: any, data?: GetDeploymentGroupCommandOutput) => void - ): Promise | void { - const command = new GetDeploymentGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Gets information about an instance as part of a deployment.

+ * @see {@link GetDeploymentInstanceCommand} */ - public getDeploymentInstance( + getDeploymentInstance( args: GetDeploymentInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDeploymentInstance( + getDeploymentInstance( args: GetDeploymentInstanceCommandInput, cb: (err: any, data?: GetDeploymentInstanceCommandOutput) => void ): void; - public getDeploymentInstance( + getDeploymentInstance( args: GetDeploymentInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeploymentInstanceCommandOutput) => void ): void; - public getDeploymentInstance( - args: GetDeploymentInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeploymentInstanceCommandOutput) => void), - cb?: (err: any, data?: GetDeploymentInstanceCommandOutput) => void - ): Promise | void { - const command = new GetDeploymentInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a deployment target.

+ * @see {@link GetDeploymentTargetCommand} */ - public getDeploymentTarget( + getDeploymentTarget( args: GetDeploymentTargetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDeploymentTarget( + getDeploymentTarget( args: GetDeploymentTargetCommandInput, cb: (err: any, data?: GetDeploymentTargetCommandOutput) => void ): void; - public getDeploymentTarget( + getDeploymentTarget( args: GetDeploymentTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeploymentTargetCommandOutput) => void ): void; - public getDeploymentTarget( - args: GetDeploymentTargetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeploymentTargetCommandOutput) => void), - cb?: (err: any, data?: GetDeploymentTargetCommandOutput) => void - ): Promise | void { - const command = new GetDeploymentTargetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about an on-premises instance.

+ * @see {@link GetOnPremisesInstanceCommand} */ - public getOnPremisesInstance( + getOnPremisesInstance( args: GetOnPremisesInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public getOnPremisesInstance( + getOnPremisesInstance( args: GetOnPremisesInstanceCommandInput, cb: (err: any, data?: GetOnPremisesInstanceCommandOutput) => void ): void; - public getOnPremisesInstance( + getOnPremisesInstance( args: GetOnPremisesInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOnPremisesInstanceCommandOutput) => void ): void; - public getOnPremisesInstance( - args: GetOnPremisesInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOnPremisesInstanceCommandOutput) => void), - cb?: (err: any, data?: GetOnPremisesInstanceCommandOutput) => void - ): Promise | void { - const command = new GetOnPremisesInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists information about revisions for an application.

+ * @see {@link ListApplicationRevisionsCommand} */ - public listApplicationRevisions( + listApplicationRevisions( args: ListApplicationRevisionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplicationRevisions( + listApplicationRevisions( args: ListApplicationRevisionsCommandInput, cb: (err: any, data?: ListApplicationRevisionsCommandOutput) => void ): void; - public listApplicationRevisions( + listApplicationRevisions( args: ListApplicationRevisionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationRevisionsCommandOutput) => void ): void; - public listApplicationRevisions( - args: ListApplicationRevisionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationRevisionsCommandOutput) => void), - cb?: (err: any, data?: ListApplicationRevisionsCommandOutput) => void - ): Promise | void { - const command = new ListApplicationRevisionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the applications registered with the IAM user or Amazon Web Services account.

+ * @see {@link ListApplicationsCommand} */ - public listApplications( + listApplications( args: ListApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplications( + listApplications( args: ListApplicationsCommandInput, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( + listApplications( args: ListApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( - args: ListApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationsCommandOutput) => void), - cb?: (err: any, data?: ListApplicationsCommandOutput) => void - ): Promise | void { - const command = new ListApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the deployment configurations with the IAM user or Amazon Web Services account.

+ * @see {@link ListDeploymentConfigsCommand} */ - public listDeploymentConfigs( + listDeploymentConfigs( args: ListDeploymentConfigsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeploymentConfigs( + listDeploymentConfigs( args: ListDeploymentConfigsCommandInput, cb: (err: any, data?: ListDeploymentConfigsCommandOutput) => void ): void; - public listDeploymentConfigs( + listDeploymentConfigs( args: ListDeploymentConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeploymentConfigsCommandOutput) => void ): void; - public listDeploymentConfigs( - args: ListDeploymentConfigsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeploymentConfigsCommandOutput) => void), - cb?: (err: any, data?: ListDeploymentConfigsCommandOutput) => void - ): Promise | void { - const command = new ListDeploymentConfigsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the deployment groups for an application registered with the IAM - * user or Amazon Web Services account.

+ * @see {@link ListDeploymentGroupsCommand} */ - public listDeploymentGroups( + listDeploymentGroups( args: ListDeploymentGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeploymentGroups( + listDeploymentGroups( args: ListDeploymentGroupsCommandInput, cb: (err: any, data?: ListDeploymentGroupsCommandOutput) => void ): void; - public listDeploymentGroups( + listDeploymentGroups( args: ListDeploymentGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeploymentGroupsCommandOutput) => void ): void; - public listDeploymentGroups( - args: ListDeploymentGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeploymentGroupsCommandOutput) => void), - cb?: (err: any, data?: ListDeploymentGroupsCommandOutput) => void - ): Promise | void { - const command = new ListDeploymentGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - * - *

The newer BatchGetDeploymentTargets should be used instead because - * it works with all compute types. ListDeploymentInstances throws an - * exception if it is used with a compute platform other than EC2/On-premises or - * Lambda.

- *
- *

Lists the instance for a deployment associated with the IAM user or - * Amazon Web Services account.

+ * @see {@link ListDeploymentInstancesCommand} */ - public listDeploymentInstances( + listDeploymentInstances( args: ListDeploymentInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeploymentInstances( + listDeploymentInstances( args: ListDeploymentInstancesCommandInput, cb: (err: any, data?: ListDeploymentInstancesCommandOutput) => void ): void; - public listDeploymentInstances( + listDeploymentInstances( args: ListDeploymentInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeploymentInstancesCommandOutput) => void ): void; - public listDeploymentInstances( - args: ListDeploymentInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeploymentInstancesCommandOutput) => void), - cb?: (err: any, data?: ListDeploymentInstancesCommandOutput) => void - ): Promise | void { - const command = new ListDeploymentInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the deployments in a deployment group for an application registered with the - * IAM user or Amazon Web Services account.

+ * @see {@link ListDeploymentsCommand} */ - public listDeployments( + listDeployments( args: ListDeploymentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeployments( - args: ListDeploymentsCommandInput, - cb: (err: any, data?: ListDeploymentsCommandOutput) => void - ): void; - public listDeployments( + listDeployments(args: ListDeploymentsCommandInput, cb: (err: any, data?: ListDeploymentsCommandOutput) => void): void; + listDeployments( args: ListDeploymentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeploymentsCommandOutput) => void ): void; - public listDeployments( - args: ListDeploymentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeploymentsCommandOutput) => void), - cb?: (err: any, data?: ListDeploymentsCommandOutput) => void - ): Promise | void { - const command = new ListDeploymentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of target IDs that are associated a deployment.

+ * @see {@link ListDeploymentTargetsCommand} */ - public listDeploymentTargets( + listDeploymentTargets( args: ListDeploymentTargetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeploymentTargets( + listDeploymentTargets( args: ListDeploymentTargetsCommandInput, cb: (err: any, data?: ListDeploymentTargetsCommandOutput) => void ): void; - public listDeploymentTargets( + listDeploymentTargets( args: ListDeploymentTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeploymentTargetsCommandOutput) => void ): void; - public listDeploymentTargets( - args: ListDeploymentTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeploymentTargetsCommandOutput) => void), - cb?: (err: any, data?: ListDeploymentTargetsCommandOutput) => void - ): Promise | void { - const command = new ListDeploymentTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the names of stored connections to GitHub accounts.

+ * @see {@link ListGitHubAccountTokenNamesCommand} */ - public listGitHubAccountTokenNames( + listGitHubAccountTokenNames( args: ListGitHubAccountTokenNamesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGitHubAccountTokenNames( + listGitHubAccountTokenNames( args: ListGitHubAccountTokenNamesCommandInput, cb: (err: any, data?: ListGitHubAccountTokenNamesCommandOutput) => void ): void; - public listGitHubAccountTokenNames( + listGitHubAccountTokenNames( args: ListGitHubAccountTokenNamesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGitHubAccountTokenNamesCommandOutput) => void ): void; - public listGitHubAccountTokenNames( - args: ListGitHubAccountTokenNamesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGitHubAccountTokenNamesCommandOutput) => void), - cb?: (err: any, data?: ListGitHubAccountTokenNamesCommandOutput) => void - ): Promise | void { - const command = new ListGitHubAccountTokenNamesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of names for one or more on-premises instances.

- *

Unless otherwise specified, both registered and deregistered on-premises instance - * names are listed. To list only registered or deregistered on-premises instance names, - * use the registration status parameter.

+ * @see {@link ListOnPremisesInstancesCommand} */ - public listOnPremisesInstances( + listOnPremisesInstances( args: ListOnPremisesInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOnPremisesInstances( + listOnPremisesInstances( args: ListOnPremisesInstancesCommandInput, cb: (err: any, data?: ListOnPremisesInstancesCommandOutput) => void ): void; - public listOnPremisesInstances( + listOnPremisesInstances( args: ListOnPremisesInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOnPremisesInstancesCommandOutput) => void ): void; - public listOnPremisesInstances( - args: ListOnPremisesInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOnPremisesInstancesCommandOutput) => void), - cb?: (err: any, data?: ListOnPremisesInstancesCommandOutput) => void - ): Promise | void { - const command = new ListOnPremisesInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of tags for the resource identified by a specified Amazon Resource - * Name (ARN). Tags are used to organize and categorize your CodeDeploy resources.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the result of a Lambda validation function. The function validates - * lifecycle hooks during a deployment that uses the Lambda or Amazon ECS compute platform. For Lambda deployments, the available - * lifecycle hooks are BeforeAllowTraffic and AfterAllowTraffic. - * For Amazon ECS deployments, the available lifecycle hooks are - * BeforeInstall, AfterInstall, - * AfterAllowTestTraffic, BeforeAllowTraffic, and - * AfterAllowTraffic. Lambda validation functions return - * Succeeded or Failed. For more information, see AppSpec 'hooks' Section for an Lambda Deployment and - * AppSpec 'hooks' Section for an Amazon ECS Deployment.

+ * @see {@link PutLifecycleEventHookExecutionStatusCommand} */ - public putLifecycleEventHookExecutionStatus( + putLifecycleEventHookExecutionStatus( args: PutLifecycleEventHookExecutionStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public putLifecycleEventHookExecutionStatus( + putLifecycleEventHookExecutionStatus( args: PutLifecycleEventHookExecutionStatusCommandInput, cb: (err: any, data?: PutLifecycleEventHookExecutionStatusCommandOutput) => void ): void; - public putLifecycleEventHookExecutionStatus( + putLifecycleEventHookExecutionStatus( args: PutLifecycleEventHookExecutionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLifecycleEventHookExecutionStatusCommandOutput) => void ): void; - public putLifecycleEventHookExecutionStatus( - args: PutLifecycleEventHookExecutionStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutLifecycleEventHookExecutionStatusCommandOutput) => void), - cb?: (err: any, data?: PutLifecycleEventHookExecutionStatusCommandOutput) => void - ): Promise | void { - const command = new PutLifecycleEventHookExecutionStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers with CodeDeploy a revision for the specified application.

+ * @see {@link RegisterApplicationRevisionCommand} */ - public registerApplicationRevision( + registerApplicationRevision( args: RegisterApplicationRevisionCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerApplicationRevision( + registerApplicationRevision( args: RegisterApplicationRevisionCommandInput, cb: (err: any, data?: RegisterApplicationRevisionCommandOutput) => void ): void; - public registerApplicationRevision( + registerApplicationRevision( args: RegisterApplicationRevisionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterApplicationRevisionCommandOutput) => void ): void; - public registerApplicationRevision( - args: RegisterApplicationRevisionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterApplicationRevisionCommandOutput) => void), - cb?: (err: any, data?: RegisterApplicationRevisionCommandOutput) => void - ): Promise | void { - const command = new RegisterApplicationRevisionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers an on-premises instance.

- * - *

Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.

- *
+ * @see {@link RegisterOnPremisesInstanceCommand} */ - public registerOnPremisesInstance( + registerOnPremisesInstance( args: RegisterOnPremisesInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerOnPremisesInstance( + registerOnPremisesInstance( args: RegisterOnPremisesInstanceCommandInput, cb: (err: any, data?: RegisterOnPremisesInstanceCommandOutput) => void ): void; - public registerOnPremisesInstance( + registerOnPremisesInstance( args: RegisterOnPremisesInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterOnPremisesInstanceCommandOutput) => void ): void; - public registerOnPremisesInstance( - args: RegisterOnPremisesInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterOnPremisesInstanceCommandOutput) => void), - cb?: (err: any, data?: RegisterOnPremisesInstanceCommandOutput) => void - ): Promise | void { - const command = new RegisterOnPremisesInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from one or more on-premises instances.

+ * @see {@link RemoveTagsFromOnPremisesInstancesCommand} */ - public removeTagsFromOnPremisesInstances( + removeTagsFromOnPremisesInstances( args: RemoveTagsFromOnPremisesInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeTagsFromOnPremisesInstances( + removeTagsFromOnPremisesInstances( args: RemoveTagsFromOnPremisesInstancesCommandInput, cb: (err: any, data?: RemoveTagsFromOnPremisesInstancesCommandOutput) => void ): void; - public removeTagsFromOnPremisesInstances( + removeTagsFromOnPremisesInstances( args: RemoveTagsFromOnPremisesInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsFromOnPremisesInstancesCommandOutput) => void ): void; - public removeTagsFromOnPremisesInstances( - args: RemoveTagsFromOnPremisesInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveTagsFromOnPremisesInstancesCommandOutput) => void), - cb?: (err: any, data?: RemoveTagsFromOnPremisesInstancesCommandOutput) => void - ): Promise | void { - const command = new RemoveTagsFromOnPremisesInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

In a blue/green deployment, overrides any specified wait time and starts terminating - * instances immediately after the traffic routing is complete.

+ * @see {@link SkipWaitTimeForInstanceTerminationCommand} */ - public skipWaitTimeForInstanceTermination( + skipWaitTimeForInstanceTermination( args: SkipWaitTimeForInstanceTerminationCommandInput, options?: __HttpHandlerOptions ): Promise; - public skipWaitTimeForInstanceTermination( + skipWaitTimeForInstanceTermination( args: SkipWaitTimeForInstanceTerminationCommandInput, cb: (err: any, data?: SkipWaitTimeForInstanceTerminationCommandOutput) => void ): void; - public skipWaitTimeForInstanceTermination( + skipWaitTimeForInstanceTermination( args: SkipWaitTimeForInstanceTerminationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SkipWaitTimeForInstanceTerminationCommandOutput) => void ): void; - public skipWaitTimeForInstanceTermination( - args: SkipWaitTimeForInstanceTerminationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SkipWaitTimeForInstanceTerminationCommandOutput) => void), - cb?: (err: any, data?: SkipWaitTimeForInstanceTerminationCommandOutput) => void - ): Promise | void { - const command = new SkipWaitTimeForInstanceTerminationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Attempts to stop an ongoing deployment.

+ * @see {@link StopDeploymentCommand} */ - public stopDeployment( + stopDeployment( args: StopDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopDeployment( - args: StopDeploymentCommandInput, - cb: (err: any, data?: StopDeploymentCommandOutput) => void - ): void; - public stopDeployment( + stopDeployment(args: StopDeploymentCommandInput, cb: (err: any, data?: StopDeploymentCommandOutput) => void): void; + stopDeployment( args: StopDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDeploymentCommandOutput) => void ): void; - public stopDeployment( - args: StopDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopDeploymentCommandOutput) => void), - cb?: (err: any, data?: StopDeploymentCommandOutput) => void - ): Promise | void { - const command = new StopDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates the list of tags in the input Tags parameter with the - * resource identified by the ResourceArn input parameter.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates a resource from a list of tags. The resource is identified by the - * ResourceArn input parameter. The tags are identified by the list of - * keys in the TagKeys input parameter.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes the name of an application.

+ * @see {@link UpdateApplicationCommand} */ - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( - args: UpdateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApplicationCommandOutput) => void), - cb?: (err: any, data?: UpdateApplicationCommandOutput) => void - ): Promise | void { - const command = new UpdateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes information about a deployment group.

+ * @see {@link UpdateDeploymentGroupCommand} */ - public updateDeploymentGroup( + updateDeploymentGroup( args: UpdateDeploymentGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDeploymentGroup( + updateDeploymentGroup( args: UpdateDeploymentGroupCommandInput, cb: (err: any, data?: UpdateDeploymentGroupCommandOutput) => void ): void; - public updateDeploymentGroup( + updateDeploymentGroup( args: UpdateDeploymentGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDeploymentGroupCommandOutput) => void ): void; - public updateDeploymentGroup( - args: UpdateDeploymentGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDeploymentGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateDeploymentGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateDeploymentGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

CodeDeploy is a deployment service that automates application deployments + * to Amazon EC2 instances, on-premises instances running in your own facility, + * serverless Lambda functions, or applications in an Amazon ECS + * service.

+ *

You can deploy a nearly unlimited variety of application content, such as an updated + * Lambda function, updated applications in an Amazon ECS service, + * code, web and configuration files, executables, packages, scripts, multimedia files, and + * so on. CodeDeploy can deploy application content stored in Amazon S3 + * buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes + * to your existing code before you can use CodeDeploy.

+ *

CodeDeploy makes it easier for you to rapidly release new features, helps + * you avoid downtime during application deployment, and handles the complexity of updating + * your applications, without many of the risks associated with error-prone manual + * deployments.

+ *

+ * CodeDeploy Components + *

+ *

Use the information in this guide to help you work with the following CodeDeploy components:

+ *
    + *
  • + *

    + * Application: A name that uniquely identifies + * the application you want to deploy. CodeDeploy uses this name, which + * functions as a container, to ensure the correct combination of revision, + * deployment configuration, and deployment group are referenced during a + * deployment.

    + *
  • + *
  • + *

    + * Deployment group: A set of individual + * instances, CodeDeploy + * Lambda deployment configuration settings, or an Amazon ECS + * service and network details. A Lambda deployment group specifies how + * to route traffic to a new version of a Lambda function. An Amazon ECS deployment group specifies the service created in Amazon ECS to deploy, a load balancer, and a listener to reroute production + * traffic to an updated containerized application. An Amazon EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Amazon EC2 Auto Scaling groups, or both. All + * deployment groups can specify optional trigger, alarm, and rollback + * settings.

    + *
  • + *
  • + *

    + * Deployment configuration: A set of deployment + * rules and deployment success and failure conditions used by CodeDeploy during a deployment.

    + *
  • + *
  • + *

    + * Deployment: The process and the components used + * when updating a Lambda function, a containerized application in an + * Amazon ECS service, or of installing content on one or more + * instances.

    + *
  • + *
  • + *

    + * Application revisions: For an Lambda deployment, this is an AppSpec file that specifies the + * Lambda function to be updated and one or more functions to + * validate deployment lifecycle events. For an Amazon ECS deployment, this + * is an AppSpec file that specifies the Amazon ECS task definition, + * container, and port where production traffic is rerouted. For an EC2/On-premises + * deployment, this is an archive file that contains source content—source code, + * webpages, executable files, and deployment scripts—along with an AppSpec file. + * Revisions are stored in Amazon S3 buckets or GitHub repositories. For + * Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely + * identified by its commit ID.

    + *
  • + *
+ *

This guide also contains information to help you get details about the instances in + * your deployments, to make on-premises instances available for CodeDeploy + * deployments, to get details about a Lambda function deployment, and to get + * details about Amazon ECS service deployments.

+ *

+ * CodeDeploy Information Resources + *

+ * + */ +export class CodeDeploy extends CodeDeployClient implements CodeDeploy {} +createAggregatedClient(commands, CodeDeploy); diff --git a/clients/client-codeguru-reviewer/src/CodeGuruReviewer.ts b/clients/client-codeguru-reviewer/src/CodeGuruReviewer.ts index 4a37c9003e27..856b8e4a9ec7 100644 --- a/clients/client-codeguru-reviewer/src/CodeGuruReviewer.ts +++ b/clients/client-codeguru-reviewer/src/CodeGuruReviewer.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CodeGuruReviewerClient } from "./CodeGuruReviewerClient"; +import { CodeGuruReviewerClient, CodeGuruReviewerClientConfig } from "./CodeGuruReviewerClient"; import { AssociateRepositoryCommand, AssociateRepositoryCommandInput, @@ -69,509 +70,267 @@ import { UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; -/** - * @public - *

This section provides documentation for the Amazon CodeGuru Reviewer API operations. CodeGuru Reviewer is a - * service that uses program analysis and machine learning to detect potential defects that - * are difficult for developers to find and recommends fixes in your Java and Python - * code.

- * - *

By proactively detecting and providing recommendations for addressing code defects and - * implementing best practices, CodeGuru Reviewer improves the overall quality and maintainability of - * your code base during the code review stage. For more information about CodeGuru Reviewer, see the - * - * Amazon CodeGuru Reviewer User Guide. - *

- * - *

To improve the security of your CodeGuru Reviewer API calls, you can establish a private connection - * between your VPC and CodeGuru Reviewer by creating an interface VPC endpoint. For - * more information, see CodeGuru Reviewer and interface VPC - * endpoints (Amazon Web Services PrivateLink) in the Amazon CodeGuru Reviewer User - * Guide.

- */ -export class CodeGuruReviewer extends CodeGuruReviewerClient { +const commands = { + AssociateRepositoryCommand, + CreateCodeReviewCommand, + DescribeCodeReviewCommand, + DescribeRecommendationFeedbackCommand, + DescribeRepositoryAssociationCommand, + DisassociateRepositoryCommand, + ListCodeReviewsCommand, + ListRecommendationFeedbackCommand, + ListRecommendationsCommand, + ListRepositoryAssociationsCommand, + ListTagsForResourceCommand, + PutRecommendationFeedbackCommand, + TagResourceCommand, + UntagResourceCommand, +}; + +export interface CodeGuruReviewer { /** - * @public - *

Use to associate an Amazon Web Services CodeCommit repository or a repository managed by Amazon Web Services - * CodeStar Connections with Amazon CodeGuru Reviewer. When you associate a repository, CodeGuru Reviewer reviews - * source code changes in the repository's pull requests and provides automatic - * recommendations. You can view recommendations using the CodeGuru Reviewer console. For more - * information, see Recommendations in - * Amazon CodeGuru Reviewer in the Amazon CodeGuru Reviewer User Guide. - *

- * - *

If you associate a CodeCommit or S3 repository, it must be in the same Amazon Web Services Region and - * Amazon Web Services account where its CodeGuru Reviewer code reviews are configured.

- * - *

Bitbucket and GitHub Enterprise Server repositories are managed by Amazon Web Services CodeStar - * Connections to connect to CodeGuru Reviewer. For more information, see Associate a - * repository in the Amazon CodeGuru Reviewer User Guide. - *

- * - * - *

You cannot use the CodeGuru Reviewer SDK or the Amazon Web Services CLI to associate a GitHub repository with - * Amazon CodeGuru Reviewer. To associate a GitHub repository, use the console. For more information, see - * Getting started with - * CodeGuru Reviewer in the CodeGuru Reviewer User Guide. - *

- *
+ * @see {@link AssociateRepositoryCommand} */ - public associateRepository( + associateRepository( args: AssociateRepositoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateRepository( + associateRepository( args: AssociateRepositoryCommandInput, cb: (err: any, data?: AssociateRepositoryCommandOutput) => void ): void; - public associateRepository( + associateRepository( args: AssociateRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateRepositoryCommandOutput) => void ): void; - public associateRepository( - args: AssociateRepositoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateRepositoryCommandOutput) => void), - cb?: (err: any, data?: AssociateRepositoryCommandOutput) => void - ): Promise | void { - const command = new AssociateRepositoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use to create a code review with a CodeReviewType of - * RepositoryAnalysis. This type of code review analyzes all code under a - * specified branch in an associated repository. PullRequest code reviews are - * automatically triggered by a pull request.

+ * @see {@link CreateCodeReviewCommand} */ - public createCodeReview( + createCodeReview( args: CreateCodeReviewCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCodeReview( + createCodeReview( args: CreateCodeReviewCommandInput, cb: (err: any, data?: CreateCodeReviewCommandOutput) => void ): void; - public createCodeReview( + createCodeReview( args: CreateCodeReviewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCodeReviewCommandOutput) => void ): void; - public createCodeReview( - args: CreateCodeReviewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCodeReviewCommandOutput) => void), - cb?: (err: any, data?: CreateCodeReviewCommandOutput) => void - ): Promise | void { - const command = new CreateCodeReviewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the metadata associated with the code review along with its status.

+ * @see {@link DescribeCodeReviewCommand} */ - public describeCodeReview( + describeCodeReview( args: DescribeCodeReviewCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCodeReview( + describeCodeReview( args: DescribeCodeReviewCommandInput, cb: (err: any, data?: DescribeCodeReviewCommandOutput) => void ): void; - public describeCodeReview( + describeCodeReview( args: DescribeCodeReviewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCodeReviewCommandOutput) => void ): void; - public describeCodeReview( - args: DescribeCodeReviewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCodeReviewCommandOutput) => void), - cb?: (err: any, data?: DescribeCodeReviewCommandOutput) => void - ): Promise | void { - const command = new DescribeCodeReviewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the customer feedback for a CodeGuru Reviewer recommendation.

+ * @see {@link DescribeRecommendationFeedbackCommand} */ - public describeRecommendationFeedback( + describeRecommendationFeedback( args: DescribeRecommendationFeedbackCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRecommendationFeedback( + describeRecommendationFeedback( args: DescribeRecommendationFeedbackCommandInput, cb: (err: any, data?: DescribeRecommendationFeedbackCommandOutput) => void ): void; - public describeRecommendationFeedback( + describeRecommendationFeedback( args: DescribeRecommendationFeedbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRecommendationFeedbackCommandOutput) => void ): void; - public describeRecommendationFeedback( - args: DescribeRecommendationFeedbackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRecommendationFeedbackCommandOutput) => void), - cb?: (err: any, data?: DescribeRecommendationFeedbackCommandOutput) => void - ): Promise | void { - const command = new DescribeRecommendationFeedbackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a RepositoryAssociation object that contains information about the requested - * repository association.

+ * @see {@link DescribeRepositoryAssociationCommand} */ - public describeRepositoryAssociation( + describeRepositoryAssociation( args: DescribeRepositoryAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRepositoryAssociation( + describeRepositoryAssociation( args: DescribeRepositoryAssociationCommandInput, cb: (err: any, data?: DescribeRepositoryAssociationCommandOutput) => void ): void; - public describeRepositoryAssociation( + describeRepositoryAssociation( args: DescribeRepositoryAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRepositoryAssociationCommandOutput) => void ): void; - public describeRepositoryAssociation( - args: DescribeRepositoryAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRepositoryAssociationCommandOutput) => void), - cb?: (err: any, data?: DescribeRepositoryAssociationCommandOutput) => void - ): Promise | void { - const command = new DescribeRepositoryAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the association between Amazon CodeGuru Reviewer and a repository.

+ * @see {@link DisassociateRepositoryCommand} */ - public disassociateRepository( + disassociateRepository( args: DisassociateRepositoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateRepository( + disassociateRepository( args: DisassociateRepositoryCommandInput, cb: (err: any, data?: DisassociateRepositoryCommandOutput) => void ): void; - public disassociateRepository( + disassociateRepository( args: DisassociateRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateRepositoryCommandOutput) => void ): void; - public disassociateRepository( - args: DisassociateRepositoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateRepositoryCommandOutput) => void), - cb?: (err: any, data?: DisassociateRepositoryCommandOutput) => void - ): Promise | void { - const command = new DisassociateRepositoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the code reviews that the customer has created in the past 90 days.

+ * @see {@link ListCodeReviewsCommand} */ - public listCodeReviews( + listCodeReviews( args: ListCodeReviewsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCodeReviews( - args: ListCodeReviewsCommandInput, - cb: (err: any, data?: ListCodeReviewsCommandOutput) => void - ): void; - public listCodeReviews( + listCodeReviews(args: ListCodeReviewsCommandInput, cb: (err: any, data?: ListCodeReviewsCommandOutput) => void): void; + listCodeReviews( args: ListCodeReviewsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCodeReviewsCommandOutput) => void ): void; - public listCodeReviews( - args: ListCodeReviewsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCodeReviewsCommandOutput) => void), - cb?: (err: any, data?: ListCodeReviewsCommandOutput) => void - ): Promise | void { - const command = new ListCodeReviewsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of RecommendationFeedbackSummary objects that contain customer recommendation - * feedback for all CodeGuru Reviewer users.

+ * @see {@link ListRecommendationFeedbackCommand} */ - public listRecommendationFeedback( + listRecommendationFeedback( args: ListRecommendationFeedbackCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRecommendationFeedback( + listRecommendationFeedback( args: ListRecommendationFeedbackCommandInput, cb: (err: any, data?: ListRecommendationFeedbackCommandOutput) => void ): void; - public listRecommendationFeedback( + listRecommendationFeedback( args: ListRecommendationFeedbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecommendationFeedbackCommandOutput) => void ): void; - public listRecommendationFeedback( - args: ListRecommendationFeedbackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRecommendationFeedbackCommandOutput) => void), - cb?: (err: any, data?: ListRecommendationFeedbackCommandOutput) => void - ): Promise | void { - const command = new ListRecommendationFeedbackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the list of all recommendations for a completed code review.

+ * @see {@link ListRecommendationsCommand} */ - public listRecommendations( + listRecommendations( args: ListRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRecommendations( + listRecommendations( args: ListRecommendationsCommandInput, cb: (err: any, data?: ListRecommendationsCommandOutput) => void ): void; - public listRecommendations( + listRecommendations( args: ListRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecommendationsCommandOutput) => void ): void; - public listRecommendations( - args: ListRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRecommendationsCommandOutput) => void), - cb?: (err: any, data?: ListRecommendationsCommandOutput) => void - ): Promise | void { - const command = new ListRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of RepositoryAssociationSummary objects that contain summary information about a - * repository association. You can filter the returned list by ProviderType, Name, State, and Owner.

+ * @see {@link ListRepositoryAssociationsCommand} */ - public listRepositoryAssociations( + listRepositoryAssociations( args: ListRepositoryAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRepositoryAssociations( + listRepositoryAssociations( args: ListRepositoryAssociationsCommandInput, cb: (err: any, data?: ListRepositoryAssociationsCommandOutput) => void ): void; - public listRepositoryAssociations( + listRepositoryAssociations( args: ListRepositoryAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRepositoryAssociationsCommandOutput) => void ): void; - public listRepositoryAssociations( - args: ListRepositoryAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRepositoryAssociationsCommandOutput) => void), - cb?: (err: any, data?: ListRepositoryAssociationsCommandOutput) => void - ): Promise | void { - const command = new ListRepositoryAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the list of tags associated with an associated repository resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stores customer feedback for a CodeGuru Reviewer recommendation. When this API is called again with - * different reactions the previous feedback is overwritten.

+ * @see {@link PutRecommendationFeedbackCommand} */ - public putRecommendationFeedback( + putRecommendationFeedback( args: PutRecommendationFeedbackCommandInput, options?: __HttpHandlerOptions ): Promise; - public putRecommendationFeedback( + putRecommendationFeedback( args: PutRecommendationFeedbackCommandInput, cb: (err: any, data?: PutRecommendationFeedbackCommandOutput) => void ): void; - public putRecommendationFeedback( + putRecommendationFeedback( args: PutRecommendationFeedbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRecommendationFeedbackCommandOutput) => void ): void; - public putRecommendationFeedback( - args: PutRecommendationFeedbackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRecommendationFeedbackCommandOutput) => void), - cb?: (err: any, data?: PutRecommendationFeedbackCommandOutput) => void - ): Promise | void { - const command = new PutRecommendationFeedbackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more tags to an associated repository.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a tag from an associated repository.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

This section provides documentation for the Amazon CodeGuru Reviewer API operations. CodeGuru Reviewer is a + * service that uses program analysis and machine learning to detect potential defects that + * are difficult for developers to find and recommends fixes in your Java and Python + * code.

+ * + *

By proactively detecting and providing recommendations for addressing code defects and + * implementing best practices, CodeGuru Reviewer improves the overall quality and maintainability of + * your code base during the code review stage. For more information about CodeGuru Reviewer, see the + * + * Amazon CodeGuru Reviewer User Guide. + *

+ * + *

To improve the security of your CodeGuru Reviewer API calls, you can establish a private connection + * between your VPC and CodeGuru Reviewer by creating an interface VPC endpoint. For + * more information, see CodeGuru Reviewer and interface VPC + * endpoints (Amazon Web Services PrivateLink) in the Amazon CodeGuru Reviewer User + * Guide.

+ */ +export class CodeGuruReviewer extends CodeGuruReviewerClient implements CodeGuruReviewer {} +createAggregatedClient(commands, CodeGuruReviewer); diff --git a/clients/client-codeguruprofiler/src/CodeGuruProfiler.ts b/clients/client-codeguruprofiler/src/CodeGuruProfiler.ts index 796e3ec500b6..76cb2d0cdefe 100644 --- a/clients/client-codeguruprofiler/src/CodeGuruProfiler.ts +++ b/clients/client-codeguruprofiler/src/CodeGuruProfiler.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CodeGuruProfilerClient } from "./CodeGuruProfilerClient"; +import { CodeGuruProfilerClient, CodeGuruProfilerClientConfig } from "./CodeGuruProfilerClient"; import { AddNotificationChannelsCommand, AddNotificationChannelsCommandInput, @@ -106,925 +107,414 @@ import { UpdateProfilingGroupCommandOutput, } from "./commands/UpdateProfilingGroupCommand"; -/** - * @public - *

- * This section provides documentation for the Amazon CodeGuru Profiler API operations. - *

- *

- * Amazon CodeGuru Profiler collects runtime performance data from your live applications, and provides - * recommendations that can help you fine-tune your application performance. Using machine learning - * algorithms, CodeGuru Profiler can help you find your most expensive lines of code and suggest ways you can - * improve efficiency and remove CPU bottlenecks. - *

- *

- * Amazon CodeGuru Profiler provides different visualizations of profiling data to help you identify what code is - * running on the CPU, see how much time is consumed, and suggest ways to reduce CPU utilization. - *

- * - *

Amazon CodeGuru Profiler currently supports applications written in all Java virtual machine (JVM) - * languages and Python. While CodeGuru Profiler supports both visualizations and recommendations for applications - * written in Java, it can also generate visualizations and a subset of recommendations for - * applications written in other JVM languages and Python.

- *
- *

- * For more information, see What is Amazon CodeGuru Profiler in - * the Amazon CodeGuru Profiler User Guide. - *

- */ -export class CodeGuruProfiler extends CodeGuruProfilerClient { +const commands = { + AddNotificationChannelsCommand, + BatchGetFrameMetricDataCommand, + ConfigureAgentCommand, + CreateProfilingGroupCommand, + DeleteProfilingGroupCommand, + DescribeProfilingGroupCommand, + GetFindingsReportAccountSummaryCommand, + GetNotificationConfigurationCommand, + GetPolicyCommand, + GetProfileCommand, + GetRecommendationsCommand, + ListFindingsReportsCommand, + ListProfileTimesCommand, + ListProfilingGroupsCommand, + ListTagsForResourceCommand, + PostAgentProfileCommand, + PutPermissionCommand, + RemoveNotificationChannelCommand, + RemovePermissionCommand, + SubmitFeedbackCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateProfilingGroupCommand, +}; + +export interface CodeGuruProfiler { /** - * @public - *

Add up to 2 anomaly notifications channels for a profiling group.

+ * @see {@link AddNotificationChannelsCommand} */ - public addNotificationChannels( + addNotificationChannels( args: AddNotificationChannelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public addNotificationChannels( + addNotificationChannels( args: AddNotificationChannelsCommandInput, cb: (err: any, data?: AddNotificationChannelsCommandOutput) => void ): void; - public addNotificationChannels( + addNotificationChannels( args: AddNotificationChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddNotificationChannelsCommandOutput) => void ): void; - public addNotificationChannels( - args: AddNotificationChannelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddNotificationChannelsCommandOutput) => void), - cb?: (err: any, data?: AddNotificationChannelsCommandOutput) => void - ): Promise | void { - const command = new AddNotificationChannelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns the time series of values for a requested list - * of frame metrics from a time period.

+ * @see {@link BatchGetFrameMetricDataCommand} */ - public batchGetFrameMetricData( + batchGetFrameMetricData( args: BatchGetFrameMetricDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetFrameMetricData( + batchGetFrameMetricData( args: BatchGetFrameMetricDataCommandInput, cb: (err: any, data?: BatchGetFrameMetricDataCommandOutput) => void ): void; - public batchGetFrameMetricData( + batchGetFrameMetricData( args: BatchGetFrameMetricDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetFrameMetricDataCommandOutput) => void ): void; - public batchGetFrameMetricData( - args: BatchGetFrameMetricDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetFrameMetricDataCommandOutput) => void), - cb?: (err: any, data?: BatchGetFrameMetricDataCommandOutput) => void - ): Promise | void { - const command = new BatchGetFrameMetricDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Used by profiler agents to report their current state and to receive remote - * configuration updates. For example, ConfigureAgent can be used - * to tell an agent whether to profile or not and for how long to return profiling data. - *

+ * @see {@link ConfigureAgentCommand} */ - public configureAgent( + configureAgent( args: ConfigureAgentCommandInput, options?: __HttpHandlerOptions ): Promise; - public configureAgent( - args: ConfigureAgentCommandInput, - cb: (err: any, data?: ConfigureAgentCommandOutput) => void - ): void; - public configureAgent( + configureAgent(args: ConfigureAgentCommandInput, cb: (err: any, data?: ConfigureAgentCommandOutput) => void): void; + configureAgent( args: ConfigureAgentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfigureAgentCommandOutput) => void ): void; - public configureAgent( - args: ConfigureAgentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConfigureAgentCommandOutput) => void), - cb?: (err: any, data?: ConfigureAgentCommandOutput) => void - ): Promise | void { - const command = new ConfigureAgentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a profiling group.

+ * @see {@link CreateProfilingGroupCommand} */ - public createProfilingGroup( + createProfilingGroup( args: CreateProfilingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createProfilingGroup( + createProfilingGroup( args: CreateProfilingGroupCommandInput, cb: (err: any, data?: CreateProfilingGroupCommandOutput) => void ): void; - public createProfilingGroup( + createProfilingGroup( args: CreateProfilingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProfilingGroupCommandOutput) => void ): void; - public createProfilingGroup( - args: CreateProfilingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProfilingGroupCommandOutput) => void), - cb?: (err: any, data?: CreateProfilingGroupCommandOutput) => void - ): Promise | void { - const command = new CreateProfilingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a profiling group.

+ * @see {@link DeleteProfilingGroupCommand} */ - public deleteProfilingGroup( + deleteProfilingGroup( args: DeleteProfilingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteProfilingGroup( + deleteProfilingGroup( args: DeleteProfilingGroupCommandInput, cb: (err: any, data?: DeleteProfilingGroupCommandOutput) => void ): void; - public deleteProfilingGroup( + deleteProfilingGroup( args: DeleteProfilingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProfilingGroupCommandOutput) => void ): void; - public deleteProfilingGroup( - args: DeleteProfilingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProfilingGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteProfilingGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteProfilingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns a - * ProfilingGroupDescription - * - * object that contains information about the requested profiling group. - *

+ * @see {@link DescribeProfilingGroupCommand} */ - public describeProfilingGroup( + describeProfilingGroup( args: DescribeProfilingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProfilingGroup( + describeProfilingGroup( args: DescribeProfilingGroupCommandInput, cb: (err: any, data?: DescribeProfilingGroupCommandOutput) => void ): void; - public describeProfilingGroup( + describeProfilingGroup( args: DescribeProfilingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProfilingGroupCommandOutput) => void ): void; - public describeProfilingGroup( - args: DescribeProfilingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProfilingGroupCommandOutput) => void), - cb?: (err: any, data?: DescribeProfilingGroupCommandOutput) => void - ): Promise | void { - const command = new DescribeProfilingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns a list of - * - * FindingsReportSummary - * - * objects that contain analysis results for all profiling groups in your AWS account. - *

+ * @see {@link GetFindingsReportAccountSummaryCommand} */ - public getFindingsReportAccountSummary( + getFindingsReportAccountSummary( args: GetFindingsReportAccountSummaryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFindingsReportAccountSummary( + getFindingsReportAccountSummary( args: GetFindingsReportAccountSummaryCommandInput, cb: (err: any, data?: GetFindingsReportAccountSummaryCommandOutput) => void ): void; - public getFindingsReportAccountSummary( + getFindingsReportAccountSummary( args: GetFindingsReportAccountSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFindingsReportAccountSummaryCommandOutput) => void ): void; - public getFindingsReportAccountSummary( - args: GetFindingsReportAccountSummaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFindingsReportAccountSummaryCommandOutput) => void), - cb?: (err: any, data?: GetFindingsReportAccountSummaryCommandOutput) => void - ): Promise | void { - const command = new GetFindingsReportAccountSummaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the current configuration for anomaly notifications for a profiling group.

+ * @see {@link GetNotificationConfigurationCommand} */ - public getNotificationConfiguration( + getNotificationConfiguration( args: GetNotificationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getNotificationConfiguration( + getNotificationConfiguration( args: GetNotificationConfigurationCommandInput, cb: (err: any, data?: GetNotificationConfigurationCommandOutput) => void ): void; - public getNotificationConfiguration( + getNotificationConfiguration( args: GetNotificationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNotificationConfigurationCommandOutput) => void ): void; - public getNotificationConfiguration( - args: GetNotificationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetNotificationConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetNotificationConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetNotificationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns the JSON-formatted resource-based policy on a profiling group. - *

+ * @see {@link GetPolicyCommand} */ - public getPolicy(args: GetPolicyCommandInput, options?: __HttpHandlerOptions): Promise; - public getPolicy(args: GetPolicyCommandInput, cb: (err: any, data?: GetPolicyCommandOutput) => void): void; - public getPolicy( + getPolicy(args: GetPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + getPolicy(args: GetPolicyCommandInput, cb: (err: any, data?: GetPolicyCommandOutput) => void): void; + getPolicy( args: GetPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPolicyCommandOutput) => void ): void; - public getPolicy( - args: GetPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPolicyCommandOutput) => void), - cb?: (err: any, data?: GetPolicyCommandOutput) => void - ): Promise | void { - const command = new GetPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Gets the aggregated profile of a profiling group for a specified time range. - * Amazon CodeGuru Profiler collects posted agent profiles for a profiling group - * into aggregated profiles. - *

- * - * - *

- * Because aggregated profiles expire over time GetProfile is not idempotent. - *

- *
- * - *

- * Specify the time range for the requested aggregated profile using 1 or 2 of the following parameters: startTime, - * endTime, period. The maximum time range allowed is 7 days. If you specify all 3 parameters, - * an exception is thrown. If you specify only period, the latest aggregated profile is returned. - *

- * - *

- * Aggregated profiles are available with aggregation periods of 5 minutes, 1 hour, and 1 day, aligned to - * UTC. The aggregation period of an aggregated profile determines how long it is retained. For more - * information, see - * AggregatedProfileTime - * . The aggregated profile's aggregation period determines how long - * it is retained by CodeGuru Profiler. - *

- * - *
    - *
  • - *

    - * If the aggregation period is 5 minutes, the aggregated profile is retained for 15 days. - *

    - *
  • - *
  • - *

    - * If the aggregation period is 1 hour, the aggregated profile is retained for 60 days. - *

    - *
  • - *
  • - *

    - * If the aggregation period is 1 day, the aggregated profile is retained for 3 years. - *

    - *
  • - *
- * - *

There are two use cases for calling GetProfile.

- *
    - *
  1. - *

    - * If you want to return an aggregated profile that already exists, use - * - * ListProfileTimes - * to - * view the time ranges of existing aggregated profiles. Use them in a GetProfile request to return a specific, - * existing aggregated profile. - *

    - *
  2. - *
  3. - *

    - * If you want to return an aggregated profile for a time range that doesn't align with an existing aggregated profile, - * then CodeGuru Profiler makes a best effort to combine existing aggregated profiles from the requested time - * range and return them as one aggregated profile. - *

    - * - *

    If aggregated profiles do not exist for the full time range requested, then - * aggregated profiles for a smaller time range are returned. For example, if the - * requested time range is from 00:00 to 00:20, and the existing aggregated profiles are - * from 00:15 and 00:25, then the aggregated profiles from 00:15 to 00:20 are returned.

    - * - * - *
  4. - *
+ * @see {@link GetProfileCommand} */ - public getProfile(args: GetProfileCommandInput, options?: __HttpHandlerOptions): Promise; - public getProfile(args: GetProfileCommandInput, cb: (err: any, data?: GetProfileCommandOutput) => void): void; - public getProfile( + getProfile(args: GetProfileCommandInput, options?: __HttpHandlerOptions): Promise; + getProfile(args: GetProfileCommandInput, cb: (err: any, data?: GetProfileCommandOutput) => void): void; + getProfile( args: GetProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProfileCommandOutput) => void ): void; - public getProfile( - args: GetProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetProfileCommandOutput) => void), - cb?: (err: any, data?: GetProfileCommandOutput) => void - ): Promise | void { - const command = new GetProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns a list of - * - * Recommendation - * - * objects that contain recommendations for a profiling group for a given time period. A list of - * - * Anomaly - * - * objects that contains details about anomalies detected in the profiling group for the same time period is also - * returned. - *

+ * @see {@link GetRecommendationsCommand} */ - public getRecommendations( + getRecommendations( args: GetRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRecommendations( + getRecommendations( args: GetRecommendationsCommandInput, cb: (err: any, data?: GetRecommendationsCommandOutput) => void ): void; - public getRecommendations( + getRecommendations( args: GetRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRecommendationsCommandOutput) => void ): void; - public getRecommendations( - args: GetRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRecommendationsCommandOutput) => void), - cb?: (err: any, data?: GetRecommendationsCommandOutput) => void - ): Promise | void { - const command = new GetRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the available reports for a given profiling group and time range.

+ * @see {@link ListFindingsReportsCommand} */ - public listFindingsReports( + listFindingsReports( args: ListFindingsReportsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFindingsReports( + listFindingsReports( args: ListFindingsReportsCommandInput, cb: (err: any, data?: ListFindingsReportsCommandOutput) => void ): void; - public listFindingsReports( + listFindingsReports( args: ListFindingsReportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFindingsReportsCommandOutput) => void ): void; - public listFindingsReports( - args: ListFindingsReportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFindingsReportsCommandOutput) => void), - cb?: (err: any, data?: ListFindingsReportsCommandOutput) => void - ): Promise | void { - const command = new ListFindingsReportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the start times of the available aggregated profiles of a profiling group - * for an aggregation period within the specified time range.

+ * @see {@link ListProfileTimesCommand} */ - public listProfileTimes( + listProfileTimes( args: ListProfileTimesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProfileTimes( + listProfileTimes( args: ListProfileTimesCommandInput, cb: (err: any, data?: ListProfileTimesCommandOutput) => void ): void; - public listProfileTimes( + listProfileTimes( args: ListProfileTimesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProfileTimesCommandOutput) => void ): void; - public listProfileTimes( - args: ListProfileTimesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProfileTimesCommandOutput) => void), - cb?: (err: any, data?: ListProfileTimesCommandOutput) => void - ): Promise | void { - const command = new ListProfileTimesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns a list of profiling groups. The profiling groups are returned as - * - * ProfilingGroupDescription - * - * objects. - *

+ * @see {@link ListProfilingGroupsCommand} */ - public listProfilingGroups( + listProfilingGroups( args: ListProfilingGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProfilingGroups( + listProfilingGroups( args: ListProfilingGroupsCommandInput, cb: (err: any, data?: ListProfilingGroupsCommandOutput) => void ): void; - public listProfilingGroups( + listProfilingGroups( args: ListProfilingGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProfilingGroupsCommandOutput) => void ): void; - public listProfilingGroups( - args: ListProfilingGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProfilingGroupsCommandOutput) => void), - cb?: (err: any, data?: ListProfilingGroupsCommandOutput) => void - ): Promise | void { - const command = new ListProfilingGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns a list of the tags that are assigned to a specified resource. - *

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Submits profiling data to an aggregated profile of a profiling group. To get an - * aggregated profile that is created with this profiling data, use - * - * GetProfile - * . - *

+ * @see {@link PostAgentProfileCommand} */ - public postAgentProfile( + postAgentProfile( args: PostAgentProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public postAgentProfile( + postAgentProfile( args: PostAgentProfileCommandInput, cb: (err: any, data?: PostAgentProfileCommandOutput) => void ): void; - public postAgentProfile( + postAgentProfile( args: PostAgentProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PostAgentProfileCommandOutput) => void ): void; - public postAgentProfile( - args: PostAgentProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PostAgentProfileCommandOutput) => void), - cb?: (err: any, data?: PostAgentProfileCommandOutput) => void - ): Promise | void { - const command = new PostAgentProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Adds permissions to a profiling group's resource-based policy - * that are provided using an action group. If a profiling group doesn't have - * a resource-based policy, one is created for it using the permissions in the action group and - * the roles and users in the principals parameter. - *

- * - *

The one supported action group that can be added is agentPermission - * which grants ConfigureAgent and PostAgent permissions. For - * more information, see Resource-based - * policies in CodeGuru Profiler in the Amazon CodeGuru Profiler User - * Guide, - * ConfigureAgent - * , and - * PostAgentProfile - * .

- * - *

- * The first time you call PutPermission on a profiling group, do not specify a revisionId because - * it doesn't have a resource-based policy. Subsequent calls must provide a revisionId to specify - * which revision of the resource-based policy to add the permissions to. - *

- * - *

- * The response contains the profiling group's JSON-formatted resource policy. - *

+ * @see {@link PutPermissionCommand} */ - public putPermission( - args: PutPermissionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putPermission( - args: PutPermissionCommandInput, - cb: (err: any, data?: PutPermissionCommandOutput) => void - ): void; - public putPermission( + putPermission(args: PutPermissionCommandInput, options?: __HttpHandlerOptions): Promise; + putPermission(args: PutPermissionCommandInput, cb: (err: any, data?: PutPermissionCommandOutput) => void): void; + putPermission( args: PutPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPermissionCommandOutput) => void ): void; - public putPermission( - args: PutPermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutPermissionCommandOutput) => void), - cb?: (err: any, data?: PutPermissionCommandOutput) => void - ): Promise | void { - const command = new PutPermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Remove one anomaly notifications channel for a profiling group.

+ * @see {@link RemoveNotificationChannelCommand} */ - public removeNotificationChannel( + removeNotificationChannel( args: RemoveNotificationChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeNotificationChannel( + removeNotificationChannel( args: RemoveNotificationChannelCommandInput, cb: (err: any, data?: RemoveNotificationChannelCommandOutput) => void ): void; - public removeNotificationChannel( + removeNotificationChannel( args: RemoveNotificationChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveNotificationChannelCommandOutput) => void ): void; - public removeNotificationChannel( - args: RemoveNotificationChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveNotificationChannelCommandOutput) => void), - cb?: (err: any, data?: RemoveNotificationChannelCommandOutput) => void - ): Promise | void { - const command = new RemoveNotificationChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes permissions from a profiling group's resource-based policy that are provided - * using an action group. The one supported action group that can be removed is - * agentPermission which grants ConfigureAgent and - * PostAgent permissions. For more information, see Resource-based policies in CodeGuru Profiler in the Amazon - * CodeGuru Profiler User Guide, - * ConfigureAgent - * , and - * PostAgentProfile - * .

+ * @see {@link RemovePermissionCommand} */ - public removePermission( + removePermission( args: RemovePermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public removePermission( + removePermission( args: RemovePermissionCommandInput, cb: (err: any, data?: RemovePermissionCommandOutput) => void ): void; - public removePermission( + removePermission( args: RemovePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemovePermissionCommandOutput) => void ): void; - public removePermission( - args: RemovePermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemovePermissionCommandOutput) => void), - cb?: (err: any, data?: RemovePermissionCommandOutput) => void - ): Promise | void { - const command = new RemovePermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is - * useful or not.

+ * @see {@link SubmitFeedbackCommand} */ - public submitFeedback( + submitFeedback( args: SubmitFeedbackCommandInput, options?: __HttpHandlerOptions ): Promise; - public submitFeedback( - args: SubmitFeedbackCommandInput, - cb: (err: any, data?: SubmitFeedbackCommandOutput) => void - ): void; - public submitFeedback( + submitFeedback(args: SubmitFeedbackCommandInput, cb: (err: any, data?: SubmitFeedbackCommandOutput) => void): void; + submitFeedback( args: SubmitFeedbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubmitFeedbackCommandOutput) => void ): void; - public submitFeedback( - args: SubmitFeedbackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SubmitFeedbackCommandOutput) => void), - cb?: (err: any, data?: SubmitFeedbackCommandOutput) => void - ): Promise | void { - const command = new SubmitFeedbackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Use to assign one or more tags to a resource. - *

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Use to remove one or more tags from a resource. - *

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a profiling group.

+ * @see {@link UpdateProfilingGroupCommand} */ - public updateProfilingGroup( + updateProfilingGroup( args: UpdateProfilingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateProfilingGroup( + updateProfilingGroup( args: UpdateProfilingGroupCommandInput, cb: (err: any, data?: UpdateProfilingGroupCommandOutput) => void ): void; - public updateProfilingGroup( + updateProfilingGroup( args: UpdateProfilingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProfilingGroupCommandOutput) => void ): void; - public updateProfilingGroup( - args: UpdateProfilingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProfilingGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateProfilingGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateProfilingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

+ * This section provides documentation for the Amazon CodeGuru Profiler API operations. + *

+ *

+ * Amazon CodeGuru Profiler collects runtime performance data from your live applications, and provides + * recommendations that can help you fine-tune your application performance. Using machine learning + * algorithms, CodeGuru Profiler can help you find your most expensive lines of code and suggest ways you can + * improve efficiency and remove CPU bottlenecks. + *

+ *

+ * Amazon CodeGuru Profiler provides different visualizations of profiling data to help you identify what code is + * running on the CPU, see how much time is consumed, and suggest ways to reduce CPU utilization. + *

+ * + *

Amazon CodeGuru Profiler currently supports applications written in all Java virtual machine (JVM) + * languages and Python. While CodeGuru Profiler supports both visualizations and recommendations for applications + * written in Java, it can also generate visualizations and a subset of recommendations for + * applications written in other JVM languages and Python.

+ *
+ *

+ * For more information, see What is Amazon CodeGuru Profiler in + * the Amazon CodeGuru Profiler User Guide. + *

+ */ +export class CodeGuruProfiler extends CodeGuruProfilerClient implements CodeGuruProfiler {} +createAggregatedClient(commands, CodeGuruProfiler); diff --git a/clients/client-codepipeline/src/CodePipeline.ts b/clients/client-codepipeline/src/CodePipeline.ts index 472c092ea192..98afbca75623 100644 --- a/clients/client-codepipeline/src/CodePipeline.ts +++ b/clients/client-codepipeline/src/CodePipeline.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CodePipelineClient } from "./CodePipelineClient"; +import { CodePipelineClient, CodePipelineClientConfig } from "./CodePipelineClient"; import { AcknowledgeJobCommand, AcknowledgeJobCommandInput, @@ -182,1558 +183,835 @@ import { UpdatePipelineCommandOutput, } from "./commands/UpdatePipelineCommand"; -/** - * @public - * AWS CodePipeline - *

- * Overview - *

- *

This is the AWS CodePipeline API Reference. This guide provides descriptions of the - * actions and data types for AWS CodePipeline. Some functionality for your pipeline can - * only be configured through the API. For more information, see the AWS - * CodePipeline User Guide.

- *

You can use the AWS CodePipeline API to work with pipelines, stages, actions, and - * transitions.

- *

- * Pipelines are models of automated release processes. Each pipeline - * is uniquely named, and consists of stages, actions, and transitions.

- *

You can work with pipelines by calling:

- *
    - *
  • - *

    - * CreatePipeline, which creates a uniquely named - * pipeline.

    - *
  • - *
  • - *

    - * DeletePipeline, which deletes the specified - * pipeline.

    - *
  • - *
  • - *

    - * GetPipeline, which returns information about the pipeline - * structure and pipeline metadata, including the pipeline Amazon Resource Name - * (ARN).

    - *
  • - *
  • - *

    - * GetPipelineExecution, which returns information about a - * specific execution of a pipeline.

    - *
  • - *
  • - *

    - * GetPipelineState, which returns information about the current - * state of the stages and actions of a pipeline.

    - *
  • - *
  • - *

    - * ListActionExecutions, which returns action-level details - * for past executions. The details include full stage and action-level details, - * including individual action duration, status, any errors that occurred during - * the execution, and input and output artifact location details.

    - *
  • - *
  • - *

    - * ListPipelines, which gets a summary of all of the pipelines - * associated with your account.

    - *
  • - *
  • - *

    - * ListPipelineExecutions, which gets a summary of the most - * recent executions for a pipeline.

    - *
  • - *
  • - *

    - * StartPipelineExecution, which runs the most recent revision of - * an artifact through the pipeline.

    - *
  • - *
  • - *

    - * StopPipelineExecution, which stops the specified pipeline - * execution from continuing through the pipeline.

    - *
  • - *
  • - *

    - * UpdatePipeline, which updates a pipeline with edits or changes - * to the structure of the pipeline.

    - *
  • - *
- *

Pipelines include stages. Each stage contains one or more - * actions that must complete before the next stage begins. A stage results in success or - * failure. If a stage fails, the pipeline stops at that stage and remains stopped until - * either a new version of an artifact appears in the source location, or a user takes - * action to rerun the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the - * status of stages in the pipeline, or GetPipeline, which returns the - * entire structure of the pipeline, including the stages of that pipeline. For more - * information about the structure of stages and actions, see AWS CodePipeline - * Pipeline Structure Reference.

- *

Pipeline stages include actions that are categorized into - * categories such as source or build actions performed in a stage of a pipeline. For - * example, you can use a source action to import artifacts into a pipeline from a source - * such as Amazon S3. Like stages, you do not work with actions directly in most cases, but - * you do define and interact with actions when working with pipeline operations such as - * CreatePipeline and GetPipelineState. Valid - * action categories are:

- *
    - *
  • - *

    Source

    - *
  • - *
  • - *

    Build

    - *
  • - *
  • - *

    Test

    - *
  • - *
  • - *

    Deploy

    - *
  • - *
  • - *

    Approval

    - *
  • - *
  • - *

    Invoke

    - *
  • - *
- *

Pipelines also include transitions, which allow the transition - * of artifacts from one stage to the next in a pipeline after the actions in one stage - * complete.

- *

You can work with transitions by calling:

- *
    - *
  • - *

    - * DisableStageTransition, which prevents artifacts from - * transitioning to the next stage in a pipeline.

    - *
  • - *
  • - *

    - * EnableStageTransition, which enables transition of artifacts - * between stages in a pipeline.

    - *
  • - *
- *

- * Using the API to integrate with AWS CodePipeline - *

- *

For third-party integrators or developers who want to create their own integrations - * with AWS CodePipeline, the expected sequence varies from the standard API user. To - * integrate with AWS CodePipeline, developers need to work with the following - * items:

- *

- * Jobs, which are instances of an action. For - * example, a job for a source action might import a revision of an artifact from a source.

- *

You can work with jobs by calling:

- *
    - *
  • - *

    - * AcknowledgeJob, which confirms whether a job worker has - * received the specified job.

    - *
  • - *
  • - *

    - * GetJobDetails, which returns the details of a job.

    - *
  • - *
  • - *

    - * PollForJobs, which determines whether there are any jobs to - * act on.

    - *
  • - *
  • - *

    - * PutJobFailureResult, which provides details of a job failure. - *

    - *
  • - *
  • - *

    - * PutJobSuccessResult, which provides details of a job - * success.

    - *
  • - *
- *

- * Third party jobs, which are instances of an action - * created by a partner action and integrated into AWS CodePipeline. Partner actions are - * created by members of the AWS Partner Network.

- *

You can work with third party jobs by calling:

- * - */ -export class CodePipeline extends CodePipelineClient { +const commands = { + AcknowledgeJobCommand, + AcknowledgeThirdPartyJobCommand, + CreateCustomActionTypeCommand, + CreatePipelineCommand, + DeleteCustomActionTypeCommand, + DeletePipelineCommand, + DeleteWebhookCommand, + DeregisterWebhookWithThirdPartyCommand, + DisableStageTransitionCommand, + EnableStageTransitionCommand, + GetActionTypeCommand, + GetJobDetailsCommand, + GetPipelineCommand, + GetPipelineExecutionCommand, + GetPipelineStateCommand, + GetThirdPartyJobDetailsCommand, + ListActionExecutionsCommand, + ListActionTypesCommand, + ListPipelineExecutionsCommand, + ListPipelinesCommand, + ListTagsForResourceCommand, + ListWebhooksCommand, + PollForJobsCommand, + PollForThirdPartyJobsCommand, + PutActionRevisionCommand, + PutApprovalResultCommand, + PutJobFailureResultCommand, + PutJobSuccessResultCommand, + PutThirdPartyJobFailureResultCommand, + PutThirdPartyJobSuccessResultCommand, + PutWebhookCommand, + RegisterWebhookWithThirdPartyCommand, + RetryStageExecutionCommand, + StartPipelineExecutionCommand, + StopPipelineExecutionCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateActionTypeCommand, + UpdatePipelineCommand, +}; + +export interface CodePipeline { /** - * @public - *

Returns information about a specified job and whether that job has been received by - * the job worker. Used for custom actions only.

+ * @see {@link AcknowledgeJobCommand} */ - public acknowledgeJob( + acknowledgeJob( args: AcknowledgeJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public acknowledgeJob( - args: AcknowledgeJobCommandInput, - cb: (err: any, data?: AcknowledgeJobCommandOutput) => void - ): void; - public acknowledgeJob( + acknowledgeJob(args: AcknowledgeJobCommandInput, cb: (err: any, data?: AcknowledgeJobCommandOutput) => void): void; + acknowledgeJob( args: AcknowledgeJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcknowledgeJobCommandOutput) => void ): void; - public acknowledgeJob( - args: AcknowledgeJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcknowledgeJobCommandOutput) => void), - cb?: (err: any, data?: AcknowledgeJobCommandOutput) => void - ): Promise | void { - const command = new AcknowledgeJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Confirms a job worker has received the specified job. Used for partner actions - * only.

+ * @see {@link AcknowledgeThirdPartyJobCommand} */ - public acknowledgeThirdPartyJob( + acknowledgeThirdPartyJob( args: AcknowledgeThirdPartyJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public acknowledgeThirdPartyJob( + acknowledgeThirdPartyJob( args: AcknowledgeThirdPartyJobCommandInput, cb: (err: any, data?: AcknowledgeThirdPartyJobCommandOutput) => void ): void; - public acknowledgeThirdPartyJob( + acknowledgeThirdPartyJob( args: AcknowledgeThirdPartyJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcknowledgeThirdPartyJobCommandOutput) => void ): void; - public acknowledgeThirdPartyJob( - args: AcknowledgeThirdPartyJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcknowledgeThirdPartyJobCommandOutput) => void), - cb?: (err: any, data?: AcknowledgeThirdPartyJobCommandOutput) => void - ): Promise | void { - const command = new AcknowledgeThirdPartyJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new custom action that can be used in all pipelines associated with the - * AWS account. Only used for custom actions.

+ * @see {@link CreateCustomActionTypeCommand} */ - public createCustomActionType( + createCustomActionType( args: CreateCustomActionTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCustomActionType( + createCustomActionType( args: CreateCustomActionTypeCommandInput, cb: (err: any, data?: CreateCustomActionTypeCommandOutput) => void ): void; - public createCustomActionType( + createCustomActionType( args: CreateCustomActionTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomActionTypeCommandOutput) => void ): void; - public createCustomActionType( - args: CreateCustomActionTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCustomActionTypeCommandOutput) => void), - cb?: (err: any, data?: CreateCustomActionTypeCommandOutput) => void - ): Promise | void { - const command = new CreateCustomActionTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a pipeline.

- * - *

In the pipeline structure, you must include either artifactStore - * or artifactStores in your pipeline, but you cannot use both. If you - * create a cross-region action in your pipeline, you must use - * artifactStores.

- *
+ * @see {@link CreatePipelineCommand} */ - public createPipeline( + createPipeline( args: CreatePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPipeline( - args: CreatePipelineCommandInput, - cb: (err: any, data?: CreatePipelineCommandOutput) => void - ): void; - public createPipeline( + createPipeline(args: CreatePipelineCommandInput, cb: (err: any, data?: CreatePipelineCommandOutput) => void): void; + createPipeline( args: CreatePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePipelineCommandOutput) => void ): void; - public createPipeline( - args: CreatePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePipelineCommandOutput) => void), - cb?: (err: any, data?: CreatePipelineCommandOutput) => void - ): Promise | void { - const command = new CreatePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Marks a custom action as deleted. PollForJobs for the custom action - * fails after the action is marked for deletion. Used for custom actions only.

- * - *

To re-create a custom action after it has been deleted you must use a string in - * the version field that has never been used before. This string can be an incremented - * version number, for example. To restore a deleted custom action, use a JSON file - * that is identical to the deleted action, including the original string in the - * version field.

- *
+ * @see {@link DeleteCustomActionTypeCommand} */ - public deleteCustomActionType( + deleteCustomActionType( args: DeleteCustomActionTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCustomActionType( + deleteCustomActionType( args: DeleteCustomActionTypeCommandInput, cb: (err: any, data?: DeleteCustomActionTypeCommandOutput) => void ): void; - public deleteCustomActionType( + deleteCustomActionType( args: DeleteCustomActionTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomActionTypeCommandOutput) => void ): void; - public deleteCustomActionType( - args: DeleteCustomActionTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCustomActionTypeCommandOutput) => void), - cb?: (err: any, data?: DeleteCustomActionTypeCommandOutput) => void - ): Promise | void { - const command = new DeleteCustomActionTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified pipeline.

+ * @see {@link DeletePipelineCommand} */ - public deletePipeline( + deletePipeline( args: DeletePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePipeline( - args: DeletePipelineCommandInput, - cb: (err: any, data?: DeletePipelineCommandOutput) => void - ): void; - public deletePipeline( + deletePipeline(args: DeletePipelineCommandInput, cb: (err: any, data?: DeletePipelineCommandOutput) => void): void; + deletePipeline( args: DeletePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePipelineCommandOutput) => void ): void; - public deletePipeline( - args: DeletePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePipelineCommandOutput) => void), - cb?: (err: any, data?: DeletePipelineCommandOutput) => void - ): Promise | void { - const command = new DeletePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a previously created webhook by name. Deleting the webhook stops AWS - * CodePipeline from starting a pipeline every time an external event occurs. The API - * returns successfully when trying to delete a webhook that is already deleted. If a - * deleted webhook is re-created by calling PutWebhook with the same name, it will have a - * different URL.

+ * @see {@link DeleteWebhookCommand} */ - public deleteWebhook( - args: DeleteWebhookCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteWebhook( - args: DeleteWebhookCommandInput, - cb: (err: any, data?: DeleteWebhookCommandOutput) => void - ): void; - public deleteWebhook( + deleteWebhook(args: DeleteWebhookCommandInput, options?: __HttpHandlerOptions): Promise; + deleteWebhook(args: DeleteWebhookCommandInput, cb: (err: any, data?: DeleteWebhookCommandOutput) => void): void; + deleteWebhook( args: DeleteWebhookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWebhookCommandOutput) => void ): void; - public deleteWebhook( - args: DeleteWebhookCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWebhookCommandOutput) => void), - cb?: (err: any, data?: DeleteWebhookCommandOutput) => void - ): Promise | void { - const command = new DeleteWebhookCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the connection between the webhook that was created by CodePipeline and the - * external tool with events to be detected. Currently supported only for webhooks that - * target an action type of GitHub.

+ * @see {@link DeregisterWebhookWithThirdPartyCommand} */ - public deregisterWebhookWithThirdParty( + deregisterWebhookWithThirdParty( args: DeregisterWebhookWithThirdPartyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterWebhookWithThirdParty( + deregisterWebhookWithThirdParty( args: DeregisterWebhookWithThirdPartyCommandInput, cb: (err: any, data?: DeregisterWebhookWithThirdPartyCommandOutput) => void ): void; - public deregisterWebhookWithThirdParty( + deregisterWebhookWithThirdParty( args: DeregisterWebhookWithThirdPartyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterWebhookWithThirdPartyCommandOutput) => void ): void; - public deregisterWebhookWithThirdParty( - args: DeregisterWebhookWithThirdPartyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterWebhookWithThirdPartyCommandOutput) => void), - cb?: (err: any, data?: DeregisterWebhookWithThirdPartyCommandOutput) => void - ): Promise | void { - const command = new DeregisterWebhookWithThirdPartyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Prevents artifacts in a pipeline from transitioning to the next stage in the - * pipeline.

+ * @see {@link DisableStageTransitionCommand} */ - public disableStageTransition( + disableStageTransition( args: DisableStageTransitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableStageTransition( + disableStageTransition( args: DisableStageTransitionCommandInput, cb: (err: any, data?: DisableStageTransitionCommandOutput) => void ): void; - public disableStageTransition( + disableStageTransition( args: DisableStageTransitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableStageTransitionCommandOutput) => void ): void; - public disableStageTransition( - args: DisableStageTransitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableStageTransitionCommandOutput) => void), - cb?: (err: any, data?: DisableStageTransitionCommandOutput) => void - ): Promise | void { - const command = new DisableStageTransitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables artifacts in a pipeline to transition to a stage in a pipeline.

+ * @see {@link EnableStageTransitionCommand} */ - public enableStageTransition( + enableStageTransition( args: EnableStageTransitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableStageTransition( + enableStageTransition( args: EnableStageTransitionCommandInput, cb: (err: any, data?: EnableStageTransitionCommandOutput) => void ): void; - public enableStageTransition( + enableStageTransition( args: EnableStageTransitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableStageTransitionCommandOutput) => void ): void; - public enableStageTransition( - args: EnableStageTransitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableStageTransitionCommandOutput) => void), - cb?: (err: any, data?: EnableStageTransitionCommandOutput) => void - ): Promise | void { - const command = new EnableStageTransitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about an action type created for an external provider, where the - * action is to be used by customers of the external provider. The action can be created - * with any supported integration model.

+ * @see {@link GetActionTypeCommand} */ - public getActionType( - args: GetActionTypeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getActionType( - args: GetActionTypeCommandInput, - cb: (err: any, data?: GetActionTypeCommandOutput) => void - ): void; - public getActionType( + getActionType(args: GetActionTypeCommandInput, options?: __HttpHandlerOptions): Promise; + getActionType(args: GetActionTypeCommandInput, cb: (err: any, data?: GetActionTypeCommandOutput) => void): void; + getActionType( args: GetActionTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetActionTypeCommandOutput) => void ): void; - public getActionType( - args: GetActionTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetActionTypeCommandOutput) => void), - cb?: (err: any, data?: GetActionTypeCommandOutput) => void - ): Promise | void { - const command = new GetActionTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a job. Used for custom actions only.

- * - *

When this API is called, AWS CodePipeline returns temporary credentials for the - * S3 bucket used to store artifacts for the pipeline, if the action requires access to - * that S3 bucket for input or output artifacts. This API also returns any secret - * values defined for the action.

- *
+ * @see {@link GetJobDetailsCommand} */ - public getJobDetails( - args: GetJobDetailsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getJobDetails( - args: GetJobDetailsCommandInput, - cb: (err: any, data?: GetJobDetailsCommandOutput) => void - ): void; - public getJobDetails( + getJobDetails(args: GetJobDetailsCommandInput, options?: __HttpHandlerOptions): Promise; + getJobDetails(args: GetJobDetailsCommandInput, cb: (err: any, data?: GetJobDetailsCommandOutput) => void): void; + getJobDetails( args: GetJobDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobDetailsCommandOutput) => void ): void; - public getJobDetails( - args: GetJobDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetJobDetailsCommandOutput) => void), - cb?: (err: any, data?: GetJobDetailsCommandOutput) => void - ): Promise | void { - const command = new GetJobDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the metadata, structure, stages, and actions of a pipeline. Can be used to - * return the entire structure of a pipeline in JSON format, which can then be modified and - * used to update the pipeline structure with UpdatePipeline.

+ * @see {@link GetPipelineCommand} */ - public getPipeline(args: GetPipelineCommandInput, options?: __HttpHandlerOptions): Promise; - public getPipeline(args: GetPipelineCommandInput, cb: (err: any, data?: GetPipelineCommandOutput) => void): void; - public getPipeline( + getPipeline(args: GetPipelineCommandInput, options?: __HttpHandlerOptions): Promise; + getPipeline(args: GetPipelineCommandInput, cb: (err: any, data?: GetPipelineCommandOutput) => void): void; + getPipeline( args: GetPipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPipelineCommandOutput) => void ): void; - public getPipeline( - args: GetPipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPipelineCommandOutput) => void), - cb?: (err: any, data?: GetPipelineCommandOutput) => void - ): Promise | void { - const command = new GetPipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about an execution of a pipeline, including details about - * artifacts, the pipeline execution ID, and the name, version, and status of the - * pipeline.

+ * @see {@link GetPipelineExecutionCommand} */ - public getPipelineExecution( + getPipelineExecution( args: GetPipelineExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPipelineExecution( + getPipelineExecution( args: GetPipelineExecutionCommandInput, cb: (err: any, data?: GetPipelineExecutionCommandOutput) => void ): void; - public getPipelineExecution( + getPipelineExecution( args: GetPipelineExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPipelineExecutionCommandOutput) => void ): void; - public getPipelineExecution( - args: GetPipelineExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPipelineExecutionCommandOutput) => void), - cb?: (err: any, data?: GetPipelineExecutionCommandOutput) => void - ): Promise | void { - const command = new GetPipelineExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the state of a pipeline, including the stages and - * actions.

- * - *

Values returned in the revisionId and revisionUrl - * fields indicate the source revision information, such as the commit ID, for the - * current state.

- *
+ * @see {@link GetPipelineStateCommand} */ - public getPipelineState( + getPipelineState( args: GetPipelineStateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPipelineState( + getPipelineState( args: GetPipelineStateCommandInput, cb: (err: any, data?: GetPipelineStateCommandOutput) => void ): void; - public getPipelineState( + getPipelineState( args: GetPipelineStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPipelineStateCommandOutput) => void ): void; - public getPipelineState( - args: GetPipelineStateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPipelineStateCommandOutput) => void), - cb?: (err: any, data?: GetPipelineStateCommandOutput) => void - ): Promise | void { - const command = new GetPipelineStateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Requests the details of a job for a third party action. Used for partner actions - * only.

- * - *

When this API is called, AWS CodePipeline returns temporary credentials for the - * S3 bucket used to store artifacts for the pipeline, if the action requires access to - * that S3 bucket for input or output artifacts. This API also returns any secret - * values defined for the action.

- *
+ * @see {@link GetThirdPartyJobDetailsCommand} */ - public getThirdPartyJobDetails( + getThirdPartyJobDetails( args: GetThirdPartyJobDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getThirdPartyJobDetails( + getThirdPartyJobDetails( args: GetThirdPartyJobDetailsCommandInput, cb: (err: any, data?: GetThirdPartyJobDetailsCommandOutput) => void ): void; - public getThirdPartyJobDetails( + getThirdPartyJobDetails( args: GetThirdPartyJobDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetThirdPartyJobDetailsCommandOutput) => void ): void; - public getThirdPartyJobDetails( - args: GetThirdPartyJobDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetThirdPartyJobDetailsCommandOutput) => void), - cb?: (err: any, data?: GetThirdPartyJobDetailsCommandOutput) => void - ): Promise | void { - const command = new GetThirdPartyJobDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the action executions that have occurred in a pipeline.

+ * @see {@link ListActionExecutionsCommand} */ - public listActionExecutions( + listActionExecutions( args: ListActionExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listActionExecutions( + listActionExecutions( args: ListActionExecutionsCommandInput, cb: (err: any, data?: ListActionExecutionsCommandOutput) => void ): void; - public listActionExecutions( + listActionExecutions( args: ListActionExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListActionExecutionsCommandOutput) => void ): void; - public listActionExecutions( - args: ListActionExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListActionExecutionsCommandOutput) => void), - cb?: (err: any, data?: ListActionExecutionsCommandOutput) => void - ): Promise | void { - const command = new ListActionExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a summary of all AWS CodePipeline action types associated with your - * account.

+ * @see {@link ListActionTypesCommand} */ - public listActionTypes( + listActionTypes( args: ListActionTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listActionTypes( - args: ListActionTypesCommandInput, - cb: (err: any, data?: ListActionTypesCommandOutput) => void - ): void; - public listActionTypes( + listActionTypes(args: ListActionTypesCommandInput, cb: (err: any, data?: ListActionTypesCommandOutput) => void): void; + listActionTypes( args: ListActionTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListActionTypesCommandOutput) => void ): void; - public listActionTypes( - args: ListActionTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListActionTypesCommandOutput) => void), - cb?: (err: any, data?: ListActionTypesCommandOutput) => void - ): Promise | void { - const command = new ListActionTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a summary of the most recent executions for a pipeline.

+ * @see {@link ListPipelineExecutionsCommand} */ - public listPipelineExecutions( + listPipelineExecutions( args: ListPipelineExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPipelineExecutions( + listPipelineExecutions( args: ListPipelineExecutionsCommandInput, cb: (err: any, data?: ListPipelineExecutionsCommandOutput) => void ): void; - public listPipelineExecutions( + listPipelineExecutions( args: ListPipelineExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPipelineExecutionsCommandOutput) => void ): void; - public listPipelineExecutions( - args: ListPipelineExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPipelineExecutionsCommandOutput) => void), - cb?: (err: any, data?: ListPipelineExecutionsCommandOutput) => void - ): Promise | void { - const command = new ListPipelineExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a summary of all of the pipelines associated with your account.

+ * @see {@link ListPipelinesCommand} */ - public listPipelines( - args: ListPipelinesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listPipelines( - args: ListPipelinesCommandInput, - cb: (err: any, data?: ListPipelinesCommandOutput) => void - ): void; - public listPipelines( + listPipelines(args: ListPipelinesCommandInput, options?: __HttpHandlerOptions): Promise; + listPipelines(args: ListPipelinesCommandInput, cb: (err: any, data?: ListPipelinesCommandOutput) => void): void; + listPipelines( args: ListPipelinesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPipelinesCommandOutput) => void ): void; - public listPipelines( - args: ListPipelinesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPipelinesCommandOutput) => void), - cb?: (err: any, data?: ListPipelinesCommandOutput) => void - ): Promise | void { - const command = new ListPipelinesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the set of key-value pairs (metadata) that are used to manage the - * resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a listing of all the webhooks in this AWS Region for this account. The output - * lists all webhooks and includes the webhook URL and ARN and the configuration for each - * webhook.

+ * @see {@link ListWebhooksCommand} */ - public listWebhooks( - args: ListWebhooksCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listWebhooks(args: ListWebhooksCommandInput, cb: (err: any, data?: ListWebhooksCommandOutput) => void): void; - public listWebhooks( + listWebhooks(args: ListWebhooksCommandInput, options?: __HttpHandlerOptions): Promise; + listWebhooks(args: ListWebhooksCommandInput, cb: (err: any, data?: ListWebhooksCommandOutput) => void): void; + listWebhooks( args: ListWebhooksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWebhooksCommandOutput) => void ): void; - public listWebhooks( - args: ListWebhooksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWebhooksCommandOutput) => void), - cb?: (err: any, data?: ListWebhooksCommandOutput) => void - ): Promise | void { - const command = new ListWebhooksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about any jobs for AWS CodePipeline to act on. - * PollForJobs is valid only for action types with "Custom" in the owner - * field. If the action type contains "AWS" or "ThirdParty" in the owner field, the - * PollForJobs action returns an error.

- * - *

When this API is called, AWS CodePipeline returns temporary credentials for the - * S3 bucket used to store artifacts for the pipeline, if the action requires access to - * that S3 bucket for input or output artifacts. This API also returns any secret - * values defined for the action.

- *
+ * @see {@link PollForJobsCommand} */ - public pollForJobs(args: PollForJobsCommandInput, options?: __HttpHandlerOptions): Promise; - public pollForJobs(args: PollForJobsCommandInput, cb: (err: any, data?: PollForJobsCommandOutput) => void): void; - public pollForJobs( + pollForJobs(args: PollForJobsCommandInput, options?: __HttpHandlerOptions): Promise; + pollForJobs(args: PollForJobsCommandInput, cb: (err: any, data?: PollForJobsCommandOutput) => void): void; + pollForJobs( args: PollForJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PollForJobsCommandOutput) => void ): void; - public pollForJobs( - args: PollForJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PollForJobsCommandOutput) => void), - cb?: (err: any, data?: PollForJobsCommandOutput) => void - ): Promise | void { - const command = new PollForJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Determines whether there are any third party jobs for a job worker to act on. Used - * for partner actions only.

- * - *

When this API is called, AWS CodePipeline returns temporary credentials for the - * S3 bucket used to store artifacts for the pipeline, if the action requires access to - * that S3 bucket for input or output artifacts.

- *
+ * @see {@link PollForThirdPartyJobsCommand} */ - public pollForThirdPartyJobs( + pollForThirdPartyJobs( args: PollForThirdPartyJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public pollForThirdPartyJobs( + pollForThirdPartyJobs( args: PollForThirdPartyJobsCommandInput, cb: (err: any, data?: PollForThirdPartyJobsCommandOutput) => void ): void; - public pollForThirdPartyJobs( + pollForThirdPartyJobs( args: PollForThirdPartyJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PollForThirdPartyJobsCommandOutput) => void ): void; - public pollForThirdPartyJobs( - args: PollForThirdPartyJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PollForThirdPartyJobsCommandOutput) => void), - cb?: (err: any, data?: PollForThirdPartyJobsCommandOutput) => void - ): Promise | void { - const command = new PollForThirdPartyJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides information to AWS CodePipeline about new revisions to a source.

+ * @see {@link PutActionRevisionCommand} */ - public putActionRevision( + putActionRevision( args: PutActionRevisionCommandInput, options?: __HttpHandlerOptions ): Promise; - public putActionRevision( + putActionRevision( args: PutActionRevisionCommandInput, cb: (err: any, data?: PutActionRevisionCommandOutput) => void ): void; - public putActionRevision( + putActionRevision( args: PutActionRevisionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutActionRevisionCommandOutput) => void ): void; - public putActionRevision( - args: PutActionRevisionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutActionRevisionCommandOutput) => void), - cb?: (err: any, data?: PutActionRevisionCommandOutput) => void - ): Promise | void { - const command = new PutActionRevisionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides the response to a manual approval request to AWS CodePipeline. Valid - * responses include Approved and Rejected.

+ * @see {@link PutApprovalResultCommand} */ - public putApprovalResult( + putApprovalResult( args: PutApprovalResultCommandInput, options?: __HttpHandlerOptions ): Promise; - public putApprovalResult( + putApprovalResult( args: PutApprovalResultCommandInput, cb: (err: any, data?: PutApprovalResultCommandOutput) => void ): void; - public putApprovalResult( + putApprovalResult( args: PutApprovalResultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutApprovalResultCommandOutput) => void ): void; - public putApprovalResult( - args: PutApprovalResultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutApprovalResultCommandOutput) => void), - cb?: (err: any, data?: PutApprovalResultCommandOutput) => void - ): Promise | void { - const command = new PutApprovalResultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Represents the failure of a job as returned to the pipeline by a job worker. Used - * for custom actions only.

+ * @see {@link PutJobFailureResultCommand} */ - public putJobFailureResult( + putJobFailureResult( args: PutJobFailureResultCommandInput, options?: __HttpHandlerOptions ): Promise; - public putJobFailureResult( + putJobFailureResult( args: PutJobFailureResultCommandInput, cb: (err: any, data?: PutJobFailureResultCommandOutput) => void ): void; - public putJobFailureResult( + putJobFailureResult( args: PutJobFailureResultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutJobFailureResultCommandOutput) => void ): void; - public putJobFailureResult( - args: PutJobFailureResultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutJobFailureResultCommandOutput) => void), - cb?: (err: any, data?: PutJobFailureResultCommandOutput) => void - ): Promise | void { - const command = new PutJobFailureResultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Represents the success of a job as returned to the pipeline by a job worker. Used - * for custom actions only.

+ * @see {@link PutJobSuccessResultCommand} */ - public putJobSuccessResult( + putJobSuccessResult( args: PutJobSuccessResultCommandInput, options?: __HttpHandlerOptions ): Promise; - public putJobSuccessResult( + putJobSuccessResult( args: PutJobSuccessResultCommandInput, cb: (err: any, data?: PutJobSuccessResultCommandOutput) => void ): void; - public putJobSuccessResult( + putJobSuccessResult( args: PutJobSuccessResultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutJobSuccessResultCommandOutput) => void ): void; - public putJobSuccessResult( - args: PutJobSuccessResultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutJobSuccessResultCommandOutput) => void), - cb?: (err: any, data?: PutJobSuccessResultCommandOutput) => void - ): Promise | void { - const command = new PutJobSuccessResultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Represents the failure of a third party job as returned to the pipeline by a job - * worker. Used for partner actions only.

+ * @see {@link PutThirdPartyJobFailureResultCommand} */ - public putThirdPartyJobFailureResult( + putThirdPartyJobFailureResult( args: PutThirdPartyJobFailureResultCommandInput, options?: __HttpHandlerOptions ): Promise; - public putThirdPartyJobFailureResult( + putThirdPartyJobFailureResult( args: PutThirdPartyJobFailureResultCommandInput, cb: (err: any, data?: PutThirdPartyJobFailureResultCommandOutput) => void ): void; - public putThirdPartyJobFailureResult( + putThirdPartyJobFailureResult( args: PutThirdPartyJobFailureResultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutThirdPartyJobFailureResultCommandOutput) => void ): void; - public putThirdPartyJobFailureResult( - args: PutThirdPartyJobFailureResultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutThirdPartyJobFailureResultCommandOutput) => void), - cb?: (err: any, data?: PutThirdPartyJobFailureResultCommandOutput) => void - ): Promise | void { - const command = new PutThirdPartyJobFailureResultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Represents the success of a third party job as returned to the pipeline by a job - * worker. Used for partner actions only.

+ * @see {@link PutThirdPartyJobSuccessResultCommand} */ - public putThirdPartyJobSuccessResult( + putThirdPartyJobSuccessResult( args: PutThirdPartyJobSuccessResultCommandInput, options?: __HttpHandlerOptions ): Promise; - public putThirdPartyJobSuccessResult( + putThirdPartyJobSuccessResult( args: PutThirdPartyJobSuccessResultCommandInput, cb: (err: any, data?: PutThirdPartyJobSuccessResultCommandOutput) => void ): void; - public putThirdPartyJobSuccessResult( + putThirdPartyJobSuccessResult( args: PutThirdPartyJobSuccessResultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutThirdPartyJobSuccessResultCommandOutput) => void ): void; - public putThirdPartyJobSuccessResult( - args: PutThirdPartyJobSuccessResultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutThirdPartyJobSuccessResultCommandOutput) => void), - cb?: (err: any, data?: PutThirdPartyJobSuccessResultCommandOutput) => void - ): Promise | void { - const command = new PutThirdPartyJobSuccessResultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Defines a webhook and returns a unique webhook URL generated by CodePipeline. This - * URL can be supplied to third party source hosting providers to call every time there's a - * code change. When CodePipeline receives a POST request on this URL, the pipeline defined - * in the webhook is started as long as the POST request satisfied the authentication and - * filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty - * and DeregisterWebhookWithThirdParty APIs can be used to automatically configure - * supported third parties to call the generated webhook URL.

+ * @see {@link PutWebhookCommand} */ - public putWebhook(args: PutWebhookCommandInput, options?: __HttpHandlerOptions): Promise; - public putWebhook(args: PutWebhookCommandInput, cb: (err: any, data?: PutWebhookCommandOutput) => void): void; - public putWebhook( + putWebhook(args: PutWebhookCommandInput, options?: __HttpHandlerOptions): Promise; + putWebhook(args: PutWebhookCommandInput, cb: (err: any, data?: PutWebhookCommandOutput) => void): void; + putWebhook( args: PutWebhookCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutWebhookCommandOutput) => void ): void; - public putWebhook( - args: PutWebhookCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutWebhookCommandOutput) => void), - cb?: (err: any, data?: PutWebhookCommandOutput) => void - ): Promise | void { - const command = new PutWebhookCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Configures a connection between the webhook that was created and the external tool - * with events to be detected.

+ * @see {@link RegisterWebhookWithThirdPartyCommand} */ - public registerWebhookWithThirdParty( + registerWebhookWithThirdParty( args: RegisterWebhookWithThirdPartyCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerWebhookWithThirdParty( + registerWebhookWithThirdParty( args: RegisterWebhookWithThirdPartyCommandInput, cb: (err: any, data?: RegisterWebhookWithThirdPartyCommandOutput) => void ): void; - public registerWebhookWithThirdParty( + registerWebhookWithThirdParty( args: RegisterWebhookWithThirdPartyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterWebhookWithThirdPartyCommandOutput) => void ): void; - public registerWebhookWithThirdParty( - args: RegisterWebhookWithThirdPartyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterWebhookWithThirdPartyCommandOutput) => void), - cb?: (err: any, data?: RegisterWebhookWithThirdPartyCommandOutput) => void - ): Promise | void { - const command = new RegisterWebhookWithThirdPartyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Resumes the pipeline execution by retrying the last failed actions in a stage. You - * can retry a stage immediately if any of the actions in the stage fail. When you retry, - * all actions that are still in progress continue working, and failed actions are - * triggered again.

+ * @see {@link RetryStageExecutionCommand} */ - public retryStageExecution( + retryStageExecution( args: RetryStageExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public retryStageExecution( + retryStageExecution( args: RetryStageExecutionCommandInput, cb: (err: any, data?: RetryStageExecutionCommandOutput) => void ): void; - public retryStageExecution( + retryStageExecution( args: RetryStageExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RetryStageExecutionCommandOutput) => void ): void; - public retryStageExecution( - args: RetryStageExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RetryStageExecutionCommandOutput) => void), - cb?: (err: any, data?: RetryStageExecutionCommandOutput) => void - ): Promise | void { - const command = new RetryStageExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts the specified pipeline. Specifically, it begins processing the latest commit - * to the source location specified as part of the pipeline.

+ * @see {@link StartPipelineExecutionCommand} */ - public startPipelineExecution( + startPipelineExecution( args: StartPipelineExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startPipelineExecution( + startPipelineExecution( args: StartPipelineExecutionCommandInput, cb: (err: any, data?: StartPipelineExecutionCommandOutput) => void ): void; - public startPipelineExecution( + startPipelineExecution( args: StartPipelineExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartPipelineExecutionCommandOutput) => void ): void; - public startPipelineExecution( - args: StartPipelineExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartPipelineExecutionCommandOutput) => void), - cb?: (err: any, data?: StartPipelineExecutionCommandOutput) => void - ): Promise | void { - const command = new StartPipelineExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops the specified pipeline execution. You choose to either stop the pipeline - * execution by completing in-progress actions without starting subsequent actions, or by - * abandoning in-progress actions. While completing or abandoning in-progress actions, the - * pipeline execution is in a Stopping state. After all in-progress actions - * are completed or abandoned, the pipeline execution is in a Stopped - * state.

+ * @see {@link StopPipelineExecutionCommand} */ - public stopPipelineExecution( + stopPipelineExecution( args: StopPipelineExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopPipelineExecution( + stopPipelineExecution( args: StopPipelineExecutionCommandInput, cb: (err: any, data?: StopPipelineExecutionCommandOutput) => void ): void; - public stopPipelineExecution( + stopPipelineExecution( args: StopPipelineExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopPipelineExecutionCommandOutput) => void ): void; - public stopPipelineExecution( - args: StopPipelineExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopPipelineExecutionCommandOutput) => void), - cb?: (err: any, data?: StopPipelineExecutionCommandOutput) => void - ): Promise | void { - const command = new StopPipelineExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds to or modifies the tags of the given resource. Tags are metadata that can be used - * to manage a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from an AWS resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an action type that was created with any supported integration model, where - * the action type is to be used by customers of the action type provider. Use a JSON file - * with the action definition and UpdateActionType to provide the full - * structure.

+ * @see {@link UpdateActionTypeCommand} */ - public updateActionType( + updateActionType( args: UpdateActionTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateActionType( + updateActionType( args: UpdateActionTypeCommandInput, cb: (err: any, data?: UpdateActionTypeCommandOutput) => void ): void; - public updateActionType( + updateActionType( args: UpdateActionTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateActionTypeCommandOutput) => void ): void; - public updateActionType( - args: UpdateActionTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateActionTypeCommandOutput) => void), - cb?: (err: any, data?: UpdateActionTypeCommandOutput) => void - ): Promise | void { - const command = new UpdateActionTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a specified pipeline with edits or changes to its structure. Use a JSON - * file with the pipeline structure and UpdatePipeline to provide the full - * structure of the pipeline. Updating the pipeline increases the version number of the - * pipeline by 1.

+ * @see {@link UpdatePipelineCommand} */ - public updatePipeline( + updatePipeline( args: UpdatePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePipeline( - args: UpdatePipelineCommandInput, - cb: (err: any, data?: UpdatePipelineCommandOutput) => void - ): void; - public updatePipeline( + updatePipeline(args: UpdatePipelineCommandInput, cb: (err: any, data?: UpdatePipelineCommandOutput) => void): void; + updatePipeline( args: UpdatePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePipelineCommandOutput) => void ): void; - public updatePipeline( - args: UpdatePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePipelineCommandOutput) => void), - cb?: (err: any, data?: UpdatePipelineCommandOutput) => void - ): Promise | void { - const command = new UpdatePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * AWS CodePipeline + *

+ * Overview + *

+ *

This is the AWS CodePipeline API Reference. This guide provides descriptions of the + * actions and data types for AWS CodePipeline. Some functionality for your pipeline can + * only be configured through the API. For more information, see the AWS + * CodePipeline User Guide.

+ *

You can use the AWS CodePipeline API to work with pipelines, stages, actions, and + * transitions.

+ *

+ * Pipelines are models of automated release processes. Each pipeline + * is uniquely named, and consists of stages, actions, and transitions.

+ *

You can work with pipelines by calling:

+ *
    + *
  • + *

    + * CreatePipeline, which creates a uniquely named + * pipeline.

    + *
  • + *
  • + *

    + * DeletePipeline, which deletes the specified + * pipeline.

    + *
  • + *
  • + *

    + * GetPipeline, which returns information about the pipeline + * structure and pipeline metadata, including the pipeline Amazon Resource Name + * (ARN).

    + *
  • + *
  • + *

    + * GetPipelineExecution, which returns information about a + * specific execution of a pipeline.

    + *
  • + *
  • + *

    + * GetPipelineState, which returns information about the current + * state of the stages and actions of a pipeline.

    + *
  • + *
  • + *

    + * ListActionExecutions, which returns action-level details + * for past executions. The details include full stage and action-level details, + * including individual action duration, status, any errors that occurred during + * the execution, and input and output artifact location details.

    + *
  • + *
  • + *

    + * ListPipelines, which gets a summary of all of the pipelines + * associated with your account.

    + *
  • + *
  • + *

    + * ListPipelineExecutions, which gets a summary of the most + * recent executions for a pipeline.

    + *
  • + *
  • + *

    + * StartPipelineExecution, which runs the most recent revision of + * an artifact through the pipeline.

    + *
  • + *
  • + *

    + * StopPipelineExecution, which stops the specified pipeline + * execution from continuing through the pipeline.

    + *
  • + *
  • + *

    + * UpdatePipeline, which updates a pipeline with edits or changes + * to the structure of the pipeline.

    + *
  • + *
+ *

Pipelines include stages. Each stage contains one or more + * actions that must complete before the next stage begins. A stage results in success or + * failure. If a stage fails, the pipeline stops at that stage and remains stopped until + * either a new version of an artifact appears in the source location, or a user takes + * action to rerun the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the + * status of stages in the pipeline, or GetPipeline, which returns the + * entire structure of the pipeline, including the stages of that pipeline. For more + * information about the structure of stages and actions, see AWS CodePipeline + * Pipeline Structure Reference.

+ *

Pipeline stages include actions that are categorized into + * categories such as source or build actions performed in a stage of a pipeline. For + * example, you can use a source action to import artifacts into a pipeline from a source + * such as Amazon S3. Like stages, you do not work with actions directly in most cases, but + * you do define and interact with actions when working with pipeline operations such as + * CreatePipeline and GetPipelineState. Valid + * action categories are:

+ *
    + *
  • + *

    Source

    + *
  • + *
  • + *

    Build

    + *
  • + *
  • + *

    Test

    + *
  • + *
  • + *

    Deploy

    + *
  • + *
  • + *

    Approval

    + *
  • + *
  • + *

    Invoke

    + *
  • + *
+ *

Pipelines also include transitions, which allow the transition + * of artifacts from one stage to the next in a pipeline after the actions in one stage + * complete.

+ *

You can work with transitions by calling:

+ *
    + *
  • + *

    + * DisableStageTransition, which prevents artifacts from + * transitioning to the next stage in a pipeline.

    + *
  • + *
  • + *

    + * EnableStageTransition, which enables transition of artifacts + * between stages in a pipeline.

    + *
  • + *
+ *

+ * Using the API to integrate with AWS CodePipeline + *

+ *

For third-party integrators or developers who want to create their own integrations + * with AWS CodePipeline, the expected sequence varies from the standard API user. To + * integrate with AWS CodePipeline, developers need to work with the following + * items:

+ *

+ * Jobs, which are instances of an action. For + * example, a job for a source action might import a revision of an artifact from a source.

+ *

You can work with jobs by calling:

+ *
    + *
  • + *

    + * AcknowledgeJob, which confirms whether a job worker has + * received the specified job.

    + *
  • + *
  • + *

    + * GetJobDetails, which returns the details of a job.

    + *
  • + *
  • + *

    + * PollForJobs, which determines whether there are any jobs to + * act on.

    + *
  • + *
  • + *

    + * PutJobFailureResult, which provides details of a job failure. + *

    + *
  • + *
  • + *

    + * PutJobSuccessResult, which provides details of a job + * success.

    + *
  • + *
+ *

+ * Third party jobs, which are instances of an action + * created by a partner action and integrated into AWS CodePipeline. Partner actions are + * created by members of the AWS Partner Network.

+ *

You can work with third party jobs by calling:

+ * + */ +export class CodePipeline extends CodePipelineClient implements CodePipeline {} +createAggregatedClient(commands, CodePipeline); diff --git a/clients/client-codestar-connections/src/CodeStarConnections.ts b/clients/client-codestar-connections/src/CodeStarConnections.ts index dc236005a9ba..23692e55e2b7 100644 --- a/clients/client-codestar-connections/src/CodeStarConnections.ts +++ b/clients/client-codestar-connections/src/CodeStarConnections.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CodeStarConnectionsClient } from "./CodeStarConnectionsClient"; +import { CodeStarConnectionsClient, CodeStarConnectionsClientConfig } from "./CodeStarConnectionsClient"; import { CreateConnectionCommand, CreateConnectionCommandInput, @@ -39,461 +40,258 @@ import { } from "./commands/UntagResourceCommand"; import { UpdateHostCommand, UpdateHostCommandInput, UpdateHostCommandOutput } from "./commands/UpdateHostCommand"; -/** - * @public - * AWS CodeStar Connections - *

This AWS CodeStar Connections API Reference provides descriptions and usage examples of - * the operations and data types for the AWS CodeStar Connections API. You can use the - * connections API to work with connections and installations.

- *

- * Connections are configurations that you use to connect AWS - * resources to external code repositories. Each connection is a resource that can be given to - * services such as CodePipeline to connect to a third-party repository such as Bitbucket. For - * example, you can add the connection in CodePipeline so that it triggers your pipeline when a - * code change is made to your third-party code repository. Each connection is named and - * associated with a unique ARN that is used to reference the connection.

- *

When you create a connection, the console initiates a third-party connection handshake. - * Installations are the apps that are used to conduct this handshake. For - * example, the installation for the Bitbucket provider type is the Bitbucket app. When you - * create a connection, you can choose an existing installation or create one.

- *

When you want to create a connection to an installed provider type such as GitHub - * Enterprise Server, you create a host for your connections.

- *

You can work with connections by calling:

- *
    - *
  • - *

    - * CreateConnection, which creates a uniquely named connection that can be - * referenced by services such as CodePipeline.

    - *
  • - *
  • - *

    - * DeleteConnection, which deletes the specified connection.

    - *
  • - *
  • - *

    - * GetConnection, which returns information about the connection, including - * the connection status.

    - *
  • - *
  • - *

    - * ListConnections, which lists the connections associated with your - * account.

    - *
  • - *
- *

You can work with hosts by calling:

- *
    - *
  • - *

    - * CreateHost, which creates a host that represents the infrastructure where your provider is installed.

    - *
  • - *
  • - *

    - * DeleteHost, which deletes the specified host.

    - *
  • - *
  • - *

    - * GetHost, which returns information about the host, including - * the setup status.

    - *
  • - *
  • - *

    - * ListHosts, which lists the hosts associated with your - * account.

    - *
  • - *
- *

You can work with tags in AWS CodeStar Connections by calling the following:

- *
    - *
  • - *

    - * ListTagsForResource, which gets information about AWS tags for a - * specified Amazon Resource Name (ARN) in AWS CodeStar Connections.

    - *
  • - *
  • - *

    - * TagResource, which adds or updates tags for a resource in AWS CodeStar - * Connections.

    - *
  • - *
  • - *

    - * UntagResource, which removes tags for a resource in AWS CodeStar - * Connections.

    - *
  • - *
- *

For information about how to use AWS CodeStar Connections, see the Developer Tools User - * Guide.

- */ -export class CodeStarConnections extends CodeStarConnectionsClient { +const commands = { + CreateConnectionCommand, + CreateHostCommand, + DeleteConnectionCommand, + DeleteHostCommand, + GetConnectionCommand, + GetHostCommand, + ListConnectionsCommand, + ListHostsCommand, + ListTagsForResourceCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateHostCommand, +}; + +export interface CodeStarConnections { /** - * @public - *

Creates a connection that can then be given to other AWS services like CodePipeline so - * that it can access third-party code repositories. The connection is in pending status until - * the third-party connection handshake is completed from the console.

+ * @see {@link CreateConnectionCommand} */ - public createConnection( + createConnection( args: CreateConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConnection( + createConnection( args: CreateConnectionCommandInput, cb: (err: any, data?: CreateConnectionCommandOutput) => void ): void; - public createConnection( + createConnection( args: CreateConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectionCommandOutput) => void ): void; - public createConnection( - args: CreateConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConnectionCommandOutput) => void), - cb?: (err: any, data?: CreateConnectionCommandOutput) => void - ): Promise | void { - const command = new CreateConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a resource that represents the infrastructure where a third-party provider is - * installed. The host is used when you create connections to an installed third-party provider - * type, such as GitHub Enterprise Server. You create one host for all connections to that - * provider.

- * - *

A host created through the CLI or the SDK is in `PENDING` status by - * default. You can make its status `AVAILABLE` by setting up the host in the console.

- *
+ * @see {@link CreateHostCommand} */ - public createHost(args: CreateHostCommandInput, options?: __HttpHandlerOptions): Promise; - public createHost(args: CreateHostCommandInput, cb: (err: any, data?: CreateHostCommandOutput) => void): void; - public createHost( + createHost(args: CreateHostCommandInput, options?: __HttpHandlerOptions): Promise; + createHost(args: CreateHostCommandInput, cb: (err: any, data?: CreateHostCommandOutput) => void): void; + createHost( args: CreateHostCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHostCommandOutput) => void ): void; - public createHost( - args: CreateHostCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateHostCommandOutput) => void), - cb?: (err: any, data?: CreateHostCommandOutput) => void - ): Promise | void { - const command = new CreateHostCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The connection to be deleted.

+ * @see {@link DeleteConnectionCommand} */ - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, cb: (err: any, data?: DeleteConnectionCommandOutput) => void ): void; - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectionCommandOutput) => void ): void; - public deleteConnection( - args: DeleteConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConnectionCommandOutput) => void), - cb?: (err: any, data?: DeleteConnectionCommandOutput) => void - ): Promise | void { - const command = new DeleteConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The host to be deleted. Before you delete a host, all connections associated to the host must be deleted.

- * - *

A host cannot be deleted if it is in the VPC_CONFIG_INITIALIZING or VPC_CONFIG_DELETING state.

- *
+ * @see {@link DeleteHostCommand} */ - public deleteHost(args: DeleteHostCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteHost(args: DeleteHostCommandInput, cb: (err: any, data?: DeleteHostCommandOutput) => void): void; - public deleteHost( + deleteHost(args: DeleteHostCommandInput, options?: __HttpHandlerOptions): Promise; + deleteHost(args: DeleteHostCommandInput, cb: (err: any, data?: DeleteHostCommandOutput) => void): void; + deleteHost( args: DeleteHostCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHostCommandOutput) => void ): void; - public deleteHost( - args: DeleteHostCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteHostCommandOutput) => void), - cb?: (err: any, data?: DeleteHostCommandOutput) => void - ): Promise | void { - const command = new DeleteHostCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the connection ARN and details such as status, owner, and provider type.

+ * @see {@link GetConnectionCommand} */ - public getConnection( - args: GetConnectionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getConnection( - args: GetConnectionCommandInput, - cb: (err: any, data?: GetConnectionCommandOutput) => void - ): void; - public getConnection( + getConnection(args: GetConnectionCommandInput, options?: __HttpHandlerOptions): Promise; + getConnection(args: GetConnectionCommandInput, cb: (err: any, data?: GetConnectionCommandOutput) => void): void; + getConnection( args: GetConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConnectionCommandOutput) => void ): void; - public getConnection( - args: GetConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConnectionCommandOutput) => void), - cb?: (err: any, data?: GetConnectionCommandOutput) => void - ): Promise | void { - const command = new GetConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the host ARN and details such as status, provider type, endpoint, and, if - * applicable, the VPC configuration.

+ * @see {@link GetHostCommand} */ - public getHost(args: GetHostCommandInput, options?: __HttpHandlerOptions): Promise; - public getHost(args: GetHostCommandInput, cb: (err: any, data?: GetHostCommandOutput) => void): void; - public getHost( + getHost(args: GetHostCommandInput, options?: __HttpHandlerOptions): Promise; + getHost(args: GetHostCommandInput, cb: (err: any, data?: GetHostCommandOutput) => void): void; + getHost( args: GetHostCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHostCommandOutput) => void ): void; - public getHost( - args: GetHostCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetHostCommandOutput) => void), - cb?: (err: any, data?: GetHostCommandOutput) => void - ): Promise | void { - const command = new GetHostCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the connections associated with your account.

+ * @see {@link ListConnectionsCommand} */ - public listConnections( + listConnections( args: ListConnectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConnections( - args: ListConnectionsCommandInput, - cb: (err: any, data?: ListConnectionsCommandOutput) => void - ): void; - public listConnections( + listConnections(args: ListConnectionsCommandInput, cb: (err: any, data?: ListConnectionsCommandOutput) => void): void; + listConnections( args: ListConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConnectionsCommandOutput) => void ): void; - public listConnections( - args: ListConnectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConnectionsCommandOutput) => void), - cb?: (err: any, data?: ListConnectionsCommandOutput) => void - ): Promise | void { - const command = new ListConnectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the hosts associated with your account.

+ * @see {@link ListHostsCommand} */ - public listHosts(args: ListHostsCommandInput, options?: __HttpHandlerOptions): Promise; - public listHosts(args: ListHostsCommandInput, cb: (err: any, data?: ListHostsCommandOutput) => void): void; - public listHosts( + listHosts(args: ListHostsCommandInput, options?: __HttpHandlerOptions): Promise; + listHosts(args: ListHostsCommandInput, cb: (err: any, data?: ListHostsCommandOutput) => void): void; + listHosts( args: ListHostsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHostsCommandOutput) => void ): void; - public listHosts( - args: ListHostsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListHostsCommandOutput) => void), - cb?: (err: any, data?: ListHostsCommandOutput) => void - ): Promise | void { - const command = new ListHostsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the set of key-value pairs (metadata) that are used to manage the resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds to or modifies the tags of the given resource. Tags are metadata that can be used - * to manage a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from an AWS resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a specified host with the provided configurations.

+ * @see {@link UpdateHostCommand} */ - public updateHost(args: UpdateHostCommandInput, options?: __HttpHandlerOptions): Promise; - public updateHost(args: UpdateHostCommandInput, cb: (err: any, data?: UpdateHostCommandOutput) => void): void; - public updateHost( + updateHost(args: UpdateHostCommandInput, options?: __HttpHandlerOptions): Promise; + updateHost(args: UpdateHostCommandInput, cb: (err: any, data?: UpdateHostCommandOutput) => void): void; + updateHost( args: UpdateHostCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateHostCommandOutput) => void ): void; - public updateHost( - args: UpdateHostCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateHostCommandOutput) => void), - cb?: (err: any, data?: UpdateHostCommandOutput) => void - ): Promise | void { - const command = new UpdateHostCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * AWS CodeStar Connections + *

This AWS CodeStar Connections API Reference provides descriptions and usage examples of + * the operations and data types for the AWS CodeStar Connections API. You can use the + * connections API to work with connections and installations.

+ *

+ * Connections are configurations that you use to connect AWS + * resources to external code repositories. Each connection is a resource that can be given to + * services such as CodePipeline to connect to a third-party repository such as Bitbucket. For + * example, you can add the connection in CodePipeline so that it triggers your pipeline when a + * code change is made to your third-party code repository. Each connection is named and + * associated with a unique ARN that is used to reference the connection.

+ *

When you create a connection, the console initiates a third-party connection handshake. + * Installations are the apps that are used to conduct this handshake. For + * example, the installation for the Bitbucket provider type is the Bitbucket app. When you + * create a connection, you can choose an existing installation or create one.

+ *

When you want to create a connection to an installed provider type such as GitHub + * Enterprise Server, you create a host for your connections.

+ *

You can work with connections by calling:

+ *
    + *
  • + *

    + * CreateConnection, which creates a uniquely named connection that can be + * referenced by services such as CodePipeline.

    + *
  • + *
  • + *

    + * DeleteConnection, which deletes the specified connection.

    + *
  • + *
  • + *

    + * GetConnection, which returns information about the connection, including + * the connection status.

    + *
  • + *
  • + *

    + * ListConnections, which lists the connections associated with your + * account.

    + *
  • + *
+ *

You can work with hosts by calling:

+ *
    + *
  • + *

    + * CreateHost, which creates a host that represents the infrastructure where your provider is installed.

    + *
  • + *
  • + *

    + * DeleteHost, which deletes the specified host.

    + *
  • + *
  • + *

    + * GetHost, which returns information about the host, including + * the setup status.

    + *
  • + *
  • + *

    + * ListHosts, which lists the hosts associated with your + * account.

    + *
  • + *
+ *

You can work with tags in AWS CodeStar Connections by calling the following:

+ *
    + *
  • + *

    + * ListTagsForResource, which gets information about AWS tags for a + * specified Amazon Resource Name (ARN) in AWS CodeStar Connections.

    + *
  • + *
  • + *

    + * TagResource, which adds or updates tags for a resource in AWS CodeStar + * Connections.

    + *
  • + *
  • + *

    + * UntagResource, which removes tags for a resource in AWS CodeStar + * Connections.

    + *
  • + *
+ *

For information about how to use AWS CodeStar Connections, see the Developer Tools User + * Guide.

+ */ +export class CodeStarConnections extends CodeStarConnectionsClient implements CodeStarConnections {} +createAggregatedClient(commands, CodeStarConnections); diff --git a/clients/client-codestar-notifications/src/CodestarNotifications.ts b/clients/client-codestar-notifications/src/CodestarNotifications.ts index 296e8f8f5629..27ec6c2d3ea3 100644 --- a/clients/client-codestar-notifications/src/CodestarNotifications.ts +++ b/clients/client-codestar-notifications/src/CodestarNotifications.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CodestarNotificationsClient } from "./CodestarNotificationsClient"; +import { CodestarNotificationsClient, CodestarNotificationsClientConfig } from "./CodestarNotificationsClient"; import { CreateNotificationRuleCommand, CreateNotificationRuleCommandInput, @@ -52,505 +53,292 @@ import { UpdateNotificationRuleCommandOutput, } from "./commands/UpdateNotificationRuleCommand"; -/** - * @public - *

This AWS CodeStar Notifications API Reference provides descriptions and usage examples of the - * operations and data types for the AWS CodeStar Notifications API. You can use the AWS CodeStar Notifications API - * to work with the following objects:

- * - *

Notification rules, by calling the following:

- *
    - *
  • - *

    - * CreateNotificationRule, which creates a notification rule for a - * resource in your account.

    - *
  • - *
  • - *

    - * DeleteNotificationRule, which deletes a notification rule.

    - *
  • - *
  • - *

    - * DescribeNotificationRule, which provides information about a notification rule.

    - *
  • - *
  • - *

    - * ListNotificationRules, which lists the notification rules associated with - * your account.

    - *
  • - *
  • - *

    - * UpdateNotificationRule, which changes the name, events, or targets associated with a - * notification rule.

    - *
  • - *
  • - *

    - * Subscribe, which subscribes a target to a notification rule.

    - *
  • - *
  • - *

    - * Unsubscribe, which removes a target from a notification rule.

    - *
  • - *
- * - *

Targets, by calling the following:

- *
    - *
  • - *

    - * DeleteTarget, which removes a notification rule target from a - * notification rule.

    - *
  • - *
  • - *

    - * ListTargets, which lists the targets associated with a - * notification rule.

    - *
  • - *
- * - *

Events, by calling the following:

- *
    - *
  • - *

    - * ListEventTypes, which lists the event types you can include in - * a notification rule.

    - *
  • - *
- *

Tags, by calling the following:

- *
    - *
  • - *

    - * ListTagsForResource, which lists the tags already associated - * with a notification rule in your account.

    - *
  • - *
  • - *

    - * TagResource, which associates a tag you provide with a - * notification rule in your account.

    - *
  • - *
  • - *

    - * UntagResource, which removes a tag from a notification rule in - * your account.

    - *
  • - *
- * - * - * - *

For information about how to use AWS CodeStar Notifications, see the Amazon Web Services Developer Tools Console User Guide. - *

- */ -export class CodestarNotifications extends CodestarNotificationsClient { +const commands = { + CreateNotificationRuleCommand, + DeleteNotificationRuleCommand, + DeleteTargetCommand, + DescribeNotificationRuleCommand, + ListEventTypesCommand, + ListNotificationRulesCommand, + ListTagsForResourceCommand, + ListTargetsCommand, + SubscribeCommand, + TagResourceCommand, + UnsubscribeCommand, + UntagResourceCommand, + UpdateNotificationRuleCommand, +}; + +export interface CodestarNotifications { /** - * @public - *

Creates a notification rule for a resource. The rule specifies the events you want - * notifications about and the targets (such as Chatbot topics or Chatbot clients configured for Slack) where you want to receive - * them.

+ * @see {@link CreateNotificationRuleCommand} */ - public createNotificationRule( + createNotificationRule( args: CreateNotificationRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNotificationRule( + createNotificationRule( args: CreateNotificationRuleCommandInput, cb: (err: any, data?: CreateNotificationRuleCommandOutput) => void ): void; - public createNotificationRule( + createNotificationRule( args: CreateNotificationRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNotificationRuleCommandOutput) => void ): void; - public createNotificationRule( - args: CreateNotificationRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNotificationRuleCommandOutput) => void), - cb?: (err: any, data?: CreateNotificationRuleCommandOutput) => void - ): Promise | void { - const command = new CreateNotificationRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a notification rule for a resource.

+ * @see {@link DeleteNotificationRuleCommand} */ - public deleteNotificationRule( + deleteNotificationRule( args: DeleteNotificationRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNotificationRule( + deleteNotificationRule( args: DeleteNotificationRuleCommandInput, cb: (err: any, data?: DeleteNotificationRuleCommandOutput) => void ): void; - public deleteNotificationRule( + deleteNotificationRule( args: DeleteNotificationRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNotificationRuleCommandOutput) => void ): void; - public deleteNotificationRule( - args: DeleteNotificationRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNotificationRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteNotificationRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteNotificationRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a specified target for notifications.

+ * @see {@link DeleteTargetCommand} */ - public deleteTarget( - args: DeleteTargetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteTarget(args: DeleteTargetCommandInput, cb: (err: any, data?: DeleteTargetCommandOutput) => void): void; - public deleteTarget( + deleteTarget(args: DeleteTargetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTarget(args: DeleteTargetCommandInput, cb: (err: any, data?: DeleteTargetCommandOutput) => void): void; + deleteTarget( args: DeleteTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTargetCommandOutput) => void ): void; - public deleteTarget( - args: DeleteTargetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTargetCommandOutput) => void), - cb?: (err: any, data?: DeleteTargetCommandOutput) => void - ): Promise | void { - const command = new DeleteTargetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a specified notification rule.

+ * @see {@link DescribeNotificationRuleCommand} */ - public describeNotificationRule( + describeNotificationRule( args: DescribeNotificationRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNotificationRule( + describeNotificationRule( args: DescribeNotificationRuleCommandInput, cb: (err: any, data?: DescribeNotificationRuleCommandOutput) => void ): void; - public describeNotificationRule( + describeNotificationRule( args: DescribeNotificationRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNotificationRuleCommandOutput) => void ): void; - public describeNotificationRule( - args: DescribeNotificationRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeNotificationRuleCommandOutput) => void), - cb?: (err: any, data?: DescribeNotificationRuleCommandOutput) => void - ): Promise | void { - const command = new DescribeNotificationRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the event types available for configuring notifications.

+ * @see {@link ListEventTypesCommand} */ - public listEventTypes( + listEventTypes( args: ListEventTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEventTypes( - args: ListEventTypesCommandInput, - cb: (err: any, data?: ListEventTypesCommandOutput) => void - ): void; - public listEventTypes( + listEventTypes(args: ListEventTypesCommandInput, cb: (err: any, data?: ListEventTypesCommandOutput) => void): void; + listEventTypes( args: ListEventTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventTypesCommandOutput) => void ): void; - public listEventTypes( - args: ListEventTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEventTypesCommandOutput) => void), - cb?: (err: any, data?: ListEventTypesCommandOutput) => void - ): Promise | void { - const command = new ListEventTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the notification rules for an Amazon Web Services account.

+ * @see {@link ListNotificationRulesCommand} */ - public listNotificationRules( + listNotificationRules( args: ListNotificationRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listNotificationRules( + listNotificationRules( args: ListNotificationRulesCommandInput, cb: (err: any, data?: ListNotificationRulesCommandOutput) => void ): void; - public listNotificationRules( + listNotificationRules( args: ListNotificationRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNotificationRulesCommandOutput) => void ): void; - public listNotificationRules( - args: ListNotificationRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNotificationRulesCommandOutput) => void), - cb?: (err: any, data?: ListNotificationRulesCommandOutput) => void - ): Promise | void { - const command = new ListNotificationRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the tags associated with a notification rule.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the notification rule targets for an Amazon Web Services account.

+ * @see {@link ListTargetsCommand} */ - public listTargets(args: ListTargetsCommandInput, options?: __HttpHandlerOptions): Promise; - public listTargets(args: ListTargetsCommandInput, cb: (err: any, data?: ListTargetsCommandOutput) => void): void; - public listTargets( + listTargets(args: ListTargetsCommandInput, options?: __HttpHandlerOptions): Promise; + listTargets(args: ListTargetsCommandInput, cb: (err: any, data?: ListTargetsCommandOutput) => void): void; + listTargets( args: ListTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTargetsCommandOutput) => void ): void; - public listTargets( - args: ListTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTargetsCommandOutput) => void), - cb?: (err: any, data?: ListTargetsCommandOutput) => void - ): Promise | void { - const command = new ListTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an association between a notification rule and an Chatbot topic or Chatbot client so that the - * associated target can receive notifications when the events described in the rule are - * triggered.

+ * @see {@link SubscribeCommand} */ - public subscribe(args: SubscribeCommandInput, options?: __HttpHandlerOptions): Promise; - public subscribe(args: SubscribeCommandInput, cb: (err: any, data?: SubscribeCommandOutput) => void): void; - public subscribe( + subscribe(args: SubscribeCommandInput, options?: __HttpHandlerOptions): Promise; + subscribe(args: SubscribeCommandInput, cb: (err: any, data?: SubscribeCommandOutput) => void): void; + subscribe( args: SubscribeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubscribeCommandOutput) => void ): void; - public subscribe( - args: SubscribeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SubscribeCommandOutput) => void), - cb?: (err: any, data?: SubscribeCommandOutput) => void - ): Promise | void { - const command = new SubscribeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a set of provided tags with a notification rule.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes an association between a notification rule and an Chatbot topic so that - * subscribers to that topic stop receiving notifications when the events described in the - * rule are triggered.

+ * @see {@link UnsubscribeCommand} */ - public unsubscribe(args: UnsubscribeCommandInput, options?: __HttpHandlerOptions): Promise; - public unsubscribe(args: UnsubscribeCommandInput, cb: (err: any, data?: UnsubscribeCommandOutput) => void): void; - public unsubscribe( + unsubscribe(args: UnsubscribeCommandInput, options?: __HttpHandlerOptions): Promise; + unsubscribe(args: UnsubscribeCommandInput, cb: (err: any, data?: UnsubscribeCommandOutput) => void): void; + unsubscribe( args: UnsubscribeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnsubscribeCommandOutput) => void ): void; - public unsubscribe( - args: UnsubscribeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnsubscribeCommandOutput) => void), - cb?: (err: any, data?: UnsubscribeCommandOutput) => void - ): Promise | void { - const command = new UnsubscribeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the association between one or more provided tags and a notification - * rule.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a notification rule for a resource. You can change the events that trigger the - * notification rule, the status of the rule, and the targets that receive the - * notifications.

- * - *

To add or remove tags for a notification rule, you must use TagResource and UntagResource.

- *
+ * @see {@link UpdateNotificationRuleCommand} */ - public updateNotificationRule( + updateNotificationRule( args: UpdateNotificationRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateNotificationRule( + updateNotificationRule( args: UpdateNotificationRuleCommandInput, cb: (err: any, data?: UpdateNotificationRuleCommandOutput) => void ): void; - public updateNotificationRule( + updateNotificationRule( args: UpdateNotificationRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNotificationRuleCommandOutput) => void ): void; - public updateNotificationRule( - args: UpdateNotificationRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateNotificationRuleCommandOutput) => void), - cb?: (err: any, data?: UpdateNotificationRuleCommandOutput) => void - ): Promise | void { - const command = new UpdateNotificationRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

This AWS CodeStar Notifications API Reference provides descriptions and usage examples of the + * operations and data types for the AWS CodeStar Notifications API. You can use the AWS CodeStar Notifications API + * to work with the following objects:

+ * + *

Notification rules, by calling the following:

+ *
    + *
  • + *

    + * CreateNotificationRule, which creates a notification rule for a + * resource in your account.

    + *
  • + *
  • + *

    + * DeleteNotificationRule, which deletes a notification rule.

    + *
  • + *
  • + *

    + * DescribeNotificationRule, which provides information about a notification rule.

    + *
  • + *
  • + *

    + * ListNotificationRules, which lists the notification rules associated with + * your account.

    + *
  • + *
  • + *

    + * UpdateNotificationRule, which changes the name, events, or targets associated with a + * notification rule.

    + *
  • + *
  • + *

    + * Subscribe, which subscribes a target to a notification rule.

    + *
  • + *
  • + *

    + * Unsubscribe, which removes a target from a notification rule.

    + *
  • + *
+ * + *

Targets, by calling the following:

+ *
    + *
  • + *

    + * DeleteTarget, which removes a notification rule target from a + * notification rule.

    + *
  • + *
  • + *

    + * ListTargets, which lists the targets associated with a + * notification rule.

    + *
  • + *
+ * + *

Events, by calling the following:

+ *
    + *
  • + *

    + * ListEventTypes, which lists the event types you can include in + * a notification rule.

    + *
  • + *
+ *

Tags, by calling the following:

+ *
    + *
  • + *

    + * ListTagsForResource, which lists the tags already associated + * with a notification rule in your account.

    + *
  • + *
  • + *

    + * TagResource, which associates a tag you provide with a + * notification rule in your account.

    + *
  • + *
  • + *

    + * UntagResource, which removes a tag from a notification rule in + * your account.

    + *
  • + *
+ * + * + * + *

For information about how to use AWS CodeStar Notifications, see the Amazon Web Services Developer Tools Console User Guide. + *

+ */ +export class CodestarNotifications extends CodestarNotificationsClient implements CodestarNotifications {} +createAggregatedClient(commands, CodestarNotifications); diff --git a/clients/client-codestar/src/CodeStar.ts b/clients/client-codestar/src/CodeStar.ts index fd4d0699a8d4..1a97e89564d2 100644 --- a/clients/client-codestar/src/CodeStar.ts +++ b/clients/client-codestar/src/CodeStar.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CodeStarClient } from "./CodeStarClient"; +import { CodeStarClient, CodeStarClientConfig } from "./CodeStarClient"; import { AssociateTeamMemberCommand, AssociateTeamMemberCommandInput, @@ -89,694 +90,379 @@ import { UpdateUserProfileCommandOutput, } from "./commands/UpdateUserProfileCommand"; -/** - * @public - * AWS CodeStar - *

This is the API reference for AWS CodeStar. This reference provides descriptions of the - * operations and data types for the AWS CodeStar API along with usage examples.

- *

You can use the AWS CodeStar API to work with:

- *

Projects and their resources, by calling the following:

- *
    - *
  • - *

    - * DeleteProject, which deletes a project.

    - *
  • - *
  • - *

    - * DescribeProject, which lists the attributes of a project.

    - *
  • - *
  • - *

    - * ListProjects, which lists all projects associated with your AWS - * account.

    - *
  • - *
  • - *

    - * ListResources, which lists the resources associated with a - * project.

    - *
  • - *
  • - *

    - * ListTagsForProject, which lists the tags associated with a - * project.

    - *
  • - *
  • - *

    - * TagProject, which adds tags to a project.

    - *
  • - *
  • - *

    - * UntagProject, which removes tags from a project.

    - *
  • - *
  • - *

    - * UpdateProject, which updates the attributes of a project.

    - *
  • - *
- *

Teams and team members, by calling the following:

- *
    - *
  • - *

    - * AssociateTeamMember, which adds an IAM user to the team for a - * project.

    - *
  • - *
  • - *

    - * DisassociateTeamMember, which removes an IAM user from the team for a - * project.

    - *
  • - *
  • - *

    - * ListTeamMembers, which lists all the IAM users in the team for a - * project, including their roles and attributes.

    - *
  • - *
  • - *

    - * UpdateTeamMember, which updates a team member's attributes in a - * project.

    - *
  • - *
- *

Users, by calling the following:

- *
    - *
  • - *

    - * CreateUserProfile, which creates a user profile that contains data - * associated with the user across all projects.

    - *
  • - *
  • - *

    - * DeleteUserProfile, which deletes all user profile information across - * all projects.

    - *
  • - *
  • - *

    - * DescribeUserProfile, which describes the profile of a user.

    - *
  • - *
  • - *

    - * ListUserProfiles, which lists all user profiles.

    - *
  • - *
  • - *

    - * UpdateUserProfile, which updates the profile for a user.

    - *
  • - *
- */ -export class CodeStar extends CodeStarClient { +const commands = { + AssociateTeamMemberCommand, + CreateProjectCommand, + CreateUserProfileCommand, + DeleteProjectCommand, + DeleteUserProfileCommand, + DescribeProjectCommand, + DescribeUserProfileCommand, + DisassociateTeamMemberCommand, + ListProjectsCommand, + ListResourcesCommand, + ListTagsForProjectCommand, + ListTeamMembersCommand, + ListUserProfilesCommand, + TagProjectCommand, + UntagProjectCommand, + UpdateProjectCommand, + UpdateTeamMemberCommand, + UpdateUserProfileCommand, +}; + +export interface CodeStar { /** - * @public - *

Adds an IAM user to the team for an AWS CodeStar project.

+ * @see {@link AssociateTeamMemberCommand} */ - public associateTeamMember( + associateTeamMember( args: AssociateTeamMemberCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateTeamMember( + associateTeamMember( args: AssociateTeamMemberCommandInput, cb: (err: any, data?: AssociateTeamMemberCommandOutput) => void ): void; - public associateTeamMember( + associateTeamMember( args: AssociateTeamMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateTeamMemberCommandOutput) => void ): void; - public associateTeamMember( - args: AssociateTeamMemberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateTeamMemberCommandOutput) => void), - cb?: (err: any, data?: AssociateTeamMemberCommandOutput) => void - ): Promise | void { - const command = new AssociateTeamMemberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a project, including project resources. This action creates a project based on - * a submitted project request. A set of source code files and a toolchain template file - * can be included with the project request. If these are not provided, an empty project is created.

+ * @see {@link CreateProjectCommand} */ - public createProject( - args: CreateProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createProject( - args: CreateProjectCommandInput, - cb: (err: any, data?: CreateProjectCommandOutput) => void - ): void; - public createProject( + createProject(args: CreateProjectCommandInput, options?: __HttpHandlerOptions): Promise; + createProject(args: CreateProjectCommandInput, cb: (err: any, data?: CreateProjectCommandOutput) => void): void; + createProject( args: CreateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectCommandOutput) => void ): void; - public createProject( - args: CreateProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProjectCommandOutput) => void), - cb?: (err: any, data?: CreateProjectCommandOutput) => void - ): Promise | void { - const command = new CreateProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a profile for a user that includes user preferences, such as the display name - * and email address assocciated with the user, in AWS CodeStar. The user profile is not - * project-specific. Information in the user profile is displayed wherever the user's information - * appears to other users in AWS CodeStar.

+ * @see {@link CreateUserProfileCommand} */ - public createUserProfile( + createUserProfile( args: CreateUserProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public createUserProfile( + createUserProfile( args: CreateUserProfileCommandInput, cb: (err: any, data?: CreateUserProfileCommandOutput) => void ): void; - public createUserProfile( + createUserProfile( args: CreateUserProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserProfileCommandOutput) => void ): void; - public createUserProfile( - args: CreateUserProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserProfileCommandOutput) => void), - cb?: (err: any, data?: CreateUserProfileCommandOutput) => void - ): Promise | void { - const command = new CreateUserProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a project, including project resources. Does not delete users associated with - * the project, but does delete the IAM roles that allowed access to the project.

+ * @see {@link DeleteProjectCommand} */ - public deleteProject( - args: DeleteProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteProject( - args: DeleteProjectCommandInput, - cb: (err: any, data?: DeleteProjectCommandOutput) => void - ): void; - public deleteProject( + deleteProject(args: DeleteProjectCommandInput, options?: __HttpHandlerOptions): Promise; + deleteProject(args: DeleteProjectCommandInput, cb: (err: any, data?: DeleteProjectCommandOutput) => void): void; + deleteProject( args: DeleteProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProjectCommandOutput) => void ): void; - public deleteProject( - args: DeleteProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProjectCommandOutput) => void), - cb?: (err: any, data?: DeleteProjectCommandOutput) => void - ): Promise | void { - const command = new DeleteProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a user profile in AWS CodeStar, including all personal preference data associated with - * that profile, such as display name and email address. It does not delete the history of that - * user, for example the history of commits made by that user.

+ * @see {@link DeleteUserProfileCommand} */ - public deleteUserProfile( + deleteUserProfile( args: DeleteUserProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteUserProfile( + deleteUserProfile( args: DeleteUserProfileCommandInput, cb: (err: any, data?: DeleteUserProfileCommandOutput) => void ): void; - public deleteUserProfile( + deleteUserProfile( args: DeleteUserProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserProfileCommandOutput) => void ): void; - public deleteUserProfile( - args: DeleteUserProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteUserProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteUserProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a project and its resources.

+ * @see {@link DescribeProjectCommand} */ - public describeProject( + describeProject( args: DescribeProjectCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProject( - args: DescribeProjectCommandInput, - cb: (err: any, data?: DescribeProjectCommandOutput) => void - ): void; - public describeProject( + describeProject(args: DescribeProjectCommandInput, cb: (err: any, data?: DescribeProjectCommandOutput) => void): void; + describeProject( args: DescribeProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProjectCommandOutput) => void ): void; - public describeProject( - args: DescribeProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProjectCommandOutput) => void), - cb?: (err: any, data?: DescribeProjectCommandOutput) => void - ): Promise | void { - const command = new DescribeProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a user in AWS CodeStar and the user attributes across all projects.

+ * @see {@link DescribeUserProfileCommand} */ - public describeUserProfile( + describeUserProfile( args: DescribeUserProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeUserProfile( + describeUserProfile( args: DescribeUserProfileCommandInput, cb: (err: any, data?: DescribeUserProfileCommandOutput) => void ): void; - public describeUserProfile( + describeUserProfile( args: DescribeUserProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserProfileCommandOutput) => void ): void; - public describeUserProfile( - args: DescribeUserProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUserProfileCommandOutput) => void), - cb?: (err: any, data?: DescribeUserProfileCommandOutput) => void - ): Promise | void { - const command = new DescribeUserProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a user from a project. Removing a user from a project also removes the IAM - * policies from that user that allowed access to the project and its resources. Disassociating a - * team member does not remove that user's profile from AWS CodeStar. It does not remove the user from - * IAM.

+ * @see {@link DisassociateTeamMemberCommand} */ - public disassociateTeamMember( + disassociateTeamMember( args: DisassociateTeamMemberCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateTeamMember( + disassociateTeamMember( args: DisassociateTeamMemberCommandInput, cb: (err: any, data?: DisassociateTeamMemberCommandOutput) => void ): void; - public disassociateTeamMember( + disassociateTeamMember( args: DisassociateTeamMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateTeamMemberCommandOutput) => void ): void; - public disassociateTeamMember( - args: DisassociateTeamMemberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateTeamMemberCommandOutput) => void), - cb?: (err: any, data?: DisassociateTeamMemberCommandOutput) => void - ): Promise | void { - const command = new DisassociateTeamMemberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all projects in AWS CodeStar associated with your AWS account.

+ * @see {@link ListProjectsCommand} */ - public listProjects( - args: ListProjectsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void; - public listProjects( + listProjects(args: ListProjectsCommandInput, options?: __HttpHandlerOptions): Promise; + listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void; + listProjects( args: ListProjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProjectsCommandOutput) => void ): void; - public listProjects( - args: ListProjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProjectsCommandOutput) => void), - cb?: (err: any, data?: ListProjectsCommandOutput) => void - ): Promise | void { - const command = new ListProjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists resources associated with a project in AWS CodeStar.

+ * @see {@link ListResourcesCommand} */ - public listResources( - args: ListResourcesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listResources( - args: ListResourcesCommandInput, - cb: (err: any, data?: ListResourcesCommandOutput) => void - ): void; - public listResources( + listResources(args: ListResourcesCommandInput, options?: __HttpHandlerOptions): Promise; + listResources(args: ListResourcesCommandInput, cb: (err: any, data?: ListResourcesCommandOutput) => void): void; + listResources( args: ListResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourcesCommandOutput) => void ): void; - public listResources( - args: ListResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourcesCommandOutput) => void), - cb?: (err: any, data?: ListResourcesCommandOutput) => void - ): Promise | void { - const command = new ListResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the tags for a project.

+ * @see {@link ListTagsForProjectCommand} */ - public listTagsForProject( + listTagsForProject( args: ListTagsForProjectCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForProject( + listTagsForProject( args: ListTagsForProjectCommandInput, cb: (err: any, data?: ListTagsForProjectCommandOutput) => void ): void; - public listTagsForProject( + listTagsForProject( args: ListTagsForProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForProjectCommandOutput) => void ): void; - public listTagsForProject( - args: ListTagsForProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForProjectCommandOutput) => void), - cb?: (err: any, data?: ListTagsForProjectCommandOutput) => void - ): Promise | void { - const command = new ListTagsForProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all team members associated with a project.

+ * @see {@link ListTeamMembersCommand} */ - public listTeamMembers( + listTeamMembers( args: ListTeamMembersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTeamMembers( - args: ListTeamMembersCommandInput, - cb: (err: any, data?: ListTeamMembersCommandOutput) => void - ): void; - public listTeamMembers( + listTeamMembers(args: ListTeamMembersCommandInput, cb: (err: any, data?: ListTeamMembersCommandOutput) => void): void; + listTeamMembers( args: ListTeamMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTeamMembersCommandOutput) => void ): void; - public listTeamMembers( - args: ListTeamMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTeamMembersCommandOutput) => void), - cb?: (err: any, data?: ListTeamMembersCommandOutput) => void - ): Promise | void { - const command = new ListTeamMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the user profiles configured for your AWS account in AWS CodeStar.

+ * @see {@link ListUserProfilesCommand} */ - public listUserProfiles( + listUserProfiles( args: ListUserProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listUserProfiles( + listUserProfiles( args: ListUserProfilesCommandInput, cb: (err: any, data?: ListUserProfilesCommandOutput) => void ): void; - public listUserProfiles( + listUserProfiles( args: ListUserProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUserProfilesCommandOutput) => void ): void; - public listUserProfiles( - args: ListUserProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUserProfilesCommandOutput) => void), - cb?: (err: any, data?: ListUserProfilesCommandOutput) => void - ): Promise | void { - const command = new ListUserProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds tags to a project.

+ * @see {@link TagProjectCommand} */ - public tagProject(args: TagProjectCommandInput, options?: __HttpHandlerOptions): Promise; - public tagProject(args: TagProjectCommandInput, cb: (err: any, data?: TagProjectCommandOutput) => void): void; - public tagProject( + tagProject(args: TagProjectCommandInput, options?: __HttpHandlerOptions): Promise; + tagProject(args: TagProjectCommandInput, cb: (err: any, data?: TagProjectCommandOutput) => void): void; + tagProject( args: TagProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagProjectCommandOutput) => void ): void; - public tagProject( - args: TagProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagProjectCommandOutput) => void), - cb?: (err: any, data?: TagProjectCommandOutput) => void - ): Promise | void { - const command = new TagProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from a project.

+ * @see {@link UntagProjectCommand} */ - public untagProject( - args: UntagProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagProject(args: UntagProjectCommandInput, cb: (err: any, data?: UntagProjectCommandOutput) => void): void; - public untagProject( + untagProject(args: UntagProjectCommandInput, options?: __HttpHandlerOptions): Promise; + untagProject(args: UntagProjectCommandInput, cb: (err: any, data?: UntagProjectCommandOutput) => void): void; + untagProject( args: UntagProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagProjectCommandOutput) => void ): void; - public untagProject( - args: UntagProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagProjectCommandOutput) => void), - cb?: (err: any, data?: UntagProjectCommandOutput) => void - ): Promise | void { - const command = new UntagProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a project in AWS CodeStar.

+ * @see {@link UpdateProjectCommand} */ - public updateProject( - args: UpdateProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateProject( - args: UpdateProjectCommandInput, - cb: (err: any, data?: UpdateProjectCommandOutput) => void - ): void; - public updateProject( + updateProject(args: UpdateProjectCommandInput, options?: __HttpHandlerOptions): Promise; + updateProject(args: UpdateProjectCommandInput, cb: (err: any, data?: UpdateProjectCommandOutput) => void): void; + updateProject( args: UpdateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProjectCommandOutput) => void ): void; - public updateProject( - args: UpdateProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProjectCommandOutput) => void), - cb?: (err: any, data?: UpdateProjectCommandOutput) => void - ): Promise | void { - const command = new UpdateProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a team member's attributes in an AWS CodeStar project. For example, you can change a - * team member's role in the project, or change whether they have remote access to project - * resources.

+ * @see {@link UpdateTeamMemberCommand} */ - public updateTeamMember( + updateTeamMember( args: UpdateTeamMemberCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTeamMember( + updateTeamMember( args: UpdateTeamMemberCommandInput, cb: (err: any, data?: UpdateTeamMemberCommandOutput) => void ): void; - public updateTeamMember( + updateTeamMember( args: UpdateTeamMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTeamMemberCommandOutput) => void ): void; - public updateTeamMember( - args: UpdateTeamMemberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTeamMemberCommandOutput) => void), - cb?: (err: any, data?: UpdateTeamMemberCommandOutput) => void - ): Promise | void { - const command = new UpdateTeamMemberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a user's profile in AWS CodeStar. The user profile is not project-specific. - * Information in the user profile is displayed wherever the user's information appears to other - * users in AWS CodeStar.

+ * @see {@link UpdateUserProfileCommand} */ - public updateUserProfile( + updateUserProfile( args: UpdateUserProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateUserProfile( + updateUserProfile( args: UpdateUserProfileCommandInput, cb: (err: any, data?: UpdateUserProfileCommandOutput) => void ): void; - public updateUserProfile( + updateUserProfile( args: UpdateUserProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserProfileCommandOutput) => void ): void; - public updateUserProfile( - args: UpdateUserProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserProfileCommandOutput) => void), - cb?: (err: any, data?: UpdateUserProfileCommandOutput) => void - ): Promise | void { - const command = new UpdateUserProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * AWS CodeStar + *

This is the API reference for AWS CodeStar. This reference provides descriptions of the + * operations and data types for the AWS CodeStar API along with usage examples.

+ *

You can use the AWS CodeStar API to work with:

+ *

Projects and their resources, by calling the following:

+ *
    + *
  • + *

    + * DeleteProject, which deletes a project.

    + *
  • + *
  • + *

    + * DescribeProject, which lists the attributes of a project.

    + *
  • + *
  • + *

    + * ListProjects, which lists all projects associated with your AWS + * account.

    + *
  • + *
  • + *

    + * ListResources, which lists the resources associated with a + * project.

    + *
  • + *
  • + *

    + * ListTagsForProject, which lists the tags associated with a + * project.

    + *
  • + *
  • + *

    + * TagProject, which adds tags to a project.

    + *
  • + *
  • + *

    + * UntagProject, which removes tags from a project.

    + *
  • + *
  • + *

    + * UpdateProject, which updates the attributes of a project.

    + *
  • + *
+ *

Teams and team members, by calling the following:

+ *
    + *
  • + *

    + * AssociateTeamMember, which adds an IAM user to the team for a + * project.

    + *
  • + *
  • + *

    + * DisassociateTeamMember, which removes an IAM user from the team for a + * project.

    + *
  • + *
  • + *

    + * ListTeamMembers, which lists all the IAM users in the team for a + * project, including their roles and attributes.

    + *
  • + *
  • + *

    + * UpdateTeamMember, which updates a team member's attributes in a + * project.

    + *
  • + *
+ *

Users, by calling the following:

+ *
    + *
  • + *

    + * CreateUserProfile, which creates a user profile that contains data + * associated with the user across all projects.

    + *
  • + *
  • + *

    + * DeleteUserProfile, which deletes all user profile information across + * all projects.

    + *
  • + *
  • + *

    + * DescribeUserProfile, which describes the profile of a user.

    + *
  • + *
  • + *

    + * ListUserProfiles, which lists all user profiles.

    + *
  • + *
  • + *

    + * UpdateUserProfile, which updates the profile for a user.

    + *
  • + *
+ */ +export class CodeStar extends CodeStarClient implements CodeStar {} +createAggregatedClient(commands, CodeStar); diff --git a/clients/client-cognito-identity-provider/src/CognitoIdentityProvider.ts b/clients/client-cognito-identity-provider/src/CognitoIdentityProvider.ts index 0c62f84823c0..37d6ad792376 100644 --- a/clients/client-cognito-identity-provider/src/CognitoIdentityProvider.ts +++ b/clients/client-cognito-identity-provider/src/CognitoIdentityProvider.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CognitoIdentityProviderClient } from "./CognitoIdentityProviderClient"; +import { CognitoIdentityProviderClient, CognitoIdentityProviderClientConfig } from "./CognitoIdentityProviderClient"; import { AddCustomAttributesCommand, AddCustomAttributesCommandInput, @@ -456,3783 +457,1675 @@ import { VerifyUserAttributeCommandOutput, } from "./commands/VerifyUserAttributeCommand"; -/** - * @public - *

Using the Amazon Cognito user pools API, you can create a user pool to manage directories and - * users. You can authenticate a user to obtain tokens related to user identity and access - * policies.

- *

This API reference provides information about user pools in Amazon Cognito user pools.

- *

For more information, see the Amazon Cognito - * Documentation.

- */ -export class CognitoIdentityProvider extends CognitoIdentityProviderClient { +const commands = { + AddCustomAttributesCommand, + AdminAddUserToGroupCommand, + AdminConfirmSignUpCommand, + AdminCreateUserCommand, + AdminDeleteUserCommand, + AdminDeleteUserAttributesCommand, + AdminDisableProviderForUserCommand, + AdminDisableUserCommand, + AdminEnableUserCommand, + AdminForgetDeviceCommand, + AdminGetDeviceCommand, + AdminGetUserCommand, + AdminInitiateAuthCommand, + AdminLinkProviderForUserCommand, + AdminListDevicesCommand, + AdminListGroupsForUserCommand, + AdminListUserAuthEventsCommand, + AdminRemoveUserFromGroupCommand, + AdminResetUserPasswordCommand, + AdminRespondToAuthChallengeCommand, + AdminSetUserMFAPreferenceCommand, + AdminSetUserPasswordCommand, + AdminSetUserSettingsCommand, + AdminUpdateAuthEventFeedbackCommand, + AdminUpdateDeviceStatusCommand, + AdminUpdateUserAttributesCommand, + AdminUserGlobalSignOutCommand, + AssociateSoftwareTokenCommand, + ChangePasswordCommand, + ConfirmDeviceCommand, + ConfirmForgotPasswordCommand, + ConfirmSignUpCommand, + CreateGroupCommand, + CreateIdentityProviderCommand, + CreateResourceServerCommand, + CreateUserImportJobCommand, + CreateUserPoolCommand, + CreateUserPoolClientCommand, + CreateUserPoolDomainCommand, + DeleteGroupCommand, + DeleteIdentityProviderCommand, + DeleteResourceServerCommand, + DeleteUserCommand, + DeleteUserAttributesCommand, + DeleteUserPoolCommand, + DeleteUserPoolClientCommand, + DeleteUserPoolDomainCommand, + DescribeIdentityProviderCommand, + DescribeResourceServerCommand, + DescribeRiskConfigurationCommand, + DescribeUserImportJobCommand, + DescribeUserPoolCommand, + DescribeUserPoolClientCommand, + DescribeUserPoolDomainCommand, + ForgetDeviceCommand, + ForgotPasswordCommand, + GetCSVHeaderCommand, + GetDeviceCommand, + GetGroupCommand, + GetIdentityProviderByIdentifierCommand, + GetSigningCertificateCommand, + GetUICustomizationCommand, + GetUserCommand, + GetUserAttributeVerificationCodeCommand, + GetUserPoolMfaConfigCommand, + GlobalSignOutCommand, + InitiateAuthCommand, + ListDevicesCommand, + ListGroupsCommand, + ListIdentityProvidersCommand, + ListResourceServersCommand, + ListTagsForResourceCommand, + ListUserImportJobsCommand, + ListUserPoolClientsCommand, + ListUserPoolsCommand, + ListUsersCommand, + ListUsersInGroupCommand, + ResendConfirmationCodeCommand, + RespondToAuthChallengeCommand, + RevokeTokenCommand, + SetRiskConfigurationCommand, + SetUICustomizationCommand, + SetUserMFAPreferenceCommand, + SetUserPoolMfaConfigCommand, + SetUserSettingsCommand, + SignUpCommand, + StartUserImportJobCommand, + StopUserImportJobCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAuthEventFeedbackCommand, + UpdateDeviceStatusCommand, + UpdateGroupCommand, + UpdateIdentityProviderCommand, + UpdateResourceServerCommand, + UpdateUserAttributesCommand, + UpdateUserPoolCommand, + UpdateUserPoolClientCommand, + UpdateUserPoolDomainCommand, + VerifySoftwareTokenCommand, + VerifyUserAttributeCommand, +}; + +export interface CognitoIdentityProvider { /** - * @public - *

Adds additional user attributes to the user pool schema.

+ * @see {@link AddCustomAttributesCommand} */ - public addCustomAttributes( + addCustomAttributes( args: AddCustomAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public addCustomAttributes( + addCustomAttributes( args: AddCustomAttributesCommandInput, cb: (err: any, data?: AddCustomAttributesCommandOutput) => void ): void; - public addCustomAttributes( + addCustomAttributes( args: AddCustomAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddCustomAttributesCommandOutput) => void ): void; - public addCustomAttributes( - args: AddCustomAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddCustomAttributesCommandOutput) => void), - cb?: (err: any, data?: AddCustomAttributesCommandOutput) => void - ): Promise | void { - const command = new AddCustomAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds the specified user to the specified group.

- *

Calling this action requires developer credentials.

+ * @see {@link AdminAddUserToGroupCommand} */ - public adminAddUserToGroup( + adminAddUserToGroup( args: AdminAddUserToGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminAddUserToGroup( + adminAddUserToGroup( args: AdminAddUserToGroupCommandInput, cb: (err: any, data?: AdminAddUserToGroupCommandOutput) => void ): void; - public adminAddUserToGroup( + adminAddUserToGroup( args: AdminAddUserToGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminAddUserToGroupCommandOutput) => void ): void; - public adminAddUserToGroup( - args: AdminAddUserToGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminAddUserToGroupCommandOutput) => void), - cb?: (err: any, data?: AdminAddUserToGroupCommandOutput) => void - ): Promise | void { - const command = new AdminAddUserToGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Confirms user registration as an admin without using a confirmation code. Works on any - * user.

- *

Calling this action requires developer credentials.

+ * @see {@link AdminConfirmSignUpCommand} */ - public adminConfirmSignUp( + adminConfirmSignUp( args: AdminConfirmSignUpCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminConfirmSignUp( + adminConfirmSignUp( args: AdminConfirmSignUpCommandInput, cb: (err: any, data?: AdminConfirmSignUpCommandOutput) => void ): void; - public adminConfirmSignUp( + adminConfirmSignUp( args: AdminConfirmSignUpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminConfirmSignUpCommandOutput) => void ): void; - public adminConfirmSignUp( - args: AdminConfirmSignUpCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminConfirmSignUpCommandOutput) => void), - cb?: (err: any, data?: AdminConfirmSignUpCommandOutput) => void - ): Promise | void { - const command = new AdminConfirmSignUpCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new user in the specified user pool.

- *

If MessageAction isn't set, the default is to send a welcome message via - * email or phone (SMS).

- * - * - *

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers - * require you to register an origination phone number before you can send SMS messages - * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a - * phone number with Amazon Pinpoint. - * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must - * receive SMS messages might not be able to sign up, activate their accounts, or sign - * in.

- *

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, - * Amazon Simple Notification Service might place your account in the SMS sandbox. In - * sandbox - * mode - * , you can send messages only to verified phone - * numbers. After you test your app while in the sandbox environment, you can move out - * of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito - * Developer Guide.

- *
- * - *

This message is based on a template that you configured in your call to create or - * update a user pool. This template includes your custom sign-up instructions and - * placeholders for user name and temporary password.

- *

Alternatively, you can call AdminCreateUser with SUPPRESS - * for the MessageAction parameter, and Amazon Cognito won't send any email.

- *

In either case, the user will be in the FORCE_CHANGE_PASSWORD state until - * they sign in and change their password.

- *

- * AdminCreateUser requires developer credentials.

+ * @see {@link AdminCreateUserCommand} */ - public adminCreateUser( + adminCreateUser( args: AdminCreateUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminCreateUser( - args: AdminCreateUserCommandInput, - cb: (err: any, data?: AdminCreateUserCommandOutput) => void - ): void; - public adminCreateUser( + adminCreateUser(args: AdminCreateUserCommandInput, cb: (err: any, data?: AdminCreateUserCommandOutput) => void): void; + adminCreateUser( args: AdminCreateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminCreateUserCommandOutput) => void ): void; - public adminCreateUser( - args: AdminCreateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminCreateUserCommandOutput) => void), - cb?: (err: any, data?: AdminCreateUserCommandOutput) => void - ): Promise | void { - const command = new AdminCreateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a user as an administrator. Works on any user.

- *

Calling this action requires developer credentials.

+ * @see {@link AdminDeleteUserCommand} */ - public adminDeleteUser( + adminDeleteUser( args: AdminDeleteUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminDeleteUser( - args: AdminDeleteUserCommandInput, - cb: (err: any, data?: AdminDeleteUserCommandOutput) => void - ): void; - public adminDeleteUser( + adminDeleteUser(args: AdminDeleteUserCommandInput, cb: (err: any, data?: AdminDeleteUserCommandOutput) => void): void; + adminDeleteUser( args: AdminDeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminDeleteUserCommandOutput) => void ): void; - public adminDeleteUser( - args: AdminDeleteUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminDeleteUserCommandOutput) => void), - cb?: (err: any, data?: AdminDeleteUserCommandOutput) => void - ): Promise | void { - const command = new AdminDeleteUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the user attributes in a user pool as an administrator. Works on any - * user.

- *

Calling this action requires developer credentials.

+ * @see {@link AdminDeleteUserAttributesCommand} */ - public adminDeleteUserAttributes( + adminDeleteUserAttributes( args: AdminDeleteUserAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminDeleteUserAttributes( + adminDeleteUserAttributes( args: AdminDeleteUserAttributesCommandInput, cb: (err: any, data?: AdminDeleteUserAttributesCommandOutput) => void ): void; - public adminDeleteUserAttributes( + adminDeleteUserAttributes( args: AdminDeleteUserAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminDeleteUserAttributesCommandOutput) => void ): void; - public adminDeleteUserAttributes( - args: AdminDeleteUserAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminDeleteUserAttributesCommandOutput) => void), - cb?: (err: any, data?: AdminDeleteUserAttributesCommandOutput) => void - ): Promise | void { - const command = new AdminDeleteUserAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Prevents the user from signing in with the specified external (SAML or social) - * identity provider (IdP). If the user that you want to deactivate is a Amazon Cognito user pools - * native username + password user, they can't use their password to sign in. If the user - * to deactivate is a linked external IdP user, any link between that user and an existing - * user is removed. When the external user signs in again, and the user is no longer - * attached to the previously linked DestinationUser, the user must create a - * new user account. See AdminLinkProviderForUser.

- *

This action is enabled only for admin access and requires developer - * credentials.

- *

The ProviderName must match the value specified when creating an IdP for - * the pool.

- *

To deactivate a native username + password user, the ProviderName value - * must be Cognito and the ProviderAttributeName must be - * Cognito_Subject. The ProviderAttributeValue must be the - * name that is used in the user pool for the user.

- *

The ProviderAttributeName must always be Cognito_Subject for - * social IdPs. The ProviderAttributeValue must always be the exact subject - * that was used when the user was originally linked as a source user.

- *

For de-linking a SAML identity, there are two scenarios. If the linked identity has - * not yet been used to sign in, the ProviderAttributeName and - * ProviderAttributeValue must be the same values that were used for the - * SourceUser when the identities were originally linked using - * AdminLinkProviderForUser call. (If the linking was done with - * ProviderAttributeName set to Cognito_Subject, the same - * applies here). However, if the user has already signed in, the - * ProviderAttributeName must be Cognito_Subject and - * ProviderAttributeValue must be the subject of the SAML - * assertion.

+ * @see {@link AdminDisableProviderForUserCommand} */ - public adminDisableProviderForUser( + adminDisableProviderForUser( args: AdminDisableProviderForUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminDisableProviderForUser( + adminDisableProviderForUser( args: AdminDisableProviderForUserCommandInput, cb: (err: any, data?: AdminDisableProviderForUserCommandOutput) => void ): void; - public adminDisableProviderForUser( + adminDisableProviderForUser( args: AdminDisableProviderForUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminDisableProviderForUserCommandOutput) => void ): void; - public adminDisableProviderForUser( - args: AdminDisableProviderForUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminDisableProviderForUserCommandOutput) => void), - cb?: (err: any, data?: AdminDisableProviderForUserCommandOutput) => void - ): Promise | void { - const command = new AdminDisableProviderForUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deactivates a user and revokes all access tokens for the user. A deactivated user can't sign in, - * but still appears in the responses to GetUser and ListUsers API requests.

- *

You must make this API request with Amazon Web Services credentials that have cognito-idp:AdminDisableUser permissions.

+ * @see {@link AdminDisableUserCommand} */ - public adminDisableUser( + adminDisableUser( args: AdminDisableUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminDisableUser( + adminDisableUser( args: AdminDisableUserCommandInput, cb: (err: any, data?: AdminDisableUserCommandOutput) => void ): void; - public adminDisableUser( + adminDisableUser( args: AdminDisableUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminDisableUserCommandOutput) => void ): void; - public adminDisableUser( - args: AdminDisableUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminDisableUserCommandOutput) => void), - cb?: (err: any, data?: AdminDisableUserCommandOutput) => void - ): Promise | void { - const command = new AdminDisableUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the specified user as an administrator. Works on any user.

- *

Calling this action requires developer credentials.

+ * @see {@link AdminEnableUserCommand} */ - public adminEnableUser( + adminEnableUser( args: AdminEnableUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminEnableUser( - args: AdminEnableUserCommandInput, - cb: (err: any, data?: AdminEnableUserCommandOutput) => void - ): void; - public adminEnableUser( + adminEnableUser(args: AdminEnableUserCommandInput, cb: (err: any, data?: AdminEnableUserCommandOutput) => void): void; + adminEnableUser( args: AdminEnableUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminEnableUserCommandOutput) => void ): void; - public adminEnableUser( - args: AdminEnableUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminEnableUserCommandOutput) => void), - cb?: (err: any, data?: AdminEnableUserCommandOutput) => void - ): Promise | void { - const command = new AdminEnableUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Forgets the device, as an administrator.

- *

Calling this action requires developer credentials.

+ * @see {@link AdminForgetDeviceCommand} */ - public adminForgetDevice( + adminForgetDevice( args: AdminForgetDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminForgetDevice( + adminForgetDevice( args: AdminForgetDeviceCommandInput, cb: (err: any, data?: AdminForgetDeviceCommandOutput) => void ): void; - public adminForgetDevice( + adminForgetDevice( args: AdminForgetDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminForgetDeviceCommandOutput) => void ): void; - public adminForgetDevice( - args: AdminForgetDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminForgetDeviceCommandOutput) => void), - cb?: (err: any, data?: AdminForgetDeviceCommandOutput) => void - ): Promise | void { - const command = new AdminForgetDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the device, as an administrator.

- *

Calling this action requires developer credentials.

+ * @see {@link AdminGetDeviceCommand} */ - public adminGetDevice( + adminGetDevice( args: AdminGetDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminGetDevice( - args: AdminGetDeviceCommandInput, - cb: (err: any, data?: AdminGetDeviceCommandOutput) => void - ): void; - public adminGetDevice( + adminGetDevice(args: AdminGetDeviceCommandInput, cb: (err: any, data?: AdminGetDeviceCommandOutput) => void): void; + adminGetDevice( args: AdminGetDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminGetDeviceCommandOutput) => void ): void; - public adminGetDevice( - args: AdminGetDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminGetDeviceCommandOutput) => void), - cb?: (err: any, data?: AdminGetDeviceCommandOutput) => void - ): Promise | void { - const command = new AdminGetDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the specified user by user name in a user pool as an administrator. Works on any - * user.

- *

Calling this action requires developer credentials.

+ * @see {@link AdminGetUserCommand} */ - public adminGetUser( - args: AdminGetUserCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public adminGetUser(args: AdminGetUserCommandInput, cb: (err: any, data?: AdminGetUserCommandOutput) => void): void; - public adminGetUser( + adminGetUser(args: AdminGetUserCommandInput, options?: __HttpHandlerOptions): Promise; + adminGetUser(args: AdminGetUserCommandInput, cb: (err: any, data?: AdminGetUserCommandOutput) => void): void; + adminGetUser( args: AdminGetUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminGetUserCommandOutput) => void ): void; - public adminGetUser( - args: AdminGetUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminGetUserCommandOutput) => void), - cb?: (err: any, data?: AdminGetUserCommandOutput) => void - ): Promise | void { - const command = new AdminGetUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Initiates the authentication flow, as an administrator.

- * - * - *

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers - * require you to register an origination phone number before you can send SMS messages - * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a - * phone number with Amazon Pinpoint. - * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must - * receive SMS messages might not be able to sign up, activate their accounts, or sign - * in.

- *

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, - * Amazon Simple Notification Service might place your account in the SMS sandbox. In - * sandbox - * mode - * , you can send messages only to verified phone - * numbers. After you test your app while in the sandbox environment, you can move out - * of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito - * Developer Guide.

- *
- * - *

Calling this action requires developer credentials.

+ * @see {@link AdminInitiateAuthCommand} */ - public adminInitiateAuth( + adminInitiateAuth( args: AdminInitiateAuthCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminInitiateAuth( + adminInitiateAuth( args: AdminInitiateAuthCommandInput, cb: (err: any, data?: AdminInitiateAuthCommandOutput) => void ): void; - public adminInitiateAuth( + adminInitiateAuth( args: AdminInitiateAuthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminInitiateAuthCommandOutput) => void ): void; - public adminInitiateAuth( - args: AdminInitiateAuthCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminInitiateAuthCommandOutput) => void), - cb?: (err: any, data?: AdminInitiateAuthCommandOutput) => void - ): Promise | void { - const command = new AdminInitiateAuthCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Links an existing user account in a user pool (DestinationUser) to an - * identity from an external IdP (SourceUser) based on a specified attribute - * name and value from the external IdP. This allows you to create a link from the existing - * user account to an external federated user identity that has not yet been used to sign - * in. You can then use the federated user identity to sign in as the existing user - * account.

- *

For example, if there is an existing user with a username and password, this API - * links that user to a federated user identity. When the user signs in with a federated - * user identity, they sign in as the existing user account.

- * - *

The maximum number of federated identities linked to a user is five.

- *
- * - *

Because this API allows a user with an external federated identity to sign in as - * an existing user in the user pool, it is critical that it only be used with external - * IdPs and provider attributes that have been trusted by the application owner.

- *
- * - *

This action is administrative and requires developer credentials.

+ * @see {@link AdminLinkProviderForUserCommand} */ - public adminLinkProviderForUser( + adminLinkProviderForUser( args: AdminLinkProviderForUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminLinkProviderForUser( + adminLinkProviderForUser( args: AdminLinkProviderForUserCommandInput, cb: (err: any, data?: AdminLinkProviderForUserCommandOutput) => void ): void; - public adminLinkProviderForUser( + adminLinkProviderForUser( args: AdminLinkProviderForUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminLinkProviderForUserCommandOutput) => void ): void; - public adminLinkProviderForUser( - args: AdminLinkProviderForUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminLinkProviderForUserCommandOutput) => void), - cb?: (err: any, data?: AdminLinkProviderForUserCommandOutput) => void - ): Promise | void { - const command = new AdminLinkProviderForUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists devices, as an administrator.

- *

Calling this action requires developer credentials.

+ * @see {@link AdminListDevicesCommand} */ - public adminListDevices( + adminListDevices( args: AdminListDevicesCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminListDevices( + adminListDevices( args: AdminListDevicesCommandInput, cb: (err: any, data?: AdminListDevicesCommandOutput) => void ): void; - public adminListDevices( + adminListDevices( args: AdminListDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminListDevicesCommandOutput) => void ): void; - public adminListDevices( - args: AdminListDevicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminListDevicesCommandOutput) => void), - cb?: (err: any, data?: AdminListDevicesCommandOutput) => void - ): Promise | void { - const command = new AdminListDevicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the groups that the user belongs to.

- *

Calling this action requires developer credentials.

+ * @see {@link AdminListGroupsForUserCommand} */ - public adminListGroupsForUser( + adminListGroupsForUser( args: AdminListGroupsForUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminListGroupsForUser( + adminListGroupsForUser( args: AdminListGroupsForUserCommandInput, cb: (err: any, data?: AdminListGroupsForUserCommandOutput) => void ): void; - public adminListGroupsForUser( + adminListGroupsForUser( args: AdminListGroupsForUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminListGroupsForUserCommandOutput) => void ): void; - public adminListGroupsForUser( - args: AdminListGroupsForUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminListGroupsForUserCommandOutput) => void), - cb?: (err: any, data?: AdminListGroupsForUserCommandOutput) => void - ): Promise | void { - const command = new AdminListGroupsForUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A history of user activity and any risks detected as part of Amazon Cognito advanced - * security.

+ * @see {@link AdminListUserAuthEventsCommand} */ - public adminListUserAuthEvents( + adminListUserAuthEvents( args: AdminListUserAuthEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminListUserAuthEvents( + adminListUserAuthEvents( args: AdminListUserAuthEventsCommandInput, cb: (err: any, data?: AdminListUserAuthEventsCommandOutput) => void ): void; - public adminListUserAuthEvents( + adminListUserAuthEvents( args: AdminListUserAuthEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminListUserAuthEventsCommandOutput) => void ): void; - public adminListUserAuthEvents( - args: AdminListUserAuthEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminListUserAuthEventsCommandOutput) => void), - cb?: (err: any, data?: AdminListUserAuthEventsCommandOutput) => void - ): Promise | void { - const command = new AdminListUserAuthEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified user from the specified group.

- *

Calling this action requires developer credentials.

+ * @see {@link AdminRemoveUserFromGroupCommand} */ - public adminRemoveUserFromGroup( + adminRemoveUserFromGroup( args: AdminRemoveUserFromGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminRemoveUserFromGroup( + adminRemoveUserFromGroup( args: AdminRemoveUserFromGroupCommandInput, cb: (err: any, data?: AdminRemoveUserFromGroupCommandOutput) => void ): void; - public adminRemoveUserFromGroup( + adminRemoveUserFromGroup( args: AdminRemoveUserFromGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminRemoveUserFromGroupCommandOutput) => void ): void; - public adminRemoveUserFromGroup( - args: AdminRemoveUserFromGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminRemoveUserFromGroupCommandOutput) => void), - cb?: (err: any, data?: AdminRemoveUserFromGroupCommandOutput) => void - ): Promise | void { - const command = new AdminRemoveUserFromGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Resets the specified user's password in a user pool as an administrator. Works on any - * user.

- *

When a developer calls this API, the current password is invalidated, so it must be - * changed. If a user tries to sign in after the API is called, the app will get a - * PasswordResetRequiredException exception back and should direct the user down the flow - * to reset the password, which is the same as the forgot password flow. In addition, if - * the user pool has phone verification selected and a verified phone number exists for the - * user, or if email verification is selected and a verified email exists for the user, - * calling this API will also result in sending a message to the end user with the code to - * change their password.

- * - * - *

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers - * require you to register an origination phone number before you can send SMS messages - * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a - * phone number with Amazon Pinpoint. - * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must - * receive SMS messages might not be able to sign up, activate their accounts, or sign - * in.

- *

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, - * Amazon Simple Notification Service might place your account in the SMS sandbox. In - * sandbox - * mode - * , you can send messages only to verified phone - * numbers. After you test your app while in the sandbox environment, you can move out - * of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito - * Developer Guide.

- *
- * - *

Calling this action requires developer credentials.

+ * @see {@link AdminResetUserPasswordCommand} */ - public adminResetUserPassword( + adminResetUserPassword( args: AdminResetUserPasswordCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminResetUserPassword( + adminResetUserPassword( args: AdminResetUserPasswordCommandInput, cb: (err: any, data?: AdminResetUserPasswordCommandOutput) => void ): void; - public adminResetUserPassword( + adminResetUserPassword( args: AdminResetUserPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminResetUserPasswordCommandOutput) => void ): void; - public adminResetUserPassword( - args: AdminResetUserPasswordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminResetUserPasswordCommandOutput) => void), - cb?: (err: any, data?: AdminResetUserPasswordCommandOutput) => void - ): Promise | void { - const command = new AdminResetUserPasswordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Responds to an authentication challenge, as an administrator.

- * - * - *

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers - * require you to register an origination phone number before you can send SMS messages - * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a - * phone number with Amazon Pinpoint. - * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must - * receive SMS messages might not be able to sign up, activate their accounts, or sign - * in.

- *

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, - * Amazon Simple Notification Service might place your account in the SMS sandbox. In - * sandbox - * mode - * , you can send messages only to verified phone - * numbers. After you test your app while in the sandbox environment, you can move out - * of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito - * Developer Guide.

- *
- * - *

Calling this action requires developer credentials.

+ * @see {@link AdminRespondToAuthChallengeCommand} */ - public adminRespondToAuthChallenge( + adminRespondToAuthChallenge( args: AdminRespondToAuthChallengeCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminRespondToAuthChallenge( + adminRespondToAuthChallenge( args: AdminRespondToAuthChallengeCommandInput, cb: (err: any, data?: AdminRespondToAuthChallengeCommandOutput) => void ): void; - public adminRespondToAuthChallenge( + adminRespondToAuthChallenge( args: AdminRespondToAuthChallengeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminRespondToAuthChallengeCommandOutput) => void ): void; - public adminRespondToAuthChallenge( - args: AdminRespondToAuthChallengeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminRespondToAuthChallengeCommandOutput) => void), - cb?: (err: any, data?: AdminRespondToAuthChallengeCommandOutput) => void - ): Promise | void { - const command = new AdminRespondToAuthChallengeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The user's multi-factor authentication (MFA) preference, including which MFA options - * are activated, and if any are preferred. Only one factor can be set as preferred. The - * preferred MFA factor will be used to authenticate a user if multiple factors are - * activated. If multiple options are activated and no preference is set, a challenge to - * choose an MFA option will be returned during sign-in.

+ * @see {@link AdminSetUserMFAPreferenceCommand} */ - public adminSetUserMFAPreference( + adminSetUserMFAPreference( args: AdminSetUserMFAPreferenceCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminSetUserMFAPreference( + adminSetUserMFAPreference( args: AdminSetUserMFAPreferenceCommandInput, cb: (err: any, data?: AdminSetUserMFAPreferenceCommandOutput) => void ): void; - public adminSetUserMFAPreference( + adminSetUserMFAPreference( args: AdminSetUserMFAPreferenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminSetUserMFAPreferenceCommandOutput) => void ): void; - public adminSetUserMFAPreference( - args: AdminSetUserMFAPreferenceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminSetUserMFAPreferenceCommandOutput) => void), - cb?: (err: any, data?: AdminSetUserMFAPreferenceCommandOutput) => void - ): Promise | void { - const command = new AdminSetUserMFAPreferenceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the specified user's password in a user pool as an administrator. Works on any - * user.

- *

The password can be temporary or permanent. If it is temporary, the user status enters - * the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the - * InitiateAuth/AdminInitiateAuth response will contain the - * NEW_PASSWORD_REQUIRED challenge. If the user doesn't sign in before it - * expires, the user won't be able to sign in, and an administrator must reset their - * password.

- *

Once the user has set a new password, or the password is permanent, the user status is - * set to Confirmed.

+ * @see {@link AdminSetUserPasswordCommand} */ - public adminSetUserPassword( + adminSetUserPassword( args: AdminSetUserPasswordCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminSetUserPassword( + adminSetUserPassword( args: AdminSetUserPasswordCommandInput, cb: (err: any, data?: AdminSetUserPasswordCommandOutput) => void ): void; - public adminSetUserPassword( + adminSetUserPassword( args: AdminSetUserPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminSetUserPasswordCommandOutput) => void ): void; - public adminSetUserPassword( - args: AdminSetUserPasswordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminSetUserPasswordCommandOutput) => void), - cb?: (err: any, data?: AdminSetUserPasswordCommandOutput) => void - ): Promise | void { - const command = new AdminSetUserPasswordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * This action is no longer supported. You can use it to configure - * only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software - * token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.

+ * @see {@link AdminSetUserSettingsCommand} */ - public adminSetUserSettings( + adminSetUserSettings( args: AdminSetUserSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminSetUserSettings( + adminSetUserSettings( args: AdminSetUserSettingsCommandInput, cb: (err: any, data?: AdminSetUserSettingsCommandOutput) => void ): void; - public adminSetUserSettings( + adminSetUserSettings( args: AdminSetUserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminSetUserSettingsCommandOutput) => void ): void; - public adminSetUserSettings( - args: AdminSetUserSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminSetUserSettingsCommandOutput) => void), - cb?: (err: any, data?: AdminSetUserSettingsCommandOutput) => void - ): Promise | void { - const command = new AdminSetUserSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides feedback for an authentication event indicating if it was from a valid user. - * This feedback is used for improving the risk evaluation decision for the user pool as - * part of Amazon Cognito advanced security.

+ * @see {@link AdminUpdateAuthEventFeedbackCommand} */ - public adminUpdateAuthEventFeedback( + adminUpdateAuthEventFeedback( args: AdminUpdateAuthEventFeedbackCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminUpdateAuthEventFeedback( + adminUpdateAuthEventFeedback( args: AdminUpdateAuthEventFeedbackCommandInput, cb: (err: any, data?: AdminUpdateAuthEventFeedbackCommandOutput) => void ): void; - public adminUpdateAuthEventFeedback( + adminUpdateAuthEventFeedback( args: AdminUpdateAuthEventFeedbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminUpdateAuthEventFeedbackCommandOutput) => void ): void; - public adminUpdateAuthEventFeedback( - args: AdminUpdateAuthEventFeedbackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminUpdateAuthEventFeedbackCommandOutput) => void), - cb?: (err: any, data?: AdminUpdateAuthEventFeedbackCommandOutput) => void - ): Promise | void { - const command = new AdminUpdateAuthEventFeedbackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the device status as an administrator.

- *

Calling this action requires developer credentials.

+ * @see {@link AdminUpdateDeviceStatusCommand} */ - public adminUpdateDeviceStatus( + adminUpdateDeviceStatus( args: AdminUpdateDeviceStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminUpdateDeviceStatus( + adminUpdateDeviceStatus( args: AdminUpdateDeviceStatusCommandInput, cb: (err: any, data?: AdminUpdateDeviceStatusCommandOutput) => void ): void; - public adminUpdateDeviceStatus( + adminUpdateDeviceStatus( args: AdminUpdateDeviceStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminUpdateDeviceStatusCommandOutput) => void ): void; - public adminUpdateDeviceStatus( - args: AdminUpdateDeviceStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminUpdateDeviceStatusCommandOutput) => void), - cb?: (err: any, data?: AdminUpdateDeviceStatusCommandOutput) => void - ): Promise | void { - const command = new AdminUpdateDeviceStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified user's attributes, including developer attributes, as an - * administrator. Works on any user.

- *

For custom attributes, you must prepend the custom: prefix to the - * attribute name.

- *

In addition to updating user attributes, this API can also be used to mark phone and - * email as verified.

- * - * - *

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers - * require you to register an origination phone number before you can send SMS messages - * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a - * phone number with Amazon Pinpoint. - * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must - * receive SMS messages might not be able to sign up, activate their accounts, or sign - * in.

- *

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, - * Amazon Simple Notification Service might place your account in the SMS sandbox. In - * sandbox - * mode - * , you can send messages only to verified phone - * numbers. After you test your app while in the sandbox environment, you can move out - * of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito - * Developer Guide.

- *
- * - *

Calling this action requires developer credentials.

+ * @see {@link AdminUpdateUserAttributesCommand} */ - public adminUpdateUserAttributes( + adminUpdateUserAttributes( args: AdminUpdateUserAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminUpdateUserAttributes( + adminUpdateUserAttributes( args: AdminUpdateUserAttributesCommandInput, cb: (err: any, data?: AdminUpdateUserAttributesCommandOutput) => void ): void; - public adminUpdateUserAttributes( + adminUpdateUserAttributes( args: AdminUpdateUserAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminUpdateUserAttributesCommandOutput) => void ): void; - public adminUpdateUserAttributes( - args: AdminUpdateUserAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminUpdateUserAttributesCommandOutput) => void), - cb?: (err: any, data?: AdminUpdateUserAttributesCommandOutput) => void - ): Promise | void { - const command = new AdminUpdateUserAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Signs out a user from all devices. You must sign AdminUserGlobalSignOut requests - * with Amazon Web Services credentials. It also invalidates all refresh tokens that Amazon Cognito has issued to - * a user. The user's current access and ID tokens remain valid until they expire. By - * default, access and ID tokens expire one hour after they're issued. A user can still use - * a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period - * of 1 hour.

- *

Calling this action requires developer credentials.

+ * @see {@link AdminUserGlobalSignOutCommand} */ - public adminUserGlobalSignOut( + adminUserGlobalSignOut( args: AdminUserGlobalSignOutCommandInput, options?: __HttpHandlerOptions ): Promise; - public adminUserGlobalSignOut( + adminUserGlobalSignOut( args: AdminUserGlobalSignOutCommandInput, cb: (err: any, data?: AdminUserGlobalSignOutCommandOutput) => void ): void; - public adminUserGlobalSignOut( + adminUserGlobalSignOut( args: AdminUserGlobalSignOutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdminUserGlobalSignOutCommandOutput) => void ): void; - public adminUserGlobalSignOut( - args: AdminUserGlobalSignOutCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdminUserGlobalSignOutCommandOutput) => void), - cb?: (err: any, data?: AdminUserGlobalSignOutCommandOutput) => void - ): Promise | void { - const command = new AdminUserGlobalSignOutCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) - * for a user, with a unique private key that Amazon Cognito generates and returns in the API - * response. You can authorize an AssociateSoftwareToken request with either - * the user's access token, or a session string from a challenge response that you received - * from Amazon Cognito.

- * - *

Amazon Cognito disassociates an existing software token when you verify the new token in a - * VerifySoftwareToken API request. If you don't verify the software - * token and your user pool doesn't require MFA, the user can then authenticate with - * user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito - * generates an MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge - * each time your user signs. Complete setup with AssociateSoftwareToken - * and VerifySoftwareToken.

- *

After you set up software token MFA for your user, Amazon Cognito generates a - * SOFTWARE_TOKEN_MFA challenge when they authenticate. Respond to - * this challenge with your user's TOTP.

- *
+ * @see {@link AssociateSoftwareTokenCommand} */ - public associateSoftwareToken( + associateSoftwareToken( args: AssociateSoftwareTokenCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateSoftwareToken( + associateSoftwareToken( args: AssociateSoftwareTokenCommandInput, cb: (err: any, data?: AssociateSoftwareTokenCommandOutput) => void ): void; - public associateSoftwareToken( + associateSoftwareToken( args: AssociateSoftwareTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateSoftwareTokenCommandOutput) => void ): void; - public associateSoftwareToken( - args: AssociateSoftwareTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateSoftwareTokenCommandOutput) => void), - cb?: (err: any, data?: AssociateSoftwareTokenCommandOutput) => void - ): Promise | void { - const command = new AssociateSoftwareTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes the password for a specified user in a user pool.

+ * @see {@link ChangePasswordCommand} */ - public changePassword( + changePassword( args: ChangePasswordCommandInput, options?: __HttpHandlerOptions ): Promise; - public changePassword( - args: ChangePasswordCommandInput, - cb: (err: any, data?: ChangePasswordCommandOutput) => void - ): void; - public changePassword( + changePassword(args: ChangePasswordCommandInput, cb: (err: any, data?: ChangePasswordCommandOutput) => void): void; + changePassword( args: ChangePasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChangePasswordCommandOutput) => void ): void; - public changePassword( - args: ChangePasswordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ChangePasswordCommandOutput) => void), - cb?: (err: any, data?: ChangePasswordCommandOutput) => void - ): Promise | void { - const command = new ChangePasswordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Confirms tracking of the device. This API call is the call that begins device - * tracking.

+ * @see {@link ConfirmDeviceCommand} */ - public confirmDevice( - args: ConfirmDeviceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public confirmDevice( - args: ConfirmDeviceCommandInput, - cb: (err: any, data?: ConfirmDeviceCommandOutput) => void - ): void; - public confirmDevice( + confirmDevice(args: ConfirmDeviceCommandInput, options?: __HttpHandlerOptions): Promise; + confirmDevice(args: ConfirmDeviceCommandInput, cb: (err: any, data?: ConfirmDeviceCommandOutput) => void): void; + confirmDevice( args: ConfirmDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfirmDeviceCommandOutput) => void ): void; - public confirmDevice( - args: ConfirmDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConfirmDeviceCommandOutput) => void), - cb?: (err: any, data?: ConfirmDeviceCommandOutput) => void - ): Promise | void { - const command = new ConfirmDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows a user to enter a confirmation code to reset a forgotten password.

+ * @see {@link ConfirmForgotPasswordCommand} */ - public confirmForgotPassword( + confirmForgotPassword( args: ConfirmForgotPasswordCommandInput, options?: __HttpHandlerOptions ): Promise; - public confirmForgotPassword( + confirmForgotPassword( args: ConfirmForgotPasswordCommandInput, cb: (err: any, data?: ConfirmForgotPasswordCommandOutput) => void ): void; - public confirmForgotPassword( + confirmForgotPassword( args: ConfirmForgotPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfirmForgotPasswordCommandOutput) => void ): void; - public confirmForgotPassword( - args: ConfirmForgotPasswordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConfirmForgotPasswordCommandOutput) => void), - cb?: (err: any, data?: ConfirmForgotPasswordCommandOutput) => void - ): Promise | void { - const command = new ConfirmForgotPasswordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Confirms registration of a new user.

+ * @see {@link ConfirmSignUpCommand} */ - public confirmSignUp( - args: ConfirmSignUpCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public confirmSignUp( - args: ConfirmSignUpCommandInput, - cb: (err: any, data?: ConfirmSignUpCommandOutput) => void - ): void; - public confirmSignUp( + confirmSignUp(args: ConfirmSignUpCommandInput, options?: __HttpHandlerOptions): Promise; + confirmSignUp(args: ConfirmSignUpCommandInput, cb: (err: any, data?: ConfirmSignUpCommandOutput) => void): void; + confirmSignUp( args: ConfirmSignUpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfirmSignUpCommandOutput) => void ): void; - public confirmSignUp( - args: ConfirmSignUpCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConfirmSignUpCommandOutput) => void), - cb?: (err: any, data?: ConfirmSignUpCommandOutput) => void - ): Promise | void { - const command = new ConfirmSignUpCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new group in the specified user pool.

- *

Calling this action requires developer credentials.

+ * @see {@link CreateGroupCommand} */ - public createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void; - public createGroup( + createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise; + createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void; + createGroup( args: CreateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupCommandOutput) => void ): void; - public createGroup( - args: CreateGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGroupCommandOutput) => void), - cb?: (err: any, data?: CreateGroupCommandOutput) => void - ): Promise | void { - const command = new CreateGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an IdP for a user pool.

+ * @see {@link CreateIdentityProviderCommand} */ - public createIdentityProvider( + createIdentityProvider( args: CreateIdentityProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public createIdentityProvider( + createIdentityProvider( args: CreateIdentityProviderCommandInput, cb: (err: any, data?: CreateIdentityProviderCommandOutput) => void ): void; - public createIdentityProvider( + createIdentityProvider( args: CreateIdentityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIdentityProviderCommandOutput) => void ): void; - public createIdentityProvider( - args: CreateIdentityProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIdentityProviderCommandOutput) => void), - cb?: (err: any, data?: CreateIdentityProviderCommandOutput) => void - ): Promise | void { - const command = new CreateIdentityProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new OAuth2.0 resource server and defines custom scopes within it.

+ * @see {@link CreateResourceServerCommand} */ - public createResourceServer( + createResourceServer( args: CreateResourceServerCommandInput, options?: __HttpHandlerOptions ): Promise; - public createResourceServer( + createResourceServer( args: CreateResourceServerCommandInput, cb: (err: any, data?: CreateResourceServerCommandOutput) => void ): void; - public createResourceServer( + createResourceServer( args: CreateResourceServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResourceServerCommandOutput) => void ): void; - public createResourceServer( - args: CreateResourceServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateResourceServerCommandOutput) => void), - cb?: (err: any, data?: CreateResourceServerCommandOutput) => void - ): Promise | void { - const command = new CreateResourceServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates the user import job.

+ * @see {@link CreateUserImportJobCommand} */ - public createUserImportJob( + createUserImportJob( args: CreateUserImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createUserImportJob( + createUserImportJob( args: CreateUserImportJobCommandInput, cb: (err: any, data?: CreateUserImportJobCommandOutput) => void ): void; - public createUserImportJob( + createUserImportJob( args: CreateUserImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserImportJobCommandOutput) => void ): void; - public createUserImportJob( - args: CreateUserImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserImportJobCommandOutput) => void), - cb?: (err: any, data?: CreateUserImportJobCommandOutput) => void - ): Promise | void { - const command = new CreateUserImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new Amazon Cognito user pool and sets the password policy for the - * pool.

- * - * - *

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers - * require you to register an origination phone number before you can send SMS messages - * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a - * phone number with Amazon Pinpoint. - * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must - * receive SMS messages might not be able to sign up, activate their accounts, or sign - * in.

- *

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, - * Amazon Simple Notification Service might place your account in the SMS sandbox. In - * sandbox - * mode - * , you can send messages only to verified phone - * numbers. After you test your app while in the sandbox environment, you can move out - * of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito - * Developer Guide.

- *
+ * @see {@link CreateUserPoolCommand} */ - public createUserPool( + createUserPool( args: CreateUserPoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public createUserPool( - args: CreateUserPoolCommandInput, - cb: (err: any, data?: CreateUserPoolCommandOutput) => void - ): void; - public createUserPool( + createUserPool(args: CreateUserPoolCommandInput, cb: (err: any, data?: CreateUserPoolCommandOutput) => void): void; + createUserPool( args: CreateUserPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserPoolCommandOutput) => void ): void; - public createUserPool( - args: CreateUserPoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserPoolCommandOutput) => void), - cb?: (err: any, data?: CreateUserPoolCommandOutput) => void - ): Promise | void { - const command = new CreateUserPoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates the user pool client.

- *

When you create a new user pool client, token revocation is automatically activated. - * For more information about revoking tokens, see RevokeToken.

+ * @see {@link CreateUserPoolClientCommand} */ - public createUserPoolClient( + createUserPoolClient( args: CreateUserPoolClientCommandInput, options?: __HttpHandlerOptions ): Promise; - public createUserPoolClient( + createUserPoolClient( args: CreateUserPoolClientCommandInput, cb: (err: any, data?: CreateUserPoolClientCommandOutput) => void ): void; - public createUserPoolClient( + createUserPoolClient( args: CreateUserPoolClientCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserPoolClientCommandOutput) => void ): void; - public createUserPoolClient( - args: CreateUserPoolClientCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserPoolClientCommandOutput) => void), - cb?: (err: any, data?: CreateUserPoolClientCommandOutput) => void - ): Promise | void { - const command = new CreateUserPoolClientCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new domain for a user pool.

+ * @see {@link CreateUserPoolDomainCommand} */ - public createUserPoolDomain( + createUserPoolDomain( args: CreateUserPoolDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public createUserPoolDomain( + createUserPoolDomain( args: CreateUserPoolDomainCommandInput, cb: (err: any, data?: CreateUserPoolDomainCommandOutput) => void ): void; - public createUserPoolDomain( + createUserPoolDomain( args: CreateUserPoolDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserPoolDomainCommandOutput) => void ): void; - public createUserPoolDomain( - args: CreateUserPoolDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserPoolDomainCommandOutput) => void), - cb?: (err: any, data?: CreateUserPoolDomainCommandOutput) => void - ): Promise | void { - const command = new CreateUserPoolDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a group.

- *

Calling this action requires developer credentials.

+ * @see {@link DeleteGroupCommand} */ - public deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void; - public deleteGroup( + deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise; + deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void; + deleteGroup( args: DeleteGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupCommandOutput) => void ): void; - public deleteGroup( - args: DeleteGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an IdP for a user pool.

+ * @see {@link DeleteIdentityProviderCommand} */ - public deleteIdentityProvider( + deleteIdentityProvider( args: DeleteIdentityProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteIdentityProvider( + deleteIdentityProvider( args: DeleteIdentityProviderCommandInput, cb: (err: any, data?: DeleteIdentityProviderCommandOutput) => void ): void; - public deleteIdentityProvider( + deleteIdentityProvider( args: DeleteIdentityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIdentityProviderCommandOutput) => void ): void; - public deleteIdentityProvider( - args: DeleteIdentityProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIdentityProviderCommandOutput) => void), - cb?: (err: any, data?: DeleteIdentityProviderCommandOutput) => void - ): Promise | void { - const command = new DeleteIdentityProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a resource server.

+ * @see {@link DeleteResourceServerCommand} */ - public deleteResourceServer( + deleteResourceServer( args: DeleteResourceServerCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourceServer( + deleteResourceServer( args: DeleteResourceServerCommandInput, cb: (err: any, data?: DeleteResourceServerCommandOutput) => void ): void; - public deleteResourceServer( + deleteResourceServer( args: DeleteResourceServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourceServerCommandOutput) => void ): void; - public deleteResourceServer( - args: DeleteResourceServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourceServerCommandOutput) => void), - cb?: (err: any, data?: DeleteResourceServerCommandOutput) => void - ): Promise | void { - const command = new DeleteResourceServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows a user to delete himself or herself.

+ * @see {@link DeleteUserCommand} */ - public deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; - public deleteUser( + deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; + deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; + deleteUser( args: DeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserCommandOutput) => void ): void; - public deleteUser( - args: DeleteUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserCommandOutput) => void), - cb?: (err: any, data?: DeleteUserCommandOutput) => void - ): Promise | void { - const command = new DeleteUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the attributes for a user.

+ * @see {@link DeleteUserAttributesCommand} */ - public deleteUserAttributes( + deleteUserAttributes( args: DeleteUserAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteUserAttributes( + deleteUserAttributes( args: DeleteUserAttributesCommandInput, cb: (err: any, data?: DeleteUserAttributesCommandOutput) => void ): void; - public deleteUserAttributes( + deleteUserAttributes( args: DeleteUserAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserAttributesCommandOutput) => void ): void; - public deleteUserAttributes( - args: DeleteUserAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserAttributesCommandOutput) => void), - cb?: (err: any, data?: DeleteUserAttributesCommandOutput) => void - ): Promise | void { - const command = new DeleteUserAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified Amazon Cognito user pool.

+ * @see {@link DeleteUserPoolCommand} */ - public deleteUserPool( + deleteUserPool( args: DeleteUserPoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteUserPool( - args: DeleteUserPoolCommandInput, - cb: (err: any, data?: DeleteUserPoolCommandOutput) => void - ): void; - public deleteUserPool( + deleteUserPool(args: DeleteUserPoolCommandInput, cb: (err: any, data?: DeleteUserPoolCommandOutput) => void): void; + deleteUserPool( args: DeleteUserPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserPoolCommandOutput) => void ): void; - public deleteUserPool( - args: DeleteUserPoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserPoolCommandOutput) => void), - cb?: (err: any, data?: DeleteUserPoolCommandOutput) => void - ): Promise | void { - const command = new DeleteUserPoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows the developer to delete the user pool client.

+ * @see {@link DeleteUserPoolClientCommand} */ - public deleteUserPoolClient( + deleteUserPoolClient( args: DeleteUserPoolClientCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteUserPoolClient( + deleteUserPoolClient( args: DeleteUserPoolClientCommandInput, cb: (err: any, data?: DeleteUserPoolClientCommandOutput) => void ): void; - public deleteUserPoolClient( + deleteUserPoolClient( args: DeleteUserPoolClientCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserPoolClientCommandOutput) => void ): void; - public deleteUserPoolClient( - args: DeleteUserPoolClientCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserPoolClientCommandOutput) => void), - cb?: (err: any, data?: DeleteUserPoolClientCommandOutput) => void - ): Promise | void { - const command = new DeleteUserPoolClientCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a domain for a user pool.

+ * @see {@link DeleteUserPoolDomainCommand} */ - public deleteUserPoolDomain( + deleteUserPoolDomain( args: DeleteUserPoolDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteUserPoolDomain( + deleteUserPoolDomain( args: DeleteUserPoolDomainCommandInput, cb: (err: any, data?: DeleteUserPoolDomainCommandOutput) => void ): void; - public deleteUserPoolDomain( + deleteUserPoolDomain( args: DeleteUserPoolDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserPoolDomainCommandOutput) => void ): void; - public deleteUserPoolDomain( - args: DeleteUserPoolDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserPoolDomainCommandOutput) => void), - cb?: (err: any, data?: DeleteUserPoolDomainCommandOutput) => void - ): Promise | void { - const command = new DeleteUserPoolDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a specific IdP.

+ * @see {@link DescribeIdentityProviderCommand} */ - public describeIdentityProvider( + describeIdentityProvider( args: DescribeIdentityProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeIdentityProvider( + describeIdentityProvider( args: DescribeIdentityProviderCommandInput, cb: (err: any, data?: DescribeIdentityProviderCommandOutput) => void ): void; - public describeIdentityProvider( + describeIdentityProvider( args: DescribeIdentityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIdentityProviderCommandOutput) => void ): void; - public describeIdentityProvider( - args: DescribeIdentityProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeIdentityProviderCommandOutput) => void), - cb?: (err: any, data?: DescribeIdentityProviderCommandOutput) => void - ): Promise | void { - const command = new DescribeIdentityProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a resource server.

+ * @see {@link DescribeResourceServerCommand} */ - public describeResourceServer( + describeResourceServer( args: DescribeResourceServerCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeResourceServer( + describeResourceServer( args: DescribeResourceServerCommandInput, cb: (err: any, data?: DescribeResourceServerCommandOutput) => void ): void; - public describeResourceServer( + describeResourceServer( args: DescribeResourceServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeResourceServerCommandOutput) => void ): void; - public describeResourceServer( - args: DescribeResourceServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeResourceServerCommandOutput) => void), - cb?: (err: any, data?: DescribeResourceServerCommandOutput) => void - ): Promise | void { - const command = new DescribeResourceServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the risk configuration.

+ * @see {@link DescribeRiskConfigurationCommand} */ - public describeRiskConfiguration( + describeRiskConfiguration( args: DescribeRiskConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRiskConfiguration( + describeRiskConfiguration( args: DescribeRiskConfigurationCommandInput, cb: (err: any, data?: DescribeRiskConfigurationCommandOutput) => void ): void; - public describeRiskConfiguration( + describeRiskConfiguration( args: DescribeRiskConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRiskConfigurationCommandOutput) => void ): void; - public describeRiskConfiguration( - args: DescribeRiskConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRiskConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeRiskConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeRiskConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the user import job.

+ * @see {@link DescribeUserImportJobCommand} */ - public describeUserImportJob( + describeUserImportJob( args: DescribeUserImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeUserImportJob( + describeUserImportJob( args: DescribeUserImportJobCommandInput, cb: (err: any, data?: DescribeUserImportJobCommandOutput) => void ): void; - public describeUserImportJob( + describeUserImportJob( args: DescribeUserImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserImportJobCommandOutput) => void ): void; - public describeUserImportJob( - args: DescribeUserImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUserImportJobCommandOutput) => void), - cb?: (err: any, data?: DescribeUserImportJobCommandOutput) => void - ): Promise | void { - const command = new DescribeUserImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the configuration information and metadata of the specified user pool.

+ * @see {@link DescribeUserPoolCommand} */ - public describeUserPool( + describeUserPool( args: DescribeUserPoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeUserPool( + describeUserPool( args: DescribeUserPoolCommandInput, cb: (err: any, data?: DescribeUserPoolCommandOutput) => void ): void; - public describeUserPool( + describeUserPool( args: DescribeUserPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserPoolCommandOutput) => void ): void; - public describeUserPool( - args: DescribeUserPoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUserPoolCommandOutput) => void), - cb?: (err: any, data?: DescribeUserPoolCommandOutput) => void - ): Promise | void { - const command = new DescribeUserPoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Client method for returning the configuration information and metadata of the - * specified user pool app client.

+ * @see {@link DescribeUserPoolClientCommand} */ - public describeUserPoolClient( + describeUserPoolClient( args: DescribeUserPoolClientCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeUserPoolClient( + describeUserPoolClient( args: DescribeUserPoolClientCommandInput, cb: (err: any, data?: DescribeUserPoolClientCommandOutput) => void ): void; - public describeUserPoolClient( + describeUserPoolClient( args: DescribeUserPoolClientCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserPoolClientCommandOutput) => void ): void; - public describeUserPoolClient( - args: DescribeUserPoolClientCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUserPoolClientCommandOutput) => void), - cb?: (err: any, data?: DescribeUserPoolClientCommandOutput) => void - ): Promise | void { - const command = new DescribeUserPoolClientCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a domain.

+ * @see {@link DescribeUserPoolDomainCommand} */ - public describeUserPoolDomain( + describeUserPoolDomain( args: DescribeUserPoolDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeUserPoolDomain( + describeUserPoolDomain( args: DescribeUserPoolDomainCommandInput, cb: (err: any, data?: DescribeUserPoolDomainCommandOutput) => void ): void; - public describeUserPoolDomain( + describeUserPoolDomain( args: DescribeUserPoolDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserPoolDomainCommandOutput) => void ): void; - public describeUserPoolDomain( - args: DescribeUserPoolDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUserPoolDomainCommandOutput) => void), - cb?: (err: any, data?: DescribeUserPoolDomainCommandOutput) => void - ): Promise | void { - const command = new DescribeUserPoolDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Forgets the specified device.

+ * @see {@link ForgetDeviceCommand} */ - public forgetDevice( - args: ForgetDeviceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public forgetDevice(args: ForgetDeviceCommandInput, cb: (err: any, data?: ForgetDeviceCommandOutput) => void): void; - public forgetDevice( + forgetDevice(args: ForgetDeviceCommandInput, options?: __HttpHandlerOptions): Promise; + forgetDevice(args: ForgetDeviceCommandInput, cb: (err: any, data?: ForgetDeviceCommandOutput) => void): void; + forgetDevice( args: ForgetDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ForgetDeviceCommandOutput) => void ): void; - public forgetDevice( - args: ForgetDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ForgetDeviceCommandOutput) => void), - cb?: (err: any, data?: ForgetDeviceCommandOutput) => void - ): Promise | void { - const command = new ForgetDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Calling this API causes a message to be sent to the end user with a confirmation code - * that is required to change the user's password. For the Username parameter, - * you can use the username or user alias. The method used to send the confirmation code is - * sent according to the specified AccountRecoverySetting. For more information, see Recovering - * User Accounts in the Amazon Cognito Developer Guide. If - * neither a verified phone number nor a verified email exists, an - * InvalidParameterException is thrown. To use the confirmation code for - * resetting the password, call ConfirmForgotPassword.

- * - * - *

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers - * require you to register an origination phone number before you can send SMS messages - * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a - * phone number with Amazon Pinpoint. - * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must - * receive SMS messages might not be able to sign up, activate their accounts, or sign - * in.

- *

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, - * Amazon Simple Notification Service might place your account in the SMS sandbox. In - * sandbox - * mode - * , you can send messages only to verified phone - * numbers. After you test your app while in the sandbox environment, you can move out - * of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito - * Developer Guide.

- *
+ * @see {@link ForgotPasswordCommand} */ - public forgotPassword( + forgotPassword( args: ForgotPasswordCommandInput, options?: __HttpHandlerOptions ): Promise; - public forgotPassword( - args: ForgotPasswordCommandInput, - cb: (err: any, data?: ForgotPasswordCommandOutput) => void - ): void; - public forgotPassword( + forgotPassword(args: ForgotPasswordCommandInput, cb: (err: any, data?: ForgotPasswordCommandOutput) => void): void; + forgotPassword( args: ForgotPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ForgotPasswordCommandOutput) => void ): void; - public forgotPassword( - args: ForgotPasswordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ForgotPasswordCommandOutput) => void), - cb?: (err: any, data?: ForgotPasswordCommandOutput) => void - ): Promise | void { - const command = new ForgotPasswordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the header information for the comma-separated value (CSV) file to be used as - * input for the user import job.

+ * @see {@link GetCSVHeaderCommand} */ - public getCSVHeader( - args: GetCSVHeaderCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getCSVHeader(args: GetCSVHeaderCommandInput, cb: (err: any, data?: GetCSVHeaderCommandOutput) => void): void; - public getCSVHeader( + getCSVHeader(args: GetCSVHeaderCommandInput, options?: __HttpHandlerOptions): Promise; + getCSVHeader(args: GetCSVHeaderCommandInput, cb: (err: any, data?: GetCSVHeaderCommandOutput) => void): void; + getCSVHeader( args: GetCSVHeaderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCSVHeaderCommandOutput) => void ): void; - public getCSVHeader( - args: GetCSVHeaderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCSVHeaderCommandOutput) => void), - cb?: (err: any, data?: GetCSVHeaderCommandOutput) => void - ): Promise | void { - const command = new GetCSVHeaderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the device.

+ * @see {@link GetDeviceCommand} */ - public getDevice(args: GetDeviceCommandInput, options?: __HttpHandlerOptions): Promise; - public getDevice(args: GetDeviceCommandInput, cb: (err: any, data?: GetDeviceCommandOutput) => void): void; - public getDevice( + getDevice(args: GetDeviceCommandInput, options?: __HttpHandlerOptions): Promise; + getDevice(args: GetDeviceCommandInput, cb: (err: any, data?: GetDeviceCommandOutput) => void): void; + getDevice( args: GetDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeviceCommandOutput) => void ): void; - public getDevice( - args: GetDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeviceCommandOutput) => void), - cb?: (err: any, data?: GetDeviceCommandOutput) => void - ): Promise | void { - const command = new GetDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a group.

- *

Calling this action requires developer credentials.

+ * @see {@link GetGroupCommand} */ - public getGroup(args: GetGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public getGroup(args: GetGroupCommandInput, cb: (err: any, data?: GetGroupCommandOutput) => void): void; - public getGroup( + getGroup(args: GetGroupCommandInput, options?: __HttpHandlerOptions): Promise; + getGroup(args: GetGroupCommandInput, cb: (err: any, data?: GetGroupCommandOutput) => void): void; + getGroup( args: GetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupCommandOutput) => void ): void; - public getGroup( - args: GetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGroupCommandOutput) => void), - cb?: (err: any, data?: GetGroupCommandOutput) => void - ): Promise | void { - const command = new GetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the specified IdP.

+ * @see {@link GetIdentityProviderByIdentifierCommand} */ - public getIdentityProviderByIdentifier( + getIdentityProviderByIdentifier( args: GetIdentityProviderByIdentifierCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIdentityProviderByIdentifier( + getIdentityProviderByIdentifier( args: GetIdentityProviderByIdentifierCommandInput, cb: (err: any, data?: GetIdentityProviderByIdentifierCommandOutput) => void ): void; - public getIdentityProviderByIdentifier( + getIdentityProviderByIdentifier( args: GetIdentityProviderByIdentifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIdentityProviderByIdentifierCommandOutput) => void ): void; - public getIdentityProviderByIdentifier( - args: GetIdentityProviderByIdentifierCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIdentityProviderByIdentifierCommandOutput) => void), - cb?: (err: any, data?: GetIdentityProviderByIdentifierCommandOutput) => void - ): Promise | void { - const command = new GetIdentityProviderByIdentifierCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This method takes a user pool ID, and returns the signing certificate. The issued certificate is valid for 10 years from the date of issue.

- *

Amazon Cognito issues and assigns a new signing certificate annually. This process returns a new value in the response to GetSigningCertificate, - * but doesn't invalidate the original certificate.

+ * @see {@link GetSigningCertificateCommand} */ - public getSigningCertificate( + getSigningCertificate( args: GetSigningCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSigningCertificate( + getSigningCertificate( args: GetSigningCertificateCommandInput, cb: (err: any, data?: GetSigningCertificateCommandOutput) => void ): void; - public getSigningCertificate( + getSigningCertificate( args: GetSigningCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSigningCertificateCommandOutput) => void ): void; - public getSigningCertificate( - args: GetSigningCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSigningCertificateCommandOutput) => void), - cb?: (err: any, data?: GetSigningCertificateCommandOutput) => void - ): Promise | void { - const command = new GetSigningCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the user interface (UI) Customization information for a particular app client's - * app UI, if any such information exists for the client. If nothing is set for the - * particular client, but there is an existing pool level customization (the app - * clientId is ALL), then that information is returned. If - * nothing is present, then an empty shape is returned.

+ * @see {@link GetUICustomizationCommand} */ - public getUICustomization( + getUICustomization( args: GetUICustomizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUICustomization( + getUICustomization( args: GetUICustomizationCommandInput, cb: (err: any, data?: GetUICustomizationCommandOutput) => void ): void; - public getUICustomization( + getUICustomization( args: GetUICustomizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUICustomizationCommandOutput) => void ): void; - public getUICustomization( - args: GetUICustomizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUICustomizationCommandOutput) => void), - cb?: (err: any, data?: GetUICustomizationCommandOutput) => void - ): Promise | void { - const command = new GetUICustomizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the user attributes and metadata for a user.

+ * @see {@link GetUserCommand} */ - public getUser(args: GetUserCommandInput, options?: __HttpHandlerOptions): Promise; - public getUser(args: GetUserCommandInput, cb: (err: any, data?: GetUserCommandOutput) => void): void; - public getUser( + getUser(args: GetUserCommandInput, options?: __HttpHandlerOptions): Promise; + getUser(args: GetUserCommandInput, cb: (err: any, data?: GetUserCommandOutput) => void): void; + getUser( args: GetUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserCommandOutput) => void ): void; - public getUser( - args: GetUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUserCommandOutput) => void), - cb?: (err: any, data?: GetUserCommandOutput) => void - ): Promise | void { - const command = new GetUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Generates a user attribute verification code for the specified attribute name. Sends a - * message to a user with a code that they must return in a VerifyUserAttribute - * request.

- * - * - *

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers - * require you to register an origination phone number before you can send SMS messages - * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a - * phone number with Amazon Pinpoint. - * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must - * receive SMS messages might not be able to sign up, activate their accounts, or sign - * in.

- *

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, - * Amazon Simple Notification Service might place your account in the SMS sandbox. In - * sandbox - * mode - * , you can send messages only to verified phone - * numbers. After you test your app while in the sandbox environment, you can move out - * of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito - * Developer Guide.

- *
+ * @see {@link GetUserAttributeVerificationCodeCommand} */ - public getUserAttributeVerificationCode( + getUserAttributeVerificationCode( args: GetUserAttributeVerificationCodeCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUserAttributeVerificationCode( + getUserAttributeVerificationCode( args: GetUserAttributeVerificationCodeCommandInput, cb: (err: any, data?: GetUserAttributeVerificationCodeCommandOutput) => void ): void; - public getUserAttributeVerificationCode( + getUserAttributeVerificationCode( args: GetUserAttributeVerificationCodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserAttributeVerificationCodeCommandOutput) => void ): void; - public getUserAttributeVerificationCode( - args: GetUserAttributeVerificationCodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUserAttributeVerificationCodeCommandOutput) => void), - cb?: (err: any, data?: GetUserAttributeVerificationCodeCommandOutput) => void - ): Promise | void { - const command = new GetUserAttributeVerificationCodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the user pool multi-factor authentication (MFA) configuration.

+ * @see {@link GetUserPoolMfaConfigCommand} */ - public getUserPoolMfaConfig( + getUserPoolMfaConfig( args: GetUserPoolMfaConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUserPoolMfaConfig( + getUserPoolMfaConfig( args: GetUserPoolMfaConfigCommandInput, cb: (err: any, data?: GetUserPoolMfaConfigCommandOutput) => void ): void; - public getUserPoolMfaConfig( + getUserPoolMfaConfig( args: GetUserPoolMfaConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserPoolMfaConfigCommandOutput) => void ): void; - public getUserPoolMfaConfig( - args: GetUserPoolMfaConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUserPoolMfaConfigCommandOutput) => void), - cb?: (err: any, data?: GetUserPoolMfaConfigCommandOutput) => void - ): Promise | void { - const command = new GetUserPoolMfaConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito - * has issued to a user. A user can still use a hosted UI cookie to retrieve new tokens - * for the duration of the 1-hour cookie validity period.

+ * @see {@link GlobalSignOutCommand} */ - public globalSignOut( - args: GlobalSignOutCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public globalSignOut( - args: GlobalSignOutCommandInput, - cb: (err: any, data?: GlobalSignOutCommandOutput) => void - ): void; - public globalSignOut( + globalSignOut(args: GlobalSignOutCommandInput, options?: __HttpHandlerOptions): Promise; + globalSignOut(args: GlobalSignOutCommandInput, cb: (err: any, data?: GlobalSignOutCommandOutput) => void): void; + globalSignOut( args: GlobalSignOutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GlobalSignOutCommandOutput) => void ): void; - public globalSignOut( - args: GlobalSignOutCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GlobalSignOutCommandOutput) => void), - cb?: (err: any, data?: GlobalSignOutCommandOutput) => void - ): Promise | void { - const command = new GlobalSignOutCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user - * with a federated IdP with InitiateAuth. For more information, see Adding user pool sign-in through a third party.

- * - * - *

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers - * require you to register an origination phone number before you can send SMS messages - * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a - * phone number with Amazon Pinpoint. - * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must - * receive SMS messages might not be able to sign up, activate their accounts, or sign - * in.

- *

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, - * Amazon Simple Notification Service might place your account in the SMS sandbox. In - * sandbox - * mode - * , you can send messages only to verified phone - * numbers. After you test your app while in the sandbox environment, you can move out - * of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito - * Developer Guide.

- *
+ * @see {@link InitiateAuthCommand} */ - public initiateAuth( - args: InitiateAuthCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public initiateAuth(args: InitiateAuthCommandInput, cb: (err: any, data?: InitiateAuthCommandOutput) => void): void; - public initiateAuth( + initiateAuth(args: InitiateAuthCommandInput, options?: __HttpHandlerOptions): Promise; + initiateAuth(args: InitiateAuthCommandInput, cb: (err: any, data?: InitiateAuthCommandOutput) => void): void; + initiateAuth( args: InitiateAuthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InitiateAuthCommandOutput) => void ): void; - public initiateAuth( - args: InitiateAuthCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InitiateAuthCommandOutput) => void), - cb?: (err: any, data?: InitiateAuthCommandOutput) => void - ): Promise | void { - const command = new InitiateAuthCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the sign-in devices that Amazon Cognito has registered to the current user.

+ * @see {@link ListDevicesCommand} */ - public listDevices(args: ListDevicesCommandInput, options?: __HttpHandlerOptions): Promise; - public listDevices(args: ListDevicesCommandInput, cb: (err: any, data?: ListDevicesCommandOutput) => void): void; - public listDevices( + listDevices(args: ListDevicesCommandInput, options?: __HttpHandlerOptions): Promise; + listDevices(args: ListDevicesCommandInput, cb: (err: any, data?: ListDevicesCommandOutput) => void): void; + listDevices( args: ListDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDevicesCommandOutput) => void ): void; - public listDevices( - args: ListDevicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDevicesCommandOutput) => void), - cb?: (err: any, data?: ListDevicesCommandOutput) => void - ): Promise | void { - const command = new ListDevicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the groups associated with a user pool.

- *

Calling this action requires developer credentials.

+ * @see {@link ListGroupsCommand} */ - public listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise; - public listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void; - public listGroups( + listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise; + listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void; + listGroups( args: ListGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsCommandOutput) => void ): void; - public listGroups( - args: ListGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGroupsCommandOutput) => void), - cb?: (err: any, data?: ListGroupsCommandOutput) => void - ): Promise | void { - const command = new ListGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists information about all IdPs for a user pool.

+ * @see {@link ListIdentityProvidersCommand} */ - public listIdentityProviders( + listIdentityProviders( args: ListIdentityProvidersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listIdentityProviders( + listIdentityProviders( args: ListIdentityProvidersCommandInput, cb: (err: any, data?: ListIdentityProvidersCommandOutput) => void ): void; - public listIdentityProviders( + listIdentityProviders( args: ListIdentityProvidersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIdentityProvidersCommandOutput) => void ): void; - public listIdentityProviders( - args: ListIdentityProvidersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIdentityProvidersCommandOutput) => void), - cb?: (err: any, data?: ListIdentityProvidersCommandOutput) => void - ): Promise | void { - const command = new ListIdentityProvidersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the resource servers for a user pool.

+ * @see {@link ListResourceServersCommand} */ - public listResourceServers( + listResourceServers( args: ListResourceServersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourceServers( + listResourceServers( args: ListResourceServersCommandInput, cb: (err: any, data?: ListResourceServersCommandOutput) => void ): void; - public listResourceServers( + listResourceServers( args: ListResourceServersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceServersCommandOutput) => void ): void; - public listResourceServers( - args: ListResourceServersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourceServersCommandOutput) => void), - cb?: (err: any, data?: ListResourceServersCommandOutput) => void - ): Promise | void { - const command = new ListResourceServersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags that are assigned to an Amazon Cognito user pool.

- *

A tag is a label that you can apply to user pools to categorize and manage them in - * different ways, such as by purpose, owner, environment, or other criteria.

- *

You can use this action up to 10 times per second, per account.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the user import jobs.

+ * @see {@link ListUserImportJobsCommand} */ - public listUserImportJobs( + listUserImportJobs( args: ListUserImportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listUserImportJobs( + listUserImportJobs( args: ListUserImportJobsCommandInput, cb: (err: any, data?: ListUserImportJobsCommandOutput) => void ): void; - public listUserImportJobs( + listUserImportJobs( args: ListUserImportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUserImportJobsCommandOutput) => void ): void; - public listUserImportJobs( - args: ListUserImportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUserImportJobsCommandOutput) => void), - cb?: (err: any, data?: ListUserImportJobsCommandOutput) => void - ): Promise | void { - const command = new ListUserImportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the clients that have been created for the specified user pool.

+ * @see {@link ListUserPoolClientsCommand} */ - public listUserPoolClients( + listUserPoolClients( args: ListUserPoolClientsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listUserPoolClients( + listUserPoolClients( args: ListUserPoolClientsCommandInput, cb: (err: any, data?: ListUserPoolClientsCommandOutput) => void ): void; - public listUserPoolClients( + listUserPoolClients( args: ListUserPoolClientsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUserPoolClientsCommandOutput) => void ): void; - public listUserPoolClients( - args: ListUserPoolClientsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUserPoolClientsCommandOutput) => void), - cb?: (err: any, data?: ListUserPoolClientsCommandOutput) => void - ): Promise | void { - const command = new ListUserPoolClientsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the user pools associated with an Amazon Web Services account.

+ * @see {@link ListUserPoolsCommand} */ - public listUserPools( - args: ListUserPoolsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listUserPools( - args: ListUserPoolsCommandInput, - cb: (err: any, data?: ListUserPoolsCommandOutput) => void - ): void; - public listUserPools( + listUserPools(args: ListUserPoolsCommandInput, options?: __HttpHandlerOptions): Promise; + listUserPools(args: ListUserPoolsCommandInput, cb: (err: any, data?: ListUserPoolsCommandOutput) => void): void; + listUserPools( args: ListUserPoolsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUserPoolsCommandOutput) => void ): void; - public listUserPools( - args: ListUserPoolsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUserPoolsCommandOutput) => void), - cb?: (err: any, data?: ListUserPoolsCommandOutput) => void - ): Promise | void { - const command = new ListUserPoolsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the users in the Amazon Cognito user pool.

+ * @see {@link ListUsersCommand} */ - public listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise; - public listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void; - public listUsers( + listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise; + listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void; + listUsers( args: ListUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersCommandOutput) => void ): void; - public listUsers( - args: ListUsersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUsersCommandOutput) => void), - cb?: (err: any, data?: ListUsersCommandOutput) => void - ): Promise | void { - const command = new ListUsersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the users in the specified group.

- *

Calling this action requires developer credentials.

+ * @see {@link ListUsersInGroupCommand} */ - public listUsersInGroup( + listUsersInGroup( args: ListUsersInGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public listUsersInGroup( + listUsersInGroup( args: ListUsersInGroupCommandInput, cb: (err: any, data?: ListUsersInGroupCommandOutput) => void ): void; - public listUsersInGroup( + listUsersInGroup( args: ListUsersInGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersInGroupCommandOutput) => void ): void; - public listUsersInGroup( - args: ListUsersInGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUsersInGroupCommandOutput) => void), - cb?: (err: any, data?: ListUsersInGroupCommandOutput) => void - ): Promise | void { - const command = new ListUsersInGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Resends the confirmation (for confirmation of registration) to a specific user in the - * user pool.

- * - * - *

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers - * require you to register an origination phone number before you can send SMS messages - * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a - * phone number with Amazon Pinpoint. - * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must - * receive SMS messages might not be able to sign up, activate their accounts, or sign - * in.

- *

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, - * Amazon Simple Notification Service might place your account in the SMS sandbox. In - * sandbox - * mode - * , you can send messages only to verified phone - * numbers. After you test your app while in the sandbox environment, you can move out - * of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito - * Developer Guide.

- *
+ * @see {@link ResendConfirmationCodeCommand} */ - public resendConfirmationCode( + resendConfirmationCode( args: ResendConfirmationCodeCommandInput, options?: __HttpHandlerOptions ): Promise; - public resendConfirmationCode( + resendConfirmationCode( args: ResendConfirmationCodeCommandInput, cb: (err: any, data?: ResendConfirmationCodeCommandOutput) => void ): void; - public resendConfirmationCode( + resendConfirmationCode( args: ResendConfirmationCodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResendConfirmationCodeCommandOutput) => void ): void; - public resendConfirmationCode( - args: ResendConfirmationCodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResendConfirmationCodeCommandOutput) => void), - cb?: (err: any, data?: ResendConfirmationCodeCommandOutput) => void - ): Promise | void { - const command = new ResendConfirmationCodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Responds to the authentication challenge.

- * - * - *

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers - * require you to register an origination phone number before you can send SMS messages - * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a - * phone number with Amazon Pinpoint. - * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must - * receive SMS messages might not be able to sign up, activate their accounts, or sign - * in.

- *

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, - * Amazon Simple Notification Service might place your account in the SMS sandbox. In - * sandbox - * mode - * , you can send messages only to verified phone - * numbers. After you test your app while in the sandbox environment, you can move out - * of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito - * Developer Guide.

- *
+ * @see {@link RespondToAuthChallengeCommand} */ - public respondToAuthChallenge( + respondToAuthChallenge( args: RespondToAuthChallengeCommandInput, options?: __HttpHandlerOptions ): Promise; - public respondToAuthChallenge( + respondToAuthChallenge( args: RespondToAuthChallengeCommandInput, cb: (err: any, data?: RespondToAuthChallengeCommandOutput) => void ): void; - public respondToAuthChallenge( + respondToAuthChallenge( args: RespondToAuthChallengeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RespondToAuthChallengeCommandOutput) => void ): void; - public respondToAuthChallenge( - args: RespondToAuthChallengeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RespondToAuthChallengeCommandOutput) => void), - cb?: (err: any, data?: RespondToAuthChallengeCommandOutput) => void - ): Promise | void { - const command = new RespondToAuthChallengeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Revokes all of the access tokens generated by, and at the same time as, the specified - * refresh token. After a token is revoked, you can't use the revoked token to access - * Amazon Cognito user APIs, or to authorize access to your resource server.

+ * @see {@link RevokeTokenCommand} */ - public revokeToken(args: RevokeTokenCommandInput, options?: __HttpHandlerOptions): Promise; - public revokeToken(args: RevokeTokenCommandInput, cb: (err: any, data?: RevokeTokenCommandOutput) => void): void; - public revokeToken( + revokeToken(args: RevokeTokenCommandInput, options?: __HttpHandlerOptions): Promise; + revokeToken(args: RevokeTokenCommandInput, cb: (err: any, data?: RevokeTokenCommandOutput) => void): void; + revokeToken( args: RevokeTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeTokenCommandOutput) => void ): void; - public revokeToken( - args: RevokeTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RevokeTokenCommandOutput) => void), - cb?: (err: any, data?: RevokeTokenCommandOutput) => void - ): Promise | void { - const command = new RevokeTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Configures actions on detected risks. To delete the risk configuration for - * UserPoolId or ClientId, pass null values for all four - * configuration types.

- *

To activate Amazon Cognito advanced security features, update the user pool to include the - * UserPoolAddOns keyAdvancedSecurityMode.

+ * @see {@link SetRiskConfigurationCommand} */ - public setRiskConfiguration( + setRiskConfiguration( args: SetRiskConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public setRiskConfiguration( + setRiskConfiguration( args: SetRiskConfigurationCommandInput, cb: (err: any, data?: SetRiskConfigurationCommandOutput) => void ): void; - public setRiskConfiguration( + setRiskConfiguration( args: SetRiskConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetRiskConfigurationCommandOutput) => void ): void; - public setRiskConfiguration( - args: SetRiskConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetRiskConfigurationCommandOutput) => void), - cb?: (err: any, data?: SetRiskConfigurationCommandOutput) => void - ): Promise | void { - const command = new SetRiskConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the user interface (UI) customization information for a user pool's built-in app - * UI.

- *

You can specify app UI customization settings for a single client (with a specific - * clientId) or for all clients (by setting the clientId to - * ALL). If you specify ALL, the default configuration is - * used for every client that has no previously set UI customization. If you specify UI - * customization settings for a particular client, it will no longer return to the - * ALL configuration.

- * - *

To use this API, your user pool must have a domain associated with it. Otherwise, - * there is no place to host the app's pages, and the service will throw an - * error.

- *
+ * @see {@link SetUICustomizationCommand} */ - public setUICustomization( + setUICustomization( args: SetUICustomizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public setUICustomization( + setUICustomization( args: SetUICustomizationCommandInput, cb: (err: any, data?: SetUICustomizationCommandOutput) => void ): void; - public setUICustomization( + setUICustomization( args: SetUICustomizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetUICustomizationCommandOutput) => void ): void; - public setUICustomization( - args: SetUICustomizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetUICustomizationCommandOutput) => void), - cb?: (err: any, data?: SetUICustomizationCommandOutput) => void - ): Promise | void { - const command = new SetUICustomizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Set the user's multi-factor authentication (MFA) method preference, including which - * MFA factors are activated and if any are preferred. Only one factor can be set as - * preferred. The preferred MFA factor will be used to authenticate a user if multiple - * factors are activated. If multiple options are activated and no preference is set, a - * challenge to choose an MFA option will be returned during sign-in. If an MFA type is - * activated for a user, the user will be prompted for MFA during all sign-in attempts - * unless device tracking is turned on and the device has been trusted. If you want MFA to - * be applied selectively based on the assessed risk level of sign-in attempts, deactivate - * MFA for users and turn on Adaptive Authentication for the user pool.

+ * @see {@link SetUserMFAPreferenceCommand} */ - public setUserMFAPreference( + setUserMFAPreference( args: SetUserMFAPreferenceCommandInput, options?: __HttpHandlerOptions ): Promise; - public setUserMFAPreference( + setUserMFAPreference( args: SetUserMFAPreferenceCommandInput, cb: (err: any, data?: SetUserMFAPreferenceCommandOutput) => void ): void; - public setUserMFAPreference( + setUserMFAPreference( args: SetUserMFAPreferenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetUserMFAPreferenceCommandOutput) => void ): void; - public setUserMFAPreference( - args: SetUserMFAPreferenceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetUserMFAPreferenceCommandOutput) => void), - cb?: (err: any, data?: SetUserMFAPreferenceCommandOutput) => void - ): Promise | void { - const command = new SetUserMFAPreferenceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the user pool multi-factor authentication (MFA) configuration.

- * - * - *

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers - * require you to register an origination phone number before you can send SMS messages - * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a - * phone number with Amazon Pinpoint. - * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must - * receive SMS messages might not be able to sign up, activate their accounts, or sign - * in.

- *

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, - * Amazon Simple Notification Service might place your account in the SMS sandbox. In - * sandbox - * mode - * , you can send messages only to verified phone - * numbers. After you test your app while in the sandbox environment, you can move out - * of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito - * Developer Guide.

- *
+ * @see {@link SetUserPoolMfaConfigCommand} */ - public setUserPoolMfaConfig( + setUserPoolMfaConfig( args: SetUserPoolMfaConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public setUserPoolMfaConfig( + setUserPoolMfaConfig( args: SetUserPoolMfaConfigCommandInput, cb: (err: any, data?: SetUserPoolMfaConfigCommandOutput) => void ): void; - public setUserPoolMfaConfig( + setUserPoolMfaConfig( args: SetUserPoolMfaConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetUserPoolMfaConfigCommandOutput) => void ): void; - public setUserPoolMfaConfig( - args: SetUserPoolMfaConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetUserPoolMfaConfigCommandOutput) => void), - cb?: (err: any, data?: SetUserPoolMfaConfigCommandOutput) => void - ): Promise | void { - const command = new SetUserPoolMfaConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * This action is no longer supported. You can use it to configure - * only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software - * token MFA. To configure either type of MFA, use SetUserMFAPreference instead.

+ * @see {@link SetUserSettingsCommand} */ - public setUserSettings( + setUserSettings( args: SetUserSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public setUserSettings( - args: SetUserSettingsCommandInput, - cb: (err: any, data?: SetUserSettingsCommandOutput) => void - ): void; - public setUserSettings( + setUserSettings(args: SetUserSettingsCommandInput, cb: (err: any, data?: SetUserSettingsCommandOutput) => void): void; + setUserSettings( args: SetUserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetUserSettingsCommandOutput) => void ): void; - public setUserSettings( - args: SetUserSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetUserSettingsCommandOutput) => void), - cb?: (err: any, data?: SetUserSettingsCommandOutput) => void - ): Promise | void { - const command = new SetUserSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers the user in the specified user pool and creates a user name, password, and - * user attributes.

- * - * - *

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers - * require you to register an origination phone number before you can send SMS messages - * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a - * phone number with Amazon Pinpoint. - * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must - * receive SMS messages might not be able to sign up, activate their accounts, or sign - * in.

- *

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, - * Amazon Simple Notification Service might place your account in the SMS sandbox. In - * sandbox - * mode - * , you can send messages only to verified phone - * numbers. After you test your app while in the sandbox environment, you can move out - * of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito - * Developer Guide.

- *
+ * @see {@link SignUpCommand} */ - public signUp(args: SignUpCommandInput, options?: __HttpHandlerOptions): Promise; - public signUp(args: SignUpCommandInput, cb: (err: any, data?: SignUpCommandOutput) => void): void; - public signUp( + signUp(args: SignUpCommandInput, options?: __HttpHandlerOptions): Promise; + signUp(args: SignUpCommandInput, cb: (err: any, data?: SignUpCommandOutput) => void): void; + signUp( args: SignUpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SignUpCommandOutput) => void ): void; - public signUp( - args: SignUpCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SignUpCommandOutput) => void), - cb?: (err: any, data?: SignUpCommandOutput) => void - ): Promise | void { - const command = new SignUpCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts the user import.

+ * @see {@link StartUserImportJobCommand} */ - public startUserImportJob( + startUserImportJob( args: StartUserImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startUserImportJob( + startUserImportJob( args: StartUserImportJobCommandInput, cb: (err: any, data?: StartUserImportJobCommandOutput) => void ): void; - public startUserImportJob( + startUserImportJob( args: StartUserImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartUserImportJobCommandOutput) => void ): void; - public startUserImportJob( - args: StartUserImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartUserImportJobCommandOutput) => void), - cb?: (err: any, data?: StartUserImportJobCommandOutput) => void - ): Promise | void { - const command = new StartUserImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops the user import job.

+ * @see {@link StopUserImportJobCommand} */ - public stopUserImportJob( + stopUserImportJob( args: StopUserImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopUserImportJob( + stopUserImportJob( args: StopUserImportJobCommandInput, cb: (err: any, data?: StopUserImportJobCommandOutput) => void ): void; - public stopUserImportJob( + stopUserImportJob( args: StopUserImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopUserImportJobCommandOutput) => void ): void; - public stopUserImportJob( - args: StopUserImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopUserImportJobCommandOutput) => void), - cb?: (err: any, data?: StopUserImportJobCommandOutput) => void - ): Promise | void { - const command = new StopUserImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to - * categorize and manage user pools in different ways, such as by purpose, owner, - * environment, or other criteria.

- *

Each tag consists of a key and value, both of which you define. A key is a general - * category for more specific values. For example, if you have two versions of a user pool, - * one for testing and another for production, you might assign an Environment - * tag key to both user pools. The value of this key might be Test for one - * user pool, and Production for the other.

- *

Tags are useful for cost tracking and access control. You can activate your tags so - * that they appear on the Billing and Cost Management console, where you can track the - * costs associated with your user pools. In an Identity and Access Management policy, you can constrain - * permissions for user pools based on specific tags or tag values.

- *

You can use this action up to 5 times per second, per account. A user pool can have as - * many as 50 tags.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 - * times per second, per account.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides the feedback for an authentication event, whether it was from a valid user or - * not. This feedback is used for improving the risk evaluation decision for the user pool - * as part of Amazon Cognito advanced security.

+ * @see {@link UpdateAuthEventFeedbackCommand} */ - public updateAuthEventFeedback( + updateAuthEventFeedback( args: UpdateAuthEventFeedbackCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAuthEventFeedback( + updateAuthEventFeedback( args: UpdateAuthEventFeedbackCommandInput, cb: (err: any, data?: UpdateAuthEventFeedbackCommandOutput) => void ): void; - public updateAuthEventFeedback( + updateAuthEventFeedback( args: UpdateAuthEventFeedbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAuthEventFeedbackCommandOutput) => void ): void; - public updateAuthEventFeedback( - args: UpdateAuthEventFeedbackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAuthEventFeedbackCommandOutput) => void), - cb?: (err: any, data?: UpdateAuthEventFeedbackCommandOutput) => void - ): Promise | void { - const command = new UpdateAuthEventFeedbackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the device status.

+ * @see {@link UpdateDeviceStatusCommand} */ - public updateDeviceStatus( + updateDeviceStatus( args: UpdateDeviceStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDeviceStatus( + updateDeviceStatus( args: UpdateDeviceStatusCommandInput, cb: (err: any, data?: UpdateDeviceStatusCommandOutput) => void ): void; - public updateDeviceStatus( + updateDeviceStatus( args: UpdateDeviceStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDeviceStatusCommandOutput) => void ): void; - public updateDeviceStatus( - args: UpdateDeviceStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDeviceStatusCommandOutput) => void), - cb?: (err: any, data?: UpdateDeviceStatusCommandOutput) => void - ): Promise | void { - const command = new UpdateDeviceStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified group with the specified attributes.

- *

Calling this action requires developer credentials.

+ * @see {@link UpdateGroupCommand} */ - public updateGroup(args: UpdateGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void; - public updateGroup( + updateGroup(args: UpdateGroupCommandInput, options?: __HttpHandlerOptions): Promise; + updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void; + updateGroup( args: UpdateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGroupCommandOutput) => void ): void; - public updateGroup( - args: UpdateGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates IdP information for a user pool.

+ * @see {@link UpdateIdentityProviderCommand} */ - public updateIdentityProvider( + updateIdentityProvider( args: UpdateIdentityProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateIdentityProvider( + updateIdentityProvider( args: UpdateIdentityProviderCommandInput, cb: (err: any, data?: UpdateIdentityProviderCommandOutput) => void ): void; - public updateIdentityProvider( + updateIdentityProvider( args: UpdateIdentityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIdentityProviderCommandOutput) => void ): void; - public updateIdentityProvider( - args: UpdateIdentityProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateIdentityProviderCommandOutput) => void), - cb?: (err: any, data?: UpdateIdentityProviderCommandOutput) => void - ): Promise | void { - const command = new UpdateIdentityProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the name and scopes of resource server. All other fields are read-only.

- * - *

If you don't provide a value for an attribute, it is set to the default - * value.

- *
+ * @see {@link UpdateResourceServerCommand} */ - public updateResourceServer( + updateResourceServer( args: UpdateResourceServerCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateResourceServer( + updateResourceServer( args: UpdateResourceServerCommandInput, cb: (err: any, data?: UpdateResourceServerCommandOutput) => void ): void; - public updateResourceServer( + updateResourceServer( args: UpdateResourceServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResourceServerCommandOutput) => void ): void; - public updateResourceServer( - args: UpdateResourceServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResourceServerCommandOutput) => void), - cb?: (err: any, data?: UpdateResourceServerCommandOutput) => void - ): Promise | void { - const command = new UpdateResourceServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows a user to update a specific attribute (one at a time).

- * - * - *

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers - * require you to register an origination phone number before you can send SMS messages - * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a - * phone number with Amazon Pinpoint. - * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must - * receive SMS messages might not be able to sign up, activate their accounts, or sign - * in.

- *

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, - * Amazon Simple Notification Service might place your account in the SMS sandbox. In - * sandbox - * mode - * , you can send messages only to verified phone - * numbers. After you test your app while in the sandbox environment, you can move out - * of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito - * Developer Guide.

- *
+ * @see {@link UpdateUserAttributesCommand} */ - public updateUserAttributes( + updateUserAttributes( args: UpdateUserAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateUserAttributes( + updateUserAttributes( args: UpdateUserAttributesCommandInput, cb: (err: any, data?: UpdateUserAttributesCommandOutput) => void ): void; - public updateUserAttributes( + updateUserAttributes( args: UpdateUserAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserAttributesCommandOutput) => void ): void; - public updateUserAttributes( - args: UpdateUserAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserAttributesCommandOutput) => void), - cb?: (err: any, data?: UpdateUserAttributesCommandOutput) => void - ): Promise | void { - const command = new UpdateUserAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified user pool with the specified attributes. You can get a list of - * the current user pool settings using DescribeUserPool. If you don't provide a value for an attribute, it will be - * set to the default value. - *

- * - * - *

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers - * require you to register an origination phone number before you can send SMS messages - * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a - * phone number with Amazon Pinpoint. - * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must - * receive SMS messages might not be able to sign up, activate their accounts, or sign - * in.

- *

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, - * Amazon Simple Notification Service might place your account in the SMS sandbox. In - * sandbox - * mode - * , you can send messages only to verified phone - * numbers. After you test your app while in the sandbox environment, you can move out - * of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito - * Developer Guide.

- *
+ * @see {@link UpdateUserPoolCommand} */ - public updateUserPool( + updateUserPool( args: UpdateUserPoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateUserPool( - args: UpdateUserPoolCommandInput, - cb: (err: any, data?: UpdateUserPoolCommandOutput) => void - ): void; - public updateUserPool( + updateUserPool(args: UpdateUserPoolCommandInput, cb: (err: any, data?: UpdateUserPoolCommandOutput) => void): void; + updateUserPool( args: UpdateUserPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserPoolCommandOutput) => void ): void; - public updateUserPool( - args: UpdateUserPoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserPoolCommandOutput) => void), - cb?: (err: any, data?: UpdateUserPoolCommandOutput) => void - ): Promise | void { - const command = new UpdateUserPoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified user pool app client with the specified attributes. You can get - * a list of the current user pool app client settings using DescribeUserPoolClient.

- * - *

If you don't provide a value for an attribute, it will be set to the default - * value.

- *
- *

You can also use this operation to enable token revocation for user pool clients. For - * more information about revoking tokens, see RevokeToken.

+ * @see {@link UpdateUserPoolClientCommand} */ - public updateUserPoolClient( + updateUserPoolClient( args: UpdateUserPoolClientCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateUserPoolClient( + updateUserPoolClient( args: UpdateUserPoolClientCommandInput, cb: (err: any, data?: UpdateUserPoolClientCommandOutput) => void ): void; - public updateUserPoolClient( + updateUserPoolClient( args: UpdateUserPoolClientCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserPoolClientCommandOutput) => void ): void; - public updateUserPoolClient( - args: UpdateUserPoolClientCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserPoolClientCommandOutput) => void), - cb?: (err: any, data?: UpdateUserPoolClientCommandOutput) => void - ): Promise | void { - const command = new UpdateUserPoolClientCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user - * pool.

- *

You can use this operation to provide the Amazon Resource Name (ARN) of a new - * certificate to Amazon Cognito. You can't use it to change the domain for a user pool.

- *

A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and - * sign-in pages for your application. When you set up a custom domain, you provide a - * certificate that you manage with Certificate Manager (ACM). When necessary, you can use this - * operation to change the certificate that you applied to your custom domain.

- *

Usually, this is unnecessary following routine certificate renewal with ACM. When - * you renew your existing certificate in ACM, the ARN for your certificate remains the - * same, and your custom domain uses the new certificate automatically.

- *

However, if you replace your existing certificate with a new one, ACM gives the new - * certificate a new ARN. To apply the new certificate to your custom domain, you must - * provide this ARN to Amazon Cognito.

- *

When you add your new certificate in ACM, you must choose US East (N. Virginia) as - * the Amazon Web Services Region.

- *

After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new - * certificate to your custom domain.

- *

For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.

+ * @see {@link UpdateUserPoolDomainCommand} */ - public updateUserPoolDomain( + updateUserPoolDomain( args: UpdateUserPoolDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateUserPoolDomain( + updateUserPoolDomain( args: UpdateUserPoolDomainCommandInput, cb: (err: any, data?: UpdateUserPoolDomainCommandOutput) => void ): void; - public updateUserPoolDomain( + updateUserPoolDomain( args: UpdateUserPoolDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserPoolDomainCommandOutput) => void ): void; - public updateUserPoolDomain( - args: UpdateUserPoolDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserPoolDomainCommandOutput) => void), - cb?: (err: any, data?: UpdateUserPoolDomainCommandOutput) => void - ): Promise | void { - const command = new UpdateUserPoolDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this API to register a user's entered time-based one-time password (TOTP) code and - * mark the user's software token MFA status as "verified" if successful. The request takes - * an access token or a session string, but not both.

+ * @see {@link VerifySoftwareTokenCommand} */ - public verifySoftwareToken( + verifySoftwareToken( args: VerifySoftwareTokenCommandInput, options?: __HttpHandlerOptions ): Promise; - public verifySoftwareToken( + verifySoftwareToken( args: VerifySoftwareTokenCommandInput, cb: (err: any, data?: VerifySoftwareTokenCommandOutput) => void ): void; - public verifySoftwareToken( + verifySoftwareToken( args: VerifySoftwareTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifySoftwareTokenCommandOutput) => void ): void; - public verifySoftwareToken( - args: VerifySoftwareTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: VerifySoftwareTokenCommandOutput) => void), - cb?: (err: any, data?: VerifySoftwareTokenCommandOutput) => void - ): Promise | void { - const command = new VerifySoftwareTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Verifies the specified user attributes in the user pool.

- *

- * If your user pool requires verification before Amazon Cognito updates the attribute value, - * VerifyUserAttribute updates the affected attribute to its pending value. For more information, - * see - * UserAttributeUpdateSettingsType. - *

+ * @see {@link VerifyUserAttributeCommand} */ - public verifyUserAttribute( + verifyUserAttribute( args: VerifyUserAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public verifyUserAttribute( + verifyUserAttribute( args: VerifyUserAttributeCommandInput, cb: (err: any, data?: VerifyUserAttributeCommandOutput) => void ): void; - public verifyUserAttribute( + verifyUserAttribute( args: VerifyUserAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifyUserAttributeCommandOutput) => void ): void; - public verifyUserAttribute( - args: VerifyUserAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: VerifyUserAttributeCommandOutput) => void), - cb?: (err: any, data?: VerifyUserAttributeCommandOutput) => void - ): Promise | void { - const command = new VerifyUserAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Using the Amazon Cognito user pools API, you can create a user pool to manage directories and + * users. You can authenticate a user to obtain tokens related to user identity and access + * policies.

+ *

This API reference provides information about user pools in Amazon Cognito user pools.

+ *

For more information, see the Amazon Cognito + * Documentation.

+ */ +export class CognitoIdentityProvider extends CognitoIdentityProviderClient implements CognitoIdentityProvider {} +createAggregatedClient(commands, CognitoIdentityProvider); diff --git a/clients/client-cognito-identity/src/CognitoIdentity.ts b/clients/client-cognito-identity/src/CognitoIdentity.ts index 3c9312b691ed..c5dc44042f9f 100644 --- a/clients/client-cognito-identity/src/CognitoIdentity.ts +++ b/clients/client-cognito-identity/src/CognitoIdentity.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CognitoIdentityClient } from "./CognitoIdentityClient"; +import { CognitoIdentityClient, CognitoIdentityClientConfig } from "./CognitoIdentityClient"; import { CreateIdentityPoolCommand, CreateIdentityPoolCommandInput, @@ -110,882 +111,414 @@ import { UpdateIdentityPoolCommandOutput, } from "./commands/UpdateIdentityPoolCommand"; -/** - * @public - * Amazon Cognito Federated Identities - *

Amazon Cognito Federated Identities is a web service that delivers scoped temporary - * credentials to mobile devices and other untrusted environments. It uniquely identifies a - * device and supplies the user with a consistent identity over the lifetime of an - * application.

- *

Using Amazon Cognito Federated Identities, you can enable authentication with one or - * more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon - * Cognito user pool, and you can also choose to support unauthenticated access from your app. - * Cognito delivers a unique identifier for each user and acts as an OpenID token provider - * trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS - * credentials.

- *

For a description of the authentication flow from the Amazon Cognito Developer Guide - * see Authentication Flow.

- *

For more information see Amazon Cognito Federated Identities.

- */ -export class CognitoIdentity extends CognitoIdentityClient { +const commands = { + CreateIdentityPoolCommand, + DeleteIdentitiesCommand, + DeleteIdentityPoolCommand, + DescribeIdentityCommand, + DescribeIdentityPoolCommand, + GetCredentialsForIdentityCommand, + GetIdCommand, + GetIdentityPoolRolesCommand, + GetOpenIdTokenCommand, + GetOpenIdTokenForDeveloperIdentityCommand, + GetPrincipalTagAttributeMapCommand, + ListIdentitiesCommand, + ListIdentityPoolsCommand, + ListTagsForResourceCommand, + LookupDeveloperIdentityCommand, + MergeDeveloperIdentitiesCommand, + SetIdentityPoolRolesCommand, + SetPrincipalTagAttributeMapCommand, + TagResourceCommand, + UnlinkDeveloperIdentityCommand, + UnlinkIdentityCommand, + UntagResourceCommand, + UpdateIdentityPoolCommand, +}; + +export interface CognitoIdentity { /** - * @public - *

Creates a new identity pool. The identity pool is a store of user identity - * information that is specific to your AWS account. The keys for SupportedLoginProviders are as follows:

- * - *
    - *
  • - *

    Facebook: graph.facebook.com - *

    - *
  • - *
  • - *

    Google: accounts.google.com - *

    - *
  • - *
  • - *

    Amazon: www.amazon.com - *

    - *
  • - *
  • - *

    Twitter: api.twitter.com - *

    - *
  • - *
  • - *

    Digits: www.digits.com - *

    - *
  • - *
- * - *

You must use AWS Developer credentials to call this API.

+ * @see {@link CreateIdentityPoolCommand} */ - public createIdentityPool( + createIdentityPool( args: CreateIdentityPoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public createIdentityPool( + createIdentityPool( args: CreateIdentityPoolCommandInput, cb: (err: any, data?: CreateIdentityPoolCommandOutput) => void ): void; - public createIdentityPool( + createIdentityPool( args: CreateIdentityPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIdentityPoolCommandOutput) => void ): void; - public createIdentityPool( - args: CreateIdentityPoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIdentityPoolCommandOutput) => void), - cb?: (err: any, data?: CreateIdentityPoolCommandOutput) => void - ): Promise | void { - const command = new CreateIdentityPoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes identities from an identity pool. You can specify a list of 1-60 identities - * that you want to delete.

- *

You must use AWS Developer credentials to call this API.

+ * @see {@link DeleteIdentitiesCommand} */ - public deleteIdentities( + deleteIdentities( args: DeleteIdentitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteIdentities( + deleteIdentities( args: DeleteIdentitiesCommandInput, cb: (err: any, data?: DeleteIdentitiesCommandOutput) => void ): void; - public deleteIdentities( + deleteIdentities( args: DeleteIdentitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIdentitiesCommandOutput) => void ): void; - public deleteIdentities( - args: DeleteIdentitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIdentitiesCommandOutput) => void), - cb?: (err: any, data?: DeleteIdentitiesCommandOutput) => void - ): Promise | void { - const command = new DeleteIdentitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an identity pool. Once a pool is deleted, users will not be able to - * authenticate with the pool.

- *

You must use AWS Developer credentials to call this API.

+ * @see {@link DeleteIdentityPoolCommand} */ - public deleteIdentityPool( + deleteIdentityPool( args: DeleteIdentityPoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteIdentityPool( + deleteIdentityPool( args: DeleteIdentityPoolCommandInput, cb: (err: any, data?: DeleteIdentityPoolCommandOutput) => void ): void; - public deleteIdentityPool( + deleteIdentityPool( args: DeleteIdentityPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIdentityPoolCommandOutput) => void ): void; - public deleteIdentityPool( - args: DeleteIdentityPoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIdentityPoolCommandOutput) => void), - cb?: (err: any, data?: DeleteIdentityPoolCommandOutput) => void - ): Promise | void { - const command = new DeleteIdentityPoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns metadata related to the given identity, including when the identity was - * created and any associated linked logins.

- *

You must use AWS Developer credentials to call this API.

+ * @see {@link DescribeIdentityCommand} */ - public describeIdentity( + describeIdentity( args: DescribeIdentityCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeIdentity( + describeIdentity( args: DescribeIdentityCommandInput, cb: (err: any, data?: DescribeIdentityCommandOutput) => void ): void; - public describeIdentity( + describeIdentity( args: DescribeIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIdentityCommandOutput) => void ): void; - public describeIdentity( - args: DescribeIdentityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeIdentityCommandOutput) => void), - cb?: (err: any, data?: DescribeIdentityCommandOutput) => void - ): Promise | void { - const command = new DescribeIdentityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets details about a particular identity pool, including the pool name, ID - * description, creation date, and current number of users.

- *

You must use AWS Developer credentials to call this API.

+ * @see {@link DescribeIdentityPoolCommand} */ - public describeIdentityPool( + describeIdentityPool( args: DescribeIdentityPoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeIdentityPool( + describeIdentityPool( args: DescribeIdentityPoolCommandInput, cb: (err: any, data?: DescribeIdentityPoolCommandOutput) => void ): void; - public describeIdentityPool( + describeIdentityPool( args: DescribeIdentityPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIdentityPoolCommandOutput) => void ): void; - public describeIdentityPool( - args: DescribeIdentityPoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeIdentityPoolCommandOutput) => void), - cb?: (err: any, data?: DescribeIdentityPoolCommandOutput) => void - ): Promise | void { - const command = new DescribeIdentityPoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns credentials for the provided identity ID. Any provided logins will be - * validated against supported login providers. If the token is for - * cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service - * with the appropriate role for the token.

- *

This is a public API. You do not need any credentials to call this API.

+ * @see {@link GetCredentialsForIdentityCommand} */ - public getCredentialsForIdentity( + getCredentialsForIdentity( args: GetCredentialsForIdentityCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCredentialsForIdentity( + getCredentialsForIdentity( args: GetCredentialsForIdentityCommandInput, cb: (err: any, data?: GetCredentialsForIdentityCommandOutput) => void ): void; - public getCredentialsForIdentity( + getCredentialsForIdentity( args: GetCredentialsForIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCredentialsForIdentityCommandOutput) => void ): void; - public getCredentialsForIdentity( - args: GetCredentialsForIdentityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCredentialsForIdentityCommandOutput) => void), - cb?: (err: any, data?: GetCredentialsForIdentityCommandOutput) => void - ): Promise | void { - const command = new GetCredentialsForIdentityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an - * implicit linked account.

- *

This is a public API. You do not need any credentials to call this API.

+ * @see {@link GetIdCommand} */ - public getId(args: GetIdCommandInput, options?: __HttpHandlerOptions): Promise; - public getId(args: GetIdCommandInput, cb: (err: any, data?: GetIdCommandOutput) => void): void; - public getId( + getId(args: GetIdCommandInput, options?: __HttpHandlerOptions): Promise; + getId(args: GetIdCommandInput, cb: (err: any, data?: GetIdCommandOutput) => void): void; + getId( args: GetIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIdCommandOutput) => void ): void; - public getId( - args: GetIdCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIdCommandOutput) => void), - cb?: (err: any, data?: GetIdCommandOutput) => void - ): Promise | void { - const command = new GetIdCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the roles for an identity pool.

- *

You must use AWS Developer credentials to call this API.

+ * @see {@link GetIdentityPoolRolesCommand} */ - public getIdentityPoolRoles( + getIdentityPoolRoles( args: GetIdentityPoolRolesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIdentityPoolRoles( + getIdentityPoolRoles( args: GetIdentityPoolRolesCommandInput, cb: (err: any, data?: GetIdentityPoolRolesCommandOutput) => void ): void; - public getIdentityPoolRoles( + getIdentityPoolRoles( args: GetIdentityPoolRolesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIdentityPoolRolesCommandOutput) => void ): void; - public getIdentityPoolRoles( - args: GetIdentityPoolRolesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIdentityPoolRolesCommandOutput) => void), - cb?: (err: any, data?: GetIdentityPoolRolesCommandOutput) => void - ): Promise | void { - const command = new GetIdentityPoolRolesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by - * GetId. You can optionally add additional logins for the identity. - * Supplying multiple logins creates an implicit link.

- *

The OpenID token is valid for 10 minutes.

- *

This is a public API. You do not need any credentials to call this API.

+ * @see {@link GetOpenIdTokenCommand} */ - public getOpenIdToken( + getOpenIdToken( args: GetOpenIdTokenCommandInput, options?: __HttpHandlerOptions ): Promise; - public getOpenIdToken( - args: GetOpenIdTokenCommandInput, - cb: (err: any, data?: GetOpenIdTokenCommandOutput) => void - ): void; - public getOpenIdToken( + getOpenIdToken(args: GetOpenIdTokenCommandInput, cb: (err: any, data?: GetOpenIdTokenCommandOutput) => void): void; + getOpenIdToken( args: GetOpenIdTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOpenIdTokenCommandOutput) => void ): void; - public getOpenIdToken( - args: GetOpenIdTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOpenIdTokenCommandOutput) => void), - cb?: (err: any, data?: GetOpenIdTokenCommandOutput) => void - ): Promise | void { - const command = new GetOpenIdTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers (or retrieves) a Cognito IdentityId and an OpenID Connect - * token for a user authenticated by your backend authentication process. Supplying multiple - * logins will create an implicit linked account. You can only specify one developer provider - * as part of the Logins map, which is linked to the identity pool. The developer - * provider is the "domain" by which Cognito will refer to your users.

- *

You can use GetOpenIdTokenForDeveloperIdentity to create a new identity - * and to link new logins (that is, user credentials issued by a public provider or developer - * provider) to an existing identity. When you want to create a new identity, the - * IdentityId should be null. When you want to associate a new login with an - * existing authenticated/unauthenticated identity, you can do so by providing the existing - * IdentityId. This API will create the identity in the specified - * IdentityPoolId.

- *

You must use AWS Developer credentials to call this API.

+ * @see {@link GetOpenIdTokenForDeveloperIdentityCommand} */ - public getOpenIdTokenForDeveloperIdentity( + getOpenIdTokenForDeveloperIdentity( args: GetOpenIdTokenForDeveloperIdentityCommandInput, options?: __HttpHandlerOptions ): Promise; - public getOpenIdTokenForDeveloperIdentity( + getOpenIdTokenForDeveloperIdentity( args: GetOpenIdTokenForDeveloperIdentityCommandInput, cb: (err: any, data?: GetOpenIdTokenForDeveloperIdentityCommandOutput) => void ): void; - public getOpenIdTokenForDeveloperIdentity( + getOpenIdTokenForDeveloperIdentity( args: GetOpenIdTokenForDeveloperIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOpenIdTokenForDeveloperIdentityCommandOutput) => void ): void; - public getOpenIdTokenForDeveloperIdentity( - args: GetOpenIdTokenForDeveloperIdentityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOpenIdTokenForDeveloperIdentityCommandOutput) => void), - cb?: (err: any, data?: GetOpenIdTokenForDeveloperIdentityCommandOutput) => void - ): Promise | void { - const command = new GetOpenIdTokenForDeveloperIdentityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user attributes.

+ * @see {@link GetPrincipalTagAttributeMapCommand} */ - public getPrincipalTagAttributeMap( + getPrincipalTagAttributeMap( args: GetPrincipalTagAttributeMapCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPrincipalTagAttributeMap( + getPrincipalTagAttributeMap( args: GetPrincipalTagAttributeMapCommandInput, cb: (err: any, data?: GetPrincipalTagAttributeMapCommandOutput) => void ): void; - public getPrincipalTagAttributeMap( + getPrincipalTagAttributeMap( args: GetPrincipalTagAttributeMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPrincipalTagAttributeMapCommandOutput) => void ): void; - public getPrincipalTagAttributeMap( - args: GetPrincipalTagAttributeMapCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPrincipalTagAttributeMapCommandOutput) => void), - cb?: (err: any, data?: GetPrincipalTagAttributeMapCommandOutput) => void - ): Promise | void { - const command = new GetPrincipalTagAttributeMapCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the identities in an identity pool.

- *

You must use AWS Developer credentials to call this API.

+ * @see {@link ListIdentitiesCommand} */ - public listIdentities( + listIdentities( args: ListIdentitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listIdentities( - args: ListIdentitiesCommandInput, - cb: (err: any, data?: ListIdentitiesCommandOutput) => void - ): void; - public listIdentities( + listIdentities(args: ListIdentitiesCommandInput, cb: (err: any, data?: ListIdentitiesCommandOutput) => void): void; + listIdentities( args: ListIdentitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIdentitiesCommandOutput) => void ): void; - public listIdentities( - args: ListIdentitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIdentitiesCommandOutput) => void), - cb?: (err: any, data?: ListIdentitiesCommandOutput) => void - ): Promise | void { - const command = new ListIdentitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all of the Cognito identity pools registered for your account.

- *

You must use AWS Developer credentials to call this API.

+ * @see {@link ListIdentityPoolsCommand} */ - public listIdentityPools( + listIdentityPools( args: ListIdentityPoolsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listIdentityPools( + listIdentityPools( args: ListIdentityPoolsCommandInput, cb: (err: any, data?: ListIdentityPoolsCommandOutput) => void ): void; - public listIdentityPools( + listIdentityPools( args: ListIdentityPoolsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIdentityPoolsCommandOutput) => void ): void; - public listIdentityPools( - args: ListIdentityPoolsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIdentityPoolsCommandOutput) => void), - cb?: (err: any, data?: ListIdentityPoolsCommandOutput) => void - ): Promise | void { - const command = new ListIdentityPoolsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags that are assigned to an Amazon Cognito identity pool.

- *

A tag is a label that you can apply to identity pools to categorize and manage them in - * different ways, such as by purpose, owner, environment, or other criteria.

- *

You can use this action up to 10 times per second, per account.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the IdentityID associated with a - * DeveloperUserIdentifier or the list of DeveloperUserIdentifier - * values associated with an IdentityId for an existing identity. Either - * IdentityID or DeveloperUserIdentifier must not be null. If you - * supply only one of these values, the other value will be searched in the database and - * returned as a part of the response. If you supply both, - * DeveloperUserIdentifier will be matched against IdentityID. If - * the values are verified against the database, the response returns both values and is the - * same as the request. Otherwise a ResourceConflictException is - * thrown.

- *

- * LookupDeveloperIdentity is intended for low-throughput control plane - * operations: for example, to enable customer service to locate an identity ID by username. - * If you are using it for higher-volume operations such as user authentication, your requests - * are likely to be throttled. GetOpenIdTokenForDeveloperIdentity is a - * better option for higher-volume operations for user authentication.

- *

You must use AWS Developer credentials to call this API.

+ * @see {@link LookupDeveloperIdentityCommand} */ - public lookupDeveloperIdentity( + lookupDeveloperIdentity( args: LookupDeveloperIdentityCommandInput, options?: __HttpHandlerOptions ): Promise; - public lookupDeveloperIdentity( + lookupDeveloperIdentity( args: LookupDeveloperIdentityCommandInput, cb: (err: any, data?: LookupDeveloperIdentityCommandOutput) => void ): void; - public lookupDeveloperIdentity( + lookupDeveloperIdentity( args: LookupDeveloperIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: LookupDeveloperIdentityCommandOutput) => void ): void; - public lookupDeveloperIdentity( - args: LookupDeveloperIdentityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: LookupDeveloperIdentityCommandOutput) => void), - cb?: (err: any, data?: LookupDeveloperIdentityCommandOutput) => void - ): Promise | void { - const command = new LookupDeveloperIdentityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Merges two users having different IdentityIds, existing in the same - * identity pool, and identified by the same developer provider. You can use this action to - * request that discrete users be merged and identified as a single user in the Cognito - * environment. Cognito associates the given source user (SourceUserIdentifier) - * with the IdentityId of the DestinationUserIdentifier. Only - * developer-authenticated users can be merged. If the users to be merged are associated with - * the same public provider, but as two different users, an exception will be - * thrown.

- *

The number of linked logins is limited to 20. So, the number of linked logins for the - * source user, SourceUserIdentifier, and the destination user, - * DestinationUserIdentifier, together should not be larger than 20. - * Otherwise, an exception will be thrown.

- *

You must use AWS Developer credentials to call this API.

+ * @see {@link MergeDeveloperIdentitiesCommand} */ - public mergeDeveloperIdentities( + mergeDeveloperIdentities( args: MergeDeveloperIdentitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public mergeDeveloperIdentities( + mergeDeveloperIdentities( args: MergeDeveloperIdentitiesCommandInput, cb: (err: any, data?: MergeDeveloperIdentitiesCommandOutput) => void ): void; - public mergeDeveloperIdentities( + mergeDeveloperIdentities( args: MergeDeveloperIdentitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MergeDeveloperIdentitiesCommandOutput) => void ): void; - public mergeDeveloperIdentities( - args: MergeDeveloperIdentitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MergeDeveloperIdentitiesCommandOutput) => void), - cb?: (err: any, data?: MergeDeveloperIdentitiesCommandOutput) => void - ): Promise | void { - const command = new MergeDeveloperIdentitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.

- *

You must use AWS Developer credentials to call this API.

+ * @see {@link SetIdentityPoolRolesCommand} */ - public setIdentityPoolRoles( + setIdentityPoolRoles( args: SetIdentityPoolRolesCommandInput, options?: __HttpHandlerOptions ): Promise; - public setIdentityPoolRoles( + setIdentityPoolRoles( args: SetIdentityPoolRolesCommandInput, cb: (err: any, data?: SetIdentityPoolRolesCommandOutput) => void ): void; - public setIdentityPoolRoles( + setIdentityPoolRoles( args: SetIdentityPoolRolesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetIdentityPoolRolesCommandOutput) => void ): void; - public setIdentityPoolRoles( - args: SetIdentityPoolRolesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetIdentityPoolRolesCommandOutput) => void), - cb?: (err: any, data?: SetIdentityPoolRolesCommandOutput) => void - ): Promise | void { - const command = new SetIdentityPoolRolesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

You can use this operation to use default (username and clientID) attribute or custom attribute mappings.

+ * @see {@link SetPrincipalTagAttributeMapCommand} */ - public setPrincipalTagAttributeMap( + setPrincipalTagAttributeMap( args: SetPrincipalTagAttributeMapCommandInput, options?: __HttpHandlerOptions ): Promise; - public setPrincipalTagAttributeMap( + setPrincipalTagAttributeMap( args: SetPrincipalTagAttributeMapCommandInput, cb: (err: any, data?: SetPrincipalTagAttributeMapCommandOutput) => void ): void; - public setPrincipalTagAttributeMap( + setPrincipalTagAttributeMap( args: SetPrincipalTagAttributeMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetPrincipalTagAttributeMapCommandOutput) => void ): void; - public setPrincipalTagAttributeMap( - args: SetPrincipalTagAttributeMapCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetPrincipalTagAttributeMapCommandOutput) => void), - cb?: (err: any, data?: SetPrincipalTagAttributeMapCommandOutput) => void - ): Promise | void { - const command = new SetPrincipalTagAttributeMapCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns a set of tags to the specified Amazon Cognito identity pool. A tag is a label - * that you can use to categorize and manage identity pools in different ways, such as by - * purpose, owner, environment, or other criteria.

- *

Each tag consists of a key and value, both of which you define. A key is a general - * category for more specific values. For example, if you have two versions of an identity - * pool, one for testing and another for production, you might assign an - * Environment tag key to both identity pools. The value of this key might be - * Test for one identity pool and Production for the - * other.

- *

Tags are useful for cost tracking and access control. You can activate your tags so that - * they appear on the Billing and Cost Management console, where you can track the costs - * associated with your identity pools. In an IAM policy, you can constrain permissions for - * identity pools based on specific tags or tag values.

- *

You can use this action up to 5 times per second, per account. An identity pool can have - * as many as 50 tags.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked - * developer users will be considered new identities next time they are seen. If, for a given - * Cognito identity, you remove all federated identities as well as the developer user - * identifier, the Cognito identity becomes inaccessible.

- *

You must use AWS Developer credentials to call this API.

+ * @see {@link UnlinkDeveloperIdentityCommand} */ - public unlinkDeveloperIdentity( + unlinkDeveloperIdentity( args: UnlinkDeveloperIdentityCommandInput, options?: __HttpHandlerOptions ): Promise; - public unlinkDeveloperIdentity( + unlinkDeveloperIdentity( args: UnlinkDeveloperIdentityCommandInput, cb: (err: any, data?: UnlinkDeveloperIdentityCommandOutput) => void ): void; - public unlinkDeveloperIdentity( + unlinkDeveloperIdentity( args: UnlinkDeveloperIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnlinkDeveloperIdentityCommandOutput) => void ): void; - public unlinkDeveloperIdentity( - args: UnlinkDeveloperIdentityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnlinkDeveloperIdentityCommandOutput) => void), - cb?: (err: any, data?: UnlinkDeveloperIdentityCommandOutput) => void - ): Promise | void { - const command = new UnlinkDeveloperIdentityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Unlinks a federated identity from an existing account. Unlinked logins will be - * considered new identities next time they are seen. Removing the last linked login will make - * this identity inaccessible.

- *

This is a public API. You do not need any credentials to call this API.

+ * @see {@link UnlinkIdentityCommand} */ - public unlinkIdentity( + unlinkIdentity( args: UnlinkIdentityCommandInput, options?: __HttpHandlerOptions ): Promise; - public unlinkIdentity( - args: UnlinkIdentityCommandInput, - cb: (err: any, data?: UnlinkIdentityCommandOutput) => void - ): void; - public unlinkIdentity( + unlinkIdentity(args: UnlinkIdentityCommandInput, cb: (err: any, data?: UnlinkIdentityCommandOutput) => void): void; + unlinkIdentity( args: UnlinkIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnlinkIdentityCommandOutput) => void ): void; - public unlinkIdentity( - args: UnlinkIdentityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnlinkIdentityCommandOutput) => void), - cb?: (err: any, data?: UnlinkIdentityCommandOutput) => void - ): Promise | void { - const command = new UnlinkIdentityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified tags from the specified Amazon Cognito identity pool. You can use - * this action up to 5 times per second, per account

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an identity pool.

- *

You must use AWS Developer credentials to call this API.

+ * @see {@link UpdateIdentityPoolCommand} */ - public updateIdentityPool( + updateIdentityPool( args: UpdateIdentityPoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateIdentityPool( + updateIdentityPool( args: UpdateIdentityPoolCommandInput, cb: (err: any, data?: UpdateIdentityPoolCommandOutput) => void ): void; - public updateIdentityPool( + updateIdentityPool( args: UpdateIdentityPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIdentityPoolCommandOutput) => void ): void; - public updateIdentityPool( - args: UpdateIdentityPoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateIdentityPoolCommandOutput) => void), - cb?: (err: any, data?: UpdateIdentityPoolCommandOutput) => void - ): Promise | void { - const command = new UpdateIdentityPoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Cognito Federated Identities + *

Amazon Cognito Federated Identities is a web service that delivers scoped temporary + * credentials to mobile devices and other untrusted environments. It uniquely identifies a + * device and supplies the user with a consistent identity over the lifetime of an + * application.

+ *

Using Amazon Cognito Federated Identities, you can enable authentication with one or + * more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon + * Cognito user pool, and you can also choose to support unauthenticated access from your app. + * Cognito delivers a unique identifier for each user and acts as an OpenID token provider + * trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS + * credentials.

+ *

For a description of the authentication flow from the Amazon Cognito Developer Guide + * see Authentication Flow.

+ *

For more information see Amazon Cognito Federated Identities.

+ */ +export class CognitoIdentity extends CognitoIdentityClient implements CognitoIdentity {} +createAggregatedClient(commands, CognitoIdentity); diff --git a/clients/client-cognito-sync/src/CognitoSync.ts b/clients/client-cognito-sync/src/CognitoSync.ts index 685950d926f7..3da4ec2107ff 100644 --- a/clients/client-cognito-sync/src/CognitoSync.ts +++ b/clients/client-cognito-sync/src/CognitoSync.ts @@ -1,7 +1,8 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -import { CognitoSyncClient } from "./CognitoSyncClient"; +import { CognitoSyncClient, CognitoSyncClientConfig } from "./CognitoSyncClient"; import { BulkPublishCommand, BulkPublishCommandInput, BulkPublishCommandOutput } from "./commands/BulkPublishCommand"; import { DeleteDatasetCommand, @@ -80,1070 +81,296 @@ import { UpdateRecordsCommandOutput, } from "./commands/UpdateRecordsCommand"; -/** - * @public - * Amazon Cognito Sync - *

Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of - * application-related user data. High-level client libraries are available for both iOS and - * Android. You can use these libraries to persist data locally so that it's available even if - * the device is offline. Developer credentials don't need to be stored on the mobile device - * to access the service. You can use Amazon Cognito to obtain a normalized user ID and - * credentials. User data is persisted in a dataset that can store up to 1 MB of key-value - * pairs, and you can have up to 20 datasets per user identity.

- *

With Amazon Cognito Sync, the data stored for each identity is accessible only to - * credentials assigned to that identity. In order to use the Cognito Sync service, you need - * to make API calls using credentials retrieved with Amazon Cognito Identity service.

- *

If you want to use Cognito Sync in an Android or iOS application, you will probably want to - * make API calls via the AWS Mobile SDK. To learn more, see the Developer Guide for Android and the Developer Guide for iOS.

- */ -export class CognitoSync extends CognitoSyncClient { +const commands = { + BulkPublishCommand, + DeleteDatasetCommand, + DescribeDatasetCommand, + DescribeIdentityPoolUsageCommand, + DescribeIdentityUsageCommand, + GetBulkPublishDetailsCommand, + GetCognitoEventsCommand, + GetIdentityPoolConfigurationCommand, + ListDatasetsCommand, + ListIdentityPoolUsageCommand, + ListRecordsCommand, + RegisterDeviceCommand, + SetCognitoEventsCommand, + SetIdentityPoolConfigurationCommand, + SubscribeToDatasetCommand, + UnsubscribeFromDatasetCommand, + UpdateRecordsCommand, +}; + +export interface CognitoSync { /** - * @public - *

Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

+ * @see {@link BulkPublishCommand} */ - public bulkPublish(args: BulkPublishCommandInput, options?: __HttpHandlerOptions): Promise; - public bulkPublish(args: BulkPublishCommandInput, cb: (err: any, data?: BulkPublishCommandOutput) => void): void; - public bulkPublish( + bulkPublish(args: BulkPublishCommandInput, options?: __HttpHandlerOptions): Promise; + bulkPublish(args: BulkPublishCommandInput, cb: (err: any, data?: BulkPublishCommandOutput) => void): void; + bulkPublish( args: BulkPublishCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BulkPublishCommandOutput) => void ): void; - public bulkPublish( - args: BulkPublishCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BulkPublishCommandOutput) => void), - cb?: (err: any, data?: BulkPublishCommandOutput) => void - ): Promise | void { - const command = new BulkPublishCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specific dataset. The dataset will be deleted permanently, and the action can't - * be undone. Datasets that this dataset was merged with will no longer report the merge. Any - * subsequent operation on this dataset will result in a - * ResourceNotFoundException.

- *

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

+ * @see {@link DeleteDatasetCommand} */ - public deleteDataset( - args: DeleteDatasetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDataset( - args: DeleteDatasetCommandInput, - cb: (err: any, data?: DeleteDatasetCommandOutput) => void - ): void; - public deleteDataset( + deleteDataset(args: DeleteDatasetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDataset(args: DeleteDatasetCommandInput, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void; + deleteDataset( args: DeleteDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetCommandOutput) => void ): void; - public deleteDataset( - args: DeleteDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDatasetCommandOutput) => void), - cb?: (err: any, data?: DeleteDatasetCommandOutput) => void - ): Promise | void { - const command = new DeleteDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each - * identity has access only to its own data. Thus, the credentials used to make this API call - * need to have access to the identity data.

- *

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

+ * @see {@link DescribeDatasetCommand} */ - public describeDataset( + describeDataset( args: DescribeDatasetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDataset( - args: DescribeDatasetCommandInput, - cb: (err: any, data?: DescribeDatasetCommandOutput) => void - ): void; - public describeDataset( + describeDataset(args: DescribeDatasetCommandInput, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void; + describeDataset( args: DescribeDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetCommandOutput) => void ): void; - public describeDataset( - args: DescribeDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDatasetCommandOutput) => void), - cb?: (err: any, data?: DescribeDatasetCommandOutput) => void - ): Promise | void { - const command = new DescribeDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets usage details (for example, data storage) about a particular identity pool.

- *

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

- * - * - * - * DescribeIdentityPoolUsage - * The following examples have been edited for readability. - * - * POST / HTTP/1.1 - * CONTENT-TYPE: application/json - * X-AMZN-REQUESTID: 8dc0e749-c8cd-48bd-8520-da6be00d528b - * X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.DescribeIdentityPoolUsage - * HOST: cognito-sync.us-east-1.amazonaws.com:443 - * X-AMZ-DATE: 20141111T205737Z - * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=, SignedHeaders=content-type;host;x-amz-date;x-amz-target;x-amzn-requestid, Signature= - * - * \{ - * "Operation": "com.amazonaws.cognito.sync.model#DescribeIdentityPoolUsage", - * "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService", - * "Input": - * \{ - * "IdentityPoolId": "IDENTITY_POOL_ID" - * \} - * \} - * - * - * 1.1 200 OK - * x-amzn-requestid: 8dc0e749-c8cd-48bd-8520-da6be00d528b - * content-type: application/json - * content-length: 271 - * date: Tue, 11 Nov 2014 20:57:37 GMT - * - * \{ - * "Output": - * \{ - * "__type": "com.amazonaws.cognito.sync.model#DescribeIdentityPoolUsageResponse", - * "IdentityPoolUsage": - * \{ - * "DataStorage": 0, - * "IdentityPoolId": "IDENTITY_POOL_ID", - * "LastModifiedDate": 1.413231134115E9, - * "SyncSessionsCount": null - * \} - * \}, - * "Version": "1.0" - * \} - * - * - * + * @see {@link DescribeIdentityPoolUsageCommand} */ - public describeIdentityPoolUsage( + describeIdentityPoolUsage( args: DescribeIdentityPoolUsageCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeIdentityPoolUsage( + describeIdentityPoolUsage( args: DescribeIdentityPoolUsageCommandInput, cb: (err: any, data?: DescribeIdentityPoolUsageCommandOutput) => void ): void; - public describeIdentityPoolUsage( + describeIdentityPoolUsage( args: DescribeIdentityPoolUsageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIdentityPoolUsageCommandOutput) => void ): void; - public describeIdentityPoolUsage( - args: DescribeIdentityPoolUsageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeIdentityPoolUsageCommandOutput) => void), - cb?: (err: any, data?: DescribeIdentityPoolUsageCommandOutput) => void - ): Promise | void { - const command = new DescribeIdentityPoolUsageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets usage information for an identity, including number of datasets and data usage.

- *

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

- * - * - * DescribeIdentityUsage - * The following examples have been edited for readability. - * - * POST / HTTP/1.1 - * CONTENT-TYPE: application/json - * X-AMZN-REQUESTID: 33f9b4e4-a177-4aad-a3bb-6edb7980b283 - * X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.DescribeIdentityUsage - * HOST: cognito-sync.us-east-1.amazonaws.com:443 - * X-AMZ-DATE: 20141111T215129Z - * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=, SignedHeaders=content-type;host;x-amz-date;x-amz-target;x-amzn-requestid, Signature= - * - * \{ - * "Operation": "com.amazonaws.cognito.sync.model#DescribeIdentityUsage", - * "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService", - * "Input": - * \{ - * "IdentityPoolId": "IDENTITY_POOL_ID", - * "IdentityId": "IDENTITY_ID" - * \} - * \} - * - * - * 1.1 200 OK - * x-amzn-requestid: 33f9b4e4-a177-4aad-a3bb-6edb7980b283 - * content-type: application/json - * content-length: 318 - * date: Tue, 11 Nov 2014 21:51:29 GMT - * - * \{ - * "Output": - * \{ - * "__type": "com.amazonaws.cognito.sync.model#DescribeIdentityUsageResponse", - * "IdentityUsage": - * \{ - * "DataStorage": 16, - * "DatasetCount": 1, - * "IdentityId": "IDENTITY_ID", - * "IdentityPoolId": "IDENTITY_POOL_ID", - * "LastModifiedDate": 1.412974081336E9 - * \} - * \}, - * "Version": "1.0" - * \} - * - * - * + * @see {@link DescribeIdentityUsageCommand} */ - public describeIdentityUsage( + describeIdentityUsage( args: DescribeIdentityUsageCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeIdentityUsage( + describeIdentityUsage( args: DescribeIdentityUsageCommandInput, cb: (err: any, data?: DescribeIdentityUsageCommandOutput) => void ): void; - public describeIdentityUsage( + describeIdentityUsage( args: DescribeIdentityUsageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIdentityUsageCommandOutput) => void ): void; - public describeIdentityUsage( - args: DescribeIdentityUsageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeIdentityUsageCommandOutput) => void), - cb?: (err: any, data?: DescribeIdentityUsageCommandOutput) => void - ): Promise | void { - const command = new DescribeIdentityUsageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the status of the last BulkPublish operation for an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

+ * @see {@link GetBulkPublishDetailsCommand} */ - public getBulkPublishDetails( + getBulkPublishDetails( args: GetBulkPublishDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBulkPublishDetails( + getBulkPublishDetails( args: GetBulkPublishDetailsCommandInput, cb: (err: any, data?: GetBulkPublishDetailsCommandOutput) => void ): void; - public getBulkPublishDetails( + getBulkPublishDetails( args: GetBulkPublishDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBulkPublishDetailsCommandOutput) => void ): void; - public getBulkPublishDetails( - args: GetBulkPublishDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBulkPublishDetailsCommandOutput) => void), - cb?: (err: any, data?: GetBulkPublishDetailsCommandOutput) => void - ): Promise | void { - const command = new GetBulkPublishDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the events and the corresponding Lambda functions associated with an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

+ * @see {@link GetCognitoEventsCommand} */ - public getCognitoEvents( + getCognitoEvents( args: GetCognitoEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCognitoEvents( + getCognitoEvents( args: GetCognitoEventsCommandInput, cb: (err: any, data?: GetCognitoEventsCommandOutput) => void ): void; - public getCognitoEvents( + getCognitoEvents( args: GetCognitoEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCognitoEventsCommandOutput) => void ): void; - public getCognitoEvents( - args: GetCognitoEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCognitoEventsCommandOutput) => void), - cb?: (err: any, data?: GetCognitoEventsCommandOutput) => void - ): Promise | void { - const command = new GetCognitoEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the configuration settings of an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

- * - * - * GetIdentityPoolConfiguration - * The following examples have been edited for readability. - * - * POST / HTTP/1.1 - * CONTENT-TYPE: application/json - * X-AMZN-REQUESTID: b1cfdd4b-f620-4fe4-be0f-02024a1d33da - * X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.GetIdentityPoolConfiguration - * HOST: cognito-sync.us-east-1.amazonaws.com - * X-AMZ-DATE: 20141004T195722Z - * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature= - * - * \{ - * "Operation": "com.amazonaws.cognito.sync.model#GetIdentityPoolConfiguration", - * "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService", - * "Input": - * \{ - * "IdentityPoolId": "ID_POOL_ID" - * \} - * \} - * - * - * - * 1.1 200 OK - * x-amzn-requestid: b1cfdd4b-f620-4fe4-be0f-02024a1d33da - * date: Sat, 04 Oct 2014 19:57:22 GMT - * content-type: application/json - * content-length: 332 - * - * \{ - * "Output": - * \{ - * "__type": "com.amazonaws.cognito.sync.model#GetIdentityPoolConfigurationResponse", - * "IdentityPoolId": "ID_POOL_ID", - * "PushSync": - * \{ - * "ApplicationArns": ["PLATFORMARN1", "PLATFORMARN2"], - * "RoleArn": "ROLEARN" - * \} - * \}, - * "Version": "1.0" - * \} - * - * - * + * @see {@link GetIdentityPoolConfigurationCommand} */ - public getIdentityPoolConfiguration( + getIdentityPoolConfiguration( args: GetIdentityPoolConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIdentityPoolConfiguration( + getIdentityPoolConfiguration( args: GetIdentityPoolConfigurationCommandInput, cb: (err: any, data?: GetIdentityPoolConfigurationCommandOutput) => void ): void; - public getIdentityPoolConfiguration( + getIdentityPoolConfiguration( args: GetIdentityPoolConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIdentityPoolConfigurationCommandOutput) => void ): void; - public getIdentityPoolConfiguration( - args: GetIdentityPoolConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIdentityPoolConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetIdentityPoolConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetIdentityPoolConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to - * its own data. Thus, the credentials used to make this API call need to have access to the - * identity data.

- *

ListDatasets can be called with temporary user credentials provided by Cognito - * Identity or with developer credentials. You should use the Cognito Identity credentials to - * make this API call.

- * - * - * ListDatasets - * The following examples have been edited for readability. - * - * POST / HTTP/1.1 - * CONTENT-TYPE: application/json - * X-AMZN-REQUESTID: 15225768-209f-4078-aaed-7494ace9f2db - * X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.ListDatasets - * HOST: cognito-sync.us-east-1.amazonaws.com:443 - * X-AMZ-DATE: 20141111T215640Z - * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=, SignedHeaders=content-type;host;x-amz-date;x-amz-target;x-amzn-requestid, Signature= - * - * \{ - * "Operation": "com.amazonaws.cognito.sync.model#ListDatasets", - * "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService", - * "Input": - * \{ - * "IdentityPoolId": "IDENTITY_POOL_ID", - * "IdentityId": "IDENTITY_ID", - * "MaxResults": "3" - * \} - * \} - * - * - * 1.1 200 OK - * x-amzn-requestid: 15225768-209f-4078-aaed-7494ace9f2db, 15225768-209f-4078-aaed-7494ace9f2db - * content-type: application/json - * content-length: 355 - * date: Tue, 11 Nov 2014 21:56:40 GMT - * - * \{ - * "Output": - * \{ - * "__type": "com.amazonaws.cognito.sync.model#ListDatasetsResponse", - * "Count": 1, - * "Datasets": [ - * \{ - * "CreationDate": 1.412974057151E9, - * "DataStorage": 16, - * "DatasetName": "my_list", - * "IdentityId": "IDENTITY_ID", - * "LastModifiedBy": "123456789012", - * "LastModifiedDate": 1.412974057244E9, - * "NumRecords": 1 - * \}], - * "NextToken": null - * \}, - * "Version": "1.0" - * \} - * - * - * + * @see {@link ListDatasetsCommand} */ - public listDatasets( - args: ListDatasetsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void; - public listDatasets( + listDatasets(args: ListDatasetsCommandInput, options?: __HttpHandlerOptions): Promise; + listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void; + listDatasets( args: ListDatasetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetsCommandOutput) => void ): void; - public listDatasets( - args: ListDatasetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatasetsCommandOutput) => void), - cb?: (err: any, data?: ListDatasetsCommandOutput) => void - ): Promise | void { - const command = new ListDatasetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of identity pools registered with Cognito.

- *

ListIdentityPoolUsage can only be called with developer credentials. You - * cannot make this API call with the temporary user credentials provided by Cognito - * Identity.

- * - * - * ListIdentityPoolUsage - * The following examples have been edited for readability. - * - * POST / HTTP/1.1 - * CONTENT-TYPE: application/json - * X-AMZN-REQUESTID: 9be7c425-ef05-48c0-aef3-9f0ff2fe17d3 - * X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.ListIdentityPoolUsage - * HOST: cognito-sync.us-east-1.amazonaws.com:443 - * X-AMZ-DATE: 20141111T211414Z - * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=, SignedHeaders=content-type;host;x-amz-date;x-amz-target;x-amzn-requestid, Signature= - * - * \{ - * "Operation": "com.amazonaws.cognito.sync.model#ListIdentityPoolUsage", - * "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService", - * "Input": - * \{ - * "MaxResults": "2" - * \} - * \} - * - * - * 1.1 200 OK - * x-amzn-requestid: 9be7c425-ef05-48c0-aef3-9f0ff2fe17d3 - * content-type: application/json - * content-length: 519 - * date: Tue, 11 Nov 2014 21:14:14 GMT - * - * \{ - * "Output": - * \{ - * "__type": "com.amazonaws.cognito.sync.model#ListIdentityPoolUsageResponse", - * "Count": 2, - * "IdentityPoolUsages": [ - * \{ - * "DataStorage": 0, - * "IdentityPoolId": "IDENTITY_POOL_ID", - * "LastModifiedDate": 1.413836234607E9, - * "SyncSessionsCount": null - * \}, - * \{ - * "DataStorage": 0, - * "IdentityPoolId": "IDENTITY_POOL_ID", - * "LastModifiedDate": 1.410892165601E9, - * "SyncSessionsCount": null - * \}], - * "MaxResults": 2, - * "NextToken": "dXMtZWFzdC0xOjBjMWJhMDUyLWUwOTgtNDFmYS1hNzZlLWVhYTJjMTI1Zjg2MQ==" - * \}, - * "Version": "1.0" - * \} - * - * - * + * @see {@link ListIdentityPoolUsageCommand} */ - public listIdentityPoolUsage( + listIdentityPoolUsage( args: ListIdentityPoolUsageCommandInput, options?: __HttpHandlerOptions ): Promise; - public listIdentityPoolUsage( + listIdentityPoolUsage( args: ListIdentityPoolUsageCommandInput, cb: (err: any, data?: ListIdentityPoolUsageCommandOutput) => void ): void; - public listIdentityPoolUsage( + listIdentityPoolUsage( args: ListIdentityPoolUsageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIdentityPoolUsageCommandOutput) => void ): void; - public listIdentityPoolUsage( - args: ListIdentityPoolUsageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIdentityPoolUsageCommandOutput) => void), - cb?: (err: any, data?: ListIdentityPoolUsageCommandOutput) => void - ): Promise | void { - const command = new ListIdentityPoolUsageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets paginated records, optionally changed after a particular sync count for a dataset and - * identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, - * the credentials used to make this API call need to have access to the identity data.

- *

ListRecords can be called with temporary user credentials provided by Cognito - * Identity or with developer credentials. You should use Cognito Identity credentials to make - * this API call.

- * - * - * ListRecords - * The following examples have been edited for readability. - * - * POST / HTTP/1.1 - * CONTENT-TYPE: application/json - * X-AMZN-REQUESTID: b3d2e31e-d6b7-4612-8e84-c9ba288dab5d - * X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.ListRecords - * HOST: cognito-sync.us-east-1.amazonaws.com:443 - * X-AMZ-DATE: 20141111T183230Z - * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=, SignedHeaders=content-type;host;x-amz-date;x-amz-target;x-amzn-requestid, Signature= - * - * \{ - * "Operation": "com.amazonaws.cognito.sync.model#ListRecords", - * "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService", - * "Input": - * \{ - * "IdentityPoolId": "IDENTITY_POOL_ID", - * "IdentityId": "IDENTITY_ID", - * "DatasetName": "newDataSet" - * \} - * \} - * - * - * 1.1 200 OK - * x-amzn-requestid: b3d2e31e-d6b7-4612-8e84-c9ba288dab5d - * content-type: application/json - * content-length: 623 - * date: Tue, 11 Nov 2014 18:32:30 GMT - * - * \{ - * "Output": - * \{ - * "__type": "com.amazonaws.cognito.sync.model#ListRecordsResponse", - * "Count": 0, - * "DatasetDeletedAfterRequestedSyncCount": false, - * "DatasetExists": false, - * "DatasetSyncCount": 0, - * "LastModifiedBy": null, - * "MergedDatasetNames": null, - * "NextToken": null, - * "Records": [], - * "SyncSessionToken": "SYNC_SESSION_TOKEN" - * \}, - * "Version": "1.0" - * \} - * - * - * + * @see {@link ListRecordsCommand} */ - public listRecords(args: ListRecordsCommandInput, options?: __HttpHandlerOptions): Promise; - public listRecords(args: ListRecordsCommandInput, cb: (err: any, data?: ListRecordsCommandOutput) => void): void; - public listRecords( + listRecords(args: ListRecordsCommandInput, options?: __HttpHandlerOptions): Promise; + listRecords(args: ListRecordsCommandInput, cb: (err: any, data?: ListRecordsCommandOutput) => void): void; + listRecords( args: ListRecordsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecordsCommandOutput) => void ): void; - public listRecords( - args: ListRecordsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRecordsCommandOutput) => void), - cb?: (err: any, data?: ListRecordsCommandOutput) => void - ): Promise | void { - const command = new ListRecordsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers a device to receive push sync notifications.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

- * - * - * RegisterDevice - * The following examples have been edited for readability. - * - * POST / HTTP/1.1 - * CONTENT-TYPE: application/json - * X-AMZN-REQUESTID: 368f9200-3eca-449e-93b3-7b9c08d8e185 - * X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.RegisterDevice - * HOST: cognito-sync.us-east-1.amazonaws.com - * X-AMZ-DATE: 20141004T194643Z - * X-AMZ-SECURITY-TOKEN: - * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature= - * - * \{ - * "Operation": "com.amazonaws.cognito.sync.model#RegisterDevice", - * "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService", - * "Input": - * \{ - * "IdentityPoolId": "ID_POOL_ID", - * "IdentityId": "IDENTITY_ID", - * "Platform": "GCM", - * "Token": "PUSH_TOKEN" - * \} - * \} - * - * - * 1.1 200 OK - * x-amzn-requestid: 368f9200-3eca-449e-93b3-7b9c08d8e185 - * date: Sat, 04 Oct 2014 19:46:44 GMT - * content-type: application/json - * content-length: 145 - * - * \{ - * "Output": - * \{ - * "__type": "com.amazonaws.cognito.sync.model#RegisterDeviceResponse", - * "DeviceId": "5cd28fbe-dd83-47ab-9f83-19093a5fb014" - * \}, - * "Version": "1.0" - * \} - * - * - * + * @see {@link RegisterDeviceCommand} */ - public registerDevice( + registerDevice( args: RegisterDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerDevice( - args: RegisterDeviceCommandInput, - cb: (err: any, data?: RegisterDeviceCommandOutput) => void - ): void; - public registerDevice( + registerDevice(args: RegisterDeviceCommandInput, cb: (err: any, data?: RegisterDeviceCommandOutput) => void): void; + registerDevice( args: RegisterDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterDeviceCommandOutput) => void ): void; - public registerDevice( - args: RegisterDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterDeviceCommandOutput) => void), - cb?: (err: any, data?: RegisterDeviceCommandOutput) => void - ): Promise | void { - const command = new RegisterDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

+ * @see {@link SetCognitoEventsCommand} */ - public setCognitoEvents( + setCognitoEvents( args: SetCognitoEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public setCognitoEvents( + setCognitoEvents( args: SetCognitoEventsCommandInput, cb: (err: any, data?: SetCognitoEventsCommandOutput) => void ): void; - public setCognitoEvents( + setCognitoEvents( args: SetCognitoEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetCognitoEventsCommandOutput) => void ): void; - public setCognitoEvents( - args: SetCognitoEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetCognitoEventsCommandOutput) => void), - cb?: (err: any, data?: SetCognitoEventsCommandOutput) => void - ): Promise | void { - const command = new SetCognitoEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the necessary configuration for push sync.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

- * - * - * SetIdentityPoolConfiguration - * The following examples have been edited for readability. - * - * POST / HTTP/1.1 - * CONTENT-TYPE: application/json - * X-AMZN-REQUESTID: a46db021-f5dd-45d6-af5b-7069fa4a211b - * X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.SetIdentityPoolConfiguration - * HOST: cognito-sync.us-east-1.amazonaws.com - * X-AMZ-DATE: 20141004T200006Z - * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature= - * - * \{ - * "Operation": "com.amazonaws.cognito.sync.model#SetIdentityPoolConfiguration", - * "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService", - * "Input": - * \{ - * "IdentityPoolId": "ID_POOL_ID", - * "PushSync": - * \{ - * "ApplicationArns": ["PLATFORMARN1", "PLATFORMARN2"], - * "RoleArn": "ROLEARN" - * \} - * \} - * \} - * - * - * 1.1 200 OK - * x-amzn-requestid: a46db021-f5dd-45d6-af5b-7069fa4a211b - * date: Sat, 04 Oct 2014 20:00:06 GMT - * content-type: application/json - * content-length: 332 - * - * \{ - * "Output": - * \{ - * "__type": "com.amazonaws.cognito.sync.model#SetIdentityPoolConfigurationResponse", - * "IdentityPoolId": "ID_POOL_ID", - * "PushSync": - * \{ - * "ApplicationArns": ["PLATFORMARN1", "PLATFORMARN2"], - * "RoleArn": "ROLEARN" - * \} - * \}, - * "Version": "1.0" - * \} - * - * - * + * @see {@link SetIdentityPoolConfigurationCommand} */ - public setIdentityPoolConfiguration( + setIdentityPoolConfiguration( args: SetIdentityPoolConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public setIdentityPoolConfiguration( + setIdentityPoolConfiguration( args: SetIdentityPoolConfigurationCommandInput, cb: (err: any, data?: SetIdentityPoolConfigurationCommandOutput) => void ): void; - public setIdentityPoolConfiguration( + setIdentityPoolConfiguration( args: SetIdentityPoolConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetIdentityPoolConfigurationCommandOutput) => void ): void; - public setIdentityPoolConfiguration( - args: SetIdentityPoolConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetIdentityPoolConfigurationCommandOutput) => void), - cb?: (err: any, data?: SetIdentityPoolConfigurationCommandOutput) => void - ): Promise | void { - const command = new SetIdentityPoolConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Subscribes to receive notifications when a dataset is modified by another device.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

- * - * - * SubscribeToDataset - * The following examples have been edited for readability. - * - * POST / HTTP/1.1 - * CONTENT-TYPE: application/json - * X-AMZN-REQUESTID: 8b9932b7-201d-4418-a960-0a470e11de9f - * X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.SubscribeToDataset - * HOST: cognito-sync.us-east-1.amazonaws.com - * X-AMZ-DATE: 20141004T195350Z - * X-AMZ-SECURITY-TOKEN: - * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature= - * - * \{ - * "Operation": "com.amazonaws.cognito.sync.model#SubscribeToDataset", - * "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService", - * "Input": - * \{ - * "IdentityPoolId": "ID_POOL_ID", - * "IdentityId": "IDENTITY_ID", - * "DatasetName": "Rufus", - * "DeviceId": "5cd28fbe-dd83-47ab-9f83-19093a5fb014" - * \} - * \} - * - * - * 1.1 200 OK - * x-amzn-requestid: 8b9932b7-201d-4418-a960-0a470e11de9f - * date: Sat, 04 Oct 2014 19:53:50 GMT - * content-type: application/json - * content-length: 99 - * - * \{ - * "Output": - * \{ - * "__type": "com.amazonaws.cognito.sync.model#SubscribeToDatasetResponse" - * \}, - * "Version": "1.0" - * \} - * - * - * + * @see {@link SubscribeToDatasetCommand} */ - public subscribeToDataset( + subscribeToDataset( args: SubscribeToDatasetCommandInput, options?: __HttpHandlerOptions ): Promise; - public subscribeToDataset( + subscribeToDataset( args: SubscribeToDatasetCommandInput, cb: (err: any, data?: SubscribeToDatasetCommandOutput) => void ): void; - public subscribeToDataset( + subscribeToDataset( args: SubscribeToDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubscribeToDatasetCommandOutput) => void ): void; - public subscribeToDataset( - args: SubscribeToDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SubscribeToDatasetCommandOutput) => void), - cb?: (err: any, data?: SubscribeToDatasetCommandOutput) => void - ): Promise | void { - const command = new SubscribeToDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Unsubscribes from receiving notifications when a dataset is modified by another device.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

- * - * - * UnsubscribeFromDataset - * The following examples have been edited for readability. - * - * POST / HTTP/1.1 - * CONTENT-TYPE: application/json - * X-AMZ-REQUESTSUPERTRACE: true - * X-AMZN-REQUESTID: 676896d6-14ca-45b1-8029-6d36b10a077e - * X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.UnsubscribeFromDataset - * HOST: cognito-sync.us-east-1.amazonaws.com - * X-AMZ-DATE: 20141004T195446Z - * X-AMZ-SECURITY-TOKEN: - * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature= - * - * \{ - * "Operation": "com.amazonaws.cognito.sync.model#UnsubscribeFromDataset", - * "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService", - * "Input": - * \{ - * "IdentityPoolId": "ID_POOL_ID", - * "IdentityId": "IDENTITY_ID", - * "DatasetName": "Rufus", - * "DeviceId": "5cd28fbe-dd83-47ab-9f83-19093a5fb014" - * \} - * \} - * - * - * 1.1 200 OK - * x-amzn-requestid: 676896d6-14ca-45b1-8029-6d36b10a077e - * date: Sat, 04 Oct 2014 19:54:46 GMT - * content-type: application/json - * content-length: 103 - * - * \{ - * "Output": - * \{ - * "__type": "com.amazonaws.cognito.sync.model#UnsubscribeFromDatasetResponse" - * \}, - * "Version": "1.0" - * \} - * - * - * + * @see {@link UnsubscribeFromDatasetCommand} */ - public unsubscribeFromDataset( + unsubscribeFromDataset( args: UnsubscribeFromDatasetCommandInput, options?: __HttpHandlerOptions ): Promise; - public unsubscribeFromDataset( + unsubscribeFromDataset( args: UnsubscribeFromDatasetCommandInput, cb: (err: any, data?: UnsubscribeFromDatasetCommandOutput) => void ): void; - public unsubscribeFromDataset( + unsubscribeFromDataset( args: UnsubscribeFromDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnsubscribeFromDatasetCommandOutput) => void ): void; - public unsubscribeFromDataset( - args: UnsubscribeFromDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnsubscribeFromDatasetCommandOutput) => void), - cb?: (err: any, data?: UnsubscribeFromDatasetCommandOutput) => void - ): Promise | void { - const command = new UnsubscribeFromDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Posts updates to records and adds and deletes records for a dataset and user.

- *

The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count.

For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0.

- *

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

+ * @see {@link UpdateRecordsCommand} */ - public updateRecords( - args: UpdateRecordsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateRecords( - args: UpdateRecordsCommandInput, - cb: (err: any, data?: UpdateRecordsCommandOutput) => void - ): void; - public updateRecords( + updateRecords(args: UpdateRecordsCommandInput, options?: __HttpHandlerOptions): Promise; + updateRecords(args: UpdateRecordsCommandInput, cb: (err: any, data?: UpdateRecordsCommandOutput) => void): void; + updateRecords( args: UpdateRecordsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRecordsCommandOutput) => void ): void; - public updateRecords( - args: UpdateRecordsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRecordsCommandOutput) => void), - cb?: (err: any, data?: UpdateRecordsCommandOutput) => void - ): Promise | void { - const command = new UpdateRecordsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Cognito Sync + *

Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of + * application-related user data. High-level client libraries are available for both iOS and + * Android. You can use these libraries to persist data locally so that it's available even if + * the device is offline. Developer credentials don't need to be stored on the mobile device + * to access the service. You can use Amazon Cognito to obtain a normalized user ID and + * credentials. User data is persisted in a dataset that can store up to 1 MB of key-value + * pairs, and you can have up to 20 datasets per user identity.

+ *

With Amazon Cognito Sync, the data stored for each identity is accessible only to + * credentials assigned to that identity. In order to use the Cognito Sync service, you need + * to make API calls using credentials retrieved with Amazon Cognito Identity service.

+ *

If you want to use Cognito Sync in an Android or iOS application, you will probably want to + * make API calls via the AWS Mobile SDK. To learn more, see the Developer Guide for Android and the Developer Guide for iOS.

+ */ +export class CognitoSync extends CognitoSyncClient implements CognitoSync {} +createAggregatedClient(commands, CognitoSync); diff --git a/clients/client-comprehend/src/Comprehend.ts b/clients/client-comprehend/src/Comprehend.ts index cbcba0ea79fa..ffb54ab8994e 100644 --- a/clients/client-comprehend/src/Comprehend.ts +++ b/clients/client-comprehend/src/Comprehend.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -413,2962 +414,1456 @@ import { UpdateFlywheelCommandInput, UpdateFlywheelCommandOutput, } from "./commands/UpdateFlywheelCommand"; -import { ComprehendClient } from "./ComprehendClient"; +import { ComprehendClient, ComprehendClientConfig } from "./ComprehendClient"; -/** - * @public - *

Amazon Comprehend is an Amazon Web Services service for gaining insight into the content of documents. - * Use these actions to determine the topics contained in your documents, the topics they - * discuss, the predominant sentiment expressed in them, the predominant language used, and - * more.

- */ -export class Comprehend extends ComprehendClient { +const commands = { + BatchDetectDominantLanguageCommand, + BatchDetectEntitiesCommand, + BatchDetectKeyPhrasesCommand, + BatchDetectSentimentCommand, + BatchDetectSyntaxCommand, + BatchDetectTargetedSentimentCommand, + ClassifyDocumentCommand, + ContainsPiiEntitiesCommand, + CreateDatasetCommand, + CreateDocumentClassifierCommand, + CreateEndpointCommand, + CreateEntityRecognizerCommand, + CreateFlywheelCommand, + DeleteDocumentClassifierCommand, + DeleteEndpointCommand, + DeleteEntityRecognizerCommand, + DeleteFlywheelCommand, + DeleteResourcePolicyCommand, + DescribeDatasetCommand, + DescribeDocumentClassificationJobCommand, + DescribeDocumentClassifierCommand, + DescribeDominantLanguageDetectionJobCommand, + DescribeEndpointCommand, + DescribeEntitiesDetectionJobCommand, + DescribeEntityRecognizerCommand, + DescribeEventsDetectionJobCommand, + DescribeFlywheelCommand, + DescribeFlywheelIterationCommand, + DescribeKeyPhrasesDetectionJobCommand, + DescribePiiEntitiesDetectionJobCommand, + DescribeResourcePolicyCommand, + DescribeSentimentDetectionJobCommand, + DescribeTargetedSentimentDetectionJobCommand, + DescribeTopicsDetectionJobCommand, + DetectDominantLanguageCommand, + DetectEntitiesCommand, + DetectKeyPhrasesCommand, + DetectPiiEntitiesCommand, + DetectSentimentCommand, + DetectSyntaxCommand, + DetectTargetedSentimentCommand, + ImportModelCommand, + ListDatasetsCommand, + ListDocumentClassificationJobsCommand, + ListDocumentClassifiersCommand, + ListDocumentClassifierSummariesCommand, + ListDominantLanguageDetectionJobsCommand, + ListEndpointsCommand, + ListEntitiesDetectionJobsCommand, + ListEntityRecognizersCommand, + ListEntityRecognizerSummariesCommand, + ListEventsDetectionJobsCommand, + ListFlywheelIterationHistoryCommand, + ListFlywheelsCommand, + ListKeyPhrasesDetectionJobsCommand, + ListPiiEntitiesDetectionJobsCommand, + ListSentimentDetectionJobsCommand, + ListTagsForResourceCommand, + ListTargetedSentimentDetectionJobsCommand, + ListTopicsDetectionJobsCommand, + PutResourcePolicyCommand, + StartDocumentClassificationJobCommand, + StartDominantLanguageDetectionJobCommand, + StartEntitiesDetectionJobCommand, + StartEventsDetectionJobCommand, + StartFlywheelIterationCommand, + StartKeyPhrasesDetectionJobCommand, + StartPiiEntitiesDetectionJobCommand, + StartSentimentDetectionJobCommand, + StartTargetedSentimentDetectionJobCommand, + StartTopicsDetectionJobCommand, + StopDominantLanguageDetectionJobCommand, + StopEntitiesDetectionJobCommand, + StopEventsDetectionJobCommand, + StopKeyPhrasesDetectionJobCommand, + StopPiiEntitiesDetectionJobCommand, + StopSentimentDetectionJobCommand, + StopTargetedSentimentDetectionJobCommand, + StopTrainingDocumentClassifierCommand, + StopTrainingEntityRecognizerCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateEndpointCommand, + UpdateFlywheelCommand, +}; + +export interface Comprehend { /** - * @public - *

Determines the dominant language of the input text for a batch of documents. For a list - * of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages. - *

+ * @see {@link BatchDetectDominantLanguageCommand} */ - public batchDetectDominantLanguage( + batchDetectDominantLanguage( args: BatchDetectDominantLanguageCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDetectDominantLanguage( + batchDetectDominantLanguage( args: BatchDetectDominantLanguageCommandInput, cb: (err: any, data?: BatchDetectDominantLanguageCommandOutput) => void ): void; - public batchDetectDominantLanguage( + batchDetectDominantLanguage( args: BatchDetectDominantLanguageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDetectDominantLanguageCommandOutput) => void ): void; - public batchDetectDominantLanguage( - args: BatchDetectDominantLanguageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDetectDominantLanguageCommandOutput) => void), - cb?: (err: any, data?: BatchDetectDominantLanguageCommandOutput) => void - ): Promise | void { - const command = new BatchDetectDominantLanguageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Inspects the text of a batch of documents for named entities and returns information - * about them. For more information about named entities, see - * Entities in the Comprehend Developer Guide. - *

- */ - public batchDetectEntities( + + /** + * @see {@link BatchDetectEntitiesCommand} + */ + batchDetectEntities( args: BatchDetectEntitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDetectEntities( + batchDetectEntities( args: BatchDetectEntitiesCommandInput, cb: (err: any, data?: BatchDetectEntitiesCommandOutput) => void ): void; - public batchDetectEntities( + batchDetectEntities( args: BatchDetectEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDetectEntitiesCommandOutput) => void ): void; - public batchDetectEntities( - args: BatchDetectEntitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDetectEntitiesCommandOutput) => void), - cb?: (err: any, data?: BatchDetectEntitiesCommandOutput) => void - ): Promise | void { - const command = new BatchDetectEntitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detects the key noun phrases found in a batch of documents.

- */ - public batchDetectKeyPhrases( + + /** + * @see {@link BatchDetectKeyPhrasesCommand} + */ + batchDetectKeyPhrases( args: BatchDetectKeyPhrasesCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDetectKeyPhrases( + batchDetectKeyPhrases( args: BatchDetectKeyPhrasesCommandInput, cb: (err: any, data?: BatchDetectKeyPhrasesCommandOutput) => void ): void; - public batchDetectKeyPhrases( + batchDetectKeyPhrases( args: BatchDetectKeyPhrasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDetectKeyPhrasesCommandOutput) => void ): void; - public batchDetectKeyPhrases( - args: BatchDetectKeyPhrasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDetectKeyPhrasesCommandOutput) => void), - cb?: (err: any, data?: BatchDetectKeyPhrasesCommandOutput) => void - ): Promise | void { - const command = new BatchDetectKeyPhrasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Inspects a batch of documents and returns an inference of the prevailing sentiment, - * POSITIVE, NEUTRAL, MIXED, or NEGATIVE, - * in each one.

- */ - public batchDetectSentiment( + + /** + * @see {@link BatchDetectSentimentCommand} + */ + batchDetectSentiment( args: BatchDetectSentimentCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDetectSentiment( + batchDetectSentiment( args: BatchDetectSentimentCommandInput, cb: (err: any, data?: BatchDetectSentimentCommandOutput) => void ): void; - public batchDetectSentiment( + batchDetectSentiment( args: BatchDetectSentimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDetectSentimentCommandOutput) => void ): void; - public batchDetectSentiment( - args: BatchDetectSentimentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDetectSentimentCommandOutput) => void), - cb?: (err: any, data?: BatchDetectSentimentCommandOutput) => void - ): Promise | void { - const command = new BatchDetectSentimentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Inspects the text of a batch of documents for the syntax and part of speech of the words - * in the document and returns information about them. For more information, see - * Syntax in the Comprehend Developer Guide. - *

- */ - public batchDetectSyntax( + + /** + * @see {@link BatchDetectSyntaxCommand} + */ + batchDetectSyntax( args: BatchDetectSyntaxCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDetectSyntax( + batchDetectSyntax( args: BatchDetectSyntaxCommandInput, cb: (err: any, data?: BatchDetectSyntaxCommandOutput) => void ): void; - public batchDetectSyntax( + batchDetectSyntax( args: BatchDetectSyntaxCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDetectSyntaxCommandOutput) => void ): void; - public batchDetectSyntax( - args: BatchDetectSyntaxCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDetectSyntaxCommandOutput) => void), - cb?: (err: any, data?: BatchDetectSyntaxCommandOutput) => void - ): Promise | void { - const command = new BatchDetectSyntaxCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Inspects a batch of documents and returns a sentiment analysis - * for each entity identified in the documents.

- *

For more information about targeted sentiment, see Targeted sentiment.

- */ - public batchDetectTargetedSentiment( + + /** + * @see {@link BatchDetectTargetedSentimentCommand} + */ + batchDetectTargetedSentiment( args: BatchDetectTargetedSentimentCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDetectTargetedSentiment( + batchDetectTargetedSentiment( args: BatchDetectTargetedSentimentCommandInput, cb: (err: any, data?: BatchDetectTargetedSentimentCommandOutput) => void ): void; - public batchDetectTargetedSentiment( + batchDetectTargetedSentiment( args: BatchDetectTargetedSentimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDetectTargetedSentimentCommandOutput) => void ): void; - public batchDetectTargetedSentiment( - args: BatchDetectTargetedSentimentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDetectTargetedSentimentCommandOutput) => void), - cb?: (err: any, data?: BatchDetectTargetedSentimentCommandOutput) => void - ): Promise | void { - const command = new BatchDetectTargetedSentimentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new document classification request to analyze a single document in real-time, - * using a previously created and trained custom model and an endpoint.

- *

You can input plain text or you can upload a single-page input document (text, PDF, Word, or image).

- *

If the system detects errors while processing a page in the input document, - * the API response includes an entry in Errors that describes the errors.

- *

If the system detects a document-level error in your input document, the API returns an - * InvalidRequestException error response. - * For details about this exception, see - * - * Errors in semi-structured documents in the Comprehend Developer Guide. - *

- */ - public classifyDocument( + + /** + * @see {@link ClassifyDocumentCommand} + */ + classifyDocument( args: ClassifyDocumentCommandInput, options?: __HttpHandlerOptions ): Promise; - public classifyDocument( + classifyDocument( args: ClassifyDocumentCommandInput, cb: (err: any, data?: ClassifyDocumentCommandOutput) => void ): void; - public classifyDocument( + classifyDocument( args: ClassifyDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ClassifyDocumentCommandOutput) => void ): void; - public classifyDocument( - args: ClassifyDocumentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ClassifyDocumentCommandOutput) => void), - cb?: (err: any, data?: ClassifyDocumentCommandOutput) => void - ): Promise | void { - const command = new ClassifyDocumentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Analyzes input text for the presence of personally identifiable information (PII) and - * returns the labels of identified PII entity types such as name, address, bank account number, - * or phone number.

- */ - public containsPiiEntities( + + /** + * @see {@link ContainsPiiEntitiesCommand} + */ + containsPiiEntities( args: ContainsPiiEntitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public containsPiiEntities( + containsPiiEntities( args: ContainsPiiEntitiesCommandInput, cb: (err: any, data?: ContainsPiiEntitiesCommandOutput) => void ): void; - public containsPiiEntities( + containsPiiEntities( args: ContainsPiiEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ContainsPiiEntitiesCommandOutput) => void ): void; - public containsPiiEntities( - args: ContainsPiiEntitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ContainsPiiEntitiesCommandOutput) => void), - cb?: (err: any, data?: ContainsPiiEntitiesCommandOutput) => void - ): Promise | void { - const command = new ContainsPiiEntitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a dataset to upload training or test data for a model associated with a flywheel. - * For more information about datasets, see - * Flywheel overview in the Amazon Comprehend Developer Guide.

- */ - public createDataset( - args: CreateDatasetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createDataset( - args: CreateDatasetCommandInput, - cb: (err: any, data?: CreateDatasetCommandOutput) => void - ): void; - public createDataset( + + /** + * @see {@link CreateDatasetCommand} + */ + createDataset(args: CreateDatasetCommandInput, options?: __HttpHandlerOptions): Promise; + createDataset(args: CreateDatasetCommandInput, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void; + createDataset( args: CreateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetCommandOutput) => void ): void; - public createDataset( - args: CreateDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDatasetCommandOutput) => void), - cb?: (err: any, data?: CreateDatasetCommandOutput) => void - ): Promise | void { - const command = new CreateDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new document classifier that you can use to categorize documents. To create a - * classifier, you provide a set of training documents that labeled with the categories that you - * want to use. After the classifier is trained you can use it to categorize a set of labeled - * documents into the categories. For more information, see - * Document Classification in the Comprehend Developer Guide. - *

- */ - public createDocumentClassifier( + + /** + * @see {@link CreateDocumentClassifierCommand} + */ + createDocumentClassifier( args: CreateDocumentClassifierCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDocumentClassifier( + createDocumentClassifier( args: CreateDocumentClassifierCommandInput, cb: (err: any, data?: CreateDocumentClassifierCommandOutput) => void ): void; - public createDocumentClassifier( + createDocumentClassifier( args: CreateDocumentClassifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDocumentClassifierCommandOutput) => void ): void; - public createDocumentClassifier( - args: CreateDocumentClassifierCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDocumentClassifierCommandOutput) => void), - cb?: (err: any, data?: CreateDocumentClassifierCommandOutput) => void - ): Promise | void { - const command = new CreateDocumentClassifierCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a model-specific endpoint for synchronous inference for a previously trained - * custom model - * For information about endpoints, see Managing endpoints.

- */ - public createEndpoint( + + /** + * @see {@link CreateEndpointCommand} + */ + createEndpoint( args: CreateEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEndpoint( - args: CreateEndpointCommandInput, - cb: (err: any, data?: CreateEndpointCommandOutput) => void - ): void; - public createEndpoint( + createEndpoint(args: CreateEndpointCommandInput, cb: (err: any, data?: CreateEndpointCommandOutput) => void): void; + createEndpoint( args: CreateEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEndpointCommandOutput) => void ): void; - public createEndpoint( - args: CreateEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEndpointCommandOutput) => void), - cb?: (err: any, data?: CreateEndpointCommandOutput) => void - ): Promise | void { - const command = new CreateEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an entity recognizer using submitted files. After your - * CreateEntityRecognizer request is submitted, you can check job status using the - * DescribeEntityRecognizer API.

- */ - public createEntityRecognizer( + + /** + * @see {@link CreateEntityRecognizerCommand} + */ + createEntityRecognizer( args: CreateEntityRecognizerCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEntityRecognizer( + createEntityRecognizer( args: CreateEntityRecognizerCommandInput, cb: (err: any, data?: CreateEntityRecognizerCommandOutput) => void ): void; - public createEntityRecognizer( + createEntityRecognizer( args: CreateEntityRecognizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEntityRecognizerCommandOutput) => void ): void; - public createEntityRecognizer( - args: CreateEntityRecognizerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEntityRecognizerCommandOutput) => void), - cb?: (err: any, data?: CreateEntityRecognizerCommandOutput) => void - ): Promise | void { - const command = new CreateEntityRecognizerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification - * or custom entity recognition. You can create a flywheel to start with an existing trained model, or - * Comprehend can create and train a new model.

- *

When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training - * data and test data for all versions of the model.

- *

To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's - * training data and test data into the flywheel's data lake.

- *

To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) - * when you create the flywheel.

- *

For more information about flywheels, see - * Flywheel overview in the Amazon Comprehend Developer Guide.

- */ - public createFlywheel( + + /** + * @see {@link CreateFlywheelCommand} + */ + createFlywheel( args: CreateFlywheelCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFlywheel( - args: CreateFlywheelCommandInput, - cb: (err: any, data?: CreateFlywheelCommandOutput) => void - ): void; - public createFlywheel( + createFlywheel(args: CreateFlywheelCommandInput, cb: (err: any, data?: CreateFlywheelCommandOutput) => void): void; + createFlywheel( args: CreateFlywheelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFlywheelCommandOutput) => void ): void; - public createFlywheel( - args: CreateFlywheelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFlywheelCommandOutput) => void), - cb?: (err: any, data?: CreateFlywheelCommandOutput) => void - ): Promise | void { - const command = new CreateFlywheelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a previously created document classifier

- *

Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. - * If an active inference job is using the model, a ResourceInUseException will be - * returned.

- *

This is an asynchronous action that puts the classifier into a DELETING state, and it is - * then removed by a background job. Once removed, the classifier disappears from your account - * and is no longer available for use.

- */ - public deleteDocumentClassifier( + + /** + * @see {@link DeleteDocumentClassifierCommand} + */ + deleteDocumentClassifier( args: DeleteDocumentClassifierCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDocumentClassifier( + deleteDocumentClassifier( args: DeleteDocumentClassifierCommandInput, cb: (err: any, data?: DeleteDocumentClassifierCommandOutput) => void ): void; - public deleteDocumentClassifier( + deleteDocumentClassifier( args: DeleteDocumentClassifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDocumentClassifierCommandOutput) => void ): void; - public deleteDocumentClassifier( - args: DeleteDocumentClassifierCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDocumentClassifierCommandOutput) => void), - cb?: (err: any, data?: DeleteDocumentClassifierCommandOutput) => void - ): Promise | void { - const command = new DeleteDocumentClassifierCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a model-specific endpoint for a previously-trained custom model. All endpoints - * must be deleted in order for the model to be deleted. - * For information about endpoints, see Managing endpoints.

- */ - public deleteEndpoint( + + /** + * @see {@link DeleteEndpointCommand} + */ + deleteEndpoint( args: DeleteEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEndpoint( - args: DeleteEndpointCommandInput, - cb: (err: any, data?: DeleteEndpointCommandOutput) => void - ): void; - public deleteEndpoint( + deleteEndpoint(args: DeleteEndpointCommandInput, cb: (err: any, data?: DeleteEndpointCommandOutput) => void): void; + deleteEndpoint( args: DeleteEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEndpointCommandOutput) => void ): void; - public deleteEndpoint( - args: DeleteEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEndpointCommandOutput) => void), - cb?: (err: any, data?: DeleteEndpointCommandOutput) => void - ): Promise | void { - const command = new DeleteEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an entity recognizer.

- *

Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. - * If an active inference job is using the model, a ResourceInUseException will be - * returned.

- *

This is an asynchronous action that puts the recognizer into a DELETING state, and it is - * then removed by a background job. Once removed, the recognizer disappears from your account - * and is no longer available for use.

- */ - public deleteEntityRecognizer( + + /** + * @see {@link DeleteEntityRecognizerCommand} + */ + deleteEntityRecognizer( args: DeleteEntityRecognizerCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEntityRecognizer( + deleteEntityRecognizer( args: DeleteEntityRecognizerCommandInput, cb: (err: any, data?: DeleteEntityRecognizerCommandOutput) => void ): void; - public deleteEntityRecognizer( + deleteEntityRecognizer( args: DeleteEntityRecognizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEntityRecognizerCommandOutput) => void ): void; - public deleteEntityRecognizer( - args: DeleteEntityRecognizerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEntityRecognizerCommandOutput) => void), - cb?: (err: any, data?: DeleteEntityRecognizerCommandOutput) => void - ): Promise | void { - const command = new DeleteEntityRecognizerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a flywheel. When you delete the flywheel, Amazon Comprehend - * does not delete the data lake or the model associated with the flywheel.

- *

For more information about flywheels, see - * Flywheel overview in the Amazon Comprehend Developer Guide.

- */ - public deleteFlywheel( + + /** + * @see {@link DeleteFlywheelCommand} + */ + deleteFlywheel( args: DeleteFlywheelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFlywheel( - args: DeleteFlywheelCommandInput, - cb: (err: any, data?: DeleteFlywheelCommandOutput) => void - ): void; - public deleteFlywheel( + deleteFlywheel(args: DeleteFlywheelCommandInput, cb: (err: any, data?: DeleteFlywheelCommandOutput) => void): void; + deleteFlywheel( args: DeleteFlywheelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFlywheelCommandOutput) => void ): void; - public deleteFlywheel( - args: DeleteFlywheelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFlywheelCommandOutput) => void), - cb?: (err: any, data?: DeleteFlywheelCommandOutput) => void - ): Promise | void { - const command = new DeleteFlywheelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a resource-based policy that is attached to a custom model.

- */ - public deleteResourcePolicy( + + /** + * @see {@link DeleteResourcePolicyCommand} + */ + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( - args: DeleteResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the dataset that you specify. - * For more information about datasets, see - * Flywheel overview in the Amazon Comprehend Developer Guide.

- */ - public describeDataset( + + /** + * @see {@link DescribeDatasetCommand} + */ + describeDataset( args: DescribeDatasetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDataset( - args: DescribeDatasetCommandInput, - cb: (err: any, data?: DescribeDatasetCommandOutput) => void - ): void; - public describeDataset( + describeDataset(args: DescribeDatasetCommandInput, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void; + describeDataset( args: DescribeDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetCommandOutput) => void ): void; - public describeDataset( - args: DescribeDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDatasetCommandOutput) => void), - cb?: (err: any, data?: DescribeDatasetCommandOutput) => void - ): Promise | void { - const command = new DescribeDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the properties associated with a document classification job. Use this operation to - * get the status of a classification job.

- */ - public describeDocumentClassificationJob( + + /** + * @see {@link DescribeDocumentClassificationJobCommand} + */ + describeDocumentClassificationJob( args: DescribeDocumentClassificationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDocumentClassificationJob( + describeDocumentClassificationJob( args: DescribeDocumentClassificationJobCommandInput, cb: (err: any, data?: DescribeDocumentClassificationJobCommandOutput) => void ): void; - public describeDocumentClassificationJob( + describeDocumentClassificationJob( args: DescribeDocumentClassificationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDocumentClassificationJobCommandOutput) => void ): void; - public describeDocumentClassificationJob( - args: DescribeDocumentClassificationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDocumentClassificationJobCommandOutput) => void), - cb?: (err: any, data?: DescribeDocumentClassificationJobCommandOutput) => void - ): Promise | void { - const command = new DescribeDocumentClassificationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the properties associated with a document classifier.

- */ - public describeDocumentClassifier( + + /** + * @see {@link DescribeDocumentClassifierCommand} + */ + describeDocumentClassifier( args: DescribeDocumentClassifierCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDocumentClassifier( + describeDocumentClassifier( args: DescribeDocumentClassifierCommandInput, cb: (err: any, data?: DescribeDocumentClassifierCommandOutput) => void ): void; - public describeDocumentClassifier( + describeDocumentClassifier( args: DescribeDocumentClassifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDocumentClassifierCommandOutput) => void ): void; - public describeDocumentClassifier( - args: DescribeDocumentClassifierCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDocumentClassifierCommandOutput) => void), - cb?: (err: any, data?: DescribeDocumentClassifierCommandOutput) => void - ): Promise | void { - const command = new DescribeDocumentClassifierCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the properties associated with a dominant language detection job. Use this operation - * to get the status of a detection job.

- */ - public describeDominantLanguageDetectionJob( + + /** + * @see {@link DescribeDominantLanguageDetectionJobCommand} + */ + describeDominantLanguageDetectionJob( args: DescribeDominantLanguageDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDominantLanguageDetectionJob( + describeDominantLanguageDetectionJob( args: DescribeDominantLanguageDetectionJobCommandInput, cb: (err: any, data?: DescribeDominantLanguageDetectionJobCommandOutput) => void ): void; - public describeDominantLanguageDetectionJob( + describeDominantLanguageDetectionJob( args: DescribeDominantLanguageDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDominantLanguageDetectionJobCommandOutput) => void ): void; - public describeDominantLanguageDetectionJob( - args: DescribeDominantLanguageDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDominantLanguageDetectionJobCommandOutput) => void), - cb?: (err: any, data?: DescribeDominantLanguageDetectionJobCommandOutput) => void - ): Promise | void { - const command = new DescribeDominantLanguageDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the properties associated with a specific endpoint. Use this operation to get the - * status of an endpoint. - * For information about endpoints, see Managing endpoints.

- */ - public describeEndpoint( + + /** + * @see {@link DescribeEndpointCommand} + */ + describeEndpoint( args: DescribeEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEndpoint( + describeEndpoint( args: DescribeEndpointCommandInput, cb: (err: any, data?: DescribeEndpointCommandOutput) => void ): void; - public describeEndpoint( + describeEndpoint( args: DescribeEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEndpointCommandOutput) => void ): void; - public describeEndpoint( - args: DescribeEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEndpointCommandOutput) => void), - cb?: (err: any, data?: DescribeEndpointCommandOutput) => void - ): Promise | void { - const command = new DescribeEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the properties associated with an entities detection job. Use this operation to get - * the status of a detection job.

- */ - public describeEntitiesDetectionJob( + + /** + * @see {@link DescribeEntitiesDetectionJobCommand} + */ + describeEntitiesDetectionJob( args: DescribeEntitiesDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEntitiesDetectionJob( + describeEntitiesDetectionJob( args: DescribeEntitiesDetectionJobCommandInput, cb: (err: any, data?: DescribeEntitiesDetectionJobCommandOutput) => void ): void; - public describeEntitiesDetectionJob( + describeEntitiesDetectionJob( args: DescribeEntitiesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEntitiesDetectionJobCommandOutput) => void ): void; - public describeEntitiesDetectionJob( - args: DescribeEntitiesDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEntitiesDetectionJobCommandOutput) => void), - cb?: (err: any, data?: DescribeEntitiesDetectionJobCommandOutput) => void - ): Promise | void { - const command = new DescribeEntitiesDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides details about an entity recognizer including status, S3 buckets containing - * training data, recognizer metadata, metrics, and so on.

- */ - public describeEntityRecognizer( + + /** + * @see {@link DescribeEntityRecognizerCommand} + */ + describeEntityRecognizer( args: DescribeEntityRecognizerCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEntityRecognizer( + describeEntityRecognizer( args: DescribeEntityRecognizerCommandInput, cb: (err: any, data?: DescribeEntityRecognizerCommandOutput) => void ): void; - public describeEntityRecognizer( + describeEntityRecognizer( args: DescribeEntityRecognizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEntityRecognizerCommandOutput) => void ): void; - public describeEntityRecognizer( - args: DescribeEntityRecognizerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEntityRecognizerCommandOutput) => void), - cb?: (err: any, data?: DescribeEntityRecognizerCommandOutput) => void - ): Promise | void { - const command = new DescribeEntityRecognizerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the status and details of an events detection job.

- */ - public describeEventsDetectionJob( + + /** + * @see {@link DescribeEventsDetectionJobCommand} + */ + describeEventsDetectionJob( args: DescribeEventsDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventsDetectionJob( + describeEventsDetectionJob( args: DescribeEventsDetectionJobCommandInput, cb: (err: any, data?: DescribeEventsDetectionJobCommandOutput) => void ): void; - public describeEventsDetectionJob( + describeEventsDetectionJob( args: DescribeEventsDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsDetectionJobCommandOutput) => void ): void; - public describeEventsDetectionJob( - args: DescribeEventsDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventsDetectionJobCommandOutput) => void), - cb?: (err: any, data?: DescribeEventsDetectionJobCommandOutput) => void - ): Promise | void { - const command = new DescribeEventsDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides configuration information about the flywheel. For more information about flywheels, see - * Flywheel overview in the Amazon Comprehend Developer Guide.

- */ - public describeFlywheel( + + /** + * @see {@link DescribeFlywheelCommand} + */ + describeFlywheel( args: DescribeFlywheelCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFlywheel( + describeFlywheel( args: DescribeFlywheelCommandInput, cb: (err: any, data?: DescribeFlywheelCommandOutput) => void ): void; - public describeFlywheel( + describeFlywheel( args: DescribeFlywheelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFlywheelCommandOutput) => void ): void; - public describeFlywheel( - args: DescribeFlywheelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFlywheelCommandOutput) => void), - cb?: (err: any, data?: DescribeFlywheelCommandOutput) => void - ): Promise | void { - const command = new DescribeFlywheelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieve the configuration properties of a flywheel iteration. - * For more information about flywheels, see - * Flywheel overview in the Amazon Comprehend Developer Guide.

- */ - public describeFlywheelIteration( + + /** + * @see {@link DescribeFlywheelIterationCommand} + */ + describeFlywheelIteration( args: DescribeFlywheelIterationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFlywheelIteration( + describeFlywheelIteration( args: DescribeFlywheelIterationCommandInput, cb: (err: any, data?: DescribeFlywheelIterationCommandOutput) => void ): void; - public describeFlywheelIteration( + describeFlywheelIteration( args: DescribeFlywheelIterationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFlywheelIterationCommandOutput) => void ): void; - public describeFlywheelIteration( - args: DescribeFlywheelIterationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFlywheelIterationCommandOutput) => void), - cb?: (err: any, data?: DescribeFlywheelIterationCommandOutput) => void - ): Promise | void { - const command = new DescribeFlywheelIterationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the properties associated with a key phrases detection job. Use this operation to get - * the status of a detection job.

- */ - public describeKeyPhrasesDetectionJob( + + /** + * @see {@link DescribeKeyPhrasesDetectionJobCommand} + */ + describeKeyPhrasesDetectionJob( args: DescribeKeyPhrasesDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeKeyPhrasesDetectionJob( + describeKeyPhrasesDetectionJob( args: DescribeKeyPhrasesDetectionJobCommandInput, cb: (err: any, data?: DescribeKeyPhrasesDetectionJobCommandOutput) => void ): void; - public describeKeyPhrasesDetectionJob( + describeKeyPhrasesDetectionJob( args: DescribeKeyPhrasesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeKeyPhrasesDetectionJobCommandOutput) => void ): void; - public describeKeyPhrasesDetectionJob( - args: DescribeKeyPhrasesDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeKeyPhrasesDetectionJobCommandOutput) => void), - cb?: (err: any, data?: DescribeKeyPhrasesDetectionJobCommandOutput) => void - ): Promise | void { - const command = new DescribeKeyPhrasesDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the properties associated with a PII entities detection job. For example, you can use - * this operation to get the job status.

- */ - public describePiiEntitiesDetectionJob( + + /** + * @see {@link DescribePiiEntitiesDetectionJobCommand} + */ + describePiiEntitiesDetectionJob( args: DescribePiiEntitiesDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePiiEntitiesDetectionJob( + describePiiEntitiesDetectionJob( args: DescribePiiEntitiesDetectionJobCommandInput, cb: (err: any, data?: DescribePiiEntitiesDetectionJobCommandOutput) => void ): void; - public describePiiEntitiesDetectionJob( + describePiiEntitiesDetectionJob( args: DescribePiiEntitiesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePiiEntitiesDetectionJobCommandOutput) => void ): void; - public describePiiEntitiesDetectionJob( - args: DescribePiiEntitiesDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePiiEntitiesDetectionJobCommandOutput) => void), - cb?: (err: any, data?: DescribePiiEntitiesDetectionJobCommandOutput) => void - ): Promise | void { - const command = new DescribePiiEntitiesDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the details of a resource-based policy that is attached to a custom model, including - * the JSON body of the policy.

- */ - public describeResourcePolicy( + + /** + * @see {@link DescribeResourcePolicyCommand} + */ + describeResourcePolicy( args: DescribeResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeResourcePolicy( + describeResourcePolicy( args: DescribeResourcePolicyCommandInput, cb: (err: any, data?: DescribeResourcePolicyCommandOutput) => void ): void; - public describeResourcePolicy( + describeResourcePolicy( args: DescribeResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeResourcePolicyCommandOutput) => void ): void; - public describeResourcePolicy( - args: DescribeResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: DescribeResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new DescribeResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the properties associated with a sentiment detection job. Use this operation to get - * the status of a detection job.

- */ - public describeSentimentDetectionJob( + + /** + * @see {@link DescribeSentimentDetectionJobCommand} + */ + describeSentimentDetectionJob( args: DescribeSentimentDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSentimentDetectionJob( + describeSentimentDetectionJob( args: DescribeSentimentDetectionJobCommandInput, cb: (err: any, data?: DescribeSentimentDetectionJobCommandOutput) => void ): void; - public describeSentimentDetectionJob( + describeSentimentDetectionJob( args: DescribeSentimentDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSentimentDetectionJobCommandOutput) => void ): void; - public describeSentimentDetectionJob( - args: DescribeSentimentDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSentimentDetectionJobCommandOutput) => void), - cb?: (err: any, data?: DescribeSentimentDetectionJobCommandOutput) => void - ): Promise | void { - const command = new DescribeSentimentDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the properties associated with a targeted sentiment detection job. Use this operation - * to get the status of the job.

- */ - public describeTargetedSentimentDetectionJob( + + /** + * @see {@link DescribeTargetedSentimentDetectionJobCommand} + */ + describeTargetedSentimentDetectionJob( args: DescribeTargetedSentimentDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTargetedSentimentDetectionJob( + describeTargetedSentimentDetectionJob( args: DescribeTargetedSentimentDetectionJobCommandInput, cb: (err: any, data?: DescribeTargetedSentimentDetectionJobCommandOutput) => void ): void; - public describeTargetedSentimentDetectionJob( + describeTargetedSentimentDetectionJob( args: DescribeTargetedSentimentDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTargetedSentimentDetectionJobCommandOutput) => void ): void; - public describeTargetedSentimentDetectionJob( - args: DescribeTargetedSentimentDetectionJobCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeTargetedSentimentDetectionJobCommandOutput) => void), - cb?: (err: any, data?: DescribeTargetedSentimentDetectionJobCommandOutput) => void - ): Promise | void { - const command = new DescribeTargetedSentimentDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the properties associated with a topic detection job. Use this operation to get - * the status of a detection job.

- */ - public describeTopicsDetectionJob( + + /** + * @see {@link DescribeTopicsDetectionJobCommand} + */ + describeTopicsDetectionJob( args: DescribeTopicsDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTopicsDetectionJob( + describeTopicsDetectionJob( args: DescribeTopicsDetectionJobCommandInput, cb: (err: any, data?: DescribeTopicsDetectionJobCommandOutput) => void ): void; - public describeTopicsDetectionJob( + describeTopicsDetectionJob( args: DescribeTopicsDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTopicsDetectionJobCommandOutput) => void ): void; - public describeTopicsDetectionJob( - args: DescribeTopicsDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTopicsDetectionJobCommandOutput) => void), - cb?: (err: any, data?: DescribeTopicsDetectionJobCommandOutput) => void - ): Promise | void { - const command = new DescribeTopicsDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Determines the dominant language of the input text. For a list of languages that Amazon - * Comprehend can detect, see Amazon Comprehend Supported Languages.

- */ - public detectDominantLanguage( + + /** + * @see {@link DetectDominantLanguageCommand} + */ + detectDominantLanguage( args: DetectDominantLanguageCommandInput, options?: __HttpHandlerOptions ): Promise; - public detectDominantLanguage( + detectDominantLanguage( args: DetectDominantLanguageCommandInput, cb: (err: any, data?: DetectDominantLanguageCommandOutput) => void ): void; - public detectDominantLanguage( + detectDominantLanguage( args: DetectDominantLanguageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectDominantLanguageCommandOutput) => void ): void; - public detectDominantLanguage( - args: DetectDominantLanguageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectDominantLanguageCommandOutput) => void), - cb?: (err: any, data?: DetectDominantLanguageCommandOutput) => void - ): Promise | void { - const command = new DetectDominantLanguageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detects named entities in input text when you use the pre-trained model. - * Detects custom entities if you have a custom entity recognition model.

- *

- * When detecting named entities using the pre-trained model, use plain text as the input. - * For more information about named entities, see - * Entities in the Comprehend Developer Guide.

- *

When you use a custom entity recognition model, - * you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).

- *

If the system detects errors while processing a page in the input document, the API response - * includes an entry in Errors for each error.

- *

If the system detects a document-level error in your input document, the API returns an - * InvalidRequestException error response. - * For details about this exception, see - * - * Errors in semi-structured documents in the Comprehend Developer Guide. - *

- */ - public detectEntities( + + /** + * @see {@link DetectEntitiesCommand} + */ + detectEntities( args: DetectEntitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public detectEntities( - args: DetectEntitiesCommandInput, - cb: (err: any, data?: DetectEntitiesCommandOutput) => void - ): void; - public detectEntities( + detectEntities(args: DetectEntitiesCommandInput, cb: (err: any, data?: DetectEntitiesCommandOutput) => void): void; + detectEntities( args: DetectEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectEntitiesCommandOutput) => void ): void; - public detectEntities( - args: DetectEntitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectEntitiesCommandOutput) => void), - cb?: (err: any, data?: DetectEntitiesCommandOutput) => void - ): Promise | void { - const command = new DetectEntitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detects the key noun phrases found in the text.

- */ - public detectKeyPhrases( + + /** + * @see {@link DetectKeyPhrasesCommand} + */ + detectKeyPhrases( args: DetectKeyPhrasesCommandInput, options?: __HttpHandlerOptions ): Promise; - public detectKeyPhrases( + detectKeyPhrases( args: DetectKeyPhrasesCommandInput, cb: (err: any, data?: DetectKeyPhrasesCommandOutput) => void ): void; - public detectKeyPhrases( + detectKeyPhrases( args: DetectKeyPhrasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectKeyPhrasesCommandOutput) => void ): void; - public detectKeyPhrases( - args: DetectKeyPhrasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectKeyPhrasesCommandOutput) => void), - cb?: (err: any, data?: DetectKeyPhrasesCommandOutput) => void - ): Promise | void { - const command = new DetectKeyPhrasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Inspects the input text for entities that contain personally identifiable information - * (PII) and returns information about them.

- */ - public detectPiiEntities( + + /** + * @see {@link DetectPiiEntitiesCommand} + */ + detectPiiEntities( args: DetectPiiEntitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public detectPiiEntities( + detectPiiEntities( args: DetectPiiEntitiesCommandInput, cb: (err: any, data?: DetectPiiEntitiesCommandOutput) => void ): void; - public detectPiiEntities( + detectPiiEntities( args: DetectPiiEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectPiiEntitiesCommandOutput) => void ): void; - public detectPiiEntities( - args: DetectPiiEntitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectPiiEntitiesCommandOutput) => void), - cb?: (err: any, data?: DetectPiiEntitiesCommandOutput) => void - ): Promise | void { - const command = new DetectPiiEntitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Inspects text and returns an inference of the prevailing sentiment - * (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).

- */ - public detectSentiment( + + /** + * @see {@link DetectSentimentCommand} + */ + detectSentiment( args: DetectSentimentCommandInput, options?: __HttpHandlerOptions ): Promise; - public detectSentiment( - args: DetectSentimentCommandInput, - cb: (err: any, data?: DetectSentimentCommandOutput) => void - ): void; - public detectSentiment( + detectSentiment(args: DetectSentimentCommandInput, cb: (err: any, data?: DetectSentimentCommandOutput) => void): void; + detectSentiment( args: DetectSentimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectSentimentCommandOutput) => void ): void; - public detectSentiment( - args: DetectSentimentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectSentimentCommandOutput) => void), - cb?: (err: any, data?: DetectSentimentCommandOutput) => void - ): Promise | void { - const command = new DetectSentimentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Inspects text for syntax and the part of speech of words in the document. For more - * information, see - * Syntax in the Comprehend Developer Guide. - *

- */ - public detectSyntax( - args: DetectSyntaxCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public detectSyntax(args: DetectSyntaxCommandInput, cb: (err: any, data?: DetectSyntaxCommandOutput) => void): void; - public detectSyntax( + + /** + * @see {@link DetectSyntaxCommand} + */ + detectSyntax(args: DetectSyntaxCommandInput, options?: __HttpHandlerOptions): Promise; + detectSyntax(args: DetectSyntaxCommandInput, cb: (err: any, data?: DetectSyntaxCommandOutput) => void): void; + detectSyntax( args: DetectSyntaxCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectSyntaxCommandOutput) => void ): void; - public detectSyntax( - args: DetectSyntaxCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectSyntaxCommandOutput) => void), - cb?: (err: any, data?: DetectSyntaxCommandOutput) => void - ): Promise | void { - const command = new DetectSyntaxCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Inspects the input text and returns a sentiment analysis for each entity identified in the text.

- *

For more information about targeted sentiment, see Targeted sentiment.

- */ - public detectTargetedSentiment( + + /** + * @see {@link DetectTargetedSentimentCommand} + */ + detectTargetedSentiment( args: DetectTargetedSentimentCommandInput, options?: __HttpHandlerOptions ): Promise; - public detectTargetedSentiment( + detectTargetedSentiment( args: DetectTargetedSentimentCommandInput, cb: (err: any, data?: DetectTargetedSentimentCommandOutput) => void ): void; - public detectTargetedSentiment( + detectTargetedSentiment( args: DetectTargetedSentimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectTargetedSentimentCommandOutput) => void ): void; - public detectTargetedSentiment( - args: DetectTargetedSentimentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectTargetedSentimentCommandOutput) => void), - cb?: (err: any, data?: DetectTargetedSentimentCommandOutput) => void - ): Promise | void { - const command = new DetectTargetedSentimentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new custom model that replicates a source custom model that you import. The - * source model can be in your Amazon Web Services account or another one.

- *

If the source model is in another Amazon Web Services account, then it must have a resource-based policy - * that authorizes you to import it.

- *

The source model must be in the same Amazon Web Services Region that you're using when you import. You - * can't import a model that's in a different Region.

- */ - public importModel(args: ImportModelCommandInput, options?: __HttpHandlerOptions): Promise; - public importModel(args: ImportModelCommandInput, cb: (err: any, data?: ImportModelCommandOutput) => void): void; - public importModel( + + /** + * @see {@link ImportModelCommand} + */ + importModel(args: ImportModelCommandInput, options?: __HttpHandlerOptions): Promise; + importModel(args: ImportModelCommandInput, cb: (err: any, data?: ImportModelCommandOutput) => void): void; + importModel( args: ImportModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportModelCommandOutput) => void ): void; - public importModel( - args: ImportModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportModelCommandOutput) => void), - cb?: (err: any, data?: ImportModelCommandOutput) => void - ): Promise | void { - const command = new ImportModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List the datasets that you have configured in this Region. For more information about datasets, see - * Flywheel overview in the Amazon Comprehend Developer Guide.

- */ - public listDatasets( - args: ListDatasetsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void; - public listDatasets( + + /** + * @see {@link ListDatasetsCommand} + */ + listDatasets(args: ListDatasetsCommandInput, options?: __HttpHandlerOptions): Promise; + listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void; + listDatasets( args: ListDatasetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetsCommandOutput) => void ): void; - public listDatasets( - args: ListDatasetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatasetsCommandOutput) => void), - cb?: (err: any, data?: ListDatasetsCommandOutput) => void - ): Promise | void { - const command = new ListDatasetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of the documentation classification jobs that you have submitted.

- */ - public listDocumentClassificationJobs( + + /** + * @see {@link ListDocumentClassificationJobsCommand} + */ + listDocumentClassificationJobs( args: ListDocumentClassificationJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDocumentClassificationJobs( + listDocumentClassificationJobs( args: ListDocumentClassificationJobsCommandInput, cb: (err: any, data?: ListDocumentClassificationJobsCommandOutput) => void ): void; - public listDocumentClassificationJobs( + listDocumentClassificationJobs( args: ListDocumentClassificationJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDocumentClassificationJobsCommandOutput) => void ): void; - public listDocumentClassificationJobs( - args: ListDocumentClassificationJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDocumentClassificationJobsCommandOutput) => void), - cb?: (err: any, data?: ListDocumentClassificationJobsCommandOutput) => void - ): Promise | void { - const command = new ListDocumentClassificationJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of the document classifiers that you have created.

- */ - public listDocumentClassifiers( + + /** + * @see {@link ListDocumentClassifiersCommand} + */ + listDocumentClassifiers( args: ListDocumentClassifiersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDocumentClassifiers( + listDocumentClassifiers( args: ListDocumentClassifiersCommandInput, cb: (err: any, data?: ListDocumentClassifiersCommandOutput) => void ): void; - public listDocumentClassifiers( + listDocumentClassifiers( args: ListDocumentClassifiersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDocumentClassifiersCommandOutput) => void ): void; - public listDocumentClassifiers( - args: ListDocumentClassifiersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDocumentClassifiersCommandOutput) => void), - cb?: (err: any, data?: ListDocumentClassifiersCommandOutput) => void - ): Promise | void { - const command = new ListDocumentClassifiersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of summaries of the document classifiers that you have created

- */ - public listDocumentClassifierSummaries( + + /** + * @see {@link ListDocumentClassifierSummariesCommand} + */ + listDocumentClassifierSummaries( args: ListDocumentClassifierSummariesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDocumentClassifierSummaries( + listDocumentClassifierSummaries( args: ListDocumentClassifierSummariesCommandInput, cb: (err: any, data?: ListDocumentClassifierSummariesCommandOutput) => void ): void; - public listDocumentClassifierSummaries( + listDocumentClassifierSummaries( args: ListDocumentClassifierSummariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDocumentClassifierSummariesCommandOutput) => void ): void; - public listDocumentClassifierSummaries( - args: ListDocumentClassifierSummariesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDocumentClassifierSummariesCommandOutput) => void), - cb?: (err: any, data?: ListDocumentClassifierSummariesCommandOutput) => void - ): Promise | void { - const command = new ListDocumentClassifierSummariesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of the dominant language detection jobs that you have submitted.

- */ - public listDominantLanguageDetectionJobs( + + /** + * @see {@link ListDominantLanguageDetectionJobsCommand} + */ + listDominantLanguageDetectionJobs( args: ListDominantLanguageDetectionJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDominantLanguageDetectionJobs( + listDominantLanguageDetectionJobs( args: ListDominantLanguageDetectionJobsCommandInput, cb: (err: any, data?: ListDominantLanguageDetectionJobsCommandOutput) => void ): void; - public listDominantLanguageDetectionJobs( + listDominantLanguageDetectionJobs( args: ListDominantLanguageDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDominantLanguageDetectionJobsCommandOutput) => void ): void; - public listDominantLanguageDetectionJobs( - args: ListDominantLanguageDetectionJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDominantLanguageDetectionJobsCommandOutput) => void), - cb?: (err: any, data?: ListDominantLanguageDetectionJobsCommandOutput) => void - ): Promise | void { - const command = new ListDominantLanguageDetectionJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of all existing endpoints that you've created. - * For information about endpoints, see Managing endpoints.

- */ - public listEndpoints( - args: ListEndpointsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listEndpoints( - args: ListEndpointsCommandInput, - cb: (err: any, data?: ListEndpointsCommandOutput) => void - ): void; - public listEndpoints( + + /** + * @see {@link ListEndpointsCommand} + */ + listEndpoints(args: ListEndpointsCommandInput, options?: __HttpHandlerOptions): Promise; + listEndpoints(args: ListEndpointsCommandInput, cb: (err: any, data?: ListEndpointsCommandOutput) => void): void; + listEndpoints( args: ListEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEndpointsCommandOutput) => void ): void; - public listEndpoints( - args: ListEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEndpointsCommandOutput) => void), - cb?: (err: any, data?: ListEndpointsCommandOutput) => void - ): Promise | void { - const command = new ListEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of the entity detection jobs that you have submitted.

- */ - public listEntitiesDetectionJobs( + + /** + * @see {@link ListEntitiesDetectionJobsCommand} + */ + listEntitiesDetectionJobs( args: ListEntitiesDetectionJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEntitiesDetectionJobs( + listEntitiesDetectionJobs( args: ListEntitiesDetectionJobsCommandInput, cb: (err: any, data?: ListEntitiesDetectionJobsCommandOutput) => void ): void; - public listEntitiesDetectionJobs( + listEntitiesDetectionJobs( args: ListEntitiesDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEntitiesDetectionJobsCommandOutput) => void ): void; - public listEntitiesDetectionJobs( - args: ListEntitiesDetectionJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEntitiesDetectionJobsCommandOutput) => void), - cb?: (err: any, data?: ListEntitiesDetectionJobsCommandOutput) => void - ): Promise | void { - const command = new ListEntitiesDetectionJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of the properties of all entity recognizers that you created, including - * recognizers currently in training. Allows you to filter the list of recognizers based on - * criteria such as status and submission time. This call returns up to 500 entity recognizers in - * the list, with a default number of 100 recognizers in the list.

- *

The results of this list are not in any particular order. Please get the list and sort - * locally if needed.

- */ - public listEntityRecognizers( + + /** + * @see {@link ListEntityRecognizersCommand} + */ + listEntityRecognizers( args: ListEntityRecognizersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEntityRecognizers( + listEntityRecognizers( args: ListEntityRecognizersCommandInput, cb: (err: any, data?: ListEntityRecognizersCommandOutput) => void ): void; - public listEntityRecognizers( + listEntityRecognizers( args: ListEntityRecognizersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEntityRecognizersCommandOutput) => void ): void; - public listEntityRecognizers( - args: ListEntityRecognizersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEntityRecognizersCommandOutput) => void), - cb?: (err: any, data?: ListEntityRecognizersCommandOutput) => void - ): Promise | void { - const command = new ListEntityRecognizersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of summaries for the entity recognizers that you have created.

- */ - public listEntityRecognizerSummaries( + + /** + * @see {@link ListEntityRecognizerSummariesCommand} + */ + listEntityRecognizerSummaries( args: ListEntityRecognizerSummariesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEntityRecognizerSummaries( + listEntityRecognizerSummaries( args: ListEntityRecognizerSummariesCommandInput, cb: (err: any, data?: ListEntityRecognizerSummariesCommandOutput) => void ): void; - public listEntityRecognizerSummaries( + listEntityRecognizerSummaries( args: ListEntityRecognizerSummariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEntityRecognizerSummariesCommandOutput) => void ): void; - public listEntityRecognizerSummaries( - args: ListEntityRecognizerSummariesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEntityRecognizerSummariesCommandOutput) => void), - cb?: (err: any, data?: ListEntityRecognizerSummariesCommandOutput) => void - ): Promise | void { - const command = new ListEntityRecognizerSummariesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of the events detection jobs that you have submitted.

- */ - public listEventsDetectionJobs( + + /** + * @see {@link ListEventsDetectionJobsCommand} + */ + listEventsDetectionJobs( args: ListEventsDetectionJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEventsDetectionJobs( + listEventsDetectionJobs( args: ListEventsDetectionJobsCommandInput, cb: (err: any, data?: ListEventsDetectionJobsCommandOutput) => void ): void; - public listEventsDetectionJobs( + listEventsDetectionJobs( args: ListEventsDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventsDetectionJobsCommandOutput) => void ): void; - public listEventsDetectionJobs( - args: ListEventsDetectionJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEventsDetectionJobsCommandOutput) => void), - cb?: (err: any, data?: ListEventsDetectionJobsCommandOutput) => void - ): Promise | void { - const command = new ListEventsDetectionJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Information about the history of a flywheel iteration. - * For more information about flywheels, see - * Flywheel overview in the Amazon Comprehend Developer Guide.

- */ - public listFlywheelIterationHistory( + + /** + * @see {@link ListFlywheelIterationHistoryCommand} + */ + listFlywheelIterationHistory( args: ListFlywheelIterationHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFlywheelIterationHistory( + listFlywheelIterationHistory( args: ListFlywheelIterationHistoryCommandInput, cb: (err: any, data?: ListFlywheelIterationHistoryCommandOutput) => void ): void; - public listFlywheelIterationHistory( + listFlywheelIterationHistory( args: ListFlywheelIterationHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFlywheelIterationHistoryCommandOutput) => void ): void; - public listFlywheelIterationHistory( - args: ListFlywheelIterationHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFlywheelIterationHistoryCommandOutput) => void), - cb?: (err: any, data?: ListFlywheelIterationHistoryCommandOutput) => void - ): Promise | void { - const command = new ListFlywheelIterationHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of the flywheels that you have created.

- */ - public listFlywheels( - args: ListFlywheelsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listFlywheels( - args: ListFlywheelsCommandInput, - cb: (err: any, data?: ListFlywheelsCommandOutput) => void - ): void; - public listFlywheels( + + /** + * @see {@link ListFlywheelsCommand} + */ + listFlywheels(args: ListFlywheelsCommandInput, options?: __HttpHandlerOptions): Promise; + listFlywheels(args: ListFlywheelsCommandInput, cb: (err: any, data?: ListFlywheelsCommandOutput) => void): void; + listFlywheels( args: ListFlywheelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFlywheelsCommandOutput) => void ): void; - public listFlywheels( - args: ListFlywheelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFlywheelsCommandOutput) => void), - cb?: (err: any, data?: ListFlywheelsCommandOutput) => void - ): Promise | void { - const command = new ListFlywheelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get a list of key phrase detection jobs that you have submitted.

- */ - public listKeyPhrasesDetectionJobs( + + /** + * @see {@link ListKeyPhrasesDetectionJobsCommand} + */ + listKeyPhrasesDetectionJobs( args: ListKeyPhrasesDetectionJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listKeyPhrasesDetectionJobs( + listKeyPhrasesDetectionJobs( args: ListKeyPhrasesDetectionJobsCommandInput, cb: (err: any, data?: ListKeyPhrasesDetectionJobsCommandOutput) => void ): void; - public listKeyPhrasesDetectionJobs( + listKeyPhrasesDetectionJobs( args: ListKeyPhrasesDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKeyPhrasesDetectionJobsCommandOutput) => void ): void; - public listKeyPhrasesDetectionJobs( - args: ListKeyPhrasesDetectionJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListKeyPhrasesDetectionJobsCommandOutput) => void), - cb?: (err: any, data?: ListKeyPhrasesDetectionJobsCommandOutput) => void - ): Promise | void { - const command = new ListKeyPhrasesDetectionJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of the PII entity detection jobs that you have submitted.

- */ - public listPiiEntitiesDetectionJobs( + + /** + * @see {@link ListPiiEntitiesDetectionJobsCommand} + */ + listPiiEntitiesDetectionJobs( args: ListPiiEntitiesDetectionJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPiiEntitiesDetectionJobs( + listPiiEntitiesDetectionJobs( args: ListPiiEntitiesDetectionJobsCommandInput, cb: (err: any, data?: ListPiiEntitiesDetectionJobsCommandOutput) => void ): void; - public listPiiEntitiesDetectionJobs( + listPiiEntitiesDetectionJobs( args: ListPiiEntitiesDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPiiEntitiesDetectionJobsCommandOutput) => void ): void; - public listPiiEntitiesDetectionJobs( - args: ListPiiEntitiesDetectionJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPiiEntitiesDetectionJobsCommandOutput) => void), - cb?: (err: any, data?: ListPiiEntitiesDetectionJobsCommandOutput) => void - ): Promise | void { - const command = new ListPiiEntitiesDetectionJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of sentiment detection jobs that you have submitted.

- */ - public listSentimentDetectionJobs( + + /** + * @see {@link ListSentimentDetectionJobsCommand} + */ + listSentimentDetectionJobs( args: ListSentimentDetectionJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSentimentDetectionJobs( + listSentimentDetectionJobs( args: ListSentimentDetectionJobsCommandInput, cb: (err: any, data?: ListSentimentDetectionJobsCommandOutput) => void ): void; - public listSentimentDetectionJobs( + listSentimentDetectionJobs( args: ListSentimentDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSentimentDetectionJobsCommandOutput) => void ): void; - public listSentimentDetectionJobs( - args: ListSentimentDetectionJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSentimentDetectionJobsCommandOutput) => void), - cb?: (err: any, data?: ListSentimentDetectionJobsCommandOutput) => void - ): Promise | void { - const command = new ListSentimentDetectionJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all tags associated with a given Amazon Comprehend resource.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of targeted sentiment detection jobs that you have submitted.

- */ - public listTargetedSentimentDetectionJobs( + + /** + * @see {@link ListTargetedSentimentDetectionJobsCommand} + */ + listTargetedSentimentDetectionJobs( args: ListTargetedSentimentDetectionJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTargetedSentimentDetectionJobs( + listTargetedSentimentDetectionJobs( args: ListTargetedSentimentDetectionJobsCommandInput, cb: (err: any, data?: ListTargetedSentimentDetectionJobsCommandOutput) => void ): void; - public listTargetedSentimentDetectionJobs( + listTargetedSentimentDetectionJobs( args: ListTargetedSentimentDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTargetedSentimentDetectionJobsCommandOutput) => void ): void; - public listTargetedSentimentDetectionJobs( - args: ListTargetedSentimentDetectionJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTargetedSentimentDetectionJobsCommandOutput) => void), - cb?: (err: any, data?: ListTargetedSentimentDetectionJobsCommandOutput) => void - ): Promise | void { - const command = new ListTargetedSentimentDetectionJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of the topic detection jobs that you have submitted.

- */ - public listTopicsDetectionJobs( + + /** + * @see {@link ListTopicsDetectionJobsCommand} + */ + listTopicsDetectionJobs( args: ListTopicsDetectionJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTopicsDetectionJobs( + listTopicsDetectionJobs( args: ListTopicsDetectionJobsCommandInput, cb: (err: any, data?: ListTopicsDetectionJobsCommandOutput) => void ): void; - public listTopicsDetectionJobs( + listTopicsDetectionJobs( args: ListTopicsDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTopicsDetectionJobsCommandOutput) => void ): void; - public listTopicsDetectionJobs( - args: ListTopicsDetectionJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTopicsDetectionJobsCommandOutput) => void), - cb?: (err: any, data?: ListTopicsDetectionJobsCommandOutput) => void - ): Promise | void { - const command = new ListTopicsDetectionJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attaches a resource-based policy to a custom model. You can use this policy to authorize - * an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon - * Comprehend in their account.

- */ - public putResourcePolicy( + + /** + * @see {@link PutResourcePolicyCommand} + */ + putResourcePolicy( args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( - args: PutResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: PutResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new PutResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts an asynchronous document classification job. Use the - * DescribeDocumentClassificationJob - * operation to track the progress of the job.

- */ - public startDocumentClassificationJob( + + /** + * @see {@link StartDocumentClassificationJobCommand} + */ + startDocumentClassificationJob( args: StartDocumentClassificationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDocumentClassificationJob( + startDocumentClassificationJob( args: StartDocumentClassificationJobCommandInput, cb: (err: any, data?: StartDocumentClassificationJobCommandOutput) => void ): void; - public startDocumentClassificationJob( + startDocumentClassificationJob( args: StartDocumentClassificationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDocumentClassificationJobCommandOutput) => void ): void; - public startDocumentClassificationJob( - args: StartDocumentClassificationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDocumentClassificationJobCommandOutput) => void), - cb?: (err: any, data?: StartDocumentClassificationJobCommandOutput) => void - ): Promise | void { - const command = new StartDocumentClassificationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts an asynchronous dominant language detection job for a collection of documents. Use - * the operation to track the status - * of a job.

- */ - public startDominantLanguageDetectionJob( + + /** + * @see {@link StartDominantLanguageDetectionJobCommand} + */ + startDominantLanguageDetectionJob( args: StartDominantLanguageDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDominantLanguageDetectionJob( + startDominantLanguageDetectionJob( args: StartDominantLanguageDetectionJobCommandInput, cb: (err: any, data?: StartDominantLanguageDetectionJobCommandOutput) => void ): void; - public startDominantLanguageDetectionJob( + startDominantLanguageDetectionJob( args: StartDominantLanguageDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDominantLanguageDetectionJobCommandOutput) => void ): void; - public startDominantLanguageDetectionJob( - args: StartDominantLanguageDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDominantLanguageDetectionJobCommandOutput) => void), - cb?: (err: any, data?: StartDominantLanguageDetectionJobCommandOutput) => void - ): Promise | void { - const command = new StartDominantLanguageDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.

- *

This API can be used for either standard entity detection or custom entity recognition. In - * order to be used for custom entity recognition, the optional EntityRecognizerArn - * must be used in order to provide access to the recognizer being used to detect the custom - * entity.

- */ - public startEntitiesDetectionJob( + + /** + * @see {@link StartEntitiesDetectionJobCommand} + */ + startEntitiesDetectionJob( args: StartEntitiesDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startEntitiesDetectionJob( + startEntitiesDetectionJob( args: StartEntitiesDetectionJobCommandInput, cb: (err: any, data?: StartEntitiesDetectionJobCommandOutput) => void ): void; - public startEntitiesDetectionJob( + startEntitiesDetectionJob( args: StartEntitiesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartEntitiesDetectionJobCommandOutput) => void ): void; - public startEntitiesDetectionJob( - args: StartEntitiesDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartEntitiesDetectionJobCommandOutput) => void), - cb?: (err: any, data?: StartEntitiesDetectionJobCommandOutput) => void - ): Promise | void { - const command = new StartEntitiesDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts an asynchronous event detection job for a collection of documents.

- */ - public startEventsDetectionJob( + + /** + * @see {@link StartEventsDetectionJobCommand} + */ + startEventsDetectionJob( args: StartEventsDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startEventsDetectionJob( + startEventsDetectionJob( args: StartEventsDetectionJobCommandInput, cb: (err: any, data?: StartEventsDetectionJobCommandOutput) => void ): void; - public startEventsDetectionJob( + startEventsDetectionJob( args: StartEventsDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartEventsDetectionJobCommandOutput) => void ): void; - public startEventsDetectionJob( - args: StartEventsDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartEventsDetectionJobCommandOutput) => void), - cb?: (err: any, data?: StartEventsDetectionJobCommandOutput) => void - ): Promise | void { - const command = new StartEventsDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Start the flywheel iteration.This operation uses any new datasets to train a new model version. - * For more information about flywheels, see - * Flywheel overview in the Amazon Comprehend Developer Guide.

- */ - public startFlywheelIteration( + + /** + * @see {@link StartFlywheelIterationCommand} + */ + startFlywheelIteration( args: StartFlywheelIterationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startFlywheelIteration( + startFlywheelIteration( args: StartFlywheelIterationCommandInput, cb: (err: any, data?: StartFlywheelIterationCommandOutput) => void ): void; - public startFlywheelIteration( + startFlywheelIteration( args: StartFlywheelIterationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFlywheelIterationCommandOutput) => void ): void; - public startFlywheelIteration( - args: StartFlywheelIterationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartFlywheelIterationCommandOutput) => void), - cb?: (err: any, data?: StartFlywheelIterationCommandOutput) => void - ): Promise | void { - const command = new StartFlywheelIterationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts an asynchronous key phrase detection job for a collection of documents. Use the - * operation to track the status of a - * job.

- */ - public startKeyPhrasesDetectionJob( + + /** + * @see {@link StartKeyPhrasesDetectionJobCommand} + */ + startKeyPhrasesDetectionJob( args: StartKeyPhrasesDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startKeyPhrasesDetectionJob( + startKeyPhrasesDetectionJob( args: StartKeyPhrasesDetectionJobCommandInput, cb: (err: any, data?: StartKeyPhrasesDetectionJobCommandOutput) => void ): void; - public startKeyPhrasesDetectionJob( + startKeyPhrasesDetectionJob( args: StartKeyPhrasesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartKeyPhrasesDetectionJobCommandOutput) => void ): void; - public startKeyPhrasesDetectionJob( - args: StartKeyPhrasesDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartKeyPhrasesDetectionJobCommandOutput) => void), - cb?: (err: any, data?: StartKeyPhrasesDetectionJobCommandOutput) => void - ): Promise | void { - const command = new StartKeyPhrasesDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts an asynchronous PII entity detection job for a collection of documents.

- */ - public startPiiEntitiesDetectionJob( + + /** + * @see {@link StartPiiEntitiesDetectionJobCommand} + */ + startPiiEntitiesDetectionJob( args: StartPiiEntitiesDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startPiiEntitiesDetectionJob( + startPiiEntitiesDetectionJob( args: StartPiiEntitiesDetectionJobCommandInput, cb: (err: any, data?: StartPiiEntitiesDetectionJobCommandOutput) => void ): void; - public startPiiEntitiesDetectionJob( + startPiiEntitiesDetectionJob( args: StartPiiEntitiesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartPiiEntitiesDetectionJobCommandOutput) => void ): void; - public startPiiEntitiesDetectionJob( - args: StartPiiEntitiesDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartPiiEntitiesDetectionJobCommandOutput) => void), - cb?: (err: any, data?: StartPiiEntitiesDetectionJobCommandOutput) => void - ): Promise | void { - const command = new StartPiiEntitiesDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts an asynchronous sentiment detection job for a collection of documents. Use the - * operation to track the status of a - * job.

- */ - public startSentimentDetectionJob( + + /** + * @see {@link StartSentimentDetectionJobCommand} + */ + startSentimentDetectionJob( args: StartSentimentDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startSentimentDetectionJob( + startSentimentDetectionJob( args: StartSentimentDetectionJobCommandInput, cb: (err: any, data?: StartSentimentDetectionJobCommandOutput) => void ): void; - public startSentimentDetectionJob( + startSentimentDetectionJob( args: StartSentimentDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSentimentDetectionJobCommandOutput) => void ): void; - public startSentimentDetectionJob( - args: StartSentimentDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartSentimentDetectionJobCommandOutput) => void), - cb?: (err: any, data?: StartSentimentDetectionJobCommandOutput) => void - ): Promise | void { - const command = new StartSentimentDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the - * DescribeTargetedSentimentDetectionJob operation to track the status of a - * job.

- */ - public startTargetedSentimentDetectionJob( + + /** + * @see {@link StartTargetedSentimentDetectionJobCommand} + */ + startTargetedSentimentDetectionJob( args: StartTargetedSentimentDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startTargetedSentimentDetectionJob( + startTargetedSentimentDetectionJob( args: StartTargetedSentimentDetectionJobCommandInput, cb: (err: any, data?: StartTargetedSentimentDetectionJobCommandOutput) => void ): void; - public startTargetedSentimentDetectionJob( + startTargetedSentimentDetectionJob( args: StartTargetedSentimentDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTargetedSentimentDetectionJobCommandOutput) => void ): void; - public startTargetedSentimentDetectionJob( - args: StartTargetedSentimentDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartTargetedSentimentDetectionJobCommandOutput) => void), - cb?: (err: any, data?: StartTargetedSentimentDetectionJobCommandOutput) => void - ): Promise | void { - const command = new StartTargetedSentimentDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts an asynchronous topic detection job. Use the - * DescribeTopicDetectionJob operation to track the status of a job.

- */ - public startTopicsDetectionJob( + + /** + * @see {@link StartTopicsDetectionJobCommand} + */ + startTopicsDetectionJob( args: StartTopicsDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startTopicsDetectionJob( + startTopicsDetectionJob( args: StartTopicsDetectionJobCommandInput, cb: (err: any, data?: StartTopicsDetectionJobCommandOutput) => void ): void; - public startTopicsDetectionJob( + startTopicsDetectionJob( args: StartTopicsDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTopicsDetectionJobCommandOutput) => void ): void; - public startTopicsDetectionJob( - args: StartTopicsDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartTopicsDetectionJobCommandOutput) => void), - cb?: (err: any, data?: StartTopicsDetectionJobCommandOutput) => void - ): Promise | void { - const command = new StartTopicsDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a dominant language detection job in progress.

- *

If the job state is IN_PROGRESS the job is marked for termination and put - * into the STOP_REQUESTED state. If the job completes before it can be stopped, it - * is put into the COMPLETED state; otherwise the job is stopped and put into the - * STOPPED state.

- *

If the job is in the COMPLETED or FAILED state when you call the - * StopDominantLanguageDetectionJob operation, the operation returns a 400 - * Internal Request Exception.

- *

When a job is stopped, any documents already processed are written to the output - * location.

- */ - public stopDominantLanguageDetectionJob( + + /** + * @see {@link StopDominantLanguageDetectionJobCommand} + */ + stopDominantLanguageDetectionJob( args: StopDominantLanguageDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopDominantLanguageDetectionJob( + stopDominantLanguageDetectionJob( args: StopDominantLanguageDetectionJobCommandInput, cb: (err: any, data?: StopDominantLanguageDetectionJobCommandOutput) => void ): void; - public stopDominantLanguageDetectionJob( + stopDominantLanguageDetectionJob( args: StopDominantLanguageDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDominantLanguageDetectionJobCommandOutput) => void ): void; - public stopDominantLanguageDetectionJob( - args: StopDominantLanguageDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopDominantLanguageDetectionJobCommandOutput) => void), - cb?: (err: any, data?: StopDominantLanguageDetectionJobCommandOutput) => void - ): Promise | void { - const command = new StopDominantLanguageDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops an entities detection job in progress.

- *

If the job state is IN_PROGRESS the job is marked for termination and put - * into the STOP_REQUESTED state. If the job completes before it can be stopped, it - * is put into the COMPLETED state; otherwise the job is stopped and put into the - * STOPPED state.

- *

If the job is in the COMPLETED or FAILED state when you call the - * StopDominantLanguageDetectionJob operation, the operation returns a 400 - * Internal Request Exception.

- *

When a job is stopped, any documents already processed are written to the output - * location.

- */ - public stopEntitiesDetectionJob( + + /** + * @see {@link StopEntitiesDetectionJobCommand} + */ + stopEntitiesDetectionJob( args: StopEntitiesDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopEntitiesDetectionJob( + stopEntitiesDetectionJob( args: StopEntitiesDetectionJobCommandInput, cb: (err: any, data?: StopEntitiesDetectionJobCommandOutput) => void ): void; - public stopEntitiesDetectionJob( + stopEntitiesDetectionJob( args: StopEntitiesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopEntitiesDetectionJobCommandOutput) => void ): void; - public stopEntitiesDetectionJob( - args: StopEntitiesDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopEntitiesDetectionJobCommandOutput) => void), - cb?: (err: any, data?: StopEntitiesDetectionJobCommandOutput) => void - ): Promise | void { - const command = new StopEntitiesDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops an events detection job in progress.

- */ - public stopEventsDetectionJob( + + /** + * @see {@link StopEventsDetectionJobCommand} + */ + stopEventsDetectionJob( args: StopEventsDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopEventsDetectionJob( + stopEventsDetectionJob( args: StopEventsDetectionJobCommandInput, cb: (err: any, data?: StopEventsDetectionJobCommandOutput) => void ): void; - public stopEventsDetectionJob( + stopEventsDetectionJob( args: StopEventsDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopEventsDetectionJobCommandOutput) => void ): void; - public stopEventsDetectionJob( - args: StopEventsDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopEventsDetectionJobCommandOutput) => void), - cb?: (err: any, data?: StopEventsDetectionJobCommandOutput) => void - ): Promise | void { - const command = new StopEventsDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a key phrases detection job in progress.

- *

If the job state is IN_PROGRESS the job is marked for termination and put - * into the STOP_REQUESTED state. If the job completes before it can be stopped, it - * is put into the COMPLETED state; otherwise the job is stopped and put into the - * STOPPED state.

- *

If the job is in the COMPLETED or FAILED state when you call the - * StopDominantLanguageDetectionJob operation, the operation returns a 400 - * Internal Request Exception.

- *

When a job is stopped, any documents already processed are written to the output - * location.

- */ - public stopKeyPhrasesDetectionJob( + + /** + * @see {@link StopKeyPhrasesDetectionJobCommand} + */ + stopKeyPhrasesDetectionJob( args: StopKeyPhrasesDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopKeyPhrasesDetectionJob( + stopKeyPhrasesDetectionJob( args: StopKeyPhrasesDetectionJobCommandInput, cb: (err: any, data?: StopKeyPhrasesDetectionJobCommandOutput) => void ): void; - public stopKeyPhrasesDetectionJob( + stopKeyPhrasesDetectionJob( args: StopKeyPhrasesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopKeyPhrasesDetectionJobCommandOutput) => void ): void; - public stopKeyPhrasesDetectionJob( - args: StopKeyPhrasesDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopKeyPhrasesDetectionJobCommandOutput) => void), - cb?: (err: any, data?: StopKeyPhrasesDetectionJobCommandOutput) => void - ): Promise | void { - const command = new StopKeyPhrasesDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a PII entities detection job in progress.

- */ - public stopPiiEntitiesDetectionJob( + + /** + * @see {@link StopPiiEntitiesDetectionJobCommand} + */ + stopPiiEntitiesDetectionJob( args: StopPiiEntitiesDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopPiiEntitiesDetectionJob( + stopPiiEntitiesDetectionJob( args: StopPiiEntitiesDetectionJobCommandInput, cb: (err: any, data?: StopPiiEntitiesDetectionJobCommandOutput) => void ): void; - public stopPiiEntitiesDetectionJob( + stopPiiEntitiesDetectionJob( args: StopPiiEntitiesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopPiiEntitiesDetectionJobCommandOutput) => void ): void; - public stopPiiEntitiesDetectionJob( - args: StopPiiEntitiesDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopPiiEntitiesDetectionJobCommandOutput) => void), - cb?: (err: any, data?: StopPiiEntitiesDetectionJobCommandOutput) => void - ): Promise | void { - const command = new StopPiiEntitiesDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a sentiment detection job in progress.

- *

If the job state is IN_PROGRESS, the job is marked for termination and put - * into the STOP_REQUESTED state. If the job completes before it can be stopped, it - * is put into the COMPLETED state; otherwise the job is be stopped and put into the - * STOPPED state.

- *

If the job is in the COMPLETED or FAILED state when you call the - * StopDominantLanguageDetectionJob operation, the operation returns a 400 - * Internal Request Exception.

- *

When a job is stopped, any documents already processed are written to the output - * location.

- */ - public stopSentimentDetectionJob( + + /** + * @see {@link StopSentimentDetectionJobCommand} + */ + stopSentimentDetectionJob( args: StopSentimentDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopSentimentDetectionJob( + stopSentimentDetectionJob( args: StopSentimentDetectionJobCommandInput, cb: (err: any, data?: StopSentimentDetectionJobCommandOutput) => void ): void; - public stopSentimentDetectionJob( + stopSentimentDetectionJob( args: StopSentimentDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopSentimentDetectionJobCommandOutput) => void ): void; - public stopSentimentDetectionJob( - args: StopSentimentDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopSentimentDetectionJobCommandOutput) => void), - cb?: (err: any, data?: StopSentimentDetectionJobCommandOutput) => void - ): Promise | void { - const command = new StopSentimentDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a targeted sentiment detection job in progress.

- *

If the job state is IN_PROGRESS, the job is marked for termination and put - * into the STOP_REQUESTED state. If the job completes before it can be stopped, it - * is put into the COMPLETED state; otherwise the job is be stopped and put into the - * STOPPED state.

- *

If the job is in the COMPLETED or FAILED state when you call the - * StopDominantLanguageDetectionJob operation, the operation returns a 400 - * Internal Request Exception.

- *

When a job is stopped, any documents already processed are written to the output - * location.

- */ - public stopTargetedSentimentDetectionJob( + + /** + * @see {@link StopTargetedSentimentDetectionJobCommand} + */ + stopTargetedSentimentDetectionJob( args: StopTargetedSentimentDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopTargetedSentimentDetectionJob( + stopTargetedSentimentDetectionJob( args: StopTargetedSentimentDetectionJobCommandInput, cb: (err: any, data?: StopTargetedSentimentDetectionJobCommandOutput) => void ): void; - public stopTargetedSentimentDetectionJob( + stopTargetedSentimentDetectionJob( args: StopTargetedSentimentDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopTargetedSentimentDetectionJobCommandOutput) => void ): void; - public stopTargetedSentimentDetectionJob( - args: StopTargetedSentimentDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopTargetedSentimentDetectionJobCommandOutput) => void), - cb?: (err: any, data?: StopTargetedSentimentDetectionJobCommandOutput) => void - ): Promise | void { - const command = new StopTargetedSentimentDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a document classifier training job while in progress.

- *

If the training job state is TRAINING, the job is marked for termination and - * put into the STOP_REQUESTED state. If the training job completes before it can be - * stopped, it is put into the TRAINED; otherwise the training job is stopped and - * put into the STOPPED state and the service sends back an HTTP 200 response with - * an empty HTTP body.

- */ - public stopTrainingDocumentClassifier( + + /** + * @see {@link StopTrainingDocumentClassifierCommand} + */ + stopTrainingDocumentClassifier( args: StopTrainingDocumentClassifierCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopTrainingDocumentClassifier( + stopTrainingDocumentClassifier( args: StopTrainingDocumentClassifierCommandInput, cb: (err: any, data?: StopTrainingDocumentClassifierCommandOutput) => void ): void; - public stopTrainingDocumentClassifier( + stopTrainingDocumentClassifier( args: StopTrainingDocumentClassifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopTrainingDocumentClassifierCommandOutput) => void ): void; - public stopTrainingDocumentClassifier( - args: StopTrainingDocumentClassifierCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopTrainingDocumentClassifierCommandOutput) => void), - cb?: (err: any, data?: StopTrainingDocumentClassifierCommandOutput) => void - ): Promise | void { - const command = new StopTrainingDocumentClassifierCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops an entity recognizer training job while in progress.

- *

If the training job state is TRAINING, the job is marked for termination and - * put into the STOP_REQUESTED state. If the training job completes before it can be - * stopped, it is put into the TRAINED; otherwise the training job is stopped and - * putted into the STOPPED state and the service sends back an HTTP 200 response - * with an empty HTTP body.

- */ - public stopTrainingEntityRecognizer( + + /** + * @see {@link StopTrainingEntityRecognizerCommand} + */ + stopTrainingEntityRecognizer( args: StopTrainingEntityRecognizerCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopTrainingEntityRecognizer( + stopTrainingEntityRecognizer( args: StopTrainingEntityRecognizerCommandInput, cb: (err: any, data?: StopTrainingEntityRecognizerCommandOutput) => void ): void; - public stopTrainingEntityRecognizer( + stopTrainingEntityRecognizer( args: StopTrainingEntityRecognizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopTrainingEntityRecognizerCommandOutput) => void ): void; - public stopTrainingEntityRecognizer( - args: StopTrainingEntityRecognizerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopTrainingEntityRecognizerCommandOutput) => void), - cb?: (err: any, data?: StopTrainingEntityRecognizerCommandOutput) => void - ): Promise | void { - const command = new StopTrainingEntityRecognizerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair - * that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with - * "Sales" as the key might be added to a resource to indicate its use by the sales department. - *

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a specific tag associated with an Amazon Comprehend resource.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates information about the specified endpoint. - * For information about endpoints, see Managing endpoints.

- */ - public updateEndpoint( + + /** + * @see {@link UpdateEndpointCommand} + */ + updateEndpoint( args: UpdateEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEndpoint( - args: UpdateEndpointCommandInput, - cb: (err: any, data?: UpdateEndpointCommandOutput) => void - ): void; - public updateEndpoint( + updateEndpoint(args: UpdateEndpointCommandInput, cb: (err: any, data?: UpdateEndpointCommandOutput) => void): void; + updateEndpoint( args: UpdateEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEndpointCommandOutput) => void ): void; - public updateEndpoint( - args: UpdateEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEndpointCommandOutput) => void), - cb?: (err: any, data?: UpdateEndpointCommandOutput) => void - ): Promise | void { - const command = new UpdateEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update the configuration information for an existing flywheel.

- */ - public updateFlywheel( + + /** + * @see {@link UpdateFlywheelCommand} + */ + updateFlywheel( args: UpdateFlywheelCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFlywheel( - args: UpdateFlywheelCommandInput, - cb: (err: any, data?: UpdateFlywheelCommandOutput) => void - ): void; - public updateFlywheel( + updateFlywheel(args: UpdateFlywheelCommandInput, cb: (err: any, data?: UpdateFlywheelCommandOutput) => void): void; + updateFlywheel( args: UpdateFlywheelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFlywheelCommandOutput) => void ): void; - public updateFlywheel( - args: UpdateFlywheelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFlywheelCommandOutput) => void), - cb?: (err: any, data?: UpdateFlywheelCommandOutput) => void - ): Promise | void { - const command = new UpdateFlywheelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Comprehend is an Amazon Web Services service for gaining insight into the content of documents. + * Use these actions to determine the topics contained in your documents, the topics they + * discuss, the predominant sentiment expressed in them, the predominant language used, and + * more.

+ */ +export class Comprehend extends ComprehendClient implements Comprehend {} +createAggregatedClient(commands, Comprehend); diff --git a/clients/client-comprehendmedical/src/ComprehendMedical.ts b/clients/client-comprehendmedical/src/ComprehendMedical.ts index 58f8879322b9..8a929b240a4f 100644 --- a/clients/client-comprehendmedical/src/ComprehendMedical.ts +++ b/clients/client-comprehendmedical/src/ComprehendMedical.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -123,895 +124,458 @@ import { StopSNOMEDCTInferenceJobCommandInput, StopSNOMEDCTInferenceJobCommandOutput, } from "./commands/StopSNOMEDCTInferenceJobCommand"; -import { ComprehendMedicalClient } from "./ComprehendMedicalClient"; +import { ComprehendMedicalClient, ComprehendMedicalClientConfig } from "./ComprehendMedicalClient"; -/** - * @public - *

Comprehend Medical; extracts structured information from unstructured clinical text. Use these actions - * to gain insight in your documents.

- */ -export class ComprehendMedical extends ComprehendMedicalClient { +const commands = { + DescribeEntitiesDetectionV2JobCommand, + DescribeICD10CMInferenceJobCommand, + DescribePHIDetectionJobCommand, + DescribeRxNormInferenceJobCommand, + DescribeSNOMEDCTInferenceJobCommand, + DetectEntitiesCommand, + DetectEntitiesV2Command, + DetectPHICommand, + InferICD10CMCommand, + InferRxNormCommand, + InferSNOMEDCTCommand, + ListEntitiesDetectionV2JobsCommand, + ListICD10CMInferenceJobsCommand, + ListPHIDetectionJobsCommand, + ListRxNormInferenceJobsCommand, + ListSNOMEDCTInferenceJobsCommand, + StartEntitiesDetectionV2JobCommand, + StartICD10CMInferenceJobCommand, + StartPHIDetectionJobCommand, + StartRxNormInferenceJobCommand, + StartSNOMEDCTInferenceJobCommand, + StopEntitiesDetectionV2JobCommand, + StopICD10CMInferenceJobCommand, + StopPHIDetectionJobCommand, + StopRxNormInferenceJobCommand, + StopSNOMEDCTInferenceJobCommand, +}; + +export interface ComprehendMedical { /** - * @public - *

Gets the properties associated with a medical entities detection job. Use this operation - * to get the status of a detection job.

+ * @see {@link DescribeEntitiesDetectionV2JobCommand} */ - public describeEntitiesDetectionV2Job( + describeEntitiesDetectionV2Job( args: DescribeEntitiesDetectionV2JobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEntitiesDetectionV2Job( + describeEntitiesDetectionV2Job( args: DescribeEntitiesDetectionV2JobCommandInput, cb: (err: any, data?: DescribeEntitiesDetectionV2JobCommandOutput) => void ): void; - public describeEntitiesDetectionV2Job( + describeEntitiesDetectionV2Job( args: DescribeEntitiesDetectionV2JobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEntitiesDetectionV2JobCommandOutput) => void ): void; - public describeEntitiesDetectionV2Job( - args: DescribeEntitiesDetectionV2JobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEntitiesDetectionV2JobCommandOutput) => void), - cb?: (err: any, data?: DescribeEntitiesDetectionV2JobCommandOutput) => void - ): Promise | void { - const command = new DescribeEntitiesDetectionV2JobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the properties associated with an InferICD10CM job. Use this operation to get the - * status of an inference job.

+ * @see {@link DescribeICD10CMInferenceJobCommand} */ - public describeICD10CMInferenceJob( + describeICD10CMInferenceJob( args: DescribeICD10CMInferenceJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeICD10CMInferenceJob( + describeICD10CMInferenceJob( args: DescribeICD10CMInferenceJobCommandInput, cb: (err: any, data?: DescribeICD10CMInferenceJobCommandOutput) => void ): void; - public describeICD10CMInferenceJob( + describeICD10CMInferenceJob( args: DescribeICD10CMInferenceJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeICD10CMInferenceJobCommandOutput) => void ): void; - public describeICD10CMInferenceJob( - args: DescribeICD10CMInferenceJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeICD10CMInferenceJobCommandOutput) => void), - cb?: (err: any, data?: DescribeICD10CMInferenceJobCommandOutput) => void - ): Promise | void { - const command = new DescribeICD10CMInferenceJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the properties associated with a protected health information (PHI) detection job. - * Use this operation to get the status of a detection job.

+ * @see {@link DescribePHIDetectionJobCommand} */ - public describePHIDetectionJob( + describePHIDetectionJob( args: DescribePHIDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePHIDetectionJob( + describePHIDetectionJob( args: DescribePHIDetectionJobCommandInput, cb: (err: any, data?: DescribePHIDetectionJobCommandOutput) => void ): void; - public describePHIDetectionJob( + describePHIDetectionJob( args: DescribePHIDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePHIDetectionJobCommandOutput) => void ): void; - public describePHIDetectionJob( - args: DescribePHIDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePHIDetectionJobCommandOutput) => void), - cb?: (err: any, data?: DescribePHIDetectionJobCommandOutput) => void - ): Promise | void { - const command = new DescribePHIDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the properties associated with an InferRxNorm job. Use this operation to get the - * status of an inference job.

+ * @see {@link DescribeRxNormInferenceJobCommand} */ - public describeRxNormInferenceJob( + describeRxNormInferenceJob( args: DescribeRxNormInferenceJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRxNormInferenceJob( + describeRxNormInferenceJob( args: DescribeRxNormInferenceJobCommandInput, cb: (err: any, data?: DescribeRxNormInferenceJobCommandOutput) => void ): void; - public describeRxNormInferenceJob( + describeRxNormInferenceJob( args: DescribeRxNormInferenceJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRxNormInferenceJobCommandOutput) => void ): void; - public describeRxNormInferenceJob( - args: DescribeRxNormInferenceJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRxNormInferenceJobCommandOutput) => void), - cb?: (err: any, data?: DescribeRxNormInferenceJobCommandOutput) => void - ): Promise | void { - const command = new DescribeRxNormInferenceJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Gets the properties associated with an InferSNOMEDCT job. Use this operation to get the status of an inference job. - *

+ * @see {@link DescribeSNOMEDCTInferenceJobCommand} */ - public describeSNOMEDCTInferenceJob( + describeSNOMEDCTInferenceJob( args: DescribeSNOMEDCTInferenceJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSNOMEDCTInferenceJob( + describeSNOMEDCTInferenceJob( args: DescribeSNOMEDCTInferenceJobCommandInput, cb: (err: any, data?: DescribeSNOMEDCTInferenceJobCommandOutput) => void ): void; - public describeSNOMEDCTInferenceJob( + describeSNOMEDCTInferenceJob( args: DescribeSNOMEDCTInferenceJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSNOMEDCTInferenceJobCommandOutput) => void ): void; - public describeSNOMEDCTInferenceJob( - args: DescribeSNOMEDCTInferenceJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSNOMEDCTInferenceJobCommandOutput) => void), - cb?: (err: any, data?: DescribeSNOMEDCTInferenceJobCommandOutput) => void - ): Promise | void { - const command = new DescribeSNOMEDCTInferenceJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

The DetectEntities operation is deprecated. You should use the DetectEntitiesV2 operation instead.

- *

Inspects the clinical text for a variety of medical entities and returns specific - * information about them such as entity category, location, and confidence score on that - * information .

+ * @see {@link DetectEntitiesCommand} */ - public detectEntities( + detectEntities( args: DetectEntitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public detectEntities( - args: DetectEntitiesCommandInput, - cb: (err: any, data?: DetectEntitiesCommandOutput) => void - ): void; - public detectEntities( + detectEntities(args: DetectEntitiesCommandInput, cb: (err: any, data?: DetectEntitiesCommandOutput) => void): void; + detectEntities( args: DetectEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectEntitiesCommandOutput) => void ): void; - public detectEntities( - args: DetectEntitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectEntitiesCommandOutput) => void), - cb?: (err: any, data?: DetectEntitiesCommandOutput) => void - ): Promise | void { - const command = new DetectEntitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Inspects the clinical text for a variety of medical entities and returns specific - * information about them such as entity category, location, and confidence score on that - * information. Amazon Comprehend Medical only detects medical entities in English language - * texts.

- *

The DetectEntitiesV2 operation replaces the DetectEntities - * operation. This new action uses a different model for determining the entities in your medical - * text and changes the way that some entities are returned in the output. You should use the - * DetectEntitiesV2 operation in all new applications.

- *

The DetectEntitiesV2 operation returns the Acuity and - * Direction entities as attributes instead of types.

+ * @see {@link DetectEntitiesV2Command} */ - public detectEntitiesV2( + detectEntitiesV2( args: DetectEntitiesV2CommandInput, options?: __HttpHandlerOptions ): Promise; - public detectEntitiesV2( + detectEntitiesV2( args: DetectEntitiesV2CommandInput, cb: (err: any, data?: DetectEntitiesV2CommandOutput) => void ): void; - public detectEntitiesV2( + detectEntitiesV2( args: DetectEntitiesV2CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectEntitiesV2CommandOutput) => void ): void; - public detectEntitiesV2( - args: DetectEntitiesV2CommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectEntitiesV2CommandOutput) => void), - cb?: (err: any, data?: DetectEntitiesV2CommandOutput) => void - ): Promise | void { - const command = new DetectEntitiesV2Command(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Inspects the clinical text for protected health information (PHI) entities and returns - * the entity category, location, and confidence score for each entity. Amazon Comprehend Medical - * only detects entities in English language texts.

+ * @see {@link DetectPHICommand} */ - public detectPHI(args: DetectPHICommandInput, options?: __HttpHandlerOptions): Promise; - public detectPHI(args: DetectPHICommandInput, cb: (err: any, data?: DetectPHICommandOutput) => void): void; - public detectPHI( + detectPHI(args: DetectPHICommandInput, options?: __HttpHandlerOptions): Promise; + detectPHI(args: DetectPHICommandInput, cb: (err: any, data?: DetectPHICommandOutput) => void): void; + detectPHI( args: DetectPHICommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectPHICommandOutput) => void ): void; - public detectPHI( - args: DetectPHICommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectPHICommandOutput) => void), - cb?: (err: any, data?: DetectPHICommandOutput) => void - ): Promise | void { - const command = new DetectPHICommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

InferICD10CM detects medical conditions as entities listed in a patient record and links - * those entities to normalized concept identifiers in the ICD-10-CM knowledge base from the - * Centers for Disease Control. Amazon Comprehend Medical only detects medical entities in - * English language texts.

+ * @see {@link InferICD10CMCommand} */ - public inferICD10CM( - args: InferICD10CMCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public inferICD10CM(args: InferICD10CMCommandInput, cb: (err: any, data?: InferICD10CMCommandOutput) => void): void; - public inferICD10CM( + inferICD10CM(args: InferICD10CMCommandInput, options?: __HttpHandlerOptions): Promise; + inferICD10CM(args: InferICD10CMCommandInput, cb: (err: any, data?: InferICD10CMCommandOutput) => void): void; + inferICD10CM( args: InferICD10CMCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InferICD10CMCommandOutput) => void ): void; - public inferICD10CM( - args: InferICD10CMCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InferICD10CMCommandOutput) => void), - cb?: (err: any, data?: InferICD10CMCommandOutput) => void - ): Promise | void { - const command = new InferICD10CMCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

InferRxNorm detects medications as entities listed in a patient record and links to the - * normalized concept identifiers in the RxNorm database from the National Library of Medicine. - * Amazon Comprehend Medical only detects medical entities in English language texts.

+ * @see {@link InferRxNormCommand} */ - public inferRxNorm(args: InferRxNormCommandInput, options?: __HttpHandlerOptions): Promise; - public inferRxNorm(args: InferRxNormCommandInput, cb: (err: any, data?: InferRxNormCommandOutput) => void): void; - public inferRxNorm( + inferRxNorm(args: InferRxNormCommandInput, options?: __HttpHandlerOptions): Promise; + inferRxNorm(args: InferRxNormCommandInput, cb: (err: any, data?: InferRxNormCommandOutput) => void): void; + inferRxNorm( args: InferRxNormCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InferRxNormCommandOutput) => void ): void; - public inferRxNorm( - args: InferRxNormCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InferRxNormCommandOutput) => void), - cb?: (err: any, data?: InferRxNormCommandOutput) => void - ): Promise | void { - const command = new InferRxNormCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology

+ * @see {@link InferSNOMEDCTCommand} */ - public inferSNOMEDCT( - args: InferSNOMEDCTCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public inferSNOMEDCT( - args: InferSNOMEDCTCommandInput, - cb: (err: any, data?: InferSNOMEDCTCommandOutput) => void - ): void; - public inferSNOMEDCT( + inferSNOMEDCT(args: InferSNOMEDCTCommandInput, options?: __HttpHandlerOptions): Promise; + inferSNOMEDCT(args: InferSNOMEDCTCommandInput, cb: (err: any, data?: InferSNOMEDCTCommandOutput) => void): void; + inferSNOMEDCT( args: InferSNOMEDCTCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InferSNOMEDCTCommandOutput) => void ): void; - public inferSNOMEDCT( - args: InferSNOMEDCTCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InferSNOMEDCTCommandOutput) => void), - cb?: (err: any, data?: InferSNOMEDCTCommandOutput) => void - ): Promise | void { - const command = new InferSNOMEDCTCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of medical entity detection jobs that you have submitted.

+ * @see {@link ListEntitiesDetectionV2JobsCommand} */ - public listEntitiesDetectionV2Jobs( + listEntitiesDetectionV2Jobs( args: ListEntitiesDetectionV2JobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEntitiesDetectionV2Jobs( + listEntitiesDetectionV2Jobs( args: ListEntitiesDetectionV2JobsCommandInput, cb: (err: any, data?: ListEntitiesDetectionV2JobsCommandOutput) => void ): void; - public listEntitiesDetectionV2Jobs( + listEntitiesDetectionV2Jobs( args: ListEntitiesDetectionV2JobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEntitiesDetectionV2JobsCommandOutput) => void ): void; - public listEntitiesDetectionV2Jobs( - args: ListEntitiesDetectionV2JobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEntitiesDetectionV2JobsCommandOutput) => void), - cb?: (err: any, data?: ListEntitiesDetectionV2JobsCommandOutput) => void - ): Promise | void { - const command = new ListEntitiesDetectionV2JobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of InferICD10CM jobs that you have submitted.

+ * @see {@link ListICD10CMInferenceJobsCommand} */ - public listICD10CMInferenceJobs( + listICD10CMInferenceJobs( args: ListICD10CMInferenceJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listICD10CMInferenceJobs( + listICD10CMInferenceJobs( args: ListICD10CMInferenceJobsCommandInput, cb: (err: any, data?: ListICD10CMInferenceJobsCommandOutput) => void ): void; - public listICD10CMInferenceJobs( + listICD10CMInferenceJobs( args: ListICD10CMInferenceJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListICD10CMInferenceJobsCommandOutput) => void ): void; - public listICD10CMInferenceJobs( - args: ListICD10CMInferenceJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListICD10CMInferenceJobsCommandOutput) => void), - cb?: (err: any, data?: ListICD10CMInferenceJobsCommandOutput) => void - ): Promise | void { - const command = new ListICD10CMInferenceJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of protected health information (PHI) detection jobs that you have - * submitted.

+ * @see {@link ListPHIDetectionJobsCommand} */ - public listPHIDetectionJobs( + listPHIDetectionJobs( args: ListPHIDetectionJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPHIDetectionJobs( + listPHIDetectionJobs( args: ListPHIDetectionJobsCommandInput, cb: (err: any, data?: ListPHIDetectionJobsCommandOutput) => void ): void; - public listPHIDetectionJobs( + listPHIDetectionJobs( args: ListPHIDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPHIDetectionJobsCommandOutput) => void ): void; - public listPHIDetectionJobs( - args: ListPHIDetectionJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPHIDetectionJobsCommandOutput) => void), - cb?: (err: any, data?: ListPHIDetectionJobsCommandOutput) => void - ): Promise | void { - const command = new ListPHIDetectionJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of InferRxNorm jobs that you have submitted.

+ * @see {@link ListRxNormInferenceJobsCommand} */ - public listRxNormInferenceJobs( + listRxNormInferenceJobs( args: ListRxNormInferenceJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRxNormInferenceJobs( + listRxNormInferenceJobs( args: ListRxNormInferenceJobsCommandInput, cb: (err: any, data?: ListRxNormInferenceJobsCommandOutput) => void ): void; - public listRxNormInferenceJobs( + listRxNormInferenceJobs( args: ListRxNormInferenceJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRxNormInferenceJobsCommandOutput) => void ): void; - public listRxNormInferenceJobs( - args: ListRxNormInferenceJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRxNormInferenceJobsCommandOutput) => void), - cb?: (err: any, data?: ListRxNormInferenceJobsCommandOutput) => void - ): Promise | void { - const command = new ListRxNormInferenceJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Gets a list of InferSNOMEDCT jobs a user has submitted. - *

+ * @see {@link ListSNOMEDCTInferenceJobsCommand} */ - public listSNOMEDCTInferenceJobs( + listSNOMEDCTInferenceJobs( args: ListSNOMEDCTInferenceJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSNOMEDCTInferenceJobs( + listSNOMEDCTInferenceJobs( args: ListSNOMEDCTInferenceJobsCommandInput, cb: (err: any, data?: ListSNOMEDCTInferenceJobsCommandOutput) => void ): void; - public listSNOMEDCTInferenceJobs( + listSNOMEDCTInferenceJobs( args: ListSNOMEDCTInferenceJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSNOMEDCTInferenceJobsCommandOutput) => void ): void; - public listSNOMEDCTInferenceJobs( - args: ListSNOMEDCTInferenceJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSNOMEDCTInferenceJobsCommandOutput) => void), - cb?: (err: any, data?: ListSNOMEDCTInferenceJobsCommandOutput) => void - ): Promise | void { - const command = new ListSNOMEDCTInferenceJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts an asynchronous medical entity detection job for a collection of documents. Use the - * DescribeEntitiesDetectionV2Job operation to track the status of a job.

+ * @see {@link StartEntitiesDetectionV2JobCommand} */ - public startEntitiesDetectionV2Job( + startEntitiesDetectionV2Job( args: StartEntitiesDetectionV2JobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startEntitiesDetectionV2Job( + startEntitiesDetectionV2Job( args: StartEntitiesDetectionV2JobCommandInput, cb: (err: any, data?: StartEntitiesDetectionV2JobCommandOutput) => void ): void; - public startEntitiesDetectionV2Job( + startEntitiesDetectionV2Job( args: StartEntitiesDetectionV2JobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartEntitiesDetectionV2JobCommandOutput) => void ): void; - public startEntitiesDetectionV2Job( - args: StartEntitiesDetectionV2JobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartEntitiesDetectionV2JobCommandOutput) => void), - cb?: (err: any, data?: StartEntitiesDetectionV2JobCommandOutput) => void - ): Promise | void { - const command = new StartEntitiesDetectionV2JobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM - * ontology. Use the DescribeICD10CMInferenceJob operation to track the status of a - * job.

+ * @see {@link StartICD10CMInferenceJobCommand} */ - public startICD10CMInferenceJob( + startICD10CMInferenceJob( args: StartICD10CMInferenceJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startICD10CMInferenceJob( + startICD10CMInferenceJob( args: StartICD10CMInferenceJobCommandInput, cb: (err: any, data?: StartICD10CMInferenceJobCommandOutput) => void ): void; - public startICD10CMInferenceJob( + startICD10CMInferenceJob( args: StartICD10CMInferenceJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartICD10CMInferenceJobCommandOutput) => void ): void; - public startICD10CMInferenceJob( - args: StartICD10CMInferenceJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartICD10CMInferenceJobCommandOutput) => void), - cb?: (err: any, data?: StartICD10CMInferenceJobCommandOutput) => void - ): Promise | void { - const command = new StartICD10CMInferenceJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts an asynchronous job to detect protected health information (PHI). Use the - * DescribePHIDetectionJob operation to track the status of a job.

+ * @see {@link StartPHIDetectionJobCommand} */ - public startPHIDetectionJob( + startPHIDetectionJob( args: StartPHIDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startPHIDetectionJob( + startPHIDetectionJob( args: StartPHIDetectionJobCommandInput, cb: (err: any, data?: StartPHIDetectionJobCommandOutput) => void ): void; - public startPHIDetectionJob( + startPHIDetectionJob( args: StartPHIDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartPHIDetectionJobCommandOutput) => void ): void; - public startPHIDetectionJob( - args: StartPHIDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartPHIDetectionJobCommandOutput) => void), - cb?: (err: any, data?: StartPHIDetectionJobCommandOutput) => void - ): Promise | void { - const command = new StartPHIDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts an asynchronous job to detect medication entities and link them to the RxNorm - * ontology. Use the DescribeRxNormInferenceJob operation to track the status of a - * job.

+ * @see {@link StartRxNormInferenceJobCommand} */ - public startRxNormInferenceJob( + startRxNormInferenceJob( args: StartRxNormInferenceJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startRxNormInferenceJob( + startRxNormInferenceJob( args: StartRxNormInferenceJobCommandInput, cb: (err: any, data?: StartRxNormInferenceJobCommandOutput) => void ): void; - public startRxNormInferenceJob( + startRxNormInferenceJob( args: StartRxNormInferenceJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartRxNormInferenceJobCommandOutput) => void ): void; - public startRxNormInferenceJob( - args: StartRxNormInferenceJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartRxNormInferenceJobCommandOutput) => void), - cb?: (err: any, data?: StartRxNormInferenceJobCommandOutput) => void - ): Promise | void { - const command = new StartRxNormInferenceJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology. Use the DescribeSNOMEDCTInferenceJob operation to track the status of a job. - *

+ * @see {@link StartSNOMEDCTInferenceJobCommand} */ - public startSNOMEDCTInferenceJob( + startSNOMEDCTInferenceJob( args: StartSNOMEDCTInferenceJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startSNOMEDCTInferenceJob( + startSNOMEDCTInferenceJob( args: StartSNOMEDCTInferenceJobCommandInput, cb: (err: any, data?: StartSNOMEDCTInferenceJobCommandOutput) => void ): void; - public startSNOMEDCTInferenceJob( + startSNOMEDCTInferenceJob( args: StartSNOMEDCTInferenceJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSNOMEDCTInferenceJobCommandOutput) => void ): void; - public startSNOMEDCTInferenceJob( - args: StartSNOMEDCTInferenceJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartSNOMEDCTInferenceJobCommandOutput) => void), - cb?: (err: any, data?: StartSNOMEDCTInferenceJobCommandOutput) => void - ): Promise | void { - const command = new StartSNOMEDCTInferenceJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops a medical entities detection job in progress.

+ * @see {@link StopEntitiesDetectionV2JobCommand} */ - public stopEntitiesDetectionV2Job( + stopEntitiesDetectionV2Job( args: StopEntitiesDetectionV2JobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopEntitiesDetectionV2Job( + stopEntitiesDetectionV2Job( args: StopEntitiesDetectionV2JobCommandInput, cb: (err: any, data?: StopEntitiesDetectionV2JobCommandOutput) => void ): void; - public stopEntitiesDetectionV2Job( + stopEntitiesDetectionV2Job( args: StopEntitiesDetectionV2JobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopEntitiesDetectionV2JobCommandOutput) => void ): void; - public stopEntitiesDetectionV2Job( - args: StopEntitiesDetectionV2JobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopEntitiesDetectionV2JobCommandOutput) => void), - cb?: (err: any, data?: StopEntitiesDetectionV2JobCommandOutput) => void - ): Promise | void { - const command = new StopEntitiesDetectionV2JobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops an InferICD10CM inference job in progress.

+ * @see {@link StopICD10CMInferenceJobCommand} */ - public stopICD10CMInferenceJob( + stopICD10CMInferenceJob( args: StopICD10CMInferenceJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopICD10CMInferenceJob( + stopICD10CMInferenceJob( args: StopICD10CMInferenceJobCommandInput, cb: (err: any, data?: StopICD10CMInferenceJobCommandOutput) => void ): void; - public stopICD10CMInferenceJob( + stopICD10CMInferenceJob( args: StopICD10CMInferenceJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopICD10CMInferenceJobCommandOutput) => void ): void; - public stopICD10CMInferenceJob( - args: StopICD10CMInferenceJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopICD10CMInferenceJobCommandOutput) => void), - cb?: (err: any, data?: StopICD10CMInferenceJobCommandOutput) => void - ): Promise | void { - const command = new StopICD10CMInferenceJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops a protected health information (PHI) detection job in progress.

+ * @see {@link StopPHIDetectionJobCommand} */ - public stopPHIDetectionJob( + stopPHIDetectionJob( args: StopPHIDetectionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopPHIDetectionJob( + stopPHIDetectionJob( args: StopPHIDetectionJobCommandInput, cb: (err: any, data?: StopPHIDetectionJobCommandOutput) => void ): void; - public stopPHIDetectionJob( + stopPHIDetectionJob( args: StopPHIDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopPHIDetectionJobCommandOutput) => void ): void; - public stopPHIDetectionJob( - args: StopPHIDetectionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopPHIDetectionJobCommandOutput) => void), - cb?: (err: any, data?: StopPHIDetectionJobCommandOutput) => void - ): Promise | void { - const command = new StopPHIDetectionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops an InferRxNorm inference job in progress.

+ * @see {@link StopRxNormInferenceJobCommand} */ - public stopRxNormInferenceJob( + stopRxNormInferenceJob( args: StopRxNormInferenceJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopRxNormInferenceJob( + stopRxNormInferenceJob( args: StopRxNormInferenceJobCommandInput, cb: (err: any, data?: StopRxNormInferenceJobCommandOutput) => void ): void; - public stopRxNormInferenceJob( + stopRxNormInferenceJob( args: StopRxNormInferenceJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopRxNormInferenceJobCommandOutput) => void ): void; - public stopRxNormInferenceJob( - args: StopRxNormInferenceJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopRxNormInferenceJobCommandOutput) => void), - cb?: (err: any, data?: StopRxNormInferenceJobCommandOutput) => void - ): Promise | void { - const command = new StopRxNormInferenceJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Stops an InferSNOMEDCT inference job in progress. - *

+ * @see {@link StopSNOMEDCTInferenceJobCommand} */ - public stopSNOMEDCTInferenceJob( + stopSNOMEDCTInferenceJob( args: StopSNOMEDCTInferenceJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopSNOMEDCTInferenceJob( + stopSNOMEDCTInferenceJob( args: StopSNOMEDCTInferenceJobCommandInput, cb: (err: any, data?: StopSNOMEDCTInferenceJobCommandOutput) => void ): void; - public stopSNOMEDCTInferenceJob( + stopSNOMEDCTInferenceJob( args: StopSNOMEDCTInferenceJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopSNOMEDCTInferenceJobCommandOutput) => void ): void; - public stopSNOMEDCTInferenceJob( - args: StopSNOMEDCTInferenceJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopSNOMEDCTInferenceJobCommandOutput) => void), - cb?: (err: any, data?: StopSNOMEDCTInferenceJobCommandOutput) => void - ): Promise | void { - const command = new StopSNOMEDCTInferenceJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Comprehend Medical; extracts structured information from unstructured clinical text. Use these actions + * to gain insight in your documents.

+ */ +export class ComprehendMedical extends ComprehendMedicalClient implements ComprehendMedical {} +createAggregatedClient(commands, ComprehendMedical); diff --git a/clients/client-compute-optimizer/src/ComputeOptimizer.ts b/clients/client-compute-optimizer/src/ComputeOptimizer.ts index f1a55dd48ceb..66f543381ba5 100644 --- a/clients/client-compute-optimizer/src/ComputeOptimizer.ts +++ b/clients/client-compute-optimizer/src/ComputeOptimizer.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -106,840 +107,405 @@ import { UpdateEnrollmentStatusCommandInput, UpdateEnrollmentStatusCommandOutput, } from "./commands/UpdateEnrollmentStatusCommand"; -import { ComputeOptimizerClient } from "./ComputeOptimizerClient"; +import { ComputeOptimizerClient, ComputeOptimizerClientConfig } from "./ComputeOptimizerClient"; -/** - * @public - *

Compute Optimizer is a service that analyzes the configuration and utilization - * metrics of your Amazon Web Services compute resources, such as Amazon EC2 - * instances, Amazon EC2 Auto Scaling groups, Lambda functions, Amazon EBS volumes, and Amazon ECS services on Fargate. - * It reports whether your resources are optimal, and generates - * optimization recommendations to reduce the cost and improve the performance of your - * workloads. Compute Optimizer also provides recent utilization metric data, in addition - * to projected utilization metric data for the recommendations, which you can use to - * evaluate which recommendation provides the best price-performance trade-off. The - * analysis of your usage patterns can help you decide when to move or resize your running - * resources, and still meet your performance and capacity requirements. For more - * information about Compute Optimizer, including the required permissions to use the - * service, see the Compute Optimizer User Guide.

- */ -export class ComputeOptimizer extends ComputeOptimizerClient { +const commands = { + DeleteRecommendationPreferencesCommand, + DescribeRecommendationExportJobsCommand, + ExportAutoScalingGroupRecommendationsCommand, + ExportEBSVolumeRecommendationsCommand, + ExportEC2InstanceRecommendationsCommand, + ExportECSServiceRecommendationsCommand, + ExportLambdaFunctionRecommendationsCommand, + GetAutoScalingGroupRecommendationsCommand, + GetEBSVolumeRecommendationsCommand, + GetEC2InstanceRecommendationsCommand, + GetEC2RecommendationProjectedMetricsCommand, + GetECSServiceRecommendationProjectedMetricsCommand, + GetECSServiceRecommendationsCommand, + GetEffectiveRecommendationPreferencesCommand, + GetEnrollmentStatusCommand, + GetEnrollmentStatusesForOrganizationCommand, + GetLambdaFunctionRecommendationsCommand, + GetRecommendationPreferencesCommand, + GetRecommendationSummariesCommand, + PutRecommendationPreferencesCommand, + UpdateEnrollmentStatusCommand, +}; + +export interface ComputeOptimizer { /** - * @public - *

Deletes a recommendation preference, such as enhanced infrastructure metrics.

- *

For more information, see Activating - * enhanced infrastructure metrics in the Compute Optimizer User - * Guide.

+ * @see {@link DeleteRecommendationPreferencesCommand} */ - public deleteRecommendationPreferences( + deleteRecommendationPreferences( args: DeleteRecommendationPreferencesCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRecommendationPreferences( + deleteRecommendationPreferences( args: DeleteRecommendationPreferencesCommandInput, cb: (err: any, data?: DeleteRecommendationPreferencesCommandOutput) => void ): void; - public deleteRecommendationPreferences( + deleteRecommendationPreferences( args: DeleteRecommendationPreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRecommendationPreferencesCommandOutput) => void ): void; - public deleteRecommendationPreferences( - args: DeleteRecommendationPreferencesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRecommendationPreferencesCommandOutput) => void), - cb?: (err: any, data?: DeleteRecommendationPreferencesCommandOutput) => void - ): Promise | void { - const command = new DeleteRecommendationPreferencesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes recommendation export jobs created in the last seven days.

- *

Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your - * recommendations. Then use the DescribeRecommendationExportJobs action - * to view your export jobs.

+ * @see {@link DescribeRecommendationExportJobsCommand} */ - public describeRecommendationExportJobs( + describeRecommendationExportJobs( args: DescribeRecommendationExportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRecommendationExportJobs( + describeRecommendationExportJobs( args: DescribeRecommendationExportJobsCommandInput, cb: (err: any, data?: DescribeRecommendationExportJobsCommandOutput) => void ): void; - public describeRecommendationExportJobs( + describeRecommendationExportJobs( args: DescribeRecommendationExportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRecommendationExportJobsCommandOutput) => void ): void; - public describeRecommendationExportJobs( - args: DescribeRecommendationExportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRecommendationExportJobsCommandOutput) => void), - cb?: (err: any, data?: DescribeRecommendationExportJobsCommandOutput) => void - ): Promise | void { - const command = new DescribeRecommendationExportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Exports optimization recommendations for Auto Scaling groups.

- *

Recommendations are exported in a comma-separated values (.csv) file, and its metadata - * in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting - * Recommendations in the Compute Optimizer User - * Guide.

- *

You can have only one Auto Scaling group export job in progress per Amazon Web Services Region.

+ * @see {@link ExportAutoScalingGroupRecommendationsCommand} */ - public exportAutoScalingGroupRecommendations( + exportAutoScalingGroupRecommendations( args: ExportAutoScalingGroupRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public exportAutoScalingGroupRecommendations( + exportAutoScalingGroupRecommendations( args: ExportAutoScalingGroupRecommendationsCommandInput, cb: (err: any, data?: ExportAutoScalingGroupRecommendationsCommandOutput) => void ): void; - public exportAutoScalingGroupRecommendations( + exportAutoScalingGroupRecommendations( args: ExportAutoScalingGroupRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportAutoScalingGroupRecommendationsCommandOutput) => void ): void; - public exportAutoScalingGroupRecommendations( - args: ExportAutoScalingGroupRecommendationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ExportAutoScalingGroupRecommendationsCommandOutput) => void), - cb?: (err: any, data?: ExportAutoScalingGroupRecommendationsCommandOutput) => void - ): Promise | void { - const command = new ExportAutoScalingGroupRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Exports optimization recommendations for Amazon EBS volumes.

- *

Recommendations are exported in a comma-separated values (.csv) file, and its metadata - * in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting - * Recommendations in the Compute Optimizer User - * Guide.

- *

You can have only one Amazon EBS volume export job in progress per Amazon Web Services Region.

+ * @see {@link ExportEBSVolumeRecommendationsCommand} */ - public exportEBSVolumeRecommendations( + exportEBSVolumeRecommendations( args: ExportEBSVolumeRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public exportEBSVolumeRecommendations( + exportEBSVolumeRecommendations( args: ExportEBSVolumeRecommendationsCommandInput, cb: (err: any, data?: ExportEBSVolumeRecommendationsCommandOutput) => void ): void; - public exportEBSVolumeRecommendations( + exportEBSVolumeRecommendations( args: ExportEBSVolumeRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportEBSVolumeRecommendationsCommandOutput) => void ): void; - public exportEBSVolumeRecommendations( - args: ExportEBSVolumeRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportEBSVolumeRecommendationsCommandOutput) => void), - cb?: (err: any, data?: ExportEBSVolumeRecommendationsCommandOutput) => void - ): Promise | void { - const command = new ExportEBSVolumeRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Exports optimization recommendations for Amazon EC2 instances.

- *

Recommendations are exported in a comma-separated values (.csv) file, and its metadata - * in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting - * Recommendations in the Compute Optimizer User - * Guide.

- *

You can have only one Amazon EC2 instance export job in progress per Amazon Web Services Region.

+ * @see {@link ExportEC2InstanceRecommendationsCommand} */ - public exportEC2InstanceRecommendations( + exportEC2InstanceRecommendations( args: ExportEC2InstanceRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public exportEC2InstanceRecommendations( + exportEC2InstanceRecommendations( args: ExportEC2InstanceRecommendationsCommandInput, cb: (err: any, data?: ExportEC2InstanceRecommendationsCommandOutput) => void ): void; - public exportEC2InstanceRecommendations( + exportEC2InstanceRecommendations( args: ExportEC2InstanceRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportEC2InstanceRecommendationsCommandOutput) => void ): void; - public exportEC2InstanceRecommendations( - args: ExportEC2InstanceRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportEC2InstanceRecommendationsCommandOutput) => void), - cb?: (err: any, data?: ExportEC2InstanceRecommendationsCommandOutput) => void - ): Promise | void { - const command = new ExportEC2InstanceRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Exports optimization recommendations for Amazon ECS services on Fargate. - *

- *

Recommendations are exported in a CSV file, and its metadata - * in a JSON file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting - * Recommendations in the Compute Optimizer User - * Guide.

- *

You can only have one Amazon ECS service export job in progress per Amazon Web Services Region.

+ * @see {@link ExportECSServiceRecommendationsCommand} */ - public exportECSServiceRecommendations( + exportECSServiceRecommendations( args: ExportECSServiceRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public exportECSServiceRecommendations( + exportECSServiceRecommendations( args: ExportECSServiceRecommendationsCommandInput, cb: (err: any, data?: ExportECSServiceRecommendationsCommandOutput) => void ): void; - public exportECSServiceRecommendations( + exportECSServiceRecommendations( args: ExportECSServiceRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportECSServiceRecommendationsCommandOutput) => void ): void; - public exportECSServiceRecommendations( - args: ExportECSServiceRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportECSServiceRecommendationsCommandOutput) => void), - cb?: (err: any, data?: ExportECSServiceRecommendationsCommandOutput) => void - ): Promise | void { - const command = new ExportECSServiceRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Exports optimization recommendations for Lambda functions.

- *

Recommendations are exported in a comma-separated values (.csv) file, and its metadata - * in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting - * Recommendations in the Compute Optimizer User - * Guide.

- *

You can have only one Lambda function export job in progress per Amazon Web Services Region.

+ * @see {@link ExportLambdaFunctionRecommendationsCommand} */ - public exportLambdaFunctionRecommendations( + exportLambdaFunctionRecommendations( args: ExportLambdaFunctionRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public exportLambdaFunctionRecommendations( + exportLambdaFunctionRecommendations( args: ExportLambdaFunctionRecommendationsCommandInput, cb: (err: any, data?: ExportLambdaFunctionRecommendationsCommandOutput) => void ): void; - public exportLambdaFunctionRecommendations( + exportLambdaFunctionRecommendations( args: ExportLambdaFunctionRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportLambdaFunctionRecommendationsCommandOutput) => void ): void; - public exportLambdaFunctionRecommendations( - args: ExportLambdaFunctionRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportLambdaFunctionRecommendationsCommandOutput) => void), - cb?: (err: any, data?: ExportLambdaFunctionRecommendationsCommandOutput) => void - ): Promise | void { - const command = new ExportLambdaFunctionRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns Auto Scaling group recommendations.

- *

Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that - * meet a specific set of requirements. For more information, see the Supported - * resources and requirements in the Compute Optimizer User - * Guide.

+ * @see {@link GetAutoScalingGroupRecommendationsCommand} */ - public getAutoScalingGroupRecommendations( + getAutoScalingGroupRecommendations( args: GetAutoScalingGroupRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAutoScalingGroupRecommendations( + getAutoScalingGroupRecommendations( args: GetAutoScalingGroupRecommendationsCommandInput, cb: (err: any, data?: GetAutoScalingGroupRecommendationsCommandOutput) => void ): void; - public getAutoScalingGroupRecommendations( + getAutoScalingGroupRecommendations( args: GetAutoScalingGroupRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAutoScalingGroupRecommendationsCommandOutput) => void ): void; - public getAutoScalingGroupRecommendations( - args: GetAutoScalingGroupRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAutoScalingGroupRecommendationsCommandOutput) => void), - cb?: (err: any, data?: GetAutoScalingGroupRecommendationsCommandOutput) => void - ): Promise | void { - const command = new GetAutoScalingGroupRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.

- *

Compute Optimizer generates recommendations for Amazon EBS volumes that - * meet a specific set of requirements. For more information, see the Supported - * resources and requirements in the Compute Optimizer User - * Guide.

+ * @see {@link GetEBSVolumeRecommendationsCommand} */ - public getEBSVolumeRecommendations( + getEBSVolumeRecommendations( args: GetEBSVolumeRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEBSVolumeRecommendations( + getEBSVolumeRecommendations( args: GetEBSVolumeRecommendationsCommandInput, cb: (err: any, data?: GetEBSVolumeRecommendationsCommandOutput) => void ): void; - public getEBSVolumeRecommendations( + getEBSVolumeRecommendations( args: GetEBSVolumeRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEBSVolumeRecommendationsCommandOutput) => void ): void; - public getEBSVolumeRecommendations( - args: GetEBSVolumeRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEBSVolumeRecommendationsCommandOutput) => void), - cb?: (err: any, data?: GetEBSVolumeRecommendationsCommandOutput) => void - ): Promise | void { - const command = new GetEBSVolumeRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns Amazon EC2 instance recommendations.

- *

Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of requirements. For more - * information, see the Supported resources and - * requirements in the Compute Optimizer User - * Guide.

+ * @see {@link GetEC2InstanceRecommendationsCommand} */ - public getEC2InstanceRecommendations( + getEC2InstanceRecommendations( args: GetEC2InstanceRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEC2InstanceRecommendations( + getEC2InstanceRecommendations( args: GetEC2InstanceRecommendationsCommandInput, cb: (err: any, data?: GetEC2InstanceRecommendationsCommandOutput) => void ): void; - public getEC2InstanceRecommendations( + getEC2InstanceRecommendations( args: GetEC2InstanceRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEC2InstanceRecommendationsCommandOutput) => void ): void; - public getEC2InstanceRecommendations( - args: GetEC2InstanceRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEC2InstanceRecommendationsCommandOutput) => void), - cb?: (err: any, data?: GetEC2InstanceRecommendationsCommandOutput) => void - ): Promise | void { - const command = new GetEC2InstanceRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the projected utilization metrics of Amazon EC2 instance - * recommendations.

- * - *

The Cpu and Memory metrics are the only projected - * utilization metrics returned when you run this action. Additionally, the - * Memory metric is returned only for resources that have the unified - * CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

- *
+ * @see {@link GetEC2RecommendationProjectedMetricsCommand} */ - public getEC2RecommendationProjectedMetrics( + getEC2RecommendationProjectedMetrics( args: GetEC2RecommendationProjectedMetricsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEC2RecommendationProjectedMetrics( + getEC2RecommendationProjectedMetrics( args: GetEC2RecommendationProjectedMetricsCommandInput, cb: (err: any, data?: GetEC2RecommendationProjectedMetricsCommandOutput) => void ): void; - public getEC2RecommendationProjectedMetrics( + getEC2RecommendationProjectedMetrics( args: GetEC2RecommendationProjectedMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEC2RecommendationProjectedMetricsCommandOutput) => void ): void; - public getEC2RecommendationProjectedMetrics( - args: GetEC2RecommendationProjectedMetricsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEC2RecommendationProjectedMetricsCommandOutput) => void), - cb?: (err: any, data?: GetEC2RecommendationProjectedMetricsCommandOutput) => void - ): Promise | void { - const command = new GetEC2RecommendationProjectedMetricsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns the projected metrics of Amazon ECS service recommendations. - *

+ * @see {@link GetECSServiceRecommendationProjectedMetricsCommand} */ - public getECSServiceRecommendationProjectedMetrics( + getECSServiceRecommendationProjectedMetrics( args: GetECSServiceRecommendationProjectedMetricsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getECSServiceRecommendationProjectedMetrics( + getECSServiceRecommendationProjectedMetrics( args: GetECSServiceRecommendationProjectedMetricsCommandInput, cb: (err: any, data?: GetECSServiceRecommendationProjectedMetricsCommandOutput) => void ): void; - public getECSServiceRecommendationProjectedMetrics( + getECSServiceRecommendationProjectedMetrics( args: GetECSServiceRecommendationProjectedMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetECSServiceRecommendationProjectedMetricsCommandOutput) => void ): void; - public getECSServiceRecommendationProjectedMetrics( - args: GetECSServiceRecommendationProjectedMetricsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetECSServiceRecommendationProjectedMetricsCommandOutput) => void), - cb?: (err: any, data?: GetECSServiceRecommendationProjectedMetricsCommandOutput) => void - ): Promise | void { - const command = new GetECSServiceRecommendationProjectedMetricsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns Amazon ECS service recommendations. - *

- *

- * Compute Optimizer generates recommendations for Amazon ECS services on - * Fargate that meet a specific set of requirements. For more - * information, see the Supported resources and - * requirements in the Compute Optimizer User - * Guide. - *

+ * @see {@link GetECSServiceRecommendationsCommand} */ - public getECSServiceRecommendations( + getECSServiceRecommendations( args: GetECSServiceRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getECSServiceRecommendations( + getECSServiceRecommendations( args: GetECSServiceRecommendationsCommandInput, cb: (err: any, data?: GetECSServiceRecommendationsCommandOutput) => void ): void; - public getECSServiceRecommendations( + getECSServiceRecommendations( args: GetECSServiceRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetECSServiceRecommendationsCommandOutput) => void ): void; - public getECSServiceRecommendations( - args: GetECSServiceRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetECSServiceRecommendationsCommandOutput) => void), - cb?: (err: any, data?: GetECSServiceRecommendationsCommandOutput) => void - ): Promise | void { - const command = new GetECSServiceRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the recommendation preferences that are in effect for a given resource, such - * as enhanced infrastructure metrics. Considers all applicable preferences that you might - * have set at the resource, account, and organization level.

- *

When you create a recommendation preference, you can set its status to - * Active or Inactive. Use this action to view the - * recommendation preferences that are in effect, or Active.

+ * @see {@link GetEffectiveRecommendationPreferencesCommand} */ - public getEffectiveRecommendationPreferences( + getEffectiveRecommendationPreferences( args: GetEffectiveRecommendationPreferencesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEffectiveRecommendationPreferences( + getEffectiveRecommendationPreferences( args: GetEffectiveRecommendationPreferencesCommandInput, cb: (err: any, data?: GetEffectiveRecommendationPreferencesCommandOutput) => void ): void; - public getEffectiveRecommendationPreferences( + getEffectiveRecommendationPreferences( args: GetEffectiveRecommendationPreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEffectiveRecommendationPreferencesCommandOutput) => void ): void; - public getEffectiveRecommendationPreferences( - args: GetEffectiveRecommendationPreferencesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetEffectiveRecommendationPreferencesCommandOutput) => void), - cb?: (err: any, data?: GetEffectiveRecommendationPreferencesCommandOutput) => void - ): Promise | void { - const command = new GetEffectiveRecommendationPreferencesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the enrollment (opt in) status of an account to the Compute Optimizer - * service.

- *

If the account is the management account of an organization, this action also confirms - * the enrollment status of member accounts of the organization. Use the GetEnrollmentStatusesForOrganization action to get detailed information - * about the enrollment status of member accounts of an organization.

+ * @see {@link GetEnrollmentStatusCommand} */ - public getEnrollmentStatus( + getEnrollmentStatus( args: GetEnrollmentStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEnrollmentStatus( + getEnrollmentStatus( args: GetEnrollmentStatusCommandInput, cb: (err: any, data?: GetEnrollmentStatusCommandOutput) => void ): void; - public getEnrollmentStatus( + getEnrollmentStatus( args: GetEnrollmentStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEnrollmentStatusCommandOutput) => void ): void; - public getEnrollmentStatus( - args: GetEnrollmentStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEnrollmentStatusCommandOutput) => void), - cb?: (err: any, data?: GetEnrollmentStatusCommandOutput) => void - ): Promise | void { - const command = new GetEnrollmentStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the Compute Optimizer enrollment (opt-in) status of organization member - * accounts, if your account is an organization management account.

- *

To get the enrollment status of standalone accounts, use the GetEnrollmentStatus action.

+ * @see {@link GetEnrollmentStatusesForOrganizationCommand} */ - public getEnrollmentStatusesForOrganization( + getEnrollmentStatusesForOrganization( args: GetEnrollmentStatusesForOrganizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEnrollmentStatusesForOrganization( + getEnrollmentStatusesForOrganization( args: GetEnrollmentStatusesForOrganizationCommandInput, cb: (err: any, data?: GetEnrollmentStatusesForOrganizationCommandOutput) => void ): void; - public getEnrollmentStatusesForOrganization( + getEnrollmentStatusesForOrganization( args: GetEnrollmentStatusesForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEnrollmentStatusesForOrganizationCommandOutput) => void ): void; - public getEnrollmentStatusesForOrganization( - args: GetEnrollmentStatusesForOrganizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEnrollmentStatusesForOrganizationCommandOutput) => void), - cb?: (err: any, data?: GetEnrollmentStatusesForOrganizationCommandOutput) => void - ): Promise | void { - const command = new GetEnrollmentStatusesForOrganizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns Lambda function recommendations.

- *

Compute Optimizer generates recommendations for functions that meet a specific set - * of requirements. For more information, see the Supported resources and - * requirements in the Compute Optimizer User - * Guide.

+ * @see {@link GetLambdaFunctionRecommendationsCommand} */ - public getLambdaFunctionRecommendations( + getLambdaFunctionRecommendations( args: GetLambdaFunctionRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLambdaFunctionRecommendations( + getLambdaFunctionRecommendations( args: GetLambdaFunctionRecommendationsCommandInput, cb: (err: any, data?: GetLambdaFunctionRecommendationsCommandOutput) => void ): void; - public getLambdaFunctionRecommendations( + getLambdaFunctionRecommendations( args: GetLambdaFunctionRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLambdaFunctionRecommendationsCommandOutput) => void ): void; - public getLambdaFunctionRecommendations( - args: GetLambdaFunctionRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLambdaFunctionRecommendationsCommandOutput) => void), - cb?: (err: any, data?: GetLambdaFunctionRecommendationsCommandOutput) => void - ): Promise | void { - const command = new GetLambdaFunctionRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns existing recommendation preferences, such as enhanced infrastructure - * metrics.

- *

Use the scope parameter to specify which preferences to return. You can - * specify to return preferences for an organization, a specific account ID, or a specific - * EC2 instance or Auto Scaling group Amazon Resource Name (ARN).

- *

For more information, see Activating - * enhanced infrastructure metrics in the Compute Optimizer User - * Guide.

+ * @see {@link GetRecommendationPreferencesCommand} */ - public getRecommendationPreferences( + getRecommendationPreferences( args: GetRecommendationPreferencesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRecommendationPreferences( + getRecommendationPreferences( args: GetRecommendationPreferencesCommandInput, cb: (err: any, data?: GetRecommendationPreferencesCommandOutput) => void ): void; - public getRecommendationPreferences( + getRecommendationPreferences( args: GetRecommendationPreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRecommendationPreferencesCommandOutput) => void ): void; - public getRecommendationPreferences( - args: GetRecommendationPreferencesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRecommendationPreferencesCommandOutput) => void), - cb?: (err: any, data?: GetRecommendationPreferencesCommandOutput) => void - ): Promise | void { - const command = new GetRecommendationPreferencesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the optimization findings for an account.

- *

It returns the number of:

- *
    - *
  • - *

    Amazon EC2 instances in an account that are - * Underprovisioned, Overprovisioned, or - * Optimized.

    - *
  • - *
  • - *

    Auto Scaling groups in an account that are NotOptimized, or - * Optimized.

    - *
  • - *
  • - *

    Amazon EBS volumes in an account that are NotOptimized, - * or Optimized.

    - *
  • - *
  • - *

    Lambda functions in an account that are NotOptimized, - * or Optimized.

    - *
  • - *
  • - *

    Amazon ECS services in an account that are Underprovisioned, - * Overprovisioned, or Optimized.

    - *
  • - *
+ * @see {@link GetRecommendationSummariesCommand} */ - public getRecommendationSummaries( + getRecommendationSummaries( args: GetRecommendationSummariesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRecommendationSummaries( + getRecommendationSummaries( args: GetRecommendationSummariesCommandInput, cb: (err: any, data?: GetRecommendationSummariesCommandOutput) => void ): void; - public getRecommendationSummaries( + getRecommendationSummaries( args: GetRecommendationSummariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRecommendationSummariesCommandOutput) => void ): void; - public getRecommendationSummaries( - args: GetRecommendationSummariesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRecommendationSummariesCommandOutput) => void), - cb?: (err: any, data?: GetRecommendationSummariesCommandOutput) => void - ): Promise | void { - const command = new GetRecommendationSummariesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new recommendation preference or updates an existing recommendation - * preference, such as enhanced infrastructure metrics.

- *

For more information, see Activating - * enhanced infrastructure metrics in the Compute Optimizer User - * Guide.

+ * @see {@link PutRecommendationPreferencesCommand} */ - public putRecommendationPreferences( + putRecommendationPreferences( args: PutRecommendationPreferencesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putRecommendationPreferences( + putRecommendationPreferences( args: PutRecommendationPreferencesCommandInput, cb: (err: any, data?: PutRecommendationPreferencesCommandOutput) => void ): void; - public putRecommendationPreferences( + putRecommendationPreferences( args: PutRecommendationPreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRecommendationPreferencesCommandOutput) => void ): void; - public putRecommendationPreferences( - args: PutRecommendationPreferencesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRecommendationPreferencesCommandOutput) => void), - cb?: (err: any, data?: PutRecommendationPreferencesCommandOutput) => void - ): Promise | void { - const command = new PutRecommendationPreferencesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the enrollment (opt in and opt out) status of an account to the Compute Optimizer service.

- *

If the account is a management account of an organization, this action can also be - * used to enroll member accounts of the organization.

- *

You must have the appropriate permissions to opt in to Compute Optimizer, to view its - * recommendations, and to opt out. For more information, see Controlling access with Amazon Web Services Identity and Access Management in the Compute Optimizer User Guide.

- *

When you opt in, Compute Optimizer automatically creates a service-linked role in your - * account to access its data. For more information, see Using - * Service-Linked Roles for Compute Optimizer in the Compute Optimizer User Guide.

+ * @see {@link UpdateEnrollmentStatusCommand} */ - public updateEnrollmentStatus( + updateEnrollmentStatus( args: UpdateEnrollmentStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEnrollmentStatus( + updateEnrollmentStatus( args: UpdateEnrollmentStatusCommandInput, cb: (err: any, data?: UpdateEnrollmentStatusCommandOutput) => void ): void; - public updateEnrollmentStatus( + updateEnrollmentStatus( args: UpdateEnrollmentStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEnrollmentStatusCommandOutput) => void ): void; - public updateEnrollmentStatus( - args: UpdateEnrollmentStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEnrollmentStatusCommandOutput) => void), - cb?: (err: any, data?: UpdateEnrollmentStatusCommandOutput) => void - ): Promise | void { - const command = new UpdateEnrollmentStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Compute Optimizer is a service that analyzes the configuration and utilization + * metrics of your Amazon Web Services compute resources, such as Amazon EC2 + * instances, Amazon EC2 Auto Scaling groups, Lambda functions, Amazon EBS volumes, and Amazon ECS services on Fargate. + * It reports whether your resources are optimal, and generates + * optimization recommendations to reduce the cost and improve the performance of your + * workloads. Compute Optimizer also provides recent utilization metric data, in addition + * to projected utilization metric data for the recommendations, which you can use to + * evaluate which recommendation provides the best price-performance trade-off. The + * analysis of your usage patterns can help you decide when to move or resize your running + * resources, and still meet your performance and capacity requirements. For more + * information about Compute Optimizer, including the required permissions to use the + * service, see the Compute Optimizer User Guide.

+ */ +export class ComputeOptimizer extends ComputeOptimizerClient implements ComputeOptimizer {} +createAggregatedClient(commands, ComputeOptimizer); diff --git a/clients/client-config-service/src/ConfigService.ts b/clients/client-config-service/src/ConfigService.ts index 4679e095ff27..154ad6a94803 100644 --- a/clients/client-config-service/src/ConfigService.ts +++ b/clients/client-config-service/src/ConfigService.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -457,3773 +458,1665 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; -import { ConfigServiceClient } from "./ConfigServiceClient"; +import { ConfigServiceClient, ConfigServiceClientConfig } from "./ConfigServiceClient"; -/** - * @public - * Config - *

Config provides a way to keep track of the configurations - * of all the Amazon Web Services resources associated with your Amazon Web Services account. You can - * use Config to get the current and historical configurations of - * each Amazon Web Services resource and also to get information about the relationship - * between the resources. An Amazon Web Services resource can be an Amazon Compute - * Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an - * elastic network Interface (ENI), or a security group. For a complete - * list of resources currently supported by Config, see Supported Amazon Web Services resources.

- *

You can access and manage Config through the Amazon Web Services Management - * Console, the Amazon Web Services Command Line Interface (Amazon Web Services CLI), the Config - * API, or the Amazon Web Services SDKs for Config. This reference guide contains - * documentation for the Config API and the Amazon Web Services CLI commands that - * you can use to manage Config. The Config API uses the - * Signature Version 4 protocol for signing requests. For more - * information about how to sign a request with this protocol, see - * Signature - * Version 4 Signing Process. For detailed information - * about Config features and their associated actions or commands, - * as well as how to work with Amazon Web Services Management Console, see What Is Config in the Config Developer - * Guide.

- */ -export class ConfigService extends ConfigServiceClient { +const commands = { + BatchGetAggregateResourceConfigCommand, + BatchGetResourceConfigCommand, + DeleteAggregationAuthorizationCommand, + DeleteConfigRuleCommand, + DeleteConfigurationAggregatorCommand, + DeleteConfigurationRecorderCommand, + DeleteConformancePackCommand, + DeleteDeliveryChannelCommand, + DeleteEvaluationResultsCommand, + DeleteOrganizationConfigRuleCommand, + DeleteOrganizationConformancePackCommand, + DeletePendingAggregationRequestCommand, + DeleteRemediationConfigurationCommand, + DeleteRemediationExceptionsCommand, + DeleteResourceConfigCommand, + DeleteRetentionConfigurationCommand, + DeleteStoredQueryCommand, + DeliverConfigSnapshotCommand, + DescribeAggregateComplianceByConfigRulesCommand, + DescribeAggregateComplianceByConformancePacksCommand, + DescribeAggregationAuthorizationsCommand, + DescribeComplianceByConfigRuleCommand, + DescribeComplianceByResourceCommand, + DescribeConfigRuleEvaluationStatusCommand, + DescribeConfigRulesCommand, + DescribeConfigurationAggregatorsCommand, + DescribeConfigurationAggregatorSourcesStatusCommand, + DescribeConfigurationRecordersCommand, + DescribeConfigurationRecorderStatusCommand, + DescribeConformancePackComplianceCommand, + DescribeConformancePacksCommand, + DescribeConformancePackStatusCommand, + DescribeDeliveryChannelsCommand, + DescribeDeliveryChannelStatusCommand, + DescribeOrganizationConfigRulesCommand, + DescribeOrganizationConfigRuleStatusesCommand, + DescribeOrganizationConformancePacksCommand, + DescribeOrganizationConformancePackStatusesCommand, + DescribePendingAggregationRequestsCommand, + DescribeRemediationConfigurationsCommand, + DescribeRemediationExceptionsCommand, + DescribeRemediationExecutionStatusCommand, + DescribeRetentionConfigurationsCommand, + GetAggregateComplianceDetailsByConfigRuleCommand, + GetAggregateConfigRuleComplianceSummaryCommand, + GetAggregateConformancePackComplianceSummaryCommand, + GetAggregateDiscoveredResourceCountsCommand, + GetAggregateResourceConfigCommand, + GetComplianceDetailsByConfigRuleCommand, + GetComplianceDetailsByResourceCommand, + GetComplianceSummaryByConfigRuleCommand, + GetComplianceSummaryByResourceTypeCommand, + GetConformancePackComplianceDetailsCommand, + GetConformancePackComplianceSummaryCommand, + GetCustomRulePolicyCommand, + GetDiscoveredResourceCountsCommand, + GetOrganizationConfigRuleDetailedStatusCommand, + GetOrganizationConformancePackDetailedStatusCommand, + GetOrganizationCustomRulePolicyCommand, + GetResourceConfigHistoryCommand, + GetResourceEvaluationSummaryCommand, + GetStoredQueryCommand, + ListAggregateDiscoveredResourcesCommand, + ListConformancePackComplianceScoresCommand, + ListDiscoveredResourcesCommand, + ListResourceEvaluationsCommand, + ListStoredQueriesCommand, + ListTagsForResourceCommand, + PutAggregationAuthorizationCommand, + PutConfigRuleCommand, + PutConfigurationAggregatorCommand, + PutConfigurationRecorderCommand, + PutConformancePackCommand, + PutDeliveryChannelCommand, + PutEvaluationsCommand, + PutExternalEvaluationCommand, + PutOrganizationConfigRuleCommand, + PutOrganizationConformancePackCommand, + PutRemediationConfigurationsCommand, + PutRemediationExceptionsCommand, + PutResourceConfigCommand, + PutRetentionConfigurationCommand, + PutStoredQueryCommand, + SelectAggregateResourceConfigCommand, + SelectResourceConfigCommand, + StartConfigRulesEvaluationCommand, + StartConfigurationRecorderCommand, + StartRemediationExecutionCommand, + StartResourceEvaluationCommand, + StopConfigurationRecorderCommand, + TagResourceCommand, + UntagResourceCommand, +}; + +export interface ConfigService { /** - * @public - *

Returns the current configuration items for resources that are present in your Config aggregator. The operation also returns a list of resources that are not processed in the current request. - * If there are no unprocessed resources, the operation returns an empty unprocessedResourceIdentifiers list.

- * - *
    - *
  • - *

    The API does not return results for deleted resources.

    - *
  • - *
  • - *

    The API does not return tags and relationships.

    - *
  • - *
- *
+ * @see {@link BatchGetAggregateResourceConfigCommand} */ - public batchGetAggregateResourceConfig( + batchGetAggregateResourceConfig( args: BatchGetAggregateResourceConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetAggregateResourceConfig( + batchGetAggregateResourceConfig( args: BatchGetAggregateResourceConfigCommandInput, cb: (err: any, data?: BatchGetAggregateResourceConfigCommandOutput) => void ): void; - public batchGetAggregateResourceConfig( + batchGetAggregateResourceConfig( args: BatchGetAggregateResourceConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetAggregateResourceConfigCommandOutput) => void ): void; - public batchGetAggregateResourceConfig( - args: BatchGetAggregateResourceConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetAggregateResourceConfigCommandOutput) => void), - cb?: (err: any, data?: BatchGetAggregateResourceConfigCommandOutput) => void - ): Promise | void { - const command = new BatchGetAggregateResourceConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the BaseConfigurationItem for one or more requested resources. - * The operation also returns a list of resources that are - * not processed in the current request. If there are no unprocessed - * resources, the operation returns an empty unprocessedResourceKeys - * list.

- * - *
    - *
  • - *

    The API does not return results for deleted - * resources.

    - *
  • - *
  • - *

    The API does not return any tags for the requested - * resources. This information is filtered out of the - * supplementaryConfiguration section of the API - * response.

    - *
  • - *
- *
+ * @see {@link BatchGetResourceConfigCommand} */ - public batchGetResourceConfig( + batchGetResourceConfig( args: BatchGetResourceConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetResourceConfig( + batchGetResourceConfig( args: BatchGetResourceConfigCommandInput, cb: (err: any, data?: BatchGetResourceConfigCommandOutput) => void ): void; - public batchGetResourceConfig( + batchGetResourceConfig( args: BatchGetResourceConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetResourceConfigCommandOutput) => void ): void; - public batchGetResourceConfig( - args: BatchGetResourceConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetResourceConfigCommandOutput) => void), - cb?: (err: any, data?: BatchGetResourceConfigCommandOutput) => void - ): Promise | void { - const command = new BatchGetResourceConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the authorization granted to the specified - * configuration aggregator account in a specified region.

+ * @see {@link DeleteAggregationAuthorizationCommand} */ - public deleteAggregationAuthorization( + deleteAggregationAuthorization( args: DeleteAggregationAuthorizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAggregationAuthorization( + deleteAggregationAuthorization( args: DeleteAggregationAuthorizationCommandInput, cb: (err: any, data?: DeleteAggregationAuthorizationCommandOutput) => void ): void; - public deleteAggregationAuthorization( + deleteAggregationAuthorization( args: DeleteAggregationAuthorizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAggregationAuthorizationCommandOutput) => void ): void; - public deleteAggregationAuthorization( - args: DeleteAggregationAuthorizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAggregationAuthorizationCommandOutput) => void), - cb?: (err: any, data?: DeleteAggregationAuthorizationCommandOutput) => void - ): Promise | void { - const command = new DeleteAggregationAuthorizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified Config rule and all of its evaluation - * results.

- *

Config sets the state of a rule to DELETING - * until the deletion is complete. You cannot update a rule while it is - * in this state. If you make a PutConfigRule or - * DeleteConfigRule request for the rule, you will - * receive a ResourceInUseException.

- *

You can check the state of a rule by using the - * DescribeConfigRules request.

+ * @see {@link DeleteConfigRuleCommand} */ - public deleteConfigRule( + deleteConfigRule( args: DeleteConfigRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConfigRule( + deleteConfigRule( args: DeleteConfigRuleCommandInput, cb: (err: any, data?: DeleteConfigRuleCommandOutput) => void ): void; - public deleteConfigRule( + deleteConfigRule( args: DeleteConfigRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigRuleCommandOutput) => void ): void; - public deleteConfigRule( - args: DeleteConfigRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConfigRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteConfigRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteConfigRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified configuration aggregator and the - * aggregated data associated with the aggregator.

+ * @see {@link DeleteConfigurationAggregatorCommand} */ - public deleteConfigurationAggregator( + deleteConfigurationAggregator( args: DeleteConfigurationAggregatorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConfigurationAggregator( + deleteConfigurationAggregator( args: DeleteConfigurationAggregatorCommandInput, cb: (err: any, data?: DeleteConfigurationAggregatorCommandOutput) => void ): void; - public deleteConfigurationAggregator( + deleteConfigurationAggregator( args: DeleteConfigurationAggregatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationAggregatorCommandOutput) => void ): void; - public deleteConfigurationAggregator( - args: DeleteConfigurationAggregatorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConfigurationAggregatorCommandOutput) => void), - cb?: (err: any, data?: DeleteConfigurationAggregatorCommandOutput) => void - ): Promise | void { - const command = new DeleteConfigurationAggregatorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the configuration recorder.

- *

After the configuration recorder is deleted, Config will - * not record resource configuration changes until you create a new - * configuration recorder.

- *

This action does not delete the configuration information that - * was previously recorded. You will be able to access the previously - * recorded information by using the - * GetResourceConfigHistory action, but you will not - * be able to access this information in the Config console until - * you create a new configuration recorder.

+ * @see {@link DeleteConfigurationRecorderCommand} */ - public deleteConfigurationRecorder( + deleteConfigurationRecorder( args: DeleteConfigurationRecorderCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConfigurationRecorder( + deleteConfigurationRecorder( args: DeleteConfigurationRecorderCommandInput, cb: (err: any, data?: DeleteConfigurationRecorderCommandOutput) => void ): void; - public deleteConfigurationRecorder( + deleteConfigurationRecorder( args: DeleteConfigurationRecorderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationRecorderCommandOutput) => void ): void; - public deleteConfigurationRecorder( - args: DeleteConfigurationRecorderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConfigurationRecorderCommandOutput) => void), - cb?: (err: any, data?: DeleteConfigurationRecorderCommandOutput) => void - ): Promise | void { - const command = new DeleteConfigurationRecorderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that - * conformance pack.

- *

Config sets the conformance pack to DELETE_IN_PROGRESS until the deletion is complete. - * You cannot update a conformance pack while it is in this state.

+ * @see {@link DeleteConformancePackCommand} */ - public deleteConformancePack( + deleteConformancePack( args: DeleteConformancePackCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConformancePack( + deleteConformancePack( args: DeleteConformancePackCommandInput, cb: (err: any, data?: DeleteConformancePackCommandOutput) => void ): void; - public deleteConformancePack( + deleteConformancePack( args: DeleteConformancePackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConformancePackCommandOutput) => void ): void; - public deleteConformancePack( - args: DeleteConformancePackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConformancePackCommandOutput) => void), - cb?: (err: any, data?: DeleteConformancePackCommandOutput) => void - ): Promise | void { - const command = new DeleteConformancePackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the delivery channel.

- *

Before you can delete the delivery channel, you must stop the - * configuration recorder by using the StopConfigurationRecorder action.

+ * @see {@link DeleteDeliveryChannelCommand} */ - public deleteDeliveryChannel( + deleteDeliveryChannel( args: DeleteDeliveryChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDeliveryChannel( + deleteDeliveryChannel( args: DeleteDeliveryChannelCommandInput, cb: (err: any, data?: DeleteDeliveryChannelCommandOutput) => void ): void; - public deleteDeliveryChannel( + deleteDeliveryChannel( args: DeleteDeliveryChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDeliveryChannelCommandOutput) => void ): void; - public deleteDeliveryChannel( - args: DeleteDeliveryChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDeliveryChannelCommandOutput) => void), - cb?: (err: any, data?: DeleteDeliveryChannelCommandOutput) => void - ): Promise | void { - const command = new DeleteDeliveryChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the evaluation results for the specified Config - * rule. You can specify one Config rule per request. After you - * delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating - * your Amazon Web Services resources against the rule.

+ * @see {@link DeleteEvaluationResultsCommand} */ - public deleteEvaluationResults( + deleteEvaluationResults( args: DeleteEvaluationResultsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEvaluationResults( + deleteEvaluationResults( args: DeleteEvaluationResultsCommandInput, cb: (err: any, data?: DeleteEvaluationResultsCommandOutput) => void ): void; - public deleteEvaluationResults( + deleteEvaluationResults( args: DeleteEvaluationResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEvaluationResultsCommandOutput) => void ): void; - public deleteEvaluationResults( - args: DeleteEvaluationResultsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEvaluationResultsCommandOutput) => void), - cb?: (err: any, data?: DeleteEvaluationResultsCommandOutput) => void - ): Promise | void { - const command = new DeleteEvaluationResultsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization.

- *

Only a management account and a delegated administrator account can delete an organization Config rule. - * When calling this API with a delegated administrator, you must ensure Organizations - * ListDelegatedAdministrator permissions are added.

- *

Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete. - * You cannot update a rule while it is in this state.

+ * @see {@link DeleteOrganizationConfigRuleCommand} */ - public deleteOrganizationConfigRule( + deleteOrganizationConfigRule( args: DeleteOrganizationConfigRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteOrganizationConfigRule( + deleteOrganizationConfigRule( args: DeleteOrganizationConfigRuleCommandInput, cb: (err: any, data?: DeleteOrganizationConfigRuleCommandOutput) => void ): void; - public deleteOrganizationConfigRule( + deleteOrganizationConfigRule( args: DeleteOrganizationConfigRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOrganizationConfigRuleCommandOutput) => void ): void; - public deleteOrganizationConfigRule( - args: DeleteOrganizationConfigRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteOrganizationConfigRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteOrganizationConfigRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteOrganizationConfigRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified organization conformance pack and all of the Config rules and remediation actions from - * all member accounts in that organization.

- *

Only a management account or a delegated administrator account can delete an organization conformance pack. - * When calling this API with a delegated administrator, you must ensure Organizations - * ListDelegatedAdministrator permissions are added.

- *

Config sets the state of a conformance pack to DELETE_IN_PROGRESS until the deletion is complete. - * You cannot update a conformance pack while it is in this state.

+ * @see {@link DeleteOrganizationConformancePackCommand} */ - public deleteOrganizationConformancePack( + deleteOrganizationConformancePack( args: DeleteOrganizationConformancePackCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteOrganizationConformancePack( + deleteOrganizationConformancePack( args: DeleteOrganizationConformancePackCommandInput, cb: (err: any, data?: DeleteOrganizationConformancePackCommandOutput) => void ): void; - public deleteOrganizationConformancePack( + deleteOrganizationConformancePack( args: DeleteOrganizationConformancePackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOrganizationConformancePackCommandOutput) => void ): void; - public deleteOrganizationConformancePack( - args: DeleteOrganizationConformancePackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteOrganizationConformancePackCommandOutput) => void), - cb?: (err: any, data?: DeleteOrganizationConformancePackCommandOutput) => void - ): Promise | void { - const command = new DeleteOrganizationConformancePackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes pending authorization requests for a specified - * aggregator account in a specified region.

+ * @see {@link DeletePendingAggregationRequestCommand} */ - public deletePendingAggregationRequest( + deletePendingAggregationRequest( args: DeletePendingAggregationRequestCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePendingAggregationRequest( + deletePendingAggregationRequest( args: DeletePendingAggregationRequestCommandInput, cb: (err: any, data?: DeletePendingAggregationRequestCommandOutput) => void ): void; - public deletePendingAggregationRequest( + deletePendingAggregationRequest( args: DeletePendingAggregationRequestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePendingAggregationRequestCommandOutput) => void ): void; - public deletePendingAggregationRequest( - args: DeletePendingAggregationRequestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePendingAggregationRequestCommandOutput) => void), - cb?: (err: any, data?: DeletePendingAggregationRequestCommandOutput) => void - ): Promise | void { - const command = new DeletePendingAggregationRequestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the remediation configuration.

+ * @see {@link DeleteRemediationConfigurationCommand} */ - public deleteRemediationConfiguration( + deleteRemediationConfiguration( args: DeleteRemediationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRemediationConfiguration( + deleteRemediationConfiguration( args: DeleteRemediationConfigurationCommandInput, cb: (err: any, data?: DeleteRemediationConfigurationCommandOutput) => void ): void; - public deleteRemediationConfiguration( + deleteRemediationConfiguration( args: DeleteRemediationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRemediationConfigurationCommandOutput) => void ): void; - public deleteRemediationConfiguration( - args: DeleteRemediationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRemediationConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteRemediationConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteRemediationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes one or more remediation exceptions mentioned in the resource keys.

- * - *

Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. - * Remediation exceptions blocks auto-remediation until the exception is cleared.

- *
+ * @see {@link DeleteRemediationExceptionsCommand} */ - public deleteRemediationExceptions( + deleteRemediationExceptions( args: DeleteRemediationExceptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRemediationExceptions( + deleteRemediationExceptions( args: DeleteRemediationExceptionsCommandInput, cb: (err: any, data?: DeleteRemediationExceptionsCommandOutput) => void ): void; - public deleteRemediationExceptions( + deleteRemediationExceptions( args: DeleteRemediationExceptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRemediationExceptionsCommandOutput) => void ): void; - public deleteRemediationExceptions( - args: DeleteRemediationExceptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRemediationExceptionsCommandOutput) => void), - cb?: (err: any, data?: DeleteRemediationExceptionsCommandOutput) => void - ): Promise | void { - const command = new DeleteRemediationExceptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Records the configuration state for a custom resource that has been deleted. This API records a new ConfigurationItem with a ResourceDeleted status. You can retrieve the ConfigurationItems recorded for this resource in your Config History. - *

+ * @see {@link DeleteResourceConfigCommand} */ - public deleteResourceConfig( + deleteResourceConfig( args: DeleteResourceConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourceConfig( + deleteResourceConfig( args: DeleteResourceConfigCommandInput, cb: (err: any, data?: DeleteResourceConfigCommandOutput) => void ): void; - public deleteResourceConfig( + deleteResourceConfig( args: DeleteResourceConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourceConfigCommandOutput) => void ): void; - public deleteResourceConfig( - args: DeleteResourceConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourceConfigCommandOutput) => void), - cb?: (err: any, data?: DeleteResourceConfigCommandOutput) => void - ): Promise | void { - const command = new DeleteResourceConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the retention configuration.

+ * @see {@link DeleteRetentionConfigurationCommand} */ - public deleteRetentionConfiguration( + deleteRetentionConfiguration( args: DeleteRetentionConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRetentionConfiguration( + deleteRetentionConfiguration( args: DeleteRetentionConfigurationCommandInput, cb: (err: any, data?: DeleteRetentionConfigurationCommandOutput) => void ): void; - public deleteRetentionConfiguration( + deleteRetentionConfiguration( args: DeleteRetentionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRetentionConfigurationCommandOutput) => void ): void; - public deleteRetentionConfiguration( - args: DeleteRetentionConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRetentionConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteRetentionConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteRetentionConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.

+ * @see {@link DeleteStoredQueryCommand} */ - public deleteStoredQuery( + deleteStoredQuery( args: DeleteStoredQueryCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteStoredQuery( + deleteStoredQuery( args: DeleteStoredQueryCommandInput, cb: (err: any, data?: DeleteStoredQueryCommandOutput) => void ): void; - public deleteStoredQuery( + deleteStoredQuery( args: DeleteStoredQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStoredQueryCommandOutput) => void ): void; - public deleteStoredQuery( - args: DeleteStoredQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStoredQueryCommandOutput) => void), - cb?: (err: any, data?: DeleteStoredQueryCommandOutput) => void - ): Promise | void { - const command = new DeleteStoredQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Schedules delivery of a configuration snapshot to the Amazon S3 - * bucket in the specified delivery channel. After the delivery has - * started, Config sends the following notifications using an - * Amazon SNS topic that you have specified.

- *
    - *
  • - *

    Notification of the start of the delivery.

    - *
  • - *
  • - *

    Notification of the completion of the delivery, if the - * delivery was successfully completed.

    - *
  • - *
  • - *

    Notification of delivery failure, if the delivery - * failed.

    - *
  • - *
+ * @see {@link DeliverConfigSnapshotCommand} */ - public deliverConfigSnapshot( + deliverConfigSnapshot( args: DeliverConfigSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public deliverConfigSnapshot( + deliverConfigSnapshot( args: DeliverConfigSnapshotCommandInput, cb: (err: any, data?: DeliverConfigSnapshotCommandOutput) => void ): void; - public deliverConfigSnapshot( + deliverConfigSnapshot( args: DeliverConfigSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeliverConfigSnapshotCommandOutput) => void ): void; - public deliverConfigSnapshot( - args: DeliverConfigSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeliverConfigSnapshotCommandOutput) => void), - cb?: (err: any, data?: DeliverConfigSnapshotCommandOutput) => void - ): Promise | void { - const command = new DeliverConfigSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of compliant and noncompliant rules with the - * number of resources for compliant and noncompliant rules. Does not display rules that do not have compliance results. - *

- * - *

The results can return an empty result page, but if you - * have a nextToken, the results are displayed on the next - * page.

- *
+ * @see {@link DescribeAggregateComplianceByConfigRulesCommand} */ - public describeAggregateComplianceByConfigRules( + describeAggregateComplianceByConfigRules( args: DescribeAggregateComplianceByConfigRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAggregateComplianceByConfigRules( + describeAggregateComplianceByConfigRules( args: DescribeAggregateComplianceByConfigRulesCommandInput, cb: (err: any, data?: DescribeAggregateComplianceByConfigRulesCommandOutput) => void ): void; - public describeAggregateComplianceByConfigRules( + describeAggregateComplianceByConfigRules( args: DescribeAggregateComplianceByConfigRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAggregateComplianceByConfigRulesCommandOutput) => void ): void; - public describeAggregateComplianceByConfigRules( - args: DescribeAggregateComplianceByConfigRulesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeAggregateComplianceByConfigRulesCommandOutput) => void), - cb?: (err: any, data?: DescribeAggregateComplianceByConfigRulesCommandOutput) => void - ): Promise | void { - const command = new DescribeAggregateComplianceByConfigRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each - * conformance pack. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.

- * - *

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

- *
+ * @see {@link DescribeAggregateComplianceByConformancePacksCommand} */ - public describeAggregateComplianceByConformancePacks( + describeAggregateComplianceByConformancePacks( args: DescribeAggregateComplianceByConformancePacksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAggregateComplianceByConformancePacks( + describeAggregateComplianceByConformancePacks( args: DescribeAggregateComplianceByConformancePacksCommandInput, cb: (err: any, data?: DescribeAggregateComplianceByConformancePacksCommandOutput) => void ): void; - public describeAggregateComplianceByConformancePacks( + describeAggregateComplianceByConformancePacks( args: DescribeAggregateComplianceByConformancePacksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAggregateComplianceByConformancePacksCommandOutput) => void ): void; - public describeAggregateComplianceByConformancePacks( - args: DescribeAggregateComplianceByConformancePacksCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeAggregateComplianceByConformancePacksCommandOutput) => void), - cb?: (err: any, data?: DescribeAggregateComplianceByConformancePacksCommandOutput) => void - ): Promise | void { - const command = new DescribeAggregateComplianceByConformancePacksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of authorizations granted to various aggregator - * accounts and regions.

+ * @see {@link DescribeAggregationAuthorizationsCommand} */ - public describeAggregationAuthorizations( + describeAggregationAuthorizations( args: DescribeAggregationAuthorizationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAggregationAuthorizations( + describeAggregationAuthorizations( args: DescribeAggregationAuthorizationsCommandInput, cb: (err: any, data?: DescribeAggregationAuthorizationsCommandOutput) => void ): void; - public describeAggregationAuthorizations( + describeAggregationAuthorizations( args: DescribeAggregationAuthorizationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAggregationAuthorizationsCommandOutput) => void ): void; - public describeAggregationAuthorizations( - args: DescribeAggregationAuthorizationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAggregationAuthorizationsCommandOutput) => void), - cb?: (err: any, data?: DescribeAggregationAuthorizationsCommandOutput) => void - ): Promise | void { - const command = new DescribeAggregationAuthorizationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Indicates whether the specified Config rules are compliant. - * If a rule is noncompliant, this action returns the number of Amazon Web Services - * resources that do not comply with the rule.

- *

A rule is compliant if all of the evaluated resources comply - * with it. It is noncompliant if any of these resources do not - * comply.

- *

If Config has no current evaluation results for the rule, - * it returns INSUFFICIENT_DATA. This result might - * indicate one of the following conditions:

- *
    - *
  • - *

    Config has never invoked an evaluation for the - * rule. To check whether it has, use the - * DescribeConfigRuleEvaluationStatus action - * to get the LastSuccessfulInvocationTime and - * LastFailedInvocationTime.

    - *
  • - *
  • - *

    The rule's Lambda function is failing to send - * evaluation results to Config. Verify that the role you - * assigned to your configuration recorder includes the - * config:PutEvaluations permission. If the - * rule is a custom rule, verify that the Lambda execution - * role includes the config:PutEvaluations - * permission.

    - *
  • - *
  • - *

    The rule's Lambda function has returned - * NOT_APPLICABLE for all evaluation results. - * This can occur if the resources were deleted or removed from - * the rule's scope.

    - *
  • - *
+ * @see {@link DescribeComplianceByConfigRuleCommand} */ - public describeComplianceByConfigRule( + describeComplianceByConfigRule( args: DescribeComplianceByConfigRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeComplianceByConfigRule( + describeComplianceByConfigRule( args: DescribeComplianceByConfigRuleCommandInput, cb: (err: any, data?: DescribeComplianceByConfigRuleCommandOutput) => void ): void; - public describeComplianceByConfigRule( + describeComplianceByConfigRule( args: DescribeComplianceByConfigRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeComplianceByConfigRuleCommandOutput) => void ): void; - public describeComplianceByConfigRule( - args: DescribeComplianceByConfigRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeComplianceByConfigRuleCommandOutput) => void), - cb?: (err: any, data?: DescribeComplianceByConfigRuleCommandOutput) => void - ): Promise | void { - const command = new DescribeComplianceByConfigRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Indicates whether the specified Amazon Web Services resources are compliant. If - * a resource is noncompliant, this action returns the number of Config rules that the resource does not comply with.

- *

A resource is compliant if it complies with all the Config - * rules that evaluate it. It is noncompliant if it does not comply - * with one or more of these rules.

- *

If Config has no current evaluation results for the - * resource, it returns INSUFFICIENT_DATA. This result - * might indicate one of the following conditions about the rules that - * evaluate the resource:

- *
    - *
  • - *

    Config has never invoked an evaluation for the - * rule. To check whether it has, use the - * DescribeConfigRuleEvaluationStatus action - * to get the LastSuccessfulInvocationTime and - * LastFailedInvocationTime.

    - *
  • - *
  • - *

    The rule's Lambda function is failing to send - * evaluation results to Config. Verify that the role that - * you assigned to your configuration recorder includes the - * config:PutEvaluations permission. If the - * rule is a custom rule, verify that the Lambda execution - * role includes the config:PutEvaluations - * permission.

    - *
  • - *
  • - *

    The rule's Lambda function has returned - * NOT_APPLICABLE for all evaluation results. - * This can occur if the resources were deleted or removed from - * the rule's scope.

    - *
  • - *
+ * @see {@link DescribeComplianceByResourceCommand} */ - public describeComplianceByResource( + describeComplianceByResource( args: DescribeComplianceByResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeComplianceByResource( + describeComplianceByResource( args: DescribeComplianceByResourceCommandInput, cb: (err: any, data?: DescribeComplianceByResourceCommandOutput) => void ): void; - public describeComplianceByResource( + describeComplianceByResource( args: DescribeComplianceByResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeComplianceByResourceCommandOutput) => void ): void; - public describeComplianceByResource( - args: DescribeComplianceByResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeComplianceByResourceCommandOutput) => void), - cb?: (err: any, data?: DescribeComplianceByResourceCommandOutput) => void - ): Promise | void { - const command = new DescribeComplianceByResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns status information for each of your Config managed rules. The status includes information such as the last time Config invoked the rule, the last time Config failed to invoke - * the rule, and the related error for the last failure.

+ * @see {@link DescribeConfigRuleEvaluationStatusCommand} */ - public describeConfigRuleEvaluationStatus( + describeConfigRuleEvaluationStatus( args: DescribeConfigRuleEvaluationStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConfigRuleEvaluationStatus( + describeConfigRuleEvaluationStatus( args: DescribeConfigRuleEvaluationStatusCommandInput, cb: (err: any, data?: DescribeConfigRuleEvaluationStatusCommandOutput) => void ): void; - public describeConfigRuleEvaluationStatus( + describeConfigRuleEvaluationStatus( args: DescribeConfigRuleEvaluationStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigRuleEvaluationStatusCommandOutput) => void ): void; - public describeConfigRuleEvaluationStatus( - args: DescribeConfigRuleEvaluationStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConfigRuleEvaluationStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeConfigRuleEvaluationStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeConfigRuleEvaluationStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns details about your Config rules.

+ * @see {@link DescribeConfigRulesCommand} */ - public describeConfigRules( + describeConfigRules( args: DescribeConfigRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConfigRules( + describeConfigRules( args: DescribeConfigRulesCommandInput, cb: (err: any, data?: DescribeConfigRulesCommandOutput) => void ): void; - public describeConfigRules( + describeConfigRules( args: DescribeConfigRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigRulesCommandOutput) => void ): void; - public describeConfigRules( - args: DescribeConfigRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConfigRulesCommandOutput) => void), - cb?: (err: any, data?: DescribeConfigRulesCommandOutput) => void - ): Promise | void { - const command = new DescribeConfigRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the details of one or more configuration aggregators. - * If the configuration aggregator is not specified, this action - * returns the details for all the configuration aggregators associated - * with the account.

+ * @see {@link DescribeConfigurationAggregatorsCommand} */ - public describeConfigurationAggregators( + describeConfigurationAggregators( args: DescribeConfigurationAggregatorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConfigurationAggregators( + describeConfigurationAggregators( args: DescribeConfigurationAggregatorsCommandInput, cb: (err: any, data?: DescribeConfigurationAggregatorsCommandOutput) => void ): void; - public describeConfigurationAggregators( + describeConfigurationAggregators( args: DescribeConfigurationAggregatorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigurationAggregatorsCommandOutput) => void ): void; - public describeConfigurationAggregators( - args: DescribeConfigurationAggregatorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConfigurationAggregatorsCommandOutput) => void), - cb?: (err: any, data?: DescribeConfigurationAggregatorsCommandOutput) => void - ): Promise | void { - const command = new DescribeConfigurationAggregatorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns status information for sources within an aggregator. - * The status includes information about the last time Config verified authorization between the source account and an aggregator account. In case of a failure, the status contains the related error code or message.

+ * @see {@link DescribeConfigurationAggregatorSourcesStatusCommand} */ - public describeConfigurationAggregatorSourcesStatus( + describeConfigurationAggregatorSourcesStatus( args: DescribeConfigurationAggregatorSourcesStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConfigurationAggregatorSourcesStatus( + describeConfigurationAggregatorSourcesStatus( args: DescribeConfigurationAggregatorSourcesStatusCommandInput, cb: (err: any, data?: DescribeConfigurationAggregatorSourcesStatusCommandOutput) => void ): void; - public describeConfigurationAggregatorSourcesStatus( + describeConfigurationAggregatorSourcesStatus( args: DescribeConfigurationAggregatorSourcesStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigurationAggregatorSourcesStatusCommandOutput) => void ): void; - public describeConfigurationAggregatorSourcesStatus( - args: DescribeConfigurationAggregatorSourcesStatusCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeConfigurationAggregatorSourcesStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeConfigurationAggregatorSourcesStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeConfigurationAggregatorSourcesStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the details for the specified configuration recorders. - * If the configuration recorder is not specified, this action returns - * the details for all configuration recorders associated with the - * account.

- * - *

Currently, you can specify only one configuration recorder - * per region in your account.

- *
+ * @see {@link DescribeConfigurationRecordersCommand} */ - public describeConfigurationRecorders( + describeConfigurationRecorders( args: DescribeConfigurationRecordersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConfigurationRecorders( + describeConfigurationRecorders( args: DescribeConfigurationRecordersCommandInput, cb: (err: any, data?: DescribeConfigurationRecordersCommandOutput) => void ): void; - public describeConfigurationRecorders( + describeConfigurationRecorders( args: DescribeConfigurationRecordersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigurationRecordersCommandOutput) => void ): void; - public describeConfigurationRecorders( - args: DescribeConfigurationRecordersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConfigurationRecordersCommandOutput) => void), - cb?: (err: any, data?: DescribeConfigurationRecordersCommandOutput) => void - ): Promise | void { - const command = new DescribeConfigurationRecordersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the current status of the specified configuration - * recorder as well as the status of the last recording event for the recorder. If a configuration recorder is not specified, this action - * returns the status of all configuration recorders associated with - * the account.

- * - *

Currently, you can specify only one configuration recorder - * per region in your account. For a detailed status of recording events over time, add your Config events to Amazon CloudWatch metrics and use CloudWatch metrics.

- *
+ * @see {@link DescribeConfigurationRecorderStatusCommand} */ - public describeConfigurationRecorderStatus( + describeConfigurationRecorderStatus( args: DescribeConfigurationRecorderStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConfigurationRecorderStatus( + describeConfigurationRecorderStatus( args: DescribeConfigurationRecorderStatusCommandInput, cb: (err: any, data?: DescribeConfigurationRecorderStatusCommandOutput) => void ): void; - public describeConfigurationRecorderStatus( + describeConfigurationRecorderStatus( args: DescribeConfigurationRecorderStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigurationRecorderStatusCommandOutput) => void ): void; - public describeConfigurationRecorderStatus( - args: DescribeConfigurationRecorderStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConfigurationRecorderStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeConfigurationRecorderStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeConfigurationRecorderStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns compliance details for each rule in that conformance pack.

- * - *

You must provide exact rule names.

- *
+ * @see {@link DescribeConformancePackComplianceCommand} */ - public describeConformancePackCompliance( + describeConformancePackCompliance( args: DescribeConformancePackComplianceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConformancePackCompliance( + describeConformancePackCompliance( args: DescribeConformancePackComplianceCommandInput, cb: (err: any, data?: DescribeConformancePackComplianceCommandOutput) => void ): void; - public describeConformancePackCompliance( + describeConformancePackCompliance( args: DescribeConformancePackComplianceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConformancePackComplianceCommandOutput) => void ): void; - public describeConformancePackCompliance( - args: DescribeConformancePackComplianceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConformancePackComplianceCommandOutput) => void), - cb?: (err: any, data?: DescribeConformancePackComplianceCommandOutput) => void - ): Promise | void { - const command = new DescribeConformancePackComplianceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of one or more conformance packs.

+ * @see {@link DescribeConformancePacksCommand} */ - public describeConformancePacks( + describeConformancePacks( args: DescribeConformancePacksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConformancePacks( + describeConformancePacks( args: DescribeConformancePacksCommandInput, cb: (err: any, data?: DescribeConformancePacksCommandOutput) => void ): void; - public describeConformancePacks( + describeConformancePacks( args: DescribeConformancePacksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConformancePacksCommandOutput) => void ): void; - public describeConformancePacks( - args: DescribeConformancePacksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConformancePacksCommandOutput) => void), - cb?: (err: any, data?: DescribeConformancePacksCommandOutput) => void - ): Promise | void { - const command = new DescribeConformancePacksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides one or more conformance packs deployment status.

- * - *

If there are no conformance packs then you will see an empty result.

- *
+ * @see {@link DescribeConformancePackStatusCommand} */ - public describeConformancePackStatus( + describeConformancePackStatus( args: DescribeConformancePackStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConformancePackStatus( + describeConformancePackStatus( args: DescribeConformancePackStatusCommandInput, cb: (err: any, data?: DescribeConformancePackStatusCommandOutput) => void ): void; - public describeConformancePackStatus( + describeConformancePackStatus( args: DescribeConformancePackStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConformancePackStatusCommandOutput) => void ): void; - public describeConformancePackStatus( - args: DescribeConformancePackStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConformancePackStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeConformancePackStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeConformancePackStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns details about the specified delivery channel. If a - * delivery channel is not specified, this action returns the details - * of all delivery channels associated with the account.

- * - *

Currently, you can specify only one delivery channel per - * region in your account.

- *
+ * @see {@link DescribeDeliveryChannelsCommand} */ - public describeDeliveryChannels( + describeDeliveryChannels( args: DescribeDeliveryChannelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDeliveryChannels( + describeDeliveryChannels( args: DescribeDeliveryChannelsCommandInput, cb: (err: any, data?: DescribeDeliveryChannelsCommandOutput) => void ): void; - public describeDeliveryChannels( + describeDeliveryChannels( args: DescribeDeliveryChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDeliveryChannelsCommandOutput) => void ): void; - public describeDeliveryChannels( - args: DescribeDeliveryChannelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDeliveryChannelsCommandOutput) => void), - cb?: (err: any, data?: DescribeDeliveryChannelsCommandOutput) => void - ): Promise | void { - const command = new DescribeDeliveryChannelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the current status of the specified delivery channel. - * If a delivery channel is not specified, this action returns the - * current status of all delivery channels associated with the - * account.

- * - *

Currently, you can specify only one delivery channel per - * region in your account.

- *
+ * @see {@link DescribeDeliveryChannelStatusCommand} */ - public describeDeliveryChannelStatus( + describeDeliveryChannelStatus( args: DescribeDeliveryChannelStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDeliveryChannelStatus( + describeDeliveryChannelStatus( args: DescribeDeliveryChannelStatusCommandInput, cb: (err: any, data?: DescribeDeliveryChannelStatusCommandOutput) => void ): void; - public describeDeliveryChannelStatus( + describeDeliveryChannelStatus( args: DescribeDeliveryChannelStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDeliveryChannelStatusCommandOutput) => void ): void; - public describeDeliveryChannelStatus( - args: DescribeDeliveryChannelStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDeliveryChannelStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeDeliveryChannelStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeDeliveryChannelStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of organization Config rules.

- * - *

When you specify the limit and the next token, you receive a paginated response.

- *

Limit and next token are not applicable if you specify organization Config rule names. - * It is only applicable, when you request all the organization Config rules.

- *

- * For accounts within an organzation - *

- *

If you deploy an organizational rule or conformance pack in an organization - * administrator account, and then establish a delegated administrator and deploy an - * organizational rule or conformance pack in the delegated administrator account, you - * won't be able to see the organizational rule or conformance pack in the organization - * administrator account from the delegated administrator account or see the organizational - * rule or conformance pack in the delegated administrator account from organization - * administrator account. The DescribeOrganizationConfigRules and - * DescribeOrganizationConformancePacks APIs can only see and interact with - * the organization-related resource that were deployed from within the account calling - * those APIs.

- *
+ * @see {@link DescribeOrganizationConfigRulesCommand} */ - public describeOrganizationConfigRules( + describeOrganizationConfigRules( args: DescribeOrganizationConfigRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOrganizationConfigRules( + describeOrganizationConfigRules( args: DescribeOrganizationConfigRulesCommandInput, cb: (err: any, data?: DescribeOrganizationConfigRulesCommandOutput) => void ): void; - public describeOrganizationConfigRules( + describeOrganizationConfigRules( args: DescribeOrganizationConfigRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrganizationConfigRulesCommandOutput) => void ): void; - public describeOrganizationConfigRules( - args: DescribeOrganizationConfigRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOrganizationConfigRulesCommandOutput) => void), - cb?: (err: any, data?: DescribeOrganizationConfigRulesCommandOutput) => void - ): Promise | void { - const command = new DescribeOrganizationConfigRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides organization Config rule deployment status for an organization.

- * - *

The status is not considered successful until organization Config rule is successfully deployed in all the member - * accounts with an exception of excluded accounts.

- *

When you specify the limit and the next token, you receive a paginated response. - * Limit and next token are not applicable if you specify organization Config rule names. - * It is only applicable, when you request all the organization Config rules.

- *
+ * @see {@link DescribeOrganizationConfigRuleStatusesCommand} */ - public describeOrganizationConfigRuleStatuses( + describeOrganizationConfigRuleStatuses( args: DescribeOrganizationConfigRuleStatusesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOrganizationConfigRuleStatuses( + describeOrganizationConfigRuleStatuses( args: DescribeOrganizationConfigRuleStatusesCommandInput, cb: (err: any, data?: DescribeOrganizationConfigRuleStatusesCommandOutput) => void ): void; - public describeOrganizationConfigRuleStatuses( + describeOrganizationConfigRuleStatuses( args: DescribeOrganizationConfigRuleStatusesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrganizationConfigRuleStatusesCommandOutput) => void ): void; - public describeOrganizationConfigRuleStatuses( - args: DescribeOrganizationConfigRuleStatusesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeOrganizationConfigRuleStatusesCommandOutput) => void), - cb?: (err: any, data?: DescribeOrganizationConfigRuleStatusesCommandOutput) => void - ): Promise | void { - const command = new DescribeOrganizationConfigRuleStatusesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of organization conformance packs.

- * - *

When you specify the limit and the next token, you receive a paginated response.

- *

Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable, - * when you request all the organization conformance packs.

- *

- * For accounts within an organzation - *

- *

If you deploy an organizational rule or conformance pack in an organization - * administrator account, and then establish a delegated administrator and deploy an - * organizational rule or conformance pack in the delegated administrator account, you - * won't be able to see the organizational rule or conformance pack in the organization - * administrator account from the delegated administrator account or see the organizational - * rule or conformance pack in the delegated administrator account from organization - * administrator account. The DescribeOrganizationConfigRules and - * DescribeOrganizationConformancePacks APIs can only see and interact with - * the organization-related resource that were deployed from within the account calling - * those APIs.

- *
+ * @see {@link DescribeOrganizationConformancePacksCommand} */ - public describeOrganizationConformancePacks( + describeOrganizationConformancePacks( args: DescribeOrganizationConformancePacksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOrganizationConformancePacks( + describeOrganizationConformancePacks( args: DescribeOrganizationConformancePacksCommandInput, cb: (err: any, data?: DescribeOrganizationConformancePacksCommandOutput) => void ): void; - public describeOrganizationConformancePacks( + describeOrganizationConformancePacks( args: DescribeOrganizationConformancePacksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrganizationConformancePacksCommandOutput) => void ): void; - public describeOrganizationConformancePacks( - args: DescribeOrganizationConformancePacksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOrganizationConformancePacksCommandOutput) => void), - cb?: (err: any, data?: DescribeOrganizationConformancePacksCommandOutput) => void - ): Promise | void { - const command = new DescribeOrganizationConformancePacksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides organization conformance pack deployment status for an organization.

- * - *

The status is not considered successful until organization conformance pack is successfully - * deployed in all the member accounts with an exception of excluded accounts.

- *

When you specify the limit and the next token, you receive a paginated response. - * Limit and next token are not applicable if you specify organization conformance pack names. - * They are only applicable, when you request all the organization conformance packs.

- *
+ * @see {@link DescribeOrganizationConformancePackStatusesCommand} */ - public describeOrganizationConformancePackStatuses( + describeOrganizationConformancePackStatuses( args: DescribeOrganizationConformancePackStatusesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOrganizationConformancePackStatuses( + describeOrganizationConformancePackStatuses( args: DescribeOrganizationConformancePackStatusesCommandInput, cb: (err: any, data?: DescribeOrganizationConformancePackStatusesCommandOutput) => void ): void; - public describeOrganizationConformancePackStatuses( + describeOrganizationConformancePackStatuses( args: DescribeOrganizationConformancePackStatusesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrganizationConformancePackStatusesCommandOutput) => void ): void; - public describeOrganizationConformancePackStatuses( - args: DescribeOrganizationConformancePackStatusesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeOrganizationConformancePackStatusesCommandOutput) => void), - cb?: (err: any, data?: DescribeOrganizationConformancePackStatusesCommandOutput) => void - ): Promise | void { - const command = new DescribeOrganizationConformancePackStatusesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all pending aggregation requests.

+ * @see {@link DescribePendingAggregationRequestsCommand} */ - public describePendingAggregationRequests( + describePendingAggregationRequests( args: DescribePendingAggregationRequestsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePendingAggregationRequests( + describePendingAggregationRequests( args: DescribePendingAggregationRequestsCommandInput, cb: (err: any, data?: DescribePendingAggregationRequestsCommandOutput) => void ): void; - public describePendingAggregationRequests( + describePendingAggregationRequests( args: DescribePendingAggregationRequestsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePendingAggregationRequestsCommandOutput) => void ): void; - public describePendingAggregationRequests( - args: DescribePendingAggregationRequestsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePendingAggregationRequestsCommandOutput) => void), - cb?: (err: any, data?: DescribePendingAggregationRequestsCommandOutput) => void - ): Promise | void { - const command = new DescribePendingAggregationRequestsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the details of one or more remediation configurations.

+ * @see {@link DescribeRemediationConfigurationsCommand} */ - public describeRemediationConfigurations( + describeRemediationConfigurations( args: DescribeRemediationConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRemediationConfigurations( + describeRemediationConfigurations( args: DescribeRemediationConfigurationsCommandInput, cb: (err: any, data?: DescribeRemediationConfigurationsCommandOutput) => void ): void; - public describeRemediationConfigurations( + describeRemediationConfigurations( args: DescribeRemediationConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRemediationConfigurationsCommandOutput) => void ): void; - public describeRemediationConfigurations( - args: DescribeRemediationConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRemediationConfigurationsCommandOutput) => void), - cb?: (err: any, data?: DescribeRemediationConfigurationsCommandOutput) => void - ): Promise | void { - const command = new DescribeRemediationConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the details of one or more remediation exceptions. A detailed view of a remediation exception for a set of resources that includes an explanation of an exception and the time when the exception will be deleted. - * When you specify the limit and the next token, you receive a paginated response.

- * - *

Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. - * Remediation exceptions blocks auto-remediation until the exception is cleared.

- *

When you specify the limit and the next token, you receive a paginated response.

- *

Limit and next token are not applicable if you request resources in batch. It is only applicable, when you request all resources.

- *
+ * @see {@link DescribeRemediationExceptionsCommand} */ - public describeRemediationExceptions( + describeRemediationExceptions( args: DescribeRemediationExceptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRemediationExceptions( + describeRemediationExceptions( args: DescribeRemediationExceptionsCommandInput, cb: (err: any, data?: DescribeRemediationExceptionsCommandOutput) => void ): void; - public describeRemediationExceptions( + describeRemediationExceptions( args: DescribeRemediationExceptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRemediationExceptionsCommandOutput) => void ): void; - public describeRemediationExceptions( - args: DescribeRemediationExceptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRemediationExceptionsCommandOutput) => void), - cb?: (err: any, data?: DescribeRemediationExceptionsCommandOutput) => void - ): Promise | void { - const command = new DescribeRemediationExceptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed. - * When you specify the limit and the next token, you receive a paginated response.

+ * @see {@link DescribeRemediationExecutionStatusCommand} */ - public describeRemediationExecutionStatus( + describeRemediationExecutionStatus( args: DescribeRemediationExecutionStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRemediationExecutionStatus( + describeRemediationExecutionStatus( args: DescribeRemediationExecutionStatusCommandInput, cb: (err: any, data?: DescribeRemediationExecutionStatusCommandOutput) => void ): void; - public describeRemediationExecutionStatus( + describeRemediationExecutionStatus( args: DescribeRemediationExecutionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRemediationExecutionStatusCommandOutput) => void ): void; - public describeRemediationExecutionStatus( - args: DescribeRemediationExecutionStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRemediationExecutionStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeRemediationExecutionStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeRemediationExecutionStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the details of one or more retention configurations. If - * the retention configuration name is not specified, this action - * returns the details for all the retention configurations for that - * account.

- * - *

Currently, Config supports only one retention - * configuration per region in your account.

- *
+ * @see {@link DescribeRetentionConfigurationsCommand} */ - public describeRetentionConfigurations( + describeRetentionConfigurations( args: DescribeRetentionConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRetentionConfigurations( + describeRetentionConfigurations( args: DescribeRetentionConfigurationsCommandInput, cb: (err: any, data?: DescribeRetentionConfigurationsCommandOutput) => void ): void; - public describeRetentionConfigurations( + describeRetentionConfigurations( args: DescribeRetentionConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRetentionConfigurationsCommandOutput) => void ): void; - public describeRetentionConfigurations( - args: DescribeRetentionConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRetentionConfigurationsCommandOutput) => void), - cb?: (err: any, data?: DescribeRetentionConfigurationsCommandOutput) => void - ): Promise | void { - const command = new DescribeRetentionConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the evaluation results for the specified Config - * rule for a specific resource in a rule. The results indicate which - * Amazon Web Services resources were evaluated by the rule, when each resource was - * last evaluated, and whether each resource complies with the rule.

- * - *

The results can return an empty result page. But if you - * have a nextToken, the results are displayed on the next - * page.

- *
+ * @see {@link GetAggregateComplianceDetailsByConfigRuleCommand} */ - public getAggregateComplianceDetailsByConfigRule( + getAggregateComplianceDetailsByConfigRule( args: GetAggregateComplianceDetailsByConfigRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAggregateComplianceDetailsByConfigRule( + getAggregateComplianceDetailsByConfigRule( args: GetAggregateComplianceDetailsByConfigRuleCommandInput, cb: (err: any, data?: GetAggregateComplianceDetailsByConfigRuleCommandOutput) => void ): void; - public getAggregateComplianceDetailsByConfigRule( + getAggregateComplianceDetailsByConfigRule( args: GetAggregateComplianceDetailsByConfigRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAggregateComplianceDetailsByConfigRuleCommandOutput) => void ): void; - public getAggregateComplianceDetailsByConfigRule( - args: GetAggregateComplianceDetailsByConfigRuleCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetAggregateComplianceDetailsByConfigRuleCommandOutput) => void), - cb?: (err: any, data?: GetAggregateComplianceDetailsByConfigRuleCommandOutput) => void - ): Promise | void { - const command = new GetAggregateComplianceDetailsByConfigRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the number of compliant and noncompliant rules for one - * or more accounts and regions in an aggregator.

- * - *

The results can return an empty result page, but if you - * have a nextToken, the results are displayed on the next - * page.

- *
+ * @see {@link GetAggregateConfigRuleComplianceSummaryCommand} */ - public getAggregateConfigRuleComplianceSummary( + getAggregateConfigRuleComplianceSummary( args: GetAggregateConfigRuleComplianceSummaryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAggregateConfigRuleComplianceSummary( + getAggregateConfigRuleComplianceSummary( args: GetAggregateConfigRuleComplianceSummaryCommandInput, cb: (err: any, data?: GetAggregateConfigRuleComplianceSummaryCommandOutput) => void ): void; - public getAggregateConfigRuleComplianceSummary( + getAggregateConfigRuleComplianceSummary( args: GetAggregateConfigRuleComplianceSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAggregateConfigRuleComplianceSummaryCommandOutput) => void ): void; - public getAggregateConfigRuleComplianceSummary( - args: GetAggregateConfigRuleComplianceSummaryCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetAggregateConfigRuleComplianceSummaryCommandOutput) => void), - cb?: (err: any, data?: GetAggregateConfigRuleComplianceSummaryCommandOutput) => void - ): Promise | void { - const command = new GetAggregateConfigRuleComplianceSummaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator. You can filter based on Amazon Web Services account ID or Amazon Web Services Region.

- * - *

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

- *
+ * @see {@link GetAggregateConformancePackComplianceSummaryCommand} */ - public getAggregateConformancePackComplianceSummary( + getAggregateConformancePackComplianceSummary( args: GetAggregateConformancePackComplianceSummaryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAggregateConformancePackComplianceSummary( + getAggregateConformancePackComplianceSummary( args: GetAggregateConformancePackComplianceSummaryCommandInput, cb: (err: any, data?: GetAggregateConformancePackComplianceSummaryCommandOutput) => void ): void; - public getAggregateConformancePackComplianceSummary( + getAggregateConformancePackComplianceSummary( args: GetAggregateConformancePackComplianceSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAggregateConformancePackComplianceSummaryCommandOutput) => void ): void; - public getAggregateConformancePackComplianceSummary( - args: GetAggregateConformancePackComplianceSummaryCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetAggregateConformancePackComplianceSummaryCommandOutput) => void), - cb?: (err: any, data?: GetAggregateConformancePackComplianceSummaryCommandOutput) => void - ): Promise | void { - const command = new GetAggregateConformancePackComplianceSummaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the resource counts across accounts and regions that are present in your Config aggregator. You can request the resource counts by providing filters and GroupByKey.

- *

For example, if the input contains accountID 12345678910 and region us-east-1 in filters, the API returns the count of resources in account ID 12345678910 and region us-east-1. - * If the input contains ACCOUNT_ID as a GroupByKey, the API returns resource counts for all source accounts that are present in your aggregator.

+ * @see {@link GetAggregateDiscoveredResourceCountsCommand} */ - public getAggregateDiscoveredResourceCounts( + getAggregateDiscoveredResourceCounts( args: GetAggregateDiscoveredResourceCountsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAggregateDiscoveredResourceCounts( + getAggregateDiscoveredResourceCounts( args: GetAggregateDiscoveredResourceCountsCommandInput, cb: (err: any, data?: GetAggregateDiscoveredResourceCountsCommandOutput) => void ): void; - public getAggregateDiscoveredResourceCounts( + getAggregateDiscoveredResourceCounts( args: GetAggregateDiscoveredResourceCountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAggregateDiscoveredResourceCountsCommandOutput) => void ): void; - public getAggregateDiscoveredResourceCounts( - args: GetAggregateDiscoveredResourceCountsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAggregateDiscoveredResourceCountsCommandOutput) => void), - cb?: (err: any, data?: GetAggregateDiscoveredResourceCountsCommandOutput) => void - ): Promise | void { - const command = new GetAggregateDiscoveredResourceCountsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns configuration item that is aggregated for your specific resource in a specific source account and region.

+ * @see {@link GetAggregateResourceConfigCommand} */ - public getAggregateResourceConfig( + getAggregateResourceConfig( args: GetAggregateResourceConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAggregateResourceConfig( + getAggregateResourceConfig( args: GetAggregateResourceConfigCommandInput, cb: (err: any, data?: GetAggregateResourceConfigCommandOutput) => void ): void; - public getAggregateResourceConfig( + getAggregateResourceConfig( args: GetAggregateResourceConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAggregateResourceConfigCommandOutput) => void ): void; - public getAggregateResourceConfig( - args: GetAggregateResourceConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAggregateResourceConfigCommandOutput) => void), - cb?: (err: any, data?: GetAggregateResourceConfigCommandOutput) => void - ): Promise | void { - const command = new GetAggregateResourceConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the evaluation results for the specified Config - * rule. The results indicate which Amazon Web Services resources were evaluated by the - * rule, when each resource was last evaluated, and whether each - * resource complies with the rule.

+ * @see {@link GetComplianceDetailsByConfigRuleCommand} */ - public getComplianceDetailsByConfigRule( + getComplianceDetailsByConfigRule( args: GetComplianceDetailsByConfigRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public getComplianceDetailsByConfigRule( + getComplianceDetailsByConfigRule( args: GetComplianceDetailsByConfigRuleCommandInput, cb: (err: any, data?: GetComplianceDetailsByConfigRuleCommandOutput) => void ): void; - public getComplianceDetailsByConfigRule( + getComplianceDetailsByConfigRule( args: GetComplianceDetailsByConfigRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComplianceDetailsByConfigRuleCommandOutput) => void ): void; - public getComplianceDetailsByConfigRule( - args: GetComplianceDetailsByConfigRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetComplianceDetailsByConfigRuleCommandOutput) => void), - cb?: (err: any, data?: GetComplianceDetailsByConfigRuleCommandOutput) => void - ): Promise | void { - const command = new GetComplianceDetailsByConfigRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the evaluation results for the specified Amazon Web Services resource. - * The results indicate which Config rules were used to evaluate - * the resource, when each rule was last invoked, and whether the resource - * complies with each rule.

+ * @see {@link GetComplianceDetailsByResourceCommand} */ - public getComplianceDetailsByResource( + getComplianceDetailsByResource( args: GetComplianceDetailsByResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public getComplianceDetailsByResource( + getComplianceDetailsByResource( args: GetComplianceDetailsByResourceCommandInput, cb: (err: any, data?: GetComplianceDetailsByResourceCommandOutput) => void ): void; - public getComplianceDetailsByResource( + getComplianceDetailsByResource( args: GetComplianceDetailsByResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComplianceDetailsByResourceCommandOutput) => void ): void; - public getComplianceDetailsByResource( - args: GetComplianceDetailsByResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetComplianceDetailsByResourceCommandOutput) => void), - cb?: (err: any, data?: GetComplianceDetailsByResourceCommandOutput) => void - ): Promise | void { - const command = new GetComplianceDetailsByResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the number of Config rules that are compliant and - * noncompliant, up to a maximum of 25 for each.

+ * @see {@link GetComplianceSummaryByConfigRuleCommand} */ - public getComplianceSummaryByConfigRule( + getComplianceSummaryByConfigRule( args: GetComplianceSummaryByConfigRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public getComplianceSummaryByConfigRule( + getComplianceSummaryByConfigRule( args: GetComplianceSummaryByConfigRuleCommandInput, cb: (err: any, data?: GetComplianceSummaryByConfigRuleCommandOutput) => void ): void; - public getComplianceSummaryByConfigRule( + getComplianceSummaryByConfigRule( args: GetComplianceSummaryByConfigRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComplianceSummaryByConfigRuleCommandOutput) => void ): void; - public getComplianceSummaryByConfigRule( - args: GetComplianceSummaryByConfigRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetComplianceSummaryByConfigRuleCommandOutput) => void), - cb?: (err: any, data?: GetComplianceSummaryByConfigRuleCommandOutput) => void - ): Promise | void { - const command = new GetComplianceSummaryByConfigRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the number of resources that are compliant and the - * number that are noncompliant. You can specify one or more resource - * types to get these numbers for each resource type. The maximum - * number returned is 100.

+ * @see {@link GetComplianceSummaryByResourceTypeCommand} */ - public getComplianceSummaryByResourceType( + getComplianceSummaryByResourceType( args: GetComplianceSummaryByResourceTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public getComplianceSummaryByResourceType( + getComplianceSummaryByResourceType( args: GetComplianceSummaryByResourceTypeCommandInput, cb: (err: any, data?: GetComplianceSummaryByResourceTypeCommandOutput) => void ): void; - public getComplianceSummaryByResourceType( + getComplianceSummaryByResourceType( args: GetComplianceSummaryByResourceTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComplianceSummaryByResourceTypeCommandOutput) => void ): void; - public getComplianceSummaryByResourceType( - args: GetComplianceSummaryByResourceTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetComplianceSummaryByResourceTypeCommandOutput) => void), - cb?: (err: any, data?: GetComplianceSummaryByResourceTypeCommandOutput) => void - ): Promise | void { - const command = new GetComplianceSummaryByResourceTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.

+ * @see {@link GetConformancePackComplianceDetailsCommand} */ - public getConformancePackComplianceDetails( + getConformancePackComplianceDetails( args: GetConformancePackComplianceDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConformancePackComplianceDetails( + getConformancePackComplianceDetails( args: GetConformancePackComplianceDetailsCommandInput, cb: (err: any, data?: GetConformancePackComplianceDetailsCommandOutput) => void ): void; - public getConformancePackComplianceDetails( + getConformancePackComplianceDetails( args: GetConformancePackComplianceDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConformancePackComplianceDetailsCommandOutput) => void ): void; - public getConformancePackComplianceDetails( - args: GetConformancePackComplianceDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConformancePackComplianceDetailsCommandOutput) => void), - cb?: (err: any, data?: GetConformancePackComplianceDetailsCommandOutput) => void - ): Promise | void { - const command = new GetConformancePackComplianceDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.

+ * @see {@link GetConformancePackComplianceSummaryCommand} */ - public getConformancePackComplianceSummary( + getConformancePackComplianceSummary( args: GetConformancePackComplianceSummaryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConformancePackComplianceSummary( + getConformancePackComplianceSummary( args: GetConformancePackComplianceSummaryCommandInput, cb: (err: any, data?: GetConformancePackComplianceSummaryCommandOutput) => void ): void; - public getConformancePackComplianceSummary( + getConformancePackComplianceSummary( args: GetConformancePackComplianceSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConformancePackComplianceSummaryCommandOutput) => void ): void; - public getConformancePackComplianceSummary( - args: GetConformancePackComplianceSummaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConformancePackComplianceSummaryCommandOutput) => void), - cb?: (err: any, data?: GetConformancePackComplianceSummaryCommandOutput) => void - ): Promise | void { - const command = new GetConformancePackComplianceSummaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the policy definition containing the logic for your Config Custom Policy rule.

+ * @see {@link GetCustomRulePolicyCommand} */ - public getCustomRulePolicy( + getCustomRulePolicy( args: GetCustomRulePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCustomRulePolicy( + getCustomRulePolicy( args: GetCustomRulePolicyCommandInput, cb: (err: any, data?: GetCustomRulePolicyCommandOutput) => void ): void; - public getCustomRulePolicy( + getCustomRulePolicy( args: GetCustomRulePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCustomRulePolicyCommandOutput) => void ): void; - public getCustomRulePolicy( - args: GetCustomRulePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCustomRulePolicyCommandOutput) => void), - cb?: (err: any, data?: GetCustomRulePolicyCommandOutput) => void - ): Promise | void { - const command = new GetCustomRulePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the resource types, the number of each resource type, - * and the total number of resources that Config is recording in - * this region for your Amazon Web Services account.

- *

- * Example - *

- *
    - *
  1. - *

    Config is recording three resource types in the US - * East (Ohio) Region for your account: 25 EC2 instances, 20 - * IAM users, and 15 S3 buckets.

    - *
  2. - *
  3. - *

    You make a call to the - * GetDiscoveredResourceCounts action and - * specify that you want all resource types.

    - *
  4. - *
  5. - *

    Config returns the following:

    - *
      - *
    • - *

      The resource types (EC2 instances, IAM users, - * and S3 buckets).

      - *
    • - *
    • - *

      The number of each resource type (25, 20, and - * 15).

      - *
    • - *
    • - *

      The total number of all resources - * (60).

      - *
    • - *
    - *
  6. - *
- *

The response is paginated. By default, Config lists 100 - * ResourceCount objects on each page. You can - * customize this number with the limit parameter. The - * response includes a nextToken string. To get the next - * page of results, run the request again and specify the string for - * the nextToken parameter.

- * - *

If you make a call to the GetDiscoveredResourceCounts action, you might - * not immediately receive resource counts in the following - * situations:

- *
    - *
  • - *

    You are a new Config customer.

    - *
  • - *
  • - *

    You just enabled resource recording.

    - *
  • - *
- *

It might take a few minutes for Config to record and - * count your resources. Wait a few minutes and then retry the - * GetDiscoveredResourceCounts action. - *

- *
+ * @see {@link GetDiscoveredResourceCountsCommand} */ - public getDiscoveredResourceCounts( + getDiscoveredResourceCounts( args: GetDiscoveredResourceCountsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDiscoveredResourceCounts( + getDiscoveredResourceCounts( args: GetDiscoveredResourceCountsCommandInput, cb: (err: any, data?: GetDiscoveredResourceCountsCommandOutput) => void ): void; - public getDiscoveredResourceCounts( + getDiscoveredResourceCounts( args: GetDiscoveredResourceCountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDiscoveredResourceCountsCommandOutput) => void ): void; - public getDiscoveredResourceCounts( - args: GetDiscoveredResourceCountsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDiscoveredResourceCountsCommandOutput) => void), - cb?: (err: any, data?: GetDiscoveredResourceCountsCommandOutput) => void - ): Promise | void { - const command = new GetDiscoveredResourceCountsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns detailed status for each member account within an organization for a given organization Config rule.

+ * @see {@link GetOrganizationConfigRuleDetailedStatusCommand} */ - public getOrganizationConfigRuleDetailedStatus( + getOrganizationConfigRuleDetailedStatus( args: GetOrganizationConfigRuleDetailedStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getOrganizationConfigRuleDetailedStatus( + getOrganizationConfigRuleDetailedStatus( args: GetOrganizationConfigRuleDetailedStatusCommandInput, cb: (err: any, data?: GetOrganizationConfigRuleDetailedStatusCommandOutput) => void ): void; - public getOrganizationConfigRuleDetailedStatus( + getOrganizationConfigRuleDetailedStatus( args: GetOrganizationConfigRuleDetailedStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOrganizationConfigRuleDetailedStatusCommandOutput) => void ): void; - public getOrganizationConfigRuleDetailedStatus( - args: GetOrganizationConfigRuleDetailedStatusCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetOrganizationConfigRuleDetailedStatusCommandOutput) => void), - cb?: (err: any, data?: GetOrganizationConfigRuleDetailedStatusCommandOutput) => void - ): Promise | void { - const command = new GetOrganizationConfigRuleDetailedStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns detailed status for each member account within an organization for a given organization conformance pack.

+ * @see {@link GetOrganizationConformancePackDetailedStatusCommand} */ - public getOrganizationConformancePackDetailedStatus( + getOrganizationConformancePackDetailedStatus( args: GetOrganizationConformancePackDetailedStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getOrganizationConformancePackDetailedStatus( + getOrganizationConformancePackDetailedStatus( args: GetOrganizationConformancePackDetailedStatusCommandInput, cb: (err: any, data?: GetOrganizationConformancePackDetailedStatusCommandOutput) => void ): void; - public getOrganizationConformancePackDetailedStatus( + getOrganizationConformancePackDetailedStatus( args: GetOrganizationConformancePackDetailedStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOrganizationConformancePackDetailedStatusCommandOutput) => void ): void; - public getOrganizationConformancePackDetailedStatus( - args: GetOrganizationConformancePackDetailedStatusCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetOrganizationConformancePackDetailedStatusCommandOutput) => void), - cb?: (err: any, data?: GetOrganizationConformancePackDetailedStatusCommandOutput) => void - ): Promise | void { - const command = new GetOrganizationConformancePackDetailedStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the policy definition containing the logic for your organization Config Custom Policy rule.

+ * @see {@link GetOrganizationCustomRulePolicyCommand} */ - public getOrganizationCustomRulePolicy( + getOrganizationCustomRulePolicy( args: GetOrganizationCustomRulePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getOrganizationCustomRulePolicy( + getOrganizationCustomRulePolicy( args: GetOrganizationCustomRulePolicyCommandInput, cb: (err: any, data?: GetOrganizationCustomRulePolicyCommandOutput) => void ): void; - public getOrganizationCustomRulePolicy( + getOrganizationCustomRulePolicy( args: GetOrganizationCustomRulePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOrganizationCustomRulePolicyCommandOutput) => void ): void; - public getOrganizationCustomRulePolicy( - args: GetOrganizationCustomRulePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOrganizationCustomRulePolicyCommandOutput) => void), - cb?: (err: any, data?: GetOrganizationCustomRulePolicyCommandOutput) => void - ): Promise | void { - const command = new GetOrganizationCustomRulePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of ConfigurationItems for the specified resource. - * The list contains details about each state of the resource - * during the specified time interval. If you specified a retention - * period to retain your ConfigurationItems between a - * minimum of 30 days and a maximum of 7 years (2557 days), Config - * returns the ConfigurationItems for the specified - * retention period.

- *

The response is paginated. By default, Config returns a - * limit of 10 configuration items per page. You can customize this - * number with the limit parameter. The response includes - * a nextToken string. To get the next page of results, - * run the request again and specify the string for the - * nextToken parameter.

- * - *

Each call to the API is limited to span a duration of seven - * days. It is likely that the number of records returned is - * smaller than the specified limit. In such cases, - * you can make another call, using the - * nextToken.

- *
+ * @see {@link GetResourceConfigHistoryCommand} */ - public getResourceConfigHistory( + getResourceConfigHistory( args: GetResourceConfigHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourceConfigHistory( + getResourceConfigHistory( args: GetResourceConfigHistoryCommandInput, cb: (err: any, data?: GetResourceConfigHistoryCommandOutput) => void ): void; - public getResourceConfigHistory( + getResourceConfigHistory( args: GetResourceConfigHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceConfigHistoryCommandOutput) => void ): void; - public getResourceConfigHistory( - args: GetResourceConfigHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourceConfigHistoryCommandOutput) => void), - cb?: (err: any, data?: GetResourceConfigHistoryCommandOutput) => void - ): Promise | void { - const command = new GetResourceConfigHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run. - * The results indicate which evaluation context was used to evaluate the rules, which resource details were evaluated, - * the evaluation mode that was run, and whether the resource details comply with the configuration of the proactive rules.

- * - *

To see additional information about the evaluation result, such as which rule flagged a resource as NON_COMPLIANT, use the GetComplianceDetailsByResource API. - * For more information, see the Examples section.

- *
+ * @see {@link GetResourceEvaluationSummaryCommand} */ - public getResourceEvaluationSummary( + getResourceEvaluationSummary( args: GetResourceEvaluationSummaryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourceEvaluationSummary( + getResourceEvaluationSummary( args: GetResourceEvaluationSummaryCommandInput, cb: (err: any, data?: GetResourceEvaluationSummaryCommandOutput) => void ): void; - public getResourceEvaluationSummary( + getResourceEvaluationSummary( args: GetResourceEvaluationSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceEvaluationSummaryCommandOutput) => void ): void; - public getResourceEvaluationSummary( - args: GetResourceEvaluationSummaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourceEvaluationSummaryCommandOutput) => void), - cb?: (err: any, data?: GetResourceEvaluationSummaryCommandOutput) => void - ): Promise | void { - const command = new GetResourceEvaluationSummaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the details of a specific stored query.

+ * @see {@link GetStoredQueryCommand} */ - public getStoredQuery( + getStoredQuery( args: GetStoredQueryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getStoredQuery( - args: GetStoredQueryCommandInput, - cb: (err: any, data?: GetStoredQueryCommandOutput) => void - ): void; - public getStoredQuery( + getStoredQuery(args: GetStoredQueryCommandInput, cb: (err: any, data?: GetStoredQueryCommandOutput) => void): void; + getStoredQuery( args: GetStoredQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStoredQueryCommandOutput) => void ): void; - public getStoredQuery( - args: GetStoredQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStoredQueryCommandOutput) => void), - cb?: (err: any, data?: GetStoredQueryCommandOutput) => void - ): Promise | void { - const command = new GetStoredQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions. - * A resource identifier includes the resource type, ID, (if available) the custom resource name, source account, and source region. - * You can narrow the results to include only resources that have specific resource IDs, or a resource name, or source account ID, or source region.

- *

For example, if the input consists of accountID 12345678910 and the region is us-east-1 for resource type AWS::EC2::Instance then the API returns all the EC2 instance identifiers of accountID 12345678910 and region us-east-1.

+ * @see {@link ListAggregateDiscoveredResourcesCommand} */ - public listAggregateDiscoveredResources( + listAggregateDiscoveredResources( args: ListAggregateDiscoveredResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAggregateDiscoveredResources( + listAggregateDiscoveredResources( args: ListAggregateDiscoveredResourcesCommandInput, cb: (err: any, data?: ListAggregateDiscoveredResourcesCommandOutput) => void ): void; - public listAggregateDiscoveredResources( + listAggregateDiscoveredResources( args: ListAggregateDiscoveredResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAggregateDiscoveredResourcesCommandOutput) => void ): void; - public listAggregateDiscoveredResources( - args: ListAggregateDiscoveredResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAggregateDiscoveredResourcesCommandOutput) => void), - cb?: (err: any, data?: ListAggregateDiscoveredResourcesCommandOutput) => void - ): Promise | void { - const command = new ListAggregateDiscoveredResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of conformance pack compliance scores. - * A compliance score is the percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack. - * This metric provides you with a high-level view of the compliance state of your conformance packs. You can use it to identify, investigate, and understand - * the level of compliance in your conformance packs.

- * - *

Conformance packs with no evaluation results will have a compliance score of INSUFFICIENT_DATA.

- *
+ * @see {@link ListConformancePackComplianceScoresCommand} */ - public listConformancePackComplianceScores( + listConformancePackComplianceScores( args: ListConformancePackComplianceScoresCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConformancePackComplianceScores( + listConformancePackComplianceScores( args: ListConformancePackComplianceScoresCommandInput, cb: (err: any, data?: ListConformancePackComplianceScoresCommandOutput) => void ): void; - public listConformancePackComplianceScores( + listConformancePackComplianceScores( args: ListConformancePackComplianceScoresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConformancePackComplianceScoresCommandOutput) => void ): void; - public listConformancePackComplianceScores( - args: ListConformancePackComplianceScoresCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConformancePackComplianceScoresCommandOutput) => void), - cb?: (err: any, data?: ListConformancePackComplianceScoresCommandOutput) => void - ): Promise | void { - const command = new ListConformancePackComplianceScoresCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Accepts a resource type and returns a list of resource - * identifiers for the resources of that type. A resource identifier - * includes the resource type, ID, and (if available) the custom - * resource name. The results consist of resources that Config has - * discovered, including those that Config is not currently - * recording. You can narrow the results to include only resources that - * have specific resource IDs or a resource name.

- * - *

You can specify either resource IDs or a resource name, but - * not both, in the same request.

- *
- *

The response is paginated. By default, Config lists 100 - * resource identifiers on each page. You can customize this number - * with the limit parameter. The response includes a - * nextToken string. To get the next page of results, - * run the request again and specify the string for the - * nextToken parameter.

+ * @see {@link ListDiscoveredResourcesCommand} */ - public listDiscoveredResources( + listDiscoveredResources( args: ListDiscoveredResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDiscoveredResources( + listDiscoveredResources( args: ListDiscoveredResourcesCommandInput, cb: (err: any, data?: ListDiscoveredResourcesCommandOutput) => void ): void; - public listDiscoveredResources( + listDiscoveredResources( args: ListDiscoveredResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDiscoveredResourcesCommandOutput) => void ): void; - public listDiscoveredResources( - args: ListDiscoveredResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDiscoveredResourcesCommandOutput) => void), - cb?: (err: any, data?: ListDiscoveredResourcesCommandOutput) => void - ): Promise | void { - const command = new ListDiscoveredResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of proactive resource evaluations.

+ * @see {@link ListResourceEvaluationsCommand} */ - public listResourceEvaluations( + listResourceEvaluations( args: ListResourceEvaluationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourceEvaluations( + listResourceEvaluations( args: ListResourceEvaluationsCommandInput, cb: (err: any, data?: ListResourceEvaluationsCommandOutput) => void ): void; - public listResourceEvaluations( + listResourceEvaluations( args: ListResourceEvaluationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceEvaluationsCommandOutput) => void ): void; - public listResourceEvaluations( - args: ListResourceEvaluationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourceEvaluationsCommandOutput) => void), - cb?: (err: any, data?: ListResourceEvaluationsCommandOutput) => void - ): Promise | void { - const command = new ListResourceEvaluationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100.

+ * @see {@link ListStoredQueriesCommand} */ - public listStoredQueries( + listStoredQueries( args: ListStoredQueriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStoredQueries( + listStoredQueries( args: ListStoredQueriesCommandInput, cb: (err: any, data?: ListStoredQueriesCommandOutput) => void ): void; - public listStoredQueries( + listStoredQueries( args: ListStoredQueriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStoredQueriesCommandOutput) => void ): void; - public listStoredQueries( - args: ListStoredQueriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStoredQueriesCommandOutput) => void), - cb?: (err: any, data?: ListStoredQueriesCommandOutput) => void - ): Promise | void { - const command = new ListStoredQueriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the tags for Config resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Authorizes the aggregator account and region to collect data - * from the source account and region.

- * - *

- * PutAggregationAuthorization is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different tags values, - * Config will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.

- *
+ * @see {@link PutAggregationAuthorizationCommand} */ - public putAggregationAuthorization( + putAggregationAuthorization( args: PutAggregationAuthorizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAggregationAuthorization( + putAggregationAuthorization( args: PutAggregationAuthorizationCommandInput, cb: (err: any, data?: PutAggregationAuthorizationCommandOutput) => void ): void; - public putAggregationAuthorization( + putAggregationAuthorization( args: PutAggregationAuthorizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAggregationAuthorizationCommandOutput) => void ): void; - public putAggregationAuthorization( - args: PutAggregationAuthorizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAggregationAuthorizationCommandOutput) => void), - cb?: (err: any, data?: PutAggregationAuthorizationCommandOutput) => void - ): Promise | void { - const command = new PutAggregationAuthorizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or updates an Config rule to evaluate if your - * Amazon Web Services resources comply with your desired configurations. For information on how many Config rules you can have per account, - * see - * Service Limits - * in the Config Developer Guide.

- *

There are two types of rules: Config Managed Rules and Config Custom Rules. - * You can use PutConfigRule to create both Config Managed Rules and Config Custom Rules.

- *

Config Managed Rules are predefined, - * customizable rules created by Config. For a list of managed rules, see - * List of Config - * Managed Rules. If you are adding an Config managed rule, you must specify the - * rule's identifier for the SourceIdentifier key.

- *

Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions - * ( Lambda Developer Guide) and with Guard (Guard GitHub - * Repository), a policy-as-code language. - * - * Config custom rules created with Lambda - * are called Config Custom Lambda Rules and Config custom rules created with - * Guard are called Config Custom Policy Rules.

- *

If you are adding a new Config Custom Lambda rule, - * you first need to create an Lambda function that the rule invokes to evaluate - * your resources. When you use PutConfigRule to add a Custom Lambda rule to Config, you must specify the Amazon Resource - * Name (ARN) that Lambda assigns to the function. You specify the ARN - * in the SourceIdentifier key. This key is part of the - * Source object, which is part of the - * ConfigRule object.

- *

For any new Config rule that you add, specify the - * ConfigRuleName in the ConfigRule - * object. Do not specify the ConfigRuleArn or the - * ConfigRuleId. These values are generated by Config for new rules.

- *

If you are updating a rule that you added previously, you can - * specify the rule by ConfigRuleName, - * ConfigRuleId, or ConfigRuleArn in the - * ConfigRule data type that you use in this - * request.

- *

For more information about developing and using Config - * rules, see Evaluating Resources with Config Rules - * in the Config Developer Guide.

- * - *

- * PutConfigRule is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different tags values, - * Config will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.

- *
+ * @see {@link PutConfigRuleCommand} */ - public putConfigRule( - args: PutConfigRuleCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putConfigRule( - args: PutConfigRuleCommandInput, - cb: (err: any, data?: PutConfigRuleCommandOutput) => void - ): void; - public putConfigRule( + putConfigRule(args: PutConfigRuleCommandInput, options?: __HttpHandlerOptions): Promise; + putConfigRule(args: PutConfigRuleCommandInput, cb: (err: any, data?: PutConfigRuleCommandOutput) => void): void; + putConfigRule( args: PutConfigRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConfigRuleCommandOutput) => void ): void; - public putConfigRule( - args: PutConfigRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutConfigRuleCommandOutput) => void), - cb?: (err: any, data?: PutConfigRuleCommandOutput) => void - ): Promise | void { - const command = new PutConfigRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates and updates the configuration aggregator with the - * selected source accounts and regions. The source account can be - * individual account(s) or an organization.

- *

- * accountIds that are passed will be replaced with existing accounts. - * If you want to add additional accounts into the aggregator, call DescribeConfigurationAggregators to get the previous accounts and then append new ones.

- * - *

Config should be enabled in source accounts and regions - * you want to aggregate.

- *

If your source type is an organization, you must be signed in to the management account or a registered delegated administrator and all the features must be enabled in your organization. - * If the caller is a management account, Config calls EnableAwsServiceAccess API to enable integration between Config and Organizations. - * If the caller is a registered delegated administrator, Config calls ListDelegatedAdministrators API to verify whether the caller is a valid delegated administrator.

- *

To register a delegated administrator, see Register a Delegated Administrator in the Config developer guide.

- *
- * - *

- * PutConfigurationAggregator is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different tags values, - * Config will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.

- *
+ * @see {@link PutConfigurationAggregatorCommand} */ - public putConfigurationAggregator( + putConfigurationAggregator( args: PutConfigurationAggregatorCommandInput, options?: __HttpHandlerOptions ): Promise; - public putConfigurationAggregator( + putConfigurationAggregator( args: PutConfigurationAggregatorCommandInput, cb: (err: any, data?: PutConfigurationAggregatorCommandOutput) => void ): void; - public putConfigurationAggregator( + putConfigurationAggregator( args: PutConfigurationAggregatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConfigurationAggregatorCommandOutput) => void ): void; - public putConfigurationAggregator( - args: PutConfigurationAggregatorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutConfigurationAggregatorCommandOutput) => void), - cb?: (err: any, data?: PutConfigurationAggregatorCommandOutput) => void - ): Promise | void { - const command = new PutConfigurationAggregatorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new configuration recorder to record the selected - * resource configurations.

- *

You can use this action to change the role roleARN - * or the recordingGroup of an existing recorder. To - * change the role, call the action on the existing configuration - * recorder and specify a role.

- * - *

Currently, you can specify only one configuration recorder - * per region in your account.

- *

If ConfigurationRecorder does not have the - * recordingGroup parameter - * specified, the default is to record all supported resource - * types.

- *
+ * @see {@link PutConfigurationRecorderCommand} */ - public putConfigurationRecorder( + putConfigurationRecorder( args: PutConfigurationRecorderCommandInput, options?: __HttpHandlerOptions ): Promise; - public putConfigurationRecorder( + putConfigurationRecorder( args: PutConfigurationRecorderCommandInput, cb: (err: any, data?: PutConfigurationRecorderCommandOutput) => void ): void; - public putConfigurationRecorder( + putConfigurationRecorder( args: PutConfigurationRecorderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConfigurationRecorderCommandOutput) => void ): void; - public putConfigurationRecorder( - args: PutConfigurationRecorderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutConfigurationRecorderCommandOutput) => void), - cb?: (err: any, data?: PutConfigurationRecorderCommandOutput) => void - ): Promise | void { - const command = new PutConfigurationRecorderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across an organization. - * For information on how many conformance packs you can have per account, - * see - * Service Limits - * in the Config Developer Guide.

- *

This API creates a service-linked role AWSServiceRoleForConfigConforms in your account. - * The service-linked role is created only when the role does not exist in your account.

- * - *

You must specify only one of the follow parameters: TemplateS3Uri, TemplateBody or TemplateSSMDocumentDetails.

- *
+ * @see {@link PutConformancePackCommand} */ - public putConformancePack( + putConformancePack( args: PutConformancePackCommandInput, options?: __HttpHandlerOptions ): Promise; - public putConformancePack( + putConformancePack( args: PutConformancePackCommandInput, cb: (err: any, data?: PutConformancePackCommandOutput) => void ): void; - public putConformancePack( + putConformancePack( args: PutConformancePackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConformancePackCommandOutput) => void ): void; - public putConformancePack( - args: PutConformancePackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutConformancePackCommandOutput) => void), - cb?: (err: any, data?: PutConformancePackCommandOutput) => void - ): Promise | void { - const command = new PutConformancePackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a delivery channel object to deliver configuration - * information to an Amazon S3 bucket and Amazon SNS topic.

- *

Before you can create a delivery channel, you must create a - * configuration recorder.

- *

You can use this action to change the Amazon S3 bucket or an - * Amazon SNS topic of the existing delivery channel. To change the - * Amazon S3 bucket or an Amazon SNS topic, call this action and - * specify the changed values for the S3 bucket and the SNS topic. If - * you specify a different value for either the S3 bucket or the SNS - * topic, this action will keep the existing value for the parameter - * that is not changed.

- * - *

You can have only one delivery channel per region in your - * account.

- *
+ * @see {@link PutDeliveryChannelCommand} */ - public putDeliveryChannel( + putDeliveryChannel( args: PutDeliveryChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public putDeliveryChannel( + putDeliveryChannel( args: PutDeliveryChannelCommandInput, cb: (err: any, data?: PutDeliveryChannelCommandOutput) => void ): void; - public putDeliveryChannel( + putDeliveryChannel( args: PutDeliveryChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDeliveryChannelCommandOutput) => void ): void; - public putDeliveryChannel( - args: PutDeliveryChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutDeliveryChannelCommandOutput) => void), - cb?: (err: any, data?: PutDeliveryChannelCommandOutput) => void - ): Promise | void { - const command = new PutDeliveryChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used by an Lambda function to deliver evaluation results to - * Config. This action is required in every Lambda function - * that is invoked by an Config rule.

+ * @see {@link PutEvaluationsCommand} */ - public putEvaluations( + putEvaluations( args: PutEvaluationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putEvaluations( - args: PutEvaluationsCommandInput, - cb: (err: any, data?: PutEvaluationsCommandOutput) => void - ): void; - public putEvaluations( + putEvaluations(args: PutEvaluationsCommandInput, cb: (err: any, data?: PutEvaluationsCommandOutput) => void): void; + putEvaluations( args: PutEvaluationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEvaluationsCommandOutput) => void ): void; - public putEvaluations( - args: PutEvaluationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutEvaluationsCommandOutput) => void), - cb?: (err: any, data?: PutEvaluationsCommandOutput) => void - ): Promise | void { - const command = new PutEvaluationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Add or updates the evaluations for process checks. - * This API checks if the rule is a process check when the name of the Config rule is provided.

+ * @see {@link PutExternalEvaluationCommand} */ - public putExternalEvaluation( + putExternalEvaluation( args: PutExternalEvaluationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putExternalEvaluation( + putExternalEvaluation( args: PutExternalEvaluationCommandInput, cb: (err: any, data?: PutExternalEvaluationCommandOutput) => void ): void; - public putExternalEvaluation( + putExternalEvaluation( args: PutExternalEvaluationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutExternalEvaluationCommandOutput) => void ): void; - public putExternalEvaluation( - args: PutExternalEvaluationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutExternalEvaluationCommandOutput) => void), - cb?: (err: any, data?: PutExternalEvaluationCommandOutput) => void - ): Promise | void { - const command = new PutExternalEvaluationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your - * desired configurations. For information on how many organization Config rules you can have per account, - * see - * Service Limits - * in the Config Developer Guide.

- *

Only a management account and a delegated administrator can create or update an organization Config rule. - * When calling this API with a delegated administrator, you must ensure Organizations - * ListDelegatedAdministrator permissions are added. An organization can have up to 3 delegated administrators.

- *

This API enables organization service access through the EnableAWSServiceAccess action and creates a service-linked - * role AWSServiceRoleForConfigMultiAccountSetup in the management or delegated administrator account of your organization. - * The service-linked role is created only when the role does not exist in the caller account. - * Config verifies the existence of role with GetRole action.

- *

To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization - * register-delegated-administrator for config-multiaccountsetup.amazonaws.com.

- *

There are two types of rules: Config Managed Rules and Config Custom Rules. - * You can use PutOrganizationConfigRule to create both Config Managed Rules and Config Custom Rules.

- *

Config Managed Rules are predefined, - * customizable rules created by Config. For a list of managed rules, see - * List of Config - * Managed Rules. If you are adding an Config managed rule, you must specify the rule's identifier for the RuleIdentifier key.

- *

Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions - * ( Lambda Developer Guide) and with Guard (Guard GitHub - * Repository), a policy-as-code language. - * - * Config custom rules created with Lambda - * are called Config Custom Lambda Rules and Config custom rules created with - * Guard are called Config Custom Policy Rules.

- *

If you are adding a new Config Custom Lambda rule, you first need to create an Lambda function in the management account or a delegated - * administrator that the rule invokes to evaluate your resources. You also need to create an IAM role in the managed account that can be assumed by the Lambda function. - * When you use PutOrganizationConfigRule to add a Custom Lambda rule to Config, you must - * specify the Amazon Resource Name (ARN) that Lambda assigns to the function.

- * - *

Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.

- *

Make sure to specify one of either OrganizationCustomPolicyRuleMetadata for Custom Policy rules, OrganizationCustomRuleMetadata for Custom Lambda rules, or OrganizationManagedRuleMetadata for managed rules.

- *
+ * @see {@link PutOrganizationConfigRuleCommand} */ - public putOrganizationConfigRule( + putOrganizationConfigRule( args: PutOrganizationConfigRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public putOrganizationConfigRule( + putOrganizationConfigRule( args: PutOrganizationConfigRuleCommandInput, cb: (err: any, data?: PutOrganizationConfigRuleCommandOutput) => void ): void; - public putOrganizationConfigRule( + putOrganizationConfigRule( args: PutOrganizationConfigRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutOrganizationConfigRuleCommandOutput) => void ): void; - public putOrganizationConfigRule( - args: PutOrganizationConfigRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutOrganizationConfigRuleCommandOutput) => void), - cb?: (err: any, data?: PutOrganizationConfigRuleCommandOutput) => void - ): Promise | void { - const command = new PutOrganizationConfigRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account, - * see - * Service Limits - * in the Config Developer Guide.

- *

Only a management account and a delegated administrator can call this API. - * When calling this API with a delegated administrator, you must ensure Organizations - * ListDelegatedAdministrator permissions are added. An organization can have up to 3 delegated administrators.

- *

This API enables organization service access for config-multiaccountsetup.amazonaws.com - * through the EnableAWSServiceAccess action and creates a - * service-linked role AWSServiceRoleForConfigMultiAccountSetup in the management or delegated administrator account of your organization. - * The service-linked role is created only when the role does not exist in the caller account. - * To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization - * register-delegate-admin for config-multiaccountsetup.amazonaws.com.

- * - *

Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.

- *

You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. - * If you provide both Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter.

- *

Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. - * You cannot update a conformance pack while it is in this state.

- *
+ * @see {@link PutOrganizationConformancePackCommand} */ - public putOrganizationConformancePack( + putOrganizationConformancePack( args: PutOrganizationConformancePackCommandInput, options?: __HttpHandlerOptions ): Promise; - public putOrganizationConformancePack( + putOrganizationConformancePack( args: PutOrganizationConformancePackCommandInput, cb: (err: any, data?: PutOrganizationConformancePackCommandOutput) => void ): void; - public putOrganizationConformancePack( + putOrganizationConformancePack( args: PutOrganizationConformancePackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutOrganizationConformancePackCommandOutput) => void ): void; - public putOrganizationConformancePack( - args: PutOrganizationConformancePackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutOrganizationConformancePackCommandOutput) => void), - cb?: (err: any, data?: PutOrganizationConformancePackCommandOutput) => void - ): Promise | void { - const command = new PutOrganizationConformancePackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or updates the remediation configuration with a specific Config rule with the - * selected target or action. - * The API creates the RemediationConfiguration object for the Config rule. - * The Config rule must already exist for you to add a remediation configuration. - * The target (SSM document) must exist and have permissions to use the target.

- * - *

If you make backward incompatible changes to the SSM document, - * you must call this again to ensure the remediations can run.

- *

This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules, - * the rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub.

- *
- * - *

For manual remediation configuration, you need to provide a value for automationAssumeRole or use a value in the assumeRolefield to remediate your resources. The SSM automation document can use either as long as it maps to a valid parameter.

- *

However, for automatic remediation configuration, the only valid assumeRole field value is AutomationAssumeRole and you need to provide a value for AutomationAssumeRole to remediate your resources.

- *
+ * @see {@link PutRemediationConfigurationsCommand} */ - public putRemediationConfigurations( + putRemediationConfigurations( args: PutRemediationConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putRemediationConfigurations( + putRemediationConfigurations( args: PutRemediationConfigurationsCommandInput, cb: (err: any, data?: PutRemediationConfigurationsCommandOutput) => void ): void; - public putRemediationConfigurations( + putRemediationConfigurations( args: PutRemediationConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRemediationConfigurationsCommandOutput) => void ): void; - public putRemediationConfigurations( - args: PutRemediationConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRemediationConfigurationsCommandOutput) => void), - cb?: (err: any, data?: PutRemediationConfigurationsCommandOutput) => void - ): Promise | void { - const command = new PutRemediationConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A remediation exception is when a specified resource is no longer considered for auto-remediation. - * This API adds a new exception or updates an existing exception for a specified resource with a specified Config rule.

- * - *

Config generates a remediation exception when a problem occurs running a remediation action for a specified resource. - * Remediation exceptions blocks auto-remediation until the exception is cleared.

- *
- * - *

When placing an exception on an Amazon Web Services resource, it is recommended that remediation is set as manual remediation until - * the given Config rule for the specified resource evaluates the resource as NON_COMPLIANT. - * Once the resource has been evaluated as NON_COMPLIANT, you can add remediation exceptions and change the remediation type back from Manual to Auto if you want to use auto-remediation. - * Otherwise, using auto-remediation before a NON_COMPLIANT evaluation result can delete resources before the exception is applied.

- *
- * - *

Placing an exception can only be performed on resources that are NON_COMPLIANT. - * If you use this API for COMPLIANT resources or resources that are NOT_APPLICABLE, a remediation exception will not be generated. - * For more information on the conditions that initiate the possible Config evaluation results, - * see Concepts | Config Rules in the Config Developer Guide.

- *
+ * @see {@link PutRemediationExceptionsCommand} */ - public putRemediationExceptions( + putRemediationExceptions( args: PutRemediationExceptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putRemediationExceptions( + putRemediationExceptions( args: PutRemediationExceptionsCommandInput, cb: (err: any, data?: PutRemediationExceptionsCommandOutput) => void ): void; - public putRemediationExceptions( + putRemediationExceptions( args: PutRemediationExceptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRemediationExceptionsCommandOutput) => void ): void; - public putRemediationExceptions( - args: PutRemediationExceptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRemediationExceptionsCommandOutput) => void), - cb?: (err: any, data?: PutRemediationExceptionsCommandOutput) => void - ): Promise | void { - const command = new PutRemediationExceptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Records the configuration state for the resource provided in the request. - * - * The configuration state of a resource is represented in Config as Configuration Items. - * Once this API records the configuration item, you can retrieve the list of configuration items for the custom resource type using existing Config APIs.

- * - *

The custom resource type must be registered with CloudFormation. This API accepts the configuration item registered with CloudFormation.

- *

When you call this API, Config only stores configuration state of the resource provided in the request. This API does not change or remediate the configuration of the resource. - *

- *

Write-only schema properites are not recorded as part of the published configuration item.

- *
+ * @see {@link PutResourceConfigCommand} */ - public putResourceConfig( + putResourceConfig( args: PutResourceConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResourceConfig( + putResourceConfig( args: PutResourceConfigCommandInput, cb: (err: any, data?: PutResourceConfigCommandOutput) => void ): void; - public putResourceConfig( + putResourceConfig( args: PutResourceConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourceConfigCommandOutput) => void ): void; - public putResourceConfig( - args: PutResourceConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourceConfigCommandOutput) => void), - cb?: (err: any, data?: PutResourceConfigCommandOutput) => void - ): Promise | void { - const command = new PutResourceConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates and updates the retention configuration with details - * about retention period (number of days) that Config stores your - * historical information. The API creates the - * RetentionConfiguration object and names the object - * as default. When you have a - * RetentionConfiguration object named default, calling the API modifies the - * default object.

- * - *

Currently, Config supports only one retention - * configuration per region in your account.

- *
+ * @see {@link PutRetentionConfigurationCommand} */ - public putRetentionConfiguration( + putRetentionConfiguration( args: PutRetentionConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putRetentionConfiguration( + putRetentionConfiguration( args: PutRetentionConfigurationCommandInput, cb: (err: any, data?: PutRetentionConfigurationCommandOutput) => void ): void; - public putRetentionConfiguration( + putRetentionConfiguration( args: PutRetentionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRetentionConfigurationCommandOutput) => void ): void; - public putRetentionConfiguration( - args: PutRetentionConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRetentionConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutRetentionConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutRetentionConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Saves a new query or updates an existing saved query. The QueryName must be unique for a single Amazon Web Services account and a single Amazon Web Services Region. - * You can create upto 300 queries in a single Amazon Web Services account and a single Amazon Web Services Region.

- * - *

- * PutStoredQuery is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different tags values, - * Config will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.

- *
+ * @see {@link PutStoredQueryCommand} */ - public putStoredQuery( + putStoredQuery( args: PutStoredQueryCommandInput, options?: __HttpHandlerOptions ): Promise; - public putStoredQuery( - args: PutStoredQueryCommandInput, - cb: (err: any, data?: PutStoredQueryCommandOutput) => void - ): void; - public putStoredQuery( + putStoredQuery(args: PutStoredQueryCommandInput, cb: (err: any, data?: PutStoredQueryCommandOutput) => void): void; + putStoredQuery( args: PutStoredQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutStoredQueryCommandOutput) => void ): void; - public putStoredQuery( - args: PutStoredQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutStoredQueryCommandOutput) => void), - cb?: (err: any, data?: PutStoredQueryCommandOutput) => void - ): Promise | void { - const command = new PutStoredQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, - * performs the corresponding search, and returns resource configurations matching the properties.

- *

For more information about query components, see the - * - * Query Components - * section in the Config Developer Guide.

- * - *

If you run an aggregation query (i.e., using GROUP BY or using aggregate functions such as COUNT; e.g., SELECT resourceId, COUNT(*) WHERE resourceType = 'AWS::IAM::Role' GROUP BY resourceId) - * and do not specify the MaxResults or the Limit query parameters, the default page size is set to 500.

- *

If you run a non-aggregation query (i.e., not using GROUP BY or aggregate function; e.g., SELECT * WHERE resourceType = 'AWS::IAM::Role') - * and do not specify the MaxResults or the Limit query parameters, the default page size is set to 25.

- *
+ * @see {@link SelectAggregateResourceConfigCommand} */ - public selectAggregateResourceConfig( + selectAggregateResourceConfig( args: SelectAggregateResourceConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public selectAggregateResourceConfig( + selectAggregateResourceConfig( args: SelectAggregateResourceConfigCommandInput, cb: (err: any, data?: SelectAggregateResourceConfigCommandOutput) => void ): void; - public selectAggregateResourceConfig( + selectAggregateResourceConfig( args: SelectAggregateResourceConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SelectAggregateResourceConfigCommandOutput) => void ): void; - public selectAggregateResourceConfig( - args: SelectAggregateResourceConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SelectAggregateResourceConfigCommandOutput) => void), - cb?: (err: any, data?: SelectAggregateResourceConfigCommandOutput) => void - ): Promise | void { - const command = new SelectAggregateResourceConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Accepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties.

- *

For more information about query components, see the - * - * Query Components - * section in the Config Developer Guide.

+ * @see {@link SelectResourceConfigCommand} */ - public selectResourceConfig( + selectResourceConfig( args: SelectResourceConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public selectResourceConfig( + selectResourceConfig( args: SelectResourceConfigCommandInput, cb: (err: any, data?: SelectResourceConfigCommandOutput) => void ): void; - public selectResourceConfig( + selectResourceConfig( args: SelectResourceConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SelectResourceConfigCommandOutput) => void ): void; - public selectResourceConfig( - args: SelectResourceConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SelectResourceConfigCommandOutput) => void), - cb?: (err: any, data?: SelectResourceConfigCommandOutput) => void - ): Promise | void { - const command = new SelectResourceConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Runs an on-demand evaluation for the specified Config rules - * against the last known configuration state of the resources. Use - * StartConfigRulesEvaluation when you want to test - * that a rule you updated is working as expected. - * StartConfigRulesEvaluation does not re-record the - * latest configuration state for your resources. It re-runs an - * evaluation against the last known state of your resources.

- *

You can specify up to 25 Config rules per request.

- *

An existing StartConfigRulesEvaluation call for - * the specified rules must complete before you can call the API again. - * If you chose to have Config stream to an Amazon SNS topic, you - * will receive a ConfigRuleEvaluationStarted notification - * when the evaluation starts.

- * - *

You don't need to call the - * StartConfigRulesEvaluation API to run an - * evaluation for a new rule. When you create a rule, Config - * evaluates your resources against the rule automatically. - *

- *
- *

The StartConfigRulesEvaluation API is useful if - * you want to run on-demand evaluations, such as the following - * example:

- *
    - *
  1. - *

    You have a custom rule that evaluates your IAM - * resources every 24 hours.

    - *
  2. - *
  3. - *

    You update your Lambda function to add additional - * conditions to your rule.

    - *
  4. - *
  5. - *

    Instead of waiting for the next periodic evaluation, - * you call the StartConfigRulesEvaluation - * API.

    - *
  6. - *
  7. - *

    Config invokes your Lambda function and evaluates - * your IAM resources.

    - *
  8. - *
  9. - *

    Your custom rule will still run periodic evaluations - * every 24 hours.

    - *
  10. - *
+ * @see {@link StartConfigRulesEvaluationCommand} */ - public startConfigRulesEvaluation( + startConfigRulesEvaluation( args: StartConfigRulesEvaluationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startConfigRulesEvaluation( + startConfigRulesEvaluation( args: StartConfigRulesEvaluationCommandInput, cb: (err: any, data?: StartConfigRulesEvaluationCommandOutput) => void ): void; - public startConfigRulesEvaluation( + startConfigRulesEvaluation( args: StartConfigRulesEvaluationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartConfigRulesEvaluationCommandOutput) => void ): void; - public startConfigRulesEvaluation( - args: StartConfigRulesEvaluationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartConfigRulesEvaluationCommandOutput) => void), - cb?: (err: any, data?: StartConfigRulesEvaluationCommandOutput) => void - ): Promise | void { - const command = new StartConfigRulesEvaluationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts recording configurations of the Amazon Web Services resources you have - * selected to record in your Amazon Web Services account.

- *

You must have created at least one delivery channel to - * successfully start the configuration recorder.

+ * @see {@link StartConfigurationRecorderCommand} */ - public startConfigurationRecorder( + startConfigurationRecorder( args: StartConfigurationRecorderCommandInput, options?: __HttpHandlerOptions ): Promise; - public startConfigurationRecorder( + startConfigurationRecorder( args: StartConfigurationRecorderCommandInput, cb: (err: any, data?: StartConfigurationRecorderCommandOutput) => void ): void; - public startConfigurationRecorder( + startConfigurationRecorder( args: StartConfigurationRecorderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartConfigurationRecorderCommandOutput) => void ): void; - public startConfigurationRecorder( - args: StartConfigurationRecorderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartConfigurationRecorderCommandOutput) => void), - cb?: (err: any, data?: StartConfigurationRecorderCommandOutput) => void - ): Promise | void { - const command = new StartConfigurationRecorderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Runs an on-demand remediation for the specified Config rules against the last known remediation configuration. It runs an execution against the current state of your resources. Remediation execution is asynchronous.

- *

You can specify up to 100 resource keys per request. An existing StartRemediationExecution call for the specified resource keys must complete before you can call the API again.

+ * @see {@link StartRemediationExecutionCommand} */ - public startRemediationExecution( + startRemediationExecution( args: StartRemediationExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startRemediationExecution( + startRemediationExecution( args: StartRemediationExecutionCommandInput, cb: (err: any, data?: StartRemediationExecutionCommandOutput) => void ): void; - public startRemediationExecution( + startRemediationExecution( args: StartRemediationExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartRemediationExecutionCommandOutput) => void ): void; - public startRemediationExecution( - args: StartRemediationExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartRemediationExecutionCommandOutput) => void), - cb?: (err: any, data?: StartRemediationExecutionCommandOutput) => void - ): Promise | void { - const command = new StartRemediationExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules. - * You can also use it for evaluation purposes. Config recommends using an evaluation context. It runs an execution against the resource details with all - * of the Config rules in your account that match with the specified proactive mode and resource type.

- * - *

Ensure you have the cloudformation:DescribeType role setup to validate the resource type schema.

- *

You can find the - * Resource type schema in "Amazon Web Services public extensions" within the CloudFormation registry or with the following CLI commmand: - * aws cloudformation describe-type --type-name "AWS::S3::Bucket" --type RESOURCE.

- *

For more information, see Managing extensions through the CloudFormation registry - * and Amazon Web Services resource and property types reference in the CloudFormation User Guide.

- *
+ * @see {@link StartResourceEvaluationCommand} */ - public startResourceEvaluation( + startResourceEvaluation( args: StartResourceEvaluationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startResourceEvaluation( + startResourceEvaluation( args: StartResourceEvaluationCommandInput, cb: (err: any, data?: StartResourceEvaluationCommandOutput) => void ): void; - public startResourceEvaluation( + startResourceEvaluation( args: StartResourceEvaluationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartResourceEvaluationCommandOutput) => void ): void; - public startResourceEvaluation( - args: StartResourceEvaluationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartResourceEvaluationCommandOutput) => void), - cb?: (err: any, data?: StartResourceEvaluationCommandOutput) => void - ): Promise | void { - const command = new StartResourceEvaluationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.

+ * @see {@link StopConfigurationRecorderCommand} */ - public stopConfigurationRecorder( + stopConfigurationRecorder( args: StopConfigurationRecorderCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopConfigurationRecorder( + stopConfigurationRecorder( args: StopConfigurationRecorderCommandInput, cb: (err: any, data?: StopConfigurationRecorderCommandOutput) => void ): void; - public stopConfigurationRecorder( + stopConfigurationRecorder( args: StopConfigurationRecorderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopConfigurationRecorderCommandOutput) => void ): void; - public stopConfigurationRecorder( - args: StopConfigurationRecorderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopConfigurationRecorderCommandOutput) => void), - cb?: (err: any, data?: StopConfigurationRecorderCommandOutput) => void - ): Promise | void { - const command = new StopConfigurationRecorderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. - * If existing tags are specified, however, then their values will be updated. When a resource is deleted, the tags associated with that resource are deleted as well.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes specified tags from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Config + *

Config provides a way to keep track of the configurations + * of all the Amazon Web Services resources associated with your Amazon Web Services account. You can + * use Config to get the current and historical configurations of + * each Amazon Web Services resource and also to get information about the relationship + * between the resources. An Amazon Web Services resource can be an Amazon Compute + * Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an + * elastic network Interface (ENI), or a security group. For a complete + * list of resources currently supported by Config, see Supported Amazon Web Services resources.

+ *

You can access and manage Config through the Amazon Web Services Management + * Console, the Amazon Web Services Command Line Interface (Amazon Web Services CLI), the Config + * API, or the Amazon Web Services SDKs for Config. This reference guide contains + * documentation for the Config API and the Amazon Web Services CLI commands that + * you can use to manage Config. The Config API uses the + * Signature Version 4 protocol for signing requests. For more + * information about how to sign a request with this protocol, see + * Signature + * Version 4 Signing Process. For detailed information + * about Config features and their associated actions or commands, + * as well as how to work with Amazon Web Services Management Console, see What Is Config in the Config Developer + * Guide.

+ */ +export class ConfigService extends ConfigServiceClient implements ConfigService {} +createAggregatedClient(commands, ConfigService); diff --git a/clients/client-connect-contact-lens/src/ConnectContactLens.ts b/clients/client-connect-contact-lens/src/ConnectContactLens.ts index dde86daf9bde..ec5de648a073 100644 --- a/clients/client-connect-contact-lens/src/ConnectContactLens.ts +++ b/clients/client-connect-contact-lens/src/ConnectContactLens.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -6,49 +7,40 @@ import { ListRealtimeContactAnalysisSegmentsCommandInput, ListRealtimeContactAnalysisSegmentsCommandOutput, } from "./commands/ListRealtimeContactAnalysisSegmentsCommand"; -import { ConnectContactLensClient } from "./ConnectContactLensClient"; +import { ConnectContactLensClient, ConnectContactLensClientConfig } from "./ConnectContactLensClient"; -/** - * @public - *

Contact Lens for Amazon Connect enables you to analyze conversations between customer and agents, - * by using speech transcription, natural language processing, and intelligent search - * capabilities. It performs sentiment analysis, detects issues, and enables you to automatically - * categorize contacts.

- *

Contact Lens for Amazon Connect provides both real-time and post-call analytics of customer-agent - * conversations. For more information, see Analyze conversations using - * Contact Lens in the Amazon Connect Administrator Guide.

- */ -export class ConnectContactLens extends ConnectContactLensClient { +const commands = { + ListRealtimeContactAnalysisSegmentsCommand, +}; + +export interface ConnectContactLens { /** - * @public - *

Provides a list of analysis segments for a real-time analysis session.

+ * @see {@link ListRealtimeContactAnalysisSegmentsCommand} */ - public listRealtimeContactAnalysisSegments( + listRealtimeContactAnalysisSegments( args: ListRealtimeContactAnalysisSegmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRealtimeContactAnalysisSegments( + listRealtimeContactAnalysisSegments( args: ListRealtimeContactAnalysisSegmentsCommandInput, cb: (err: any, data?: ListRealtimeContactAnalysisSegmentsCommandOutput) => void ): void; - public listRealtimeContactAnalysisSegments( + listRealtimeContactAnalysisSegments( args: ListRealtimeContactAnalysisSegmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRealtimeContactAnalysisSegmentsCommandOutput) => void ): void; - public listRealtimeContactAnalysisSegments( - args: ListRealtimeContactAnalysisSegmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRealtimeContactAnalysisSegmentsCommandOutput) => void), - cb?: (err: any, data?: ListRealtimeContactAnalysisSegmentsCommandOutput) => void - ): Promise | void { - const command = new ListRealtimeContactAnalysisSegmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Contact Lens for Amazon Connect enables you to analyze conversations between customer and agents, + * by using speech transcription, natural language processing, and intelligent search + * capabilities. It performs sentiment analysis, detects issues, and enables you to automatically + * categorize contacts.

+ *

Contact Lens for Amazon Connect provides both real-time and post-call analytics of customer-agent + * conversations. For more information, see Analyze conversations using + * Contact Lens in the Amazon Connect Administrator Guide.

+ */ +export class ConnectContactLens extends ConnectContactLensClient implements ConnectContactLens {} +createAggregatedClient(commands, ConnectContactLens); diff --git a/clients/client-connect/src/Connect.ts b/clients/client-connect/src/Connect.ts index ad153f78bb71..9581d66088f0 100644 --- a/clients/client-connect/src/Connect.ts +++ b/clients/client-connect/src/Connect.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -791,5980 +792,2888 @@ import { UpdateUserSecurityProfilesCommandInput, UpdateUserSecurityProfilesCommandOutput, } from "./commands/UpdateUserSecurityProfilesCommand"; -import { ConnectClient } from "./ConnectClient"; +import { ConnectClient, ConnectClientConfig } from "./ConnectClient"; -/** - * @public - *

Amazon Connect is a cloud-based contact center solution that you use to set up and - * manage a customer contact center and provide reliable customer engagement at any scale.

- *

Amazon Connect provides metrics and real-time reporting that enable you to optimize - * contact routing. You can also resolve customer issues more efficiently by getting customers in - * touch with the appropriate agents.

- *

There are limits to the number of Amazon Connect resources that you can create. There - * are also limits to the number of requests that you can make per second. For more information, see - * Amazon Connect Service Quotas in the Amazon Connect Administrator - * Guide.

- *

You can connect programmatically to an Amazon Web Services service by using an endpoint. For - * a list of Amazon Connect endpoints, see Amazon Connect Endpoints.

- */ -export class Connect extends ConnectClient { +const commands = { + AssociateApprovedOriginCommand, + AssociateBotCommand, + AssociateDefaultVocabularyCommand, + AssociateInstanceStorageConfigCommand, + AssociateLambdaFunctionCommand, + AssociateLexBotCommand, + AssociatePhoneNumberContactFlowCommand, + AssociateQueueQuickConnectsCommand, + AssociateRoutingProfileQueuesCommand, + AssociateSecurityKeyCommand, + ClaimPhoneNumberCommand, + CreateAgentStatusCommand, + CreateContactFlowCommand, + CreateContactFlowModuleCommand, + CreateHoursOfOperationCommand, + CreateInstanceCommand, + CreateIntegrationAssociationCommand, + CreateQueueCommand, + CreateQuickConnectCommand, + CreateRoutingProfileCommand, + CreateRuleCommand, + CreateSecurityProfileCommand, + CreateTaskTemplateCommand, + CreateTrafficDistributionGroupCommand, + CreateUseCaseCommand, + CreateUserCommand, + CreateUserHierarchyGroupCommand, + CreateVocabularyCommand, + DeleteContactFlowCommand, + DeleteContactFlowModuleCommand, + DeleteHoursOfOperationCommand, + DeleteInstanceCommand, + DeleteIntegrationAssociationCommand, + DeleteQuickConnectCommand, + DeleteRuleCommand, + DeleteSecurityProfileCommand, + DeleteTaskTemplateCommand, + DeleteTrafficDistributionGroupCommand, + DeleteUseCaseCommand, + DeleteUserCommand, + DeleteUserHierarchyGroupCommand, + DeleteVocabularyCommand, + DescribeAgentStatusCommand, + DescribeContactCommand, + DescribeContactFlowCommand, + DescribeContactFlowModuleCommand, + DescribeHoursOfOperationCommand, + DescribeInstanceCommand, + DescribeInstanceAttributeCommand, + DescribeInstanceStorageConfigCommand, + DescribePhoneNumberCommand, + DescribeQueueCommand, + DescribeQuickConnectCommand, + DescribeRoutingProfileCommand, + DescribeRuleCommand, + DescribeSecurityProfileCommand, + DescribeTrafficDistributionGroupCommand, + DescribeUserCommand, + DescribeUserHierarchyGroupCommand, + DescribeUserHierarchyStructureCommand, + DescribeVocabularyCommand, + DisassociateApprovedOriginCommand, + DisassociateBotCommand, + DisassociateInstanceStorageConfigCommand, + DisassociateLambdaFunctionCommand, + DisassociateLexBotCommand, + DisassociatePhoneNumberContactFlowCommand, + DisassociateQueueQuickConnectsCommand, + DisassociateRoutingProfileQueuesCommand, + DisassociateSecurityKeyCommand, + DismissUserContactCommand, + GetContactAttributesCommand, + GetCurrentMetricDataCommand, + GetCurrentUserDataCommand, + GetFederationTokenCommand, + GetMetricDataCommand, + GetMetricDataV2Command, + GetTaskTemplateCommand, + GetTrafficDistributionCommand, + ListAgentStatusesCommand, + ListApprovedOriginsCommand, + ListBotsCommand, + ListContactFlowModulesCommand, + ListContactFlowsCommand, + ListContactReferencesCommand, + ListDefaultVocabulariesCommand, + ListHoursOfOperationsCommand, + ListInstanceAttributesCommand, + ListInstancesCommand, + ListInstanceStorageConfigsCommand, + ListIntegrationAssociationsCommand, + ListLambdaFunctionsCommand, + ListLexBotsCommand, + ListPhoneNumbersCommand, + ListPhoneNumbersV2Command, + ListPromptsCommand, + ListQueueQuickConnectsCommand, + ListQueuesCommand, + ListQuickConnectsCommand, + ListRoutingProfileQueuesCommand, + ListRoutingProfilesCommand, + ListRulesCommand, + ListSecurityKeysCommand, + ListSecurityProfilePermissionsCommand, + ListSecurityProfilesCommand, + ListTagsForResourceCommand, + ListTaskTemplatesCommand, + ListTrafficDistributionGroupsCommand, + ListUseCasesCommand, + ListUserHierarchyGroupsCommand, + ListUsersCommand, + MonitorContactCommand, + PutUserStatusCommand, + ReleasePhoneNumberCommand, + ReplicateInstanceCommand, + ResumeContactRecordingCommand, + SearchAvailablePhoneNumbersCommand, + SearchQueuesCommand, + SearchRoutingProfilesCommand, + SearchSecurityProfilesCommand, + SearchUsersCommand, + SearchVocabulariesCommand, + StartChatContactCommand, + StartContactRecordingCommand, + StartContactStreamingCommand, + StartOutboundVoiceContactCommand, + StartTaskContactCommand, + StopContactCommand, + StopContactRecordingCommand, + StopContactStreamingCommand, + SuspendContactRecordingCommand, + TagResourceCommand, + TransferContactCommand, + UntagResourceCommand, + UpdateAgentStatusCommand, + UpdateContactCommand, + UpdateContactAttributesCommand, + UpdateContactFlowContentCommand, + UpdateContactFlowMetadataCommand, + UpdateContactFlowModuleContentCommand, + UpdateContactFlowModuleMetadataCommand, + UpdateContactFlowNameCommand, + UpdateContactScheduleCommand, + UpdateHoursOfOperationCommand, + UpdateInstanceAttributeCommand, + UpdateInstanceStorageConfigCommand, + UpdateParticipantRoleConfigCommand, + UpdatePhoneNumberCommand, + UpdateQueueHoursOfOperationCommand, + UpdateQueueMaxContactsCommand, + UpdateQueueNameCommand, + UpdateQueueOutboundCallerConfigCommand, + UpdateQueueStatusCommand, + UpdateQuickConnectConfigCommand, + UpdateQuickConnectNameCommand, + UpdateRoutingProfileConcurrencyCommand, + UpdateRoutingProfileDefaultOutboundQueueCommand, + UpdateRoutingProfileNameCommand, + UpdateRoutingProfileQueuesCommand, + UpdateRuleCommand, + UpdateSecurityProfileCommand, + UpdateTaskTemplateCommand, + UpdateTrafficDistributionCommand, + UpdateUserHierarchyCommand, + UpdateUserHierarchyGroupNameCommand, + UpdateUserHierarchyStructureCommand, + UpdateUserIdentityInfoCommand, + UpdateUserPhoneConfigCommand, + UpdateUserRoutingProfileCommand, + UpdateUserSecurityProfilesCommand, +}; + +export interface Connect { /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Associates an approved origin to an Amazon Connect instance.

+ * @see {@link AssociateApprovedOriginCommand} */ - public associateApprovedOrigin( + associateApprovedOrigin( args: AssociateApprovedOriginCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateApprovedOrigin( + associateApprovedOrigin( args: AssociateApprovedOriginCommandInput, cb: (err: any, data?: AssociateApprovedOriginCommandOutput) => void ): void; - public associateApprovedOrigin( + associateApprovedOrigin( args: AssociateApprovedOriginCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateApprovedOriginCommandOutput) => void ): void; - public associateApprovedOrigin( - args: AssociateApprovedOriginCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateApprovedOriginCommandOutput) => void), - cb?: (err: any, data?: AssociateApprovedOriginCommandOutput) => void - ): Promise | void { - const command = new AssociateApprovedOriginCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Allows the specified Amazon Connect instance to access the specified Amazon Lex - * or Amazon Lex V2 bot.

- */ - public associateBot( - args: AssociateBotCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public associateBot(args: AssociateBotCommandInput, cb: (err: any, data?: AssociateBotCommandOutput) => void): void; - public associateBot( + + /** + * @see {@link AssociateBotCommand} + */ + associateBot(args: AssociateBotCommandInput, options?: __HttpHandlerOptions): Promise; + associateBot(args: AssociateBotCommandInput, cb: (err: any, data?: AssociateBotCommandOutput) => void): void; + associateBot( args: AssociateBotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateBotCommandOutput) => void ): void; - public associateBot( - args: AssociateBotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateBotCommandOutput) => void), - cb?: (err: any, data?: AssociateBotCommandOutput) => void - ): Promise | void { - const command = new AssociateBotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call - * and real-time analysis sessions for the given language.

- */ - public associateDefaultVocabulary( + + /** + * @see {@link AssociateDefaultVocabularyCommand} + */ + associateDefaultVocabulary( args: AssociateDefaultVocabularyCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateDefaultVocabulary( + associateDefaultVocabulary( args: AssociateDefaultVocabularyCommandInput, cb: (err: any, data?: AssociateDefaultVocabularyCommandOutput) => void ): void; - public associateDefaultVocabulary( + associateDefaultVocabulary( args: AssociateDefaultVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateDefaultVocabularyCommandOutput) => void ): void; - public associateDefaultVocabulary( - args: AssociateDefaultVocabularyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateDefaultVocabularyCommandOutput) => void), - cb?: (err: any, data?: AssociateDefaultVocabularyCommandOutput) => void - ): Promise | void { - const command = new AssociateDefaultVocabularyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Associates a storage resource type for the first time. You can only associate one type of - * storage configuration in a single call. This means, for example, that you can't define an - * instance with multiple S3 buckets for storing chat transcripts.

- *

This API does not create a resource that doesn't exist. It only associates it to the - * instance. Ensure that the resource being specified in the storage configuration, like an S3 - * bucket, exists when being used for association.

- */ - public associateInstanceStorageConfig( + + /** + * @see {@link AssociateInstanceStorageConfigCommand} + */ + associateInstanceStorageConfig( args: AssociateInstanceStorageConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateInstanceStorageConfig( + associateInstanceStorageConfig( args: AssociateInstanceStorageConfigCommandInput, cb: (err: any, data?: AssociateInstanceStorageConfigCommandOutput) => void ): void; - public associateInstanceStorageConfig( + associateInstanceStorageConfig( args: AssociateInstanceStorageConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateInstanceStorageConfigCommandOutput) => void ): void; - public associateInstanceStorageConfig( - args: AssociateInstanceStorageConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateInstanceStorageConfigCommandOutput) => void), - cb?: (err: any, data?: AssociateInstanceStorageConfigCommandOutput) => void - ): Promise | void { - const command = new AssociateInstanceStorageConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Allows the specified Amazon Connect instance to access the specified Lambda - * function.

- */ - public associateLambdaFunction( + + /** + * @see {@link AssociateLambdaFunctionCommand} + */ + associateLambdaFunction( args: AssociateLambdaFunctionCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateLambdaFunction( + associateLambdaFunction( args: AssociateLambdaFunctionCommandInput, cb: (err: any, data?: AssociateLambdaFunctionCommandOutput) => void ): void; - public associateLambdaFunction( + associateLambdaFunction( args: AssociateLambdaFunctionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateLambdaFunctionCommandOutput) => void ): void; - public associateLambdaFunction( - args: AssociateLambdaFunctionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateLambdaFunctionCommandOutput) => void), - cb?: (err: any, data?: AssociateLambdaFunctionCommandOutput) => void - ): Promise | void { - const command = new AssociateLambdaFunctionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Allows the specified Amazon Connect instance to access the specified Amazon Lex - * V1 bot. This API only supports the association of Amazon Lex V1 bots.

- */ - public associateLexBot( + + /** + * @see {@link AssociateLexBotCommand} + */ + associateLexBot( args: AssociateLexBotCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateLexBot( - args: AssociateLexBotCommandInput, - cb: (err: any, data?: AssociateLexBotCommandOutput) => void - ): void; - public associateLexBot( + associateLexBot(args: AssociateLexBotCommandInput, cb: (err: any, data?: AssociateLexBotCommandOutput) => void): void; + associateLexBot( args: AssociateLexBotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateLexBotCommandOutput) => void ): void; - public associateLexBot( - args: AssociateLexBotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateLexBotCommandOutput) => void), - cb?: (err: any, data?: AssociateLexBotCommandOutput) => void - ): Promise | void { - const command = new AssociateLexBotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a flow with a phone number claimed to your Amazon Connect instance.

- * - *

If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the - * Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number - * ARN or UUID value for the PhoneNumberId URI request parameter. However, if the - * number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate - * Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. - * If a UUID is provided - * in - * this scenario, you will receive a - * ResourceNotFoundException.

- *
- */ - public associatePhoneNumberContactFlow( + + /** + * @see {@link AssociatePhoneNumberContactFlowCommand} + */ + associatePhoneNumberContactFlow( args: AssociatePhoneNumberContactFlowCommandInput, options?: __HttpHandlerOptions ): Promise; - public associatePhoneNumberContactFlow( + associatePhoneNumberContactFlow( args: AssociatePhoneNumberContactFlowCommandInput, cb: (err: any, data?: AssociatePhoneNumberContactFlowCommandOutput) => void ): void; - public associatePhoneNumberContactFlow( + associatePhoneNumberContactFlow( args: AssociatePhoneNumberContactFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociatePhoneNumberContactFlowCommandOutput) => void ): void; - public associatePhoneNumberContactFlow( - args: AssociatePhoneNumberContactFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociatePhoneNumberContactFlowCommandOutput) => void), - cb?: (err: any, data?: AssociatePhoneNumberContactFlowCommandOutput) => void - ): Promise | void { - const command = new AssociatePhoneNumberContactFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Associates a set of quick connects with a queue.

- */ - public associateQueueQuickConnects( + + /** + * @see {@link AssociateQueueQuickConnectsCommand} + */ + associateQueueQuickConnects( args: AssociateQueueQuickConnectsCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateQueueQuickConnects( + associateQueueQuickConnects( args: AssociateQueueQuickConnectsCommandInput, cb: (err: any, data?: AssociateQueueQuickConnectsCommandOutput) => void ): void; - public associateQueueQuickConnects( + associateQueueQuickConnects( args: AssociateQueueQuickConnectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateQueueQuickConnectsCommandOutput) => void ): void; - public associateQueueQuickConnects( - args: AssociateQueueQuickConnectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateQueueQuickConnectsCommandOutput) => void), - cb?: (err: any, data?: AssociateQueueQuickConnectsCommandOutput) => void - ): Promise | void { - const command = new AssociateQueueQuickConnectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a set of queues with a routing profile.

- */ - public associateRoutingProfileQueues( + + /** + * @see {@link AssociateRoutingProfileQueuesCommand} + */ + associateRoutingProfileQueues( args: AssociateRoutingProfileQueuesCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateRoutingProfileQueues( + associateRoutingProfileQueues( args: AssociateRoutingProfileQueuesCommandInput, cb: (err: any, data?: AssociateRoutingProfileQueuesCommandOutput) => void ): void; - public associateRoutingProfileQueues( + associateRoutingProfileQueues( args: AssociateRoutingProfileQueuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateRoutingProfileQueuesCommandOutput) => void ): void; - public associateRoutingProfileQueues( - args: AssociateRoutingProfileQueuesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateRoutingProfileQueuesCommandOutput) => void), - cb?: (err: any, data?: AssociateRoutingProfileQueuesCommandOutput) => void - ): Promise | void { - const command = new AssociateRoutingProfileQueuesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Associates a security key to the instance.

- */ - public associateSecurityKey( + + /** + * @see {@link AssociateSecurityKeyCommand} + */ + associateSecurityKey( args: AssociateSecurityKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateSecurityKey( + associateSecurityKey( args: AssociateSecurityKeyCommandInput, cb: (err: any, data?: AssociateSecurityKeyCommandOutput) => void ): void; - public associateSecurityKey( + associateSecurityKey( args: AssociateSecurityKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateSecurityKeyCommandOutput) => void ): void; - public associateSecurityKey( - args: AssociateSecurityKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateSecurityKeyCommandOutput) => void), - cb?: (err: any, data?: AssociateSecurityKeyCommandOutput) => void - ): Promise | void { - const command = new AssociateSecurityKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Claims an available phone number to your Amazon Connect instance or traffic distribution - * group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.

- *

For more information about how to use this operation, see Claim a phone number in your - * country and Claim phone - * numbers to traffic distribution groups in the Amazon Connect Administrator - * Guide.

- * - *

You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call - * the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber - * operation.

- *
- */ - public claimPhoneNumber( + + /** + * @see {@link ClaimPhoneNumberCommand} + */ + claimPhoneNumber( args: ClaimPhoneNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public claimPhoneNumber( + claimPhoneNumber( args: ClaimPhoneNumberCommandInput, cb: (err: any, data?: ClaimPhoneNumberCommandOutput) => void ): void; - public claimPhoneNumber( + claimPhoneNumber( args: ClaimPhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ClaimPhoneNumberCommandOutput) => void ): void; - public claimPhoneNumber( - args: ClaimPhoneNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ClaimPhoneNumberCommandOutput) => void), - cb?: (err: any, data?: ClaimPhoneNumberCommandOutput) => void - ): Promise | void { - const command = new ClaimPhoneNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Creates an agent status for the specified Amazon Connect instance.

- */ - public createAgentStatus( + + /** + * @see {@link CreateAgentStatusCommand} + */ + createAgentStatus( args: CreateAgentStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAgentStatus( + createAgentStatus( args: CreateAgentStatusCommandInput, cb: (err: any, data?: CreateAgentStatusCommandOutput) => void ): void; - public createAgentStatus( + createAgentStatus( args: CreateAgentStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAgentStatusCommandOutput) => void ): void; - public createAgentStatus( - args: CreateAgentStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAgentStatusCommandOutput) => void), - cb?: (err: any, data?: CreateAgentStatusCommandOutput) => void - ): Promise | void { - const command = new CreateAgentStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a flow for the specified Amazon Connect instance.

- *

You can also create and update flows using the Amazon Connect - * Flow language.

- */ - public createContactFlow( + + /** + * @see {@link CreateContactFlowCommand} + */ + createContactFlow( args: CreateContactFlowCommandInput, options?: __HttpHandlerOptions ): Promise; - public createContactFlow( + createContactFlow( args: CreateContactFlowCommandInput, cb: (err: any, data?: CreateContactFlowCommandOutput) => void ): void; - public createContactFlow( + createContactFlow( args: CreateContactFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateContactFlowCommandOutput) => void ): void; - public createContactFlow( - args: CreateContactFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateContactFlowCommandOutput) => void), - cb?: (err: any, data?: CreateContactFlowCommandOutput) => void - ): Promise | void { - const command = new CreateContactFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a flow module for the specified Amazon Connect instance.

- */ - public createContactFlowModule( + + /** + * @see {@link CreateContactFlowModuleCommand} + */ + createContactFlowModule( args: CreateContactFlowModuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createContactFlowModule( + createContactFlowModule( args: CreateContactFlowModuleCommandInput, cb: (err: any, data?: CreateContactFlowModuleCommandOutput) => void ): void; - public createContactFlowModule( + createContactFlowModule( args: CreateContactFlowModuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateContactFlowModuleCommandOutput) => void ): void; - public createContactFlowModule( - args: CreateContactFlowModuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateContactFlowModuleCommandOutput) => void), - cb?: (err: any, data?: CreateContactFlowModuleCommandOutput) => void - ): Promise | void { - const command = new CreateContactFlowModuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Creates hours of operation.

- */ - public createHoursOfOperation( + + /** + * @see {@link CreateHoursOfOperationCommand} + */ + createHoursOfOperation( args: CreateHoursOfOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createHoursOfOperation( + createHoursOfOperation( args: CreateHoursOfOperationCommandInput, cb: (err: any, data?: CreateHoursOfOperationCommandOutput) => void ): void; - public createHoursOfOperation( + createHoursOfOperation( args: CreateHoursOfOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHoursOfOperationCommandOutput) => void ): void; - public createHoursOfOperation( - args: CreateHoursOfOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateHoursOfOperationCommandOutput) => void), - cb?: (err: any, data?: CreateHoursOfOperationCommandOutput) => void - ): Promise | void { - const command = new CreateHoursOfOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Initiates an Amazon Connect instance with all the supported channels enabled. It does - * not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It - * also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.

- *

Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. - * If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. - * You must wait 30 days before you can restart creating and deleting instances in your account.

- */ - public createInstance( + + /** + * @see {@link CreateInstanceCommand} + */ + createInstance( args: CreateInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createInstance( - args: CreateInstanceCommandInput, - cb: (err: any, data?: CreateInstanceCommandOutput) => void - ): void; - public createInstance( + createInstance(args: CreateInstanceCommandInput, cb: (err: any, data?: CreateInstanceCommandOutput) => void): void; + createInstance( args: CreateInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInstanceCommandOutput) => void ): void; - public createInstance( - args: CreateInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateInstanceCommandOutput) => void), - cb?: (err: any, data?: CreateInstanceCommandOutput) => void - ): Promise | void { - const command = new CreateInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon Web Services resource association with an Amazon Connect - * instance.

- */ - public createIntegrationAssociation( + + /** + * @see {@link CreateIntegrationAssociationCommand} + */ + createIntegrationAssociation( args: CreateIntegrationAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createIntegrationAssociation( + createIntegrationAssociation( args: CreateIntegrationAssociationCommandInput, cb: (err: any, data?: CreateIntegrationAssociationCommandOutput) => void ): void; - public createIntegrationAssociation( + createIntegrationAssociation( args: CreateIntegrationAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIntegrationAssociationCommandOutput) => void ): void; - public createIntegrationAssociation( - args: CreateIntegrationAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIntegrationAssociationCommandOutput) => void), - cb?: (err: any, data?: CreateIntegrationAssociationCommandOutput) => void - ): Promise | void { - const command = new CreateIntegrationAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Creates a new queue for the specified Amazon Connect instance.

- * - *

If the number being used in the input is claimed to a traffic distribution group, and you are calling this API - * using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use - * either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value - * of the OutboundCallerConfig request body parameter. However, if the number is claimed to a - * traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region - * associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided - * in - * this scenario, you will receive a - * ResourceNotFoundException.

- *
- */ - public createQueue(args: CreateQueueCommandInput, options?: __HttpHandlerOptions): Promise; - public createQueue(args: CreateQueueCommandInput, cb: (err: any, data?: CreateQueueCommandOutput) => void): void; - public createQueue( + + /** + * @see {@link CreateQueueCommand} + */ + createQueue(args: CreateQueueCommandInput, options?: __HttpHandlerOptions): Promise; + createQueue(args: CreateQueueCommandInput, cb: (err: any, data?: CreateQueueCommandOutput) => void): void; + createQueue( args: CreateQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateQueueCommandOutput) => void ): void; - public createQueue( - args: CreateQueueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateQueueCommandOutput) => void), - cb?: (err: any, data?: CreateQueueCommandOutput) => void - ): Promise | void { - const command = new CreateQueueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a quick connect for the specified Amazon Connect instance.

- */ - public createQuickConnect( + + /** + * @see {@link CreateQuickConnectCommand} + */ + createQuickConnect( args: CreateQuickConnectCommandInput, options?: __HttpHandlerOptions ): Promise; - public createQuickConnect( + createQuickConnect( args: CreateQuickConnectCommandInput, cb: (err: any, data?: CreateQuickConnectCommandOutput) => void ): void; - public createQuickConnect( + createQuickConnect( args: CreateQuickConnectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateQuickConnectCommandOutput) => void ): void; - public createQuickConnect( - args: CreateQuickConnectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateQuickConnectCommandOutput) => void), - cb?: (err: any, data?: CreateQuickConnectCommandOutput) => void - ): Promise | void { - const command = new CreateQuickConnectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new routing profile.

- */ - public createRoutingProfile( + + /** + * @see {@link CreateRoutingProfileCommand} + */ + createRoutingProfile( args: CreateRoutingProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRoutingProfile( + createRoutingProfile( args: CreateRoutingProfileCommandInput, cb: (err: any, data?: CreateRoutingProfileCommandOutput) => void ): void; - public createRoutingProfile( + createRoutingProfile( args: CreateRoutingProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRoutingProfileCommandOutput) => void ): void; - public createRoutingProfile( - args: CreateRoutingProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRoutingProfileCommandOutput) => void), - cb?: (err: any, data?: CreateRoutingProfileCommandOutput) => void - ): Promise | void { - const command = new CreateRoutingProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a rule for the specified Amazon Connect instance.

- *

Use the Rules Function language to - * code conditions for the rule.

- */ - public createRule(args: CreateRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public createRule(args: CreateRuleCommandInput, cb: (err: any, data?: CreateRuleCommandOutput) => void): void; - public createRule( + + /** + * @see {@link CreateRuleCommand} + */ + createRule(args: CreateRuleCommandInput, options?: __HttpHandlerOptions): Promise; + createRule(args: CreateRuleCommandInput, cb: (err: any, data?: CreateRuleCommandOutput) => void): void; + createRule( args: CreateRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRuleCommandOutput) => void ): void; - public createRule( - args: CreateRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRuleCommandOutput) => void), - cb?: (err: any, data?: CreateRuleCommandOutput) => void - ): Promise | void { - const command = new CreateRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Creates a security profile.

- */ - public createSecurityProfile( + + /** + * @see {@link CreateSecurityProfileCommand} + */ + createSecurityProfile( args: CreateSecurityProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSecurityProfile( + createSecurityProfile( args: CreateSecurityProfileCommandInput, cb: (err: any, data?: CreateSecurityProfileCommandOutput) => void ): void; - public createSecurityProfile( + createSecurityProfile( args: CreateSecurityProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSecurityProfileCommandOutput) => void ): void; - public createSecurityProfile( - args: CreateSecurityProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSecurityProfileCommandOutput) => void), - cb?: (err: any, data?: CreateSecurityProfileCommandOutput) => void - ): Promise | void { - const command = new CreateSecurityProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new task template in the specified Amazon Connect instance.

- */ - public createTaskTemplate( + + /** + * @see {@link CreateTaskTemplateCommand} + */ + createTaskTemplate( args: CreateTaskTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTaskTemplate( + createTaskTemplate( args: CreateTaskTemplateCommandInput, cb: (err: any, data?: CreateTaskTemplateCommandOutput) => void ): void; - public createTaskTemplate( + createTaskTemplate( args: CreateTaskTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTaskTemplateCommandOutput) => void ): void; - public createTaskTemplate( - args: CreateTaskTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTaskTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateTaskTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateTaskTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a traffic distribution group given an Amazon Connect instance that has been replicated.

- *

For more information about creating traffic distribution groups, see Set up traffic distribution groups in - * the Amazon Connect Administrator Guide.

- */ - public createTrafficDistributionGroup( + + /** + * @see {@link CreateTrafficDistributionGroupCommand} + */ + createTrafficDistributionGroup( args: CreateTrafficDistributionGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTrafficDistributionGroup( + createTrafficDistributionGroup( args: CreateTrafficDistributionGroupCommandInput, cb: (err: any, data?: CreateTrafficDistributionGroupCommandOutput) => void ): void; - public createTrafficDistributionGroup( + createTrafficDistributionGroup( args: CreateTrafficDistributionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTrafficDistributionGroupCommandOutput) => void ): void; - public createTrafficDistributionGroup( - args: CreateTrafficDistributionGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTrafficDistributionGroupCommandOutput) => void), - cb?: (err: any, data?: CreateTrafficDistributionGroupCommandOutput) => void - ): Promise | void { - const command = new CreateTrafficDistributionGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a use case for an integration association.

- */ - public createUseCase( - args: CreateUseCaseCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createUseCase( - args: CreateUseCaseCommandInput, - cb: (err: any, data?: CreateUseCaseCommandOutput) => void - ): void; - public createUseCase( + + /** + * @see {@link CreateUseCaseCommand} + */ + createUseCase(args: CreateUseCaseCommandInput, options?: __HttpHandlerOptions): Promise; + createUseCase(args: CreateUseCaseCommandInput, cb: (err: any, data?: CreateUseCaseCommandOutput) => void): void; + createUseCase( args: CreateUseCaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUseCaseCommandOutput) => void ): void; - public createUseCase( - args: CreateUseCaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUseCaseCommandOutput) => void), - cb?: (err: any, data?: CreateUseCaseCommandOutput) => void - ): Promise | void { - const command = new CreateUseCaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a user account for the specified Amazon Connect instance.

- *

For information about how to create user accounts using the Amazon Connect console, see - * Add - * Users in the Amazon Connect Administrator Guide.

- */ - public createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; - public createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; - public createUser( + + /** + * @see {@link CreateUserCommand} + */ + createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; + createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; + createUser( args: CreateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserCommandOutput) => void ): void; - public createUser( - args: CreateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserCommandOutput) => void), - cb?: (err: any, data?: CreateUserCommandOutput) => void - ): Promise | void { - const command = new CreateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new user hierarchy group.

- */ - public createUserHierarchyGroup( + + /** + * @see {@link CreateUserHierarchyGroupCommand} + */ + createUserHierarchyGroup( args: CreateUserHierarchyGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createUserHierarchyGroup( + createUserHierarchyGroup( args: CreateUserHierarchyGroupCommandInput, cb: (err: any, data?: CreateUserHierarchyGroupCommandOutput) => void ): void; - public createUserHierarchyGroup( + createUserHierarchyGroup( args: CreateUserHierarchyGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserHierarchyGroupCommandOutput) => void ): void; - public createUserHierarchyGroup( - args: CreateUserHierarchyGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserHierarchyGroupCommandOutput) => void), - cb?: (err: any, data?: CreateUserHierarchyGroupCommandOutput) => void - ): Promise | void { - const command = new CreateUserHierarchyGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a custom vocabulary associated with your Amazon Connect instance. You can set a - * custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default - * vocabulary in post-call and real-time contact analysis sessions for that language.

- */ - public createVocabulary( + + /** + * @see {@link CreateVocabularyCommand} + */ + createVocabulary( args: CreateVocabularyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVocabulary( + createVocabulary( args: CreateVocabularyCommandInput, cb: (err: any, data?: CreateVocabularyCommandOutput) => void ): void; - public createVocabulary( + createVocabulary( args: CreateVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVocabularyCommandOutput) => void ): void; - public createVocabulary( - args: CreateVocabularyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVocabularyCommandOutput) => void), - cb?: (err: any, data?: CreateVocabularyCommandOutput) => void - ): Promise | void { - const command = new CreateVocabularyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a flow for the specified Amazon Connect instance.

- */ - public deleteContactFlow( + + /** + * @see {@link DeleteContactFlowCommand} + */ + deleteContactFlow( args: DeleteContactFlowCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteContactFlow( + deleteContactFlow( args: DeleteContactFlowCommandInput, cb: (err: any, data?: DeleteContactFlowCommandOutput) => void ): void; - public deleteContactFlow( + deleteContactFlow( args: DeleteContactFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteContactFlowCommandOutput) => void ): void; - public deleteContactFlow( - args: DeleteContactFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteContactFlowCommandOutput) => void), - cb?: (err: any, data?: DeleteContactFlowCommandOutput) => void - ): Promise | void { - const command = new DeleteContactFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified flow module.

- */ - public deleteContactFlowModule( + + /** + * @see {@link DeleteContactFlowModuleCommand} + */ + deleteContactFlowModule( args: DeleteContactFlowModuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteContactFlowModule( + deleteContactFlowModule( args: DeleteContactFlowModuleCommandInput, cb: (err: any, data?: DeleteContactFlowModuleCommandOutput) => void ): void; - public deleteContactFlowModule( + deleteContactFlowModule( args: DeleteContactFlowModuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteContactFlowModuleCommandOutput) => void ): void; - public deleteContactFlowModule( - args: DeleteContactFlowModuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteContactFlowModuleCommandOutput) => void), - cb?: (err: any, data?: DeleteContactFlowModuleCommandOutput) => void - ): Promise | void { - const command = new DeleteContactFlowModuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Deletes an hours of operation.

- */ - public deleteHoursOfOperation( + + /** + * @see {@link DeleteHoursOfOperationCommand} + */ + deleteHoursOfOperation( args: DeleteHoursOfOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteHoursOfOperation( + deleteHoursOfOperation( args: DeleteHoursOfOperationCommandInput, cb: (err: any, data?: DeleteHoursOfOperationCommandOutput) => void ): void; - public deleteHoursOfOperation( + deleteHoursOfOperation( args: DeleteHoursOfOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHoursOfOperationCommandOutput) => void ): void; - public deleteHoursOfOperation( - args: DeleteHoursOfOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteHoursOfOperationCommandOutput) => void), - cb?: (err: any, data?: DeleteHoursOfOperationCommandOutput) => void - ): Promise | void { - const command = new DeleteHoursOfOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Deletes the Amazon Connect instance.

- *

Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. - * If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. - * You must wait 30 days before you can restart creating and deleting instances in your account.

- */ - public deleteInstance( + + /** + * @see {@link DeleteInstanceCommand} + */ + deleteInstance( args: DeleteInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInstance( - args: DeleteInstanceCommandInput, - cb: (err: any, data?: DeleteInstanceCommandOutput) => void - ): void; - public deleteInstance( + deleteInstance(args: DeleteInstanceCommandInput, cb: (err: any, data?: DeleteInstanceCommandOutput) => void): void; + deleteInstance( args: DeleteInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInstanceCommandOutput) => void ): void; - public deleteInstance( - args: DeleteInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInstanceCommandOutput) => void), - cb?: (err: any, data?: DeleteInstanceCommandOutput) => void - ): Promise | void { - const command = new DeleteInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an Amazon Web Services resource association from an Amazon Connect instance. The - * association must not have any use cases associated with it.

- */ - public deleteIntegrationAssociation( + + /** + * @see {@link DeleteIntegrationAssociationCommand} + */ + deleteIntegrationAssociation( args: DeleteIntegrationAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteIntegrationAssociation( + deleteIntegrationAssociation( args: DeleteIntegrationAssociationCommandInput, cb: (err: any, data?: DeleteIntegrationAssociationCommandOutput) => void ): void; - public deleteIntegrationAssociation( + deleteIntegrationAssociation( args: DeleteIntegrationAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIntegrationAssociationCommandOutput) => void ): void; - public deleteIntegrationAssociation( - args: DeleteIntegrationAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIntegrationAssociationCommandOutput) => void), - cb?: (err: any, data?: DeleteIntegrationAssociationCommandOutput) => void - ): Promise | void { - const command = new DeleteIntegrationAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a quick connect.

- */ - public deleteQuickConnect( + + /** + * @see {@link DeleteQuickConnectCommand} + */ + deleteQuickConnect( args: DeleteQuickConnectCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteQuickConnect( + deleteQuickConnect( args: DeleteQuickConnectCommandInput, cb: (err: any, data?: DeleteQuickConnectCommandOutput) => void ): void; - public deleteQuickConnect( + deleteQuickConnect( args: DeleteQuickConnectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteQuickConnectCommandOutput) => void ): void; - public deleteQuickConnect( - args: DeleteQuickConnectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteQuickConnectCommandOutput) => void), - cb?: (err: any, data?: DeleteQuickConnectCommandOutput) => void - ): Promise | void { - const command = new DeleteQuickConnectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a rule for the specified Amazon Connect instance.

- */ - public deleteRule(args: DeleteRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteRule(args: DeleteRuleCommandInput, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void; - public deleteRule( + + /** + * @see {@link DeleteRuleCommand} + */ + deleteRule(args: DeleteRuleCommandInput, options?: __HttpHandlerOptions): Promise; + deleteRule(args: DeleteRuleCommandInput, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void; + deleteRule( args: DeleteRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRuleCommandOutput) => void ): void; - public deleteRule( - args: DeleteRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Deletes a security profile.

- */ - public deleteSecurityProfile( + + /** + * @see {@link DeleteSecurityProfileCommand} + */ + deleteSecurityProfile( args: DeleteSecurityProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSecurityProfile( + deleteSecurityProfile( args: DeleteSecurityProfileCommandInput, cb: (err: any, data?: DeleteSecurityProfileCommandOutput) => void ): void; - public deleteSecurityProfile( + deleteSecurityProfile( args: DeleteSecurityProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSecurityProfileCommandOutput) => void ): void; - public deleteSecurityProfile( - args: DeleteSecurityProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSecurityProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteSecurityProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteSecurityProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the task template.

- */ - public deleteTaskTemplate( + + /** + * @see {@link DeleteTaskTemplateCommand} + */ + deleteTaskTemplate( args: DeleteTaskTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTaskTemplate( + deleteTaskTemplate( args: DeleteTaskTemplateCommandInput, cb: (err: any, data?: DeleteTaskTemplateCommandOutput) => void ): void; - public deleteTaskTemplate( + deleteTaskTemplate( args: DeleteTaskTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTaskTemplateCommandOutput) => void ): void; - public deleteTaskTemplate( - args: DeleteTaskTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTaskTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteTaskTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteTaskTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is - * created.

- *

For more information about deleting traffic distribution groups, see Delete traffic distribution groups in - * the Amazon Connect Administrator Guide.

- */ - public deleteTrafficDistributionGroup( + + /** + * @see {@link DeleteTrafficDistributionGroupCommand} + */ + deleteTrafficDistributionGroup( args: DeleteTrafficDistributionGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTrafficDistributionGroup( + deleteTrafficDistributionGroup( args: DeleteTrafficDistributionGroupCommandInput, cb: (err: any, data?: DeleteTrafficDistributionGroupCommandOutput) => void ): void; - public deleteTrafficDistributionGroup( + deleteTrafficDistributionGroup( args: DeleteTrafficDistributionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTrafficDistributionGroupCommandOutput) => void ): void; - public deleteTrafficDistributionGroup( - args: DeleteTrafficDistributionGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTrafficDistributionGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteTrafficDistributionGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteTrafficDistributionGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a use case from an integration association.

- */ - public deleteUseCase( - args: DeleteUseCaseCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteUseCase( - args: DeleteUseCaseCommandInput, - cb: (err: any, data?: DeleteUseCaseCommandOutput) => void - ): void; - public deleteUseCase( + + /** + * @see {@link DeleteUseCaseCommand} + */ + deleteUseCase(args: DeleteUseCaseCommandInput, options?: __HttpHandlerOptions): Promise; + deleteUseCase(args: DeleteUseCaseCommandInput, cb: (err: any, data?: DeleteUseCaseCommandOutput) => void): void; + deleteUseCase( args: DeleteUseCaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUseCaseCommandOutput) => void ): void; - public deleteUseCase( - args: DeleteUseCaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUseCaseCommandOutput) => void), - cb?: (err: any, data?: DeleteUseCaseCommandOutput) => void - ): Promise | void { - const command = new DeleteUseCaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a user account from the specified Amazon Connect instance.

- *

For information about what happens to a user's data when their account is deleted, see - * Delete Users from - * Your Amazon Connect Instance in the Amazon Connect Administrator - * Guide.

- */ - public deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; - public deleteUser( + + /** + * @see {@link DeleteUserCommand} + */ + deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; + deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; + deleteUser( args: DeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserCommandOutput) => void ): void; - public deleteUser( - args: DeleteUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserCommandOutput) => void), - cb?: (err: any, data?: DeleteUserCommandOutput) => void - ): Promise | void { - const command = new DeleteUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an existing user hierarchy group. It must not be associated with any agents or have - * any active child groups.

- */ - public deleteUserHierarchyGroup( + + /** + * @see {@link DeleteUserHierarchyGroupCommand} + */ + deleteUserHierarchyGroup( args: DeleteUserHierarchyGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteUserHierarchyGroup( + deleteUserHierarchyGroup( args: DeleteUserHierarchyGroupCommandInput, cb: (err: any, data?: DeleteUserHierarchyGroupCommandOutput) => void ): void; - public deleteUserHierarchyGroup( + deleteUserHierarchyGroup( args: DeleteUserHierarchyGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserHierarchyGroupCommandOutput) => void ): void; - public deleteUserHierarchyGroup( - args: DeleteUserHierarchyGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserHierarchyGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteUserHierarchyGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteUserHierarchyGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the vocabulary that has the given identifier.

- */ - public deleteVocabulary( + + /** + * @see {@link DeleteVocabularyCommand} + */ + deleteVocabulary( args: DeleteVocabularyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVocabulary( + deleteVocabulary( args: DeleteVocabularyCommandInput, cb: (err: any, data?: DeleteVocabularyCommandOutput) => void ): void; - public deleteVocabulary( + deleteVocabulary( args: DeleteVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVocabularyCommandOutput) => void ): void; - public deleteVocabulary( - args: DeleteVocabularyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVocabularyCommandOutput) => void), - cb?: (err: any, data?: DeleteVocabularyCommandOutput) => void - ): Promise | void { - const command = new DeleteVocabularyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Describes an agent status.

- */ - public describeAgentStatus( + + /** + * @see {@link DescribeAgentStatusCommand} + */ + describeAgentStatus( args: DescribeAgentStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAgentStatus( + describeAgentStatus( args: DescribeAgentStatusCommandInput, cb: (err: any, data?: DescribeAgentStatusCommandOutput) => void ): void; - public describeAgentStatus( + describeAgentStatus( args: DescribeAgentStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAgentStatusCommandOutput) => void ): void; - public describeAgentStatus( - args: DescribeAgentStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAgentStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeAgentStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeAgentStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Describes the specified contact.

- * - *

Contact information remains available in Amazon Connect for 24 months, and then it is - * deleted.

- *

Only data from November 12, 2021, and later is returned by this - * API.

- *
- */ - public describeContact( + + /** + * @see {@link DescribeContactCommand} + */ + describeContact( args: DescribeContactCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeContact( - args: DescribeContactCommandInput, - cb: (err: any, data?: DescribeContactCommandOutput) => void - ): void; - public describeContact( + describeContact(args: DescribeContactCommandInput, cb: (err: any, data?: DescribeContactCommandOutput) => void): void; + describeContact( args: DescribeContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeContactCommandOutput) => void ): void; - public describeContact( - args: DescribeContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeContactCommandOutput) => void), - cb?: (err: any, data?: DescribeContactCommandOutput) => void - ): Promise | void { - const command = new DescribeContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified flow.

- *

You can also create and update flows using the Amazon Connect - * Flow language.

- */ - public describeContactFlow( + + /** + * @see {@link DescribeContactFlowCommand} + */ + describeContactFlow( args: DescribeContactFlowCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeContactFlow( + describeContactFlow( args: DescribeContactFlowCommandInput, cb: (err: any, data?: DescribeContactFlowCommandOutput) => void ): void; - public describeContactFlow( + describeContactFlow( args: DescribeContactFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeContactFlowCommandOutput) => void ): void; - public describeContactFlow( - args: DescribeContactFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeContactFlowCommandOutput) => void), - cb?: (err: any, data?: DescribeContactFlowCommandOutput) => void - ): Promise | void { - const command = new DescribeContactFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified flow module.

- */ - public describeContactFlowModule( + + /** + * @see {@link DescribeContactFlowModuleCommand} + */ + describeContactFlowModule( args: DescribeContactFlowModuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeContactFlowModule( + describeContactFlowModule( args: DescribeContactFlowModuleCommandInput, cb: (err: any, data?: DescribeContactFlowModuleCommandOutput) => void ): void; - public describeContactFlowModule( + describeContactFlowModule( args: DescribeContactFlowModuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeContactFlowModuleCommandOutput) => void ): void; - public describeContactFlowModule( - args: DescribeContactFlowModuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeContactFlowModuleCommandOutput) => void), - cb?: (err: any, data?: DescribeContactFlowModuleCommandOutput) => void - ): Promise | void { - const command = new DescribeContactFlowModuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Describes the hours of operation.

- */ - public describeHoursOfOperation( + + /** + * @see {@link DescribeHoursOfOperationCommand} + */ + describeHoursOfOperation( args: DescribeHoursOfOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeHoursOfOperation( + describeHoursOfOperation( args: DescribeHoursOfOperationCommandInput, cb: (err: any, data?: DescribeHoursOfOperationCommandOutput) => void ): void; - public describeHoursOfOperation( + describeHoursOfOperation( args: DescribeHoursOfOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHoursOfOperationCommandOutput) => void ): void; - public describeHoursOfOperation( - args: DescribeHoursOfOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeHoursOfOperationCommandOutput) => void), - cb?: (err: any, data?: DescribeHoursOfOperationCommandOutput) => void - ): Promise | void { - const command = new DescribeHoursOfOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Returns the current state of the specified instance identifier. It tracks the instance while - * it is being created and returns an error status, if applicable.

- *

If an instance is not created successfully, the instance status reason field returns details - * relevant to the reason. The instance in a failed state is returned only for 24 hours after the - * CreateInstance API was invoked.

- */ - public describeInstance( + + /** + * @see {@link DescribeInstanceCommand} + */ + describeInstance( args: DescribeInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInstance( + describeInstance( args: DescribeInstanceCommandInput, cb: (err: any, data?: DescribeInstanceCommandOutput) => void ): void; - public describeInstance( + describeInstance( args: DescribeInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstanceCommandOutput) => void ): void; - public describeInstance( - args: DescribeInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInstanceCommandOutput) => void), - cb?: (err: any, data?: DescribeInstanceCommandOutput) => void - ): Promise | void { - const command = new DescribeInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Describes the specified instance attribute.

- */ - public describeInstanceAttribute( + + /** + * @see {@link DescribeInstanceAttributeCommand} + */ + describeInstanceAttribute( args: DescribeInstanceAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInstanceAttribute( + describeInstanceAttribute( args: DescribeInstanceAttributeCommandInput, cb: (err: any, data?: DescribeInstanceAttributeCommandOutput) => void ): void; - public describeInstanceAttribute( + describeInstanceAttribute( args: DescribeInstanceAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstanceAttributeCommandOutput) => void ): void; - public describeInstanceAttribute( - args: DescribeInstanceAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInstanceAttributeCommandOutput) => void), - cb?: (err: any, data?: DescribeInstanceAttributeCommandOutput) => void - ): Promise | void { - const command = new DescribeInstanceAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Retrieves the current storage configurations for the specified resource type, association - * ID, and instance ID.

- */ - public describeInstanceStorageConfig( + + /** + * @see {@link DescribeInstanceStorageConfigCommand} + */ + describeInstanceStorageConfig( args: DescribeInstanceStorageConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInstanceStorageConfig( + describeInstanceStorageConfig( args: DescribeInstanceStorageConfigCommandInput, cb: (err: any, data?: DescribeInstanceStorageConfigCommandOutput) => void ): void; - public describeInstanceStorageConfig( + describeInstanceStorageConfig( args: DescribeInstanceStorageConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstanceStorageConfigCommandOutput) => void ): void; - public describeInstanceStorageConfig( - args: DescribeInstanceStorageConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInstanceStorageConfigCommandOutput) => void), - cb?: (err: any, data?: DescribeInstanceStorageConfigCommandOutput) => void - ): Promise | void { - const command = new DescribeInstanceStorageConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets details and status of a phone number that’s claimed to your Amazon Connect instance - * or traffic distribution group.

- * - *

If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region - * where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the - * PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group - * and you are calling this API in the alternate Amazon Web Services Region associated with the - * traffic distribution group, you must provide a full phone number ARN. If a UUID is provided - * in - * this scenario, you will receive a - * ResourceNotFoundException.

- *
- */ - public describePhoneNumber( + + /** + * @see {@link DescribePhoneNumberCommand} + */ + describePhoneNumber( args: DescribePhoneNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePhoneNumber( + describePhoneNumber( args: DescribePhoneNumberCommandInput, cb: (err: any, data?: DescribePhoneNumberCommandOutput) => void ): void; - public describePhoneNumber( + describePhoneNumber( args: DescribePhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePhoneNumberCommandOutput) => void ): void; - public describePhoneNumber( - args: DescribePhoneNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePhoneNumberCommandOutput) => void), - cb?: (err: any, data?: DescribePhoneNumberCommandOutput) => void - ): Promise | void { - const command = new DescribePhoneNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Describes the specified queue.

- */ - public describeQueue( - args: DescribeQueueCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeQueue( - args: DescribeQueueCommandInput, - cb: (err: any, data?: DescribeQueueCommandOutput) => void - ): void; - public describeQueue( + + /** + * @see {@link DescribeQueueCommand} + */ + describeQueue(args: DescribeQueueCommandInput, options?: __HttpHandlerOptions): Promise; + describeQueue(args: DescribeQueueCommandInput, cb: (err: any, data?: DescribeQueueCommandOutput) => void): void; + describeQueue( args: DescribeQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeQueueCommandOutput) => void ): void; - public describeQueue( - args: DescribeQueueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeQueueCommandOutput) => void), - cb?: (err: any, data?: DescribeQueueCommandOutput) => void - ): Promise | void { - const command = new DescribeQueueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the quick connect.

- */ - public describeQuickConnect( + + /** + * @see {@link DescribeQuickConnectCommand} + */ + describeQuickConnect( args: DescribeQuickConnectCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeQuickConnect( + describeQuickConnect( args: DescribeQuickConnectCommandInput, cb: (err: any, data?: DescribeQuickConnectCommandOutput) => void ): void; - public describeQuickConnect( + describeQuickConnect( args: DescribeQuickConnectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeQuickConnectCommandOutput) => void ): void; - public describeQuickConnect( - args: DescribeQuickConnectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeQuickConnectCommandOutput) => void), - cb?: (err: any, data?: DescribeQuickConnectCommandOutput) => void - ): Promise | void { - const command = new DescribeQuickConnectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified routing profile.

- */ - public describeRoutingProfile( + + /** + * @see {@link DescribeRoutingProfileCommand} + */ + describeRoutingProfile( args: DescribeRoutingProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRoutingProfile( + describeRoutingProfile( args: DescribeRoutingProfileCommandInput, cb: (err: any, data?: DescribeRoutingProfileCommandOutput) => void ): void; - public describeRoutingProfile( + describeRoutingProfile( args: DescribeRoutingProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRoutingProfileCommandOutput) => void ): void; - public describeRoutingProfile( - args: DescribeRoutingProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRoutingProfileCommandOutput) => void), - cb?: (err: any, data?: DescribeRoutingProfileCommandOutput) => void - ): Promise | void { - const command = new DescribeRoutingProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a rule for the specified Amazon Connect instance.

- */ - public describeRule( - args: DescribeRuleCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeRule(args: DescribeRuleCommandInput, cb: (err: any, data?: DescribeRuleCommandOutput) => void): void; - public describeRule( + + /** + * @see {@link DescribeRuleCommand} + */ + describeRule(args: DescribeRuleCommandInput, options?: __HttpHandlerOptions): Promise; + describeRule(args: DescribeRuleCommandInput, cb: (err: any, data?: DescribeRuleCommandOutput) => void): void; + describeRule( args: DescribeRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRuleCommandOutput) => void ): void; - public describeRule( - args: DescribeRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRuleCommandOutput) => void), - cb?: (err: any, data?: DescribeRuleCommandOutput) => void - ): Promise | void { - const command = new DescribeRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Gets basic information about the security profle.

- */ - public describeSecurityProfile( + + /** + * @see {@link DescribeSecurityProfileCommand} + */ + describeSecurityProfile( args: DescribeSecurityProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSecurityProfile( + describeSecurityProfile( args: DescribeSecurityProfileCommandInput, cb: (err: any, data?: DescribeSecurityProfileCommandOutput) => void ): void; - public describeSecurityProfile( + describeSecurityProfile( args: DescribeSecurityProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSecurityProfileCommandOutput) => void ): void; - public describeSecurityProfile( - args: DescribeSecurityProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSecurityProfileCommandOutput) => void), - cb?: (err: any, data?: DescribeSecurityProfileCommandOutput) => void - ): Promise | void { - const command = new DescribeSecurityProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets details and status of a traffic distribution group.

- */ - public describeTrafficDistributionGroup( + + /** + * @see {@link DescribeTrafficDistributionGroupCommand} + */ + describeTrafficDistributionGroup( args: DescribeTrafficDistributionGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTrafficDistributionGroup( + describeTrafficDistributionGroup( args: DescribeTrafficDistributionGroupCommandInput, cb: (err: any, data?: DescribeTrafficDistributionGroupCommandOutput) => void ): void; - public describeTrafficDistributionGroup( + describeTrafficDistributionGroup( args: DescribeTrafficDistributionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrafficDistributionGroupCommandOutput) => void ): void; - public describeTrafficDistributionGroup( - args: DescribeTrafficDistributionGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTrafficDistributionGroupCommandOutput) => void), - cb?: (err: any, data?: DescribeTrafficDistributionGroupCommandOutput) => void - ): Promise | void { - const command = new DescribeTrafficDistributionGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified user account. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the - * user IDs. Instead, list the users and note the IDs provided in the output.

- */ - public describeUser( - args: DescribeUserCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeUser(args: DescribeUserCommandInput, cb: (err: any, data?: DescribeUserCommandOutput) => void): void; - public describeUser( + + /** + * @see {@link DescribeUserCommand} + */ + describeUser(args: DescribeUserCommandInput, options?: __HttpHandlerOptions): Promise; + describeUser(args: DescribeUserCommandInput, cb: (err: any, data?: DescribeUserCommandOutput) => void): void; + describeUser( args: DescribeUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserCommandOutput) => void ): void; - public describeUser( - args: DescribeUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUserCommandOutput) => void), - cb?: (err: any, data?: DescribeUserCommandOutput) => void - ): Promise | void { - const command = new DescribeUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified hierarchy group.

- */ - public describeUserHierarchyGroup( + + /** + * @see {@link DescribeUserHierarchyGroupCommand} + */ + describeUserHierarchyGroup( args: DescribeUserHierarchyGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeUserHierarchyGroup( + describeUserHierarchyGroup( args: DescribeUserHierarchyGroupCommandInput, cb: (err: any, data?: DescribeUserHierarchyGroupCommandOutput) => void ): void; - public describeUserHierarchyGroup( + describeUserHierarchyGroup( args: DescribeUserHierarchyGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserHierarchyGroupCommandOutput) => void ): void; - public describeUserHierarchyGroup( - args: DescribeUserHierarchyGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUserHierarchyGroupCommandOutput) => void), - cb?: (err: any, data?: DescribeUserHierarchyGroupCommandOutput) => void - ): Promise | void { - const command = new DescribeUserHierarchyGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the hierarchy structure of the specified Amazon Connect instance.

- */ - public describeUserHierarchyStructure( + + /** + * @see {@link DescribeUserHierarchyStructureCommand} + */ + describeUserHierarchyStructure( args: DescribeUserHierarchyStructureCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeUserHierarchyStructure( + describeUserHierarchyStructure( args: DescribeUserHierarchyStructureCommandInput, cb: (err: any, data?: DescribeUserHierarchyStructureCommandOutput) => void ): void; - public describeUserHierarchyStructure( + describeUserHierarchyStructure( args: DescribeUserHierarchyStructureCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserHierarchyStructureCommandOutput) => void ): void; - public describeUserHierarchyStructure( - args: DescribeUserHierarchyStructureCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUserHierarchyStructureCommandOutput) => void), - cb?: (err: any, data?: DescribeUserHierarchyStructureCommandOutput) => void - ): Promise | void { - const command = new DescribeUserHierarchyStructureCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified vocabulary.

- */ - public describeVocabulary( + + /** + * @see {@link DescribeVocabularyCommand} + */ + describeVocabulary( args: DescribeVocabularyCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVocabulary( + describeVocabulary( args: DescribeVocabularyCommandInput, cb: (err: any, data?: DescribeVocabularyCommandOutput) => void ): void; - public describeVocabulary( + describeVocabulary( args: DescribeVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVocabularyCommandOutput) => void ): void; - public describeVocabulary( - args: DescribeVocabularyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVocabularyCommandOutput) => void), - cb?: (err: any, data?: DescribeVocabularyCommandOutput) => void - ): Promise | void { - const command = new DescribeVocabularyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Revokes access to integrated applications from Amazon Connect.

- */ - public disassociateApprovedOrigin( + + /** + * @see {@link DisassociateApprovedOriginCommand} + */ + disassociateApprovedOrigin( args: DisassociateApprovedOriginCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateApprovedOrigin( + disassociateApprovedOrigin( args: DisassociateApprovedOriginCommandInput, cb: (err: any, data?: DisassociateApprovedOriginCommandOutput) => void ): void; - public disassociateApprovedOrigin( + disassociateApprovedOrigin( args: DisassociateApprovedOriginCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateApprovedOriginCommandOutput) => void ): void; - public disassociateApprovedOrigin( - args: DisassociateApprovedOriginCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateApprovedOriginCommandOutput) => void), - cb?: (err: any, data?: DisassociateApprovedOriginCommandOutput) => void - ): Promise | void { - const command = new DisassociateApprovedOriginCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 - * bot.

- */ - public disassociateBot( + + /** + * @see {@link DisassociateBotCommand} + */ + disassociateBot( args: DisassociateBotCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateBot( - args: DisassociateBotCommandInput, - cb: (err: any, data?: DisassociateBotCommandOutput) => void - ): void; - public disassociateBot( + disassociateBot(args: DisassociateBotCommandInput, cb: (err: any, data?: DisassociateBotCommandOutput) => void): void; + disassociateBot( args: DisassociateBotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateBotCommandOutput) => void ): void; - public disassociateBot( - args: DisassociateBotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateBotCommandOutput) => void), - cb?: (err: any, data?: DisassociateBotCommandOutput) => void - ): Promise | void { - const command = new DisassociateBotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Removes the storage type configurations for the specified resource type and association - * ID.

- */ - public disassociateInstanceStorageConfig( + + /** + * @see {@link DisassociateInstanceStorageConfigCommand} + */ + disassociateInstanceStorageConfig( args: DisassociateInstanceStorageConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateInstanceStorageConfig( + disassociateInstanceStorageConfig( args: DisassociateInstanceStorageConfigCommandInput, cb: (err: any, data?: DisassociateInstanceStorageConfigCommandOutput) => void ): void; - public disassociateInstanceStorageConfig( + disassociateInstanceStorageConfig( args: DisassociateInstanceStorageConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateInstanceStorageConfigCommandOutput) => void ): void; - public disassociateInstanceStorageConfig( - args: DisassociateInstanceStorageConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateInstanceStorageConfigCommandOutput) => void), - cb?: (err: any, data?: DisassociateInstanceStorageConfigCommandOutput) => void - ): Promise | void { - const command = new DisassociateInstanceStorageConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Remove the Lambda function from the dropdown options available in the relevant - * flow blocks.

- */ - public disassociateLambdaFunction( + + /** + * @see {@link DisassociateLambdaFunctionCommand} + */ + disassociateLambdaFunction( args: DisassociateLambdaFunctionCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateLambdaFunction( + disassociateLambdaFunction( args: DisassociateLambdaFunctionCommandInput, cb: (err: any, data?: DisassociateLambdaFunctionCommandOutput) => void ): void; - public disassociateLambdaFunction( + disassociateLambdaFunction( args: DisassociateLambdaFunctionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateLambdaFunctionCommandOutput) => void ): void; - public disassociateLambdaFunction( - args: DisassociateLambdaFunctionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateLambdaFunctionCommandOutput) => void), - cb?: (err: any, data?: DisassociateLambdaFunctionCommandOutput) => void - ): Promise | void { - const command = new DisassociateLambdaFunctionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Revokes authorization from the specified instance to access the specified Amazon Lex - * bot.

- */ - public disassociateLexBot( + + /** + * @see {@link DisassociateLexBotCommand} + */ + disassociateLexBot( args: DisassociateLexBotCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateLexBot( + disassociateLexBot( args: DisassociateLexBotCommandInput, cb: (err: any, data?: DisassociateLexBotCommandOutput) => void ): void; - public disassociateLexBot( + disassociateLexBot( args: DisassociateLexBotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateLexBotCommandOutput) => void ): void; - public disassociateLexBot( - args: DisassociateLexBotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateLexBotCommandOutput) => void), - cb?: (err: any, data?: DisassociateLexBotCommandOutput) => void - ): Promise | void { - const command = new DisassociateLexBotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the flow association from a phone number claimed to your Amazon Connect - * instance.

- * - *

If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the - * Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number - * ARN or UUID value for the PhoneNumberId URI request parameter. However, if the - * number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate - * Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. - * If a UUID is provided in this scenario, you will receive a - * ResourceNotFoundException.

- *
- */ - public disassociatePhoneNumberContactFlow( + + /** + * @see {@link DisassociatePhoneNumberContactFlowCommand} + */ + disassociatePhoneNumberContactFlow( args: DisassociatePhoneNumberContactFlowCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociatePhoneNumberContactFlow( + disassociatePhoneNumberContactFlow( args: DisassociatePhoneNumberContactFlowCommandInput, cb: (err: any, data?: DisassociatePhoneNumberContactFlowCommandOutput) => void ): void; - public disassociatePhoneNumberContactFlow( + disassociatePhoneNumberContactFlow( args: DisassociatePhoneNumberContactFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociatePhoneNumberContactFlowCommandOutput) => void ): void; - public disassociatePhoneNumberContactFlow( - args: DisassociatePhoneNumberContactFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociatePhoneNumberContactFlowCommandOutput) => void), - cb?: (err: any, data?: DisassociatePhoneNumberContactFlowCommandOutput) => void - ): Promise | void { - const command = new DisassociatePhoneNumberContactFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Disassociates a set of quick connects from a queue.

- */ - public disassociateQueueQuickConnects( + + /** + * @see {@link DisassociateQueueQuickConnectsCommand} + */ + disassociateQueueQuickConnects( args: DisassociateQueueQuickConnectsCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateQueueQuickConnects( + disassociateQueueQuickConnects( args: DisassociateQueueQuickConnectsCommandInput, cb: (err: any, data?: DisassociateQueueQuickConnectsCommandOutput) => void ): void; - public disassociateQueueQuickConnects( + disassociateQueueQuickConnects( args: DisassociateQueueQuickConnectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateQueueQuickConnectsCommandOutput) => void ): void; - public disassociateQueueQuickConnects( - args: DisassociateQueueQuickConnectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateQueueQuickConnectsCommandOutput) => void), - cb?: (err: any, data?: DisassociateQueueQuickConnectsCommandOutput) => void - ): Promise | void { - const command = new DisassociateQueueQuickConnectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a set of queues from a routing profile.

- */ - public disassociateRoutingProfileQueues( + + /** + * @see {@link DisassociateRoutingProfileQueuesCommand} + */ + disassociateRoutingProfileQueues( args: DisassociateRoutingProfileQueuesCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateRoutingProfileQueues( + disassociateRoutingProfileQueues( args: DisassociateRoutingProfileQueuesCommandInput, cb: (err: any, data?: DisassociateRoutingProfileQueuesCommandOutput) => void ): void; - public disassociateRoutingProfileQueues( + disassociateRoutingProfileQueues( args: DisassociateRoutingProfileQueuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateRoutingProfileQueuesCommandOutput) => void ): void; - public disassociateRoutingProfileQueues( - args: DisassociateRoutingProfileQueuesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateRoutingProfileQueuesCommandOutput) => void), - cb?: (err: any, data?: DisassociateRoutingProfileQueuesCommandOutput) => void - ): Promise | void { - const command = new DisassociateRoutingProfileQueuesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Deletes the specified security key.

- */ - public disassociateSecurityKey( + + /** + * @see {@link DisassociateSecurityKeyCommand} + */ + disassociateSecurityKey( args: DisassociateSecurityKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateSecurityKey( + disassociateSecurityKey( args: DisassociateSecurityKeyCommandInput, cb: (err: any, data?: DisassociateSecurityKeyCommandOutput) => void ): void; - public disassociateSecurityKey( + disassociateSecurityKey( args: DisassociateSecurityKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateSecurityKeyCommandOutput) => void ): void; - public disassociateSecurityKey( - args: DisassociateSecurityKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateSecurityKeyCommandOutput) => void), - cb?: (err: any, data?: DisassociateSecurityKeyCommandOutput) => void - ): Promise | void { - const command = new DisassociateSecurityKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Dismisses contacts from an agent’s CCP and returns the agent to an available state, which - * allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a - * MISSED, ERROR, ENDED, or REJECTED state in - * the Agent - * Event Stream.

- */ - public dismissUserContact( + + /** + * @see {@link DismissUserContactCommand} + */ + dismissUserContact( args: DismissUserContactCommandInput, options?: __HttpHandlerOptions ): Promise; - public dismissUserContact( + dismissUserContact( args: DismissUserContactCommandInput, cb: (err: any, data?: DismissUserContactCommandOutput) => void ): void; - public dismissUserContact( + dismissUserContact( args: DismissUserContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DismissUserContactCommandOutput) => void ): void; - public dismissUserContact( - args: DismissUserContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DismissUserContactCommandOutput) => void), - cb?: (err: any, data?: DismissUserContactCommandOutput) => void - ): Promise | void { - const command = new DismissUserContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the contact attributes for the specified contact.

- */ - public getContactAttributes( + + /** + * @see {@link GetContactAttributesCommand} + */ + getContactAttributes( args: GetContactAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getContactAttributes( + getContactAttributes( args: GetContactAttributesCommandInput, cb: (err: any, data?: GetContactAttributesCommandOutput) => void ): void; - public getContactAttributes( + getContactAttributes( args: GetContactAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContactAttributesCommandOutput) => void ): void; - public getContactAttributes( - args: GetContactAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContactAttributesCommandOutput) => void), - cb?: (err: any, data?: GetContactAttributesCommandOutput) => void - ): Promise | void { - const command = new GetContactAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the real-time metric data from the specified Amazon Connect instance.

- *

For a description of each metric, see Real-time Metrics - * Definitions in the Amazon Connect Administrator Guide.

- */ - public getCurrentMetricData( + + /** + * @see {@link GetCurrentMetricDataCommand} + */ + getCurrentMetricData( args: GetCurrentMetricDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCurrentMetricData( + getCurrentMetricData( args: GetCurrentMetricDataCommandInput, cb: (err: any, data?: GetCurrentMetricDataCommandOutput) => void ): void; - public getCurrentMetricData( + getCurrentMetricData( args: GetCurrentMetricDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCurrentMetricDataCommandOutput) => void ): void; - public getCurrentMetricData( - args: GetCurrentMetricDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCurrentMetricDataCommandOutput) => void), - cb?: (err: any, data?: GetCurrentMetricDataCommandOutput) => void - ): Promise | void { - const command = new GetCurrentMetricDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the real-time active user data from the specified Amazon Connect instance.

- */ - public getCurrentUserData( + + /** + * @see {@link GetCurrentUserDataCommand} + */ + getCurrentUserData( args: GetCurrentUserDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCurrentUserData( + getCurrentUserData( args: GetCurrentUserDataCommandInput, cb: (err: any, data?: GetCurrentUserDataCommandOutput) => void ): void; - public getCurrentUserData( + getCurrentUserData( args: GetCurrentUserDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCurrentUserDataCommandOutput) => void ): void; - public getCurrentUserData( - args: GetCurrentUserDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCurrentUserDataCommandOutput) => void), - cb?: (err: any, data?: GetCurrentUserDataCommandOutput) => void - ): Promise | void { - const command = new GetCurrentUserDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a token for federation.

- * - *

This API doesn't support root users. If you try to invoke GetFederationToken with root - * credentials, an error message similar to the following one appears:

- *

- * Provided identity: Principal: .... User: .... cannot be used for federation with - * Amazon Connect - *

- *
- */ - public getFederationToken( + + /** + * @see {@link GetFederationTokenCommand} + */ + getFederationToken( args: GetFederationTokenCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFederationToken( + getFederationToken( args: GetFederationTokenCommandInput, cb: (err: any, data?: GetFederationTokenCommandOutput) => void ): void; - public getFederationToken( + getFederationToken( args: GetFederationTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFederationTokenCommandOutput) => void ): void; - public getFederationToken( - args: GetFederationTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFederationTokenCommandOutput) => void), - cb?: (err: any, data?: GetFederationTokenCommandOutput) => void - ): Promise | void { - const command = new GetFederationTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets historical metric data from the specified Amazon Connect instance.

- *

For a description of each historical metric, see Historical Metrics - * Definitions in the Amazon Connect Administrator Guide.

- */ - public getMetricData( - args: GetMetricDataCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getMetricData( - args: GetMetricDataCommandInput, - cb: (err: any, data?: GetMetricDataCommandOutput) => void - ): void; - public getMetricData( + + /** + * @see {@link GetMetricDataCommand} + */ + getMetricData(args: GetMetricDataCommandInput, options?: __HttpHandlerOptions): Promise; + getMetricData(args: GetMetricDataCommandInput, cb: (err: any, data?: GetMetricDataCommandOutput) => void): void; + getMetricData( args: GetMetricDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMetricDataCommandOutput) => void ): void; - public getMetricData( - args: GetMetricDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMetricDataCommandOutput) => void), - cb?: (err: any, data?: GetMetricDataCommandOutput) => void - ): Promise | void { - const command = new GetMetricDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets metric data from the specified Amazon Connect instance.

- *

- * GetMetricDataV2 offers more features than GetMetricData, the previous - * version of this API. It has new metrics, offers filtering at a metric level, and offers the - * ability to filter and group data by channels, queues, routing profiles, agents, and agent - * hierarchy levels. It can retrieve historical data for the last 14 days, in 24-hour - * intervals.

- *

For a description of the historical metrics that are supported by - * GetMetricDataV2 and GetMetricData, see Historical metrics - * definitions in the Amazon Connect Administrator's Guide.

- *

This API is not available in the Amazon Web Services GovCloud (US) Regions.

- */ - public getMetricDataV2( + + /** + * @see {@link GetMetricDataV2Command} + */ + getMetricDataV2( args: GetMetricDataV2CommandInput, options?: __HttpHandlerOptions ): Promise; - public getMetricDataV2( - args: GetMetricDataV2CommandInput, - cb: (err: any, data?: GetMetricDataV2CommandOutput) => void - ): void; - public getMetricDataV2( + getMetricDataV2(args: GetMetricDataV2CommandInput, cb: (err: any, data?: GetMetricDataV2CommandOutput) => void): void; + getMetricDataV2( args: GetMetricDataV2CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMetricDataV2CommandOutput) => void ): void; - public getMetricDataV2( - args: GetMetricDataV2CommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMetricDataV2CommandOutput) => void), - cb?: (err: any, data?: GetMetricDataV2CommandOutput) => void - ): Promise | void { - const command = new GetMetricDataV2Command(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets details about a specific task template in the specified Amazon Connect - * instance.

- */ - public getTaskTemplate( + + /** + * @see {@link GetTaskTemplateCommand} + */ + getTaskTemplate( args: GetTaskTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTaskTemplate( - args: GetTaskTemplateCommandInput, - cb: (err: any, data?: GetTaskTemplateCommandOutput) => void - ): void; - public getTaskTemplate( + getTaskTemplate(args: GetTaskTemplateCommandInput, cb: (err: any, data?: GetTaskTemplateCommandOutput) => void): void; + getTaskTemplate( args: GetTaskTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTaskTemplateCommandOutput) => void ): void; - public getTaskTemplate( - args: GetTaskTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTaskTemplateCommandOutput) => void), - cb?: (err: any, data?: GetTaskTemplateCommandOutput) => void - ): Promise | void { - const command = new GetTaskTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the current traffic distribution for a given traffic distribution group.

- */ - public getTrafficDistribution( + + /** + * @see {@link GetTrafficDistributionCommand} + */ + getTrafficDistribution( args: GetTrafficDistributionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTrafficDistribution( + getTrafficDistribution( args: GetTrafficDistributionCommandInput, cb: (err: any, data?: GetTrafficDistributionCommandOutput) => void ): void; - public getTrafficDistribution( + getTrafficDistribution( args: GetTrafficDistributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTrafficDistributionCommandOutput) => void ): void; - public getTrafficDistribution( - args: GetTrafficDistributionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTrafficDistributionCommandOutput) => void), - cb?: (err: any, data?: GetTrafficDistributionCommandOutput) => void - ): Promise | void { - const command = new GetTrafficDistributionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Lists agent statuses.

- */ - public listAgentStatuses( + + /** + * @see {@link ListAgentStatusesCommand} + */ + listAgentStatuses( args: ListAgentStatusesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAgentStatuses( + listAgentStatuses( args: ListAgentStatusesCommandInput, cb: (err: any, data?: ListAgentStatusesCommandOutput) => void ): void; - public listAgentStatuses( + listAgentStatuses( args: ListAgentStatusesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAgentStatusesCommandOutput) => void ): void; - public listAgentStatuses( - args: ListAgentStatusesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAgentStatusesCommandOutput) => void), - cb?: (err: any, data?: ListAgentStatusesCommandOutput) => void - ): Promise | void { - const command = new ListAgentStatusesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Returns a paginated list of all approved origins associated with the instance.

- */ - public listApprovedOrigins( + + /** + * @see {@link ListApprovedOriginsCommand} + */ + listApprovedOrigins( args: ListApprovedOriginsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApprovedOrigins( + listApprovedOrigins( args: ListApprovedOriginsCommandInput, cb: (err: any, data?: ListApprovedOriginsCommandOutput) => void ): void; - public listApprovedOrigins( + listApprovedOrigins( args: ListApprovedOriginsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApprovedOriginsCommandOutput) => void ): void; - public listApprovedOrigins( - args: ListApprovedOriginsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApprovedOriginsCommandOutput) => void), - cb?: (err: any, data?: ListApprovedOriginsCommandOutput) => void - ): Promise | void { - const command = new ListApprovedOriginsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.

- */ - public listBots(args: ListBotsCommandInput, options?: __HttpHandlerOptions): Promise; - public listBots(args: ListBotsCommandInput, cb: (err: any, data?: ListBotsCommandOutput) => void): void; - public listBots( + + /** + * @see {@link ListBotsCommand} + */ + listBots(args: ListBotsCommandInput, options?: __HttpHandlerOptions): Promise; + listBots(args: ListBotsCommandInput, cb: (err: any, data?: ListBotsCommandOutput) => void): void; + listBots( args: ListBotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBotsCommandOutput) => void ): void; - public listBots( - args: ListBotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBotsCommandOutput) => void), - cb?: (err: any, data?: ListBotsCommandOutput) => void - ): Promise | void { - const command = new ListBotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides information about the flow modules for the specified Amazon Connect - * instance.

- */ - public listContactFlowModules( + + /** + * @see {@link ListContactFlowModulesCommand} + */ + listContactFlowModules( args: ListContactFlowModulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listContactFlowModules( + listContactFlowModules( args: ListContactFlowModulesCommandInput, cb: (err: any, data?: ListContactFlowModulesCommandOutput) => void ): void; - public listContactFlowModules( + listContactFlowModules( args: ListContactFlowModulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListContactFlowModulesCommandOutput) => void ): void; - public listContactFlowModules( - args: ListContactFlowModulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListContactFlowModulesCommandOutput) => void), - cb?: (err: any, data?: ListContactFlowModulesCommandOutput) => void - ): Promise | void { - const command = new ListContactFlowModulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides information about the flows for the specified Amazon Connect instance.

- *

You can also create and update flows using the Amazon Connect - * Flow language.

- *

For more information about flows, see Flows in the - * Amazon Connect Administrator Guide.

- */ - public listContactFlows( + + /** + * @see {@link ListContactFlowsCommand} + */ + listContactFlows( args: ListContactFlowsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listContactFlows( + listContactFlows( args: ListContactFlowsCommandInput, cb: (err: any, data?: ListContactFlowsCommandOutput) => void ): void; - public listContactFlows( + listContactFlows( args: ListContactFlowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListContactFlowsCommandOutput) => void ): void; - public listContactFlows( - args: ListContactFlowsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListContactFlowsCommandOutput) => void), - cb?: (err: any, data?: ListContactFlowsCommandOutput) => void - ): Promise | void { - const command = new ListContactFlowsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

For the specified referenceTypes, returns a list of references associated with - * the contact.

- */ - public listContactReferences( + + /** + * @see {@link ListContactReferencesCommand} + */ + listContactReferences( args: ListContactReferencesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listContactReferences( + listContactReferences( args: ListContactReferencesCommandInput, cb: (err: any, data?: ListContactReferencesCommandOutput) => void ): void; - public listContactReferences( + listContactReferences( args: ListContactReferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListContactReferencesCommandOutput) => void ): void; - public listContactReferences( - args: ListContactReferencesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListContactReferencesCommandOutput) => void), - cb?: (err: any, data?: ListContactReferencesCommandOutput) => void - ): Promise | void { - const command = new ListContactReferencesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the default vocabularies for the specified Amazon Connect instance.

- */ - public listDefaultVocabularies( + + /** + * @see {@link ListDefaultVocabulariesCommand} + */ + listDefaultVocabularies( args: ListDefaultVocabulariesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDefaultVocabularies( + listDefaultVocabularies( args: ListDefaultVocabulariesCommandInput, cb: (err: any, data?: ListDefaultVocabulariesCommandOutput) => void ): void; - public listDefaultVocabularies( + listDefaultVocabularies( args: ListDefaultVocabulariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDefaultVocabulariesCommandOutput) => void ): void; - public listDefaultVocabularies( - args: ListDefaultVocabulariesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDefaultVocabulariesCommandOutput) => void), - cb?: (err: any, data?: ListDefaultVocabulariesCommandOutput) => void - ): Promise | void { - const command = new ListDefaultVocabulariesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides information about the hours of operation for the specified Amazon Connect - * instance.

- *

For more information about hours of operation, see Set the Hours of Operation for a - * Queue in the Amazon Connect Administrator Guide.

- */ - public listHoursOfOperations( + + /** + * @see {@link ListHoursOfOperationsCommand} + */ + listHoursOfOperations( args: ListHoursOfOperationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listHoursOfOperations( + listHoursOfOperations( args: ListHoursOfOperationsCommandInput, cb: (err: any, data?: ListHoursOfOperationsCommandOutput) => void ): void; - public listHoursOfOperations( + listHoursOfOperations( args: ListHoursOfOperationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHoursOfOperationsCommandOutput) => void ): void; - public listHoursOfOperations( - args: ListHoursOfOperationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListHoursOfOperationsCommandOutput) => void), - cb?: (err: any, data?: ListHoursOfOperationsCommandOutput) => void - ): Promise | void { - const command = new ListHoursOfOperationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Returns a paginated list of all attribute types for the given instance.

- */ - public listInstanceAttributes( + + /** + * @see {@link ListInstanceAttributesCommand} + */ + listInstanceAttributes( args: ListInstanceAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInstanceAttributes( + listInstanceAttributes( args: ListInstanceAttributesCommandInput, cb: (err: any, data?: ListInstanceAttributesCommandOutput) => void ): void; - public listInstanceAttributes( + listInstanceAttributes( args: ListInstanceAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInstanceAttributesCommandOutput) => void ): void; - public listInstanceAttributes( - args: ListInstanceAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInstanceAttributesCommandOutput) => void), - cb?: (err: any, data?: ListInstanceAttributesCommandOutput) => void - ): Promise | void { - const command = new ListInstanceAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Return a list of instances which are in active state, creation-in-progress state, and failed - * state. Instances that aren't successfully created (they are in a failed state) are returned only - * for 24 hours after the CreateInstance API was invoked.

- */ - public listInstances( - args: ListInstancesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listInstances( - args: ListInstancesCommandInput, - cb: (err: any, data?: ListInstancesCommandOutput) => void - ): void; - public listInstances( + + /** + * @see {@link ListInstancesCommand} + */ + listInstances(args: ListInstancesCommandInput, options?: __HttpHandlerOptions): Promise; + listInstances(args: ListInstancesCommandInput, cb: (err: any, data?: ListInstancesCommandOutput) => void): void; + listInstances( args: ListInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInstancesCommandOutput) => void ): void; - public listInstances( - args: ListInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInstancesCommandOutput) => void), - cb?: (err: any, data?: ListInstancesCommandOutput) => void - ): Promise | void { - const command = new ListInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Returns a paginated list of storage configs for the identified instance and resource - * type.

- */ - public listInstanceStorageConfigs( + + /** + * @see {@link ListInstanceStorageConfigsCommand} + */ + listInstanceStorageConfigs( args: ListInstanceStorageConfigsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInstanceStorageConfigs( + listInstanceStorageConfigs( args: ListInstanceStorageConfigsCommandInput, cb: (err: any, data?: ListInstanceStorageConfigsCommandOutput) => void ): void; - public listInstanceStorageConfigs( + listInstanceStorageConfigs( args: ListInstanceStorageConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInstanceStorageConfigsCommandOutput) => void ): void; - public listInstanceStorageConfigs( - args: ListInstanceStorageConfigsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInstanceStorageConfigsCommandOutput) => void), - cb?: (err: any, data?: ListInstanceStorageConfigsCommandOutput) => void - ): Promise | void { - const command = new ListInstanceStorageConfigsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides summary information about the Amazon Web Services resource associations for the - * specified Amazon Connect instance.

- */ - public listIntegrationAssociations( + + /** + * @see {@link ListIntegrationAssociationsCommand} + */ + listIntegrationAssociations( args: ListIntegrationAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listIntegrationAssociations( + listIntegrationAssociations( args: ListIntegrationAssociationsCommandInput, cb: (err: any, data?: ListIntegrationAssociationsCommandOutput) => void ): void; - public listIntegrationAssociations( + listIntegrationAssociations( args: ListIntegrationAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIntegrationAssociationsCommandOutput) => void ): void; - public listIntegrationAssociations( - args: ListIntegrationAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIntegrationAssociationsCommandOutput) => void), - cb?: (err: any, data?: ListIntegrationAssociationsCommandOutput) => void - ): Promise | void { - const command = new ListIntegrationAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Returns a paginated list of all Lambda functions that display in the dropdown options in the - * relevant flow blocks.

- */ - public listLambdaFunctions( + + /** + * @see {@link ListLambdaFunctionsCommand} + */ + listLambdaFunctions( args: ListLambdaFunctionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLambdaFunctions( + listLambdaFunctions( args: ListLambdaFunctionsCommandInput, cb: (err: any, data?: ListLambdaFunctionsCommandOutput) => void ): void; - public listLambdaFunctions( + listLambdaFunctions( args: ListLambdaFunctionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLambdaFunctionsCommandOutput) => void ): void; - public listLambdaFunctions( - args: ListLambdaFunctionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLambdaFunctionsCommandOutput) => void), - cb?: (err: any, data?: ListLambdaFunctionsCommandOutput) => void - ): Promise | void { - const command = new ListLambdaFunctionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Returns a paginated list of all the Amazon Lex V1 bots currently associated with the - * instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API. - *

- */ - public listLexBots(args: ListLexBotsCommandInput, options?: __HttpHandlerOptions): Promise; - public listLexBots(args: ListLexBotsCommandInput, cb: (err: any, data?: ListLexBotsCommandOutput) => void): void; - public listLexBots( + + /** + * @see {@link ListLexBotsCommand} + */ + listLexBots(args: ListLexBotsCommandInput, options?: __HttpHandlerOptions): Promise; + listLexBots(args: ListLexBotsCommandInput, cb: (err: any, data?: ListLexBotsCommandOutput) => void): void; + listLexBots( args: ListLexBotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLexBotsCommandOutput) => void ): void; - public listLexBots( - args: ListLexBotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLexBotsCommandOutput) => void), - cb?: (err: any, data?: ListLexBotsCommandOutput) => void - ): Promise | void { - const command = new ListLexBotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides information about the phone numbers for the specified Amazon Connect instance.

- *

For more information about phone numbers, see Set Up Phone Numbers for Your - * Contact Center in the Amazon Connect Administrator - * Guide.

- * - *

The phone number Arn value that is returned from each of the items in the - * PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with - * a ResourceNotFoundException. Instead, use the ListPhoneNumbersV2 API. - * It returns the new phone number ARN that can be used to tag phone number resources.

- *
- */ - public listPhoneNumbers( + + /** + * @see {@link ListPhoneNumbersCommand} + */ + listPhoneNumbers( args: ListPhoneNumbersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPhoneNumbers( + listPhoneNumbers( args: ListPhoneNumbersCommandInput, cb: (err: any, data?: ListPhoneNumbersCommandOutput) => void ): void; - public listPhoneNumbers( + listPhoneNumbers( args: ListPhoneNumbersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPhoneNumbersCommandOutput) => void ): void; - public listPhoneNumbers( - args: ListPhoneNumbersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPhoneNumbersCommandOutput) => void), - cb?: (err: any, data?: ListPhoneNumbersCommandOutput) => void - ): Promise | void { - const command = new ListPhoneNumbersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided - * TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions - * associated with traffic distribution group.

- *

For more information about phone numbers, see Set Up Phone Numbers for Your - * Contact Center in the Amazon Connect Administrator - * Guide.

- */ - public listPhoneNumbersV2( + + /** + * @see {@link ListPhoneNumbersV2Command} + */ + listPhoneNumbersV2( args: ListPhoneNumbersV2CommandInput, options?: __HttpHandlerOptions ): Promise; - public listPhoneNumbersV2( + listPhoneNumbersV2( args: ListPhoneNumbersV2CommandInput, cb: (err: any, data?: ListPhoneNumbersV2CommandOutput) => void ): void; - public listPhoneNumbersV2( + listPhoneNumbersV2( args: ListPhoneNumbersV2CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPhoneNumbersV2CommandOutput) => void ): void; - public listPhoneNumbersV2( - args: ListPhoneNumbersV2CommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPhoneNumbersV2CommandOutput) => void), - cb?: (err: any, data?: ListPhoneNumbersV2CommandOutput) => void - ): Promise | void { - const command = new ListPhoneNumbersV2Command(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides information about the prompts for the specified Amazon Connect instance.

- */ - public listPrompts(args: ListPromptsCommandInput, options?: __HttpHandlerOptions): Promise; - public listPrompts(args: ListPromptsCommandInput, cb: (err: any, data?: ListPromptsCommandOutput) => void): void; - public listPrompts( + + /** + * @see {@link ListPromptsCommand} + */ + listPrompts(args: ListPromptsCommandInput, options?: __HttpHandlerOptions): Promise; + listPrompts(args: ListPromptsCommandInput, cb: (err: any, data?: ListPromptsCommandOutput) => void): void; + listPrompts( args: ListPromptsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPromptsCommandOutput) => void ): void; - public listPrompts( - args: ListPromptsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPromptsCommandOutput) => void), - cb?: (err: any, data?: ListPromptsCommandOutput) => void - ): Promise | void { - const command = new ListPromptsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Lists the quick connects associated with a queue.

- */ - public listQueueQuickConnects( + + /** + * @see {@link ListQueueQuickConnectsCommand} + */ + listQueueQuickConnects( args: ListQueueQuickConnectsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listQueueQuickConnects( + listQueueQuickConnects( args: ListQueueQuickConnectsCommandInput, cb: (err: any, data?: ListQueueQuickConnectsCommandOutput) => void ): void; - public listQueueQuickConnects( + listQueueQuickConnects( args: ListQueueQuickConnectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQueueQuickConnectsCommandOutput) => void ): void; - public listQueueQuickConnects( - args: ListQueueQuickConnectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListQueueQuickConnectsCommandOutput) => void), - cb?: (err: any, data?: ListQueueQuickConnectsCommandOutput) => void - ): Promise | void { - const command = new ListQueueQuickConnectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides information about the queues for the specified Amazon Connect instance.

- *

If you do not specify a QueueTypes - * parameter, both standard and agent queues are returned. This might cause an unexpected truncation - * of results if you have more than 1000 agents and you limit the number of results of the API call - * in code.

- *

For more information about queues, see Queues: Standard and - * Agent in the Amazon Connect Administrator Guide.

- */ - public listQueues(args: ListQueuesCommandInput, options?: __HttpHandlerOptions): Promise; - public listQueues(args: ListQueuesCommandInput, cb: (err: any, data?: ListQueuesCommandOutput) => void): void; - public listQueues( + + /** + * @see {@link ListQueuesCommand} + */ + listQueues(args: ListQueuesCommandInput, options?: __HttpHandlerOptions): Promise; + listQueues(args: ListQueuesCommandInput, cb: (err: any, data?: ListQueuesCommandOutput) => void): void; + listQueues( args: ListQueuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQueuesCommandOutput) => void ): void; - public listQueues( - args: ListQueuesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListQueuesCommandOutput) => void), - cb?: (err: any, data?: ListQueuesCommandOutput) => void - ): Promise | void { - const command = new ListQueuesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides information about the quick connects for the specified Amazon Connect instance. - *

- */ - public listQuickConnects( + + /** + * @see {@link ListQuickConnectsCommand} + */ + listQuickConnects( args: ListQuickConnectsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listQuickConnects( + listQuickConnects( args: ListQuickConnectsCommandInput, cb: (err: any, data?: ListQuickConnectsCommandOutput) => void ): void; - public listQuickConnects( + listQuickConnects( args: ListQuickConnectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQuickConnectsCommandOutput) => void ): void; - public listQuickConnects( - args: ListQuickConnectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListQuickConnectsCommandOutput) => void), - cb?: (err: any, data?: ListQuickConnectsCommandOutput) => void - ): Promise | void { - const command = new ListQuickConnectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the queues associated with a routing profile.

- */ - public listRoutingProfileQueues( + + /** + * @see {@link ListRoutingProfileQueuesCommand} + */ + listRoutingProfileQueues( args: ListRoutingProfileQueuesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRoutingProfileQueues( + listRoutingProfileQueues( args: ListRoutingProfileQueuesCommandInput, cb: (err: any, data?: ListRoutingProfileQueuesCommandOutput) => void ): void; - public listRoutingProfileQueues( + listRoutingProfileQueues( args: ListRoutingProfileQueuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRoutingProfileQueuesCommandOutput) => void ): void; - public listRoutingProfileQueues( - args: ListRoutingProfileQueuesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRoutingProfileQueuesCommandOutput) => void), - cb?: (err: any, data?: ListRoutingProfileQueuesCommandOutput) => void - ): Promise | void { - const command = new ListRoutingProfileQueuesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides summary information about the routing profiles for the specified Amazon Connect - * instance.

- *

For more information about routing profiles, see Routing Profiles and Create a Routing - * Profile in the Amazon Connect Administrator Guide.

- */ - public listRoutingProfiles( + + /** + * @see {@link ListRoutingProfilesCommand} + */ + listRoutingProfiles( args: ListRoutingProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRoutingProfiles( + listRoutingProfiles( args: ListRoutingProfilesCommandInput, cb: (err: any, data?: ListRoutingProfilesCommandOutput) => void ): void; - public listRoutingProfiles( + listRoutingProfiles( args: ListRoutingProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRoutingProfilesCommandOutput) => void ): void; - public listRoutingProfiles( - args: ListRoutingProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRoutingProfilesCommandOutput) => void), - cb?: (err: any, data?: ListRoutingProfilesCommandOutput) => void - ): Promise | void { - const command = new ListRoutingProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List all rules for the specified Amazon Connect instance.

- */ - public listRules(args: ListRulesCommandInput, options?: __HttpHandlerOptions): Promise; - public listRules(args: ListRulesCommandInput, cb: (err: any, data?: ListRulesCommandOutput) => void): void; - public listRules( + + /** + * @see {@link ListRulesCommand} + */ + listRules(args: ListRulesCommandInput, options?: __HttpHandlerOptions): Promise; + listRules(args: ListRulesCommandInput, cb: (err: any, data?: ListRulesCommandOutput) => void): void; + listRules( args: ListRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRulesCommandOutput) => void ): void; - public listRules( - args: ListRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRulesCommandOutput) => void), - cb?: (err: any, data?: ListRulesCommandOutput) => void - ): Promise | void { - const command = new ListRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Returns a paginated list of all security keys associated with the instance.

- */ - public listSecurityKeys( + + /** + * @see {@link ListSecurityKeysCommand} + */ + listSecurityKeys( args: ListSecurityKeysCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSecurityKeys( + listSecurityKeys( args: ListSecurityKeysCommandInput, cb: (err: any, data?: ListSecurityKeysCommandOutput) => void ): void; - public listSecurityKeys( + listSecurityKeys( args: ListSecurityKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSecurityKeysCommandOutput) => void ): void; - public listSecurityKeys( - args: ListSecurityKeysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSecurityKeysCommandOutput) => void), - cb?: (err: any, data?: ListSecurityKeysCommandOutput) => void - ): Promise | void { - const command = new ListSecurityKeysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Lists the permissions granted to a security profile.

- */ - public listSecurityProfilePermissions( + + /** + * @see {@link ListSecurityProfilePermissionsCommand} + */ + listSecurityProfilePermissions( args: ListSecurityProfilePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSecurityProfilePermissions( + listSecurityProfilePermissions( args: ListSecurityProfilePermissionsCommandInput, cb: (err: any, data?: ListSecurityProfilePermissionsCommandOutput) => void ): void; - public listSecurityProfilePermissions( + listSecurityProfilePermissions( args: ListSecurityProfilePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSecurityProfilePermissionsCommandOutput) => void ): void; - public listSecurityProfilePermissions( - args: ListSecurityProfilePermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSecurityProfilePermissionsCommandOutput) => void), - cb?: (err: any, data?: ListSecurityProfilePermissionsCommandOutput) => void - ): Promise | void { - const command = new ListSecurityProfilePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides summary information about the security profiles for the specified Amazon Connect instance.

- *

For more information about security profiles, see Security Profiles in the - * Amazon Connect Administrator Guide.

- */ - public listSecurityProfiles( + + /** + * @see {@link ListSecurityProfilesCommand} + */ + listSecurityProfiles( args: ListSecurityProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSecurityProfiles( + listSecurityProfiles( args: ListSecurityProfilesCommandInput, cb: (err: any, data?: ListSecurityProfilesCommandOutput) => void ): void; - public listSecurityProfiles( + listSecurityProfiles( args: ListSecurityProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSecurityProfilesCommandOutput) => void ): void; - public listSecurityProfiles( - args: ListSecurityProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSecurityProfilesCommandOutput) => void), - cb?: (err: any, data?: ListSecurityProfilesCommandOutput) => void - ): Promise | void { - const command = new ListSecurityProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the tags for the specified resource.

- *

For sample policies that use tags, see Amazon Connect - * Identity-Based Policy Examples in the Amazon Connect Administrator - * Guide.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists task templates for the specified Amazon Connect instance.

- */ - public listTaskTemplates( + + /** + * @see {@link ListTaskTemplatesCommand} + */ + listTaskTemplates( args: ListTaskTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTaskTemplates( + listTaskTemplates( args: ListTaskTemplatesCommandInput, cb: (err: any, data?: ListTaskTemplatesCommandOutput) => void ): void; - public listTaskTemplates( + listTaskTemplates( args: ListTaskTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTaskTemplatesCommandOutput) => void ): void; - public listTaskTemplates( - args: ListTaskTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTaskTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListTaskTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListTaskTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists traffic distribution groups.

- */ - public listTrafficDistributionGroups( + + /** + * @see {@link ListTrafficDistributionGroupsCommand} + */ + listTrafficDistributionGroups( args: ListTrafficDistributionGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTrafficDistributionGroups( + listTrafficDistributionGroups( args: ListTrafficDistributionGroupsCommandInput, cb: (err: any, data?: ListTrafficDistributionGroupsCommandOutput) => void ): void; - public listTrafficDistributionGroups( + listTrafficDistributionGroups( args: ListTrafficDistributionGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTrafficDistributionGroupsCommandOutput) => void ): void; - public listTrafficDistributionGroups( - args: ListTrafficDistributionGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTrafficDistributionGroupsCommandOutput) => void), - cb?: (err: any, data?: ListTrafficDistributionGroupsCommandOutput) => void - ): Promise | void { - const command = new ListTrafficDistributionGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the use cases for the integration association.

- */ - public listUseCases( - args: ListUseCasesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listUseCases(args: ListUseCasesCommandInput, cb: (err: any, data?: ListUseCasesCommandOutput) => void): void; - public listUseCases( + + /** + * @see {@link ListUseCasesCommand} + */ + listUseCases(args: ListUseCasesCommandInput, options?: __HttpHandlerOptions): Promise; + listUseCases(args: ListUseCasesCommandInput, cb: (err: any, data?: ListUseCasesCommandOutput) => void): void; + listUseCases( args: ListUseCasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUseCasesCommandOutput) => void ): void; - public listUseCases( - args: ListUseCasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUseCasesCommandOutput) => void), - cb?: (err: any, data?: ListUseCasesCommandOutput) => void - ): Promise | void { - const command = new ListUseCasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides summary information about the hierarchy groups for the specified Amazon Connect - * instance.

- *

For more information about agent hierarchies, see Set Up Agent Hierarchies in the - * Amazon Connect Administrator Guide.

- */ - public listUserHierarchyGroups( + + /** + * @see {@link ListUserHierarchyGroupsCommand} + */ + listUserHierarchyGroups( args: ListUserHierarchyGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listUserHierarchyGroups( + listUserHierarchyGroups( args: ListUserHierarchyGroupsCommandInput, cb: (err: any, data?: ListUserHierarchyGroupsCommandOutput) => void ): void; - public listUserHierarchyGroups( + listUserHierarchyGroups( args: ListUserHierarchyGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUserHierarchyGroupsCommandOutput) => void ): void; - public listUserHierarchyGroups( - args: ListUserHierarchyGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUserHierarchyGroupsCommandOutput) => void), - cb?: (err: any, data?: ListUserHierarchyGroupsCommandOutput) => void - ): Promise | void { - const command = new ListUserHierarchyGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides summary information about the users for the specified Amazon Connect - * instance.

- */ - public listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise; - public listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void; - public listUsers( + + /** + * @see {@link ListUsersCommand} + */ + listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise; + listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void; + listUsers( args: ListUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersCommandOutput) => void ): void; - public listUsers( - args: ListUsersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUsersCommandOutput) => void), - cb?: (err: any, data?: ListUsersCommandOutput) => void - ): Promise | void { - const command = new ListUsersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user - * specified by userId will be set to silent monitoring mode on the - * contact.

- */ - public monitorContact( + + /** + * @see {@link MonitorContactCommand} + */ + monitorContact( args: MonitorContactCommandInput, options?: __HttpHandlerOptions ): Promise; - public monitorContact( - args: MonitorContactCommandInput, - cb: (err: any, data?: MonitorContactCommandOutput) => void - ): void; - public monitorContact( + monitorContact(args: MonitorContactCommandInput, cb: (err: any, data?: MonitorContactCommandOutput) => void): void; + monitorContact( args: MonitorContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MonitorContactCommandOutput) => void ): void; - public monitorContact( - args: MonitorContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MonitorContactCommandOutput) => void), - cb?: (err: any, data?: MonitorContactCommandOutput) => void - ): Promise | void { - const command = new MonitorContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Changes the current status of a user or agent in Amazon Connect. If the agent is - * currently handling a contact, this sets the agent's next status.

- *

For more information, see Agent status and Set your next - * status in the Amazon Connect Administrator Guide.

- */ - public putUserStatus( - args: PutUserStatusCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putUserStatus( - args: PutUserStatusCommandInput, - cb: (err: any, data?: PutUserStatusCommandOutput) => void - ): void; - public putUserStatus( + + /** + * @see {@link PutUserStatusCommand} + */ + putUserStatus(args: PutUserStatusCommandInput, options?: __HttpHandlerOptions): Promise; + putUserStatus(args: PutUserStatusCommandInput, cb: (err: any, data?: PutUserStatusCommandOutput) => void): void; + putUserStatus( args: PutUserStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutUserStatusCommandOutput) => void ): void; - public putUserStatus( - args: PutUserStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutUserStatusCommandOutput) => void), - cb?: (err: any, data?: PutUserStatusCommandOutput) => void - ): Promise | void { - const command = new PutUserStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You - * can call this API only in the Amazon Web Services Region where the number was claimed.

- * - *

To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the - * Amazon Connect console.

- *

After releasing a phone number, the phone number enters into a cooldown period of 30 days. - * It cannot be searched for or claimed again until the period has ended. If you accidentally - * release a phone number, contact Amazon Web Services Support.

- *
- */ - public releasePhoneNumber( + + /** + * @see {@link ReleasePhoneNumberCommand} + */ + releasePhoneNumber( args: ReleasePhoneNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public releasePhoneNumber( + releasePhoneNumber( args: ReleasePhoneNumberCommandInput, cb: (err: any, data?: ReleasePhoneNumberCommandOutput) => void ): void; - public releasePhoneNumber( + releasePhoneNumber( args: ReleasePhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReleasePhoneNumberCommandOutput) => void ): void; - public releasePhoneNumber( - args: ReleasePhoneNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReleasePhoneNumberCommandOutput) => void), - cb?: (err: any, data?: ReleasePhoneNumberCommandOutput) => void - ): Promise | void { - const command = new ReleasePhoneNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Replicates an Amazon Connect instance in the specified Amazon Web Services Region.

- *

For more information about replicating an Amazon Connect instance, see Create - * a replica of your existing Amazon Connect instance in the Amazon Connect - * Administrator Guide.

- */ - public replicateInstance( + + /** + * @see {@link ReplicateInstanceCommand} + */ + replicateInstance( args: ReplicateInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public replicateInstance( + replicateInstance( args: ReplicateInstanceCommandInput, cb: (err: any, data?: ReplicateInstanceCommandOutput) => void ): void; - public replicateInstance( + replicateInstance( args: ReplicateInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReplicateInstanceCommandOutput) => void ): void; - public replicateInstance( - args: ReplicateInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReplicateInstanceCommandOutput) => void), - cb?: (err: any, data?: ReplicateInstanceCommandOutput) => void - ): Promise | void { - const command = new ReplicateInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

When a contact is being recorded, and the recording has been suspended using - * SuspendContactRecording, this API resumes recording the call.

- *

Only voice recordings are supported at this time.

- */ - public resumeContactRecording( + + /** + * @see {@link ResumeContactRecordingCommand} + */ + resumeContactRecording( args: ResumeContactRecordingCommandInput, options?: __HttpHandlerOptions ): Promise; - public resumeContactRecording( + resumeContactRecording( args: ResumeContactRecordingCommandInput, cb: (err: any, data?: ResumeContactRecordingCommandOutput) => void ): void; - public resumeContactRecording( + resumeContactRecording( args: ResumeContactRecordingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResumeContactRecordingCommandOutput) => void ): void; - public resumeContactRecording( - args: ResumeContactRecordingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResumeContactRecordingCommandOutput) => void), - cb?: (err: any, data?: ResumeContactRecordingCommandOutput) => void - ): Promise | void { - const command = new ResumeContactRecordingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Searches for available phone numbers that you can claim to your Amazon Connect instance - * or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both - * Amazon Web Services Regions associated with the traffic distribution group.

- */ - public searchAvailablePhoneNumbers( + + /** + * @see {@link SearchAvailablePhoneNumbersCommand} + */ + searchAvailablePhoneNumbers( args: SearchAvailablePhoneNumbersCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchAvailablePhoneNumbers( + searchAvailablePhoneNumbers( args: SearchAvailablePhoneNumbersCommandInput, cb: (err: any, data?: SearchAvailablePhoneNumbersCommandOutput) => void ): void; - public searchAvailablePhoneNumbers( + searchAvailablePhoneNumbers( args: SearchAvailablePhoneNumbersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchAvailablePhoneNumbersCommandOutput) => void ): void; - public searchAvailablePhoneNumbers( - args: SearchAvailablePhoneNumbersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchAvailablePhoneNumbersCommandOutput) => void), - cb?: (err: any, data?: SearchAvailablePhoneNumbersCommandOutput) => void - ): Promise | void { - const command = new SearchAvailablePhoneNumbersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Searches queues in an Amazon Connect instance, with optional filtering.

- */ - public searchQueues( - args: SearchQueuesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public searchQueues(args: SearchQueuesCommandInput, cb: (err: any, data?: SearchQueuesCommandOutput) => void): void; - public searchQueues( + + /** + * @see {@link SearchQueuesCommand} + */ + searchQueues(args: SearchQueuesCommandInput, options?: __HttpHandlerOptions): Promise; + searchQueues(args: SearchQueuesCommandInput, cb: (err: any, data?: SearchQueuesCommandOutput) => void): void; + searchQueues( args: SearchQueuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchQueuesCommandOutput) => void ): void; - public searchQueues( - args: SearchQueuesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchQueuesCommandOutput) => void), - cb?: (err: any, data?: SearchQueuesCommandOutput) => void - ): Promise | void { - const command = new SearchQueuesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Searches routing profiles in an Amazon Connect instance, with optional filtering.

- */ - public searchRoutingProfiles( + + /** + * @see {@link SearchRoutingProfilesCommand} + */ + searchRoutingProfiles( args: SearchRoutingProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchRoutingProfiles( + searchRoutingProfiles( args: SearchRoutingProfilesCommandInput, cb: (err: any, data?: SearchRoutingProfilesCommandOutput) => void ): void; - public searchRoutingProfiles( + searchRoutingProfiles( args: SearchRoutingProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchRoutingProfilesCommandOutput) => void ): void; - public searchRoutingProfiles( - args: SearchRoutingProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchRoutingProfilesCommandOutput) => void), - cb?: (err: any, data?: SearchRoutingProfilesCommandOutput) => void - ): Promise | void { - const command = new SearchRoutingProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Searches security profiles in an Amazon Connect instance, with optional - * filtering.

- */ - public searchSecurityProfiles( + + /** + * @see {@link SearchSecurityProfilesCommand} + */ + searchSecurityProfiles( args: SearchSecurityProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchSecurityProfiles( + searchSecurityProfiles( args: SearchSecurityProfilesCommandInput, cb: (err: any, data?: SearchSecurityProfilesCommandOutput) => void ): void; - public searchSecurityProfiles( + searchSecurityProfiles( args: SearchSecurityProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchSecurityProfilesCommandOutput) => void ): void; - public searchSecurityProfiles( - args: SearchSecurityProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchSecurityProfilesCommandOutput) => void), - cb?: (err: any, data?: SearchSecurityProfilesCommandOutput) => void - ): Promise | void { - const command = new SearchSecurityProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Searches users in an Amazon Connect instance, with optional filtering.

- * - *

- * AfterContactWorkTimeLimit is returned in milliseconds.

- *
- */ - public searchUsers(args: SearchUsersCommandInput, options?: __HttpHandlerOptions): Promise; - public searchUsers(args: SearchUsersCommandInput, cb: (err: any, data?: SearchUsersCommandOutput) => void): void; - public searchUsers( + + /** + * @see {@link SearchUsersCommand} + */ + searchUsers(args: SearchUsersCommandInput, options?: __HttpHandlerOptions): Promise; + searchUsers(args: SearchUsersCommandInput, cb: (err: any, data?: SearchUsersCommandOutput) => void): void; + searchUsers( args: SearchUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchUsersCommandOutput) => void ): void; - public searchUsers( - args: SearchUsersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchUsersCommandOutput) => void), - cb?: (err: any, data?: SearchUsersCommandOutput) => void - ): Promise | void { - const command = new SearchUsersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Searches for vocabularies within a specific Amazon Connect instance using - * State, NameStartsWith, and LanguageCode.

- */ - public searchVocabularies( + + /** + * @see {@link SearchVocabulariesCommand} + */ + searchVocabularies( args: SearchVocabulariesCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchVocabularies( + searchVocabularies( args: SearchVocabulariesCommandInput, cb: (err: any, data?: SearchVocabulariesCommandOutput) => void ): void; - public searchVocabularies( + searchVocabularies( args: SearchVocabulariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchVocabulariesCommandOutput) => void ): void; - public searchVocabularies( - args: SearchVocabulariesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchVocabulariesCommandOutput) => void), - cb?: (err: any, data?: SearchVocabulariesCommandOutput) => void - ): Promise | void { - const command = new SearchVocabulariesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Initiates a flow to start a new chat for the customer. Response of this API provides a token - * required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

- *

When a new chat contact is successfully created, clients must subscribe to the participant’s - * connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

- *

A 429 error occurs in the following situations:

- *
    - *
  • - *

    API rate limit is exceeded. API TPS throttling returns a TooManyRequests - * exception.

    - *
  • - *
  • - *

    The quota for concurrent active - * chats is exceeded. Active chat throttling returns a - * LimitExceededException.

    - *
  • - *
- *

If you use the ChatDurationInMinutes parameter and receive a 400 error, your - * account may not support the ability to configure custom chat durations. For more information, - * contact Amazon Web Services Support.

- *

For more information about chat, see Chat in the Amazon Connect - * Administrator Guide.

- */ - public startChatContact( + + /** + * @see {@link StartChatContactCommand} + */ + startChatContact( args: StartChatContactCommandInput, options?: __HttpHandlerOptions ): Promise; - public startChatContact( + startChatContact( args: StartChatContactCommandInput, cb: (err: any, data?: StartChatContactCommandOutput) => void ): void; - public startChatContact( + startChatContact( args: StartChatContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartChatContactCommandOutput) => void ): void; - public startChatContact( - args: StartChatContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartChatContactCommandOutput) => void), - cb?: (err: any, data?: StartChatContactCommandOutput) => void - ): Promise | void { - const command = new StartChatContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts recording the contact:

- *
    - *
  • - *

    If the API is called before the agent joins the call, recording - * starts when the agent joins the call.

    - *
  • - *
  • - *

    If the API is called after the agent joins the call, recording starts - * at the time of the API call.

    - *
  • - *
- *

StartContactRecording is a one-time action. For example, if you use StopContactRecording to - * stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios - * where the recording has started and you want to suspend and resume it, such as when collecting - * sensitive information (for example, a credit card number), use SuspendContactRecording and - * ResumeContactRecording.

- *

You can use this API to override the recording behavior configured in the Set recording - * behavior block.

- *

Only voice recordings are supported at this time.

- */ - public startContactRecording( + + /** + * @see {@link StartContactRecordingCommand} + */ + startContactRecording( args: StartContactRecordingCommandInput, options?: __HttpHandlerOptions ): Promise; - public startContactRecording( + startContactRecording( args: StartContactRecordingCommandInput, cb: (err: any, data?: StartContactRecordingCommandOutput) => void ): void; - public startContactRecording( + startContactRecording( args: StartContactRecordingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartContactRecordingCommandOutput) => void ): void; - public startContactRecording( - args: StartContactRecordingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartContactRecordingCommandOutput) => void), - cb?: (err: any, data?: StartContactRecordingCommandOutput) => void - ): Promise | void { - const command = new StartContactRecordingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Initiates real-time message streaming for a new chat contact.

- *

For more information about message streaming, see Enable real-time chat message - * streaming in the Amazon Connect Administrator Guide.

- */ - public startContactStreaming( + + /** + * @see {@link StartContactStreamingCommand} + */ + startContactStreaming( args: StartContactStreamingCommandInput, options?: __HttpHandlerOptions ): Promise; - public startContactStreaming( + startContactStreaming( args: StartContactStreamingCommandInput, cb: (err: any, data?: StartContactStreamingCommandOutput) => void ): void; - public startContactStreaming( + startContactStreaming( args: StartContactStreamingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartContactStreamingCommandOutput) => void ): void; - public startContactStreaming( - args: StartContactStreamingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartContactStreamingCommandOutput) => void), - cb?: (err: any, data?: StartContactStreamingCommandOutput) => void - ): Promise | void { - const command = new StartContactStreamingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Places an outbound call to a contact, and then initiates the flow. It performs the actions - * in the flow that's specified (in ContactFlowId).

- *

Agents do not initiate the outbound API, which means that they do not dial the contact. If - * the flow places an outbound call to a contact, and then puts the contact in queue, the call is - * then routed to the agent, like any other inbound case.

- *

There is a 60-second dialing timeout for this operation. If the call is not connected after - * 60 seconds, it fails.

- * - *

UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK - * mobile numbers, you must submit a service quota increase request. For more information, see - * Amazon Connect Service Quotas in the Amazon Connect Administrator - * Guide.

- *
- * - *

Campaign calls are not allowed by default. Before you can make a call with - * TrafficType = CAMPAIGN, you must submit a service quota increase - * request to the quota Amazon Connect campaigns.

- *
- */ - public startOutboundVoiceContact( + + /** + * @see {@link StartOutboundVoiceContactCommand} + */ + startOutboundVoiceContact( args: StartOutboundVoiceContactCommandInput, options?: __HttpHandlerOptions ): Promise; - public startOutboundVoiceContact( + startOutboundVoiceContact( args: StartOutboundVoiceContactCommandInput, cb: (err: any, data?: StartOutboundVoiceContactCommandOutput) => void ): void; - public startOutboundVoiceContact( + startOutboundVoiceContact( args: StartOutboundVoiceContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartOutboundVoiceContactCommandOutput) => void ): void; - public startOutboundVoiceContact( - args: StartOutboundVoiceContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartOutboundVoiceContactCommandOutput) => void), - cb?: (err: any, data?: StartOutboundVoiceContactCommandOutput) => void - ): Promise | void { - const command = new StartOutboundVoiceContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Initiates a flow to start a new task.

- */ - public startTaskContact( + + /** + * @see {@link StartTaskContactCommand} + */ + startTaskContact( args: StartTaskContactCommandInput, options?: __HttpHandlerOptions ): Promise; - public startTaskContact( + startTaskContact( args: StartTaskContactCommandInput, cb: (err: any, data?: StartTaskContactCommandOutput) => void ): void; - public startTaskContact( + startTaskContact( args: StartTaskContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTaskContactCommandOutput) => void ): void; - public startTaskContact( - args: StartTaskContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartTaskContactCommandOutput) => void), - cb?: (err: any, data?: StartTaskContactCommandOutput) => void - ): Promise | void { - const command = new StartTaskContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Ends the specified contact. This call does not work for the following initiation - * methods:

- *
    - *
  • - *

    DISCONNECT

    - *
  • - *
  • - *

    TRANSFER

    - *
  • - *
  • - *

    QUEUE_TRANSFER

    - *
  • - *
- */ - public stopContact(args: StopContactCommandInput, options?: __HttpHandlerOptions): Promise; - public stopContact(args: StopContactCommandInput, cb: (err: any, data?: StopContactCommandOutput) => void): void; - public stopContact( + + /** + * @see {@link StopContactCommand} + */ + stopContact(args: StopContactCommandInput, options?: __HttpHandlerOptions): Promise; + stopContact(args: StopContactCommandInput, cb: (err: any, data?: StopContactCommandOutput) => void): void; + stopContact( args: StopContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopContactCommandOutput) => void ): void; - public stopContact( - args: StopContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopContactCommandOutput) => void), - cb?: (err: any, data?: StopContactCommandOutput) => void - ): Promise | void { - const command = new StopContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops recording a call when a contact is being recorded. StopContactRecording is a one-time - * action. If you use StopContactRecording to stop recording an ongoing call, you can't use - * StartContactRecording to restart it. For scenarios where the recording has started and you want - * to suspend it for sensitive information (for example, to collect a credit card number), and then - * restart it, use SuspendContactRecording and ResumeContactRecording.

- *

Only voice recordings are supported at this time.

- */ - public stopContactRecording( + + /** + * @see {@link StopContactRecordingCommand} + */ + stopContactRecording( args: StopContactRecordingCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopContactRecording( + stopContactRecording( args: StopContactRecordingCommandInput, cb: (err: any, data?: StopContactRecordingCommandOutput) => void ): void; - public stopContactRecording( + stopContactRecording( args: StopContactRecordingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopContactRecordingCommandOutput) => void ): void; - public stopContactRecording( - args: StopContactRecordingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopContactRecordingCommandOutput) => void), - cb?: (err: any, data?: StopContactRecordingCommandOutput) => void - ): Promise | void { - const command = new StopContactRecordingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Ends message streaming on a specified contact. To restart message streaming on that - * contact, call the StartContactStreaming - * API.

- */ - public stopContactStreaming( + + /** + * @see {@link StopContactStreamingCommand} + */ + stopContactStreaming( args: StopContactStreamingCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopContactStreaming( + stopContactStreaming( args: StopContactStreamingCommandInput, cb: (err: any, data?: StopContactStreamingCommandOutput) => void ): void; - public stopContactStreaming( + stopContactStreaming( args: StopContactStreamingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopContactStreamingCommandOutput) => void ): void; - public stopContactStreaming( - args: StopContactStreamingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopContactStreamingCommandOutput) => void), - cb?: (err: any, data?: StopContactStreamingCommandOutput) => void - ): Promise | void { - const command = new StopContactStreamingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

When a contact is being recorded, this API suspends recording the call. For example, you - * might suspend the call recording while collecting sensitive information, such as a credit card - * number. Then use ResumeContactRecording to restart recording.

- *

The period of time that the recording is suspended is filled with silence in the final - * recording.

- *

Only voice recordings are supported at this time.

- */ - public suspendContactRecording( + + /** + * @see {@link SuspendContactRecordingCommand} + */ + suspendContactRecording( args: SuspendContactRecordingCommandInput, options?: __HttpHandlerOptions ): Promise; - public suspendContactRecording( + suspendContactRecording( args: SuspendContactRecordingCommandInput, cb: (err: any, data?: SuspendContactRecordingCommandOutput) => void ): void; - public suspendContactRecording( + suspendContactRecording( args: SuspendContactRecordingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SuspendContactRecordingCommandOutput) => void ): void; - public suspendContactRecording( - args: SuspendContactRecordingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SuspendContactRecordingCommandOutput) => void), - cb?: (err: any, data?: SuspendContactRecordingCommandOutput) => void - ): Promise | void { - const command = new SuspendContactRecordingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds the specified tags to the specified resource.

- *

Some of the supported resource types are agents, routing profiles, queues, quick connects, - * contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task - * templates. For a complete list, see Tagging resources in Amazon Connect.

- *

For sample policies that use tags, see Amazon Connect - * Identity-Based Policy Examples in the Amazon Connect Administrator - * Guide.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Transfers contacts from one agent or queue to another agent or queue at any point after a - * contact is created. You can transfer a contact to another queue by providing the flow which - * orchestrates the contact to the destination queue. This gives you more control over contact - * handling and helps you adhere to the service level agreement (SLA) guaranteed to your - * customers.

- *

Note the following requirements:

- *
    - *
  • - *

    Transfer is supported for only TASK contacts.

    - *
  • - *
  • - *

    Do not use both QueueId and UserId in the same call.

    - *
  • - *
  • - *

    The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer - * to queue flow.

    - *
  • - *
  • - *

    The TransferContact API can be called only on active contacts.

    - *
  • - *
  • - *

    A contact cannot be transferred more than 11 times.

    - *
  • - *
- */ - public transferContact( + + /** + * @see {@link TransferContactCommand} + */ + transferContact( args: TransferContactCommandInput, options?: __HttpHandlerOptions ): Promise; - public transferContact( - args: TransferContactCommandInput, - cb: (err: any, data?: TransferContactCommandOutput) => void - ): void; - public transferContact( + transferContact(args: TransferContactCommandInput, cb: (err: any, data?: TransferContactCommandOutput) => void): void; + transferContact( args: TransferContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TransferContactCommandOutput) => void ): void; - public transferContact( - args: TransferContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TransferContactCommandOutput) => void), - cb?: (err: any, data?: TransferContactCommandOutput) => void - ): Promise | void { - const command = new TransferContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the specified tags from the specified resource.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Updates agent status.

- */ - public updateAgentStatus( + + /** + * @see {@link UpdateAgentStatusCommand} + */ + updateAgentStatus( args: UpdateAgentStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAgentStatus( + updateAgentStatus( args: UpdateAgentStatusCommandInput, cb: (err: any, data?: UpdateAgentStatusCommandOutput) => void ): void; - public updateAgentStatus( + updateAgentStatus( args: UpdateAgentStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAgentStatusCommandOutput) => void ): void; - public updateAgentStatus( - args: UpdateAgentStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAgentStatusCommandOutput) => void), - cb?: (err: any, data?: UpdateAgentStatusCommandOutput) => void - ): Promise | void { - const command = new UpdateAgentStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Adds or updates user-defined contact information associated with the specified contact. At - * least one field to be updated must be present in the request.

- * - *

You can add or update user-defined contact information for both ongoing and completed - * contacts.

- *
- */ - public updateContact( - args: UpdateContactCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateContact( - args: UpdateContactCommandInput, - cb: (err: any, data?: UpdateContactCommandOutput) => void - ): void; - public updateContact( + + /** + * @see {@link UpdateContactCommand} + */ + updateContact(args: UpdateContactCommandInput, options?: __HttpHandlerOptions): Promise; + updateContact(args: UpdateContactCommandInput, cb: (err: any, data?: UpdateContactCommandOutput) => void): void; + updateContact( args: UpdateContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContactCommandOutput) => void ): void; - public updateContact( - args: UpdateContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateContactCommandOutput) => void), - cb?: (err: any, data?: UpdateContactCommandOutput) => void - ): Promise | void { - const command = new UpdateContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or updates - * user-defined contact attributes - * associated with the specified contact.

- *

You can create or update user-defined attributes for both ongoing and completed contacts. - * For example, while the call is active, you can update the customer's name or the reason the - * customer called. You can add notes about steps that the agent took during the call that display - * to the next agent that takes the call. You can also update attributes for a contact using data - * from your CRM application and save the data with the contact in Amazon Connect. You could - * also flag calls for additional analysis, such as legal review or to identify abusive - * callers.

- *

Contact attributes are available in Amazon Connect for 24 months, and are then deleted. - * For information about contact record retention and the maximum size of the contact record - * attributes section, see Feature - * specifications in the Amazon Connect Administrator Guide.

- */ - public updateContactAttributes( + + /** + * @see {@link UpdateContactAttributesCommand} + */ + updateContactAttributes( args: UpdateContactAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateContactAttributes( + updateContactAttributes( args: UpdateContactAttributesCommandInput, cb: (err: any, data?: UpdateContactAttributesCommandOutput) => void ): void; - public updateContactAttributes( + updateContactAttributes( args: UpdateContactAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContactAttributesCommandOutput) => void ): void; - public updateContactAttributes( - args: UpdateContactAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateContactAttributesCommandOutput) => void), - cb?: (err: any, data?: UpdateContactAttributesCommandOutput) => void - ): Promise | void { - const command = new UpdateContactAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the specified flow.

- *

You can also create and update flows using the Amazon Connect - * Flow language.

- */ - public updateContactFlowContent( + + /** + * @see {@link UpdateContactFlowContentCommand} + */ + updateContactFlowContent( args: UpdateContactFlowContentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateContactFlowContent( + updateContactFlowContent( args: UpdateContactFlowContentCommandInput, cb: (err: any, data?: UpdateContactFlowContentCommandOutput) => void ): void; - public updateContactFlowContent( + updateContactFlowContent( args: UpdateContactFlowContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContactFlowContentCommandOutput) => void ): void; - public updateContactFlowContent( - args: UpdateContactFlowContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateContactFlowContentCommandOutput) => void), - cb?: (err: any, data?: UpdateContactFlowContentCommandOutput) => void - ): Promise | void { - const command = new UpdateContactFlowContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates metadata about specified flow.

- */ - public updateContactFlowMetadata( + + /** + * @see {@link UpdateContactFlowMetadataCommand} + */ + updateContactFlowMetadata( args: UpdateContactFlowMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateContactFlowMetadata( + updateContactFlowMetadata( args: UpdateContactFlowMetadataCommandInput, cb: (err: any, data?: UpdateContactFlowMetadataCommandOutput) => void ): void; - public updateContactFlowMetadata( + updateContactFlowMetadata( args: UpdateContactFlowMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContactFlowMetadataCommandOutput) => void ): void; - public updateContactFlowMetadata( - args: UpdateContactFlowMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateContactFlowMetadataCommandOutput) => void), - cb?: (err: any, data?: UpdateContactFlowMetadataCommandOutput) => void - ): Promise | void { - const command = new UpdateContactFlowMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates specified flow module for the specified Amazon Connect instance.

- */ - public updateContactFlowModuleContent( + + /** + * @see {@link UpdateContactFlowModuleContentCommand} + */ + updateContactFlowModuleContent( args: UpdateContactFlowModuleContentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateContactFlowModuleContent( + updateContactFlowModuleContent( args: UpdateContactFlowModuleContentCommandInput, cb: (err: any, data?: UpdateContactFlowModuleContentCommandOutput) => void ): void; - public updateContactFlowModuleContent( + updateContactFlowModuleContent( args: UpdateContactFlowModuleContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContactFlowModuleContentCommandOutput) => void ): void; - public updateContactFlowModuleContent( - args: UpdateContactFlowModuleContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateContactFlowModuleContentCommandOutput) => void), - cb?: (err: any, data?: UpdateContactFlowModuleContentCommandOutput) => void - ): Promise | void { - const command = new UpdateContactFlowModuleContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates metadata about specified flow module.

- */ - public updateContactFlowModuleMetadata( + + /** + * @see {@link UpdateContactFlowModuleMetadataCommand} + */ + updateContactFlowModuleMetadata( args: UpdateContactFlowModuleMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateContactFlowModuleMetadata( + updateContactFlowModuleMetadata( args: UpdateContactFlowModuleMetadataCommandInput, cb: (err: any, data?: UpdateContactFlowModuleMetadataCommandOutput) => void ): void; - public updateContactFlowModuleMetadata( + updateContactFlowModuleMetadata( args: UpdateContactFlowModuleMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContactFlowModuleMetadataCommandOutput) => void ): void; - public updateContactFlowModuleMetadata( - args: UpdateContactFlowModuleMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateContactFlowModuleMetadataCommandOutput) => void), - cb?: (err: any, data?: UpdateContactFlowModuleMetadataCommandOutput) => void - ): Promise | void { - const command = new UpdateContactFlowModuleMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

The name of the flow.

- *

You can also create and update flows using the Amazon Connect - * Flow language.

- */ - public updateContactFlowName( + + /** + * @see {@link UpdateContactFlowNameCommand} + */ + updateContactFlowName( args: UpdateContactFlowNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateContactFlowName( + updateContactFlowName( args: UpdateContactFlowNameCommandInput, cb: (err: any, data?: UpdateContactFlowNameCommandOutput) => void ): void; - public updateContactFlowName( + updateContactFlowName( args: UpdateContactFlowNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContactFlowNameCommandOutput) => void ): void; - public updateContactFlowName( - args: UpdateContactFlowNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateContactFlowNameCommandOutput) => void), - cb?: (err: any, data?: UpdateContactFlowNameCommandOutput) => void - ): Promise | void { - const command = new UpdateContactFlowNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the scheduled time of a task contact that is already scheduled.

- */ - public updateContactSchedule( + + /** + * @see {@link UpdateContactScheduleCommand} + */ + updateContactSchedule( args: UpdateContactScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateContactSchedule( + updateContactSchedule( args: UpdateContactScheduleCommandInput, cb: (err: any, data?: UpdateContactScheduleCommandOutput) => void ): void; - public updateContactSchedule( + updateContactSchedule( args: UpdateContactScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContactScheduleCommandOutput) => void ): void; - public updateContactSchedule( - args: UpdateContactScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateContactScheduleCommandOutput) => void), - cb?: (err: any, data?: UpdateContactScheduleCommandOutput) => void - ): Promise | void { - const command = new UpdateContactScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Updates the hours of operation.

- */ - public updateHoursOfOperation( + + /** + * @see {@link UpdateHoursOfOperationCommand} + */ + updateHoursOfOperation( args: UpdateHoursOfOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateHoursOfOperation( + updateHoursOfOperation( args: UpdateHoursOfOperationCommandInput, cb: (err: any, data?: UpdateHoursOfOperationCommandOutput) => void ): void; - public updateHoursOfOperation( + updateHoursOfOperation( args: UpdateHoursOfOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateHoursOfOperationCommandOutput) => void ): void; - public updateHoursOfOperation( - args: UpdateHoursOfOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateHoursOfOperationCommandOutput) => void), - cb?: (err: any, data?: UpdateHoursOfOperationCommandOutput) => void - ): Promise | void { - const command = new UpdateHoursOfOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Updates the value for the specified attribute type.

- */ - public updateInstanceAttribute( + + /** + * @see {@link UpdateInstanceAttributeCommand} + */ + updateInstanceAttribute( args: UpdateInstanceAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateInstanceAttribute( + updateInstanceAttribute( args: UpdateInstanceAttributeCommandInput, cb: (err: any, data?: UpdateInstanceAttributeCommandOutput) => void ): void; - public updateInstanceAttribute( + updateInstanceAttribute( args: UpdateInstanceAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateInstanceAttributeCommandOutput) => void ): void; - public updateInstanceAttribute( - args: UpdateInstanceAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateInstanceAttributeCommandOutput) => void), - cb?: (err: any, data?: UpdateInstanceAttributeCommandOutput) => void - ): Promise | void { - const command = new UpdateInstanceAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Updates an existing configuration for a resource type. This API is idempotent.

- */ - public updateInstanceStorageConfig( + + /** + * @see {@link UpdateInstanceStorageConfigCommand} + */ + updateInstanceStorageConfig( args: UpdateInstanceStorageConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateInstanceStorageConfig( + updateInstanceStorageConfig( args: UpdateInstanceStorageConfigCommandInput, cb: (err: any, data?: UpdateInstanceStorageConfigCommandOutput) => void ): void; - public updateInstanceStorageConfig( + updateInstanceStorageConfig( args: UpdateInstanceStorageConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateInstanceStorageConfigCommandOutput) => void ): void; - public updateInstanceStorageConfig( - args: UpdateInstanceStorageConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateInstanceStorageConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateInstanceStorageConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateInstanceStorageConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates timeouts for when human chat participants are to be considered idle, and when agents - * are automatically disconnected from a chat due to idleness. You can set four timers:

- *
    - *
  • - *

    Customer idle timeout

    - *
  • - *
  • - *

    Customer auto-disconnect timeout

    - *
  • - *
  • - *

    Agent idle timeout

    - *
  • - *
  • - *

    Agent auto-disconnect timeout

    - *
  • - *
- *

For more information about how chat timeouts work, see - * Set up chat timeouts for human participants.

- */ - public updateParticipantRoleConfig( + + /** + * @see {@link UpdateParticipantRoleConfigCommand} + */ + updateParticipantRoleConfig( args: UpdateParticipantRoleConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateParticipantRoleConfig( + updateParticipantRoleConfig( args: UpdateParticipantRoleConfigCommandInput, cb: (err: any, data?: UpdateParticipantRoleConfigCommandOutput) => void ): void; - public updateParticipantRoleConfig( + updateParticipantRoleConfig( args: UpdateParticipantRoleConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateParticipantRoleConfigCommandOutput) => void ): void; - public updateParticipantRoleConfig( - args: UpdateParticipantRoleConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateParticipantRoleConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateParticipantRoleConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateParticipantRoleConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to - * another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.

- * - *

You can call DescribePhoneNumber API - * to verify the status of a previous UpdatePhoneNumber - * operation.

- *
- */ - public updatePhoneNumber( + + /** + * @see {@link UpdatePhoneNumberCommand} + */ + updatePhoneNumber( args: UpdatePhoneNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePhoneNumber( + updatePhoneNumber( args: UpdatePhoneNumberCommandInput, cb: (err: any, data?: UpdatePhoneNumberCommandOutput) => void ): void; - public updatePhoneNumber( + updatePhoneNumber( args: UpdatePhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePhoneNumberCommandOutput) => void ): void; - public updatePhoneNumber( - args: UpdatePhoneNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePhoneNumberCommandOutput) => void), - cb?: (err: any, data?: UpdatePhoneNumberCommandOutput) => void - ): Promise | void { - const command = new UpdatePhoneNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Updates the hours of operation for the specified queue.

- */ - public updateQueueHoursOfOperation( + + /** + * @see {@link UpdateQueueHoursOfOperationCommand} + */ + updateQueueHoursOfOperation( args: UpdateQueueHoursOfOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateQueueHoursOfOperation( + updateQueueHoursOfOperation( args: UpdateQueueHoursOfOperationCommandInput, cb: (err: any, data?: UpdateQueueHoursOfOperationCommandOutput) => void ): void; - public updateQueueHoursOfOperation( + updateQueueHoursOfOperation( args: UpdateQueueHoursOfOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateQueueHoursOfOperationCommandOutput) => void ): void; - public updateQueueHoursOfOperation( - args: UpdateQueueHoursOfOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateQueueHoursOfOperationCommandOutput) => void), - cb?: (err: any, data?: UpdateQueueHoursOfOperationCommandOutput) => void - ): Promise | void { - const command = new UpdateQueueHoursOfOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Updates the maximum number of contacts allowed in a queue before it is considered - * full.

- */ - public updateQueueMaxContacts( + + /** + * @see {@link UpdateQueueMaxContactsCommand} + */ + updateQueueMaxContacts( args: UpdateQueueMaxContactsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateQueueMaxContacts( + updateQueueMaxContacts( args: UpdateQueueMaxContactsCommandInput, cb: (err: any, data?: UpdateQueueMaxContactsCommandOutput) => void ): void; - public updateQueueMaxContacts( + updateQueueMaxContacts( args: UpdateQueueMaxContactsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateQueueMaxContactsCommandOutput) => void ): void; - public updateQueueMaxContacts( - args: UpdateQueueMaxContactsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateQueueMaxContactsCommandOutput) => void), - cb?: (err: any, data?: UpdateQueueMaxContactsCommandOutput) => void - ): Promise | void { - const command = new UpdateQueueMaxContactsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Updates the name and description of a queue. At least Name or Description must be provided.

- */ - public updateQueueName( + + /** + * @see {@link UpdateQueueNameCommand} + */ + updateQueueName( args: UpdateQueueNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateQueueName( - args: UpdateQueueNameCommandInput, - cb: (err: any, data?: UpdateQueueNameCommandOutput) => void - ): void; - public updateQueueName( + updateQueueName(args: UpdateQueueNameCommandInput, cb: (err: any, data?: UpdateQueueNameCommandOutput) => void): void; + updateQueueName( args: UpdateQueueNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateQueueNameCommandOutput) => void ): void; - public updateQueueName( - args: UpdateQueueNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateQueueNameCommandOutput) => void), - cb?: (err: any, data?: UpdateQueueNameCommandOutput) => void - ): Promise | void { - const command = new UpdateQueueNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Updates the outbound caller ID name, number, and outbound whisper flow for a specified - * queue.

- * - *

If the number being used in the input is claimed to a traffic distribution group, and you are calling this API - * using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use - * either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value - * of the OutboundCallerConfig request body parameter. However, if the number is claimed to a - * traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region - * associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided - * in - * this scenario, you will receive a - * ResourceNotFoundException.

- *
- */ - public updateQueueOutboundCallerConfig( + + /** + * @see {@link UpdateQueueOutboundCallerConfigCommand} + */ + updateQueueOutboundCallerConfig( args: UpdateQueueOutboundCallerConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateQueueOutboundCallerConfig( + updateQueueOutboundCallerConfig( args: UpdateQueueOutboundCallerConfigCommandInput, cb: (err: any, data?: UpdateQueueOutboundCallerConfigCommandOutput) => void ): void; - public updateQueueOutboundCallerConfig( + updateQueueOutboundCallerConfig( args: UpdateQueueOutboundCallerConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateQueueOutboundCallerConfigCommandOutput) => void ): void; - public updateQueueOutboundCallerConfig( - args: UpdateQueueOutboundCallerConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateQueueOutboundCallerConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateQueueOutboundCallerConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateQueueOutboundCallerConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Updates the status of the queue.

- */ - public updateQueueStatus( + + /** + * @see {@link UpdateQueueStatusCommand} + */ + updateQueueStatus( args: UpdateQueueStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateQueueStatus( + updateQueueStatus( args: UpdateQueueStatusCommandInput, cb: (err: any, data?: UpdateQueueStatusCommandOutput) => void ): void; - public updateQueueStatus( + updateQueueStatus( args: UpdateQueueStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateQueueStatusCommandOutput) => void ): void; - public updateQueueStatus( - args: UpdateQueueStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateQueueStatusCommandOutput) => void), - cb?: (err: any, data?: UpdateQueueStatusCommandOutput) => void - ): Promise | void { - const command = new UpdateQueueStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the configuration settings for the specified quick connect.

- */ - public updateQuickConnectConfig( + + /** + * @see {@link UpdateQuickConnectConfigCommand} + */ + updateQuickConnectConfig( args: UpdateQuickConnectConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateQuickConnectConfig( + updateQuickConnectConfig( args: UpdateQuickConnectConfigCommandInput, cb: (err: any, data?: UpdateQuickConnectConfigCommandOutput) => void ): void; - public updateQuickConnectConfig( + updateQuickConnectConfig( args: UpdateQuickConnectConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateQuickConnectConfigCommandOutput) => void ): void; - public updateQuickConnectConfig( - args: UpdateQuickConnectConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateQuickConnectConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateQuickConnectConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateQuickConnectConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.

- */ - public updateQuickConnectName( + + /** + * @see {@link UpdateQuickConnectNameCommand} + */ + updateQuickConnectName( args: UpdateQuickConnectNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateQuickConnectName( + updateQuickConnectName( args: UpdateQuickConnectNameCommandInput, cb: (err: any, data?: UpdateQuickConnectNameCommandOutput) => void ): void; - public updateQuickConnectName( + updateQuickConnectName( args: UpdateQuickConnectNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateQuickConnectNameCommandOutput) => void ): void; - public updateQuickConnectName( - args: UpdateQuickConnectNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateQuickConnectNameCommandOutput) => void), - cb?: (err: any, data?: UpdateQuickConnectNameCommandOutput) => void - ): Promise | void { - const command = new UpdateQuickConnectNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing - * profile.

- */ - public updateRoutingProfileConcurrency( + + /** + * @see {@link UpdateRoutingProfileConcurrencyCommand} + */ + updateRoutingProfileConcurrency( args: UpdateRoutingProfileConcurrencyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRoutingProfileConcurrency( + updateRoutingProfileConcurrency( args: UpdateRoutingProfileConcurrencyCommandInput, cb: (err: any, data?: UpdateRoutingProfileConcurrencyCommandOutput) => void ): void; - public updateRoutingProfileConcurrency( + updateRoutingProfileConcurrency( args: UpdateRoutingProfileConcurrencyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRoutingProfileConcurrencyCommandOutput) => void ): void; - public updateRoutingProfileConcurrency( - args: UpdateRoutingProfileConcurrencyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRoutingProfileConcurrencyCommandOutput) => void), - cb?: (err: any, data?: UpdateRoutingProfileConcurrencyCommandOutput) => void - ): Promise | void { - const command = new UpdateRoutingProfileConcurrencyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the default outbound queue of a routing profile.

- */ - public updateRoutingProfileDefaultOutboundQueue( + + /** + * @see {@link UpdateRoutingProfileDefaultOutboundQueueCommand} + */ + updateRoutingProfileDefaultOutboundQueue( args: UpdateRoutingProfileDefaultOutboundQueueCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRoutingProfileDefaultOutboundQueue( + updateRoutingProfileDefaultOutboundQueue( args: UpdateRoutingProfileDefaultOutboundQueueCommandInput, cb: (err: any, data?: UpdateRoutingProfileDefaultOutboundQueueCommandOutput) => void ): void; - public updateRoutingProfileDefaultOutboundQueue( + updateRoutingProfileDefaultOutboundQueue( args: UpdateRoutingProfileDefaultOutboundQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRoutingProfileDefaultOutboundQueueCommandOutput) => void ): void; - public updateRoutingProfileDefaultOutboundQueue( - args: UpdateRoutingProfileDefaultOutboundQueueCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateRoutingProfileDefaultOutboundQueueCommandOutput) => void), - cb?: (err: any, data?: UpdateRoutingProfileDefaultOutboundQueueCommandOutput) => void - ): Promise | void { - const command = new UpdateRoutingProfileDefaultOutboundQueueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the name and description of a routing profile. The request accepts the following data in JSON format. - * At least Name or Description must be provided.

- */ - public updateRoutingProfileName( + + /** + * @see {@link UpdateRoutingProfileNameCommand} + */ + updateRoutingProfileName( args: UpdateRoutingProfileNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRoutingProfileName( + updateRoutingProfileName( args: UpdateRoutingProfileNameCommandInput, cb: (err: any, data?: UpdateRoutingProfileNameCommandOutput) => void ): void; - public updateRoutingProfileName( + updateRoutingProfileName( args: UpdateRoutingProfileNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRoutingProfileNameCommandOutput) => void ): void; - public updateRoutingProfileName( - args: UpdateRoutingProfileNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRoutingProfileNameCommandOutput) => void), - cb?: (err: any, data?: UpdateRoutingProfileNameCommandOutput) => void - ): Promise | void { - const command = new UpdateRoutingProfileNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the properties associated with a set of queues for a routing profile.

- */ - public updateRoutingProfileQueues( + + /** + * @see {@link UpdateRoutingProfileQueuesCommand} + */ + updateRoutingProfileQueues( args: UpdateRoutingProfileQueuesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRoutingProfileQueues( + updateRoutingProfileQueues( args: UpdateRoutingProfileQueuesCommandInput, cb: (err: any, data?: UpdateRoutingProfileQueuesCommandOutput) => void ): void; - public updateRoutingProfileQueues( + updateRoutingProfileQueues( args: UpdateRoutingProfileQueuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRoutingProfileQueuesCommandOutput) => void ): void; - public updateRoutingProfileQueues( - args: UpdateRoutingProfileQueuesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRoutingProfileQueuesCommandOutput) => void), - cb?: (err: any, data?: UpdateRoutingProfileQueuesCommandOutput) => void - ): Promise | void { - const command = new UpdateRoutingProfileQueuesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a rule for the specified Amazon Connect instance.

- *

Use the Rules Function language to - * code conditions for the rule.

- */ - public updateRule(args: UpdateRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public updateRule(args: UpdateRuleCommandInput, cb: (err: any, data?: UpdateRuleCommandOutput) => void): void; - public updateRule( + + /** + * @see {@link UpdateRuleCommand} + */ + updateRule(args: UpdateRuleCommandInput, options?: __HttpHandlerOptions): Promise; + updateRule(args: UpdateRuleCommandInput, cb: (err: any, data?: UpdateRuleCommandOutput) => void): void; + updateRule( args: UpdateRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRuleCommandOutput) => void ): void; - public updateRule( - args: UpdateRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRuleCommandOutput) => void), - cb?: (err: any, data?: UpdateRuleCommandOutput) => void - ): Promise | void { - const command = new UpdateRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API is in preview release for Amazon Connect and is subject to change.

- *

Updates a security profile.

- */ - public updateSecurityProfile( + + /** + * @see {@link UpdateSecurityProfileCommand} + */ + updateSecurityProfile( args: UpdateSecurityProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSecurityProfile( + updateSecurityProfile( args: UpdateSecurityProfileCommandInput, cb: (err: any, data?: UpdateSecurityProfileCommandOutput) => void ): void; - public updateSecurityProfile( + updateSecurityProfile( args: UpdateSecurityProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSecurityProfileCommandOutput) => void ): void; - public updateSecurityProfile( - args: UpdateSecurityProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSecurityProfileCommandOutput) => void), - cb?: (err: any, data?: UpdateSecurityProfileCommandOutput) => void - ): Promise | void { - const command = new UpdateSecurityProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates details about a specific task template in the specified Amazon Connect instance. - * This operation does not support partial updates. Instead it does a full update of template - * content.

- */ - public updateTaskTemplate( + + /** + * @see {@link UpdateTaskTemplateCommand} + */ + updateTaskTemplate( args: UpdateTaskTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTaskTemplate( + updateTaskTemplate( args: UpdateTaskTemplateCommandInput, cb: (err: any, data?: UpdateTaskTemplateCommandOutput) => void ): void; - public updateTaskTemplate( + updateTaskTemplate( args: UpdateTaskTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTaskTemplateCommandOutput) => void ): void; - public updateTaskTemplate( - args: UpdateTaskTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTaskTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateTaskTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateTaskTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the traffic distribution for a given traffic distribution group.

- *

For more information about updating a traffic distribution group, see Update telephony - * traffic distribution across Amazon Web Services Regions - * in the Amazon Connect Administrator Guide.

- */ - public updateTrafficDistribution( + + /** + * @see {@link UpdateTrafficDistributionCommand} + */ + updateTrafficDistribution( args: UpdateTrafficDistributionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTrafficDistribution( + updateTrafficDistribution( args: UpdateTrafficDistributionCommandInput, cb: (err: any, data?: UpdateTrafficDistributionCommandOutput) => void ): void; - public updateTrafficDistribution( + updateTrafficDistribution( args: UpdateTrafficDistributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTrafficDistributionCommandOutput) => void ): void; - public updateTrafficDistribution( - args: UpdateTrafficDistributionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTrafficDistributionCommandOutput) => void), - cb?: (err: any, data?: UpdateTrafficDistributionCommandOutput) => void - ): Promise | void { - const command = new UpdateTrafficDistributionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Assigns the specified hierarchy group to the specified user.

- */ - public updateUserHierarchy( + + /** + * @see {@link UpdateUserHierarchyCommand} + */ + updateUserHierarchy( args: UpdateUserHierarchyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateUserHierarchy( + updateUserHierarchy( args: UpdateUserHierarchyCommandInput, cb: (err: any, data?: UpdateUserHierarchyCommandOutput) => void ): void; - public updateUserHierarchy( + updateUserHierarchy( args: UpdateUserHierarchyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserHierarchyCommandOutput) => void ): void; - public updateUserHierarchy( - args: UpdateUserHierarchyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserHierarchyCommandOutput) => void), - cb?: (err: any, data?: UpdateUserHierarchyCommandOutput) => void - ): Promise | void { - const command = new UpdateUserHierarchyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the name of the user hierarchy group.

- */ - public updateUserHierarchyGroupName( + + /** + * @see {@link UpdateUserHierarchyGroupNameCommand} + */ + updateUserHierarchyGroupName( args: UpdateUserHierarchyGroupNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateUserHierarchyGroupName( + updateUserHierarchyGroupName( args: UpdateUserHierarchyGroupNameCommandInput, cb: (err: any, data?: UpdateUserHierarchyGroupNameCommandOutput) => void ): void; - public updateUserHierarchyGroupName( + updateUserHierarchyGroupName( args: UpdateUserHierarchyGroupNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserHierarchyGroupNameCommandOutput) => void ): void; - public updateUserHierarchyGroupName( - args: UpdateUserHierarchyGroupNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserHierarchyGroupNameCommandOutput) => void), - cb?: (err: any, data?: UpdateUserHierarchyGroupNameCommandOutput) => void - ): Promise | void { - const command = new UpdateUserHierarchyGroupNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.

- */ - public updateUserHierarchyStructure( + + /** + * @see {@link UpdateUserHierarchyStructureCommand} + */ + updateUserHierarchyStructure( args: UpdateUserHierarchyStructureCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateUserHierarchyStructure( + updateUserHierarchyStructure( args: UpdateUserHierarchyStructureCommandInput, cb: (err: any, data?: UpdateUserHierarchyStructureCommandOutput) => void ): void; - public updateUserHierarchyStructure( + updateUserHierarchyStructure( args: UpdateUserHierarchyStructureCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserHierarchyStructureCommandOutput) => void ): void; - public updateUserHierarchyStructure( - args: UpdateUserHierarchyStructureCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserHierarchyStructureCommandOutput) => void), - cb?: (err: any, data?: UpdateUserHierarchyStructureCommandOutput) => void - ): Promise | void { - const command = new UpdateUserHierarchyStructureCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the identity information for the specified user.

- * - *

We strongly recommend limiting who has the ability to invoke - * UpdateUserIdentityInfo. Someone with that ability can change the login credentials - * of other users by changing their email address. This poses a security risk to your organization. - * They can change the email address of a user to the attacker's email address, and then reset the - * password through email. For more information, see Best Practices for - * Security Profiles in the Amazon Connect Administrator - * Guide.

- *
- */ - public updateUserIdentityInfo( + + /** + * @see {@link UpdateUserIdentityInfoCommand} + */ + updateUserIdentityInfo( args: UpdateUserIdentityInfoCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateUserIdentityInfo( + updateUserIdentityInfo( args: UpdateUserIdentityInfoCommandInput, cb: (err: any, data?: UpdateUserIdentityInfoCommandOutput) => void ): void; - public updateUserIdentityInfo( + updateUserIdentityInfo( args: UpdateUserIdentityInfoCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserIdentityInfoCommandOutput) => void ): void; - public updateUserIdentityInfo( - args: UpdateUserIdentityInfoCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserIdentityInfoCommandOutput) => void), - cb?: (err: any, data?: UpdateUserIdentityInfoCommandOutput) => void - ): Promise | void { - const command = new UpdateUserIdentityInfoCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the phone configuration settings for the specified user.

- */ - public updateUserPhoneConfig( + + /** + * @see {@link UpdateUserPhoneConfigCommand} + */ + updateUserPhoneConfig( args: UpdateUserPhoneConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateUserPhoneConfig( + updateUserPhoneConfig( args: UpdateUserPhoneConfigCommandInput, cb: (err: any, data?: UpdateUserPhoneConfigCommandOutput) => void ): void; - public updateUserPhoneConfig( + updateUserPhoneConfig( args: UpdateUserPhoneConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserPhoneConfigCommandOutput) => void ): void; - public updateUserPhoneConfig( - args: UpdateUserPhoneConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserPhoneConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateUserPhoneConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateUserPhoneConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Assigns the specified routing profile to the specified user.

- */ - public updateUserRoutingProfile( + + /** + * @see {@link UpdateUserRoutingProfileCommand} + */ + updateUserRoutingProfile( args: UpdateUserRoutingProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateUserRoutingProfile( + updateUserRoutingProfile( args: UpdateUserRoutingProfileCommandInput, cb: (err: any, data?: UpdateUserRoutingProfileCommandOutput) => void ): void; - public updateUserRoutingProfile( + updateUserRoutingProfile( args: UpdateUserRoutingProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserRoutingProfileCommandOutput) => void ): void; - public updateUserRoutingProfile( - args: UpdateUserRoutingProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserRoutingProfileCommandOutput) => void), - cb?: (err: any, data?: UpdateUserRoutingProfileCommandOutput) => void - ): Promise | void { - const command = new UpdateUserRoutingProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Assigns the specified security profiles to the specified user.

- */ - public updateUserSecurityProfiles( + + /** + * @see {@link UpdateUserSecurityProfilesCommand} + */ + updateUserSecurityProfiles( args: UpdateUserSecurityProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateUserSecurityProfiles( + updateUserSecurityProfiles( args: UpdateUserSecurityProfilesCommandInput, cb: (err: any, data?: UpdateUserSecurityProfilesCommandOutput) => void ): void; - public updateUserSecurityProfiles( + updateUserSecurityProfiles( args: UpdateUserSecurityProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserSecurityProfilesCommandOutput) => void ): void; - public updateUserSecurityProfiles( - args: UpdateUserSecurityProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserSecurityProfilesCommandOutput) => void), - cb?: (err: any, data?: UpdateUserSecurityProfilesCommandOutput) => void - ): Promise | void { - const command = new UpdateUserSecurityProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Connect is a cloud-based contact center solution that you use to set up and + * manage a customer contact center and provide reliable customer engagement at any scale.

+ *

Amazon Connect provides metrics and real-time reporting that enable you to optimize + * contact routing. You can also resolve customer issues more efficiently by getting customers in + * touch with the appropriate agents.

+ *

There are limits to the number of Amazon Connect resources that you can create. There + * are also limits to the number of requests that you can make per second. For more information, see + * Amazon Connect Service Quotas in the Amazon Connect Administrator + * Guide.

+ *

You can connect programmatically to an Amazon Web Services service by using an endpoint. For + * a list of Amazon Connect endpoints, see Amazon Connect Endpoints.

+ */ +export class Connect extends ConnectClient implements Connect {} +createAggregatedClient(commands, Connect); diff --git a/clients/client-connectcampaigns/src/ConnectCampaigns.ts b/clients/client-connectcampaigns/src/ConnectCampaigns.ts index 0287480a8598..3e7e2eda5e26 100644 --- a/clients/client-connectcampaigns/src/ConnectCampaigns.ts +++ b/clients/client-connectcampaigns/src/ConnectCampaigns.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -107,727 +108,367 @@ import { UpdateCampaignOutboundCallConfigCommandInput, UpdateCampaignOutboundCallConfigCommandOutput, } from "./commands/UpdateCampaignOutboundCallConfigCommand"; -import { ConnectCampaignsClient } from "./ConnectCampaignsClient"; +import { ConnectCampaignsClient, ConnectCampaignsClientConfig } from "./ConnectCampaignsClient"; -/** - * @public - * Provide APIs to create and manage Amazon Connect Campaigns. - */ -export class ConnectCampaigns extends ConnectCampaignsClient { +const commands = { + CreateCampaignCommand, + DeleteCampaignCommand, + DeleteConnectInstanceConfigCommand, + DeleteInstanceOnboardingJobCommand, + DescribeCampaignCommand, + GetCampaignStateCommand, + GetCampaignStateBatchCommand, + GetConnectInstanceConfigCommand, + GetInstanceOnboardingJobStatusCommand, + ListCampaignsCommand, + ListTagsForResourceCommand, + PauseCampaignCommand, + PutDialRequestBatchCommand, + ResumeCampaignCommand, + StartCampaignCommand, + StartInstanceOnboardingJobCommand, + StopCampaignCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateCampaignDialerConfigCommand, + UpdateCampaignNameCommand, + UpdateCampaignOutboundCallConfigCommand, +}; + +export interface ConnectCampaigns { /** - * @public - * Creates a campaign for the specified Amazon Connect account. This API is idempotent. + * @see {@link CreateCampaignCommand} */ - public createCampaign( + createCampaign( args: CreateCampaignCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCampaign( - args: CreateCampaignCommandInput, - cb: (err: any, data?: CreateCampaignCommandOutput) => void - ): void; - public createCampaign( + createCampaign(args: CreateCampaignCommandInput, cb: (err: any, data?: CreateCampaignCommandOutput) => void): void; + createCampaign( args: CreateCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCampaignCommandOutput) => void ): void; - public createCampaign( - args: CreateCampaignCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCampaignCommandOutput) => void), - cb?: (err: any, data?: CreateCampaignCommandOutput) => void - ): Promise | void { - const command = new CreateCampaignCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Deletes a campaign from the specified Amazon Connect account. + * @see {@link DeleteCampaignCommand} */ - public deleteCampaign( + deleteCampaign( args: DeleteCampaignCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCampaign( - args: DeleteCampaignCommandInput, - cb: (err: any, data?: DeleteCampaignCommandOutput) => void - ): void; - public deleteCampaign( + deleteCampaign(args: DeleteCampaignCommandInput, cb: (err: any, data?: DeleteCampaignCommandOutput) => void): void; + deleteCampaign( args: DeleteCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCampaignCommandOutput) => void ): void; - public deleteCampaign( - args: DeleteCampaignCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCampaignCommandOutput) => void), - cb?: (err: any, data?: DeleteCampaignCommandOutput) => void - ): Promise | void { - const command = new DeleteCampaignCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Deletes a connect instance config from the specified AWS account. + * @see {@link DeleteConnectInstanceConfigCommand} */ - public deleteConnectInstanceConfig( + deleteConnectInstanceConfig( args: DeleteConnectInstanceConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConnectInstanceConfig( + deleteConnectInstanceConfig( args: DeleteConnectInstanceConfigCommandInput, cb: (err: any, data?: DeleteConnectInstanceConfigCommandOutput) => void ): void; - public deleteConnectInstanceConfig( + deleteConnectInstanceConfig( args: DeleteConnectInstanceConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectInstanceConfigCommandOutput) => void ): void; - public deleteConnectInstanceConfig( - args: DeleteConnectInstanceConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConnectInstanceConfigCommandOutput) => void), - cb?: (err: any, data?: DeleteConnectInstanceConfigCommandOutput) => void - ): Promise | void { - const command = new DeleteConnectInstanceConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance. + * @see {@link DeleteInstanceOnboardingJobCommand} */ - public deleteInstanceOnboardingJob( + deleteInstanceOnboardingJob( args: DeleteInstanceOnboardingJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInstanceOnboardingJob( + deleteInstanceOnboardingJob( args: DeleteInstanceOnboardingJobCommandInput, cb: (err: any, data?: DeleteInstanceOnboardingJobCommandOutput) => void ): void; - public deleteInstanceOnboardingJob( + deleteInstanceOnboardingJob( args: DeleteInstanceOnboardingJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInstanceOnboardingJobCommandOutput) => void ): void; - public deleteInstanceOnboardingJob( - args: DeleteInstanceOnboardingJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInstanceOnboardingJobCommandOutput) => void), - cb?: (err: any, data?: DeleteInstanceOnboardingJobCommandOutput) => void - ): Promise | void { - const command = new DeleteInstanceOnboardingJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Describes the specific campaign. + * @see {@link DescribeCampaignCommand} */ - public describeCampaign( + describeCampaign( args: DescribeCampaignCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCampaign( + describeCampaign( args: DescribeCampaignCommandInput, cb: (err: any, data?: DescribeCampaignCommandOutput) => void ): void; - public describeCampaign( + describeCampaign( args: DescribeCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCampaignCommandOutput) => void ): void; - public describeCampaign( - args: DescribeCampaignCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCampaignCommandOutput) => void), - cb?: (err: any, data?: DescribeCampaignCommandOutput) => void - ): Promise | void { - const command = new DescribeCampaignCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Get state of a campaign for the specified Amazon Connect account. + * @see {@link GetCampaignStateCommand} */ - public getCampaignState( + getCampaignState( args: GetCampaignStateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCampaignState( + getCampaignState( args: GetCampaignStateCommandInput, cb: (err: any, data?: GetCampaignStateCommandOutput) => void ): void; - public getCampaignState( + getCampaignState( args: GetCampaignStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCampaignStateCommandOutput) => void ): void; - public getCampaignState( - args: GetCampaignStateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCampaignStateCommandOutput) => void), - cb?: (err: any, data?: GetCampaignStateCommandOutput) => void - ): Promise | void { - const command = new GetCampaignStateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Get state of campaigns for the specified Amazon Connect account. + * @see {@link GetCampaignStateBatchCommand} */ - public getCampaignStateBatch( + getCampaignStateBatch( args: GetCampaignStateBatchCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCampaignStateBatch( + getCampaignStateBatch( args: GetCampaignStateBatchCommandInput, cb: (err: any, data?: GetCampaignStateBatchCommandOutput) => void ): void; - public getCampaignStateBatch( + getCampaignStateBatch( args: GetCampaignStateBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCampaignStateBatchCommandOutput) => void ): void; - public getCampaignStateBatch( - args: GetCampaignStateBatchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCampaignStateBatchCommandOutput) => void), - cb?: (err: any, data?: GetCampaignStateBatchCommandOutput) => void - ): Promise | void { - const command = new GetCampaignStateBatchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Get the specific Connect instance config. + * @see {@link GetConnectInstanceConfigCommand} */ - public getConnectInstanceConfig( + getConnectInstanceConfig( args: GetConnectInstanceConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConnectInstanceConfig( + getConnectInstanceConfig( args: GetConnectInstanceConfigCommandInput, cb: (err: any, data?: GetConnectInstanceConfigCommandOutput) => void ): void; - public getConnectInstanceConfig( + getConnectInstanceConfig( args: GetConnectInstanceConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConnectInstanceConfigCommandOutput) => void ): void; - public getConnectInstanceConfig( - args: GetConnectInstanceConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConnectInstanceConfigCommandOutput) => void), - cb?: (err: any, data?: GetConnectInstanceConfigCommandOutput) => void - ): Promise | void { - const command = new GetConnectInstanceConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Get the specific instance onboarding job status. + * @see {@link GetInstanceOnboardingJobStatusCommand} */ - public getInstanceOnboardingJobStatus( + getInstanceOnboardingJobStatus( args: GetInstanceOnboardingJobStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInstanceOnboardingJobStatus( + getInstanceOnboardingJobStatus( args: GetInstanceOnboardingJobStatusCommandInput, cb: (err: any, data?: GetInstanceOnboardingJobStatusCommandOutput) => void ): void; - public getInstanceOnboardingJobStatus( + getInstanceOnboardingJobStatus( args: GetInstanceOnboardingJobStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInstanceOnboardingJobStatusCommandOutput) => void ): void; - public getInstanceOnboardingJobStatus( - args: GetInstanceOnboardingJobStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInstanceOnboardingJobStatusCommandOutput) => void), - cb?: (err: any, data?: GetInstanceOnboardingJobStatusCommandOutput) => void - ): Promise | void { - const command = new GetInstanceOnboardingJobStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Provides summary information about the campaigns under the specified Amazon Connect account. + * @see {@link ListCampaignsCommand} */ - public listCampaigns( - args: ListCampaignsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listCampaigns( - args: ListCampaignsCommandInput, - cb: (err: any, data?: ListCampaignsCommandOutput) => void - ): void; - public listCampaigns( + listCampaigns(args: ListCampaignsCommandInput, options?: __HttpHandlerOptions): Promise; + listCampaigns(args: ListCampaignsCommandInput, cb: (err: any, data?: ListCampaignsCommandOutput) => void): void; + listCampaigns( args: ListCampaignsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCampaignsCommandOutput) => void ): void; - public listCampaigns( - args: ListCampaignsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCampaignsCommandOutput) => void), - cb?: (err: any, data?: ListCampaignsCommandOutput) => void - ): Promise | void { - const command = new ListCampaignsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * List tags for a resource. + * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Pauses a campaign for the specified Amazon Connect account. + * @see {@link PauseCampaignCommand} */ - public pauseCampaign( - args: PauseCampaignCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public pauseCampaign( - args: PauseCampaignCommandInput, - cb: (err: any, data?: PauseCampaignCommandOutput) => void - ): void; - public pauseCampaign( + pauseCampaign(args: PauseCampaignCommandInput, options?: __HttpHandlerOptions): Promise; + pauseCampaign(args: PauseCampaignCommandInput, cb: (err: any, data?: PauseCampaignCommandOutput) => void): void; + pauseCampaign( args: PauseCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PauseCampaignCommandOutput) => void ): void; - public pauseCampaign( - args: PauseCampaignCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PauseCampaignCommandOutput) => void), - cb?: (err: any, data?: PauseCampaignCommandOutput) => void - ): Promise | void { - const command = new PauseCampaignCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent. + * @see {@link PutDialRequestBatchCommand} */ - public putDialRequestBatch( + putDialRequestBatch( args: PutDialRequestBatchCommandInput, options?: __HttpHandlerOptions ): Promise; - public putDialRequestBatch( + putDialRequestBatch( args: PutDialRequestBatchCommandInput, cb: (err: any, data?: PutDialRequestBatchCommandOutput) => void ): void; - public putDialRequestBatch( + putDialRequestBatch( args: PutDialRequestBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDialRequestBatchCommandOutput) => void ): void; - public putDialRequestBatch( - args: PutDialRequestBatchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutDialRequestBatchCommandOutput) => void), - cb?: (err: any, data?: PutDialRequestBatchCommandOutput) => void - ): Promise | void { - const command = new PutDialRequestBatchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Stops a campaign for the specified Amazon Connect account. + * @see {@link ResumeCampaignCommand} */ - public resumeCampaign( + resumeCampaign( args: ResumeCampaignCommandInput, options?: __HttpHandlerOptions ): Promise; - public resumeCampaign( - args: ResumeCampaignCommandInput, - cb: (err: any, data?: ResumeCampaignCommandOutput) => void - ): void; - public resumeCampaign( + resumeCampaign(args: ResumeCampaignCommandInput, cb: (err: any, data?: ResumeCampaignCommandOutput) => void): void; + resumeCampaign( args: ResumeCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResumeCampaignCommandOutput) => void ): void; - public resumeCampaign( - args: ResumeCampaignCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResumeCampaignCommandOutput) => void), - cb?: (err: any, data?: ResumeCampaignCommandOutput) => void - ): Promise | void { - const command = new ResumeCampaignCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Starts a campaign for the specified Amazon Connect account. + * @see {@link StartCampaignCommand} */ - public startCampaign( - args: StartCampaignCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public startCampaign( - args: StartCampaignCommandInput, - cb: (err: any, data?: StartCampaignCommandOutput) => void - ): void; - public startCampaign( + startCampaign(args: StartCampaignCommandInput, options?: __HttpHandlerOptions): Promise; + startCampaign(args: StartCampaignCommandInput, cb: (err: any, data?: StartCampaignCommandOutput) => void): void; + startCampaign( args: StartCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCampaignCommandOutput) => void ): void; - public startCampaign( - args: StartCampaignCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartCampaignCommandOutput) => void), - cb?: (err: any, data?: StartCampaignCommandOutput) => void - ): Promise | void { - const command = new StartCampaignCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Onboard the specific Amazon Connect instance to Connect Campaigns. + * @see {@link StartInstanceOnboardingJobCommand} */ - public startInstanceOnboardingJob( + startInstanceOnboardingJob( args: StartInstanceOnboardingJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startInstanceOnboardingJob( + startInstanceOnboardingJob( args: StartInstanceOnboardingJobCommandInput, cb: (err: any, data?: StartInstanceOnboardingJobCommandOutput) => void ): void; - public startInstanceOnboardingJob( + startInstanceOnboardingJob( args: StartInstanceOnboardingJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartInstanceOnboardingJobCommandOutput) => void ): void; - public startInstanceOnboardingJob( - args: StartInstanceOnboardingJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartInstanceOnboardingJobCommandOutput) => void), - cb?: (err: any, data?: StartInstanceOnboardingJobCommandOutput) => void - ): Promise | void { - const command = new StartInstanceOnboardingJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Stops a campaign for the specified Amazon Connect account. + * @see {@link StopCampaignCommand} */ - public stopCampaign( - args: StopCampaignCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public stopCampaign(args: StopCampaignCommandInput, cb: (err: any, data?: StopCampaignCommandOutput) => void): void; - public stopCampaign( + stopCampaign(args: StopCampaignCommandInput, options?: __HttpHandlerOptions): Promise; + stopCampaign(args: StopCampaignCommandInput, cb: (err: any, data?: StopCampaignCommandOutput) => void): void; + stopCampaign( args: StopCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopCampaignCommandOutput) => void ): void; - public stopCampaign( - args: StopCampaignCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopCampaignCommandOutput) => void), - cb?: (err: any, data?: StopCampaignCommandOutput) => void - ): Promise | void { - const command = new StopCampaignCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Tag a resource. + * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Untag a resource. + * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Updates the dialer config of a campaign. This API is idempotent. + * @see {@link UpdateCampaignDialerConfigCommand} */ - public updateCampaignDialerConfig( + updateCampaignDialerConfig( args: UpdateCampaignDialerConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCampaignDialerConfig( + updateCampaignDialerConfig( args: UpdateCampaignDialerConfigCommandInput, cb: (err: any, data?: UpdateCampaignDialerConfigCommandOutput) => void ): void; - public updateCampaignDialerConfig( + updateCampaignDialerConfig( args: UpdateCampaignDialerConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCampaignDialerConfigCommandOutput) => void ): void; - public updateCampaignDialerConfig( - args: UpdateCampaignDialerConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCampaignDialerConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateCampaignDialerConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateCampaignDialerConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Updates the name of a campaign. This API is idempotent. + * @see {@link UpdateCampaignNameCommand} */ - public updateCampaignName( + updateCampaignName( args: UpdateCampaignNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCampaignName( + updateCampaignName( args: UpdateCampaignNameCommandInput, cb: (err: any, data?: UpdateCampaignNameCommandOutput) => void ): void; - public updateCampaignName( + updateCampaignName( args: UpdateCampaignNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCampaignNameCommandOutput) => void ): void; - public updateCampaignName( - args: UpdateCampaignNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCampaignNameCommandOutput) => void), - cb?: (err: any, data?: UpdateCampaignNameCommandOutput) => void - ): Promise | void { - const command = new UpdateCampaignNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Updates the outbound call config of a campaign. This API is idempotent. + * @see {@link UpdateCampaignOutboundCallConfigCommand} */ - public updateCampaignOutboundCallConfig( + updateCampaignOutboundCallConfig( args: UpdateCampaignOutboundCallConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCampaignOutboundCallConfig( + updateCampaignOutboundCallConfig( args: UpdateCampaignOutboundCallConfigCommandInput, cb: (err: any, data?: UpdateCampaignOutboundCallConfigCommandOutput) => void ): void; - public updateCampaignOutboundCallConfig( + updateCampaignOutboundCallConfig( args: UpdateCampaignOutboundCallConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCampaignOutboundCallConfigCommandOutput) => void ): void; - public updateCampaignOutboundCallConfig( - args: UpdateCampaignOutboundCallConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCampaignOutboundCallConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateCampaignOutboundCallConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateCampaignOutboundCallConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Provide APIs to create and manage Amazon Connect Campaigns. + */ +export class ConnectCampaigns extends ConnectCampaignsClient implements ConnectCampaigns {} +createAggregatedClient(commands, ConnectCampaigns); diff --git a/clients/client-connectcases/src/ConnectCases.ts b/clients/client-connectcases/src/ConnectCases.ts index 7d529cc1b639..97bccbaa5012 100644 --- a/clients/client-connectcases/src/ConnectCases.ts +++ b/clients/client-connectcases/src/ConnectCases.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -99,999 +100,434 @@ import { UpdateTemplateCommandInput, UpdateTemplateCommandOutput, } from "./commands/UpdateTemplateCommand"; -import { ConnectCasesClient } from "./ConnectCasesClient"; +import { ConnectCasesClient, ConnectCasesClientConfig } from "./ConnectCasesClient"; -/** - * @public - *

With Amazon Connect Cases, your agents can track and manage customer issues that require - * multiple interactions, follow-up tasks, and teams in your contact center. A case represents a - * customer issue. It records the issue, the steps and interactions taken to resolve the issue, - * and the outcome. For more information, see Amazon Connect Cases in the - * Amazon Connect Administrator Guide.

- */ -export class ConnectCases extends ConnectCasesClient { +const commands = { + BatchGetFieldCommand, + BatchPutFieldOptionsCommand, + CreateCaseCommand, + CreateDomainCommand, + CreateFieldCommand, + CreateLayoutCommand, + CreateRelatedItemCommand, + CreateTemplateCommand, + DeleteDomainCommand, + GetCaseCommand, + GetCaseEventConfigurationCommand, + GetDomainCommand, + GetLayoutCommand, + GetTemplateCommand, + ListCasesForContactCommand, + ListDomainsCommand, + ListFieldOptionsCommand, + ListFieldsCommand, + ListLayoutsCommand, + ListTagsForResourceCommand, + ListTemplatesCommand, + PutCaseEventConfigurationCommand, + SearchCasesCommand, + SearchRelatedItemsCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateCaseCommand, + UpdateFieldCommand, + UpdateLayoutCommand, + UpdateTemplateCommand, +}; + +export interface ConnectCases { /** - * @public - *

Returns the description for the list of fields in the request parameters.

+ * @see {@link BatchGetFieldCommand} */ - public batchGetField( - args: BatchGetFieldCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public batchGetField( - args: BatchGetFieldCommandInput, - cb: (err: any, data?: BatchGetFieldCommandOutput) => void - ): void; - public batchGetField( + batchGetField(args: BatchGetFieldCommandInput, options?: __HttpHandlerOptions): Promise; + batchGetField(args: BatchGetFieldCommandInput, cb: (err: any, data?: BatchGetFieldCommandOutput) => void): void; + batchGetField( args: BatchGetFieldCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetFieldCommandOutput) => void ): void; - public batchGetField( - args: BatchGetFieldCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetFieldCommandOutput) => void), - cb?: (err: any, data?: BatchGetFieldCommandOutput) => void - ): Promise | void { - const command = new BatchGetFieldCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates and updates a set of field options for a single select field in a Cases - * domain.

+ * @see {@link BatchPutFieldOptionsCommand} */ - public batchPutFieldOptions( + batchPutFieldOptions( args: BatchPutFieldOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchPutFieldOptions( + batchPutFieldOptions( args: BatchPutFieldOptionsCommandInput, cb: (err: any, data?: BatchPutFieldOptionsCommandOutput) => void ): void; - public batchPutFieldOptions( + batchPutFieldOptions( args: BatchPutFieldOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchPutFieldOptionsCommandOutput) => void ): void; - public batchPutFieldOptions( - args: BatchPutFieldOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchPutFieldOptionsCommandOutput) => void), - cb?: (err: any, data?: BatchPutFieldOptionsCommandOutput) => void - ): Promise | void { - const command = new BatchPutFieldOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a case in the specified Cases domain. Case system and custom fields are taken - * as an array id/value pairs with a declared data types.

- * - *

The following fields are required when creating a case:

- * - *
    - *
  • - *

    - * customer_id - You must provide the full customer profile ARN in this - * format: arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles - * domain name/profiles/profile ID - *

    - *
  • - *
  • - *

    - * title - *

    - *
  • - *
- * - *
+ * @see {@link CreateCaseCommand} */ - public createCase(args: CreateCaseCommandInput, options?: __HttpHandlerOptions): Promise; - public createCase(args: CreateCaseCommandInput, cb: (err: any, data?: CreateCaseCommandOutput) => void): void; - public createCase( + createCase(args: CreateCaseCommandInput, options?: __HttpHandlerOptions): Promise; + createCase(args: CreateCaseCommandInput, cb: (err: any, data?: CreateCaseCommandOutput) => void): void; + createCase( args: CreateCaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCaseCommandOutput) => void ): void; - public createCase( - args: CreateCaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCaseCommandOutput) => void), - cb?: (err: any, data?: CreateCaseCommandOutput) => void - ): Promise | void { - const command = new CreateCaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a domain, which is a container for all case data, such as cases, fields, templates - * and layouts. Each Amazon Connect instance can be associated with only one Cases - * domain.

- * - *

This will not associate your connect instance to Cases domain. Instead, use the - * Amazon Connect - * CreateIntegrationAssociation API. You need specific IAM - * permissions to successfully associate the Cases domain. For more information, see - * Onboard to Cases.

- *
+ * @see {@link CreateDomainCommand} */ - public createDomain( - args: CreateDomainCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createDomain(args: CreateDomainCommandInput, cb: (err: any, data?: CreateDomainCommandOutput) => void): void; - public createDomain( + createDomain(args: CreateDomainCommandInput, options?: __HttpHandlerOptions): Promise; + createDomain(args: CreateDomainCommandInput, cb: (err: any, data?: CreateDomainCommandOutput) => void): void; + createDomain( args: CreateDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDomainCommandOutput) => void ): void; - public createDomain( - args: CreateDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDomainCommandOutput) => void), - cb?: (err: any, data?: CreateDomainCommandOutput) => void - ): Promise | void { - const command = new CreateDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a field in the Cases domain. This field is used to define the case object - * model (that is, defines what data can be captured on cases) in a Cases domain.

+ * @see {@link CreateFieldCommand} */ - public createField(args: CreateFieldCommandInput, options?: __HttpHandlerOptions): Promise; - public createField(args: CreateFieldCommandInput, cb: (err: any, data?: CreateFieldCommandOutput) => void): void; - public createField( + createField(args: CreateFieldCommandInput, options?: __HttpHandlerOptions): Promise; + createField(args: CreateFieldCommandInput, cb: (err: any, data?: CreateFieldCommandOutput) => void): void; + createField( args: CreateFieldCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFieldCommandOutput) => void ): void; - public createField( - args: CreateFieldCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFieldCommandOutput) => void), - cb?: (err: any, data?: CreateFieldCommandOutput) => void - ): Promise | void { - const command = new CreateFieldCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a layout in the Cases domain. Layouts define the following configuration in - * the top section and More Info tab of the Cases user interface:

- *
    - *
  • - *

    Fields to display to the users

    - *
  • - *
  • - *

    Field ordering

    - *
  • - *
- * - *

Title and Status fields cannot be part of layouts since they are not - * configurable.

- *
+ * @see {@link CreateLayoutCommand} */ - public createLayout( - args: CreateLayoutCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createLayout(args: CreateLayoutCommandInput, cb: (err: any, data?: CreateLayoutCommandOutput) => void): void; - public createLayout( + createLayout(args: CreateLayoutCommandInput, options?: __HttpHandlerOptions): Promise; + createLayout(args: CreateLayoutCommandInput, cb: (err: any, data?: CreateLayoutCommandOutput) => void): void; + createLayout( args: CreateLayoutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLayoutCommandOutput) => void ): void; - public createLayout( - args: CreateLayoutCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLayoutCommandOutput) => void), - cb?: (err: any, data?: CreateLayoutCommandOutput) => void - ): Promise | void { - const command = new CreateLayoutCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a related item (comments, tasks, and contacts) and associates it with a - * case.

- * - *

A Related Item is a resource that is associated with a case. It may or may not have an - * external identifier linking it to an external resource (for example, a - * contactArn). All Related Items have their own internal identifier, the - * relatedItemArn. Examples of related items include comments and - * contacts.

- *
+ * @see {@link CreateRelatedItemCommand} */ - public createRelatedItem( + createRelatedItem( args: CreateRelatedItemCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRelatedItem( + createRelatedItem( args: CreateRelatedItemCommandInput, cb: (err: any, data?: CreateRelatedItemCommandOutput) => void ): void; - public createRelatedItem( + createRelatedItem( args: CreateRelatedItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRelatedItemCommandOutput) => void ): void; - public createRelatedItem( - args: CreateRelatedItemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRelatedItemCommandOutput) => void), - cb?: (err: any, data?: CreateRelatedItemCommandOutput) => void - ): Promise | void { - const command = new CreateRelatedItemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a template in the Cases domain. This template is used to define the case object - * model (that is, to define what data can be captured on cases) in a Cases domain. A template - * must have a unique name within a domain, and it must reference existing field IDs and layout - * IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A - * template can be either Active or Inactive, as indicated by its status. Inactive templates - * cannot be used to create cases.

+ * @see {@link CreateTemplateCommand} */ - public createTemplate( + createTemplate( args: CreateTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTemplate( - args: CreateTemplateCommandInput, - cb: (err: any, data?: CreateTemplateCommandOutput) => void - ): void; - public createTemplate( + createTemplate(args: CreateTemplateCommandInput, cb: (err: any, data?: CreateTemplateCommandOutput) => void): void; + createTemplate( args: CreateTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTemplateCommandOutput) => void ): void; - public createTemplate( - args: CreateTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a domain.

+ * @see {@link DeleteDomainCommand} */ - public deleteDomain( - args: DeleteDomainCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDomain(args: DeleteDomainCommandInput, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void; - public deleteDomain( + deleteDomain(args: DeleteDomainCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDomain(args: DeleteDomainCommandInput, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void; + deleteDomain( args: DeleteDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDomainCommandOutput) => void ): void; - public deleteDomain( - args: DeleteDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDomainCommandOutput) => void), - cb?: (err: any, data?: DeleteDomainCommandOutput) => void - ): Promise | void { - const command = new DeleteDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a specific case if it exists.

+ * @see {@link GetCaseCommand} */ - public getCase(args: GetCaseCommandInput, options?: __HttpHandlerOptions): Promise; - public getCase(args: GetCaseCommandInput, cb: (err: any, data?: GetCaseCommandOutput) => void): void; - public getCase( + getCase(args: GetCaseCommandInput, options?: __HttpHandlerOptions): Promise; + getCase(args: GetCaseCommandInput, cb: (err: any, data?: GetCaseCommandOutput) => void): void; + getCase( args: GetCaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCaseCommandOutput) => void ): void; - public getCase( - args: GetCaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCaseCommandOutput) => void), - cb?: (err: any, data?: GetCaseCommandOutput) => void - ): Promise | void { - const command = new GetCaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the case event publishing configuration.

+ * @see {@link GetCaseEventConfigurationCommand} */ - public getCaseEventConfiguration( + getCaseEventConfiguration( args: GetCaseEventConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCaseEventConfiguration( + getCaseEventConfiguration( args: GetCaseEventConfigurationCommandInput, cb: (err: any, data?: GetCaseEventConfigurationCommandOutput) => void ): void; - public getCaseEventConfiguration( + getCaseEventConfiguration( args: GetCaseEventConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCaseEventConfigurationCommandOutput) => void ): void; - public getCaseEventConfiguration( - args: GetCaseEventConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCaseEventConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetCaseEventConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetCaseEventConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a specific domain if it exists.

+ * @see {@link GetDomainCommand} */ - public getDomain(args: GetDomainCommandInput, options?: __HttpHandlerOptions): Promise; - public getDomain(args: GetDomainCommandInput, cb: (err: any, data?: GetDomainCommandOutput) => void): void; - public getDomain( + getDomain(args: GetDomainCommandInput, options?: __HttpHandlerOptions): Promise; + getDomain(args: GetDomainCommandInput, cb: (err: any, data?: GetDomainCommandOutput) => void): void; + getDomain( args: GetDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDomainCommandOutput) => void ): void; - public getDomain( - args: GetDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDomainCommandOutput) => void), - cb?: (err: any, data?: GetDomainCommandOutput) => void - ): Promise | void { - const command = new GetDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the details for the requested layout.

+ * @see {@link GetLayoutCommand} */ - public getLayout(args: GetLayoutCommandInput, options?: __HttpHandlerOptions): Promise; - public getLayout(args: GetLayoutCommandInput, cb: (err: any, data?: GetLayoutCommandOutput) => void): void; - public getLayout( + getLayout(args: GetLayoutCommandInput, options?: __HttpHandlerOptions): Promise; + getLayout(args: GetLayoutCommandInput, cb: (err: any, data?: GetLayoutCommandOutput) => void): void; + getLayout( args: GetLayoutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLayoutCommandOutput) => void ): void; - public getLayout( - args: GetLayoutCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLayoutCommandOutput) => void), - cb?: (err: any, data?: GetLayoutCommandOutput) => void - ): Promise | void { - const command = new GetLayoutCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the details for the requested template.

+ * @see {@link GetTemplateCommand} */ - public getTemplate(args: GetTemplateCommandInput, options?: __HttpHandlerOptions): Promise; - public getTemplate(args: GetTemplateCommandInput, cb: (err: any, data?: GetTemplateCommandOutput) => void): void; - public getTemplate( + getTemplate(args: GetTemplateCommandInput, options?: __HttpHandlerOptions): Promise; + getTemplate(args: GetTemplateCommandInput, cb: (err: any, data?: GetTemplateCommandOutput) => void): void; + getTemplate( args: GetTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTemplateCommandOutput) => void ): void; - public getTemplate( - args: GetTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTemplateCommandOutput) => void), - cb?: (err: any, data?: GetTemplateCommandOutput) => void - ): Promise | void { - const command = new GetTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists cases for a given contact.

+ * @see {@link ListCasesForContactCommand} */ - public listCasesForContact( + listCasesForContact( args: ListCasesForContactCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCasesForContact( + listCasesForContact( args: ListCasesForContactCommandInput, cb: (err: any, data?: ListCasesForContactCommandOutput) => void ): void; - public listCasesForContact( + listCasesForContact( args: ListCasesForContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCasesForContactCommandOutput) => void ): void; - public listCasesForContact( - args: ListCasesForContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCasesForContactCommandOutput) => void), - cb?: (err: any, data?: ListCasesForContactCommandOutput) => void - ): Promise | void { - const command = new ListCasesForContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all cases domains in the Amazon Web Services account. Each list item is a condensed - * summary object of the domain.

+ * @see {@link ListDomainsCommand} */ - public listDomains(args: ListDomainsCommandInput, options?: __HttpHandlerOptions): Promise; - public listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void; - public listDomains( + listDomains(args: ListDomainsCommandInput, options?: __HttpHandlerOptions): Promise; + listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void; + listDomains( args: ListDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainsCommandOutput) => void ): void; - public listDomains( - args: ListDomainsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDomainsCommandOutput) => void), - cb?: (err: any, data?: ListDomainsCommandOutput) => void - ): Promise | void { - const command = new ListDomainsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all of the field options for a field identifier in the domain.

+ * @see {@link ListFieldOptionsCommand} */ - public listFieldOptions( + listFieldOptions( args: ListFieldOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFieldOptions( + listFieldOptions( args: ListFieldOptionsCommandInput, cb: (err: any, data?: ListFieldOptionsCommandOutput) => void ): void; - public listFieldOptions( + listFieldOptions( args: ListFieldOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFieldOptionsCommandOutput) => void ): void; - public listFieldOptions( - args: ListFieldOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFieldOptionsCommandOutput) => void), - cb?: (err: any, data?: ListFieldOptionsCommandOutput) => void - ): Promise | void { - const command = new ListFieldOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all fields in a Cases domain.

+ * @see {@link ListFieldsCommand} */ - public listFields(args: ListFieldsCommandInput, options?: __HttpHandlerOptions): Promise; - public listFields(args: ListFieldsCommandInput, cb: (err: any, data?: ListFieldsCommandOutput) => void): void; - public listFields( + listFields(args: ListFieldsCommandInput, options?: __HttpHandlerOptions): Promise; + listFields(args: ListFieldsCommandInput, cb: (err: any, data?: ListFieldsCommandOutput) => void): void; + listFields( args: ListFieldsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFieldsCommandOutput) => void ): void; - public listFields( - args: ListFieldsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFieldsCommandOutput) => void), - cb?: (err: any, data?: ListFieldsCommandOutput) => void - ): Promise | void { - const command = new ListFieldsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all layouts in the given cases domain. Each list item is a condensed summary object - * of the layout.

+ * @see {@link ListLayoutsCommand} */ - public listLayouts(args: ListLayoutsCommandInput, options?: __HttpHandlerOptions): Promise; - public listLayouts(args: ListLayoutsCommandInput, cb: (err: any, data?: ListLayoutsCommandOutput) => void): void; - public listLayouts( + listLayouts(args: ListLayoutsCommandInput, options?: __HttpHandlerOptions): Promise; + listLayouts(args: ListLayoutsCommandInput, cb: (err: any, data?: ListLayoutsCommandOutput) => void): void; + listLayouts( args: ListLayoutsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLayoutsCommandOutput) => void ): void; - public listLayouts( - args: ListLayoutsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLayoutsCommandOutput) => void), - cb?: (err: any, data?: ListLayoutsCommandOutput) => void - ): Promise | void { - const command = new ListLayoutsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists tags for a resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all of the templates in a Cases domain. Each list item is a condensed summary - * object of the template.

+ * @see {@link ListTemplatesCommand} */ - public listTemplates( - args: ListTemplatesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listTemplates( - args: ListTemplatesCommandInput, - cb: (err: any, data?: ListTemplatesCommandOutput) => void - ): void; - public listTemplates( + listTemplates(args: ListTemplatesCommandInput, options?: __HttpHandlerOptions): Promise; + listTemplates(args: ListTemplatesCommandInput, cb: (err: any, data?: ListTemplatesCommandOutput) => void): void; + listTemplates( args: ListTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTemplatesCommandOutput) => void ): void; - public listTemplates( - args: ListTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

API for adding case event publishing configuration

+ * @see {@link PutCaseEventConfigurationCommand} */ - public putCaseEventConfiguration( + putCaseEventConfiguration( args: PutCaseEventConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putCaseEventConfiguration( + putCaseEventConfiguration( args: PutCaseEventConfigurationCommandInput, cb: (err: any, data?: PutCaseEventConfigurationCommandOutput) => void ): void; - public putCaseEventConfiguration( + putCaseEventConfiguration( args: PutCaseEventConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutCaseEventConfigurationCommandOutput) => void ): void; - public putCaseEventConfiguration( - args: PutCaseEventConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutCaseEventConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutCaseEventConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutCaseEventConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Searches for cases within their associated Cases domain. Search results are returned - * as a paginated list of abridged case documents.

- * - *

For customer_id you must provide the full customer profile ARN in this - * format: arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain - * name/profiles/profile ID.

- *
+ * @see {@link SearchCasesCommand} */ - public searchCases(args: SearchCasesCommandInput, options?: __HttpHandlerOptions): Promise; - public searchCases(args: SearchCasesCommandInput, cb: (err: any, data?: SearchCasesCommandOutput) => void): void; - public searchCases( + searchCases(args: SearchCasesCommandInput, options?: __HttpHandlerOptions): Promise; + searchCases(args: SearchCasesCommandInput, cb: (err: any, data?: SearchCasesCommandOutput) => void): void; + searchCases( args: SearchCasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchCasesCommandOutput) => void ): void; - public searchCases( - args: SearchCasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchCasesCommandOutput) => void), - cb?: (err: any, data?: SearchCasesCommandOutput) => void - ): Promise | void { - const command = new SearchCasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Searches for related items that are associated with a case.

- * - *

If no filters are provided, this returns all related items associated with a - * case.

- *
+ * @see {@link SearchRelatedItemsCommand} */ - public searchRelatedItems( + searchRelatedItems( args: SearchRelatedItemsCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchRelatedItems( + searchRelatedItems( args: SearchRelatedItemsCommandInput, cb: (err: any, data?: SearchRelatedItemsCommandOutput) => void ): void; - public searchRelatedItems( + searchRelatedItems( args: SearchRelatedItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchRelatedItemsCommandOutput) => void ): void; - public searchRelatedItems( - args: SearchRelatedItemsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchRelatedItemsCommandOutput) => void), - cb?: (err: any, data?: SearchRelatedItemsCommandOutput) => void - ): Promise | void { - const command = new SearchRelatedItemsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds tags to a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Untags a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the values of fields on a case. Fields to be updated are received as an array of - * id/value pairs identical to the CreateCase input .

- *

If the action is successful, the service sends back an HTTP 200 response with an empty - * HTTP body.

+ * @see {@link UpdateCaseCommand} */ - public updateCase(args: UpdateCaseCommandInput, options?: __HttpHandlerOptions): Promise; - public updateCase(args: UpdateCaseCommandInput, cb: (err: any, data?: UpdateCaseCommandOutput) => void): void; - public updateCase( + updateCase(args: UpdateCaseCommandInput, options?: __HttpHandlerOptions): Promise; + updateCase(args: UpdateCaseCommandInput, cb: (err: any, data?: UpdateCaseCommandOutput) => void): void; + updateCase( args: UpdateCaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCaseCommandOutput) => void ): void; - public updateCase( - args: UpdateCaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCaseCommandOutput) => void), - cb?: (err: any, data?: UpdateCaseCommandOutput) => void - ): Promise | void { - const command = new UpdateCaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the properties of an existing field.

+ * @see {@link UpdateFieldCommand} */ - public updateField(args: UpdateFieldCommandInput, options?: __HttpHandlerOptions): Promise; - public updateField(args: UpdateFieldCommandInput, cb: (err: any, data?: UpdateFieldCommandOutput) => void): void; - public updateField( + updateField(args: UpdateFieldCommandInput, options?: __HttpHandlerOptions): Promise; + updateField(args: UpdateFieldCommandInput, cb: (err: any, data?: UpdateFieldCommandOutput) => void): void; + updateField( args: UpdateFieldCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFieldCommandOutput) => void ): void; - public updateField( - args: UpdateFieldCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFieldCommandOutput) => void), - cb?: (err: any, data?: UpdateFieldCommandOutput) => void - ): Promise | void { - const command = new UpdateFieldCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the attributes of an existing layout.

- *

If the action is successful, the service sends back an HTTP 200 response with an empty - * HTTP body.

- *

A ValidationException is returned when you add non-existent - * fieldIds to a layout.

- * - *

Title and Status fields cannot be part of layouts because they are not - * configurable.

- *
+ * @see {@link UpdateLayoutCommand} */ - public updateLayout( - args: UpdateLayoutCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateLayout(args: UpdateLayoutCommandInput, cb: (err: any, data?: UpdateLayoutCommandOutput) => void): void; - public updateLayout( + updateLayout(args: UpdateLayoutCommandInput, options?: __HttpHandlerOptions): Promise; + updateLayout(args: UpdateLayoutCommandInput, cb: (err: any, data?: UpdateLayoutCommandOutput) => void): void; + updateLayout( args: UpdateLayoutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLayoutCommandOutput) => void ): void; - public updateLayout( - args: UpdateLayoutCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLayoutCommandOutput) => void), - cb?: (err: any, data?: UpdateLayoutCommandOutput) => void - ): Promise | void { - const command = new UpdateLayoutCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the attributes of an existing template. The template attributes that can be - * modified include name, description, - * layoutConfiguration, requiredFields, and status. At - * least one of these attributes must not be null. If a null value is provided for a given - * attribute, that attribute is ignored and its current value is preserved.

+ * @see {@link UpdateTemplateCommand} */ - public updateTemplate( + updateTemplate( args: UpdateTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTemplate( - args: UpdateTemplateCommandInput, - cb: (err: any, data?: UpdateTemplateCommandOutput) => void - ): void; - public updateTemplate( + updateTemplate(args: UpdateTemplateCommandInput, cb: (err: any, data?: UpdateTemplateCommandOutput) => void): void; + updateTemplate( args: UpdateTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTemplateCommandOutput) => void ): void; - public updateTemplate( - args: UpdateTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

With Amazon Connect Cases, your agents can track and manage customer issues that require + * multiple interactions, follow-up tasks, and teams in your contact center. A case represents a + * customer issue. It records the issue, the steps and interactions taken to resolve the issue, + * and the outcome. For more information, see Amazon Connect Cases in the + * Amazon Connect Administrator Guide.

+ */ +export class ConnectCases extends ConnectCasesClient implements ConnectCases {} +createAggregatedClient(commands, ConnectCases); diff --git a/clients/client-connectparticipant/src/ConnectParticipant.ts b/clients/client-connectparticipant/src/ConnectParticipant.ts index 63fe476a4df0..dd315402ed28 100644 --- a/clients/client-connectparticipant/src/ConnectParticipant.ts +++ b/clients/client-connectparticipant/src/ConnectParticipant.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -33,358 +34,144 @@ import { StartAttachmentUploadCommandInput, StartAttachmentUploadCommandOutput, } from "./commands/StartAttachmentUploadCommand"; -import { ConnectParticipantClient } from "./ConnectParticipantClient"; +import { ConnectParticipantClient, ConnectParticipantClientConfig } from "./ConnectParticipantClient"; -/** - * @public - *

Amazon Connect is an easy-to-use omnichannel cloud contact center service that - * enables companies of any size to deliver superior customer service at a lower cost. - * Amazon Connect communications capabilities make it easy for companies to deliver - * personalized interactions across communication channels, including chat.

- *

Use the Amazon Connect Participant Service to manage participants (for example, - * agents, customers, and managers listening in), and to send messages and events within a - * chat contact. The APIs in the service enable the following: sending chat messages, - * attachment sharing, managing a participant's connection state and message events, and - * retrieving chat transcripts.

- */ -export class ConnectParticipant extends ConnectParticipantClient { +const commands = { + CompleteAttachmentUploadCommand, + CreateParticipantConnectionCommand, + DisconnectParticipantCommand, + GetAttachmentCommand, + GetTranscriptCommand, + SendEventCommand, + SendMessageCommand, + StartAttachmentUploadCommand, +}; + +export interface ConnectParticipant { /** - * @public - *

Allows you to confirm that the attachment has been uploaded using the pre-signed URL - * provided in StartAttachmentUpload API.

- * - *

- * ConnectionToken is used for invoking this API instead of - * ParticipantToken.

- *
- *

The Amazon Connect Participant Service APIs do not use Signature Version 4 - * authentication.

+ * @see {@link CompleteAttachmentUploadCommand} */ - public completeAttachmentUpload( + completeAttachmentUpload( args: CompleteAttachmentUploadCommandInput, options?: __HttpHandlerOptions ): Promise; - public completeAttachmentUpload( + completeAttachmentUpload( args: CompleteAttachmentUploadCommandInput, cb: (err: any, data?: CompleteAttachmentUploadCommandOutput) => void ): void; - public completeAttachmentUpload( + completeAttachmentUpload( args: CompleteAttachmentUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteAttachmentUploadCommandOutput) => void ): void; - public completeAttachmentUpload( - args: CompleteAttachmentUploadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CompleteAttachmentUploadCommandOutput) => void), - cb?: (err: any, data?: CompleteAttachmentUploadCommandOutput) => void - ): Promise | void { - const command = new CompleteAttachmentUploadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates the participant's connection.

- * - *

- * ParticipantToken is used for invoking this API instead of - * ConnectionToken.

- *
- *

The participant token is valid for the lifetime of the participant – until they are - * part of a contact.

- *

The response URL for WEBSOCKET Type has a connect expiry timeout of 100s. - * Clients must manually connect to the returned websocket URL and subscribe to the desired - * topic.

- *

For chat, you need to publish the following on the established websocket - * connection:

- *

- * \{"topic":"aws/subscribe","content":\{"topics":["aws/chat"]\}\} - *

- *

Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, - * clients need to call this API again to obtain a new websocket URL and perform the same - * steps as before.

- *

- * Message streaming support: This API can also be used - * together with the StartContactStreaming API to create a participant connection for chat - * contacts that are not using a websocket. For more information about message streaming, - * Enable real-time chat - * message streaming in the Amazon Connect Administrator - * Guide.

- *

- * Feature specifications: For information about feature - * specifications, such as the allowed number of open websocket connections per - * participant, see Feature specifications in the Amazon Connect Administrator - * Guide.

- * - *

The Amazon Connect Participant Service APIs do not use Signature Version 4 - * authentication.

- *
+ * @see {@link CreateParticipantConnectionCommand} */ - public createParticipantConnection( + createParticipantConnection( args: CreateParticipantConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createParticipantConnection( + createParticipantConnection( args: CreateParticipantConnectionCommandInput, cb: (err: any, data?: CreateParticipantConnectionCommandOutput) => void ): void; - public createParticipantConnection( + createParticipantConnection( args: CreateParticipantConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateParticipantConnectionCommandOutput) => void ): void; - public createParticipantConnection( - args: CreateParticipantConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateParticipantConnectionCommandOutput) => void), - cb?: (err: any, data?: CreateParticipantConnectionCommandOutput) => void - ): Promise | void { - const command = new CreateParticipantConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disconnects a participant.

- * - *

- * ConnectionToken is used for invoking this API instead of - * ParticipantToken.

- *
- *

The Amazon Connect Participant Service APIs do not use Signature Version 4 - * authentication.

+ * @see {@link DisconnectParticipantCommand} */ - public disconnectParticipant( + disconnectParticipant( args: DisconnectParticipantCommandInput, options?: __HttpHandlerOptions ): Promise; - public disconnectParticipant( + disconnectParticipant( args: DisconnectParticipantCommandInput, cb: (err: any, data?: DisconnectParticipantCommandOutput) => void ): void; - public disconnectParticipant( + disconnectParticipant( args: DisconnectParticipantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisconnectParticipantCommandOutput) => void ): void; - public disconnectParticipant( - args: DisconnectParticipantCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisconnectParticipantCommandOutput) => void), - cb?: (err: any, data?: DisconnectParticipantCommandOutput) => void - ): Promise | void { - const command = new DisconnectParticipantCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a pre-signed URL for download of a completed attachment. This is an - * asynchronous API for use with active contacts.

- * - *

- * ConnectionToken is used for invoking this API instead of - * ParticipantToken.

- *
- *

The Amazon Connect Participant Service APIs do not use Signature Version 4 - * authentication.

+ * @see {@link GetAttachmentCommand} */ - public getAttachment( - args: GetAttachmentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getAttachment( - args: GetAttachmentCommandInput, - cb: (err: any, data?: GetAttachmentCommandOutput) => void - ): void; - public getAttachment( + getAttachment(args: GetAttachmentCommandInput, options?: __HttpHandlerOptions): Promise; + getAttachment(args: GetAttachmentCommandInput, cb: (err: any, data?: GetAttachmentCommandOutput) => void): void; + getAttachment( args: GetAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAttachmentCommandOutput) => void ): void; - public getAttachment( - args: GetAttachmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAttachmentCommandOutput) => void), - cb?: (err: any, data?: GetAttachmentCommandOutput) => void - ): Promise | void { - const command = new GetAttachmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a transcript of the session, including details about any attachments. For - * information about accessing past chat contact transcripts for a persistent chat, see - * Enable persistent chat.

- * - *

- * ConnectionToken is used for invoking this API instead of - * ParticipantToken.

- *
- *

The Amazon Connect Participant Service APIs do not use Signature Version 4 - * authentication.

+ * @see {@link GetTranscriptCommand} */ - public getTranscript( - args: GetTranscriptCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getTranscript( - args: GetTranscriptCommandInput, - cb: (err: any, data?: GetTranscriptCommandOutput) => void - ): void; - public getTranscript( + getTranscript(args: GetTranscriptCommandInput, options?: __HttpHandlerOptions): Promise; + getTranscript(args: GetTranscriptCommandInput, cb: (err: any, data?: GetTranscriptCommandOutput) => void): void; + getTranscript( args: GetTranscriptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTranscriptCommandOutput) => void ): void; - public getTranscript( - args: GetTranscriptCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTranscriptCommandOutput) => void), - cb?: (err: any, data?: GetTranscriptCommandOutput) => void - ): Promise | void { - const command = new GetTranscriptCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sends an event.

- * - *

- * ConnectionToken is used for invoking this API instead of - * ParticipantToken.

- *
- *

The Amazon Connect Participant Service APIs do not use Signature Version 4 - * authentication.

+ * @see {@link SendEventCommand} */ - public sendEvent(args: SendEventCommandInput, options?: __HttpHandlerOptions): Promise; - public sendEvent(args: SendEventCommandInput, cb: (err: any, data?: SendEventCommandOutput) => void): void; - public sendEvent( + sendEvent(args: SendEventCommandInput, options?: __HttpHandlerOptions): Promise; + sendEvent(args: SendEventCommandInput, cb: (err: any, data?: SendEventCommandOutput) => void): void; + sendEvent( args: SendEventCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendEventCommandOutput) => void ): void; - public sendEvent( - args: SendEventCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendEventCommandOutput) => void), - cb?: (err: any, data?: SendEventCommandOutput) => void - ): Promise | void { - const command = new SendEventCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sends a message.

- * - *

- * ConnectionToken is used for invoking this API instead of - * ParticipantToken.

- *
- *

The Amazon Connect Participant Service APIs do not use Signature Version 4 - * authentication.

+ * @see {@link SendMessageCommand} */ - public sendMessage(args: SendMessageCommandInput, options?: __HttpHandlerOptions): Promise; - public sendMessage(args: SendMessageCommandInput, cb: (err: any, data?: SendMessageCommandOutput) => void): void; - public sendMessage( + sendMessage(args: SendMessageCommandInput, options?: __HttpHandlerOptions): Promise; + sendMessage(args: SendMessageCommandInput, cb: (err: any, data?: SendMessageCommandOutput) => void): void; + sendMessage( args: SendMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendMessageCommandOutput) => void ): void; - public sendMessage( - args: SendMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendMessageCommandOutput) => void), - cb?: (err: any, data?: SendMessageCommandOutput) => void - ): Promise | void { - const command = new SendMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a pre-signed Amazon S3 URL in response for uploading the file directly to - * S3.

- * - *

- * ConnectionToken is used for invoking this API instead of - * ParticipantToken.

- *
- *

The Amazon Connect Participant Service APIs do not use Signature Version 4 - * authentication.

+ * @see {@link StartAttachmentUploadCommand} */ - public startAttachmentUpload( + startAttachmentUpload( args: StartAttachmentUploadCommandInput, options?: __HttpHandlerOptions ): Promise; - public startAttachmentUpload( + startAttachmentUpload( args: StartAttachmentUploadCommandInput, cb: (err: any, data?: StartAttachmentUploadCommandOutput) => void ): void; - public startAttachmentUpload( + startAttachmentUpload( args: StartAttachmentUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartAttachmentUploadCommandOutput) => void ): void; - public startAttachmentUpload( - args: StartAttachmentUploadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartAttachmentUploadCommandOutput) => void), - cb?: (err: any, data?: StartAttachmentUploadCommandOutput) => void - ): Promise | void { - const command = new StartAttachmentUploadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Connect is an easy-to-use omnichannel cloud contact center service that + * enables companies of any size to deliver superior customer service at a lower cost. + * Amazon Connect communications capabilities make it easy for companies to deliver + * personalized interactions across communication channels, including chat.

+ *

Use the Amazon Connect Participant Service to manage participants (for example, + * agents, customers, and managers listening in), and to send messages and events within a + * chat contact. The APIs in the service enable the following: sending chat messages, + * attachment sharing, managing a participant's connection state and message events, and + * retrieving chat transcripts.

+ */ +export class ConnectParticipant extends ConnectParticipantClient implements ConnectParticipant {} +createAggregatedClient(commands, ConnectParticipant); diff --git a/clients/client-controltower/src/ControlTower.ts b/clients/client-controltower/src/ControlTower.ts index 53a4b8948a4a..d9104ff21448 100644 --- a/clients/client-controltower/src/ControlTower.ts +++ b/clients/client-controltower/src/ControlTower.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -21,7 +22,75 @@ import { ListEnabledControlsCommandInput, ListEnabledControlsCommandOutput, } from "./commands/ListEnabledControlsCommand"; -import { ControlTowerClient } from "./ControlTowerClient"; +import { ControlTowerClient, ControlTowerClientConfig } from "./ControlTowerClient"; + +const commands = { + DisableControlCommand, + EnableControlCommand, + GetControlOperationCommand, + ListEnabledControlsCommand, +}; + +export interface ControlTower { + /** + * @see {@link DisableControlCommand} + */ + disableControl( + args: DisableControlCommandInput, + options?: __HttpHandlerOptions + ): Promise; + disableControl(args: DisableControlCommandInput, cb: (err: any, data?: DisableControlCommandOutput) => void): void; + disableControl( + args: DisableControlCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DisableControlCommandOutput) => void + ): void; + + /** + * @see {@link EnableControlCommand} + */ + enableControl(args: EnableControlCommandInput, options?: __HttpHandlerOptions): Promise; + enableControl(args: EnableControlCommandInput, cb: (err: any, data?: EnableControlCommandOutput) => void): void; + enableControl( + args: EnableControlCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: EnableControlCommandOutput) => void + ): void; + + /** + * @see {@link GetControlOperationCommand} + */ + getControlOperation( + args: GetControlOperationCommandInput, + options?: __HttpHandlerOptions + ): Promise; + getControlOperation( + args: GetControlOperationCommandInput, + cb: (err: any, data?: GetControlOperationCommandOutput) => void + ): void; + getControlOperation( + args: GetControlOperationCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: GetControlOperationCommandOutput) => void + ): void; + + /** + * @see {@link ListEnabledControlsCommand} + */ + listEnabledControls( + args: ListEnabledControlsCommandInput, + options?: __HttpHandlerOptions + ): Promise; + listEnabledControls( + args: ListEnabledControlsCommandInput, + cb: (err: any, data?: ListEnabledControlsCommandOutput) => void + ): void; + listEnabledControls( + args: ListEnabledControlsCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: ListEnabledControlsCommandOutput) => void + ): void; +} /** * @public @@ -97,143 +166,5 @@ import { ControlTowerClient } from "./ControlTowerClient"; *

*

AWS Control Tower supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the AWS Control Tower service received, who made the request and when, and so on. For more about AWS Control Tower and its support for CloudTrail, see Logging AWS Control Tower Actions with AWS CloudTrail in the AWS Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.

*/ -export class ControlTower extends ControlTowerClient { - /** - * @public - *

This API call turns off a control. It starts an asynchronous operation that deletes AWS resources on the specified - * organizational unit and the accounts it contains. The resources will vary according to the - * control that you specify.

- */ - public disableControl( - args: DisableControlCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public disableControl( - args: DisableControlCommandInput, - cb: (err: any, data?: DisableControlCommandOutput) => void - ): void; - public disableControl( - args: DisableControlCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: DisableControlCommandOutput) => void - ): void; - public disableControl( - args: DisableControlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableControlCommandOutput) => void), - cb?: (err: any, data?: DisableControlCommandOutput) => void - ): Promise | void { - const command = new DisableControlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API call activates a control. It starts an asynchronous operation that creates AWS resources on the specified - * organizational unit and the accounts it contains. The resources created will vary according to - * the control that you specify.

- */ - public enableControl( - args: EnableControlCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public enableControl( - args: EnableControlCommandInput, - cb: (err: any, data?: EnableControlCommandOutput) => void - ): void; - public enableControl( - args: EnableControlCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: EnableControlCommandOutput) => void - ): void; - public enableControl( - args: EnableControlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableControlCommandOutput) => void), - cb?: (err: any, data?: EnableControlCommandOutput) => void - ): Promise | void { - const command = new EnableControlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the status of a particular EnableControl or - * DisableControl operation. Displays a message in case of error. - * Details for an operation are available for 90 days.

- */ - public getControlOperation( - args: GetControlOperationCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getControlOperation( - args: GetControlOperationCommandInput, - cb: (err: any, data?: GetControlOperationCommandOutput) => void - ): void; - public getControlOperation( - args: GetControlOperationCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: GetControlOperationCommandOutput) => void - ): void; - public getControlOperation( - args: GetControlOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetControlOperationCommandOutput) => void), - cb?: (err: any, data?: GetControlOperationCommandOutput) => void - ): Promise | void { - const command = new GetControlOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the controls enabled by AWS Control Tower on the specified organizational unit and - * the accounts it contains.

- */ - public listEnabledControls( - args: ListEnabledControlsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listEnabledControls( - args: ListEnabledControlsCommandInput, - cb: (err: any, data?: ListEnabledControlsCommandOutput) => void - ): void; - public listEnabledControls( - args: ListEnabledControlsCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: ListEnabledControlsCommandOutput) => void - ): void; - public listEnabledControls( - args: ListEnabledControlsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEnabledControlsCommandOutput) => void), - cb?: (err: any, data?: ListEnabledControlsCommandOutput) => void - ): Promise | void { - const command = new ListEnabledControlsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } -} +export class ControlTower extends ControlTowerClient implements ControlTower {} +createAggregatedClient(commands, ControlTower); diff --git a/clients/client-cost-and-usage-report-service/src/CostAndUsageReportService.ts b/clients/client-cost-and-usage-report-service/src/CostAndUsageReportService.ts index f94e37496d4b..e8cc559cfa40 100644 --- a/clients/client-cost-and-usage-report-service/src/CostAndUsageReportService.ts +++ b/clients/client-cost-and-usage-report-service/src/CostAndUsageReportService.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -21,159 +22,108 @@ import { PutReportDefinitionCommandInput, PutReportDefinitionCommandOutput, } from "./commands/PutReportDefinitionCommand"; -import { CostAndUsageReportServiceClient } from "./CostAndUsageReportServiceClient"; +import { + CostAndUsageReportServiceClient, + CostAndUsageReportServiceClientConfig, +} from "./CostAndUsageReportServiceClient"; -/** - * @public - *

The AWS Cost and Usage Report API enables you to programmatically create, query, and delete - * AWS Cost and Usage report definitions.

- *

AWS Cost and Usage reports track the monthly AWS costs and usage - * associated with your AWS account. - * - * The report contains line items for each unique combination of AWS product, - * usage type, and operation that your AWS account uses. - * - * You can configure the AWS Cost and Usage report to show only the data that you want, using the - * AWS Cost and Usage API.

- * - *

Service Endpoint

- *

The AWS Cost and Usage Report API provides the following endpoint:

- *
    - *
  • - *

    cur.us-east-1.amazonaws.com

    - *
  • - *
- */ -export class CostAndUsageReportService extends CostAndUsageReportServiceClient { +const commands = { + DeleteReportDefinitionCommand, + DescribeReportDefinitionsCommand, + ModifyReportDefinitionCommand, + PutReportDefinitionCommand, +}; + +export interface CostAndUsageReportService { /** - * @public - *

Deletes the specified report.

+ * @see {@link DeleteReportDefinitionCommand} */ - public deleteReportDefinition( + deleteReportDefinition( args: DeleteReportDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteReportDefinition( + deleteReportDefinition( args: DeleteReportDefinitionCommandInput, cb: (err: any, data?: DeleteReportDefinitionCommandOutput) => void ): void; - public deleteReportDefinition( + deleteReportDefinition( args: DeleteReportDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReportDefinitionCommandOutput) => void ): void; - public deleteReportDefinition( - args: DeleteReportDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteReportDefinitionCommandOutput) => void), - cb?: (err: any, data?: DeleteReportDefinitionCommandOutput) => void - ): Promise | void { - const command = new DeleteReportDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the AWS Cost and Usage reports available to this account.

+ * @see {@link DescribeReportDefinitionsCommand} */ - public describeReportDefinitions( + describeReportDefinitions( args: DescribeReportDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReportDefinitions( + describeReportDefinitions( args: DescribeReportDefinitionsCommandInput, cb: (err: any, data?: DescribeReportDefinitionsCommandOutput) => void ): void; - public describeReportDefinitions( + describeReportDefinitions( args: DescribeReportDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReportDefinitionsCommandOutput) => void ): void; - public describeReportDefinitions( - args: DescribeReportDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReportDefinitionsCommandOutput) => void), - cb?: (err: any, data?: DescribeReportDefinitionsCommandOutput) => void - ): Promise | void { - const command = new DescribeReportDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows you to programatically update your report preferences.

+ * @see {@link ModifyReportDefinitionCommand} */ - public modifyReportDefinition( + modifyReportDefinition( args: ModifyReportDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyReportDefinition( + modifyReportDefinition( args: ModifyReportDefinitionCommandInput, cb: (err: any, data?: ModifyReportDefinitionCommandOutput) => void ): void; - public modifyReportDefinition( + modifyReportDefinition( args: ModifyReportDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyReportDefinitionCommandOutput) => void ): void; - public modifyReportDefinition( - args: ModifyReportDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyReportDefinitionCommandOutput) => void), - cb?: (err: any, data?: ModifyReportDefinitionCommandOutput) => void - ): Promise | void { - const command = new ModifyReportDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new report using the description that you provide.

+ * @see {@link PutReportDefinitionCommand} */ - public putReportDefinition( + putReportDefinition( args: PutReportDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public putReportDefinition( + putReportDefinition( args: PutReportDefinitionCommandInput, cb: (err: any, data?: PutReportDefinitionCommandOutput) => void ): void; - public putReportDefinition( + putReportDefinition( args: PutReportDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutReportDefinitionCommandOutput) => void ): void; - public putReportDefinition( - args: PutReportDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutReportDefinitionCommandOutput) => void), - cb?: (err: any, data?: PutReportDefinitionCommandOutput) => void - ): Promise | void { - const command = new PutReportDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The AWS Cost and Usage Report API enables you to programmatically create, query, and delete + * AWS Cost and Usage report definitions.

+ *

AWS Cost and Usage reports track the monthly AWS costs and usage + * associated with your AWS account. + * + * The report contains line items for each unique combination of AWS product, + * usage type, and operation that your AWS account uses. + * + * You can configure the AWS Cost and Usage report to show only the data that you want, using the + * AWS Cost and Usage API.

+ * + *

Service Endpoint

+ *

The AWS Cost and Usage Report API provides the following endpoint:

+ *
    + *
  • + *

    cur.us-east-1.amazonaws.com

    + *
  • + *
+ */ +export class CostAndUsageReportService extends CostAndUsageReportServiceClient implements CostAndUsageReportService {} +createAggregatedClient(commands, CostAndUsageReportService); diff --git a/clients/client-cost-explorer/src/CostExplorer.ts b/clients/client-cost-explorer/src/CostExplorer.ts index 5b55b4518dff..b68964911642 100644 --- a/clients/client-cost-explorer/src/CostExplorer.ts +++ b/clients/client-cost-explorer/src/CostExplorer.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -178,1421 +179,667 @@ import { UpdateCostCategoryDefinitionCommandInput, UpdateCostCategoryDefinitionCommandOutput, } from "./commands/UpdateCostCategoryDefinitionCommand"; -import { CostExplorerClient } from "./CostExplorerClient"; +import { CostExplorerClient, CostExplorerClientConfig } from "./CostExplorerClient"; -/** - * @public - *

You can use the Cost Explorer API to programmatically query your cost and usage data. - * You can query for aggregated data such as total monthly costs or total daily usage. You can - * also query for granular data. This might include the number of daily write operations for - * Amazon DynamoDB database tables in your production environment.

- *

Service Endpoint

- *

The Cost Explorer API provides the following endpoint:

- *
    - *
  • - *

    - * https://ce.us-east-1.amazonaws.com - *

    - *
  • - *
- *

For information about the costs that are associated with the Cost Explorer API, see - * Amazon Web Services Cost - * Management Pricing.

- */ -export class CostExplorer extends CostExplorerClient { +const commands = { + CreateAnomalyMonitorCommand, + CreateAnomalySubscriptionCommand, + CreateCostCategoryDefinitionCommand, + DeleteAnomalyMonitorCommand, + DeleteAnomalySubscriptionCommand, + DeleteCostCategoryDefinitionCommand, + DescribeCostCategoryDefinitionCommand, + GetAnomaliesCommand, + GetAnomalyMonitorsCommand, + GetAnomalySubscriptionsCommand, + GetCostAndUsageCommand, + GetCostAndUsageWithResourcesCommand, + GetCostCategoriesCommand, + GetCostForecastCommand, + GetDimensionValuesCommand, + GetReservationCoverageCommand, + GetReservationPurchaseRecommendationCommand, + GetReservationUtilizationCommand, + GetRightsizingRecommendationCommand, + GetSavingsPlansCoverageCommand, + GetSavingsPlansPurchaseRecommendationCommand, + GetSavingsPlansUtilizationCommand, + GetSavingsPlansUtilizationDetailsCommand, + GetTagsCommand, + GetUsageForecastCommand, + ListCostAllocationTagsCommand, + ListCostCategoryDefinitionsCommand, + ListSavingsPlansPurchaseRecommendationGenerationCommand, + ListTagsForResourceCommand, + ProvideAnomalyFeedbackCommand, + StartSavingsPlansPurchaseRecommendationGenerationCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAnomalyMonitorCommand, + UpdateAnomalySubscriptionCommand, + UpdateCostAllocationTagsStatusCommand, + UpdateCostCategoryDefinitionCommand, +}; + +export interface CostExplorer { /** - * @public - *

Creates a new cost anomaly detection monitor with the requested type and monitor - * specification.

+ * @see {@link CreateAnomalyMonitorCommand} */ - public createAnomalyMonitor( + createAnomalyMonitor( args: CreateAnomalyMonitorCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAnomalyMonitor( + createAnomalyMonitor( args: CreateAnomalyMonitorCommandInput, cb: (err: any, data?: CreateAnomalyMonitorCommandOutput) => void ): void; - public createAnomalyMonitor( + createAnomalyMonitor( args: CreateAnomalyMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAnomalyMonitorCommandOutput) => void ): void; - public createAnomalyMonitor( - args: CreateAnomalyMonitorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAnomalyMonitorCommandOutput) => void), - cb?: (err: any, data?: CreateAnomalyMonitorCommandOutput) => void - ): Promise | void { - const command = new CreateAnomalyMonitorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds an alert subscription to a cost anomaly detection monitor. You can use each - * subscription to define subscribers with email or SNS notifications. Email subscribers can set - * an absolute or percentage threshold and a time frequency for receiving notifications.

+ * @see {@link CreateAnomalySubscriptionCommand} */ - public createAnomalySubscription( + createAnomalySubscription( args: CreateAnomalySubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAnomalySubscription( + createAnomalySubscription( args: CreateAnomalySubscriptionCommandInput, cb: (err: any, data?: CreateAnomalySubscriptionCommandOutput) => void ): void; - public createAnomalySubscription( + createAnomalySubscription( args: CreateAnomalySubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAnomalySubscriptionCommandOutput) => void ): void; - public createAnomalySubscription( - args: CreateAnomalySubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAnomalySubscriptionCommandOutput) => void), - cb?: (err: any, data?: CreateAnomalySubscriptionCommandOutput) => void - ): Promise | void { - const command = new CreateAnomalySubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new Cost Category with the requested name and rules.

+ * @see {@link CreateCostCategoryDefinitionCommand} */ - public createCostCategoryDefinition( + createCostCategoryDefinition( args: CreateCostCategoryDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCostCategoryDefinition( + createCostCategoryDefinition( args: CreateCostCategoryDefinitionCommandInput, cb: (err: any, data?: CreateCostCategoryDefinitionCommandOutput) => void ): void; - public createCostCategoryDefinition( + createCostCategoryDefinition( args: CreateCostCategoryDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCostCategoryDefinitionCommandOutput) => void ): void; - public createCostCategoryDefinition( - args: CreateCostCategoryDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCostCategoryDefinitionCommandOutput) => void), - cb?: (err: any, data?: CreateCostCategoryDefinitionCommandOutput) => void - ): Promise | void { - const command = new CreateCostCategoryDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a cost anomaly monitor.

+ * @see {@link DeleteAnomalyMonitorCommand} */ - public deleteAnomalyMonitor( + deleteAnomalyMonitor( args: DeleteAnomalyMonitorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAnomalyMonitor( + deleteAnomalyMonitor( args: DeleteAnomalyMonitorCommandInput, cb: (err: any, data?: DeleteAnomalyMonitorCommandOutput) => void ): void; - public deleteAnomalyMonitor( + deleteAnomalyMonitor( args: DeleteAnomalyMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAnomalyMonitorCommandOutput) => void ): void; - public deleteAnomalyMonitor( - args: DeleteAnomalyMonitorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAnomalyMonitorCommandOutput) => void), - cb?: (err: any, data?: DeleteAnomalyMonitorCommandOutput) => void - ): Promise | void { - const command = new DeleteAnomalyMonitorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a cost anomaly subscription.

+ * @see {@link DeleteAnomalySubscriptionCommand} */ - public deleteAnomalySubscription( + deleteAnomalySubscription( args: DeleteAnomalySubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAnomalySubscription( + deleteAnomalySubscription( args: DeleteAnomalySubscriptionCommandInput, cb: (err: any, data?: DeleteAnomalySubscriptionCommandOutput) => void ): void; - public deleteAnomalySubscription( + deleteAnomalySubscription( args: DeleteAnomalySubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAnomalySubscriptionCommandOutput) => void ): void; - public deleteAnomalySubscription( - args: DeleteAnomalySubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAnomalySubscriptionCommandOutput) => void), - cb?: (err: any, data?: DeleteAnomalySubscriptionCommandOutput) => void - ): Promise | void { - const command = new DeleteAnomalySubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Cost Category. Expenses from this month going forward will no longer be - * categorized with this Cost Category.

+ * @see {@link DeleteCostCategoryDefinitionCommand} */ - public deleteCostCategoryDefinition( + deleteCostCategoryDefinition( args: DeleteCostCategoryDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCostCategoryDefinition( + deleteCostCategoryDefinition( args: DeleteCostCategoryDefinitionCommandInput, cb: (err: any, data?: DeleteCostCategoryDefinitionCommandOutput) => void ): void; - public deleteCostCategoryDefinition( + deleteCostCategoryDefinition( args: DeleteCostCategoryDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCostCategoryDefinitionCommandOutput) => void ): void; - public deleteCostCategoryDefinition( - args: DeleteCostCategoryDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCostCategoryDefinitionCommandOutput) => void), - cb?: (err: any, data?: DeleteCostCategoryDefinitionCommandOutput) => void - ): Promise | void { - const command = new DeleteCostCategoryDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the name, Amazon Resource Name (ARN), rules, definition, and effective dates of a - * Cost Category that's defined in the account.

- *

You have the option to use EffectiveOn to return a Cost Category that's - * active on a specific date. If there's no EffectiveOn specified, you see a Cost - * Category that's effective on the current date. If Cost Category is still effective, - * EffectiveEnd is omitted in the response.

+ * @see {@link DescribeCostCategoryDefinitionCommand} */ - public describeCostCategoryDefinition( + describeCostCategoryDefinition( args: DescribeCostCategoryDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCostCategoryDefinition( + describeCostCategoryDefinition( args: DescribeCostCategoryDefinitionCommandInput, cb: (err: any, data?: DescribeCostCategoryDefinitionCommandOutput) => void ): void; - public describeCostCategoryDefinition( + describeCostCategoryDefinition( args: DescribeCostCategoryDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCostCategoryDefinitionCommandOutput) => void ): void; - public describeCostCategoryDefinition( - args: DescribeCostCategoryDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCostCategoryDefinitionCommandOutput) => void), - cb?: (err: any, data?: DescribeCostCategoryDefinitionCommandOutput) => void - ): Promise | void { - const command = new DescribeCostCategoryDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves all of the cost anomalies detected on your account during the time period that's - * specified by the DateInterval object. Anomalies are available for up to 90 - * days.

+ * @see {@link GetAnomaliesCommand} */ - public getAnomalies( - args: GetAnomaliesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getAnomalies(args: GetAnomaliesCommandInput, cb: (err: any, data?: GetAnomaliesCommandOutput) => void): void; - public getAnomalies( + getAnomalies(args: GetAnomaliesCommandInput, options?: __HttpHandlerOptions): Promise; + getAnomalies(args: GetAnomaliesCommandInput, cb: (err: any, data?: GetAnomaliesCommandOutput) => void): void; + getAnomalies( args: GetAnomaliesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAnomaliesCommandOutput) => void ): void; - public getAnomalies( - args: GetAnomaliesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAnomaliesCommandOutput) => void), - cb?: (err: any, data?: GetAnomaliesCommandOutput) => void - ): Promise | void { - const command = new GetAnomaliesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the cost anomaly monitor definitions for your account. You can filter using a - * list of cost anomaly monitor Amazon Resource Names (ARNs).

+ * @see {@link GetAnomalyMonitorsCommand} */ - public getAnomalyMonitors( + getAnomalyMonitors( args: GetAnomalyMonitorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAnomalyMonitors( + getAnomalyMonitors( args: GetAnomalyMonitorsCommandInput, cb: (err: any, data?: GetAnomalyMonitorsCommandOutput) => void ): void; - public getAnomalyMonitors( + getAnomalyMonitors( args: GetAnomalyMonitorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAnomalyMonitorsCommandOutput) => void ): void; - public getAnomalyMonitors( - args: GetAnomalyMonitorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAnomalyMonitorsCommandOutput) => void), - cb?: (err: any, data?: GetAnomalyMonitorsCommandOutput) => void - ): Promise | void { - const command = new GetAnomalyMonitorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the cost anomaly subscription objects for your account. You can filter using a - * list of cost anomaly monitor Amazon Resource Names (ARNs).

+ * @see {@link GetAnomalySubscriptionsCommand} */ - public getAnomalySubscriptions( + getAnomalySubscriptions( args: GetAnomalySubscriptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAnomalySubscriptions( + getAnomalySubscriptions( args: GetAnomalySubscriptionsCommandInput, cb: (err: any, data?: GetAnomalySubscriptionsCommandOutput) => void ): void; - public getAnomalySubscriptions( + getAnomalySubscriptions( args: GetAnomalySubscriptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAnomalySubscriptionsCommandOutput) => void ): void; - public getAnomalySubscriptions( - args: GetAnomalySubscriptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAnomalySubscriptionsCommandOutput) => void), - cb?: (err: any, data?: GetAnomalySubscriptionsCommandOutput) => void - ): Promise | void { - const command = new GetAnomalySubscriptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves cost and usage metrics for your account. You can specify which cost and - * usage-related metric that you want the request to return. For example, you can specify - * BlendedCosts or UsageQuantity. You can also filter and group your - * data by various dimensions, such as SERVICE or AZ, in a specific - * time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Management account in an organization in Organizations have access to all member accounts.

- *

For information about filter limitations, see Quotas and restrictions - * in the Billing and Cost Management User Guide.

+ * @see {@link GetCostAndUsageCommand} */ - public getCostAndUsage( + getCostAndUsage( args: GetCostAndUsageCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCostAndUsage( - args: GetCostAndUsageCommandInput, - cb: (err: any, data?: GetCostAndUsageCommandOutput) => void - ): void; - public getCostAndUsage( + getCostAndUsage(args: GetCostAndUsageCommandInput, cb: (err: any, data?: GetCostAndUsageCommandOutput) => void): void; + getCostAndUsage( args: GetCostAndUsageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCostAndUsageCommandOutput) => void ): void; - public getCostAndUsage( - args: GetCostAndUsageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCostAndUsageCommandOutput) => void), - cb?: (err: any, data?: GetCostAndUsageCommandOutput) => void - ): Promise | void { - const command = new GetCostAndUsageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves cost and usage metrics with resources for your account. You can specify which - * cost and usage-related metric, such as BlendedCosts or - * UsageQuantity, that you want the request to return. You can also filter and group - * your data by various dimensions, such as SERVICE or AZ, in a - * specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Management account in an organization in Organizations have access to all member accounts. This API is currently available for the - * Amazon Elastic Compute Cloud – Compute service only.

- * - *

This is an opt-in only feature. You can enable this feature from the Cost Explorer - * Settings page. For information about how to access the Settings page, see Controlling - * Access for Cost Explorer in the Billing and Cost Management User - * Guide.

- *
+ * @see {@link GetCostAndUsageWithResourcesCommand} */ - public getCostAndUsageWithResources( + getCostAndUsageWithResources( args: GetCostAndUsageWithResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCostAndUsageWithResources( + getCostAndUsageWithResources( args: GetCostAndUsageWithResourcesCommandInput, cb: (err: any, data?: GetCostAndUsageWithResourcesCommandOutput) => void ): void; - public getCostAndUsageWithResources( + getCostAndUsageWithResources( args: GetCostAndUsageWithResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCostAndUsageWithResourcesCommandOutput) => void ): void; - public getCostAndUsageWithResources( - args: GetCostAndUsageWithResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCostAndUsageWithResourcesCommandOutput) => void), - cb?: (err: any, data?: GetCostAndUsageWithResourcesCommandOutput) => void - ): Promise | void { - const command = new GetCostAndUsageWithResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves an array of Cost Category names and values incurred cost.

- * - *

If some Cost Category names and values are not associated with any cost, they will not - * be returned by this API.

- *
+ * @see {@link GetCostCategoriesCommand} */ - public getCostCategories( + getCostCategories( args: GetCostCategoriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCostCategories( + getCostCategories( args: GetCostCategoriesCommandInput, cb: (err: any, data?: GetCostCategoriesCommandOutput) => void ): void; - public getCostCategories( + getCostCategories( args: GetCostCategoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCostCategoriesCommandOutput) => void ): void; - public getCostCategories( - args: GetCostCategoriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCostCategoriesCommandOutput) => void), - cb?: (err: any, data?: GetCostCategoriesCommandOutput) => void - ): Promise | void { - const command = new GetCostCategoriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a forecast for how much Amazon Web Services predicts that you will spend over - * the forecast time period that you select, based on your past costs.

+ * @see {@link GetCostForecastCommand} */ - public getCostForecast( + getCostForecast( args: GetCostForecastCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCostForecast( - args: GetCostForecastCommandInput, - cb: (err: any, data?: GetCostForecastCommandOutput) => void - ): void; - public getCostForecast( + getCostForecast(args: GetCostForecastCommandInput, cb: (err: any, data?: GetCostForecastCommandOutput) => void): void; + getCostForecast( args: GetCostForecastCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCostForecastCommandOutput) => void ): void; - public getCostForecast( - args: GetCostForecastCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCostForecastCommandOutput) => void), - cb?: (err: any, data?: GetCostForecastCommandOutput) => void - ): Promise | void { - const command = new GetCostForecastCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves all available filter values for a specified filter over a period of time. You - * can search the dimension values for an arbitrary string.

+ * @see {@link GetDimensionValuesCommand} */ - public getDimensionValues( + getDimensionValues( args: GetDimensionValuesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDimensionValues( + getDimensionValues( args: GetDimensionValuesCommandInput, cb: (err: any, data?: GetDimensionValuesCommandOutput) => void ): void; - public getDimensionValues( + getDimensionValues( args: GetDimensionValuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDimensionValuesCommandOutput) => void ): void; - public getDimensionValues( - args: GetDimensionValuesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDimensionValuesCommandOutput) => void), - cb?: (err: any, data?: GetDimensionValuesCommandOutput) => void - ): Promise | void { - const command = new GetDimensionValuesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the reservation coverage for your account, which you can use to see how much - * of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, - * or Amazon Redshift usage is covered by a reservation. An organization's management account can - * see the coverage of the associated member accounts. This supports dimensions, Cost Categories, - * and nested expressions. For any time period, you can filter data about reservation usage by - * the following dimensions:

- *
    - *
  • - *

    AZ

    - *
  • - *
  • - *

    CACHE_ENGINE

    - *
  • - *
  • - *

    DATABASE_ENGINE

    - *
  • - *
  • - *

    DEPLOYMENT_OPTION

    - *
  • - *
  • - *

    INSTANCE_TYPE

    - *
  • - *
  • - *

    LINKED_ACCOUNT

    - *
  • - *
  • - *

    OPERATING_SYSTEM

    - *
  • - *
  • - *

    PLATFORM

    - *
  • - *
  • - *

    REGION

    - *
  • - *
  • - *

    SERVICE

    - *
  • - *
  • - *

    TAG

    - *
  • - *
  • - *

    TENANCY

    - *
  • - *
- *

To determine valid values for a dimension, use the GetDimensionValues - * operation.

+ * @see {@link GetReservationCoverageCommand} */ - public getReservationCoverage( + getReservationCoverage( args: GetReservationCoverageCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReservationCoverage( + getReservationCoverage( args: GetReservationCoverageCommandInput, cb: (err: any, data?: GetReservationCoverageCommandOutput) => void ): void; - public getReservationCoverage( + getReservationCoverage( args: GetReservationCoverageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReservationCoverageCommandOutput) => void ): void; - public getReservationCoverage( - args: GetReservationCoverageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReservationCoverageCommandOutput) => void), - cb?: (err: any, data?: GetReservationCoverageCommandOutput) => void - ): Promise | void { - const command = new GetReservationCoverageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets recommendations for reservation purchases. These recommendations might help you to - * reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to - * On-Demand pricing.

- *

Amazon Web Services generates your recommendations by identifying your On-Demand usage - * during a specific time period and collecting your usage into categories that are eligible for - * a reservation. After Amazon Web Services has these categories, it simulates every combination - * of reservations in each category of usage to identify the best number of each type of Reserved - * Instance (RI) to purchase to maximize your estimated savings.

- *

For example, Amazon Web Services automatically aggregates your Amazon EC2 Linux, shared - * tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you buy - * size-flexible regional reservations to apply to the c4 family usage. Amazon Web Services - * recommends the smallest size instance in an instance family. This makes it easier to purchase - * a size-flexible Reserved Instance (RI). Amazon Web Services also shows the equal number of - * normalized units. This way, you can purchase any instance size that you want. For this - * example, your RI recommendation is for c4.large because that is the smallest size - * instance in the c4 instance family.

+ * @see {@link GetReservationPurchaseRecommendationCommand} */ - public getReservationPurchaseRecommendation( + getReservationPurchaseRecommendation( args: GetReservationPurchaseRecommendationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReservationPurchaseRecommendation( + getReservationPurchaseRecommendation( args: GetReservationPurchaseRecommendationCommandInput, cb: (err: any, data?: GetReservationPurchaseRecommendationCommandOutput) => void ): void; - public getReservationPurchaseRecommendation( + getReservationPurchaseRecommendation( args: GetReservationPurchaseRecommendationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReservationPurchaseRecommendationCommandOutput) => void ): void; - public getReservationPurchaseRecommendation( - args: GetReservationPurchaseRecommendationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReservationPurchaseRecommendationCommandOutput) => void), - cb?: (err: any, data?: GetReservationPurchaseRecommendationCommandOutput) => void - ): Promise | void { - const command = new GetReservationPurchaseRecommendationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the reservation utilization for your account. Management account in an - * organization have access to member accounts. You can filter data by dimensions in a time - * period. You can use GetDimensionValues to determine the possible dimension - * values. Currently, you can group only by SUBSCRIPTION_ID.

+ * @see {@link GetReservationUtilizationCommand} */ - public getReservationUtilization( + getReservationUtilization( args: GetReservationUtilizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReservationUtilization( + getReservationUtilization( args: GetReservationUtilizationCommandInput, cb: (err: any, data?: GetReservationUtilizationCommandOutput) => void ): void; - public getReservationUtilization( + getReservationUtilization( args: GetReservationUtilizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReservationUtilizationCommandOutput) => void ): void; - public getReservationUtilization( - args: GetReservationUtilizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReservationUtilizationCommandOutput) => void), - cb?: (err: any, data?: GetReservationUtilizationCommandOutput) => void - ): Promise | void { - const command = new GetReservationUtilizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates recommendations that help you save cost by identifying idle and underutilized - * Amazon EC2 instances.

- *

Recommendations are generated to either downsize or terminate instances, along with - * providing savings detail and metrics. For more information about calculation and function, see - * Optimizing Your Cost with Rightsizing Recommendations in the Billing and Cost Management User Guide.

+ * @see {@link GetRightsizingRecommendationCommand} */ - public getRightsizingRecommendation( + getRightsizingRecommendation( args: GetRightsizingRecommendationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRightsizingRecommendation( + getRightsizingRecommendation( args: GetRightsizingRecommendationCommandInput, cb: (err: any, data?: GetRightsizingRecommendationCommandOutput) => void ): void; - public getRightsizingRecommendation( + getRightsizingRecommendation( args: GetRightsizingRecommendationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRightsizingRecommendationCommandOutput) => void ): void; - public getRightsizingRecommendation( - args: GetRightsizingRecommendationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRightsizingRecommendationCommandOutput) => void), - cb?: (err: any, data?: GetRightsizingRecommendationCommandOutput) => void - ): Promise | void { - const command = new GetRightsizingRecommendationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the Savings Plans covered for your account. This enables you to see how much of - * your cost is covered by a Savings Plan. An organization’s management account can see the - * coverage of the associated member accounts. This supports dimensions, Cost Categories, and - * nested expressions. For any time period, you can filter data for Savings Plans usage with the - * following dimensions:

- *
    - *
  • - *

    - * LINKED_ACCOUNT - *

    - *
  • - *
  • - *

    - * REGION - *

    - *
  • - *
  • - *

    - * SERVICE - *

    - *
  • - *
  • - *

    - * INSTANCE_FAMILY - *

    - *
  • - *
- *

To determine valid values for a dimension, use the GetDimensionValues - * operation.

+ * @see {@link GetSavingsPlansCoverageCommand} */ - public getSavingsPlansCoverage( + getSavingsPlansCoverage( args: GetSavingsPlansCoverageCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSavingsPlansCoverage( + getSavingsPlansCoverage( args: GetSavingsPlansCoverageCommandInput, cb: (err: any, data?: GetSavingsPlansCoverageCommandOutput) => void ): void; - public getSavingsPlansCoverage( + getSavingsPlansCoverage( args: GetSavingsPlansCoverageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSavingsPlansCoverageCommandOutput) => void ): void; - public getSavingsPlansCoverage( - args: GetSavingsPlansCoverageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSavingsPlansCoverageCommandOutput) => void), - cb?: (err: any, data?: GetSavingsPlansCoverageCommandOutput) => void - ): Promise | void { - const command = new GetSavingsPlansCoverageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the Savings Plans recommendations for your account. First use - * StartSavingsPlansPurchaseRecommendationGeneration to generate a new set of - * recommendations, and then use GetSavingsPlansPurchaseRecommendation to retrieve - * them.

+ * @see {@link GetSavingsPlansPurchaseRecommendationCommand} */ - public getSavingsPlansPurchaseRecommendation( + getSavingsPlansPurchaseRecommendation( args: GetSavingsPlansPurchaseRecommendationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSavingsPlansPurchaseRecommendation( + getSavingsPlansPurchaseRecommendation( args: GetSavingsPlansPurchaseRecommendationCommandInput, cb: (err: any, data?: GetSavingsPlansPurchaseRecommendationCommandOutput) => void ): void; - public getSavingsPlansPurchaseRecommendation( + getSavingsPlansPurchaseRecommendation( args: GetSavingsPlansPurchaseRecommendationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSavingsPlansPurchaseRecommendationCommandOutput) => void ): void; - public getSavingsPlansPurchaseRecommendation( - args: GetSavingsPlansPurchaseRecommendationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetSavingsPlansPurchaseRecommendationCommandOutput) => void), - cb?: (err: any, data?: GetSavingsPlansPurchaseRecommendationCommandOutput) => void - ): Promise | void { - const command = new GetSavingsPlansPurchaseRecommendationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the Savings Plans utilization for your account across date ranges with daily or - * monthly granularity. Management account in an organization have access to member accounts. You - * can use GetDimensionValues in SAVINGS_PLANS to determine the - * possible dimension values.

- * - *

You can't group by any dimension values for - * GetSavingsPlansUtilization.

- *
+ * @see {@link GetSavingsPlansUtilizationCommand} */ - public getSavingsPlansUtilization( + getSavingsPlansUtilization( args: GetSavingsPlansUtilizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSavingsPlansUtilization( + getSavingsPlansUtilization( args: GetSavingsPlansUtilizationCommandInput, cb: (err: any, data?: GetSavingsPlansUtilizationCommandOutput) => void ): void; - public getSavingsPlansUtilization( + getSavingsPlansUtilization( args: GetSavingsPlansUtilizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSavingsPlansUtilizationCommandOutput) => void ): void; - public getSavingsPlansUtilization( - args: GetSavingsPlansUtilizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSavingsPlansUtilizationCommandOutput) => void), - cb?: (err: any, data?: GetSavingsPlansUtilizationCommandOutput) => void - ): Promise | void { - const command = new GetSavingsPlansUtilizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves attribute data along with aggregate utilization and savings data for a given - * time period. This doesn't support granular or grouped data (daily/monthly) in response. You - * can't retrieve data by dates in a single response similar to - * GetSavingsPlanUtilization, but you have the option to make multiple calls to - * GetSavingsPlanUtilizationDetails by providing individual dates. You can use - * GetDimensionValues in SAVINGS_PLANS to determine the possible - * dimension values.

- * - *

- * GetSavingsPlanUtilizationDetails internally groups data by - * SavingsPlansArn.

- *
+ * @see {@link GetSavingsPlansUtilizationDetailsCommand} */ - public getSavingsPlansUtilizationDetails( + getSavingsPlansUtilizationDetails( args: GetSavingsPlansUtilizationDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSavingsPlansUtilizationDetails( + getSavingsPlansUtilizationDetails( args: GetSavingsPlansUtilizationDetailsCommandInput, cb: (err: any, data?: GetSavingsPlansUtilizationDetailsCommandOutput) => void ): void; - public getSavingsPlansUtilizationDetails( + getSavingsPlansUtilizationDetails( args: GetSavingsPlansUtilizationDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSavingsPlansUtilizationDetailsCommandOutput) => void ): void; - public getSavingsPlansUtilizationDetails( - args: GetSavingsPlansUtilizationDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSavingsPlansUtilizationDetailsCommandOutput) => void), - cb?: (err: any, data?: GetSavingsPlansUtilizationDetailsCommandOutput) => void - ): Promise | void { - const command = new GetSavingsPlansUtilizationDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Queries for available tag keys and tag values for a specified period. You can search - * the tag values for an arbitrary string.

+ * @see {@link GetTagsCommand} */ - public getTags(args: GetTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public getTags(args: GetTagsCommandInput, cb: (err: any, data?: GetTagsCommandOutput) => void): void; - public getTags( + getTags(args: GetTagsCommandInput, options?: __HttpHandlerOptions): Promise; + getTags(args: GetTagsCommandInput, cb: (err: any, data?: GetTagsCommandOutput) => void): void; + getTags( args: GetTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTagsCommandOutput) => void ): void; - public getTags( - args: GetTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTagsCommandOutput) => void), - cb?: (err: any, data?: GetTagsCommandOutput) => void - ): Promise | void { - const command = new GetTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a forecast for how much Amazon Web Services predicts that you will use - * over the forecast time period that you select, based on your past usage.

+ * @see {@link GetUsageForecastCommand} */ - public getUsageForecast( + getUsageForecast( args: GetUsageForecastCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUsageForecast( + getUsageForecast( args: GetUsageForecastCommandInput, cb: (err: any, data?: GetUsageForecastCommandOutput) => void ): void; - public getUsageForecast( + getUsageForecast( args: GetUsageForecastCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUsageForecastCommandOutput) => void ): void; - public getUsageForecast( - args: GetUsageForecastCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUsageForecastCommandOutput) => void), - cb?: (err: any, data?: GetUsageForecastCommandOutput) => void - ): Promise | void { - const command = new GetUsageForecastCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get a list of cost allocation tags. All inputs in the API are optional and serve as - * filters. By default, all cost allocation tags are returned.

+ * @see {@link ListCostAllocationTagsCommand} */ - public listCostAllocationTags( + listCostAllocationTags( args: ListCostAllocationTagsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCostAllocationTags( + listCostAllocationTags( args: ListCostAllocationTagsCommandInput, cb: (err: any, data?: ListCostAllocationTagsCommandOutput) => void ): void; - public listCostAllocationTags( + listCostAllocationTags( args: ListCostAllocationTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCostAllocationTagsCommandOutput) => void ): void; - public listCostAllocationTags( - args: ListCostAllocationTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCostAllocationTagsCommandOutput) => void), - cb?: (err: any, data?: ListCostAllocationTagsCommandOutput) => void - ): Promise | void { - const command = new ListCostAllocationTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the name, Amazon Resource Name (ARN), NumberOfRules and effective - * dates of all Cost Categories defined in the account. You have the option to use - * EffectiveOn to return a list of Cost Categories that were active on a specific - * date. If there is no EffectiveOn specified, you’ll see Cost Categories that are - * effective on the current date. If Cost Category is still effective, EffectiveEnd - * is omitted in the response. ListCostCategoryDefinitions supports pagination. The - * request can have a MaxResults range up to 100.

+ * @see {@link ListCostCategoryDefinitionsCommand} */ - public listCostCategoryDefinitions( + listCostCategoryDefinitions( args: ListCostCategoryDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCostCategoryDefinitions( + listCostCategoryDefinitions( args: ListCostCategoryDefinitionsCommandInput, cb: (err: any, data?: ListCostCategoryDefinitionsCommandOutput) => void ): void; - public listCostCategoryDefinitions( + listCostCategoryDefinitions( args: ListCostCategoryDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCostCategoryDefinitionsCommandOutput) => void ): void; - public listCostCategoryDefinitions( - args: ListCostCategoryDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCostCategoryDefinitionsCommandOutput) => void), - cb?: (err: any, data?: ListCostCategoryDefinitionsCommandOutput) => void - ): Promise | void { - const command = new ListCostCategoryDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of your historical recommendation generations within the past 30 - * days.

+ * @see {@link ListSavingsPlansPurchaseRecommendationGenerationCommand} */ - public listSavingsPlansPurchaseRecommendationGeneration( + listSavingsPlansPurchaseRecommendationGeneration( args: ListSavingsPlansPurchaseRecommendationGenerationCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSavingsPlansPurchaseRecommendationGeneration( + listSavingsPlansPurchaseRecommendationGeneration( args: ListSavingsPlansPurchaseRecommendationGenerationCommandInput, cb: (err: any, data?: ListSavingsPlansPurchaseRecommendationGenerationCommandOutput) => void ): void; - public listSavingsPlansPurchaseRecommendationGeneration( + listSavingsPlansPurchaseRecommendationGeneration( args: ListSavingsPlansPurchaseRecommendationGenerationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSavingsPlansPurchaseRecommendationGenerationCommandOutput) => void ): void; - public listSavingsPlansPurchaseRecommendationGeneration( - args: ListSavingsPlansPurchaseRecommendationGenerationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListSavingsPlansPurchaseRecommendationGenerationCommandOutput) => void), - cb?: (err: any, data?: ListSavingsPlansPurchaseRecommendationGenerationCommandOutput) => void - ): Promise | void { - const command = new ListSavingsPlansPurchaseRecommendationGenerationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of resource tags associated with the resource specified by the Amazon - * Resource Name (ARN).

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the feedback property of a given cost anomaly.

+ * @see {@link ProvideAnomalyFeedbackCommand} */ - public provideAnomalyFeedback( + provideAnomalyFeedback( args: ProvideAnomalyFeedbackCommandInput, options?: __HttpHandlerOptions ): Promise; - public provideAnomalyFeedback( + provideAnomalyFeedback( args: ProvideAnomalyFeedbackCommandInput, cb: (err: any, data?: ProvideAnomalyFeedbackCommandOutput) => void ): void; - public provideAnomalyFeedback( + provideAnomalyFeedback( args: ProvideAnomalyFeedbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ProvideAnomalyFeedbackCommandOutput) => void ): void; - public provideAnomalyFeedback( - args: ProvideAnomalyFeedbackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ProvideAnomalyFeedbackCommandOutput) => void), - cb?: (err: any, data?: ProvideAnomalyFeedbackCommandOutput) => void - ): Promise | void { - const command = new ProvideAnomalyFeedbackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Requests a Savings Plans recommendation generation. This enables you to calculate a fresh - * set of Savings Plans recommendations that takes your latest usage data and current Savings - * Plans inventory into account. You can refresh Savings Plans recommendations up to three times - * daily for a consolidated billing family.

- * - *

- * StartSavingsPlansPurchaseRecommendationGeneration has no request syntax - * because no input parameters are needed to support this operation.

- *
+ * @see {@link StartSavingsPlansPurchaseRecommendationGenerationCommand} */ - public startSavingsPlansPurchaseRecommendationGeneration( + startSavingsPlansPurchaseRecommendationGeneration( args: StartSavingsPlansPurchaseRecommendationGenerationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startSavingsPlansPurchaseRecommendationGeneration( + startSavingsPlansPurchaseRecommendationGeneration( args: StartSavingsPlansPurchaseRecommendationGenerationCommandInput, cb: (err: any, data?: StartSavingsPlansPurchaseRecommendationGenerationCommandOutput) => void ): void; - public startSavingsPlansPurchaseRecommendationGeneration( + startSavingsPlansPurchaseRecommendationGeneration( args: StartSavingsPlansPurchaseRecommendationGenerationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSavingsPlansPurchaseRecommendationGenerationCommandOutput) => void ): void; - public startSavingsPlansPurchaseRecommendationGeneration( - args: StartSavingsPlansPurchaseRecommendationGenerationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: StartSavingsPlansPurchaseRecommendationGenerationCommandOutput) => void), - cb?: (err: any, data?: StartSavingsPlansPurchaseRecommendationGenerationCommandOutput) => void - ): Promise | void { - const command = new StartSavingsPlansPurchaseRecommendationGenerationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

An API operation for adding one or more tags (key-value pairs) to a resource.

- *

You can use the TagResource operation with a resource that already has tags. - * If you specify a new tag key for the resource, this tag is appended to the list of tags - * associated with the resource. If you specify a tag key that is already associated with the - * resource, the new tag value you specify replaces the previous value for that tag.

- *

Although the maximum number of array members is 200, user-tag maximum is 50. The remaining - * are reserved for Amazon Web Services use.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from a resource. Specify only tag keys in your request. Don't - * specify the value.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing cost anomaly monitor. The changes made are applied going forward, and - * doesn't change anomalies detected in the past.

+ * @see {@link UpdateAnomalyMonitorCommand} */ - public updateAnomalyMonitor( + updateAnomalyMonitor( args: UpdateAnomalyMonitorCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAnomalyMonitor( + updateAnomalyMonitor( args: UpdateAnomalyMonitorCommandInput, cb: (err: any, data?: UpdateAnomalyMonitorCommandOutput) => void ): void; - public updateAnomalyMonitor( + updateAnomalyMonitor( args: UpdateAnomalyMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAnomalyMonitorCommandOutput) => void ): void; - public updateAnomalyMonitor( - args: UpdateAnomalyMonitorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAnomalyMonitorCommandOutput) => void), - cb?: (err: any, data?: UpdateAnomalyMonitorCommandOutput) => void - ): Promise | void { - const command = new UpdateAnomalyMonitorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing cost anomaly monitor subscription.

+ * @see {@link UpdateAnomalySubscriptionCommand} */ - public updateAnomalySubscription( + updateAnomalySubscription( args: UpdateAnomalySubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAnomalySubscription( + updateAnomalySubscription( args: UpdateAnomalySubscriptionCommandInput, cb: (err: any, data?: UpdateAnomalySubscriptionCommandOutput) => void ): void; - public updateAnomalySubscription( + updateAnomalySubscription( args: UpdateAnomalySubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAnomalySubscriptionCommandOutput) => void ): void; - public updateAnomalySubscription( - args: UpdateAnomalySubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAnomalySubscriptionCommandOutput) => void), - cb?: (err: any, data?: UpdateAnomalySubscriptionCommandOutput) => void - ): Promise | void { - const command = new UpdateAnomalySubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates status for cost allocation tags in bulk, with maximum batch size of 20. If the tag - * status that's updated is the same as the existing tag status, the request doesn't fail. - * Instead, it doesn't have any effect on the tag status (for example, activating the active - * tag).

+ * @see {@link UpdateCostAllocationTagsStatusCommand} */ - public updateCostAllocationTagsStatus( + updateCostAllocationTagsStatus( args: UpdateCostAllocationTagsStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCostAllocationTagsStatus( + updateCostAllocationTagsStatus( args: UpdateCostAllocationTagsStatusCommandInput, cb: (err: any, data?: UpdateCostAllocationTagsStatusCommandOutput) => void ): void; - public updateCostAllocationTagsStatus( + updateCostAllocationTagsStatus( args: UpdateCostAllocationTagsStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCostAllocationTagsStatusCommandOutput) => void ): void; - public updateCostAllocationTagsStatus( - args: UpdateCostAllocationTagsStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCostAllocationTagsStatusCommandOutput) => void), - cb?: (err: any, data?: UpdateCostAllocationTagsStatusCommandOutput) => void - ): Promise | void { - const command = new UpdateCostAllocationTagsStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing Cost Category. Changes made to the Cost Category rules will be used to - * categorize the current month’s expenses and future expenses. This won’t change categorization - * for the previous months.

+ * @see {@link UpdateCostCategoryDefinitionCommand} */ - public updateCostCategoryDefinition( + updateCostCategoryDefinition( args: UpdateCostCategoryDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCostCategoryDefinition( + updateCostCategoryDefinition( args: UpdateCostCategoryDefinitionCommandInput, cb: (err: any, data?: UpdateCostCategoryDefinitionCommandOutput) => void ): void; - public updateCostCategoryDefinition( + updateCostCategoryDefinition( args: UpdateCostCategoryDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCostCategoryDefinitionCommandOutput) => void ): void; - public updateCostCategoryDefinition( - args: UpdateCostCategoryDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCostCategoryDefinitionCommandOutput) => void), - cb?: (err: any, data?: UpdateCostCategoryDefinitionCommandOutput) => void - ): Promise | void { - const command = new UpdateCostCategoryDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

You can use the Cost Explorer API to programmatically query your cost and usage data. + * You can query for aggregated data such as total monthly costs or total daily usage. You can + * also query for granular data. This might include the number of daily write operations for + * Amazon DynamoDB database tables in your production environment.

+ *

Service Endpoint

+ *

The Cost Explorer API provides the following endpoint:

+ *
    + *
  • + *

    + * https://ce.us-east-1.amazonaws.com + *

    + *
  • + *
+ *

For information about the costs that are associated with the Cost Explorer API, see + * Amazon Web Services Cost + * Management Pricing.

+ */ +export class CostExplorer extends CostExplorerClient implements CostExplorer {} +createAggregatedClient(commands, CostExplorer); diff --git a/clients/client-customer-profiles/src/CustomerProfiles.ts b/clients/client-customer-profiles/src/CustomerProfiles.ts index 891055a801e5..45aa018ba61c 100644 --- a/clients/client-customer-profiles/src/CustomerProfiles.ts +++ b/clients/client-customer-profiles/src/CustomerProfiles.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -171,1400 +172,603 @@ import { UpdateProfileCommandInput, UpdateProfileCommandOutput, } from "./commands/UpdateProfileCommand"; -import { CustomerProfilesClient } from "./CustomerProfilesClient"; +import { CustomerProfilesClient, CustomerProfilesClientConfig } from "./CustomerProfilesClient"; -/** - * @public - * Amazon Connect Customer Profiles - *

Amazon Connect Customer Profiles is a unified customer profile for your contact center that has - * pre-built connectors powered by AppFlow that make it easy to combine customer information - * from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your - * enterprise resource planning (ERP), with contact history from your Amazon Connect contact center. - * If you're new to Amazon Connect, you might find it helpful to review the Amazon Connect Administrator Guide.

- */ -export class CustomerProfiles extends CustomerProfilesClient { +const commands = { + AddProfileKeyCommand, + CreateDomainCommand, + CreateIntegrationWorkflowCommand, + CreateProfileCommand, + DeleteDomainCommand, + DeleteIntegrationCommand, + DeleteProfileCommand, + DeleteProfileKeyCommand, + DeleteProfileObjectCommand, + DeleteProfileObjectTypeCommand, + DeleteWorkflowCommand, + GetAutoMergingPreviewCommand, + GetDomainCommand, + GetIdentityResolutionJobCommand, + GetIntegrationCommand, + GetMatchesCommand, + GetProfileObjectTypeCommand, + GetProfileObjectTypeTemplateCommand, + GetWorkflowCommand, + GetWorkflowStepsCommand, + ListAccountIntegrationsCommand, + ListDomainsCommand, + ListIdentityResolutionJobsCommand, + ListIntegrationsCommand, + ListProfileObjectsCommand, + ListProfileObjectTypesCommand, + ListProfileObjectTypeTemplatesCommand, + ListTagsForResourceCommand, + ListWorkflowsCommand, + MergeProfilesCommand, + PutIntegrationCommand, + PutProfileObjectCommand, + PutProfileObjectTypeCommand, + SearchProfilesCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateDomainCommand, + UpdateProfileCommand, +}; + +export interface CustomerProfiles { /** - * @public - *

Associates a new key value with a specific profile, such as a Contact Record - * ContactId.

- *

A profile object can have a single unique key and any number of additional keys that can - * be used to identify the profile that it belongs to.

+ * @see {@link AddProfileKeyCommand} */ - public addProfileKey( - args: AddProfileKeyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public addProfileKey( - args: AddProfileKeyCommandInput, - cb: (err: any, data?: AddProfileKeyCommandOutput) => void - ): void; - public addProfileKey( + addProfileKey(args: AddProfileKeyCommandInput, options?: __HttpHandlerOptions): Promise; + addProfileKey(args: AddProfileKeyCommandInput, cb: (err: any, data?: AddProfileKeyCommandOutput) => void): void; + addProfileKey( args: AddProfileKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddProfileKeyCommandOutput) => void ): void; - public addProfileKey( - args: AddProfileKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddProfileKeyCommandOutput) => void), - cb?: (err: any, data?: AddProfileKeyCommandOutput) => void - ): Promise | void { - const command = new AddProfileKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a domain, which is a container for all customer data, such as customer profile - * attributes, object types, profile keys, and encryption keys. You can create multiple - * domains, and each domain can have multiple third-party integrations.

- *

Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can - * be associated with one domain.

- *

Use this API or UpdateDomain to - * enable identity - * resolution: set Matching to true.

- *

To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should - * apply.

+ * @see {@link CreateDomainCommand} */ - public createDomain( - args: CreateDomainCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createDomain(args: CreateDomainCommandInput, cb: (err: any, data?: CreateDomainCommandOutput) => void): void; - public createDomain( + createDomain(args: CreateDomainCommandInput, options?: __HttpHandlerOptions): Promise; + createDomain(args: CreateDomainCommandInput, cb: (err: any, data?: CreateDomainCommandOutput) => void): void; + createDomain( args: CreateDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDomainCommandOutput) => void ): void; - public createDomain( - args: CreateDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDomainCommandOutput) => void), - cb?: (err: any, data?: CreateDomainCommandOutput) => void - ): Promise | void { - const command = new CreateDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Creates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo. - *

+ * @see {@link CreateIntegrationWorkflowCommand} */ - public createIntegrationWorkflow( + createIntegrationWorkflow( args: CreateIntegrationWorkflowCommandInput, options?: __HttpHandlerOptions ): Promise; - public createIntegrationWorkflow( + createIntegrationWorkflow( args: CreateIntegrationWorkflowCommandInput, cb: (err: any, data?: CreateIntegrationWorkflowCommandOutput) => void ): void; - public createIntegrationWorkflow( + createIntegrationWorkflow( args: CreateIntegrationWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIntegrationWorkflowCommandOutput) => void ): void; - public createIntegrationWorkflow( - args: CreateIntegrationWorkflowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIntegrationWorkflowCommandOutput) => void), - cb?: (err: any, data?: CreateIntegrationWorkflowCommandOutput) => void - ): Promise | void { - const command = new CreateIntegrationWorkflowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a standard profile.

- *

A standard profile represents the following attributes for a customer profile in a - * domain.

+ * @see {@link CreateProfileCommand} */ - public createProfile( - args: CreateProfileCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createProfile( - args: CreateProfileCommandInput, - cb: (err: any, data?: CreateProfileCommandOutput) => void - ): void; - public createProfile( + createProfile(args: CreateProfileCommandInput, options?: __HttpHandlerOptions): Promise; + createProfile(args: CreateProfileCommandInput, cb: (err: any, data?: CreateProfileCommandOutput) => void): void; + createProfile( args: CreateProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProfileCommandOutput) => void ): void; - public createProfile( - args: CreateProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProfileCommandOutput) => void), - cb?: (err: any, data?: CreateProfileCommandOutput) => void - ): Promise | void { - const command = new CreateProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a specific domain and all of its customer data, such as customer profile - * attributes and their related objects.

+ * @see {@link DeleteDomainCommand} */ - public deleteDomain( - args: DeleteDomainCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDomain(args: DeleteDomainCommandInput, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void; - public deleteDomain( + deleteDomain(args: DeleteDomainCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDomain(args: DeleteDomainCommandInput, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void; + deleteDomain( args: DeleteDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDomainCommandOutput) => void ): void; - public deleteDomain( - args: DeleteDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDomainCommandOutput) => void), - cb?: (err: any, data?: DeleteDomainCommandOutput) => void - ): Promise | void { - const command = new DeleteDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes an integration from a specific domain.

+ * @see {@link DeleteIntegrationCommand} */ - public deleteIntegration( + deleteIntegration( args: DeleteIntegrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteIntegration( + deleteIntegration( args: DeleteIntegrationCommandInput, cb: (err: any, data?: DeleteIntegrationCommandOutput) => void ): void; - public deleteIntegration( + deleteIntegration( args: DeleteIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIntegrationCommandOutput) => void ): void; - public deleteIntegration( - args: DeleteIntegrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIntegrationCommandOutput) => void), - cb?: (err: any, data?: DeleteIntegrationCommandOutput) => void - ): Promise | void { - const command = new DeleteIntegrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the standard customer profile and all data pertaining to the profile.

+ * @see {@link DeleteProfileCommand} */ - public deleteProfile( - args: DeleteProfileCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteProfile( - args: DeleteProfileCommandInput, - cb: (err: any, data?: DeleteProfileCommandOutput) => void - ): void; - public deleteProfile( + deleteProfile(args: DeleteProfileCommandInput, options?: __HttpHandlerOptions): Promise; + deleteProfile(args: DeleteProfileCommandInput, cb: (err: any, data?: DeleteProfileCommandOutput) => void): void; + deleteProfile( args: DeleteProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProfileCommandOutput) => void ): void; - public deleteProfile( - args: DeleteProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a searchable key from a customer profile.

+ * @see {@link DeleteProfileKeyCommand} */ - public deleteProfileKey( + deleteProfileKey( args: DeleteProfileKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteProfileKey( + deleteProfileKey( args: DeleteProfileKeyCommandInput, cb: (err: any, data?: DeleteProfileKeyCommandOutput) => void ): void; - public deleteProfileKey( + deleteProfileKey( args: DeleteProfileKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProfileKeyCommandOutput) => void ): void; - public deleteProfileKey( - args: DeleteProfileKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProfileKeyCommandOutput) => void), - cb?: (err: any, data?: DeleteProfileKeyCommandOutput) => void - ): Promise | void { - const command = new DeleteProfileKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes an object associated with a profile of a given ProfileObjectType.

+ * @see {@link DeleteProfileObjectCommand} */ - public deleteProfileObject( + deleteProfileObject( args: DeleteProfileObjectCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteProfileObject( + deleteProfileObject( args: DeleteProfileObjectCommandInput, cb: (err: any, data?: DeleteProfileObjectCommandOutput) => void ): void; - public deleteProfileObject( + deleteProfileObject( args: DeleteProfileObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProfileObjectCommandOutput) => void ): void; - public deleteProfileObject( - args: DeleteProfileObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProfileObjectCommandOutput) => void), - cb?: (err: any, data?: DeleteProfileObjectCommandOutput) => void - ): Promise | void { - const command = new DeleteProfileObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a ProfileObjectType from a specific domain as well as removes all the - * ProfileObjects of that type. It also disables integrations from this specific - * ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that - * were populated from this ProfileObjectType.

+ * @see {@link DeleteProfileObjectTypeCommand} */ - public deleteProfileObjectType( + deleteProfileObjectType( args: DeleteProfileObjectTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteProfileObjectType( + deleteProfileObjectType( args: DeleteProfileObjectTypeCommandInput, cb: (err: any, data?: DeleteProfileObjectTypeCommandOutput) => void ): void; - public deleteProfileObjectType( + deleteProfileObjectType( args: DeleteProfileObjectTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProfileObjectTypeCommandOutput) => void ): void; - public deleteProfileObjectType( - args: DeleteProfileObjectTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProfileObjectTypeCommandOutput) => void), - cb?: (err: any, data?: DeleteProfileObjectTypeCommandOutput) => void - ): Promise | void { - const command = new DeleteProfileObjectTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified workflow and all its corresponding resources. This is an async process.

+ * @see {@link DeleteWorkflowCommand} */ - public deleteWorkflow( + deleteWorkflow( args: DeleteWorkflowCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWorkflow( - args: DeleteWorkflowCommandInput, - cb: (err: any, data?: DeleteWorkflowCommandOutput) => void - ): void; - public deleteWorkflow( + deleteWorkflow(args: DeleteWorkflowCommandInput, cb: (err: any, data?: DeleteWorkflowCommandOutput) => void): void; + deleteWorkflow( args: DeleteWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkflowCommandOutput) => void ): void; - public deleteWorkflow( - args: DeleteWorkflowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorkflowCommandOutput) => void), - cb?: (err: any, data?: DeleteWorkflowCommandOutput) => void - ): Promise | void { - const command = new DeleteWorkflowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly - * selects a sample of matching groups from the existing matching results, and applies the - * automerging settings that you provided. You can then view the number of profiles in the - * sample, the number of matches, and the number of profiles identified to be merged. This - * enables you to evaluate the accuracy of the attributes in your matching list.

- *

You can't view which profiles are matched and would be merged.

- * - *

We strongly recommend you use this API to do a dry run of the automerging process - * before running the Identity Resolution Job. Include at least two matching - * attributes. If your matching list includes too few attributes (such as only - * FirstName or only LastName), there may be a large number of - * matches. This increases the chances of erroneous merges.

- *
+ * @see {@link GetAutoMergingPreviewCommand} */ - public getAutoMergingPreview( + getAutoMergingPreview( args: GetAutoMergingPreviewCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAutoMergingPreview( + getAutoMergingPreview( args: GetAutoMergingPreviewCommandInput, cb: (err: any, data?: GetAutoMergingPreviewCommandOutput) => void ): void; - public getAutoMergingPreview( + getAutoMergingPreview( args: GetAutoMergingPreviewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAutoMergingPreviewCommandOutput) => void ): void; - public getAutoMergingPreview( - args: GetAutoMergingPreviewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAutoMergingPreviewCommandOutput) => void), - cb?: (err: any, data?: GetAutoMergingPreviewCommandOutput) => void - ): Promise | void { - const command = new GetAutoMergingPreviewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a specific domain.

+ * @see {@link GetDomainCommand} */ - public getDomain(args: GetDomainCommandInput, options?: __HttpHandlerOptions): Promise; - public getDomain(args: GetDomainCommandInput, cb: (err: any, data?: GetDomainCommandOutput) => void): void; - public getDomain( + getDomain(args: GetDomainCommandInput, options?: __HttpHandlerOptions): Promise; + getDomain(args: GetDomainCommandInput, cb: (err: any, data?: GetDomainCommandOutput) => void): void; + getDomain( args: GetDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDomainCommandOutput) => void ): void; - public getDomain( - args: GetDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDomainCommandOutput) => void), - cb?: (err: any, data?: GetDomainCommandOutput) => void - ): Promise | void { - const command = new GetDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about an Identity Resolution Job in a specific domain.

- *

Identity Resolution Jobs are set up using the Amazon Connect admin console. For more information, see Use - * Identity Resolution to consolidate similar profiles.

+ * @see {@link GetIdentityResolutionJobCommand} */ - public getIdentityResolutionJob( + getIdentityResolutionJob( args: GetIdentityResolutionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIdentityResolutionJob( + getIdentityResolutionJob( args: GetIdentityResolutionJobCommandInput, cb: (err: any, data?: GetIdentityResolutionJobCommandOutput) => void ): void; - public getIdentityResolutionJob( + getIdentityResolutionJob( args: GetIdentityResolutionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIdentityResolutionJobCommandOutput) => void ): void; - public getIdentityResolutionJob( - args: GetIdentityResolutionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIdentityResolutionJobCommandOutput) => void), - cb?: (err: any, data?: GetIdentityResolutionJobCommandOutput) => void - ): Promise | void { - const command = new GetIdentityResolutionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an integration for a domain.

+ * @see {@link GetIntegrationCommand} */ - public getIntegration( + getIntegration( args: GetIntegrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIntegration( - args: GetIntegrationCommandInput, - cb: (err: any, data?: GetIntegrationCommandOutput) => void - ): void; - public getIntegration( + getIntegration(args: GetIntegrationCommandInput, cb: (err: any, data?: GetIntegrationCommandOutput) => void): void; + getIntegration( args: GetIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIntegrationCommandOutput) => void ): void; - public getIntegration( - args: GetIntegrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIntegrationCommandOutput) => void), - cb?: (err: any, data?: GetIntegrationCommandOutput) => void - ): Promise | void { - const command = new GetIntegrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Before calling this API, use CreateDomain or - * UpdateDomain to - * enable identity resolution: set Matching to true.

- *

GetMatches returns potentially matching profiles, based on the results of the latest run - * of a machine learning process.

- * - *

The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly - * batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every - * Saturday at 12AM UTC to detect duplicate profiles in your domains.

- *

After the Identity Resolution Job completes, use the - * GetMatches - * API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from - * S3.

- *
- *

Amazon Connect uses the following profile attributes to identify matches:

- *
    - *
  • - *

    PhoneNumber

    - *
  • - *
  • - *

    HomePhoneNumber

    - *
  • - *
  • - *

    BusinessPhoneNumber

    - *
  • - *
  • - *

    MobilePhoneNumber

    - *
  • - *
  • - *

    EmailAddress

    - *
  • - *
  • - *

    PersonalEmailAddress

    - *
  • - *
  • - *

    BusinessEmailAddress

    - *
  • - *
  • - *

    FullName

    - *
  • - *
- *

For example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing - * email addresses such as JOHN_DOE@ANYCOMPANY.COM and - * johndoe@anycompany.com, or different phone number - * formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile.

+ * @see {@link GetMatchesCommand} */ - public getMatches(args: GetMatchesCommandInput, options?: __HttpHandlerOptions): Promise; - public getMatches(args: GetMatchesCommandInput, cb: (err: any, data?: GetMatchesCommandOutput) => void): void; - public getMatches( + getMatches(args: GetMatchesCommandInput, options?: __HttpHandlerOptions): Promise; + getMatches(args: GetMatchesCommandInput, cb: (err: any, data?: GetMatchesCommandOutput) => void): void; + getMatches( args: GetMatchesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMatchesCommandOutput) => void ): void; - public getMatches( - args: GetMatchesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMatchesCommandOutput) => void), - cb?: (err: any, data?: GetMatchesCommandOutput) => void - ): Promise | void { - const command = new GetMatchesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the object types for a specific domain.

+ * @see {@link GetProfileObjectTypeCommand} */ - public getProfileObjectType( + getProfileObjectType( args: GetProfileObjectTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public getProfileObjectType( + getProfileObjectType( args: GetProfileObjectTypeCommandInput, cb: (err: any, data?: GetProfileObjectTypeCommandOutput) => void ): void; - public getProfileObjectType( + getProfileObjectType( args: GetProfileObjectTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProfileObjectTypeCommandOutput) => void ): void; - public getProfileObjectType( - args: GetProfileObjectTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetProfileObjectTypeCommandOutput) => void), - cb?: (err: any, data?: GetProfileObjectTypeCommandOutput) => void - ): Promise | void { - const command = new GetProfileObjectTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the template information for a specific object type.

- *

A template is a predefined ProfileObjectType, such as “Salesforce-Account” or - * “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API, - * with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the - * template.

+ * @see {@link GetProfileObjectTypeTemplateCommand} */ - public getProfileObjectTypeTemplate( + getProfileObjectTypeTemplate( args: GetProfileObjectTypeTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getProfileObjectTypeTemplate( + getProfileObjectTypeTemplate( args: GetProfileObjectTypeTemplateCommandInput, cb: (err: any, data?: GetProfileObjectTypeTemplateCommandOutput) => void ): void; - public getProfileObjectTypeTemplate( + getProfileObjectTypeTemplate( args: GetProfileObjectTypeTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProfileObjectTypeTemplateCommandOutput) => void ): void; - public getProfileObjectTypeTemplate( - args: GetProfileObjectTypeTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetProfileObjectTypeTemplateCommandOutput) => void), - cb?: (err: any, data?: GetProfileObjectTypeTemplateCommandOutput) => void - ): Promise | void { - const command = new GetProfileObjectTypeTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get details of specified workflow.

+ * @see {@link GetWorkflowCommand} */ - public getWorkflow(args: GetWorkflowCommandInput, options?: __HttpHandlerOptions): Promise; - public getWorkflow(args: GetWorkflowCommandInput, cb: (err: any, data?: GetWorkflowCommandOutput) => void): void; - public getWorkflow( + getWorkflow(args: GetWorkflowCommandInput, options?: __HttpHandlerOptions): Promise; + getWorkflow(args: GetWorkflowCommandInput, cb: (err: any, data?: GetWorkflowCommandOutput) => void): void; + getWorkflow( args: GetWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkflowCommandOutput) => void ): void; - public getWorkflow( - args: GetWorkflowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkflowCommandOutput) => void), - cb?: (err: any, data?: GetWorkflowCommandOutput) => void - ): Promise | void { - const command = new GetWorkflowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get granular list of steps in workflow.

+ * @see {@link GetWorkflowStepsCommand} */ - public getWorkflowSteps( + getWorkflowSteps( args: GetWorkflowStepsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWorkflowSteps( + getWorkflowSteps( args: GetWorkflowStepsCommandInput, cb: (err: any, data?: GetWorkflowStepsCommandOutput) => void ): void; - public getWorkflowSteps( + getWorkflowSteps( args: GetWorkflowStepsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkflowStepsCommandOutput) => void ): void; - public getWorkflowSteps( - args: GetWorkflowStepsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkflowStepsCommandOutput) => void), - cb?: (err: any, data?: GetWorkflowStepsCommandOutput) => void - ): Promise | void { - const command = new GetWorkflowStepsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all of the integrations associated to a specific URI in the AWS account.

+ * @see {@link ListAccountIntegrationsCommand} */ - public listAccountIntegrations( + listAccountIntegrations( args: ListAccountIntegrationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAccountIntegrations( + listAccountIntegrations( args: ListAccountIntegrationsCommandInput, cb: (err: any, data?: ListAccountIntegrationsCommandOutput) => void ): void; - public listAccountIntegrations( + listAccountIntegrations( args: ListAccountIntegrationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccountIntegrationsCommandOutput) => void ): void; - public listAccountIntegrations( - args: ListAccountIntegrationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccountIntegrationsCommandOutput) => void), - cb?: (err: any, data?: ListAccountIntegrationsCommandOutput) => void - ): Promise | void { - const command = new ListAccountIntegrationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all the domains for an AWS account that have been created.

+ * @see {@link ListDomainsCommand} */ - public listDomains(args: ListDomainsCommandInput, options?: __HttpHandlerOptions): Promise; - public listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void; - public listDomains( + listDomains(args: ListDomainsCommandInput, options?: __HttpHandlerOptions): Promise; + listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void; + listDomains( args: ListDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainsCommandOutput) => void ): void; - public listDomains( - args: ListDomainsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDomainsCommandOutput) => void), - cb?: (err: any, data?: ListDomainsCommandOutput) => void - ): Promise | void { - const command = new ListDomainsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by - * JobStartTime.

+ * @see {@link ListIdentityResolutionJobsCommand} */ - public listIdentityResolutionJobs( + listIdentityResolutionJobs( args: ListIdentityResolutionJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listIdentityResolutionJobs( + listIdentityResolutionJobs( args: ListIdentityResolutionJobsCommandInput, cb: (err: any, data?: ListIdentityResolutionJobsCommandOutput) => void ): void; - public listIdentityResolutionJobs( + listIdentityResolutionJobs( args: ListIdentityResolutionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIdentityResolutionJobsCommandOutput) => void ): void; - public listIdentityResolutionJobs( - args: ListIdentityResolutionJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIdentityResolutionJobsCommandOutput) => void), - cb?: (err: any, data?: ListIdentityResolutionJobsCommandOutput) => void - ): Promise | void { - const command = new ListIdentityResolutionJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all of the integrations in your domain.

+ * @see {@link ListIntegrationsCommand} */ - public listIntegrations( + listIntegrations( args: ListIntegrationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listIntegrations( + listIntegrations( args: ListIntegrationsCommandInput, cb: (err: any, data?: ListIntegrationsCommandOutput) => void ): void; - public listIntegrations( + listIntegrations( args: ListIntegrationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIntegrationsCommandOutput) => void ): void; - public listIntegrations( - args: ListIntegrationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIntegrationsCommandOutput) => void), - cb?: (err: any, data?: ListIntegrationsCommandOutput) => void - ): Promise | void { - const command = new ListIntegrationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of objects associated with a profile of a given ProfileObjectType.

+ * @see {@link ListProfileObjectsCommand} */ - public listProfileObjects( + listProfileObjects( args: ListProfileObjectsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProfileObjects( + listProfileObjects( args: ListProfileObjectsCommandInput, cb: (err: any, data?: ListProfileObjectsCommandOutput) => void ): void; - public listProfileObjects( + listProfileObjects( args: ListProfileObjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProfileObjectsCommandOutput) => void ): void; - public listProfileObjects( - args: ListProfileObjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProfileObjectsCommandOutput) => void), - cb?: (err: any, data?: ListProfileObjectsCommandOutput) => void - ): Promise | void { - const command = new ListProfileObjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all of the templates available within the service.

+ * @see {@link ListProfileObjectTypesCommand} */ - public listProfileObjectTypes( + listProfileObjectTypes( args: ListProfileObjectTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProfileObjectTypes( + listProfileObjectTypes( args: ListProfileObjectTypesCommandInput, cb: (err: any, data?: ListProfileObjectTypesCommandOutput) => void ): void; - public listProfileObjectTypes( + listProfileObjectTypes( args: ListProfileObjectTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProfileObjectTypesCommandOutput) => void ): void; - public listProfileObjectTypes( - args: ListProfileObjectTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProfileObjectTypesCommandOutput) => void), - cb?: (err: any, data?: ListProfileObjectTypesCommandOutput) => void - ): Promise | void { - const command = new ListProfileObjectTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all of the template information for object types.

+ * @see {@link ListProfileObjectTypeTemplatesCommand} */ - public listProfileObjectTypeTemplates( + listProfileObjectTypeTemplates( args: ListProfileObjectTypeTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProfileObjectTypeTemplates( + listProfileObjectTypeTemplates( args: ListProfileObjectTypeTemplatesCommandInput, cb: (err: any, data?: ListProfileObjectTypeTemplatesCommandOutput) => void ): void; - public listProfileObjectTypeTemplates( + listProfileObjectTypeTemplates( args: ListProfileObjectTypeTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProfileObjectTypeTemplatesCommandOutput) => void ): void; - public listProfileObjectTypeTemplates( - args: ListProfileObjectTypeTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProfileObjectTypeTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListProfileObjectTypeTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListProfileObjectTypeTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect - * Customer Profiles, domains, profile object types, and integrations can be tagged.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Query to list all workflows.

+ * @see {@link ListWorkflowsCommand} */ - public listWorkflows( - args: ListWorkflowsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listWorkflows( - args: ListWorkflowsCommandInput, - cb: (err: any, data?: ListWorkflowsCommandOutput) => void - ): void; - public listWorkflows( + listWorkflows(args: ListWorkflowsCommandInput, options?: __HttpHandlerOptions): Promise; + listWorkflows(args: ListWorkflowsCommandInput, cb: (err: any, data?: ListWorkflowsCommandOutput) => void): void; + listWorkflows( args: ListWorkflowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkflowsCommandOutput) => void ): void; - public listWorkflows( - args: ListWorkflowsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkflowsCommandOutput) => void), - cb?: (err: any, data?: ListWorkflowsCommandOutput) => void - ): Promise | void { - const command = new ListWorkflowsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Runs an AWS Lambda job that does the following:

- *
    - *
  1. - *

    All the profileKeys in the ProfileToBeMerged will be moved to the - * main profile.

    - *
  2. - *
  3. - *

    All the objects in the ProfileToBeMerged will be moved to the main - * profile.

    - *
  4. - *
  5. - *

    All the ProfileToBeMerged will be deleted at the end.

    - *
  6. - *
  7. - *

    All the profileKeys in the ProfileIdsToBeMerged will be moved to the - * main profile.

    - *
  8. - *
  9. - *

    Standard fields are merged as follows:

    - *
      - *
    1. - *

      Fields are always "union"-ed if there are no conflicts in standard fields or - * attributeKeys.

      - *
    2. - *
    3. - *

      When there are conflicting fields:

      - *
        - *
      1. - *

        If no SourceProfileIds entry is specified, the main - * Profile value is always taken.

        - *
      2. - *
      3. - *

        If a SourceProfileIds entry is specified, the specified - * profileId is always taken, even if it is a NULL value.

        - *
      4. - *
      - *
    4. - *
    - *
  10. - *
- *

You can use MergeProfiles together with GetMatches, which - * returns potentially matching profiles, or use it with the results of another matching - * system. After profiles have been merged, they cannot be separated (unmerged).

+ * @see {@link MergeProfilesCommand} */ - public mergeProfiles( - args: MergeProfilesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public mergeProfiles( - args: MergeProfilesCommandInput, - cb: (err: any, data?: MergeProfilesCommandOutput) => void - ): void; - public mergeProfiles( + mergeProfiles(args: MergeProfilesCommandInput, options?: __HttpHandlerOptions): Promise; + mergeProfiles(args: MergeProfilesCommandInput, cb: (err: any, data?: MergeProfilesCommandOutput) => void): void; + mergeProfiles( args: MergeProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MergeProfilesCommandOutput) => void ): void; - public mergeProfiles( - args: MergeProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MergeProfilesCommandOutput) => void), - cb?: (err: any, data?: MergeProfilesCommandOutput) => void - ): Promise | void { - const command = new MergeProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds an integration between the service and a third-party service, which includes - * Amazon AppFlow and Amazon Connect.

- *

An integration can belong to only one domain.

- *

To add or remove tags on an existing Integration, see TagResource - * / - * UntagResource.

+ * @see {@link PutIntegrationCommand} */ - public putIntegration( + putIntegration( args: PutIntegrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putIntegration( - args: PutIntegrationCommandInput, - cb: (err: any, data?: PutIntegrationCommandOutput) => void - ): void; - public putIntegration( + putIntegration(args: PutIntegrationCommandInput, cb: (err: any, data?: PutIntegrationCommandOutput) => void): void; + putIntegration( args: PutIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutIntegrationCommandOutput) => void ): void; - public putIntegration( - args: PutIntegrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutIntegrationCommandOutput) => void), - cb?: (err: any, data?: PutIntegrationCommandOutput) => void - ): Promise | void { - const command = new PutIntegrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds additional objects to customer profiles of a given ObjectType.

- *

When adding a specific profile object, like a Contact Record, an inferred profile can - * get created if it is not mapped to an existing profile. The resulting profile will only - * have a phone number populated in the standard ProfileObject. Any additional Contact Records - * with the same phone number will be mapped to the same inferred profile.

- *

When a ProfileObject is created and if a ProfileObjectType already exists for the - * ProfileObject, it will provide data to a standard profile depending on the - * ProfileObjectType definition.

- *

PutProfileObject needs an ObjectType, which can be created using - * PutProfileObjectType.

+ * @see {@link PutProfileObjectCommand} */ - public putProfileObject( + putProfileObject( args: PutProfileObjectCommandInput, options?: __HttpHandlerOptions ): Promise; - public putProfileObject( + putProfileObject( args: PutProfileObjectCommandInput, cb: (err: any, data?: PutProfileObjectCommandOutput) => void ): void; - public putProfileObject( + putProfileObject( args: PutProfileObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutProfileObjectCommandOutput) => void ): void; - public putProfileObject( - args: PutProfileObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutProfileObjectCommandOutput) => void), - cb?: (err: any, data?: PutProfileObjectCommandOutput) => void - ): Promise | void { - const command = new PutProfileObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Defines a ProfileObjectType.

- *

To add or remove tags on an existing ObjectType, see - * TagResource/UntagResource.

+ * @see {@link PutProfileObjectTypeCommand} */ - public putProfileObjectType( + putProfileObjectType( args: PutProfileObjectTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public putProfileObjectType( + putProfileObjectType( args: PutProfileObjectTypeCommandInput, cb: (err: any, data?: PutProfileObjectTypeCommandOutput) => void ): void; - public putProfileObjectType( + putProfileObjectType( args: PutProfileObjectTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutProfileObjectTypeCommandOutput) => void ): void; - public putProfileObjectType( - args: PutProfileObjectTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutProfileObjectTypeCommandOutput) => void), - cb?: (err: any, data?: PutProfileObjectTypeCommandOutput) => void - ): Promise | void { - const command = new PutProfileObjectTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Searches for profiles within a specific domain using one or more predefined search keys - * (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys. A search key - * is a data type pair that consists of a KeyName and Values list.

- *

This operation supports searching for profiles with a minimum of 1 key-value(s) pair and up to - * 5 key-value(s) pairs using either AND or OR logic.

+ * @see {@link SearchProfilesCommand} */ - public searchProfiles( + searchProfiles( args: SearchProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchProfiles( - args: SearchProfilesCommandInput, - cb: (err: any, data?: SearchProfilesCommandOutput) => void - ): void; - public searchProfiles( + searchProfiles(args: SearchProfilesCommandInput, cb: (err: any, data?: SearchProfilesCommandOutput) => void): void; + searchProfiles( args: SearchProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchProfilesCommandOutput) => void ): void; - public searchProfiles( - args: SearchProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchProfilesCommandOutput) => void), - cb?: (err: any, data?: SearchProfilesCommandOutput) => void - ): Promise | void { - const command = new SearchProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles - * resource. Tags can help you organize and categorize your resources. You can also use them - * to scope user permissions by granting a user permission to access or change only resources - * with certain tag values. In Connect Customer Profiles, domains, profile object types, and - * integrations can be tagged.

- *

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of - * characters.

- *

You can use the TagResource action with a resource that already has tags. If you specify - * a new tag key, this tag is appended to the list of tags associated with the resource. If - * you specify a tag key that is already associated with the resource, the new tag value that - * you specify replaces the previous value for that tag.

- *

You can associate as many as 50 tags with a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from the specified Amazon Connect Customer Profiles resource. In Connect - * Customer Profiles, domains, profile object types, and integrations can be tagged.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the properties of a domain, including creating or selecting a dead letter queue - * or an encryption key.

- *

After a domain is created, the name can’t be changed.

- *

Use this API or CreateDomain to - * enable identity - * resolution: set Matching to true.

- *

To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should - * apply.

- *

To add or remove tags on an existing Domain, see TagResource/UntagResource.

+ * @see {@link UpdateDomainCommand} */ - public updateDomain( - args: UpdateDomainCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateDomain(args: UpdateDomainCommandInput, cb: (err: any, data?: UpdateDomainCommandOutput) => void): void; - public updateDomain( + updateDomain(args: UpdateDomainCommandInput, options?: __HttpHandlerOptions): Promise; + updateDomain(args: UpdateDomainCommandInput, cb: (err: any, data?: UpdateDomainCommandOutput) => void): void; + updateDomain( args: UpdateDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDomainCommandOutput) => void ): void; - public updateDomain( - args: UpdateDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDomainCommandOutput) => void), - cb?: (err: any, data?: UpdateDomainCommandOutput) => void - ): Promise | void { - const command = new UpdateDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the properties of a profile. The ProfileId is required for updating a customer - * profile.

- *

When calling the UpdateProfile API, specifying an empty string value means that any - * existing value will be removed. Not specifying a string value means that any value already - * there will be kept.

+ * @see {@link UpdateProfileCommand} */ - public updateProfile( - args: UpdateProfileCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateProfile( - args: UpdateProfileCommandInput, - cb: (err: any, data?: UpdateProfileCommandOutput) => void - ): void; - public updateProfile( + updateProfile(args: UpdateProfileCommandInput, options?: __HttpHandlerOptions): Promise; + updateProfile(args: UpdateProfileCommandInput, cb: (err: any, data?: UpdateProfileCommandOutput) => void): void; + updateProfile( args: UpdateProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProfileCommandOutput) => void ): void; - public updateProfile( - args: UpdateProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProfileCommandOutput) => void), - cb?: (err: any, data?: UpdateProfileCommandOutput) => void - ): Promise | void { - const command = new UpdateProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Connect Customer Profiles + *

Amazon Connect Customer Profiles is a unified customer profile for your contact center that has + * pre-built connectors powered by AppFlow that make it easy to combine customer information + * from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your + * enterprise resource planning (ERP), with contact history from your Amazon Connect contact center. + * If you're new to Amazon Connect, you might find it helpful to review the Amazon Connect Administrator Guide.

+ */ +export class CustomerProfiles extends CustomerProfilesClient implements CustomerProfiles {} +createAggregatedClient(commands, CustomerProfiles); diff --git a/clients/client-data-pipeline/src/DataPipeline.ts b/clients/client-data-pipeline/src/DataPipeline.ts index b04f81bc63c5..c962fc361222 100644 --- a/clients/client-data-pipeline/src/DataPipeline.ts +++ b/clients/client-data-pipeline/src/DataPipeline.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -80,1521 +81,323 @@ import { ValidatePipelineDefinitionCommandInput, ValidatePipelineDefinitionCommandOutput, } from "./commands/ValidatePipelineDefinitionCommand"; -import { DataPipelineClient } from "./DataPipelineClient"; +import { DataPipelineClient, DataPipelineClientConfig } from "./DataPipelineClient"; -/** - * @public - *

AWS Data Pipeline configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline - * handles the details of scheduling and ensuring that data dependencies are met so that your application - * can focus on processing the data.

- * - *

AWS Data Pipeline provides a JAR implementation of a task runner called AWS Data Pipeline Task Runner. - * AWS Data Pipeline Task Runner provides logic for common data management scenarios, such as performing - * database queries and running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use - * AWS Data Pipeline Task Runner as your task runner, or you can write your own task runner to provide - * custom data management.

- * - *

AWS Data Pipeline implements two main sets of functionality. Use the first set to create a pipeline - * and define data sources, schedules, dependencies, and the transforms to be performed on the data. - * Use the second set in your task runner application to receive the next task ready for processing. - * The logic for performing the task, such as querying the data, running data analysis, or converting - * the data from one format to another, is contained within the task runner. The task runner performs - * the task assigned to it by the web service, reporting progress to the web service as it does so. - * When the task is done, the task runner reports the final success or failure of the task to the web service.

- */ -export class DataPipeline extends DataPipelineClient { +const commands = { + ActivatePipelineCommand, + AddTagsCommand, + CreatePipelineCommand, + DeactivatePipelineCommand, + DeletePipelineCommand, + DescribeObjectsCommand, + DescribePipelinesCommand, + EvaluateExpressionCommand, + GetPipelineDefinitionCommand, + ListPipelinesCommand, + PollForTaskCommand, + PutPipelineDefinitionCommand, + QueryObjectsCommand, + RemoveTagsCommand, + ReportTaskProgressCommand, + ReportTaskRunnerHeartbeatCommand, + SetStatusCommand, + SetTaskStatusCommand, + ValidatePipelineDefinitionCommand, +}; + +export interface DataPipeline { /** - * @public - *

Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, - * activation fails.

- *

If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, - * call DeactivatePipeline.

- *

To activate a finished pipeline, modify the end date for the pipeline and then activate it.

- * - * - * - * POST / HTTP/1.1 - * Content-Type: application/x-amz-json-1.1 - * X-Amz-Target: DataPipeline.ActivatePipeline - * Content-Length: 39 - * Host: datapipeline.us-east-1.amazonaws.com - * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT - * Authorization: AuthParams - * - * \{"pipelineId": "df-06372391ZG65EXAMPLE"\} - * - * - * - * - * HTTP/1.1 200 - * x-amzn-RequestId: ee19d5bf-074e-11e2-af6f-6bc7a6be60d9 - * Content-Type: application/x-amz-json-1.1 - * Content-Length: 2 - * Date: Mon, 12 Nov 2012 17:50:53 GMT - * - * \{\} - * - * - * + * @see {@link ActivatePipelineCommand} */ - public activatePipeline( + activatePipeline( args: ActivatePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public activatePipeline( + activatePipeline( args: ActivatePipelineCommandInput, cb: (err: any, data?: ActivatePipelineCommandOutput) => void ): void; - public activatePipeline( + activatePipeline( args: ActivatePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ActivatePipelineCommandOutput) => void ): void; - public activatePipeline( - args: ActivatePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ActivatePipelineCommandOutput) => void), - cb?: (err: any, data?: ActivatePipelineCommandOutput) => void - ): Promise | void { - const command = new ActivatePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or modifies tags for the specified pipeline.

+ * @see {@link AddTagsCommand} */ - public addTags(args: AddTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public addTags(args: AddTagsCommandInput, cb: (err: any, data?: AddTagsCommandOutput) => void): void; - public addTags( + addTags(args: AddTagsCommandInput, options?: __HttpHandlerOptions): Promise; + addTags(args: AddTagsCommandInput, cb: (err: any, data?: AddTagsCommandOutput) => void): void; + addTags( args: AddTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsCommandOutput) => void ): void; - public addTags( - args: AddTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddTagsCommandOutput) => void), - cb?: (err: any, data?: AddTagsCommandOutput) => void - ): Promise | void { - const command = new AddTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.

- * - * - * - * - * POST / HTTP/1.1 - * Content-Type: application/x-amz-json-1.1 - * X-Amz-Target: DataPipeline.CreatePipeline - * Content-Length: 91 - * Host: datapipeline.us-east-1.amazonaws.com - * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT - * Authorization: AuthParams - * - * \{"name": "myPipeline", - * "uniqueId": "123456789", - * "description": "This is my first pipeline"\} - * - * - * - * - * - * HTTP/1.1 200 - * x-amzn-RequestId: b16911ce-0774-11e2-af6f-6bc7a6be60d9 - * Content-Type: application/x-amz-json-1.1 - * Content-Length: 40 - * Date: Mon, 12 Nov 2012 17:50:53 GMT - * - * \{"pipelineId": "df-06372391ZG65EXAMPLE"\} - * - * - * + * @see {@link CreatePipelineCommand} */ - public createPipeline( + createPipeline( args: CreatePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPipeline( - args: CreatePipelineCommandInput, - cb: (err: any, data?: CreatePipelineCommandOutput) => void - ): void; - public createPipeline( + createPipeline(args: CreatePipelineCommandInput, cb: (err: any, data?: CreatePipelineCommandOutput) => void): void; + createPipeline( args: CreatePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePipelineCommandOutput) => void ): void; - public createPipeline( - args: CreatePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePipelineCommandOutput) => void), - cb?: (err: any, data?: CreatePipelineCommandOutput) => void - ): Promise | void { - const command = new CreatePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING - * state until the deactivation process completes.

- *

To resume a deactivated pipeline, use ActivatePipeline. By default, the pipeline resumes from the last completed execution. - * Optionally, you can specify the date and time to resume the pipeline.

+ * @see {@link DeactivatePipelineCommand} */ - public deactivatePipeline( + deactivatePipeline( args: DeactivatePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public deactivatePipeline( + deactivatePipeline( args: DeactivatePipelineCommandInput, cb: (err: any, data?: DeactivatePipelineCommandOutput) => void ): void; - public deactivatePipeline( + deactivatePipeline( args: DeactivatePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeactivatePipelineCommandOutput) => void ): void; - public deactivatePipeline( - args: DeactivatePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeactivatePipelineCommandOutput) => void), - cb?: (err: any, data?: DeactivatePipelineCommandOutput) => void - ): Promise | void { - const command = new DeactivatePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a pipeline, its pipeline definition, and its run history. - * AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners.

- *

Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. - * To temporarily pause a pipeline instead of deleting it, call SetStatus with the status set to PAUSE on individual components. - * Components that are paused by SetStatus can be resumed.

- * - * - * - * - * POST / HTTP/1.1 - * Content-Type: application/x-amz-json-1.1 - * X-Amz-Target: DataPipeline.DeletePipeline - * Content-Length: 50 - * Host: datapipeline.us-east-1.amazonaws.com - * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT - * Authorization: AuthParams - * - * \{"pipelineId": "df-06372391ZG65EXAMPLE"\} - * - * - * - * - * - * x-amzn-RequestId: b7a88c81-0754-11e2-af6f-6bc7a6be60d9 - * Content-Type: application/x-amz-json-1.1 - * Content-Length: 0 - * Date: Mon, 12 Nov 2012 17:50:53 GMT - * - * Unexpected response: 200, OK, undefined - * - * - * + * @see {@link DeletePipelineCommand} */ - public deletePipeline( + deletePipeline( args: DeletePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePipeline( - args: DeletePipelineCommandInput, - cb: (err: any, data?: DeletePipelineCommandOutput) => void - ): void; - public deletePipeline( + deletePipeline(args: DeletePipelineCommandInput, cb: (err: any, data?: DeletePipelineCommandOutput) => void): void; + deletePipeline( args: DeletePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePipelineCommandOutput) => void ): void; - public deletePipeline( - args: DeletePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePipelineCommandOutput) => void), - cb?: (err: any, data?: DeletePipelineCommandOutput) => void - ): Promise | void { - const command = new DeletePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of - * a set of fields that define the properties of the object.

- * - * - * - * - * POST / HTTP/1.1 - * Content-Type: application/x-amz-json-1.1 - * X-Amz-Target: DataPipeline.DescribeObjects - * Content-Length: 98 - * Host: datapipeline.us-east-1.amazonaws.com - * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT - * Authorization: AuthParams - * - * \{"pipelineId": "df-06372391ZG65EXAMPLE", - * "objectIds": - * ["Schedule"], - * "evaluateExpressions": true\} - * - * - * - * - * - * x-amzn-RequestId: 4c18ea5d-0777-11e2-8a14-21bb8a1f50ef - * Content-Type: application/x-amz-json-1.1 - * Content-Length: 1488 - * Date: Mon, 12 Nov 2012 17:50:53 GMT - * - * \{"hasMoreResults": false, - * "pipelineObjects": - * [ - * \{"fields": - * [ - * \{"key": "startDateTime", - * "stringValue": "2012-12-12T00:00:00"\}, - * \{"key": "parent", - * "refValue": "Default"\}, - * \{"key": "@sphere", - * "stringValue": "COMPONENT"\}, - * \{"key": "type", - * "stringValue": "Schedule"\}, - * \{"key": "period", - * "stringValue": "1 hour"\}, - * \{"key": "endDateTime", - * "stringValue": "2012-12-21T18:00:00"\}, - * \{"key": "@version", - * "stringValue": "1"\}, - * \{"key": "@status", - * "stringValue": "PENDING"\}, - * \{"key": "@pipelineId", - * "stringValue": "df-06372391ZG65EXAMPLE"\} - * ], - * "id": "Schedule", - * "name": "Schedule"\} - * ] - * \} - * - * - * + * @see {@link DescribeObjectsCommand} */ - public describeObjects( + describeObjects( args: DescribeObjectsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeObjects( - args: DescribeObjectsCommandInput, - cb: (err: any, data?: DescribeObjectsCommandOutput) => void - ): void; - public describeObjects( + describeObjects(args: DescribeObjectsCommandInput, cb: (err: any, data?: DescribeObjectsCommandOutput) => void): void; + describeObjects( args: DescribeObjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeObjectsCommandOutput) => void ): void; - public describeObjects( - args: DescribeObjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeObjectsCommandOutput) => void), - cb?: (err: any, data?: DescribeObjectsCommandOutput) => void - ): Promise | void { - const command = new DescribeObjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, - * its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines - * that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines - * for which you have read permissions.

- *

To retrieve the full pipeline definition instead of metadata about the pipeline, call GetPipelineDefinition.

- * - * - * - * - * POST / HTTP/1.1 - * Content-Type: application/x-amz-json-1.1 - * X-Amz-Target: DataPipeline.DescribePipelines - * Content-Length: 70 - * Host: datapipeline.us-east-1.amazonaws.com - * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT - * Authorization: AuthParams - * - * \{"pipelineIds": - * ["df-08785951KAKJEXAMPLE"] - * \} - * - * - * - * - * - * x-amzn-RequestId: 02870eb7-0736-11e2-af6f-6bc7a6be60d9 - * Content-Type: application/x-amz-json-1.1 - * Content-Length: 767 - * Date: Mon, 12 Nov 2012 17:50:53 GMT - * - * \{"pipelineDescriptionList": - * [ - * \{"description": "This is my first pipeline", - * "fields": - * [ - * \{"key": "@pipelineState", - * "stringValue": "SCHEDULED"\}, - * \{"key": "description", - * "stringValue": "This is my first pipeline"\}, - * \{"key": "name", - * "stringValue": "myPipeline"\}, - * \{"key": "@creationTime", - * "stringValue": "2012-12-13T01:24:06"\}, - * \{"key": "@id", - * "stringValue": "df-0937003356ZJEXAMPLE"\}, - * \{"key": "@sphere", - * "stringValue": "PIPELINE"\}, - * \{"key": "@version", - * "stringValue": "1"\}, - * \{"key": "@userId", - * "stringValue": "924374875933"\}, - * \{"key": "@accountId", - * "stringValue": "924374875933"\}, - * \{"key": "uniqueId", - * "stringValue": "1234567890"\} - * ], - * "name": "myPipeline", - * "pipelineId": "df-0937003356ZJEXAMPLE"\} - * ] - * \} - * - * + * @see {@link DescribePipelinesCommand} */ - public describePipelines( + describePipelines( args: DescribePipelinesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePipelines( + describePipelines( args: DescribePipelinesCommandInput, cb: (err: any, data?: DescribePipelinesCommandOutput) => void ): void; - public describePipelines( + describePipelines( args: DescribePipelinesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePipelinesCommandOutput) => void ): void; - public describePipelines( - args: DescribePipelinesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePipelinesCommandOutput) => void), - cb?: (err: any, data?: DescribePipelinesCommandOutput) => void - ): Promise | void { - const command = new DescribePipelinesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Task runners call EvaluateExpression to evaluate a string in the context of the specified object. - * For example, a task runner can evaluate SQL queries stored in Amazon S3.

- * - * - * - * - * POST / HTTP/1.1 - * Content-Type: application/x-amz-json-1.1 - * X-Amz-Target: DataPipeline.DescribePipelines - * Content-Length: 164 - * Host: datapipeline.us-east-1.amazonaws.com - * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT - * Authorization: AuthParams - * - * \{"pipelineId": "df-08785951KAKJEXAMPLE", - * "objectId": "Schedule", - * "expression": "Transform started at #\{startDateTime\} and finished at #\{endDateTime\}"\} - * - * - * - * - * - * - * x-amzn-RequestId: 02870eb7-0736-11e2-af6f-6bc7a6be60d9 - * Content-Type: application/x-amz-json-1.1 - * Content-Length: 103 - * Date: Mon, 12 Nov 2012 17:50:53 GMT - * - * \{"evaluatedExpression": "Transform started at 2012-12-12T00:00:00 and finished at 2012-12-21T18:00:00"\} - * - * + * @see {@link EvaluateExpressionCommand} */ - public evaluateExpression( + evaluateExpression( args: EvaluateExpressionCommandInput, options?: __HttpHandlerOptions ): Promise; - public evaluateExpression( + evaluateExpression( args: EvaluateExpressionCommandInput, cb: (err: any, data?: EvaluateExpressionCommandOutput) => void ): void; - public evaluateExpression( + evaluateExpression( args: EvaluateExpressionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EvaluateExpressionCommandOutput) => void ): void; - public evaluateExpression( - args: EvaluateExpressionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EvaluateExpressionCommandOutput) => void), - cb?: (err: any, data?: EvaluateExpressionCommandOutput) => void - ): Promise | void { - const command = new EvaluateExpressionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve - * the pipeline definition that you provided using PutPipelineDefinition.

- * - * - * - * - * POST / HTTP/1.1 - * Content-Type: application/x-amz-json-1.1 - * X-Amz-Target: DataPipeline.GetPipelineDefinition - * Content-Length: 40 - * Host: datapipeline.us-east-1.amazonaws.com - * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT - * Authorization: AuthParams - * - * - * \{"pipelineId": "df-06372391ZG65EXAMPLE"\} - * - * - * - * - * x-amzn-RequestId: e28309e5-0776-11e2-8a14-21bb8a1f50ef - * Content-Type: application/x-amz-json-1.1 - * Content-Length: 890 - * Date: Mon, 12 Nov 2012 17:50:53 GMT - * - * \{"pipelineObjects": - * [ - * \{"fields": - * [ - * \{"key": "workerGroup", - * "stringValue": "workerGroup"\} - * ], - * "id": "Default", - * "name": "Default"\}, - * \{"fields": - * [ - * \{"key": "startDateTime", - * "stringValue": "2012-09-25T17:00:00"\}, - * \{"key": "type", - * "stringValue": "Schedule"\}, - * \{"key": "period", - * "stringValue": "1 hour"\}, - * \{"key": "endDateTime", - * "stringValue": "2012-09-25T18:00:00"\} - * ], - * "id": "Schedule", - * "name": "Schedule"\}, - * \{"fields": - * [ - * \{"key": "schedule", - * "refValue": "Schedule"\}, - * \{"key": "command", - * "stringValue": "echo hello"\}, - * \{"key": "parent", - * "refValue": "Default"\}, - * \{"key": "type", - * "stringValue": "ShellCommandActivity"\} - * ], - * "id": "SayHello", - * "name": "SayHello"\} - * ] - * \} - * - * - * + * @see {@link GetPipelineDefinitionCommand} */ - public getPipelineDefinition( + getPipelineDefinition( args: GetPipelineDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPipelineDefinition( + getPipelineDefinition( args: GetPipelineDefinitionCommandInput, cb: (err: any, data?: GetPipelineDefinitionCommandOutput) => void ): void; - public getPipelineDefinition( + getPipelineDefinition( args: GetPipelineDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPipelineDefinitionCommandOutput) => void ): void; - public getPipelineDefinition( - args: GetPipelineDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPipelineDefinitionCommandOutput) => void), - cb?: (err: any, data?: GetPipelineDefinitionCommandOutput) => void - ): Promise | void { - const command = new GetPipelineDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the pipeline identifiers for all active pipelines that you have permission to access.

- * - * - * - * - * POST / HTTP/1.1 - * Content-Type: application/x-amz-json-1.1 - * X-Amz-Target: DataPipeline.ListPipelines - * Content-Length: 14 - * Host: datapipeline.us-east-1.amazonaws.com - * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT - * Authorization: AuthParams - * - * \{\} - * - * - * - * Status: - * x-amzn-RequestId: b3104dc5-0734-11e2-af6f-6bc7a6be60d9 - * Content-Type: application/x-amz-json-1.1 - * Content-Length: 39 - * Date: Mon, 12 Nov 2012 17:50:53 GMT - * - * \{"PipelineIdList": - * [ - * \{"id": "df-08785951KAKJEXAMPLE", - * "name": "MyPipeline"\}, - * \{"id": "df-08662578ISYEXAMPLE", - * "name": "MySecondPipeline"\} - * ] - * \} - * + * @see {@link ListPipelinesCommand} */ - public listPipelines( - args: ListPipelinesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listPipelines( - args: ListPipelinesCommandInput, - cb: (err: any, data?: ListPipelinesCommandOutput) => void - ): void; - public listPipelines( + listPipelines(args: ListPipelinesCommandInput, options?: __HttpHandlerOptions): Promise; + listPipelines(args: ListPipelinesCommandInput, cb: (err: any, data?: ListPipelinesCommandOutput) => void): void; + listPipelines( args: ListPipelinesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPipelinesCommandOutput) => void ): void; - public listPipelines( - args: ListPipelinesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPipelinesCommandOutput) => void), - cb?: (err: any, data?: ListPipelinesCommandOutput) => void - ): Promise | void { - const command = new ListPipelinesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Task runners call PollForTask to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform - * by setting a value for the workerGroup parameter. The task returned can come from any of the pipelines that - * match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials - * specified by the task runner.

- *

If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are available in the queue, - * PollForTask uses long-polling and holds on to a poll connection for up to a 90 seconds, during which time the first newly - * scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task - * runner should not call PollForTask again on the same workerGroup until it receives a response, and this can take up to 90 seconds. - *

- * - * - * - * - * POST / HTTP/1.1 - * Content-Type: application/x-amz-json-1.1 - * X-Amz-Target: DataPipeline.PollForTask - * Content-Length: 59 - * Host: datapipeline.us-east-1.amazonaws.com - * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT - * Authorization: AuthParams - * - * \{"workerGroup": "MyworkerGroup", - * "hostname": "example.com"\} - * - * - * - * - * - * x-amzn-RequestId: 41c713d2-0775-11e2-af6f-6bc7a6be60d9 - * Content-Type: application/x-amz-json-1.1 - * Content-Length: 39 - * Date: Mon, 12 Nov 2012 17:50:53 GMT - * - * \{"taskObject": - * \{"attemptId": "@SayHello_2012-12-12T00:00:00_Attempt=1", - * "objects": - * \{"@SayHello_2012-12-12T00:00:00_Attempt=1": - * \{"fields": - * [ - * \{"key": "@componentParent", - * "refValue": "SayHello"\}, - * \{"key": "@scheduledStartTime", - * "stringValue": "2012-12-12T00:00:00"\}, - * \{"key": "parent", - * "refValue": "SayHello"\}, - * \{"key": "@sphere", - * "stringValue": "ATTEMPT"\}, - * \{"key": "workerGroup", - * "stringValue": "workerGroup"\}, - * \{"key": "@instanceParent", - * "refValue": "@SayHello_2012-12-12T00:00:00"\}, - * \{"key": "type", - * "stringValue": "ShellCommandActivity"\}, - * \{"key": "@status", - * "stringValue": "WAITING_FOR_RUNNER"\}, - * \{"key": "@version", - * "stringValue": "1"\}, - * \{"key": "schedule", - * "refValue": "Schedule"\}, - * \{"key": "@actualStartTime", - * "stringValue": "2012-12-13T01:40:50"\}, - * \{"key": "command", - * "stringValue": "echo hello"\}, - * \{"key": "@scheduledEndTime", - * "stringValue": "2012-12-12T01:00:00"\}, - * \{"key": "@activeInstances", - * "refValue": "@SayHello_2012-12-12T00:00:00"\}, - * \{"key": "@pipelineId", - * "stringValue": "df-0937003356ZJEXAMPLE"\} - * ], - * "id": "@SayHello_2012-12-12T00:00:00_Attempt=1", - * "name": "@SayHello_2012-12-12T00:00:00_Attempt=1"\} - * \}, - * "pipelineId": "df-0937003356ZJEXAMPLE", - * "taskId": "2xaM4wRs5zOsIH+g9U3oVHfAgAlbSqU6XduncB0HhZ3xMnmvfePZPn4dIbYXHyWyRK+cU15MqDHwdrvftx/4wv+sNS4w34vJfv7QA9aOoOazW28l1GYSb2ZRR0N0paiQp+d1MhSKo10hOTWOsVK5S5Lnx9Qm6omFgXHyIvZRIvTlrQMpr1xuUrflyGOfbFOGpOLpvPE172MYdqpZKnbSS4TcuqgQKSWV2833fEubI57DPOP7ghWa2TcYeSIv4pdLYG53fTuwfbnbdc98g2LNUQzSVhSnt7BoqyNwht2aQ6b/UHg9A80+KVpuXuqmz3m1MXwHFgxjdmuesXNOrrlGpeLCcRWD+aGo0RN1NqhQRzNAig8V4GlaPTQzMsRCljKqvrIyAoP3Tt2XEGsHkkQo12rEX8Z90957XX2qKRwhruwYzqGkSLWjINoLdAxUJdpRXRc5DJTrBd3D5mdzn7kY1l7NEh4kFHJDt3Cx4Z3Mk8MYCACyCk/CEyy9DwuPi66cLz0NBcgbCM5LKjTBOwo1m+am+pvM1kSposE9FPP1+RFGb8k6jQBTJx3TRz1yKilnGXQTZ5xvdOFpJrklIT0OXP1MG3+auM9FlJA+1dX90QoNJE5z7axmK//MOGXUdkqFe2kiDkorqjxwDvc0Js9pVKfKvAmW8YqUbmI9l0ERpWCXXnLVHNmPWz3jaPY+OBAmuJWDmxB/Z8p94aEDg4BVXQ7LvsKQ3DLYhaB7yJ390CJT+i0mm+EBqY60V6YikPSWDFrYQ/NPi2b1DgE19mX8zHqw8qprIl4yh1Ckx2Iige4En/N5ktOoIxnASxAw/TzcE2skxdw5KlHDF+UTj71m16CR/dIaKlXijlfNlNzUBo/bNSadCQn3G5NoO501wPKI:XO50TgDNyo8EXAMPLE/g==:1"\} - * \} - * - * - * + * @see {@link PollForTaskCommand} */ - public pollForTask(args: PollForTaskCommandInput, options?: __HttpHandlerOptions): Promise; - public pollForTask(args: PollForTaskCommandInput, cb: (err: any, data?: PollForTaskCommandOutput) => void): void; - public pollForTask( + pollForTask(args: PollForTaskCommandInput, options?: __HttpHandlerOptions): Promise; + pollForTask(args: PollForTaskCommandInput, cb: (err: any, data?: PollForTaskCommandOutput) => void): void; + pollForTask( args: PollForTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PollForTaskCommandOutput) => void ): void; - public pollForTask( - args: PollForTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PollForTaskCommandOutput) => void), - cb?: (err: any, data?: PollForTaskCommandOutput) => void - ): Promise | void { - const command = new PollForTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline.

- *

- * PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one - * of the following three validation errors exists in the pipeline. - *

- *
    - *
  1. An object is missing a name or identifier field.
  2. - *
  3. A string or reference field is empty.
  4. - *
  5. The number of objects in the pipeline exceeds the maximum allowed objects.
  6. - *
  7. The pipeline is in a FINISHED state.
  8. - *
- *

- * Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action. - *

- * - * - * Example 1 - * - * This example sets an valid pipeline configuration and returns success. - * - * - * - * POST / HTTP/1.1 - * Content-Type: application/x-amz-json-1.1 - * X-Amz-Target: DataPipeline.PutPipelineDefinition - * Content-Length: 914 - * Host: datapipeline.us-east-1.amazonaws.com - * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT - * Authorization: AuthParams - * - * \{"pipelineId": "df-0937003356ZJEXAMPLE", - * "pipelineObjects": - * [ - * \{"id": "Default", - * "name": "Default", - * "fields": - * [ - * \{"key": "workerGroup", - * "stringValue": "workerGroup"\} - * ] - * \}, - * \{"id": "Schedule", - * "name": "Schedule", - * "fields": - * [ - * \{"key": "startDateTime", - * "stringValue": "2012-12-12T00:00:00"\}, - * \{"key": "type", - * "stringValue": "Schedule"\}, - * \{"key": "period", - * "stringValue": "1 hour"\}, - * \{"key": "endDateTime", - * "stringValue": "2012-12-21T18:00:00"\} - * ] - * \}, - * \{"id": "SayHello", - * "name": "SayHello", - * "fields": - * [ - * \{"key": "type", - * "stringValue": "ShellCommandActivity"\}, - * \{"key": "command", - * "stringValue": "echo hello"\}, - * \{"key": "parent", - * "refValue": "Default"\}, - * \{"key": "schedule", - * "refValue": "Schedule"\} - * ] - * \} - * ] - * \} - * - * - * - * - * HTTP/1.1 200 - * x-amzn-RequestId: f74afc14-0754-11e2-af6f-6bc7a6be60d9 - * Content-Type: application/x-amz-json-1.1 - * Content-Length: 18 - * Date: Mon, 12 Nov 2012 17:50:53 GMT - * - * \{"errored": false\} - * - * - * - * - * - * Example 2 - * - * This example sets an invalid pipeline configuration (the value for workerGroup is an empty string) and returns an error message. - * - * - * - * POST / HTTP/1.1 - * Content-Type: application/x-amz-json-1.1 - * X-Amz-Target: DataPipeline.PutPipelineDefinition - * Content-Length: 903 - * Host: datapipeline.us-east-1.amazonaws.com - * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT - * Authorization: AuthParams - * - * \{"pipelineId": "df-06372391ZG65EXAMPLE", - * "pipelineObjects": - * [ - * \{"id": "Default", - * "name": "Default", - * "fields": - * [ - * \{"key": "workerGroup", - * "stringValue": ""\} - * ] - * \}, - * \{"id": "Schedule", - * "name": "Schedule", - * "fields": - * [ - * \{"key": "startDateTime", - * "stringValue": "2012-09-25T17:00:00"\}, - * \{"key": "type", - * "stringValue": "Schedule"\}, - * \{"key": "period", - * "stringValue": "1 hour"\}, - * \{"key": "endDateTime", - * "stringValue": "2012-09-25T18:00:00"\} - * ] - * \}, - * \{"id": "SayHello", - * "name": "SayHello", - * "fields": - * [ - * \{"key": "type", - * "stringValue": "ShellCommandActivity"\}, - * \{"key": "command", - * "stringValue": "echo hello"\}, - * \{"key": "parent", - * "refValue": "Default"\}, - * \{"key": "schedule", - * "refValue": "Schedule"\} - * - * ] - * \} - * ] - * \} - * - * - * - * - * HTTP/1.1 200 - * x-amzn-RequestId: f74afc14-0754-11e2-af6f-6bc7a6be60d9 - * Content-Type: application/x-amz-json-1.1 - * Content-Length: 18 - * Date: Mon, 12 Nov 2012 17:50:53 GMT - * - * \{"__type": "com.amazon.setl.webservice#InvalidRequestException", - * "message": "Pipeline definition has errors: Could not save the pipeline definition due to FATAL errors: [com.amazon.setl.webservice.ValidationError@108d7ea9] Please call Validate to validate your pipeline"\} - * - * - * - * - * + * @see {@link PutPipelineDefinitionCommand} */ - public putPipelineDefinition( + putPipelineDefinition( args: PutPipelineDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public putPipelineDefinition( + putPipelineDefinition( args: PutPipelineDefinitionCommandInput, cb: (err: any, data?: PutPipelineDefinitionCommandOutput) => void ): void; - public putPipelineDefinition( + putPipelineDefinition( args: PutPipelineDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPipelineDefinitionCommandOutput) => void ): void; - public putPipelineDefinition( - args: PutPipelineDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutPipelineDefinitionCommandOutput) => void), - cb?: (err: any, data?: PutPipelineDefinitionCommandOutput) => void - ): Promise | void { - const command = new PutPipelineDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Queries the specified pipeline for the names of objects that match the specified set of conditions.

- * - * - * - * - * POST / HTTP/1.1 - * Content-Type: application/x-amz-json-1.1 - * X-Amz-Target: DataPipeline.QueryObjects - * Content-Length: 123 - * Host: datapipeline.us-east-1.amazonaws.com - * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT - * Authorization: AuthParams - * - * \{"pipelineId": "df-06372391ZG65EXAMPLE", - * "query": - * \{"selectors": - * [ - * ] - * \}, - * "sphere": "INSTANCE", - * "marker": "", - * "limit": 10\} - * - * - * - * - * - * - * x-amzn-RequestId: 14d704c1-0775-11e2-af6f-6bc7a6be60d9 - * Content-Type: application/x-amz-json-1.1 - * Content-Length: 72 - * Date: Mon, 12 Nov 2012 17:50:53 GMT - * - * \{"hasMoreResults": false, - * "ids": - * ["@SayHello_1_2012-09-25T17:00:00"] - * \} - * - * + * @see {@link QueryObjectsCommand} */ - public queryObjects( - args: QueryObjectsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public queryObjects(args: QueryObjectsCommandInput, cb: (err: any, data?: QueryObjectsCommandOutput) => void): void; - public queryObjects( + queryObjects(args: QueryObjectsCommandInput, options?: __HttpHandlerOptions): Promise; + queryObjects(args: QueryObjectsCommandInput, cb: (err: any, data?: QueryObjectsCommandOutput) => void): void; + queryObjects( args: QueryObjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryObjectsCommandOutput) => void ): void; - public queryObjects( - args: QueryObjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryObjectsCommandOutput) => void), - cb?: (err: any, data?: QueryObjectsCommandOutput) => void - ): Promise | void { - const command = new QueryObjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes existing tags from the specified pipeline.

+ * @see {@link RemoveTagsCommand} */ - public removeTags(args: RemoveTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public removeTags(args: RemoveTagsCommandInput, cb: (err: any, data?: RemoveTagsCommandOutput) => void): void; - public removeTags( + removeTags(args: RemoveTagsCommandInput, options?: __HttpHandlerOptions): Promise; + removeTags(args: RemoveTagsCommandInput, cb: (err: any, data?: RemoveTagsCommandOutput) => void): void; + removeTags( args: RemoveTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsCommandOutput) => void ): void; - public removeTags( - args: RemoveTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveTagsCommandOutput) => void), - cb?: (err: any, data?: RemoveTagsCommandOutput) => void - ): Promise | void { - const command = new RemoveTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Task runners call ReportTaskProgress when assigned a task to acknowledge that it has the task. If the web service does not - * receive this acknowledgement within 2 minutes, it assigns the task in a subsequent PollForTask call. After this initial acknowledgement, - * the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time - * from 15 minutes by specifying a reportProgressTimeout field in your pipeline.

- *

If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the task - * and reassigns the task in a subsequent response to PollForTask. Task runners should call ReportTaskProgress every 60 seconds.

- * - * - * - * POST / HTTP/1.1 - * Content-Type: application/x-amz-json-1.1 - * X-Amz-Target: DataPipeline.ReportTaskProgress - * Content-Length: 832 - * Host: datapipeline.us-east-1.amazonaws.com - * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT - * Authorization: AuthParams - * - * \{"taskId": "aaGgHT4LuH0T0Y0oLrJRjas5qH0d8cDPADxqq3tn+zCWGELkCdV2JprLreXm1oxeP5EFZHFLJ69kjSsLYE0iYHYBYVGBrB+E/pYq7ANEEeGJFnSBMRiXZVA+8UJ3OzcInvXeinqBmBaKwii7hnnKb/AXjXiNTXyxgydX1KAyg1AxkwBYG4cfPYMZbuEbQJFJvv5C/2+GVXz1w94nKYTeUeepwUOFOuRLS6JVtZoYwpF56E+Yfk1IcGpFOvCZ01B4Bkuu7x3J+MD/j6kJgZLAgbCJQtI3eiW3kdGmX0p0I2BdY1ZsX6b4UiSvM3OMj6NEHJCJL4E0ZfitnhCoe24Kvjo6C2hFbZq+ei/HPgSXBQMSagkr4vS9c0ChzxH2+LNYvec6bY4kymkaZI1dvOzmpa0FcnGf5AjSK4GpsViZ/ujz6zxFv81qBXzjF0/4M1775rjV1VUdyKaixiA/sJiACNezqZqETidp8d24BDPRhGsj6pBCrnelqGFrk/gXEXUsJ+xwMifRC8UVwiKekpAvHUywVk7Ku4jH/n3i2VoLRP6FXwpUbelu34iiZ9czpXyLtyPKwxa87dlrnRVURwkcVjOt2Mcrcaqe+cbWHvNRhyrPkkdfSF3ac8/wfgVbXvLEB2k9mKc67aD9rvdc1PKX09Tk8BKklsMTpZ3TRCd4NzQlJKigMe8Jat9+1tKj4Ole5ZzW6uyTu2s2iFjEV8KXu4MaiRJyNKCdKeGhhZWY37Qk4NBK4Ppgu+C6Y41dpfOh288SLDEVx0/UySlqOEdhba7c6BiPp5r3hKj3mk9lFy5OYp1aoGLeeFmjXveTnPdf2gkWqXXg7AUbJ7jEs1F0lKZQg4szep2gcKyAJXgvXLfJJHcha8Lfb/Ee7wYmyOcAaRpDBoFNSbtoVXar46teIrpho+ZDvynUXvU0grHWGOk=:wn3SgymHZM99bEXAMPLE", - * "fields": - * [ - * \{"key": "percentComplete", - * "stringValue": "50"\} - * ] - * \} - * - * - * - * - * - * x-amzn-RequestId: 640bd023-0775-11e2-af6f-6bc7a6be60d9 - * Content-Type: application/x-amz-json-1.1 - * Content-Length: 18 - * Date: Mon, 12 Nov 2012 17:50:53 GMT - * - * \{"canceled": false\} - * - * - * + * @see {@link ReportTaskProgressCommand} */ - public reportTaskProgress( + reportTaskProgress( args: ReportTaskProgressCommandInput, options?: __HttpHandlerOptions ): Promise; - public reportTaskProgress( + reportTaskProgress( args: ReportTaskProgressCommandInput, cb: (err: any, data?: ReportTaskProgressCommandOutput) => void ): void; - public reportTaskProgress( + reportTaskProgress( args: ReportTaskProgressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReportTaskProgressCommandOutput) => void ): void; - public reportTaskProgress( - args: ReportTaskProgressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReportTaskProgressCommandOutput) => void), - cb?: (err: any, data?: ReportTaskProgressCommandOutput) => void - ): Promise | void { - const command = new ReportTaskProgressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. - * If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use - * this call to detect when the task runner application has failed and restart a new instance.

- * - * - * - * - * POST / HTTP/1.1 - * Content-Type: application/x-amz-json-1.1 - * X-Amz-Target: DataPipeline.ReportTaskRunnerHeartbeat - * Content-Length: 84 - * Host: datapipeline.us-east-1.amazonaws.com - * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT - * Authorization: AuthParams - * - * \{"taskrunnerId": "1234567890", - * "workerGroup": "wg-12345", - * "hostname": "example.com"\} - * - * - * - * - * - * Status: - * x-amzn-RequestId: b3104dc5-0734-11e2-af6f-6bc7a6be60d9 - * Content-Type: application/x-amz-json-1.1 - * Content-Length: 20 - * Date: Mon, 12 Nov 2012 17:50:53 GMT - * - * \{"terminate": false\} - * - * - * + * @see {@link ReportTaskRunnerHeartbeatCommand} */ - public reportTaskRunnerHeartbeat( + reportTaskRunnerHeartbeat( args: ReportTaskRunnerHeartbeatCommandInput, options?: __HttpHandlerOptions ): Promise; - public reportTaskRunnerHeartbeat( + reportTaskRunnerHeartbeat( args: ReportTaskRunnerHeartbeatCommandInput, cb: (err: any, data?: ReportTaskRunnerHeartbeatCommandOutput) => void ): void; - public reportTaskRunnerHeartbeat( + reportTaskRunnerHeartbeat( args: ReportTaskRunnerHeartbeatCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReportTaskRunnerHeartbeatCommandOutput) => void ): void; - public reportTaskRunnerHeartbeat( - args: ReportTaskRunnerHeartbeatCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReportTaskRunnerHeartbeatCommandOutput) => void), - cb?: (err: any, data?: ReportTaskRunnerHeartbeatCommandOutput) => void - ): Promise | void { - const command = new ReportTaskRunnerHeartbeatCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. - * This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). - * You cannot perform this operation on FINISHED pipelines and attempting to do so returns InvalidRequestException.

- * - * - * - * - * POST / HTTP/1.1 - * Content-Type: application/x-amz-json-1.1 - * X-Amz-Target: DataPipeline.SetStatus - * Content-Length: 100 - * Host: datapipeline.us-east-1.amazonaws.com - * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT - * Authorization: AuthParams - * - * \{"pipelineId": "df-0634701J7KEXAMPLE", - * "objectIds": - * ["o-08600941GHJWMBR9E2"], - * "status": "pause"\} - * - * - * - * - * - * x-amzn-RequestId: e83b8ab7-076a-11e2-af6f-6bc7a6be60d9 - * Content-Type: application/x-amz-json-1.1 - * Content-Length: 0 - * Date: Mon, 12 Nov 2012 17:50:53 GMT - * - * Unexpected response: 200, OK, undefined - * - * - * + * @see {@link SetStatusCommand} */ - public setStatus(args: SetStatusCommandInput, options?: __HttpHandlerOptions): Promise; - public setStatus(args: SetStatusCommandInput, cb: (err: any, data?: SetStatusCommandOutput) => void): void; - public setStatus( + setStatus(args: SetStatusCommandInput, options?: __HttpHandlerOptions): Promise; + setStatus(args: SetStatusCommandInput, cb: (err: any, data?: SetStatusCommandOutput) => void): void; + setStatus( args: SetStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetStatusCommandOutput) => void ): void; - public setStatus( - args: SetStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetStatusCommandOutput) => void), - cb?: (err: any, data?: SetStatusCommandOutput) => void - ): Promise | void { - const command = new SetStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide information about the final status. - * A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call SetTaskStatus for - * tasks that are canceled by the web service during a call to ReportTaskProgress.

- * - * - * - * - * POST / HTTP/1.1 - * Content-Type: application/x-amz-json-1.1 - * X-Amz-Target: DataPipeline.SetTaskStatus - * Content-Length: 847 - * Host: datapipeline.us-east-1.amazonaws.com - * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT - * Authorization: AuthParams - * - * \{"taskId": "aaGgHT4LuH0T0Y0oLrJRjas5qH0d8cDPADxqq3tn+zCWGELkCdV2JprLreXm1oxeP5EFZHFLJ69kjSsLYE0iYHYBYVGBrB+E/pYq7ANEEeGJFnSBMRiXZVA+8UJ3OzcInvXeinqBmBaKwii7hnnKb/AXjXiNTXyxgydX1KAyg1AxkwBYG4cfPYMZbuEbQJFJvv5C/2+GVXz1w94nKYTeUeepwUOFOuRLS6JVtZoYwpF56E+Yfk1IcGpFOvCZ01B4Bkuu7x3J+MD/j6kJgZLAgbCJQtI3eiW3kdGmX0p0I2BdY1ZsX6b4UiSvM3OMj6NEHJCJL4E0ZfitnhCoe24Kvjo6C2hFbZq+ei/HPgSXBQMSagkr4vS9c0ChzxH2+LNYvec6bY4kymkaZI1dvOzmpa0FcnGf5AjSK4GpsViZ/ujz6zxFv81qBXzjF0/4M1775rjV1VUdyKaixiA/sJiACNezqZqETidp8d24BDPRhGsj6pBCrnelqGFrk/gXEXUsJ+xwMifRC8UVwiKekpAvHUywVk7Ku4jH/n3i2VoLRP6FXwpUbelu34iiZ9czpXyLtyPKwxa87dlrnRVURwkcVjOt2Mcrcaqe+cbWHvNRhyrPkkdfSF3ac8/wfgVbXvLEB2k9mKc67aD9rvdc1PKX09Tk8BKklsMTpZ3TRCd4NzQlJKigMe8Jat9+1tKj4Ole5ZzW6uyTu2s2iFjEV8KXu4MaiRJyNKCdKeGhhZWY37Qk4NBK4Ppgu+C6Y41dpfOh288SLDEVx0/UySlqOEdhba7c6BiPp5r3hKj3mk9lFy5OYp1aoGLeeFmjXveTnPdf2gkWqXXg7AUbJ7jEs1F0lKZQg4szep2gcKyAJXgvXLfJJHcha8Lfb/Ee7wYmyOcAaRpDBoFNSbtoVXar46teIrpho+ZDvynUXvU0grHWGOk=:wn3SgymHZM99bEXAMPLE", - * "taskStatus": "FINISHED"\} - * - * - * - * - * - * x-amzn-RequestId: 8c8deb53-0788-11e2-af9c-6bc7a6be6qr8 - * Content-Type: application/x-amz-json-1.1 - * Content-Length: 0 - * Date: Mon, 12 Nov 2012 17:50:53 GMT - * - * \{\} - * - * - * + * @see {@link SetTaskStatusCommand} */ - public setTaskStatus( - args: SetTaskStatusCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public setTaskStatus( - args: SetTaskStatusCommandInput, - cb: (err: any, data?: SetTaskStatusCommandOutput) => void - ): void; - public setTaskStatus( + setTaskStatus(args: SetTaskStatusCommandInput, options?: __HttpHandlerOptions): Promise; + setTaskStatus(args: SetTaskStatusCommandInput, cb: (err: any, data?: SetTaskStatusCommandOutput) => void): void; + setTaskStatus( args: SetTaskStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetTaskStatusCommandOutput) => void ): void; - public setTaskStatus( - args: SetTaskStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetTaskStatusCommandOutput) => void), - cb?: (err: any, data?: SetTaskStatusCommandOutput) => void - ): Promise | void { - const command = new SetTaskStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Validates the specified pipeline definition to ensure that it is well formed and can be run without error.

- * - * - * - * Example 1 - * - * This example sets an valid pipeline configuration and returns success. - * - * - * - * POST / HTTP/1.1 - * Content-Type: application/x-amz-json-1.1 - * X-Amz-Target: DataPipeline.ValidatePipelineDefinition - * Content-Length: 936 - * Host: datapipeline.us-east-1.amazonaws.com - * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT - * Authorization: AuthParams - * - * \{"pipelineId": "df-06372391ZG65EXAMPLE", - * "pipelineObjects": - * [ - * \{"id": "Default", - * "name": "Default", - * "fields": - * [ - * \{"key": "workerGroup", - * "stringValue": "MyworkerGroup"\} - * ] - * \}, - * \{"id": "Schedule", - * "name": "Schedule", - * "fields": - * [ - * \{"key": "startDateTime", - * "stringValue": "2012-09-25T17:00:00"\}, - * \{"key": "type", - * "stringValue": "Schedule"\}, - * \{"key": "period", - * "stringValue": "1 hour"\}, - * \{"key": "endDateTime", - * "stringValue": "2012-09-25T18:00:00"\} - * ] - * \}, - * \{"id": "SayHello", - * "name": "SayHello", - * "fields": - * [ - * \{"key": "type", - * "stringValue": "ShellCommandActivity"\}, - * \{"key": "command", - * "stringValue": "echo hello"\}, - * \{"key": "parent", - * "refValue": "Default"\}, - * \{"key": "schedule", - * "refValue": "Schedule"\} - * - * ] - * \} - * ] - * \} - * - * - * - * - * x-amzn-RequestId: 92c9f347-0776-11e2-8a14-21bb8a1f50ef - * Content-Type: application/x-amz-json-1.1 - * Content-Length: 18 - * Date: Mon, 12 Nov 2012 17:50:53 GMT - * - * \{"errored": false\} - * - * - * - * - * Example 2 - * - * This example sets an invalid pipeline configuration and returns the associated set of validation errors. - * - * - * - * - * POST / HTTP/1.1 - * Content-Type: application/x-amz-json-1.1 - * X-Amz-Target: DataPipeline.ValidatePipelineDefinition - * Content-Length: 903 - * Host: datapipeline.us-east-1.amazonaws.com - * X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT - * Authorization: AuthParams - * - * \{"pipelineId": "df-06372391ZG65EXAMPLE", - * "pipelineObjects": - * [ - * \{"id": "Default", - * "name": "Default", - * "fields": - * [ - * \{"key": "workerGroup", - * "stringValue": "MyworkerGroup"\} - * ] - * \}, - * \{"id": "Schedule", - * "name": "Schedule", - * "fields": - * [ - * \{"key": "startDateTime", - * "stringValue": "bad-time"\}, - * \{"key": "type", - * "stringValue": "Schedule"\}, - * \{"key": "period", - * "stringValue": "1 hour"\}, - * \{"key": "endDateTime", - * "stringValue": "2012-09-25T18:00:00"\} - * ] - * \}, - * \{"id": "SayHello", - * "name": "SayHello", - * "fields": - * [ - * \{"key": "type", - * "stringValue": "ShellCommandActivity"\}, - * \{"key": "command", - * "stringValue": "echo hello"\}, - * \{"key": "parent", - * "refValue": "Default"\}, - * \{"key": "schedule", - * "refValue": "Schedule"\} - * - * ] - * \} - * ] - * \} - * - * - * - * - * x-amzn-RequestId: 496a1f5a-0e6a-11e2-a61c-bd6312c92ddd - * Content-Type: application/x-amz-json-1.1 - * Content-Length: 278 - * Date: Mon, 12 Nov 2012 17:50:53 GMT - * - * \{"errored": true, - * "validationErrors": - * [ - * \{"errors": - * ["INVALID_FIELD_VALUE: 'startDateTime' value must be a literal datetime value."], - * "id": "Schedule"\} - * ] - * \} - * - * - * - * + * @see {@link ValidatePipelineDefinitionCommand} */ - public validatePipelineDefinition( + validatePipelineDefinition( args: ValidatePipelineDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public validatePipelineDefinition( + validatePipelineDefinition( args: ValidatePipelineDefinitionCommandInput, cb: (err: any, data?: ValidatePipelineDefinitionCommandOutput) => void ): void; - public validatePipelineDefinition( + validatePipelineDefinition( args: ValidatePipelineDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidatePipelineDefinitionCommandOutput) => void ): void; - public validatePipelineDefinition( - args: ValidatePipelineDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ValidatePipelineDefinitionCommandOutput) => void), - cb?: (err: any, data?: ValidatePipelineDefinitionCommandOutput) => void - ): Promise | void { - const command = new ValidatePipelineDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

AWS Data Pipeline configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline + * handles the details of scheduling and ensuring that data dependencies are met so that your application + * can focus on processing the data.

+ * + *

AWS Data Pipeline provides a JAR implementation of a task runner called AWS Data Pipeline Task Runner. + * AWS Data Pipeline Task Runner provides logic for common data management scenarios, such as performing + * database queries and running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use + * AWS Data Pipeline Task Runner as your task runner, or you can write your own task runner to provide + * custom data management.

+ * + *

AWS Data Pipeline implements two main sets of functionality. Use the first set to create a pipeline + * and define data sources, schedules, dependencies, and the transforms to be performed on the data. + * Use the second set in your task runner application to receive the next task ready for processing. + * The logic for performing the task, such as querying the data, running data analysis, or converting + * the data from one format to another, is contained within the task runner. The task runner performs + * the task assigned to it by the web service, reporting progress to the web service as it does so. + * When the task is done, the task runner reports the final success or failure of the task to the web service.

+ */ +export class DataPipeline extends DataPipelineClient implements DataPipeline {} +createAggregatedClient(commands, DataPipeline); diff --git a/clients/client-database-migration-service/src/DatabaseMigrationService.ts b/clients/client-database-migration-service/src/DatabaseMigrationService.ts index 3a3c3486acfa..6a47c606659c 100644 --- a/clients/client-database-migration-service/src/DatabaseMigrationService.ts +++ b/clients/client-database-migration-service/src/DatabaseMigrationService.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -346,2485 +347,1240 @@ import { UpdateSubscriptionsToEventBridgeCommandInput, UpdateSubscriptionsToEventBridgeCommandOutput, } from "./commands/UpdateSubscriptionsToEventBridgeCommand"; -import { DatabaseMigrationServiceClient } from "./DatabaseMigrationServiceClient"; +import { DatabaseMigrationServiceClient, DatabaseMigrationServiceClientConfig } from "./DatabaseMigrationServiceClient"; -/** - * @public - * Database Migration Service - *

Database Migration Service (DMS) can migrate your data to and from the most - * widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL - * Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise - * (ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as - * heterogeneous migrations between different database platforms, such as Oracle to MySQL or - * SQL Server to PostgreSQL.

- *

For more information about DMS, see What Is Database Migration Service? - * in the Database Migration Service User Guide. - *

- */ -export class DatabaseMigrationService extends DatabaseMigrationServiceClient { +const commands = { + AddTagsToResourceCommand, + ApplyPendingMaintenanceActionCommand, + BatchStartRecommendationsCommand, + CancelReplicationTaskAssessmentRunCommand, + CreateEndpointCommand, + CreateEventSubscriptionCommand, + CreateFleetAdvisorCollectorCommand, + CreateReplicationInstanceCommand, + CreateReplicationSubnetGroupCommand, + CreateReplicationTaskCommand, + DeleteCertificateCommand, + DeleteConnectionCommand, + DeleteEndpointCommand, + DeleteEventSubscriptionCommand, + DeleteFleetAdvisorCollectorCommand, + DeleteFleetAdvisorDatabasesCommand, + DeleteReplicationInstanceCommand, + DeleteReplicationSubnetGroupCommand, + DeleteReplicationTaskCommand, + DeleteReplicationTaskAssessmentRunCommand, + DescribeAccountAttributesCommand, + DescribeApplicableIndividualAssessmentsCommand, + DescribeCertificatesCommand, + DescribeConnectionsCommand, + DescribeEndpointsCommand, + DescribeEndpointSettingsCommand, + DescribeEndpointTypesCommand, + DescribeEventCategoriesCommand, + DescribeEventsCommand, + DescribeEventSubscriptionsCommand, + DescribeFleetAdvisorCollectorsCommand, + DescribeFleetAdvisorDatabasesCommand, + DescribeFleetAdvisorLsaAnalysisCommand, + DescribeFleetAdvisorSchemaObjectSummaryCommand, + DescribeFleetAdvisorSchemasCommand, + DescribeOrderableReplicationInstancesCommand, + DescribePendingMaintenanceActionsCommand, + DescribeRecommendationLimitationsCommand, + DescribeRecommendationsCommand, + DescribeRefreshSchemasStatusCommand, + DescribeReplicationInstancesCommand, + DescribeReplicationInstanceTaskLogsCommand, + DescribeReplicationSubnetGroupsCommand, + DescribeReplicationTaskAssessmentResultsCommand, + DescribeReplicationTaskAssessmentRunsCommand, + DescribeReplicationTaskIndividualAssessmentsCommand, + DescribeReplicationTasksCommand, + DescribeSchemasCommand, + DescribeTableStatisticsCommand, + ImportCertificateCommand, + ListTagsForResourceCommand, + ModifyEndpointCommand, + ModifyEventSubscriptionCommand, + ModifyReplicationInstanceCommand, + ModifyReplicationSubnetGroupCommand, + ModifyReplicationTaskCommand, + MoveReplicationTaskCommand, + RebootReplicationInstanceCommand, + RefreshSchemasCommand, + ReloadTablesCommand, + RemoveTagsFromResourceCommand, + RunFleetAdvisorLsaAnalysisCommand, + StartRecommendationsCommand, + StartReplicationTaskCommand, + StartReplicationTaskAssessmentCommand, + StartReplicationTaskAssessmentRunCommand, + StopReplicationTaskCommand, + TestConnectionCommand, + UpdateSubscriptionsToEventBridgeCommand, +}; + +export interface DatabaseMigrationService { /** - * @public - *

Adds metadata tags to an DMS resource, including replication instance, endpoint, - * subnet group, and migration task. These tags can also be used with cost allocation - * reporting to track cost associated with DMS resources, or used in a Condition statement in - * an IAM policy for DMS. For more information, see - * Tag - * data type description.

+ * @see {@link AddTagsToResourceCommand} */ - public addTagsToResource( + addTagsToResource( args: AddTagsToResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public addTagsToResource( + addTagsToResource( args: AddTagsToResourceCommandInput, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void ): void; - public addTagsToResource( + addTagsToResource( args: AddTagsToResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void ): void; - public addTagsToResource( - args: AddTagsToResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddTagsToResourceCommandOutput) => void), - cb?: (err: any, data?: AddTagsToResourceCommandOutput) => void - ): Promise | void { - const command = new AddTagsToResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Applies a pending maintenance action to a resource (for example, to a replication instance).

- */ - public applyPendingMaintenanceAction( + + /** + * @see {@link ApplyPendingMaintenanceActionCommand} + */ + applyPendingMaintenanceAction( args: ApplyPendingMaintenanceActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public applyPendingMaintenanceAction( + applyPendingMaintenanceAction( args: ApplyPendingMaintenanceActionCommandInput, cb: (err: any, data?: ApplyPendingMaintenanceActionCommandOutput) => void ): void; - public applyPendingMaintenanceAction( + applyPendingMaintenanceAction( args: ApplyPendingMaintenanceActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ApplyPendingMaintenanceActionCommandOutput) => void ): void; - public applyPendingMaintenanceAction( - args: ApplyPendingMaintenanceActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ApplyPendingMaintenanceActionCommandOutput) => void), - cb?: (err: any, data?: ApplyPendingMaintenanceActionCommandOutput) => void - ): Promise | void { - const command = new ApplyPendingMaintenanceActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts the analysis of up to 20 source databases to recommend target engines for each - * source database. This is a batch version of StartRecommendations.

- *

The result of analysis of each source database is reported individually in the - * response. Because the batch request can result in a combination of successful and - * unsuccessful actions, you should check for batch errors even when the call returns an - * HTTP status code of 200.

- */ - public batchStartRecommendations( + + /** + * @see {@link BatchStartRecommendationsCommand} + */ + batchStartRecommendations( args: BatchStartRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchStartRecommendations( + batchStartRecommendations( args: BatchStartRecommendationsCommandInput, cb: (err: any, data?: BatchStartRecommendationsCommandOutput) => void ): void; - public batchStartRecommendations( + batchStartRecommendations( args: BatchStartRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchStartRecommendationsCommandOutput) => void ): void; - public batchStartRecommendations( - args: BatchStartRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchStartRecommendationsCommandOutput) => void), - cb?: (err: any, data?: BatchStartRecommendationsCommandOutput) => void - ): Promise | void { - const command = new BatchStartRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels a single premigration assessment run.

- *

This operation prevents any individual assessments from running if they haven't started - * running. It also attempts to cancel any individual assessments that are currently - * running.

- */ - public cancelReplicationTaskAssessmentRun( + + /** + * @see {@link CancelReplicationTaskAssessmentRunCommand} + */ + cancelReplicationTaskAssessmentRun( args: CancelReplicationTaskAssessmentRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelReplicationTaskAssessmentRun( + cancelReplicationTaskAssessmentRun( args: CancelReplicationTaskAssessmentRunCommandInput, cb: (err: any, data?: CancelReplicationTaskAssessmentRunCommandOutput) => void ): void; - public cancelReplicationTaskAssessmentRun( + cancelReplicationTaskAssessmentRun( args: CancelReplicationTaskAssessmentRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelReplicationTaskAssessmentRunCommandOutput) => void ): void; - public cancelReplicationTaskAssessmentRun( - args: CancelReplicationTaskAssessmentRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelReplicationTaskAssessmentRunCommandOutput) => void), - cb?: (err: any, data?: CancelReplicationTaskAssessmentRunCommandOutput) => void - ): Promise | void { - const command = new CancelReplicationTaskAssessmentRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an endpoint using the provided settings.

- * - *

For a MySQL source or target endpoint, don't explicitly specify the database using - * the DatabaseName request parameter on the CreateEndpoint API call. - * Specifying DatabaseName when you create a MySQL endpoint replicates all the - * task tables to this single database. For MySQL endpoints, you specify the database only when - * you specify the schema in the table-mapping rules of the DMS task.

- *
- */ - public createEndpoint( + + /** + * @see {@link CreateEndpointCommand} + */ + createEndpoint( args: CreateEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEndpoint( - args: CreateEndpointCommandInput, - cb: (err: any, data?: CreateEndpointCommandOutput) => void - ): void; - public createEndpoint( + createEndpoint(args: CreateEndpointCommandInput, cb: (err: any, data?: CreateEndpointCommandOutput) => void): void; + createEndpoint( args: CreateEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEndpointCommandOutput) => void ): void; - public createEndpoint( - args: CreateEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEndpointCommandOutput) => void), - cb?: (err: any, data?: CreateEndpointCommandOutput) => void - ): Promise | void { - const command = new CreateEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an DMS event notification subscription.

- *

You can specify the type of source (SourceType) you want to be notified of, - * provide a list of DMS source IDs (SourceIds) that triggers the events, and - * provide a list of event categories (EventCategories) for events you want to be - * notified of. If you specify both the SourceType and SourceIds, - * such as SourceType = replication-instance and SourceIdentifier = - * my-replinstance, you will be notified of all the replication instance events for - * the specified source. If you specify a SourceType but don't specify a - * SourceIdentifier, you receive notice of the events for that source type for - * all your DMS sources. If you don't specify either SourceType nor - * SourceIdentifier, you will be notified of events generated from all DMS - * sources belonging to your customer account.

- *

For more information about DMS events, see Working with Events and - * Notifications in the Database Migration Service User - * Guide. - *

- */ - public createEventSubscription( + + /** + * @see {@link CreateEventSubscriptionCommand} + */ + createEventSubscription( args: CreateEventSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEventSubscription( + createEventSubscription( args: CreateEventSubscriptionCommandInput, cb: (err: any, data?: CreateEventSubscriptionCommandOutput) => void ): void; - public createEventSubscription( + createEventSubscription( args: CreateEventSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEventSubscriptionCommandOutput) => void ): void; - public createEventSubscription( - args: CreateEventSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEventSubscriptionCommandOutput) => void), - cb?: (err: any, data?: CreateEventSubscriptionCommandOutput) => void - ): Promise | void { - const command = new CreateEventSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Fleet Advisor collector using the specified parameters.

- */ - public createFleetAdvisorCollector( + + /** + * @see {@link CreateFleetAdvisorCollectorCommand} + */ + createFleetAdvisorCollector( args: CreateFleetAdvisorCollectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFleetAdvisorCollector( + createFleetAdvisorCollector( args: CreateFleetAdvisorCollectorCommandInput, cb: (err: any, data?: CreateFleetAdvisorCollectorCommandOutput) => void ): void; - public createFleetAdvisorCollector( + createFleetAdvisorCollector( args: CreateFleetAdvisorCollectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFleetAdvisorCollectorCommandOutput) => void ): void; - public createFleetAdvisorCollector( - args: CreateFleetAdvisorCollectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFleetAdvisorCollectorCommandOutput) => void), - cb?: (err: any, data?: CreateFleetAdvisorCollectorCommandOutput) => void - ): Promise | void { - const command = new CreateFleetAdvisorCollectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates the replication instance using the specified parameters.

- *

DMS requires that your account have certain roles with appropriate permissions - * before you can create a replication instance. For information on the required roles, see - * Creating the IAM Roles to Use With the CLI and DMS API. For - * information on the required permissions, see - * IAM Permissions Needed to Use DMS.

- */ - public createReplicationInstance( + + /** + * @see {@link CreateReplicationInstanceCommand} + */ + createReplicationInstance( args: CreateReplicationInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createReplicationInstance( + createReplicationInstance( args: CreateReplicationInstanceCommandInput, cb: (err: any, data?: CreateReplicationInstanceCommandOutput) => void ): void; - public createReplicationInstance( + createReplicationInstance( args: CreateReplicationInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReplicationInstanceCommandOutput) => void ): void; - public createReplicationInstance( - args: CreateReplicationInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateReplicationInstanceCommandOutput) => void), - cb?: (err: any, data?: CreateReplicationInstanceCommandOutput) => void - ): Promise | void { - const command = new CreateReplicationInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a replication subnet group given a list of the subnet IDs in a VPC.

- *

The VPC needs to have at least one subnet in at least two availability zones in the Amazon Web Services Region, otherwise the - * service will throw a ReplicationSubnetGroupDoesNotCoverEnoughAZs exception.

- */ - public createReplicationSubnetGroup( + + /** + * @see {@link CreateReplicationSubnetGroupCommand} + */ + createReplicationSubnetGroup( args: CreateReplicationSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createReplicationSubnetGroup( + createReplicationSubnetGroup( args: CreateReplicationSubnetGroupCommandInput, cb: (err: any, data?: CreateReplicationSubnetGroupCommandOutput) => void ): void; - public createReplicationSubnetGroup( + createReplicationSubnetGroup( args: CreateReplicationSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReplicationSubnetGroupCommandOutput) => void ): void; - public createReplicationSubnetGroup( - args: CreateReplicationSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateReplicationSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: CreateReplicationSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new CreateReplicationSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a replication task using the specified parameters.

- */ - public createReplicationTask( + + /** + * @see {@link CreateReplicationTaskCommand} + */ + createReplicationTask( args: CreateReplicationTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public createReplicationTask( + createReplicationTask( args: CreateReplicationTaskCommandInput, cb: (err: any, data?: CreateReplicationTaskCommandOutput) => void ): void; - public createReplicationTask( + createReplicationTask( args: CreateReplicationTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReplicationTaskCommandOutput) => void ): void; - public createReplicationTask( - args: CreateReplicationTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateReplicationTaskCommandOutput) => void), - cb?: (err: any, data?: CreateReplicationTaskCommandOutput) => void - ): Promise | void { - const command = new CreateReplicationTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified certificate.

- */ - public deleteCertificate( + + /** + * @see {@link DeleteCertificateCommand} + */ + deleteCertificate( args: DeleteCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCertificate( + deleteCertificate( args: DeleteCertificateCommandInput, cb: (err: any, data?: DeleteCertificateCommandOutput) => void ): void; - public deleteCertificate( + deleteCertificate( args: DeleteCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCertificateCommandOutput) => void ): void; - public deleteCertificate( - args: DeleteCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCertificateCommandOutput) => void), - cb?: (err: any, data?: DeleteCertificateCommandOutput) => void - ): Promise | void { - const command = new DeleteCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the connection between a replication instance and an endpoint.

- */ - public deleteConnection( + + /** + * @see {@link DeleteConnectionCommand} + */ + deleteConnection( args: DeleteConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, cb: (err: any, data?: DeleteConnectionCommandOutput) => void ): void; - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectionCommandOutput) => void ): void; - public deleteConnection( - args: DeleteConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConnectionCommandOutput) => void), - cb?: (err: any, data?: DeleteConnectionCommandOutput) => void - ): Promise | void { - const command = new DeleteConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified endpoint.

- * - *

All tasks associated with the endpoint must be deleted before you can delete the - * endpoint.

- *
- *

- */ - public deleteEndpoint( + + /** + * @see {@link DeleteEndpointCommand} + */ + deleteEndpoint( args: DeleteEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEndpoint( - args: DeleteEndpointCommandInput, - cb: (err: any, data?: DeleteEndpointCommandOutput) => void - ): void; - public deleteEndpoint( + deleteEndpoint(args: DeleteEndpointCommandInput, cb: (err: any, data?: DeleteEndpointCommandOutput) => void): void; + deleteEndpoint( args: DeleteEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEndpointCommandOutput) => void ): void; - public deleteEndpoint( - args: DeleteEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEndpointCommandOutput) => void), - cb?: (err: any, data?: DeleteEndpointCommandOutput) => void - ): Promise | void { - const command = new DeleteEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an DMS event subscription.

- */ - public deleteEventSubscription( + + /** + * @see {@link DeleteEventSubscriptionCommand} + */ + deleteEventSubscription( args: DeleteEventSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEventSubscription( + deleteEventSubscription( args: DeleteEventSubscriptionCommandInput, cb: (err: any, data?: DeleteEventSubscriptionCommandOutput) => void ): void; - public deleteEventSubscription( + deleteEventSubscription( args: DeleteEventSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventSubscriptionCommandOutput) => void ): void; - public deleteEventSubscription( - args: DeleteEventSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEventSubscriptionCommandOutput) => void), - cb?: (err: any, data?: DeleteEventSubscriptionCommandOutput) => void - ): Promise | void { - const command = new DeleteEventSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified Fleet Advisor collector.

- */ - public deleteFleetAdvisorCollector( + + /** + * @see {@link DeleteFleetAdvisorCollectorCommand} + */ + deleteFleetAdvisorCollector( args: DeleteFleetAdvisorCollectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFleetAdvisorCollector( + deleteFleetAdvisorCollector( args: DeleteFleetAdvisorCollectorCommandInput, cb: (err: any, data?: DeleteFleetAdvisorCollectorCommandOutput) => void ): void; - public deleteFleetAdvisorCollector( + deleteFleetAdvisorCollector( args: DeleteFleetAdvisorCollectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFleetAdvisorCollectorCommandOutput) => void ): void; - public deleteFleetAdvisorCollector( - args: DeleteFleetAdvisorCollectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFleetAdvisorCollectorCommandOutput) => void), - cb?: (err: any, data?: DeleteFleetAdvisorCollectorCommandOutput) => void - ): Promise | void { - const command = new DeleteFleetAdvisorCollectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified Fleet Advisor collector databases.

- */ - public deleteFleetAdvisorDatabases( + + /** + * @see {@link DeleteFleetAdvisorDatabasesCommand} + */ + deleteFleetAdvisorDatabases( args: DeleteFleetAdvisorDatabasesCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFleetAdvisorDatabases( + deleteFleetAdvisorDatabases( args: DeleteFleetAdvisorDatabasesCommandInput, cb: (err: any, data?: DeleteFleetAdvisorDatabasesCommandOutput) => void ): void; - public deleteFleetAdvisorDatabases( + deleteFleetAdvisorDatabases( args: DeleteFleetAdvisorDatabasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFleetAdvisorDatabasesCommandOutput) => void ): void; - public deleteFleetAdvisorDatabases( - args: DeleteFleetAdvisorDatabasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFleetAdvisorDatabasesCommandOutput) => void), - cb?: (err: any, data?: DeleteFleetAdvisorDatabasesCommandOutput) => void - ): Promise | void { - const command = new DeleteFleetAdvisorDatabasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified replication instance.

- * - *

You must delete any migration tasks that are associated with the replication instance - * before you can delete it.

- *
- *

- */ - public deleteReplicationInstance( + + /** + * @see {@link DeleteReplicationInstanceCommand} + */ + deleteReplicationInstance( args: DeleteReplicationInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteReplicationInstance( + deleteReplicationInstance( args: DeleteReplicationInstanceCommandInput, cb: (err: any, data?: DeleteReplicationInstanceCommandOutput) => void ): void; - public deleteReplicationInstance( + deleteReplicationInstance( args: DeleteReplicationInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReplicationInstanceCommandOutput) => void ): void; - public deleteReplicationInstance( - args: DeleteReplicationInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteReplicationInstanceCommandOutput) => void), - cb?: (err: any, data?: DeleteReplicationInstanceCommandOutput) => void - ): Promise | void { - const command = new DeleteReplicationInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a subnet group.

- */ - public deleteReplicationSubnetGroup( + + /** + * @see {@link DeleteReplicationSubnetGroupCommand} + */ + deleteReplicationSubnetGroup( args: DeleteReplicationSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteReplicationSubnetGroup( + deleteReplicationSubnetGroup( args: DeleteReplicationSubnetGroupCommandInput, cb: (err: any, data?: DeleteReplicationSubnetGroupCommandOutput) => void ): void; - public deleteReplicationSubnetGroup( + deleteReplicationSubnetGroup( args: DeleteReplicationSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReplicationSubnetGroupCommandOutput) => void ): void; - public deleteReplicationSubnetGroup( - args: DeleteReplicationSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteReplicationSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteReplicationSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteReplicationSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified replication task.

- */ - public deleteReplicationTask( + + /** + * @see {@link DeleteReplicationTaskCommand} + */ + deleteReplicationTask( args: DeleteReplicationTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteReplicationTask( + deleteReplicationTask( args: DeleteReplicationTaskCommandInput, cb: (err: any, data?: DeleteReplicationTaskCommandOutput) => void ): void; - public deleteReplicationTask( + deleteReplicationTask( args: DeleteReplicationTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReplicationTaskCommandOutput) => void ): void; - public deleteReplicationTask( - args: DeleteReplicationTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteReplicationTaskCommandOutput) => void), - cb?: (err: any, data?: DeleteReplicationTaskCommandOutput) => void - ): Promise | void { - const command = new DeleteReplicationTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the record of a single premigration assessment run.

- *

This operation removes all metadata that DMS maintains about this assessment run. - * However, the operation leaves untouched all information about this assessment run that is - * stored in your Amazon S3 bucket.

- */ - public deleteReplicationTaskAssessmentRun( + + /** + * @see {@link DeleteReplicationTaskAssessmentRunCommand} + */ + deleteReplicationTaskAssessmentRun( args: DeleteReplicationTaskAssessmentRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteReplicationTaskAssessmentRun( + deleteReplicationTaskAssessmentRun( args: DeleteReplicationTaskAssessmentRunCommandInput, cb: (err: any, data?: DeleteReplicationTaskAssessmentRunCommandOutput) => void ): void; - public deleteReplicationTaskAssessmentRun( + deleteReplicationTaskAssessmentRun( args: DeleteReplicationTaskAssessmentRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReplicationTaskAssessmentRunCommandOutput) => void ): void; - public deleteReplicationTaskAssessmentRun( - args: DeleteReplicationTaskAssessmentRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteReplicationTaskAssessmentRunCommandOutput) => void), - cb?: (err: any, data?: DeleteReplicationTaskAssessmentRunCommandOutput) => void - ): Promise | void { - const command = new DeleteReplicationTaskAssessmentRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all of the DMS attributes for a customer account. These attributes include DMS - * quotas for the account and a unique account identifier in a particular DMS region. DMS - * quotas include a list of resource quotas supported by the account, such as the number of - * replication instances allowed. The description for each resource quota, includes the quota - * name, current usage toward that quota, and the quota's maximum value. DMS uses the unique - * account identifier to name each artifact used by DMS in the given region.

- *

This command does not take any parameters.

- */ - public describeAccountAttributes( + + /** + * @see {@link DescribeAccountAttributesCommand} + */ + describeAccountAttributes( args: DescribeAccountAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccountAttributes( + describeAccountAttributes( args: DescribeAccountAttributesCommandInput, cb: (err: any, data?: DescribeAccountAttributesCommandOutput) => void ): void; - public describeAccountAttributes( + describeAccountAttributes( args: DescribeAccountAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountAttributesCommandOutput) => void ): void; - public describeAccountAttributes( - args: DescribeAccountAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccountAttributesCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountAttributesCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides a list of individual assessments that you can specify for a new premigration - * assessment run, given one or more parameters.

- *

If you specify an existing migration task, this operation provides the default individual - * assessments you can specify for that task. Otherwise, the specified parameters model elements - * of a possible migration task on which to base a premigration assessment run.

- *

To use these migration task modeling parameters, you must specify an existing replication instance, - * a source database engine, a target database engine, and a migration type. This combination of - * parameters potentially limits the default individual assessments available for an assessment run - * created for a corresponding migration task.

- *

If you specify no parameters, this operation provides a list of all possible individual assessments - * that you can specify for an assessment run. If you specify any one of the task modeling parameters, you must - * specify all of them or the operation cannot provide a list of individual assessments. - * The only parameter that you can specify alone is for an existing migration task. The specified task - * definition then determines the default list of individual assessments that you can specify in an - * assessment run for the task.

- */ - public describeApplicableIndividualAssessments( + + /** + * @see {@link DescribeApplicableIndividualAssessmentsCommand} + */ + describeApplicableIndividualAssessments( args: DescribeApplicableIndividualAssessmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeApplicableIndividualAssessments( + describeApplicableIndividualAssessments( args: DescribeApplicableIndividualAssessmentsCommandInput, cb: (err: any, data?: DescribeApplicableIndividualAssessmentsCommandOutput) => void ): void; - public describeApplicableIndividualAssessments( + describeApplicableIndividualAssessments( args: DescribeApplicableIndividualAssessmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeApplicableIndividualAssessmentsCommandOutput) => void ): void; - public describeApplicableIndividualAssessments( - args: DescribeApplicableIndividualAssessmentsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeApplicableIndividualAssessmentsCommandOutput) => void), - cb?: (err: any, data?: DescribeApplicableIndividualAssessmentsCommandOutput) => void - ): Promise | void { - const command = new DescribeApplicableIndividualAssessmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides a description of the certificate.

- */ - public describeCertificates( + + /** + * @see {@link DescribeCertificatesCommand} + */ + describeCertificates( args: DescribeCertificatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCertificates( + describeCertificates( args: DescribeCertificatesCommandInput, cb: (err: any, data?: DescribeCertificatesCommandOutput) => void ): void; - public describeCertificates( + describeCertificates( args: DescribeCertificatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCertificatesCommandOutput) => void ): void; - public describeCertificates( - args: DescribeCertificatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCertificatesCommandOutput) => void), - cb?: (err: any, data?: DescribeCertificatesCommandOutput) => void - ): Promise | void { - const command = new DescribeCertificatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the status of the connections that have been made between the replication - * instance and an endpoint. Connections are created when you test an endpoint.

- */ - public describeConnections( + + /** + * @see {@link DescribeConnectionsCommand} + */ + describeConnections( args: DescribeConnectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConnections( + describeConnections( args: DescribeConnectionsCommandInput, cb: (err: any, data?: DescribeConnectionsCommandOutput) => void ): void; - public describeConnections( + describeConnections( args: DescribeConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectionsCommandOutput) => void ): void; - public describeConnections( - args: DescribeConnectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConnectionsCommandOutput) => void), - cb?: (err: any, data?: DescribeConnectionsCommandOutput) => void - ): Promise | void { - const command = new DescribeConnectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the endpoints for your account in the current region.

- */ - public describeEndpoints( + + /** + * @see {@link DescribeEndpointsCommand} + */ + describeEndpoints( args: DescribeEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEndpoints( + describeEndpoints( args: DescribeEndpointsCommandInput, cb: (err: any, data?: DescribeEndpointsCommandOutput) => void ): void; - public describeEndpoints( + describeEndpoints( args: DescribeEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEndpointsCommandOutput) => void ): void; - public describeEndpoints( - args: DescribeEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEndpointsCommandOutput) => void), - cb?: (err: any, data?: DescribeEndpointsCommandOutput) => void - ): Promise | void { - const command = new DescribeEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the possible endpoint settings available - * when you create an endpoint for a specific database engine.

- */ - public describeEndpointSettings( + + /** + * @see {@link DescribeEndpointSettingsCommand} + */ + describeEndpointSettings( args: DescribeEndpointSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEndpointSettings( + describeEndpointSettings( args: DescribeEndpointSettingsCommandInput, cb: (err: any, data?: DescribeEndpointSettingsCommandOutput) => void ): void; - public describeEndpointSettings( + describeEndpointSettings( args: DescribeEndpointSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEndpointSettingsCommandOutput) => void ): void; - public describeEndpointSettings( - args: DescribeEndpointSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEndpointSettingsCommandOutput) => void), - cb?: (err: any, data?: DescribeEndpointSettingsCommandOutput) => void - ): Promise | void { - const command = new DescribeEndpointSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the type of endpoints available.

- */ - public describeEndpointTypes( + + /** + * @see {@link DescribeEndpointTypesCommand} + */ + describeEndpointTypes( args: DescribeEndpointTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEndpointTypes( + describeEndpointTypes( args: DescribeEndpointTypesCommandInput, cb: (err: any, data?: DescribeEndpointTypesCommandOutput) => void ): void; - public describeEndpointTypes( + describeEndpointTypes( args: DescribeEndpointTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEndpointTypesCommandOutput) => void ): void; - public describeEndpointTypes( - args: DescribeEndpointTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEndpointTypesCommandOutput) => void), - cb?: (err: any, data?: DescribeEndpointTypesCommandOutput) => void - ): Promise | void { - const command = new DescribeEndpointTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists categories for all event source types, or, if specified, for a specified source - * type. You can see a list of the event categories and source types in Working with Events - * and Notifications in the Database Migration Service User - * Guide. - *

- */ - public describeEventCategories( + + /** + * @see {@link DescribeEventCategoriesCommand} + */ + describeEventCategories( args: DescribeEventCategoriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventCategories( + describeEventCategories( args: DescribeEventCategoriesCommandInput, cb: (err: any, data?: DescribeEventCategoriesCommandOutput) => void ): void; - public describeEventCategories( + describeEventCategories( args: DescribeEventCategoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventCategoriesCommandOutput) => void ): void; - public describeEventCategories( - args: DescribeEventCategoriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventCategoriesCommandOutput) => void), - cb?: (err: any, data?: DescribeEventCategoriesCommandOutput) => void - ): Promise | void { - const command = new DescribeEventCategoriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists events for a given source identifier and source type. You can also specify a - * start and end time. For more information on DMS events, see Working with Events and - * Notifications in the Database Migration Service User - * Guide. - *

- */ - public describeEvents( + + /** + * @see {@link DescribeEventsCommand} + */ + describeEvents( args: DescribeEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEvents( - args: DescribeEventsCommandInput, - cb: (err: any, data?: DescribeEventsCommandOutput) => void - ): void; - public describeEvents( + describeEvents(args: DescribeEventsCommandInput, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void; + describeEvents( args: DescribeEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsCommandOutput) => void ): void; - public describeEvents( - args: DescribeEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventsCommandOutput) => void), - cb?: (err: any, data?: DescribeEventsCommandOutput) => void - ): Promise | void { - const command = new DescribeEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all the event subscriptions for a customer account. The description of a - * subscription includes SubscriptionName, SNSTopicARN, - * CustomerID, SourceType, SourceID, - * CreationTime, and Status.

- *

If you specify SubscriptionName, this action lists the description for that - * subscription.

- */ - public describeEventSubscriptions( + + /** + * @see {@link DescribeEventSubscriptionsCommand} + */ + describeEventSubscriptions( args: DescribeEventSubscriptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventSubscriptions( + describeEventSubscriptions( args: DescribeEventSubscriptionsCommandInput, cb: (err: any, data?: DescribeEventSubscriptionsCommandOutput) => void ): void; - public describeEventSubscriptions( + describeEventSubscriptions( args: DescribeEventSubscriptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventSubscriptionsCommandOutput) => void ): void; - public describeEventSubscriptions( - args: DescribeEventSubscriptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventSubscriptionsCommandOutput) => void), - cb?: (err: any, data?: DescribeEventSubscriptionsCommandOutput) => void - ): Promise | void { - const command = new DescribeEventSubscriptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of the Fleet Advisor collectors in your account.

- */ - public describeFleetAdvisorCollectors( + + /** + * @see {@link DescribeFleetAdvisorCollectorsCommand} + */ + describeFleetAdvisorCollectors( args: DescribeFleetAdvisorCollectorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFleetAdvisorCollectors( + describeFleetAdvisorCollectors( args: DescribeFleetAdvisorCollectorsCommandInput, cb: (err: any, data?: DescribeFleetAdvisorCollectorsCommandOutput) => void ): void; - public describeFleetAdvisorCollectors( + describeFleetAdvisorCollectors( args: DescribeFleetAdvisorCollectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetAdvisorCollectorsCommandOutput) => void ): void; - public describeFleetAdvisorCollectors( - args: DescribeFleetAdvisorCollectorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFleetAdvisorCollectorsCommandOutput) => void), - cb?: (err: any, data?: DescribeFleetAdvisorCollectorsCommandOutput) => void - ): Promise | void { - const command = new DescribeFleetAdvisorCollectorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of Fleet Advisor databases in your account.

- */ - public describeFleetAdvisorDatabases( + + /** + * @see {@link DescribeFleetAdvisorDatabasesCommand} + */ + describeFleetAdvisorDatabases( args: DescribeFleetAdvisorDatabasesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFleetAdvisorDatabases( + describeFleetAdvisorDatabases( args: DescribeFleetAdvisorDatabasesCommandInput, cb: (err: any, data?: DescribeFleetAdvisorDatabasesCommandOutput) => void ): void; - public describeFleetAdvisorDatabases( + describeFleetAdvisorDatabases( args: DescribeFleetAdvisorDatabasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetAdvisorDatabasesCommandOutput) => void ): void; - public describeFleetAdvisorDatabases( - args: DescribeFleetAdvisorDatabasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFleetAdvisorDatabasesCommandOutput) => void), - cb?: (err: any, data?: DescribeFleetAdvisorDatabasesCommandOutput) => void - ): Promise | void { - const command = new DescribeFleetAdvisorDatabasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides descriptions of large-scale assessment (LSA) analyses produced by your Fleet - * Advisor collectors.

- */ - public describeFleetAdvisorLsaAnalysis( + + /** + * @see {@link DescribeFleetAdvisorLsaAnalysisCommand} + */ + describeFleetAdvisorLsaAnalysis( args: DescribeFleetAdvisorLsaAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFleetAdvisorLsaAnalysis( + describeFleetAdvisorLsaAnalysis( args: DescribeFleetAdvisorLsaAnalysisCommandInput, cb: (err: any, data?: DescribeFleetAdvisorLsaAnalysisCommandOutput) => void ): void; - public describeFleetAdvisorLsaAnalysis( + describeFleetAdvisorLsaAnalysis( args: DescribeFleetAdvisorLsaAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetAdvisorLsaAnalysisCommandOutput) => void ): void; - public describeFleetAdvisorLsaAnalysis( - args: DescribeFleetAdvisorLsaAnalysisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFleetAdvisorLsaAnalysisCommandOutput) => void), - cb?: (err: any, data?: DescribeFleetAdvisorLsaAnalysisCommandOutput) => void - ): Promise | void { - const command = new DescribeFleetAdvisorLsaAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides descriptions of the schemas discovered by your Fleet Advisor - * collectors.

- */ - public describeFleetAdvisorSchemaObjectSummary( + + /** + * @see {@link DescribeFleetAdvisorSchemaObjectSummaryCommand} + */ + describeFleetAdvisorSchemaObjectSummary( args: DescribeFleetAdvisorSchemaObjectSummaryCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFleetAdvisorSchemaObjectSummary( + describeFleetAdvisorSchemaObjectSummary( args: DescribeFleetAdvisorSchemaObjectSummaryCommandInput, cb: (err: any, data?: DescribeFleetAdvisorSchemaObjectSummaryCommandOutput) => void ): void; - public describeFleetAdvisorSchemaObjectSummary( + describeFleetAdvisorSchemaObjectSummary( args: DescribeFleetAdvisorSchemaObjectSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetAdvisorSchemaObjectSummaryCommandOutput) => void ): void; - public describeFleetAdvisorSchemaObjectSummary( - args: DescribeFleetAdvisorSchemaObjectSummaryCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeFleetAdvisorSchemaObjectSummaryCommandOutput) => void), - cb?: (err: any, data?: DescribeFleetAdvisorSchemaObjectSummaryCommandOutput) => void - ): Promise | void { - const command = new DescribeFleetAdvisorSchemaObjectSummaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of schemas detected by Fleet Advisor Collectors in your account.

- */ - public describeFleetAdvisorSchemas( + + /** + * @see {@link DescribeFleetAdvisorSchemasCommand} + */ + describeFleetAdvisorSchemas( args: DescribeFleetAdvisorSchemasCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFleetAdvisorSchemas( + describeFleetAdvisorSchemas( args: DescribeFleetAdvisorSchemasCommandInput, cb: (err: any, data?: DescribeFleetAdvisorSchemasCommandOutput) => void ): void; - public describeFleetAdvisorSchemas( + describeFleetAdvisorSchemas( args: DescribeFleetAdvisorSchemasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetAdvisorSchemasCommandOutput) => void ): void; - public describeFleetAdvisorSchemas( - args: DescribeFleetAdvisorSchemasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFleetAdvisorSchemasCommandOutput) => void), - cb?: (err: any, data?: DescribeFleetAdvisorSchemasCommandOutput) => void - ): Promise | void { - const command = new DescribeFleetAdvisorSchemasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the replication instance types that can be created in the - * specified region.

- */ - public describeOrderableReplicationInstances( + + /** + * @see {@link DescribeOrderableReplicationInstancesCommand} + */ + describeOrderableReplicationInstances( args: DescribeOrderableReplicationInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOrderableReplicationInstances( + describeOrderableReplicationInstances( args: DescribeOrderableReplicationInstancesCommandInput, cb: (err: any, data?: DescribeOrderableReplicationInstancesCommandOutput) => void ): void; - public describeOrderableReplicationInstances( + describeOrderableReplicationInstances( args: DescribeOrderableReplicationInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrderableReplicationInstancesCommandOutput) => void ): void; - public describeOrderableReplicationInstances( - args: DescribeOrderableReplicationInstancesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeOrderableReplicationInstancesCommandOutput) => void), - cb?: (err: any, data?: DescribeOrderableReplicationInstancesCommandOutput) => void - ): Promise | void { - const command = new DescribeOrderableReplicationInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

For internal use only

- */ - public describePendingMaintenanceActions( + + /** + * @see {@link DescribePendingMaintenanceActionsCommand} + */ + describePendingMaintenanceActions( args: DescribePendingMaintenanceActionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePendingMaintenanceActions( + describePendingMaintenanceActions( args: DescribePendingMaintenanceActionsCommandInput, cb: (err: any, data?: DescribePendingMaintenanceActionsCommandOutput) => void ): void; - public describePendingMaintenanceActions( + describePendingMaintenanceActions( args: DescribePendingMaintenanceActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePendingMaintenanceActionsCommandOutput) => void ): void; - public describePendingMaintenanceActions( - args: DescribePendingMaintenanceActionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePendingMaintenanceActionsCommandOutput) => void), - cb?: (err: any, data?: DescribePendingMaintenanceActionsCommandOutput) => void - ): Promise | void { - const command = new DescribePendingMaintenanceActionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a paginated list of limitations for recommendations of target Amazon Web Services - * engines.

- */ - public describeRecommendationLimitations( + + /** + * @see {@link DescribeRecommendationLimitationsCommand} + */ + describeRecommendationLimitations( args: DescribeRecommendationLimitationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRecommendationLimitations( + describeRecommendationLimitations( args: DescribeRecommendationLimitationsCommandInput, cb: (err: any, data?: DescribeRecommendationLimitationsCommandOutput) => void ): void; - public describeRecommendationLimitations( + describeRecommendationLimitations( args: DescribeRecommendationLimitationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRecommendationLimitationsCommandOutput) => void ): void; - public describeRecommendationLimitations( - args: DescribeRecommendationLimitationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRecommendationLimitationsCommandOutput) => void), - cb?: (err: any, data?: DescribeRecommendationLimitationsCommandOutput) => void - ): Promise | void { - const command = new DescribeRecommendationLimitationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a paginated list of target engine recommendations for your source - * databases.

- */ - public describeRecommendations( + + /** + * @see {@link DescribeRecommendationsCommand} + */ + describeRecommendations( args: DescribeRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRecommendations( + describeRecommendations( args: DescribeRecommendationsCommandInput, cb: (err: any, data?: DescribeRecommendationsCommandOutput) => void ): void; - public describeRecommendations( + describeRecommendations( args: DescribeRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRecommendationsCommandOutput) => void ): void; - public describeRecommendations( - args: DescribeRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRecommendationsCommandOutput) => void), - cb?: (err: any, data?: DescribeRecommendationsCommandOutput) => void - ): Promise | void { - const command = new DescribeRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the status of the RefreshSchemas operation.

- */ - public describeRefreshSchemasStatus( + + /** + * @see {@link DescribeRefreshSchemasStatusCommand} + */ + describeRefreshSchemasStatus( args: DescribeRefreshSchemasStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRefreshSchemasStatus( + describeRefreshSchemasStatus( args: DescribeRefreshSchemasStatusCommandInput, cb: (err: any, data?: DescribeRefreshSchemasStatusCommandOutput) => void ): void; - public describeRefreshSchemasStatus( + describeRefreshSchemasStatus( args: DescribeRefreshSchemasStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRefreshSchemasStatusCommandOutput) => void ): void; - public describeRefreshSchemasStatus( - args: DescribeRefreshSchemasStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRefreshSchemasStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeRefreshSchemasStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeRefreshSchemasStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about replication instances for your account in the current - * region.

- */ - public describeReplicationInstances( + + /** + * @see {@link DescribeReplicationInstancesCommand} + */ + describeReplicationInstances( args: DescribeReplicationInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReplicationInstances( + describeReplicationInstances( args: DescribeReplicationInstancesCommandInput, cb: (err: any, data?: DescribeReplicationInstancesCommandOutput) => void ): void; - public describeReplicationInstances( + describeReplicationInstances( args: DescribeReplicationInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReplicationInstancesCommandOutput) => void ): void; - public describeReplicationInstances( - args: DescribeReplicationInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReplicationInstancesCommandOutput) => void), - cb?: (err: any, data?: DescribeReplicationInstancesCommandOutput) => void - ): Promise | void { - const command = new DescribeReplicationInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the task logs for the specified task.

- */ - public describeReplicationInstanceTaskLogs( + + /** + * @see {@link DescribeReplicationInstanceTaskLogsCommand} + */ + describeReplicationInstanceTaskLogs( args: DescribeReplicationInstanceTaskLogsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReplicationInstanceTaskLogs( + describeReplicationInstanceTaskLogs( args: DescribeReplicationInstanceTaskLogsCommandInput, cb: (err: any, data?: DescribeReplicationInstanceTaskLogsCommandOutput) => void ): void; - public describeReplicationInstanceTaskLogs( + describeReplicationInstanceTaskLogs( args: DescribeReplicationInstanceTaskLogsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReplicationInstanceTaskLogsCommandOutput) => void ): void; - public describeReplicationInstanceTaskLogs( - args: DescribeReplicationInstanceTaskLogsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReplicationInstanceTaskLogsCommandOutput) => void), - cb?: (err: any, data?: DescribeReplicationInstanceTaskLogsCommandOutput) => void - ): Promise | void { - const command = new DescribeReplicationInstanceTaskLogsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the replication subnet groups.

- */ - public describeReplicationSubnetGroups( + + /** + * @see {@link DescribeReplicationSubnetGroupsCommand} + */ + describeReplicationSubnetGroups( args: DescribeReplicationSubnetGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReplicationSubnetGroups( + describeReplicationSubnetGroups( args: DescribeReplicationSubnetGroupsCommandInput, cb: (err: any, data?: DescribeReplicationSubnetGroupsCommandOutput) => void ): void; - public describeReplicationSubnetGroups( + describeReplicationSubnetGroups( args: DescribeReplicationSubnetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReplicationSubnetGroupsCommandOutput) => void ): void; - public describeReplicationSubnetGroups( - args: DescribeReplicationSubnetGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReplicationSubnetGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeReplicationSubnetGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeReplicationSubnetGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the task assessment results from the Amazon S3 bucket that DMS creates in your - * Amazon Web Services account. This action always returns the - * latest results.

- *

For more information about DMS task assessments, see - * Creating a task assessment report - * in the Database Migration Service User Guide.

- */ - public describeReplicationTaskAssessmentResults( + + /** + * @see {@link DescribeReplicationTaskAssessmentResultsCommand} + */ + describeReplicationTaskAssessmentResults( args: DescribeReplicationTaskAssessmentResultsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReplicationTaskAssessmentResults( + describeReplicationTaskAssessmentResults( args: DescribeReplicationTaskAssessmentResultsCommandInput, cb: (err: any, data?: DescribeReplicationTaskAssessmentResultsCommandOutput) => void ): void; - public describeReplicationTaskAssessmentResults( + describeReplicationTaskAssessmentResults( args: DescribeReplicationTaskAssessmentResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReplicationTaskAssessmentResultsCommandOutput) => void ): void; - public describeReplicationTaskAssessmentResults( - args: DescribeReplicationTaskAssessmentResultsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeReplicationTaskAssessmentResultsCommandOutput) => void), - cb?: (err: any, data?: DescribeReplicationTaskAssessmentResultsCommandOutput) => void - ): Promise | void { - const command = new DescribeReplicationTaskAssessmentResultsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a paginated list of premigration assessment runs based on filter - * settings.

- *

These filter settings can specify a combination of premigration assessment runs, - * migration tasks, replication instances, and assessment run status values.

- * - *

This operation doesn't return information about individual assessments. For this - * information, see the DescribeReplicationTaskIndividualAssessments - * operation.

- *
- */ - public describeReplicationTaskAssessmentRuns( + + /** + * @see {@link DescribeReplicationTaskAssessmentRunsCommand} + */ + describeReplicationTaskAssessmentRuns( args: DescribeReplicationTaskAssessmentRunsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReplicationTaskAssessmentRuns( + describeReplicationTaskAssessmentRuns( args: DescribeReplicationTaskAssessmentRunsCommandInput, cb: (err: any, data?: DescribeReplicationTaskAssessmentRunsCommandOutput) => void ): void; - public describeReplicationTaskAssessmentRuns( + describeReplicationTaskAssessmentRuns( args: DescribeReplicationTaskAssessmentRunsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReplicationTaskAssessmentRunsCommandOutput) => void ): void; - public describeReplicationTaskAssessmentRuns( - args: DescribeReplicationTaskAssessmentRunsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeReplicationTaskAssessmentRunsCommandOutput) => void), - cb?: (err: any, data?: DescribeReplicationTaskAssessmentRunsCommandOutput) => void - ): Promise | void { - const command = new DescribeReplicationTaskAssessmentRunsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a paginated list of individual assessments based on filter settings.

- *

These filter settings can specify a combination of premigration assessment runs, - * migration tasks, and assessment status values.

- */ - public describeReplicationTaskIndividualAssessments( + + /** + * @see {@link DescribeReplicationTaskIndividualAssessmentsCommand} + */ + describeReplicationTaskIndividualAssessments( args: DescribeReplicationTaskIndividualAssessmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReplicationTaskIndividualAssessments( + describeReplicationTaskIndividualAssessments( args: DescribeReplicationTaskIndividualAssessmentsCommandInput, cb: (err: any, data?: DescribeReplicationTaskIndividualAssessmentsCommandOutput) => void ): void; - public describeReplicationTaskIndividualAssessments( + describeReplicationTaskIndividualAssessments( args: DescribeReplicationTaskIndividualAssessmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReplicationTaskIndividualAssessmentsCommandOutput) => void ): void; - public describeReplicationTaskIndividualAssessments( - args: DescribeReplicationTaskIndividualAssessmentsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeReplicationTaskIndividualAssessmentsCommandOutput) => void), - cb?: (err: any, data?: DescribeReplicationTaskIndividualAssessmentsCommandOutput) => void - ): Promise | void { - const command = new DescribeReplicationTaskIndividualAssessmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about replication tasks for your account in the current - * region.

- */ - public describeReplicationTasks( + + /** + * @see {@link DescribeReplicationTasksCommand} + */ + describeReplicationTasks( args: DescribeReplicationTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReplicationTasks( + describeReplicationTasks( args: DescribeReplicationTasksCommandInput, cb: (err: any, data?: DescribeReplicationTasksCommandOutput) => void ): void; - public describeReplicationTasks( + describeReplicationTasks( args: DescribeReplicationTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReplicationTasksCommandOutput) => void ): void; - public describeReplicationTasks( - args: DescribeReplicationTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReplicationTasksCommandOutput) => void), - cb?: (err: any, data?: DescribeReplicationTasksCommandOutput) => void - ): Promise | void { - const command = new DescribeReplicationTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the schema for the specified endpoint.

- *

- */ - public describeSchemas( + + /** + * @see {@link DescribeSchemasCommand} + */ + describeSchemas( args: DescribeSchemasCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSchemas( - args: DescribeSchemasCommandInput, - cb: (err: any, data?: DescribeSchemasCommandOutput) => void - ): void; - public describeSchemas( + describeSchemas(args: DescribeSchemasCommandInput, cb: (err: any, data?: DescribeSchemasCommandOutput) => void): void; + describeSchemas( args: DescribeSchemasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSchemasCommandOutput) => void ): void; - public describeSchemas( - args: DescribeSchemasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSchemasCommandOutput) => void), - cb?: (err: any, data?: DescribeSchemasCommandOutput) => void - ): Promise | void { - const command = new DescribeSchemasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns table statistics on the database migration task, including table name, rows - * inserted, rows updated, and rows deleted.

- *

Note that the "last updated" column the DMS console only indicates the time that DMS - * last updated the table statistics record for a table. It does not indicate the time of the - * last update to the table.

- */ - public describeTableStatistics( + + /** + * @see {@link DescribeTableStatisticsCommand} + */ + describeTableStatistics( args: DescribeTableStatisticsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTableStatistics( + describeTableStatistics( args: DescribeTableStatisticsCommandInput, cb: (err: any, data?: DescribeTableStatisticsCommandOutput) => void ): void; - public describeTableStatistics( + describeTableStatistics( args: DescribeTableStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTableStatisticsCommandOutput) => void ): void; - public describeTableStatistics( - args: DescribeTableStatisticsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTableStatisticsCommandOutput) => void), - cb?: (err: any, data?: DescribeTableStatisticsCommandOutput) => void - ): Promise | void { - const command = new DescribeTableStatisticsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Uploads the specified certificate.

- */ - public importCertificate( + + /** + * @see {@link ImportCertificateCommand} + */ + importCertificate( args: ImportCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public importCertificate( + importCertificate( args: ImportCertificateCommandInput, cb: (err: any, data?: ImportCertificateCommandOutput) => void ): void; - public importCertificate( + importCertificate( args: ImportCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportCertificateCommandOutput) => void ): void; - public importCertificate( - args: ImportCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportCertificateCommandOutput) => void), - cb?: (err: any, data?: ImportCertificateCommandOutput) => void - ): Promise | void { - const command = new ImportCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all metadata tags attached to an DMS resource, including - * replication instance, endpoint, subnet group, and migration task. - * For more information, see - * Tag - * data type description.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the specified endpoint.

- * - *

For a MySQL source or target endpoint, don't explicitly specify the database using - * the DatabaseName request parameter on the ModifyEndpoint API call. - * Specifying DatabaseName when you modify a MySQL endpoint replicates all the - * task tables to this single database. For MySQL endpoints, you specify the database only when - * you specify the schema in the table-mapping rules of the DMS task.

- *
- */ - public modifyEndpoint( + + /** + * @see {@link ModifyEndpointCommand} + */ + modifyEndpoint( args: ModifyEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyEndpoint( - args: ModifyEndpointCommandInput, - cb: (err: any, data?: ModifyEndpointCommandOutput) => void - ): void; - public modifyEndpoint( + modifyEndpoint(args: ModifyEndpointCommandInput, cb: (err: any, data?: ModifyEndpointCommandOutput) => void): void; + modifyEndpoint( args: ModifyEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyEndpointCommandOutput) => void ): void; - public modifyEndpoint( - args: ModifyEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyEndpointCommandOutput) => void), - cb?: (err: any, data?: ModifyEndpointCommandOutput) => void - ): Promise | void { - const command = new ModifyEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies an existing DMS event notification subscription.

- */ - public modifyEventSubscription( + + /** + * @see {@link ModifyEventSubscriptionCommand} + */ + modifyEventSubscription( args: ModifyEventSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyEventSubscription( + modifyEventSubscription( args: ModifyEventSubscriptionCommandInput, cb: (err: any, data?: ModifyEventSubscriptionCommandOutput) => void ): void; - public modifyEventSubscription( + modifyEventSubscription( args: ModifyEventSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyEventSubscriptionCommandOutput) => void ): void; - public modifyEventSubscription( - args: ModifyEventSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyEventSubscriptionCommandOutput) => void), - cb?: (err: any, data?: ModifyEventSubscriptionCommandOutput) => void - ): Promise | void { - const command = new ModifyEventSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the replication instance to apply new settings. You can change one or more - * parameters by specifying these parameters and the new values in the request.

- *

Some settings are applied during the maintenance window.

- *

- */ - public modifyReplicationInstance( + + /** + * @see {@link ModifyReplicationInstanceCommand} + */ + modifyReplicationInstance( args: ModifyReplicationInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyReplicationInstance( + modifyReplicationInstance( args: ModifyReplicationInstanceCommandInput, cb: (err: any, data?: ModifyReplicationInstanceCommandOutput) => void ): void; - public modifyReplicationInstance( + modifyReplicationInstance( args: ModifyReplicationInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyReplicationInstanceCommandOutput) => void ): void; - public modifyReplicationInstance( - args: ModifyReplicationInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyReplicationInstanceCommandOutput) => void), - cb?: (err: any, data?: ModifyReplicationInstanceCommandOutput) => void - ): Promise | void { - const command = new ModifyReplicationInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the settings for the specified replication subnet group.

- */ - public modifyReplicationSubnetGroup( + + /** + * @see {@link ModifyReplicationSubnetGroupCommand} + */ + modifyReplicationSubnetGroup( args: ModifyReplicationSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyReplicationSubnetGroup( + modifyReplicationSubnetGroup( args: ModifyReplicationSubnetGroupCommandInput, cb: (err: any, data?: ModifyReplicationSubnetGroupCommandOutput) => void ): void; - public modifyReplicationSubnetGroup( + modifyReplicationSubnetGroup( args: ModifyReplicationSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyReplicationSubnetGroupCommandOutput) => void ): void; - public modifyReplicationSubnetGroup( - args: ModifyReplicationSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyReplicationSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: ModifyReplicationSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new ModifyReplicationSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the specified replication task.

- *

You can't modify the task endpoints. The task must be stopped before you can modify it.

- *

For more information about DMS tasks, see Working with Migration Tasks in the - * Database Migration Service User Guide.

- */ - public modifyReplicationTask( + + /** + * @see {@link ModifyReplicationTaskCommand} + */ + modifyReplicationTask( args: ModifyReplicationTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyReplicationTask( + modifyReplicationTask( args: ModifyReplicationTaskCommandInput, cb: (err: any, data?: ModifyReplicationTaskCommandOutput) => void ): void; - public modifyReplicationTask( + modifyReplicationTask( args: ModifyReplicationTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyReplicationTaskCommandOutput) => void ): void; - public modifyReplicationTask( - args: ModifyReplicationTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyReplicationTaskCommandOutput) => void), - cb?: (err: any, data?: ModifyReplicationTaskCommandOutput) => void - ): Promise | void { - const command = new ModifyReplicationTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Moves a replication task from its current replication instance to a different target - * replication instance using the specified parameters. The target replication instance must - * be created with the same or later DMS version as the current replication - * instance.

- */ - public moveReplicationTask( + + /** + * @see {@link MoveReplicationTaskCommand} + */ + moveReplicationTask( args: MoveReplicationTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public moveReplicationTask( + moveReplicationTask( args: MoveReplicationTaskCommandInput, cb: (err: any, data?: MoveReplicationTaskCommandOutput) => void ): void; - public moveReplicationTask( + moveReplicationTask( args: MoveReplicationTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MoveReplicationTaskCommandOutput) => void ): void; - public moveReplicationTask( - args: MoveReplicationTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MoveReplicationTaskCommandOutput) => void), - cb?: (err: any, data?: MoveReplicationTaskCommandOutput) => void - ): Promise | void { - const command = new MoveReplicationTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Reboots a replication instance. Rebooting results in a momentary outage, until the - * replication instance becomes available again.

- */ - public rebootReplicationInstance( + + /** + * @see {@link RebootReplicationInstanceCommand} + */ + rebootReplicationInstance( args: RebootReplicationInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public rebootReplicationInstance( + rebootReplicationInstance( args: RebootReplicationInstanceCommandInput, cb: (err: any, data?: RebootReplicationInstanceCommandOutput) => void ): void; - public rebootReplicationInstance( + rebootReplicationInstance( args: RebootReplicationInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebootReplicationInstanceCommandOutput) => void ): void; - public rebootReplicationInstance( - args: RebootReplicationInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RebootReplicationInstanceCommandOutput) => void), - cb?: (err: any, data?: RebootReplicationInstanceCommandOutput) => void - ): Promise | void { - const command = new RebootReplicationInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Populates the schema for the specified endpoint. This is an asynchronous operation and - * can take several minutes. You can check the status of this operation by calling the - * DescribeRefreshSchemasStatus operation.

- */ - public refreshSchemas( + + /** + * @see {@link RefreshSchemasCommand} + */ + refreshSchemas( args: RefreshSchemasCommandInput, options?: __HttpHandlerOptions ): Promise; - public refreshSchemas( - args: RefreshSchemasCommandInput, - cb: (err: any, data?: RefreshSchemasCommandOutput) => void - ): void; - public refreshSchemas( + refreshSchemas(args: RefreshSchemasCommandInput, cb: (err: any, data?: RefreshSchemasCommandOutput) => void): void; + refreshSchemas( args: RefreshSchemasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RefreshSchemasCommandOutput) => void ): void; - public refreshSchemas( - args: RefreshSchemasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RefreshSchemasCommandOutput) => void), - cb?: (err: any, data?: RefreshSchemasCommandOutput) => void - ): Promise | void { - const command = new RefreshSchemasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Reloads the target database table with the source data.

- *

You can only use this operation with a task in the RUNNING state, otherwise the service - * will throw an InvalidResourceStateFault exception.

- */ - public reloadTables( - args: ReloadTablesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public reloadTables(args: ReloadTablesCommandInput, cb: (err: any, data?: ReloadTablesCommandOutput) => void): void; - public reloadTables( + + /** + * @see {@link ReloadTablesCommand} + */ + reloadTables(args: ReloadTablesCommandInput, options?: __HttpHandlerOptions): Promise; + reloadTables(args: ReloadTablesCommandInput, cb: (err: any, data?: ReloadTablesCommandOutput) => void): void; + reloadTables( args: ReloadTablesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReloadTablesCommandOutput) => void ): void; - public reloadTables( - args: ReloadTablesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReloadTablesCommandOutput) => void), - cb?: (err: any, data?: ReloadTablesCommandOutput) => void - ): Promise | void { - const command = new ReloadTablesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes metadata tags from an DMS resource, including replication instance, - * endpoint, subnet group, and migration task. For more information, see - * - * Tag - * - * data type description.

- */ - public removeTagsFromResource( + + /** + * @see {@link RemoveTagsFromResourceCommand} + */ + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeTagsFromResource( + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void ): void; - public removeTagsFromResource( + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void ): void; - public removeTagsFromResource( - args: RemoveTagsFromResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveTagsFromResourceCommandOutput) => void), - cb?: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void - ): Promise | void { - const command = new RemoveTagsFromResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Runs large-scale assessment (LSA) analysis on every Fleet Advisor collector in your account.

- */ - public runFleetAdvisorLsaAnalysis( + + /** + * @see {@link RunFleetAdvisorLsaAnalysisCommand} + */ + runFleetAdvisorLsaAnalysis( args: RunFleetAdvisorLsaAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public runFleetAdvisorLsaAnalysis( + runFleetAdvisorLsaAnalysis( args: RunFleetAdvisorLsaAnalysisCommandInput, cb: (err: any, data?: RunFleetAdvisorLsaAnalysisCommandOutput) => void ): void; - public runFleetAdvisorLsaAnalysis( + runFleetAdvisorLsaAnalysis( args: RunFleetAdvisorLsaAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RunFleetAdvisorLsaAnalysisCommandOutput) => void ): void; - public runFleetAdvisorLsaAnalysis( - args: RunFleetAdvisorLsaAnalysisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RunFleetAdvisorLsaAnalysisCommandOutput) => void), - cb?: (err: any, data?: RunFleetAdvisorLsaAnalysisCommandOutput) => void - ): Promise | void { - const command = new RunFleetAdvisorLsaAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts the analysis of your source database to provide recommendations of target - * engines.

- *

You can create recommendations for multiple source databases using BatchStartRecommendations.

- */ - public startRecommendations( + + /** + * @see {@link StartRecommendationsCommand} + */ + startRecommendations( args: StartRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public startRecommendations( + startRecommendations( args: StartRecommendationsCommandInput, cb: (err: any, data?: StartRecommendationsCommandOutput) => void ): void; - public startRecommendations( + startRecommendations( args: StartRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartRecommendationsCommandOutput) => void ): void; - public startRecommendations( - args: StartRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartRecommendationsCommandOutput) => void), - cb?: (err: any, data?: StartRecommendationsCommandOutput) => void - ): Promise | void { - const command = new StartRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts the replication task.

- *

For more information about DMS tasks, see Working with Migration Tasks in the - * Database Migration Service User Guide. - *

- */ - public startReplicationTask( + + /** + * @see {@link StartReplicationTaskCommand} + */ + startReplicationTask( args: StartReplicationTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public startReplicationTask( + startReplicationTask( args: StartReplicationTaskCommandInput, cb: (err: any, data?: StartReplicationTaskCommandOutput) => void ): void; - public startReplicationTask( + startReplicationTask( args: StartReplicationTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartReplicationTaskCommandOutput) => void ): void; - public startReplicationTask( - args: StartReplicationTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartReplicationTaskCommandOutput) => void), - cb?: (err: any, data?: StartReplicationTaskCommandOutput) => void - ): Promise | void { - const command = new StartReplicationTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts the replication task assessment for unsupported data types in the source - * database.

- *

You can only use this operation for a task if the following conditions are true:

- *
    - *
  • - *

    The task must be in the stopped state.

    - *
  • - *
  • - *

    The task must have successful connections to the source and target.

    - *
  • - *
- *

If either of these conditions are not met, an InvalidResourceStateFault error will result.

- *

For information about DMS task assessments, see - * Creating a task assessment report - * in the Database Migration Service User Guide.

- */ - public startReplicationTaskAssessment( + + /** + * @see {@link StartReplicationTaskAssessmentCommand} + */ + startReplicationTaskAssessment( args: StartReplicationTaskAssessmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public startReplicationTaskAssessment( + startReplicationTaskAssessment( args: StartReplicationTaskAssessmentCommandInput, cb: (err: any, data?: StartReplicationTaskAssessmentCommandOutput) => void ): void; - public startReplicationTaskAssessment( + startReplicationTaskAssessment( args: StartReplicationTaskAssessmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartReplicationTaskAssessmentCommandOutput) => void ): void; - public startReplicationTaskAssessment( - args: StartReplicationTaskAssessmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartReplicationTaskAssessmentCommandOutput) => void), - cb?: (err: any, data?: StartReplicationTaskAssessmentCommandOutput) => void - ): Promise | void { - const command = new StartReplicationTaskAssessmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a new premigration assessment run for one or more individual assessments - * of a migration task.

- *

The assessments that you can specify depend on the source and target database engine and - * the migration type defined for the given task. To run this operation, your migration task - * must already be created. After you run this operation, you can review the status of each - * individual assessment. You can also run the migration task manually after the assessment - * run and its individual assessments complete.

- */ - public startReplicationTaskAssessmentRun( + + /** + * @see {@link StartReplicationTaskAssessmentRunCommand} + */ + startReplicationTaskAssessmentRun( args: StartReplicationTaskAssessmentRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public startReplicationTaskAssessmentRun( + startReplicationTaskAssessmentRun( args: StartReplicationTaskAssessmentRunCommandInput, cb: (err: any, data?: StartReplicationTaskAssessmentRunCommandOutput) => void ): void; - public startReplicationTaskAssessmentRun( + startReplicationTaskAssessmentRun( args: StartReplicationTaskAssessmentRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartReplicationTaskAssessmentRunCommandOutput) => void ): void; - public startReplicationTaskAssessmentRun( - args: StartReplicationTaskAssessmentRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartReplicationTaskAssessmentRunCommandOutput) => void), - cb?: (err: any, data?: StartReplicationTaskAssessmentRunCommandOutput) => void - ): Promise | void { - const command = new StartReplicationTaskAssessmentRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops the replication task.

- */ - public stopReplicationTask( + + /** + * @see {@link StopReplicationTaskCommand} + */ + stopReplicationTask( args: StopReplicationTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopReplicationTask( + stopReplicationTask( args: StopReplicationTaskCommandInput, cb: (err: any, data?: StopReplicationTaskCommandOutput) => void ): void; - public stopReplicationTask( + stopReplicationTask( args: StopReplicationTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopReplicationTaskCommandOutput) => void ): void; - public stopReplicationTask( - args: StopReplicationTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopReplicationTaskCommandOutput) => void), - cb?: (err: any, data?: StopReplicationTaskCommandOutput) => void - ): Promise | void { - const command = new StopReplicationTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Tests the connection between the replication instance and the endpoint.

- */ - public testConnection( + + /** + * @see {@link TestConnectionCommand} + */ + testConnection( args: TestConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public testConnection( - args: TestConnectionCommandInput, - cb: (err: any, data?: TestConnectionCommandOutput) => void - ): void; - public testConnection( + testConnection(args: TestConnectionCommandInput, cb: (err: any, data?: TestConnectionCommandOutput) => void): void; + testConnection( args: TestConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestConnectionCommandOutput) => void ): void; - public testConnection( - args: TestConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestConnectionCommandOutput) => void), - cb?: (err: any, data?: TestConnectionCommandOutput) => void - ): Promise | void { - const command = new TestConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Migrates 10 active and enabled Amazon SNS subscriptions at a time and converts them to corresponding Amazon EventBridge rules. - * By default, this operation migrates subscriptions only when all your replication instance versions are 3.4.6 or higher. - * If any replication instances are from versions earlier than 3.4.6, the operation raises an error and tells you - * to upgrade these instances to version 3.4.6 or higher. To enable migration regardless of version, set the Force - * option to true. However, if you don't upgrade instances earlier than version 3.4.6, some types of events might not be - * available when you use Amazon EventBridge.

- *

To call this operation, make sure that you have certain permissions added to your user account. - * For more information, see Migrating event subscriptions to Amazon EventBridge - * in the Amazon Web Services Database Migration Service User Guide.

- */ - public updateSubscriptionsToEventBridge( + + /** + * @see {@link UpdateSubscriptionsToEventBridgeCommand} + */ + updateSubscriptionsToEventBridge( args: UpdateSubscriptionsToEventBridgeCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSubscriptionsToEventBridge( + updateSubscriptionsToEventBridge( args: UpdateSubscriptionsToEventBridgeCommandInput, cb: (err: any, data?: UpdateSubscriptionsToEventBridgeCommandOutput) => void ): void; - public updateSubscriptionsToEventBridge( + updateSubscriptionsToEventBridge( args: UpdateSubscriptionsToEventBridgeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSubscriptionsToEventBridgeCommandOutput) => void ): void; - public updateSubscriptionsToEventBridge( - args: UpdateSubscriptionsToEventBridgeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSubscriptionsToEventBridgeCommandOutput) => void), - cb?: (err: any, data?: UpdateSubscriptionsToEventBridgeCommandOutput) => void - ): Promise | void { - const command = new UpdateSubscriptionsToEventBridgeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Database Migration Service + *

Database Migration Service (DMS) can migrate your data to and from the most + * widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL + * Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise + * (ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as + * heterogeneous migrations between different database platforms, such as Oracle to MySQL or + * SQL Server to PostgreSQL.

+ *

For more information about DMS, see What Is Database Migration Service? + * in the Database Migration Service User Guide. + *

+ */ +export class DatabaseMigrationService extends DatabaseMigrationServiceClient implements DatabaseMigrationService {} +createAggregatedClient(commands, DatabaseMigrationService); diff --git a/clients/client-databrew/src/DataBrew.ts b/clients/client-databrew/src/DataBrew.ts index 62c16696f73d..70625301c932 100644 --- a/clients/client-databrew/src/DataBrew.ts +++ b/clients/client-databrew/src/DataBrew.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -189,1449 +190,631 @@ import { UpdateScheduleCommandInput, UpdateScheduleCommandOutput, } from "./commands/UpdateScheduleCommand"; -import { DataBrewClient } from "./DataBrewClient"; +import { DataBrewClient, DataBrewClientConfig } from "./DataBrewClient"; -/** - * @public - *

Glue DataBrew is a visual, cloud-scale data-preparation service. DataBrew - * simplifies data preparation tasks, targeting data issues that are hard to spot and - * time-consuming to fix. DataBrew empowers users of all technical levels to visualize the - * data and perform one-click data transformations, with no coding required.

- */ -export class DataBrew extends DataBrewClient { +const commands = { + BatchDeleteRecipeVersionCommand, + CreateDatasetCommand, + CreateProfileJobCommand, + CreateProjectCommand, + CreateRecipeCommand, + CreateRecipeJobCommand, + CreateRulesetCommand, + CreateScheduleCommand, + DeleteDatasetCommand, + DeleteJobCommand, + DeleteProjectCommand, + DeleteRecipeVersionCommand, + DeleteRulesetCommand, + DeleteScheduleCommand, + DescribeDatasetCommand, + DescribeJobCommand, + DescribeJobRunCommand, + DescribeProjectCommand, + DescribeRecipeCommand, + DescribeRulesetCommand, + DescribeScheduleCommand, + ListDatasetsCommand, + ListJobRunsCommand, + ListJobsCommand, + ListProjectsCommand, + ListRecipesCommand, + ListRecipeVersionsCommand, + ListRulesetsCommand, + ListSchedulesCommand, + ListTagsForResourceCommand, + PublishRecipeCommand, + SendProjectSessionActionCommand, + StartJobRunCommand, + StartProjectSessionCommand, + StopJobRunCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateDatasetCommand, + UpdateProfileJobCommand, + UpdateProjectCommand, + UpdateRecipeCommand, + UpdateRecipeJobCommand, + UpdateRulesetCommand, + UpdateScheduleCommand, +}; + +export interface DataBrew { /** - * @public - *

Deletes one or more versions of a recipe at a time.

- *

The entire request will be rejected if:

- *
    - *
  • - *

    The recipe does not exist.

    - *
  • - *
  • - *

    There is an invalid version identifier in the list of versions.

    - *
  • - *
  • - *

    The version list is empty.

    - *
  • - *
  • - *

    The version list size exceeds 50.

    - *
  • - *
  • - *

    The version list contains duplicate entries.

    - *
  • - *
- *

The request will complete successfully, but with partial failures, if:

- *
    - *
  • - *

    A version does not exist.

    - *
  • - *
  • - *

    A version is being used by a job.

    - *
  • - *
  • - *

    You specify LATEST_WORKING, but it's being used by a - * project.

    - *
  • - *
  • - *

    The version fails to be deleted.

    - *
  • - *
- *

The LATEST_WORKING version will only be deleted if the recipe has no - * other versions. If you try to delete LATEST_WORKING while other versions - * exist (or if they can't be deleted), then LATEST_WORKING will be listed as - * partial failure in the response.

+ * @see {@link BatchDeleteRecipeVersionCommand} */ - public batchDeleteRecipeVersion( + batchDeleteRecipeVersion( args: BatchDeleteRecipeVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeleteRecipeVersion( + batchDeleteRecipeVersion( args: BatchDeleteRecipeVersionCommandInput, cb: (err: any, data?: BatchDeleteRecipeVersionCommandOutput) => void ): void; - public batchDeleteRecipeVersion( + batchDeleteRecipeVersion( args: BatchDeleteRecipeVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteRecipeVersionCommandOutput) => void ): void; - public batchDeleteRecipeVersion( - args: BatchDeleteRecipeVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeleteRecipeVersionCommandOutput) => void), - cb?: (err: any, data?: BatchDeleteRecipeVersionCommandOutput) => void - ): Promise | void { - const command = new BatchDeleteRecipeVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new DataBrew dataset.

+ * @see {@link CreateDatasetCommand} */ - public createDataset( - args: CreateDatasetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createDataset( - args: CreateDatasetCommandInput, - cb: (err: any, data?: CreateDatasetCommandOutput) => void - ): void; - public createDataset( + createDataset(args: CreateDatasetCommandInput, options?: __HttpHandlerOptions): Promise; + createDataset(args: CreateDatasetCommandInput, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void; + createDataset( args: CreateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetCommandOutput) => void ): void; - public createDataset( - args: CreateDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDatasetCommandOutput) => void), - cb?: (err: any, data?: CreateDatasetCommandOutput) => void - ): Promise | void { - const command = new CreateDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new job to analyze a dataset and create its data profile.

+ * @see {@link CreateProfileJobCommand} */ - public createProfileJob( + createProfileJob( args: CreateProfileJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createProfileJob( + createProfileJob( args: CreateProfileJobCommandInput, cb: (err: any, data?: CreateProfileJobCommandOutput) => void ): void; - public createProfileJob( + createProfileJob( args: CreateProfileJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProfileJobCommandOutput) => void ): void; - public createProfileJob( - args: CreateProfileJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProfileJobCommandOutput) => void), - cb?: (err: any, data?: CreateProfileJobCommandOutput) => void - ): Promise | void { - const command = new CreateProfileJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new DataBrew project.

+ * @see {@link CreateProjectCommand} */ - public createProject( - args: CreateProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createProject( - args: CreateProjectCommandInput, - cb: (err: any, data?: CreateProjectCommandOutput) => void - ): void; - public createProject( + createProject(args: CreateProjectCommandInput, options?: __HttpHandlerOptions): Promise; + createProject(args: CreateProjectCommandInput, cb: (err: any, data?: CreateProjectCommandOutput) => void): void; + createProject( args: CreateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectCommandOutput) => void ): void; - public createProject( - args: CreateProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProjectCommandOutput) => void), - cb?: (err: any, data?: CreateProjectCommandOutput) => void - ): Promise | void { - const command = new CreateProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new DataBrew recipe.

+ * @see {@link CreateRecipeCommand} */ - public createRecipe( - args: CreateRecipeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createRecipe(args: CreateRecipeCommandInput, cb: (err: any, data?: CreateRecipeCommandOutput) => void): void; - public createRecipe( + createRecipe(args: CreateRecipeCommandInput, options?: __HttpHandlerOptions): Promise; + createRecipe(args: CreateRecipeCommandInput, cb: (err: any, data?: CreateRecipeCommandOutput) => void): void; + createRecipe( args: CreateRecipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRecipeCommandOutput) => void ): void; - public createRecipe( - args: CreateRecipeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRecipeCommandOutput) => void), - cb?: (err: any, data?: CreateRecipeCommandOutput) => void - ): Promise | void { - const command = new CreateRecipeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new job to transform input data, using steps defined in an existing Glue DataBrew recipe

+ * @see {@link CreateRecipeJobCommand} */ - public createRecipeJob( + createRecipeJob( args: CreateRecipeJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRecipeJob( - args: CreateRecipeJobCommandInput, - cb: (err: any, data?: CreateRecipeJobCommandOutput) => void - ): void; - public createRecipeJob( + createRecipeJob(args: CreateRecipeJobCommandInput, cb: (err: any, data?: CreateRecipeJobCommandOutput) => void): void; + createRecipeJob( args: CreateRecipeJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRecipeJobCommandOutput) => void ): void; - public createRecipeJob( - args: CreateRecipeJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRecipeJobCommandOutput) => void), - cb?: (err: any, data?: CreateRecipeJobCommandOutput) => void - ): Promise | void { - const command = new CreateRecipeJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new ruleset that can be used in a profile job to validate - * the data quality of a dataset.

+ * @see {@link CreateRulesetCommand} */ - public createRuleset( - args: CreateRulesetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createRuleset( - args: CreateRulesetCommandInput, - cb: (err: any, data?: CreateRulesetCommandOutput) => void - ): void; - public createRuleset( + createRuleset(args: CreateRulesetCommandInput, options?: __HttpHandlerOptions): Promise; + createRuleset(args: CreateRulesetCommandInput, cb: (err: any, data?: CreateRulesetCommandOutput) => void): void; + createRuleset( args: CreateRulesetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRulesetCommandOutput) => void ): void; - public createRuleset( - args: CreateRulesetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRulesetCommandOutput) => void), - cb?: (err: any, data?: CreateRulesetCommandOutput) => void - ): Promise | void { - const command = new CreateRulesetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific - * date and time, or at regular intervals.

+ * @see {@link CreateScheduleCommand} */ - public createSchedule( + createSchedule( args: CreateScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSchedule( - args: CreateScheduleCommandInput, - cb: (err: any, data?: CreateScheduleCommandOutput) => void - ): void; - public createSchedule( + createSchedule(args: CreateScheduleCommandInput, cb: (err: any, data?: CreateScheduleCommandOutput) => void): void; + createSchedule( args: CreateScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateScheduleCommandOutput) => void ): void; - public createSchedule( - args: CreateScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateScheduleCommandOutput) => void), - cb?: (err: any, data?: CreateScheduleCommandOutput) => void - ): Promise | void { - const command = new CreateScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a dataset from DataBrew.

+ * @see {@link DeleteDatasetCommand} */ - public deleteDataset( - args: DeleteDatasetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDataset( - args: DeleteDatasetCommandInput, - cb: (err: any, data?: DeleteDatasetCommandOutput) => void - ): void; - public deleteDataset( + deleteDataset(args: DeleteDatasetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDataset(args: DeleteDatasetCommandInput, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void; + deleteDataset( args: DeleteDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetCommandOutput) => void ): void; - public deleteDataset( - args: DeleteDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDatasetCommandOutput) => void), - cb?: (err: any, data?: DeleteDatasetCommandOutput) => void - ): Promise | void { - const command = new DeleteDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified DataBrew job.

+ * @see {@link DeleteJobCommand} */ - public deleteJob(args: DeleteJobCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteJob(args: DeleteJobCommandInput, cb: (err: any, data?: DeleteJobCommandOutput) => void): void; - public deleteJob( + deleteJob(args: DeleteJobCommandInput, options?: __HttpHandlerOptions): Promise; + deleteJob(args: DeleteJobCommandInput, cb: (err: any, data?: DeleteJobCommandOutput) => void): void; + deleteJob( args: DeleteJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteJobCommandOutput) => void ): void; - public deleteJob( - args: DeleteJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteJobCommandOutput) => void), - cb?: (err: any, data?: DeleteJobCommandOutput) => void - ): Promise | void { - const command = new DeleteJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing DataBrew project.

+ * @see {@link DeleteProjectCommand} */ - public deleteProject( - args: DeleteProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteProject( - args: DeleteProjectCommandInput, - cb: (err: any, data?: DeleteProjectCommandOutput) => void - ): void; - public deleteProject( + deleteProject(args: DeleteProjectCommandInput, options?: __HttpHandlerOptions): Promise; + deleteProject(args: DeleteProjectCommandInput, cb: (err: any, data?: DeleteProjectCommandOutput) => void): void; + deleteProject( args: DeleteProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProjectCommandOutput) => void ): void; - public deleteProject( - args: DeleteProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProjectCommandOutput) => void), - cb?: (err: any, data?: DeleteProjectCommandOutput) => void - ): Promise | void { - const command = new DeleteProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a single version of a DataBrew recipe.

+ * @see {@link DeleteRecipeVersionCommand} */ - public deleteRecipeVersion( + deleteRecipeVersion( args: DeleteRecipeVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRecipeVersion( + deleteRecipeVersion( args: DeleteRecipeVersionCommandInput, cb: (err: any, data?: DeleteRecipeVersionCommandOutput) => void ): void; - public deleteRecipeVersion( + deleteRecipeVersion( args: DeleteRecipeVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRecipeVersionCommandOutput) => void ): void; - public deleteRecipeVersion( - args: DeleteRecipeVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRecipeVersionCommandOutput) => void), - cb?: (err: any, data?: DeleteRecipeVersionCommandOutput) => void - ): Promise | void { - const command = new DeleteRecipeVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a ruleset.

+ * @see {@link DeleteRulesetCommand} */ - public deleteRuleset( - args: DeleteRulesetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteRuleset( - args: DeleteRulesetCommandInput, - cb: (err: any, data?: DeleteRulesetCommandOutput) => void - ): void; - public deleteRuleset( + deleteRuleset(args: DeleteRulesetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteRuleset(args: DeleteRulesetCommandInput, cb: (err: any, data?: DeleteRulesetCommandOutput) => void): void; + deleteRuleset( args: DeleteRulesetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRulesetCommandOutput) => void ): void; - public deleteRuleset( - args: DeleteRulesetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRulesetCommandOutput) => void), - cb?: (err: any, data?: DeleteRulesetCommandOutput) => void - ): Promise | void { - const command = new DeleteRulesetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified DataBrew schedule.

+ * @see {@link DeleteScheduleCommand} */ - public deleteSchedule( + deleteSchedule( args: DeleteScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSchedule( - args: DeleteScheduleCommandInput, - cb: (err: any, data?: DeleteScheduleCommandOutput) => void - ): void; - public deleteSchedule( + deleteSchedule(args: DeleteScheduleCommandInput, cb: (err: any, data?: DeleteScheduleCommandOutput) => void): void; + deleteSchedule( args: DeleteScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteScheduleCommandOutput) => void ): void; - public deleteSchedule( - args: DeleteScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteScheduleCommandOutput) => void), - cb?: (err: any, data?: DeleteScheduleCommandOutput) => void - ): Promise | void { - const command = new DeleteScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the definition of a specific DataBrew dataset.

+ * @see {@link DescribeDatasetCommand} */ - public describeDataset( + describeDataset( args: DescribeDatasetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDataset( - args: DescribeDatasetCommandInput, - cb: (err: any, data?: DescribeDatasetCommandOutput) => void - ): void; - public describeDataset( + describeDataset(args: DescribeDatasetCommandInput, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void; + describeDataset( args: DescribeDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetCommandOutput) => void ): void; - public describeDataset( - args: DescribeDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDatasetCommandOutput) => void), - cb?: (err: any, data?: DescribeDatasetCommandOutput) => void - ): Promise | void { - const command = new DescribeDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the definition of a specific DataBrew job.

+ * @see {@link DescribeJobCommand} */ - public describeJob(args: DescribeJobCommandInput, options?: __HttpHandlerOptions): Promise; - public describeJob(args: DescribeJobCommandInput, cb: (err: any, data?: DescribeJobCommandOutput) => void): void; - public describeJob( + describeJob(args: DescribeJobCommandInput, options?: __HttpHandlerOptions): Promise; + describeJob(args: DescribeJobCommandInput, cb: (err: any, data?: DescribeJobCommandOutput) => void): void; + describeJob( args: DescribeJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobCommandOutput) => void ): void; - public describeJob( - args: DescribeJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeJobCommandOutput) => void), - cb?: (err: any, data?: DescribeJobCommandOutput) => void - ): Promise | void { - const command = new DescribeJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Represents one run of a DataBrew job.

+ * @see {@link DescribeJobRunCommand} */ - public describeJobRun( + describeJobRun( args: DescribeJobRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeJobRun( - args: DescribeJobRunCommandInput, - cb: (err: any, data?: DescribeJobRunCommandOutput) => void - ): void; - public describeJobRun( + describeJobRun(args: DescribeJobRunCommandInput, cb: (err: any, data?: DescribeJobRunCommandOutput) => void): void; + describeJobRun( args: DescribeJobRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobRunCommandOutput) => void ): void; - public describeJobRun( - args: DescribeJobRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeJobRunCommandOutput) => void), - cb?: (err: any, data?: DescribeJobRunCommandOutput) => void - ): Promise | void { - const command = new DescribeJobRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the definition of a specific DataBrew project.

+ * @see {@link DescribeProjectCommand} */ - public describeProject( + describeProject( args: DescribeProjectCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProject( - args: DescribeProjectCommandInput, - cb: (err: any, data?: DescribeProjectCommandOutput) => void - ): void; - public describeProject( + describeProject(args: DescribeProjectCommandInput, cb: (err: any, data?: DescribeProjectCommandOutput) => void): void; + describeProject( args: DescribeProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProjectCommandOutput) => void ): void; - public describeProject( - args: DescribeProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProjectCommandOutput) => void), - cb?: (err: any, data?: DescribeProjectCommandOutput) => void - ): Promise | void { - const command = new DescribeProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the definition of a specific DataBrew recipe corresponding to a particular - * version.

+ * @see {@link DescribeRecipeCommand} */ - public describeRecipe( + describeRecipe( args: DescribeRecipeCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRecipe( - args: DescribeRecipeCommandInput, - cb: (err: any, data?: DescribeRecipeCommandOutput) => void - ): void; - public describeRecipe( + describeRecipe(args: DescribeRecipeCommandInput, cb: (err: any, data?: DescribeRecipeCommandOutput) => void): void; + describeRecipe( args: DescribeRecipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRecipeCommandOutput) => void ): void; - public describeRecipe( - args: DescribeRecipeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRecipeCommandOutput) => void), - cb?: (err: any, data?: DescribeRecipeCommandOutput) => void - ): Promise | void { - const command = new DescribeRecipeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves detailed information about the ruleset.

+ * @see {@link DescribeRulesetCommand} */ - public describeRuleset( + describeRuleset( args: DescribeRulesetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRuleset( - args: DescribeRulesetCommandInput, - cb: (err: any, data?: DescribeRulesetCommandOutput) => void - ): void; - public describeRuleset( + describeRuleset(args: DescribeRulesetCommandInput, cb: (err: any, data?: DescribeRulesetCommandOutput) => void): void; + describeRuleset( args: DescribeRulesetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRulesetCommandOutput) => void ): void; - public describeRuleset( - args: DescribeRulesetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRulesetCommandOutput) => void), - cb?: (err: any, data?: DescribeRulesetCommandOutput) => void - ): Promise | void { - const command = new DescribeRulesetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the definition of a specific DataBrew schedule.

+ * @see {@link DescribeScheduleCommand} */ - public describeSchedule( + describeSchedule( args: DescribeScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSchedule( + describeSchedule( args: DescribeScheduleCommandInput, cb: (err: any, data?: DescribeScheduleCommandOutput) => void ): void; - public describeSchedule( + describeSchedule( args: DescribeScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScheduleCommandOutput) => void ): void; - public describeSchedule( - args: DescribeScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeScheduleCommandOutput) => void), - cb?: (err: any, data?: DescribeScheduleCommandOutput) => void - ): Promise | void { - const command = new DescribeScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all of the DataBrew datasets.

+ * @see {@link ListDatasetsCommand} */ - public listDatasets( - args: ListDatasetsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void; - public listDatasets( + listDatasets(args: ListDatasetsCommandInput, options?: __HttpHandlerOptions): Promise; + listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void; + listDatasets( args: ListDatasetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetsCommandOutput) => void ): void; - public listDatasets( - args: ListDatasetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatasetsCommandOutput) => void), - cb?: (err: any, data?: ListDatasetsCommandOutput) => void - ): Promise | void { - const command = new ListDatasetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all of the previous runs of a particular DataBrew job.

+ * @see {@link ListJobRunsCommand} */ - public listJobRuns(args: ListJobRunsCommandInput, options?: __HttpHandlerOptions): Promise; - public listJobRuns(args: ListJobRunsCommandInput, cb: (err: any, data?: ListJobRunsCommandOutput) => void): void; - public listJobRuns( + listJobRuns(args: ListJobRunsCommandInput, options?: __HttpHandlerOptions): Promise; + listJobRuns(args: ListJobRunsCommandInput, cb: (err: any, data?: ListJobRunsCommandOutput) => void): void; + listJobRuns( args: ListJobRunsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobRunsCommandOutput) => void ): void; - public listJobRuns( - args: ListJobRunsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJobRunsCommandOutput) => void), - cb?: (err: any, data?: ListJobRunsCommandOutput) => void - ): Promise | void { - const command = new ListJobRunsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all of the DataBrew jobs that are defined.

+ * @see {@link ListJobsCommand} */ - public listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise; - public listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void; - public listJobs( + listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise; + listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void; + listJobs( args: ListJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobsCommandOutput) => void ): void; - public listJobs( - args: ListJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJobsCommandOutput) => void), - cb?: (err: any, data?: ListJobsCommandOutput) => void - ): Promise | void { - const command = new ListJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all of the DataBrew projects that are defined.

+ * @see {@link ListProjectsCommand} */ - public listProjects( - args: ListProjectsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void; - public listProjects( + listProjects(args: ListProjectsCommandInput, options?: __HttpHandlerOptions): Promise; + listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void; + listProjects( args: ListProjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProjectsCommandOutput) => void ): void; - public listProjects( - args: ListProjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProjectsCommandOutput) => void), - cb?: (err: any, data?: ListProjectsCommandOutput) => void - ): Promise | void { - const command = new ListProjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all of the DataBrew recipes that are defined.

+ * @see {@link ListRecipesCommand} */ - public listRecipes(args: ListRecipesCommandInput, options?: __HttpHandlerOptions): Promise; - public listRecipes(args: ListRecipesCommandInput, cb: (err: any, data?: ListRecipesCommandOutput) => void): void; - public listRecipes( + listRecipes(args: ListRecipesCommandInput, options?: __HttpHandlerOptions): Promise; + listRecipes(args: ListRecipesCommandInput, cb: (err: any, data?: ListRecipesCommandOutput) => void): void; + listRecipes( args: ListRecipesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecipesCommandOutput) => void ): void; - public listRecipes( - args: ListRecipesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRecipesCommandOutput) => void), - cb?: (err: any, data?: ListRecipesCommandOutput) => void - ): Promise | void { - const command = new ListRecipesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the versions of a particular DataBrew recipe, except for - * LATEST_WORKING.

+ * @see {@link ListRecipeVersionsCommand} */ - public listRecipeVersions( + listRecipeVersions( args: ListRecipeVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRecipeVersions( + listRecipeVersions( args: ListRecipeVersionsCommandInput, cb: (err: any, data?: ListRecipeVersionsCommandOutput) => void ): void; - public listRecipeVersions( + listRecipeVersions( args: ListRecipeVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecipeVersionsCommandOutput) => void ): void; - public listRecipeVersions( - args: ListRecipeVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRecipeVersionsCommandOutput) => void), - cb?: (err: any, data?: ListRecipeVersionsCommandOutput) => void - ): Promise | void { - const command = new ListRecipeVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all rulesets available in the current account or rulesets associated - * with a specific resource (dataset).

+ * @see {@link ListRulesetsCommand} */ - public listRulesets( - args: ListRulesetsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listRulesets(args: ListRulesetsCommandInput, cb: (err: any, data?: ListRulesetsCommandOutput) => void): void; - public listRulesets( + listRulesets(args: ListRulesetsCommandInput, options?: __HttpHandlerOptions): Promise; + listRulesets(args: ListRulesetsCommandInput, cb: (err: any, data?: ListRulesetsCommandOutput) => void): void; + listRulesets( args: ListRulesetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRulesetsCommandOutput) => void ): void; - public listRulesets( - args: ListRulesetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRulesetsCommandOutput) => void), - cb?: (err: any, data?: ListRulesetsCommandOutput) => void - ): Promise | void { - const command = new ListRulesetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the DataBrew schedules that are defined.

+ * @see {@link ListSchedulesCommand} */ - public listSchedules( - args: ListSchedulesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listSchedules( - args: ListSchedulesCommandInput, - cb: (err: any, data?: ListSchedulesCommandOutput) => void - ): void; - public listSchedules( + listSchedules(args: ListSchedulesCommandInput, options?: __HttpHandlerOptions): Promise; + listSchedules(args: ListSchedulesCommandInput, cb: (err: any, data?: ListSchedulesCommandOutput) => void): void; + listSchedules( args: ListSchedulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSchedulesCommandOutput) => void ): void; - public listSchedules( - args: ListSchedulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSchedulesCommandOutput) => void), - cb?: (err: any, data?: ListSchedulesCommandOutput) => void - ): Promise | void { - const command = new ListSchedulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the tags for a DataBrew resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Publishes a new version of a DataBrew recipe.

+ * @see {@link PublishRecipeCommand} */ - public publishRecipe( - args: PublishRecipeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public publishRecipe( - args: PublishRecipeCommandInput, - cb: (err: any, data?: PublishRecipeCommandOutput) => void - ): void; - public publishRecipe( + publishRecipe(args: PublishRecipeCommandInput, options?: __HttpHandlerOptions): Promise; + publishRecipe(args: PublishRecipeCommandInput, cb: (err: any, data?: PublishRecipeCommandOutput) => void): void; + publishRecipe( args: PublishRecipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishRecipeCommandOutput) => void ): void; - public publishRecipe( - args: PublishRecipeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PublishRecipeCommandOutput) => void), - cb?: (err: any, data?: PublishRecipeCommandOutput) => void - ): Promise | void { - const command = new PublishRecipeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Performs a recipe step within an interactive DataBrew session that's currently - * open.

+ * @see {@link SendProjectSessionActionCommand} */ - public sendProjectSessionAction( + sendProjectSessionAction( args: SendProjectSessionActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendProjectSessionAction( + sendProjectSessionAction( args: SendProjectSessionActionCommandInput, cb: (err: any, data?: SendProjectSessionActionCommandOutput) => void ): void; - public sendProjectSessionAction( + sendProjectSessionAction( args: SendProjectSessionActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendProjectSessionActionCommandOutput) => void ): void; - public sendProjectSessionAction( - args: SendProjectSessionActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendProjectSessionActionCommandOutput) => void), - cb?: (err: any, data?: SendProjectSessionActionCommandOutput) => void - ): Promise | void { - const command = new SendProjectSessionActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Runs a DataBrew job.

+ * @see {@link StartJobRunCommand} */ - public startJobRun(args: StartJobRunCommandInput, options?: __HttpHandlerOptions): Promise; - public startJobRun(args: StartJobRunCommandInput, cb: (err: any, data?: StartJobRunCommandOutput) => void): void; - public startJobRun( + startJobRun(args: StartJobRunCommandInput, options?: __HttpHandlerOptions): Promise; + startJobRun(args: StartJobRunCommandInput, cb: (err: any, data?: StartJobRunCommandOutput) => void): void; + startJobRun( args: StartJobRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartJobRunCommandOutput) => void ): void; - public startJobRun( - args: StartJobRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartJobRunCommandOutput) => void), - cb?: (err: any, data?: StartJobRunCommandOutput) => void - ): Promise | void { - const command = new StartJobRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an interactive session, enabling you to manipulate data in a DataBrew - * project.

+ * @see {@link StartProjectSessionCommand} */ - public startProjectSession( + startProjectSession( args: StartProjectSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startProjectSession( + startProjectSession( args: StartProjectSessionCommandInput, cb: (err: any, data?: StartProjectSessionCommandOutput) => void ): void; - public startProjectSession( + startProjectSession( args: StartProjectSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartProjectSessionCommandOutput) => void ): void; - public startProjectSession( - args: StartProjectSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartProjectSessionCommandOutput) => void), - cb?: (err: any, data?: StartProjectSessionCommandOutput) => void - ): Promise | void { - const command = new StartProjectSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops a particular run of a job.

+ * @see {@link StopJobRunCommand} */ - public stopJobRun(args: StopJobRunCommandInput, options?: __HttpHandlerOptions): Promise; - public stopJobRun(args: StopJobRunCommandInput, cb: (err: any, data?: StopJobRunCommandOutput) => void): void; - public stopJobRun( + stopJobRun(args: StopJobRunCommandInput, options?: __HttpHandlerOptions): Promise; + stopJobRun(args: StopJobRunCommandInput, cb: (err: any, data?: StopJobRunCommandOutput) => void): void; + stopJobRun( args: StopJobRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopJobRunCommandOutput) => void ): void; - public stopJobRun( - args: StopJobRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopJobRunCommandOutput) => void), - cb?: (err: any, data?: StopJobRunCommandOutput) => void - ): Promise | void { - const command = new StopJobRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or - * schedule.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes metadata tags from a DataBrew resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the definition of an existing DataBrew dataset.

+ * @see {@link UpdateDatasetCommand} */ - public updateDataset( - args: UpdateDatasetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateDataset( - args: UpdateDatasetCommandInput, - cb: (err: any, data?: UpdateDatasetCommandOutput) => void - ): void; - public updateDataset( + updateDataset(args: UpdateDatasetCommandInput, options?: __HttpHandlerOptions): Promise; + updateDataset(args: UpdateDatasetCommandInput, cb: (err: any, data?: UpdateDatasetCommandOutput) => void): void; + updateDataset( args: UpdateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDatasetCommandOutput) => void ): void; - public updateDataset( - args: UpdateDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDatasetCommandOutput) => void), - cb?: (err: any, data?: UpdateDatasetCommandOutput) => void - ): Promise | void { - const command = new UpdateDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the definition of an existing profile job.

+ * @see {@link UpdateProfileJobCommand} */ - public updateProfileJob( + updateProfileJob( args: UpdateProfileJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateProfileJob( + updateProfileJob( args: UpdateProfileJobCommandInput, cb: (err: any, data?: UpdateProfileJobCommandOutput) => void ): void; - public updateProfileJob( + updateProfileJob( args: UpdateProfileJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProfileJobCommandOutput) => void ): void; - public updateProfileJob( - args: UpdateProfileJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProfileJobCommandOutput) => void), - cb?: (err: any, data?: UpdateProfileJobCommandOutput) => void - ): Promise | void { - const command = new UpdateProfileJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the definition of an existing DataBrew project.

+ * @see {@link UpdateProjectCommand} */ - public updateProject( - args: UpdateProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateProject( - args: UpdateProjectCommandInput, - cb: (err: any, data?: UpdateProjectCommandOutput) => void - ): void; - public updateProject( + updateProject(args: UpdateProjectCommandInput, options?: __HttpHandlerOptions): Promise; + updateProject(args: UpdateProjectCommandInput, cb: (err: any, data?: UpdateProjectCommandOutput) => void): void; + updateProject( args: UpdateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProjectCommandOutput) => void ): void; - public updateProject( - args: UpdateProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProjectCommandOutput) => void), - cb?: (err: any, data?: UpdateProjectCommandOutput) => void - ): Promise | void { - const command = new UpdateProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the definition of the LATEST_WORKING version of a DataBrew - * recipe.

+ * @see {@link UpdateRecipeCommand} */ - public updateRecipe( - args: UpdateRecipeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateRecipe(args: UpdateRecipeCommandInput, cb: (err: any, data?: UpdateRecipeCommandOutput) => void): void; - public updateRecipe( + updateRecipe(args: UpdateRecipeCommandInput, options?: __HttpHandlerOptions): Promise; + updateRecipe(args: UpdateRecipeCommandInput, cb: (err: any, data?: UpdateRecipeCommandOutput) => void): void; + updateRecipe( args: UpdateRecipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRecipeCommandOutput) => void ): void; - public updateRecipe( - args: UpdateRecipeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRecipeCommandOutput) => void), - cb?: (err: any, data?: UpdateRecipeCommandOutput) => void - ): Promise | void { - const command = new UpdateRecipeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the definition of an existing DataBrew recipe job.

+ * @see {@link UpdateRecipeJobCommand} */ - public updateRecipeJob( + updateRecipeJob( args: UpdateRecipeJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRecipeJob( - args: UpdateRecipeJobCommandInput, - cb: (err: any, data?: UpdateRecipeJobCommandOutput) => void - ): void; - public updateRecipeJob( + updateRecipeJob(args: UpdateRecipeJobCommandInput, cb: (err: any, data?: UpdateRecipeJobCommandOutput) => void): void; + updateRecipeJob( args: UpdateRecipeJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRecipeJobCommandOutput) => void ): void; - public updateRecipeJob( - args: UpdateRecipeJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRecipeJobCommandOutput) => void), - cb?: (err: any, data?: UpdateRecipeJobCommandOutput) => void - ): Promise | void { - const command = new UpdateRecipeJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates specified ruleset.

+ * @see {@link UpdateRulesetCommand} */ - public updateRuleset( - args: UpdateRulesetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateRuleset( - args: UpdateRulesetCommandInput, - cb: (err: any, data?: UpdateRulesetCommandOutput) => void - ): void; - public updateRuleset( + updateRuleset(args: UpdateRulesetCommandInput, options?: __HttpHandlerOptions): Promise; + updateRuleset(args: UpdateRulesetCommandInput, cb: (err: any, data?: UpdateRulesetCommandOutput) => void): void; + updateRuleset( args: UpdateRulesetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRulesetCommandOutput) => void ): void; - public updateRuleset( - args: UpdateRulesetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRulesetCommandOutput) => void), - cb?: (err: any, data?: UpdateRulesetCommandOutput) => void - ): Promise | void { - const command = new UpdateRulesetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the definition of an existing DataBrew schedule.

+ * @see {@link UpdateScheduleCommand} */ - public updateSchedule( + updateSchedule( args: UpdateScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSchedule( - args: UpdateScheduleCommandInput, - cb: (err: any, data?: UpdateScheduleCommandOutput) => void - ): void; - public updateSchedule( + updateSchedule(args: UpdateScheduleCommandInput, cb: (err: any, data?: UpdateScheduleCommandOutput) => void): void; + updateSchedule( args: UpdateScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateScheduleCommandOutput) => void ): void; - public updateSchedule( - args: UpdateScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateScheduleCommandOutput) => void), - cb?: (err: any, data?: UpdateScheduleCommandOutput) => void - ): Promise | void { - const command = new UpdateScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Glue DataBrew is a visual, cloud-scale data-preparation service. DataBrew + * simplifies data preparation tasks, targeting data issues that are hard to spot and + * time-consuming to fix. DataBrew empowers users of all technical levels to visualize the + * data and perform one-click data transformations, with no coding required.

+ */ +export class DataBrew extends DataBrewClient implements DataBrew {} +createAggregatedClient(commands, DataBrew); diff --git a/clients/client-dataexchange/src/DataExchange.ts b/clients/client-dataexchange/src/DataExchange.ts index de442b91f2fc..e039e00c888a 100644 --- a/clients/client-dataexchange/src/DataExchange.ts +++ b/clients/client-dataexchange/src/DataExchange.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { CancelJobCommand, CancelJobCommandInput, CancelJobCommandOutput } from "./commands/CancelJobCommand"; @@ -102,910 +103,436 @@ import { UpdateRevisionCommandInput, UpdateRevisionCommandOutput, } from "./commands/UpdateRevisionCommand"; -import { DataExchangeClient } from "./DataExchangeClient"; +import { DataExchangeClient, DataExchangeClientConfig } from "./DataExchangeClient"; -/** - * @public - *

AWS Data Exchange is a service that makes it easy for AWS customers to exchange data in the cloud. You can use the AWS Data Exchange APIs to create, update, manage, and access file-based data set in the AWS Cloud.

- *

As a subscriber, you can view and access the data sets that you have an entitlement to through - * a subscription. You can use the APIs to download or copy your entitled data sets to Amazon - * Simple Storage Service (Amazon S3) for use across a variety of AWS analytics and machine - * learning services.

- *

As a provider, you can create and manage your data sets that you would like to publish to a - * product. Being able to package and provide your data sets into products requires a few - * steps to determine eligibility. For more information, visit the AWS Data Exchange - * User Guide.

- *

A data set is a collection of data that can be changed or updated over time. Data sets can be - * updated using revisions, which represent a new version or incremental change to a data set. - * A revision contains one or more assets. An asset in AWS Data Exchange is a piece of data - * that can be stored as an Amazon S3 object, Redshift datashare, API Gateway API, AWS Lake - * Formation data permission, or Amazon S3 data access. The asset can be a structured data - * file, an image file, or some other data file. Jobs are asynchronous import or export - * operations used to create or copy assets.

- */ -export class DataExchange extends DataExchangeClient { +const commands = { + CancelJobCommand, + CreateDataSetCommand, + CreateEventActionCommand, + CreateJobCommand, + CreateRevisionCommand, + DeleteAssetCommand, + DeleteDataSetCommand, + DeleteEventActionCommand, + DeleteRevisionCommand, + GetAssetCommand, + GetDataSetCommand, + GetEventActionCommand, + GetJobCommand, + GetRevisionCommand, + ListDataSetRevisionsCommand, + ListDataSetsCommand, + ListEventActionsCommand, + ListJobsCommand, + ListRevisionAssetsCommand, + ListTagsForResourceCommand, + RevokeRevisionCommand, + SendApiAssetCommand, + StartJobCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAssetCommand, + UpdateDataSetCommand, + UpdateEventActionCommand, + UpdateRevisionCommand, +}; + +export interface DataExchange { /** - * @public - *

This operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.

+ * @see {@link CancelJobCommand} */ - public cancelJob(args: CancelJobCommandInput, options?: __HttpHandlerOptions): Promise; - public cancelJob(args: CancelJobCommandInput, cb: (err: any, data?: CancelJobCommandOutput) => void): void; - public cancelJob( + cancelJob(args: CancelJobCommandInput, options?: __HttpHandlerOptions): Promise; + cancelJob(args: CancelJobCommandInput, cb: (err: any, data?: CancelJobCommandOutput) => void): void; + cancelJob( args: CancelJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelJobCommandOutput) => void ): void; - public cancelJob( - args: CancelJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelJobCommandOutput) => void), - cb?: (err: any, data?: CancelJobCommandOutput) => void - ): Promise | void { - const command = new CancelJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation creates a data set.

+ * @see {@link CreateDataSetCommand} */ - public createDataSet( - args: CreateDataSetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createDataSet( - args: CreateDataSetCommandInput, - cb: (err: any, data?: CreateDataSetCommandOutput) => void - ): void; - public createDataSet( + createDataSet(args: CreateDataSetCommandInput, options?: __HttpHandlerOptions): Promise; + createDataSet(args: CreateDataSetCommandInput, cb: (err: any, data?: CreateDataSetCommandOutput) => void): void; + createDataSet( args: CreateDataSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataSetCommandOutput) => void ): void; - public createDataSet( - args: CreateDataSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDataSetCommandOutput) => void), - cb?: (err: any, data?: CreateDataSetCommandOutput) => void - ): Promise | void { - const command = new CreateDataSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation creates an event action.

+ * @see {@link CreateEventActionCommand} */ - public createEventAction( + createEventAction( args: CreateEventActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEventAction( + createEventAction( args: CreateEventActionCommandInput, cb: (err: any, data?: CreateEventActionCommandOutput) => void ): void; - public createEventAction( + createEventAction( args: CreateEventActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEventActionCommandOutput) => void ): void; - public createEventAction( - args: CreateEventActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEventActionCommandOutput) => void), - cb?: (err: any, data?: CreateEventActionCommandOutput) => void - ): Promise | void { - const command = new CreateEventActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation creates a job.

+ * @see {@link CreateJobCommand} */ - public createJob(args: CreateJobCommandInput, options?: __HttpHandlerOptions): Promise; - public createJob(args: CreateJobCommandInput, cb: (err: any, data?: CreateJobCommandOutput) => void): void; - public createJob( + createJob(args: CreateJobCommandInput, options?: __HttpHandlerOptions): Promise; + createJob(args: CreateJobCommandInput, cb: (err: any, data?: CreateJobCommandOutput) => void): void; + createJob( args: CreateJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateJobCommandOutput) => void ): void; - public createJob( - args: CreateJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateJobCommandOutput) => void), - cb?: (err: any, data?: CreateJobCommandOutput) => void - ): Promise | void { - const command = new CreateJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation creates a revision for a data set.

+ * @see {@link CreateRevisionCommand} */ - public createRevision( + createRevision( args: CreateRevisionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRevision( - args: CreateRevisionCommandInput, - cb: (err: any, data?: CreateRevisionCommandOutput) => void - ): void; - public createRevision( + createRevision(args: CreateRevisionCommandInput, cb: (err: any, data?: CreateRevisionCommandOutput) => void): void; + createRevision( args: CreateRevisionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRevisionCommandOutput) => void ): void; - public createRevision( - args: CreateRevisionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRevisionCommandOutput) => void), - cb?: (err: any, data?: CreateRevisionCommandOutput) => void - ): Promise | void { - const command = new CreateRevisionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation deletes an asset.

+ * @see {@link DeleteAssetCommand} */ - public deleteAsset(args: DeleteAssetCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteAsset(args: DeleteAssetCommandInput, cb: (err: any, data?: DeleteAssetCommandOutput) => void): void; - public deleteAsset( + deleteAsset(args: DeleteAssetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteAsset(args: DeleteAssetCommandInput, cb: (err: any, data?: DeleteAssetCommandOutput) => void): void; + deleteAsset( args: DeleteAssetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAssetCommandOutput) => void ): void; - public deleteAsset( - args: DeleteAssetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAssetCommandOutput) => void), - cb?: (err: any, data?: DeleteAssetCommandOutput) => void - ): Promise | void { - const command = new DeleteAssetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation deletes a data set.

+ * @see {@link DeleteDataSetCommand} */ - public deleteDataSet( - args: DeleteDataSetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDataSet( - args: DeleteDataSetCommandInput, - cb: (err: any, data?: DeleteDataSetCommandOutput) => void - ): void; - public deleteDataSet( + deleteDataSet(args: DeleteDataSetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDataSet(args: DeleteDataSetCommandInput, cb: (err: any, data?: DeleteDataSetCommandOutput) => void): void; + deleteDataSet( args: DeleteDataSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataSetCommandOutput) => void ): void; - public deleteDataSet( - args: DeleteDataSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDataSetCommandOutput) => void), - cb?: (err: any, data?: DeleteDataSetCommandOutput) => void - ): Promise | void { - const command = new DeleteDataSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation deletes the event action.

+ * @see {@link DeleteEventActionCommand} */ - public deleteEventAction( + deleteEventAction( args: DeleteEventActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEventAction( + deleteEventAction( args: DeleteEventActionCommandInput, cb: (err: any, data?: DeleteEventActionCommandOutput) => void ): void; - public deleteEventAction( + deleteEventAction( args: DeleteEventActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventActionCommandOutput) => void ): void; - public deleteEventAction( - args: DeleteEventActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEventActionCommandOutput) => void), - cb?: (err: any, data?: DeleteEventActionCommandOutput) => void - ): Promise | void { - const command = new DeleteEventActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation deletes a revision.

+ * @see {@link DeleteRevisionCommand} */ - public deleteRevision( + deleteRevision( args: DeleteRevisionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRevision( - args: DeleteRevisionCommandInput, - cb: (err: any, data?: DeleteRevisionCommandOutput) => void - ): void; - public deleteRevision( + deleteRevision(args: DeleteRevisionCommandInput, cb: (err: any, data?: DeleteRevisionCommandOutput) => void): void; + deleteRevision( args: DeleteRevisionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRevisionCommandOutput) => void ): void; - public deleteRevision( - args: DeleteRevisionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRevisionCommandOutput) => void), - cb?: (err: any, data?: DeleteRevisionCommandOutput) => void - ): Promise | void { - const command = new DeleteRevisionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation returns information about an asset.

+ * @see {@link GetAssetCommand} */ - public getAsset(args: GetAssetCommandInput, options?: __HttpHandlerOptions): Promise; - public getAsset(args: GetAssetCommandInput, cb: (err: any, data?: GetAssetCommandOutput) => void): void; - public getAsset( + getAsset(args: GetAssetCommandInput, options?: __HttpHandlerOptions): Promise; + getAsset(args: GetAssetCommandInput, cb: (err: any, data?: GetAssetCommandOutput) => void): void; + getAsset( args: GetAssetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAssetCommandOutput) => void ): void; - public getAsset( - args: GetAssetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAssetCommandOutput) => void), - cb?: (err: any, data?: GetAssetCommandOutput) => void - ): Promise | void { - const command = new GetAssetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation returns information about a data set.

+ * @see {@link GetDataSetCommand} */ - public getDataSet(args: GetDataSetCommandInput, options?: __HttpHandlerOptions): Promise; - public getDataSet(args: GetDataSetCommandInput, cb: (err: any, data?: GetDataSetCommandOutput) => void): void; - public getDataSet( + getDataSet(args: GetDataSetCommandInput, options?: __HttpHandlerOptions): Promise; + getDataSet(args: GetDataSetCommandInput, cb: (err: any, data?: GetDataSetCommandOutput) => void): void; + getDataSet( args: GetDataSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataSetCommandOutput) => void ): void; - public getDataSet( - args: GetDataSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDataSetCommandOutput) => void), - cb?: (err: any, data?: GetDataSetCommandOutput) => void - ): Promise | void { - const command = new GetDataSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation retrieves information about an event action.

+ * @see {@link GetEventActionCommand} */ - public getEventAction( + getEventAction( args: GetEventActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEventAction( - args: GetEventActionCommandInput, - cb: (err: any, data?: GetEventActionCommandOutput) => void - ): void; - public getEventAction( + getEventAction(args: GetEventActionCommandInput, cb: (err: any, data?: GetEventActionCommandOutput) => void): void; + getEventAction( args: GetEventActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEventActionCommandOutput) => void ): void; - public getEventAction( - args: GetEventActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEventActionCommandOutput) => void), - cb?: (err: any, data?: GetEventActionCommandOutput) => void - ): Promise | void { - const command = new GetEventActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation returns information about a job.

+ * @see {@link GetJobCommand} */ - public getJob(args: GetJobCommandInput, options?: __HttpHandlerOptions): Promise; - public getJob(args: GetJobCommandInput, cb: (err: any, data?: GetJobCommandOutput) => void): void; - public getJob( + getJob(args: GetJobCommandInput, options?: __HttpHandlerOptions): Promise; + getJob(args: GetJobCommandInput, cb: (err: any, data?: GetJobCommandOutput) => void): void; + getJob( args: GetJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobCommandOutput) => void ): void; - public getJob( - args: GetJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetJobCommandOutput) => void), - cb?: (err: any, data?: GetJobCommandOutput) => void - ): Promise | void { - const command = new GetJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation returns information about a revision.

+ * @see {@link GetRevisionCommand} */ - public getRevision(args: GetRevisionCommandInput, options?: __HttpHandlerOptions): Promise; - public getRevision(args: GetRevisionCommandInput, cb: (err: any, data?: GetRevisionCommandOutput) => void): void; - public getRevision( + getRevision(args: GetRevisionCommandInput, options?: __HttpHandlerOptions): Promise; + getRevision(args: GetRevisionCommandInput, cb: (err: any, data?: GetRevisionCommandOutput) => void): void; + getRevision( args: GetRevisionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRevisionCommandOutput) => void ): void; - public getRevision( - args: GetRevisionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRevisionCommandOutput) => void), - cb?: (err: any, data?: GetRevisionCommandOutput) => void - ): Promise | void { - const command = new GetRevisionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation lists a data set's revisions sorted by CreatedAt in descending order.

+ * @see {@link ListDataSetRevisionsCommand} */ - public listDataSetRevisions( + listDataSetRevisions( args: ListDataSetRevisionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDataSetRevisions( + listDataSetRevisions( args: ListDataSetRevisionsCommandInput, cb: (err: any, data?: ListDataSetRevisionsCommandOutput) => void ): void; - public listDataSetRevisions( + listDataSetRevisions( args: ListDataSetRevisionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataSetRevisionsCommandOutput) => void ): void; - public listDataSetRevisions( - args: ListDataSetRevisionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDataSetRevisionsCommandOutput) => void), - cb?: (err: any, data?: ListDataSetRevisionsCommandOutput) => void - ): Promise | void { - const command = new ListDataSetRevisionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation lists your data sets. When listing by origin OWNED, results are sorted by CreatedAt in descending order. When listing by origin ENTITLED, there is no order and the maxResults parameter is ignored.

+ * @see {@link ListDataSetsCommand} */ - public listDataSets( - args: ListDataSetsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listDataSets(args: ListDataSetsCommandInput, cb: (err: any, data?: ListDataSetsCommandOutput) => void): void; - public listDataSets( + listDataSets(args: ListDataSetsCommandInput, options?: __HttpHandlerOptions): Promise; + listDataSets(args: ListDataSetsCommandInput, cb: (err: any, data?: ListDataSetsCommandOutput) => void): void; + listDataSets( args: ListDataSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataSetsCommandOutput) => void ): void; - public listDataSets( - args: ListDataSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDataSetsCommandOutput) => void), - cb?: (err: any, data?: ListDataSetsCommandOutput) => void - ): Promise | void { - const command = new ListDataSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation lists your event actions.

+ * @see {@link ListEventActionsCommand} */ - public listEventActions( + listEventActions( args: ListEventActionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEventActions( + listEventActions( args: ListEventActionsCommandInput, cb: (err: any, data?: ListEventActionsCommandOutput) => void ): void; - public listEventActions( + listEventActions( args: ListEventActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventActionsCommandOutput) => void ): void; - public listEventActions( - args: ListEventActionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEventActionsCommandOutput) => void), - cb?: (err: any, data?: ListEventActionsCommandOutput) => void - ): Promise | void { - const command = new ListEventActionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation lists your jobs sorted by CreatedAt in descending order.

+ * @see {@link ListJobsCommand} */ - public listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise; - public listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void; - public listJobs( + listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise; + listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void; + listJobs( args: ListJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobsCommandOutput) => void ): void; - public listJobs( - args: ListJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJobsCommandOutput) => void), - cb?: (err: any, data?: ListJobsCommandOutput) => void - ): Promise | void { - const command = new ListJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation lists a revision's assets sorted alphabetically in descending order.

+ * @see {@link ListRevisionAssetsCommand} */ - public listRevisionAssets( + listRevisionAssets( args: ListRevisionAssetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRevisionAssets( + listRevisionAssets( args: ListRevisionAssetsCommandInput, cb: (err: any, data?: ListRevisionAssetsCommandOutput) => void ): void; - public listRevisionAssets( + listRevisionAssets( args: ListRevisionAssetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRevisionAssetsCommandOutput) => void ): void; - public listRevisionAssets( - args: ListRevisionAssetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRevisionAssetsCommandOutput) => void), - cb?: (err: any, data?: ListRevisionAssetsCommandOutput) => void - ): Promise | void { - const command = new ListRevisionAssetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation lists the tags on the resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation revokes subscribers' access to a revision.

+ * @see {@link RevokeRevisionCommand} */ - public revokeRevision( + revokeRevision( args: RevokeRevisionCommandInput, options?: __HttpHandlerOptions ): Promise; - public revokeRevision( - args: RevokeRevisionCommandInput, - cb: (err: any, data?: RevokeRevisionCommandOutput) => void - ): void; - public revokeRevision( + revokeRevision(args: RevokeRevisionCommandInput, cb: (err: any, data?: RevokeRevisionCommandOutput) => void): void; + revokeRevision( args: RevokeRevisionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeRevisionCommandOutput) => void ): void; - public revokeRevision( - args: RevokeRevisionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RevokeRevisionCommandOutput) => void), - cb?: (err: any, data?: RevokeRevisionCommandOutput) => void - ): Promise | void { - const command = new RevokeRevisionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation invokes an API Gateway API asset. The request is proxied to the provider’s API Gateway API.

+ * @see {@link SendApiAssetCommand} */ - public sendApiAsset( - args: SendApiAssetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public sendApiAsset(args: SendApiAssetCommandInput, cb: (err: any, data?: SendApiAssetCommandOutput) => void): void; - public sendApiAsset( + sendApiAsset(args: SendApiAssetCommandInput, options?: __HttpHandlerOptions): Promise; + sendApiAsset(args: SendApiAssetCommandInput, cb: (err: any, data?: SendApiAssetCommandOutput) => void): void; + sendApiAsset( args: SendApiAssetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendApiAssetCommandOutput) => void ): void; - public sendApiAsset( - args: SendApiAssetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendApiAssetCommandOutput) => void), - cb?: (err: any, data?: SendApiAssetCommandOutput) => void - ): Promise | void { - const command = new SendApiAssetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation starts a job.

+ * @see {@link StartJobCommand} */ - public startJob(args: StartJobCommandInput, options?: __HttpHandlerOptions): Promise; - public startJob(args: StartJobCommandInput, cb: (err: any, data?: StartJobCommandOutput) => void): void; - public startJob( + startJob(args: StartJobCommandInput, options?: __HttpHandlerOptions): Promise; + startJob(args: StartJobCommandInput, cb: (err: any, data?: StartJobCommandOutput) => void): void; + startJob( args: StartJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartJobCommandOutput) => void ): void; - public startJob( - args: StartJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartJobCommandOutput) => void), - cb?: (err: any, data?: StartJobCommandOutput) => void - ): Promise | void { - const command = new StartJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation tags a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation removes one or more tags from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation updates an asset.

+ * @see {@link UpdateAssetCommand} */ - public updateAsset(args: UpdateAssetCommandInput, options?: __HttpHandlerOptions): Promise; - public updateAsset(args: UpdateAssetCommandInput, cb: (err: any, data?: UpdateAssetCommandOutput) => void): void; - public updateAsset( + updateAsset(args: UpdateAssetCommandInput, options?: __HttpHandlerOptions): Promise; + updateAsset(args: UpdateAssetCommandInput, cb: (err: any, data?: UpdateAssetCommandOutput) => void): void; + updateAsset( args: UpdateAssetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAssetCommandOutput) => void ): void; - public updateAsset( - args: UpdateAssetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAssetCommandOutput) => void), - cb?: (err: any, data?: UpdateAssetCommandOutput) => void - ): Promise | void { - const command = new UpdateAssetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation updates a data set.

+ * @see {@link UpdateDataSetCommand} */ - public updateDataSet( - args: UpdateDataSetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateDataSet( - args: UpdateDataSetCommandInput, - cb: (err: any, data?: UpdateDataSetCommandOutput) => void - ): void; - public updateDataSet( + updateDataSet(args: UpdateDataSetCommandInput, options?: __HttpHandlerOptions): Promise; + updateDataSet(args: UpdateDataSetCommandInput, cb: (err: any, data?: UpdateDataSetCommandOutput) => void): void; + updateDataSet( args: UpdateDataSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDataSetCommandOutput) => void ): void; - public updateDataSet( - args: UpdateDataSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDataSetCommandOutput) => void), - cb?: (err: any, data?: UpdateDataSetCommandOutput) => void - ): Promise | void { - const command = new UpdateDataSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation updates the event action.

+ * @see {@link UpdateEventActionCommand} */ - public updateEventAction( + updateEventAction( args: UpdateEventActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEventAction( + updateEventAction( args: UpdateEventActionCommandInput, cb: (err: any, data?: UpdateEventActionCommandOutput) => void ): void; - public updateEventAction( + updateEventAction( args: UpdateEventActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEventActionCommandOutput) => void ): void; - public updateEventAction( - args: UpdateEventActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEventActionCommandOutput) => void), - cb?: (err: any, data?: UpdateEventActionCommandOutput) => void - ): Promise | void { - const command = new UpdateEventActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation updates a revision.

+ * @see {@link UpdateRevisionCommand} */ - public updateRevision( + updateRevision( args: UpdateRevisionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRevision( - args: UpdateRevisionCommandInput, - cb: (err: any, data?: UpdateRevisionCommandOutput) => void - ): void; - public updateRevision( + updateRevision(args: UpdateRevisionCommandInput, cb: (err: any, data?: UpdateRevisionCommandOutput) => void): void; + updateRevision( args: UpdateRevisionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRevisionCommandOutput) => void ): void; - public updateRevision( - args: UpdateRevisionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRevisionCommandOutput) => void), - cb?: (err: any, data?: UpdateRevisionCommandOutput) => void - ): Promise | void { - const command = new UpdateRevisionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

AWS Data Exchange is a service that makes it easy for AWS customers to exchange data in the cloud. You can use the AWS Data Exchange APIs to create, update, manage, and access file-based data set in the AWS Cloud.

+ *

As a subscriber, you can view and access the data sets that you have an entitlement to through + * a subscription. You can use the APIs to download or copy your entitled data sets to Amazon + * Simple Storage Service (Amazon S3) for use across a variety of AWS analytics and machine + * learning services.

+ *

As a provider, you can create and manage your data sets that you would like to publish to a + * product. Being able to package and provide your data sets into products requires a few + * steps to determine eligibility. For more information, visit the AWS Data Exchange + * User Guide.

+ *

A data set is a collection of data that can be changed or updated over time. Data sets can be + * updated using revisions, which represent a new version or incremental change to a data set. + * A revision contains one or more assets. An asset in AWS Data Exchange is a piece of data + * that can be stored as an Amazon S3 object, Redshift datashare, API Gateway API, AWS Lake + * Formation data permission, or Amazon S3 data access. The asset can be a structured data + * file, an image file, or some other data file. Jobs are asynchronous import or export + * operations used to create or copy assets.

+ */ +export class DataExchange extends DataExchangeClient implements DataExchange {} +createAggregatedClient(commands, DataExchange); diff --git a/clients/client-datasync/src/DataSync.ts b/clients/client-datasync/src/DataSync.ts index 265df05c1d4d..fbd118bf36b8 100644 --- a/clients/client-datasync/src/DataSync.ts +++ b/clients/client-datasync/src/DataSync.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -185,1486 +186,734 @@ import { UpdateTaskExecutionCommandInput, UpdateTaskExecutionCommandOutput, } from "./commands/UpdateTaskExecutionCommand"; -import { DataSyncClient } from "./DataSyncClient"; +import { DataSyncClient, DataSyncClientConfig } from "./DataSyncClient"; -/** - * @public - * DataSync - *

DataSync is a managed data transfer service that makes it simpler for you - * to automate moving data between on-premises storage and Amazon Web Services storage services. You also can use DataSync to transfer data between other cloud providers and Amazon Web Services storage services.

- *

This API interface reference includes documentation for using DataSync - * programmatically. For complete information, see the - * DataSync User - * Guide - * .

- */ -export class DataSync extends DataSyncClient { +const commands = { + CancelTaskExecutionCommand, + CreateAgentCommand, + CreateLocationEfsCommand, + CreateLocationFsxLustreCommand, + CreateLocationFsxOntapCommand, + CreateLocationFsxOpenZfsCommand, + CreateLocationFsxWindowsCommand, + CreateLocationHdfsCommand, + CreateLocationNfsCommand, + CreateLocationObjectStorageCommand, + CreateLocationS3Command, + CreateLocationSmbCommand, + CreateTaskCommand, + DeleteAgentCommand, + DeleteLocationCommand, + DeleteTaskCommand, + DescribeAgentCommand, + DescribeLocationEfsCommand, + DescribeLocationFsxLustreCommand, + DescribeLocationFsxOntapCommand, + DescribeLocationFsxOpenZfsCommand, + DescribeLocationFsxWindowsCommand, + DescribeLocationHdfsCommand, + DescribeLocationNfsCommand, + DescribeLocationObjectStorageCommand, + DescribeLocationS3Command, + DescribeLocationSmbCommand, + DescribeTaskCommand, + DescribeTaskExecutionCommand, + ListAgentsCommand, + ListLocationsCommand, + ListTagsForResourceCommand, + ListTaskExecutionsCommand, + ListTasksCommand, + StartTaskExecutionCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAgentCommand, + UpdateLocationHdfsCommand, + UpdateLocationNfsCommand, + UpdateLocationObjectStorageCommand, + UpdateLocationSmbCommand, + UpdateTaskCommand, + UpdateTaskExecutionCommand, +}; + +export interface DataSync { /** - * @public - *

Stops an DataSync task execution that's in progress. The transfer of some - * files are abruptly interrupted. File contents that're transferred to the destination might be - * incomplete or inconsistent with the source files.

- *

However, if you start a new task execution using the same task and allow it to finish, - * file content on the destination will be complete and consistent. This applies to other - * unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully completes the transfer when you start the next task - * execution.

+ * @see {@link CancelTaskExecutionCommand} */ - public cancelTaskExecution( + cancelTaskExecution( args: CancelTaskExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelTaskExecution( + cancelTaskExecution( args: CancelTaskExecutionCommandInput, cb: (err: any, data?: CancelTaskExecutionCommandOutput) => void ): void; - public cancelTaskExecution( + cancelTaskExecution( args: CancelTaskExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelTaskExecutionCommandOutput) => void ): void; - public cancelTaskExecution( - args: CancelTaskExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelTaskExecutionCommandOutput) => void), - cb?: (err: any, data?: CancelTaskExecutionCommandOutput) => void - ): Promise | void { - const command = new CancelTaskExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Activates an DataSync agent that you have deployed in your storage - * environment. The activation process associates your agent with your account. In the activation - * process, you specify information such as the Amazon Web Services Region that you want to - * activate the agent in. You activate the agent in the Amazon Web Services Region where your - * target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services Region.

- *

You can activate the agent in a VPC (virtual private cloud) or provide the agent access to - * a VPC endpoint so you can run tasks without going over the public internet.

- *

You can use an agent for more than one location. If a task uses multiple agents, all of - * them need to have status AVAILABLE for the task to run. If you use multiple agents for a - * source location, the status of all the agents must be AVAILABLE for the task to run.

- *

Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that - * ensures minimal interruption to your tasks.

+ * @see {@link CreateAgentCommand} */ - public createAgent(args: CreateAgentCommandInput, options?: __HttpHandlerOptions): Promise; - public createAgent(args: CreateAgentCommandInput, cb: (err: any, data?: CreateAgentCommandOutput) => void): void; - public createAgent( + createAgent(args: CreateAgentCommandInput, options?: __HttpHandlerOptions): Promise; + createAgent(args: CreateAgentCommandInput, cb: (err: any, data?: CreateAgentCommandOutput) => void): void; + createAgent( args: CreateAgentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAgentCommandOutput) => void ): void; - public createAgent( - args: CreateAgentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAgentCommandOutput) => void), - cb?: (err: any, data?: CreateAgentCommandOutput) => void - ): Promise | void { - const command = new CreateAgentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an endpoint for an Amazon EFS file system that DataSync - * can access for a transfer. For more information, see Creating a location for Amazon EFS.

+ * @see {@link CreateLocationEfsCommand} */ - public createLocationEfs( + createLocationEfs( args: CreateLocationEfsCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLocationEfs( + createLocationEfs( args: CreateLocationEfsCommandInput, cb: (err: any, data?: CreateLocationEfsCommandOutput) => void ): void; - public createLocationEfs( + createLocationEfs( args: CreateLocationEfsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocationEfsCommandOutput) => void ): void; - public createLocationEfs( - args: CreateLocationEfsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLocationEfsCommandOutput) => void), - cb?: (err: any, data?: CreateLocationEfsCommandOutput) => void - ): Promise | void { - const command = new CreateLocationEfsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an endpoint for an Amazon FSx for Lustre file system.

+ * @see {@link CreateLocationFsxLustreCommand} */ - public createLocationFsxLustre( + createLocationFsxLustre( args: CreateLocationFsxLustreCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLocationFsxLustre( + createLocationFsxLustre( args: CreateLocationFsxLustreCommandInput, cb: (err: any, data?: CreateLocationFsxLustreCommandOutput) => void ): void; - public createLocationFsxLustre( + createLocationFsxLustre( args: CreateLocationFsxLustreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocationFsxLustreCommandOutput) => void ): void; - public createLocationFsxLustre( - args: CreateLocationFsxLustreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLocationFsxLustreCommandOutput) => void), - cb?: (err: any, data?: CreateLocationFsxLustreCommandOutput) => void - ): Promise | void { - const command = new CreateLocationFsxLustreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync - * can access for a transfer. For more information, see Creating a location for FSx for ONTAP.

+ * @see {@link CreateLocationFsxOntapCommand} */ - public createLocationFsxOntap( + createLocationFsxOntap( args: CreateLocationFsxOntapCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLocationFsxOntap( + createLocationFsxOntap( args: CreateLocationFsxOntapCommandInput, cb: (err: any, data?: CreateLocationFsxOntapCommandOutput) => void ): void; - public createLocationFsxOntap( + createLocationFsxOntap( args: CreateLocationFsxOntapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocationFsxOntapCommandOutput) => void ): void; - public createLocationFsxOntap( - args: CreateLocationFsxOntapCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLocationFsxOntapCommandOutput) => void), - cb?: (err: any, data?: CreateLocationFsxOntapCommandOutput) => void - ): Promise | void { - const command = new CreateLocationFsxOntapCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync - * can access for a transfer. For more information, see Creating a location for FSx for OpenZFS.

- * - *

Request parameters related to SMB aren't supported with the - * CreateLocationFsxOpenZfs operation.

- *
+ * @see {@link CreateLocationFsxOpenZfsCommand} */ - public createLocationFsxOpenZfs( + createLocationFsxOpenZfs( args: CreateLocationFsxOpenZfsCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLocationFsxOpenZfs( + createLocationFsxOpenZfs( args: CreateLocationFsxOpenZfsCommandInput, cb: (err: any, data?: CreateLocationFsxOpenZfsCommandOutput) => void ): void; - public createLocationFsxOpenZfs( + createLocationFsxOpenZfs( args: CreateLocationFsxOpenZfsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocationFsxOpenZfsCommandOutput) => void ): void; - public createLocationFsxOpenZfs( - args: CreateLocationFsxOpenZfsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLocationFsxOpenZfsCommandOutput) => void), - cb?: (err: any, data?: CreateLocationFsxOpenZfsCommandOutput) => void - ): Promise | void { - const command = new CreateLocationFsxOpenZfsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an endpoint for an Amazon FSx for Windows File Server file system.

+ * @see {@link CreateLocationFsxWindowsCommand} */ - public createLocationFsxWindows( + createLocationFsxWindows( args: CreateLocationFsxWindowsCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLocationFsxWindows( + createLocationFsxWindows( args: CreateLocationFsxWindowsCommandInput, cb: (err: any, data?: CreateLocationFsxWindowsCommandOutput) => void ): void; - public createLocationFsxWindows( + createLocationFsxWindows( args: CreateLocationFsxWindowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocationFsxWindowsCommandOutput) => void ): void; - public createLocationFsxWindows( - args: CreateLocationFsxWindowsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLocationFsxWindowsCommandOutput) => void), - cb?: (err: any, data?: CreateLocationFsxWindowsCommandOutput) => void - ): Promise | void { - const command = new CreateLocationFsxWindowsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an endpoint for a Hadoop Distributed File System (HDFS).

+ * @see {@link CreateLocationHdfsCommand} */ - public createLocationHdfs( + createLocationHdfs( args: CreateLocationHdfsCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLocationHdfs( + createLocationHdfs( args: CreateLocationHdfsCommandInput, cb: (err: any, data?: CreateLocationHdfsCommandOutput) => void ): void; - public createLocationHdfs( + createLocationHdfs( args: CreateLocationHdfsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocationHdfsCommandOutput) => void ): void; - public createLocationHdfs( - args: CreateLocationHdfsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLocationHdfsCommandOutput) => void), - cb?: (err: any, data?: CreateLocationHdfsCommandOutput) => void - ): Promise | void { - const command = new CreateLocationHdfsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Defines a file system on a Network File System (NFS) server that can be read from or - * written to.

+ * @see {@link CreateLocationNfsCommand} */ - public createLocationNfs( + createLocationNfs( args: CreateLocationNfsCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLocationNfs( + createLocationNfs( args: CreateLocationNfsCommandInput, cb: (err: any, data?: CreateLocationNfsCommandOutput) => void ): void; - public createLocationNfs( + createLocationNfs( args: CreateLocationNfsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocationNfsCommandOutput) => void ): void; - public createLocationNfs( - args: CreateLocationNfsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLocationNfsCommandOutput) => void), - cb?: (err: any, data?: CreateLocationNfsCommandOutput) => void - ): Promise | void { - const command = new CreateLocationNfsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an endpoint for an object storage system that DataSync can access for a transfer. For more information, see Creating a location for object storage.

+ * @see {@link CreateLocationObjectStorageCommand} */ - public createLocationObjectStorage( + createLocationObjectStorage( args: CreateLocationObjectStorageCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLocationObjectStorage( + createLocationObjectStorage( args: CreateLocationObjectStorageCommandInput, cb: (err: any, data?: CreateLocationObjectStorageCommandOutput) => void ): void; - public createLocationObjectStorage( + createLocationObjectStorage( args: CreateLocationObjectStorageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocationObjectStorageCommandOutput) => void ): void; - public createLocationObjectStorage( - args: CreateLocationObjectStorageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLocationObjectStorageCommandOutput) => void), - cb?: (err: any, data?: CreateLocationObjectStorageCommandOutput) => void - ): Promise | void { - const command = new CreateLocationObjectStorageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an endpoint for an Amazon S3 bucket that DataSync can - * access for a transfer. For more information, see Create an Amazon S3 location.

+ * @see {@link CreateLocationS3Command} */ - public createLocationS3( + createLocationS3( args: CreateLocationS3CommandInput, options?: __HttpHandlerOptions ): Promise; - public createLocationS3( + createLocationS3( args: CreateLocationS3CommandInput, cb: (err: any, data?: CreateLocationS3CommandOutput) => void ): void; - public createLocationS3( + createLocationS3( args: CreateLocationS3CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocationS3CommandOutput) => void ): void; - public createLocationS3( - args: CreateLocationS3CommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLocationS3CommandOutput) => void), - cb?: (err: any, data?: CreateLocationS3CommandOutput) => void - ): Promise | void { - const command = new CreateLocationS3Command(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an endpoint for a Server Message Block (SMB) file server that DataSync can access for a transfer. For more information, see Creating an SMB location.

+ * @see {@link CreateLocationSmbCommand} */ - public createLocationSmb( + createLocationSmb( args: CreateLocationSmbCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLocationSmb( + createLocationSmb( args: CreateLocationSmbCommandInput, cb: (err: any, data?: CreateLocationSmbCommandOutput) => void ): void; - public createLocationSmb( + createLocationSmb( args: CreateLocationSmbCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocationSmbCommandOutput) => void ): void; - public createLocationSmb( - args: CreateLocationSmbCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLocationSmbCommandOutput) => void), - cb?: (err: any, data?: CreateLocationSmbCommandOutput) => void - ): Promise | void { - const command = new CreateLocationSmbCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Configures a task, which defines where and how DataSync transfers your - * data.

- *

A task includes a source location, a destination location, and the preferences for how and - * when you want to transfer your data (such as bandwidth limits, scheduling, among other - * options).

+ * @see {@link CreateTaskCommand} */ - public createTask(args: CreateTaskCommandInput, options?: __HttpHandlerOptions): Promise; - public createTask(args: CreateTaskCommandInput, cb: (err: any, data?: CreateTaskCommandOutput) => void): void; - public createTask( + createTask(args: CreateTaskCommandInput, options?: __HttpHandlerOptions): Promise; + createTask(args: CreateTaskCommandInput, cb: (err: any, data?: CreateTaskCommandOutput) => void): void; + createTask( args: CreateTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTaskCommandOutput) => void ): void; - public createTask( - args: CreateTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTaskCommandOutput) => void), - cb?: (err: any, data?: CreateTaskCommandOutput) => void - ): Promise | void { - const command = new CreateTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) - * of the agent in your request. The operation disassociates the agent from your Amazon Web Services account. - * However, it doesn't delete the agent virtual machine (VM) from your on-premises - * environment.

+ * @see {@link DeleteAgentCommand} */ - public deleteAgent(args: DeleteAgentCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteAgent(args: DeleteAgentCommandInput, cb: (err: any, data?: DeleteAgentCommandOutput) => void): void; - public deleteAgent( + deleteAgent(args: DeleteAgentCommandInput, options?: __HttpHandlerOptions): Promise; + deleteAgent(args: DeleteAgentCommandInput, cb: (err: any, data?: DeleteAgentCommandOutput) => void): void; + deleteAgent( args: DeleteAgentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAgentCommandOutput) => void ): void; - public deleteAgent( - args: DeleteAgentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAgentCommandOutput) => void), - cb?: (err: any, data?: DeleteAgentCommandOutput) => void - ): Promise | void { - const command = new DeleteAgentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the configuration of a location used by DataSync.

+ * @see {@link DeleteLocationCommand} */ - public deleteLocation( + deleteLocation( args: DeleteLocationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLocation( - args: DeleteLocationCommandInput, - cb: (err: any, data?: DeleteLocationCommandOutput) => void - ): void; - public deleteLocation( + deleteLocation(args: DeleteLocationCommandInput, cb: (err: any, data?: DeleteLocationCommandOutput) => void): void; + deleteLocation( args: DeleteLocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLocationCommandOutput) => void ): void; - public deleteLocation( - args: DeleteLocationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLocationCommandOutput) => void), - cb?: (err: any, data?: DeleteLocationCommandOutput) => void - ): Promise | void { - const command = new DeleteLocationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an DataSync task.

+ * @see {@link DeleteTaskCommand} */ - public deleteTask(args: DeleteTaskCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteTask(args: DeleteTaskCommandInput, cb: (err: any, data?: DeleteTaskCommandOutput) => void): void; - public deleteTask( + deleteTask(args: DeleteTaskCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTask(args: DeleteTaskCommandInput, cb: (err: any, data?: DeleteTaskCommandOutput) => void): void; + deleteTask( args: DeleteTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTaskCommandOutput) => void ): void; - public deleteTask( - args: DeleteTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTaskCommandOutput) => void), - cb?: (err: any, data?: DeleteTaskCommandOutput) => void - ): Promise | void { - const command = new DeleteTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns metadata about an DataSync agent, such as its name, endpoint type, and status.

+ * @see {@link DescribeAgentCommand} */ - public describeAgent( - args: DescribeAgentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeAgent( - args: DescribeAgentCommandInput, - cb: (err: any, data?: DescribeAgentCommandOutput) => void - ): void; - public describeAgent( + describeAgent(args: DescribeAgentCommandInput, options?: __HttpHandlerOptions): Promise; + describeAgent(args: DescribeAgentCommandInput, cb: (err: any, data?: DescribeAgentCommandOutput) => void): void; + describeAgent( args: DescribeAgentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAgentCommandOutput) => void ): void; - public describeAgent( - args: DescribeAgentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAgentCommandOutput) => void), - cb?: (err: any, data?: DescribeAgentCommandOutput) => void - ): Promise | void { - const command = new DescribeAgentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns metadata about your DataSync location for an Amazon EFS file system.

+ * @see {@link DescribeLocationEfsCommand} */ - public describeLocationEfs( + describeLocationEfs( args: DescribeLocationEfsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLocationEfs( + describeLocationEfs( args: DescribeLocationEfsCommandInput, cb: (err: any, data?: DescribeLocationEfsCommandOutput) => void ): void; - public describeLocationEfs( + describeLocationEfs( args: DescribeLocationEfsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocationEfsCommandOutput) => void ): void; - public describeLocationEfs( - args: DescribeLocationEfsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLocationEfsCommandOutput) => void), - cb?: (err: any, data?: DescribeLocationEfsCommandOutput) => void - ): Promise | void { - const command = new DescribeLocationEfsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.

+ * @see {@link DescribeLocationFsxLustreCommand} */ - public describeLocationFsxLustre( + describeLocationFsxLustre( args: DescribeLocationFsxLustreCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLocationFsxLustre( + describeLocationFsxLustre( args: DescribeLocationFsxLustreCommandInput, cb: (err: any, data?: DescribeLocationFsxLustreCommandOutput) => void ): void; - public describeLocationFsxLustre( + describeLocationFsxLustre( args: DescribeLocationFsxLustreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocationFsxLustreCommandOutput) => void ): void; - public describeLocationFsxLustre( - args: DescribeLocationFsxLustreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLocationFsxLustreCommandOutput) => void), - cb?: (err: any, data?: DescribeLocationFsxLustreCommandOutput) => void - ): Promise | void { - const command = new DescribeLocationFsxLustreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.

- * - *

If your location uses SMB, the DescribeLocationFsxOntap operation doesn't - * actually return a Password.

- *
+ * @see {@link DescribeLocationFsxOntapCommand} */ - public describeLocationFsxOntap( + describeLocationFsxOntap( args: DescribeLocationFsxOntapCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLocationFsxOntap( + describeLocationFsxOntap( args: DescribeLocationFsxOntapCommandInput, cb: (err: any, data?: DescribeLocationFsxOntapCommandOutput) => void ): void; - public describeLocationFsxOntap( + describeLocationFsxOntap( args: DescribeLocationFsxOntapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocationFsxOntapCommandOutput) => void ): void; - public describeLocationFsxOntap( - args: DescribeLocationFsxOntapCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLocationFsxOntapCommandOutput) => void), - cb?: (err: any, data?: DescribeLocationFsxOntapCommandOutput) => void - ): Promise | void { - const command = new DescribeLocationFsxOntapCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.

- * - *

Response elements related to SMB aren't supported with the - * DescribeLocationFsxOpenZfs operation.

- *
+ * @see {@link DescribeLocationFsxOpenZfsCommand} */ - public describeLocationFsxOpenZfs( + describeLocationFsxOpenZfs( args: DescribeLocationFsxOpenZfsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLocationFsxOpenZfs( + describeLocationFsxOpenZfs( args: DescribeLocationFsxOpenZfsCommandInput, cb: (err: any, data?: DescribeLocationFsxOpenZfsCommandOutput) => void ): void; - public describeLocationFsxOpenZfs( + describeLocationFsxOpenZfs( args: DescribeLocationFsxOpenZfsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocationFsxOpenZfsCommandOutput) => void ): void; - public describeLocationFsxOpenZfs( - args: DescribeLocationFsxOpenZfsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLocationFsxOpenZfsCommandOutput) => void), - cb?: (err: any, data?: DescribeLocationFsxOpenZfsCommandOutput) => void - ): Promise | void { - const command = new DescribeLocationFsxOpenZfsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns metadata about an Amazon FSx for Windows File Server - * location, such as information about its path.

+ * @see {@link DescribeLocationFsxWindowsCommand} */ - public describeLocationFsxWindows( + describeLocationFsxWindows( args: DescribeLocationFsxWindowsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLocationFsxWindows( + describeLocationFsxWindows( args: DescribeLocationFsxWindowsCommandInput, cb: (err: any, data?: DescribeLocationFsxWindowsCommandOutput) => void ): void; - public describeLocationFsxWindows( + describeLocationFsxWindows( args: DescribeLocationFsxWindowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocationFsxWindowsCommandOutput) => void ): void; - public describeLocationFsxWindows( - args: DescribeLocationFsxWindowsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLocationFsxWindowsCommandOutput) => void), - cb?: (err: any, data?: DescribeLocationFsxWindowsCommandOutput) => void - ): Promise | void { - const command = new DescribeLocationFsxWindowsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns metadata, such as the authentication information about the Hadoop Distributed File - * System (HDFS) location.

+ * @see {@link DescribeLocationHdfsCommand} */ - public describeLocationHdfs( + describeLocationHdfs( args: DescribeLocationHdfsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLocationHdfs( + describeLocationHdfs( args: DescribeLocationHdfsCommandInput, cb: (err: any, data?: DescribeLocationHdfsCommandOutput) => void ): void; - public describeLocationHdfs( + describeLocationHdfs( args: DescribeLocationHdfsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocationHdfsCommandOutput) => void ): void; - public describeLocationHdfs( - args: DescribeLocationHdfsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLocationHdfsCommandOutput) => void), - cb?: (err: any, data?: DescribeLocationHdfsCommandOutput) => void - ): Promise | void { - const command = new DescribeLocationHdfsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns metadata, such as the path information, about an NFS location.

+ * @see {@link DescribeLocationNfsCommand} */ - public describeLocationNfs( + describeLocationNfs( args: DescribeLocationNfsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLocationNfs( + describeLocationNfs( args: DescribeLocationNfsCommandInput, cb: (err: any, data?: DescribeLocationNfsCommandOutput) => void ): void; - public describeLocationNfs( + describeLocationNfs( args: DescribeLocationNfsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocationNfsCommandOutput) => void ): void; - public describeLocationNfs( - args: DescribeLocationNfsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLocationNfsCommandOutput) => void), - cb?: (err: any, data?: DescribeLocationNfsCommandOutput) => void - ): Promise | void { - const command = new DescribeLocationNfsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns metadata about your DataSync location for an object storage system.

+ * @see {@link DescribeLocationObjectStorageCommand} */ - public describeLocationObjectStorage( + describeLocationObjectStorage( args: DescribeLocationObjectStorageCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLocationObjectStorage( + describeLocationObjectStorage( args: DescribeLocationObjectStorageCommandInput, cb: (err: any, data?: DescribeLocationObjectStorageCommandOutput) => void ): void; - public describeLocationObjectStorage( + describeLocationObjectStorage( args: DescribeLocationObjectStorageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocationObjectStorageCommandOutput) => void ): void; - public describeLocationObjectStorage( - args: DescribeLocationObjectStorageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLocationObjectStorageCommandOutput) => void), - cb?: (err: any, data?: DescribeLocationObjectStorageCommandOutput) => void - ): Promise | void { - const command = new DescribeLocationObjectStorageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns metadata, such as bucket name, about an Amazon S3 bucket location.

+ * @see {@link DescribeLocationS3Command} */ - public describeLocationS3( + describeLocationS3( args: DescribeLocationS3CommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLocationS3( + describeLocationS3( args: DescribeLocationS3CommandInput, cb: (err: any, data?: DescribeLocationS3CommandOutput) => void ): void; - public describeLocationS3( + describeLocationS3( args: DescribeLocationS3CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocationS3CommandOutput) => void ): void; - public describeLocationS3( - args: DescribeLocationS3CommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLocationS3CommandOutput) => void), - cb?: (err: any, data?: DescribeLocationS3CommandOutput) => void - ): Promise | void { - const command = new DescribeLocationS3Command(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns metadata, such as the path and user information about an SMB location.

+ * @see {@link DescribeLocationSmbCommand} */ - public describeLocationSmb( + describeLocationSmb( args: DescribeLocationSmbCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLocationSmb( + describeLocationSmb( args: DescribeLocationSmbCommandInput, cb: (err: any, data?: DescribeLocationSmbCommandOutput) => void ): void; - public describeLocationSmb( + describeLocationSmb( args: DescribeLocationSmbCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocationSmbCommandOutput) => void ): void; - public describeLocationSmb( - args: DescribeLocationSmbCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLocationSmbCommandOutput) => void), - cb?: (err: any, data?: DescribeLocationSmbCommandOutput) => void - ): Promise | void { - const command = new DescribeLocationSmbCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns metadata about a task.

+ * @see {@link DescribeTaskCommand} */ - public describeTask( - args: DescribeTaskCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeTask(args: DescribeTaskCommandInput, cb: (err: any, data?: DescribeTaskCommandOutput) => void): void; - public describeTask( + describeTask(args: DescribeTaskCommandInput, options?: __HttpHandlerOptions): Promise; + describeTask(args: DescribeTaskCommandInput, cb: (err: any, data?: DescribeTaskCommandOutput) => void): void; + describeTask( args: DescribeTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTaskCommandOutput) => void ): void; - public describeTask( - args: DescribeTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTaskCommandOutput) => void), - cb?: (err: any, data?: DescribeTaskCommandOutput) => void - ): Promise | void { - const command = new DescribeTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns detailed metadata about a task that is being executed.

+ * @see {@link DescribeTaskExecutionCommand} */ - public describeTaskExecution( + describeTaskExecution( args: DescribeTaskExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTaskExecution( + describeTaskExecution( args: DescribeTaskExecutionCommandInput, cb: (err: any, data?: DescribeTaskExecutionCommandOutput) => void ): void; - public describeTaskExecution( + describeTaskExecution( args: DescribeTaskExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTaskExecutionCommandOutput) => void ): void; - public describeTaskExecution( - args: DescribeTaskExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTaskExecutionCommandOutput) => void), - cb?: (err: any, data?: DescribeTaskExecutionCommandOutput) => void - ): Promise | void { - const command = new DescribeTaskExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request.

- *

With pagination, you can reduce the number of agents returned in a response. If you get - * a truncated list of agents in a response, the response contains a marker that you can specify - * in your next request to fetch the next page of agents.

- *

- * ListAgents is eventually consistent. This means the result of running the - * operation might not reflect that you just created or deleted an agent. For example, if you - * create an agent with CreateAgent and then - * immediately run ListAgents, that agent might not show up in the list right away. - * In situations like this, you can always confirm whether an agent has been created (or deleted) - * by using DescribeAgent.

+ * @see {@link ListAgentsCommand} */ - public listAgents(args: ListAgentsCommandInput, options?: __HttpHandlerOptions): Promise; - public listAgents(args: ListAgentsCommandInput, cb: (err: any, data?: ListAgentsCommandOutput) => void): void; - public listAgents( + listAgents(args: ListAgentsCommandInput, options?: __HttpHandlerOptions): Promise; + listAgents(args: ListAgentsCommandInput, cb: (err: any, data?: ListAgentsCommandOutput) => void): void; + listAgents( args: ListAgentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAgentsCommandOutput) => void ): void; - public listAgents( - args: ListAgentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAgentsCommandOutput) => void), - cb?: (err: any, data?: ListAgentsCommandOutput) => void - ): Promise | void { - const command = new ListAgentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of source and destination locations.

- *

If you have more locations than are returned in a response (that is, the response - * returns only a truncated list of your agents), the response contains a token that you can - * specify in your next request to fetch the next page of locations.

+ * @see {@link ListLocationsCommand} */ - public listLocations( - args: ListLocationsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listLocations( - args: ListLocationsCommandInput, - cb: (err: any, data?: ListLocationsCommandOutput) => void - ): void; - public listLocations( + listLocations(args: ListLocationsCommandInput, options?: __HttpHandlerOptions): Promise; + listLocations(args: ListLocationsCommandInput, cb: (err: any, data?: ListLocationsCommandOutput) => void): void; + listLocations( args: ListLocationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLocationsCommandOutput) => void ): void; - public listLocations( - args: ListLocationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLocationsCommandOutput) => void), - cb?: (err: any, data?: ListLocationsCommandOutput) => void - ): Promise | void { - const command = new ListLocationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns all the tags associated with an Amazon Web Services resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of executed tasks.

+ * @see {@link ListTaskExecutionsCommand} */ - public listTaskExecutions( + listTaskExecutions( args: ListTaskExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTaskExecutions( + listTaskExecutions( args: ListTaskExecutionsCommandInput, cb: (err: any, data?: ListTaskExecutionsCommandOutput) => void ): void; - public listTaskExecutions( + listTaskExecutions( args: ListTaskExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTaskExecutionsCommandOutput) => void ): void; - public listTaskExecutions( - args: ListTaskExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTaskExecutionsCommandOutput) => void), - cb?: (err: any, data?: ListTaskExecutionsCommandOutput) => void - ): Promise | void { - const command = new ListTaskExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the DataSync tasks you created.

+ * @see {@link ListTasksCommand} */ - public listTasks(args: ListTasksCommandInput, options?: __HttpHandlerOptions): Promise; - public listTasks(args: ListTasksCommandInput, cb: (err: any, data?: ListTasksCommandOutput) => void): void; - public listTasks( + listTasks(args: ListTasksCommandInput, options?: __HttpHandlerOptions): Promise; + listTasks(args: ListTasksCommandInput, cb: (err: any, data?: ListTasksCommandOutput) => void): void; + listTasks( args: ListTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTasksCommandOutput) => void ): void; - public listTasks( - args: ListTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTasksCommandOutput) => void), - cb?: (err: any, data?: ListTasksCommandOutput) => void - ): Promise | void { - const command = new ListTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts an DataSync task. For each task, you can only run one task execution at a time.

- *

There are several phases to a task execution. For more information, see Task execution statuses.

+ * @see {@link StartTaskExecutionCommand} */ - public startTaskExecution( + startTaskExecution( args: StartTaskExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startTaskExecution( + startTaskExecution( args: StartTaskExecutionCommandInput, cb: (err: any, data?: StartTaskExecutionCommandOutput) => void ): void; - public startTaskExecution( + startTaskExecution( args: StartTaskExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTaskExecutionCommandOutput) => void ): void; - public startTaskExecution( - args: StartTaskExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartTaskExecutionCommandOutput) => void), - cb?: (err: any, data?: StartTaskExecutionCommandOutput) => void - ): Promise | void { - const command = new StartTaskExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Applies a tag to an Amazon Web Services - * resource. Tags are key-value pairs that can help you manage, filter, and search for your resources.

- *

These include DataSync resources, such as locations, tasks, and task executions.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from an Amazon Web Services resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the name of an agent.

+ * @see {@link UpdateAgentCommand} */ - public updateAgent(args: UpdateAgentCommandInput, options?: __HttpHandlerOptions): Promise; - public updateAgent(args: UpdateAgentCommandInput, cb: (err: any, data?: UpdateAgentCommandOutput) => void): void; - public updateAgent( + updateAgent(args: UpdateAgentCommandInput, options?: __HttpHandlerOptions): Promise; + updateAgent(args: UpdateAgentCommandInput, cb: (err: any, data?: UpdateAgentCommandOutput) => void): void; + updateAgent( args: UpdateAgentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAgentCommandOutput) => void ): void; - public updateAgent( - args: UpdateAgentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAgentCommandOutput) => void), - cb?: (err: any, data?: UpdateAgentCommandOutput) => void - ): Promise | void { - const command = new UpdateAgentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates some parameters of a previously created location for a Hadoop Distributed File - * System cluster.

+ * @see {@link UpdateLocationHdfsCommand} */ - public updateLocationHdfs( + updateLocationHdfs( args: UpdateLocationHdfsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLocationHdfs( + updateLocationHdfs( args: UpdateLocationHdfsCommandInput, cb: (err: any, data?: UpdateLocationHdfsCommandOutput) => void ): void; - public updateLocationHdfs( + updateLocationHdfs( args: UpdateLocationHdfsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLocationHdfsCommandOutput) => void ): void; - public updateLocationHdfs( - args: UpdateLocationHdfsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLocationHdfsCommandOutput) => void), - cb?: (err: any, data?: UpdateLocationHdfsCommandOutput) => void - ): Promise | void { - const command = new UpdateLocationHdfsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates some of the parameters of a previously created location for Network File System (NFS) access. - * For information about creating an NFS location, see Creating a location for NFS.

+ * @see {@link UpdateLocationNfsCommand} */ - public updateLocationNfs( + updateLocationNfs( args: UpdateLocationNfsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLocationNfs( + updateLocationNfs( args: UpdateLocationNfsCommandInput, cb: (err: any, data?: UpdateLocationNfsCommandOutput) => void ): void; - public updateLocationNfs( + updateLocationNfs( args: UpdateLocationNfsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLocationNfsCommandOutput) => void ): void; - public updateLocationNfs( - args: UpdateLocationNfsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLocationNfsCommandOutput) => void), - cb?: (err: any, data?: UpdateLocationNfsCommandOutput) => void - ): Promise | void { - const command = new UpdateLocationNfsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates some parameters of an existing object storage location that DataSync - * accesses for a transfer. For information about creating a self-managed object storage - * location, see Creating a location for object - * storage.

+ * @see {@link UpdateLocationObjectStorageCommand} */ - public updateLocationObjectStorage( + updateLocationObjectStorage( args: UpdateLocationObjectStorageCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLocationObjectStorage( + updateLocationObjectStorage( args: UpdateLocationObjectStorageCommandInput, cb: (err: any, data?: UpdateLocationObjectStorageCommandOutput) => void ): void; - public updateLocationObjectStorage( + updateLocationObjectStorage( args: UpdateLocationObjectStorageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLocationObjectStorageCommandOutput) => void ): void; - public updateLocationObjectStorage( - args: UpdateLocationObjectStorageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLocationObjectStorageCommandOutput) => void), - cb?: (err: any, data?: UpdateLocationObjectStorageCommandOutput) => void - ): Promise | void { - const command = new UpdateLocationObjectStorageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates some of the parameters of a previously created location for Server Message Block - * (SMB) file system access. For information about creating an SMB location, see - * Creating a location for SMB.

+ * @see {@link UpdateLocationSmbCommand} */ - public updateLocationSmb( + updateLocationSmb( args: UpdateLocationSmbCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLocationSmb( + updateLocationSmb( args: UpdateLocationSmbCommandInput, cb: (err: any, data?: UpdateLocationSmbCommandOutput) => void ): void; - public updateLocationSmb( + updateLocationSmb( args: UpdateLocationSmbCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLocationSmbCommandOutput) => void ): void; - public updateLocationSmb( - args: UpdateLocationSmbCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLocationSmbCommandOutput) => void), - cb?: (err: any, data?: UpdateLocationSmbCommandOutput) => void - ): Promise | void { - const command = new UpdateLocationSmbCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the metadata associated with a task.

+ * @see {@link UpdateTaskCommand} */ - public updateTask(args: UpdateTaskCommandInput, options?: __HttpHandlerOptions): Promise; - public updateTask(args: UpdateTaskCommandInput, cb: (err: any, data?: UpdateTaskCommandOutput) => void): void; - public updateTask( + updateTask(args: UpdateTaskCommandInput, options?: __HttpHandlerOptions): Promise; + updateTask(args: UpdateTaskCommandInput, cb: (err: any, data?: UpdateTaskCommandOutput) => void): void; + updateTask( args: UpdateTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTaskCommandOutput) => void ): void; - public updateTask( - args: UpdateTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTaskCommandOutput) => void), - cb?: (err: any, data?: UpdateTaskCommandOutput) => void - ): Promise | void { - const command = new UpdateTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates execution of a task.

- *

You can modify bandwidth throttling for a task execution that is running or queued. - * For more information, see Adjusting Bandwidth Throttling for a Task Execution.

- * - *

The only Option that can be modified by UpdateTaskExecution - * is - * BytesPerSecond - * .

- *
+ * @see {@link UpdateTaskExecutionCommand} */ - public updateTaskExecution( + updateTaskExecution( args: UpdateTaskExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTaskExecution( + updateTaskExecution( args: UpdateTaskExecutionCommandInput, cb: (err: any, data?: UpdateTaskExecutionCommandOutput) => void ): void; - public updateTaskExecution( + updateTaskExecution( args: UpdateTaskExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTaskExecutionCommandOutput) => void ): void; - public updateTaskExecution( - args: UpdateTaskExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTaskExecutionCommandOutput) => void), - cb?: (err: any, data?: UpdateTaskExecutionCommandOutput) => void - ): Promise | void { - const command = new UpdateTaskExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * DataSync + *

DataSync is a managed data transfer service that makes it simpler for you + * to automate moving data between on-premises storage and Amazon Web Services storage services. You also can use DataSync to transfer data between other cloud providers and Amazon Web Services storage services.

+ *

This API interface reference includes documentation for using DataSync + * programmatically. For complete information, see the + * DataSync User + * Guide + * .

+ */ +export class DataSync extends DataSyncClient implements DataSync {} +createAggregatedClient(commands, DataSync); diff --git a/clients/client-dax/src/DAX.ts b/clients/client-dax/src/DAX.ts index 7d6920bd3b53..ca7587de9af7 100644 --- a/clients/client-dax/src/DAX.ts +++ b/clients/client-dax/src/DAX.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -94,735 +95,354 @@ import { UpdateSubnetGroupCommandInput, UpdateSubnetGroupCommandOutput, } from "./commands/UpdateSubnetGroupCommand"; -import { DAXClient } from "./DAXClient"; +import { DAXClient, DAXClientConfig } from "./DAXClient"; -/** - * @public - *

DAX is a managed caching service engineered for Amazon DynamoDB. DAX - * dramatically speeds up database reads by caching frequently-accessed data from DynamoDB, so - * applications can access that data with sub-millisecond latency. You can create a DAX - * cluster easily, using the AWS Management Console. With a few simple modifications to - * your code, your application can begin taking advantage of the DAX cluster and realize - * significant improvements in read performance.

- */ -export class DAX extends DAXClient { +const commands = { + CreateClusterCommand, + CreateParameterGroupCommand, + CreateSubnetGroupCommand, + DecreaseReplicationFactorCommand, + DeleteClusterCommand, + DeleteParameterGroupCommand, + DeleteSubnetGroupCommand, + DescribeClustersCommand, + DescribeDefaultParametersCommand, + DescribeEventsCommand, + DescribeParameterGroupsCommand, + DescribeParametersCommand, + DescribeSubnetGroupsCommand, + IncreaseReplicationFactorCommand, + ListTagsCommand, + RebootNodeCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateClusterCommand, + UpdateParameterGroupCommand, + UpdateSubnetGroupCommand, +}; + +export interface DAX { /** - * @public - *

Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.

+ * @see {@link CreateClusterCommand} */ - public createCluster( - args: CreateClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createCluster( - args: CreateClusterCommandInput, - cb: (err: any, data?: CreateClusterCommandOutput) => void - ): void; - public createCluster( + createCluster(args: CreateClusterCommandInput, options?: __HttpHandlerOptions): Promise; + createCluster(args: CreateClusterCommandInput, cb: (err: any, data?: CreateClusterCommandOutput) => void): void; + createCluster( args: CreateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterCommandOutput) => void ): void; - public createCluster( - args: CreateClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateClusterCommandOutput) => void), - cb?: (err: any, data?: CreateClusterCommandOutput) => void - ): Promise | void { - const command = new CreateClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new parameter group. A parameter group is a collection of parameters that - * you apply to all of the nodes in a DAX cluster.

+ * @see {@link CreateParameterGroupCommand} */ - public createParameterGroup( + createParameterGroup( args: CreateParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createParameterGroup( + createParameterGroup( args: CreateParameterGroupCommandInput, cb: (err: any, data?: CreateParameterGroupCommandOutput) => void ): void; - public createParameterGroup( + createParameterGroup( args: CreateParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateParameterGroupCommandOutput) => void ): void; - public createParameterGroup( - args: CreateParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateParameterGroupCommandOutput) => void), - cb?: (err: any, data?: CreateParameterGroupCommandOutput) => void - ): Promise | void { - const command = new CreateParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new subnet group.

+ * @see {@link CreateSubnetGroupCommand} */ - public createSubnetGroup( + createSubnetGroup( args: CreateSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSubnetGroup( + createSubnetGroup( args: CreateSubnetGroupCommandInput, cb: (err: any, data?: CreateSubnetGroupCommandOutput) => void ): void; - public createSubnetGroup( + createSubnetGroup( args: CreateSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSubnetGroupCommandOutput) => void ): void; - public createSubnetGroup( - args: CreateSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: CreateSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new CreateSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more nodes from a DAX cluster.

- * - *

You cannot use DecreaseReplicationFactor to remove the last node in a DAX cluster. If you need to do this, use DeleteCluster instead.

- *
+ * @see {@link DecreaseReplicationFactorCommand} */ - public decreaseReplicationFactor( + decreaseReplicationFactor( args: DecreaseReplicationFactorCommandInput, options?: __HttpHandlerOptions ): Promise; - public decreaseReplicationFactor( + decreaseReplicationFactor( args: DecreaseReplicationFactorCommandInput, cb: (err: any, data?: DecreaseReplicationFactorCommandOutput) => void ): void; - public decreaseReplicationFactor( + decreaseReplicationFactor( args: DecreaseReplicationFactorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DecreaseReplicationFactorCommandOutput) => void ): void; - public decreaseReplicationFactor( - args: DecreaseReplicationFactorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DecreaseReplicationFactorCommandOutput) => void), - cb?: (err: any, data?: DecreaseReplicationFactorCommandOutput) => void - ): Promise | void { - const command = new DecreaseReplicationFactorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a previously provisioned DAX cluster. - * DeleteCluster deletes all associated nodes, node endpoints - * and the DAX cluster itself. When you receive a successful response from this action, - * DAX immediately begins deleting the cluster; you cannot cancel or revert this - * action.

+ * @see {@link DeleteClusterCommand} */ - public deleteCluster( - args: DeleteClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteCluster( - args: DeleteClusterCommandInput, - cb: (err: any, data?: DeleteClusterCommandOutput) => void - ): void; - public deleteCluster( + deleteCluster(args: DeleteClusterCommandInput, options?: __HttpHandlerOptions): Promise; + deleteCluster(args: DeleteClusterCommandInput, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void; + deleteCluster( args: DeleteClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClusterCommandOutput) => void ): void; - public deleteCluster( - args: DeleteClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteClusterCommandOutput) => void), - cb?: (err: any, data?: DeleteClusterCommandOutput) => void - ): Promise | void { - const command = new DeleteClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified parameter group. You cannot delete a parameter group if it is - * associated with any DAX clusters.

+ * @see {@link DeleteParameterGroupCommand} */ - public deleteParameterGroup( + deleteParameterGroup( args: DeleteParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteParameterGroup( + deleteParameterGroup( args: DeleteParameterGroupCommandInput, cb: (err: any, data?: DeleteParameterGroupCommandOutput) => void ): void; - public deleteParameterGroup( + deleteParameterGroup( args: DeleteParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteParameterGroupCommandOutput) => void ): void; - public deleteParameterGroup( - args: DeleteParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteParameterGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteParameterGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a subnet group.

- * - *

You cannot delete a subnet group if it is associated with any DAX - * clusters.

- *
+ * @see {@link DeleteSubnetGroupCommand} */ - public deleteSubnetGroup( + deleteSubnetGroup( args: DeleteSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSubnetGroup( + deleteSubnetGroup( args: DeleteSubnetGroupCommandInput, cb: (err: any, data?: DeleteSubnetGroupCommandOutput) => void ): void; - public deleteSubnetGroup( + deleteSubnetGroup( args: DeleteSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSubnetGroupCommandOutput) => void ): void; - public deleteSubnetGroup( - args: DeleteSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about all provisioned DAX clusters if no cluster identifier - * is specified, or about a specific DAX cluster if a cluster identifier is - * supplied.

- *

If the cluster is in the CREATING state, only cluster level information will be - * displayed until all of the nodes are successfully provisioned.

- *

If the cluster is in the DELETING state, only cluster level information will be - * displayed.

- *

If nodes are currently being added to the DAX cluster, node endpoint information - * and creation time for the additional nodes will not be displayed until they are - * completely provisioned. When the DAX cluster state is available, - * the cluster is ready for use.

- *

If nodes are currently being removed from the DAX cluster, no endpoint - * information for the removed nodes is displayed.

+ * @see {@link DescribeClustersCommand} */ - public describeClusters( + describeClusters( args: DescribeClustersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClusters( + describeClusters( args: DescribeClustersCommandInput, cb: (err: any, data?: DescribeClustersCommandOutput) => void ): void; - public describeClusters( + describeClusters( args: DescribeClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClustersCommandOutput) => void ): void; - public describeClusters( - args: DescribeClustersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClustersCommandOutput) => void), - cb?: (err: any, data?: DescribeClustersCommandOutput) => void - ): Promise | void { - const command = new DescribeClustersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the default system parameter information for the DAX caching - * software.

+ * @see {@link DescribeDefaultParametersCommand} */ - public describeDefaultParameters( + describeDefaultParameters( args: DescribeDefaultParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDefaultParameters( + describeDefaultParameters( args: DescribeDefaultParametersCommandInput, cb: (err: any, data?: DescribeDefaultParametersCommandOutput) => void ): void; - public describeDefaultParameters( + describeDefaultParameters( args: DescribeDefaultParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDefaultParametersCommandOutput) => void ): void; - public describeDefaultParameters( - args: DescribeDefaultParametersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDefaultParametersCommandOutput) => void), - cb?: (err: any, data?: DescribeDefaultParametersCommandOutput) => void - ): Promise | void { - const command = new DescribeDefaultParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns events related to DAX clusters and parameter groups. You can obtain - * events specific to a particular DAX cluster or parameter group by providing the name - * as a parameter.

- *

By default, only the events occurring within the last 24 hours are returned; however, - * you can retrieve up to 14 days' worth of events if necessary.

+ * @see {@link DescribeEventsCommand} */ - public describeEvents( + describeEvents( args: DescribeEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEvents( - args: DescribeEventsCommandInput, - cb: (err: any, data?: DescribeEventsCommandOutput) => void - ): void; - public describeEvents( + describeEvents(args: DescribeEventsCommandInput, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void; + describeEvents( args: DescribeEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsCommandOutput) => void ): void; - public describeEvents( - args: DescribeEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventsCommandOutput) => void), - cb?: (err: any, data?: DescribeEventsCommandOutput) => void - ): Promise | void { - const command = new DescribeEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of parameter group descriptions. If a parameter group name is - * specified, the list will contain only the descriptions for that group.

+ * @see {@link DescribeParameterGroupsCommand} */ - public describeParameterGroups( + describeParameterGroups( args: DescribeParameterGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeParameterGroups( + describeParameterGroups( args: DescribeParameterGroupsCommandInput, cb: (err: any, data?: DescribeParameterGroupsCommandOutput) => void ): void; - public describeParameterGroups( + describeParameterGroups( args: DescribeParameterGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeParameterGroupsCommandOutput) => void ): void; - public describeParameterGroups( - args: DescribeParameterGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeParameterGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeParameterGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeParameterGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the detailed parameter list for a particular parameter group.

+ * @see {@link DescribeParametersCommand} */ - public describeParameters( + describeParameters( args: DescribeParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeParameters( + describeParameters( args: DescribeParametersCommandInput, cb: (err: any, data?: DescribeParametersCommandOutput) => void ): void; - public describeParameters( + describeParameters( args: DescribeParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeParametersCommandOutput) => void ): void; - public describeParameters( - args: DescribeParametersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeParametersCommandOutput) => void), - cb?: (err: any, data?: DescribeParametersCommandOutput) => void - ): Promise | void { - const command = new DescribeParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of subnet group descriptions. If a subnet group name is specified, - * the list will contain only the description of that group.

+ * @see {@link DescribeSubnetGroupsCommand} */ - public describeSubnetGroups( + describeSubnetGroups( args: DescribeSubnetGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSubnetGroups( + describeSubnetGroups( args: DescribeSubnetGroupsCommandInput, cb: (err: any, data?: DescribeSubnetGroupsCommandOutput) => void ): void; - public describeSubnetGroups( + describeSubnetGroups( args: DescribeSubnetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSubnetGroupsCommandOutput) => void ): void; - public describeSubnetGroups( - args: DescribeSubnetGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSubnetGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeSubnetGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeSubnetGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more nodes to a DAX cluster.

+ * @see {@link IncreaseReplicationFactorCommand} */ - public increaseReplicationFactor( + increaseReplicationFactor( args: IncreaseReplicationFactorCommandInput, options?: __HttpHandlerOptions ): Promise; - public increaseReplicationFactor( + increaseReplicationFactor( args: IncreaseReplicationFactorCommandInput, cb: (err: any, data?: IncreaseReplicationFactorCommandOutput) => void ): void; - public increaseReplicationFactor( + increaseReplicationFactor( args: IncreaseReplicationFactorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IncreaseReplicationFactorCommandOutput) => void ): void; - public increaseReplicationFactor( - args: IncreaseReplicationFactorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: IncreaseReplicationFactorCommandOutput) => void), - cb?: (err: any, data?: IncreaseReplicationFactorCommandOutput) => void - ): Promise | void { - const command = new IncreaseReplicationFactorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all of the tags for a DAX cluster. You can call ListTags up to - * 10 times per second, per account.

+ * @see {@link ListTagsCommand} */ - public listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; - public listTags( + listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; + listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; + listTags( args: ListTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsCommandOutput) => void ): void; - public listTags( - args: ListTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsCommandOutput) => void), - cb?: (err: any, data?: ListTagsCommandOutput) => void - ): Promise | void { - const command = new ListTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Reboots a single node of a DAX cluster. The reboot action takes place - * as soon as possible. During the - * reboot, the node status is set to REBOOTING.

- * - *

- * RebootNode restarts the DAX engine process and does not remove the contents of the cache.

- *
+ * @see {@link RebootNodeCommand} */ - public rebootNode(args: RebootNodeCommandInput, options?: __HttpHandlerOptions): Promise; - public rebootNode(args: RebootNodeCommandInput, cb: (err: any, data?: RebootNodeCommandOutput) => void): void; - public rebootNode( + rebootNode(args: RebootNodeCommandInput, options?: __HttpHandlerOptions): Promise; + rebootNode(args: RebootNodeCommandInput, cb: (err: any, data?: RebootNodeCommandOutput) => void): void; + rebootNode( args: RebootNodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebootNodeCommandOutput) => void ): void; - public rebootNode( - args: RebootNodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RebootNodeCommandOutput) => void), - cb?: (err: any, data?: RebootNodeCommandOutput) => void - ): Promise | void { - const command = new RebootNodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a set of tags with a DAX resource. You can call TagResource up to 5 times per second, per - * account.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the association of tags from a DAX resource. You can call - * UntagResource up to 5 times per second, per account.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the settings for a DAX cluster. You can use this action to change one or - * more cluster configuration parameters by specifying the parameters and the new - * values.

+ * @see {@link UpdateClusterCommand} */ - public updateCluster( - args: UpdateClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateCluster( - args: UpdateClusterCommandInput, - cb: (err: any, data?: UpdateClusterCommandOutput) => void - ): void; - public updateCluster( + updateCluster(args: UpdateClusterCommandInput, options?: __HttpHandlerOptions): Promise; + updateCluster(args: UpdateClusterCommandInput, cb: (err: any, data?: UpdateClusterCommandOutput) => void): void; + updateCluster( args: UpdateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateClusterCommandOutput) => void ): void; - public updateCluster( - args: UpdateClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateClusterCommandOutput) => void), - cb?: (err: any, data?: UpdateClusterCommandOutput) => void - ): Promise | void { - const command = new UpdateClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the parameters of a parameter group. You can modify up to 20 - * parameters in a single request by submitting a list parameter name and value - * pairs.

+ * @see {@link UpdateParameterGroupCommand} */ - public updateParameterGroup( + updateParameterGroup( args: UpdateParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateParameterGroup( + updateParameterGroup( args: UpdateParameterGroupCommandInput, cb: (err: any, data?: UpdateParameterGroupCommandOutput) => void ): void; - public updateParameterGroup( + updateParameterGroup( args: UpdateParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateParameterGroupCommandOutput) => void ): void; - public updateParameterGroup( - args: UpdateParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateParameterGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateParameterGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies an existing subnet group.

+ * @see {@link UpdateSubnetGroupCommand} */ - public updateSubnetGroup( + updateSubnetGroup( args: UpdateSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSubnetGroup( + updateSubnetGroup( args: UpdateSubnetGroupCommandInput, cb: (err: any, data?: UpdateSubnetGroupCommandOutput) => void ): void; - public updateSubnetGroup( + updateSubnetGroup( args: UpdateSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSubnetGroupCommandOutput) => void ): void; - public updateSubnetGroup( - args: UpdateSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

DAX is a managed caching service engineered for Amazon DynamoDB. DAX + * dramatically speeds up database reads by caching frequently-accessed data from DynamoDB, so + * applications can access that data with sub-millisecond latency. You can create a DAX + * cluster easily, using the AWS Management Console. With a few simple modifications to + * your code, your application can begin taking advantage of the DAX cluster and realize + * significant improvements in read performance.

+ */ +export class DAX extends DAXClient implements DAX {} +createAggregatedClient(commands, DAX); diff --git a/clients/client-detective/src/Detective.ts b/clients/client-detective/src/Detective.ts index 106e7bba149c..0a08a5d768ae 100644 --- a/clients/client-detective/src/Detective.ts +++ b/clients/client-detective/src/Detective.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -97,966 +98,466 @@ import { UpdateOrganizationConfigurationCommandInput, UpdateOrganizationConfigurationCommandOutput, } from "./commands/UpdateOrganizationConfigurationCommand"; -import { DetectiveClient } from "./DetectiveClient"; +import { DetectiveClient, DetectiveClientConfig } from "./DetectiveClient"; -/** - * @public - *

Detective uses machine learning and purpose-built visualizations to help you to - * analyze and investigate security issues across your Amazon Web Services (Amazon Web Services) workloads. Detective automatically extracts time-based events such - * as login attempts, API calls, and network traffic from CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by - * Amazon GuardDuty.

- *

The Detective API primarily supports the creation and management of behavior - * graphs. A behavior graph contains the extracted data from a set of member accounts, and is - * created and managed by an administrator account.

- *

To add a member account to the behavior graph, the administrator account sends an - * invitation to the account. When the account accepts the invitation, it becomes a member - * account in the behavior graph.

- *

Detective is also integrated with Organizations. The organization - * management account designates the Detective administrator account for the - * organization. That account becomes the administrator account for the organization behavior - * graph. The Detective administrator account is also the delegated administrator - * account for Detective in Organizations.

- *

The Detective administrator account can enable any organization account as a - * member account in the organization behavior graph. The organization accounts do not receive - * invitations. The Detective administrator account can also invite other accounts to - * the organization behavior graph.

- *

Every behavior graph is specific to a Region. You can only use the API to manage - * behavior graphs that belong to the Region that is associated with the currently selected - * endpoint.

- *

The administrator account for a behavior graph can use the Detective API to do - * the following:

- *
    - *
  • - *

    Enable and disable Detective. Enabling Detective creates a new - * behavior graph.

    - *
  • - *
  • - *

    View the list of member accounts in a behavior graph.

    - *
  • - *
  • - *

    Add member accounts to a behavior graph.

    - *
  • - *
  • - *

    Remove member accounts from a behavior graph.

    - *
  • - *
  • - *

    Apply tags to a behavior graph.

    - *
  • - *
- *

The organization management account can use the Detective API to select the - * delegated administrator for Detective.

- *

The Detective administrator account for an organization can use the Detective API to do the following:

- *
    - *
  • - *

    Perform all of the functions of an administrator account.

    - *
  • - *
  • - *

    Determine whether to automatically enable new organization accounts as member - * accounts in the organization behavior graph.

    - *
  • - *
- *

An invited member account can use the Detective API to do the following:

- *
    - *
  • - *

    View the list of behavior graphs that they are invited to.

    - *
  • - *
  • - *

    Accept an invitation to contribute to a behavior graph.

    - *
  • - *
  • - *

    Decline an invitation to contribute to a behavior graph.

    - *
  • - *
  • - *

    Remove their account from a behavior graph.

    - *
  • - *
- *

All API actions are logged as CloudTrail events. See Logging Detective API Calls with CloudTrail.

- * - *

We replaced the term "master account" with the term "administrator account." An - * administrator account is used to centrally manage multiple accounts. In the case of - * Detective, the administrator account manages the accounts in their behavior - * graph.

- *
- */ -export class Detective extends DetectiveClient { +const commands = { + AcceptInvitationCommand, + BatchGetGraphMemberDatasourcesCommand, + BatchGetMembershipDatasourcesCommand, + CreateGraphCommand, + CreateMembersCommand, + DeleteGraphCommand, + DeleteMembersCommand, + DescribeOrganizationConfigurationCommand, + DisableOrganizationAdminAccountCommand, + DisassociateMembershipCommand, + EnableOrganizationAdminAccountCommand, + GetMembersCommand, + ListDatasourcePackagesCommand, + ListGraphsCommand, + ListInvitationsCommand, + ListMembersCommand, + ListOrganizationAdminAccountsCommand, + ListTagsForResourceCommand, + RejectInvitationCommand, + StartMonitoringMemberCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateDatasourcePackagesCommand, + UpdateOrganizationConfigurationCommand, +}; + +export interface Detective { /** - * @public - *

Accepts an invitation for the member account to contribute data to a behavior graph. - * This operation can only be called by an invited member account.

- *

The request provides the ARN of behavior graph.

- *

The member account status in the graph must be INVITED.

+ * @see {@link AcceptInvitationCommand} */ - public acceptInvitation( + acceptInvitation( args: AcceptInvitationCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptInvitation( + acceptInvitation( args: AcceptInvitationCommandInput, cb: (err: any, data?: AcceptInvitationCommandOutput) => void ): void; - public acceptInvitation( + acceptInvitation( args: AcceptInvitationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptInvitationCommandOutput) => void ): void; - public acceptInvitation( - args: AcceptInvitationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptInvitationCommandOutput) => void), - cb?: (err: any, data?: AcceptInvitationCommandOutput) => void - ): Promise | void { - const command = new AcceptInvitationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets data source package information for the behavior graph.

+ * @see {@link BatchGetGraphMemberDatasourcesCommand} */ - public batchGetGraphMemberDatasources( + batchGetGraphMemberDatasources( args: BatchGetGraphMemberDatasourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetGraphMemberDatasources( + batchGetGraphMemberDatasources( args: BatchGetGraphMemberDatasourcesCommandInput, cb: (err: any, data?: BatchGetGraphMemberDatasourcesCommandOutput) => void ): void; - public batchGetGraphMemberDatasources( + batchGetGraphMemberDatasources( args: BatchGetGraphMemberDatasourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetGraphMemberDatasourcesCommandOutput) => void ): void; - public batchGetGraphMemberDatasources( - args: BatchGetGraphMemberDatasourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetGraphMemberDatasourcesCommandOutput) => void), - cb?: (err: any, data?: BatchGetGraphMemberDatasourcesCommandOutput) => void - ): Promise | void { - const command = new BatchGetGraphMemberDatasourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information on the data source package history for an account.

+ * @see {@link BatchGetMembershipDatasourcesCommand} */ - public batchGetMembershipDatasources( + batchGetMembershipDatasources( args: BatchGetMembershipDatasourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetMembershipDatasources( + batchGetMembershipDatasources( args: BatchGetMembershipDatasourcesCommandInput, cb: (err: any, data?: BatchGetMembershipDatasourcesCommandOutput) => void ): void; - public batchGetMembershipDatasources( + batchGetMembershipDatasources( args: BatchGetMembershipDatasourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetMembershipDatasourcesCommandOutput) => void ): void; - public batchGetMembershipDatasources( - args: BatchGetMembershipDatasourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetMembershipDatasourcesCommandOutput) => void), - cb?: (err: any, data?: BatchGetMembershipDatasourcesCommandOutput) => void - ): Promise | void { - const command = new BatchGetMembershipDatasourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new behavior graph for the calling account, and sets that account as the - * administrator account. This operation is called by the account that is enabling Detective.

- *

Before you try to enable Detective, make sure that your account has been - * enrolled in Amazon GuardDuty for at least 48 hours. If you do not meet this - * requirement, you cannot enable Detective. If you do meet the GuardDuty - * prerequisite, then when you make the request to enable Detective, it checks - * whether your data volume is within the Detective quota. If it exceeds the quota, - * then you cannot enable Detective.

- *

The operation also enables Detective for the calling account in the currently - * selected Region. It returns the ARN of the new behavior graph.

- *

- * CreateGraph triggers a process to create the corresponding data tables for - * the new behavior graph.

- *

An account can only be the administrator account for one behavior graph within a Region. - * If the same account calls CreateGraph with the same administrator account, it - * always returns the same behavior graph ARN. It does not create a new behavior graph.

+ * @see {@link CreateGraphCommand} */ - public createGraph(args: CreateGraphCommandInput, options?: __HttpHandlerOptions): Promise; - public createGraph(args: CreateGraphCommandInput, cb: (err: any, data?: CreateGraphCommandOutput) => void): void; - public createGraph( + createGraph(args: CreateGraphCommandInput, options?: __HttpHandlerOptions): Promise; + createGraph(args: CreateGraphCommandInput, cb: (err: any, data?: CreateGraphCommandOutput) => void): void; + createGraph( args: CreateGraphCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGraphCommandOutput) => void ): void; - public createGraph( - args: CreateGraphCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGraphCommandOutput) => void), - cb?: (err: any, data?: CreateGraphCommandOutput) => void - ): Promise | void { - const command = new CreateGraphCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * CreateMembers is used to send invitations to accounts. For the organization - * behavior graph, the Detective administrator account uses - * CreateMembers to enable organization accounts as member accounts.

- *

For invited accounts, CreateMembers sends a request to invite the specified - * Amazon Web Services accounts to be member accounts in the behavior graph. This operation - * can only be called by the administrator account for a behavior graph.

- *

- * CreateMembers verifies the accounts and then invites the verified accounts. - * The administrator can optionally specify to not send invitation emails to the member - * accounts. This would be used when the administrator manages their member accounts - * centrally.

- *

For organization accounts in the organization behavior graph, CreateMembers - * attempts to enable the accounts. The organization accounts do not receive - * invitations.

- *

The request provides the behavior graph ARN and the list of accounts to invite or to - * enable.

- *

The response separates the requested accounts into two lists:

- *
    - *
  • - *

    The accounts that CreateMembers was able to process. For invited - * accounts, includes member accounts that are being verified, that have passed - * verification and are to be invited, and that have failed verification. For - * organization accounts in the organization behavior graph, includes accounts that can - * be enabled and that cannot be enabled.

    - *
  • - *
  • - *

    The accounts that CreateMembers was unable to process. This list - * includes accounts that were already invited to be member accounts in the behavior - * graph.

    - *
  • - *
+ * @see {@link CreateMembersCommand} */ - public createMembers( - args: CreateMembersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createMembers( - args: CreateMembersCommandInput, - cb: (err: any, data?: CreateMembersCommandOutput) => void - ): void; - public createMembers( + createMembers(args: CreateMembersCommandInput, options?: __HttpHandlerOptions): Promise; + createMembers(args: CreateMembersCommandInput, cb: (err: any, data?: CreateMembersCommandOutput) => void): void; + createMembers( args: CreateMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMembersCommandOutput) => void ): void; - public createMembers( - args: CreateMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMembersCommandOutput) => void), - cb?: (err: any, data?: CreateMembersCommandOutput) => void - ): Promise | void { - const command = new CreateMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables the specified behavior graph and queues it to be deleted. This operation - * removes the behavior graph from each member account's list of behavior graphs.

- *

- * DeleteGraph can only be called by the administrator account for a behavior - * graph.

+ * @see {@link DeleteGraphCommand} */ - public deleteGraph(args: DeleteGraphCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteGraph(args: DeleteGraphCommandInput, cb: (err: any, data?: DeleteGraphCommandOutput) => void): void; - public deleteGraph( + deleteGraph(args: DeleteGraphCommandInput, options?: __HttpHandlerOptions): Promise; + deleteGraph(args: DeleteGraphCommandInput, cb: (err: any, data?: DeleteGraphCommandOutput) => void): void; + deleteGraph( args: DeleteGraphCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGraphCommandOutput) => void ): void; - public deleteGraph( - args: DeleteGraphCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGraphCommandOutput) => void), - cb?: (err: any, data?: DeleteGraphCommandOutput) => void - ): Promise | void { - const command = new DeleteGraphCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified member accounts from the behavior graph. The removed accounts no - * longer contribute data to the behavior graph. This operation can only be called by the - * administrator account for the behavior graph.

- *

For invited accounts, the removed accounts are deleted from the list of accounts in the - * behavior graph. To restore the account, the administrator account must send another - * invitation.

- *

For organization accounts in the organization behavior graph, the Detective - * administrator account can always enable the organization account again. Organization - * accounts that are not enabled as member accounts are not included in the - * ListMembers results for the organization behavior graph.

- *

An administrator account cannot use DeleteMembers to remove their own - * account from the behavior graph. To disable a behavior graph, the administrator account - * uses the DeleteGraph API method.

+ * @see {@link DeleteMembersCommand} */ - public deleteMembers( - args: DeleteMembersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteMembers( - args: DeleteMembersCommandInput, - cb: (err: any, data?: DeleteMembersCommandOutput) => void - ): void; - public deleteMembers( + deleteMembers(args: DeleteMembersCommandInput, options?: __HttpHandlerOptions): Promise; + deleteMembers(args: DeleteMembersCommandInput, cb: (err: any, data?: DeleteMembersCommandOutput) => void): void; + deleteMembers( args: DeleteMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMembersCommandOutput) => void ): void; - public deleteMembers( - args: DeleteMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMembersCommandOutput) => void), - cb?: (err: any, data?: DeleteMembersCommandOutput) => void - ): Promise | void { - const command = new DeleteMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the configuration for the organization behavior graph. - * Currently indicates whether to automatically enable new organization accounts as member - * accounts.

- *

Can only be called by the Detective administrator account for the organization.

+ * @see {@link DescribeOrganizationConfigurationCommand} */ - public describeOrganizationConfiguration( + describeOrganizationConfiguration( args: DescribeOrganizationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOrganizationConfiguration( + describeOrganizationConfiguration( args: DescribeOrganizationConfigurationCommandInput, cb: (err: any, data?: DescribeOrganizationConfigurationCommandOutput) => void ): void; - public describeOrganizationConfiguration( + describeOrganizationConfiguration( args: DescribeOrganizationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrganizationConfigurationCommandOutput) => void ): void; - public describeOrganizationConfiguration( - args: DescribeOrganizationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOrganizationConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeOrganizationConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeOrganizationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the Detective administrator account in the current Region. Deletes the - * organization behavior graph.

- *

Can only be called by the organization management account.

- *

Removing the Detective administrator account does not affect the delegated - * administrator account for Detective in Organizations.

- *

To remove the delegated administrator account in Organizations, use the Organizations API. Removing the delegated administrator account also removes the Detective administrator account in all Regions, except for Regions where the Detective administrator account is the organization management account.

+ * @see {@link DisableOrganizationAdminAccountCommand} */ - public disableOrganizationAdminAccount( + disableOrganizationAdminAccount( args: DisableOrganizationAdminAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableOrganizationAdminAccount( + disableOrganizationAdminAccount( args: DisableOrganizationAdminAccountCommandInput, cb: (err: any, data?: DisableOrganizationAdminAccountCommandOutput) => void ): void; - public disableOrganizationAdminAccount( + disableOrganizationAdminAccount( args: DisableOrganizationAdminAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableOrganizationAdminAccountCommandOutput) => void ): void; - public disableOrganizationAdminAccount( - args: DisableOrganizationAdminAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableOrganizationAdminAccountCommandOutput) => void), - cb?: (err: any, data?: DisableOrganizationAdminAccountCommandOutput) => void - ): Promise | void { - const command = new DisableOrganizationAdminAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the member account from the specified behavior graph. This operation can only be - * called by an invited member account that has the ENABLED status.

- *

- * DisassociateMembership cannot be called by an organization account in the - * organization behavior graph. For the organization behavior graph, the Detective - * administrator account determines which organization accounts to enable or disable as member - * accounts.

+ * @see {@link DisassociateMembershipCommand} */ - public disassociateMembership( + disassociateMembership( args: DisassociateMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateMembership( + disassociateMembership( args: DisassociateMembershipCommandInput, cb: (err: any, data?: DisassociateMembershipCommandOutput) => void ): void; - public disassociateMembership( + disassociateMembership( args: DisassociateMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateMembershipCommandOutput) => void ): void; - public disassociateMembership( - args: DisassociateMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateMembershipCommandOutput) => void), - cb?: (err: any, data?: DisassociateMembershipCommandOutput) => void - ): Promise | void { - const command = new DisassociateMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Designates the Detective administrator account for the organization in the - * current Region.

- *

If the account does not have Detective enabled, then enables Detective - * for that account and creates a new behavior graph.

- *

Can only be called by the organization management account.

- *

If the organization has a delegated administrator account in Organizations, then the - * Detective administrator account must be either the delegated administrator - * account or the organization management account.

- *

If the organization does not have a delegated administrator account in Organizations, then you can choose any account in the organization. If you choose an account other - * than the organization management account, Detective calls Organizations to - * make that account the delegated administrator account for Detective. The - * organization management account cannot be the delegated administrator account.

+ * @see {@link EnableOrganizationAdminAccountCommand} */ - public enableOrganizationAdminAccount( + enableOrganizationAdminAccount( args: EnableOrganizationAdminAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableOrganizationAdminAccount( + enableOrganizationAdminAccount( args: EnableOrganizationAdminAccountCommandInput, cb: (err: any, data?: EnableOrganizationAdminAccountCommandOutput) => void ): void; - public enableOrganizationAdminAccount( + enableOrganizationAdminAccount( args: EnableOrganizationAdminAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableOrganizationAdminAccountCommandOutput) => void ): void; - public enableOrganizationAdminAccount( - args: EnableOrganizationAdminAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableOrganizationAdminAccountCommandOutput) => void), - cb?: (err: any, data?: EnableOrganizationAdminAccountCommandOutput) => void - ): Promise | void { - const command = new EnableOrganizationAdminAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the membership details for specified member accounts for a behavior - * graph.

+ * @see {@link GetMembersCommand} */ - public getMembers(args: GetMembersCommandInput, options?: __HttpHandlerOptions): Promise; - public getMembers(args: GetMembersCommandInput, cb: (err: any, data?: GetMembersCommandOutput) => void): void; - public getMembers( + getMembers(args: GetMembersCommandInput, options?: __HttpHandlerOptions): Promise; + getMembers(args: GetMembersCommandInput, cb: (err: any, data?: GetMembersCommandOutput) => void): void; + getMembers( args: GetMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMembersCommandOutput) => void ): void; - public getMembers( - args: GetMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMembersCommandOutput) => void), - cb?: (err: any, data?: GetMembersCommandOutput) => void - ): Promise | void { - const command = new GetMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists data source packages in the behavior graph.

+ * @see {@link ListDatasourcePackagesCommand} */ - public listDatasourcePackages( + listDatasourcePackages( args: ListDatasourcePackagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDatasourcePackages( + listDatasourcePackages( args: ListDatasourcePackagesCommandInput, cb: (err: any, data?: ListDatasourcePackagesCommandOutput) => void ): void; - public listDatasourcePackages( + listDatasourcePackages( args: ListDatasourcePackagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasourcePackagesCommandOutput) => void ): void; - public listDatasourcePackages( - args: ListDatasourcePackagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatasourcePackagesCommandOutput) => void), - cb?: (err: any, data?: ListDatasourcePackagesCommandOutput) => void - ): Promise | void { - const command = new ListDatasourcePackagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the list of behavior graphs that the calling account is an administrator account - * of. This operation can only be called by an administrator account.

- *

Because an account can currently only be the administrator of one behavior graph within - * a Region, the results always contain a single behavior graph.

+ * @see {@link ListGraphsCommand} */ - public listGraphs(args: ListGraphsCommandInput, options?: __HttpHandlerOptions): Promise; - public listGraphs(args: ListGraphsCommandInput, cb: (err: any, data?: ListGraphsCommandOutput) => void): void; - public listGraphs( + listGraphs(args: ListGraphsCommandInput, options?: __HttpHandlerOptions): Promise; + listGraphs(args: ListGraphsCommandInput, cb: (err: any, data?: ListGraphsCommandOutput) => void): void; + listGraphs( args: ListGraphsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGraphsCommandOutput) => void ): void; - public listGraphs( - args: ListGraphsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGraphsCommandOutput) => void), - cb?: (err: any, data?: ListGraphsCommandOutput) => void - ): Promise | void { - const command = new ListGraphsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the list of open and accepted behavior graph invitations for the member - * account. This operation can only be called by an invited member account.

- *

Open invitations are invitations that the member account has not responded to.

- *

The results do not include behavior graphs for which the member account declined the - * invitation. The results also do not include behavior graphs that the member account - * resigned from or was removed from.

+ * @see {@link ListInvitationsCommand} */ - public listInvitations( + listInvitations( args: ListInvitationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInvitations( - args: ListInvitationsCommandInput, - cb: (err: any, data?: ListInvitationsCommandOutput) => void - ): void; - public listInvitations( + listInvitations(args: ListInvitationsCommandInput, cb: (err: any, data?: ListInvitationsCommandOutput) => void): void; + listInvitations( args: ListInvitationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInvitationsCommandOutput) => void ): void; - public listInvitations( - args: ListInvitationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInvitationsCommandOutput) => void), - cb?: (err: any, data?: ListInvitationsCommandOutput) => void - ): Promise | void { - const command = new ListInvitationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the list of member accounts for a behavior graph.

- *

For invited accounts, the results do not include member accounts that were removed from - * the behavior graph.

- *

For the organization behavior graph, the results do not include organization accounts - * that the Detective administrator account has not enabled as member - * accounts.

+ * @see {@link ListMembersCommand} */ - public listMembers(args: ListMembersCommandInput, options?: __HttpHandlerOptions): Promise; - public listMembers(args: ListMembersCommandInput, cb: (err: any, data?: ListMembersCommandOutput) => void): void; - public listMembers( + listMembers(args: ListMembersCommandInput, options?: __HttpHandlerOptions): Promise; + listMembers(args: ListMembersCommandInput, cb: (err: any, data?: ListMembersCommandOutput) => void): void; + listMembers( args: ListMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMembersCommandOutput) => void ): void; - public listMembers( - args: ListMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMembersCommandOutput) => void), - cb?: (err: any, data?: ListMembersCommandOutput) => void - ): Promise | void { - const command = new ListMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the Detective administrator account for an - * organization. Can only be called by the organization management account.

+ * @see {@link ListOrganizationAdminAccountsCommand} */ - public listOrganizationAdminAccounts( + listOrganizationAdminAccounts( args: ListOrganizationAdminAccountsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOrganizationAdminAccounts( + listOrganizationAdminAccounts( args: ListOrganizationAdminAccountsCommandInput, cb: (err: any, data?: ListOrganizationAdminAccountsCommandOutput) => void ): void; - public listOrganizationAdminAccounts( + listOrganizationAdminAccounts( args: ListOrganizationAdminAccountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOrganizationAdminAccountsCommandOutput) => void ): void; - public listOrganizationAdminAccounts( - args: ListOrganizationAdminAccountsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOrganizationAdminAccountsCommandOutput) => void), - cb?: (err: any, data?: ListOrganizationAdminAccountsCommandOutput) => void - ): Promise | void { - const command = new ListOrganizationAdminAccountsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the tag values that are assigned to a behavior graph.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Rejects an invitation to contribute the account data to a behavior graph. This operation - * must be called by an invited member account that has the INVITED - * status.

- *

- * RejectInvitation cannot be called by an organization account in the - * organization behavior graph. In the organization behavior graph, organization accounts do - * not receive an invitation.

+ * @see {@link RejectInvitationCommand} */ - public rejectInvitation( + rejectInvitation( args: RejectInvitationCommandInput, options?: __HttpHandlerOptions ): Promise; - public rejectInvitation( + rejectInvitation( args: RejectInvitationCommandInput, cb: (err: any, data?: RejectInvitationCommandOutput) => void ): void; - public rejectInvitation( + rejectInvitation( args: RejectInvitationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectInvitationCommandOutput) => void ): void; - public rejectInvitation( - args: RejectInvitationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RejectInvitationCommandOutput) => void), - cb?: (err: any, data?: RejectInvitationCommandOutput) => void - ): Promise | void { - const command = new RejectInvitationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sends a request to enable data ingest for a member account that has a status of - * ACCEPTED_BUT_DISABLED.

- *

For valid member accounts, the status is updated as follows.

- *
    - *
  • - *

    If Detective enabled the member account, then the new status is - * ENABLED.

    - *
  • - *
  • - *

    If Detective cannot enable the member account, the status remains - * ACCEPTED_BUT_DISABLED.

    - *
  • - *
+ * @see {@link StartMonitoringMemberCommand} */ - public startMonitoringMember( + startMonitoringMember( args: StartMonitoringMemberCommandInput, options?: __HttpHandlerOptions ): Promise; - public startMonitoringMember( + startMonitoringMember( args: StartMonitoringMemberCommandInput, cb: (err: any, data?: StartMonitoringMemberCommandOutput) => void ): void; - public startMonitoringMember( + startMonitoringMember( args: StartMonitoringMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMonitoringMemberCommandOutput) => void ): void; - public startMonitoringMember( - args: StartMonitoringMemberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartMonitoringMemberCommandOutput) => void), - cb?: (err: any, data?: StartMonitoringMemberCommandOutput) => void - ): Promise | void { - const command = new StartMonitoringMemberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Applies tag values to a behavior graph.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from a behavior graph.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a data source packages for the behavior graph.

+ * @see {@link UpdateDatasourcePackagesCommand} */ - public updateDatasourcePackages( + updateDatasourcePackages( args: UpdateDatasourcePackagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDatasourcePackages( + updateDatasourcePackages( args: UpdateDatasourcePackagesCommandInput, cb: (err: any, data?: UpdateDatasourcePackagesCommandOutput) => void ): void; - public updateDatasourcePackages( + updateDatasourcePackages( args: UpdateDatasourcePackagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDatasourcePackagesCommandOutput) => void ): void; - public updateDatasourcePackages( - args: UpdateDatasourcePackagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDatasourcePackagesCommandOutput) => void), - cb?: (err: any, data?: UpdateDatasourcePackagesCommandOutput) => void - ): Promise | void { - const command = new UpdateDatasourcePackagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the configuration for the Organizations integration in the current Region. - * Can only be called by the Detective administrator account for the - * organization.

+ * @see {@link UpdateOrganizationConfigurationCommand} */ - public updateOrganizationConfiguration( + updateOrganizationConfiguration( args: UpdateOrganizationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateOrganizationConfiguration( + updateOrganizationConfiguration( args: UpdateOrganizationConfigurationCommandInput, cb: (err: any, data?: UpdateOrganizationConfigurationCommandOutput) => void ): void; - public updateOrganizationConfiguration( + updateOrganizationConfiguration( args: UpdateOrganizationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateOrganizationConfigurationCommandOutput) => void ): void; - public updateOrganizationConfiguration( - args: UpdateOrganizationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateOrganizationConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateOrganizationConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateOrganizationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Detective uses machine learning and purpose-built visualizations to help you to + * analyze and investigate security issues across your Amazon Web Services (Amazon Web Services) workloads. Detective automatically extracts time-based events such + * as login attempts, API calls, and network traffic from CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by + * Amazon GuardDuty.

+ *

The Detective API primarily supports the creation and management of behavior + * graphs. A behavior graph contains the extracted data from a set of member accounts, and is + * created and managed by an administrator account.

+ *

To add a member account to the behavior graph, the administrator account sends an + * invitation to the account. When the account accepts the invitation, it becomes a member + * account in the behavior graph.

+ *

Detective is also integrated with Organizations. The organization + * management account designates the Detective administrator account for the + * organization. That account becomes the administrator account for the organization behavior + * graph. The Detective administrator account is also the delegated administrator + * account for Detective in Organizations.

+ *

The Detective administrator account can enable any organization account as a + * member account in the organization behavior graph. The organization accounts do not receive + * invitations. The Detective administrator account can also invite other accounts to + * the organization behavior graph.

+ *

Every behavior graph is specific to a Region. You can only use the API to manage + * behavior graphs that belong to the Region that is associated with the currently selected + * endpoint.

+ *

The administrator account for a behavior graph can use the Detective API to do + * the following:

+ *
    + *
  • + *

    Enable and disable Detective. Enabling Detective creates a new + * behavior graph.

    + *
  • + *
  • + *

    View the list of member accounts in a behavior graph.

    + *
  • + *
  • + *

    Add member accounts to a behavior graph.

    + *
  • + *
  • + *

    Remove member accounts from a behavior graph.

    + *
  • + *
  • + *

    Apply tags to a behavior graph.

    + *
  • + *
+ *

The organization management account can use the Detective API to select the + * delegated administrator for Detective.

+ *

The Detective administrator account for an organization can use the Detective API to do the following:

+ *
    + *
  • + *

    Perform all of the functions of an administrator account.

    + *
  • + *
  • + *

    Determine whether to automatically enable new organization accounts as member + * accounts in the organization behavior graph.

    + *
  • + *
+ *

An invited member account can use the Detective API to do the following:

+ *
    + *
  • + *

    View the list of behavior graphs that they are invited to.

    + *
  • + *
  • + *

    Accept an invitation to contribute to a behavior graph.

    + *
  • + *
  • + *

    Decline an invitation to contribute to a behavior graph.

    + *
  • + *
  • + *

    Remove their account from a behavior graph.

    + *
  • + *
+ *

All API actions are logged as CloudTrail events. See Logging Detective API Calls with CloudTrail.

+ * + *

We replaced the term "master account" with the term "administrator account." An + * administrator account is used to centrally manage multiple accounts. In the case of + * Detective, the administrator account manages the accounts in their behavior + * graph.

+ *
+ */ +export class Detective extends DetectiveClient implements Detective {} +createAggregatedClient(commands, Detective); diff --git a/clients/client-device-farm/src/DeviceFarm.ts b/clients/client-device-farm/src/DeviceFarm.ts index be58104deac5..d0d921e3d3a5 100644 --- a/clients/client-device-farm/src/DeviceFarm.ts +++ b/clients/client-device-farm/src/DeviceFarm.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -310,2498 +311,1227 @@ import { UpdateVPCEConfigurationCommandInput, UpdateVPCEConfigurationCommandOutput, } from "./commands/UpdateVPCEConfigurationCommand"; -import { DeviceFarmClient } from "./DeviceFarmClient"; +import { DeviceFarmClient, DeviceFarmClientConfig } from "./DeviceFarmClient"; -/** - * @public - *

Welcome to the AWS Device Farm API documentation, which contains APIs for:

- *
    - *
  • - *

    Testing on desktop browsers

    - *

    Device Farm makes it possible for you to test your web applications on desktop browsers using - * Selenium. The APIs for desktop browser testing contain TestGrid in their names. For - * more information, see Testing Web - * Applications on Selenium with Device Farm.

    - *
  • - *
  • - *

    Testing on real mobile devices

    - *

    Device Farm makes it possible for you to test apps on physical phones, tablets, and other - * devices in the cloud. For more information, see the Device Farm Developer Guide.

    - *
  • - *
- */ -export class DeviceFarm extends DeviceFarmClient { +const commands = { + CreateDevicePoolCommand, + CreateInstanceProfileCommand, + CreateNetworkProfileCommand, + CreateProjectCommand, + CreateRemoteAccessSessionCommand, + CreateTestGridProjectCommand, + CreateTestGridUrlCommand, + CreateUploadCommand, + CreateVPCEConfigurationCommand, + DeleteDevicePoolCommand, + DeleteInstanceProfileCommand, + DeleteNetworkProfileCommand, + DeleteProjectCommand, + DeleteRemoteAccessSessionCommand, + DeleteRunCommand, + DeleteTestGridProjectCommand, + DeleteUploadCommand, + DeleteVPCEConfigurationCommand, + GetAccountSettingsCommand, + GetDeviceCommand, + GetDeviceInstanceCommand, + GetDevicePoolCommand, + GetDevicePoolCompatibilityCommand, + GetInstanceProfileCommand, + GetJobCommand, + GetNetworkProfileCommand, + GetOfferingStatusCommand, + GetProjectCommand, + GetRemoteAccessSessionCommand, + GetRunCommand, + GetSuiteCommand, + GetTestCommand, + GetTestGridProjectCommand, + GetTestGridSessionCommand, + GetUploadCommand, + GetVPCEConfigurationCommand, + InstallToRemoteAccessSessionCommand, + ListArtifactsCommand, + ListDeviceInstancesCommand, + ListDevicePoolsCommand, + ListDevicesCommand, + ListInstanceProfilesCommand, + ListJobsCommand, + ListNetworkProfilesCommand, + ListOfferingPromotionsCommand, + ListOfferingsCommand, + ListOfferingTransactionsCommand, + ListProjectsCommand, + ListRemoteAccessSessionsCommand, + ListRunsCommand, + ListSamplesCommand, + ListSuitesCommand, + ListTagsForResourceCommand, + ListTestGridProjectsCommand, + ListTestGridSessionActionsCommand, + ListTestGridSessionArtifactsCommand, + ListTestGridSessionsCommand, + ListTestsCommand, + ListUniqueProblemsCommand, + ListUploadsCommand, + ListVPCEConfigurationsCommand, + PurchaseOfferingCommand, + RenewOfferingCommand, + ScheduleRunCommand, + StopJobCommand, + StopRemoteAccessSessionCommand, + StopRunCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateDeviceInstanceCommand, + UpdateDevicePoolCommand, + UpdateInstanceProfileCommand, + UpdateNetworkProfileCommand, + UpdateProjectCommand, + UpdateTestGridProjectCommand, + UpdateUploadCommand, + UpdateVPCEConfigurationCommand, +}; + +export interface DeviceFarm { /** - * @public - *

Creates a device pool.

+ * @see {@link CreateDevicePoolCommand} */ - public createDevicePool( + createDevicePool( args: CreateDevicePoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDevicePool( + createDevicePool( args: CreateDevicePoolCommandInput, cb: (err: any, data?: CreateDevicePoolCommandOutput) => void ): void; - public createDevicePool( + createDevicePool( args: CreateDevicePoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDevicePoolCommandOutput) => void ): void; - public createDevicePool( - args: CreateDevicePoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDevicePoolCommandOutput) => void), - cb?: (err: any, data?: CreateDevicePoolCommandOutput) => void - ): Promise | void { - const command = new CreateDevicePoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a profile that can be applied to one or more private fleet device - * instances.

- */ - public createInstanceProfile( + + /** + * @see {@link CreateInstanceProfileCommand} + */ + createInstanceProfile( args: CreateInstanceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public createInstanceProfile( + createInstanceProfile( args: CreateInstanceProfileCommandInput, cb: (err: any, data?: CreateInstanceProfileCommandOutput) => void ): void; - public createInstanceProfile( + createInstanceProfile( args: CreateInstanceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInstanceProfileCommandOutput) => void ): void; - public createInstanceProfile( - args: CreateInstanceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateInstanceProfileCommandOutput) => void), - cb?: (err: any, data?: CreateInstanceProfileCommandOutput) => void - ): Promise | void { - const command = new CreateInstanceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a network profile.

- */ - public createNetworkProfile( + + /** + * @see {@link CreateNetworkProfileCommand} + */ + createNetworkProfile( args: CreateNetworkProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNetworkProfile( + createNetworkProfile( args: CreateNetworkProfileCommandInput, cb: (err: any, data?: CreateNetworkProfileCommandOutput) => void ): void; - public createNetworkProfile( + createNetworkProfile( args: CreateNetworkProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNetworkProfileCommandOutput) => void ): void; - public createNetworkProfile( - args: CreateNetworkProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNetworkProfileCommandOutput) => void), - cb?: (err: any, data?: CreateNetworkProfileCommandOutput) => void - ): Promise | void { - const command = new CreateNetworkProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a project.

- */ - public createProject( - args: CreateProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createProject( - args: CreateProjectCommandInput, - cb: (err: any, data?: CreateProjectCommandOutput) => void - ): void; - public createProject( + + /** + * @see {@link CreateProjectCommand} + */ + createProject(args: CreateProjectCommandInput, options?: __HttpHandlerOptions): Promise; + createProject(args: CreateProjectCommandInput, cb: (err: any, data?: CreateProjectCommandOutput) => void): void; + createProject( args: CreateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectCommandOutput) => void ): void; - public createProject( - args: CreateProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProjectCommandOutput) => void), - cb?: (err: any, data?: CreateProjectCommandOutput) => void - ): Promise | void { - const command = new CreateProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Specifies and starts a remote access session.

- */ - public createRemoteAccessSession( + + /** + * @see {@link CreateRemoteAccessSessionCommand} + */ + createRemoteAccessSession( args: CreateRemoteAccessSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRemoteAccessSession( + createRemoteAccessSession( args: CreateRemoteAccessSessionCommandInput, cb: (err: any, data?: CreateRemoteAccessSessionCommandOutput) => void ): void; - public createRemoteAccessSession( + createRemoteAccessSession( args: CreateRemoteAccessSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRemoteAccessSessionCommandOutput) => void ): void; - public createRemoteAccessSession( - args: CreateRemoteAccessSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRemoteAccessSessionCommandOutput) => void), - cb?: (err: any, data?: CreateRemoteAccessSessionCommandOutput) => void - ): Promise | void { - const command = new CreateRemoteAccessSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Selenium testing project. Projects are used to track TestGridSession - * instances.

- */ - public createTestGridProject( + + /** + * @see {@link CreateTestGridProjectCommand} + */ + createTestGridProject( args: CreateTestGridProjectCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTestGridProject( + createTestGridProject( args: CreateTestGridProjectCommandInput, cb: (err: any, data?: CreateTestGridProjectCommandOutput) => void ): void; - public createTestGridProject( + createTestGridProject( args: CreateTestGridProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTestGridProjectCommandOutput) => void ): void; - public createTestGridProject( - args: CreateTestGridProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTestGridProjectCommandOutput) => void), - cb?: (err: any, data?: CreateTestGridProjectCommandOutput) => void - ): Promise | void { - const command = new CreateTestGridProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a signed, short-term URL that can be passed to a Selenium RemoteWebDriver - * constructor.

- */ - public createTestGridUrl( + + /** + * @see {@link CreateTestGridUrlCommand} + */ + createTestGridUrl( args: CreateTestGridUrlCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTestGridUrl( + createTestGridUrl( args: CreateTestGridUrlCommandInput, cb: (err: any, data?: CreateTestGridUrlCommandOutput) => void ): void; - public createTestGridUrl( + createTestGridUrl( args: CreateTestGridUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTestGridUrlCommandOutput) => void ): void; - public createTestGridUrl( - args: CreateTestGridUrlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTestGridUrlCommandOutput) => void), - cb?: (err: any, data?: CreateTestGridUrlCommandOutput) => void - ): Promise | void { - const command = new CreateTestGridUrlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Uploads an app or test scripts.

- */ - public createUpload( - args: CreateUploadCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createUpload(args: CreateUploadCommandInput, cb: (err: any, data?: CreateUploadCommandOutput) => void): void; - public createUpload( + + /** + * @see {@link CreateUploadCommand} + */ + createUpload(args: CreateUploadCommandInput, options?: __HttpHandlerOptions): Promise; + createUpload(args: CreateUploadCommandInput, cb: (err: any, data?: CreateUploadCommandOutput) => void): void; + createUpload( args: CreateUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUploadCommandOutput) => void ): void; - public createUpload( - args: CreateUploadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUploadCommandOutput) => void), - cb?: (err: any, data?: CreateUploadCommandOutput) => void - ): Promise | void { - const command = new CreateUploadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud - * (VPC) endpoint.

- */ - public createVPCEConfiguration( + + /** + * @see {@link CreateVPCEConfigurationCommand} + */ + createVPCEConfiguration( args: CreateVPCEConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVPCEConfiguration( + createVPCEConfiguration( args: CreateVPCEConfigurationCommandInput, cb: (err: any, data?: CreateVPCEConfigurationCommandOutput) => void ): void; - public createVPCEConfiguration( + createVPCEConfiguration( args: CreateVPCEConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVPCEConfigurationCommandOutput) => void ): void; - public createVPCEConfiguration( - args: CreateVPCEConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVPCEConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateVPCEConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateVPCEConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a device pool given the pool ARN. Does not allow deletion of curated pools - * owned by the system.

- */ - public deleteDevicePool( + + /** + * @see {@link DeleteDevicePoolCommand} + */ + deleteDevicePool( args: DeleteDevicePoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDevicePool( + deleteDevicePool( args: DeleteDevicePoolCommandInput, cb: (err: any, data?: DeleteDevicePoolCommandOutput) => void ): void; - public deleteDevicePool( + deleteDevicePool( args: DeleteDevicePoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDevicePoolCommandOutput) => void ): void; - public deleteDevicePool( - args: DeleteDevicePoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDevicePoolCommandOutput) => void), - cb?: (err: any, data?: DeleteDevicePoolCommandOutput) => void - ): Promise | void { - const command = new DeleteDevicePoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a profile that can be applied to one or more private device instances.

- */ - public deleteInstanceProfile( + + /** + * @see {@link DeleteInstanceProfileCommand} + */ + deleteInstanceProfile( args: DeleteInstanceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInstanceProfile( + deleteInstanceProfile( args: DeleteInstanceProfileCommandInput, cb: (err: any, data?: DeleteInstanceProfileCommandOutput) => void ): void; - public deleteInstanceProfile( + deleteInstanceProfile( args: DeleteInstanceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInstanceProfileCommandOutput) => void ): void; - public deleteInstanceProfile( - args: DeleteInstanceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInstanceProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteInstanceProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteInstanceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a network profile.

- */ - public deleteNetworkProfile( + + /** + * @see {@link DeleteNetworkProfileCommand} + */ + deleteNetworkProfile( args: DeleteNetworkProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNetworkProfile( + deleteNetworkProfile( args: DeleteNetworkProfileCommandInput, cb: (err: any, data?: DeleteNetworkProfileCommandOutput) => void ): void; - public deleteNetworkProfile( + deleteNetworkProfile( args: DeleteNetworkProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNetworkProfileCommandOutput) => void ): void; - public deleteNetworkProfile( - args: DeleteNetworkProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNetworkProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteNetworkProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteNetworkProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an AWS Device Farm project, given the project ARN.

- *

Deleting this resource does not stop an in-progress run.

- */ - public deleteProject( - args: DeleteProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteProject( - args: DeleteProjectCommandInput, - cb: (err: any, data?: DeleteProjectCommandOutput) => void - ): void; - public deleteProject( + + /** + * @see {@link DeleteProjectCommand} + */ + deleteProject(args: DeleteProjectCommandInput, options?: __HttpHandlerOptions): Promise; + deleteProject(args: DeleteProjectCommandInput, cb: (err: any, data?: DeleteProjectCommandOutput) => void): void; + deleteProject( args: DeleteProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProjectCommandOutput) => void ): void; - public deleteProject( - args: DeleteProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProjectCommandOutput) => void), - cb?: (err: any, data?: DeleteProjectCommandOutput) => void - ): Promise | void { - const command = new DeleteProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a completed remote access session and its results.

- */ - public deleteRemoteAccessSession( + + /** + * @see {@link DeleteRemoteAccessSessionCommand} + */ + deleteRemoteAccessSession( args: DeleteRemoteAccessSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRemoteAccessSession( + deleteRemoteAccessSession( args: DeleteRemoteAccessSessionCommandInput, cb: (err: any, data?: DeleteRemoteAccessSessionCommandOutput) => void ): void; - public deleteRemoteAccessSession( + deleteRemoteAccessSession( args: DeleteRemoteAccessSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRemoteAccessSessionCommandOutput) => void ): void; - public deleteRemoteAccessSession( - args: DeleteRemoteAccessSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRemoteAccessSessionCommandOutput) => void), - cb?: (err: any, data?: DeleteRemoteAccessSessionCommandOutput) => void - ): Promise | void { - const command = new DeleteRemoteAccessSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the run, given the run ARN.

- *

Deleting this resource does not stop an in-progress run.

- */ - public deleteRun(args: DeleteRunCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteRun(args: DeleteRunCommandInput, cb: (err: any, data?: DeleteRunCommandOutput) => void): void; - public deleteRun( + + /** + * @see {@link DeleteRunCommand} + */ + deleteRun(args: DeleteRunCommandInput, options?: __HttpHandlerOptions): Promise; + deleteRun(args: DeleteRunCommandInput, cb: (err: any, data?: DeleteRunCommandOutput) => void): void; + deleteRun( args: DeleteRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRunCommandOutput) => void ): void; - public deleteRun( - args: DeleteRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRunCommandOutput) => void), - cb?: (err: any, data?: DeleteRunCommandOutput) => void - ): Promise | void { - const command = new DeleteRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a Selenium testing project and all content generated under it.

- * - *

You cannot undo this operation.

- *
- * - *

You cannot delete a project if it has active sessions.

- *
- */ - public deleteTestGridProject( + + /** + * @see {@link DeleteTestGridProjectCommand} + */ + deleteTestGridProject( args: DeleteTestGridProjectCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTestGridProject( + deleteTestGridProject( args: DeleteTestGridProjectCommandInput, cb: (err: any, data?: DeleteTestGridProjectCommandOutput) => void ): void; - public deleteTestGridProject( + deleteTestGridProject( args: DeleteTestGridProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTestGridProjectCommandOutput) => void ): void; - public deleteTestGridProject( - args: DeleteTestGridProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTestGridProjectCommandOutput) => void), - cb?: (err: any, data?: DeleteTestGridProjectCommandOutput) => void - ): Promise | void { - const command = new DeleteTestGridProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an upload given the upload ARN.

- */ - public deleteUpload( - args: DeleteUploadCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteUpload(args: DeleteUploadCommandInput, cb: (err: any, data?: DeleteUploadCommandOutput) => void): void; - public deleteUpload( + + /** + * @see {@link DeleteUploadCommand} + */ + deleteUpload(args: DeleteUploadCommandInput, options?: __HttpHandlerOptions): Promise; + deleteUpload(args: DeleteUploadCommandInput, cb: (err: any, data?: DeleteUploadCommandOutput) => void): void; + deleteUpload( args: DeleteUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUploadCommandOutput) => void ): void; - public deleteUpload( - args: DeleteUploadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUploadCommandOutput) => void), - cb?: (err: any, data?: DeleteUploadCommandOutput) => void - ): Promise | void { - const command = new DeleteUploadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.

- */ - public deleteVPCEConfiguration( + + /** + * @see {@link DeleteVPCEConfigurationCommand} + */ + deleteVPCEConfiguration( args: DeleteVPCEConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVPCEConfiguration( + deleteVPCEConfiguration( args: DeleteVPCEConfigurationCommandInput, cb: (err: any, data?: DeleteVPCEConfigurationCommandOutput) => void ): void; - public deleteVPCEConfiguration( + deleteVPCEConfiguration( args: DeleteVPCEConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVPCEConfigurationCommandOutput) => void ): void; - public deleteVPCEConfiguration( - args: DeleteVPCEConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVPCEConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteVPCEConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteVPCEConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the number of unmetered iOS or unmetered Android devices that have been purchased by the - * account.

- */ - public getAccountSettings( + + /** + * @see {@link GetAccountSettingsCommand} + */ + getAccountSettings( args: GetAccountSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccountSettings( + getAccountSettings( args: GetAccountSettingsCommandInput, cb: (err: any, data?: GetAccountSettingsCommandOutput) => void ): void; - public getAccountSettings( + getAccountSettings( args: GetAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountSettingsCommandOutput) => void ): void; - public getAccountSettings( - args: GetAccountSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccountSettingsCommandOutput) => void), - cb?: (err: any, data?: GetAccountSettingsCommandOutput) => void - ): Promise | void { - const command = new GetAccountSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a unique device type.

- */ - public getDevice(args: GetDeviceCommandInput, options?: __HttpHandlerOptions): Promise; - public getDevice(args: GetDeviceCommandInput, cb: (err: any, data?: GetDeviceCommandOutput) => void): void; - public getDevice( + + /** + * @see {@link GetDeviceCommand} + */ + getDevice(args: GetDeviceCommandInput, options?: __HttpHandlerOptions): Promise; + getDevice(args: GetDeviceCommandInput, cb: (err: any, data?: GetDeviceCommandOutput) => void): void; + getDevice( args: GetDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeviceCommandOutput) => void ): void; - public getDevice( - args: GetDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeviceCommandOutput) => void), - cb?: (err: any, data?: GetDeviceCommandOutput) => void - ): Promise | void { - const command = new GetDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a device instance that belongs to a private device fleet.

- */ - public getDeviceInstance( + + /** + * @see {@link GetDeviceInstanceCommand} + */ + getDeviceInstance( args: GetDeviceInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDeviceInstance( + getDeviceInstance( args: GetDeviceInstanceCommandInput, cb: (err: any, data?: GetDeviceInstanceCommandOutput) => void ): void; - public getDeviceInstance( + getDeviceInstance( args: GetDeviceInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeviceInstanceCommandOutput) => void ): void; - public getDeviceInstance( - args: GetDeviceInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeviceInstanceCommandOutput) => void), - cb?: (err: any, data?: GetDeviceInstanceCommandOutput) => void - ): Promise | void { - const command = new GetDeviceInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a device pool.

- */ - public getDevicePool( - args: GetDevicePoolCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getDevicePool( - args: GetDevicePoolCommandInput, - cb: (err: any, data?: GetDevicePoolCommandOutput) => void - ): void; - public getDevicePool( + + /** + * @see {@link GetDevicePoolCommand} + */ + getDevicePool(args: GetDevicePoolCommandInput, options?: __HttpHandlerOptions): Promise; + getDevicePool(args: GetDevicePoolCommandInput, cb: (err: any, data?: GetDevicePoolCommandOutput) => void): void; + getDevicePool( args: GetDevicePoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDevicePoolCommandOutput) => void ): void; - public getDevicePool( - args: GetDevicePoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDevicePoolCommandOutput) => void), - cb?: (err: any, data?: GetDevicePoolCommandOutput) => void - ): Promise | void { - const command = new GetDevicePoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about compatibility with a device pool.

- */ - public getDevicePoolCompatibility( + + /** + * @see {@link GetDevicePoolCompatibilityCommand} + */ + getDevicePoolCompatibility( args: GetDevicePoolCompatibilityCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDevicePoolCompatibility( + getDevicePoolCompatibility( args: GetDevicePoolCompatibilityCommandInput, cb: (err: any, data?: GetDevicePoolCompatibilityCommandOutput) => void ): void; - public getDevicePoolCompatibility( + getDevicePoolCompatibility( args: GetDevicePoolCompatibilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDevicePoolCompatibilityCommandOutput) => void ): void; - public getDevicePoolCompatibility( - args: GetDevicePoolCompatibilityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDevicePoolCompatibilityCommandOutput) => void), - cb?: (err: any, data?: GetDevicePoolCompatibilityCommandOutput) => void - ): Promise | void { - const command = new GetDevicePoolCompatibilityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the specified instance profile.

- */ - public getInstanceProfile( + + /** + * @see {@link GetInstanceProfileCommand} + */ + getInstanceProfile( args: GetInstanceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInstanceProfile( + getInstanceProfile( args: GetInstanceProfileCommandInput, cb: (err: any, data?: GetInstanceProfileCommandOutput) => void ): void; - public getInstanceProfile( + getInstanceProfile( args: GetInstanceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInstanceProfileCommandOutput) => void ): void; - public getInstanceProfile( - args: GetInstanceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInstanceProfileCommandOutput) => void), - cb?: (err: any, data?: GetInstanceProfileCommandOutput) => void - ): Promise | void { - const command = new GetInstanceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a job.

- */ - public getJob(args: GetJobCommandInput, options?: __HttpHandlerOptions): Promise; - public getJob(args: GetJobCommandInput, cb: (err: any, data?: GetJobCommandOutput) => void): void; - public getJob( + + /** + * @see {@link GetJobCommand} + */ + getJob(args: GetJobCommandInput, options?: __HttpHandlerOptions): Promise; + getJob(args: GetJobCommandInput, cb: (err: any, data?: GetJobCommandOutput) => void): void; + getJob( args: GetJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobCommandOutput) => void ): void; - public getJob( - args: GetJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetJobCommandOutput) => void), - cb?: (err: any, data?: GetJobCommandOutput) => void - ): Promise | void { - const command = new GetJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a network profile.

- */ - public getNetworkProfile( + + /** + * @see {@link GetNetworkProfileCommand} + */ + getNetworkProfile( args: GetNetworkProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public getNetworkProfile( + getNetworkProfile( args: GetNetworkProfileCommandInput, cb: (err: any, data?: GetNetworkProfileCommandOutput) => void ): void; - public getNetworkProfile( + getNetworkProfile( args: GetNetworkProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNetworkProfileCommandOutput) => void ): void; - public getNetworkProfile( - args: GetNetworkProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetNetworkProfileCommandOutput) => void), - cb?: (err: any, data?: GetNetworkProfileCommandOutput) => void - ): Promise | void { - const command = new GetNetworkProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the current status and future status of all offerings purchased by an AWS account. The response - * indicates how many offerings are currently available and the offerings that will be available in the next - * period. The API returns a NotEligible error if the user is not permitted to invoke the - * operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

- */ - public getOfferingStatus( + + /** + * @see {@link GetOfferingStatusCommand} + */ + getOfferingStatus( args: GetOfferingStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getOfferingStatus( + getOfferingStatus( args: GetOfferingStatusCommandInput, cb: (err: any, data?: GetOfferingStatusCommandOutput) => void ): void; - public getOfferingStatus( + getOfferingStatus( args: GetOfferingStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOfferingStatusCommandOutput) => void ): void; - public getOfferingStatus( - args: GetOfferingStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOfferingStatusCommandOutput) => void), - cb?: (err: any, data?: GetOfferingStatusCommandOutput) => void - ): Promise | void { - const command = new GetOfferingStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a project.

- */ - public getProject(args: GetProjectCommandInput, options?: __HttpHandlerOptions): Promise; - public getProject(args: GetProjectCommandInput, cb: (err: any, data?: GetProjectCommandOutput) => void): void; - public getProject( + + /** + * @see {@link GetProjectCommand} + */ + getProject(args: GetProjectCommandInput, options?: __HttpHandlerOptions): Promise; + getProject(args: GetProjectCommandInput, cb: (err: any, data?: GetProjectCommandOutput) => void): void; + getProject( args: GetProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProjectCommandOutput) => void ): void; - public getProject( - args: GetProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetProjectCommandOutput) => void), - cb?: (err: any, data?: GetProjectCommandOutput) => void - ): Promise | void { - const command = new GetProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a link to a currently running remote access session.

- */ - public getRemoteAccessSession( + + /** + * @see {@link GetRemoteAccessSessionCommand} + */ + getRemoteAccessSession( args: GetRemoteAccessSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRemoteAccessSession( + getRemoteAccessSession( args: GetRemoteAccessSessionCommandInput, cb: (err: any, data?: GetRemoteAccessSessionCommandOutput) => void ): void; - public getRemoteAccessSession( + getRemoteAccessSession( args: GetRemoteAccessSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRemoteAccessSessionCommandOutput) => void ): void; - public getRemoteAccessSession( - args: GetRemoteAccessSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRemoteAccessSessionCommandOutput) => void), - cb?: (err: any, data?: GetRemoteAccessSessionCommandOutput) => void - ): Promise | void { - const command = new GetRemoteAccessSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a run.

- */ - public getRun(args: GetRunCommandInput, options?: __HttpHandlerOptions): Promise; - public getRun(args: GetRunCommandInput, cb: (err: any, data?: GetRunCommandOutput) => void): void; - public getRun( + + /** + * @see {@link GetRunCommand} + */ + getRun(args: GetRunCommandInput, options?: __HttpHandlerOptions): Promise; + getRun(args: GetRunCommandInput, cb: (err: any, data?: GetRunCommandOutput) => void): void; + getRun( args: GetRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRunCommandOutput) => void ): void; - public getRun( - args: GetRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRunCommandOutput) => void), - cb?: (err: any, data?: GetRunCommandOutput) => void - ): Promise | void { - const command = new GetRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a suite.

- */ - public getSuite(args: GetSuiteCommandInput, options?: __HttpHandlerOptions): Promise; - public getSuite(args: GetSuiteCommandInput, cb: (err: any, data?: GetSuiteCommandOutput) => void): void; - public getSuite( + + /** + * @see {@link GetSuiteCommand} + */ + getSuite(args: GetSuiteCommandInput, options?: __HttpHandlerOptions): Promise; + getSuite(args: GetSuiteCommandInput, cb: (err: any, data?: GetSuiteCommandOutput) => void): void; + getSuite( args: GetSuiteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSuiteCommandOutput) => void ): void; - public getSuite( - args: GetSuiteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSuiteCommandOutput) => void), - cb?: (err: any, data?: GetSuiteCommandOutput) => void - ): Promise | void { - const command = new GetSuiteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a test.

- */ - public getTest(args: GetTestCommandInput, options?: __HttpHandlerOptions): Promise; - public getTest(args: GetTestCommandInput, cb: (err: any, data?: GetTestCommandOutput) => void): void; - public getTest( + + /** + * @see {@link GetTestCommand} + */ + getTest(args: GetTestCommandInput, options?: __HttpHandlerOptions): Promise; + getTest(args: GetTestCommandInput, cb: (err: any, data?: GetTestCommandOutput) => void): void; + getTest( args: GetTestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTestCommandOutput) => void ): void; - public getTest( - args: GetTestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTestCommandOutput) => void), - cb?: (err: any, data?: GetTestCommandOutput) => void - ): Promise | void { - const command = new GetTestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about a Selenium testing project.

- */ - public getTestGridProject( + + /** + * @see {@link GetTestGridProjectCommand} + */ + getTestGridProject( args: GetTestGridProjectCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTestGridProject( + getTestGridProject( args: GetTestGridProjectCommandInput, cb: (err: any, data?: GetTestGridProjectCommandOutput) => void ): void; - public getTestGridProject( + getTestGridProject( args: GetTestGridProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTestGridProjectCommandOutput) => void ): void; - public getTestGridProject( - args: GetTestGridProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTestGridProjectCommandOutput) => void), - cb?: (err: any, data?: GetTestGridProjectCommandOutput) => void - ): Promise | void { - const command = new GetTestGridProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

A session is an instance of a browser created through a RemoteWebDriver with the URL from CreateTestGridUrlResult$url. You can use the following to look up sessions:

- * - *

- */ - public getTestGridSession( + + /** + * @see {@link GetTestGridSessionCommand} + */ + getTestGridSession( args: GetTestGridSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTestGridSession( + getTestGridSession( args: GetTestGridSessionCommandInput, cb: (err: any, data?: GetTestGridSessionCommandOutput) => void ): void; - public getTestGridSession( + getTestGridSession( args: GetTestGridSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTestGridSessionCommandOutput) => void ): void; - public getTestGridSession( - args: GetTestGridSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTestGridSessionCommandOutput) => void), - cb?: (err: any, data?: GetTestGridSessionCommandOutput) => void - ): Promise | void { - const command = new GetTestGridSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about an upload.

- */ - public getUpload(args: GetUploadCommandInput, options?: __HttpHandlerOptions): Promise; - public getUpload(args: GetUploadCommandInput, cb: (err: any, data?: GetUploadCommandOutput) => void): void; - public getUpload( + + /** + * @see {@link GetUploadCommand} + */ + getUpload(args: GetUploadCommandInput, options?: __HttpHandlerOptions): Promise; + getUpload(args: GetUploadCommandInput, cb: (err: any, data?: GetUploadCommandOutput) => void): void; + getUpload( args: GetUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUploadCommandOutput) => void ): void; - public getUpload( - args: GetUploadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUploadCommandOutput) => void), - cb?: (err: any, data?: GetUploadCommandOutput) => void - ): Promise | void { - const command = new GetUploadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the configuration settings for your Amazon Virtual Private - * Cloud (VPC) endpoint.

- */ - public getVPCEConfiguration( + + /** + * @see {@link GetVPCEConfigurationCommand} + */ + getVPCEConfiguration( args: GetVPCEConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVPCEConfiguration( + getVPCEConfiguration( args: GetVPCEConfigurationCommandInput, cb: (err: any, data?: GetVPCEConfigurationCommandOutput) => void ): void; - public getVPCEConfiguration( + getVPCEConfiguration( args: GetVPCEConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVPCEConfigurationCommandOutput) => void ): void; - public getVPCEConfiguration( - args: GetVPCEConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVPCEConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetVPCEConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetVPCEConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Installs an application to the device in a remote access session. For Android - * applications, the file must be in .apk format. For iOS applications, the file must be in - * .ipa format.

- */ - public installToRemoteAccessSession( + + /** + * @see {@link InstallToRemoteAccessSessionCommand} + */ + installToRemoteAccessSession( args: InstallToRemoteAccessSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public installToRemoteAccessSession( + installToRemoteAccessSession( args: InstallToRemoteAccessSessionCommandInput, cb: (err: any, data?: InstallToRemoteAccessSessionCommandOutput) => void ): void; - public installToRemoteAccessSession( + installToRemoteAccessSession( args: InstallToRemoteAccessSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InstallToRemoteAccessSessionCommandOutput) => void ): void; - public installToRemoteAccessSession( - args: InstallToRemoteAccessSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InstallToRemoteAccessSessionCommandOutput) => void), - cb?: (err: any, data?: InstallToRemoteAccessSessionCommandOutput) => void - ): Promise | void { - const command = new InstallToRemoteAccessSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about artifacts.

- */ - public listArtifacts( - args: ListArtifactsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listArtifacts( - args: ListArtifactsCommandInput, - cb: (err: any, data?: ListArtifactsCommandOutput) => void - ): void; - public listArtifacts( + + /** + * @see {@link ListArtifactsCommand} + */ + listArtifacts(args: ListArtifactsCommandInput, options?: __HttpHandlerOptions): Promise; + listArtifacts(args: ListArtifactsCommandInput, cb: (err: any, data?: ListArtifactsCommandOutput) => void): void; + listArtifacts( args: ListArtifactsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListArtifactsCommandOutput) => void ): void; - public listArtifacts( - args: ListArtifactsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListArtifactsCommandOutput) => void), - cb?: (err: any, data?: ListArtifactsCommandOutput) => void - ): Promise | void { - const command = new ListArtifactsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the private device instances associated with one or more AWS - * accounts.

- */ - public listDeviceInstances( + + /** + * @see {@link ListDeviceInstancesCommand} + */ + listDeviceInstances( args: ListDeviceInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeviceInstances( + listDeviceInstances( args: ListDeviceInstancesCommandInput, cb: (err: any, data?: ListDeviceInstancesCommandOutput) => void ): void; - public listDeviceInstances( + listDeviceInstances( args: ListDeviceInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeviceInstancesCommandOutput) => void ): void; - public listDeviceInstances( - args: ListDeviceInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeviceInstancesCommandOutput) => void), - cb?: (err: any, data?: ListDeviceInstancesCommandOutput) => void - ): Promise | void { - const command = new ListDeviceInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about device pools.

- */ - public listDevicePools( + + /** + * @see {@link ListDevicePoolsCommand} + */ + listDevicePools( args: ListDevicePoolsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDevicePools( - args: ListDevicePoolsCommandInput, - cb: (err: any, data?: ListDevicePoolsCommandOutput) => void - ): void; - public listDevicePools( + listDevicePools(args: ListDevicePoolsCommandInput, cb: (err: any, data?: ListDevicePoolsCommandOutput) => void): void; + listDevicePools( args: ListDevicePoolsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDevicePoolsCommandOutput) => void ): void; - public listDevicePools( - args: ListDevicePoolsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDevicePoolsCommandOutput) => void), - cb?: (err: any, data?: ListDevicePoolsCommandOutput) => void - ): Promise | void { - const command = new ListDevicePoolsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about unique device types.

- */ - public listDevices(args: ListDevicesCommandInput, options?: __HttpHandlerOptions): Promise; - public listDevices(args: ListDevicesCommandInput, cb: (err: any, data?: ListDevicesCommandOutput) => void): void; - public listDevices( + + /** + * @see {@link ListDevicesCommand} + */ + listDevices(args: ListDevicesCommandInput, options?: __HttpHandlerOptions): Promise; + listDevices(args: ListDevicesCommandInput, cb: (err: any, data?: ListDevicesCommandOutput) => void): void; + listDevices( args: ListDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDevicesCommandOutput) => void ): void; - public listDevices( - args: ListDevicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDevicesCommandOutput) => void), - cb?: (err: any, data?: ListDevicesCommandOutput) => void - ): Promise | void { - const command = new ListDevicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about all the instance profiles in an AWS account.

- */ - public listInstanceProfiles( + + /** + * @see {@link ListInstanceProfilesCommand} + */ + listInstanceProfiles( args: ListInstanceProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInstanceProfiles( + listInstanceProfiles( args: ListInstanceProfilesCommandInput, cb: (err: any, data?: ListInstanceProfilesCommandOutput) => void ): void; - public listInstanceProfiles( + listInstanceProfiles( args: ListInstanceProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInstanceProfilesCommandOutput) => void ): void; - public listInstanceProfiles( - args: ListInstanceProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInstanceProfilesCommandOutput) => void), - cb?: (err: any, data?: ListInstanceProfilesCommandOutput) => void - ): Promise | void { - const command = new ListInstanceProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about jobs for a given test run.

- */ - public listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise; - public listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void; - public listJobs( + + /** + * @see {@link ListJobsCommand} + */ + listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise; + listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void; + listJobs( args: ListJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobsCommandOutput) => void ): void; - public listJobs( - args: ListJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJobsCommandOutput) => void), - cb?: (err: any, data?: ListJobsCommandOutput) => void - ): Promise | void { - const command = new ListJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the list of available network profiles.

- */ - public listNetworkProfiles( + + /** + * @see {@link ListNetworkProfilesCommand} + */ + listNetworkProfiles( args: ListNetworkProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listNetworkProfiles( + listNetworkProfiles( args: ListNetworkProfilesCommandInput, cb: (err: any, data?: ListNetworkProfilesCommandOutput) => void ): void; - public listNetworkProfiles( + listNetworkProfiles( args: ListNetworkProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNetworkProfilesCommandOutput) => void ): void; - public listNetworkProfiles( - args: ListNetworkProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNetworkProfilesCommandOutput) => void), - cb?: (err: any, data?: ListNetworkProfilesCommandOutput) => void - ): Promise | void { - const command = new ListNetworkProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of offering promotions. Each offering promotion record contains the ID and description - * of the promotion. The API returns a NotEligible error if the caller is not permitted to invoke - * the operation. Contact aws-devicefarm-support@amazon.com if you must be able to invoke this operation.

- */ - public listOfferingPromotions( + + /** + * @see {@link ListOfferingPromotionsCommand} + */ + listOfferingPromotions( args: ListOfferingPromotionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOfferingPromotions( + listOfferingPromotions( args: ListOfferingPromotionsCommandInput, cb: (err: any, data?: ListOfferingPromotionsCommandOutput) => void ): void; - public listOfferingPromotions( + listOfferingPromotions( args: ListOfferingPromotionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOfferingPromotionsCommandOutput) => void ): void; - public listOfferingPromotions( - args: ListOfferingPromotionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOfferingPromotionsCommandOutput) => void), - cb?: (err: any, data?: ListOfferingPromotionsCommandOutput) => void - ): Promise | void { - const command = new ListOfferingPromotionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of products or offerings that the user can manage through the API. Each offering record - * indicates the recurring price per unit and the frequency for that offering. The API returns a - * NotEligible error if the user is not permitted to invoke the operation. If you must be - * able to invoke this operation, contact aws-devicefarm-support@amazon.com.

- */ - public listOfferings( - args: ListOfferingsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listOfferings( - args: ListOfferingsCommandInput, - cb: (err: any, data?: ListOfferingsCommandOutput) => void - ): void; - public listOfferings( + + /** + * @see {@link ListOfferingsCommand} + */ + listOfferings(args: ListOfferingsCommandInput, options?: __HttpHandlerOptions): Promise; + listOfferings(args: ListOfferingsCommandInput, cb: (err: any, data?: ListOfferingsCommandOutput) => void): void; + listOfferings( args: ListOfferingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOfferingsCommandOutput) => void ): void; - public listOfferings( - args: ListOfferingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOfferingsCommandOutput) => void), - cb?: (err: any, data?: ListOfferingsCommandOutput) => void - ): Promise | void { - const command = new ListOfferingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS - * account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). - * The API returns a NotEligible error if the user is not permitted to invoke the operation. If - * you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

- */ - public listOfferingTransactions( + + /** + * @see {@link ListOfferingTransactionsCommand} + */ + listOfferingTransactions( args: ListOfferingTransactionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOfferingTransactions( + listOfferingTransactions( args: ListOfferingTransactionsCommandInput, cb: (err: any, data?: ListOfferingTransactionsCommandOutput) => void ): void; - public listOfferingTransactions( + listOfferingTransactions( args: ListOfferingTransactionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOfferingTransactionsCommandOutput) => void ): void; - public listOfferingTransactions( - args: ListOfferingTransactionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOfferingTransactionsCommandOutput) => void), - cb?: (err: any, data?: ListOfferingTransactionsCommandOutput) => void - ): Promise | void { - const command = new ListOfferingTransactionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about projects.

- */ - public listProjects( - args: ListProjectsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void; - public listProjects( + + /** + * @see {@link ListProjectsCommand} + */ + listProjects(args: ListProjectsCommandInput, options?: __HttpHandlerOptions): Promise; + listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void; + listProjects( args: ListProjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProjectsCommandOutput) => void ): void; - public listProjects( - args: ListProjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProjectsCommandOutput) => void), - cb?: (err: any, data?: ListProjectsCommandOutput) => void - ): Promise | void { - const command = new ListProjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of all currently running remote access sessions.

- */ - public listRemoteAccessSessions( + + /** + * @see {@link ListRemoteAccessSessionsCommand} + */ + listRemoteAccessSessions( args: ListRemoteAccessSessionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRemoteAccessSessions( + listRemoteAccessSessions( args: ListRemoteAccessSessionsCommandInput, cb: (err: any, data?: ListRemoteAccessSessionsCommandOutput) => void ): void; - public listRemoteAccessSessions( + listRemoteAccessSessions( args: ListRemoteAccessSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRemoteAccessSessionsCommandOutput) => void ): void; - public listRemoteAccessSessions( - args: ListRemoteAccessSessionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRemoteAccessSessionsCommandOutput) => void), - cb?: (err: any, data?: ListRemoteAccessSessionsCommandOutput) => void - ): Promise | void { - const command = new ListRemoteAccessSessionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about runs, given an AWS Device Farm project ARN.

- */ - public listRuns(args: ListRunsCommandInput, options?: __HttpHandlerOptions): Promise; - public listRuns(args: ListRunsCommandInput, cb: (err: any, data?: ListRunsCommandOutput) => void): void; - public listRuns( + + /** + * @see {@link ListRunsCommand} + */ + listRuns(args: ListRunsCommandInput, options?: __HttpHandlerOptions): Promise; + listRuns(args: ListRunsCommandInput, cb: (err: any, data?: ListRunsCommandOutput) => void): void; + listRuns( args: ListRunsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRunsCommandOutput) => void ): void; - public listRuns( - args: ListRunsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRunsCommandOutput) => void), - cb?: (err: any, data?: ListRunsCommandOutput) => void - ): Promise | void { - const command = new ListRunsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about samples, given an AWS Device Farm job ARN.

- */ - public listSamples(args: ListSamplesCommandInput, options?: __HttpHandlerOptions): Promise; - public listSamples(args: ListSamplesCommandInput, cb: (err: any, data?: ListSamplesCommandOutput) => void): void; - public listSamples( + + /** + * @see {@link ListSamplesCommand} + */ + listSamples(args: ListSamplesCommandInput, options?: __HttpHandlerOptions): Promise; + listSamples(args: ListSamplesCommandInput, cb: (err: any, data?: ListSamplesCommandOutput) => void): void; + listSamples( args: ListSamplesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSamplesCommandOutput) => void ): void; - public listSamples( - args: ListSamplesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSamplesCommandOutput) => void), - cb?: (err: any, data?: ListSamplesCommandOutput) => void - ): Promise | void { - const command = new ListSamplesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about test suites for a given job.

- */ - public listSuites(args: ListSuitesCommandInput, options?: __HttpHandlerOptions): Promise; - public listSuites(args: ListSuitesCommandInput, cb: (err: any, data?: ListSuitesCommandOutput) => void): void; - public listSuites( + + /** + * @see {@link ListSuitesCommand} + */ + listSuites(args: ListSuitesCommandInput, options?: __HttpHandlerOptions): Promise; + listSuites(args: ListSuitesCommandInput, cb: (err: any, data?: ListSuitesCommandOutput) => void): void; + listSuites( args: ListSuitesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSuitesCommandOutput) => void ): void; - public listSuites( - args: ListSuitesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSuitesCommandOutput) => void), - cb?: (err: any, data?: ListSuitesCommandOutput) => void - ): Promise | void { - const command = new ListSuitesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List the tags for an AWS Device Farm resource.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of all Selenium testing projects in your account.

- */ - public listTestGridProjects( + + /** + * @see {@link ListTestGridProjectsCommand} + */ + listTestGridProjects( args: ListTestGridProjectsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTestGridProjects( + listTestGridProjects( args: ListTestGridProjectsCommandInput, cb: (err: any, data?: ListTestGridProjectsCommandOutput) => void ): void; - public listTestGridProjects( + listTestGridProjects( args: ListTestGridProjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTestGridProjectsCommandOutput) => void ): void; - public listTestGridProjects( - args: ListTestGridProjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTestGridProjectsCommandOutput) => void), - cb?: (err: any, data?: ListTestGridProjectsCommandOutput) => void - ): Promise | void { - const command = new ListTestGridProjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of the actions taken in a TestGridSession.

- */ - public listTestGridSessionActions( + + /** + * @see {@link ListTestGridSessionActionsCommand} + */ + listTestGridSessionActions( args: ListTestGridSessionActionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTestGridSessionActions( + listTestGridSessionActions( args: ListTestGridSessionActionsCommandInput, cb: (err: any, data?: ListTestGridSessionActionsCommandOutput) => void ): void; - public listTestGridSessionActions( + listTestGridSessionActions( args: ListTestGridSessionActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTestGridSessionActionsCommandOutput) => void ): void; - public listTestGridSessionActions( - args: ListTestGridSessionActionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTestGridSessionActionsCommandOutput) => void), - cb?: (err: any, data?: ListTestGridSessionActionsCommandOutput) => void - ): Promise | void { - const command = new ListTestGridSessionActionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of artifacts created during the session.

- */ - public listTestGridSessionArtifacts( + + /** + * @see {@link ListTestGridSessionArtifactsCommand} + */ + listTestGridSessionArtifacts( args: ListTestGridSessionArtifactsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTestGridSessionArtifacts( + listTestGridSessionArtifacts( args: ListTestGridSessionArtifactsCommandInput, cb: (err: any, data?: ListTestGridSessionArtifactsCommandOutput) => void ): void; - public listTestGridSessionArtifacts( + listTestGridSessionArtifacts( args: ListTestGridSessionArtifactsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTestGridSessionArtifactsCommandOutput) => void ): void; - public listTestGridSessionArtifacts( - args: ListTestGridSessionArtifactsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTestGridSessionArtifactsCommandOutput) => void), - cb?: (err: any, data?: ListTestGridSessionArtifactsCommandOutput) => void - ): Promise | void { - const command = new ListTestGridSessionArtifactsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of sessions for a TestGridProject.

- */ - public listTestGridSessions( + + /** + * @see {@link ListTestGridSessionsCommand} + */ + listTestGridSessions( args: ListTestGridSessionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTestGridSessions( + listTestGridSessions( args: ListTestGridSessionsCommandInput, cb: (err: any, data?: ListTestGridSessionsCommandOutput) => void ): void; - public listTestGridSessions( + listTestGridSessions( args: ListTestGridSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTestGridSessionsCommandOutput) => void ): void; - public listTestGridSessions( - args: ListTestGridSessionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTestGridSessionsCommandOutput) => void), - cb?: (err: any, data?: ListTestGridSessionsCommandOutput) => void - ): Promise | void { - const command = new ListTestGridSessionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about tests in a given test suite.

- */ - public listTests(args: ListTestsCommandInput, options?: __HttpHandlerOptions): Promise; - public listTests(args: ListTestsCommandInput, cb: (err: any, data?: ListTestsCommandOutput) => void): void; - public listTests( + + /** + * @see {@link ListTestsCommand} + */ + listTests(args: ListTestsCommandInput, options?: __HttpHandlerOptions): Promise; + listTests(args: ListTestsCommandInput, cb: (err: any, data?: ListTestsCommandOutput) => void): void; + listTests( args: ListTestsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTestsCommandOutput) => void ): void; - public listTests( - args: ListTestsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTestsCommandOutput) => void), - cb?: (err: any, data?: ListTestsCommandOutput) => void - ): Promise | void { - const command = new ListTestsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about unique problems, such as exceptions or crashes.

- *

Unique problems are defined as a single instance of an error across a run, job, or suite. For example, - * if a call in your application consistently raises an exception (OutOfBoundsException in - * MyActivity.java:386), ListUniqueProblems returns a single entry instead of many - * individual entries for that exception.

- */ - public listUniqueProblems( + + /** + * @see {@link ListUniqueProblemsCommand} + */ + listUniqueProblems( args: ListUniqueProblemsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listUniqueProblems( + listUniqueProblems( args: ListUniqueProblemsCommandInput, cb: (err: any, data?: ListUniqueProblemsCommandOutput) => void ): void; - public listUniqueProblems( + listUniqueProblems( args: ListUniqueProblemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUniqueProblemsCommandOutput) => void ): void; - public listUniqueProblems( - args: ListUniqueProblemsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUniqueProblemsCommandOutput) => void), - cb?: (err: any, data?: ListUniqueProblemsCommandOutput) => void - ): Promise | void { - const command = new ListUniqueProblemsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about uploads, given an AWS Device Farm project ARN.

- */ - public listUploads(args: ListUploadsCommandInput, options?: __HttpHandlerOptions): Promise; - public listUploads(args: ListUploadsCommandInput, cb: (err: any, data?: ListUploadsCommandOutput) => void): void; - public listUploads( + + /** + * @see {@link ListUploadsCommand} + */ + listUploads(args: ListUploadsCommandInput, options?: __HttpHandlerOptions): Promise; + listUploads(args: ListUploadsCommandInput, cb: (err: any, data?: ListUploadsCommandOutput) => void): void; + listUploads( args: ListUploadsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUploadsCommandOutput) => void ): void; - public listUploads( - args: ListUploadsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUploadsCommandOutput) => void), - cb?: (err: any, data?: ListUploadsCommandOutput) => void - ): Promise | void { - const command = new ListUploadsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about all Amazon Virtual Private Cloud (VPC) endpoint - * configurations in the AWS account.

- */ - public listVPCEConfigurations( + + /** + * @see {@link ListVPCEConfigurationsCommand} + */ + listVPCEConfigurations( args: ListVPCEConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVPCEConfigurations( + listVPCEConfigurations( args: ListVPCEConfigurationsCommandInput, cb: (err: any, data?: ListVPCEConfigurationsCommandOutput) => void ): void; - public listVPCEConfigurations( + listVPCEConfigurations( args: ListVPCEConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVPCEConfigurationsCommandOutput) => void ): void; - public listVPCEConfigurations( - args: ListVPCEConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVPCEConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListVPCEConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListVPCEConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased - * quantity for an offering, unless the renewal was overridden. The API returns a NotEligible - * error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, - * contact aws-devicefarm-support@amazon.com.

- */ - public purchaseOffering( + + /** + * @see {@link PurchaseOfferingCommand} + */ + purchaseOffering( args: PurchaseOfferingCommandInput, options?: __HttpHandlerOptions ): Promise; - public purchaseOffering( + purchaseOffering( args: PurchaseOfferingCommandInput, cb: (err: any, data?: PurchaseOfferingCommandOutput) => void ): void; - public purchaseOffering( + purchaseOffering( args: PurchaseOfferingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PurchaseOfferingCommandOutput) => void ): void; - public purchaseOffering( - args: PurchaseOfferingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PurchaseOfferingCommandOutput) => void), - cb?: (err: any, data?: PurchaseOfferingCommandOutput) => void - ): Promise | void { - const command = new PurchaseOfferingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Explicitly sets the quantity of devices to renew for an offering, starting from the - * effectiveDate of the next period. The API returns a NotEligible error if the - * user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

- */ - public renewOffering( - args: RenewOfferingCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public renewOffering( - args: RenewOfferingCommandInput, - cb: (err: any, data?: RenewOfferingCommandOutput) => void - ): void; - public renewOffering( + + /** + * @see {@link RenewOfferingCommand} + */ + renewOffering(args: RenewOfferingCommandInput, options?: __HttpHandlerOptions): Promise; + renewOffering(args: RenewOfferingCommandInput, cb: (err: any, data?: RenewOfferingCommandOutput) => void): void; + renewOffering( args: RenewOfferingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RenewOfferingCommandOutput) => void ): void; - public renewOffering( - args: RenewOfferingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RenewOfferingCommandOutput) => void), - cb?: (err: any, data?: RenewOfferingCommandOutput) => void - ): Promise | void { - const command = new RenewOfferingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Schedules a run.

- */ - public scheduleRun(args: ScheduleRunCommandInput, options?: __HttpHandlerOptions): Promise; - public scheduleRun(args: ScheduleRunCommandInput, cb: (err: any, data?: ScheduleRunCommandOutput) => void): void; - public scheduleRun( + + /** + * @see {@link ScheduleRunCommand} + */ + scheduleRun(args: ScheduleRunCommandInput, options?: __HttpHandlerOptions): Promise; + scheduleRun(args: ScheduleRunCommandInput, cb: (err: any, data?: ScheduleRunCommandOutput) => void): void; + scheduleRun( args: ScheduleRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ScheduleRunCommandOutput) => void ): void; - public scheduleRun( - args: ScheduleRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ScheduleRunCommandOutput) => void), - cb?: (err: any, data?: ScheduleRunCommandOutput) => void - ): Promise | void { - const command = new ScheduleRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Initiates a stop request for the current job. AWS Device Farm immediately stops the job on the device - * where tests have not started. You are not billed for this device. On the device where tests have started, - * setup suite and teardown suite tests run to completion on the device. You are billed for setup, teardown, - * and any tests that were in progress or already completed.

- */ - public stopJob(args: StopJobCommandInput, options?: __HttpHandlerOptions): Promise; - public stopJob(args: StopJobCommandInput, cb: (err: any, data?: StopJobCommandOutput) => void): void; - public stopJob( + + /** + * @see {@link StopJobCommand} + */ + stopJob(args: StopJobCommandInput, options?: __HttpHandlerOptions): Promise; + stopJob(args: StopJobCommandInput, cb: (err: any, data?: StopJobCommandOutput) => void): void; + stopJob( args: StopJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopJobCommandOutput) => void ): void; - public stopJob( - args: StopJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopJobCommandOutput) => void), - cb?: (err: any, data?: StopJobCommandOutput) => void - ): Promise | void { - const command = new StopJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Ends a specified remote access session.

- */ - public stopRemoteAccessSession( + + /** + * @see {@link StopRemoteAccessSessionCommand} + */ + stopRemoteAccessSession( args: StopRemoteAccessSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopRemoteAccessSession( + stopRemoteAccessSession( args: StopRemoteAccessSessionCommandInput, cb: (err: any, data?: StopRemoteAccessSessionCommandOutput) => void ): void; - public stopRemoteAccessSession( + stopRemoteAccessSession( args: StopRemoteAccessSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopRemoteAccessSessionCommandOutput) => void ): void; - public stopRemoteAccessSession( - args: StopRemoteAccessSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopRemoteAccessSessionCommandOutput) => void), - cb?: (err: any, data?: StopRemoteAccessSessionCommandOutput) => void - ): Promise | void { - const command = new StopRemoteAccessSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Initiates a stop request for the current test run. AWS Device Farm immediately stops the run on devices - * where tests have not started. You are not billed for these devices. On devices where tests have started - * executing, setup suite and teardown suite tests run to completion on those devices. You are billed for - * setup, teardown, and any tests that were in progress or already completed.

- */ - public stopRun(args: StopRunCommandInput, options?: __HttpHandlerOptions): Promise; - public stopRun(args: StopRunCommandInput, cb: (err: any, data?: StopRunCommandOutput) => void): void; - public stopRun( + + /** + * @see {@link StopRunCommand} + */ + stopRun(args: StopRunCommandInput, options?: __HttpHandlerOptions): Promise; + stopRun(args: StopRunCommandInput, cb: (err: any, data?: StopRunCommandOutput) => void): void; + stopRun( args: StopRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopRunCommandOutput) => void ): void; - public stopRun( - args: StopRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopRunCommandOutput) => void), - cb?: (err: any, data?: StopRunCommandOutput) => void - ): Promise | void { - const command = new StopRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates the specified tags to a resource with the specified resourceArn. If existing tags - * on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, - * the tags associated with that resource are also deleted.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified tags from a resource.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates information about a private device instance.

- */ - public updateDeviceInstance( + + /** + * @see {@link UpdateDeviceInstanceCommand} + */ + updateDeviceInstance( args: UpdateDeviceInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDeviceInstance( + updateDeviceInstance( args: UpdateDeviceInstanceCommandInput, cb: (err: any, data?: UpdateDeviceInstanceCommandOutput) => void ): void; - public updateDeviceInstance( + updateDeviceInstance( args: UpdateDeviceInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDeviceInstanceCommandOutput) => void ): void; - public updateDeviceInstance( - args: UpdateDeviceInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDeviceInstanceCommandOutput) => void), - cb?: (err: any, data?: UpdateDeviceInstanceCommandOutput) => void - ): Promise | void { - const command = new UpdateDeviceInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the name, description, and rules in a device pool given the attributes and - * the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a - * whole (or not at all).

- */ - public updateDevicePool( + + /** + * @see {@link UpdateDevicePoolCommand} + */ + updateDevicePool( args: UpdateDevicePoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDevicePool( + updateDevicePool( args: UpdateDevicePoolCommandInput, cb: (err: any, data?: UpdateDevicePoolCommandOutput) => void ): void; - public updateDevicePool( + updateDevicePool( args: UpdateDevicePoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDevicePoolCommandOutput) => void ): void; - public updateDevicePool( - args: UpdateDevicePoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDevicePoolCommandOutput) => void), - cb?: (err: any, data?: UpdateDevicePoolCommandOutput) => void - ): Promise | void { - const command = new UpdateDevicePoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates information about an existing private device instance profile.

- */ - public updateInstanceProfile( + + /** + * @see {@link UpdateInstanceProfileCommand} + */ + updateInstanceProfile( args: UpdateInstanceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateInstanceProfile( + updateInstanceProfile( args: UpdateInstanceProfileCommandInput, cb: (err: any, data?: UpdateInstanceProfileCommandOutput) => void ): void; - public updateInstanceProfile( + updateInstanceProfile( args: UpdateInstanceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateInstanceProfileCommandOutput) => void ): void; - public updateInstanceProfile( - args: UpdateInstanceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateInstanceProfileCommandOutput) => void), - cb?: (err: any, data?: UpdateInstanceProfileCommandOutput) => void - ): Promise | void { - const command = new UpdateInstanceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the network profile.

- */ - public updateNetworkProfile( + + /** + * @see {@link UpdateNetworkProfileCommand} + */ + updateNetworkProfile( args: UpdateNetworkProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateNetworkProfile( + updateNetworkProfile( args: UpdateNetworkProfileCommandInput, cb: (err: any, data?: UpdateNetworkProfileCommandOutput) => void ): void; - public updateNetworkProfile( + updateNetworkProfile( args: UpdateNetworkProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNetworkProfileCommandOutput) => void ): void; - public updateNetworkProfile( - args: UpdateNetworkProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateNetworkProfileCommandOutput) => void), - cb?: (err: any, data?: UpdateNetworkProfileCommandOutput) => void - ): Promise | void { - const command = new UpdateNetworkProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the specified project name, given the project ARN and a new - * name.

- */ - public updateProject( - args: UpdateProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateProject( - args: UpdateProjectCommandInput, - cb: (err: any, data?: UpdateProjectCommandOutput) => void - ): void; - public updateProject( + + /** + * @see {@link UpdateProjectCommand} + */ + updateProject(args: UpdateProjectCommandInput, options?: __HttpHandlerOptions): Promise; + updateProject(args: UpdateProjectCommandInput, cb: (err: any, data?: UpdateProjectCommandOutput) => void): void; + updateProject( args: UpdateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProjectCommandOutput) => void ): void; - public updateProject( - args: UpdateProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProjectCommandOutput) => void), - cb?: (err: any, data?: UpdateProjectCommandOutput) => void - ): Promise | void { - const command = new UpdateProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Change details of a project.

- */ - public updateTestGridProject( + + /** + * @see {@link UpdateTestGridProjectCommand} + */ + updateTestGridProject( args: UpdateTestGridProjectCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTestGridProject( + updateTestGridProject( args: UpdateTestGridProjectCommandInput, cb: (err: any, data?: UpdateTestGridProjectCommandOutput) => void ): void; - public updateTestGridProject( + updateTestGridProject( args: UpdateTestGridProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTestGridProjectCommandOutput) => void ): void; - public updateTestGridProject( - args: UpdateTestGridProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTestGridProjectCommandOutput) => void), - cb?: (err: any, data?: UpdateTestGridProjectCommandOutput) => void - ): Promise | void { - const command = new UpdateTestGridProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an uploaded test spec.

- */ - public updateUpload( - args: UpdateUploadCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateUpload(args: UpdateUploadCommandInput, cb: (err: any, data?: UpdateUploadCommandOutput) => void): void; - public updateUpload( + + /** + * @see {@link UpdateUploadCommand} + */ + updateUpload(args: UpdateUploadCommandInput, options?: __HttpHandlerOptions): Promise; + updateUpload(args: UpdateUploadCommandInput, cb: (err: any, data?: UpdateUploadCommandOutput) => void): void; + updateUpload( args: UpdateUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUploadCommandOutput) => void ): void; - public updateUpload( - args: UpdateUploadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUploadCommandOutput) => void), - cb?: (err: any, data?: UpdateUploadCommandOutput) => void - ): Promise | void { - const command = new UpdateUploadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.

- */ - public updateVPCEConfiguration( + + /** + * @see {@link UpdateVPCEConfigurationCommand} + */ + updateVPCEConfiguration( args: UpdateVPCEConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVPCEConfiguration( + updateVPCEConfiguration( args: UpdateVPCEConfigurationCommandInput, cb: (err: any, data?: UpdateVPCEConfigurationCommandOutput) => void ): void; - public updateVPCEConfiguration( + updateVPCEConfiguration( args: UpdateVPCEConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVPCEConfigurationCommandOutput) => void ): void; - public updateVPCEConfiguration( - args: UpdateVPCEConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVPCEConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateVPCEConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateVPCEConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Welcome to the AWS Device Farm API documentation, which contains APIs for:

+ *
    + *
  • + *

    Testing on desktop browsers

    + *

    Device Farm makes it possible for you to test your web applications on desktop browsers using + * Selenium. The APIs for desktop browser testing contain TestGrid in their names. For + * more information, see Testing Web + * Applications on Selenium with Device Farm.

    + *
  • + *
  • + *

    Testing on real mobile devices

    + *

    Device Farm makes it possible for you to test apps on physical phones, tablets, and other + * devices in the cloud. For more information, see the Device Farm Developer Guide.

    + *
  • + *
+ */ +export class DeviceFarm extends DeviceFarmClient implements DeviceFarm {} +createAggregatedClient(commands, DeviceFarm); diff --git a/clients/client-devops-guru/src/DevOpsGuru.ts b/clients/client-devops-guru/src/DevOpsGuru.ts index 4c3ed436dafc..27d7cd1170ea 100644 --- a/clients/client-devops-guru/src/DevOpsGuru.ts +++ b/clients/client-devops-guru/src/DevOpsGuru.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -148,1101 +149,552 @@ import { UpdateServiceIntegrationCommandInput, UpdateServiceIntegrationCommandOutput, } from "./commands/UpdateServiceIntegrationCommand"; -import { DevOpsGuruClient } from "./DevOpsGuruClient"; +import { DevOpsGuruClient, DevOpsGuruClientConfig } from "./DevOpsGuruClient"; -/** - * @public - *

Amazon DevOps Guru is a fully managed service that helps you identify anomalous behavior in - * business critical operational applications. You specify the Amazon Web Services resources that you - * want DevOps Guru to cover, then the Amazon CloudWatch metrics and Amazon Web Services CloudTrail events related to those - * resources are analyzed. When anomalous behavior is detected, DevOps Guru creates an - * insight that includes recommendations, related events, and - * related metrics that can help you improve your operational applications. For more - * information, see What is Amazon DevOps Guru.

- *

You can specify 1 or 2 Amazon Simple Notification Service topics so you are notified every time a new insight - * is created. You can also enable DevOps Guru to generate an OpsItem in Amazon Web Services Systems Manager for each - * insight to help you manage and track your work addressing insights.

- *

To learn about the DevOps Guru workflow, see How DevOps Guru works. To - * learn about DevOps Guru concepts, see Concepts in DevOps Guru.

- */ -export class DevOpsGuru extends DevOpsGuruClient { +const commands = { + AddNotificationChannelCommand, + DeleteInsightCommand, + DescribeAccountHealthCommand, + DescribeAccountOverviewCommand, + DescribeAnomalyCommand, + DescribeEventSourcesConfigCommand, + DescribeFeedbackCommand, + DescribeInsightCommand, + DescribeOrganizationHealthCommand, + DescribeOrganizationOverviewCommand, + DescribeOrganizationResourceCollectionHealthCommand, + DescribeResourceCollectionHealthCommand, + DescribeServiceIntegrationCommand, + GetCostEstimationCommand, + GetResourceCollectionCommand, + ListAnomaliesForInsightCommand, + ListAnomalousLogGroupsCommand, + ListEventsCommand, + ListInsightsCommand, + ListMonitoredResourcesCommand, + ListNotificationChannelsCommand, + ListOrganizationInsightsCommand, + ListRecommendationsCommand, + PutFeedbackCommand, + RemoveNotificationChannelCommand, + SearchInsightsCommand, + SearchOrganizationInsightsCommand, + StartCostEstimationCommand, + UpdateEventSourcesConfigCommand, + UpdateResourceCollectionCommand, + UpdateServiceIntegrationCommand, +}; + +export interface DevOpsGuru { /** - * @public - *

Adds a notification channel to DevOps Guru. A notification channel is used to notify you - * about important DevOps Guru events, such as when an insight is generated.

- *

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission - * to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. - * For more information, see Permissions - * for cross account Amazon SNS topics.

- *

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.

- *

If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions - * to the CMK. For more information, see Permissions for - * Amazon Web Services KMS–encrypted Amazon SNS topics.

+ * @see {@link AddNotificationChannelCommand} */ - public addNotificationChannel( + addNotificationChannel( args: AddNotificationChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public addNotificationChannel( + addNotificationChannel( args: AddNotificationChannelCommandInput, cb: (err: any, data?: AddNotificationChannelCommandOutput) => void ): void; - public addNotificationChannel( + addNotificationChannel( args: AddNotificationChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddNotificationChannelCommandOutput) => void ): void; - public addNotificationChannel( - args: AddNotificationChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddNotificationChannelCommandOutput) => void), - cb?: (err: any, data?: AddNotificationChannelCommandOutput) => void - ): Promise | void { - const command = new AddNotificationChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the insight along with the associated anomalies, events and recommendations.

+ * @see {@link DeleteInsightCommand} */ - public deleteInsight( - args: DeleteInsightCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteInsight( - args: DeleteInsightCommandInput, - cb: (err: any, data?: DeleteInsightCommandOutput) => void - ): void; - public deleteInsight( + deleteInsight(args: DeleteInsightCommandInput, options?: __HttpHandlerOptions): Promise; + deleteInsight(args: DeleteInsightCommandInput, cb: (err: any, data?: DeleteInsightCommandOutput) => void): void; + deleteInsight( args: DeleteInsightCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInsightCommandOutput) => void ): void; - public deleteInsight( - args: DeleteInsightCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInsightCommandOutput) => void), - cb?: (err: any, data?: DeleteInsightCommandOutput) => void - ): Promise | void { - const command = new DeleteInsightCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the number of open reactive insights, the number of open proactive insights, - * and the number of metrics analyzed in your Amazon Web Services account. Use these numbers to gauge the - * health of operations in your Amazon Web Services account.

+ * @see {@link DescribeAccountHealthCommand} */ - public describeAccountHealth( + describeAccountHealth( args: DescribeAccountHealthCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccountHealth( + describeAccountHealth( args: DescribeAccountHealthCommandInput, cb: (err: any, data?: DescribeAccountHealthCommandOutput) => void ): void; - public describeAccountHealth( + describeAccountHealth( args: DescribeAccountHealthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountHealthCommandOutput) => void ): void; - public describeAccountHealth( - args: DescribeAccountHealthCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccountHealthCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountHealthCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountHealthCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

For the time range passed in, returns the number of open reactive insight that were - * created, the number of open proactive insights that were created, and the Mean Time to Recover (MTTR) for all - * closed reactive insights.

+ * @see {@link DescribeAccountOverviewCommand} */ - public describeAccountOverview( + describeAccountOverview( args: DescribeAccountOverviewCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccountOverview( + describeAccountOverview( args: DescribeAccountOverviewCommandInput, cb: (err: any, data?: DescribeAccountOverviewCommandOutput) => void ): void; - public describeAccountOverview( + describeAccountOverview( args: DescribeAccountOverviewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountOverviewCommandOutput) => void ): void; - public describeAccountOverview( - args: DescribeAccountOverviewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccountOverviewCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountOverviewCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountOverviewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns details about an anomaly that you specify using its ID.

+ * @see {@link DescribeAnomalyCommand} */ - public describeAnomaly( + describeAnomaly( args: DescribeAnomalyCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAnomaly( - args: DescribeAnomalyCommandInput, - cb: (err: any, data?: DescribeAnomalyCommandOutput) => void - ): void; - public describeAnomaly( + describeAnomaly(args: DescribeAnomalyCommandInput, cb: (err: any, data?: DescribeAnomalyCommandOutput) => void): void; + describeAnomaly( args: DescribeAnomalyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAnomalyCommandOutput) => void ): void; - public describeAnomaly( - args: DescribeAnomalyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAnomalyCommandOutput) => void), - cb?: (err: any, data?: DescribeAnomalyCommandOutput) => void - ): Promise | void { - const command = new DescribeAnomalyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the integration status of services that are integrated with DevOps Guru as Consumer - * via EventBridge. The one service that can be integrated with DevOps Guru is Amazon CodeGuru - * Profiler, which can produce proactive recommendations which can be stored and viewed in - * DevOps Guru.

+ * @see {@link DescribeEventSourcesConfigCommand} */ - public describeEventSourcesConfig( + describeEventSourcesConfig( args: DescribeEventSourcesConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventSourcesConfig( + describeEventSourcesConfig( args: DescribeEventSourcesConfigCommandInput, cb: (err: any, data?: DescribeEventSourcesConfigCommandOutput) => void ): void; - public describeEventSourcesConfig( + describeEventSourcesConfig( args: DescribeEventSourcesConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventSourcesConfigCommandOutput) => void ): void; - public describeEventSourcesConfig( - args: DescribeEventSourcesConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventSourcesConfigCommandOutput) => void), - cb?: (err: any, data?: DescribeEventSourcesConfigCommandOutput) => void - ): Promise | void { - const command = new DescribeEventSourcesConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the most recent feedback submitted in the current Amazon Web Services account and Region. - *

+ * @see {@link DescribeFeedbackCommand} */ - public describeFeedback( + describeFeedback( args: DescribeFeedbackCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFeedback( + describeFeedback( args: DescribeFeedbackCommandInput, cb: (err: any, data?: DescribeFeedbackCommandOutput) => void ): void; - public describeFeedback( + describeFeedback( args: DescribeFeedbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFeedbackCommandOutput) => void ): void; - public describeFeedback( - args: DescribeFeedbackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFeedbackCommandOutput) => void), - cb?: (err: any, data?: DescribeFeedbackCommandOutput) => void - ): Promise | void { - const command = new DescribeFeedbackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns details about an insight that you specify using its ID.

+ * @see {@link DescribeInsightCommand} */ - public describeInsight( + describeInsight( args: DescribeInsightCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInsight( - args: DescribeInsightCommandInput, - cb: (err: any, data?: DescribeInsightCommandOutput) => void - ): void; - public describeInsight( + describeInsight(args: DescribeInsightCommandInput, cb: (err: any, data?: DescribeInsightCommandOutput) => void): void; + describeInsight( args: DescribeInsightCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInsightCommandOutput) => void ): void; - public describeInsight( - args: DescribeInsightCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInsightCommandOutput) => void), - cb?: (err: any, data?: DescribeInsightCommandOutput) => void - ): Promise | void { - const command = new DescribeInsightCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns active insights, predictive insights, and resource hours analyzed in last - * hour.

+ * @see {@link DescribeOrganizationHealthCommand} */ - public describeOrganizationHealth( + describeOrganizationHealth( args: DescribeOrganizationHealthCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOrganizationHealth( + describeOrganizationHealth( args: DescribeOrganizationHealthCommandInput, cb: (err: any, data?: DescribeOrganizationHealthCommandOutput) => void ): void; - public describeOrganizationHealth( + describeOrganizationHealth( args: DescribeOrganizationHealthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrganizationHealthCommandOutput) => void ): void; - public describeOrganizationHealth( - args: DescribeOrganizationHealthCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOrganizationHealthCommandOutput) => void), - cb?: (err: any, data?: DescribeOrganizationHealthCommandOutput) => void - ): Promise | void { - const command = new DescribeOrganizationHealthCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an overview of your organization's history based on the specified time range. - * The overview includes the total reactive and proactive insights.

+ * @see {@link DescribeOrganizationOverviewCommand} */ - public describeOrganizationOverview( + describeOrganizationOverview( args: DescribeOrganizationOverviewCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOrganizationOverview( + describeOrganizationOverview( args: DescribeOrganizationOverviewCommandInput, cb: (err: any, data?: DescribeOrganizationOverviewCommandOutput) => void ): void; - public describeOrganizationOverview( + describeOrganizationOverview( args: DescribeOrganizationOverviewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrganizationOverviewCommandOutput) => void ): void; - public describeOrganizationOverview( - args: DescribeOrganizationOverviewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOrganizationOverviewCommandOutput) => void), - cb?: (err: any, data?: DescribeOrganizationOverviewCommandOutput) => void - ): Promise | void { - const command = new DescribeOrganizationOverviewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides an overview of your system's health. If additional member accounts are part - * of your organization, you can filter those accounts using the AccountIds - * field.

+ * @see {@link DescribeOrganizationResourceCollectionHealthCommand} */ - public describeOrganizationResourceCollectionHealth( + describeOrganizationResourceCollectionHealth( args: DescribeOrganizationResourceCollectionHealthCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOrganizationResourceCollectionHealth( + describeOrganizationResourceCollectionHealth( args: DescribeOrganizationResourceCollectionHealthCommandInput, cb: (err: any, data?: DescribeOrganizationResourceCollectionHealthCommandOutput) => void ): void; - public describeOrganizationResourceCollectionHealth( + describeOrganizationResourceCollectionHealth( args: DescribeOrganizationResourceCollectionHealthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrganizationResourceCollectionHealthCommandOutput) => void ): void; - public describeOrganizationResourceCollectionHealth( - args: DescribeOrganizationResourceCollectionHealthCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeOrganizationResourceCollectionHealthCommandOutput) => void), - cb?: (err: any, data?: DescribeOrganizationResourceCollectionHealthCommandOutput) => void - ): Promise | void { - const command = new DescribeOrganizationResourceCollectionHealthCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the number of open proactive insights, open reactive insights, and the Mean Time to Recover (MTTR) - * for all closed insights in resource collections in your account. You specify the type of - * Amazon Web Services resources collection. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and - * Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze - * the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

+ * @see {@link DescribeResourceCollectionHealthCommand} */ - public describeResourceCollectionHealth( + describeResourceCollectionHealth( args: DescribeResourceCollectionHealthCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeResourceCollectionHealth( + describeResourceCollectionHealth( args: DescribeResourceCollectionHealthCommandInput, cb: (err: any, data?: DescribeResourceCollectionHealthCommandOutput) => void ): void; - public describeResourceCollectionHealth( + describeResourceCollectionHealth( args: DescribeResourceCollectionHealthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeResourceCollectionHealthCommandOutput) => void ): void; - public describeResourceCollectionHealth( - args: DescribeResourceCollectionHealthCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeResourceCollectionHealthCommandOutput) => void), - cb?: (err: any, data?: DescribeResourceCollectionHealthCommandOutput) => void - ): Promise | void { - const command = new DescribeResourceCollectionHealthCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the integration status of services that are integrated with DevOps Guru. - * The one service that can be integrated with DevOps Guru - * is Amazon Web Services Systems Manager, which can be used to create an OpsItem for each generated insight.

+ * @see {@link DescribeServiceIntegrationCommand} */ - public describeServiceIntegration( + describeServiceIntegration( args: DescribeServiceIntegrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeServiceIntegration( + describeServiceIntegration( args: DescribeServiceIntegrationCommandInput, cb: (err: any, data?: DescribeServiceIntegrationCommandOutput) => void ): void; - public describeServiceIntegration( + describeServiceIntegration( args: DescribeServiceIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeServiceIntegrationCommandOutput) => void ): void; - public describeServiceIntegration( - args: DescribeServiceIntegrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeServiceIntegrationCommandOutput) => void), - cb?: (err: any, data?: DescribeServiceIntegrationCommandOutput) => void - ): Promise | void { - const command = new DescribeServiceIntegrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an estimate of the monthly cost for DevOps Guru to analyze your Amazon Web Services resources. - * For more information, - * see Estimate your - * Amazon DevOps Guru costs and - * Amazon DevOps Guru pricing.

+ * @see {@link GetCostEstimationCommand} */ - public getCostEstimation( + getCostEstimation( args: GetCostEstimationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCostEstimation( + getCostEstimation( args: GetCostEstimationCommandInput, cb: (err: any, data?: GetCostEstimationCommandOutput) => void ): void; - public getCostEstimation( + getCostEstimation( args: GetCostEstimationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCostEstimationCommandOutput) => void ): void; - public getCostEstimation( - args: GetCostEstimationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCostEstimationCommandOutput) => void), - cb?: (err: any, data?: GetCostEstimationCommandOutput) => void - ): Promise | void { - const command = new GetCostEstimationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns lists Amazon Web Services resources that are of the specified resource collection type. - * The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and - * Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze - * the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

+ * @see {@link GetResourceCollectionCommand} */ - public getResourceCollection( + getResourceCollection( args: GetResourceCollectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourceCollection( + getResourceCollection( args: GetResourceCollectionCommandInput, cb: (err: any, data?: GetResourceCollectionCommandOutput) => void ): void; - public getResourceCollection( + getResourceCollection( args: GetResourceCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceCollectionCommandOutput) => void ): void; - public getResourceCollection( - args: GetResourceCollectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourceCollectionCommandOutput) => void), - cb?: (err: any, data?: GetResourceCollectionCommandOutput) => void - ): Promise | void { - const command = new GetResourceCollectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the anomalies that belong to an insight that you specify using its - * ID.

+ * @see {@link ListAnomaliesForInsightCommand} */ - public listAnomaliesForInsight( + listAnomaliesForInsight( args: ListAnomaliesForInsightCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAnomaliesForInsight( + listAnomaliesForInsight( args: ListAnomaliesForInsightCommandInput, cb: (err: any, data?: ListAnomaliesForInsightCommandOutput) => void ): void; - public listAnomaliesForInsight( + listAnomaliesForInsight( args: ListAnomaliesForInsightCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAnomaliesForInsightCommandOutput) => void ): void; - public listAnomaliesForInsight( - args: ListAnomaliesForInsightCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAnomaliesForInsightCommandOutput) => void), - cb?: (err: any, data?: ListAnomaliesForInsightCommandOutput) => void - ): Promise | void { - const command = new ListAnomaliesForInsightCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns the list of log groups that contain log anomalies. - *

+ * @see {@link ListAnomalousLogGroupsCommand} */ - public listAnomalousLogGroups( + listAnomalousLogGroups( args: ListAnomalousLogGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAnomalousLogGroups( + listAnomalousLogGroups( args: ListAnomalousLogGroupsCommandInput, cb: (err: any, data?: ListAnomalousLogGroupsCommandOutput) => void ): void; - public listAnomalousLogGroups( + listAnomalousLogGroups( args: ListAnomalousLogGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAnomalousLogGroupsCommandOutput) => void ): void; - public listAnomalousLogGroups( - args: ListAnomalousLogGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAnomalousLogGroupsCommandOutput) => void), - cb?: (err: any, data?: ListAnomalousLogGroupsCommandOutput) => void - ): Promise | void { - const command = new ListAnomalousLogGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the events emitted by the resources that are evaluated by DevOps Guru. - * You can use filters to specify which events are returned.

+ * @see {@link ListEventsCommand} */ - public listEvents(args: ListEventsCommandInput, options?: __HttpHandlerOptions): Promise; - public listEvents(args: ListEventsCommandInput, cb: (err: any, data?: ListEventsCommandOutput) => void): void; - public listEvents( + listEvents(args: ListEventsCommandInput, options?: __HttpHandlerOptions): Promise; + listEvents(args: ListEventsCommandInput, cb: (err: any, data?: ListEventsCommandOutput) => void): void; + listEvents( args: ListEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventsCommandOutput) => void ): void; - public listEvents( - args: ListEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEventsCommandOutput) => void), - cb?: (err: any, data?: ListEventsCommandOutput) => void - ): Promise | void { - const command = new ListEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of insights in your Amazon Web Services account. You can specify which insights are - * returned by their start time and status (ONGOING, CLOSED, or - * ANY).

+ * @see {@link ListInsightsCommand} */ - public listInsights( - args: ListInsightsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listInsights(args: ListInsightsCommandInput, cb: (err: any, data?: ListInsightsCommandOutput) => void): void; - public listInsights( + listInsights(args: ListInsightsCommandInput, options?: __HttpHandlerOptions): Promise; + listInsights(args: ListInsightsCommandInput, cb: (err: any, data?: ListInsightsCommandOutput) => void): void; + listInsights( args: ListInsightsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInsightsCommandOutput) => void ): void; - public listInsights( - args: ListInsightsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInsightsCommandOutput) => void), - cb?: (err: any, data?: ListInsightsCommandOutput) => void - ): Promise | void { - const command = new ListInsightsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns the list of all log groups that are being monitored and tagged by DevOps Guru. - *

+ * @see {@link ListMonitoredResourcesCommand} */ - public listMonitoredResources( + listMonitoredResources( args: ListMonitoredResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMonitoredResources( + listMonitoredResources( args: ListMonitoredResourcesCommandInput, cb: (err: any, data?: ListMonitoredResourcesCommandOutput) => void ): void; - public listMonitoredResources( + listMonitoredResources( args: ListMonitoredResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMonitoredResourcesCommandOutput) => void ): void; - public listMonitoredResources( - args: ListMonitoredResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMonitoredResourcesCommandOutput) => void), - cb?: (err: any, data?: ListMonitoredResourcesCommandOutput) => void - ): Promise | void { - const command = new ListMonitoredResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of notification channels configured for DevOps Guru. Each notification - * channel is used to notify you when DevOps Guru generates an insight that contains information - * about how to improve your operations. The one - * supported notification channel is Amazon Simple Notification Service (Amazon SNS).

+ * @see {@link ListNotificationChannelsCommand} */ - public listNotificationChannels( + listNotificationChannels( args: ListNotificationChannelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listNotificationChannels( + listNotificationChannels( args: ListNotificationChannelsCommandInput, cb: (err: any, data?: ListNotificationChannelsCommandOutput) => void ): void; - public listNotificationChannels( + listNotificationChannels( args: ListNotificationChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNotificationChannelsCommandOutput) => void ): void; - public listNotificationChannels( - args: ListNotificationChannelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNotificationChannelsCommandOutput) => void), - cb?: (err: any, data?: ListNotificationChannelsCommandOutput) => void - ): Promise | void { - const command = new ListNotificationChannelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of insights associated with the account or OU Id.

+ * @see {@link ListOrganizationInsightsCommand} */ - public listOrganizationInsights( + listOrganizationInsights( args: ListOrganizationInsightsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOrganizationInsights( + listOrganizationInsights( args: ListOrganizationInsightsCommandInput, cb: (err: any, data?: ListOrganizationInsightsCommandOutput) => void ): void; - public listOrganizationInsights( + listOrganizationInsights( args: ListOrganizationInsightsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOrganizationInsightsCommandOutput) => void ): void; - public listOrganizationInsights( - args: ListOrganizationInsightsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOrganizationInsightsCommandOutput) => void), - cb?: (err: any, data?: ListOrganizationInsightsCommandOutput) => void - ): Promise | void { - const command = new ListOrganizationInsightsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of a specified insight's recommendations. Each recommendation includes - * a list of related metrics and a list of related events.

+ * @see {@link ListRecommendationsCommand} */ - public listRecommendations( + listRecommendations( args: ListRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRecommendations( + listRecommendations( args: ListRecommendationsCommandInput, cb: (err: any, data?: ListRecommendationsCommandOutput) => void ): void; - public listRecommendations( + listRecommendations( args: ListRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecommendationsCommandOutput) => void ): void; - public listRecommendations( - args: ListRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRecommendationsCommandOutput) => void), - cb?: (err: any, data?: ListRecommendationsCommandOutput) => void - ): Promise | void { - const command = new ListRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Collects customer feedback about the specified insight.

+ * @see {@link PutFeedbackCommand} */ - public putFeedback(args: PutFeedbackCommandInput, options?: __HttpHandlerOptions): Promise; - public putFeedback(args: PutFeedbackCommandInput, cb: (err: any, data?: PutFeedbackCommandOutput) => void): void; - public putFeedback( + putFeedback(args: PutFeedbackCommandInput, options?: __HttpHandlerOptions): Promise; + putFeedback(args: PutFeedbackCommandInput, cb: (err: any, data?: PutFeedbackCommandOutput) => void): void; + putFeedback( args: PutFeedbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutFeedbackCommandOutput) => void ): void; - public putFeedback( - args: PutFeedbackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutFeedbackCommandOutput) => void), - cb?: (err: any, data?: PutFeedbackCommandOutput) => void - ): Promise | void { - const command = new PutFeedbackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a notification channel from DevOps Guru. A notification channel is used to notify - * you when DevOps Guru generates an insight that contains information about how to improve your - * operations.

+ * @see {@link RemoveNotificationChannelCommand} */ - public removeNotificationChannel( + removeNotificationChannel( args: RemoveNotificationChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeNotificationChannel( + removeNotificationChannel( args: RemoveNotificationChannelCommandInput, cb: (err: any, data?: RemoveNotificationChannelCommandOutput) => void ): void; - public removeNotificationChannel( + removeNotificationChannel( args: RemoveNotificationChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveNotificationChannelCommandOutput) => void ): void; - public removeNotificationChannel( - args: RemoveNotificationChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveNotificationChannelCommandOutput) => void), - cb?: (err: any, data?: RemoveNotificationChannelCommandOutput) => void - ): Promise | void { - const command = new RemoveNotificationChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of insights in your Amazon Web Services account. You can specify which insights are - * returned by their start time, one or more statuses (ONGOING or CLOSED), one or more severities - * (LOW, MEDIUM, and HIGH), and type - * (REACTIVE or PROACTIVE).

- *

Use the Filters parameter to specify status and severity search - * parameters. Use the Type parameter to specify REACTIVE or - * PROACTIVE in your search.

+ * @see {@link SearchInsightsCommand} */ - public searchInsights( + searchInsights( args: SearchInsightsCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchInsights( - args: SearchInsightsCommandInput, - cb: (err: any, data?: SearchInsightsCommandOutput) => void - ): void; - public searchInsights( + searchInsights(args: SearchInsightsCommandInput, cb: (err: any, data?: SearchInsightsCommandOutput) => void): void; + searchInsights( args: SearchInsightsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchInsightsCommandOutput) => void ): void; - public searchInsights( - args: SearchInsightsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchInsightsCommandOutput) => void), - cb?: (err: any, data?: SearchInsightsCommandOutput) => void - ): Promise | void { - const command = new SearchInsightsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of insights in your organization. You can specify which insights are - * returned by their start time, one or more statuses (ONGOING, - * CLOSED, and CLOSED), one or more severities - * (LOW, MEDIUM, and HIGH), and type - * (REACTIVE or PROACTIVE).

- *

Use the Filters parameter to specify status and severity search - * parameters. Use the Type parameter to specify REACTIVE or - * PROACTIVE in your search.

+ * @see {@link SearchOrganizationInsightsCommand} */ - public searchOrganizationInsights( + searchOrganizationInsights( args: SearchOrganizationInsightsCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchOrganizationInsights( + searchOrganizationInsights( args: SearchOrganizationInsightsCommandInput, cb: (err: any, data?: SearchOrganizationInsightsCommandOutput) => void ): void; - public searchOrganizationInsights( + searchOrganizationInsights( args: SearchOrganizationInsightsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchOrganizationInsightsCommandOutput) => void ): void; - public searchOrganizationInsights( - args: SearchOrganizationInsightsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchOrganizationInsightsCommandOutput) => void), - cb?: (err: any, data?: SearchOrganizationInsightsCommandOutput) => void - ): Promise | void { - const command = new SearchOrganizationInsightsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts the creation of an estimate of the monthly cost to analyze your Amazon Web Services - * resources.

+ * @see {@link StartCostEstimationCommand} */ - public startCostEstimation( + startCostEstimation( args: StartCostEstimationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startCostEstimation( + startCostEstimation( args: StartCostEstimationCommandInput, cb: (err: any, data?: StartCostEstimationCommandOutput) => void ): void; - public startCostEstimation( + startCostEstimation( args: StartCostEstimationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCostEstimationCommandOutput) => void ): void; - public startCostEstimation( - args: StartCostEstimationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartCostEstimationCommandOutput) => void), - cb?: (err: any, data?: StartCostEstimationCommandOutput) => void - ): Promise | void { - const command = new StartCostEstimationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables or disables integration with a service that can be integrated with DevOps Guru. The - * one service that can be integrated with DevOps Guru is Amazon CodeGuru Profiler, which - * can produce proactive recommendations which can be stored and viewed in DevOps Guru.

+ * @see {@link UpdateEventSourcesConfigCommand} */ - public updateEventSourcesConfig( + updateEventSourcesConfig( args: UpdateEventSourcesConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEventSourcesConfig( + updateEventSourcesConfig( args: UpdateEventSourcesConfigCommandInput, cb: (err: any, data?: UpdateEventSourcesConfigCommandOutput) => void ): void; - public updateEventSourcesConfig( + updateEventSourcesConfig( args: UpdateEventSourcesConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEventSourcesConfigCommandOutput) => void ): void; - public updateEventSourcesConfig( - args: UpdateEventSourcesConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEventSourcesConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateEventSourcesConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateEventSourcesConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the collection of resources that DevOps Guru analyzes. - * The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and - * Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze - * the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks. This method also creates the IAM role required for - * you to use DevOps Guru.

+ * @see {@link UpdateResourceCollectionCommand} */ - public updateResourceCollection( + updateResourceCollection( args: UpdateResourceCollectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateResourceCollection( + updateResourceCollection( args: UpdateResourceCollectionCommandInput, cb: (err: any, data?: UpdateResourceCollectionCommandOutput) => void ): void; - public updateResourceCollection( + updateResourceCollection( args: UpdateResourceCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResourceCollectionCommandOutput) => void ): void; - public updateResourceCollection( - args: UpdateResourceCollectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResourceCollectionCommandOutput) => void), - cb?: (err: any, data?: UpdateResourceCollectionCommandOutput) => void - ): Promise | void { - const command = new UpdateResourceCollectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables or disables integration with a service that can be integrated with DevOps Guru. The - * one service that can be integrated with DevOps Guru is Amazon Web Services Systems Manager, which can be used to create - * an OpsItem for each generated insight.

+ * @see {@link UpdateServiceIntegrationCommand} */ - public updateServiceIntegration( + updateServiceIntegration( args: UpdateServiceIntegrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateServiceIntegration( + updateServiceIntegration( args: UpdateServiceIntegrationCommandInput, cb: (err: any, data?: UpdateServiceIntegrationCommandOutput) => void ): void; - public updateServiceIntegration( + updateServiceIntegration( args: UpdateServiceIntegrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceIntegrationCommandOutput) => void ): void; - public updateServiceIntegration( - args: UpdateServiceIntegrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServiceIntegrationCommandOutput) => void), - cb?: (err: any, data?: UpdateServiceIntegrationCommandOutput) => void - ): Promise | void { - const command = new UpdateServiceIntegrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon DevOps Guru is a fully managed service that helps you identify anomalous behavior in + * business critical operational applications. You specify the Amazon Web Services resources that you + * want DevOps Guru to cover, then the Amazon CloudWatch metrics and Amazon Web Services CloudTrail events related to those + * resources are analyzed. When anomalous behavior is detected, DevOps Guru creates an + * insight that includes recommendations, related events, and + * related metrics that can help you improve your operational applications. For more + * information, see What is Amazon DevOps Guru.

+ *

You can specify 1 or 2 Amazon Simple Notification Service topics so you are notified every time a new insight + * is created. You can also enable DevOps Guru to generate an OpsItem in Amazon Web Services Systems Manager for each + * insight to help you manage and track your work addressing insights.

+ *

To learn about the DevOps Guru workflow, see How DevOps Guru works. To + * learn about DevOps Guru concepts, see Concepts in DevOps Guru.

+ */ +export class DevOpsGuru extends DevOpsGuruClient implements DevOpsGuru {} +createAggregatedClient(commands, DevOpsGuru); diff --git a/clients/client-direct-connect/src/DirectConnect.ts b/clients/client-direct-connect/src/DirectConnect.ts index a5c6a8f95950..142698ffb9d4 100644 --- a/clients/client-direct-connect/src/DirectConnect.ts +++ b/clients/client-direct-connect/src/DirectConnect.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -296,2344 +297,1095 @@ import { UpdateVirtualInterfaceAttributesCommandInput, UpdateVirtualInterfaceAttributesCommandOutput, } from "./commands/UpdateVirtualInterfaceAttributesCommand"; -import { DirectConnectClient } from "./DirectConnectClient"; +import { DirectConnectClient, DirectConnectClientConfig } from "./DirectConnectClient"; -/** - * @public - *

Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. - * One end of the cable is connected to your router, the other to an Direct Connect router. With this connection - * in place, you can create virtual interfaces directly to the Amazon Web Services Cloud (for example, to Amazon EC2 - * and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A - * connection provides access to all Amazon Web Services Regions except the China (Beijing) and (China) Ningxia Regions. - * Amazon Web Services resources in the China Regions can only be accessed through locations associated with those Regions.

- */ -export class DirectConnect extends DirectConnectClient { +const commands = { + AcceptDirectConnectGatewayAssociationProposalCommand, + AllocateConnectionOnInterconnectCommand, + AllocateHostedConnectionCommand, + AllocatePrivateVirtualInterfaceCommand, + AllocatePublicVirtualInterfaceCommand, + AllocateTransitVirtualInterfaceCommand, + AssociateConnectionWithLagCommand, + AssociateHostedConnectionCommand, + AssociateMacSecKeyCommand, + AssociateVirtualInterfaceCommand, + ConfirmConnectionCommand, + ConfirmCustomerAgreementCommand, + ConfirmPrivateVirtualInterfaceCommand, + ConfirmPublicVirtualInterfaceCommand, + ConfirmTransitVirtualInterfaceCommand, + CreateBGPPeerCommand, + CreateConnectionCommand, + CreateDirectConnectGatewayCommand, + CreateDirectConnectGatewayAssociationCommand, + CreateDirectConnectGatewayAssociationProposalCommand, + CreateInterconnectCommand, + CreateLagCommand, + CreatePrivateVirtualInterfaceCommand, + CreatePublicVirtualInterfaceCommand, + CreateTransitVirtualInterfaceCommand, + DeleteBGPPeerCommand, + DeleteConnectionCommand, + DeleteDirectConnectGatewayCommand, + DeleteDirectConnectGatewayAssociationCommand, + DeleteDirectConnectGatewayAssociationProposalCommand, + DeleteInterconnectCommand, + DeleteLagCommand, + DeleteVirtualInterfaceCommand, + DescribeConnectionLoaCommand, + DescribeConnectionsCommand, + DescribeConnectionsOnInterconnectCommand, + DescribeCustomerMetadataCommand, + DescribeDirectConnectGatewayAssociationProposalsCommand, + DescribeDirectConnectGatewayAssociationsCommand, + DescribeDirectConnectGatewayAttachmentsCommand, + DescribeDirectConnectGatewaysCommand, + DescribeHostedConnectionsCommand, + DescribeInterconnectLoaCommand, + DescribeInterconnectsCommand, + DescribeLagsCommand, + DescribeLoaCommand, + DescribeLocationsCommand, + DescribeRouterConfigurationCommand, + DescribeTagsCommand, + DescribeVirtualGatewaysCommand, + DescribeVirtualInterfacesCommand, + DisassociateConnectionFromLagCommand, + DisassociateMacSecKeyCommand, + ListVirtualInterfaceTestHistoryCommand, + StartBgpFailoverTestCommand, + StopBgpFailoverTestCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateConnectionCommand, + UpdateDirectConnectGatewayCommand, + UpdateDirectConnectGatewayAssociationCommand, + UpdateLagCommand, + UpdateVirtualInterfaceAttributesCommand, +}; + +export interface DirectConnect { /** - * @public - *

Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.

+ * @see {@link AcceptDirectConnectGatewayAssociationProposalCommand} */ - public acceptDirectConnectGatewayAssociationProposal( + acceptDirectConnectGatewayAssociationProposal( args: AcceptDirectConnectGatewayAssociationProposalCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptDirectConnectGatewayAssociationProposal( + acceptDirectConnectGatewayAssociationProposal( args: AcceptDirectConnectGatewayAssociationProposalCommandInput, cb: (err: any, data?: AcceptDirectConnectGatewayAssociationProposalCommandOutput) => void ): void; - public acceptDirectConnectGatewayAssociationProposal( + acceptDirectConnectGatewayAssociationProposal( args: AcceptDirectConnectGatewayAssociationProposalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptDirectConnectGatewayAssociationProposalCommandOutput) => void ): void; - public acceptDirectConnectGatewayAssociationProposal( - args: AcceptDirectConnectGatewayAssociationProposalCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AcceptDirectConnectGatewayAssociationProposalCommandOutput) => void), - cb?: (err: any, data?: AcceptDirectConnectGatewayAssociationProposalCommandOutput) => void - ): Promise | void { - const command = new AcceptDirectConnectGatewayAssociationProposalCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Deprecated. Use AllocateHostedConnection instead.

- *

Creates a hosted connection on an interconnect.

- *

Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect.

- * - *

Intended for use by Direct Connect Partners only.

- *
+ * @see {@link AllocateConnectionOnInterconnectCommand} */ - public allocateConnectionOnInterconnect( + allocateConnectionOnInterconnect( args: AllocateConnectionOnInterconnectCommandInput, options?: __HttpHandlerOptions ): Promise; - public allocateConnectionOnInterconnect( + allocateConnectionOnInterconnect( args: AllocateConnectionOnInterconnectCommandInput, cb: (err: any, data?: AllocateConnectionOnInterconnectCommandOutput) => void ): void; - public allocateConnectionOnInterconnect( + allocateConnectionOnInterconnect( args: AllocateConnectionOnInterconnectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AllocateConnectionOnInterconnectCommandOutput) => void ): void; - public allocateConnectionOnInterconnect( - args: AllocateConnectionOnInterconnectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AllocateConnectionOnInterconnectCommandOutput) => void), - cb?: (err: any, data?: AllocateConnectionOnInterconnectCommandOutput) => void - ): Promise | void { - const command = new AllocateConnectionOnInterconnectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.

- *

Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. - * Amazon Web Services polices the hosted connection for the specified capacity and the Direct Connect Partner must also police the hosted connection for the specified capacity.

- * - *

Intended for use by Direct Connect Partners only.

- *
+ * @see {@link AllocateHostedConnectionCommand} */ - public allocateHostedConnection( + allocateHostedConnection( args: AllocateHostedConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public allocateHostedConnection( + allocateHostedConnection( args: AllocateHostedConnectionCommandInput, cb: (err: any, data?: AllocateHostedConnectionCommandOutput) => void ): void; - public allocateHostedConnection( + allocateHostedConnection( args: AllocateHostedConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AllocateHostedConnectionCommandOutput) => void ): void; - public allocateHostedConnection( - args: AllocateHostedConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AllocateHostedConnectionCommandOutput) => void), - cb?: (err: any, data?: AllocateHostedConnectionCommandOutput) => void - ): Promise | void { - const command = new AllocateHostedConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provisions a private virtual interface to be owned by the specified Amazon Web Services account.

- *

Virtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface. - * Until then, the virtual interface is in the Confirming state and is not available to handle traffic.

+ * @see {@link AllocatePrivateVirtualInterfaceCommand} */ - public allocatePrivateVirtualInterface( + allocatePrivateVirtualInterface( args: AllocatePrivateVirtualInterfaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public allocatePrivateVirtualInterface( + allocatePrivateVirtualInterface( args: AllocatePrivateVirtualInterfaceCommandInput, cb: (err: any, data?: AllocatePrivateVirtualInterfaceCommandOutput) => void ): void; - public allocatePrivateVirtualInterface( + allocatePrivateVirtualInterface( args: AllocatePrivateVirtualInterfaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AllocatePrivateVirtualInterfaceCommandOutput) => void ): void; - public allocatePrivateVirtualInterface( - args: AllocatePrivateVirtualInterfaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AllocatePrivateVirtualInterfaceCommandOutput) => void), - cb?: (err: any, data?: AllocatePrivateVirtualInterfaceCommandOutput) => void - ): Promise | void { - const command = new AllocatePrivateVirtualInterfaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provisions a public virtual interface to be owned by the specified Amazon Web Services account.

- *

The owner of a connection calls this function to provision a public virtual interface to be owned by the specified Amazon Web Services account.

- *

Virtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface. - * Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic.

- *

When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from - * the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.

+ * @see {@link AllocatePublicVirtualInterfaceCommand} */ - public allocatePublicVirtualInterface( + allocatePublicVirtualInterface( args: AllocatePublicVirtualInterfaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public allocatePublicVirtualInterface( + allocatePublicVirtualInterface( args: AllocatePublicVirtualInterfaceCommandInput, cb: (err: any, data?: AllocatePublicVirtualInterfaceCommandOutput) => void ): void; - public allocatePublicVirtualInterface( + allocatePublicVirtualInterface( args: AllocatePublicVirtualInterfaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AllocatePublicVirtualInterfaceCommandOutput) => void ): void; - public allocatePublicVirtualInterface( - args: AllocatePublicVirtualInterfaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AllocatePublicVirtualInterfaceCommandOutput) => void), - cb?: (err: any, data?: AllocatePublicVirtualInterfaceCommandOutput) => void - ): Promise | void { - const command = new AllocatePublicVirtualInterfaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provisions a transit virtual interface to be owned by the specified Amazon Web Services account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.

- *

The owner of a connection provisions a transit virtual interface to be owned by the specified Amazon Web Services account.

- *

After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.

+ * @see {@link AllocateTransitVirtualInterfaceCommand} */ - public allocateTransitVirtualInterface( + allocateTransitVirtualInterface( args: AllocateTransitVirtualInterfaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public allocateTransitVirtualInterface( + allocateTransitVirtualInterface( args: AllocateTransitVirtualInterfaceCommandInput, cb: (err: any, data?: AllocateTransitVirtualInterfaceCommandOutput) => void ): void; - public allocateTransitVirtualInterface( + allocateTransitVirtualInterface( args: AllocateTransitVirtualInterfaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AllocateTransitVirtualInterfaceCommandOutput) => void ): void; - public allocateTransitVirtualInterface( - args: AllocateTransitVirtualInterfaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AllocateTransitVirtualInterfaceCommandOutput) => void), - cb?: (err: any, data?: AllocateTransitVirtualInterfaceCommandOutput) => void - ): Promise | void { - const command = new AllocateTransitVirtualInterfaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates an existing connection with a link aggregation group (LAG). The connection - * is interrupted and re-established as a member of the LAG (connectivity to Amazon Web Services is - * interrupted). The connection must be hosted on the same Direct Connect endpoint as the LAG, and its - * bandwidth must match the bandwidth for the LAG. You can re-associate a connection that's - * currently associated with a different LAG; however, if removing the connection would cause - * the original LAG to fall below its setting for minimum number of operational connections, - * the request fails.

- *

Any virtual interfaces that are directly associated with the connection are - * automatically re-associated with the LAG. If the connection was originally associated - * with a different LAG, the virtual interfaces remain associated with the original - * LAG.

- *

For interconnects, any hosted connections are automatically re-associated with the - * LAG. If the interconnect was originally associated with a different LAG, the hosted - * connections remain associated with the original LAG.

+ * @see {@link AssociateConnectionWithLagCommand} */ - public associateConnectionWithLag( + associateConnectionWithLag( args: AssociateConnectionWithLagCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateConnectionWithLag( + associateConnectionWithLag( args: AssociateConnectionWithLagCommandInput, cb: (err: any, data?: AssociateConnectionWithLagCommandOutput) => void ): void; - public associateConnectionWithLag( + associateConnectionWithLag( args: AssociateConnectionWithLagCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateConnectionWithLagCommandOutput) => void ): void; - public associateConnectionWithLag( - args: AssociateConnectionWithLagCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateConnectionWithLagCommandOutput) => void), - cb?: (err: any, data?: AssociateConnectionWithLagCommandOutput) => void - ): Promise | void { - const command = new AssociateConnectionWithLagCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a hosted connection and its virtual interfaces with a link aggregation - * group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted - * connection with a conflicting VLAN number or IP address, the operation fails. This - * action temporarily interrupts the hosted connection's connectivity to Amazon Web Services - * as it is being migrated.

- * - *

Intended for use by Direct Connect Partners only.

- *
+ * @see {@link AssociateHostedConnectionCommand} */ - public associateHostedConnection( + associateHostedConnection( args: AssociateHostedConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateHostedConnection( + associateHostedConnection( args: AssociateHostedConnectionCommandInput, cb: (err: any, data?: AssociateHostedConnectionCommandOutput) => void ): void; - public associateHostedConnection( + associateHostedConnection( args: AssociateHostedConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateHostedConnectionCommandOutput) => void ): void; - public associateHostedConnection( - args: AssociateHostedConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateHostedConnectionCommandOutput) => void), - cb?: (err: any, data?: AssociateHostedConnectionCommandOutput) => void - ): Promise | void { - const command = new AssociateHostedConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an Direct Connect dedicated connection.

- *

You must supply either the secretARN, or the CKN/CAK (ckn and cak) pair in the request.

- *

For information about MAC Security (MACsec) key considerations, see MACsec pre-shared CKN/CAK key considerations in the Direct Connect User Guide.

+ * @see {@link AssociateMacSecKeyCommand} */ - public associateMacSecKey( + associateMacSecKey( args: AssociateMacSecKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateMacSecKey( + associateMacSecKey( args: AssociateMacSecKeyCommandInput, cb: (err: any, data?: AssociateMacSecKeyCommandOutput) => void ): void; - public associateMacSecKey( + associateMacSecKey( args: AssociateMacSecKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateMacSecKeyCommandOutput) => void ): void; - public associateMacSecKey( - args: AssociateMacSecKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateMacSecKeyCommandOutput) => void), - cb?: (err: any, data?: AssociateMacSecKeyCommandOutput) => void - ): Promise | void { - const command = new AssociateMacSecKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a virtual interface with a specified link aggregation group (LAG) or - * connection. Connectivity to Amazon Web Services is temporarily interrupted as the virtual interface is - * being migrated. If the target connection or LAG has an associated virtual interface with - * a conflicting VLAN number or a conflicting IP address, the operation fails.

- *

Virtual interfaces associated with a hosted connection cannot be associated with a - * LAG; hosted connections must be migrated along with their virtual interfaces using AssociateHostedConnection.

- *

To reassociate a virtual interface to a new connection or LAG, the requester - * must own either the virtual interface itself or the connection to which the virtual - * interface is currently associated. Additionally, the requester must own the connection - * or LAG for the association.

+ * @see {@link AssociateVirtualInterfaceCommand} */ - public associateVirtualInterface( + associateVirtualInterface( args: AssociateVirtualInterfaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateVirtualInterface( + associateVirtualInterface( args: AssociateVirtualInterfaceCommandInput, cb: (err: any, data?: AssociateVirtualInterfaceCommandOutput) => void ): void; - public associateVirtualInterface( + associateVirtualInterface( args: AssociateVirtualInterfaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateVirtualInterfaceCommandOutput) => void ): void; - public associateVirtualInterface( - args: AssociateVirtualInterfaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateVirtualInterfaceCommandOutput) => void), - cb?: (err: any, data?: AssociateVirtualInterfaceCommandOutput) => void - ): Promise | void { - const command = new AssociateVirtualInterfaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Confirms the creation of the specified hosted connection on an interconnect.

- *

Upon creation, the hosted connection is initially in the Ordering state, and - * remains in this state until the owner confirms creation of the hosted connection.

+ * @see {@link ConfirmConnectionCommand} */ - public confirmConnection( + confirmConnection( args: ConfirmConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public confirmConnection( + confirmConnection( args: ConfirmConnectionCommandInput, cb: (err: any, data?: ConfirmConnectionCommandOutput) => void ): void; - public confirmConnection( + confirmConnection( args: ConfirmConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfirmConnectionCommandOutput) => void ): void; - public confirmConnection( - args: ConfirmConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConfirmConnectionCommandOutput) => void), - cb?: (err: any, data?: ConfirmConnectionCommandOutput) => void - ): Promise | void { - const command = new ConfirmConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The confirmation of the terms of agreement when creating the connection/link aggregation group (LAG). - *

+ * @see {@link ConfirmCustomerAgreementCommand} */ - public confirmCustomerAgreement( + confirmCustomerAgreement( args: ConfirmCustomerAgreementCommandInput, options?: __HttpHandlerOptions ): Promise; - public confirmCustomerAgreement( + confirmCustomerAgreement( args: ConfirmCustomerAgreementCommandInput, cb: (err: any, data?: ConfirmCustomerAgreementCommandOutput) => void ): void; - public confirmCustomerAgreement( + confirmCustomerAgreement( args: ConfirmCustomerAgreementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfirmCustomerAgreementCommandOutput) => void ): void; - public confirmCustomerAgreement( - args: ConfirmCustomerAgreementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConfirmCustomerAgreementCommandOutput) => void), - cb?: (err: any, data?: ConfirmCustomerAgreementCommandOutput) => void - ): Promise | void { - const command = new ConfirmCustomerAgreementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Accepts ownership of a private virtual interface created by another Amazon Web Services account.

- *

After the virtual interface owner makes this call, the virtual interface is - * created and attached to the specified virtual private gateway or Direct Connect gateway, and is - * made available to handle traffic.

+ * @see {@link ConfirmPrivateVirtualInterfaceCommand} */ - public confirmPrivateVirtualInterface( + confirmPrivateVirtualInterface( args: ConfirmPrivateVirtualInterfaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public confirmPrivateVirtualInterface( + confirmPrivateVirtualInterface( args: ConfirmPrivateVirtualInterfaceCommandInput, cb: (err: any, data?: ConfirmPrivateVirtualInterfaceCommandOutput) => void ): void; - public confirmPrivateVirtualInterface( + confirmPrivateVirtualInterface( args: ConfirmPrivateVirtualInterfaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfirmPrivateVirtualInterfaceCommandOutput) => void ): void; - public confirmPrivateVirtualInterface( - args: ConfirmPrivateVirtualInterfaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConfirmPrivateVirtualInterfaceCommandOutput) => void), - cb?: (err: any, data?: ConfirmPrivateVirtualInterfaceCommandOutput) => void - ): Promise | void { - const command = new ConfirmPrivateVirtualInterfaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Accepts ownership of a public virtual interface created by another Amazon Web Services account.

- *

After the virtual interface owner makes this call, the specified virtual interface is - * created and made available to handle traffic.

+ * @see {@link ConfirmPublicVirtualInterfaceCommand} */ - public confirmPublicVirtualInterface( + confirmPublicVirtualInterface( args: ConfirmPublicVirtualInterfaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public confirmPublicVirtualInterface( + confirmPublicVirtualInterface( args: ConfirmPublicVirtualInterfaceCommandInput, cb: (err: any, data?: ConfirmPublicVirtualInterfaceCommandOutput) => void ): void; - public confirmPublicVirtualInterface( + confirmPublicVirtualInterface( args: ConfirmPublicVirtualInterfaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfirmPublicVirtualInterfaceCommandOutput) => void ): void; - public confirmPublicVirtualInterface( - args: ConfirmPublicVirtualInterfaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConfirmPublicVirtualInterfaceCommandOutput) => void), - cb?: (err: any, data?: ConfirmPublicVirtualInterfaceCommandOutput) => void - ): Promise | void { - const command = new ConfirmPublicVirtualInterfaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Accepts ownership of a transit virtual interface created by another Amazon Web Services account.

- *

After the owner of the transit virtual interface makes this call, the specified transit virtual interface is created and made available to handle traffic.

+ * @see {@link ConfirmTransitVirtualInterfaceCommand} */ - public confirmTransitVirtualInterface( + confirmTransitVirtualInterface( args: ConfirmTransitVirtualInterfaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public confirmTransitVirtualInterface( + confirmTransitVirtualInterface( args: ConfirmTransitVirtualInterfaceCommandInput, cb: (err: any, data?: ConfirmTransitVirtualInterfaceCommandOutput) => void ): void; - public confirmTransitVirtualInterface( + confirmTransitVirtualInterface( args: ConfirmTransitVirtualInterfaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfirmTransitVirtualInterfaceCommandOutput) => void ): void; - public confirmTransitVirtualInterface( - args: ConfirmTransitVirtualInterfaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConfirmTransitVirtualInterfaceCommandOutput) => void), - cb?: (err: any, data?: ConfirmTransitVirtualInterfaceCommandOutput) => void - ): Promise | void { - const command = new ConfirmTransitVirtualInterfaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a BGP peer on the specified virtual interface.

- *

You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to - * access Amazon Web Services resources that also use that address family.

- *

If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot - * be in the same address family as an existing BGP peer on the virtual interface.

- *

When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from - * the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.

- * - *

If you let Amazon Web Services auto-assign IPv4 addresses, a /30 CIDR will be allocated - * from 169.254.0.0/16. Amazon Web Services does not recommend this option if you intend to use - * the customer router peer IP address as the source and destination for traffic. Instead you - * should use RFC 1918 or other addressing, and specify the address yourself. For more - * information about RFC 1918 see - * Address Allocation for Private Internets.

- *
- *

For a public virtual interface, the Autonomous System Number (ASN) must be private or already on the allow list for the virtual interface.

+ * @see {@link CreateBGPPeerCommand} */ - public createBGPPeer( - args: CreateBGPPeerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createBGPPeer( - args: CreateBGPPeerCommandInput, - cb: (err: any, data?: CreateBGPPeerCommandOutput) => void - ): void; - public createBGPPeer( + createBGPPeer(args: CreateBGPPeerCommandInput, options?: __HttpHandlerOptions): Promise; + createBGPPeer(args: CreateBGPPeerCommandInput, cb: (err: any, data?: CreateBGPPeerCommandOutput) => void): void; + createBGPPeer( args: CreateBGPPeerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBGPPeerCommandOutput) => void ): void; - public createBGPPeer( - args: CreateBGPPeerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBGPPeerCommandOutput) => void), - cb?: (err: any, data?: CreateBGPPeerCommandOutput) => void - ): Promise | void { - const command = new CreateBGPPeerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a connection between a customer network and a specific Direct Connect location.

- *

A connection links your internal network to an Direct Connect location over a standard Ethernet fiber-optic - * cable. One end of the cable is connected to your router, the other to an Direct Connect router.

- *

To find the locations for your Region, use DescribeLocations.

- *

You can automatically add the new connection to a link aggregation group (LAG) by - * specifying a LAG ID in the request. This ensures that the new connection is allocated on the - * same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, - * the request fails and no connection is created.

+ * @see {@link CreateConnectionCommand} */ - public createConnection( + createConnection( args: CreateConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConnection( + createConnection( args: CreateConnectionCommandInput, cb: (err: any, data?: CreateConnectionCommandOutput) => void ): void; - public createConnection( + createConnection( args: CreateConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectionCommandOutput) => void ): void; - public createConnection( - args: CreateConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConnectionCommandOutput) => void), - cb?: (err: any, data?: CreateConnectionCommandOutput) => void - ): Promise | void { - const command = new CreateConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set - * of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any - * Amazon Web Services Region after it is created. The virtual interfaces and virtual private gateways that - * are connected through a Direct Connect gateway can be in different Amazon Web Services Regions. This enables you to - * connect to a VPC in any Region, regardless of the Region in which the virtual interfaces - * are located, and pass traffic between them.

+ * @see {@link CreateDirectConnectGatewayCommand} */ - public createDirectConnectGateway( + createDirectConnectGateway( args: CreateDirectConnectGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDirectConnectGateway( + createDirectConnectGateway( args: CreateDirectConnectGatewayCommandInput, cb: (err: any, data?: CreateDirectConnectGatewayCommandOutput) => void ): void; - public createDirectConnectGateway( + createDirectConnectGateway( args: CreateDirectConnectGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDirectConnectGatewayCommandOutput) => void ): void; - public createDirectConnectGateway( - args: CreateDirectConnectGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDirectConnectGatewayCommandOutput) => void), - cb?: (err: any, data?: CreateDirectConnectGatewayCommandOutput) => void - ): Promise | void { - const command = new CreateDirectConnectGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an association between a Direct Connect gateway and a virtual private gateway. The virtual - * private gateway must be attached to a VPC and must not be associated with another Direct Connect gateway.

+ * @see {@link CreateDirectConnectGatewayAssociationCommand} */ - public createDirectConnectGatewayAssociation( + createDirectConnectGatewayAssociation( args: CreateDirectConnectGatewayAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDirectConnectGatewayAssociation( + createDirectConnectGatewayAssociation( args: CreateDirectConnectGatewayAssociationCommandInput, cb: (err: any, data?: CreateDirectConnectGatewayAssociationCommandOutput) => void ): void; - public createDirectConnectGatewayAssociation( + createDirectConnectGatewayAssociation( args: CreateDirectConnectGatewayAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDirectConnectGatewayAssociationCommandOutput) => void ): void; - public createDirectConnectGatewayAssociation( - args: CreateDirectConnectGatewayAssociationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateDirectConnectGatewayAssociationCommandOutput) => void), - cb?: (err: any, data?: CreateDirectConnectGatewayAssociationCommandOutput) => void - ): Promise | void { - const command = new CreateDirectConnectGatewayAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.

- *

You can associate a Direct Connect gateway and virtual private gateway or transit gateway that is owned by any Amazon Web Services account.

+ * @see {@link CreateDirectConnectGatewayAssociationProposalCommand} */ - public createDirectConnectGatewayAssociationProposal( + createDirectConnectGatewayAssociationProposal( args: CreateDirectConnectGatewayAssociationProposalCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDirectConnectGatewayAssociationProposal( + createDirectConnectGatewayAssociationProposal( args: CreateDirectConnectGatewayAssociationProposalCommandInput, cb: (err: any, data?: CreateDirectConnectGatewayAssociationProposalCommandOutput) => void ): void; - public createDirectConnectGatewayAssociationProposal( + createDirectConnectGatewayAssociationProposal( args: CreateDirectConnectGatewayAssociationProposalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDirectConnectGatewayAssociationProposalCommandOutput) => void ): void; - public createDirectConnectGatewayAssociationProposal( - args: CreateDirectConnectGatewayAssociationProposalCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateDirectConnectGatewayAssociationProposalCommandOutput) => void), - cb?: (err: any, data?: CreateDirectConnectGatewayAssociationProposalCommandOutput) => void - ): Promise | void { - const command = new CreateDirectConnectGatewayAssociationProposalCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an interconnect between an Direct Connect Partner's network and a specific Direct Connect location.

- *

An interconnect is a connection that is capable of hosting other connections. The - * Direct Connect Partner can use an interconnect to provide Direct Connect hosted - * connections to customers through their own network services. Like a standard connection, an - * interconnect links the partner's network to an Direct Connect location over a standard Ethernet - * fiber-optic cable. One end is connected to the partner's router, the other to an Direct Connect - * router.

- *

You can automatically add the new interconnect to a link aggregation group (LAG) by - * specifying a LAG ID in the request. This ensures that the new interconnect is allocated on - * the same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the - * endpoint, the request fails and no interconnect is created.

- *

For each end customer, the Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. - * The end customer can then connect to Amazon Web Services resources by creating a virtual interface on their connection, using the VLAN assigned to them by the Direct Connect Partner.

- * - *

Intended for use by Direct Connect Partners only.

- *
+ * @see {@link CreateInterconnectCommand} */ - public createInterconnect( + createInterconnect( args: CreateInterconnectCommandInput, options?: __HttpHandlerOptions ): Promise; - public createInterconnect( + createInterconnect( args: CreateInterconnectCommandInput, cb: (err: any, data?: CreateInterconnectCommandOutput) => void ): void; - public createInterconnect( + createInterconnect( args: CreateInterconnectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInterconnectCommandOutput) => void ): void; - public createInterconnect( - args: CreateInterconnectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateInterconnectCommandOutput) => void), - cb?: (err: any, data?: CreateInterconnectCommandOutput) => void - ): Promise | void { - const command = new CreateInterconnectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a link aggregation group (LAG) with the specified number of bundled - * physical dedicated connections between the customer network and a specific Direct Connect location. - * A LAG is a logical interface that uses the Link Aggregation Control Protocol - * (LACP) to aggregate multiple interfaces, enabling you to treat them as a single - * interface.

- *

All connections in a LAG must use the same bandwidth (either 1Gbps or 10Gbps) and must terminate at the same Direct Connect endpoint.

- *

You can have up to 10 dedicated connections per LAG. Regardless of this limit, if you - * request more connections for the LAG than Direct Connect can allocate on a single endpoint, no LAG is - * created.

- *

You can specify an existing physical dedicated connection or interconnect to include in - * the LAG (which counts towards the total number of connections). Doing so interrupts the - * current physical dedicated connection, and re-establishes them as a member of the LAG. The LAG - * will be created on the same Direct Connect endpoint to which the dedicated connection terminates. Any - * virtual interfaces associated with the dedicated connection are automatically disassociated - * and re-associated with the LAG. The connection ID does not change.

- *

If the Amazon Web Services account used to create a LAG is a registered Direct Connect Partner, the LAG is - * automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual - * interfaces cannot be directly configured.

+ * @see {@link CreateLagCommand} */ - public createLag(args: CreateLagCommandInput, options?: __HttpHandlerOptions): Promise; - public createLag(args: CreateLagCommandInput, cb: (err: any, data?: CreateLagCommandOutput) => void): void; - public createLag( + createLag(args: CreateLagCommandInput, options?: __HttpHandlerOptions): Promise; + createLag(args: CreateLagCommandInput, cb: (err: any, data?: CreateLagCommandOutput) => void): void; + createLag( args: CreateLagCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLagCommandOutput) => void ): void; - public createLag( - args: CreateLagCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLagCommandOutput) => void), - cb?: (err: any, data?: CreateLagCommandOutput) => void - ): Promise | void { - const command = new CreateLagCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a private virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. - * A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). - * Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple - * VPCs, including VPCs in different Amazon Web Services Regions. Connecting the private virtual interface - * to a VGW only provides access to a single VPC within the same Region.

- *

Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to - * the underlying physical connection if it wasn't updated to support jumbo frames. Updating - * the connection disrupts network connectivity for all virtual interfaces associated with - * the connection for up to 30 seconds. To check whether your connection supports jumbo - * frames, call DescribeConnections. To check whether your virtual - * interface supports jumbo frames, call DescribeVirtualInterfaces.

+ * @see {@link CreatePrivateVirtualInterfaceCommand} */ - public createPrivateVirtualInterface( + createPrivateVirtualInterface( args: CreatePrivateVirtualInterfaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPrivateVirtualInterface( + createPrivateVirtualInterface( args: CreatePrivateVirtualInterfaceCommandInput, cb: (err: any, data?: CreatePrivateVirtualInterfaceCommandOutput) => void ): void; - public createPrivateVirtualInterface( + createPrivateVirtualInterface( args: CreatePrivateVirtualInterfaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePrivateVirtualInterfaceCommandOutput) => void ): void; - public createPrivateVirtualInterface( - args: CreatePrivateVirtualInterfaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePrivateVirtualInterfaceCommandOutput) => void), - cb?: (err: any, data?: CreatePrivateVirtualInterfaceCommandOutput) => void - ): Promise | void { - const command = new CreatePrivateVirtualInterfaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a public virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. - * A public virtual interface supports sending traffic to public services of Amazon Web Services such as Amazon S3.

- *

When creating an IPv6 public virtual interface (addressFamily is ipv6), leave the customer - * and amazon address fields blank to use auto-assigned IPv6 space. Custom IPv6 addresses are not supported.

+ * @see {@link CreatePublicVirtualInterfaceCommand} */ - public createPublicVirtualInterface( + createPublicVirtualInterface( args: CreatePublicVirtualInterfaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPublicVirtualInterface( + createPublicVirtualInterface( args: CreatePublicVirtualInterfaceCommandInput, cb: (err: any, data?: CreatePublicVirtualInterfaceCommandOutput) => void ): void; - public createPublicVirtualInterface( + createPublicVirtualInterface( args: CreatePublicVirtualInterfaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePublicVirtualInterfaceCommandOutput) => void ): void; - public createPublicVirtualInterface( - args: CreatePublicVirtualInterfaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePublicVirtualInterfaceCommandOutput) => void), - cb?: (err: any, data?: CreatePublicVirtualInterfaceCommandOutput) => void - ): Promise | void { - const command = new CreatePublicVirtualInterfaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a transit virtual interface. A transit virtual interface should be used to access one or more transit gateways associated with Direct Connect gateways. A transit virtual interface enables the connection of multiple VPCs attached to a transit gateway to a Direct Connect gateway.

- * - *

If you associate your transit gateway with one or more Direct Connect gateways, the Autonomous System Number (ASN) used by the transit gateway and the Direct Connect gateway must be different. For example, if you use the default ASN 64512 for both your the transit gateway and Direct Connect gateway, the association request fails.

- *
- *

A jumbo MTU value must be either 1500 or 8500. No other values will be accepted. Setting - * the MTU of a virtual interface to 8500 (jumbo frames) can cause an update to the underlying - * physical connection if it wasn't updated to support jumbo frames. Updating the connection - * disrupts network connectivity for all virtual interfaces associated with the connection for up - * to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo - * frames, call DescribeVirtualInterfaces.

+ * @see {@link CreateTransitVirtualInterfaceCommand} */ - public createTransitVirtualInterface( + createTransitVirtualInterface( args: CreateTransitVirtualInterfaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTransitVirtualInterface( + createTransitVirtualInterface( args: CreateTransitVirtualInterfaceCommandInput, cb: (err: any, data?: CreateTransitVirtualInterfaceCommandOutput) => void ): void; - public createTransitVirtualInterface( + createTransitVirtualInterface( args: CreateTransitVirtualInterfaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTransitVirtualInterfaceCommandOutput) => void ): void; - public createTransitVirtualInterface( - args: CreateTransitVirtualInterfaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTransitVirtualInterfaceCommandOutput) => void), - cb?: (err: any, data?: CreateTransitVirtualInterfaceCommandOutput) => void - ): Promise | void { - const command = new CreateTransitVirtualInterfaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN.

- *

You cannot delete the last BGP peer from a virtual interface.

+ * @see {@link DeleteBGPPeerCommand} */ - public deleteBGPPeer( - args: DeleteBGPPeerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteBGPPeer( - args: DeleteBGPPeerCommandInput, - cb: (err: any, data?: DeleteBGPPeerCommandOutput) => void - ): void; - public deleteBGPPeer( + deleteBGPPeer(args: DeleteBGPPeerCommandInput, options?: __HttpHandlerOptions): Promise; + deleteBGPPeer(args: DeleteBGPPeerCommandInput, cb: (err: any, data?: DeleteBGPPeerCommandOutput) => void): void; + deleteBGPPeer( args: DeleteBGPPeerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBGPPeerCommandOutput) => void ): void; - public deleteBGPPeer( - args: DeleteBGPPeerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBGPPeerCommandOutput) => void), - cb?: (err: any, data?: DeleteBGPPeerCommandOutput) => void - ): Promise | void { - const command = new DeleteBGPPeerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified connection.

- *

Deleting a connection only stops the Direct Connect port hour and data transfer charges. - * If you are partnering with any third parties to connect with the Direct Connect location, - * you must cancel your service with them separately.

+ * @see {@link DeleteConnectionCommand} */ - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, cb: (err: any, data?: DeleteConnectionCommandOutput) => void ): void; - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectionCommandOutput) => void ): void; - public deleteConnection( - args: DeleteConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConnectionCommandOutput) => void), - cb?: (err: any, data?: DeleteConnectionCommandOutput) => void - ): Promise | void { - const command = new DeleteConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified Direct Connect gateway. You must first delete all virtual interfaces that are - * attached to the Direct Connect gateway and disassociate all virtual private gateways associated - * with the Direct Connect gateway.

+ * @see {@link DeleteDirectConnectGatewayCommand} */ - public deleteDirectConnectGateway( + deleteDirectConnectGateway( args: DeleteDirectConnectGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDirectConnectGateway( + deleteDirectConnectGateway( args: DeleteDirectConnectGatewayCommandInput, cb: (err: any, data?: DeleteDirectConnectGatewayCommandOutput) => void ): void; - public deleteDirectConnectGateway( + deleteDirectConnectGateway( args: DeleteDirectConnectGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDirectConnectGatewayCommandOutput) => void ): void; - public deleteDirectConnectGateway( - args: DeleteDirectConnectGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDirectConnectGatewayCommandOutput) => void), - cb?: (err: any, data?: DeleteDirectConnectGatewayCommandOutput) => void - ): Promise | void { - const command = new DeleteDirectConnectGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the association between the specified Direct Connect gateway and virtual private gateway.

- *

We recommend that you specify the associationID to delete the association. Alternatively, if you own virtual gateway and a Direct Connect gateway association, you can specify the virtualGatewayId and directConnectGatewayId to delete an association.

+ * @see {@link DeleteDirectConnectGatewayAssociationCommand} */ - public deleteDirectConnectGatewayAssociation( + deleteDirectConnectGatewayAssociation( args: DeleteDirectConnectGatewayAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDirectConnectGatewayAssociation( + deleteDirectConnectGatewayAssociation( args: DeleteDirectConnectGatewayAssociationCommandInput, cb: (err: any, data?: DeleteDirectConnectGatewayAssociationCommandOutput) => void ): void; - public deleteDirectConnectGatewayAssociation( + deleteDirectConnectGatewayAssociation( args: DeleteDirectConnectGatewayAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDirectConnectGatewayAssociationCommandOutput) => void ): void; - public deleteDirectConnectGatewayAssociation( - args: DeleteDirectConnectGatewayAssociationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteDirectConnectGatewayAssociationCommandOutput) => void), - cb?: (err: any, data?: DeleteDirectConnectGatewayAssociationCommandOutput) => void - ): Promise | void { - const command = new DeleteDirectConnectGatewayAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.

+ * @see {@link DeleteDirectConnectGatewayAssociationProposalCommand} */ - public deleteDirectConnectGatewayAssociationProposal( + deleteDirectConnectGatewayAssociationProposal( args: DeleteDirectConnectGatewayAssociationProposalCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDirectConnectGatewayAssociationProposal( + deleteDirectConnectGatewayAssociationProposal( args: DeleteDirectConnectGatewayAssociationProposalCommandInput, cb: (err: any, data?: DeleteDirectConnectGatewayAssociationProposalCommandOutput) => void ): void; - public deleteDirectConnectGatewayAssociationProposal( + deleteDirectConnectGatewayAssociationProposal( args: DeleteDirectConnectGatewayAssociationProposalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDirectConnectGatewayAssociationProposalCommandOutput) => void ): void; - public deleteDirectConnectGatewayAssociationProposal( - args: DeleteDirectConnectGatewayAssociationProposalCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteDirectConnectGatewayAssociationProposalCommandOutput) => void), - cb?: (err: any, data?: DeleteDirectConnectGatewayAssociationProposalCommandOutput) => void - ): Promise | void { - const command = new DeleteDirectConnectGatewayAssociationProposalCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified interconnect.

- * - *

Intended for use - * by Direct Connect Partners only.

- *
+ * @see {@link DeleteInterconnectCommand} */ - public deleteInterconnect( + deleteInterconnect( args: DeleteInterconnectCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInterconnect( + deleteInterconnect( args: DeleteInterconnectCommandInput, cb: (err: any, data?: DeleteInterconnectCommandOutput) => void ): void; - public deleteInterconnect( + deleteInterconnect( args: DeleteInterconnectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInterconnectCommandOutput) => void ): void; - public deleteInterconnect( - args: DeleteInterconnectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInterconnectCommandOutput) => void), - cb?: (err: any, data?: DeleteInterconnectCommandOutput) => void - ): Promise | void { - const command = new DeleteInterconnectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active - * virtual interfaces or hosted connections.

+ * @see {@link DeleteLagCommand} */ - public deleteLag(args: DeleteLagCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteLag(args: DeleteLagCommandInput, cb: (err: any, data?: DeleteLagCommandOutput) => void): void; - public deleteLag( + deleteLag(args: DeleteLagCommandInput, options?: __HttpHandlerOptions): Promise; + deleteLag(args: DeleteLagCommandInput, cb: (err: any, data?: DeleteLagCommandOutput) => void): void; + deleteLag( args: DeleteLagCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLagCommandOutput) => void ): void; - public deleteLag( - args: DeleteLagCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLagCommandOutput) => void), - cb?: (err: any, data?: DeleteLagCommandOutput) => void - ): Promise | void { - const command = new DeleteLagCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a virtual interface.

+ * @see {@link DeleteVirtualInterfaceCommand} */ - public deleteVirtualInterface( + deleteVirtualInterface( args: DeleteVirtualInterfaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVirtualInterface( + deleteVirtualInterface( args: DeleteVirtualInterfaceCommandInput, cb: (err: any, data?: DeleteVirtualInterfaceCommandOutput) => void ): void; - public deleteVirtualInterface( + deleteVirtualInterface( args: DeleteVirtualInterfaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVirtualInterfaceCommandOutput) => void ): void; - public deleteVirtualInterface( - args: DeleteVirtualInterfaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVirtualInterfaceCommandOutput) => void), - cb?: (err: any, data?: DeleteVirtualInterfaceCommandOutput) => void - ): Promise | void { - const command = new DeleteVirtualInterfaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Deprecated. Use DescribeLoa instead.

- *

Gets the LOA-CFA for a connection.

- *

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or - * service provider uses when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, - * see Requesting Cross Connects - * at Direct Connect Locations in the Direct Connect User Guide.

+ * @see {@link DescribeConnectionLoaCommand} */ - public describeConnectionLoa( + describeConnectionLoa( args: DescribeConnectionLoaCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConnectionLoa( + describeConnectionLoa( args: DescribeConnectionLoaCommandInput, cb: (err: any, data?: DescribeConnectionLoaCommandOutput) => void ): void; - public describeConnectionLoa( + describeConnectionLoa( args: DescribeConnectionLoaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectionLoaCommandOutput) => void ): void; - public describeConnectionLoa( - args: DescribeConnectionLoaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConnectionLoaCommandOutput) => void), - cb?: (err: any, data?: DescribeConnectionLoaCommandOutput) => void - ): Promise | void { - const command = new DescribeConnectionLoaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays the specified connection or all connections in this Region.

+ * @see {@link DescribeConnectionsCommand} */ - public describeConnections( + describeConnections( args: DescribeConnectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConnections( + describeConnections( args: DescribeConnectionsCommandInput, cb: (err: any, data?: DescribeConnectionsCommandOutput) => void ): void; - public describeConnections( + describeConnections( args: DescribeConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectionsCommandOutput) => void ): void; - public describeConnections( - args: DescribeConnectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConnectionsCommandOutput) => void), - cb?: (err: any, data?: DescribeConnectionsCommandOutput) => void - ): Promise | void { - const command = new DescribeConnectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Deprecated. Use DescribeHostedConnections instead.

- *

Lists the connections that have been provisioned on the specified interconnect.

- * - *

Intended for use by Direct Connect Partners only.

- *
+ * @see {@link DescribeConnectionsOnInterconnectCommand} */ - public describeConnectionsOnInterconnect( + describeConnectionsOnInterconnect( args: DescribeConnectionsOnInterconnectCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConnectionsOnInterconnect( + describeConnectionsOnInterconnect( args: DescribeConnectionsOnInterconnectCommandInput, cb: (err: any, data?: DescribeConnectionsOnInterconnectCommandOutput) => void ): void; - public describeConnectionsOnInterconnect( + describeConnectionsOnInterconnect( args: DescribeConnectionsOnInterconnectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectionsOnInterconnectCommandOutput) => void ): void; - public describeConnectionsOnInterconnect( - args: DescribeConnectionsOnInterconnectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConnectionsOnInterconnectCommandOutput) => void), - cb?: (err: any, data?: DescribeConnectionsOnInterconnectCommandOutput) => void - ): Promise | void { - const command = new DescribeConnectionsOnInterconnectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get and view a list of customer agreements, along with their signed status and whether the customer is an NNIPartner, NNIPartnerV2, or a nonPartner.

+ * @see {@link DescribeCustomerMetadataCommand} */ - public describeCustomerMetadata( + describeCustomerMetadata( args: DescribeCustomerMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCustomerMetadata( + describeCustomerMetadata( args: DescribeCustomerMetadataCommandInput, cb: (err: any, data?: DescribeCustomerMetadataCommandOutput) => void ): void; - public describeCustomerMetadata( + describeCustomerMetadata( args: DescribeCustomerMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCustomerMetadataCommandOutput) => void ): void; - public describeCustomerMetadata( - args: DescribeCustomerMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCustomerMetadataCommandOutput) => void), - cb?: (err: any, data?: DescribeCustomerMetadataCommandOutput) => void - ): Promise | void { - const command = new DescribeCustomerMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.

+ * @see {@link DescribeDirectConnectGatewayAssociationProposalsCommand} */ - public describeDirectConnectGatewayAssociationProposals( + describeDirectConnectGatewayAssociationProposals( args: DescribeDirectConnectGatewayAssociationProposalsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDirectConnectGatewayAssociationProposals( + describeDirectConnectGatewayAssociationProposals( args: DescribeDirectConnectGatewayAssociationProposalsCommandInput, cb: (err: any, data?: DescribeDirectConnectGatewayAssociationProposalsCommandOutput) => void ): void; - public describeDirectConnectGatewayAssociationProposals( + describeDirectConnectGatewayAssociationProposals( args: DescribeDirectConnectGatewayAssociationProposalsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDirectConnectGatewayAssociationProposalsCommandOutput) => void ): void; - public describeDirectConnectGatewayAssociationProposals( - args: DescribeDirectConnectGatewayAssociationProposalsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeDirectConnectGatewayAssociationProposalsCommandOutput) => void), - cb?: (err: any, data?: DescribeDirectConnectGatewayAssociationProposalsCommandOutput) => void - ): Promise | void { - const command = new DescribeDirectConnectGatewayAssociationProposalsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways. You must specify one of the following:

- *
    - *
  • - *

    A Direct Connect gateway

    - *

    The response contains all virtual private gateways and transit gateways associated with the Direct Connect gateway.

    - *
  • - *
  • - *

    A virtual private gateway

    - *

    The response contains the Direct Connect gateway.

    - *
  • - *
  • - *

    A transit gateway

    - *

    The response contains the Direct Connect gateway.

    - *
  • - *
  • - *

    A Direct Connect gateway and a virtual private gateway

    - *

    The response contains the association between the Direct Connect gateway and virtual private gateway.

    - *
  • - *
  • - *

    A Direct Connect gateway and a transit gateway

    - *

    The response contains the association between the Direct Connect gateway and transit gateway.

    - *
  • - *
+ * @see {@link DescribeDirectConnectGatewayAssociationsCommand} */ - public describeDirectConnectGatewayAssociations( + describeDirectConnectGatewayAssociations( args: DescribeDirectConnectGatewayAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDirectConnectGatewayAssociations( + describeDirectConnectGatewayAssociations( args: DescribeDirectConnectGatewayAssociationsCommandInput, cb: (err: any, data?: DescribeDirectConnectGatewayAssociationsCommandOutput) => void ): void; - public describeDirectConnectGatewayAssociations( + describeDirectConnectGatewayAssociations( args: DescribeDirectConnectGatewayAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDirectConnectGatewayAssociationsCommandOutput) => void ): void; - public describeDirectConnectGatewayAssociations( - args: DescribeDirectConnectGatewayAssociationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeDirectConnectGatewayAssociationsCommandOutput) => void), - cb?: (err: any, data?: DescribeDirectConnectGatewayAssociationsCommandOutput) => void - ): Promise | void { - const command = new DescribeDirectConnectGatewayAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify - * a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains - * all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the - * response contains all Direct Connect gateways attached to the virtual interface. If you specify both, - * the response contains the attachment between the Direct Connect gateway and the virtual interface.

+ * @see {@link DescribeDirectConnectGatewayAttachmentsCommand} */ - public describeDirectConnectGatewayAttachments( + describeDirectConnectGatewayAttachments( args: DescribeDirectConnectGatewayAttachmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDirectConnectGatewayAttachments( + describeDirectConnectGatewayAttachments( args: DescribeDirectConnectGatewayAttachmentsCommandInput, cb: (err: any, data?: DescribeDirectConnectGatewayAttachmentsCommandOutput) => void ): void; - public describeDirectConnectGatewayAttachments( + describeDirectConnectGatewayAttachments( args: DescribeDirectConnectGatewayAttachmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDirectConnectGatewayAttachmentsCommandOutput) => void ): void; - public describeDirectConnectGatewayAttachments( - args: DescribeDirectConnectGatewayAttachmentsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeDirectConnectGatewayAttachmentsCommandOutput) => void), - cb?: (err: any, data?: DescribeDirectConnectGatewayAttachmentsCommandOutput) => void - ): Promise | void { - const command = new DescribeDirectConnectGatewayAttachmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned.

+ * @see {@link DescribeDirectConnectGatewaysCommand} */ - public describeDirectConnectGateways( + describeDirectConnectGateways( args: DescribeDirectConnectGatewaysCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDirectConnectGateways( + describeDirectConnectGateways( args: DescribeDirectConnectGatewaysCommandInput, cb: (err: any, data?: DescribeDirectConnectGatewaysCommandOutput) => void ): void; - public describeDirectConnectGateways( + describeDirectConnectGateways( args: DescribeDirectConnectGatewaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDirectConnectGatewaysCommandOutput) => void ): void; - public describeDirectConnectGateways( - args: DescribeDirectConnectGatewaysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDirectConnectGatewaysCommandOutput) => void), - cb?: (err: any, data?: DescribeDirectConnectGatewaysCommandOutput) => void - ): Promise | void { - const command = new DescribeDirectConnectGatewaysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the hosted connections that have been provisioned on the specified - * interconnect or link aggregation group (LAG).

- * - *

Intended for use by Direct Connect Partners only.

- *
+ * @see {@link DescribeHostedConnectionsCommand} */ - public describeHostedConnections( + describeHostedConnections( args: DescribeHostedConnectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeHostedConnections( + describeHostedConnections( args: DescribeHostedConnectionsCommandInput, cb: (err: any, data?: DescribeHostedConnectionsCommandOutput) => void ): void; - public describeHostedConnections( + describeHostedConnections( args: DescribeHostedConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHostedConnectionsCommandOutput) => void ): void; - public describeHostedConnections( - args: DescribeHostedConnectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeHostedConnectionsCommandOutput) => void), - cb?: (err: any, data?: DescribeHostedConnectionsCommandOutput) => void - ): Promise | void { - const command = new DescribeHostedConnectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Deprecated. Use DescribeLoa instead.

- *

Gets the LOA-CFA for the specified interconnect.

- *

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility. - * For more information, see Requesting Cross Connects at Direct Connect Locations - * in the Direct Connect User Guide.

+ * @see {@link DescribeInterconnectLoaCommand} */ - public describeInterconnectLoa( + describeInterconnectLoa( args: DescribeInterconnectLoaCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInterconnectLoa( + describeInterconnectLoa( args: DescribeInterconnectLoaCommandInput, cb: (err: any, data?: DescribeInterconnectLoaCommandOutput) => void ): void; - public describeInterconnectLoa( + describeInterconnectLoa( args: DescribeInterconnectLoaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInterconnectLoaCommandOutput) => void ): void; - public describeInterconnectLoa( - args: DescribeInterconnectLoaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInterconnectLoaCommandOutput) => void), - cb?: (err: any, data?: DescribeInterconnectLoaCommandOutput) => void - ): Promise | void { - const command = new DescribeInterconnectLoaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect.

+ * @see {@link DescribeInterconnectsCommand} */ - public describeInterconnects( + describeInterconnects( args: DescribeInterconnectsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInterconnects( + describeInterconnects( args: DescribeInterconnectsCommandInput, cb: (err: any, data?: DescribeInterconnectsCommandOutput) => void ): void; - public describeInterconnects( + describeInterconnects( args: DescribeInterconnectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInterconnectsCommandOutput) => void ): void; - public describeInterconnects( - args: DescribeInterconnectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInterconnectsCommandOutput) => void), - cb?: (err: any, data?: DescribeInterconnectsCommandOutput) => void - ): Promise | void { - const command = new DescribeInterconnectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes all your link aggregation groups (LAG) or the specified LAG.

+ * @see {@link DescribeLagsCommand} */ - public describeLags( - args: DescribeLagsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeLags(args: DescribeLagsCommandInput, cb: (err: any, data?: DescribeLagsCommandOutput) => void): void; - public describeLags( + describeLags(args: DescribeLagsCommandInput, options?: __HttpHandlerOptions): Promise; + describeLags(args: DescribeLagsCommandInput, cb: (err: any, data?: DescribeLagsCommandOutput) => void): void; + describeLags( args: DescribeLagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLagsCommandOutput) => void ): void; - public describeLags( - args: DescribeLagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLagsCommandOutput) => void), - cb?: (err: any, data?: DescribeLagsCommandOutput) => void - ): Promise | void { - const command = new DescribeLagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).

- *

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing - * your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations - * in the Direct Connect User Guide.

+ * @see {@link DescribeLoaCommand} */ - public describeLoa(args: DescribeLoaCommandInput, options?: __HttpHandlerOptions): Promise; - public describeLoa(args: DescribeLoaCommandInput, cb: (err: any, data?: DescribeLoaCommandOutput) => void): void; - public describeLoa( + describeLoa(args: DescribeLoaCommandInput, options?: __HttpHandlerOptions): Promise; + describeLoa(args: DescribeLoaCommandInput, cb: (err: any, data?: DescribeLoaCommandOutput) => void): void; + describeLoa( args: DescribeLoaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLoaCommandOutput) => void ): void; - public describeLoa( - args: DescribeLoaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLoaCommandOutput) => void), - cb?: (err: any, data?: DescribeLoaCommandOutput) => void - ): Promise | void { - const command = new DescribeLoaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the Direct Connect locations in the current Amazon Web Services Region. These are the locations that can be selected when calling - * CreateConnection or CreateInterconnect.

+ * @see {@link DescribeLocationsCommand} */ - public describeLocations( + describeLocations( args: DescribeLocationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLocations( + describeLocations( args: DescribeLocationsCommandInput, cb: (err: any, data?: DescribeLocationsCommandOutput) => void ): void; - public describeLocations( + describeLocations( args: DescribeLocationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocationsCommandOutput) => void ): void; - public describeLocations( - args: DescribeLocationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLocationsCommandOutput) => void), - cb?: (err: any, data?: DescribeLocationsCommandOutput) => void - ): Promise | void { - const command = new DescribeLocationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Details about the router. - *

+ * @see {@link DescribeRouterConfigurationCommand} */ - public describeRouterConfiguration( + describeRouterConfiguration( args: DescribeRouterConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRouterConfiguration( + describeRouterConfiguration( args: DescribeRouterConfigurationCommandInput, cb: (err: any, data?: DescribeRouterConfigurationCommandOutput) => void ): void; - public describeRouterConfiguration( + describeRouterConfiguration( args: DescribeRouterConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRouterConfigurationCommandOutput) => void ): void; - public describeRouterConfiguration( - args: DescribeRouterConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRouterConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeRouterConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeRouterConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the tags associated with the specified Direct Connect resources.

+ * @see {@link DescribeTagsCommand} */ - public describeTags( - args: DescribeTagsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeTags(args: DescribeTagsCommandInput, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void; - public describeTags( + describeTags(args: DescribeTagsCommandInput, options?: __HttpHandlerOptions): Promise; + describeTags(args: DescribeTagsCommandInput, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void; + describeTags( args: DescribeTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTagsCommandOutput) => void ): void; - public describeTags( - args: DescribeTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTagsCommandOutput) => void), - cb?: (err: any, data?: DescribeTagsCommandOutput) => void - ): Promise | void { - const command = new DescribeTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the virtual private gateways owned by the Amazon Web Services account.

- *

You can create one or more Direct Connect private virtual interfaces linked to a virtual private gateway.

+ * @see {@link DescribeVirtualGatewaysCommand} */ - public describeVirtualGateways( + describeVirtualGateways( args: DescribeVirtualGatewaysCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVirtualGateways( + describeVirtualGateways( args: DescribeVirtualGatewaysCommandInput, cb: (err: any, data?: DescribeVirtualGatewaysCommandOutput) => void ): void; - public describeVirtualGateways( + describeVirtualGateways( args: DescribeVirtualGatewaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVirtualGatewaysCommandOutput) => void ): void; - public describeVirtualGateways( - args: DescribeVirtualGatewaysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVirtualGatewaysCommandOutput) => void), - cb?: (err: any, data?: DescribeVirtualGatewaysCommandOutput) => void - ): Promise | void { - const command = new DescribeVirtualGatewaysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays all virtual interfaces for an Amazon Web Services account. Virtual interfaces deleted fewer - * than 15 minutes before you make the request are also returned. If you specify a - * connection ID, only the virtual interfaces associated with the connection are returned. - * If you specify a virtual interface ID, then only a single virtual interface is returned.

- *

A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer network.

+ * @see {@link DescribeVirtualInterfacesCommand} */ - public describeVirtualInterfaces( + describeVirtualInterfaces( args: DescribeVirtualInterfacesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVirtualInterfaces( + describeVirtualInterfaces( args: DescribeVirtualInterfacesCommandInput, cb: (err: any, data?: DescribeVirtualInterfacesCommandOutput) => void ): void; - public describeVirtualInterfaces( + describeVirtualInterfaces( args: DescribeVirtualInterfacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVirtualInterfacesCommandOutput) => void ): void; - public describeVirtualInterfaces( - args: DescribeVirtualInterfacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVirtualInterfacesCommandOutput) => void), - cb?: (err: any, data?: DescribeVirtualInterfacesCommandOutput) => void - ): Promise | void { - const command = new DescribeVirtualInterfacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates a connection from a link aggregation group (LAG). The connection is - * interrupted and re-established as a standalone connection (the connection is not - * deleted; to delete the connection, use the DeleteConnection request). - * If the LAG has associated virtual interfaces or hosted connections, they remain - * associated with the LAG. A disassociated connection owned by an Direct Connect Partner is - * automatically converted to an interconnect.

- *

If disassociating the connection would cause the LAG to fall below its setting for - * minimum number of operational connections, the request fails, except when it's the last - * member of the LAG. If all connections are disassociated, the LAG continues to exist as - * an empty LAG with no physical connections.

+ * @see {@link DisassociateConnectionFromLagCommand} */ - public disassociateConnectionFromLag( + disassociateConnectionFromLag( args: DisassociateConnectionFromLagCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateConnectionFromLag( + disassociateConnectionFromLag( args: DisassociateConnectionFromLagCommandInput, cb: (err: any, data?: DisassociateConnectionFromLagCommandOutput) => void ): void; - public disassociateConnectionFromLag( + disassociateConnectionFromLag( args: DisassociateConnectionFromLagCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateConnectionFromLagCommandOutput) => void ): void; - public disassociateConnectionFromLag( - args: DisassociateConnectionFromLagCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateConnectionFromLagCommandOutput) => void), - cb?: (err: any, data?: DisassociateConnectionFromLagCommandOutput) => void - ): Promise | void { - const command = new DisassociateConnectionFromLagCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the association between a MAC Security (MACsec) security key and an Direct Connect dedicated connection.

+ * @see {@link DisassociateMacSecKeyCommand} */ - public disassociateMacSecKey( + disassociateMacSecKey( args: DisassociateMacSecKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateMacSecKey( + disassociateMacSecKey( args: DisassociateMacSecKeyCommandInput, cb: (err: any, data?: DisassociateMacSecKeyCommandOutput) => void ): void; - public disassociateMacSecKey( + disassociateMacSecKey( args: DisassociateMacSecKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateMacSecKeyCommandOutput) => void ): void; - public disassociateMacSecKey( - args: DisassociateMacSecKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateMacSecKeyCommandOutput) => void), - cb?: (err: any, data?: DisassociateMacSecKeyCommandOutput) => void - ): Promise | void { - const command = new DisassociateMacSecKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the virtual interface failover test history.

+ * @see {@link ListVirtualInterfaceTestHistoryCommand} */ - public listVirtualInterfaceTestHistory( + listVirtualInterfaceTestHistory( args: ListVirtualInterfaceTestHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVirtualInterfaceTestHistory( + listVirtualInterfaceTestHistory( args: ListVirtualInterfaceTestHistoryCommandInput, cb: (err: any, data?: ListVirtualInterfaceTestHistoryCommandOutput) => void ): void; - public listVirtualInterfaceTestHistory( + listVirtualInterfaceTestHistory( args: ListVirtualInterfaceTestHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVirtualInterfaceTestHistoryCommandOutput) => void ): void; - public listVirtualInterfaceTestHistory( - args: ListVirtualInterfaceTestHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVirtualInterfaceTestHistoryCommandOutput) => void), - cb?: (err: any, data?: ListVirtualInterfaceTestHistoryCommandOutput) => void - ): Promise | void { - const command = new ListVirtualInterfaceTestHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts the virtual interface failover test that verifies your configuration meets your resiliency requirements by placing the BGP peering session in the DOWN state. You can then send traffic to verify that there are no outages.

- *

You can run the test on public, private, transit, and hosted virtual interfaces.

- *

You can use ListVirtualInterfaceTestHistory to view the virtual interface test history.

- *

If you need to stop the test before the test interval completes, use StopBgpFailoverTest.

+ * @see {@link StartBgpFailoverTestCommand} */ - public startBgpFailoverTest( + startBgpFailoverTest( args: StartBgpFailoverTestCommandInput, options?: __HttpHandlerOptions ): Promise; - public startBgpFailoverTest( + startBgpFailoverTest( args: StartBgpFailoverTestCommandInput, cb: (err: any, data?: StartBgpFailoverTestCommandOutput) => void ): void; - public startBgpFailoverTest( + startBgpFailoverTest( args: StartBgpFailoverTestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartBgpFailoverTestCommandOutput) => void ): void; - public startBgpFailoverTest( - args: StartBgpFailoverTestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartBgpFailoverTestCommandOutput) => void), - cb?: (err: any, data?: StartBgpFailoverTestCommandOutput) => void - ): Promise | void { - const command = new StartBgpFailoverTestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops the virtual interface failover test.

+ * @see {@link StopBgpFailoverTestCommand} */ - public stopBgpFailoverTest( + stopBgpFailoverTest( args: StopBgpFailoverTestCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopBgpFailoverTest( + stopBgpFailoverTest( args: StopBgpFailoverTestCommandInput, cb: (err: any, data?: StopBgpFailoverTestCommandOutput) => void ): void; - public stopBgpFailoverTest( + stopBgpFailoverTest( args: StopBgpFailoverTestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopBgpFailoverTestCommandOutput) => void ): void; - public stopBgpFailoverTest( - args: StopBgpFailoverTestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopBgpFailoverTestCommandOutput) => void), - cb?: (err: any, data?: StopBgpFailoverTestCommandOutput) => void - ): Promise | void { - const command = new StopBgpFailoverTestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds the specified tags to the specified Direct Connect resource. Each resource can have a maximum of 50 tags.

- *

Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from the specified Direct Connect resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the Direct Connect dedicated connection configuration.

- *

You can update the following parameters for a connection:

- *
    - *
  • - *

    The connection name

    - *
  • - *
  • - *

    The connection's MAC Security (MACsec) encryption mode.

    - *
  • - *
+ * @see {@link UpdateConnectionCommand} */ - public updateConnection( + updateConnection( args: UpdateConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConnection( + updateConnection( args: UpdateConnectionCommandInput, cb: (err: any, data?: UpdateConnectionCommandOutput) => void ): void; - public updateConnection( + updateConnection( args: UpdateConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectionCommandOutput) => void ): void; - public updateConnection( - args: UpdateConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConnectionCommandOutput) => void), - cb?: (err: any, data?: UpdateConnectionCommandOutput) => void - ): Promise | void { - const command = new UpdateConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the name of a current Direct Connect gateway.

+ * @see {@link UpdateDirectConnectGatewayCommand} */ - public updateDirectConnectGateway( + updateDirectConnectGateway( args: UpdateDirectConnectGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDirectConnectGateway( + updateDirectConnectGateway( args: UpdateDirectConnectGatewayCommandInput, cb: (err: any, data?: UpdateDirectConnectGatewayCommandOutput) => void ): void; - public updateDirectConnectGateway( + updateDirectConnectGateway( args: UpdateDirectConnectGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDirectConnectGatewayCommandOutput) => void ): void; - public updateDirectConnectGateway( - args: UpdateDirectConnectGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDirectConnectGatewayCommandOutput) => void), - cb?: (err: any, data?: UpdateDirectConnectGatewayCommandOutput) => void - ): Promise | void { - const command = new UpdateDirectConnectGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified attributes of the Direct Connect gateway association.

- *

Add or remove prefixes from the association.

+ * @see {@link UpdateDirectConnectGatewayAssociationCommand} */ - public updateDirectConnectGatewayAssociation( + updateDirectConnectGatewayAssociation( args: UpdateDirectConnectGatewayAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDirectConnectGatewayAssociation( + updateDirectConnectGatewayAssociation( args: UpdateDirectConnectGatewayAssociationCommandInput, cb: (err: any, data?: UpdateDirectConnectGatewayAssociationCommandOutput) => void ): void; - public updateDirectConnectGatewayAssociation( + updateDirectConnectGatewayAssociation( args: UpdateDirectConnectGatewayAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDirectConnectGatewayAssociationCommandOutput) => void ): void; - public updateDirectConnectGatewayAssociation( - args: UpdateDirectConnectGatewayAssociationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateDirectConnectGatewayAssociationCommandOutput) => void), - cb?: (err: any, data?: UpdateDirectConnectGatewayAssociationCommandOutput) => void - ): Promise | void { - const command = new UpdateDirectConnectGatewayAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the attributes of the specified link aggregation group (LAG).

- *

You can update the following LAG attributes:

- *
    - *
  • - *

    The name of the LAG.

    - *
  • - *
  • - *

    The value for the minimum number of connections that must be operational - * for the LAG itself to be operational.

    - *
  • - *
  • - *

    The LAG's MACsec encryption mode.

    - *

    Amazon Web Services assigns this value to each connection which is part of the LAG.

    - *
  • - *
  • - *

    The tags

    - *
  • - *
- * - *

If you adjust the threshold value for the minimum number of operational connections, ensure - * that the new value does not cause the LAG to fall below the threshold and become - * non-operational.

- *
+ * @see {@link UpdateLagCommand} */ - public updateLag(args: UpdateLagCommandInput, options?: __HttpHandlerOptions): Promise; - public updateLag(args: UpdateLagCommandInput, cb: (err: any, data?: UpdateLagCommandOutput) => void): void; - public updateLag( + updateLag(args: UpdateLagCommandInput, options?: __HttpHandlerOptions): Promise; + updateLag(args: UpdateLagCommandInput, cb: (err: any, data?: UpdateLagCommandOutput) => void): void; + updateLag( args: UpdateLagCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLagCommandOutput) => void ): void; - public updateLag( - args: UpdateLagCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLagCommandOutput) => void), - cb?: (err: any, data?: UpdateLagCommandOutput) => void - ): Promise | void { - const command = new UpdateLagCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified attributes of the specified virtual private interface.

- *

Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to - * the underlying physical connection if it wasn't updated to support jumbo frames. Updating - * the connection disrupts network connectivity for all virtual interfaces associated with - * the connection for up to 30 seconds. To check whether your connection supports jumbo - * frames, call DescribeConnections. To check whether your virtual q - * interface supports jumbo frames, call DescribeVirtualInterfaces.

+ * @see {@link UpdateVirtualInterfaceAttributesCommand} */ - public updateVirtualInterfaceAttributes( + updateVirtualInterfaceAttributes( args: UpdateVirtualInterfaceAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVirtualInterfaceAttributes( + updateVirtualInterfaceAttributes( args: UpdateVirtualInterfaceAttributesCommandInput, cb: (err: any, data?: UpdateVirtualInterfaceAttributesCommandOutput) => void ): void; - public updateVirtualInterfaceAttributes( + updateVirtualInterfaceAttributes( args: UpdateVirtualInterfaceAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVirtualInterfaceAttributesCommandOutput) => void ): void; - public updateVirtualInterfaceAttributes( - args: UpdateVirtualInterfaceAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVirtualInterfaceAttributesCommandOutput) => void), - cb?: (err: any, data?: UpdateVirtualInterfaceAttributesCommandOutput) => void - ): Promise | void { - const command = new UpdateVirtualInterfaceAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. + * One end of the cable is connected to your router, the other to an Direct Connect router. With this connection + * in place, you can create virtual interfaces directly to the Amazon Web Services Cloud (for example, to Amazon EC2 + * and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A + * connection provides access to all Amazon Web Services Regions except the China (Beijing) and (China) Ningxia Regions. + * Amazon Web Services resources in the China Regions can only be accessed through locations associated with those Regions.

+ */ +export class DirectConnect extends DirectConnectClient implements DirectConnect {} +createAggregatedClient(commands, DirectConnect); diff --git a/clients/client-directory-service/src/DirectoryService.ts b/clients/client-directory-service/src/DirectoryService.ts index 240023af82fb..933a62bdde01 100644 --- a/clients/client-directory-service/src/DirectoryService.ts +++ b/clients/client-directory-service/src/DirectoryService.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -296,2290 +297,1109 @@ import { } from "./commands/UpdateSettingsCommand"; import { UpdateTrustCommand, UpdateTrustCommandInput, UpdateTrustCommandOutput } from "./commands/UpdateTrustCommand"; import { VerifyTrustCommand, VerifyTrustCommandInput, VerifyTrustCommandOutput } from "./commands/VerifyTrustCommand"; -import { DirectoryServiceClient } from "./DirectoryServiceClient"; +import { DirectoryServiceClient, DirectoryServiceClientConfig } from "./DirectoryServiceClient"; -/** - * @public - * Directory Service - *

Directory Service is a web service that makes it easy for you to setup and run directories in the - * Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active - * Directory. This guide provides detailed information about Directory Service operations, data types, - * parameters, and errors. For information about Directory Services features, see Directory Service and the Directory Service - * Administration Guide.

- * - *

Amazon Web Services provides SDKs that consist of libraries and sample code for various - * programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs - * provide a convenient way to create programmatic access to Directory Service and other Amazon Web Services - * services. For more information about the Amazon Web Services SDKs, including how to download and - * install them, see Tools for Amazon Web - * Services.

- *
- */ -export class DirectoryService extends DirectoryServiceClient { +const commands = { + AcceptSharedDirectoryCommand, + AddIpRoutesCommand, + AddRegionCommand, + AddTagsToResourceCommand, + CancelSchemaExtensionCommand, + ConnectDirectoryCommand, + CreateAliasCommand, + CreateComputerCommand, + CreateConditionalForwarderCommand, + CreateDirectoryCommand, + CreateLogSubscriptionCommand, + CreateMicrosoftADCommand, + CreateSnapshotCommand, + CreateTrustCommand, + DeleteConditionalForwarderCommand, + DeleteDirectoryCommand, + DeleteLogSubscriptionCommand, + DeleteSnapshotCommand, + DeleteTrustCommand, + DeregisterCertificateCommand, + DeregisterEventTopicCommand, + DescribeCertificateCommand, + DescribeClientAuthenticationSettingsCommand, + DescribeConditionalForwardersCommand, + DescribeDirectoriesCommand, + DescribeDomainControllersCommand, + DescribeEventTopicsCommand, + DescribeLDAPSSettingsCommand, + DescribeRegionsCommand, + DescribeSettingsCommand, + DescribeSharedDirectoriesCommand, + DescribeSnapshotsCommand, + DescribeTrustsCommand, + DescribeUpdateDirectoryCommand, + DisableClientAuthenticationCommand, + DisableLDAPSCommand, + DisableRadiusCommand, + DisableSsoCommand, + EnableClientAuthenticationCommand, + EnableLDAPSCommand, + EnableRadiusCommand, + EnableSsoCommand, + GetDirectoryLimitsCommand, + GetSnapshotLimitsCommand, + ListCertificatesCommand, + ListIpRoutesCommand, + ListLogSubscriptionsCommand, + ListSchemaExtensionsCommand, + ListTagsForResourceCommand, + RegisterCertificateCommand, + RegisterEventTopicCommand, + RejectSharedDirectoryCommand, + RemoveIpRoutesCommand, + RemoveRegionCommand, + RemoveTagsFromResourceCommand, + ResetUserPasswordCommand, + RestoreFromSnapshotCommand, + ShareDirectoryCommand, + StartSchemaExtensionCommand, + UnshareDirectoryCommand, + UpdateConditionalForwarderCommand, + UpdateDirectorySetupCommand, + UpdateNumberOfDomainControllersCommand, + UpdateRadiusCommand, + UpdateSettingsCommand, + UpdateTrustCommand, + VerifyTrustCommand, +}; + +export interface DirectoryService { /** - * @public - *

Accepts a directory sharing request that was sent from the directory owner account.

+ * @see {@link AcceptSharedDirectoryCommand} */ - public acceptSharedDirectory( + acceptSharedDirectory( args: AcceptSharedDirectoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptSharedDirectory( + acceptSharedDirectory( args: AcceptSharedDirectoryCommandInput, cb: (err: any, data?: AcceptSharedDirectoryCommandOutput) => void ): void; - public acceptSharedDirectory( + acceptSharedDirectory( args: AcceptSharedDirectoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptSharedDirectoryCommandOutput) => void ): void; - public acceptSharedDirectory( - args: AcceptSharedDirectoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptSharedDirectoryCommandOutput) => void), - cb?: (err: any, data?: AcceptSharedDirectoryCommandOutput) => void - ): Promise | void { - const command = new AcceptSharedDirectoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

If the DNS server for your self-managed domain uses a publicly addressable IP address, - * you must add a CIDR address block to correctly route traffic to and from your Microsoft AD - * on Amazon Web Services. AddIpRoutes adds this address block. You can - * also use AddIpRoutes to facilitate routing traffic that uses public IP - * ranges from your Microsoft AD on Amazon Web Services to a peer VPC.

- *

Before you call AddIpRoutes, ensure that all of the required - * permissions have been explicitly granted through a policy. For details about what - * permissions are required to run the AddIpRoutes operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.

- */ - public addIpRoutes(args: AddIpRoutesCommandInput, options?: __HttpHandlerOptions): Promise; - public addIpRoutes(args: AddIpRoutesCommandInput, cb: (err: any, data?: AddIpRoutesCommandOutput) => void): void; - public addIpRoutes( + + /** + * @see {@link AddIpRoutesCommand} + */ + addIpRoutes(args: AddIpRoutesCommandInput, options?: __HttpHandlerOptions): Promise; + addIpRoutes(args: AddIpRoutesCommandInput, cb: (err: any, data?: AddIpRoutesCommandOutput) => void): void; + addIpRoutes( args: AddIpRoutesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddIpRoutesCommandOutput) => void ): void; - public addIpRoutes( - args: AddIpRoutesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddIpRoutesCommandOutput) => void), - cb?: (err: any, data?: AddIpRoutesCommandOutput) => void - ): Promise | void { - const command = new AddIpRoutesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds two domain controllers in the specified Region for the specified directory.

- */ - public addRegion(args: AddRegionCommandInput, options?: __HttpHandlerOptions): Promise; - public addRegion(args: AddRegionCommandInput, cb: (err: any, data?: AddRegionCommandOutput) => void): void; - public addRegion( + + /** + * @see {@link AddRegionCommand} + */ + addRegion(args: AddRegionCommandInput, options?: __HttpHandlerOptions): Promise; + addRegion(args: AddRegionCommandInput, cb: (err: any, data?: AddRegionCommandOutput) => void): void; + addRegion( args: AddRegionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddRegionCommandOutput) => void ): void; - public addRegion( - args: AddRegionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddRegionCommandOutput) => void), - cb?: (err: any, data?: AddRegionCommandOutput) => void - ): Promise | void { - const command = new AddRegionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds or overwrites one or more tags for the specified directory. Each directory can - * have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be - * unique to each resource.

- */ - public addTagsToResource( + + /** + * @see {@link AddTagsToResourceCommand} + */ + addTagsToResource( args: AddTagsToResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public addTagsToResource( + addTagsToResource( args: AddTagsToResourceCommandInput, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void ): void; - public addTagsToResource( + addTagsToResource( args: AddTagsToResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void ): void; - public addTagsToResource( - args: AddTagsToResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddTagsToResourceCommandOutput) => void), - cb?: (err: any, data?: AddTagsToResourceCommandOutput) => void - ): Promise | void { - const command = new AddTagsToResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema - * extension has started replicating to all domain controllers, the task can no longer be - * canceled. A schema extension can be canceled during any of the following states; - * Initializing, CreatingSnapshot, and - * UpdatingSchema.

- */ - public cancelSchemaExtension( + + /** + * @see {@link CancelSchemaExtensionCommand} + */ + cancelSchemaExtension( args: CancelSchemaExtensionCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelSchemaExtension( + cancelSchemaExtension( args: CancelSchemaExtensionCommandInput, cb: (err: any, data?: CancelSchemaExtensionCommandOutput) => void ): void; - public cancelSchemaExtension( + cancelSchemaExtension( args: CancelSchemaExtensionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelSchemaExtensionCommandOutput) => void ): void; - public cancelSchemaExtension( - args: CancelSchemaExtensionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelSchemaExtensionCommandOutput) => void), - cb?: (err: any, data?: CancelSchemaExtensionCommandOutput) => void - ): Promise | void { - const command = new CancelSchemaExtensionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an AD Connector to connect to a self-managed directory.

- *

Before you call ConnectDirectory, ensure that all of the required permissions - * have been explicitly granted through a policy. For details about what permissions are required - * to run the ConnectDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions - * Reference.

- */ - public connectDirectory( + + /** + * @see {@link ConnectDirectoryCommand} + */ + connectDirectory( args: ConnectDirectoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public connectDirectory( + connectDirectory( args: ConnectDirectoryCommandInput, cb: (err: any, data?: ConnectDirectoryCommandOutput) => void ): void; - public connectDirectory( + connectDirectory( args: ConnectDirectoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConnectDirectoryCommandOutput) => void ): void; - public connectDirectory( - args: ConnectDirectoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConnectDirectoryCommandOutput) => void), - cb?: (err: any, data?: ConnectDirectoryCommandOutput) => void - ): Promise | void { - const command = new ConnectDirectoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an alias for a directory and assigns the alias to the directory. The alias is used - * to construct the access URL for the directory, such as - * http://.awsapps.com.

- * - *

After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.

- *
- */ - public createAlias(args: CreateAliasCommandInput, options?: __HttpHandlerOptions): Promise; - public createAlias(args: CreateAliasCommandInput, cb: (err: any, data?: CreateAliasCommandOutput) => void): void; - public createAlias( + + /** + * @see {@link CreateAliasCommand} + */ + createAlias(args: CreateAliasCommandInput, options?: __HttpHandlerOptions): Promise; + createAlias(args: CreateAliasCommandInput, cb: (err: any, data?: CreateAliasCommandOutput) => void): void; + createAlias( args: CreateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAliasCommandOutput) => void ): void; - public createAlias( - args: CreateAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAliasCommandOutput) => void), - cb?: (err: any, data?: CreateAliasCommandOutput) => void - ): Promise | void { - const command = new CreateAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Active Directory computer object in the specified directory.

- */ - public createComputer( + + /** + * @see {@link CreateComputerCommand} + */ + createComputer( args: CreateComputerCommandInput, options?: __HttpHandlerOptions ): Promise; - public createComputer( - args: CreateComputerCommandInput, - cb: (err: any, data?: CreateComputerCommandOutput) => void - ): void; - public createComputer( + createComputer(args: CreateComputerCommandInput, cb: (err: any, data?: CreateComputerCommandOutput) => void): void; + createComputer( args: CreateComputerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateComputerCommandOutput) => void ): void; - public createComputer( - args: CreateComputerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateComputerCommandOutput) => void), - cb?: (err: any, data?: CreateComputerCommandOutput) => void - ): Promise | void { - const command = new CreateComputerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a conditional forwarder associated with your Amazon Web Services directory. Conditional - * forwarders are required in order to set up a trust relationship with another domain. The - * conditional forwarder points to the trusted domain.

- */ - public createConditionalForwarder( + + /** + * @see {@link CreateConditionalForwarderCommand} + */ + createConditionalForwarder( args: CreateConditionalForwarderCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConditionalForwarder( + createConditionalForwarder( args: CreateConditionalForwarderCommandInput, cb: (err: any, data?: CreateConditionalForwarderCommandOutput) => void ): void; - public createConditionalForwarder( + createConditionalForwarder( args: CreateConditionalForwarderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConditionalForwarderCommandOutput) => void ): void; - public createConditionalForwarder( - args: CreateConditionalForwarderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConditionalForwarderCommandOutput) => void), - cb?: (err: any, data?: CreateConditionalForwarderCommandOutput) => void - ): Promise | void { - const command = new CreateConditionalForwarderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Simple AD directory. For more information, see Simple Active Directory in the Directory Service Admin - * Guide.

- *

Before you call CreateDirectory, ensure that all of the required permissions - * have been explicitly granted through a policy. For details about what permissions are required - * to run the CreateDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions - * Reference.

- */ - public createDirectory( + + /** + * @see {@link CreateDirectoryCommand} + */ + createDirectory( args: CreateDirectoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDirectory( - args: CreateDirectoryCommandInput, - cb: (err: any, data?: CreateDirectoryCommandOutput) => void - ): void; - public createDirectory( + createDirectory(args: CreateDirectoryCommandInput, cb: (err: any, data?: CreateDirectoryCommandOutput) => void): void; + createDirectory( args: CreateDirectoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDirectoryCommandOutput) => void ): void; - public createDirectory( - args: CreateDirectoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDirectoryCommandOutput) => void), - cb?: (err: any, data?: CreateDirectoryCommandOutput) => void - ): Promise | void { - const command = new CreateDirectoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a subscription to forward real-time Directory Service domain controller security - * logs to the specified Amazon CloudWatch log group in your Amazon Web Services account.

- */ - public createLogSubscription( + + /** + * @see {@link CreateLogSubscriptionCommand} + */ + createLogSubscription( args: CreateLogSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLogSubscription( + createLogSubscription( args: CreateLogSubscriptionCommandInput, cb: (err: any, data?: CreateLogSubscriptionCommandOutput) => void ): void; - public createLogSubscription( + createLogSubscription( args: CreateLogSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLogSubscriptionCommandOutput) => void ): void; - public createLogSubscription( - args: CreateLogSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLogSubscriptionCommandOutput) => void), - cb?: (err: any, data?: CreateLogSubscriptionCommandOutput) => void - ): Promise | void { - const command = new CreateLogSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft AD in the Directory Service Admin Guide.

- *

Before you call CreateMicrosoftAD, ensure that all of the required - * permissions have been explicitly granted through a policy. For details about what permissions - * are required to run the CreateMicrosoftAD operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.

- */ - public createMicrosoftAD( + + /** + * @see {@link CreateMicrosoftADCommand} + */ + createMicrosoftAD( args: CreateMicrosoftADCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMicrosoftAD( + createMicrosoftAD( args: CreateMicrosoftADCommandInput, cb: (err: any, data?: CreateMicrosoftADCommandOutput) => void ): void; - public createMicrosoftAD( + createMicrosoftAD( args: CreateMicrosoftADCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMicrosoftADCommandOutput) => void ): void; - public createMicrosoftAD( - args: CreateMicrosoftADCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMicrosoftADCommandOutput) => void), - cb?: (err: any, data?: CreateMicrosoftADCommandOutput) => void - ): Promise | void { - const command = new CreateMicrosoftADCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.

- * - *

You cannot take snapshots of AD Connector directories.

- *
- */ - public createSnapshot( + + /** + * @see {@link CreateSnapshotCommand} + */ + createSnapshot( args: CreateSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSnapshot( - args: CreateSnapshotCommandInput, - cb: (err: any, data?: CreateSnapshotCommandOutput) => void - ): void; - public createSnapshot( + createSnapshot(args: CreateSnapshotCommandInput, cb: (err: any, data?: CreateSnapshotCommandOutput) => void): void; + createSnapshot( args: CreateSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSnapshotCommandOutput) => void ): void; - public createSnapshot( - args: CreateSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSnapshotCommandOutput) => void), - cb?: (err: any, data?: CreateSnapshotCommandOutput) => void - ): Promise | void { - const command = new CreateSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Directory Service for Microsoft Active Directory allows you to configure trust relationships. For - * example, you can establish a trust between your Managed Microsoft AD directory, and your existing - * self-managed Microsoft Active Directory. This would allow you to provide users and groups - * access to resources in either domain, with a single set of credentials.

- *

This action initiates the creation of the Amazon Web Services side of a trust relationship between an - * Managed Microsoft AD directory and an external domain. You can create either a forest trust or an - * external trust.

- */ - public createTrust(args: CreateTrustCommandInput, options?: __HttpHandlerOptions): Promise; - public createTrust(args: CreateTrustCommandInput, cb: (err: any, data?: CreateTrustCommandOutput) => void): void; - public createTrust( + + /** + * @see {@link CreateTrustCommand} + */ + createTrust(args: CreateTrustCommandInput, options?: __HttpHandlerOptions): Promise; + createTrust(args: CreateTrustCommandInput, cb: (err: any, data?: CreateTrustCommandOutput) => void): void; + createTrust( args: CreateTrustCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTrustCommandOutput) => void ): void; - public createTrust( - args: CreateTrustCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTrustCommandOutput) => void), - cb?: (err: any, data?: CreateTrustCommandOutput) => void - ): Promise | void { - const command = new CreateTrustCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a conditional forwarder that has been set up for your Amazon Web Services - * directory.

- */ - public deleteConditionalForwarder( + + /** + * @see {@link DeleteConditionalForwarderCommand} + */ + deleteConditionalForwarder( args: DeleteConditionalForwarderCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConditionalForwarder( + deleteConditionalForwarder( args: DeleteConditionalForwarderCommandInput, cb: (err: any, data?: DeleteConditionalForwarderCommandOutput) => void ): void; - public deleteConditionalForwarder( + deleteConditionalForwarder( args: DeleteConditionalForwarderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConditionalForwarderCommandOutput) => void ): void; - public deleteConditionalForwarder( - args: DeleteConditionalForwarderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConditionalForwarderCommandOutput) => void), - cb?: (err: any, data?: DeleteConditionalForwarderCommandOutput) => void - ): Promise | void { - const command = new DeleteConditionalForwarderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an Directory Service directory.

- *

Before you call DeleteDirectory, ensure that all of the required permissions - * have been explicitly granted through a policy. For details about what permissions are required - * to run the DeleteDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions - * Reference.

- */ - public deleteDirectory( + + /** + * @see {@link DeleteDirectoryCommand} + */ + deleteDirectory( args: DeleteDirectoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDirectory( - args: DeleteDirectoryCommandInput, - cb: (err: any, data?: DeleteDirectoryCommandOutput) => void - ): void; - public deleteDirectory( + deleteDirectory(args: DeleteDirectoryCommandInput, cb: (err: any, data?: DeleteDirectoryCommandOutput) => void): void; + deleteDirectory( args: DeleteDirectoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDirectoryCommandOutput) => void ): void; - public deleteDirectory( - args: DeleteDirectoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDirectoryCommandOutput) => void), - cb?: (err: any, data?: DeleteDirectoryCommandOutput) => void - ): Promise | void { - const command = new DeleteDirectoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified log subscription.

- */ - public deleteLogSubscription( + + /** + * @see {@link DeleteLogSubscriptionCommand} + */ + deleteLogSubscription( args: DeleteLogSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLogSubscription( + deleteLogSubscription( args: DeleteLogSubscriptionCommandInput, cb: (err: any, data?: DeleteLogSubscriptionCommandOutput) => void ): void; - public deleteLogSubscription( + deleteLogSubscription( args: DeleteLogSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLogSubscriptionCommandOutput) => void ): void; - public deleteLogSubscription( - args: DeleteLogSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLogSubscriptionCommandOutput) => void), - cb?: (err: any, data?: DeleteLogSubscriptionCommandOutput) => void - ): Promise | void { - const command = new DeleteLogSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a directory snapshot.

- */ - public deleteSnapshot( + + /** + * @see {@link DeleteSnapshotCommand} + */ + deleteSnapshot( args: DeleteSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSnapshot( - args: DeleteSnapshotCommandInput, - cb: (err: any, data?: DeleteSnapshotCommandOutput) => void - ): void; - public deleteSnapshot( + deleteSnapshot(args: DeleteSnapshotCommandInput, cb: (err: any, data?: DeleteSnapshotCommandOutput) => void): void; + deleteSnapshot( args: DeleteSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSnapshotCommandOutput) => void ): void; - public deleteSnapshot( - args: DeleteSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSnapshotCommandOutput) => void), - cb?: (err: any, data?: DeleteSnapshotCommandOutput) => void - ): Promise | void { - const command = new DeleteSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an existing trust relationship between your Managed Microsoft AD directory and an external - * domain.

- */ - public deleteTrust(args: DeleteTrustCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteTrust(args: DeleteTrustCommandInput, cb: (err: any, data?: DeleteTrustCommandOutput) => void): void; - public deleteTrust( + + /** + * @see {@link DeleteTrustCommand} + */ + deleteTrust(args: DeleteTrustCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTrust(args: DeleteTrustCommandInput, cb: (err: any, data?: DeleteTrustCommandOutput) => void): void; + deleteTrust( args: DeleteTrustCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTrustCommandOutput) => void ): void; - public deleteTrust( - args: DeleteTrustCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTrustCommandOutput) => void), - cb?: (err: any, data?: DeleteTrustCommandOutput) => void - ): Promise | void { - const command = new DeleteTrustCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.

- */ - public deregisterCertificate( + + /** + * @see {@link DeregisterCertificateCommand} + */ + deregisterCertificate( args: DeregisterCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterCertificate( + deregisterCertificate( args: DeregisterCertificateCommandInput, cb: (err: any, data?: DeregisterCertificateCommandOutput) => void ): void; - public deregisterCertificate( + deregisterCertificate( args: DeregisterCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterCertificateCommandOutput) => void ): void; - public deregisterCertificate( - args: DeregisterCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterCertificateCommandOutput) => void), - cb?: (err: any, data?: DeregisterCertificateCommandOutput) => void - ): Promise | void { - const command = new DeregisterCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the specified directory as a publisher to the specified Amazon SNS topic.

- */ - public deregisterEventTopic( + + /** + * @see {@link DeregisterEventTopicCommand} + */ + deregisterEventTopic( args: DeregisterEventTopicCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterEventTopic( + deregisterEventTopic( args: DeregisterEventTopicCommandInput, cb: (err: any, data?: DeregisterEventTopicCommandOutput) => void ): void; - public deregisterEventTopic( + deregisterEventTopic( args: DeregisterEventTopicCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterEventTopicCommandOutput) => void ): void; - public deregisterEventTopic( - args: DeregisterEventTopicCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterEventTopicCommandOutput) => void), - cb?: (err: any, data?: DeregisterEventTopicCommandOutput) => void - ): Promise | void { - const command = new DeregisterEventTopicCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Displays information about the certificate registered for secure LDAP or client certificate authentication.

- */ - public describeCertificate( + + /** + * @see {@link DescribeCertificateCommand} + */ + describeCertificate( args: DescribeCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCertificate( + describeCertificate( args: DescribeCertificateCommandInput, cb: (err: any, data?: DescribeCertificateCommandOutput) => void ): void; - public describeCertificate( + describeCertificate( args: DescribeCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCertificateCommandOutput) => void ): void; - public describeCertificate( - args: DescribeCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCertificateCommandOutput) => void), - cb?: (err: any, data?: DescribeCertificateCommandOutput) => void - ): Promise | void { - const command = new DescribeCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about the type of client authentication for the specified directory, if the type is specified. If no type is specified, information about all client authentication types that are supported for the specified directory is retrieved. Currently, only SmartCard is supported. - *

- */ - public describeClientAuthenticationSettings( + + /** + * @see {@link DescribeClientAuthenticationSettingsCommand} + */ + describeClientAuthenticationSettings( args: DescribeClientAuthenticationSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClientAuthenticationSettings( + describeClientAuthenticationSettings( args: DescribeClientAuthenticationSettingsCommandInput, cb: (err: any, data?: DescribeClientAuthenticationSettingsCommandOutput) => void ): void; - public describeClientAuthenticationSettings( + describeClientAuthenticationSettings( args: DescribeClientAuthenticationSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClientAuthenticationSettingsCommandOutput) => void ): void; - public describeClientAuthenticationSettings( - args: DescribeClientAuthenticationSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClientAuthenticationSettingsCommandOutput) => void), - cb?: (err: any, data?: DescribeClientAuthenticationSettingsCommandOutput) => void - ): Promise | void { - const command = new DescribeClientAuthenticationSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Obtains information about the conditional forwarders for this account.

- *

If no input parameters are provided for RemoteDomainNames, this request describes all - * conditional forwarders for the specified directory ID.

- */ - public describeConditionalForwarders( + + /** + * @see {@link DescribeConditionalForwardersCommand} + */ + describeConditionalForwarders( args: DescribeConditionalForwardersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConditionalForwarders( + describeConditionalForwarders( args: DescribeConditionalForwardersCommandInput, cb: (err: any, data?: DescribeConditionalForwardersCommandOutput) => void ): void; - public describeConditionalForwarders( + describeConditionalForwarders( args: DescribeConditionalForwardersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConditionalForwardersCommandOutput) => void ): void; - public describeConditionalForwarders( - args: DescribeConditionalForwardersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConditionalForwardersCommandOutput) => void), - cb?: (err: any, data?: DescribeConditionalForwardersCommandOutput) => void - ): Promise | void { - const command = new DescribeConditionalForwardersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Obtains information about the directories that belong to this account.

- *

You can retrieve information about specific directories by passing the directory - * identifiers in the DirectoryIds parameter. Otherwise, all directories that belong - * to the current account are returned.

- *

This operation supports pagination with the use of the NextToken request and - * response parameters. If more results are available, the - * DescribeDirectoriesResult.NextToken member contains a token that you pass in - * the next call to DescribeDirectories to retrieve the next set of - * items.

- *

You can also specify a maximum number of return results with the Limit - * parameter.

- */ - public describeDirectories( + + /** + * @see {@link DescribeDirectoriesCommand} + */ + describeDirectories( args: DescribeDirectoriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDirectories( + describeDirectories( args: DescribeDirectoriesCommandInput, cb: (err: any, data?: DescribeDirectoriesCommandOutput) => void ): void; - public describeDirectories( + describeDirectories( args: DescribeDirectoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDirectoriesCommandOutput) => void ): void; - public describeDirectories( - args: DescribeDirectoriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDirectoriesCommandOutput) => void), - cb?: (err: any, data?: DescribeDirectoriesCommandOutput) => void - ): Promise | void { - const command = new DescribeDirectoriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides information about any domain controllers in your directory.

- */ - public describeDomainControllers( + + /** + * @see {@link DescribeDomainControllersCommand} + */ + describeDomainControllers( args: DescribeDomainControllersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDomainControllers( + describeDomainControllers( args: DescribeDomainControllersCommandInput, cb: (err: any, data?: DescribeDomainControllersCommandOutput) => void ): void; - public describeDomainControllers( + describeDomainControllers( args: DescribeDomainControllersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDomainControllersCommandOutput) => void ): void; - public describeDomainControllers( - args: DescribeDomainControllersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDomainControllersCommandOutput) => void), - cb?: (err: any, data?: DescribeDomainControllersCommandOutput) => void - ): Promise | void { - const command = new DescribeDomainControllersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Obtains information about which Amazon SNS topics receive status messages from the specified - * directory.

- *

If no input parameters are provided, such as DirectoryId or TopicName, this request - * describes all of the associations in the account.

- */ - public describeEventTopics( + + /** + * @see {@link DescribeEventTopicsCommand} + */ + describeEventTopics( args: DescribeEventTopicsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventTopics( + describeEventTopics( args: DescribeEventTopicsCommandInput, cb: (err: any, data?: DescribeEventTopicsCommandOutput) => void ): void; - public describeEventTopics( + describeEventTopics( args: DescribeEventTopicsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventTopicsCommandOutput) => void ): void; - public describeEventTopics( - args: DescribeEventTopicsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventTopicsCommandOutput) => void), - cb?: (err: any, data?: DescribeEventTopicsCommandOutput) => void - ): Promise | void { - const command = new DescribeEventTopicsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the status of LDAP security for the specified directory.

- */ - public describeLDAPSSettings( + + /** + * @see {@link DescribeLDAPSSettingsCommand} + */ + describeLDAPSSettings( args: DescribeLDAPSSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLDAPSSettings( + describeLDAPSSettings( args: DescribeLDAPSSettingsCommandInput, cb: (err: any, data?: DescribeLDAPSSettingsCommandOutput) => void ): void; - public describeLDAPSSettings( + describeLDAPSSettings( args: DescribeLDAPSSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLDAPSSettingsCommandOutput) => void ): void; - public describeLDAPSSettings( - args: DescribeLDAPSSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLDAPSSettingsCommandOutput) => void), - cb?: (err: any, data?: DescribeLDAPSSettingsCommandOutput) => void - ): Promise | void { - const command = new DescribeLDAPSSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides information about the Regions that are configured for multi-Region - * replication.

- */ - public describeRegions( + + /** + * @see {@link DescribeRegionsCommand} + */ + describeRegions( args: DescribeRegionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRegions( - args: DescribeRegionsCommandInput, - cb: (err: any, data?: DescribeRegionsCommandOutput) => void - ): void; - public describeRegions( + describeRegions(args: DescribeRegionsCommandInput, cb: (err: any, data?: DescribeRegionsCommandOutput) => void): void; + describeRegions( args: DescribeRegionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRegionsCommandOutput) => void ): void; - public describeRegions( - args: DescribeRegionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRegionsCommandOutput) => void), - cb?: (err: any, data?: DescribeRegionsCommandOutput) => void - ): Promise | void { - const command = new DescribeRegionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about the configurable settings for the specified directory.

- */ - public describeSettings( + + /** + * @see {@link DescribeSettingsCommand} + */ + describeSettings( args: DescribeSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSettings( + describeSettings( args: DescribeSettingsCommandInput, cb: (err: any, data?: DescribeSettingsCommandOutput) => void ): void; - public describeSettings( + describeSettings( args: DescribeSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSettingsCommandOutput) => void ): void; - public describeSettings( - args: DescribeSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSettingsCommandOutput) => void), - cb?: (err: any, data?: DescribeSettingsCommandOutput) => void - ): Promise | void { - const command = new DescribeSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the shared directories in your account.

- */ - public describeSharedDirectories( + + /** + * @see {@link DescribeSharedDirectoriesCommand} + */ + describeSharedDirectories( args: DescribeSharedDirectoriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSharedDirectories( + describeSharedDirectories( args: DescribeSharedDirectoriesCommandInput, cb: (err: any, data?: DescribeSharedDirectoriesCommandOutput) => void ): void; - public describeSharedDirectories( + describeSharedDirectories( args: DescribeSharedDirectoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSharedDirectoriesCommandOutput) => void ): void; - public describeSharedDirectories( - args: DescribeSharedDirectoriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSharedDirectoriesCommandOutput) => void), - cb?: (err: any, data?: DescribeSharedDirectoriesCommandOutput) => void - ): Promise | void { - const command = new DescribeSharedDirectoriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Obtains information about the directory snapshots that belong to this account.

- *

This operation supports pagination with the use of the NextToken request and - * response parameters. If more results are available, the DescribeSnapshots.NextToken - * member contains a token that you pass in the next call to DescribeSnapshots to - * retrieve the next set of items.

- *

You can also specify a maximum number of return results with the Limit - * parameter.

- */ - public describeSnapshots( + + /** + * @see {@link DescribeSnapshotsCommand} + */ + describeSnapshots( args: DescribeSnapshotsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSnapshots( + describeSnapshots( args: DescribeSnapshotsCommandInput, cb: (err: any, data?: DescribeSnapshotsCommandOutput) => void ): void; - public describeSnapshots( + describeSnapshots( args: DescribeSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSnapshotsCommandOutput) => void ): void; - public describeSnapshots( - args: DescribeSnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSnapshotsCommandOutput) => void), - cb?: (err: any, data?: DescribeSnapshotsCommandOutput) => void - ): Promise | void { - const command = new DescribeSnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Obtains information about the trust relationships for this account.

- *

If no input parameters are provided, such as DirectoryId or TrustIds, this request - * describes all the trust relationships belonging to the account.

- */ - public describeTrusts( + + /** + * @see {@link DescribeTrustsCommand} + */ + describeTrusts( args: DescribeTrustsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTrusts( - args: DescribeTrustsCommandInput, - cb: (err: any, data?: DescribeTrustsCommandOutput) => void - ): void; - public describeTrusts( + describeTrusts(args: DescribeTrustsCommandInput, cb: (err: any, data?: DescribeTrustsCommandOutput) => void): void; + describeTrusts( args: DescribeTrustsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrustsCommandOutput) => void ): void; - public describeTrusts( - args: DescribeTrustsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTrustsCommandOutput) => void), - cb?: (err: any, data?: DescribeTrustsCommandOutput) => void - ): Promise | void { - const command = new DescribeTrustsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Describes the updates of a directory for a particular update type. - *

- */ - public describeUpdateDirectory( + + /** + * @see {@link DescribeUpdateDirectoryCommand} + */ + describeUpdateDirectory( args: DescribeUpdateDirectoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeUpdateDirectory( + describeUpdateDirectory( args: DescribeUpdateDirectoryCommandInput, cb: (err: any, data?: DescribeUpdateDirectoryCommandOutput) => void ): void; - public describeUpdateDirectory( + describeUpdateDirectory( args: DescribeUpdateDirectoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUpdateDirectoryCommandOutput) => void ): void; - public describeUpdateDirectory( - args: DescribeUpdateDirectoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUpdateDirectoryCommandOutput) => void), - cb?: (err: any, data?: DescribeUpdateDirectoryCommandOutput) => void - ): Promise | void { - const command = new DescribeUpdateDirectoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables alternative client authentication methods for the specified directory.

- */ - public disableClientAuthentication( + + /** + * @see {@link DisableClientAuthenticationCommand} + */ + disableClientAuthentication( args: DisableClientAuthenticationCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableClientAuthentication( + disableClientAuthentication( args: DisableClientAuthenticationCommandInput, cb: (err: any, data?: DisableClientAuthenticationCommandOutput) => void ): void; - public disableClientAuthentication( + disableClientAuthentication( args: DisableClientAuthenticationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableClientAuthenticationCommandOutput) => void ): void; - public disableClientAuthentication( - args: DisableClientAuthenticationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableClientAuthenticationCommandOutput) => void), - cb?: (err: any, data?: DisableClientAuthenticationCommandOutput) => void - ): Promise | void { - const command = new DisableClientAuthenticationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deactivates LDAP secure calls for the specified directory.

- */ - public disableLDAPS( - args: DisableLDAPSCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public disableLDAPS(args: DisableLDAPSCommandInput, cb: (err: any, data?: DisableLDAPSCommandOutput) => void): void; - public disableLDAPS( + + /** + * @see {@link DisableLDAPSCommand} + */ + disableLDAPS(args: DisableLDAPSCommandInput, options?: __HttpHandlerOptions): Promise; + disableLDAPS(args: DisableLDAPSCommandInput, cb: (err: any, data?: DisableLDAPSCommandOutput) => void): void; + disableLDAPS( args: DisableLDAPSCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableLDAPSCommandOutput) => void ): void; - public disableLDAPS( - args: DisableLDAPSCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableLDAPSCommandOutput) => void), - cb?: (err: any, data?: DisableLDAPSCommandOutput) => void - ): Promise | void { - const command = new DisableLDAPSCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables multi-factor authentication (MFA) with the Remote Authentication Dial In - * User Service (RADIUS) server for an AD Connector or Microsoft AD directory.

- */ - public disableRadius( - args: DisableRadiusCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public disableRadius( - args: DisableRadiusCommandInput, - cb: (err: any, data?: DisableRadiusCommandOutput) => void - ): void; - public disableRadius( + + /** + * @see {@link DisableRadiusCommand} + */ + disableRadius(args: DisableRadiusCommandInput, options?: __HttpHandlerOptions): Promise; + disableRadius(args: DisableRadiusCommandInput, cb: (err: any, data?: DisableRadiusCommandOutput) => void): void; + disableRadius( args: DisableRadiusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableRadiusCommandOutput) => void ): void; - public disableRadius( - args: DisableRadiusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableRadiusCommandOutput) => void), - cb?: (err: any, data?: DisableRadiusCommandOutput) => void - ): Promise | void { - const command = new DisableRadiusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables single-sign on for a directory.

- */ - public disableSso(args: DisableSsoCommandInput, options?: __HttpHandlerOptions): Promise; - public disableSso(args: DisableSsoCommandInput, cb: (err: any, data?: DisableSsoCommandOutput) => void): void; - public disableSso( + + /** + * @see {@link DisableSsoCommand} + */ + disableSso(args: DisableSsoCommandInput, options?: __HttpHandlerOptions): Promise; + disableSso(args: DisableSsoCommandInput, cb: (err: any, data?: DisableSsoCommandOutput) => void): void; + disableSso( args: DisableSsoCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableSsoCommandOutput) => void ): void; - public disableSso( - args: DisableSsoCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableSsoCommandOutput) => void), - cb?: (err: any, data?: DisableSsoCommandOutput) => void - ): Promise | void { - const command = new DisableSsoCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables alternative client authentication methods for the specified directory.

- */ - public enableClientAuthentication( + + /** + * @see {@link EnableClientAuthenticationCommand} + */ + enableClientAuthentication( args: EnableClientAuthenticationCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableClientAuthentication( + enableClientAuthentication( args: EnableClientAuthenticationCommandInput, cb: (err: any, data?: EnableClientAuthenticationCommandOutput) => void ): void; - public enableClientAuthentication( + enableClientAuthentication( args: EnableClientAuthenticationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableClientAuthenticationCommandOutput) => void ): void; - public enableClientAuthentication( - args: EnableClientAuthenticationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableClientAuthenticationCommandOutput) => void), - cb?: (err: any, data?: EnableClientAuthenticationCommandOutput) => void - ): Promise | void { - const command = new EnableClientAuthenticationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Activates the switch for the specific directory to always use LDAP secure calls.

- */ - public enableLDAPS(args: EnableLDAPSCommandInput, options?: __HttpHandlerOptions): Promise; - public enableLDAPS(args: EnableLDAPSCommandInput, cb: (err: any, data?: EnableLDAPSCommandOutput) => void): void; - public enableLDAPS( + + /** + * @see {@link EnableLDAPSCommand} + */ + enableLDAPS(args: EnableLDAPSCommandInput, options?: __HttpHandlerOptions): Promise; + enableLDAPS(args: EnableLDAPSCommandInput, cb: (err: any, data?: EnableLDAPSCommandOutput) => void): void; + enableLDAPS( args: EnableLDAPSCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableLDAPSCommandOutput) => void ): void; - public enableLDAPS( - args: EnableLDAPSCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableLDAPSCommandOutput) => void), - cb?: (err: any, data?: EnableLDAPSCommandOutput) => void - ): Promise | void { - const command = new EnableLDAPSCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User - * Service (RADIUS) server for an AD Connector or Microsoft AD directory.

- */ - public enableRadius( - args: EnableRadiusCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public enableRadius(args: EnableRadiusCommandInput, cb: (err: any, data?: EnableRadiusCommandOutput) => void): void; - public enableRadius( + + /** + * @see {@link EnableRadiusCommand} + */ + enableRadius(args: EnableRadiusCommandInput, options?: __HttpHandlerOptions): Promise; + enableRadius(args: EnableRadiusCommandInput, cb: (err: any, data?: EnableRadiusCommandOutput) => void): void; + enableRadius( args: EnableRadiusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableRadiusCommandOutput) => void ): void; - public enableRadius( - args: EnableRadiusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableRadiusCommandOutput) => void), - cb?: (err: any, data?: EnableRadiusCommandOutput) => void - ): Promise | void { - const command = new EnableRadiusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables single sign-on for a directory. Single sign-on allows users in your directory to - * access certain Amazon Web Services services from a computer joined to the directory without having to enter - * their credentials separately.

- */ - public enableSso(args: EnableSsoCommandInput, options?: __HttpHandlerOptions): Promise; - public enableSso(args: EnableSsoCommandInput, cb: (err: any, data?: EnableSsoCommandOutput) => void): void; - public enableSso( + + /** + * @see {@link EnableSsoCommand} + */ + enableSso(args: EnableSsoCommandInput, options?: __HttpHandlerOptions): Promise; + enableSso(args: EnableSsoCommandInput, cb: (err: any, data?: EnableSsoCommandOutput) => void): void; + enableSso( args: EnableSsoCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableSsoCommandOutput) => void ): void; - public enableSso( - args: EnableSsoCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableSsoCommandOutput) => void), - cb?: (err: any, data?: EnableSsoCommandOutput) => void - ): Promise | void { - const command = new EnableSsoCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Obtains directory limit information for the current Region.

- */ - public getDirectoryLimits( + + /** + * @see {@link GetDirectoryLimitsCommand} + */ + getDirectoryLimits( args: GetDirectoryLimitsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDirectoryLimits( + getDirectoryLimits( args: GetDirectoryLimitsCommandInput, cb: (err: any, data?: GetDirectoryLimitsCommandOutput) => void ): void; - public getDirectoryLimits( + getDirectoryLimits( args: GetDirectoryLimitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDirectoryLimitsCommandOutput) => void ): void; - public getDirectoryLimits( - args: GetDirectoryLimitsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDirectoryLimitsCommandOutput) => void), - cb?: (err: any, data?: GetDirectoryLimitsCommandOutput) => void - ): Promise | void { - const command = new GetDirectoryLimitsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Obtains the manual snapshot limits for a directory.

- */ - public getSnapshotLimits( + + /** + * @see {@link GetSnapshotLimitsCommand} + */ + getSnapshotLimits( args: GetSnapshotLimitsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSnapshotLimits( + getSnapshotLimits( args: GetSnapshotLimitsCommandInput, cb: (err: any, data?: GetSnapshotLimitsCommandOutput) => void ): void; - public getSnapshotLimits( + getSnapshotLimits( args: GetSnapshotLimitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSnapshotLimitsCommandOutput) => void ): void; - public getSnapshotLimits( - args: GetSnapshotLimitsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSnapshotLimitsCommandOutput) => void), - cb?: (err: any, data?: GetSnapshotLimitsCommandOutput) => void - ): Promise | void { - const command = new GetSnapshotLimitsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.

- */ - public listCertificates( + + /** + * @see {@link ListCertificatesCommand} + */ + listCertificates( args: ListCertificatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCertificates( + listCertificates( args: ListCertificatesCommandInput, cb: (err: any, data?: ListCertificatesCommandOutput) => void ): void; - public listCertificates( + listCertificates( args: ListCertificatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCertificatesCommandOutput) => void ): void; - public listCertificates( - args: ListCertificatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCertificatesCommandOutput) => void), - cb?: (err: any, data?: ListCertificatesCommandOutput) => void - ): Promise | void { - const command = new ListCertificatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the address blocks that you have added to a directory.

- */ - public listIpRoutes( - args: ListIpRoutesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listIpRoutes(args: ListIpRoutesCommandInput, cb: (err: any, data?: ListIpRoutesCommandOutput) => void): void; - public listIpRoutes( + + /** + * @see {@link ListIpRoutesCommand} + */ + listIpRoutes(args: ListIpRoutesCommandInput, options?: __HttpHandlerOptions): Promise; + listIpRoutes(args: ListIpRoutesCommandInput, cb: (err: any, data?: ListIpRoutesCommandOutput) => void): void; + listIpRoutes( args: ListIpRoutesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIpRoutesCommandOutput) => void ): void; - public listIpRoutes( - args: ListIpRoutesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIpRoutesCommandOutput) => void), - cb?: (err: any, data?: ListIpRoutesCommandOutput) => void - ): Promise | void { - const command = new ListIpRoutesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the active log subscriptions for the Amazon Web Services account.

- */ - public listLogSubscriptions( + + /** + * @see {@link ListLogSubscriptionsCommand} + */ + listLogSubscriptions( args: ListLogSubscriptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLogSubscriptions( + listLogSubscriptions( args: ListLogSubscriptionsCommandInput, cb: (err: any, data?: ListLogSubscriptionsCommandOutput) => void ): void; - public listLogSubscriptions( + listLogSubscriptions( args: ListLogSubscriptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLogSubscriptionsCommandOutput) => void ): void; - public listLogSubscriptions( - args: ListLogSubscriptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLogSubscriptionsCommandOutput) => void), - cb?: (err: any, data?: ListLogSubscriptionsCommandOutput) => void - ): Promise | void { - const command = new ListLogSubscriptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all schema extensions applied to a Microsoft AD Directory.

- */ - public listSchemaExtensions( + + /** + * @see {@link ListSchemaExtensionsCommand} + */ + listSchemaExtensions( args: ListSchemaExtensionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSchemaExtensions( + listSchemaExtensions( args: ListSchemaExtensionsCommandInput, cb: (err: any, data?: ListSchemaExtensionsCommandOutput) => void ): void; - public listSchemaExtensions( + listSchemaExtensions( args: ListSchemaExtensionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSchemaExtensionsCommandOutput) => void ): void; - public listSchemaExtensions( - args: ListSchemaExtensionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSchemaExtensionsCommandOutput) => void), - cb?: (err: any, data?: ListSchemaExtensionsCommandOutput) => void - ): Promise | void { - const command = new ListSchemaExtensionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all tags on a directory.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers a certificate for a secure LDAP or client certificate authentication.

- */ - public registerCertificate( + + /** + * @see {@link RegisterCertificateCommand} + */ + registerCertificate( args: RegisterCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerCertificate( + registerCertificate( args: RegisterCertificateCommandInput, cb: (err: any, data?: RegisterCertificateCommandOutput) => void ): void; - public registerCertificate( + registerCertificate( args: RegisterCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterCertificateCommandOutput) => void ): void; - public registerCertificate( - args: RegisterCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterCertificateCommandOutput) => void), - cb?: (err: any, data?: RegisterCertificateCommandOutput) => void - ): Promise | void { - const command = new RegisterCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a directory with an Amazon SNS topic. This establishes the directory as a - * publisher to the specified Amazon SNS topic. You can then receive email or text (SMS) messages when - * the status of your directory changes. You get notified if your directory goes from an Active - * status to an Impaired or Inoperable status. You also receive a notification when the directory - * returns to an Active status.

- */ - public registerEventTopic( + + /** + * @see {@link RegisterEventTopicCommand} + */ + registerEventTopic( args: RegisterEventTopicCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerEventTopic( + registerEventTopic( args: RegisterEventTopicCommandInput, cb: (err: any, data?: RegisterEventTopicCommandOutput) => void ): void; - public registerEventTopic( + registerEventTopic( args: RegisterEventTopicCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterEventTopicCommandOutput) => void ): void; - public registerEventTopic( - args: RegisterEventTopicCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterEventTopicCommandOutput) => void), - cb?: (err: any, data?: RegisterEventTopicCommandOutput) => void - ): Promise | void { - const command = new RegisterEventTopicCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Rejects a directory sharing request that was sent from the directory owner account.

- */ - public rejectSharedDirectory( + + /** + * @see {@link RejectSharedDirectoryCommand} + */ + rejectSharedDirectory( args: RejectSharedDirectoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public rejectSharedDirectory( + rejectSharedDirectory( args: RejectSharedDirectoryCommandInput, cb: (err: any, data?: RejectSharedDirectoryCommandOutput) => void ): void; - public rejectSharedDirectory( + rejectSharedDirectory( args: RejectSharedDirectoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectSharedDirectoryCommandOutput) => void ): void; - public rejectSharedDirectory( - args: RejectSharedDirectoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RejectSharedDirectoryCommandOutput) => void), - cb?: (err: any, data?: RejectSharedDirectoryCommandOutput) => void - ): Promise | void { - const command = new RejectSharedDirectoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes IP address blocks from a directory.

- */ - public removeIpRoutes( + + /** + * @see {@link RemoveIpRoutesCommand} + */ + removeIpRoutes( args: RemoveIpRoutesCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeIpRoutes( - args: RemoveIpRoutesCommandInput, - cb: (err: any, data?: RemoveIpRoutesCommandOutput) => void - ): void; - public removeIpRoutes( + removeIpRoutes(args: RemoveIpRoutesCommandInput, cb: (err: any, data?: RemoveIpRoutesCommandOutput) => void): void; + removeIpRoutes( args: RemoveIpRoutesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveIpRoutesCommandOutput) => void ): void; - public removeIpRoutes( - args: RemoveIpRoutesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveIpRoutesCommandOutput) => void), - cb?: (err: any, data?: RemoveIpRoutesCommandOutput) => void - ): Promise | void { - const command = new RemoveIpRoutesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops all replication and removes the domain controllers from the specified Region. You - * cannot remove the primary Region with this operation. Instead, use the - * DeleteDirectory API.

- */ - public removeRegion( - args: RemoveRegionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public removeRegion(args: RemoveRegionCommandInput, cb: (err: any, data?: RemoveRegionCommandOutput) => void): void; - public removeRegion( + + /** + * @see {@link RemoveRegionCommand} + */ + removeRegion(args: RemoveRegionCommandInput, options?: __HttpHandlerOptions): Promise; + removeRegion(args: RemoveRegionCommandInput, cb: (err: any, data?: RemoveRegionCommandOutput) => void): void; + removeRegion( args: RemoveRegionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveRegionCommandOutput) => void ): void; - public removeRegion( - args: RemoveRegionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveRegionCommandOutput) => void), - cb?: (err: any, data?: RemoveRegionCommandOutput) => void - ): Promise | void { - const command = new RemoveRegionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes tags from a directory.

- */ - public removeTagsFromResource( + + /** + * @see {@link RemoveTagsFromResourceCommand} + */ + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeTagsFromResource( + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void ): void; - public removeTagsFromResource( + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void ): void; - public removeTagsFromResource( - args: RemoveTagsFromResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveTagsFromResourceCommandOutput) => void), - cb?: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void - ): Promise | void { - const command = new RemoveTagsFromResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Resets the password for any user in your Managed Microsoft AD or Simple AD - * directory.

- *

You can reset the password for any user in your directory with the following - * exceptions:

- *
    - *
  • - *

    For Simple AD, you cannot reset the password for any user that is a member of either - * the Domain Admins or Enterprise - * Admins group except for the administrator user.

    - *
  • - *
  • - *

    For Managed Microsoft AD, you can only reset the password for a user that is in an - * OU based off of the NetBIOS name that you typed when you created your directory. For - * example, you cannot reset the password for a user in the Amazon Web Services - * Reserved OU. For more information about the OU structure for an Managed Microsoft AD directory, see What Gets Created in the Directory Service Administration - * Guide.

    - *
  • - *
- */ - public resetUserPassword( + + /** + * @see {@link ResetUserPasswordCommand} + */ + resetUserPassword( args: ResetUserPasswordCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetUserPassword( + resetUserPassword( args: ResetUserPasswordCommandInput, cb: (err: any, data?: ResetUserPasswordCommandOutput) => void ): void; - public resetUserPassword( + resetUserPassword( args: ResetUserPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetUserPasswordCommandOutput) => void ): void; - public resetUserPassword( - args: ResetUserPasswordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetUserPasswordCommandOutput) => void), - cb?: (err: any, data?: ResetUserPasswordCommandOutput) => void - ): Promise | void { - const command = new ResetUserPasswordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Restores a directory using an existing directory snapshot.

- *

When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.

- *

This action returns as soon as the restore operation is initiated. You can monitor the - * progress of the restore operation by calling the DescribeDirectories operation with - * the directory identifier. When the DirectoryDescription.Stage value changes to - * Active, the restore operation is complete.

- */ - public restoreFromSnapshot( + + /** + * @see {@link RestoreFromSnapshotCommand} + */ + restoreFromSnapshot( args: RestoreFromSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreFromSnapshot( + restoreFromSnapshot( args: RestoreFromSnapshotCommandInput, cb: (err: any, data?: RestoreFromSnapshotCommandOutput) => void ): void; - public restoreFromSnapshot( + restoreFromSnapshot( args: RestoreFromSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreFromSnapshotCommandOutput) => void ): void; - public restoreFromSnapshot( - args: RestoreFromSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreFromSnapshotCommandOutput) => void), - cb?: (err: any, data?: RestoreFromSnapshotCommandOutput) => void - ): Promise | void { - const command = new RestoreFromSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Shares a specified directory (DirectoryId) in your Amazon Web Services account (directory - * owner) with another Amazon Web Services account (directory consumer). With this operation you can use your - * directory from any Amazon Web Services account and from any Amazon VPC within an Amazon Web Services Region.

- *

When you share your Managed Microsoft AD directory, Directory Service creates a - * shared directory in the directory consumer account. This shared directory contains the - * metadata to provide access to the directory within the directory owner account. The shared - * directory is visible in all VPCs in the directory consumer account.

- *

The ShareMethod parameter determines whether the specified directory can be - * shared between Amazon Web Services accounts inside the same Amazon Web Services organization (ORGANIZATIONS). It - * also determines whether you can share the directory with any other Amazon Web Services account either inside - * or outside of the organization (HANDSHAKE).

- *

The ShareNotes parameter is only used when HANDSHAKE is called, - * which sends a directory sharing request to the directory consumer.

- */ - public shareDirectory( + + /** + * @see {@link ShareDirectoryCommand} + */ + shareDirectory( args: ShareDirectoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public shareDirectory( - args: ShareDirectoryCommandInput, - cb: (err: any, data?: ShareDirectoryCommandOutput) => void - ): void; - public shareDirectory( + shareDirectory(args: ShareDirectoryCommandInput, cb: (err: any, data?: ShareDirectoryCommandOutput) => void): void; + shareDirectory( args: ShareDirectoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ShareDirectoryCommandOutput) => void ): void; - public shareDirectory( - args: ShareDirectoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ShareDirectoryCommandOutput) => void), - cb?: (err: any, data?: ShareDirectoryCommandOutput) => void - ): Promise | void { - const command = new ShareDirectoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Applies a schema extension to a Microsoft AD directory.

- */ - public startSchemaExtension( + + /** + * @see {@link StartSchemaExtensionCommand} + */ + startSchemaExtension( args: StartSchemaExtensionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startSchemaExtension( + startSchemaExtension( args: StartSchemaExtensionCommandInput, cb: (err: any, data?: StartSchemaExtensionCommandOutput) => void ): void; - public startSchemaExtension( + startSchemaExtension( args: StartSchemaExtensionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSchemaExtensionCommandOutput) => void ): void; - public startSchemaExtension( - args: StartSchemaExtensionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartSchemaExtensionCommandOutput) => void), - cb?: (err: any, data?: StartSchemaExtensionCommandOutput) => void - ): Promise | void { - const command = new StartSchemaExtensionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops the directory sharing between the directory owner and consumer accounts.

- */ - public unshareDirectory( + + /** + * @see {@link UnshareDirectoryCommand} + */ + unshareDirectory( args: UnshareDirectoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public unshareDirectory( + unshareDirectory( args: UnshareDirectoryCommandInput, cb: (err: any, data?: UnshareDirectoryCommandOutput) => void ): void; - public unshareDirectory( + unshareDirectory( args: UnshareDirectoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnshareDirectoryCommandOutput) => void ): void; - public unshareDirectory( - args: UnshareDirectoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnshareDirectoryCommandOutput) => void), - cb?: (err: any, data?: UnshareDirectoryCommandOutput) => void - ): Promise | void { - const command = new UnshareDirectoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a conditional forwarder that has been set up for your Amazon Web Services - * directory.

- */ - public updateConditionalForwarder( + + /** + * @see {@link UpdateConditionalForwarderCommand} + */ + updateConditionalForwarder( args: UpdateConditionalForwarderCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConditionalForwarder( + updateConditionalForwarder( args: UpdateConditionalForwarderCommandInput, cb: (err: any, data?: UpdateConditionalForwarderCommandOutput) => void ): void; - public updateConditionalForwarder( + updateConditionalForwarder( args: UpdateConditionalForwarderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConditionalForwarderCommandOutput) => void ): void; - public updateConditionalForwarder( - args: UpdateConditionalForwarderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConditionalForwarderCommandOutput) => void), - cb?: (err: any, data?: UpdateConditionalForwarderCommandOutput) => void - ): Promise | void { - const command = new UpdateConditionalForwarderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Updates the directory for a particular update type. - *

- */ - public updateDirectorySetup( + + /** + * @see {@link UpdateDirectorySetupCommand} + */ + updateDirectorySetup( args: UpdateDirectorySetupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDirectorySetup( + updateDirectorySetup( args: UpdateDirectorySetupCommandInput, cb: (err: any, data?: UpdateDirectorySetupCommandOutput) => void ): void; - public updateDirectorySetup( + updateDirectorySetup( args: UpdateDirectorySetupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDirectorySetupCommandOutput) => void ): void; - public updateDirectorySetup( - args: UpdateDirectorySetupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDirectorySetupCommandOutput) => void), - cb?: (err: any, data?: UpdateDirectorySetupCommandOutput) => void - ): Promise | void { - const command = new UpdateDirectorySetupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds or removes domain controllers to or from the directory. Based on the difference - * between current value and new value (provided through this API call), domain controllers will - * be added or removed. It may take up to 45 minutes for any new domain controllers to become - * fully active once the requested number of domain controllers is updated. During this time, you - * cannot make another update request.

- */ - public updateNumberOfDomainControllers( + + /** + * @see {@link UpdateNumberOfDomainControllersCommand} + */ + updateNumberOfDomainControllers( args: UpdateNumberOfDomainControllersCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateNumberOfDomainControllers( + updateNumberOfDomainControllers( args: UpdateNumberOfDomainControllersCommandInput, cb: (err: any, data?: UpdateNumberOfDomainControllersCommandOutput) => void ): void; - public updateNumberOfDomainControllers( + updateNumberOfDomainControllers( args: UpdateNumberOfDomainControllersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNumberOfDomainControllersCommandOutput) => void ): void; - public updateNumberOfDomainControllers( - args: UpdateNumberOfDomainControllersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateNumberOfDomainControllersCommandOutput) => void), - cb?: (err: any, data?: UpdateNumberOfDomainControllersCommandOutput) => void - ): Promise | void { - const command = new UpdateNumberOfDomainControllersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the Remote Authentication Dial In User Service (RADIUS) server information - * for an AD Connector or Microsoft AD directory.

- */ - public updateRadius( - args: UpdateRadiusCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateRadius(args: UpdateRadiusCommandInput, cb: (err: any, data?: UpdateRadiusCommandOutput) => void): void; - public updateRadius( + + /** + * @see {@link UpdateRadiusCommand} + */ + updateRadius(args: UpdateRadiusCommandInput, options?: __HttpHandlerOptions): Promise; + updateRadius(args: UpdateRadiusCommandInput, cb: (err: any, data?: UpdateRadiusCommandOutput) => void): void; + updateRadius( args: UpdateRadiusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRadiusCommandOutput) => void ): void; - public updateRadius( - args: UpdateRadiusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRadiusCommandOutput) => void), - cb?: (err: any, data?: UpdateRadiusCommandOutput) => void - ): Promise | void { - const command = new UpdateRadiusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the configurable settings for the specified directory.

- */ - public updateSettings( + + /** + * @see {@link UpdateSettingsCommand} + */ + updateSettings( args: UpdateSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSettings( - args: UpdateSettingsCommandInput, - cb: (err: any, data?: UpdateSettingsCommandOutput) => void - ): void; - public updateSettings( + updateSettings(args: UpdateSettingsCommandInput, cb: (err: any, data?: UpdateSettingsCommandOutput) => void): void; + updateSettings( args: UpdateSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSettingsCommandOutput) => void ): void; - public updateSettings( - args: UpdateSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the trust that has been set up between your Managed Microsoft AD directory and an - * self-managed Active Directory.

- */ - public updateTrust(args: UpdateTrustCommandInput, options?: __HttpHandlerOptions): Promise; - public updateTrust(args: UpdateTrustCommandInput, cb: (err: any, data?: UpdateTrustCommandOutput) => void): void; - public updateTrust( + + /** + * @see {@link UpdateTrustCommand} + */ + updateTrust(args: UpdateTrustCommandInput, options?: __HttpHandlerOptions): Promise; + updateTrust(args: UpdateTrustCommandInput, cb: (err: any, data?: UpdateTrustCommandOutput) => void): void; + updateTrust( args: UpdateTrustCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTrustCommandOutput) => void ): void; - public updateTrust( - args: UpdateTrustCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTrustCommandOutput) => void), - cb?: (err: any, data?: UpdateTrustCommandOutput) => void - ): Promise | void { - const command = new UpdateTrustCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Directory Service for Microsoft Active Directory allows you to configure and verify trust - * relationships.

- *

This action verifies a trust relationship between your Managed Microsoft AD directory and an - * external domain.

- */ - public verifyTrust(args: VerifyTrustCommandInput, options?: __HttpHandlerOptions): Promise; - public verifyTrust(args: VerifyTrustCommandInput, cb: (err: any, data?: VerifyTrustCommandOutput) => void): void; - public verifyTrust( + + /** + * @see {@link VerifyTrustCommand} + */ + verifyTrust(args: VerifyTrustCommandInput, options?: __HttpHandlerOptions): Promise; + verifyTrust(args: VerifyTrustCommandInput, cb: (err: any, data?: VerifyTrustCommandOutput) => void): void; + verifyTrust( args: VerifyTrustCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifyTrustCommandOutput) => void ): void; - public verifyTrust( - args: VerifyTrustCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: VerifyTrustCommandOutput) => void), - cb?: (err: any, data?: VerifyTrustCommandOutput) => void - ): Promise | void { - const command = new VerifyTrustCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Directory Service + *

Directory Service is a web service that makes it easy for you to setup and run directories in the + * Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active + * Directory. This guide provides detailed information about Directory Service operations, data types, + * parameters, and errors. For information about Directory Services features, see Directory Service and the Directory Service + * Administration Guide.

+ * + *

Amazon Web Services provides SDKs that consist of libraries and sample code for various + * programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs + * provide a convenient way to create programmatic access to Directory Service and other Amazon Web Services + * services. For more information about the Amazon Web Services SDKs, including how to download and + * install them, see Tools for Amazon Web + * Services.

+ *
+ */ +export class DirectoryService extends DirectoryServiceClient implements DirectoryService {} +createAggregatedClient(commands, DirectoryService); diff --git a/clients/client-dlm/src/DLM.ts b/clients/client-dlm/src/DLM.ts index a3bc6bf47475..3b08b0b084ee 100644 --- a/clients/client-dlm/src/DLM.ts +++ b/clients/client-dlm/src/DLM.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -37,281 +38,154 @@ import { UpdateLifecyclePolicyCommandInput, UpdateLifecyclePolicyCommandOutput, } from "./commands/UpdateLifecyclePolicyCommand"; -import { DLMClient } from "./DLMClient"; +import { DLMClient, DLMClientConfig } from "./DLMClient"; -/** - * @public - * Amazon Data Lifecycle Manager - *

With Amazon Data Lifecycle Manager, you can manage the lifecycle of your Amazon Web Services resources. You create - * lifecycle policies, which are used to automate operations on the specified - * resources.

- *

Amazon Data Lifecycle Manager supports Amazon EBS volumes and snapshots. For information about using Amazon Data Lifecycle Manager - * with Amazon EBS, see - * Amazon Data Lifecycle Manager in the Amazon EC2 User Guide.

- */ -export class DLM extends DLMClient { +const commands = { + CreateLifecyclePolicyCommand, + DeleteLifecyclePolicyCommand, + GetLifecyclePoliciesCommand, + GetLifecyclePolicyCommand, + ListTagsForResourceCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateLifecyclePolicyCommand, +}; + +export interface DLM { /** - * @public - *

Creates a policy to manage the lifecycle of the specified Amazon Web Services resources. You can - * create up to 100 lifecycle policies.

+ * @see {@link CreateLifecyclePolicyCommand} */ - public createLifecyclePolicy( + createLifecyclePolicy( args: CreateLifecyclePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLifecyclePolicy( + createLifecyclePolicy( args: CreateLifecyclePolicyCommandInput, cb: (err: any, data?: CreateLifecyclePolicyCommandOutput) => void ): void; - public createLifecyclePolicy( + createLifecyclePolicy( args: CreateLifecyclePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLifecyclePolicyCommandOutput) => void ): void; - public createLifecyclePolicy( - args: CreateLifecyclePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLifecyclePolicyCommandOutput) => void), - cb?: (err: any, data?: CreateLifecyclePolicyCommandOutput) => void - ): Promise | void { - const command = new CreateLifecyclePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified lifecycle policy and halts the automated operations that the - * policy specified.

- *

For more information about deleting a policy, see Delete lifecycle - * policies.

+ * @see {@link DeleteLifecyclePolicyCommand} */ - public deleteLifecyclePolicy( + deleteLifecyclePolicy( args: DeleteLifecyclePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLifecyclePolicy( + deleteLifecyclePolicy( args: DeleteLifecyclePolicyCommandInput, cb: (err: any, data?: DeleteLifecyclePolicyCommandOutput) => void ): void; - public deleteLifecyclePolicy( + deleteLifecyclePolicy( args: DeleteLifecyclePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLifecyclePolicyCommandOutput) => void ): void; - public deleteLifecyclePolicy( - args: DeleteLifecyclePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLifecyclePolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteLifecyclePolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteLifecyclePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets summary information about all or the specified data lifecycle policies.

- *

To get complete information about a policy, use GetLifecyclePolicy.

+ * @see {@link GetLifecyclePoliciesCommand} */ - public getLifecyclePolicies( + getLifecyclePolicies( args: GetLifecyclePoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLifecyclePolicies( + getLifecyclePolicies( args: GetLifecyclePoliciesCommandInput, cb: (err: any, data?: GetLifecyclePoliciesCommandOutput) => void ): void; - public getLifecyclePolicies( + getLifecyclePolicies( args: GetLifecyclePoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLifecyclePoliciesCommandOutput) => void ): void; - public getLifecyclePolicies( - args: GetLifecyclePoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLifecyclePoliciesCommandOutput) => void), - cb?: (err: any, data?: GetLifecyclePoliciesCommandOutput) => void - ): Promise | void { - const command = new GetLifecyclePoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets detailed information about the specified lifecycle policy.

+ * @see {@link GetLifecyclePolicyCommand} */ - public getLifecyclePolicy( + getLifecyclePolicy( args: GetLifecyclePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLifecyclePolicy( + getLifecyclePolicy( args: GetLifecyclePolicyCommandInput, cb: (err: any, data?: GetLifecyclePolicyCommandOutput) => void ): void; - public getLifecyclePolicy( + getLifecyclePolicy( args: GetLifecyclePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLifecyclePolicyCommandOutput) => void ): void; - public getLifecyclePolicy( - args: GetLifecyclePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLifecyclePolicyCommandOutput) => void), - cb?: (err: any, data?: GetLifecyclePolicyCommandOutput) => void - ): Promise | void { - const command = new GetLifecyclePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags for the specified resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds the specified tags to the specified resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified tags from the specified resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified lifecycle policy.

- *

For more information about updating a policy, see Modify lifecycle - * policies.

+ * @see {@link UpdateLifecyclePolicyCommand} */ - public updateLifecyclePolicy( + updateLifecyclePolicy( args: UpdateLifecyclePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLifecyclePolicy( + updateLifecyclePolicy( args: UpdateLifecyclePolicyCommandInput, cb: (err: any, data?: UpdateLifecyclePolicyCommandOutput) => void ): void; - public updateLifecyclePolicy( + updateLifecyclePolicy( args: UpdateLifecyclePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLifecyclePolicyCommandOutput) => void ): void; - public updateLifecyclePolicy( - args: UpdateLifecyclePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLifecyclePolicyCommandOutput) => void), - cb?: (err: any, data?: UpdateLifecyclePolicyCommandOutput) => void - ): Promise | void { - const command = new UpdateLifecyclePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Data Lifecycle Manager + *

With Amazon Data Lifecycle Manager, you can manage the lifecycle of your Amazon Web Services resources. You create + * lifecycle policies, which are used to automate operations on the specified + * resources.

+ *

Amazon Data Lifecycle Manager supports Amazon EBS volumes and snapshots. For information about using Amazon Data Lifecycle Manager + * with Amazon EBS, see + * Amazon Data Lifecycle Manager in the Amazon EC2 User Guide.

+ */ +export class DLM extends DLMClient implements DLM {} +createAggregatedClient(commands, DLM); diff --git a/clients/client-docdb-elastic/src/DocDBElastic.ts b/clients/client-docdb-elastic/src/DocDBElastic.ts index 9b6829d12899..1b35e7d8db04 100644 --- a/clients/client-docdb-elastic/src/DocDBElastic.ts +++ b/clients/client-docdb-elastic/src/DocDBElastic.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -58,425 +59,208 @@ import { UpdateClusterCommandInput, UpdateClusterCommandOutput, } from "./commands/UpdateClusterCommand"; -import { DocDBElasticClient } from "./DocDBElasticClient"; +import { DocDBElasticClient, DocDBElasticClientConfig } from "./DocDBElasticClient"; -/** - * @public - *

The new Amazon Elastic DocumentDB service endpoint.

- */ -export class DocDBElastic extends DocDBElasticClient { +const commands = { + CreateClusterCommand, + CreateClusterSnapshotCommand, + DeleteClusterCommand, + DeleteClusterSnapshotCommand, + GetClusterCommand, + GetClusterSnapshotCommand, + ListClustersCommand, + ListClusterSnapshotsCommand, + ListTagsForResourceCommand, + RestoreClusterFromSnapshotCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateClusterCommand, +}; + +export interface DocDBElastic { /** - * @public - *

Creates a new Elastic DocumentDB cluster and returns its Cluster structure.

+ * @see {@link CreateClusterCommand} */ - public createCluster( - args: CreateClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createCluster( - args: CreateClusterCommandInput, - cb: (err: any, data?: CreateClusterCommandOutput) => void - ): void; - public createCluster( + createCluster(args: CreateClusterCommandInput, options?: __HttpHandlerOptions): Promise; + createCluster(args: CreateClusterCommandInput, cb: (err: any, data?: CreateClusterCommandOutput) => void): void; + createCluster( args: CreateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterCommandOutput) => void ): void; - public createCluster( - args: CreateClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateClusterCommandOutput) => void), - cb?: (err: any, data?: CreateClusterCommandOutput) => void - ): Promise | void { - const command = new CreateClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a snapshot of a cluster.

+ * @see {@link CreateClusterSnapshotCommand} */ - public createClusterSnapshot( + createClusterSnapshot( args: CreateClusterSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public createClusterSnapshot( + createClusterSnapshot( args: CreateClusterSnapshotCommandInput, cb: (err: any, data?: CreateClusterSnapshotCommandOutput) => void ): void; - public createClusterSnapshot( + createClusterSnapshot( args: CreateClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterSnapshotCommandOutput) => void ): void; - public createClusterSnapshot( - args: CreateClusterSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateClusterSnapshotCommandOutput) => void), - cb?: (err: any, data?: CreateClusterSnapshotCommandOutput) => void - ): Promise | void { - const command = new CreateClusterSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete a Elastic DocumentDB cluster.

+ * @see {@link DeleteClusterCommand} */ - public deleteCluster( - args: DeleteClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteCluster( - args: DeleteClusterCommandInput, - cb: (err: any, data?: DeleteClusterCommandOutput) => void - ): void; - public deleteCluster( + deleteCluster(args: DeleteClusterCommandInput, options?: __HttpHandlerOptions): Promise; + deleteCluster(args: DeleteClusterCommandInput, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void; + deleteCluster( args: DeleteClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClusterCommandOutput) => void ): void; - public deleteCluster( - args: DeleteClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteClusterCommandOutput) => void), - cb?: (err: any, data?: DeleteClusterCommandOutput) => void - ): Promise | void { - const command = new DeleteClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete a Elastic DocumentDB snapshot.

+ * @see {@link DeleteClusterSnapshotCommand} */ - public deleteClusterSnapshot( + deleteClusterSnapshot( args: DeleteClusterSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteClusterSnapshot( + deleteClusterSnapshot( args: DeleteClusterSnapshotCommandInput, cb: (err: any, data?: DeleteClusterSnapshotCommandOutput) => void ): void; - public deleteClusterSnapshot( + deleteClusterSnapshot( args: DeleteClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClusterSnapshotCommandOutput) => void ): void; - public deleteClusterSnapshot( - args: DeleteClusterSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteClusterSnapshotCommandOutput) => void), - cb?: (err: any, data?: DeleteClusterSnapshotCommandOutput) => void - ): Promise | void { - const command = new DeleteClusterSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a specific Elastic DocumentDB cluster.

+ * @see {@link GetClusterCommand} */ - public getCluster(args: GetClusterCommandInput, options?: __HttpHandlerOptions): Promise; - public getCluster(args: GetClusterCommandInput, cb: (err: any, data?: GetClusterCommandOutput) => void): void; - public getCluster( + getCluster(args: GetClusterCommandInput, options?: __HttpHandlerOptions): Promise; + getCluster(args: GetClusterCommandInput, cb: (err: any, data?: GetClusterCommandOutput) => void): void; + getCluster( args: GetClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetClusterCommandOutput) => void ): void; - public getCluster( - args: GetClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetClusterCommandOutput) => void), - cb?: (err: any, data?: GetClusterCommandOutput) => void - ): Promise | void { - const command = new GetClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a specific Elastic DocumentDB snapshot

+ * @see {@link GetClusterSnapshotCommand} */ - public getClusterSnapshot( + getClusterSnapshot( args: GetClusterSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public getClusterSnapshot( + getClusterSnapshot( args: GetClusterSnapshotCommandInput, cb: (err: any, data?: GetClusterSnapshotCommandOutput) => void ): void; - public getClusterSnapshot( + getClusterSnapshot( args: GetClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetClusterSnapshotCommandOutput) => void ): void; - public getClusterSnapshot( - args: GetClusterSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetClusterSnapshotCommandOutput) => void), - cb?: (err: any, data?: GetClusterSnapshotCommandOutput) => void - ): Promise | void { - const command = new GetClusterSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about provisioned Elastic DocumentDB clusters.

+ * @see {@link ListClustersCommand} */ - public listClusters( - args: ListClustersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listClusters(args: ListClustersCommandInput, cb: (err: any, data?: ListClustersCommandOutput) => void): void; - public listClusters( + listClusters(args: ListClustersCommandInput, options?: __HttpHandlerOptions): Promise; + listClusters(args: ListClustersCommandInput, cb: (err: any, data?: ListClustersCommandOutput) => void): void; + listClusters( args: ListClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListClustersCommandOutput) => void ): void; - public listClusters( - args: ListClustersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListClustersCommandOutput) => void), - cb?: (err: any, data?: ListClustersCommandOutput) => void - ): Promise | void { - const command = new ListClustersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about Elastic DocumentDB snapshots for a specified cluster.

+ * @see {@link ListClusterSnapshotsCommand} */ - public listClusterSnapshots( + listClusterSnapshots( args: ListClusterSnapshotsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listClusterSnapshots( + listClusterSnapshots( args: ListClusterSnapshotsCommandInput, cb: (err: any, data?: ListClusterSnapshotsCommandOutput) => void ): void; - public listClusterSnapshots( + listClusterSnapshots( args: ListClusterSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListClusterSnapshotsCommandOutput) => void ): void; - public listClusterSnapshots( - args: ListClusterSnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListClusterSnapshotsCommandOutput) => void), - cb?: (err: any, data?: ListClusterSnapshotsCommandOutput) => void - ): Promise | void { - const command = new ListClusterSnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all tags on a Elastic DocumentDB resource

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Restores a Elastic DocumentDB cluster from a snapshot.

+ * @see {@link RestoreClusterFromSnapshotCommand} */ - public restoreClusterFromSnapshot( + restoreClusterFromSnapshot( args: RestoreClusterFromSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreClusterFromSnapshot( + restoreClusterFromSnapshot( args: RestoreClusterFromSnapshotCommandInput, cb: (err: any, data?: RestoreClusterFromSnapshotCommandOutput) => void ): void; - public restoreClusterFromSnapshot( + restoreClusterFromSnapshot( args: RestoreClusterFromSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreClusterFromSnapshotCommandOutput) => void ): void; - public restoreClusterFromSnapshot( - args: RestoreClusterFromSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreClusterFromSnapshotCommandOutput) => void), - cb?: (err: any, data?: RestoreClusterFromSnapshotCommandOutput) => void - ): Promise | void { - const command = new RestoreClusterFromSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds metadata tags to a Elastic DocumentDB resource

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes metadata tags to a Elastic DocumentDB resource

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies a Elastic DocumentDB cluster. This includes updating admin-username/password, - * upgrading API version setting up a backup window and maintenance window

+ * @see {@link UpdateClusterCommand} */ - public updateCluster( - args: UpdateClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateCluster( - args: UpdateClusterCommandInput, - cb: (err: any, data?: UpdateClusterCommandOutput) => void - ): void; - public updateCluster( + updateCluster(args: UpdateClusterCommandInput, options?: __HttpHandlerOptions): Promise; + updateCluster(args: UpdateClusterCommandInput, cb: (err: any, data?: UpdateClusterCommandOutput) => void): void; + updateCluster( args: UpdateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateClusterCommandOutput) => void ): void; - public updateCluster( - args: UpdateClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateClusterCommandOutput) => void), - cb?: (err: any, data?: UpdateClusterCommandOutput) => void - ): Promise | void { - const command = new UpdateClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The new Amazon Elastic DocumentDB service endpoint.

+ */ +export class DocDBElastic extends DocDBElasticClient implements DocDBElastic {} +createAggregatedClient(commands, DocDBElastic); diff --git a/clients/client-docdb/src/DocDB.ts b/clients/client-docdb/src/DocDB.ts index d99174987f91..d3ca451ce26d 100644 --- a/clients/client-docdb/src/DocDB.ts +++ b/clients/client-docdb/src/DocDB.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -266,1885 +267,949 @@ import { StopDBClusterCommandInput, StopDBClusterCommandOutput, } from "./commands/StopDBClusterCommand"; -import { DocDBClient } from "./DocDBClient"; +import { DocDBClient, DocDBClientConfig } from "./DocDBClient"; -/** - * @public - *

Amazon DocumentDB API documentation

- */ -export class DocDB extends DocDBClient { +const commands = { + AddSourceIdentifierToSubscriptionCommand, + AddTagsToResourceCommand, + ApplyPendingMaintenanceActionCommand, + CopyDBClusterParameterGroupCommand, + CopyDBClusterSnapshotCommand, + CreateDBClusterCommand, + CreateDBClusterParameterGroupCommand, + CreateDBClusterSnapshotCommand, + CreateDBInstanceCommand, + CreateDBSubnetGroupCommand, + CreateEventSubscriptionCommand, + CreateGlobalClusterCommand, + DeleteDBClusterCommand, + DeleteDBClusterParameterGroupCommand, + DeleteDBClusterSnapshotCommand, + DeleteDBInstanceCommand, + DeleteDBSubnetGroupCommand, + DeleteEventSubscriptionCommand, + DeleteGlobalClusterCommand, + DescribeCertificatesCommand, + DescribeDBClusterParameterGroupsCommand, + DescribeDBClusterParametersCommand, + DescribeDBClustersCommand, + DescribeDBClusterSnapshotAttributesCommand, + DescribeDBClusterSnapshotsCommand, + DescribeDBEngineVersionsCommand, + DescribeDBInstancesCommand, + DescribeDBSubnetGroupsCommand, + DescribeEngineDefaultClusterParametersCommand, + DescribeEventCategoriesCommand, + DescribeEventsCommand, + DescribeEventSubscriptionsCommand, + DescribeGlobalClustersCommand, + DescribeOrderableDBInstanceOptionsCommand, + DescribePendingMaintenanceActionsCommand, + FailoverDBClusterCommand, + ListTagsForResourceCommand, + ModifyDBClusterCommand, + ModifyDBClusterParameterGroupCommand, + ModifyDBClusterSnapshotAttributeCommand, + ModifyDBInstanceCommand, + ModifyDBSubnetGroupCommand, + ModifyEventSubscriptionCommand, + ModifyGlobalClusterCommand, + RebootDBInstanceCommand, + RemoveFromGlobalClusterCommand, + RemoveSourceIdentifierFromSubscriptionCommand, + RemoveTagsFromResourceCommand, + ResetDBClusterParameterGroupCommand, + RestoreDBClusterFromSnapshotCommand, + RestoreDBClusterToPointInTimeCommand, + StartDBClusterCommand, + StopDBClusterCommand, +}; + +export interface DocDB { /** - * @public - *

Adds a source identifier to an existing event notification - * subscription.

+ * @see {@link AddSourceIdentifierToSubscriptionCommand} */ - public addSourceIdentifierToSubscription( + addSourceIdentifierToSubscription( args: AddSourceIdentifierToSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public addSourceIdentifierToSubscription( + addSourceIdentifierToSubscription( args: AddSourceIdentifierToSubscriptionCommandInput, cb: (err: any, data?: AddSourceIdentifierToSubscriptionCommandOutput) => void ): void; - public addSourceIdentifierToSubscription( + addSourceIdentifierToSubscription( args: AddSourceIdentifierToSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddSourceIdentifierToSubscriptionCommandOutput) => void ): void; - public addSourceIdentifierToSubscription( - args: AddSourceIdentifierToSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddSourceIdentifierToSubscriptionCommandOutput) => void), - cb?: (err: any, data?: AddSourceIdentifierToSubscriptionCommandOutput) => void - ): Promise | void { - const command = new AddSourceIdentifierToSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds metadata tags to an Amazon DocumentDB resource. You can use these tags - * with cost allocation reporting to track costs that are associated - * with Amazon DocumentDB resources or in a Condition statement in - * an Identity and Access Management (IAM) policy for Amazon DocumentDB.

+ * @see {@link AddTagsToResourceCommand} */ - public addTagsToResource( + addTagsToResource( args: AddTagsToResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public addTagsToResource( + addTagsToResource( args: AddTagsToResourceCommandInput, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void ): void; - public addTagsToResource( + addTagsToResource( args: AddTagsToResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void ): void; - public addTagsToResource( - args: AddTagsToResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddTagsToResourceCommandOutput) => void), - cb?: (err: any, data?: AddTagsToResourceCommandOutput) => void - ): Promise | void { - const command = new AddTagsToResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Applies a pending maintenance action to a resource (for example, - * to an Amazon DocumentDB instance).

+ * @see {@link ApplyPendingMaintenanceActionCommand} */ - public applyPendingMaintenanceAction( + applyPendingMaintenanceAction( args: ApplyPendingMaintenanceActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public applyPendingMaintenanceAction( + applyPendingMaintenanceAction( args: ApplyPendingMaintenanceActionCommandInput, cb: (err: any, data?: ApplyPendingMaintenanceActionCommandOutput) => void ): void; - public applyPendingMaintenanceAction( + applyPendingMaintenanceAction( args: ApplyPendingMaintenanceActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ApplyPendingMaintenanceActionCommandOutput) => void ): void; - public applyPendingMaintenanceAction( - args: ApplyPendingMaintenanceActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ApplyPendingMaintenanceActionCommandOutput) => void), - cb?: (err: any, data?: ApplyPendingMaintenanceActionCommandOutput) => void - ): Promise | void { - const command = new ApplyPendingMaintenanceActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Copies the specified cluster parameter group.

+ * @see {@link CopyDBClusterParameterGroupCommand} */ - public copyDBClusterParameterGroup( + copyDBClusterParameterGroup( args: CopyDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public copyDBClusterParameterGroup( + copyDBClusterParameterGroup( args: CopyDBClusterParameterGroupCommandInput, cb: (err: any, data?: CopyDBClusterParameterGroupCommandOutput) => void ): void; - public copyDBClusterParameterGroup( + copyDBClusterParameterGroup( args: CopyDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyDBClusterParameterGroupCommandOutput) => void ): void; - public copyDBClusterParameterGroup( - args: CopyDBClusterParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopyDBClusterParameterGroupCommandOutput) => void), - cb?: (err: any, data?: CopyDBClusterParameterGroupCommandOutput) => void - ): Promise | void { - const command = new CopyDBClusterParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Copies a snapshot of a cluster.

- *

To copy a cluster snapshot from a shared manual cluster snapshot, - * SourceDBClusterSnapshotIdentifier must be the Amazon - * Resource Name (ARN) of the shared cluster snapshot. You can only - * copy a shared DB cluster snapshot, whether encrypted or not, in the - * same Amazon Web Services Region.

- *

To cancel the copy operation after it is in progress, delete the - * target cluster snapshot identified by - * TargetDBClusterSnapshotIdentifier while that cluster - * snapshot is in the copying status.

+ * @see {@link CopyDBClusterSnapshotCommand} */ - public copyDBClusterSnapshot( + copyDBClusterSnapshot( args: CopyDBClusterSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public copyDBClusterSnapshot( + copyDBClusterSnapshot( args: CopyDBClusterSnapshotCommandInput, cb: (err: any, data?: CopyDBClusterSnapshotCommandOutput) => void ): void; - public copyDBClusterSnapshot( + copyDBClusterSnapshot( args: CopyDBClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyDBClusterSnapshotCommandOutput) => void ): void; - public copyDBClusterSnapshot( - args: CopyDBClusterSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopyDBClusterSnapshotCommandOutput) => void), - cb?: (err: any, data?: CopyDBClusterSnapshotCommandOutput) => void - ): Promise | void { - const command = new CopyDBClusterSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new Amazon DocumentDB cluster.

+ * @see {@link CreateDBClusterCommand} */ - public createDBCluster( + createDBCluster( args: CreateDBClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDBCluster( - args: CreateDBClusterCommandInput, - cb: (err: any, data?: CreateDBClusterCommandOutput) => void - ): void; - public createDBCluster( + createDBCluster(args: CreateDBClusterCommandInput, cb: (err: any, data?: CreateDBClusterCommandOutput) => void): void; + createDBCluster( args: CreateDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBClusterCommandOutput) => void ): void; - public createDBCluster( - args: CreateDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBClusterCommandOutput) => void), - cb?: (err: any, data?: CreateDBClusterCommandOutput) => void - ): Promise | void { - const command = new CreateDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new cluster parameter group.

- *

Parameters in a cluster parameter group apply to all of the - * instances in a cluster.

- *

A cluster parameter group is initially created with the default - * parameters for the database engine used by instances in the cluster. - * In Amazon DocumentDB, you cannot make modifications directly to the - * default.docdb3.6 cluster parameter group. If your - * Amazon DocumentDB cluster is using the default cluster parameter group and you - * want to modify a value in it, you must first - * create a new parameter group - * or - * copy an existing parameter group, - * modify it, and then apply the modified parameter group to your - * cluster. For the new cluster parameter group and associated settings - * to take effect, you must then reboot the instances in the cluster - * without failover. For more information, - * see - * Modifying Amazon DocumentDB Cluster Parameter Groups. - *

+ * @see {@link CreateDBClusterParameterGroupCommand} */ - public createDBClusterParameterGroup( + createDBClusterParameterGroup( args: CreateDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDBClusterParameterGroup( + createDBClusterParameterGroup( args: CreateDBClusterParameterGroupCommandInput, cb: (err: any, data?: CreateDBClusterParameterGroupCommandOutput) => void ): void; - public createDBClusterParameterGroup( + createDBClusterParameterGroup( args: CreateDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBClusterParameterGroupCommandOutput) => void ): void; - public createDBClusterParameterGroup( - args: CreateDBClusterParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBClusterParameterGroupCommandOutput) => void), - cb?: (err: any, data?: CreateDBClusterParameterGroupCommandOutput) => void - ): Promise | void { - const command = new CreateDBClusterParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a snapshot of a cluster.

+ * @see {@link CreateDBClusterSnapshotCommand} */ - public createDBClusterSnapshot( + createDBClusterSnapshot( args: CreateDBClusterSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDBClusterSnapshot( + createDBClusterSnapshot( args: CreateDBClusterSnapshotCommandInput, cb: (err: any, data?: CreateDBClusterSnapshotCommandOutput) => void ): void; - public createDBClusterSnapshot( + createDBClusterSnapshot( args: CreateDBClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBClusterSnapshotCommandOutput) => void ): void; - public createDBClusterSnapshot( - args: CreateDBClusterSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBClusterSnapshotCommandOutput) => void), - cb?: (err: any, data?: CreateDBClusterSnapshotCommandOutput) => void - ): Promise | void { - const command = new CreateDBClusterSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new instance.

+ * @see {@link CreateDBInstanceCommand} */ - public createDBInstance( + createDBInstance( args: CreateDBInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDBInstance( + createDBInstance( args: CreateDBInstanceCommandInput, cb: (err: any, data?: CreateDBInstanceCommandOutput) => void ): void; - public createDBInstance( + createDBInstance( args: CreateDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBInstanceCommandOutput) => void ): void; - public createDBInstance( - args: CreateDBInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBInstanceCommandOutput) => void), - cb?: (err: any, data?: CreateDBInstanceCommandOutput) => void - ): Promise | void { - const command = new CreateDBInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new subnet group. subnet groups must contain at least one subnet in at - * least two Availability Zones in the Amazon Web Services Region.

+ * @see {@link CreateDBSubnetGroupCommand} */ - public createDBSubnetGroup( + createDBSubnetGroup( args: CreateDBSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDBSubnetGroup( + createDBSubnetGroup( args: CreateDBSubnetGroupCommandInput, cb: (err: any, data?: CreateDBSubnetGroupCommandOutput) => void ): void; - public createDBSubnetGroup( + createDBSubnetGroup( args: CreateDBSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBSubnetGroupCommandOutput) => void ): void; - public createDBSubnetGroup( - args: CreateDBSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: CreateDBSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new CreateDBSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.

- *

You can specify the type of source (SourceType) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

- *

If you specify both the SourceType and SourceIds (such as SourceType = db-instance and SourceIdentifier = myDBInstance1), you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the SourceType or the SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.

+ * @see {@link CreateEventSubscriptionCommand} */ - public createEventSubscription( + createEventSubscription( args: CreateEventSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEventSubscription( + createEventSubscription( args: CreateEventSubscriptionCommandInput, cb: (err: any, data?: CreateEventSubscriptionCommandOutput) => void ): void; - public createEventSubscription( + createEventSubscription( args: CreateEventSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEventSubscriptionCommandOutput) => void ): void; - public createEventSubscription( - args: CreateEventSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEventSubscriptionCommandOutput) => void), - cb?: (err: any, data?: CreateEventSubscriptionCommandOutput) => void - ): Promise | void { - const command = new CreateEventSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.

- *

- *

You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster.

- * - *

This action only applies to Amazon DocumentDB clusters.

- *
+ * @see {@link CreateGlobalClusterCommand} */ - public createGlobalCluster( + createGlobalCluster( args: CreateGlobalClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public createGlobalCluster( + createGlobalCluster( args: CreateGlobalClusterCommandInput, cb: (err: any, data?: CreateGlobalClusterCommandOutput) => void ): void; - public createGlobalCluster( + createGlobalCluster( args: CreateGlobalClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGlobalClusterCommandOutput) => void ): void; - public createGlobalCluster( - args: CreateGlobalClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGlobalClusterCommandOutput) => void), - cb?: (err: any, data?: CreateGlobalClusterCommandOutput) => void - ): Promise | void { - const command = new CreateGlobalClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.

- *

+ * @see {@link DeleteDBClusterCommand} */ - public deleteDBCluster( + deleteDBCluster( args: DeleteDBClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDBCluster( - args: DeleteDBClusterCommandInput, - cb: (err: any, data?: DeleteDBClusterCommandOutput) => void - ): void; - public deleteDBCluster( + deleteDBCluster(args: DeleteDBClusterCommandInput, cb: (err: any, data?: DeleteDBClusterCommandOutput) => void): void; + deleteDBCluster( args: DeleteDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBClusterCommandOutput) => void ): void; - public deleteDBCluster( - args: DeleteDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBClusterCommandOutput) => void), - cb?: (err: any, data?: DeleteDBClusterCommandOutput) => void - ): Promise | void { - const command = new DeleteDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.

+ * @see {@link DeleteDBClusterParameterGroupCommand} */ - public deleteDBClusterParameterGroup( + deleteDBClusterParameterGroup( args: DeleteDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDBClusterParameterGroup( + deleteDBClusterParameterGroup( args: DeleteDBClusterParameterGroupCommandInput, cb: (err: any, data?: DeleteDBClusterParameterGroupCommandOutput) => void ): void; - public deleteDBClusterParameterGroup( + deleteDBClusterParameterGroup( args: DeleteDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBClusterParameterGroupCommandOutput) => void ): void; - public deleteDBClusterParameterGroup( - args: DeleteDBClusterParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBClusterParameterGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteDBClusterParameterGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteDBClusterParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

- * - *

The cluster snapshot must be in the available state to be deleted.

- *
+ * @see {@link DeleteDBClusterSnapshotCommand} */ - public deleteDBClusterSnapshot( + deleteDBClusterSnapshot( args: DeleteDBClusterSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDBClusterSnapshot( + deleteDBClusterSnapshot( args: DeleteDBClusterSnapshotCommandInput, cb: (err: any, data?: DeleteDBClusterSnapshotCommandOutput) => void ): void; - public deleteDBClusterSnapshot( + deleteDBClusterSnapshot( args: DeleteDBClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBClusterSnapshotCommandOutput) => void ): void; - public deleteDBClusterSnapshot( - args: DeleteDBClusterSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBClusterSnapshotCommandOutput) => void), - cb?: (err: any, data?: DeleteDBClusterSnapshotCommandOutput) => void - ): Promise | void { - const command = new DeleteDBClusterSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a previously provisioned instance.

+ * @see {@link DeleteDBInstanceCommand} */ - public deleteDBInstance( + deleteDBInstance( args: DeleteDBInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDBInstance( + deleteDBInstance( args: DeleteDBInstanceCommandInput, cb: (err: any, data?: DeleteDBInstanceCommandOutput) => void ): void; - public deleteDBInstance( + deleteDBInstance( args: DeleteDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBInstanceCommandOutput) => void ): void; - public deleteDBInstance( - args: DeleteDBInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBInstanceCommandOutput) => void), - cb?: (err: any, data?: DeleteDBInstanceCommandOutput) => void - ): Promise | void { - const command = new DeleteDBInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a subnet group.

- * - *

The specified database subnet group must not be associated with any DB - * instances.

- *
+ * @see {@link DeleteDBSubnetGroupCommand} */ - public deleteDBSubnetGroup( + deleteDBSubnetGroup( args: DeleteDBSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDBSubnetGroup( + deleteDBSubnetGroup( args: DeleteDBSubnetGroupCommandInput, cb: (err: any, data?: DeleteDBSubnetGroupCommandOutput) => void ): void; - public deleteDBSubnetGroup( + deleteDBSubnetGroup( args: DeleteDBSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBSubnetGroupCommandOutput) => void ): void; - public deleteDBSubnetGroup( - args: DeleteDBSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteDBSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteDBSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon DocumentDB event notification subscription.

+ * @see {@link DeleteEventSubscriptionCommand} */ - public deleteEventSubscription( + deleteEventSubscription( args: DeleteEventSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEventSubscription( + deleteEventSubscription( args: DeleteEventSubscriptionCommandInput, cb: (err: any, data?: DeleteEventSubscriptionCommandOutput) => void ): void; - public deleteEventSubscription( + deleteEventSubscription( args: DeleteEventSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventSubscriptionCommandOutput) => void ): void; - public deleteEventSubscription( - args: DeleteEventSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEventSubscriptionCommandOutput) => void), - cb?: (err: any, data?: DeleteEventSubscriptionCommandOutput) => void - ): Promise | void { - const command = new DeleteEventSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.

- * - *

This action only applies to Amazon DocumentDB clusters.

- *
+ * @see {@link DeleteGlobalClusterCommand} */ - public deleteGlobalCluster( + deleteGlobalCluster( args: DeleteGlobalClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteGlobalCluster( + deleteGlobalCluster( args: DeleteGlobalClusterCommandInput, cb: (err: any, data?: DeleteGlobalClusterCommandOutput) => void ): void; - public deleteGlobalCluster( + deleteGlobalCluster( args: DeleteGlobalClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGlobalClusterCommandOutput) => void ): void; - public deleteGlobalCluster( - args: DeleteGlobalClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGlobalClusterCommandOutput) => void), - cb?: (err: any, data?: DeleteGlobalClusterCommandOutput) => void - ): Promise | void { - const command = new DeleteGlobalClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.

+ * @see {@link DescribeCertificatesCommand} */ - public describeCertificates( + describeCertificates( args: DescribeCertificatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCertificates( + describeCertificates( args: DescribeCertificatesCommandInput, cb: (err: any, data?: DescribeCertificatesCommandOutput) => void ): void; - public describeCertificates( + describeCertificates( args: DescribeCertificatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCertificatesCommandOutput) => void ): void; - public describeCertificates( - args: DescribeCertificatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCertificatesCommandOutput) => void), - cb?: (err: any, data?: DescribeCertificatesCommandOutput) => void - ): Promise | void { - const command = new DescribeCertificatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified cluster parameter group.

+ * @see {@link DescribeDBClusterParameterGroupsCommand} */ - public describeDBClusterParameterGroups( + describeDBClusterParameterGroups( args: DescribeDBClusterParameterGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBClusterParameterGroups( + describeDBClusterParameterGroups( args: DescribeDBClusterParameterGroupsCommandInput, cb: (err: any, data?: DescribeDBClusterParameterGroupsCommandOutput) => void ): void; - public describeDBClusterParameterGroups( + describeDBClusterParameterGroups( args: DescribeDBClusterParameterGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterParameterGroupsCommandOutput) => void ): void; - public describeDBClusterParameterGroups( - args: DescribeDBClusterParameterGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBClusterParameterGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeDBClusterParameterGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeDBClusterParameterGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the detailed parameter list for a particular cluster parameter - * group.

+ * @see {@link DescribeDBClusterParametersCommand} */ - public describeDBClusterParameters( + describeDBClusterParameters( args: DescribeDBClusterParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBClusterParameters( + describeDBClusterParameters( args: DescribeDBClusterParametersCommandInput, cb: (err: any, data?: DescribeDBClusterParametersCommandOutput) => void ): void; - public describeDBClusterParameters( + describeDBClusterParameters( args: DescribeDBClusterParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterParametersCommandOutput) => void ): void; - public describeDBClusterParameters( - args: DescribeDBClusterParametersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBClusterParametersCommandOutput) => void), - cb?: (err: any, data?: DescribeDBClusterParametersCommandOutput) => void - ): Promise | void { - const command = new DescribeDBClusterParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about provisioned Amazon DocumentDB clusters. This API - * operation supports pagination. For certain management features - * such as cluster and instance lifecycle management, Amazon DocumentDB leverages - * operational technology that is shared with Amazon RDS and Amazon - * Neptune. Use the filterName=engine,Values=docdb filter - * parameter to return only Amazon DocumentDB clusters.

+ * @see {@link DescribeDBClustersCommand} */ - public describeDBClusters( + describeDBClusters( args: DescribeDBClustersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBClusters( + describeDBClusters( args: DescribeDBClustersCommandInput, cb: (err: any, data?: DescribeDBClustersCommandOutput) => void ): void; - public describeDBClusters( + describeDBClusters( args: DescribeDBClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClustersCommandOutput) => void ): void; - public describeDBClusters( - args: DescribeDBClustersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBClustersCommandOutput) => void), - cb?: (err: any, data?: DescribeDBClustersCommandOutput) => void - ): Promise | void { - const command = new DescribeDBClustersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of cluster snapshot attribute names and values for a manual DB - * cluster snapshot.

- *

When you share snapshots with other Amazon Web Services accounts, - * DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.

+ * @see {@link DescribeDBClusterSnapshotAttributesCommand} */ - public describeDBClusterSnapshotAttributes( + describeDBClusterSnapshotAttributes( args: DescribeDBClusterSnapshotAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBClusterSnapshotAttributes( + describeDBClusterSnapshotAttributes( args: DescribeDBClusterSnapshotAttributesCommandInput, cb: (err: any, data?: DescribeDBClusterSnapshotAttributesCommandOutput) => void ): void; - public describeDBClusterSnapshotAttributes( + describeDBClusterSnapshotAttributes( args: DescribeDBClusterSnapshotAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterSnapshotAttributesCommandOutput) => void ): void; - public describeDBClusterSnapshotAttributes( - args: DescribeDBClusterSnapshotAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBClusterSnapshotAttributesCommandOutput) => void), - cb?: (err: any, data?: DescribeDBClusterSnapshotAttributesCommandOutput) => void - ): Promise | void { - const command = new DescribeDBClusterSnapshotAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about cluster snapshots. This API operation supports pagination.

+ * @see {@link DescribeDBClusterSnapshotsCommand} */ - public describeDBClusterSnapshots( + describeDBClusterSnapshots( args: DescribeDBClusterSnapshotsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBClusterSnapshots( + describeDBClusterSnapshots( args: DescribeDBClusterSnapshotsCommandInput, cb: (err: any, data?: DescribeDBClusterSnapshotsCommandOutput) => void ): void; - public describeDBClusterSnapshots( + describeDBClusterSnapshots( args: DescribeDBClusterSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterSnapshotsCommandOutput) => void ): void; - public describeDBClusterSnapshots( - args: DescribeDBClusterSnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBClusterSnapshotsCommandOutput) => void), - cb?: (err: any, data?: DescribeDBClusterSnapshotsCommandOutput) => void - ): Promise | void { - const command = new DescribeDBClusterSnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the available engines.

+ * @see {@link DescribeDBEngineVersionsCommand} */ - public describeDBEngineVersions( + describeDBEngineVersions( args: DescribeDBEngineVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBEngineVersions( + describeDBEngineVersions( args: DescribeDBEngineVersionsCommandInput, cb: (err: any, data?: DescribeDBEngineVersionsCommandOutput) => void ): void; - public describeDBEngineVersions( + describeDBEngineVersions( args: DescribeDBEngineVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBEngineVersionsCommandOutput) => void ): void; - public describeDBEngineVersions( - args: DescribeDBEngineVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBEngineVersionsCommandOutput) => void), - cb?: (err: any, data?: DescribeDBEngineVersionsCommandOutput) => void - ): Promise | void { - const command = new DescribeDBEngineVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.

+ * @see {@link DescribeDBInstancesCommand} */ - public describeDBInstances( + describeDBInstances( args: DescribeDBInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBInstances( + describeDBInstances( args: DescribeDBInstancesCommandInput, cb: (err: any, data?: DescribeDBInstancesCommandOutput) => void ): void; - public describeDBInstances( + describeDBInstances( args: DescribeDBInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBInstancesCommandOutput) => void ): void; - public describeDBInstances( - args: DescribeDBInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBInstancesCommandOutput) => void), - cb?: (err: any, data?: DescribeDBInstancesCommandOutput) => void - ): Promise | void { - const command = new DescribeDBInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of DBSubnetGroup descriptions. If a - * DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

+ * @see {@link DescribeDBSubnetGroupsCommand} */ - public describeDBSubnetGroups( + describeDBSubnetGroups( args: DescribeDBSubnetGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBSubnetGroups( + describeDBSubnetGroups( args: DescribeDBSubnetGroupsCommandInput, cb: (err: any, data?: DescribeDBSubnetGroupsCommandOutput) => void ): void; - public describeDBSubnetGroups( + describeDBSubnetGroups( args: DescribeDBSubnetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBSubnetGroupsCommandOutput) => void ): void; - public describeDBSubnetGroups( - args: DescribeDBSubnetGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBSubnetGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeDBSubnetGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeDBSubnetGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the default engine and system parameter information for the cluster database - * engine.

+ * @see {@link DescribeEngineDefaultClusterParametersCommand} */ - public describeEngineDefaultClusterParameters( + describeEngineDefaultClusterParameters( args: DescribeEngineDefaultClusterParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEngineDefaultClusterParameters( + describeEngineDefaultClusterParameters( args: DescribeEngineDefaultClusterParametersCommandInput, cb: (err: any, data?: DescribeEngineDefaultClusterParametersCommandOutput) => void ): void; - public describeEngineDefaultClusterParameters( + describeEngineDefaultClusterParameters( args: DescribeEngineDefaultClusterParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEngineDefaultClusterParametersCommandOutput) => void ): void; - public describeEngineDefaultClusterParameters( - args: DescribeEngineDefaultClusterParametersCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeEngineDefaultClusterParametersCommandOutput) => void), - cb?: (err: any, data?: DescribeEngineDefaultClusterParametersCommandOutput) => void - ): Promise | void { - const command = new DescribeEngineDefaultClusterParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays a list of categories for all event source types, or, if specified, for a - * specified source type.

+ * @see {@link DescribeEventCategoriesCommand} */ - public describeEventCategories( + describeEventCategories( args: DescribeEventCategoriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventCategories( + describeEventCategories( args: DescribeEventCategoriesCommandInput, cb: (err: any, data?: DescribeEventCategoriesCommandOutput) => void ): void; - public describeEventCategories( + describeEventCategories( args: DescribeEventCategoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventCategoriesCommandOutput) => void ): void; - public describeEventCategories( - args: DescribeEventCategoriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventCategoriesCommandOutput) => void), - cb?: (err: any, data?: DescribeEventCategoriesCommandOutput) => void - ): Promise | void { - const command = new DescribeEventCategoriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.

+ * @see {@link DescribeEventsCommand} */ - public describeEvents( + describeEvents( args: DescribeEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEvents( - args: DescribeEventsCommandInput, - cb: (err: any, data?: DescribeEventsCommandOutput) => void - ): void; - public describeEvents( + describeEvents(args: DescribeEventsCommandInput, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void; + describeEvents( args: DescribeEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsCommandOutput) => void ): void; - public describeEvents( - args: DescribeEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventsCommandOutput) => void), - cb?: (err: any, data?: DescribeEventsCommandOutput) => void - ): Promise | void { - const command = new DescribeEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

- *

If you specify a SubscriptionName, lists the description for that subscription.

+ * @see {@link DescribeEventSubscriptionsCommand} */ - public describeEventSubscriptions( + describeEventSubscriptions( args: DescribeEventSubscriptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventSubscriptions( + describeEventSubscriptions( args: DescribeEventSubscriptionsCommandInput, cb: (err: any, data?: DescribeEventSubscriptionsCommandOutput) => void ): void; - public describeEventSubscriptions( + describeEventSubscriptions( args: DescribeEventSubscriptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventSubscriptionsCommandOutput) => void ): void; - public describeEventSubscriptions( - args: DescribeEventSubscriptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventSubscriptionsCommandOutput) => void), - cb?: (err: any, data?: DescribeEventSubscriptionsCommandOutput) => void - ): Promise | void { - const command = new DescribeEventSubscriptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about Amazon DocumentDB global clusters. This API supports pagination.

- * - *

This action only applies to Amazon DocumentDB clusters.

- *
+ * @see {@link DescribeGlobalClustersCommand} */ - public describeGlobalClusters( + describeGlobalClusters( args: DescribeGlobalClustersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGlobalClusters( + describeGlobalClusters( args: DescribeGlobalClustersCommandInput, cb: (err: any, data?: DescribeGlobalClustersCommandOutput) => void ): void; - public describeGlobalClusters( + describeGlobalClusters( args: DescribeGlobalClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGlobalClustersCommandOutput) => void ): void; - public describeGlobalClusters( - args: DescribeGlobalClustersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGlobalClustersCommandOutput) => void), - cb?: (err: any, data?: DescribeGlobalClustersCommandOutput) => void - ): Promise | void { - const command = new DescribeGlobalClustersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of orderable instance options for the specified engine.

+ * @see {@link DescribeOrderableDBInstanceOptionsCommand} */ - public describeOrderableDBInstanceOptions( + describeOrderableDBInstanceOptions( args: DescribeOrderableDBInstanceOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOrderableDBInstanceOptions( + describeOrderableDBInstanceOptions( args: DescribeOrderableDBInstanceOptionsCommandInput, cb: (err: any, data?: DescribeOrderableDBInstanceOptionsCommandOutput) => void ): void; - public describeOrderableDBInstanceOptions( + describeOrderableDBInstanceOptions( args: DescribeOrderableDBInstanceOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrderableDBInstanceOptionsCommandOutput) => void ): void; - public describeOrderableDBInstanceOptions( - args: DescribeOrderableDBInstanceOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOrderableDBInstanceOptionsCommandOutput) => void), - cb?: (err: any, data?: DescribeOrderableDBInstanceOptionsCommandOutput) => void - ): Promise | void { - const command = new DescribeOrderableDBInstanceOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of resources (for example, instances) that have at least one pending - * maintenance action.

+ * @see {@link DescribePendingMaintenanceActionsCommand} */ - public describePendingMaintenanceActions( + describePendingMaintenanceActions( args: DescribePendingMaintenanceActionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePendingMaintenanceActions( + describePendingMaintenanceActions( args: DescribePendingMaintenanceActionsCommandInput, cb: (err: any, data?: DescribePendingMaintenanceActionsCommandOutput) => void ): void; - public describePendingMaintenanceActions( + describePendingMaintenanceActions( args: DescribePendingMaintenanceActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePendingMaintenanceActionsCommandOutput) => void ): void; - public describePendingMaintenanceActions( - args: DescribePendingMaintenanceActionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePendingMaintenanceActionsCommandOutput) => void), - cb?: (err: any, data?: DescribePendingMaintenanceActionsCommandOutput) => void - ): Promise | void { - const command = new DescribePendingMaintenanceActionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Forces a failover for a cluster.

- *

A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).

- *

If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.

+ * @see {@link FailoverDBClusterCommand} */ - public failoverDBCluster( + failoverDBCluster( args: FailoverDBClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public failoverDBCluster( + failoverDBCluster( args: FailoverDBClusterCommandInput, cb: (err: any, data?: FailoverDBClusterCommandOutput) => void ): void; - public failoverDBCluster( + failoverDBCluster( args: FailoverDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FailoverDBClusterCommandOutput) => void ): void; - public failoverDBCluster( - args: FailoverDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FailoverDBClusterCommandOutput) => void), - cb?: (err: any, data?: FailoverDBClusterCommandOutput) => void - ): Promise | void { - const command = new FailoverDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all tags on an Amazon DocumentDB resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database - * configuration parameters by specifying these parameters and the new values in the - * request.

+ * @see {@link ModifyDBClusterCommand} */ - public modifyDBCluster( + modifyDBCluster( args: ModifyDBClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDBCluster( - args: ModifyDBClusterCommandInput, - cb: (err: any, data?: ModifyDBClusterCommandOutput) => void - ): void; - public modifyDBCluster( + modifyDBCluster(args: ModifyDBClusterCommandInput, cb: (err: any, data?: ModifyDBClusterCommandOutput) => void): void; + modifyDBCluster( args: ModifyDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBClusterCommandOutput) => void ): void; - public modifyDBCluster( - args: ModifyDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBClusterCommandOutput) => void), - cb?: (err: any, data?: ModifyDBClusterCommandOutput) => void - ): Promise | void { - const command = new ModifyDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the parameters of a cluster parameter group. To modify more than one - * parameter, submit a list of the following: ParameterName, - * ParameterValue, and ApplyMethod. A maximum of 20 - * parameters can be modified in a single request.

- * - *

Changes to dynamic parameters are applied immediately. Changes to static - * parameters require a reboot or maintenance window - * - * before the change can take effect.

- *
- * - *

After you create a cluster parameter group, you should wait at least 5 minutes - * before creating your first cluster that uses that cluster parameter group as - * the default parameter group. This allows Amazon DocumentDB to fully complete the create action - * before the parameter group is used as the default for a new cluster. This step is - * especially important for parameters that are critical when creating the default - * database for a cluster, such as the character set for the default database - * defined by the character_set_database parameter.

- *
+ * @see {@link ModifyDBClusterParameterGroupCommand} */ - public modifyDBClusterParameterGroup( + modifyDBClusterParameterGroup( args: ModifyDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDBClusterParameterGroup( + modifyDBClusterParameterGroup( args: ModifyDBClusterParameterGroupCommandInput, cb: (err: any, data?: ModifyDBClusterParameterGroupCommandOutput) => void ): void; - public modifyDBClusterParameterGroup( + modifyDBClusterParameterGroup( args: ModifyDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBClusterParameterGroupCommandOutput) => void ): void; - public modifyDBClusterParameterGroup( - args: ModifyDBClusterParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBClusterParameterGroupCommandOutput) => void), - cb?: (err: any, data?: ModifyDBClusterParameterGroupCommandOutput) => void - ): Promise | void { - const command = new ModifyDBClusterParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.

- *

To share a manual cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual cluster snapshot. Use the value all to make the manual cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Do not add the all value for any manual cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

+ * @see {@link ModifyDBClusterSnapshotAttributeCommand} */ - public modifyDBClusterSnapshotAttribute( + modifyDBClusterSnapshotAttribute( args: ModifyDBClusterSnapshotAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDBClusterSnapshotAttribute( + modifyDBClusterSnapshotAttribute( args: ModifyDBClusterSnapshotAttributeCommandInput, cb: (err: any, data?: ModifyDBClusterSnapshotAttributeCommandOutput) => void ): void; - public modifyDBClusterSnapshotAttribute( + modifyDBClusterSnapshotAttribute( args: ModifyDBClusterSnapshotAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBClusterSnapshotAttributeCommandOutput) => void ): void; - public modifyDBClusterSnapshotAttribute( - args: ModifyDBClusterSnapshotAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBClusterSnapshotAttributeCommandOutput) => void), - cb?: (err: any, data?: ModifyDBClusterSnapshotAttributeCommandOutput) => void - ): Promise | void { - const command = new ModifyDBClusterSnapshotAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

+ * @see {@link ModifyDBInstanceCommand} */ - public modifyDBInstance( + modifyDBInstance( args: ModifyDBInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDBInstance( + modifyDBInstance( args: ModifyDBInstanceCommandInput, cb: (err: any, data?: ModifyDBInstanceCommandOutput) => void ): void; - public modifyDBInstance( + modifyDBInstance( args: ModifyDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBInstanceCommandOutput) => void ): void; - public modifyDBInstance( - args: ModifyDBInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBInstanceCommandOutput) => void), - cb?: (err: any, data?: ModifyDBInstanceCommandOutput) => void - ): Promise | void { - const command = new ModifyDBInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.

+ * @see {@link ModifyDBSubnetGroupCommand} */ - public modifyDBSubnetGroup( + modifyDBSubnetGroup( args: ModifyDBSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDBSubnetGroup( + modifyDBSubnetGroup( args: ModifyDBSubnetGroupCommandInput, cb: (err: any, data?: ModifyDBSubnetGroupCommandOutput) => void ): void; - public modifyDBSubnetGroup( + modifyDBSubnetGroup( args: ModifyDBSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBSubnetGroupCommandOutput) => void ): void; - public modifyDBSubnetGroup( - args: ModifyDBSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: ModifyDBSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new ModifyDBSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies an existing Amazon DocumentDB event notification subscription.

+ * @see {@link ModifyEventSubscriptionCommand} */ - public modifyEventSubscription( + modifyEventSubscription( args: ModifyEventSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyEventSubscription( + modifyEventSubscription( args: ModifyEventSubscriptionCommandInput, cb: (err: any, data?: ModifyEventSubscriptionCommandOutput) => void ): void; - public modifyEventSubscription( + modifyEventSubscription( args: ModifyEventSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyEventSubscriptionCommandOutput) => void ): void; - public modifyEventSubscription( - args: ModifyEventSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyEventSubscriptionCommandOutput) => void), - cb?: (err: any, data?: ModifyEventSubscriptionCommandOutput) => void - ): Promise | void { - const command = new ModifyEventSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.

- * - *

This action only applies to Amazon DocumentDB clusters.

- *
+ * @see {@link ModifyGlobalClusterCommand} */ - public modifyGlobalCluster( + modifyGlobalCluster( args: ModifyGlobalClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyGlobalCluster( + modifyGlobalCluster( args: ModifyGlobalClusterCommandInput, cb: (err: any, data?: ModifyGlobalClusterCommandOutput) => void ): void; - public modifyGlobalCluster( + modifyGlobalCluster( args: ModifyGlobalClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyGlobalClusterCommandOutput) => void ): void; - public modifyGlobalCluster( - args: ModifyGlobalClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyGlobalClusterCommandOutput) => void), - cb?: (err: any, data?: ModifyGlobalClusterCommandOutput) => void - ): Promise | void { - const command = new ModifyGlobalClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

You might need to reboot your instance, usually for maintenance reasons. For - * example, if you make certain changes, or if you change the cluster parameter group - * that is associated with the instance, you must reboot the instance for the changes to - * take effect.

- *

Rebooting an instance restarts the database engine service. Rebooting an instance - * results in a momentary outage, during which the instance status is set to - * rebooting.

+ * @see {@link RebootDBInstanceCommand} */ - public rebootDBInstance( + rebootDBInstance( args: RebootDBInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public rebootDBInstance( + rebootDBInstance( args: RebootDBInstanceCommandInput, cb: (err: any, data?: RebootDBInstanceCommandOutput) => void ): void; - public rebootDBInstance( + rebootDBInstance( args: RebootDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebootDBInstanceCommandOutput) => void ): void; - public rebootDBInstance( - args: RebootDBInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RebootDBInstanceCommandOutput) => void), - cb?: (err: any, data?: RebootDBInstanceCommandOutput) => void - ): Promise | void { - const command = new RebootDBInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region.

- * - *

This action only applies to Amazon DocumentDB clusters.

- *
+ * @see {@link RemoveFromGlobalClusterCommand} */ - public removeFromGlobalCluster( + removeFromGlobalCluster( args: RemoveFromGlobalClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeFromGlobalCluster( + removeFromGlobalCluster( args: RemoveFromGlobalClusterCommandInput, cb: (err: any, data?: RemoveFromGlobalClusterCommandOutput) => void ): void; - public removeFromGlobalCluster( + removeFromGlobalCluster( args: RemoveFromGlobalClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveFromGlobalClusterCommandOutput) => void ): void; - public removeFromGlobalCluster( - args: RemoveFromGlobalClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveFromGlobalClusterCommandOutput) => void), - cb?: (err: any, data?: RemoveFromGlobalClusterCommandOutput) => void - ): Promise | void { - const command = new RemoveFromGlobalClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a source identifier from an existing Amazon DocumentDB event notification - * subscription.

+ * @see {@link RemoveSourceIdentifierFromSubscriptionCommand} */ - public removeSourceIdentifierFromSubscription( + removeSourceIdentifierFromSubscription( args: RemoveSourceIdentifierFromSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeSourceIdentifierFromSubscription( + removeSourceIdentifierFromSubscription( args: RemoveSourceIdentifierFromSubscriptionCommandInput, cb: (err: any, data?: RemoveSourceIdentifierFromSubscriptionCommandOutput) => void ): void; - public removeSourceIdentifierFromSubscription( + removeSourceIdentifierFromSubscription( args: RemoveSourceIdentifierFromSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveSourceIdentifierFromSubscriptionCommandOutput) => void ): void; - public removeSourceIdentifierFromSubscription( - args: RemoveSourceIdentifierFromSubscriptionCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: RemoveSourceIdentifierFromSubscriptionCommandOutput) => void), - cb?: (err: any, data?: RemoveSourceIdentifierFromSubscriptionCommandOutput) => void - ): Promise | void { - const command = new RemoveSourceIdentifierFromSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes metadata tags from an Amazon DocumentDB resource.

+ * @see {@link RemoveTagsFromResourceCommand} */ - public removeTagsFromResource( + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeTagsFromResource( + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void ): void; - public removeTagsFromResource( + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void ): void; - public removeTagsFromResource( - args: RemoveTagsFromResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveTagsFromResourceCommandOutput) => void), - cb?: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void - ): Promise | void { - const command = new RemoveTagsFromResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the parameters of a cluster parameter group to the default value. To - * reset specific parameters, submit a list of the following: ParameterName - * and ApplyMethod. To reset the entire cluster parameter group, specify - * the DBClusterParameterGroupName and ResetAllParameters - * parameters.

- *

When you reset the entire group, dynamic parameters are updated immediately and - * static parameters are set to pending-reboot to take effect on the next DB - * instance reboot.

+ * @see {@link ResetDBClusterParameterGroupCommand} */ - public resetDBClusterParameterGroup( + resetDBClusterParameterGroup( args: ResetDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetDBClusterParameterGroup( + resetDBClusterParameterGroup( args: ResetDBClusterParameterGroupCommandInput, cb: (err: any, data?: ResetDBClusterParameterGroupCommandOutput) => void ): void; - public resetDBClusterParameterGroup( + resetDBClusterParameterGroup( args: ResetDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetDBClusterParameterGroupCommandOutput) => void ): void; - public resetDBClusterParameterGroup( - args: ResetDBClusterParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetDBClusterParameterGroupCommandOutput) => void), - cb?: (err: any, data?: ResetDBClusterParameterGroupCommandOutput) => void - ): Promise | void { - const command = new ResetDBClusterParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new cluster from a snapshot or cluster snapshot.

- *

If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group.

- *

If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.

+ * @see {@link RestoreDBClusterFromSnapshotCommand} */ - public restoreDBClusterFromSnapshot( + restoreDBClusterFromSnapshot( args: RestoreDBClusterFromSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreDBClusterFromSnapshot( + restoreDBClusterFromSnapshot( args: RestoreDBClusterFromSnapshotCommandInput, cb: (err: any, data?: RestoreDBClusterFromSnapshotCommandOutput) => void ): void; - public restoreDBClusterFromSnapshot( + restoreDBClusterFromSnapshot( args: RestoreDBClusterFromSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreDBClusterFromSnapshotCommandOutput) => void ): void; - public restoreDBClusterFromSnapshot( - args: RestoreDBClusterFromSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreDBClusterFromSnapshotCommandOutput) => void), - cb?: (err: any, data?: RestoreDBClusterFromSnapshotCommandOutput) => void - ): Promise | void { - const command = new RestoreDBClusterFromSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Restores a cluster to an arbitrary point in time. Users can restore to any point in - * time before LatestRestorableTime for up to - * BackupRetentionPeriod days. The target cluster is created from the - * source cluster with the same configuration as the original cluster, except that - * the new cluster is created with the default security group.

+ * @see {@link RestoreDBClusterToPointInTimeCommand} */ - public restoreDBClusterToPointInTime( + restoreDBClusterToPointInTime( args: RestoreDBClusterToPointInTimeCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreDBClusterToPointInTime( + restoreDBClusterToPointInTime( args: RestoreDBClusterToPointInTimeCommandInput, cb: (err: any, data?: RestoreDBClusterToPointInTimeCommandOutput) => void ): void; - public restoreDBClusterToPointInTime( + restoreDBClusterToPointInTime( args: RestoreDBClusterToPointInTimeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreDBClusterToPointInTimeCommandOutput) => void ): void; - public restoreDBClusterToPointInTime( - args: RestoreDBClusterToPointInTimeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreDBClusterToPointInTimeCommandOutput) => void), - cb?: (err: any, data?: RestoreDBClusterToPointInTimeCommandOutput) => void - ): Promise | void { - const command = new RestoreDBClusterToPointInTimeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Restarts the stopped cluster that is specified by DBClusterIdentifier. - * For more information, see Stopping and - * Starting an Amazon DocumentDB Cluster.

+ * @see {@link StartDBClusterCommand} */ - public startDBCluster( + startDBCluster( args: StartDBClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDBCluster( - args: StartDBClusterCommandInput, - cb: (err: any, data?: StartDBClusterCommandOutput) => void - ): void; - public startDBCluster( + startDBCluster(args: StartDBClusterCommandInput, cb: (err: any, data?: StartDBClusterCommandOutput) => void): void; + startDBCluster( args: StartDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDBClusterCommandOutput) => void ): void; - public startDBCluster( - args: StartDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDBClusterCommandOutput) => void), - cb?: (err: any, data?: StartDBClusterCommandOutput) => void - ): Promise | void { - const command = new StartDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops the running cluster that is specified by DBClusterIdentifier. The - * cluster must be in the available state. For more information, see - * Stopping and - * Starting an Amazon DocumentDB Cluster.

+ * @see {@link StopDBClusterCommand} */ - public stopDBCluster( - args: StopDBClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public stopDBCluster( - args: StopDBClusterCommandInput, - cb: (err: any, data?: StopDBClusterCommandOutput) => void - ): void; - public stopDBCluster( + stopDBCluster(args: StopDBClusterCommandInput, options?: __HttpHandlerOptions): Promise; + stopDBCluster(args: StopDBClusterCommandInput, cb: (err: any, data?: StopDBClusterCommandOutput) => void): void; + stopDBCluster( args: StopDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDBClusterCommandOutput) => void ): void; - public stopDBCluster( - args: StopDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopDBClusterCommandOutput) => void), - cb?: (err: any, data?: StopDBClusterCommandOutput) => void - ): Promise | void { - const command = new StopDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon DocumentDB API documentation

+ */ +export class DocDB extends DocDBClient implements DocDB {} +createAggregatedClient(commands, DocDB); diff --git a/clients/client-drs/src/Drs.ts b/clients/client-drs/src/Drs.ts index 90d2754559ef..1cb76d4185e9 100644 --- a/clients/client-drs/src/Drs.ts +++ b/clients/client-drs/src/Drs.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -188,1299 +189,679 @@ import { UpdateReplicationConfigurationTemplateCommandInput, UpdateReplicationConfigurationTemplateCommandOutput, } from "./commands/UpdateReplicationConfigurationTemplateCommand"; -import { DrsClient } from "./DrsClient"; +import { DrsClient, DrsClientConfig } from "./DrsClient"; -/** - * @public - *

AWS Elastic Disaster Recovery Service.

- */ -export class Drs extends DrsClient { +const commands = { + CreateExtendedSourceServerCommand, + CreateLaunchConfigurationTemplateCommand, + CreateReplicationConfigurationTemplateCommand, + DeleteJobCommand, + DeleteLaunchConfigurationTemplateCommand, + DeleteRecoveryInstanceCommand, + DeleteReplicationConfigurationTemplateCommand, + DeleteSourceServerCommand, + DescribeJobLogItemsCommand, + DescribeJobsCommand, + DescribeLaunchConfigurationTemplatesCommand, + DescribeRecoveryInstancesCommand, + DescribeRecoverySnapshotsCommand, + DescribeReplicationConfigurationTemplatesCommand, + DescribeSourceServersCommand, + DisconnectRecoveryInstanceCommand, + DisconnectSourceServerCommand, + GetFailbackReplicationConfigurationCommand, + GetLaunchConfigurationCommand, + GetReplicationConfigurationCommand, + InitializeServiceCommand, + ListExtensibleSourceServersCommand, + ListStagingAccountsCommand, + ListTagsForResourceCommand, + RetryDataReplicationCommand, + ReverseReplicationCommand, + StartFailbackLaunchCommand, + StartRecoveryCommand, + StartReplicationCommand, + StopFailbackCommand, + StopReplicationCommand, + TagResourceCommand, + TerminateRecoveryInstancesCommand, + UntagResourceCommand, + UpdateFailbackReplicationConfigurationCommand, + UpdateLaunchConfigurationCommand, + UpdateLaunchConfigurationTemplateCommand, + UpdateReplicationConfigurationCommand, + UpdateReplicationConfigurationTemplateCommand, +}; + +export interface Drs { /** - * @public - *

Create an extended source server in the target Account based on the source server in staging account.

+ * @see {@link CreateExtendedSourceServerCommand} */ - public createExtendedSourceServer( + createExtendedSourceServer( args: CreateExtendedSourceServerCommandInput, options?: __HttpHandlerOptions ): Promise; - public createExtendedSourceServer( + createExtendedSourceServer( args: CreateExtendedSourceServerCommandInput, cb: (err: any, data?: CreateExtendedSourceServerCommandOutput) => void ): void; - public createExtendedSourceServer( + createExtendedSourceServer( args: CreateExtendedSourceServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExtendedSourceServerCommandOutput) => void ): void; - public createExtendedSourceServer( - args: CreateExtendedSourceServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateExtendedSourceServerCommandOutput) => void), - cb?: (err: any, data?: CreateExtendedSourceServerCommandOutput) => void - ): Promise | void { - const command = new CreateExtendedSourceServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new Launch Configuration Template.

+ * @see {@link CreateLaunchConfigurationTemplateCommand} */ - public createLaunchConfigurationTemplate( + createLaunchConfigurationTemplate( args: CreateLaunchConfigurationTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLaunchConfigurationTemplate( + createLaunchConfigurationTemplate( args: CreateLaunchConfigurationTemplateCommandInput, cb: (err: any, data?: CreateLaunchConfigurationTemplateCommandOutput) => void ): void; - public createLaunchConfigurationTemplate( + createLaunchConfigurationTemplate( args: CreateLaunchConfigurationTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLaunchConfigurationTemplateCommandOutput) => void ): void; - public createLaunchConfigurationTemplate( - args: CreateLaunchConfigurationTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLaunchConfigurationTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateLaunchConfigurationTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateLaunchConfigurationTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new ReplicationConfigurationTemplate.

+ * @see {@link CreateReplicationConfigurationTemplateCommand} */ - public createReplicationConfigurationTemplate( + createReplicationConfigurationTemplate( args: CreateReplicationConfigurationTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createReplicationConfigurationTemplate( + createReplicationConfigurationTemplate( args: CreateReplicationConfigurationTemplateCommandInput, cb: (err: any, data?: CreateReplicationConfigurationTemplateCommandOutput) => void ): void; - public createReplicationConfigurationTemplate( + createReplicationConfigurationTemplate( args: CreateReplicationConfigurationTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReplicationConfigurationTemplateCommandOutput) => void ): void; - public createReplicationConfigurationTemplate( - args: CreateReplicationConfigurationTemplateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateReplicationConfigurationTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateReplicationConfigurationTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateReplicationConfigurationTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a single Job by ID.

+ * @see {@link DeleteJobCommand} */ - public deleteJob(args: DeleteJobCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteJob(args: DeleteJobCommandInput, cb: (err: any, data?: DeleteJobCommandOutput) => void): void; - public deleteJob( + deleteJob(args: DeleteJobCommandInput, options?: __HttpHandlerOptions): Promise; + deleteJob(args: DeleteJobCommandInput, cb: (err: any, data?: DeleteJobCommandOutput) => void): void; + deleteJob( args: DeleteJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteJobCommandOutput) => void ): void; - public deleteJob( - args: DeleteJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteJobCommandOutput) => void), - cb?: (err: any, data?: DeleteJobCommandOutput) => void - ): Promise | void { - const command = new DeleteJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a single Launch Configuration Template by ID.

+ * @see {@link DeleteLaunchConfigurationTemplateCommand} */ - public deleteLaunchConfigurationTemplate( + deleteLaunchConfigurationTemplate( args: DeleteLaunchConfigurationTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLaunchConfigurationTemplate( + deleteLaunchConfigurationTemplate( args: DeleteLaunchConfigurationTemplateCommandInput, cb: (err: any, data?: DeleteLaunchConfigurationTemplateCommandOutput) => void ): void; - public deleteLaunchConfigurationTemplate( + deleteLaunchConfigurationTemplate( args: DeleteLaunchConfigurationTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLaunchConfigurationTemplateCommandOutput) => void ): void; - public deleteLaunchConfigurationTemplate( - args: DeleteLaunchConfigurationTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLaunchConfigurationTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteLaunchConfigurationTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteLaunchConfigurationTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a single Recovery Instance by ID. This deletes the Recovery Instance resource from Elastic Disaster Recovery. The Recovery Instance must be disconnected first in order to delete it.

+ * @see {@link DeleteRecoveryInstanceCommand} */ - public deleteRecoveryInstance( + deleteRecoveryInstance( args: DeleteRecoveryInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRecoveryInstance( + deleteRecoveryInstance( args: DeleteRecoveryInstanceCommandInput, cb: (err: any, data?: DeleteRecoveryInstanceCommandOutput) => void ): void; - public deleteRecoveryInstance( + deleteRecoveryInstance( args: DeleteRecoveryInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRecoveryInstanceCommandOutput) => void ): void; - public deleteRecoveryInstance( - args: DeleteRecoveryInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRecoveryInstanceCommandOutput) => void), - cb?: (err: any, data?: DeleteRecoveryInstanceCommandOutput) => void - ): Promise | void { - const command = new DeleteRecoveryInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a single Replication Configuration Template by ID

+ * @see {@link DeleteReplicationConfigurationTemplateCommand} */ - public deleteReplicationConfigurationTemplate( + deleteReplicationConfigurationTemplate( args: DeleteReplicationConfigurationTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteReplicationConfigurationTemplate( + deleteReplicationConfigurationTemplate( args: DeleteReplicationConfigurationTemplateCommandInput, cb: (err: any, data?: DeleteReplicationConfigurationTemplateCommandOutput) => void ): void; - public deleteReplicationConfigurationTemplate( + deleteReplicationConfigurationTemplate( args: DeleteReplicationConfigurationTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReplicationConfigurationTemplateCommandOutput) => void ): void; - public deleteReplicationConfigurationTemplate( - args: DeleteReplicationConfigurationTemplateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteReplicationConfigurationTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteReplicationConfigurationTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteReplicationConfigurationTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a single Source Server by ID. The Source Server must be disconnected first.

+ * @see {@link DeleteSourceServerCommand} */ - public deleteSourceServer( + deleteSourceServer( args: DeleteSourceServerCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSourceServer( + deleteSourceServer( args: DeleteSourceServerCommandInput, cb: (err: any, data?: DeleteSourceServerCommandOutput) => void ): void; - public deleteSourceServer( + deleteSourceServer( args: DeleteSourceServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSourceServerCommandOutput) => void ): void; - public deleteSourceServer( - args: DeleteSourceServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSourceServerCommandOutput) => void), - cb?: (err: any, data?: DeleteSourceServerCommandOutput) => void - ): Promise | void { - const command = new DeleteSourceServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a detailed Job log with pagination.

+ * @see {@link DescribeJobLogItemsCommand} */ - public describeJobLogItems( + describeJobLogItems( args: DescribeJobLogItemsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeJobLogItems( + describeJobLogItems( args: DescribeJobLogItemsCommandInput, cb: (err: any, data?: DescribeJobLogItemsCommandOutput) => void ): void; - public describeJobLogItems( + describeJobLogItems( args: DescribeJobLogItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobLogItemsCommandOutput) => void ): void; - public describeJobLogItems( - args: DescribeJobLogItemsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeJobLogItemsCommandOutput) => void), - cb?: (err: any, data?: DescribeJobLogItemsCommandOutput) => void - ): Promise | void { - const command = new DescribeJobLogItemsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of Jobs. Use the JobsID and fromDate and toDate filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are created by the StartRecovery, TerminateRecoveryInstances and StartFailbackLaunch APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets.

+ * @see {@link DescribeJobsCommand} */ - public describeJobs( - args: DescribeJobsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeJobs(args: DescribeJobsCommandInput, cb: (err: any, data?: DescribeJobsCommandOutput) => void): void; - public describeJobs( + describeJobs(args: DescribeJobsCommandInput, options?: __HttpHandlerOptions): Promise; + describeJobs(args: DescribeJobsCommandInput, cb: (err: any, data?: DescribeJobsCommandOutput) => void): void; + describeJobs( args: DescribeJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobsCommandOutput) => void ): void; - public describeJobs( - args: DescribeJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeJobsCommandOutput) => void), - cb?: (err: any, data?: DescribeJobsCommandOutput) => void - ): Promise | void { - const command = new DescribeJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs

+ * @see {@link DescribeLaunchConfigurationTemplatesCommand} */ - public describeLaunchConfigurationTemplates( + describeLaunchConfigurationTemplates( args: DescribeLaunchConfigurationTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLaunchConfigurationTemplates( + describeLaunchConfigurationTemplates( args: DescribeLaunchConfigurationTemplatesCommandInput, cb: (err: any, data?: DescribeLaunchConfigurationTemplatesCommandOutput) => void ): void; - public describeLaunchConfigurationTemplates( + describeLaunchConfigurationTemplates( args: DescribeLaunchConfigurationTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLaunchConfigurationTemplatesCommandOutput) => void ): void; - public describeLaunchConfigurationTemplates( - args: DescribeLaunchConfigurationTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLaunchConfigurationTemplatesCommandOutput) => void), - cb?: (err: any, data?: DescribeLaunchConfigurationTemplatesCommandOutput) => void - ): Promise | void { - const command = new DescribeLaunchConfigurationTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all Recovery Instances or multiple Recovery Instances by ID.

+ * @see {@link DescribeRecoveryInstancesCommand} */ - public describeRecoveryInstances( + describeRecoveryInstances( args: DescribeRecoveryInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRecoveryInstances( + describeRecoveryInstances( args: DescribeRecoveryInstancesCommandInput, cb: (err: any, data?: DescribeRecoveryInstancesCommandOutput) => void ): void; - public describeRecoveryInstances( + describeRecoveryInstances( args: DescribeRecoveryInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRecoveryInstancesCommandOutput) => void ): void; - public describeRecoveryInstances( - args: DescribeRecoveryInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRecoveryInstancesCommandOutput) => void), - cb?: (err: any, data?: DescribeRecoveryInstancesCommandOutput) => void - ): Promise | void { - const command = new DescribeRecoveryInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all Recovery Snapshots for a single Source Server.

+ * @see {@link DescribeRecoverySnapshotsCommand} */ - public describeRecoverySnapshots( + describeRecoverySnapshots( args: DescribeRecoverySnapshotsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRecoverySnapshots( + describeRecoverySnapshots( args: DescribeRecoverySnapshotsCommandInput, cb: (err: any, data?: DescribeRecoverySnapshotsCommandOutput) => void ): void; - public describeRecoverySnapshots( + describeRecoverySnapshots( args: DescribeRecoverySnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRecoverySnapshotsCommandOutput) => void ): void; - public describeRecoverySnapshots( - args: DescribeRecoverySnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRecoverySnapshotsCommandOutput) => void), - cb?: (err: any, data?: DescribeRecoverySnapshotsCommandOutput) => void - ): Promise | void { - const command = new DescribeRecoverySnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

+ * @see {@link DescribeReplicationConfigurationTemplatesCommand} */ - public describeReplicationConfigurationTemplates( + describeReplicationConfigurationTemplates( args: DescribeReplicationConfigurationTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReplicationConfigurationTemplates( + describeReplicationConfigurationTemplates( args: DescribeReplicationConfigurationTemplatesCommandInput, cb: (err: any, data?: DescribeReplicationConfigurationTemplatesCommandOutput) => void ): void; - public describeReplicationConfigurationTemplates( + describeReplicationConfigurationTemplates( args: DescribeReplicationConfigurationTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReplicationConfigurationTemplatesCommandOutput) => void ): void; - public describeReplicationConfigurationTemplates( - args: DescribeReplicationConfigurationTemplatesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeReplicationConfigurationTemplatesCommandOutput) => void), - cb?: (err: any, data?: DescribeReplicationConfigurationTemplatesCommandOutput) => void - ): Promise | void { - const command = new DescribeReplicationConfigurationTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all Source Servers or multiple Source Servers filtered by ID.

+ * @see {@link DescribeSourceServersCommand} */ - public describeSourceServers( + describeSourceServers( args: DescribeSourceServersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSourceServers( + describeSourceServers( args: DescribeSourceServersCommandInput, cb: (err: any, data?: DescribeSourceServersCommandOutput) => void ): void; - public describeSourceServers( + describeSourceServers( args: DescribeSourceServersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSourceServersCommandOutput) => void ): void; - public describeSourceServers( - args: DescribeSourceServersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSourceServersCommandOutput) => void), - cb?: (err: any, data?: DescribeSourceServersCommandOutput) => void - ): Promise | void { - const command = new DescribeSourceServersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disconnect a Recovery Instance from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Recovery Instance will be terminated / deleted within 90 minutes. If the agent on the Recovery Instance has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the Recovery Instance will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

+ * @see {@link DisconnectRecoveryInstanceCommand} */ - public disconnectRecoveryInstance( + disconnectRecoveryInstance( args: DisconnectRecoveryInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public disconnectRecoveryInstance( + disconnectRecoveryInstance( args: DisconnectRecoveryInstanceCommandInput, cb: (err: any, data?: DisconnectRecoveryInstanceCommandOutput) => void ): void; - public disconnectRecoveryInstance( + disconnectRecoveryInstance( args: DisconnectRecoveryInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisconnectRecoveryInstanceCommandOutput) => void ): void; - public disconnectRecoveryInstance( - args: DisconnectRecoveryInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisconnectRecoveryInstanceCommandOutput) => void), - cb?: (err: any, data?: DisconnectRecoveryInstanceCommandOutput) => void - ): Promise | void { - const command = new DisconnectRecoveryInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disconnects a specific Source Server from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Source Server will be terminated / deleted within 90 minutes. You cannot disconnect a Source Server if it has a Recovery Instance. If the agent on the Source Server has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

+ * @see {@link DisconnectSourceServerCommand} */ - public disconnectSourceServer( + disconnectSourceServer( args: DisconnectSourceServerCommandInput, options?: __HttpHandlerOptions ): Promise; - public disconnectSourceServer( + disconnectSourceServer( args: DisconnectSourceServerCommandInput, cb: (err: any, data?: DisconnectSourceServerCommandOutput) => void ): void; - public disconnectSourceServer( + disconnectSourceServer( args: DisconnectSourceServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisconnectSourceServerCommandOutput) => void ): void; - public disconnectSourceServer( - args: DisconnectSourceServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisconnectSourceServerCommandOutput) => void), - cb?: (err: any, data?: DisconnectSourceServerCommandOutput) => void - ): Promise | void { - const command = new DisconnectSourceServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all Failback ReplicationConfigurations, filtered by Recovery Instance ID.

+ * @see {@link GetFailbackReplicationConfigurationCommand} */ - public getFailbackReplicationConfiguration( + getFailbackReplicationConfiguration( args: GetFailbackReplicationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFailbackReplicationConfiguration( + getFailbackReplicationConfiguration( args: GetFailbackReplicationConfigurationCommandInput, cb: (err: any, data?: GetFailbackReplicationConfigurationCommandOutput) => void ): void; - public getFailbackReplicationConfiguration( + getFailbackReplicationConfiguration( args: GetFailbackReplicationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFailbackReplicationConfigurationCommandOutput) => void ): void; - public getFailbackReplicationConfiguration( - args: GetFailbackReplicationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFailbackReplicationConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetFailbackReplicationConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetFailbackReplicationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a LaunchConfiguration, filtered by Source Server IDs.

+ * @see {@link GetLaunchConfigurationCommand} */ - public getLaunchConfiguration( + getLaunchConfiguration( args: GetLaunchConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLaunchConfiguration( + getLaunchConfiguration( args: GetLaunchConfigurationCommandInput, cb: (err: any, data?: GetLaunchConfigurationCommandOutput) => void ): void; - public getLaunchConfiguration( + getLaunchConfiguration( args: GetLaunchConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLaunchConfigurationCommandOutput) => void ): void; - public getLaunchConfiguration( - args: GetLaunchConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLaunchConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetLaunchConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetLaunchConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a ReplicationConfiguration, filtered by Source Server ID.

+ * @see {@link GetReplicationConfigurationCommand} */ - public getReplicationConfiguration( + getReplicationConfiguration( args: GetReplicationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReplicationConfiguration( + getReplicationConfiguration( args: GetReplicationConfigurationCommandInput, cb: (err: any, data?: GetReplicationConfigurationCommandOutput) => void ): void; - public getReplicationConfiguration( + getReplicationConfiguration( args: GetReplicationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReplicationConfigurationCommandOutput) => void ): void; - public getReplicationConfiguration( - args: GetReplicationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReplicationConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetReplicationConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetReplicationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Initialize Elastic Disaster Recovery.

+ * @see {@link InitializeServiceCommand} */ - public initializeService( + initializeService( args: InitializeServiceCommandInput, options?: __HttpHandlerOptions ): Promise; - public initializeService( + initializeService( args: InitializeServiceCommandInput, cb: (err: any, data?: InitializeServiceCommandOutput) => void ): void; - public initializeService( + initializeService( args: InitializeServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InitializeServiceCommandOutput) => void ): void; - public initializeService( - args: InitializeServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InitializeServiceCommandOutput) => void), - cb?: (err: any, data?: InitializeServiceCommandOutput) => void - ): Promise | void { - const command = new InitializeServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of source servers on a staging account that are extensible, which means that: - * a. The source server is not already extended into this Account. - * b. The source server on the Account we’re reading from is not an extension of another source server. - *

+ * @see {@link ListExtensibleSourceServersCommand} */ - public listExtensibleSourceServers( + listExtensibleSourceServers( args: ListExtensibleSourceServersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listExtensibleSourceServers( + listExtensibleSourceServers( args: ListExtensibleSourceServersCommandInput, cb: (err: any, data?: ListExtensibleSourceServersCommandOutput) => void ): void; - public listExtensibleSourceServers( + listExtensibleSourceServers( args: ListExtensibleSourceServersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExtensibleSourceServersCommandOutput) => void ): void; - public listExtensibleSourceServers( - args: ListExtensibleSourceServersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListExtensibleSourceServersCommandOutput) => void), - cb?: (err: any, data?: ListExtensibleSourceServersCommandOutput) => void - ): Promise | void { - const command = new ListExtensibleSourceServersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of staging accounts for existing extended source servers.

+ * @see {@link ListStagingAccountsCommand} */ - public listStagingAccounts( + listStagingAccounts( args: ListStagingAccountsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStagingAccounts( + listStagingAccounts( args: ListStagingAccountsCommandInput, cb: (err: any, data?: ListStagingAccountsCommandOutput) => void ): void; - public listStagingAccounts( + listStagingAccounts( args: ListStagingAccountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStagingAccountsCommandOutput) => void ): void; - public listStagingAccounts( - args: ListStagingAccountsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStagingAccountsCommandOutput) => void), - cb?: (err: any, data?: ListStagingAccountsCommandOutput) => void - ): Promise | void { - const command = new ListStagingAccountsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all tags for your Elastic Disaster Recovery resources.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

WARNING: RetryDataReplication is deprecated. - * Causes the data replication initiation sequence to begin immediately upon next Handshake for the specified Source Server ID, regardless of when the previous initiation started. This command will work only if the Source Server is stalled or is in a DISCONNECTED or STOPPED state. - *

+ * @see {@link RetryDataReplicationCommand} */ - public retryDataReplication( + retryDataReplication( args: RetryDataReplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public retryDataReplication( + retryDataReplication( args: RetryDataReplicationCommandInput, cb: (err: any, data?: RetryDataReplicationCommandOutput) => void ): void; - public retryDataReplication( + retryDataReplication( args: RetryDataReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RetryDataReplicationCommandOutput) => void ): void; - public retryDataReplication( - args: RetryDataReplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RetryDataReplicationCommandOutput) => void), - cb?: (err: any, data?: RetryDataReplicationCommandOutput) => void - ): Promise | void { - const command = new RetryDataReplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Start replication to origin / target region - applies only to protected instances that originated in EC2. - * For recovery instances on target region - starts replication back to origin region. - * For failback instances on origin region - starts replication to target region to re-protect them. - *

+ * @see {@link ReverseReplicationCommand} */ - public reverseReplication( + reverseReplication( args: ReverseReplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public reverseReplication( + reverseReplication( args: ReverseReplicationCommandInput, cb: (err: any, data?: ReverseReplicationCommandOutput) => void ): void; - public reverseReplication( + reverseReplication( args: ReverseReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReverseReplicationCommandOutput) => void ): void; - public reverseReplication( - args: ReverseReplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReverseReplicationCommandOutput) => void), - cb?: (err: any, data?: ReverseReplicationCommandOutput) => void - ): Promise | void { - const command = new ReverseReplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Initiates a Job for launching the machine that is being failed back to from the specified Recovery Instance. This will run conversion on the failback client and will reboot your machine, thus completing the failback process.

+ * @see {@link StartFailbackLaunchCommand} */ - public startFailbackLaunch( + startFailbackLaunch( args: StartFailbackLaunchCommandInput, options?: __HttpHandlerOptions ): Promise; - public startFailbackLaunch( + startFailbackLaunch( args: StartFailbackLaunchCommandInput, cb: (err: any, data?: StartFailbackLaunchCommandOutput) => void ): void; - public startFailbackLaunch( + startFailbackLaunch( args: StartFailbackLaunchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFailbackLaunchCommandOutput) => void ): void; - public startFailbackLaunch( - args: StartFailbackLaunchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartFailbackLaunchCommandOutput) => void), - cb?: (err: any, data?: StartFailbackLaunchCommandOutput) => void - ): Promise | void { - const command = new StartFailbackLaunchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Launches Recovery Instances for the specified Source Servers. For each Source Server you may choose a point in time snapshot to launch from, or use an on demand snapshot.

+ * @see {@link StartRecoveryCommand} */ - public startRecovery( - args: StartRecoveryCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public startRecovery( - args: StartRecoveryCommandInput, - cb: (err: any, data?: StartRecoveryCommandOutput) => void - ): void; - public startRecovery( + startRecovery(args: StartRecoveryCommandInput, options?: __HttpHandlerOptions): Promise; + startRecovery(args: StartRecoveryCommandInput, cb: (err: any, data?: StartRecoveryCommandOutput) => void): void; + startRecovery( args: StartRecoveryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartRecoveryCommandOutput) => void ): void; - public startRecovery( - args: StartRecoveryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartRecoveryCommandOutput) => void), - cb?: (err: any, data?: StartRecoveryCommandOutput) => void - ): Promise | void { - const command = new StartRecoveryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts replication for a stopped Source Server. This action would make the Source Server protected again and restart billing for it.

+ * @see {@link StartReplicationCommand} */ - public startReplication( + startReplication( args: StartReplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startReplication( + startReplication( args: StartReplicationCommandInput, cb: (err: any, data?: StartReplicationCommandOutput) => void ): void; - public startReplication( + startReplication( args: StartReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartReplicationCommandOutput) => void ): void; - public startReplication( - args: StartReplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartReplicationCommandOutput) => void), - cb?: (err: any, data?: StartReplicationCommandOutput) => void - ): Promise | void { - const command = new StartReplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops the failback process for a specified Recovery Instance. This changes the Failback State of the Recovery Instance back to FAILBACK_NOT_STARTED.

+ * @see {@link StopFailbackCommand} */ - public stopFailback( - args: StopFailbackCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public stopFailback(args: StopFailbackCommandInput, cb: (err: any, data?: StopFailbackCommandOutput) => void): void; - public stopFailback( + stopFailback(args: StopFailbackCommandInput, options?: __HttpHandlerOptions): Promise; + stopFailback(args: StopFailbackCommandInput, cb: (err: any, data?: StopFailbackCommandOutput) => void): void; + stopFailback( args: StopFailbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopFailbackCommandOutput) => void ): void; - public stopFailback( - args: StopFailbackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopFailbackCommandOutput) => void), - cb?: (err: any, data?: StopFailbackCommandOutput) => void - ): Promise | void { - const command = new StopFailbackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops replication for a Source Server. This action would make the Source Server unprotected, delete its existing snapshots and stop billing for it.

+ * @see {@link StopReplicationCommand} */ - public stopReplication( + stopReplication( args: StopReplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopReplication( - args: StopReplicationCommandInput, - cb: (err: any, data?: StopReplicationCommandOutput) => void - ): void; - public stopReplication( + stopReplication(args: StopReplicationCommandInput, cb: (err: any, data?: StopReplicationCommandOutput) => void): void; + stopReplication( args: StopReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopReplicationCommandOutput) => void ): void; - public stopReplication( - args: StopReplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopReplicationCommandOutput) => void), - cb?: (err: any, data?: StopReplicationCommandOutput) => void - ): Promise | void { - const command = new StopReplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or overwrites only the specified tags for the specified Elastic Disaster Recovery resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Initiates a Job for terminating the EC2 resources associated with the specified Recovery Instances, and then will delete the Recovery Instances from the Elastic Disaster Recovery service.

+ * @see {@link TerminateRecoveryInstancesCommand} */ - public terminateRecoveryInstances( + terminateRecoveryInstances( args: TerminateRecoveryInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public terminateRecoveryInstances( + terminateRecoveryInstances( args: TerminateRecoveryInstancesCommandInput, cb: (err: any, data?: TerminateRecoveryInstancesCommandOutput) => void ): void; - public terminateRecoveryInstances( + terminateRecoveryInstances( args: TerminateRecoveryInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TerminateRecoveryInstancesCommandOutput) => void ): void; - public terminateRecoveryInstances( - args: TerminateRecoveryInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TerminateRecoveryInstancesCommandOutput) => void), - cb?: (err: any, data?: TerminateRecoveryInstancesCommandOutput) => void - ): Promise | void { - const command = new TerminateRecoveryInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified set of tags from the specified set of Elastic Disaster Recovery resources.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows you to update the failback replication configuration of a Recovery Instance by ID.

+ * @see {@link UpdateFailbackReplicationConfigurationCommand} */ - public updateFailbackReplicationConfiguration( + updateFailbackReplicationConfiguration( args: UpdateFailbackReplicationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFailbackReplicationConfiguration( + updateFailbackReplicationConfiguration( args: UpdateFailbackReplicationConfigurationCommandInput, cb: (err: any, data?: UpdateFailbackReplicationConfigurationCommandOutput) => void ): void; - public updateFailbackReplicationConfiguration( + updateFailbackReplicationConfiguration( args: UpdateFailbackReplicationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFailbackReplicationConfigurationCommandOutput) => void ): void; - public updateFailbackReplicationConfiguration( - args: UpdateFailbackReplicationConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateFailbackReplicationConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateFailbackReplicationConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateFailbackReplicationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a LaunchConfiguration by Source Server ID.

+ * @see {@link UpdateLaunchConfigurationCommand} */ - public updateLaunchConfiguration( + updateLaunchConfiguration( args: UpdateLaunchConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLaunchConfiguration( + updateLaunchConfiguration( args: UpdateLaunchConfigurationCommandInput, cb: (err: any, data?: UpdateLaunchConfigurationCommandOutput) => void ): void; - public updateLaunchConfiguration( + updateLaunchConfiguration( args: UpdateLaunchConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLaunchConfigurationCommandOutput) => void ): void; - public updateLaunchConfiguration( - args: UpdateLaunchConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLaunchConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateLaunchConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateLaunchConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing Launch Configuration Template by ID.

+ * @see {@link UpdateLaunchConfigurationTemplateCommand} */ - public updateLaunchConfigurationTemplate( + updateLaunchConfigurationTemplate( args: UpdateLaunchConfigurationTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLaunchConfigurationTemplate( + updateLaunchConfigurationTemplate( args: UpdateLaunchConfigurationTemplateCommandInput, cb: (err: any, data?: UpdateLaunchConfigurationTemplateCommandOutput) => void ): void; - public updateLaunchConfigurationTemplate( + updateLaunchConfigurationTemplate( args: UpdateLaunchConfigurationTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLaunchConfigurationTemplateCommandOutput) => void ): void; - public updateLaunchConfigurationTemplate( - args: UpdateLaunchConfigurationTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLaunchConfigurationTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateLaunchConfigurationTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateLaunchConfigurationTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows you to update a ReplicationConfiguration by Source Server ID.

+ * @see {@link UpdateReplicationConfigurationCommand} */ - public updateReplicationConfiguration( + updateReplicationConfiguration( args: UpdateReplicationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateReplicationConfiguration( + updateReplicationConfiguration( args: UpdateReplicationConfigurationCommandInput, cb: (err: any, data?: UpdateReplicationConfigurationCommandOutput) => void ): void; - public updateReplicationConfiguration( + updateReplicationConfiguration( args: UpdateReplicationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateReplicationConfigurationCommandOutput) => void ): void; - public updateReplicationConfiguration( - args: UpdateReplicationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateReplicationConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateReplicationConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateReplicationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a ReplicationConfigurationTemplate by ID.

+ * @see {@link UpdateReplicationConfigurationTemplateCommand} */ - public updateReplicationConfigurationTemplate( + updateReplicationConfigurationTemplate( args: UpdateReplicationConfigurationTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateReplicationConfigurationTemplate( + updateReplicationConfigurationTemplate( args: UpdateReplicationConfigurationTemplateCommandInput, cb: (err: any, data?: UpdateReplicationConfigurationTemplateCommandOutput) => void ): void; - public updateReplicationConfigurationTemplate( + updateReplicationConfigurationTemplate( args: UpdateReplicationConfigurationTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateReplicationConfigurationTemplateCommandOutput) => void ): void; - public updateReplicationConfigurationTemplate( - args: UpdateReplicationConfigurationTemplateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateReplicationConfigurationTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateReplicationConfigurationTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateReplicationConfigurationTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

AWS Elastic Disaster Recovery Service.

+ */ +export class Drs extends DrsClient implements Drs {} +createAggregatedClient(commands, Drs); diff --git a/clients/client-dynamodb-streams/src/DynamoDBStreams.ts b/clients/client-dynamodb-streams/src/DynamoDBStreams.ts index addff4746e07..c80e6a855323 100644 --- a/clients/client-dynamodb-streams/src/DynamoDBStreams.ts +++ b/clients/client-dynamodb-streams/src/DynamoDBStreams.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -13,165 +14,78 @@ import { GetShardIteratorCommandOutput, } from "./commands/GetShardIteratorCommand"; import { ListStreamsCommand, ListStreamsCommandInput, ListStreamsCommandOutput } from "./commands/ListStreamsCommand"; -import { DynamoDBStreamsClient } from "./DynamoDBStreamsClient"; +import { DynamoDBStreamsClient, DynamoDBStreamsClientConfig } from "./DynamoDBStreamsClient"; -/** - * @public - * Amazon DynamoDB - * - *

Amazon DynamoDB Streams provides API actions for accessing streams and processing - * stream records. To learn more about application development with Streams, see Capturing - * Table Activity with DynamoDB Streams in the Amazon DynamoDB Developer - * Guide.

- */ -export class DynamoDBStreams extends DynamoDBStreamsClient { +const commands = { + DescribeStreamCommand, + GetRecordsCommand, + GetShardIteratorCommand, + ListStreamsCommand, +}; + +export interface DynamoDBStreams { /** - * @public - *

Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table.

- * - *

You can call DescribeStream at a maximum rate of 10 times per second.

- *
- *

Each shard in the stream has a SequenceNumberRange associated with it. If the - * SequenceNumberRange has a StartingSequenceNumber but no - * EndingSequenceNumber, then the shard is still open (able to receive more stream - * records). If both StartingSequenceNumber and EndingSequenceNumber - * are present, then that shard is closed and can no longer receive more data.

+ * @see {@link DescribeStreamCommand} */ - public describeStream( + describeStream( args: DescribeStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStream( - args: DescribeStreamCommandInput, - cb: (err: any, data?: DescribeStreamCommandOutput) => void - ): void; - public describeStream( + describeStream(args: DescribeStreamCommandInput, cb: (err: any, data?: DescribeStreamCommandOutput) => void): void; + describeStream( args: DescribeStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStreamCommandOutput) => void ): void; - public describeStream( - args: DescribeStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStreamCommandOutput) => void), - cb?: (err: any, data?: DescribeStreamCommandOutput) => void - ): Promise | void { - const command = new DescribeStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the stream records from a given shard.

- *

Specify a shard iterator using the ShardIterator parameter. The shard iterator - * specifies the position in the shard from which you want to start reading stream records - * sequentially. If there are no stream records available in the portion of the shard that the - * iterator points to, GetRecords returns an empty list. Note that it might take - * multiple calls to get to a portion of the shard that contains stream records.

- * - *

- * GetRecords can retrieve a maximum of 1 MB of data or 1000 stream records, - * whichever comes first.

- *
+ * @see {@link GetRecordsCommand} */ - public getRecords(args: GetRecordsCommandInput, options?: __HttpHandlerOptions): Promise; - public getRecords(args: GetRecordsCommandInput, cb: (err: any, data?: GetRecordsCommandOutput) => void): void; - public getRecords( + getRecords(args: GetRecordsCommandInput, options?: __HttpHandlerOptions): Promise; + getRecords(args: GetRecordsCommandInput, cb: (err: any, data?: GetRecordsCommandOutput) => void): void; + getRecords( args: GetRecordsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRecordsCommandOutput) => void ): void; - public getRecords( - args: GetRecordsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRecordsCommandOutput) => void), - cb?: (err: any, data?: GetRecordsCommandOutput) => void - ): Promise | void { - const command = new GetRecordsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a shard iterator. A shard iterator provides information - * about how to retrieve the stream records from within a shard. Use - * the shard iterator in a subsequent - * GetRecords request to read the stream records - * from the shard.

- * - *

A shard iterator expires 15 minutes after it is returned to the requester.

- *
+ * @see {@link GetShardIteratorCommand} */ - public getShardIterator( + getShardIterator( args: GetShardIteratorCommandInput, options?: __HttpHandlerOptions ): Promise; - public getShardIterator( + getShardIterator( args: GetShardIteratorCommandInput, cb: (err: any, data?: GetShardIteratorCommandOutput) => void ): void; - public getShardIterator( + getShardIterator( args: GetShardIteratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetShardIteratorCommandOutput) => void ): void; - public getShardIterator( - args: GetShardIteratorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetShardIteratorCommandOutput) => void), - cb?: (err: any, data?: GetShardIteratorCommandOutput) => void - ): Promise | void { - const command = new GetShardIteratorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of stream ARNs associated with the current account and endpoint. If the - * TableName parameter is present, then ListStreams will return only the - * streams ARNs for that table.

- * - *

You can call ListStreams at a maximum rate of 5 times per second.

- *
+ * @see {@link ListStreamsCommand} */ - public listStreams(args: ListStreamsCommandInput, options?: __HttpHandlerOptions): Promise; - public listStreams(args: ListStreamsCommandInput, cb: (err: any, data?: ListStreamsCommandOutput) => void): void; - public listStreams( + listStreams(args: ListStreamsCommandInput, options?: __HttpHandlerOptions): Promise; + listStreams(args: ListStreamsCommandInput, cb: (err: any, data?: ListStreamsCommandOutput) => void): void; + listStreams( args: ListStreamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamsCommandOutput) => void ): void; - public listStreams( - args: ListStreamsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStreamsCommandOutput) => void), - cb?: (err: any, data?: ListStreamsCommandOutput) => void - ): Promise | void { - const command = new ListStreamsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon DynamoDB + * + *

Amazon DynamoDB Streams provides API actions for accessing streams and processing + * stream records. To learn more about application development with Streams, see Capturing + * Table Activity with DynamoDB Streams in the Amazon DynamoDB Developer + * Guide.

+ */ +export class DynamoDBStreams extends DynamoDBStreamsClient implements DynamoDBStreams {} +createAggregatedClient(commands, DynamoDBStreams); diff --git a/clients/client-dynamodb/src/DynamoDB.ts b/clients/client-dynamodb/src/DynamoDB.ts index 2218e4b085f5..2a5ff1a62a16 100644 --- a/clients/client-dynamodb/src/DynamoDB.ts +++ b/clients/client-dynamodb/src/DynamoDB.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -206,2542 +207,847 @@ import { UpdateTimeToLiveCommandInput, UpdateTimeToLiveCommandOutput, } from "./commands/UpdateTimeToLiveCommand"; -import { DynamoDBClient } from "./DynamoDBClient"; +import { DynamoDBClient, DynamoDBClientConfig } from "./DynamoDBClient"; -/** - * @public - * Amazon DynamoDB - *

Amazon DynamoDB is a fully managed NoSQL database service that provides fast - * and predictable performance with seamless scalability. DynamoDB lets you - * offload the administrative burdens of operating and scaling a distributed database, so - * that you don't have to worry about hardware provisioning, setup and configuration, - * replication, software patching, or cluster scaling.

- *

With DynamoDB, you can create database tables that can store and retrieve - * any amount of data, and serve any level of request traffic. You can scale up or scale - * down your tables' throughput capacity without downtime or performance degradation, and - * use the Amazon Web Services Management Console to monitor resource utilization and performance - * metrics.

- *

DynamoDB automatically spreads the data and traffic for your tables over - * a sufficient number of servers to handle your throughput and storage requirements, while - * maintaining consistent and fast performance. All of your data is stored on solid state - * disks (SSDs) and automatically replicated across multiple Availability Zones in an - * Amazon Web Services Region, providing built-in high availability and data - * durability.

- */ -export class DynamoDB extends DynamoDBClient { +const commands = { + BatchExecuteStatementCommand, + BatchGetItemCommand, + BatchWriteItemCommand, + CreateBackupCommand, + CreateGlobalTableCommand, + CreateTableCommand, + DeleteBackupCommand, + DeleteItemCommand, + DeleteTableCommand, + DescribeBackupCommand, + DescribeContinuousBackupsCommand, + DescribeContributorInsightsCommand, + DescribeEndpointsCommand, + DescribeExportCommand, + DescribeGlobalTableCommand, + DescribeGlobalTableSettingsCommand, + DescribeImportCommand, + DescribeKinesisStreamingDestinationCommand, + DescribeLimitsCommand, + DescribeTableCommand, + DescribeTableReplicaAutoScalingCommand, + DescribeTimeToLiveCommand, + DisableKinesisStreamingDestinationCommand, + EnableKinesisStreamingDestinationCommand, + ExecuteStatementCommand, + ExecuteTransactionCommand, + ExportTableToPointInTimeCommand, + GetItemCommand, + ImportTableCommand, + ListBackupsCommand, + ListContributorInsightsCommand, + ListExportsCommand, + ListGlobalTablesCommand, + ListImportsCommand, + ListTablesCommand, + ListTagsOfResourceCommand, + PutItemCommand, + QueryCommand, + RestoreTableFromBackupCommand, + RestoreTableToPointInTimeCommand, + ScanCommand, + TagResourceCommand, + TransactGetItemsCommand, + TransactWriteItemsCommand, + UntagResourceCommand, + UpdateContinuousBackupsCommand, + UpdateContributorInsightsCommand, + UpdateGlobalTableCommand, + UpdateGlobalTableSettingsCommand, + UpdateItemCommand, + UpdateTableCommand, + UpdateTableReplicaAutoScalingCommand, + UpdateTimeToLiveCommand, +}; + +export interface DynamoDB { /** - * @public - *

This operation allows you to perform batch reads or writes on data stored in DynamoDB, - * using PartiQL. Each read statement in a BatchExecuteStatement must specify - * an equality condition on all key attributes. This enforces that each SELECT - * statement in a batch returns at most a single item.

- * - *

The entire batch must consist of either read statements or write statements, you - * cannot mix both in one batch.

- *
- * - *

A HTTP 200 response does not mean that all statements in the BatchExecuteStatement - * succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each - * statement.

- *
+ * @see {@link BatchExecuteStatementCommand} */ - public batchExecuteStatement( + batchExecuteStatement( args: BatchExecuteStatementCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchExecuteStatement( + batchExecuteStatement( args: BatchExecuteStatementCommandInput, cb: (err: any, data?: BatchExecuteStatementCommandOutput) => void ): void; - public batchExecuteStatement( + batchExecuteStatement( args: BatchExecuteStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchExecuteStatementCommandOutput) => void ): void; - public batchExecuteStatement( - args: BatchExecuteStatementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchExecuteStatementCommandOutput) => void), - cb?: (err: any, data?: BatchExecuteStatementCommandOutput) => void - ): Promise | void { - const command = new BatchExecuteStatementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The BatchGetItem operation returns the attributes of one or more items - * from one or more tables. You identify requested items by primary key.

- *

A single operation can retrieve up to 16 MB of data, which can contain as many as 100 - * items. BatchGetItem returns a partial result if the response size limit is - * exceeded, the table's provisioned throughput is exceeded, or an internal processing - * failure occurs. If a partial result is returned, the operation returns a value for - * UnprocessedKeys. You can use this value to retry the operation starting - * with the next item to get.

- * - *

If you request more than 100 items, BatchGetItem returns a - * ValidationException with the message "Too many items requested for - * the BatchGetItem call."

- *
- *

For example, if you ask to retrieve 100 items, but each individual item is 300 KB in - * size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns - * an appropriate UnprocessedKeys value so you can get the next page of - * results. If desired, your application can include its own logic to assemble the pages of - * results into one dataset.

- *

If none of the items can be processed due to insufficient - * provisioned throughput on all of the tables in the request, then - * BatchGetItem returns a - * ProvisionedThroughputExceededException. If at least - * one of the items is successfully processed, then - * BatchGetItem completes successfully, while returning the keys of the - * unread items in UnprocessedKeys.

- * - *

If DynamoDB returns any unprocessed items, you should retry the batch operation on - * those items. However, we strongly recommend that you use an exponential - * backoff algorithm. If you retry the batch operation immediately, the - * underlying read or write requests can still fail due to throttling on the individual - * tables. If you delay the batch operation using exponential backoff, the individual - * requests in the batch are much more likely to succeed.

- *

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB - * Developer Guide.

- *
- *

By default, BatchGetItem performs eventually consistent reads on every - * table in the request. If you want strongly consistent reads instead, you can set - * ConsistentRead to true for any or all tables.

- *

In order to minimize response latency, BatchGetItem may retrieve items in - * parallel.

- *

When designing your application, keep in mind that DynamoDB does not return items in - * any particular order. To help parse the response by item, include the primary key values - * for the items in your request in the ProjectionExpression parameter.

- *

If a requested item does not exist, it is not returned in the result. Requests for - * nonexistent items consume the minimum read capacity units according to the type of read. - * For more information, see Working with Tables in the Amazon DynamoDB Developer - * Guide.

+ * @see {@link BatchGetItemCommand} */ - public batchGetItem( - args: BatchGetItemCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public batchGetItem(args: BatchGetItemCommandInput, cb: (err: any, data?: BatchGetItemCommandOutput) => void): void; - public batchGetItem( + batchGetItem(args: BatchGetItemCommandInput, options?: __HttpHandlerOptions): Promise; + batchGetItem(args: BatchGetItemCommandInput, cb: (err: any, data?: BatchGetItemCommandOutput) => void): void; + batchGetItem( args: BatchGetItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetItemCommandOutput) => void ): void; - public batchGetItem( - args: BatchGetItemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetItemCommandOutput) => void), - cb?: (err: any, data?: BatchGetItemCommandOutput) => void - ): Promise | void { - const command = new BatchGetItemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The BatchWriteItem operation puts or deletes multiple items in one or - * more tables. A single call to BatchWriteItem can transmit up to 16MB of - * data over the network, consisting of up to 25 item put or delete operations. While - * individual items can be up to 400 KB once stored, it's important to note that an item's - * representation might be greater than 400KB while being sent in DynamoDB's JSON format - * for the API call. For more details on this distinction, see Naming Rules and Data Types.

- * - *

- * BatchWriteItem cannot update items. If you perform a BatchWriteItem - * operation on an existing item, that item's values will be overwritten by the - * operation and it will appear like it was updated. To update items, we recommend you - * use the UpdateItem action.

- *
- *

The individual PutItem and DeleteItem operations specified - * in BatchWriteItem are atomic; however BatchWriteItem as a - * whole is not. If any requested operations fail because the table's provisioned - * throughput is exceeded or an internal processing failure occurs, the failed operations - * are returned in the UnprocessedItems response parameter. You can - * investigate and optionally resend the requests. Typically, you would call - * BatchWriteItem in a loop. Each iteration would check for unprocessed - * items and submit a new BatchWriteItem request with those unprocessed items - * until all items have been processed.

- *

If none of the items can be processed due to insufficient - * provisioned throughput on all of the tables in the request, then - * BatchWriteItem returns a - * ProvisionedThroughputExceededException.

- * - *

If DynamoDB returns any unprocessed items, you should retry the batch operation on - * those items. However, we strongly recommend that you use an exponential - * backoff algorithm. If you retry the batch operation immediately, the - * underlying read or write requests can still fail due to throttling on the individual - * tables. If you delay the batch operation using exponential backoff, the individual - * requests in the batch are much more likely to succeed.

- *

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB - * Developer Guide.

- *
- *

With BatchWriteItem, you can efficiently write or delete large amounts of - * data, such as from Amazon EMR, or copy data from another database into DynamoDB. In - * order to improve performance with these large-scale operations, - * BatchWriteItem does not behave in the same way as individual - * PutItem and DeleteItem calls would. For example, you - * cannot specify conditions on individual put and delete requests, and - * BatchWriteItem does not return deleted items in the response.

- *

If you use a programming language that supports concurrency, you can use threads to - * write items in parallel. Your application must include the necessary logic to manage the - * threads. With languages that don't support threading, you must update or delete the - * specified items one at a time. In both situations, BatchWriteItem performs - * the specified put and delete operations in parallel, giving you the power of the thread - * pool approach without having to introduce complexity into your application.

- *

Parallel processing reduces latency, but each specified put and delete request - * consumes the same number of write capacity units whether it is processed in parallel or - * not. Delete operations on nonexistent items consume one write capacity unit.

- *

If one or more of the following is true, DynamoDB rejects the entire batch write - * operation:

- *
    - *
  • - *

    One or more tables specified in the BatchWriteItem request does - * not exist.

    - *
  • - *
  • - *

    Primary key attributes specified on an item in the request do not match those - * in the corresponding table's primary key schema.

    - *
  • - *
  • - *

    You try to perform multiple operations on the same item in the same - * BatchWriteItem request. For example, you cannot put and delete - * the same item in the same BatchWriteItem request.

    - *
  • - *
  • - *

    Your request contains at least two items with identical hash and range keys - * (which essentially is two put operations).

    - *
  • - *
  • - *

    There are more than 25 requests in the batch.

    - *
  • - *
  • - *

    Any individual item in a batch exceeds 400 KB.

    - *
  • - *
  • - *

    The total request size exceeds 16 MB.

    - *
  • - *
+ * @see {@link BatchWriteItemCommand} */ - public batchWriteItem( + batchWriteItem( args: BatchWriteItemCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchWriteItem( - args: BatchWriteItemCommandInput, - cb: (err: any, data?: BatchWriteItemCommandOutput) => void - ): void; - public batchWriteItem( + batchWriteItem(args: BatchWriteItemCommandInput, cb: (err: any, data?: BatchWriteItemCommandOutput) => void): void; + batchWriteItem( args: BatchWriteItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchWriteItemCommandOutput) => void ): void; - public batchWriteItem( - args: BatchWriteItemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchWriteItemCommandOutput) => void), - cb?: (err: any, data?: BatchWriteItemCommandOutput) => void - ): Promise | void { - const command = new BatchWriteItemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a backup for an existing table.

- *

Each time you create an on-demand backup, the entire table data is backed up. There - * is no limit to the number of on-demand backups that can be taken.

- *

When you create an on-demand backup, a time marker of the request is cataloged, and - * the backup is created asynchronously, by applying all changes until the time of the - * request to the last full table snapshot. Backup requests are processed instantaneously - * and become available for restore within minutes.

- *

You can call CreateBackup at a maximum rate of 50 times per - * second.

- *

All backups in DynamoDB work without consuming any provisioned throughput on the - * table.

- *

If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to - * contain all data committed to the table up to 14:24:00, and data committed after - * 14:26:00 will not be. The backup might contain data modifications made between 14:24:00 - * and 14:26:00. On-demand backup does not support causal consistency.

- *

Along with data, the following are also included on the backups:

- *
    - *
  • - *

    Global secondary indexes (GSIs)

    - *
  • - *
  • - *

    Local secondary indexes (LSIs)

    - *
  • - *
  • - *

    Streams

    - *
  • - *
  • - *

    Provisioned read and write capacity

    - *
  • - *
+ * @see {@link CreateBackupCommand} */ - public createBackup( - args: CreateBackupCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createBackup(args: CreateBackupCommandInput, cb: (err: any, data?: CreateBackupCommandOutput) => void): void; - public createBackup( + createBackup(args: CreateBackupCommandInput, options?: __HttpHandlerOptions): Promise; + createBackup(args: CreateBackupCommandInput, cb: (err: any, data?: CreateBackupCommandOutput) => void): void; + createBackup( args: CreateBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBackupCommandOutput) => void ): void; - public createBackup( - args: CreateBackupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBackupCommandOutput) => void), - cb?: (err: any, data?: CreateBackupCommandOutput) => void - ): Promise | void { - const command = new CreateBackupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a global table from an existing table. A global table creates a replication - * relationship between two or more DynamoDB tables with the same table name in the - * provided Regions.

- * - *

This operation only applies to Version - * 2017.11.29 (Legacy) of global tables. We recommend using - * Version 2019.11.21 (Current) - * when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than - * 2017.11.29 (Legacy). To determine which version you are using, see - * Determining the version. - * To update existing global tables from version 2017.11.29 (Legacy) to version - * 2019.11.21 (Current), see - * Updating global tables. - *

- *
- *

If you want to add a new replica table to a global table, each of the following - * conditions must be true:

- *
    - *
  • - *

    The table must have the same primary key as all of the other replicas.

    - *
  • - *
  • - *

    The table must have the same name as all of the other replicas.

    - *
  • - *
  • - *

    The table must have DynamoDB Streams enabled, with the stream containing both - * the new and the old images of the item.

    - *
  • - *
  • - *

    None of the replica tables in the global table can contain any data.

    - *
  • - *
- *

If global secondary indexes are specified, then the following conditions must also be - * met:

- *
    - *
  • - *

    The global secondary indexes must have the same name.

    - *
  • - *
  • - *

    The global secondary indexes must have the same hash key and sort key (if - * present).

    - *
  • - *
- *

If local secondary indexes are specified, then the following conditions must also be - * met:

- *
    - *
  • - *

    The local secondary indexes must have the same name.

    - *
  • - *
  • - *

    The local secondary indexes must have the same hash key and sort key (if - * present).

    - *
  • - *
- * - *

Write capacity settings should be set consistently across your replica tables and - * secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the - * write capacity settings for all of your global tables replicas and indexes.

- *

If you prefer to manage write capacity settings manually, you should provision - * equal replicated write capacity units to your replica tables. You should also - * provision equal replicated write capacity units to matching secondary indexes across - * your global table.

- *
+ * @see {@link CreateGlobalTableCommand} */ - public createGlobalTable( + createGlobalTable( args: CreateGlobalTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public createGlobalTable( + createGlobalTable( args: CreateGlobalTableCommandInput, cb: (err: any, data?: CreateGlobalTableCommandOutput) => void ): void; - public createGlobalTable( + createGlobalTable( args: CreateGlobalTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGlobalTableCommandOutput) => void ): void; - public createGlobalTable( - args: CreateGlobalTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGlobalTableCommandOutput) => void), - cb?: (err: any, data?: CreateGlobalTableCommandOutput) => void - ): Promise | void { - const command = new CreateGlobalTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The CreateTable operation adds a new table to your account. In an Amazon Web Services account, table names must be unique within each Region. That is, you can - * have two tables with same name if you create the tables in different Regions.

- *

- * CreateTable is an asynchronous operation. Upon receiving a - * CreateTable request, DynamoDB immediately returns a response with a - * TableStatus of CREATING. After the table is created, - * DynamoDB sets the TableStatus to ACTIVE. You can perform read - * and write operations only on an ACTIVE table.

- *

You can optionally define secondary indexes on the new table, as part of the - * CreateTable operation. If you want to create multiple tables with - * secondary indexes on them, you must create the tables sequentially. Only one table with - * secondary indexes can be in the CREATING state at any given time.

- *

You can use the DescribeTable action to check the table status.

+ * @see {@link CreateTableCommand} */ - public createTable(args: CreateTableCommandInput, options?: __HttpHandlerOptions): Promise; - public createTable(args: CreateTableCommandInput, cb: (err: any, data?: CreateTableCommandOutput) => void): void; - public createTable( + createTable(args: CreateTableCommandInput, options?: __HttpHandlerOptions): Promise; + createTable(args: CreateTableCommandInput, cb: (err: any, data?: CreateTableCommandOutput) => void): void; + createTable( args: CreateTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTableCommandOutput) => void ): void; - public createTable( - args: CreateTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTableCommandOutput) => void), - cb?: (err: any, data?: CreateTableCommandOutput) => void - ): Promise | void { - const command = new CreateTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing backup of a table.

- *

You can call DeleteBackup at a maximum rate of 10 times per - * second.

+ * @see {@link DeleteBackupCommand} */ - public deleteBackup( - args: DeleteBackupCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteBackup(args: DeleteBackupCommandInput, cb: (err: any, data?: DeleteBackupCommandOutput) => void): void; - public deleteBackup( + deleteBackup(args: DeleteBackupCommandInput, options?: __HttpHandlerOptions): Promise; + deleteBackup(args: DeleteBackupCommandInput, cb: (err: any, data?: DeleteBackupCommandOutput) => void): void; + deleteBackup( args: DeleteBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackupCommandOutput) => void ): void; - public deleteBackup( - args: DeleteBackupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBackupCommandOutput) => void), - cb?: (err: any, data?: DeleteBackupCommandOutput) => void - ): Promise | void { - const command = new DeleteBackupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a single item in a table by primary key. You can perform a conditional delete - * operation that deletes the item if it exists, or if it has an expected attribute - * value.

- *

In addition to deleting an item, you can also return the item's attribute values in - * the same operation, using the ReturnValues parameter.

- *

Unless you specify conditions, the DeleteItem is an idempotent operation; - * running it multiple times on the same item or attribute does not - * result in an error response.

- *

Conditional deletes are useful for deleting items only if specific conditions are met. - * If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not - * deleted.

+ * @see {@link DeleteItemCommand} */ - public deleteItem(args: DeleteItemCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteItem(args: DeleteItemCommandInput, cb: (err: any, data?: DeleteItemCommandOutput) => void): void; - public deleteItem( + deleteItem(args: DeleteItemCommandInput, options?: __HttpHandlerOptions): Promise; + deleteItem(args: DeleteItemCommandInput, cb: (err: any, data?: DeleteItemCommandOutput) => void): void; + deleteItem( args: DeleteItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteItemCommandOutput) => void ): void; - public deleteItem( - args: DeleteItemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteItemCommandOutput) => void), - cb?: (err: any, data?: DeleteItemCommandOutput) => void - ): Promise | void { - const command = new DeleteItemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The DeleteTable operation deletes a table and all of its items. After a - * DeleteTable request, the specified table is in the - * DELETING state until DynamoDB completes the deletion. If the table is - * in the ACTIVE state, you can delete it. If a table is in - * CREATING or UPDATING states, then DynamoDB returns a - * ResourceInUseException. If the specified table does not exist, DynamoDB - * returns a ResourceNotFoundException. If table is already in the - * DELETING state, no error is returned.

- * - *

This operation only applies to Version 2019.11.21 (Current) - * of global tables. - *

- *
- * - *

DynamoDB might continue to accept data read and write operations, such as - * GetItem and PutItem, on a table in the - * DELETING state until the table deletion is complete.

- *
- *

When you delete a table, any indexes on that table are also deleted.

- *

If you have DynamoDB Streams enabled on the table, then the corresponding stream on - * that table goes into the DISABLED state, and the stream is automatically - * deleted after 24 hours.

- *

Use the DescribeTable action to check the status of the table.

+ * @see {@link DeleteTableCommand} */ - public deleteTable(args: DeleteTableCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteTable(args: DeleteTableCommandInput, cb: (err: any, data?: DeleteTableCommandOutput) => void): void; - public deleteTable( + deleteTable(args: DeleteTableCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTable(args: DeleteTableCommandInput, cb: (err: any, data?: DeleteTableCommandOutput) => void): void; + deleteTable( args: DeleteTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTableCommandOutput) => void ): void; - public deleteTable( - args: DeleteTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTableCommandOutput) => void), - cb?: (err: any, data?: DeleteTableCommandOutput) => void - ): Promise | void { - const command = new DeleteTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an existing backup of a table.

- *

You can call DescribeBackup at a maximum rate of 10 times per - * second.

+ * @see {@link DescribeBackupCommand} */ - public describeBackup( + describeBackup( args: DescribeBackupCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBackup( - args: DescribeBackupCommandInput, - cb: (err: any, data?: DescribeBackupCommandOutput) => void - ): void; - public describeBackup( + describeBackup(args: DescribeBackupCommandInput, cb: (err: any, data?: DescribeBackupCommandOutput) => void): void; + describeBackup( args: DescribeBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBackupCommandOutput) => void ): void; - public describeBackup( - args: DescribeBackupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBackupCommandOutput) => void), - cb?: (err: any, data?: DescribeBackupCommandOutput) => void - ): Promise | void { - const command = new DescribeBackupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Checks the status of continuous backups and point in time recovery on the specified - * table. Continuous backups are ENABLED on all tables at table creation. If - * point in time recovery is enabled, PointInTimeRecoveryStatus will be set to - * ENABLED.

- *

After continuous backups and point in time recovery are enabled, you can restore to - * any point in time within EarliestRestorableDateTime and - * LatestRestorableDateTime.

- *

- * LatestRestorableDateTime is typically 5 minutes before the current time. - * You can restore your table to any point in time during the last 35 days.

- *

You can call DescribeContinuousBackups at a maximum rate of 10 times per - * second.

+ * @see {@link DescribeContinuousBackupsCommand} */ - public describeContinuousBackups( + describeContinuousBackups( args: DescribeContinuousBackupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeContinuousBackups( + describeContinuousBackups( args: DescribeContinuousBackupsCommandInput, cb: (err: any, data?: DescribeContinuousBackupsCommandOutput) => void ): void; - public describeContinuousBackups( + describeContinuousBackups( args: DescribeContinuousBackupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeContinuousBackupsCommandOutput) => void ): void; - public describeContinuousBackups( - args: DescribeContinuousBackupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeContinuousBackupsCommandOutput) => void), - cb?: (err: any, data?: DescribeContinuousBackupsCommandOutput) => void - ): Promise | void { - const command = new DescribeContinuousBackupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about contributor insights for a given table or global secondary - * index.

+ * @see {@link DescribeContributorInsightsCommand} */ - public describeContributorInsights( + describeContributorInsights( args: DescribeContributorInsightsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeContributorInsights( + describeContributorInsights( args: DescribeContributorInsightsCommandInput, cb: (err: any, data?: DescribeContributorInsightsCommandOutput) => void ): void; - public describeContributorInsights( + describeContributorInsights( args: DescribeContributorInsightsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeContributorInsightsCommandOutput) => void ): void; - public describeContributorInsights( - args: DescribeContributorInsightsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeContributorInsightsCommandOutput) => void), - cb?: (err: any, data?: DescribeContributorInsightsCommandOutput) => void - ): Promise | void { - const command = new DescribeContributorInsightsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the regional endpoint information. This action must be included in your VPC - * endpoint policies, or access to the DescribeEndpoints API will be denied. For more information - * on policy permissions, please see Internetwork traffic privacy.

+ * @see {@link DescribeEndpointsCommand} */ - public describeEndpoints( + describeEndpoints( args: DescribeEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEndpoints( + describeEndpoints( args: DescribeEndpointsCommandInput, cb: (err: any, data?: DescribeEndpointsCommandOutput) => void ): void; - public describeEndpoints( + describeEndpoints( args: DescribeEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEndpointsCommandOutput) => void ): void; - public describeEndpoints( - args: DescribeEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEndpointsCommandOutput) => void), - cb?: (err: any, data?: DescribeEndpointsCommandOutput) => void - ): Promise | void { - const command = new DescribeEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an existing table export.

+ * @see {@link DescribeExportCommand} */ - public describeExport( + describeExport( args: DescribeExportCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeExport( - args: DescribeExportCommandInput, - cb: (err: any, data?: DescribeExportCommandOutput) => void - ): void; - public describeExport( + describeExport(args: DescribeExportCommandInput, cb: (err: any, data?: DescribeExportCommandOutput) => void): void; + describeExport( args: DescribeExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExportCommandOutput) => void ): void; - public describeExport( - args: DescribeExportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeExportCommandOutput) => void), - cb?: (err: any, data?: DescribeExportCommandOutput) => void - ): Promise | void { - const command = new DescribeExportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the specified global table.

- * - *

This operation only applies to Version - * 2017.11.29 (Legacy) of global tables. We recommend using - * Version 2019.11.21 (Current) - * when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than - * 2017.11.29 (Legacy). To determine which version you are using, see - * Determining the version. - * To update existing global tables from version 2017.11.29 (Legacy) to version - * 2019.11.21 (Current), see - * Updating global tables. - *

- *
+ * @see {@link DescribeGlobalTableCommand} */ - public describeGlobalTable( + describeGlobalTable( args: DescribeGlobalTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGlobalTable( + describeGlobalTable( args: DescribeGlobalTableCommandInput, cb: (err: any, data?: DescribeGlobalTableCommandOutput) => void ): void; - public describeGlobalTable( + describeGlobalTable( args: DescribeGlobalTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGlobalTableCommandOutput) => void ): void; - public describeGlobalTable( - args: DescribeGlobalTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGlobalTableCommandOutput) => void), - cb?: (err: any, data?: DescribeGlobalTableCommandOutput) => void - ): Promise | void { - const command = new DescribeGlobalTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes Region-specific settings for a global table.

- * - *

This operation only applies to Version - * 2017.11.29 (Legacy) of global tables. We recommend using - * Version 2019.11.21 (Current) - * when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than - * 2017.11.29 (Legacy). To determine which version you are using, see - * Determining the version. - * To update existing global tables from version 2017.11.29 (Legacy) to version - * 2019.11.21 (Current), see - * Updating global tables. - *

- *
+ * @see {@link DescribeGlobalTableSettingsCommand} */ - public describeGlobalTableSettings( + describeGlobalTableSettings( args: DescribeGlobalTableSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGlobalTableSettings( + describeGlobalTableSettings( args: DescribeGlobalTableSettingsCommandInput, cb: (err: any, data?: DescribeGlobalTableSettingsCommandOutput) => void ): void; - public describeGlobalTableSettings( + describeGlobalTableSettings( args: DescribeGlobalTableSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGlobalTableSettingsCommandOutput) => void ): void; - public describeGlobalTableSettings( - args: DescribeGlobalTableSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGlobalTableSettingsCommandOutput) => void), - cb?: (err: any, data?: DescribeGlobalTableSettingsCommandOutput) => void - ): Promise | void { - const command = new DescribeGlobalTableSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Represents the properties of the import.

+ * @see {@link DescribeImportCommand} */ - public describeImport( + describeImport( args: DescribeImportCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeImport( - args: DescribeImportCommandInput, - cb: (err: any, data?: DescribeImportCommandOutput) => void - ): void; - public describeImport( + describeImport(args: DescribeImportCommandInput, cb: (err: any, data?: DescribeImportCommandOutput) => void): void; + describeImport( args: DescribeImportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImportCommandOutput) => void ): void; - public describeImport( - args: DescribeImportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeImportCommandOutput) => void), - cb?: (err: any, data?: DescribeImportCommandOutput) => void - ): Promise | void { - const command = new DescribeImportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the status of Kinesis streaming.

+ * @see {@link DescribeKinesisStreamingDestinationCommand} */ - public describeKinesisStreamingDestination( + describeKinesisStreamingDestination( args: DescribeKinesisStreamingDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeKinesisStreamingDestination( + describeKinesisStreamingDestination( args: DescribeKinesisStreamingDestinationCommandInput, cb: (err: any, data?: DescribeKinesisStreamingDestinationCommandOutput) => void ): void; - public describeKinesisStreamingDestination( + describeKinesisStreamingDestination( args: DescribeKinesisStreamingDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeKinesisStreamingDestinationCommandOutput) => void ): void; - public describeKinesisStreamingDestination( - args: DescribeKinesisStreamingDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeKinesisStreamingDestinationCommandOutput) => void), - cb?: (err: any, data?: DescribeKinesisStreamingDestinationCommandOutput) => void - ): Promise | void { - const command = new DescribeKinesisStreamingDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the current provisioned-capacity quotas for your Amazon Web Services account in - * a Region, both for the Region as a whole and for any one DynamoDB table that you create - * there.

- *

When you establish an Amazon Web Services account, the account has initial quotas on - * the maximum read capacity units and write capacity units that you can provision across - * all of your DynamoDB tables in a given Region. Also, there are per-table - * quotas that apply when you create a table there. For more information, see Service, - * Account, and Table Quotas page in the Amazon DynamoDB - * Developer Guide.

- *

Although you can increase these quotas by filing a case at Amazon Web Services Support Center, obtaining the - * increase is not instantaneous. The DescribeLimits action lets you write - * code to compare the capacity you are currently using to those quotas imposed by your - * account so that you have enough time to apply for an increase before you hit a - * quota.

- *

For example, you could use one of the Amazon Web Services SDKs to do the - * following:

- *
    - *
  1. - *

    Call DescribeLimits for a particular Region to obtain your - * current account quotas on provisioned capacity there.

    - *
  2. - *
  3. - *

    Create a variable to hold the aggregate read capacity units provisioned for - * all your tables in that Region, and one to hold the aggregate write capacity - * units. Zero them both.

    - *
  4. - *
  5. - *

    Call ListTables to obtain a list of all your DynamoDB - * tables.

    - *
  6. - *
  7. - *

    For each table name listed by ListTables, do the - * following:

    - *
      - *
    • - *

      Call DescribeTable with the table name.

      - *
    • - *
    • - *

      Use the data returned by DescribeTable to add the read - * capacity units and write capacity units provisioned for the table itself - * to your variables.

      - *
    • - *
    • - *

      If the table has one or more global secondary indexes (GSIs), loop - * over these GSIs and add their provisioned capacity values to your - * variables as well.

      - *
    • - *
    - *
  8. - *
  9. - *

    Report the account quotas for that Region returned by - * DescribeLimits, along with the total current provisioned - * capacity levels you have calculated.

    - *
  10. - *
- *

This will let you see whether you are getting close to your account-level - * quotas.

- *

The per-table quotas apply only when you are creating a new table. They restrict the - * sum of the provisioned capacity of the new table itself and all its global secondary - * indexes.

- *

For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned - * capacity extremely rapidly, but the only quota that applies is that the aggregate - * provisioned capacity over all your tables and GSIs cannot exceed either of the - * per-account quotas.

- * - *

- * DescribeLimits should only be called periodically. You can expect - * throttling errors if you call it more than once in a minute.

- *
- *

The DescribeLimits Request element has no content.

+ * @see {@link DescribeLimitsCommand} */ - public describeLimits( + describeLimits( args: DescribeLimitsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLimits( - args: DescribeLimitsCommandInput, - cb: (err: any, data?: DescribeLimitsCommandOutput) => void - ): void; - public describeLimits( + describeLimits(args: DescribeLimitsCommandInput, cb: (err: any, data?: DescribeLimitsCommandOutput) => void): void; + describeLimits( args: DescribeLimitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLimitsCommandOutput) => void ): void; - public describeLimits( - args: DescribeLimitsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLimitsCommandOutput) => void), - cb?: (err: any, data?: DescribeLimitsCommandOutput) => void - ): Promise | void { - const command = new DescribeLimitsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the table, including the current status of the table, when - * it was created, the primary key schema, and any indexes on the table.

- * - *

This operation only applies to Version 2019.11.21 (Current) - * of global tables. - *

- *
- * - *

If you issue a DescribeTable request immediately after a - * CreateTable request, DynamoDB might return a - * ResourceNotFoundException. This is because - * DescribeTable uses an eventually consistent query, and the metadata - * for your table might not be available at that moment. Wait for a few seconds, and - * then try the DescribeTable request again.

- *
+ * @see {@link DescribeTableCommand} */ - public describeTable( - args: DescribeTableCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeTable( - args: DescribeTableCommandInput, - cb: (err: any, data?: DescribeTableCommandOutput) => void - ): void; - public describeTable( + describeTable(args: DescribeTableCommandInput, options?: __HttpHandlerOptions): Promise; + describeTable(args: DescribeTableCommandInput, cb: (err: any, data?: DescribeTableCommandOutput) => void): void; + describeTable( args: DescribeTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTableCommandOutput) => void ): void; - public describeTable( - args: DescribeTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTableCommandOutput) => void), - cb?: (err: any, data?: DescribeTableCommandOutput) => void - ): Promise | void { - const command = new DescribeTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes auto scaling settings across replicas of the global table at once.

- * - *

This operation only applies to Version 2019.11.21 (Current) - * of global tables.

- *
+ * @see {@link DescribeTableReplicaAutoScalingCommand} */ - public describeTableReplicaAutoScaling( + describeTableReplicaAutoScaling( args: DescribeTableReplicaAutoScalingCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTableReplicaAutoScaling( + describeTableReplicaAutoScaling( args: DescribeTableReplicaAutoScalingCommandInput, cb: (err: any, data?: DescribeTableReplicaAutoScalingCommandOutput) => void ): void; - public describeTableReplicaAutoScaling( + describeTableReplicaAutoScaling( args: DescribeTableReplicaAutoScalingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTableReplicaAutoScalingCommandOutput) => void ): void; - public describeTableReplicaAutoScaling( - args: DescribeTableReplicaAutoScalingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTableReplicaAutoScalingCommandOutput) => void), - cb?: (err: any, data?: DescribeTableReplicaAutoScalingCommandOutput) => void - ): Promise | void { - const command = new DescribeTableReplicaAutoScalingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gives a description of the Time to Live (TTL) status on the specified table.

+ * @see {@link DescribeTimeToLiveCommand} */ - public describeTimeToLive( + describeTimeToLive( args: DescribeTimeToLiveCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTimeToLive( + describeTimeToLive( args: DescribeTimeToLiveCommandInput, cb: (err: any, data?: DescribeTimeToLiveCommandOutput) => void ): void; - public describeTimeToLive( + describeTimeToLive( args: DescribeTimeToLiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTimeToLiveCommandOutput) => void ): void; - public describeTimeToLive( - args: DescribeTimeToLiveCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTimeToLiveCommandOutput) => void), - cb?: (err: any, data?: DescribeTimeToLiveCommandOutput) => void - ): Promise | void { - const command = new DescribeTimeToLiveCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops replication from the DynamoDB table to the Kinesis data stream. This is done - * without deleting either of the resources.

+ * @see {@link DisableKinesisStreamingDestinationCommand} */ - public disableKinesisStreamingDestination( + disableKinesisStreamingDestination( args: DisableKinesisStreamingDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableKinesisStreamingDestination( + disableKinesisStreamingDestination( args: DisableKinesisStreamingDestinationCommandInput, cb: (err: any, data?: DisableKinesisStreamingDestinationCommandOutput) => void ): void; - public disableKinesisStreamingDestination( + disableKinesisStreamingDestination( args: DisableKinesisStreamingDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableKinesisStreamingDestinationCommandOutput) => void ): void; - public disableKinesisStreamingDestination( - args: DisableKinesisStreamingDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableKinesisStreamingDestinationCommandOutput) => void), - cb?: (err: any, data?: DisableKinesisStreamingDestinationCommandOutput) => void - ): Promise | void { - const command = new DisableKinesisStreamingDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts table data replication to the specified Kinesis data stream at a timestamp - * chosen during the enable workflow. If this operation doesn't return results immediately, - * use DescribeKinesisStreamingDestination to check if streaming to the Kinesis data stream - * is ACTIVE.

+ * @see {@link EnableKinesisStreamingDestinationCommand} */ - public enableKinesisStreamingDestination( + enableKinesisStreamingDestination( args: EnableKinesisStreamingDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableKinesisStreamingDestination( + enableKinesisStreamingDestination( args: EnableKinesisStreamingDestinationCommandInput, cb: (err: any, data?: EnableKinesisStreamingDestinationCommandOutput) => void ): void; - public enableKinesisStreamingDestination( + enableKinesisStreamingDestination( args: EnableKinesisStreamingDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableKinesisStreamingDestinationCommandOutput) => void ): void; - public enableKinesisStreamingDestination( - args: EnableKinesisStreamingDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableKinesisStreamingDestinationCommandOutput) => void), - cb?: (err: any, data?: EnableKinesisStreamingDestinationCommandOutput) => void - ): Promise | void { - const command = new EnableKinesisStreamingDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation allows you to perform reads and singleton writes on data stored in - * DynamoDB, using PartiQL.

- *

For PartiQL reads (SELECT statement), if the total number of processed - * items exceeds the maximum dataset size limit of 1 MB, the read stops and results are - * returned to the user as a LastEvaluatedKey value to continue the read in a - * subsequent operation. If the filter criteria in WHERE clause does not match - * any data, the read will return an empty result set.

- *

A single SELECT statement response can return up to the maximum number of - * items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any - * filtering to the results using WHERE clause). If - * LastEvaluatedKey is present in the response, you need to paginate the - * result set. If NextToken is present, you need to paginate the result set and include - * NextToken.

+ * @see {@link ExecuteStatementCommand} */ - public executeStatement( + executeStatement( args: ExecuteStatementCommandInput, options?: __HttpHandlerOptions ): Promise; - public executeStatement( + executeStatement( args: ExecuteStatementCommandInput, cb: (err: any, data?: ExecuteStatementCommandOutput) => void ): void; - public executeStatement( + executeStatement( args: ExecuteStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteStatementCommandOutput) => void ): void; - public executeStatement( - args: ExecuteStatementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExecuteStatementCommandOutput) => void), - cb?: (err: any, data?: ExecuteStatementCommandOutput) => void - ): Promise | void { - const command = new ExecuteStatementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation allows you to perform transactional reads or writes on data stored in - * DynamoDB, using PartiQL.

- * - *

The entire transaction must consist of either read statements or write statements, - * you cannot mix both in one transaction. The EXISTS function is an exception and can - * be used to check the condition of specific attributes of the item in a similar - * manner to ConditionCheck in the TransactWriteItems API.

- *
+ * @see {@link ExecuteTransactionCommand} */ - public executeTransaction( + executeTransaction( args: ExecuteTransactionCommandInput, options?: __HttpHandlerOptions ): Promise; - public executeTransaction( + executeTransaction( args: ExecuteTransactionCommandInput, cb: (err: any, data?: ExecuteTransactionCommandOutput) => void ): void; - public executeTransaction( + executeTransaction( args: ExecuteTransactionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteTransactionCommandOutput) => void ): void; - public executeTransaction( - args: ExecuteTransactionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExecuteTransactionCommandOutput) => void), - cb?: (err: any, data?: ExecuteTransactionCommandOutput) => void - ): Promise | void { - const command = new ExecuteTransactionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Exports table data to an S3 bucket. The table must have point in time recovery - * enabled, and you can export data from any time within the point in time recovery - * window.

+ * @see {@link ExportTableToPointInTimeCommand} */ - public exportTableToPointInTime( + exportTableToPointInTime( args: ExportTableToPointInTimeCommandInput, options?: __HttpHandlerOptions ): Promise; - public exportTableToPointInTime( + exportTableToPointInTime( args: ExportTableToPointInTimeCommandInput, cb: (err: any, data?: ExportTableToPointInTimeCommandOutput) => void ): void; - public exportTableToPointInTime( + exportTableToPointInTime( args: ExportTableToPointInTimeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportTableToPointInTimeCommandOutput) => void ): void; - public exportTableToPointInTime( - args: ExportTableToPointInTimeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportTableToPointInTimeCommandOutput) => void), - cb?: (err: any, data?: ExportTableToPointInTimeCommandOutput) => void - ): Promise | void { - const command = new ExportTableToPointInTimeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The GetItem operation returns a set of attributes for the item with the - * given primary key. If there is no matching item, GetItem does not return - * any data and there will be no Item element in the response.

- *

- * GetItem provides an eventually consistent read by default. If your - * application requires a strongly consistent read, set ConsistentRead to - * true. Although a strongly consistent read might take more time than an - * eventually consistent read, it always returns the last updated value.

+ * @see {@link GetItemCommand} */ - public getItem(args: GetItemCommandInput, options?: __HttpHandlerOptions): Promise; - public getItem(args: GetItemCommandInput, cb: (err: any, data?: GetItemCommandOutput) => void): void; - public getItem( + getItem(args: GetItemCommandInput, options?: __HttpHandlerOptions): Promise; + getItem(args: GetItemCommandInput, cb: (err: any, data?: GetItemCommandOutput) => void): void; + getItem( args: GetItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetItemCommandOutput) => void ): void; - public getItem( - args: GetItemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetItemCommandOutput) => void), - cb?: (err: any, data?: GetItemCommandOutput) => void - ): Promise | void { - const command = new GetItemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Imports table data from an S3 bucket.

+ * @see {@link ImportTableCommand} */ - public importTable(args: ImportTableCommandInput, options?: __HttpHandlerOptions): Promise; - public importTable(args: ImportTableCommandInput, cb: (err: any, data?: ImportTableCommandOutput) => void): void; - public importTable( + importTable(args: ImportTableCommandInput, options?: __HttpHandlerOptions): Promise; + importTable(args: ImportTableCommandInput, cb: (err: any, data?: ImportTableCommandOutput) => void): void; + importTable( args: ImportTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportTableCommandOutput) => void ): void; - public importTable( - args: ImportTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportTableCommandOutput) => void), - cb?: (err: any, data?: ImportTableCommandOutput) => void - ): Promise | void { - const command = new ImportTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List backups associated with an Amazon Web Services account. To list backups for a - * given table, specify TableName. ListBackups returns a - * paginated list of results with at most 1 MB worth of items in a page. You can also - * specify a maximum number of entries to be returned in a page.

- *

In the request, start time is inclusive, but end time is exclusive. Note that these - * boundaries are for the time at which the original backup was requested.

- *

You can call ListBackups a maximum of five times per second.

+ * @see {@link ListBackupsCommand} */ - public listBackups(args: ListBackupsCommandInput, options?: __HttpHandlerOptions): Promise; - public listBackups(args: ListBackupsCommandInput, cb: (err: any, data?: ListBackupsCommandOutput) => void): void; - public listBackups( + listBackups(args: ListBackupsCommandInput, options?: __HttpHandlerOptions): Promise; + listBackups(args: ListBackupsCommandInput, cb: (err: any, data?: ListBackupsCommandOutput) => void): void; + listBackups( args: ListBackupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBackupsCommandOutput) => void ): void; - public listBackups( - args: ListBackupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBackupsCommandOutput) => void), - cb?: (err: any, data?: ListBackupsCommandOutput) => void - ): Promise | void { - const command = new ListBackupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of ContributorInsightsSummary for a table and all its global secondary - * indexes.

+ * @see {@link ListContributorInsightsCommand} */ - public listContributorInsights( + listContributorInsights( args: ListContributorInsightsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listContributorInsights( + listContributorInsights( args: ListContributorInsightsCommandInput, cb: (err: any, data?: ListContributorInsightsCommandOutput) => void ): void; - public listContributorInsights( + listContributorInsights( args: ListContributorInsightsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListContributorInsightsCommandOutput) => void ): void; - public listContributorInsights( - args: ListContributorInsightsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListContributorInsightsCommandOutput) => void), - cb?: (err: any, data?: ListContributorInsightsCommandOutput) => void - ): Promise | void { - const command = new ListContributorInsightsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists completed exports within the past 90 days.

+ * @see {@link ListExportsCommand} */ - public listExports(args: ListExportsCommandInput, options?: __HttpHandlerOptions): Promise; - public listExports(args: ListExportsCommandInput, cb: (err: any, data?: ListExportsCommandOutput) => void): void; - public listExports( + listExports(args: ListExportsCommandInput, options?: __HttpHandlerOptions): Promise; + listExports(args: ListExportsCommandInput, cb: (err: any, data?: ListExportsCommandOutput) => void): void; + listExports( args: ListExportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExportsCommandOutput) => void ): void; - public listExports( - args: ListExportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListExportsCommandOutput) => void), - cb?: (err: any, data?: ListExportsCommandOutput) => void - ): Promise | void { - const command = new ListExportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all global tables that have a replica in the specified Region.

- * - *

This operation only applies to Version - * 2017.11.29 (Legacy) of global tables. We recommend using - * Version 2019.11.21 (Current) - * when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than - * 2017.11.29 (Legacy). To determine which version you are using, see - * Determining the version. - * To update existing global tables from version 2017.11.29 (Legacy) to version - * 2019.11.21 (Current), see - * Updating global tables. - *

- *
+ * @see {@link ListGlobalTablesCommand} */ - public listGlobalTables( + listGlobalTables( args: ListGlobalTablesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGlobalTables( + listGlobalTables( args: ListGlobalTablesCommandInput, cb: (err: any, data?: ListGlobalTablesCommandOutput) => void ): void; - public listGlobalTables( + listGlobalTables( args: ListGlobalTablesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGlobalTablesCommandOutput) => void ): void; - public listGlobalTables( - args: ListGlobalTablesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGlobalTablesCommandOutput) => void), - cb?: (err: any, data?: ListGlobalTablesCommandOutput) => void - ): Promise | void { - const command = new ListGlobalTablesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists completed imports within the past 90 days.

+ * @see {@link ListImportsCommand} */ - public listImports(args: ListImportsCommandInput, options?: __HttpHandlerOptions): Promise; - public listImports(args: ListImportsCommandInput, cb: (err: any, data?: ListImportsCommandOutput) => void): void; - public listImports( + listImports(args: ListImportsCommandInput, options?: __HttpHandlerOptions): Promise; + listImports(args: ListImportsCommandInput, cb: (err: any, data?: ListImportsCommandOutput) => void): void; + listImports( args: ListImportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImportsCommandOutput) => void ): void; - public listImports( - args: ListImportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListImportsCommandOutput) => void), - cb?: (err: any, data?: ListImportsCommandOutput) => void - ): Promise | void { - const command = new ListImportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of table names associated with the current account and endpoint. The - * output from ListTables is paginated, with each page returning a maximum of - * 100 table names.

+ * @see {@link ListTablesCommand} */ - public listTables(args: ListTablesCommandInput, options?: __HttpHandlerOptions): Promise; - public listTables(args: ListTablesCommandInput, cb: (err: any, data?: ListTablesCommandOutput) => void): void; - public listTables( + listTables(args: ListTablesCommandInput, options?: __HttpHandlerOptions): Promise; + listTables(args: ListTablesCommandInput, cb: (err: any, data?: ListTablesCommandOutput) => void): void; + listTables( args: ListTablesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTablesCommandOutput) => void ): void; - public listTables( - args: ListTablesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTablesCommandOutput) => void), - cb?: (err: any, data?: ListTablesCommandOutput) => void - ): Promise | void { - const command = new ListTablesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 - * times per second, per account.

- *

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB - * in the Amazon DynamoDB Developer Guide.

+ * @see {@link ListTagsOfResourceCommand} */ - public listTagsOfResource( + listTagsOfResource( args: ListTagsOfResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsOfResource( + listTagsOfResource( args: ListTagsOfResourceCommandInput, cb: (err: any, data?: ListTagsOfResourceCommandOutput) => void ): void; - public listTagsOfResource( + listTagsOfResource( args: ListTagsOfResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsOfResourceCommandOutput) => void ): void; - public listTagsOfResource( - args: ListTagsOfResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsOfResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsOfResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsOfResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new item, or replaces an old item with a new item. If an item that has the - * same primary key as the new item already exists in the specified table, the new item - * completely replaces the existing item. You can perform a conditional put operation (add - * a new item if one with the specified primary key doesn't exist), or replace an existing - * item if it has certain attribute values. You can return the item's attribute values in - * the same operation, using the ReturnValues parameter.

- *

When you add an item, the primary key attributes are the only required attributes. - *

- *

Empty String and Binary attribute values are allowed. Attribute values of type String - * and Binary must have a length greater than zero if the attribute is used as a key - * attribute for a table or index. Set type attributes cannot be empty.

- *

Invalid Requests with empty values will be rejected with a - * ValidationException exception.

- * - *

To prevent a new item from replacing an existing item, use a conditional - * expression that contains the attribute_not_exists function with the - * name of the attribute being used as the partition key for the table. Since every - * record must contain that attribute, the attribute_not_exists function - * will only succeed if no matching item exists.

- *
- *

For more information about PutItem, see Working with - * Items in the Amazon DynamoDB Developer Guide.

+ * @see {@link PutItemCommand} */ - public putItem(args: PutItemCommandInput, options?: __HttpHandlerOptions): Promise; - public putItem(args: PutItemCommandInput, cb: (err: any, data?: PutItemCommandOutput) => void): void; - public putItem( + putItem(args: PutItemCommandInput, options?: __HttpHandlerOptions): Promise; + putItem(args: PutItemCommandInput, cb: (err: any, data?: PutItemCommandOutput) => void): void; + putItem( args: PutItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutItemCommandOutput) => void ): void; - public putItem( - args: PutItemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutItemCommandOutput) => void), - cb?: (err: any, data?: PutItemCommandOutput) => void - ): Promise | void { - const command = new PutItemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

You must provide the name of the partition key attribute and a single value for that - * attribute. Query returns all items with that partition key value. - * Optionally, you can provide a sort key attribute and use a comparison operator to refine - * the search results.

- *

Use the KeyConditionExpression parameter to provide a specific value for - * the partition key. The Query operation will return all of the items from - * the table or index with that partition key value. You can optionally narrow the scope of - * the Query operation by specifying a sort key value and a comparison - * operator in KeyConditionExpression. To further refine the - * Query results, you can optionally provide a - * FilterExpression. A FilterExpression determines which - * items within the results should be returned to you. All of the other results are - * discarded.

- *

A Query operation always returns a result set. If no matching items are - * found, the result set will be empty. Queries that do not return results consume the - * minimum number of read capacity units for that type of read operation.

- * - *

DynamoDB calculates the number of read capacity units consumed based on item - * size, not on the amount of data that is returned to an application. The number of - * capacity units consumed will be the same whether you request all of the attributes - * (the default behavior) or just some of them (using a projection expression). The - * number will also be the same whether or not you use a FilterExpression. - *

- *
- *

- * Query results are always sorted by the sort key value. If the data type of - * the sort key is Number, the results are returned in numeric order; otherwise, the - * results are returned in order of UTF-8 bytes. By default, the sort order is ascending. - * To reverse the order, set the ScanIndexForward parameter to false.

- *

A single Query operation will read up to the maximum number of items set - * (if using the Limit parameter) or a maximum of 1 MB of data and then apply - * any filtering to the results using FilterExpression. If - * LastEvaluatedKey is present in the response, you will need to paginate - * the result set. For more information, see Paginating - * the Results in the Amazon DynamoDB Developer Guide.

- *

- * FilterExpression is applied after a Query finishes, but before - * the results are returned. A FilterExpression cannot contain partition key - * or sort key attributes. You need to specify those attributes in the - * KeyConditionExpression.

- * - *

A Query operation can return an empty result set and a - * LastEvaluatedKey if all the items read for the page of results are - * filtered out.

- *
- *

You can query a table, a local secondary index, or a global secondary index. For a - * query on a table or on a local secondary index, you can set the - * ConsistentRead parameter to true and obtain a strongly - * consistent result. Global secondary indexes support eventually consistent reads only, so - * do not specify ConsistentRead when querying a global secondary - * index.

+ * @see {@link QueryCommand} */ - public query(args: QueryCommandInput, options?: __HttpHandlerOptions): Promise; - public query(args: QueryCommandInput, cb: (err: any, data?: QueryCommandOutput) => void): void; - public query( + query(args: QueryCommandInput, options?: __HttpHandlerOptions): Promise; + query(args: QueryCommandInput, cb: (err: any, data?: QueryCommandOutput) => void): void; + query( args: QueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryCommandOutput) => void ): void; - public query( - args: QueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryCommandOutput) => void), - cb?: (err: any, data?: QueryCommandOutput) => void - ): Promise | void { - const command = new QueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new table from an existing backup. Any number of users can execute up to 50 - * concurrent restores (any type of restore) in a given account.

- *

You can call RestoreTableFromBackup at a maximum rate of 10 times per - * second.

- *

You must manually set up the following on the restored table:

- *
    - *
  • - *

    Auto scaling policies

    - *
  • - *
  • - *

    IAM policies

    - *
  • - *
  • - *

    Amazon CloudWatch metrics and alarms

    - *
  • - *
  • - *

    Tags

    - *
  • - *
  • - *

    Stream settings

    - *
  • - *
  • - *

    Time to Live (TTL) settings

    - *
  • - *
+ * @see {@link RestoreTableFromBackupCommand} */ - public restoreTableFromBackup( + restoreTableFromBackup( args: RestoreTableFromBackupCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreTableFromBackup( + restoreTableFromBackup( args: RestoreTableFromBackupCommandInput, cb: (err: any, data?: RestoreTableFromBackupCommandOutput) => void ): void; - public restoreTableFromBackup( + restoreTableFromBackup( args: RestoreTableFromBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreTableFromBackupCommandOutput) => void ): void; - public restoreTableFromBackup( - args: RestoreTableFromBackupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreTableFromBackupCommandOutput) => void), - cb?: (err: any, data?: RestoreTableFromBackupCommandOutput) => void - ): Promise | void { - const command = new RestoreTableFromBackupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Restores the specified table to the specified point in time within - * EarliestRestorableDateTime and LatestRestorableDateTime. - * You can restore your table to any point in time during the last 35 days. Any number of - * users can execute up to 4 concurrent restores (any type of restore) in a given account.

- *

When you restore using point in time recovery, DynamoDB restores your table data to - * the state based on the selected date and time (day:hour:minute:second) to a new table.

- *

Along with data, the following are also included on the new restored table using - * point in time recovery:

- *
    - *
  • - *

    Global secondary indexes (GSIs)

    - *
  • - *
  • - *

    Local secondary indexes (LSIs)

    - *
  • - *
  • - *

    Provisioned read and write capacity

    - *
  • - *
  • - *

    Encryption settings

    - * - *

    All these settings come from the current settings of the source table at - * the time of restore.

    - *
    - *
  • - *
- *

You must manually set up the following on the restored table:

- *
    - *
  • - *

    Auto scaling policies

    - *
  • - *
  • - *

    IAM policies

    - *
  • - *
  • - *

    Amazon CloudWatch metrics and alarms

    - *
  • - *
  • - *

    Tags

    - *
  • - *
  • - *

    Stream settings

    - *
  • - *
  • - *

    Time to Live (TTL) settings

    - *
  • - *
  • - *

    Point in time recovery settings

    - *
  • - *
+ * @see {@link RestoreTableToPointInTimeCommand} */ - public restoreTableToPointInTime( + restoreTableToPointInTime( args: RestoreTableToPointInTimeCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreTableToPointInTime( + restoreTableToPointInTime( args: RestoreTableToPointInTimeCommandInput, cb: (err: any, data?: RestoreTableToPointInTimeCommandOutput) => void ): void; - public restoreTableToPointInTime( + restoreTableToPointInTime( args: RestoreTableToPointInTimeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreTableToPointInTimeCommandOutput) => void ): void; - public restoreTableToPointInTime( - args: RestoreTableToPointInTimeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreTableToPointInTimeCommandOutput) => void), - cb?: (err: any, data?: RestoreTableToPointInTimeCommandOutput) => void - ): Promise | void { - const command = new RestoreTableToPointInTimeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The Scan operation returns one or more items and item attributes by - * accessing every item in a table or a secondary index. To have DynamoDB return fewer - * items, you can provide a FilterExpression operation.

- *

If the total number of scanned items exceeds the maximum dataset size limit of 1 MB, - * the scan stops and results are returned to the user as a LastEvaluatedKey - * value to continue the scan in a subsequent operation. The results also include the - * number of items exceeding the limit. A scan can result in no table data meeting the - * filter criteria.

- *

A single Scan operation reads up to the maximum number of items set (if - * using the Limit parameter) or a maximum of 1 MB of data and then apply any - * filtering to the results using FilterExpression. If - * LastEvaluatedKey is present in the response, you need to paginate the - * result set. For more information, see Paginating the - * Results in the Amazon DynamoDB Developer Guide.

- *

- * Scan operations proceed sequentially; however, for faster performance on - * a large table or secondary index, applications can request a parallel Scan - * operation by providing the Segment and TotalSegments - * parameters. For more information, see Parallel - * Scan in the Amazon DynamoDB Developer Guide.

- *

- * Scan uses eventually consistent reads when accessing the data in a table; - * therefore, the result set might not include the changes to data in the table immediately - * before the operation began. If you need a consistent copy of the data, as of the time - * that the Scan begins, you can set the ConsistentRead parameter - * to true.

+ * @see {@link ScanCommand} */ - public scan(args: ScanCommandInput, options?: __HttpHandlerOptions): Promise; - public scan(args: ScanCommandInput, cb: (err: any, data?: ScanCommandOutput) => void): void; - public scan( - args: ScanCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: ScanCommandOutput) => void - ): void; - public scan( - args: ScanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ScanCommandOutput) => void), - cb?: (err: any, data?: ScanCommandOutput) => void - ): Promise | void { - const command = new ScanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } + scan(args: ScanCommandInput, options?: __HttpHandlerOptions): Promise; + scan(args: ScanCommandInput, cb: (err: any, data?: ScanCommandOutput) => void): void; + scan(args: ScanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ScanCommandOutput) => void): void; /** - * @public - *

Associate a set of tags with an Amazon DynamoDB resource. You can then activate these - * user-defined tags so that they appear on the Billing and Cost Management console for - * cost allocation tracking. You can call TagResource up to five times per second, per - * account.

- *

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB - * in the Amazon DynamoDB Developer Guide.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * TransactGetItems is a synchronous operation that atomically retrieves - * multiple items from one or more tables (but not from indexes) in a single account and - * Region. A TransactGetItems call can contain up to 100 - * TransactGetItem objects, each of which contains a Get - * structure that specifies an item to retrieve from a table in the account and Region. A - * call to TransactGetItems cannot retrieve items from tables in more than one - * Amazon Web Services account or Region. The aggregate size of the items in the - * transaction cannot exceed 4 MB.

- *

DynamoDB rejects the entire TransactGetItems request if any of - * the following is true:

- *
    - *
  • - *

    A conflicting operation is in the process of updating an item to be - * read.

    - *
  • - *
  • - *

    There is insufficient provisioned capacity for the transaction to be - * completed.

    - *
  • - *
  • - *

    There is a user error, such as an invalid data format.

    - *
  • - *
  • - *

    The aggregate size of the items in the transaction exceeded 4 MB.

    - *
  • - *
+ * @see {@link TransactGetItemsCommand} */ - public transactGetItems( + transactGetItems( args: TransactGetItemsCommandInput, options?: __HttpHandlerOptions ): Promise; - public transactGetItems( + transactGetItems( args: TransactGetItemsCommandInput, cb: (err: any, data?: TransactGetItemsCommandOutput) => void ): void; - public transactGetItems( + transactGetItems( args: TransactGetItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TransactGetItemsCommandOutput) => void ): void; - public transactGetItems( - args: TransactGetItemsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TransactGetItemsCommandOutput) => void), - cb?: (err: any, data?: TransactGetItemsCommandOutput) => void - ): Promise | void { - const command = new TransactGetItemsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * TransactWriteItems is a synchronous write operation that groups up to 100 - * action requests. These actions can target items in different tables, but not in - * different Amazon Web Services accounts or Regions, and no two actions can target the same - * item. For example, you cannot both ConditionCheck and Update - * the same item. The aggregate size of the items in the transaction cannot exceed 4 - * MB.

- *

The actions are completed atomically so that either all of them succeed, or all of - * them fail. They are defined by the following objects:

- *
    - *
  • - *

    - * Put  —   Initiates a PutItem - * operation to write a new item. This structure specifies the primary key of the - * item to be written, the name of the table to write it in, an optional condition - * expression that must be satisfied for the write to succeed, a list of the item's - * attributes, and a field indicating whether to retrieve the item's attributes if - * the condition is not met.

    - *
  • - *
  • - *

    - * Update  —   Initiates an UpdateItem - * operation to update an existing item. This structure specifies the primary key - * of the item to be updated, the name of the table where it resides, an optional - * condition expression that must be satisfied for the update to succeed, an - * expression that defines one or more attributes to be updated, and a field - * indicating whether to retrieve the item's attributes if the condition is not - * met.

    - *
  • - *
  • - *

    - * Delete  —   Initiates a DeleteItem - * operation to delete an existing item. This structure specifies the primary key - * of the item to be deleted, the name of the table where it resides, an optional - * condition expression that must be satisfied for the deletion to succeed, and a - * field indicating whether to retrieve the item's attributes if the condition is - * not met.

    - *
  • - *
  • - *

    - * ConditionCheck  —   Applies a condition to an item - * that is not being modified by the transaction. This structure specifies the - * primary key of the item to be checked, the name of the table where it resides, a - * condition expression that must be satisfied for the transaction to succeed, and - * a field indicating whether to retrieve the item's attributes if the condition is - * not met.

    - *
  • - *
- *

DynamoDB rejects the entire TransactWriteItems request if any of the - * following is true:

- *
    - *
  • - *

    A condition in one of the condition expressions is not met.

    - *
  • - *
  • - *

    An ongoing operation is in the process of updating the same item.

    - *
  • - *
  • - *

    There is insufficient provisioned capacity for the transaction to be - * completed.

    - *
  • - *
  • - *

    An item size becomes too large (bigger than 400 KB), a local secondary index - * (LSI) becomes too large, or a similar validation error occurs because of changes - * made by the transaction.

    - *
  • - *
  • - *

    The aggregate size of the items in the transaction exceeds 4 MB.

    - *
  • - *
  • - *

    There is a user error, such as an invalid data format.

    - *
  • - *
+ * @see {@link TransactWriteItemsCommand} */ - public transactWriteItems( + transactWriteItems( args: TransactWriteItemsCommandInput, options?: __HttpHandlerOptions ): Promise; - public transactWriteItems( + transactWriteItems( args: TransactWriteItemsCommandInput, cb: (err: any, data?: TransactWriteItemsCommandOutput) => void ): void; - public transactWriteItems( + transactWriteItems( args: TransactWriteItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TransactWriteItemsCommandOutput) => void ): void; - public transactWriteItems( - args: TransactWriteItemsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TransactWriteItemsCommandOutput) => void), - cb?: (err: any, data?: TransactWriteItemsCommandOutput) => void - ): Promise | void { - const command = new TransactWriteItemsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the association of tags from an Amazon DynamoDB resource. You can call - * UntagResource up to five times per second, per account.

- *

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB - * in the Amazon DynamoDB Developer Guide.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * UpdateContinuousBackups enables or disables point in time recovery for - * the specified table. A successful UpdateContinuousBackups call returns the - * current ContinuousBackupsDescription. Continuous backups are - * ENABLED on all tables at table creation. If point in time recovery is - * enabled, PointInTimeRecoveryStatus will be set to ENABLED.

- *

Once continuous backups and point in time recovery are enabled, you can restore to - * any point in time within EarliestRestorableDateTime and - * LatestRestorableDateTime.

- *

- * LatestRestorableDateTime is typically 5 minutes before the current time. - * You can restore your table to any point in time during the last 35 days.

+ * @see {@link UpdateContinuousBackupsCommand} */ - public updateContinuousBackups( + updateContinuousBackups( args: UpdateContinuousBackupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateContinuousBackups( + updateContinuousBackups( args: UpdateContinuousBackupsCommandInput, cb: (err: any, data?: UpdateContinuousBackupsCommandOutput) => void ): void; - public updateContinuousBackups( + updateContinuousBackups( args: UpdateContinuousBackupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContinuousBackupsCommandOutput) => void ): void; - public updateContinuousBackups( - args: UpdateContinuousBackupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateContinuousBackupsCommandOutput) => void), - cb?: (err: any, data?: UpdateContinuousBackupsCommandOutput) => void - ): Promise | void { - const command = new UpdateContinuousBackupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the status for contributor insights for a specific table or index. CloudWatch - * Contributor Insights for DynamoDB graphs display the partition key and (if applicable) - * sort key of frequently accessed items and frequently throttled items in plaintext. If - * you require the use of Amazon Web Services Key Management Service (KMS) to encrypt this - * table’s partition key and sort key data with an Amazon Web Services managed key or - * customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB - * for this table.

+ * @see {@link UpdateContributorInsightsCommand} */ - public updateContributorInsights( + updateContributorInsights( args: UpdateContributorInsightsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateContributorInsights( + updateContributorInsights( args: UpdateContributorInsightsCommandInput, cb: (err: any, data?: UpdateContributorInsightsCommandOutput) => void ): void; - public updateContributorInsights( + updateContributorInsights( args: UpdateContributorInsightsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContributorInsightsCommandOutput) => void ): void; - public updateContributorInsights( - args: UpdateContributorInsightsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateContributorInsightsCommandOutput) => void), - cb?: (err: any, data?: UpdateContributorInsightsCommandOutput) => void - ): Promise | void { - const command = new UpdateContributorInsightsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or removes replicas in the specified global table. The global table must already - * exist to be able to use this operation. Any replica to be added must be empty, have the - * same name as the global table, have the same key schema, have DynamoDB Streams enabled, - * and have the same provisioned and maximum write capacity units.

- * - *

This operation only applies to Version - * 2017.11.29 (Legacy) of global tables. We recommend using - * Version 2019.11.21 (Current) - * when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than - * 2017.11.29 (Legacy). To determine which version you are using, see - * Determining the version. - * To update existing global tables from version 2017.11.29 (Legacy) to version - * 2019.11.21 (Current), see - * Updating global tables. - *

- *
- * - *

- * This operation only applies to Version - * 2017.11.29 of global tables. If you are using global tables Version - * 2019.11.21 you can use DescribeTable instead. - *

- *

- * Although you can use UpdateGlobalTable to add replicas and remove - * replicas in a single request, for simplicity we recommend that you issue separate - * requests for adding or removing replicas. - *

- *
- *

If global secondary indexes are specified, then the following conditions must also be - * met:

- *
    - *
  • - *

    The global secondary indexes must have the same name.

    - *
  • - *
  • - *

    The global secondary indexes must have the same hash key and sort key (if - * present).

    - *
  • - *
  • - *

    The global secondary indexes must have the same provisioned and maximum write - * capacity units.

    - *
  • - *
+ * @see {@link UpdateGlobalTableCommand} */ - public updateGlobalTable( + updateGlobalTable( args: UpdateGlobalTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGlobalTable( + updateGlobalTable( args: UpdateGlobalTableCommandInput, cb: (err: any, data?: UpdateGlobalTableCommandOutput) => void ): void; - public updateGlobalTable( + updateGlobalTable( args: UpdateGlobalTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGlobalTableCommandOutput) => void ): void; - public updateGlobalTable( - args: UpdateGlobalTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGlobalTableCommandOutput) => void), - cb?: (err: any, data?: UpdateGlobalTableCommandOutput) => void - ): Promise | void { - const command = new UpdateGlobalTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates settings for a global table.

- * - *

This operation only applies to Version - * 2017.11.29 (Legacy) of global tables. We recommend using - * Version 2019.11.21 (Current) - * when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than - * 2017.11.29 (Legacy). To determine which version you are using, see - * Determining the version. - * To update existing global tables from version 2017.11.29 (Legacy) to version - * 2019.11.21 (Current), see - * Updating global tables. - *

- *
+ * @see {@link UpdateGlobalTableSettingsCommand} */ - public updateGlobalTableSettings( + updateGlobalTableSettings( args: UpdateGlobalTableSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGlobalTableSettings( + updateGlobalTableSettings( args: UpdateGlobalTableSettingsCommandInput, cb: (err: any, data?: UpdateGlobalTableSettingsCommandOutput) => void ): void; - public updateGlobalTableSettings( + updateGlobalTableSettings( args: UpdateGlobalTableSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGlobalTableSettingsCommandOutput) => void ): void; - public updateGlobalTableSettings( - args: UpdateGlobalTableSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGlobalTableSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateGlobalTableSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateGlobalTableSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Edits an existing item's attributes, or adds a new item to the table if it does not - * already exist. You can put, delete, or add attribute values. You can also perform a - * conditional update on an existing item (insert a new attribute name-value pair if it - * doesn't exist, or replace an existing name-value pair if it has certain expected - * attribute values).

- *

You can also return the item's attribute values in the same UpdateItem - * operation using the ReturnValues parameter.

+ * @see {@link UpdateItemCommand} */ - public updateItem(args: UpdateItemCommandInput, options?: __HttpHandlerOptions): Promise; - public updateItem(args: UpdateItemCommandInput, cb: (err: any, data?: UpdateItemCommandOutput) => void): void; - public updateItem( + updateItem(args: UpdateItemCommandInput, options?: __HttpHandlerOptions): Promise; + updateItem(args: UpdateItemCommandInput, cb: (err: any, data?: UpdateItemCommandOutput) => void): void; + updateItem( args: UpdateItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateItemCommandOutput) => void ): void; - public updateItem( - args: UpdateItemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateItemCommandOutput) => void), - cb?: (err: any, data?: UpdateItemCommandOutput) => void - ): Promise | void { - const command = new UpdateItemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB - * Streams settings for a given table.

- * - *

This operation only applies to Version 2019.11.21 (Current) - * of global tables. - *

- *
- *

You can only perform one of the following operations at once:

- *
    - *
  • - *

    Modify the provisioned throughput settings of the table.

    - *
  • - *
  • - *

    Remove a global secondary index from the table.

    - *
  • - *
  • - *

    Create a new global secondary index on the table. After the index begins - * backfilling, you can use UpdateTable to perform other - * operations.

    - *
  • - *
- *

- * UpdateTable is an asynchronous operation; while it is executing, the table - * status changes from ACTIVE to UPDATING. While it is - * UPDATING, you cannot issue another UpdateTable request. - * When the table returns to the ACTIVE state, the UpdateTable - * operation is complete.

+ * @see {@link UpdateTableCommand} */ - public updateTable(args: UpdateTableCommandInput, options?: __HttpHandlerOptions): Promise; - public updateTable(args: UpdateTableCommandInput, cb: (err: any, data?: UpdateTableCommandOutput) => void): void; - public updateTable( + updateTable(args: UpdateTableCommandInput, options?: __HttpHandlerOptions): Promise; + updateTable(args: UpdateTableCommandInput, cb: (err: any, data?: UpdateTableCommandOutput) => void): void; + updateTable( args: UpdateTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTableCommandOutput) => void ): void; - public updateTable( - args: UpdateTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTableCommandOutput) => void), - cb?: (err: any, data?: UpdateTableCommandOutput) => void - ): Promise | void { - const command = new UpdateTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates auto scaling settings on your global tables at once.

- * - *

This operation only applies to Version 2019.11.21 (Current) - * of global tables. - *

- *
+ * @see {@link UpdateTableReplicaAutoScalingCommand} */ - public updateTableReplicaAutoScaling( + updateTableReplicaAutoScaling( args: UpdateTableReplicaAutoScalingCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTableReplicaAutoScaling( + updateTableReplicaAutoScaling( args: UpdateTableReplicaAutoScalingCommandInput, cb: (err: any, data?: UpdateTableReplicaAutoScalingCommandOutput) => void ): void; - public updateTableReplicaAutoScaling( + updateTableReplicaAutoScaling( args: UpdateTableReplicaAutoScalingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTableReplicaAutoScalingCommandOutput) => void ): void; - public updateTableReplicaAutoScaling( - args: UpdateTableReplicaAutoScalingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTableReplicaAutoScalingCommandOutput) => void), - cb?: (err: any, data?: UpdateTableReplicaAutoScalingCommandOutput) => void - ): Promise | void { - const command = new UpdateTableReplicaAutoScalingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The UpdateTimeToLive method enables or disables Time to Live (TTL) for - * the specified table. A successful UpdateTimeToLive call returns the current - * TimeToLiveSpecification. It can take up to one hour for the change to - * fully process. Any additional UpdateTimeToLive calls for the same table - * during this one hour duration result in a ValidationException.

- *

TTL compares the current time in epoch time format to the time stored in the TTL - * attribute of an item. If the epoch time value stored in the attribute is less than the - * current time, the item is marked as expired and subsequently deleted.

- * - *

The epoch time format is the number of seconds elapsed since 12:00:00 AM January - * 1, 1970 UTC.

- *
- *

DynamoDB deletes expired items on a best-effort basis to ensure availability of - * throughput for other data operations.

- * - *

DynamoDB typically deletes expired items within two days of expiration. The exact - * duration within which an item gets deleted after expiration is specific to the - * nature of the workload. Items that have expired and not been deleted will still show - * up in reads, queries, and scans.

- *
- *

As items are deleted, they are removed from any local secondary index and global - * secondary index immediately in the same eventually consistent way as a standard delete - * operation.

- *

For more information, see Time To Live in the - * Amazon DynamoDB Developer Guide.

+ * @see {@link UpdateTimeToLiveCommand} */ - public updateTimeToLive( + updateTimeToLive( args: UpdateTimeToLiveCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTimeToLive( + updateTimeToLive( args: UpdateTimeToLiveCommandInput, cb: (err: any, data?: UpdateTimeToLiveCommandOutput) => void ): void; - public updateTimeToLive( + updateTimeToLive( args: UpdateTimeToLiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTimeToLiveCommandOutput) => void ): void; - public updateTimeToLive( - args: UpdateTimeToLiveCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTimeToLiveCommandOutput) => void), - cb?: (err: any, data?: UpdateTimeToLiveCommandOutput) => void - ): Promise | void { - const command = new UpdateTimeToLiveCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon DynamoDB + *

Amazon DynamoDB is a fully managed NoSQL database service that provides fast + * and predictable performance with seamless scalability. DynamoDB lets you + * offload the administrative burdens of operating and scaling a distributed database, so + * that you don't have to worry about hardware provisioning, setup and configuration, + * replication, software patching, or cluster scaling.

+ *

With DynamoDB, you can create database tables that can store and retrieve + * any amount of data, and serve any level of request traffic. You can scale up or scale + * down your tables' throughput capacity without downtime or performance degradation, and + * use the Amazon Web Services Management Console to monitor resource utilization and performance + * metrics.

+ *

DynamoDB automatically spreads the data and traffic for your tables over + * a sufficient number of servers to handle your throughput and storage requirements, while + * maintaining consistent and fast performance. All of your data is stored on solid state + * disks (SSDs) and automatically replicated across multiple Availability Zones in an + * Amazon Web Services Region, providing built-in high availability and data + * durability.

+ */ +export class DynamoDB extends DynamoDBClient implements DynamoDB {} +createAggregatedClient(commands, DynamoDB); diff --git a/clients/client-ebs/src/EBS.ts b/clients/client-ebs/src/EBS.ts index e67e49a6dd75..5187e093aadf 100644 --- a/clients/client-ebs/src/EBS.ts +++ b/clients/client-ebs/src/EBS.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -31,236 +32,137 @@ import { StartSnapshotCommandInput, StartSnapshotCommandOutput, } from "./commands/StartSnapshotCommand"; -import { EBSClient } from "./EBSClient"; +import { EBSClient, EBSClientConfig } from "./EBSClient"; -/** - * @public - *

You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create Amazon EBS snapshots, write data directly to - * your snapshots, read data on your snapshots, and identify the differences or changes between - * two snapshots. If you’re an independent software vendor (ISV) who offers backup services for - * Amazon EBS, the EBS direct APIs make it more efficient and cost-effective to track incremental changes on - * your Amazon EBS volumes through snapshots. This can be done without having to create new volumes - * from snapshots, and then use Amazon Elastic Compute Cloud (Amazon EC2) instances to compare the differences.

- * - *

You can create incremental snapshots directly from data on-premises into volumes and the - * cloud to use for quick disaster recovery. With the ability to write and read snapshots, you can - * write your on-premises data to an snapshot during a disaster. Then after recovery, you can - * restore it back to Amazon Web Services or on-premises from the snapshot. You no longer need to build and - * maintain complex mechanisms to copy data to and from Amazon EBS.

- * - * - *

This API reference provides detailed information about the actions, data types, - * parameters, and errors of the EBS direct APIs. For more information about the elements that - * make up the EBS direct APIs, and examples of how to use them effectively, see Accessing the Contents of an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User - * Guide. For more information about the supported Amazon Web Services Regions, endpoints, - * and service quotas for the EBS direct APIs, see Amazon Elastic Block Store Endpoints and Quotas in - * the Amazon Web Services General Reference.

- */ -export class EBS extends EBSClient { +const commands = { + CompleteSnapshotCommand, + GetSnapshotBlockCommand, + ListChangedBlocksCommand, + ListSnapshotBlocksCommand, + PutSnapshotBlockCommand, + StartSnapshotCommand, +}; + +export interface EBS { /** - * @public - *

Seals and completes the snapshot after all of the required blocks of data have been - * written to it. Completing the snapshot changes the status to completed. You - * cannot write new blocks to a snapshot after it has been completed.

+ * @see {@link CompleteSnapshotCommand} */ - public completeSnapshot( + completeSnapshot( args: CompleteSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public completeSnapshot( + completeSnapshot( args: CompleteSnapshotCommandInput, cb: (err: any, data?: CompleteSnapshotCommandOutput) => void ): void; - public completeSnapshot( + completeSnapshot( args: CompleteSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteSnapshotCommandOutput) => void ): void; - public completeSnapshot( - args: CompleteSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CompleteSnapshotCommandOutput) => void), - cb?: (err: any, data?: CompleteSnapshotCommandOutput) => void - ): Promise | void { - const command = new CompleteSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the data in a block in an Amazon Elastic Block Store snapshot.

+ * @see {@link GetSnapshotBlockCommand} */ - public getSnapshotBlock( + getSnapshotBlock( args: GetSnapshotBlockCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSnapshotBlock( + getSnapshotBlock( args: GetSnapshotBlockCommandInput, cb: (err: any, data?: GetSnapshotBlockCommandOutput) => void ): void; - public getSnapshotBlock( + getSnapshotBlock( args: GetSnapshotBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSnapshotBlockCommandOutput) => void ): void; - public getSnapshotBlock( - args: GetSnapshotBlockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSnapshotBlockCommandOutput) => void), - cb?: (err: any, data?: GetSnapshotBlockCommandOutput) => void - ): Promise | void { - const command = new GetSnapshotBlockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the blocks that are different between two - * Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.

+ * @see {@link ListChangedBlocksCommand} */ - public listChangedBlocks( + listChangedBlocks( args: ListChangedBlocksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listChangedBlocks( + listChangedBlocks( args: ListChangedBlocksCommandInput, cb: (err: any, data?: ListChangedBlocksCommandOutput) => void ): void; - public listChangedBlocks( + listChangedBlocks( args: ListChangedBlocksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChangedBlocksCommandOutput) => void ): void; - public listChangedBlocks( - args: ListChangedBlocksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListChangedBlocksCommandOutput) => void), - cb?: (err: any, data?: ListChangedBlocksCommandOutput) => void - ): Promise | void { - const command = new ListChangedBlocksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the blocks in an Amazon Elastic Block Store snapshot.

+ * @see {@link ListSnapshotBlocksCommand} */ - public listSnapshotBlocks( + listSnapshotBlocks( args: ListSnapshotBlocksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSnapshotBlocks( + listSnapshotBlocks( args: ListSnapshotBlocksCommandInput, cb: (err: any, data?: ListSnapshotBlocksCommandOutput) => void ): void; - public listSnapshotBlocks( + listSnapshotBlocks( args: ListSnapshotBlocksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSnapshotBlocksCommandOutput) => void ): void; - public listSnapshotBlocks( - args: ListSnapshotBlocksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSnapshotBlocksCommandOutput) => void), - cb?: (err: any, data?: ListSnapshotBlocksCommandOutput) => void - ): Promise | void { - const command = new ListSnapshotBlocksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Writes a block of data to a snapshot. If the specified block contains - * data, the existing data is overwritten. The target snapshot must be in the - * pending state.

- *

Data written to a snapshot must be aligned with 512-KiB sectors.

+ * @see {@link PutSnapshotBlockCommand} */ - public putSnapshotBlock( + putSnapshotBlock( args: PutSnapshotBlockCommandInput, options?: __HttpHandlerOptions ): Promise; - public putSnapshotBlock( + putSnapshotBlock( args: PutSnapshotBlockCommandInput, cb: (err: any, data?: PutSnapshotBlockCommandOutput) => void ): void; - public putSnapshotBlock( + putSnapshotBlock( args: PutSnapshotBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSnapshotBlockCommandOutput) => void ): void; - public putSnapshotBlock( - args: PutSnapshotBlockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutSnapshotBlockCommandOutput) => void), - cb?: (err: any, data?: PutSnapshotBlockCommandOutput) => void - ): Promise | void { - const command = new PutSnapshotBlockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new Amazon EBS snapshot. The new snapshot enters the pending state - * after the request completes.

- *

After creating the snapshot, use PutSnapshotBlock to - * write blocks of data to the snapshot.

+ * @see {@link StartSnapshotCommand} */ - public startSnapshot( - args: StartSnapshotCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public startSnapshot( - args: StartSnapshotCommandInput, - cb: (err: any, data?: StartSnapshotCommandOutput) => void - ): void; - public startSnapshot( + startSnapshot(args: StartSnapshotCommandInput, options?: __HttpHandlerOptions): Promise; + startSnapshot(args: StartSnapshotCommandInput, cb: (err: any, data?: StartSnapshotCommandOutput) => void): void; + startSnapshot( args: StartSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSnapshotCommandOutput) => void ): void; - public startSnapshot( - args: StartSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartSnapshotCommandOutput) => void), - cb?: (err: any, data?: StartSnapshotCommandOutput) => void - ): Promise | void { - const command = new StartSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create Amazon EBS snapshots, write data directly to + * your snapshots, read data on your snapshots, and identify the differences or changes between + * two snapshots. If you’re an independent software vendor (ISV) who offers backup services for + * Amazon EBS, the EBS direct APIs make it more efficient and cost-effective to track incremental changes on + * your Amazon EBS volumes through snapshots. This can be done without having to create new volumes + * from snapshots, and then use Amazon Elastic Compute Cloud (Amazon EC2) instances to compare the differences.

+ * + *

You can create incremental snapshots directly from data on-premises into volumes and the + * cloud to use for quick disaster recovery. With the ability to write and read snapshots, you can + * write your on-premises data to an snapshot during a disaster. Then after recovery, you can + * restore it back to Amazon Web Services or on-premises from the snapshot. You no longer need to build and + * maintain complex mechanisms to copy data to and from Amazon EBS.

+ * + * + *

This API reference provides detailed information about the actions, data types, + * parameters, and errors of the EBS direct APIs. For more information about the elements that + * make up the EBS direct APIs, and examples of how to use them effectively, see Accessing the Contents of an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User + * Guide. For more information about the supported Amazon Web Services Regions, endpoints, + * and service quotas for the EBS direct APIs, see Amazon Elastic Block Store Endpoints and Quotas in + * the Amazon Web Services General Reference.

+ */ +export class EBS extends EBSClient implements EBS {} +createAggregatedClient(commands, EBS); diff --git a/clients/client-ec2-instance-connect/src/EC2InstanceConnect.ts b/clients/client-ec2-instance-connect/src/EC2InstanceConnect.ts index ab5de539f9ab..e72aa4836264 100644 --- a/clients/client-ec2-instance-connect/src/EC2InstanceConnect.ts +++ b/clients/client-ec2-instance-connect/src/EC2InstanceConnect.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -11,84 +12,54 @@ import { SendSSHPublicKeyCommandInput, SendSSHPublicKeyCommandOutput, } from "./commands/SendSSHPublicKeyCommand"; -import { EC2InstanceConnectClient } from "./EC2InstanceConnectClient"; +import { EC2InstanceConnectClient, EC2InstanceConnectClientConfig } from "./EC2InstanceConnectClient"; -/** - * @public - *

Amazon EC2 Instance Connect enables system administrators to publish one-time use SSH - * public keys to EC2, providing users a simple and secure way to connect to their - * instances.

- */ -export class EC2InstanceConnect extends EC2InstanceConnectClient { +const commands = { + SendSerialConsoleSSHPublicKeyCommand, + SendSSHPublicKeyCommand, +}; + +export interface EC2InstanceConnect { /** - * @public - *

Pushes an SSH public key to the specified EC2 instance. The key remains for 60 - * seconds, which gives you 60 seconds to establish a serial console connection to the - * instance using SSH. For more information, see EC2 Serial Console in - * the Amazon EC2 User Guide.

+ * @see {@link SendSerialConsoleSSHPublicKeyCommand} */ - public sendSerialConsoleSSHPublicKey( + sendSerialConsoleSSHPublicKey( args: SendSerialConsoleSSHPublicKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendSerialConsoleSSHPublicKey( + sendSerialConsoleSSHPublicKey( args: SendSerialConsoleSSHPublicKeyCommandInput, cb: (err: any, data?: SendSerialConsoleSSHPublicKeyCommandOutput) => void ): void; - public sendSerialConsoleSSHPublicKey( + sendSerialConsoleSSHPublicKey( args: SendSerialConsoleSSHPublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendSerialConsoleSSHPublicKeyCommandOutput) => void ): void; - public sendSerialConsoleSSHPublicKey( - args: SendSerialConsoleSSHPublicKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendSerialConsoleSSHPublicKeyCommandOutput) => void), - cb?: (err: any, data?: SendSerialConsoleSSHPublicKeyCommandOutput) => void - ): Promise | void { - const command = new SendSerialConsoleSSHPublicKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Pushes an SSH public key to the specified EC2 instance for use by the specified user. - * The key remains for 60 seconds. For more information, see Connect to - * your Linux instance using EC2 Instance Connect in the Amazon EC2 - * User Guide.

+ * @see {@link SendSSHPublicKeyCommand} */ - public sendSSHPublicKey( + sendSSHPublicKey( args: SendSSHPublicKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendSSHPublicKey( + sendSSHPublicKey( args: SendSSHPublicKeyCommandInput, cb: (err: any, data?: SendSSHPublicKeyCommandOutput) => void ): void; - public sendSSHPublicKey( + sendSSHPublicKey( args: SendSSHPublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendSSHPublicKeyCommandOutput) => void ): void; - public sendSSHPublicKey( - args: SendSSHPublicKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendSSHPublicKeyCommandOutput) => void), - cb?: (err: any, data?: SendSSHPublicKeyCommandOutput) => void - ): Promise | void { - const command = new SendSSHPublicKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon EC2 Instance Connect enables system administrators to publish one-time use SSH + * public keys to EC2, providing users a simple and secure way to connect to their + * instances.

+ */ +export class EC2InstanceConnect extends EC2InstanceConnectClient implements EC2InstanceConnect {} +createAggregatedClient(commands, EC2InstanceConnect); diff --git a/clients/client-ec2/src/EC2.ts b/clients/client-ec2/src/EC2.ts index 840caab2329f..08f086cee6cf 100644 --- a/clients/client-ec2/src/EC2.ts +++ b/clients/client-ec2/src/EC2.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -2892,22078 +2893,10340 @@ import { WithdrawByoipCidrCommandInput, WithdrawByoipCidrCommandOutput, } from "./commands/WithdrawByoipCidrCommand"; -import { EC2Client } from "./EC2Client"; +import { EC2Client, EC2ClientConfig } from "./EC2Client"; -/** - * @public - * Amazon Elastic Compute Cloud - *

Amazon Elastic Compute Cloud (Amazon EC2) provides secure and resizable computing capacity in the Amazon Web Services Cloud. - * Using Amazon EC2 eliminates the need to invest in hardware up front, so you can develop and deploy applications - * faster. Amazon Virtual Private Cloud (Amazon VPC) enables you to provision a logically isolated section of the - * Amazon Web Services Cloud where you can launch Amazon Web Services resources in a virtual network that you've defined. Amazon Elastic Block Store - * (Amazon EBS) provides block level storage volumes for use with EC2 instances. EBS volumes are highly available - * and reliable storage volumes that can be attached to any running instance and used like a hard drive.

- *

To learn more, see the following resources:

- * - */ -export class EC2 extends EC2Client { +const commands = { + AcceptAddressTransferCommand, + AcceptReservedInstancesExchangeQuoteCommand, + AcceptTransitGatewayMulticastDomainAssociationsCommand, + AcceptTransitGatewayPeeringAttachmentCommand, + AcceptTransitGatewayVpcAttachmentCommand, + AcceptVpcEndpointConnectionsCommand, + AcceptVpcPeeringConnectionCommand, + AdvertiseByoipCidrCommand, + AllocateAddressCommand, + AllocateHostsCommand, + AllocateIpamPoolCidrCommand, + ApplySecurityGroupsToClientVpnTargetNetworkCommand, + AssignIpv6AddressesCommand, + AssignPrivateIpAddressesCommand, + AssignPrivateNatGatewayAddressCommand, + AssociateAddressCommand, + AssociateClientVpnTargetNetworkCommand, + AssociateDhcpOptionsCommand, + AssociateEnclaveCertificateIamRoleCommand, + AssociateIamInstanceProfileCommand, + AssociateInstanceEventWindowCommand, + AssociateIpamResourceDiscoveryCommand, + AssociateNatGatewayAddressCommand, + AssociateRouteTableCommand, + AssociateSubnetCidrBlockCommand, + AssociateTransitGatewayMulticastDomainCommand, + AssociateTransitGatewayPolicyTableCommand, + AssociateTransitGatewayRouteTableCommand, + AssociateTrunkInterfaceCommand, + AssociateVpcCidrBlockCommand, + AttachClassicLinkVpcCommand, + AttachInternetGatewayCommand, + AttachNetworkInterfaceCommand, + AttachVerifiedAccessTrustProviderCommand, + AttachVolumeCommand, + AttachVpnGatewayCommand, + AuthorizeClientVpnIngressCommand, + AuthorizeSecurityGroupEgressCommand, + AuthorizeSecurityGroupIngressCommand, + BundleInstanceCommand, + CancelBundleTaskCommand, + CancelCapacityReservationCommand, + CancelCapacityReservationFleetsCommand, + CancelConversionTaskCommand, + CancelExportTaskCommand, + CancelImageLaunchPermissionCommand, + CancelImportTaskCommand, + CancelReservedInstancesListingCommand, + CancelSpotFleetRequestsCommand, + CancelSpotInstanceRequestsCommand, + ConfirmProductInstanceCommand, + CopyFpgaImageCommand, + CopyImageCommand, + CopySnapshotCommand, + CreateCapacityReservationCommand, + CreateCapacityReservationFleetCommand, + CreateCarrierGatewayCommand, + CreateClientVpnEndpointCommand, + CreateClientVpnRouteCommand, + CreateCoipCidrCommand, + CreateCoipPoolCommand, + CreateCustomerGatewayCommand, + CreateDefaultSubnetCommand, + CreateDefaultVpcCommand, + CreateDhcpOptionsCommand, + CreateEgressOnlyInternetGatewayCommand, + CreateFleetCommand, + CreateFlowLogsCommand, + CreateFpgaImageCommand, + CreateImageCommand, + CreateInstanceEventWindowCommand, + CreateInstanceExportTaskCommand, + CreateInternetGatewayCommand, + CreateIpamCommand, + CreateIpamPoolCommand, + CreateIpamResourceDiscoveryCommand, + CreateIpamScopeCommand, + CreateKeyPairCommand, + CreateLaunchTemplateCommand, + CreateLaunchTemplateVersionCommand, + CreateLocalGatewayRouteCommand, + CreateLocalGatewayRouteTableCommand, + CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationCommand, + CreateLocalGatewayRouteTableVpcAssociationCommand, + CreateManagedPrefixListCommand, + CreateNatGatewayCommand, + CreateNetworkAclCommand, + CreateNetworkAclEntryCommand, + CreateNetworkInsightsAccessScopeCommand, + CreateNetworkInsightsPathCommand, + CreateNetworkInterfaceCommand, + CreateNetworkInterfacePermissionCommand, + CreatePlacementGroupCommand, + CreatePublicIpv4PoolCommand, + CreateReplaceRootVolumeTaskCommand, + CreateReservedInstancesListingCommand, + CreateRestoreImageTaskCommand, + CreateRouteCommand, + CreateRouteTableCommand, + CreateSecurityGroupCommand, + CreateSnapshotCommand, + CreateSnapshotsCommand, + CreateSpotDatafeedSubscriptionCommand, + CreateStoreImageTaskCommand, + CreateSubnetCommand, + CreateSubnetCidrReservationCommand, + CreateTagsCommand, + CreateTrafficMirrorFilterCommand, + CreateTrafficMirrorFilterRuleCommand, + CreateTrafficMirrorSessionCommand, + CreateTrafficMirrorTargetCommand, + CreateTransitGatewayCommand, + CreateTransitGatewayConnectCommand, + CreateTransitGatewayConnectPeerCommand, + CreateTransitGatewayMulticastDomainCommand, + CreateTransitGatewayPeeringAttachmentCommand, + CreateTransitGatewayPolicyTableCommand, + CreateTransitGatewayPrefixListReferenceCommand, + CreateTransitGatewayRouteCommand, + CreateTransitGatewayRouteTableCommand, + CreateTransitGatewayRouteTableAnnouncementCommand, + CreateTransitGatewayVpcAttachmentCommand, + CreateVerifiedAccessEndpointCommand, + CreateVerifiedAccessGroupCommand, + CreateVerifiedAccessInstanceCommand, + CreateVerifiedAccessTrustProviderCommand, + CreateVolumeCommand, + CreateVpcCommand, + CreateVpcEndpointCommand, + CreateVpcEndpointConnectionNotificationCommand, + CreateVpcEndpointServiceConfigurationCommand, + CreateVpcPeeringConnectionCommand, + CreateVpnConnectionCommand, + CreateVpnConnectionRouteCommand, + CreateVpnGatewayCommand, + DeleteCarrierGatewayCommand, + DeleteClientVpnEndpointCommand, + DeleteClientVpnRouteCommand, + DeleteCoipCidrCommand, + DeleteCoipPoolCommand, + DeleteCustomerGatewayCommand, + DeleteDhcpOptionsCommand, + DeleteEgressOnlyInternetGatewayCommand, + DeleteFleetsCommand, + DeleteFlowLogsCommand, + DeleteFpgaImageCommand, + DeleteInstanceEventWindowCommand, + DeleteInternetGatewayCommand, + DeleteIpamCommand, + DeleteIpamPoolCommand, + DeleteIpamResourceDiscoveryCommand, + DeleteIpamScopeCommand, + DeleteKeyPairCommand, + DeleteLaunchTemplateCommand, + DeleteLaunchTemplateVersionsCommand, + DeleteLocalGatewayRouteCommand, + DeleteLocalGatewayRouteTableCommand, + DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationCommand, + DeleteLocalGatewayRouteTableVpcAssociationCommand, + DeleteManagedPrefixListCommand, + DeleteNatGatewayCommand, + DeleteNetworkAclCommand, + DeleteNetworkAclEntryCommand, + DeleteNetworkInsightsAccessScopeCommand, + DeleteNetworkInsightsAccessScopeAnalysisCommand, + DeleteNetworkInsightsAnalysisCommand, + DeleteNetworkInsightsPathCommand, + DeleteNetworkInterfaceCommand, + DeleteNetworkInterfacePermissionCommand, + DeletePlacementGroupCommand, + DeletePublicIpv4PoolCommand, + DeleteQueuedReservedInstancesCommand, + DeleteRouteCommand, + DeleteRouteTableCommand, + DeleteSecurityGroupCommand, + DeleteSnapshotCommand, + DeleteSpotDatafeedSubscriptionCommand, + DeleteSubnetCommand, + DeleteSubnetCidrReservationCommand, + DeleteTagsCommand, + DeleteTrafficMirrorFilterCommand, + DeleteTrafficMirrorFilterRuleCommand, + DeleteTrafficMirrorSessionCommand, + DeleteTrafficMirrorTargetCommand, + DeleteTransitGatewayCommand, + DeleteTransitGatewayConnectCommand, + DeleteTransitGatewayConnectPeerCommand, + DeleteTransitGatewayMulticastDomainCommand, + DeleteTransitGatewayPeeringAttachmentCommand, + DeleteTransitGatewayPolicyTableCommand, + DeleteTransitGatewayPrefixListReferenceCommand, + DeleteTransitGatewayRouteCommand, + DeleteTransitGatewayRouteTableCommand, + DeleteTransitGatewayRouteTableAnnouncementCommand, + DeleteTransitGatewayVpcAttachmentCommand, + DeleteVerifiedAccessEndpointCommand, + DeleteVerifiedAccessGroupCommand, + DeleteVerifiedAccessInstanceCommand, + DeleteVerifiedAccessTrustProviderCommand, + DeleteVolumeCommand, + DeleteVpcCommand, + DeleteVpcEndpointConnectionNotificationsCommand, + DeleteVpcEndpointsCommand, + DeleteVpcEndpointServiceConfigurationsCommand, + DeleteVpcPeeringConnectionCommand, + DeleteVpnConnectionCommand, + DeleteVpnConnectionRouteCommand, + DeleteVpnGatewayCommand, + DeprovisionByoipCidrCommand, + DeprovisionIpamPoolCidrCommand, + DeprovisionPublicIpv4PoolCidrCommand, + DeregisterImageCommand, + DeregisterInstanceEventNotificationAttributesCommand, + DeregisterTransitGatewayMulticastGroupMembersCommand, + DeregisterTransitGatewayMulticastGroupSourcesCommand, + DescribeAccountAttributesCommand, + DescribeAddressesCommand, + DescribeAddressesAttributeCommand, + DescribeAddressTransfersCommand, + DescribeAggregateIdFormatCommand, + DescribeAvailabilityZonesCommand, + DescribeAwsNetworkPerformanceMetricSubscriptionsCommand, + DescribeBundleTasksCommand, + DescribeByoipCidrsCommand, + DescribeCapacityReservationFleetsCommand, + DescribeCapacityReservationsCommand, + DescribeCarrierGatewaysCommand, + DescribeClassicLinkInstancesCommand, + DescribeClientVpnAuthorizationRulesCommand, + DescribeClientVpnConnectionsCommand, + DescribeClientVpnEndpointsCommand, + DescribeClientVpnRoutesCommand, + DescribeClientVpnTargetNetworksCommand, + DescribeCoipPoolsCommand, + DescribeConversionTasksCommand, + DescribeCustomerGatewaysCommand, + DescribeDhcpOptionsCommand, + DescribeEgressOnlyInternetGatewaysCommand, + DescribeElasticGpusCommand, + DescribeExportImageTasksCommand, + DescribeExportTasksCommand, + DescribeFastLaunchImagesCommand, + DescribeFastSnapshotRestoresCommand, + DescribeFleetHistoryCommand, + DescribeFleetInstancesCommand, + DescribeFleetsCommand, + DescribeFlowLogsCommand, + DescribeFpgaImageAttributeCommand, + DescribeFpgaImagesCommand, + DescribeHostReservationOfferingsCommand, + DescribeHostReservationsCommand, + DescribeHostsCommand, + DescribeIamInstanceProfileAssociationsCommand, + DescribeIdentityIdFormatCommand, + DescribeIdFormatCommand, + DescribeImageAttributeCommand, + DescribeImagesCommand, + DescribeImportImageTasksCommand, + DescribeImportSnapshotTasksCommand, + DescribeInstanceAttributeCommand, + DescribeInstanceCreditSpecificationsCommand, + DescribeInstanceEventNotificationAttributesCommand, + DescribeInstanceEventWindowsCommand, + DescribeInstancesCommand, + DescribeInstanceStatusCommand, + DescribeInstanceTypeOfferingsCommand, + DescribeInstanceTypesCommand, + DescribeInternetGatewaysCommand, + DescribeIpamPoolsCommand, + DescribeIpamResourceDiscoveriesCommand, + DescribeIpamResourceDiscoveryAssociationsCommand, + DescribeIpamsCommand, + DescribeIpamScopesCommand, + DescribeIpv6PoolsCommand, + DescribeKeyPairsCommand, + DescribeLaunchTemplatesCommand, + DescribeLaunchTemplateVersionsCommand, + DescribeLocalGatewayRouteTablesCommand, + DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsCommand, + DescribeLocalGatewayRouteTableVpcAssociationsCommand, + DescribeLocalGatewaysCommand, + DescribeLocalGatewayVirtualInterfaceGroupsCommand, + DescribeLocalGatewayVirtualInterfacesCommand, + DescribeManagedPrefixListsCommand, + DescribeMovingAddressesCommand, + DescribeNatGatewaysCommand, + DescribeNetworkAclsCommand, + DescribeNetworkInsightsAccessScopeAnalysesCommand, + DescribeNetworkInsightsAccessScopesCommand, + DescribeNetworkInsightsAnalysesCommand, + DescribeNetworkInsightsPathsCommand, + DescribeNetworkInterfaceAttributeCommand, + DescribeNetworkInterfacePermissionsCommand, + DescribeNetworkInterfacesCommand, + DescribePlacementGroupsCommand, + DescribePrefixListsCommand, + DescribePrincipalIdFormatCommand, + DescribePublicIpv4PoolsCommand, + DescribeRegionsCommand, + DescribeReplaceRootVolumeTasksCommand, + DescribeReservedInstancesCommand, + DescribeReservedInstancesListingsCommand, + DescribeReservedInstancesModificationsCommand, + DescribeReservedInstancesOfferingsCommand, + DescribeRouteTablesCommand, + DescribeScheduledInstanceAvailabilityCommand, + DescribeScheduledInstancesCommand, + DescribeSecurityGroupReferencesCommand, + DescribeSecurityGroupRulesCommand, + DescribeSecurityGroupsCommand, + DescribeSnapshotAttributeCommand, + DescribeSnapshotsCommand, + DescribeSnapshotTierStatusCommand, + DescribeSpotDatafeedSubscriptionCommand, + DescribeSpotFleetInstancesCommand, + DescribeSpotFleetRequestHistoryCommand, + DescribeSpotFleetRequestsCommand, + DescribeSpotInstanceRequestsCommand, + DescribeSpotPriceHistoryCommand, + DescribeStaleSecurityGroupsCommand, + DescribeStoreImageTasksCommand, + DescribeSubnetsCommand, + DescribeTagsCommand, + DescribeTrafficMirrorFiltersCommand, + DescribeTrafficMirrorSessionsCommand, + DescribeTrafficMirrorTargetsCommand, + DescribeTransitGatewayAttachmentsCommand, + DescribeTransitGatewayConnectPeersCommand, + DescribeTransitGatewayConnectsCommand, + DescribeTransitGatewayMulticastDomainsCommand, + DescribeTransitGatewayPeeringAttachmentsCommand, + DescribeTransitGatewayPolicyTablesCommand, + DescribeTransitGatewayRouteTableAnnouncementsCommand, + DescribeTransitGatewayRouteTablesCommand, + DescribeTransitGatewaysCommand, + DescribeTransitGatewayVpcAttachmentsCommand, + DescribeTrunkInterfaceAssociationsCommand, + DescribeVerifiedAccessEndpointsCommand, + DescribeVerifiedAccessGroupsCommand, + DescribeVerifiedAccessInstanceLoggingConfigurationsCommand, + DescribeVerifiedAccessInstancesCommand, + DescribeVerifiedAccessTrustProvidersCommand, + DescribeVolumeAttributeCommand, + DescribeVolumesCommand, + DescribeVolumesModificationsCommand, + DescribeVolumeStatusCommand, + DescribeVpcAttributeCommand, + DescribeVpcClassicLinkCommand, + DescribeVpcClassicLinkDnsSupportCommand, + DescribeVpcEndpointConnectionNotificationsCommand, + DescribeVpcEndpointConnectionsCommand, + DescribeVpcEndpointsCommand, + DescribeVpcEndpointServiceConfigurationsCommand, + DescribeVpcEndpointServicePermissionsCommand, + DescribeVpcEndpointServicesCommand, + DescribeVpcPeeringConnectionsCommand, + DescribeVpcsCommand, + DescribeVpnConnectionsCommand, + DescribeVpnGatewaysCommand, + DetachClassicLinkVpcCommand, + DetachInternetGatewayCommand, + DetachNetworkInterfaceCommand, + DetachVerifiedAccessTrustProviderCommand, + DetachVolumeCommand, + DetachVpnGatewayCommand, + DisableAddressTransferCommand, + DisableAwsNetworkPerformanceMetricSubscriptionCommand, + DisableEbsEncryptionByDefaultCommand, + DisableFastLaunchCommand, + DisableFastSnapshotRestoresCommand, + DisableImageDeprecationCommand, + DisableIpamOrganizationAdminAccountCommand, + DisableSerialConsoleAccessCommand, + DisableTransitGatewayRouteTablePropagationCommand, + DisableVgwRoutePropagationCommand, + DisableVpcClassicLinkCommand, + DisableVpcClassicLinkDnsSupportCommand, + DisassociateAddressCommand, + DisassociateClientVpnTargetNetworkCommand, + DisassociateEnclaveCertificateIamRoleCommand, + DisassociateIamInstanceProfileCommand, + DisassociateInstanceEventWindowCommand, + DisassociateIpamResourceDiscoveryCommand, + DisassociateNatGatewayAddressCommand, + DisassociateRouteTableCommand, + DisassociateSubnetCidrBlockCommand, + DisassociateTransitGatewayMulticastDomainCommand, + DisassociateTransitGatewayPolicyTableCommand, + DisassociateTransitGatewayRouteTableCommand, + DisassociateTrunkInterfaceCommand, + DisassociateVpcCidrBlockCommand, + EnableAddressTransferCommand, + EnableAwsNetworkPerformanceMetricSubscriptionCommand, + EnableEbsEncryptionByDefaultCommand, + EnableFastLaunchCommand, + EnableFastSnapshotRestoresCommand, + EnableImageDeprecationCommand, + EnableIpamOrganizationAdminAccountCommand, + EnableReachabilityAnalyzerOrganizationSharingCommand, + EnableSerialConsoleAccessCommand, + EnableTransitGatewayRouteTablePropagationCommand, + EnableVgwRoutePropagationCommand, + EnableVolumeIOCommand, + EnableVpcClassicLinkCommand, + EnableVpcClassicLinkDnsSupportCommand, + ExportClientVpnClientCertificateRevocationListCommand, + ExportClientVpnClientConfigurationCommand, + ExportImageCommand, + ExportTransitGatewayRoutesCommand, + GetAssociatedEnclaveCertificateIamRolesCommand, + GetAssociatedIpv6PoolCidrsCommand, + GetAwsNetworkPerformanceDataCommand, + GetCapacityReservationUsageCommand, + GetCoipPoolUsageCommand, + GetConsoleOutputCommand, + GetConsoleScreenshotCommand, + GetDefaultCreditSpecificationCommand, + GetEbsDefaultKmsKeyIdCommand, + GetEbsEncryptionByDefaultCommand, + GetFlowLogsIntegrationTemplateCommand, + GetGroupsForCapacityReservationCommand, + GetHostReservationPurchasePreviewCommand, + GetInstanceTypesFromInstanceRequirementsCommand, + GetInstanceUefiDataCommand, + GetIpamAddressHistoryCommand, + GetIpamDiscoveredAccountsCommand, + GetIpamDiscoveredResourceCidrsCommand, + GetIpamPoolAllocationsCommand, + GetIpamPoolCidrsCommand, + GetIpamResourceCidrsCommand, + GetLaunchTemplateDataCommand, + GetManagedPrefixListAssociationsCommand, + GetManagedPrefixListEntriesCommand, + GetNetworkInsightsAccessScopeAnalysisFindingsCommand, + GetNetworkInsightsAccessScopeContentCommand, + GetPasswordDataCommand, + GetReservedInstancesExchangeQuoteCommand, + GetSerialConsoleAccessStatusCommand, + GetSpotPlacementScoresCommand, + GetSubnetCidrReservationsCommand, + GetTransitGatewayAttachmentPropagationsCommand, + GetTransitGatewayMulticastDomainAssociationsCommand, + GetTransitGatewayPolicyTableAssociationsCommand, + GetTransitGatewayPolicyTableEntriesCommand, + GetTransitGatewayPrefixListReferencesCommand, + GetTransitGatewayRouteTableAssociationsCommand, + GetTransitGatewayRouteTablePropagationsCommand, + GetVerifiedAccessEndpointPolicyCommand, + GetVerifiedAccessGroupPolicyCommand, + GetVpnConnectionDeviceSampleConfigurationCommand, + GetVpnConnectionDeviceTypesCommand, + GetVpnTunnelReplacementStatusCommand, + ImportClientVpnClientCertificateRevocationListCommand, + ImportImageCommand, + ImportInstanceCommand, + ImportKeyPairCommand, + ImportSnapshotCommand, + ImportVolumeCommand, + ListImagesInRecycleBinCommand, + ListSnapshotsInRecycleBinCommand, + ModifyAddressAttributeCommand, + ModifyAvailabilityZoneGroupCommand, + ModifyCapacityReservationCommand, + ModifyCapacityReservationFleetCommand, + ModifyClientVpnEndpointCommand, + ModifyDefaultCreditSpecificationCommand, + ModifyEbsDefaultKmsKeyIdCommand, + ModifyFleetCommand, + ModifyFpgaImageAttributeCommand, + ModifyHostsCommand, + ModifyIdentityIdFormatCommand, + ModifyIdFormatCommand, + ModifyImageAttributeCommand, + ModifyInstanceAttributeCommand, + ModifyInstanceCapacityReservationAttributesCommand, + ModifyInstanceCreditSpecificationCommand, + ModifyInstanceEventStartTimeCommand, + ModifyInstanceEventWindowCommand, + ModifyInstanceMaintenanceOptionsCommand, + ModifyInstanceMetadataOptionsCommand, + ModifyInstancePlacementCommand, + ModifyIpamCommand, + ModifyIpamPoolCommand, + ModifyIpamResourceCidrCommand, + ModifyIpamResourceDiscoveryCommand, + ModifyIpamScopeCommand, + ModifyLaunchTemplateCommand, + ModifyLocalGatewayRouteCommand, + ModifyManagedPrefixListCommand, + ModifyNetworkInterfaceAttributeCommand, + ModifyPrivateDnsNameOptionsCommand, + ModifyReservedInstancesCommand, + ModifySecurityGroupRulesCommand, + ModifySnapshotAttributeCommand, + ModifySnapshotTierCommand, + ModifySpotFleetRequestCommand, + ModifySubnetAttributeCommand, + ModifyTrafficMirrorFilterNetworkServicesCommand, + ModifyTrafficMirrorFilterRuleCommand, + ModifyTrafficMirrorSessionCommand, + ModifyTransitGatewayCommand, + ModifyTransitGatewayPrefixListReferenceCommand, + ModifyTransitGatewayVpcAttachmentCommand, + ModifyVerifiedAccessEndpointCommand, + ModifyVerifiedAccessEndpointPolicyCommand, + ModifyVerifiedAccessGroupCommand, + ModifyVerifiedAccessGroupPolicyCommand, + ModifyVerifiedAccessInstanceCommand, + ModifyVerifiedAccessInstanceLoggingConfigurationCommand, + ModifyVerifiedAccessTrustProviderCommand, + ModifyVolumeCommand, + ModifyVolumeAttributeCommand, + ModifyVpcAttributeCommand, + ModifyVpcEndpointCommand, + ModifyVpcEndpointConnectionNotificationCommand, + ModifyVpcEndpointServiceConfigurationCommand, + ModifyVpcEndpointServicePayerResponsibilityCommand, + ModifyVpcEndpointServicePermissionsCommand, + ModifyVpcPeeringConnectionOptionsCommand, + ModifyVpcTenancyCommand, + ModifyVpnConnectionCommand, + ModifyVpnConnectionOptionsCommand, + ModifyVpnTunnelCertificateCommand, + ModifyVpnTunnelOptionsCommand, + MonitorInstancesCommand, + MoveAddressToVpcCommand, + MoveByoipCidrToIpamCommand, + ProvisionByoipCidrCommand, + ProvisionIpamPoolCidrCommand, + ProvisionPublicIpv4PoolCidrCommand, + PurchaseHostReservationCommand, + PurchaseReservedInstancesOfferingCommand, + PurchaseScheduledInstancesCommand, + RebootInstancesCommand, + RegisterImageCommand, + RegisterInstanceEventNotificationAttributesCommand, + RegisterTransitGatewayMulticastGroupMembersCommand, + RegisterTransitGatewayMulticastGroupSourcesCommand, + RejectTransitGatewayMulticastDomainAssociationsCommand, + RejectTransitGatewayPeeringAttachmentCommand, + RejectTransitGatewayVpcAttachmentCommand, + RejectVpcEndpointConnectionsCommand, + RejectVpcPeeringConnectionCommand, + ReleaseAddressCommand, + ReleaseHostsCommand, + ReleaseIpamPoolAllocationCommand, + ReplaceIamInstanceProfileAssociationCommand, + ReplaceNetworkAclAssociationCommand, + ReplaceNetworkAclEntryCommand, + ReplaceRouteCommand, + ReplaceRouteTableAssociationCommand, + ReplaceTransitGatewayRouteCommand, + ReplaceVpnTunnelCommand, + ReportInstanceStatusCommand, + RequestSpotFleetCommand, + RequestSpotInstancesCommand, + ResetAddressAttributeCommand, + ResetEbsDefaultKmsKeyIdCommand, + ResetFpgaImageAttributeCommand, + ResetImageAttributeCommand, + ResetInstanceAttributeCommand, + ResetNetworkInterfaceAttributeCommand, + ResetSnapshotAttributeCommand, + RestoreAddressToClassicCommand, + RestoreImageFromRecycleBinCommand, + RestoreManagedPrefixListVersionCommand, + RestoreSnapshotFromRecycleBinCommand, + RestoreSnapshotTierCommand, + RevokeClientVpnIngressCommand, + RevokeSecurityGroupEgressCommand, + RevokeSecurityGroupIngressCommand, + RunInstancesCommand, + RunScheduledInstancesCommand, + SearchLocalGatewayRoutesCommand, + SearchTransitGatewayMulticastGroupsCommand, + SearchTransitGatewayRoutesCommand, + SendDiagnosticInterruptCommand, + StartInstancesCommand, + StartNetworkInsightsAccessScopeAnalysisCommand, + StartNetworkInsightsAnalysisCommand, + StartVpcEndpointServicePrivateDnsVerificationCommand, + StopInstancesCommand, + TerminateClientVpnConnectionsCommand, + TerminateInstancesCommand, + UnassignIpv6AddressesCommand, + UnassignPrivateIpAddressesCommand, + UnassignPrivateNatGatewayAddressCommand, + UnmonitorInstancesCommand, + UpdateSecurityGroupRuleDescriptionsEgressCommand, + UpdateSecurityGroupRuleDescriptionsIngressCommand, + WithdrawByoipCidrCommand, +}; + +export interface EC2 { /** - * @public - *

Accepts an Elastic IP address transfer. For more information, see Accept a transferred Elastic IP address in the Amazon Virtual Private Cloud User Guide.

+ * @see {@link AcceptAddressTransferCommand} */ - public acceptAddressTransfer( + acceptAddressTransfer( args: AcceptAddressTransferCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptAddressTransfer( + acceptAddressTransfer( args: AcceptAddressTransferCommandInput, cb: (err: any, data?: AcceptAddressTransferCommandOutput) => void ): void; - public acceptAddressTransfer( + acceptAddressTransfer( args: AcceptAddressTransferCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptAddressTransferCommandOutput) => void ): void; - public acceptAddressTransfer( - args: AcceptAddressTransferCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptAddressTransferCommandOutput) => void), - cb?: (err: any, data?: AcceptAddressTransferCommandOutput) => void - ): Promise | void { - const command = new AcceptAddressTransferCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.

- */ - public acceptReservedInstancesExchangeQuote( + + /** + * @see {@link AcceptReservedInstancesExchangeQuoteCommand} + */ + acceptReservedInstancesExchangeQuote( args: AcceptReservedInstancesExchangeQuoteCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptReservedInstancesExchangeQuote( + acceptReservedInstancesExchangeQuote( args: AcceptReservedInstancesExchangeQuoteCommandInput, cb: (err: any, data?: AcceptReservedInstancesExchangeQuoteCommandOutput) => void ): void; - public acceptReservedInstancesExchangeQuote( + acceptReservedInstancesExchangeQuote( args: AcceptReservedInstancesExchangeQuoteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptReservedInstancesExchangeQuoteCommandOutput) => void ): void; - public acceptReservedInstancesExchangeQuote( - args: AcceptReservedInstancesExchangeQuoteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptReservedInstancesExchangeQuoteCommandOutput) => void), - cb?: (err: any, data?: AcceptReservedInstancesExchangeQuoteCommandOutput) => void - ): Promise | void { - const command = new AcceptReservedInstancesExchangeQuoteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Accepts a request to associate subnets with a transit gateway multicast domain.

- */ - public acceptTransitGatewayMulticastDomainAssociations( + + /** + * @see {@link AcceptTransitGatewayMulticastDomainAssociationsCommand} + */ + acceptTransitGatewayMulticastDomainAssociations( args: AcceptTransitGatewayMulticastDomainAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptTransitGatewayMulticastDomainAssociations( + acceptTransitGatewayMulticastDomainAssociations( args: AcceptTransitGatewayMulticastDomainAssociationsCommandInput, cb: (err: any, data?: AcceptTransitGatewayMulticastDomainAssociationsCommandOutput) => void ): void; - public acceptTransitGatewayMulticastDomainAssociations( + acceptTransitGatewayMulticastDomainAssociations( args: AcceptTransitGatewayMulticastDomainAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptTransitGatewayMulticastDomainAssociationsCommandOutput) => void ): void; - public acceptTransitGatewayMulticastDomainAssociations( - args: AcceptTransitGatewayMulticastDomainAssociationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AcceptTransitGatewayMulticastDomainAssociationsCommandOutput) => void), - cb?: (err: any, data?: AcceptTransitGatewayMulticastDomainAssociationsCommandOutput) => void - ): Promise | void { - const command = new AcceptTransitGatewayMulticastDomainAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Accepts a transit gateway peering attachment request. The peering attachment must be - * in the pendingAcceptance state.

- */ - public acceptTransitGatewayPeeringAttachment( + + /** + * @see {@link AcceptTransitGatewayPeeringAttachmentCommand} + */ + acceptTransitGatewayPeeringAttachment( args: AcceptTransitGatewayPeeringAttachmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptTransitGatewayPeeringAttachment( + acceptTransitGatewayPeeringAttachment( args: AcceptTransitGatewayPeeringAttachmentCommandInput, cb: (err: any, data?: AcceptTransitGatewayPeeringAttachmentCommandOutput) => void ): void; - public acceptTransitGatewayPeeringAttachment( + acceptTransitGatewayPeeringAttachment( args: AcceptTransitGatewayPeeringAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptTransitGatewayPeeringAttachmentCommandOutput) => void ): void; - public acceptTransitGatewayPeeringAttachment( - args: AcceptTransitGatewayPeeringAttachmentCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AcceptTransitGatewayPeeringAttachmentCommandOutput) => void), - cb?: (err: any, data?: AcceptTransitGatewayPeeringAttachmentCommandOutput) => void - ): Promise | void { - const command = new AcceptTransitGatewayPeeringAttachmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Accepts a request to attach a VPC to a transit gateway.

- *

The VPC attachment must be in the pendingAcceptance state. - * Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. - * Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request.

- */ - public acceptTransitGatewayVpcAttachment( + + /** + * @see {@link AcceptTransitGatewayVpcAttachmentCommand} + */ + acceptTransitGatewayVpcAttachment( args: AcceptTransitGatewayVpcAttachmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptTransitGatewayVpcAttachment( + acceptTransitGatewayVpcAttachment( args: AcceptTransitGatewayVpcAttachmentCommandInput, cb: (err: any, data?: AcceptTransitGatewayVpcAttachmentCommandOutput) => void ): void; - public acceptTransitGatewayVpcAttachment( + acceptTransitGatewayVpcAttachment( args: AcceptTransitGatewayVpcAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptTransitGatewayVpcAttachmentCommandOutput) => void ): void; - public acceptTransitGatewayVpcAttachment( - args: AcceptTransitGatewayVpcAttachmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptTransitGatewayVpcAttachmentCommandOutput) => void), - cb?: (err: any, data?: AcceptTransitGatewayVpcAttachmentCommandOutput) => void - ): Promise | void { - const command = new AcceptTransitGatewayVpcAttachmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Accepts connection requests to your VPC endpoint service.

- */ - public acceptVpcEndpointConnections( + + /** + * @see {@link AcceptVpcEndpointConnectionsCommand} + */ + acceptVpcEndpointConnections( args: AcceptVpcEndpointConnectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptVpcEndpointConnections( + acceptVpcEndpointConnections( args: AcceptVpcEndpointConnectionsCommandInput, cb: (err: any, data?: AcceptVpcEndpointConnectionsCommandOutput) => void ): void; - public acceptVpcEndpointConnections( + acceptVpcEndpointConnections( args: AcceptVpcEndpointConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptVpcEndpointConnectionsCommandOutput) => void ): void; - public acceptVpcEndpointConnections( - args: AcceptVpcEndpointConnectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptVpcEndpointConnectionsCommandOutput) => void), - cb?: (err: any, data?: AcceptVpcEndpointConnectionsCommandOutput) => void - ): Promise | void { - const command = new AcceptVpcEndpointConnectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Accept a VPC peering connection request. To accept a request, the VPC peering connection must - * be in the pending-acceptance state, and you must be the owner of the peer VPC. - * Use DescribeVpcPeeringConnections to view your outstanding VPC - * peering connection requests.

- *

For an inter-Region VPC peering connection request, you must accept the VPC peering - * connection in the Region of the accepter VPC.

- */ - public acceptVpcPeeringConnection( + + /** + * @see {@link AcceptVpcPeeringConnectionCommand} + */ + acceptVpcPeeringConnection( args: AcceptVpcPeeringConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptVpcPeeringConnection( + acceptVpcPeeringConnection( args: AcceptVpcPeeringConnectionCommandInput, cb: (err: any, data?: AcceptVpcPeeringConnectionCommandOutput) => void ): void; - public acceptVpcPeeringConnection( + acceptVpcPeeringConnection( args: AcceptVpcPeeringConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptVpcPeeringConnectionCommandOutput) => void ): void; - public acceptVpcPeeringConnection( - args: AcceptVpcPeeringConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptVpcPeeringConnectionCommandOutput) => void), - cb?: (err: any, data?: AcceptVpcPeeringConnectionCommandOutput) => void - ): Promise | void { - const command = new AcceptVpcPeeringConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through - * bring your own IP addresses (BYOIP).

- *

You can perform this operation at most once every 10 seconds, even if you specify different - * address ranges each time.

- *

We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise - * it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a - * BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current - * location and start advertising it through Amazon Web Services.

- *

It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services - * because of BGP propagation delays.

- *

To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.

- */ - public advertiseByoipCidr( + + /** + * @see {@link AdvertiseByoipCidrCommand} + */ + advertiseByoipCidr( args: AdvertiseByoipCidrCommandInput, options?: __HttpHandlerOptions ): Promise; - public advertiseByoipCidr( + advertiseByoipCidr( args: AdvertiseByoipCidrCommandInput, cb: (err: any, data?: AdvertiseByoipCidrCommandOutput) => void ): void; - public advertiseByoipCidr( + advertiseByoipCidr( args: AdvertiseByoipCidrCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdvertiseByoipCidrCommandOutput) => void ): void; - public advertiseByoipCidr( - args: AdvertiseByoipCidrCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdvertiseByoipCidrCommandOutput) => void), - cb?: (err: any, data?: AdvertiseByoipCidrCommandOutput) => void - ): Promise | void { - const command = new AdvertiseByoipCidrCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate - * it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address - * pool and can be allocated to a different Amazon Web Services account.

- *

You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created - * from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own - * IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

- *

[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an - * Elastic IP address that you released after it is allocated to another Amazon Web Services account. You cannot recover an Elastic IP - * address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.

- *

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate - * 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.

- *

For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

- *

You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).

- * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- */ - public allocateAddress( + + /** + * @see {@link AllocateAddressCommand} + */ + allocateAddress( args: AllocateAddressCommandInput, options?: __HttpHandlerOptions ): Promise; - public allocateAddress( - args: AllocateAddressCommandInput, - cb: (err: any, data?: AllocateAddressCommandOutput) => void - ): void; - public allocateAddress( + allocateAddress(args: AllocateAddressCommandInput, cb: (err: any, data?: AllocateAddressCommandOutput) => void): void; + allocateAddress( args: AllocateAddressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AllocateAddressCommandOutput) => void ): void; - public allocateAddress( - args: AllocateAddressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AllocateAddressCommandOutput) => void), - cb?: (err: any, data?: AllocateAddressCommandOutput) => void - ): Promise | void { - const command = new AllocateAddressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Allocates a Dedicated Host to your account. At a minimum, specify the supported - * instance type or instance family, the Availability Zone in which to allocate the host, - * and the number of hosts to allocate.

- */ - public allocateHosts( - args: AllocateHostsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public allocateHosts( - args: AllocateHostsCommandInput, - cb: (err: any, data?: AllocateHostsCommandOutput) => void - ): void; - public allocateHosts( + + /** + * @see {@link AllocateHostsCommand} + */ + allocateHosts(args: AllocateHostsCommandInput, options?: __HttpHandlerOptions): Promise; + allocateHosts(args: AllocateHostsCommandInput, cb: (err: any, data?: AllocateHostsCommandOutput) => void): void; + allocateHosts( args: AllocateHostsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AllocateHostsCommandOutput) => void ): void; - public allocateHosts( - args: AllocateHostsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AllocateHostsCommandOutput) => void), - cb?: (err: any, data?: AllocateHostsCommandOutput) => void - ): Promise | void { - const command = new AllocateHostsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Allocate a CIDR from an IPAM pool. In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource. For more information, see Allocate CIDRs in the Amazon VPC IPAM User Guide.

- * - *

This action creates an allocation with strong consistency. The returned CIDR will not overlap with any other allocations from the same pool.

- *
- */ - public allocateIpamPoolCidr( + + /** + * @see {@link AllocateIpamPoolCidrCommand} + */ + allocateIpamPoolCidr( args: AllocateIpamPoolCidrCommandInput, options?: __HttpHandlerOptions ): Promise; - public allocateIpamPoolCidr( + allocateIpamPoolCidr( args: AllocateIpamPoolCidrCommandInput, cb: (err: any, data?: AllocateIpamPoolCidrCommandOutput) => void ): void; - public allocateIpamPoolCidr( + allocateIpamPoolCidr( args: AllocateIpamPoolCidrCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AllocateIpamPoolCidrCommandOutput) => void ): void; - public allocateIpamPoolCidr( - args: AllocateIpamPoolCidrCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AllocateIpamPoolCidrCommandOutput) => void), - cb?: (err: any, data?: AllocateIpamPoolCidrCommandOutput) => void - ): Promise | void { - const command = new AllocateIpamPoolCidrCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing - * security groups with the specified security groups.

- */ - public applySecurityGroupsToClientVpnTargetNetwork( + + /** + * @see {@link ApplySecurityGroupsToClientVpnTargetNetworkCommand} + */ + applySecurityGroupsToClientVpnTargetNetwork( args: ApplySecurityGroupsToClientVpnTargetNetworkCommandInput, options?: __HttpHandlerOptions ): Promise; - public applySecurityGroupsToClientVpnTargetNetwork( + applySecurityGroupsToClientVpnTargetNetwork( args: ApplySecurityGroupsToClientVpnTargetNetworkCommandInput, cb: (err: any, data?: ApplySecurityGroupsToClientVpnTargetNetworkCommandOutput) => void ): void; - public applySecurityGroupsToClientVpnTargetNetwork( + applySecurityGroupsToClientVpnTargetNetwork( args: ApplySecurityGroupsToClientVpnTargetNetworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ApplySecurityGroupsToClientVpnTargetNetworkCommandOutput) => void ): void; - public applySecurityGroupsToClientVpnTargetNetwork( - args: ApplySecurityGroupsToClientVpnTargetNetworkCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ApplySecurityGroupsToClientVpnTargetNetworkCommandOutput) => void), - cb?: (err: any, data?: ApplySecurityGroupsToClientVpnTargetNetworkCommandOutput) => void - ): Promise | void { - const command = new ApplySecurityGroupsToClientVpnTargetNetworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Assigns one or more IPv6 addresses to the specified network interface. You can - * specify one or more specific IPv6 addresses, or you can specify the number of IPv6 - * addresses to be automatically assigned from within the subnet's IPv6 CIDR block range. - * You can assign as many IPv6 addresses to a network interface as you can assign private - * IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type - * in the Amazon Elastic Compute Cloud User Guide.

- *

You must specify either the IPv6 addresses or the IPv6 address count in the request.

- *

You can optionally use Prefix Delegation on the network interface. You must specify - * either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For - * information, see - * Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

- */ - public assignIpv6Addresses( + + /** + * @see {@link AssignIpv6AddressesCommand} + */ + assignIpv6Addresses( args: AssignIpv6AddressesCommandInput, options?: __HttpHandlerOptions ): Promise; - public assignIpv6Addresses( + assignIpv6Addresses( args: AssignIpv6AddressesCommandInput, cb: (err: any, data?: AssignIpv6AddressesCommandOutput) => void ): void; - public assignIpv6Addresses( + assignIpv6Addresses( args: AssignIpv6AddressesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssignIpv6AddressesCommandOutput) => void ): void; - public assignIpv6Addresses( - args: AssignIpv6AddressesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssignIpv6AddressesCommandOutput) => void), - cb?: (err: any, data?: AssignIpv6AddressesCommandOutput) => void - ): Promise | void { - const command = new AssignIpv6AddressesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Assigns one or more secondary private IP addresses to the specified network interface.

- *

You can specify one or more specific secondary IP addresses, or you can specify the number - * of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. - * The number of secondary IP addresses that you can assign to an instance varies by instance type. - * For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about - * Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

- *

When you move a secondary private IP address to another network interface, any Elastic IP address - * that is associated with the IP address is also moved.

- *

Remapping an IP address is an asynchronous operation. When you move an IP address from one network - * interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance - * metadata to confirm that the remapping is complete.

- *

You must specify either the IP addresses or the IP address count in the request.

- *

You can optionally use Prefix Delegation on the network interface. You must specify - * either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For - * information, see - * Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

- */ - public assignPrivateIpAddresses( + + /** + * @see {@link AssignPrivateIpAddressesCommand} + */ + assignPrivateIpAddresses( args: AssignPrivateIpAddressesCommandInput, options?: __HttpHandlerOptions ): Promise; - public assignPrivateIpAddresses( + assignPrivateIpAddresses( args: AssignPrivateIpAddressesCommandInput, cb: (err: any, data?: AssignPrivateIpAddressesCommandOutput) => void ): void; - public assignPrivateIpAddresses( + assignPrivateIpAddresses( args: AssignPrivateIpAddressesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssignPrivateIpAddressesCommandOutput) => void ): void; - public assignPrivateIpAddresses( - args: AssignPrivateIpAddressesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssignPrivateIpAddressesCommandOutput) => void), - cb?: (err: any, data?: AssignPrivateIpAddressesCommandOutput) => void - ): Promise | void { - const command = new AssignPrivateIpAddressesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Assigns one or more private IPv4 addresses to a private NAT gateway. For more information, see Work with NAT gateways in the Amazon Virtual Private Cloud User Guide.

- */ - public assignPrivateNatGatewayAddress( + + /** + * @see {@link AssignPrivateNatGatewayAddressCommand} + */ + assignPrivateNatGatewayAddress( args: AssignPrivateNatGatewayAddressCommandInput, options?: __HttpHandlerOptions ): Promise; - public assignPrivateNatGatewayAddress( + assignPrivateNatGatewayAddress( args: AssignPrivateNatGatewayAddressCommandInput, cb: (err: any, data?: AssignPrivateNatGatewayAddressCommandOutput) => void ): void; - public assignPrivateNatGatewayAddress( + assignPrivateNatGatewayAddress( args: AssignPrivateNatGatewayAddressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssignPrivateNatGatewayAddressCommandOutput) => void ): void; - public assignPrivateNatGatewayAddress( - args: AssignPrivateNatGatewayAddressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssignPrivateNatGatewayAddressCommandOutput) => void), - cb?: (err: any, data?: AssignPrivateNatGatewayAddressCommandOutput) => void - ): Promise | void { - const command = new AssignPrivateNatGatewayAddressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates an Elastic IP address, or carrier IP address (for instances that are in - * subnets in Wavelength Zones) with an instance or a network interface. Before you can use an - * Elastic IP address, you must allocate it to your account.

- *

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. - * For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

- *

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already - * associated with a different instance, it is disassociated from that instance and associated - * with the specified instance. If you associate an Elastic IP address with an instance that has - * an existing Elastic IP address, the existing address is disassociated from the instance, but - * remains allocated to your account.

- *

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic - * IP address is associated with the primary IP address. If the Elastic IP address is already - * associated with a different instance or a network interface, you get an error unless you allow - * reassociation. You cannot associate an Elastic IP address with an instance or network - * interface that has an existing Elastic IP address.

- *

[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication - * carrier to the instance or network interface.

- *

You cannot associate an Elastic IP address with an interface in a different network border group.

- * - *

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 - * doesn't return an error, and you may be charged for each time the Elastic IP address is - * remapped to the same instance. For more information, see the Elastic IP - * Addresses section of Amazon EC2 - * Pricing.

- *
- * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- */ - public associateAddress( + + /** + * @see {@link AssociateAddressCommand} + */ + associateAddress( args: AssociateAddressCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateAddress( + associateAddress( args: AssociateAddressCommandInput, cb: (err: any, data?: AssociateAddressCommandOutput) => void ): void; - public associateAddress( + associateAddress( args: AssociateAddressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateAddressCommandOutput) => void ): void; - public associateAddress( - args: AssociateAddressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateAddressCommandOutput) => void), - cb?: (err: any, data?: AssociateAddressCommandOutput) => void - ): Promise | void { - const command = new AssociateAddressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.

- *

If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that's associated with it.

- */ - public associateClientVpnTargetNetwork( + + /** + * @see {@link AssociateClientVpnTargetNetworkCommand} + */ + associateClientVpnTargetNetwork( args: AssociateClientVpnTargetNetworkCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateClientVpnTargetNetwork( + associateClientVpnTargetNetwork( args: AssociateClientVpnTargetNetworkCommandInput, cb: (err: any, data?: AssociateClientVpnTargetNetworkCommandOutput) => void ): void; - public associateClientVpnTargetNetwork( + associateClientVpnTargetNetwork( args: AssociateClientVpnTargetNetworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateClientVpnTargetNetworkCommandOutput) => void ): void; - public associateClientVpnTargetNetwork( - args: AssociateClientVpnTargetNetworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateClientVpnTargetNetworkCommandOutput) => void), - cb?: (err: any, data?: AssociateClientVpnTargetNetworkCommandOutput) => void - ): Promise | void { - const command = new AssociateClientVpnTargetNetworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

- *

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

- *

For more information, see DHCP options sets - * in the Amazon Virtual Private Cloud User Guide.

- */ - public associateDhcpOptions( + + /** + * @see {@link AssociateDhcpOptionsCommand} + */ + associateDhcpOptions( args: AssociateDhcpOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateDhcpOptions( + associateDhcpOptions( args: AssociateDhcpOptionsCommandInput, cb: (err: any, data?: AssociateDhcpOptionsCommandOutput) => void ): void; - public associateDhcpOptions( + associateDhcpOptions( args: AssociateDhcpOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateDhcpOptionsCommandOutput) => void ): void; - public associateDhcpOptions( - args: AssociateDhcpOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateDhcpOptionsCommandOutput) => void), - cb?: (err: any, data?: AssociateDhcpOptionsCommandOutput) => void - ): Promise | void { - const command = new AssociateDhcpOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. - * This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more - * information, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves - * User Guide.

- *

When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted - * private key are placed in an Amazon S3 location that only the associated IAM role can access. The private key of the certificate - * is encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.

- *

To enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject - * on the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key, - * you must grant it permission to call kms:Decrypt on the KMS key returned by the command. - * For more information, see - * Grant the role permission to access the certificate and encryption key in the - * Amazon Web Services Nitro Enclaves User Guide.

- */ - public associateEnclaveCertificateIamRole( + + /** + * @see {@link AssociateEnclaveCertificateIamRoleCommand} + */ + associateEnclaveCertificateIamRole( args: AssociateEnclaveCertificateIamRoleCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateEnclaveCertificateIamRole( + associateEnclaveCertificateIamRole( args: AssociateEnclaveCertificateIamRoleCommandInput, cb: (err: any, data?: AssociateEnclaveCertificateIamRoleCommandOutput) => void ): void; - public associateEnclaveCertificateIamRole( + associateEnclaveCertificateIamRole( args: AssociateEnclaveCertificateIamRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateEnclaveCertificateIamRoleCommandOutput) => void ): void; - public associateEnclaveCertificateIamRole( - args: AssociateEnclaveCertificateIamRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateEnclaveCertificateIamRoleCommandOutput) => void), - cb?: (err: any, data?: AssociateEnclaveCertificateIamRoleCommandOutput) => void - ): Promise | void { - const command = new AssociateEnclaveCertificateIamRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates an IAM instance profile with a running or stopped instance. You cannot - * associate more than one IAM instance profile with an instance.

- */ - public associateIamInstanceProfile( + + /** + * @see {@link AssociateIamInstanceProfileCommand} + */ + associateIamInstanceProfile( args: AssociateIamInstanceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateIamInstanceProfile( + associateIamInstanceProfile( args: AssociateIamInstanceProfileCommandInput, cb: (err: any, data?: AssociateIamInstanceProfileCommandOutput) => void ): void; - public associateIamInstanceProfile( + associateIamInstanceProfile( args: AssociateIamInstanceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateIamInstanceProfileCommandOutput) => void ): void; - public associateIamInstanceProfile( - args: AssociateIamInstanceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateIamInstanceProfileCommandOutput) => void), - cb?: (err: any, data?: AssociateIamInstanceProfileCommandOutput) => void - ): Promise | void { - const command = new AssociateIamInstanceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates one or more targets with an event window. Only one type of target (instance IDs, - * Dedicated Host IDs, or tags) can be specified with an event window.

- *

For more information, see Define event windows for scheduled - * events in the Amazon EC2 User Guide.

- */ - public associateInstanceEventWindow( + + /** + * @see {@link AssociateInstanceEventWindowCommand} + */ + associateInstanceEventWindow( args: AssociateInstanceEventWindowCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateInstanceEventWindow( + associateInstanceEventWindow( args: AssociateInstanceEventWindowCommandInput, cb: (err: any, data?: AssociateInstanceEventWindowCommandOutput) => void ): void; - public associateInstanceEventWindow( + associateInstanceEventWindow( args: AssociateInstanceEventWindowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateInstanceEventWindowCommandOutput) => void ): void; - public associateInstanceEventWindow( - args: AssociateInstanceEventWindowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateInstanceEventWindowCommandOutput) => void), - cb?: (err: any, data?: AssociateInstanceEventWindowCommandOutput) => void - ): Promise | void { - const command = new AssociateInstanceEventWindowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates an IPAM resource discovery with an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

- */ - public associateIpamResourceDiscovery( + + /** + * @see {@link AssociateIpamResourceDiscoveryCommand} + */ + associateIpamResourceDiscovery( args: AssociateIpamResourceDiscoveryCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateIpamResourceDiscovery( + associateIpamResourceDiscovery( args: AssociateIpamResourceDiscoveryCommandInput, cb: (err: any, data?: AssociateIpamResourceDiscoveryCommandOutput) => void ): void; - public associateIpamResourceDiscovery( + associateIpamResourceDiscovery( args: AssociateIpamResourceDiscoveryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateIpamResourceDiscoveryCommandOutput) => void ): void; - public associateIpamResourceDiscovery( - args: AssociateIpamResourceDiscoveryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateIpamResourceDiscoveryCommandOutput) => void), - cb?: (err: any, data?: AssociateIpamResourceDiscoveryCommandOutput) => void - ): Promise | void { - const command = new AssociateIpamResourceDiscoveryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway. For more information, see Work with NAT gateways in the Amazon Virtual Private Cloud User Guide.

- *

By default, you can associate up to 2 Elastic IP addresses per public NAT gateway. You can increase the limit by requesting a quota adjustment. For more information, see Elastic IP address quotas in the Amazon Virtual Private Cloud User Guide.

- */ - public associateNatGatewayAddress( + + /** + * @see {@link AssociateNatGatewayAddressCommand} + */ + associateNatGatewayAddress( args: AssociateNatGatewayAddressCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateNatGatewayAddress( + associateNatGatewayAddress( args: AssociateNatGatewayAddressCommandInput, cb: (err: any, data?: AssociateNatGatewayAddressCommandOutput) => void ): void; - public associateNatGatewayAddress( + associateNatGatewayAddress( args: AssociateNatGatewayAddressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateNatGatewayAddressCommandOutput) => void ): void; - public associateNatGatewayAddress( - args: AssociateNatGatewayAddressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateNatGatewayAddressCommandOutput) => void), - cb?: (err: any, data?: AssociateNatGatewayAddressCommandOutput) => void - ): Promise | void { - const command = new AssociateNatGatewayAddressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a subnet in your VPC or an internet gateway or virtual private gateway - * attached to your VPC with a route table in your VPC. This association causes traffic - * from the subnet or gateway to be routed according to the routes in the route table. The - * action returns an association ID, which you need in order to disassociate the route - * table later. A route table can be associated with multiple subnets.

- *

For more information, see Route tables in the - * Amazon Virtual Private Cloud User Guide.

- */ - public associateRouteTable( + + /** + * @see {@link AssociateRouteTableCommand} + */ + associateRouteTable( args: AssociateRouteTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateRouteTable( + associateRouteTable( args: AssociateRouteTableCommandInput, cb: (err: any, data?: AssociateRouteTableCommandOutput) => void ): void; - public associateRouteTable( + associateRouteTable( args: AssociateRouteTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateRouteTableCommandOutput) => void ): void; - public associateRouteTable( - args: AssociateRouteTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateRouteTableCommandOutput) => void), - cb?: (err: any, data?: AssociateRouteTableCommandOutput) => void - ): Promise | void { - const command = new AssociateRouteTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR - * block with your subnet. An IPv6 CIDR block must have a prefix length of /64.

- */ - public associateSubnetCidrBlock( + + /** + * @see {@link AssociateSubnetCidrBlockCommand} + */ + associateSubnetCidrBlock( args: AssociateSubnetCidrBlockCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateSubnetCidrBlock( + associateSubnetCidrBlock( args: AssociateSubnetCidrBlockCommandInput, cb: (err: any, data?: AssociateSubnetCidrBlockCommandOutput) => void ): void; - public associateSubnetCidrBlock( + associateSubnetCidrBlock( args: AssociateSubnetCidrBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateSubnetCidrBlockCommandOutput) => void ): void; - public associateSubnetCidrBlock( - args: AssociateSubnetCidrBlockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateSubnetCidrBlockCommandOutput) => void), - cb?: (err: any, data?: AssociateSubnetCidrBlockCommandOutput) => void - ): Promise | void { - const command = new AssociateSubnetCidrBlockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.

- *

The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments - * to see the state of the attachment.

- */ - public associateTransitGatewayMulticastDomain( + + /** + * @see {@link AssociateTransitGatewayMulticastDomainCommand} + */ + associateTransitGatewayMulticastDomain( args: AssociateTransitGatewayMulticastDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateTransitGatewayMulticastDomain( + associateTransitGatewayMulticastDomain( args: AssociateTransitGatewayMulticastDomainCommandInput, cb: (err: any, data?: AssociateTransitGatewayMulticastDomainCommandOutput) => void ): void; - public associateTransitGatewayMulticastDomain( + associateTransitGatewayMulticastDomain( args: AssociateTransitGatewayMulticastDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateTransitGatewayMulticastDomainCommandOutput) => void ): void; - public associateTransitGatewayMulticastDomain( - args: AssociateTransitGatewayMulticastDomainCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AssociateTransitGatewayMulticastDomainCommandOutput) => void), - cb?: (err: any, data?: AssociateTransitGatewayMulticastDomainCommandOutput) => void - ): Promise | void { - const command = new AssociateTransitGatewayMulticastDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates the specified transit gateway attachment with a transit gateway policy table.

- */ - public associateTransitGatewayPolicyTable( + + /** + * @see {@link AssociateTransitGatewayPolicyTableCommand} + */ + associateTransitGatewayPolicyTable( args: AssociateTransitGatewayPolicyTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateTransitGatewayPolicyTable( + associateTransitGatewayPolicyTable( args: AssociateTransitGatewayPolicyTableCommandInput, cb: (err: any, data?: AssociateTransitGatewayPolicyTableCommandOutput) => void ): void; - public associateTransitGatewayPolicyTable( + associateTransitGatewayPolicyTable( args: AssociateTransitGatewayPolicyTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateTransitGatewayPolicyTableCommandOutput) => void ): void; - public associateTransitGatewayPolicyTable( - args: AssociateTransitGatewayPolicyTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateTransitGatewayPolicyTableCommandOutput) => void), - cb?: (err: any, data?: AssociateTransitGatewayPolicyTableCommandOutput) => void - ): Promise | void { - const command = new AssociateTransitGatewayPolicyTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates the specified attachment with the specified transit gateway route table. You can - * associate only one route table with an attachment.

- */ - public associateTransitGatewayRouteTable( + + /** + * @see {@link AssociateTransitGatewayRouteTableCommand} + */ + associateTransitGatewayRouteTable( args: AssociateTransitGatewayRouteTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateTransitGatewayRouteTable( + associateTransitGatewayRouteTable( args: AssociateTransitGatewayRouteTableCommandInput, cb: (err: any, data?: AssociateTransitGatewayRouteTableCommandOutput) => void ): void; - public associateTransitGatewayRouteTable( + associateTransitGatewayRouteTable( args: AssociateTransitGatewayRouteTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateTransitGatewayRouteTableCommandOutput) => void ): void; - public associateTransitGatewayRouteTable( - args: AssociateTransitGatewayRouteTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateTransitGatewayRouteTableCommandOutput) => void), - cb?: (err: any, data?: AssociateTransitGatewayRouteTableCommandOutput) => void - ): Promise | void { - const command = new AssociateTransitGatewayRouteTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This API action is currently in limited preview only. - * If you are interested in using this feature, contact your account manager.

- *
- *

Associates a branch network interface with a trunk network interface.

- *

Before you create the association, run the create-network-interface command and set - * --interface-type to trunk. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.

- */ - public associateTrunkInterface( + + /** + * @see {@link AssociateTrunkInterfaceCommand} + */ + associateTrunkInterface( args: AssociateTrunkInterfaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateTrunkInterface( + associateTrunkInterface( args: AssociateTrunkInterfaceCommandInput, cb: (err: any, data?: AssociateTrunkInterfaceCommandOutput) => void ): void; - public associateTrunkInterface( + associateTrunkInterface( args: AssociateTrunkInterfaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateTrunkInterfaceCommandOutput) => void ): void; - public associateTrunkInterface( - args: AssociateTrunkInterfaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateTrunkInterfaceCommandOutput) => void), - cb?: (err: any, data?: AssociateTrunkInterfaceCommandOutput) => void - ): Promise | void { - const command = new AssociateTrunkInterfaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, - * an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that - * you provisioned through bring your own IP addresses (BYOIP). The IPv6 CIDR block size is fixed - * at /56.

- *

You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 - * pool, or an Amazon-provided IPv6 CIDR block.

- *

For more information about associating CIDR blocks with your VPC and applicable - * restrictions, see VPC and subnet sizing in the - * Amazon Virtual Private Cloud User Guide.

- */ - public associateVpcCidrBlock( + + /** + * @see {@link AssociateVpcCidrBlockCommand} + */ + associateVpcCidrBlock( args: AssociateVpcCidrBlockCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateVpcCidrBlock( + associateVpcCidrBlock( args: AssociateVpcCidrBlockCommandInput, cb: (err: any, data?: AssociateVpcCidrBlockCommandOutput) => void ): void; - public associateVpcCidrBlock( + associateVpcCidrBlock( args: AssociateVpcCidrBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateVpcCidrBlockCommandOutput) => void ): void; - public associateVpcCidrBlock( - args: AssociateVpcCidrBlockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateVpcCidrBlockCommandOutput) => void), - cb?: (err: any, data?: AssociateVpcCidrBlockCommandOutput) => void - ): Promise | void { - const command = new AssociateVpcCidrBlockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- *

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's - * security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You - * can only link an instance that's in the running state. An instance is - * automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when - * you restart it.

- *

After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.

- *

Linking your instance to a VPC is sometimes referred to as attaching your instance.

- */ - public attachClassicLinkVpc( + + /** + * @see {@link AttachClassicLinkVpcCommand} + */ + attachClassicLinkVpc( args: AttachClassicLinkVpcCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachClassicLinkVpc( + attachClassicLinkVpc( args: AttachClassicLinkVpcCommandInput, cb: (err: any, data?: AttachClassicLinkVpcCommandOutput) => void ): void; - public attachClassicLinkVpc( + attachClassicLinkVpc( args: AttachClassicLinkVpcCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachClassicLinkVpcCommandOutput) => void ): void; - public attachClassicLinkVpc( - args: AttachClassicLinkVpcCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachClassicLinkVpcCommandOutput) => void), - cb?: (err: any, data?: AttachClassicLinkVpcCommandOutput) => void - ): Promise | void { - const command = new AttachClassicLinkVpcCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and - * the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.

- */ - public attachInternetGateway( + + /** + * @see {@link AttachInternetGatewayCommand} + */ + attachInternetGateway( args: AttachInternetGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachInternetGateway( + attachInternetGateway( args: AttachInternetGatewayCommandInput, cb: (err: any, data?: AttachInternetGatewayCommandOutput) => void ): void; - public attachInternetGateway( + attachInternetGateway( args: AttachInternetGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachInternetGatewayCommandOutput) => void ): void; - public attachInternetGateway( - args: AttachInternetGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachInternetGatewayCommandOutput) => void), - cb?: (err: any, data?: AttachInternetGatewayCommandOutput) => void - ): Promise | void { - const command = new AttachInternetGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attaches a network interface to an instance.

- */ - public attachNetworkInterface( + + /** + * @see {@link AttachNetworkInterfaceCommand} + */ + attachNetworkInterface( args: AttachNetworkInterfaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachNetworkInterface( + attachNetworkInterface( args: AttachNetworkInterfaceCommandInput, cb: (err: any, data?: AttachNetworkInterfaceCommandOutput) => void ): void; - public attachNetworkInterface( + attachNetworkInterface( args: AttachNetworkInterfaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachNetworkInterfaceCommandOutput) => void ): void; - public attachNetworkInterface( - args: AttachNetworkInterfaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachNetworkInterfaceCommandOutput) => void), - cb?: (err: any, data?: AttachNetworkInterfaceCommandOutput) => void - ): Promise | void { - const command = new AttachNetworkInterfaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

A trust provider is a third-party entity that creates, maintains, and manages identity - * information for users and devices. One or more trust providers can be attached to an Amazon Web Services Verified Access - * instance.

- */ - public attachVerifiedAccessTrustProvider( + + /** + * @see {@link AttachVerifiedAccessTrustProviderCommand} + */ + attachVerifiedAccessTrustProvider( args: AttachVerifiedAccessTrustProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachVerifiedAccessTrustProvider( + attachVerifiedAccessTrustProvider( args: AttachVerifiedAccessTrustProviderCommandInput, cb: (err: any, data?: AttachVerifiedAccessTrustProviderCommandOutput) => void ): void; - public attachVerifiedAccessTrustProvider( + attachVerifiedAccessTrustProvider( args: AttachVerifiedAccessTrustProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachVerifiedAccessTrustProviderCommandOutput) => void ): void; - public attachVerifiedAccessTrustProvider( - args: AttachVerifiedAccessTrustProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachVerifiedAccessTrustProviderCommandOutput) => void), - cb?: (err: any, data?: AttachVerifiedAccessTrustProviderCommandOutput) => void - ): Promise | void { - const command = new AttachVerifiedAccessTrustProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attaches an EBS volume to a running or stopped instance and exposes it to the instance - * with the specified device name.

- *

Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For - * more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

- *

After you attach an EBS volume, you must make it available. For more information, see - * Make an EBS volume available for use.

- *

If a volume has an Amazon Web Services Marketplace product code:

- *
    - *
  • - *

    The volume can be attached only to a stopped instance.

    - *
  • - *
  • - *

    Amazon Web Services Marketplace product codes are copied from the volume to the instance.

    - *
  • - *
  • - *

    You must be subscribed to the product.

    - *
  • - *
  • - *

    The instance type and operating system of the instance must support the product. For - * example, you can't detach a volume from a Windows instance and attach it to a Linux - * instance.

    - *
  • - *
- *

For more information, see Attach an Amazon EBS volume to an instance in the - * Amazon Elastic Compute Cloud User Guide.

- */ - public attachVolume( - args: AttachVolumeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public attachVolume(args: AttachVolumeCommandInput, cb: (err: any, data?: AttachVolumeCommandOutput) => void): void; - public attachVolume( + + /** + * @see {@link AttachVolumeCommand} + */ + attachVolume(args: AttachVolumeCommandInput, options?: __HttpHandlerOptions): Promise; + attachVolume(args: AttachVolumeCommandInput, cb: (err: any, data?: AttachVolumeCommandOutput) => void): void; + attachVolume( args: AttachVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachVolumeCommandOutput) => void ): void; - public attachVolume( - args: AttachVolumeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachVolumeCommandOutput) => void), - cb?: (err: any, data?: AttachVolumeCommandOutput) => void - ): Promise | void { - const command = new AttachVolumeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attaches a virtual private gateway to a VPC. You can attach one virtual private - * gateway to one VPC at a time.

- *

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN - * User Guide.

- */ - public attachVpnGateway( + + /** + * @see {@link AttachVpnGatewayCommand} + */ + attachVpnGateway( args: AttachVpnGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachVpnGateway( + attachVpnGateway( args: AttachVpnGatewayCommandInput, cb: (err: any, data?: AttachVpnGatewayCommandOutput) => void ): void; - public attachVpnGateway( + attachVpnGateway( args: AttachVpnGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachVpnGatewayCommandOutput) => void ): void; - public attachVpnGateway( - args: AttachVpnGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachVpnGatewayCommandOutput) => void), - cb?: (err: any, data?: AttachVpnGatewayCommandOutput) => void - ): Promise | void { - const command = new AttachVpnGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as - * firewall rules that grant access to networks. You must configure ingress authorization rules to - * enable clients to access resources in Amazon Web Services or on-premises networks.

- */ - public authorizeClientVpnIngress( + + /** + * @see {@link AuthorizeClientVpnIngressCommand} + */ + authorizeClientVpnIngress( args: AuthorizeClientVpnIngressCommandInput, options?: __HttpHandlerOptions ): Promise; - public authorizeClientVpnIngress( + authorizeClientVpnIngress( args: AuthorizeClientVpnIngressCommandInput, cb: (err: any, data?: AuthorizeClientVpnIngressCommandOutput) => void ): void; - public authorizeClientVpnIngress( + authorizeClientVpnIngress( args: AuthorizeClientVpnIngressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AuthorizeClientVpnIngressCommandOutput) => void ): void; - public authorizeClientVpnIngress( - args: AuthorizeClientVpnIngressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AuthorizeClientVpnIngressCommandOutput) => void), - cb?: (err: any, data?: AuthorizeClientVpnIngressCommandOutput) => void - ): Promise | void { - const command = new AuthorizeClientVpnIngressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

[VPC only] Adds the specified outbound (egress) rules to a security group for use with a VPC.

- *

An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR - * address ranges, or to the instances that are associated with the specified source - * security groups. When specifying an outbound rule for your security group in a VPC, the - * IpPermissions must include a destination for the traffic.

- *

You specify a protocol for each rule (for example, TCP). - * For the TCP and UDP protocols, you must also specify the destination port or port range. - * For the ICMP protocol, you must also specify the ICMP type and code. - * You can use -1 for the type or code to mean all types or all codes.

- *

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

- *

For information about VPC security group quotas, see Amazon VPC quotas.

- */ - public authorizeSecurityGroupEgress( + + /** + * @see {@link AuthorizeSecurityGroupEgressCommand} + */ + authorizeSecurityGroupEgress( args: AuthorizeSecurityGroupEgressCommandInput, options?: __HttpHandlerOptions ): Promise; - public authorizeSecurityGroupEgress( + authorizeSecurityGroupEgress( args: AuthorizeSecurityGroupEgressCommandInput, cb: (err: any, data?: AuthorizeSecurityGroupEgressCommandOutput) => void ): void; - public authorizeSecurityGroupEgress( + authorizeSecurityGroupEgress( args: AuthorizeSecurityGroupEgressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AuthorizeSecurityGroupEgressCommandOutput) => void ): void; - public authorizeSecurityGroupEgress( - args: AuthorizeSecurityGroupEgressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AuthorizeSecurityGroupEgressCommandOutput) => void), - cb?: (err: any, data?: AuthorizeSecurityGroupEgressCommandOutput) => void - ): Promise | void { - const command = new AuthorizeSecurityGroupEgressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds the specified inbound (ingress) rules to a security group.

- *

An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR - * address range, or from the instances that are associated with the specified destination security - * groups. When specifying an inbound rule for your security group in a VPC, the - * IpPermissions must include a source for the traffic.

- *

You specify a protocol for each rule (for example, TCP). - * For TCP and UDP, you must also specify the destination port or port range. - * For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. - * You can use -1 to mean all types or all codes.

- *

Rule changes are propagated to instances within the security group as quickly as possible. - * However, a small delay might occur.

- *

For more information about VPC security group quotas, see Amazon VPC quotas.

- * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- */ - public authorizeSecurityGroupIngress( + + /** + * @see {@link AuthorizeSecurityGroupIngressCommand} + */ + authorizeSecurityGroupIngress( args: AuthorizeSecurityGroupIngressCommandInput, options?: __HttpHandlerOptions ): Promise; - public authorizeSecurityGroupIngress( + authorizeSecurityGroupIngress( args: AuthorizeSecurityGroupIngressCommandInput, cb: (err: any, data?: AuthorizeSecurityGroupIngressCommandOutput) => void ): void; - public authorizeSecurityGroupIngress( + authorizeSecurityGroupIngress( args: AuthorizeSecurityGroupIngressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AuthorizeSecurityGroupIngressCommandOutput) => void ): void; - public authorizeSecurityGroupIngress( - args: AuthorizeSecurityGroupIngressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AuthorizeSecurityGroupIngressCommandOutput) => void), - cb?: (err: any, data?: AuthorizeSecurityGroupIngressCommandOutput) => void - ): Promise | void { - const command = new AuthorizeSecurityGroupIngressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Bundles an Amazon instance store-backed Windows instance.

- *

During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved.

- * - *

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

- *
- */ - public bundleInstance( + + /** + * @see {@link BundleInstanceCommand} + */ + bundleInstance( args: BundleInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public bundleInstance( - args: BundleInstanceCommandInput, - cb: (err: any, data?: BundleInstanceCommandOutput) => void - ): void; - public bundleInstance( + bundleInstance(args: BundleInstanceCommandInput, cb: (err: any, data?: BundleInstanceCommandOutput) => void): void; + bundleInstance( args: BundleInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BundleInstanceCommandOutput) => void ): void; - public bundleInstance( - args: BundleInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BundleInstanceCommandOutput) => void), - cb?: (err: any, data?: BundleInstanceCommandOutput) => void - ): Promise | void { - const command = new BundleInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels a bundling operation for an instance store-backed Windows instance.

- */ - public cancelBundleTask( + + /** + * @see {@link CancelBundleTaskCommand} + */ + cancelBundleTask( args: CancelBundleTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelBundleTask( + cancelBundleTask( args: CancelBundleTaskCommandInput, cb: (err: any, data?: CancelBundleTaskCommandOutput) => void ): void; - public cancelBundleTask( + cancelBundleTask( args: CancelBundleTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelBundleTaskCommandOutput) => void ): void; - public cancelBundleTask( - args: CancelBundleTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelBundleTaskCommandOutput) => void), - cb?: (err: any, data?: CancelBundleTaskCommandOutput) => void - ): Promise | void { - const command = new CancelBundleTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to - * cancelled.

- *

Instances running in the reserved capacity continue running until you stop them. Stopped - * instances that target the Capacity Reservation can no longer launch. Modify these instances to either - * target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation - * that has matching attributes and sufficient capacity.

- */ - public cancelCapacityReservation( + + /** + * @see {@link CancelCapacityReservationCommand} + */ + cancelCapacityReservation( args: CancelCapacityReservationCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelCapacityReservation( + cancelCapacityReservation( args: CancelCapacityReservationCommandInput, cb: (err: any, data?: CancelCapacityReservationCommandOutput) => void ): void; - public cancelCapacityReservation( + cancelCapacityReservation( args: CancelCapacityReservationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelCapacityReservationCommandOutput) => void ): void; - public cancelCapacityReservation( - args: CancelCapacityReservationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelCapacityReservationCommandOutput) => void), - cb?: (err: any, data?: CancelCapacityReservationCommandOutput) => void - ): Promise | void { - const command = new CancelCapacityReservationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation - * Fleet, the following happens:

- *
    - *
  • - *

    The Capacity Reservation Fleet's status changes to cancelled.

    - *
  • - *
  • - *

    The individual Capacity Reservations in the Fleet are cancelled. Instances running - * in the Capacity Reservations at the time of cancelling the Fleet continue to run in - * shared capacity.

    - *
  • - *
  • - *

    The Fleet stops creating new Capacity Reservations.

    - *
  • - *
- */ - public cancelCapacityReservationFleets( + + /** + * @see {@link CancelCapacityReservationFleetsCommand} + */ + cancelCapacityReservationFleets( args: CancelCapacityReservationFleetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelCapacityReservationFleets( + cancelCapacityReservationFleets( args: CancelCapacityReservationFleetsCommandInput, cb: (err: any, data?: CancelCapacityReservationFleetsCommandOutput) => void ): void; - public cancelCapacityReservationFleets( + cancelCapacityReservationFleets( args: CancelCapacityReservationFleetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelCapacityReservationFleetsCommandOutput) => void ): void; - public cancelCapacityReservationFleets( - args: CancelCapacityReservationFleetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelCapacityReservationFleetsCommandOutput) => void), - cb?: (err: any, data?: CancelCapacityReservationFleetsCommandOutput) => void - ): Promise | void { - const command = new CancelCapacityReservationFleetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all - * artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is - * in the process of transferring the final disk image, the command fails and returns an exception.

- *

For more information, see Importing a Virtual Machine Using the Amazon - * EC2 CLI.

- */ - public cancelConversionTask( + + /** + * @see {@link CancelConversionTaskCommand} + */ + cancelConversionTask( args: CancelConversionTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelConversionTask( + cancelConversionTask( args: CancelConversionTaskCommandInput, cb: (err: any, data?: CancelConversionTaskCommandOutput) => void ): void; - public cancelConversionTask( + cancelConversionTask( args: CancelConversionTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelConversionTaskCommandOutput) => void ): void; - public cancelConversionTask( - args: CancelConversionTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelConversionTaskCommandOutput) => void), - cb?: (err: any, data?: CancelConversionTaskCommandOutput) => void - ): Promise | void { - const command = new CancelConversionTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels an active export task. The request removes all artifacts of the export, including any partially-created - * Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the - * command fails and returns an error.

- */ - public cancelExportTask( + + /** + * @see {@link CancelExportTaskCommand} + */ + cancelExportTask( args: CancelExportTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelExportTask( + cancelExportTask( args: CancelExportTaskCommandInput, cb: (err: any, data?: CancelExportTaskCommandOutput) => void ): void; - public cancelExportTask( + cancelExportTask( args: CancelExportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelExportTaskCommandOutput) => void ): void; - public cancelExportTask( - args: CancelExportTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelExportTaskCommandOutput) => void), - cb?: (err: any, data?: CancelExportTaskCommandOutput) => void - ): Promise | void { - const command = new CancelExportTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes your Amazon Web Services account from the launch permissions for the specified AMI. For more - * information, see - * Cancel having an AMI shared with your Amazon Web Services account in the - * Amazon EC2 User Guide.

- */ - public cancelImageLaunchPermission( + + /** + * @see {@link CancelImageLaunchPermissionCommand} + */ + cancelImageLaunchPermission( args: CancelImageLaunchPermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelImageLaunchPermission( + cancelImageLaunchPermission( args: CancelImageLaunchPermissionCommandInput, cb: (err: any, data?: CancelImageLaunchPermissionCommandOutput) => void ): void; - public cancelImageLaunchPermission( + cancelImageLaunchPermission( args: CancelImageLaunchPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelImageLaunchPermissionCommandOutput) => void ): void; - public cancelImageLaunchPermission( - args: CancelImageLaunchPermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelImageLaunchPermissionCommandOutput) => void), - cb?: (err: any, data?: CancelImageLaunchPermissionCommandOutput) => void - ): Promise | void { - const command = new CancelImageLaunchPermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels an in-process import virtual machine or import snapshot task.

- */ - public cancelImportTask( + + /** + * @see {@link CancelImportTaskCommand} + */ + cancelImportTask( args: CancelImportTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelImportTask( + cancelImportTask( args: CancelImportTaskCommandInput, cb: (err: any, data?: CancelImportTaskCommandOutput) => void ): void; - public cancelImportTask( + cancelImportTask( args: CancelImportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelImportTaskCommandOutput) => void ): void; - public cancelImportTask( - args: CancelImportTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelImportTaskCommandOutput) => void), - cb?: (err: any, data?: CancelImportTaskCommandOutput) => void - ): Promise | void { - const command = new CancelImportTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

- *

For more information, see - * Reserved Instance Marketplace - * in the Amazon EC2 User Guide.

- */ - public cancelReservedInstancesListing( + + /** + * @see {@link CancelReservedInstancesListingCommand} + */ + cancelReservedInstancesListing( args: CancelReservedInstancesListingCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelReservedInstancesListing( + cancelReservedInstancesListing( args: CancelReservedInstancesListingCommandInput, cb: (err: any, data?: CancelReservedInstancesListingCommandOutput) => void ): void; - public cancelReservedInstancesListing( + cancelReservedInstancesListing( args: CancelReservedInstancesListingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelReservedInstancesListingCommandOutput) => void ): void; - public cancelReservedInstancesListing( - args: CancelReservedInstancesListingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelReservedInstancesListingCommandOutput) => void), - cb?: (err: any, data?: CancelReservedInstancesListingCommandOutput) => void - ): Promise | void { - const command = new CancelReservedInstancesListingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels the specified Spot Fleet requests.

- *

After you cancel a Spot Fleet request, the Spot Fleet launches no new instances.

- *

You must also specify whether a canceled Spot Fleet request should terminate its instances. If you - * choose to terminate the instances, the Spot Fleet request enters the - * cancelled_terminating state. Otherwise, the Spot Fleet request enters - * the cancelled_running state and the instances continue to run until they - * are interrupted or you terminate them manually.

- */ - public cancelSpotFleetRequests( + + /** + * @see {@link CancelSpotFleetRequestsCommand} + */ + cancelSpotFleetRequests( args: CancelSpotFleetRequestsCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelSpotFleetRequests( + cancelSpotFleetRequests( args: CancelSpotFleetRequestsCommandInput, cb: (err: any, data?: CancelSpotFleetRequestsCommandOutput) => void ): void; - public cancelSpotFleetRequests( + cancelSpotFleetRequests( args: CancelSpotFleetRequestsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelSpotFleetRequestsCommandOutput) => void ): void; - public cancelSpotFleetRequests( - args: CancelSpotFleetRequestsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelSpotFleetRequestsCommandOutput) => void), - cb?: (err: any, data?: CancelSpotFleetRequestsCommandOutput) => void - ): Promise | void { - const command = new CancelSpotFleetRequestsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels one or more Spot Instance requests.

- * - *

Canceling a Spot Instance request does not terminate running Spot Instances - * associated with the request.

- *
- */ - public cancelSpotInstanceRequests( + + /** + * @see {@link CancelSpotInstanceRequestsCommand} + */ + cancelSpotInstanceRequests( args: CancelSpotInstanceRequestsCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelSpotInstanceRequests( + cancelSpotInstanceRequests( args: CancelSpotInstanceRequestsCommandInput, cb: (err: any, data?: CancelSpotInstanceRequestsCommandOutput) => void ): void; - public cancelSpotInstanceRequests( + cancelSpotInstanceRequests( args: CancelSpotInstanceRequestsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelSpotInstanceRequestsCommandOutput) => void ): void; - public cancelSpotInstanceRequests( - args: CancelSpotInstanceRequestsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelSpotInstanceRequestsCommandOutput) => void), - cb?: (err: any, data?: CancelSpotInstanceRequestsCommandOutput) => void - ): Promise | void { - const command = new CancelSpotInstanceRequestsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Determines whether a product code is associated with an instance. This action can only - * be used by the owner of the product code. It is useful when a product code owner must - * verify whether another user's instance is eligible for support.

- */ - public confirmProductInstance( + + /** + * @see {@link ConfirmProductInstanceCommand} + */ + confirmProductInstance( args: ConfirmProductInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public confirmProductInstance( + confirmProductInstance( args: ConfirmProductInstanceCommandInput, cb: (err: any, data?: ConfirmProductInstanceCommandOutput) => void ): void; - public confirmProductInstance( + confirmProductInstance( args: ConfirmProductInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfirmProductInstanceCommandOutput) => void ): void; - public confirmProductInstance( - args: ConfirmProductInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConfirmProductInstanceCommandOutput) => void), - cb?: (err: any, data?: ConfirmProductInstanceCommandOutput) => void - ): Promise | void { - const command = new ConfirmProductInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Copies the specified Amazon FPGA Image (AFI) to the current Region.

- */ - public copyFpgaImage( - args: CopyFpgaImageCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public copyFpgaImage( - args: CopyFpgaImageCommandInput, - cb: (err: any, data?: CopyFpgaImageCommandOutput) => void - ): void; - public copyFpgaImage( + + /** + * @see {@link CopyFpgaImageCommand} + */ + copyFpgaImage(args: CopyFpgaImageCommandInput, options?: __HttpHandlerOptions): Promise; + copyFpgaImage(args: CopyFpgaImageCommandInput, cb: (err: any, data?: CopyFpgaImageCommandOutput) => void): void; + copyFpgaImage( args: CopyFpgaImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyFpgaImageCommandOutput) => void ): void; - public copyFpgaImage( - args: CopyFpgaImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopyFpgaImageCommandOutput) => void), - cb?: (err: any, data?: CopyFpgaImageCommandOutput) => void - ): Promise | void { - const command = new CopyFpgaImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a - * Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost - * to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.

- *

To copy an AMI from one Region to another, specify the source Region using the - * SourceRegion parameter, and specify the - * destination Region using its endpoint. Copies of encrypted backing snapshots for - * the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, - * unless you set Encrypted during the copy operation. You cannot - * create an unencrypted copy of an encrypted backing snapshot.

- *

To copy an AMI from a Region to an Outpost, specify the source Region using the - * SourceRegion parameter, and specify the - * ARN of the destination Outpost using DestinationOutpostArn. - * Backing snapshots copied to an Outpost are encrypted by default using the default - * encryption key for the Region, or a different key that you specify in the request using - * KmsKeyId. Outposts do not support unencrypted - * snapshots. For more information, - * Amazon EBS local snapshots on Outposts in the Amazon EC2 User Guide.

- *

For more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the - * Amazon EC2 User Guide.

- */ - public copyImage(args: CopyImageCommandInput, options?: __HttpHandlerOptions): Promise; - public copyImage(args: CopyImageCommandInput, cb: (err: any, data?: CopyImageCommandOutput) => void): void; - public copyImage( + + /** + * @see {@link CopyImageCommand} + */ + copyImage(args: CopyImageCommandInput, options?: __HttpHandlerOptions): Promise; + copyImage(args: CopyImageCommandInput, cb: (err: any, data?: CopyImageCommandOutput) => void): void; + copyImage( args: CopyImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyImageCommandOutput) => void ): void; - public copyImage( - args: CopyImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopyImageCommandOutput) => void), - cb?: (err: any, data?: CopyImageCommandOutput) => void - ): Promise | void { - const command = new CopyImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a - * snapshot within the same Region, from one Region to another, or from a Region to an Outpost. - * You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within - * the same Outpost.

- *

You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).

- *

When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. - * Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the - * snapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS) - * KMS key; however, you can specify a different KMS key. To copy an encrypted - * snapshot that has been shared from another account, you must have permissions for the KMS key - * used to encrypt the snapshot.

- *

Snapshots copied to an Outpost are encrypted by default using the default - * encryption key for the Region, or a different key that you specify in the request using - * KmsKeyId. Outposts do not support unencrypted - * snapshots. For more information, - * Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.

- *

Snapshots created by copying another snapshot have an arbitrary volume ID that should not - * be used for any purpose.

- *

For more information, see Copy an Amazon EBS snapshot in the - * Amazon Elastic Compute Cloud User Guide.

- */ - public copySnapshot( - args: CopySnapshotCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public copySnapshot(args: CopySnapshotCommandInput, cb: (err: any, data?: CopySnapshotCommandOutput) => void): void; - public copySnapshot( + + /** + * @see {@link CopySnapshotCommand} + */ + copySnapshot(args: CopySnapshotCommandInput, options?: __HttpHandlerOptions): Promise; + copySnapshot(args: CopySnapshotCommandInput, cb: (err: any, data?: CopySnapshotCommandOutput) => void): void; + copySnapshot( args: CopySnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopySnapshotCommandOutput) => void ): void; - public copySnapshot( - args: CopySnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopySnapshotCommandOutput) => void), - cb?: (err: any, data?: CopySnapshotCommandOutput) => void - ): Promise | void { - const command = new CopySnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new Capacity Reservation with the specified attributes.

- *

Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This - * gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. - * By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. - * For more information, see Capacity Reservations in the Amazon EC2 User Guide.

- *

Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to - * fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try - * again at a later time, try in a different Availability Zone, or request a smaller - * capacity reservation. If your application is flexible across instance types and sizes, - * try to create a Capacity Reservation with different instance attributes.

- *

Your request could also fail if the requested quantity exceeds your On-Demand Instance - * limit for the selected instance type. If your request fails due to limit constraints, - * increase your On-Demand Instance limit for the required instance type and try again. For - * more information about increasing your instance limits, see Amazon EC2 Service - * Quotas in the Amazon EC2 User Guide.

- */ - public createCapacityReservation( + + /** + * @see {@link CreateCapacityReservationCommand} + */ + createCapacityReservation( args: CreateCapacityReservationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCapacityReservation( + createCapacityReservation( args: CreateCapacityReservationCommandInput, cb: (err: any, data?: CreateCapacityReservationCommandOutput) => void ): void; - public createCapacityReservation( + createCapacityReservation( args: CreateCapacityReservationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCapacityReservationCommandOutput) => void ): void; - public createCapacityReservation( - args: CreateCapacityReservationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCapacityReservationCommandOutput) => void), - cb?: (err: any, data?: CreateCapacityReservationCommandOutput) => void - ): Promise | void { - const command = new CreateCapacityReservationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Capacity Reservation Fleet. For more information, see Create a Capacity - * Reservation Fleet in the Amazon EC2 User Guide.

- */ - public createCapacityReservationFleet( + + /** + * @see {@link CreateCapacityReservationFleetCommand} + */ + createCapacityReservationFleet( args: CreateCapacityReservationFleetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCapacityReservationFleet( + createCapacityReservationFleet( args: CreateCapacityReservationFleetCommandInput, cb: (err: any, data?: CreateCapacityReservationFleetCommandOutput) => void ): void; - public createCapacityReservationFleet( + createCapacityReservationFleet( args: CreateCapacityReservationFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCapacityReservationFleetCommandOutput) => void ): void; - public createCapacityReservationFleet( - args: CreateCapacityReservationFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCapacityReservationFleetCommandOutput) => void), - cb?: (err: any, data?: CreateCapacityReservationFleetCommandOutput) => void - ): Promise | void { - const command = new CreateCapacityReservationFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide.

- */ - public createCarrierGateway( + + /** + * @see {@link CreateCarrierGatewayCommand} + */ + createCarrierGateway( args: CreateCarrierGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCarrierGateway( + createCarrierGateway( args: CreateCarrierGatewayCommandInput, cb: (err: any, data?: CreateCarrierGatewayCommandOutput) => void ): void; - public createCarrierGateway( + createCarrierGateway( args: CreateCarrierGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCarrierGatewayCommandOutput) => void ): void; - public createCarrierGateway( - args: CreateCarrierGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCarrierGatewayCommandOutput) => void), - cb?: (err: any, data?: CreateCarrierGatewayCommandOutput) => void - ): Promise | void { - const command = new CreateCarrierGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to - * enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions - * are terminated.

- */ - public createClientVpnEndpoint( + + /** + * @see {@link CreateClientVpnEndpointCommand} + */ + createClientVpnEndpoint( args: CreateClientVpnEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createClientVpnEndpoint( + createClientVpnEndpoint( args: CreateClientVpnEndpointCommandInput, cb: (err: any, data?: CreateClientVpnEndpointCommandOutput) => void ): void; - public createClientVpnEndpoint( + createClientVpnEndpoint( args: CreateClientVpnEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClientVpnEndpointCommandOutput) => void ): void; - public createClientVpnEndpoint( - args: CreateClientVpnEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateClientVpnEndpointCommandOutput) => void), - cb?: (err: any, data?: CreateClientVpnEndpointCommandOutput) => void - ): Promise | void { - const command = new CreateClientVpnEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the - * available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.

- */ - public createClientVpnRoute( + + /** + * @see {@link CreateClientVpnRouteCommand} + */ + createClientVpnRoute( args: CreateClientVpnRouteCommandInput, options?: __HttpHandlerOptions ): Promise; - public createClientVpnRoute( + createClientVpnRoute( args: CreateClientVpnRouteCommandInput, cb: (err: any, data?: CreateClientVpnRouteCommandOutput) => void ): void; - public createClientVpnRoute( + createClientVpnRoute( args: CreateClientVpnRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClientVpnRouteCommandOutput) => void ): void; - public createClientVpnRoute( - args: CreateClientVpnRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateClientVpnRouteCommandOutput) => void), - cb?: (err: any, data?: CreateClientVpnRouteCommandOutput) => void - ): Promise | void { - const command = new CreateClientVpnRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Creates a range of customer-owned IP addresses. - *

- */ - public createCoipCidr( + + /** + * @see {@link CreateCoipCidrCommand} + */ + createCoipCidr( args: CreateCoipCidrCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCoipCidr( - args: CreateCoipCidrCommandInput, - cb: (err: any, data?: CreateCoipCidrCommandOutput) => void - ): void; - public createCoipCidr( + createCoipCidr(args: CreateCoipCidrCommandInput, cb: (err: any, data?: CreateCoipCidrCommandOutput) => void): void; + createCoipCidr( args: CreateCoipCidrCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCoipCidrCommandOutput) => void ): void; - public createCoipCidr( - args: CreateCoipCidrCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCoipCidrCommandOutput) => void), - cb?: (err: any, data?: CreateCoipCidrCommandOutput) => void - ): Promise | void { - const command = new CreateCoipCidrCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a pool of customer-owned IP (CoIP) addresses.

- */ - public createCoipPool( + + /** + * @see {@link CreateCoipPoolCommand} + */ + createCoipPool( args: CreateCoipPoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCoipPool( - args: CreateCoipPoolCommandInput, - cb: (err: any, data?: CreateCoipPoolCommandOutput) => void - ): void; - public createCoipPool( + createCoipPool(args: CreateCoipPoolCommandInput, cb: (err: any, data?: CreateCoipPoolCommandOutput) => void): void; + createCoipPool( args: CreateCoipPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCoipPoolCommandOutput) => void ): void; - public createCoipPool( - args: CreateCoipPoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCoipPoolCommandOutput) => void), - cb?: (err: any, data?: CreateCoipPoolCommandOutput) => void - ): Promise | void { - const command = new CreateCoipPoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides information to Amazon Web Services about your customer gateway device. The - * customer gateway device is the appliance at your end of the VPN connection. You - * must provide the IP address of the customer gateway device’s external - * interface. The IP address must be static and can be behind a device performing network - * address translation (NAT).

- *

For devices that use Border Gateway Protocol (BGP), you can also provide the device's - * BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. - * If you don't have an ASN already, you can use a private ASN. For more information, see - * Customer gateway - * options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.

- *

To create more than one customer gateway with the same VPN type, IP address, and - * BGP ASN, specify a unique device name for each customer gateway. An identical request - * returns information about the existing customer gateway; it doesn't create a new customer - * gateway.

- */ - public createCustomerGateway( + + /** + * @see {@link CreateCustomerGatewayCommand} + */ + createCustomerGateway( args: CreateCustomerGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCustomerGateway( + createCustomerGateway( args: CreateCustomerGatewayCommandInput, cb: (err: any, data?: CreateCustomerGatewayCommandOutput) => void ): void; - public createCustomerGateway( + createCustomerGateway( args: CreateCustomerGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomerGatewayCommandOutput) => void ): void; - public createCustomerGateway( - args: CreateCustomerGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCustomerGatewayCommandOutput) => void), - cb?: (err: any, data?: CreateCustomerGatewayCommandOutput) => void - ): Promise | void { - const command = new CreateCustomerGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a default subnet with a size /20 IPv4 CIDR block in the - * specified Availability Zone in your default VPC. You can have only one default subnet - * per Availability Zone. For more information, see Creating a default - * subnet in the Amazon Virtual Private Cloud User Guide.

- */ - public createDefaultSubnet( + + /** + * @see {@link CreateDefaultSubnetCommand} + */ + createDefaultSubnet( args: CreateDefaultSubnetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDefaultSubnet( + createDefaultSubnet( args: CreateDefaultSubnetCommandInput, cb: (err: any, data?: CreateDefaultSubnetCommandOutput) => void ): void; - public createDefaultSubnet( + createDefaultSubnet( args: CreateDefaultSubnetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDefaultSubnetCommandOutput) => void ): void; - public createDefaultSubnet( - args: CreateDefaultSubnetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDefaultSubnetCommandOutput) => void), - cb?: (err: any, data?: CreateDefaultSubnetCommandOutput) => void - ): Promise | void { - const command = new CreateDefaultSubnetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet - * in each Availability Zone. For more information about the components of a default VPC, - * see Default VPC and - * default subnets in the Amazon Virtual Private Cloud User Guide. You cannot - * specify the components of the default VPC yourself.

- *

If you deleted your previous default VPC, you can create a default VPC. You cannot have - * more than one default VPC per Region.

- *

If your account supports EC2-Classic, you cannot use this action to create a default VPC - * in a Region that supports EC2-Classic. If you want a default VPC in a Region that - * supports EC2-Classic, see "I really want a default VPC for my existing EC2 account. Is - * that possible?" in the Default VPCs - * FAQ.

- * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- */ - public createDefaultVpc( + + /** + * @see {@link CreateDefaultVpcCommand} + */ + createDefaultVpc( args: CreateDefaultVpcCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDefaultVpc( + createDefaultVpc( args: CreateDefaultVpcCommandInput, cb: (err: any, data?: CreateDefaultVpcCommandOutput) => void ): void; - public createDefaultVpc( + createDefaultVpc( args: CreateDefaultVpcCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDefaultVpcCommandOutput) => void ): void; - public createDefaultVpc( - args: CreateDefaultVpcCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDefaultVpcCommandOutput) => void), - cb?: (err: any, data?: CreateDefaultVpcCommandOutput) => void - ): Promise | void { - const command = new CreateDefaultVpcCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a set of DHCP options for your VPC. After creating the set, you must - * associate it with the VPC, causing all existing and new instances that you launch in - * the VPC to use this set of DHCP options. The following are the individual DHCP - * options you can specify. For more information about the options, see RFC 2132.

- *
    - *
  • - *

    - * domain-name-servers - The IP addresses of up to four domain name - * servers, or AmazonProvidedDNS. The default DHCP option set specifies - * AmazonProvidedDNS. If specifying more than one domain name server, specify the - * IP addresses in a single parameter, separated by commas. To have your instance - * receive a custom DNS hostname as specified in domain-name, you must - * set domain-name-servers to a custom DNS server.

    - *
  • - *
  • - *

    - * domain-name - If you're using AmazonProvidedDNS in - * us-east-1, specify ec2.internal. If you're using - * AmazonProvidedDNS in another Region, specify - * region.compute.internal (for example, - * ap-northeast-1.compute.internal). Otherwise, specify a domain - * name (for example, ExampleCompany.com). This value is used to complete - * unqualified DNS hostnames. Important: Some - * Linux operating systems accept multiple domain names separated by spaces. - * However, Windows and other Linux operating systems treat the value as a single - * domain, which results in unexpected behavior. If your DHCP options set is - * associated with a VPC that has instances with multiple operating systems, - * specify only one domain name.

    - *
  • - *
  • - *

    - * ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) - * servers.

    - *
  • - *
  • - *

    - * netbios-name-servers - The IP addresses of up to four NetBIOS name - * servers.

    - *
  • - *
  • - *

    - * netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that - * you specify 2 (broadcast and multicast are not currently supported). For more information - * about these node types, see RFC 2132.

    - *
  • - *
- *

Your VPC automatically starts out with a set of DHCP options that includes only a DNS - * server that we provide (AmazonProvidedDNS). If you create a set of options, and if your - * VPC has an internet gateway, make sure to set the domain-name-servers - * option either to AmazonProvidedDNS or to a domain name server of your - * choice. For more information, see DHCP options sets in the - * Amazon Virtual Private Cloud User Guide.

- */ - public createDhcpOptions( + + /** + * @see {@link CreateDhcpOptionsCommand} + */ + createDhcpOptions( args: CreateDhcpOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDhcpOptions( + createDhcpOptions( args: CreateDhcpOptionsCommandInput, cb: (err: any, data?: CreateDhcpOptionsCommandOutput) => void ): void; - public createDhcpOptions( + createDhcpOptions( args: CreateDhcpOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDhcpOptionsCommandOutput) => void ): void; - public createDhcpOptions( - args: CreateDhcpOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDhcpOptionsCommandOutput) => void), - cb?: (err: any, data?: CreateDhcpOptionsCommandOutput) => void - ): Promise | void { - const command = new CreateDhcpOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

[IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only - * internet gateway is used to enable outbound communication over IPv6 from instances in - * your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 - * connection with your instance.

- */ - public createEgressOnlyInternetGateway( + + /** + * @see {@link CreateEgressOnlyInternetGatewayCommand} + */ + createEgressOnlyInternetGateway( args: CreateEgressOnlyInternetGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEgressOnlyInternetGateway( + createEgressOnlyInternetGateway( args: CreateEgressOnlyInternetGatewayCommandInput, cb: (err: any, data?: CreateEgressOnlyInternetGatewayCommandOutput) => void ): void; - public createEgressOnlyInternetGateway( + createEgressOnlyInternetGateway( args: CreateEgressOnlyInternetGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEgressOnlyInternetGatewayCommandOutput) => void ): void; - public createEgressOnlyInternetGateway( - args: CreateEgressOnlyInternetGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEgressOnlyInternetGatewayCommandOutput) => void), - cb?: (err: any, data?: CreateEgressOnlyInternetGatewayCommandOutput) => void - ): Promise | void { - const command = new CreateEgressOnlyInternetGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Launches an EC2 Fleet.

- *

You can create a single EC2 Fleet that includes multiple launch specifications that vary by - * instance type, AMI, Availability Zone, or subnet.

- *

For more information, see EC2 Fleet in the Amazon EC2 User Guide.

- */ - public createFleet(args: CreateFleetCommandInput, options?: __HttpHandlerOptions): Promise; - public createFleet(args: CreateFleetCommandInput, cb: (err: any, data?: CreateFleetCommandOutput) => void): void; - public createFleet( + + /** + * @see {@link CreateFleetCommand} + */ + createFleet(args: CreateFleetCommandInput, options?: __HttpHandlerOptions): Promise; + createFleet(args: CreateFleetCommandInput, cb: (err: any, data?: CreateFleetCommandOutput) => void): void; + createFleet( args: CreateFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFleetCommandOutput) => void ): void; - public createFleet( - args: CreateFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFleetCommandOutput) => void), - cb?: (err: any, data?: CreateFleetCommandOutput) => void - ): Promise | void { - const command = new CreateFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates one or more flow logs to capture information about IP traffic for a specific network interface, - * subnet, or VPC.

- *

Flow log data for a monitored network interface is recorded as flow log records, which are log events - * consisting of fields that describe the traffic flow. For more information, see - * Flow log records - * in the Amazon Virtual Private Cloud User Guide.

- *

When publishing to CloudWatch Logs, flow log records are published to a log group, and each network - * interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all - * of the monitored network interfaces are published to a single log file object that is stored in the specified - * bucket.

- *

For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.

- */ - public createFlowLogs( + + /** + * @see {@link CreateFlowLogsCommand} + */ + createFlowLogs( args: CreateFlowLogsCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFlowLogs( - args: CreateFlowLogsCommandInput, - cb: (err: any, data?: CreateFlowLogsCommandOutput) => void - ): void; - public createFlowLogs( + createFlowLogs(args: CreateFlowLogsCommandInput, cb: (err: any, data?: CreateFlowLogsCommandOutput) => void): void; + createFlowLogs( args: CreateFlowLogsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFlowLogsCommandOutput) => void ): void; - public createFlowLogs( - args: CreateFlowLogsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFlowLogsCommandOutput) => void), - cb?: (err: any, data?: CreateFlowLogsCommandOutput) => void - ): Promise | void { - const command = new CreateFlowLogsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).

- *

The create operation is asynchronous. To verify that the AFI is ready for use, - * check the output logs.

- *

An AFI contains the FPGA bitstream that is ready to download to an FPGA. - * You can securely deploy an AFI on multiple FPGA-accelerated instances. - * For more information, see the Amazon Web Services FPGA Hardware Development Kit.

- */ - public createFpgaImage( + + /** + * @see {@link CreateFpgaImageCommand} + */ + createFpgaImage( args: CreateFpgaImageCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFpgaImage( - args: CreateFpgaImageCommandInput, - cb: (err: any, data?: CreateFpgaImageCommandOutput) => void - ): void; - public createFpgaImage( + createFpgaImage(args: CreateFpgaImageCommandInput, cb: (err: any, data?: CreateFpgaImageCommandOutput) => void): void; + createFpgaImage( args: CreateFpgaImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFpgaImageCommandOutput) => void ): void; - public createFpgaImage( - args: CreateFpgaImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFpgaImageCommandOutput) => void), - cb?: (err: any, data?: CreateFpgaImageCommandOutput) => void - ): Promise | void { - const command = new CreateFpgaImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance - * that is either running or stopped.

- *

By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can - * take snapshots of the attached volumes while data is at rest, in order to ensure a consistent - * state. You can set the NoReboot parameter to true in the API request, - * or use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and - * rebooting the instance.

- * - *

If you choose to bypass the shutdown and reboot process by setting the NoReboot - * parameter to true in the API request, or by using the --no-reboot option - * in the CLI, we can't guarantee the file system integrity of the created image.

- *
- *

If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the - * new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, - * the instance automatically launches with those additional volumes.

- *

For more information, see Create an Amazon EBS-backed Linux - * AMI in the Amazon Elastic Compute Cloud User Guide.

- */ - public createImage(args: CreateImageCommandInput, options?: __HttpHandlerOptions): Promise; - public createImage(args: CreateImageCommandInput, cb: (err: any, data?: CreateImageCommandOutput) => void): void; - public createImage( + + /** + * @see {@link CreateImageCommand} + */ + createImage(args: CreateImageCommandInput, options?: __HttpHandlerOptions): Promise; + createImage(args: CreateImageCommandInput, cb: (err: any, data?: CreateImageCommandOutput) => void): void; + createImage( args: CreateImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateImageCommandOutput) => void ): void; - public createImage( - args: CreateImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateImageCommandOutput) => void), - cb?: (err: any, data?: CreateImageCommandOutput) => void - ): Promise | void { - const command = new CreateImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an event window in which scheduled events for the associated Amazon EC2 instances can - * run.

- *

You can define either a set of time ranges or a cron expression when creating the event - * window, but not both. All event window times are in UTC.

- *

You can create up to 200 event windows per Amazon Web Services Region.

- *

When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags) - * are not yet associated with it. To ensure that the event window can be used, you must - * associate one or more targets with it by using the AssociateInstanceEventWindow API.

- * - *

Event windows are applicable only for scheduled events that stop, reboot, or - * terminate instances.

- *

Event windows are not applicable for:

- *
    - *
  • - *

    Expedited scheduled events and network maintenance events.

    - *
  • - *
  • - *

    Unscheduled maintenance such as AutoRecovery and unplanned reboots.

    - *
  • - *
- *
- *

For more information, see Define event windows for scheduled - * events in the Amazon EC2 User Guide.

- */ - public createInstanceEventWindow( + + /** + * @see {@link CreateInstanceEventWindowCommand} + */ + createInstanceEventWindow( args: CreateInstanceEventWindowCommandInput, options?: __HttpHandlerOptions ): Promise; - public createInstanceEventWindow( + createInstanceEventWindow( args: CreateInstanceEventWindowCommandInput, cb: (err: any, data?: CreateInstanceEventWindowCommandOutput) => void ): void; - public createInstanceEventWindow( + createInstanceEventWindow( args: CreateInstanceEventWindowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInstanceEventWindowCommandOutput) => void ): void; - public createInstanceEventWindow( - args: CreateInstanceEventWindowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateInstanceEventWindowCommandOutput) => void), - cb?: (err: any, data?: CreateInstanceEventWindowCommandOutput) => void - ): Promise | void { - const command = new CreateInstanceEventWindowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Exports a running or stopped instance to an Amazon S3 bucket.

- *

For information about the supported operating systems, image formats, and known limitations - * for the types of instances you can export, see Exporting an instance as a VM Using VM Import/Export - * in the VM Import/Export User Guide.

- */ - public createInstanceExportTask( + + /** + * @see {@link CreateInstanceExportTaskCommand} + */ + createInstanceExportTask( args: CreateInstanceExportTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public createInstanceExportTask( + createInstanceExportTask( args: CreateInstanceExportTaskCommandInput, cb: (err: any, data?: CreateInstanceExportTaskCommandOutput) => void ): void; - public createInstanceExportTask( + createInstanceExportTask( args: CreateInstanceExportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInstanceExportTaskCommandOutput) => void ): void; - public createInstanceExportTask( - args: CreateInstanceExportTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateInstanceExportTaskCommandOutput) => void), - cb?: (err: any, data?: CreateInstanceExportTaskCommandOutput) => void - ): Promise | void { - const command = new CreateInstanceExportTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an internet gateway for use with a VPC. After creating the internet gateway, - * you attach it to a VPC using AttachInternetGateway.

- *

For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.

- */ - public createInternetGateway( + + /** + * @see {@link CreateInternetGatewayCommand} + */ + createInternetGateway( args: CreateInternetGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public createInternetGateway( + createInternetGateway( args: CreateInternetGatewayCommandInput, cb: (err: any, data?: CreateInternetGatewayCommandOutput) => void ): void; - public createInternetGateway( + createInternetGateway( args: CreateInternetGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInternetGatewayCommandOutput) => void ): void; - public createInternetGateway( - args: CreateInternetGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateInternetGatewayCommandOutput) => void), - cb?: (err: any, data?: CreateInternetGatewayCommandOutput) => void - ): Promise | void { - const command = new CreateInternetGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use - * to automate your IP address management workflows including assigning, tracking, - * troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts - * throughout your Amazon Web Services Organization.

- *

For more information, see Create an IPAM in the Amazon VPC IPAM User Guide. - *

- */ - public createIpam(args: CreateIpamCommandInput, options?: __HttpHandlerOptions): Promise; - public createIpam(args: CreateIpamCommandInput, cb: (err: any, data?: CreateIpamCommandOutput) => void): void; - public createIpam( + + /** + * @see {@link CreateIpamCommand} + */ + createIpam(args: CreateIpamCommandInput, options?: __HttpHandlerOptions): Promise; + createIpam(args: CreateIpamCommandInput, cb: (err: any, data?: CreateIpamCommandOutput) => void): void; + createIpam( args: CreateIpamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIpamCommandOutput) => void ): void; - public createIpam( - args: CreateIpamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIpamCommandOutput) => void), - cb?: (err: any, data?: CreateIpamCommandOutput) => void - ): Promise | void { - const command = new CreateIpamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.

- *

For more information, see Create a top-level pool in the Amazon VPC IPAM User Guide. - *

- */ - public createIpamPool( + + /** + * @see {@link CreateIpamPoolCommand} + */ + createIpamPool( args: CreateIpamPoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public createIpamPool( - args: CreateIpamPoolCommandInput, - cb: (err: any, data?: CreateIpamPoolCommandOutput) => void - ): void; - public createIpamPool( + createIpamPool(args: CreateIpamPoolCommandInput, cb: (err: any, data?: CreateIpamPoolCommandOutput) => void): void; + createIpamPool( args: CreateIpamPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIpamPoolCommandOutput) => void ): void; - public createIpamPool( - args: CreateIpamPoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIpamPoolCommandOutput) => void), - cb?: (err: any, data?: CreateIpamPoolCommandOutput) => void - ): Promise | void { - const command = new CreateIpamPoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

- */ - public createIpamResourceDiscovery( + + /** + * @see {@link CreateIpamResourceDiscoveryCommand} + */ + createIpamResourceDiscovery( args: CreateIpamResourceDiscoveryCommandInput, options?: __HttpHandlerOptions ): Promise; - public createIpamResourceDiscovery( + createIpamResourceDiscovery( args: CreateIpamResourceDiscoveryCommandInput, cb: (err: any, data?: CreateIpamResourceDiscoveryCommandOutput) => void ): void; - public createIpamResourceDiscovery( + createIpamResourceDiscovery( args: CreateIpamResourceDiscoveryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIpamResourceDiscoveryCommandOutput) => void ): void; - public createIpamResourceDiscovery( - args: CreateIpamResourceDiscoveryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIpamResourceDiscoveryCommandOutput) => void), - cb?: (err: any, data?: CreateIpamResourceDiscoveryCommandOutput) => void - ): Promise | void { - const command = new CreateIpamResourceDiscoveryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

- *

For more information, see Add a scope in the Amazon VPC IPAM User Guide.

- */ - public createIpamScope( + + /** + * @see {@link CreateIpamScopeCommand} + */ + createIpamScope( args: CreateIpamScopeCommandInput, options?: __HttpHandlerOptions ): Promise; - public createIpamScope( - args: CreateIpamScopeCommandInput, - cb: (err: any, data?: CreateIpamScopeCommandOutput) => void - ): void; - public createIpamScope( + createIpamScope(args: CreateIpamScopeCommandInput, cb: (err: any, data?: CreateIpamScopeCommandOutput) => void): void; + createIpamScope( args: CreateIpamScopeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIpamScopeCommandOutput) => void ): void; - public createIpamScope( - args: CreateIpamScopeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIpamScopeCommandOutput) => void), - cb?: (err: any, data?: CreateIpamScopeCommandOutput) => void - ): Promise | void { - const command = new CreateIpamScopeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the - * specified PEM or PPK format. Amazon EC2 stores the public key and displays the private - * key for you to save to a file. The private key is returned as an unencrypted PEM encoded - * PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a - * key with the specified name already exists, Amazon EC2 returns an error.

- *

The key pair returned to you is available only in the Amazon Web Services Region in which you create it. - * If you prefer, you can create your own key pair using a third-party tool and upload it - * to any Region using ImportKeyPair.

- *

You can have up to 5,000 key pairs per Amazon Web Services Region.

- *

For more information, see Amazon EC2 key pairs in the - * Amazon Elastic Compute Cloud User Guide.

- */ - public createKeyPair( - args: CreateKeyPairCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createKeyPair( - args: CreateKeyPairCommandInput, - cb: (err: any, data?: CreateKeyPairCommandOutput) => void - ): void; - public createKeyPair( + + /** + * @see {@link CreateKeyPairCommand} + */ + createKeyPair(args: CreateKeyPairCommandInput, options?: __HttpHandlerOptions): Promise; + createKeyPair(args: CreateKeyPairCommandInput, cb: (err: any, data?: CreateKeyPairCommandOutput) => void): void; + createKeyPair( args: CreateKeyPairCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateKeyPairCommandOutput) => void ): void; - public createKeyPair( - args: CreateKeyPairCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateKeyPairCommandOutput) => void), - cb?: (err: any, data?: CreateKeyPairCommandOutput) => void - ): Promise | void { - const command = new CreateKeyPairCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a launch template.

- *

A launch template contains the parameters to launch an instance. When you launch an - * instance using RunInstances, you can specify a launch template instead - * of providing the launch parameters in the request. For more information, see Launch - * an instance from a launch template in the - * Amazon Elastic Compute Cloud User Guide.

- *

If you want to clone an existing launch template as the basis for creating a new - * launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support - * cloning a template. For more information, see Create a launch template from an existing launch template in the - * Amazon Elastic Compute Cloud User Guide.

- */ - public createLaunchTemplate( + + /** + * @see {@link CreateLaunchTemplateCommand} + */ + createLaunchTemplate( args: CreateLaunchTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLaunchTemplate( + createLaunchTemplate( args: CreateLaunchTemplateCommandInput, cb: (err: any, data?: CreateLaunchTemplateCommandOutput) => void ): void; - public createLaunchTemplate( + createLaunchTemplate( args: CreateLaunchTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLaunchTemplateCommandOutput) => void ): void; - public createLaunchTemplate( - args: CreateLaunchTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLaunchTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateLaunchTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateLaunchTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new version of a launch template. You can specify an existing version of - * launch template from which to base the new version.

- *

Launch template versions are numbered in the order in which they are created. You - * cannot specify, change, or replace the numbering of launch template versions.

- *

Launch templates are immutable; after you create a launch template, you can't modify - * it. Instead, you can create a new version of the launch template that includes any - * changes you require.

- *

For more information, see Modify a launch template (manage launch template versions) in the - * Amazon Elastic Compute Cloud User Guide.

- */ - public createLaunchTemplateVersion( + + /** + * @see {@link CreateLaunchTemplateVersionCommand} + */ + createLaunchTemplateVersion( args: CreateLaunchTemplateVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLaunchTemplateVersion( + createLaunchTemplateVersion( args: CreateLaunchTemplateVersionCommandInput, cb: (err: any, data?: CreateLaunchTemplateVersionCommandOutput) => void ): void; - public createLaunchTemplateVersion( + createLaunchTemplateVersion( args: CreateLaunchTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLaunchTemplateVersionCommandOutput) => void ): void; - public createLaunchTemplateVersion( - args: CreateLaunchTemplateVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLaunchTemplateVersionCommandOutput) => void), - cb?: (err: any, data?: CreateLaunchTemplateVersionCommandOutput) => void - ): Promise | void { - const command = new CreateLaunchTemplateVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a static route for the specified local gateway route table. You must specify one of the - * following targets:

- *
    - *
  • - *

    - * LocalGatewayVirtualInterfaceGroupId - *

    - *
  • - *
  • - *

    - * NetworkInterfaceId - *

    - *
  • - *
- */ - public createLocalGatewayRoute( + + /** + * @see {@link CreateLocalGatewayRouteCommand} + */ + createLocalGatewayRoute( args: CreateLocalGatewayRouteCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLocalGatewayRoute( + createLocalGatewayRoute( args: CreateLocalGatewayRouteCommandInput, cb: (err: any, data?: CreateLocalGatewayRouteCommandOutput) => void ): void; - public createLocalGatewayRoute( + createLocalGatewayRoute( args: CreateLocalGatewayRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocalGatewayRouteCommandOutput) => void ): void; - public createLocalGatewayRoute( - args: CreateLocalGatewayRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLocalGatewayRouteCommandOutput) => void), - cb?: (err: any, data?: CreateLocalGatewayRouteCommandOutput) => void - ): Promise | void { - const command = new CreateLocalGatewayRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Creates a local gateway route table. - *

- */ - public createLocalGatewayRouteTable( + + /** + * @see {@link CreateLocalGatewayRouteTableCommand} + */ + createLocalGatewayRouteTable( args: CreateLocalGatewayRouteTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLocalGatewayRouteTable( + createLocalGatewayRouteTable( args: CreateLocalGatewayRouteTableCommandInput, cb: (err: any, data?: CreateLocalGatewayRouteTableCommandOutput) => void ): void; - public createLocalGatewayRouteTable( + createLocalGatewayRouteTable( args: CreateLocalGatewayRouteTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocalGatewayRouteTableCommandOutput) => void ): void; - public createLocalGatewayRouteTable( - args: CreateLocalGatewayRouteTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLocalGatewayRouteTableCommandOutput) => void), - cb?: (err: any, data?: CreateLocalGatewayRouteTableCommandOutput) => void - ): Promise | void { - const command = new CreateLocalGatewayRouteTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Creates a local gateway route table virtual interface group association. - *

- */ - public createLocalGatewayRouteTableVirtualInterfaceGroupAssociation( + + /** + * @see {@link CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationCommand} + */ + createLocalGatewayRouteTableVirtualInterfaceGroupAssociation( args: CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLocalGatewayRouteTableVirtualInterfaceGroupAssociation( + createLocalGatewayRouteTableVirtualInterfaceGroupAssociation( args: CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationCommandInput, cb: (err: any, data?: CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationCommandOutput) => void ): void; - public createLocalGatewayRouteTableVirtualInterfaceGroupAssociation( + createLocalGatewayRouteTableVirtualInterfaceGroupAssociation( args: CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationCommandOutput) => void ): void; - public createLocalGatewayRouteTableVirtualInterfaceGroupAssociation( - args: CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationCommandOutput) => void), - cb?: (err: any, data?: CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationCommandOutput) => void - ): Promise | void { - const command = new CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates the specified VPC with the specified local gateway route table.

- */ - public createLocalGatewayRouteTableVpcAssociation( + + /** + * @see {@link CreateLocalGatewayRouteTableVpcAssociationCommand} + */ + createLocalGatewayRouteTableVpcAssociation( args: CreateLocalGatewayRouteTableVpcAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLocalGatewayRouteTableVpcAssociation( + createLocalGatewayRouteTableVpcAssociation( args: CreateLocalGatewayRouteTableVpcAssociationCommandInput, cb: (err: any, data?: CreateLocalGatewayRouteTableVpcAssociationCommandOutput) => void ): void; - public createLocalGatewayRouteTableVpcAssociation( + createLocalGatewayRouteTableVpcAssociation( args: CreateLocalGatewayRouteTableVpcAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocalGatewayRouteTableVpcAssociationCommandOutput) => void ): void; - public createLocalGatewayRouteTableVpcAssociation( - args: CreateLocalGatewayRouteTableVpcAssociationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateLocalGatewayRouteTableVpcAssociationCommandOutput) => void), - cb?: (err: any, data?: CreateLocalGatewayRouteTableVpcAssociationCommandOutput) => void - ): Promise | void { - const command = new CreateLocalGatewayRouteTableVpcAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a managed prefix list. You can specify one or more entries for the prefix list. - * Each entry consists of a CIDR block and an optional description.

- */ - public createManagedPrefixList( + + /** + * @see {@link CreateManagedPrefixListCommand} + */ + createManagedPrefixList( args: CreateManagedPrefixListCommandInput, options?: __HttpHandlerOptions ): Promise; - public createManagedPrefixList( + createManagedPrefixList( args: CreateManagedPrefixListCommandInput, cb: (err: any, data?: CreateManagedPrefixListCommandOutput) => void ): void; - public createManagedPrefixList( + createManagedPrefixList( args: CreateManagedPrefixListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateManagedPrefixListCommandOutput) => void ): void; - public createManagedPrefixList( - args: CreateManagedPrefixListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateManagedPrefixListCommandOutput) => void), - cb?: (err: any, data?: CreateManagedPrefixListCommandOutput) => void - ): Promise | void { - const command = new CreateManagedPrefixListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a NAT gateway in the specified subnet. This action creates a network interface - * in the specified subnet with a private IP address from the IP address range of the - * subnet. You can create either a public NAT gateway or a private NAT gateway.

- *

With a public NAT gateway, internet-bound traffic from a private subnet can be routed - * to the NAT gateway, so that instances in a private subnet can connect to the internet.

- *

With a private NAT gateway, private communication is routed across VPCs and on-premises - * networks through a transit gateway or virtual private gateway. Common use cases include - * running large workloads behind a small pool of allowlisted IPv4 addresses, preserving - * private IPv4 addresses, and communicating between overlapping networks.

- *

For more information, see NAT gateways in the Amazon Virtual Private Cloud User Guide.

- */ - public createNatGateway( + + /** + * @see {@link CreateNatGatewayCommand} + */ + createNatGateway( args: CreateNatGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNatGateway( + createNatGateway( args: CreateNatGatewayCommandInput, cb: (err: any, data?: CreateNatGatewayCommandOutput) => void ): void; - public createNatGateway( + createNatGateway( args: CreateNatGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNatGatewayCommandOutput) => void ): void; - public createNatGateway( - args: CreateNatGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNatGatewayCommandOutput) => void), - cb?: (err: any, data?: CreateNatGatewayCommandOutput) => void - ): Promise | void { - const command = new CreateNatGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

- *

For more information, see Network ACLs in the - * Amazon Virtual Private Cloud User Guide.

- */ - public createNetworkAcl( + + /** + * @see {@link CreateNetworkAclCommand} + */ + createNetworkAcl( args: CreateNetworkAclCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNetworkAcl( + createNetworkAcl( args: CreateNetworkAclCommandInput, cb: (err: any, data?: CreateNetworkAclCommandOutput) => void ): void; - public createNetworkAcl( + createNetworkAcl( args: CreateNetworkAclCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNetworkAclCommandOutput) => void ): void; - public createNetworkAcl( - args: CreateNetworkAclCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNetworkAclCommandOutput) => void), - cb?: (err: any, data?: CreateNetworkAclCommandOutput) => void - ): Promise | void { - const command = new CreateNetworkAclCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules - * and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated - * with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of - * ingress rules and a separate set of egress rules.

- *

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the - * other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

- *

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

- *

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

- */ - public createNetworkAclEntry( + + /** + * @see {@link CreateNetworkAclEntryCommand} + */ + createNetworkAclEntry( args: CreateNetworkAclEntryCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNetworkAclEntry( + createNetworkAclEntry( args: CreateNetworkAclEntryCommandInput, cb: (err: any, data?: CreateNetworkAclEntryCommandOutput) => void ): void; - public createNetworkAclEntry( + createNetworkAclEntry( args: CreateNetworkAclEntryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNetworkAclEntryCommandOutput) => void ): void; - public createNetworkAclEntry( - args: CreateNetworkAclEntryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNetworkAclEntryCommandOutput) => void), - cb?: (err: any, data?: CreateNetworkAclEntryCommandOutput) => void - ): Promise | void { - const command = new CreateNetworkAclEntryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Network Access Scope.

- *

Amazon Web Services Network Access Analyzer enables cloud networking and cloud operations teams - * to verify that their networks on Amazon Web Services conform to their network security and governance - * objectives. For more information, see the Amazon Web Services Network Access Analyzer Guide.

- */ - public createNetworkInsightsAccessScope( + + /** + * @see {@link CreateNetworkInsightsAccessScopeCommand} + */ + createNetworkInsightsAccessScope( args: CreateNetworkInsightsAccessScopeCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNetworkInsightsAccessScope( + createNetworkInsightsAccessScope( args: CreateNetworkInsightsAccessScopeCommandInput, cb: (err: any, data?: CreateNetworkInsightsAccessScopeCommandOutput) => void ): void; - public createNetworkInsightsAccessScope( + createNetworkInsightsAccessScope( args: CreateNetworkInsightsAccessScopeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNetworkInsightsAccessScopeCommandOutput) => void ): void; - public createNetworkInsightsAccessScope( - args: CreateNetworkInsightsAccessScopeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNetworkInsightsAccessScopeCommandOutput) => void), - cb?: (err: any, data?: CreateNetworkInsightsAccessScopeCommandOutput) => void - ): Promise | void { - const command = new CreateNetworkInsightsAccessScopeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a path to analyze for reachability.

- *

Reachability Analyzer enables you to analyze and debug network reachability between - * two resources in your virtual private cloud (VPC). For more information, see the - * Reachability Analyzer Guide.

- */ - public createNetworkInsightsPath( + + /** + * @see {@link CreateNetworkInsightsPathCommand} + */ + createNetworkInsightsPath( args: CreateNetworkInsightsPathCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNetworkInsightsPath( + createNetworkInsightsPath( args: CreateNetworkInsightsPathCommandInput, cb: (err: any, data?: CreateNetworkInsightsPathCommandOutput) => void ): void; - public createNetworkInsightsPath( + createNetworkInsightsPath( args: CreateNetworkInsightsPathCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNetworkInsightsPathCommandOutput) => void ): void; - public createNetworkInsightsPath( - args: CreateNetworkInsightsPathCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNetworkInsightsPathCommandOutput) => void), - cb?: (err: any, data?: CreateNetworkInsightsPathCommandOutput) => void - ): Promise | void { - const command = new CreateNetworkInsightsPathCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a network interface in the specified subnet.

- *

The number of IP addresses you can assign to a network interface varies by instance - * type. For more information, see IP Addresses Per ENI Per - * Instance Type in the Amazon Virtual Private Cloud User Guide.

- *

For more information about network interfaces, see Elastic network interfaces - * in the Amazon Elastic Compute Cloud User Guide.

- */ - public createNetworkInterface( + + /** + * @see {@link CreateNetworkInterfaceCommand} + */ + createNetworkInterface( args: CreateNetworkInterfaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNetworkInterface( + createNetworkInterface( args: CreateNetworkInterfaceCommandInput, cb: (err: any, data?: CreateNetworkInterfaceCommandOutput) => void ): void; - public createNetworkInterface( + createNetworkInterface( args: CreateNetworkInterfaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNetworkInterfaceCommandOutput) => void ): void; - public createNetworkInterface( - args: CreateNetworkInterfaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNetworkInterfaceCommandOutput) => void), - cb?: (err: any, data?: CreateNetworkInterfaceCommandOutput) => void - ): Promise | void { - const command = new CreateNetworkInterfaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Grants an Amazon Web Services-authorized account permission to attach the specified network interface to - * an instance in their account.

- *

You can grant permission to a single Amazon Web Services account only, and only one account at a time.

- */ - public createNetworkInterfacePermission( + + /** + * @see {@link CreateNetworkInterfacePermissionCommand} + */ + createNetworkInterfacePermission( args: CreateNetworkInterfacePermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNetworkInterfacePermission( + createNetworkInterfacePermission( args: CreateNetworkInterfacePermissionCommandInput, cb: (err: any, data?: CreateNetworkInterfacePermissionCommandOutput) => void ): void; - public createNetworkInterfacePermission( + createNetworkInterfacePermission( args: CreateNetworkInterfacePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNetworkInterfacePermissionCommandOutput) => void ): void; - public createNetworkInterfacePermission( - args: CreateNetworkInterfacePermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNetworkInterfacePermissionCommandOutput) => void), - cb?: (err: any, data?: CreateNetworkInterfacePermissionCommandOutput) => void - ): Promise | void { - const command = new CreateNetworkInterfacePermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a placement group in which to launch instances. The strategy of the placement - * group determines how the instances are organized within the group.

- *

A cluster placement group is a logical grouping of instances within a - * single Availability Zone that benefit from low network latency, high network throughput. - * A spread placement group places instances on distinct hardware. A - * partition placement group places groups of instances in different - * partitions, where instances in one partition do not share the same hardware with - * instances in another partition.

- *

For more information, see Placement groups in the - * Amazon EC2 User Guide.

- */ - public createPlacementGroup( + + /** + * @see {@link CreatePlacementGroupCommand} + */ + createPlacementGroup( args: CreatePlacementGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPlacementGroup( + createPlacementGroup( args: CreatePlacementGroupCommandInput, cb: (err: any, data?: CreatePlacementGroupCommandOutput) => void ): void; - public createPlacementGroup( + createPlacementGroup( args: CreatePlacementGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePlacementGroupCommandOutput) => void ): void; - public createPlacementGroup( - args: CreatePlacementGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePlacementGroupCommandOutput) => void), - cb?: (err: any, data?: CreatePlacementGroupCommandOutput) => void - ): Promise | void { - const command = new CreatePlacementGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. To monitor the status of pool creation, use DescribePublicIpv4Pools.

- */ - public createPublicIpv4Pool( + + /** + * @see {@link CreatePublicIpv4PoolCommand} + */ + createPublicIpv4Pool( args: CreatePublicIpv4PoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPublicIpv4Pool( + createPublicIpv4Pool( args: CreatePublicIpv4PoolCommandInput, cb: (err: any, data?: CreatePublicIpv4PoolCommandOutput) => void ): void; - public createPublicIpv4Pool( + createPublicIpv4Pool( args: CreatePublicIpv4PoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePublicIpv4PoolCommandOutput) => void ): void; - public createPublicIpv4Pool( - args: CreatePublicIpv4PoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePublicIpv4PoolCommandOutput) => void), - cb?: (err: any, data?: CreatePublicIpv4PoolCommandOutput) => void - ): Promise | void { - const command = new CreatePublicIpv4PoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Replaces the EBS-backed root volume for a running instance with a new - * volume that is restored to the original root volume's launch state, that is restored to a - * specific snapshot taken from the original root volume, or that is restored from an AMI - * that has the same key characteristics as that of the instance.

- *

For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.

- */ - public createReplaceRootVolumeTask( + + /** + * @see {@link CreateReplaceRootVolumeTaskCommand} + */ + createReplaceRootVolumeTask( args: CreateReplaceRootVolumeTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public createReplaceRootVolumeTask( + createReplaceRootVolumeTask( args: CreateReplaceRootVolumeTaskCommandInput, cb: (err: any, data?: CreateReplaceRootVolumeTaskCommandOutput) => void ): void; - public createReplaceRootVolumeTask( + createReplaceRootVolumeTask( args: CreateReplaceRootVolumeTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReplaceRootVolumeTaskCommandOutput) => void ): void; - public createReplaceRootVolumeTask( - args: CreateReplaceRootVolumeTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateReplaceRootVolumeTaskCommandOutput) => void), - cb?: (err: any, data?: CreateReplaceRootVolumeTaskCommandOutput) => void - ): Promise | void { - const command = new CreateReplaceRootVolumeTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance - * Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your - * Standard Reserved Instances, you can use the DescribeReservedInstances operation.

- * - *

Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. - * Convertible Reserved Instances cannot be sold.

- *
- *

The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

- *

To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance - * Marketplace. After completing the registration process, you can create a Reserved Instance - * Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price - * to receive for them. Your Standard Reserved Instance listings then become available for purchase. To - * view the details of your Standard Reserved Instance listing, you can use the - * DescribeReservedInstancesListings operation.

- *

For more information, see Reserved Instance Marketplace in the - * Amazon EC2 User Guide.

- */ - public createReservedInstancesListing( + + /** + * @see {@link CreateReservedInstancesListingCommand} + */ + createReservedInstancesListing( args: CreateReservedInstancesListingCommandInput, options?: __HttpHandlerOptions ): Promise; - public createReservedInstancesListing( + createReservedInstancesListing( args: CreateReservedInstancesListingCommandInput, cb: (err: any, data?: CreateReservedInstancesListingCommandOutput) => void ): void; - public createReservedInstancesListing( + createReservedInstancesListing( args: CreateReservedInstancesListingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReservedInstancesListingCommandOutput) => void ): void; - public createReservedInstancesListing( - args: CreateReservedInstancesListingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateReservedInstancesListingCommandOutput) => void), - cb?: (err: any, data?: CreateReservedInstancesListingCommandOutput) => void - ): Promise | void { - const command = new CreateReservedInstancesListingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a task that restores an AMI from an Amazon S3 object that was previously created by using - * CreateStoreImageTask.

- *

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the - * Amazon EC2 User Guide.

- *

For more information, see Store and restore an AMI using - * Amazon S3 in the Amazon EC2 User Guide.

- */ - public createRestoreImageTask( + + /** + * @see {@link CreateRestoreImageTaskCommand} + */ + createRestoreImageTask( args: CreateRestoreImageTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRestoreImageTask( + createRestoreImageTask( args: CreateRestoreImageTaskCommandInput, cb: (err: any, data?: CreateRestoreImageTaskCommandOutput) => void ): void; - public createRestoreImageTask( + createRestoreImageTask( args: CreateRestoreImageTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRestoreImageTaskCommandOutput) => void ): void; - public createRestoreImageTask( - args: CreateRestoreImageTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRestoreImageTaskCommandOutput) => void), - cb?: (err: any, data?: CreateRestoreImageTaskCommandOutput) => void - ): Promise | void { - const command = new CreateRestoreImageTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a route in a route table within a VPC.

- *

You must specify either a destination CIDR block or a prefix list ID. You must also specify - * exactly one of the resources from the parameter list.

- *

When determining how to route traffic, we use the route with the most specific match. - * For example, traffic is destined for the IPv4 address 192.0.2.3, and the - * route table includes the following two IPv4 routes:

- *
    - *
  • - *

    - * 192.0.2.0/24 (goes to some target A)

    - *
  • - *
  • - *

    - * 192.0.2.0/28 (goes to some target B)

    - *
  • - *
- *

Both routes apply to the traffic destined for 192.0.2.3. However, the second route - * in the list covers a smaller number of IP addresses and is therefore more specific, - * so we use that route to determine where to target the traffic.

- *

For more information about route tables, see Route tables in the - * Amazon Virtual Private Cloud User Guide.

- */ - public createRoute(args: CreateRouteCommandInput, options?: __HttpHandlerOptions): Promise; - public createRoute(args: CreateRouteCommandInput, cb: (err: any, data?: CreateRouteCommandOutput) => void): void; - public createRoute( + + /** + * @see {@link CreateRouteCommand} + */ + createRoute(args: CreateRouteCommandInput, options?: __HttpHandlerOptions): Promise; + createRoute(args: CreateRouteCommandInput, cb: (err: any, data?: CreateRouteCommandOutput) => void): void; + createRoute( args: CreateRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRouteCommandOutput) => void ): void; - public createRoute( - args: CreateRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRouteCommandOutput) => void), - cb?: (err: any, data?: CreateRouteCommandOutput) => void - ): Promise | void { - const command = new CreateRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.

- *

For more information, see Route tables in the - * Amazon Virtual Private Cloud User Guide.

- */ - public createRouteTable( + + /** + * @see {@link CreateRouteTableCommand} + */ + createRouteTable( args: CreateRouteTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRouteTable( + createRouteTable( args: CreateRouteTableCommandInput, cb: (err: any, data?: CreateRouteTableCommandOutput) => void ): void; - public createRouteTable( + createRouteTable( args: CreateRouteTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRouteTableCommandOutput) => void ): void; - public createRouteTable( - args: CreateRouteTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRouteTableCommandOutput) => void), - cb?: (err: any, data?: CreateRouteTableCommandOutput) => void - ): Promise | void { - const command = new CreateRouteTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a security group.

- *

A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. - * For more information, see - * Amazon EC2 security groups in - * the Amazon Elastic Compute Cloud User Guide and - * Security groups for your VPC in the - * Amazon Virtual Private Cloud User Guide.

- *

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

- *

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

- *

You can add or remove rules from your security groups using - * AuthorizeSecurityGroupIngress, - * AuthorizeSecurityGroupEgress, - * RevokeSecurityGroupIngress, and - * RevokeSecurityGroupEgress.

- *

For more information about VPC security group limits, see Amazon VPC Limits.

- * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- */ - public createSecurityGroup( + + /** + * @see {@link CreateSecurityGroupCommand} + */ + createSecurityGroup( args: CreateSecurityGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSecurityGroup( + createSecurityGroup( args: CreateSecurityGroupCommandInput, cb: (err: any, data?: CreateSecurityGroupCommandOutput) => void ): void; - public createSecurityGroup( + createSecurityGroup( args: CreateSecurityGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSecurityGroupCommandOutput) => void ): void; - public createSecurityGroup( - args: CreateSecurityGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSecurityGroupCommandOutput) => void), - cb?: (err: any, data?: CreateSecurityGroupCommandOutput) => void - ): Promise | void { - const command = new CreateSecurityGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for - * backups, to make copies of EBS volumes, and to save data before shutting down an - * instance.

- *

You can create snapshots of volumes in a Region and volumes on an Outpost. If you - * create a snapshot of a volume in a Region, the snapshot must be stored in the same - * Region as the volume. If you create a snapshot of a volume on an Outpost, the snapshot - * can be stored on the same Outpost as the volume, or in the Region for that Outpost.

- *

When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the - * source volume are propagated to the snapshot.

- *

You can take a snapshot of an attached volume that is in use. However, snapshots only - * capture data that has been written to your Amazon EBS volume at the time the snapshot command is - * issued; this might exclude any data that has been cached by any applications or the operating - * system. If you can pause any file systems on the volume long enough to take a snapshot, your - * snapshot should be complete. However, if you cannot pause all file writes to the volume, you - * should unmount the volume from within the instance, issue the snapshot command, and then - * remount the volume to ensure a consistent and complete snapshot. You may remount and use your - * volume while the snapshot status is pending.

- *

When you create a snapshot for an EBS volume that serves as a root device, we recommend - * that you stop the instance before taking the snapshot.

- *

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that - * are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes - * and any associated snapshots always remain protected.

- *

You can tag your snapshots during creation. For more information, see Tag your Amazon EC2 - * resources in the Amazon Elastic Compute Cloud User Guide.

- *

For more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

- */ - public createSnapshot( + + /** + * @see {@link CreateSnapshotCommand} + */ + createSnapshot( args: CreateSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSnapshot( - args: CreateSnapshotCommandInput, - cb: (err: any, data?: CreateSnapshotCommandOutput) => void - ): void; - public createSnapshot( + createSnapshot(args: CreateSnapshotCommandInput, cb: (err: any, data?: CreateSnapshotCommandOutput) => void): void; + createSnapshot( args: CreateSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSnapshotCommandOutput) => void ): void; - public createSnapshot( - args: CreateSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSnapshotCommandOutput) => void), - cb?: (err: any, data?: CreateSnapshotCommandOutput) => void - ): Promise | void { - const command = new CreateSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. - * Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot - * each that is crash-consistent across the instance.

- *

You can include all of the volumes currently attached to the instance, or you can exclude - * the root volume or specific data (non-root) volumes from the multi-volume snapshot set.

- *

You can create multi-volume snapshots of instances in a Region and instances on an - * Outpost. If you create snapshots from an instance in a Region, the snapshots must be stored - * in the same Region as the instance. If you create snapshots from an instance on an Outpost, - * the snapshots can be stored on the same Outpost as the instance, or in the Region for that - * Outpost.

- */ - public createSnapshots( + + /** + * @see {@link CreateSnapshotsCommand} + */ + createSnapshots( args: CreateSnapshotsCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSnapshots( - args: CreateSnapshotsCommandInput, - cb: (err: any, data?: CreateSnapshotsCommandOutput) => void - ): void; - public createSnapshots( + createSnapshots(args: CreateSnapshotsCommandInput, cb: (err: any, data?: CreateSnapshotsCommandOutput) => void): void; + createSnapshots( args: CreateSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSnapshotsCommandOutput) => void ): void; - public createSnapshots( - args: CreateSnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSnapshotsCommandOutput) => void), - cb?: (err: any, data?: CreateSnapshotsCommandOutput) => void - ): Promise | void { - const command = new CreateSnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. - * You can create one data feed per Amazon Web Services account. For more information, see - * Spot Instance data feed - * in the Amazon EC2 User Guide for Linux Instances.

- */ - public createSpotDatafeedSubscription( + + /** + * @see {@link CreateSpotDatafeedSubscriptionCommand} + */ + createSpotDatafeedSubscription( args: CreateSpotDatafeedSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSpotDatafeedSubscription( + createSpotDatafeedSubscription( args: CreateSpotDatafeedSubscriptionCommandInput, cb: (err: any, data?: CreateSpotDatafeedSubscriptionCommandOutput) => void ): void; - public createSpotDatafeedSubscription( + createSpotDatafeedSubscription( args: CreateSpotDatafeedSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSpotDatafeedSubscriptionCommandOutput) => void ): void; - public createSpotDatafeedSubscription( - args: CreateSpotDatafeedSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSpotDatafeedSubscriptionCommandOutput) => void), - cb?: (err: any, data?: CreateSpotDatafeedSubscriptionCommandOutput) => void - ): Promise | void { - const command = new CreateSpotDatafeedSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stores an AMI as a single object in an Amazon S3 bucket.

- *

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the - * Amazon EC2 User Guide.

- *

For more information, see Store and restore an AMI using - * Amazon S3 in the Amazon EC2 User Guide.

- */ - public createStoreImageTask( + + /** + * @see {@link CreateStoreImageTaskCommand} + */ + createStoreImageTask( args: CreateStoreImageTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public createStoreImageTask( + createStoreImageTask( args: CreateStoreImageTaskCommandInput, cb: (err: any, data?: CreateStoreImageTaskCommandOutput) => void ): void; - public createStoreImageTask( + createStoreImageTask( args: CreateStoreImageTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStoreImageTaskCommandOutput) => void ): void; - public createStoreImageTask( - args: CreateStoreImageTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStoreImageTaskCommandOutput) => void), - cb?: (err: any, data?: CreateStoreImageTaskCommandOutput) => void - ): Promise | void { - const command = new CreateStoreImageTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a subnet in the specified VPC. For an IPv4 only subnet, specify an IPv4 CIDR block. - * If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. - * For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both - * an IPv4 CIDR block and an IPv6 CIDR block.

- *

A subnet CIDR block must not overlap the CIDR block of an existing subnet in the VPC. - * After you create a subnet, you can't change its CIDR block.

- *

The allowed size for an IPv4 subnet is between a /28 netmask (16 IP addresses) and - * a /16 netmask (65,536 IP addresses). Amazon Web Services reserves both the first four and - * the last IPv4 address in each subnet's CIDR block. They're not available for your use.

- *

If you've associated an IPv6 CIDR block with your VPC, you can associate an IPv6 CIDR block - * with a subnet when you create it. The allowed block size for an IPv6 subnet is a /64 netmask.

- *

If you add more than one subnet to a VPC, they're set up in a star topology with a - * logical router in the middle.

- *

When you stop an instance in a subnet, it retains its private IPv4 address. It's - * therefore possible to have a subnet with no running instances (they're all stopped), but - * no remaining IP addresses available.

- *

For more information, see Subnets in the Amazon Virtual Private Cloud User Guide.

- */ - public createSubnet( - args: CreateSubnetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createSubnet(args: CreateSubnetCommandInput, cb: (err: any, data?: CreateSubnetCommandOutput) => void): void; - public createSubnet( + + /** + * @see {@link CreateSubnetCommand} + */ + createSubnet(args: CreateSubnetCommandInput, options?: __HttpHandlerOptions): Promise; + createSubnet(args: CreateSubnetCommandInput, cb: (err: any, data?: CreateSubnetCommandOutput) => void): void; + createSubnet( args: CreateSubnetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSubnetCommandOutput) => void ): void; - public createSubnet( - args: CreateSubnetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSubnetCommandOutput) => void), - cb?: (err: any, data?: CreateSubnetCommandOutput) => void - ): Promise | void { - const command = new CreateSubnetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a subnet CIDR reservation. For information about subnet CIDR reservations, see Subnet CIDR reservations in the Amazon Virtual Private Cloud User Guide.

- */ - public createSubnetCidrReservation( + + /** + * @see {@link CreateSubnetCidrReservationCommand} + */ + createSubnetCidrReservation( args: CreateSubnetCidrReservationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSubnetCidrReservation( + createSubnetCidrReservation( args: CreateSubnetCidrReservationCommandInput, cb: (err: any, data?: CreateSubnetCidrReservationCommandOutput) => void ): void; - public createSubnetCidrReservation( + createSubnetCidrReservation( args: CreateSubnetCidrReservationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSubnetCidrReservationCommandOutput) => void ): void; - public createSubnetCidrReservation( - args: CreateSubnetCidrReservationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSubnetCidrReservationCommandOutput) => void), - cb?: (err: any, data?: CreateSubnetCidrReservationCommandOutput) => void - ): Promise | void { - const command = new CreateSubnetCidrReservationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds or overwrites only the specified tags for the specified Amazon EC2 resource or - * resources. When you specify an existing tag key, the value is overwritten with - * the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and - * optional value. Tag keys must be unique per resource.

- *

For more information about tags, see Tag your Amazon EC2 resources in the - * Amazon Elastic Compute Cloud User Guide. For more information about - * creating IAM policies that control users' access to resources based on tags, see Supported - * resource-level permissions for Amazon EC2 API actions in the Amazon - * Elastic Compute Cloud User Guide.

- */ - public createTags(args: CreateTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public createTags(args: CreateTagsCommandInput, cb: (err: any, data?: CreateTagsCommandOutput) => void): void; - public createTags( + + /** + * @see {@link CreateTagsCommand} + */ + createTags(args: CreateTagsCommandInput, options?: __HttpHandlerOptions): Promise; + createTags(args: CreateTagsCommandInput, cb: (err: any, data?: CreateTagsCommandOutput) => void): void; + createTags( args: CreateTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTagsCommandOutput) => void ): void; - public createTags( - args: CreateTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTagsCommandOutput) => void), - cb?: (err: any, data?: CreateTagsCommandOutput) => void - ): Promise | void { - const command = new CreateTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Traffic Mirror filter.

- *

A Traffic Mirror filter is a set of rules that defines the traffic to mirror.

- *

By default, no traffic is mirrored. To mirror traffic, use CreateTrafficMirrorFilterRule to add Traffic Mirror rules to the filter. The rules you - * add define what traffic gets mirrored. You can also use ModifyTrafficMirrorFilterNetworkServices to mirror supported network services.

- */ - public createTrafficMirrorFilter( + + /** + * @see {@link CreateTrafficMirrorFilterCommand} + */ + createTrafficMirrorFilter( args: CreateTrafficMirrorFilterCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTrafficMirrorFilter( + createTrafficMirrorFilter( args: CreateTrafficMirrorFilterCommandInput, cb: (err: any, data?: CreateTrafficMirrorFilterCommandOutput) => void ): void; - public createTrafficMirrorFilter( + createTrafficMirrorFilter( args: CreateTrafficMirrorFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTrafficMirrorFilterCommandOutput) => void ): void; - public createTrafficMirrorFilter( - args: CreateTrafficMirrorFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTrafficMirrorFilterCommandOutput) => void), - cb?: (err: any, data?: CreateTrafficMirrorFilterCommandOutput) => void - ): Promise | void { - const command = new CreateTrafficMirrorFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Traffic Mirror filter rule.

- *

A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.

- *

You need the Traffic Mirror filter ID when you create the rule.

- */ - public createTrafficMirrorFilterRule( + + /** + * @see {@link CreateTrafficMirrorFilterRuleCommand} + */ + createTrafficMirrorFilterRule( args: CreateTrafficMirrorFilterRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTrafficMirrorFilterRule( + createTrafficMirrorFilterRule( args: CreateTrafficMirrorFilterRuleCommandInput, cb: (err: any, data?: CreateTrafficMirrorFilterRuleCommandOutput) => void ): void; - public createTrafficMirrorFilterRule( + createTrafficMirrorFilterRule( args: CreateTrafficMirrorFilterRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTrafficMirrorFilterRuleCommandOutput) => void ): void; - public createTrafficMirrorFilterRule( - args: CreateTrafficMirrorFilterRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTrafficMirrorFilterRuleCommandOutput) => void), - cb?: (err: any, data?: CreateTrafficMirrorFilterRuleCommandOutput) => void - ): Promise | void { - const command = new CreateTrafficMirrorFilterRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Traffic Mirror session.

- *

A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it - * to the session to define a subset of the traffic to mirror, for example all TCP - * traffic.

- *

The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.

- *

By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to - * create filter rules that specify the traffic to mirror.

- */ - public createTrafficMirrorSession( + + /** + * @see {@link CreateTrafficMirrorSessionCommand} + */ + createTrafficMirrorSession( args: CreateTrafficMirrorSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTrafficMirrorSession( + createTrafficMirrorSession( args: CreateTrafficMirrorSessionCommandInput, cb: (err: any, data?: CreateTrafficMirrorSessionCommandOutput) => void ): void; - public createTrafficMirrorSession( + createTrafficMirrorSession( args: CreateTrafficMirrorSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTrafficMirrorSessionCommandOutput) => void ): void; - public createTrafficMirrorSession( - args: CreateTrafficMirrorSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTrafficMirrorSessionCommandOutput) => void), - cb?: (err: any, data?: CreateTrafficMirrorSessionCommandOutput) => void - ): Promise | void { - const command = new CreateTrafficMirrorSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a target for your Traffic Mirror session.

- *

A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and - * the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in - * different VPCs connected via VPC peering or a transit gateway.

- *

A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.

- *

To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.

- */ - public createTrafficMirrorTarget( + + /** + * @see {@link CreateTrafficMirrorTargetCommand} + */ + createTrafficMirrorTarget( args: CreateTrafficMirrorTargetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTrafficMirrorTarget( + createTrafficMirrorTarget( args: CreateTrafficMirrorTargetCommandInput, cb: (err: any, data?: CreateTrafficMirrorTargetCommandOutput) => void ): void; - public createTrafficMirrorTarget( + createTrafficMirrorTarget( args: CreateTrafficMirrorTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTrafficMirrorTargetCommandOutput) => void ): void; - public createTrafficMirrorTarget( - args: CreateTrafficMirrorTargetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTrafficMirrorTargetCommandOutput) => void), - cb?: (err: any, data?: CreateTrafficMirrorTargetCommandOutput) => void - ): Promise | void { - const command = new CreateTrafficMirrorTargetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a transit gateway.

- *

You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. - * After the transit gateway enters the available state, you can attach your VPCs and VPN - * connections to the transit gateway.

- *

To attach your VPCs, use CreateTransitGatewayVpcAttachment.

- *

To attach a VPN connection, use CreateCustomerGateway to create a customer - * gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to - * CreateVpnConnection.

- *

When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table - * and the default propagation route table. You can use CreateTransitGatewayRouteTable to create - * additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. - * You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource - * attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table.

- */ - public createTransitGateway( + + /** + * @see {@link CreateTransitGatewayCommand} + */ + createTransitGateway( args: CreateTransitGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTransitGateway( + createTransitGateway( args: CreateTransitGatewayCommandInput, cb: (err: any, data?: CreateTransitGatewayCommandOutput) => void ): void; - public createTransitGateway( + createTransitGateway( args: CreateTransitGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTransitGatewayCommandOutput) => void ): void; - public createTransitGateway( - args: CreateTransitGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTransitGatewayCommandOutput) => void), - cb?: (err: any, data?: CreateTransitGatewayCommandOutput) => void - ): Promise | void { - const command = new CreateTransitGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.

- *

A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.

- */ - public createTransitGatewayConnect( + + /** + * @see {@link CreateTransitGatewayConnectCommand} + */ + createTransitGatewayConnect( args: CreateTransitGatewayConnectCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTransitGatewayConnect( + createTransitGatewayConnect( args: CreateTransitGatewayConnectCommandInput, cb: (err: any, data?: CreateTransitGatewayConnectCommandOutput) => void ): void; - public createTransitGatewayConnect( + createTransitGatewayConnect( args: CreateTransitGatewayConnectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTransitGatewayConnectCommandOutput) => void ): void; - public createTransitGatewayConnect( - args: CreateTransitGatewayConnectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTransitGatewayConnectCommandOutput) => void), - cb?: (err: any, data?: CreateTransitGatewayConnectCommandOutput) => void - ): Promise | void { - const command = new CreateTransitGatewayConnectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Connect peer for a specified transit gateway Connect attachment between a - * transit gateway and an appliance.

- *

The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

- *

For more information, see Connect peers in the Transit Gateways Guide.

- */ - public createTransitGatewayConnectPeer( + + /** + * @see {@link CreateTransitGatewayConnectPeerCommand} + */ + createTransitGatewayConnectPeer( args: CreateTransitGatewayConnectPeerCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTransitGatewayConnectPeer( + createTransitGatewayConnectPeer( args: CreateTransitGatewayConnectPeerCommandInput, cb: (err: any, data?: CreateTransitGatewayConnectPeerCommandOutput) => void ): void; - public createTransitGatewayConnectPeer( + createTransitGatewayConnectPeer( args: CreateTransitGatewayConnectPeerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTransitGatewayConnectPeerCommandOutput) => void ): void; - public createTransitGatewayConnectPeer( - args: CreateTransitGatewayConnectPeerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTransitGatewayConnectPeerCommandOutput) => void), - cb?: (err: any, data?: CreateTransitGatewayConnectPeerCommandOutput) => void - ): Promise | void { - const command = new CreateTransitGatewayConnectPeerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a multicast domain using the specified transit gateway.

- *

The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.

- */ - public createTransitGatewayMulticastDomain( + + /** + * @see {@link CreateTransitGatewayMulticastDomainCommand} + */ + createTransitGatewayMulticastDomain( args: CreateTransitGatewayMulticastDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTransitGatewayMulticastDomain( + createTransitGatewayMulticastDomain( args: CreateTransitGatewayMulticastDomainCommandInput, cb: (err: any, data?: CreateTransitGatewayMulticastDomainCommandOutput) => void ): void; - public createTransitGatewayMulticastDomain( + createTransitGatewayMulticastDomain( args: CreateTransitGatewayMulticastDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTransitGatewayMulticastDomainCommandOutput) => void ): void; - public createTransitGatewayMulticastDomain( - args: CreateTransitGatewayMulticastDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTransitGatewayMulticastDomainCommandOutput) => void), - cb?: (err: any, data?: CreateTransitGatewayMulticastDomainCommandOutput) => void - ): Promise | void { - const command = new CreateTransitGatewayMulticastDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Requests a transit gateway peering attachment between the specified transit gateway - * (requester) and a peer transit gateway (accepter). The peer transit gateway can be in - * your account or a different Amazon Web Services account.

- *

After you create the peering attachment, the owner of the accepter transit gateway - * must accept the attachment request.

- */ - public createTransitGatewayPeeringAttachment( + + /** + * @see {@link CreateTransitGatewayPeeringAttachmentCommand} + */ + createTransitGatewayPeeringAttachment( args: CreateTransitGatewayPeeringAttachmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTransitGatewayPeeringAttachment( + createTransitGatewayPeeringAttachment( args: CreateTransitGatewayPeeringAttachmentCommandInput, cb: (err: any, data?: CreateTransitGatewayPeeringAttachmentCommandOutput) => void ): void; - public createTransitGatewayPeeringAttachment( + createTransitGatewayPeeringAttachment( args: CreateTransitGatewayPeeringAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTransitGatewayPeeringAttachmentCommandOutput) => void ): void; - public createTransitGatewayPeeringAttachment( - args: CreateTransitGatewayPeeringAttachmentCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateTransitGatewayPeeringAttachmentCommandOutput) => void), - cb?: (err: any, data?: CreateTransitGatewayPeeringAttachmentCommandOutput) => void - ): Promise | void { - const command = new CreateTransitGatewayPeeringAttachmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a transit gateway policy table.

- */ - public createTransitGatewayPolicyTable( + + /** + * @see {@link CreateTransitGatewayPolicyTableCommand} + */ + createTransitGatewayPolicyTable( args: CreateTransitGatewayPolicyTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTransitGatewayPolicyTable( + createTransitGatewayPolicyTable( args: CreateTransitGatewayPolicyTableCommandInput, cb: (err: any, data?: CreateTransitGatewayPolicyTableCommandOutput) => void ): void; - public createTransitGatewayPolicyTable( + createTransitGatewayPolicyTable( args: CreateTransitGatewayPolicyTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTransitGatewayPolicyTableCommandOutput) => void ): void; - public createTransitGatewayPolicyTable( - args: CreateTransitGatewayPolicyTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTransitGatewayPolicyTableCommandOutput) => void), - cb?: (err: any, data?: CreateTransitGatewayPolicyTableCommandOutput) => void - ): Promise | void { - const command = new CreateTransitGatewayPolicyTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a reference (route) to a prefix list in a specified transit gateway route table.

- */ - public createTransitGatewayPrefixListReference( + + /** + * @see {@link CreateTransitGatewayPrefixListReferenceCommand} + */ + createTransitGatewayPrefixListReference( args: CreateTransitGatewayPrefixListReferenceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTransitGatewayPrefixListReference( + createTransitGatewayPrefixListReference( args: CreateTransitGatewayPrefixListReferenceCommandInput, cb: (err: any, data?: CreateTransitGatewayPrefixListReferenceCommandOutput) => void ): void; - public createTransitGatewayPrefixListReference( + createTransitGatewayPrefixListReference( args: CreateTransitGatewayPrefixListReferenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTransitGatewayPrefixListReferenceCommandOutput) => void ): void; - public createTransitGatewayPrefixListReference( - args: CreateTransitGatewayPrefixListReferenceCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateTransitGatewayPrefixListReferenceCommandOutput) => void), - cb?: (err: any, data?: CreateTransitGatewayPrefixListReferenceCommandOutput) => void - ): Promise | void { - const command = new CreateTransitGatewayPrefixListReferenceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a static route for the specified transit gateway route table.

- */ - public createTransitGatewayRoute( + + /** + * @see {@link CreateTransitGatewayRouteCommand} + */ + createTransitGatewayRoute( args: CreateTransitGatewayRouteCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTransitGatewayRoute( + createTransitGatewayRoute( args: CreateTransitGatewayRouteCommandInput, cb: (err: any, data?: CreateTransitGatewayRouteCommandOutput) => void ): void; - public createTransitGatewayRoute( + createTransitGatewayRoute( args: CreateTransitGatewayRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTransitGatewayRouteCommandOutput) => void ): void; - public createTransitGatewayRoute( - args: CreateTransitGatewayRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTransitGatewayRouteCommandOutput) => void), - cb?: (err: any, data?: CreateTransitGatewayRouteCommandOutput) => void - ): Promise | void { - const command = new CreateTransitGatewayRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a route table for the specified transit gateway.

- */ - public createTransitGatewayRouteTable( + + /** + * @see {@link CreateTransitGatewayRouteTableCommand} + */ + createTransitGatewayRouteTable( args: CreateTransitGatewayRouteTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTransitGatewayRouteTable( + createTransitGatewayRouteTable( args: CreateTransitGatewayRouteTableCommandInput, cb: (err: any, data?: CreateTransitGatewayRouteTableCommandOutput) => void ): void; - public createTransitGatewayRouteTable( + createTransitGatewayRouteTable( args: CreateTransitGatewayRouteTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTransitGatewayRouteTableCommandOutput) => void ): void; - public createTransitGatewayRouteTable( - args: CreateTransitGatewayRouteTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTransitGatewayRouteTableCommandOutput) => void), - cb?: (err: any, data?: CreateTransitGatewayRouteTableCommandOutput) => void - ): Promise | void { - const command = new CreateTransitGatewayRouteTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Advertises a new transit gateway route table.

- */ - public createTransitGatewayRouteTableAnnouncement( + + /** + * @see {@link CreateTransitGatewayRouteTableAnnouncementCommand} + */ + createTransitGatewayRouteTableAnnouncement( args: CreateTransitGatewayRouteTableAnnouncementCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTransitGatewayRouteTableAnnouncement( + createTransitGatewayRouteTableAnnouncement( args: CreateTransitGatewayRouteTableAnnouncementCommandInput, cb: (err: any, data?: CreateTransitGatewayRouteTableAnnouncementCommandOutput) => void ): void; - public createTransitGatewayRouteTableAnnouncement( + createTransitGatewayRouteTableAnnouncement( args: CreateTransitGatewayRouteTableAnnouncementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTransitGatewayRouteTableAnnouncementCommandOutput) => void ): void; - public createTransitGatewayRouteTableAnnouncement( - args: CreateTransitGatewayRouteTableAnnouncementCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateTransitGatewayRouteTableAnnouncementCommandOutput) => void), - cb?: (err: any, data?: CreateTransitGatewayRouteTableAnnouncementCommandOutput) => void - ): Promise | void { - const command = new CreateTransitGatewayRouteTableAnnouncementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attaches the specified VPC to the specified transit gateway.

- *

If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, - * the new VPC CIDR range is not propagated to the default propagation route table.

- *

To send VPC traffic to an attached transit gateway, add a route to the VPC route table using CreateRoute.

- */ - public createTransitGatewayVpcAttachment( + + /** + * @see {@link CreateTransitGatewayVpcAttachmentCommand} + */ + createTransitGatewayVpcAttachment( args: CreateTransitGatewayVpcAttachmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTransitGatewayVpcAttachment( + createTransitGatewayVpcAttachment( args: CreateTransitGatewayVpcAttachmentCommandInput, cb: (err: any, data?: CreateTransitGatewayVpcAttachmentCommandOutput) => void ): void; - public createTransitGatewayVpcAttachment( + createTransitGatewayVpcAttachment( args: CreateTransitGatewayVpcAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTransitGatewayVpcAttachmentCommandOutput) => void ): void; - public createTransitGatewayVpcAttachment( - args: CreateTransitGatewayVpcAttachmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTransitGatewayVpcAttachmentCommandOutput) => void), - cb?: (err: any, data?: CreateTransitGatewayVpcAttachmentCommandOutput) => void - ): Promise | void { - const command = new CreateTransitGatewayVpcAttachmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.

- */ - public createVerifiedAccessEndpoint( + + /** + * @see {@link CreateVerifiedAccessEndpointCommand} + */ + createVerifiedAccessEndpoint( args: CreateVerifiedAccessEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVerifiedAccessEndpoint( + createVerifiedAccessEndpoint( args: CreateVerifiedAccessEndpointCommandInput, cb: (err: any, data?: CreateVerifiedAccessEndpointCommandOutput) => void ): void; - public createVerifiedAccessEndpoint( + createVerifiedAccessEndpoint( args: CreateVerifiedAccessEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVerifiedAccessEndpointCommandOutput) => void ): void; - public createVerifiedAccessEndpoint( - args: CreateVerifiedAccessEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVerifiedAccessEndpointCommandOutput) => void), - cb?: (err: any, data?: CreateVerifiedAccessEndpointCommandOutput) => void - ): Promise | void { - const command = new CreateVerifiedAccessEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

An Amazon Web Services Verified Access group is a collection of Amazon Web Services Verified Access endpoints who's associated applications have - * similar security requirements. Each instance within an Amazon Web Services Verified Access group shares an Amazon Web Services Verified Access policy. For - * example, you can group all Amazon Web Services Verified Access instances associated with “sales” applications together and - * use one common Amazon Web Services Verified Access policy.

- */ - public createVerifiedAccessGroup( + + /** + * @see {@link CreateVerifiedAccessGroupCommand} + */ + createVerifiedAccessGroup( args: CreateVerifiedAccessGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVerifiedAccessGroup( + createVerifiedAccessGroup( args: CreateVerifiedAccessGroupCommandInput, cb: (err: any, data?: CreateVerifiedAccessGroupCommandOutput) => void ): void; - public createVerifiedAccessGroup( + createVerifiedAccessGroup( args: CreateVerifiedAccessGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVerifiedAccessGroupCommandOutput) => void ): void; - public createVerifiedAccessGroup( - args: CreateVerifiedAccessGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVerifiedAccessGroupCommandOutput) => void), - cb?: (err: any, data?: CreateVerifiedAccessGroupCommandOutput) => void - ): Promise | void { - const command = new CreateVerifiedAccessGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

An Amazon Web Services Verified Access instance is a regional entity that evaluates application requests and grants - * access only when your security requirements are met.

- */ - public createVerifiedAccessInstance( + + /** + * @see {@link CreateVerifiedAccessInstanceCommand} + */ + createVerifiedAccessInstance( args: CreateVerifiedAccessInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVerifiedAccessInstance( + createVerifiedAccessInstance( args: CreateVerifiedAccessInstanceCommandInput, cb: (err: any, data?: CreateVerifiedAccessInstanceCommandOutput) => void ): void; - public createVerifiedAccessInstance( + createVerifiedAccessInstance( args: CreateVerifiedAccessInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVerifiedAccessInstanceCommandOutput) => void ): void; - public createVerifiedAccessInstance( - args: CreateVerifiedAccessInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVerifiedAccessInstanceCommandOutput) => void), - cb?: (err: any, data?: CreateVerifiedAccessInstanceCommandOutput) => void - ): Promise | void { - const command = new CreateVerifiedAccessInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

A trust provider is a third-party entity that creates, maintains, and manages identity - * information for users and devices. When an application request is made, the identity - * information sent by the trust provider will be evaluated by Amazon Web Services Verified Access, before allowing or - * denying the application request.

- */ - public createVerifiedAccessTrustProvider( + + /** + * @see {@link CreateVerifiedAccessTrustProviderCommand} + */ + createVerifiedAccessTrustProvider( args: CreateVerifiedAccessTrustProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVerifiedAccessTrustProvider( + createVerifiedAccessTrustProvider( args: CreateVerifiedAccessTrustProviderCommandInput, cb: (err: any, data?: CreateVerifiedAccessTrustProviderCommandOutput) => void ): void; - public createVerifiedAccessTrustProvider( + createVerifiedAccessTrustProvider( args: CreateVerifiedAccessTrustProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVerifiedAccessTrustProviderCommandOutput) => void ): void; - public createVerifiedAccessTrustProvider( - args: CreateVerifiedAccessTrustProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVerifiedAccessTrustProviderCommandOutput) => void), - cb?: (err: any, data?: CreateVerifiedAccessTrustProviderCommandOutput) => void - ): Promise | void { - const command = new CreateVerifiedAccessTrustProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an EBS volume that can be attached to an instance in the same Availability Zone.

- *

You can create a new empty volume or restore a volume from an EBS snapshot. - * Any Amazon Web Services Marketplace product codes from the snapshot are propagated to the volume.

- *

You can create encrypted volumes. Encrypted volumes must be attached to instances that - * support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically - * encrypted. For more information, see Amazon EBS encryption - * in the Amazon Elastic Compute Cloud User Guide.

- *

You can tag your volumes during creation. For more information, see Tag your Amazon EC2 - * resources in the Amazon Elastic Compute Cloud User Guide.

- *

For more information, see Create an Amazon EBS volume in the - * Amazon Elastic Compute Cloud User Guide.

- */ - public createVolume( - args: CreateVolumeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createVolume(args: CreateVolumeCommandInput, cb: (err: any, data?: CreateVolumeCommandOutput) => void): void; - public createVolume( + + /** + * @see {@link CreateVolumeCommand} + */ + createVolume(args: CreateVolumeCommandInput, options?: __HttpHandlerOptions): Promise; + createVolume(args: CreateVolumeCommandInput, cb: (err: any, data?: CreateVolumeCommandOutput) => void): void; + createVolume( args: CreateVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVolumeCommandOutput) => void ): void; - public createVolume( - args: CreateVolumeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVolumeCommandOutput) => void), - cb?: (err: any, data?: CreateVolumeCommandOutput) => void - ): Promise | void { - const command = new CreateVolumeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a VPC with the specified CIDR blocks. For more information, see - * VPC CIDR blocks in the Amazon Virtual Private Cloud User Guide.

- *

You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided - * IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address - * pool that you provisioned through bring your own IP addresses (BYOIP).

- *

By default, each instance that you launch in the VPC has the default DHCP options, which - * include only a default DNS server that we provide (AmazonProvidedDNS). For more - * information, see DHCP option sets in the Amazon Virtual Private Cloud User Guide.

- *

You can specify the instance tenancy value for the VPC when you create it. You can't change - * this value for the VPC after you create it. For more information, see Dedicated Instances in the - * Amazon Elastic Compute Cloud User Guide.

- */ - public createVpc(args: CreateVpcCommandInput, options?: __HttpHandlerOptions): Promise; - public createVpc(args: CreateVpcCommandInput, cb: (err: any, data?: CreateVpcCommandOutput) => void): void; - public createVpc( + + /** + * @see {@link CreateVpcCommand} + */ + createVpc(args: CreateVpcCommandInput, options?: __HttpHandlerOptions): Promise; + createVpc(args: CreateVpcCommandInput, cb: (err: any, data?: CreateVpcCommandOutput) => void): void; + createVpc( args: CreateVpcCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVpcCommandOutput) => void ): void; - public createVpc( - args: CreateVpcCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVpcCommandOutput) => void), - cb?: (err: any, data?: CreateVpcCommandOutput) => void - ): Promise | void { - const command = new CreateVpcCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a VPC endpoint for a specified service. An endpoint enables you to create a - * private connection between your VPC and the service. The service may be provided by Amazon Web Services, - * an Amazon Web Services Marketplace Partner, or another Amazon Web Services account. For more information, - * see the Amazon Web Services PrivateLink Guide.

- */ - public createVpcEndpoint( + + /** + * @see {@link CreateVpcEndpointCommand} + */ + createVpcEndpoint( args: CreateVpcEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVpcEndpoint( + createVpcEndpoint( args: CreateVpcEndpointCommandInput, cb: (err: any, data?: CreateVpcEndpointCommandOutput) => void ): void; - public createVpcEndpoint( + createVpcEndpoint( args: CreateVpcEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVpcEndpointCommandOutput) => void ): void; - public createVpcEndpoint( - args: CreateVpcEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVpcEndpointCommandOutput) => void), - cb?: (err: any, data?: CreateVpcEndpointCommandOutput) => void - ): Promise | void { - const command = new CreateVpcEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a connection notification for a specified VPC endpoint or VPC endpoint - * service. A connection notification notifies you of specific endpoint events. You must - * create an SNS topic to receive notifications. For more information, see Create a Topic in - * the Amazon Simple Notification Service Developer Guide.

- *

You can create a connection notification for interface endpoints only.

- */ - public createVpcEndpointConnectionNotification( + + /** + * @see {@link CreateVpcEndpointConnectionNotificationCommand} + */ + createVpcEndpointConnectionNotification( args: CreateVpcEndpointConnectionNotificationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVpcEndpointConnectionNotification( + createVpcEndpointConnectionNotification( args: CreateVpcEndpointConnectionNotificationCommandInput, cb: (err: any, data?: CreateVpcEndpointConnectionNotificationCommandOutput) => void ): void; - public createVpcEndpointConnectionNotification( + createVpcEndpointConnectionNotification( args: CreateVpcEndpointConnectionNotificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVpcEndpointConnectionNotificationCommandOutput) => void ): void; - public createVpcEndpointConnectionNotification( - args: CreateVpcEndpointConnectionNotificationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateVpcEndpointConnectionNotificationCommandOutput) => void), - cb?: (err: any, data?: CreateVpcEndpointConnectionNotificationCommandOutput) => void - ): Promise | void { - const command = new CreateVpcEndpointConnectionNotificationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts, - * users, and IAM roles) can connect.

- *

Before you create an endpoint service, you must create one of the following for your service:

- *
    - *
  • - *

    A Network Load Balancer. - * Service consumers connect to your service using an interface endpoint.

    - *
  • - *
  • - *

    A Gateway Load Balancer. - * Service consumers connect to your service using a Gateway Load Balancer endpoint.

    - *
  • - *
- *

If you set the private DNS name, you must prove that you own the private DNS domain - * name.

- *

For more information, see the Amazon Web Services PrivateLink - * Guide.

- */ - public createVpcEndpointServiceConfiguration( + + /** + * @see {@link CreateVpcEndpointServiceConfigurationCommand} + */ + createVpcEndpointServiceConfiguration( args: CreateVpcEndpointServiceConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVpcEndpointServiceConfiguration( + createVpcEndpointServiceConfiguration( args: CreateVpcEndpointServiceConfigurationCommandInput, cb: (err: any, data?: CreateVpcEndpointServiceConfigurationCommandOutput) => void ): void; - public createVpcEndpointServiceConfiguration( + createVpcEndpointServiceConfiguration( args: CreateVpcEndpointServiceConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVpcEndpointServiceConfigurationCommandOutput) => void ): void; - public createVpcEndpointServiceConfiguration( - args: CreateVpcEndpointServiceConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateVpcEndpointServiceConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateVpcEndpointServiceConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateVpcEndpointServiceConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Requests a VPC peering connection between two VPCs: a requester VPC that you own and - * an accepter VPC with which to create the connection. The accepter VPC can belong to - * another Amazon Web Services account and can be in a different Region to the requester VPC. - * The requester VPC and accepter VPC cannot have overlapping CIDR blocks.

- * - *

Limitations and rules apply to a VPC peering connection. For more information, see - * the limitations section in the VPC Peering Guide.

- *
- *

The owner of the accepter VPC must accept the peering request to activate the peering - * connection. The VPC peering connection request expires after 7 days, after which it - * cannot be accepted or rejected.

- *

If you create a VPC peering connection request between VPCs with overlapping CIDR - * blocks, the VPC peering connection has a status of failed.

- */ - public createVpcPeeringConnection( + + /** + * @see {@link CreateVpcPeeringConnectionCommand} + */ + createVpcPeeringConnection( args: CreateVpcPeeringConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVpcPeeringConnection( + createVpcPeeringConnection( args: CreateVpcPeeringConnectionCommandInput, cb: (err: any, data?: CreateVpcPeeringConnectionCommandOutput) => void ): void; - public createVpcPeeringConnection( + createVpcPeeringConnection( args: CreateVpcPeeringConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVpcPeeringConnectionCommandOutput) => void ): void; - public createVpcPeeringConnection( - args: CreateVpcPeeringConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVpcPeeringConnectionCommandOutput) => void), - cb?: (err: any, data?: CreateVpcPeeringConnectionCommandOutput) => void - ): Promise | void { - const command = new CreateVpcPeeringConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a VPN connection between an existing virtual private gateway or transit - * gateway and a customer gateway. The supported connection type is - * ipsec.1.

- *

The response includes information that you need to give to your network administrator - * to configure your customer gateway.

- * - *

We strongly recommend that you use HTTPS when calling this operation because the - * response contains sensitive cryptographic information for configuring your customer - * gateway device.

- *
- *

If you decide to shut down your VPN connection for any reason and later create a new - * VPN connection, you must reconfigure your customer gateway with the new information - * returned from this call.

- *

This is an idempotent operation. If you perform the operation more than once, Amazon - * EC2 doesn't return an error.

- *

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN - * User Guide.

- */ - public createVpnConnection( + + /** + * @see {@link CreateVpnConnectionCommand} + */ + createVpnConnection( args: CreateVpnConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVpnConnection( + createVpnConnection( args: CreateVpnConnectionCommandInput, cb: (err: any, data?: CreateVpnConnectionCommandOutput) => void ): void; - public createVpnConnection( + createVpnConnection( args: CreateVpnConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVpnConnectionCommandOutput) => void ): void; - public createVpnConnection( - args: CreateVpnConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVpnConnectionCommandOutput) => void), - cb?: (err: any, data?: CreateVpnConnectionCommandOutput) => void - ): Promise | void { - const command = new CreateVpnConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a static route associated with a VPN connection between an existing virtual - * private gateway and a VPN customer gateway. The static route allows traffic to be routed - * from the virtual private gateway to the VPN customer gateway.

- *

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN - * User Guide.

- */ - public createVpnConnectionRoute( + + /** + * @see {@link CreateVpnConnectionRouteCommand} + */ + createVpnConnectionRoute( args: CreateVpnConnectionRouteCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVpnConnectionRoute( + createVpnConnectionRoute( args: CreateVpnConnectionRouteCommandInput, cb: (err: any, data?: CreateVpnConnectionRouteCommandOutput) => void ): void; - public createVpnConnectionRoute( + createVpnConnectionRoute( args: CreateVpnConnectionRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVpnConnectionRouteCommandOutput) => void ): void; - public createVpnConnectionRoute( - args: CreateVpnConnectionRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVpnConnectionRouteCommandOutput) => void), - cb?: (err: any, data?: CreateVpnConnectionRouteCommandOutput) => void - ): Promise | void { - const command = new CreateVpnConnectionRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a virtual private gateway. A virtual private gateway is the endpoint on the - * VPC side of your VPN connection. You can create a virtual private gateway before - * creating the VPC itself.

- *

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN - * User Guide.

- */ - public createVpnGateway( + + /** + * @see {@link CreateVpnGatewayCommand} + */ + createVpnGateway( args: CreateVpnGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVpnGateway( + createVpnGateway( args: CreateVpnGatewayCommandInput, cb: (err: any, data?: CreateVpnGatewayCommandOutput) => void ): void; - public createVpnGateway( + createVpnGateway( args: CreateVpnGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVpnGatewayCommandOutput) => void ): void; - public createVpnGateway( - args: CreateVpnGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVpnGatewayCommandOutput) => void), - cb?: (err: any, data?: CreateVpnGatewayCommandOutput) => void - ): Promise | void { - const command = new CreateVpnGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a carrier gateway.

- * - *

If you do not delete the route that contains the carrier gateway as the - * Target, the route is a blackhole route. For information about how to delete a route, see - * DeleteRoute.

- *
- */ - public deleteCarrierGateway( + + /** + * @see {@link DeleteCarrierGatewayCommand} + */ + deleteCarrierGateway( args: DeleteCarrierGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCarrierGateway( + deleteCarrierGateway( args: DeleteCarrierGatewayCommandInput, cb: (err: any, data?: DeleteCarrierGatewayCommandOutput) => void ): void; - public deleteCarrierGateway( + deleteCarrierGateway( args: DeleteCarrierGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCarrierGatewayCommandOutput) => void ): void; - public deleteCarrierGateway( - args: DeleteCarrierGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCarrierGatewayCommandOutput) => void), - cb?: (err: any, data?: DeleteCarrierGatewayCommandOutput) => void - ): Promise | void { - const command = new DeleteCarrierGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified Client VPN endpoint. You must disassociate all target networks before you - * can delete a Client VPN endpoint.

- */ - public deleteClientVpnEndpoint( + + /** + * @see {@link DeleteClientVpnEndpointCommand} + */ + deleteClientVpnEndpoint( args: DeleteClientVpnEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteClientVpnEndpoint( + deleteClientVpnEndpoint( args: DeleteClientVpnEndpointCommandInput, cb: (err: any, data?: DeleteClientVpnEndpointCommandOutput) => void ): void; - public deleteClientVpnEndpoint( + deleteClientVpnEndpoint( args: DeleteClientVpnEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClientVpnEndpointCommandOutput) => void ): void; - public deleteClientVpnEndpoint( - args: DeleteClientVpnEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteClientVpnEndpointCommandOutput) => void), - cb?: (err: any, data?: DeleteClientVpnEndpointCommandOutput) => void - ): Promise | void { - const command = new DeleteClientVpnEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using - * the CreateClientVpnRoute action. You cannot delete routes that were - * automatically added when associating a subnet. To remove routes that have been automatically added, - * disassociate the target subnet from the Client VPN endpoint.

- */ - public deleteClientVpnRoute( + + /** + * @see {@link DeleteClientVpnRouteCommand} + */ + deleteClientVpnRoute( args: DeleteClientVpnRouteCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteClientVpnRoute( + deleteClientVpnRoute( args: DeleteClientVpnRouteCommandInput, cb: (err: any, data?: DeleteClientVpnRouteCommandOutput) => void ): void; - public deleteClientVpnRoute( + deleteClientVpnRoute( args: DeleteClientVpnRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClientVpnRouteCommandOutput) => void ): void; - public deleteClientVpnRoute( - args: DeleteClientVpnRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteClientVpnRouteCommandOutput) => void), - cb?: (err: any, data?: DeleteClientVpnRouteCommandOutput) => void - ): Promise | void { - const command = new DeleteClientVpnRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Deletes a range of customer-owned IP addresses. - *

- */ - public deleteCoipCidr( + + /** + * @see {@link DeleteCoipCidrCommand} + */ + deleteCoipCidr( args: DeleteCoipCidrCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCoipCidr( - args: DeleteCoipCidrCommandInput, - cb: (err: any, data?: DeleteCoipCidrCommandOutput) => void - ): void; - public deleteCoipCidr( + deleteCoipCidr(args: DeleteCoipCidrCommandInput, cb: (err: any, data?: DeleteCoipCidrCommandOutput) => void): void; + deleteCoipCidr( args: DeleteCoipCidrCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCoipCidrCommandOutput) => void ): void; - public deleteCoipCidr( - args: DeleteCoipCidrCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCoipCidrCommandOutput) => void), - cb?: (err: any, data?: DeleteCoipCidrCommandOutput) => void - ): Promise | void { - const command = new DeleteCoipCidrCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a pool of customer-owned IP (CoIP) addresses.

- */ - public deleteCoipPool( + + /** + * @see {@link DeleteCoipPoolCommand} + */ + deleteCoipPool( args: DeleteCoipPoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCoipPool( - args: DeleteCoipPoolCommandInput, - cb: (err: any, data?: DeleteCoipPoolCommandOutput) => void - ): void; - public deleteCoipPool( + deleteCoipPool(args: DeleteCoipPoolCommandInput, cb: (err: any, data?: DeleteCoipPoolCommandOutput) => void): void; + deleteCoipPool( args: DeleteCoipPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCoipPoolCommandOutput) => void ): void; - public deleteCoipPool( - args: DeleteCoipPoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCoipPoolCommandOutput) => void), - cb?: (err: any, data?: DeleteCoipPoolCommandOutput) => void - ): Promise | void { - const command = new DeleteCoipPoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified customer gateway. You must delete the VPN connection before you - * can delete the customer gateway.

- */ - public deleteCustomerGateway( + + /** + * @see {@link DeleteCustomerGatewayCommand} + */ + deleteCustomerGateway( args: DeleteCustomerGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCustomerGateway( + deleteCustomerGateway( args: DeleteCustomerGatewayCommandInput, cb: (err: any, data?: DeleteCustomerGatewayCommandOutput) => void ): void; - public deleteCustomerGateway( + deleteCustomerGateway( args: DeleteCustomerGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomerGatewayCommandOutput) => void ): void; - public deleteCustomerGateway( - args: DeleteCustomerGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCustomerGatewayCommandOutput) => void), - cb?: (err: any, data?: DeleteCustomerGatewayCommandOutput) => void - ): Promise | void { - const command = new DeleteCustomerGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.

- */ - public deleteDhcpOptions( + + /** + * @see {@link DeleteDhcpOptionsCommand} + */ + deleteDhcpOptions( args: DeleteDhcpOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDhcpOptions( + deleteDhcpOptions( args: DeleteDhcpOptionsCommandInput, cb: (err: any, data?: DeleteDhcpOptionsCommandOutput) => void ): void; - public deleteDhcpOptions( + deleteDhcpOptions( args: DeleteDhcpOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDhcpOptionsCommandOutput) => void ): void; - public deleteDhcpOptions( - args: DeleteDhcpOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDhcpOptionsCommandOutput) => void), - cb?: (err: any, data?: DeleteDhcpOptionsCommandOutput) => void - ): Promise | void { - const command = new DeleteDhcpOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an egress-only internet gateway.

- */ - public deleteEgressOnlyInternetGateway( + + /** + * @see {@link DeleteEgressOnlyInternetGatewayCommand} + */ + deleteEgressOnlyInternetGateway( args: DeleteEgressOnlyInternetGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEgressOnlyInternetGateway( + deleteEgressOnlyInternetGateway( args: DeleteEgressOnlyInternetGatewayCommandInput, cb: (err: any, data?: DeleteEgressOnlyInternetGatewayCommandOutput) => void ): void; - public deleteEgressOnlyInternetGateway( + deleteEgressOnlyInternetGateway( args: DeleteEgressOnlyInternetGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEgressOnlyInternetGatewayCommandOutput) => void ): void; - public deleteEgressOnlyInternetGateway( - args: DeleteEgressOnlyInternetGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEgressOnlyInternetGatewayCommandOutput) => void), - cb?: (err: any, data?: DeleteEgressOnlyInternetGatewayCommandOutput) => void - ): Promise | void { - const command = new DeleteEgressOnlyInternetGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified EC2 Fleets.

- *

After you delete an EC2 Fleet, it launches no new instances.

- *

You must also specify whether a deleted EC2 Fleet should terminate its instances. If you - * choose to terminate the instances, the EC2 Fleet enters the deleted_terminating - * state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances - * continue to run until they are interrupted or you terminate them manually.

- *

For instant fleets, EC2 Fleet must terminate the instances when the fleet is - * deleted. A deleted instant fleet with running instances is not - * supported.

- *

- * Restrictions - *

- *
    - *
  • - *

    You can delete up to 25 instant fleets in a single request. If you exceed this - * number, no instant fleets are deleted and an error is returned. There is no - * restriction on the number of fleets of type maintain or request that can be deleted - * in a single request.

    - *
  • - *
  • - *

    Up to 1000 instances can be terminated in a single request to delete - * instant fleets.

    - *
  • - *
- *

For more information, see Delete an EC2 - * Fleet in the Amazon EC2 User Guide.

- */ - public deleteFleets( - args: DeleteFleetsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteFleets(args: DeleteFleetsCommandInput, cb: (err: any, data?: DeleteFleetsCommandOutput) => void): void; - public deleteFleets( + + /** + * @see {@link DeleteFleetsCommand} + */ + deleteFleets(args: DeleteFleetsCommandInput, options?: __HttpHandlerOptions): Promise; + deleteFleets(args: DeleteFleetsCommandInput, cb: (err: any, data?: DeleteFleetsCommandOutput) => void): void; + deleteFleets( args: DeleteFleetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFleetsCommandOutput) => void ): void; - public deleteFleets( - args: DeleteFleetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFleetsCommandOutput) => void), - cb?: (err: any, data?: DeleteFleetsCommandOutput) => void - ): Promise | void { - const command = new DeleteFleetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes one or more flow logs.

- */ - public deleteFlowLogs( + + /** + * @see {@link DeleteFlowLogsCommand} + */ + deleteFlowLogs( args: DeleteFlowLogsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFlowLogs( - args: DeleteFlowLogsCommandInput, - cb: (err: any, data?: DeleteFlowLogsCommandOutput) => void - ): void; - public deleteFlowLogs( + deleteFlowLogs(args: DeleteFlowLogsCommandInput, cb: (err: any, data?: DeleteFlowLogsCommandOutput) => void): void; + deleteFlowLogs( args: DeleteFlowLogsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFlowLogsCommandOutput) => void ): void; - public deleteFlowLogs( - args: DeleteFlowLogsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFlowLogsCommandOutput) => void), - cb?: (err: any, data?: DeleteFlowLogsCommandOutput) => void - ): Promise | void { - const command = new DeleteFlowLogsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified Amazon FPGA Image (AFI).

- */ - public deleteFpgaImage( + + /** + * @see {@link DeleteFpgaImageCommand} + */ + deleteFpgaImage( args: DeleteFpgaImageCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFpgaImage( - args: DeleteFpgaImageCommandInput, - cb: (err: any, data?: DeleteFpgaImageCommandOutput) => void - ): void; - public deleteFpgaImage( + deleteFpgaImage(args: DeleteFpgaImageCommandInput, cb: (err: any, data?: DeleteFpgaImageCommandOutput) => void): void; + deleteFpgaImage( args: DeleteFpgaImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFpgaImageCommandOutput) => void ): void; - public deleteFpgaImage( - args: DeleteFpgaImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFpgaImageCommandOutput) => void), - cb?: (err: any, data?: DeleteFpgaImageCommandOutput) => void - ): Promise | void { - const command = new DeleteFpgaImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified event window.

- *

For more information, see Define event windows for scheduled - * events in the Amazon EC2 User Guide.

- */ - public deleteInstanceEventWindow( + + /** + * @see {@link DeleteInstanceEventWindowCommand} + */ + deleteInstanceEventWindow( args: DeleteInstanceEventWindowCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInstanceEventWindow( + deleteInstanceEventWindow( args: DeleteInstanceEventWindowCommandInput, cb: (err: any, data?: DeleteInstanceEventWindowCommandOutput) => void ): void; - public deleteInstanceEventWindow( + deleteInstanceEventWindow( args: DeleteInstanceEventWindowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInstanceEventWindowCommandOutput) => void ): void; - public deleteInstanceEventWindow( - args: DeleteInstanceEventWindowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInstanceEventWindowCommandOutput) => void), - cb?: (err: any, data?: DeleteInstanceEventWindowCommandOutput) => void - ): Promise | void { - const command = new DeleteInstanceEventWindowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified internet gateway. You must detach the internet gateway from the - * VPC before you can delete it.

- */ - public deleteInternetGateway( + + /** + * @see {@link DeleteInternetGatewayCommand} + */ + deleteInternetGateway( args: DeleteInternetGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInternetGateway( + deleteInternetGateway( args: DeleteInternetGatewayCommandInput, cb: (err: any, data?: DeleteInternetGatewayCommandOutput) => void ): void; - public deleteInternetGateway( + deleteInternetGateway( args: DeleteInternetGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInternetGatewayCommandOutput) => void ): void; - public deleteInternetGateway( - args: DeleteInternetGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInternetGatewayCommandOutput) => void), - cb?: (err: any, data?: DeleteInternetGatewayCommandOutput) => void - ): Promise | void { - const command = new DeleteInternetGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.

- *

For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide. - *

- */ - public deleteIpam(args: DeleteIpamCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteIpam(args: DeleteIpamCommandInput, cb: (err: any, data?: DeleteIpamCommandOutput) => void): void; - public deleteIpam( + + /** + * @see {@link DeleteIpamCommand} + */ + deleteIpam(args: DeleteIpamCommandInput, options?: __HttpHandlerOptions): Promise; + deleteIpam(args: DeleteIpamCommandInput, cb: (err: any, data?: DeleteIpamCommandOutput) => void): void; + deleteIpam( args: DeleteIpamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIpamCommandOutput) => void ): void; - public deleteIpam( - args: DeleteIpamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIpamCommandOutput) => void), - cb?: (err: any, data?: DeleteIpamCommandOutput) => void - ): Promise | void { - const command = new DeleteIpamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete an IPAM pool.

- * - *

You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release - * allocations, see ReleaseIpamPoolAllocation. To deprovision pool - * CIDRs, see DeprovisionIpamPoolCidr.

- *
- *

For more information, see Delete a pool in the Amazon VPC IPAM User Guide. - *

- */ - public deleteIpamPool( + + /** + * @see {@link DeleteIpamPoolCommand} + */ + deleteIpamPool( args: DeleteIpamPoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteIpamPool( - args: DeleteIpamPoolCommandInput, - cb: (err: any, data?: DeleteIpamPoolCommandOutput) => void - ): void; - public deleteIpamPool( + deleteIpamPool(args: DeleteIpamPoolCommandInput, cb: (err: any, data?: DeleteIpamPoolCommandOutput) => void): void; + deleteIpamPool( args: DeleteIpamPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIpamPoolCommandOutput) => void ): void; - public deleteIpamPool( - args: DeleteIpamPoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIpamPoolCommandOutput) => void), - cb?: (err: any, data?: DeleteIpamPoolCommandOutput) => void - ): Promise | void { - const command = new DeleteIpamPoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

- */ - public deleteIpamResourceDiscovery( + + /** + * @see {@link DeleteIpamResourceDiscoveryCommand} + */ + deleteIpamResourceDiscovery( args: DeleteIpamResourceDiscoveryCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteIpamResourceDiscovery( + deleteIpamResourceDiscovery( args: DeleteIpamResourceDiscoveryCommandInput, cb: (err: any, data?: DeleteIpamResourceDiscoveryCommandOutput) => void ): void; - public deleteIpamResourceDiscovery( + deleteIpamResourceDiscovery( args: DeleteIpamResourceDiscoveryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIpamResourceDiscoveryCommandOutput) => void ): void; - public deleteIpamResourceDiscovery( - args: DeleteIpamResourceDiscoveryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIpamResourceDiscoveryCommandOutput) => void), - cb?: (err: any, data?: DeleteIpamResourceDiscoveryCommandOutput) => void - ): Promise | void { - const command = new DeleteIpamResourceDiscoveryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete the scope for an IPAM. You cannot delete the default scopes.

- *

For more information, see Delete a scope in the Amazon VPC IPAM User Guide. - *

- */ - public deleteIpamScope( + + /** + * @see {@link DeleteIpamScopeCommand} + */ + deleteIpamScope( args: DeleteIpamScopeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteIpamScope( - args: DeleteIpamScopeCommandInput, - cb: (err: any, data?: DeleteIpamScopeCommandOutput) => void - ): void; - public deleteIpamScope( + deleteIpamScope(args: DeleteIpamScopeCommandInput, cb: (err: any, data?: DeleteIpamScopeCommandOutput) => void): void; + deleteIpamScope( args: DeleteIpamScopeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIpamScopeCommandOutput) => void ): void; - public deleteIpamScope( - args: DeleteIpamScopeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIpamScopeCommandOutput) => void), - cb?: (err: any, data?: DeleteIpamScopeCommandOutput) => void - ): Promise | void { - const command = new DeleteIpamScopeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified key pair, by removing the public key from Amazon EC2.

- */ - public deleteKeyPair( - args: DeleteKeyPairCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteKeyPair( - args: DeleteKeyPairCommandInput, - cb: (err: any, data?: DeleteKeyPairCommandOutput) => void - ): void; - public deleteKeyPair( + + /** + * @see {@link DeleteKeyPairCommand} + */ + deleteKeyPair(args: DeleteKeyPairCommandInput, options?: __HttpHandlerOptions): Promise; + deleteKeyPair(args: DeleteKeyPairCommandInput, cb: (err: any, data?: DeleteKeyPairCommandOutput) => void): void; + deleteKeyPair( args: DeleteKeyPairCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteKeyPairCommandOutput) => void ): void; - public deleteKeyPair( - args: DeleteKeyPairCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteKeyPairCommandOutput) => void), - cb?: (err: any, data?: DeleteKeyPairCommandOutput) => void - ): Promise | void { - const command = new DeleteKeyPairCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a launch template. Deleting a launch template deletes all of its - * versions.

- */ - public deleteLaunchTemplate( + + /** + * @see {@link DeleteLaunchTemplateCommand} + */ + deleteLaunchTemplate( args: DeleteLaunchTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLaunchTemplate( + deleteLaunchTemplate( args: DeleteLaunchTemplateCommandInput, cb: (err: any, data?: DeleteLaunchTemplateCommandOutput) => void ): void; - public deleteLaunchTemplate( + deleteLaunchTemplate( args: DeleteLaunchTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLaunchTemplateCommandOutput) => void ): void; - public deleteLaunchTemplate( - args: DeleteLaunchTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLaunchTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteLaunchTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteLaunchTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes one or more versions of a launch template. You cannot delete the default - * version of a launch template; you must first assign a different version as the default. - * If the default version is the only version for the launch template, you must delete the - * entire launch template using DeleteLaunchTemplate.

- */ - public deleteLaunchTemplateVersions( + + /** + * @see {@link DeleteLaunchTemplateVersionsCommand} + */ + deleteLaunchTemplateVersions( args: DeleteLaunchTemplateVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLaunchTemplateVersions( + deleteLaunchTemplateVersions( args: DeleteLaunchTemplateVersionsCommandInput, cb: (err: any, data?: DeleteLaunchTemplateVersionsCommandOutput) => void ): void; - public deleteLaunchTemplateVersions( + deleteLaunchTemplateVersions( args: DeleteLaunchTemplateVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLaunchTemplateVersionsCommandOutput) => void ): void; - public deleteLaunchTemplateVersions( - args: DeleteLaunchTemplateVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLaunchTemplateVersionsCommandOutput) => void), - cb?: (err: any, data?: DeleteLaunchTemplateVersionsCommandOutput) => void - ): Promise | void { - const command = new DeleteLaunchTemplateVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified route from the specified local gateway route table.

- */ - public deleteLocalGatewayRoute( + + /** + * @see {@link DeleteLocalGatewayRouteCommand} + */ + deleteLocalGatewayRoute( args: DeleteLocalGatewayRouteCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLocalGatewayRoute( + deleteLocalGatewayRoute( args: DeleteLocalGatewayRouteCommandInput, cb: (err: any, data?: DeleteLocalGatewayRouteCommandOutput) => void ): void; - public deleteLocalGatewayRoute( + deleteLocalGatewayRoute( args: DeleteLocalGatewayRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLocalGatewayRouteCommandOutput) => void ): void; - public deleteLocalGatewayRoute( - args: DeleteLocalGatewayRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLocalGatewayRouteCommandOutput) => void), - cb?: (err: any, data?: DeleteLocalGatewayRouteCommandOutput) => void - ): Promise | void { - const command = new DeleteLocalGatewayRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Deletes a local gateway route table. - *

- */ - public deleteLocalGatewayRouteTable( + + /** + * @see {@link DeleteLocalGatewayRouteTableCommand} + */ + deleteLocalGatewayRouteTable( args: DeleteLocalGatewayRouteTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLocalGatewayRouteTable( + deleteLocalGatewayRouteTable( args: DeleteLocalGatewayRouteTableCommandInput, cb: (err: any, data?: DeleteLocalGatewayRouteTableCommandOutput) => void ): void; - public deleteLocalGatewayRouteTable( + deleteLocalGatewayRouteTable( args: DeleteLocalGatewayRouteTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLocalGatewayRouteTableCommandOutput) => void ): void; - public deleteLocalGatewayRouteTable( - args: DeleteLocalGatewayRouteTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLocalGatewayRouteTableCommandOutput) => void), - cb?: (err: any, data?: DeleteLocalGatewayRouteTableCommandOutput) => void - ): Promise | void { - const command = new DeleteLocalGatewayRouteTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Deletes a local gateway route table virtual interface group association. - *

- */ - public deleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation( + + /** + * @see {@link DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationCommand} + */ + deleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation( args: DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation( + deleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation( args: DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationCommandInput, cb: (err: any, data?: DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationCommandOutput) => void ): void; - public deleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation( + deleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation( args: DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationCommandOutput) => void ): void; - public deleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation( - args: DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationCommandOutput) => void), - cb?: (err: any, data?: DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationCommandOutput) => void - ): Promise | void { - const command = new DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified association between a VPC and local gateway route table.

- */ - public deleteLocalGatewayRouteTableVpcAssociation( + + /** + * @see {@link DeleteLocalGatewayRouteTableVpcAssociationCommand} + */ + deleteLocalGatewayRouteTableVpcAssociation( args: DeleteLocalGatewayRouteTableVpcAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLocalGatewayRouteTableVpcAssociation( + deleteLocalGatewayRouteTableVpcAssociation( args: DeleteLocalGatewayRouteTableVpcAssociationCommandInput, cb: (err: any, data?: DeleteLocalGatewayRouteTableVpcAssociationCommandOutput) => void ): void; - public deleteLocalGatewayRouteTableVpcAssociation( + deleteLocalGatewayRouteTableVpcAssociation( args: DeleteLocalGatewayRouteTableVpcAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLocalGatewayRouteTableVpcAssociationCommandOutput) => void ): void; - public deleteLocalGatewayRouteTableVpcAssociation( - args: DeleteLocalGatewayRouteTableVpcAssociationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteLocalGatewayRouteTableVpcAssociationCommandOutput) => void), - cb?: (err: any, data?: DeleteLocalGatewayRouteTableVpcAssociationCommandOutput) => void - ): Promise | void { - const command = new DeleteLocalGatewayRouteTableVpcAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.

- */ - public deleteManagedPrefixList( + + /** + * @see {@link DeleteManagedPrefixListCommand} + */ + deleteManagedPrefixList( args: DeleteManagedPrefixListCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteManagedPrefixList( + deleteManagedPrefixList( args: DeleteManagedPrefixListCommandInput, cb: (err: any, data?: DeleteManagedPrefixListCommandOutput) => void ): void; - public deleteManagedPrefixList( + deleteManagedPrefixList( args: DeleteManagedPrefixListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteManagedPrefixListCommandOutput) => void ): void; - public deleteManagedPrefixList( - args: DeleteManagedPrefixListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteManagedPrefixListCommandOutput) => void), - cb?: (err: any, data?: DeleteManagedPrefixListCommandOutput) => void - ): Promise | void { - const command = new DeleteManagedPrefixListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, - * but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway - * routes in your route tables.

- */ - public deleteNatGateway( + + /** + * @see {@link DeleteNatGatewayCommand} + */ + deleteNatGateway( args: DeleteNatGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNatGateway( + deleteNatGateway( args: DeleteNatGatewayCommandInput, cb: (err: any, data?: DeleteNatGatewayCommandOutput) => void ): void; - public deleteNatGateway( + deleteNatGateway( args: DeleteNatGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNatGatewayCommandOutput) => void ): void; - public deleteNatGateway( - args: DeleteNatGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNatGatewayCommandOutput) => void), - cb?: (err: any, data?: DeleteNatGatewayCommandOutput) => void - ): Promise | void { - const command = new DeleteNatGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.

- */ - public deleteNetworkAcl( + + /** + * @see {@link DeleteNetworkAclCommand} + */ + deleteNetworkAcl( args: DeleteNetworkAclCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNetworkAcl( + deleteNetworkAcl( args: DeleteNetworkAclCommandInput, cb: (err: any, data?: DeleteNetworkAclCommandOutput) => void ): void; - public deleteNetworkAcl( + deleteNetworkAcl( args: DeleteNetworkAclCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNetworkAclCommandOutput) => void ): void; - public deleteNetworkAcl( - args: DeleteNetworkAclCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNetworkAclCommandOutput) => void), - cb?: (err: any, data?: DeleteNetworkAclCommandOutput) => void - ): Promise | void { - const command = new DeleteNetworkAclCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

- */ - public deleteNetworkAclEntry( + + /** + * @see {@link DeleteNetworkAclEntryCommand} + */ + deleteNetworkAclEntry( args: DeleteNetworkAclEntryCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNetworkAclEntry( + deleteNetworkAclEntry( args: DeleteNetworkAclEntryCommandInput, cb: (err: any, data?: DeleteNetworkAclEntryCommandOutput) => void ): void; - public deleteNetworkAclEntry( + deleteNetworkAclEntry( args: DeleteNetworkAclEntryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNetworkAclEntryCommandOutput) => void ): void; - public deleteNetworkAclEntry( - args: DeleteNetworkAclEntryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNetworkAclEntryCommandOutput) => void), - cb?: (err: any, data?: DeleteNetworkAclEntryCommandOutput) => void - ): Promise | void { - const command = new DeleteNetworkAclEntryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified Network Access Scope.

- */ - public deleteNetworkInsightsAccessScope( + + /** + * @see {@link DeleteNetworkInsightsAccessScopeCommand} + */ + deleteNetworkInsightsAccessScope( args: DeleteNetworkInsightsAccessScopeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNetworkInsightsAccessScope( + deleteNetworkInsightsAccessScope( args: DeleteNetworkInsightsAccessScopeCommandInput, cb: (err: any, data?: DeleteNetworkInsightsAccessScopeCommandOutput) => void ): void; - public deleteNetworkInsightsAccessScope( + deleteNetworkInsightsAccessScope( args: DeleteNetworkInsightsAccessScopeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNetworkInsightsAccessScopeCommandOutput) => void ): void; - public deleteNetworkInsightsAccessScope( - args: DeleteNetworkInsightsAccessScopeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNetworkInsightsAccessScopeCommandOutput) => void), - cb?: (err: any, data?: DeleteNetworkInsightsAccessScopeCommandOutput) => void - ): Promise | void { - const command = new DeleteNetworkInsightsAccessScopeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified Network Access Scope analysis.

- */ - public deleteNetworkInsightsAccessScopeAnalysis( + + /** + * @see {@link DeleteNetworkInsightsAccessScopeAnalysisCommand} + */ + deleteNetworkInsightsAccessScopeAnalysis( args: DeleteNetworkInsightsAccessScopeAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNetworkInsightsAccessScopeAnalysis( + deleteNetworkInsightsAccessScopeAnalysis( args: DeleteNetworkInsightsAccessScopeAnalysisCommandInput, cb: (err: any, data?: DeleteNetworkInsightsAccessScopeAnalysisCommandOutput) => void ): void; - public deleteNetworkInsightsAccessScopeAnalysis( + deleteNetworkInsightsAccessScopeAnalysis( args: DeleteNetworkInsightsAccessScopeAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNetworkInsightsAccessScopeAnalysisCommandOutput) => void ): void; - public deleteNetworkInsightsAccessScopeAnalysis( - args: DeleteNetworkInsightsAccessScopeAnalysisCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteNetworkInsightsAccessScopeAnalysisCommandOutput) => void), - cb?: (err: any, data?: DeleteNetworkInsightsAccessScopeAnalysisCommandOutput) => void - ): Promise | void { - const command = new DeleteNetworkInsightsAccessScopeAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified network insights analysis.

- */ - public deleteNetworkInsightsAnalysis( + + /** + * @see {@link DeleteNetworkInsightsAnalysisCommand} + */ + deleteNetworkInsightsAnalysis( args: DeleteNetworkInsightsAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNetworkInsightsAnalysis( + deleteNetworkInsightsAnalysis( args: DeleteNetworkInsightsAnalysisCommandInput, cb: (err: any, data?: DeleteNetworkInsightsAnalysisCommandOutput) => void ): void; - public deleteNetworkInsightsAnalysis( + deleteNetworkInsightsAnalysis( args: DeleteNetworkInsightsAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNetworkInsightsAnalysisCommandOutput) => void ): void; - public deleteNetworkInsightsAnalysis( - args: DeleteNetworkInsightsAnalysisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNetworkInsightsAnalysisCommandOutput) => void), - cb?: (err: any, data?: DeleteNetworkInsightsAnalysisCommandOutput) => void - ): Promise | void { - const command = new DeleteNetworkInsightsAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified path.

- */ - public deleteNetworkInsightsPath( + + /** + * @see {@link DeleteNetworkInsightsPathCommand} + */ + deleteNetworkInsightsPath( args: DeleteNetworkInsightsPathCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNetworkInsightsPath( + deleteNetworkInsightsPath( args: DeleteNetworkInsightsPathCommandInput, cb: (err: any, data?: DeleteNetworkInsightsPathCommandOutput) => void ): void; - public deleteNetworkInsightsPath( + deleteNetworkInsightsPath( args: DeleteNetworkInsightsPathCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNetworkInsightsPathCommandOutput) => void ): void; - public deleteNetworkInsightsPath( - args: DeleteNetworkInsightsPathCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNetworkInsightsPathCommandOutput) => void), - cb?: (err: any, data?: DeleteNetworkInsightsPathCommandOutput) => void - ): Promise | void { - const command = new DeleteNetworkInsightsPathCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified network interface. You must detach the network interface before you can delete it.

- */ - public deleteNetworkInterface( + + /** + * @see {@link DeleteNetworkInterfaceCommand} + */ + deleteNetworkInterface( args: DeleteNetworkInterfaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNetworkInterface( + deleteNetworkInterface( args: DeleteNetworkInterfaceCommandInput, cb: (err: any, data?: DeleteNetworkInterfaceCommandOutput) => void ): void; - public deleteNetworkInterface( + deleteNetworkInterface( args: DeleteNetworkInterfaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNetworkInterfaceCommandOutput) => void ): void; - public deleteNetworkInterface( - args: DeleteNetworkInterfaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNetworkInterfaceCommandOutput) => void), - cb?: (err: any, data?: DeleteNetworkInterfaceCommandOutput) => void - ): Promise | void { - const command = new DeleteNetworkInterfaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a permission for a network interface. By default, you cannot delete the - * permission if the account for which you're removing the permission has attached the - * network interface to an instance. However, you can force delete the permission, - * regardless of any attachment.

- */ - public deleteNetworkInterfacePermission( + + /** + * @see {@link DeleteNetworkInterfacePermissionCommand} + */ + deleteNetworkInterfacePermission( args: DeleteNetworkInterfacePermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNetworkInterfacePermission( + deleteNetworkInterfacePermission( args: DeleteNetworkInterfacePermissionCommandInput, cb: (err: any, data?: DeleteNetworkInterfacePermissionCommandOutput) => void ): void; - public deleteNetworkInterfacePermission( + deleteNetworkInterfacePermission( args: DeleteNetworkInterfacePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNetworkInterfacePermissionCommandOutput) => void ): void; - public deleteNetworkInterfacePermission( - args: DeleteNetworkInterfacePermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNetworkInterfacePermissionCommandOutput) => void), - cb?: (err: any, data?: DeleteNetworkInterfacePermissionCommandOutput) => void - ): Promise | void { - const command = new DeleteNetworkInterfacePermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified placement group. You must terminate all instances in the - * placement group before you can delete the placement group. For more information, see - * Placement groups in the Amazon EC2 User Guide.

- */ - public deletePlacementGroup( + + /** + * @see {@link DeletePlacementGroupCommand} + */ + deletePlacementGroup( args: DeletePlacementGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePlacementGroup( + deletePlacementGroup( args: DeletePlacementGroupCommandInput, cb: (err: any, data?: DeletePlacementGroupCommandOutput) => void ): void; - public deletePlacementGroup( + deletePlacementGroup( args: DeletePlacementGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePlacementGroupCommandOutput) => void ): void; - public deletePlacementGroup( - args: DeletePlacementGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePlacementGroupCommandOutput) => void), - cb?: (err: any, data?: DeletePlacementGroupCommandOutput) => void - ): Promise | void { - const command = new DeletePlacementGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only.

- */ - public deletePublicIpv4Pool( + + /** + * @see {@link DeletePublicIpv4PoolCommand} + */ + deletePublicIpv4Pool( args: DeletePublicIpv4PoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePublicIpv4Pool( + deletePublicIpv4Pool( args: DeletePublicIpv4PoolCommandInput, cb: (err: any, data?: DeletePublicIpv4PoolCommandOutput) => void ): void; - public deletePublicIpv4Pool( + deletePublicIpv4Pool( args: DeletePublicIpv4PoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePublicIpv4PoolCommandOutput) => void ): void; - public deletePublicIpv4Pool( - args: DeletePublicIpv4PoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePublicIpv4PoolCommandOutput) => void), - cb?: (err: any, data?: DeletePublicIpv4PoolCommandOutput) => void - ): Promise | void { - const command = new DeletePublicIpv4PoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the queued purchases for the specified Reserved Instances.

- */ - public deleteQueuedReservedInstances( + + /** + * @see {@link DeleteQueuedReservedInstancesCommand} + */ + deleteQueuedReservedInstances( args: DeleteQueuedReservedInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteQueuedReservedInstances( + deleteQueuedReservedInstances( args: DeleteQueuedReservedInstancesCommandInput, cb: (err: any, data?: DeleteQueuedReservedInstancesCommandOutput) => void ): void; - public deleteQueuedReservedInstances( + deleteQueuedReservedInstances( args: DeleteQueuedReservedInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteQueuedReservedInstancesCommandOutput) => void ): void; - public deleteQueuedReservedInstances( - args: DeleteQueuedReservedInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteQueuedReservedInstancesCommandOutput) => void), - cb?: (err: any, data?: DeleteQueuedReservedInstancesCommandOutput) => void - ): Promise | void { - const command = new DeleteQueuedReservedInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified route from the specified route table.

- */ - public deleteRoute(args: DeleteRouteCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteRoute(args: DeleteRouteCommandInput, cb: (err: any, data?: DeleteRouteCommandOutput) => void): void; - public deleteRoute( + + /** + * @see {@link DeleteRouteCommand} + */ + deleteRoute(args: DeleteRouteCommandInput, options?: __HttpHandlerOptions): Promise; + deleteRoute(args: DeleteRouteCommandInput, cb: (err: any, data?: DeleteRouteCommandOutput) => void): void; + deleteRoute( args: DeleteRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRouteCommandOutput) => void ): void; - public deleteRoute( - args: DeleteRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRouteCommandOutput) => void), - cb?: (err: any, data?: DeleteRouteCommandOutput) => void - ): Promise | void { - const command = new DeleteRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.

- */ - public deleteRouteTable( + + /** + * @see {@link DeleteRouteTableCommand} + */ + deleteRouteTable( args: DeleteRouteTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRouteTable( + deleteRouteTable( args: DeleteRouteTableCommandInput, cb: (err: any, data?: DeleteRouteTableCommandOutput) => void ): void; - public deleteRouteTable( + deleteRouteTable( args: DeleteRouteTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRouteTableCommandOutput) => void ): void; - public deleteRouteTable( - args: DeleteRouteTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRouteTableCommandOutput) => void), - cb?: (err: any, data?: DeleteRouteTableCommandOutput) => void - ): Promise | void { - const command = new DeleteRouteTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a security group.

- *

If you attempt to delete a security group that is associated with an instance, or is - * referenced by another security group, the operation fails with - * InvalidGroup.InUse in EC2-Classic or - * DependencyViolation in EC2-VPC.

- * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- */ - public deleteSecurityGroup( + + /** + * @see {@link DeleteSecurityGroupCommand} + */ + deleteSecurityGroup( args: DeleteSecurityGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSecurityGroup( + deleteSecurityGroup( args: DeleteSecurityGroupCommandInput, cb: (err: any, data?: DeleteSecurityGroupCommandOutput) => void ): void; - public deleteSecurityGroup( + deleteSecurityGroup( args: DeleteSecurityGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSecurityGroupCommandOutput) => void ): void; - public deleteSecurityGroup( - args: DeleteSecurityGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSecurityGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteSecurityGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteSecurityGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified snapshot.

- *

When you make periodic snapshots of a volume, the snapshots are incremental, and only the - * blocks on the device that have changed since your last snapshot are saved in the new snapshot. - * When you delete a snapshot, only the data not needed for any other snapshot is removed. So - * regardless of which prior snapshots have been deleted, all active snapshots will have access - * to all the information needed to restore the volume.

- *

You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. - * You must first de-register the AMI before you can delete the snapshot.

- *

For more information, see Delete an Amazon EBS snapshot in the - * Amazon Elastic Compute Cloud User Guide.

- */ - public deleteSnapshot( + + /** + * @see {@link DeleteSnapshotCommand} + */ + deleteSnapshot( args: DeleteSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSnapshot( - args: DeleteSnapshotCommandInput, - cb: (err: any, data?: DeleteSnapshotCommandOutput) => void - ): void; - public deleteSnapshot( + deleteSnapshot(args: DeleteSnapshotCommandInput, cb: (err: any, data?: DeleteSnapshotCommandOutput) => void): void; + deleteSnapshot( args: DeleteSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSnapshotCommandOutput) => void ): void; - public deleteSnapshot( - args: DeleteSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSnapshotCommandOutput) => void), - cb?: (err: any, data?: DeleteSnapshotCommandOutput) => void - ): Promise | void { - const command = new DeleteSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the data feed for Spot Instances.

- */ - public deleteSpotDatafeedSubscription( + + /** + * @see {@link DeleteSpotDatafeedSubscriptionCommand} + */ + deleteSpotDatafeedSubscription( args: DeleteSpotDatafeedSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSpotDatafeedSubscription( + deleteSpotDatafeedSubscription( args: DeleteSpotDatafeedSubscriptionCommandInput, cb: (err: any, data?: DeleteSpotDatafeedSubscriptionCommandOutput) => void ): void; - public deleteSpotDatafeedSubscription( + deleteSpotDatafeedSubscription( args: DeleteSpotDatafeedSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSpotDatafeedSubscriptionCommandOutput) => void ): void; - public deleteSpotDatafeedSubscription( - args: DeleteSpotDatafeedSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSpotDatafeedSubscriptionCommandOutput) => void), - cb?: (err: any, data?: DeleteSpotDatafeedSubscriptionCommandOutput) => void - ): Promise | void { - const command = new DeleteSpotDatafeedSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

- */ - public deleteSubnet( - args: DeleteSubnetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteSubnet(args: DeleteSubnetCommandInput, cb: (err: any, data?: DeleteSubnetCommandOutput) => void): void; - public deleteSubnet( + + /** + * @see {@link DeleteSubnetCommand} + */ + deleteSubnet(args: DeleteSubnetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteSubnet(args: DeleteSubnetCommandInput, cb: (err: any, data?: DeleteSubnetCommandOutput) => void): void; + deleteSubnet( args: DeleteSubnetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSubnetCommandOutput) => void ): void; - public deleteSubnet( - args: DeleteSubnetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSubnetCommandOutput) => void), - cb?: (err: any, data?: DeleteSubnetCommandOutput) => void - ): Promise | void { - const command = new DeleteSubnetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a subnet CIDR reservation.

- */ - public deleteSubnetCidrReservation( + + /** + * @see {@link DeleteSubnetCidrReservationCommand} + */ + deleteSubnetCidrReservation( args: DeleteSubnetCidrReservationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSubnetCidrReservation( + deleteSubnetCidrReservation( args: DeleteSubnetCidrReservationCommandInput, cb: (err: any, data?: DeleteSubnetCidrReservationCommandOutput) => void ): void; - public deleteSubnetCidrReservation( + deleteSubnetCidrReservation( args: DeleteSubnetCidrReservationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSubnetCidrReservationCommandOutput) => void ): void; - public deleteSubnetCidrReservation( - args: DeleteSubnetCidrReservationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSubnetCidrReservationCommandOutput) => void), - cb?: (err: any, data?: DeleteSubnetCidrReservationCommandOutput) => void - ): Promise | void { - const command = new DeleteSubnetCidrReservationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified set of tags from the specified set of resources.

- *

To list the current tags, use DescribeTags. For more information about - * tags, see Tag - * your Amazon EC2 resources in the Amazon Elastic Compute Cloud User - * Guide.

- */ - public deleteTags(args: DeleteTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteTags(args: DeleteTagsCommandInput, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void; - public deleteTags( + + /** + * @see {@link DeleteTagsCommand} + */ + deleteTags(args: DeleteTagsCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTags(args: DeleteTagsCommandInput, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void; + deleteTags( args: DeleteTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTagsCommandOutput) => void ): void; - public deleteTags( - args: DeleteTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTagsCommandOutput) => void), - cb?: (err: any, data?: DeleteTagsCommandOutput) => void - ): Promise | void { - const command = new DeleteTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified Traffic Mirror filter.

- *

You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.

- */ - public deleteTrafficMirrorFilter( + + /** + * @see {@link DeleteTrafficMirrorFilterCommand} + */ + deleteTrafficMirrorFilter( args: DeleteTrafficMirrorFilterCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTrafficMirrorFilter( + deleteTrafficMirrorFilter( args: DeleteTrafficMirrorFilterCommandInput, cb: (err: any, data?: DeleteTrafficMirrorFilterCommandOutput) => void ): void; - public deleteTrafficMirrorFilter( + deleteTrafficMirrorFilter( args: DeleteTrafficMirrorFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTrafficMirrorFilterCommandOutput) => void ): void; - public deleteTrafficMirrorFilter( - args: DeleteTrafficMirrorFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTrafficMirrorFilterCommandOutput) => void), - cb?: (err: any, data?: DeleteTrafficMirrorFilterCommandOutput) => void - ): Promise | void { - const command = new DeleteTrafficMirrorFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified Traffic Mirror rule.

- */ - public deleteTrafficMirrorFilterRule( + + /** + * @see {@link DeleteTrafficMirrorFilterRuleCommand} + */ + deleteTrafficMirrorFilterRule( args: DeleteTrafficMirrorFilterRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTrafficMirrorFilterRule( + deleteTrafficMirrorFilterRule( args: DeleteTrafficMirrorFilterRuleCommandInput, cb: (err: any, data?: DeleteTrafficMirrorFilterRuleCommandOutput) => void ): void; - public deleteTrafficMirrorFilterRule( + deleteTrafficMirrorFilterRule( args: DeleteTrafficMirrorFilterRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTrafficMirrorFilterRuleCommandOutput) => void ): void; - public deleteTrafficMirrorFilterRule( - args: DeleteTrafficMirrorFilterRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTrafficMirrorFilterRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteTrafficMirrorFilterRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteTrafficMirrorFilterRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified Traffic Mirror session.

- */ - public deleteTrafficMirrorSession( + + /** + * @see {@link DeleteTrafficMirrorSessionCommand} + */ + deleteTrafficMirrorSession( args: DeleteTrafficMirrorSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTrafficMirrorSession( + deleteTrafficMirrorSession( args: DeleteTrafficMirrorSessionCommandInput, cb: (err: any, data?: DeleteTrafficMirrorSessionCommandOutput) => void ): void; - public deleteTrafficMirrorSession( + deleteTrafficMirrorSession( args: DeleteTrafficMirrorSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTrafficMirrorSessionCommandOutput) => void ): void; - public deleteTrafficMirrorSession( - args: DeleteTrafficMirrorSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTrafficMirrorSessionCommandOutput) => void), - cb?: (err: any, data?: DeleteTrafficMirrorSessionCommandOutput) => void - ): Promise | void { - const command = new DeleteTrafficMirrorSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified Traffic Mirror target.

- *

You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.

- */ - public deleteTrafficMirrorTarget( + + /** + * @see {@link DeleteTrafficMirrorTargetCommand} + */ + deleteTrafficMirrorTarget( args: DeleteTrafficMirrorTargetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTrafficMirrorTarget( + deleteTrafficMirrorTarget( args: DeleteTrafficMirrorTargetCommandInput, cb: (err: any, data?: DeleteTrafficMirrorTargetCommandOutput) => void ): void; - public deleteTrafficMirrorTarget( + deleteTrafficMirrorTarget( args: DeleteTrafficMirrorTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTrafficMirrorTargetCommandOutput) => void ): void; - public deleteTrafficMirrorTarget( - args: DeleteTrafficMirrorTargetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTrafficMirrorTargetCommandOutput) => void), - cb?: (err: any, data?: DeleteTrafficMirrorTargetCommandOutput) => void - ): Promise | void { - const command = new DeleteTrafficMirrorTargetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified transit gateway.

- */ - public deleteTransitGateway( + + /** + * @see {@link DeleteTransitGatewayCommand} + */ + deleteTransitGateway( args: DeleteTransitGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTransitGateway( + deleteTransitGateway( args: DeleteTransitGatewayCommandInput, cb: (err: any, data?: DeleteTransitGatewayCommandOutput) => void ): void; - public deleteTransitGateway( + deleteTransitGateway( args: DeleteTransitGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTransitGatewayCommandOutput) => void ): void; - public deleteTransitGateway( - args: DeleteTransitGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTransitGatewayCommandOutput) => void), - cb?: (err: any, data?: DeleteTransitGatewayCommandOutput) => void - ): Promise | void { - const command = new DeleteTransitGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified Connect attachment. You must first delete any Connect peers for - * the attachment.

- */ - public deleteTransitGatewayConnect( + + /** + * @see {@link DeleteTransitGatewayConnectCommand} + */ + deleteTransitGatewayConnect( args: DeleteTransitGatewayConnectCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTransitGatewayConnect( + deleteTransitGatewayConnect( args: DeleteTransitGatewayConnectCommandInput, cb: (err: any, data?: DeleteTransitGatewayConnectCommandOutput) => void ): void; - public deleteTransitGatewayConnect( + deleteTransitGatewayConnect( args: DeleteTransitGatewayConnectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTransitGatewayConnectCommandOutput) => void ): void; - public deleteTransitGatewayConnect( - args: DeleteTransitGatewayConnectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTransitGatewayConnectCommandOutput) => void), - cb?: (err: any, data?: DeleteTransitGatewayConnectCommandOutput) => void - ): Promise | void { - const command = new DeleteTransitGatewayConnectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified Connect peer.

- */ - public deleteTransitGatewayConnectPeer( + + /** + * @see {@link DeleteTransitGatewayConnectPeerCommand} + */ + deleteTransitGatewayConnectPeer( args: DeleteTransitGatewayConnectPeerCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTransitGatewayConnectPeer( + deleteTransitGatewayConnectPeer( args: DeleteTransitGatewayConnectPeerCommandInput, cb: (err: any, data?: DeleteTransitGatewayConnectPeerCommandOutput) => void ): void; - public deleteTransitGatewayConnectPeer( + deleteTransitGatewayConnectPeer( args: DeleteTransitGatewayConnectPeerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTransitGatewayConnectPeerCommandOutput) => void ): void; - public deleteTransitGatewayConnectPeer( - args: DeleteTransitGatewayConnectPeerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTransitGatewayConnectPeerCommandOutput) => void), - cb?: (err: any, data?: DeleteTransitGatewayConnectPeerCommandOutput) => void - ): Promise | void { - const command = new DeleteTransitGatewayConnectPeerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified transit gateway multicast domain.

- */ - public deleteTransitGatewayMulticastDomain( + + /** + * @see {@link DeleteTransitGatewayMulticastDomainCommand} + */ + deleteTransitGatewayMulticastDomain( args: DeleteTransitGatewayMulticastDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTransitGatewayMulticastDomain( + deleteTransitGatewayMulticastDomain( args: DeleteTransitGatewayMulticastDomainCommandInput, cb: (err: any, data?: DeleteTransitGatewayMulticastDomainCommandOutput) => void ): void; - public deleteTransitGatewayMulticastDomain( + deleteTransitGatewayMulticastDomain( args: DeleteTransitGatewayMulticastDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTransitGatewayMulticastDomainCommandOutput) => void ): void; - public deleteTransitGatewayMulticastDomain( - args: DeleteTransitGatewayMulticastDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTransitGatewayMulticastDomainCommandOutput) => void), - cb?: (err: any, data?: DeleteTransitGatewayMulticastDomainCommandOutput) => void - ): Promise | void { - const command = new DeleteTransitGatewayMulticastDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a transit gateway peering attachment.

- */ - public deleteTransitGatewayPeeringAttachment( + + /** + * @see {@link DeleteTransitGatewayPeeringAttachmentCommand} + */ + deleteTransitGatewayPeeringAttachment( args: DeleteTransitGatewayPeeringAttachmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTransitGatewayPeeringAttachment( + deleteTransitGatewayPeeringAttachment( args: DeleteTransitGatewayPeeringAttachmentCommandInput, cb: (err: any, data?: DeleteTransitGatewayPeeringAttachmentCommandOutput) => void ): void; - public deleteTransitGatewayPeeringAttachment( + deleteTransitGatewayPeeringAttachment( args: DeleteTransitGatewayPeeringAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTransitGatewayPeeringAttachmentCommandOutput) => void ): void; - public deleteTransitGatewayPeeringAttachment( - args: DeleteTransitGatewayPeeringAttachmentCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteTransitGatewayPeeringAttachmentCommandOutput) => void), - cb?: (err: any, data?: DeleteTransitGatewayPeeringAttachmentCommandOutput) => void - ): Promise | void { - const command = new DeleteTransitGatewayPeeringAttachmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified transit gateway policy table.

- */ - public deleteTransitGatewayPolicyTable( + + /** + * @see {@link DeleteTransitGatewayPolicyTableCommand} + */ + deleteTransitGatewayPolicyTable( args: DeleteTransitGatewayPolicyTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTransitGatewayPolicyTable( + deleteTransitGatewayPolicyTable( args: DeleteTransitGatewayPolicyTableCommandInput, cb: (err: any, data?: DeleteTransitGatewayPolicyTableCommandOutput) => void ): void; - public deleteTransitGatewayPolicyTable( + deleteTransitGatewayPolicyTable( args: DeleteTransitGatewayPolicyTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTransitGatewayPolicyTableCommandOutput) => void ): void; - public deleteTransitGatewayPolicyTable( - args: DeleteTransitGatewayPolicyTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTransitGatewayPolicyTableCommandOutput) => void), - cb?: (err: any, data?: DeleteTransitGatewayPolicyTableCommandOutput) => void - ): Promise | void { - const command = new DeleteTransitGatewayPolicyTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a reference (route) to a prefix list in a specified transit gateway route table.

- */ - public deleteTransitGatewayPrefixListReference( + + /** + * @see {@link DeleteTransitGatewayPrefixListReferenceCommand} + */ + deleteTransitGatewayPrefixListReference( args: DeleteTransitGatewayPrefixListReferenceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTransitGatewayPrefixListReference( + deleteTransitGatewayPrefixListReference( args: DeleteTransitGatewayPrefixListReferenceCommandInput, cb: (err: any, data?: DeleteTransitGatewayPrefixListReferenceCommandOutput) => void ): void; - public deleteTransitGatewayPrefixListReference( + deleteTransitGatewayPrefixListReference( args: DeleteTransitGatewayPrefixListReferenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTransitGatewayPrefixListReferenceCommandOutput) => void ): void; - public deleteTransitGatewayPrefixListReference( - args: DeleteTransitGatewayPrefixListReferenceCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteTransitGatewayPrefixListReferenceCommandOutput) => void), - cb?: (err: any, data?: DeleteTransitGatewayPrefixListReferenceCommandOutput) => void - ): Promise | void { - const command = new DeleteTransitGatewayPrefixListReferenceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified route from the specified transit gateway route table.

- */ - public deleteTransitGatewayRoute( + + /** + * @see {@link DeleteTransitGatewayRouteCommand} + */ + deleteTransitGatewayRoute( args: DeleteTransitGatewayRouteCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTransitGatewayRoute( + deleteTransitGatewayRoute( args: DeleteTransitGatewayRouteCommandInput, cb: (err: any, data?: DeleteTransitGatewayRouteCommandOutput) => void ): void; - public deleteTransitGatewayRoute( + deleteTransitGatewayRoute( args: DeleteTransitGatewayRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTransitGatewayRouteCommandOutput) => void ): void; - public deleteTransitGatewayRoute( - args: DeleteTransitGatewayRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTransitGatewayRouteCommandOutput) => void), - cb?: (err: any, data?: DeleteTransitGatewayRouteCommandOutput) => void - ): Promise | void { - const command = new DeleteTransitGatewayRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified transit gateway route table. You must disassociate the route table from any - * transit gateway route tables before you can delete it.

- */ - public deleteTransitGatewayRouteTable( + + /** + * @see {@link DeleteTransitGatewayRouteTableCommand} + */ + deleteTransitGatewayRouteTable( args: DeleteTransitGatewayRouteTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTransitGatewayRouteTable( + deleteTransitGatewayRouteTable( args: DeleteTransitGatewayRouteTableCommandInput, cb: (err: any, data?: DeleteTransitGatewayRouteTableCommandOutput) => void ): void; - public deleteTransitGatewayRouteTable( + deleteTransitGatewayRouteTable( args: DeleteTransitGatewayRouteTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTransitGatewayRouteTableCommandOutput) => void ): void; - public deleteTransitGatewayRouteTable( - args: DeleteTransitGatewayRouteTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTransitGatewayRouteTableCommandOutput) => void), - cb?: (err: any, data?: DeleteTransitGatewayRouteTableCommandOutput) => void - ): Promise | void { - const command = new DeleteTransitGatewayRouteTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Advertises to the transit gateway that a transit gateway route table is deleted.

- */ - public deleteTransitGatewayRouteTableAnnouncement( + + /** + * @see {@link DeleteTransitGatewayRouteTableAnnouncementCommand} + */ + deleteTransitGatewayRouteTableAnnouncement( args: DeleteTransitGatewayRouteTableAnnouncementCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTransitGatewayRouteTableAnnouncement( + deleteTransitGatewayRouteTableAnnouncement( args: DeleteTransitGatewayRouteTableAnnouncementCommandInput, cb: (err: any, data?: DeleteTransitGatewayRouteTableAnnouncementCommandOutput) => void ): void; - public deleteTransitGatewayRouteTableAnnouncement( + deleteTransitGatewayRouteTableAnnouncement( args: DeleteTransitGatewayRouteTableAnnouncementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTransitGatewayRouteTableAnnouncementCommandOutput) => void ): void; - public deleteTransitGatewayRouteTableAnnouncement( - args: DeleteTransitGatewayRouteTableAnnouncementCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteTransitGatewayRouteTableAnnouncementCommandOutput) => void), - cb?: (err: any, data?: DeleteTransitGatewayRouteTableAnnouncementCommandOutput) => void - ): Promise | void { - const command = new DeleteTransitGatewayRouteTableAnnouncementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified VPC attachment.

- */ - public deleteTransitGatewayVpcAttachment( + + /** + * @see {@link DeleteTransitGatewayVpcAttachmentCommand} + */ + deleteTransitGatewayVpcAttachment( args: DeleteTransitGatewayVpcAttachmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTransitGatewayVpcAttachment( + deleteTransitGatewayVpcAttachment( args: DeleteTransitGatewayVpcAttachmentCommandInput, cb: (err: any, data?: DeleteTransitGatewayVpcAttachmentCommandOutput) => void ): void; - public deleteTransitGatewayVpcAttachment( + deleteTransitGatewayVpcAttachment( args: DeleteTransitGatewayVpcAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTransitGatewayVpcAttachmentCommandOutput) => void ): void; - public deleteTransitGatewayVpcAttachment( - args: DeleteTransitGatewayVpcAttachmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTransitGatewayVpcAttachmentCommandOutput) => void), - cb?: (err: any, data?: DeleteTransitGatewayVpcAttachmentCommandOutput) => void - ): Promise | void { - const command = new DeleteTransitGatewayVpcAttachmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete an Amazon Web Services Verified Access endpoint.

- */ - public deleteVerifiedAccessEndpoint( + + /** + * @see {@link DeleteVerifiedAccessEndpointCommand} + */ + deleteVerifiedAccessEndpoint( args: DeleteVerifiedAccessEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVerifiedAccessEndpoint( + deleteVerifiedAccessEndpoint( args: DeleteVerifiedAccessEndpointCommandInput, cb: (err: any, data?: DeleteVerifiedAccessEndpointCommandOutput) => void ): void; - public deleteVerifiedAccessEndpoint( + deleteVerifiedAccessEndpoint( args: DeleteVerifiedAccessEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVerifiedAccessEndpointCommandOutput) => void ): void; - public deleteVerifiedAccessEndpoint( - args: DeleteVerifiedAccessEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVerifiedAccessEndpointCommandOutput) => void), - cb?: (err: any, data?: DeleteVerifiedAccessEndpointCommandOutput) => void - ): Promise | void { - const command = new DeleteVerifiedAccessEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete an Amazon Web Services Verified Access group.

- */ - public deleteVerifiedAccessGroup( + + /** + * @see {@link DeleteVerifiedAccessGroupCommand} + */ + deleteVerifiedAccessGroup( args: DeleteVerifiedAccessGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVerifiedAccessGroup( + deleteVerifiedAccessGroup( args: DeleteVerifiedAccessGroupCommandInput, cb: (err: any, data?: DeleteVerifiedAccessGroupCommandOutput) => void ): void; - public deleteVerifiedAccessGroup( + deleteVerifiedAccessGroup( args: DeleteVerifiedAccessGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVerifiedAccessGroupCommandOutput) => void ): void; - public deleteVerifiedAccessGroup( - args: DeleteVerifiedAccessGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVerifiedAccessGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteVerifiedAccessGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteVerifiedAccessGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete an Amazon Web Services Verified Access instance.

- */ - public deleteVerifiedAccessInstance( + + /** + * @see {@link DeleteVerifiedAccessInstanceCommand} + */ + deleteVerifiedAccessInstance( args: DeleteVerifiedAccessInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVerifiedAccessInstance( + deleteVerifiedAccessInstance( args: DeleteVerifiedAccessInstanceCommandInput, cb: (err: any, data?: DeleteVerifiedAccessInstanceCommandOutput) => void ): void; - public deleteVerifiedAccessInstance( + deleteVerifiedAccessInstance( args: DeleteVerifiedAccessInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVerifiedAccessInstanceCommandOutput) => void ): void; - public deleteVerifiedAccessInstance( - args: DeleteVerifiedAccessInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVerifiedAccessInstanceCommandOutput) => void), - cb?: (err: any, data?: DeleteVerifiedAccessInstanceCommandOutput) => void - ): Promise | void { - const command = new DeleteVerifiedAccessInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete an Amazon Web Services Verified Access trust provider.

- */ - public deleteVerifiedAccessTrustProvider( + + /** + * @see {@link DeleteVerifiedAccessTrustProviderCommand} + */ + deleteVerifiedAccessTrustProvider( args: DeleteVerifiedAccessTrustProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVerifiedAccessTrustProvider( + deleteVerifiedAccessTrustProvider( args: DeleteVerifiedAccessTrustProviderCommandInput, cb: (err: any, data?: DeleteVerifiedAccessTrustProviderCommandOutput) => void ): void; - public deleteVerifiedAccessTrustProvider( + deleteVerifiedAccessTrustProvider( args: DeleteVerifiedAccessTrustProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVerifiedAccessTrustProviderCommandOutput) => void ): void; - public deleteVerifiedAccessTrustProvider( - args: DeleteVerifiedAccessTrustProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVerifiedAccessTrustProviderCommandOutput) => void), - cb?: (err: any, data?: DeleteVerifiedAccessTrustProviderCommandOutput) => void - ): Promise | void { - const command = new DeleteVerifiedAccessTrustProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified EBS volume. The volume must be in the available state - * (not attached to an instance).

- *

The volume can remain in the deleting state for several minutes.

- *

For more information, see Delete an Amazon EBS volume in the - * Amazon Elastic Compute Cloud User Guide.

- */ - public deleteVolume( - args: DeleteVolumeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteVolume(args: DeleteVolumeCommandInput, cb: (err: any, data?: DeleteVolumeCommandOutput) => void): void; - public deleteVolume( + + /** + * @see {@link DeleteVolumeCommand} + */ + deleteVolume(args: DeleteVolumeCommandInput, options?: __HttpHandlerOptions): Promise; + deleteVolume(args: DeleteVolumeCommandInput, cb: (err: any, data?: DeleteVolumeCommandOutput) => void): void; + deleteVolume( args: DeleteVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVolumeCommandOutput) => void ): void; - public deleteVolume( - args: DeleteVolumeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVolumeCommandOutput) => void), - cb?: (err: any, data?: DeleteVolumeCommandOutput) => void - ): Promise | void { - const command = new DeleteVolumeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.

- */ - public deleteVpc(args: DeleteVpcCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteVpc(args: DeleteVpcCommandInput, cb: (err: any, data?: DeleteVpcCommandOutput) => void): void; - public deleteVpc( + + /** + * @see {@link DeleteVpcCommand} + */ + deleteVpc(args: DeleteVpcCommandInput, options?: __HttpHandlerOptions): Promise; + deleteVpc(args: DeleteVpcCommandInput, cb: (err: any, data?: DeleteVpcCommandOutput) => void): void; + deleteVpc( args: DeleteVpcCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVpcCommandOutput) => void ): void; - public deleteVpc( - args: DeleteVpcCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVpcCommandOutput) => void), - cb?: (err: any, data?: DeleteVpcCommandOutput) => void - ): Promise | void { - const command = new DeleteVpcCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified VPC endpoint connection notifications.

- */ - public deleteVpcEndpointConnectionNotifications( + + /** + * @see {@link DeleteVpcEndpointConnectionNotificationsCommand} + */ + deleteVpcEndpointConnectionNotifications( args: DeleteVpcEndpointConnectionNotificationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVpcEndpointConnectionNotifications( + deleteVpcEndpointConnectionNotifications( args: DeleteVpcEndpointConnectionNotificationsCommandInput, cb: (err: any, data?: DeleteVpcEndpointConnectionNotificationsCommandOutput) => void ): void; - public deleteVpcEndpointConnectionNotifications( + deleteVpcEndpointConnectionNotifications( args: DeleteVpcEndpointConnectionNotificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVpcEndpointConnectionNotificationsCommandOutput) => void ): void; - public deleteVpcEndpointConnectionNotifications( - args: DeleteVpcEndpointConnectionNotificationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteVpcEndpointConnectionNotificationsCommandOutput) => void), - cb?: (err: any, data?: DeleteVpcEndpointConnectionNotificationsCommandOutput) => void - ): Promise | void { - const command = new DeleteVpcEndpointConnectionNotificationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified VPC endpoints.

- *

When you delete a gateway endpoint, we delete the endpoint routes in the route tables for the endpoint.

- *

When you delete a Gateway Load Balancer endpoint, we delete its endpoint network interfaces. - * You can only delete Gateway Load Balancer endpoints when the routes that are associated with the endpoint are deleted.

- *

When you delete an interface endpoint, we delete its endpoint network interfaces.

- */ - public deleteVpcEndpoints( + + /** + * @see {@link DeleteVpcEndpointsCommand} + */ + deleteVpcEndpoints( args: DeleteVpcEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVpcEndpoints( + deleteVpcEndpoints( args: DeleteVpcEndpointsCommandInput, cb: (err: any, data?: DeleteVpcEndpointsCommandOutput) => void ): void; - public deleteVpcEndpoints( + deleteVpcEndpoints( args: DeleteVpcEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVpcEndpointsCommandOutput) => void ): void; - public deleteVpcEndpoints( - args: DeleteVpcEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVpcEndpointsCommandOutput) => void), - cb?: (err: any, data?: DeleteVpcEndpointsCommandOutput) => void - ): Promise | void { - const command = new DeleteVpcEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified VPC endpoint service configurations. Before you can delete - * an endpoint service configuration, you must reject any Available or - * PendingAcceptance interface endpoint connections that are attached to - * the service.

- */ - public deleteVpcEndpointServiceConfigurations( + + /** + * @see {@link DeleteVpcEndpointServiceConfigurationsCommand} + */ + deleteVpcEndpointServiceConfigurations( args: DeleteVpcEndpointServiceConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVpcEndpointServiceConfigurations( + deleteVpcEndpointServiceConfigurations( args: DeleteVpcEndpointServiceConfigurationsCommandInput, cb: (err: any, data?: DeleteVpcEndpointServiceConfigurationsCommandOutput) => void ): void; - public deleteVpcEndpointServiceConfigurations( + deleteVpcEndpointServiceConfigurations( args: DeleteVpcEndpointServiceConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVpcEndpointServiceConfigurationsCommandOutput) => void ): void; - public deleteVpcEndpointServiceConfigurations( - args: DeleteVpcEndpointServiceConfigurationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteVpcEndpointServiceConfigurationsCommandOutput) => void), - cb?: (err: any, data?: DeleteVpcEndpointServiceConfigurationsCommandOutput) => void - ): Promise | void { - const command = new DeleteVpcEndpointServiceConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a VPC peering connection. Either the owner of the requester VPC or the owner - * of the accepter VPC can delete the VPC peering connection if it's in the - * active state. The owner of the requester VPC can delete a VPC peering - * connection in the pending-acceptance state. You cannot delete a VPC peering - * connection that's in the failed state.

- */ - public deleteVpcPeeringConnection( + + /** + * @see {@link DeleteVpcPeeringConnectionCommand} + */ + deleteVpcPeeringConnection( args: DeleteVpcPeeringConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVpcPeeringConnection( + deleteVpcPeeringConnection( args: DeleteVpcPeeringConnectionCommandInput, cb: (err: any, data?: DeleteVpcPeeringConnectionCommandOutput) => void ): void; - public deleteVpcPeeringConnection( + deleteVpcPeeringConnection( args: DeleteVpcPeeringConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVpcPeeringConnectionCommandOutput) => void ): void; - public deleteVpcPeeringConnection( - args: DeleteVpcPeeringConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVpcPeeringConnectionCommandOutput) => void), - cb?: (err: any, data?: DeleteVpcPeeringConnectionCommandOutput) => void - ): Promise | void { - const command = new DeleteVpcPeeringConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified VPN connection.

- *

If you're deleting the VPC and its associated components, we recommend that you detach - * the virtual private gateway from the VPC and delete the VPC before deleting the VPN - * connection. If you believe that the tunnel credentials for your VPN connection have been - * compromised, you can delete the VPN connection and create a new one that has new keys, - * without needing to delete the VPC or virtual private gateway. If you create a new VPN - * connection, you must reconfigure the customer gateway device using the new configuration - * information returned with the new VPN connection ID.

- *

For certificate-based authentication, delete all Certificate Manager (ACM) private - * certificates used for the Amazon Web Services-side tunnel endpoints for the VPN - * connection before deleting the VPN connection.

- */ - public deleteVpnConnection( + + /** + * @see {@link DeleteVpnConnectionCommand} + */ + deleteVpnConnection( args: DeleteVpnConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVpnConnection( + deleteVpnConnection( args: DeleteVpnConnectionCommandInput, cb: (err: any, data?: DeleteVpnConnectionCommandOutput) => void ): void; - public deleteVpnConnection( + deleteVpnConnection( args: DeleteVpnConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVpnConnectionCommandOutput) => void ): void; - public deleteVpnConnection( - args: DeleteVpnConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVpnConnectionCommandOutput) => void), - cb?: (err: any, data?: DeleteVpnConnectionCommandOutput) => void - ): Promise | void { - const command = new DeleteVpnConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified static route associated with a VPN connection between an - * existing virtual private gateway and a VPN customer gateway. The static route allows - * traffic to be routed from the virtual private gateway to the VPN customer - * gateway.

- */ - public deleteVpnConnectionRoute( + + /** + * @see {@link DeleteVpnConnectionRouteCommand} + */ + deleteVpnConnectionRoute( args: DeleteVpnConnectionRouteCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVpnConnectionRoute( + deleteVpnConnectionRoute( args: DeleteVpnConnectionRouteCommandInput, cb: (err: any, data?: DeleteVpnConnectionRouteCommandOutput) => void ): void; - public deleteVpnConnectionRoute( + deleteVpnConnectionRoute( args: DeleteVpnConnectionRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVpnConnectionRouteCommandOutput) => void ): void; - public deleteVpnConnectionRoute( - args: DeleteVpnConnectionRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVpnConnectionRouteCommandOutput) => void), - cb?: (err: any, data?: DeleteVpnConnectionRouteCommandOutput) => void - ): Promise | void { - const command = new DeleteVpnConnectionRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified virtual private gateway. You must first detach the virtual - * private gateway from the VPC. Note that you don't need to delete the virtual private - * gateway if you plan to delete and recreate the VPN connection between your VPC and your - * network.

- */ - public deleteVpnGateway( + + /** + * @see {@link DeleteVpnGatewayCommand} + */ + deleteVpnGateway( args: DeleteVpnGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVpnGateway( + deleteVpnGateway( args: DeleteVpnGatewayCommandInput, cb: (err: any, data?: DeleteVpnGatewayCommandOutput) => void ): void; - public deleteVpnGateway( + deleteVpnGateway( args: DeleteVpnGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVpnGatewayCommandOutput) => void ): void; - public deleteVpnGateway( - args: DeleteVpnGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVpnGatewayCommandOutput) => void), - cb?: (err: any, data?: DeleteVpnGatewayCommandOutput) => void - ): Promise | void { - const command = new DeleteVpnGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Releases the specified address range that you provisioned for use with your Amazon Web Services resources - * through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.

- *

Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its - * address range.

- */ - public deprovisionByoipCidr( + + /** + * @see {@link DeprovisionByoipCidrCommand} + */ + deprovisionByoipCidr( args: DeprovisionByoipCidrCommandInput, options?: __HttpHandlerOptions ): Promise; - public deprovisionByoipCidr( + deprovisionByoipCidr( args: DeprovisionByoipCidrCommandInput, cb: (err: any, data?: DeprovisionByoipCidrCommandOutput) => void ): void; - public deprovisionByoipCidr( + deprovisionByoipCidr( args: DeprovisionByoipCidrCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeprovisionByoipCidrCommandOutput) => void ): void; - public deprovisionByoipCidr( - args: DeprovisionByoipCidrCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeprovisionByoipCidrCommandOutput) => void), - cb?: (err: any, data?: DeprovisionByoipCidrCommandOutput) => void - ): Promise | void { - const command = new DeprovisionByoipCidrCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see Deprovision pool CIDRs in the Amazon VPC IPAM User Guide.

- */ - public deprovisionIpamPoolCidr( + + /** + * @see {@link DeprovisionIpamPoolCidrCommand} + */ + deprovisionIpamPoolCidr( args: DeprovisionIpamPoolCidrCommandInput, options?: __HttpHandlerOptions ): Promise; - public deprovisionIpamPoolCidr( + deprovisionIpamPoolCidr( args: DeprovisionIpamPoolCidrCommandInput, cb: (err: any, data?: DeprovisionIpamPoolCidrCommandOutput) => void ): void; - public deprovisionIpamPoolCidr( + deprovisionIpamPoolCidr( args: DeprovisionIpamPoolCidrCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeprovisionIpamPoolCidrCommandOutput) => void ): void; - public deprovisionIpamPoolCidr( - args: DeprovisionIpamPoolCidrCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeprovisionIpamPoolCidrCommandOutput) => void), - cb?: (err: any, data?: DeprovisionIpamPoolCidrCommandOutput) => void - ): Promise | void { - const command = new DeprovisionIpamPoolCidrCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deprovision a CIDR from a public IPv4 pool.

- */ - public deprovisionPublicIpv4PoolCidr( + + /** + * @see {@link DeprovisionPublicIpv4PoolCidrCommand} + */ + deprovisionPublicIpv4PoolCidr( args: DeprovisionPublicIpv4PoolCidrCommandInput, options?: __HttpHandlerOptions ): Promise; - public deprovisionPublicIpv4PoolCidr( + deprovisionPublicIpv4PoolCidr( args: DeprovisionPublicIpv4PoolCidrCommandInput, cb: (err: any, data?: DeprovisionPublicIpv4PoolCidrCommandOutput) => void ): void; - public deprovisionPublicIpv4PoolCidr( + deprovisionPublicIpv4PoolCidr( args: DeprovisionPublicIpv4PoolCidrCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeprovisionPublicIpv4PoolCidrCommandOutput) => void ): void; - public deprovisionPublicIpv4PoolCidr( - args: DeprovisionPublicIpv4PoolCidrCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeprovisionPublicIpv4PoolCidrCommandOutput) => void), - cb?: (err: any, data?: DeprovisionPublicIpv4PoolCidrCommandOutput) => void - ): Promise | void { - const command = new DeprovisionPublicIpv4PoolCidrCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deregisters the specified AMI. After you deregister an AMI, it can't be used to - * launch new instances.

- *

If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained - * in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in - * the Amazon EC2 User Guide.

- *

When you deregister an AMI, it doesn't affect any instances that you've already - * launched from the AMI. You'll continue to incur usage costs for those instances until - * you terminate them.

- *

When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was - * created for the root volume of the instance during the AMI creation process. When you - * deregister an instance store-backed AMI, it doesn't affect the files that you uploaded - * to Amazon S3 when you created the AMI.

- */ - public deregisterImage( + + /** + * @see {@link DeregisterImageCommand} + */ + deregisterImage( args: DeregisterImageCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterImage( - args: DeregisterImageCommandInput, - cb: (err: any, data?: DeregisterImageCommandOutput) => void - ): void; - public deregisterImage( + deregisterImage(args: DeregisterImageCommandInput, cb: (err: any, data?: DeregisterImageCommandOutput) => void): void; + deregisterImage( args: DeregisterImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterImageCommandOutput) => void ): void; - public deregisterImage( - args: DeregisterImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterImageCommandOutput) => void), - cb?: (err: any, data?: DeregisterImageCommandOutput) => void - ): Promise | void { - const command = new DeregisterImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deregisters tag keys to prevent tags that have the specified tag keys from being included - * in scheduled event notifications for resources in the Region.

- */ - public deregisterInstanceEventNotificationAttributes( + + /** + * @see {@link DeregisterInstanceEventNotificationAttributesCommand} + */ + deregisterInstanceEventNotificationAttributes( args: DeregisterInstanceEventNotificationAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterInstanceEventNotificationAttributes( + deregisterInstanceEventNotificationAttributes( args: DeregisterInstanceEventNotificationAttributesCommandInput, cb: (err: any, data?: DeregisterInstanceEventNotificationAttributesCommandOutput) => void ): void; - public deregisterInstanceEventNotificationAttributes( + deregisterInstanceEventNotificationAttributes( args: DeregisterInstanceEventNotificationAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterInstanceEventNotificationAttributesCommandOutput) => void ): void; - public deregisterInstanceEventNotificationAttributes( - args: DeregisterInstanceEventNotificationAttributesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeregisterInstanceEventNotificationAttributesCommandOutput) => void), - cb?: (err: any, data?: DeregisterInstanceEventNotificationAttributesCommandOutput) => void - ): Promise | void { - const command = new DeregisterInstanceEventNotificationAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deregisters the specified members (network interfaces) from the transit gateway multicast group.

- */ - public deregisterTransitGatewayMulticastGroupMembers( + + /** + * @see {@link DeregisterTransitGatewayMulticastGroupMembersCommand} + */ + deregisterTransitGatewayMulticastGroupMembers( args: DeregisterTransitGatewayMulticastGroupMembersCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterTransitGatewayMulticastGroupMembers( + deregisterTransitGatewayMulticastGroupMembers( args: DeregisterTransitGatewayMulticastGroupMembersCommandInput, cb: (err: any, data?: DeregisterTransitGatewayMulticastGroupMembersCommandOutput) => void ): void; - public deregisterTransitGatewayMulticastGroupMembers( + deregisterTransitGatewayMulticastGroupMembers( args: DeregisterTransitGatewayMulticastGroupMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterTransitGatewayMulticastGroupMembersCommandOutput) => void ): void; - public deregisterTransitGatewayMulticastGroupMembers( - args: DeregisterTransitGatewayMulticastGroupMembersCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeregisterTransitGatewayMulticastGroupMembersCommandOutput) => void), - cb?: (err: any, data?: DeregisterTransitGatewayMulticastGroupMembersCommandOutput) => void - ): Promise | void { - const command = new DeregisterTransitGatewayMulticastGroupMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deregisters the specified sources (network interfaces) from the transit gateway multicast group.

- */ - public deregisterTransitGatewayMulticastGroupSources( + + /** + * @see {@link DeregisterTransitGatewayMulticastGroupSourcesCommand} + */ + deregisterTransitGatewayMulticastGroupSources( args: DeregisterTransitGatewayMulticastGroupSourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterTransitGatewayMulticastGroupSources( + deregisterTransitGatewayMulticastGroupSources( args: DeregisterTransitGatewayMulticastGroupSourcesCommandInput, cb: (err: any, data?: DeregisterTransitGatewayMulticastGroupSourcesCommandOutput) => void ): void; - public deregisterTransitGatewayMulticastGroupSources( + deregisterTransitGatewayMulticastGroupSources( args: DeregisterTransitGatewayMulticastGroupSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterTransitGatewayMulticastGroupSourcesCommandOutput) => void ): void; - public deregisterTransitGatewayMulticastGroupSources( - args: DeregisterTransitGatewayMulticastGroupSourcesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeregisterTransitGatewayMulticastGroupSourcesCommandOutput) => void), - cb?: (err: any, data?: DeregisterTransitGatewayMulticastGroupSourcesCommandOutput) => void - ): Promise | void { - const command = new DeregisterTransitGatewayMulticastGroupSourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes attributes of your Amazon Web Services account. The following are the supported account attributes:

- *
    - *
  • - *

    - * supported-platforms: Indicates whether your account can launch instances - * into EC2-Classic and EC2-VPC, or only into EC2-VPC.

    - *
  • - *
  • - *

    - * default-vpc: The ID of the default VPC for your account, or - * none.

    - *
  • - *
  • - *

    - * max-instances: This attribute is no longer supported. The returned - * value does not reflect your actual vCPU limit for running On-Demand Instances. - * For more information, see On-Demand Instance Limits in the - * Amazon Elastic Compute Cloud User Guide.

    - *
  • - *
  • - *

    - * vpc-max-security-groups-per-interface: The maximum number of security groups - * that you can assign to a network interface.

    - *
  • - *
  • - *

    - * max-elastic-ips: The maximum number of Elastic IP addresses that you can - * allocate for use with EC2-Classic.

    - *
  • - *
  • - *

    - * vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can - * allocate for use with EC2-VPC.

    - *
  • - *
- * - *

We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide.

- *
- */ - public describeAccountAttributes( + + /** + * @see {@link DescribeAccountAttributesCommand} + */ + describeAccountAttributes( args: DescribeAccountAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccountAttributes( + describeAccountAttributes( args: DescribeAccountAttributesCommandInput, cb: (err: any, data?: DescribeAccountAttributesCommandOutput) => void ): void; - public describeAccountAttributes( + describeAccountAttributes( args: DescribeAccountAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountAttributesCommandOutput) => void ): void; - public describeAccountAttributes( - args: DescribeAccountAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccountAttributesCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountAttributesCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified Elastic IP addresses or all of your Elastic IP addresses.

- *

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. - * For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

- * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- */ - public describeAddresses( + + /** + * @see {@link DescribeAddressesCommand} + */ + describeAddresses( args: DescribeAddressesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAddresses( + describeAddresses( args: DescribeAddressesCommandInput, cb: (err: any, data?: DescribeAddressesCommandOutput) => void ): void; - public describeAddresses( + describeAddresses( args: DescribeAddressesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAddressesCommandOutput) => void ): void; - public describeAddresses( - args: DescribeAddressesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAddressesCommandOutput) => void), - cb?: (err: any, data?: DescribeAddressesCommandOutput) => void - ): Promise | void { - const command = new DescribeAddressesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications.

- */ - public describeAddressesAttribute( + + /** + * @see {@link DescribeAddressesAttributeCommand} + */ + describeAddressesAttribute( args: DescribeAddressesAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAddressesAttribute( + describeAddressesAttribute( args: DescribeAddressesAttributeCommandInput, cb: (err: any, data?: DescribeAddressesAttributeCommandOutput) => void ): void; - public describeAddressesAttribute( + describeAddressesAttribute( args: DescribeAddressesAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAddressesAttributeCommandOutput) => void ): void; - public describeAddressesAttribute( - args: DescribeAddressesAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAddressesAttributeCommandOutput) => void), - cb?: (err: any, data?: DescribeAddressesAttributeCommandOutput) => void - ): Promise | void { - const command = new DescribeAddressesAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes an Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.

- */ - public describeAddressTransfers( + + /** + * @see {@link DescribeAddressTransfersCommand} + */ + describeAddressTransfers( args: DescribeAddressTransfersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAddressTransfers( + describeAddressTransfers( args: DescribeAddressTransfersCommandInput, cb: (err: any, data?: DescribeAddressTransfersCommandOutput) => void ): void; - public describeAddressTransfers( + describeAddressTransfers( args: DescribeAddressTransfersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAddressTransfersCommandOutput) => void ): void; - public describeAddressTransfers( - args: DescribeAddressTransfersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAddressTransfersCommandOutput) => void), - cb?: (err: any, data?: DescribeAddressTransfersCommandOutput) => void - ): Promise | void { - const command = new DescribeAddressTransfersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the longer ID format settings for all resource types in a specific - * Region. This request is useful for performing a quick audit to determine whether a - * specific Region is fully opted in for longer IDs (17-character IDs).

- *

This request only returns information about resource types that support longer IDs.

- *

The following resource types support longer IDs: bundle | - * conversion-task | customer-gateway | dhcp-options | - * elastic-ip-allocation | elastic-ip-association | - * export-task | flow-log | image | - * import-task | instance | internet-gateway | - * network-acl | network-acl-association | - * network-interface | network-interface-attachment | - * prefix-list | reservation | route-table | - * route-table-association | security-group | - * snapshot | subnet | - * subnet-cidr-block-association | volume | vpc | - * vpc-cidr-block-association | vpc-endpoint | - * vpc-peering-connection | vpn-connection | vpn-gateway.

- */ - public describeAggregateIdFormat( + + /** + * @see {@link DescribeAggregateIdFormatCommand} + */ + describeAggregateIdFormat( args: DescribeAggregateIdFormatCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAggregateIdFormat( + describeAggregateIdFormat( args: DescribeAggregateIdFormatCommandInput, cb: (err: any, data?: DescribeAggregateIdFormatCommandOutput) => void ): void; - public describeAggregateIdFormat( + describeAggregateIdFormat( args: DescribeAggregateIdFormatCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAggregateIdFormatCommandOutput) => void ): void; - public describeAggregateIdFormat( - args: DescribeAggregateIdFormatCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAggregateIdFormatCommandOutput) => void), - cb?: (err: any, data?: DescribeAggregateIdFormatCommandOutput) => void - ): Promise | void { - const command = new DescribeAggregateIdFormatCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to - * you. If there is an event impacting a zone, you can use this request to view the state and any - * provided messages for that zone.

- *

For more information about Availability Zones, Local Zones, and Wavelength Zones, see - * Regions and zones - * in the Amazon Elastic Compute Cloud User Guide.

- */ - public describeAvailabilityZones( + + /** + * @see {@link DescribeAvailabilityZonesCommand} + */ + describeAvailabilityZones( args: DescribeAvailabilityZonesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAvailabilityZones( + describeAvailabilityZones( args: DescribeAvailabilityZonesCommandInput, cb: (err: any, data?: DescribeAvailabilityZonesCommandOutput) => void ): void; - public describeAvailabilityZones( + describeAvailabilityZones( args: DescribeAvailabilityZonesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAvailabilityZonesCommandOutput) => void ): void; - public describeAvailabilityZones( - args: DescribeAvailabilityZonesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAvailabilityZonesCommandOutput) => void), - cb?: (err: any, data?: DescribeAvailabilityZonesCommandOutput) => void - ): Promise | void { - const command = new DescribeAvailabilityZonesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the current Infrastructure Performance metric subscriptions.

- */ - public describeAwsNetworkPerformanceMetricSubscriptions( + + /** + * @see {@link DescribeAwsNetworkPerformanceMetricSubscriptionsCommand} + */ + describeAwsNetworkPerformanceMetricSubscriptions( args: DescribeAwsNetworkPerformanceMetricSubscriptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAwsNetworkPerformanceMetricSubscriptions( + describeAwsNetworkPerformanceMetricSubscriptions( args: DescribeAwsNetworkPerformanceMetricSubscriptionsCommandInput, cb: (err: any, data?: DescribeAwsNetworkPerformanceMetricSubscriptionsCommandOutput) => void ): void; - public describeAwsNetworkPerformanceMetricSubscriptions( + describeAwsNetworkPerformanceMetricSubscriptions( args: DescribeAwsNetworkPerformanceMetricSubscriptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAwsNetworkPerformanceMetricSubscriptionsCommandOutput) => void ): void; - public describeAwsNetworkPerformanceMetricSubscriptions( - args: DescribeAwsNetworkPerformanceMetricSubscriptionsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeAwsNetworkPerformanceMetricSubscriptionsCommandOutput) => void), - cb?: (err: any, data?: DescribeAwsNetworkPerformanceMetricSubscriptionsCommandOutput) => void - ): Promise | void { - const command = new DescribeAwsNetworkPerformanceMetricSubscriptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified bundle tasks or all of your bundle tasks.

- * - *

Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

- *
- */ - public describeBundleTasks( + + /** + * @see {@link DescribeBundleTasksCommand} + */ + describeBundleTasks( args: DescribeBundleTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBundleTasks( + describeBundleTasks( args: DescribeBundleTasksCommandInput, cb: (err: any, data?: DescribeBundleTasksCommandOutput) => void ): void; - public describeBundleTasks( + describeBundleTasks( args: DescribeBundleTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBundleTasksCommandOutput) => void ): void; - public describeBundleTasks( - args: DescribeBundleTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBundleTasksCommandOutput) => void), - cb?: (err: any, data?: DescribeBundleTasksCommandOutput) => void - ): Promise | void { - const command = new DescribeBundleTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.

- *

To describe the address pools that were created when you provisioned the address - * ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools.

- */ - public describeByoipCidrs( + + /** + * @see {@link DescribeByoipCidrsCommand} + */ + describeByoipCidrs( args: DescribeByoipCidrsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeByoipCidrs( + describeByoipCidrs( args: DescribeByoipCidrsCommandInput, cb: (err: any, data?: DescribeByoipCidrsCommandOutput) => void ): void; - public describeByoipCidrs( + describeByoipCidrs( args: DescribeByoipCidrsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeByoipCidrsCommandOutput) => void ): void; - public describeByoipCidrs( - args: DescribeByoipCidrsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeByoipCidrsCommandOutput) => void), - cb?: (err: any, data?: DescribeByoipCidrsCommandOutput) => void - ): Promise | void { - const command = new DescribeByoipCidrsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more Capacity Reservation Fleets.

- */ - public describeCapacityReservationFleets( + + /** + * @see {@link DescribeCapacityReservationFleetsCommand} + */ + describeCapacityReservationFleets( args: DescribeCapacityReservationFleetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCapacityReservationFleets( + describeCapacityReservationFleets( args: DescribeCapacityReservationFleetsCommandInput, cb: (err: any, data?: DescribeCapacityReservationFleetsCommandOutput) => void ): void; - public describeCapacityReservationFleets( + describeCapacityReservationFleets( args: DescribeCapacityReservationFleetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCapacityReservationFleetsCommandOutput) => void ): void; - public describeCapacityReservationFleets( - args: DescribeCapacityReservationFleetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCapacityReservationFleetsCommandOutput) => void), - cb?: (err: any, data?: DescribeCapacityReservationFleetsCommandOutput) => void - ): Promise | void { - const command = new DescribeCapacityReservationFleetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the - * Amazon Web Services Region that you're currently using.

- */ - public describeCapacityReservations( + + /** + * @see {@link DescribeCapacityReservationsCommand} + */ + describeCapacityReservations( args: DescribeCapacityReservationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCapacityReservations( + describeCapacityReservations( args: DescribeCapacityReservationsCommandInput, cb: (err: any, data?: DescribeCapacityReservationsCommandOutput) => void ): void; - public describeCapacityReservations( + describeCapacityReservations( args: DescribeCapacityReservationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCapacityReservationsCommandOutput) => void ): void; - public describeCapacityReservations( - args: DescribeCapacityReservationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCapacityReservationsCommandOutput) => void), - cb?: (err: any, data?: DescribeCapacityReservationsCommandOutput) => void - ): Promise | void { - const command = new DescribeCapacityReservationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more of your carrier gateways.

- */ - public describeCarrierGateways( + + /** + * @see {@link DescribeCarrierGatewaysCommand} + */ + describeCarrierGateways( args: DescribeCarrierGatewaysCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCarrierGateways( + describeCarrierGateways( args: DescribeCarrierGatewaysCommandInput, cb: (err: any, data?: DescribeCarrierGatewaysCommandOutput) => void ): void; - public describeCarrierGateways( + describeCarrierGateways( args: DescribeCarrierGatewaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCarrierGatewaysCommandOutput) => void ): void; - public describeCarrierGateways( - args: DescribeCarrierGatewaysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCarrierGatewaysCommandOutput) => void), - cb?: (err: any, data?: DescribeCarrierGatewaysCommandOutput) => void - ): Promise | void { - const command = new DescribeCarrierGatewaysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more of your linked EC2-Classic instances. This request only returns - * information about EC2-Classic instances linked to a VPC through ClassicLink. You cannot - * use this request to return information about other instances.

- * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- */ - public describeClassicLinkInstances( + + /** + * @see {@link DescribeClassicLinkInstancesCommand} + */ + describeClassicLinkInstances( args: DescribeClassicLinkInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClassicLinkInstances( + describeClassicLinkInstances( args: DescribeClassicLinkInstancesCommandInput, cb: (err: any, data?: DescribeClassicLinkInstancesCommandOutput) => void ): void; - public describeClassicLinkInstances( + describeClassicLinkInstances( args: DescribeClassicLinkInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClassicLinkInstancesCommandOutput) => void ): void; - public describeClassicLinkInstances( - args: DescribeClassicLinkInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClassicLinkInstancesCommandOutput) => void), - cb?: (err: any, data?: DescribeClassicLinkInstancesCommandOutput) => void - ): Promise | void { - const command = new DescribeClassicLinkInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the authorization rules for a specified Client VPN endpoint.

- */ - public describeClientVpnAuthorizationRules( + + /** + * @see {@link DescribeClientVpnAuthorizationRulesCommand} + */ + describeClientVpnAuthorizationRules( args: DescribeClientVpnAuthorizationRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClientVpnAuthorizationRules( + describeClientVpnAuthorizationRules( args: DescribeClientVpnAuthorizationRulesCommandInput, cb: (err: any, data?: DescribeClientVpnAuthorizationRulesCommandOutput) => void ): void; - public describeClientVpnAuthorizationRules( + describeClientVpnAuthorizationRules( args: DescribeClientVpnAuthorizationRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClientVpnAuthorizationRulesCommandOutput) => void ): void; - public describeClientVpnAuthorizationRules( - args: DescribeClientVpnAuthorizationRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClientVpnAuthorizationRulesCommandOutput) => void), - cb?: (err: any, data?: DescribeClientVpnAuthorizationRulesCommandOutput) => void - ): Promise | void { - const command = new DescribeClientVpnAuthorizationRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes active client connections and connections that have been terminated within the last 60 - * minutes for the specified Client VPN endpoint.

- */ - public describeClientVpnConnections( + + /** + * @see {@link DescribeClientVpnConnectionsCommand} + */ + describeClientVpnConnections( args: DescribeClientVpnConnectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClientVpnConnections( + describeClientVpnConnections( args: DescribeClientVpnConnectionsCommandInput, cb: (err: any, data?: DescribeClientVpnConnectionsCommandOutput) => void ): void; - public describeClientVpnConnections( + describeClientVpnConnections( args: DescribeClientVpnConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClientVpnConnectionsCommandOutput) => void ): void; - public describeClientVpnConnections( - args: DescribeClientVpnConnectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClientVpnConnectionsCommandOutput) => void), - cb?: (err: any, data?: DescribeClientVpnConnectionsCommandOutput) => void - ): Promise | void { - const command = new DescribeClientVpnConnectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more Client VPN endpoints in the account.

- */ - public describeClientVpnEndpoints( + + /** + * @see {@link DescribeClientVpnEndpointsCommand} + */ + describeClientVpnEndpoints( args: DescribeClientVpnEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClientVpnEndpoints( + describeClientVpnEndpoints( args: DescribeClientVpnEndpointsCommandInput, cb: (err: any, data?: DescribeClientVpnEndpointsCommandOutput) => void ): void; - public describeClientVpnEndpoints( + describeClientVpnEndpoints( args: DescribeClientVpnEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClientVpnEndpointsCommandOutput) => void ): void; - public describeClientVpnEndpoints( - args: DescribeClientVpnEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClientVpnEndpointsCommandOutput) => void), - cb?: (err: any, data?: DescribeClientVpnEndpointsCommandOutput) => void - ): Promise | void { - const command = new DescribeClientVpnEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the routes for the specified Client VPN endpoint.

- */ - public describeClientVpnRoutes( + + /** + * @see {@link DescribeClientVpnRoutesCommand} + */ + describeClientVpnRoutes( args: DescribeClientVpnRoutesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClientVpnRoutes( + describeClientVpnRoutes( args: DescribeClientVpnRoutesCommandInput, cb: (err: any, data?: DescribeClientVpnRoutesCommandOutput) => void ): void; - public describeClientVpnRoutes( + describeClientVpnRoutes( args: DescribeClientVpnRoutesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClientVpnRoutesCommandOutput) => void ): void; - public describeClientVpnRoutes( - args: DescribeClientVpnRoutesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClientVpnRoutesCommandOutput) => void), - cb?: (err: any, data?: DescribeClientVpnRoutesCommandOutput) => void - ): Promise | void { - const command = new DescribeClientVpnRoutesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the target networks associated with the specified Client VPN endpoint.

- */ - public describeClientVpnTargetNetworks( + + /** + * @see {@link DescribeClientVpnTargetNetworksCommand} + */ + describeClientVpnTargetNetworks( args: DescribeClientVpnTargetNetworksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClientVpnTargetNetworks( + describeClientVpnTargetNetworks( args: DescribeClientVpnTargetNetworksCommandInput, cb: (err: any, data?: DescribeClientVpnTargetNetworksCommandOutput) => void ): void; - public describeClientVpnTargetNetworks( + describeClientVpnTargetNetworks( args: DescribeClientVpnTargetNetworksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClientVpnTargetNetworksCommandOutput) => void ): void; - public describeClientVpnTargetNetworks( - args: DescribeClientVpnTargetNetworksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClientVpnTargetNetworksCommandOutput) => void), - cb?: (err: any, data?: DescribeClientVpnTargetNetworksCommandOutput) => void - ): Promise | void { - const command = new DescribeClientVpnTargetNetworksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified customer-owned address pools or all of your customer-owned address pools.

- */ - public describeCoipPools( + + /** + * @see {@link DescribeCoipPoolsCommand} + */ + describeCoipPools( args: DescribeCoipPoolsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCoipPools( + describeCoipPools( args: DescribeCoipPoolsCommandInput, cb: (err: any, data?: DescribeCoipPoolsCommandOutput) => void ): void; - public describeCoipPools( + describeCoipPools( args: DescribeCoipPoolsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCoipPoolsCommandOutput) => void ): void; - public describeCoipPools( - args: DescribeCoipPoolsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCoipPoolsCommandOutput) => void), - cb?: (err: any, data?: DescribeCoipPoolsCommandOutput) => void - ): Promise | void { - const command = new DescribeCoipPoolsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified conversion tasks or all your conversion tasks. For more information, see the - * VM Import/Export User Guide.

- *

For information about the import manifest referenced by this API action, see VM Import Manifest.

- */ - public describeConversionTasks( + + /** + * @see {@link DescribeConversionTasksCommand} + */ + describeConversionTasks( args: DescribeConversionTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConversionTasks( + describeConversionTasks( args: DescribeConversionTasksCommandInput, cb: (err: any, data?: DescribeConversionTasksCommandOutput) => void ): void; - public describeConversionTasks( + describeConversionTasks( args: DescribeConversionTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConversionTasksCommandOutput) => void ): void; - public describeConversionTasks( - args: DescribeConversionTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConversionTasksCommandOutput) => void), - cb?: (err: any, data?: DescribeConversionTasksCommandOutput) => void - ): Promise | void { - const command = new DescribeConversionTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more of your VPN customer gateways.

- *

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN - * User Guide.

- */ - public describeCustomerGateways( + + /** + * @see {@link DescribeCustomerGatewaysCommand} + */ + describeCustomerGateways( args: DescribeCustomerGatewaysCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCustomerGateways( + describeCustomerGateways( args: DescribeCustomerGatewaysCommandInput, cb: (err: any, data?: DescribeCustomerGatewaysCommandOutput) => void ): void; - public describeCustomerGateways( + describeCustomerGateways( args: DescribeCustomerGatewaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCustomerGatewaysCommandOutput) => void ): void; - public describeCustomerGateways( - args: DescribeCustomerGatewaysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCustomerGatewaysCommandOutput) => void), - cb?: (err: any, data?: DescribeCustomerGatewaysCommandOutput) => void - ): Promise | void { - const command = new DescribeCustomerGatewaysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more of your DHCP options sets.

- *

For more information, see DHCP options sets in the - * Amazon Virtual Private Cloud User Guide.

- */ - public describeDhcpOptions( + + /** + * @see {@link DescribeDhcpOptionsCommand} + */ + describeDhcpOptions( args: DescribeDhcpOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDhcpOptions( + describeDhcpOptions( args: DescribeDhcpOptionsCommandInput, cb: (err: any, data?: DescribeDhcpOptionsCommandOutput) => void ): void; - public describeDhcpOptions( + describeDhcpOptions( args: DescribeDhcpOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDhcpOptionsCommandOutput) => void ): void; - public describeDhcpOptions( - args: DescribeDhcpOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDhcpOptionsCommandOutput) => void), - cb?: (err: any, data?: DescribeDhcpOptionsCommandOutput) => void - ): Promise | void { - const command = new DescribeDhcpOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more of your egress-only internet gateways.

- */ - public describeEgressOnlyInternetGateways( + + /** + * @see {@link DescribeEgressOnlyInternetGatewaysCommand} + */ + describeEgressOnlyInternetGateways( args: DescribeEgressOnlyInternetGatewaysCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEgressOnlyInternetGateways( + describeEgressOnlyInternetGateways( args: DescribeEgressOnlyInternetGatewaysCommandInput, cb: (err: any, data?: DescribeEgressOnlyInternetGatewaysCommandOutput) => void ): void; - public describeEgressOnlyInternetGateways( + describeEgressOnlyInternetGateways( args: DescribeEgressOnlyInternetGatewaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEgressOnlyInternetGatewaysCommandOutput) => void ): void; - public describeEgressOnlyInternetGateways( - args: DescribeEgressOnlyInternetGatewaysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEgressOnlyInternetGatewaysCommandOutput) => void), - cb?: (err: any, data?: DescribeEgressOnlyInternetGatewaysCommandOutput) => void - ): Promise | void { - const command = new DescribeEgressOnlyInternetGatewaysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the Elastic Graphics accelerator associated with your instances. For more information - * about Elastic Graphics, see Amazon Elastic Graphics.

- */ - public describeElasticGpus( + + /** + * @see {@link DescribeElasticGpusCommand} + */ + describeElasticGpus( args: DescribeElasticGpusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeElasticGpus( + describeElasticGpus( args: DescribeElasticGpusCommandInput, cb: (err: any, data?: DescribeElasticGpusCommandOutput) => void ): void; - public describeElasticGpus( + describeElasticGpus( args: DescribeElasticGpusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeElasticGpusCommandOutput) => void ): void; - public describeElasticGpus( - args: DescribeElasticGpusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeElasticGpusCommandOutput) => void), - cb?: (err: any, data?: DescribeElasticGpusCommandOutput) => void - ): Promise | void { - const command = new DescribeElasticGpusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified export image tasks or all of your export image tasks.

- */ - public describeExportImageTasks( + + /** + * @see {@link DescribeExportImageTasksCommand} + */ + describeExportImageTasks( args: DescribeExportImageTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeExportImageTasks( + describeExportImageTasks( args: DescribeExportImageTasksCommandInput, cb: (err: any, data?: DescribeExportImageTasksCommandOutput) => void ): void; - public describeExportImageTasks( + describeExportImageTasks( args: DescribeExportImageTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExportImageTasksCommandOutput) => void ): void; - public describeExportImageTasks( - args: DescribeExportImageTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeExportImageTasksCommandOutput) => void), - cb?: (err: any, data?: DescribeExportImageTasksCommandOutput) => void - ): Promise | void { - const command = new DescribeExportImageTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified export instance tasks or all of your export instance tasks.

- */ - public describeExportTasks( + + /** + * @see {@link DescribeExportTasksCommand} + */ + describeExportTasks( args: DescribeExportTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeExportTasks( + describeExportTasks( args: DescribeExportTasksCommandInput, cb: (err: any, data?: DescribeExportTasksCommandOutput) => void ): void; - public describeExportTasks( + describeExportTasks( args: DescribeExportTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExportTasksCommandOutput) => void ): void; - public describeExportTasks( - args: DescribeExportTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeExportTasksCommandOutput) => void), - cb?: (err: any, data?: DescribeExportTasksCommandOutput) => void - ): Promise | void { - const command = new DescribeExportTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describe details for Windows AMIs that are configured for faster launching.

- */ - public describeFastLaunchImages( + + /** + * @see {@link DescribeFastLaunchImagesCommand} + */ + describeFastLaunchImages( args: DescribeFastLaunchImagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFastLaunchImages( + describeFastLaunchImages( args: DescribeFastLaunchImagesCommandInput, cb: (err: any, data?: DescribeFastLaunchImagesCommandOutput) => void ): void; - public describeFastLaunchImages( + describeFastLaunchImages( args: DescribeFastLaunchImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFastLaunchImagesCommandOutput) => void ): void; - public describeFastLaunchImages( - args: DescribeFastLaunchImagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFastLaunchImagesCommandOutput) => void), - cb?: (err: any, data?: DescribeFastLaunchImagesCommandOutput) => void - ): Promise | void { - const command = new DescribeFastLaunchImagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the state of fast snapshot restores for your snapshots.

- */ - public describeFastSnapshotRestores( + + /** + * @see {@link DescribeFastSnapshotRestoresCommand} + */ + describeFastSnapshotRestores( args: DescribeFastSnapshotRestoresCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFastSnapshotRestores( + describeFastSnapshotRestores( args: DescribeFastSnapshotRestoresCommandInput, cb: (err: any, data?: DescribeFastSnapshotRestoresCommandOutput) => void ): void; - public describeFastSnapshotRestores( + describeFastSnapshotRestores( args: DescribeFastSnapshotRestoresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFastSnapshotRestoresCommandOutput) => void ): void; - public describeFastSnapshotRestores( - args: DescribeFastSnapshotRestoresCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFastSnapshotRestoresCommandOutput) => void), - cb?: (err: any, data?: DescribeFastSnapshotRestoresCommandOutput) => void - ): Promise | void { - const command = new DescribeFastSnapshotRestoresCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the events for the specified EC2 Fleet during the specified time.

- *

EC2 Fleet events are delayed by up to 30 seconds before they can be described. This ensures - * that you can query by the last evaluated time and not miss a recorded event. EC2 Fleet events - * are available for 48 hours.

- *

For more information, see Monitor fleet events using Amazon EventBridge in the - * Amazon EC2 User Guide.

- */ - public describeFleetHistory( + + /** + * @see {@link DescribeFleetHistoryCommand} + */ + describeFleetHistory( args: DescribeFleetHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFleetHistory( + describeFleetHistory( args: DescribeFleetHistoryCommandInput, cb: (err: any, data?: DescribeFleetHistoryCommandOutput) => void ): void; - public describeFleetHistory( + describeFleetHistory( args: DescribeFleetHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetHistoryCommandOutput) => void ): void; - public describeFleetHistory( - args: DescribeFleetHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFleetHistoryCommandOutput) => void), - cb?: (err: any, data?: DescribeFleetHistoryCommandOutput) => void - ): Promise | void { - const command = new DescribeFleetHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the running instances for the specified EC2 Fleet.

- *

For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.

- */ - public describeFleetInstances( + + /** + * @see {@link DescribeFleetInstancesCommand} + */ + describeFleetInstances( args: DescribeFleetInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFleetInstances( + describeFleetInstances( args: DescribeFleetInstancesCommandInput, cb: (err: any, data?: DescribeFleetInstancesCommandOutput) => void ): void; - public describeFleetInstances( + describeFleetInstances( args: DescribeFleetInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetInstancesCommandOutput) => void ): void; - public describeFleetInstances( - args: DescribeFleetInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFleetInstancesCommandOutput) => void), - cb?: (err: any, data?: DescribeFleetInstancesCommandOutput) => void - ): Promise | void { - const command = new DescribeFleetInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified EC2 Fleets or all of your EC2 Fleets.

- *

For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.

- */ - public describeFleets( + + /** + * @see {@link DescribeFleetsCommand} + */ + describeFleets( args: DescribeFleetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFleets( - args: DescribeFleetsCommandInput, - cb: (err: any, data?: DescribeFleetsCommandOutput) => void - ): void; - public describeFleets( + describeFleets(args: DescribeFleetsCommandInput, cb: (err: any, data?: DescribeFleetsCommandOutput) => void): void; + describeFleets( args: DescribeFleetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetsCommandOutput) => void ): void; - public describeFleets( - args: DescribeFleetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFleetsCommandOutput) => void), - cb?: (err: any, data?: DescribeFleetsCommandOutput) => void - ): Promise | void { - const command = new DescribeFleetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more flow logs.

- *

To view the published flow log records, you must view the log destination. For example, - * the CloudWatch Logs log group, the Amazon S3 bucket, or the Kinesis Data Firehose delivery stream.

- */ - public describeFlowLogs( + + /** + * @see {@link DescribeFlowLogsCommand} + */ + describeFlowLogs( args: DescribeFlowLogsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFlowLogs( + describeFlowLogs( args: DescribeFlowLogsCommandInput, cb: (err: any, data?: DescribeFlowLogsCommandOutput) => void ): void; - public describeFlowLogs( + describeFlowLogs( args: DescribeFlowLogsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFlowLogsCommandOutput) => void ): void; - public describeFlowLogs( - args: DescribeFlowLogsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFlowLogsCommandOutput) => void), - cb?: (err: any, data?: DescribeFlowLogsCommandOutput) => void - ): Promise | void { - const command = new DescribeFlowLogsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified attribute of the specified Amazon FPGA Image (AFI).

- */ - public describeFpgaImageAttribute( + + /** + * @see {@link DescribeFpgaImageAttributeCommand} + */ + describeFpgaImageAttribute( args: DescribeFpgaImageAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFpgaImageAttribute( + describeFpgaImageAttribute( args: DescribeFpgaImageAttributeCommandInput, cb: (err: any, data?: DescribeFpgaImageAttributeCommandOutput) => void ): void; - public describeFpgaImageAttribute( + describeFpgaImageAttribute( args: DescribeFpgaImageAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFpgaImageAttributeCommandOutput) => void ): void; - public describeFpgaImageAttribute( - args: DescribeFpgaImageAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFpgaImageAttributeCommandOutput) => void), - cb?: (err: any, data?: DescribeFpgaImageAttributeCommandOutput) => void - ): Promise | void { - const command = new DescribeFpgaImageAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, - * private AFIs that you own, and AFIs owned by other Amazon Web Services accounts for which you have load - * permissions.

- */ - public describeFpgaImages( + + /** + * @see {@link DescribeFpgaImagesCommand} + */ + describeFpgaImages( args: DescribeFpgaImagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFpgaImages( + describeFpgaImages( args: DescribeFpgaImagesCommandInput, cb: (err: any, data?: DescribeFpgaImagesCommandOutput) => void ): void; - public describeFpgaImages( + describeFpgaImages( args: DescribeFpgaImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFpgaImagesCommandOutput) => void ): void; - public describeFpgaImages( - args: DescribeFpgaImagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFpgaImagesCommandOutput) => void), - cb?: (err: any, data?: DescribeFpgaImagesCommandOutput) => void - ): Promise | void { - const command = new DescribeFpgaImagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the Dedicated Host reservations that are available to purchase.

- *

The results describe all of the Dedicated Host reservation offerings, including - * offerings that might not match the instance family and Region of your Dedicated Hosts. - * When purchasing an offering, ensure that the instance family and Region of the offering - * matches that of the Dedicated Hosts with which it is to be associated. For more - * information about supported instance types, see Dedicated Hosts - * in the Amazon EC2 User Guide.

- */ - public describeHostReservationOfferings( + + /** + * @see {@link DescribeHostReservationOfferingsCommand} + */ + describeHostReservationOfferings( args: DescribeHostReservationOfferingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeHostReservationOfferings( + describeHostReservationOfferings( args: DescribeHostReservationOfferingsCommandInput, cb: (err: any, data?: DescribeHostReservationOfferingsCommandOutput) => void ): void; - public describeHostReservationOfferings( + describeHostReservationOfferings( args: DescribeHostReservationOfferingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHostReservationOfferingsCommandOutput) => void ): void; - public describeHostReservationOfferings( - args: DescribeHostReservationOfferingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeHostReservationOfferingsCommandOutput) => void), - cb?: (err: any, data?: DescribeHostReservationOfferingsCommandOutput) => void - ): Promise | void { - const command = new DescribeHostReservationOfferingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes reservations that are associated with Dedicated Hosts in your - * account.

- */ - public describeHostReservations( + + /** + * @see {@link DescribeHostReservationsCommand} + */ + describeHostReservations( args: DescribeHostReservationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeHostReservations( + describeHostReservations( args: DescribeHostReservationsCommandInput, cb: (err: any, data?: DescribeHostReservationsCommandOutput) => void ): void; - public describeHostReservations( + describeHostReservations( args: DescribeHostReservationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHostReservationsCommandOutput) => void ): void; - public describeHostReservations( - args: DescribeHostReservationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeHostReservationsCommandOutput) => void), - cb?: (err: any, data?: DescribeHostReservationsCommandOutput) => void - ): Promise | void { - const command = new DescribeHostReservationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified Dedicated Hosts or all your Dedicated Hosts.

- *

The results describe only the Dedicated Hosts in the Region you're currently using. - * All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have - * recently been released are listed with the state released.

- */ - public describeHosts( - args: DescribeHostsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeHosts( - args: DescribeHostsCommandInput, - cb: (err: any, data?: DescribeHostsCommandOutput) => void - ): void; - public describeHosts( + + /** + * @see {@link DescribeHostsCommand} + */ + describeHosts(args: DescribeHostsCommandInput, options?: __HttpHandlerOptions): Promise; + describeHosts(args: DescribeHostsCommandInput, cb: (err: any, data?: DescribeHostsCommandOutput) => void): void; + describeHosts( args: DescribeHostsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHostsCommandOutput) => void ): void; - public describeHosts( - args: DescribeHostsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeHostsCommandOutput) => void), - cb?: (err: any, data?: DescribeHostsCommandOutput) => void - ): Promise | void { - const command = new DescribeHostsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes your IAM instance profile associations.

- */ - public describeIamInstanceProfileAssociations( + + /** + * @see {@link DescribeIamInstanceProfileAssociationsCommand} + */ + describeIamInstanceProfileAssociations( args: DescribeIamInstanceProfileAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeIamInstanceProfileAssociations( + describeIamInstanceProfileAssociations( args: DescribeIamInstanceProfileAssociationsCommandInput, cb: (err: any, data?: DescribeIamInstanceProfileAssociationsCommandOutput) => void ): void; - public describeIamInstanceProfileAssociations( + describeIamInstanceProfileAssociations( args: DescribeIamInstanceProfileAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIamInstanceProfileAssociationsCommandOutput) => void ): void; - public describeIamInstanceProfileAssociations( - args: DescribeIamInstanceProfileAssociationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeIamInstanceProfileAssociationsCommandOutput) => void), - cb?: (err: any, data?: DescribeIamInstanceProfileAssociationsCommandOutput) => void - ): Promise | void { - const command = new DescribeIamInstanceProfileAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the ID format settings for resources for the specified IAM user, IAM role, or root - * user. For example, you can view the resource types that are enabled for longer IDs. This request only - * returns information about resource types whose ID formats can be modified; it does not return - * information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

- *

The following resource types support longer IDs: bundle | - * conversion-task | customer-gateway | dhcp-options | - * elastic-ip-allocation | elastic-ip-association | - * export-task | flow-log | image | - * import-task | instance | internet-gateway | - * network-acl | network-acl-association | - * network-interface | network-interface-attachment | - * prefix-list | reservation | route-table | - * route-table-association | security-group | - * snapshot | subnet | - * subnet-cidr-block-association | volume | vpc - * | vpc-cidr-block-association | vpc-endpoint | - * vpc-peering-connection | vpn-connection | vpn-gateway.

- *

These settings apply to the principal specified in the request. They do not apply to the - * principal that makes the request.

- */ - public describeIdentityIdFormat( + + /** + * @see {@link DescribeIdentityIdFormatCommand} + */ + describeIdentityIdFormat( args: DescribeIdentityIdFormatCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeIdentityIdFormat( + describeIdentityIdFormat( args: DescribeIdentityIdFormatCommandInput, cb: (err: any, data?: DescribeIdentityIdFormatCommandOutput) => void ): void; - public describeIdentityIdFormat( + describeIdentityIdFormat( args: DescribeIdentityIdFormatCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIdentityIdFormatCommandOutput) => void ): void; - public describeIdentityIdFormat( - args: DescribeIdentityIdFormatCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeIdentityIdFormatCommandOutput) => void), - cb?: (err: any, data?: DescribeIdentityIdFormatCommandOutput) => void - ): Promise | void { - const command = new DescribeIdentityIdFormatCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.

- *

The following resource types support longer IDs: bundle | - * conversion-task | customer-gateway | dhcp-options | - * elastic-ip-allocation | elastic-ip-association | - * export-task | flow-log | image | - * import-task | instance | internet-gateway | - * network-acl | network-acl-association | - * network-interface | network-interface-attachment | - * prefix-list | reservation | route-table | - * route-table-association | security-group | - * snapshot | subnet | - * subnet-cidr-block-association | volume | vpc - * | vpc-cidr-block-association | vpc-endpoint | - * vpc-peering-connection | vpn-connection | vpn-gateway.

- *

These settings apply to the IAM user who makes the request; they do not apply to the entire - * Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user, unless - * they explicitly override the settings by running the ModifyIdFormat command. Resources - * created with longer IDs are visible to all IAM users, regardless of these settings and - * provided that they have permission to use the relevant Describe command for the - * resource type.

- */ - public describeIdFormat( + + /** + * @see {@link DescribeIdFormatCommand} + */ + describeIdFormat( args: DescribeIdFormatCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeIdFormat( + describeIdFormat( args: DescribeIdFormatCommandInput, cb: (err: any, data?: DescribeIdFormatCommandOutput) => void ): void; - public describeIdFormat( + describeIdFormat( args: DescribeIdFormatCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIdFormatCommandOutput) => void ): void; - public describeIdFormat( - args: DescribeIdFormatCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeIdFormatCommandOutput) => void), - cb?: (err: any, data?: DescribeIdFormatCommandOutput) => void - ): Promise | void { - const command = new DescribeIdFormatCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

- */ - public describeImageAttribute( + + /** + * @see {@link DescribeImageAttributeCommand} + */ + describeImageAttribute( args: DescribeImageAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeImageAttribute( + describeImageAttribute( args: DescribeImageAttributeCommandInput, cb: (err: any, data?: DescribeImageAttributeCommandOutput) => void ): void; - public describeImageAttribute( + describeImageAttribute( args: DescribeImageAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImageAttributeCommandOutput) => void ): void; - public describeImageAttribute( - args: DescribeImageAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeImageAttributeCommandOutput) => void), - cb?: (err: any, data?: DescribeImageAttributeCommandOutput) => void - ): Promise | void { - const command = new DescribeImageAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.

- *

The images available to you include public images, private images that you own, and private images owned by other - * Amazon Web Services accounts for which you have explicit launch permissions.

- *

Recently deregistered images appear in the returned results for a short interval and then - * return empty results. After all instances that reference a deregistered AMI are terminated, - * specifying the ID of the image will eventually return an error indicating that the AMI ID - * cannot be found.

- */ - public describeImages( + + /** + * @see {@link DescribeImagesCommand} + */ + describeImages( args: DescribeImagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeImages( - args: DescribeImagesCommandInput, - cb: (err: any, data?: DescribeImagesCommandOutput) => void - ): void; - public describeImages( + describeImages(args: DescribeImagesCommandInput, cb: (err: any, data?: DescribeImagesCommandOutput) => void): void; + describeImages( args: DescribeImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImagesCommandOutput) => void ): void; - public describeImages( - args: DescribeImagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeImagesCommandOutput) => void), - cb?: (err: any, data?: DescribeImagesCommandOutput) => void - ): Promise | void { - const command = new DescribeImagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Displays details about an import virtual machine or import snapshot tasks that are already created.

- */ - public describeImportImageTasks( + + /** + * @see {@link DescribeImportImageTasksCommand} + */ + describeImportImageTasks( args: DescribeImportImageTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeImportImageTasks( + describeImportImageTasks( args: DescribeImportImageTasksCommandInput, cb: (err: any, data?: DescribeImportImageTasksCommandOutput) => void ): void; - public describeImportImageTasks( + describeImportImageTasks( args: DescribeImportImageTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImportImageTasksCommandOutput) => void ): void; - public describeImportImageTasks( - args: DescribeImportImageTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeImportImageTasksCommandOutput) => void), - cb?: (err: any, data?: DescribeImportImageTasksCommandOutput) => void - ): Promise | void { - const command = new DescribeImportImageTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes your import snapshot tasks.

- */ - public describeImportSnapshotTasks( + + /** + * @see {@link DescribeImportSnapshotTasksCommand} + */ + describeImportSnapshotTasks( args: DescribeImportSnapshotTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeImportSnapshotTasks( + describeImportSnapshotTasks( args: DescribeImportSnapshotTasksCommandInput, cb: (err: any, data?: DescribeImportSnapshotTasksCommandOutput) => void ): void; - public describeImportSnapshotTasks( + describeImportSnapshotTasks( args: DescribeImportSnapshotTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImportSnapshotTasksCommandOutput) => void ): void; - public describeImportSnapshotTasks( - args: DescribeImportSnapshotTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeImportSnapshotTasksCommandOutput) => void), - cb?: (err: any, data?: DescribeImportSnapshotTasksCommandOutput) => void - ): Promise | void { - const command = new DescribeImportSnapshotTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified attribute of the specified instance. You can specify only one - * attribute at a time. Valid attribute values are: instanceType | - * kernel | ramdisk | userData | - * disableApiTermination | instanceInitiatedShutdownBehavior - * | rootDeviceName | blockDeviceMapping | - * productCodes | sourceDestCheck | groupSet | - * ebsOptimized | sriovNetSupport - *

- */ - public describeInstanceAttribute( + + /** + * @see {@link DescribeInstanceAttributeCommand} + */ + describeInstanceAttribute( args: DescribeInstanceAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInstanceAttribute( + describeInstanceAttribute( args: DescribeInstanceAttributeCommandInput, cb: (err: any, data?: DescribeInstanceAttributeCommandOutput) => void ): void; - public describeInstanceAttribute( + describeInstanceAttribute( args: DescribeInstanceAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstanceAttributeCommandOutput) => void ): void; - public describeInstanceAttribute( - args: DescribeInstanceAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInstanceAttributeCommandOutput) => void), - cb?: (err: any, data?: DescribeInstanceAttributeCommandOutput) => void - ): Promise | void { - const command = new DescribeInstanceAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the credit option for CPU usage of the specified burstable performance - * instances. The credit options are standard and - * unlimited.

- *

If you do not specify an instance ID, Amazon EC2 returns burstable performance - * instances with the unlimited credit option, as well as instances that were - * previously configured as T2, T3, and T3a with the unlimited credit option. - * For example, if you resize a T2 instance, while it is configured as - * unlimited, to an M4 instance, Amazon EC2 returns the M4 - * instance.

- *

If you specify one or more instance IDs, Amazon EC2 returns the credit option - * (standard or unlimited) of those instances. If you specify - * an instance ID that is not valid, such as an instance that is not a burstable - * performance instance, an error is returned.

- *

Recently terminated instances might appear in the returned results. This interval is - * usually less than one hour.

- *

If an Availability Zone is experiencing a service disruption and you specify instance - * IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If - * you specify only instance IDs in an unaffected zone, the call works normally.

- *

For more information, see Burstable - * performance instances in the Amazon EC2 User Guide.

- */ - public describeInstanceCreditSpecifications( + + /** + * @see {@link DescribeInstanceCreditSpecificationsCommand} + */ + describeInstanceCreditSpecifications( args: DescribeInstanceCreditSpecificationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInstanceCreditSpecifications( + describeInstanceCreditSpecifications( args: DescribeInstanceCreditSpecificationsCommandInput, cb: (err: any, data?: DescribeInstanceCreditSpecificationsCommandOutput) => void ): void; - public describeInstanceCreditSpecifications( + describeInstanceCreditSpecifications( args: DescribeInstanceCreditSpecificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstanceCreditSpecificationsCommandOutput) => void ): void; - public describeInstanceCreditSpecifications( - args: DescribeInstanceCreditSpecificationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInstanceCreditSpecificationsCommandOutput) => void), - cb?: (err: any, data?: DescribeInstanceCreditSpecificationsCommandOutput) => void - ): Promise | void { - const command = new DescribeInstanceCreditSpecificationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the tag keys that are registered to appear in scheduled event notifications for - * resources in the current Region.

- */ - public describeInstanceEventNotificationAttributes( + + /** + * @see {@link DescribeInstanceEventNotificationAttributesCommand} + */ + describeInstanceEventNotificationAttributes( args: DescribeInstanceEventNotificationAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInstanceEventNotificationAttributes( + describeInstanceEventNotificationAttributes( args: DescribeInstanceEventNotificationAttributesCommandInput, cb: (err: any, data?: DescribeInstanceEventNotificationAttributesCommandOutput) => void ): void; - public describeInstanceEventNotificationAttributes( + describeInstanceEventNotificationAttributes( args: DescribeInstanceEventNotificationAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstanceEventNotificationAttributesCommandOutput) => void ): void; - public describeInstanceEventNotificationAttributes( - args: DescribeInstanceEventNotificationAttributesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeInstanceEventNotificationAttributesCommandOutput) => void), - cb?: (err: any, data?: DescribeInstanceEventNotificationAttributesCommandOutput) => void - ): Promise | void { - const command = new DescribeInstanceEventNotificationAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified event windows or all event windows.

- *

If you specify event window IDs, the output includes information for only the specified - * event windows. If you specify filters, the output includes information for only those event - * windows that meet the filter criteria. If you do not specify event windows IDs or filters, - * the output includes information for all event windows, which can affect performance. We - * recommend that you use pagination to ensure that the operation returns quickly and - * successfully.

- *

For more information, see Define event windows for scheduled - * events in the Amazon EC2 User Guide.

- */ - public describeInstanceEventWindows( + + /** + * @see {@link DescribeInstanceEventWindowsCommand} + */ + describeInstanceEventWindows( args: DescribeInstanceEventWindowsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInstanceEventWindows( + describeInstanceEventWindows( args: DescribeInstanceEventWindowsCommandInput, cb: (err: any, data?: DescribeInstanceEventWindowsCommandOutput) => void ): void; - public describeInstanceEventWindows( + describeInstanceEventWindows( args: DescribeInstanceEventWindowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstanceEventWindowsCommandOutput) => void ): void; - public describeInstanceEventWindows( - args: DescribeInstanceEventWindowsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInstanceEventWindowsCommandOutput) => void), - cb?: (err: any, data?: DescribeInstanceEventWindowsCommandOutput) => void - ): Promise | void { - const command = new DescribeInstanceEventWindowsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified instances or all instances.

- *

If you specify instance IDs, the output includes information for only the specified - * instances. If you specify filters, the output includes information for only those - * instances that meet the filter criteria. If you do not specify instance IDs or filters, - * the output includes information for all instances, which can affect performance. We - * recommend that you use pagination to ensure that the operation returns quickly and - * successfully.

- *

If you specify an instance ID that is not valid, an error is returned. If you specify - * an instance that you do not own, it is not included in the output.

- *

Recently terminated instances might appear in the returned results. This interval is - * usually less than one hour.

- *

If you describe instances in the rare case where an Availability Zone is experiencing - * a service disruption and you specify instance IDs that are in the affected zone, or do - * not specify any instance IDs at all, the call fails. If you describe instances and - * specify only instance IDs that are in an unaffected zone, the call works - * normally.

- */ - public describeInstances( + + /** + * @see {@link DescribeInstancesCommand} + */ + describeInstances( args: DescribeInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInstances( + describeInstances( args: DescribeInstancesCommandInput, cb: (err: any, data?: DescribeInstancesCommandOutput) => void ): void; - public describeInstances( + describeInstances( args: DescribeInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstancesCommandOutput) => void ): void; - public describeInstances( - args: DescribeInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInstancesCommandOutput) => void), - cb?: (err: any, data?: DescribeInstancesCommandOutput) => void - ): Promise | void { - const command = new DescribeInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the status of the specified instances or all of your instances. By default, - * only running instances are described, unless you specifically indicate to return the - * status of all instances.

- *

Instance status includes the following components:

- *
    - *
  • - *

    - * Status checks - Amazon EC2 performs status - * checks on running EC2 instances to identify hardware and software issues. For - * more information, see Status checks for your instances and Troubleshoot - * instances with failed status checks in the Amazon EC2 User - * Guide.

    - *
  • - *
  • - *

    - * Scheduled events - Amazon EC2 can schedule - * events (such as reboot, stop, or terminate) for your instances related to - * hardware issues, software updates, or system maintenance. For more information, - * see Scheduled events for your instances in the Amazon EC2 User - * Guide.

    - *
  • - *
  • - *

    - * Instance state - You can manage your instances - * from the moment you launch them through their termination. For more information, - * see Instance - * lifecycle in the Amazon EC2 User Guide.

    - *
  • - *
- */ - public describeInstanceStatus( + + /** + * @see {@link DescribeInstanceStatusCommand} + */ + describeInstanceStatus( args: DescribeInstanceStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInstanceStatus( + describeInstanceStatus( args: DescribeInstanceStatusCommandInput, cb: (err: any, data?: DescribeInstanceStatusCommandOutput) => void ): void; - public describeInstanceStatus( + describeInstanceStatus( args: DescribeInstanceStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstanceStatusCommandOutput) => void ): void; - public describeInstanceStatus( - args: DescribeInstanceStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInstanceStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeInstanceStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeInstanceStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of all instance types offered. The results can be filtered by location (Region or Availability - * Zone). If no location is specified, the instance types offered in the current Region are returned.

- */ - public describeInstanceTypeOfferings( + + /** + * @see {@link DescribeInstanceTypeOfferingsCommand} + */ + describeInstanceTypeOfferings( args: DescribeInstanceTypeOfferingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInstanceTypeOfferings( + describeInstanceTypeOfferings( args: DescribeInstanceTypeOfferingsCommandInput, cb: (err: any, data?: DescribeInstanceTypeOfferingsCommandOutput) => void ): void; - public describeInstanceTypeOfferings( + describeInstanceTypeOfferings( args: DescribeInstanceTypeOfferingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstanceTypeOfferingsCommandOutput) => void ): void; - public describeInstanceTypeOfferings( - args: DescribeInstanceTypeOfferingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInstanceTypeOfferingsCommandOutput) => void), - cb?: (err: any, data?: DescribeInstanceTypeOfferingsCommandOutput) => void - ): Promise | void { - const command = new DescribeInstanceTypeOfferingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the details of the instance types that are offered in a location. The results can be filtered by the - * attributes of the instance types.

- */ - public describeInstanceTypes( + + /** + * @see {@link DescribeInstanceTypesCommand} + */ + describeInstanceTypes( args: DescribeInstanceTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInstanceTypes( + describeInstanceTypes( args: DescribeInstanceTypesCommandInput, cb: (err: any, data?: DescribeInstanceTypesCommandOutput) => void ): void; - public describeInstanceTypes( + describeInstanceTypes( args: DescribeInstanceTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstanceTypesCommandOutput) => void ): void; - public describeInstanceTypes( - args: DescribeInstanceTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInstanceTypesCommandOutput) => void), - cb?: (err: any, data?: DescribeInstanceTypesCommandOutput) => void - ): Promise | void { - const command = new DescribeInstanceTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more of your internet gateways.

- */ - public describeInternetGateways( + + /** + * @see {@link DescribeInternetGatewaysCommand} + */ + describeInternetGateways( args: DescribeInternetGatewaysCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInternetGateways( + describeInternetGateways( args: DescribeInternetGatewaysCommandInput, cb: (err: any, data?: DescribeInternetGatewaysCommandOutput) => void ): void; - public describeInternetGateways( + describeInternetGateways( args: DescribeInternetGatewaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInternetGatewaysCommandOutput) => void ): void; - public describeInternetGateways( - args: DescribeInternetGatewaysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInternetGatewaysCommandOutput) => void), - cb?: (err: any, data?: DescribeInternetGatewaysCommandOutput) => void - ): Promise | void { - const command = new DescribeInternetGatewaysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get information about your IPAM pools.

- */ - public describeIpamPools( + + /** + * @see {@link DescribeIpamPoolsCommand} + */ + describeIpamPools( args: DescribeIpamPoolsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeIpamPools( + describeIpamPools( args: DescribeIpamPoolsCommandInput, cb: (err: any, data?: DescribeIpamPoolsCommandOutput) => void ): void; - public describeIpamPools( + describeIpamPools( args: DescribeIpamPoolsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIpamPoolsCommandOutput) => void ): void; - public describeIpamPools( - args: DescribeIpamPoolsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeIpamPoolsCommandOutput) => void), - cb?: (err: any, data?: DescribeIpamPoolsCommandOutput) => void - ): Promise | void { - const command = new DescribeIpamPoolsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

- */ - public describeIpamResourceDiscoveries( + + /** + * @see {@link DescribeIpamResourceDiscoveriesCommand} + */ + describeIpamResourceDiscoveries( args: DescribeIpamResourceDiscoveriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeIpamResourceDiscoveries( + describeIpamResourceDiscoveries( args: DescribeIpamResourceDiscoveriesCommandInput, cb: (err: any, data?: DescribeIpamResourceDiscoveriesCommandOutput) => void ): void; - public describeIpamResourceDiscoveries( + describeIpamResourceDiscoveries( args: DescribeIpamResourceDiscoveriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIpamResourceDiscoveriesCommandOutput) => void ): void; - public describeIpamResourceDiscoveries( - args: DescribeIpamResourceDiscoveriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeIpamResourceDiscoveriesCommandOutput) => void), - cb?: (err: any, data?: DescribeIpamResourceDiscoveriesCommandOutput) => void - ): Promise | void { - const command = new DescribeIpamResourceDiscoveriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes resource discovery association with an Amazon VPC IPAM. An associated resource discovery is a resource discovery that has been associated with an IPAM..

- */ - public describeIpamResourceDiscoveryAssociations( + + /** + * @see {@link DescribeIpamResourceDiscoveryAssociationsCommand} + */ + describeIpamResourceDiscoveryAssociations( args: DescribeIpamResourceDiscoveryAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeIpamResourceDiscoveryAssociations( + describeIpamResourceDiscoveryAssociations( args: DescribeIpamResourceDiscoveryAssociationsCommandInput, cb: (err: any, data?: DescribeIpamResourceDiscoveryAssociationsCommandOutput) => void ): void; - public describeIpamResourceDiscoveryAssociations( + describeIpamResourceDiscoveryAssociations( args: DescribeIpamResourceDiscoveryAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIpamResourceDiscoveryAssociationsCommandOutput) => void ): void; - public describeIpamResourceDiscoveryAssociations( - args: DescribeIpamResourceDiscoveryAssociationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeIpamResourceDiscoveryAssociationsCommandOutput) => void), - cb?: (err: any, data?: DescribeIpamResourceDiscoveryAssociationsCommandOutput) => void - ): Promise | void { - const command = new DescribeIpamResourceDiscoveryAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get information about your IPAM pools.

- *

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide. - *

- */ - public describeIpams( - args: DescribeIpamsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeIpams( - args: DescribeIpamsCommandInput, - cb: (err: any, data?: DescribeIpamsCommandOutput) => void - ): void; - public describeIpams( + + /** + * @see {@link DescribeIpamsCommand} + */ + describeIpams(args: DescribeIpamsCommandInput, options?: __HttpHandlerOptions): Promise; + describeIpams(args: DescribeIpamsCommandInput, cb: (err: any, data?: DescribeIpamsCommandOutput) => void): void; + describeIpams( args: DescribeIpamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIpamsCommandOutput) => void ): void; - public describeIpams( - args: DescribeIpamsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeIpamsCommandOutput) => void), - cb?: (err: any, data?: DescribeIpamsCommandOutput) => void - ): Promise | void { - const command = new DescribeIpamsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get information about your IPAM scopes.

- */ - public describeIpamScopes( + + /** + * @see {@link DescribeIpamScopesCommand} + */ + describeIpamScopes( args: DescribeIpamScopesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeIpamScopes( + describeIpamScopes( args: DescribeIpamScopesCommandInput, cb: (err: any, data?: DescribeIpamScopesCommandOutput) => void ): void; - public describeIpamScopes( + describeIpamScopes( args: DescribeIpamScopesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIpamScopesCommandOutput) => void ): void; - public describeIpamScopes( - args: DescribeIpamScopesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeIpamScopesCommandOutput) => void), - cb?: (err: any, data?: DescribeIpamScopesCommandOutput) => void - ): Promise | void { - const command = new DescribeIpamScopesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes your IPv6 address pools.

- */ - public describeIpv6Pools( + + /** + * @see {@link DescribeIpv6PoolsCommand} + */ + describeIpv6Pools( args: DescribeIpv6PoolsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeIpv6Pools( + describeIpv6Pools( args: DescribeIpv6PoolsCommandInput, cb: (err: any, data?: DescribeIpv6PoolsCommandOutput) => void ): void; - public describeIpv6Pools( + describeIpv6Pools( args: DescribeIpv6PoolsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIpv6PoolsCommandOutput) => void ): void; - public describeIpv6Pools( - args: DescribeIpv6PoolsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeIpv6PoolsCommandOutput) => void), - cb?: (err: any, data?: DescribeIpv6PoolsCommandOutput) => void - ): Promise | void { - const command = new DescribeIpv6PoolsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified key pairs or all of your key pairs.

- *

For more information about key pairs, see Amazon EC2 key pairs - * in the Amazon Elastic Compute Cloud User Guide.

- */ - public describeKeyPairs( + + /** + * @see {@link DescribeKeyPairsCommand} + */ + describeKeyPairs( args: DescribeKeyPairsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeKeyPairs( + describeKeyPairs( args: DescribeKeyPairsCommandInput, cb: (err: any, data?: DescribeKeyPairsCommandOutput) => void ): void; - public describeKeyPairs( + describeKeyPairs( args: DescribeKeyPairsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeKeyPairsCommandOutput) => void ): void; - public describeKeyPairs( - args: DescribeKeyPairsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeKeyPairsCommandOutput) => void), - cb?: (err: any, data?: DescribeKeyPairsCommandOutput) => void - ): Promise | void { - const command = new DescribeKeyPairsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more launch templates.

- */ - public describeLaunchTemplates( + + /** + * @see {@link DescribeLaunchTemplatesCommand} + */ + describeLaunchTemplates( args: DescribeLaunchTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLaunchTemplates( + describeLaunchTemplates( args: DescribeLaunchTemplatesCommandInput, cb: (err: any, data?: DescribeLaunchTemplatesCommandOutput) => void ): void; - public describeLaunchTemplates( + describeLaunchTemplates( args: DescribeLaunchTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLaunchTemplatesCommandOutput) => void ): void; - public describeLaunchTemplates( - args: DescribeLaunchTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLaunchTemplatesCommandOutput) => void), - cb?: (err: any, data?: DescribeLaunchTemplatesCommandOutput) => void - ): Promise | void { - const command = new DescribeLaunchTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more versions of a specified launch template. You can describe all - * versions, individual versions, or a range of versions. You can also describe all the - * latest versions or all the default versions of all the launch templates in your - * account.

- */ - public describeLaunchTemplateVersions( + + /** + * @see {@link DescribeLaunchTemplateVersionsCommand} + */ + describeLaunchTemplateVersions( args: DescribeLaunchTemplateVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLaunchTemplateVersions( + describeLaunchTemplateVersions( args: DescribeLaunchTemplateVersionsCommandInput, cb: (err: any, data?: DescribeLaunchTemplateVersionsCommandOutput) => void ): void; - public describeLaunchTemplateVersions( + describeLaunchTemplateVersions( args: DescribeLaunchTemplateVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLaunchTemplateVersionsCommandOutput) => void ): void; - public describeLaunchTemplateVersions( - args: DescribeLaunchTemplateVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLaunchTemplateVersionsCommandOutput) => void), - cb?: (err: any, data?: DescribeLaunchTemplateVersionsCommandOutput) => void - ): Promise | void { - const command = new DescribeLaunchTemplateVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more local gateway route tables. By default, all local gateway route tables are described. - * Alternatively, you can filter the results.

- */ - public describeLocalGatewayRouteTables( + + /** + * @see {@link DescribeLocalGatewayRouteTablesCommand} + */ + describeLocalGatewayRouteTables( args: DescribeLocalGatewayRouteTablesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLocalGatewayRouteTables( + describeLocalGatewayRouteTables( args: DescribeLocalGatewayRouteTablesCommandInput, cb: (err: any, data?: DescribeLocalGatewayRouteTablesCommandOutput) => void ): void; - public describeLocalGatewayRouteTables( + describeLocalGatewayRouteTables( args: DescribeLocalGatewayRouteTablesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocalGatewayRouteTablesCommandOutput) => void ): void; - public describeLocalGatewayRouteTables( - args: DescribeLocalGatewayRouteTablesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLocalGatewayRouteTablesCommandOutput) => void), - cb?: (err: any, data?: DescribeLocalGatewayRouteTablesCommandOutput) => void - ): Promise | void { - const command = new DescribeLocalGatewayRouteTablesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the associations between virtual interface groups and local gateway route tables.

- */ - public describeLocalGatewayRouteTableVirtualInterfaceGroupAssociations( + + /** + * @see {@link DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsCommand} + */ + describeLocalGatewayRouteTableVirtualInterfaceGroupAssociations( args: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLocalGatewayRouteTableVirtualInterfaceGroupAssociations( + describeLocalGatewayRouteTableVirtualInterfaceGroupAssociations( args: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsCommandInput, cb: (err: any, data?: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsCommandOutput) => void ): void; - public describeLocalGatewayRouteTableVirtualInterfaceGroupAssociations( + describeLocalGatewayRouteTableVirtualInterfaceGroupAssociations( args: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsCommandOutput) => void ): void; - public describeLocalGatewayRouteTableVirtualInterfaceGroupAssociations( - args: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsCommandOutput) => void), - cb?: (err: any, data?: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsCommandOutput) => void - ): Promise | void { - const command = new DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified associations between VPCs and local gateway route tables.

- */ - public describeLocalGatewayRouteTableVpcAssociations( + + /** + * @see {@link DescribeLocalGatewayRouteTableVpcAssociationsCommand} + */ + describeLocalGatewayRouteTableVpcAssociations( args: DescribeLocalGatewayRouteTableVpcAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLocalGatewayRouteTableVpcAssociations( + describeLocalGatewayRouteTableVpcAssociations( args: DescribeLocalGatewayRouteTableVpcAssociationsCommandInput, cb: (err: any, data?: DescribeLocalGatewayRouteTableVpcAssociationsCommandOutput) => void ): void; - public describeLocalGatewayRouteTableVpcAssociations( + describeLocalGatewayRouteTableVpcAssociations( args: DescribeLocalGatewayRouteTableVpcAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocalGatewayRouteTableVpcAssociationsCommandOutput) => void ): void; - public describeLocalGatewayRouteTableVpcAssociations( - args: DescribeLocalGatewayRouteTableVpcAssociationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeLocalGatewayRouteTableVpcAssociationsCommandOutput) => void), - cb?: (err: any, data?: DescribeLocalGatewayRouteTableVpcAssociationsCommandOutput) => void - ): Promise | void { - const command = new DescribeLocalGatewayRouteTableVpcAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more local gateways. By default, all local gateways are described. - * Alternatively, you can filter the results.

- */ - public describeLocalGateways( + + /** + * @see {@link DescribeLocalGatewaysCommand} + */ + describeLocalGateways( args: DescribeLocalGatewaysCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLocalGateways( + describeLocalGateways( args: DescribeLocalGatewaysCommandInput, cb: (err: any, data?: DescribeLocalGatewaysCommandOutput) => void ): void; - public describeLocalGateways( + describeLocalGateways( args: DescribeLocalGatewaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocalGatewaysCommandOutput) => void ): void; - public describeLocalGateways( - args: DescribeLocalGatewaysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLocalGatewaysCommandOutput) => void), - cb?: (err: any, data?: DescribeLocalGatewaysCommandOutput) => void - ): Promise | void { - const command = new DescribeLocalGatewaysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified local gateway virtual interface groups.

- */ - public describeLocalGatewayVirtualInterfaceGroups( + + /** + * @see {@link DescribeLocalGatewayVirtualInterfaceGroupsCommand} + */ + describeLocalGatewayVirtualInterfaceGroups( args: DescribeLocalGatewayVirtualInterfaceGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLocalGatewayVirtualInterfaceGroups( + describeLocalGatewayVirtualInterfaceGroups( args: DescribeLocalGatewayVirtualInterfaceGroupsCommandInput, cb: (err: any, data?: DescribeLocalGatewayVirtualInterfaceGroupsCommandOutput) => void ): void; - public describeLocalGatewayVirtualInterfaceGroups( + describeLocalGatewayVirtualInterfaceGroups( args: DescribeLocalGatewayVirtualInterfaceGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocalGatewayVirtualInterfaceGroupsCommandOutput) => void ): void; - public describeLocalGatewayVirtualInterfaceGroups( - args: DescribeLocalGatewayVirtualInterfaceGroupsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeLocalGatewayVirtualInterfaceGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeLocalGatewayVirtualInterfaceGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeLocalGatewayVirtualInterfaceGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified local gateway virtual interfaces.

- */ - public describeLocalGatewayVirtualInterfaces( + + /** + * @see {@link DescribeLocalGatewayVirtualInterfacesCommand} + */ + describeLocalGatewayVirtualInterfaces( args: DescribeLocalGatewayVirtualInterfacesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLocalGatewayVirtualInterfaces( + describeLocalGatewayVirtualInterfaces( args: DescribeLocalGatewayVirtualInterfacesCommandInput, cb: (err: any, data?: DescribeLocalGatewayVirtualInterfacesCommandOutput) => void ): void; - public describeLocalGatewayVirtualInterfaces( + describeLocalGatewayVirtualInterfaces( args: DescribeLocalGatewayVirtualInterfacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocalGatewayVirtualInterfacesCommandOutput) => void ): void; - public describeLocalGatewayVirtualInterfaces( - args: DescribeLocalGatewayVirtualInterfacesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeLocalGatewayVirtualInterfacesCommandOutput) => void), - cb?: (err: any, data?: DescribeLocalGatewayVirtualInterfacesCommandOutput) => void - ): Promise | void { - const command = new DescribeLocalGatewayVirtualInterfacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.

- *

To view the entries for your prefix list, use GetManagedPrefixListEntries.

- */ - public describeManagedPrefixLists( + + /** + * @see {@link DescribeManagedPrefixListsCommand} + */ + describeManagedPrefixLists( args: DescribeManagedPrefixListsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeManagedPrefixLists( + describeManagedPrefixLists( args: DescribeManagedPrefixListsCommandInput, cb: (err: any, data?: DescribeManagedPrefixListsCommandOutput) => void ): void; - public describeManagedPrefixLists( + describeManagedPrefixLists( args: DescribeManagedPrefixListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeManagedPrefixListsCommandOutput) => void ): void; - public describeManagedPrefixLists( - args: DescribeManagedPrefixListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeManagedPrefixListsCommandOutput) => void), - cb?: (err: any, data?: DescribeManagedPrefixListsCommandOutput) => void - ): Promise | void { - const command = new DescribeManagedPrefixListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.

- */ - public describeMovingAddresses( + + /** + * @see {@link DescribeMovingAddressesCommand} + */ + describeMovingAddresses( args: DescribeMovingAddressesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMovingAddresses( + describeMovingAddresses( args: DescribeMovingAddressesCommandInput, cb: (err: any, data?: DescribeMovingAddressesCommandOutput) => void ): void; - public describeMovingAddresses( + describeMovingAddresses( args: DescribeMovingAddressesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMovingAddressesCommandOutput) => void ): void; - public describeMovingAddresses( - args: DescribeMovingAddressesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMovingAddressesCommandOutput) => void), - cb?: (err: any, data?: DescribeMovingAddressesCommandOutput) => void - ): Promise | void { - const command = new DescribeMovingAddressesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more of your NAT gateways.

- */ - public describeNatGateways( + + /** + * @see {@link DescribeNatGatewaysCommand} + */ + describeNatGateways( args: DescribeNatGatewaysCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNatGateways( + describeNatGateways( args: DescribeNatGatewaysCommandInput, cb: (err: any, data?: DescribeNatGatewaysCommandOutput) => void ): void; - public describeNatGateways( + describeNatGateways( args: DescribeNatGatewaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNatGatewaysCommandOutput) => void ): void; - public describeNatGateways( - args: DescribeNatGatewaysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeNatGatewaysCommandOutput) => void), - cb?: (err: any, data?: DescribeNatGatewaysCommandOutput) => void - ): Promise | void { - const command = new DescribeNatGatewaysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more of your network ACLs.

- *

For more information, see Network ACLs in the - * Amazon Virtual Private Cloud User Guide.

- */ - public describeNetworkAcls( + + /** + * @see {@link DescribeNetworkAclsCommand} + */ + describeNetworkAcls( args: DescribeNetworkAclsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNetworkAcls( + describeNetworkAcls( args: DescribeNetworkAclsCommandInput, cb: (err: any, data?: DescribeNetworkAclsCommandOutput) => void ): void; - public describeNetworkAcls( + describeNetworkAcls( args: DescribeNetworkAclsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNetworkAclsCommandOutput) => void ): void; - public describeNetworkAcls( - args: DescribeNetworkAclsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeNetworkAclsCommandOutput) => void), - cb?: (err: any, data?: DescribeNetworkAclsCommandOutput) => void - ): Promise | void { - const command = new DescribeNetworkAclsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified Network Access Scope analyses.

- */ - public describeNetworkInsightsAccessScopeAnalyses( + + /** + * @see {@link DescribeNetworkInsightsAccessScopeAnalysesCommand} + */ + describeNetworkInsightsAccessScopeAnalyses( args: DescribeNetworkInsightsAccessScopeAnalysesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNetworkInsightsAccessScopeAnalyses( + describeNetworkInsightsAccessScopeAnalyses( args: DescribeNetworkInsightsAccessScopeAnalysesCommandInput, cb: (err: any, data?: DescribeNetworkInsightsAccessScopeAnalysesCommandOutput) => void ): void; - public describeNetworkInsightsAccessScopeAnalyses( + describeNetworkInsightsAccessScopeAnalyses( args: DescribeNetworkInsightsAccessScopeAnalysesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNetworkInsightsAccessScopeAnalysesCommandOutput) => void ): void; - public describeNetworkInsightsAccessScopeAnalyses( - args: DescribeNetworkInsightsAccessScopeAnalysesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeNetworkInsightsAccessScopeAnalysesCommandOutput) => void), - cb?: (err: any, data?: DescribeNetworkInsightsAccessScopeAnalysesCommandOutput) => void - ): Promise | void { - const command = new DescribeNetworkInsightsAccessScopeAnalysesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified Network Access Scopes.

- */ - public describeNetworkInsightsAccessScopes( + + /** + * @see {@link DescribeNetworkInsightsAccessScopesCommand} + */ + describeNetworkInsightsAccessScopes( args: DescribeNetworkInsightsAccessScopesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNetworkInsightsAccessScopes( + describeNetworkInsightsAccessScopes( args: DescribeNetworkInsightsAccessScopesCommandInput, cb: (err: any, data?: DescribeNetworkInsightsAccessScopesCommandOutput) => void ): void; - public describeNetworkInsightsAccessScopes( + describeNetworkInsightsAccessScopes( args: DescribeNetworkInsightsAccessScopesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNetworkInsightsAccessScopesCommandOutput) => void ): void; - public describeNetworkInsightsAccessScopes( - args: DescribeNetworkInsightsAccessScopesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeNetworkInsightsAccessScopesCommandOutput) => void), - cb?: (err: any, data?: DescribeNetworkInsightsAccessScopesCommandOutput) => void - ): Promise | void { - const command = new DescribeNetworkInsightsAccessScopesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more of your network insights analyses.

- */ - public describeNetworkInsightsAnalyses( + + /** + * @see {@link DescribeNetworkInsightsAnalysesCommand} + */ + describeNetworkInsightsAnalyses( args: DescribeNetworkInsightsAnalysesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNetworkInsightsAnalyses( + describeNetworkInsightsAnalyses( args: DescribeNetworkInsightsAnalysesCommandInput, cb: (err: any, data?: DescribeNetworkInsightsAnalysesCommandOutput) => void ): void; - public describeNetworkInsightsAnalyses( + describeNetworkInsightsAnalyses( args: DescribeNetworkInsightsAnalysesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNetworkInsightsAnalysesCommandOutput) => void ): void; - public describeNetworkInsightsAnalyses( - args: DescribeNetworkInsightsAnalysesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeNetworkInsightsAnalysesCommandOutput) => void), - cb?: (err: any, data?: DescribeNetworkInsightsAnalysesCommandOutput) => void - ): Promise | void { - const command = new DescribeNetworkInsightsAnalysesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more of your paths.

- */ - public describeNetworkInsightsPaths( + + /** + * @see {@link DescribeNetworkInsightsPathsCommand} + */ + describeNetworkInsightsPaths( args: DescribeNetworkInsightsPathsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNetworkInsightsPaths( + describeNetworkInsightsPaths( args: DescribeNetworkInsightsPathsCommandInput, cb: (err: any, data?: DescribeNetworkInsightsPathsCommandOutput) => void ): void; - public describeNetworkInsightsPaths( + describeNetworkInsightsPaths( args: DescribeNetworkInsightsPathsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNetworkInsightsPathsCommandOutput) => void ): void; - public describeNetworkInsightsPaths( - args: DescribeNetworkInsightsPathsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeNetworkInsightsPathsCommandOutput) => void), - cb?: (err: any, data?: DescribeNetworkInsightsPathsCommandOutput) => void - ): Promise | void { - const command = new DescribeNetworkInsightsPathsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a network interface attribute. You can specify only one attribute at a time.

- */ - public describeNetworkInterfaceAttribute( + + /** + * @see {@link DescribeNetworkInterfaceAttributeCommand} + */ + describeNetworkInterfaceAttribute( args: DescribeNetworkInterfaceAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNetworkInterfaceAttribute( + describeNetworkInterfaceAttribute( args: DescribeNetworkInterfaceAttributeCommandInput, cb: (err: any, data?: DescribeNetworkInterfaceAttributeCommandOutput) => void ): void; - public describeNetworkInterfaceAttribute( + describeNetworkInterfaceAttribute( args: DescribeNetworkInterfaceAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNetworkInterfaceAttributeCommandOutput) => void ): void; - public describeNetworkInterfaceAttribute( - args: DescribeNetworkInterfaceAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeNetworkInterfaceAttributeCommandOutput) => void), - cb?: (err: any, data?: DescribeNetworkInterfaceAttributeCommandOutput) => void - ): Promise | void { - const command = new DescribeNetworkInterfaceAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the permissions for your network interfaces.

- */ - public describeNetworkInterfacePermissions( + + /** + * @see {@link DescribeNetworkInterfacePermissionsCommand} + */ + describeNetworkInterfacePermissions( args: DescribeNetworkInterfacePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNetworkInterfacePermissions( + describeNetworkInterfacePermissions( args: DescribeNetworkInterfacePermissionsCommandInput, cb: (err: any, data?: DescribeNetworkInterfacePermissionsCommandOutput) => void ): void; - public describeNetworkInterfacePermissions( + describeNetworkInterfacePermissions( args: DescribeNetworkInterfacePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNetworkInterfacePermissionsCommandOutput) => void ): void; - public describeNetworkInterfacePermissions( - args: DescribeNetworkInterfacePermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeNetworkInterfacePermissionsCommandOutput) => void), - cb?: (err: any, data?: DescribeNetworkInterfacePermissionsCommandOutput) => void - ): Promise | void { - const command = new DescribeNetworkInterfacePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more of your network interfaces.

- */ - public describeNetworkInterfaces( + + /** + * @see {@link DescribeNetworkInterfacesCommand} + */ + describeNetworkInterfaces( args: DescribeNetworkInterfacesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNetworkInterfaces( + describeNetworkInterfaces( args: DescribeNetworkInterfacesCommandInput, cb: (err: any, data?: DescribeNetworkInterfacesCommandOutput) => void ): void; - public describeNetworkInterfaces( + describeNetworkInterfaces( args: DescribeNetworkInterfacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNetworkInterfacesCommandOutput) => void ): void; - public describeNetworkInterfaces( - args: DescribeNetworkInterfacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeNetworkInterfacesCommandOutput) => void), - cb?: (err: any, data?: DescribeNetworkInterfacesCommandOutput) => void - ): Promise | void { - const command = new DescribeNetworkInterfacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified placement groups or all of your placement groups. For more - * information, see Placement groups in the - * Amazon EC2 User Guide.

- */ - public describePlacementGroups( + + /** + * @see {@link DescribePlacementGroupsCommand} + */ + describePlacementGroups( args: DescribePlacementGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePlacementGroups( + describePlacementGroups( args: DescribePlacementGroupsCommandInput, cb: (err: any, data?: DescribePlacementGroupsCommandOutput) => void ): void; - public describePlacementGroups( + describePlacementGroups( args: DescribePlacementGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePlacementGroupsCommandOutput) => void ): void; - public describePlacementGroups( - args: DescribePlacementGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePlacementGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribePlacementGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribePlacementGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes available Amazon Web Services services in a prefix list format, which includes the prefix list - * name and prefix list ID of the service and the IP address range for the service.

- *

We recommend that you use DescribeManagedPrefixLists instead.

- */ - public describePrefixLists( + + /** + * @see {@link DescribePrefixListsCommand} + */ + describePrefixLists( args: DescribePrefixListsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePrefixLists( + describePrefixLists( args: DescribePrefixListsCommandInput, cb: (err: any, data?: DescribePrefixListsCommandOutput) => void ): void; - public describePrefixLists( + describePrefixLists( args: DescribePrefixListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePrefixListsCommandOutput) => void ): void; - public describePrefixLists( - args: DescribePrefixListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePrefixListsCommandOutput) => void), - cb?: (err: any, data?: DescribePrefixListsCommandOutput) => void - ): Promise | void { - const command = new DescribePrefixListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the ID format settings for the root user and all IAM roles and IAM users - * that have explicitly specified a longer ID (17-character ID) preference.

- *

By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they - * explicitly override the settings. This request is useful for identifying those IAM users and IAM roles - * that have overridden the default ID settings.

- *

The following resource types support longer IDs: bundle | - * conversion-task | customer-gateway | dhcp-options | - * elastic-ip-allocation | elastic-ip-association | - * export-task | flow-log | image | - * import-task | instance | internet-gateway | - * network-acl | network-acl-association | - * network-interface | network-interface-attachment | - * prefix-list | reservation | route-table | - * route-table-association | security-group | - * snapshot | subnet | - * subnet-cidr-block-association | volume | vpc - * | vpc-cidr-block-association | vpc-endpoint | - * vpc-peering-connection | vpn-connection | vpn-gateway.

- */ - public describePrincipalIdFormat( + + /** + * @see {@link DescribePrincipalIdFormatCommand} + */ + describePrincipalIdFormat( args: DescribePrincipalIdFormatCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePrincipalIdFormat( + describePrincipalIdFormat( args: DescribePrincipalIdFormatCommandInput, cb: (err: any, data?: DescribePrincipalIdFormatCommandOutput) => void ): void; - public describePrincipalIdFormat( + describePrincipalIdFormat( args: DescribePrincipalIdFormatCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePrincipalIdFormatCommandOutput) => void ): void; - public describePrincipalIdFormat( - args: DescribePrincipalIdFormatCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePrincipalIdFormatCommandOutput) => void), - cb?: (err: any, data?: DescribePrincipalIdFormatCommandOutput) => void - ): Promise | void { - const command = new DescribePrincipalIdFormatCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified IPv4 address pools.

- */ - public describePublicIpv4Pools( + + /** + * @see {@link DescribePublicIpv4PoolsCommand} + */ + describePublicIpv4Pools( args: DescribePublicIpv4PoolsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePublicIpv4Pools( + describePublicIpv4Pools( args: DescribePublicIpv4PoolsCommandInput, cb: (err: any, data?: DescribePublicIpv4PoolsCommandOutput) => void ): void; - public describePublicIpv4Pools( + describePublicIpv4Pools( args: DescribePublicIpv4PoolsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePublicIpv4PoolsCommandOutput) => void ): void; - public describePublicIpv4Pools( - args: DescribePublicIpv4PoolsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePublicIpv4PoolsCommandOutput) => void), - cb?: (err: any, data?: DescribePublicIpv4PoolsCommandOutput) => void - ): Promise | void { - const command = new DescribePublicIpv4PoolsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the Regions that are enabled for your account, or all Regions.

- *

For a list of the Regions supported by Amazon EC2, see - * Amazon Elastic Compute Cloud endpoints and quotas.

- *

For information about enabling and disabling Regions for your account, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.

- */ - public describeRegions( + + /** + * @see {@link DescribeRegionsCommand} + */ + describeRegions( args: DescribeRegionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRegions( - args: DescribeRegionsCommandInput, - cb: (err: any, data?: DescribeRegionsCommandOutput) => void - ): void; - public describeRegions( + describeRegions(args: DescribeRegionsCommandInput, cb: (err: any, data?: DescribeRegionsCommandOutput) => void): void; + describeRegions( args: DescribeRegionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRegionsCommandOutput) => void ): void; - public describeRegions( - args: DescribeRegionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRegionsCommandOutput) => void), - cb?: (err: any, data?: DescribeRegionsCommandOutput) => void - ): Promise | void { - const command = new DescribeRegionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a root volume replacement task. For more information, see - * Replace a root volume in the Amazon Elastic Compute Cloud User Guide.

- */ - public describeReplaceRootVolumeTasks( + + /** + * @see {@link DescribeReplaceRootVolumeTasksCommand} + */ + describeReplaceRootVolumeTasks( args: DescribeReplaceRootVolumeTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReplaceRootVolumeTasks( + describeReplaceRootVolumeTasks( args: DescribeReplaceRootVolumeTasksCommandInput, cb: (err: any, data?: DescribeReplaceRootVolumeTasksCommandOutput) => void ): void; - public describeReplaceRootVolumeTasks( + describeReplaceRootVolumeTasks( args: DescribeReplaceRootVolumeTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReplaceRootVolumeTasksCommandOutput) => void ): void; - public describeReplaceRootVolumeTasks( - args: DescribeReplaceRootVolumeTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReplaceRootVolumeTasksCommandOutput) => void), - cb?: (err: any, data?: DescribeReplaceRootVolumeTasksCommandOutput) => void - ): Promise | void { - const command = new DescribeReplaceRootVolumeTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more of the Reserved Instances that you purchased.

- *

For more information about Reserved Instances, see Reserved - * Instances in the Amazon EC2 User Guide.

- */ - public describeReservedInstances( + + /** + * @see {@link DescribeReservedInstancesCommand} + */ + describeReservedInstances( args: DescribeReservedInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReservedInstances( + describeReservedInstances( args: DescribeReservedInstancesCommandInput, cb: (err: any, data?: DescribeReservedInstancesCommandOutput) => void ): void; - public describeReservedInstances( + describeReservedInstances( args: DescribeReservedInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReservedInstancesCommandOutput) => void ): void; - public describeReservedInstances( - args: DescribeReservedInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReservedInstancesCommandOutput) => void), - cb?: (err: any, data?: DescribeReservedInstancesCommandOutput) => void - ): Promise | void { - const command = new DescribeReservedInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

- *

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

- *

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

- *

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

- *

For more information, see Reserved Instance Marketplace - * in the Amazon EC2 User Guide.

- */ - public describeReservedInstancesListings( + + /** + * @see {@link DescribeReservedInstancesListingsCommand} + */ + describeReservedInstancesListings( args: DescribeReservedInstancesListingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReservedInstancesListings( + describeReservedInstancesListings( args: DescribeReservedInstancesListingsCommandInput, cb: (err: any, data?: DescribeReservedInstancesListingsCommandOutput) => void ): void; - public describeReservedInstancesListings( + describeReservedInstancesListings( args: DescribeReservedInstancesListingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReservedInstancesListingsCommandOutput) => void ): void; - public describeReservedInstancesListings( - args: DescribeReservedInstancesListingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReservedInstancesListingsCommandOutput) => void), - cb?: (err: any, data?: DescribeReservedInstancesListingsCommandOutput) => void - ): Promise | void { - const command = new DescribeReservedInstancesListingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

- *

For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.

- */ - public describeReservedInstancesModifications( + + /** + * @see {@link DescribeReservedInstancesModificationsCommand} + */ + describeReservedInstancesModifications( args: DescribeReservedInstancesModificationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReservedInstancesModifications( + describeReservedInstancesModifications( args: DescribeReservedInstancesModificationsCommandInput, cb: (err: any, data?: DescribeReservedInstancesModificationsCommandOutput) => void ): void; - public describeReservedInstancesModifications( + describeReservedInstancesModifications( args: DescribeReservedInstancesModificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReservedInstancesModificationsCommandOutput) => void ): void; - public describeReservedInstancesModifications( - args: DescribeReservedInstancesModificationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeReservedInstancesModificationsCommandOutput) => void), - cb?: (err: any, data?: DescribeReservedInstancesModificationsCommandOutput) => void - ): Promise | void { - const command = new DescribeReservedInstancesModificationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

- *

If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.

- *

For more information, see Reserved Instance Marketplace - * in the Amazon EC2 User Guide.

- */ - public describeReservedInstancesOfferings( + + /** + * @see {@link DescribeReservedInstancesOfferingsCommand} + */ + describeReservedInstancesOfferings( args: DescribeReservedInstancesOfferingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReservedInstancesOfferings( + describeReservedInstancesOfferings( args: DescribeReservedInstancesOfferingsCommandInput, cb: (err: any, data?: DescribeReservedInstancesOfferingsCommandOutput) => void ): void; - public describeReservedInstancesOfferings( + describeReservedInstancesOfferings( args: DescribeReservedInstancesOfferingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReservedInstancesOfferingsCommandOutput) => void ): void; - public describeReservedInstancesOfferings( - args: DescribeReservedInstancesOfferingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReservedInstancesOfferingsCommandOutput) => void), - cb?: (err: any, data?: DescribeReservedInstancesOfferingsCommandOutput) => void - ): Promise | void { - const command = new DescribeReservedInstancesOfferingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more of your route tables.

- *

Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.

- *

For more information, see Route tables in the - * Amazon Virtual Private Cloud User Guide.

- */ - public describeRouteTables( + + /** + * @see {@link DescribeRouteTablesCommand} + */ + describeRouteTables( args: DescribeRouteTablesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRouteTables( + describeRouteTables( args: DescribeRouteTablesCommandInput, cb: (err: any, data?: DescribeRouteTablesCommandOutput) => void ): void; - public describeRouteTables( + describeRouteTables( args: DescribeRouteTablesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRouteTablesCommandOutput) => void ): void; - public describeRouteTables( - args: DescribeRouteTablesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRouteTablesCommandOutput) => void), - cb?: (err: any, data?: DescribeRouteTablesCommandOutput) => void - ): Promise | void { - const command = new DescribeRouteTablesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Finds available schedules that meet the specified criteria.

- *

You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

- *

After you find a schedule that meets your needs, call PurchaseScheduledInstances - * to purchase Scheduled Instances with that schedule.

- */ - public describeScheduledInstanceAvailability( + + /** + * @see {@link DescribeScheduledInstanceAvailabilityCommand} + */ + describeScheduledInstanceAvailability( args: DescribeScheduledInstanceAvailabilityCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeScheduledInstanceAvailability( + describeScheduledInstanceAvailability( args: DescribeScheduledInstanceAvailabilityCommandInput, cb: (err: any, data?: DescribeScheduledInstanceAvailabilityCommandOutput) => void ): void; - public describeScheduledInstanceAvailability( + describeScheduledInstanceAvailability( args: DescribeScheduledInstanceAvailabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScheduledInstanceAvailabilityCommandOutput) => void ): void; - public describeScheduledInstanceAvailability( - args: DescribeScheduledInstanceAvailabilityCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeScheduledInstanceAvailabilityCommandOutput) => void), - cb?: (err: any, data?: DescribeScheduledInstanceAvailabilityCommandOutput) => void - ): Promise | void { - const command = new DescribeScheduledInstanceAvailabilityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified Scheduled Instances or all your Scheduled Instances.

- */ - public describeScheduledInstances( + + /** + * @see {@link DescribeScheduledInstancesCommand} + */ + describeScheduledInstances( args: DescribeScheduledInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeScheduledInstances( + describeScheduledInstances( args: DescribeScheduledInstancesCommandInput, cb: (err: any, data?: DescribeScheduledInstancesCommandOutput) => void ): void; - public describeScheduledInstances( + describeScheduledInstances( args: DescribeScheduledInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScheduledInstancesCommandOutput) => void ): void; - public describeScheduledInstances( - args: DescribeScheduledInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeScheduledInstancesCommandOutput) => void), - cb?: (err: any, data?: DescribeScheduledInstancesCommandOutput) => void - ): Promise | void { - const command = new DescribeScheduledInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

[VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.

- */ - public describeSecurityGroupReferences( + + /** + * @see {@link DescribeSecurityGroupReferencesCommand} + */ + describeSecurityGroupReferences( args: DescribeSecurityGroupReferencesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSecurityGroupReferences( + describeSecurityGroupReferences( args: DescribeSecurityGroupReferencesCommandInput, cb: (err: any, data?: DescribeSecurityGroupReferencesCommandOutput) => void ): void; - public describeSecurityGroupReferences( + describeSecurityGroupReferences( args: DescribeSecurityGroupReferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSecurityGroupReferencesCommandOutput) => void ): void; - public describeSecurityGroupReferences( - args: DescribeSecurityGroupReferencesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSecurityGroupReferencesCommandOutput) => void), - cb?: (err: any, data?: DescribeSecurityGroupReferencesCommandOutput) => void - ): Promise | void { - const command = new DescribeSecurityGroupReferencesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more of your security group rules.

- */ - public describeSecurityGroupRules( + + /** + * @see {@link DescribeSecurityGroupRulesCommand} + */ + describeSecurityGroupRules( args: DescribeSecurityGroupRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSecurityGroupRules( + describeSecurityGroupRules( args: DescribeSecurityGroupRulesCommandInput, cb: (err: any, data?: DescribeSecurityGroupRulesCommandOutput) => void ): void; - public describeSecurityGroupRules( + describeSecurityGroupRules( args: DescribeSecurityGroupRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSecurityGroupRulesCommandOutput) => void ): void; - public describeSecurityGroupRules( - args: DescribeSecurityGroupRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSecurityGroupRulesCommandOutput) => void), - cb?: (err: any, data?: DescribeSecurityGroupRulesCommandOutput) => void - ): Promise | void { - const command = new DescribeSecurityGroupRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified security groups or all of your security groups.

- *

A security group is for use with instances either in the EC2-Classic platform - * or in a specific VPC. For more information, see - * Amazon EC2 security groups in - * the Amazon Elastic Compute Cloud User Guide and - * Security groups for your VPC in the - * Amazon Virtual Private Cloud User Guide.

- * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- */ - public describeSecurityGroups( + + /** + * @see {@link DescribeSecurityGroupsCommand} + */ + describeSecurityGroups( args: DescribeSecurityGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSecurityGroups( + describeSecurityGroups( args: DescribeSecurityGroupsCommandInput, cb: (err: any, data?: DescribeSecurityGroupsCommandOutput) => void ): void; - public describeSecurityGroups( + describeSecurityGroups( args: DescribeSecurityGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSecurityGroupsCommandOutput) => void ): void; - public describeSecurityGroups( - args: DescribeSecurityGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSecurityGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeSecurityGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeSecurityGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified attribute of the specified snapshot. You can specify only one - * attribute at a time.

- *

For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.

- */ - public describeSnapshotAttribute( + + /** + * @see {@link DescribeSnapshotAttributeCommand} + */ + describeSnapshotAttribute( args: DescribeSnapshotAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSnapshotAttribute( + describeSnapshotAttribute( args: DescribeSnapshotAttributeCommandInput, cb: (err: any, data?: DescribeSnapshotAttributeCommandOutput) => void ): void; - public describeSnapshotAttribute( + describeSnapshotAttribute( args: DescribeSnapshotAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSnapshotAttributeCommandOutput) => void ): void; - public describeSnapshotAttribute( - args: DescribeSnapshotAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSnapshotAttributeCommandOutput) => void), - cb?: (err: any, data?: DescribeSnapshotAttributeCommandOutput) => void - ): Promise | void { - const command = new DescribeSnapshotAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified EBS snapshots available to you or all of the EBS snapshots - * available to you.

- *

The snapshots available to you include public snapshots, private snapshots that you own, - * and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume - * permissions.

- *

The create volume permissions fall into the following categories:

- *
    - *
  • - *

    - * public: The owner of the snapshot granted create volume - * permissions for the snapshot to the all group. All Amazon Web Services accounts have create - * volume permissions for these snapshots.

    - *
  • - *
  • - *

    - * explicit: The owner of the snapshot granted create volume - * permissions to a specific Amazon Web Services account.

    - *
  • - *
  • - *

    - * implicit: An Amazon Web Services account has implicit create volume permissions - * for all snapshots it owns.

    - *
  • - *
- *

The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot - * owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, - * Amazon EC2 returns all snapshots for which you have create volume permissions.

- *

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are - * returned. If you specify an invalid snapshot ID, an error is returned. If you specify a - * snapshot ID for which you do not have access, it is not included in the returned - * results.

- *

If you specify one or more snapshot owners using the OwnerIds option, only - * snapshots from the specified owners and for which you have access are returned. The results - * can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots - * owned by Amazon, or self for snapshots that you own.

- *

If you specify a list of restorable users, only snapshots with create snapshot permissions - * for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots), - * self for snapshots for which you own or have explicit permissions, or - * all for public snapshots.

- *

If you are describing a long list of snapshots, we recommend that you paginate the output to make the - * list more manageable. For more information, see Pagination.

- *

To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.

- *

For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.

- */ - public describeSnapshots( + + /** + * @see {@link DescribeSnapshotsCommand} + */ + describeSnapshots( args: DescribeSnapshotsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSnapshots( + describeSnapshots( args: DescribeSnapshotsCommandInput, cb: (err: any, data?: DescribeSnapshotsCommandOutput) => void ): void; - public describeSnapshots( + describeSnapshots( args: DescribeSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSnapshotsCommandOutput) => void ): void; - public describeSnapshots( - args: DescribeSnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSnapshotsCommandOutput) => void), - cb?: (err: any, data?: DescribeSnapshotsCommandOutput) => void - ): Promise | void { - const command = new DescribeSnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the storage tier status of one or more Amazon EBS snapshots.

- */ - public describeSnapshotTierStatus( + + /** + * @see {@link DescribeSnapshotTierStatusCommand} + */ + describeSnapshotTierStatus( args: DescribeSnapshotTierStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSnapshotTierStatus( + describeSnapshotTierStatus( args: DescribeSnapshotTierStatusCommandInput, cb: (err: any, data?: DescribeSnapshotTierStatusCommandOutput) => void ): void; - public describeSnapshotTierStatus( + describeSnapshotTierStatus( args: DescribeSnapshotTierStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSnapshotTierStatusCommandOutput) => void ): void; - public describeSnapshotTierStatus( - args: DescribeSnapshotTierStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSnapshotTierStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeSnapshotTierStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeSnapshotTierStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the data feed for Spot Instances. For more information, see Spot - * Instance data feed in the Amazon EC2 User Guide for Linux Instances.

- */ - public describeSpotDatafeedSubscription( + + /** + * @see {@link DescribeSpotDatafeedSubscriptionCommand} + */ + describeSpotDatafeedSubscription( args: DescribeSpotDatafeedSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSpotDatafeedSubscription( + describeSpotDatafeedSubscription( args: DescribeSpotDatafeedSubscriptionCommandInput, cb: (err: any, data?: DescribeSpotDatafeedSubscriptionCommandOutput) => void ): void; - public describeSpotDatafeedSubscription( + describeSpotDatafeedSubscription( args: DescribeSpotDatafeedSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSpotDatafeedSubscriptionCommandOutput) => void ): void; - public describeSpotDatafeedSubscription( - args: DescribeSpotDatafeedSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSpotDatafeedSubscriptionCommandOutput) => void), - cb?: (err: any, data?: DescribeSpotDatafeedSubscriptionCommandOutput) => void - ): Promise | void { - const command = new DescribeSpotDatafeedSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the running instances for the specified Spot Fleet.

- */ - public describeSpotFleetInstances( + + /** + * @see {@link DescribeSpotFleetInstancesCommand} + */ + describeSpotFleetInstances( args: DescribeSpotFleetInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSpotFleetInstances( + describeSpotFleetInstances( args: DescribeSpotFleetInstancesCommandInput, cb: (err: any, data?: DescribeSpotFleetInstancesCommandOutput) => void ): void; - public describeSpotFleetInstances( + describeSpotFleetInstances( args: DescribeSpotFleetInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSpotFleetInstancesCommandOutput) => void ): void; - public describeSpotFleetInstances( - args: DescribeSpotFleetInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSpotFleetInstancesCommandOutput) => void), - cb?: (err: any, data?: DescribeSpotFleetInstancesCommandOutput) => void - ): Promise | void { - const command = new DescribeSpotFleetInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the events for the specified Spot Fleet request during the specified - * time.

- *

Spot Fleet events are delayed by up to 30 seconds before they can be described. This - * ensures that you can query by the last evaluated time and not miss a recorded event. - * Spot Fleet events are available for 48 hours.

- *

For more information, see Monitor fleet events using Amazon - * EventBridge in the Amazon EC2 User Guide.

- */ - public describeSpotFleetRequestHistory( + + /** + * @see {@link DescribeSpotFleetRequestHistoryCommand} + */ + describeSpotFleetRequestHistory( args: DescribeSpotFleetRequestHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSpotFleetRequestHistory( + describeSpotFleetRequestHistory( args: DescribeSpotFleetRequestHistoryCommandInput, cb: (err: any, data?: DescribeSpotFleetRequestHistoryCommandOutput) => void ): void; - public describeSpotFleetRequestHistory( + describeSpotFleetRequestHistory( args: DescribeSpotFleetRequestHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSpotFleetRequestHistoryCommandOutput) => void ): void; - public describeSpotFleetRequestHistory( - args: DescribeSpotFleetRequestHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSpotFleetRequestHistoryCommandOutput) => void), - cb?: (err: any, data?: DescribeSpotFleetRequestHistoryCommandOutput) => void - ): Promise | void { - const command = new DescribeSpotFleetRequestHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes your Spot Fleet requests.

- *

Spot Fleet requests are deleted 48 hours after they are canceled and their instances - * are terminated.

- */ - public describeSpotFleetRequests( + + /** + * @see {@link DescribeSpotFleetRequestsCommand} + */ + describeSpotFleetRequests( args: DescribeSpotFleetRequestsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSpotFleetRequests( + describeSpotFleetRequests( args: DescribeSpotFleetRequestsCommandInput, cb: (err: any, data?: DescribeSpotFleetRequestsCommandOutput) => void ): void; - public describeSpotFleetRequests( + describeSpotFleetRequests( args: DescribeSpotFleetRequestsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSpotFleetRequestsCommandOutput) => void ): void; - public describeSpotFleetRequests( - args: DescribeSpotFleetRequestsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSpotFleetRequestsCommandOutput) => void), - cb?: (err: any, data?: DescribeSpotFleetRequestsCommandOutput) => void - ): Promise | void { - const command = new DescribeSpotFleetRequestsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified Spot Instance requests.

- *

You can use DescribeSpotInstanceRequests to find a running Spot Instance by - * examining the response. If the status of the Spot Instance is fulfilled, the - * instance ID appears in the response and contains the identifier of the instance. - * Alternatively, you can use DescribeInstances - * with a filter to look for instances where the instance lifecycle is - * spot.

- *

We recommend that you set MaxResults to a value between 5 and 1000 to - * limit the number of items returned. This paginates the output, which makes the list - * more manageable and returns the items faster. If the list of items exceeds your - * MaxResults value, then that number of items is returned along with a - * NextToken value that can be passed to a subsequent - * DescribeSpotInstanceRequests request to retrieve the remaining - * items.

- *

Spot Instance requests are deleted four hours after they are canceled and their instances are - * terminated.

- */ - public describeSpotInstanceRequests( + + /** + * @see {@link DescribeSpotInstanceRequestsCommand} + */ + describeSpotInstanceRequests( args: DescribeSpotInstanceRequestsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSpotInstanceRequests( + describeSpotInstanceRequests( args: DescribeSpotInstanceRequestsCommandInput, cb: (err: any, data?: DescribeSpotInstanceRequestsCommandOutput) => void ): void; - public describeSpotInstanceRequests( + describeSpotInstanceRequests( args: DescribeSpotInstanceRequestsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSpotInstanceRequestsCommandOutput) => void ): void; - public describeSpotInstanceRequests( - args: DescribeSpotInstanceRequestsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSpotInstanceRequestsCommandOutput) => void), - cb?: (err: any, data?: DescribeSpotInstanceRequestsCommandOutput) => void - ): Promise | void { - const command = new DescribeSpotInstanceRequestsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the Spot price history. For more information, see Spot Instance pricing history in the - * Amazon EC2 User Guide for Linux Instances.

- *

When you specify a start and end time, the operation returns the prices of the - * instance types within that time range. It also returns the last price change before the - * start time, which is the effective price as of the start time.

- */ - public describeSpotPriceHistory( + + /** + * @see {@link DescribeSpotPriceHistoryCommand} + */ + describeSpotPriceHistory( args: DescribeSpotPriceHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSpotPriceHistory( + describeSpotPriceHistory( args: DescribeSpotPriceHistoryCommandInput, cb: (err: any, data?: DescribeSpotPriceHistoryCommandOutput) => void ): void; - public describeSpotPriceHistory( + describeSpotPriceHistory( args: DescribeSpotPriceHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSpotPriceHistoryCommandOutput) => void ): void; - public describeSpotPriceHistory( - args: DescribeSpotPriceHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSpotPriceHistoryCommandOutput) => void), - cb?: (err: any, data?: DescribeSpotPriceHistoryCommandOutput) => void - ): Promise | void { - const command = new DescribeSpotPriceHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

[VPC only] Describes the stale security group rules for security groups in a specified VPC. - * Rules are stale when they reference a deleted security group in the same VPC or in a peer VPC, - * or if they reference a security group in a peer VPC for which the VPC peering connection has - * been deleted.

- */ - public describeStaleSecurityGroups( + + /** + * @see {@link DescribeStaleSecurityGroupsCommand} + */ + describeStaleSecurityGroups( args: DescribeStaleSecurityGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStaleSecurityGroups( + describeStaleSecurityGroups( args: DescribeStaleSecurityGroupsCommandInput, cb: (err: any, data?: DescribeStaleSecurityGroupsCommandOutput) => void ): void; - public describeStaleSecurityGroups( + describeStaleSecurityGroups( args: DescribeStaleSecurityGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStaleSecurityGroupsCommandOutput) => void ): void; - public describeStaleSecurityGroups( - args: DescribeStaleSecurityGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStaleSecurityGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeStaleSecurityGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeStaleSecurityGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the progress of the AMI store tasks. You can describe the store tasks for - * specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from - * the last 31 days.

- *

For each AMI task, the response indicates if the task is InProgress, - * Completed, or Failed. For tasks InProgress, the - * response shows the estimated progress as a percentage.

- *

Tasks are listed in reverse chronological order. Currently, only tasks from the past 31 - * days can be viewed.

- *

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the - * Amazon EC2 User Guide.

- *

For more information, see Store and restore an AMI using - * Amazon S3 in the Amazon EC2 User Guide.

- */ - public describeStoreImageTasks( + + /** + * @see {@link DescribeStoreImageTasksCommand} + */ + describeStoreImageTasks( args: DescribeStoreImageTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStoreImageTasks( + describeStoreImageTasks( args: DescribeStoreImageTasksCommandInput, cb: (err: any, data?: DescribeStoreImageTasksCommandOutput) => void ): void; - public describeStoreImageTasks( + describeStoreImageTasks( args: DescribeStoreImageTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStoreImageTasksCommandOutput) => void ): void; - public describeStoreImageTasks( - args: DescribeStoreImageTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStoreImageTasksCommandOutput) => void), - cb?: (err: any, data?: DescribeStoreImageTasksCommandOutput) => void - ): Promise | void { - const command = new DescribeStoreImageTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more of your subnets.

- *

For more information, see Your VPC and subnets in the - * Amazon Virtual Private Cloud User Guide.

- */ - public describeSubnets( + + /** + * @see {@link DescribeSubnetsCommand} + */ + describeSubnets( args: DescribeSubnetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSubnets( - args: DescribeSubnetsCommandInput, - cb: (err: any, data?: DescribeSubnetsCommandOutput) => void - ): void; - public describeSubnets( + describeSubnets(args: DescribeSubnetsCommandInput, cb: (err: any, data?: DescribeSubnetsCommandOutput) => void): void; + describeSubnets( args: DescribeSubnetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSubnetsCommandOutput) => void ): void; - public describeSubnets( - args: DescribeSubnetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSubnetsCommandOutput) => void), - cb?: (err: any, data?: DescribeSubnetsCommandOutput) => void - ): Promise | void { - const command = new DescribeSubnetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified tags for your EC2 resources.

- *

For more information about tags, see Tag your Amazon EC2 resources in the - * Amazon Elastic Compute Cloud User Guide.

- */ - public describeTags( - args: DescribeTagsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeTags(args: DescribeTagsCommandInput, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void; - public describeTags( + + /** + * @see {@link DescribeTagsCommand} + */ + describeTags(args: DescribeTagsCommandInput, options?: __HttpHandlerOptions): Promise; + describeTags(args: DescribeTagsCommandInput, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void; + describeTags( args: DescribeTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTagsCommandOutput) => void ): void; - public describeTags( - args: DescribeTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTagsCommandOutput) => void), - cb?: (err: any, data?: DescribeTagsCommandOutput) => void - ): Promise | void { - const command = new DescribeTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more Traffic Mirror filters.

- */ - public describeTrafficMirrorFilters( + + /** + * @see {@link DescribeTrafficMirrorFiltersCommand} + */ + describeTrafficMirrorFilters( args: DescribeTrafficMirrorFiltersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTrafficMirrorFilters( + describeTrafficMirrorFilters( args: DescribeTrafficMirrorFiltersCommandInput, cb: (err: any, data?: DescribeTrafficMirrorFiltersCommandOutput) => void ): void; - public describeTrafficMirrorFilters( + describeTrafficMirrorFilters( args: DescribeTrafficMirrorFiltersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrafficMirrorFiltersCommandOutput) => void ): void; - public describeTrafficMirrorFilters( - args: DescribeTrafficMirrorFiltersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTrafficMirrorFiltersCommandOutput) => void), - cb?: (err: any, data?: DescribeTrafficMirrorFiltersCommandOutput) => void - ): Promise | void { - const command = new DescribeTrafficMirrorFiltersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.

- */ - public describeTrafficMirrorSessions( + + /** + * @see {@link DescribeTrafficMirrorSessionsCommand} + */ + describeTrafficMirrorSessions( args: DescribeTrafficMirrorSessionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTrafficMirrorSessions( + describeTrafficMirrorSessions( args: DescribeTrafficMirrorSessionsCommandInput, cb: (err: any, data?: DescribeTrafficMirrorSessionsCommandOutput) => void ): void; - public describeTrafficMirrorSessions( + describeTrafficMirrorSessions( args: DescribeTrafficMirrorSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrafficMirrorSessionsCommandOutput) => void ): void; - public describeTrafficMirrorSessions( - args: DescribeTrafficMirrorSessionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTrafficMirrorSessionsCommandOutput) => void), - cb?: (err: any, data?: DescribeTrafficMirrorSessionsCommandOutput) => void - ): Promise | void { - const command = new DescribeTrafficMirrorSessionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Information about one or more Traffic Mirror targets.

- */ - public describeTrafficMirrorTargets( + + /** + * @see {@link DescribeTrafficMirrorTargetsCommand} + */ + describeTrafficMirrorTargets( args: DescribeTrafficMirrorTargetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTrafficMirrorTargets( + describeTrafficMirrorTargets( args: DescribeTrafficMirrorTargetsCommandInput, cb: (err: any, data?: DescribeTrafficMirrorTargetsCommandOutput) => void ): void; - public describeTrafficMirrorTargets( + describeTrafficMirrorTargets( args: DescribeTrafficMirrorTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrafficMirrorTargetsCommandOutput) => void ): void; - public describeTrafficMirrorTargets( - args: DescribeTrafficMirrorTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTrafficMirrorTargetsCommandOutput) => void), - cb?: (err: any, data?: DescribeTrafficMirrorTargetsCommandOutput) => void - ): Promise | void { - const command = new DescribeTrafficMirrorTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more attachments between resources and transit gateways. By default, all attachments are described. - * Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.

- */ - public describeTransitGatewayAttachments( + + /** + * @see {@link DescribeTransitGatewayAttachmentsCommand} + */ + describeTransitGatewayAttachments( args: DescribeTransitGatewayAttachmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTransitGatewayAttachments( + describeTransitGatewayAttachments( args: DescribeTransitGatewayAttachmentsCommandInput, cb: (err: any, data?: DescribeTransitGatewayAttachmentsCommandOutput) => void ): void; - public describeTransitGatewayAttachments( + describeTransitGatewayAttachments( args: DescribeTransitGatewayAttachmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTransitGatewayAttachmentsCommandOutput) => void ): void; - public describeTransitGatewayAttachments( - args: DescribeTransitGatewayAttachmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTransitGatewayAttachmentsCommandOutput) => void), - cb?: (err: any, data?: DescribeTransitGatewayAttachmentsCommandOutput) => void - ): Promise | void { - const command = new DescribeTransitGatewayAttachmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more Connect peers.

- */ - public describeTransitGatewayConnectPeers( + + /** + * @see {@link DescribeTransitGatewayConnectPeersCommand} + */ + describeTransitGatewayConnectPeers( args: DescribeTransitGatewayConnectPeersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTransitGatewayConnectPeers( + describeTransitGatewayConnectPeers( args: DescribeTransitGatewayConnectPeersCommandInput, cb: (err: any, data?: DescribeTransitGatewayConnectPeersCommandOutput) => void ): void; - public describeTransitGatewayConnectPeers( + describeTransitGatewayConnectPeers( args: DescribeTransitGatewayConnectPeersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTransitGatewayConnectPeersCommandOutput) => void ): void; - public describeTransitGatewayConnectPeers( - args: DescribeTransitGatewayConnectPeersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTransitGatewayConnectPeersCommandOutput) => void), - cb?: (err: any, data?: DescribeTransitGatewayConnectPeersCommandOutput) => void - ): Promise | void { - const command = new DescribeTransitGatewayConnectPeersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more Connect attachments.

- */ - public describeTransitGatewayConnects( + + /** + * @see {@link DescribeTransitGatewayConnectsCommand} + */ + describeTransitGatewayConnects( args: DescribeTransitGatewayConnectsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTransitGatewayConnects( + describeTransitGatewayConnects( args: DescribeTransitGatewayConnectsCommandInput, cb: (err: any, data?: DescribeTransitGatewayConnectsCommandOutput) => void ): void; - public describeTransitGatewayConnects( + describeTransitGatewayConnects( args: DescribeTransitGatewayConnectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTransitGatewayConnectsCommandOutput) => void ): void; - public describeTransitGatewayConnects( - args: DescribeTransitGatewayConnectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTransitGatewayConnectsCommandOutput) => void), - cb?: (err: any, data?: DescribeTransitGatewayConnectsCommandOutput) => void - ): Promise | void { - const command = new DescribeTransitGatewayConnectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more transit gateway multicast domains.

- */ - public describeTransitGatewayMulticastDomains( + + /** + * @see {@link DescribeTransitGatewayMulticastDomainsCommand} + */ + describeTransitGatewayMulticastDomains( args: DescribeTransitGatewayMulticastDomainsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTransitGatewayMulticastDomains( + describeTransitGatewayMulticastDomains( args: DescribeTransitGatewayMulticastDomainsCommandInput, cb: (err: any, data?: DescribeTransitGatewayMulticastDomainsCommandOutput) => void ): void; - public describeTransitGatewayMulticastDomains( + describeTransitGatewayMulticastDomains( args: DescribeTransitGatewayMulticastDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTransitGatewayMulticastDomainsCommandOutput) => void ): void; - public describeTransitGatewayMulticastDomains( - args: DescribeTransitGatewayMulticastDomainsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeTransitGatewayMulticastDomainsCommandOutput) => void), - cb?: (err: any, data?: DescribeTransitGatewayMulticastDomainsCommandOutput) => void - ): Promise | void { - const command = new DescribeTransitGatewayMulticastDomainsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes your transit gateway peering attachments.

- */ - public describeTransitGatewayPeeringAttachments( + + /** + * @see {@link DescribeTransitGatewayPeeringAttachmentsCommand} + */ + describeTransitGatewayPeeringAttachments( args: DescribeTransitGatewayPeeringAttachmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTransitGatewayPeeringAttachments( + describeTransitGatewayPeeringAttachments( args: DescribeTransitGatewayPeeringAttachmentsCommandInput, cb: (err: any, data?: DescribeTransitGatewayPeeringAttachmentsCommandOutput) => void ): void; - public describeTransitGatewayPeeringAttachments( + describeTransitGatewayPeeringAttachments( args: DescribeTransitGatewayPeeringAttachmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTransitGatewayPeeringAttachmentsCommandOutput) => void ): void; - public describeTransitGatewayPeeringAttachments( - args: DescribeTransitGatewayPeeringAttachmentsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeTransitGatewayPeeringAttachmentsCommandOutput) => void), - cb?: (err: any, data?: DescribeTransitGatewayPeeringAttachmentsCommandOutput) => void - ): Promise | void { - const command = new DescribeTransitGatewayPeeringAttachmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more transit gateway route policy tables.

- */ - public describeTransitGatewayPolicyTables( + + /** + * @see {@link DescribeTransitGatewayPolicyTablesCommand} + */ + describeTransitGatewayPolicyTables( args: DescribeTransitGatewayPolicyTablesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTransitGatewayPolicyTables( + describeTransitGatewayPolicyTables( args: DescribeTransitGatewayPolicyTablesCommandInput, cb: (err: any, data?: DescribeTransitGatewayPolicyTablesCommandOutput) => void ): void; - public describeTransitGatewayPolicyTables( + describeTransitGatewayPolicyTables( args: DescribeTransitGatewayPolicyTablesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTransitGatewayPolicyTablesCommandOutput) => void ): void; - public describeTransitGatewayPolicyTables( - args: DescribeTransitGatewayPolicyTablesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTransitGatewayPolicyTablesCommandOutput) => void), - cb?: (err: any, data?: DescribeTransitGatewayPolicyTablesCommandOutput) => void - ): Promise | void { - const command = new DescribeTransitGatewayPolicyTablesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more transit gateway route table advertisements.

- */ - public describeTransitGatewayRouteTableAnnouncements( + + /** + * @see {@link DescribeTransitGatewayRouteTableAnnouncementsCommand} + */ + describeTransitGatewayRouteTableAnnouncements( args: DescribeTransitGatewayRouteTableAnnouncementsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTransitGatewayRouteTableAnnouncements( + describeTransitGatewayRouteTableAnnouncements( args: DescribeTransitGatewayRouteTableAnnouncementsCommandInput, cb: (err: any, data?: DescribeTransitGatewayRouteTableAnnouncementsCommandOutput) => void ): void; - public describeTransitGatewayRouteTableAnnouncements( + describeTransitGatewayRouteTableAnnouncements( args: DescribeTransitGatewayRouteTableAnnouncementsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTransitGatewayRouteTableAnnouncementsCommandOutput) => void ): void; - public describeTransitGatewayRouteTableAnnouncements( - args: DescribeTransitGatewayRouteTableAnnouncementsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeTransitGatewayRouteTableAnnouncementsCommandOutput) => void), - cb?: (err: any, data?: DescribeTransitGatewayRouteTableAnnouncementsCommandOutput) => void - ): Promise | void { - const command = new DescribeTransitGatewayRouteTableAnnouncementsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. - * Alternatively, you can filter the results.

- */ - public describeTransitGatewayRouteTables( + + /** + * @see {@link DescribeTransitGatewayRouteTablesCommand} + */ + describeTransitGatewayRouteTables( args: DescribeTransitGatewayRouteTablesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTransitGatewayRouteTables( + describeTransitGatewayRouteTables( args: DescribeTransitGatewayRouteTablesCommandInput, cb: (err: any, data?: DescribeTransitGatewayRouteTablesCommandOutput) => void ): void; - public describeTransitGatewayRouteTables( + describeTransitGatewayRouteTables( args: DescribeTransitGatewayRouteTablesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTransitGatewayRouteTablesCommandOutput) => void ): void; - public describeTransitGatewayRouteTables( - args: DescribeTransitGatewayRouteTablesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTransitGatewayRouteTablesCommandOutput) => void), - cb?: (err: any, data?: DescribeTransitGatewayRouteTablesCommandOutput) => void - ): Promise | void { - const command = new DescribeTransitGatewayRouteTablesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can - * filter the results.

- */ - public describeTransitGateways( + + /** + * @see {@link DescribeTransitGatewaysCommand} + */ + describeTransitGateways( args: DescribeTransitGatewaysCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTransitGateways( + describeTransitGateways( args: DescribeTransitGatewaysCommandInput, cb: (err: any, data?: DescribeTransitGatewaysCommandOutput) => void ): void; - public describeTransitGateways( + describeTransitGateways( args: DescribeTransitGatewaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTransitGatewaysCommandOutput) => void ): void; - public describeTransitGateways( - args: DescribeTransitGatewaysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTransitGatewaysCommandOutput) => void), - cb?: (err: any, data?: DescribeTransitGatewaysCommandOutput) => void - ): Promise | void { - const command = new DescribeTransitGatewaysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more VPC attachments. By default, all VPC attachments are described. - * Alternatively, you can filter the results.

- */ - public describeTransitGatewayVpcAttachments( + + /** + * @see {@link DescribeTransitGatewayVpcAttachmentsCommand} + */ + describeTransitGatewayVpcAttachments( args: DescribeTransitGatewayVpcAttachmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTransitGatewayVpcAttachments( + describeTransitGatewayVpcAttachments( args: DescribeTransitGatewayVpcAttachmentsCommandInput, cb: (err: any, data?: DescribeTransitGatewayVpcAttachmentsCommandOutput) => void ): void; - public describeTransitGatewayVpcAttachments( + describeTransitGatewayVpcAttachments( args: DescribeTransitGatewayVpcAttachmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTransitGatewayVpcAttachmentsCommandOutput) => void ): void; - public describeTransitGatewayVpcAttachments( - args: DescribeTransitGatewayVpcAttachmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTransitGatewayVpcAttachmentsCommandOutput) => void), - cb?: (err: any, data?: DescribeTransitGatewayVpcAttachmentsCommandOutput) => void - ): Promise | void { - const command = new DescribeTransitGatewayVpcAttachmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This API action is currently in limited preview only. - * If you are interested in using this feature, contact your account manager.

- *
- *

Describes one or more network interface trunk associations.

- */ - public describeTrunkInterfaceAssociations( + + /** + * @see {@link DescribeTrunkInterfaceAssociationsCommand} + */ + describeTrunkInterfaceAssociations( args: DescribeTrunkInterfaceAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTrunkInterfaceAssociations( + describeTrunkInterfaceAssociations( args: DescribeTrunkInterfaceAssociationsCommandInput, cb: (err: any, data?: DescribeTrunkInterfaceAssociationsCommandOutput) => void ): void; - public describeTrunkInterfaceAssociations( + describeTrunkInterfaceAssociations( args: DescribeTrunkInterfaceAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrunkInterfaceAssociationsCommandOutput) => void ): void; - public describeTrunkInterfaceAssociations( - args: DescribeTrunkInterfaceAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTrunkInterfaceAssociationsCommandOutput) => void), - cb?: (err: any, data?: DescribeTrunkInterfaceAssociationsCommandOutput) => void - ): Promise | void { - const command = new DescribeTrunkInterfaceAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describe Amazon Web Services Verified Access endpoints.

- */ - public describeVerifiedAccessEndpoints( + + /** + * @see {@link DescribeVerifiedAccessEndpointsCommand} + */ + describeVerifiedAccessEndpoints( args: DescribeVerifiedAccessEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVerifiedAccessEndpoints( + describeVerifiedAccessEndpoints( args: DescribeVerifiedAccessEndpointsCommandInput, cb: (err: any, data?: DescribeVerifiedAccessEndpointsCommandOutput) => void ): void; - public describeVerifiedAccessEndpoints( + describeVerifiedAccessEndpoints( args: DescribeVerifiedAccessEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVerifiedAccessEndpointsCommandOutput) => void ): void; - public describeVerifiedAccessEndpoints( - args: DescribeVerifiedAccessEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVerifiedAccessEndpointsCommandOutput) => void), - cb?: (err: any, data?: DescribeVerifiedAccessEndpointsCommandOutput) => void - ): Promise | void { - const command = new DescribeVerifiedAccessEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describe details of existing Verified Access groups.

- */ - public describeVerifiedAccessGroups( + + /** + * @see {@link DescribeVerifiedAccessGroupsCommand} + */ + describeVerifiedAccessGroups( args: DescribeVerifiedAccessGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVerifiedAccessGroups( + describeVerifiedAccessGroups( args: DescribeVerifiedAccessGroupsCommandInput, cb: (err: any, data?: DescribeVerifiedAccessGroupsCommandOutput) => void ): void; - public describeVerifiedAccessGroups( + describeVerifiedAccessGroups( args: DescribeVerifiedAccessGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVerifiedAccessGroupsCommandOutput) => void ): void; - public describeVerifiedAccessGroups( - args: DescribeVerifiedAccessGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVerifiedAccessGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeVerifiedAccessGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeVerifiedAccessGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the current logging configuration for the Amazon Web Services Verified Access instances.

- */ - public describeVerifiedAccessInstanceLoggingConfigurations( + + /** + * @see {@link DescribeVerifiedAccessInstanceLoggingConfigurationsCommand} + */ + describeVerifiedAccessInstanceLoggingConfigurations( args: DescribeVerifiedAccessInstanceLoggingConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVerifiedAccessInstanceLoggingConfigurations( + describeVerifiedAccessInstanceLoggingConfigurations( args: DescribeVerifiedAccessInstanceLoggingConfigurationsCommandInput, cb: (err: any, data?: DescribeVerifiedAccessInstanceLoggingConfigurationsCommandOutput) => void ): void; - public describeVerifiedAccessInstanceLoggingConfigurations( + describeVerifiedAccessInstanceLoggingConfigurations( args: DescribeVerifiedAccessInstanceLoggingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVerifiedAccessInstanceLoggingConfigurationsCommandOutput) => void ): void; - public describeVerifiedAccessInstanceLoggingConfigurations( - args: DescribeVerifiedAccessInstanceLoggingConfigurationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeVerifiedAccessInstanceLoggingConfigurationsCommandOutput) => void), - cb?: (err: any, data?: DescribeVerifiedAccessInstanceLoggingConfigurationsCommandOutput) => void - ): Promise | void { - const command = new DescribeVerifiedAccessInstanceLoggingConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describe Verified Access instances.

- */ - public describeVerifiedAccessInstances( + + /** + * @see {@link DescribeVerifiedAccessInstancesCommand} + */ + describeVerifiedAccessInstances( args: DescribeVerifiedAccessInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVerifiedAccessInstances( + describeVerifiedAccessInstances( args: DescribeVerifiedAccessInstancesCommandInput, cb: (err: any, data?: DescribeVerifiedAccessInstancesCommandOutput) => void ): void; - public describeVerifiedAccessInstances( + describeVerifiedAccessInstances( args: DescribeVerifiedAccessInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVerifiedAccessInstancesCommandOutput) => void ): void; - public describeVerifiedAccessInstances( - args: DescribeVerifiedAccessInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVerifiedAccessInstancesCommandOutput) => void), - cb?: (err: any, data?: DescribeVerifiedAccessInstancesCommandOutput) => void - ): Promise | void { - const command = new DescribeVerifiedAccessInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describe details of existing Verified Access trust providers.

- */ - public describeVerifiedAccessTrustProviders( + + /** + * @see {@link DescribeVerifiedAccessTrustProvidersCommand} + */ + describeVerifiedAccessTrustProviders( args: DescribeVerifiedAccessTrustProvidersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVerifiedAccessTrustProviders( + describeVerifiedAccessTrustProviders( args: DescribeVerifiedAccessTrustProvidersCommandInput, cb: (err: any, data?: DescribeVerifiedAccessTrustProvidersCommandOutput) => void ): void; - public describeVerifiedAccessTrustProviders( + describeVerifiedAccessTrustProviders( args: DescribeVerifiedAccessTrustProvidersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVerifiedAccessTrustProvidersCommandOutput) => void ): void; - public describeVerifiedAccessTrustProviders( - args: DescribeVerifiedAccessTrustProvidersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVerifiedAccessTrustProvidersCommandOutput) => void), - cb?: (err: any, data?: DescribeVerifiedAccessTrustProvidersCommandOutput) => void - ): Promise | void { - const command = new DescribeVerifiedAccessTrustProvidersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified attribute of the specified volume. You can specify only one - * attribute at a time.

- *

For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.

- */ - public describeVolumeAttribute( + + /** + * @see {@link DescribeVolumeAttributeCommand} + */ + describeVolumeAttribute( args: DescribeVolumeAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVolumeAttribute( + describeVolumeAttribute( args: DescribeVolumeAttributeCommandInput, cb: (err: any, data?: DescribeVolumeAttributeCommandOutput) => void ): void; - public describeVolumeAttribute( + describeVolumeAttribute( args: DescribeVolumeAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVolumeAttributeCommandOutput) => void ): void; - public describeVolumeAttribute( - args: DescribeVolumeAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVolumeAttributeCommandOutput) => void), - cb?: (err: any, data?: DescribeVolumeAttributeCommandOutput) => void - ): Promise | void { - const command = new DescribeVolumeAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified EBS volumes or all of your EBS volumes.

- *

If you are describing a long list of volumes, we recommend that you paginate the output to make the list - * more manageable. For more information, see Pagination.

- *

For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.

- */ - public describeVolumes( + + /** + * @see {@link DescribeVolumesCommand} + */ + describeVolumes( args: DescribeVolumesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVolumes( - args: DescribeVolumesCommandInput, - cb: (err: any, data?: DescribeVolumesCommandOutput) => void - ): void; - public describeVolumes( + describeVolumes(args: DescribeVolumesCommandInput, cb: (err: any, data?: DescribeVolumesCommandOutput) => void): void; + describeVolumes( args: DescribeVolumesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVolumesCommandOutput) => void ): void; - public describeVolumes( - args: DescribeVolumesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVolumesCommandOutput) => void), - cb?: (err: any, data?: DescribeVolumesCommandOutput) => void - ): Promise | void { - const command = new DescribeVolumesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the most recent volume modification request for the specified EBS volumes.

- *

If a volume has never been modified, some information in the output will be null. - * If a volume has been modified more than once, the output includes only the most - * recent modification request.

- *

You can also use CloudWatch Events to check the status of a modification to an EBS - * volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see - * Monitor the progress of volume modifications in the Amazon Elastic Compute Cloud User Guide.

- */ - public describeVolumesModifications( + + /** + * @see {@link DescribeVolumesModificationsCommand} + */ + describeVolumesModifications( args: DescribeVolumesModificationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVolumesModifications( + describeVolumesModifications( args: DescribeVolumesModificationsCommandInput, cb: (err: any, data?: DescribeVolumesModificationsCommandOutput) => void ): void; - public describeVolumesModifications( + describeVolumesModifications( args: DescribeVolumesModificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVolumesModificationsCommandOutput) => void ): void; - public describeVolumesModifications( - args: DescribeVolumesModificationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVolumesModificationsCommandOutput) => void), - cb?: (err: any, data?: DescribeVolumesModificationsCommandOutput) => void - ): Promise | void { - const command = new DescribeVolumesModificationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the status of the specified volumes. Volume status provides the result of the - * checks performed on your volumes to determine events that can impair the performance of your - * volumes. The performance of a volume can be affected if an issue occurs on the volume's - * underlying host. If the volume's underlying host experiences a power outage or system issue, - * after the system is restored, there could be data inconsistencies on the volume. Volume events - * notify you if this occurs. Volume actions notify you if any action needs to be taken in - * response to the event.

- *

The DescribeVolumeStatus operation provides the following information about - * the specified volumes:

- *

- * Status: Reflects the current status of the volume. The possible - * values are ok, impaired , warning, or - * insufficient-data. If all checks pass, the overall status of the volume is - * ok. If the check fails, the overall status is impaired. If the - * status is insufficient-data, then the checks might still be taking place on your - * volume at the time. We recommend that you retry the request. For more information about volume - * status, see Monitor the status of your volumes in the - * Amazon Elastic Compute Cloud User Guide.

- *

- * Events: Reflect the cause of a volume status and might require you to - * take action. For example, if your volume returns an impaired status, then the - * volume event might be potential-data-inconsistency. This means that your volume - * has been affected by an issue with the underlying host, has all I/O operations disabled, and - * might have inconsistent data.

- *

- * Actions: Reflect the actions you might have to take in response to an - * event. For example, if the status of the volume is impaired and the volume event - * shows potential-data-inconsistency, then the action shows - * enable-volume-io. This means that you may want to enable the I/O operations for - * the volume by calling the EnableVolumeIO action and then check the volume - * for data consistency.

- *

Volume status is based on the volume status checks, and does not reflect the volume state. - * Therefore, volume status does not indicate volumes in the error state (for - * example, when a volume is incapable of accepting I/O.)

- */ - public describeVolumeStatus( + + /** + * @see {@link DescribeVolumeStatusCommand} + */ + describeVolumeStatus( args: DescribeVolumeStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVolumeStatus( + describeVolumeStatus( args: DescribeVolumeStatusCommandInput, cb: (err: any, data?: DescribeVolumeStatusCommandOutput) => void ): void; - public describeVolumeStatus( + describeVolumeStatus( args: DescribeVolumeStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVolumeStatusCommandOutput) => void ): void; - public describeVolumeStatus( - args: DescribeVolumeStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVolumeStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeVolumeStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeVolumeStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

- */ - public describeVpcAttribute( + + /** + * @see {@link DescribeVpcAttributeCommand} + */ + describeVpcAttribute( args: DescribeVpcAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVpcAttribute( + describeVpcAttribute( args: DescribeVpcAttributeCommandInput, cb: (err: any, data?: DescribeVpcAttributeCommandOutput) => void ): void; - public describeVpcAttribute( + describeVpcAttribute( args: DescribeVpcAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVpcAttributeCommandOutput) => void ): void; - public describeVpcAttribute( - args: DescribeVpcAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVpcAttributeCommandOutput) => void), - cb?: (err: any, data?: DescribeVpcAttributeCommandOutput) => void - ): Promise | void { - const command = new DescribeVpcAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the ClassicLink status of one or more VPCs.

- * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- */ - public describeVpcClassicLink( + + /** + * @see {@link DescribeVpcClassicLinkCommand} + */ + describeVpcClassicLink( args: DescribeVpcClassicLinkCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVpcClassicLink( + describeVpcClassicLink( args: DescribeVpcClassicLinkCommandInput, cb: (err: any, data?: DescribeVpcClassicLinkCommandOutput) => void ): void; - public describeVpcClassicLink( + describeVpcClassicLink( args: DescribeVpcClassicLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVpcClassicLinkCommandOutput) => void ): void; - public describeVpcClassicLink( - args: DescribeVpcClassicLinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVpcClassicLinkCommandOutput) => void), - cb?: (err: any, data?: DescribeVpcClassicLinkCommandOutput) => void - ): Promise | void { - const command = new DescribeVpcClassicLinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- *

Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS - * hostname of a linked EC2-Classic instance resolves to its private IP address when - * addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname - * of an instance in a VPC resolves to its private IP address when addressed from a linked - * EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

- */ - public describeVpcClassicLinkDnsSupport( + + /** + * @see {@link DescribeVpcClassicLinkDnsSupportCommand} + */ + describeVpcClassicLinkDnsSupport( args: DescribeVpcClassicLinkDnsSupportCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVpcClassicLinkDnsSupport( + describeVpcClassicLinkDnsSupport( args: DescribeVpcClassicLinkDnsSupportCommandInput, cb: (err: any, data?: DescribeVpcClassicLinkDnsSupportCommandOutput) => void ): void; - public describeVpcClassicLinkDnsSupport( + describeVpcClassicLinkDnsSupport( args: DescribeVpcClassicLinkDnsSupportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVpcClassicLinkDnsSupportCommandOutput) => void ): void; - public describeVpcClassicLinkDnsSupport( - args: DescribeVpcClassicLinkDnsSupportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVpcClassicLinkDnsSupportCommandOutput) => void), - cb?: (err: any, data?: DescribeVpcClassicLinkDnsSupportCommandOutput) => void - ): Promise | void { - const command = new DescribeVpcClassicLinkDnsSupportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the connection notifications for VPC endpoints and VPC endpoint - * services.

- */ - public describeVpcEndpointConnectionNotifications( + + /** + * @see {@link DescribeVpcEndpointConnectionNotificationsCommand} + */ + describeVpcEndpointConnectionNotifications( args: DescribeVpcEndpointConnectionNotificationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVpcEndpointConnectionNotifications( + describeVpcEndpointConnectionNotifications( args: DescribeVpcEndpointConnectionNotificationsCommandInput, cb: (err: any, data?: DescribeVpcEndpointConnectionNotificationsCommandOutput) => void ): void; - public describeVpcEndpointConnectionNotifications( + describeVpcEndpointConnectionNotifications( args: DescribeVpcEndpointConnectionNotificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVpcEndpointConnectionNotificationsCommandOutput) => void ): void; - public describeVpcEndpointConnectionNotifications( - args: DescribeVpcEndpointConnectionNotificationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeVpcEndpointConnectionNotificationsCommandOutput) => void), - cb?: (err: any, data?: DescribeVpcEndpointConnectionNotificationsCommandOutput) => void - ): Promise | void { - const command = new DescribeVpcEndpointConnectionNotificationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the VPC endpoint connections to your VPC endpoint services, including any - * endpoints that are pending your acceptance.

- */ - public describeVpcEndpointConnections( + + /** + * @see {@link DescribeVpcEndpointConnectionsCommand} + */ + describeVpcEndpointConnections( args: DescribeVpcEndpointConnectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVpcEndpointConnections( + describeVpcEndpointConnections( args: DescribeVpcEndpointConnectionsCommandInput, cb: (err: any, data?: DescribeVpcEndpointConnectionsCommandOutput) => void ): void; - public describeVpcEndpointConnections( + describeVpcEndpointConnections( args: DescribeVpcEndpointConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVpcEndpointConnectionsCommandOutput) => void ): void; - public describeVpcEndpointConnections( - args: DescribeVpcEndpointConnectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVpcEndpointConnectionsCommandOutput) => void), - cb?: (err: any, data?: DescribeVpcEndpointConnectionsCommandOutput) => void - ): Promise | void { - const command = new DescribeVpcEndpointConnectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes your VPC endpoints.

- */ - public describeVpcEndpoints( + + /** + * @see {@link DescribeVpcEndpointsCommand} + */ + describeVpcEndpoints( args: DescribeVpcEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVpcEndpoints( + describeVpcEndpoints( args: DescribeVpcEndpointsCommandInput, cb: (err: any, data?: DescribeVpcEndpointsCommandOutput) => void ): void; - public describeVpcEndpoints( + describeVpcEndpoints( args: DescribeVpcEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVpcEndpointsCommandOutput) => void ): void; - public describeVpcEndpoints( - args: DescribeVpcEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVpcEndpointsCommandOutput) => void), - cb?: (err: any, data?: DescribeVpcEndpointsCommandOutput) => void - ): Promise | void { - const command = new DescribeVpcEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the VPC endpoint service configurations in your account (your services).

- */ - public describeVpcEndpointServiceConfigurations( + + /** + * @see {@link DescribeVpcEndpointServiceConfigurationsCommand} + */ + describeVpcEndpointServiceConfigurations( args: DescribeVpcEndpointServiceConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVpcEndpointServiceConfigurations( + describeVpcEndpointServiceConfigurations( args: DescribeVpcEndpointServiceConfigurationsCommandInput, cb: (err: any, data?: DescribeVpcEndpointServiceConfigurationsCommandOutput) => void ): void; - public describeVpcEndpointServiceConfigurations( + describeVpcEndpointServiceConfigurations( args: DescribeVpcEndpointServiceConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVpcEndpointServiceConfigurationsCommandOutput) => void ): void; - public describeVpcEndpointServiceConfigurations( - args: DescribeVpcEndpointServiceConfigurationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeVpcEndpointServiceConfigurationsCommandOutput) => void), - cb?: (err: any, data?: DescribeVpcEndpointServiceConfigurationsCommandOutput) => void - ): Promise | void { - const command = new DescribeVpcEndpointServiceConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the principals (service consumers) that are permitted to discover your VPC - * endpoint service.

- */ - public describeVpcEndpointServicePermissions( + + /** + * @see {@link DescribeVpcEndpointServicePermissionsCommand} + */ + describeVpcEndpointServicePermissions( args: DescribeVpcEndpointServicePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVpcEndpointServicePermissions( + describeVpcEndpointServicePermissions( args: DescribeVpcEndpointServicePermissionsCommandInput, cb: (err: any, data?: DescribeVpcEndpointServicePermissionsCommandOutput) => void ): void; - public describeVpcEndpointServicePermissions( + describeVpcEndpointServicePermissions( args: DescribeVpcEndpointServicePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVpcEndpointServicePermissionsCommandOutput) => void ): void; - public describeVpcEndpointServicePermissions( - args: DescribeVpcEndpointServicePermissionsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeVpcEndpointServicePermissionsCommandOutput) => void), - cb?: (err: any, data?: DescribeVpcEndpointServicePermissionsCommandOutput) => void - ): Promise | void { - const command = new DescribeVpcEndpointServicePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes available services to which you can create a VPC endpoint.

- *

When the service provider and the consumer have different accounts in multiple - * Availability Zones, and the consumer views the VPC endpoint service information, the - * response only includes the common Availability Zones. For example, when the service - * provider account uses us-east-1a and us-east-1c and the - * consumer uses us-east-1a and us-east-1b, the response includes - * the VPC endpoint services in the common Availability Zone, - * us-east-1a.

- */ - public describeVpcEndpointServices( + + /** + * @see {@link DescribeVpcEndpointServicesCommand} + */ + describeVpcEndpointServices( args: DescribeVpcEndpointServicesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVpcEndpointServices( + describeVpcEndpointServices( args: DescribeVpcEndpointServicesCommandInput, cb: (err: any, data?: DescribeVpcEndpointServicesCommandOutput) => void ): void; - public describeVpcEndpointServices( + describeVpcEndpointServices( args: DescribeVpcEndpointServicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVpcEndpointServicesCommandOutput) => void ): void; - public describeVpcEndpointServices( - args: DescribeVpcEndpointServicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVpcEndpointServicesCommandOutput) => void), - cb?: (err: any, data?: DescribeVpcEndpointServicesCommandOutput) => void - ): Promise | void { - const command = new DescribeVpcEndpointServicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more of your VPC peering connections.

- */ - public describeVpcPeeringConnections( + + /** + * @see {@link DescribeVpcPeeringConnectionsCommand} + */ + describeVpcPeeringConnections( args: DescribeVpcPeeringConnectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVpcPeeringConnections( + describeVpcPeeringConnections( args: DescribeVpcPeeringConnectionsCommandInput, cb: (err: any, data?: DescribeVpcPeeringConnectionsCommandOutput) => void ): void; - public describeVpcPeeringConnections( + describeVpcPeeringConnections( args: DescribeVpcPeeringConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVpcPeeringConnectionsCommandOutput) => void ): void; - public describeVpcPeeringConnections( - args: DescribeVpcPeeringConnectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVpcPeeringConnectionsCommandOutput) => void), - cb?: (err: any, data?: DescribeVpcPeeringConnectionsCommandOutput) => void - ): Promise | void { - const command = new DescribeVpcPeeringConnectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more of your VPCs.

- */ - public describeVpcs( - args: DescribeVpcsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeVpcs(args: DescribeVpcsCommandInput, cb: (err: any, data?: DescribeVpcsCommandOutput) => void): void; - public describeVpcs( + + /** + * @see {@link DescribeVpcsCommand} + */ + describeVpcs(args: DescribeVpcsCommandInput, options?: __HttpHandlerOptions): Promise; + describeVpcs(args: DescribeVpcsCommandInput, cb: (err: any, data?: DescribeVpcsCommandOutput) => void): void; + describeVpcs( args: DescribeVpcsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVpcsCommandOutput) => void ): void; - public describeVpcs( - args: DescribeVpcsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVpcsCommandOutput) => void), - cb?: (err: any, data?: DescribeVpcsCommandOutput) => void - ): Promise | void { - const command = new DescribeVpcsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more of your VPN connections.

- *

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN - * User Guide.

- */ - public describeVpnConnections( + + /** + * @see {@link DescribeVpnConnectionsCommand} + */ + describeVpnConnections( args: DescribeVpnConnectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVpnConnections( + describeVpnConnections( args: DescribeVpnConnectionsCommandInput, cb: (err: any, data?: DescribeVpnConnectionsCommandOutput) => void ): void; - public describeVpnConnections( + describeVpnConnections( args: DescribeVpnConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVpnConnectionsCommandOutput) => void ): void; - public describeVpnConnections( - args: DescribeVpnConnectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVpnConnectionsCommandOutput) => void), - cb?: (err: any, data?: DescribeVpnConnectionsCommandOutput) => void - ): Promise | void { - const command = new DescribeVpnConnectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more of your virtual private gateways.

- *

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN - * User Guide.

- */ - public describeVpnGateways( + + /** + * @see {@link DescribeVpnGatewaysCommand} + */ + describeVpnGateways( args: DescribeVpnGatewaysCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVpnGateways( + describeVpnGateways( args: DescribeVpnGatewaysCommandInput, cb: (err: any, data?: DescribeVpnGatewaysCommandOutput) => void ): void; - public describeVpnGateways( + describeVpnGateways( args: DescribeVpnGatewaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVpnGatewaysCommandOutput) => void ): void; - public describeVpnGateways( - args: DescribeVpnGatewaysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVpnGatewaysCommandOutput) => void), - cb?: (err: any, data?: DescribeVpnGatewaysCommandOutput) => void - ): Promise | void { - const command = new DescribeVpnGatewaysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- *

Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.

- */ - public detachClassicLinkVpc( + + /** + * @see {@link DetachClassicLinkVpcCommand} + */ + detachClassicLinkVpc( args: DetachClassicLinkVpcCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachClassicLinkVpc( + detachClassicLinkVpc( args: DetachClassicLinkVpcCommandInput, cb: (err: any, data?: DetachClassicLinkVpcCommandOutput) => void ): void; - public detachClassicLinkVpc( + detachClassicLinkVpc( args: DetachClassicLinkVpcCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachClassicLinkVpcCommandOutput) => void ): void; - public detachClassicLinkVpc( - args: DetachClassicLinkVpcCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachClassicLinkVpcCommandOutput) => void), - cb?: (err: any, data?: DetachClassicLinkVpcCommandOutput) => void - ): Promise | void { - const command = new DetachClassicLinkVpcCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detaches an internet gateway from a VPC, disabling connectivity between the internet - * and the VPC. The VPC must not contain any running instances with Elastic IP addresses or - * public IPv4 addresses.

- */ - public detachInternetGateway( + + /** + * @see {@link DetachInternetGatewayCommand} + */ + detachInternetGateway( args: DetachInternetGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachInternetGateway( + detachInternetGateway( args: DetachInternetGatewayCommandInput, cb: (err: any, data?: DetachInternetGatewayCommandOutput) => void ): void; - public detachInternetGateway( + detachInternetGateway( args: DetachInternetGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachInternetGatewayCommandOutput) => void ): void; - public detachInternetGateway( - args: DetachInternetGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachInternetGatewayCommandOutput) => void), - cb?: (err: any, data?: DetachInternetGatewayCommandOutput) => void - ): Promise | void { - const command = new DetachInternetGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detaches a network interface from an instance.

- */ - public detachNetworkInterface( + + /** + * @see {@link DetachNetworkInterfaceCommand} + */ + detachNetworkInterface( args: DetachNetworkInterfaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachNetworkInterface( + detachNetworkInterface( args: DetachNetworkInterfaceCommandInput, cb: (err: any, data?: DetachNetworkInterfaceCommandOutput) => void ): void; - public detachNetworkInterface( + detachNetworkInterface( args: DetachNetworkInterfaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachNetworkInterfaceCommandOutput) => void ): void; - public detachNetworkInterface( - args: DetachNetworkInterfaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachNetworkInterfaceCommandOutput) => void), - cb?: (err: any, data?: DetachNetworkInterfaceCommandOutput) => void - ): Promise | void { - const command = new DetachNetworkInterfaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detach a trust provider from an Amazon Web Services Verified Access instance.

- */ - public detachVerifiedAccessTrustProvider( + + /** + * @see {@link DetachVerifiedAccessTrustProviderCommand} + */ + detachVerifiedAccessTrustProvider( args: DetachVerifiedAccessTrustProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachVerifiedAccessTrustProvider( + detachVerifiedAccessTrustProvider( args: DetachVerifiedAccessTrustProviderCommandInput, cb: (err: any, data?: DetachVerifiedAccessTrustProviderCommandOutput) => void ): void; - public detachVerifiedAccessTrustProvider( + detachVerifiedAccessTrustProvider( args: DetachVerifiedAccessTrustProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachVerifiedAccessTrustProviderCommandOutput) => void ): void; - public detachVerifiedAccessTrustProvider( - args: DetachVerifiedAccessTrustProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachVerifiedAccessTrustProviderCommandOutput) => void), - cb?: (err: any, data?: DetachVerifiedAccessTrustProviderCommandOutput) => void - ): Promise | void { - const command = new DetachVerifiedAccessTrustProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detaches an EBS volume from an instance. Make sure to unmount any file systems on the - * device within your operating system before detaching the volume. Failure to do so can result - * in the volume becoming stuck in the busy state while detaching. If this happens, - * detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot - * the instance, or all three. If an EBS volume is the root device of an instance, it can't be - * detached while the instance is running. To detach the root volume, stop the instance - * first.

- *

When a volume with an Amazon Web Services Marketplace product code is detached from an instance, the - * product code is no longer associated with the instance.

- *

For more information, see Detach an Amazon EBS volume in the - * Amazon Elastic Compute Cloud User Guide.

- */ - public detachVolume( - args: DetachVolumeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public detachVolume(args: DetachVolumeCommandInput, cb: (err: any, data?: DetachVolumeCommandOutput) => void): void; - public detachVolume( + + /** + * @see {@link DetachVolumeCommand} + */ + detachVolume(args: DetachVolumeCommandInput, options?: __HttpHandlerOptions): Promise; + detachVolume(args: DetachVolumeCommandInput, cb: (err: any, data?: DetachVolumeCommandOutput) => void): void; + detachVolume( args: DetachVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachVolumeCommandOutput) => void ): void; - public detachVolume( - args: DetachVolumeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachVolumeCommandOutput) => void), - cb?: (err: any, data?: DetachVolumeCommandOutput) => void - ): Promise | void { - const command = new DetachVolumeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn - * off the VPC and not use it anymore. You can confirm a virtual private gateway has been - * completely detached from a VPC by describing the virtual private gateway (any - * attachments to the virtual private gateway are also described).

- *

You must wait for the attachment's state to switch to detached before you - * can delete the VPC or attach a different VPC to the virtual private gateway.

- */ - public detachVpnGateway( + + /** + * @see {@link DetachVpnGatewayCommand} + */ + detachVpnGateway( args: DetachVpnGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachVpnGateway( + detachVpnGateway( args: DetachVpnGatewayCommandInput, cb: (err: any, data?: DetachVpnGatewayCommandOutput) => void ): void; - public detachVpnGateway( + detachVpnGateway( args: DetachVpnGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachVpnGatewayCommandOutput) => void ): void; - public detachVpnGateway( - args: DetachVpnGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachVpnGatewayCommandOutput) => void), - cb?: (err: any, data?: DetachVpnGatewayCommandOutput) => void - ): Promise | void { - const command = new DetachVpnGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.

- */ - public disableAddressTransfer( + + /** + * @see {@link DisableAddressTransferCommand} + */ + disableAddressTransfer( args: DisableAddressTransferCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableAddressTransfer( + disableAddressTransfer( args: DisableAddressTransferCommandInput, cb: (err: any, data?: DisableAddressTransferCommandOutput) => void ): void; - public disableAddressTransfer( + disableAddressTransfer( args: DisableAddressTransferCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableAddressTransferCommandOutput) => void ): void; - public disableAddressTransfer( - args: DisableAddressTransferCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableAddressTransferCommandOutput) => void), - cb?: (err: any, data?: DisableAddressTransferCommandOutput) => void - ): Promise | void { - const command = new DisableAddressTransferCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables Infrastructure Performance metric subscriptions.

- */ - public disableAwsNetworkPerformanceMetricSubscription( + + /** + * @see {@link DisableAwsNetworkPerformanceMetricSubscriptionCommand} + */ + disableAwsNetworkPerformanceMetricSubscription( args: DisableAwsNetworkPerformanceMetricSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableAwsNetworkPerformanceMetricSubscription( + disableAwsNetworkPerformanceMetricSubscription( args: DisableAwsNetworkPerformanceMetricSubscriptionCommandInput, cb: (err: any, data?: DisableAwsNetworkPerformanceMetricSubscriptionCommandOutput) => void ): void; - public disableAwsNetworkPerformanceMetricSubscription( + disableAwsNetworkPerformanceMetricSubscription( args: DisableAwsNetworkPerformanceMetricSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableAwsNetworkPerformanceMetricSubscriptionCommandOutput) => void ): void; - public disableAwsNetworkPerformanceMetricSubscription( - args: DisableAwsNetworkPerformanceMetricSubscriptionCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisableAwsNetworkPerformanceMetricSubscriptionCommandOutput) => void), - cb?: (err: any, data?: DisableAwsNetworkPerformanceMetricSubscriptionCommandOutput) => void - ): Promise | void { - const command = new DisableAwsNetworkPerformanceMetricSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables EBS encryption by default for your account in the current Region.

- *

After you disable encryption by default, you can still create encrypted volumes by - * enabling encryption when you create each volume.

- *

Disabling encryption by default does not change the encryption status of your - * existing volumes.

- *

For more information, see Amazon EBS encryption in the - * Amazon Elastic Compute Cloud User Guide.

- */ - public disableEbsEncryptionByDefault( + + /** + * @see {@link DisableEbsEncryptionByDefaultCommand} + */ + disableEbsEncryptionByDefault( args: DisableEbsEncryptionByDefaultCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableEbsEncryptionByDefault( + disableEbsEncryptionByDefault( args: DisableEbsEncryptionByDefaultCommandInput, cb: (err: any, data?: DisableEbsEncryptionByDefaultCommandOutput) => void ): void; - public disableEbsEncryptionByDefault( + disableEbsEncryptionByDefault( args: DisableEbsEncryptionByDefaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableEbsEncryptionByDefaultCommandOutput) => void ): void; - public disableEbsEncryptionByDefault( - args: DisableEbsEncryptionByDefaultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableEbsEncryptionByDefaultCommandOutput) => void), - cb?: (err: any, data?: DisableEbsEncryptionByDefaultCommandOutput) => void - ): Promise | void { - const command = new DisableEbsEncryptionByDefaultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Discontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. - * When you disable faster launching, the AMI uses the standard launch process for each - * instance. All pre-provisioned snapshots must be removed before you can enable faster launching again.

- * - *

To change these settings, you must own the AMI.

- *
- */ - public disableFastLaunch( + + /** + * @see {@link DisableFastLaunchCommand} + */ + disableFastLaunch( args: DisableFastLaunchCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableFastLaunch( + disableFastLaunch( args: DisableFastLaunchCommandInput, cb: (err: any, data?: DisableFastLaunchCommandOutput) => void ): void; - public disableFastLaunch( + disableFastLaunch( args: DisableFastLaunchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableFastLaunchCommandOutput) => void ): void; - public disableFastLaunch( - args: DisableFastLaunchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableFastLaunchCommandOutput) => void), - cb?: (err: any, data?: DisableFastLaunchCommandOutput) => void - ): Promise | void { - const command = new DisableFastLaunchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables fast snapshot restores for the specified snapshots in the specified Availability Zones.

- */ - public disableFastSnapshotRestores( + + /** + * @see {@link DisableFastSnapshotRestoresCommand} + */ + disableFastSnapshotRestores( args: DisableFastSnapshotRestoresCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableFastSnapshotRestores( + disableFastSnapshotRestores( args: DisableFastSnapshotRestoresCommandInput, cb: (err: any, data?: DisableFastSnapshotRestoresCommandOutput) => void ): void; - public disableFastSnapshotRestores( + disableFastSnapshotRestores( args: DisableFastSnapshotRestoresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableFastSnapshotRestoresCommandOutput) => void ): void; - public disableFastSnapshotRestores( - args: DisableFastSnapshotRestoresCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableFastSnapshotRestoresCommandOutput) => void), - cb?: (err: any, data?: DisableFastSnapshotRestoresCommandOutput) => void - ): Promise | void { - const command = new DisableFastSnapshotRestoresCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels the deprecation of the specified AMI.

- *

For more information, see Deprecate an AMI in the - * Amazon EC2 User Guide.

- */ - public disableImageDeprecation( + + /** + * @see {@link DisableImageDeprecationCommand} + */ + disableImageDeprecation( args: DisableImageDeprecationCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableImageDeprecation( + disableImageDeprecation( args: DisableImageDeprecationCommandInput, cb: (err: any, data?: DisableImageDeprecationCommandOutput) => void ): void; - public disableImageDeprecation( + disableImageDeprecation( args: DisableImageDeprecationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableImageDeprecationCommandOutput) => void ): void; - public disableImageDeprecation( - args: DisableImageDeprecationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableImageDeprecationCommandOutput) => void), - cb?: (err: any, data?: DisableImageDeprecationCommandOutput) => void - ): Promise | void { - const command = new DisableImageDeprecationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disable the IPAM account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide. - *

- */ - public disableIpamOrganizationAdminAccount( + + /** + * @see {@link DisableIpamOrganizationAdminAccountCommand} + */ + disableIpamOrganizationAdminAccount( args: DisableIpamOrganizationAdminAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableIpamOrganizationAdminAccount( + disableIpamOrganizationAdminAccount( args: DisableIpamOrganizationAdminAccountCommandInput, cb: (err: any, data?: DisableIpamOrganizationAdminAccountCommandOutput) => void ): void; - public disableIpamOrganizationAdminAccount( + disableIpamOrganizationAdminAccount( args: DisableIpamOrganizationAdminAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableIpamOrganizationAdminAccountCommandOutput) => void ): void; - public disableIpamOrganizationAdminAccount( - args: DisableIpamOrganizationAdminAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableIpamOrganizationAdminAccountCommandOutput) => void), - cb?: (err: any, data?: DisableIpamOrganizationAdminAccountCommandOutput) => void - ): Promise | void { - const command = new DisableIpamOrganizationAdminAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables access to the EC2 serial console of all instances for your account. By default, - * access to the EC2 serial console is disabled for your account. For more information, see - * Manage account access to the EC2 serial console in the Amazon EC2 - * User Guide.

- */ - public disableSerialConsoleAccess( + + /** + * @see {@link DisableSerialConsoleAccessCommand} + */ + disableSerialConsoleAccess( args: DisableSerialConsoleAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableSerialConsoleAccess( + disableSerialConsoleAccess( args: DisableSerialConsoleAccessCommandInput, cb: (err: any, data?: DisableSerialConsoleAccessCommandOutput) => void ): void; - public disableSerialConsoleAccess( + disableSerialConsoleAccess( args: DisableSerialConsoleAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableSerialConsoleAccessCommandOutput) => void ): void; - public disableSerialConsoleAccess( - args: DisableSerialConsoleAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableSerialConsoleAccessCommandOutput) => void), - cb?: (err: any, data?: DisableSerialConsoleAccessCommandOutput) => void - ): Promise | void { - const command = new DisableSerialConsoleAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables the specified resource attachment from propagating routes to the specified - * propagation route table.

- */ - public disableTransitGatewayRouteTablePropagation( + + /** + * @see {@link DisableTransitGatewayRouteTablePropagationCommand} + */ + disableTransitGatewayRouteTablePropagation( args: DisableTransitGatewayRouteTablePropagationCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableTransitGatewayRouteTablePropagation( + disableTransitGatewayRouteTablePropagation( args: DisableTransitGatewayRouteTablePropagationCommandInput, cb: (err: any, data?: DisableTransitGatewayRouteTablePropagationCommandOutput) => void ): void; - public disableTransitGatewayRouteTablePropagation( + disableTransitGatewayRouteTablePropagation( args: DisableTransitGatewayRouteTablePropagationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableTransitGatewayRouteTablePropagationCommandOutput) => void ): void; - public disableTransitGatewayRouteTablePropagation( - args: DisableTransitGatewayRouteTablePropagationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisableTransitGatewayRouteTablePropagationCommandOutput) => void), - cb?: (err: any, data?: DisableTransitGatewayRouteTablePropagationCommandOutput) => void - ): Promise | void { - const command = new DisableTransitGatewayRouteTablePropagationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables a virtual private gateway (VGW) from propagating routes to a specified route - * table of a VPC.

- */ - public disableVgwRoutePropagation( + + /** + * @see {@link DisableVgwRoutePropagationCommand} + */ + disableVgwRoutePropagation( args: DisableVgwRoutePropagationCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableVgwRoutePropagation( + disableVgwRoutePropagation( args: DisableVgwRoutePropagationCommandInput, cb: (err: any, data?: DisableVgwRoutePropagationCommandOutput) => void ): void; - public disableVgwRoutePropagation( + disableVgwRoutePropagation( args: DisableVgwRoutePropagationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableVgwRoutePropagationCommandOutput) => void ): void; - public disableVgwRoutePropagation( - args: DisableVgwRoutePropagationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableVgwRoutePropagationCommandOutput) => void), - cb?: (err: any, data?: DisableVgwRoutePropagationCommandOutput) => void - ): Promise | void { - const command = new DisableVgwRoutePropagationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.

- * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- */ - public disableVpcClassicLink( + + /** + * @see {@link DisableVpcClassicLinkCommand} + */ + disableVpcClassicLink( args: DisableVpcClassicLinkCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableVpcClassicLink( + disableVpcClassicLink( args: DisableVpcClassicLinkCommandInput, cb: (err: any, data?: DisableVpcClassicLinkCommandOutput) => void ): void; - public disableVpcClassicLink( + disableVpcClassicLink( args: DisableVpcClassicLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableVpcClassicLinkCommandOutput) => void ): void; - public disableVpcClassicLink( - args: DisableVpcClassicLinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableVpcClassicLinkCommandOutput) => void), - cb?: (err: any, data?: DisableVpcClassicLinkCommandOutput) => void - ): Promise | void { - const command = new DisableVpcClassicLinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to - * public IP addresses when addressed between a linked EC2-Classic instance and instances - * in the VPC to which it's linked. For more information, see ClassicLink in the - * Amazon Elastic Compute Cloud User Guide.

- *

You must specify a VPC ID in the request.

- * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- */ - public disableVpcClassicLinkDnsSupport( + + /** + * @see {@link DisableVpcClassicLinkDnsSupportCommand} + */ + disableVpcClassicLinkDnsSupport( args: DisableVpcClassicLinkDnsSupportCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableVpcClassicLinkDnsSupport( + disableVpcClassicLinkDnsSupport( args: DisableVpcClassicLinkDnsSupportCommandInput, cb: (err: any, data?: DisableVpcClassicLinkDnsSupportCommandOutput) => void ): void; - public disableVpcClassicLinkDnsSupport( + disableVpcClassicLinkDnsSupport( args: DisableVpcClassicLinkDnsSupportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableVpcClassicLinkDnsSupportCommandOutput) => void ): void; - public disableVpcClassicLinkDnsSupport( - args: DisableVpcClassicLinkDnsSupportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableVpcClassicLinkDnsSupportCommandOutput) => void), - cb?: (err: any, data?: DisableVpcClassicLinkDnsSupportCommandOutput) => void - ): Promise | void { - const command = new DisableVpcClassicLinkDnsSupportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates an Elastic IP address from the instance or network interface it's associated with.

- *

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more - * information, see Elastic IP - * Addresses in the Amazon Elastic Compute Cloud User Guide.

- * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- *

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

- */ - public disassociateAddress( + + /** + * @see {@link DisassociateAddressCommand} + */ + disassociateAddress( args: DisassociateAddressCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateAddress( + disassociateAddress( args: DisassociateAddressCommandInput, cb: (err: any, data?: DisassociateAddressCommandOutput) => void ): void; - public disassociateAddress( + disassociateAddress( args: DisassociateAddressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateAddressCommandOutput) => void ): void; - public disassociateAddress( - args: DisassociateAddressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateAddressCommandOutput) => void), - cb?: (err: any, data?: DisassociateAddressCommandOutput) => void - ): Promise | void { - const command = new DisassociateAddressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a target network from the specified Client VPN endpoint. When you disassociate the - * last target network from a Client VPN, the following happens:

- *
    - *
  • - *

    The route that was automatically added for the VPC is deleted

    - *
  • - *
  • - *

    All active client connections are terminated

    - *
  • - *
  • - *

    New client connections are disallowed

    - *
  • - *
  • - *

    The Client VPN endpoint's status changes to pending-associate - *

    - *
  • - *
- */ - public disassociateClientVpnTargetNetwork( + + /** + * @see {@link DisassociateClientVpnTargetNetworkCommand} + */ + disassociateClientVpnTargetNetwork( args: DisassociateClientVpnTargetNetworkCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateClientVpnTargetNetwork( + disassociateClientVpnTargetNetwork( args: DisassociateClientVpnTargetNetworkCommandInput, cb: (err: any, data?: DisassociateClientVpnTargetNetworkCommandOutput) => void ): void; - public disassociateClientVpnTargetNetwork( + disassociateClientVpnTargetNetwork( args: DisassociateClientVpnTargetNetworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateClientVpnTargetNetworkCommandOutput) => void ): void; - public disassociateClientVpnTargetNetwork( - args: DisassociateClientVpnTargetNetworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateClientVpnTargetNetworkCommandOutput) => void), - cb?: (err: any, data?: DisassociateClientVpnTargetNetworkCommandOutput) => void - ): Promise | void { - const command = new DisassociateClientVpnTargetNetworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates an IAM role from an Certificate Manager (ACM) certificate. Disassociating an IAM role - * from an ACM certificate removes the Amazon S3 object that contains the certificate, certificate chain, and - * encrypted private key from the Amazon S3 bucket. It also revokes the IAM role's permission to use the - * KMS key used to encrypt the private key. This effectively revokes the role's permission - * to use the certificate.

- */ - public disassociateEnclaveCertificateIamRole( + + /** + * @see {@link DisassociateEnclaveCertificateIamRoleCommand} + */ + disassociateEnclaveCertificateIamRole( args: DisassociateEnclaveCertificateIamRoleCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateEnclaveCertificateIamRole( + disassociateEnclaveCertificateIamRole( args: DisassociateEnclaveCertificateIamRoleCommandInput, cb: (err: any, data?: DisassociateEnclaveCertificateIamRoleCommandOutput) => void ): void; - public disassociateEnclaveCertificateIamRole( + disassociateEnclaveCertificateIamRole( args: DisassociateEnclaveCertificateIamRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateEnclaveCertificateIamRoleCommandOutput) => void ): void; - public disassociateEnclaveCertificateIamRole( - args: DisassociateEnclaveCertificateIamRoleCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociateEnclaveCertificateIamRoleCommandOutput) => void), - cb?: (err: any, data?: DisassociateEnclaveCertificateIamRoleCommandOutput) => void - ): Promise | void { - const command = new DisassociateEnclaveCertificateIamRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates an IAM instance profile from a running or stopped instance.

- *

Use DescribeIamInstanceProfileAssociations to get the association - * ID.

- */ - public disassociateIamInstanceProfile( + + /** + * @see {@link DisassociateIamInstanceProfileCommand} + */ + disassociateIamInstanceProfile( args: DisassociateIamInstanceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateIamInstanceProfile( + disassociateIamInstanceProfile( args: DisassociateIamInstanceProfileCommandInput, cb: (err: any, data?: DisassociateIamInstanceProfileCommandOutput) => void ): void; - public disassociateIamInstanceProfile( + disassociateIamInstanceProfile( args: DisassociateIamInstanceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateIamInstanceProfileCommandOutput) => void ): void; - public disassociateIamInstanceProfile( - args: DisassociateIamInstanceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateIamInstanceProfileCommandOutput) => void), - cb?: (err: any, data?: DisassociateIamInstanceProfileCommandOutput) => void - ): Promise | void { - const command = new DisassociateIamInstanceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates one or more targets from an event window.

- *

For more information, see Define event windows for scheduled - * events in the Amazon EC2 User Guide.

- */ - public disassociateInstanceEventWindow( + + /** + * @see {@link DisassociateInstanceEventWindowCommand} + */ + disassociateInstanceEventWindow( args: DisassociateInstanceEventWindowCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateInstanceEventWindow( + disassociateInstanceEventWindow( args: DisassociateInstanceEventWindowCommandInput, cb: (err: any, data?: DisassociateInstanceEventWindowCommandOutput) => void ): void; - public disassociateInstanceEventWindow( + disassociateInstanceEventWindow( args: DisassociateInstanceEventWindowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateInstanceEventWindowCommandOutput) => void ): void; - public disassociateInstanceEventWindow( - args: DisassociateInstanceEventWindowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateInstanceEventWindowCommandOutput) => void), - cb?: (err: any, data?: DisassociateInstanceEventWindowCommandOutput) => void - ): Promise | void { - const command = new DisassociateInstanceEventWindowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a resource discovery from an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

- */ - public disassociateIpamResourceDiscovery( + + /** + * @see {@link DisassociateIpamResourceDiscoveryCommand} + */ + disassociateIpamResourceDiscovery( args: DisassociateIpamResourceDiscoveryCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateIpamResourceDiscovery( + disassociateIpamResourceDiscovery( args: DisassociateIpamResourceDiscoveryCommandInput, cb: (err: any, data?: DisassociateIpamResourceDiscoveryCommandOutput) => void ): void; - public disassociateIpamResourceDiscovery( + disassociateIpamResourceDiscovery( args: DisassociateIpamResourceDiscoveryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateIpamResourceDiscoveryCommandOutput) => void ): void; - public disassociateIpamResourceDiscovery( - args: DisassociateIpamResourceDiscoveryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateIpamResourceDiscoveryCommandOutput) => void), - cb?: (err: any, data?: DisassociateIpamResourceDiscoveryCommandOutput) => void - ): Promise | void { - const command = new DisassociateIpamResourceDiscoveryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates secondary Elastic IP addresses (EIPs) from a public NAT gateway. You cannot disassociate your primary EIP. For more information, see Edit secondary IP address associations in the Amazon Virtual Private Cloud User Guide.

- *

While disassociating is in progress, you cannot associate/disassociate additional EIPs while the connections are being drained. You are, however, allowed to delete the NAT gateway.

- *

An EIP will only be released at the end of MaxDrainDurationSeconds. The EIPs stay - * associated and support the existing connections but do not support any new connections - * (new connections are distributed across the remaining associated EIPs). As the existing - * connections drain out, the EIPs (and the corresponding private IPs mapped to them) get - * released.

- */ - public disassociateNatGatewayAddress( + + /** + * @see {@link DisassociateNatGatewayAddressCommand} + */ + disassociateNatGatewayAddress( args: DisassociateNatGatewayAddressCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateNatGatewayAddress( + disassociateNatGatewayAddress( args: DisassociateNatGatewayAddressCommandInput, cb: (err: any, data?: DisassociateNatGatewayAddressCommandOutput) => void ): void; - public disassociateNatGatewayAddress( + disassociateNatGatewayAddress( args: DisassociateNatGatewayAddressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateNatGatewayAddressCommandOutput) => void ): void; - public disassociateNatGatewayAddress( - args: DisassociateNatGatewayAddressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateNatGatewayAddressCommandOutput) => void), - cb?: (err: any, data?: DisassociateNatGatewayAddressCommandOutput) => void - ): Promise | void { - const command = new DisassociateNatGatewayAddressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a subnet or gateway from a route table.

- *

After you perform this action, the subnet no longer uses the routes in the route table. - * Instead, it uses the routes in the VPC's main route table. For more information - * about route tables, see Route - * tables in the Amazon Virtual Private Cloud User Guide.

- */ - public disassociateRouteTable( + + /** + * @see {@link DisassociateRouteTableCommand} + */ + disassociateRouteTable( args: DisassociateRouteTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateRouteTable( + disassociateRouteTable( args: DisassociateRouteTableCommandInput, cb: (err: any, data?: DisassociateRouteTableCommandOutput) => void ): void; - public disassociateRouteTable( + disassociateRouteTable( args: DisassociateRouteTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateRouteTableCommandOutput) => void ): void; - public disassociateRouteTable( - args: DisassociateRouteTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateRouteTableCommandOutput) => void), - cb?: (err: any, data?: DisassociateRouteTableCommandOutput) => void - ): Promise | void { - const command = new DisassociateRouteTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.

- */ - public disassociateSubnetCidrBlock( + + /** + * @see {@link DisassociateSubnetCidrBlockCommand} + */ + disassociateSubnetCidrBlock( args: DisassociateSubnetCidrBlockCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateSubnetCidrBlock( + disassociateSubnetCidrBlock( args: DisassociateSubnetCidrBlockCommandInput, cb: (err: any, data?: DisassociateSubnetCidrBlockCommandOutput) => void ): void; - public disassociateSubnetCidrBlock( + disassociateSubnetCidrBlock( args: DisassociateSubnetCidrBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateSubnetCidrBlockCommandOutput) => void ): void; - public disassociateSubnetCidrBlock( - args: DisassociateSubnetCidrBlockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateSubnetCidrBlockCommandOutput) => void), - cb?: (err: any, data?: DisassociateSubnetCidrBlockCommandOutput) => void - ): Promise | void { - const command = new DisassociateSubnetCidrBlockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates the specified subnets from the transit gateway multicast domain.

- */ - public disassociateTransitGatewayMulticastDomain( + + /** + * @see {@link DisassociateTransitGatewayMulticastDomainCommand} + */ + disassociateTransitGatewayMulticastDomain( args: DisassociateTransitGatewayMulticastDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateTransitGatewayMulticastDomain( + disassociateTransitGatewayMulticastDomain( args: DisassociateTransitGatewayMulticastDomainCommandInput, cb: (err: any, data?: DisassociateTransitGatewayMulticastDomainCommandOutput) => void ): void; - public disassociateTransitGatewayMulticastDomain( + disassociateTransitGatewayMulticastDomain( args: DisassociateTransitGatewayMulticastDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateTransitGatewayMulticastDomainCommandOutput) => void ): void; - public disassociateTransitGatewayMulticastDomain( - args: DisassociateTransitGatewayMulticastDomainCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociateTransitGatewayMulticastDomainCommandOutput) => void), - cb?: (err: any, data?: DisassociateTransitGatewayMulticastDomainCommandOutput) => void - ): Promise | void { - const command = new DisassociateTransitGatewayMulticastDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the association between an an attachment and a policy table.

- */ - public disassociateTransitGatewayPolicyTable( + + /** + * @see {@link DisassociateTransitGatewayPolicyTableCommand} + */ + disassociateTransitGatewayPolicyTable( args: DisassociateTransitGatewayPolicyTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateTransitGatewayPolicyTable( + disassociateTransitGatewayPolicyTable( args: DisassociateTransitGatewayPolicyTableCommandInput, cb: (err: any, data?: DisassociateTransitGatewayPolicyTableCommandOutput) => void ): void; - public disassociateTransitGatewayPolicyTable( + disassociateTransitGatewayPolicyTable( args: DisassociateTransitGatewayPolicyTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateTransitGatewayPolicyTableCommandOutput) => void ): void; - public disassociateTransitGatewayPolicyTable( - args: DisassociateTransitGatewayPolicyTableCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociateTransitGatewayPolicyTableCommandOutput) => void), - cb?: (err: any, data?: DisassociateTransitGatewayPolicyTableCommandOutput) => void - ): Promise | void { - const command = new DisassociateTransitGatewayPolicyTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a resource attachment from a transit gateway route table.

- */ - public disassociateTransitGatewayRouteTable( + + /** + * @see {@link DisassociateTransitGatewayRouteTableCommand} + */ + disassociateTransitGatewayRouteTable( args: DisassociateTransitGatewayRouteTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateTransitGatewayRouteTable( + disassociateTransitGatewayRouteTable( args: DisassociateTransitGatewayRouteTableCommandInput, cb: (err: any, data?: DisassociateTransitGatewayRouteTableCommandOutput) => void ): void; - public disassociateTransitGatewayRouteTable( + disassociateTransitGatewayRouteTable( args: DisassociateTransitGatewayRouteTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateTransitGatewayRouteTableCommandOutput) => void ): void; - public disassociateTransitGatewayRouteTable( - args: DisassociateTransitGatewayRouteTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateTransitGatewayRouteTableCommandOutput) => void), - cb?: (err: any, data?: DisassociateTransitGatewayRouteTableCommandOutput) => void - ): Promise | void { - const command = new DisassociateTransitGatewayRouteTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This API action is currently in limited preview only. - * If you are interested in using this feature, contact your account manager.

- *
- *

Removes an association between a branch network interface with a trunk network interface.

- */ - public disassociateTrunkInterface( + + /** + * @see {@link DisassociateTrunkInterfaceCommand} + */ + disassociateTrunkInterface( args: DisassociateTrunkInterfaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateTrunkInterface( + disassociateTrunkInterface( args: DisassociateTrunkInterfaceCommandInput, cb: (err: any, data?: DisassociateTrunkInterfaceCommandOutput) => void ): void; - public disassociateTrunkInterface( + disassociateTrunkInterface( args: DisassociateTrunkInterfaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateTrunkInterfaceCommandOutput) => void ): void; - public disassociateTrunkInterface( - args: DisassociateTrunkInterfaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateTrunkInterfaceCommandOutput) => void), - cb?: (err: any, data?: DisassociateTrunkInterfaceCommandOutput) => void - ): Promise | void { - const command = new DisassociateTrunkInterfaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must - * specify its association ID. You can get the association ID by using - * DescribeVpcs. You must detach or delete all gateways and resources that - * are associated with the CIDR block before you can disassociate it.

- *

You cannot disassociate the CIDR block with which you originally created the VPC (the - * primary CIDR block).

- */ - public disassociateVpcCidrBlock( + + /** + * @see {@link DisassociateVpcCidrBlockCommand} + */ + disassociateVpcCidrBlock( args: DisassociateVpcCidrBlockCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateVpcCidrBlock( + disassociateVpcCidrBlock( args: DisassociateVpcCidrBlockCommandInput, cb: (err: any, data?: DisassociateVpcCidrBlockCommandOutput) => void ): void; - public disassociateVpcCidrBlock( + disassociateVpcCidrBlock( args: DisassociateVpcCidrBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateVpcCidrBlockCommandOutput) => void ): void; - public disassociateVpcCidrBlock( - args: DisassociateVpcCidrBlockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateVpcCidrBlockCommandOutput) => void), - cb?: (err: any, data?: DisassociateVpcCidrBlockCommandOutput) => void - ): Promise | void { - const command = new DisassociateVpcCidrBlockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.

- */ - public enableAddressTransfer( + + /** + * @see {@link EnableAddressTransferCommand} + */ + enableAddressTransfer( args: EnableAddressTransferCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableAddressTransfer( + enableAddressTransfer( args: EnableAddressTransferCommandInput, cb: (err: any, data?: EnableAddressTransferCommandOutput) => void ): void; - public enableAddressTransfer( + enableAddressTransfer( args: EnableAddressTransferCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableAddressTransferCommandOutput) => void ): void; - public enableAddressTransfer( - args: EnableAddressTransferCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableAddressTransferCommandOutput) => void), - cb?: (err: any, data?: EnableAddressTransferCommandOutput) => void - ): Promise | void { - const command = new EnableAddressTransferCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables Infrastructure Performance subscriptions.

- */ - public enableAwsNetworkPerformanceMetricSubscription( + + /** + * @see {@link EnableAwsNetworkPerformanceMetricSubscriptionCommand} + */ + enableAwsNetworkPerformanceMetricSubscription( args: EnableAwsNetworkPerformanceMetricSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableAwsNetworkPerformanceMetricSubscription( + enableAwsNetworkPerformanceMetricSubscription( args: EnableAwsNetworkPerformanceMetricSubscriptionCommandInput, cb: (err: any, data?: EnableAwsNetworkPerformanceMetricSubscriptionCommandOutput) => void ): void; - public enableAwsNetworkPerformanceMetricSubscription( + enableAwsNetworkPerformanceMetricSubscription( args: EnableAwsNetworkPerformanceMetricSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableAwsNetworkPerformanceMetricSubscriptionCommandOutput) => void ): void; - public enableAwsNetworkPerformanceMetricSubscription( - args: EnableAwsNetworkPerformanceMetricSubscriptionCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: EnableAwsNetworkPerformanceMetricSubscriptionCommandOutput) => void), - cb?: (err: any, data?: EnableAwsNetworkPerformanceMetricSubscriptionCommandOutput) => void - ): Promise | void { - const command = new EnableAwsNetworkPerformanceMetricSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables EBS encryption by default for your account in the current Region.

- *

After you enable encryption by default, the EBS volumes that you create are - * always encrypted, either using the default KMS key or the KMS key that you specified - * when you created each volume. For more information, see Amazon EBS encryption in the - * Amazon Elastic Compute Cloud User Guide.

- *

You can specify the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId - * or ResetEbsDefaultKmsKeyId.

- *

Enabling encryption by default has no effect on the encryption status of your - * existing volumes.

- *

After you enable encryption by default, you can no longer launch instances - * using instance types that do not support encryption. For more information, see Supported - * instance types.

- */ - public enableEbsEncryptionByDefault( + + /** + * @see {@link EnableEbsEncryptionByDefaultCommand} + */ + enableEbsEncryptionByDefault( args: EnableEbsEncryptionByDefaultCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableEbsEncryptionByDefault( + enableEbsEncryptionByDefault( args: EnableEbsEncryptionByDefaultCommandInput, cb: (err: any, data?: EnableEbsEncryptionByDefaultCommandOutput) => void ): void; - public enableEbsEncryptionByDefault( + enableEbsEncryptionByDefault( args: EnableEbsEncryptionByDefaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableEbsEncryptionByDefaultCommandOutput) => void ): void; - public enableEbsEncryptionByDefault( - args: EnableEbsEncryptionByDefaultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableEbsEncryptionByDefaultCommandOutput) => void), - cb?: (err: any, data?: EnableEbsEncryptionByDefaultCommandOutput) => void - ): Promise | void { - const command = new EnableEbsEncryptionByDefaultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

When you enable faster launching for a Windows AMI, images are pre-provisioned, - * using snapshots to launch instances up to 65% faster. To create the optimized Windows - * image, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. - * Then it creates a set of reserved snapshots that are used for subsequent launches. The - * reserved snapshots are automatically replenished as they are used, depending on your - * settings for launch frequency.

- * - *

To change these settings, you must own the AMI.

- *
- */ - public enableFastLaunch( + + /** + * @see {@link EnableFastLaunchCommand} + */ + enableFastLaunch( args: EnableFastLaunchCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableFastLaunch( + enableFastLaunch( args: EnableFastLaunchCommandInput, cb: (err: any, data?: EnableFastLaunchCommandOutput) => void ): void; - public enableFastLaunch( + enableFastLaunch( args: EnableFastLaunchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableFastLaunchCommandOutput) => void ): void; - public enableFastLaunch( - args: EnableFastLaunchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableFastLaunchCommandOutput) => void), - cb?: (err: any, data?: EnableFastLaunchCommandOutput) => void - ): Promise | void { - const command = new EnableFastLaunchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.

- *

You get the full benefit of fast snapshot restores after they enter the enabled state. - * To get the current state of fast snapshot restores, use DescribeFastSnapshotRestores. - * To disable fast snapshot restores, use DisableFastSnapshotRestores.

- *

For more information, see Amazon EBS fast snapshot - * restore in the Amazon Elastic Compute Cloud User Guide.

- */ - public enableFastSnapshotRestores( + + /** + * @see {@link EnableFastSnapshotRestoresCommand} + */ + enableFastSnapshotRestores( args: EnableFastSnapshotRestoresCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableFastSnapshotRestores( + enableFastSnapshotRestores( args: EnableFastSnapshotRestoresCommandInput, cb: (err: any, data?: EnableFastSnapshotRestoresCommandOutput) => void ): void; - public enableFastSnapshotRestores( + enableFastSnapshotRestores( args: EnableFastSnapshotRestoresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableFastSnapshotRestoresCommandOutput) => void ): void; - public enableFastSnapshotRestores( - args: EnableFastSnapshotRestoresCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableFastSnapshotRestoresCommandOutput) => void), - cb?: (err: any, data?: EnableFastSnapshotRestoresCommandOutput) => void - ): Promise | void { - const command = new EnableFastSnapshotRestoresCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables deprecation of the specified AMI at the specified date and time.

- *

For more information, see Deprecate an AMI in the Amazon EC2 User Guide.

- */ - public enableImageDeprecation( + + /** + * @see {@link EnableImageDeprecationCommand} + */ + enableImageDeprecation( args: EnableImageDeprecationCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableImageDeprecation( + enableImageDeprecation( args: EnableImageDeprecationCommandInput, cb: (err: any, data?: EnableImageDeprecationCommandOutput) => void ): void; - public enableImageDeprecation( + enableImageDeprecation( args: EnableImageDeprecationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableImageDeprecationCommandOutput) => void ): void; - public enableImageDeprecation( - args: EnableImageDeprecationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableImageDeprecationCommandOutput) => void), - cb?: (err: any, data?: EnableImageDeprecationCommandOutput) => void - ): Promise | void { - const command = new EnableImageDeprecationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enable an Organizations member account as the IPAM admin account. You cannot select the Organizations management account as the IPAM admin account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide. - *

- */ - public enableIpamOrganizationAdminAccount( + + /** + * @see {@link EnableIpamOrganizationAdminAccountCommand} + */ + enableIpamOrganizationAdminAccount( args: EnableIpamOrganizationAdminAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableIpamOrganizationAdminAccount( + enableIpamOrganizationAdminAccount( args: EnableIpamOrganizationAdminAccountCommandInput, cb: (err: any, data?: EnableIpamOrganizationAdminAccountCommandOutput) => void ): void; - public enableIpamOrganizationAdminAccount( + enableIpamOrganizationAdminAccount( args: EnableIpamOrganizationAdminAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableIpamOrganizationAdminAccountCommandOutput) => void ): void; - public enableIpamOrganizationAdminAccount( - args: EnableIpamOrganizationAdminAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableIpamOrganizationAdminAccountCommandOutput) => void), - cb?: (err: any, data?: EnableIpamOrganizationAdminAccountCommandOutput) => void - ): Promise | void { - const command = new EnableIpamOrganizationAdminAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Establishes a trust relationship between Reachability Analyzer and Organizations. - * This operation must be performed by the management account for the organization.

- *

After you establish a trust relationship, a user in the management account or - * a delegated administrator account can run a cross-account analysis using resources - * from the member accounts.

- */ - public enableReachabilityAnalyzerOrganizationSharing( + + /** + * @see {@link EnableReachabilityAnalyzerOrganizationSharingCommand} + */ + enableReachabilityAnalyzerOrganizationSharing( args: EnableReachabilityAnalyzerOrganizationSharingCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableReachabilityAnalyzerOrganizationSharing( + enableReachabilityAnalyzerOrganizationSharing( args: EnableReachabilityAnalyzerOrganizationSharingCommandInput, cb: (err: any, data?: EnableReachabilityAnalyzerOrganizationSharingCommandOutput) => void ): void; - public enableReachabilityAnalyzerOrganizationSharing( + enableReachabilityAnalyzerOrganizationSharing( args: EnableReachabilityAnalyzerOrganizationSharingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableReachabilityAnalyzerOrganizationSharingCommandOutput) => void ): void; - public enableReachabilityAnalyzerOrganizationSharing( - args: EnableReachabilityAnalyzerOrganizationSharingCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: EnableReachabilityAnalyzerOrganizationSharingCommandOutput) => void), - cb?: (err: any, data?: EnableReachabilityAnalyzerOrganizationSharingCommandOutput) => void - ): Promise | void { - const command = new EnableReachabilityAnalyzerOrganizationSharingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables access to the EC2 serial console of all instances for your account. By default, - * access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console - * in the Amazon EC2 User Guide.

- */ - public enableSerialConsoleAccess( + + /** + * @see {@link EnableSerialConsoleAccessCommand} + */ + enableSerialConsoleAccess( args: EnableSerialConsoleAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableSerialConsoleAccess( + enableSerialConsoleAccess( args: EnableSerialConsoleAccessCommandInput, cb: (err: any, data?: EnableSerialConsoleAccessCommandOutput) => void ): void; - public enableSerialConsoleAccess( + enableSerialConsoleAccess( args: EnableSerialConsoleAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableSerialConsoleAccessCommandOutput) => void ): void; - public enableSerialConsoleAccess( - args: EnableSerialConsoleAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableSerialConsoleAccessCommandOutput) => void), - cb?: (err: any, data?: EnableSerialConsoleAccessCommandOutput) => void - ): Promise | void { - const command = new EnableSerialConsoleAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables the specified attachment to propagate routes to the specified - * propagation route table.

- */ - public enableTransitGatewayRouteTablePropagation( + + /** + * @see {@link EnableTransitGatewayRouteTablePropagationCommand} + */ + enableTransitGatewayRouteTablePropagation( args: EnableTransitGatewayRouteTablePropagationCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableTransitGatewayRouteTablePropagation( + enableTransitGatewayRouteTablePropagation( args: EnableTransitGatewayRouteTablePropagationCommandInput, cb: (err: any, data?: EnableTransitGatewayRouteTablePropagationCommandOutput) => void ): void; - public enableTransitGatewayRouteTablePropagation( + enableTransitGatewayRouteTablePropagation( args: EnableTransitGatewayRouteTablePropagationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableTransitGatewayRouteTablePropagationCommandOutput) => void ): void; - public enableTransitGatewayRouteTablePropagation( - args: EnableTransitGatewayRouteTablePropagationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: EnableTransitGatewayRouteTablePropagationCommandOutput) => void), - cb?: (err: any, data?: EnableTransitGatewayRouteTablePropagationCommandOutput) => void - ): Promise | void { - const command = new EnableTransitGatewayRouteTablePropagationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables a virtual private gateway (VGW) to propagate routes to the specified route - * table of a VPC.

- */ - public enableVgwRoutePropagation( + + /** + * @see {@link EnableVgwRoutePropagationCommand} + */ + enableVgwRoutePropagation( args: EnableVgwRoutePropagationCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableVgwRoutePropagation( + enableVgwRoutePropagation( args: EnableVgwRoutePropagationCommandInput, cb: (err: any, data?: EnableVgwRoutePropagationCommandOutput) => void ): void; - public enableVgwRoutePropagation( + enableVgwRoutePropagation( args: EnableVgwRoutePropagationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableVgwRoutePropagationCommandOutput) => void ): void; - public enableVgwRoutePropagation( - args: EnableVgwRoutePropagationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableVgwRoutePropagationCommandOutput) => void), - cb?: (err: any, data?: EnableVgwRoutePropagationCommandOutput) => void - ): Promise | void { - const command = new EnableVgwRoutePropagationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables I/O operations for a volume that had I/O operations disabled because the data on - * the volume was potentially inconsistent.

- */ - public enableVolumeIO( + + /** + * @see {@link EnableVolumeIOCommand} + */ + enableVolumeIO( args: EnableVolumeIOCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableVolumeIO( - args: EnableVolumeIOCommandInput, - cb: (err: any, data?: EnableVolumeIOCommandOutput) => void - ): void; - public enableVolumeIO( + enableVolumeIO(args: EnableVolumeIOCommandInput, cb: (err: any, data?: EnableVolumeIOCommandOutput) => void): void; + enableVolumeIO( args: EnableVolumeIOCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableVolumeIOCommandOutput) => void ): void; - public enableVolumeIO( - args: EnableVolumeIOCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableVolumeIOCommandOutput) => void), - cb?: (err: any, data?: EnableVolumeIOCommandOutput) => void - ): Promise | void { - const command = new EnableVolumeIOCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- *

Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your - * ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot - * enable your VPC for ClassicLink if any of your VPC route tables have existing routes for - * address ranges within the 10.0.0.0/8 IP address range, excluding local - * routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address - * ranges. For more information, see ClassicLink in the - * Amazon Elastic Compute Cloud User Guide.

- */ - public enableVpcClassicLink( + + /** + * @see {@link EnableVpcClassicLinkCommand} + */ + enableVpcClassicLink( args: EnableVpcClassicLinkCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableVpcClassicLink( + enableVpcClassicLink( args: EnableVpcClassicLinkCommandInput, cb: (err: any, data?: EnableVpcClassicLinkCommandOutput) => void ): void; - public enableVpcClassicLink( + enableVpcClassicLink( args: EnableVpcClassicLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableVpcClassicLinkCommandOutput) => void ): void; - public enableVpcClassicLink( - args: EnableVpcClassicLinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableVpcClassicLinkCommandOutput) => void), - cb?: (err: any, data?: EnableVpcClassicLinkCommandOutput) => void - ): Promise | void { - const command = new EnableVpcClassicLinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- *

Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS - * hostname of a linked EC2-Classic instance resolves to its private IP address when - * addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname - * of an instance in a VPC resolves to its private IP address when addressed from a linked - * EC2-Classic instance. For more information, see ClassicLink in the - * Amazon Elastic Compute Cloud User Guide.

- *

You must specify a VPC ID in the request.

- */ - public enableVpcClassicLinkDnsSupport( + + /** + * @see {@link EnableVpcClassicLinkDnsSupportCommand} + */ + enableVpcClassicLinkDnsSupport( args: EnableVpcClassicLinkDnsSupportCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableVpcClassicLinkDnsSupport( + enableVpcClassicLinkDnsSupport( args: EnableVpcClassicLinkDnsSupportCommandInput, cb: (err: any, data?: EnableVpcClassicLinkDnsSupportCommandOutput) => void ): void; - public enableVpcClassicLinkDnsSupport( + enableVpcClassicLinkDnsSupport( args: EnableVpcClassicLinkDnsSupportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableVpcClassicLinkDnsSupportCommandOutput) => void ): void; - public enableVpcClassicLinkDnsSupport( - args: EnableVpcClassicLinkDnsSupportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableVpcClassicLinkDnsSupportCommandOutput) => void), - cb?: (err: any, data?: EnableVpcClassicLinkDnsSupportCommandOutput) => void - ): Promise | void { - const command = new EnableVpcClassicLinkDnsSupportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Downloads the client certificate revocation list for the specified Client VPN endpoint.

- */ - public exportClientVpnClientCertificateRevocationList( + + /** + * @see {@link ExportClientVpnClientCertificateRevocationListCommand} + */ + exportClientVpnClientCertificateRevocationList( args: ExportClientVpnClientCertificateRevocationListCommandInput, options?: __HttpHandlerOptions ): Promise; - public exportClientVpnClientCertificateRevocationList( + exportClientVpnClientCertificateRevocationList( args: ExportClientVpnClientCertificateRevocationListCommandInput, cb: (err: any, data?: ExportClientVpnClientCertificateRevocationListCommandOutput) => void ): void; - public exportClientVpnClientCertificateRevocationList( + exportClientVpnClientCertificateRevocationList( args: ExportClientVpnClientCertificateRevocationListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportClientVpnClientCertificateRevocationListCommandOutput) => void ): void; - public exportClientVpnClientCertificateRevocationList( - args: ExportClientVpnClientCertificateRevocationListCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ExportClientVpnClientCertificateRevocationListCommandOutput) => void), - cb?: (err: any, data?: ExportClientVpnClientCertificateRevocationListCommandOutput) => void - ): Promise | void { - const command = new ExportClientVpnClientCertificateRevocationListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration - * file includes the Client VPN endpoint and certificate information clients need to establish a connection - * with the Client VPN endpoint.

- */ - public exportClientVpnClientConfiguration( + + /** + * @see {@link ExportClientVpnClientConfigurationCommand} + */ + exportClientVpnClientConfiguration( args: ExportClientVpnClientConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public exportClientVpnClientConfiguration( + exportClientVpnClientConfiguration( args: ExportClientVpnClientConfigurationCommandInput, cb: (err: any, data?: ExportClientVpnClientConfigurationCommandOutput) => void ): void; - public exportClientVpnClientConfiguration( + exportClientVpnClientConfiguration( args: ExportClientVpnClientConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportClientVpnClientConfigurationCommandOutput) => void ): void; - public exportClientVpnClientConfiguration( - args: ExportClientVpnClientConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportClientVpnClientConfigurationCommandOutput) => void), - cb?: (err: any, data?: ExportClientVpnClientConfigurationCommandOutput) => void - ): Promise | void { - const command = new ExportClientVpnClientConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a VM - * directly from an Amazon Machine Image (AMI) in the - * VM Import/Export User Guide.

- */ - public exportImage(args: ExportImageCommandInput, options?: __HttpHandlerOptions): Promise; - public exportImage(args: ExportImageCommandInput, cb: (err: any, data?: ExportImageCommandOutput) => void): void; - public exportImage( + + /** + * @see {@link ExportImageCommand} + */ + exportImage(args: ExportImageCommandInput, options?: __HttpHandlerOptions): Promise; + exportImage(args: ExportImageCommandInput, cb: (err: any, data?: ExportImageCommandOutput) => void): void; + exportImage( args: ExportImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportImageCommandOutput) => void ): void; - public exportImage( - args: ExportImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportImageCommandOutput) => void), - cb?: (err: any, data?: ExportImageCommandOutput) => void - ): Promise | void { - const command = new ExportImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Exports routes from the specified transit gateway route table to the specified S3 bucket. - * By default, all routes are exported. Alternatively, you can filter by CIDR range.

- *

The routes are saved to the specified bucket in a JSON file. For more information, see - * Export Route Tables - * to Amazon S3 in Transit Gateways.

- */ - public exportTransitGatewayRoutes( + + /** + * @see {@link ExportTransitGatewayRoutesCommand} + */ + exportTransitGatewayRoutes( args: ExportTransitGatewayRoutesCommandInput, options?: __HttpHandlerOptions ): Promise; - public exportTransitGatewayRoutes( + exportTransitGatewayRoutes( args: ExportTransitGatewayRoutesCommandInput, cb: (err: any, data?: ExportTransitGatewayRoutesCommandOutput) => void ): void; - public exportTransitGatewayRoutes( + exportTransitGatewayRoutes( args: ExportTransitGatewayRoutesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportTransitGatewayRoutesCommandOutput) => void ): void; - public exportTransitGatewayRoutes( - args: ExportTransitGatewayRoutesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportTransitGatewayRoutesCommandOutput) => void), - cb?: (err: any, data?: ExportTransitGatewayRoutesCommandOutput) => void - ): Promise | void { - const command = new ExportTransitGatewayRoutesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the IAM roles that are associated with the specified ACM (ACM) certificate. - * It also returns the name of the Amazon S3 bucket and the Amazon S3 object key where the certificate, - * certificate chain, and encrypted private key bundle are stored, and the ARN of the KMS key - * that's used to encrypt the private key.

- */ - public getAssociatedEnclaveCertificateIamRoles( + + /** + * @see {@link GetAssociatedEnclaveCertificateIamRolesCommand} + */ + getAssociatedEnclaveCertificateIamRoles( args: GetAssociatedEnclaveCertificateIamRolesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAssociatedEnclaveCertificateIamRoles( + getAssociatedEnclaveCertificateIamRoles( args: GetAssociatedEnclaveCertificateIamRolesCommandInput, cb: (err: any, data?: GetAssociatedEnclaveCertificateIamRolesCommandOutput) => void ): void; - public getAssociatedEnclaveCertificateIamRoles( + getAssociatedEnclaveCertificateIamRoles( args: GetAssociatedEnclaveCertificateIamRolesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAssociatedEnclaveCertificateIamRolesCommandOutput) => void ): void; - public getAssociatedEnclaveCertificateIamRoles( - args: GetAssociatedEnclaveCertificateIamRolesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetAssociatedEnclaveCertificateIamRolesCommandOutput) => void), - cb?: (err: any, data?: GetAssociatedEnclaveCertificateIamRolesCommandOutput) => void - ): Promise | void { - const command = new GetAssociatedEnclaveCertificateIamRolesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.

- */ - public getAssociatedIpv6PoolCidrs( + + /** + * @see {@link GetAssociatedIpv6PoolCidrsCommand} + */ + getAssociatedIpv6PoolCidrs( args: GetAssociatedIpv6PoolCidrsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAssociatedIpv6PoolCidrs( + getAssociatedIpv6PoolCidrs( args: GetAssociatedIpv6PoolCidrsCommandInput, cb: (err: any, data?: GetAssociatedIpv6PoolCidrsCommandOutput) => void ): void; - public getAssociatedIpv6PoolCidrs( + getAssociatedIpv6PoolCidrs( args: GetAssociatedIpv6PoolCidrsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAssociatedIpv6PoolCidrsCommandOutput) => void ): void; - public getAssociatedIpv6PoolCidrs( - args: GetAssociatedIpv6PoolCidrsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAssociatedIpv6PoolCidrsCommandOutput) => void), - cb?: (err: any, data?: GetAssociatedIpv6PoolCidrsCommandOutput) => void - ): Promise | void { - const command = new GetAssociatedIpv6PoolCidrsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets network performance data.

- */ - public getAwsNetworkPerformanceData( + + /** + * @see {@link GetAwsNetworkPerformanceDataCommand} + */ + getAwsNetworkPerformanceData( args: GetAwsNetworkPerformanceDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAwsNetworkPerformanceData( + getAwsNetworkPerformanceData( args: GetAwsNetworkPerformanceDataCommandInput, cb: (err: any, data?: GetAwsNetworkPerformanceDataCommandOutput) => void ): void; - public getAwsNetworkPerformanceData( + getAwsNetworkPerformanceData( args: GetAwsNetworkPerformanceDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAwsNetworkPerformanceDataCommandOutput) => void ): void; - public getAwsNetworkPerformanceData( - args: GetAwsNetworkPerformanceDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAwsNetworkPerformanceDataCommandOutput) => void), - cb?: (err: any, data?: GetAwsNetworkPerformanceDataCommandOutput) => void - ): Promise | void { - const command = new GetAwsNetworkPerformanceDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner - * and each Amazon Web Services account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only - * the Capacity Reservation owner's usage.

- */ - public getCapacityReservationUsage( + + /** + * @see {@link GetCapacityReservationUsageCommand} + */ + getCapacityReservationUsage( args: GetCapacityReservationUsageCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCapacityReservationUsage( + getCapacityReservationUsage( args: GetCapacityReservationUsageCommandInput, cb: (err: any, data?: GetCapacityReservationUsageCommandOutput) => void ): void; - public getCapacityReservationUsage( + getCapacityReservationUsage( args: GetCapacityReservationUsageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCapacityReservationUsageCommandOutput) => void ): void; - public getCapacityReservationUsage( - args: GetCapacityReservationUsageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCapacityReservationUsageCommandOutput) => void), - cb?: (err: any, data?: GetCapacityReservationUsageCommandOutput) => void - ): Promise | void { - const command = new GetCapacityReservationUsageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the allocations from the specified customer-owned address pool.

- */ - public getCoipPoolUsage( + + /** + * @see {@link GetCoipPoolUsageCommand} + */ + getCoipPoolUsage( args: GetCoipPoolUsageCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCoipPoolUsage( + getCoipPoolUsage( args: GetCoipPoolUsageCommandInput, cb: (err: any, data?: GetCoipPoolUsageCommandOutput) => void ): void; - public getCoipPoolUsage( + getCoipPoolUsage( args: GetCoipPoolUsageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCoipPoolUsageCommandOutput) => void ): void; - public getCoipPoolUsage( - args: GetCoipPoolUsageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCoipPoolUsageCommandOutput) => void), - cb?: (err: any, data?: GetCoipPoolUsageCommandOutput) => void - ): Promise | void { - const command = new GetCoipPoolUsageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the console output for the specified instance. For Linux instances, the instance - * console output displays the exact console output that would normally be displayed on a - * physical monitor attached to a computer. For Windows instances, the instance console - * output includes the last three system event log errors.

- *

By default, the console output returns buffered information that was posted shortly - * after an instance transition state (start, stop, reboot, or terminate). This information - * is available for at least one hour after the most recent post. Only the most recent 64 - * KB of console output is available.

- *

You can optionally retrieve the latest serial console output at any time during the - * instance lifecycle. This option is supported on instance types that use the Nitro - * hypervisor.

- *

For more information, see Instance - * console output in the Amazon EC2 User Guide.

- */ - public getConsoleOutput( + + /** + * @see {@link GetConsoleOutputCommand} + */ + getConsoleOutput( args: GetConsoleOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConsoleOutput( + getConsoleOutput( args: GetConsoleOutputCommandInput, cb: (err: any, data?: GetConsoleOutputCommandOutput) => void ): void; - public getConsoleOutput( + getConsoleOutput( args: GetConsoleOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConsoleOutputCommandOutput) => void ): void; - public getConsoleOutput( - args: GetConsoleOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConsoleOutputCommandOutput) => void), - cb?: (err: any, data?: GetConsoleOutputCommandOutput) => void - ): Promise | void { - const command = new GetConsoleOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieve a JPG-format screenshot of a running instance to help with - * troubleshooting.

- *

The returned content is Base64-encoded.

- */ - public getConsoleScreenshot( + + /** + * @see {@link GetConsoleScreenshotCommand} + */ + getConsoleScreenshot( args: GetConsoleScreenshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConsoleScreenshot( + getConsoleScreenshot( args: GetConsoleScreenshotCommandInput, cb: (err: any, data?: GetConsoleScreenshotCommandOutput) => void ): void; - public getConsoleScreenshot( + getConsoleScreenshot( args: GetConsoleScreenshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConsoleScreenshotCommandOutput) => void ): void; - public getConsoleScreenshot( - args: GetConsoleScreenshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConsoleScreenshotCommandOutput) => void), - cb?: (err: any, data?: GetConsoleScreenshotCommandOutput) => void - ): Promise | void { - const command = new GetConsoleScreenshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the default credit option for CPU usage of a burstable performance instance - * family.

- *

For more information, see Burstable - * performance instances in the Amazon EC2 User Guide.

- */ - public getDefaultCreditSpecification( + + /** + * @see {@link GetDefaultCreditSpecificationCommand} + */ + getDefaultCreditSpecification( args: GetDefaultCreditSpecificationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDefaultCreditSpecification( + getDefaultCreditSpecification( args: GetDefaultCreditSpecificationCommandInput, cb: (err: any, data?: GetDefaultCreditSpecificationCommandOutput) => void ): void; - public getDefaultCreditSpecification( + getDefaultCreditSpecification( args: GetDefaultCreditSpecificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDefaultCreditSpecificationCommandOutput) => void ): void; - public getDefaultCreditSpecification( - args: GetDefaultCreditSpecificationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDefaultCreditSpecificationCommandOutput) => void), - cb?: (err: any, data?: GetDefaultCreditSpecificationCommandOutput) => void - ): Promise | void { - const command = new GetDefaultCreditSpecificationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the default KMS key for EBS encryption by default for your account in this Region. - * You can change the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or - * ResetEbsDefaultKmsKeyId.

- *

For more information, see Amazon EBS encryption - * in the Amazon Elastic Compute Cloud User Guide.

- */ - public getEbsDefaultKmsKeyId( + + /** + * @see {@link GetEbsDefaultKmsKeyIdCommand} + */ + getEbsDefaultKmsKeyId( args: GetEbsDefaultKmsKeyIdCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEbsDefaultKmsKeyId( + getEbsDefaultKmsKeyId( args: GetEbsDefaultKmsKeyIdCommandInput, cb: (err: any, data?: GetEbsDefaultKmsKeyIdCommandOutput) => void ): void; - public getEbsDefaultKmsKeyId( + getEbsDefaultKmsKeyId( args: GetEbsDefaultKmsKeyIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEbsDefaultKmsKeyIdCommandOutput) => void ): void; - public getEbsDefaultKmsKeyId( - args: GetEbsDefaultKmsKeyIdCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEbsDefaultKmsKeyIdCommandOutput) => void), - cb?: (err: any, data?: GetEbsDefaultKmsKeyIdCommandOutput) => void - ): Promise | void { - const command = new GetEbsDefaultKmsKeyIdCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes whether EBS encryption by default is enabled for your account in the current - * Region.

- *

For more information, see Amazon EBS encryption - * in the Amazon Elastic Compute Cloud User Guide.

- */ - public getEbsEncryptionByDefault( + + /** + * @see {@link GetEbsEncryptionByDefaultCommand} + */ + getEbsEncryptionByDefault( args: GetEbsEncryptionByDefaultCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEbsEncryptionByDefault( + getEbsEncryptionByDefault( args: GetEbsEncryptionByDefaultCommandInput, cb: (err: any, data?: GetEbsEncryptionByDefaultCommandOutput) => void ): void; - public getEbsEncryptionByDefault( + getEbsEncryptionByDefault( args: GetEbsEncryptionByDefaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEbsEncryptionByDefaultCommandOutput) => void ): void; - public getEbsEncryptionByDefault( - args: GetEbsEncryptionByDefaultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEbsEncryptionByDefaultCommandOutput) => void), - cb?: (err: any, data?: GetEbsEncryptionByDefaultCommandOutput) => void - ): Promise | void { - const command = new GetEbsEncryptionByDefaultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs - * with Amazon Athena. This make it easier for you to query and gain insights from VPC flow logs data. - * Based on the information that you provide, we configure resources in the template to do the following:

- *
    - *
  • - *

    Create a table in Athena that maps fields to a custom log format

    - *
  • - *
  • - *

    Create a Lambda function that updates the table with new partitions on a daily, weekly, or - * monthly basis

    - *
  • - *
  • - *

    Create a table partitioned between two timestamps in the past

    - *
  • - *
  • - *

    Create a set of named queries in Athena that you can use to get started quickly

    - *
  • - *
- */ - public getFlowLogsIntegrationTemplate( + + /** + * @see {@link GetFlowLogsIntegrationTemplateCommand} + */ + getFlowLogsIntegrationTemplate( args: GetFlowLogsIntegrationTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFlowLogsIntegrationTemplate( + getFlowLogsIntegrationTemplate( args: GetFlowLogsIntegrationTemplateCommandInput, cb: (err: any, data?: GetFlowLogsIntegrationTemplateCommandOutput) => void ): void; - public getFlowLogsIntegrationTemplate( + getFlowLogsIntegrationTemplate( args: GetFlowLogsIntegrationTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFlowLogsIntegrationTemplateCommandOutput) => void ): void; - public getFlowLogsIntegrationTemplate( - args: GetFlowLogsIntegrationTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFlowLogsIntegrationTemplateCommandOutput) => void), - cb?: (err: any, data?: GetFlowLogsIntegrationTemplateCommandOutput) => void - ): Promise | void { - const command = new GetFlowLogsIntegrationTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the resource groups to which a Capacity Reservation has been added.

- */ - public getGroupsForCapacityReservation( + + /** + * @see {@link GetGroupsForCapacityReservationCommand} + */ + getGroupsForCapacityReservation( args: GetGroupsForCapacityReservationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getGroupsForCapacityReservation( + getGroupsForCapacityReservation( args: GetGroupsForCapacityReservationCommandInput, cb: (err: any, data?: GetGroupsForCapacityReservationCommandOutput) => void ): void; - public getGroupsForCapacityReservation( + getGroupsForCapacityReservation( args: GetGroupsForCapacityReservationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupsForCapacityReservationCommandOutput) => void ): void; - public getGroupsForCapacityReservation( - args: GetGroupsForCapacityReservationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGroupsForCapacityReservationCommandOutput) => void), - cb?: (err: any, data?: GetGroupsForCapacityReservationCommandOutput) => void - ): Promise | void { - const command = new GetGroupsForCapacityReservationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Preview a reservation purchase with configurations that match those of your Dedicated - * Host. You must have active Dedicated Hosts in your account before you purchase a - * reservation.

- *

This is a preview of the PurchaseHostReservation action and does not - * result in the offering being purchased.

- */ - public getHostReservationPurchasePreview( + + /** + * @see {@link GetHostReservationPurchasePreviewCommand} + */ + getHostReservationPurchasePreview( args: GetHostReservationPurchasePreviewCommandInput, options?: __HttpHandlerOptions ): Promise; - public getHostReservationPurchasePreview( + getHostReservationPurchasePreview( args: GetHostReservationPurchasePreviewCommandInput, cb: (err: any, data?: GetHostReservationPurchasePreviewCommandOutput) => void ): void; - public getHostReservationPurchasePreview( + getHostReservationPurchasePreview( args: GetHostReservationPurchasePreviewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHostReservationPurchasePreviewCommandOutput) => void ): void; - public getHostReservationPurchasePreview( - args: GetHostReservationPurchasePreviewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetHostReservationPurchasePreviewCommandOutput) => void), - cb?: (err: any, data?: GetHostReservationPurchasePreviewCommandOutput) => void - ): Promise | void { - const command = new GetHostReservationPurchasePreviewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of instance types with the specified instance attributes. You can - * use the response to preview the instance types without launching instances. Note - * that the response does not consider capacity.

- *

When you specify multiple parameters, you get instance types that satisfy all of the - * specified parameters. If you specify multiple values for a parameter, you get instance - * types that satisfy any of the specified values.

- *

For more information, see Preview instance types with specified attributes, Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot - * placement score in the Amazon EC2 User Guide, and Creating an - * Auto Scaling group using attribute-based instance type selection in the - * Amazon EC2 Auto Scaling User Guide.

- */ - public getInstanceTypesFromInstanceRequirements( + + /** + * @see {@link GetInstanceTypesFromInstanceRequirementsCommand} + */ + getInstanceTypesFromInstanceRequirements( args: GetInstanceTypesFromInstanceRequirementsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInstanceTypesFromInstanceRequirements( + getInstanceTypesFromInstanceRequirements( args: GetInstanceTypesFromInstanceRequirementsCommandInput, cb: (err: any, data?: GetInstanceTypesFromInstanceRequirementsCommandOutput) => void ): void; - public getInstanceTypesFromInstanceRequirements( + getInstanceTypesFromInstanceRequirements( args: GetInstanceTypesFromInstanceRequirementsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInstanceTypesFromInstanceRequirementsCommandOutput) => void ): void; - public getInstanceTypesFromInstanceRequirements( - args: GetInstanceTypesFromInstanceRequirementsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetInstanceTypesFromInstanceRequirementsCommandOutput) => void), - cb?: (err: any, data?: GetInstanceTypesFromInstanceRequirementsCommandOutput) => void - ): Promise | void { - const command = new GetInstanceTypesFromInstanceRequirementsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

A binary representation of the UEFI variable store. Only non-volatile variables are - * stored. This is a base64 encoded and zlib compressed binary value that must be properly - * encoded.

- *

When you use register-image to create - * an AMI, you can create an exact copy of your variable store by passing the UEFI data in - * the UefiData parameter. You can modify the UEFI data by using the python-uefivars tool on - * GitHub. You can use the tool to convert the UEFI data into a human-readable format - * (JSON), which you can inspect and modify, and then convert back into the binary format - * to use with register-image.

- *

For more information, see UEFI Secure Boot in the - * Amazon EC2 User Guide.

- */ - public getInstanceUefiData( + + /** + * @see {@link GetInstanceUefiDataCommand} + */ + getInstanceUefiData( args: GetInstanceUefiDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInstanceUefiData( + getInstanceUefiData( args: GetInstanceUefiDataCommandInput, cb: (err: any, data?: GetInstanceUefiDataCommandOutput) => void ): void; - public getInstanceUefiData( + getInstanceUefiData( args: GetInstanceUefiDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInstanceUefiDataCommandOutput) => void ): void; - public getInstanceUefiData( - args: GetInstanceUefiDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInstanceUefiDataCommandOutput) => void), - cb?: (err: any, data?: GetInstanceUefiDataCommandOutput) => void - ): Promise | void { - const command = new GetInstanceUefiDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieve historical information about a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.

- */ - public getIpamAddressHistory( + + /** + * @see {@link GetIpamAddressHistoryCommand} + */ + getIpamAddressHistory( args: GetIpamAddressHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIpamAddressHistory( + getIpamAddressHistory( args: GetIpamAddressHistoryCommandInput, cb: (err: any, data?: GetIpamAddressHistoryCommandOutput) => void ): void; - public getIpamAddressHistory( + getIpamAddressHistory( args: GetIpamAddressHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIpamAddressHistoryCommandOutput) => void ): void; - public getIpamAddressHistory( - args: GetIpamAddressHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIpamAddressHistoryCommandOutput) => void), - cb?: (err: any, data?: GetIpamAddressHistoryCommandOutput) => void - ): Promise | void { - const command = new GetIpamAddressHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets IPAM discovered accounts. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts. Only the IPAM account can get all discovered accounts in the organization.

- */ - public getIpamDiscoveredAccounts( + + /** + * @see {@link GetIpamDiscoveredAccountsCommand} + */ + getIpamDiscoveredAccounts( args: GetIpamDiscoveredAccountsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIpamDiscoveredAccounts( + getIpamDiscoveredAccounts( args: GetIpamDiscoveredAccountsCommandInput, cb: (err: any, data?: GetIpamDiscoveredAccountsCommandOutput) => void ): void; - public getIpamDiscoveredAccounts( + getIpamDiscoveredAccounts( args: GetIpamDiscoveredAccountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIpamDiscoveredAccountsCommandOutput) => void ): void; - public getIpamDiscoveredAccounts( - args: GetIpamDiscoveredAccountsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIpamDiscoveredAccountsCommandOutput) => void), - cb?: (err: any, data?: GetIpamDiscoveredAccountsCommandOutput) => void - ): Promise | void { - const command = new GetIpamDiscoveredAccountsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the resource CIDRs that are monitored as part of a resource discovery. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses.

- */ - public getIpamDiscoveredResourceCidrs( + + /** + * @see {@link GetIpamDiscoveredResourceCidrsCommand} + */ + getIpamDiscoveredResourceCidrs( args: GetIpamDiscoveredResourceCidrsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIpamDiscoveredResourceCidrs( + getIpamDiscoveredResourceCidrs( args: GetIpamDiscoveredResourceCidrsCommandInput, cb: (err: any, data?: GetIpamDiscoveredResourceCidrsCommandOutput) => void ): void; - public getIpamDiscoveredResourceCidrs( + getIpamDiscoveredResourceCidrs( args: GetIpamDiscoveredResourceCidrsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIpamDiscoveredResourceCidrsCommandOutput) => void ): void; - public getIpamDiscoveredResourceCidrs( - args: GetIpamDiscoveredResourceCidrsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIpamDiscoveredResourceCidrsCommandOutput) => void), - cb?: (err: any, data?: GetIpamDiscoveredResourceCidrsCommandOutput) => void - ): Promise | void { - const command = new GetIpamDiscoveredResourceCidrsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get a list of all the CIDR allocations in an IPAM pool.

- * - *

If you use this action after AllocateIpamPoolCidr or ReleaseIpamPoolAllocation, note that all EC2 API actions follow an eventual consistency model.

- *
- */ - public getIpamPoolAllocations( + + /** + * @see {@link GetIpamPoolAllocationsCommand} + */ + getIpamPoolAllocations( args: GetIpamPoolAllocationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIpamPoolAllocations( + getIpamPoolAllocations( args: GetIpamPoolAllocationsCommandInput, cb: (err: any, data?: GetIpamPoolAllocationsCommandOutput) => void ): void; - public getIpamPoolAllocations( + getIpamPoolAllocations( args: GetIpamPoolAllocationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIpamPoolAllocationsCommandOutput) => void ): void; - public getIpamPoolAllocations( - args: GetIpamPoolAllocationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIpamPoolAllocationsCommandOutput) => void), - cb?: (err: any, data?: GetIpamPoolAllocationsCommandOutput) => void - ): Promise | void { - const command = new GetIpamPoolAllocationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get the CIDRs provisioned to an IPAM pool.

- */ - public getIpamPoolCidrs( + + /** + * @see {@link GetIpamPoolCidrsCommand} + */ + getIpamPoolCidrs( args: GetIpamPoolCidrsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIpamPoolCidrs( + getIpamPoolCidrs( args: GetIpamPoolCidrsCommandInput, cb: (err: any, data?: GetIpamPoolCidrsCommandOutput) => void ): void; - public getIpamPoolCidrs( + getIpamPoolCidrs( args: GetIpamPoolCidrsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIpamPoolCidrsCommandOutput) => void ): void; - public getIpamPoolCidrs( - args: GetIpamPoolCidrsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIpamPoolCidrsCommandOutput) => void), - cb?: (err: any, data?: GetIpamPoolCidrsCommandOutput) => void - ): Promise | void { - const command = new GetIpamPoolCidrsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns resource CIDRs managed by IPAM in a given scope. If an IPAM is associated with more than one resource discovery, the resource CIDRs across all of the resource discoveries is returned. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

- */ - public getIpamResourceCidrs( + + /** + * @see {@link GetIpamResourceCidrsCommand} + */ + getIpamResourceCidrs( args: GetIpamResourceCidrsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIpamResourceCidrs( + getIpamResourceCidrs( args: GetIpamResourceCidrsCommandInput, cb: (err: any, data?: GetIpamResourceCidrsCommandOutput) => void ): void; - public getIpamResourceCidrs( + getIpamResourceCidrs( args: GetIpamResourceCidrsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIpamResourceCidrsCommandOutput) => void ): void; - public getIpamResourceCidrs( - args: GetIpamResourceCidrsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIpamResourceCidrsCommandOutput) => void), - cb?: (err: any, data?: GetIpamResourceCidrsCommandOutput) => void - ): Promise | void { - const command = new GetIpamResourceCidrsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the configuration data of the specified instance. You can use this data to - * create a launch template.

- *

This action calls on other describe actions to get instance information. Depending on - * your instance configuration, you may need to allow the following actions in your IAM - * policy: DescribeSpotInstanceRequests, - * DescribeInstanceCreditSpecifications, DescribeVolumes, - * DescribeInstanceAttribute, and DescribeElasticGpus. Or, - * you can allow describe* depending on your instance requirements.

- */ - public getLaunchTemplateData( + + /** + * @see {@link GetLaunchTemplateDataCommand} + */ + getLaunchTemplateData( args: GetLaunchTemplateDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLaunchTemplateData( + getLaunchTemplateData( args: GetLaunchTemplateDataCommandInput, cb: (err: any, data?: GetLaunchTemplateDataCommandOutput) => void ): void; - public getLaunchTemplateData( + getLaunchTemplateData( args: GetLaunchTemplateDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLaunchTemplateDataCommandOutput) => void ): void; - public getLaunchTemplateData( - args: GetLaunchTemplateDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLaunchTemplateDataCommandOutput) => void), - cb?: (err: any, data?: GetLaunchTemplateDataCommandOutput) => void - ): Promise | void { - const command = new GetLaunchTemplateDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the resources that are associated with the specified managed prefix list.

- */ - public getManagedPrefixListAssociations( + + /** + * @see {@link GetManagedPrefixListAssociationsCommand} + */ + getManagedPrefixListAssociations( args: GetManagedPrefixListAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getManagedPrefixListAssociations( + getManagedPrefixListAssociations( args: GetManagedPrefixListAssociationsCommandInput, cb: (err: any, data?: GetManagedPrefixListAssociationsCommandOutput) => void ): void; - public getManagedPrefixListAssociations( + getManagedPrefixListAssociations( args: GetManagedPrefixListAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetManagedPrefixListAssociationsCommandOutput) => void ): void; - public getManagedPrefixListAssociations( - args: GetManagedPrefixListAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetManagedPrefixListAssociationsCommandOutput) => void), - cb?: (err: any, data?: GetManagedPrefixListAssociationsCommandOutput) => void - ): Promise | void { - const command = new GetManagedPrefixListAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the entries for a specified managed prefix list.

- */ - public getManagedPrefixListEntries( + + /** + * @see {@link GetManagedPrefixListEntriesCommand} + */ + getManagedPrefixListEntries( args: GetManagedPrefixListEntriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getManagedPrefixListEntries( + getManagedPrefixListEntries( args: GetManagedPrefixListEntriesCommandInput, cb: (err: any, data?: GetManagedPrefixListEntriesCommandOutput) => void ): void; - public getManagedPrefixListEntries( + getManagedPrefixListEntries( args: GetManagedPrefixListEntriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetManagedPrefixListEntriesCommandOutput) => void ): void; - public getManagedPrefixListEntries( - args: GetManagedPrefixListEntriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetManagedPrefixListEntriesCommandOutput) => void), - cb?: (err: any, data?: GetManagedPrefixListEntriesCommandOutput) => void - ): Promise | void { - const command = new GetManagedPrefixListEntriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the findings for the specified Network Access Scope analysis.

- */ - public getNetworkInsightsAccessScopeAnalysisFindings( + + /** + * @see {@link GetNetworkInsightsAccessScopeAnalysisFindingsCommand} + */ + getNetworkInsightsAccessScopeAnalysisFindings( args: GetNetworkInsightsAccessScopeAnalysisFindingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getNetworkInsightsAccessScopeAnalysisFindings( + getNetworkInsightsAccessScopeAnalysisFindings( args: GetNetworkInsightsAccessScopeAnalysisFindingsCommandInput, cb: (err: any, data?: GetNetworkInsightsAccessScopeAnalysisFindingsCommandOutput) => void ): void; - public getNetworkInsightsAccessScopeAnalysisFindings( + getNetworkInsightsAccessScopeAnalysisFindings( args: GetNetworkInsightsAccessScopeAnalysisFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNetworkInsightsAccessScopeAnalysisFindingsCommandOutput) => void ): void; - public getNetworkInsightsAccessScopeAnalysisFindings( - args: GetNetworkInsightsAccessScopeAnalysisFindingsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetNetworkInsightsAccessScopeAnalysisFindingsCommandOutput) => void), - cb?: (err: any, data?: GetNetworkInsightsAccessScopeAnalysisFindingsCommandOutput) => void - ): Promise | void { - const command = new GetNetworkInsightsAccessScopeAnalysisFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the content for the specified Network Access Scope.

- */ - public getNetworkInsightsAccessScopeContent( + + /** + * @see {@link GetNetworkInsightsAccessScopeContentCommand} + */ + getNetworkInsightsAccessScopeContent( args: GetNetworkInsightsAccessScopeContentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getNetworkInsightsAccessScopeContent( + getNetworkInsightsAccessScopeContent( args: GetNetworkInsightsAccessScopeContentCommandInput, cb: (err: any, data?: GetNetworkInsightsAccessScopeContentCommandOutput) => void ): void; - public getNetworkInsightsAccessScopeContent( + getNetworkInsightsAccessScopeContent( args: GetNetworkInsightsAccessScopeContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNetworkInsightsAccessScopeContentCommandOutput) => void ): void; - public getNetworkInsightsAccessScopeContent( - args: GetNetworkInsightsAccessScopeContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetNetworkInsightsAccessScopeContentCommandOutput) => void), - cb?: (err: any, data?: GetNetworkInsightsAccessScopeContentCommandOutput) => void - ): Promise | void { - const command = new GetNetworkInsightsAccessScopeContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the encrypted administrator password for a running Windows instance.

- *

The Windows password is generated at boot by the EC2Config service or - * EC2Launch scripts (Windows Server 2016 and later). This usually only - * happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the - * Amazon EC2 User Guide.

- *

For the EC2Config service, the password is not generated for rebundled - * AMIs unless Ec2SetPassword is enabled before bundling.

- *

The password is encrypted using the key pair that you specified when you launched the - * instance. You must provide the corresponding key pair file.

- *

When you launch an instance, password generation and encryption may take a few - * minutes. If you try to retrieve the password before it's available, the output returns - * an empty string. We recommend that you wait up to 15 minutes after launching an instance - * before trying to retrieve the generated password.

- */ - public getPasswordData( + + /** + * @see {@link GetPasswordDataCommand} + */ + getPasswordData( args: GetPasswordDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPasswordData( - args: GetPasswordDataCommandInput, - cb: (err: any, data?: GetPasswordDataCommandOutput) => void - ): void; - public getPasswordData( + getPasswordData(args: GetPasswordDataCommandInput, cb: (err: any, data?: GetPasswordDataCommandOutput) => void): void; + getPasswordData( args: GetPasswordDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPasswordDataCommandOutput) => void ): void; - public getPasswordData( - args: GetPasswordDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPasswordDataCommandOutput) => void), - cb?: (err: any, data?: GetPasswordDataCommandOutput) => void - ): Promise | void { - const command = new GetPasswordDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a quote and exchange information for exchanging one or more specified - * Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange - * cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange.

- */ - public getReservedInstancesExchangeQuote( + + /** + * @see {@link GetReservedInstancesExchangeQuoteCommand} + */ + getReservedInstancesExchangeQuote( args: GetReservedInstancesExchangeQuoteCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReservedInstancesExchangeQuote( + getReservedInstancesExchangeQuote( args: GetReservedInstancesExchangeQuoteCommandInput, cb: (err: any, data?: GetReservedInstancesExchangeQuoteCommandOutput) => void ): void; - public getReservedInstancesExchangeQuote( + getReservedInstancesExchangeQuote( args: GetReservedInstancesExchangeQuoteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReservedInstancesExchangeQuoteCommandOutput) => void ): void; - public getReservedInstancesExchangeQuote( - args: GetReservedInstancesExchangeQuoteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReservedInstancesExchangeQuoteCommandOutput) => void), - cb?: (err: any, data?: GetReservedInstancesExchangeQuoteCommandOutput) => void - ): Promise | void { - const command = new GetReservedInstancesExchangeQuoteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the access status of your account to the EC2 serial console of all instances. By - * default, access to the EC2 serial console is disabled for your account. For more - * information, see Manage account access to the EC2 serial console in the Amazon EC2 - * User Guide.

- */ - public getSerialConsoleAccessStatus( + + /** + * @see {@link GetSerialConsoleAccessStatusCommand} + */ + getSerialConsoleAccessStatus( args: GetSerialConsoleAccessStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSerialConsoleAccessStatus( + getSerialConsoleAccessStatus( args: GetSerialConsoleAccessStatusCommandInput, cb: (err: any, data?: GetSerialConsoleAccessStatusCommandOutput) => void ): void; - public getSerialConsoleAccessStatus( + getSerialConsoleAccessStatus( args: GetSerialConsoleAccessStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSerialConsoleAccessStatusCommandOutput) => void ): void; - public getSerialConsoleAccessStatus( - args: GetSerialConsoleAccessStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSerialConsoleAccessStatusCommandOutput) => void), - cb?: (err: any, data?: GetSerialConsoleAccessStatusCommandOutput) => void - ): Promise | void { - const command = new GetSerialConsoleAccessStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Calculates the Spot placement score for a Region or Availability Zone based on the - * specified target capacity and compute requirements.

- *

You can specify your compute requirements either by using - * InstanceRequirementsWithMetadata and letting Amazon EC2 choose the optimal - * instance types to fulfill your Spot request, or you can specify the instance types by using - * InstanceTypes.

- *

For more information, see Spot placement score in - * the Amazon EC2 User Guide.

- */ - public getSpotPlacementScores( + + /** + * @see {@link GetSpotPlacementScoresCommand} + */ + getSpotPlacementScores( args: GetSpotPlacementScoresCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSpotPlacementScores( + getSpotPlacementScores( args: GetSpotPlacementScoresCommandInput, cb: (err: any, data?: GetSpotPlacementScoresCommandOutput) => void ): void; - public getSpotPlacementScores( + getSpotPlacementScores( args: GetSpotPlacementScoresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSpotPlacementScoresCommandOutput) => void ): void; - public getSpotPlacementScores( - args: GetSpotPlacementScoresCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSpotPlacementScoresCommandOutput) => void), - cb?: (err: any, data?: GetSpotPlacementScoresCommandOutput) => void - ): Promise | void { - const command = new GetSpotPlacementScoresCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the subnet CIDR reservations.

- */ - public getSubnetCidrReservations( + + /** + * @see {@link GetSubnetCidrReservationsCommand} + */ + getSubnetCidrReservations( args: GetSubnetCidrReservationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSubnetCidrReservations( + getSubnetCidrReservations( args: GetSubnetCidrReservationsCommandInput, cb: (err: any, data?: GetSubnetCidrReservationsCommandOutput) => void ): void; - public getSubnetCidrReservations( + getSubnetCidrReservations( args: GetSubnetCidrReservationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSubnetCidrReservationsCommandOutput) => void ): void; - public getSubnetCidrReservations( - args: GetSubnetCidrReservationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSubnetCidrReservationsCommandOutput) => void), - cb?: (err: any, data?: GetSubnetCidrReservationsCommandOutput) => void - ): Promise | void { - const command = new GetSubnetCidrReservationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the route tables to which the specified resource attachment propagates routes.

- */ - public getTransitGatewayAttachmentPropagations( + + /** + * @see {@link GetTransitGatewayAttachmentPropagationsCommand} + */ + getTransitGatewayAttachmentPropagations( args: GetTransitGatewayAttachmentPropagationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTransitGatewayAttachmentPropagations( + getTransitGatewayAttachmentPropagations( args: GetTransitGatewayAttachmentPropagationsCommandInput, cb: (err: any, data?: GetTransitGatewayAttachmentPropagationsCommandOutput) => void ): void; - public getTransitGatewayAttachmentPropagations( + getTransitGatewayAttachmentPropagations( args: GetTransitGatewayAttachmentPropagationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTransitGatewayAttachmentPropagationsCommandOutput) => void ): void; - public getTransitGatewayAttachmentPropagations( - args: GetTransitGatewayAttachmentPropagationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetTransitGatewayAttachmentPropagationsCommandOutput) => void), - cb?: (err: any, data?: GetTransitGatewayAttachmentPropagationsCommandOutput) => void - ): Promise | void { - const command = new GetTransitGatewayAttachmentPropagationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the associations for the transit gateway multicast domain.

- */ - public getTransitGatewayMulticastDomainAssociations( + + /** + * @see {@link GetTransitGatewayMulticastDomainAssociationsCommand} + */ + getTransitGatewayMulticastDomainAssociations( args: GetTransitGatewayMulticastDomainAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTransitGatewayMulticastDomainAssociations( + getTransitGatewayMulticastDomainAssociations( args: GetTransitGatewayMulticastDomainAssociationsCommandInput, cb: (err: any, data?: GetTransitGatewayMulticastDomainAssociationsCommandOutput) => void ): void; - public getTransitGatewayMulticastDomainAssociations( + getTransitGatewayMulticastDomainAssociations( args: GetTransitGatewayMulticastDomainAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTransitGatewayMulticastDomainAssociationsCommandOutput) => void ): void; - public getTransitGatewayMulticastDomainAssociations( - args: GetTransitGatewayMulticastDomainAssociationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetTransitGatewayMulticastDomainAssociationsCommandOutput) => void), - cb?: (err: any, data?: GetTransitGatewayMulticastDomainAssociationsCommandOutput) => void - ): Promise | void { - const command = new GetTransitGatewayMulticastDomainAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of the transit gateway policy table associations.

- */ - public getTransitGatewayPolicyTableAssociations( + + /** + * @see {@link GetTransitGatewayPolicyTableAssociationsCommand} + */ + getTransitGatewayPolicyTableAssociations( args: GetTransitGatewayPolicyTableAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTransitGatewayPolicyTableAssociations( + getTransitGatewayPolicyTableAssociations( args: GetTransitGatewayPolicyTableAssociationsCommandInput, cb: (err: any, data?: GetTransitGatewayPolicyTableAssociationsCommandOutput) => void ): void; - public getTransitGatewayPolicyTableAssociations( + getTransitGatewayPolicyTableAssociations( args: GetTransitGatewayPolicyTableAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTransitGatewayPolicyTableAssociationsCommandOutput) => void ): void; - public getTransitGatewayPolicyTableAssociations( - args: GetTransitGatewayPolicyTableAssociationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetTransitGatewayPolicyTableAssociationsCommandOutput) => void), - cb?: (err: any, data?: GetTransitGatewayPolicyTableAssociationsCommandOutput) => void - ): Promise | void { - const command = new GetTransitGatewayPolicyTableAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of transit gateway policy table entries.

- */ - public getTransitGatewayPolicyTableEntries( + + /** + * @see {@link GetTransitGatewayPolicyTableEntriesCommand} + */ + getTransitGatewayPolicyTableEntries( args: GetTransitGatewayPolicyTableEntriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTransitGatewayPolicyTableEntries( + getTransitGatewayPolicyTableEntries( args: GetTransitGatewayPolicyTableEntriesCommandInput, cb: (err: any, data?: GetTransitGatewayPolicyTableEntriesCommandOutput) => void ): void; - public getTransitGatewayPolicyTableEntries( + getTransitGatewayPolicyTableEntries( args: GetTransitGatewayPolicyTableEntriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTransitGatewayPolicyTableEntriesCommandOutput) => void ): void; - public getTransitGatewayPolicyTableEntries( - args: GetTransitGatewayPolicyTableEntriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTransitGatewayPolicyTableEntriesCommandOutput) => void), - cb?: (err: any, data?: GetTransitGatewayPolicyTableEntriesCommandOutput) => void - ): Promise | void { - const command = new GetTransitGatewayPolicyTableEntriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the prefix list references in a specified transit gateway route table.

- */ - public getTransitGatewayPrefixListReferences( + + /** + * @see {@link GetTransitGatewayPrefixListReferencesCommand} + */ + getTransitGatewayPrefixListReferences( args: GetTransitGatewayPrefixListReferencesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTransitGatewayPrefixListReferences( + getTransitGatewayPrefixListReferences( args: GetTransitGatewayPrefixListReferencesCommandInput, cb: (err: any, data?: GetTransitGatewayPrefixListReferencesCommandOutput) => void ): void; - public getTransitGatewayPrefixListReferences( + getTransitGatewayPrefixListReferences( args: GetTransitGatewayPrefixListReferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTransitGatewayPrefixListReferencesCommandOutput) => void ): void; - public getTransitGatewayPrefixListReferences( - args: GetTransitGatewayPrefixListReferencesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetTransitGatewayPrefixListReferencesCommandOutput) => void), - cb?: (err: any, data?: GetTransitGatewayPrefixListReferencesCommandOutput) => void - ): Promise | void { - const command = new GetTransitGatewayPrefixListReferencesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the associations for the specified transit gateway route table.

- */ - public getTransitGatewayRouteTableAssociations( + + /** + * @see {@link GetTransitGatewayRouteTableAssociationsCommand} + */ + getTransitGatewayRouteTableAssociations( args: GetTransitGatewayRouteTableAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTransitGatewayRouteTableAssociations( + getTransitGatewayRouteTableAssociations( args: GetTransitGatewayRouteTableAssociationsCommandInput, cb: (err: any, data?: GetTransitGatewayRouteTableAssociationsCommandOutput) => void ): void; - public getTransitGatewayRouteTableAssociations( + getTransitGatewayRouteTableAssociations( args: GetTransitGatewayRouteTableAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTransitGatewayRouteTableAssociationsCommandOutput) => void ): void; - public getTransitGatewayRouteTableAssociations( - args: GetTransitGatewayRouteTableAssociationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetTransitGatewayRouteTableAssociationsCommandOutput) => void), - cb?: (err: any, data?: GetTransitGatewayRouteTableAssociationsCommandOutput) => void - ): Promise | void { - const command = new GetTransitGatewayRouteTableAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the route table propagations for the specified transit gateway route table.

- */ - public getTransitGatewayRouteTablePropagations( + + /** + * @see {@link GetTransitGatewayRouteTablePropagationsCommand} + */ + getTransitGatewayRouteTablePropagations( args: GetTransitGatewayRouteTablePropagationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTransitGatewayRouteTablePropagations( + getTransitGatewayRouteTablePropagations( args: GetTransitGatewayRouteTablePropagationsCommandInput, cb: (err: any, data?: GetTransitGatewayRouteTablePropagationsCommandOutput) => void ): void; - public getTransitGatewayRouteTablePropagations( + getTransitGatewayRouteTablePropagations( args: GetTransitGatewayRouteTablePropagationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTransitGatewayRouteTablePropagationsCommandOutput) => void ): void; - public getTransitGatewayRouteTablePropagations( - args: GetTransitGatewayRouteTablePropagationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetTransitGatewayRouteTablePropagationsCommandOutput) => void), - cb?: (err: any, data?: GetTransitGatewayRouteTablePropagationsCommandOutput) => void - ): Promise | void { - const command = new GetTransitGatewayRouteTablePropagationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get the Verified Access policy associated with the endpoint.

- */ - public getVerifiedAccessEndpointPolicy( + + /** + * @see {@link GetVerifiedAccessEndpointPolicyCommand} + */ + getVerifiedAccessEndpointPolicy( args: GetVerifiedAccessEndpointPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVerifiedAccessEndpointPolicy( + getVerifiedAccessEndpointPolicy( args: GetVerifiedAccessEndpointPolicyCommandInput, cb: (err: any, data?: GetVerifiedAccessEndpointPolicyCommandOutput) => void ): void; - public getVerifiedAccessEndpointPolicy( + getVerifiedAccessEndpointPolicy( args: GetVerifiedAccessEndpointPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVerifiedAccessEndpointPolicyCommandOutput) => void ): void; - public getVerifiedAccessEndpointPolicy( - args: GetVerifiedAccessEndpointPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVerifiedAccessEndpointPolicyCommandOutput) => void), - cb?: (err: any, data?: GetVerifiedAccessEndpointPolicyCommandOutput) => void - ): Promise | void { - const command = new GetVerifiedAccessEndpointPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Shows the contents of the Verified Access policy associated with the group.

- */ - public getVerifiedAccessGroupPolicy( + + /** + * @see {@link GetVerifiedAccessGroupPolicyCommand} + */ + getVerifiedAccessGroupPolicy( args: GetVerifiedAccessGroupPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVerifiedAccessGroupPolicy( + getVerifiedAccessGroupPolicy( args: GetVerifiedAccessGroupPolicyCommandInput, cb: (err: any, data?: GetVerifiedAccessGroupPolicyCommandOutput) => void ): void; - public getVerifiedAccessGroupPolicy( + getVerifiedAccessGroupPolicy( args: GetVerifiedAccessGroupPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVerifiedAccessGroupPolicyCommandOutput) => void ): void; - public getVerifiedAccessGroupPolicy( - args: GetVerifiedAccessGroupPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVerifiedAccessGroupPolicyCommandOutput) => void), - cb?: (err: any, data?: GetVerifiedAccessGroupPolicyCommandOutput) => void - ): Promise | void { - const command = new GetVerifiedAccessGroupPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Download an Amazon Web Services-provided sample configuration file to be used with the customer - * gateway device specified for your Site-to-Site VPN connection.

- */ - public getVpnConnectionDeviceSampleConfiguration( + + /** + * @see {@link GetVpnConnectionDeviceSampleConfigurationCommand} + */ + getVpnConnectionDeviceSampleConfiguration( args: GetVpnConnectionDeviceSampleConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVpnConnectionDeviceSampleConfiguration( + getVpnConnectionDeviceSampleConfiguration( args: GetVpnConnectionDeviceSampleConfigurationCommandInput, cb: (err: any, data?: GetVpnConnectionDeviceSampleConfigurationCommandOutput) => void ): void; - public getVpnConnectionDeviceSampleConfiguration( + getVpnConnectionDeviceSampleConfiguration( args: GetVpnConnectionDeviceSampleConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVpnConnectionDeviceSampleConfigurationCommandOutput) => void ): void; - public getVpnConnectionDeviceSampleConfiguration( - args: GetVpnConnectionDeviceSampleConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetVpnConnectionDeviceSampleConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetVpnConnectionDeviceSampleConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetVpnConnectionDeviceSampleConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Obtain a list of customer gateway devices for which sample configuration - * files can be provided. The request has no additional parameters. You can also see the - * list of device types with sample configuration files available under Your customer gateway - * device in the Amazon Web Services Site-to-Site VPN User Guide.

- */ - public getVpnConnectionDeviceTypes( + + /** + * @see {@link GetVpnConnectionDeviceTypesCommand} + */ + getVpnConnectionDeviceTypes( args: GetVpnConnectionDeviceTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVpnConnectionDeviceTypes( + getVpnConnectionDeviceTypes( args: GetVpnConnectionDeviceTypesCommandInput, cb: (err: any, data?: GetVpnConnectionDeviceTypesCommandOutput) => void ): void; - public getVpnConnectionDeviceTypes( + getVpnConnectionDeviceTypes( args: GetVpnConnectionDeviceTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVpnConnectionDeviceTypesCommandOutput) => void ): void; - public getVpnConnectionDeviceTypes( - args: GetVpnConnectionDeviceTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVpnConnectionDeviceTypesCommandOutput) => void), - cb?: (err: any, data?: GetVpnConnectionDeviceTypesCommandOutput) => void - ): Promise | void { - const command = new GetVpnConnectionDeviceTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get details of available tunnel endpoint maintenance.

- */ - public getVpnTunnelReplacementStatus( + + /** + * @see {@link GetVpnTunnelReplacementStatusCommand} + */ + getVpnTunnelReplacementStatus( args: GetVpnTunnelReplacementStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVpnTunnelReplacementStatus( + getVpnTunnelReplacementStatus( args: GetVpnTunnelReplacementStatusCommandInput, cb: (err: any, data?: GetVpnTunnelReplacementStatusCommandOutput) => void ): void; - public getVpnTunnelReplacementStatus( + getVpnTunnelReplacementStatus( args: GetVpnTunnelReplacementStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVpnTunnelReplacementStatusCommandOutput) => void ): void; - public getVpnTunnelReplacementStatus( - args: GetVpnTunnelReplacementStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVpnTunnelReplacementStatusCommandOutput) => void), - cb?: (err: any, data?: GetVpnTunnelReplacementStatusCommandOutput) => void - ): Promise | void { - const command = new GetVpnTunnelReplacementStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list.

- *

Uploading a client certificate revocation list resets existing client connections.

- */ - public importClientVpnClientCertificateRevocationList( + + /** + * @see {@link ImportClientVpnClientCertificateRevocationListCommand} + */ + importClientVpnClientCertificateRevocationList( args: ImportClientVpnClientCertificateRevocationListCommandInput, options?: __HttpHandlerOptions ): Promise; - public importClientVpnClientCertificateRevocationList( + importClientVpnClientCertificateRevocationList( args: ImportClientVpnClientCertificateRevocationListCommandInput, cb: (err: any, data?: ImportClientVpnClientCertificateRevocationListCommandOutput) => void ): void; - public importClientVpnClientCertificateRevocationList( + importClientVpnClientCertificateRevocationList( args: ImportClientVpnClientCertificateRevocationListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportClientVpnClientCertificateRevocationListCommandOutput) => void ): void; - public importClientVpnClientCertificateRevocationList( - args: ImportClientVpnClientCertificateRevocationListCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ImportClientVpnClientCertificateRevocationListCommandOutput) => void), - cb?: (err: any, data?: ImportClientVpnClientCertificateRevocationListCommandOutput) => void - ): Promise | void { - const command = new ImportClientVpnClientCertificateRevocationListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

To import your virtual machines (VMs) with a console-based experience, you can use the - * Import virtual machine images to Amazon Web Services template in the Migration Hub Orchestrator console. For more - * information, see the - * Migration Hub Orchestrator User Guide - * .

- *
- *

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).

- * - *

Amazon Web Services VM Import/Export strongly recommends specifying a value for either the - * --license-type or --usage-operation parameter when you create a new - * VM Import task. This ensures your operating system is licensed appropriately and your billing is - * optimized.

- *
- *

For more information, see Importing a - * VM as an image using VM Import/Export in the VM Import/Export User Guide.

- */ - public importImage(args: ImportImageCommandInput, options?: __HttpHandlerOptions): Promise; - public importImage(args: ImportImageCommandInput, cb: (err: any, data?: ImportImageCommandOutput) => void): void; - public importImage( + + /** + * @see {@link ImportImageCommand} + */ + importImage(args: ImportImageCommandInput, options?: __HttpHandlerOptions): Promise; + importImage(args: ImportImageCommandInput, cb: (err: any, data?: ImportImageCommandOutput) => void): void; + importImage( args: ImportImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportImageCommandOutput) => void ): void; - public importImage( - args: ImportImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportImageCommandOutput) => void), - cb?: (err: any, data?: ImportImageCommandOutput) => void - ): Promise | void { - const command = new ImportImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an import instance task using metadata from the specified disk image.

- *

This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage - * instead.

- *

This API action is not supported by the Command Line Interface (CLI). For - * information about using the Amazon EC2 CLI, which is deprecated, see - * Importing a VM to Amazon EC2 in the Amazon EC2 CLI Reference PDF file.

- *

For information about the import manifest referenced by this API action, see VM Import Manifest.

- */ - public importInstance( + + /** + * @see {@link ImportInstanceCommand} + */ + importInstance( args: ImportInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public importInstance( - args: ImportInstanceCommandInput, - cb: (err: any, data?: ImportInstanceCommandOutput) => void - ): void; - public importInstance( + importInstance(args: ImportInstanceCommandInput, cb: (err: any, data?: ImportInstanceCommandOutput) => void): void; + importInstance( args: ImportInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportInstanceCommandOutput) => void ): void; - public importInstance( - args: ImportInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportInstanceCommandOutput) => void), - cb?: (err: any, data?: ImportInstanceCommandOutput) => void - ): Promise | void { - const command = new ImportInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Imports the public key from an RSA or ED25519 key pair that you created with a third-party tool. - * Compare this with CreateKeyPair, in which Amazon Web Services creates the key pair and gives the keys to you - * (Amazon Web Services keeps a copy of the public key). With ImportKeyPair, you create the key pair and give Amazon Web Services just the public key. - * The private key is never transferred between you and Amazon Web Services.

- *

For more information about key pairs, see Amazon EC2 key pairs - * in the Amazon Elastic Compute Cloud User Guide.

- */ - public importKeyPair( - args: ImportKeyPairCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public importKeyPair( - args: ImportKeyPairCommandInput, - cb: (err: any, data?: ImportKeyPairCommandOutput) => void - ): void; - public importKeyPair( + + /** + * @see {@link ImportKeyPairCommand} + */ + importKeyPair(args: ImportKeyPairCommandInput, options?: __HttpHandlerOptions): Promise; + importKeyPair(args: ImportKeyPairCommandInput, cb: (err: any, data?: ImportKeyPairCommandOutput) => void): void; + importKeyPair( args: ImportKeyPairCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportKeyPairCommandOutput) => void ): void; - public importKeyPair( - args: ImportKeyPairCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportKeyPairCommandOutput) => void), - cb?: (err: any, data?: ImportKeyPairCommandOutput) => void - ): Promise | void { - const command = new ImportKeyPairCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Imports a disk into an EBS snapshot.

- *

For more information, see Importing a disk as a snapshot using VM Import/Export in the - * VM Import/Export User Guide.

- */ - public importSnapshot( + + /** + * @see {@link ImportSnapshotCommand} + */ + importSnapshot( args: ImportSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public importSnapshot( - args: ImportSnapshotCommandInput, - cb: (err: any, data?: ImportSnapshotCommandOutput) => void - ): void; - public importSnapshot( + importSnapshot(args: ImportSnapshotCommandInput, cb: (err: any, data?: ImportSnapshotCommandOutput) => void): void; + importSnapshot( args: ImportSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportSnapshotCommandOutput) => void ): void; - public importSnapshot( - args: ImportSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportSnapshotCommandOutput) => void), - cb?: (err: any, data?: ImportSnapshotCommandOutput) => void - ): Promise | void { - const command = new ImportSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an import volume task using metadata from the specified disk image.

- *

This API action supports only single-volume VMs. To import multi-volume VMs, use - * ImportImage instead. To import a disk to a snapshot, use - * ImportSnapshot instead.

- *

This API action is not supported by the Command Line Interface (CLI). For - * information about using the Amazon EC2 CLI, which is deprecated, see Importing Disks to Amazon EBS in the Amazon EC2 CLI Reference PDF file.

- *

For information about the import manifest referenced by this API action, see VM Import Manifest.

- */ - public importVolume( - args: ImportVolumeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public importVolume(args: ImportVolumeCommandInput, cb: (err: any, data?: ImportVolumeCommandOutput) => void): void; - public importVolume( + + /** + * @see {@link ImportVolumeCommand} + */ + importVolume(args: ImportVolumeCommandInput, options?: __HttpHandlerOptions): Promise; + importVolume(args: ImportVolumeCommandInput, cb: (err: any, data?: ImportVolumeCommandOutput) => void): void; + importVolume( args: ImportVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportVolumeCommandOutput) => void ): void; - public importVolume( - args: ImportVolumeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportVolumeCommandOutput) => void), - cb?: (err: any, data?: ImportVolumeCommandOutput) => void - ): Promise | void { - const command = new ImportVolumeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists one or more AMIs that are currently in the Recycle Bin. For more information, - * see Recycle - * Bin in the Amazon EC2 User Guide.

- */ - public listImagesInRecycleBin( + + /** + * @see {@link ListImagesInRecycleBinCommand} + */ + listImagesInRecycleBin( args: ListImagesInRecycleBinCommandInput, options?: __HttpHandlerOptions ): Promise; - public listImagesInRecycleBin( + listImagesInRecycleBin( args: ListImagesInRecycleBinCommandInput, cb: (err: any, data?: ListImagesInRecycleBinCommandOutput) => void ): void; - public listImagesInRecycleBin( + listImagesInRecycleBin( args: ListImagesInRecycleBinCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImagesInRecycleBinCommandOutput) => void ): void; - public listImagesInRecycleBin( - args: ListImagesInRecycleBinCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListImagesInRecycleBinCommandOutput) => void), - cb?: (err: any, data?: ListImagesInRecycleBinCommandOutput) => void - ): Promise | void { - const command = new ListImagesInRecycleBinCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists one or more snapshots that are currently in the Recycle Bin.

- */ - public listSnapshotsInRecycleBin( + + /** + * @see {@link ListSnapshotsInRecycleBinCommand} + */ + listSnapshotsInRecycleBin( args: ListSnapshotsInRecycleBinCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSnapshotsInRecycleBin( + listSnapshotsInRecycleBin( args: ListSnapshotsInRecycleBinCommandInput, cb: (err: any, data?: ListSnapshotsInRecycleBinCommandOutput) => void ): void; - public listSnapshotsInRecycleBin( + listSnapshotsInRecycleBin( args: ListSnapshotsInRecycleBinCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSnapshotsInRecycleBinCommandOutput) => void ): void; - public listSnapshotsInRecycleBin( - args: ListSnapshotsInRecycleBinCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSnapshotsInRecycleBinCommandOutput) => void), - cb?: (err: any, data?: ListSnapshotsInRecycleBinCommandOutput) => void - ): Promise | void { - const command = new ListSnapshotsInRecycleBinCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications.

- */ - public modifyAddressAttribute( + + /** + * @see {@link ModifyAddressAttributeCommand} + */ + modifyAddressAttribute( args: ModifyAddressAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyAddressAttribute( + modifyAddressAttribute( args: ModifyAddressAttributeCommandInput, cb: (err: any, data?: ModifyAddressAttributeCommandOutput) => void ): void; - public modifyAddressAttribute( + modifyAddressAttribute( args: ModifyAddressAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyAddressAttributeCommandOutput) => void ): void; - public modifyAddressAttribute( - args: ModifyAddressAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyAddressAttributeCommandOutput) => void), - cb?: (err: any, data?: ModifyAddressAttributeCommandOutput) => void - ): Promise | void { - const command = new ModifyAddressAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Changes the opt-in status of the Local Zone and Wavelength Zone group for your - * account.

- *

Use - * DescribeAvailabilityZones to view the value for GroupName.

- */ - public modifyAvailabilityZoneGroup( + + /** + * @see {@link ModifyAvailabilityZoneGroupCommand} + */ + modifyAvailabilityZoneGroup( args: ModifyAvailabilityZoneGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyAvailabilityZoneGroup( + modifyAvailabilityZoneGroup( args: ModifyAvailabilityZoneGroupCommandInput, cb: (err: any, data?: ModifyAvailabilityZoneGroupCommandOutput) => void ): void; - public modifyAvailabilityZoneGroup( + modifyAvailabilityZoneGroup( args: ModifyAvailabilityZoneGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyAvailabilityZoneGroupCommandOutput) => void ): void; - public modifyAvailabilityZoneGroup( - args: ModifyAvailabilityZoneGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyAvailabilityZoneGroupCommandOutput) => void), - cb?: (err: any, data?: ModifyAvailabilityZoneGroupCommandOutput) => void - ): Promise | void { - const command = new ModifyAvailabilityZoneGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies a Capacity Reservation's capacity and the conditions under which it is to be released. You - * cannot change a Capacity Reservation's instance type, EBS optimization, instance store settings, - * platform, Availability Zone, or instance eligibility. If you need to modify any of these - * attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with - * the required attributes.

- */ - public modifyCapacityReservation( + + /** + * @see {@link ModifyCapacityReservationCommand} + */ + modifyCapacityReservation( args: ModifyCapacityReservationCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyCapacityReservation( + modifyCapacityReservation( args: ModifyCapacityReservationCommandInput, cb: (err: any, data?: ModifyCapacityReservationCommandOutput) => void ): void; - public modifyCapacityReservation( + modifyCapacityReservation( args: ModifyCapacityReservationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyCapacityReservationCommandOutput) => void ): void; - public modifyCapacityReservation( - args: ModifyCapacityReservationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyCapacityReservationCommandOutput) => void), - cb?: (err: any, data?: ModifyCapacityReservationCommandOutput) => void - ): Promise | void { - const command = new ModifyCapacityReservationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies a Capacity Reservation Fleet.

- *

When you modify the total target capacity of a Capacity Reservation Fleet, the Fleet automatically - * creates new Capacity Reservations, or modifies or cancels existing Capacity Reservations in the Fleet - * to meet the new total target capacity. When you modify the end date for the Fleet, the end dates for - * all of the individual Capacity Reservations in the Fleet are updated accordingly.

- */ - public modifyCapacityReservationFleet( + + /** + * @see {@link ModifyCapacityReservationFleetCommand} + */ + modifyCapacityReservationFleet( args: ModifyCapacityReservationFleetCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyCapacityReservationFleet( + modifyCapacityReservationFleet( args: ModifyCapacityReservationFleetCommandInput, cb: (err: any, data?: ModifyCapacityReservationFleetCommandOutput) => void ): void; - public modifyCapacityReservationFleet( + modifyCapacityReservationFleet( args: ModifyCapacityReservationFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyCapacityReservationFleetCommandOutput) => void ): void; - public modifyCapacityReservationFleet( - args: ModifyCapacityReservationFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyCapacityReservationFleetCommandOutput) => void), - cb?: (err: any, data?: ModifyCapacityReservationFleetCommandOutput) => void - ): Promise | void { - const command = new ModifyCapacityReservationFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.

- */ - public modifyClientVpnEndpoint( + + /** + * @see {@link ModifyClientVpnEndpointCommand} + */ + modifyClientVpnEndpoint( args: ModifyClientVpnEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyClientVpnEndpoint( + modifyClientVpnEndpoint( args: ModifyClientVpnEndpointCommandInput, cb: (err: any, data?: ModifyClientVpnEndpointCommandOutput) => void ): void; - public modifyClientVpnEndpoint( + modifyClientVpnEndpoint( args: ModifyClientVpnEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyClientVpnEndpointCommandOutput) => void ): void; - public modifyClientVpnEndpoint( - args: ModifyClientVpnEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyClientVpnEndpointCommandOutput) => void), - cb?: (err: any, data?: ModifyClientVpnEndpointCommandOutput) => void - ): Promise | void { - const command = new ModifyClientVpnEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the default credit option for CPU usage of burstable performance instances. - * The default credit option is set at the account level per Amazon Web Services Region, and - * is specified per instance family. All new burstable performance instances in the account - * launch using the default credit option.

- *

- * ModifyDefaultCreditSpecification is an asynchronous operation, which - * works at an Amazon Web Services Region level and modifies the credit option for each - * Availability Zone. All zones in a Region are updated within five minutes. But if - * instances are launched during this operation, they might not get the new credit option - * until the zone is updated. To verify whether the update has occurred, you can call - * GetDefaultCreditSpecification and check - * DefaultCreditSpecification for updates.

- *

For more information, see Burstable - * performance instances in the Amazon EC2 User Guide.

- */ - public modifyDefaultCreditSpecification( + + /** + * @see {@link ModifyDefaultCreditSpecificationCommand} + */ + modifyDefaultCreditSpecification( args: ModifyDefaultCreditSpecificationCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDefaultCreditSpecification( + modifyDefaultCreditSpecification( args: ModifyDefaultCreditSpecificationCommandInput, cb: (err: any, data?: ModifyDefaultCreditSpecificationCommandOutput) => void ): void; - public modifyDefaultCreditSpecification( + modifyDefaultCreditSpecification( args: ModifyDefaultCreditSpecificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDefaultCreditSpecificationCommandOutput) => void ): void; - public modifyDefaultCreditSpecification( - args: ModifyDefaultCreditSpecificationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDefaultCreditSpecificationCommandOutput) => void), - cb?: (err: any, data?: ModifyDefaultCreditSpecificationCommandOutput) => void - ): Promise | void { - const command = new ModifyDefaultCreditSpecificationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Changes the default KMS key for EBS encryption by default for your account in this Region.

- *

Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If - * you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services - * managed KMS key. To reset the default KMS key to the Amazon Web Services managed KMS key for EBS, use ResetEbsDefaultKmsKeyId. Amazon EBS does not support asymmetric KMS keys.

- *

If you delete or disable the customer managed KMS key that you specified for use with - * encryption by default, your instances will fail to launch.

- *

For more information, see Amazon EBS encryption - * in the Amazon Elastic Compute Cloud User Guide.

- */ - public modifyEbsDefaultKmsKeyId( + + /** + * @see {@link ModifyEbsDefaultKmsKeyIdCommand} + */ + modifyEbsDefaultKmsKeyId( args: ModifyEbsDefaultKmsKeyIdCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyEbsDefaultKmsKeyId( + modifyEbsDefaultKmsKeyId( args: ModifyEbsDefaultKmsKeyIdCommandInput, cb: (err: any, data?: ModifyEbsDefaultKmsKeyIdCommandOutput) => void ): void; - public modifyEbsDefaultKmsKeyId( + modifyEbsDefaultKmsKeyId( args: ModifyEbsDefaultKmsKeyIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyEbsDefaultKmsKeyIdCommandOutput) => void ): void; - public modifyEbsDefaultKmsKeyId( - args: ModifyEbsDefaultKmsKeyIdCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyEbsDefaultKmsKeyIdCommandOutput) => void), - cb?: (err: any, data?: ModifyEbsDefaultKmsKeyIdCommandOutput) => void - ): Promise | void { - const command = new ModifyEbsDefaultKmsKeyIdCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the specified EC2 Fleet.

- *

You can only modify an EC2 Fleet request of type maintain.

- *

While the EC2 Fleet is being modified, it is in the modifying state.

- *

To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional - * Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation - * strategy is lowest-price, the EC2 Fleet launches instances using the Spot Instance - * pool with the lowest price. If the allocation strategy is diversified, the - * EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy - * is capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with optimal - * capacity for the number of instances that are launching.

- *

To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open - * requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot - * Instances until the size of the fleet no longer exceeds the new target capacity. If the - * allocation strategy is lowest-price, the EC2 Fleet terminates the instances with - * the highest price per unit. If the allocation strategy is capacity-optimized, - * the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available - * Spot Instance capacity. If the allocation strategy is diversified, the EC2 Fleet terminates - * instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep - * the fleet at its current size, but not replace any Spot Instances that are interrupted or - * that you terminate manually.

- *

If you are finished with your EC2 Fleet for now, but will use it again later, you can set the - * target capacity to 0.

- */ - public modifyFleet(args: ModifyFleetCommandInput, options?: __HttpHandlerOptions): Promise; - public modifyFleet(args: ModifyFleetCommandInput, cb: (err: any, data?: ModifyFleetCommandOutput) => void): void; - public modifyFleet( + + /** + * @see {@link ModifyFleetCommand} + */ + modifyFleet(args: ModifyFleetCommandInput, options?: __HttpHandlerOptions): Promise; + modifyFleet(args: ModifyFleetCommandInput, cb: (err: any, data?: ModifyFleetCommandOutput) => void): void; + modifyFleet( args: ModifyFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyFleetCommandOutput) => void ): void; - public modifyFleet( - args: ModifyFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyFleetCommandOutput) => void), - cb?: (err: any, data?: ModifyFleetCommandOutput) => void - ): Promise | void { - const command = new ModifyFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the specified attribute of the specified Amazon FPGA Image (AFI).

- */ - public modifyFpgaImageAttribute( + + /** + * @see {@link ModifyFpgaImageAttributeCommand} + */ + modifyFpgaImageAttribute( args: ModifyFpgaImageAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyFpgaImageAttribute( + modifyFpgaImageAttribute( args: ModifyFpgaImageAttributeCommandInput, cb: (err: any, data?: ModifyFpgaImageAttributeCommandOutput) => void ): void; - public modifyFpgaImageAttribute( + modifyFpgaImageAttribute( args: ModifyFpgaImageAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyFpgaImageAttributeCommandOutput) => void ): void; - public modifyFpgaImageAttribute( - args: ModifyFpgaImageAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyFpgaImageAttributeCommandOutput) => void), - cb?: (err: any, data?: ModifyFpgaImageAttributeCommandOutput) => void - ): Promise | void { - const command = new ModifyFpgaImageAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, - * any instances that you launch with a tenancy of host but without a specific - * host ID are placed onto any available Dedicated Host in your account that has - * auto-placement enabled. When auto-placement is disabled, you need to provide a host ID - * to have the instance launch onto a specific host. If no host ID is provided, the - * instance is launched onto a suitable host with auto-placement enabled.

- *

You can also use this API action to modify a Dedicated Host to support either multiple - * instance types in an instance family, or to support a specific instance type - * only.

- */ - public modifyHosts(args: ModifyHostsCommandInput, options?: __HttpHandlerOptions): Promise; - public modifyHosts(args: ModifyHostsCommandInput, cb: (err: any, data?: ModifyHostsCommandOutput) => void): void; - public modifyHosts( + + /** + * @see {@link ModifyHostsCommand} + */ + modifyHosts(args: ModifyHostsCommandInput, options?: __HttpHandlerOptions): Promise; + modifyHosts(args: ModifyHostsCommandInput, cb: (err: any, data?: ModifyHostsCommandOutput) => void): void; + modifyHosts( args: ModifyHostsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyHostsCommandOutput) => void ): void; - public modifyHosts( - args: ModifyHostsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyHostsCommandOutput) => void), - cb?: (err: any, data?: ModifyHostsCommandOutput) => void - ): Promise | void { - const command = new ModifyHostsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the ID format of a resource for a specified IAM user, IAM role, or the root - * user for an account; or all IAM users, IAM roles, and the root user for an account. You can - * specify that resources should receive longer IDs (17-character IDs) when they are created.

- *

This request can only be used to modify longer ID settings for resource types that are - * within the opt-in period. Resources currently in their opt-in period include: - * bundle | conversion-task | customer-gateway | dhcp-options | - * elastic-ip-allocation | elastic-ip-association | - * export-task | flow-log | image | - * import-task | internet-gateway | network-acl - * | network-acl-association | network-interface | - * network-interface-attachment | prefix-list | - * route-table | route-table-association | - * security-group | subnet | - * subnet-cidr-block-association | vpc | - * vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

- *

For more information, see Resource IDs in the - * Amazon Elastic Compute Cloud User Guide.

- *

This setting applies to the principal specified in the request; it does not apply to the - * principal that makes the request.

- *

Resources created with longer IDs are visible to all IAM roles and users, regardless of these - * settings and provided that they have permission to use the relevant Describe - * command for the resource type.

- */ - public modifyIdentityIdFormat( + + /** + * @see {@link ModifyIdentityIdFormatCommand} + */ + modifyIdentityIdFormat( args: ModifyIdentityIdFormatCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyIdentityIdFormat( + modifyIdentityIdFormat( args: ModifyIdentityIdFormatCommandInput, cb: (err: any, data?: ModifyIdentityIdFormatCommandOutput) => void ): void; - public modifyIdentityIdFormat( + modifyIdentityIdFormat( args: ModifyIdentityIdFormatCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyIdentityIdFormatCommandOutput) => void ): void; - public modifyIdentityIdFormat( - args: ModifyIdentityIdFormatCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyIdentityIdFormatCommandOutput) => void), - cb?: (err: any, data?: ModifyIdentityIdFormatCommandOutput) => void - ): Promise | void { - const command = new ModifyIdentityIdFormatCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the ID format for the specified resource on a per-Region basis. You can - * specify that resources should receive longer IDs (17-character IDs) when they are - * created.

- *

This request can only be used to modify longer ID settings for resource types that - * are within the opt-in period. Resources currently in their opt-in period include: - * bundle | conversion-task | customer-gateway | dhcp-options | - * elastic-ip-allocation | elastic-ip-association | - * export-task | flow-log | image | - * import-task | internet-gateway | network-acl - * | network-acl-association | network-interface | - * network-interface-attachment | prefix-list | - * route-table | route-table-association | - * security-group | subnet | - * subnet-cidr-block-association | vpc | - * vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

- *

This setting applies to the IAM user who makes the request; it does not apply to the - * entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user. If - * you're using this action as the root user, then these settings apply to the entire account, - * unless an IAM user explicitly overrides these settings for themselves. For more information, - * see Resource IDs - * in the Amazon Elastic Compute Cloud User Guide.

- *

Resources created with longer IDs are visible to all IAM roles and users, regardless - * of these settings and provided that they have permission to use the relevant - * Describe command for the resource type.

- */ - public modifyIdFormat( + + /** + * @see {@link ModifyIdFormatCommand} + */ + modifyIdFormat( args: ModifyIdFormatCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyIdFormat( - args: ModifyIdFormatCommandInput, - cb: (err: any, data?: ModifyIdFormatCommandOutput) => void - ): void; - public modifyIdFormat( + modifyIdFormat(args: ModifyIdFormatCommandInput, cb: (err: any, data?: ModifyIdFormatCommandOutput) => void): void; + modifyIdFormat( args: ModifyIdFormatCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyIdFormatCommandOutput) => void ): void; - public modifyIdFormat( - args: ModifyIdFormatCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyIdFormatCommandOutput) => void), - cb?: (err: any, data?: ModifyIdFormatCommandOutput) => void - ): Promise | void { - const command = new ModifyIdFormatCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.

- *

To specify the attribute, you can use the Attribute parameter, or one of the following parameters: - * Description, ImdsSupport, or LaunchPermission.

- *

Images with an Amazon Web Services Marketplace product code cannot be made public.

- *

To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance - * and create an AMI from the instance.

- */ - public modifyImageAttribute( + + /** + * @see {@link ModifyImageAttributeCommand} + */ + modifyImageAttribute( args: ModifyImageAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyImageAttribute( + modifyImageAttribute( args: ModifyImageAttributeCommandInput, cb: (err: any, data?: ModifyImageAttributeCommandOutput) => void ): void; - public modifyImageAttribute( + modifyImageAttribute( args: ModifyImageAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyImageAttributeCommandOutput) => void ): void; - public modifyImageAttribute( - args: ModifyImageAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyImageAttributeCommandOutput) => void), - cb?: (err: any, data?: ModifyImageAttributeCommandOutput) => void - ): Promise | void { - const command = new ModifyImageAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the specified attribute of the specified instance. You can specify only one - * attribute at a time.

- *

- * Note: Using this action to change the security groups - * associated with an elastic network interface (ENI) attached to an instance in a VPC can - * result in an error if the instance has more than one ENI. To change the security groups - * associated with an ENI attached to an instance that has multiple ENIs, we recommend that - * you use the ModifyNetworkInterfaceAttribute action.

- *

To modify some attributes, the instance must be stopped. For more information, see - * Modify a stopped instance in the - * Amazon EC2 User Guide.

- */ - public modifyInstanceAttribute( + + /** + * @see {@link ModifyInstanceAttributeCommand} + */ + modifyInstanceAttribute( args: ModifyInstanceAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyInstanceAttribute( + modifyInstanceAttribute( args: ModifyInstanceAttributeCommandInput, cb: (err: any, data?: ModifyInstanceAttributeCommandOutput) => void ): void; - public modifyInstanceAttribute( + modifyInstanceAttribute( args: ModifyInstanceAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyInstanceAttributeCommandOutput) => void ): void; - public modifyInstanceAttribute( - args: ModifyInstanceAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyInstanceAttributeCommandOutput) => void), - cb?: (err: any, data?: ModifyInstanceAttributeCommandOutput) => void - ): Promise | void { - const command = new ModifyInstanceAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an - * instance to target a specific Capacity Reservation, run in any open Capacity Reservation with matching - * attributes, or run On-Demand Instance capacity.

- */ - public modifyInstanceCapacityReservationAttributes( + + /** + * @see {@link ModifyInstanceCapacityReservationAttributesCommand} + */ + modifyInstanceCapacityReservationAttributes( args: ModifyInstanceCapacityReservationAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyInstanceCapacityReservationAttributes( + modifyInstanceCapacityReservationAttributes( args: ModifyInstanceCapacityReservationAttributesCommandInput, cb: (err: any, data?: ModifyInstanceCapacityReservationAttributesCommandOutput) => void ): void; - public modifyInstanceCapacityReservationAttributes( + modifyInstanceCapacityReservationAttributes( args: ModifyInstanceCapacityReservationAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyInstanceCapacityReservationAttributesCommandOutput) => void ): void; - public modifyInstanceCapacityReservationAttributes( - args: ModifyInstanceCapacityReservationAttributesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ModifyInstanceCapacityReservationAttributesCommandOutput) => void), - cb?: (err: any, data?: ModifyInstanceCapacityReservationAttributesCommandOutput) => void - ): Promise | void { - const command = new ModifyInstanceCapacityReservationAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the credit option for CPU usage on a running or stopped burstable performance - * instance. The credit options are standard and - * unlimited.

- *

For more information, see Burstable - * performance instances in the Amazon EC2 User Guide.

- */ - public modifyInstanceCreditSpecification( + + /** + * @see {@link ModifyInstanceCreditSpecificationCommand} + */ + modifyInstanceCreditSpecification( args: ModifyInstanceCreditSpecificationCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyInstanceCreditSpecification( + modifyInstanceCreditSpecification( args: ModifyInstanceCreditSpecificationCommandInput, cb: (err: any, data?: ModifyInstanceCreditSpecificationCommandOutput) => void ): void; - public modifyInstanceCreditSpecification( + modifyInstanceCreditSpecification( args: ModifyInstanceCreditSpecificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyInstanceCreditSpecificationCommandOutput) => void ): void; - public modifyInstanceCreditSpecification( - args: ModifyInstanceCreditSpecificationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyInstanceCreditSpecificationCommandOutput) => void), - cb?: (err: any, data?: ModifyInstanceCreditSpecificationCommandOutput) => void - ): Promise | void { - const command = new ModifyInstanceCreditSpecificationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the start time for a scheduled Amazon EC2 instance event.

- */ - public modifyInstanceEventStartTime( + + /** + * @see {@link ModifyInstanceEventStartTimeCommand} + */ + modifyInstanceEventStartTime( args: ModifyInstanceEventStartTimeCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyInstanceEventStartTime( + modifyInstanceEventStartTime( args: ModifyInstanceEventStartTimeCommandInput, cb: (err: any, data?: ModifyInstanceEventStartTimeCommandOutput) => void ): void; - public modifyInstanceEventStartTime( + modifyInstanceEventStartTime( args: ModifyInstanceEventStartTimeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyInstanceEventStartTimeCommandOutput) => void ): void; - public modifyInstanceEventStartTime( - args: ModifyInstanceEventStartTimeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyInstanceEventStartTimeCommandOutput) => void), - cb?: (err: any, data?: ModifyInstanceEventStartTimeCommandOutput) => void - ): Promise | void { - const command = new ModifyInstanceEventStartTimeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the specified event window.

- *

You can define either a set of time ranges or a cron expression when modifying the event - * window, but not both.

- *

To modify the targets associated with the event window, use the AssociateInstanceEventWindow and DisassociateInstanceEventWindow API.

- *

If Amazon Web Services has already scheduled an event, modifying an event window won't change the time - * of the scheduled event.

- *

For more information, see Define event windows for scheduled - * events in the Amazon EC2 User Guide.

- */ - public modifyInstanceEventWindow( + + /** + * @see {@link ModifyInstanceEventWindowCommand} + */ + modifyInstanceEventWindow( args: ModifyInstanceEventWindowCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyInstanceEventWindow( + modifyInstanceEventWindow( args: ModifyInstanceEventWindowCommandInput, cb: (err: any, data?: ModifyInstanceEventWindowCommandOutput) => void ): void; - public modifyInstanceEventWindow( + modifyInstanceEventWindow( args: ModifyInstanceEventWindowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyInstanceEventWindowCommandOutput) => void ): void; - public modifyInstanceEventWindow( - args: ModifyInstanceEventWindowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyInstanceEventWindowCommandOutput) => void), - cb?: (err: any, data?: ModifyInstanceEventWindowCommandOutput) => void - ): Promise | void { - const command = new ModifyInstanceEventWindowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the recovery behavior of your instance to disable simplified automatic - * recovery or set the recovery behavior to default. The default configuration will not - * enable simplified automatic recovery for an unsupported instance type. For more - * information, see Simplified automatic recovery.

- */ - public modifyInstanceMaintenanceOptions( + + /** + * @see {@link ModifyInstanceMaintenanceOptionsCommand} + */ + modifyInstanceMaintenanceOptions( args: ModifyInstanceMaintenanceOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyInstanceMaintenanceOptions( + modifyInstanceMaintenanceOptions( args: ModifyInstanceMaintenanceOptionsCommandInput, cb: (err: any, data?: ModifyInstanceMaintenanceOptionsCommandOutput) => void ): void; - public modifyInstanceMaintenanceOptions( + modifyInstanceMaintenanceOptions( args: ModifyInstanceMaintenanceOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyInstanceMaintenanceOptionsCommandOutput) => void ): void; - public modifyInstanceMaintenanceOptions( - args: ModifyInstanceMaintenanceOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyInstanceMaintenanceOptionsCommandOutput) => void), - cb?: (err: any, data?: ModifyInstanceMaintenanceOptionsCommandOutput) => void - ): Promise | void { - const command = new ModifyInstanceMaintenanceOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modify the instance metadata parameters on a running or stopped instance. When you - * modify the parameters on a stopped instance, they are applied when the instance is - * started. When you modify the parameters on a running instance, the API responds with a - * state of “pending”. After the parameter modifications are successfully applied to the - * instance, the state of the modifications changes from “pending” to “applied” in - * subsequent describe-instances API calls. For more information, see Instance metadata and user data in the - * Amazon EC2 User Guide.

- */ - public modifyInstanceMetadataOptions( + + /** + * @see {@link ModifyInstanceMetadataOptionsCommand} + */ + modifyInstanceMetadataOptions( args: ModifyInstanceMetadataOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyInstanceMetadataOptions( + modifyInstanceMetadataOptions( args: ModifyInstanceMetadataOptionsCommandInput, cb: (err: any, data?: ModifyInstanceMetadataOptionsCommandOutput) => void ): void; - public modifyInstanceMetadataOptions( + modifyInstanceMetadataOptions( args: ModifyInstanceMetadataOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyInstanceMetadataOptionsCommandOutput) => void ): void; - public modifyInstanceMetadataOptions( - args: ModifyInstanceMetadataOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyInstanceMetadataOptionsCommandOutput) => void), - cb?: (err: any, data?: ModifyInstanceMetadataOptionsCommandOutput) => void - ): Promise | void { - const command = new ModifyInstanceMetadataOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the placement attributes for a specified instance. You can do the - * following:

- *
    - *
  • - *

    Modify the affinity between an instance and a Dedicated - * Host. When affinity is set to host and the instance is - * not associated with a specific Dedicated Host, the next time the instance is - * launched, it is automatically associated with the host on which it lands. If the - * instance is restarted or rebooted, this relationship persists.

    - *
  • - *
  • - *

    Change the Dedicated Host with which an instance is associated.

    - *
  • - *
  • - *

    Change the instance tenancy of an instance.

    - *
  • - *
  • - *

    Move an instance to or from a placement - * group.

    - *
  • - *
- *

At least one attribute for affinity, host ID, tenancy, or placement group name must be - * specified in the request. Affinity and tenancy can be modified in the same - * request.

- *

To modify the host ID, tenancy, placement group, or partition for an instance, the - * instance must be in the stopped state.

- */ - public modifyInstancePlacement( + + /** + * @see {@link ModifyInstancePlacementCommand} + */ + modifyInstancePlacement( args: ModifyInstancePlacementCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyInstancePlacement( + modifyInstancePlacement( args: ModifyInstancePlacementCommandInput, cb: (err: any, data?: ModifyInstancePlacementCommandOutput) => void ): void; - public modifyInstancePlacement( + modifyInstancePlacement( args: ModifyInstancePlacementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyInstancePlacementCommandOutput) => void ): void; - public modifyInstancePlacement( - args: ModifyInstancePlacementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyInstancePlacementCommandOutput) => void), - cb?: (err: any, data?: ModifyInstancePlacementCommandOutput) => void - ): Promise | void { - const command = new ModifyInstancePlacementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modify the configurations of an IPAM. - *

- */ - public modifyIpam(args: ModifyIpamCommandInput, options?: __HttpHandlerOptions): Promise; - public modifyIpam(args: ModifyIpamCommandInput, cb: (err: any, data?: ModifyIpamCommandOutput) => void): void; - public modifyIpam( + + /** + * @see {@link ModifyIpamCommand} + */ + modifyIpam(args: ModifyIpamCommandInput, options?: __HttpHandlerOptions): Promise; + modifyIpam(args: ModifyIpamCommandInput, cb: (err: any, data?: ModifyIpamCommandOutput) => void): void; + modifyIpam( args: ModifyIpamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyIpamCommandOutput) => void ): void; - public modifyIpam( - args: ModifyIpamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyIpamCommandOutput) => void), - cb?: (err: any, data?: ModifyIpamCommandOutput) => void - ): Promise | void { - const command = new ModifyIpamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modify the configurations of an IPAM pool.

- *

For more information, see Modify a pool in the Amazon VPC IPAM User Guide. - *

- */ - public modifyIpamPool( + + /** + * @see {@link ModifyIpamPoolCommand} + */ + modifyIpamPool( args: ModifyIpamPoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyIpamPool( - args: ModifyIpamPoolCommandInput, - cb: (err: any, data?: ModifyIpamPoolCommandOutput) => void - ): void; - public modifyIpamPool( + modifyIpamPool(args: ModifyIpamPoolCommandInput, cb: (err: any, data?: ModifyIpamPoolCommandOutput) => void): void; + modifyIpamPool( args: ModifyIpamPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyIpamPoolCommandOutput) => void ): void; - public modifyIpamPool( - args: ModifyIpamPoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyIpamPoolCommandOutput) => void), - cb?: (err: any, data?: ModifyIpamPoolCommandOutput) => void - ): Promise | void { - const command = new ModifyIpamPoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes and ignore resource CIDRs that you do not want to manage. If set to false, the resource will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be removed from any pool it has an allocation in.

- *

For more information, see Move resource CIDRs between scopes and Change the monitoring state of resource CIDRs in the Amazon VPC IPAM User Guide.

- */ - public modifyIpamResourceCidr( + + /** + * @see {@link ModifyIpamResourceCidrCommand} + */ + modifyIpamResourceCidr( args: ModifyIpamResourceCidrCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyIpamResourceCidr( + modifyIpamResourceCidr( args: ModifyIpamResourceCidrCommandInput, cb: (err: any, data?: ModifyIpamResourceCidrCommandOutput) => void ): void; - public modifyIpamResourceCidr( + modifyIpamResourceCidr( args: ModifyIpamResourceCidrCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyIpamResourceCidrCommandOutput) => void ): void; - public modifyIpamResourceCidr( - args: ModifyIpamResourceCidrCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyIpamResourceCidrCommandOutput) => void), - cb?: (err: any, data?: ModifyIpamResourceCidrCommandOutput) => void - ): Promise | void { - const command = new ModifyIpamResourceCidrCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies a resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

- */ - public modifyIpamResourceDiscovery( + + /** + * @see {@link ModifyIpamResourceDiscoveryCommand} + */ + modifyIpamResourceDiscovery( args: ModifyIpamResourceDiscoveryCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyIpamResourceDiscovery( + modifyIpamResourceDiscovery( args: ModifyIpamResourceDiscoveryCommandInput, cb: (err: any, data?: ModifyIpamResourceDiscoveryCommandOutput) => void ): void; - public modifyIpamResourceDiscovery( + modifyIpamResourceDiscovery( args: ModifyIpamResourceDiscoveryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyIpamResourceDiscoveryCommandOutput) => void ): void; - public modifyIpamResourceDiscovery( - args: ModifyIpamResourceDiscoveryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyIpamResourceDiscoveryCommandOutput) => void), - cb?: (err: any, data?: ModifyIpamResourceDiscoveryCommandOutput) => void - ): Promise | void { - const command = new ModifyIpamResourceDiscoveryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modify an IPAM scope.

- */ - public modifyIpamScope( + + /** + * @see {@link ModifyIpamScopeCommand} + */ + modifyIpamScope( args: ModifyIpamScopeCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyIpamScope( - args: ModifyIpamScopeCommandInput, - cb: (err: any, data?: ModifyIpamScopeCommandOutput) => void - ): void; - public modifyIpamScope( + modifyIpamScope(args: ModifyIpamScopeCommandInput, cb: (err: any, data?: ModifyIpamScopeCommandOutput) => void): void; + modifyIpamScope( args: ModifyIpamScopeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyIpamScopeCommandOutput) => void ): void; - public modifyIpamScope( - args: ModifyIpamScopeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyIpamScopeCommandOutput) => void), - cb?: (err: any, data?: ModifyIpamScopeCommandOutput) => void - ): Promise | void { - const command = new ModifyIpamScopeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies a launch template. You can specify which version of the launch template to - * set as the default version. When launching an instance, the default version applies when - * a launch template version is not specified.

- */ - public modifyLaunchTemplate( + + /** + * @see {@link ModifyLaunchTemplateCommand} + */ + modifyLaunchTemplate( args: ModifyLaunchTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyLaunchTemplate( + modifyLaunchTemplate( args: ModifyLaunchTemplateCommandInput, cb: (err: any, data?: ModifyLaunchTemplateCommandOutput) => void ): void; - public modifyLaunchTemplate( + modifyLaunchTemplate( args: ModifyLaunchTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyLaunchTemplateCommandOutput) => void ): void; - public modifyLaunchTemplate( - args: ModifyLaunchTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyLaunchTemplateCommandOutput) => void), - cb?: (err: any, data?: ModifyLaunchTemplateCommandOutput) => void - ): Promise | void { - const command = new ModifyLaunchTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the specified local gateway route.

- */ - public modifyLocalGatewayRoute( + + /** + * @see {@link ModifyLocalGatewayRouteCommand} + */ + modifyLocalGatewayRoute( args: ModifyLocalGatewayRouteCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyLocalGatewayRoute( + modifyLocalGatewayRoute( args: ModifyLocalGatewayRouteCommandInput, cb: (err: any, data?: ModifyLocalGatewayRouteCommandOutput) => void ): void; - public modifyLocalGatewayRoute( + modifyLocalGatewayRoute( args: ModifyLocalGatewayRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyLocalGatewayRouteCommandOutput) => void ): void; - public modifyLocalGatewayRoute( - args: ModifyLocalGatewayRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyLocalGatewayRouteCommandOutput) => void), - cb?: (err: any, data?: ModifyLocalGatewayRouteCommandOutput) => void - ): Promise | void { - const command = new ModifyLocalGatewayRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the specified managed prefix list.

- *

Adding or removing entries in a prefix list creates a new version of the prefix list. - * Changing the name of the prefix list does not affect the version.

- *

If you specify a current version number that does not match the true current version - * number, the request fails.

- */ - public modifyManagedPrefixList( + + /** + * @see {@link ModifyManagedPrefixListCommand} + */ + modifyManagedPrefixList( args: ModifyManagedPrefixListCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyManagedPrefixList( + modifyManagedPrefixList( args: ModifyManagedPrefixListCommandInput, cb: (err: any, data?: ModifyManagedPrefixListCommandOutput) => void ): void; - public modifyManagedPrefixList( + modifyManagedPrefixList( args: ModifyManagedPrefixListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyManagedPrefixListCommandOutput) => void ): void; - public modifyManagedPrefixList( - args: ModifyManagedPrefixListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyManagedPrefixListCommandOutput) => void), - cb?: (err: any, data?: ModifyManagedPrefixListCommandOutput) => void - ): Promise | void { - const command = new ModifyManagedPrefixListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the specified network interface attribute. You can specify only one - * attribute at a time. You can use this action to attach and detach security groups from - * an existing EC2 instance.

- */ - public modifyNetworkInterfaceAttribute( + + /** + * @see {@link ModifyNetworkInterfaceAttributeCommand} + */ + modifyNetworkInterfaceAttribute( args: ModifyNetworkInterfaceAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyNetworkInterfaceAttribute( + modifyNetworkInterfaceAttribute( args: ModifyNetworkInterfaceAttributeCommandInput, cb: (err: any, data?: ModifyNetworkInterfaceAttributeCommandOutput) => void ): void; - public modifyNetworkInterfaceAttribute( + modifyNetworkInterfaceAttribute( args: ModifyNetworkInterfaceAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyNetworkInterfaceAttributeCommandOutput) => void ): void; - public modifyNetworkInterfaceAttribute( - args: ModifyNetworkInterfaceAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyNetworkInterfaceAttributeCommandOutput) => void), - cb?: (err: any, data?: ModifyNetworkInterfaceAttributeCommandOutput) => void - ): Promise | void { - const command = new ModifyNetworkInterfaceAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the options for instance hostnames for the specified instance.

- */ - public modifyPrivateDnsNameOptions( + + /** + * @see {@link ModifyPrivateDnsNameOptionsCommand} + */ + modifyPrivateDnsNameOptions( args: ModifyPrivateDnsNameOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyPrivateDnsNameOptions( + modifyPrivateDnsNameOptions( args: ModifyPrivateDnsNameOptionsCommandInput, cb: (err: any, data?: ModifyPrivateDnsNameOptionsCommandOutput) => void ): void; - public modifyPrivateDnsNameOptions( + modifyPrivateDnsNameOptions( args: ModifyPrivateDnsNameOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyPrivateDnsNameOptionsCommandOutput) => void ): void; - public modifyPrivateDnsNameOptions( - args: ModifyPrivateDnsNameOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyPrivateDnsNameOptionsCommandOutput) => void), - cb?: (err: any, data?: ModifyPrivateDnsNameOptionsCommandOutput) => void - ): Promise | void { - const command = new ModifyPrivateDnsNameOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the configuration of your Reserved Instances, such as the Availability Zone, - * instance count, or instance type. The Reserved Instances to be modified must be identical, - * except for Availability Zone, network platform, and instance type.

- *

For more information, see Modifying Reserved - * Instances in the Amazon EC2 User Guide.

- * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- */ - public modifyReservedInstances( + + /** + * @see {@link ModifyReservedInstancesCommand} + */ + modifyReservedInstances( args: ModifyReservedInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyReservedInstances( + modifyReservedInstances( args: ModifyReservedInstancesCommandInput, cb: (err: any, data?: ModifyReservedInstancesCommandOutput) => void ): void; - public modifyReservedInstances( + modifyReservedInstances( args: ModifyReservedInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyReservedInstancesCommandOutput) => void ): void; - public modifyReservedInstances( - args: ModifyReservedInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyReservedInstancesCommandOutput) => void), - cb?: (err: any, data?: ModifyReservedInstancesCommandOutput) => void - ): Promise | void { - const command = new ModifyReservedInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the rules of a security group.

- */ - public modifySecurityGroupRules( + + /** + * @see {@link ModifySecurityGroupRulesCommand} + */ + modifySecurityGroupRules( args: ModifySecurityGroupRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifySecurityGroupRules( + modifySecurityGroupRules( args: ModifySecurityGroupRulesCommandInput, cb: (err: any, data?: ModifySecurityGroupRulesCommandOutput) => void ): void; - public modifySecurityGroupRules( + modifySecurityGroupRules( args: ModifySecurityGroupRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifySecurityGroupRulesCommandOutput) => void ): void; - public modifySecurityGroupRules( - args: ModifySecurityGroupRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifySecurityGroupRulesCommandOutput) => void), - cb?: (err: any, data?: ModifySecurityGroupRulesCommandOutput) => void - ): Promise | void { - const command = new ModifySecurityGroupRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds or removes permission settings for the specified snapshot. You may add or remove - * specified Amazon Web Services account IDs from a snapshot's list of create volume permissions, but you cannot - * do both in a single operation. If you need to both add and remove account IDs for a snapshot, - * you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.

- *

Encrypted snapshots and snapshots with Amazon Web Services Marketplace product codes cannot be made - * public. Snapshots encrypted with your default KMS key cannot be shared with other accounts.

- *

For more information about modifying snapshot permissions, see Share a snapshot in the - * Amazon Elastic Compute Cloud User Guide.

- */ - public modifySnapshotAttribute( + + /** + * @see {@link ModifySnapshotAttributeCommand} + */ + modifySnapshotAttribute( args: ModifySnapshotAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifySnapshotAttribute( + modifySnapshotAttribute( args: ModifySnapshotAttributeCommandInput, cb: (err: any, data?: ModifySnapshotAttributeCommandOutput) => void ): void; - public modifySnapshotAttribute( + modifySnapshotAttribute( args: ModifySnapshotAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifySnapshotAttributeCommandOutput) => void ): void; - public modifySnapshotAttribute( - args: ModifySnapshotAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifySnapshotAttributeCommandOutput) => void), - cb?: (err: any, data?: ModifySnapshotAttributeCommandOutput) => void - ): Promise | void { - const command = new ModifySnapshotAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to a full - * snapshot that includes all of the blocks of data that were written to the volume at the - * time the snapshot was created, and moved from the standard tier to the archive - * tier. For more information, see Archive Amazon EBS snapshots - * in the Amazon Elastic Compute Cloud User Guide.

- */ - public modifySnapshotTier( + + /** + * @see {@link ModifySnapshotTierCommand} + */ + modifySnapshotTier( args: ModifySnapshotTierCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifySnapshotTier( + modifySnapshotTier( args: ModifySnapshotTierCommandInput, cb: (err: any, data?: ModifySnapshotTierCommandOutput) => void ): void; - public modifySnapshotTier( + modifySnapshotTier( args: ModifySnapshotTierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifySnapshotTierCommandOutput) => void ): void; - public modifySnapshotTier( - args: ModifySnapshotTierCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifySnapshotTierCommandOutput) => void), - cb?: (err: any, data?: ModifySnapshotTierCommandOutput) => void - ): Promise | void { - const command = new ModifySnapshotTierCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the specified Spot Fleet request.

- *

You can only modify a Spot Fleet request of type maintain.

- *

While the Spot Fleet request is being modified, it is in the modifying - * state.

- *

To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the - * additional Spot Instances according to the allocation strategy for the Spot Fleet - * request. If the allocation strategy is lowestPrice, the Spot Fleet launches - * instances using the Spot Instance pool with the lowest price. If the allocation strategy - * is diversified, the Spot Fleet distributes the instances across the Spot - * Instance pools. If the allocation strategy is capacityOptimized, Spot Fleet - * launches instances from Spot Instance pools with optimal capacity for the number of instances - * that are launching.

- *

To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet - * cancels any open requests that exceed the new target capacity. You can request that the - * Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the - * new target capacity. If the allocation strategy is lowestPrice, the Spot - * Fleet terminates the instances with the highest price per unit. If the allocation - * strategy is capacityOptimized, the Spot Fleet terminates the instances in - * the Spot Instance pools that have the least available Spot Instance capacity. If the allocation - * strategy is diversified, the Spot Fleet terminates instances across the - * Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet - * at its current size, but not replace any Spot Instances that are interrupted or that you - * terminate manually.

- *

If you are finished with your Spot Fleet for now, but will use it again later, you can - * set the target capacity to 0.

- */ - public modifySpotFleetRequest( + + /** + * @see {@link ModifySpotFleetRequestCommand} + */ + modifySpotFleetRequest( args: ModifySpotFleetRequestCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifySpotFleetRequest( + modifySpotFleetRequest( args: ModifySpotFleetRequestCommandInput, cb: (err: any, data?: ModifySpotFleetRequestCommandOutput) => void ): void; - public modifySpotFleetRequest( + modifySpotFleetRequest( args: ModifySpotFleetRequestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifySpotFleetRequestCommandOutput) => void ): void; - public modifySpotFleetRequest( - args: ModifySpotFleetRequestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifySpotFleetRequestCommandOutput) => void), - cb?: (err: any, data?: ModifySpotFleetRequestCommandOutput) => void - ): Promise | void { - const command = new ModifySpotFleetRequestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies a subnet attribute. You can only modify one attribute at a time.

- *

Use this action to modify subnets on Amazon Web Services Outposts.

- *
    - *
  • - *

    To modify a subnet on an Outpost rack, set both - * MapCustomerOwnedIpOnLaunch and - * CustomerOwnedIpv4Pool. These two parameters act as a single - * attribute.

    - *
  • - *
  • - *

    To modify a subnet on an Outpost server, set either - * EnableLniAtDeviceIndex or - * DisableLniAtDeviceIndex.

    - *
  • - *
- *

For more information about Amazon Web Services Outposts, see the following:

- * - */ - public modifySubnetAttribute( + + /** + * @see {@link ModifySubnetAttributeCommand} + */ + modifySubnetAttribute( args: ModifySubnetAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifySubnetAttribute( + modifySubnetAttribute( args: ModifySubnetAttributeCommandInput, cb: (err: any, data?: ModifySubnetAttributeCommandOutput) => void ): void; - public modifySubnetAttribute( + modifySubnetAttribute( args: ModifySubnetAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifySubnetAttributeCommandOutput) => void ): void; - public modifySubnetAttribute( - args: ModifySubnetAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifySubnetAttributeCommandOutput) => void), - cb?: (err: any, data?: ModifySubnetAttributeCommandOutput) => void - ): Promise | void { - const command = new ModifySubnetAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Allows or restricts mirroring network services.

- *

By default, Amazon DNS network services are not eligible for Traffic Mirror. Use AddNetworkServices to add network services to a Traffic Mirror filter. When a network service is added to the Traffic Mirror filter, all traffic related to that network service will be mirrored. - * When you no longer want to mirror network services, use RemoveNetworkServices to remove the network services from the Traffic Mirror filter. - *

- */ - public modifyTrafficMirrorFilterNetworkServices( + + /** + * @see {@link ModifyTrafficMirrorFilterNetworkServicesCommand} + */ + modifyTrafficMirrorFilterNetworkServices( args: ModifyTrafficMirrorFilterNetworkServicesCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyTrafficMirrorFilterNetworkServices( + modifyTrafficMirrorFilterNetworkServices( args: ModifyTrafficMirrorFilterNetworkServicesCommandInput, cb: (err: any, data?: ModifyTrafficMirrorFilterNetworkServicesCommandOutput) => void ): void; - public modifyTrafficMirrorFilterNetworkServices( + modifyTrafficMirrorFilterNetworkServices( args: ModifyTrafficMirrorFilterNetworkServicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyTrafficMirrorFilterNetworkServicesCommandOutput) => void ): void; - public modifyTrafficMirrorFilterNetworkServices( - args: ModifyTrafficMirrorFilterNetworkServicesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ModifyTrafficMirrorFilterNetworkServicesCommandOutput) => void), - cb?: (err: any, data?: ModifyTrafficMirrorFilterNetworkServicesCommandOutput) => void - ): Promise | void { - const command = new ModifyTrafficMirrorFilterNetworkServicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the specified Traffic Mirror rule.

- *

- * DestinationCidrBlock and SourceCidrBlock must both be an IPv4 - * range or an IPv6 range.

- */ - public modifyTrafficMirrorFilterRule( + + /** + * @see {@link ModifyTrafficMirrorFilterRuleCommand} + */ + modifyTrafficMirrorFilterRule( args: ModifyTrafficMirrorFilterRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyTrafficMirrorFilterRule( + modifyTrafficMirrorFilterRule( args: ModifyTrafficMirrorFilterRuleCommandInput, cb: (err: any, data?: ModifyTrafficMirrorFilterRuleCommandOutput) => void ): void; - public modifyTrafficMirrorFilterRule( + modifyTrafficMirrorFilterRule( args: ModifyTrafficMirrorFilterRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyTrafficMirrorFilterRuleCommandOutput) => void ): void; - public modifyTrafficMirrorFilterRule( - args: ModifyTrafficMirrorFilterRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyTrafficMirrorFilterRuleCommandOutput) => void), - cb?: (err: any, data?: ModifyTrafficMirrorFilterRuleCommandOutput) => void - ): Promise | void { - const command = new ModifyTrafficMirrorFilterRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies a Traffic Mirror session.

- */ - public modifyTrafficMirrorSession( + + /** + * @see {@link ModifyTrafficMirrorSessionCommand} + */ + modifyTrafficMirrorSession( args: ModifyTrafficMirrorSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyTrafficMirrorSession( + modifyTrafficMirrorSession( args: ModifyTrafficMirrorSessionCommandInput, cb: (err: any, data?: ModifyTrafficMirrorSessionCommandOutput) => void ): void; - public modifyTrafficMirrorSession( + modifyTrafficMirrorSession( args: ModifyTrafficMirrorSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyTrafficMirrorSessionCommandOutput) => void ): void; - public modifyTrafficMirrorSession( - args: ModifyTrafficMirrorSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyTrafficMirrorSessionCommandOutput) => void), - cb?: (err: any, data?: ModifyTrafficMirrorSessionCommandOutput) => void - ): Promise | void { - const command = new ModifyTrafficMirrorSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the specified transit gateway. When you modify a transit gateway, the modified options are applied to new transit gateway attachments only. Your existing transit gateway attachments are not modified.

- */ - public modifyTransitGateway( + + /** + * @see {@link ModifyTransitGatewayCommand} + */ + modifyTransitGateway( args: ModifyTransitGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyTransitGateway( + modifyTransitGateway( args: ModifyTransitGatewayCommandInput, cb: (err: any, data?: ModifyTransitGatewayCommandOutput) => void ): void; - public modifyTransitGateway( + modifyTransitGateway( args: ModifyTransitGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyTransitGatewayCommandOutput) => void ): void; - public modifyTransitGateway( - args: ModifyTransitGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyTransitGatewayCommandOutput) => void), - cb?: (err: any, data?: ModifyTransitGatewayCommandOutput) => void - ): Promise | void { - const command = new ModifyTransitGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies a reference (route) to a prefix list in a specified transit gateway route table.

- */ - public modifyTransitGatewayPrefixListReference( + + /** + * @see {@link ModifyTransitGatewayPrefixListReferenceCommand} + */ + modifyTransitGatewayPrefixListReference( args: ModifyTransitGatewayPrefixListReferenceCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyTransitGatewayPrefixListReference( + modifyTransitGatewayPrefixListReference( args: ModifyTransitGatewayPrefixListReferenceCommandInput, cb: (err: any, data?: ModifyTransitGatewayPrefixListReferenceCommandOutput) => void ): void; - public modifyTransitGatewayPrefixListReference( + modifyTransitGatewayPrefixListReference( args: ModifyTransitGatewayPrefixListReferenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyTransitGatewayPrefixListReferenceCommandOutput) => void ): void; - public modifyTransitGatewayPrefixListReference( - args: ModifyTransitGatewayPrefixListReferenceCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ModifyTransitGatewayPrefixListReferenceCommandOutput) => void), - cb?: (err: any, data?: ModifyTransitGatewayPrefixListReferenceCommandOutput) => void - ): Promise | void { - const command = new ModifyTransitGatewayPrefixListReferenceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the specified VPC attachment.

- */ - public modifyTransitGatewayVpcAttachment( + + /** + * @see {@link ModifyTransitGatewayVpcAttachmentCommand} + */ + modifyTransitGatewayVpcAttachment( args: ModifyTransitGatewayVpcAttachmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyTransitGatewayVpcAttachment( + modifyTransitGatewayVpcAttachment( args: ModifyTransitGatewayVpcAttachmentCommandInput, cb: (err: any, data?: ModifyTransitGatewayVpcAttachmentCommandOutput) => void ): void; - public modifyTransitGatewayVpcAttachment( + modifyTransitGatewayVpcAttachment( args: ModifyTransitGatewayVpcAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyTransitGatewayVpcAttachmentCommandOutput) => void ): void; - public modifyTransitGatewayVpcAttachment( - args: ModifyTransitGatewayVpcAttachmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyTransitGatewayVpcAttachmentCommandOutput) => void), - cb?: (err: any, data?: ModifyTransitGatewayVpcAttachmentCommandOutput) => void - ): Promise | void { - const command = new ModifyTransitGatewayVpcAttachmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the configuration of an Amazon Web Services Verified Access endpoint.

- */ - public modifyVerifiedAccessEndpoint( + + /** + * @see {@link ModifyVerifiedAccessEndpointCommand} + */ + modifyVerifiedAccessEndpoint( args: ModifyVerifiedAccessEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyVerifiedAccessEndpoint( + modifyVerifiedAccessEndpoint( args: ModifyVerifiedAccessEndpointCommandInput, cb: (err: any, data?: ModifyVerifiedAccessEndpointCommandOutput) => void ): void; - public modifyVerifiedAccessEndpoint( + modifyVerifiedAccessEndpoint( args: ModifyVerifiedAccessEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyVerifiedAccessEndpointCommandOutput) => void ): void; - public modifyVerifiedAccessEndpoint( - args: ModifyVerifiedAccessEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyVerifiedAccessEndpointCommandOutput) => void), - cb?: (err: any, data?: ModifyVerifiedAccessEndpointCommandOutput) => void - ): Promise | void { - const command = new ModifyVerifiedAccessEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the specified Verified Access endpoint policy.

- */ - public modifyVerifiedAccessEndpointPolicy( + + /** + * @see {@link ModifyVerifiedAccessEndpointPolicyCommand} + */ + modifyVerifiedAccessEndpointPolicy( args: ModifyVerifiedAccessEndpointPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyVerifiedAccessEndpointPolicy( + modifyVerifiedAccessEndpointPolicy( args: ModifyVerifiedAccessEndpointPolicyCommandInput, cb: (err: any, data?: ModifyVerifiedAccessEndpointPolicyCommandOutput) => void ): void; - public modifyVerifiedAccessEndpointPolicy( + modifyVerifiedAccessEndpointPolicy( args: ModifyVerifiedAccessEndpointPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyVerifiedAccessEndpointPolicyCommandOutput) => void ): void; - public modifyVerifiedAccessEndpointPolicy( - args: ModifyVerifiedAccessEndpointPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyVerifiedAccessEndpointPolicyCommandOutput) => void), - cb?: (err: any, data?: ModifyVerifiedAccessEndpointPolicyCommandOutput) => void - ): Promise | void { - const command = new ModifyVerifiedAccessEndpointPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the specified Verified Access group configuration.

- */ - public modifyVerifiedAccessGroup( + + /** + * @see {@link ModifyVerifiedAccessGroupCommand} + */ + modifyVerifiedAccessGroup( args: ModifyVerifiedAccessGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyVerifiedAccessGroup( + modifyVerifiedAccessGroup( args: ModifyVerifiedAccessGroupCommandInput, cb: (err: any, data?: ModifyVerifiedAccessGroupCommandOutput) => void ): void; - public modifyVerifiedAccessGroup( + modifyVerifiedAccessGroup( args: ModifyVerifiedAccessGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyVerifiedAccessGroupCommandOutput) => void ): void; - public modifyVerifiedAccessGroup( - args: ModifyVerifiedAccessGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyVerifiedAccessGroupCommandOutput) => void), - cb?: (err: any, data?: ModifyVerifiedAccessGroupCommandOutput) => void - ): Promise | void { - const command = new ModifyVerifiedAccessGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the specified Verified Access group policy.

- */ - public modifyVerifiedAccessGroupPolicy( + + /** + * @see {@link ModifyVerifiedAccessGroupPolicyCommand} + */ + modifyVerifiedAccessGroupPolicy( args: ModifyVerifiedAccessGroupPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyVerifiedAccessGroupPolicy( + modifyVerifiedAccessGroupPolicy( args: ModifyVerifiedAccessGroupPolicyCommandInput, cb: (err: any, data?: ModifyVerifiedAccessGroupPolicyCommandOutput) => void ): void; - public modifyVerifiedAccessGroupPolicy( + modifyVerifiedAccessGroupPolicy( args: ModifyVerifiedAccessGroupPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyVerifiedAccessGroupPolicyCommandOutput) => void ): void; - public modifyVerifiedAccessGroupPolicy( - args: ModifyVerifiedAccessGroupPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyVerifiedAccessGroupPolicyCommandOutput) => void), - cb?: (err: any, data?: ModifyVerifiedAccessGroupPolicyCommandOutput) => void - ): Promise | void { - const command = new ModifyVerifiedAccessGroupPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the configuration of the specified Verified Access instance.

- */ - public modifyVerifiedAccessInstance( + + /** + * @see {@link ModifyVerifiedAccessInstanceCommand} + */ + modifyVerifiedAccessInstance( args: ModifyVerifiedAccessInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyVerifiedAccessInstance( + modifyVerifiedAccessInstance( args: ModifyVerifiedAccessInstanceCommandInput, cb: (err: any, data?: ModifyVerifiedAccessInstanceCommandOutput) => void ): void; - public modifyVerifiedAccessInstance( + modifyVerifiedAccessInstance( args: ModifyVerifiedAccessInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyVerifiedAccessInstanceCommandOutput) => void ): void; - public modifyVerifiedAccessInstance( - args: ModifyVerifiedAccessInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyVerifiedAccessInstanceCommandOutput) => void), - cb?: (err: any, data?: ModifyVerifiedAccessInstanceCommandOutput) => void - ): Promise | void { - const command = new ModifyVerifiedAccessInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the logging configuration for the specified Amazon Web Services Verified Access instance.

- */ - public modifyVerifiedAccessInstanceLoggingConfiguration( + + /** + * @see {@link ModifyVerifiedAccessInstanceLoggingConfigurationCommand} + */ + modifyVerifiedAccessInstanceLoggingConfiguration( args: ModifyVerifiedAccessInstanceLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyVerifiedAccessInstanceLoggingConfiguration( + modifyVerifiedAccessInstanceLoggingConfiguration( args: ModifyVerifiedAccessInstanceLoggingConfigurationCommandInput, cb: (err: any, data?: ModifyVerifiedAccessInstanceLoggingConfigurationCommandOutput) => void ): void; - public modifyVerifiedAccessInstanceLoggingConfiguration( + modifyVerifiedAccessInstanceLoggingConfiguration( args: ModifyVerifiedAccessInstanceLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyVerifiedAccessInstanceLoggingConfigurationCommandOutput) => void ): void; - public modifyVerifiedAccessInstanceLoggingConfiguration( - args: ModifyVerifiedAccessInstanceLoggingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ModifyVerifiedAccessInstanceLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: ModifyVerifiedAccessInstanceLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new ModifyVerifiedAccessInstanceLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the configuration of the specified Amazon Web Services Verified Access trust provider.

- */ - public modifyVerifiedAccessTrustProvider( + + /** + * @see {@link ModifyVerifiedAccessTrustProviderCommand} + */ + modifyVerifiedAccessTrustProvider( args: ModifyVerifiedAccessTrustProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyVerifiedAccessTrustProvider( + modifyVerifiedAccessTrustProvider( args: ModifyVerifiedAccessTrustProviderCommandInput, cb: (err: any, data?: ModifyVerifiedAccessTrustProviderCommandOutput) => void ): void; - public modifyVerifiedAccessTrustProvider( + modifyVerifiedAccessTrustProvider( args: ModifyVerifiedAccessTrustProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyVerifiedAccessTrustProviderCommandOutput) => void ): void; - public modifyVerifiedAccessTrustProvider( - args: ModifyVerifiedAccessTrustProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyVerifiedAccessTrustProviderCommandOutput) => void), - cb?: (err: any, data?: ModifyVerifiedAccessTrustProviderCommandOutput) => void - ): Promise | void { - const command = new ModifyVerifiedAccessTrustProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

You can modify several parameters of an existing EBS volume, including volume size, volume - * type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance - * type, you might be able to apply these changes without stopping the instance or detaching the - * volume from it. For more information about modifying EBS volumes, see Amazon EBS Elastic Volumes (Linux instances) - * or Amazon EBS Elastic Volumes (Windows instances).

- *

When you complete a resize operation on your volume, you need to extend the volume's - * file-system size to take advantage of the new storage capacity. For more information, see Extend a Linux file system or - * Extend a Windows file system.

- *

You can use CloudWatch Events to check the status of a modification to an EBS volume. For - * information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a - * modification using DescribeVolumesModifications. For information - * about tracking status changes using either method, see Monitor the progress of volume modifications.

- *

With previous-generation instance types, resizing an EBS volume might require detaching and - * reattaching the volume or stopping and restarting the instance.

- *

After modifying a volume, you must wait at least six hours and ensure that the volume - * is in the in-use or available state before you can modify the same - * volume. This is sometimes referred to as a cooldown period.

- */ - public modifyVolume( - args: ModifyVolumeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public modifyVolume(args: ModifyVolumeCommandInput, cb: (err: any, data?: ModifyVolumeCommandOutput) => void): void; - public modifyVolume( + + /** + * @see {@link ModifyVolumeCommand} + */ + modifyVolume(args: ModifyVolumeCommandInput, options?: __HttpHandlerOptions): Promise; + modifyVolume(args: ModifyVolumeCommandInput, cb: (err: any, data?: ModifyVolumeCommandOutput) => void): void; + modifyVolume( args: ModifyVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyVolumeCommandOutput) => void ): void; - public modifyVolume( - args: ModifyVolumeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyVolumeCommandOutput) => void), - cb?: (err: any, data?: ModifyVolumeCommandOutput) => void - ): Promise | void { - const command = new ModifyVolumeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies a volume attribute.

- *

By default, all I/O operations for the volume are suspended when the data on the volume is - * determined to be potentially inconsistent, to prevent undetectable, latent data corruption. - * The I/O access to the volume can be resumed by first enabling I/O access and then checking the - * data consistency on your volume.

- *

You can change the default behavior to resume I/O operations. We recommend that you change - * this only for boot volumes or for volumes that are stateless or disposable.

- */ - public modifyVolumeAttribute( + + /** + * @see {@link ModifyVolumeAttributeCommand} + */ + modifyVolumeAttribute( args: ModifyVolumeAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyVolumeAttribute( + modifyVolumeAttribute( args: ModifyVolumeAttributeCommandInput, cb: (err: any, data?: ModifyVolumeAttributeCommandOutput) => void ): void; - public modifyVolumeAttribute( + modifyVolumeAttribute( args: ModifyVolumeAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyVolumeAttributeCommandOutput) => void ): void; - public modifyVolumeAttribute( - args: ModifyVolumeAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyVolumeAttributeCommandOutput) => void), - cb?: (err: any, data?: ModifyVolumeAttributeCommandOutput) => void - ): Promise | void { - const command = new ModifyVolumeAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the specified attribute of the specified VPC.

- */ - public modifyVpcAttribute( + + /** + * @see {@link ModifyVpcAttributeCommand} + */ + modifyVpcAttribute( args: ModifyVpcAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyVpcAttribute( + modifyVpcAttribute( args: ModifyVpcAttributeCommandInput, cb: (err: any, data?: ModifyVpcAttributeCommandOutput) => void ): void; - public modifyVpcAttribute( + modifyVpcAttribute( args: ModifyVpcAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyVpcAttributeCommandOutput) => void ): void; - public modifyVpcAttribute( - args: ModifyVpcAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyVpcAttributeCommandOutput) => void), - cb?: (err: any, data?: ModifyVpcAttributeCommandOutput) => void - ): Promise | void { - const command = new ModifyVpcAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies attributes of a specified VPC endpoint. The attributes that you can modify - * depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, - * see the Amazon Web Services PrivateLink - * Guide.

- */ - public modifyVpcEndpoint( + + /** + * @see {@link ModifyVpcEndpointCommand} + */ + modifyVpcEndpoint( args: ModifyVpcEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyVpcEndpoint( + modifyVpcEndpoint( args: ModifyVpcEndpointCommandInput, cb: (err: any, data?: ModifyVpcEndpointCommandOutput) => void ): void; - public modifyVpcEndpoint( + modifyVpcEndpoint( args: ModifyVpcEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyVpcEndpointCommandOutput) => void ): void; - public modifyVpcEndpoint( - args: ModifyVpcEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyVpcEndpointCommandOutput) => void), - cb?: (err: any, data?: ModifyVpcEndpointCommandOutput) => void - ): Promise | void { - const command = new ModifyVpcEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies a connection notification for VPC endpoint or VPC endpoint service. You - * can change the SNS topic for the notification, or the events for which to be notified.

- */ - public modifyVpcEndpointConnectionNotification( + + /** + * @see {@link ModifyVpcEndpointConnectionNotificationCommand} + */ + modifyVpcEndpointConnectionNotification( args: ModifyVpcEndpointConnectionNotificationCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyVpcEndpointConnectionNotification( + modifyVpcEndpointConnectionNotification( args: ModifyVpcEndpointConnectionNotificationCommandInput, cb: (err: any, data?: ModifyVpcEndpointConnectionNotificationCommandOutput) => void ): void; - public modifyVpcEndpointConnectionNotification( + modifyVpcEndpointConnectionNotification( args: ModifyVpcEndpointConnectionNotificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyVpcEndpointConnectionNotificationCommandOutput) => void ): void; - public modifyVpcEndpointConnectionNotification( - args: ModifyVpcEndpointConnectionNotificationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ModifyVpcEndpointConnectionNotificationCommandOutput) => void), - cb?: (err: any, data?: ModifyVpcEndpointConnectionNotificationCommandOutput) => void - ): Promise | void { - const command = new ModifyVpcEndpointConnectionNotificationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the attributes of your VPC endpoint service configuration. You can change the - * Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is - * required for requests to connect to your endpoint service through an interface VPC - * endpoint.

- *

If you set or modify the private DNS name, you must prove that you own the private DNS - * domain name.

- */ - public modifyVpcEndpointServiceConfiguration( + + /** + * @see {@link ModifyVpcEndpointServiceConfigurationCommand} + */ + modifyVpcEndpointServiceConfiguration( args: ModifyVpcEndpointServiceConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyVpcEndpointServiceConfiguration( + modifyVpcEndpointServiceConfiguration( args: ModifyVpcEndpointServiceConfigurationCommandInput, cb: (err: any, data?: ModifyVpcEndpointServiceConfigurationCommandOutput) => void ): void; - public modifyVpcEndpointServiceConfiguration( + modifyVpcEndpointServiceConfiguration( args: ModifyVpcEndpointServiceConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyVpcEndpointServiceConfigurationCommandOutput) => void ): void; - public modifyVpcEndpointServiceConfiguration( - args: ModifyVpcEndpointServiceConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ModifyVpcEndpointServiceConfigurationCommandOutput) => void), - cb?: (err: any, data?: ModifyVpcEndpointServiceConfigurationCommandOutput) => void - ): Promise | void { - const command = new ModifyVpcEndpointServiceConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the payer responsibility for your VPC endpoint service.

- */ - public modifyVpcEndpointServicePayerResponsibility( + + /** + * @see {@link ModifyVpcEndpointServicePayerResponsibilityCommand} + */ + modifyVpcEndpointServicePayerResponsibility( args: ModifyVpcEndpointServicePayerResponsibilityCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyVpcEndpointServicePayerResponsibility( + modifyVpcEndpointServicePayerResponsibility( args: ModifyVpcEndpointServicePayerResponsibilityCommandInput, cb: (err: any, data?: ModifyVpcEndpointServicePayerResponsibilityCommandOutput) => void ): void; - public modifyVpcEndpointServicePayerResponsibility( + modifyVpcEndpointServicePayerResponsibility( args: ModifyVpcEndpointServicePayerResponsibilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyVpcEndpointServicePayerResponsibilityCommandOutput) => void ): void; - public modifyVpcEndpointServicePayerResponsibility( - args: ModifyVpcEndpointServicePayerResponsibilityCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ModifyVpcEndpointServicePayerResponsibilityCommandOutput) => void), - cb?: (err: any, data?: ModifyVpcEndpointServicePayerResponsibilityCommandOutput) => void - ): Promise | void { - const command = new ModifyVpcEndpointServicePayerResponsibilityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the permissions for your VPC endpoint service. You can add or remove permissions - * for service consumers (Amazon Web Services accounts, users, and IAM roles) to connect to - * your endpoint service.

- *

If you grant permissions to all principals, the service is public. Any users who know the name of a - * public service can send a request to attach an endpoint. If the service does not require manual approval, - * attachments are automatically approved.

- */ - public modifyVpcEndpointServicePermissions( + + /** + * @see {@link ModifyVpcEndpointServicePermissionsCommand} + */ + modifyVpcEndpointServicePermissions( args: ModifyVpcEndpointServicePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyVpcEndpointServicePermissions( + modifyVpcEndpointServicePermissions( args: ModifyVpcEndpointServicePermissionsCommandInput, cb: (err: any, data?: ModifyVpcEndpointServicePermissionsCommandOutput) => void ): void; - public modifyVpcEndpointServicePermissions( + modifyVpcEndpointServicePermissions( args: ModifyVpcEndpointServicePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyVpcEndpointServicePermissionsCommandOutput) => void ): void; - public modifyVpcEndpointServicePermissions( - args: ModifyVpcEndpointServicePermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyVpcEndpointServicePermissionsCommandOutput) => void), - cb?: (err: any, data?: ModifyVpcEndpointServicePermissionsCommandOutput) => void - ): Promise | void { - const command = new ModifyVpcEndpointServicePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- *

Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:

- *
    - *
  • - *

    Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC.

    - *
  • - *
  • - *

    Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC.

    - *
  • - *
  • - *

    Enable/disable the ability to resolve public DNS hostnames to private IP - * addresses when queried from instances in the peer VPC.

    - *
  • - *
- *

If the peered VPCs are in the same Amazon Web Services account, you can enable DNS - * resolution for queries from the local VPC. This ensures that queries from the local VPC - * resolve to private IP addresses in the peer VPC. This option is not available if the - * peered VPCs are in different Amazon Web Services accounts or different Regions. For - * peered VPCs in different Amazon Web Services accounts, each Amazon Web Services account - * owner must initiate a separate request to modify the peering connection options. For - * inter-region peering connections, you must use the Region for the requester VPC to - * modify the requester VPC peering options and the Region for the accepter VPC to modify - * the accepter VPC peering options. To verify which VPCs are the accepter and the - * requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.

- */ - public modifyVpcPeeringConnectionOptions( + + /** + * @see {@link ModifyVpcPeeringConnectionOptionsCommand} + */ + modifyVpcPeeringConnectionOptions( args: ModifyVpcPeeringConnectionOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyVpcPeeringConnectionOptions( + modifyVpcPeeringConnectionOptions( args: ModifyVpcPeeringConnectionOptionsCommandInput, cb: (err: any, data?: ModifyVpcPeeringConnectionOptionsCommandOutput) => void ): void; - public modifyVpcPeeringConnectionOptions( + modifyVpcPeeringConnectionOptions( args: ModifyVpcPeeringConnectionOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyVpcPeeringConnectionOptionsCommandOutput) => void ): void; - public modifyVpcPeeringConnectionOptions( - args: ModifyVpcPeeringConnectionOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyVpcPeeringConnectionOptionsCommandOutput) => void), - cb?: (err: any, data?: ModifyVpcPeeringConnectionOptionsCommandOutput) => void - ): Promise | void { - const command = new ModifyVpcPeeringConnectionOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the instance tenancy attribute of the specified VPC. You can change the - * instance tenancy attribute of a VPC to default only. You cannot change the - * instance tenancy attribute to dedicated.

- *

After you modify the tenancy of the VPC, any new instances that you launch into the - * VPC have a tenancy of default, unless you specify otherwise during launch. - * The tenancy of any existing instances in the VPC is not affected.

- *

For more information, see Dedicated Instances in the - * Amazon Elastic Compute Cloud User Guide.

- */ - public modifyVpcTenancy( + + /** + * @see {@link ModifyVpcTenancyCommand} + */ + modifyVpcTenancy( args: ModifyVpcTenancyCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyVpcTenancy( + modifyVpcTenancy( args: ModifyVpcTenancyCommandInput, cb: (err: any, data?: ModifyVpcTenancyCommandOutput) => void ): void; - public modifyVpcTenancy( + modifyVpcTenancy( args: ModifyVpcTenancyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyVpcTenancyCommandOutput) => void ): void; - public modifyVpcTenancy( - args: ModifyVpcTenancyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyVpcTenancyCommandOutput) => void), - cb?: (err: any, data?: ModifyVpcTenancyCommandOutput) => void - ): Promise | void { - const command = new ModifyVpcTenancyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection. To - * modify the target gateway, the following migration options are available:

- *
    - *
  • - *

    An existing virtual private gateway to a new virtual private gateway

    - *
  • - *
  • - *

    An existing virtual private gateway to a transit gateway

    - *
  • - *
  • - *

    An existing transit gateway to a new transit gateway

    - *
  • - *
  • - *

    An existing transit gateway to a virtual private gateway

    - *
  • - *
- *

Before you perform the migration to the new gateway, you must configure the new - * gateway. Use CreateVpnGateway to create a virtual private gateway, or - * CreateTransitGateway to create a transit gateway.

- *

This step is required when you migrate from a virtual private gateway with static - * routes to a transit gateway.

- *

You must delete the static routes before you migrate to the new gateway.

- *

Keep a copy of the static route before you delete it. You will need to add back these - * routes to the transit gateway after the VPN connection migration is complete.

- *

After you migrate to the new gateway, you might need to modify your VPC route table. - * Use CreateRoute and DeleteRoute to make the changes - * described in Update VPC route - * tables in the Amazon Web Services Site-to-Site VPN User Guide.

- *

When the new gateway is a transit gateway, modify the transit gateway route table to - * allow traffic between the VPC and the Amazon Web Services Site-to-Site VPN connection. - * Use CreateTransitGatewayRoute to add the routes.

- *

If you deleted VPN static routes, you must add the static routes to the transit - * gateway route table.

- *

After you perform this operation, the VPN endpoint's IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will - * be temporarily unavailable for a brief period while we provision the new - * endpoints.

- */ - public modifyVpnConnection( + + /** + * @see {@link ModifyVpnConnectionCommand} + */ + modifyVpnConnection( args: ModifyVpnConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyVpnConnection( + modifyVpnConnection( args: ModifyVpnConnectionCommandInput, cb: (err: any, data?: ModifyVpnConnectionCommandOutput) => void ): void; - public modifyVpnConnection( + modifyVpnConnection( args: ModifyVpnConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyVpnConnectionCommandOutput) => void ): void; - public modifyVpnConnection( - args: ModifyVpnConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyVpnConnectionCommandOutput) => void), - cb?: (err: any, data?: ModifyVpnConnectionCommandOutput) => void - ): Promise | void { - const command = new ModifyVpnConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the connection options for your Site-to-Site VPN connection.

- *

When you modify the VPN connection options, the VPN endpoint IP addresses on the - * Amazon Web Services side do not change, and the tunnel options do not change. Your - * VPN connection will be temporarily unavailable for a brief period while the VPN - * connection is updated.

- */ - public modifyVpnConnectionOptions( + + /** + * @see {@link ModifyVpnConnectionOptionsCommand} + */ + modifyVpnConnectionOptions( args: ModifyVpnConnectionOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyVpnConnectionOptions( + modifyVpnConnectionOptions( args: ModifyVpnConnectionOptionsCommandInput, cb: (err: any, data?: ModifyVpnConnectionOptionsCommandOutput) => void ): void; - public modifyVpnConnectionOptions( + modifyVpnConnectionOptions( args: ModifyVpnConnectionOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyVpnConnectionOptionsCommandOutput) => void ): void; - public modifyVpnConnectionOptions( - args: ModifyVpnConnectionOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyVpnConnectionOptionsCommandOutput) => void), - cb?: (err: any, data?: ModifyVpnConnectionOptionsCommandOutput) => void - ): Promise | void { - const command = new ModifyVpnConnectionOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the VPN tunnel endpoint certificate.

- */ - public modifyVpnTunnelCertificate( + + /** + * @see {@link ModifyVpnTunnelCertificateCommand} + */ + modifyVpnTunnelCertificate( args: ModifyVpnTunnelCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyVpnTunnelCertificate( + modifyVpnTunnelCertificate( args: ModifyVpnTunnelCertificateCommandInput, cb: (err: any, data?: ModifyVpnTunnelCertificateCommandOutput) => void ): void; - public modifyVpnTunnelCertificate( + modifyVpnTunnelCertificate( args: ModifyVpnTunnelCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyVpnTunnelCertificateCommandOutput) => void ): void; - public modifyVpnTunnelCertificate( - args: ModifyVpnTunnelCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyVpnTunnelCertificateCommandOutput) => void), - cb?: (err: any, data?: ModifyVpnTunnelCertificateCommandOutput) => void - ): Promise | void { - const command = new ModifyVpnTunnelCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN connection. You can modify - * multiple options for a tunnel in a single request, but you can only modify one tunnel at - * a time. For more information, see Site-to-Site VPN tunnel options for your Site-to-Site VPN - * connection in the Amazon Web Services Site-to-Site VPN User Guide.

- */ - public modifyVpnTunnelOptions( + + /** + * @see {@link ModifyVpnTunnelOptionsCommand} + */ + modifyVpnTunnelOptions( args: ModifyVpnTunnelOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyVpnTunnelOptions( + modifyVpnTunnelOptions( args: ModifyVpnTunnelOptionsCommandInput, cb: (err: any, data?: ModifyVpnTunnelOptionsCommandOutput) => void ): void; - public modifyVpnTunnelOptions( + modifyVpnTunnelOptions( args: ModifyVpnTunnelOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyVpnTunnelOptionsCommandOutput) => void ): void; - public modifyVpnTunnelOptions( - args: ModifyVpnTunnelOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyVpnTunnelOptionsCommandOutput) => void), - cb?: (err: any, data?: ModifyVpnTunnelOptionsCommandOutput) => void - ): Promise | void { - const command = new ModifyVpnTunnelOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables detailed monitoring for a running instance. Otherwise, basic monitoring is - * enabled. For more information, see Monitor your instances using - * CloudWatch in the Amazon EC2 User Guide.

- *

To disable detailed monitoring, see UnmonitorInstances.

- */ - public monitorInstances( + + /** + * @see {@link MonitorInstancesCommand} + */ + monitorInstances( args: MonitorInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public monitorInstances( + monitorInstances( args: MonitorInstancesCommandInput, cb: (err: any, data?: MonitorInstancesCommandOutput) => void ): void; - public monitorInstances( + monitorInstances( args: MonitorInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MonitorInstancesCommandOutput) => void ): void; - public monitorInstances( - args: MonitorInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MonitorInstancesCommandOutput) => void), - cb?: (err: any, data?: MonitorInstancesCommandOutput) => void - ): Promise | void { - const command = new MonitorInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The - * Elastic IP address must be allocated to your account for more than 24 hours, and it must not - * be associated with an instance. After the Elastic IP address is moved, it is no longer - * available for use in the EC2-Classic platform, unless you move it back using the - * RestoreAddressToClassic request. You cannot move an Elastic IP address that was - * originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.

- * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- */ - public moveAddressToVpc( + + /** + * @see {@link MoveAddressToVpcCommand} + */ + moveAddressToVpc( args: MoveAddressToVpcCommandInput, options?: __HttpHandlerOptions ): Promise; - public moveAddressToVpc( + moveAddressToVpc( args: MoveAddressToVpcCommandInput, cb: (err: any, data?: MoveAddressToVpcCommandOutput) => void ): void; - public moveAddressToVpc( + moveAddressToVpc( args: MoveAddressToVpcCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MoveAddressToVpcCommandOutput) => void ): void; - public moveAddressToVpc( - args: MoveAddressToVpcCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MoveAddressToVpcCommandOutput) => void), - cb?: (err: any, data?: MoveAddressToVpcCommandOutput) => void - ): Promise | void { - const command = new MoveAddressToVpcCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Move a BYOIPv4 CIDR to IPAM from a public IPv4 pool.

- *

If you already have a BYOIPv4 CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in Tutorial: BYOIP address CIDRs to IPAM.

- */ - public moveByoipCidrToIpam( + + /** + * @see {@link MoveByoipCidrToIpamCommand} + */ + moveByoipCidrToIpam( args: MoveByoipCidrToIpamCommandInput, options?: __HttpHandlerOptions ): Promise; - public moveByoipCidrToIpam( + moveByoipCidrToIpam( args: MoveByoipCidrToIpamCommandInput, cb: (err: any, data?: MoveByoipCidrToIpamCommandOutput) => void ): void; - public moveByoipCidrToIpam( + moveByoipCidrToIpam( args: MoveByoipCidrToIpamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MoveByoipCidrToIpamCommandOutput) => void ): void; - public moveByoipCidrToIpam( - args: MoveByoipCidrToIpamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MoveByoipCidrToIpamCommandOutput) => void), - cb?: (err: any, data?: MoveByoipCidrToIpamCommandOutput) => void - ): Promise | void { - const command = new MoveByoipCidrToIpamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP - * addresses (BYOIP) and creates a corresponding address pool. After the address range is - * provisioned, it is ready to be advertised using AdvertiseByoipCidr.

- *

Amazon Web Services verifies that you own the address range and are authorized to advertise it. - * You must ensure that the address range is registered to you and that you created an - * RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. - * For more information, see Bring your own IP addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

- *

Provisioning an address range is an asynchronous operation, so the call returns immediately, - * but the address range is not ready to use until its status changes from pending-provision - * to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. - * To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress - * with either the specific address from the address pool or the ID of the address pool.

- */ - public provisionByoipCidr( + + /** + * @see {@link ProvisionByoipCidrCommand} + */ + provisionByoipCidr( args: ProvisionByoipCidrCommandInput, options?: __HttpHandlerOptions ): Promise; - public provisionByoipCidr( + provisionByoipCidr( args: ProvisionByoipCidrCommandInput, cb: (err: any, data?: ProvisionByoipCidrCommandOutput) => void ): void; - public provisionByoipCidr( + provisionByoipCidr( args: ProvisionByoipCidrCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ProvisionByoipCidrCommandOutput) => void ): void; - public provisionByoipCidr( - args: ProvisionByoipCidrCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ProvisionByoipCidrCommandOutput) => void), - cb?: (err: any, data?: ProvisionByoipCidrCommandOutput) => void - ): Promise | void { - const command = new ProvisionByoipCidrCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.

- *

For more information, see Provision CIDRs to pools in the Amazon VPC IPAM User Guide. - *

- */ - public provisionIpamPoolCidr( + + /** + * @see {@link ProvisionIpamPoolCidrCommand} + */ + provisionIpamPoolCidr( args: ProvisionIpamPoolCidrCommandInput, options?: __HttpHandlerOptions ): Promise; - public provisionIpamPoolCidr( + provisionIpamPoolCidr( args: ProvisionIpamPoolCidrCommandInput, cb: (err: any, data?: ProvisionIpamPoolCidrCommandOutput) => void ): void; - public provisionIpamPoolCidr( + provisionIpamPoolCidr( args: ProvisionIpamPoolCidrCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ProvisionIpamPoolCidrCommandOutput) => void ): void; - public provisionIpamPoolCidr( - args: ProvisionIpamPoolCidrCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ProvisionIpamPoolCidrCommandOutput) => void), - cb?: (err: any, data?: ProvisionIpamPoolCidrCommandOutput) => void - ): Promise | void { - const command = new ProvisionIpamPoolCidrCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provision a CIDR to a public IPv4 pool.

- *

For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

- */ - public provisionPublicIpv4PoolCidr( + + /** + * @see {@link ProvisionPublicIpv4PoolCidrCommand} + */ + provisionPublicIpv4PoolCidr( args: ProvisionPublicIpv4PoolCidrCommandInput, options?: __HttpHandlerOptions ): Promise; - public provisionPublicIpv4PoolCidr( + provisionPublicIpv4PoolCidr( args: ProvisionPublicIpv4PoolCidrCommandInput, cb: (err: any, data?: ProvisionPublicIpv4PoolCidrCommandOutput) => void ): void; - public provisionPublicIpv4PoolCidr( + provisionPublicIpv4PoolCidr( args: ProvisionPublicIpv4PoolCidrCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ProvisionPublicIpv4PoolCidrCommandOutput) => void ): void; - public provisionPublicIpv4PoolCidr( - args: ProvisionPublicIpv4PoolCidrCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ProvisionPublicIpv4PoolCidrCommandOutput) => void), - cb?: (err: any, data?: ProvisionPublicIpv4PoolCidrCommandOutput) => void - ): Promise | void { - const command = new ProvisionPublicIpv4PoolCidrCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Purchase a reservation with configurations that match those of your Dedicated Host. - * You must have active Dedicated Hosts in your account before you purchase a reservation. - * This action results in the specified reservation being purchased and charged to your - * account.

- */ - public purchaseHostReservation( + + /** + * @see {@link PurchaseHostReservationCommand} + */ + purchaseHostReservation( args: PurchaseHostReservationCommandInput, options?: __HttpHandlerOptions ): Promise; - public purchaseHostReservation( + purchaseHostReservation( args: PurchaseHostReservationCommandInput, cb: (err: any, data?: PurchaseHostReservationCommandOutput) => void ): void; - public purchaseHostReservation( + purchaseHostReservation( args: PurchaseHostReservationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PurchaseHostReservationCommandOutput) => void ): void; - public purchaseHostReservation( - args: PurchaseHostReservationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PurchaseHostReservationCommandOutput) => void), - cb?: (err: any, data?: PurchaseHostReservationCommandOutput) => void - ): Promise | void { - const command = new PurchaseHostReservationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower - * hourly rate compared to On-Demand instance pricing.

- *

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings - * that match your specifications. After you've purchased a Reserved Instance, you can check for your - * new Reserved Instance with DescribeReservedInstances.

- *

To queue a purchase for a future date and time, specify a purchase time. If you do not specify a - * purchase time, the default is the current time.

- *

For more information, see Reserved Instances and - * Reserved Instance Marketplace - * in the Amazon EC2 User Guide.

- * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- */ - public purchaseReservedInstancesOffering( + + /** + * @see {@link PurchaseReservedInstancesOfferingCommand} + */ + purchaseReservedInstancesOffering( args: PurchaseReservedInstancesOfferingCommandInput, options?: __HttpHandlerOptions ): Promise; - public purchaseReservedInstancesOffering( + purchaseReservedInstancesOffering( args: PurchaseReservedInstancesOfferingCommandInput, cb: (err: any, data?: PurchaseReservedInstancesOfferingCommandOutput) => void ): void; - public purchaseReservedInstancesOffering( + purchaseReservedInstancesOffering( args: PurchaseReservedInstancesOfferingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PurchaseReservedInstancesOfferingCommandOutput) => void ): void; - public purchaseReservedInstancesOffering( - args: PurchaseReservedInstancesOfferingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PurchaseReservedInstancesOfferingCommandOutput) => void), - cb?: (err: any, data?: PurchaseReservedInstancesOfferingCommandOutput) => void - ): Promise | void { - const command = new PurchaseReservedInstancesOfferingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

You can no longer purchase Scheduled Instances.

- *
- *

Purchases the Scheduled Instances with the specified schedule.

- *

Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. - * Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability - * to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, - * you must call RunScheduledInstances during each scheduled time period.

- *

After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.

- */ - public purchaseScheduledInstances( + + /** + * @see {@link PurchaseScheduledInstancesCommand} + */ + purchaseScheduledInstances( args: PurchaseScheduledInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public purchaseScheduledInstances( + purchaseScheduledInstances( args: PurchaseScheduledInstancesCommandInput, cb: (err: any, data?: PurchaseScheduledInstancesCommandOutput) => void ): void; - public purchaseScheduledInstances( + purchaseScheduledInstances( args: PurchaseScheduledInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PurchaseScheduledInstancesCommandOutput) => void ): void; - public purchaseScheduledInstances( - args: PurchaseScheduledInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PurchaseScheduledInstancesCommandOutput) => void), - cb?: (err: any, data?: PurchaseScheduledInstancesCommandOutput) => void - ): Promise | void { - const command = new PurchaseScheduledInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Requests a reboot of the specified instances. This operation is asynchronous; it only - * queues a request to reboot the specified instances. The operation succeeds if the - * instances are valid and belong to you. Requests to reboot terminated instances are - * ignored.

- *

If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a - * hard reboot.

- *

For more information about troubleshooting, see Troubleshoot an unreachable - * instance in the Amazon EC2 User Guide.

- */ - public rebootInstances( + + /** + * @see {@link RebootInstancesCommand} + */ + rebootInstances( args: RebootInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public rebootInstances( - args: RebootInstancesCommandInput, - cb: (err: any, data?: RebootInstancesCommandOutput) => void - ): void; - public rebootInstances( + rebootInstances(args: RebootInstancesCommandInput, cb: (err: any, data?: RebootInstancesCommandOutput) => void): void; + rebootInstances( args: RebootInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebootInstancesCommandOutput) => void ): void; - public rebootInstances( - args: RebootInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RebootInstancesCommandOutput) => void), - cb?: (err: any, data?: RebootInstancesCommandOutput) => void - ): Promise | void { - const command = new RebootInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers an AMI. When you're creating an AMI, this is the final step you must complete - * before you can launch an instance from the AMI. For more information about creating AMIs, see - * Create your - * own AMI in the Amazon Elastic Compute Cloud User Guide.

- * - *

For Amazon EBS-backed instances, CreateImage creates and registers the AMI - * in a single request, so you don't have to register the AMI yourself. We recommend that you - * always use CreateImage unless you have a specific reason to use - * RegisterImage.

- *
- *

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. - * If you make changes to an image, deregister the previous image and register the new image.

- *

- * Register a snapshot of a root device volume - *

- *

You can use RegisterImage to create an Amazon EBS-backed Linux AMI from - * a snapshot of a root device volume. You specify the snapshot using a block device mapping. - * You can't set the encryption state of the volume using the block device mapping. If the - * snapshot is encrypted, or encryption by default is enabled, the root volume of an instance - * launched from the AMI is encrypted.

- *

For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs - * in the Amazon Elastic Compute Cloud User Guide.

- *

- * Amazon Web Services Marketplace product codes - *

- *

If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new - * AMI.

- *

Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE - * Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to - * verify the subscription status for package updates. To create a new AMI for operating systems - * that require a billing product code, instead of registering the AMI, do the following to - * preserve the billing product code association:

- *
    - *
  1. - *

    Launch an instance from an existing AMI with that billing product code.

    - *
  2. - *
  3. - *

    Customize the instance.

    - *
  4. - *
  5. - *

    Create an AMI from the instance using CreateImage.

    - *
  6. - *
- *

If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched - * from an AMI with a billing product code, make sure that the Reserved Instance has the matching - * billing product code. If you purchase a Reserved Instance without the matching billing product - * code, the Reserved Instance will not be applied to the On-Demand Instance. For information - * about how to obtain the platform details and billing information of an AMI, see Understand AMI - * billing information in the Amazon EC2 User Guide.

- */ - public registerImage( - args: RegisterImageCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public registerImage( - args: RegisterImageCommandInput, - cb: (err: any, data?: RegisterImageCommandOutput) => void - ): void; - public registerImage( + + /** + * @see {@link RegisterImageCommand} + */ + registerImage(args: RegisterImageCommandInput, options?: __HttpHandlerOptions): Promise; + registerImage(args: RegisterImageCommandInput, cb: (err: any, data?: RegisterImageCommandOutput) => void): void; + registerImage( args: RegisterImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterImageCommandOutput) => void ): void; - public registerImage( - args: RegisterImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterImageCommandOutput) => void), - cb?: (err: any, data?: RegisterImageCommandOutput) => void - ): Promise | void { - const command = new RegisterImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers a set of tag keys to include in scheduled event notifications for your resources. - *

- *

To remove tags, use DeregisterInstanceEventNotificationAttributes.

- */ - public registerInstanceEventNotificationAttributes( + + /** + * @see {@link RegisterInstanceEventNotificationAttributesCommand} + */ + registerInstanceEventNotificationAttributes( args: RegisterInstanceEventNotificationAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerInstanceEventNotificationAttributes( + registerInstanceEventNotificationAttributes( args: RegisterInstanceEventNotificationAttributesCommandInput, cb: (err: any, data?: RegisterInstanceEventNotificationAttributesCommandOutput) => void ): void; - public registerInstanceEventNotificationAttributes( + registerInstanceEventNotificationAttributes( args: RegisterInstanceEventNotificationAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterInstanceEventNotificationAttributesCommandOutput) => void ): void; - public registerInstanceEventNotificationAttributes( - args: RegisterInstanceEventNotificationAttributesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: RegisterInstanceEventNotificationAttributesCommandOutput) => void), - cb?: (err: any, data?: RegisterInstanceEventNotificationAttributesCommandOutput) => void - ): Promise | void { - const command = new RegisterInstanceEventNotificationAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated - * with a supported EC2 instance that receives multicast traffic. For information about - * supported instances, see Multicast - * Consideration in Amazon VPC Transit Gateways.

- *

After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added - * to the transit gateway multicast group.

- */ - public registerTransitGatewayMulticastGroupMembers( + + /** + * @see {@link RegisterTransitGatewayMulticastGroupMembersCommand} + */ + registerTransitGatewayMulticastGroupMembers( args: RegisterTransitGatewayMulticastGroupMembersCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerTransitGatewayMulticastGroupMembers( + registerTransitGatewayMulticastGroupMembers( args: RegisterTransitGatewayMulticastGroupMembersCommandInput, cb: (err: any, data?: RegisterTransitGatewayMulticastGroupMembersCommandOutput) => void ): void; - public registerTransitGatewayMulticastGroupMembers( + registerTransitGatewayMulticastGroupMembers( args: RegisterTransitGatewayMulticastGroupMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterTransitGatewayMulticastGroupMembersCommandOutput) => void ): void; - public registerTransitGatewayMulticastGroupMembers( - args: RegisterTransitGatewayMulticastGroupMembersCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: RegisterTransitGatewayMulticastGroupMembersCommandOutput) => void), - cb?: (err: any, data?: RegisterTransitGatewayMulticastGroupMembersCommandOutput) => void - ): Promise | void { - const command = new RegisterTransitGatewayMulticastGroupMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers sources (network interfaces) with the specified transit gateway multicast group.

- *

A multicast source is a network interface attached to a supported instance that sends - * multicast traffic. For information about supported instances, see Multicast - * Considerations in Amazon VPC Transit Gateways.

- *

After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast - * group.

- */ - public registerTransitGatewayMulticastGroupSources( + + /** + * @see {@link RegisterTransitGatewayMulticastGroupSourcesCommand} + */ + registerTransitGatewayMulticastGroupSources( args: RegisterTransitGatewayMulticastGroupSourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerTransitGatewayMulticastGroupSources( + registerTransitGatewayMulticastGroupSources( args: RegisterTransitGatewayMulticastGroupSourcesCommandInput, cb: (err: any, data?: RegisterTransitGatewayMulticastGroupSourcesCommandOutput) => void ): void; - public registerTransitGatewayMulticastGroupSources( + registerTransitGatewayMulticastGroupSources( args: RegisterTransitGatewayMulticastGroupSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterTransitGatewayMulticastGroupSourcesCommandOutput) => void ): void; - public registerTransitGatewayMulticastGroupSources( - args: RegisterTransitGatewayMulticastGroupSourcesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: RegisterTransitGatewayMulticastGroupSourcesCommandOutput) => void), - cb?: (err: any, data?: RegisterTransitGatewayMulticastGroupSourcesCommandOutput) => void - ): Promise | void { - const command = new RegisterTransitGatewayMulticastGroupSourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Rejects a request to associate cross-account subnets with a transit gateway multicast domain.

- */ - public rejectTransitGatewayMulticastDomainAssociations( + + /** + * @see {@link RejectTransitGatewayMulticastDomainAssociationsCommand} + */ + rejectTransitGatewayMulticastDomainAssociations( args: RejectTransitGatewayMulticastDomainAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public rejectTransitGatewayMulticastDomainAssociations( + rejectTransitGatewayMulticastDomainAssociations( args: RejectTransitGatewayMulticastDomainAssociationsCommandInput, cb: (err: any, data?: RejectTransitGatewayMulticastDomainAssociationsCommandOutput) => void ): void; - public rejectTransitGatewayMulticastDomainAssociations( + rejectTransitGatewayMulticastDomainAssociations( args: RejectTransitGatewayMulticastDomainAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectTransitGatewayMulticastDomainAssociationsCommandOutput) => void ): void; - public rejectTransitGatewayMulticastDomainAssociations( - args: RejectTransitGatewayMulticastDomainAssociationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: RejectTransitGatewayMulticastDomainAssociationsCommandOutput) => void), - cb?: (err: any, data?: RejectTransitGatewayMulticastDomainAssociationsCommandOutput) => void - ): Promise | void { - const command = new RejectTransitGatewayMulticastDomainAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Rejects a transit gateway peering attachment request.

- */ - public rejectTransitGatewayPeeringAttachment( + + /** + * @see {@link RejectTransitGatewayPeeringAttachmentCommand} + */ + rejectTransitGatewayPeeringAttachment( args: RejectTransitGatewayPeeringAttachmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public rejectTransitGatewayPeeringAttachment( + rejectTransitGatewayPeeringAttachment( args: RejectTransitGatewayPeeringAttachmentCommandInput, cb: (err: any, data?: RejectTransitGatewayPeeringAttachmentCommandOutput) => void ): void; - public rejectTransitGatewayPeeringAttachment( + rejectTransitGatewayPeeringAttachment( args: RejectTransitGatewayPeeringAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectTransitGatewayPeeringAttachmentCommandOutput) => void ): void; - public rejectTransitGatewayPeeringAttachment( - args: RejectTransitGatewayPeeringAttachmentCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: RejectTransitGatewayPeeringAttachmentCommandOutput) => void), - cb?: (err: any, data?: RejectTransitGatewayPeeringAttachmentCommandOutput) => void - ): Promise | void { - const command = new RejectTransitGatewayPeeringAttachmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Rejects a request to attach a VPC to a transit gateway.

- *

The VPC attachment must be in the pendingAcceptance state. - * Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. - * Use AcceptTransitGatewayVpcAttachment to accept a VPC attachment request.

- */ - public rejectTransitGatewayVpcAttachment( + + /** + * @see {@link RejectTransitGatewayVpcAttachmentCommand} + */ + rejectTransitGatewayVpcAttachment( args: RejectTransitGatewayVpcAttachmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public rejectTransitGatewayVpcAttachment( + rejectTransitGatewayVpcAttachment( args: RejectTransitGatewayVpcAttachmentCommandInput, cb: (err: any, data?: RejectTransitGatewayVpcAttachmentCommandOutput) => void ): void; - public rejectTransitGatewayVpcAttachment( + rejectTransitGatewayVpcAttachment( args: RejectTransitGatewayVpcAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectTransitGatewayVpcAttachmentCommandOutput) => void ): void; - public rejectTransitGatewayVpcAttachment( - args: RejectTransitGatewayVpcAttachmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RejectTransitGatewayVpcAttachmentCommandOutput) => void), - cb?: (err: any, data?: RejectTransitGatewayVpcAttachmentCommandOutput) => void - ): Promise | void { - const command = new RejectTransitGatewayVpcAttachmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Rejects VPC endpoint connection requests to your VPC endpoint service.

- */ - public rejectVpcEndpointConnections( + + /** + * @see {@link RejectVpcEndpointConnectionsCommand} + */ + rejectVpcEndpointConnections( args: RejectVpcEndpointConnectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public rejectVpcEndpointConnections( + rejectVpcEndpointConnections( args: RejectVpcEndpointConnectionsCommandInput, cb: (err: any, data?: RejectVpcEndpointConnectionsCommandOutput) => void ): void; - public rejectVpcEndpointConnections( + rejectVpcEndpointConnections( args: RejectVpcEndpointConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectVpcEndpointConnectionsCommandOutput) => void ): void; - public rejectVpcEndpointConnections( - args: RejectVpcEndpointConnectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RejectVpcEndpointConnectionsCommandOutput) => void), - cb?: (err: any, data?: RejectVpcEndpointConnectionsCommandOutput) => void - ): Promise | void { - const command = new RejectVpcEndpointConnectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Rejects a VPC peering connection request. The VPC peering connection must be in the - * pending-acceptance state. Use the DescribeVpcPeeringConnections request - * to view your outstanding VPC peering connection requests. To delete an active VPC peering - * connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.

- */ - public rejectVpcPeeringConnection( + + /** + * @see {@link RejectVpcPeeringConnectionCommand} + */ + rejectVpcPeeringConnection( args: RejectVpcPeeringConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public rejectVpcPeeringConnection( + rejectVpcPeeringConnection( args: RejectVpcPeeringConnectionCommandInput, cb: (err: any, data?: RejectVpcPeeringConnectionCommandOutput) => void ): void; - public rejectVpcPeeringConnection( + rejectVpcPeeringConnection( args: RejectVpcPeeringConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectVpcPeeringConnectionCommandOutput) => void ): void; - public rejectVpcPeeringConnection( - args: RejectVpcPeeringConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RejectVpcPeeringConnectionCommandOutput) => void), - cb?: (err: any, data?: RejectVpcPeeringConnectionCommandOutput) => void - ): Promise | void { - const command = new RejectVpcPeeringConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Releases the specified Elastic IP address.

- *

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it - * from any instance that it's associated with. To disassociate an Elastic IP address without - * releasing it, use DisassociateAddress.

- * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- *

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address - * before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

- *

After releasing an Elastic IP address, it is released to the IP address pool. - * Be sure to update your DNS records and any servers or devices that communicate with the address. - * If you attempt to release an Elastic IP address that you already released, you'll get an - * AuthFailure error if the address is already allocated to another Amazon Web Services account.

- *

[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. - * For more information, see AllocateAddress.

- *

For more - * information, see Elastic IP - * Addresses in the Amazon Elastic Compute Cloud User Guide.

- */ - public releaseAddress( + + /** + * @see {@link ReleaseAddressCommand} + */ + releaseAddress( args: ReleaseAddressCommandInput, options?: __HttpHandlerOptions ): Promise; - public releaseAddress( - args: ReleaseAddressCommandInput, - cb: (err: any, data?: ReleaseAddressCommandOutput) => void - ): void; - public releaseAddress( + releaseAddress(args: ReleaseAddressCommandInput, cb: (err: any, data?: ReleaseAddressCommandOutput) => void): void; + releaseAddress( args: ReleaseAddressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReleaseAddressCommandOutput) => void ): void; - public releaseAddress( - args: ReleaseAddressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReleaseAddressCommandOutput) => void), - cb?: (err: any, data?: ReleaseAddressCommandOutput) => void - ): Promise | void { - const command = new ReleaseAddressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

When you no longer want to use an On-Demand Dedicated Host it can be released. - * On-Demand billing is stopped and the host goes into released state. The - * host ID of Dedicated Hosts that have been released can no longer be specified in another - * request, for example, to modify the host. You must stop or terminate all instances on a - * host before it can be released.

- *

When Dedicated Hosts are released, it may take some time for them to stop counting - * toward your limit and you may receive capacity errors when trying to allocate new - * Dedicated Hosts. Wait a few minutes and then try again.

- *

Released hosts still appear in a DescribeHosts response.

- */ - public releaseHosts( - args: ReleaseHostsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public releaseHosts(args: ReleaseHostsCommandInput, cb: (err: any, data?: ReleaseHostsCommandOutput) => void): void; - public releaseHosts( + + /** + * @see {@link ReleaseHostsCommand} + */ + releaseHosts(args: ReleaseHostsCommandInput, options?: __HttpHandlerOptions): Promise; + releaseHosts(args: ReleaseHostsCommandInput, cb: (err: any, data?: ReleaseHostsCommandOutput) => void): void; + releaseHosts( args: ReleaseHostsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReleaseHostsCommandOutput) => void ): void; - public releaseHosts( - args: ReleaseHostsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReleaseHostsCommandOutput) => void), - cb?: (err: any, data?: ReleaseHostsCommandOutput) => void - ): Promise | void { - const command = new ReleaseHostsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Release an allocation within an IPAM pool. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon VPC IPAM User Guide. - *

- * - *

All EC2 API actions follow an eventual consistency model.

- *
- */ - public releaseIpamPoolAllocation( + + /** + * @see {@link ReleaseIpamPoolAllocationCommand} + */ + releaseIpamPoolAllocation( args: ReleaseIpamPoolAllocationCommandInput, options?: __HttpHandlerOptions ): Promise; - public releaseIpamPoolAllocation( + releaseIpamPoolAllocation( args: ReleaseIpamPoolAllocationCommandInput, cb: (err: any, data?: ReleaseIpamPoolAllocationCommandOutput) => void ): void; - public releaseIpamPoolAllocation( + releaseIpamPoolAllocation( args: ReleaseIpamPoolAllocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReleaseIpamPoolAllocationCommandOutput) => void ): void; - public releaseIpamPoolAllocation( - args: ReleaseIpamPoolAllocationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReleaseIpamPoolAllocationCommandOutput) => void), - cb?: (err: any, data?: ReleaseIpamPoolAllocationCommandOutput) => void - ): Promise | void { - const command = new ReleaseIpamPoolAllocationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Replaces an IAM instance profile for the specified running instance. You can use - * this action to change the IAM instance profile that's associated with an instance - * without having to disassociate the existing IAM instance profile first.

- *

Use DescribeIamInstanceProfileAssociations to get the association - * ID.

- */ - public replaceIamInstanceProfileAssociation( + + /** + * @see {@link ReplaceIamInstanceProfileAssociationCommand} + */ + replaceIamInstanceProfileAssociation( args: ReplaceIamInstanceProfileAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public replaceIamInstanceProfileAssociation( + replaceIamInstanceProfileAssociation( args: ReplaceIamInstanceProfileAssociationCommandInput, cb: (err: any, data?: ReplaceIamInstanceProfileAssociationCommandOutput) => void ): void; - public replaceIamInstanceProfileAssociation( + replaceIamInstanceProfileAssociation( args: ReplaceIamInstanceProfileAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReplaceIamInstanceProfileAssociationCommandOutput) => void ): void; - public replaceIamInstanceProfileAssociation( - args: ReplaceIamInstanceProfileAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReplaceIamInstanceProfileAssociationCommandOutput) => void), - cb?: (err: any, data?: ReplaceIamInstanceProfileAssociationCommandOutput) => void - ): Promise | void { - const command = new ReplaceIamInstanceProfileAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Changes which network ACL a subnet is associated with. By default when you create a - * subnet, it's automatically associated with the default network ACL. For more - * information, see Network - * ACLs in the Amazon Virtual Private Cloud User Guide.

- *

This is an idempotent operation.

- */ - public replaceNetworkAclAssociation( + + /** + * @see {@link ReplaceNetworkAclAssociationCommand} + */ + replaceNetworkAclAssociation( args: ReplaceNetworkAclAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public replaceNetworkAclAssociation( + replaceNetworkAclAssociation( args: ReplaceNetworkAclAssociationCommandInput, cb: (err: any, data?: ReplaceNetworkAclAssociationCommandOutput) => void ): void; - public replaceNetworkAclAssociation( + replaceNetworkAclAssociation( args: ReplaceNetworkAclAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReplaceNetworkAclAssociationCommandOutput) => void ): void; - public replaceNetworkAclAssociation( - args: ReplaceNetworkAclAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReplaceNetworkAclAssociationCommandOutput) => void), - cb?: (err: any, data?: ReplaceNetworkAclAssociationCommandOutput) => void - ): Promise | void { - const command = new ReplaceNetworkAclAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the - * Amazon Virtual Private Cloud User Guide.

- */ - public replaceNetworkAclEntry( + + /** + * @see {@link ReplaceNetworkAclEntryCommand} + */ + replaceNetworkAclEntry( args: ReplaceNetworkAclEntryCommandInput, options?: __HttpHandlerOptions ): Promise; - public replaceNetworkAclEntry( + replaceNetworkAclEntry( args: ReplaceNetworkAclEntryCommandInput, cb: (err: any, data?: ReplaceNetworkAclEntryCommandOutput) => void ): void; - public replaceNetworkAclEntry( + replaceNetworkAclEntry( args: ReplaceNetworkAclEntryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReplaceNetworkAclEntryCommandOutput) => void ): void; - public replaceNetworkAclEntry( - args: ReplaceNetworkAclEntryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReplaceNetworkAclEntryCommandOutput) => void), - cb?: (err: any, data?: ReplaceNetworkAclEntryCommandOutput) => void - ): Promise | void { - const command = new ReplaceNetworkAclEntryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Replaces an existing route within a route table in a VPC.

- *

You must specify either a destination CIDR block or a prefix list ID. You must also specify - * exactly one of the resources from the parameter list, or reset the local route to its default - * target.

- *

For more information, see Route tables in the - * Amazon Virtual Private Cloud User Guide.

- */ - public replaceRoute( - args: ReplaceRouteCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public replaceRoute(args: ReplaceRouteCommandInput, cb: (err: any, data?: ReplaceRouteCommandOutput) => void): void; - public replaceRoute( + + /** + * @see {@link ReplaceRouteCommand} + */ + replaceRoute(args: ReplaceRouteCommandInput, options?: __HttpHandlerOptions): Promise; + replaceRoute(args: ReplaceRouteCommandInput, cb: (err: any, data?: ReplaceRouteCommandOutput) => void): void; + replaceRoute( args: ReplaceRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReplaceRouteCommandOutput) => void ): void; - public replaceRoute( - args: ReplaceRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReplaceRouteCommandOutput) => void), - cb?: (err: any, data?: ReplaceRouteCommandOutput) => void - ): Promise | void { - const command = new ReplaceRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC. After the operation - * completes, the subnet or gateway uses the routes in the new route table. For more - * information about route tables, see Route - * tables in the Amazon Virtual Private Cloud User Guide.

- *

You can also use this operation to change which table is the main route table in the VPC. Specify the main route table's association ID and the route table ID of the new main route table.

- */ - public replaceRouteTableAssociation( + + /** + * @see {@link ReplaceRouteTableAssociationCommand} + */ + replaceRouteTableAssociation( args: ReplaceRouteTableAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public replaceRouteTableAssociation( + replaceRouteTableAssociation( args: ReplaceRouteTableAssociationCommandInput, cb: (err: any, data?: ReplaceRouteTableAssociationCommandOutput) => void ): void; - public replaceRouteTableAssociation( + replaceRouteTableAssociation( args: ReplaceRouteTableAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReplaceRouteTableAssociationCommandOutput) => void ): void; - public replaceRouteTableAssociation( - args: ReplaceRouteTableAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReplaceRouteTableAssociationCommandOutput) => void), - cb?: (err: any, data?: ReplaceRouteTableAssociationCommandOutput) => void - ): Promise | void { - const command = new ReplaceRouteTableAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Replaces the specified route in the specified transit gateway route table.

- */ - public replaceTransitGatewayRoute( + + /** + * @see {@link ReplaceTransitGatewayRouteCommand} + */ + replaceTransitGatewayRoute( args: ReplaceTransitGatewayRouteCommandInput, options?: __HttpHandlerOptions ): Promise; - public replaceTransitGatewayRoute( + replaceTransitGatewayRoute( args: ReplaceTransitGatewayRouteCommandInput, cb: (err: any, data?: ReplaceTransitGatewayRouteCommandOutput) => void ): void; - public replaceTransitGatewayRoute( + replaceTransitGatewayRoute( args: ReplaceTransitGatewayRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReplaceTransitGatewayRouteCommandOutput) => void ): void; - public replaceTransitGatewayRoute( - args: ReplaceTransitGatewayRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReplaceTransitGatewayRouteCommandOutput) => void), - cb?: (err: any, data?: ReplaceTransitGatewayRouteCommandOutput) => void - ): Promise | void { - const command = new ReplaceTransitGatewayRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Trigger replacement of specified VPN tunnel.

- */ - public replaceVpnTunnel( + + /** + * @see {@link ReplaceVpnTunnelCommand} + */ + replaceVpnTunnel( args: ReplaceVpnTunnelCommandInput, options?: __HttpHandlerOptions ): Promise; - public replaceVpnTunnel( + replaceVpnTunnel( args: ReplaceVpnTunnelCommandInput, cb: (err: any, data?: ReplaceVpnTunnelCommandOutput) => void ): void; - public replaceVpnTunnel( + replaceVpnTunnel( args: ReplaceVpnTunnelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReplaceVpnTunnelCommandOutput) => void ): void; - public replaceVpnTunnel( - args: ReplaceVpnTunnelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReplaceVpnTunnelCommandOutput) => void), - cb?: (err: any, data?: ReplaceVpnTunnelCommandOutput) => void - ): Promise | void { - const command = new ReplaceVpnTunnelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Submits feedback about the status of an instance. The instance must be in the - * running state. If your experience with the instance differs from the - * instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon - * EC2 collects this information to improve the accuracy of status checks.

- *

Use of this action does not change the value returned by DescribeInstanceStatus.

- */ - public reportInstanceStatus( + + /** + * @see {@link ReportInstanceStatusCommand} + */ + reportInstanceStatus( args: ReportInstanceStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public reportInstanceStatus( + reportInstanceStatus( args: ReportInstanceStatusCommandInput, cb: (err: any, data?: ReportInstanceStatusCommandOutput) => void ): void; - public reportInstanceStatus( + reportInstanceStatus( args: ReportInstanceStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReportInstanceStatusCommandOutput) => void ): void; - public reportInstanceStatus( - args: ReportInstanceStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReportInstanceStatusCommandOutput) => void), - cb?: (err: any, data?: ReportInstanceStatusCommandOutput) => void - ): Promise | void { - const command = new ReportInstanceStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Spot Fleet request.

- *

The Spot Fleet request specifies the total target capacity and the On-Demand target - * capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand - * capacity, and launches the difference as Spot capacity.

- *

You can submit a single request that includes multiple launch specifications that vary - * by instance type, AMI, Availability Zone, or subnet.

- *

By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the - * price per unit is the lowest. Each launch specification can include its own instance - * weighting that reflects the value of the instance type to your application - * workload.

- *

Alternatively, you can specify that the Spot Fleet distribute the target capacity - * across the Spot pools included in its launch specifications. By ensuring that the Spot - * Instances in your Spot Fleet are in different Spot pools, you can improve the - * availability of your fleet.

- *

You can specify tags for the Spot Fleet request and instances launched by the fleet. - * You cannot tag other resource types in a Spot Fleet request because only the - * spot-fleet-request and instance resource types are - * supported.

- *

For more information, see Spot Fleet requests - * in the Amazon EC2 User Guide.

- * - *

We strongly discourage using the RequestSpotFleet API because it is a legacy - * API with no planned investment. For options for requesting Spot Instances, see - * Which - * is the best Spot request method to use? in the - * Amazon EC2 User Guide.

- *
- */ - public requestSpotFleet( + + /** + * @see {@link RequestSpotFleetCommand} + */ + requestSpotFleet( args: RequestSpotFleetCommandInput, options?: __HttpHandlerOptions ): Promise; - public requestSpotFleet( + requestSpotFleet( args: RequestSpotFleetCommandInput, cb: (err: any, data?: RequestSpotFleetCommandOutput) => void ): void; - public requestSpotFleet( + requestSpotFleet( args: RequestSpotFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RequestSpotFleetCommandOutput) => void ): void; - public requestSpotFleet( - args: RequestSpotFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RequestSpotFleetCommandOutput) => void), - cb?: (err: any, data?: RequestSpotFleetCommandOutput) => void - ): Promise | void { - const command = new RequestSpotFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Spot Instance request.

- *

For more information, see Spot Instance requests in - * the Amazon EC2 User Guide for Linux Instances.

- * - *

We strongly discourage using the RequestSpotInstances API because it is a legacy - * API with no planned investment. For options for requesting Spot Instances, see - * Which - * is the best Spot request method to use? in the - * Amazon EC2 User Guide for Linux Instances.

- *
- * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide for Linux Instances.

- *
- */ - public requestSpotInstances( + + /** + * @see {@link RequestSpotInstancesCommand} + */ + requestSpotInstances( args: RequestSpotInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public requestSpotInstances( + requestSpotInstances( args: RequestSpotInstancesCommandInput, cb: (err: any, data?: RequestSpotInstancesCommandOutput) => void ): void; - public requestSpotInstances( + requestSpotInstances( args: RequestSpotInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RequestSpotInstancesCommandOutput) => void ): void; - public requestSpotInstances( - args: RequestSpotInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RequestSpotInstancesCommandOutput) => void), - cb?: (err: any, data?: RequestSpotInstancesCommandOutput) => void - ): Promise | void { - const command = new RequestSpotInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Resets the attribute of the specified IP address. For requirements, see Using reverse DNS for email applications.

- */ - public resetAddressAttribute( + + /** + * @see {@link ResetAddressAttributeCommand} + */ + resetAddressAttribute( args: ResetAddressAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetAddressAttribute( + resetAddressAttribute( args: ResetAddressAttributeCommandInput, cb: (err: any, data?: ResetAddressAttributeCommandOutput) => void ): void; - public resetAddressAttribute( + resetAddressAttribute( args: ResetAddressAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetAddressAttributeCommandOutput) => void ): void; - public resetAddressAttribute( - args: ResetAddressAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetAddressAttributeCommandOutput) => void), - cb?: (err: any, data?: ResetAddressAttributeCommandOutput) => void - ): Promise | void { - const command = new ResetAddressAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Resets the default KMS key for EBS encryption for your account in this Region - * to the Amazon Web Services managed KMS key for EBS.

- *

After resetting the default KMS key to the Amazon Web Services managed KMS key, you can continue to encrypt by a - * customer managed KMS key by specifying it when you create the volume. For more information, see - * Amazon EBS encryption - * in the Amazon Elastic Compute Cloud User Guide.

- */ - public resetEbsDefaultKmsKeyId( + + /** + * @see {@link ResetEbsDefaultKmsKeyIdCommand} + */ + resetEbsDefaultKmsKeyId( args: ResetEbsDefaultKmsKeyIdCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetEbsDefaultKmsKeyId( + resetEbsDefaultKmsKeyId( args: ResetEbsDefaultKmsKeyIdCommandInput, cb: (err: any, data?: ResetEbsDefaultKmsKeyIdCommandOutput) => void ): void; - public resetEbsDefaultKmsKeyId( + resetEbsDefaultKmsKeyId( args: ResetEbsDefaultKmsKeyIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetEbsDefaultKmsKeyIdCommandOutput) => void ): void; - public resetEbsDefaultKmsKeyId( - args: ResetEbsDefaultKmsKeyIdCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetEbsDefaultKmsKeyIdCommandOutput) => void), - cb?: (err: any, data?: ResetEbsDefaultKmsKeyIdCommandOutput) => void - ): Promise | void { - const command = new ResetEbsDefaultKmsKeyIdCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. - * You can only reset the load permission attribute.

- */ - public resetFpgaImageAttribute( + + /** + * @see {@link ResetFpgaImageAttributeCommand} + */ + resetFpgaImageAttribute( args: ResetFpgaImageAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetFpgaImageAttribute( + resetFpgaImageAttribute( args: ResetFpgaImageAttributeCommandInput, cb: (err: any, data?: ResetFpgaImageAttributeCommandOutput) => void ): void; - public resetFpgaImageAttribute( + resetFpgaImageAttribute( args: ResetFpgaImageAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetFpgaImageAttributeCommandOutput) => void ): void; - public resetFpgaImageAttribute( - args: ResetFpgaImageAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetFpgaImageAttributeCommandOutput) => void), - cb?: (err: any, data?: ResetFpgaImageAttributeCommandOutput) => void - ): Promise | void { - const command = new ResetFpgaImageAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Resets an attribute of an AMI to its default value.

- */ - public resetImageAttribute( + + /** + * @see {@link ResetImageAttributeCommand} + */ + resetImageAttribute( args: ResetImageAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetImageAttribute( + resetImageAttribute( args: ResetImageAttributeCommandInput, cb: (err: any, data?: ResetImageAttributeCommandOutput) => void ): void; - public resetImageAttribute( + resetImageAttribute( args: ResetImageAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetImageAttributeCommandOutput) => void ): void; - public resetImageAttribute( - args: ResetImageAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetImageAttributeCommandOutput) => void), - cb?: (err: any, data?: ResetImageAttributeCommandOutput) => void - ): Promise | void { - const command = new ResetImageAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Resets an attribute of an instance to its default value. To reset the - * kernel or ramdisk, the instance must be in a stopped - * state. To reset the sourceDestCheck, the instance can be either running or - * stopped.

- *

The sourceDestCheck attribute controls whether source/destination - * checking is enabled. The default value is true, which means checking is - * enabled. This value must be false for a NAT instance to perform NAT. For - * more information, see NAT Instances in the - * Amazon VPC User Guide.

- */ - public resetInstanceAttribute( + + /** + * @see {@link ResetInstanceAttributeCommand} + */ + resetInstanceAttribute( args: ResetInstanceAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetInstanceAttribute( + resetInstanceAttribute( args: ResetInstanceAttributeCommandInput, cb: (err: any, data?: ResetInstanceAttributeCommandOutput) => void ): void; - public resetInstanceAttribute( + resetInstanceAttribute( args: ResetInstanceAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetInstanceAttributeCommandOutput) => void ): void; - public resetInstanceAttribute( - args: ResetInstanceAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetInstanceAttributeCommandOutput) => void), - cb?: (err: any, data?: ResetInstanceAttributeCommandOutput) => void - ): Promise | void { - const command = new ResetInstanceAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Resets a network interface attribute. You can specify only one attribute at a time.

- */ - public resetNetworkInterfaceAttribute( + + /** + * @see {@link ResetNetworkInterfaceAttributeCommand} + */ + resetNetworkInterfaceAttribute( args: ResetNetworkInterfaceAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetNetworkInterfaceAttribute( + resetNetworkInterfaceAttribute( args: ResetNetworkInterfaceAttributeCommandInput, cb: (err: any, data?: ResetNetworkInterfaceAttributeCommandOutput) => void ): void; - public resetNetworkInterfaceAttribute( + resetNetworkInterfaceAttribute( args: ResetNetworkInterfaceAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetNetworkInterfaceAttributeCommandOutput) => void ): void; - public resetNetworkInterfaceAttribute( - args: ResetNetworkInterfaceAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetNetworkInterfaceAttributeCommandOutput) => void), - cb?: (err: any, data?: ResetNetworkInterfaceAttributeCommandOutput) => void - ): Promise | void { - const command = new ResetNetworkInterfaceAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Resets permission settings for the specified snapshot.

- *

For more information about modifying snapshot permissions, see Share a snapshot in the - * Amazon Elastic Compute Cloud User Guide.

- */ - public resetSnapshotAttribute( + + /** + * @see {@link ResetSnapshotAttributeCommand} + */ + resetSnapshotAttribute( args: ResetSnapshotAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetSnapshotAttribute( + resetSnapshotAttribute( args: ResetSnapshotAttributeCommandInput, cb: (err: any, data?: ResetSnapshotAttributeCommandOutput) => void ): void; - public resetSnapshotAttribute( + resetSnapshotAttribute( args: ResetSnapshotAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetSnapshotAttributeCommandOutput) => void ): void; - public resetSnapshotAttribute( - args: ResetSnapshotAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetSnapshotAttributeCommandOutput) => void), - cb?: (err: any, data?: ResetSnapshotAttributeCommandOutput) => void - ): Promise | void { - const command = new ResetSnapshotAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.

- * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- */ - public restoreAddressToClassic( + + /** + * @see {@link RestoreAddressToClassicCommand} + */ + restoreAddressToClassic( args: RestoreAddressToClassicCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreAddressToClassic( + restoreAddressToClassic( args: RestoreAddressToClassicCommandInput, cb: (err: any, data?: RestoreAddressToClassicCommandOutput) => void ): void; - public restoreAddressToClassic( + restoreAddressToClassic( args: RestoreAddressToClassicCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreAddressToClassicCommandOutput) => void ): void; - public restoreAddressToClassic( - args: RestoreAddressToClassicCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreAddressToClassicCommandOutput) => void), - cb?: (err: any, data?: RestoreAddressToClassicCommandOutput) => void - ): Promise | void { - const command = new RestoreAddressToClassicCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.

- */ - public restoreImageFromRecycleBin( + + /** + * @see {@link RestoreImageFromRecycleBinCommand} + */ + restoreImageFromRecycleBin( args: RestoreImageFromRecycleBinCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreImageFromRecycleBin( + restoreImageFromRecycleBin( args: RestoreImageFromRecycleBinCommandInput, cb: (err: any, data?: RestoreImageFromRecycleBinCommandOutput) => void ): void; - public restoreImageFromRecycleBin( + restoreImageFromRecycleBin( args: RestoreImageFromRecycleBinCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreImageFromRecycleBinCommandOutput) => void ): void; - public restoreImageFromRecycleBin( - args: RestoreImageFromRecycleBinCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreImageFromRecycleBinCommandOutput) => void), - cb?: (err: any, data?: RestoreImageFromRecycleBinCommandOutput) => void - ): Promise | void { - const command = new RestoreImageFromRecycleBinCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.

- */ - public restoreManagedPrefixListVersion( + + /** + * @see {@link RestoreManagedPrefixListVersionCommand} + */ + restoreManagedPrefixListVersion( args: RestoreManagedPrefixListVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreManagedPrefixListVersion( + restoreManagedPrefixListVersion( args: RestoreManagedPrefixListVersionCommandInput, cb: (err: any, data?: RestoreManagedPrefixListVersionCommandOutput) => void ): void; - public restoreManagedPrefixListVersion( + restoreManagedPrefixListVersion( args: RestoreManagedPrefixListVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreManagedPrefixListVersionCommandOutput) => void ): void; - public restoreManagedPrefixListVersion( - args: RestoreManagedPrefixListVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreManagedPrefixListVersionCommandOutput) => void), - cb?: (err: any, data?: RestoreManagedPrefixListVersionCommandOutput) => void - ): Promise | void { - const command = new RestoreManagedPrefixListVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Restores a snapshot from the Recycle Bin. For more information, see Restore - * snapshots from the Recycle Bin in the Amazon Elastic Compute Cloud User Guide.

- */ - public restoreSnapshotFromRecycleBin( + + /** + * @see {@link RestoreSnapshotFromRecycleBinCommand} + */ + restoreSnapshotFromRecycleBin( args: RestoreSnapshotFromRecycleBinCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreSnapshotFromRecycleBin( + restoreSnapshotFromRecycleBin( args: RestoreSnapshotFromRecycleBinCommandInput, cb: (err: any, data?: RestoreSnapshotFromRecycleBinCommandOutput) => void ): void; - public restoreSnapshotFromRecycleBin( + restoreSnapshotFromRecycleBin( args: RestoreSnapshotFromRecycleBinCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreSnapshotFromRecycleBinCommandOutput) => void ): void; - public restoreSnapshotFromRecycleBin( - args: RestoreSnapshotFromRecycleBinCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreSnapshotFromRecycleBinCommandOutput) => void), - cb?: (err: any, data?: RestoreSnapshotFromRecycleBinCommandOutput) => void - ): Promise | void { - const command = new RestoreSnapshotFromRecycleBinCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore - * period or restore type for a snapshot that was previously temporarily restored.

- *

For more information see - * Restore an archived snapshot and - * modify the restore period or restore type for a temporarily restored snapshot in the Amazon Elastic Compute Cloud User Guide.

- */ - public restoreSnapshotTier( + + /** + * @see {@link RestoreSnapshotTierCommand} + */ + restoreSnapshotTier( args: RestoreSnapshotTierCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreSnapshotTier( + restoreSnapshotTier( args: RestoreSnapshotTierCommandInput, cb: (err: any, data?: RestoreSnapshotTierCommandOutput) => void ): void; - public restoreSnapshotTier( + restoreSnapshotTier( args: RestoreSnapshotTierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreSnapshotTierCommandOutput) => void ): void; - public restoreSnapshotTier( - args: RestoreSnapshotTierCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreSnapshotTierCommandOutput) => void), - cb?: (err: any, data?: RestoreSnapshotTierCommandOutput) => void - ): Promise | void { - const command = new RestoreSnapshotTierCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes an ingress authorization rule from a Client VPN endpoint.

- */ - public revokeClientVpnIngress( + + /** + * @see {@link RevokeClientVpnIngressCommand} + */ + revokeClientVpnIngress( args: RevokeClientVpnIngressCommandInput, options?: __HttpHandlerOptions ): Promise; - public revokeClientVpnIngress( + revokeClientVpnIngress( args: RevokeClientVpnIngressCommandInput, cb: (err: any, data?: RevokeClientVpnIngressCommandOutput) => void ): void; - public revokeClientVpnIngress( + revokeClientVpnIngress( args: RevokeClientVpnIngressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeClientVpnIngressCommandOutput) => void ): void; - public revokeClientVpnIngress( - args: RevokeClientVpnIngressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RevokeClientVpnIngressCommandOutput) => void), - cb?: (err: any, data?: RevokeClientVpnIngressCommandOutput) => void - ): Promise | void { - const command = new RevokeClientVpnIngressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

[VPC only] Removes the specified outbound (egress) rules from a security group for EC2-VPC. - * This action does not apply to security groups for use in EC2-Classic.

- *

You can specify rules using either rule IDs or security group rule properties. If you use - * rule properties, the values that you specify (for example, ports) must match the existing rule's - * values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, - * security group, or prefix list). For the TCP and UDP protocols, you must also specify the - * destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type - * and code. If the security group rule has a description, you do not need to specify the description - * to revoke the rule.

- *

[Default VPC] If the values you specify do not match the existing rule's values, no error is - * returned, and the output describes the security group rules that were not revoked.

- *

Amazon Web Services recommends that you describe the security group to verify that the rules were removed.

- *

Rule changes are propagated to instances within the security group as quickly as possible. However, - * a small delay might occur.

- */ - public revokeSecurityGroupEgress( + + /** + * @see {@link RevokeSecurityGroupEgressCommand} + */ + revokeSecurityGroupEgress( args: RevokeSecurityGroupEgressCommandInput, options?: __HttpHandlerOptions ): Promise; - public revokeSecurityGroupEgress( + revokeSecurityGroupEgress( args: RevokeSecurityGroupEgressCommandInput, cb: (err: any, data?: RevokeSecurityGroupEgressCommandOutput) => void ): void; - public revokeSecurityGroupEgress( + revokeSecurityGroupEgress( args: RevokeSecurityGroupEgressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeSecurityGroupEgressCommandOutput) => void ): void; - public revokeSecurityGroupEgress( - args: RevokeSecurityGroupEgressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RevokeSecurityGroupEgressCommandOutput) => void), - cb?: (err: any, data?: RevokeSecurityGroupEgressCommandOutput) => void - ): Promise | void { - const command = new RevokeSecurityGroupEgressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the specified inbound (ingress) rules from a security group.

- *

You can specify rules using either rule IDs or security group rule properties. If you use - * rule properties, the values that you specify (for example, ports) must match the existing rule's - * values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, - * security group, or prefix list). For the TCP and UDP protocols, you must also specify the - * destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type - * and code. If the security group rule has a description, you do not need to specify the description - * to revoke the rule.

- *

[EC2-Classic, default VPC] If the values you specify do not match the existing rule's values, no error is - * returned, and the output describes the security group rules that were not revoked.

- *

Amazon Web Services recommends that you describe the security group to verify that the rules were removed.

- *

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

- * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

- *
- */ - public revokeSecurityGroupIngress( + + /** + * @see {@link RevokeSecurityGroupIngressCommand} + */ + revokeSecurityGroupIngress( args: RevokeSecurityGroupIngressCommandInput, options?: __HttpHandlerOptions ): Promise; - public revokeSecurityGroupIngress( + revokeSecurityGroupIngress( args: RevokeSecurityGroupIngressCommandInput, cb: (err: any, data?: RevokeSecurityGroupIngressCommandOutput) => void ): void; - public revokeSecurityGroupIngress( + revokeSecurityGroupIngress( args: RevokeSecurityGroupIngressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeSecurityGroupIngressCommandOutput) => void ): void; - public revokeSecurityGroupIngress( - args: RevokeSecurityGroupIngressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RevokeSecurityGroupIngressCommandOutput) => void), - cb?: (err: any, data?: RevokeSecurityGroupIngressCommandOutput) => void - ): Promise | void { - const command = new RevokeSecurityGroupIngressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Launches the specified number of instances using an AMI for which you have - * permissions.

- *

You can specify a number of options, or leave the default options. The following rules - * apply:

- *
    - *
  • - *

    [EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from - * your default VPC for you. If you don't have a default VPC, you must specify a - * subnet ID in the request.

    - *
  • - *
  • - *

    [EC2-Classic] If don't specify an Availability Zone, we choose one for - * you.

    - *
  • - *
  • - *

    Some instance types must be launched into a VPC. If you do not have a default - * VPC, or if you do not specify a subnet ID, the request fails. For more - * information, see Instance types available only in a VPC.

    - *
  • - *
  • - *

    [EC2-VPC] All instances have a network interface with a primary private IPv4 - * address. If you don't specify this address, we choose one from the IPv4 range of - * your subnet.

    - *
  • - *
  • - *

    Not all instance types support IPv6 addresses. For more information, see - * Instance - * types.

    - *
  • - *
  • - *

    If you don't specify a security group ID, we use the default security group. - * For more information, see Security - * groups.

    - *
  • - *
  • - *

    If any of the AMIs have a product code attached for which the user has not - * subscribed, the request fails.

    - *
  • - *
- *

You can create a launch template, - * which is a resource that contains the parameters to launch an instance. When you launch - * an instance using RunInstances, you can specify the launch template - * instead of specifying the launch parameters.

- *

To ensure faster instance launches, break up large requests into smaller batches. For - * example, create five separate launch requests for 100 instances each instead of one - * launch request for 500 instances.

- *

An instance is ready for you to use when it's in the running state. You - * can check the state of your instance using DescribeInstances. You can - * tag instances and EBS volumes during launch, after launch, or both. For more - * information, see CreateTags and Tagging your Amazon EC2 - * resources.

- *

Linux instances have access to the public key of the key pair at boot. You can use - * this key to provide secure access to the instance. Amazon EC2 public images use this - * feature to provide secure access without passwords. For more information, see Key - * pairs.

- *

For troubleshooting, see What to do if - * an instance immediately terminates, and Troubleshooting connecting to your instance.

- * - *

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a - * VPC. For more information, see Migrate from EC2-Classic to a - * VPC in the Amazon EC2 User Guide.

- *
- */ - public runInstances( - args: RunInstancesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public runInstances(args: RunInstancesCommandInput, cb: (err: any, data?: RunInstancesCommandOutput) => void): void; - public runInstances( + + /** + * @see {@link RunInstancesCommand} + */ + runInstances(args: RunInstancesCommandInput, options?: __HttpHandlerOptions): Promise; + runInstances(args: RunInstancesCommandInput, cb: (err: any, data?: RunInstancesCommandOutput) => void): void; + runInstances( args: RunInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RunInstancesCommandOutput) => void ): void; - public runInstances( - args: RunInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RunInstancesCommandOutput) => void), - cb?: (err: any, data?: RunInstancesCommandOutput) => void - ): Promise | void { - const command = new RunInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Launches the specified Scheduled Instances.

- *

Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.

- *

You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, - * but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, - * you can launch it again after a few minutes. For more information, see Scheduled Instances - * in the Amazon EC2 User Guide.

- */ - public runScheduledInstances( + + /** + * @see {@link RunScheduledInstancesCommand} + */ + runScheduledInstances( args: RunScheduledInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public runScheduledInstances( + runScheduledInstances( args: RunScheduledInstancesCommandInput, cb: (err: any, data?: RunScheduledInstancesCommandOutput) => void ): void; - public runScheduledInstances( + runScheduledInstances( args: RunScheduledInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RunScheduledInstancesCommandOutput) => void ): void; - public runScheduledInstances( - args: RunScheduledInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RunScheduledInstancesCommandOutput) => void), - cb?: (err: any, data?: RunScheduledInstancesCommandOutput) => void - ): Promise | void { - const command = new RunScheduledInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Searches for routes in the specified local gateway route table.

- */ - public searchLocalGatewayRoutes( + + /** + * @see {@link SearchLocalGatewayRoutesCommand} + */ + searchLocalGatewayRoutes( args: SearchLocalGatewayRoutesCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchLocalGatewayRoutes( + searchLocalGatewayRoutes( args: SearchLocalGatewayRoutesCommandInput, cb: (err: any, data?: SearchLocalGatewayRoutesCommandOutput) => void ): void; - public searchLocalGatewayRoutes( + searchLocalGatewayRoutes( args: SearchLocalGatewayRoutesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchLocalGatewayRoutesCommandOutput) => void ): void; - public searchLocalGatewayRoutes( - args: SearchLocalGatewayRoutesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchLocalGatewayRoutesCommandOutput) => void), - cb?: (err: any, data?: SearchLocalGatewayRoutesCommandOutput) => void - ): Promise | void { - const command = new SearchLocalGatewayRoutesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Searches one or more transit gateway multicast groups and returns the group membership information.

- */ - public searchTransitGatewayMulticastGroups( + + /** + * @see {@link SearchTransitGatewayMulticastGroupsCommand} + */ + searchTransitGatewayMulticastGroups( args: SearchTransitGatewayMulticastGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchTransitGatewayMulticastGroups( + searchTransitGatewayMulticastGroups( args: SearchTransitGatewayMulticastGroupsCommandInput, cb: (err: any, data?: SearchTransitGatewayMulticastGroupsCommandOutput) => void ): void; - public searchTransitGatewayMulticastGroups( + searchTransitGatewayMulticastGroups( args: SearchTransitGatewayMulticastGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchTransitGatewayMulticastGroupsCommandOutput) => void ): void; - public searchTransitGatewayMulticastGroups( - args: SearchTransitGatewayMulticastGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchTransitGatewayMulticastGroupsCommandOutput) => void), - cb?: (err: any, data?: SearchTransitGatewayMulticastGroupsCommandOutput) => void - ): Promise | void { - const command = new SearchTransitGatewayMulticastGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Searches for routes in the specified transit gateway route table.

- */ - public searchTransitGatewayRoutes( + + /** + * @see {@link SearchTransitGatewayRoutesCommand} + */ + searchTransitGatewayRoutes( args: SearchTransitGatewayRoutesCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchTransitGatewayRoutes( + searchTransitGatewayRoutes( args: SearchTransitGatewayRoutesCommandInput, cb: (err: any, data?: SearchTransitGatewayRoutesCommandOutput) => void ): void; - public searchTransitGatewayRoutes( + searchTransitGatewayRoutes( args: SearchTransitGatewayRoutesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchTransitGatewayRoutesCommandOutput) => void ): void; - public searchTransitGatewayRoutes( - args: SearchTransitGatewayRoutesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchTransitGatewayRoutesCommandOutput) => void), - cb?: (err: any, data?: SearchTransitGatewayRoutesCommandOutput) => void - ): Promise | void { - const command = new SearchTransitGatewayRoutesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a - * kernel panic (on Linux instances), or a blue - * screen/stop error (on Windows instances). For - * instances based on Intel and AMD processors, the interrupt is received as a - * non-maskable interrupt (NMI).

- *

In general, the operating system crashes and reboots when a kernel panic or stop error - * is triggered. The operating system can also be configured to perform diagnostic tasks, - * such as generating a memory dump file, loading a secondary kernel, or obtaining a call - * trace.

- *

Before sending a diagnostic interrupt to your instance, ensure that its operating - * system is configured to perform the required diagnostic tasks.

- *

For more information about configuring your operating system to generate a crash dump - * when a kernel panic or stop error occurs, see Send a diagnostic interrupt - * (for advanced users) (Linux instances) or Send a diagnostic - * interrupt (for advanced users) (Windows instances).

- */ - public sendDiagnosticInterrupt( + + /** + * @see {@link SendDiagnosticInterruptCommand} + */ + sendDiagnosticInterrupt( args: SendDiagnosticInterruptCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendDiagnosticInterrupt( + sendDiagnosticInterrupt( args: SendDiagnosticInterruptCommandInput, cb: (err: any, data?: SendDiagnosticInterruptCommandOutput) => void ): void; - public sendDiagnosticInterrupt( + sendDiagnosticInterrupt( args: SendDiagnosticInterruptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendDiagnosticInterruptCommandOutput) => void ): void; - public sendDiagnosticInterrupt( - args: SendDiagnosticInterruptCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendDiagnosticInterruptCommandOutput) => void), - cb?: (err: any, data?: SendDiagnosticInterruptCommandOutput) => void - ): Promise | void { - const command = new SendDiagnosticInterruptCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts an Amazon EBS-backed instance that you've previously stopped.

- *

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and - * started. When an instance is stopped, the compute resources are released and you are not - * billed for instance usage. However, your root partition Amazon EBS volume remains and - * continues to persist your data, and you are charged for Amazon EBS volume usage. You can - * restart your instance at any time. Every time you start your instance, Amazon EC2 - * charges a one-minute minimum for instance usage, and thereafter charges per second for - * instance usage.

- *

Before stopping an instance, make sure it is in a state from which it can be - * restarted. Stopping an instance does not preserve data stored in RAM.

- *

Performing this operation on an instance that uses an instance store as its root - * device returns an error.

- *

If you attempt to start a T3 instance with host tenancy and the - * unlimted CPU credit option, the request fails. The - * unlimited CPU credit option is not supported on Dedicated Hosts. Before - * you start the instance, either change its CPU credit option to standard, or - * change its tenancy to default or dedicated.

- *

For more information, see Stop and start your instance - * in the Amazon EC2 User Guide.

- */ - public startInstances( + + /** + * @see {@link StartInstancesCommand} + */ + startInstances( args: StartInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public startInstances( - args: StartInstancesCommandInput, - cb: (err: any, data?: StartInstancesCommandOutput) => void - ): void; - public startInstances( + startInstances(args: StartInstancesCommandInput, cb: (err: any, data?: StartInstancesCommandOutput) => void): void; + startInstances( args: StartInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartInstancesCommandOutput) => void ): void; - public startInstances( - args: StartInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartInstancesCommandOutput) => void), - cb?: (err: any, data?: StartInstancesCommandOutput) => void - ): Promise | void { - const command = new StartInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts analyzing the specified Network Access Scope.

- */ - public startNetworkInsightsAccessScopeAnalysis( + + /** + * @see {@link StartNetworkInsightsAccessScopeAnalysisCommand} + */ + startNetworkInsightsAccessScopeAnalysis( args: StartNetworkInsightsAccessScopeAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public startNetworkInsightsAccessScopeAnalysis( + startNetworkInsightsAccessScopeAnalysis( args: StartNetworkInsightsAccessScopeAnalysisCommandInput, cb: (err: any, data?: StartNetworkInsightsAccessScopeAnalysisCommandOutput) => void ): void; - public startNetworkInsightsAccessScopeAnalysis( + startNetworkInsightsAccessScopeAnalysis( args: StartNetworkInsightsAccessScopeAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartNetworkInsightsAccessScopeAnalysisCommandOutput) => void ): void; - public startNetworkInsightsAccessScopeAnalysis( - args: StartNetworkInsightsAccessScopeAnalysisCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: StartNetworkInsightsAccessScopeAnalysisCommandOutput) => void), - cb?: (err: any, data?: StartNetworkInsightsAccessScopeAnalysisCommandOutput) => void - ): Promise | void { - const command = new StartNetworkInsightsAccessScopeAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts analyzing the specified path. If the path is reachable, the - * operation returns the shortest feasible path.

- */ - public startNetworkInsightsAnalysis( + + /** + * @see {@link StartNetworkInsightsAnalysisCommand} + */ + startNetworkInsightsAnalysis( args: StartNetworkInsightsAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public startNetworkInsightsAnalysis( + startNetworkInsightsAnalysis( args: StartNetworkInsightsAnalysisCommandInput, cb: (err: any, data?: StartNetworkInsightsAnalysisCommandOutput) => void ): void; - public startNetworkInsightsAnalysis( + startNetworkInsightsAnalysis( args: StartNetworkInsightsAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartNetworkInsightsAnalysisCommandOutput) => void ): void; - public startNetworkInsightsAnalysis( - args: StartNetworkInsightsAnalysisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartNetworkInsightsAnalysisCommandOutput) => void), - cb?: (err: any, data?: StartNetworkInsightsAnalysisCommandOutput) => void - ): Promise | void { - const command = new StartNetworkInsightsAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Initiates the verification process to prove that the service provider owns the private - * DNS name domain for the endpoint service.

- *

The service provider must successfully perform the verification before the consumer can use the name to access the service.

- *

Before the service provider runs this command, they must add a record to the DNS server.

- */ - public startVpcEndpointServicePrivateDnsVerification( + + /** + * @see {@link StartVpcEndpointServicePrivateDnsVerificationCommand} + */ + startVpcEndpointServicePrivateDnsVerification( args: StartVpcEndpointServicePrivateDnsVerificationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startVpcEndpointServicePrivateDnsVerification( + startVpcEndpointServicePrivateDnsVerification( args: StartVpcEndpointServicePrivateDnsVerificationCommandInput, cb: (err: any, data?: StartVpcEndpointServicePrivateDnsVerificationCommandOutput) => void ): void; - public startVpcEndpointServicePrivateDnsVerification( + startVpcEndpointServicePrivateDnsVerification( args: StartVpcEndpointServicePrivateDnsVerificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartVpcEndpointServicePrivateDnsVerificationCommandOutput) => void ): void; - public startVpcEndpointServicePrivateDnsVerification( - args: StartVpcEndpointServicePrivateDnsVerificationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: StartVpcEndpointServicePrivateDnsVerificationCommandOutput) => void), - cb?: (err: any, data?: StartVpcEndpointServicePrivateDnsVerificationCommandOutput) => void - ): Promise | void { - const command = new StartVpcEndpointServicePrivateDnsVerificationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops an Amazon EBS-backed instance. For more information, see Stop and start - * your instance in the Amazon EC2 User Guide.

- *

You can use the Stop action to hibernate an instance if the instance is enabled for - * hibernation and it meets the hibernation - * prerequisites. For more information, see Hibernate your instance in the - * Amazon EC2 User Guide.

- *

We don't charge usage for a stopped instance, or data transfer fees; however, your - * root partition Amazon EBS volume remains and continues to persist your data, and you are - * charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 - * charges a one-minute minimum for instance usage, and thereafter charges per second for - * instance usage.

- *

You can't stop or hibernate instance store-backed instances. You can't use the Stop - * action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate - * Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the - * Amazon EC2 User Guide.

- *

When you stop or hibernate an instance, we shut it down. You can restart your instance - * at any time. Before stopping or hibernating an instance, make sure it is in a state from - * which it can be restarted. Stopping an instance does not preserve data stored in RAM, - * but hibernating an instance does preserve data stored in RAM. If an instance cannot - * hibernate successfully, a normal shutdown occurs.

- *

Stopping and hibernating an instance is different to rebooting or terminating it. For - * example, when you stop or hibernate an instance, the root device and any other devices - * attached to the instance persist. When you terminate an instance, the root device and - * any other devices attached during the instance launch are automatically deleted. For - * more information about the differences between rebooting, stopping, hibernating, and - * terminating instances, see Instance lifecycle - * in the Amazon EC2 User Guide.

- *

When you stop an instance, we attempt to shut it down forcibly after a short while. If - * your instance appears stuck in the stopping state after a period of time, there may be - * an issue with the underlying host computer. For more information, see Troubleshoot - * stopping your instance in the Amazon EC2 User Guide.

- */ - public stopInstances( - args: StopInstancesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public stopInstances( - args: StopInstancesCommandInput, - cb: (err: any, data?: StopInstancesCommandOutput) => void - ): void; - public stopInstances( + + /** + * @see {@link StopInstancesCommand} + */ + stopInstances(args: StopInstancesCommandInput, options?: __HttpHandlerOptions): Promise; + stopInstances(args: StopInstancesCommandInput, cb: (err: any, data?: StopInstancesCommandOutput) => void): void; + stopInstances( args: StopInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopInstancesCommandOutput) => void ): void; - public stopInstances( - args: StopInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopInstancesCommandOutput) => void), - cb?: (err: any, data?: StopInstancesCommandOutput) => void - ): Promise | void { - const command = new StopInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user.

- */ - public terminateClientVpnConnections( + + /** + * @see {@link TerminateClientVpnConnectionsCommand} + */ + terminateClientVpnConnections( args: TerminateClientVpnConnectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public terminateClientVpnConnections( + terminateClientVpnConnections( args: TerminateClientVpnConnectionsCommandInput, cb: (err: any, data?: TerminateClientVpnConnectionsCommandOutput) => void ): void; - public terminateClientVpnConnections( + terminateClientVpnConnections( args: TerminateClientVpnConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TerminateClientVpnConnectionsCommandOutput) => void ): void; - public terminateClientVpnConnections( - args: TerminateClientVpnConnectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TerminateClientVpnConnectionsCommandOutput) => void), - cb?: (err: any, data?: TerminateClientVpnConnectionsCommandOutput) => void - ): Promise | void { - const command = new TerminateClientVpnConnectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Shuts down the specified instances. This operation is idempotent; if you terminate an - * instance more than once, each call succeeds.

- *

If you specify multiple instances and the request fails (for example, because of a - * single incorrect instance ID), none of the instances are terminated.

- *

If you terminate multiple instances across multiple Availability Zones, and one or - * more of the specified instances are enabled for termination protection, the request - * fails with the following results:

- *
    - *
  • - *

    The specified instances that are in the same Availability Zone as the - * protected instance are not terminated.

    - *
  • - *
  • - *

    The specified instances that are in different Availability Zones, where no - * other specified instances are protected, are successfully terminated.

    - *
  • - *
- *

For example, say you have the following instances:

- *
    - *
  • - *

    Instance A: us-east-1a; Not protected

    - *
  • - *
  • - *

    Instance B: us-east-1a; Not protected

    - *
  • - *
  • - *

    Instance C: us-east-1b; Protected

    - *
  • - *
  • - *

    Instance D: us-east-1b; not protected

    - *
  • - *
- *

If you attempt to terminate all of these instances in the same request, the request - * reports failure with the following results:

- *
    - *
  • - *

    Instance A and Instance B are successfully terminated because none of the - * specified instances in us-east-1a are enabled for termination - * protection.

    - *
  • - *
  • - *

    Instance C and Instance D fail to terminate because at least one of the - * specified instances in us-east-1b (Instance C) is enabled for - * termination protection.

    - *
  • - *
- *

Terminated instances remain visible after termination (for approximately one - * hour).

- *

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance - * launched. Volumes attached after instance launch continue running.

- *

You can stop, start, and terminate EBS-backed instances. You can only terminate - * instance store-backed instances. What happens to an instance differs if you stop it or - * terminate it. For example, when you stop an instance, the root device and any other - * devices attached to the instance persist. When you terminate an instance, any attached - * EBS volumes with the DeleteOnTermination block device mapping parameter set - * to true are automatically deleted. For more information about the - * differences between stopping and terminating instances, see Instance lifecycle - * in the Amazon EC2 User Guide.

- *

For more information about troubleshooting, see Troubleshooting terminating your instance in the - * Amazon EC2 User Guide.

- */ - public terminateInstances( + + /** + * @see {@link TerminateInstancesCommand} + */ + terminateInstances( args: TerminateInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public terminateInstances( + terminateInstances( args: TerminateInstancesCommandInput, cb: (err: any, data?: TerminateInstancesCommandOutput) => void ): void; - public terminateInstances( + terminateInstances( args: TerminateInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TerminateInstancesCommandOutput) => void ): void; - public terminateInstances( - args: TerminateInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TerminateInstancesCommandOutput) => void), - cb?: (err: any, data?: TerminateInstancesCommandOutput) => void - ): Promise | void { - const command = new TerminateInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface.

- */ - public unassignIpv6Addresses( + + /** + * @see {@link UnassignIpv6AddressesCommand} + */ + unassignIpv6Addresses( args: UnassignIpv6AddressesCommandInput, options?: __HttpHandlerOptions ): Promise; - public unassignIpv6Addresses( + unassignIpv6Addresses( args: UnassignIpv6AddressesCommandInput, cb: (err: any, data?: UnassignIpv6AddressesCommandOutput) => void ): void; - public unassignIpv6Addresses( + unassignIpv6Addresses( args: UnassignIpv6AddressesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnassignIpv6AddressesCommandOutput) => void ): void; - public unassignIpv6Addresses( - args: UnassignIpv6AddressesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnassignIpv6AddressesCommandOutput) => void), - cb?: (err: any, data?: UnassignIpv6AddressesCommandOutput) => void - ): Promise | void { - const command = new UnassignIpv6AddressesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a - * network interface.

- */ - public unassignPrivateIpAddresses( + + /** + * @see {@link UnassignPrivateIpAddressesCommand} + */ + unassignPrivateIpAddresses( args: UnassignPrivateIpAddressesCommandInput, options?: __HttpHandlerOptions ): Promise; - public unassignPrivateIpAddresses( + unassignPrivateIpAddresses( args: UnassignPrivateIpAddressesCommandInput, cb: (err: any, data?: UnassignPrivateIpAddressesCommandOutput) => void ): void; - public unassignPrivateIpAddresses( + unassignPrivateIpAddresses( args: UnassignPrivateIpAddressesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnassignPrivateIpAddressesCommandOutput) => void ): void; - public unassignPrivateIpAddresses( - args: UnassignPrivateIpAddressesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnassignPrivateIpAddressesCommandOutput) => void), - cb?: (err: any, data?: UnassignPrivateIpAddressesCommandOutput) => void - ): Promise | void { - const command = new UnassignPrivateIpAddressesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Unassigns secondary private IPv4 addresses from a private NAT gateway. You cannot unassign your primary private IP. For more information, see Edit secondary IP address associations in the Amazon Virtual Private Cloud User Guide.

- *

While unassigning is in progress, you cannot assign/unassign additional IP addresses while the connections are being drained. You are, however, allowed to delete the NAT gateway.

- *

A private IP address will only be released at the end of MaxDrainDurationSeconds. The - * private IP addresses stay associated and support the existing connections but do not - * support any new connections (new connections are distributed across the remaining - * assigned private IP address). After the existing connections drain out, the private IP - * addresses get released.

- *

- *

- */ - public unassignPrivateNatGatewayAddress( + + /** + * @see {@link UnassignPrivateNatGatewayAddressCommand} + */ + unassignPrivateNatGatewayAddress( args: UnassignPrivateNatGatewayAddressCommandInput, options?: __HttpHandlerOptions ): Promise; - public unassignPrivateNatGatewayAddress( + unassignPrivateNatGatewayAddress( args: UnassignPrivateNatGatewayAddressCommandInput, cb: (err: any, data?: UnassignPrivateNatGatewayAddressCommandOutput) => void ): void; - public unassignPrivateNatGatewayAddress( + unassignPrivateNatGatewayAddress( args: UnassignPrivateNatGatewayAddressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnassignPrivateNatGatewayAddressCommandOutput) => void ): void; - public unassignPrivateNatGatewayAddress( - args: UnassignPrivateNatGatewayAddressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnassignPrivateNatGatewayAddressCommandOutput) => void), - cb?: (err: any, data?: UnassignPrivateNatGatewayAddressCommandOutput) => void - ): Promise | void { - const command = new UnassignPrivateNatGatewayAddressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables detailed monitoring for a running instance. For more information, see Monitoring - * your instances and volumes in the - * Amazon EC2 User Guide.

- */ - public unmonitorInstances( + + /** + * @see {@link UnmonitorInstancesCommand} + */ + unmonitorInstances( args: UnmonitorInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public unmonitorInstances( + unmonitorInstances( args: UnmonitorInstancesCommandInput, cb: (err: any, data?: UnmonitorInstancesCommandOutput) => void ): void; - public unmonitorInstances( + unmonitorInstances( args: UnmonitorInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnmonitorInstancesCommandOutput) => void ): void; - public unmonitorInstances( - args: UnmonitorInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnmonitorInstancesCommandOutput) => void), - cb?: (err: any, data?: UnmonitorInstancesCommandOutput) => void - ): Promise | void { - const command = new UnmonitorInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

[VPC only] Updates the description of an egress (outbound) security group rule. You - * can replace an existing description, or add a description to a rule that did not have one - * previously. You can remove a description for a security group rule by omitting the - * description parameter in the request.

- */ - public updateSecurityGroupRuleDescriptionsEgress( + + /** + * @see {@link UpdateSecurityGroupRuleDescriptionsEgressCommand} + */ + updateSecurityGroupRuleDescriptionsEgress( args: UpdateSecurityGroupRuleDescriptionsEgressCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSecurityGroupRuleDescriptionsEgress( + updateSecurityGroupRuleDescriptionsEgress( args: UpdateSecurityGroupRuleDescriptionsEgressCommandInput, cb: (err: any, data?: UpdateSecurityGroupRuleDescriptionsEgressCommandOutput) => void ): void; - public updateSecurityGroupRuleDescriptionsEgress( + updateSecurityGroupRuleDescriptionsEgress( args: UpdateSecurityGroupRuleDescriptionsEgressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSecurityGroupRuleDescriptionsEgressCommandOutput) => void ): void; - public updateSecurityGroupRuleDescriptionsEgress( - args: UpdateSecurityGroupRuleDescriptionsEgressCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateSecurityGroupRuleDescriptionsEgressCommandOutput) => void), - cb?: (err: any, data?: UpdateSecurityGroupRuleDescriptionsEgressCommandOutput) => void - ): Promise | void { - const command = new UpdateSecurityGroupRuleDescriptionsEgressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the description of an ingress (inbound) security group rule. You can replace an - * existing description, or add a description to a rule that did not have one previously. - * You can remove a description for a security group rule by omitting the description - * parameter in the request.

- */ - public updateSecurityGroupRuleDescriptionsIngress( + + /** + * @see {@link UpdateSecurityGroupRuleDescriptionsIngressCommand} + */ + updateSecurityGroupRuleDescriptionsIngress( args: UpdateSecurityGroupRuleDescriptionsIngressCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSecurityGroupRuleDescriptionsIngress( + updateSecurityGroupRuleDescriptionsIngress( args: UpdateSecurityGroupRuleDescriptionsIngressCommandInput, cb: (err: any, data?: UpdateSecurityGroupRuleDescriptionsIngressCommandOutput) => void ): void; - public updateSecurityGroupRuleDescriptionsIngress( + updateSecurityGroupRuleDescriptionsIngress( args: UpdateSecurityGroupRuleDescriptionsIngressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSecurityGroupRuleDescriptionsIngressCommandOutput) => void ): void; - public updateSecurityGroupRuleDescriptionsIngress( - args: UpdateSecurityGroupRuleDescriptionsIngressCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateSecurityGroupRuleDescriptionsIngressCommandOutput) => void), - cb?: (err: any, data?: UpdateSecurityGroupRuleDescriptionsIngressCommandOutput) => void - ): Promise | void { - const command = new UpdateSecurityGroupRuleDescriptionsIngressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops advertising an address range that is provisioned as an address pool.

- *

You can perform this operation at most once every 10 seconds, even if you specify different - * address ranges each time.

- *

It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services - * because of BGP propagation delays.

- */ - public withdrawByoipCidr( + + /** + * @see {@link WithdrawByoipCidrCommand} + */ + withdrawByoipCidr( args: WithdrawByoipCidrCommandInput, options?: __HttpHandlerOptions ): Promise; - public withdrawByoipCidr( + withdrawByoipCidr( args: WithdrawByoipCidrCommandInput, cb: (err: any, data?: WithdrawByoipCidrCommandOutput) => void ): void; - public withdrawByoipCidr( + withdrawByoipCidr( args: WithdrawByoipCidrCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: WithdrawByoipCidrCommandOutput) => void ): void; - public withdrawByoipCidr( - args: WithdrawByoipCidrCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: WithdrawByoipCidrCommandOutput) => void), - cb?: (err: any, data?: WithdrawByoipCidrCommandOutput) => void - ): Promise | void { - const command = new WithdrawByoipCidrCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Elastic Compute Cloud + *

Amazon Elastic Compute Cloud (Amazon EC2) provides secure and resizable computing capacity in the Amazon Web Services Cloud. + * Using Amazon EC2 eliminates the need to invest in hardware up front, so you can develop and deploy applications + * faster. Amazon Virtual Private Cloud (Amazon VPC) enables you to provision a logically isolated section of the + * Amazon Web Services Cloud where you can launch Amazon Web Services resources in a virtual network that you've defined. Amazon Elastic Block Store + * (Amazon EBS) provides block level storage volumes for use with EC2 instances. EBS volumes are highly available + * and reliable storage volumes that can be attached to any running instance and used like a hard drive.

+ *

To learn more, see the following resources:

+ * + */ +export class EC2 extends EC2Client implements EC2 {} +createAggregatedClient(commands, EC2); diff --git a/clients/client-ecr-public/src/ECRPUBLIC.ts b/clients/client-ecr-public/src/ECRPUBLIC.ts index 15a30fdd5f4b..a68a196b7763 100644 --- a/clients/client-ecr-public/src/ECRPUBLIC.ts +++ b/clients/client-ecr-public/src/ECRPUBLIC.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -108,820 +109,412 @@ import { UploadLayerPartCommandInput, UploadLayerPartCommandOutput, } from "./commands/UploadLayerPartCommand"; -import { ECRPUBLICClient } from "./ECRPUBLICClient"; +import { ECRPUBLICClient, ECRPUBLICClientConfig } from "./ECRPUBLICClient"; -/** - * @public - * Amazon Elastic Container Registry Public - *

Amazon Elastic Container Registry Public (Amazon ECR Public) is a managed container image registry service. Amazon ECR provides both - * public and private registries to host your container images. You can use the Docker CLI or - * your preferred client to push, pull, and manage images. Amazon ECR provides a secure, scalable, - * and reliable registry for your Docker or Open Container Initiative (OCI) images. Amazon ECR - * supports public repositories with this API. For information about the Amazon ECR API for private - * repositories, see Amazon Elastic Container Registry API Reference.

- */ -export class ECRPUBLIC extends ECRPUBLICClient { +const commands = { + BatchCheckLayerAvailabilityCommand, + BatchDeleteImageCommand, + CompleteLayerUploadCommand, + CreateRepositoryCommand, + DeleteRepositoryCommand, + DeleteRepositoryPolicyCommand, + DescribeImagesCommand, + DescribeImageTagsCommand, + DescribeRegistriesCommand, + DescribeRepositoriesCommand, + GetAuthorizationTokenCommand, + GetRegistryCatalogDataCommand, + GetRepositoryCatalogDataCommand, + GetRepositoryPolicyCommand, + InitiateLayerUploadCommand, + ListTagsForResourceCommand, + PutImageCommand, + PutRegistryCatalogDataCommand, + PutRepositoryCatalogDataCommand, + SetRepositoryPolicyCommand, + TagResourceCommand, + UntagResourceCommand, + UploadLayerPartCommand, +}; + +export interface ECRPUBLIC { /** - * @public - *

Checks the availability of one or more image layers that are within a repository in a - * public registry. When an image is pushed to a repository, each image layer is checked to - * verify if it has been uploaded before. If it has been uploaded, then the image layer is - * skipped.

- * - *

This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

- *
+ * @see {@link BatchCheckLayerAvailabilityCommand} */ - public batchCheckLayerAvailability( + batchCheckLayerAvailability( args: BatchCheckLayerAvailabilityCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchCheckLayerAvailability( + batchCheckLayerAvailability( args: BatchCheckLayerAvailabilityCommandInput, cb: (err: any, data?: BatchCheckLayerAvailabilityCommandOutput) => void ): void; - public batchCheckLayerAvailability( + batchCheckLayerAvailability( args: BatchCheckLayerAvailabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCheckLayerAvailabilityCommandOutput) => void ): void; - public batchCheckLayerAvailability( - args: BatchCheckLayerAvailabilityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchCheckLayerAvailabilityCommandOutput) => void), - cb?: (err: any, data?: BatchCheckLayerAvailabilityCommandOutput) => void - ): Promise | void { - const command = new BatchCheckLayerAvailabilityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a list of specified images that are within a repository in a public registry. - * Images are specified with either an imageTag or - * imageDigest.

- *

You can remove a tag from an image by specifying the image's tag in your request. When - * you remove the last tag from an image, the image is deleted from your repository.

- *

You can completely delete an image (and all of its tags) by specifying the digest of the - * image in your request.

+ * @see {@link BatchDeleteImageCommand} */ - public batchDeleteImage( + batchDeleteImage( args: BatchDeleteImageCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeleteImage( + batchDeleteImage( args: BatchDeleteImageCommandInput, cb: (err: any, data?: BatchDeleteImageCommandOutput) => void ): void; - public batchDeleteImage( + batchDeleteImage( args: BatchDeleteImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteImageCommandOutput) => void ): void; - public batchDeleteImage( - args: BatchDeleteImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeleteImageCommandOutput) => void), - cb?: (err: any, data?: BatchDeleteImageCommandOutput) => void - ): Promise | void { - const command = new BatchDeleteImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Informs Amazon ECR that the image layer upload is complete for a specified public registry, - * repository name, and upload ID. You can optionally provide a sha256 digest of - * the image layer for data validation purposes.

- *

When an image is pushed, the CompleteLayerUpload API is called once for each new image - * layer to verify that the upload is complete.

- * - *

This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

- *
+ * @see {@link CompleteLayerUploadCommand} */ - public completeLayerUpload( + completeLayerUpload( args: CompleteLayerUploadCommandInput, options?: __HttpHandlerOptions ): Promise; - public completeLayerUpload( + completeLayerUpload( args: CompleteLayerUploadCommandInput, cb: (err: any, data?: CompleteLayerUploadCommandOutput) => void ): void; - public completeLayerUpload( + completeLayerUpload( args: CompleteLayerUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteLayerUploadCommandOutput) => void ): void; - public completeLayerUpload( - args: CompleteLayerUploadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CompleteLayerUploadCommandOutput) => void), - cb?: (err: any, data?: CompleteLayerUploadCommandOutput) => void - ): Promise | void { - const command = new CompleteLayerUploadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a repository in a public registry. For more information, see Amazon ECR - * repositories in the Amazon Elastic Container Registry User Guide.

+ * @see {@link CreateRepositoryCommand} */ - public createRepository( + createRepository( args: CreateRepositoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRepository( + createRepository( args: CreateRepositoryCommandInput, cb: (err: any, data?: CreateRepositoryCommandOutput) => void ): void; - public createRepository( + createRepository( args: CreateRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRepositoryCommandOutput) => void ): void; - public createRepository( - args: CreateRepositoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRepositoryCommandOutput) => void), - cb?: (err: any, data?: CreateRepositoryCommandOutput) => void - ): Promise | void { - const command = new CreateRepositoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a repository in a public registry. If the repository contains images, you must - * either manually delete all images in the repository or use the force option. - * This option deletes all images on your behalf before deleting the repository.

+ * @see {@link DeleteRepositoryCommand} */ - public deleteRepository( + deleteRepository( args: DeleteRepositoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRepository( + deleteRepository( args: DeleteRepositoryCommandInput, cb: (err: any, data?: DeleteRepositoryCommandOutput) => void ): void; - public deleteRepository( + deleteRepository( args: DeleteRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRepositoryCommandOutput) => void ): void; - public deleteRepository( - args: DeleteRepositoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRepositoryCommandOutput) => void), - cb?: (err: any, data?: DeleteRepositoryCommandOutput) => void - ): Promise | void { - const command = new DeleteRepositoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the repository policy that's associated with the specified repository.

+ * @see {@link DeleteRepositoryPolicyCommand} */ - public deleteRepositoryPolicy( + deleteRepositoryPolicy( args: DeleteRepositoryPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRepositoryPolicy( + deleteRepositoryPolicy( args: DeleteRepositoryPolicyCommandInput, cb: (err: any, data?: DeleteRepositoryPolicyCommandOutput) => void ): void; - public deleteRepositoryPolicy( + deleteRepositoryPolicy( args: DeleteRepositoryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRepositoryPolicyCommandOutput) => void ): void; - public deleteRepositoryPolicy( - args: DeleteRepositoryPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRepositoryPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteRepositoryPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteRepositoryPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns metadata that's related to the images in a repository in a public - * registry.

- * - *

Beginning with Docker version 1.9, the Docker client compresses image layers before - * pushing them to a V2 Docker registry. The output of the docker images - * command shows the uncompressed image size. Therefore, it might return a larger image - * size than the image sizes that are returned by DescribeImages.

- *
+ * @see {@link DescribeImagesCommand} */ - public describeImages( + describeImages( args: DescribeImagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeImages( - args: DescribeImagesCommandInput, - cb: (err: any, data?: DescribeImagesCommandOutput) => void - ): void; - public describeImages( + describeImages(args: DescribeImagesCommandInput, cb: (err: any, data?: DescribeImagesCommandOutput) => void): void; + describeImages( args: DescribeImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImagesCommandOutput) => void ): void; - public describeImages( - args: DescribeImagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeImagesCommandOutput) => void), - cb?: (err: any, data?: DescribeImagesCommandOutput) => void - ): Promise | void { - const command = new DescribeImagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the image tag details for a repository in a public registry.

+ * @see {@link DescribeImageTagsCommand} */ - public describeImageTags( + describeImageTags( args: DescribeImageTagsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeImageTags( + describeImageTags( args: DescribeImageTagsCommandInput, cb: (err: any, data?: DescribeImageTagsCommandOutput) => void ): void; - public describeImageTags( + describeImageTags( args: DescribeImageTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImageTagsCommandOutput) => void ): void; - public describeImageTags( - args: DescribeImageTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeImageTagsCommandOutput) => void), - cb?: (err: any, data?: DescribeImageTagsCommandOutput) => void - ): Promise | void { - const command = new DescribeImageTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns details for a public registry.

+ * @see {@link DescribeRegistriesCommand} */ - public describeRegistries( + describeRegistries( args: DescribeRegistriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRegistries( + describeRegistries( args: DescribeRegistriesCommandInput, cb: (err: any, data?: DescribeRegistriesCommandOutput) => void ): void; - public describeRegistries( + describeRegistries( args: DescribeRegistriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRegistriesCommandOutput) => void ): void; - public describeRegistries( - args: DescribeRegistriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRegistriesCommandOutput) => void), - cb?: (err: any, data?: DescribeRegistriesCommandOutput) => void - ): Promise | void { - const command = new DescribeRegistriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes repositories that are in a public registry.

+ * @see {@link DescribeRepositoriesCommand} */ - public describeRepositories( + describeRepositories( args: DescribeRepositoriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRepositories( + describeRepositories( args: DescribeRepositoriesCommandInput, cb: (err: any, data?: DescribeRepositoriesCommandOutput) => void ): void; - public describeRepositories( + describeRepositories( args: DescribeRepositoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRepositoriesCommandOutput) => void ): void; - public describeRepositories( - args: DescribeRepositoriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRepositoriesCommandOutput) => void), - cb?: (err: any, data?: DescribeRepositoriesCommandOutput) => void - ): Promise | void { - const command = new DescribeRepositoriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves an authorization token. An authorization token represents your IAM - * authentication credentials. You can use it to access any Amazon ECR registry that your IAM - * principal has access to. The authorization token is valid for 12 hours. This API requires - * the ecr-public:GetAuthorizationToken and - * sts:GetServiceBearerToken permissions.

+ * @see {@link GetAuthorizationTokenCommand} */ - public getAuthorizationToken( + getAuthorizationToken( args: GetAuthorizationTokenCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAuthorizationToken( + getAuthorizationToken( args: GetAuthorizationTokenCommandInput, cb: (err: any, data?: GetAuthorizationTokenCommandOutput) => void ): void; - public getAuthorizationToken( + getAuthorizationToken( args: GetAuthorizationTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAuthorizationTokenCommandOutput) => void ): void; - public getAuthorizationToken( - args: GetAuthorizationTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAuthorizationTokenCommandOutput) => void), - cb?: (err: any, data?: GetAuthorizationTokenCommandOutput) => void - ): Promise | void { - const command = new GetAuthorizationTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves catalog metadata for a public registry.

+ * @see {@link GetRegistryCatalogDataCommand} */ - public getRegistryCatalogData( + getRegistryCatalogData( args: GetRegistryCatalogDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRegistryCatalogData( + getRegistryCatalogData( args: GetRegistryCatalogDataCommandInput, cb: (err: any, data?: GetRegistryCatalogDataCommandOutput) => void ): void; - public getRegistryCatalogData( + getRegistryCatalogData( args: GetRegistryCatalogDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRegistryCatalogDataCommandOutput) => void ): void; - public getRegistryCatalogData( - args: GetRegistryCatalogDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRegistryCatalogDataCommandOutput) => void), - cb?: (err: any, data?: GetRegistryCatalogDataCommandOutput) => void - ): Promise | void { - const command = new GetRegistryCatalogDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieve catalog metadata for a repository in a public registry. This metadata is - * displayed publicly in the Amazon ECR Public Gallery.

+ * @see {@link GetRepositoryCatalogDataCommand} */ - public getRepositoryCatalogData( + getRepositoryCatalogData( args: GetRepositoryCatalogDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRepositoryCatalogData( + getRepositoryCatalogData( args: GetRepositoryCatalogDataCommandInput, cb: (err: any, data?: GetRepositoryCatalogDataCommandOutput) => void ): void; - public getRepositoryCatalogData( + getRepositoryCatalogData( args: GetRepositoryCatalogDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRepositoryCatalogDataCommandOutput) => void ): void; - public getRepositoryCatalogData( - args: GetRepositoryCatalogDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRepositoryCatalogDataCommandOutput) => void), - cb?: (err: any, data?: GetRepositoryCatalogDataCommandOutput) => void - ): Promise | void { - const command = new GetRepositoryCatalogDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the repository policy for the specified repository.

+ * @see {@link GetRepositoryPolicyCommand} */ - public getRepositoryPolicy( + getRepositoryPolicy( args: GetRepositoryPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRepositoryPolicy( + getRepositoryPolicy( args: GetRepositoryPolicyCommandInput, cb: (err: any, data?: GetRepositoryPolicyCommandOutput) => void ): void; - public getRepositoryPolicy( + getRepositoryPolicy( args: GetRepositoryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRepositoryPolicyCommandOutput) => void ): void; - public getRepositoryPolicy( - args: GetRepositoryPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRepositoryPolicyCommandOutput) => void), - cb?: (err: any, data?: GetRepositoryPolicyCommandOutput) => void - ): Promise | void { - const command = new GetRepositoryPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Notifies Amazon ECR that you intend to upload an image layer.

- *

When an image is pushed, the InitiateLayerUpload API is called once for each image layer - * that hasn't already been uploaded. Whether an image layer uploads is determined by the - * BatchCheckLayerAvailability API action.

- * - *

This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

- *
+ * @see {@link InitiateLayerUploadCommand} */ - public initiateLayerUpload( + initiateLayerUpload( args: InitiateLayerUploadCommandInput, options?: __HttpHandlerOptions ): Promise; - public initiateLayerUpload( + initiateLayerUpload( args: InitiateLayerUploadCommandInput, cb: (err: any, data?: InitiateLayerUploadCommandOutput) => void ): void; - public initiateLayerUpload( + initiateLayerUpload( args: InitiateLayerUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InitiateLayerUploadCommandOutput) => void ): void; - public initiateLayerUpload( - args: InitiateLayerUploadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InitiateLayerUploadCommandOutput) => void), - cb?: (err: any, data?: InitiateLayerUploadCommandOutput) => void - ): Promise | void { - const command = new InitiateLayerUploadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the tags for an Amazon ECR Public resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates the image manifest and tags that are associated with an image.

- *

When an image is pushed and all new image layers have been uploaded, the PutImage API is - * called once to create or update the image manifest and the tags that are associated with - * the image.

- * - *

This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

- *
+ * @see {@link PutImageCommand} */ - public putImage(args: PutImageCommandInput, options?: __HttpHandlerOptions): Promise; - public putImage(args: PutImageCommandInput, cb: (err: any, data?: PutImageCommandOutput) => void): void; - public putImage( + putImage(args: PutImageCommandInput, options?: __HttpHandlerOptions): Promise; + putImage(args: PutImageCommandInput, cb: (err: any, data?: PutImageCommandOutput) => void): void; + putImage( args: PutImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutImageCommandOutput) => void ): void; - public putImage( - args: PutImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutImageCommandOutput) => void), - cb?: (err: any, data?: PutImageCommandOutput) => void - ): Promise | void { - const command = new PutImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create or update the catalog data for a public registry.

+ * @see {@link PutRegistryCatalogDataCommand} */ - public putRegistryCatalogData( + putRegistryCatalogData( args: PutRegistryCatalogDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public putRegistryCatalogData( + putRegistryCatalogData( args: PutRegistryCatalogDataCommandInput, cb: (err: any, data?: PutRegistryCatalogDataCommandOutput) => void ): void; - public putRegistryCatalogData( + putRegistryCatalogData( args: PutRegistryCatalogDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRegistryCatalogDataCommandOutput) => void ): void; - public putRegistryCatalogData( - args: PutRegistryCatalogDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRegistryCatalogDataCommandOutput) => void), - cb?: (err: any, data?: PutRegistryCatalogDataCommandOutput) => void - ): Promise | void { - const command = new PutRegistryCatalogDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates the catalog data for a repository in a public registry.

+ * @see {@link PutRepositoryCatalogDataCommand} */ - public putRepositoryCatalogData( + putRepositoryCatalogData( args: PutRepositoryCatalogDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public putRepositoryCatalogData( + putRepositoryCatalogData( args: PutRepositoryCatalogDataCommandInput, cb: (err: any, data?: PutRepositoryCatalogDataCommandOutput) => void ): void; - public putRepositoryCatalogData( + putRepositoryCatalogData( args: PutRepositoryCatalogDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRepositoryCatalogDataCommandOutput) => void ): void; - public putRepositoryCatalogData( - args: PutRepositoryCatalogDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRepositoryCatalogDataCommandOutput) => void), - cb?: (err: any, data?: PutRepositoryCatalogDataCommandOutput) => void - ): Promise | void { - const command = new PutRepositoryCatalogDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Applies a repository policy to the specified public repository to control access - * permissions. For more information, see Amazon ECR Repository - * Policies in the Amazon Elastic Container Registry User Guide.

+ * @see {@link SetRepositoryPolicyCommand} */ - public setRepositoryPolicy( + setRepositoryPolicy( args: SetRepositoryPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public setRepositoryPolicy( + setRepositoryPolicy( args: SetRepositoryPolicyCommandInput, cb: (err: any, data?: SetRepositoryPolicyCommandOutput) => void ): void; - public setRepositoryPolicy( + setRepositoryPolicy( args: SetRepositoryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetRepositoryPolicyCommandOutput) => void ): void; - public setRepositoryPolicy( - args: SetRepositoryPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetRepositoryPolicyCommandOutput) => void), - cb?: (err: any, data?: SetRepositoryPolicyCommandOutput) => void - ): Promise | void { - const command = new SetRepositoryPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates the specified tags to a resource with the specified resourceArn. - * If existing tags on a resource aren't specified in the request parameters, they aren't - * changed. When a resource is deleted, the tags associated with that resource are also - * deleted.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes specified tags from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Uploads an image layer part to Amazon ECR.

- *

When an image is pushed, each new image layer is uploaded in parts. The maximum size of - * each image layer part can be 20971520 bytes (about 20MB). The UploadLayerPart API is called - * once for each new image layer part.

- * - *

This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

- *
+ * @see {@link UploadLayerPartCommand} */ - public uploadLayerPart( + uploadLayerPart( args: UploadLayerPartCommandInput, options?: __HttpHandlerOptions ): Promise; - public uploadLayerPart( - args: UploadLayerPartCommandInput, - cb: (err: any, data?: UploadLayerPartCommandOutput) => void - ): void; - public uploadLayerPart( + uploadLayerPart(args: UploadLayerPartCommandInput, cb: (err: any, data?: UploadLayerPartCommandOutput) => void): void; + uploadLayerPart( args: UploadLayerPartCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UploadLayerPartCommandOutput) => void ): void; - public uploadLayerPart( - args: UploadLayerPartCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UploadLayerPartCommandOutput) => void), - cb?: (err: any, data?: UploadLayerPartCommandOutput) => void - ): Promise | void { - const command = new UploadLayerPartCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Elastic Container Registry Public + *

Amazon Elastic Container Registry Public (Amazon ECR Public) is a managed container image registry service. Amazon ECR provides both + * public and private registries to host your container images. You can use the Docker CLI or + * your preferred client to push, pull, and manage images. Amazon ECR provides a secure, scalable, + * and reliable registry for your Docker or Open Container Initiative (OCI) images. Amazon ECR + * supports public repositories with this API. For information about the Amazon ECR API for private + * repositories, see Amazon Elastic Container Registry API Reference.

+ */ +export class ECRPUBLIC extends ECRPUBLICClient implements ECRPUBLIC {} +createAggregatedClient(commands, ECRPUBLIC); diff --git a/clients/client-ecr/src/ECR.ts b/clients/client-ecr/src/ECR.ts index f1be23f21633..4355f7aec79d 100644 --- a/clients/client-ecr/src/ECR.ts +++ b/clients/client-ecr/src/ECR.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -194,1461 +195,723 @@ import { UploadLayerPartCommandInput, UploadLayerPartCommandOutput, } from "./commands/UploadLayerPartCommand"; -import { ECRClient } from "./ECRClient"; +import { ECRClient, ECRClientConfig } from "./ECRClient"; -/** - * @public - * Amazon Elastic Container Registry - *

Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Customers can use the - * familiar Docker CLI, or their preferred client, to push, pull, and manage images. Amazon ECR - * provides a secure, scalable, and reliable registry for your Docker or Open Container - * Initiative (OCI) images. Amazon ECR supports private repositories with resource-based - * permissions using IAM so that specific users or Amazon EC2 instances can access - * repositories and images.

- *

Amazon ECR has service endpoints in each supported Region. For more information, see Amazon ECR endpoints in the - * Amazon Web Services General Reference.

- */ -export class ECR extends ECRClient { +const commands = { + BatchCheckLayerAvailabilityCommand, + BatchDeleteImageCommand, + BatchGetImageCommand, + BatchGetRepositoryScanningConfigurationCommand, + CompleteLayerUploadCommand, + CreatePullThroughCacheRuleCommand, + CreateRepositoryCommand, + DeleteLifecyclePolicyCommand, + DeletePullThroughCacheRuleCommand, + DeleteRegistryPolicyCommand, + DeleteRepositoryCommand, + DeleteRepositoryPolicyCommand, + DescribeImageReplicationStatusCommand, + DescribeImagesCommand, + DescribeImageScanFindingsCommand, + DescribePullThroughCacheRulesCommand, + DescribeRegistryCommand, + DescribeRepositoriesCommand, + GetAuthorizationTokenCommand, + GetDownloadUrlForLayerCommand, + GetLifecyclePolicyCommand, + GetLifecyclePolicyPreviewCommand, + GetRegistryPolicyCommand, + GetRegistryScanningConfigurationCommand, + GetRepositoryPolicyCommand, + InitiateLayerUploadCommand, + ListImagesCommand, + ListTagsForResourceCommand, + PutImageCommand, + PutImageScanningConfigurationCommand, + PutImageTagMutabilityCommand, + PutLifecyclePolicyCommand, + PutRegistryPolicyCommand, + PutRegistryScanningConfigurationCommand, + PutReplicationConfigurationCommand, + SetRepositoryPolicyCommand, + StartImageScanCommand, + StartLifecyclePolicyPreviewCommand, + TagResourceCommand, + UntagResourceCommand, + UploadLayerPartCommand, +}; + +export interface ECR { /** - * @public - *

Checks the availability of one or more image layers in a repository.

- *

When an image is pushed to a repository, each image layer is checked to verify if it - * has been uploaded before. If it has been uploaded, then the image layer is - * skipped.

- * - *

This operation is used by the Amazon ECR proxy and is not generally used by - * customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

- *
+ * @see {@link BatchCheckLayerAvailabilityCommand} */ - public batchCheckLayerAvailability( + batchCheckLayerAvailability( args: BatchCheckLayerAvailabilityCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchCheckLayerAvailability( + batchCheckLayerAvailability( args: BatchCheckLayerAvailabilityCommandInput, cb: (err: any, data?: BatchCheckLayerAvailabilityCommandOutput) => void ): void; - public batchCheckLayerAvailability( + batchCheckLayerAvailability( args: BatchCheckLayerAvailabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCheckLayerAvailabilityCommandOutput) => void ): void; - public batchCheckLayerAvailability( - args: BatchCheckLayerAvailabilityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchCheckLayerAvailabilityCommandOutput) => void), - cb?: (err: any, data?: BatchCheckLayerAvailabilityCommandOutput) => void - ): Promise | void { - const command = new BatchCheckLayerAvailabilityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a list of specified images within a repository. Images are specified with - * either an imageTag or imageDigest.

- *

You can remove a tag from an image by specifying the image's tag in your request. When - * you remove the last tag from an image, the image is deleted from your repository.

- *

You can completely delete an image (and all of its tags) by specifying the image's - * digest in your request.

+ * @see {@link BatchDeleteImageCommand} */ - public batchDeleteImage( + batchDeleteImage( args: BatchDeleteImageCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeleteImage( + batchDeleteImage( args: BatchDeleteImageCommandInput, cb: (err: any, data?: BatchDeleteImageCommandOutput) => void ): void; - public batchDeleteImage( + batchDeleteImage( args: BatchDeleteImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteImageCommandOutput) => void ): void; - public batchDeleteImage( - args: BatchDeleteImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeleteImageCommandOutput) => void), - cb?: (err: any, data?: BatchDeleteImageCommandOutput) => void - ): Promise | void { - const command = new BatchDeleteImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets detailed information for an image. Images are specified with either an - * imageTag or imageDigest.

- *

When an image is pulled, the BatchGetImage API is called once to retrieve the image - * manifest.

+ * @see {@link BatchGetImageCommand} */ - public batchGetImage( - args: BatchGetImageCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public batchGetImage( - args: BatchGetImageCommandInput, - cb: (err: any, data?: BatchGetImageCommandOutput) => void - ): void; - public batchGetImage( + batchGetImage(args: BatchGetImageCommandInput, options?: __HttpHandlerOptions): Promise; + batchGetImage(args: BatchGetImageCommandInput, cb: (err: any, data?: BatchGetImageCommandOutput) => void): void; + batchGetImage( args: BatchGetImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetImageCommandOutput) => void ): void; - public batchGetImage( - args: BatchGetImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetImageCommandOutput) => void), - cb?: (err: any, data?: BatchGetImageCommandOutput) => void - ): Promise | void { - const command = new BatchGetImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the scanning configuration for one or more repositories.

+ * @see {@link BatchGetRepositoryScanningConfigurationCommand} */ - public batchGetRepositoryScanningConfiguration( + batchGetRepositoryScanningConfiguration( args: BatchGetRepositoryScanningConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetRepositoryScanningConfiguration( + batchGetRepositoryScanningConfiguration( args: BatchGetRepositoryScanningConfigurationCommandInput, cb: (err: any, data?: BatchGetRepositoryScanningConfigurationCommandOutput) => void ): void; - public batchGetRepositoryScanningConfiguration( + batchGetRepositoryScanningConfiguration( args: BatchGetRepositoryScanningConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetRepositoryScanningConfigurationCommandOutput) => void ): void; - public batchGetRepositoryScanningConfiguration( - args: BatchGetRepositoryScanningConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: BatchGetRepositoryScanningConfigurationCommandOutput) => void), - cb?: (err: any, data?: BatchGetRepositoryScanningConfigurationCommandOutput) => void - ): Promise | void { - const command = new BatchGetRepositoryScanningConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Informs Amazon ECR that the image layer upload has completed for a specified registry, - * repository name, and upload ID. You can optionally provide a sha256 digest - * of the image layer for data validation purposes.

- *

When an image is pushed, the CompleteLayerUpload API is called once per each new image - * layer to verify that the upload has completed.

- * - *

This operation is used by the Amazon ECR proxy and is not generally used by - * customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

- *
+ * @see {@link CompleteLayerUploadCommand} */ - public completeLayerUpload( + completeLayerUpload( args: CompleteLayerUploadCommandInput, options?: __HttpHandlerOptions ): Promise; - public completeLayerUpload( + completeLayerUpload( args: CompleteLayerUploadCommandInput, cb: (err: any, data?: CompleteLayerUploadCommandOutput) => void ): void; - public completeLayerUpload( + completeLayerUpload( args: CompleteLayerUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteLayerUploadCommandOutput) => void ): void; - public completeLayerUpload( - args: CompleteLayerUploadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CompleteLayerUploadCommandOutput) => void), - cb?: (err: any, data?: CompleteLayerUploadCommandOutput) => void - ): Promise | void { - const command = new CompleteLayerUploadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a pull through cache rule. A pull through cache rule provides a way to cache - * images from an external public registry in your Amazon ECR private registry.

+ * @see {@link CreatePullThroughCacheRuleCommand} */ - public createPullThroughCacheRule( + createPullThroughCacheRule( args: CreatePullThroughCacheRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPullThroughCacheRule( + createPullThroughCacheRule( args: CreatePullThroughCacheRuleCommandInput, cb: (err: any, data?: CreatePullThroughCacheRuleCommandOutput) => void ): void; - public createPullThroughCacheRule( + createPullThroughCacheRule( args: CreatePullThroughCacheRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePullThroughCacheRuleCommandOutput) => void ): void; - public createPullThroughCacheRule( - args: CreatePullThroughCacheRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePullThroughCacheRuleCommandOutput) => void), - cb?: (err: any, data?: CreatePullThroughCacheRuleCommandOutput) => void - ): Promise | void { - const command = new CreatePullThroughCacheRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a repository. For more information, see Amazon ECR repositories in the - * Amazon Elastic Container Registry User Guide.

+ * @see {@link CreateRepositoryCommand} */ - public createRepository( + createRepository( args: CreateRepositoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRepository( + createRepository( args: CreateRepositoryCommandInput, cb: (err: any, data?: CreateRepositoryCommandOutput) => void ): void; - public createRepository( + createRepository( args: CreateRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRepositoryCommandOutput) => void ): void; - public createRepository( - args: CreateRepositoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRepositoryCommandOutput) => void), - cb?: (err: any, data?: CreateRepositoryCommandOutput) => void - ): Promise | void { - const command = new CreateRepositoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the lifecycle policy associated with the specified repository.

+ * @see {@link DeleteLifecyclePolicyCommand} */ - public deleteLifecyclePolicy( + deleteLifecyclePolicy( args: DeleteLifecyclePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLifecyclePolicy( + deleteLifecyclePolicy( args: DeleteLifecyclePolicyCommandInput, cb: (err: any, data?: DeleteLifecyclePolicyCommandOutput) => void ): void; - public deleteLifecyclePolicy( + deleteLifecyclePolicy( args: DeleteLifecyclePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLifecyclePolicyCommandOutput) => void ): void; - public deleteLifecyclePolicy( - args: DeleteLifecyclePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLifecyclePolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteLifecyclePolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteLifecyclePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a pull through cache rule.

+ * @see {@link DeletePullThroughCacheRuleCommand} */ - public deletePullThroughCacheRule( + deletePullThroughCacheRule( args: DeletePullThroughCacheRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePullThroughCacheRule( + deletePullThroughCacheRule( args: DeletePullThroughCacheRuleCommandInput, cb: (err: any, data?: DeletePullThroughCacheRuleCommandOutput) => void ): void; - public deletePullThroughCacheRule( + deletePullThroughCacheRule( args: DeletePullThroughCacheRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePullThroughCacheRuleCommandOutput) => void ): void; - public deletePullThroughCacheRule( - args: DeletePullThroughCacheRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePullThroughCacheRuleCommandOutput) => void), - cb?: (err: any, data?: DeletePullThroughCacheRuleCommandOutput) => void - ): Promise | void { - const command = new DeletePullThroughCacheRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the registry permissions policy.

+ * @see {@link DeleteRegistryPolicyCommand} */ - public deleteRegistryPolicy( + deleteRegistryPolicy( args: DeleteRegistryPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRegistryPolicy( + deleteRegistryPolicy( args: DeleteRegistryPolicyCommandInput, cb: (err: any, data?: DeleteRegistryPolicyCommandOutput) => void ): void; - public deleteRegistryPolicy( + deleteRegistryPolicy( args: DeleteRegistryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRegistryPolicyCommandOutput) => void ): void; - public deleteRegistryPolicy( - args: DeleteRegistryPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRegistryPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteRegistryPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteRegistryPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a repository. If the repository contains images, you must either delete all - * images in the repository or use the force option to delete the - * repository.

+ * @see {@link DeleteRepositoryCommand} */ - public deleteRepository( + deleteRepository( args: DeleteRepositoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRepository( + deleteRepository( args: DeleteRepositoryCommandInput, cb: (err: any, data?: DeleteRepositoryCommandOutput) => void ): void; - public deleteRepository( + deleteRepository( args: DeleteRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRepositoryCommandOutput) => void ): void; - public deleteRepository( - args: DeleteRepositoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRepositoryCommandOutput) => void), - cb?: (err: any, data?: DeleteRepositoryCommandOutput) => void - ): Promise | void { - const command = new DeleteRepositoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the repository policy associated with the specified repository.

+ * @see {@link DeleteRepositoryPolicyCommand} */ - public deleteRepositoryPolicy( + deleteRepositoryPolicy( args: DeleteRepositoryPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRepositoryPolicy( + deleteRepositoryPolicy( args: DeleteRepositoryPolicyCommandInput, cb: (err: any, data?: DeleteRepositoryPolicyCommandOutput) => void ): void; - public deleteRepositoryPolicy( + deleteRepositoryPolicy( args: DeleteRepositoryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRepositoryPolicyCommandOutput) => void ): void; - public deleteRepositoryPolicy( - args: DeleteRepositoryPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRepositoryPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteRepositoryPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteRepositoryPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the replication status for a specified image.

+ * @see {@link DescribeImageReplicationStatusCommand} */ - public describeImageReplicationStatus( + describeImageReplicationStatus( args: DescribeImageReplicationStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeImageReplicationStatus( + describeImageReplicationStatus( args: DescribeImageReplicationStatusCommandInput, cb: (err: any, data?: DescribeImageReplicationStatusCommandOutput) => void ): void; - public describeImageReplicationStatus( + describeImageReplicationStatus( args: DescribeImageReplicationStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImageReplicationStatusCommandOutput) => void ): void; - public describeImageReplicationStatus( - args: DescribeImageReplicationStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeImageReplicationStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeImageReplicationStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeImageReplicationStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns metadata about the images in a repository.

- * - *

Beginning with Docker version 1.9, the Docker client compresses image layers - * before pushing them to a V2 Docker registry. The output of the docker - * images command shows the uncompressed image size, so it may return a - * larger image size than the image sizes returned by DescribeImages.

- *
+ * @see {@link DescribeImagesCommand} */ - public describeImages( + describeImages( args: DescribeImagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeImages( - args: DescribeImagesCommandInput, - cb: (err: any, data?: DescribeImagesCommandOutput) => void - ): void; - public describeImages( + describeImages(args: DescribeImagesCommandInput, cb: (err: any, data?: DescribeImagesCommandOutput) => void): void; + describeImages( args: DescribeImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImagesCommandOutput) => void ): void; - public describeImages( - args: DescribeImagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeImagesCommandOutput) => void), - cb?: (err: any, data?: DescribeImagesCommandOutput) => void - ): Promise | void { - const command = new DescribeImagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the scan findings for the specified image.

+ * @see {@link DescribeImageScanFindingsCommand} */ - public describeImageScanFindings( + describeImageScanFindings( args: DescribeImageScanFindingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeImageScanFindings( + describeImageScanFindings( args: DescribeImageScanFindingsCommandInput, cb: (err: any, data?: DescribeImageScanFindingsCommandOutput) => void ): void; - public describeImageScanFindings( + describeImageScanFindings( args: DescribeImageScanFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImageScanFindingsCommandOutput) => void ): void; - public describeImageScanFindings( - args: DescribeImageScanFindingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeImageScanFindingsCommandOutput) => void), - cb?: (err: any, data?: DescribeImageScanFindingsCommandOutput) => void - ): Promise | void { - const command = new DescribeImageScanFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the pull through cache rules for a registry.

+ * @see {@link DescribePullThroughCacheRulesCommand} */ - public describePullThroughCacheRules( + describePullThroughCacheRules( args: DescribePullThroughCacheRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePullThroughCacheRules( + describePullThroughCacheRules( args: DescribePullThroughCacheRulesCommandInput, cb: (err: any, data?: DescribePullThroughCacheRulesCommandOutput) => void ): void; - public describePullThroughCacheRules( + describePullThroughCacheRules( args: DescribePullThroughCacheRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePullThroughCacheRulesCommandOutput) => void ): void; - public describePullThroughCacheRules( - args: DescribePullThroughCacheRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePullThroughCacheRulesCommandOutput) => void), - cb?: (err: any, data?: DescribePullThroughCacheRulesCommandOutput) => void - ): Promise | void { - const command = new DescribePullThroughCacheRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the settings for a registry. The replication configuration for a repository - * can be created or updated with the PutReplicationConfiguration API - * action.

+ * @see {@link DescribeRegistryCommand} */ - public describeRegistry( + describeRegistry( args: DescribeRegistryCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRegistry( + describeRegistry( args: DescribeRegistryCommandInput, cb: (err: any, data?: DescribeRegistryCommandOutput) => void ): void; - public describeRegistry( + describeRegistry( args: DescribeRegistryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRegistryCommandOutput) => void ): void; - public describeRegistry( - args: DescribeRegistryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRegistryCommandOutput) => void), - cb?: (err: any, data?: DescribeRegistryCommandOutput) => void - ): Promise | void { - const command = new DescribeRegistryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes image repositories in a registry.

+ * @see {@link DescribeRepositoriesCommand} */ - public describeRepositories( + describeRepositories( args: DescribeRepositoriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRepositories( + describeRepositories( args: DescribeRepositoriesCommandInput, cb: (err: any, data?: DescribeRepositoriesCommandOutput) => void ): void; - public describeRepositories( + describeRepositories( args: DescribeRepositoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRepositoriesCommandOutput) => void ): void; - public describeRepositories( - args: DescribeRepositoriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRepositoriesCommandOutput) => void), - cb?: (err: any, data?: DescribeRepositoriesCommandOutput) => void - ): Promise | void { - const command = new DescribeRepositoriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves an authorization token. An authorization token represents your IAM - * authentication credentials and can be used to access any Amazon ECR registry that your IAM - * principal has access to. The authorization token is valid for 12 hours.

- *

The authorizationToken returned is a base64 encoded string that can be - * decoded and used in a docker login command to authenticate to a registry. - * The CLI offers an get-login-password command that simplifies the login - * process. For more information, see Registry - * authentication in the Amazon Elastic Container Registry User Guide.

+ * @see {@link GetAuthorizationTokenCommand} */ - public getAuthorizationToken( + getAuthorizationToken( args: GetAuthorizationTokenCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAuthorizationToken( + getAuthorizationToken( args: GetAuthorizationTokenCommandInput, cb: (err: any, data?: GetAuthorizationTokenCommandOutput) => void ): void; - public getAuthorizationToken( + getAuthorizationToken( args: GetAuthorizationTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAuthorizationTokenCommandOutput) => void ): void; - public getAuthorizationToken( - args: GetAuthorizationTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAuthorizationTokenCommandOutput) => void), - cb?: (err: any, data?: GetAuthorizationTokenCommandOutput) => void - ): Promise | void { - const command = new GetAuthorizationTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can - * only get URLs for image layers that are referenced in an image.

- *

When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer - * that is not already cached.

- * - *

This operation is used by the Amazon ECR proxy and is not generally used by - * customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

- *
+ * @see {@link GetDownloadUrlForLayerCommand} */ - public getDownloadUrlForLayer( + getDownloadUrlForLayer( args: GetDownloadUrlForLayerCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDownloadUrlForLayer( + getDownloadUrlForLayer( args: GetDownloadUrlForLayerCommandInput, cb: (err: any, data?: GetDownloadUrlForLayerCommandOutput) => void ): void; - public getDownloadUrlForLayer( + getDownloadUrlForLayer( args: GetDownloadUrlForLayerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDownloadUrlForLayerCommandOutput) => void ): void; - public getDownloadUrlForLayer( - args: GetDownloadUrlForLayerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDownloadUrlForLayerCommandOutput) => void), - cb?: (err: any, data?: GetDownloadUrlForLayerCommandOutput) => void - ): Promise | void { - const command = new GetDownloadUrlForLayerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the lifecycle policy for the specified repository.

+ * @see {@link GetLifecyclePolicyCommand} */ - public getLifecyclePolicy( + getLifecyclePolicy( args: GetLifecyclePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLifecyclePolicy( + getLifecyclePolicy( args: GetLifecyclePolicyCommandInput, cb: (err: any, data?: GetLifecyclePolicyCommandOutput) => void ): void; - public getLifecyclePolicy( + getLifecyclePolicy( args: GetLifecyclePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLifecyclePolicyCommandOutput) => void ): void; - public getLifecyclePolicy( - args: GetLifecyclePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLifecyclePolicyCommandOutput) => void), - cb?: (err: any, data?: GetLifecyclePolicyCommandOutput) => void - ): Promise | void { - const command = new GetLifecyclePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the results of the lifecycle policy preview request for the specified - * repository.

+ * @see {@link GetLifecyclePolicyPreviewCommand} */ - public getLifecyclePolicyPreview( + getLifecyclePolicyPreview( args: GetLifecyclePolicyPreviewCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLifecyclePolicyPreview( + getLifecyclePolicyPreview( args: GetLifecyclePolicyPreviewCommandInput, cb: (err: any, data?: GetLifecyclePolicyPreviewCommandOutput) => void ): void; - public getLifecyclePolicyPreview( + getLifecyclePolicyPreview( args: GetLifecyclePolicyPreviewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLifecyclePolicyPreviewCommandOutput) => void ): void; - public getLifecyclePolicyPreview( - args: GetLifecyclePolicyPreviewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLifecyclePolicyPreviewCommandOutput) => void), - cb?: (err: any, data?: GetLifecyclePolicyPreviewCommandOutput) => void - ): Promise | void { - const command = new GetLifecyclePolicyPreviewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the permissions policy for a registry.

+ * @see {@link GetRegistryPolicyCommand} */ - public getRegistryPolicy( + getRegistryPolicy( args: GetRegistryPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRegistryPolicy( + getRegistryPolicy( args: GetRegistryPolicyCommandInput, cb: (err: any, data?: GetRegistryPolicyCommandOutput) => void ): void; - public getRegistryPolicy( + getRegistryPolicy( args: GetRegistryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRegistryPolicyCommandOutput) => void ): void; - public getRegistryPolicy( - args: GetRegistryPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRegistryPolicyCommandOutput) => void), - cb?: (err: any, data?: GetRegistryPolicyCommandOutput) => void - ): Promise | void { - const command = new GetRegistryPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the scanning configuration for a registry.

+ * @see {@link GetRegistryScanningConfigurationCommand} */ - public getRegistryScanningConfiguration( + getRegistryScanningConfiguration( args: GetRegistryScanningConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRegistryScanningConfiguration( + getRegistryScanningConfiguration( args: GetRegistryScanningConfigurationCommandInput, cb: (err: any, data?: GetRegistryScanningConfigurationCommandOutput) => void ): void; - public getRegistryScanningConfiguration( + getRegistryScanningConfiguration( args: GetRegistryScanningConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRegistryScanningConfigurationCommandOutput) => void ): void; - public getRegistryScanningConfiguration( - args: GetRegistryScanningConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRegistryScanningConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetRegistryScanningConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetRegistryScanningConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the repository policy for the specified repository.

+ * @see {@link GetRepositoryPolicyCommand} */ - public getRepositoryPolicy( + getRepositoryPolicy( args: GetRepositoryPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRepositoryPolicy( + getRepositoryPolicy( args: GetRepositoryPolicyCommandInput, cb: (err: any, data?: GetRepositoryPolicyCommandOutput) => void ): void; - public getRepositoryPolicy( + getRepositoryPolicy( args: GetRepositoryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRepositoryPolicyCommandOutput) => void ): void; - public getRepositoryPolicy( - args: GetRepositoryPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRepositoryPolicyCommandOutput) => void), - cb?: (err: any, data?: GetRepositoryPolicyCommandOutput) => void - ): Promise | void { - const command = new GetRepositoryPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Notifies Amazon ECR that you intend to upload an image layer.

- *

When an image is pushed, the InitiateLayerUpload API is called once per image layer - * that has not already been uploaded. Whether or not an image layer has been uploaded is - * determined by the BatchCheckLayerAvailability API action.

- * - *

This operation is used by the Amazon ECR proxy and is not generally used by - * customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

- *
+ * @see {@link InitiateLayerUploadCommand} */ - public initiateLayerUpload( + initiateLayerUpload( args: InitiateLayerUploadCommandInput, options?: __HttpHandlerOptions ): Promise; - public initiateLayerUpload( + initiateLayerUpload( args: InitiateLayerUploadCommandInput, cb: (err: any, data?: InitiateLayerUploadCommandOutput) => void ): void; - public initiateLayerUpload( + initiateLayerUpload( args: InitiateLayerUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InitiateLayerUploadCommandOutput) => void ): void; - public initiateLayerUpload( - args: InitiateLayerUploadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InitiateLayerUploadCommandOutput) => void), - cb?: (err: any, data?: InitiateLayerUploadCommandOutput) => void - ): Promise | void { - const command = new InitiateLayerUploadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the image IDs for the specified repository.

- *

You can filter images based on whether or not they are tagged by using the - * tagStatus filter and specifying either TAGGED, - * UNTAGGED or ANY. For example, you can filter your results - * to return only UNTAGGED images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your - * results to return only TAGGED images to list all of the tags in your - * repository.

+ * @see {@link ListImagesCommand} */ - public listImages(args: ListImagesCommandInput, options?: __HttpHandlerOptions): Promise; - public listImages(args: ListImagesCommandInput, cb: (err: any, data?: ListImagesCommandOutput) => void): void; - public listImages( + listImages(args: ListImagesCommandInput, options?: __HttpHandlerOptions): Promise; + listImages(args: ListImagesCommandInput, cb: (err: any, data?: ListImagesCommandOutput) => void): void; + listImages( args: ListImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImagesCommandOutput) => void ): void; - public listImages( - args: ListImagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListImagesCommandOutput) => void), - cb?: (err: any, data?: ListImagesCommandOutput) => void - ): Promise | void { - const command = new ListImagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the tags for an Amazon ECR resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates the image manifest and tags associated with an image.

- *

When an image is pushed and all new image layers have been uploaded, the PutImage API - * is called once to create or update the image manifest and the tags associated with the - * image.

- * - * - *

This operation is used by the Amazon ECR proxy and is not generally used by - * customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

- *
+ * @see {@link PutImageCommand} */ - public putImage(args: PutImageCommandInput, options?: __HttpHandlerOptions): Promise; - public putImage(args: PutImageCommandInput, cb: (err: any, data?: PutImageCommandOutput) => void): void; - public putImage( + putImage(args: PutImageCommandInput, options?: __HttpHandlerOptions): Promise; + putImage(args: PutImageCommandInput, cb: (err: any, data?: PutImageCommandOutput) => void): void; + putImage( args: PutImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutImageCommandOutput) => void ): void; - public putImage( - args: PutImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutImageCommandOutput) => void), - cb?: (err: any, data?: PutImageCommandOutput) => void - ): Promise | void { - const command = new PutImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

The PutImageScanningConfiguration API is being deprecated, in favor - * of specifying the image scanning configuration at the registry level. For more - * information, see PutRegistryScanningConfiguration.

- *
- *

Updates the image scanning configuration for the specified repository.

+ * @see {@link PutImageScanningConfigurationCommand} */ - public putImageScanningConfiguration( + putImageScanningConfiguration( args: PutImageScanningConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putImageScanningConfiguration( + putImageScanningConfiguration( args: PutImageScanningConfigurationCommandInput, cb: (err: any, data?: PutImageScanningConfigurationCommandOutput) => void ): void; - public putImageScanningConfiguration( + putImageScanningConfiguration( args: PutImageScanningConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutImageScanningConfigurationCommandOutput) => void ): void; - public putImageScanningConfiguration( - args: PutImageScanningConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutImageScanningConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutImageScanningConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutImageScanningConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the image tag mutability settings for the specified repository. For more - * information, see Image tag - * mutability in the Amazon Elastic Container Registry User Guide.

+ * @see {@link PutImageTagMutabilityCommand} */ - public putImageTagMutability( + putImageTagMutability( args: PutImageTagMutabilityCommandInput, options?: __HttpHandlerOptions ): Promise; - public putImageTagMutability( + putImageTagMutability( args: PutImageTagMutabilityCommandInput, cb: (err: any, data?: PutImageTagMutabilityCommandOutput) => void ): void; - public putImageTagMutability( + putImageTagMutability( args: PutImageTagMutabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutImageTagMutabilityCommandOutput) => void ): void; - public putImageTagMutability( - args: PutImageTagMutabilityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutImageTagMutabilityCommandOutput) => void), - cb?: (err: any, data?: PutImageTagMutabilityCommandOutput) => void - ): Promise | void { - const command = new PutImageTagMutabilityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates the lifecycle policy for the specified repository. For more - * information, see Lifecycle policy - * template.

+ * @see {@link PutLifecyclePolicyCommand} */ - public putLifecyclePolicy( + putLifecyclePolicy( args: PutLifecyclePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putLifecyclePolicy( + putLifecyclePolicy( args: PutLifecyclePolicyCommandInput, cb: (err: any, data?: PutLifecyclePolicyCommandOutput) => void ): void; - public putLifecyclePolicy( + putLifecyclePolicy( args: PutLifecyclePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLifecyclePolicyCommandOutput) => void ): void; - public putLifecyclePolicy( - args: PutLifecyclePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutLifecyclePolicyCommandOutput) => void), - cb?: (err: any, data?: PutLifecyclePolicyCommandOutput) => void - ): Promise | void { - const command = new PutLifecyclePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates the permissions policy for your registry.

- *

A registry policy is used to specify permissions for another Amazon Web Services account and is used - * when configuring cross-account replication. For more information, see Registry permissions in the Amazon Elastic Container Registry User Guide.

+ * @see {@link PutRegistryPolicyCommand} */ - public putRegistryPolicy( + putRegistryPolicy( args: PutRegistryPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putRegistryPolicy( + putRegistryPolicy( args: PutRegistryPolicyCommandInput, cb: (err: any, data?: PutRegistryPolicyCommandOutput) => void ): void; - public putRegistryPolicy( + putRegistryPolicy( args: PutRegistryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRegistryPolicyCommandOutput) => void ): void; - public putRegistryPolicy( - args: PutRegistryPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRegistryPolicyCommandOutput) => void), - cb?: (err: any, data?: PutRegistryPolicyCommandOutput) => void - ): Promise | void { - const command = new PutRegistryPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates the scanning configuration for your private registry.

+ * @see {@link PutRegistryScanningConfigurationCommand} */ - public putRegistryScanningConfiguration( + putRegistryScanningConfiguration( args: PutRegistryScanningConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putRegistryScanningConfiguration( + putRegistryScanningConfiguration( args: PutRegistryScanningConfigurationCommandInput, cb: (err: any, data?: PutRegistryScanningConfigurationCommandOutput) => void ): void; - public putRegistryScanningConfiguration( + putRegistryScanningConfiguration( args: PutRegistryScanningConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRegistryScanningConfigurationCommandOutput) => void ): void; - public putRegistryScanningConfiguration( - args: PutRegistryScanningConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRegistryScanningConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutRegistryScanningConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutRegistryScanningConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates the replication configuration for a registry. The existing - * replication configuration for a repository can be retrieved with the DescribeRegistry API action. The first time the - * PutReplicationConfiguration API is called, a service-linked IAM role is created in - * your account for the replication process. For more information, see Using - * service-linked roles for Amazon ECR in the - * Amazon Elastic Container Registry User Guide.

- * - *

When configuring cross-account replication, the destination account must grant the - * source account permission to replicate. This permission is controlled using a - * registry permissions policy. For more information, see PutRegistryPolicy.

- *
+ * @see {@link PutReplicationConfigurationCommand} */ - public putReplicationConfiguration( + putReplicationConfiguration( args: PutReplicationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putReplicationConfiguration( + putReplicationConfiguration( args: PutReplicationConfigurationCommandInput, cb: (err: any, data?: PutReplicationConfigurationCommandOutput) => void ): void; - public putReplicationConfiguration( + putReplicationConfiguration( args: PutReplicationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutReplicationConfigurationCommandOutput) => void ): void; - public putReplicationConfiguration( - args: PutReplicationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutReplicationConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutReplicationConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutReplicationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Applies a repository policy to the specified repository to control access permissions. - * For more information, see Amazon ECR Repository - * policies in the Amazon Elastic Container Registry User Guide.

+ * @see {@link SetRepositoryPolicyCommand} */ - public setRepositoryPolicy( + setRepositoryPolicy( args: SetRepositoryPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public setRepositoryPolicy( + setRepositoryPolicy( args: SetRepositoryPolicyCommandInput, cb: (err: any, data?: SetRepositoryPolicyCommandOutput) => void ): void; - public setRepositoryPolicy( + setRepositoryPolicy( args: SetRepositoryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetRepositoryPolicyCommandOutput) => void ): void; - public setRepositoryPolicy( - args: SetRepositoryPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetRepositoryPolicyCommandOutput) => void), - cb?: (err: any, data?: SetRepositoryPolicyCommandOutput) => void - ): Promise | void { - const command = new SetRepositoryPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts an image vulnerability scan. An image scan can only be started once per 24 - * hours on an individual image. This limit includes if an image was scanned on initial - * push. For more information, see Image scanning in the - * Amazon Elastic Container Registry User Guide.

+ * @see {@link StartImageScanCommand} */ - public startImageScan( + startImageScan( args: StartImageScanCommandInput, options?: __HttpHandlerOptions ): Promise; - public startImageScan( - args: StartImageScanCommandInput, - cb: (err: any, data?: StartImageScanCommandOutput) => void - ): void; - public startImageScan( + startImageScan(args: StartImageScanCommandInput, cb: (err: any, data?: StartImageScanCommandOutput) => void): void; + startImageScan( args: StartImageScanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartImageScanCommandOutput) => void ): void; - public startImageScan( - args: StartImageScanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartImageScanCommandOutput) => void), - cb?: (err: any, data?: StartImageScanCommandOutput) => void - ): Promise | void { - const command = new StartImageScanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a preview of a lifecycle policy for the specified repository. This allows you - * to see the results before associating the lifecycle policy with the repository.

+ * @see {@link StartLifecyclePolicyPreviewCommand} */ - public startLifecyclePolicyPreview( + startLifecyclePolicyPreview( args: StartLifecyclePolicyPreviewCommandInput, options?: __HttpHandlerOptions ): Promise; - public startLifecyclePolicyPreview( + startLifecyclePolicyPreview( args: StartLifecyclePolicyPreviewCommandInput, cb: (err: any, data?: StartLifecyclePolicyPreviewCommandOutput) => void ): void; - public startLifecyclePolicyPreview( + startLifecyclePolicyPreview( args: StartLifecyclePolicyPreviewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartLifecyclePolicyPreviewCommandOutput) => void ): void; - public startLifecyclePolicyPreview( - args: StartLifecyclePolicyPreviewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartLifecyclePolicyPreviewCommandOutput) => void), - cb?: (err: any, data?: StartLifecyclePolicyPreviewCommandOutput) => void - ): Promise | void { - const command = new StartLifecyclePolicyPreviewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds specified tags to a resource with the specified ARN. Existing tags on a resource - * are not changed if they are not specified in the request parameters.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes specified tags from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Uploads an image layer part to Amazon ECR.

- *

When an image is pushed, each new image layer is uploaded in parts. The maximum size - * of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API - * is called once per each new image layer part.

- * - *

This operation is used by the Amazon ECR proxy and is not generally used by - * customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

- *
+ * @see {@link UploadLayerPartCommand} */ - public uploadLayerPart( + uploadLayerPart( args: UploadLayerPartCommandInput, options?: __HttpHandlerOptions ): Promise; - public uploadLayerPart( - args: UploadLayerPartCommandInput, - cb: (err: any, data?: UploadLayerPartCommandOutput) => void - ): void; - public uploadLayerPart( + uploadLayerPart(args: UploadLayerPartCommandInput, cb: (err: any, data?: UploadLayerPartCommandOutput) => void): void; + uploadLayerPart( args: UploadLayerPartCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UploadLayerPartCommandOutput) => void ): void; - public uploadLayerPart( - args: UploadLayerPartCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UploadLayerPartCommandOutput) => void), - cb?: (err: any, data?: UploadLayerPartCommandOutput) => void - ): Promise | void { - const command = new UploadLayerPartCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Elastic Container Registry + *

Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Customers can use the + * familiar Docker CLI, or their preferred client, to push, pull, and manage images. Amazon ECR + * provides a secure, scalable, and reliable registry for your Docker or Open Container + * Initiative (OCI) images. Amazon ECR supports private repositories with resource-based + * permissions using IAM so that specific users or Amazon EC2 instances can access + * repositories and images.

+ *

Amazon ECR has service endpoints in each supported Region. For more information, see Amazon ECR endpoints in the + * Amazon Web Services General Reference.

+ */ +export class ECR extends ECRClient implements ECR {} +createAggregatedClient(commands, ECR); diff --git a/clients/client-ecs/src/ECS.ts b/clients/client-ecs/src/ECS.ts index f29e50ceacbc..8cc5eabb6e0a 100644 --- a/clients/client-ecs/src/ECS.ts +++ b/clients/client-ecs/src/ECS.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -261,2404 +262,916 @@ import { UpdateTaskSetCommandInput, UpdateTaskSetCommandOutput, } from "./commands/UpdateTaskSetCommand"; -import { ECSClient } from "./ECSClient"; +import { ECSClient, ECSClientConfig } from "./ECSClient"; -/** - * @public - * Amazon Elastic Container Service - *

Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes - * it easy to run, stop, and manage Docker containers. You can host your cluster on a - * serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on - * Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) - * or External (on-premises) instances that you manage.

- *

Amazon ECS makes it easy to launch and stop container-based applications with simple API - * calls. This makes it easy to get the state of your cluster from a centralized service, - * and gives you access to many familiar Amazon EC2 features.

- *

You can use Amazon ECS to schedule the placement of containers across your cluster based on - * your resource needs, isolation policies, and availability requirements. With Amazon ECS, you - * don't need to operate your own cluster management and configuration management systems. - * You also don't need to worry about scaling your management infrastructure.

- */ -export class ECS extends ECSClient { +const commands = { + CreateCapacityProviderCommand, + CreateClusterCommand, + CreateServiceCommand, + CreateTaskSetCommand, + DeleteAccountSettingCommand, + DeleteAttributesCommand, + DeleteCapacityProviderCommand, + DeleteClusterCommand, + DeleteServiceCommand, + DeleteTaskDefinitionsCommand, + DeleteTaskSetCommand, + DeregisterContainerInstanceCommand, + DeregisterTaskDefinitionCommand, + DescribeCapacityProvidersCommand, + DescribeClustersCommand, + DescribeContainerInstancesCommand, + DescribeServicesCommand, + DescribeTaskDefinitionCommand, + DescribeTasksCommand, + DescribeTaskSetsCommand, + DiscoverPollEndpointCommand, + ExecuteCommandCommand, + GetTaskProtectionCommand, + ListAccountSettingsCommand, + ListAttributesCommand, + ListClustersCommand, + ListContainerInstancesCommand, + ListServicesCommand, + ListServicesByNamespaceCommand, + ListTagsForResourceCommand, + ListTaskDefinitionFamiliesCommand, + ListTaskDefinitionsCommand, + ListTasksCommand, + PutAccountSettingCommand, + PutAccountSettingDefaultCommand, + PutAttributesCommand, + PutClusterCapacityProvidersCommand, + RegisterContainerInstanceCommand, + RegisterTaskDefinitionCommand, + RunTaskCommand, + StartTaskCommand, + StopTaskCommand, + SubmitAttachmentStateChangesCommand, + SubmitContainerStateChangeCommand, + SubmitTaskStateChangeCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateCapacityProviderCommand, + UpdateClusterCommand, + UpdateClusterSettingsCommand, + UpdateContainerAgentCommand, + UpdateContainerInstancesStateCommand, + UpdateServiceCommand, + UpdateServicePrimaryTaskSetCommand, + UpdateTaskProtectionCommand, + UpdateTaskSetCommand, +}; + +export interface ECS { /** - * @public - *

Creates a new capacity provider. Capacity providers are associated with an Amazon ECS - * cluster and are used in capacity provider strategies to facilitate cluster auto - * scaling.

- *

Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on - * Fargate use the FARGATE and FARGATE_SPOT capacity providers. - * These providers are available to all accounts in the Amazon Web Services Regions that Fargate - * supports.

+ * @see {@link CreateCapacityProviderCommand} */ - public createCapacityProvider( + createCapacityProvider( args: CreateCapacityProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCapacityProvider( + createCapacityProvider( args: CreateCapacityProviderCommandInput, cb: (err: any, data?: CreateCapacityProviderCommandOutput) => void ): void; - public createCapacityProvider( + createCapacityProvider( args: CreateCapacityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCapacityProviderCommandOutput) => void ): void; - public createCapacityProvider( - args: CreateCapacityProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCapacityProviderCommandOutput) => void), - cb?: (err: any, data?: CreateCapacityProviderCommandOutput) => void - ): Promise | void { - const command = new CreateCapacityProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new Amazon ECS cluster. By default, your account receives a default - * cluster when you launch your first container instance. However, you can create your own - * cluster with a unique name with the CreateCluster action.

- * - *

When you call the CreateCluster API operation, Amazon ECS attempts to - * create the Amazon ECS service-linked role for your account. This is so that it can manage - * required resources in other Amazon Web Services services on your behalf. However, if the user - * that makes the call doesn't have permissions to create the service-linked role, it - * isn't created. For more information, see Using - * service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

- *
+ * @see {@link CreateClusterCommand} */ - public createCluster( - args: CreateClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createCluster( - args: CreateClusterCommandInput, - cb: (err: any, data?: CreateClusterCommandOutput) => void - ): void; - public createCluster( + createCluster(args: CreateClusterCommandInput, options?: __HttpHandlerOptions): Promise; + createCluster(args: CreateClusterCommandInput, cb: (err: any, data?: CreateClusterCommandOutput) => void): void; + createCluster( args: CreateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterCommandOutput) => void ): void; - public createCluster( - args: CreateClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateClusterCommandOutput) => void), - cb?: (err: any, data?: CreateClusterCommandOutput) => void - ): Promise | void { - const command = new CreateClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Runs and maintains your desired number of tasks from a specified task definition. If - * the number of tasks running in a service drops below the desiredCount, - * Amazon ECS runs another copy of the task in the specified cluster. To update an existing - * service, see the UpdateService action.

- * - *

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

- *
- *

In addition to maintaining the desired count of tasks in your service, you can - * optionally run your service behind one or more load balancers. The load balancers - * distribute traffic across the tasks that are associated with the service. For more - * information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.

- *

Tasks for services that don't use a load balancer are considered healthy if they're in - * the RUNNING state. Tasks for services that use a load balancer are - * considered healthy if they're in the RUNNING state and are reported as - * healthy by the load balancer.

- *

There are two service scheduler strategies available:

- *
    - *
  • - *

    - * REPLICA - The replica scheduling strategy places and - * maintains your desired number of tasks across your cluster. By default, the - * service scheduler spreads tasks across Availability Zones. You can use task - * placement strategies and constraints to customize task placement decisions. For - * more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.

    - *
  • - *
  • - *

    - * DAEMON - The daemon scheduling strategy deploys exactly one - * task on each active container instance that meets all of the task placement - * constraints that you specify in your cluster. The service scheduler also - * evaluates the task placement constraints for running tasks. It also stops tasks - * that don't meet the placement constraints. When using this strategy, you don't - * need to specify a desired number of tasks, a task placement strategy, or use - * Service Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.

    - *
  • - *
- *

You can optionally specify a deployment configuration for your service. The deployment - * is initiated by changing properties. For example, the deployment might be initiated by - * the task definition or by your desired count of a service. This is done with an UpdateService operation. The default value for a replica service for - * minimumHealthyPercent is 100%. The default value for a daemon service - * for minimumHealthyPercent is 0%.

- *

If a service uses the ECS deployment controller, the minimum healthy - * percent represents a lower limit on the number of tasks in a service that must remain in - * the RUNNING state during a deployment. Specifically, it represents it as a - * percentage of your desired number of tasks (rounded up to the nearest integer). This - * happens when any of your container instances are in the DRAINING state if - * the service contains tasks using the EC2 launch type. Using this - * parameter, you can deploy without using additional cluster capacity. For example, if you - * set your service to have desired number of four tasks and a minimum healthy percent of - * 50%, the scheduler might stop two existing tasks to free up cluster capacity before - * starting two new tasks. If they're in the RUNNING state, tasks for services - * that don't use a load balancer are considered healthy . If they're in the - * RUNNING state and reported as healthy by the load balancer, tasks for - * services that do use a load balancer are considered healthy . The - * default value for minimum healthy percent is 100%.

- *

If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the - * number of tasks in a service that are allowed in the RUNNING or - * PENDING state during a deployment. Specifically, it represents it as a - * percentage of the desired number of tasks (rounded down to the nearest integer). This - * happens when any of your container instances are in the DRAINING state if - * the service contains tasks using the EC2 launch type. Using this - * parameter, you can define the deployment batch size. For example, if your service has a - * desired number of four tasks and a maximum percent value of 200%, the scheduler may - * start four new tasks before stopping the four older tasks (provided that the cluster - * resources required to do this are available). The default value for maximum percent is - * 200%.

- *

If a service uses either the CODE_DEPLOY or EXTERNAL - * deployment controller types and tasks that use the EC2 launch type, the - * minimum healthy percent and maximum percent values are used only to define the lower and upper limit - * on the number of the tasks in the service that remain in the RUNNING state. - * This is while the container instances are in the DRAINING state. If the - * tasks in the service use the Fargate launch type, the minimum healthy - * percent and maximum percent values aren't used. This is the case even if they're - * currently visible when describing your service.

- *

When creating a service that uses the EXTERNAL deployment controller, you - * can specify only parameters that aren't controlled at the task set level. The only - * required parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

- *

When the service scheduler launches new tasks, it determines task placement. For - * information about task placement and task placement strategies, see Amazon ECS - * task placement in the Amazon Elastic Container Service Developer Guide.

+ * @see {@link CreateServiceCommand} */ - public createService( - args: CreateServiceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createService( - args: CreateServiceCommandInput, - cb: (err: any, data?: CreateServiceCommandOutput) => void - ): void; - public createService( + createService(args: CreateServiceCommandInput, options?: __HttpHandlerOptions): Promise; + createService(args: CreateServiceCommandInput, cb: (err: any, data?: CreateServiceCommandOutput) => void): void; + createService( args: CreateServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceCommandOutput) => void ): void; - public createService( - args: CreateServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateServiceCommandOutput) => void), - cb?: (err: any, data?: CreateServiceCommandOutput) => void - ): Promise | void { - const command = new CreateServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create a task set in the specified cluster and service. This is used when a service - * uses the EXTERNAL deployment controller type. For more information, see - * Amazon ECS deployment - * types in the Amazon Elastic Container Service Developer Guide.

+ * @see {@link CreateTaskSetCommand} */ - public createTaskSet( - args: CreateTaskSetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createTaskSet( - args: CreateTaskSetCommandInput, - cb: (err: any, data?: CreateTaskSetCommandOutput) => void - ): void; - public createTaskSet( + createTaskSet(args: CreateTaskSetCommandInput, options?: __HttpHandlerOptions): Promise; + createTaskSet(args: CreateTaskSetCommandInput, cb: (err: any, data?: CreateTaskSetCommandOutput) => void): void; + createTaskSet( args: CreateTaskSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTaskSetCommandOutput) => void ): void; - public createTaskSet( - args: CreateTaskSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTaskSetCommandOutput) => void), - cb?: (err: any, data?: CreateTaskSetCommandOutput) => void - ): Promise | void { - const command = new CreateTaskSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables an account setting for a specified user, role, or the root user for - * an account.

+ * @see {@link DeleteAccountSettingCommand} */ - public deleteAccountSetting( + deleteAccountSetting( args: DeleteAccountSettingCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAccountSetting( + deleteAccountSetting( args: DeleteAccountSettingCommandInput, cb: (err: any, data?: DeleteAccountSettingCommandOutput) => void ): void; - public deleteAccountSetting( + deleteAccountSetting( args: DeleteAccountSettingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccountSettingCommandOutput) => void ): void; - public deleteAccountSetting( - args: DeleteAccountSettingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAccountSettingCommandOutput) => void), - cb?: (err: any, data?: DeleteAccountSettingCommandOutput) => void - ): Promise | void { - const command = new DeleteAccountSettingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes one or more custom attributes from an Amazon ECS resource.

+ * @see {@link DeleteAttributesCommand} */ - public deleteAttributes( + deleteAttributes( args: DeleteAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAttributes( + deleteAttributes( args: DeleteAttributesCommandInput, cb: (err: any, data?: DeleteAttributesCommandOutput) => void ): void; - public deleteAttributes( + deleteAttributes( args: DeleteAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAttributesCommandOutput) => void ): void; - public deleteAttributes( - args: DeleteAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAttributesCommandOutput) => void), - cb?: (err: any, data?: DeleteAttributesCommandOutput) => void - ): Promise | void { - const command = new DeleteAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified capacity provider.

- * - *

The FARGATE and FARGATE_SPOT capacity providers are - * reserved and can't be deleted. You can disassociate them from a cluster using either - * the PutClusterCapacityProviders API or by deleting the - * cluster.

- *
- *

Prior to a capacity provider being deleted, the capacity provider must be removed from - * the capacity provider strategy from all services. The UpdateService - * API can be used to remove a capacity provider from a service's capacity provider - * strategy. When updating a service, the forceNewDeployment option can be - * used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity - * provider are transitioned to use the capacity from the remaining capacity providers. - * Only capacity providers that aren't associated with a cluster can be deleted. To remove - * a capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster.

+ * @see {@link DeleteCapacityProviderCommand} */ - public deleteCapacityProvider( + deleteCapacityProvider( args: DeleteCapacityProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCapacityProvider( + deleteCapacityProvider( args: DeleteCapacityProviderCommandInput, cb: (err: any, data?: DeleteCapacityProviderCommandOutput) => void ): void; - public deleteCapacityProvider( + deleteCapacityProvider( args: DeleteCapacityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCapacityProviderCommandOutput) => void ): void; - public deleteCapacityProvider( - args: DeleteCapacityProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCapacityProviderCommandOutput) => void), - cb?: (err: any, data?: DeleteCapacityProviderCommandOutput) => void - ): Promise | void { - const command = new DeleteCapacityProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified cluster. The cluster transitions to the INACTIVE - * state. Clusters with an INACTIVE status might remain discoverable in your - * account for a period of time. However, this behavior is subject to change in the future. - * We don't recommend that you rely on INACTIVE clusters persisting.

- *

You must deregister all container instances from this cluster before you may delete - * it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.

+ * @see {@link DeleteClusterCommand} */ - public deleteCluster( - args: DeleteClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteCluster( - args: DeleteClusterCommandInput, - cb: (err: any, data?: DeleteClusterCommandOutput) => void - ): void; - public deleteCluster( + deleteCluster(args: DeleteClusterCommandInput, options?: __HttpHandlerOptions): Promise; + deleteCluster(args: DeleteClusterCommandInput, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void; + deleteCluster( args: DeleteClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClusterCommandOutput) => void ): void; - public deleteCluster( - args: DeleteClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteClusterCommandOutput) => void), - cb?: (err: any, data?: DeleteClusterCommandOutput) => void - ): Promise | void { - const command = new DeleteClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a specified service within a cluster. You can delete a service if you have no - * running tasks in it and the desired task count is zero. If the service is actively - * maintaining tasks, you can't delete it, and you must update the service to a desired - * task count of zero. For more information, see UpdateService.

- * - *

When you delete a service, if there are still running tasks that require cleanup, - * the service status moves from ACTIVE to DRAINING, and the - * service is no longer visible in the console or in the ListServices - * API operation. After all tasks have transitioned to either STOPPING or - * STOPPED status, the service status moves from DRAINING - * to INACTIVE. Services in the DRAINING or - * INACTIVE status can still be viewed with the DescribeServices API operation. However, in the future, - * INACTIVE services may be cleaned up and purged from Amazon ECS record - * keeping, and DescribeServices calls on those services return a - * ServiceNotFoundException error.

- *
- * - *

If you attempt to create a new service with the same name as an existing service - * in either ACTIVE or DRAINING status, you receive an - * error.

- *
+ * @see {@link DeleteServiceCommand} */ - public deleteService( - args: DeleteServiceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteService( - args: DeleteServiceCommandInput, - cb: (err: any, data?: DeleteServiceCommandOutput) => void - ): void; - public deleteService( + deleteService(args: DeleteServiceCommandInput, options?: __HttpHandlerOptions): Promise; + deleteService(args: DeleteServiceCommandInput, cb: (err: any, data?: DeleteServiceCommandOutput) => void): void; + deleteService( args: DeleteServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceCommandOutput) => void ): void; - public deleteService( - args: DeleteServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteServiceCommandOutput) => void), - cb?: (err: any, data?: DeleteServiceCommandOutput) => void - ): Promise | void { - const command = new DeleteServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes one or more task definitions.

- *

You must deregister a task definition revision before you delete it. For more information, - * see DeregisterTaskDefinition.

- *

When you delete a task definition revision, it is immediately transitions from the - * INACTIVE to DELETE_IN_PROGRESS. Existing tasks and services - * that reference a DELETE_IN_PROGRESS task definition revision continue to run - * without disruption. Existing services that reference a DELETE_IN_PROGRESS task - * definition revision can still scale up or down by modifying the service's desired - * count.

- *

You can't use a DELETE_IN_PROGRESS task definition revision to run new tasks - * or create new services. You also can't update an existing service to reference a - * DELETE_IN_PROGRESS task definition revision.

- *

A task definition revision will stay in DELETE_IN_PROGRESS status until - * all the associated tasks and services have been terminated.

+ * @see {@link DeleteTaskDefinitionsCommand} */ - public deleteTaskDefinitions( + deleteTaskDefinitions( args: DeleteTaskDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTaskDefinitions( + deleteTaskDefinitions( args: DeleteTaskDefinitionsCommandInput, cb: (err: any, data?: DeleteTaskDefinitionsCommandOutput) => void ): void; - public deleteTaskDefinitions( + deleteTaskDefinitions( args: DeleteTaskDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTaskDefinitionsCommandOutput) => void ): void; - public deleteTaskDefinitions( - args: DeleteTaskDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTaskDefinitionsCommandOutput) => void), - cb?: (err: any, data?: DeleteTaskDefinitionsCommandOutput) => void - ): Promise | void { - const command = new DeleteTaskDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a specified task set within a service. This is used when a service uses the - * EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

+ * @see {@link DeleteTaskSetCommand} */ - public deleteTaskSet( - args: DeleteTaskSetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteTaskSet( - args: DeleteTaskSetCommandInput, - cb: (err: any, data?: DeleteTaskSetCommandOutput) => void - ): void; - public deleteTaskSet( + deleteTaskSet(args: DeleteTaskSetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTaskSet(args: DeleteTaskSetCommandInput, cb: (err: any, data?: DeleteTaskSetCommandOutput) => void): void; + deleteTaskSet( args: DeleteTaskSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTaskSetCommandOutput) => void ): void; - public deleteTaskSet( - args: DeleteTaskSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTaskSetCommandOutput) => void), - cb?: (err: any, data?: DeleteTaskSetCommandOutput) => void - ): Promise | void { - const command = new DeleteTaskSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deregisters an Amazon ECS container instance from the specified cluster. This instance is - * no longer available to run tasks.

- *

If you intend to use the container instance for some other purpose after - * deregistration, we recommend that you stop all of the tasks running on the container - * instance before deregistration. That prevents any orphaned tasks from consuming - * resources.

- *

Deregistering a container instance removes the instance from a cluster, but it doesn't - * terminate the EC2 instance. If you are finished using the instance, be sure to terminate - * it in the Amazon EC2 console to stop billing.

- * - *

If you terminate a running container instance, Amazon ECS automatically deregisters the - * instance from your cluster (stopped container instances or instances with - * disconnected agents aren't automatically deregistered when terminated).

- *
+ * @see {@link DeregisterContainerInstanceCommand} */ - public deregisterContainerInstance( + deregisterContainerInstance( args: DeregisterContainerInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterContainerInstance( + deregisterContainerInstance( args: DeregisterContainerInstanceCommandInput, cb: (err: any, data?: DeregisterContainerInstanceCommandOutput) => void ): void; - public deregisterContainerInstance( + deregisterContainerInstance( args: DeregisterContainerInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterContainerInstanceCommandOutput) => void ): void; - public deregisterContainerInstance( - args: DeregisterContainerInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterContainerInstanceCommandOutput) => void), - cb?: (err: any, data?: DeregisterContainerInstanceCommandOutput) => void - ): Promise | void { - const command = new DeregisterContainerInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deregisters the specified task definition by family and revision. Upon deregistration, the - * task definition is marked as INACTIVE. Existing tasks and services that - * reference an INACTIVE task definition continue to run without disruption. - * Existing services that reference an INACTIVE task definition can still - * scale up or down by modifying the service's desired count. If you want to delete a task - * definition revision, you must first deregister the task definition revision.

- *

You can't use an INACTIVE task definition to run new tasks or create new - * services, and you can't update an existing service to reference an INACTIVE - * task definition. However, there may be up to a 10-minute window following deregistration - * where these restrictions have not yet taken effect.

- * - *

At this time, INACTIVE task definitions remain discoverable in your - * account indefinitely. However, this behavior is subject to change in the future. We - * don't recommend that you rely on INACTIVE task definitions persisting - * beyond the lifecycle of any associated tasks and services.

- *
- *

You must deregister a task definition revision before you delete it. For more information, - * see DeleteTaskDefinitions.

+ * @see {@link DeregisterTaskDefinitionCommand} */ - public deregisterTaskDefinition( + deregisterTaskDefinition( args: DeregisterTaskDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterTaskDefinition( + deregisterTaskDefinition( args: DeregisterTaskDefinitionCommandInput, cb: (err: any, data?: DeregisterTaskDefinitionCommandOutput) => void ): void; - public deregisterTaskDefinition( + deregisterTaskDefinition( args: DeregisterTaskDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterTaskDefinitionCommandOutput) => void ): void; - public deregisterTaskDefinition( - args: DeregisterTaskDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterTaskDefinitionCommandOutput) => void), - cb?: (err: any, data?: DeregisterTaskDefinitionCommandOutput) => void - ): Promise | void { - const command = new DeregisterTaskDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes one or more of your capacity providers.

+ * @see {@link DescribeCapacityProvidersCommand} */ - public describeCapacityProviders( + describeCapacityProviders( args: DescribeCapacityProvidersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCapacityProviders( + describeCapacityProviders( args: DescribeCapacityProvidersCommandInput, cb: (err: any, data?: DescribeCapacityProvidersCommandOutput) => void ): void; - public describeCapacityProviders( + describeCapacityProviders( args: DescribeCapacityProvidersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCapacityProvidersCommandOutput) => void ): void; - public describeCapacityProviders( - args: DescribeCapacityProvidersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCapacityProvidersCommandOutput) => void), - cb?: (err: any, data?: DescribeCapacityProvidersCommandOutput) => void - ): Promise | void { - const command = new DescribeCapacityProvidersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes one or more of your clusters.

+ * @see {@link DescribeClustersCommand} */ - public describeClusters( + describeClusters( args: DescribeClustersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClusters( + describeClusters( args: DescribeClustersCommandInput, cb: (err: any, data?: DescribeClustersCommandOutput) => void ): void; - public describeClusters( + describeClusters( args: DescribeClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClustersCommandOutput) => void ): void; - public describeClusters( - args: DescribeClustersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClustersCommandOutput) => void), - cb?: (err: any, data?: DescribeClustersCommandOutput) => void - ): Promise | void { - const command = new DescribeClustersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes one or more container instances. Returns metadata about each container - * instance requested.

+ * @see {@link DescribeContainerInstancesCommand} */ - public describeContainerInstances( + describeContainerInstances( args: DescribeContainerInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeContainerInstances( + describeContainerInstances( args: DescribeContainerInstancesCommandInput, cb: (err: any, data?: DescribeContainerInstancesCommandOutput) => void ): void; - public describeContainerInstances( + describeContainerInstances( args: DescribeContainerInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeContainerInstancesCommandOutput) => void ): void; - public describeContainerInstances( - args: DescribeContainerInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeContainerInstancesCommandOutput) => void), - cb?: (err: any, data?: DescribeContainerInstancesCommandOutput) => void - ): Promise | void { - const command = new DescribeContainerInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified services running in your cluster.

+ * @see {@link DescribeServicesCommand} */ - public describeServices( + describeServices( args: DescribeServicesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeServices( + describeServices( args: DescribeServicesCommandInput, cb: (err: any, data?: DescribeServicesCommandOutput) => void ): void; - public describeServices( + describeServices( args: DescribeServicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeServicesCommandOutput) => void ): void; - public describeServices( - args: DescribeServicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeServicesCommandOutput) => void), - cb?: (err: any, data?: DescribeServicesCommandOutput) => void - ): Promise | void { - const command = new DescribeServicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a task definition. You can specify a family and - * revision to find information about a specific task definition, or you - * can simply specify the family to find the latest ACTIVE revision in that - * family.

- * - *

You can only describe INACTIVE task definitions while an active task - * or service references them.

- *
+ * @see {@link DescribeTaskDefinitionCommand} */ - public describeTaskDefinition( + describeTaskDefinition( args: DescribeTaskDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTaskDefinition( + describeTaskDefinition( args: DescribeTaskDefinitionCommandInput, cb: (err: any, data?: DescribeTaskDefinitionCommandOutput) => void ): void; - public describeTaskDefinition( + describeTaskDefinition( args: DescribeTaskDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTaskDefinitionCommandOutput) => void ): void; - public describeTaskDefinition( - args: DescribeTaskDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTaskDefinitionCommandOutput) => void), - cb?: (err: any, data?: DescribeTaskDefinitionCommandOutput) => void - ): Promise | void { - const command = new DescribeTaskDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a specified task or tasks.

- *

Currently, stopped tasks appear in the returned results for at least one hour.

+ * @see {@link DescribeTasksCommand} */ - public describeTasks( - args: DescribeTasksCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeTasks( - args: DescribeTasksCommandInput, - cb: (err: any, data?: DescribeTasksCommandOutput) => void - ): void; - public describeTasks( + describeTasks(args: DescribeTasksCommandInput, options?: __HttpHandlerOptions): Promise; + describeTasks(args: DescribeTasksCommandInput, cb: (err: any, data?: DescribeTasksCommandOutput) => void): void; + describeTasks( args: DescribeTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTasksCommandOutput) => void ): void; - public describeTasks( - args: DescribeTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTasksCommandOutput) => void), - cb?: (err: any, data?: DescribeTasksCommandOutput) => void - ): Promise | void { - const command = new DescribeTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the task sets in the specified cluster and service. This is used when a - * service uses the EXTERNAL deployment controller type. For more information, - * see Amazon ECS Deployment - * Types in the Amazon Elastic Container Service Developer Guide.

+ * @see {@link DescribeTaskSetsCommand} */ - public describeTaskSets( + describeTaskSets( args: DescribeTaskSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTaskSets( + describeTaskSets( args: DescribeTaskSetsCommandInput, cb: (err: any, data?: DescribeTaskSetsCommandOutput) => void ): void; - public describeTaskSets( + describeTaskSets( args: DescribeTaskSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTaskSetsCommandOutput) => void ): void; - public describeTaskSets( - args: DescribeTaskSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTaskSetsCommandOutput) => void), - cb?: (err: any, data?: DescribeTaskSetsCommandOutput) => void - ): Promise | void { - const command = new DescribeTaskSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

- *
- *

Returns an endpoint for the Amazon ECS agent to poll for updates.

+ * @see {@link DiscoverPollEndpointCommand} */ - public discoverPollEndpoint( + discoverPollEndpoint( args: DiscoverPollEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public discoverPollEndpoint( + discoverPollEndpoint( args: DiscoverPollEndpointCommandInput, cb: (err: any, data?: DiscoverPollEndpointCommandOutput) => void ): void; - public discoverPollEndpoint( + discoverPollEndpoint( args: DiscoverPollEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DiscoverPollEndpointCommandOutput) => void ): void; - public discoverPollEndpoint( - args: DiscoverPollEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DiscoverPollEndpointCommandOutput) => void), - cb?: (err: any, data?: DiscoverPollEndpointCommandOutput) => void - ): Promise | void { - const command = new DiscoverPollEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Runs a command remotely on a container within a task.

- *

If you use a condition key in your IAM policy to refine the conditions for the policy - * statement, for example limit the actions to a specific cluster, you receive an - * AccessDeniedException when there is a mismatch between the condition - * key value and the corresponding parameter value.

- *

For information about required permissions and considerations, see Using Amazon ECS Exec for - * debugging in the Amazon ECS Developer Guide.

+ * @see {@link ExecuteCommandCommand} */ - public executeCommand( + executeCommand( args: ExecuteCommandCommandInput, options?: __HttpHandlerOptions ): Promise; - public executeCommand( - args: ExecuteCommandCommandInput, - cb: (err: any, data?: ExecuteCommandCommandOutput) => void - ): void; - public executeCommand( + executeCommand(args: ExecuteCommandCommandInput, cb: (err: any, data?: ExecuteCommandCommandOutput) => void): void; + executeCommand( args: ExecuteCommandCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteCommandCommandOutput) => void ): void; - public executeCommand( - args: ExecuteCommandCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExecuteCommandCommandOutput) => void), - cb?: (err: any, data?: ExecuteCommandCommandOutput) => void - ): Promise | void { - const command = new ExecuteCommandCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the protection status of tasks in an Amazon ECS service.

+ * @see {@link GetTaskProtectionCommand} */ - public getTaskProtection( + getTaskProtection( args: GetTaskProtectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTaskProtection( + getTaskProtection( args: GetTaskProtectionCommandInput, cb: (err: any, data?: GetTaskProtectionCommandOutput) => void ): void; - public getTaskProtection( + getTaskProtection( args: GetTaskProtectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTaskProtectionCommandOutput) => void ): void; - public getTaskProtection( - args: GetTaskProtectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTaskProtectionCommandOutput) => void), - cb?: (err: any, data?: GetTaskProtectionCommandOutput) => void - ): Promise | void { - const command = new GetTaskProtectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the account settings for a specified principal.

+ * @see {@link ListAccountSettingsCommand} */ - public listAccountSettings( + listAccountSettings( args: ListAccountSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAccountSettings( + listAccountSettings( args: ListAccountSettingsCommandInput, cb: (err: any, data?: ListAccountSettingsCommandOutput) => void ): void; - public listAccountSettings( + listAccountSettings( args: ListAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccountSettingsCommandOutput) => void ): void; - public listAccountSettings( - args: ListAccountSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccountSettingsCommandOutput) => void), - cb?: (err: any, data?: ListAccountSettingsCommandOutput) => void - ): Promise | void { - const command = new ListAccountSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the attributes for Amazon ECS resources within a specified target type and cluster. - * When you specify a target type and cluster, ListAttributes returns a list - * of attribute objects, one for each attribute on each resource. You can filter the list - * of results to a single attribute name to only return results that have that name. You - * can also filter the results by attribute name and value. You can do this, for example, - * to see which container instances in a cluster are running a Linux AMI - * (ecs.os-type=linux).

+ * @see {@link ListAttributesCommand} */ - public listAttributes( + listAttributes( args: ListAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAttributes( - args: ListAttributesCommandInput, - cb: (err: any, data?: ListAttributesCommandOutput) => void - ): void; - public listAttributes( + listAttributes(args: ListAttributesCommandInput, cb: (err: any, data?: ListAttributesCommandOutput) => void): void; + listAttributes( args: ListAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAttributesCommandOutput) => void ): void; - public listAttributes( - args: ListAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAttributesCommandOutput) => void), - cb?: (err: any, data?: ListAttributesCommandOutput) => void - ): Promise | void { - const command = new ListAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of existing clusters.

+ * @see {@link ListClustersCommand} */ - public listClusters( - args: ListClustersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listClusters(args: ListClustersCommandInput, cb: (err: any, data?: ListClustersCommandOutput) => void): void; - public listClusters( + listClusters(args: ListClustersCommandInput, options?: __HttpHandlerOptions): Promise; + listClusters(args: ListClustersCommandInput, cb: (err: any, data?: ListClustersCommandOutput) => void): void; + listClusters( args: ListClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListClustersCommandOutput) => void ): void; - public listClusters( - args: ListClustersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListClustersCommandOutput) => void), - cb?: (err: any, data?: ListClustersCommandOutput) => void - ): Promise | void { - const command = new ListClustersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of container instances in a specified cluster. You can filter the - * results of a ListContainerInstances operation with cluster query language - * statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

+ * @see {@link ListContainerInstancesCommand} */ - public listContainerInstances( + listContainerInstances( args: ListContainerInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listContainerInstances( + listContainerInstances( args: ListContainerInstancesCommandInput, cb: (err: any, data?: ListContainerInstancesCommandOutput) => void ): void; - public listContainerInstances( + listContainerInstances( args: ListContainerInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListContainerInstancesCommandOutput) => void ): void; - public listContainerInstances( - args: ListContainerInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListContainerInstancesCommandOutput) => void), - cb?: (err: any, data?: ListContainerInstancesCommandOutput) => void - ): Promise | void { - const command = new ListContainerInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of services. You can filter the results by cluster, launch type, and - * scheduling strategy.

+ * @see {@link ListServicesCommand} */ - public listServices( - args: ListServicesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listServices(args: ListServicesCommandInput, cb: (err: any, data?: ListServicesCommandOutput) => void): void; - public listServices( + listServices(args: ListServicesCommandInput, options?: __HttpHandlerOptions): Promise; + listServices(args: ListServicesCommandInput, cb: (err: any, data?: ListServicesCommandOutput) => void): void; + listServices( args: ListServicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServicesCommandOutput) => void ): void; - public listServices( - args: ListServicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServicesCommandOutput) => void), - cb?: (err: any, data?: ListServicesCommandOutput) => void - ): Promise | void { - const command = new ListServicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation lists all of the services that are associated with a Cloud Map - * namespace. This list might include services in different clusters. In contrast, - * ListServices can only list services in one cluster at a time. If you - * need to filter the list of services in a single cluster by various parameters, use - * ListServices. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

+ * @see {@link ListServicesByNamespaceCommand} */ - public listServicesByNamespace( + listServicesByNamespace( args: ListServicesByNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listServicesByNamespace( + listServicesByNamespace( args: ListServicesByNamespaceCommandInput, cb: (err: any, data?: ListServicesByNamespaceCommandOutput) => void ): void; - public listServicesByNamespace( + listServicesByNamespace( args: ListServicesByNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServicesByNamespaceCommandOutput) => void ): void; - public listServicesByNamespace( - args: ListServicesByNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServicesByNamespaceCommandOutput) => void), - cb?: (err: any, data?: ListServicesByNamespaceCommandOutput) => void - ): Promise | void { - const command = new ListServicesByNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the tags for an Amazon ECS resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of task definition families that are registered to your account. This - * list includes task definition families that no longer have any ACTIVE task - * definition revisions.

- *

You can filter out task definition families that don't contain any ACTIVE - * task definition revisions by setting the status parameter to - * ACTIVE. You can also filter the results with the - * familyPrefix parameter.

+ * @see {@link ListTaskDefinitionFamiliesCommand} */ - public listTaskDefinitionFamilies( + listTaskDefinitionFamilies( args: ListTaskDefinitionFamiliesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTaskDefinitionFamilies( + listTaskDefinitionFamilies( args: ListTaskDefinitionFamiliesCommandInput, cb: (err: any, data?: ListTaskDefinitionFamiliesCommandOutput) => void ): void; - public listTaskDefinitionFamilies( + listTaskDefinitionFamilies( args: ListTaskDefinitionFamiliesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTaskDefinitionFamiliesCommandOutput) => void ): void; - public listTaskDefinitionFamilies( - args: ListTaskDefinitionFamiliesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTaskDefinitionFamiliesCommandOutput) => void), - cb?: (err: any, data?: ListTaskDefinitionFamiliesCommandOutput) => void - ): Promise | void { - const command = new ListTaskDefinitionFamiliesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of task definitions that are registered to your account. You can filter - * the results by family name with the familyPrefix parameter or by status - * with the status parameter.

+ * @see {@link ListTaskDefinitionsCommand} */ - public listTaskDefinitions( + listTaskDefinitions( args: ListTaskDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTaskDefinitions( + listTaskDefinitions( args: ListTaskDefinitionsCommandInput, cb: (err: any, data?: ListTaskDefinitionsCommandOutput) => void ): void; - public listTaskDefinitions( + listTaskDefinitions( args: ListTaskDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTaskDefinitionsCommandOutput) => void ): void; - public listTaskDefinitions( - args: ListTaskDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTaskDefinitionsCommandOutput) => void), - cb?: (err: any, data?: ListTaskDefinitionsCommandOutput) => void - ): Promise | void { - const command = new ListTaskDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of tasks. You can filter the results by cluster, task definition - * family, container instance, launch type, what IAM principal started the task, or by the - * desired status of the task.

- *

Recently stopped tasks might appear in the returned results. Currently, stopped tasks - * appear in the returned results for at least one hour.

+ * @see {@link ListTasksCommand} */ - public listTasks(args: ListTasksCommandInput, options?: __HttpHandlerOptions): Promise; - public listTasks(args: ListTasksCommandInput, cb: (err: any, data?: ListTasksCommandOutput) => void): void; - public listTasks( + listTasks(args: ListTasksCommandInput, options?: __HttpHandlerOptions): Promise; + listTasks(args: ListTasksCommandInput, cb: (err: any, data?: ListTasksCommandOutput) => void): void; + listTasks( args: ListTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTasksCommandOutput) => void ): void; - public listTasks( - args: ListTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTasksCommandOutput) => void), - cb?: (err: any, data?: ListTasksCommandOutput) => void - ): Promise | void { - const command = new ListTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies an account setting. Account settings are set on a per-Region basis.

- *

If you change the root user account setting, the default settings are reset for users - * and roles that do not have specified individual account settings. For more information, - * see Account - * Settings in the Amazon Elastic Container Service Developer Guide.

- *

When serviceLongArnFormat, taskLongArnFormat, or - * containerInstanceLongArnFormat are specified, the Amazon Resource Name - * (ARN) and resource ID format of the resource type for a specified user, role, or - * the root user for an account is affected. The opt-in and opt-out account setting must be - * set for each Amazon ECS resource separately. The ARN and resource ID format of a resource - * is defined by the opt-in status of the user or role that created the resource. You - * must turn on this setting to use Amazon ECS features such as resource tagging.

- *

When awsvpcTrunking is specified, the elastic network interface (ENI) - * limit for any new container instances that support the feature is changed. If - * awsvpcTrunking is turned on, any new container instances that support the - * feature are launched have the increased ENI limits available to them. For more - * information, see Elastic Network - * Interface Trunking in the Amazon Elastic Container Service Developer Guide.

- *

When containerInsights is specified, the default setting indicating whether - * Amazon Web Services CloudWatch Container Insights is turned on for your clusters is changed. If - * containerInsights is turned on, any new clusters that are created will - * have Container Insights turned on unless you disable it during cluster creation. For - * more information, see CloudWatch - * Container Insights in the Amazon Elastic Container Service Developer Guide.

+ * @see {@link PutAccountSettingCommand} */ - public putAccountSetting( + putAccountSetting( args: PutAccountSettingCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAccountSetting( + putAccountSetting( args: PutAccountSettingCommandInput, cb: (err: any, data?: PutAccountSettingCommandOutput) => void ): void; - public putAccountSetting( + putAccountSetting( args: PutAccountSettingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccountSettingCommandOutput) => void ): void; - public putAccountSetting( - args: PutAccountSettingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAccountSettingCommandOutput) => void), - cb?: (err: any, data?: PutAccountSettingCommandOutput) => void - ): Promise | void { - const command = new PutAccountSettingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies an account setting for all users on an account for whom no individual - * account setting has been specified. Account settings are set on a per-Region - * basis.

+ * @see {@link PutAccountSettingDefaultCommand} */ - public putAccountSettingDefault( + putAccountSettingDefault( args: PutAccountSettingDefaultCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAccountSettingDefault( + putAccountSettingDefault( args: PutAccountSettingDefaultCommandInput, cb: (err: any, data?: PutAccountSettingDefaultCommandOutput) => void ): void; - public putAccountSettingDefault( + putAccountSettingDefault( args: PutAccountSettingDefaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccountSettingDefaultCommandOutput) => void ): void; - public putAccountSettingDefault( - args: PutAccountSettingDefaultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAccountSettingDefaultCommandOutput) => void), - cb?: (err: any, data?: PutAccountSettingDefaultCommandOutput) => void - ): Promise | void { - const command = new PutAccountSettingDefaultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist, - * it's created. If the attribute exists, its value is replaced with the specified value. - * To delete an attribute, use DeleteAttributes. For more information, - * see Attributes in the Amazon Elastic Container Service Developer Guide.

+ * @see {@link PutAttributesCommand} */ - public putAttributes( - args: PutAttributesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putAttributes( - args: PutAttributesCommandInput, - cb: (err: any, data?: PutAttributesCommandOutput) => void - ): void; - public putAttributes( + putAttributes(args: PutAttributesCommandInput, options?: __HttpHandlerOptions): Promise; + putAttributes(args: PutAttributesCommandInput, cb: (err: any, data?: PutAttributesCommandOutput) => void): void; + putAttributes( args: PutAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAttributesCommandOutput) => void ): void; - public putAttributes( - args: PutAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAttributesCommandOutput) => void), - cb?: (err: any, data?: PutAttributesCommandOutput) => void - ): Promise | void { - const command = new PutAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the available capacity providers and the default capacity provider strategy - * for a cluster.

- *

You must specify both the available capacity providers and a default capacity provider - * strategy for the cluster. If the specified cluster has existing capacity providers - * associated with it, you must specify all existing capacity providers in addition to any - * new ones you want to add. Any existing capacity providers that are associated with a - * cluster that are omitted from a PutClusterCapacityProviders API call - * will be disassociated with the cluster. You can only disassociate an existing capacity - * provider from a cluster if it's not being used by any existing tasks.

- *

When creating a service or running a task on a cluster, if no capacity provider or - * launch type is specified, then the cluster's default capacity provider strategy is used. - * We recommend that you define a default capacity provider strategy for your cluster. - * However, you must specify an empty array ([]) to bypass defining a default - * strategy.

+ * @see {@link PutClusterCapacityProvidersCommand} */ - public putClusterCapacityProviders( + putClusterCapacityProviders( args: PutClusterCapacityProvidersCommandInput, options?: __HttpHandlerOptions ): Promise; - public putClusterCapacityProviders( + putClusterCapacityProviders( args: PutClusterCapacityProvidersCommandInput, cb: (err: any, data?: PutClusterCapacityProvidersCommandOutput) => void ): void; - public putClusterCapacityProviders( + putClusterCapacityProviders( args: PutClusterCapacityProvidersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutClusterCapacityProvidersCommandOutput) => void ): void; - public putClusterCapacityProviders( - args: PutClusterCapacityProvidersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutClusterCapacityProvidersCommandOutput) => void), - cb?: (err: any, data?: PutClusterCapacityProvidersCommandOutput) => void - ): Promise | void { - const command = new PutClusterCapacityProvidersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

- *
- *

Registers an EC2 instance into the specified cluster. This instance becomes available - * to place containers on.

+ * @see {@link RegisterContainerInstanceCommand} */ - public registerContainerInstance( + registerContainerInstance( args: RegisterContainerInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerContainerInstance( + registerContainerInstance( args: RegisterContainerInstanceCommandInput, cb: (err: any, data?: RegisterContainerInstanceCommandOutput) => void ): void; - public registerContainerInstance( + registerContainerInstance( args: RegisterContainerInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterContainerInstanceCommandOutput) => void ): void; - public registerContainerInstance( - args: RegisterContainerInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterContainerInstanceCommandOutput) => void), - cb?: (err: any, data?: RegisterContainerInstanceCommandOutput) => void - ): Promise | void { - const command = new RegisterContainerInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers a new task definition from the supplied family and - * containerDefinitions. Optionally, you can add data volumes to your - * containers with the volumes parameter. For more information about task - * definition parameters and defaults, see Amazon ECS Task - * Definitions in the Amazon Elastic Container Service Developer Guide.

- *

You can specify a role for your task with the taskRoleArn parameter. - * When you specify a role for a task, its containers can then use the latest versions - * of the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in - * the policy that's associated with the role. For more information, see IAM - * Roles for Tasks in the Amazon Elastic Container Service Developer Guide.

- *

You can specify a Docker networking mode for the containers in your task definition - * with the networkMode parameter. The available network modes correspond to - * those described in Network - * settings in the Docker run reference. If you specify the awsvpc - * network mode, the task is allocated an elastic network interface, and you must specify a - * NetworkConfiguration when you create a service or run a task with - * the task definition. For more information, see Task Networking - * in the Amazon Elastic Container Service Developer Guide.

+ * @see {@link RegisterTaskDefinitionCommand} */ - public registerTaskDefinition( + registerTaskDefinition( args: RegisterTaskDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerTaskDefinition( + registerTaskDefinition( args: RegisterTaskDefinitionCommandInput, cb: (err: any, data?: RegisterTaskDefinitionCommandOutput) => void ): void; - public registerTaskDefinition( + registerTaskDefinition( args: RegisterTaskDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterTaskDefinitionCommandOutput) => void ): void; - public registerTaskDefinition( - args: RegisterTaskDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterTaskDefinitionCommandOutput) => void), - cb?: (err: any, data?: RegisterTaskDefinitionCommandOutput) => void - ): Promise | void { - const command = new RegisterTaskDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a new task using the specified task definition.

- *

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places - * tasks using placement constraints and placement strategies. For more information, see - * Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

- *

Alternatively, you can use StartTask to use your own scheduler or - * place tasks manually on specific container instances.

- * - *

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

- *
- *

The Amazon ECS API follows an eventual consistency model. This is because of the - * distributed nature of the system supporting the API. This means that the result of an - * API command you run that affects your Amazon ECS resources might not be immediately visible - * to all subsequent commands you run. Keep this in mind when you carry out an API command - * that immediately follows a previous API command.

- *

To manage eventual consistency, you can do the following:

- *
    - *
  • - *

    Confirm the state of the resource before you run a command to modify it. Run - * the DescribeTasks command using an exponential backoff algorithm to ensure that - * you allow enough time for the previous command to propagate through the system. - * To do this, run the DescribeTasks command repeatedly, starting with a couple of - * seconds of wait time and increasing gradually up to five minutes of wait - * time.

    - *
  • - *
  • - *

    Add wait time between subsequent commands, even if the DescribeTasks command - * returns an accurate response. Apply an exponential backoff algorithm starting - * with a couple of seconds of wait time, and increase gradually up to about five - * minutes of wait time.

    - *
  • - *
+ * @see {@link RunTaskCommand} */ - public runTask(args: RunTaskCommandInput, options?: __HttpHandlerOptions): Promise; - public runTask(args: RunTaskCommandInput, cb: (err: any, data?: RunTaskCommandOutput) => void): void; - public runTask( + runTask(args: RunTaskCommandInput, options?: __HttpHandlerOptions): Promise; + runTask(args: RunTaskCommandInput, cb: (err: any, data?: RunTaskCommandOutput) => void): void; + runTask( args: RunTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RunTaskCommandOutput) => void ): void; - public runTask( - args: RunTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RunTaskCommandOutput) => void), - cb?: (err: any, data?: RunTaskCommandOutput) => void - ): Promise | void { - const command = new RunTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a new task from the specified task definition on the specified container - * instance or instances.

- * - *

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

- *
- *

Alternatively, you can use RunTask to place tasks for you. For more - * information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

+ * @see {@link StartTaskCommand} */ - public startTask(args: StartTaskCommandInput, options?: __HttpHandlerOptions): Promise; - public startTask(args: StartTaskCommandInput, cb: (err: any, data?: StartTaskCommandOutput) => void): void; - public startTask( + startTask(args: StartTaskCommandInput, options?: __HttpHandlerOptions): Promise; + startTask(args: StartTaskCommandInput, cb: (err: any, data?: StartTaskCommandOutput) => void): void; + startTask( args: StartTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTaskCommandOutput) => void ): void; - public startTask( - args: StartTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartTaskCommandOutput) => void), - cb?: (err: any, data?: StartTaskCommandOutput) => void - ): Promise | void { - const command = new StartTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops a running task. Any tags associated with the task will be deleted.

- *

When StopTask is called on a task, the equivalent of docker - * stop is issued to the containers running in the task. This results in a - * SIGTERM value and a default 30-second timeout, after which the - * SIGKILL value is sent and the containers are forcibly stopped. If the - * container handles the SIGTERM value gracefully and exits within 30 seconds - * from receiving it, no SIGKILL value is sent.

- * - *

The default 30-second timeout can be configured on the Amazon ECS container agent with - * the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see - * Amazon ECS Container Agent Configuration in the - * Amazon Elastic Container Service Developer Guide.

- *
+ * @see {@link StopTaskCommand} */ - public stopTask(args: StopTaskCommandInput, options?: __HttpHandlerOptions): Promise; - public stopTask(args: StopTaskCommandInput, cb: (err: any, data?: StopTaskCommandOutput) => void): void; - public stopTask( + stopTask(args: StopTaskCommandInput, options?: __HttpHandlerOptions): Promise; + stopTask(args: StopTaskCommandInput, cb: (err: any, data?: StopTaskCommandOutput) => void): void; + stopTask( args: StopTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopTaskCommandOutput) => void ): void; - public stopTask( - args: StopTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopTaskCommandOutput) => void), - cb?: (err: any, data?: StopTaskCommandOutput) => void - ): Promise | void { - const command = new StopTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

- *
- *

Sent to acknowledge that an attachment changed states.

+ * @see {@link SubmitAttachmentStateChangesCommand} */ - public submitAttachmentStateChanges( + submitAttachmentStateChanges( args: SubmitAttachmentStateChangesCommandInput, options?: __HttpHandlerOptions ): Promise; - public submitAttachmentStateChanges( + submitAttachmentStateChanges( args: SubmitAttachmentStateChangesCommandInput, cb: (err: any, data?: SubmitAttachmentStateChangesCommandOutput) => void ): void; - public submitAttachmentStateChanges( + submitAttachmentStateChanges( args: SubmitAttachmentStateChangesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubmitAttachmentStateChangesCommandOutput) => void ): void; - public submitAttachmentStateChanges( - args: SubmitAttachmentStateChangesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SubmitAttachmentStateChangesCommandOutput) => void), - cb?: (err: any, data?: SubmitAttachmentStateChangesCommandOutput) => void - ): Promise | void { - const command = new SubmitAttachmentStateChangesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

- *
- *

Sent to acknowledge that a container changed states.

+ * @see {@link SubmitContainerStateChangeCommand} */ - public submitContainerStateChange( + submitContainerStateChange( args: SubmitContainerStateChangeCommandInput, options?: __HttpHandlerOptions ): Promise; - public submitContainerStateChange( + submitContainerStateChange( args: SubmitContainerStateChangeCommandInput, cb: (err: any, data?: SubmitContainerStateChangeCommandOutput) => void ): void; - public submitContainerStateChange( + submitContainerStateChange( args: SubmitContainerStateChangeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubmitContainerStateChangeCommandOutput) => void ): void; - public submitContainerStateChange( - args: SubmitContainerStateChangeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SubmitContainerStateChangeCommandOutput) => void), - cb?: (err: any, data?: SubmitContainerStateChangeCommandOutput) => void - ): Promise | void { - const command = new SubmitContainerStateChangeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

- *
- *

Sent to acknowledge that a task changed states.

+ * @see {@link SubmitTaskStateChangeCommand} */ - public submitTaskStateChange( + submitTaskStateChange( args: SubmitTaskStateChangeCommandInput, options?: __HttpHandlerOptions ): Promise; - public submitTaskStateChange( + submitTaskStateChange( args: SubmitTaskStateChangeCommandInput, cb: (err: any, data?: SubmitTaskStateChangeCommandOutput) => void ): void; - public submitTaskStateChange( + submitTaskStateChange( args: SubmitTaskStateChangeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubmitTaskStateChangeCommandOutput) => void ): void; - public submitTaskStateChange( - args: SubmitTaskStateChangeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SubmitTaskStateChangeCommandOutput) => void), - cb?: (err: any, data?: SubmitTaskStateChangeCommandOutput) => void - ): Promise | void { - const command = new SubmitTaskStateChangeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates the specified tags to a resource with the specified - * resourceArn. If existing tags on a resource aren't specified in the - * request parameters, they aren't changed. When a resource is deleted, the tags that are - * associated with that resource are deleted as well.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes specified tags from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the parameters for a capacity provider.

+ * @see {@link UpdateCapacityProviderCommand} */ - public updateCapacityProvider( + updateCapacityProvider( args: UpdateCapacityProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCapacityProvider( + updateCapacityProvider( args: UpdateCapacityProviderCommandInput, cb: (err: any, data?: UpdateCapacityProviderCommandOutput) => void ): void; - public updateCapacityProvider( + updateCapacityProvider( args: UpdateCapacityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCapacityProviderCommandOutput) => void ): void; - public updateCapacityProvider( - args: UpdateCapacityProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCapacityProviderCommandOutput) => void), - cb?: (err: any, data?: UpdateCapacityProviderCommandOutput) => void - ): Promise | void { - const command = new UpdateCapacityProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the cluster.

+ * @see {@link UpdateClusterCommand} */ - public updateCluster( - args: UpdateClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateCluster( - args: UpdateClusterCommandInput, - cb: (err: any, data?: UpdateClusterCommandOutput) => void - ): void; - public updateCluster( + updateCluster(args: UpdateClusterCommandInput, options?: __HttpHandlerOptions): Promise; + updateCluster(args: UpdateClusterCommandInput, cb: (err: any, data?: UpdateClusterCommandOutput) => void): void; + updateCluster( args: UpdateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateClusterCommandOutput) => void ): void; - public updateCluster( - args: UpdateClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateClusterCommandOutput) => void), - cb?: (err: any, data?: UpdateClusterCommandOutput) => void - ): Promise | void { - const command = new UpdateClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the settings to use for a cluster.

+ * @see {@link UpdateClusterSettingsCommand} */ - public updateClusterSettings( + updateClusterSettings( args: UpdateClusterSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateClusterSettings( + updateClusterSettings( args: UpdateClusterSettingsCommandInput, cb: (err: any, data?: UpdateClusterSettingsCommandOutput) => void ): void; - public updateClusterSettings( + updateClusterSettings( args: UpdateClusterSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateClusterSettingsCommandOutput) => void ): void; - public updateClusterSettings( - args: UpdateClusterSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateClusterSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateClusterSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateClusterSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the Amazon ECS container agent on a specified container instance. Updating the - * Amazon ECS container agent doesn't interrupt running tasks or services on the container - * instance. The process for updating the agent differs depending on whether your container - * instance was launched with the Amazon ECS-optimized AMI or another operating system.

- * - *

The UpdateContainerAgent API isn't supported for container instances - * using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent, - * you can update the ecs-init package. This updates the agent. For more - * information, see Updating the - * Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.

- *
- * - *

Agent updates with the UpdateContainerAgent API operation do not - * apply to Windows container instances. We recommend that you launch new container - * instances to update the agent version in your Windows clusters.

- *
- *

The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon - * Linux AMI with the ecs-init service installed and running. For help - * updating the Amazon ECS container agent on other operating systems, see Manually updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.

+ * @see {@link UpdateContainerAgentCommand} */ - public updateContainerAgent( + updateContainerAgent( args: UpdateContainerAgentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateContainerAgent( + updateContainerAgent( args: UpdateContainerAgentCommandInput, cb: (err: any, data?: UpdateContainerAgentCommandOutput) => void ): void; - public updateContainerAgent( + updateContainerAgent( args: UpdateContainerAgentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContainerAgentCommandOutput) => void ): void; - public updateContainerAgent( - args: UpdateContainerAgentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateContainerAgentCommandOutput) => void), - cb?: (err: any, data?: UpdateContainerAgentCommandOutput) => void - ): Promise | void { - const command = new UpdateContainerAgentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the status of an Amazon ECS container instance.

- *

Once a container instance has reached an ACTIVE state, you can change the - * status of a container instance to DRAINING to manually remove an instance - * from a cluster, for example to perform system updates, update the Docker daemon, or - * scale down the cluster size.

- * - *

A container instance can't be changed to DRAINING until it has - * reached an ACTIVE status. If the instance is in any other status, an - * error will be received.

- *
- *

When you set a container instance to DRAINING, Amazon ECS prevents new tasks - * from being scheduled for placement on the container instance and replacement service - * tasks are started on other container instances in the cluster if the resources are - * available. Service tasks on the container instance that are in the PENDING - * state are stopped immediately.

- *

Service tasks on the container instance that are in the RUNNING state are - * stopped and replaced according to the service's deployment configuration parameters, - * minimumHealthyPercent and maximumPercent. You can change - * the deployment configuration of your service using UpdateService.

- *
    - *
  • - *

    If minimumHealthyPercent is below 100%, the scheduler can ignore - * desiredCount temporarily during task replacement. For example, - * desiredCount is four tasks, a minimum of 50% allows the - * scheduler to stop two existing tasks before starting two new tasks. If the - * minimum is 100%, the service scheduler can't remove existing tasks until the - * replacement tasks are considered healthy. Tasks for services that do not use a - * load balancer are considered healthy if they're in the RUNNING - * state. Tasks for services that use a load balancer are considered healthy if - * they're in the RUNNING state and are reported as healthy by the - * load balancer.

    - *
  • - *
  • - *

    The maximumPercent parameter represents an upper limit on the - * number of running tasks during task replacement. You can use this to define the - * replacement batch size. For example, if desiredCount is four tasks, - * a maximum of 200% starts four new tasks before stopping the four tasks to be - * drained, provided that the cluster resources required to do this are available. - * If the maximum is 100%, then replacement tasks can't start until the draining - * tasks have stopped.

    - *
  • - *
- *

Any PENDING or RUNNING tasks that do not belong to a service - * aren't affected. You must wait for them to finish or stop them manually.

- *

A container instance has completed draining when it has no more RUNNING - * tasks. You can verify this using ListTasks.

- *

When a container instance has been drained, you can set a container instance to - * ACTIVE status and once it has reached that status the Amazon ECS scheduler - * can begin scheduling tasks on the instance again.

+ * @see {@link UpdateContainerInstancesStateCommand} */ - public updateContainerInstancesState( + updateContainerInstancesState( args: UpdateContainerInstancesStateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateContainerInstancesState( + updateContainerInstancesState( args: UpdateContainerInstancesStateCommandInput, cb: (err: any, data?: UpdateContainerInstancesStateCommandOutput) => void ): void; - public updateContainerInstancesState( + updateContainerInstancesState( args: UpdateContainerInstancesStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContainerInstancesStateCommandOutput) => void ): void; - public updateContainerInstancesState( - args: UpdateContainerInstancesStateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateContainerInstancesStateCommandOutput) => void), - cb?: (err: any, data?: UpdateContainerInstancesStateCommandOutput) => void - ): Promise | void { - const command = new UpdateContainerInstancesStateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the parameters of a service.

- *

For services using the rolling update (ECS) you can update the desired - * count, deployment configuration, network configuration, load balancers, service - * registries, enable ECS managed tags option, propagate tags option, task placement - * constraints and strategies, and task definition. When you update any of these - * parameters, Amazon ECS starts new tasks with the new configuration.

- *

For services using the blue/green (CODE_DEPLOY) deployment controller, - * only the desired count, deployment configuration, health check grace period, task - * placement constraints and strategies, enable ECS managed tags option, and propagate tags - * can be updated using this API. If the network configuration, platform version, task - * definition, or load balancer need to be updated, create a new CodeDeploy deployment. For more - * information, see CreateDeployment in the CodeDeploy API Reference.

- *

For services using an external deployment controller, you can update only the desired - * count, task placement constraints and strategies, health check grace period, enable ECS - * managed tags option, and propagate tags option, using this API. If the launch type, load - * balancer, network configuration, platform version, or task definition need to be - * updated, create a new task set For more information, see CreateTaskSet.

- *

You can add to or subtract from the number of instantiations of a task definition in a - * service by specifying the cluster that the service is running in and a new - * desiredCount parameter.

- *

If you have updated the Docker image of your application, you can create a new task - * definition with that image and deploy it to your service. The service scheduler uses the - * minimum healthy percent and maximum percent parameters (in the service's deployment - * configuration) to determine the deployment strategy.

- * - *

If your updated Docker image uses the same tag as what is in the existing task - * definition for your service (for example, my_image:latest), you don't - * need to create a new revision of your task definition. You can update the service - * using the forceNewDeployment option. The new tasks launched by the - * deployment pull the current image/tag combination from your repository when they - * start.

- *
- *

You can also update the deployment configuration of a service. When a deployment is - * triggered by updating the task definition of a service, the service scheduler uses the - * deployment configuration parameters, minimumHealthyPercent and - * maximumPercent, to determine the deployment strategy.

- *
    - *
  • - *

    If minimumHealthyPercent is below 100%, the scheduler can ignore - * desiredCount temporarily during a deployment. For example, if - * desiredCount is four tasks, a minimum of 50% allows the - * scheduler to stop two existing tasks before starting two new tasks. Tasks for - * services that don't use a load balancer are considered healthy if they're in the - * RUNNING state. Tasks for services that use a load balancer are - * considered healthy if they're in the RUNNING state and are reported - * as healthy by the load balancer.

    - *
  • - *
  • - *

    The maximumPercent parameter represents an upper limit on the - * number of running tasks during a deployment. You can use it to define the - * deployment batch size. For example, if desiredCount is four tasks, - * a maximum of 200% starts four new tasks before stopping the four older tasks - * (provided that the cluster resources required to do this are available).

    - *
  • - *
- *

When UpdateService stops a task during a deployment, the equivalent - * of docker stop is issued to the containers running in the task. This - * results in a SIGTERM and a 30-second timeout. After this, - * SIGKILL is sent and the containers are forcibly stopped. If the - * container handles the SIGTERM gracefully and exits within 30 seconds from - * receiving it, no SIGKILL is sent.

- *

When the service scheduler launches new tasks, it determines task placement in your - * cluster with the following logic.

- *
    - *
  • - *

    Determine which of the container instances in your cluster can support your - * service's task definition. For example, they have the required CPU, memory, - * ports, and container instance attributes.

    - *
  • - *
  • - *

    By default, the service scheduler attempts to balance tasks across - * Availability Zones in this manner even though you can choose a different - * placement strategy.

    - *
      - *
    • - *

      Sort the valid container instances by the fewest number of running - * tasks for this service in the same Availability Zone as the instance. - * For example, if zone A has one running service task and zones B and C - * each have zero, valid container instances in either zone B or C are - * considered optimal for placement.

      - *
    • - *
    • - *

      Place the new service task on a valid container instance in an optimal - * Availability Zone (based on the previous steps), favoring container - * instances with the fewest number of running tasks for this - * service.

      - *
    • - *
    - *
  • - *
- *

When the service scheduler stops running tasks, it attempts to maintain balance across - * the Availability Zones in your cluster using the following logic:

- *
    - *
  • - *

    Sort the container instances by the largest number of running tasks for this - * service in the same Availability Zone as the instance. For example, if zone A - * has one running service task and zones B and C each have two, container - * instances in either zone B or C are considered optimal for termination.

    - *
  • - *
  • - *

    Stop the task on a container instance in an optimal Availability Zone (based - * on the previous steps), favoring container instances with the largest number of - * running tasks for this service.

    - *
  • - *
- * - *

You must have a service-linked role when you update any of the following service - * properties. If you specified a custom role when you created the service, Amazon ECS - * automatically replaces the roleARN associated with the service with the ARN of your - * service-linked role. For more information, see Service-linked roles in the Amazon Elastic Container Service Developer Guide.

- *
    - *
  • - *

    - * loadBalancers, - *

    - *
  • - *
  • - *

    - * serviceRegistries - *

    - *
  • - *
- *
+ * @see {@link UpdateServiceCommand} */ - public updateService( - args: UpdateServiceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateService( - args: UpdateServiceCommandInput, - cb: (err: any, data?: UpdateServiceCommandOutput) => void - ): void; - public updateService( + updateService(args: UpdateServiceCommandInput, options?: __HttpHandlerOptions): Promise; + updateService(args: UpdateServiceCommandInput, cb: (err: any, data?: UpdateServiceCommandOutput) => void): void; + updateService( args: UpdateServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceCommandOutput) => void ): void; - public updateService( - args: UpdateServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServiceCommandOutput) => void), - cb?: (err: any, data?: UpdateServiceCommandOutput) => void - ): Promise | void { - const command = new UpdateServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies which task set in a service is the primary task set. Any parameters that are - * updated on the primary task set in a service will transition to the service. This is - * used when a service uses the EXTERNAL deployment controller type. For more - * information, see Amazon ECS Deployment - * Types in the Amazon Elastic Container Service Developer Guide.

+ * @see {@link UpdateServicePrimaryTaskSetCommand} */ - public updateServicePrimaryTaskSet( + updateServicePrimaryTaskSet( args: UpdateServicePrimaryTaskSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateServicePrimaryTaskSet( + updateServicePrimaryTaskSet( args: UpdateServicePrimaryTaskSetCommandInput, cb: (err: any, data?: UpdateServicePrimaryTaskSetCommandOutput) => void ): void; - public updateServicePrimaryTaskSet( + updateServicePrimaryTaskSet( args: UpdateServicePrimaryTaskSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServicePrimaryTaskSetCommandOutput) => void ): void; - public updateServicePrimaryTaskSet( - args: UpdateServicePrimaryTaskSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServicePrimaryTaskSetCommandOutput) => void), - cb?: (err: any, data?: UpdateServicePrimaryTaskSetCommandOutput) => void - ): Promise | void { - const command = new UpdateServicePrimaryTaskSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the protection status of a task. You can set protectionEnabled to - * true to protect your task from termination during scale-in events from - * Service - * Autoscaling or deployments.

- *

Task-protection, by default, expires after 2 hours at which point Amazon ECS clears the - * protectionEnabled property making the task eligible for termination by - * a subsequent scale-in event.

- *

You can specify a custom expiration period for task protection from 1 minute to up to - * 2,880 minutes (48 hours). To specify the custom expiration period, set the - * expiresInMinutes property. The expiresInMinutes property - * is always reset when you invoke this operation for a task that already has - * protectionEnabled set to true. You can keep extending the - * protection expiration period of a task by invoking this operation repeatedly.

- *

To learn more about Amazon ECS task protection, see Task scale-in - * protection in the - * Amazon Elastic Container Service Developer Guide - * .

- * - *

This operation is only supported for tasks belonging to an Amazon ECS service. Invoking - * this operation for a standalone task will result in an TASK_NOT_VALID - * failure. For more information, see API failure - * reasons.

- *
- * - *

If you prefer to set task protection from within the container, we recommend using - * the Task scale-in protection endpoint.

- *
+ * @see {@link UpdateTaskProtectionCommand} */ - public updateTaskProtection( + updateTaskProtection( args: UpdateTaskProtectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTaskProtection( + updateTaskProtection( args: UpdateTaskProtectionCommandInput, cb: (err: any, data?: UpdateTaskProtectionCommandOutput) => void ): void; - public updateTaskProtection( + updateTaskProtection( args: UpdateTaskProtectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTaskProtectionCommandOutput) => void ): void; - public updateTaskProtection( - args: UpdateTaskProtectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTaskProtectionCommandOutput) => void), - cb?: (err: any, data?: UpdateTaskProtectionCommandOutput) => void - ): Promise | void { - const command = new UpdateTaskProtectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies a task set. This is used when a service uses the EXTERNAL - * deployment controller type. For more information, see Amazon ECS Deployment - * Types in the Amazon Elastic Container Service Developer Guide.

+ * @see {@link UpdateTaskSetCommand} */ - public updateTaskSet( - args: UpdateTaskSetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateTaskSet( - args: UpdateTaskSetCommandInput, - cb: (err: any, data?: UpdateTaskSetCommandOutput) => void - ): void; - public updateTaskSet( + updateTaskSet(args: UpdateTaskSetCommandInput, options?: __HttpHandlerOptions): Promise; + updateTaskSet(args: UpdateTaskSetCommandInput, cb: (err: any, data?: UpdateTaskSetCommandOutput) => void): void; + updateTaskSet( args: UpdateTaskSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTaskSetCommandOutput) => void ): void; - public updateTaskSet( - args: UpdateTaskSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTaskSetCommandOutput) => void), - cb?: (err: any, data?: UpdateTaskSetCommandOutput) => void - ): Promise | void { - const command = new UpdateTaskSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Elastic Container Service + *

Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes + * it easy to run, stop, and manage Docker containers. You can host your cluster on a + * serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on + * Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) + * or External (on-premises) instances that you manage.

+ *

Amazon ECS makes it easy to launch and stop container-based applications with simple API + * calls. This makes it easy to get the state of your cluster from a centralized service, + * and gives you access to many familiar Amazon EC2 features.

+ *

You can use Amazon ECS to schedule the placement of containers across your cluster based on + * your resource needs, isolation policies, and availability requirements. With Amazon ECS, you + * don't need to operate your own cluster management and configuration management systems. + * You also don't need to worry about scaling your management infrastructure.

+ */ +export class ECS extends ECSClient implements ECS {} +createAggregatedClient(commands, ECS); diff --git a/clients/client-efs/src/EFS.ts b/clients/client-efs/src/EFS.ts index d0704ac04788..a4ff6d1520a2 100644 --- a/clients/client-efs/src/EFS.ts +++ b/clients/client-efs/src/EFS.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -139,1502 +140,527 @@ import { UpdateFileSystemCommandInput, UpdateFileSystemCommandOutput, } from "./commands/UpdateFileSystemCommand"; -import { EFSClient } from "./EFSClient"; +import { EFSClient, EFSClientConfig } from "./EFSClient"; -/** - * @public - * Amazon Elastic File System - *

Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for - * use with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and - * remove files, so that your applications have the storage they need, when they need it. For - * more information, see the Amazon Elastic File System API Reference and the Amazon Elastic File System User Guide.

- */ -export class EFS extends EFSClient { +const commands = { + CreateAccessPointCommand, + CreateFileSystemCommand, + CreateMountTargetCommand, + CreateReplicationConfigurationCommand, + CreateTagsCommand, + DeleteAccessPointCommand, + DeleteFileSystemCommand, + DeleteFileSystemPolicyCommand, + DeleteMountTargetCommand, + DeleteReplicationConfigurationCommand, + DeleteTagsCommand, + DescribeAccessPointsCommand, + DescribeAccountPreferencesCommand, + DescribeBackupPolicyCommand, + DescribeFileSystemPolicyCommand, + DescribeFileSystemsCommand, + DescribeLifecycleConfigurationCommand, + DescribeMountTargetsCommand, + DescribeMountTargetSecurityGroupsCommand, + DescribeReplicationConfigurationsCommand, + DescribeTagsCommand, + ListTagsForResourceCommand, + ModifyMountTargetSecurityGroupsCommand, + PutAccountPreferencesCommand, + PutBackupPolicyCommand, + PutFileSystemPolicyCommand, + PutLifecycleConfigurationCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateFileSystemCommand, +}; + +export interface EFS { /** - * @public - *

Creates an EFS access point. An access point is an application-specific view into an EFS - * file system that applies an operating system user and group, and a file system path, to any - * file system request made through the access point. The operating system user and group - * override any identity information provided by the NFS client. The file system path is exposed - * as the access point's root directory. Applications using the access point can only access data in - * the application's own directory and any subdirectories. To learn more, see Mounting a file system using EFS access - * points.

- * - *

If multiple requests to create access points on the same file system are sent in quick - * succession, and the file system is near the limit of 1000 access points, you may experience - * a throttling response for these requests. This is to ensure that the file system does not - * exceed the stated access point limit.

- *
- *

This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.

+ * @see {@link CreateAccessPointCommand} */ - public createAccessPoint( + createAccessPoint( args: CreateAccessPointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAccessPoint( + createAccessPoint( args: CreateAccessPointCommandInput, cb: (err: any, data?: CreateAccessPointCommandOutput) => void ): void; - public createAccessPoint( + createAccessPoint( args: CreateAccessPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessPointCommandOutput) => void ): void; - public createAccessPoint( - args: CreateAccessPointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAccessPointCommandOutput) => void), - cb?: (err: any, data?: CreateAccessPointCommandOutput) => void - ): Promise | void { - const command = new CreateAccessPointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new, empty file system. The operation requires a creation token in the - * request that Amazon EFS uses to ensure idempotent creation (calling the operation with same - * creation token has no effect). If a file system does not currently exist that is owned by the - * caller's Amazon Web Services account with the specified creation token, this operation does the - * following:

- *
    - *
  • - *

    Creates a new, empty file system. The file system will have an Amazon EFS assigned - * ID, and an initial lifecycle state creating.

    - *
  • - *
  • - *

    Returns with the description of the created file system.

    - *
  • - *
- *

Otherwise, this operation returns a FileSystemAlreadyExists error with the - * ID of the existing file system.

- * - *

For basic use cases, you can use a randomly generated UUID for the creation - * token.

- *
- *

The idempotent operation allows you to retry a CreateFileSystem call without - * risk of creating an extra file system. This can happen when an initial call fails in a way - * that leaves it uncertain whether or not a file system was actually created. An example might - * be that a transport level timeout occurred or your connection was reset. As long as you use - * the same creation token, if the initial call had succeeded in creating a file system, the - * client can learn of its existence from the FileSystemAlreadyExists error.

- *

For more information, see - * Creating a file system - * in the Amazon EFS User Guide.

- * - *

The CreateFileSystem call returns while the file system's lifecycle - * state is still creating. You can check the file system creation status by - * calling the DescribeFileSystems operation, which among other things returns the file - * system state.

- *
- *

This operation accepts an optional PerformanceMode parameter that you - * choose for your file system. We recommend generalPurpose performance mode for - * most file systems. File systems using the maxIO performance mode can scale to - * higher levels of aggregate throughput and operations per second with a tradeoff of slightly - * higher latencies for most file operations. The performance mode can't be changed after - * the file system has been created. For more information, see Amazon EFS performance - * modes.

- *

You can set the throughput mode for the file system using the ThroughputMode parameter.

- *

After the file system is fully created, Amazon EFS sets its lifecycle state to - * available, at which point you can create one or more mount targets for the file - * system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in - * your VPC by using the mount target. For more information, see Amazon EFS: How it Works.

- *

This operation requires permissions for the - * elasticfilesystem:CreateFileSystem action.

+ * @see {@link CreateFileSystemCommand} */ - public createFileSystem( + createFileSystem( args: CreateFileSystemCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFileSystem( + createFileSystem( args: CreateFileSystemCommandInput, cb: (err: any, data?: CreateFileSystemCommandOutput) => void ): void; - public createFileSystem( + createFileSystem( args: CreateFileSystemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFileSystemCommandOutput) => void ): void; - public createFileSystem( - args: CreateFileSystemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFileSystemCommandOutput) => void), - cb?: (err: any, data?: CreateFileSystemCommandOutput) => void - ): Promise | void { - const command = new CreateFileSystemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a mount target for a file system. You can then mount the file system on EC2 - * instances by using the mount target.

- *

You can create one mount target in each Availability Zone in your VPC. All EC2 - * instances in a VPC within a given Availability Zone share a single mount target for a given - * file system. If you have multiple subnets in an Availability Zone, you create a mount target - * in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target - * in order to access their file system.

- *

You can create only one mount target for an EFS file system using One Zone storage - * classes. You must create that mount target in the same Availability Zone in which the file - * system is located. Use the AvailabilityZoneName and - * AvailabiltyZoneId properties in the DescribeFileSystems - * response object to get this information. Use the subnetId associated with the - * file system's Availability Zone when creating the mount target.

- *

For more information, see Amazon EFS: How it Works.

- *

To create a mount target for a file system, the file system's lifecycle state must be - * available. For more information, see DescribeFileSystems.

- *

In the request, provide the following:

- *
    - *
  • - *

    The file system ID for which you are creating the mount - * target.

    - *
  • - *
  • - *

    A subnet ID, which determines the following:

    - *
      - *
    • - *

      The VPC in which Amazon EFS creates the mount target

      - *
    • - *
    • - *

      The Availability Zone in which Amazon EFS creates the mount target

      - *
    • - *
    • - *

      The IP address range from which Amazon EFS selects the IP address of the mount target - * (if you don't specify an IP address in the request)

      - *
    • - *
    - *
  • - *
- *

After creating the mount target, Amazon EFS returns a response that includes, a - * MountTargetId and an IpAddress. You use this IP address when - * mounting the file system in an EC2 instance. You can also use the mount target's DNS name - * when mounting the file system. The EC2 instance on which you mount the file system by using - * the mount target can resolve the mount target's DNS name to its IP address. For more - * information, see How it Works: - * Implementation Overview.

- *

Note that you can create mount targets for a file system in only one VPC, and there can - * be only one mount target per Availability Zone. That is, if the file system already has one or - * more mount targets created for it, the subnet specified in the request to add another mount - * target must meet the following requirements:

- *
    - *
  • - *

    Must belong to the same VPC as the subnets of the existing mount targets

    - *
  • - *
  • - *

    Must not be in the same Availability Zone as any of the subnets of the existing - * mount targets

    - *
  • - *
- *

If the request satisfies the requirements, Amazon EFS does the following:

- *
    - *
  • - *

    Creates a new mount target in the specified subnet.

    - *
  • - *
  • - *

    Also creates a new network interface in the subnet as follows:

    - *
      - *
    • - *

      If the request provides an IpAddress, Amazon EFS assigns that IP - * address to the network interface. Otherwise, Amazon EFS assigns a free address in the - * subnet (in the same way that the Amazon EC2 CreateNetworkInterface call - * does when a request does not specify a primary private IP address).

      - *
    • - *
    • - *

      If the request provides SecurityGroups, this network interface is - * associated with those security groups. Otherwise, it belongs to the default security - * group for the subnet's VPC.

      - *
    • - *
    • - *

      Assigns the description Mount target fsmt-id for - * file system fs-id - * where - * fsmt-id - * is the mount target ID, and - * fs-id - * is the FileSystemId.

      - *
    • - *
    • - *

      Sets the requesterManaged property of the network interface to - * true, and the requesterId value to - * EFS.

      - *
    • - *
    - *

    Each Amazon EFS mount target has one corresponding requester-managed EC2 network - * interface. After the network interface is created, Amazon EFS sets the - * NetworkInterfaceId field in the mount target's description to the - * network interface ID, and the IpAddress field to its address. If network - * interface creation fails, the entire CreateMountTarget operation - * fails.

    - *
  • - *
- * - *

The CreateMountTarget call returns only after creating the network - * interface, but while the mount target state is still creating, you can check - * the mount target creation status by calling the DescribeMountTargets operation, which among other things returns the mount - * target state.

- *
- *

We recommend that you create a mount target in each of the Availability Zones. There - * are cost considerations for using a file system in an Availability Zone through a mount target - * created in another Availability Zone. For more information, see Amazon EFS. In addition, by always using a mount target local to the - * instance's Availability Zone, you eliminate a partial failure scenario. If the - * Availability Zone in which your mount target is created goes down, then you can't access - * your file system through that mount target.

- *

This operation requires permissions for the following action on the file - * system:

- *
    - *
  • - *

    - * elasticfilesystem:CreateMountTarget - *

    - *
  • - *
- *

This operation also requires permissions for the following Amazon EC2 - * actions:

- *
    - *
  • - *

    - * ec2:DescribeSubnets - *

    - *
  • - *
  • - *

    - * ec2:DescribeNetworkInterfaces - *

    - *
  • - *
  • - *

    - * ec2:CreateNetworkInterface - *

    - *
  • - *
+ * @see {@link CreateMountTargetCommand} */ - public createMountTarget( + createMountTarget( args: CreateMountTargetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMountTarget( + createMountTarget( args: CreateMountTargetCommandInput, cb: (err: any, data?: CreateMountTargetCommandOutput) => void ): void; - public createMountTarget( + createMountTarget( args: CreateMountTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMountTargetCommandOutput) => void ): void; - public createMountTarget( - args: CreateMountTargetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMountTargetCommandOutput) => void), - cb?: (err: any, data?: CreateMountTargetCommandOutput) => void - ): Promise | void { - const command = new CreateMountTargetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a replication configuration that replicates an existing EFS file system to a new, - * read-only file system. For more information, see Amazon EFS replication in the - * Amazon EFS User Guide. The replication configuration - * specifies the following:

- *
    - *
  • - *

    - * Source file system - An existing EFS file system that you - * want replicated. The source file system cannot be a destination file system in an existing - * replication configuration.

    - *
  • - *
  • - *

    - * Destination file system configuration - The configuration of - * the destination file system to which the source file system will be replicated. There can - * only be one destination file system in a replication configuration. The destination file - * system configuration consists of the following properties:

    - *
      - *
    • - *

      - * Amazon Web Services Region - The Amazon Web Services Region in - * which the destination file system is created. Amazon EFS replication is - * available in all Amazon Web Services Regions that Amazon EFS is available in, - * except Africa (Cape Town), Asia Pacific (Hong Kong), Asia Pacific (Jakarta), Europe - * (Milan), and Middle East (Bahrain).

      - *
    • - *
    • - *

      - * Availability Zone - If you want the destination file system - * to use EFS One Zone availability and durability, you must specify the Availability - * Zone to create the file system in. For more information about EFS storage classes, see - * - * Amazon EFS storage classes in the Amazon EFS User - * Guide.

      - *
    • - *
    • - *

      - * Encryption - All destination file systems are created with - * encryption at rest enabled. You can specify the Key Management Service (KMS) key that is used to encrypt the destination file system. If you don't - * specify a KMS key, your service-managed KMS key for - * Amazon EFS is used.

      - * - *

      After the file system is created, you cannot change the KMS key.

      - *
      - *
    • - *
    - *
  • - *
- *

The following properties are set by default:

- *
    - *
  • - *

    - * Performance mode - The destination file system's performance - * mode matches that of the source file system, unless the destination file system uses EFS - * One Zone storage. In that case, the General Purpose performance mode is used. The - * performance mode cannot be changed.

    - *
  • - *
  • - *

    - * Throughput mode - The destination file system's throughput - * mode matches that of the source file system. After the file system is created, you can modify the - * throughput mode.

    - *
  • - *
- *

The following properties are turned off by default:

- *
    - *
  • - *

    - * Lifecycle management - EFS lifecycle management and EFS - * Intelligent-Tiering are not enabled on the destination file system. After the destination - * file system is created, you can enable EFS lifecycle management and EFS - * Intelligent-Tiering.

    - *
  • - *
  • - *

    - * Automatic backups - Automatic daily backups not enabled on - * the destination file system. After the file system is created, you can change this - * setting.

    - *
  • - *
- *

For more information, see Amazon EFS replication in the - * Amazon EFS User Guide.

+ * @see {@link CreateReplicationConfigurationCommand} */ - public createReplicationConfiguration( + createReplicationConfiguration( args: CreateReplicationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createReplicationConfiguration( + createReplicationConfiguration( args: CreateReplicationConfigurationCommandInput, cb: (err: any, data?: CreateReplicationConfigurationCommandOutput) => void ): void; - public createReplicationConfiguration( + createReplicationConfiguration( args: CreateReplicationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReplicationConfigurationCommandOutput) => void ): void; - public createReplicationConfiguration( - args: CreateReplicationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateReplicationConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateReplicationConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateReplicationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - * - *

DEPRECATED - CreateTags is deprecated and not maintained. To create tags for EFS - * resources, use the API action.

- *
- *

Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If - * a tag key specified in the request already exists on the file system, this operation - * overwrites its value with the value provided in the request. If you add the Name - * tag to your file system, Amazon EFS returns it in the response to the DescribeFileSystems operation.

- *

This operation requires permission for the elasticfilesystem:CreateTags - * action.

+ * @see {@link CreateTagsCommand} */ - public createTags(args: CreateTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public createTags(args: CreateTagsCommandInput, cb: (err: any, data?: CreateTagsCommandOutput) => void): void; - public createTags( + createTags(args: CreateTagsCommandInput, options?: __HttpHandlerOptions): Promise; + createTags(args: CreateTagsCommandInput, cb: (err: any, data?: CreateTagsCommandOutput) => void): void; + createTags( args: CreateTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTagsCommandOutput) => void ): void; - public createTags( - args: CreateTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTagsCommandOutput) => void), - cb?: (err: any, data?: CreateTagsCommandOutput) => void - ): Promise | void { - const command = new CreateTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified access point. After deletion is complete, new clients can no - * longer connect to the access points. Clients connected to the access point at the time of - * deletion will continue to function until they terminate their connection.

- *

This operation requires permissions for the elasticfilesystem:DeleteAccessPoint action.

+ * @see {@link DeleteAccessPointCommand} */ - public deleteAccessPoint( + deleteAccessPoint( args: DeleteAccessPointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAccessPoint( + deleteAccessPoint( args: DeleteAccessPointCommandInput, cb: (err: any, data?: DeleteAccessPointCommandOutput) => void ): void; - public deleteAccessPoint( + deleteAccessPoint( args: DeleteAccessPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessPointCommandOutput) => void ): void; - public deleteAccessPoint( - args: DeleteAccessPointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAccessPointCommandOutput) => void), - cb?: (err: any, data?: DeleteAccessPointCommandOutput) => void - ): Promise | void { - const command = new DeleteAccessPointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a file system, permanently severing access to its contents. Upon return, the - * file system no longer exists and you can't access any contents of the deleted file - * system.

- *

You need to manually delete mount targets attached to a file system before you can delete - * an EFS file system. This step is performed for you when you use the Amazon Web Services console - * to delete a file system.

- * - *

You cannot delete a file system that is part of an EFS Replication configuration. - * You need to delete the replication configuration first.

- *
- *

You can't delete a file system that is in use. That is, if the file system has - * any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget.

- * - *

The DeleteFileSystem call returns while the file system state is still - * deleting. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your - * account. If you pass file system ID or creation token for the deleted file system, the DescribeFileSystems returns a 404 FileSystemNotFound - * error.

- *
- *

This operation requires permissions for the - * elasticfilesystem:DeleteFileSystem action.

+ * @see {@link DeleteFileSystemCommand} */ - public deleteFileSystem( + deleteFileSystem( args: DeleteFileSystemCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFileSystem( + deleteFileSystem( args: DeleteFileSystemCommandInput, cb: (err: any, data?: DeleteFileSystemCommandOutput) => void ): void; - public deleteFileSystem( + deleteFileSystem( args: DeleteFileSystemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFileSystemCommandOutput) => void ): void; - public deleteFileSystem( - args: DeleteFileSystemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFileSystemCommandOutput) => void), - cb?: (err: any, data?: DeleteFileSystemCommandOutput) => void - ): Promise | void { - const command = new DeleteFileSystemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the FileSystemPolicy for the specified file system. - * The default FileSystemPolicy goes into effect once the existing policy is deleted. - * For more information about the default file system policy, see Using Resource-based Policies with EFS.

- *

This operation requires permissions for the elasticfilesystem:DeleteFileSystemPolicy action.

+ * @see {@link DeleteFileSystemPolicyCommand} */ - public deleteFileSystemPolicy( + deleteFileSystemPolicy( args: DeleteFileSystemPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFileSystemPolicy( + deleteFileSystemPolicy( args: DeleteFileSystemPolicyCommandInput, cb: (err: any, data?: DeleteFileSystemPolicyCommandOutput) => void ): void; - public deleteFileSystemPolicy( + deleteFileSystemPolicy( args: DeleteFileSystemPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFileSystemPolicyCommandOutput) => void ): void; - public deleteFileSystemPolicy( - args: DeleteFileSystemPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFileSystemPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteFileSystemPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteFileSystemPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified mount target.

- *

This operation forcibly breaks any mounts of the file system by using the mount target - * that is being deleted, which might disrupt instances or applications using those mounts. To - * avoid applications getting cut off abruptly, you might consider unmounting any mounts of the - * mount target, if feasible. The operation also deletes the associated network interface. - * Uncommitted writes might be lost, but breaking a mount target using this operation does not - * corrupt the file system itself. The file system you created remains. You can mount an EC2 - * instance in your VPC by using another mount target.

- *

This operation requires permissions for the following action on the file - * system:

- *
    - *
  • - *

    - * elasticfilesystem:DeleteMountTarget - *

    - *
  • - *
- * - *

The DeleteMountTarget call returns while the mount target state is still - * deleting. You can check the mount target deletion by calling the DescribeMountTargets operation, which returns a list of mount target - * descriptions for the given file system.

- *
- *

The operation also requires permissions for the following Amazon EC2 action on the - * mount target's network interface:

- *
    - *
  • - *

    - * ec2:DeleteNetworkInterface - *

    - *
  • - *
+ * @see {@link DeleteMountTargetCommand} */ - public deleteMountTarget( + deleteMountTarget( args: DeleteMountTargetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMountTarget( + deleteMountTarget( args: DeleteMountTargetCommandInput, cb: (err: any, data?: DeleteMountTargetCommandOutput) => void ): void; - public deleteMountTarget( + deleteMountTarget( args: DeleteMountTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMountTargetCommandOutput) => void ): void; - public deleteMountTarget( - args: DeleteMountTargetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMountTargetCommandOutput) => void), - cb?: (err: any, data?: DeleteMountTargetCommandOutput) => void - ): Promise | void { - const command = new DeleteMountTargetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing replication configuration. To delete a replication configuration, you - * must make the request from the Amazon Web Services Region in which the destination file system - * is located. Deleting a replication configuration ends the replication process. After a - * replication configuration is deleted, the destination file system is no longer read-only. You - * can write to the destination file system after its status becomes - * Writeable.

+ * @see {@link DeleteReplicationConfigurationCommand} */ - public deleteReplicationConfiguration( + deleteReplicationConfiguration( args: DeleteReplicationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteReplicationConfiguration( + deleteReplicationConfiguration( args: DeleteReplicationConfigurationCommandInput, cb: (err: any, data?: DeleteReplicationConfigurationCommandOutput) => void ): void; - public deleteReplicationConfiguration( + deleteReplicationConfiguration( args: DeleteReplicationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReplicationConfigurationCommandOutput) => void ): void; - public deleteReplicationConfiguration( - args: DeleteReplicationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteReplicationConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteReplicationConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteReplicationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - * - *

DEPRECATED - DeleteTags is deprecated and not maintained. To remove tags from EFS - * resources, use the API action.

- *
- *

Deletes the specified tags from a file system. If the DeleteTags request - * includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an - * error. For more information about tags and related restrictions, see Tag restrictions in the - * Billing and Cost Management User Guide.

- *

This operation requires permissions for the elasticfilesystem:DeleteTags - * action.

+ * @see {@link DeleteTagsCommand} */ - public deleteTags(args: DeleteTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteTags(args: DeleteTagsCommandInput, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void; - public deleteTags( + deleteTags(args: DeleteTagsCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTags(args: DeleteTagsCommandInput, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void; + deleteTags( args: DeleteTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTagsCommandOutput) => void ): void; - public deleteTags( - args: DeleteTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTagsCommandOutput) => void), - cb?: (err: any, data?: DeleteTagsCommandOutput) => void - ): Promise | void { - const command = new DeleteTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the description of a specific Amazon EFS access point if the AccessPointId is provided. - * If you provide an EFS FileSystemId, it returns descriptions of all access points for that file system. - * You can provide either an AccessPointId or a FileSystemId in the request, but not both.

- *

This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action.

+ * @see {@link DescribeAccessPointsCommand} */ - public describeAccessPoints( + describeAccessPoints( args: DescribeAccessPointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccessPoints( + describeAccessPoints( args: DescribeAccessPointsCommandInput, cb: (err: any, data?: DescribeAccessPointsCommandOutput) => void ): void; - public describeAccessPoints( + describeAccessPoints( args: DescribeAccessPointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccessPointsCommandOutput) => void ): void; - public describeAccessPoints( - args: DescribeAccessPointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccessPointsCommandOutput) => void), - cb?: (err: any, data?: DescribeAccessPointsCommandOutput) => void - ): Promise | void { - const command = new DescribeAccessPointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region. - * For more information, see Managing Amazon EFS resource IDs.

+ * @see {@link DescribeAccountPreferencesCommand} */ - public describeAccountPreferences( + describeAccountPreferences( args: DescribeAccountPreferencesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccountPreferences( + describeAccountPreferences( args: DescribeAccountPreferencesCommandInput, cb: (err: any, data?: DescribeAccountPreferencesCommandOutput) => void ): void; - public describeAccountPreferences( + describeAccountPreferences( args: DescribeAccountPreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountPreferencesCommandOutput) => void ): void; - public describeAccountPreferences( - args: DescribeAccountPreferencesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccountPreferencesCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountPreferencesCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountPreferencesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the backup policy for the specified EFS file system.

+ * @see {@link DescribeBackupPolicyCommand} */ - public describeBackupPolicy( + describeBackupPolicy( args: DescribeBackupPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBackupPolicy( + describeBackupPolicy( args: DescribeBackupPolicyCommandInput, cb: (err: any, data?: DescribeBackupPolicyCommandOutput) => void ): void; - public describeBackupPolicy( + describeBackupPolicy( args: DescribeBackupPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBackupPolicyCommandOutput) => void ): void; - public describeBackupPolicy( - args: DescribeBackupPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBackupPolicyCommandOutput) => void), - cb?: (err: any, data?: DescribeBackupPolicyCommandOutput) => void - ): Promise | void { - const command = new DescribeBackupPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the FileSystemPolicy for the specified EFS file system.

- *

This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy action.

+ * @see {@link DescribeFileSystemPolicyCommand} */ - public describeFileSystemPolicy( + describeFileSystemPolicy( args: DescribeFileSystemPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFileSystemPolicy( + describeFileSystemPolicy( args: DescribeFileSystemPolicyCommandInput, cb: (err: any, data?: DescribeFileSystemPolicyCommandOutput) => void ): void; - public describeFileSystemPolicy( + describeFileSystemPolicy( args: DescribeFileSystemPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFileSystemPolicyCommandOutput) => void ): void; - public describeFileSystemPolicy( - args: DescribeFileSystemPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFileSystemPolicyCommandOutput) => void), - cb?: (err: any, data?: DescribeFileSystemPolicyCommandOutput) => void - ): Promise | void { - const command = new DescribeFileSystemPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the description of a specific Amazon EFS file system if either the file system - * CreationToken or the FileSystemId is provided. Otherwise, it - * returns descriptions of all file systems owned by the caller's Amazon Web Services account in the - * Amazon Web Services Region of the endpoint that you're calling.

- *

When retrieving all file system descriptions, you can optionally specify the - * MaxItems parameter to limit the number of descriptions in a response. - * This number is automatically set to 100. If more file system descriptions remain, - * Amazon EFS returns a NextMarker, an opaque token, in the response. In this case, - * you should send a subsequent request with the Marker request parameter set to the - * value of NextMarker.

- *

To retrieve a list of your file system descriptions, this operation is used in an - * iterative process, where DescribeFileSystems is called first without the - * Marker and then the operation continues to call it with the Marker - * parameter set to the value of the NextMarker from the previous response until the - * response has no NextMarker.

- *

The order of file systems returned in the response of one - * DescribeFileSystems call and the order of file systems returned across the - * responses of a multi-call iteration is unspecified.

- *

This operation requires permissions for the - * elasticfilesystem:DescribeFileSystems action.

+ * @see {@link DescribeFileSystemsCommand} */ - public describeFileSystems( + describeFileSystems( args: DescribeFileSystemsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFileSystems( + describeFileSystems( args: DescribeFileSystemsCommandInput, cb: (err: any, data?: DescribeFileSystemsCommandOutput) => void ): void; - public describeFileSystems( + describeFileSystems( args: DescribeFileSystemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFileSystemsCommandOutput) => void ): void; - public describeFileSystems( - args: DescribeFileSystemsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFileSystemsCommandOutput) => void), - cb?: (err: any, data?: DescribeFileSystemsCommandOutput) => void - ): Promise | void { - const command = new DescribeFileSystemsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the current LifecycleConfiguration object for the specified Amazon - * EFS file system. EFS lifecycle management uses the LifecycleConfiguration object - * to identify which files to move to the EFS Infrequent Access (IA) storage class. For a file system - * without a LifecycleConfiguration object, the call returns an empty array in the - * response.

- *

When EFS Intelligent-Tiering is enabled, TransitionToPrimaryStorageClass has - * a value of AFTER_1_ACCESS.

- *

This operation requires permissions for the - * elasticfilesystem:DescribeLifecycleConfiguration operation.

+ * @see {@link DescribeLifecycleConfigurationCommand} */ - public describeLifecycleConfiguration( + describeLifecycleConfiguration( args: DescribeLifecycleConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLifecycleConfiguration( + describeLifecycleConfiguration( args: DescribeLifecycleConfigurationCommandInput, cb: (err: any, data?: DescribeLifecycleConfigurationCommandOutput) => void ): void; - public describeLifecycleConfiguration( + describeLifecycleConfiguration( args: DescribeLifecycleConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLifecycleConfigurationCommandOutput) => void ): void; - public describeLifecycleConfiguration( - args: DescribeLifecycleConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLifecycleConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeLifecycleConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeLifecycleConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the descriptions of all the current mount targets, or a specific mount target, - * for a file system. When requesting all of the current mount targets, the order of mount - * targets returned in the response is unspecified.

- *

This operation requires permissions for the - * elasticfilesystem:DescribeMountTargets action, on either the file system ID - * that you specify in FileSystemId, or on the file system of the mount target that - * you specify in MountTargetId.

+ * @see {@link DescribeMountTargetsCommand} */ - public describeMountTargets( + describeMountTargets( args: DescribeMountTargetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMountTargets( + describeMountTargets( args: DescribeMountTargetsCommandInput, cb: (err: any, data?: DescribeMountTargetsCommandOutput) => void ): void; - public describeMountTargets( + describeMountTargets( args: DescribeMountTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMountTargetsCommandOutput) => void ): void; - public describeMountTargets( - args: DescribeMountTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMountTargetsCommandOutput) => void), - cb?: (err: any, data?: DescribeMountTargetsCommandOutput) => void - ): Promise | void { - const command = new DescribeMountTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the security groups currently in effect for a mount target. This operation - * requires that the network interface of the mount target has been created and the lifecycle - * state of the mount target is not deleted.

- *

This operation requires permissions for the following actions:

- *
    - *
  • - *

    - * elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount - * target's file system.

    - *
  • - *
  • - *

    - * ec2:DescribeNetworkInterfaceAttribute action on the mount target's - * network interface.

    - *
  • - *
+ * @see {@link DescribeMountTargetSecurityGroupsCommand} */ - public describeMountTargetSecurityGroups( + describeMountTargetSecurityGroups( args: DescribeMountTargetSecurityGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMountTargetSecurityGroups( + describeMountTargetSecurityGroups( args: DescribeMountTargetSecurityGroupsCommandInput, cb: (err: any, data?: DescribeMountTargetSecurityGroupsCommandOutput) => void ): void; - public describeMountTargetSecurityGroups( + describeMountTargetSecurityGroups( args: DescribeMountTargetSecurityGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMountTargetSecurityGroupsCommandOutput) => void ): void; - public describeMountTargetSecurityGroups( - args: DescribeMountTargetSecurityGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMountTargetSecurityGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeMountTargetSecurityGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeMountTargetSecurityGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the replication configuration for a specific file system. If a file system is - * not specified, all of the replication configurations for the Amazon Web Services account in an - * Amazon Web Services Region are retrieved.

+ * @see {@link DescribeReplicationConfigurationsCommand} */ - public describeReplicationConfigurations( + describeReplicationConfigurations( args: DescribeReplicationConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReplicationConfigurations( + describeReplicationConfigurations( args: DescribeReplicationConfigurationsCommandInput, cb: (err: any, data?: DescribeReplicationConfigurationsCommandOutput) => void ): void; - public describeReplicationConfigurations( + describeReplicationConfigurations( args: DescribeReplicationConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReplicationConfigurationsCommandOutput) => void ): void; - public describeReplicationConfigurations( - args: DescribeReplicationConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReplicationConfigurationsCommandOutput) => void), - cb?: (err: any, data?: DescribeReplicationConfigurationsCommandOutput) => void - ): Promise | void { - const command = new DescribeReplicationConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - * - *

DEPRECATED - The DescribeTags action is deprecated and not maintained. To view - * tags associated with EFS resources, use the ListTagsForResource API - * action.

- *
- *

Returns the tags associated with a file system. The order of tags returned in the - * response of one DescribeTags call and the order of tags returned across the - * responses of a multiple-call iteration (when using pagination) is unspecified.

- *

This operation requires permissions for the - * elasticfilesystem:DescribeTags action.

+ * @see {@link DescribeTagsCommand} */ - public describeTags( - args: DescribeTagsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeTags(args: DescribeTagsCommandInput, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void; - public describeTags( + describeTags(args: DescribeTagsCommandInput, options?: __HttpHandlerOptions): Promise; + describeTags(args: DescribeTagsCommandInput, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void; + describeTags( args: DescribeTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTagsCommandOutput) => void ): void; - public describeTags( - args: DescribeTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTagsCommandOutput) => void), - cb?: (err: any, data?: DescribeTagsCommandOutput) => void - ): Promise | void { - const command = new DescribeTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all tags for a top-level EFS resource. You must provide the ID of the resource that you want to retrieve the tags for.

- *

This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the set of security groups in effect for a mount target.

- *

When you create a mount target, Amazon EFS also creates a new network interface. For - * more information, see CreateMountTarget. This operation replaces the security groups in effect for the - * network interface associated with a mount target, with the SecurityGroups - * provided in the request. This operation requires that the network interface of the mount - * target has been created and the lifecycle state of the mount target is not - * deleted.

- *

The operation requires permissions for the following actions:

- *
    - *
  • - *

    - * elasticfilesystem:ModifyMountTargetSecurityGroups action on the mount - * target's file system.

    - *
  • - *
  • - *

    - * ec2:ModifyNetworkInterfaceAttribute action on the mount target's network - * interface.

    - *
  • - *
+ * @see {@link ModifyMountTargetSecurityGroupsCommand} */ - public modifyMountTargetSecurityGroups( + modifyMountTargetSecurityGroups( args: ModifyMountTargetSecurityGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyMountTargetSecurityGroups( + modifyMountTargetSecurityGroups( args: ModifyMountTargetSecurityGroupsCommandInput, cb: (err: any, data?: ModifyMountTargetSecurityGroupsCommandOutput) => void ): void; - public modifyMountTargetSecurityGroups( + modifyMountTargetSecurityGroups( args: ModifyMountTargetSecurityGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyMountTargetSecurityGroupsCommandOutput) => void ): void; - public modifyMountTargetSecurityGroups( - args: ModifyMountTargetSecurityGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyMountTargetSecurityGroupsCommandOutput) => void), - cb?: (err: any, data?: ModifyMountTargetSecurityGroupsCommandOutput) => void - ): Promise | void { - const command = new ModifyMountTargetSecurityGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this operation to set the account preference in the current Amazon Web Services Region - * to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for - * new EFS file system and mount target resources. All existing resource IDs are not affected - * by any changes you make. You can set the ID preference during the - * opt-in period as EFS transitions to long resource IDs. For more information, - * see Managing Amazon EFS resource IDs.

- * - *

Starting in October, 2021, you will receive an error if you try to set the account preference - * to use the short 8 character format resource ID. Contact Amazon Web Services support if you - * receive an error and must use short IDs for file system and mount target resources.

- *
+ * @see {@link PutAccountPreferencesCommand} */ - public putAccountPreferences( + putAccountPreferences( args: PutAccountPreferencesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAccountPreferences( + putAccountPreferences( args: PutAccountPreferencesCommandInput, cb: (err: any, data?: PutAccountPreferencesCommandOutput) => void ): void; - public putAccountPreferences( + putAccountPreferences( args: PutAccountPreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccountPreferencesCommandOutput) => void ): void; - public putAccountPreferences( - args: PutAccountPreferencesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAccountPreferencesCommandOutput) => void), - cb?: (err: any, data?: PutAccountPreferencesCommandOutput) => void - ): Promise | void { - const command = new PutAccountPreferencesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system.

+ * @see {@link PutBackupPolicyCommand} */ - public putBackupPolicy( + putBackupPolicy( args: PutBackupPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBackupPolicy( - args: PutBackupPolicyCommandInput, - cb: (err: any, data?: PutBackupPolicyCommandOutput) => void - ): void; - public putBackupPolicy( + putBackupPolicy(args: PutBackupPolicyCommandInput, cb: (err: any, data?: PutBackupPolicyCommandOutput) => void): void; + putBackupPolicy( args: PutBackupPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBackupPolicyCommandOutput) => void ): void; - public putBackupPolicy( - args: PutBackupPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBackupPolicyCommandOutput) => void), - cb?: (err: any, data?: PutBackupPolicyCommandOutput) => void - ): Promise | void { - const command = new PutBackupPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Applies an Amazon EFS FileSystemPolicy to an Amazon EFS file system. - * A file system policy is an IAM resource-based policy and can contain multiple policy statements. - * A file system always has exactly one file system policy, which can be the default policy or - * an explicit policy set or updated using this API operation. - * EFS file system policies have a 20,000 character limit. - * When an explicit policy is set, it overrides the default policy. For more information about the default file system policy, see - * Default EFS File System Policy. - *

- * - *

EFS file system policies have a 20,000 character limit.

- *
- *

This operation requires permissions for the elasticfilesystem:PutFileSystemPolicy action.

+ * @see {@link PutFileSystemPolicyCommand} */ - public putFileSystemPolicy( + putFileSystemPolicy( args: PutFileSystemPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putFileSystemPolicy( + putFileSystemPolicy( args: PutFileSystemPolicyCommandInput, cb: (err: any, data?: PutFileSystemPolicyCommandOutput) => void ): void; - public putFileSystemPolicy( + putFileSystemPolicy( args: PutFileSystemPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutFileSystemPolicyCommandOutput) => void ): void; - public putFileSystemPolicy( - args: PutFileSystemPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutFileSystemPolicyCommandOutput) => void), - cb?: (err: any, data?: PutFileSystemPolicyCommandOutput) => void - ): Promise | void { - const command = new PutFileSystemPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this action to manage EFS lifecycle management and EFS Intelligent-Tiering. A - * LifecycleConfiguration consists of one or more LifecyclePolicy - * objects that define the following:

- *
    - *
  • - *

    - * EFS Lifecycle management - When Amazon EFS - * automatically transitions files in a file system into the lower-cost EFS Infrequent Access - * (IA) storage class.

    - *

    To enable EFS Lifecycle management, set the value of TransitionToIA to one of the available options.

    - *
  • - *
  • - *

    - * EFS Intelligent-Tiering - When Amazon EFS - * automatically transitions files from IA back into the file system's primary storage class - * (EFS Standard or EFS One Zone Standard).

    - *

    To enable EFS Intelligent-Tiering, set the value of - * TransitionToPrimaryStorageClass to AFTER_1_ACCESS.

    - *
  • - *
- *

For more information, see EFS Lifecycle Management.

- *

Each Amazon EFS file system supports one lifecycle configuration, which applies to - * all files in the file system. If a LifecycleConfiguration object already exists - * for the specified file system, a PutLifecycleConfiguration call modifies the - * existing configuration. A PutLifecycleConfiguration call with an empty - * LifecyclePolicies array in the request body deletes any existing - * LifecycleConfiguration and turns off lifecycle management and EFS - * Intelligent-Tiering for the file system.

- *

In the request, specify the following:

- *
    - *
  • - *

    The ID for the file system for which you are enabling, disabling, or modifying - * lifecycle management and EFS Intelligent-Tiering.

    - *
  • - *
  • - *

    A LifecyclePolicies array of LifecyclePolicy objects that - * define when files are moved into IA storage, and when they are moved back to Standard storage.

    - * - *

    Amazon EFS requires that each LifecyclePolicy - * object have only have a single transition, so the LifecyclePolicies array needs to be structured with separate - * LifecyclePolicy objects. See the example requests in the following section for more information.

    - *
    - *
  • - *
- *

This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation.

- *

To apply a LifecycleConfiguration object to an encrypted file system, you - * need the same Key Management Service permissions as when you created the encrypted file system.

+ * @see {@link PutLifecycleConfigurationCommand} */ - public putLifecycleConfiguration( + putLifecycleConfiguration( args: PutLifecycleConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putLifecycleConfiguration( + putLifecycleConfiguration( args: PutLifecycleConfigurationCommandInput, cb: (err: any, data?: PutLifecycleConfigurationCommandOutput) => void ): void; - public putLifecycleConfiguration( + putLifecycleConfiguration( args: PutLifecycleConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLifecycleConfigurationCommandOutput) => void ): void; - public putLifecycleConfiguration( - args: PutLifecycleConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutLifecycleConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutLifecycleConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutLifecycleConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a tag for an EFS resource. You can create tags for EFS file systems and access points using this API operation.

- *

This operation requires permissions for the elasticfilesystem:TagResource action.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from an EFS resource. You can remove tags from EFS file systems and access points using this API operation.

- *

This operation requires permissions for the elasticfilesystem:UntagResource action.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the throughput mode or the amount of provisioned throughput of an existing file - * system.

+ * @see {@link UpdateFileSystemCommand} */ - public updateFileSystem( + updateFileSystem( args: UpdateFileSystemCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFileSystem( + updateFileSystem( args: UpdateFileSystemCommandInput, cb: (err: any, data?: UpdateFileSystemCommandOutput) => void ): void; - public updateFileSystem( + updateFileSystem( args: UpdateFileSystemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFileSystemCommandOutput) => void ): void; - public updateFileSystem( - args: UpdateFileSystemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFileSystemCommandOutput) => void), - cb?: (err: any, data?: UpdateFileSystemCommandOutput) => void - ): Promise | void { - const command = new UpdateFileSystemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Elastic File System + *

Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for + * use with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and + * remove files, so that your applications have the storage they need, when they need it. For + * more information, see the Amazon Elastic File System API Reference and the Amazon Elastic File System User Guide.

+ */ +export class EFS extends EFSClient implements EFS {} +createAggregatedClient(commands, EFS); diff --git a/clients/client-eks/src/EKS.ts b/clients/client-eks/src/EKS.ts index bf6c6367c52a..bfca41ad4dcc 100644 --- a/clients/client-eks/src/EKS.ts +++ b/clients/client-eks/src/EKS.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -152,1324 +153,571 @@ import { UpdateNodegroupVersionCommandInput, UpdateNodegroupVersionCommandOutput, } from "./commands/UpdateNodegroupVersionCommand"; -import { EKSClient } from "./EKSClient"; +import { EKSClient, EKSClientConfig } from "./EKSClient"; -/** - * @public - *

Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy - * for you to run Kubernetes on Amazon Web Services without needing to stand up or maintain - * your own Kubernetes control plane. Kubernetes is an open-source system for automating - * the deployment, scaling, and management of containerized applications.

- *

Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so - * you can use all the existing plugins and tooling from the Kubernetes community. - * Applications running on Amazon EKS are fully compatible with applications - * running on any standard Kubernetes environment, whether running in on-premises data - * centers or public clouds. This means that you can easily migrate any standard Kubernetes - * application to Amazon EKS without any code modification required.

- */ -export class EKS extends EKSClient { +const commands = { + AssociateEncryptionConfigCommand, + AssociateIdentityProviderConfigCommand, + CreateAddonCommand, + CreateClusterCommand, + CreateFargateProfileCommand, + CreateNodegroupCommand, + DeleteAddonCommand, + DeleteClusterCommand, + DeleteFargateProfileCommand, + DeleteNodegroupCommand, + DeregisterClusterCommand, + DescribeAddonCommand, + DescribeAddonConfigurationCommand, + DescribeAddonVersionsCommand, + DescribeClusterCommand, + DescribeFargateProfileCommand, + DescribeIdentityProviderConfigCommand, + DescribeNodegroupCommand, + DescribeUpdateCommand, + DisassociateIdentityProviderConfigCommand, + ListAddonsCommand, + ListClustersCommand, + ListFargateProfilesCommand, + ListIdentityProviderConfigsCommand, + ListNodegroupsCommand, + ListTagsForResourceCommand, + ListUpdatesCommand, + RegisterClusterCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAddonCommand, + UpdateClusterConfigCommand, + UpdateClusterVersionCommand, + UpdateNodegroupConfigCommand, + UpdateNodegroupVersionCommand, +}; + +export interface EKS { /** - * @public - *

Associate encryption configuration to an existing cluster.

- *

You can use this API to enable encryption on existing clusters which do not have - * encryption already enabled. This allows you to implement a defense-in-depth security - * strategy without migrating applications to new Amazon EKS clusters.

+ * @see {@link AssociateEncryptionConfigCommand} */ - public associateEncryptionConfig( + associateEncryptionConfig( args: AssociateEncryptionConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateEncryptionConfig( + associateEncryptionConfig( args: AssociateEncryptionConfigCommandInput, cb: (err: any, data?: AssociateEncryptionConfigCommandOutput) => void ): void; - public associateEncryptionConfig( + associateEncryptionConfig( args: AssociateEncryptionConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateEncryptionConfigCommandOutput) => void ): void; - public associateEncryptionConfig( - args: AssociateEncryptionConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateEncryptionConfigCommandOutput) => void), - cb?: (err: any, data?: AssociateEncryptionConfigCommandOutput) => void - ): Promise | void { - const command = new AssociateEncryptionConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associate an identity provider configuration to a cluster.

- *

If you want to authenticate identities using an identity provider, you can create an - * identity provider configuration and associate it to your cluster. After configuring - * authentication to your cluster you can create Kubernetes roles and - * clusterroles to assign permissions to the roles, and then bind the - * roles to the identities using Kubernetes rolebindings and - * clusterrolebindings. For more information see Using RBAC - * Authorization in the Kubernetes documentation.

+ * @see {@link AssociateIdentityProviderConfigCommand} */ - public associateIdentityProviderConfig( + associateIdentityProviderConfig( args: AssociateIdentityProviderConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateIdentityProviderConfig( + associateIdentityProviderConfig( args: AssociateIdentityProviderConfigCommandInput, cb: (err: any, data?: AssociateIdentityProviderConfigCommandOutput) => void ): void; - public associateIdentityProviderConfig( + associateIdentityProviderConfig( args: AssociateIdentityProviderConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateIdentityProviderConfigCommandOutput) => void ): void; - public associateIdentityProviderConfig( - args: AssociateIdentityProviderConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateIdentityProviderConfigCommandOutput) => void), - cb?: (err: any, data?: AssociateIdentityProviderConfigCommandOutput) => void - ): Promise | void { - const command = new AssociateIdentityProviderConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Amazon EKS add-on.

- *

Amazon EKS add-ons help to automate the provisioning and lifecycle management - * of common operational software for Amazon EKS clusters. For more information, - * see Amazon EKS add-ons in the Amazon EKS User Guide.

+ * @see {@link CreateAddonCommand} */ - public createAddon(args: CreateAddonCommandInput, options?: __HttpHandlerOptions): Promise; - public createAddon(args: CreateAddonCommandInput, cb: (err: any, data?: CreateAddonCommandOutput) => void): void; - public createAddon( + createAddon(args: CreateAddonCommandInput, options?: __HttpHandlerOptions): Promise; + createAddon(args: CreateAddonCommandInput, cb: (err: any, data?: CreateAddonCommandOutput) => void): void; + createAddon( args: CreateAddonCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAddonCommandOutput) => void ): void; - public createAddon( - args: CreateAddonCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAddonCommandOutput) => void), - cb?: (err: any, data?: CreateAddonCommandOutput) => void - ): Promise | void { - const command = new CreateAddonCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Amazon EKS control plane.

- *

The Amazon EKS control plane consists of control plane instances that run the - * Kubernetes software, such as etcd and the API server. The control plane - * runs in an account managed by Amazon Web Services, and the Kubernetes API is exposed by - * the Amazon EKS API server endpoint. Each Amazon EKS cluster control - * plane is single tenant and unique. It runs on its own set of Amazon EC2 - * instances.

- *

The cluster control plane is provisioned across multiple Availability Zones and - * fronted by an Elastic Load Balancing - * Network Load Balancer. Amazon EKS also provisions elastic network interfaces in - * your VPC subnets to provide connectivity from the control plane instances to the nodes - * (for example, to support kubectl exec, logs, and - * proxy data flows).

- *

Amazon EKS nodes run in your Amazon Web Services account and connect to your - * cluster's control plane over the Kubernetes API server endpoint and a certificate file - * that is created for your cluster.

- *

In most cases, it takes several minutes to create a cluster. After you create an - * Amazon EKS cluster, you must configure your Kubernetes tooling to - * communicate with the API server and launch nodes into your cluster. For more - * information, see Managing Cluster Authentication and Launching - * Amazon EKS nodes in the Amazon EKS User Guide.

+ * @see {@link CreateClusterCommand} */ - public createCluster( - args: CreateClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createCluster( - args: CreateClusterCommandInput, - cb: (err: any, data?: CreateClusterCommandOutput) => void - ): void; - public createCluster( + createCluster(args: CreateClusterCommandInput, options?: __HttpHandlerOptions): Promise; + createCluster(args: CreateClusterCommandInput, cb: (err: any, data?: CreateClusterCommandOutput) => void): void; + createCluster( args: CreateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterCommandOutput) => void ): void; - public createCluster( - args: CreateClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateClusterCommandOutput) => void), - cb?: (err: any, data?: CreateClusterCommandOutput) => void - ): Promise | void { - const command = new CreateClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Fargate profile for your Amazon EKS cluster. You - * must have at least one Fargate profile in a cluster to be able to run - * pods on Fargate.

- *

The Fargate profile allows an administrator to declare which pods run - * on Fargate and specify which pods run on which Fargate - * profile. This declaration is done through the profile’s selectors. Each profile can have - * up to five selectors that contain a namespace and labels. A namespace is required for - * every selector. The label field consists of multiple optional key-value pairs. Pods that - * match the selectors are scheduled on Fargate. If a to-be-scheduled pod - * matches any of the selectors in the Fargate profile, then that pod is run - * on Fargate.

- *

When you create a Fargate profile, you must specify a pod execution - * role to use with the pods that are scheduled with the profile. This role is added to the - * cluster's Kubernetes Role Based Access Control (RBAC) for authorization so that the - * kubelet that is running on the Fargate infrastructure - * can register with your Amazon EKS cluster so that it can appear in your cluster - * as a node. The pod execution role also provides IAM permissions to the - * Fargate infrastructure to allow read access to Amazon ECR - * image repositories. For more information, see Pod - * Execution Role in the Amazon EKS User Guide.

- *

Fargate profiles are immutable. However, you can create a new updated - * profile to replace an existing profile and then delete the original after the updated - * profile has finished creating.

- *

If any Fargate profiles in a cluster are in the DELETING - * status, you must wait for that Fargate profile to finish deleting before - * you can create any other profiles in that cluster.

- *

For more information, see Fargate Profile in the - * Amazon EKS User Guide.

+ * @see {@link CreateFargateProfileCommand} */ - public createFargateProfile( + createFargateProfile( args: CreateFargateProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFargateProfile( + createFargateProfile( args: CreateFargateProfileCommandInput, cb: (err: any, data?: CreateFargateProfileCommandOutput) => void ): void; - public createFargateProfile( + createFargateProfile( args: CreateFargateProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFargateProfileCommandOutput) => void ): void; - public createFargateProfile( - args: CreateFargateProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFargateProfileCommandOutput) => void), - cb?: (err: any, data?: CreateFargateProfileCommandOutput) => void - ): Promise | void { - const command = new CreateFargateProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a managed node group for an Amazon EKS cluster. You can only create a - * node group for your cluster that is equal to the current Kubernetes version for the - * cluster. All node groups are created with the latest AMI release version for the - * respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using - * a launch template. For more information about using launch templates, see Launch - * template support.

- *

An Amazon EKS managed node group is an Amazon EC2 - * Auto Scaling group and associated Amazon EC2 instances that are managed by - * Amazon Web Services for an Amazon EKS cluster. For more information, see - * Managed node groups in the Amazon EKS User Guide.

- * - *

Windows AMI types are only supported for commercial Regions that support Windows - * Amazon EKS.

- *
+ * @see {@link CreateNodegroupCommand} */ - public createNodegroup( + createNodegroup( args: CreateNodegroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNodegroup( - args: CreateNodegroupCommandInput, - cb: (err: any, data?: CreateNodegroupCommandOutput) => void - ): void; - public createNodegroup( + createNodegroup(args: CreateNodegroupCommandInput, cb: (err: any, data?: CreateNodegroupCommandOutput) => void): void; + createNodegroup( args: CreateNodegroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNodegroupCommandOutput) => void ): void; - public createNodegroup( - args: CreateNodegroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNodegroupCommandOutput) => void), - cb?: (err: any, data?: CreateNodegroupCommandOutput) => void - ): Promise | void { - const command = new CreateNodegroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete an Amazon EKS add-on.

- *

When you remove the add-on, it will also be deleted from the cluster. You can always - * manually start an add-on on the cluster using the Kubernetes API.

+ * @see {@link DeleteAddonCommand} */ - public deleteAddon(args: DeleteAddonCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteAddon(args: DeleteAddonCommandInput, cb: (err: any, data?: DeleteAddonCommandOutput) => void): void; - public deleteAddon( + deleteAddon(args: DeleteAddonCommandInput, options?: __HttpHandlerOptions): Promise; + deleteAddon(args: DeleteAddonCommandInput, cb: (err: any, data?: DeleteAddonCommandOutput) => void): void; + deleteAddon( args: DeleteAddonCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAddonCommandOutput) => void ): void; - public deleteAddon( - args: DeleteAddonCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAddonCommandOutput) => void), - cb?: (err: any, data?: DeleteAddonCommandOutput) => void - ): Promise | void { - const command = new DeleteAddonCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the Amazon EKS cluster control plane.

- *

If you have active services in your cluster that are associated with a load balancer, - * you must delete those services before deleting the cluster so that the load balancers - * are deleted properly. Otherwise, you can have orphaned resources in your VPC that - * prevent you from being able to delete the VPC. For more information, see Deleting a - * Cluster in the Amazon EKS User Guide.

- *

If you have managed node groups or Fargate profiles attached to the - * cluster, you must delete them first. For more information, see DeleteNodegroup and DeleteFargateProfile.

+ * @see {@link DeleteClusterCommand} */ - public deleteCluster( - args: DeleteClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteCluster( - args: DeleteClusterCommandInput, - cb: (err: any, data?: DeleteClusterCommandOutput) => void - ): void; - public deleteCluster( + deleteCluster(args: DeleteClusterCommandInput, options?: __HttpHandlerOptions): Promise; + deleteCluster(args: DeleteClusterCommandInput, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void; + deleteCluster( args: DeleteClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClusterCommandOutput) => void ): void; - public deleteCluster( - args: DeleteClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteClusterCommandOutput) => void), - cb?: (err: any, data?: DeleteClusterCommandOutput) => void - ): Promise | void { - const command = new DeleteClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Fargate profile.

- *

When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. If those pods match - * another Fargate profile, then they are scheduled on Fargate with that profile. If they no longer match any Fargate profiles, then - * they are not scheduled on Fargate and they may remain in a pending - * state.

- *

Only one Fargate profile in a cluster can be in the - * DELETING status at a time. You must wait for a Fargate - * profile to finish deleting before you can delete any other profiles in that - * cluster.

+ * @see {@link DeleteFargateProfileCommand} */ - public deleteFargateProfile( + deleteFargateProfile( args: DeleteFargateProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFargateProfile( + deleteFargateProfile( args: DeleteFargateProfileCommandInput, cb: (err: any, data?: DeleteFargateProfileCommandOutput) => void ): void; - public deleteFargateProfile( + deleteFargateProfile( args: DeleteFargateProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFargateProfileCommandOutput) => void ): void; - public deleteFargateProfile( - args: DeleteFargateProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFargateProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteFargateProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteFargateProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon EKS node group for a cluster.

+ * @see {@link DeleteNodegroupCommand} */ - public deleteNodegroup( + deleteNodegroup( args: DeleteNodegroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNodegroup( - args: DeleteNodegroupCommandInput, - cb: (err: any, data?: DeleteNodegroupCommandOutput) => void - ): void; - public deleteNodegroup( + deleteNodegroup(args: DeleteNodegroupCommandInput, cb: (err: any, data?: DeleteNodegroupCommandOutput) => void): void; + deleteNodegroup( args: DeleteNodegroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNodegroupCommandOutput) => void ): void; - public deleteNodegroup( - args: DeleteNodegroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNodegroupCommandOutput) => void), - cb?: (err: any, data?: DeleteNodegroupCommandOutput) => void - ): Promise | void { - const command = new DeleteNodegroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deregisters a connected cluster to remove it from the Amazon EKS control - * plane.

+ * @see {@link DeregisterClusterCommand} */ - public deregisterCluster( + deregisterCluster( args: DeregisterClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterCluster( + deregisterCluster( args: DeregisterClusterCommandInput, cb: (err: any, data?: DeregisterClusterCommandOutput) => void ): void; - public deregisterCluster( + deregisterCluster( args: DeregisterClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterClusterCommandOutput) => void ): void; - public deregisterCluster( - args: DeregisterClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterClusterCommandOutput) => void), - cb?: (err: any, data?: DeregisterClusterCommandOutput) => void - ): Promise | void { - const command = new DeregisterClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an Amazon EKS add-on.

+ * @see {@link DescribeAddonCommand} */ - public describeAddon( - args: DescribeAddonCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeAddon( - args: DescribeAddonCommandInput, - cb: (err: any, data?: DescribeAddonCommandOutput) => void - ): void; - public describeAddon( + describeAddon(args: DescribeAddonCommandInput, options?: __HttpHandlerOptions): Promise; + describeAddon(args: DescribeAddonCommandInput, cb: (err: any, data?: DescribeAddonCommandOutput) => void): void; + describeAddon( args: DescribeAddonCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAddonCommandOutput) => void ): void; - public describeAddon( - args: DescribeAddonCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAddonCommandOutput) => void), - cb?: (err: any, data?: DescribeAddonCommandOutput) => void - ): Promise | void { - const command = new DescribeAddonCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns configuration options.

+ * @see {@link DescribeAddonConfigurationCommand} */ - public describeAddonConfiguration( + describeAddonConfiguration( args: DescribeAddonConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAddonConfiguration( + describeAddonConfiguration( args: DescribeAddonConfigurationCommandInput, cb: (err: any, data?: DescribeAddonConfigurationCommandOutput) => void ): void; - public describeAddonConfiguration( + describeAddonConfiguration( args: DescribeAddonConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAddonConfigurationCommandOutput) => void ): void; - public describeAddonConfiguration( - args: DescribeAddonConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAddonConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeAddonConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeAddonConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the versions for an add-on. Information such as the Kubernetes versions that you - * can use the add-on with, the owner, publisher, and the - * type of the add-on are returned.

+ * @see {@link DescribeAddonVersionsCommand} */ - public describeAddonVersions( + describeAddonVersions( args: DescribeAddonVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAddonVersions( + describeAddonVersions( args: DescribeAddonVersionsCommandInput, cb: (err: any, data?: DescribeAddonVersionsCommandOutput) => void ): void; - public describeAddonVersions( + describeAddonVersions( args: DescribeAddonVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAddonVersionsCommandOutput) => void ): void; - public describeAddonVersions( - args: DescribeAddonVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAddonVersionsCommandOutput) => void), - cb?: (err: any, data?: DescribeAddonVersionsCommandOutput) => void - ): Promise | void { - const command = new DescribeAddonVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns descriptive information about an Amazon EKS cluster.

- *

The API server endpoint and certificate authority data returned by this operation are - * required for kubelet and kubectl to communicate with your - * Kubernetes API server. For more information, see Create a - * kubeconfig for Amazon EKS.

- * - *

The API server endpoint and certificate authority data aren't available until the - * cluster reaches the ACTIVE state.

- *
+ * @see {@link DescribeClusterCommand} */ - public describeCluster( + describeCluster( args: DescribeClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCluster( - args: DescribeClusterCommandInput, - cb: (err: any, data?: DescribeClusterCommandOutput) => void - ): void; - public describeCluster( + describeCluster(args: DescribeClusterCommandInput, cb: (err: any, data?: DescribeClusterCommandOutput) => void): void; + describeCluster( args: DescribeClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClusterCommandOutput) => void ): void; - public describeCluster( - args: DescribeClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClusterCommandOutput) => void), - cb?: (err: any, data?: DescribeClusterCommandOutput) => void - ): Promise | void { - const command = new DescribeClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns descriptive information about an Fargate profile.

+ * @see {@link DescribeFargateProfileCommand} */ - public describeFargateProfile( + describeFargateProfile( args: DescribeFargateProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFargateProfile( + describeFargateProfile( args: DescribeFargateProfileCommandInput, cb: (err: any, data?: DescribeFargateProfileCommandOutput) => void ): void; - public describeFargateProfile( + describeFargateProfile( args: DescribeFargateProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFargateProfileCommandOutput) => void ): void; - public describeFargateProfile( - args: DescribeFargateProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFargateProfileCommandOutput) => void), - cb?: (err: any, data?: DescribeFargateProfileCommandOutput) => void - ): Promise | void { - const command = new DescribeFargateProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns descriptive information about an identity provider configuration.

+ * @see {@link DescribeIdentityProviderConfigCommand} */ - public describeIdentityProviderConfig( + describeIdentityProviderConfig( args: DescribeIdentityProviderConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeIdentityProviderConfig( + describeIdentityProviderConfig( args: DescribeIdentityProviderConfigCommandInput, cb: (err: any, data?: DescribeIdentityProviderConfigCommandOutput) => void ): void; - public describeIdentityProviderConfig( + describeIdentityProviderConfig( args: DescribeIdentityProviderConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIdentityProviderConfigCommandOutput) => void ): void; - public describeIdentityProviderConfig( - args: DescribeIdentityProviderConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeIdentityProviderConfigCommandOutput) => void), - cb?: (err: any, data?: DescribeIdentityProviderConfigCommandOutput) => void - ): Promise | void { - const command = new DescribeIdentityProviderConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns descriptive information about an Amazon EKS node group.

+ * @see {@link DescribeNodegroupCommand} */ - public describeNodegroup( + describeNodegroup( args: DescribeNodegroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNodegroup( + describeNodegroup( args: DescribeNodegroupCommandInput, cb: (err: any, data?: DescribeNodegroupCommandOutput) => void ): void; - public describeNodegroup( + describeNodegroup( args: DescribeNodegroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNodegroupCommandOutput) => void ): void; - public describeNodegroup( - args: DescribeNodegroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeNodegroupCommandOutput) => void), - cb?: (err: any, data?: DescribeNodegroupCommandOutput) => void - ): Promise | void { - const command = new DescribeNodegroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns descriptive information about an update against your Amazon EKS - * cluster or associated managed node group or Amazon EKS add-on.

- *

When the status of the update is Succeeded, the update is complete. If an - * update fails, the status is Failed, and an error detail explains the reason - * for the failure.

+ * @see {@link DescribeUpdateCommand} */ - public describeUpdate( + describeUpdate( args: DescribeUpdateCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeUpdate( - args: DescribeUpdateCommandInput, - cb: (err: any, data?: DescribeUpdateCommandOutput) => void - ): void; - public describeUpdate( + describeUpdate(args: DescribeUpdateCommandInput, cb: (err: any, data?: DescribeUpdateCommandOutput) => void): void; + describeUpdate( args: DescribeUpdateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUpdateCommandOutput) => void ): void; - public describeUpdate( - args: DescribeUpdateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUpdateCommandOutput) => void), - cb?: (err: any, data?: DescribeUpdateCommandOutput) => void - ): Promise | void { - const command = new DescribeUpdateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates an identity provider configuration from a cluster. If you disassociate - * an identity provider from your cluster, users included in the provider can no longer - * access the cluster. However, you can still access the cluster with Amazon Web Services - * IAM users.

+ * @see {@link DisassociateIdentityProviderConfigCommand} */ - public disassociateIdentityProviderConfig( + disassociateIdentityProviderConfig( args: DisassociateIdentityProviderConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateIdentityProviderConfig( + disassociateIdentityProviderConfig( args: DisassociateIdentityProviderConfigCommandInput, cb: (err: any, data?: DisassociateIdentityProviderConfigCommandOutput) => void ): void; - public disassociateIdentityProviderConfig( + disassociateIdentityProviderConfig( args: DisassociateIdentityProviderConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateIdentityProviderConfigCommandOutput) => void ): void; - public disassociateIdentityProviderConfig( - args: DisassociateIdentityProviderConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateIdentityProviderConfigCommandOutput) => void), - cb?: (err: any, data?: DisassociateIdentityProviderConfigCommandOutput) => void - ): Promise | void { - const command = new DisassociateIdentityProviderConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the available add-ons.

+ * @see {@link ListAddonsCommand} */ - public listAddons(args: ListAddonsCommandInput, options?: __HttpHandlerOptions): Promise; - public listAddons(args: ListAddonsCommandInput, cb: (err: any, data?: ListAddonsCommandOutput) => void): void; - public listAddons( + listAddons(args: ListAddonsCommandInput, options?: __HttpHandlerOptions): Promise; + listAddons(args: ListAddonsCommandInput, cb: (err: any, data?: ListAddonsCommandOutput) => void): void; + listAddons( args: ListAddonsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAddonsCommandOutput) => void ): void; - public listAddons( - args: ListAddonsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAddonsCommandOutput) => void), - cb?: (err: any, data?: ListAddonsCommandOutput) => void - ): Promise | void { - const command = new ListAddonsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the Amazon EKS clusters in your Amazon Web Services account in the - * specified Region.

+ * @see {@link ListClustersCommand} */ - public listClusters( - args: ListClustersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listClusters(args: ListClustersCommandInput, cb: (err: any, data?: ListClustersCommandOutput) => void): void; - public listClusters( + listClusters(args: ListClustersCommandInput, options?: __HttpHandlerOptions): Promise; + listClusters(args: ListClustersCommandInput, cb: (err: any, data?: ListClustersCommandOutput) => void): void; + listClusters( args: ListClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListClustersCommandOutput) => void ): void; - public listClusters( - args: ListClustersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListClustersCommandOutput) => void), - cb?: (err: any, data?: ListClustersCommandOutput) => void - ): Promise | void { - const command = new ListClustersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the Fargate profiles associated with the specified cluster in - * your Amazon Web Services account in the specified Region.

+ * @see {@link ListFargateProfilesCommand} */ - public listFargateProfiles( + listFargateProfiles( args: ListFargateProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFargateProfiles( + listFargateProfiles( args: ListFargateProfilesCommandInput, cb: (err: any, data?: ListFargateProfilesCommandOutput) => void ): void; - public listFargateProfiles( + listFargateProfiles( args: ListFargateProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFargateProfilesCommandOutput) => void ): void; - public listFargateProfiles( - args: ListFargateProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFargateProfilesCommandOutput) => void), - cb?: (err: any, data?: ListFargateProfilesCommandOutput) => void - ): Promise | void { - const command = new ListFargateProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A list of identity provider configurations.

+ * @see {@link ListIdentityProviderConfigsCommand} */ - public listIdentityProviderConfigs( + listIdentityProviderConfigs( args: ListIdentityProviderConfigsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listIdentityProviderConfigs( + listIdentityProviderConfigs( args: ListIdentityProviderConfigsCommandInput, cb: (err: any, data?: ListIdentityProviderConfigsCommandOutput) => void ): void; - public listIdentityProviderConfigs( + listIdentityProviderConfigs( args: ListIdentityProviderConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIdentityProviderConfigsCommandOutput) => void ): void; - public listIdentityProviderConfigs( - args: ListIdentityProviderConfigsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIdentityProviderConfigsCommandOutput) => void), - cb?: (err: any, data?: ListIdentityProviderConfigsCommandOutput) => void - ): Promise | void { - const command = new ListIdentityProviderConfigsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the Amazon EKS managed node groups associated with the specified cluster - * in your Amazon Web Services account in the specified Region. Self-managed node groups are - * not listed.

+ * @see {@link ListNodegroupsCommand} */ - public listNodegroups( + listNodegroups( args: ListNodegroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listNodegroups( - args: ListNodegroupsCommandInput, - cb: (err: any, data?: ListNodegroupsCommandOutput) => void - ): void; - public listNodegroups( + listNodegroups(args: ListNodegroupsCommandInput, cb: (err: any, data?: ListNodegroupsCommandOutput) => void): void; + listNodegroups( args: ListNodegroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNodegroupsCommandOutput) => void ): void; - public listNodegroups( - args: ListNodegroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNodegroupsCommandOutput) => void), - cb?: (err: any, data?: ListNodegroupsCommandOutput) => void - ): Promise | void { - const command = new ListNodegroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the tags for an Amazon EKS resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the updates associated with an Amazon EKS cluster or managed node group - * in your Amazon Web Services account, in the specified Region.

+ * @see {@link ListUpdatesCommand} */ - public listUpdates(args: ListUpdatesCommandInput, options?: __HttpHandlerOptions): Promise; - public listUpdates(args: ListUpdatesCommandInput, cb: (err: any, data?: ListUpdatesCommandOutput) => void): void; - public listUpdates( + listUpdates(args: ListUpdatesCommandInput, options?: __HttpHandlerOptions): Promise; + listUpdates(args: ListUpdatesCommandInput, cb: (err: any, data?: ListUpdatesCommandOutput) => void): void; + listUpdates( args: ListUpdatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUpdatesCommandOutput) => void ): void; - public listUpdates( - args: ListUpdatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUpdatesCommandOutput) => void), - cb?: (err: any, data?: ListUpdatesCommandOutput) => void - ): Promise | void { - const command = new ListUpdatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Connects a Kubernetes cluster to the Amazon EKS control plane.

- *

Any Kubernetes cluster can be connected to the Amazon EKS control plane to - * view current information about the cluster and its nodes.

- *

Cluster connection requires two steps. First, send a - * RegisterClusterRequest - * to add it to the Amazon EKS - * control plane.

- *

Second, a Manifest containing the activationID and - * activationCode must be applied to the Kubernetes cluster through it's - * native provider to provide visibility.

- *

After the Manifest is updated and applied, then the connected cluster is visible to - * the Amazon EKS control plane. If the Manifest is not applied within three days, - * then the connected cluster will no longer be visible and must be deregistered. See DeregisterCluster.

+ * @see {@link RegisterClusterCommand} */ - public registerCluster( + registerCluster( args: RegisterClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerCluster( - args: RegisterClusterCommandInput, - cb: (err: any, data?: RegisterClusterCommandOutput) => void - ): void; - public registerCluster( + registerCluster(args: RegisterClusterCommandInput, cb: (err: any, data?: RegisterClusterCommandOutput) => void): void; + registerCluster( args: RegisterClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterClusterCommandOutput) => void ): void; - public registerCluster( - args: RegisterClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterClusterCommandOutput) => void), - cb?: (err: any, data?: RegisterClusterCommandOutput) => void - ): Promise | void { - const command = new RegisterClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates the specified tags to a resource with the specified - * resourceArn. If existing tags on a resource are not specified in the - * request parameters, they are not changed. When a resource is deleted, the tags - * associated with that resource are deleted as well. Tags that you create for Amazon EKS resources do not propagate to any other resources associated with the - * cluster. For example, if you tag a cluster with this operation, that tag does not - * automatically propagate to the subnets and nodes associated with the cluster.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes specified tags from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an Amazon EKS add-on.

+ * @see {@link UpdateAddonCommand} */ - public updateAddon(args: UpdateAddonCommandInput, options?: __HttpHandlerOptions): Promise; - public updateAddon(args: UpdateAddonCommandInput, cb: (err: any, data?: UpdateAddonCommandOutput) => void): void; - public updateAddon( + updateAddon(args: UpdateAddonCommandInput, options?: __HttpHandlerOptions): Promise; + updateAddon(args: UpdateAddonCommandInput, cb: (err: any, data?: UpdateAddonCommandOutput) => void): void; + updateAddon( args: UpdateAddonCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAddonCommandOutput) => void ): void; - public updateAddon( - args: UpdateAddonCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAddonCommandOutput) => void), - cb?: (err: any, data?: UpdateAddonCommandOutput) => void - ): Promise | void { - const command = new UpdateAddonCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an Amazon EKS cluster configuration. Your cluster continues to - * function during the update. The response output includes an update ID that you can use - * to track the status of your cluster update with the DescribeUpdate API - * operation.

- *

You can use this API operation to enable or disable exporting the Kubernetes control - * plane logs for your cluster to CloudWatch Logs. By default, cluster control plane - * logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the - * - * Amazon EKS User Guide - * .

- * - *

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to - * exported control plane logs. For more information, see CloudWatch - * Pricing.

- *
- *

You can also use this API operation to enable or disable public and private access to - * your cluster's Kubernetes API server endpoint. By default, public access is enabled, and - * private access is disabled. For more information, see Amazon EKS cluster endpoint access control in the - * - * Amazon EKS User Guide - * .

- * - *

You can't update the subnets or security group IDs for an existing cluster.

- *
- *

Cluster updates are asynchronous, and they should finish within a few minutes. During - * an update, the cluster status moves to UPDATING (this status transition is - * eventually consistent). When the update is complete (either Failed or - * Successful), the cluster status moves to Active.

+ * @see {@link UpdateClusterConfigCommand} */ - public updateClusterConfig( + updateClusterConfig( args: UpdateClusterConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateClusterConfig( + updateClusterConfig( args: UpdateClusterConfigCommandInput, cb: (err: any, data?: UpdateClusterConfigCommandOutput) => void ): void; - public updateClusterConfig( + updateClusterConfig( args: UpdateClusterConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateClusterConfigCommandOutput) => void ): void; - public updateClusterConfig( - args: UpdateClusterConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateClusterConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateClusterConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateClusterConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an Amazon EKS cluster to the specified Kubernetes version. Your - * cluster continues to function during the update. The response output includes an update - * ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.

- *

Cluster updates are asynchronous, and they should finish within a few minutes. During - * an update, the cluster status moves to UPDATING (this status transition is - * eventually consistent). When the update is complete (either Failed or - * Successful), the cluster status moves to Active.

- *

If your cluster has managed node groups attached to it, all of your node groups’ - * Kubernetes versions must match the cluster’s Kubernetes version in order to update the - * cluster to a new Kubernetes version.

+ * @see {@link UpdateClusterVersionCommand} */ - public updateClusterVersion( + updateClusterVersion( args: UpdateClusterVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateClusterVersion( + updateClusterVersion( args: UpdateClusterVersionCommandInput, cb: (err: any, data?: UpdateClusterVersionCommandOutput) => void ): void; - public updateClusterVersion( + updateClusterVersion( args: UpdateClusterVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateClusterVersionCommandOutput) => void ): void; - public updateClusterVersion( - args: UpdateClusterVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateClusterVersionCommandOutput) => void), - cb?: (err: any, data?: UpdateClusterVersionCommandOutput) => void - ): Promise | void { - const command = new UpdateClusterVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an Amazon EKS managed node group configuration. Your node group - * continues to function during the update. The response output includes an update ID that - * you can use to track the status of your node group update with the DescribeUpdate API operation. Currently you can update the Kubernetes - * labels for a node group or the scaling configuration.

+ * @see {@link UpdateNodegroupConfigCommand} */ - public updateNodegroupConfig( + updateNodegroupConfig( args: UpdateNodegroupConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateNodegroupConfig( + updateNodegroupConfig( args: UpdateNodegroupConfigCommandInput, cb: (err: any, data?: UpdateNodegroupConfigCommandOutput) => void ): void; - public updateNodegroupConfig( + updateNodegroupConfig( args: UpdateNodegroupConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNodegroupConfigCommandOutput) => void ): void; - public updateNodegroupConfig( - args: UpdateNodegroupConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateNodegroupConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateNodegroupConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateNodegroupConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the Kubernetes version or AMI version of an Amazon EKS managed node - * group.

- *

You can update a node group using a launch template only if the node group was - * originally deployed with a launch template. If you need to update a custom AMI in a node - * group that was deployed with a launch template, then update your custom AMI, specify the - * new ID in a new version of the launch template, and then update the node group to the - * new version of the launch template.

- *

If you update without a launch template, then you can update to the latest available - * AMI version of a node group's current Kubernetes version by not specifying a Kubernetes version in - * the request. You can update to the latest AMI version of your cluster's current Kubernetes - * version by specifying your cluster's Kubernetes version in the request. For information about - * Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the - * Amazon EKS User Guide. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the - * Amazon EKS User Guide.

- *

You cannot roll back a node group to an earlier Kubernetes version or AMI - * version.

- *

When a node in a managed node group is terminated due to a scaling action or update, - * the pods in that node are drained first. Amazon EKS attempts to drain the nodes - * gracefully and will fail if it is unable to do so. You can force the update - * if Amazon EKS is unable to drain the nodes as a result of a pod disruption - * budget issue.

+ * @see {@link UpdateNodegroupVersionCommand} */ - public updateNodegroupVersion( + updateNodegroupVersion( args: UpdateNodegroupVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateNodegroupVersion( + updateNodegroupVersion( args: UpdateNodegroupVersionCommandInput, cb: (err: any, data?: UpdateNodegroupVersionCommandOutput) => void ): void; - public updateNodegroupVersion( + updateNodegroupVersion( args: UpdateNodegroupVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNodegroupVersionCommandOutput) => void ): void; - public updateNodegroupVersion( - args: UpdateNodegroupVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateNodegroupVersionCommandOutput) => void), - cb?: (err: any, data?: UpdateNodegroupVersionCommandOutput) => void - ): Promise | void { - const command = new UpdateNodegroupVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy + * for you to run Kubernetes on Amazon Web Services without needing to stand up or maintain + * your own Kubernetes control plane. Kubernetes is an open-source system for automating + * the deployment, scaling, and management of containerized applications.

+ *

Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so + * you can use all the existing plugins and tooling from the Kubernetes community. + * Applications running on Amazon EKS are fully compatible with applications + * running on any standard Kubernetes environment, whether running in on-premises data + * centers or public clouds. This means that you can easily migrate any standard Kubernetes + * application to Amazon EKS without any code modification required.

+ */ +export class EKS extends EKSClient implements EKS {} +createAggregatedClient(commands, EKS); diff --git a/clients/client-elastic-beanstalk/src/ElasticBeanstalk.ts b/clients/client-elastic-beanstalk/src/ElasticBeanstalk.ts index f127e6409d3e..8899f492415c 100644 --- a/clients/client-elastic-beanstalk/src/ElasticBeanstalk.ts +++ b/clients/client-elastic-beanstalk/src/ElasticBeanstalk.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -236,1773 +237,871 @@ import { ValidateConfigurationSettingsCommandInput, ValidateConfigurationSettingsCommandOutput, } from "./commands/ValidateConfigurationSettingsCommand"; -import { ElasticBeanstalkClient } from "./ElasticBeanstalkClient"; +import { ElasticBeanstalkClient, ElasticBeanstalkClientConfig } from "./ElasticBeanstalkClient"; -/** - * @public - * AWS Elastic Beanstalk - *

AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable, - * fault-tolerant applications running on the Amazon Web Services cloud.

- *

For more information about this product, go to the AWS Elastic Beanstalk details page. The location of the - * latest AWS Elastic Beanstalk WSDL is https://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl. - * To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) - * Toolkits, and command line tools that enable you to access the API, go to Tools for Amazon Web Services.

- *

- * Endpoints - *

- *

For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to - * Regions and Endpoints in the Amazon Web Services - * Glossary.

- */ -export class ElasticBeanstalk extends ElasticBeanstalkClient { +const commands = { + AbortEnvironmentUpdateCommand, + ApplyEnvironmentManagedActionCommand, + AssociateEnvironmentOperationsRoleCommand, + CheckDNSAvailabilityCommand, + ComposeEnvironmentsCommand, + CreateApplicationCommand, + CreateApplicationVersionCommand, + CreateConfigurationTemplateCommand, + CreateEnvironmentCommand, + CreatePlatformVersionCommand, + CreateStorageLocationCommand, + DeleteApplicationCommand, + DeleteApplicationVersionCommand, + DeleteConfigurationTemplateCommand, + DeleteEnvironmentConfigurationCommand, + DeletePlatformVersionCommand, + DescribeAccountAttributesCommand, + DescribeApplicationsCommand, + DescribeApplicationVersionsCommand, + DescribeConfigurationOptionsCommand, + DescribeConfigurationSettingsCommand, + DescribeEnvironmentHealthCommand, + DescribeEnvironmentManagedActionHistoryCommand, + DescribeEnvironmentManagedActionsCommand, + DescribeEnvironmentResourcesCommand, + DescribeEnvironmentsCommand, + DescribeEventsCommand, + DescribeInstancesHealthCommand, + DescribePlatformVersionCommand, + DisassociateEnvironmentOperationsRoleCommand, + ListAvailableSolutionStacksCommand, + ListPlatformBranchesCommand, + ListPlatformVersionsCommand, + ListTagsForResourceCommand, + RebuildEnvironmentCommand, + RequestEnvironmentInfoCommand, + RestartAppServerCommand, + RetrieveEnvironmentInfoCommand, + SwapEnvironmentCNAMEsCommand, + TerminateEnvironmentCommand, + UpdateApplicationCommand, + UpdateApplicationResourceLifecycleCommand, + UpdateApplicationVersionCommand, + UpdateConfigurationTemplateCommand, + UpdateEnvironmentCommand, + UpdateTagsForResourceCommand, + ValidateConfigurationSettingsCommand, +}; + +export interface ElasticBeanstalk { /** - * @public - *

Cancels in-progress environment configuration update or application version - * deployment.

+ * @see {@link AbortEnvironmentUpdateCommand} */ - public abortEnvironmentUpdate( + abortEnvironmentUpdate( args: AbortEnvironmentUpdateCommandInput, options?: __HttpHandlerOptions ): Promise; - public abortEnvironmentUpdate( + abortEnvironmentUpdate( args: AbortEnvironmentUpdateCommandInput, cb: (err: any, data?: AbortEnvironmentUpdateCommandOutput) => void ): void; - public abortEnvironmentUpdate( + abortEnvironmentUpdate( args: AbortEnvironmentUpdateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AbortEnvironmentUpdateCommandOutput) => void ): void; - public abortEnvironmentUpdate( - args: AbortEnvironmentUpdateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AbortEnvironmentUpdateCommandOutput) => void), - cb?: (err: any, data?: AbortEnvironmentUpdateCommandOutput) => void - ): Promise | void { - const command = new AbortEnvironmentUpdateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Applies a scheduled managed action immediately. A managed action can be applied only if - * its status is Scheduled. Get the status and action ID of a managed action with - * DescribeEnvironmentManagedActions.

+ * @see {@link ApplyEnvironmentManagedActionCommand} */ - public applyEnvironmentManagedAction( + applyEnvironmentManagedAction( args: ApplyEnvironmentManagedActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public applyEnvironmentManagedAction( + applyEnvironmentManagedAction( args: ApplyEnvironmentManagedActionCommandInput, cb: (err: any, data?: ApplyEnvironmentManagedActionCommandOutput) => void ): void; - public applyEnvironmentManagedAction( + applyEnvironmentManagedAction( args: ApplyEnvironmentManagedActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ApplyEnvironmentManagedActionCommandOutput) => void ): void; - public applyEnvironmentManagedAction( - args: ApplyEnvironmentManagedActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ApplyEnvironmentManagedActionCommandOutput) => void), - cb?: (err: any, data?: ApplyEnvironmentManagedActionCommandOutput) => void - ): Promise | void { - const command = new ApplyEnvironmentManagedActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Add or change the operations role used by an environment. After this call is made, Elastic Beanstalk - * uses the associated operations role for permissions to downstream services during subsequent - * calls acting on this environment. For more information, see Operations roles in the - * AWS Elastic Beanstalk Developer Guide.

+ * @see {@link AssociateEnvironmentOperationsRoleCommand} */ - public associateEnvironmentOperationsRole( + associateEnvironmentOperationsRole( args: AssociateEnvironmentOperationsRoleCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateEnvironmentOperationsRole( + associateEnvironmentOperationsRole( args: AssociateEnvironmentOperationsRoleCommandInput, cb: (err: any, data?: AssociateEnvironmentOperationsRoleCommandOutput) => void ): void; - public associateEnvironmentOperationsRole( + associateEnvironmentOperationsRole( args: AssociateEnvironmentOperationsRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateEnvironmentOperationsRoleCommandOutput) => void ): void; - public associateEnvironmentOperationsRole( - args: AssociateEnvironmentOperationsRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateEnvironmentOperationsRoleCommandOutput) => void), - cb?: (err: any, data?: AssociateEnvironmentOperationsRoleCommandOutput) => void - ): Promise | void { - const command = new AssociateEnvironmentOperationsRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Checks if the specified CNAME is available.

+ * @see {@link CheckDNSAvailabilityCommand} */ - public checkDNSAvailability( + checkDNSAvailability( args: CheckDNSAvailabilityCommandInput, options?: __HttpHandlerOptions ): Promise; - public checkDNSAvailability( + checkDNSAvailability( args: CheckDNSAvailabilityCommandInput, cb: (err: any, data?: CheckDNSAvailabilityCommandOutput) => void ): void; - public checkDNSAvailability( + checkDNSAvailability( args: CheckDNSAvailabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CheckDNSAvailabilityCommandOutput) => void ): void; - public checkDNSAvailability( - args: CheckDNSAvailabilityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CheckDNSAvailabilityCommandOutput) => void), - cb?: (err: any, data?: CheckDNSAvailabilityCommandOutput) => void - ): Promise | void { - const command = new CheckDNSAvailabilityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create or update a group of environments that each run a separate component of a single - * application. Takes a list of version labels that specify application source bundles for each - * of the environments to create or update. The name of each environment and other required - * information must be included in the source bundles in an environment manifest named - * env.yaml. See Compose Environments - * for details.

+ * @see {@link ComposeEnvironmentsCommand} */ - public composeEnvironments( + composeEnvironments( args: ComposeEnvironmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public composeEnvironments( + composeEnvironments( args: ComposeEnvironmentsCommandInput, cb: (err: any, data?: ComposeEnvironmentsCommandOutput) => void ): void; - public composeEnvironments( + composeEnvironments( args: ComposeEnvironmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ComposeEnvironmentsCommandOutput) => void ): void; - public composeEnvironments( - args: ComposeEnvironmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ComposeEnvironmentsCommandOutput) => void), - cb?: (err: any, data?: ComposeEnvironmentsCommandOutput) => void - ): Promise | void { - const command = new ComposeEnvironmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an application that has one configuration template named default - * and no application versions.

+ * @see {@link CreateApplicationCommand} */ - public createApplication( + createApplication( args: CreateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApplication( + createApplication( args: CreateApplicationCommandInput, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( + createApplication( args: CreateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( - args: CreateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApplicationCommandOutput) => void), - cb?: (err: any, data?: CreateApplicationCommandOutput) => void - ): Promise | void { - const command = new CreateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an application version for the specified application. You can create an - * application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the - * output of an AWS CodeBuild build as follows:

- *

Specify a commit in an AWS CodeCommit repository with - * SourceBuildInformation.

- *

Specify a build in an AWS CodeBuild with SourceBuildInformation and - * BuildConfiguration.

- *

Specify a source bundle in S3 with SourceBundle - *

- *

Omit both SourceBuildInformation and SourceBundle to use the - * default sample application.

- * - *

After you create an application version with a specified Amazon S3 bucket and key - * location, you can't change that Amazon S3 location. If you change the Amazon S3 location, - * you receive an exception when you attempt to launch an environment from the application - * version.

- *
+ * @see {@link CreateApplicationVersionCommand} */ - public createApplicationVersion( + createApplicationVersion( args: CreateApplicationVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApplicationVersion( + createApplicationVersion( args: CreateApplicationVersionCommandInput, cb: (err: any, data?: CreateApplicationVersionCommandOutput) => void ): void; - public createApplicationVersion( + createApplicationVersion( args: CreateApplicationVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApplicationVersionCommandOutput) => void ): void; - public createApplicationVersion( - args: CreateApplicationVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApplicationVersionCommandOutput) => void), - cb?: (err: any, data?: CreateApplicationVersionCommandOutput) => void - ): Promise | void { - const command = new CreateApplicationVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk - * application. You define application configuration settings in a configuration template. You - * can then use the configuration template to deploy different versions of the application with - * the same configuration settings.

- *

Templates aren't associated with any environment. The EnvironmentName - * response element is always null.

- *

Related Topics

- * + * @see {@link CreateConfigurationTemplateCommand} */ - public createConfigurationTemplate( + createConfigurationTemplate( args: CreateConfigurationTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConfigurationTemplate( + createConfigurationTemplate( args: CreateConfigurationTemplateCommandInput, cb: (err: any, data?: CreateConfigurationTemplateCommandOutput) => void ): void; - public createConfigurationTemplate( + createConfigurationTemplate( args: CreateConfigurationTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfigurationTemplateCommandOutput) => void ): void; - public createConfigurationTemplate( - args: CreateConfigurationTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConfigurationTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateConfigurationTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateConfigurationTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Launches an AWS Elastic Beanstalk environment for the specified application using the specified - * configuration.

+ * @see {@link CreateEnvironmentCommand} */ - public createEnvironment( + createEnvironment( args: CreateEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEnvironment( + createEnvironment( args: CreateEnvironmentCommandInput, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void ): void; - public createEnvironment( + createEnvironment( args: CreateEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void ): void; - public createEnvironment( - args: CreateEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEnvironmentCommandOutput) => void), - cb?: (err: any, data?: CreateEnvironmentCommandOutput) => void - ): Promise | void { - const command = new CreateEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create a new version of your custom platform.

+ * @see {@link CreatePlatformVersionCommand} */ - public createPlatformVersion( + createPlatformVersion( args: CreatePlatformVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPlatformVersion( + createPlatformVersion( args: CreatePlatformVersionCommandInput, cb: (err: any, data?: CreatePlatformVersionCommandOutput) => void ): void; - public createPlatformVersion( + createPlatformVersion( args: CreatePlatformVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePlatformVersionCommandOutput) => void ): void; - public createPlatformVersion( - args: CreatePlatformVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePlatformVersionCommandOutput) => void), - cb?: (err: any, data?: CreatePlatformVersionCommandOutput) => void - ): Promise | void { - const command = new CreatePlatformVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a bucket in Amazon S3 to store application versions, logs, and other files used - * by Elastic Beanstalk environments. The Elastic Beanstalk console and EB CLI call this API the - * first time you create an environment in a region. If the storage location already exists, - * CreateStorageLocation still returns the bucket name but does not create a new - * bucket.

+ * @see {@link CreateStorageLocationCommand} */ - public createStorageLocation( + createStorageLocation( args: CreateStorageLocationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createStorageLocation( + createStorageLocation( args: CreateStorageLocationCommandInput, cb: (err: any, data?: CreateStorageLocationCommandOutput) => void ): void; - public createStorageLocation( + createStorageLocation( args: CreateStorageLocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStorageLocationCommandOutput) => void ): void; - public createStorageLocation( - args: CreateStorageLocationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStorageLocationCommandOutput) => void), - cb?: (err: any, data?: CreateStorageLocationCommandOutput) => void - ): Promise | void { - const command = new CreateStorageLocationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified application along with all associated versions and - * configurations. The application versions will not be deleted from your Amazon S3 - * bucket.

- * - *

You cannot delete an application that has a running environment.

- *
+ * @see {@link DeleteApplicationCommand} */ - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( - args: DeleteApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApplicationCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified version from the specified application.

- * - *

You cannot delete an application version that is associated with a running - * environment.

- *
+ * @see {@link DeleteApplicationVersionCommand} */ - public deleteApplicationVersion( + deleteApplicationVersion( args: DeleteApplicationVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplicationVersion( + deleteApplicationVersion( args: DeleteApplicationVersionCommandInput, cb: (err: any, data?: DeleteApplicationVersionCommandOutput) => void ): void; - public deleteApplicationVersion( + deleteApplicationVersion( args: DeleteApplicationVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationVersionCommandOutput) => void ): void; - public deleteApplicationVersion( - args: DeleteApplicationVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApplicationVersionCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationVersionCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified configuration template.

- * - *

When you launch an environment using a configuration template, the environment gets a - * copy of the template. You can delete or modify the environment's copy of the template - * without affecting the running environment.

- *
+ * @see {@link DeleteConfigurationTemplateCommand} */ - public deleteConfigurationTemplate( + deleteConfigurationTemplate( args: DeleteConfigurationTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConfigurationTemplate( + deleteConfigurationTemplate( args: DeleteConfigurationTemplateCommandInput, cb: (err: any, data?: DeleteConfigurationTemplateCommandOutput) => void ): void; - public deleteConfigurationTemplate( + deleteConfigurationTemplate( args: DeleteConfigurationTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationTemplateCommandOutput) => void ): void; - public deleteConfigurationTemplate( - args: DeleteConfigurationTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConfigurationTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteConfigurationTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteConfigurationTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the draft configuration associated with the running environment.

- *

Updating a running environment with any configuration changes creates a draft - * configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update - * fails. The DeploymentStatus for the draft configuration indicates whether the - * deployment is in process or has failed. The draft configuration remains in existence until it - * is deleted with this action.

+ * @see {@link DeleteEnvironmentConfigurationCommand} */ - public deleteEnvironmentConfiguration( + deleteEnvironmentConfiguration( args: DeleteEnvironmentConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEnvironmentConfiguration( + deleteEnvironmentConfiguration( args: DeleteEnvironmentConfigurationCommandInput, cb: (err: any, data?: DeleteEnvironmentConfigurationCommandOutput) => void ): void; - public deleteEnvironmentConfiguration( + deleteEnvironmentConfiguration( args: DeleteEnvironmentConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEnvironmentConfigurationCommandOutput) => void ): void; - public deleteEnvironmentConfiguration( - args: DeleteEnvironmentConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEnvironmentConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteEnvironmentConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteEnvironmentConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified version of a custom platform.

+ * @see {@link DeletePlatformVersionCommand} */ - public deletePlatformVersion( + deletePlatformVersion( args: DeletePlatformVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePlatformVersion( + deletePlatformVersion( args: DeletePlatformVersionCommandInput, cb: (err: any, data?: DeletePlatformVersionCommandOutput) => void ): void; - public deletePlatformVersion( + deletePlatformVersion( args: DeletePlatformVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePlatformVersionCommandOutput) => void ): void; - public deletePlatformVersion( - args: DeletePlatformVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePlatformVersionCommandOutput) => void), - cb?: (err: any, data?: DeletePlatformVersionCommandOutput) => void - ): Promise | void { - const command = new DeletePlatformVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS - * account.

- *

The result currently has one set of attributes—resource quotas.

+ * @see {@link DescribeAccountAttributesCommand} */ - public describeAccountAttributes( + describeAccountAttributes( args: DescribeAccountAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccountAttributes( + describeAccountAttributes( args: DescribeAccountAttributesCommandInput, cb: (err: any, data?: DescribeAccountAttributesCommandOutput) => void ): void; - public describeAccountAttributes( + describeAccountAttributes( args: DescribeAccountAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountAttributesCommandOutput) => void ): void; - public describeAccountAttributes( - args: DescribeAccountAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccountAttributesCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountAttributesCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the descriptions of existing applications.

+ * @see {@link DescribeApplicationsCommand} */ - public describeApplications( + describeApplications( args: DescribeApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeApplications( + describeApplications( args: DescribeApplicationsCommandInput, cb: (err: any, data?: DescribeApplicationsCommandOutput) => void ): void; - public describeApplications( + describeApplications( args: DescribeApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeApplicationsCommandOutput) => void ): void; - public describeApplications( - args: DescribeApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeApplicationsCommandOutput) => void), - cb?: (err: any, data?: DescribeApplicationsCommandOutput) => void - ): Promise | void { - const command = new DescribeApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieve a list of application versions.

+ * @see {@link DescribeApplicationVersionsCommand} */ - public describeApplicationVersions( + describeApplicationVersions( args: DescribeApplicationVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeApplicationVersions( + describeApplicationVersions( args: DescribeApplicationVersionsCommandInput, cb: (err: any, data?: DescribeApplicationVersionsCommandOutput) => void ): void; - public describeApplicationVersions( + describeApplicationVersions( args: DescribeApplicationVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeApplicationVersionsCommandOutput) => void ): void; - public describeApplicationVersions( - args: DescribeApplicationVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeApplicationVersionsCommandOutput) => void), - cb?: (err: any, data?: DescribeApplicationVersionsCommandOutput) => void - ): Promise | void { - const command = new DescribeApplicationVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the configuration options that are used in a particular configuration - * template or environment, or that a specified solution stack defines. The description includes - * the values the options, their default values, and an indication of the required action on a - * running environment if an option value is changed.

+ * @see {@link DescribeConfigurationOptionsCommand} */ - public describeConfigurationOptions( + describeConfigurationOptions( args: DescribeConfigurationOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConfigurationOptions( + describeConfigurationOptions( args: DescribeConfigurationOptionsCommandInput, cb: (err: any, data?: DescribeConfigurationOptionsCommandOutput) => void ): void; - public describeConfigurationOptions( + describeConfigurationOptions( args: DescribeConfigurationOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigurationOptionsCommandOutput) => void ): void; - public describeConfigurationOptions( - args: DescribeConfigurationOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConfigurationOptionsCommandOutput) => void), - cb?: (err: any, data?: DescribeConfigurationOptionsCommandOutput) => void - ): Promise | void { - const command = new DescribeConfigurationOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a description of the settings for the specified configuration set, that is, - * either a configuration template or the configuration set associated with a running - * environment.

- *

When describing the settings for the configuration set associated with a running - * environment, it is possible to receive two sets of setting descriptions. One is the deployed - * configuration set, and the other is a draft configuration of an environment that is either in - * the process of deployment or that failed to deploy.

- *

Related Topics

- * + * @see {@link DescribeConfigurationSettingsCommand} */ - public describeConfigurationSettings( + describeConfigurationSettings( args: DescribeConfigurationSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConfigurationSettings( + describeConfigurationSettings( args: DescribeConfigurationSettingsCommandInput, cb: (err: any, data?: DescribeConfigurationSettingsCommandOutput) => void ): void; - public describeConfigurationSettings( + describeConfigurationSettings( args: DescribeConfigurationSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigurationSettingsCommandOutput) => void ): void; - public describeConfigurationSettings( - args: DescribeConfigurationSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConfigurationSettingsCommandOutput) => void), - cb?: (err: any, data?: DescribeConfigurationSettingsCommandOutput) => void - ): Promise | void { - const command = new DescribeConfigurationSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the overall health of the specified environment. The - * DescribeEnvironmentHealth operation is only available with - * AWS Elastic Beanstalk Enhanced Health.

+ * @see {@link DescribeEnvironmentHealthCommand} */ - public describeEnvironmentHealth( + describeEnvironmentHealth( args: DescribeEnvironmentHealthCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEnvironmentHealth( + describeEnvironmentHealth( args: DescribeEnvironmentHealthCommandInput, cb: (err: any, data?: DescribeEnvironmentHealthCommandOutput) => void ): void; - public describeEnvironmentHealth( + describeEnvironmentHealth( args: DescribeEnvironmentHealthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEnvironmentHealthCommandOutput) => void ): void; - public describeEnvironmentHealth( - args: DescribeEnvironmentHealthCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEnvironmentHealthCommandOutput) => void), - cb?: (err: any, data?: DescribeEnvironmentHealthCommandOutput) => void - ): Promise | void { - const command = new DescribeEnvironmentHealthCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists an environment's completed and failed managed actions.

+ * @see {@link DescribeEnvironmentManagedActionHistoryCommand} */ - public describeEnvironmentManagedActionHistory( + describeEnvironmentManagedActionHistory( args: DescribeEnvironmentManagedActionHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEnvironmentManagedActionHistory( + describeEnvironmentManagedActionHistory( args: DescribeEnvironmentManagedActionHistoryCommandInput, cb: (err: any, data?: DescribeEnvironmentManagedActionHistoryCommandOutput) => void ): void; - public describeEnvironmentManagedActionHistory( + describeEnvironmentManagedActionHistory( args: DescribeEnvironmentManagedActionHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEnvironmentManagedActionHistoryCommandOutput) => void ): void; - public describeEnvironmentManagedActionHistory( - args: DescribeEnvironmentManagedActionHistoryCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeEnvironmentManagedActionHistoryCommandOutput) => void), - cb?: (err: any, data?: DescribeEnvironmentManagedActionHistoryCommandOutput) => void - ): Promise | void { - const command = new DescribeEnvironmentManagedActionHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists an environment's upcoming and in-progress managed actions.

+ * @see {@link DescribeEnvironmentManagedActionsCommand} */ - public describeEnvironmentManagedActions( + describeEnvironmentManagedActions( args: DescribeEnvironmentManagedActionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEnvironmentManagedActions( + describeEnvironmentManagedActions( args: DescribeEnvironmentManagedActionsCommandInput, cb: (err: any, data?: DescribeEnvironmentManagedActionsCommandOutput) => void ): void; - public describeEnvironmentManagedActions( + describeEnvironmentManagedActions( args: DescribeEnvironmentManagedActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEnvironmentManagedActionsCommandOutput) => void ): void; - public describeEnvironmentManagedActions( - args: DescribeEnvironmentManagedActionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEnvironmentManagedActionsCommandOutput) => void), - cb?: (err: any, data?: DescribeEnvironmentManagedActionsCommandOutput) => void - ): Promise | void { - const command = new DescribeEnvironmentManagedActionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns AWS resources for this environment.

+ * @see {@link DescribeEnvironmentResourcesCommand} */ - public describeEnvironmentResources( + describeEnvironmentResources( args: DescribeEnvironmentResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEnvironmentResources( + describeEnvironmentResources( args: DescribeEnvironmentResourcesCommandInput, cb: (err: any, data?: DescribeEnvironmentResourcesCommandOutput) => void ): void; - public describeEnvironmentResources( + describeEnvironmentResources( args: DescribeEnvironmentResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEnvironmentResourcesCommandOutput) => void ): void; - public describeEnvironmentResources( - args: DescribeEnvironmentResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEnvironmentResourcesCommandOutput) => void), - cb?: (err: any, data?: DescribeEnvironmentResourcesCommandOutput) => void - ): Promise | void { - const command = new DescribeEnvironmentResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns descriptions for existing environments.

+ * @see {@link DescribeEnvironmentsCommand} */ - public describeEnvironments( + describeEnvironments( args: DescribeEnvironmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEnvironments( + describeEnvironments( args: DescribeEnvironmentsCommandInput, cb: (err: any, data?: DescribeEnvironmentsCommandOutput) => void ): void; - public describeEnvironments( + describeEnvironments( args: DescribeEnvironmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEnvironmentsCommandOutput) => void ): void; - public describeEnvironments( - args: DescribeEnvironmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEnvironmentsCommandOutput) => void), - cb?: (err: any, data?: DescribeEnvironmentsCommandOutput) => void - ): Promise | void { - const command = new DescribeEnvironmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns list of event descriptions matching criteria up to the last 6 weeks.

- * - *

This action returns the most recent 1,000 events from the specified - * NextToken.

- *
+ * @see {@link DescribeEventsCommand} */ - public describeEvents( + describeEvents( args: DescribeEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEvents( - args: DescribeEventsCommandInput, - cb: (err: any, data?: DescribeEventsCommandOutput) => void - ): void; - public describeEvents( + describeEvents(args: DescribeEventsCommandInput, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void; + describeEvents( args: DescribeEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsCommandOutput) => void ): void; - public describeEvents( - args: DescribeEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventsCommandOutput) => void), - cb?: (err: any, data?: DescribeEventsCommandOutput) => void - ): Promise | void { - const command = new DescribeEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves detailed information about the health of instances in your AWS Elastic - * Beanstalk. This operation requires enhanced health - * reporting.

+ * @see {@link DescribeInstancesHealthCommand} */ - public describeInstancesHealth( + describeInstancesHealth( args: DescribeInstancesHealthCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInstancesHealth( + describeInstancesHealth( args: DescribeInstancesHealthCommandInput, cb: (err: any, data?: DescribeInstancesHealthCommandOutput) => void ): void; - public describeInstancesHealth( + describeInstancesHealth( args: DescribeInstancesHealthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstancesHealthCommandOutput) => void ): void; - public describeInstancesHealth( - args: DescribeInstancesHealthCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInstancesHealthCommandOutput) => void), - cb?: (err: any, data?: DescribeInstancesHealthCommandOutput) => void - ): Promise | void { - const command = new DescribeInstancesHealthCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a platform version. Provides full details. Compare to ListPlatformVersions, which provides summary information about a list of - * platform versions.

- *

For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk - * Platforms Glossary.

+ * @see {@link DescribePlatformVersionCommand} */ - public describePlatformVersion( + describePlatformVersion( args: DescribePlatformVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePlatformVersion( + describePlatformVersion( args: DescribePlatformVersionCommandInput, cb: (err: any, data?: DescribePlatformVersionCommandOutput) => void ): void; - public describePlatformVersion( + describePlatformVersion( args: DescribePlatformVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePlatformVersionCommandOutput) => void ): void; - public describePlatformVersion( - args: DescribePlatformVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePlatformVersionCommandOutput) => void), - cb?: (err: any, data?: DescribePlatformVersionCommandOutput) => void - ): Promise | void { - const command = new DescribePlatformVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociate the operations role from an environment. After this call is made, Elastic Beanstalk uses - * the caller's permissions for permissions to downstream services during subsequent calls acting - * on this environment. For more information, see Operations roles in the - * AWS Elastic Beanstalk Developer Guide.

+ * @see {@link DisassociateEnvironmentOperationsRoleCommand} */ - public disassociateEnvironmentOperationsRole( + disassociateEnvironmentOperationsRole( args: DisassociateEnvironmentOperationsRoleCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateEnvironmentOperationsRole( + disassociateEnvironmentOperationsRole( args: DisassociateEnvironmentOperationsRoleCommandInput, cb: (err: any, data?: DisassociateEnvironmentOperationsRoleCommandOutput) => void ): void; - public disassociateEnvironmentOperationsRole( + disassociateEnvironmentOperationsRole( args: DisassociateEnvironmentOperationsRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateEnvironmentOperationsRoleCommandOutput) => void ): void; - public disassociateEnvironmentOperationsRole( - args: DisassociateEnvironmentOperationsRoleCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociateEnvironmentOperationsRoleCommandOutput) => void), - cb?: (err: any, data?: DisassociateEnvironmentOperationsRoleCommandOutput) => void - ): Promise | void { - const command = new DisassociateEnvironmentOperationsRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the available solution stack names, with the public version first and - * then in reverse chronological order.

+ * @see {@link ListAvailableSolutionStacksCommand} */ - public listAvailableSolutionStacks( + listAvailableSolutionStacks( args: ListAvailableSolutionStacksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAvailableSolutionStacks( + listAvailableSolutionStacks( args: ListAvailableSolutionStacksCommandInput, cb: (err: any, data?: ListAvailableSolutionStacksCommandOutput) => void ): void; - public listAvailableSolutionStacks( + listAvailableSolutionStacks( args: ListAvailableSolutionStacksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAvailableSolutionStacksCommandOutput) => void ): void; - public listAvailableSolutionStacks( - args: ListAvailableSolutionStacksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAvailableSolutionStacksCommandOutput) => void), - cb?: (err: any, data?: ListAvailableSolutionStacksCommandOutput) => void - ): Promise | void { - const command = new ListAvailableSolutionStacksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the platform branches available for your account in an AWS Region. Provides - * summary information about each platform branch.

- *

For definitions of platform branch and other platform-related terms, see AWS Elastic Beanstalk - * Platforms Glossary.

+ * @see {@link ListPlatformBranchesCommand} */ - public listPlatformBranches( + listPlatformBranches( args: ListPlatformBranchesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPlatformBranches( + listPlatformBranches( args: ListPlatformBranchesCommandInput, cb: (err: any, data?: ListPlatformBranchesCommandOutput) => void ): void; - public listPlatformBranches( + listPlatformBranches( args: ListPlatformBranchesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPlatformBranchesCommandOutput) => void ): void; - public listPlatformBranches( - args: ListPlatformBranchesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPlatformBranchesCommandOutput) => void), - cb?: (err: any, data?: ListPlatformBranchesCommandOutput) => void - ): Promise | void { - const command = new ListPlatformBranchesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the platform versions available for your account in an AWS Region. Provides - * summary information about each platform version. Compare to DescribePlatformVersion, which provides full details about a single platform - * version.

- *

For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk - * Platforms Glossary.

+ * @see {@link ListPlatformVersionsCommand} */ - public listPlatformVersions( + listPlatformVersions( args: ListPlatformVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPlatformVersions( + listPlatformVersions( args: ListPlatformVersionsCommandInput, cb: (err: any, data?: ListPlatformVersionsCommandOutput) => void ): void; - public listPlatformVersions( + listPlatformVersions( args: ListPlatformVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPlatformVersionsCommandOutput) => void ): void; - public listPlatformVersions( - args: ListPlatformVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPlatformVersionsCommandOutput) => void), - cb?: (err: any, data?: ListPlatformVersionsCommandOutput) => void - ): Promise | void { - const command = new ListPlatformVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Return the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.

- *

Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see - * Tagging Application - * Resources.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, - * load balancer, etc.) for a specified environment and forces a restart.

+ * @see {@link RebuildEnvironmentCommand} */ - public rebuildEnvironment( + rebuildEnvironment( args: RebuildEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public rebuildEnvironment( + rebuildEnvironment( args: RebuildEnvironmentCommandInput, cb: (err: any, data?: RebuildEnvironmentCommandOutput) => void ): void; - public rebuildEnvironment( + rebuildEnvironment( args: RebuildEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebuildEnvironmentCommandOutput) => void ): void; - public rebuildEnvironment( - args: RebuildEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RebuildEnvironmentCommandOutput) => void), - cb?: (err: any, data?: RebuildEnvironmentCommandOutput) => void - ): Promise | void { - const command = new RebuildEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Initiates a request to compile the specified type of information of the deployed - * environment.

- *

Setting the InfoType to tail compiles the last lines from - * the application server log files of every Amazon EC2 instance in your environment.

- *

Setting the InfoType to bundle compresses the application - * server log files for every Amazon EC2 instance into a .zip file. Legacy and .NET - * containers do not support bundle logs.

- *

Use RetrieveEnvironmentInfo to obtain the set of logs.

- *

Related Topics

- * + * @see {@link RequestEnvironmentInfoCommand} */ - public requestEnvironmentInfo( + requestEnvironmentInfo( args: RequestEnvironmentInfoCommandInput, options?: __HttpHandlerOptions ): Promise; - public requestEnvironmentInfo( + requestEnvironmentInfo( args: RequestEnvironmentInfoCommandInput, cb: (err: any, data?: RequestEnvironmentInfoCommandOutput) => void ): void; - public requestEnvironmentInfo( + requestEnvironmentInfo( args: RequestEnvironmentInfoCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RequestEnvironmentInfoCommandOutput) => void ): void; - public requestEnvironmentInfo( - args: RequestEnvironmentInfoCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RequestEnvironmentInfoCommandOutput) => void), - cb?: (err: any, data?: RequestEnvironmentInfoCommandOutput) => void - ): Promise | void { - const command = new RequestEnvironmentInfoCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Causes the environment to restart the application container server running on each - * Amazon EC2 instance.

+ * @see {@link RestartAppServerCommand} */ - public restartAppServer( + restartAppServer( args: RestartAppServerCommandInput, options?: __HttpHandlerOptions ): Promise; - public restartAppServer( + restartAppServer( args: RestartAppServerCommandInput, cb: (err: any, data?: RestartAppServerCommandOutput) => void ): void; - public restartAppServer( + restartAppServer( args: RestartAppServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestartAppServerCommandOutput) => void ): void; - public restartAppServer( - args: RestartAppServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestartAppServerCommandOutput) => void), - cb?: (err: any, data?: RestartAppServerCommandOutput) => void - ): Promise | void { - const command = new RestartAppServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the compiled information from a RequestEnvironmentInfo - * request.

- *

Related Topics

- * + * @see {@link RetrieveEnvironmentInfoCommand} */ - public retrieveEnvironmentInfo( + retrieveEnvironmentInfo( args: RetrieveEnvironmentInfoCommandInput, options?: __HttpHandlerOptions ): Promise; - public retrieveEnvironmentInfo( + retrieveEnvironmentInfo( args: RetrieveEnvironmentInfoCommandInput, cb: (err: any, data?: RetrieveEnvironmentInfoCommandOutput) => void ): void; - public retrieveEnvironmentInfo( + retrieveEnvironmentInfo( args: RetrieveEnvironmentInfoCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RetrieveEnvironmentInfoCommandOutput) => void ): void; - public retrieveEnvironmentInfo( - args: RetrieveEnvironmentInfoCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RetrieveEnvironmentInfoCommandOutput) => void), - cb?: (err: any, data?: RetrieveEnvironmentInfoCommandOutput) => void - ): Promise | void { - const command = new RetrieveEnvironmentInfoCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Swaps the CNAMEs of two environments.

+ * @see {@link SwapEnvironmentCNAMEsCommand} */ - public swapEnvironmentCNAMEs( + swapEnvironmentCNAMEs( args: SwapEnvironmentCNAMEsCommandInput, options?: __HttpHandlerOptions ): Promise; - public swapEnvironmentCNAMEs( + swapEnvironmentCNAMEs( args: SwapEnvironmentCNAMEsCommandInput, cb: (err: any, data?: SwapEnvironmentCNAMEsCommandOutput) => void ): void; - public swapEnvironmentCNAMEs( + swapEnvironmentCNAMEs( args: SwapEnvironmentCNAMEsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SwapEnvironmentCNAMEsCommandOutput) => void ): void; - public swapEnvironmentCNAMEs( - args: SwapEnvironmentCNAMEsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SwapEnvironmentCNAMEsCommandOutput) => void), - cb?: (err: any, data?: SwapEnvironmentCNAMEsCommandOutput) => void - ): Promise | void { - const command = new SwapEnvironmentCNAMEsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Terminates the specified environment.

+ * @see {@link TerminateEnvironmentCommand} */ - public terminateEnvironment( + terminateEnvironment( args: TerminateEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public terminateEnvironment( + terminateEnvironment( args: TerminateEnvironmentCommandInput, cb: (err: any, data?: TerminateEnvironmentCommandOutput) => void ): void; - public terminateEnvironment( + terminateEnvironment( args: TerminateEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TerminateEnvironmentCommandOutput) => void ): void; - public terminateEnvironment( - args: TerminateEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TerminateEnvironmentCommandOutput) => void), - cb?: (err: any, data?: TerminateEnvironmentCommandOutput) => void - ): Promise | void { - const command = new TerminateEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified application to have the specified properties.

- * - *

If a property (for example, description) is not provided, the value - * remains unchanged. To clear these properties, specify an empty string.

- *
+ * @see {@link UpdateApplicationCommand} */ - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( - args: UpdateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApplicationCommandOutput) => void), - cb?: (err: any, data?: UpdateApplicationCommandOutput) => void - ): Promise | void { - const command = new UpdateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies lifecycle settings for an application.

+ * @see {@link UpdateApplicationResourceLifecycleCommand} */ - public updateApplicationResourceLifecycle( + updateApplicationResourceLifecycle( args: UpdateApplicationResourceLifecycleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApplicationResourceLifecycle( + updateApplicationResourceLifecycle( args: UpdateApplicationResourceLifecycleCommandInput, cb: (err: any, data?: UpdateApplicationResourceLifecycleCommandOutput) => void ): void; - public updateApplicationResourceLifecycle( + updateApplicationResourceLifecycle( args: UpdateApplicationResourceLifecycleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationResourceLifecycleCommandOutput) => void ): void; - public updateApplicationResourceLifecycle( - args: UpdateApplicationResourceLifecycleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApplicationResourceLifecycleCommandOutput) => void), - cb?: (err: any, data?: UpdateApplicationResourceLifecycleCommandOutput) => void - ): Promise | void { - const command = new UpdateApplicationResourceLifecycleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified application version to have the specified properties.

- * - *

If a property (for example, description) is not provided, the value - * remains unchanged. To clear properties, specify an empty string.

- *
+ * @see {@link UpdateApplicationVersionCommand} */ - public updateApplicationVersion( + updateApplicationVersion( args: UpdateApplicationVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApplicationVersion( + updateApplicationVersion( args: UpdateApplicationVersionCommandInput, cb: (err: any, data?: UpdateApplicationVersionCommandOutput) => void ): void; - public updateApplicationVersion( + updateApplicationVersion( args: UpdateApplicationVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationVersionCommandOutput) => void ): void; - public updateApplicationVersion( - args: UpdateApplicationVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApplicationVersionCommandOutput) => void), - cb?: (err: any, data?: UpdateApplicationVersionCommandOutput) => void - ): Promise | void { - const command = new UpdateApplicationVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified configuration template to have the specified properties or - * configuration option values.

- * - *

If a property (for example, ApplicationName) is not provided, its value - * remains unchanged. To clear such properties, specify an empty string.

- *
- *

Related Topics

- * + * @see {@link UpdateConfigurationTemplateCommand} */ - public updateConfigurationTemplate( + updateConfigurationTemplate( args: UpdateConfigurationTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConfigurationTemplate( + updateConfigurationTemplate( args: UpdateConfigurationTemplateCommandInput, cb: (err: any, data?: UpdateConfigurationTemplateCommandOutput) => void ): void; - public updateConfigurationTemplate( + updateConfigurationTemplate( args: UpdateConfigurationTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConfigurationTemplateCommandOutput) => void ): void; - public updateConfigurationTemplate( - args: UpdateConfigurationTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConfigurationTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateConfigurationTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateConfigurationTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the environment description, deploys a new application version, updates the - * configuration settings to an entirely new configuration template, or updates select - * configuration option values in the running environment.

- *

Attempting to update both the release and configuration is not allowed and AWS Elastic - * Beanstalk returns an InvalidParameterCombination error.

- *

When updating the configuration settings to a new template or individual settings, a - * draft configuration is created and DescribeConfigurationSettings for this - * environment returns two setting descriptions with different DeploymentStatus - * values.

+ * @see {@link UpdateEnvironmentCommand} */ - public updateEnvironment( + updateEnvironment( args: UpdateEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEnvironment( + updateEnvironment( args: UpdateEnvironmentCommandInput, cb: (err: any, data?: UpdateEnvironmentCommandOutput) => void ): void; - public updateEnvironment( + updateEnvironment( args: UpdateEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEnvironmentCommandOutput) => void ): void; - public updateEnvironment( - args: UpdateEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEnvironmentCommandOutput) => void), - cb?: (err: any, data?: UpdateEnvironmentCommandOutput) => void - ): Promise | void { - const command = new UpdateEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: TagsToAdd - * for tags to add or update, and TagsToRemove.

- *

Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see - * Tagging Application - * Resources.

- *

If you create a custom IAM user policy to control permission to this operation, specify - * one of the following two virtual actions (or both) instead of the API operation name:

- *
- *
elasticbeanstalk:AddTags
- *
- *

Controls permission to call UpdateTagsForResource and pass a list of tags to add in the TagsToAdd - * parameter.

- *
- *
elasticbeanstalk:RemoveTags
- *
- *

Controls permission to call UpdateTagsForResource and pass a list of tag keys to remove in the TagsToRemove - * parameter.

- *
- *
- *

For details about creating a custom user policy, see Creating a Custom User Policy.

+ * @see {@link UpdateTagsForResourceCommand} */ - public updateTagsForResource( + updateTagsForResource( args: UpdateTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTagsForResource( + updateTagsForResource( args: UpdateTagsForResourceCommandInput, cb: (err: any, data?: UpdateTagsForResourceCommandOutput) => void ): void; - public updateTagsForResource( + updateTagsForResource( args: UpdateTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTagsForResourceCommandOutput) => void ): void; - public updateTagsForResource( - args: UpdateTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: UpdateTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new UpdateTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Takes a set of configuration settings and either a configuration template or - * environment, and determines whether those values are valid.

- *

This action returns a list of messages indicating any errors or warnings associated - * with the selection of option values.

+ * @see {@link ValidateConfigurationSettingsCommand} */ - public validateConfigurationSettings( + validateConfigurationSettings( args: ValidateConfigurationSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public validateConfigurationSettings( + validateConfigurationSettings( args: ValidateConfigurationSettingsCommandInput, cb: (err: any, data?: ValidateConfigurationSettingsCommandOutput) => void ): void; - public validateConfigurationSettings( + validateConfigurationSettings( args: ValidateConfigurationSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidateConfigurationSettingsCommandOutput) => void ): void; - public validateConfigurationSettings( - args: ValidateConfigurationSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ValidateConfigurationSettingsCommandOutput) => void), - cb?: (err: any, data?: ValidateConfigurationSettingsCommandOutput) => void - ): Promise | void { - const command = new ValidateConfigurationSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * AWS Elastic Beanstalk + *

AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable, + * fault-tolerant applications running on the Amazon Web Services cloud.

+ *

For more information about this product, go to the AWS Elastic Beanstalk details page. The location of the + * latest AWS Elastic Beanstalk WSDL is https://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl. + * To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) + * Toolkits, and command line tools that enable you to access the API, go to Tools for Amazon Web Services.

+ *

+ * Endpoints + *

+ *

For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to + * Regions and Endpoints in the Amazon Web Services + * Glossary.

+ */ +export class ElasticBeanstalk extends ElasticBeanstalkClient implements ElasticBeanstalk {} +createAggregatedClient(commands, ElasticBeanstalk); diff --git a/clients/client-elastic-inference/src/ElasticInference.ts b/clients/client-elastic-inference/src/ElasticInference.ts index f2334961dbc6..3cc5c0848158 100644 --- a/clients/client-elastic-inference/src/ElasticInference.ts +++ b/clients/client-elastic-inference/src/ElasticInference.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -27,251 +28,119 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; -import { ElasticInferenceClient } from "./ElasticInferenceClient"; +import { ElasticInferenceClient, ElasticInferenceClientConfig } from "./ElasticInferenceClient"; -/** - * @public - *

- * Elastic Inference public APIs. - *

- *

- * February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. - * After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. - * However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. - *

- */ -export class ElasticInference extends ElasticInferenceClient { +const commands = { + DescribeAcceleratorOfferingsCommand, + DescribeAcceleratorsCommand, + DescribeAcceleratorTypesCommand, + ListTagsForResourceCommand, + TagResourceCommand, + UntagResourceCommand, +}; + +export interface ElasticInference { /** - * @public - *

- * Describes the locations in which a given accelerator type or set of types is present in a given region. - *

- *

- * February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. - * After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. - * However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. - *

+ * @see {@link DescribeAcceleratorOfferingsCommand} */ - public describeAcceleratorOfferings( + describeAcceleratorOfferings( args: DescribeAcceleratorOfferingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAcceleratorOfferings( + describeAcceleratorOfferings( args: DescribeAcceleratorOfferingsCommandInput, cb: (err: any, data?: DescribeAcceleratorOfferingsCommandOutput) => void ): void; - public describeAcceleratorOfferings( + describeAcceleratorOfferings( args: DescribeAcceleratorOfferingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAcceleratorOfferingsCommandOutput) => void ): void; - public describeAcceleratorOfferings( - args: DescribeAcceleratorOfferingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAcceleratorOfferingsCommandOutput) => void), - cb?: (err: any, data?: DescribeAcceleratorOfferingsCommandOutput) => void - ): Promise | void { - const command = new DescribeAcceleratorOfferingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Describes information over a provided set of accelerators belonging to an account. - *

- *

- * February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. - * After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. - * However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. - *

+ * @see {@link DescribeAcceleratorsCommand} */ - public describeAccelerators( + describeAccelerators( args: DescribeAcceleratorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccelerators( + describeAccelerators( args: DescribeAcceleratorsCommandInput, cb: (err: any, data?: DescribeAcceleratorsCommandOutput) => void ): void; - public describeAccelerators( + describeAccelerators( args: DescribeAcceleratorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAcceleratorsCommandOutput) => void ): void; - public describeAccelerators( - args: DescribeAcceleratorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAcceleratorsCommandOutput) => void), - cb?: (err: any, data?: DescribeAcceleratorsCommandOutput) => void - ): Promise | void { - const command = new DescribeAcceleratorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput. - *

- *

- * February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. - * After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. - * However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. - *

+ * @see {@link DescribeAcceleratorTypesCommand} */ - public describeAcceleratorTypes( + describeAcceleratorTypes( args: DescribeAcceleratorTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAcceleratorTypes( + describeAcceleratorTypes( args: DescribeAcceleratorTypesCommandInput, cb: (err: any, data?: DescribeAcceleratorTypesCommandOutput) => void ): void; - public describeAcceleratorTypes( + describeAcceleratorTypes( args: DescribeAcceleratorTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAcceleratorTypesCommandOutput) => void ): void; - public describeAcceleratorTypes( - args: DescribeAcceleratorTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAcceleratorTypesCommandOutput) => void), - cb?: (err: any, data?: DescribeAcceleratorTypesCommandOutput) => void - ): Promise | void { - const command = new DescribeAcceleratorTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns all tags of an Elastic Inference Accelerator. - *

- *

- * February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. - * After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. - * However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. - *

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Adds the specified tags to an Elastic Inference Accelerator. - *

- *

- * February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. - * After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. - * However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. - *

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Removes the specified tags from an Elastic Inference Accelerator. - *

- *

- * February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. - * After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. - * However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. - *

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

+ * Elastic Inference public APIs. + *

+ *

+ * February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. + * After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. + * However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. + *

+ */ +export class ElasticInference extends ElasticInferenceClient implements ElasticInference {} +createAggregatedClient(commands, ElasticInference); diff --git a/clients/client-elastic-load-balancing-v2/src/ElasticLoadBalancingV2.ts b/clients/client-elastic-load-balancing-v2/src/ElasticLoadBalancingV2.ts index ba1d19bc7a7b..480cfe03d37e 100644 --- a/clients/client-elastic-load-balancing-v2/src/ElasticLoadBalancingV2.ts +++ b/clients/client-elastic-load-balancing-v2/src/ElasticLoadBalancingV2.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -147,1339 +148,596 @@ import { SetSecurityGroupsCommandOutput, } from "./commands/SetSecurityGroupsCommand"; import { SetSubnetsCommand, SetSubnetsCommandInput, SetSubnetsCommandOutput } from "./commands/SetSubnetsCommand"; -import { ElasticLoadBalancingV2Client } from "./ElasticLoadBalancingV2Client"; +import { ElasticLoadBalancingV2Client, ElasticLoadBalancingV2ClientConfig } from "./ElasticLoadBalancingV2Client"; -/** - * @public - * Elastic Load Balancing - *

A load balancer distributes incoming traffic across targets, such as your EC2 instances. - * This enables you to increase the availability of your application. The load balancer also - * monitors the health of its registered targets and ensures that it routes traffic only to - * healthy targets. You configure your load balancer to accept incoming traffic by specifying one - * or more listeners, which are configured with a protocol and port number for connections from - * clients to the load balancer. You configure a target group with a protocol and port number for - * connections from the load balancer to the targets, and with health check settings to be used - * when checking the health status of the targets.

- *

Elastic Load Balancing supports the following types of load balancers: Application Load - * Balancers, Network Load Balancers, Gateway Load Balancers, and Classic Load Balancers. This - * reference covers the following load balancer types:

- *
    - *
  • - *

    Application Load Balancer - Operates at the application layer (layer 7) and supports - * HTTP and HTTPS.

    - *
  • - *
  • - *

    Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, - * TLS, and UDP.

    - *
  • - *
  • - *

    Gateway Load Balancer - Operates at the network layer (layer 3).

    - *
  • - *
- *

For more information, see the Elastic Load Balancing User - * Guide.

- *

All Elastic Load Balancing operations are idempotent, which means that they complete at - * most one time. If you repeat an operation, it succeeds.

- */ -export class ElasticLoadBalancingV2 extends ElasticLoadBalancingV2Client { +const commands = { + AddListenerCertificatesCommand, + AddTagsCommand, + CreateListenerCommand, + CreateLoadBalancerCommand, + CreateRuleCommand, + CreateTargetGroupCommand, + DeleteListenerCommand, + DeleteLoadBalancerCommand, + DeleteRuleCommand, + DeleteTargetGroupCommand, + DeregisterTargetsCommand, + DescribeAccountLimitsCommand, + DescribeListenerCertificatesCommand, + DescribeListenersCommand, + DescribeLoadBalancerAttributesCommand, + DescribeLoadBalancersCommand, + DescribeRulesCommand, + DescribeSSLPoliciesCommand, + DescribeTagsCommand, + DescribeTargetGroupAttributesCommand, + DescribeTargetGroupsCommand, + DescribeTargetHealthCommand, + ModifyListenerCommand, + ModifyLoadBalancerAttributesCommand, + ModifyRuleCommand, + ModifyTargetGroupCommand, + ModifyTargetGroupAttributesCommand, + RegisterTargetsCommand, + RemoveListenerCertificatesCommand, + RemoveTagsCommand, + SetIpAddressTypeCommand, + SetRulePrioritiesCommand, + SetSecurityGroupsCommand, + SetSubnetsCommand, +}; + +export interface ElasticLoadBalancingV2 { /** - * @public - *

Adds the specified SSL server certificate to the certificate list for the specified HTTPS - * or TLS listener.

- *

If the certificate in already in the certificate list, the call is successful but the - * certificate is not added again.

- *

For more information, see HTTPS - * listeners in the Application Load Balancers Guide or TLS - * listeners in the Network Load Balancers Guide.

+ * @see {@link AddListenerCertificatesCommand} */ - public addListenerCertificates( + addListenerCertificates( args: AddListenerCertificatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public addListenerCertificates( + addListenerCertificates( args: AddListenerCertificatesCommandInput, cb: (err: any, data?: AddListenerCertificatesCommandOutput) => void ): void; - public addListenerCertificates( + addListenerCertificates( args: AddListenerCertificatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddListenerCertificatesCommandOutput) => void ): void; - public addListenerCertificates( - args: AddListenerCertificatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddListenerCertificatesCommandOutput) => void), - cb?: (err: any, data?: AddListenerCertificatesCommandOutput) => void - ): Promise | void { - const command = new AddListenerCertificatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your - * Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, - * listeners, and rules.

- *

Each tag consists of a key and an optional value. If a resource already has a tag with the - * same key, AddTags updates its value.

+ * @see {@link AddTagsCommand} */ - public addTags(args: AddTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public addTags(args: AddTagsCommandInput, cb: (err: any, data?: AddTagsCommandOutput) => void): void; - public addTags( + addTags(args: AddTagsCommandInput, options?: __HttpHandlerOptions): Promise; + addTags(args: AddTagsCommandInput, cb: (err: any, data?: AddTagsCommandOutput) => void): void; + addTags( args: AddTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsCommandOutput) => void ): void; - public addTags( - args: AddTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddTagsCommandOutput) => void), - cb?: (err: any, data?: AddTagsCommandOutput) => void - ): Promise | void { - const command = new AddTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a listener for the specified Application Load Balancer, Network Load Balancer, or - * Gateway Load Balancer.

- *

For more information, see the following:

- * - *

This operation is idempotent, which means that it completes at most one time. If you - * attempt to create multiple listeners with the same settings, each call succeeds.

+ * @see {@link CreateListenerCommand} */ - public createListener( + createListener( args: CreateListenerCommandInput, options?: __HttpHandlerOptions ): Promise; - public createListener( - args: CreateListenerCommandInput, - cb: (err: any, data?: CreateListenerCommandOutput) => void - ): void; - public createListener( + createListener(args: CreateListenerCommandInput, cb: (err: any, data?: CreateListenerCommandOutput) => void): void; + createListener( args: CreateListenerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateListenerCommandOutput) => void ): void; - public createListener( - args: CreateListenerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateListenerCommandOutput) => void), - cb?: (err: any, data?: CreateListenerCommandOutput) => void - ): Promise | void { - const command = new CreateListenerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Application Load Balancer, Network Load Balancer, or Gateway Load - * Balancer.

- *

For more information, see the following:

- * - *

This operation is idempotent, which means that it completes at most one time. If you - * attempt to create multiple load balancers with the same settings, each call succeeds.

+ * @see {@link CreateLoadBalancerCommand} */ - public createLoadBalancer( + createLoadBalancer( args: CreateLoadBalancerCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLoadBalancer( + createLoadBalancer( args: CreateLoadBalancerCommandInput, cb: (err: any, data?: CreateLoadBalancerCommandOutput) => void ): void; - public createLoadBalancer( + createLoadBalancer( args: CreateLoadBalancerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLoadBalancerCommandOutput) => void ): void; - public createLoadBalancer( - args: CreateLoadBalancerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLoadBalancerCommandOutput) => void), - cb?: (err: any, data?: CreateLoadBalancerCommandOutput) => void - ): Promise | void { - const command = new CreateLoadBalancerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a rule for the specified listener. The listener must be associated with an - * Application Load Balancer.

- *

Each rule consists of a priority, one or more actions, and one or more conditions. Rules - * are evaluated in priority order, from the lowest value to the highest value. When the - * conditions for a rule are met, its actions are performed. If the conditions for no rules are - * met, the actions for the default rule are performed. For more information, see Listener rules in the Application Load Balancers Guide.

+ * @see {@link CreateRuleCommand} */ - public createRule(args: CreateRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public createRule(args: CreateRuleCommandInput, cb: (err: any, data?: CreateRuleCommandOutput) => void): void; - public createRule( + createRule(args: CreateRuleCommandInput, options?: __HttpHandlerOptions): Promise; + createRule(args: CreateRuleCommandInput, cb: (err: any, data?: CreateRuleCommandOutput) => void): void; + createRule( args: CreateRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRuleCommandOutput) => void ): void; - public createRule( - args: CreateRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRuleCommandOutput) => void), - cb?: (err: any, data?: CreateRuleCommandOutput) => void - ): Promise | void { - const command = new CreateRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a target group.

- *

For more information, see the following:

- * - *

This operation is idempotent, which means that it completes at most one time. If you - * attempt to create multiple target groups with the same settings, each call succeeds.

+ * @see {@link CreateTargetGroupCommand} */ - public createTargetGroup( + createTargetGroup( args: CreateTargetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTargetGroup( + createTargetGroup( args: CreateTargetGroupCommandInput, cb: (err: any, data?: CreateTargetGroupCommandOutput) => void ): void; - public createTargetGroup( + createTargetGroup( args: CreateTargetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTargetGroupCommandOutput) => void ): void; - public createTargetGroup( - args: CreateTargetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTargetGroupCommandOutput) => void), - cb?: (err: any, data?: CreateTargetGroupCommandOutput) => void - ): Promise | void { - const command = new CreateTargetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified listener.

- *

Alternatively, your listener is deleted when you delete the load balancer to which it is - * attached.

+ * @see {@link DeleteListenerCommand} */ - public deleteListener( + deleteListener( args: DeleteListenerCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteListener( - args: DeleteListenerCommandInput, - cb: (err: any, data?: DeleteListenerCommandOutput) => void - ): void; - public deleteListener( + deleteListener(args: DeleteListenerCommandInput, cb: (err: any, data?: DeleteListenerCommandOutput) => void): void; + deleteListener( args: DeleteListenerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteListenerCommandOutput) => void ): void; - public deleteListener( - args: DeleteListenerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteListenerCommandOutput) => void), - cb?: (err: any, data?: DeleteListenerCommandOutput) => void - ): Promise | void { - const command = new DeleteListenerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load - * Balancer. Deleting a load balancer also deletes its listeners.

- *

You can't delete a load balancer if deletion protection is enabled. If the load balancer - * does not exist or has already been deleted, the call succeeds.

- *

Deleting a load balancer does not affect its registered targets. For example, your EC2 - * instances continue to run and are still registered to their target groups. If you no longer - * need these EC2 instances, you can stop or terminate them.

+ * @see {@link DeleteLoadBalancerCommand} */ - public deleteLoadBalancer( + deleteLoadBalancer( args: DeleteLoadBalancerCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLoadBalancer( + deleteLoadBalancer( args: DeleteLoadBalancerCommandInput, cb: (err: any, data?: DeleteLoadBalancerCommandOutput) => void ): void; - public deleteLoadBalancer( + deleteLoadBalancer( args: DeleteLoadBalancerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLoadBalancerCommandOutput) => void ): void; - public deleteLoadBalancer( - args: DeleteLoadBalancerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLoadBalancerCommandOutput) => void), - cb?: (err: any, data?: DeleteLoadBalancerCommandOutput) => void - ): Promise | void { - const command = new DeleteLoadBalancerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified rule.

- *

You can't delete the default rule.

+ * @see {@link DeleteRuleCommand} */ - public deleteRule(args: DeleteRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteRule(args: DeleteRuleCommandInput, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void; - public deleteRule( + deleteRule(args: DeleteRuleCommandInput, options?: __HttpHandlerOptions): Promise; + deleteRule(args: DeleteRuleCommandInput, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void; + deleteRule( args: DeleteRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRuleCommandOutput) => void ): void; - public deleteRule( - args: DeleteRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified target group.

- *

You can delete a target group if it is not referenced by any actions. Deleting a target - * group also deletes any associated health checks. Deleting a target group does not affect its - * registered targets. For example, any EC2 instances continue to run until you stop or terminate - * them.

+ * @see {@link DeleteTargetGroupCommand} */ - public deleteTargetGroup( + deleteTargetGroup( args: DeleteTargetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTargetGroup( + deleteTargetGroup( args: DeleteTargetGroupCommandInput, cb: (err: any, data?: DeleteTargetGroupCommandOutput) => void ): void; - public deleteTargetGroup( + deleteTargetGroup( args: DeleteTargetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTargetGroupCommandOutput) => void ): void; - public deleteTargetGroup( - args: DeleteTargetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTargetGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteTargetGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteTargetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deregisters the specified targets from the specified target group. After the targets are - * deregistered, they no longer receive traffic from the load balancer.

+ * @see {@link DeregisterTargetsCommand} */ - public deregisterTargets( + deregisterTargets( args: DeregisterTargetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterTargets( + deregisterTargets( args: DeregisterTargetsCommandInput, cb: (err: any, data?: DeregisterTargetsCommandOutput) => void ): void; - public deregisterTargets( + deregisterTargets( args: DeregisterTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterTargetsCommandOutput) => void ): void; - public deregisterTargets( - args: DeregisterTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterTargetsCommandOutput) => void), - cb?: (err: any, data?: DeregisterTargetsCommandOutput) => void - ): Promise | void { - const command = new DeregisterTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the current Elastic Load Balancing resource limits for your Amazon Web Services - * account.

- *

For more information, see the following:

- * + * @see {@link DescribeAccountLimitsCommand} */ - public describeAccountLimits( + describeAccountLimits( args: DescribeAccountLimitsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccountLimits( + describeAccountLimits( args: DescribeAccountLimitsCommandInput, cb: (err: any, data?: DescribeAccountLimitsCommandOutput) => void ): void; - public describeAccountLimits( + describeAccountLimits( args: DescribeAccountLimitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountLimitsCommandOutput) => void ): void; - public describeAccountLimits( - args: DescribeAccountLimitsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccountLimitsCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountLimitsCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountLimitsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the default certificate and the certificate list for the specified HTTPS or TLS - * listener.

- *

If the default certificate is also in the certificate list, it appears twice in the - * results (once with IsDefault set to true and once with IsDefault set - * to false).

- *

For more information, see SSL certificates in the Application Load Balancers Guide or - * Server certificates in the Network Load Balancers - * Guide.

+ * @see {@link DescribeListenerCertificatesCommand} */ - public describeListenerCertificates( + describeListenerCertificates( args: DescribeListenerCertificatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeListenerCertificates( + describeListenerCertificates( args: DescribeListenerCertificatesCommandInput, cb: (err: any, data?: DescribeListenerCertificatesCommandOutput) => void ): void; - public describeListenerCertificates( + describeListenerCertificates( args: DescribeListenerCertificatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeListenerCertificatesCommandOutput) => void ): void; - public describeListenerCertificates( - args: DescribeListenerCertificatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeListenerCertificatesCommandOutput) => void), - cb?: (err: any, data?: DescribeListenerCertificatesCommandOutput) => void - ): Promise | void { - const command = new DescribeListenerCertificatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified listeners or the listeners for the specified Application Load - * Balancer, Network Load Balancer, or Gateway Load Balancer. You must specify either a load - * balancer or one or more listeners.

+ * @see {@link DescribeListenersCommand} */ - public describeListeners( + describeListeners( args: DescribeListenersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeListeners( + describeListeners( args: DescribeListenersCommandInput, cb: (err: any, data?: DescribeListenersCommandOutput) => void ): void; - public describeListeners( + describeListeners( args: DescribeListenersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeListenersCommandOutput) => void ): void; - public describeListeners( - args: DescribeListenersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeListenersCommandOutput) => void), - cb?: (err: any, data?: DescribeListenersCommandOutput) => void - ): Promise | void { - const command = new DescribeListenersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the attributes for the specified Application Load Balancer, Network Load - * Balancer, or Gateway Load Balancer.

- *

For more information, see the following:

- * + * @see {@link DescribeLoadBalancerAttributesCommand} */ - public describeLoadBalancerAttributes( + describeLoadBalancerAttributes( args: DescribeLoadBalancerAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLoadBalancerAttributes( + describeLoadBalancerAttributes( args: DescribeLoadBalancerAttributesCommandInput, cb: (err: any, data?: DescribeLoadBalancerAttributesCommandOutput) => void ): void; - public describeLoadBalancerAttributes( + describeLoadBalancerAttributes( args: DescribeLoadBalancerAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLoadBalancerAttributesCommandOutput) => void ): void; - public describeLoadBalancerAttributes( - args: DescribeLoadBalancerAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLoadBalancerAttributesCommandOutput) => void), - cb?: (err: any, data?: DescribeLoadBalancerAttributesCommandOutput) => void - ): Promise | void { - const command = new DescribeLoadBalancerAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified load balancers or all of your load balancers.

+ * @see {@link DescribeLoadBalancersCommand} */ - public describeLoadBalancers( + describeLoadBalancers( args: DescribeLoadBalancersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLoadBalancers( + describeLoadBalancers( args: DescribeLoadBalancersCommandInput, cb: (err: any, data?: DescribeLoadBalancersCommandOutput) => void ): void; - public describeLoadBalancers( + describeLoadBalancers( args: DescribeLoadBalancersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLoadBalancersCommandOutput) => void ): void; - public describeLoadBalancers( - args: DescribeLoadBalancersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLoadBalancersCommandOutput) => void), - cb?: (err: any, data?: DescribeLoadBalancersCommandOutput) => void - ): Promise | void { - const command = new DescribeLoadBalancersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified rules or the rules for the specified listener. You must specify - * either a listener or one or more rules.

+ * @see {@link DescribeRulesCommand} */ - public describeRules( - args: DescribeRulesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeRules( - args: DescribeRulesCommandInput, - cb: (err: any, data?: DescribeRulesCommandOutput) => void - ): void; - public describeRules( + describeRules(args: DescribeRulesCommandInput, options?: __HttpHandlerOptions): Promise; + describeRules(args: DescribeRulesCommandInput, cb: (err: any, data?: DescribeRulesCommandOutput) => void): void; + describeRules( args: DescribeRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRulesCommandOutput) => void ): void; - public describeRules( - args: DescribeRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRulesCommandOutput) => void), - cb?: (err: any, data?: DescribeRulesCommandOutput) => void - ): Promise | void { - const command = new DescribeRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified policies or all policies used for SSL negotiation.

- *

For more information, see Security policies in the Application Load Balancers Guide or - * Security policies in the Network Load Balancers Guide.

+ * @see {@link DescribeSSLPoliciesCommand} */ - public describeSSLPolicies( + describeSSLPolicies( args: DescribeSSLPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSSLPolicies( + describeSSLPolicies( args: DescribeSSLPoliciesCommandInput, cb: (err: any, data?: DescribeSSLPoliciesCommandOutput) => void ): void; - public describeSSLPolicies( + describeSSLPolicies( args: DescribeSSLPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSSLPoliciesCommandOutput) => void ): void; - public describeSSLPolicies( - args: DescribeSSLPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSSLPoliciesCommandOutput) => void), - cb?: (err: any, data?: DescribeSSLPoliciesCommandOutput) => void - ): Promise | void { - const command = new DescribeSSLPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the tags for the specified Elastic Load Balancing resources. You can describe - * the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load - * Balancers, target groups, listeners, or rules.

+ * @see {@link DescribeTagsCommand} */ - public describeTags( - args: DescribeTagsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeTags(args: DescribeTagsCommandInput, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void; - public describeTags( + describeTags(args: DescribeTagsCommandInput, options?: __HttpHandlerOptions): Promise; + describeTags(args: DescribeTagsCommandInput, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void; + describeTags( args: DescribeTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTagsCommandOutput) => void ): void; - public describeTags( - args: DescribeTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTagsCommandOutput) => void), - cb?: (err: any, data?: DescribeTagsCommandOutput) => void - ): Promise | void { - const command = new DescribeTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the attributes for the specified target group.

- *

For more information, see the following:

- * + * @see {@link DescribeTargetGroupAttributesCommand} */ - public describeTargetGroupAttributes( + describeTargetGroupAttributes( args: DescribeTargetGroupAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTargetGroupAttributes( + describeTargetGroupAttributes( args: DescribeTargetGroupAttributesCommandInput, cb: (err: any, data?: DescribeTargetGroupAttributesCommandOutput) => void ): void; - public describeTargetGroupAttributes( + describeTargetGroupAttributes( args: DescribeTargetGroupAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTargetGroupAttributesCommandOutput) => void ): void; - public describeTargetGroupAttributes( - args: DescribeTargetGroupAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTargetGroupAttributesCommandOutput) => void), - cb?: (err: any, data?: DescribeTargetGroupAttributesCommandOutput) => void - ): Promise | void { - const command = new DescribeTargetGroupAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified target groups or all of your target groups. By default, all target - * groups are described. Alternatively, you can specify one of the following to filter the - * results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of - * one or more target groups.

+ * @see {@link DescribeTargetGroupsCommand} */ - public describeTargetGroups( + describeTargetGroups( args: DescribeTargetGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTargetGroups( + describeTargetGroups( args: DescribeTargetGroupsCommandInput, cb: (err: any, data?: DescribeTargetGroupsCommandOutput) => void ): void; - public describeTargetGroups( + describeTargetGroups( args: DescribeTargetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTargetGroupsCommandOutput) => void ): void; - public describeTargetGroups( - args: DescribeTargetGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTargetGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeTargetGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeTargetGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the health of the specified targets or all of your targets.

+ * @see {@link DescribeTargetHealthCommand} */ - public describeTargetHealth( + describeTargetHealth( args: DescribeTargetHealthCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTargetHealth( + describeTargetHealth( args: DescribeTargetHealthCommandInput, cb: (err: any, data?: DescribeTargetHealthCommandOutput) => void ): void; - public describeTargetHealth( + describeTargetHealth( args: DescribeTargetHealthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTargetHealthCommandOutput) => void ): void; - public describeTargetHealth( - args: DescribeTargetHealthCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTargetHealthCommandOutput) => void), - cb?: (err: any, data?: DescribeTargetHealthCommandOutput) => void - ): Promise | void { - const command = new DescribeTargetHealthCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Replaces the specified properties of the specified listener. Any properties that you do - * not specify remain unchanged.

- *

Changing the protocol from HTTPS to HTTP, or from TLS to TCP, removes the security policy - * and default certificate properties. If you change the protocol from HTTP to HTTPS, or from TCP - * to TLS, you must add the security policy and default certificate properties.

- *

To add an item to a list, remove an item from a list, or update an item in a list, you - * must provide the entire list. For example, to add an action, specify a list with the current - * actions plus the new action.

+ * @see {@link ModifyListenerCommand} */ - public modifyListener( + modifyListener( args: ModifyListenerCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyListener( - args: ModifyListenerCommandInput, - cb: (err: any, data?: ModifyListenerCommandOutput) => void - ): void; - public modifyListener( + modifyListener(args: ModifyListenerCommandInput, cb: (err: any, data?: ModifyListenerCommandOutput) => void): void; + modifyListener( args: ModifyListenerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyListenerCommandOutput) => void ): void; - public modifyListener( - args: ModifyListenerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyListenerCommandOutput) => void), - cb?: (err: any, data?: ModifyListenerCommandOutput) => void - ): Promise | void { - const command = new ModifyListenerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the specified attributes of the specified Application Load Balancer, Network Load - * Balancer, or Gateway Load Balancer.

- *

If any of the specified attributes can't be modified as requested, the call fails. Any - * existing attributes that you do not modify retain their current values.

+ * @see {@link ModifyLoadBalancerAttributesCommand} */ - public modifyLoadBalancerAttributes( + modifyLoadBalancerAttributes( args: ModifyLoadBalancerAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyLoadBalancerAttributes( + modifyLoadBalancerAttributes( args: ModifyLoadBalancerAttributesCommandInput, cb: (err: any, data?: ModifyLoadBalancerAttributesCommandOutput) => void ): void; - public modifyLoadBalancerAttributes( + modifyLoadBalancerAttributes( args: ModifyLoadBalancerAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyLoadBalancerAttributesCommandOutput) => void ): void; - public modifyLoadBalancerAttributes( - args: ModifyLoadBalancerAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyLoadBalancerAttributesCommandOutput) => void), - cb?: (err: any, data?: ModifyLoadBalancerAttributesCommandOutput) => void - ): Promise | void { - const command = new ModifyLoadBalancerAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Replaces the specified properties of the specified rule. Any properties that you do not - * specify are unchanged.

- *

To add an item to a list, remove an item from a list, or update an item in a list, you - * must provide the entire list. For example, to add an action, specify a list with the current - * actions plus the new action.

+ * @see {@link ModifyRuleCommand} */ - public modifyRule(args: ModifyRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public modifyRule(args: ModifyRuleCommandInput, cb: (err: any, data?: ModifyRuleCommandOutput) => void): void; - public modifyRule( + modifyRule(args: ModifyRuleCommandInput, options?: __HttpHandlerOptions): Promise; + modifyRule(args: ModifyRuleCommandInput, cb: (err: any, data?: ModifyRuleCommandOutput) => void): void; + modifyRule( args: ModifyRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyRuleCommandOutput) => void ): void; - public modifyRule( - args: ModifyRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyRuleCommandOutput) => void), - cb?: (err: any, data?: ModifyRuleCommandOutput) => void - ): Promise | void { - const command = new ModifyRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the health checks used when evaluating the health state of the targets in the - * specified target group.

+ * @see {@link ModifyTargetGroupCommand} */ - public modifyTargetGroup( + modifyTargetGroup( args: ModifyTargetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyTargetGroup( + modifyTargetGroup( args: ModifyTargetGroupCommandInput, cb: (err: any, data?: ModifyTargetGroupCommandOutput) => void ): void; - public modifyTargetGroup( + modifyTargetGroup( args: ModifyTargetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyTargetGroupCommandOutput) => void ): void; - public modifyTargetGroup( - args: ModifyTargetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyTargetGroupCommandOutput) => void), - cb?: (err: any, data?: ModifyTargetGroupCommandOutput) => void - ): Promise | void { - const command = new ModifyTargetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the specified attributes of the specified target group.

+ * @see {@link ModifyTargetGroupAttributesCommand} */ - public modifyTargetGroupAttributes( + modifyTargetGroupAttributes( args: ModifyTargetGroupAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyTargetGroupAttributes( + modifyTargetGroupAttributes( args: ModifyTargetGroupAttributesCommandInput, cb: (err: any, data?: ModifyTargetGroupAttributesCommandOutput) => void ): void; - public modifyTargetGroupAttributes( + modifyTargetGroupAttributes( args: ModifyTargetGroupAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyTargetGroupAttributesCommandOutput) => void ): void; - public modifyTargetGroupAttributes( - args: ModifyTargetGroupAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyTargetGroupAttributesCommandOutput) => void), - cb?: (err: any, data?: ModifyTargetGroupAttributesCommandOutput) => void - ): Promise | void { - const command = new ModifyTargetGroupAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers the specified targets with the specified target group.

- *

If the target is an EC2 instance, it must be in the running state when you - * register it.

- *

By default, the load balancer routes requests to registered targets using the protocol and - * port for the target group. Alternatively, you can override the port for a target when you - * register it. You can register each EC2 instance or IP address with the same target group - * multiple times using different ports.

- *

With a Network Load Balancer, you cannot register instances by instance ID if they have - * the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, - * and T1. You can register instances of these types by IP address.

+ * @see {@link RegisterTargetsCommand} */ - public registerTargets( + registerTargets( args: RegisterTargetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerTargets( - args: RegisterTargetsCommandInput, - cb: (err: any, data?: RegisterTargetsCommandOutput) => void - ): void; - public registerTargets( + registerTargets(args: RegisterTargetsCommandInput, cb: (err: any, data?: RegisterTargetsCommandOutput) => void): void; + registerTargets( args: RegisterTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterTargetsCommandOutput) => void ): void; - public registerTargets( - args: RegisterTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterTargetsCommandOutput) => void), - cb?: (err: any, data?: RegisterTargetsCommandOutput) => void - ): Promise | void { - const command = new RegisterTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified certificate from the certificate list for the specified HTTPS or TLS - * listener.

+ * @see {@link RemoveListenerCertificatesCommand} */ - public removeListenerCertificates( + removeListenerCertificates( args: RemoveListenerCertificatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeListenerCertificates( + removeListenerCertificates( args: RemoveListenerCertificatesCommandInput, cb: (err: any, data?: RemoveListenerCertificatesCommandOutput) => void ): void; - public removeListenerCertificates( + removeListenerCertificates( args: RemoveListenerCertificatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveListenerCertificatesCommandOutput) => void ): void; - public removeListenerCertificates( - args: RemoveListenerCertificatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveListenerCertificatesCommandOutput) => void), - cb?: (err: any, data?: RemoveListenerCertificatesCommandOutput) => void - ): Promise | void { - const command = new RemoveListenerCertificatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified tags from the specified Elastic Load Balancing resources. You can - * remove the tags for one or more Application Load Balancers, Network Load Balancers, Gateway - * Load Balancers, target groups, listeners, or rules.

+ * @see {@link RemoveTagsCommand} */ - public removeTags(args: RemoveTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public removeTags(args: RemoveTagsCommandInput, cb: (err: any, data?: RemoveTagsCommandOutput) => void): void; - public removeTags( + removeTags(args: RemoveTagsCommandInput, options?: __HttpHandlerOptions): Promise; + removeTags(args: RemoveTagsCommandInput, cb: (err: any, data?: RemoveTagsCommandOutput) => void): void; + removeTags( args: RemoveTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsCommandOutput) => void ): void; - public removeTags( - args: RemoveTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveTagsCommandOutput) => void), - cb?: (err: any, data?: RemoveTagsCommandOutput) => void - ): Promise | void { - const command = new RemoveTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the type of IP addresses used by the subnets of the specified load balancer.

+ * @see {@link SetIpAddressTypeCommand} */ - public setIpAddressType( + setIpAddressType( args: SetIpAddressTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public setIpAddressType( + setIpAddressType( args: SetIpAddressTypeCommandInput, cb: (err: any, data?: SetIpAddressTypeCommandOutput) => void ): void; - public setIpAddressType( + setIpAddressType( args: SetIpAddressTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetIpAddressTypeCommandOutput) => void ): void; - public setIpAddressType( - args: SetIpAddressTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetIpAddressTypeCommandOutput) => void), - cb?: (err: any, data?: SetIpAddressTypeCommandOutput) => void - ): Promise | void { - const command = new SetIpAddressTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the priorities of the specified rules.

- *

You can reorder the rules as long as there are no priority conflicts in the new order. Any - * existing rules that you do not specify retain their current priority.

+ * @see {@link SetRulePrioritiesCommand} */ - public setRulePriorities( + setRulePriorities( args: SetRulePrioritiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public setRulePriorities( + setRulePriorities( args: SetRulePrioritiesCommandInput, cb: (err: any, data?: SetRulePrioritiesCommandOutput) => void ): void; - public setRulePriorities( + setRulePriorities( args: SetRulePrioritiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetRulePrioritiesCommandOutput) => void ): void; - public setRulePriorities( - args: SetRulePrioritiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetRulePrioritiesCommandOutput) => void), - cb?: (err: any, data?: SetRulePrioritiesCommandOutput) => void - ): Promise | void { - const command = new SetRulePrioritiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates the specified security groups with the specified Application Load Balancer. The - * specified security groups override the previously associated security groups.

- *

You can't specify a security group for a Network Load Balancer or Gateway Load - * Balancer.

+ * @see {@link SetSecurityGroupsCommand} */ - public setSecurityGroups( + setSecurityGroups( args: SetSecurityGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public setSecurityGroups( + setSecurityGroups( args: SetSecurityGroupsCommandInput, cb: (err: any, data?: SetSecurityGroupsCommandOutput) => void ): void; - public setSecurityGroups( + setSecurityGroups( args: SetSecurityGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetSecurityGroupsCommandOutput) => void ): void; - public setSecurityGroups( - args: SetSecurityGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetSecurityGroupsCommandOutput) => void), - cb?: (err: any, data?: SetSecurityGroupsCommandOutput) => void - ): Promise | void { - const command = new SetSecurityGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the Availability Zones for the specified public subnets for the specified - * Application Load Balancer or Network Load Balancer. The specified subnets replace the - * previously enabled subnets.

- *

When you specify subnets for a Network Load Balancer, you must include all subnets that - * were enabled previously, with their existing configurations, plus any additional - * subnets.

+ * @see {@link SetSubnetsCommand} */ - public setSubnets(args: SetSubnetsCommandInput, options?: __HttpHandlerOptions): Promise; - public setSubnets(args: SetSubnetsCommandInput, cb: (err: any, data?: SetSubnetsCommandOutput) => void): void; - public setSubnets( + setSubnets(args: SetSubnetsCommandInput, options?: __HttpHandlerOptions): Promise; + setSubnets(args: SetSubnetsCommandInput, cb: (err: any, data?: SetSubnetsCommandOutput) => void): void; + setSubnets( args: SetSubnetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetSubnetsCommandOutput) => void ): void; - public setSubnets( - args: SetSubnetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetSubnetsCommandOutput) => void), - cb?: (err: any, data?: SetSubnetsCommandOutput) => void - ): Promise | void { - const command = new SetSubnetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Elastic Load Balancing + *

A load balancer distributes incoming traffic across targets, such as your EC2 instances. + * This enables you to increase the availability of your application. The load balancer also + * monitors the health of its registered targets and ensures that it routes traffic only to + * healthy targets. You configure your load balancer to accept incoming traffic by specifying one + * or more listeners, which are configured with a protocol and port number for connections from + * clients to the load balancer. You configure a target group with a protocol and port number for + * connections from the load balancer to the targets, and with health check settings to be used + * when checking the health status of the targets.

+ *

Elastic Load Balancing supports the following types of load balancers: Application Load + * Balancers, Network Load Balancers, Gateway Load Balancers, and Classic Load Balancers. This + * reference covers the following load balancer types:

+ *
    + *
  • + *

    Application Load Balancer - Operates at the application layer (layer 7) and supports + * HTTP and HTTPS.

    + *
  • + *
  • + *

    Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, + * TLS, and UDP.

    + *
  • + *
  • + *

    Gateway Load Balancer - Operates at the network layer (layer 3).

    + *
  • + *
+ *

For more information, see the Elastic Load Balancing User + * Guide.

+ *

All Elastic Load Balancing operations are idempotent, which means that they complete at + * most one time. If you repeat an operation, it succeeds.

+ */ +export class ElasticLoadBalancingV2 extends ElasticLoadBalancingV2Client implements ElasticLoadBalancingV2 {} +createAggregatedClient(commands, ElasticLoadBalancingV2); diff --git a/clients/client-elastic-load-balancing/src/ElasticLoadBalancing.ts b/clients/client-elastic-load-balancing/src/ElasticLoadBalancing.ts index ed29c2862cbb..7b46b5782b28 100644 --- a/clients/client-elastic-load-balancing/src/ElasticLoadBalancing.ts +++ b/clients/client-elastic-load-balancing/src/ElasticLoadBalancing.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { AddTagsCommand, AddTagsCommandInput, AddTagsCommandOutput } from "./commands/AddTagsCommand"; @@ -138,1124 +139,540 @@ import { SetLoadBalancerPoliciesOfListenerCommandInput, SetLoadBalancerPoliciesOfListenerCommandOutput, } from "./commands/SetLoadBalancerPoliciesOfListenerCommand"; -import { ElasticLoadBalancingClient } from "./ElasticLoadBalancingClient"; +import { ElasticLoadBalancingClient, ElasticLoadBalancingClientConfig } from "./ElasticLoadBalancingClient"; -/** - * @public - * Elastic Load Balancing - * - *

A load balancer can distribute incoming traffic across your EC2 instances. - * This enables you to increase the availability of your application. The load balancer - * also monitors the health of its registered instances and ensures that it routes traffic - * only to healthy instances. You configure your load balancer to accept incoming traffic - * by specifying one or more listeners, which are configured with a protocol and port - * number for connections from clients to the load balancer and a protocol and port number - * for connections from the load balancer to the instances.

- *

Elastic Load Balancing supports three types of load balancers: Application Load Balancers, Network Load Balancers, - * and Classic Load Balancers. You can select a load balancer based on your application needs. For more - * information, see the Elastic Load Balancing User Guide.

- *

This reference covers the 2012-06-01 API, which supports Classic Load Balancers. - * The 2015-12-01 API supports Application Load Balancers and Network Load Balancers.

- * - *

To get started, create a load balancer with one or more listeners using CreateLoadBalancer. - * Register your instances with the load balancer using RegisterInstancesWithLoadBalancer.

- * - *

All Elastic Load Balancing operations are idempotent, which means - * that they complete at most one time. If you repeat an operation, it succeeds with a 200 OK - * response code.

- */ -export class ElasticLoadBalancing extends ElasticLoadBalancingClient { +const commands = { + AddTagsCommand, + ApplySecurityGroupsToLoadBalancerCommand, + AttachLoadBalancerToSubnetsCommand, + ConfigureHealthCheckCommand, + CreateAppCookieStickinessPolicyCommand, + CreateLBCookieStickinessPolicyCommand, + CreateLoadBalancerCommand, + CreateLoadBalancerListenersCommand, + CreateLoadBalancerPolicyCommand, + DeleteLoadBalancerCommand, + DeleteLoadBalancerListenersCommand, + DeleteLoadBalancerPolicyCommand, + DeregisterInstancesFromLoadBalancerCommand, + DescribeAccountLimitsCommand, + DescribeInstanceHealthCommand, + DescribeLoadBalancerAttributesCommand, + DescribeLoadBalancerPoliciesCommand, + DescribeLoadBalancerPolicyTypesCommand, + DescribeLoadBalancersCommand, + DescribeTagsCommand, + DetachLoadBalancerFromSubnetsCommand, + DisableAvailabilityZonesForLoadBalancerCommand, + EnableAvailabilityZonesForLoadBalancerCommand, + ModifyLoadBalancerAttributesCommand, + RegisterInstancesWithLoadBalancerCommand, + RemoveTagsCommand, + SetLoadBalancerListenerSSLCertificateCommand, + SetLoadBalancerPoliciesForBackendServerCommand, + SetLoadBalancerPoliciesOfListenerCommand, +}; + +export interface ElasticLoadBalancing { /** - * @public - *

Adds the specified tags to the specified load balancer. Each load balancer can have a maximum of 10 tags.

- * - *

Each tag consists of a key and an optional value. If a tag with the same key is already associated - * with the load balancer, AddTags updates its value.

- * - *

For more information, see Tag Your Classic Load Balancer - * in the Classic Load Balancers Guide.

+ * @see {@link AddTagsCommand} */ - public addTags(args: AddTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public addTags(args: AddTagsCommandInput, cb: (err: any, data?: AddTagsCommandOutput) => void): void; - public addTags( + addTags(args: AddTagsCommandInput, options?: __HttpHandlerOptions): Promise; + addTags(args: AddTagsCommandInput, cb: (err: any, data?: AddTagsCommandOutput) => void): void; + addTags( args: AddTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsCommandOutput) => void ): void; - public addTags( - args: AddTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddTagsCommandOutput) => void), - cb?: (err: any, data?: AddTagsCommandOutput) => void - ): Promise | void { - const command = new AddTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates one or more security groups with your load balancer in a virtual private cloud (VPC). The specified security groups override the previously associated security groups.

- *

For more information, see Security Groups for Load Balancers in a VPC - * in the Classic Load Balancers Guide.

+ * @see {@link ApplySecurityGroupsToLoadBalancerCommand} */ - public applySecurityGroupsToLoadBalancer( + applySecurityGroupsToLoadBalancer( args: ApplySecurityGroupsToLoadBalancerCommandInput, options?: __HttpHandlerOptions ): Promise; - public applySecurityGroupsToLoadBalancer( + applySecurityGroupsToLoadBalancer( args: ApplySecurityGroupsToLoadBalancerCommandInput, cb: (err: any, data?: ApplySecurityGroupsToLoadBalancerCommandOutput) => void ): void; - public applySecurityGroupsToLoadBalancer( + applySecurityGroupsToLoadBalancer( args: ApplySecurityGroupsToLoadBalancerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ApplySecurityGroupsToLoadBalancerCommandOutput) => void ): void; - public applySecurityGroupsToLoadBalancer( - args: ApplySecurityGroupsToLoadBalancerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ApplySecurityGroupsToLoadBalancerCommandOutput) => void), - cb?: (err: any, data?: ApplySecurityGroupsToLoadBalancerCommandOutput) => void - ): Promise | void { - const command = new ApplySecurityGroupsToLoadBalancerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more subnets to the set of configured subnets for the specified load balancer.

- *

The load balancer evenly distributes requests across all registered subnets. - * For more information, see Add or Remove Subnets for Your Load Balancer in a VPC - * in the Classic Load Balancers Guide.

+ * @see {@link AttachLoadBalancerToSubnetsCommand} */ - public attachLoadBalancerToSubnets( + attachLoadBalancerToSubnets( args: AttachLoadBalancerToSubnetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachLoadBalancerToSubnets( + attachLoadBalancerToSubnets( args: AttachLoadBalancerToSubnetsCommandInput, cb: (err: any, data?: AttachLoadBalancerToSubnetsCommandOutput) => void ): void; - public attachLoadBalancerToSubnets( + attachLoadBalancerToSubnets( args: AttachLoadBalancerToSubnetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachLoadBalancerToSubnetsCommandOutput) => void ): void; - public attachLoadBalancerToSubnets( - args: AttachLoadBalancerToSubnetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachLoadBalancerToSubnetsCommandOutput) => void), - cb?: (err: any, data?: AttachLoadBalancerToSubnetsCommandOutput) => void - ): Promise | void { - const command = new AttachLoadBalancerToSubnetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Specifies the health check settings to use when evaluating the health state of your EC2 instances.

- *

For more information, see Configure Health Checks for Your Load Balancer - * in the Classic Load Balancers Guide.

+ * @see {@link ConfigureHealthCheckCommand} */ - public configureHealthCheck( + configureHealthCheck( args: ConfigureHealthCheckCommandInput, options?: __HttpHandlerOptions ): Promise; - public configureHealthCheck( + configureHealthCheck( args: ConfigureHealthCheckCommandInput, cb: (err: any, data?: ConfigureHealthCheckCommandOutput) => void ): void; - public configureHealthCheck( + configureHealthCheck( args: ConfigureHealthCheckCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfigureHealthCheckCommandOutput) => void ): void; - public configureHealthCheck( - args: ConfigureHealthCheckCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConfigureHealthCheckCommandOutput) => void), - cb?: (err: any, data?: ConfigureHealthCheckCommandOutput) => void - ): Promise | void { - const command = new ConfigureHealthCheckCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners.

- *

This policy is similar to the policy created by CreateLBCookieStickinessPolicy, - * except that the lifetime of the special Elastic Load Balancing cookie, AWSELB, - * follows the lifetime of the application-generated cookie specified in the policy configuration. - * The load balancer only inserts a new stickiness cookie when the application response - * includes a new application cookie.

- *

If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued.

- *

For more information, see Application-Controlled Session Stickiness - * in the Classic Load Balancers Guide.

+ * @see {@link CreateAppCookieStickinessPolicyCommand} */ - public createAppCookieStickinessPolicy( + createAppCookieStickinessPolicy( args: CreateAppCookieStickinessPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAppCookieStickinessPolicy( + createAppCookieStickinessPolicy( args: CreateAppCookieStickinessPolicyCommandInput, cb: (err: any, data?: CreateAppCookieStickinessPolicyCommandOutput) => void ): void; - public createAppCookieStickinessPolicy( + createAppCookieStickinessPolicy( args: CreateAppCookieStickinessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppCookieStickinessPolicyCommandOutput) => void ): void; - public createAppCookieStickinessPolicy( - args: CreateAppCookieStickinessPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAppCookieStickinessPolicyCommandOutput) => void), - cb?: (err: any, data?: CreateAppCookieStickinessPolicyCommandOutput) => void - ): Promise | void { - const command = new CreateAppCookieStickinessPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners.

- *

When a load balancer implements this policy, the load balancer uses a special cookie to track the instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. - * If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load-balancing algorithm.

- *

A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration.

- * - *

For more information, see Duration-Based Session Stickiness - * in the Classic Load Balancers Guide.

+ * @see {@link CreateLBCookieStickinessPolicyCommand} */ - public createLBCookieStickinessPolicy( + createLBCookieStickinessPolicy( args: CreateLBCookieStickinessPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLBCookieStickinessPolicy( + createLBCookieStickinessPolicy( args: CreateLBCookieStickinessPolicyCommandInput, cb: (err: any, data?: CreateLBCookieStickinessPolicyCommandOutput) => void ): void; - public createLBCookieStickinessPolicy( + createLBCookieStickinessPolicy( args: CreateLBCookieStickinessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLBCookieStickinessPolicyCommandOutput) => void ): void; - public createLBCookieStickinessPolicy( - args: CreateLBCookieStickinessPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLBCookieStickinessPolicyCommandOutput) => void), - cb?: (err: any, data?: CreateLBCookieStickinessPolicyCommandOutput) => void - ): Promise | void { - const command = new CreateLBCookieStickinessPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a Classic Load Balancer.

- * - *

You can add listeners, security groups, subnets, and tags when you create your load balancer, - * or you can add them later using CreateLoadBalancerListeners, - * ApplySecurityGroupsToLoadBalancer, AttachLoadBalancerToSubnets, - * and AddTags.

- *

To describe your current load balancers, see DescribeLoadBalancers. - * When you are finished with a load balancer, you can delete it using - * DeleteLoadBalancer.

- * - *

You can create up to 20 load balancers per region per account. - * You can request an increase for the number of load balancers for your account. - * For more information, see Limits for Your Classic Load Balancer - * in the Classic Load Balancers Guide.

+ * @see {@link CreateLoadBalancerCommand} */ - public createLoadBalancer( + createLoadBalancer( args: CreateLoadBalancerCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLoadBalancer( + createLoadBalancer( args: CreateLoadBalancerCommandInput, cb: (err: any, data?: CreateLoadBalancerCommandOutput) => void ): void; - public createLoadBalancer( + createLoadBalancer( args: CreateLoadBalancerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLoadBalancerCommandOutput) => void ): void; - public createLoadBalancer( - args: CreateLoadBalancerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLoadBalancerCommandOutput) => void), - cb?: (err: any, data?: CreateLoadBalancerCommandOutput) => void - ): Promise | void { - const command = new CreateLoadBalancerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates one or more listeners for the specified load balancer. If a listener with the specified port does not already exist, it is created; otherwise, the properties of the new listener must match the properties of the existing listener.

- *

For more information, see Listeners for Your Classic Load Balancer - * in the Classic Load Balancers Guide.

+ * @see {@link CreateLoadBalancerListenersCommand} */ - public createLoadBalancerListeners( + createLoadBalancerListeners( args: CreateLoadBalancerListenersCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLoadBalancerListeners( + createLoadBalancerListeners( args: CreateLoadBalancerListenersCommandInput, cb: (err: any, data?: CreateLoadBalancerListenersCommandOutput) => void ): void; - public createLoadBalancerListeners( + createLoadBalancerListeners( args: CreateLoadBalancerListenersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLoadBalancerListenersCommandOutput) => void ): void; - public createLoadBalancerListeners( - args: CreateLoadBalancerListenersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLoadBalancerListenersCommandOutput) => void), - cb?: (err: any, data?: CreateLoadBalancerListenersCommandOutput) => void - ): Promise | void { - const command = new CreateLoadBalancerListenersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a policy with the specified attributes for the specified load balancer.

- *

Policies are settings that are saved for your load balancer and that can be applied to the listener or the application server, depending on the policy type.

+ * @see {@link CreateLoadBalancerPolicyCommand} */ - public createLoadBalancerPolicy( + createLoadBalancerPolicy( args: CreateLoadBalancerPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLoadBalancerPolicy( + createLoadBalancerPolicy( args: CreateLoadBalancerPolicyCommandInput, cb: (err: any, data?: CreateLoadBalancerPolicyCommandOutput) => void ): void; - public createLoadBalancerPolicy( + createLoadBalancerPolicy( args: CreateLoadBalancerPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLoadBalancerPolicyCommandOutput) => void ): void; - public createLoadBalancerPolicy( - args: CreateLoadBalancerPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLoadBalancerPolicyCommandOutput) => void), - cb?: (err: any, data?: CreateLoadBalancerPolicyCommandOutput) => void - ): Promise | void { - const command = new CreateLoadBalancerPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified load balancer.

- *

If you are attempting to recreate a load balancer, you must reconfigure all settings. The DNS name associated with a deleted load balancer are no longer usable. The name and associated DNS record of the deleted load balancer no longer exist and traffic sent to any of its IP addresses is no longer delivered to your instances.

- *

If the load balancer does not exist or has already been deleted, the call to - * DeleteLoadBalancer still succeeds.

+ * @see {@link DeleteLoadBalancerCommand} */ - public deleteLoadBalancer( + deleteLoadBalancer( args: DeleteLoadBalancerCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLoadBalancer( + deleteLoadBalancer( args: DeleteLoadBalancerCommandInput, cb: (err: any, data?: DeleteLoadBalancerCommandOutput) => void ): void; - public deleteLoadBalancer( + deleteLoadBalancer( args: DeleteLoadBalancerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLoadBalancerCommandOutput) => void ): void; - public deleteLoadBalancer( - args: DeleteLoadBalancerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLoadBalancerCommandOutput) => void), - cb?: (err: any, data?: DeleteLoadBalancerCommandOutput) => void - ): Promise | void { - const command = new DeleteLoadBalancerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified listeners from the specified load balancer.

+ * @see {@link DeleteLoadBalancerListenersCommand} */ - public deleteLoadBalancerListeners( + deleteLoadBalancerListeners( args: DeleteLoadBalancerListenersCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLoadBalancerListeners( + deleteLoadBalancerListeners( args: DeleteLoadBalancerListenersCommandInput, cb: (err: any, data?: DeleteLoadBalancerListenersCommandOutput) => void ): void; - public deleteLoadBalancerListeners( + deleteLoadBalancerListeners( args: DeleteLoadBalancerListenersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLoadBalancerListenersCommandOutput) => void ): void; - public deleteLoadBalancerListeners( - args: DeleteLoadBalancerListenersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLoadBalancerListenersCommandOutput) => void), - cb?: (err: any, data?: DeleteLoadBalancerListenersCommandOutput) => void - ): Promise | void { - const command = new DeleteLoadBalancerListenersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners.

+ * @see {@link DeleteLoadBalancerPolicyCommand} */ - public deleteLoadBalancerPolicy( + deleteLoadBalancerPolicy( args: DeleteLoadBalancerPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLoadBalancerPolicy( + deleteLoadBalancerPolicy( args: DeleteLoadBalancerPolicyCommandInput, cb: (err: any, data?: DeleteLoadBalancerPolicyCommandOutput) => void ): void; - public deleteLoadBalancerPolicy( + deleteLoadBalancerPolicy( args: DeleteLoadBalancerPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLoadBalancerPolicyCommandOutput) => void ): void; - public deleteLoadBalancerPolicy( - args: DeleteLoadBalancerPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLoadBalancerPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteLoadBalancerPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteLoadBalancerPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deregisters the specified instances from the specified load balancer. After the instance is deregistered, it no longer receives traffic from the load balancer.

- * - *

You can use DescribeLoadBalancers to verify that the instance is deregistered from the load balancer.

- * - *

For more information, see Register or De-Register EC2 Instances - * in the Classic Load Balancers Guide.

+ * @see {@link DeregisterInstancesFromLoadBalancerCommand} */ - public deregisterInstancesFromLoadBalancer( + deregisterInstancesFromLoadBalancer( args: DeregisterInstancesFromLoadBalancerCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterInstancesFromLoadBalancer( + deregisterInstancesFromLoadBalancer( args: DeregisterInstancesFromLoadBalancerCommandInput, cb: (err: any, data?: DeregisterInstancesFromLoadBalancerCommandOutput) => void ): void; - public deregisterInstancesFromLoadBalancer( + deregisterInstancesFromLoadBalancer( args: DeregisterInstancesFromLoadBalancerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterInstancesFromLoadBalancerCommandOutput) => void ): void; - public deregisterInstancesFromLoadBalancer( - args: DeregisterInstancesFromLoadBalancerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterInstancesFromLoadBalancerCommandOutput) => void), - cb?: (err: any, data?: DeregisterInstancesFromLoadBalancerCommandOutput) => void - ): Promise | void { - const command = new DeregisterInstancesFromLoadBalancerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the current Elastic Load Balancing resource limits for your AWS account.

- *

For more information, see Limits for Your Classic Load Balancer - * in the Classic Load Balancers Guide.

+ * @see {@link DescribeAccountLimitsCommand} */ - public describeAccountLimits( + describeAccountLimits( args: DescribeAccountLimitsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccountLimits( + describeAccountLimits( args: DescribeAccountLimitsCommandInput, cb: (err: any, data?: DescribeAccountLimitsCommandOutput) => void ): void; - public describeAccountLimits( + describeAccountLimits( args: DescribeAccountLimitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountLimitsCommandOutput) => void ): void; - public describeAccountLimits( - args: DescribeAccountLimitsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccountLimitsCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountLimitsCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountLimitsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the state of the specified instances with respect to the specified load balancer. If no instances are specified, the call describes the state of all instances that are currently registered with the load balancer. If instances are specified, their state is returned even if they are no longer registered with the load balancer. The state of terminated instances is not returned.

+ * @see {@link DescribeInstanceHealthCommand} */ - public describeInstanceHealth( + describeInstanceHealth( args: DescribeInstanceHealthCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInstanceHealth( + describeInstanceHealth( args: DescribeInstanceHealthCommandInput, cb: (err: any, data?: DescribeInstanceHealthCommandOutput) => void ): void; - public describeInstanceHealth( + describeInstanceHealth( args: DescribeInstanceHealthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstanceHealthCommandOutput) => void ): void; - public describeInstanceHealth( - args: DescribeInstanceHealthCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInstanceHealthCommandOutput) => void), - cb?: (err: any, data?: DescribeInstanceHealthCommandOutput) => void - ): Promise | void { - const command = new DescribeInstanceHealthCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the attributes for the specified load balancer.

+ * @see {@link DescribeLoadBalancerAttributesCommand} */ - public describeLoadBalancerAttributes( + describeLoadBalancerAttributes( args: DescribeLoadBalancerAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLoadBalancerAttributes( + describeLoadBalancerAttributes( args: DescribeLoadBalancerAttributesCommandInput, cb: (err: any, data?: DescribeLoadBalancerAttributesCommandOutput) => void ): void; - public describeLoadBalancerAttributes( + describeLoadBalancerAttributes( args: DescribeLoadBalancerAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLoadBalancerAttributesCommandOutput) => void ): void; - public describeLoadBalancerAttributes( - args: DescribeLoadBalancerAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLoadBalancerAttributesCommandOutput) => void), - cb?: (err: any, data?: DescribeLoadBalancerAttributesCommandOutput) => void - ): Promise | void { - const command = new DescribeLoadBalancerAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified policies.

- *

If you specify a load balancer name, the action returns the descriptions of all policies created for the load balancer. - * If you specify a policy name associated with your load balancer, the action returns the description of that policy. - * If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all sample policies. - * The names of the sample policies have the ELBSample- prefix.

+ * @see {@link DescribeLoadBalancerPoliciesCommand} */ - public describeLoadBalancerPolicies( + describeLoadBalancerPolicies( args: DescribeLoadBalancerPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLoadBalancerPolicies( + describeLoadBalancerPolicies( args: DescribeLoadBalancerPoliciesCommandInput, cb: (err: any, data?: DescribeLoadBalancerPoliciesCommandOutput) => void ): void; - public describeLoadBalancerPolicies( + describeLoadBalancerPolicies( args: DescribeLoadBalancerPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLoadBalancerPoliciesCommandOutput) => void ): void; - public describeLoadBalancerPolicies( - args: DescribeLoadBalancerPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLoadBalancerPoliciesCommandOutput) => void), - cb?: (err: any, data?: DescribeLoadBalancerPoliciesCommandOutput) => void - ): Promise | void { - const command = new DescribeLoadBalancerPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified load balancer policy types or all load balancer policy types.

- *

The description of each type indicates how it can be used. For example, - * some policies can be used only with layer 7 listeners, - * some policies can be used only with layer 4 listeners, - * and some policies can be used only with your EC2 instances.

- *

You can use CreateLoadBalancerPolicy to create a policy configuration for any of these policy types. - * Then, depending on the policy type, use either SetLoadBalancerPoliciesOfListener or - * SetLoadBalancerPoliciesForBackendServer to set the policy.

+ * @see {@link DescribeLoadBalancerPolicyTypesCommand} */ - public describeLoadBalancerPolicyTypes( + describeLoadBalancerPolicyTypes( args: DescribeLoadBalancerPolicyTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLoadBalancerPolicyTypes( + describeLoadBalancerPolicyTypes( args: DescribeLoadBalancerPolicyTypesCommandInput, cb: (err: any, data?: DescribeLoadBalancerPolicyTypesCommandOutput) => void ): void; - public describeLoadBalancerPolicyTypes( + describeLoadBalancerPolicyTypes( args: DescribeLoadBalancerPolicyTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLoadBalancerPolicyTypesCommandOutput) => void ): void; - public describeLoadBalancerPolicyTypes( - args: DescribeLoadBalancerPolicyTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLoadBalancerPolicyTypesCommandOutput) => void), - cb?: (err: any, data?: DescribeLoadBalancerPolicyTypesCommandOutput) => void - ): Promise | void { - const command = new DescribeLoadBalancerPolicyTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.

+ * @see {@link DescribeLoadBalancersCommand} */ - public describeLoadBalancers( + describeLoadBalancers( args: DescribeLoadBalancersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLoadBalancers( + describeLoadBalancers( args: DescribeLoadBalancersCommandInput, cb: (err: any, data?: DescribeLoadBalancersCommandOutput) => void ): void; - public describeLoadBalancers( + describeLoadBalancers( args: DescribeLoadBalancersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLoadBalancersCommandOutput) => void ): void; - public describeLoadBalancers( - args: DescribeLoadBalancersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLoadBalancersCommandOutput) => void), - cb?: (err: any, data?: DescribeLoadBalancersCommandOutput) => void - ): Promise | void { - const command = new DescribeLoadBalancersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the tags associated with the specified load balancers.

+ * @see {@link DescribeTagsCommand} */ - public describeTags( - args: DescribeTagsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeTags(args: DescribeTagsCommandInput, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void; - public describeTags( + describeTags(args: DescribeTagsCommandInput, options?: __HttpHandlerOptions): Promise; + describeTags(args: DescribeTagsCommandInput, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void; + describeTags( args: DescribeTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTagsCommandOutput) => void ): void; - public describeTags( - args: DescribeTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTagsCommandOutput) => void), - cb?: (err: any, data?: DescribeTagsCommandOutput) => void - ): Promise | void { - const command = new DescribeTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified subnets from the set of configured subnets for the load balancer.

- *

After a subnet is removed, all EC2 instances registered with the load balancer - * in the removed subnet go into the OutOfService state. Then, - * the load balancer balances the traffic among the remaining routable subnets.

+ * @see {@link DetachLoadBalancerFromSubnetsCommand} */ - public detachLoadBalancerFromSubnets( + detachLoadBalancerFromSubnets( args: DetachLoadBalancerFromSubnetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachLoadBalancerFromSubnets( + detachLoadBalancerFromSubnets( args: DetachLoadBalancerFromSubnetsCommandInput, cb: (err: any, data?: DetachLoadBalancerFromSubnetsCommandOutput) => void ): void; - public detachLoadBalancerFromSubnets( + detachLoadBalancerFromSubnets( args: DetachLoadBalancerFromSubnetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachLoadBalancerFromSubnetsCommandOutput) => void ): void; - public detachLoadBalancerFromSubnets( - args: DetachLoadBalancerFromSubnetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachLoadBalancerFromSubnetsCommandOutput) => void), - cb?: (err: any, data?: DetachLoadBalancerFromSubnetsCommandOutput) => void - ): Promise | void { - const command = new DetachLoadBalancerFromSubnetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer - * in EC2-Classic or a default VPC.

- *

For load balancers in a non-default VPC, use DetachLoadBalancerFromSubnets.

- *

There must be at least one Availability Zone registered with a load balancer at all times. - * After an Availability Zone is removed, all instances registered with the load balancer that are in the removed - * Availability Zone go into the OutOfService state. Then, the load balancer attempts to equally balance - * the traffic among its remaining Availability Zones.

- *

For more information, see Add or Remove Availability Zones - * in the Classic Load Balancers Guide.

+ * @see {@link DisableAvailabilityZonesForLoadBalancerCommand} */ - public disableAvailabilityZonesForLoadBalancer( + disableAvailabilityZonesForLoadBalancer( args: DisableAvailabilityZonesForLoadBalancerCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableAvailabilityZonesForLoadBalancer( + disableAvailabilityZonesForLoadBalancer( args: DisableAvailabilityZonesForLoadBalancerCommandInput, cb: (err: any, data?: DisableAvailabilityZonesForLoadBalancerCommandOutput) => void ): void; - public disableAvailabilityZonesForLoadBalancer( + disableAvailabilityZonesForLoadBalancer( args: DisableAvailabilityZonesForLoadBalancerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableAvailabilityZonesForLoadBalancerCommandOutput) => void ): void; - public disableAvailabilityZonesForLoadBalancer( - args: DisableAvailabilityZonesForLoadBalancerCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisableAvailabilityZonesForLoadBalancerCommandOutput) => void), - cb?: (err: any, data?: DisableAvailabilityZonesForLoadBalancerCommandOutput) => void - ): Promise | void { - const command = new DisableAvailabilityZonesForLoadBalancerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer - * in EC2-Classic or a default VPC.

- *

For load balancers in a non-default VPC, use AttachLoadBalancerToSubnets.

- *

The load balancer evenly distributes requests across all its registered Availability Zones - * that contain instances. For more information, see Add or Remove Availability Zones - * in the Classic Load Balancers Guide.

+ * @see {@link EnableAvailabilityZonesForLoadBalancerCommand} */ - public enableAvailabilityZonesForLoadBalancer( + enableAvailabilityZonesForLoadBalancer( args: EnableAvailabilityZonesForLoadBalancerCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableAvailabilityZonesForLoadBalancer( + enableAvailabilityZonesForLoadBalancer( args: EnableAvailabilityZonesForLoadBalancerCommandInput, cb: (err: any, data?: EnableAvailabilityZonesForLoadBalancerCommandOutput) => void ): void; - public enableAvailabilityZonesForLoadBalancer( + enableAvailabilityZonesForLoadBalancer( args: EnableAvailabilityZonesForLoadBalancerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableAvailabilityZonesForLoadBalancerCommandOutput) => void ): void; - public enableAvailabilityZonesForLoadBalancer( - args: EnableAvailabilityZonesForLoadBalancerCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: EnableAvailabilityZonesForLoadBalancerCommandOutput) => void), - cb?: (err: any, data?: EnableAvailabilityZonesForLoadBalancerCommandOutput) => void - ): Promise | void { - const command = new EnableAvailabilityZonesForLoadBalancerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the attributes of the specified load balancer.

- *

You can modify the load balancer attributes, such as AccessLogs, ConnectionDraining, and - * CrossZoneLoadBalancing by either enabling or disabling them. Or, you can modify the load balancer attribute - * ConnectionSettings by specifying an idle connection timeout value for your load balancer.

- *

For more information, see the following in the Classic Load Balancers Guide:

- * + * @see {@link ModifyLoadBalancerAttributesCommand} */ - public modifyLoadBalancerAttributes( + modifyLoadBalancerAttributes( args: ModifyLoadBalancerAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyLoadBalancerAttributes( + modifyLoadBalancerAttributes( args: ModifyLoadBalancerAttributesCommandInput, cb: (err: any, data?: ModifyLoadBalancerAttributesCommandOutput) => void ): void; - public modifyLoadBalancerAttributes( + modifyLoadBalancerAttributes( args: ModifyLoadBalancerAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyLoadBalancerAttributesCommandOutput) => void ): void; - public modifyLoadBalancerAttributes( - args: ModifyLoadBalancerAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyLoadBalancerAttributesCommandOutput) => void), - cb?: (err: any, data?: ModifyLoadBalancerAttributesCommandOutput) => void - ): Promise | void { - const command = new ModifyLoadBalancerAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds the specified instances to the specified load balancer.

- * - *

The instance must be a running instance in the same network as the load balancer (EC2-Classic or the same VPC). If you have EC2-Classic instances and a load balancer in a VPC with ClassicLink enabled, you can link the EC2-Classic instances to that VPC and then register the linked EC2-Classic instances with the load balancer in the VPC.

- * - *

Note that RegisterInstanceWithLoadBalancer completes when the request has been registered. - * Instance registration takes a little time to complete. To check the state of the registered instances, use - * DescribeLoadBalancers or DescribeInstanceHealth.

- * - *

After the instance is registered, it starts receiving traffic - * and requests from the load balancer. Any instance that is not - * in one of the Availability Zones registered for the load balancer - * is moved to the OutOfService state. If an Availability Zone - * is added to the load balancer later, any instances registered with the - * load balancer move to the InService state.

- * - *

To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer.

- * - *

For more information, see Register or De-Register EC2 Instances - * in the Classic Load Balancers Guide.

+ * @see {@link RegisterInstancesWithLoadBalancerCommand} */ - public registerInstancesWithLoadBalancer( + registerInstancesWithLoadBalancer( args: RegisterInstancesWithLoadBalancerCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerInstancesWithLoadBalancer( + registerInstancesWithLoadBalancer( args: RegisterInstancesWithLoadBalancerCommandInput, cb: (err: any, data?: RegisterInstancesWithLoadBalancerCommandOutput) => void ): void; - public registerInstancesWithLoadBalancer( + registerInstancesWithLoadBalancer( args: RegisterInstancesWithLoadBalancerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterInstancesWithLoadBalancerCommandOutput) => void ): void; - public registerInstancesWithLoadBalancer( - args: RegisterInstancesWithLoadBalancerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterInstancesWithLoadBalancerCommandOutput) => void), - cb?: (err: any, data?: RegisterInstancesWithLoadBalancerCommandOutput) => void - ): Promise | void { - const command = new RegisterInstancesWithLoadBalancerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from the specified load balancer.

+ * @see {@link RemoveTagsCommand} */ - public removeTags(args: RemoveTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public removeTags(args: RemoveTagsCommandInput, cb: (err: any, data?: RemoveTagsCommandOutput) => void): void; - public removeTags( + removeTags(args: RemoveTagsCommandInput, options?: __HttpHandlerOptions): Promise; + removeTags(args: RemoveTagsCommandInput, cb: (err: any, data?: RemoveTagsCommandOutput) => void): void; + removeTags( args: RemoveTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsCommandOutput) => void ): void; - public removeTags( - args: RemoveTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveTagsCommandOutput) => void), - cb?: (err: any, data?: RemoveTagsCommandOutput) => void - ): Promise | void { - const command = new RemoveTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same load balancer and port.

- * - *

For more information about updating your SSL certificate, see - * Replace the SSL Certificate for Your Load Balancer - * in the Classic Load Balancers Guide.

+ * @see {@link SetLoadBalancerListenerSSLCertificateCommand} */ - public setLoadBalancerListenerSSLCertificate( + setLoadBalancerListenerSSLCertificate( args: SetLoadBalancerListenerSSLCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public setLoadBalancerListenerSSLCertificate( + setLoadBalancerListenerSSLCertificate( args: SetLoadBalancerListenerSSLCertificateCommandInput, cb: (err: any, data?: SetLoadBalancerListenerSSLCertificateCommandOutput) => void ): void; - public setLoadBalancerListenerSSLCertificate( + setLoadBalancerListenerSSLCertificate( args: SetLoadBalancerListenerSSLCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetLoadBalancerListenerSSLCertificateCommandOutput) => void ): void; - public setLoadBalancerListenerSSLCertificate( - args: SetLoadBalancerListenerSSLCertificateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: SetLoadBalancerListenerSSLCertificateCommandOutput) => void), - cb?: (err: any, data?: SetLoadBalancerListenerSSLCertificateCommandOutput) => void - ): Promise | void { - const command = new SetLoadBalancerListenerSSLCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Replaces the set of policies associated with the specified port on which the EC2 instance is listening with a new set of policies. - * At this time, only the back-end server authentication policy type can be applied to the instance ports; this policy type is composed of multiple public key policies.

- *

Each time you use SetLoadBalancerPoliciesForBackendServer to enable the policies, - * use the PolicyNames parameter to list the policies that you want to enable.

- *

You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies to verify that the policy - * is associated with the EC2 instance.

- * - *

For more information about enabling back-end instance authentication, see Configure Back-end Instance Authentication - * in the Classic Load Balancers Guide. For more information about Proxy Protocol, see - * Configure Proxy Protocol Support - * in the Classic Load Balancers Guide.

+ * @see {@link SetLoadBalancerPoliciesForBackendServerCommand} */ - public setLoadBalancerPoliciesForBackendServer( + setLoadBalancerPoliciesForBackendServer( args: SetLoadBalancerPoliciesForBackendServerCommandInput, options?: __HttpHandlerOptions ): Promise; - public setLoadBalancerPoliciesForBackendServer( + setLoadBalancerPoliciesForBackendServer( args: SetLoadBalancerPoliciesForBackendServerCommandInput, cb: (err: any, data?: SetLoadBalancerPoliciesForBackendServerCommandOutput) => void ): void; - public setLoadBalancerPoliciesForBackendServer( + setLoadBalancerPoliciesForBackendServer( args: SetLoadBalancerPoliciesForBackendServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetLoadBalancerPoliciesForBackendServerCommandOutput) => void ): void; - public setLoadBalancerPoliciesForBackendServer( - args: SetLoadBalancerPoliciesForBackendServerCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: SetLoadBalancerPoliciesForBackendServerCommandOutput) => void), - cb?: (err: any, data?: SetLoadBalancerPoliciesForBackendServerCommandOutput) => void - ): Promise | void { - const command = new SetLoadBalancerPoliciesForBackendServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Replaces the current set of policies for the specified load balancer port with the specified set of policies.

- *

To enable back-end server authentication, use SetLoadBalancerPoliciesForBackendServer.

- *

For more information about setting policies, see - * Update the SSL Negotiation Configuration, - * Duration-Based Session Stickiness, and - * Application-Controlled Session Stickiness - * in the Classic Load Balancers Guide.

+ * @see {@link SetLoadBalancerPoliciesOfListenerCommand} */ - public setLoadBalancerPoliciesOfListener( + setLoadBalancerPoliciesOfListener( args: SetLoadBalancerPoliciesOfListenerCommandInput, options?: __HttpHandlerOptions ): Promise; - public setLoadBalancerPoliciesOfListener( + setLoadBalancerPoliciesOfListener( args: SetLoadBalancerPoliciesOfListenerCommandInput, cb: (err: any, data?: SetLoadBalancerPoliciesOfListenerCommandOutput) => void ): void; - public setLoadBalancerPoliciesOfListener( + setLoadBalancerPoliciesOfListener( args: SetLoadBalancerPoliciesOfListenerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetLoadBalancerPoliciesOfListenerCommandOutput) => void ): void; - public setLoadBalancerPoliciesOfListener( - args: SetLoadBalancerPoliciesOfListenerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetLoadBalancerPoliciesOfListenerCommandOutput) => void), - cb?: (err: any, data?: SetLoadBalancerPoliciesOfListenerCommandOutput) => void - ): Promise | void { - const command = new SetLoadBalancerPoliciesOfListenerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Elastic Load Balancing + * + *

A load balancer can distribute incoming traffic across your EC2 instances. + * This enables you to increase the availability of your application. The load balancer + * also monitors the health of its registered instances and ensures that it routes traffic + * only to healthy instances. You configure your load balancer to accept incoming traffic + * by specifying one or more listeners, which are configured with a protocol and port + * number for connections from clients to the load balancer and a protocol and port number + * for connections from the load balancer to the instances.

+ *

Elastic Load Balancing supports three types of load balancers: Application Load Balancers, Network Load Balancers, + * and Classic Load Balancers. You can select a load balancer based on your application needs. For more + * information, see the Elastic Load Balancing User Guide.

+ *

This reference covers the 2012-06-01 API, which supports Classic Load Balancers. + * The 2015-12-01 API supports Application Load Balancers and Network Load Balancers.

+ * + *

To get started, create a load balancer with one or more listeners using CreateLoadBalancer. + * Register your instances with the load balancer using RegisterInstancesWithLoadBalancer.

+ * + *

All Elastic Load Balancing operations are idempotent, which means + * that they complete at most one time. If you repeat an operation, it succeeds with a 200 OK + * response code.

+ */ +export class ElasticLoadBalancing extends ElasticLoadBalancingClient implements ElasticLoadBalancing {} +createAggregatedClient(commands, ElasticLoadBalancing); diff --git a/clients/client-elastic-transcoder/src/ElasticTranscoder.ts b/clients/client-elastic-transcoder/src/ElasticTranscoder.ts index 4b5e6ad5e91c..dc7ed3a6b504 100644 --- a/clients/client-elastic-transcoder/src/ElasticTranscoder.ts +++ b/clients/client-elastic-transcoder/src/ElasticTranscoder.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { CancelJobCommand, CancelJobCommandInput, CancelJobCommandOutput } from "./commands/CancelJobCommand"; @@ -62,577 +63,254 @@ import { UpdatePipelineStatusCommandInput, UpdatePipelineStatusCommandOutput, } from "./commands/UpdatePipelineStatusCommand"; -import { ElasticTranscoderClient } from "./ElasticTranscoderClient"; +import { ElasticTranscoderClient, ElasticTranscoderClientConfig } from "./ElasticTranscoderClient"; -/** - * @public - * AWS Elastic Transcoder Service - *

The AWS Elastic Transcoder Service.

- */ -export class ElasticTranscoder extends ElasticTranscoderClient { +const commands = { + CancelJobCommand, + CreateJobCommand, + CreatePipelineCommand, + CreatePresetCommand, + DeletePipelineCommand, + DeletePresetCommand, + ListJobsByPipelineCommand, + ListJobsByStatusCommand, + ListPipelinesCommand, + ListPresetsCommand, + ReadJobCommand, + ReadPipelineCommand, + ReadPresetCommand, + TestRoleCommand, + UpdatePipelineCommand, + UpdatePipelineNotificationsCommand, + UpdatePipelineStatusCommand, +}; + +export interface ElasticTranscoder { /** - * @public - *

The CancelJob operation cancels an unfinished job.

- * - *

You can only cancel a job that has a status of Submitted. To prevent a - * pipeline from starting to process a job while you're getting the job identifier, use - * UpdatePipelineStatus to temporarily pause the pipeline.

- *
+ * @see {@link CancelJobCommand} */ - public cancelJob(args: CancelJobCommandInput, options?: __HttpHandlerOptions): Promise; - public cancelJob(args: CancelJobCommandInput, cb: (err: any, data?: CancelJobCommandOutput) => void): void; - public cancelJob( + cancelJob(args: CancelJobCommandInput, options?: __HttpHandlerOptions): Promise; + cancelJob(args: CancelJobCommandInput, cb: (err: any, data?: CancelJobCommandOutput) => void): void; + cancelJob( args: CancelJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelJobCommandOutput) => void ): void; - public cancelJob( - args: CancelJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelJobCommandOutput) => void), - cb?: (err: any, data?: CancelJobCommandOutput) => void - ): Promise | void { - const command = new CancelJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified - * plus information about the job that is created.

- *

If you have specified more than one output for your jobs (for example, one output for the - * Kindle Fire and another output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to - * list the jobs (as opposed to the AWS Console).

+ * @see {@link CreateJobCommand} */ - public createJob(args: CreateJobCommandInput, options?: __HttpHandlerOptions): Promise; - public createJob(args: CreateJobCommandInput, cb: (err: any, data?: CreateJobCommandOutput) => void): void; - public createJob( + createJob(args: CreateJobCommandInput, options?: __HttpHandlerOptions): Promise; + createJob(args: CreateJobCommandInput, cb: (err: any, data?: CreateJobCommandOutput) => void): void; + createJob( args: CreateJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateJobCommandOutput) => void ): void; - public createJob( - args: CreateJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateJobCommandOutput) => void), - cb?: (err: any, data?: CreateJobCommandOutput) => void - ): Promise | void { - const command = new CreateJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The CreatePipeline operation creates a pipeline with settings that you specify.

+ * @see {@link CreatePipelineCommand} */ - public createPipeline( + createPipeline( args: CreatePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPipeline( - args: CreatePipelineCommandInput, - cb: (err: any, data?: CreatePipelineCommandOutput) => void - ): void; - public createPipeline( + createPipeline(args: CreatePipelineCommandInput, cb: (err: any, data?: CreatePipelineCommandOutput) => void): void; + createPipeline( args: CreatePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePipelineCommandOutput) => void ): void; - public createPipeline( - args: CreatePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePipelineCommandOutput) => void), - cb?: (err: any, data?: CreatePipelineCommandOutput) => void - ): Promise | void { - const command = new CreatePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The CreatePreset operation creates a preset with settings that you specify.

- * - *

Elastic Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder requirements - * and to determine whether they comply with H.264 standards. If your settings are not - * valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response (ValidationException) and - * does not create the preset. If the settings are valid for Elastic Transcoder but aren't strictly - * compliant with the H.264 standard, Elastic Transcoder creates the preset and returns a warning message - * in the response. This helps you determine whether your settings comply with the H.264 - * standard while giving you greater flexibility with respect to the video that Elastic Transcoder - * produces.

- *
- *

Elastic Transcoder uses the H.264 video-compression format. For more information, see the International - * Telecommunication Union publication Recommendation ITU-T H.264: Advanced video coding - * for generic audiovisual services.

+ * @see {@link CreatePresetCommand} */ - public createPreset( - args: CreatePresetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createPreset(args: CreatePresetCommandInput, cb: (err: any, data?: CreatePresetCommandOutput) => void): void; - public createPreset( + createPreset(args: CreatePresetCommandInput, options?: __HttpHandlerOptions): Promise; + createPreset(args: CreatePresetCommandInput, cb: (err: any, data?: CreatePresetCommandOutput) => void): void; + createPreset( args: CreatePresetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePresetCommandOutput) => void ): void; - public createPreset( - args: CreatePresetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePresetCommandOutput) => void), - cb?: (err: any, data?: CreatePresetCommandOutput) => void - ): Promise | void { - const command = new CreatePresetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The DeletePipeline operation removes a pipeline.

- *

You can only delete a pipeline that has never been used or that is not currently in use - * (doesn't contain any active jobs). If the pipeline is currently in use, - * DeletePipeline returns an error.

+ * @see {@link DeletePipelineCommand} */ - public deletePipeline( + deletePipeline( args: DeletePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePipeline( - args: DeletePipelineCommandInput, - cb: (err: any, data?: DeletePipelineCommandOutput) => void - ): void; - public deletePipeline( + deletePipeline(args: DeletePipelineCommandInput, cb: (err: any, data?: DeletePipelineCommandOutput) => void): void; + deletePipeline( args: DeletePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePipelineCommandOutput) => void ): void; - public deletePipeline( - args: DeletePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePipelineCommandOutput) => void), - cb?: (err: any, data?: DeletePipelineCommandOutput) => void - ): Promise | void { - const command = new DeletePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The DeletePreset operation removes a preset that you've added in an AWS region.

- * - *

You can't delete the default presets that are included with Elastic Transcoder.

- *
+ * @see {@link DeletePresetCommand} */ - public deletePreset( - args: DeletePresetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deletePreset(args: DeletePresetCommandInput, cb: (err: any, data?: DeletePresetCommandOutput) => void): void; - public deletePreset( + deletePreset(args: DeletePresetCommandInput, options?: __HttpHandlerOptions): Promise; + deletePreset(args: DeletePresetCommandInput, cb: (err: any, data?: DeletePresetCommandOutput) => void): void; + deletePreset( args: DeletePresetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePresetCommandOutput) => void ): void; - public deletePreset( - args: DeletePresetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePresetCommandOutput) => void), - cb?: (err: any, data?: DeletePresetCommandOutput) => void - ): Promise | void { - const command = new DeletePresetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline.

- *

Elastic Transcoder returns all of the jobs currently in the specified pipeline. The response body contains - * one element for each job that satisfies the search criteria.

+ * @see {@link ListJobsByPipelineCommand} */ - public listJobsByPipeline( + listJobsByPipeline( args: ListJobsByPipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public listJobsByPipeline( + listJobsByPipeline( args: ListJobsByPipelineCommandInput, cb: (err: any, data?: ListJobsByPipelineCommandOutput) => void ): void; - public listJobsByPipeline( + listJobsByPipeline( args: ListJobsByPipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobsByPipelineCommandOutput) => void ): void; - public listJobsByPipeline( - args: ListJobsByPipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJobsByPipelineCommandOutput) => void), - cb?: (err: any, data?: ListJobsByPipelineCommandOutput) => void - ): Promise | void { - const command = new ListJobsByPipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The ListJobsByStatus operation gets a list of jobs that have a specified status. The response - * body contains one element for each job that satisfies the search criteria.

+ * @see {@link ListJobsByStatusCommand} */ - public listJobsByStatus( + listJobsByStatus( args: ListJobsByStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public listJobsByStatus( + listJobsByStatus( args: ListJobsByStatusCommandInput, cb: (err: any, data?: ListJobsByStatusCommandOutput) => void ): void; - public listJobsByStatus( + listJobsByStatus( args: ListJobsByStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobsByStatusCommandOutput) => void ): void; - public listJobsByStatus( - args: ListJobsByStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJobsByStatusCommandOutput) => void), - cb?: (err: any, data?: ListJobsByStatusCommandOutput) => void - ): Promise | void { - const command = new ListJobsByStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The ListPipelines operation gets a list of the pipelines associated with the current AWS account.

+ * @see {@link ListPipelinesCommand} */ - public listPipelines( - args: ListPipelinesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listPipelines( - args: ListPipelinesCommandInput, - cb: (err: any, data?: ListPipelinesCommandOutput) => void - ): void; - public listPipelines( + listPipelines(args: ListPipelinesCommandInput, options?: __HttpHandlerOptions): Promise; + listPipelines(args: ListPipelinesCommandInput, cb: (err: any, data?: ListPipelinesCommandOutput) => void): void; + listPipelines( args: ListPipelinesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPipelinesCommandOutput) => void ): void; - public listPipelines( - args: ListPipelinesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPipelinesCommandOutput) => void), - cb?: (err: any, data?: ListPipelinesCommandOutput) => void - ): Promise | void { - const command = new ListPipelinesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that - * you've added in an AWS region.

+ * @see {@link ListPresetsCommand} */ - public listPresets(args: ListPresetsCommandInput, options?: __HttpHandlerOptions): Promise; - public listPresets(args: ListPresetsCommandInput, cb: (err: any, data?: ListPresetsCommandOutput) => void): void; - public listPresets( + listPresets(args: ListPresetsCommandInput, options?: __HttpHandlerOptions): Promise; + listPresets(args: ListPresetsCommandInput, cb: (err: any, data?: ListPresetsCommandOutput) => void): void; + listPresets( args: ListPresetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPresetsCommandOutput) => void ): void; - public listPresets( - args: ListPresetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPresetsCommandOutput) => void), - cb?: (err: any, data?: ListPresetsCommandOutput) => void - ): Promise | void { - const command = new ListPresetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The ReadJob operation returns detailed information about a job.

+ * @see {@link ReadJobCommand} */ - public readJob(args: ReadJobCommandInput, options?: __HttpHandlerOptions): Promise; - public readJob(args: ReadJobCommandInput, cb: (err: any, data?: ReadJobCommandOutput) => void): void; - public readJob( + readJob(args: ReadJobCommandInput, options?: __HttpHandlerOptions): Promise; + readJob(args: ReadJobCommandInput, cb: (err: any, data?: ReadJobCommandOutput) => void): void; + readJob( args: ReadJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReadJobCommandOutput) => void ): void; - public readJob( - args: ReadJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReadJobCommandOutput) => void), - cb?: (err: any, data?: ReadJobCommandOutput) => void - ): Promise | void { - const command = new ReadJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The ReadPipeline operation gets detailed information about a pipeline.

+ * @see {@link ReadPipelineCommand} */ - public readPipeline( - args: ReadPipelineCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public readPipeline(args: ReadPipelineCommandInput, cb: (err: any, data?: ReadPipelineCommandOutput) => void): void; - public readPipeline( + readPipeline(args: ReadPipelineCommandInput, options?: __HttpHandlerOptions): Promise; + readPipeline(args: ReadPipelineCommandInput, cb: (err: any, data?: ReadPipelineCommandOutput) => void): void; + readPipeline( args: ReadPipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReadPipelineCommandOutput) => void ): void; - public readPipeline( - args: ReadPipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReadPipelineCommandOutput) => void), - cb?: (err: any, data?: ReadPipelineCommandOutput) => void - ): Promise | void { - const command = new ReadPipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The ReadPreset operation gets detailed information about a preset.

+ * @see {@link ReadPresetCommand} */ - public readPreset(args: ReadPresetCommandInput, options?: __HttpHandlerOptions): Promise; - public readPreset(args: ReadPresetCommandInput, cb: (err: any, data?: ReadPresetCommandOutput) => void): void; - public readPreset( + readPreset(args: ReadPresetCommandInput, options?: __HttpHandlerOptions): Promise; + readPreset(args: ReadPresetCommandInput, cb: (err: any, data?: ReadPresetCommandOutput) => void): void; + readPreset( args: ReadPresetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReadPresetCommandOutput) => void ): void; - public readPreset( - args: ReadPresetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReadPresetCommandOutput) => void), - cb?: (err: any, data?: ReadPresetCommandOutput) => void - ): Promise | void { - const command = new ReadPresetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

The TestRole operation tests the IAM role used to create the pipeline.

- *

The TestRole action lets you determine whether the IAM role you are using - * has sufficient permissions to let Elastic Transcoder perform tasks associated with the transcoding - * process. The action attempts to assume the specified IAM role, checks read access to the - * input and output buckets, and tries to send a test notification to Amazon SNS topics - * that you specify.

+ * @see {@link TestRoleCommand} */ - public testRole(args: TestRoleCommandInput, options?: __HttpHandlerOptions): Promise; - public testRole(args: TestRoleCommandInput, cb: (err: any, data?: TestRoleCommandOutput) => void): void; - public testRole( + testRole(args: TestRoleCommandInput, options?: __HttpHandlerOptions): Promise; + testRole(args: TestRoleCommandInput, cb: (err: any, data?: TestRoleCommandOutput) => void): void; + testRole( args: TestRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestRoleCommandOutput) => void ): void; - public testRole( - args: TestRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestRoleCommandOutput) => void), - cb?: (err: any, data?: TestRoleCommandOutput) => void - ): Promise | void { - const command = new TestRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use the UpdatePipeline operation to update settings for a pipeline.

- * - *

When you change pipeline settings, your changes take effect immediately. - * Jobs that you have already submitted and that Elastic Transcoder has not started to process are - * affected in addition to jobs that you submit after you change settings.

- *
+ * @see {@link UpdatePipelineCommand} */ - public updatePipeline( + updatePipeline( args: UpdatePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePipeline( - args: UpdatePipelineCommandInput, - cb: (err: any, data?: UpdatePipelineCommandOutput) => void - ): void; - public updatePipeline( + updatePipeline(args: UpdatePipelineCommandInput, cb: (err: any, data?: UpdatePipelineCommandOutput) => void): void; + updatePipeline( args: UpdatePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePipelineCommandOutput) => void ): void; - public updatePipeline( - args: UpdatePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePipelineCommandOutput) => void), - cb?: (err: any, data?: UpdatePipelineCommandOutput) => void - ): Promise | void { - const command = new UpdatePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline.

- *

When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request.

+ * @see {@link UpdatePipelineNotificationsCommand} */ - public updatePipelineNotifications( + updatePipelineNotifications( args: UpdatePipelineNotificationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePipelineNotifications( + updatePipelineNotifications( args: UpdatePipelineNotificationsCommandInput, cb: (err: any, data?: UpdatePipelineNotificationsCommandOutput) => void ): void; - public updatePipelineNotifications( + updatePipelineNotifications( args: UpdatePipelineNotificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePipelineNotificationsCommandOutput) => void ): void; - public updatePipelineNotifications( - args: UpdatePipelineNotificationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePipelineNotificationsCommandOutput) => void), - cb?: (err: any, data?: UpdatePipelineNotificationsCommandOutput) => void - ): Promise | void { - const command = new UpdatePipelineNotificationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline - * stops or restarts the processing of jobs.

- *

Changing the pipeline status is useful if you want to cancel one or more jobs. You can't - * cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which - * you submitted the jobs, you have more time to get the job IDs for the jobs that you want - * to cancel, and to send a CancelJob request.

+ * @see {@link UpdatePipelineStatusCommand} */ - public updatePipelineStatus( + updatePipelineStatus( args: UpdatePipelineStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePipelineStatus( + updatePipelineStatus( args: UpdatePipelineStatusCommandInput, cb: (err: any, data?: UpdatePipelineStatusCommandOutput) => void ): void; - public updatePipelineStatus( + updatePipelineStatus( args: UpdatePipelineStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePipelineStatusCommandOutput) => void ): void; - public updatePipelineStatus( - args: UpdatePipelineStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePipelineStatusCommandOutput) => void), - cb?: (err: any, data?: UpdatePipelineStatusCommandOutput) => void - ): Promise | void { - const command = new UpdatePipelineStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * AWS Elastic Transcoder Service + *

The AWS Elastic Transcoder Service.

+ */ +export class ElasticTranscoder extends ElasticTranscoderClient implements ElasticTranscoder {} +createAggregatedClient(commands, ElasticTranscoder); diff --git a/clients/client-elasticache/src/ElastiCache.ts b/clients/client-elasticache/src/ElastiCache.ts index a25988182ae2..c3c96f54b998 100644 --- a/clients/client-elasticache/src/ElastiCache.ts +++ b/clients/client-elasticache/src/ElastiCache.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -314,2543 +315,1138 @@ import { TestFailoverCommandInput, TestFailoverCommandOutput, } from "./commands/TestFailoverCommand"; -import { ElastiCacheClient } from "./ElastiCacheClient"; +import { ElastiCacheClient, ElastiCacheClientConfig } from "./ElastiCacheClient"; -/** - * @public - * Amazon ElastiCache - *

Amazon ElastiCache is a web service that makes it easier to set up, operate, - * and scale a distributed cache in the cloud.

- *

With ElastiCache, customers get all of the benefits of a high-performance, - * in-memory cache with less of the administrative burden involved in launching and managing a distributed cache. - * The service makes setup, scaling, - * and cluster failure handling much simpler than in a self-managed cache deployment.

- *

In addition, through integration with Amazon CloudWatch, - * customers get enhanced visibility into the key performance statistics - * associated with their cache and can receive alarms if a part of their cache runs hot.

- */ -export class ElastiCache extends ElastiCacheClient { - /** - * @public - *

A tag is a key-value pair where the key and value are case-sensitive. - * You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. - * For more information, see Resource-level permissions.

- *

- * For example, you can use cost-allocation tags to your ElastiCache resources, - * Amazon generates a cost allocation report as a comma-separated value (CSV) file - * with your usage and costs aggregated by your tags. - * You can apply tags that represent business categories (such as cost centers, application names, or owners) - * to organize your costs across multiple services.

- *

For more information, - * see Using Cost Allocation Tags in Amazon ElastiCache - * in the ElastiCache User Guide.

- */ - public addTagsToResource( +const commands = { + AddTagsToResourceCommand, + AuthorizeCacheSecurityGroupIngressCommand, + BatchApplyUpdateActionCommand, + BatchStopUpdateActionCommand, + CompleteMigrationCommand, + CopySnapshotCommand, + CreateCacheClusterCommand, + CreateCacheParameterGroupCommand, + CreateCacheSecurityGroupCommand, + CreateCacheSubnetGroupCommand, + CreateGlobalReplicationGroupCommand, + CreateReplicationGroupCommand, + CreateSnapshotCommand, + CreateUserCommand, + CreateUserGroupCommand, + DecreaseNodeGroupsInGlobalReplicationGroupCommand, + DecreaseReplicaCountCommand, + DeleteCacheClusterCommand, + DeleteCacheParameterGroupCommand, + DeleteCacheSecurityGroupCommand, + DeleteCacheSubnetGroupCommand, + DeleteGlobalReplicationGroupCommand, + DeleteReplicationGroupCommand, + DeleteSnapshotCommand, + DeleteUserCommand, + DeleteUserGroupCommand, + DescribeCacheClustersCommand, + DescribeCacheEngineVersionsCommand, + DescribeCacheParameterGroupsCommand, + DescribeCacheParametersCommand, + DescribeCacheSecurityGroupsCommand, + DescribeCacheSubnetGroupsCommand, + DescribeEngineDefaultParametersCommand, + DescribeEventsCommand, + DescribeGlobalReplicationGroupsCommand, + DescribeReplicationGroupsCommand, + DescribeReservedCacheNodesCommand, + DescribeReservedCacheNodesOfferingsCommand, + DescribeServiceUpdatesCommand, + DescribeSnapshotsCommand, + DescribeUpdateActionsCommand, + DescribeUserGroupsCommand, + DescribeUsersCommand, + DisassociateGlobalReplicationGroupCommand, + FailoverGlobalReplicationGroupCommand, + IncreaseNodeGroupsInGlobalReplicationGroupCommand, + IncreaseReplicaCountCommand, + ListAllowedNodeTypeModificationsCommand, + ListTagsForResourceCommand, + ModifyCacheClusterCommand, + ModifyCacheParameterGroupCommand, + ModifyCacheSubnetGroupCommand, + ModifyGlobalReplicationGroupCommand, + ModifyReplicationGroupCommand, + ModifyReplicationGroupShardConfigurationCommand, + ModifyUserCommand, + ModifyUserGroupCommand, + PurchaseReservedCacheNodesOfferingCommand, + RebalanceSlotsInGlobalReplicationGroupCommand, + RebootCacheClusterCommand, + RemoveTagsFromResourceCommand, + ResetCacheParameterGroupCommand, + RevokeCacheSecurityGroupIngressCommand, + StartMigrationCommand, + TestFailoverCommand, +}; + +export interface ElastiCache { + /** + * @see {@link AddTagsToResourceCommand} + */ + addTagsToResource( args: AddTagsToResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public addTagsToResource( + addTagsToResource( args: AddTagsToResourceCommandInput, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void ): void; - public addTagsToResource( + addTagsToResource( args: AddTagsToResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void ): void; - public addTagsToResource( - args: AddTagsToResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddTagsToResourceCommandOutput) => void), - cb?: (err: any, data?: AddTagsToResourceCommandOutput) => void - ): Promise | void { - const command = new AddTagsToResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Allows network ingress to a cache - * security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 - * security groups are used as the authorization mechanism.

- * - *

You cannot authorize ingress from an Amazon EC2 security group in one region to an - * ElastiCache cluster in another region.

- *
- */ - public authorizeCacheSecurityGroupIngress( + + /** + * @see {@link AuthorizeCacheSecurityGroupIngressCommand} + */ + authorizeCacheSecurityGroupIngress( args: AuthorizeCacheSecurityGroupIngressCommandInput, options?: __HttpHandlerOptions ): Promise; - public authorizeCacheSecurityGroupIngress( + authorizeCacheSecurityGroupIngress( args: AuthorizeCacheSecurityGroupIngressCommandInput, cb: (err: any, data?: AuthorizeCacheSecurityGroupIngressCommandOutput) => void ): void; - public authorizeCacheSecurityGroupIngress( + authorizeCacheSecurityGroupIngress( args: AuthorizeCacheSecurityGroupIngressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AuthorizeCacheSecurityGroupIngressCommandOutput) => void ): void; - public authorizeCacheSecurityGroupIngress( - args: AuthorizeCacheSecurityGroupIngressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AuthorizeCacheSecurityGroupIngressCommandOutput) => void), - cb?: (err: any, data?: AuthorizeCacheSecurityGroupIngressCommandOutput) => void - ): Promise | void { - const command = new AuthorizeCacheSecurityGroupIngressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Apply the service update. For more information on service updates and applying them, see Applying Service Updates.

- */ - public batchApplyUpdateAction( + + /** + * @see {@link BatchApplyUpdateActionCommand} + */ + batchApplyUpdateAction( args: BatchApplyUpdateActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchApplyUpdateAction( + batchApplyUpdateAction( args: BatchApplyUpdateActionCommandInput, cb: (err: any, data?: BatchApplyUpdateActionCommandOutput) => void ): void; - public batchApplyUpdateAction( + batchApplyUpdateAction( args: BatchApplyUpdateActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchApplyUpdateActionCommandOutput) => void ): void; - public batchApplyUpdateAction( - args: BatchApplyUpdateActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchApplyUpdateActionCommandOutput) => void), - cb?: (err: any, data?: BatchApplyUpdateActionCommandOutput) => void - ): Promise | void { - const command = new BatchApplyUpdateActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.

- */ - public batchStopUpdateAction( + + /** + * @see {@link BatchStopUpdateActionCommand} + */ + batchStopUpdateAction( args: BatchStopUpdateActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchStopUpdateAction( + batchStopUpdateAction( args: BatchStopUpdateActionCommandInput, cb: (err: any, data?: BatchStopUpdateActionCommandOutput) => void ): void; - public batchStopUpdateAction( + batchStopUpdateAction( args: BatchStopUpdateActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchStopUpdateActionCommandOutput) => void ): void; - public batchStopUpdateAction( - args: BatchStopUpdateActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchStopUpdateActionCommandOutput) => void), - cb?: (err: any, data?: BatchStopUpdateActionCommandOutput) => void - ): Promise | void { - const command = new BatchStopUpdateActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Complete the migration of data.

- */ - public completeMigration( + + /** + * @see {@link CompleteMigrationCommand} + */ + completeMigration( args: CompleteMigrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public completeMigration( + completeMigration( args: CompleteMigrationCommandInput, cb: (err: any, data?: CompleteMigrationCommandOutput) => void ): void; - public completeMigration( + completeMigration( args: CompleteMigrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteMigrationCommandOutput) => void ): void; - public completeMigration( - args: CompleteMigrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CompleteMigrationCommandOutput) => void), - cb?: (err: any, data?: CompleteMigrationCommandOutput) => void - ): Promise | void { - const command = new CompleteMigrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Makes a copy of an existing snapshot.

- * - *

This operation is valid for Redis only.

- *
- * - *

Users or groups that have permissions to use the CopySnapshot operation - * can create their own Amazon S3 buckets and copy snapshots to it. - * To control access to your snapshots, use an IAM policy to control who has the ability to use - * the CopySnapshot operation. - * For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots - * and Authentication & Access Control.

- *
- *

You could receive the following error messages.

- *

- * Error Messages - *

- *
    - *
  • - *

    - * Error Message: - * The S3 bucket %s is outside of the region.

    - *

    - * Solution: - * Create an Amazon S3 bucket in the same region as your snapshot. - * For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

    - *
  • - *
  • - *

    - * Error Message: - * The S3 bucket %s does not exist.

    - *

    - * Solution: - * Create an Amazon S3 bucket in the same region as your snapshot. - * For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

    - *
  • - *
  • - *

    - * Error Message: - * The S3 bucket %s is not owned by the authenticated user.

    - *

    - * Solution: - * Create an Amazon S3 bucket in the same region as your snapshot. - * For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

    - *
  • - *
  • - *

    - * Error Message: - * The authenticated user does not have sufficient permissions to perform the desired activity.

    - *

    - * Solution: - * Contact your system administrator to get the needed permissions.

    - *
  • - *
  • - *

    - * Error Message: - * The S3 bucket %s already contains an object with key %s.

    - *

    - * Solution: - * Give the TargetSnapshotName a new and unique value. - * If exporting a snapshot, - * you could alternatively create a new Amazon S3 bucket - * and use this same value for TargetSnapshotName.

    - *
  • - *
  • - *

    - * Error Message: - * ElastiCache has not been granted READ permissions %s on the S3 Bucket.

    - *

    - * Solution: - * Add List and Read permissions on the bucket. - * For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

    - *
  • - *
  • - *

    - * Error Message: - * ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.

    - *

    - * Solution: - * Add Upload/Delete permissions on the bucket. - * For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

    - *
  • - *
  • - *

    - * Error Message: - * ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.

    - *

    - * Solution: - * Add View Permissions on the bucket. - * For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

    - *
  • - *
- */ - public copySnapshot( - args: CopySnapshotCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public copySnapshot(args: CopySnapshotCommandInput, cb: (err: any, data?: CopySnapshotCommandOutput) => void): void; - public copySnapshot( + + /** + * @see {@link CopySnapshotCommand} + */ + copySnapshot(args: CopySnapshotCommandInput, options?: __HttpHandlerOptions): Promise; + copySnapshot(args: CopySnapshotCommandInput, cb: (err: any, data?: CopySnapshotCommandOutput) => void): void; + copySnapshot( args: CopySnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopySnapshotCommandOutput) => void ): void; - public copySnapshot( - args: CopySnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopySnapshotCommandOutput) => void), - cb?: (err: any, data?: CopySnapshotCommandOutput) => void - ): Promise | void { - const command = new CopySnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a cluster. All nodes in the - * cluster run the same protocol-compliant cache engine software, either Memcached - * or Redis.

- *

This operation is not supported for Redis (cluster mode enabled) clusters.

- */ - public createCacheCluster( + + /** + * @see {@link CreateCacheClusterCommand} + */ + createCacheCluster( args: CreateCacheClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCacheCluster( + createCacheCluster( args: CreateCacheClusterCommandInput, cb: (err: any, data?: CreateCacheClusterCommandOutput) => void ): void; - public createCacheCluster( + createCacheCluster( args: CreateCacheClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCacheClusterCommandOutput) => void ): void; - public createCacheCluster( - args: CreateCacheClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCacheClusterCommandOutput) => void), - cb?: (err: any, data?: CreateCacheClusterCommandOutput) => void - ): Promise | void { - const command = new CreateCacheClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new Amazon ElastiCache cache parameter group. An ElastiCache - * cache parameter group is a collection of parameters and their values that are applied to all of the nodes - * in any cluster or replication group using the CacheParameterGroup.

- *

A newly created CacheParameterGroup is an exact duplicate of the default parameter group - * for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can - * change the values of specific parameters. For more information, see:

- * - */ - public createCacheParameterGroup( + + /** + * @see {@link CreateCacheParameterGroupCommand} + */ + createCacheParameterGroup( args: CreateCacheParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCacheParameterGroup( + createCacheParameterGroup( args: CreateCacheParameterGroupCommandInput, cb: (err: any, data?: CreateCacheParameterGroupCommandOutput) => void ): void; - public createCacheParameterGroup( + createCacheParameterGroup( args: CreateCacheParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCacheParameterGroupCommandOutput) => void ): void; - public createCacheParameterGroup( - args: CreateCacheParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCacheParameterGroupCommandOutput) => void), - cb?: (err: any, data?: CreateCacheParameterGroupCommandOutput) => void - ): Promise | void { - const command = new CreateCacheParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new cache security group. Use a - * cache security group to control access to one or more clusters.

- *

Cache security groups are only used when you are creating a cluster outside of an Amazon - * Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache - * subnet group instead. For more information, - * see CreateCacheSubnetGroup.

- */ - public createCacheSecurityGroup( + + /** + * @see {@link CreateCacheSecurityGroupCommand} + */ + createCacheSecurityGroup( args: CreateCacheSecurityGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCacheSecurityGroup( + createCacheSecurityGroup( args: CreateCacheSecurityGroupCommandInput, cb: (err: any, data?: CreateCacheSecurityGroupCommandOutput) => void ): void; - public createCacheSecurityGroup( + createCacheSecurityGroup( args: CreateCacheSecurityGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCacheSecurityGroupCommandOutput) => void ): void; - public createCacheSecurityGroup( - args: CreateCacheSecurityGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCacheSecurityGroupCommandOutput) => void), - cb?: (err: any, data?: CreateCacheSecurityGroupCommandOutput) => void - ): Promise | void { - const command = new CreateCacheSecurityGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new cache subnet group.

- *

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

- */ - public createCacheSubnetGroup( + + /** + * @see {@link CreateCacheSubnetGroupCommand} + */ + createCacheSubnetGroup( args: CreateCacheSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCacheSubnetGroup( + createCacheSubnetGroup( args: CreateCacheSubnetGroupCommandInput, cb: (err: any, data?: CreateCacheSubnetGroupCommandOutput) => void ): void; - public createCacheSubnetGroup( + createCacheSubnetGroup( args: CreateCacheSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCacheSubnetGroupCommandOutput) => void ): void; - public createCacheSubnetGroup( - args: CreateCacheSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCacheSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: CreateCacheSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new CreateCacheSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Global Datastore for Redis offers fully managed, fast, - * reliable and secure cross-region replication. - * Using Global Datastore for Redis, you can create cross-region - * read replica clusters for ElastiCache for Redis to enable low-latency reads - * and disaster recovery across regions. For more information, - * - * see Replication Across Regions Using Global Datastore.

- *
    - *
  • - *

    The GlobalReplicationGroupIdSuffix is the name of the Global datastore.

    - *
  • - *
  • - *

    The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.

    - *
  • - *
- */ - public createGlobalReplicationGroup( + + /** + * @see {@link CreateGlobalReplicationGroupCommand} + */ + createGlobalReplicationGroup( args: CreateGlobalReplicationGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createGlobalReplicationGroup( + createGlobalReplicationGroup( args: CreateGlobalReplicationGroupCommandInput, cb: (err: any, data?: CreateGlobalReplicationGroupCommandOutput) => void ): void; - public createGlobalReplicationGroup( + createGlobalReplicationGroup( args: CreateGlobalReplicationGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGlobalReplicationGroupCommandOutput) => void ): void; - public createGlobalReplicationGroup( - args: CreateGlobalReplicationGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGlobalReplicationGroupCommandOutput) => void), - cb?: (err: any, data?: CreateGlobalReplicationGroupCommandOutput) => void - ): Promise | void { - const command = new CreateGlobalReplicationGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.

- *

This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.

- *

A Redis (cluster mode disabled) replication group is a collection of clusters, - * where one of the clusters is a read/write primary and the others are read-only replicas. - * Writes to the primary are asynchronously propagated to the replicas.

- *

A Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). - * Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed. - * - *

- *

The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between - * 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. - * Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see - * Creating a Subnet Group. For versions below 5.0.6, - * the limit is 250 per cluster.

- *

To request a limit increase, see - * Amazon Service Limits - * and choose the limit type Nodes per cluster per instance type.

- *

When a Redis (cluster mode disabled) replication group has been successfully created, - * you can add one or more read replicas to it, up to a total of 5 read replicas. - * If you need to increase or decrease the number of node groups (console: shards), - * you can avail yourself of ElastiCache for Redis' scaling. For more information, - * see Scaling ElastiCache for Redis Clusters in the ElastiCache User Guide.

- * - *

This operation is valid for Redis only.

- *
- */ - public createReplicationGroup( + + /** + * @see {@link CreateReplicationGroupCommand} + */ + createReplicationGroup( args: CreateReplicationGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createReplicationGroup( + createReplicationGroup( args: CreateReplicationGroupCommandInput, cb: (err: any, data?: CreateReplicationGroupCommandOutput) => void ): void; - public createReplicationGroup( + createReplicationGroup( args: CreateReplicationGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReplicationGroupCommandOutput) => void ): void; - public createReplicationGroup( - args: CreateReplicationGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateReplicationGroupCommandOutput) => void), - cb?: (err: any, data?: CreateReplicationGroupCommandOutput) => void - ): Promise | void { - const command = new CreateReplicationGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a copy of an entire cluster or replication group at a - * specific moment in time.

- * - *

This operation is valid for Redis only.

- *
- */ - public createSnapshot( + + /** + * @see {@link CreateSnapshotCommand} + */ + createSnapshot( args: CreateSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSnapshot( - args: CreateSnapshotCommandInput, - cb: (err: any, data?: CreateSnapshotCommandOutput) => void - ): void; - public createSnapshot( + createSnapshot(args: CreateSnapshotCommandInput, cb: (err: any, data?: CreateSnapshotCommandOutput) => void): void; + createSnapshot( args: CreateSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSnapshotCommandOutput) => void ): void; - public createSnapshot( - args: CreateSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSnapshotCommandOutput) => void), - cb?: (err: any, data?: CreateSnapshotCommandOutput) => void - ): Promise | void { - const command = new CreateSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC).

- */ - public createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; - public createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; - public createUser( + + /** + * @see {@link CreateUserCommand} + */ + createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; + createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; + createUser( args: CreateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserCommandOutput) => void ): void; - public createUser( - args: CreateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserCommandOutput) => void), - cb?: (err: any, data?: CreateUserCommandOutput) => void - ): Promise | void { - const command = new CreateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC) - *

- */ - public createUserGroup( + + /** + * @see {@link CreateUserGroupCommand} + */ + createUserGroup( args: CreateUserGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createUserGroup( - args: CreateUserGroupCommandInput, - cb: (err: any, data?: CreateUserGroupCommandOutput) => void - ): void; - public createUserGroup( + createUserGroup(args: CreateUserGroupCommandInput, cb: (err: any, data?: CreateUserGroupCommandOutput) => void): void; + createUserGroup( args: CreateUserGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserGroupCommandOutput) => void ): void; - public createUserGroup( - args: CreateUserGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserGroupCommandOutput) => void), - cb?: (err: any, data?: CreateUserGroupCommandOutput) => void - ): Promise | void { - const command = new CreateUserGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Decreases the number of node groups in a Global datastore

- */ - public decreaseNodeGroupsInGlobalReplicationGroup( + + /** + * @see {@link DecreaseNodeGroupsInGlobalReplicationGroupCommand} + */ + decreaseNodeGroupsInGlobalReplicationGroup( args: DecreaseNodeGroupsInGlobalReplicationGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public decreaseNodeGroupsInGlobalReplicationGroup( + decreaseNodeGroupsInGlobalReplicationGroup( args: DecreaseNodeGroupsInGlobalReplicationGroupCommandInput, cb: (err: any, data?: DecreaseNodeGroupsInGlobalReplicationGroupCommandOutput) => void ): void; - public decreaseNodeGroupsInGlobalReplicationGroup( + decreaseNodeGroupsInGlobalReplicationGroup( args: DecreaseNodeGroupsInGlobalReplicationGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DecreaseNodeGroupsInGlobalReplicationGroupCommandOutput) => void ): void; - public decreaseNodeGroupsInGlobalReplicationGroup( - args: DecreaseNodeGroupsInGlobalReplicationGroupCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DecreaseNodeGroupsInGlobalReplicationGroupCommandOutput) => void), - cb?: (err: any, data?: DecreaseNodeGroupsInGlobalReplicationGroupCommandOutput) => void - ): Promise | void { - const command = new DecreaseNodeGroupsInGlobalReplicationGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number of - * replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation - * is performed with no cluster down time.

- */ - public decreaseReplicaCount( + + /** + * @see {@link DecreaseReplicaCountCommand} + */ + decreaseReplicaCount( args: DecreaseReplicaCountCommandInput, options?: __HttpHandlerOptions ): Promise; - public decreaseReplicaCount( + decreaseReplicaCount( args: DecreaseReplicaCountCommandInput, cb: (err: any, data?: DecreaseReplicaCountCommandOutput) => void ): void; - public decreaseReplicaCount( + decreaseReplicaCount( args: DecreaseReplicaCountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DecreaseReplicaCountCommandOutput) => void ): void; - public decreaseReplicaCount( - args: DecreaseReplicaCountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DecreaseReplicaCountCommandOutput) => void), - cb?: (err: any, data?: DecreaseReplicaCountCommandOutput) => void - ): Promise | void { - const command = new DecreaseReplicaCountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a previously provisioned cluster. - * DeleteCacheCluster deletes all associated cache nodes, node endpoints and the - * cluster itself. When you receive a successful response from this operation, - * Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert - * this operation.

- *

This operation is not valid for:

- *
    - *
  • - *

    Redis (cluster mode enabled) clusters

    - *
  • - *
  • - *

    Redis (cluster mode disabled) clusters

    - *
  • - *
  • - *

    A cluster that is the last read replica of a replication group

    - *
  • - *
  • - *

    A cluster that is the primary node of a replication group

    - *
  • - *
  • - *

    A node group (shard) that has Multi-AZ mode enabled

    - *
  • - *
  • - *

    A cluster from a Redis (cluster mode enabled) replication group

    - *
  • - *
  • - *

    A cluster that is not in the available state

    - *
  • - *
- */ - public deleteCacheCluster( + + /** + * @see {@link DeleteCacheClusterCommand} + */ + deleteCacheCluster( args: DeleteCacheClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCacheCluster( + deleteCacheCluster( args: DeleteCacheClusterCommandInput, cb: (err: any, data?: DeleteCacheClusterCommandOutput) => void ): void; - public deleteCacheCluster( + deleteCacheCluster( args: DeleteCacheClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCacheClusterCommandOutput) => void ): void; - public deleteCacheCluster( - args: DeleteCacheClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCacheClusterCommandOutput) => void), - cb?: (err: any, data?: DeleteCacheClusterCommandOutput) => void - ): Promise | void { - const command = new DeleteCacheClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified cache parameter - * group. You cannot delete a cache parameter group if it is associated with any cache - * clusters. You cannot delete the default cache parameter groups in your account.

- */ - public deleteCacheParameterGroup( + + /** + * @see {@link DeleteCacheParameterGroupCommand} + */ + deleteCacheParameterGroup( args: DeleteCacheParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCacheParameterGroup( + deleteCacheParameterGroup( args: DeleteCacheParameterGroupCommandInput, cb: (err: any, data?: DeleteCacheParameterGroupCommandOutput) => void ): void; - public deleteCacheParameterGroup( + deleteCacheParameterGroup( args: DeleteCacheParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCacheParameterGroupCommandOutput) => void ): void; - public deleteCacheParameterGroup( - args: DeleteCacheParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCacheParameterGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteCacheParameterGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteCacheParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a cache security group.

- * - *

You cannot delete a cache security group if it is associated with any clusters.

- *
- */ - public deleteCacheSecurityGroup( + + /** + * @see {@link DeleteCacheSecurityGroupCommand} + */ + deleteCacheSecurityGroup( args: DeleteCacheSecurityGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCacheSecurityGroup( + deleteCacheSecurityGroup( args: DeleteCacheSecurityGroupCommandInput, cb: (err: any, data?: DeleteCacheSecurityGroupCommandOutput) => void ): void; - public deleteCacheSecurityGroup( + deleteCacheSecurityGroup( args: DeleteCacheSecurityGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCacheSecurityGroupCommandOutput) => void ): void; - public deleteCacheSecurityGroup( - args: DeleteCacheSecurityGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCacheSecurityGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteCacheSecurityGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteCacheSecurityGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a cache subnet group.

- * - *

You cannot delete a default cache subnet group or one that is associated with any clusters.

- *
- */ - public deleteCacheSubnetGroup( + + /** + * @see {@link DeleteCacheSubnetGroupCommand} + */ + deleteCacheSubnetGroup( args: DeleteCacheSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCacheSubnetGroup( + deleteCacheSubnetGroup( args: DeleteCacheSubnetGroupCommandInput, cb: (err: any, data?: DeleteCacheSubnetGroupCommandOutput) => void ): void; - public deleteCacheSubnetGroup( + deleteCacheSubnetGroup( args: DeleteCacheSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCacheSubnetGroupCommandOutput) => void ): void; - public deleteCacheSubnetGroup( - args: DeleteCacheSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCacheSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteCacheSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteCacheSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deleting a Global datastore is a two-step process:

- *
    - *
  • - *

    First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore.

    - *
  • - *
  • - *

    Once the Global datastore contains only the primary cluster, you can use the DeleteGlobalReplicationGroup API to delete the Global datastore while retainining the primary cluster using RetainPrimaryReplicationGroup=true.

    - *
  • - *
- *

Since the Global Datastore has only a primary cluster, you can delete the Global Datastore - * while retaining the primary by setting RetainPrimaryReplicationGroup=true. The primary cluster is never deleted when deleting a - * Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore.

- *

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; - * you cannot cancel or revert this operation.

- */ - public deleteGlobalReplicationGroup( + + /** + * @see {@link DeleteGlobalReplicationGroupCommand} + */ + deleteGlobalReplicationGroup( args: DeleteGlobalReplicationGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteGlobalReplicationGroup( + deleteGlobalReplicationGroup( args: DeleteGlobalReplicationGroupCommandInput, cb: (err: any, data?: DeleteGlobalReplicationGroupCommandOutput) => void ): void; - public deleteGlobalReplicationGroup( + deleteGlobalReplicationGroup( args: DeleteGlobalReplicationGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGlobalReplicationGroupCommandOutput) => void ): void; - public deleteGlobalReplicationGroup( - args: DeleteGlobalReplicationGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGlobalReplicationGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteGlobalReplicationGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteGlobalReplicationGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an existing replication group. - * By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. - * If the replication group has only one primary, - * you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true.

- *

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; - * you cannot cancel or revert this operation.

- * - *

This operation is valid for Redis only.

- *
- */ - public deleteReplicationGroup( + + /** + * @see {@link DeleteReplicationGroupCommand} + */ + deleteReplicationGroup( args: DeleteReplicationGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteReplicationGroup( + deleteReplicationGroup( args: DeleteReplicationGroupCommandInput, cb: (err: any, data?: DeleteReplicationGroupCommandOutput) => void ): void; - public deleteReplicationGroup( + deleteReplicationGroup( args: DeleteReplicationGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReplicationGroupCommandOutput) => void ): void; - public deleteReplicationGroup( - args: DeleteReplicationGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteReplicationGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteReplicationGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteReplicationGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an existing snapshot. When you receive a - * successful response from this operation, ElastiCache immediately begins deleting the snapshot; - * you cannot cancel or revert this operation.

- * - *

This operation is valid for Redis only.

- *
- */ - public deleteSnapshot( + + /** + * @see {@link DeleteSnapshotCommand} + */ + deleteSnapshot( args: DeleteSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSnapshot( - args: DeleteSnapshotCommandInput, - cb: (err: any, data?: DeleteSnapshotCommandOutput) => void - ): void; - public deleteSnapshot( + deleteSnapshot(args: DeleteSnapshotCommandInput, cb: (err: any, data?: DeleteSnapshotCommandOutput) => void): void; + deleteSnapshot( args: DeleteSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSnapshotCommandOutput) => void ): void; - public deleteSnapshot( - args: DeleteSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSnapshotCommandOutput) => void), - cb?: (err: any, data?: DeleteSnapshotCommandOutput) => void - ): Promise | void { - const command = new DeleteSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

For Redis engine version 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC).

- */ - public deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; - public deleteUser( + + /** + * @see {@link DeleteUserCommand} + */ + deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; + deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; + deleteUser( args: DeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserCommandOutput) => void ): void; - public deleteUser( - args: DeleteUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserCommandOutput) => void), - cb?: (err: any, data?: DeleteUserCommandOutput) => void - ): Promise | void { - const command = new DeleteUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

For Redis engine version 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC).

- */ - public deleteUserGroup( + + /** + * @see {@link DeleteUserGroupCommand} + */ + deleteUserGroup( args: DeleteUserGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteUserGroup( - args: DeleteUserGroupCommandInput, - cb: (err: any, data?: DeleteUserGroupCommandOutput) => void - ): void; - public deleteUserGroup( + deleteUserGroup(args: DeleteUserGroupCommandInput, cb: (err: any, data?: DeleteUserGroupCommandOutput) => void): void; + deleteUserGroup( args: DeleteUserGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserGroupCommandOutput) => void ): void; - public deleteUserGroup( - args: DeleteUserGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteUserGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteUserGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about all provisioned - * clusters if no cluster identifier is specified, or about a specific cache - * cluster if a cluster identifier is supplied.

- *

By default, abbreviated information about the clusters is returned. You can - * use the optional ShowCacheNodeInfo flag to retrieve detailed information about the - * cache nodes associated with the clusters. These details include the DNS address - * and port for the cache node endpoint.

- *

If the cluster is in the creating state, only cluster-level information is displayed - * until all of the nodes are successfully provisioned.

- *

If the cluster is in the deleting state, only cluster-level information is displayed.

- *

If cache nodes are currently being added to the cluster, node endpoint information - * and creation time for the additional nodes are not displayed until they are - * completely provisioned. When the cluster state is available, the cluster is - * ready for use.

- *

If cache nodes are currently being removed from the cluster, no endpoint information - * for the removed nodes is displayed.

- */ - public describeCacheClusters( + + /** + * @see {@link DescribeCacheClustersCommand} + */ + describeCacheClusters( args: DescribeCacheClustersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCacheClusters( + describeCacheClusters( args: DescribeCacheClustersCommandInput, cb: (err: any, data?: DescribeCacheClustersCommandOutput) => void ): void; - public describeCacheClusters( + describeCacheClusters( args: DescribeCacheClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCacheClustersCommandOutput) => void ): void; - public describeCacheClusters( - args: DescribeCacheClustersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCacheClustersCommandOutput) => void), - cb?: (err: any, data?: DescribeCacheClustersCommandOutput) => void - ): Promise | void { - const command = new DescribeCacheClustersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of the available cache - * engines and their versions.

- */ - public describeCacheEngineVersions( + + /** + * @see {@link DescribeCacheEngineVersionsCommand} + */ + describeCacheEngineVersions( args: DescribeCacheEngineVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCacheEngineVersions( + describeCacheEngineVersions( args: DescribeCacheEngineVersionsCommandInput, cb: (err: any, data?: DescribeCacheEngineVersionsCommandOutput) => void ): void; - public describeCacheEngineVersions( + describeCacheEngineVersions( args: DescribeCacheEngineVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCacheEngineVersionsCommandOutput) => void ): void; - public describeCacheEngineVersions( - args: DescribeCacheEngineVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCacheEngineVersionsCommandOutput) => void), - cb?: (err: any, data?: DescribeCacheEngineVersionsCommandOutput) => void - ): Promise | void { - const command = new DescribeCacheEngineVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of cache parameter group - * descriptions. If a cache parameter group name is specified, the list contains only - * the descriptions for that group.

- */ - public describeCacheParameterGroups( + + /** + * @see {@link DescribeCacheParameterGroupsCommand} + */ + describeCacheParameterGroups( args: DescribeCacheParameterGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCacheParameterGroups( + describeCacheParameterGroups( args: DescribeCacheParameterGroupsCommandInput, cb: (err: any, data?: DescribeCacheParameterGroupsCommandOutput) => void ): void; - public describeCacheParameterGroups( + describeCacheParameterGroups( args: DescribeCacheParameterGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCacheParameterGroupsCommandOutput) => void ): void; - public describeCacheParameterGroups( - args: DescribeCacheParameterGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCacheParameterGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeCacheParameterGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeCacheParameterGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the detailed parameter list for a - * particular cache parameter group.

- */ - public describeCacheParameters( + + /** + * @see {@link DescribeCacheParametersCommand} + */ + describeCacheParameters( args: DescribeCacheParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCacheParameters( + describeCacheParameters( args: DescribeCacheParametersCommandInput, cb: (err: any, data?: DescribeCacheParametersCommandOutput) => void ): void; - public describeCacheParameters( + describeCacheParameters( args: DescribeCacheParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCacheParametersCommandOutput) => void ): void; - public describeCacheParameters( - args: DescribeCacheParametersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCacheParametersCommandOutput) => void), - cb?: (err: any, data?: DescribeCacheParametersCommandOutput) => void - ): Promise | void { - const command = new DescribeCacheParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of cache security group - * descriptions. If a cache security group name is specified, the list contains only - * the description of that group. This applicable only when you have ElastiCache in Classic setup - *

- */ - public describeCacheSecurityGroups( + + /** + * @see {@link DescribeCacheSecurityGroupsCommand} + */ + describeCacheSecurityGroups( args: DescribeCacheSecurityGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCacheSecurityGroups( + describeCacheSecurityGroups( args: DescribeCacheSecurityGroupsCommandInput, cb: (err: any, data?: DescribeCacheSecurityGroupsCommandOutput) => void ): void; - public describeCacheSecurityGroups( + describeCacheSecurityGroups( args: DescribeCacheSecurityGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCacheSecurityGroupsCommandOutput) => void ): void; - public describeCacheSecurityGroups( - args: DescribeCacheSecurityGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCacheSecurityGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeCacheSecurityGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeCacheSecurityGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of cache subnet group - * descriptions. If a subnet group name is specified, the list contains only the - * description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default. - *

- */ - public describeCacheSubnetGroups( + + /** + * @see {@link DescribeCacheSubnetGroupsCommand} + */ + describeCacheSubnetGroups( args: DescribeCacheSubnetGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCacheSubnetGroups( + describeCacheSubnetGroups( args: DescribeCacheSubnetGroupsCommandInput, cb: (err: any, data?: DescribeCacheSubnetGroupsCommandOutput) => void ): void; - public describeCacheSubnetGroups( + describeCacheSubnetGroups( args: DescribeCacheSubnetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCacheSubnetGroupsCommandOutput) => void ): void; - public describeCacheSubnetGroups( - args: DescribeCacheSubnetGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCacheSubnetGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeCacheSubnetGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeCacheSubnetGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the default engine and - * system parameter information for the specified cache engine.

- */ - public describeEngineDefaultParameters( + + /** + * @see {@link DescribeEngineDefaultParametersCommand} + */ + describeEngineDefaultParameters( args: DescribeEngineDefaultParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEngineDefaultParameters( + describeEngineDefaultParameters( args: DescribeEngineDefaultParametersCommandInput, cb: (err: any, data?: DescribeEngineDefaultParametersCommandOutput) => void ): void; - public describeEngineDefaultParameters( + describeEngineDefaultParameters( args: DescribeEngineDefaultParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEngineDefaultParametersCommandOutput) => void ): void; - public describeEngineDefaultParameters( - args: DescribeEngineDefaultParametersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEngineDefaultParametersCommandOutput) => void), - cb?: (err: any, data?: DescribeEngineDefaultParametersCommandOutput) => void - ): Promise | void { - const command = new DescribeEngineDefaultParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns events related to clusters, cache - * security groups, and cache parameter groups. You can obtain events specific to a - * particular cluster, cache security group, or cache parameter group by providing - * the name as a parameter.

- *

By default, only the events occurring within the last hour are returned; - * however, you can retrieve up to 14 days' worth of events if necessary.

- */ - public describeEvents( + + /** + * @see {@link DescribeEventsCommand} + */ + describeEvents( args: DescribeEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEvents( - args: DescribeEventsCommandInput, - cb: (err: any, data?: DescribeEventsCommandOutput) => void - ): void; - public describeEvents( + describeEvents(args: DescribeEventsCommandInput, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void; + describeEvents( args: DescribeEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsCommandOutput) => void ): void; - public describeEvents( - args: DescribeEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventsCommandOutput) => void), - cb?: (err: any, data?: DescribeEventsCommandOutput) => void - ): Promise | void { - const command = new DescribeEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.

- */ - public describeGlobalReplicationGroups( + + /** + * @see {@link DescribeGlobalReplicationGroupsCommand} + */ + describeGlobalReplicationGroups( args: DescribeGlobalReplicationGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGlobalReplicationGroups( + describeGlobalReplicationGroups( args: DescribeGlobalReplicationGroupsCommandInput, cb: (err: any, data?: DescribeGlobalReplicationGroupsCommandOutput) => void ): void; - public describeGlobalReplicationGroups( + describeGlobalReplicationGroups( args: DescribeGlobalReplicationGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGlobalReplicationGroupsCommandOutput) => void ): void; - public describeGlobalReplicationGroups( - args: DescribeGlobalReplicationGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGlobalReplicationGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeGlobalReplicationGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeGlobalReplicationGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a particular - * replication group. If no identifier is specified, DescribeReplicationGroups - * returns information about all replication groups.

- * - *

This operation is valid for Redis only.

- *
- */ - public describeReplicationGroups( + + /** + * @see {@link DescribeReplicationGroupsCommand} + */ + describeReplicationGroups( args: DescribeReplicationGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReplicationGroups( + describeReplicationGroups( args: DescribeReplicationGroupsCommandInput, cb: (err: any, data?: DescribeReplicationGroupsCommandOutput) => void ): void; - public describeReplicationGroups( + describeReplicationGroups( args: DescribeReplicationGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReplicationGroupsCommandOutput) => void ): void; - public describeReplicationGroups( - args: DescribeReplicationGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReplicationGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeReplicationGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeReplicationGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about reserved cache - * nodes for this account, or about a specified reserved cache node.

- */ - public describeReservedCacheNodes( + + /** + * @see {@link DescribeReservedCacheNodesCommand} + */ + describeReservedCacheNodes( args: DescribeReservedCacheNodesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReservedCacheNodes( + describeReservedCacheNodes( args: DescribeReservedCacheNodesCommandInput, cb: (err: any, data?: DescribeReservedCacheNodesCommandOutput) => void ): void; - public describeReservedCacheNodes( + describeReservedCacheNodes( args: DescribeReservedCacheNodesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReservedCacheNodesCommandOutput) => void ): void; - public describeReservedCacheNodes( - args: DescribeReservedCacheNodesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReservedCacheNodesCommandOutput) => void), - cb?: (err: any, data?: DescribeReservedCacheNodesCommandOutput) => void - ): Promise | void { - const command = new DescribeReservedCacheNodesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists available reserved cache - * node offerings.

- */ - public describeReservedCacheNodesOfferings( + + /** + * @see {@link DescribeReservedCacheNodesOfferingsCommand} + */ + describeReservedCacheNodesOfferings( args: DescribeReservedCacheNodesOfferingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReservedCacheNodesOfferings( + describeReservedCacheNodesOfferings( args: DescribeReservedCacheNodesOfferingsCommandInput, cb: (err: any, data?: DescribeReservedCacheNodesOfferingsCommandOutput) => void ): void; - public describeReservedCacheNodesOfferings( + describeReservedCacheNodesOfferings( args: DescribeReservedCacheNodesOfferingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReservedCacheNodesOfferingsCommandOutput) => void ): void; - public describeReservedCacheNodesOfferings( - args: DescribeReservedCacheNodesOfferingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReservedCacheNodesOfferingsCommandOutput) => void), - cb?: (err: any, data?: DescribeReservedCacheNodesOfferingsCommandOutput) => void - ): Promise | void { - const command = new DescribeReservedCacheNodesOfferingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns details of the service updates

- */ - public describeServiceUpdates( + + /** + * @see {@link DescribeServiceUpdatesCommand} + */ + describeServiceUpdates( args: DescribeServiceUpdatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeServiceUpdates( + describeServiceUpdates( args: DescribeServiceUpdatesCommandInput, cb: (err: any, data?: DescribeServiceUpdatesCommandOutput) => void ): void; - public describeServiceUpdates( + describeServiceUpdates( args: DescribeServiceUpdatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeServiceUpdatesCommandOutput) => void ): void; - public describeServiceUpdates( - args: DescribeServiceUpdatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeServiceUpdatesCommandOutput) => void), - cb?: (err: any, data?: DescribeServiceUpdatesCommandOutput) => void - ): Promise | void { - const command = new DescribeServiceUpdatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about cluster or replication group snapshots. - * By default, DescribeSnapshots lists all of your snapshots; it can optionally - * describe a single snapshot, or just the snapshots associated with a particular cache - * cluster.

- * - *

This operation is valid for Redis only.

- *
- */ - public describeSnapshots( + + /** + * @see {@link DescribeSnapshotsCommand} + */ + describeSnapshots( args: DescribeSnapshotsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSnapshots( + describeSnapshots( args: DescribeSnapshotsCommandInput, cb: (err: any, data?: DescribeSnapshotsCommandOutput) => void ): void; - public describeSnapshots( + describeSnapshots( args: DescribeSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSnapshotsCommandOutput) => void ): void; - public describeSnapshots( - args: DescribeSnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSnapshotsCommandOutput) => void), - cb?: (err: any, data?: DescribeSnapshotsCommandOutput) => void - ): Promise | void { - const command = new DescribeSnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns details of the update actions

- */ - public describeUpdateActions( + + /** + * @see {@link DescribeUpdateActionsCommand} + */ + describeUpdateActions( args: DescribeUpdateActionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeUpdateActions( + describeUpdateActions( args: DescribeUpdateActionsCommandInput, cb: (err: any, data?: DescribeUpdateActionsCommandOutput) => void ): void; - public describeUpdateActions( + describeUpdateActions( args: DescribeUpdateActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUpdateActionsCommandOutput) => void ): void; - public describeUpdateActions( - args: DescribeUpdateActionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUpdateActionsCommandOutput) => void), - cb?: (err: any, data?: DescribeUpdateActionsCommandOutput) => void - ): Promise | void { - const command = new DescribeUpdateActionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of user groups.

- */ - public describeUserGroups( + + /** + * @see {@link DescribeUserGroupsCommand} + */ + describeUserGroups( args: DescribeUserGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeUserGroups( + describeUserGroups( args: DescribeUserGroupsCommandInput, cb: (err: any, data?: DescribeUserGroupsCommandOutput) => void ): void; - public describeUserGroups( + describeUserGroups( args: DescribeUserGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserGroupsCommandOutput) => void ): void; - public describeUserGroups( - args: DescribeUserGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUserGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeUserGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeUserGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of users.

- */ - public describeUsers( - args: DescribeUsersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeUsers( - args: DescribeUsersCommandInput, - cb: (err: any, data?: DescribeUsersCommandOutput) => void - ): void; - public describeUsers( + + /** + * @see {@link DescribeUsersCommand} + */ + describeUsers(args: DescribeUsersCommandInput, options?: __HttpHandlerOptions): Promise; + describeUsers(args: DescribeUsersCommandInput, cb: (err: any, data?: DescribeUsersCommandOutput) => void): void; + describeUsers( args: DescribeUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUsersCommandOutput) => void ): void; - public describeUsers( - args: DescribeUsersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUsersCommandOutput) => void), - cb?: (err: any, data?: DescribeUsersCommandOutput) => void - ): Promise | void { - const command = new DescribeUsersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that Amazon region.

- */ - public disassociateGlobalReplicationGroup( + + /** + * @see {@link DisassociateGlobalReplicationGroupCommand} + */ + disassociateGlobalReplicationGroup( args: DisassociateGlobalReplicationGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateGlobalReplicationGroup( + disassociateGlobalReplicationGroup( args: DisassociateGlobalReplicationGroupCommandInput, cb: (err: any, data?: DisassociateGlobalReplicationGroupCommandOutput) => void ): void; - public disassociateGlobalReplicationGroup( + disassociateGlobalReplicationGroup( args: DisassociateGlobalReplicationGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateGlobalReplicationGroupCommandOutput) => void ): void; - public disassociateGlobalReplicationGroup( - args: DisassociateGlobalReplicationGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateGlobalReplicationGroupCommandOutput) => void), - cb?: (err: any, data?: DisassociateGlobalReplicationGroupCommandOutput) => void - ): Promise | void { - const command = new DisassociateGlobalReplicationGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.

- */ - public failoverGlobalReplicationGroup( + + /** + * @see {@link FailoverGlobalReplicationGroupCommand} + */ + failoverGlobalReplicationGroup( args: FailoverGlobalReplicationGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public failoverGlobalReplicationGroup( + failoverGlobalReplicationGroup( args: FailoverGlobalReplicationGroupCommandInput, cb: (err: any, data?: FailoverGlobalReplicationGroupCommandOutput) => void ): void; - public failoverGlobalReplicationGroup( + failoverGlobalReplicationGroup( args: FailoverGlobalReplicationGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FailoverGlobalReplicationGroupCommandOutput) => void ): void; - public failoverGlobalReplicationGroup( - args: FailoverGlobalReplicationGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FailoverGlobalReplicationGroupCommandOutput) => void), - cb?: (err: any, data?: FailoverGlobalReplicationGroupCommandOutput) => void - ): Promise | void { - const command = new FailoverGlobalReplicationGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Increase the number of node groups in the Global datastore

- */ - public increaseNodeGroupsInGlobalReplicationGroup( + + /** + * @see {@link IncreaseNodeGroupsInGlobalReplicationGroupCommand} + */ + increaseNodeGroupsInGlobalReplicationGroup( args: IncreaseNodeGroupsInGlobalReplicationGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public increaseNodeGroupsInGlobalReplicationGroup( + increaseNodeGroupsInGlobalReplicationGroup( args: IncreaseNodeGroupsInGlobalReplicationGroupCommandInput, cb: (err: any, data?: IncreaseNodeGroupsInGlobalReplicationGroupCommandOutput) => void ): void; - public increaseNodeGroupsInGlobalReplicationGroup( + increaseNodeGroupsInGlobalReplicationGroup( args: IncreaseNodeGroupsInGlobalReplicationGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IncreaseNodeGroupsInGlobalReplicationGroupCommandOutput) => void ): void; - public increaseNodeGroupsInGlobalReplicationGroup( - args: IncreaseNodeGroupsInGlobalReplicationGroupCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: IncreaseNodeGroupsInGlobalReplicationGroupCommandOutput) => void), - cb?: (err: any, data?: IncreaseNodeGroupsInGlobalReplicationGroupCommandOutput) => void - ): Promise | void { - const command = new IncreaseNodeGroupsInGlobalReplicationGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Dynamically increases the number of replicas in a Redis (cluster mode disabled) replication group or the number of - * replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation - * is performed with no cluster down time.

- */ - public increaseReplicaCount( + + /** + * @see {@link IncreaseReplicaCountCommand} + */ + increaseReplicaCount( args: IncreaseReplicaCountCommandInput, options?: __HttpHandlerOptions ): Promise; - public increaseReplicaCount( + increaseReplicaCount( args: IncreaseReplicaCountCommandInput, cb: (err: any, data?: IncreaseReplicaCountCommandOutput) => void ): void; - public increaseReplicaCount( + increaseReplicaCount( args: IncreaseReplicaCountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IncreaseReplicaCountCommandOutput) => void ): void; - public increaseReplicaCount( - args: IncreaseReplicaCountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: IncreaseReplicaCountCommandOutput) => void), - cb?: (err: any, data?: IncreaseReplicaCountCommandOutput) => void - ): Promise | void { - const command = new IncreaseReplicaCountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all available node types that you - * can scale your Redis cluster's or replication group's current node type.

- *

When you use the ModifyCacheCluster or ModifyReplicationGroup operations to - * scale your cluster or replication group, the value of the CacheNodeType parameter - * must be one of the node types returned by this operation.

- */ - public listAllowedNodeTypeModifications( + + /** + * @see {@link ListAllowedNodeTypeModificationsCommand} + */ + listAllowedNodeTypeModifications( args: ListAllowedNodeTypeModificationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAllowedNodeTypeModifications( + listAllowedNodeTypeModifications( args: ListAllowedNodeTypeModificationsCommandInput, cb: (err: any, data?: ListAllowedNodeTypeModificationsCommandOutput) => void ): void; - public listAllowedNodeTypeModifications( + listAllowedNodeTypeModifications( args: ListAllowedNodeTypeModificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAllowedNodeTypeModificationsCommandOutput) => void ): void; - public listAllowedNodeTypeModifications( - args: ListAllowedNodeTypeModificationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAllowedNodeTypeModificationsCommandOutput) => void), - cb?: (err: any, data?: ListAllowedNodeTypeModificationsCommandOutput) => void - ): Promise | void { - const command = new ListAllowedNodeTypeModificationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all tags currently on a named resource.

- *

A tag is a key-value pair where the key and value are case-sensitive. - * You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. - * For more information, see Resource-level permissions.

- *

If the cluster is not in the available state, ListTagsForResource - * returns an error.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the settings for a cluster. You - * can use this operation to change one or more cluster configuration parameters by - * specifying the parameters and the new values.

- */ - public modifyCacheCluster( + + /** + * @see {@link ModifyCacheClusterCommand} + */ + modifyCacheCluster( args: ModifyCacheClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyCacheCluster( + modifyCacheCluster( args: ModifyCacheClusterCommandInput, cb: (err: any, data?: ModifyCacheClusterCommandOutput) => void ): void; - public modifyCacheCluster( + modifyCacheCluster( args: ModifyCacheClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyCacheClusterCommandOutput) => void ): void; - public modifyCacheCluster( - args: ModifyCacheClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyCacheClusterCommandOutput) => void), - cb?: (err: any, data?: ModifyCacheClusterCommandOutput) => void - ): Promise | void { - const command = new ModifyCacheClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the parameters of a cache - * parameter group. You can modify up to 20 parameters in a single request by submitting a - * list parameter name and value pairs.

- */ - public modifyCacheParameterGroup( + + /** + * @see {@link ModifyCacheParameterGroupCommand} + */ + modifyCacheParameterGroup( args: ModifyCacheParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyCacheParameterGroup( + modifyCacheParameterGroup( args: ModifyCacheParameterGroupCommandInput, cb: (err: any, data?: ModifyCacheParameterGroupCommandOutput) => void ): void; - public modifyCacheParameterGroup( + modifyCacheParameterGroup( args: ModifyCacheParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyCacheParameterGroupCommandOutput) => void ): void; - public modifyCacheParameterGroup( - args: ModifyCacheParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyCacheParameterGroupCommandOutput) => void), - cb?: (err: any, data?: ModifyCacheParameterGroupCommandOutput) => void - ): Promise | void { - const command = new ModifyCacheParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies an existing cache subnet group.

- */ - public modifyCacheSubnetGroup( + + /** + * @see {@link ModifyCacheSubnetGroupCommand} + */ + modifyCacheSubnetGroup( args: ModifyCacheSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyCacheSubnetGroup( + modifyCacheSubnetGroup( args: ModifyCacheSubnetGroupCommandInput, cb: (err: any, data?: ModifyCacheSubnetGroupCommandOutput) => void ): void; - public modifyCacheSubnetGroup( + modifyCacheSubnetGroup( args: ModifyCacheSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyCacheSubnetGroupCommandOutput) => void ): void; - public modifyCacheSubnetGroup( - args: ModifyCacheSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyCacheSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: ModifyCacheSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new ModifyCacheSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the settings for a Global datastore.

- */ - public modifyGlobalReplicationGroup( + + /** + * @see {@link ModifyGlobalReplicationGroupCommand} + */ + modifyGlobalReplicationGroup( args: ModifyGlobalReplicationGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyGlobalReplicationGroup( + modifyGlobalReplicationGroup( args: ModifyGlobalReplicationGroupCommandInput, cb: (err: any, data?: ModifyGlobalReplicationGroupCommandOutput) => void ): void; - public modifyGlobalReplicationGroup( + modifyGlobalReplicationGroup( args: ModifyGlobalReplicationGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyGlobalReplicationGroupCommandOutput) => void ): void; - public modifyGlobalReplicationGroup( - args: ModifyGlobalReplicationGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyGlobalReplicationGroupCommandOutput) => void), - cb?: (err: any, data?: ModifyGlobalReplicationGroupCommandOutput) => void - ): Promise | void { - const command = new ModifyGlobalReplicationGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the settings for a replication group.

- * - * - *

This operation is valid for Redis only.

- *
- */ - public modifyReplicationGroup( + + /** + * @see {@link ModifyReplicationGroupCommand} + */ + modifyReplicationGroup( args: ModifyReplicationGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyReplicationGroup( + modifyReplicationGroup( args: ModifyReplicationGroupCommandInput, cb: (err: any, data?: ModifyReplicationGroupCommandOutput) => void ): void; - public modifyReplicationGroup( + modifyReplicationGroup( args: ModifyReplicationGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyReplicationGroupCommandOutput) => void ): void; - public modifyReplicationGroup( - args: ModifyReplicationGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyReplicationGroupCommandOutput) => void), - cb?: (err: any, data?: ModifyReplicationGroupCommandOutput) => void - ): Promise | void { - const command = new ModifyReplicationGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies a replication group's shards (node groups) by allowing you to - * add shards, remove shards, or rebalance the keyspaces among existing shards.

- */ - public modifyReplicationGroupShardConfiguration( + + /** + * @see {@link ModifyReplicationGroupShardConfigurationCommand} + */ + modifyReplicationGroupShardConfiguration( args: ModifyReplicationGroupShardConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyReplicationGroupShardConfiguration( + modifyReplicationGroupShardConfiguration( args: ModifyReplicationGroupShardConfigurationCommandInput, cb: (err: any, data?: ModifyReplicationGroupShardConfigurationCommandOutput) => void ): void; - public modifyReplicationGroupShardConfiguration( + modifyReplicationGroupShardConfiguration( args: ModifyReplicationGroupShardConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyReplicationGroupShardConfigurationCommandOutput) => void ): void; - public modifyReplicationGroupShardConfiguration( - args: ModifyReplicationGroupShardConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ModifyReplicationGroupShardConfigurationCommandOutput) => void), - cb?: (err: any, data?: ModifyReplicationGroupShardConfigurationCommandOutput) => void - ): Promise | void { - const command = new ModifyReplicationGroupShardConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Changes user password(s) and/or access string.

- */ - public modifyUser(args: ModifyUserCommandInput, options?: __HttpHandlerOptions): Promise; - public modifyUser(args: ModifyUserCommandInput, cb: (err: any, data?: ModifyUserCommandOutput) => void): void; - public modifyUser( + + /** + * @see {@link ModifyUserCommand} + */ + modifyUser(args: ModifyUserCommandInput, options?: __HttpHandlerOptions): Promise; + modifyUser(args: ModifyUserCommandInput, cb: (err: any, data?: ModifyUserCommandOutput) => void): void; + modifyUser( args: ModifyUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyUserCommandOutput) => void ): void; - public modifyUser( - args: ModifyUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyUserCommandOutput) => void), - cb?: (err: any, data?: ModifyUserCommandOutput) => void - ): Promise | void { - const command = new ModifyUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Changes the list of users that belong to the user group.

- */ - public modifyUserGroup( + + /** + * @see {@link ModifyUserGroupCommand} + */ + modifyUserGroup( args: ModifyUserGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyUserGroup( - args: ModifyUserGroupCommandInput, - cb: (err: any, data?: ModifyUserGroupCommandOutput) => void - ): void; - public modifyUserGroup( + modifyUserGroup(args: ModifyUserGroupCommandInput, cb: (err: any, data?: ModifyUserGroupCommandOutput) => void): void; + modifyUserGroup( args: ModifyUserGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyUserGroupCommandOutput) => void ): void; - public modifyUserGroup( - args: ModifyUserGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyUserGroupCommandOutput) => void), - cb?: (err: any, data?: ModifyUserGroupCommandOutput) => void - ): Promise | void { - const command = new ModifyUserGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Allows you to purchase a reserved - * cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, - * see Managing Costs with Reserved Nodes for Redis or - * Managing Costs with Reserved Nodes for Memcached.

- */ - public purchaseReservedCacheNodesOffering( + + /** + * @see {@link PurchaseReservedCacheNodesOfferingCommand} + */ + purchaseReservedCacheNodesOffering( args: PurchaseReservedCacheNodesOfferingCommandInput, options?: __HttpHandlerOptions ): Promise; - public purchaseReservedCacheNodesOffering( + purchaseReservedCacheNodesOffering( args: PurchaseReservedCacheNodesOfferingCommandInput, cb: (err: any, data?: PurchaseReservedCacheNodesOfferingCommandOutput) => void ): void; - public purchaseReservedCacheNodesOffering( + purchaseReservedCacheNodesOffering( args: PurchaseReservedCacheNodesOfferingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PurchaseReservedCacheNodesOfferingCommandOutput) => void ): void; - public purchaseReservedCacheNodesOffering( - args: PurchaseReservedCacheNodesOfferingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PurchaseReservedCacheNodesOfferingCommandOutput) => void), - cb?: (err: any, data?: PurchaseReservedCacheNodesOfferingCommandOutput) => void - ): Promise | void { - const command = new PurchaseReservedCacheNodesOfferingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Redistribute slots to ensure uniform distribution across existing shards in the cluster.

- */ - public rebalanceSlotsInGlobalReplicationGroup( + + /** + * @see {@link RebalanceSlotsInGlobalReplicationGroupCommand} + */ + rebalanceSlotsInGlobalReplicationGroup( args: RebalanceSlotsInGlobalReplicationGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public rebalanceSlotsInGlobalReplicationGroup( + rebalanceSlotsInGlobalReplicationGroup( args: RebalanceSlotsInGlobalReplicationGroupCommandInput, cb: (err: any, data?: RebalanceSlotsInGlobalReplicationGroupCommandOutput) => void ): void; - public rebalanceSlotsInGlobalReplicationGroup( + rebalanceSlotsInGlobalReplicationGroup( args: RebalanceSlotsInGlobalReplicationGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebalanceSlotsInGlobalReplicationGroupCommandOutput) => void ): void; - public rebalanceSlotsInGlobalReplicationGroup( - args: RebalanceSlotsInGlobalReplicationGroupCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: RebalanceSlotsInGlobalReplicationGroupCommandOutput) => void), - cb?: (err: any, data?: RebalanceSlotsInGlobalReplicationGroupCommandOutput) => void - ): Promise | void { - const command = new RebalanceSlotsInGlobalReplicationGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Reboots some, or all, of the cache nodes - * within a provisioned cluster. This operation applies any modified cache parameter - * groups to the cluster. The reboot operation takes place as soon as possible, and - * results in a momentary outage to the cluster. During the reboot, the cluster - * status is set to REBOOTING.

- *

The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.

- *

When the reboot is complete, a cluster event is created.

- *

Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. - * Rebooting is not supported on Redis (cluster mode enabled) clusters.

- *

If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, - * see Rebooting a Cluster for an alternate process.

- */ - public rebootCacheCluster( + + /** + * @see {@link RebootCacheClusterCommand} + */ + rebootCacheCluster( args: RebootCacheClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public rebootCacheCluster( + rebootCacheCluster( args: RebootCacheClusterCommandInput, cb: (err: any, data?: RebootCacheClusterCommandOutput) => void ): void; - public rebootCacheCluster( + rebootCacheCluster( args: RebootCacheClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebootCacheClusterCommandOutput) => void ): void; - public rebootCacheCluster( - args: RebootCacheClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RebootCacheClusterCommandOutput) => void), - cb?: (err: any, data?: RebootCacheClusterCommandOutput) => void - ): Promise | void { - const command = new RebootCacheClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the tags identified by the TagKeys - * list from the named resource. A tag is a key-value pair where the key and value are case-sensitive. - * You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. - * For more information, see Resource-level permissions.

- */ - public removeTagsFromResource( + + /** + * @see {@link RemoveTagsFromResourceCommand} + */ + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeTagsFromResource( + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void ): void; - public removeTagsFromResource( + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void ): void; - public removeTagsFromResource( - args: RemoveTagsFromResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveTagsFromResourceCommandOutput) => void), - cb?: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void - ): Promise | void { - const command = new RemoveTagsFromResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the parameters of a cache - * parameter group to the engine or system default value. You can reset specific parameters - * by submitting a list of parameter names. To reset the entire cache parameter group, - * specify the ResetAllParameters and CacheParameterGroupName parameters.

- */ - public resetCacheParameterGroup( + + /** + * @see {@link ResetCacheParameterGroupCommand} + */ + resetCacheParameterGroup( args: ResetCacheParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetCacheParameterGroup( + resetCacheParameterGroup( args: ResetCacheParameterGroupCommandInput, cb: (err: any, data?: ResetCacheParameterGroupCommandOutput) => void ): void; - public resetCacheParameterGroup( + resetCacheParameterGroup( args: ResetCacheParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetCacheParameterGroupCommandOutput) => void ): void; - public resetCacheParameterGroup( - args: ResetCacheParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetCacheParameterGroupCommandOutput) => void), - cb?: (err: any, data?: ResetCacheParameterGroupCommandOutput) => void - ): Promise | void { - const command = new ResetCacheParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Revokes ingress from a cache security group. - * Use this operation to disallow access from an Amazon EC2 security group - * that had been previously authorized.

- */ - public revokeCacheSecurityGroupIngress( + + /** + * @see {@link RevokeCacheSecurityGroupIngressCommand} + */ + revokeCacheSecurityGroupIngress( args: RevokeCacheSecurityGroupIngressCommandInput, options?: __HttpHandlerOptions ): Promise; - public revokeCacheSecurityGroupIngress( + revokeCacheSecurityGroupIngress( args: RevokeCacheSecurityGroupIngressCommandInput, cb: (err: any, data?: RevokeCacheSecurityGroupIngressCommandOutput) => void ): void; - public revokeCacheSecurityGroupIngress( + revokeCacheSecurityGroupIngress( args: RevokeCacheSecurityGroupIngressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeCacheSecurityGroupIngressCommandOutput) => void ): void; - public revokeCacheSecurityGroupIngress( - args: RevokeCacheSecurityGroupIngressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RevokeCacheSecurityGroupIngressCommandOutput) => void), - cb?: (err: any, data?: RevokeCacheSecurityGroupIngressCommandOutput) => void - ): Promise | void { - const command = new RevokeCacheSecurityGroupIngressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Start the migration of data.

- */ - public startMigration( + + /** + * @see {@link StartMigrationCommand} + */ + startMigration( args: StartMigrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startMigration( - args: StartMigrationCommandInput, - cb: (err: any, data?: StartMigrationCommandOutput) => void - ): void; - public startMigration( + startMigration(args: StartMigrationCommandInput, cb: (err: any, data?: StartMigrationCommandOutput) => void): void; + startMigration( args: StartMigrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMigrationCommandOutput) => void ): void; - public startMigration( - args: StartMigrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartMigrationCommandOutput) => void), - cb?: (err: any, data?: StartMigrationCommandOutput) => void - ): Promise | void { - const command = new StartMigrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Represents the input of a TestFailover operation which test automatic failover on - * a specified node group (called shard in the console) in a replication group (called cluster in the console).

- *

This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool - * for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API.

- *

- * Note the following - *

- *
    - *
  • - *

    A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and Amazon CLI) - * in any rolling 24-hour period.

    - *
  • - *
  • - *

    If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.

    - *

    - *
  • - *
  • - *

    If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, - * the first node replacement must complete before a subsequent call can be made.

    - *
  • - *
  • - *

    To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, - * the Amazon CLI, or the ElastiCache API. - * Look for the following automatic failover related events, listed here in order of occurrance:

    - *
      - *
    1. - *

      Replication group message: Test Failover API called for node group - *

      - *
    2. - *
    3. - *

      Cache cluster message: Failover from primary node to replica node completed - *

      - *
    4. - *
    5. - *

      Replication group message: Failover from primary node to replica node completed - *

      - *
    6. - *
    7. - *

      Cache cluster message: Recovering cache nodes - *

      - *
    8. - *
    9. - *

      Cache cluster message: Finished recovery for cache nodes - *

      - *
    10. - *
    - *

    For more information see:

    - * - *
  • - *
- *

Also see, Testing Multi-AZ in the ElastiCache User Guide.

- */ - public testFailover( - args: TestFailoverCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public testFailover(args: TestFailoverCommandInput, cb: (err: any, data?: TestFailoverCommandOutput) => void): void; - public testFailover( + + /** + * @see {@link TestFailoverCommand} + */ + testFailover(args: TestFailoverCommandInput, options?: __HttpHandlerOptions): Promise; + testFailover(args: TestFailoverCommandInput, cb: (err: any, data?: TestFailoverCommandOutput) => void): void; + testFailover( args: TestFailoverCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestFailoverCommandOutput) => void ): void; - public testFailover( - args: TestFailoverCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestFailoverCommandOutput) => void), - cb?: (err: any, data?: TestFailoverCommandOutput) => void - ): Promise | void { - const command = new TestFailoverCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon ElastiCache + *

Amazon ElastiCache is a web service that makes it easier to set up, operate, + * and scale a distributed cache in the cloud.

+ *

With ElastiCache, customers get all of the benefits of a high-performance, + * in-memory cache with less of the administrative burden involved in launching and managing a distributed cache. + * The service makes setup, scaling, + * and cluster failure handling much simpler than in a self-managed cache deployment.

+ *

In addition, through integration with Amazon CloudWatch, + * customers get enhanced visibility into the key performance statistics + * associated with their cache and can receive alarms if a part of their cache runs hot.

+ */ +export class ElastiCache extends ElastiCacheClient implements ElastiCache {} +createAggregatedClient(commands, ElastiCache); diff --git a/clients/client-elasticsearch-service/src/ElasticsearchService.ts b/clients/client-elasticsearch-service/src/ElasticsearchService.ts index 08e3daeaa5fa..ed4b1dbdab63 100644 --- a/clients/client-elasticsearch-service/src/ElasticsearchService.ts +++ b/clients/client-elasticsearch-service/src/ElasticsearchService.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -239,1693 +240,883 @@ import { UpgradeElasticsearchDomainCommandInput, UpgradeElasticsearchDomainCommandOutput, } from "./commands/UpgradeElasticsearchDomainCommand"; -import { ElasticsearchServiceClient } from "./ElasticsearchServiceClient"; +import { ElasticsearchServiceClient, ElasticsearchServiceClientConfig } from "./ElasticsearchServiceClient"; -/** - * @public - * Amazon Elasticsearch Configuration Service - *

Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains.

- *

For sample code that uses the Configuration API, see the Amazon Elasticsearch Service Developer Guide. - * The guide also contains sample code for sending signed HTTP requests to the Elasticsearch APIs.

- *

The endpoint for configuration service requests is region-specific: es.region.amazonaws.com. - * For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, - * see Regions and Endpoints.

- */ -export class ElasticsearchService extends ElasticsearchServiceClient { +const commands = { + AcceptInboundCrossClusterSearchConnectionCommand, + AddTagsCommand, + AssociatePackageCommand, + AuthorizeVpcEndpointAccessCommand, + CancelElasticsearchServiceSoftwareUpdateCommand, + CreateElasticsearchDomainCommand, + CreateOutboundCrossClusterSearchConnectionCommand, + CreatePackageCommand, + CreateVpcEndpointCommand, + DeleteElasticsearchDomainCommand, + DeleteElasticsearchServiceRoleCommand, + DeleteInboundCrossClusterSearchConnectionCommand, + DeleteOutboundCrossClusterSearchConnectionCommand, + DeletePackageCommand, + DeleteVpcEndpointCommand, + DescribeDomainAutoTunesCommand, + DescribeDomainChangeProgressCommand, + DescribeElasticsearchDomainCommand, + DescribeElasticsearchDomainConfigCommand, + DescribeElasticsearchDomainsCommand, + DescribeElasticsearchInstanceTypeLimitsCommand, + DescribeInboundCrossClusterSearchConnectionsCommand, + DescribeOutboundCrossClusterSearchConnectionsCommand, + DescribePackagesCommand, + DescribeReservedElasticsearchInstanceOfferingsCommand, + DescribeReservedElasticsearchInstancesCommand, + DescribeVpcEndpointsCommand, + DissociatePackageCommand, + GetCompatibleElasticsearchVersionsCommand, + GetPackageVersionHistoryCommand, + GetUpgradeHistoryCommand, + GetUpgradeStatusCommand, + ListDomainNamesCommand, + ListDomainsForPackageCommand, + ListElasticsearchInstanceTypesCommand, + ListElasticsearchVersionsCommand, + ListPackagesForDomainCommand, + ListTagsCommand, + ListVpcEndpointAccessCommand, + ListVpcEndpointsCommand, + ListVpcEndpointsForDomainCommand, + PurchaseReservedElasticsearchInstanceOfferingCommand, + RejectInboundCrossClusterSearchConnectionCommand, + RemoveTagsCommand, + RevokeVpcEndpointAccessCommand, + StartElasticsearchServiceSoftwareUpdateCommand, + UpdateElasticsearchDomainConfigCommand, + UpdatePackageCommand, + UpdateVpcEndpointCommand, + UpgradeElasticsearchDomainCommand, +}; + +export interface ElasticsearchService { /** - * @public - *

Allows the destination domain owner to accept an inbound cross-cluster search connection request.

+ * @see {@link AcceptInboundCrossClusterSearchConnectionCommand} */ - public acceptInboundCrossClusterSearchConnection( + acceptInboundCrossClusterSearchConnection( args: AcceptInboundCrossClusterSearchConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptInboundCrossClusterSearchConnection( + acceptInboundCrossClusterSearchConnection( args: AcceptInboundCrossClusterSearchConnectionCommandInput, cb: (err: any, data?: AcceptInboundCrossClusterSearchConnectionCommandOutput) => void ): void; - public acceptInboundCrossClusterSearchConnection( + acceptInboundCrossClusterSearchConnection( args: AcceptInboundCrossClusterSearchConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptInboundCrossClusterSearchConnectionCommandOutput) => void ): void; - public acceptInboundCrossClusterSearchConnection( - args: AcceptInboundCrossClusterSearchConnectionCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AcceptInboundCrossClusterSearchConnectionCommandOutput) => void), - cb?: (err: any, data?: AcceptInboundCrossClusterSearchConnectionCommandOutput) => void - ): Promise | void { - const command = new AcceptInboundCrossClusterSearchConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See - * Tagging Amazon Elasticsearch Service Domains for more information.

+ * @see {@link AddTagsCommand} */ - public addTags(args: AddTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public addTags(args: AddTagsCommandInput, cb: (err: any, data?: AddTagsCommandOutput) => void): void; - public addTags( + addTags(args: AddTagsCommandInput, options?: __HttpHandlerOptions): Promise; + addTags(args: AddTagsCommandInput, cb: (err: any, data?: AddTagsCommandOutput) => void): void; + addTags( args: AddTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsCommandOutput) => void ): void; - public addTags( - args: AddTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddTagsCommandOutput) => void), - cb?: (err: any, data?: AddTagsCommandOutput) => void - ): Promise | void { - const command = new AddTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a package with an Amazon ES domain.

+ * @see {@link AssociatePackageCommand} */ - public associatePackage( + associatePackage( args: AssociatePackageCommandInput, options?: __HttpHandlerOptions ): Promise; - public associatePackage( + associatePackage( args: AssociatePackageCommandInput, cb: (err: any, data?: AssociatePackageCommandOutput) => void ): void; - public associatePackage( + associatePackage( args: AssociatePackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociatePackageCommandOutput) => void ): void; - public associatePackage( - args: AssociatePackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociatePackageCommandOutput) => void), - cb?: (err: any, data?: AssociatePackageCommandOutput) => void - ): Promise | void { - const command = new AssociatePackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

+ * @see {@link AuthorizeVpcEndpointAccessCommand} */ - public authorizeVpcEndpointAccess( + authorizeVpcEndpointAccess( args: AuthorizeVpcEndpointAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public authorizeVpcEndpointAccess( + authorizeVpcEndpointAccess( args: AuthorizeVpcEndpointAccessCommandInput, cb: (err: any, data?: AuthorizeVpcEndpointAccessCommandOutput) => void ): void; - public authorizeVpcEndpointAccess( + authorizeVpcEndpointAccess( args: AuthorizeVpcEndpointAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AuthorizeVpcEndpointAccessCommandOutput) => void ): void; - public authorizeVpcEndpointAccess( - args: AuthorizeVpcEndpointAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AuthorizeVpcEndpointAccessCommandOutput) => void), - cb?: (err: any, data?: AuthorizeVpcEndpointAccessCommandOutput) => void - ): Promise | void { - const command = new AuthorizeVpcEndpointAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.

+ * @see {@link CancelElasticsearchServiceSoftwareUpdateCommand} */ - public cancelElasticsearchServiceSoftwareUpdate( + cancelElasticsearchServiceSoftwareUpdate( args: CancelElasticsearchServiceSoftwareUpdateCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelElasticsearchServiceSoftwareUpdate( + cancelElasticsearchServiceSoftwareUpdate( args: CancelElasticsearchServiceSoftwareUpdateCommandInput, cb: (err: any, data?: CancelElasticsearchServiceSoftwareUpdateCommandOutput) => void ): void; - public cancelElasticsearchServiceSoftwareUpdate( + cancelElasticsearchServiceSoftwareUpdate( args: CancelElasticsearchServiceSoftwareUpdateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelElasticsearchServiceSoftwareUpdateCommandOutput) => void ): void; - public cancelElasticsearchServiceSoftwareUpdate( - args: CancelElasticsearchServiceSoftwareUpdateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CancelElasticsearchServiceSoftwareUpdateCommandOutput) => void), - cb?: (err: any, data?: CancelElasticsearchServiceSoftwareUpdateCommandOutput) => void - ): Promise | void { - const command = new CancelElasticsearchServiceSoftwareUpdateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new Elasticsearch domain. For more information, - * see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

+ * @see {@link CreateElasticsearchDomainCommand} */ - public createElasticsearchDomain( + createElasticsearchDomain( args: CreateElasticsearchDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public createElasticsearchDomain( + createElasticsearchDomain( args: CreateElasticsearchDomainCommandInput, cb: (err: any, data?: CreateElasticsearchDomainCommandOutput) => void ): void; - public createElasticsearchDomain( + createElasticsearchDomain( args: CreateElasticsearchDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateElasticsearchDomainCommandOutput) => void ): void; - public createElasticsearchDomain( - args: CreateElasticsearchDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateElasticsearchDomainCommandOutput) => void), - cb?: (err: any, data?: CreateElasticsearchDomainCommandOutput) => void - ): Promise | void { - const command = new CreateElasticsearchDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new cross-cluster search connection from a source domain to a destination domain.

+ * @see {@link CreateOutboundCrossClusterSearchConnectionCommand} */ - public createOutboundCrossClusterSearchConnection( + createOutboundCrossClusterSearchConnection( args: CreateOutboundCrossClusterSearchConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createOutboundCrossClusterSearchConnection( + createOutboundCrossClusterSearchConnection( args: CreateOutboundCrossClusterSearchConnectionCommandInput, cb: (err: any, data?: CreateOutboundCrossClusterSearchConnectionCommandOutput) => void ): void; - public createOutboundCrossClusterSearchConnection( + createOutboundCrossClusterSearchConnection( args: CreateOutboundCrossClusterSearchConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateOutboundCrossClusterSearchConnectionCommandOutput) => void ): void; - public createOutboundCrossClusterSearchConnection( - args: CreateOutboundCrossClusterSearchConnectionCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateOutboundCrossClusterSearchConnectionCommandOutput) => void), - cb?: (err: any, data?: CreateOutboundCrossClusterSearchConnectionCommandOutput) => void - ): Promise | void { - const command = new CreateOutboundCrossClusterSearchConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create a package for use with Amazon ES domains.

+ * @see {@link CreatePackageCommand} */ - public createPackage( - args: CreatePackageCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createPackage( - args: CreatePackageCommandInput, - cb: (err: any, data?: CreatePackageCommandOutput) => void - ): void; - public createPackage( + createPackage(args: CreatePackageCommandInput, options?: __HttpHandlerOptions): Promise; + createPackage(args: CreatePackageCommandInput, cb: (err: any, data?: CreatePackageCommandOutput) => void): void; + createPackage( args: CreatePackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePackageCommandOutput) => void ): void; - public createPackage( - args: CreatePackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePackageCommandOutput) => void), - cb?: (err: any, data?: CreatePackageCommandOutput) => void - ): Promise | void { - const command = new CreatePackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Amazon OpenSearch Service-managed VPC endpoint.

+ * @see {@link CreateVpcEndpointCommand} */ - public createVpcEndpoint( + createVpcEndpoint( args: CreateVpcEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVpcEndpoint( + createVpcEndpoint( args: CreateVpcEndpointCommandInput, cb: (err: any, data?: CreateVpcEndpointCommandOutput) => void ): void; - public createVpcEndpoint( + createVpcEndpoint( args: CreateVpcEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVpcEndpointCommandOutput) => void ): void; - public createVpcEndpoint( - args: CreateVpcEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVpcEndpointCommandOutput) => void), - cb?: (err: any, data?: CreateVpcEndpointCommandOutput) => void - ): Promise | void { - const command = new CreateVpcEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.

+ * @see {@link DeleteElasticsearchDomainCommand} */ - public deleteElasticsearchDomain( + deleteElasticsearchDomain( args: DeleteElasticsearchDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteElasticsearchDomain( + deleteElasticsearchDomain( args: DeleteElasticsearchDomainCommandInput, cb: (err: any, data?: DeleteElasticsearchDomainCommandOutput) => void ): void; - public deleteElasticsearchDomain( + deleteElasticsearchDomain( args: DeleteElasticsearchDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteElasticsearchDomainCommandOutput) => void ): void; - public deleteElasticsearchDomain( - args: DeleteElasticsearchDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteElasticsearchDomainCommandOutput) => void), - cb?: (err: any, data?: DeleteElasticsearchDomainCommandOutput) => void - ): Promise | void { - const command = new DeleteElasticsearchDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains.

+ * @see {@link DeleteElasticsearchServiceRoleCommand} */ - public deleteElasticsearchServiceRole( + deleteElasticsearchServiceRole( args: DeleteElasticsearchServiceRoleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteElasticsearchServiceRole( + deleteElasticsearchServiceRole( args: DeleteElasticsearchServiceRoleCommandInput, cb: (err: any, data?: DeleteElasticsearchServiceRoleCommandOutput) => void ): void; - public deleteElasticsearchServiceRole( + deleteElasticsearchServiceRole( args: DeleteElasticsearchServiceRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteElasticsearchServiceRoleCommandOutput) => void ): void; - public deleteElasticsearchServiceRole( - args: DeleteElasticsearchServiceRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteElasticsearchServiceRoleCommandOutput) => void), - cb?: (err: any, data?: DeleteElasticsearchServiceRoleCommandOutput) => void - ): Promise | void { - const command = new DeleteElasticsearchServiceRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows the destination domain owner to delete an existing inbound cross-cluster search connection.

+ * @see {@link DeleteInboundCrossClusterSearchConnectionCommand} */ - public deleteInboundCrossClusterSearchConnection( + deleteInboundCrossClusterSearchConnection( args: DeleteInboundCrossClusterSearchConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInboundCrossClusterSearchConnection( + deleteInboundCrossClusterSearchConnection( args: DeleteInboundCrossClusterSearchConnectionCommandInput, cb: (err: any, data?: DeleteInboundCrossClusterSearchConnectionCommandOutput) => void ): void; - public deleteInboundCrossClusterSearchConnection( + deleteInboundCrossClusterSearchConnection( args: DeleteInboundCrossClusterSearchConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInboundCrossClusterSearchConnectionCommandOutput) => void ): void; - public deleteInboundCrossClusterSearchConnection( - args: DeleteInboundCrossClusterSearchConnectionCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteInboundCrossClusterSearchConnectionCommandOutput) => void), - cb?: (err: any, data?: DeleteInboundCrossClusterSearchConnectionCommandOutput) => void - ): Promise | void { - const command = new DeleteInboundCrossClusterSearchConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows the source domain owner to delete an existing outbound cross-cluster search connection.

+ * @see {@link DeleteOutboundCrossClusterSearchConnectionCommand} */ - public deleteOutboundCrossClusterSearchConnection( + deleteOutboundCrossClusterSearchConnection( args: DeleteOutboundCrossClusterSearchConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteOutboundCrossClusterSearchConnection( + deleteOutboundCrossClusterSearchConnection( args: DeleteOutboundCrossClusterSearchConnectionCommandInput, cb: (err: any, data?: DeleteOutboundCrossClusterSearchConnectionCommandOutput) => void ): void; - public deleteOutboundCrossClusterSearchConnection( + deleteOutboundCrossClusterSearchConnection( args: DeleteOutboundCrossClusterSearchConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOutboundCrossClusterSearchConnectionCommandOutput) => void ): void; - public deleteOutboundCrossClusterSearchConnection( - args: DeleteOutboundCrossClusterSearchConnectionCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteOutboundCrossClusterSearchConnectionCommandOutput) => void), - cb?: (err: any, data?: DeleteOutboundCrossClusterSearchConnectionCommandOutput) => void - ): Promise | void { - const command = new DeleteOutboundCrossClusterSearchConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete the package.

+ * @see {@link DeletePackageCommand} */ - public deletePackage( - args: DeletePackageCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deletePackage( - args: DeletePackageCommandInput, - cb: (err: any, data?: DeletePackageCommandOutput) => void - ): void; - public deletePackage( + deletePackage(args: DeletePackageCommandInput, options?: __HttpHandlerOptions): Promise; + deletePackage(args: DeletePackageCommandInput, cb: (err: any, data?: DeletePackageCommandOutput) => void): void; + deletePackage( args: DeletePackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePackageCommandOutput) => void ): void; - public deletePackage( - args: DeletePackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePackageCommandOutput) => void), - cb?: (err: any, data?: DeletePackageCommandOutput) => void - ): Promise | void { - const command = new DeletePackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

+ * @see {@link DeleteVpcEndpointCommand} */ - public deleteVpcEndpoint( + deleteVpcEndpoint( args: DeleteVpcEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVpcEndpoint( + deleteVpcEndpoint( args: DeleteVpcEndpointCommandInput, cb: (err: any, data?: DeleteVpcEndpointCommandOutput) => void ): void; - public deleteVpcEndpoint( + deleteVpcEndpoint( args: DeleteVpcEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVpcEndpointCommandOutput) => void ): void; - public deleteVpcEndpoint( - args: DeleteVpcEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVpcEndpointCommandOutput) => void), - cb?: (err: any, data?: DeleteVpcEndpointCommandOutput) => void - ): Promise | void { - const command = new DeleteVpcEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.

+ * @see {@link DescribeDomainAutoTunesCommand} */ - public describeDomainAutoTunes( + describeDomainAutoTunes( args: DescribeDomainAutoTunesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDomainAutoTunes( + describeDomainAutoTunes( args: DescribeDomainAutoTunesCommandInput, cb: (err: any, data?: DescribeDomainAutoTunesCommandOutput) => void ): void; - public describeDomainAutoTunes( + describeDomainAutoTunes( args: DescribeDomainAutoTunesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDomainAutoTunesCommandOutput) => void ): void; - public describeDomainAutoTunes( - args: DescribeDomainAutoTunesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDomainAutoTunesCommandOutput) => void), - cb?: (err: any, data?: DescribeDomainAutoTunesCommandOutput) => void - ): Promise | void { - const command = new DescribeDomainAutoTunesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the current blue/green deployment happening on a domain, including - * a change ID, status, and progress stages.

+ * @see {@link DescribeDomainChangeProgressCommand} */ - public describeDomainChangeProgress( + describeDomainChangeProgress( args: DescribeDomainChangeProgressCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDomainChangeProgress( + describeDomainChangeProgress( args: DescribeDomainChangeProgressCommandInput, cb: (err: any, data?: DescribeDomainChangeProgressCommandOutput) => void ): void; - public describeDomainChangeProgress( + describeDomainChangeProgress( args: DescribeDomainChangeProgressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDomainChangeProgressCommandOutput) => void ): void; - public describeDomainChangeProgress( - args: DescribeDomainChangeProgressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDomainChangeProgressCommandOutput) => void), - cb?: (err: any, data?: DescribeDomainChangeProgressCommandOutput) => void - ): Promise | void { - const command = new DescribeDomainChangeProgressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.

+ * @see {@link DescribeElasticsearchDomainCommand} */ - public describeElasticsearchDomain( + describeElasticsearchDomain( args: DescribeElasticsearchDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeElasticsearchDomain( + describeElasticsearchDomain( args: DescribeElasticsearchDomainCommandInput, cb: (err: any, data?: DescribeElasticsearchDomainCommandOutput) => void ): void; - public describeElasticsearchDomain( + describeElasticsearchDomain( args: DescribeElasticsearchDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeElasticsearchDomainCommandOutput) => void ): void; - public describeElasticsearchDomain( - args: DescribeElasticsearchDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeElasticsearchDomainCommandOutput) => void), - cb?: (err: any, data?: DescribeElasticsearchDomainCommandOutput) => void - ): Promise | void { - const command = new DescribeElasticsearchDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.

+ * @see {@link DescribeElasticsearchDomainConfigCommand} */ - public describeElasticsearchDomainConfig( + describeElasticsearchDomainConfig( args: DescribeElasticsearchDomainConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeElasticsearchDomainConfig( + describeElasticsearchDomainConfig( args: DescribeElasticsearchDomainConfigCommandInput, cb: (err: any, data?: DescribeElasticsearchDomainConfigCommandOutput) => void ): void; - public describeElasticsearchDomainConfig( + describeElasticsearchDomainConfig( args: DescribeElasticsearchDomainConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeElasticsearchDomainConfigCommandOutput) => void ): void; - public describeElasticsearchDomainConfig( - args: DescribeElasticsearchDomainConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeElasticsearchDomainConfigCommandOutput) => void), - cb?: (err: any, data?: DescribeElasticsearchDomainConfigCommandOutput) => void - ): Promise | void { - const command = new DescribeElasticsearchDomainConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

+ * @see {@link DescribeElasticsearchDomainsCommand} */ - public describeElasticsearchDomains( + describeElasticsearchDomains( args: DescribeElasticsearchDomainsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeElasticsearchDomains( + describeElasticsearchDomains( args: DescribeElasticsearchDomainsCommandInput, cb: (err: any, data?: DescribeElasticsearchDomainsCommandOutput) => void ): void; - public describeElasticsearchDomains( + describeElasticsearchDomains( args: DescribeElasticsearchDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeElasticsearchDomainsCommandOutput) => void ): void; - public describeElasticsearchDomains( - args: DescribeElasticsearchDomainsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeElasticsearchDomainsCommandOutput) => void), - cb?: (err: any, data?: DescribeElasticsearchDomainsCommandOutput) => void - ): Promise | void { - const command = new DescribeElasticsearchDomainsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. - * When modifying existing Domain, specify the - * - * DomainName - * - * to know what Limits are supported for modifying. - *

+ * @see {@link DescribeElasticsearchInstanceTypeLimitsCommand} */ - public describeElasticsearchInstanceTypeLimits( + describeElasticsearchInstanceTypeLimits( args: DescribeElasticsearchInstanceTypeLimitsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeElasticsearchInstanceTypeLimits( + describeElasticsearchInstanceTypeLimits( args: DescribeElasticsearchInstanceTypeLimitsCommandInput, cb: (err: any, data?: DescribeElasticsearchInstanceTypeLimitsCommandOutput) => void ): void; - public describeElasticsearchInstanceTypeLimits( + describeElasticsearchInstanceTypeLimits( args: DescribeElasticsearchInstanceTypeLimitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeElasticsearchInstanceTypeLimitsCommandOutput) => void ): void; - public describeElasticsearchInstanceTypeLimits( - args: DescribeElasticsearchInstanceTypeLimitsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeElasticsearchInstanceTypeLimitsCommandOutput) => void), - cb?: (err: any, data?: DescribeElasticsearchInstanceTypeLimitsCommandOutput) => void - ): Promise | void { - const command = new DescribeElasticsearchInstanceTypeLimitsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the inbound cross-cluster search connections for a destination domain.

+ * @see {@link DescribeInboundCrossClusterSearchConnectionsCommand} */ - public describeInboundCrossClusterSearchConnections( + describeInboundCrossClusterSearchConnections( args: DescribeInboundCrossClusterSearchConnectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInboundCrossClusterSearchConnections( + describeInboundCrossClusterSearchConnections( args: DescribeInboundCrossClusterSearchConnectionsCommandInput, cb: (err: any, data?: DescribeInboundCrossClusterSearchConnectionsCommandOutput) => void ): void; - public describeInboundCrossClusterSearchConnections( + describeInboundCrossClusterSearchConnections( args: DescribeInboundCrossClusterSearchConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInboundCrossClusterSearchConnectionsCommandOutput) => void ): void; - public describeInboundCrossClusterSearchConnections( - args: DescribeInboundCrossClusterSearchConnectionsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeInboundCrossClusterSearchConnectionsCommandOutput) => void), - cb?: (err: any, data?: DescribeInboundCrossClusterSearchConnectionsCommandOutput) => void - ): Promise | void { - const command = new DescribeInboundCrossClusterSearchConnectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the outbound cross-cluster search connections for a source domain.

+ * @see {@link DescribeOutboundCrossClusterSearchConnectionsCommand} */ - public describeOutboundCrossClusterSearchConnections( + describeOutboundCrossClusterSearchConnections( args: DescribeOutboundCrossClusterSearchConnectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOutboundCrossClusterSearchConnections( + describeOutboundCrossClusterSearchConnections( args: DescribeOutboundCrossClusterSearchConnectionsCommandInput, cb: (err: any, data?: DescribeOutboundCrossClusterSearchConnectionsCommandOutput) => void ): void; - public describeOutboundCrossClusterSearchConnections( + describeOutboundCrossClusterSearchConnections( args: DescribeOutboundCrossClusterSearchConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOutboundCrossClusterSearchConnectionsCommandOutput) => void ): void; - public describeOutboundCrossClusterSearchConnections( - args: DescribeOutboundCrossClusterSearchConnectionsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeOutboundCrossClusterSearchConnectionsCommandOutput) => void), - cb?: (err: any, data?: DescribeOutboundCrossClusterSearchConnectionsCommandOutput) => void - ): Promise | void { - const command = new DescribeOutboundCrossClusterSearchConnectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.

+ * @see {@link DescribePackagesCommand} */ - public describePackages( + describePackages( args: DescribePackagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePackages( + describePackages( args: DescribePackagesCommandInput, cb: (err: any, data?: DescribePackagesCommandOutput) => void ): void; - public describePackages( + describePackages( args: DescribePackagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePackagesCommandOutput) => void ): void; - public describePackages( - args: DescribePackagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePackagesCommandOutput) => void), - cb?: (err: any, data?: DescribePackagesCommandOutput) => void - ): Promise | void { - const command = new DescribePackagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists available reserved Elasticsearch instance offerings.

+ * @see {@link DescribeReservedElasticsearchInstanceOfferingsCommand} */ - public describeReservedElasticsearchInstanceOfferings( + describeReservedElasticsearchInstanceOfferings( args: DescribeReservedElasticsearchInstanceOfferingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReservedElasticsearchInstanceOfferings( + describeReservedElasticsearchInstanceOfferings( args: DescribeReservedElasticsearchInstanceOfferingsCommandInput, cb: (err: any, data?: DescribeReservedElasticsearchInstanceOfferingsCommandOutput) => void ): void; - public describeReservedElasticsearchInstanceOfferings( + describeReservedElasticsearchInstanceOfferings( args: DescribeReservedElasticsearchInstanceOfferingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReservedElasticsearchInstanceOfferingsCommandOutput) => void ): void; - public describeReservedElasticsearchInstanceOfferings( - args: DescribeReservedElasticsearchInstanceOfferingsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeReservedElasticsearchInstanceOfferingsCommandOutput) => void), - cb?: (err: any, data?: DescribeReservedElasticsearchInstanceOfferingsCommandOutput) => void - ): Promise | void { - const command = new DescribeReservedElasticsearchInstanceOfferingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about reserved Elasticsearch instances for this account.

+ * @see {@link DescribeReservedElasticsearchInstancesCommand} */ - public describeReservedElasticsearchInstances( + describeReservedElasticsearchInstances( args: DescribeReservedElasticsearchInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReservedElasticsearchInstances( + describeReservedElasticsearchInstances( args: DescribeReservedElasticsearchInstancesCommandInput, cb: (err: any, data?: DescribeReservedElasticsearchInstancesCommandOutput) => void ): void; - public describeReservedElasticsearchInstances( + describeReservedElasticsearchInstances( args: DescribeReservedElasticsearchInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReservedElasticsearchInstancesCommandOutput) => void ): void; - public describeReservedElasticsearchInstances( - args: DescribeReservedElasticsearchInstancesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeReservedElasticsearchInstancesCommandOutput) => void), - cb?: (err: any, data?: DescribeReservedElasticsearchInstancesCommandOutput) => void - ): Promise | void { - const command = new DescribeReservedElasticsearchInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

+ * @see {@link DescribeVpcEndpointsCommand} */ - public describeVpcEndpoints( + describeVpcEndpoints( args: DescribeVpcEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVpcEndpoints( + describeVpcEndpoints( args: DescribeVpcEndpointsCommandInput, cb: (err: any, data?: DescribeVpcEndpointsCommandOutput) => void ): void; - public describeVpcEndpoints( + describeVpcEndpoints( args: DescribeVpcEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVpcEndpointsCommandOutput) => void ): void; - public describeVpcEndpoints( - args: DescribeVpcEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVpcEndpointsCommandOutput) => void), - cb?: (err: any, data?: DescribeVpcEndpointsCommandOutput) => void - ): Promise | void { - const command = new DescribeVpcEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Dissociates a package from the Amazon ES domain.

+ * @see {@link DissociatePackageCommand} */ - public dissociatePackage( + dissociatePackage( args: DissociatePackageCommandInput, options?: __HttpHandlerOptions ): Promise; - public dissociatePackage( + dissociatePackage( args: DissociatePackageCommandInput, cb: (err: any, data?: DissociatePackageCommandOutput) => void ): void; - public dissociatePackage( + dissociatePackage( args: DissociatePackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DissociatePackageCommandOutput) => void ): void; - public dissociatePackage( - args: DissociatePackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DissociatePackageCommandOutput) => void), - cb?: (err: any, data?: DissociatePackageCommandOutput) => void - ): Promise | void { - const command = new DissociatePackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns a list of upgrade compatible Elastisearch versions. - * You can optionally pass a - * - * DomainName - * - * to get all upgrade compatible Elasticsearch versions for that specific domain. - *

+ * @see {@link GetCompatibleElasticsearchVersionsCommand} */ - public getCompatibleElasticsearchVersions( + getCompatibleElasticsearchVersions( args: GetCompatibleElasticsearchVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCompatibleElasticsearchVersions( + getCompatibleElasticsearchVersions( args: GetCompatibleElasticsearchVersionsCommandInput, cb: (err: any, data?: GetCompatibleElasticsearchVersionsCommandOutput) => void ): void; - public getCompatibleElasticsearchVersions( + getCompatibleElasticsearchVersions( args: GetCompatibleElasticsearchVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCompatibleElasticsearchVersionsCommandOutput) => void ): void; - public getCompatibleElasticsearchVersions( - args: GetCompatibleElasticsearchVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCompatibleElasticsearchVersionsCommandOutput) => void), - cb?: (err: any, data?: GetCompatibleElasticsearchVersionsCommandOutput) => void - ): Promise | void { - const command = new GetCompatibleElasticsearchVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of versions of the package, along with their creation time and commit message.

+ * @see {@link GetPackageVersionHistoryCommand} */ - public getPackageVersionHistory( + getPackageVersionHistory( args: GetPackageVersionHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPackageVersionHistory( + getPackageVersionHistory( args: GetPackageVersionHistoryCommandInput, cb: (err: any, data?: GetPackageVersionHistoryCommandOutput) => void ): void; - public getPackageVersionHistory( + getPackageVersionHistory( args: GetPackageVersionHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPackageVersionHistoryCommandOutput) => void ): void; - public getPackageVersionHistory( - args: GetPackageVersionHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPackageVersionHistoryCommandOutput) => void), - cb?: (err: any, data?: GetPackageVersionHistoryCommandOutput) => void - ): Promise | void { - const command = new GetPackageVersionHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the complete history of the last 10 upgrades that were performed on the domain.

+ * @see {@link GetUpgradeHistoryCommand} */ - public getUpgradeHistory( + getUpgradeHistory( args: GetUpgradeHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUpgradeHistory( + getUpgradeHistory( args: GetUpgradeHistoryCommandInput, cb: (err: any, data?: GetUpgradeHistoryCommandOutput) => void ): void; - public getUpgradeHistory( + getUpgradeHistory( args: GetUpgradeHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUpgradeHistoryCommandOutput) => void ): void; - public getUpgradeHistory( - args: GetUpgradeHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUpgradeHistoryCommandOutput) => void), - cb?: (err: any, data?: GetUpgradeHistoryCommandOutput) => void - ): Promise | void { - const command = new GetUpgradeHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

+ * @see {@link GetUpgradeStatusCommand} */ - public getUpgradeStatus( + getUpgradeStatus( args: GetUpgradeStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUpgradeStatus( + getUpgradeStatus( args: GetUpgradeStatusCommandInput, cb: (err: any, data?: GetUpgradeStatusCommandOutput) => void ): void; - public getUpgradeStatus( + getUpgradeStatus( args: GetUpgradeStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUpgradeStatusCommandOutput) => void ): void; - public getUpgradeStatus( - args: GetUpgradeStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUpgradeStatusCommandOutput) => void), - cb?: (err: any, data?: GetUpgradeStatusCommandOutput) => void - ): Promise | void { - const command = new GetUpgradeStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the name of all Elasticsearch domains owned by the current user's account.

+ * @see {@link ListDomainNamesCommand} */ - public listDomainNames( + listDomainNames( args: ListDomainNamesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDomainNames( - args: ListDomainNamesCommandInput, - cb: (err: any, data?: ListDomainNamesCommandOutput) => void - ): void; - public listDomainNames( + listDomainNames(args: ListDomainNamesCommandInput, cb: (err: any, data?: ListDomainNamesCommandOutput) => void): void; + listDomainNames( args: ListDomainNamesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainNamesCommandOutput) => void ): void; - public listDomainNames( - args: ListDomainNamesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDomainNamesCommandOutput) => void), - cb?: (err: any, data?: ListDomainNamesCommandOutput) => void - ): Promise | void { - const command = new ListDomainNamesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all Amazon ES domains associated with the package.

+ * @see {@link ListDomainsForPackageCommand} */ - public listDomainsForPackage( + listDomainsForPackage( args: ListDomainsForPackageCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDomainsForPackage( + listDomainsForPackage( args: ListDomainsForPackageCommandInput, cb: (err: any, data?: ListDomainsForPackageCommandOutput) => void ): void; - public listDomainsForPackage( + listDomainsForPackage( args: ListDomainsForPackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainsForPackageCommandOutput) => void ): void; - public listDomainsForPackage( - args: ListDomainsForPackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDomainsForPackageCommandOutput) => void), - cb?: (err: any, data?: ListDomainsForPackageCommandOutput) => void - ): Promise | void { - const command = new ListDomainsForPackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

+ * @see {@link ListElasticsearchInstanceTypesCommand} */ - public listElasticsearchInstanceTypes( + listElasticsearchInstanceTypes( args: ListElasticsearchInstanceTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listElasticsearchInstanceTypes( + listElasticsearchInstanceTypes( args: ListElasticsearchInstanceTypesCommandInput, cb: (err: any, data?: ListElasticsearchInstanceTypesCommandOutput) => void ): void; - public listElasticsearchInstanceTypes( + listElasticsearchInstanceTypes( args: ListElasticsearchInstanceTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListElasticsearchInstanceTypesCommandOutput) => void ): void; - public listElasticsearchInstanceTypes( - args: ListElasticsearchInstanceTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListElasticsearchInstanceTypesCommandOutput) => void), - cb?: (err: any, data?: ListElasticsearchInstanceTypesCommandOutput) => void - ): Promise | void { - const command = new ListElasticsearchInstanceTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all supported Elasticsearch versions

+ * @see {@link ListElasticsearchVersionsCommand} */ - public listElasticsearchVersions( + listElasticsearchVersions( args: ListElasticsearchVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listElasticsearchVersions( + listElasticsearchVersions( args: ListElasticsearchVersionsCommandInput, cb: (err: any, data?: ListElasticsearchVersionsCommandOutput) => void ): void; - public listElasticsearchVersions( + listElasticsearchVersions( args: ListElasticsearchVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListElasticsearchVersionsCommandOutput) => void ): void; - public listElasticsearchVersions( - args: ListElasticsearchVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListElasticsearchVersionsCommandOutput) => void), - cb?: (err: any, data?: ListElasticsearchVersionsCommandOutput) => void - ): Promise | void { - const command = new ListElasticsearchVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all packages associated with the Amazon ES domain.

+ * @see {@link ListPackagesForDomainCommand} */ - public listPackagesForDomain( + listPackagesForDomain( args: ListPackagesForDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPackagesForDomain( + listPackagesForDomain( args: ListPackagesForDomainCommandInput, cb: (err: any, data?: ListPackagesForDomainCommandOutput) => void ): void; - public listPackagesForDomain( + listPackagesForDomain( args: ListPackagesForDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPackagesForDomainCommandOutput) => void ): void; - public listPackagesForDomain( - args: ListPackagesForDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPackagesForDomainCommandOutput) => void), - cb?: (err: any, data?: ListPackagesForDomainCommandOutput) => void - ): Promise | void { - const command = new ListPackagesForDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns all tags for the given Elasticsearch domain.

+ * @see {@link ListTagsCommand} */ - public listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; - public listTags( + listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; + listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; + listTags( args: ListTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsCommandOutput) => void ): void; - public listTags( - args: ListTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsCommandOutput) => void), - cb?: (err: any, data?: ListTagsCommandOutput) => void - ): Promise | void { - const command = new ListTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about each principal that is allowed to access a - * given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

+ * @see {@link ListVpcEndpointAccessCommand} */ - public listVpcEndpointAccess( + listVpcEndpointAccess( args: ListVpcEndpointAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVpcEndpointAccess( + listVpcEndpointAccess( args: ListVpcEndpointAccessCommandInput, cb: (err: any, data?: ListVpcEndpointAccessCommandOutput) => void ): void; - public listVpcEndpointAccess( + listVpcEndpointAccess( args: ListVpcEndpointAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVpcEndpointAccessCommandOutput) => void ): void; - public listVpcEndpointAccess( - args: ListVpcEndpointAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVpcEndpointAccessCommandOutput) => void), - cb?: (err: any, data?: ListVpcEndpointAccessCommandOutput) => void - ): Promise | void { - const command = new ListVpcEndpointAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.

+ * @see {@link ListVpcEndpointsCommand} */ - public listVpcEndpoints( + listVpcEndpoints( args: ListVpcEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVpcEndpoints( + listVpcEndpoints( args: ListVpcEndpointsCommandInput, cb: (err: any, data?: ListVpcEndpointsCommandOutput) => void ): void; - public listVpcEndpoints( + listVpcEndpoints( args: ListVpcEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVpcEndpointsCommandOutput) => void ): void; - public listVpcEndpoints( - args: ListVpcEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVpcEndpointsCommandOutput) => void), - cb?: (err: any, data?: ListVpcEndpointsCommandOutput) => void - ): Promise | void { - const command = new ListVpcEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

+ * @see {@link ListVpcEndpointsForDomainCommand} */ - public listVpcEndpointsForDomain( + listVpcEndpointsForDomain( args: ListVpcEndpointsForDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVpcEndpointsForDomain( + listVpcEndpointsForDomain( args: ListVpcEndpointsForDomainCommandInput, cb: (err: any, data?: ListVpcEndpointsForDomainCommandOutput) => void ): void; - public listVpcEndpointsForDomain( + listVpcEndpointsForDomain( args: ListVpcEndpointsForDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVpcEndpointsForDomainCommandOutput) => void ): void; - public listVpcEndpointsForDomain( - args: ListVpcEndpointsForDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVpcEndpointsForDomainCommandOutput) => void), - cb?: (err: any, data?: ListVpcEndpointsForDomainCommandOutput) => void - ): Promise | void { - const command = new ListVpcEndpointsForDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows you to purchase reserved Elasticsearch instances.

+ * @see {@link PurchaseReservedElasticsearchInstanceOfferingCommand} */ - public purchaseReservedElasticsearchInstanceOffering( + purchaseReservedElasticsearchInstanceOffering( args: PurchaseReservedElasticsearchInstanceOfferingCommandInput, options?: __HttpHandlerOptions ): Promise; - public purchaseReservedElasticsearchInstanceOffering( + purchaseReservedElasticsearchInstanceOffering( args: PurchaseReservedElasticsearchInstanceOfferingCommandInput, cb: (err: any, data?: PurchaseReservedElasticsearchInstanceOfferingCommandOutput) => void ): void; - public purchaseReservedElasticsearchInstanceOffering( + purchaseReservedElasticsearchInstanceOffering( args: PurchaseReservedElasticsearchInstanceOfferingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PurchaseReservedElasticsearchInstanceOfferingCommandOutput) => void ): void; - public purchaseReservedElasticsearchInstanceOffering( - args: PurchaseReservedElasticsearchInstanceOfferingCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PurchaseReservedElasticsearchInstanceOfferingCommandOutput) => void), - cb?: (err: any, data?: PurchaseReservedElasticsearchInstanceOfferingCommandOutput) => void - ): Promise | void { - const command = new PurchaseReservedElasticsearchInstanceOfferingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows the destination domain owner to reject an inbound cross-cluster search connection request.

+ * @see {@link RejectInboundCrossClusterSearchConnectionCommand} */ - public rejectInboundCrossClusterSearchConnection( + rejectInboundCrossClusterSearchConnection( args: RejectInboundCrossClusterSearchConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public rejectInboundCrossClusterSearchConnection( + rejectInboundCrossClusterSearchConnection( args: RejectInboundCrossClusterSearchConnectionCommandInput, cb: (err: any, data?: RejectInboundCrossClusterSearchConnectionCommandOutput) => void ): void; - public rejectInboundCrossClusterSearchConnection( + rejectInboundCrossClusterSearchConnection( args: RejectInboundCrossClusterSearchConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectInboundCrossClusterSearchConnectionCommandOutput) => void ): void; - public rejectInboundCrossClusterSearchConnection( - args: RejectInboundCrossClusterSearchConnectionCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: RejectInboundCrossClusterSearchConnectionCommandOutput) => void), - cb?: (err: any, data?: RejectInboundCrossClusterSearchConnectionCommandOutput) => void - ): Promise | void { - const command = new RejectInboundCrossClusterSearchConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified set of tags from the specified Elasticsearch domain.

+ * @see {@link RemoveTagsCommand} */ - public removeTags(args: RemoveTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public removeTags(args: RemoveTagsCommandInput, cb: (err: any, data?: RemoveTagsCommandOutput) => void): void; - public removeTags( + removeTags(args: RemoveTagsCommandInput, options?: __HttpHandlerOptions): Promise; + removeTags(args: RemoveTagsCommandInput, cb: (err: any, data?: RemoveTagsCommandOutput) => void): void; + removeTags( args: RemoveTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsCommandOutput) => void ): void; - public removeTags( - args: RemoveTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveTagsCommandOutput) => void), - cb?: (err: any, data?: RemoveTagsCommandOutput) => void - ): Promise | void { - const command = new RemoveTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface - * VPC endpoint.

+ * @see {@link RevokeVpcEndpointAccessCommand} */ - public revokeVpcEndpointAccess( + revokeVpcEndpointAccess( args: RevokeVpcEndpointAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public revokeVpcEndpointAccess( + revokeVpcEndpointAccess( args: RevokeVpcEndpointAccessCommandInput, cb: (err: any, data?: RevokeVpcEndpointAccessCommandOutput) => void ): void; - public revokeVpcEndpointAccess( + revokeVpcEndpointAccess( args: RevokeVpcEndpointAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeVpcEndpointAccessCommandOutput) => void ): void; - public revokeVpcEndpointAccess( - args: RevokeVpcEndpointAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RevokeVpcEndpointAccessCommandOutput) => void), - cb?: (err: any, data?: RevokeVpcEndpointAccessCommandOutput) => void - ): Promise | void { - const command = new RevokeVpcEndpointAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Schedules a service software update for an Amazon ES domain.

+ * @see {@link StartElasticsearchServiceSoftwareUpdateCommand} */ - public startElasticsearchServiceSoftwareUpdate( + startElasticsearchServiceSoftwareUpdate( args: StartElasticsearchServiceSoftwareUpdateCommandInput, options?: __HttpHandlerOptions ): Promise; - public startElasticsearchServiceSoftwareUpdate( + startElasticsearchServiceSoftwareUpdate( args: StartElasticsearchServiceSoftwareUpdateCommandInput, cb: (err: any, data?: StartElasticsearchServiceSoftwareUpdateCommandOutput) => void ): void; - public startElasticsearchServiceSoftwareUpdate( + startElasticsearchServiceSoftwareUpdate( args: StartElasticsearchServiceSoftwareUpdateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartElasticsearchServiceSoftwareUpdateCommandOutput) => void ): void; - public startElasticsearchServiceSoftwareUpdate( - args: StartElasticsearchServiceSoftwareUpdateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: StartElasticsearchServiceSoftwareUpdateCommandOutput) => void), - cb?: (err: any, data?: StartElasticsearchServiceSoftwareUpdateCommandOutput) => void - ): Promise | void { - const command = new StartElasticsearchServiceSoftwareUpdateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

+ * @see {@link UpdateElasticsearchDomainConfigCommand} */ - public updateElasticsearchDomainConfig( + updateElasticsearchDomainConfig( args: UpdateElasticsearchDomainConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateElasticsearchDomainConfig( + updateElasticsearchDomainConfig( args: UpdateElasticsearchDomainConfigCommandInput, cb: (err: any, data?: UpdateElasticsearchDomainConfigCommandOutput) => void ): void; - public updateElasticsearchDomainConfig( + updateElasticsearchDomainConfig( args: UpdateElasticsearchDomainConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateElasticsearchDomainConfigCommandOutput) => void ): void; - public updateElasticsearchDomainConfig( - args: UpdateElasticsearchDomainConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateElasticsearchDomainConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateElasticsearchDomainConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateElasticsearchDomainConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a package for use with Amazon ES domains.

+ * @see {@link UpdatePackageCommand} */ - public updatePackage( - args: UpdatePackageCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updatePackage( - args: UpdatePackageCommandInput, - cb: (err: any, data?: UpdatePackageCommandOutput) => void - ): void; - public updatePackage( + updatePackage(args: UpdatePackageCommandInput, options?: __HttpHandlerOptions): Promise; + updatePackage(args: UpdatePackageCommandInput, cb: (err: any, data?: UpdatePackageCommandOutput) => void): void; + updatePackage( args: UpdatePackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePackageCommandOutput) => void ): void; - public updatePackage( - args: UpdatePackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePackageCommandOutput) => void), - cb?: (err: any, data?: UpdatePackageCommandOutput) => void - ): Promise | void { - const command = new UpdatePackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

+ * @see {@link UpdateVpcEndpointCommand} */ - public updateVpcEndpoint( + updateVpcEndpoint( args: UpdateVpcEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVpcEndpoint( + updateVpcEndpoint( args: UpdateVpcEndpointCommandInput, cb: (err: any, data?: UpdateVpcEndpointCommandOutput) => void ): void; - public updateVpcEndpoint( + updateVpcEndpoint( args: UpdateVpcEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVpcEndpointCommandOutput) => void ): void; - public updateVpcEndpoint( - args: UpdateVpcEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVpcEndpointCommandOutput) => void), - cb?: (err: any, data?: UpdateVpcEndpointCommandOutput) => void - ): Promise | void { - const command = new UpdateVpcEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

+ * @see {@link UpgradeElasticsearchDomainCommand} */ - public upgradeElasticsearchDomain( + upgradeElasticsearchDomain( args: UpgradeElasticsearchDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public upgradeElasticsearchDomain( + upgradeElasticsearchDomain( args: UpgradeElasticsearchDomainCommandInput, cb: (err: any, data?: UpgradeElasticsearchDomainCommandOutput) => void ): void; - public upgradeElasticsearchDomain( + upgradeElasticsearchDomain( args: UpgradeElasticsearchDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpgradeElasticsearchDomainCommandOutput) => void ): void; - public upgradeElasticsearchDomain( - args: UpgradeElasticsearchDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpgradeElasticsearchDomainCommandOutput) => void), - cb?: (err: any, data?: UpgradeElasticsearchDomainCommandOutput) => void - ): Promise | void { - const command = new UpgradeElasticsearchDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Elasticsearch Configuration Service + *

Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains.

+ *

For sample code that uses the Configuration API, see the Amazon Elasticsearch Service Developer Guide. + * The guide also contains sample code for sending signed HTTP requests to the Elasticsearch APIs.

+ *

The endpoint for configuration service requests is region-specific: es.region.amazonaws.com. + * For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, + * see Regions and Endpoints.

+ */ +export class ElasticsearchService extends ElasticsearchServiceClient implements ElasticsearchService {} +createAggregatedClient(commands, ElasticsearchService); diff --git a/clients/client-emr-containers/src/EMRContainers.ts b/clients/client-emr-containers/src/EMRContainers.ts index 2b88ee553442..122c93480b17 100644 --- a/clients/client-emr-containers/src/EMRContainers.ts +++ b/clients/client-emr-containers/src/EMRContainers.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -84,686 +85,348 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; -import { EMRContainersClient } from "./EMRContainersClient"; +import { EMRContainersClient, EMRContainersClientConfig } from "./EMRContainersClient"; -/** - * @public - *

Amazon EMR on EKS provides a deployment option for Amazon EMR that allows - * you to run open-source big data frameworks on Amazon Elastic Kubernetes Service (Amazon EKS). - * With this deployment option, you can focus on running analytics workloads while Amazon EMR on EKS builds, configures, and manages containers for open-source applications. - * For more information about Amazon EMR on EKS concepts and tasks, see What is - * shared id="EMR-EKS"/>.

- *

- * Amazon EMR containers is the API name for Amazon EMR on EKS. - * The emr-containers prefix is used in the following scenarios:

- *
    - *
  • - *

    It is the prefix in the CLI commands for Amazon EMR on EKS. For example, - * aws emr-containers start-job-run.

    - *
  • - *
  • - *

    It is the prefix before IAM policy actions for Amazon EMR on EKS. For - * example, "Action": [ "emr-containers:StartJobRun"]. For more - * information, see Policy actions for Amazon EMR on EKS.

    - *
  • - *
  • - *

    It is the prefix used in Amazon EMR on EKS service endpoints. For example, - * emr-containers.us-east-2.amazonaws.com. For more information, see - * Amazon EMR on EKSService Endpoints.

    - *
  • - *
- */ -export class EMRContainers extends EMRContainersClient { +const commands = { + CancelJobRunCommand, + CreateJobTemplateCommand, + CreateManagedEndpointCommand, + CreateVirtualClusterCommand, + DeleteJobTemplateCommand, + DeleteManagedEndpointCommand, + DeleteVirtualClusterCommand, + DescribeJobRunCommand, + DescribeJobTemplateCommand, + DescribeManagedEndpointCommand, + DescribeVirtualClusterCommand, + ListJobRunsCommand, + ListJobTemplatesCommand, + ListManagedEndpointsCommand, + ListTagsForResourceCommand, + ListVirtualClustersCommand, + StartJobRunCommand, + TagResourceCommand, + UntagResourceCommand, +}; + +export interface EMRContainers { /** - * @public - *

Cancels a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or - * SparkSQL query, that you submit to Amazon EMR on EKS.

+ * @see {@link CancelJobRunCommand} */ - public cancelJobRun( - args: CancelJobRunCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public cancelJobRun(args: CancelJobRunCommandInput, cb: (err: any, data?: CancelJobRunCommandOutput) => void): void; - public cancelJobRun( + cancelJobRun(args: CancelJobRunCommandInput, options?: __HttpHandlerOptions): Promise; + cancelJobRun(args: CancelJobRunCommandInput, cb: (err: any, data?: CancelJobRunCommandOutput) => void): void; + cancelJobRun( args: CancelJobRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelJobRunCommandOutput) => void ): void; - public cancelJobRun( - args: CancelJobRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelJobRunCommandOutput) => void), - cb?: (err: any, data?: CancelJobRunCommandOutput) => void - ): Promise | void { - const command = new CancelJobRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a job template. Job template stores values of StartJobRun API request in a - * template and can be used to start a job run. Job template allows two use cases: avoid - * repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun - * API request.

+ * @see {@link CreateJobTemplateCommand} */ - public createJobTemplate( + createJobTemplate( args: CreateJobTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createJobTemplate( + createJobTemplate( args: CreateJobTemplateCommandInput, cb: (err: any, data?: CreateJobTemplateCommandOutput) => void ): void; - public createJobTemplate( + createJobTemplate( args: CreateJobTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateJobTemplateCommandOutput) => void ): void; - public createJobTemplate( - args: CreateJobTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateJobTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateJobTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateJobTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to - * Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual - * cluster.

+ * @see {@link CreateManagedEndpointCommand} */ - public createManagedEndpoint( + createManagedEndpoint( args: CreateManagedEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createManagedEndpoint( + createManagedEndpoint( args: CreateManagedEndpointCommandInput, cb: (err: any, data?: CreateManagedEndpointCommandOutput) => void ): void; - public createManagedEndpoint( + createManagedEndpoint( args: CreateManagedEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateManagedEndpointCommandOutput) => void ): void; - public createManagedEndpoint( - args: CreateManagedEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateManagedEndpointCommandOutput) => void), - cb?: (err: any, data?: CreateManagedEndpointCommandOutput) => void - ): Promise | void { - const command = new CreateManagedEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any - * additional resource in your system. A single virtual cluster maps to a single Kubernetes - * namespace. Given this relationship, you can model virtual clusters the same way you model - * Kubernetes namespaces to meet your requirements.

+ * @see {@link CreateVirtualClusterCommand} */ - public createVirtualCluster( + createVirtualCluster( args: CreateVirtualClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVirtualCluster( + createVirtualCluster( args: CreateVirtualClusterCommandInput, cb: (err: any, data?: CreateVirtualClusterCommandOutput) => void ): void; - public createVirtualCluster( + createVirtualCluster( args: CreateVirtualClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVirtualClusterCommandOutput) => void ): void; - public createVirtualCluster( - args: CreateVirtualClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVirtualClusterCommandOutput) => void), - cb?: (err: any, data?: CreateVirtualClusterCommandOutput) => void - ): Promise | void { - const command = new CreateVirtualClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a job template. Job template stores values of StartJobRun API request in a - * template and can be used to start a job run. Job template allows two use cases: avoid - * repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun - * API request.

+ * @see {@link DeleteJobTemplateCommand} */ - public deleteJobTemplate( + deleteJobTemplate( args: DeleteJobTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteJobTemplate( + deleteJobTemplate( args: DeleteJobTemplateCommandInput, cb: (err: any, data?: DeleteJobTemplateCommandOutput) => void ): void; - public deleteJobTemplate( + deleteJobTemplate( args: DeleteJobTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteJobTemplateCommandOutput) => void ): void; - public deleteJobTemplate( - args: DeleteJobTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteJobTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteJobTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteJobTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to - * Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual - * cluster.

+ * @see {@link DeleteManagedEndpointCommand} */ - public deleteManagedEndpoint( + deleteManagedEndpoint( args: DeleteManagedEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteManagedEndpoint( + deleteManagedEndpoint( args: DeleteManagedEndpointCommandInput, cb: (err: any, data?: DeleteManagedEndpointCommandOutput) => void ): void; - public deleteManagedEndpoint( + deleteManagedEndpoint( args: DeleteManagedEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteManagedEndpointCommandOutput) => void ): void; - public deleteManagedEndpoint( - args: DeleteManagedEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteManagedEndpointCommandOutput) => void), - cb?: (err: any, data?: DeleteManagedEndpointCommandOutput) => void - ): Promise | void { - const command = new DeleteManagedEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any - * additional resource in your system. A single virtual cluster maps to a single Kubernetes - * namespace. Given this relationship, you can model virtual clusters the same way you model - * Kubernetes namespaces to meet your requirements.

+ * @see {@link DeleteVirtualClusterCommand} */ - public deleteVirtualCluster( + deleteVirtualCluster( args: DeleteVirtualClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVirtualCluster( + deleteVirtualCluster( args: DeleteVirtualClusterCommandInput, cb: (err: any, data?: DeleteVirtualClusterCommandOutput) => void ): void; - public deleteVirtualCluster( + deleteVirtualCluster( args: DeleteVirtualClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVirtualClusterCommandOutput) => void ): void; - public deleteVirtualCluster( - args: DeleteVirtualClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVirtualClusterCommandOutput) => void), - cb?: (err: any, data?: DeleteVirtualClusterCommandOutput) => void - ): Promise | void { - const command = new DeleteVirtualClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays detailed information about a job run. A job run is a unit of work, such as a - * Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

+ * @see {@link DescribeJobRunCommand} */ - public describeJobRun( + describeJobRun( args: DescribeJobRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeJobRun( - args: DescribeJobRunCommandInput, - cb: (err: any, data?: DescribeJobRunCommandOutput) => void - ): void; - public describeJobRun( + describeJobRun(args: DescribeJobRunCommandInput, cb: (err: any, data?: DescribeJobRunCommandOutput) => void): void; + describeJobRun( args: DescribeJobRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobRunCommandOutput) => void ): void; - public describeJobRun( - args: DescribeJobRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeJobRunCommandOutput) => void), - cb?: (err: any, data?: DescribeJobRunCommandOutput) => void - ): Promise | void { - const command = new DescribeJobRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays detailed information about a specified job template. Job template stores values - * of StartJobRun API request in a template and can be used to start a job run. Job template - * allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing - * certain values in StartJobRun API request.

+ * @see {@link DescribeJobTemplateCommand} */ - public describeJobTemplate( + describeJobTemplate( args: DescribeJobTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeJobTemplate( + describeJobTemplate( args: DescribeJobTemplateCommandInput, cb: (err: any, data?: DescribeJobTemplateCommandOutput) => void ): void; - public describeJobTemplate( + describeJobTemplate( args: DescribeJobTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobTemplateCommandOutput) => void ): void; - public describeJobTemplate( - args: DescribeJobTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeJobTemplateCommandOutput) => void), - cb?: (err: any, data?: DescribeJobTemplateCommandOutput) => void - ): Promise | void { - const command = new DescribeJobTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays detailed information about a managed endpoint. A managed endpoint is a gateway - * that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with - * your virtual cluster.

+ * @see {@link DescribeManagedEndpointCommand} */ - public describeManagedEndpoint( + describeManagedEndpoint( args: DescribeManagedEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeManagedEndpoint( + describeManagedEndpoint( args: DescribeManagedEndpointCommandInput, cb: (err: any, data?: DescribeManagedEndpointCommandOutput) => void ): void; - public describeManagedEndpoint( + describeManagedEndpoint( args: DescribeManagedEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeManagedEndpointCommandOutput) => void ): void; - public describeManagedEndpoint( - args: DescribeManagedEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeManagedEndpointCommandOutput) => void), - cb?: (err: any, data?: DescribeManagedEndpointCommandOutput) => void - ): Promise | void { - const command = new DescribeManagedEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays detailed information about a specified virtual cluster. Virtual cluster is a - * managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual - * clusters. They do not consume any additional resource in your system. A single virtual - * cluster maps to a single Kubernetes namespace. Given this relationship, you can model - * virtual clusters the same way you model Kubernetes namespaces to meet your - * requirements.

+ * @see {@link DescribeVirtualClusterCommand} */ - public describeVirtualCluster( + describeVirtualCluster( args: DescribeVirtualClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVirtualCluster( + describeVirtualCluster( args: DescribeVirtualClusterCommandInput, cb: (err: any, data?: DescribeVirtualClusterCommandOutput) => void ): void; - public describeVirtualCluster( + describeVirtualCluster( args: DescribeVirtualClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVirtualClusterCommandOutput) => void ): void; - public describeVirtualCluster( - args: DescribeVirtualClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVirtualClusterCommandOutput) => void), - cb?: (err: any, data?: DescribeVirtualClusterCommandOutput) => void - ): Promise | void { - const command = new DescribeVirtualClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists job runs based on a set of parameters. A job run is a unit of work, such as a - * Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

+ * @see {@link ListJobRunsCommand} */ - public listJobRuns(args: ListJobRunsCommandInput, options?: __HttpHandlerOptions): Promise; - public listJobRuns(args: ListJobRunsCommandInput, cb: (err: any, data?: ListJobRunsCommandOutput) => void): void; - public listJobRuns( + listJobRuns(args: ListJobRunsCommandInput, options?: __HttpHandlerOptions): Promise; + listJobRuns(args: ListJobRunsCommandInput, cb: (err: any, data?: ListJobRunsCommandOutput) => void): void; + listJobRuns( args: ListJobRunsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobRunsCommandOutput) => void ): void; - public listJobRuns( - args: ListJobRunsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJobRunsCommandOutput) => void), - cb?: (err: any, data?: ListJobRunsCommandOutput) => void - ): Promise | void { - const command = new ListJobRunsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists job templates based on a set of parameters. Job template stores values of - * StartJobRun API request in a template and can be used to start a job run. Job template - * allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing - * certain values in StartJobRun API request.

+ * @see {@link ListJobTemplatesCommand} */ - public listJobTemplates( + listJobTemplates( args: ListJobTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listJobTemplates( + listJobTemplates( args: ListJobTemplatesCommandInput, cb: (err: any, data?: ListJobTemplatesCommandOutput) => void ): void; - public listJobTemplates( + listJobTemplates( args: ListJobTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobTemplatesCommandOutput) => void ): void; - public listJobTemplates( - args: ListJobTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJobTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListJobTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListJobTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway - * that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with - * your virtual cluster.

+ * @see {@link ListManagedEndpointsCommand} */ - public listManagedEndpoints( + listManagedEndpoints( args: ListManagedEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listManagedEndpoints( + listManagedEndpoints( args: ListManagedEndpointsCommandInput, cb: (err: any, data?: ListManagedEndpointsCommandOutput) => void ): void; - public listManagedEndpoints( + listManagedEndpoints( args: ListManagedEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListManagedEndpointsCommandOutput) => void ): void; - public listManagedEndpoints( - args: ListManagedEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListManagedEndpointsCommandOutput) => void), - cb?: (err: any, data?: ListManagedEndpointsCommandOutput) => void - ): Promise | void { - const command = new ListManagedEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags assigned to the resources.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists information about the specified virtual cluster. Virtual cluster is a managed - * entity on Amazon EMR on EKS. You can create, describe, list and delete virtual - * clusters. They do not consume any additional resource in your system. A single virtual - * cluster maps to a single Kubernetes namespace. Given this relationship, you can model - * virtual clusters the same way you model Kubernetes namespaces to meet your - * requirements.

+ * @see {@link ListVirtualClustersCommand} */ - public listVirtualClusters( + listVirtualClusters( args: ListVirtualClustersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVirtualClusters( + listVirtualClusters( args: ListVirtualClustersCommandInput, cb: (err: any, data?: ListVirtualClustersCommandOutput) => void ): void; - public listVirtualClusters( + listVirtualClusters( args: ListVirtualClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVirtualClustersCommandOutput) => void ): void; - public listVirtualClusters( - args: ListVirtualClustersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVirtualClustersCommandOutput) => void), - cb?: (err: any, data?: ListVirtualClustersCommandOutput) => void - ): Promise | void { - const command = new ListVirtualClustersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or - * SparkSQL query, that you submit to Amazon EMR on EKS.

+ * @see {@link StartJobRunCommand} */ - public startJobRun(args: StartJobRunCommandInput, options?: __HttpHandlerOptions): Promise; - public startJobRun(args: StartJobRunCommandInput, cb: (err: any, data?: StartJobRunCommandOutput) => void): void; - public startJobRun( + startJobRun(args: StartJobRunCommandInput, options?: __HttpHandlerOptions): Promise; + startJobRun(args: StartJobRunCommandInput, cb: (err: any, data?: StartJobRunCommandOutput) => void): void; + startJobRun( args: StartJobRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartJobRunCommandOutput) => void ): void; - public startJobRun( - args: StartJobRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartJobRunCommandOutput) => void), - cb?: (err: any, data?: StartJobRunCommandOutput) => void - ): Promise | void { - const command = new StartJobRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns tags to resources. A tag is a label that you assign to an Amazon Web Services resource. Each tag - * consists of a key and an optional value, both of which you define. Tags enable you to - * categorize your Amazon Web Services resources by attributes such as purpose, owner, or environment. When - * you have many resources of the same type, you can quickly identify a specific resource - * based on the tags you've assigned to it. For example, you can define a set of tags for your - * Amazon EMR on EKS clusters to help you track each cluster's owner and stack level. - * We recommend that you devise a consistent set of tag keys for each resource type. You can - * then search and filter the resources based on the tags that you add.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from resources.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon EMR on EKS provides a deployment option for Amazon EMR that allows + * you to run open-source big data frameworks on Amazon Elastic Kubernetes Service (Amazon EKS). + * With this deployment option, you can focus on running analytics workloads while Amazon EMR on EKS builds, configures, and manages containers for open-source applications. + * For more information about Amazon EMR on EKS concepts and tasks, see What is + * shared id="EMR-EKS"/>.

+ *

+ * Amazon EMR containers is the API name for Amazon EMR on EKS. + * The emr-containers prefix is used in the following scenarios:

+ *
    + *
  • + *

    It is the prefix in the CLI commands for Amazon EMR on EKS. For example, + * aws emr-containers start-job-run.

    + *
  • + *
  • + *

    It is the prefix before IAM policy actions for Amazon EMR on EKS. For + * example, "Action": [ "emr-containers:StartJobRun"]. For more + * information, see Policy actions for Amazon EMR on EKS.

    + *
  • + *
  • + *

    It is the prefix used in Amazon EMR on EKS service endpoints. For example, + * emr-containers.us-east-2.amazonaws.com. For more information, see + * Amazon EMR on EKSService Endpoints.

    + *
  • + *
+ */ +export class EMRContainers extends EMRContainersClient implements EMRContainers {} +createAggregatedClient(commands, EMRContainers); diff --git a/clients/client-emr-serverless/src/EMRServerless.ts b/clients/client-emr-serverless/src/EMRServerless.ts index 97c0e2c882c7..b7a1b88705ba 100644 --- a/clients/client-emr-serverless/src/EMRServerless.ts +++ b/clients/client-emr-serverless/src/EMRServerless.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -60,507 +61,265 @@ import { UpdateApplicationCommandInput, UpdateApplicationCommandOutput, } from "./commands/UpdateApplicationCommand"; -import { EMRServerlessClient } from "./EMRServerlessClient"; +import { EMRServerlessClient, EMRServerlessClientConfig } from "./EMRServerlessClient"; -/** - * @public - *

Amazon EMR Serverless is a new deployment option for Amazon EMR. EMR Serverless provides - * a serverless runtime environment that simplifies running analytics applications using the - * latest open source frameworks such as Apache Spark and Apache Hive. With EMR Serverless, - * you don’t have to configure, optimize, secure, or operate clusters to run applications with - * these frameworks.

- *

The API reference to Amazon EMR Serverless is emr-serverless. The - * emr-serverless prefix is used in the following scenarios:

- *
    - *
  • - *

    It is the prefix in the CLI commands for Amazon EMR Serverless. For example, - * aws emr-serverless start-job-run.

    - *
  • - *
  • - *

    It is the prefix before IAM policy actions for Amazon EMR Serverless. For example, - * "Action": ["emr-serverless:StartJobRun"]. For more information, see - * Policy actions for Amazon EMR Serverless.

    - *
  • - *
  • - *

    It is the prefix used in Amazon EMR Serverless service endpoints. For example, - * emr-serverless.us-east-2.amazonaws.com.

    - *
  • - *
- */ -export class EMRServerless extends EMRServerlessClient { +const commands = { + CancelJobRunCommand, + CreateApplicationCommand, + DeleteApplicationCommand, + GetApplicationCommand, + GetDashboardForJobRunCommand, + GetJobRunCommand, + ListApplicationsCommand, + ListJobRunsCommand, + ListTagsForResourceCommand, + StartApplicationCommand, + StartJobRunCommand, + StopApplicationCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateApplicationCommand, +}; + +export interface EMRServerless { /** - * @public - *

Cancels a job run.

+ * @see {@link CancelJobRunCommand} */ - public cancelJobRun( - args: CancelJobRunCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public cancelJobRun(args: CancelJobRunCommandInput, cb: (err: any, data?: CancelJobRunCommandOutput) => void): void; - public cancelJobRun( + cancelJobRun(args: CancelJobRunCommandInput, options?: __HttpHandlerOptions): Promise; + cancelJobRun(args: CancelJobRunCommandInput, cb: (err: any, data?: CancelJobRunCommandOutput) => void): void; + cancelJobRun( args: CancelJobRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelJobRunCommandOutput) => void ): void; - public cancelJobRun( - args: CancelJobRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelJobRunCommandOutput) => void), - cb?: (err: any, data?: CancelJobRunCommandOutput) => void - ): Promise | void { - const command = new CancelJobRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an application.

+ * @see {@link CreateApplicationCommand} */ - public createApplication( + createApplication( args: CreateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApplication( + createApplication( args: CreateApplicationCommandInput, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( + createApplication( args: CreateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( - args: CreateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApplicationCommandOutput) => void), - cb?: (err: any, data?: CreateApplicationCommandOutput) => void - ): Promise | void { - const command = new CreateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an application. An application has to be in a stopped or created state in order - * to be deleted.

+ * @see {@link DeleteApplicationCommand} */ - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( - args: DeleteApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApplicationCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays detailed information about a specified application.

+ * @see {@link GetApplicationCommand} */ - public getApplication( + getApplication( args: GetApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getApplication( - args: GetApplicationCommandInput, - cb: (err: any, data?: GetApplicationCommandOutput) => void - ): void; - public getApplication( + getApplication(args: GetApplicationCommandInput, cb: (err: any, data?: GetApplicationCommandOutput) => void): void; + getApplication( args: GetApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApplicationCommandOutput) => void ): void; - public getApplication( - args: GetApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApplicationCommandOutput) => void), - cb?: (err: any, data?: GetApplicationCommandOutput) => void - ): Promise | void { - const command = new GetApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a URL to access the job run dashboard. The generated URL is valid for one hour, - * after which you must invoke the API again to generate a new URL.

+ * @see {@link GetDashboardForJobRunCommand} */ - public getDashboardForJobRun( + getDashboardForJobRun( args: GetDashboardForJobRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDashboardForJobRun( + getDashboardForJobRun( args: GetDashboardForJobRunCommandInput, cb: (err: any, data?: GetDashboardForJobRunCommandOutput) => void ): void; - public getDashboardForJobRun( + getDashboardForJobRun( args: GetDashboardForJobRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDashboardForJobRunCommandOutput) => void ): void; - public getDashboardForJobRun( - args: GetDashboardForJobRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDashboardForJobRunCommandOutput) => void), - cb?: (err: any, data?: GetDashboardForJobRunCommandOutput) => void - ): Promise | void { - const command = new GetDashboardForJobRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays detailed information about a job run.

+ * @see {@link GetJobRunCommand} */ - public getJobRun(args: GetJobRunCommandInput, options?: __HttpHandlerOptions): Promise; - public getJobRun(args: GetJobRunCommandInput, cb: (err: any, data?: GetJobRunCommandOutput) => void): void; - public getJobRun( + getJobRun(args: GetJobRunCommandInput, options?: __HttpHandlerOptions): Promise; + getJobRun(args: GetJobRunCommandInput, cb: (err: any, data?: GetJobRunCommandOutput) => void): void; + getJobRun( args: GetJobRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobRunCommandOutput) => void ): void; - public getJobRun( - args: GetJobRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetJobRunCommandOutput) => void), - cb?: (err: any, data?: GetJobRunCommandOutput) => void - ): Promise | void { - const command = new GetJobRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists applications based on a set of parameters.

+ * @see {@link ListApplicationsCommand} */ - public listApplications( + listApplications( args: ListApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplications( + listApplications( args: ListApplicationsCommandInput, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( + listApplications( args: ListApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( - args: ListApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationsCommandOutput) => void), - cb?: (err: any, data?: ListApplicationsCommandOutput) => void - ): Promise | void { - const command = new ListApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists job runs based on a set of parameters.

+ * @see {@link ListJobRunsCommand} */ - public listJobRuns(args: ListJobRunsCommandInput, options?: __HttpHandlerOptions): Promise; - public listJobRuns(args: ListJobRunsCommandInput, cb: (err: any, data?: ListJobRunsCommandOutput) => void): void; - public listJobRuns( + listJobRuns(args: ListJobRunsCommandInput, options?: __HttpHandlerOptions): Promise; + listJobRuns(args: ListJobRunsCommandInput, cb: (err: any, data?: ListJobRunsCommandOutput) => void): void; + listJobRuns( args: ListJobRunsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobRunsCommandOutput) => void ): void; - public listJobRuns( - args: ListJobRunsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJobRunsCommandOutput) => void), - cb?: (err: any, data?: ListJobRunsCommandOutput) => void - ): Promise | void { - const command = new ListJobRunsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags assigned to the resources.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a specified application and initializes initial capacity if configured.

+ * @see {@link StartApplicationCommand} */ - public startApplication( + startApplication( args: StartApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startApplication( + startApplication( args: StartApplicationCommandInput, cb: (err: any, data?: StartApplicationCommandOutput) => void ): void; - public startApplication( + startApplication( args: StartApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartApplicationCommandOutput) => void ): void; - public startApplication( - args: StartApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartApplicationCommandOutput) => void), - cb?: (err: any, data?: StartApplicationCommandOutput) => void - ): Promise | void { - const command = new StartApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a job run.

+ * @see {@link StartJobRunCommand} */ - public startJobRun(args: StartJobRunCommandInput, options?: __HttpHandlerOptions): Promise; - public startJobRun(args: StartJobRunCommandInput, cb: (err: any, data?: StartJobRunCommandOutput) => void): void; - public startJobRun( + startJobRun(args: StartJobRunCommandInput, options?: __HttpHandlerOptions): Promise; + startJobRun(args: StartJobRunCommandInput, cb: (err: any, data?: StartJobRunCommandOutput) => void): void; + startJobRun( args: StartJobRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartJobRunCommandOutput) => void ): void; - public startJobRun( - args: StartJobRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartJobRunCommandOutput) => void), - cb?: (err: any, data?: StartJobRunCommandOutput) => void - ): Promise | void { - const command = new StartJobRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops a specified application and releases initial capacity if configured. All scheduled - * and running jobs must be completed or cancelled before stopping an application.

+ * @see {@link StopApplicationCommand} */ - public stopApplication( + stopApplication( args: StopApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopApplication( - args: StopApplicationCommandInput, - cb: (err: any, data?: StopApplicationCommandOutput) => void - ): void; - public stopApplication( + stopApplication(args: StopApplicationCommandInput, cb: (err: any, data?: StopApplicationCommandOutput) => void): void; + stopApplication( args: StopApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopApplicationCommandOutput) => void ): void; - public stopApplication( - args: StopApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopApplicationCommandOutput) => void), - cb?: (err: any, data?: StopApplicationCommandOutput) => void - ): Promise | void { - const command = new StopApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns tags to resources. A tag is a label that you assign to an Amazon Web Services - * resource. Each tag consists of a key and an optional value, both of which you define. Tags - * enable you to categorize your Amazon Web Services resources by attributes such as purpose, - * owner, or environment. When you have many resources of the same type, you can quickly - * identify a specific resource based on the tags you've assigned to it.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from resources.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a specified application. An application has to be in a stopped or created state - * in order to be updated.

+ * @see {@link UpdateApplicationCommand} */ - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( - args: UpdateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApplicationCommandOutput) => void), - cb?: (err: any, data?: UpdateApplicationCommandOutput) => void - ): Promise | void { - const command = new UpdateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon EMR Serverless is a new deployment option for Amazon EMR. EMR Serverless provides + * a serverless runtime environment that simplifies running analytics applications using the + * latest open source frameworks such as Apache Spark and Apache Hive. With EMR Serverless, + * you don’t have to configure, optimize, secure, or operate clusters to run applications with + * these frameworks.

+ *

The API reference to Amazon EMR Serverless is emr-serverless. The + * emr-serverless prefix is used in the following scenarios:

+ *
    + *
  • + *

    It is the prefix in the CLI commands for Amazon EMR Serverless. For example, + * aws emr-serverless start-job-run.

    + *
  • + *
  • + *

    It is the prefix before IAM policy actions for Amazon EMR Serverless. For example, + * "Action": ["emr-serverless:StartJobRun"]. For more information, see + * Policy actions for Amazon EMR Serverless.

    + *
  • + *
  • + *

    It is the prefix used in Amazon EMR Serverless service endpoints. For example, + * emr-serverless.us-east-2.amazonaws.com.

    + *
  • + *
+ */ +export class EMRServerless extends EMRServerlessClient implements EMRServerless {} +createAggregatedClient(commands, EMRServerless); diff --git a/clients/client-emr/src/EMR.ts b/clients/client-emr/src/EMR.ts index ea274ca1c71e..424f1dbf1adf 100644 --- a/clients/client-emr/src/EMR.ts +++ b/clients/client-emr/src/EMR.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -242,1886 +243,885 @@ import { UpdateStudioSessionMappingCommandInput, UpdateStudioSessionMappingCommandOutput, } from "./commands/UpdateStudioSessionMappingCommand"; -import { EMRClient } from "./EMRClient"; +import { EMRClient, EMRClientConfig } from "./EMRClient"; -/** - * @public - *

Amazon EMR is a web service that makes it easier to process large amounts of - * data efficiently. Amazon EMR uses Hadoop processing combined with several Amazon Web Services services to do tasks such as web indexing, data mining, log file analysis, - * machine learning, scientific simulation, and data warehouse management.

- */ -export class EMR extends EMRClient { +const commands = { + AddInstanceFleetCommand, + AddInstanceGroupsCommand, + AddJobFlowStepsCommand, + AddTagsCommand, + CancelStepsCommand, + CreateSecurityConfigurationCommand, + CreateStudioCommand, + CreateStudioSessionMappingCommand, + DeleteSecurityConfigurationCommand, + DeleteStudioCommand, + DeleteStudioSessionMappingCommand, + DescribeClusterCommand, + DescribeJobFlowsCommand, + DescribeNotebookExecutionCommand, + DescribeReleaseLabelCommand, + DescribeSecurityConfigurationCommand, + DescribeStepCommand, + DescribeStudioCommand, + GetAutoTerminationPolicyCommand, + GetBlockPublicAccessConfigurationCommand, + GetClusterSessionCredentialsCommand, + GetManagedScalingPolicyCommand, + GetStudioSessionMappingCommand, + ListBootstrapActionsCommand, + ListClustersCommand, + ListInstanceFleetsCommand, + ListInstanceGroupsCommand, + ListInstancesCommand, + ListNotebookExecutionsCommand, + ListReleaseLabelsCommand, + ListSecurityConfigurationsCommand, + ListStepsCommand, + ListStudiosCommand, + ListStudioSessionMappingsCommand, + ModifyClusterCommand, + ModifyInstanceFleetCommand, + ModifyInstanceGroupsCommand, + PutAutoScalingPolicyCommand, + PutAutoTerminationPolicyCommand, + PutBlockPublicAccessConfigurationCommand, + PutManagedScalingPolicyCommand, + RemoveAutoScalingPolicyCommand, + RemoveAutoTerminationPolicyCommand, + RemoveManagedScalingPolicyCommand, + RemoveTagsCommand, + RunJobFlowCommand, + SetTerminationProtectionCommand, + SetVisibleToAllUsersCommand, + StartNotebookExecutionCommand, + StopNotebookExecutionCommand, + TerminateJobFlowsCommand, + UpdateStudioCommand, + UpdateStudioSessionMappingCommand, +}; + +export interface EMR { /** - * @public - *

Adds an instance fleet to a running cluster.

- * - *

The instance fleet configuration is available only in Amazon EMR versions - * 4.8.0 and later, excluding 5.0.x.

- *
+ * @see {@link AddInstanceFleetCommand} */ - public addInstanceFleet( + addInstanceFleet( args: AddInstanceFleetCommandInput, options?: __HttpHandlerOptions ): Promise; - public addInstanceFleet( + addInstanceFleet( args: AddInstanceFleetCommandInput, cb: (err: any, data?: AddInstanceFleetCommandOutput) => void ): void; - public addInstanceFleet( + addInstanceFleet( args: AddInstanceFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddInstanceFleetCommandOutput) => void ): void; - public addInstanceFleet( - args: AddInstanceFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddInstanceFleetCommandOutput) => void), - cb?: (err: any, data?: AddInstanceFleetCommandOutput) => void - ): Promise | void { - const command = new AddInstanceFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more instance groups to a running cluster.

+ * @see {@link AddInstanceGroupsCommand} */ - public addInstanceGroups( + addInstanceGroups( args: AddInstanceGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public addInstanceGroups( + addInstanceGroups( args: AddInstanceGroupsCommandInput, cb: (err: any, data?: AddInstanceGroupsCommandOutput) => void ): void; - public addInstanceGroups( + addInstanceGroups( args: AddInstanceGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddInstanceGroupsCommandOutput) => void ): void; - public addInstanceGroups( - args: AddInstanceGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddInstanceGroupsCommandOutput) => void), - cb?: (err: any, data?: AddInstanceGroupsCommandOutput) => void - ): Promise | void { - const command = new AddInstanceGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

AddJobFlowSteps adds new steps to a running cluster. A maximum of 256 steps are allowed - * in each job flow.

- *

If your cluster is long-running (such as a Hive data warehouse) or complex, you may - * require more than 256 steps to process your data. You can bypass the 256-step limitation in - * various ways, including using SSH to connect to the master node and submitting queries - * directly to the software running on the master node, such as Hive and Hadoop.

- *

A step specifies the location of a JAR file stored either on the master node of the - * cluster or in Amazon S3. Each step is performed by the main function of the main - * class of the JAR file. The main class can be specified either in the manifest of the JAR or - * by using the MainFunction parameter of the step.

- *

Amazon EMR executes each step in the order listed. For a step to be considered - * complete, the main function must exit with a zero exit code and all Hadoop jobs started - * while the step was running must have completed and run successfully.

- *

You can only add steps to a cluster that is in one of the following states: STARTING, - * BOOTSTRAPPING, RUNNING, or WAITING.

- * - *

The string values passed into HadoopJarStep object cannot exceed a total - * of 10240 characters.

- *
+ * @see {@link AddJobFlowStepsCommand} */ - public addJobFlowSteps( + addJobFlowSteps( args: AddJobFlowStepsCommandInput, options?: __HttpHandlerOptions ): Promise; - public addJobFlowSteps( - args: AddJobFlowStepsCommandInput, - cb: (err: any, data?: AddJobFlowStepsCommandOutput) => void - ): void; - public addJobFlowSteps( + addJobFlowSteps(args: AddJobFlowStepsCommandInput, cb: (err: any, data?: AddJobFlowStepsCommandOutput) => void): void; + addJobFlowSteps( args: AddJobFlowStepsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddJobFlowStepsCommandOutput) => void ): void; - public addJobFlowSteps( - args: AddJobFlowStepsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddJobFlowStepsCommandOutput) => void), - cb?: (err: any, data?: AddJobFlowStepsCommandOutput) => void - ): Promise | void { - const command = new AddJobFlowStepsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds tags to an Amazon EMR resource, such as a cluster or an Amazon EMR - * Studio. Tags make it easier to associate resources in various ways, such as grouping - * clusters to track your Amazon EMR resource allocation costs. For more information, - * see Tag - * Clusters.

+ * @see {@link AddTagsCommand} */ - public addTags(args: AddTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public addTags(args: AddTagsCommandInput, cb: (err: any, data?: AddTagsCommandOutput) => void): void; - public addTags( + addTags(args: AddTagsCommandInput, options?: __HttpHandlerOptions): Promise; + addTags(args: AddTagsCommandInput, cb: (err: any, data?: AddTagsCommandOutput) => void): void; + addTags( args: AddTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsCommandOutput) => void ): void; - public addTags( - args: AddTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddTagsCommandOutput) => void), - cb?: (err: any, data?: AddTagsCommandOutput) => void - ): Promise | void { - const command = new AddTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in - * each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee - * that a step will be canceled, even if the request is successfully submitted. When you use - * Amazon EMR versions 5.28.0 and later, you can cancel steps that are in a - * PENDING or RUNNING state. In earlier versions of Amazon EMR, you can only cancel steps that are in a PENDING state.

+ * @see {@link CancelStepsCommand} */ - public cancelSteps(args: CancelStepsCommandInput, options?: __HttpHandlerOptions): Promise; - public cancelSteps(args: CancelStepsCommandInput, cb: (err: any, data?: CancelStepsCommandOutput) => void): void; - public cancelSteps( + cancelSteps(args: CancelStepsCommandInput, options?: __HttpHandlerOptions): Promise; + cancelSteps(args: CancelStepsCommandInput, cb: (err: any, data?: CancelStepsCommandOutput) => void): void; + cancelSteps( args: CancelStepsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelStepsCommandOutput) => void ): void; - public cancelSteps( - args: CancelStepsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelStepsCommandOutput) => void), - cb?: (err: any, data?: CancelStepsCommandOutput) => void - ): Promise | void { - const command = new CancelStepsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a security configuration, which is stored in the service and can be specified - * when a cluster is created.

+ * @see {@link CreateSecurityConfigurationCommand} */ - public createSecurityConfiguration( + createSecurityConfiguration( args: CreateSecurityConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSecurityConfiguration( + createSecurityConfiguration( args: CreateSecurityConfigurationCommandInput, cb: (err: any, data?: CreateSecurityConfigurationCommandOutput) => void ): void; - public createSecurityConfiguration( + createSecurityConfiguration( args: CreateSecurityConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSecurityConfigurationCommandOutput) => void ): void; - public createSecurityConfiguration( - args: CreateSecurityConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSecurityConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateSecurityConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateSecurityConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new Amazon EMR Studio.

+ * @see {@link CreateStudioCommand} */ - public createStudio( - args: CreateStudioCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createStudio(args: CreateStudioCommandInput, cb: (err: any, data?: CreateStudioCommandOutput) => void): void; - public createStudio( + createStudio(args: CreateStudioCommandInput, options?: __HttpHandlerOptions): Promise; + createStudio(args: CreateStudioCommandInput, cb: (err: any, data?: CreateStudioCommandOutput) => void): void; + createStudio( args: CreateStudioCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStudioCommandOutput) => void ): void; - public createStudio( - args: CreateStudioCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStudioCommandOutput) => void), - cb?: (err: any, data?: CreateStudioCommandOutput) => void - ): Promise | void { - const command = new CreateStudioCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Maps a user or group to the Amazon EMR Studio specified by - * StudioId, and applies a session policy to refine Studio permissions for that - * user or group. Use CreateStudioSessionMapping to assign users to a Studio when - * you use IAM Identity Center authentication. For instructions on how to assign users to a - * Studio when you use IAM authentication, see Assign a user or group to your EMR Studio.

+ * @see {@link CreateStudioSessionMappingCommand} */ - public createStudioSessionMapping( + createStudioSessionMapping( args: CreateStudioSessionMappingCommandInput, options?: __HttpHandlerOptions ): Promise; - public createStudioSessionMapping( + createStudioSessionMapping( args: CreateStudioSessionMappingCommandInput, cb: (err: any, data?: CreateStudioSessionMappingCommandOutput) => void ): void; - public createStudioSessionMapping( + createStudioSessionMapping( args: CreateStudioSessionMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStudioSessionMappingCommandOutput) => void ): void; - public createStudioSessionMapping( - args: CreateStudioSessionMappingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStudioSessionMappingCommandOutput) => void), - cb?: (err: any, data?: CreateStudioSessionMappingCommandOutput) => void - ): Promise | void { - const command = new CreateStudioSessionMappingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a security configuration.

+ * @see {@link DeleteSecurityConfigurationCommand} */ - public deleteSecurityConfiguration( + deleteSecurityConfiguration( args: DeleteSecurityConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSecurityConfiguration( + deleteSecurityConfiguration( args: DeleteSecurityConfigurationCommandInput, cb: (err: any, data?: DeleteSecurityConfigurationCommandOutput) => void ): void; - public deleteSecurityConfiguration( + deleteSecurityConfiguration( args: DeleteSecurityConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSecurityConfigurationCommandOutput) => void ): void; - public deleteSecurityConfiguration( - args: DeleteSecurityConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSecurityConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteSecurityConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteSecurityConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes an Amazon EMR Studio from the Studio metadata store.

+ * @see {@link DeleteStudioCommand} */ - public deleteStudio( - args: DeleteStudioCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteStudio(args: DeleteStudioCommandInput, cb: (err: any, data?: DeleteStudioCommandOutput) => void): void; - public deleteStudio( + deleteStudio(args: DeleteStudioCommandInput, options?: __HttpHandlerOptions): Promise; + deleteStudio(args: DeleteStudioCommandInput, cb: (err: any, data?: DeleteStudioCommandOutput) => void): void; + deleteStudio( args: DeleteStudioCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStudioCommandOutput) => void ): void; - public deleteStudio( - args: DeleteStudioCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStudioCommandOutput) => void), - cb?: (err: any, data?: DeleteStudioCommandOutput) => void - ): Promise | void { - const command = new DeleteStudioCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a user or group from an Amazon EMR Studio.

+ * @see {@link DeleteStudioSessionMappingCommand} */ - public deleteStudioSessionMapping( + deleteStudioSessionMapping( args: DeleteStudioSessionMappingCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteStudioSessionMapping( + deleteStudioSessionMapping( args: DeleteStudioSessionMappingCommandInput, cb: (err: any, data?: DeleteStudioSessionMappingCommandOutput) => void ): void; - public deleteStudioSessionMapping( + deleteStudioSessionMapping( args: DeleteStudioSessionMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStudioSessionMappingCommandOutput) => void ): void; - public deleteStudioSessionMapping( - args: DeleteStudioSessionMappingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStudioSessionMappingCommandOutput) => void), - cb?: (err: any, data?: DeleteStudioSessionMappingCommandOutput) => void - ): Promise | void { - const command = new DeleteStudioSessionMappingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides cluster-level details including status, hardware and software configuration, - * VPC settings, and so on.

+ * @see {@link DescribeClusterCommand} */ - public describeCluster( + describeCluster( args: DescribeClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCluster( - args: DescribeClusterCommandInput, - cb: (err: any, data?: DescribeClusterCommandOutput) => void - ): void; - public describeCluster( + describeCluster(args: DescribeClusterCommandInput, cb: (err: any, data?: DescribeClusterCommandOutput) => void): void; + describeCluster( args: DescribeClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClusterCommandOutput) => void ): void; - public describeCluster( - args: DescribeClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClusterCommandOutput) => void), - cb?: (err: any, data?: DescribeClusterCommandOutput) => void - ): Promise | void { - const command = new DescribeClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

This API is no longer supported and will eventually be removed. We recommend you use - * ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions instead.

- *

DescribeJobFlows returns a list of job flows that match all of the supplied parameters. - * The parameters can include a list of job flow IDs, job flow states, and restrictions on job - * flow creation date and time.

- *

Regardless of supplied parameters, only job flows created within the last two months are - * returned.

- *

If no parameters are supplied, then job flows matching either of the following criteria - * are returned:

- *
    - *
  • - *

    Job flows created and completed in the last two weeks

    - *
  • - *
  • - *

    Job flows created within the last two months that are in one of the following - * states: RUNNING, WAITING, SHUTTING_DOWN, - * STARTING - *

    - *
  • - *
- *

Amazon EMR can return a maximum of 512 job flow descriptions.

+ * @see {@link DescribeJobFlowsCommand} */ - public describeJobFlows( + describeJobFlows( args: DescribeJobFlowsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeJobFlows( + describeJobFlows( args: DescribeJobFlowsCommandInput, cb: (err: any, data?: DescribeJobFlowsCommandOutput) => void ): void; - public describeJobFlows( + describeJobFlows( args: DescribeJobFlowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobFlowsCommandOutput) => void ): void; - public describeJobFlows( - args: DescribeJobFlowsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeJobFlowsCommandOutput) => void), - cb?: (err: any, data?: DescribeJobFlowsCommandOutput) => void - ): Promise | void { - const command = new DescribeJobFlowsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides details of a notebook execution.

+ * @see {@link DescribeNotebookExecutionCommand} */ - public describeNotebookExecution( + describeNotebookExecution( args: DescribeNotebookExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNotebookExecution( + describeNotebookExecution( args: DescribeNotebookExecutionCommandInput, cb: (err: any, data?: DescribeNotebookExecutionCommandOutput) => void ): void; - public describeNotebookExecution( + describeNotebookExecution( args: DescribeNotebookExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNotebookExecutionCommandOutput) => void ): void; - public describeNotebookExecution( - args: DescribeNotebookExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeNotebookExecutionCommandOutput) => void), - cb?: (err: any, data?: DescribeNotebookExecutionCommandOutput) => void - ): Promise | void { - const command = new DescribeNotebookExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides EMR release label details, such as releases available the region where the API - * request is run, and the available applications for a specific EMR release label. Can also - * list EMR release versions that support a specified version of Spark.

+ * @see {@link DescribeReleaseLabelCommand} */ - public describeReleaseLabel( + describeReleaseLabel( args: DescribeReleaseLabelCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReleaseLabel( + describeReleaseLabel( args: DescribeReleaseLabelCommandInput, cb: (err: any, data?: DescribeReleaseLabelCommandOutput) => void ): void; - public describeReleaseLabel( + describeReleaseLabel( args: DescribeReleaseLabelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReleaseLabelCommandOutput) => void ): void; - public describeReleaseLabel( - args: DescribeReleaseLabelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReleaseLabelCommandOutput) => void), - cb?: (err: any, data?: DescribeReleaseLabelCommandOutput) => void - ): Promise | void { - const command = new DescribeReleaseLabelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides the details of a security configuration by returning the configuration - * JSON.

+ * @see {@link DescribeSecurityConfigurationCommand} */ - public describeSecurityConfiguration( + describeSecurityConfiguration( args: DescribeSecurityConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSecurityConfiguration( + describeSecurityConfiguration( args: DescribeSecurityConfigurationCommandInput, cb: (err: any, data?: DescribeSecurityConfigurationCommandOutput) => void ): void; - public describeSecurityConfiguration( + describeSecurityConfiguration( args: DescribeSecurityConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSecurityConfigurationCommandOutput) => void ): void; - public describeSecurityConfiguration( - args: DescribeSecurityConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSecurityConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeSecurityConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeSecurityConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides more detail about the cluster step.

+ * @see {@link DescribeStepCommand} */ - public describeStep( - args: DescribeStepCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeStep(args: DescribeStepCommandInput, cb: (err: any, data?: DescribeStepCommandOutput) => void): void; - public describeStep( + describeStep(args: DescribeStepCommandInput, options?: __HttpHandlerOptions): Promise; + describeStep(args: DescribeStepCommandInput, cb: (err: any, data?: DescribeStepCommandOutput) => void): void; + describeStep( args: DescribeStepCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStepCommandOutput) => void ): void; - public describeStep( - args: DescribeStepCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStepCommandOutput) => void), - cb?: (err: any, data?: DescribeStepCommandOutput) => void - ): Promise | void { - const command = new DescribeStepCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns details for the specified Amazon EMR Studio including ID, Name, VPC, - * Studio access URL, and so on.

+ * @see {@link DescribeStudioCommand} */ - public describeStudio( + describeStudio( args: DescribeStudioCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStudio( - args: DescribeStudioCommandInput, - cb: (err: any, data?: DescribeStudioCommandOutput) => void - ): void; - public describeStudio( + describeStudio(args: DescribeStudioCommandInput, cb: (err: any, data?: DescribeStudioCommandOutput) => void): void; + describeStudio( args: DescribeStudioCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStudioCommandOutput) => void ): void; - public describeStudio( - args: DescribeStudioCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStudioCommandOutput) => void), - cb?: (err: any, data?: DescribeStudioCommandOutput) => void - ): Promise | void { - const command = new DescribeStudioCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the auto-termination policy for an Amazon EMR cluster.

+ * @see {@link GetAutoTerminationPolicyCommand} */ - public getAutoTerminationPolicy( + getAutoTerminationPolicy( args: GetAutoTerminationPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAutoTerminationPolicy( + getAutoTerminationPolicy( args: GetAutoTerminationPolicyCommandInput, cb: (err: any, data?: GetAutoTerminationPolicyCommandOutput) => void ): void; - public getAutoTerminationPolicy( + getAutoTerminationPolicy( args: GetAutoTerminationPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAutoTerminationPolicyCommandOutput) => void ): void; - public getAutoTerminationPolicy( - args: GetAutoTerminationPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAutoTerminationPolicyCommandOutput) => void), - cb?: (err: any, data?: GetAutoTerminationPolicyCommandOutput) => void - ): Promise | void { - const command = new GetAutoTerminationPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the Amazon EMR block public access configuration for your Amazon Web Services account in the current Region. For more information see Configure Block - * Public Access for Amazon EMR in the Amazon EMR - * Management Guide.

+ * @see {@link GetBlockPublicAccessConfigurationCommand} */ - public getBlockPublicAccessConfiguration( + getBlockPublicAccessConfiguration( args: GetBlockPublicAccessConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBlockPublicAccessConfiguration( + getBlockPublicAccessConfiguration( args: GetBlockPublicAccessConfigurationCommandInput, cb: (err: any, data?: GetBlockPublicAccessConfigurationCommandOutput) => void ): void; - public getBlockPublicAccessConfiguration( + getBlockPublicAccessConfiguration( args: GetBlockPublicAccessConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBlockPublicAccessConfigurationCommandOutput) => void ): void; - public getBlockPublicAccessConfiguration( - args: GetBlockPublicAccessConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBlockPublicAccessConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetBlockPublicAccessConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetBlockPublicAccessConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides temporary, HTTP basic credentials that are associated with a given runtime IAM role - * and used by a cluster with fine-grained access control activated. You can use these credentials to connect to cluster endpoints that support username and password authentication.

+ * @see {@link GetClusterSessionCredentialsCommand} */ - public getClusterSessionCredentials( + getClusterSessionCredentials( args: GetClusterSessionCredentialsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getClusterSessionCredentials( + getClusterSessionCredentials( args: GetClusterSessionCredentialsCommandInput, cb: (err: any, data?: GetClusterSessionCredentialsCommandOutput) => void ): void; - public getClusterSessionCredentials( + getClusterSessionCredentials( args: GetClusterSessionCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetClusterSessionCredentialsCommandOutput) => void ): void; - public getClusterSessionCredentials( - args: GetClusterSessionCredentialsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetClusterSessionCredentialsCommandOutput) => void), - cb?: (err: any, data?: GetClusterSessionCredentialsCommandOutput) => void - ): Promise | void { - const command = new GetClusterSessionCredentialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Fetches the attached managed scaling policy for an Amazon EMR cluster.

+ * @see {@link GetManagedScalingPolicyCommand} */ - public getManagedScalingPolicy( + getManagedScalingPolicy( args: GetManagedScalingPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getManagedScalingPolicy( + getManagedScalingPolicy( args: GetManagedScalingPolicyCommandInput, cb: (err: any, data?: GetManagedScalingPolicyCommandOutput) => void ): void; - public getManagedScalingPolicy( + getManagedScalingPolicy( args: GetManagedScalingPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetManagedScalingPolicyCommandOutput) => void ): void; - public getManagedScalingPolicy( - args: GetManagedScalingPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetManagedScalingPolicyCommandOutput) => void), - cb?: (err: any, data?: GetManagedScalingPolicyCommandOutput) => void - ): Promise | void { - const command = new GetManagedScalingPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Fetches mapping details for the specified Amazon EMR Studio and identity (user - * or group).

+ * @see {@link GetStudioSessionMappingCommand} */ - public getStudioSessionMapping( + getStudioSessionMapping( args: GetStudioSessionMappingCommandInput, options?: __HttpHandlerOptions ): Promise; - public getStudioSessionMapping( + getStudioSessionMapping( args: GetStudioSessionMappingCommandInput, cb: (err: any, data?: GetStudioSessionMappingCommandOutput) => void ): void; - public getStudioSessionMapping( + getStudioSessionMapping( args: GetStudioSessionMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStudioSessionMappingCommandOutput) => void ): void; - public getStudioSessionMapping( - args: GetStudioSessionMappingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStudioSessionMappingCommandOutput) => void), - cb?: (err: any, data?: GetStudioSessionMappingCommandOutput) => void - ): Promise | void { - const command = new GetStudioSessionMappingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides information about the bootstrap actions associated with a cluster.

+ * @see {@link ListBootstrapActionsCommand} */ - public listBootstrapActions( + listBootstrapActions( args: ListBootstrapActionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBootstrapActions( + listBootstrapActions( args: ListBootstrapActionsCommandInput, cb: (err: any, data?: ListBootstrapActionsCommandOutput) => void ): void; - public listBootstrapActions( + listBootstrapActions( args: ListBootstrapActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBootstrapActionsCommandOutput) => void ): void; - public listBootstrapActions( - args: ListBootstrapActionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBootstrapActionsCommandOutput) => void), - cb?: (err: any, data?: ListBootstrapActionsCommandOutput) => void - ): Promise | void { - const command = new ListBootstrapActionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides the status of all clusters visible to this Amazon Web Services account. Allows - * you to filter the list of clusters based on certain criteria; for example, filtering by - * cluster creation date and time or by status. This call returns a maximum of 50 clusters in - * unsorted order per call, but returns a marker to track the paging of the cluster list - * across multiple ListClusters calls.

+ * @see {@link ListClustersCommand} */ - public listClusters( - args: ListClustersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listClusters(args: ListClustersCommandInput, cb: (err: any, data?: ListClustersCommandOutput) => void): void; - public listClusters( + listClusters(args: ListClustersCommandInput, options?: __HttpHandlerOptions): Promise; + listClusters(args: ListClustersCommandInput, cb: (err: any, data?: ListClustersCommandOutput) => void): void; + listClusters( args: ListClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListClustersCommandOutput) => void ): void; - public listClusters( - args: ListClustersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListClustersCommandOutput) => void), - cb?: (err: any, data?: ListClustersCommandOutput) => void - ): Promise | void { - const command = new ListClustersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all available details about the instance fleets in a cluster.

- * - *

The instance fleet configuration is available only in Amazon EMR versions - * 4.8.0 and later, excluding 5.0.x versions.

- *
+ * @see {@link ListInstanceFleetsCommand} */ - public listInstanceFleets( + listInstanceFleets( args: ListInstanceFleetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInstanceFleets( + listInstanceFleets( args: ListInstanceFleetsCommandInput, cb: (err: any, data?: ListInstanceFleetsCommandOutput) => void ): void; - public listInstanceFleets( + listInstanceFleets( args: ListInstanceFleetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInstanceFleetsCommandOutput) => void ): void; - public listInstanceFleets( - args: ListInstanceFleetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInstanceFleetsCommandOutput) => void), - cb?: (err: any, data?: ListInstanceFleetsCommandOutput) => void - ): Promise | void { - const command = new ListInstanceFleetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides all available details about the instance groups in a cluster.

+ * @see {@link ListInstanceGroupsCommand} */ - public listInstanceGroups( + listInstanceGroups( args: ListInstanceGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInstanceGroups( + listInstanceGroups( args: ListInstanceGroupsCommandInput, cb: (err: any, data?: ListInstanceGroupsCommandOutput) => void ): void; - public listInstanceGroups( + listInstanceGroups( args: ListInstanceGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInstanceGroupsCommandOutput) => void ): void; - public listInstanceGroups( - args: ListInstanceGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInstanceGroupsCommandOutput) => void), - cb?: (err: any, data?: ListInstanceGroupsCommandOutput) => void - ): Promise | void { - const command = new ListInstanceGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides information for all active EC2 instances and EC2 instances terminated in the - * last 30 days, up to a maximum of 2,000. EC2 instances in any of the following states are - * considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING.

+ * @see {@link ListInstancesCommand} */ - public listInstances( - args: ListInstancesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listInstances( - args: ListInstancesCommandInput, - cb: (err: any, data?: ListInstancesCommandOutput) => void - ): void; - public listInstances( + listInstances(args: ListInstancesCommandInput, options?: __HttpHandlerOptions): Promise; + listInstances(args: ListInstancesCommandInput, cb: (err: any, data?: ListInstancesCommandOutput) => void): void; + listInstances( args: ListInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInstancesCommandOutput) => void ): void; - public listInstances( - args: ListInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInstancesCommandOutput) => void), - cb?: (err: any, data?: ListInstancesCommandOutput) => void - ): Promise | void { - const command = new ListInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides summaries of all notebook executions. You can filter the list based on multiple - * criteria such as status, time range, and editor id. Returns a maximum of 50 notebook - * executions and a marker to track the paging of a longer notebook execution list across - * multiple ListNotebookExecution calls.

+ * @see {@link ListNotebookExecutionsCommand} */ - public listNotebookExecutions( + listNotebookExecutions( args: ListNotebookExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listNotebookExecutions( + listNotebookExecutions( args: ListNotebookExecutionsCommandInput, cb: (err: any, data?: ListNotebookExecutionsCommandOutput) => void ): void; - public listNotebookExecutions( + listNotebookExecutions( args: ListNotebookExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNotebookExecutionsCommandOutput) => void ): void; - public listNotebookExecutions( - args: ListNotebookExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNotebookExecutionsCommandOutput) => void), - cb?: (err: any, data?: ListNotebookExecutionsCommandOutput) => void - ): Promise | void { - const command = new ListNotebookExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves release labels of EMR services in the region where the API is called.

+ * @see {@link ListReleaseLabelsCommand} */ - public listReleaseLabels( + listReleaseLabels( args: ListReleaseLabelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReleaseLabels( + listReleaseLabels( args: ListReleaseLabelsCommandInput, cb: (err: any, data?: ListReleaseLabelsCommandOutput) => void ): void; - public listReleaseLabels( + listReleaseLabels( args: ListReleaseLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReleaseLabelsCommandOutput) => void ): void; - public listReleaseLabels( - args: ListReleaseLabelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReleaseLabelsCommandOutput) => void), - cb?: (err: any, data?: ListReleaseLabelsCommandOutput) => void - ): Promise | void { - const command = new ListReleaseLabelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the security configurations visible to this account, providing their creation - * dates and times, and their names. This call returns a maximum of 50 clusters per call, but - * returns a marker to track the paging of the cluster list across multiple - * ListSecurityConfigurations calls.

+ * @see {@link ListSecurityConfigurationsCommand} */ - public listSecurityConfigurations( + listSecurityConfigurations( args: ListSecurityConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSecurityConfigurations( + listSecurityConfigurations( args: ListSecurityConfigurationsCommandInput, cb: (err: any, data?: ListSecurityConfigurationsCommandOutput) => void ): void; - public listSecurityConfigurations( + listSecurityConfigurations( args: ListSecurityConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSecurityConfigurationsCommandOutput) => void ): void; - public listSecurityConfigurations( - args: ListSecurityConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSecurityConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListSecurityConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListSecurityConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a list of steps for the cluster in reverse order unless you specify - * stepIds with the request or filter by StepStates. You can - * specify a maximum of 10 stepIDs. The CLI automatically - * paginates results to return a list greater than 50 steps. To return more than 50 steps - * using the CLI, specify a Marker, which is a pagination token - * that indicates the next set of steps to retrieve.

+ * @see {@link ListStepsCommand} */ - public listSteps(args: ListStepsCommandInput, options?: __HttpHandlerOptions): Promise; - public listSteps(args: ListStepsCommandInput, cb: (err: any, data?: ListStepsCommandOutput) => void): void; - public listSteps( + listSteps(args: ListStepsCommandInput, options?: __HttpHandlerOptions): Promise; + listSteps(args: ListStepsCommandInput, cb: (err: any, data?: ListStepsCommandOutput) => void): void; + listSteps( args: ListStepsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStepsCommandOutput) => void ): void; - public listSteps( - args: ListStepsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStepsCommandOutput) => void), - cb?: (err: any, data?: ListStepsCommandOutput) => void - ): Promise | void { - const command = new ListStepsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all Amazon EMR Studios associated with the Amazon Web Services account. The list includes details such as ID, Studio Access URL, and - * creation time for each Studio.

+ * @see {@link ListStudiosCommand} */ - public listStudios(args: ListStudiosCommandInput, options?: __HttpHandlerOptions): Promise; - public listStudios(args: ListStudiosCommandInput, cb: (err: any, data?: ListStudiosCommandOutput) => void): void; - public listStudios( + listStudios(args: ListStudiosCommandInput, options?: __HttpHandlerOptions): Promise; + listStudios(args: ListStudiosCommandInput, cb: (err: any, data?: ListStudiosCommandOutput) => void): void; + listStudios( args: ListStudiosCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStudiosCommandOutput) => void ): void; - public listStudios( - args: ListStudiosCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStudiosCommandOutput) => void), - cb?: (err: any, data?: ListStudiosCommandOutput) => void - ): Promise | void { - const command = new ListStudiosCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all user or group session mappings for the Amazon EMR Studio - * specified by StudioId.

+ * @see {@link ListStudioSessionMappingsCommand} */ - public listStudioSessionMappings( + listStudioSessionMappings( args: ListStudioSessionMappingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStudioSessionMappings( + listStudioSessionMappings( args: ListStudioSessionMappingsCommandInput, cb: (err: any, data?: ListStudioSessionMappingsCommandOutput) => void ): void; - public listStudioSessionMappings( + listStudioSessionMappings( args: ListStudioSessionMappingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStudioSessionMappingsCommandOutput) => void ): void; - public listStudioSessionMappings( - args: ListStudioSessionMappingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStudioSessionMappingsCommandOutput) => void), - cb?: (err: any, data?: ListStudioSessionMappingsCommandOutput) => void - ): Promise | void { - const command = new ListStudioSessionMappingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the number of steps that can be executed concurrently for the cluster specified - * using ClusterID.

+ * @see {@link ModifyClusterCommand} */ - public modifyCluster( - args: ModifyClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public modifyCluster( - args: ModifyClusterCommandInput, - cb: (err: any, data?: ModifyClusterCommandOutput) => void - ): void; - public modifyCluster( + modifyCluster(args: ModifyClusterCommandInput, options?: __HttpHandlerOptions): Promise; + modifyCluster(args: ModifyClusterCommandInput, cb: (err: any, data?: ModifyClusterCommandOutput) => void): void; + modifyCluster( args: ModifyClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyClusterCommandOutput) => void ): void; - public modifyCluster( - args: ModifyClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyClusterCommandOutput) => void), - cb?: (err: any, data?: ModifyClusterCommandOutput) => void - ): Promise | void { - const command = new ModifyClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the target On-Demand and target Spot capacities for the instance fleet with the - * specified InstanceFleetID within the cluster specified using ClusterID. The call either - * succeeds or fails atomically.

- * - *

The instance fleet configuration is available only in Amazon EMR versions - * 4.8.0 and later, excluding 5.0.x versions.

- *
+ * @see {@link ModifyInstanceFleetCommand} */ - public modifyInstanceFleet( + modifyInstanceFleet( args: ModifyInstanceFleetCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyInstanceFleet( + modifyInstanceFleet( args: ModifyInstanceFleetCommandInput, cb: (err: any, data?: ModifyInstanceFleetCommandOutput) => void ): void; - public modifyInstanceFleet( + modifyInstanceFleet( args: ModifyInstanceFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyInstanceFleetCommandOutput) => void ): void; - public modifyInstanceFleet( - args: ModifyInstanceFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyInstanceFleetCommandOutput) => void), - cb?: (err: any, data?: ModifyInstanceFleetCommandOutput) => void - ): Promise | void { - const command = new ModifyInstanceFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

ModifyInstanceGroups modifies the number of nodes and configuration settings of an - * instance group. The input parameters include the new target instance count for the group - * and the instance group ID. The call will either succeed or fail atomically.

+ * @see {@link ModifyInstanceGroupsCommand} */ - public modifyInstanceGroups( + modifyInstanceGroups( args: ModifyInstanceGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyInstanceGroups( + modifyInstanceGroups( args: ModifyInstanceGroupsCommandInput, cb: (err: any, data?: ModifyInstanceGroupsCommandOutput) => void ): void; - public modifyInstanceGroups( + modifyInstanceGroups( args: ModifyInstanceGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyInstanceGroupsCommandOutput) => void ): void; - public modifyInstanceGroups( - args: ModifyInstanceGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyInstanceGroupsCommandOutput) => void), - cb?: (err: any, data?: ModifyInstanceGroupsCommandOutput) => void - ): Promise | void { - const command = new ModifyInstanceGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates an automatic scaling policy for a core instance group or task - * instance group in an Amazon EMR cluster. The automatic scaling policy defines how - * an instance group dynamically adds and terminates EC2 instances in response to the value of - * a CloudWatch metric.

+ * @see {@link PutAutoScalingPolicyCommand} */ - public putAutoScalingPolicy( + putAutoScalingPolicy( args: PutAutoScalingPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAutoScalingPolicy( + putAutoScalingPolicy( args: PutAutoScalingPolicyCommandInput, cb: (err: any, data?: PutAutoScalingPolicyCommandOutput) => void ): void; - public putAutoScalingPolicy( + putAutoScalingPolicy( args: PutAutoScalingPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAutoScalingPolicyCommandOutput) => void ): void; - public putAutoScalingPolicy( - args: PutAutoScalingPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAutoScalingPolicyCommandOutput) => void), - cb?: (err: any, data?: PutAutoScalingPolicyCommandOutput) => void - ): Promise | void { - const command = new PutAutoScalingPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

Auto-termination is supported in Amazon EMR versions 5.30.0 and 6.1.0 and - * later. For more information, see Using an - * auto-termination policy.

- *
- *

Creates or updates an auto-termination policy for an Amazon EMR cluster. An - * auto-termination policy defines the amount of idle time in seconds after which a cluster - * automatically terminates. For alternative cluster termination options, see Control - * cluster termination.

+ * @see {@link PutAutoTerminationPolicyCommand} */ - public putAutoTerminationPolicy( + putAutoTerminationPolicy( args: PutAutoTerminationPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAutoTerminationPolicy( + putAutoTerminationPolicy( args: PutAutoTerminationPolicyCommandInput, cb: (err: any, data?: PutAutoTerminationPolicyCommandOutput) => void ): void; - public putAutoTerminationPolicy( + putAutoTerminationPolicy( args: PutAutoTerminationPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAutoTerminationPolicyCommandOutput) => void ): void; - public putAutoTerminationPolicy( - args: PutAutoTerminationPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAutoTerminationPolicyCommandOutput) => void), - cb?: (err: any, data?: PutAutoTerminationPolicyCommandOutput) => void - ): Promise | void { - const command = new PutAutoTerminationPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates an Amazon EMR block public access configuration for your - * Amazon Web Services account in the current Region. For more information see Configure Block - * Public Access for Amazon EMR in the Amazon EMR - * Management Guide.

+ * @see {@link PutBlockPublicAccessConfigurationCommand} */ - public putBlockPublicAccessConfiguration( + putBlockPublicAccessConfiguration( args: PutBlockPublicAccessConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBlockPublicAccessConfiguration( + putBlockPublicAccessConfiguration( args: PutBlockPublicAccessConfigurationCommandInput, cb: (err: any, data?: PutBlockPublicAccessConfigurationCommandOutput) => void ): void; - public putBlockPublicAccessConfiguration( + putBlockPublicAccessConfiguration( args: PutBlockPublicAccessConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBlockPublicAccessConfigurationCommandOutput) => void ): void; - public putBlockPublicAccessConfiguration( - args: PutBlockPublicAccessConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBlockPublicAccessConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutBlockPublicAccessConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutBlockPublicAccessConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates a managed scaling policy for an Amazon EMR cluster. The - * managed scaling policy defines the limits for resources, such as EC2 instances that can be - * added or terminated from a cluster. The policy only applies to the core and task nodes. The - * master node cannot be scaled after initial configuration.

+ * @see {@link PutManagedScalingPolicyCommand} */ - public putManagedScalingPolicy( + putManagedScalingPolicy( args: PutManagedScalingPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putManagedScalingPolicy( + putManagedScalingPolicy( args: PutManagedScalingPolicyCommandInput, cb: (err: any, data?: PutManagedScalingPolicyCommandOutput) => void ): void; - public putManagedScalingPolicy( + putManagedScalingPolicy( args: PutManagedScalingPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutManagedScalingPolicyCommandOutput) => void ): void; - public putManagedScalingPolicy( - args: PutManagedScalingPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutManagedScalingPolicyCommandOutput) => void), - cb?: (err: any, data?: PutManagedScalingPolicyCommandOutput) => void - ): Promise | void { - const command = new PutManagedScalingPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes an automatic scaling policy from a specified instance group within an EMR - * cluster.

+ * @see {@link RemoveAutoScalingPolicyCommand} */ - public removeAutoScalingPolicy( + removeAutoScalingPolicy( args: RemoveAutoScalingPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeAutoScalingPolicy( + removeAutoScalingPolicy( args: RemoveAutoScalingPolicyCommandInput, cb: (err: any, data?: RemoveAutoScalingPolicyCommandOutput) => void ): void; - public removeAutoScalingPolicy( + removeAutoScalingPolicy( args: RemoveAutoScalingPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveAutoScalingPolicyCommandOutput) => void ): void; - public removeAutoScalingPolicy( - args: RemoveAutoScalingPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveAutoScalingPolicyCommandOutput) => void), - cb?: (err: any, data?: RemoveAutoScalingPolicyCommandOutput) => void - ): Promise | void { - const command = new RemoveAutoScalingPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes an auto-termination policy from an Amazon EMR cluster.

+ * @see {@link RemoveAutoTerminationPolicyCommand} */ - public removeAutoTerminationPolicy( + removeAutoTerminationPolicy( args: RemoveAutoTerminationPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeAutoTerminationPolicy( + removeAutoTerminationPolicy( args: RemoveAutoTerminationPolicyCommandInput, cb: (err: any, data?: RemoveAutoTerminationPolicyCommandOutput) => void ): void; - public removeAutoTerminationPolicy( + removeAutoTerminationPolicy( args: RemoveAutoTerminationPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveAutoTerminationPolicyCommandOutput) => void ): void; - public removeAutoTerminationPolicy( - args: RemoveAutoTerminationPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveAutoTerminationPolicyCommandOutput) => void), - cb?: (err: any, data?: RemoveAutoTerminationPolicyCommandOutput) => void - ): Promise | void { - const command = new RemoveAutoTerminationPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a managed scaling policy from a specified EMR cluster.

+ * @see {@link RemoveManagedScalingPolicyCommand} */ - public removeManagedScalingPolicy( + removeManagedScalingPolicy( args: RemoveManagedScalingPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeManagedScalingPolicy( + removeManagedScalingPolicy( args: RemoveManagedScalingPolicyCommandInput, cb: (err: any, data?: RemoveManagedScalingPolicyCommandOutput) => void ): void; - public removeManagedScalingPolicy( + removeManagedScalingPolicy( args: RemoveManagedScalingPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveManagedScalingPolicyCommandOutput) => void ): void; - public removeManagedScalingPolicy( - args: RemoveManagedScalingPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveManagedScalingPolicyCommandOutput) => void), - cb?: (err: any, data?: RemoveManagedScalingPolicyCommandOutput) => void - ): Promise | void { - const command = new RemoveManagedScalingPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from an Amazon EMR resource, such as a cluster or Amazon EMR Studio. Tags make it easier to associate resources in various ways, such as grouping - * clusters to track your Amazon EMR resource allocation costs. For more information, - * see Tag - * Clusters.

- *

The following example removes the stack tag with value Prod from a cluster:

+ * @see {@link RemoveTagsCommand} */ - public removeTags(args: RemoveTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public removeTags(args: RemoveTagsCommandInput, cb: (err: any, data?: RemoveTagsCommandOutput) => void): void; - public removeTags( + removeTags(args: RemoveTagsCommandInput, options?: __HttpHandlerOptions): Promise; + removeTags(args: RemoveTagsCommandInput, cb: (err: any, data?: RemoveTagsCommandOutput) => void): void; + removeTags( args: RemoveTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsCommandOutput) => void ): void; - public removeTags( - args: RemoveTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveTagsCommandOutput) => void), - cb?: (err: any, data?: RemoveTagsCommandOutput) => void - ): Promise | void { - const command = new RemoveTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

RunJobFlow creates and starts running a new cluster (job flow). The cluster runs the - * steps specified. After the steps complete, the cluster stops and the HDFS partition is - * lost. To prevent loss of data, configure the last step of the job flow to store results in - * Amazon S3. If the JobFlowInstancesConfig - * KeepJobFlowAliveWhenNoSteps parameter is set to TRUE, the cluster - * transitions to the WAITING state rather than shutting down after the steps have completed.

- *

For additional protection, you can set the JobFlowInstancesConfig - * TerminationProtected parameter to TRUE to lock the cluster and - * prevent it from being terminated by API call, user intervention, or in the event of a job - * flow error.

- *

A maximum of 256 steps are allowed in each job flow.

- *

If your cluster is long-running (such as a Hive data warehouse) or complex, you may - * require more than 256 steps to process your data. You can bypass the 256-step limitation in - * various ways, including using the SSH shell to connect to the master node and submitting - * queries directly to the software running on the master node, such as Hive and - * Hadoop.

- *

For long-running clusters, we recommend that you periodically store your results.

- * - *

The instance fleets configuration is available only in Amazon EMR versions - * 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can contain - * InstanceFleets parameters or InstanceGroups parameters, but not both.

- *
+ * @see {@link RunJobFlowCommand} */ - public runJobFlow(args: RunJobFlowCommandInput, options?: __HttpHandlerOptions): Promise; - public runJobFlow(args: RunJobFlowCommandInput, cb: (err: any, data?: RunJobFlowCommandOutput) => void): void; - public runJobFlow( + runJobFlow(args: RunJobFlowCommandInput, options?: __HttpHandlerOptions): Promise; + runJobFlow(args: RunJobFlowCommandInput, cb: (err: any, data?: RunJobFlowCommandOutput) => void): void; + runJobFlow( args: RunJobFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RunJobFlowCommandOutput) => void ): void; - public runJobFlow( - args: RunJobFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RunJobFlowCommandOutput) => void), - cb?: (err: any, data?: RunJobFlowCommandOutput) => void - ): Promise | void { - const command = new RunJobFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

SetTerminationProtection locks a cluster (job flow) so the EC2 instances in the cluster - * cannot be terminated by user intervention, an API call, or in the event of a job-flow - * error. The cluster still terminates upon successful completion of the job flow. Calling - * SetTerminationProtection on a cluster is similar to calling the Amazon EC2 - * DisableAPITermination API on all EC2 instances in a cluster.

- *

- * SetTerminationProtection is used to prevent accidental termination of a - * cluster and to ensure that in the event of an error, the instances persist so that you can - * recover any data stored in their ephemeral instance storage.

- *

To terminate a cluster that has been locked by setting - * SetTerminationProtection to true, you must first unlock the - * job flow by a subsequent call to SetTerminationProtection in which you set the - * value to false.

- *

For more information, seeManaging Cluster - * Termination in the Amazon EMR Management Guide.

+ * @see {@link SetTerminationProtectionCommand} */ - public setTerminationProtection( + setTerminationProtection( args: SetTerminationProtectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public setTerminationProtection( + setTerminationProtection( args: SetTerminationProtectionCommandInput, cb: (err: any, data?: SetTerminationProtectionCommandOutput) => void ): void; - public setTerminationProtection( + setTerminationProtection( args: SetTerminationProtectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetTerminationProtectionCommandOutput) => void ): void; - public setTerminationProtection( - args: SetTerminationProtectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetTerminationProtectionCommandOutput) => void), - cb?: (err: any, data?: SetTerminationProtectionCommandOutput) => void - ): Promise | void { - const command = new SetTerminationProtectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

The SetVisibleToAllUsers parameter is no longer supported. Your cluster may be - * visible to all users in your account. To restrict cluster access using an IAM policy, see Identity and Access - * Management for EMR.

- *
- *

Sets the Cluster$VisibleToAllUsers value for an EMR cluster. When - * true, IAM principals in the Amazon Web Services account can perform EMR - * cluster actions that their IAM policies allow. When false, only - * the IAM principal that created the cluster and the Amazon Web Services account root user can - * perform EMR actions on the cluster, regardless of IAM permissions policies attached to - * other IAM principals.

- *

This action works on running clusters. When you create a cluster, use the RunJobFlowInput$VisibleToAllUsers parameter.

- *

For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the - * Amazon EMRManagement Guide.

+ * @see {@link SetVisibleToAllUsersCommand} */ - public setVisibleToAllUsers( + setVisibleToAllUsers( args: SetVisibleToAllUsersCommandInput, options?: __HttpHandlerOptions ): Promise; - public setVisibleToAllUsers( + setVisibleToAllUsers( args: SetVisibleToAllUsersCommandInput, cb: (err: any, data?: SetVisibleToAllUsersCommandOutput) => void ): void; - public setVisibleToAllUsers( + setVisibleToAllUsers( args: SetVisibleToAllUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetVisibleToAllUsersCommandOutput) => void ): void; - public setVisibleToAllUsers( - args: SetVisibleToAllUsersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetVisibleToAllUsersCommandOutput) => void), - cb?: (err: any, data?: SetVisibleToAllUsersCommandOutput) => void - ): Promise | void { - const command = new SetVisibleToAllUsersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a notebook execution.

+ * @see {@link StartNotebookExecutionCommand} */ - public startNotebookExecution( + startNotebookExecution( args: StartNotebookExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startNotebookExecution( + startNotebookExecution( args: StartNotebookExecutionCommandInput, cb: (err: any, data?: StartNotebookExecutionCommandOutput) => void ): void; - public startNotebookExecution( + startNotebookExecution( args: StartNotebookExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartNotebookExecutionCommandOutput) => void ): void; - public startNotebookExecution( - args: StartNotebookExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartNotebookExecutionCommandOutput) => void), - cb?: (err: any, data?: StartNotebookExecutionCommandOutput) => void - ): Promise | void { - const command = new StartNotebookExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops a notebook execution.

+ * @see {@link StopNotebookExecutionCommand} */ - public stopNotebookExecution( + stopNotebookExecution( args: StopNotebookExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopNotebookExecution( + stopNotebookExecution( args: StopNotebookExecutionCommandInput, cb: (err: any, data?: StopNotebookExecutionCommandOutput) => void ): void; - public stopNotebookExecution( + stopNotebookExecution( args: StopNotebookExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopNotebookExecutionCommandOutput) => void ): void; - public stopNotebookExecution( - args: StopNotebookExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopNotebookExecutionCommandOutput) => void), - cb?: (err: any, data?: StopNotebookExecutionCommandOutput) => void - ): Promise | void { - const command = new StopNotebookExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

TerminateJobFlows shuts a list of clusters (job flows) down. When a job flow is shut - * down, any step not yet completed is canceled and the EC2 instances on which the cluster is - * running are stopped. Any log files not already saved are uploaded to Amazon S3 if a - * LogUri was specified when the cluster was created.

- *

The maximum number of clusters allowed is 10. The call to TerminateJobFlows - * is asynchronous. Depending on the configuration of the cluster, it may take up to 1-5 - * minutes for the cluster to completely terminate and release allocated resources, such as - * Amazon EC2 instances.

+ * @see {@link TerminateJobFlowsCommand} */ - public terminateJobFlows( + terminateJobFlows( args: TerminateJobFlowsCommandInput, options?: __HttpHandlerOptions ): Promise; - public terminateJobFlows( + terminateJobFlows( args: TerminateJobFlowsCommandInput, cb: (err: any, data?: TerminateJobFlowsCommandOutput) => void ): void; - public terminateJobFlows( + terminateJobFlows( args: TerminateJobFlowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TerminateJobFlowsCommandOutput) => void ): void; - public terminateJobFlows( - args: TerminateJobFlowsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TerminateJobFlowsCommandOutput) => void), - cb?: (err: any, data?: TerminateJobFlowsCommandOutput) => void - ): Promise | void { - const command = new TerminateJobFlowsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an Amazon EMR Studio configuration, including attributes such as name, - * description, and subnets.

+ * @see {@link UpdateStudioCommand} */ - public updateStudio( - args: UpdateStudioCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateStudio(args: UpdateStudioCommandInput, cb: (err: any, data?: UpdateStudioCommandOutput) => void): void; - public updateStudio( + updateStudio(args: UpdateStudioCommandInput, options?: __HttpHandlerOptions): Promise; + updateStudio(args: UpdateStudioCommandInput, cb: (err: any, data?: UpdateStudioCommandOutput) => void): void; + updateStudio( args: UpdateStudioCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStudioCommandOutput) => void ): void; - public updateStudio( - args: UpdateStudioCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStudioCommandOutput) => void), - cb?: (err: any, data?: UpdateStudioCommandOutput) => void - ): Promise | void { - const command = new UpdateStudioCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the session policy attached to the user or group for the specified Amazon EMR Studio.

+ * @see {@link UpdateStudioSessionMappingCommand} */ - public updateStudioSessionMapping( + updateStudioSessionMapping( args: UpdateStudioSessionMappingCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateStudioSessionMapping( + updateStudioSessionMapping( args: UpdateStudioSessionMappingCommandInput, cb: (err: any, data?: UpdateStudioSessionMappingCommandOutput) => void ): void; - public updateStudioSessionMapping( + updateStudioSessionMapping( args: UpdateStudioSessionMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStudioSessionMappingCommandOutput) => void ): void; - public updateStudioSessionMapping( - args: UpdateStudioSessionMappingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStudioSessionMappingCommandOutput) => void), - cb?: (err: any, data?: UpdateStudioSessionMappingCommandOutput) => void - ): Promise | void { - const command = new UpdateStudioSessionMappingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon EMR is a web service that makes it easier to process large amounts of + * data efficiently. Amazon EMR uses Hadoop processing combined with several Amazon Web Services services to do tasks such as web indexing, data mining, log file analysis, + * machine learning, scientific simulation, and data warehouse management.

+ */ +export class EMR extends EMRClient implements EMR {} +createAggregatedClient(commands, EMR); diff --git a/clients/client-eventbridge/src/EventBridge.ts b/clients/client-eventbridge/src/EventBridge.ts index fcfea02c8e31..557a10c3bea3 100644 --- a/clients/client-eventbridge/src/EventBridge.ts +++ b/clients/client-eventbridge/src/EventBridge.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -241,2171 +242,897 @@ import { UpdateEndpointCommandInput, UpdateEndpointCommandOutput, } from "./commands/UpdateEndpointCommand"; -import { EventBridgeClient } from "./EventBridgeClient"; +import { EventBridgeClient, EventBridgeClientConfig } from "./EventBridgeClient"; -/** - * @public - *

Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your - * resources change state, they automatically send events to an event stream. You can create - * rules that match selected events in the stream and route them to targets to take action. You - * can also use rules to take action on a predetermined schedule. For example, you can configure - * rules to:

- *
    - *
  • - *

    Automatically invoke an Lambda function to update DNS entries when an event - * notifies you that Amazon EC2 instance enters the running state.

    - *
  • - *
  • - *

    Direct specific API records from CloudTrail to an Amazon Kinesis data stream for - * detailed analysis of potential security or availability risks.

    - *
  • - *
  • - *

    Periodically invoke a built-in target to create a snapshot of an Amazon EBS - * volume.

    - *
  • - *
- *

For more information about the features of Amazon EventBridge, see the Amazon EventBridge User - * Guide.

- */ -export class EventBridge extends EventBridgeClient { +const commands = { + ActivateEventSourceCommand, + CancelReplayCommand, + CreateApiDestinationCommand, + CreateArchiveCommand, + CreateConnectionCommand, + CreateEndpointCommand, + CreateEventBusCommand, + CreatePartnerEventSourceCommand, + DeactivateEventSourceCommand, + DeauthorizeConnectionCommand, + DeleteApiDestinationCommand, + DeleteArchiveCommand, + DeleteConnectionCommand, + DeleteEndpointCommand, + DeleteEventBusCommand, + DeletePartnerEventSourceCommand, + DeleteRuleCommand, + DescribeApiDestinationCommand, + DescribeArchiveCommand, + DescribeConnectionCommand, + DescribeEndpointCommand, + DescribeEventBusCommand, + DescribeEventSourceCommand, + DescribePartnerEventSourceCommand, + DescribeReplayCommand, + DescribeRuleCommand, + DisableRuleCommand, + EnableRuleCommand, + ListApiDestinationsCommand, + ListArchivesCommand, + ListConnectionsCommand, + ListEndpointsCommand, + ListEventBusesCommand, + ListEventSourcesCommand, + ListPartnerEventSourceAccountsCommand, + ListPartnerEventSourcesCommand, + ListReplaysCommand, + ListRuleNamesByTargetCommand, + ListRulesCommand, + ListTagsForResourceCommand, + ListTargetsByRuleCommand, + PutEventsCommand, + PutPartnerEventsCommand, + PutPermissionCommand, + PutRuleCommand, + PutTargetsCommand, + RemovePermissionCommand, + RemoveTargetsCommand, + StartReplayCommand, + TagResourceCommand, + TestEventPatternCommand, + UntagResourceCommand, + UpdateApiDestinationCommand, + UpdateArchiveCommand, + UpdateConnectionCommand, + UpdateEndpointCommand, +}; + +export interface EventBridge { /** - * @public - *

Activates a partner event source that has been deactivated. Once activated, your matching - * event bus will start receiving events from the event source.

+ * @see {@link ActivateEventSourceCommand} */ - public activateEventSource( + activateEventSource( args: ActivateEventSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public activateEventSource( + activateEventSource( args: ActivateEventSourceCommandInput, cb: (err: any, data?: ActivateEventSourceCommandOutput) => void ): void; - public activateEventSource( + activateEventSource( args: ActivateEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ActivateEventSourceCommandOutput) => void ): void; - public activateEventSource( - args: ActivateEventSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ActivateEventSourceCommandOutput) => void), - cb?: (err: any, data?: ActivateEventSourceCommandOutput) => void - ): Promise | void { - const command = new ActivateEventSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels the specified replay.

+ * @see {@link CancelReplayCommand} */ - public cancelReplay( - args: CancelReplayCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public cancelReplay(args: CancelReplayCommandInput, cb: (err: any, data?: CancelReplayCommandOutput) => void): void; - public cancelReplay( + cancelReplay(args: CancelReplayCommandInput, options?: __HttpHandlerOptions): Promise; + cancelReplay(args: CancelReplayCommandInput, cb: (err: any, data?: CancelReplayCommandOutput) => void): void; + cancelReplay( args: CancelReplayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelReplayCommandOutput) => void ): void; - public cancelReplay( - args: CancelReplayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelReplayCommandOutput) => void), - cb?: (err: any, data?: CancelReplayCommandOutput) => void - ): Promise | void { - const command = new CancelReplayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an API destination, which is an HTTP invocation endpoint configured as a target - * for events.

+ * @see {@link CreateApiDestinationCommand} */ - public createApiDestination( + createApiDestination( args: CreateApiDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApiDestination( + createApiDestination( args: CreateApiDestinationCommandInput, cb: (err: any, data?: CreateApiDestinationCommandOutput) => void ): void; - public createApiDestination( + createApiDestination( args: CreateApiDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApiDestinationCommandOutput) => void ): void; - public createApiDestination( - args: CreateApiDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApiDestinationCommandOutput) => void), - cb?: (err: any, data?: CreateApiDestinationCommandOutput) => void - ): Promise | void { - const command = new CreateApiDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an archive of events with the specified settings. When you create an archive, - * incoming events might not immediately start being sent to the archive. Allow a short period of - * time for changes to take effect. If you do not specify a pattern to filter events sent to the - * archive, all events are sent to the archive except replayed events. Replayed events are not - * sent to an archive.

+ * @see {@link CreateArchiveCommand} */ - public createArchive( - args: CreateArchiveCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createArchive( - args: CreateArchiveCommandInput, - cb: (err: any, data?: CreateArchiveCommandOutput) => void - ): void; - public createArchive( + createArchive(args: CreateArchiveCommandInput, options?: __HttpHandlerOptions): Promise; + createArchive(args: CreateArchiveCommandInput, cb: (err: any, data?: CreateArchiveCommandOutput) => void): void; + createArchive( args: CreateArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateArchiveCommandOutput) => void ): void; - public createArchive( - args: CreateArchiveCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateArchiveCommandOutput) => void), - cb?: (err: any, data?: CreateArchiveCommandOutput) => void - ): Promise | void { - const command = new CreateArchiveCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a connection. A connection defines the authorization type and credentials to use - * for authorization with an API destination HTTP endpoint.

+ * @see {@link CreateConnectionCommand} */ - public createConnection( + createConnection( args: CreateConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConnection( + createConnection( args: CreateConnectionCommandInput, cb: (err: any, data?: CreateConnectionCommandOutput) => void ): void; - public createConnection( + createConnection( args: CreateConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectionCommandOutput) => void ): void; - public createConnection( - args: CreateConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConnectionCommandOutput) => void), - cb?: (err: any, data?: CreateConnectionCommandOutput) => void - ): Promise | void { - const command = new CreateConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a global endpoint. Global endpoints improve your application's availability by making it regional-fault tolerant. To do this, you define a primary and secondary Region - * with event buses in each Region. You also create a Amazon Route 53 health check that will tell EventBridge to route events to the secondary Region when an "unhealthy" state - * is encountered and events will be routed back to the primary Region when the health check reports a "healthy" state.

+ * @see {@link CreateEndpointCommand} */ - public createEndpoint( + createEndpoint( args: CreateEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEndpoint( - args: CreateEndpointCommandInput, - cb: (err: any, data?: CreateEndpointCommandOutput) => void - ): void; - public createEndpoint( + createEndpoint(args: CreateEndpointCommandInput, cb: (err: any, data?: CreateEndpointCommandOutput) => void): void; + createEndpoint( args: CreateEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEndpointCommandOutput) => void ): void; - public createEndpoint( - args: CreateEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEndpointCommandOutput) => void), - cb?: (err: any, data?: CreateEndpointCommandOutput) => void - ): Promise | void { - const command = new CreateEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new event bus within your account. This can be a custom event bus which you can - * use to receive events from your custom applications and services, or it can be a partner event - * bus which can be matched to a partner event source.

+ * @see {@link CreateEventBusCommand} */ - public createEventBus( + createEventBus( args: CreateEventBusCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEventBus( - args: CreateEventBusCommandInput, - cb: (err: any, data?: CreateEventBusCommandOutput) => void - ): void; - public createEventBus( + createEventBus(args: CreateEventBusCommandInput, cb: (err: any, data?: CreateEventBusCommandOutput) => void): void; + createEventBus( args: CreateEventBusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEventBusCommandOutput) => void ): void; - public createEventBus( - args: CreateEventBusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEventBusCommandOutput) => void), - cb?: (err: any, data?: CreateEventBusCommandOutput) => void - ): Promise | void { - const command = new CreateEventBusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Called by an SaaS partner to create a partner event source. This operation is not used by - * Amazon Web Services customers.

- *

Each partner event source can be used by one Amazon Web Services account to create a matching partner - * event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each - * Amazon Web Services account that wants to receive those event types.

- *

A partner event source creates events based on resources within the SaaS partner's service - * or application.

- *

An Amazon Web Services account that creates a partner event bus that matches the partner event source can - * use that event bus to receive events from the partner, and then process them using Amazon Web Services Events - * rules and targets.

- *

Partner event source names follow this format:

- *

- * - * partner_name/event_namespace/event_name - * - *

- *

- * partner_name is determined during partner registration and identifies - * the partner to Amazon Web Services customers. event_namespace is determined by the - * partner and is a way for the partner to categorize their events. - * event_name is determined by the partner, and should uniquely identify - * an event-generating resource within the partner system. The combination of - * event_namespace and event_name should help Amazon Web Services - * customers decide whether to create an event bus to receive these events.

+ * @see {@link CreatePartnerEventSourceCommand} */ - public createPartnerEventSource( + createPartnerEventSource( args: CreatePartnerEventSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPartnerEventSource( + createPartnerEventSource( args: CreatePartnerEventSourceCommandInput, cb: (err: any, data?: CreatePartnerEventSourceCommandOutput) => void ): void; - public createPartnerEventSource( + createPartnerEventSource( args: CreatePartnerEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePartnerEventSourceCommandOutput) => void ): void; - public createPartnerEventSource( - args: CreatePartnerEventSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePartnerEventSourceCommandOutput) => void), - cb?: (err: any, data?: CreatePartnerEventSourceCommandOutput) => void - ): Promise | void { - const command = new CreatePartnerEventSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

You can use this operation to temporarily stop receiving events from the specified partner - * event source. The matching event bus is not deleted.

- *

When you deactivate a partner event source, the source goes into PENDING state. If it - * remains in PENDING state for more than two weeks, it is deleted.

- *

To activate a deactivated partner event source, use ActivateEventSource.

+ * @see {@link DeactivateEventSourceCommand} */ - public deactivateEventSource( + deactivateEventSource( args: DeactivateEventSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deactivateEventSource( + deactivateEventSource( args: DeactivateEventSourceCommandInput, cb: (err: any, data?: DeactivateEventSourceCommandOutput) => void ): void; - public deactivateEventSource( + deactivateEventSource( args: DeactivateEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeactivateEventSourceCommandOutput) => void ): void; - public deactivateEventSource( - args: DeactivateEventSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeactivateEventSourceCommandOutput) => void), - cb?: (err: any, data?: DeactivateEventSourceCommandOutput) => void - ): Promise | void { - const command = new DeactivateEventSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes all authorization parameters from the connection. This lets you remove the secret - * from the connection so you can reuse it without having to create a new connection.

+ * @see {@link DeauthorizeConnectionCommand} */ - public deauthorizeConnection( + deauthorizeConnection( args: DeauthorizeConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deauthorizeConnection( + deauthorizeConnection( args: DeauthorizeConnectionCommandInput, cb: (err: any, data?: DeauthorizeConnectionCommandOutput) => void ): void; - public deauthorizeConnection( + deauthorizeConnection( args: DeauthorizeConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeauthorizeConnectionCommandOutput) => void ): void; - public deauthorizeConnection( - args: DeauthorizeConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeauthorizeConnectionCommandOutput) => void), - cb?: (err: any, data?: DeauthorizeConnectionCommandOutput) => void - ): Promise | void { - const command = new DeauthorizeConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified API destination.

+ * @see {@link DeleteApiDestinationCommand} */ - public deleteApiDestination( + deleteApiDestination( args: DeleteApiDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApiDestination( + deleteApiDestination( args: DeleteApiDestinationCommandInput, cb: (err: any, data?: DeleteApiDestinationCommandOutput) => void ): void; - public deleteApiDestination( + deleteApiDestination( args: DeleteApiDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApiDestinationCommandOutput) => void ): void; - public deleteApiDestination( - args: DeleteApiDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApiDestinationCommandOutput) => void), - cb?: (err: any, data?: DeleteApiDestinationCommandOutput) => void - ): Promise | void { - const command = new DeleteApiDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified archive.

+ * @see {@link DeleteArchiveCommand} */ - public deleteArchive( - args: DeleteArchiveCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteArchive( - args: DeleteArchiveCommandInput, - cb: (err: any, data?: DeleteArchiveCommandOutput) => void - ): void; - public deleteArchive( + deleteArchive(args: DeleteArchiveCommandInput, options?: __HttpHandlerOptions): Promise; + deleteArchive(args: DeleteArchiveCommandInput, cb: (err: any, data?: DeleteArchiveCommandOutput) => void): void; + deleteArchive( args: DeleteArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteArchiveCommandOutput) => void ): void; - public deleteArchive( - args: DeleteArchiveCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteArchiveCommandOutput) => void), - cb?: (err: any, data?: DeleteArchiveCommandOutput) => void - ): Promise | void { - const command = new DeleteArchiveCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a connection.

+ * @see {@link DeleteConnectionCommand} */ - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, cb: (err: any, data?: DeleteConnectionCommandOutput) => void ): void; - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectionCommandOutput) => void ): void; - public deleteConnection( - args: DeleteConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConnectionCommandOutput) => void), - cb?: (err: any, data?: DeleteConnectionCommandOutput) => void - ): Promise | void { - const command = new DeleteConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.

+ * @see {@link DeleteEndpointCommand} */ - public deleteEndpoint( + deleteEndpoint( args: DeleteEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEndpoint( - args: DeleteEndpointCommandInput, - cb: (err: any, data?: DeleteEndpointCommandOutput) => void - ): void; - public deleteEndpoint( + deleteEndpoint(args: DeleteEndpointCommandInput, cb: (err: any, data?: DeleteEndpointCommandOutput) => void): void; + deleteEndpoint( args: DeleteEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEndpointCommandOutput) => void ): void; - public deleteEndpoint( - args: DeleteEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEndpointCommandOutput) => void), - cb?: (err: any, data?: DeleteEndpointCommandOutput) => void - ): Promise | void { - const command = new DeleteEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified custom event bus or partner event bus. All rules associated with - * this event bus need to be deleted. You can't delete your account's default event bus.

+ * @see {@link DeleteEventBusCommand} */ - public deleteEventBus( + deleteEventBus( args: DeleteEventBusCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEventBus( - args: DeleteEventBusCommandInput, - cb: (err: any, data?: DeleteEventBusCommandOutput) => void - ): void; - public deleteEventBus( + deleteEventBus(args: DeleteEventBusCommandInput, cb: (err: any, data?: DeleteEventBusCommandOutput) => void): void; + deleteEventBus( args: DeleteEventBusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventBusCommandOutput) => void ): void; - public deleteEventBus( - args: DeleteEventBusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEventBusCommandOutput) => void), - cb?: (err: any, data?: DeleteEventBusCommandOutput) => void - ): Promise | void { - const command = new DeleteEventBusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation is used by SaaS partners to delete a partner event source. This operation - * is not used by Amazon Web Services customers.

- *

When you delete an event source, the status of the corresponding partner event bus in the - * Amazon Web Services customer account becomes DELETED.

- *

+ * @see {@link DeletePartnerEventSourceCommand} */ - public deletePartnerEventSource( + deletePartnerEventSource( args: DeletePartnerEventSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePartnerEventSource( + deletePartnerEventSource( args: DeletePartnerEventSourceCommandInput, cb: (err: any, data?: DeletePartnerEventSourceCommandOutput) => void ): void; - public deletePartnerEventSource( + deletePartnerEventSource( args: DeletePartnerEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePartnerEventSourceCommandOutput) => void ): void; - public deletePartnerEventSource( - args: DeletePartnerEventSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePartnerEventSourceCommandOutput) => void), - cb?: (err: any, data?: DeletePartnerEventSourceCommandOutput) => void - ): Promise | void { - const command = new DeletePartnerEventSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified rule.

- *

Before you can delete the rule, you must remove all targets, using RemoveTargets.

- *

When you delete a rule, incoming events might continue to match to the deleted rule. Allow - * a short period of time for changes to take effect.

- *

If you call delete rule multiple times for the same rule, all calls will succeed. When you - * call delete rule for a non-existent custom eventbus, ResourceNotFoundException is - * returned.

- *

Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These - * rules are created by those other Amazon Web Services services to support functionality in those services. You - * can delete these rules using the Force option, but you should do so only if you - * are sure the other service is not still using that rule.

+ * @see {@link DeleteRuleCommand} */ - public deleteRule(args: DeleteRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteRule(args: DeleteRuleCommandInput, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void; - public deleteRule( + deleteRule(args: DeleteRuleCommandInput, options?: __HttpHandlerOptions): Promise; + deleteRule(args: DeleteRuleCommandInput, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void; + deleteRule( args: DeleteRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRuleCommandOutput) => void ): void; - public deleteRule( - args: DeleteRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves details about an API destination.

+ * @see {@link DescribeApiDestinationCommand} */ - public describeApiDestination( + describeApiDestination( args: DescribeApiDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeApiDestination( + describeApiDestination( args: DescribeApiDestinationCommandInput, cb: (err: any, data?: DescribeApiDestinationCommandOutput) => void ): void; - public describeApiDestination( + describeApiDestination( args: DescribeApiDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeApiDestinationCommandOutput) => void ): void; - public describeApiDestination( - args: DescribeApiDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeApiDestinationCommandOutput) => void), - cb?: (err: any, data?: DescribeApiDestinationCommandOutput) => void - ): Promise | void { - const command = new DescribeApiDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves details about an archive.

+ * @see {@link DescribeArchiveCommand} */ - public describeArchive( + describeArchive( args: DescribeArchiveCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeArchive( - args: DescribeArchiveCommandInput, - cb: (err: any, data?: DescribeArchiveCommandOutput) => void - ): void; - public describeArchive( + describeArchive(args: DescribeArchiveCommandInput, cb: (err: any, data?: DescribeArchiveCommandOutput) => void): void; + describeArchive( args: DescribeArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeArchiveCommandOutput) => void ): void; - public describeArchive( - args: DescribeArchiveCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeArchiveCommandOutput) => void), - cb?: (err: any, data?: DescribeArchiveCommandOutput) => void - ): Promise | void { - const command = new DescribeArchiveCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves details about a connection.

+ * @see {@link DescribeConnectionCommand} */ - public describeConnection( + describeConnection( args: DescribeConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConnection( + describeConnection( args: DescribeConnectionCommandInput, cb: (err: any, data?: DescribeConnectionCommandOutput) => void ): void; - public describeConnection( + describeConnection( args: DescribeConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectionCommandOutput) => void ): void; - public describeConnection( - args: DescribeConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConnectionCommandOutput) => void), - cb?: (err: any, data?: DescribeConnectionCommandOutput) => void - ): Promise | void { - const command = new DescribeConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the information about an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide..

+ * @see {@link DescribeEndpointCommand} */ - public describeEndpoint( + describeEndpoint( args: DescribeEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEndpoint( + describeEndpoint( args: DescribeEndpointCommandInput, cb: (err: any, data?: DescribeEndpointCommandOutput) => void ): void; - public describeEndpoint( + describeEndpoint( args: DescribeEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEndpointCommandOutput) => void ): void; - public describeEndpoint( - args: DescribeEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEndpointCommandOutput) => void), - cb?: (err: any, data?: DescribeEndpointCommandOutput) => void - ): Promise | void { - const command = new DescribeEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays details about an event bus in your account. This can include the external Amazon Web Services - * accounts that are permitted to write events to your default event bus, and the associated - * policy. For custom event buses and partner event buses, it displays the name, ARN, policy, - * state, and creation time.

- *

To enable your account to receive events from other accounts on its default event bus, - * use PutPermission.

- *

For more information about partner event buses, see CreateEventBus.

+ * @see {@link DescribeEventBusCommand} */ - public describeEventBus( + describeEventBus( args: DescribeEventBusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventBus( + describeEventBus( args: DescribeEventBusCommandInput, cb: (err: any, data?: DescribeEventBusCommandOutput) => void ): void; - public describeEventBus( + describeEventBus( args: DescribeEventBusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventBusCommandOutput) => void ): void; - public describeEventBus( - args: DescribeEventBusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventBusCommandOutput) => void), - cb?: (err: any, data?: DescribeEventBusCommandOutput) => void - ): Promise | void { - const command = new DescribeEventBusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation lists details about a partner event source that is shared with your - * account.

+ * @see {@link DescribeEventSourceCommand} */ - public describeEventSource( + describeEventSource( args: DescribeEventSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventSource( + describeEventSource( args: DescribeEventSourceCommandInput, cb: (err: any, data?: DescribeEventSourceCommandOutput) => void ): void; - public describeEventSource( + describeEventSource( args: DescribeEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventSourceCommandOutput) => void ): void; - public describeEventSource( - args: DescribeEventSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventSourceCommandOutput) => void), - cb?: (err: any, data?: DescribeEventSourceCommandOutput) => void - ): Promise | void { - const command = new DescribeEventSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

An SaaS partner can use this operation to list details about a partner event source that - * they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource - * to see details about a partner event source that is - * shared with them.

+ * @see {@link DescribePartnerEventSourceCommand} */ - public describePartnerEventSource( + describePartnerEventSource( args: DescribePartnerEventSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePartnerEventSource( + describePartnerEventSource( args: DescribePartnerEventSourceCommandInput, cb: (err: any, data?: DescribePartnerEventSourceCommandOutput) => void ): void; - public describePartnerEventSource( + describePartnerEventSource( args: DescribePartnerEventSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePartnerEventSourceCommandOutput) => void ): void; - public describePartnerEventSource( - args: DescribePartnerEventSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePartnerEventSourceCommandOutput) => void), - cb?: (err: any, data?: DescribePartnerEventSourceCommandOutput) => void - ): Promise | void { - const command = new DescribePartnerEventSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves details about a replay. Use DescribeReplay to determine the - * progress of a running replay. A replay processes events to replay based on the time in the - * event, and replays them using 1 minute intervals. If you use StartReplay and - * specify an EventStartTime and an EventEndTime that covers a 20 - * minute time range, the events are replayed from the first minute of that 20 minute range - * first. Then the events from the second minute are replayed. You can use - * DescribeReplay to determine the progress of a replay. The value returned for - * EventLastReplayedTime indicates the time within the specified time range - * associated with the last event replayed.

+ * @see {@link DescribeReplayCommand} */ - public describeReplay( + describeReplay( args: DescribeReplayCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReplay( - args: DescribeReplayCommandInput, - cb: (err: any, data?: DescribeReplayCommandOutput) => void - ): void; - public describeReplay( + describeReplay(args: DescribeReplayCommandInput, cb: (err: any, data?: DescribeReplayCommandOutput) => void): void; + describeReplay( args: DescribeReplayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReplayCommandOutput) => void ): void; - public describeReplay( - args: DescribeReplayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReplayCommandOutput) => void), - cb?: (err: any, data?: DescribeReplayCommandOutput) => void - ): Promise | void { - const command = new DescribeReplayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified rule.

- *

DescribeRule does not list the targets of a rule. To see the targets associated with a - * rule, use ListTargetsByRule.

+ * @see {@link DescribeRuleCommand} */ - public describeRule( - args: DescribeRuleCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeRule(args: DescribeRuleCommandInput, cb: (err: any, data?: DescribeRuleCommandOutput) => void): void; - public describeRule( + describeRule(args: DescribeRuleCommandInput, options?: __HttpHandlerOptions): Promise; + describeRule(args: DescribeRuleCommandInput, cb: (err: any, data?: DescribeRuleCommandOutput) => void): void; + describeRule( args: DescribeRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRuleCommandOutput) => void ): void; - public describeRule( - args: DescribeRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRuleCommandOutput) => void), - cb?: (err: any, data?: DescribeRuleCommandOutput) => void - ): Promise | void { - const command = new DescribeRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables the specified rule. A disabled rule won't match any events, and won't - * self-trigger if it has a schedule expression.

- *

When you disable a rule, incoming events might continue to match to the disabled rule. - * Allow a short period of time for changes to take effect.

+ * @see {@link DisableRuleCommand} */ - public disableRule(args: DisableRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public disableRule(args: DisableRuleCommandInput, cb: (err: any, data?: DisableRuleCommandOutput) => void): void; - public disableRule( + disableRule(args: DisableRuleCommandInput, options?: __HttpHandlerOptions): Promise; + disableRule(args: DisableRuleCommandInput, cb: (err: any, data?: DisableRuleCommandOutput) => void): void; + disableRule( args: DisableRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableRuleCommandOutput) => void ): void; - public disableRule( - args: DisableRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableRuleCommandOutput) => void), - cb?: (err: any, data?: DisableRuleCommandOutput) => void - ): Promise | void { - const command = new DisableRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the specified rule. If the rule does not exist, the operation fails.

- *

When you enable a rule, incoming events might not immediately start matching to a newly - * enabled rule. Allow a short period of time for changes to take effect.

+ * @see {@link EnableRuleCommand} */ - public enableRule(args: EnableRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public enableRule(args: EnableRuleCommandInput, cb: (err: any, data?: EnableRuleCommandOutput) => void): void; - public enableRule( + enableRule(args: EnableRuleCommandInput, options?: __HttpHandlerOptions): Promise; + enableRule(args: EnableRuleCommandInput, cb: (err: any, data?: EnableRuleCommandOutput) => void): void; + enableRule( args: EnableRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableRuleCommandOutput) => void ): void; - public enableRule( - args: EnableRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableRuleCommandOutput) => void), - cb?: (err: any, data?: EnableRuleCommandOutput) => void - ): Promise | void { - const command = new EnableRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of API destination in the account in the current Region.

+ * @see {@link ListApiDestinationsCommand} */ - public listApiDestinations( + listApiDestinations( args: ListApiDestinationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApiDestinations( + listApiDestinations( args: ListApiDestinationsCommandInput, cb: (err: any, data?: ListApiDestinationsCommandOutput) => void ): void; - public listApiDestinations( + listApiDestinations( args: ListApiDestinationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApiDestinationsCommandOutput) => void ): void; - public listApiDestinations( - args: ListApiDestinationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApiDestinationsCommandOutput) => void), - cb?: (err: any, data?: ListApiDestinationsCommandOutput) => void - ): Promise | void { - const command = new ListApiDestinationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists your archives. You can either list all the archives or you can provide a prefix to - * match to the archive names. Filter parameters are exclusive.

+ * @see {@link ListArchivesCommand} */ - public listArchives( - args: ListArchivesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listArchives(args: ListArchivesCommandInput, cb: (err: any, data?: ListArchivesCommandOutput) => void): void; - public listArchives( + listArchives(args: ListArchivesCommandInput, options?: __HttpHandlerOptions): Promise; + listArchives(args: ListArchivesCommandInput, cb: (err: any, data?: ListArchivesCommandOutput) => void): void; + listArchives( args: ListArchivesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListArchivesCommandOutput) => void ): void; - public listArchives( - args: ListArchivesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListArchivesCommandOutput) => void), - cb?: (err: any, data?: ListArchivesCommandOutput) => void - ): Promise | void { - const command = new ListArchivesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of connections from the account.

+ * @see {@link ListConnectionsCommand} */ - public listConnections( + listConnections( args: ListConnectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConnections( - args: ListConnectionsCommandInput, - cb: (err: any, data?: ListConnectionsCommandOutput) => void - ): void; - public listConnections( + listConnections(args: ListConnectionsCommandInput, cb: (err: any, data?: ListConnectionsCommandOutput) => void): void; + listConnections( args: ListConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConnectionsCommandOutput) => void ): void; - public listConnections( - args: ListConnectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConnectionsCommandOutput) => void), - cb?: (err: any, data?: ListConnectionsCommandOutput) => void - ): Promise | void { - const command = new ListConnectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the global endpoints associated with this account. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide..

+ * @see {@link ListEndpointsCommand} */ - public listEndpoints( - args: ListEndpointsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listEndpoints( - args: ListEndpointsCommandInput, - cb: (err: any, data?: ListEndpointsCommandOutput) => void - ): void; - public listEndpoints( + listEndpoints(args: ListEndpointsCommandInput, options?: __HttpHandlerOptions): Promise; + listEndpoints(args: ListEndpointsCommandInput, cb: (err: any, data?: ListEndpointsCommandOutput) => void): void; + listEndpoints( args: ListEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEndpointsCommandOutput) => void ): void; - public listEndpoints( - args: ListEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEndpointsCommandOutput) => void), - cb?: (err: any, data?: ListEndpointsCommandOutput) => void - ): Promise | void { - const command = new ListEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the event buses in your account, including the default event bus, custom event - * buses, and partner event buses.

+ * @see {@link ListEventBusesCommand} */ - public listEventBuses( + listEventBuses( args: ListEventBusesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEventBuses( - args: ListEventBusesCommandInput, - cb: (err: any, data?: ListEventBusesCommandOutput) => void - ): void; - public listEventBuses( + listEventBuses(args: ListEventBusesCommandInput, cb: (err: any, data?: ListEventBusesCommandOutput) => void): void; + listEventBuses( args: ListEventBusesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventBusesCommandOutput) => void ): void; - public listEventBuses( - args: ListEventBusesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEventBusesCommandOutput) => void), - cb?: (err: any, data?: ListEventBusesCommandOutput) => void - ): Promise | void { - const command = new ListEventBusesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

You can use this to see all the partner event sources that have been shared with your Amazon Web Services - * account. For more information about partner event sources, see CreateEventBus.

+ * @see {@link ListEventSourcesCommand} */ - public listEventSources( + listEventSources( args: ListEventSourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEventSources( + listEventSources( args: ListEventSourcesCommandInput, cb: (err: any, data?: ListEventSourcesCommandOutput) => void ): void; - public listEventSources( + listEventSources( args: ListEventSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventSourcesCommandOutput) => void ): void; - public listEventSources( - args: ListEventSourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEventSourcesCommandOutput) => void), - cb?: (err: any, data?: ListEventSourcesCommandOutput) => void - ): Promise | void { - const command = new ListEventSourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular - * partner event source name is associated with. This operation is not used by Amazon Web Services - * customers.

+ * @see {@link ListPartnerEventSourceAccountsCommand} */ - public listPartnerEventSourceAccounts( + listPartnerEventSourceAccounts( args: ListPartnerEventSourceAccountsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPartnerEventSourceAccounts( + listPartnerEventSourceAccounts( args: ListPartnerEventSourceAccountsCommandInput, cb: (err: any, data?: ListPartnerEventSourceAccountsCommandOutput) => void ): void; - public listPartnerEventSourceAccounts( + listPartnerEventSourceAccounts( args: ListPartnerEventSourceAccountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPartnerEventSourceAccountsCommandOutput) => void ): void; - public listPartnerEventSourceAccounts( - args: ListPartnerEventSourceAccountsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPartnerEventSourceAccountsCommandOutput) => void), - cb?: (err: any, data?: ListPartnerEventSourceAccountsCommandOutput) => void - ): Promise | void { - const command = new ListPartnerEventSourceAccountsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

An SaaS partner can use this operation to list all the partner event source names that - * they have created. This operation is not used by Amazon Web Services customers.

+ * @see {@link ListPartnerEventSourcesCommand} */ - public listPartnerEventSources( + listPartnerEventSources( args: ListPartnerEventSourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPartnerEventSources( + listPartnerEventSources( args: ListPartnerEventSourcesCommandInput, cb: (err: any, data?: ListPartnerEventSourcesCommandOutput) => void ): void; - public listPartnerEventSources( + listPartnerEventSources( args: ListPartnerEventSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPartnerEventSourcesCommandOutput) => void ): void; - public listPartnerEventSources( - args: ListPartnerEventSourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPartnerEventSourcesCommandOutput) => void), - cb?: (err: any, data?: ListPartnerEventSourcesCommandOutput) => void - ): Promise | void { - const command = new ListPartnerEventSourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists your replays. You can either list all the replays or you can provide a prefix to - * match to the replay names. Filter parameters are exclusive.

+ * @see {@link ListReplaysCommand} */ - public listReplays(args: ListReplaysCommandInput, options?: __HttpHandlerOptions): Promise; - public listReplays(args: ListReplaysCommandInput, cb: (err: any, data?: ListReplaysCommandOutput) => void): void; - public listReplays( + listReplays(args: ListReplaysCommandInput, options?: __HttpHandlerOptions): Promise; + listReplays(args: ListReplaysCommandInput, cb: (err: any, data?: ListReplaysCommandOutput) => void): void; + listReplays( args: ListReplaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReplaysCommandOutput) => void ): void; - public listReplays( - args: ListReplaysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReplaysCommandOutput) => void), - cb?: (err: any, data?: ListReplaysCommandOutput) => void - ): Promise | void { - const command = new ListReplaysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the rules for the specified target. You can see which of the rules in Amazon - * EventBridge can invoke a specific target in your account.

+ * @see {@link ListRuleNamesByTargetCommand} */ - public listRuleNamesByTarget( + listRuleNamesByTarget( args: ListRuleNamesByTargetCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRuleNamesByTarget( + listRuleNamesByTarget( args: ListRuleNamesByTargetCommandInput, cb: (err: any, data?: ListRuleNamesByTargetCommandOutput) => void ): void; - public listRuleNamesByTarget( + listRuleNamesByTarget( args: ListRuleNamesByTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRuleNamesByTargetCommandOutput) => void ): void; - public listRuleNamesByTarget( - args: ListRuleNamesByTargetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRuleNamesByTargetCommandOutput) => void), - cb?: (err: any, data?: ListRuleNamesByTargetCommandOutput) => void - ): Promise | void { - const command = new ListRuleNamesByTargetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists your Amazon EventBridge rules. You can either list all the rules or you can provide - * a prefix to match to the rule names.

- *

ListRules does not list the targets of a rule. To see the targets associated with a rule, - * use ListTargetsByRule.

+ * @see {@link ListRulesCommand} */ - public listRules(args: ListRulesCommandInput, options?: __HttpHandlerOptions): Promise; - public listRules(args: ListRulesCommandInput, cb: (err: any, data?: ListRulesCommandOutput) => void): void; - public listRules( + listRules(args: ListRulesCommandInput, options?: __HttpHandlerOptions): Promise; + listRules(args: ListRulesCommandInput, cb: (err: any, data?: ListRulesCommandOutput) => void): void; + listRules( args: ListRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRulesCommandOutput) => void ): void; - public listRules( - args: ListRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRulesCommandOutput) => void), - cb?: (err: any, data?: ListRulesCommandOutput) => void - ): Promise | void { - const command = new ListRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays the tags associated with an EventBridge resource. In EventBridge, rules and event - * buses can be tagged.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the targets assigned to the specified rule.

+ * @see {@link ListTargetsByRuleCommand} */ - public listTargetsByRule( + listTargetsByRule( args: ListTargetsByRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTargetsByRule( + listTargetsByRule( args: ListTargetsByRuleCommandInput, cb: (err: any, data?: ListTargetsByRuleCommandOutput) => void ): void; - public listTargetsByRule( + listTargetsByRule( args: ListTargetsByRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTargetsByRuleCommandOutput) => void ): void; - public listTargetsByRule( - args: ListTargetsByRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTargetsByRuleCommandOutput) => void), - cb?: (err: any, data?: ListTargetsByRuleCommandOutput) => void - ): Promise | void { - const command = new ListTargetsByRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sends custom events to Amazon EventBridge so that they can be matched to rules.

- * - *

PutEvents will only process nested JSON up to 1100 levels deep.

- *
+ * @see {@link PutEventsCommand} */ - public putEvents(args: PutEventsCommandInput, options?: __HttpHandlerOptions): Promise; - public putEvents(args: PutEventsCommandInput, cb: (err: any, data?: PutEventsCommandOutput) => void): void; - public putEvents( + putEvents(args: PutEventsCommandInput, options?: __HttpHandlerOptions): Promise; + putEvents(args: PutEventsCommandInput, cb: (err: any, data?: PutEventsCommandOutput) => void): void; + putEvents( args: PutEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEventsCommandOutput) => void ): void; - public putEvents( - args: PutEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutEventsCommandOutput) => void), - cb?: (err: any, data?: PutEventsCommandOutput) => void - ): Promise | void { - const command = new PutEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services - * customers do not use this operation.

+ * @see {@link PutPartnerEventsCommand} */ - public putPartnerEvents( + putPartnerEvents( args: PutPartnerEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putPartnerEvents( + putPartnerEvents( args: PutPartnerEventsCommandInput, cb: (err: any, data?: PutPartnerEventsCommandOutput) => void ): void; - public putPartnerEvents( + putPartnerEvents( args: PutPartnerEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPartnerEventsCommandOutput) => void ): void; - public putPartnerEvents( - args: PutPartnerEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutPartnerEventsCommandOutput) => void), - cb?: (err: any, data?: PutPartnerEventsCommandOutput) => void - ): Promise | void { - const command = new PutPartnerEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization - * to put events to the specified event bus. Amazon EventBridge (CloudWatch - * Events) rules in your account are triggered by these events arriving to an event bus in your - * account.

- *

For another account to send events to your account, that external account must have an - * EventBridge rule with your account's event bus as a target.

- *

To enable multiple Amazon Web Services accounts to put events to your event bus, run - * PutPermission once for each of these accounts. Or, if all the accounts are - * members of the same Amazon Web Services organization, you can run PutPermission once specifying - * Principal as "*" and specifying the Amazon Web Services organization ID in - * Condition, to grant permissions to all accounts in that organization.

- *

If you grant permissions using an organization, then accounts in that organization must - * specify a RoleArn with proper permissions when they use PutTarget to - * add your account's event bus as a target. For more information, see Sending and - * Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User - * Guide.

- *

The permission policy on the event bus cannot exceed 10 KB in size.

+ * @see {@link PutPermissionCommand} */ - public putPermission( - args: PutPermissionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putPermission( - args: PutPermissionCommandInput, - cb: (err: any, data?: PutPermissionCommandOutput) => void - ): void; - public putPermission( + putPermission(args: PutPermissionCommandInput, options?: __HttpHandlerOptions): Promise; + putPermission(args: PutPermissionCommandInput, cb: (err: any, data?: PutPermissionCommandOutput) => void): void; + putPermission( args: PutPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPermissionCommandOutput) => void ): void; - public putPermission( - args: PutPermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutPermissionCommandOutput) => void), - cb?: (err: any, data?: PutPermissionCommandOutput) => void - ): Promise | void { - const command = new PutPermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates the specified rule. Rules are enabled by default, or based on value of - * the state. You can disable a rule using DisableRule.

- *

A single rule watches for events from a single event bus. Events generated by Amazon Web Services services - * go to your account's default event bus. Events generated by SaaS partner services or - * applications go to the matching partner event bus. If you have custom applications or - * services, you can specify whether their events go to your default event bus or a custom event - * bus that you have created. For more information, see CreateEventBus.

- *

If you are updating an existing rule, the rule is replaced with what you specify in this - * PutRule command. If you omit arguments in PutRule, the old values - * for those arguments are not kept. Instead, they are replaced with null values.

- *

When you create or update a rule, incoming events might not immediately start matching to - * new or updated rules. Allow a short period of time for changes to take effect.

- *

A rule must contain at least an EventPattern or ScheduleExpression. Rules with - * EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions - * self-trigger based on the given schedule. A rule can have both an EventPattern and a - * ScheduleExpression, in which case the rule triggers on matching events as well as on a - * schedule.

- *

When you initially create a rule, you can optionally assign one or more tags to the rule. - * Tags can help you organize and categorize your resources. You can also use them to scope user - * permissions, by granting a user permission to access or change only rules with certain tag - * values. To use the PutRule operation and assign tags, you must have both the - * events:PutRule and events:TagResource permissions.

- *

If you are updating an existing rule, any tags you specify in the PutRule - * operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.

- *

Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). - * However, EventBridge uses an exact match in event patterns and rules. Be sure to use the - * correct ARN characters when creating event patterns so that they match the ARN syntax in the - * event you want to match.

- *

In EventBridge, it is possible to create rules that lead to infinite loops, where a rule - * is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, - * and trigger software to change them to the desired state. If the rule is not written - * carefully, the subsequent change to the ACLs fires the rule again, creating an infinite - * loop.

- *

To prevent this, write the rules so that the triggered actions do not re-fire the same - * rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead - * of after any change.

- *

An infinite loop can quickly cause higher than expected charges. We recommend that you use - * budgeting, which alerts you when charges exceed your specified limit. For more information, - * see Managing Your Costs with - * Budgets.

+ * @see {@link PutRuleCommand} */ - public putRule(args: PutRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public putRule(args: PutRuleCommandInput, cb: (err: any, data?: PutRuleCommandOutput) => void): void; - public putRule( + putRule(args: PutRuleCommandInput, options?: __HttpHandlerOptions): Promise; + putRule(args: PutRuleCommandInput, cb: (err: any, data?: PutRuleCommandOutput) => void): void; + putRule( args: PutRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRuleCommandOutput) => void ): void; - public putRule( - args: PutRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRuleCommandOutput) => void), - cb?: (err: any, data?: PutRuleCommandOutput) => void - ): Promise | void { - const command = new PutRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds the specified targets to the specified rule, or updates the targets if they are - * already associated with the rule.

- *

Targets are the resources that are invoked when a rule is triggered.

- * - *

Each rule can have up to five (5) targets associated with it at one time.

- *
- *

You can configure the following as targets for Events:

- *
    - *
  • - *

    - * API destination - *

    - *
  • - *
  • - *

    - * API Gateway - *

    - *
  • - *
  • - *

    Batch job queue

    - *
  • - *
  • - *

    CloudWatch group

    - *
  • - *
  • - *

    CodeBuild project

    - *
  • - *
  • - *

    CodePipeline

    - *
  • - *
  • - *

    EC2 CreateSnapshot API call

    - *
  • - *
  • - *

    EC2 Image Builder

    - *
  • - *
  • - *

    EC2 RebootInstances API call

    - *
  • - *
  • - *

    EC2 StopInstances API call

    - *
  • - *
  • - *

    EC2 TerminateInstances API call

    - *
  • - *
  • - *

    ECS task

    - *
  • - *
  • - *

    - * Event bus in a different account or - * Region - *

    - *
  • - *
  • - *

    - * Event bus in the same account and - * Region - *

    - *
  • - *
  • - *

    Firehose delivery stream

    - *
  • - *
  • - *

    Glue workflow

    - *
  • - *
  • - *

    - * Incident Manager response plan - *

    - *
  • - *
  • - *

    Inspector assessment template

    - *
  • - *
  • - *

    Kinesis stream

    - *
  • - *
  • - *

    Lambda function

    - *
  • - *
  • - *

    Redshift cluster

    - *
  • - *
  • - *

    Redshift Serverless workgroup

    - *
  • - *
  • - *

    SageMaker Pipeline

    - *
  • - *
  • - *

    SNS topic

    - *
  • - *
  • - *

    SQS queue

    - *
  • - *
  • - *

    Step Functions state machine

    - *
  • - *
  • - *

    Systems Manager Automation

    - *
  • - *
  • - *

    Systems Manager OpsItem

    - *
  • - *
  • - *

    Systems Manager Run Command

    - *
  • - *
- *

Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The - * built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API - * call, EC2 StopInstances API call, and EC2 TerminateInstances API - * call.

- *

For some target types, PutTargets provides target-specific parameters. If the - * target is a Kinesis data stream, you can optionally specify which shard the event goes to by - * using the KinesisParameters argument. To invoke a command on multiple EC2 - * instances with one rule, you can use the RunCommandParameters field.

- *

To be able to make API calls against the resources that you own, Amazon EventBridge - * needs the appropriate permissions. For Lambda and Amazon SNS - * resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, - * Step Functions state machines and API Gateway APIs, EventBridge relies on - * IAM roles that you specify in the RoleARN argument in PutTargets. - * For more information, see Authentication - * and Access Control in the Amazon EventBridge User Guide.

- *

If another Amazon Web Services account is in the same region and has granted you permission (using - * PutPermission), you can send events to that account. Set that account's event - * bus as a target of the rules in your account. To send the matched events to the other account, - * specify that account's event bus as the Arn value when you run - * PutTargets. If your account sends events to another account, your account is - * charged for each sent event. Each event sent to another account is charged as a custom event. - * The account receiving the event is not charged. For more information, see Amazon EventBridge - * Pricing.

- * - *

- * Input, InputPath, and InputTransformer are not - * available with PutTarget if the target is an event bus of a different Amazon Web Services - * account.

- *
- *

If you are setting the event bus of another account as the target, and that account - * granted permission to your account through an organization instead of directly by the account - * ID, then you must specify a RoleArn with proper permissions in the - * Target structure. For more information, see Sending and - * Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User - * Guide.

- *

For more information about enabling cross-account events, see PutPermission.

- *

- * Input, InputPath, and - * InputTransformer are mutually exclusive and optional - * parameters of a target. When a rule is triggered due to a matched event:

- *
    - *
  • - *

    If none of the following arguments are specified for a target, then the entire event - * is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or - * Amazon ECS task, in which case nothing from the event is passed to the target).

    - *
  • - *
  • - *

    If Input is specified in the form of valid JSON, then - * the matched event is overridden with this constant.

    - *
  • - *
  • - *

    If InputPath is specified in the form of JSONPath - * (for example, $.detail), then only the part of the event specified in the - * path is passed to the target (for example, only the detail part of the event is - * passed).

    - *
  • - *
  • - *

    If InputTransformer is specified, then one or more - * specified JSONPaths are extracted from the event and used as values in a template that you - * specify as the input to the target.

    - *
  • - *
- *

When you specify InputPath or InputTransformer, you must use - * JSON dot notation, not bracket notation.

- *

When you add targets to a rule and the associated rule triggers soon after, new or updated - * targets might not be immediately invoked. Allow a short period of time for changes to take - * effect.

- *

This action can partially fail if too many requests are made at the same time. If that - * happens, FailedEntryCount is non-zero in the response and each entry in - * FailedEntries provides the ID of the failed target and the error code.

+ * @see {@link PutTargetsCommand} */ - public putTargets(args: PutTargetsCommandInput, options?: __HttpHandlerOptions): Promise; - public putTargets(args: PutTargetsCommandInput, cb: (err: any, data?: PutTargetsCommandOutput) => void): void; - public putTargets( + putTargets(args: PutTargetsCommandInput, options?: __HttpHandlerOptions): Promise; + putTargets(args: PutTargetsCommandInput, cb: (err: any, data?: PutTargetsCommandOutput) => void): void; + putTargets( args: PutTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutTargetsCommandOutput) => void ): void; - public putTargets( - args: PutTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutTargetsCommandOutput) => void), - cb?: (err: any, data?: PutTargetsCommandOutput) => void - ): Promise | void { - const command = new PutTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Revokes the permission of another Amazon Web Services account to be able to put events to the specified - * event bus. Specify the account to revoke by the StatementId value that you - * associated with the account when you granted it permission with PutPermission. - * You can find the StatementId by using DescribeEventBus.

+ * @see {@link RemovePermissionCommand} */ - public removePermission( + removePermission( args: RemovePermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public removePermission( + removePermission( args: RemovePermissionCommandInput, cb: (err: any, data?: RemovePermissionCommandOutput) => void ): void; - public removePermission( + removePermission( args: RemovePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemovePermissionCommandOutput) => void ): void; - public removePermission( - args: RemovePermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemovePermissionCommandOutput) => void), - cb?: (err: any, data?: RemovePermissionCommandOutput) => void - ): Promise | void { - const command = new RemovePermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified targets from the specified rule. When the rule is triggered, those - * targets are no longer be invoked.

- * - *

A successful execution of RemoveTargets doesn't guarantee all targets are removed from the rule, it means that the target(s) listed in the request are removed.

- *
- *

When you remove a target, when the associated rule triggers, removed targets might - * continue to be invoked. Allow a short period of time for changes to take effect.

- *

This action can partially fail if too many requests are made at the same time. If that - * happens, FailedEntryCount is non-zero in the response and each entry in - * FailedEntries provides the ID of the failed target and the error code.

+ * @see {@link RemoveTargetsCommand} */ - public removeTargets( - args: RemoveTargetsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public removeTargets( - args: RemoveTargetsCommandInput, - cb: (err: any, data?: RemoveTargetsCommandOutput) => void - ): void; - public removeTargets( + removeTargets(args: RemoveTargetsCommandInput, options?: __HttpHandlerOptions): Promise; + removeTargets(args: RemoveTargetsCommandInput, cb: (err: any, data?: RemoveTargetsCommandOutput) => void): void; + removeTargets( args: RemoveTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTargetsCommandOutput) => void ): void; - public removeTargets( - args: RemoveTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveTargetsCommandOutput) => void), - cb?: (err: any, data?: RemoveTargetsCommandOutput) => void - ): Promise | void { - const command = new RemoveTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts the specified replay. Events are not necessarily replayed in the exact same order - * that they were added to the archive. A replay processes events to replay based on the time in - * the event, and replays them using 1 minute intervals. If you specify an - * EventStartTime and an EventEndTime that covers a 20 minute time - * range, the events are replayed from the first minute of that 20 minute range first. Then the - * events from the second minute are replayed. You can use DescribeReplay to - * determine the progress of a replay. The value returned for EventLastReplayedTime - * indicates the time within the specified time range associated with the last event - * replayed.

+ * @see {@link StartReplayCommand} */ - public startReplay(args: StartReplayCommandInput, options?: __HttpHandlerOptions): Promise; - public startReplay(args: StartReplayCommandInput, cb: (err: any, data?: StartReplayCommandOutput) => void): void; - public startReplay( + startReplay(args: StartReplayCommandInput, options?: __HttpHandlerOptions): Promise; + startReplay(args: StartReplayCommandInput, cb: (err: any, data?: StartReplayCommandOutput) => void): void; + startReplay( args: StartReplayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartReplayCommandOutput) => void ): void; - public startReplay( - args: StartReplayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartReplayCommandOutput) => void), - cb?: (err: any, data?: StartReplayCommandOutput) => void - ): Promise | void { - const command = new StartReplayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can - * help you organize and categorize your resources. You can also use them to scope user - * permissions by granting a user permission to access or change only resources with certain tag - * values. In EventBridge, rules and event buses can be tagged.

- *

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of - * characters.

- *

You can use the TagResource action with a resource that already has tags. If - * you specify a new tag key, this tag is appended to the list of tags associated with the - * resource. If you specify a tag key that is already associated with the resource, the new tag - * value that you specify replaces the previous value for that tag.

- *

You can associate as many as 50 tags with a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Tests whether the specified event pattern matches the provided event.

- *

Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). - * However, EventBridge uses an exact match in event patterns and rules. Be sure to use the - * correct ARN characters when creating event patterns so that they match the ARN syntax in the - * event you want to match.

+ * @see {@link TestEventPatternCommand} */ - public testEventPattern( + testEventPattern( args: TestEventPatternCommandInput, options?: __HttpHandlerOptions ): Promise; - public testEventPattern( + testEventPattern( args: TestEventPatternCommandInput, cb: (err: any, data?: TestEventPatternCommandOutput) => void ): void; - public testEventPattern( + testEventPattern( args: TestEventPatternCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestEventPatternCommandOutput) => void ): void; - public testEventPattern( - args: TestEventPatternCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestEventPatternCommandOutput) => void), - cb?: (err: any, data?: TestEventPatternCommandOutput) => void - ): Promise | void { - const command = new TestEventPatternCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge - * (CloudWatch Events), rules and event buses can be tagged.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an API destination.

+ * @see {@link UpdateApiDestinationCommand} */ - public updateApiDestination( + updateApiDestination( args: UpdateApiDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApiDestination( + updateApiDestination( args: UpdateApiDestinationCommandInput, cb: (err: any, data?: UpdateApiDestinationCommandOutput) => void ): void; - public updateApiDestination( + updateApiDestination( args: UpdateApiDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApiDestinationCommandOutput) => void ): void; - public updateApiDestination( - args: UpdateApiDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApiDestinationCommandOutput) => void), - cb?: (err: any, data?: UpdateApiDestinationCommandOutput) => void - ): Promise | void { - const command = new UpdateApiDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified archive.

+ * @see {@link UpdateArchiveCommand} */ - public updateArchive( - args: UpdateArchiveCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateArchive( - args: UpdateArchiveCommandInput, - cb: (err: any, data?: UpdateArchiveCommandOutput) => void - ): void; - public updateArchive( + updateArchive(args: UpdateArchiveCommandInput, options?: __HttpHandlerOptions): Promise; + updateArchive(args: UpdateArchiveCommandInput, cb: (err: any, data?: UpdateArchiveCommandOutput) => void): void; + updateArchive( args: UpdateArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateArchiveCommandOutput) => void ): void; - public updateArchive( - args: UpdateArchiveCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateArchiveCommandOutput) => void), - cb?: (err: any, data?: UpdateArchiveCommandOutput) => void - ): Promise | void { - const command = new UpdateArchiveCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates settings for a connection.

+ * @see {@link UpdateConnectionCommand} */ - public updateConnection( + updateConnection( args: UpdateConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConnection( + updateConnection( args: UpdateConnectionCommandInput, cb: (err: any, data?: UpdateConnectionCommandOutput) => void ): void; - public updateConnection( + updateConnection( args: UpdateConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectionCommandOutput) => void ): void; - public updateConnection( - args: UpdateConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConnectionCommandOutput) => void), - cb?: (err: any, data?: UpdateConnectionCommandOutput) => void - ): Promise | void { - const command = new UpdateConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update an existing endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide..

+ * @see {@link UpdateEndpointCommand} */ - public updateEndpoint( + updateEndpoint( args: UpdateEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEndpoint( - args: UpdateEndpointCommandInput, - cb: (err: any, data?: UpdateEndpointCommandOutput) => void - ): void; - public updateEndpoint( + updateEndpoint(args: UpdateEndpointCommandInput, cb: (err: any, data?: UpdateEndpointCommandOutput) => void): void; + updateEndpoint( args: UpdateEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEndpointCommandOutput) => void ): void; - public updateEndpoint( - args: UpdateEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEndpointCommandOutput) => void), - cb?: (err: any, data?: UpdateEndpointCommandOutput) => void - ): Promise | void { - const command = new UpdateEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your + * resources change state, they automatically send events to an event stream. You can create + * rules that match selected events in the stream and route them to targets to take action. You + * can also use rules to take action on a predetermined schedule. For example, you can configure + * rules to:

+ *
    + *
  • + *

    Automatically invoke an Lambda function to update DNS entries when an event + * notifies you that Amazon EC2 instance enters the running state.

    + *
  • + *
  • + *

    Direct specific API records from CloudTrail to an Amazon Kinesis data stream for + * detailed analysis of potential security or availability risks.

    + *
  • + *
  • + *

    Periodically invoke a built-in target to create a snapshot of an Amazon EBS + * volume.

    + *
  • + *
+ *

For more information about the features of Amazon EventBridge, see the Amazon EventBridge User + * Guide.

+ */ +export class EventBridge extends EventBridgeClient implements EventBridge {} +createAggregatedClient(commands, EventBridge); diff --git a/clients/client-evidently/src/Evidently.ts b/clients/client-evidently/src/Evidently.ts index 021010316c59..531590ccf312 100644 --- a/clients/client-evidently/src/Evidently.ts +++ b/clients/client-evidently/src/Evidently.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -163,1335 +164,553 @@ import { UpdateProjectDataDeliveryCommandInput, UpdateProjectDataDeliveryCommandOutput, } from "./commands/UpdateProjectDataDeliveryCommand"; -import { EvidentlyClient } from "./EvidentlyClient"; +import { EvidentlyClient, EvidentlyClientConfig } from "./EvidentlyClient"; -/** - * @public - *

You can use Amazon CloudWatch Evidently to safely validate new features by serving - * them to a specified percentage - * of your users while you roll out the feature. You can monitor the performance of the new feature - * to help you decide when to ramp up traffic to your users. This helps you - * reduce risk and identify unintended consequences before you fully launch the feature.

- *

You can also conduct A/B experiments to make feature design decisions based on evidence - * and data. An experiment can test as many as five variations at once. Evidently collects - * experiment data and analyzes it using statistical methods. It also provides clear - * recommendations about which variations perform better. You can test both user-facing features - * and backend features.

- */ -export class Evidently extends EvidentlyClient { +const commands = { + BatchEvaluateFeatureCommand, + CreateExperimentCommand, + CreateFeatureCommand, + CreateLaunchCommand, + CreateProjectCommand, + CreateSegmentCommand, + DeleteExperimentCommand, + DeleteFeatureCommand, + DeleteLaunchCommand, + DeleteProjectCommand, + DeleteSegmentCommand, + EvaluateFeatureCommand, + GetExperimentCommand, + GetExperimentResultsCommand, + GetFeatureCommand, + GetLaunchCommand, + GetProjectCommand, + GetSegmentCommand, + ListExperimentsCommand, + ListFeaturesCommand, + ListLaunchesCommand, + ListProjectsCommand, + ListSegmentReferencesCommand, + ListSegmentsCommand, + ListTagsForResourceCommand, + PutProjectEventsCommand, + StartExperimentCommand, + StartLaunchCommand, + StopExperimentCommand, + StopLaunchCommand, + TagResourceCommand, + TestSegmentPatternCommand, + UntagResourceCommand, + UpdateExperimentCommand, + UpdateFeatureCommand, + UpdateLaunchCommand, + UpdateProjectCommand, + UpdateProjectDataDeliveryCommand, +}; + +export interface Evidently { /** - * @public - *

This operation assigns feature variation to user sessions. For each user session, you pass - * in an entityID that represents the user. Evidently then checks the evaluation - * rules and assigns the variation.

- *

The first rules that are evaluated are the override rules. If the user's - * entityID matches an override rule, the user is served the variation specified - * by that rule.

- *

Next, if there is a launch of the feature, the user might be assigned to a variation in - * the launch. The chance of this depends on the percentage of users that are allocated to that - * launch. If the user is enrolled in the launch, the variation they are served depends on the - * allocation of the various feature variations used for the launch.

- *

If the user is not assigned to a launch, and there is an ongoing experiment for this feature, the user might - * be assigned to a variation in the experiment. The chance of this - * depends on the percentage of users that are allocated to that experiment. If the user is enrolled in the experiment, - * the variation they are served depends on the allocation of the various feature variations used for the experiment.

- *

If the user is not assigned to a launch or experiment, they are served the default variation.

+ * @see {@link BatchEvaluateFeatureCommand} */ - public batchEvaluateFeature( + batchEvaluateFeature( args: BatchEvaluateFeatureCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchEvaluateFeature( + batchEvaluateFeature( args: BatchEvaluateFeatureCommandInput, cb: (err: any, data?: BatchEvaluateFeatureCommandOutput) => void ): void; - public batchEvaluateFeature( + batchEvaluateFeature( args: BatchEvaluateFeatureCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchEvaluateFeatureCommandOutput) => void ): void; - public batchEvaluateFeature( - args: BatchEvaluateFeatureCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchEvaluateFeatureCommandOutput) => void), - cb?: (err: any, data?: BatchEvaluateFeatureCommandOutput) => void - ): Promise | void { - const command = new BatchEvaluateFeatureCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Evidently experiment. Before you create an experiment, - * you must create the feature to use for the experiment.

- *

An experiment helps you make feature design - * decisions based on evidence and data. An experiment can test as - * many as five variations at once. Evidently collects experiment data and analyzes it by statistical methods, and provides - * clear recommendations about which variations perform better.

- *

You can optionally specify a segment to have the experiment consider only certain audience - * types in the experiment, such as using only user sessions from a certain location or who use a certain internet browser.

- *

Don't use this operation to update an existing experiment. Instead, use - * UpdateExperiment.

+ * @see {@link CreateExperimentCommand} */ - public createExperiment( + createExperiment( args: CreateExperimentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createExperiment( + createExperiment( args: CreateExperimentCommandInput, cb: (err: any, data?: CreateExperimentCommandOutput) => void ): void; - public createExperiment( + createExperiment( args: CreateExperimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExperimentCommandOutput) => void ): void; - public createExperiment( - args: CreateExperimentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateExperimentCommandOutput) => void), - cb?: (err: any, data?: CreateExperimentCommandOutput) => void - ): Promise | void { - const command = new CreateExperimentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Evidently feature that you want to launch or test. You can define up to - * five variations of a feature, and use these variations in your launches and experiments. A feature must be created in - * a project. For information about creating a project, see CreateProject.

- *

Don't use this operation to update an existing feature. Instead, use - * UpdateFeature.

+ * @see {@link CreateFeatureCommand} */ - public createFeature( - args: CreateFeatureCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createFeature( - args: CreateFeatureCommandInput, - cb: (err: any, data?: CreateFeatureCommandOutput) => void - ): void; - public createFeature( + createFeature(args: CreateFeatureCommandInput, options?: __HttpHandlerOptions): Promise; + createFeature(args: CreateFeatureCommandInput, cb: (err: any, data?: CreateFeatureCommandOutput) => void): void; + createFeature( args: CreateFeatureCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFeatureCommandOutput) => void ): void; - public createFeature( - args: CreateFeatureCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFeatureCommandOutput) => void), - cb?: (err: any, data?: CreateFeatureCommandOutput) => void - ): Promise | void { - const command = new CreateFeatureCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a launch of a given feature. Before you create a launch, you - * must create the feature to use for the launch.

- *

You can use a launch to safely validate new features by serving them to a specified - * percentage of your users while you roll out the feature. You can monitor the performance of - * the new feature to help you decide when to ramp up traffic to more users. This helps you - * reduce risk and identify unintended consequences before you fully launch the feature.

- *

Don't use this operation to update an existing launch. Instead, use - * UpdateLaunch.

+ * @see {@link CreateLaunchCommand} */ - public createLaunch( - args: CreateLaunchCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createLaunch(args: CreateLaunchCommandInput, cb: (err: any, data?: CreateLaunchCommandOutput) => void): void; - public createLaunch( + createLaunch(args: CreateLaunchCommandInput, options?: __HttpHandlerOptions): Promise; + createLaunch(args: CreateLaunchCommandInput, cb: (err: any, data?: CreateLaunchCommandOutput) => void): void; + createLaunch( args: CreateLaunchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLaunchCommandOutput) => void ): void; - public createLaunch( - args: CreateLaunchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLaunchCommandOutput) => void), - cb?: (err: any, data?: CreateLaunchCommandOutput) => void - ): Promise | void { - const command = new CreateLaunchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a project, which is the logical object in Evidently that can contain features, launches, and - * experiments. Use projects to group similar features together.

- *

To update an existing project, use UpdateProject.

+ * @see {@link CreateProjectCommand} */ - public createProject( - args: CreateProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createProject( - args: CreateProjectCommandInput, - cb: (err: any, data?: CreateProjectCommandOutput) => void - ): void; - public createProject( + createProject(args: CreateProjectCommandInput, options?: __HttpHandlerOptions): Promise; + createProject(args: CreateProjectCommandInput, cb: (err: any, data?: CreateProjectCommandOutput) => void): void; + createProject( args: CreateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectCommandOutput) => void ): void; - public createProject( - args: CreateProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProjectCommandOutput) => void), - cb?: (err: any, data?: CreateProjectCommandOutput) => void - ): Promise | void { - const command = new CreateProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this operation to define a segment of your audience. A segment - * is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, - * users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, - * such as age.

- *

Using a segment in an experiment limits that experiment to evaluate only the users who match the segment - * criteria. Using one or more segments in a launch allows you to define different traffic splits for the different - * audience segments.

- *

For more information about segment pattern syntax, see - * - * Segment rule pattern syntax.

- *

The pattern that you define for a segment is matched against the value of evaluationContext, which - * is passed into Evidently in the EvaluateFeature operation, - * when Evidently assigns a feature variation to a user.

+ * @see {@link CreateSegmentCommand} */ - public createSegment( - args: CreateSegmentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createSegment( - args: CreateSegmentCommandInput, - cb: (err: any, data?: CreateSegmentCommandOutput) => void - ): void; - public createSegment( + createSegment(args: CreateSegmentCommandInput, options?: __HttpHandlerOptions): Promise; + createSegment(args: CreateSegmentCommandInput, cb: (err: any, data?: CreateSegmentCommandOutput) => void): void; + createSegment( args: CreateSegmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSegmentCommandOutput) => void ): void; - public createSegment( - args: CreateSegmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSegmentCommandOutput) => void), - cb?: (err: any, data?: CreateSegmentCommandOutput) => void - ): Promise | void { - const command = new CreateSegmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Evidently experiment. The feature used for the experiment is not deleted.

- *

To stop an experiment without deleting it, use StopExperiment.

+ * @see {@link DeleteExperimentCommand} */ - public deleteExperiment( + deleteExperiment( args: DeleteExperimentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteExperiment( + deleteExperiment( args: DeleteExperimentCommandInput, cb: (err: any, data?: DeleteExperimentCommandOutput) => void ): void; - public deleteExperiment( + deleteExperiment( args: DeleteExperimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteExperimentCommandOutput) => void ): void; - public deleteExperiment( - args: DeleteExperimentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteExperimentCommandOutput) => void), - cb?: (err: any, data?: DeleteExperimentCommandOutput) => void - ): Promise | void { - const command = new DeleteExperimentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Evidently feature.

+ * @see {@link DeleteFeatureCommand} */ - public deleteFeature( - args: DeleteFeatureCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteFeature( - args: DeleteFeatureCommandInput, - cb: (err: any, data?: DeleteFeatureCommandOutput) => void - ): void; - public deleteFeature( + deleteFeature(args: DeleteFeatureCommandInput, options?: __HttpHandlerOptions): Promise; + deleteFeature(args: DeleteFeatureCommandInput, cb: (err: any, data?: DeleteFeatureCommandOutput) => void): void; + deleteFeature( args: DeleteFeatureCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFeatureCommandOutput) => void ): void; - public deleteFeature( - args: DeleteFeatureCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFeatureCommandOutput) => void), - cb?: (err: any, data?: DeleteFeatureCommandOutput) => void - ): Promise | void { - const command = new DeleteFeatureCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Evidently launch. The feature used for the launch is not deleted.

- *

To stop a launch without deleting it, use StopLaunch.

+ * @see {@link DeleteLaunchCommand} */ - public deleteLaunch( - args: DeleteLaunchCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteLaunch(args: DeleteLaunchCommandInput, cb: (err: any, data?: DeleteLaunchCommandOutput) => void): void; - public deleteLaunch( + deleteLaunch(args: DeleteLaunchCommandInput, options?: __HttpHandlerOptions): Promise; + deleteLaunch(args: DeleteLaunchCommandInput, cb: (err: any, data?: DeleteLaunchCommandOutput) => void): void; + deleteLaunch( args: DeleteLaunchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLaunchCommandOutput) => void ): void; - public deleteLaunch( - args: DeleteLaunchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLaunchCommandOutput) => void), - cb?: (err: any, data?: DeleteLaunchCommandOutput) => void - ): Promise | void { - const command = new DeleteLaunchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Evidently project. Before you can delete a project, you must delete all the - * features that the project contains. To delete a feature, use DeleteFeature.

+ * @see {@link DeleteProjectCommand} */ - public deleteProject( - args: DeleteProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteProject( - args: DeleteProjectCommandInput, - cb: (err: any, data?: DeleteProjectCommandOutput) => void - ): void; - public deleteProject( + deleteProject(args: DeleteProjectCommandInput, options?: __HttpHandlerOptions): Promise; + deleteProject(args: DeleteProjectCommandInput, cb: (err: any, data?: DeleteProjectCommandOutput) => void): void; + deleteProject( args: DeleteProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProjectCommandOutput) => void ): void; - public deleteProject( - args: DeleteProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProjectCommandOutput) => void), - cb?: (err: any, data?: DeleteProjectCommandOutput) => void - ): Promise | void { - const command = new DeleteProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a segment. You can't delete a segment that is being used in a launch or experiment, even if that - * launch or experiment is not currently running.

+ * @see {@link DeleteSegmentCommand} */ - public deleteSegment( - args: DeleteSegmentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteSegment( - args: DeleteSegmentCommandInput, - cb: (err: any, data?: DeleteSegmentCommandOutput) => void - ): void; - public deleteSegment( + deleteSegment(args: DeleteSegmentCommandInput, options?: __HttpHandlerOptions): Promise; + deleteSegment(args: DeleteSegmentCommandInput, cb: (err: any, data?: DeleteSegmentCommandOutput) => void): void; + deleteSegment( args: DeleteSegmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSegmentCommandOutput) => void ): void; - public deleteSegment( - args: DeleteSegmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSegmentCommandOutput) => void), - cb?: (err: any, data?: DeleteSegmentCommandOutput) => void - ): Promise | void { - const command = new DeleteSegmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation assigns a feature variation to one given user session. You pass in an - * entityID that represents the user. Evidently then checks the evaluation rules - * and assigns the variation.

- *

The first rules that are evaluated are the override rules. If the user's - * entityID matches an override rule, the user is served the variation specified - * by that rule.

- *

If there is a current launch with this feature that uses segment overrides, and - * if the user session's evaluationContext matches a segment rule defined in a - * segment override, the configuration in the segment overrides is used. For more information - * about segments, see CreateSegment - * and - * Use segments to focus your - * audience.

- *

If there is a launch with no segment overrides, the user might be assigned to a variation in - * the launch. The chance of this depends on the percentage of users that are allocated to that - * launch. If the user is enrolled in the launch, the variation they are served depends on the - * allocation of the various feature variations used for the launch.

- *

If the user is not assigned to a launch, and there is an ongoing experiment for this feature, the user might - * be assigned to a variation in the experiment. The chance of this - * depends on the percentage of users that are allocated to that experiment.

- *

If the experiment uses a segment, then only - * user sessions with evaluationContext values that match the segment rule are used in the experiment.

- *

If the user is enrolled in the experiment, - * the variation they are served depends on the allocation of the various feature variations used for the experiment.

- *

If the user is not assigned to a launch or experiment, they are served the default variation.

+ * @see {@link EvaluateFeatureCommand} */ - public evaluateFeature( + evaluateFeature( args: EvaluateFeatureCommandInput, options?: __HttpHandlerOptions ): Promise; - public evaluateFeature( - args: EvaluateFeatureCommandInput, - cb: (err: any, data?: EvaluateFeatureCommandOutput) => void - ): void; - public evaluateFeature( + evaluateFeature(args: EvaluateFeatureCommandInput, cb: (err: any, data?: EvaluateFeatureCommandOutput) => void): void; + evaluateFeature( args: EvaluateFeatureCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EvaluateFeatureCommandOutput) => void ): void; - public evaluateFeature( - args: EvaluateFeatureCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EvaluateFeatureCommandOutput) => void), - cb?: (err: any, data?: EvaluateFeatureCommandOutput) => void - ): Promise | void { - const command = new EvaluateFeatureCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the details about one experiment. You must already know the - * experiment name. To retrieve a list of experiments in your account, use ListExperiments.

+ * @see {@link GetExperimentCommand} */ - public getExperiment( - args: GetExperimentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getExperiment( - args: GetExperimentCommandInput, - cb: (err: any, data?: GetExperimentCommandOutput) => void - ): void; - public getExperiment( + getExperiment(args: GetExperimentCommandInput, options?: __HttpHandlerOptions): Promise; + getExperiment(args: GetExperimentCommandInput, cb: (err: any, data?: GetExperimentCommandOutput) => void): void; + getExperiment( args: GetExperimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExperimentCommandOutput) => void ): void; - public getExperiment( - args: GetExperimentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetExperimentCommandOutput) => void), - cb?: (err: any, data?: GetExperimentCommandOutput) => void - ): Promise | void { - const command = new GetExperimentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the results of a running or completed experiment. No results are available until - * there have been 100 events for each variation and at least 10 minutes have passed since the start of the experiment. - * To increase the statistical power, Evidently performs an additional offline p-value analysis at the end of the experiment. - * Offline p-value analysis can detect statistical significance in some cases where the anytime p-values used during - * the experiment do not find statistical significance.

- *

Experiment - * results are available up to 63 days after the start of the experiment. They are not available after that because - * of CloudWatch data retention policies.

+ * @see {@link GetExperimentResultsCommand} */ - public getExperimentResults( + getExperimentResults( args: GetExperimentResultsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getExperimentResults( + getExperimentResults( args: GetExperimentResultsCommandInput, cb: (err: any, data?: GetExperimentResultsCommandOutput) => void ): void; - public getExperimentResults( + getExperimentResults( args: GetExperimentResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExperimentResultsCommandOutput) => void ): void; - public getExperimentResults( - args: GetExperimentResultsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetExperimentResultsCommandOutput) => void), - cb?: (err: any, data?: GetExperimentResultsCommandOutput) => void - ): Promise | void { - const command = new GetExperimentResultsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the details about one feature. You must already know the feature name. To - * retrieve a list of features in your account, use ListFeatures.

+ * @see {@link GetFeatureCommand} */ - public getFeature(args: GetFeatureCommandInput, options?: __HttpHandlerOptions): Promise; - public getFeature(args: GetFeatureCommandInput, cb: (err: any, data?: GetFeatureCommandOutput) => void): void; - public getFeature( + getFeature(args: GetFeatureCommandInput, options?: __HttpHandlerOptions): Promise; + getFeature(args: GetFeatureCommandInput, cb: (err: any, data?: GetFeatureCommandOutput) => void): void; + getFeature( args: GetFeatureCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFeatureCommandOutput) => void ): void; - public getFeature( - args: GetFeatureCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFeatureCommandOutput) => void), - cb?: (err: any, data?: GetFeatureCommandOutput) => void - ): Promise | void { - const command = new GetFeatureCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the details about one launch. You must already know the - * launch name. To retrieve a list of launches in your account, use ListLaunches.

+ * @see {@link GetLaunchCommand} */ - public getLaunch(args: GetLaunchCommandInput, options?: __HttpHandlerOptions): Promise; - public getLaunch(args: GetLaunchCommandInput, cb: (err: any, data?: GetLaunchCommandOutput) => void): void; - public getLaunch( + getLaunch(args: GetLaunchCommandInput, options?: __HttpHandlerOptions): Promise; + getLaunch(args: GetLaunchCommandInput, cb: (err: any, data?: GetLaunchCommandOutput) => void): void; + getLaunch( args: GetLaunchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLaunchCommandOutput) => void ): void; - public getLaunch( - args: GetLaunchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLaunchCommandOutput) => void), - cb?: (err: any, data?: GetLaunchCommandOutput) => void - ): Promise | void { - const command = new GetLaunchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the details about one launch. You must already know the - * project name. To retrieve a list of projects in your account, use ListProjects.

+ * @see {@link GetProjectCommand} */ - public getProject(args: GetProjectCommandInput, options?: __HttpHandlerOptions): Promise; - public getProject(args: GetProjectCommandInput, cb: (err: any, data?: GetProjectCommandOutput) => void): void; - public getProject( + getProject(args: GetProjectCommandInput, options?: __HttpHandlerOptions): Promise; + getProject(args: GetProjectCommandInput, cb: (err: any, data?: GetProjectCommandOutput) => void): void; + getProject( args: GetProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProjectCommandOutput) => void ): void; - public getProject( - args: GetProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetProjectCommandOutput) => void), - cb?: (err: any, data?: GetProjectCommandOutput) => void - ): Promise | void { - const command = new GetProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the specified segment. Specify the segment you want to view - * by specifying its ARN.

+ * @see {@link GetSegmentCommand} */ - public getSegment(args: GetSegmentCommandInput, options?: __HttpHandlerOptions): Promise; - public getSegment(args: GetSegmentCommandInput, cb: (err: any, data?: GetSegmentCommandOutput) => void): void; - public getSegment( + getSegment(args: GetSegmentCommandInput, options?: __HttpHandlerOptions): Promise; + getSegment(args: GetSegmentCommandInput, cb: (err: any, data?: GetSegmentCommandOutput) => void): void; + getSegment( args: GetSegmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSegmentCommandOutput) => void ): void; - public getSegment( - args: GetSegmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSegmentCommandOutput) => void), - cb?: (err: any, data?: GetSegmentCommandOutput) => void - ): Promise | void { - const command = new GetSegmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns configuration details about all the experiments in the specified project.

+ * @see {@link ListExperimentsCommand} */ - public listExperiments( + listExperiments( args: ListExperimentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listExperiments( - args: ListExperimentsCommandInput, - cb: (err: any, data?: ListExperimentsCommandOutput) => void - ): void; - public listExperiments( + listExperiments(args: ListExperimentsCommandInput, cb: (err: any, data?: ListExperimentsCommandOutput) => void): void; + listExperiments( args: ListExperimentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExperimentsCommandOutput) => void ): void; - public listExperiments( - args: ListExperimentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListExperimentsCommandOutput) => void), - cb?: (err: any, data?: ListExperimentsCommandOutput) => void - ): Promise | void { - const command = new ListExperimentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns configuration details about all the features in the specified project.

+ * @see {@link ListFeaturesCommand} */ - public listFeatures( - args: ListFeaturesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listFeatures(args: ListFeaturesCommandInput, cb: (err: any, data?: ListFeaturesCommandOutput) => void): void; - public listFeatures( + listFeatures(args: ListFeaturesCommandInput, options?: __HttpHandlerOptions): Promise; + listFeatures(args: ListFeaturesCommandInput, cb: (err: any, data?: ListFeaturesCommandOutput) => void): void; + listFeatures( args: ListFeaturesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFeaturesCommandOutput) => void ): void; - public listFeatures( - args: ListFeaturesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFeaturesCommandOutput) => void), - cb?: (err: any, data?: ListFeaturesCommandOutput) => void - ): Promise | void { - const command = new ListFeaturesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns configuration details about all the launches in the specified project.

+ * @see {@link ListLaunchesCommand} */ - public listLaunches( - args: ListLaunchesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listLaunches(args: ListLaunchesCommandInput, cb: (err: any, data?: ListLaunchesCommandOutput) => void): void; - public listLaunches( + listLaunches(args: ListLaunchesCommandInput, options?: __HttpHandlerOptions): Promise; + listLaunches(args: ListLaunchesCommandInput, cb: (err: any, data?: ListLaunchesCommandOutput) => void): void; + listLaunches( args: ListLaunchesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLaunchesCommandOutput) => void ): void; - public listLaunches( - args: ListLaunchesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLaunchesCommandOutput) => void), - cb?: (err: any, data?: ListLaunchesCommandOutput) => void - ): Promise | void { - const command = new ListLaunchesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns configuration details about all the projects in the current Region in your - * account.

+ * @see {@link ListProjectsCommand} */ - public listProjects( - args: ListProjectsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void; - public listProjects( + listProjects(args: ListProjectsCommandInput, options?: __HttpHandlerOptions): Promise; + listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void; + listProjects( args: ListProjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProjectsCommandOutput) => void ): void; - public listProjects( - args: ListProjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProjectsCommandOutput) => void), - cb?: (err: any, data?: ListProjectsCommandOutput) => void - ): Promise | void { - const command = new ListProjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this operation to find which experiments or launches are using a specified segment.

+ * @see {@link ListSegmentReferencesCommand} */ - public listSegmentReferences( + listSegmentReferences( args: ListSegmentReferencesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSegmentReferences( + listSegmentReferences( args: ListSegmentReferencesCommandInput, cb: (err: any, data?: ListSegmentReferencesCommandOutput) => void ): void; - public listSegmentReferences( + listSegmentReferences( args: ListSegmentReferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSegmentReferencesCommandOutput) => void ): void; - public listSegmentReferences( - args: ListSegmentReferencesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSegmentReferencesCommandOutput) => void), - cb?: (err: any, data?: ListSegmentReferencesCommandOutput) => void - ): Promise | void { - const command = new ListSegmentReferencesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of audience segments that you have created in your account in this Region.

+ * @see {@link ListSegmentsCommand} */ - public listSegments( - args: ListSegmentsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listSegments(args: ListSegmentsCommandInput, cb: (err: any, data?: ListSegmentsCommandOutput) => void): void; - public listSegments( + listSegments(args: ListSegmentsCommandInput, options?: __HttpHandlerOptions): Promise; + listSegments(args: ListSegmentsCommandInput, cb: (err: any, data?: ListSegmentsCommandOutput) => void): void; + listSegments( args: ListSegmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSegmentsCommandOutput) => void ): void; - public listSegments( - args: ListSegmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSegmentsCommandOutput) => void), - cb?: (err: any, data?: ListSegmentsCommandOutput) => void - ): Promise | void { - const command = new ListSegmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays the tags associated with an Evidently resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sends performance events to Evidently. These events can be used to evaluate a launch or - * an experiment.

+ * @see {@link PutProjectEventsCommand} */ - public putProjectEvents( + putProjectEvents( args: PutProjectEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putProjectEvents( + putProjectEvents( args: PutProjectEventsCommandInput, cb: (err: any, data?: PutProjectEventsCommandOutput) => void ): void; - public putProjectEvents( + putProjectEvents( args: PutProjectEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutProjectEventsCommandOutput) => void ): void; - public putProjectEvents( - args: PutProjectEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutProjectEventsCommandOutput) => void), - cb?: (err: any, data?: PutProjectEventsCommandOutput) => void - ): Promise | void { - const command = new PutProjectEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts an existing experiment. To create an experiment, - * use CreateExperiment.

+ * @see {@link StartExperimentCommand} */ - public startExperiment( + startExperiment( args: StartExperimentCommandInput, options?: __HttpHandlerOptions ): Promise; - public startExperiment( - args: StartExperimentCommandInput, - cb: (err: any, data?: StartExperimentCommandOutput) => void - ): void; - public startExperiment( + startExperiment(args: StartExperimentCommandInput, cb: (err: any, data?: StartExperimentCommandOutput) => void): void; + startExperiment( args: StartExperimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartExperimentCommandOutput) => void ): void; - public startExperiment( - args: StartExperimentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartExperimentCommandOutput) => void), - cb?: (err: any, data?: StartExperimentCommandOutput) => void - ): Promise | void { - const command = new StartExperimentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts an existing launch. To create a launch, - * use CreateLaunch.

+ * @see {@link StartLaunchCommand} */ - public startLaunch(args: StartLaunchCommandInput, options?: __HttpHandlerOptions): Promise; - public startLaunch(args: StartLaunchCommandInput, cb: (err: any, data?: StartLaunchCommandOutput) => void): void; - public startLaunch( + startLaunch(args: StartLaunchCommandInput, options?: __HttpHandlerOptions): Promise; + startLaunch(args: StartLaunchCommandInput, cb: (err: any, data?: StartLaunchCommandOutput) => void): void; + startLaunch( args: StartLaunchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartLaunchCommandOutput) => void ): void; - public startLaunch( - args: StartLaunchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartLaunchCommandOutput) => void), - cb?: (err: any, data?: StartLaunchCommandOutput) => void - ): Promise | void { - const command = new StartLaunchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops an experiment that is currently running. If you stop an experiment, you can't - * resume it or restart it.

+ * @see {@link StopExperimentCommand} */ - public stopExperiment( + stopExperiment( args: StopExperimentCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopExperiment( - args: StopExperimentCommandInput, - cb: (err: any, data?: StopExperimentCommandOutput) => void - ): void; - public stopExperiment( + stopExperiment(args: StopExperimentCommandInput, cb: (err: any, data?: StopExperimentCommandOutput) => void): void; + stopExperiment( args: StopExperimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopExperimentCommandOutput) => void ): void; - public stopExperiment( - args: StopExperimentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopExperimentCommandOutput) => void), - cb?: (err: any, data?: StopExperimentCommandOutput) => void - ): Promise | void { - const command = new StopExperimentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops a launch that is currently running. After you stop a launch, you will not be able to resume it or restart it. - * Also, it - * will not be evaluated as a rule for traffic allocation, and the traffic that was allocated to the launch - * will instead be available to the feature's experiment, if there is one. Otherwise, all traffic - * will be served the default variation after the launch is stopped.

+ * @see {@link StopLaunchCommand} */ - public stopLaunch(args: StopLaunchCommandInput, options?: __HttpHandlerOptions): Promise; - public stopLaunch(args: StopLaunchCommandInput, cb: (err: any, data?: StopLaunchCommandOutput) => void): void; - public stopLaunch( + stopLaunch(args: StopLaunchCommandInput, options?: __HttpHandlerOptions): Promise; + stopLaunch(args: StopLaunchCommandInput, cb: (err: any, data?: StopLaunchCommandOutput) => void): void; + stopLaunch( args: StopLaunchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopLaunchCommandOutput) => void ): void; - public stopLaunch( - args: StopLaunchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopLaunchCommandOutput) => void), - cb?: (err: any, data?: StopLaunchCommandOutput) => void - ): Promise | void { - const command = new StopLaunchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns one or more tags (key-value pairs) to the specified CloudWatch Evidently resource. Projects, - * features, launches, and experiments can be tagged.

- *

Tags can help you organize and categorize your resources. You can also use them to scope user - * permissions by granting a user - * permission to access or change only resources with certain tag values.

- *

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

- *

You can use the TagResource action with a resource that already has tags. - * If you specify a new tag key for the resource, - * this tag is appended to the list of tags associated - * with the alarm. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces - * the previous value for that tag.

- *

You can associate as many as 50 tags with a resource.

- *

For more information, see Tagging Amazon Web Services resources.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this operation to test a rules pattern that you plan to use to create an audience segment. - * For more information about segments, see CreateSegment.

+ * @see {@link TestSegmentPatternCommand} */ - public testSegmentPattern( + testSegmentPattern( args: TestSegmentPatternCommandInput, options?: __HttpHandlerOptions ): Promise; - public testSegmentPattern( + testSegmentPattern( args: TestSegmentPatternCommandInput, cb: (err: any, data?: TestSegmentPatternCommandOutput) => void ): void; - public testSegmentPattern( + testSegmentPattern( args: TestSegmentPatternCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestSegmentPatternCommandOutput) => void ): void; - public testSegmentPattern( - args: TestSegmentPatternCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestSegmentPatternCommandOutput) => void), - cb?: (err: any, data?: TestSegmentPatternCommandOutput) => void - ): Promise | void { - const command = new TestSegmentPatternCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from the specified resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an Evidently experiment.

- *

Don't use this operation to update an experiment's tag. Instead, use - * TagResource.

+ * @see {@link UpdateExperimentCommand} */ - public updateExperiment( + updateExperiment( args: UpdateExperimentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateExperiment( + updateExperiment( args: UpdateExperimentCommandInput, cb: (err: any, data?: UpdateExperimentCommandOutput) => void ): void; - public updateExperiment( + updateExperiment( args: UpdateExperimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateExperimentCommandOutput) => void ): void; - public updateExperiment( - args: UpdateExperimentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateExperimentCommandOutput) => void), - cb?: (err: any, data?: UpdateExperimentCommandOutput) => void - ): Promise | void { - const command = new UpdateExperimentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing feature.

- *

You can't use this operation to update the tags of an existing feature. Instead, use - * TagResource.

+ * @see {@link UpdateFeatureCommand} */ - public updateFeature( - args: UpdateFeatureCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateFeature( - args: UpdateFeatureCommandInput, - cb: (err: any, data?: UpdateFeatureCommandOutput) => void - ): void; - public updateFeature( + updateFeature(args: UpdateFeatureCommandInput, options?: __HttpHandlerOptions): Promise; + updateFeature(args: UpdateFeatureCommandInput, cb: (err: any, data?: UpdateFeatureCommandOutput) => void): void; + updateFeature( args: UpdateFeatureCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFeatureCommandOutput) => void ): void; - public updateFeature( - args: UpdateFeatureCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFeatureCommandOutput) => void), - cb?: (err: any, data?: UpdateFeatureCommandOutput) => void - ): Promise | void { - const command = new UpdateFeatureCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a launch of a given feature.

- *

Don't use this operation to update the tags of an existing launch. Instead, use - * TagResource.

+ * @see {@link UpdateLaunchCommand} */ - public updateLaunch( - args: UpdateLaunchCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateLaunch(args: UpdateLaunchCommandInput, cb: (err: any, data?: UpdateLaunchCommandOutput) => void): void; - public updateLaunch( + updateLaunch(args: UpdateLaunchCommandInput, options?: __HttpHandlerOptions): Promise; + updateLaunch(args: UpdateLaunchCommandInput, cb: (err: any, data?: UpdateLaunchCommandOutput) => void): void; + updateLaunch( args: UpdateLaunchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLaunchCommandOutput) => void ): void; - public updateLaunch( - args: UpdateLaunchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLaunchCommandOutput) => void), - cb?: (err: any, data?: UpdateLaunchCommandOutput) => void - ): Promise | void { - const command = new UpdateLaunchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the description of an existing project.

- *

To create a new project, use CreateProject.

- *

Don't use this operation to update the data storage options of a project. Instead, use - * UpdateProjectDataDelivery.

- *

Don't use this operation to update the tags of a project. Instead, use - * TagResource.

+ * @see {@link UpdateProjectCommand} */ - public updateProject( - args: UpdateProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateProject( - args: UpdateProjectCommandInput, - cb: (err: any, data?: UpdateProjectCommandOutput) => void - ): void; - public updateProject( + updateProject(args: UpdateProjectCommandInput, options?: __HttpHandlerOptions): Promise; + updateProject(args: UpdateProjectCommandInput, cb: (err: any, data?: UpdateProjectCommandOutput) => void): void; + updateProject( args: UpdateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProjectCommandOutput) => void ): void; - public updateProject( - args: UpdateProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProjectCommandOutput) => void), - cb?: (err: any, data?: UpdateProjectCommandOutput) => void - ): Promise | void { - const command = new UpdateProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the data storage options for this project. If you store evaluation events, you an - * keep them and analyze them on your own. If you choose not to store evaluation events, - * Evidently deletes them after using them to produce metrics and other experiment results that - * you can view.

- *

You can't specify both cloudWatchLogs and s3Destination in the same operation.

+ * @see {@link UpdateProjectDataDeliveryCommand} */ - public updateProjectDataDelivery( + updateProjectDataDelivery( args: UpdateProjectDataDeliveryCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateProjectDataDelivery( + updateProjectDataDelivery( args: UpdateProjectDataDeliveryCommandInput, cb: (err: any, data?: UpdateProjectDataDeliveryCommandOutput) => void ): void; - public updateProjectDataDelivery( + updateProjectDataDelivery( args: UpdateProjectDataDeliveryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProjectDataDeliveryCommandOutput) => void ): void; - public updateProjectDataDelivery( - args: UpdateProjectDataDeliveryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProjectDataDeliveryCommandOutput) => void), - cb?: (err: any, data?: UpdateProjectDataDeliveryCommandOutput) => void - ): Promise | void { - const command = new UpdateProjectDataDeliveryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

You can use Amazon CloudWatch Evidently to safely validate new features by serving + * them to a specified percentage + * of your users while you roll out the feature. You can monitor the performance of the new feature + * to help you decide when to ramp up traffic to your users. This helps you + * reduce risk and identify unintended consequences before you fully launch the feature.

+ *

You can also conduct A/B experiments to make feature design decisions based on evidence + * and data. An experiment can test as many as five variations at once. Evidently collects + * experiment data and analyzes it using statistical methods. It also provides clear + * recommendations about which variations perform better. You can test both user-facing features + * and backend features.

+ */ +export class Evidently extends EvidentlyClient implements Evidently {} +createAggregatedClient(commands, Evidently); diff --git a/clients/client-finspace-data/src/FinspaceData.ts b/clients/client-finspace-data/src/FinspaceData.ts index 294d14713834..9af344b7b3ac 100644 --- a/clients/client-finspace-data/src/FinspaceData.ts +++ b/clients/client-finspace-data/src/FinspaceData.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -124,988 +125,478 @@ import { UpdatePermissionGroupCommandOutput, } from "./commands/UpdatePermissionGroupCommand"; import { UpdateUserCommand, UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand"; -import { FinspaceDataClient } from "./FinspaceDataClient"; +import { FinspaceDataClient, FinspaceDataClientConfig } from "./FinspaceDataClient"; -/** - * @public - *

The FinSpace APIs let you take actions inside the FinSpace.

- */ -export class FinspaceData extends FinspaceDataClient { +const commands = { + AssociateUserToPermissionGroupCommand, + CreateChangesetCommand, + CreateDatasetCommand, + CreateDataViewCommand, + CreatePermissionGroupCommand, + CreateUserCommand, + DeleteDatasetCommand, + DeletePermissionGroupCommand, + DisableUserCommand, + DisassociateUserFromPermissionGroupCommand, + EnableUserCommand, + GetChangesetCommand, + GetDatasetCommand, + GetDataViewCommand, + GetExternalDataViewAccessDetailsCommand, + GetPermissionGroupCommand, + GetProgrammaticAccessCredentialsCommand, + GetUserCommand, + GetWorkingLocationCommand, + ListChangesetsCommand, + ListDatasetsCommand, + ListDataViewsCommand, + ListPermissionGroupsCommand, + ListPermissionGroupsByUserCommand, + ListUsersCommand, + ListUsersByPermissionGroupCommand, + ResetUserPasswordCommand, + UpdateChangesetCommand, + UpdateDatasetCommand, + UpdatePermissionGroupCommand, + UpdateUserCommand, +}; + +export interface FinspaceData { /** - * @public - *

Adds a user account to a permission group to grant permissions for actions a user can perform in FinSpace.

+ * @see {@link AssociateUserToPermissionGroupCommand} */ - public associateUserToPermissionGroup( + associateUserToPermissionGroup( args: AssociateUserToPermissionGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateUserToPermissionGroup( + associateUserToPermissionGroup( args: AssociateUserToPermissionGroupCommandInput, cb: (err: any, data?: AssociateUserToPermissionGroupCommandOutput) => void ): void; - public associateUserToPermissionGroup( + associateUserToPermissionGroup( args: AssociateUserToPermissionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateUserToPermissionGroupCommandOutput) => void ): void; - public associateUserToPermissionGroup( - args: AssociateUserToPermissionGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateUserToPermissionGroupCommandOutput) => void), - cb?: (err: any, data?: AssociateUserToPermissionGroupCommandOutput) => void - ): Promise | void { - const command = new AssociateUserToPermissionGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new Changeset in a FinSpace Dataset.

+ * @see {@link CreateChangesetCommand} */ - public createChangeset( + createChangeset( args: CreateChangesetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createChangeset( - args: CreateChangesetCommandInput, - cb: (err: any, data?: CreateChangesetCommandOutput) => void - ): void; - public createChangeset( + createChangeset(args: CreateChangesetCommandInput, cb: (err: any, data?: CreateChangesetCommandOutput) => void): void; + createChangeset( args: CreateChangesetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChangesetCommandOutput) => void ): void; - public createChangeset( - args: CreateChangesetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateChangesetCommandOutput) => void), - cb?: (err: any, data?: CreateChangesetCommandOutput) => void - ): Promise | void { - const command = new CreateChangesetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new FinSpace Dataset.

+ * @see {@link CreateDatasetCommand} */ - public createDataset( - args: CreateDatasetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createDataset( - args: CreateDatasetCommandInput, - cb: (err: any, data?: CreateDatasetCommandOutput) => void - ): void; - public createDataset( + createDataset(args: CreateDatasetCommandInput, options?: __HttpHandlerOptions): Promise; + createDataset(args: CreateDatasetCommandInput, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void; + createDataset( args: CreateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetCommandOutput) => void ): void; - public createDataset( - args: CreateDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDatasetCommandOutput) => void), - cb?: (err: any, data?: CreateDatasetCommandOutput) => void - ): Promise | void { - const command = new CreateDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a Dataview for a Dataset.

+ * @see {@link CreateDataViewCommand} */ - public createDataView( + createDataView( args: CreateDataViewCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDataView( - args: CreateDataViewCommandInput, - cb: (err: any, data?: CreateDataViewCommandOutput) => void - ): void; - public createDataView( + createDataView(args: CreateDataViewCommandInput, cb: (err: any, data?: CreateDataViewCommandOutput) => void): void; + createDataView( args: CreateDataViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataViewCommandOutput) => void ): void; - public createDataView( - args: CreateDataViewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDataViewCommandOutput) => void), - cb?: (err: any, data?: CreateDataViewCommandOutput) => void - ): Promise | void { - const command = new CreateDataViewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a group of permissions for various actions that a user can perform in FinSpace.

+ * @see {@link CreatePermissionGroupCommand} */ - public createPermissionGroup( + createPermissionGroup( args: CreatePermissionGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPermissionGroup( + createPermissionGroup( args: CreatePermissionGroupCommandInput, cb: (err: any, data?: CreatePermissionGroupCommandOutput) => void ): void; - public createPermissionGroup( + createPermissionGroup( args: CreatePermissionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePermissionGroupCommandOutput) => void ): void; - public createPermissionGroup( - args: CreatePermissionGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePermissionGroupCommandOutput) => void), - cb?: (err: any, data?: CreatePermissionGroupCommandOutput) => void - ): Promise | void { - const command = new CreatePermissionGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new user in FinSpace.

+ * @see {@link CreateUserCommand} */ - public createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; - public createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; - public createUser( + createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; + createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; + createUser( args: CreateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserCommandOutput) => void ): void; - public createUser( - args: CreateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserCommandOutput) => void), - cb?: (err: any, data?: CreateUserCommandOutput) => void - ): Promise | void { - const command = new CreateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a FinSpace Dataset.

+ * @see {@link DeleteDatasetCommand} */ - public deleteDataset( - args: DeleteDatasetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDataset( - args: DeleteDatasetCommandInput, - cb: (err: any, data?: DeleteDatasetCommandOutput) => void - ): void; - public deleteDataset( + deleteDataset(args: DeleteDatasetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDataset(args: DeleteDatasetCommandInput, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void; + deleteDataset( args: DeleteDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetCommandOutput) => void ): void; - public deleteDataset( - args: DeleteDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDatasetCommandOutput) => void), - cb?: (err: any, data?: DeleteDatasetCommandOutput) => void - ): Promise | void { - const command = new DeleteDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a permission group. This action is irreversible.

+ * @see {@link DeletePermissionGroupCommand} */ - public deletePermissionGroup( + deletePermissionGroup( args: DeletePermissionGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePermissionGroup( + deletePermissionGroup( args: DeletePermissionGroupCommandInput, cb: (err: any, data?: DeletePermissionGroupCommandOutput) => void ): void; - public deletePermissionGroup( + deletePermissionGroup( args: DeletePermissionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePermissionGroupCommandOutput) => void ): void; - public deletePermissionGroup( - args: DeletePermissionGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePermissionGroupCommandOutput) => void), - cb?: (err: any, data?: DeletePermissionGroupCommandOutput) => void - ): Promise | void { - const command = new DeletePermissionGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Denies access to the FinSpace web application and API for the specified user.

+ * @see {@link DisableUserCommand} */ - public disableUser(args: DisableUserCommandInput, options?: __HttpHandlerOptions): Promise; - public disableUser(args: DisableUserCommandInput, cb: (err: any, data?: DisableUserCommandOutput) => void): void; - public disableUser( + disableUser(args: DisableUserCommandInput, options?: __HttpHandlerOptions): Promise; + disableUser(args: DisableUserCommandInput, cb: (err: any, data?: DisableUserCommandOutput) => void): void; + disableUser( args: DisableUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableUserCommandOutput) => void ): void; - public disableUser( - args: DisableUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableUserCommandOutput) => void), - cb?: (err: any, data?: DisableUserCommandOutput) => void - ): Promise | void { - const command = new DisableUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a user account from a permission group.

+ * @see {@link DisassociateUserFromPermissionGroupCommand} */ - public disassociateUserFromPermissionGroup( + disassociateUserFromPermissionGroup( args: DisassociateUserFromPermissionGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateUserFromPermissionGroup( + disassociateUserFromPermissionGroup( args: DisassociateUserFromPermissionGroupCommandInput, cb: (err: any, data?: DisassociateUserFromPermissionGroupCommandOutput) => void ): void; - public disassociateUserFromPermissionGroup( + disassociateUserFromPermissionGroup( args: DisassociateUserFromPermissionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateUserFromPermissionGroupCommandOutput) => void ): void; - public disassociateUserFromPermissionGroup( - args: DisassociateUserFromPermissionGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateUserFromPermissionGroupCommandOutput) => void), - cb?: (err: any, data?: DisassociateUserFromPermissionGroupCommandOutput) => void - ): Promise | void { - const command = new DisassociateUserFromPermissionGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows the specified user to access the FinSpace web application and API.

+ * @see {@link EnableUserCommand} */ - public enableUser(args: EnableUserCommandInput, options?: __HttpHandlerOptions): Promise; - public enableUser(args: EnableUserCommandInput, cb: (err: any, data?: EnableUserCommandOutput) => void): void; - public enableUser( + enableUser(args: EnableUserCommandInput, options?: __HttpHandlerOptions): Promise; + enableUser(args: EnableUserCommandInput, cb: (err: any, data?: EnableUserCommandOutput) => void): void; + enableUser( args: EnableUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableUserCommandOutput) => void ): void; - public enableUser( - args: EnableUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableUserCommandOutput) => void), - cb?: (err: any, data?: EnableUserCommandOutput) => void - ): Promise | void { - const command = new EnableUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get information about a Changeset.

+ * @see {@link GetChangesetCommand} */ - public getChangeset( - args: GetChangesetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getChangeset(args: GetChangesetCommandInput, cb: (err: any, data?: GetChangesetCommandOutput) => void): void; - public getChangeset( + getChangeset(args: GetChangesetCommandInput, options?: __HttpHandlerOptions): Promise; + getChangeset(args: GetChangesetCommandInput, cb: (err: any, data?: GetChangesetCommandOutput) => void): void; + getChangeset( args: GetChangesetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChangesetCommandOutput) => void ): void; - public getChangeset( - args: GetChangesetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetChangesetCommandOutput) => void), - cb?: (err: any, data?: GetChangesetCommandOutput) => void - ): Promise | void { - const command = new GetChangesetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a Dataset.

+ * @see {@link GetDatasetCommand} */ - public getDataset(args: GetDatasetCommandInput, options?: __HttpHandlerOptions): Promise; - public getDataset(args: GetDatasetCommandInput, cb: (err: any, data?: GetDatasetCommandOutput) => void): void; - public getDataset( + getDataset(args: GetDatasetCommandInput, options?: __HttpHandlerOptions): Promise; + getDataset(args: GetDatasetCommandInput, cb: (err: any, data?: GetDatasetCommandOutput) => void): void; + getDataset( args: GetDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDatasetCommandOutput) => void ): void; - public getDataset( - args: GetDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDatasetCommandOutput) => void), - cb?: (err: any, data?: GetDatasetCommandOutput) => void - ): Promise | void { - const command = new GetDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a Dataview.

+ * @see {@link GetDataViewCommand} */ - public getDataView(args: GetDataViewCommandInput, options?: __HttpHandlerOptions): Promise; - public getDataView(args: GetDataViewCommandInput, cb: (err: any, data?: GetDataViewCommandOutput) => void): void; - public getDataView( + getDataView(args: GetDataViewCommandInput, options?: __HttpHandlerOptions): Promise; + getDataView(args: GetDataViewCommandInput, cb: (err: any, data?: GetDataViewCommandOutput) => void): void; + getDataView( args: GetDataViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataViewCommandOutput) => void ): void; - public getDataView( - args: GetDataViewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDataViewCommandOutput) => void), - cb?: (err: any, data?: GetDataViewCommandOutput) => void - ): Promise | void { - const command = new GetDataViewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the credentials to access the external Dataview from an S3 location. To call this API:

- *
    - *
  • - *

    You must retrieve the programmatic credentials.

    - *
  • - *
  • - *

    You must be a member of a FinSpace user group, where the dataset that you want to access has Read Dataset Data permissions.

    - *
  • - *
+ * @see {@link GetExternalDataViewAccessDetailsCommand} */ - public getExternalDataViewAccessDetails( + getExternalDataViewAccessDetails( args: GetExternalDataViewAccessDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getExternalDataViewAccessDetails( + getExternalDataViewAccessDetails( args: GetExternalDataViewAccessDetailsCommandInput, cb: (err: any, data?: GetExternalDataViewAccessDetailsCommandOutput) => void ): void; - public getExternalDataViewAccessDetails( + getExternalDataViewAccessDetails( args: GetExternalDataViewAccessDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExternalDataViewAccessDetailsCommandOutput) => void ): void; - public getExternalDataViewAccessDetails( - args: GetExternalDataViewAccessDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetExternalDataViewAccessDetailsCommandOutput) => void), - cb?: (err: any, data?: GetExternalDataViewAccessDetailsCommandOutput) => void - ): Promise | void { - const command = new GetExternalDataViewAccessDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the details of a specific permission group.

+ * @see {@link GetPermissionGroupCommand} */ - public getPermissionGroup( + getPermissionGroup( args: GetPermissionGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPermissionGroup( + getPermissionGroup( args: GetPermissionGroupCommandInput, cb: (err: any, data?: GetPermissionGroupCommandOutput) => void ): void; - public getPermissionGroup( + getPermissionGroup( args: GetPermissionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPermissionGroupCommandOutput) => void ): void; - public getPermissionGroup( - args: GetPermissionGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPermissionGroupCommandOutput) => void), - cb?: (err: any, data?: GetPermissionGroupCommandOutput) => void - ): Promise | void { - const command = new GetPermissionGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Request programmatic credentials to use with FinSpace SDK.

+ * @see {@link GetProgrammaticAccessCredentialsCommand} */ - public getProgrammaticAccessCredentials( + getProgrammaticAccessCredentials( args: GetProgrammaticAccessCredentialsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getProgrammaticAccessCredentials( + getProgrammaticAccessCredentials( args: GetProgrammaticAccessCredentialsCommandInput, cb: (err: any, data?: GetProgrammaticAccessCredentialsCommandOutput) => void ): void; - public getProgrammaticAccessCredentials( + getProgrammaticAccessCredentials( args: GetProgrammaticAccessCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProgrammaticAccessCredentialsCommandOutput) => void ): void; - public getProgrammaticAccessCredentials( - args: GetProgrammaticAccessCredentialsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetProgrammaticAccessCredentialsCommandOutput) => void), - cb?: (err: any, data?: GetProgrammaticAccessCredentialsCommandOutput) => void - ): Promise | void { - const command = new GetProgrammaticAccessCredentialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves details for a specific user.

+ * @see {@link GetUserCommand} */ - public getUser(args: GetUserCommandInput, options?: __HttpHandlerOptions): Promise; - public getUser(args: GetUserCommandInput, cb: (err: any, data?: GetUserCommandOutput) => void): void; - public getUser( + getUser(args: GetUserCommandInput, options?: __HttpHandlerOptions): Promise; + getUser(args: GetUserCommandInput, cb: (err: any, data?: GetUserCommandOutput) => void): void; + getUser( args: GetUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserCommandOutput) => void ): void; - public getUser( - args: GetUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUserCommandOutput) => void), - cb?: (err: any, data?: GetUserCommandOutput) => void - ): Promise | void { - const command = new GetUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A temporary Amazon S3 location, where you can copy your files from a source location to stage or use - * as a scratch space in FinSpace notebook.

+ * @see {@link GetWorkingLocationCommand} */ - public getWorkingLocation( + getWorkingLocation( args: GetWorkingLocationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWorkingLocation( + getWorkingLocation( args: GetWorkingLocationCommandInput, cb: (err: any, data?: GetWorkingLocationCommandOutput) => void ): void; - public getWorkingLocation( + getWorkingLocation( args: GetWorkingLocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkingLocationCommandOutput) => void ): void; - public getWorkingLocation( - args: GetWorkingLocationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkingLocationCommandOutput) => void), - cb?: (err: any, data?: GetWorkingLocationCommandOutput) => void - ): Promise | void { - const command = new GetWorkingLocationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the FinSpace Changesets for a Dataset.

+ * @see {@link ListChangesetsCommand} */ - public listChangesets( + listChangesets( args: ListChangesetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listChangesets( - args: ListChangesetsCommandInput, - cb: (err: any, data?: ListChangesetsCommandOutput) => void - ): void; - public listChangesets( + listChangesets(args: ListChangesetsCommandInput, cb: (err: any, data?: ListChangesetsCommandOutput) => void): void; + listChangesets( args: ListChangesetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChangesetsCommandOutput) => void ): void; - public listChangesets( - args: ListChangesetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListChangesetsCommandOutput) => void), - cb?: (err: any, data?: ListChangesetsCommandOutput) => void - ): Promise | void { - const command = new ListChangesetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all of the active Datasets that a user has access to.

+ * @see {@link ListDatasetsCommand} */ - public listDatasets( - args: ListDatasetsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void; - public listDatasets( + listDatasets(args: ListDatasetsCommandInput, options?: __HttpHandlerOptions): Promise; + listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void; + listDatasets( args: ListDatasetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetsCommandOutput) => void ): void; - public listDatasets( - args: ListDatasetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatasetsCommandOutput) => void), - cb?: (err: any, data?: ListDatasetsCommandOutput) => void - ): Promise | void { - const command = new ListDatasetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all available Dataviews for a Dataset.

+ * @see {@link ListDataViewsCommand} */ - public listDataViews( - args: ListDataViewsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listDataViews( - args: ListDataViewsCommandInput, - cb: (err: any, data?: ListDataViewsCommandOutput) => void - ): void; - public listDataViews( + listDataViews(args: ListDataViewsCommandInput, options?: __HttpHandlerOptions): Promise; + listDataViews(args: ListDataViewsCommandInput, cb: (err: any, data?: ListDataViewsCommandOutput) => void): void; + listDataViews( args: ListDataViewsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataViewsCommandOutput) => void ): void; - public listDataViews( - args: ListDataViewsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDataViewsCommandOutput) => void), - cb?: (err: any, data?: ListDataViewsCommandOutput) => void - ): Promise | void { - const command = new ListDataViewsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all available permission groups in FinSpace.

+ * @see {@link ListPermissionGroupsCommand} */ - public listPermissionGroups( + listPermissionGroups( args: ListPermissionGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPermissionGroups( + listPermissionGroups( args: ListPermissionGroupsCommandInput, cb: (err: any, data?: ListPermissionGroupsCommandOutput) => void ): void; - public listPermissionGroups( + listPermissionGroups( args: ListPermissionGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPermissionGroupsCommandOutput) => void ): void; - public listPermissionGroups( - args: ListPermissionGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPermissionGroupsCommandOutput) => void), - cb?: (err: any, data?: ListPermissionGroupsCommandOutput) => void - ): Promise | void { - const command = new ListPermissionGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the permission groups that are associated with a specific user account.

+ * @see {@link ListPermissionGroupsByUserCommand} */ - public listPermissionGroupsByUser( + listPermissionGroupsByUser( args: ListPermissionGroupsByUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPermissionGroupsByUser( + listPermissionGroupsByUser( args: ListPermissionGroupsByUserCommandInput, cb: (err: any, data?: ListPermissionGroupsByUserCommandOutput) => void ): void; - public listPermissionGroupsByUser( + listPermissionGroupsByUser( args: ListPermissionGroupsByUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPermissionGroupsByUserCommandOutput) => void ): void; - public listPermissionGroupsByUser( - args: ListPermissionGroupsByUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPermissionGroupsByUserCommandOutput) => void), - cb?: (err: any, data?: ListPermissionGroupsByUserCommandOutput) => void - ): Promise | void { - const command = new ListPermissionGroupsByUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all available user accounts in FinSpace.

+ * @see {@link ListUsersCommand} */ - public listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise; - public listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void; - public listUsers( + listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise; + listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void; + listUsers( args: ListUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersCommandOutput) => void ): void; - public listUsers( - args: ListUsersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUsersCommandOutput) => void), - cb?: (err: any, data?: ListUsersCommandOutput) => void - ): Promise | void { - const command = new ListUsersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists details of all the users in a specific permission group.

+ * @see {@link ListUsersByPermissionGroupCommand} */ - public listUsersByPermissionGroup( + listUsersByPermissionGroup( args: ListUsersByPermissionGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public listUsersByPermissionGroup( + listUsersByPermissionGroup( args: ListUsersByPermissionGroupCommandInput, cb: (err: any, data?: ListUsersByPermissionGroupCommandOutput) => void ): void; - public listUsersByPermissionGroup( + listUsersByPermissionGroup( args: ListUsersByPermissionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersByPermissionGroupCommandOutput) => void ): void; - public listUsersByPermissionGroup( - args: ListUsersByPermissionGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUsersByPermissionGroupCommandOutput) => void), - cb?: (err: any, data?: ListUsersByPermissionGroupCommandOutput) => void - ): Promise | void { - const command = new ListUsersByPermissionGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.

+ * @see {@link ResetUserPasswordCommand} */ - public resetUserPassword( + resetUserPassword( args: ResetUserPasswordCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetUserPassword( + resetUserPassword( args: ResetUserPasswordCommandInput, cb: (err: any, data?: ResetUserPasswordCommandOutput) => void ): void; - public resetUserPassword( + resetUserPassword( args: ResetUserPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetUserPasswordCommandOutput) => void ): void; - public resetUserPassword( - args: ResetUserPasswordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetUserPasswordCommandOutput) => void), - cb?: (err: any, data?: ResetUserPasswordCommandOutput) => void - ): Promise | void { - const command = new ResetUserPasswordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a FinSpace Changeset.

+ * @see {@link UpdateChangesetCommand} */ - public updateChangeset( + updateChangeset( args: UpdateChangesetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateChangeset( - args: UpdateChangesetCommandInput, - cb: (err: any, data?: UpdateChangesetCommandOutput) => void - ): void; - public updateChangeset( + updateChangeset(args: UpdateChangesetCommandInput, cb: (err: any, data?: UpdateChangesetCommandOutput) => void): void; + updateChangeset( args: UpdateChangesetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChangesetCommandOutput) => void ): void; - public updateChangeset( - args: UpdateChangesetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateChangesetCommandOutput) => void), - cb?: (err: any, data?: UpdateChangesetCommandOutput) => void - ): Promise | void { - const command = new UpdateChangesetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a FinSpace Dataset.

+ * @see {@link UpdateDatasetCommand} */ - public updateDataset( - args: UpdateDatasetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateDataset( - args: UpdateDatasetCommandInput, - cb: (err: any, data?: UpdateDatasetCommandOutput) => void - ): void; - public updateDataset( + updateDataset(args: UpdateDatasetCommandInput, options?: __HttpHandlerOptions): Promise; + updateDataset(args: UpdateDatasetCommandInput, cb: (err: any, data?: UpdateDatasetCommandOutput) => void): void; + updateDataset( args: UpdateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDatasetCommandOutput) => void ): void; - public updateDataset( - args: UpdateDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDatasetCommandOutput) => void), - cb?: (err: any, data?: UpdateDatasetCommandOutput) => void - ): Promise | void { - const command = new UpdateDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the details of a permission group. You cannot modify a permissionGroupID.

+ * @see {@link UpdatePermissionGroupCommand} */ - public updatePermissionGroup( + updatePermissionGroup( args: UpdatePermissionGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePermissionGroup( + updatePermissionGroup( args: UpdatePermissionGroupCommandInput, cb: (err: any, data?: UpdatePermissionGroupCommandOutput) => void ): void; - public updatePermissionGroup( + updatePermissionGroup( args: UpdatePermissionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePermissionGroupCommandOutput) => void ): void; - public updatePermissionGroup( - args: UpdatePermissionGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePermissionGroupCommandOutput) => void), - cb?: (err: any, data?: UpdatePermissionGroupCommandOutput) => void - ): Promise | void { - const command = new UpdatePermissionGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the details of the specified user account. You cannot update the userId for a user.

+ * @see {@link UpdateUserCommand} */ - public updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise; - public updateUser(args: UpdateUserCommandInput, cb: (err: any, data?: UpdateUserCommandOutput) => void): void; - public updateUser( + updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise; + updateUser(args: UpdateUserCommandInput, cb: (err: any, data?: UpdateUserCommandOutput) => void): void; + updateUser( args: UpdateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserCommandOutput) => void ): void; - public updateUser( - args: UpdateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserCommandOutput) => void), - cb?: (err: any, data?: UpdateUserCommandOutput) => void - ): Promise | void { - const command = new UpdateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The FinSpace APIs let you take actions inside the FinSpace.

+ */ +export class FinspaceData extends FinspaceDataClient implements FinspaceData {} +createAggregatedClient(commands, FinspaceData); diff --git a/clients/client-finspace/src/Finspace.ts b/clients/client-finspace/src/Finspace.ts index 30b0479c64fd..9279fdf0653b 100644 --- a/clients/client-finspace/src/Finspace.ts +++ b/clients/client-finspace/src/Finspace.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -37,268 +38,145 @@ import { UpdateEnvironmentCommandInput, UpdateEnvironmentCommandOutput, } from "./commands/UpdateEnvironmentCommand"; -import { FinspaceClient } from "./FinspaceClient"; +import { FinspaceClient, FinspaceClientConfig } from "./FinspaceClient"; -/** - * @public - *

The FinSpace management service provides the APIs for managing FinSpace environments.

- */ -export class Finspace extends FinspaceClient { +const commands = { + CreateEnvironmentCommand, + DeleteEnvironmentCommand, + GetEnvironmentCommand, + ListEnvironmentsCommand, + ListTagsForResourceCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateEnvironmentCommand, +}; + +export interface Finspace { /** - * @public - *

Create a new FinSpace environment.

+ * @see {@link CreateEnvironmentCommand} */ - public createEnvironment( + createEnvironment( args: CreateEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEnvironment( + createEnvironment( args: CreateEnvironmentCommandInput, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void ): void; - public createEnvironment( + createEnvironment( args: CreateEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void ): void; - public createEnvironment( - args: CreateEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEnvironmentCommandOutput) => void), - cb?: (err: any, data?: CreateEnvironmentCommandOutput) => void - ): Promise | void { - const command = new CreateEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete an FinSpace environment.

+ * @see {@link DeleteEnvironmentCommand} */ - public deleteEnvironment( + deleteEnvironment( args: DeleteEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEnvironment( + deleteEnvironment( args: DeleteEnvironmentCommandInput, cb: (err: any, data?: DeleteEnvironmentCommandOutput) => void ): void; - public deleteEnvironment( + deleteEnvironment( args: DeleteEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEnvironmentCommandOutput) => void ): void; - public deleteEnvironment( - args: DeleteEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEnvironmentCommandOutput) => void), - cb?: (err: any, data?: DeleteEnvironmentCommandOutput) => void - ): Promise | void { - const command = new DeleteEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the FinSpace environment object.

+ * @see {@link GetEnvironmentCommand} */ - public getEnvironment( + getEnvironment( args: GetEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEnvironment( - args: GetEnvironmentCommandInput, - cb: (err: any, data?: GetEnvironmentCommandOutput) => void - ): void; - public getEnvironment( + getEnvironment(args: GetEnvironmentCommandInput, cb: (err: any, data?: GetEnvironmentCommandOutput) => void): void; + getEnvironment( args: GetEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEnvironmentCommandOutput) => void ): void; - public getEnvironment( - args: GetEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEnvironmentCommandOutput) => void), - cb?: (err: any, data?: GetEnvironmentCommandOutput) => void - ): Promise | void { - const command = new GetEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A list of all of your FinSpace environments.

+ * @see {@link ListEnvironmentsCommand} */ - public listEnvironments( + listEnvironments( args: ListEnvironmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEnvironments( + listEnvironments( args: ListEnvironmentsCommandInput, cb: (err: any, data?: ListEnvironmentsCommandOutput) => void ): void; - public listEnvironments( + listEnvironments( args: ListEnvironmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnvironmentsCommandOutput) => void ): void; - public listEnvironments( - args: ListEnvironmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEnvironmentsCommandOutput) => void), - cb?: (err: any, data?: ListEnvironmentsCommandOutput) => void - ): Promise | void { - const command = new ListEnvironmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A list of all tags for a resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds metadata tags to a FinSpace resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes metadata tags from a FinSpace resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update your FinSpace environment.

+ * @see {@link UpdateEnvironmentCommand} */ - public updateEnvironment( + updateEnvironment( args: UpdateEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEnvironment( + updateEnvironment( args: UpdateEnvironmentCommandInput, cb: (err: any, data?: UpdateEnvironmentCommandOutput) => void ): void; - public updateEnvironment( + updateEnvironment( args: UpdateEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEnvironmentCommandOutput) => void ): void; - public updateEnvironment( - args: UpdateEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEnvironmentCommandOutput) => void), - cb?: (err: any, data?: UpdateEnvironmentCommandOutput) => void - ): Promise | void { - const command = new UpdateEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The FinSpace management service provides the APIs for managing FinSpace environments.

+ */ +export class Finspace extends FinspaceClient implements Finspace {} +createAggregatedClient(commands, Finspace); diff --git a/clients/client-firehose/src/Firehose.ts b/clients/client-firehose/src/Firehose.ts index 02db86f696d0..b7f04798d8b0 100644 --- a/clients/client-firehose/src/Firehose.ts +++ b/clients/client-firehose/src/Firehose.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -57,666 +58,227 @@ import { UpdateDestinationCommandInput, UpdateDestinationCommandOutput, } from "./commands/UpdateDestinationCommand"; -import { FirehoseClient } from "./FirehoseClient"; +import { FirehoseClient, FirehoseClientConfig } from "./FirehoseClient"; -/** - * @public - * Amazon Kinesis Data Firehose API Reference - *

Amazon Kinesis Data Firehose is a fully managed service that delivers real-time - * streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon - * OpenSearch Service, Amazon Redshift, Splunk, and various other supportd - * destinations.

- */ -export class Firehose extends FirehoseClient { +const commands = { + CreateDeliveryStreamCommand, + DeleteDeliveryStreamCommand, + DescribeDeliveryStreamCommand, + ListDeliveryStreamsCommand, + ListTagsForDeliveryStreamCommand, + PutRecordCommand, + PutRecordBatchCommand, + StartDeliveryStreamEncryptionCommand, + StopDeliveryStreamEncryptionCommand, + TagDeliveryStreamCommand, + UntagDeliveryStreamCommand, + UpdateDestinationCommand, +}; + +export interface Firehose { /** - * @public - *

Creates a Kinesis Data Firehose delivery stream.

- * - *

By default, you can create up to 50 delivery streams per Amazon Web Services - * Region.

- *

This is an asynchronous operation that immediately returns. The initial status of the - * delivery stream is CREATING. After the delivery stream is created, its status - * is ACTIVE and it now accepts data. If the delivery stream creation fails, the - * status transitions to CREATING_FAILED. Attempts to send data to a delivery - * stream that is not in the ACTIVE state cause an exception. To check the state - * of a delivery stream, use DescribeDeliveryStream.

- *

If the status of a delivery stream is CREATING_FAILED, this status - * doesn't change, and you can't invoke CreateDeliveryStream again on it. - * However, you can invoke the DeleteDeliveryStream operation to delete - * it.

- *

A Kinesis Data Firehose delivery stream can be configured to receive records directly - * from providers using PutRecord or PutRecordBatch, or it - * can be configured to use an existing Kinesis stream as its source. To specify a Kinesis - * data stream as input, set the DeliveryStreamType parameter to - * KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name - * (ARN) and role ARN in the KinesisStreamSourceConfiguration - * parameter.

- *

To create a delivery stream with server-side encryption (SSE) enabled, include DeliveryStreamEncryptionConfigurationInput in your request. This is - * optional. You can also invoke StartDeliveryStreamEncryption to turn on - * SSE for an existing delivery stream that doesn't have SSE enabled.

- *

A delivery stream is configured with a single destination: Amazon S3, Amazon ES, - * Amazon Redshift, or Splunk. You must specify only one of the following destination - * configuration parameters: ExtendedS3DestinationConfiguration, - * S3DestinationConfiguration, - * ElasticsearchDestinationConfiguration, - * RedshiftDestinationConfiguration, or - * SplunkDestinationConfiguration.

- *

When you specify S3DestinationConfiguration, you can also provide the - * following optional values: BufferingHints, EncryptionConfiguration, and - * CompressionFormat. By default, if no BufferingHints value is - * provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever - * condition is satisfied first. BufferingHints is a hint, so there are some - * cases where the service cannot adhere to these conditions strictly. For example, record - * boundaries might be such that the size is a little over or under the configured buffering - * size. By default, no encryption is performed. We strongly recommend that you enable - * encryption to ensure secure data storage in Amazon S3.

- * - *

A few notes about Amazon Redshift as a destination:

- *
    - *
  • - *

    An Amazon Redshift destination requires an S3 bucket as intermediate location. - * Kinesis Data Firehose first delivers data to Amazon S3 and then uses - * COPY syntax to load data into an Amazon Redshift table. This is - * specified in the RedshiftDestinationConfiguration.S3Configuration - * parameter.

    - * - *
  • - *
  • - *

    The compression formats SNAPPY or ZIP cannot be - * specified in RedshiftDestinationConfiguration.S3Configuration because - * the Amazon Redshift COPY operation that reads from the S3 bucket doesn't - * support these compression formats.

    - *
  • - *
  • - *

    We strongly recommend that you use the user name and password you provide - * exclusively with Kinesis Data Firehose, and that the permissions for the account are - * restricted for Amazon Redshift INSERT permissions.

    - * - *
  • - *
- *

Kinesis Data Firehose assumes the IAM role that is configured as part of the - * destination. The role should allow the Kinesis Data Firehose principal to assume the role, - * and the role should have permissions that allow the service to deliver the data. For more - * information, see Grant Kinesis Data - * Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data - * Firehose Developer Guide.

+ * @see {@link CreateDeliveryStreamCommand} */ - public createDeliveryStream( + createDeliveryStream( args: CreateDeliveryStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDeliveryStream( + createDeliveryStream( args: CreateDeliveryStreamCommandInput, cb: (err: any, data?: CreateDeliveryStreamCommandOutput) => void ): void; - public createDeliveryStream( + createDeliveryStream( args: CreateDeliveryStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeliveryStreamCommandOutput) => void ): void; - public createDeliveryStream( - args: CreateDeliveryStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDeliveryStreamCommandOutput) => void), - cb?: (err: any, data?: CreateDeliveryStreamCommandOutput) => void - ): Promise | void { - const command = new CreateDeliveryStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a delivery stream and its data.

- *

To check the state of a delivery stream, use DescribeDeliveryStream. You can delete a delivery stream only if it is in one of the following states: - * ACTIVE, DELETING, CREATING_FAILED, or - * DELETING_FAILED. You can't delete a delivery stream that is in the - * CREATING state. While the deletion request is in process, the delivery - * stream is in the DELETING state.

- *

While the delivery stream is in the DELETING state, the service might - * continue to accept records, but it doesn't make any guarantees with respect to delivering - * the data. Therefore, as a best practice, first stop any applications that are sending - * records before you delete a delivery stream.

+ * @see {@link DeleteDeliveryStreamCommand} */ - public deleteDeliveryStream( + deleteDeliveryStream( args: DeleteDeliveryStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDeliveryStream( + deleteDeliveryStream( args: DeleteDeliveryStreamCommandInput, cb: (err: any, data?: DeleteDeliveryStreamCommandOutput) => void ): void; - public deleteDeliveryStream( + deleteDeliveryStream( args: DeleteDeliveryStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDeliveryStreamCommandOutput) => void ): void; - public deleteDeliveryStream( - args: DeleteDeliveryStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDeliveryStreamCommandOutput) => void), - cb?: (err: any, data?: DeleteDeliveryStreamCommandOutput) => void - ): Promise | void { - const command = new DeleteDeliveryStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified delivery stream and its status. For example, after your - * delivery stream is created, call DescribeDeliveryStream to see whether the - * delivery stream is ACTIVE and therefore ready for data to be sent to it.

- *

If the status of a delivery stream is CREATING_FAILED, this status - * doesn't change, and you can't invoke CreateDeliveryStream again on it. - * However, you can invoke the DeleteDeliveryStream operation to delete it. - * If the status is DELETING_FAILED, you can force deletion by invoking DeleteDeliveryStream again but with DeleteDeliveryStreamInput$AllowForceDelete set to true.

+ * @see {@link DescribeDeliveryStreamCommand} */ - public describeDeliveryStream( + describeDeliveryStream( args: DescribeDeliveryStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDeliveryStream( + describeDeliveryStream( args: DescribeDeliveryStreamCommandInput, cb: (err: any, data?: DescribeDeliveryStreamCommandOutput) => void ): void; - public describeDeliveryStream( + describeDeliveryStream( args: DescribeDeliveryStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDeliveryStreamCommandOutput) => void ): void; - public describeDeliveryStream( - args: DescribeDeliveryStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDeliveryStreamCommandOutput) => void), - cb?: (err: any, data?: DescribeDeliveryStreamCommandOutput) => void - ): Promise | void { - const command = new DescribeDeliveryStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists your delivery streams in alphabetical order of their names.

- *

The number of delivery streams might be too large to return using a single call to - * ListDeliveryStreams. You can limit the number of delivery streams returned, - * using the Limit parameter. To determine whether there are more delivery - * streams to list, check the value of HasMoreDeliveryStreams in the output. If - * there are more delivery streams to list, you can request them by calling this operation - * again and setting the ExclusiveStartDeliveryStreamName parameter to the name - * of the last delivery stream returned in the last call.

+ * @see {@link ListDeliveryStreamsCommand} */ - public listDeliveryStreams( + listDeliveryStreams( args: ListDeliveryStreamsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeliveryStreams( + listDeliveryStreams( args: ListDeliveryStreamsCommandInput, cb: (err: any, data?: ListDeliveryStreamsCommandOutput) => void ): void; - public listDeliveryStreams( + listDeliveryStreams( args: ListDeliveryStreamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeliveryStreamsCommandOutput) => void ): void; - public listDeliveryStreams( - args: ListDeliveryStreamsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeliveryStreamsCommandOutput) => void), - cb?: (err: any, data?: ListDeliveryStreamsCommandOutput) => void - ): Promise | void { - const command = new ListDeliveryStreamsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags for the specified delivery stream. This operation has a limit of five - * transactions per second per account.

+ * @see {@link ListTagsForDeliveryStreamCommand} */ - public listTagsForDeliveryStream( + listTagsForDeliveryStream( args: ListTagsForDeliveryStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForDeliveryStream( + listTagsForDeliveryStream( args: ListTagsForDeliveryStreamCommandInput, cb: (err: any, data?: ListTagsForDeliveryStreamCommandOutput) => void ): void; - public listTagsForDeliveryStream( + listTagsForDeliveryStream( args: ListTagsForDeliveryStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForDeliveryStreamCommandOutput) => void ): void; - public listTagsForDeliveryStream( - args: ListTagsForDeliveryStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForDeliveryStreamCommandOutput) => void), - cb?: (err: any, data?: ListTagsForDeliveryStreamCommandOutput) => void - ): Promise | void { - const command = new ListTagsForDeliveryStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Writes a single data record into an Amazon Kinesis Data Firehose delivery stream. To - * write multiple data records into a delivery stream, use PutRecordBatch. - * Applications using these operations are referred to as producers.

- *

By default, each delivery stream can take in up to 2,000 transactions per second, - * 5,000 records per second, or 5 MB per second. If you use PutRecord and - * PutRecordBatch, the limits are an aggregate across these two - * operations for each delivery stream. For more information about limits and how to request - * an increase, see Amazon - * Kinesis Data Firehose Limits.

- *

You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 - * KiB in size, and any kind of data. For example, it can be a segment from a log file, - * geographic location data, website clickstream data, and so on.

- *

Kinesis Data Firehose buffers records before delivering them to the destination. To - * disambiguate the data blobs at the destination, a common solution is to use delimiters in - * the data, such as a newline (\n) or some other character unique within the - * data. This allows the consumer application to parse individual data items when reading the - * data from the destination.

- *

The PutRecord operation returns a RecordId, which is a - * unique string assigned to each record. Producer applications can use this ID for purposes - * such as auditability and investigation.

- *

If the PutRecord operation throws a - * ServiceUnavailableException, back off and retry. If the exception persists, - * it is possible that the throughput limits have been exceeded for the delivery stream.

- *

Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they - * are added to a delivery stream as it tries to send the records to the destination. If the - * destination is unreachable for more than 24 hours, the data is no longer - * available.

- * - * - *

Don't concatenate two or more base64 strings to form the data fields of your records. - * Instead, concatenate the raw data, then perform base64 encoding.

- *
+ * @see {@link PutRecordCommand} */ - public putRecord(args: PutRecordCommandInput, options?: __HttpHandlerOptions): Promise; - public putRecord(args: PutRecordCommandInput, cb: (err: any, data?: PutRecordCommandOutput) => void): void; - public putRecord( + putRecord(args: PutRecordCommandInput, options?: __HttpHandlerOptions): Promise; + putRecord(args: PutRecordCommandInput, cb: (err: any, data?: PutRecordCommandOutput) => void): void; + putRecord( args: PutRecordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRecordCommandOutput) => void ): void; - public putRecord( - args: PutRecordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRecordCommandOutput) => void), - cb?: (err: any, data?: PutRecordCommandOutput) => void - ): Promise | void { - const command = new PutRecordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Writes multiple data records into a delivery stream in a single call, which can - * achieve higher throughput per producer than when writing single records. To write single - * data records into a delivery stream, use PutRecord. Applications using - * these operations are referred to as producers.

- *

For information about service quota, see Amazon Kinesis Data Firehose - * Quota.

- *

Each PutRecordBatch request supports up to 500 records. Each record - * in the request can be as large as 1,000 KB (before base64 encoding), up to a limit of 4 MB - * for the entire request. These limits cannot be changed.

- *

You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 - * KB in size, and any kind of data. For example, it could be a segment from a log file, - * geographic location data, website clickstream data, and so on.

- *

Kinesis Data Firehose buffers records before delivering them to the destination. To - * disambiguate the data blobs at the destination, a common solution is to use delimiters in - * the data, such as a newline (\n) or some other character unique within the - * data. This allows the consumer application to parse individual data items when reading the - * data from the destination.

- *

The PutRecordBatch response includes a count of failed records, - * FailedPutCount, and an array of responses, RequestResponses. - * Even if the PutRecordBatch call succeeds, the value of - * FailedPutCount may be greater than 0, indicating that there are records for - * which the operation didn't succeed. Each entry in the RequestResponses array - * provides additional information about the processed record. It directly correlates with a - * record in the request array using the same ordering, from the top to the bottom. The - * response array always includes the same number of records as the request array. - * RequestResponses includes both successfully and unsuccessfully processed - * records. Kinesis Data Firehose tries to process all records in each PutRecordBatch request. A single record failure does not stop the processing - * of subsequent records.

- *

A successfully processed record includes a RecordId value, which is - * unique for the record. An unsuccessfully processed record includes ErrorCode - * and ErrorMessage values. ErrorCode reflects the type of error, - * and is one of the following values: ServiceUnavailableException or - * InternalFailure. ErrorMessage provides more detailed - * information about the error.

- *

If there is an internal server error or a timeout, the write might have completed or - * it might have failed. If FailedPutCount is greater than 0, retry the request, - * resending only those records that might have failed processing. This minimizes the possible - * duplicate records and also reduces the total bytes sent (and corresponding charges). We - * recommend that you handle any duplicates at the destination.

- *

If PutRecordBatch throws ServiceUnavailableException, - * back off and retry. If the exception persists, it is possible that the throughput limits - * have been exceeded for the delivery stream.

- * - *

Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they - * are added to a delivery stream as it attempts to send the records to the destination. If - * the destination is unreachable for more than 24 hours, the data is no longer - * available.

- * - *

Don't concatenate two or more base64 strings to form the data fields of your records. - * Instead, concatenate the raw data, then perform base64 encoding.

- *
+ * @see {@link PutRecordBatchCommand} */ - public putRecordBatch( + putRecordBatch( args: PutRecordBatchCommandInput, options?: __HttpHandlerOptions ): Promise; - public putRecordBatch( - args: PutRecordBatchCommandInput, - cb: (err: any, data?: PutRecordBatchCommandOutput) => void - ): void; - public putRecordBatch( + putRecordBatch(args: PutRecordBatchCommandInput, cb: (err: any, data?: PutRecordBatchCommandOutput) => void): void; + putRecordBatch( args: PutRecordBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRecordBatchCommandOutput) => void ): void; - public putRecordBatch( - args: PutRecordBatchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRecordBatchCommandOutput) => void), - cb?: (err: any, data?: PutRecordBatchCommandOutput) => void - ): Promise | void { - const command = new PutRecordBatchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables server-side encryption (SSE) for the delivery stream.

- *

This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data - * Firehose first sets the encryption status of the stream to ENABLING, and then - * to ENABLED. The encryption status of a delivery stream is the - * Status property in DeliveryStreamEncryptionConfiguration. - * If the operation fails, the encryption status changes to ENABLING_FAILED. You - * can continue to read and write data to your delivery stream while the encryption status is - * ENABLING, but the data is not encrypted. It can take up to 5 seconds after - * the encryption status changes to ENABLED before all records written to the - * delivery stream are encrypted. To find out whether a record or a batch of records was - * encrypted, check the response elements PutRecordOutput$Encrypted and - * PutRecordBatchOutput$Encrypted, respectively.

- *

To check the encryption status of a delivery stream, use DescribeDeliveryStream.

- *

Even if encryption is currently enabled for a delivery stream, you can still invoke this - * operation on it to change the ARN of the CMK or both its type and ARN. If you invoke this - * method to change the CMK, and the old CMK is of type CUSTOMER_MANAGED_CMK, - * Kinesis Data Firehose schedules the grant it had on the old CMK for retirement. If the new - * CMK is of type CUSTOMER_MANAGED_CMK, Kinesis Data Firehose creates a grant - * that enables it to use the new CMK to encrypt and decrypt data and to manage the - * grant.

- *

If a delivery stream already has encryption enabled and then you invoke this operation - * to change the ARN of the CMK or both its type and ARN and you get - * ENABLING_FAILED, this only means that the attempt to change the CMK failed. - * In this case, encryption remains enabled with the old CMK.

- *

If the encryption status of your delivery stream is ENABLING_FAILED, you - * can invoke this operation again with a valid CMK. The CMK must be enabled and the key - * policy mustn't explicitly deny the permission for Kinesis Data Firehose to invoke KMS - * encrypt and decrypt operations.

- *

You can enable SSE for a delivery stream only if it's a delivery stream that uses - * DirectPut as its source.

- *

The StartDeliveryStreamEncryption and - * StopDeliveryStreamEncryption operations have a combined limit of 25 calls - * per delivery stream per 24 hours. For example, you reach the limit if you call - * StartDeliveryStreamEncryption 13 times and - * StopDeliveryStreamEncryption 12 times for the same delivery stream in a - * 24-hour period.

+ * @see {@link StartDeliveryStreamEncryptionCommand} */ - public startDeliveryStreamEncryption( + startDeliveryStreamEncryption( args: StartDeliveryStreamEncryptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDeliveryStreamEncryption( + startDeliveryStreamEncryption( args: StartDeliveryStreamEncryptionCommandInput, cb: (err: any, data?: StartDeliveryStreamEncryptionCommandOutput) => void ): void; - public startDeliveryStreamEncryption( + startDeliveryStreamEncryption( args: StartDeliveryStreamEncryptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDeliveryStreamEncryptionCommandOutput) => void ): void; - public startDeliveryStreamEncryption( - args: StartDeliveryStreamEncryptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDeliveryStreamEncryptionCommandOutput) => void), - cb?: (err: any, data?: StartDeliveryStreamEncryptionCommandOutput) => void - ): Promise | void { - const command = new StartDeliveryStreamEncryptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables server-side encryption (SSE) for the delivery stream.

- *

This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data - * Firehose first sets the encryption status of the stream to DISABLING, and then - * to DISABLED. You can continue to read and write data to your stream while its - * status is DISABLING. It can take up to 5 seconds after the encryption status - * changes to DISABLED before all records written to the delivery stream are no - * longer subject to encryption. To find out whether a record or a batch of records was - * encrypted, check the response elements PutRecordOutput$Encrypted and - * PutRecordBatchOutput$Encrypted, respectively.

- *

To check the encryption state of a delivery stream, use DescribeDeliveryStream.

- *

If SSE is enabled using a customer managed CMK and then you invoke - * StopDeliveryStreamEncryption, Kinesis Data Firehose schedules the related - * KMS grant for retirement and then retires it after it ensures that it is finished - * delivering records to the destination.

- *

The StartDeliveryStreamEncryption and - * StopDeliveryStreamEncryption operations have a combined limit of 25 calls - * per delivery stream per 24 hours. For example, you reach the limit if you call - * StartDeliveryStreamEncryption 13 times and - * StopDeliveryStreamEncryption 12 times for the same delivery stream in a - * 24-hour period.

+ * @see {@link StopDeliveryStreamEncryptionCommand} */ - public stopDeliveryStreamEncryption( + stopDeliveryStreamEncryption( args: StopDeliveryStreamEncryptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopDeliveryStreamEncryption( + stopDeliveryStreamEncryption( args: StopDeliveryStreamEncryptionCommandInput, cb: (err: any, data?: StopDeliveryStreamEncryptionCommandOutput) => void ): void; - public stopDeliveryStreamEncryption( + stopDeliveryStreamEncryption( args: StopDeliveryStreamEncryptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDeliveryStreamEncryptionCommandOutput) => void ): void; - public stopDeliveryStreamEncryption( - args: StopDeliveryStreamEncryptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopDeliveryStreamEncryptionCommandOutput) => void), - cb?: (err: any, data?: StopDeliveryStreamEncryptionCommandOutput) => void - ): Promise | void { - const command = new StopDeliveryStreamEncryptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or updates tags for the specified delivery stream. A tag is a key-value pair - * that you can define and assign to Amazon Web Services resources. If you specify a tag that - * already exists, the tag value is replaced with the value that you specify in the request. - * Tags are metadata. For example, you can add friendly names and descriptions or other types - * of information that can help you distinguish the delivery stream. For more information - * about tags, see Using Cost Allocation - * Tags in the Amazon Web Services Billing and Cost Management User - * Guide.

- *

Each delivery stream can have up to 50 tags.

- *

This operation has a limit of five transactions per second per account.

+ * @see {@link TagDeliveryStreamCommand} */ - public tagDeliveryStream( + tagDeliveryStream( args: TagDeliveryStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public tagDeliveryStream( + tagDeliveryStream( args: TagDeliveryStreamCommandInput, cb: (err: any, data?: TagDeliveryStreamCommandOutput) => void ): void; - public tagDeliveryStream( + tagDeliveryStream( args: TagDeliveryStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagDeliveryStreamCommandOutput) => void ): void; - public tagDeliveryStream( - args: TagDeliveryStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagDeliveryStreamCommandOutput) => void), - cb?: (err: any, data?: TagDeliveryStreamCommandOutput) => void - ): Promise | void { - const command = new TagDeliveryStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from the specified delivery stream. Removed tags are deleted, and you - * can't recover them after this operation successfully completes.

- *

If you specify a tag that doesn't exist, the operation ignores it.

- *

This operation has a limit of five transactions per second per account.

+ * @see {@link UntagDeliveryStreamCommand} */ - public untagDeliveryStream( + untagDeliveryStream( args: UntagDeliveryStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public untagDeliveryStream( + untagDeliveryStream( args: UntagDeliveryStreamCommandInput, cb: (err: any, data?: UntagDeliveryStreamCommandOutput) => void ): void; - public untagDeliveryStream( + untagDeliveryStream( args: UntagDeliveryStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagDeliveryStreamCommandOutput) => void ): void; - public untagDeliveryStream( - args: UntagDeliveryStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagDeliveryStreamCommandOutput) => void), - cb?: (err: any, data?: UntagDeliveryStreamCommandOutput) => void - ): Promise | void { - const command = new UntagDeliveryStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified destination of the specified delivery stream.

- * - *

Use this operation to change the destination type (for example, to replace the Amazon - * S3 destination with Amazon Redshift) or change the parameters associated with a destination - * (for example, to change the bucket name of the Amazon S3 destination). The update might not - * occur immediately. The target delivery stream remains active while the configurations are - * updated, so data writes to the delivery stream can continue during this process. The - * updated configurations are usually effective within a few minutes.

- *

Switching between Amazon ES and other services is not supported. For an Amazon ES - * destination, you can only update to another Amazon ES destination.

- *

If the destination type is the same, Kinesis Data Firehose merges the configuration - * parameters specified with the destination configuration that already exists on the delivery - * stream. If any of the parameters are not specified in the call, the existing values are - * retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified, then the existing - * EncryptionConfiguration is maintained on the destination.

- *

If the destination type is not the same, for example, changing the destination from - * Amazon S3 to Amazon Redshift, Kinesis Data Firehose does not merge any parameters. In this - * case, all parameters must be specified.

- * - *

Kinesis Data Firehose uses CurrentDeliveryStreamVersionId to avoid race - * conditions and conflicting merges. This is a required field, and the service updates the - * configuration only if the existing configuration has a version ID that matches. After the - * update is applied successfully, the version ID is updated, and can be retrieved using DescribeDeliveryStream. Use the new version ID to set - * CurrentDeliveryStreamVersionId in the next call.

+ * @see {@link UpdateDestinationCommand} */ - public updateDestination( + updateDestination( args: UpdateDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDestination( + updateDestination( args: UpdateDestinationCommandInput, cb: (err: any, data?: UpdateDestinationCommandOutput) => void ): void; - public updateDestination( + updateDestination( args: UpdateDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDestinationCommandOutput) => void ): void; - public updateDestination( - args: UpdateDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDestinationCommandOutput) => void), - cb?: (err: any, data?: UpdateDestinationCommandOutput) => void - ): Promise | void { - const command = new UpdateDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Kinesis Data Firehose API Reference + *

Amazon Kinesis Data Firehose is a fully managed service that delivers real-time + * streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon + * OpenSearch Service, Amazon Redshift, Splunk, and various other supportd + * destinations.

+ */ +export class Firehose extends FirehoseClient implements Firehose {} +createAggregatedClient(commands, Firehose); diff --git a/clients/client-fis/src/Fis.ts b/clients/client-fis/src/Fis.ts index 9ce3ae973994..cb0474ccbbb1 100644 --- a/clients/client-fis/src/Fis.ts +++ b/clients/client-fis/src/Fis.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -69,543 +70,266 @@ import { UpdateExperimentTemplateCommandInput, UpdateExperimentTemplateCommandOutput, } from "./commands/UpdateExperimentTemplateCommand"; -import { FisClient } from "./FisClient"; +import { FisClient, FisClientConfig } from "./FisClient"; -/** - * @public - *

Fault Injection Simulator is a managed service that enables you to perform fault injection - * experiments on your Amazon Web Services workloads. For more information, see the Fault Injection Simulator User Guide.

- */ -export class Fis extends FisClient { +const commands = { + CreateExperimentTemplateCommand, + DeleteExperimentTemplateCommand, + GetActionCommand, + GetExperimentCommand, + GetExperimentTemplateCommand, + GetTargetResourceTypeCommand, + ListActionsCommand, + ListExperimentsCommand, + ListExperimentTemplatesCommand, + ListTagsForResourceCommand, + ListTargetResourceTypesCommand, + StartExperimentCommand, + StopExperimentCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateExperimentTemplateCommand, +}; + +export interface Fis { /** - * @public - *

Creates an experiment template.

- *

An experiment template includes the following components:

- *
    - *
  • - *

    - * Targets: A target can be a specific resource in - * your Amazon Web Services environment, or one or more resources that match criteria that you - * specify, for example, resources that have specific tags.

    - *
  • - *
  • - *

    - * Actions: The actions to carry out on the - * target. You can specify multiple actions, the duration of each action, and when to start each action during an experiment.

    - *
  • - *
  • - *

    - * Stop conditions: If a stop condition is - * triggered while an experiment is running, the experiment is automatically - * stopped. You can define a stop condition as a CloudWatch alarm.

    - *
  • - *
- *

For more information, see Experiment templates - * in the Fault Injection Simulator User Guide.

+ * @see {@link CreateExperimentTemplateCommand} */ - public createExperimentTemplate( + createExperimentTemplate( args: CreateExperimentTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createExperimentTemplate( + createExperimentTemplate( args: CreateExperimentTemplateCommandInput, cb: (err: any, data?: CreateExperimentTemplateCommandOutput) => void ): void; - public createExperimentTemplate( + createExperimentTemplate( args: CreateExperimentTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExperimentTemplateCommandOutput) => void ): void; - public createExperimentTemplate( - args: CreateExperimentTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateExperimentTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateExperimentTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateExperimentTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified experiment template.

+ * @see {@link DeleteExperimentTemplateCommand} */ - public deleteExperimentTemplate( + deleteExperimentTemplate( args: DeleteExperimentTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteExperimentTemplate( + deleteExperimentTemplate( args: DeleteExperimentTemplateCommandInput, cb: (err: any, data?: DeleteExperimentTemplateCommandOutput) => void ): void; - public deleteExperimentTemplate( + deleteExperimentTemplate( args: DeleteExperimentTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteExperimentTemplateCommandOutput) => void ): void; - public deleteExperimentTemplate( - args: DeleteExperimentTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteExperimentTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteExperimentTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteExperimentTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about the specified FIS action.

+ * @see {@link GetActionCommand} */ - public getAction(args: GetActionCommandInput, options?: __HttpHandlerOptions): Promise; - public getAction(args: GetActionCommandInput, cb: (err: any, data?: GetActionCommandOutput) => void): void; - public getAction( + getAction(args: GetActionCommandInput, options?: __HttpHandlerOptions): Promise; + getAction(args: GetActionCommandInput, cb: (err: any, data?: GetActionCommandOutput) => void): void; + getAction( args: GetActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetActionCommandOutput) => void ): void; - public getAction( - args: GetActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetActionCommandOutput) => void), - cb?: (err: any, data?: GetActionCommandOutput) => void - ): Promise | void { - const command = new GetActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about the specified experiment.

+ * @see {@link GetExperimentCommand} */ - public getExperiment( - args: GetExperimentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getExperiment( - args: GetExperimentCommandInput, - cb: (err: any, data?: GetExperimentCommandOutput) => void - ): void; - public getExperiment( + getExperiment(args: GetExperimentCommandInput, options?: __HttpHandlerOptions): Promise; + getExperiment(args: GetExperimentCommandInput, cb: (err: any, data?: GetExperimentCommandOutput) => void): void; + getExperiment( args: GetExperimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExperimentCommandOutput) => void ): void; - public getExperiment( - args: GetExperimentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetExperimentCommandOutput) => void), - cb?: (err: any, data?: GetExperimentCommandOutput) => void - ): Promise | void { - const command = new GetExperimentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about the specified experiment template.

+ * @see {@link GetExperimentTemplateCommand} */ - public getExperimentTemplate( + getExperimentTemplate( args: GetExperimentTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getExperimentTemplate( + getExperimentTemplate( args: GetExperimentTemplateCommandInput, cb: (err: any, data?: GetExperimentTemplateCommandOutput) => void ): void; - public getExperimentTemplate( + getExperimentTemplate( args: GetExperimentTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExperimentTemplateCommandOutput) => void ): void; - public getExperimentTemplate( - args: GetExperimentTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetExperimentTemplateCommandOutput) => void), - cb?: (err: any, data?: GetExperimentTemplateCommandOutput) => void - ): Promise | void { - const command = new GetExperimentTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about the specified resource type.

+ * @see {@link GetTargetResourceTypeCommand} */ - public getTargetResourceType( + getTargetResourceType( args: GetTargetResourceTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTargetResourceType( + getTargetResourceType( args: GetTargetResourceTypeCommandInput, cb: (err: any, data?: GetTargetResourceTypeCommandOutput) => void ): void; - public getTargetResourceType( + getTargetResourceType( args: GetTargetResourceTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTargetResourceTypeCommandOutput) => void ): void; - public getTargetResourceType( - args: GetTargetResourceTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTargetResourceTypeCommandOutput) => void), - cb?: (err: any, data?: GetTargetResourceTypeCommandOutput) => void - ): Promise | void { - const command = new GetTargetResourceTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the available FIS actions.

+ * @see {@link ListActionsCommand} */ - public listActions(args: ListActionsCommandInput, options?: __HttpHandlerOptions): Promise; - public listActions(args: ListActionsCommandInput, cb: (err: any, data?: ListActionsCommandOutput) => void): void; - public listActions( + listActions(args: ListActionsCommandInput, options?: __HttpHandlerOptions): Promise; + listActions(args: ListActionsCommandInput, cb: (err: any, data?: ListActionsCommandOutput) => void): void; + listActions( args: ListActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListActionsCommandOutput) => void ): void; - public listActions( - args: ListActionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListActionsCommandOutput) => void), - cb?: (err: any, data?: ListActionsCommandOutput) => void - ): Promise | void { - const command = new ListActionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists your experiments.

+ * @see {@link ListExperimentsCommand} */ - public listExperiments( + listExperiments( args: ListExperimentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listExperiments( - args: ListExperimentsCommandInput, - cb: (err: any, data?: ListExperimentsCommandOutput) => void - ): void; - public listExperiments( + listExperiments(args: ListExperimentsCommandInput, cb: (err: any, data?: ListExperimentsCommandOutput) => void): void; + listExperiments( args: ListExperimentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExperimentsCommandOutput) => void ): void; - public listExperiments( - args: ListExperimentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListExperimentsCommandOutput) => void), - cb?: (err: any, data?: ListExperimentsCommandOutput) => void - ): Promise | void { - const command = new ListExperimentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists your experiment templates.

+ * @see {@link ListExperimentTemplatesCommand} */ - public listExperimentTemplates( + listExperimentTemplates( args: ListExperimentTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listExperimentTemplates( + listExperimentTemplates( args: ListExperimentTemplatesCommandInput, cb: (err: any, data?: ListExperimentTemplatesCommandOutput) => void ): void; - public listExperimentTemplates( + listExperimentTemplates( args: ListExperimentTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExperimentTemplatesCommandOutput) => void ): void; - public listExperimentTemplates( - args: ListExperimentTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListExperimentTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListExperimentTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListExperimentTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags for the specified resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the target resource types.

+ * @see {@link ListTargetResourceTypesCommand} */ - public listTargetResourceTypes( + listTargetResourceTypes( args: ListTargetResourceTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTargetResourceTypes( + listTargetResourceTypes( args: ListTargetResourceTypesCommandInput, cb: (err: any, data?: ListTargetResourceTypesCommandOutput) => void ): void; - public listTargetResourceTypes( + listTargetResourceTypes( args: ListTargetResourceTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTargetResourceTypesCommandOutput) => void ): void; - public listTargetResourceTypes( - args: ListTargetResourceTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTargetResourceTypesCommandOutput) => void), - cb?: (err: any, data?: ListTargetResourceTypesCommandOutput) => void - ): Promise | void { - const command = new ListTargetResourceTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts running an experiment from the specified experiment template.

+ * @see {@link StartExperimentCommand} */ - public startExperiment( + startExperiment( args: StartExperimentCommandInput, options?: __HttpHandlerOptions ): Promise; - public startExperiment( - args: StartExperimentCommandInput, - cb: (err: any, data?: StartExperimentCommandOutput) => void - ): void; - public startExperiment( + startExperiment(args: StartExperimentCommandInput, cb: (err: any, data?: StartExperimentCommandOutput) => void): void; + startExperiment( args: StartExperimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartExperimentCommandOutput) => void ): void; - public startExperiment( - args: StartExperimentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartExperimentCommandOutput) => void), - cb?: (err: any, data?: StartExperimentCommandOutput) => void - ): Promise | void { - const command = new StartExperimentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops the specified experiment.

+ * @see {@link StopExperimentCommand} */ - public stopExperiment( + stopExperiment( args: StopExperimentCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopExperiment( - args: StopExperimentCommandInput, - cb: (err: any, data?: StopExperimentCommandOutput) => void - ): void; - public stopExperiment( + stopExperiment(args: StopExperimentCommandInput, cb: (err: any, data?: StopExperimentCommandOutput) => void): void; + stopExperiment( args: StopExperimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopExperimentCommandOutput) => void ): void; - public stopExperiment( - args: StopExperimentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopExperimentCommandOutput) => void), - cb?: (err: any, data?: StopExperimentCommandOutput) => void - ): Promise | void { - const command = new StopExperimentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Applies the specified tags to the specified resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified tags from the specified resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified experiment template.

+ * @see {@link UpdateExperimentTemplateCommand} */ - public updateExperimentTemplate( + updateExperimentTemplate( args: UpdateExperimentTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateExperimentTemplate( + updateExperimentTemplate( args: UpdateExperimentTemplateCommandInput, cb: (err: any, data?: UpdateExperimentTemplateCommandOutput) => void ): void; - public updateExperimentTemplate( + updateExperimentTemplate( args: UpdateExperimentTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateExperimentTemplateCommandOutput) => void ): void; - public updateExperimentTemplate( - args: UpdateExperimentTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateExperimentTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateExperimentTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateExperimentTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Fault Injection Simulator is a managed service that enables you to perform fault injection + * experiments on your Amazon Web Services workloads. For more information, see the Fault Injection Simulator User Guide.

+ */ +export class Fis extends FisClient implements Fis {} +createAggregatedClient(commands, Fis); diff --git a/clients/client-fms/src/FMS.ts b/clients/client-fms/src/FMS.ts index 90f2b0ceaad3..099e18cdf1e7 100644 --- a/clients/client-fms/src/FMS.ts +++ b/clients/client-fms/src/FMS.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -171,1313 +172,640 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; -import { FMSClient } from "./FMSClient"; +import { FMSClient, FMSClientConfig } from "./FMSClient"; -/** - * @public - *

This is the Firewall Manager API Reference. This guide is for - * developers who need detailed information about the Firewall Manager API actions, data - * types, and errors. For detailed information about Firewall Manager features, see the - * Firewall Manager Developer Guide.

- *

Some API actions require explicit resource permissions. For information, see the developer guide topic - * Firewall Manager required permissions for API actions. - *

- */ -export class FMS extends FMSClient { +const commands = { + AssociateAdminAccountCommand, + AssociateThirdPartyFirewallCommand, + BatchAssociateResourceCommand, + BatchDisassociateResourceCommand, + DeleteAppsListCommand, + DeleteNotificationChannelCommand, + DeletePolicyCommand, + DeleteProtocolsListCommand, + DeleteResourceSetCommand, + DisassociateAdminAccountCommand, + DisassociateThirdPartyFirewallCommand, + GetAdminAccountCommand, + GetAppsListCommand, + GetComplianceDetailCommand, + GetNotificationChannelCommand, + GetPolicyCommand, + GetProtectionStatusCommand, + GetProtocolsListCommand, + GetResourceSetCommand, + GetThirdPartyFirewallAssociationStatusCommand, + GetViolationDetailsCommand, + ListAppsListsCommand, + ListComplianceStatusCommand, + ListDiscoveredResourcesCommand, + ListMemberAccountsCommand, + ListPoliciesCommand, + ListProtocolsListsCommand, + ListResourceSetResourcesCommand, + ListResourceSetsCommand, + ListTagsForResourceCommand, + ListThirdPartyFirewallFirewallPoliciesCommand, + PutAppsListCommand, + PutNotificationChannelCommand, + PutPolicyCommand, + PutProtocolsListCommand, + PutResourceSetCommand, + TagResourceCommand, + UntagResourceCommand, +}; + +export interface FMS { /** - * @public - *

Sets the Firewall Manager administrator account. The account must be - * a member of the organization in Organizations whose resources you want to protect. - * Firewall Manager sets the permissions that allow the account to administer your Firewall Manager policies.

- *

The account that you associate with Firewall Manager is called the Firewall Manager administrator account.

+ * @see {@link AssociateAdminAccountCommand} */ - public associateAdminAccount( + associateAdminAccount( args: AssociateAdminAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateAdminAccount( + associateAdminAccount( args: AssociateAdminAccountCommandInput, cb: (err: any, data?: AssociateAdminAccountCommandOutput) => void ): void; - public associateAdminAccount( + associateAdminAccount( args: AssociateAdminAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateAdminAccountCommandOutput) => void ): void; - public associateAdminAccount( - args: AssociateAdminAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateAdminAccountCommandOutput) => void), - cb?: (err: any, data?: AssociateAdminAccountCommandOutput) => void - ): Promise | void { - const command = new AssociateAdminAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service. A tenant is an instance of the third-party firewall service that's associated with your Amazon Web Services customer account.

+ * @see {@link AssociateThirdPartyFirewallCommand} */ - public associateThirdPartyFirewall( + associateThirdPartyFirewall( args: AssociateThirdPartyFirewallCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateThirdPartyFirewall( + associateThirdPartyFirewall( args: AssociateThirdPartyFirewallCommandInput, cb: (err: any, data?: AssociateThirdPartyFirewallCommandOutput) => void ): void; - public associateThirdPartyFirewall( + associateThirdPartyFirewall( args: AssociateThirdPartyFirewallCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateThirdPartyFirewallCommandOutput) => void ): void; - public associateThirdPartyFirewall( - args: AssociateThirdPartyFirewallCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateThirdPartyFirewallCommandOutput) => void), - cb?: (err: any, data?: AssociateThirdPartyFirewallCommandOutput) => void - ): Promise | void { - const command = new AssociateThirdPartyFirewallCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associate resources to a Firewall Manager resource set.

+ * @see {@link BatchAssociateResourceCommand} */ - public batchAssociateResource( + batchAssociateResource( args: BatchAssociateResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchAssociateResource( + batchAssociateResource( args: BatchAssociateResourceCommandInput, cb: (err: any, data?: BatchAssociateResourceCommandOutput) => void ): void; - public batchAssociateResource( + batchAssociateResource( args: BatchAssociateResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchAssociateResourceCommandOutput) => void ): void; - public batchAssociateResource( - args: BatchAssociateResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchAssociateResourceCommandOutput) => void), - cb?: (err: any, data?: BatchAssociateResourceCommandOutput) => void - ): Promise | void { - const command = new BatchAssociateResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates resources from a Firewall Manager resource set.

+ * @see {@link BatchDisassociateResourceCommand} */ - public batchDisassociateResource( + batchDisassociateResource( args: BatchDisassociateResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDisassociateResource( + batchDisassociateResource( args: BatchDisassociateResourceCommandInput, cb: (err: any, data?: BatchDisassociateResourceCommandOutput) => void ): void; - public batchDisassociateResource( + batchDisassociateResource( args: BatchDisassociateResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDisassociateResourceCommandOutput) => void ): void; - public batchDisassociateResource( - args: BatchDisassociateResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDisassociateResourceCommandOutput) => void), - cb?: (err: any, data?: BatchDisassociateResourceCommandOutput) => void - ): Promise | void { - const command = new BatchDisassociateResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Permanently deletes an Firewall Manager applications list.

+ * @see {@link DeleteAppsListCommand} */ - public deleteAppsList( + deleteAppsList( args: DeleteAppsListCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAppsList( - args: DeleteAppsListCommandInput, - cb: (err: any, data?: DeleteAppsListCommandOutput) => void - ): void; - public deleteAppsList( + deleteAppsList(args: DeleteAppsListCommandInput, cb: (err: any, data?: DeleteAppsListCommandOutput) => void): void; + deleteAppsList( args: DeleteAppsListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppsListCommandOutput) => void ): void; - public deleteAppsList( - args: DeleteAppsListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppsListCommandOutput) => void), - cb?: (err: any, data?: DeleteAppsListCommandOutput) => void - ): Promise | void { - const command = new DeleteAppsListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Firewall Manager association with the IAM role and the Amazon Simple - * Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.

+ * @see {@link DeleteNotificationChannelCommand} */ - public deleteNotificationChannel( + deleteNotificationChannel( args: DeleteNotificationChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNotificationChannel( + deleteNotificationChannel( args: DeleteNotificationChannelCommandInput, cb: (err: any, data?: DeleteNotificationChannelCommandOutput) => void ): void; - public deleteNotificationChannel( + deleteNotificationChannel( args: DeleteNotificationChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNotificationChannelCommandOutput) => void ): void; - public deleteNotificationChannel( - args: DeleteNotificationChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNotificationChannelCommandOutput) => void), - cb?: (err: any, data?: DeleteNotificationChannelCommandOutput) => void - ): Promise | void { - const command = new DeleteNotificationChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Permanently deletes an Firewall Manager policy.

+ * @see {@link DeletePolicyCommand} */ - public deletePolicy( - args: DeletePolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deletePolicy(args: DeletePolicyCommandInput, cb: (err: any, data?: DeletePolicyCommandOutput) => void): void; - public deletePolicy( + deletePolicy(args: DeletePolicyCommandInput, options?: __HttpHandlerOptions): Promise; + deletePolicy(args: DeletePolicyCommandInput, cb: (err: any, data?: DeletePolicyCommandOutput) => void): void; + deletePolicy( args: DeletePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePolicyCommandOutput) => void ): void; - public deletePolicy( - args: DeletePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePolicyCommandOutput) => void), - cb?: (err: any, data?: DeletePolicyCommandOutput) => void - ): Promise | void { - const command = new DeletePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Permanently deletes an Firewall Manager protocols list.

+ * @see {@link DeleteProtocolsListCommand} */ - public deleteProtocolsList( + deleteProtocolsList( args: DeleteProtocolsListCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteProtocolsList( + deleteProtocolsList( args: DeleteProtocolsListCommandInput, cb: (err: any, data?: DeleteProtocolsListCommandOutput) => void ): void; - public deleteProtocolsList( + deleteProtocolsList( args: DeleteProtocolsListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProtocolsListCommandOutput) => void ): void; - public deleteProtocolsList( - args: DeleteProtocolsListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProtocolsListCommandOutput) => void), - cb?: (err: any, data?: DeleteProtocolsListCommandOutput) => void - ): Promise | void { - const command = new DeleteProtocolsListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified ResourceSet.

+ * @see {@link DeleteResourceSetCommand} */ - public deleteResourceSet( + deleteResourceSet( args: DeleteResourceSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourceSet( + deleteResourceSet( args: DeleteResourceSetCommandInput, cb: (err: any, data?: DeleteResourceSetCommandOutput) => void ): void; - public deleteResourceSet( + deleteResourceSet( args: DeleteResourceSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourceSetCommandOutput) => void ): void; - public deleteResourceSet( - args: DeleteResourceSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourceSetCommandOutput) => void), - cb?: (err: any, data?: DeleteResourceSetCommandOutput) => void - ): Promise | void { - const command = new DeleteResourceSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates the account that has been set as the Firewall Manager administrator - * account. To set a different account as the administrator account, you must submit an - * AssociateAdminAccount request.

+ * @see {@link DisassociateAdminAccountCommand} */ - public disassociateAdminAccount( + disassociateAdminAccount( args: DisassociateAdminAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateAdminAccount( + disassociateAdminAccount( args: DisassociateAdminAccountCommandInput, cb: (err: any, data?: DisassociateAdminAccountCommandOutput) => void ): void; - public disassociateAdminAccount( + disassociateAdminAccount( args: DisassociateAdminAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateAdminAccountCommandOutput) => void ): void; - public disassociateAdminAccount( - args: DisassociateAdminAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateAdminAccountCommandOutput) => void), - cb?: (err: any, data?: DisassociateAdminAccountCommandOutput) => void - ): Promise | void { - const command = new DisassociateAdminAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates a Firewall Manager policy administrator from a third-party firewall tenant. When you call DisassociateThirdPartyFirewall, the third-party firewall vendor deletes all of the firewalls that are associated with the account.

+ * @see {@link DisassociateThirdPartyFirewallCommand} */ - public disassociateThirdPartyFirewall( + disassociateThirdPartyFirewall( args: DisassociateThirdPartyFirewallCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateThirdPartyFirewall( + disassociateThirdPartyFirewall( args: DisassociateThirdPartyFirewallCommandInput, cb: (err: any, data?: DisassociateThirdPartyFirewallCommandOutput) => void ): void; - public disassociateThirdPartyFirewall( + disassociateThirdPartyFirewall( args: DisassociateThirdPartyFirewallCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateThirdPartyFirewallCommandOutput) => void ): void; - public disassociateThirdPartyFirewall( - args: DisassociateThirdPartyFirewallCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateThirdPartyFirewallCommandOutput) => void), - cb?: (err: any, data?: DisassociateThirdPartyFirewallCommandOutput) => void - ): Promise | void { - const command = new DisassociateThirdPartyFirewallCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the Organizations account that is associated with Firewall Manager - * as the Firewall Manager administrator.

+ * @see {@link GetAdminAccountCommand} */ - public getAdminAccount( + getAdminAccount( args: GetAdminAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAdminAccount( - args: GetAdminAccountCommandInput, - cb: (err: any, data?: GetAdminAccountCommandOutput) => void - ): void; - public getAdminAccount( + getAdminAccount(args: GetAdminAccountCommandInput, cb: (err: any, data?: GetAdminAccountCommandOutput) => void): void; + getAdminAccount( args: GetAdminAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAdminAccountCommandOutput) => void ): void; - public getAdminAccount( - args: GetAdminAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAdminAccountCommandOutput) => void), - cb?: (err: any, data?: GetAdminAccountCommandOutput) => void - ): Promise | void { - const command = new GetAdminAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the specified Firewall Manager applications list.

+ * @see {@link GetAppsListCommand} */ - public getAppsList(args: GetAppsListCommandInput, options?: __HttpHandlerOptions): Promise; - public getAppsList(args: GetAppsListCommandInput, cb: (err: any, data?: GetAppsListCommandOutput) => void): void; - public getAppsList( + getAppsList(args: GetAppsListCommandInput, options?: __HttpHandlerOptions): Promise; + getAppsList(args: GetAppsListCommandInput, cb: (err: any, data?: GetAppsListCommandOutput) => void): void; + getAppsList( args: GetAppsListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAppsListCommandOutput) => void ): void; - public getAppsList( - args: GetAppsListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAppsListCommandOutput) => void), - cb?: (err: any, data?: GetAppsListCommandOutput) => void - ): Promise | void { - const command = new GetAppsListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns detailed compliance information about the specified member account. Details - * include resources that are in and out of compliance with the specified policy.

- *
    - *
  • - *

    Resources are - * considered noncompliant for WAF and Shield Advanced policies if the specified policy has - * not been applied to them.

    - *
  • - *
  • - *

    Resources are considered noncompliant for security group policies if - * they are in scope of the policy, they violate one or more of the policy rules, and remediation - * is disabled or not possible.

    - *
  • - *
  • - *

    Resources are considered noncompliant for Network Firewall policies - * if a firewall is missing in the VPC, if the firewall endpoint isn't set up in an expected Availability Zone and subnet, - * if a subnet created by the Firewall Manager doesn't have the expected route table, - * and for modifications to a firewall policy that violate the Firewall Manager policy's rules.

    - *
  • - *
  • - *

    Resources are considered noncompliant for DNS Firewall policies - * if a DNS Firewall rule group is missing from the rule group associations for the VPC.

    - *
  • - *
+ * @see {@link GetComplianceDetailCommand} */ - public getComplianceDetail( + getComplianceDetail( args: GetComplianceDetailCommandInput, options?: __HttpHandlerOptions ): Promise; - public getComplianceDetail( + getComplianceDetail( args: GetComplianceDetailCommandInput, cb: (err: any, data?: GetComplianceDetailCommandOutput) => void ): void; - public getComplianceDetail( + getComplianceDetail( args: GetComplianceDetailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComplianceDetailCommandOutput) => void ): void; - public getComplianceDetail( - args: GetComplianceDetailCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetComplianceDetailCommandOutput) => void), - cb?: (err: any, data?: GetComplianceDetailCommandOutput) => void - ): Promise | void { - const command = new GetComplianceDetailCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Information - * about the Amazon Simple Notification Service (SNS) topic that is used to - * record Firewall Manager SNS logs.

+ * @see {@link GetNotificationChannelCommand} */ - public getNotificationChannel( + getNotificationChannel( args: GetNotificationChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public getNotificationChannel( + getNotificationChannel( args: GetNotificationChannelCommandInput, cb: (err: any, data?: GetNotificationChannelCommandOutput) => void ): void; - public getNotificationChannel( + getNotificationChannel( args: GetNotificationChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNotificationChannelCommandOutput) => void ): void; - public getNotificationChannel( - args: GetNotificationChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetNotificationChannelCommandOutput) => void), - cb?: (err: any, data?: GetNotificationChannelCommandOutput) => void - ): Promise | void { - const command = new GetNotificationChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the specified Firewall Manager policy.

+ * @see {@link GetPolicyCommand} */ - public getPolicy(args: GetPolicyCommandInput, options?: __HttpHandlerOptions): Promise; - public getPolicy(args: GetPolicyCommandInput, cb: (err: any, data?: GetPolicyCommandOutput) => void): void; - public getPolicy( + getPolicy(args: GetPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + getPolicy(args: GetPolicyCommandInput, cb: (err: any, data?: GetPolicyCommandOutput) => void): void; + getPolicy( args: GetPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPolicyCommandOutput) => void ): void; - public getPolicy( - args: GetPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPolicyCommandOutput) => void), - cb?: (err: any, data?: GetPolicyCommandOutput) => void - ): Promise | void { - const command = new GetPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

If you created a Shield Advanced policy, returns policy-level attack summary information - * in the event of a potential DDoS attack. Other policy types are currently unsupported.

+ * @see {@link GetProtectionStatusCommand} */ - public getProtectionStatus( + getProtectionStatus( args: GetProtectionStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getProtectionStatus( + getProtectionStatus( args: GetProtectionStatusCommandInput, cb: (err: any, data?: GetProtectionStatusCommandOutput) => void ): void; - public getProtectionStatus( + getProtectionStatus( args: GetProtectionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProtectionStatusCommandOutput) => void ): void; - public getProtectionStatus( - args: GetProtectionStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetProtectionStatusCommandOutput) => void), - cb?: (err: any, data?: GetProtectionStatusCommandOutput) => void - ): Promise | void { - const command = new GetProtectionStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the specified Firewall Manager protocols list.

+ * @see {@link GetProtocolsListCommand} */ - public getProtocolsList( + getProtocolsList( args: GetProtocolsListCommandInput, options?: __HttpHandlerOptions ): Promise; - public getProtocolsList( + getProtocolsList( args: GetProtocolsListCommandInput, cb: (err: any, data?: GetProtocolsListCommandOutput) => void ): void; - public getProtocolsList( + getProtocolsList( args: GetProtocolsListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProtocolsListCommandOutput) => void ): void; - public getProtocolsList( - args: GetProtocolsListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetProtocolsListCommandOutput) => void), - cb?: (err: any, data?: GetProtocolsListCommandOutput) => void - ): Promise | void { - const command = new GetProtocolsListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a specific resource set.

+ * @see {@link GetResourceSetCommand} */ - public getResourceSet( + getResourceSet( args: GetResourceSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourceSet( - args: GetResourceSetCommandInput, - cb: (err: any, data?: GetResourceSetCommandOutput) => void - ): void; - public getResourceSet( + getResourceSet(args: GetResourceSetCommandInput, cb: (err: any, data?: GetResourceSetCommandOutput) => void): void; + getResourceSet( args: GetResourceSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceSetCommandOutput) => void ): void; - public getResourceSet( - args: GetResourceSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourceSetCommandOutput) => void), - cb?: (err: any, data?: GetResourceSetCommandOutput) => void - ): Promise | void { - const command = new GetResourceSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant.

+ * @see {@link GetThirdPartyFirewallAssociationStatusCommand} */ - public getThirdPartyFirewallAssociationStatus( + getThirdPartyFirewallAssociationStatus( args: GetThirdPartyFirewallAssociationStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getThirdPartyFirewallAssociationStatus( + getThirdPartyFirewallAssociationStatus( args: GetThirdPartyFirewallAssociationStatusCommandInput, cb: (err: any, data?: GetThirdPartyFirewallAssociationStatusCommandOutput) => void ): void; - public getThirdPartyFirewallAssociationStatus( + getThirdPartyFirewallAssociationStatus( args: GetThirdPartyFirewallAssociationStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetThirdPartyFirewallAssociationStatusCommandOutput) => void ): void; - public getThirdPartyFirewallAssociationStatus( - args: GetThirdPartyFirewallAssociationStatusCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetThirdPartyFirewallAssociationStatusCommandOutput) => void), - cb?: (err: any, data?: GetThirdPartyFirewallAssociationStatusCommandOutput) => void - ): Promise | void { - const command = new GetThirdPartyFirewallAssociationStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.

+ * @see {@link GetViolationDetailsCommand} */ - public getViolationDetails( + getViolationDetails( args: GetViolationDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getViolationDetails( + getViolationDetails( args: GetViolationDetailsCommandInput, cb: (err: any, data?: GetViolationDetailsCommandOutput) => void ): void; - public getViolationDetails( + getViolationDetails( args: GetViolationDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetViolationDetailsCommandOutput) => void ): void; - public getViolationDetails( - args: GetViolationDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetViolationDetailsCommandOutput) => void), - cb?: (err: any, data?: GetViolationDetailsCommandOutput) => void - ): Promise | void { - const command = new GetViolationDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of AppsListDataSummary objects.

+ * @see {@link ListAppsListsCommand} */ - public listAppsLists( - args: ListAppsListsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listAppsLists( - args: ListAppsListsCommandInput, - cb: (err: any, data?: ListAppsListsCommandOutput) => void - ): void; - public listAppsLists( + listAppsLists(args: ListAppsListsCommandInput, options?: __HttpHandlerOptions): Promise; + listAppsLists(args: ListAppsListsCommandInput, cb: (err: any, data?: ListAppsListsCommandOutput) => void): void; + listAppsLists( args: ListAppsListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppsListsCommandOutput) => void ): void; - public listAppsLists( - args: ListAppsListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppsListsCommandOutput) => void), - cb?: (err: any, data?: ListAppsListsCommandOutput) => void - ): Promise | void { - const command = new ListAppsListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of PolicyComplianceStatus objects. Use - * PolicyComplianceStatus to get a summary of which member accounts are protected - * by the specified policy.

+ * @see {@link ListComplianceStatusCommand} */ - public listComplianceStatus( + listComplianceStatus( args: ListComplianceStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public listComplianceStatus( + listComplianceStatus( args: ListComplianceStatusCommandInput, cb: (err: any, data?: ListComplianceStatusCommandOutput) => void ): void; - public listComplianceStatus( + listComplianceStatus( args: ListComplianceStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComplianceStatusCommandOutput) => void ): void; - public listComplianceStatus( - args: ListComplianceStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListComplianceStatusCommandOutput) => void), - cb?: (err: any, data?: ListComplianceStatusCommandOutput) => void - ): Promise | void { - const command = new ListComplianceStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of resources in the organization's accounts that are available to be associated with a resource set.

+ * @see {@link ListDiscoveredResourcesCommand} */ - public listDiscoveredResources( + listDiscoveredResources( args: ListDiscoveredResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDiscoveredResources( + listDiscoveredResources( args: ListDiscoveredResourcesCommandInput, cb: (err: any, data?: ListDiscoveredResourcesCommandOutput) => void ): void; - public listDiscoveredResources( + listDiscoveredResources( args: ListDiscoveredResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDiscoveredResourcesCommandOutput) => void ): void; - public listDiscoveredResources( - args: ListDiscoveredResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDiscoveredResourcesCommandOutput) => void), - cb?: (err: any, data?: ListDiscoveredResourcesCommandOutput) => void - ): Promise | void { - const command = new ListDiscoveredResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a MemberAccounts object that lists the member accounts in the - * administrator's Amazon Web Services organization.

- *

The ListMemberAccounts must be submitted by the account that is set as the - * Firewall Manager administrator.

+ * @see {@link ListMemberAccountsCommand} */ - public listMemberAccounts( + listMemberAccounts( args: ListMemberAccountsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMemberAccounts( + listMemberAccounts( args: ListMemberAccountsCommandInput, cb: (err: any, data?: ListMemberAccountsCommandOutput) => void ): void; - public listMemberAccounts( + listMemberAccounts( args: ListMemberAccountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMemberAccountsCommandOutput) => void ): void; - public listMemberAccounts( - args: ListMemberAccountsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMemberAccountsCommandOutput) => void), - cb?: (err: any, data?: ListMemberAccountsCommandOutput) => void - ): Promise | void { - const command = new ListMemberAccountsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of PolicySummary objects.

+ * @see {@link ListPoliciesCommand} */ - public listPolicies( - args: ListPoliciesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listPolicies(args: ListPoliciesCommandInput, cb: (err: any, data?: ListPoliciesCommandOutput) => void): void; - public listPolicies( + listPolicies(args: ListPoliciesCommandInput, options?: __HttpHandlerOptions): Promise; + listPolicies(args: ListPoliciesCommandInput, cb: (err: any, data?: ListPoliciesCommandOutput) => void): void; + listPolicies( args: ListPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPoliciesCommandOutput) => void ): void; - public listPolicies( - args: ListPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of ProtocolsListDataSummary objects.

+ * @see {@link ListProtocolsListsCommand} */ - public listProtocolsLists( + listProtocolsLists( args: ListProtocolsListsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProtocolsLists( + listProtocolsLists( args: ListProtocolsListsCommandInput, cb: (err: any, data?: ListProtocolsListsCommandOutput) => void ): void; - public listProtocolsLists( + listProtocolsLists( args: ListProtocolsListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProtocolsListsCommandOutput) => void ): void; - public listProtocolsLists( - args: ListProtocolsListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProtocolsListsCommandOutput) => void), - cb?: (err: any, data?: ListProtocolsListsCommandOutput) => void - ): Promise | void { - const command = new ListProtocolsListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of resources that are currently associated to a resource set.

+ * @see {@link ListResourceSetResourcesCommand} */ - public listResourceSetResources( + listResourceSetResources( args: ListResourceSetResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourceSetResources( + listResourceSetResources( args: ListResourceSetResourcesCommandInput, cb: (err: any, data?: ListResourceSetResourcesCommandOutput) => void ): void; - public listResourceSetResources( + listResourceSetResources( args: ListResourceSetResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceSetResourcesCommandOutput) => void ): void; - public listResourceSetResources( - args: ListResourceSetResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourceSetResourcesCommandOutput) => void), - cb?: (err: any, data?: ListResourceSetResourcesCommandOutput) => void - ): Promise | void { - const command = new ListResourceSetResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of ResourceSetSummary objects.

+ * @see {@link ListResourceSetsCommand} */ - public listResourceSets( + listResourceSets( args: ListResourceSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourceSets( + listResourceSets( args: ListResourceSetsCommandInput, cb: (err: any, data?: ListResourceSetsCommandOutput) => void ): void; - public listResourceSets( + listResourceSets( args: ListResourceSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceSetsCommandOutput) => void ): void; - public listResourceSets( - args: ListResourceSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourceSetsCommandOutput) => void), - cb?: (err: any, data?: ListResourceSetsCommandOutput) => void - ): Promise | void { - const command = new ListResourceSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the list of tags for the specified Amazon Web Services resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account.

+ * @see {@link ListThirdPartyFirewallFirewallPoliciesCommand} */ - public listThirdPartyFirewallFirewallPolicies( + listThirdPartyFirewallFirewallPolicies( args: ListThirdPartyFirewallFirewallPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listThirdPartyFirewallFirewallPolicies( + listThirdPartyFirewallFirewallPolicies( args: ListThirdPartyFirewallFirewallPoliciesCommandInput, cb: (err: any, data?: ListThirdPartyFirewallFirewallPoliciesCommandOutput) => void ): void; - public listThirdPartyFirewallFirewallPolicies( + listThirdPartyFirewallFirewallPolicies( args: ListThirdPartyFirewallFirewallPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListThirdPartyFirewallFirewallPoliciesCommandOutput) => void ): void; - public listThirdPartyFirewallFirewallPolicies( - args: ListThirdPartyFirewallFirewallPoliciesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListThirdPartyFirewallFirewallPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListThirdPartyFirewallFirewallPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListThirdPartyFirewallFirewallPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Firewall Manager applications list.

+ * @see {@link PutAppsListCommand} */ - public putAppsList(args: PutAppsListCommandInput, options?: __HttpHandlerOptions): Promise; - public putAppsList(args: PutAppsListCommandInput, cb: (err: any, data?: PutAppsListCommandOutput) => void): void; - public putAppsList( + putAppsList(args: PutAppsListCommandInput, options?: __HttpHandlerOptions): Promise; + putAppsList(args: PutAppsListCommandInput, cb: (err: any, data?: PutAppsListCommandOutput) => void): void; + putAppsList( args: PutAppsListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAppsListCommandOutput) => void ): void; - public putAppsList( - args: PutAppsListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAppsListCommandOutput) => void), - cb?: (err: any, data?: PutAppsListCommandOutput) => void - ): Promise | void { - const command = new PutAppsListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Designates the IAM role and Amazon Simple Notification Service (SNS) topic that - * Firewall Manager uses to record SNS logs.

- *

To perform this action outside of the console, you must configure the SNS topic to allow the Firewall Manager - * role AWSServiceRoleForFMS to publish SNS logs. For more information, see - * Firewall Manager required permissions for API actions in the Firewall Manager Developer Guide.

+ * @see {@link PutNotificationChannelCommand} */ - public putNotificationChannel( + putNotificationChannel( args: PutNotificationChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public putNotificationChannel( + putNotificationChannel( args: PutNotificationChannelCommandInput, cb: (err: any, data?: PutNotificationChannelCommandOutput) => void ): void; - public putNotificationChannel( + putNotificationChannel( args: PutNotificationChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutNotificationChannelCommandOutput) => void ): void; - public putNotificationChannel( - args: PutNotificationChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutNotificationChannelCommandOutput) => void), - cb?: (err: any, data?: PutNotificationChannelCommandOutput) => void - ): Promise | void { - const command = new PutNotificationChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Firewall Manager policy.

- *

Firewall Manager provides the following types of policies:

- *
    - *
  • - *

    An WAF policy (type WAFV2), which defines rule groups to run first in the - * corresponding WAF web ACL and rule groups to run last in the web ACL.

    - *
  • - *
  • - *

    An WAF Classic policy (type WAF), which defines a rule group.

    - *
  • - *
  • - *

    A Shield Advanced policy, which applies Shield Advanced protection to specified - * accounts and resources.

    - *
  • - *
  • - *

    A security group policy, which manages VPC security groups across your Amazon Web Services - * organization.

    - *
  • - *
  • - *

    An Network Firewall policy, which provides firewall rules to filter network traffic in specified - * Amazon VPCs.

    - *
  • - *
  • - *

    A DNS Firewall policy, which provides Route 53 Resolver DNS Firewall rules to filter DNS queries for - * specified VPCs.

    - *
  • - *
- *

Each policy is specific to one of the types. If you want to enforce more than one - * policy type across accounts, create multiple policies. You can create multiple - * policies for each type.

- *

You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more - * information about subscribing to Shield Advanced, see - * CreateSubscription.

+ * @see {@link PutPolicyCommand} */ - public putPolicy(args: PutPolicyCommandInput, options?: __HttpHandlerOptions): Promise; - public putPolicy(args: PutPolicyCommandInput, cb: (err: any, data?: PutPolicyCommandOutput) => void): void; - public putPolicy( + putPolicy(args: PutPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + putPolicy(args: PutPolicyCommandInput, cb: (err: any, data?: PutPolicyCommandOutput) => void): void; + putPolicy( args: PutPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPolicyCommandOutput) => void ): void; - public putPolicy( - args: PutPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutPolicyCommandOutput) => void), - cb?: (err: any, data?: PutPolicyCommandOutput) => void - ): Promise | void { - const command = new PutPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Firewall Manager protocols list.

+ * @see {@link PutProtocolsListCommand} */ - public putProtocolsList( + putProtocolsList( args: PutProtocolsListCommandInput, options?: __HttpHandlerOptions ): Promise; - public putProtocolsList( + putProtocolsList( args: PutProtocolsListCommandInput, cb: (err: any, data?: PutProtocolsListCommandOutput) => void ): void; - public putProtocolsList( + putProtocolsList( args: PutProtocolsListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutProtocolsListCommandOutput) => void ): void; - public putProtocolsList( - args: PutProtocolsListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutProtocolsListCommandOutput) => void), - cb?: (err: any, data?: PutProtocolsListCommandOutput) => void - ): Promise | void { - const command = new PutProtocolsListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates the resource set.

- *

An Firewall Manager resource set defines the resources to import into an Firewall Manager policy from another Amazon Web Services service.

+ * @see {@link PutResourceSetCommand} */ - public putResourceSet( + putResourceSet( args: PutResourceSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResourceSet( - args: PutResourceSetCommandInput, - cb: (err: any, data?: PutResourceSetCommandOutput) => void - ): void; - public putResourceSet( + putResourceSet(args: PutResourceSetCommandInput, cb: (err: any, data?: PutResourceSetCommandOutput) => void): void; + putResourceSet( args: PutResourceSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourceSetCommandOutput) => void ): void; - public putResourceSet( - args: PutResourceSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourceSetCommandOutput) => void), - cb?: (err: any, data?: PutResourceSetCommandOutput) => void - ): Promise | void { - const command = new PutResourceSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more tags to an Amazon Web Services resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from an Amazon Web Services resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

This is the Firewall Manager API Reference. This guide is for + * developers who need detailed information about the Firewall Manager API actions, data + * types, and errors. For detailed information about Firewall Manager features, see the + * Firewall Manager Developer Guide.

+ *

Some API actions require explicit resource permissions. For information, see the developer guide topic + * Firewall Manager required permissions for API actions. + *

+ */ +export class FMS extends FMSClient implements FMS {} +createAggregatedClient(commands, FMS); diff --git a/clients/client-forecast/src/Forecast.ts b/clients/client-forecast/src/Forecast.ts index 882dc592f25e..c09536f2b520 100644 --- a/clients/client-forecast/src/Forecast.ts +++ b/clients/client-forecast/src/Forecast.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -312,2889 +313,1066 @@ import { UpdateDatasetGroupCommandInput, UpdateDatasetGroupCommandOutput, } from "./commands/UpdateDatasetGroupCommand"; -import { ForecastClient } from "./ForecastClient"; +import { ForecastClient, ForecastClientConfig } from "./ForecastClient"; -/** - * @public - *

Provides APIs for creating and managing Amazon Forecast resources.

- */ -export class Forecast extends ForecastClient { +const commands = { + CreateAutoPredictorCommand, + CreateDatasetCommand, + CreateDatasetGroupCommand, + CreateDatasetImportJobCommand, + CreateExplainabilityCommand, + CreateExplainabilityExportCommand, + CreateForecastCommand, + CreateForecastExportJobCommand, + CreateMonitorCommand, + CreatePredictorCommand, + CreatePredictorBacktestExportJobCommand, + CreateWhatIfAnalysisCommand, + CreateWhatIfForecastCommand, + CreateWhatIfForecastExportCommand, + DeleteDatasetCommand, + DeleteDatasetGroupCommand, + DeleteDatasetImportJobCommand, + DeleteExplainabilityCommand, + DeleteExplainabilityExportCommand, + DeleteForecastCommand, + DeleteForecastExportJobCommand, + DeleteMonitorCommand, + DeletePredictorCommand, + DeletePredictorBacktestExportJobCommand, + DeleteResourceTreeCommand, + DeleteWhatIfAnalysisCommand, + DeleteWhatIfForecastCommand, + DeleteWhatIfForecastExportCommand, + DescribeAutoPredictorCommand, + DescribeDatasetCommand, + DescribeDatasetGroupCommand, + DescribeDatasetImportJobCommand, + DescribeExplainabilityCommand, + DescribeExplainabilityExportCommand, + DescribeForecastCommand, + DescribeForecastExportJobCommand, + DescribeMonitorCommand, + DescribePredictorCommand, + DescribePredictorBacktestExportJobCommand, + DescribeWhatIfAnalysisCommand, + DescribeWhatIfForecastCommand, + DescribeWhatIfForecastExportCommand, + GetAccuracyMetricsCommand, + ListDatasetGroupsCommand, + ListDatasetImportJobsCommand, + ListDatasetsCommand, + ListExplainabilitiesCommand, + ListExplainabilityExportsCommand, + ListForecastExportJobsCommand, + ListForecastsCommand, + ListMonitorEvaluationsCommand, + ListMonitorsCommand, + ListPredictorBacktestExportJobsCommand, + ListPredictorsCommand, + ListTagsForResourceCommand, + ListWhatIfAnalysesCommand, + ListWhatIfForecastExportsCommand, + ListWhatIfForecastsCommand, + ResumeResourceCommand, + StopResourceCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateDatasetGroupCommand, +}; + +export interface Forecast { /** - * @public - *

Creates an Amazon Forecast predictor.

- *

Amazon Forecast creates predictors with AutoPredictor, which involves applying the - * optimal combination of algorithms to each time series in your datasets. You can use - * CreateAutoPredictor to create new predictors or upgrade/retrain - * existing predictors.

- *

- * Creating new predictors - *

- *

The following parameters are required when creating a new predictor:

- *
    - *
  • - *

    - * PredictorName - A unique name for the predictor.

    - *
  • - *
  • - *

    - * DatasetGroupArn - The ARN of the dataset group used to train the - * predictor.

    - *
  • - *
  • - *

    - * ForecastFrequency - The granularity of your forecasts (hourly, - * daily, weekly, etc).

    - *
  • - *
  • - *

    - * ForecastHorizon - The number of time-steps that the model - * predicts. The forecast horizon is also called the prediction length.

    - *
  • - *
- *

When creating a new predictor, do not specify a value for - * ReferencePredictorArn.

- *

- * Upgrading and retraining predictors - *

- *

The following parameters are required when retraining or upgrading a predictor:

- *
    - *
  • - *

    - * PredictorName - A unique name for the predictor.

    - *
  • - *
  • - *

    - * ReferencePredictorArn - The ARN of the predictor to retrain or - * upgrade.

    - *
  • - *
- *

When upgrading or retraining a predictor, only specify values for the - * ReferencePredictorArn and PredictorName.

+ * @see {@link CreateAutoPredictorCommand} */ - public createAutoPredictor( + createAutoPredictor( args: CreateAutoPredictorCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAutoPredictor( + createAutoPredictor( args: CreateAutoPredictorCommandInput, cb: (err: any, data?: CreateAutoPredictorCommandOutput) => void ): void; - public createAutoPredictor( + createAutoPredictor( args: CreateAutoPredictorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAutoPredictorCommandOutput) => void ): void; - public createAutoPredictor( - args: CreateAutoPredictorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAutoPredictorCommandOutput) => void), - cb?: (err: any, data?: CreateAutoPredictorCommandOutput) => void - ): Promise | void { - const command = new CreateAutoPredictorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Amazon Forecast dataset. The information about the dataset that you provide helps - * Forecast understand how to consume the data for model training. This includes the - * following:

- *
    - *
  • - *

    - * - * DataFrequency - * - How frequently your historical - * time-series data is collected.

    - *
  • - *
  • - *

    - * - * Domain - * and - * - * DatasetType - * - Each dataset has an associated dataset - * domain and a type within the domain. Amazon Forecast provides a list of predefined domains and - * types within each domain. For each unique dataset domain and type within the domain, - * Amazon Forecast requires your data to include a minimum set of predefined fields.

    - *
  • - *
  • - *

    - * - * Schema - * - A schema specifies the fields in the dataset, - * including the field name and data type.

    - *
  • - *
- *

After creating a dataset, you import your training data into it and add the dataset to a - * dataset group. You use the dataset group to create a predictor. For more information, see - * Importing datasets.

- *

To get a list of all your datasets, use the ListDatasets operation.

- *

For example Forecast datasets, see the Amazon Forecast Sample GitHub - * repository.

- * - *

The Status of a dataset must be ACTIVE before you can import - * training data. Use the DescribeDataset operation to get - * the status.

- *
+ * @see {@link CreateDatasetCommand} */ - public createDataset( - args: CreateDatasetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createDataset( - args: CreateDatasetCommandInput, - cb: (err: any, data?: CreateDatasetCommandOutput) => void - ): void; - public createDataset( + createDataset(args: CreateDatasetCommandInput, options?: __HttpHandlerOptions): Promise; + createDataset(args: CreateDatasetCommandInput, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void; + createDataset( args: CreateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetCommandOutput) => void ): void; - public createDataset( - args: CreateDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDatasetCommandOutput) => void), - cb?: (err: any, data?: CreateDatasetCommandOutput) => void - ): Promise | void { - const command = new CreateDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a dataset group, which holds a collection of related datasets. You can add - * datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation.

- *

After creating a dataset group and adding datasets, you use the dataset group when you - * create a predictor. For more information, see Dataset groups.

- *

To get a list of all your datasets groups, use the ListDatasetGroups - * operation.

- * - *

The Status of a dataset group must be ACTIVE before you can - * use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.

- *
+ * @see {@link CreateDatasetGroupCommand} */ - public createDatasetGroup( + createDatasetGroup( args: CreateDatasetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDatasetGroup( + createDatasetGroup( args: CreateDatasetGroupCommandInput, cb: (err: any, data?: CreateDatasetGroupCommandOutput) => void ): void; - public createDatasetGroup( + createDatasetGroup( args: CreateDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetGroupCommandOutput) => void ): void; - public createDatasetGroup( - args: CreateDatasetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDatasetGroupCommandOutput) => void), - cb?: (err: any, data?: CreateDatasetGroupCommandOutput) => void - ): Promise | void { - const command = new CreateDatasetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Imports your training data to an Amazon Forecast dataset. You provide the location of your - * training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset - * that you want to import the data to.

- *

You must specify a DataSource object that includes an - * Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy - * of your data and processes it in an internal Amazon Web Services system. For more information, see Set up - * permissions.

- *

The training data must be in CSV or Parquet format. The delimiter must be a comma (,).

- *

You can specify the path to a specific file, the S3 bucket, or to a folder in the S3 - * bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000 - * files.

- *

Because dataset imports are not aggregated, your most recent dataset import is the one - * that is used when training a predictor or generating a forecast. Make sure that your most - * recent dataset import contains all of the data you want to model off of, and not just the new - * data collected since the previous import.

- *

To get a list of all your dataset import jobs, filtered by specified criteria, use the - * ListDatasetImportJobs operation.

+ * @see {@link CreateDatasetImportJobCommand} */ - public createDatasetImportJob( + createDatasetImportJob( args: CreateDatasetImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDatasetImportJob( + createDatasetImportJob( args: CreateDatasetImportJobCommandInput, cb: (err: any, data?: CreateDatasetImportJobCommandOutput) => void ): void; - public createDatasetImportJob( + createDatasetImportJob( args: CreateDatasetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetImportJobCommandOutput) => void ): void; - public createDatasetImportJob( - args: CreateDatasetImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDatasetImportJobCommandOutput) => void), - cb?: (err: any, data?: CreateDatasetImportJobCommandOutput) => void - ): Promise | void { - const command = new CreateDatasetImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

Explainability is only available for Forecasts and Predictors generated from an - * AutoPredictor (CreateAutoPredictor)

- *
- *

Creates an Amazon Forecast Explainability.

- *

Explainability helps you better understand how the attributes in your datasets impact - * forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative - * impact of each attribute and determine whether they increase or decrease forecast - * values.

- *

To enable Forecast Explainability, your predictor must include at least one of the - * following: related time series, item metadata, or additional datasets like Holidays and - * the Weather Index.

- *

CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive - * aggregated Impact scores for all time series and time points in your datasets, provide a - * Predictor ARN. To receive Impact scores for specific time series and time points, - * provide a Forecast ARN.

- *

- * CreateExplainability with a Predictor ARN - *

- * - *

You can only have one Explainability resource per predictor. If you already - * enabled ExplainPredictor in CreateAutoPredictor, that - * predictor already has an Explainability resource.

- *
- *

The following parameters are required when providing a Predictor ARN:

- *
    - *
  • - *

    - * ExplainabilityName - A unique name for the Explainability.

    - *
  • - *
  • - *

    - * ResourceArn - The Arn of the predictor.

    - *
  • - *
  • - *

    - * TimePointGranularity - Must be set to “ALL”.

    - *
  • - *
  • - *

    - * TimeSeriesGranularity - Must be set to “ALL”.

    - *
  • - *
- *

Do not specify a value for the following parameters:

- *
    - *
  • - *

    - * DataSource - Only valid when TimeSeriesGranularity is - * “SPECIFIC”.

    - *
  • - *
  • - *

    - * Schema - Only valid when TimeSeriesGranularity is - * “SPECIFIC”.

    - *
  • - *
  • - *

    - * StartDateTime - Only valid when TimePointGranularity is - * “SPECIFIC”.

    - *
  • - *
  • - *

    - * EndDateTime - Only valid when TimePointGranularity is - * “SPECIFIC”.

    - *
  • - *
- *

- * CreateExplainability with a Forecast ARN - *

- * - *

You can specify a maximum of 50 time series and 500 time points.

- *
- *

The following parameters are required when providing a Predictor ARN:

- *
    - *
  • - *

    - * ExplainabilityName - A unique name for the Explainability.

    - *
  • - *
  • - *

    - * ResourceArn - The Arn of the forecast.

    - *
  • - *
  • - *

    - * TimePointGranularity - Either “ALL” or “SPECIFIC”.

    - *
  • - *
  • - *

    - * TimeSeriesGranularity - Either “ALL” or “SPECIFIC”.

    - *
  • - *
- *

If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the - * following:

- *
    - *
  • - *

    - * DataSource - The S3 location of the CSV file specifying your time - * series.

    - *
  • - *
  • - *

    - * Schema - The Schema defines the attributes and attribute types - * listed in the Data Source.

    - *
  • - *
- *

If you set TimePointGranularity to “SPECIFIC”, you must also provide the - * following:

- *
    - *
  • - *

    - * StartDateTime - The first timestamp in the range of time - * points.

    - *
  • - *
  • - *

    - * EndDateTime - The last timestamp in the range of time - * points.

    - *
  • - *
+ * @see {@link CreateExplainabilityCommand} */ - public createExplainability( + createExplainability( args: CreateExplainabilityCommandInput, options?: __HttpHandlerOptions ): Promise; - public createExplainability( + createExplainability( args: CreateExplainabilityCommandInput, cb: (err: any, data?: CreateExplainabilityCommandOutput) => void ): void; - public createExplainability( + createExplainability( args: CreateExplainabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExplainabilityCommandOutput) => void ): void; - public createExplainability( - args: CreateExplainabilityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateExplainabilityCommandOutput) => void), - cb?: (err: any, data?: CreateExplainabilityCommandOutput) => void - ): Promise | void { - const command = new CreateExplainabilityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Exports an Explainability resource created by the CreateExplainability operation. Exported files are exported to an Amazon Simple Storage Service (Amazon - * S3) bucket.

- *

You must specify a DataDestination object that includes an Amazon S3 - * bucket and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 - * bucket. For more information, see aws-forecast-iam-roles.

- * - *

The Status of the export job must be ACTIVE before you - * can access the export in your Amazon S3 bucket. To get the status, use the DescribeExplainabilityExport operation.

- *
+ * @see {@link CreateExplainabilityExportCommand} */ - public createExplainabilityExport( + createExplainabilityExport( args: CreateExplainabilityExportCommandInput, options?: __HttpHandlerOptions ): Promise; - public createExplainabilityExport( + createExplainabilityExport( args: CreateExplainabilityExportCommandInput, cb: (err: any, data?: CreateExplainabilityExportCommandOutput) => void ): void; - public createExplainabilityExport( + createExplainabilityExport( args: CreateExplainabilityExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExplainabilityExportCommandOutput) => void ): void; - public createExplainabilityExport( - args: CreateExplainabilityExportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateExplainabilityExportCommandOutput) => void), - cb?: (err: any, data?: CreateExplainabilityExportCommandOutput) => void - ): Promise | void { - const command = new CreateExplainabilityExportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was - * used to train the predictor. This is known as inference. To retrieve the forecast for a single - * item at low latency, use the operation. To - * export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation.

- *

The range of the forecast is determined by the ForecastHorizon value, which - * you specify in the CreatePredictor request. When you query a forecast, you - * can request a specific date range within the forecast.

- *

To get a list of all your forecasts, use the ListForecasts - * operation.

- * - *

The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was - * used to create the predictor.

- *
- *

For more information, see howitworks-forecast.

- * - *

The Status of the forecast must be ACTIVE before you can query - * or export the forecast. Use the DescribeForecast operation to get the - * status.

- *
- *

By default, a forecast includes predictions for every item (item_id) in the dataset group that was used to train the predictor. - * However, you can use the TimeSeriesSelector object to generate a forecast on a subset of time series. Forecast creation is skipped for any time series that you specify that are not in the input dataset. The forecast export file will not contain these time series or their forecasted values.

+ * @see {@link CreateForecastCommand} */ - public createForecast( + createForecast( args: CreateForecastCommandInput, options?: __HttpHandlerOptions ): Promise; - public createForecast( - args: CreateForecastCommandInput, - cb: (err: any, data?: CreateForecastCommandOutput) => void - ): void; - public createForecast( + createForecast(args: CreateForecastCommandInput, cb: (err: any, data?: CreateForecastCommandOutput) => void): void; + createForecast( args: CreateForecastCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateForecastCommandOutput) => void ): void; - public createForecast( - args: CreateForecastCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateForecastCommandOutput) => void), - cb?: (err: any, data?: CreateForecastCommandOutput) => void - ): Promise | void { - const command = new CreateForecastCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Exports a forecast created by the CreateForecast operation to your - * Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:

- *

__

- *

where the component is in Java SimpleDateFormat - * (yyyy-MM-ddTHH-mm-ssZ).

- *

You must specify a DataDestination object that includes an Identity and Access Management - * (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see - * aws-forecast-iam-roles.

- *

For more information, see howitworks-forecast.

- *

To get a list of all your forecast export jobs, use the ListForecastExportJobs operation.

- * - *

The Status of the forecast export job must be ACTIVE before - * you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob operation.

- *
+ * @see {@link CreateForecastExportJobCommand} */ - public createForecastExportJob( + createForecastExportJob( args: CreateForecastExportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createForecastExportJob( + createForecastExportJob( args: CreateForecastExportJobCommandInput, cb: (err: any, data?: CreateForecastExportJobCommandOutput) => void ): void; - public createForecastExportJob( + createForecastExportJob( args: CreateForecastExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateForecastExportJobCommandOutput) => void ): void; - public createForecastExportJob( - args: CreateForecastExportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateForecastExportJobCommandOutput) => void), - cb?: (err: any, data?: CreateForecastExportJobCommandOutput) => void - ): Promise | void { - const command = new CreateForecastExportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a predictor monitor resource for an existing auto predictor. Predictor monitoring allows you to see how your predictor's performance changes over time. - * For more information, see Predictor Monitoring. - *

+ * @see {@link CreateMonitorCommand} */ - public createMonitor( - args: CreateMonitorCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createMonitor( - args: CreateMonitorCommandInput, - cb: (err: any, data?: CreateMonitorCommandOutput) => void - ): void; - public createMonitor( + createMonitor(args: CreateMonitorCommandInput, options?: __HttpHandlerOptions): Promise; + createMonitor(args: CreateMonitorCommandInput, cb: (err: any, data?: CreateMonitorCommandOutput) => void): void; + createMonitor( args: CreateMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMonitorCommandOutput) => void ): void; - public createMonitor( - args: CreateMonitorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMonitorCommandOutput) => void), - cb?: (err: any, data?: CreateMonitorCommandOutput) => void - ): Promise | void { - const command = new CreateMonitorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This operation creates a legacy predictor that does not include all the predictor - * functionalities provided by Amazon Forecast. To create a predictor that is compatible with all - * aspects of Forecast, use CreateAutoPredictor.

- *
- *

Creates an Amazon Forecast predictor.

- *

In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast - * choose an algorithm for you using AutoML. If you specify an algorithm, you also can override - * algorithm-specific hyperparameters.

- *

Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets - * in the specified dataset group. You can then generate a forecast using the CreateForecast operation.

- *

To see the evaluation metrics, use the GetAccuracyMetrics operation.

- *

You can specify a featurization configuration to fill and aggregate the data fields in the - * TARGET_TIME_SERIES dataset to improve model training. For more information, see - * FeaturizationConfig.

- *

For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the - * DataFrequency specified when the dataset was created matches the - * ForecastFrequency. TARGET_TIME_SERIES datasets don't have this restriction. - * Amazon Forecast also verifies the delimiter and timestamp format. For more information, see howitworks-datasets-groups.

- *

By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9 - * (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor by - * setting the ForecastTypes.

- *

- * AutoML - *

- *

If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the - * objective function, set PerformAutoML to true. The - * objective function is defined as the mean of the weighted losses over the - * forecast types. By default, these are the p10, p50, and p90 quantile losses. For more - * information, see EvaluationResult.

- *

When AutoML is enabled, the following properties are disallowed:

- *
    - *
  • - *

    - * AlgorithmArn - *

    - *
  • - *
  • - *

    - * HPOConfig - *

    - *
  • - *
  • - *

    - * PerformHPO - *

    - *
  • - *
  • - *

    - * TrainingParameters - *

    - *
  • - *
- *

To get a list of all of your predictors, use the ListPredictors - * operation.

- * - *

Before you can use the predictor to create a forecast, the Status of the - * predictor must be ACTIVE, signifying that training has completed. To get the - * status, use the DescribePredictor operation.

- *
+ * @see {@link CreatePredictorCommand} */ - public createPredictor( + createPredictor( args: CreatePredictorCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPredictor( - args: CreatePredictorCommandInput, - cb: (err: any, data?: CreatePredictorCommandOutput) => void - ): void; - public createPredictor( + createPredictor(args: CreatePredictorCommandInput, cb: (err: any, data?: CreatePredictorCommandOutput) => void): void; + createPredictor( args: CreatePredictorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePredictorCommandOutput) => void ): void; - public createPredictor( - args: CreatePredictorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePredictorCommandOutput) => void), - cb?: (err: any, data?: CreatePredictorCommandOutput) => void - ): Promise | void { - const command = new CreatePredictorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or CreatePredictor operations. Two - * folders containing CSV or Parquet files are exported to your specified S3 bucket.

- *

The export file names will match the following conventions:

- *

- * __.csv - *

- *

The component is in Java SimpleDate format - * (yyyy-MM-ddTHH-mm-ssZ).

- *

You must specify a DataDestination object that includes an Amazon S3 - * bucket and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 - * bucket. For more information, see aws-forecast-iam-roles.

- * - *

The Status of the export job must be ACTIVE before you - * can access the export in your Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJob operation.

- *
+ * @see {@link CreatePredictorBacktestExportJobCommand} */ - public createPredictorBacktestExportJob( + createPredictorBacktestExportJob( args: CreatePredictorBacktestExportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPredictorBacktestExportJob( + createPredictorBacktestExportJob( args: CreatePredictorBacktestExportJobCommandInput, cb: (err: any, data?: CreatePredictorBacktestExportJobCommandOutput) => void ): void; - public createPredictorBacktestExportJob( + createPredictorBacktestExportJob( args: CreatePredictorBacktestExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePredictorBacktestExportJobCommandOutput) => void ): void; - public createPredictorBacktestExportJob( - args: CreatePredictorBacktestExportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePredictorBacktestExportJobCommandOutput) => void), - cb?: (err: any, data?: CreatePredictorBacktestExportJobCommandOutput) => void - ): Promise | void { - const command = new CreatePredictorBacktestExportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

What-if analysis is a scenario modeling technique where you make a hypothetical change to a time series and - * compare the forecasts generated by these changes against the baseline, unchanged time series. It is important to - * remember that the purpose of a what-if analysis is to understand how a forecast can change given different - * modifications to the baseline time series.

- *

For example, imagine you are a clothing retailer who is considering an end of season sale - * to clear space for new styles. After creating a baseline forecast, you can use a what-if - * analysis to investigate how different sales tactics might affect your goals.

- *

You could create a scenario where everything is given a 25% markdown, and another where - * everything is given a fixed dollar markdown. You could create a scenario where the sale lasts for one week and - * another where the sale lasts for one month. - * With a what-if analysis, you can compare many different scenarios against each other.

- *

Note that a what-if analysis is meant to display what the forecasting model has learned and how it will behave in the scenarios that you are evaluating. Do not blindly use the results of the what-if analysis to make business decisions. For instance, forecasts might not be accurate for novel scenarios where there is no reference available to determine whether a forecast is good.

- *

The TimeSeriesSelector object defines the items that you want in the what-if analysis.

+ * @see {@link CreateWhatIfAnalysisCommand} */ - public createWhatIfAnalysis( + createWhatIfAnalysis( args: CreateWhatIfAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWhatIfAnalysis( + createWhatIfAnalysis( args: CreateWhatIfAnalysisCommandInput, cb: (err: any, data?: CreateWhatIfAnalysisCommandOutput) => void ): void; - public createWhatIfAnalysis( + createWhatIfAnalysis( args: CreateWhatIfAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWhatIfAnalysisCommandOutput) => void ): void; - public createWhatIfAnalysis( - args: CreateWhatIfAnalysisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWhatIfAnalysisCommandOutput) => void), - cb?: (err: any, data?: CreateWhatIfAnalysisCommandOutput) => void - ): Promise | void { - const command = new CreateWhatIfAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A what-if forecast is a forecast that is created from a modified version of the baseline forecast. Each - * what-if forecast incorporates either a replacement dataset or a set of transformations to the original dataset.

+ * @see {@link CreateWhatIfForecastCommand} */ - public createWhatIfForecast( + createWhatIfForecast( args: CreateWhatIfForecastCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWhatIfForecast( + createWhatIfForecast( args: CreateWhatIfForecastCommandInput, cb: (err: any, data?: CreateWhatIfForecastCommandOutput) => void ): void; - public createWhatIfForecast( + createWhatIfForecast( args: CreateWhatIfForecastCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWhatIfForecastCommandOutput) => void ): void; - public createWhatIfForecast( - args: CreateWhatIfForecastCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWhatIfForecastCommandOutput) => void), - cb?: (err: any, data?: CreateWhatIfForecastCommandOutput) => void - ): Promise | void { - const command = new CreateWhatIfForecastCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Exports a forecast created by the CreateWhatIfForecast operation to your - * Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:

- *

- * __ - *

- *

The component is in Java SimpleDateFormat - * (yyyy-MM-ddTHH-mm-ssZ).

- *

You must specify a DataDestination object that includes an Identity and Access Management - * (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see - * aws-forecast-iam-roles.

- *

For more information, see howitworks-forecast.

- *

To get a list of all your what-if forecast export jobs, use the ListWhatIfForecastExports - * operation.

- * - *

The Status of the forecast export job must be ACTIVE before - * you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeWhatIfForecastExport operation.

- *
+ * @see {@link CreateWhatIfForecastExportCommand} */ - public createWhatIfForecastExport( + createWhatIfForecastExport( args: CreateWhatIfForecastExportCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWhatIfForecastExport( + createWhatIfForecastExport( args: CreateWhatIfForecastExportCommandInput, cb: (err: any, data?: CreateWhatIfForecastExportCommandOutput) => void ): void; - public createWhatIfForecastExport( + createWhatIfForecastExport( args: CreateWhatIfForecastExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWhatIfForecastExportCommandOutput) => void ): void; - public createWhatIfForecastExport( - args: CreateWhatIfForecastExportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWhatIfForecastExportCommandOutput) => void), - cb?: (err: any, data?: CreateWhatIfForecastExportCommandOutput) => void - ): Promise | void { - const command = new CreateWhatIfForecastExportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can - * only delete datasets that have a status of ACTIVE or CREATE_FAILED. - * To get the status use the DescribeDataset operation.

- * - *

Forecast does not automatically update any dataset groups that contain the deleted dataset. - * In order to update the dataset group, use the UpdateDatasetGroup operation, - * omitting the deleted dataset's ARN.

- *
+ * @see {@link DeleteDatasetCommand} */ - public deleteDataset( - args: DeleteDatasetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDataset( - args: DeleteDatasetCommandInput, - cb: (err: any, data?: DeleteDatasetCommandOutput) => void - ): void; - public deleteDataset( + deleteDataset(args: DeleteDatasetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDataset(args: DeleteDatasetCommandInput, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void; + deleteDataset( args: DeleteDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetCommandOutput) => void ): void; - public deleteDataset( - args: DeleteDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDatasetCommandOutput) => void), - cb?: (err: any, data?: DeleteDatasetCommandOutput) => void - ): Promise | void { - const command = new DeleteDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a dataset group created using the CreateDatasetGroup operation. - * You can only delete dataset groups that have a status of ACTIVE, - * CREATE_FAILED, or UPDATE_FAILED. To get the status, use the DescribeDatasetGroup operation.

- *

This operation deletes only the dataset group, not the datasets in the group.

+ * @see {@link DeleteDatasetGroupCommand} */ - public deleteDatasetGroup( + deleteDatasetGroup( args: DeleteDatasetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDatasetGroup( + deleteDatasetGroup( args: DeleteDatasetGroupCommandInput, cb: (err: any, data?: DeleteDatasetGroupCommandOutput) => void ): void; - public deleteDatasetGroup( + deleteDatasetGroup( args: DeleteDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetGroupCommandOutput) => void ): void; - public deleteDatasetGroup( - args: DeleteDatasetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDatasetGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteDatasetGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteDatasetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a dataset import job created using the CreateDatasetImportJob - * operation. You can delete only dataset import jobs that have a status of ACTIVE - * or CREATE_FAILED. To get the status, use the DescribeDatasetImportJob - * operation.

+ * @see {@link DeleteDatasetImportJobCommand} */ - public deleteDatasetImportJob( + deleteDatasetImportJob( args: DeleteDatasetImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDatasetImportJob( + deleteDatasetImportJob( args: DeleteDatasetImportJobCommandInput, cb: (err: any, data?: DeleteDatasetImportJobCommandOutput) => void ): void; - public deleteDatasetImportJob( + deleteDatasetImportJob( args: DeleteDatasetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetImportJobCommandOutput) => void ): void; - public deleteDatasetImportJob( - args: DeleteDatasetImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDatasetImportJobCommandOutput) => void), - cb?: (err: any, data?: DeleteDatasetImportJobCommandOutput) => void - ): Promise | void { - const command = new DeleteDatasetImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Explainability resource.

- *

You can delete only predictor that have a status of ACTIVE or - * CREATE_FAILED. To get the status, use the DescribeExplainability operation.

+ * @see {@link DeleteExplainabilityCommand} */ - public deleteExplainability( + deleteExplainability( args: DeleteExplainabilityCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteExplainability( + deleteExplainability( args: DeleteExplainabilityCommandInput, cb: (err: any, data?: DeleteExplainabilityCommandOutput) => void ): void; - public deleteExplainability( + deleteExplainability( args: DeleteExplainabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteExplainabilityCommandOutput) => void ): void; - public deleteExplainability( - args: DeleteExplainabilityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteExplainabilityCommandOutput) => void), - cb?: (err: any, data?: DeleteExplainabilityCommandOutput) => void - ): Promise | void { - const command = new DeleteExplainabilityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Explainability export.

+ * @see {@link DeleteExplainabilityExportCommand} */ - public deleteExplainabilityExport( + deleteExplainabilityExport( args: DeleteExplainabilityExportCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteExplainabilityExport( + deleteExplainabilityExport( args: DeleteExplainabilityExportCommandInput, cb: (err: any, data?: DeleteExplainabilityExportCommandOutput) => void ): void; - public deleteExplainabilityExport( + deleteExplainabilityExport( args: DeleteExplainabilityExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteExplainabilityExportCommandOutput) => void ): void; - public deleteExplainabilityExport( - args: DeleteExplainabilityExportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteExplainabilityExportCommandOutput) => void), - cb?: (err: any, data?: DeleteExplainabilityExportCommandOutput) => void - ): Promise | void { - const command = new DeleteExplainabilityExportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a forecast created using the CreateForecast operation. You can - * delete only forecasts that have a status of ACTIVE or CREATE_FAILED. - * To get the status, use the DescribeForecast operation.

- *

You can't delete a forecast while it is being exported. After a forecast is deleted, you - * can no longer query the forecast.

+ * @see {@link DeleteForecastCommand} */ - public deleteForecast( + deleteForecast( args: DeleteForecastCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteForecast( - args: DeleteForecastCommandInput, - cb: (err: any, data?: DeleteForecastCommandOutput) => void - ): void; - public deleteForecast( + deleteForecast(args: DeleteForecastCommandInput, cb: (err: any, data?: DeleteForecastCommandOutput) => void): void; + deleteForecast( args: DeleteForecastCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteForecastCommandOutput) => void ): void; - public deleteForecast( - args: DeleteForecastCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteForecastCommandOutput) => void), - cb?: (err: any, data?: DeleteForecastCommandOutput) => void - ): Promise | void { - const command = new DeleteForecastCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a forecast export job created using the CreateForecastExportJob - * operation. You can delete only export jobs that have a status of ACTIVE or - * CREATE_FAILED. To get the status, use the DescribeForecastExportJob operation.

+ * @see {@link DeleteForecastExportJobCommand} */ - public deleteForecastExportJob( + deleteForecastExportJob( args: DeleteForecastExportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteForecastExportJob( + deleteForecastExportJob( args: DeleteForecastExportJobCommandInput, cb: (err: any, data?: DeleteForecastExportJobCommandOutput) => void ): void; - public deleteForecastExportJob( + deleteForecastExportJob( args: DeleteForecastExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteForecastExportJobCommandOutput) => void ): void; - public deleteForecastExportJob( - args: DeleteForecastExportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteForecastExportJobCommandOutput) => void), - cb?: (err: any, data?: DeleteForecastExportJobCommandOutput) => void - ): Promise | void { - const command = new DeleteForecastExportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a monitor resource. You can only delete a monitor resource with a status of ACTIVE, ACTIVE_STOPPED, CREATE_FAILED, or CREATE_STOPPED.

+ * @see {@link DeleteMonitorCommand} */ - public deleteMonitor( - args: DeleteMonitorCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteMonitor( - args: DeleteMonitorCommandInput, - cb: (err: any, data?: DeleteMonitorCommandOutput) => void - ): void; - public deleteMonitor( + deleteMonitor(args: DeleteMonitorCommandInput, options?: __HttpHandlerOptions): Promise; + deleteMonitor(args: DeleteMonitorCommandInput, cb: (err: any, data?: DeleteMonitorCommandOutput) => void): void; + deleteMonitor( args: DeleteMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMonitorCommandOutput) => void ): void; - public deleteMonitor( - args: DeleteMonitorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMonitorCommandOutput) => void), - cb?: (err: any, data?: DeleteMonitorCommandOutput) => void - ): Promise | void { - const command = new DeleteMonitorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a predictor created using the DescribePredictor or CreatePredictor operations. You can delete only predictor that have a status of - * ACTIVE or CREATE_FAILED. To get the status, use the DescribePredictor operation.

+ * @see {@link DeletePredictorCommand} */ - public deletePredictor( + deletePredictor( args: DeletePredictorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePredictor( - args: DeletePredictorCommandInput, - cb: (err: any, data?: DeletePredictorCommandOutput) => void - ): void; - public deletePredictor( + deletePredictor(args: DeletePredictorCommandInput, cb: (err: any, data?: DeletePredictorCommandOutput) => void): void; + deletePredictor( args: DeletePredictorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePredictorCommandOutput) => void ): void; - public deletePredictor( - args: DeletePredictorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePredictorCommandOutput) => void), - cb?: (err: any, data?: DeletePredictorCommandOutput) => void - ): Promise | void { - const command = new DeletePredictorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a predictor backtest export job.

+ * @see {@link DeletePredictorBacktestExportJobCommand} */ - public deletePredictorBacktestExportJob( + deletePredictorBacktestExportJob( args: DeletePredictorBacktestExportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePredictorBacktestExportJob( + deletePredictorBacktestExportJob( args: DeletePredictorBacktestExportJobCommandInput, cb: (err: any, data?: DeletePredictorBacktestExportJobCommandOutput) => void ): void; - public deletePredictorBacktestExportJob( + deletePredictorBacktestExportJob( args: DeletePredictorBacktestExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePredictorBacktestExportJobCommandOutput) => void ): void; - public deletePredictorBacktestExportJob( - args: DeletePredictorBacktestExportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePredictorBacktestExportJobCommandOutput) => void), - cb?: (err: any, data?: DeletePredictorBacktestExportJobCommandOutput) => void - ): Promise | void { - const command = new DeletePredictorBacktestExportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an entire resource tree. This operation will delete the parent resource and - * its child resources.

- *

Child resources are resources that were created from another resource. For example, - * when a forecast is generated from a predictor, the forecast is the child resource and - * the predictor is the parent resource.

- *

Amazon Forecast resources possess the following parent-child resource hierarchies:

- *
    - *
  • - *

    - * Dataset: dataset import jobs

    - *
  • - *
  • - *

    - * Dataset Group: predictors, predictor backtest - * export jobs, forecasts, forecast export jobs

    - *
  • - *
  • - *

    - * Predictor: predictor backtest export jobs, - * forecasts, forecast export jobs

    - *
  • - *
  • - *

    - * Forecast: forecast export jobs

    - *
  • - *
- * - *

- * DeleteResourceTree will only delete Amazon Forecast resources, and will not - * delete datasets or exported files stored in Amazon S3.

- *
+ * @see {@link DeleteResourceTreeCommand} */ - public deleteResourceTree( + deleteResourceTree( args: DeleteResourceTreeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourceTree( + deleteResourceTree( args: DeleteResourceTreeCommandInput, cb: (err: any, data?: DeleteResourceTreeCommandOutput) => void ): void; - public deleteResourceTree( + deleteResourceTree( args: DeleteResourceTreeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourceTreeCommandOutput) => void ): void; - public deleteResourceTree( - args: DeleteResourceTreeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourceTreeCommandOutput) => void), - cb?: (err: any, data?: DeleteResourceTreeCommandOutput) => void - ): Promise | void { - const command = new DeleteResourceTreeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a what-if analysis created using the CreateWhatIfAnalysis - * operation. You can delete only what-if analyses that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeWhatIfAnalysis operation.

- *

You can't delete a what-if analysis while any of its forecasts are being exported.

+ * @see {@link DeleteWhatIfAnalysisCommand} */ - public deleteWhatIfAnalysis( + deleteWhatIfAnalysis( args: DeleteWhatIfAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWhatIfAnalysis( + deleteWhatIfAnalysis( args: DeleteWhatIfAnalysisCommandInput, cb: (err: any, data?: DeleteWhatIfAnalysisCommandOutput) => void ): void; - public deleteWhatIfAnalysis( + deleteWhatIfAnalysis( args: DeleteWhatIfAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWhatIfAnalysisCommandOutput) => void ): void; - public deleteWhatIfAnalysis( - args: DeleteWhatIfAnalysisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWhatIfAnalysisCommandOutput) => void), - cb?: (err: any, data?: DeleteWhatIfAnalysisCommandOutput) => void - ): Promise | void { - const command = new DeleteWhatIfAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a what-if forecast created using the CreateWhatIfForecast - * operation. You can delete only what-if forecasts that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeWhatIfForecast operation.

- *

You can't delete a what-if forecast while it is being exported. After a what-if forecast is deleted, you can no longer query the what-if analysis.

+ * @see {@link DeleteWhatIfForecastCommand} */ - public deleteWhatIfForecast( + deleteWhatIfForecast( args: DeleteWhatIfForecastCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWhatIfForecast( + deleteWhatIfForecast( args: DeleteWhatIfForecastCommandInput, cb: (err: any, data?: DeleteWhatIfForecastCommandOutput) => void ): void; - public deleteWhatIfForecast( + deleteWhatIfForecast( args: DeleteWhatIfForecastCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWhatIfForecastCommandOutput) => void ): void; - public deleteWhatIfForecast( - args: DeleteWhatIfForecastCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWhatIfForecastCommandOutput) => void), - cb?: (err: any, data?: DeleteWhatIfForecastCommandOutput) => void - ): Promise | void { - const command = new DeleteWhatIfForecastCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a what-if forecast export created using the CreateWhatIfForecastExport - * operation. You can delete only what-if forecast exports that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeWhatIfForecastExport operation.

+ * @see {@link DeleteWhatIfForecastExportCommand} */ - public deleteWhatIfForecastExport( + deleteWhatIfForecastExport( args: DeleteWhatIfForecastExportCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWhatIfForecastExport( + deleteWhatIfForecastExport( args: DeleteWhatIfForecastExportCommandInput, cb: (err: any, data?: DeleteWhatIfForecastExportCommandOutput) => void ): void; - public deleteWhatIfForecastExport( + deleteWhatIfForecastExport( args: DeleteWhatIfForecastExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWhatIfForecastExportCommandOutput) => void ): void; - public deleteWhatIfForecastExport( - args: DeleteWhatIfForecastExportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWhatIfForecastExportCommandOutput) => void), - cb?: (err: any, data?: DeleteWhatIfForecastExportCommandOutput) => void - ): Promise | void { - const command = new DeleteWhatIfForecastExportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a predictor created using the CreateAutoPredictor operation.

+ * @see {@link DescribeAutoPredictorCommand} */ - public describeAutoPredictor( + describeAutoPredictor( args: DescribeAutoPredictorCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAutoPredictor( + describeAutoPredictor( args: DescribeAutoPredictorCommandInput, cb: (err: any, data?: DescribeAutoPredictorCommandOutput) => void ): void; - public describeAutoPredictor( + describeAutoPredictor( args: DescribeAutoPredictorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAutoPredictorCommandOutput) => void ): void; - public describeAutoPredictor( - args: DescribeAutoPredictorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAutoPredictorCommandOutput) => void), - cb?: (err: any, data?: DescribeAutoPredictorCommandOutput) => void - ): Promise | void { - const command = new DescribeAutoPredictorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an Amazon Forecast dataset created using the CreateDataset operation.

- *

In addition to listing the parameters specified in the CreateDataset request, - * this operation includes the following dataset properties:

- *
    - *
  • - *

    - * CreationTime - *

    - *
  • - *
  • - *

    - * LastModificationTime - *

    - *
  • - *
  • - *

    - * Status - *

    - *
  • - *
+ * @see {@link DescribeDatasetCommand} */ - public describeDataset( + describeDataset( args: DescribeDatasetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDataset( - args: DescribeDatasetCommandInput, - cb: (err: any, data?: DescribeDatasetCommandOutput) => void - ): void; - public describeDataset( + describeDataset(args: DescribeDatasetCommandInput, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void; + describeDataset( args: DescribeDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetCommandOutput) => void ): void; - public describeDataset( - args: DescribeDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDatasetCommandOutput) => void), - cb?: (err: any, data?: DescribeDatasetCommandOutput) => void - ): Promise | void { - const command = new DescribeDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a dataset group created using the CreateDatasetGroup - * operation.

- *

In addition to listing the parameters provided in the CreateDatasetGroup - * request, this operation includes the following properties:

- *
    - *
  • - *

    - * DatasetArns - The datasets belonging to the group.

    - *
  • - *
  • - *

    - * CreationTime - *

    - *
  • - *
  • - *

    - * LastModificationTime - *

    - *
  • - *
  • - *

    - * Status - *

    - *
  • - *
+ * @see {@link DescribeDatasetGroupCommand} */ - public describeDatasetGroup( + describeDatasetGroup( args: DescribeDatasetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDatasetGroup( + describeDatasetGroup( args: DescribeDatasetGroupCommandInput, cb: (err: any, data?: DescribeDatasetGroupCommandOutput) => void ): void; - public describeDatasetGroup( + describeDatasetGroup( args: DescribeDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetGroupCommandOutput) => void ): void; - public describeDatasetGroup( - args: DescribeDatasetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDatasetGroupCommandOutput) => void), - cb?: (err: any, data?: DescribeDatasetGroupCommandOutput) => void - ): Promise | void { - const command = new DescribeDatasetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a dataset import job created using the CreateDatasetImportJob - * operation.

- *

In addition to listing the parameters provided in the CreateDatasetImportJob - * request, this operation includes the following properties:

- *
    - *
  • - *

    - * CreationTime - *

    - *
  • - *
  • - *

    - * LastModificationTime - *

    - *
  • - *
  • - *

    - * DataSize - *

    - *
  • - *
  • - *

    - * FieldStatistics - *

    - *
  • - *
  • - *

    - * Status - *

    - *
  • - *
  • - *

    - * Message - If an error occurred, information about the error.

    - *
  • - *
+ * @see {@link DescribeDatasetImportJobCommand} */ - public describeDatasetImportJob( + describeDatasetImportJob( args: DescribeDatasetImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDatasetImportJob( + describeDatasetImportJob( args: DescribeDatasetImportJobCommandInput, cb: (err: any, data?: DescribeDatasetImportJobCommandOutput) => void ): void; - public describeDatasetImportJob( + describeDatasetImportJob( args: DescribeDatasetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetImportJobCommandOutput) => void ): void; - public describeDatasetImportJob( - args: DescribeDatasetImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDatasetImportJobCommandOutput) => void), - cb?: (err: any, data?: DescribeDatasetImportJobCommandOutput) => void - ): Promise | void { - const command = new DescribeDatasetImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an Explainability resource created using the CreateExplainability operation.

+ * @see {@link DescribeExplainabilityCommand} */ - public describeExplainability( + describeExplainability( args: DescribeExplainabilityCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeExplainability( + describeExplainability( args: DescribeExplainabilityCommandInput, cb: (err: any, data?: DescribeExplainabilityCommandOutput) => void ): void; - public describeExplainability( + describeExplainability( args: DescribeExplainabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExplainabilityCommandOutput) => void ): void; - public describeExplainability( - args: DescribeExplainabilityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeExplainabilityCommandOutput) => void), - cb?: (err: any, data?: DescribeExplainabilityCommandOutput) => void - ): Promise | void { - const command = new DescribeExplainabilityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an Explainability export created using the CreateExplainabilityExport operation.

+ * @see {@link DescribeExplainabilityExportCommand} */ - public describeExplainabilityExport( + describeExplainabilityExport( args: DescribeExplainabilityExportCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeExplainabilityExport( + describeExplainabilityExport( args: DescribeExplainabilityExportCommandInput, cb: (err: any, data?: DescribeExplainabilityExportCommandOutput) => void ): void; - public describeExplainabilityExport( + describeExplainabilityExport( args: DescribeExplainabilityExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExplainabilityExportCommandOutput) => void ): void; - public describeExplainabilityExport( - args: DescribeExplainabilityExportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeExplainabilityExportCommandOutput) => void), - cb?: (err: any, data?: DescribeExplainabilityExportCommandOutput) => void - ): Promise | void { - const command = new DescribeExplainabilityExportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a forecast created using the CreateForecast operation.

- *

In addition to listing the properties provided in the CreateForecast request, - * this operation lists the following properties:

- *
    - *
  • - *

    - * DatasetGroupArn - The dataset group that provided the training - * data.

    - *
  • - *
  • - *

    - * CreationTime - *

    - *
  • - *
  • - *

    - * LastModificationTime - *

    - *
  • - *
  • - *

    - * Status - *

    - *
  • - *
  • - *

    - * Message - If an error occurred, information about the error.

    - *
  • - *
+ * @see {@link DescribeForecastCommand} */ - public describeForecast( + describeForecast( args: DescribeForecastCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeForecast( + describeForecast( args: DescribeForecastCommandInput, cb: (err: any, data?: DescribeForecastCommandOutput) => void ): void; - public describeForecast( + describeForecast( args: DescribeForecastCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeForecastCommandOutput) => void ): void; - public describeForecast( - args: DescribeForecastCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeForecastCommandOutput) => void), - cb?: (err: any, data?: DescribeForecastCommandOutput) => void - ): Promise | void { - const command = new DescribeForecastCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a forecast export job created using the CreateForecastExportJob operation.

- *

In addition to listing the properties provided by the user in the - * CreateForecastExportJob request, this operation lists the following - * properties:

- *
    - *
  • - *

    - * CreationTime - *

    - *
  • - *
  • - *

    - * LastModificationTime - *

    - *
  • - *
  • - *

    - * Status - *

    - *
  • - *
  • - *

    - * Message - If an error occurred, information about the error.

    - *
  • - *
+ * @see {@link DescribeForecastExportJobCommand} */ - public describeForecastExportJob( + describeForecastExportJob( args: DescribeForecastExportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeForecastExportJob( + describeForecastExportJob( args: DescribeForecastExportJobCommandInput, cb: (err: any, data?: DescribeForecastExportJobCommandOutput) => void ): void; - public describeForecastExportJob( + describeForecastExportJob( args: DescribeForecastExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeForecastExportJobCommandOutput) => void ): void; - public describeForecastExportJob( - args: DescribeForecastExportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeForecastExportJobCommandOutput) => void), - cb?: (err: any, data?: DescribeForecastExportJobCommandOutput) => void - ): Promise | void { - const command = new DescribeForecastExportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a monitor resource. In addition to listing the properties provided in the CreateMonitor request, this operation lists the following properties:

- *
    - *
  • - *

    - * Baseline - *

    - *
  • - *
  • - *

    - * CreationTime - *

    - *
  • - *
  • - *

    - * LastEvaluationTime - *

    - *
  • - *
  • - *

    - * LastEvaluationState - *

    - *
  • - *
  • - *

    - * LastModificationTime - *

    - *
  • - *
  • - *

    - * Message - *

    - *
  • - *
  • - *

    - * Status - *

    - *
  • - *
+ * @see {@link DescribeMonitorCommand} */ - public describeMonitor( + describeMonitor( args: DescribeMonitorCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMonitor( - args: DescribeMonitorCommandInput, - cb: (err: any, data?: DescribeMonitorCommandOutput) => void - ): void; - public describeMonitor( + describeMonitor(args: DescribeMonitorCommandInput, cb: (err: any, data?: DescribeMonitorCommandOutput) => void): void; + describeMonitor( args: DescribeMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMonitorCommandOutput) => void ): void; - public describeMonitor( - args: DescribeMonitorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMonitorCommandOutput) => void), - cb?: (err: any, data?: DescribeMonitorCommandOutput) => void - ): Promise | void { - const command = new DescribeMonitorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This operation is only valid for legacy predictors created with CreatePredictor. If you - * are not using a legacy predictor, use DescribeAutoPredictor.

- *
- *

Describes a predictor created using the CreatePredictor - * operation.

- *

In addition to listing the properties provided in the CreatePredictor - * request, this operation lists the following properties:

- *
    - *
  • - *

    - * DatasetImportJobArns - The dataset import jobs used to import training - * data.

    - *
  • - *
  • - *

    - * AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were - * evaluated.

    - *
  • - *
  • - *

    - * CreationTime - *

    - *
  • - *
  • - *

    - * LastModificationTime - *

    - *
  • - *
  • - *

    - * Status - *

    - *
  • - *
  • - *

    - * Message - If an error occurred, information about the error.

    - *
  • - *
+ * @see {@link DescribePredictorCommand} */ - public describePredictor( + describePredictor( args: DescribePredictorCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePredictor( + describePredictor( args: DescribePredictorCommandInput, cb: (err: any, data?: DescribePredictorCommandOutput) => void ): void; - public describePredictor( + describePredictor( args: DescribePredictorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePredictorCommandOutput) => void ): void; - public describePredictor( - args: DescribePredictorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePredictorCommandOutput) => void), - cb?: (err: any, data?: DescribePredictorCommandOutput) => void - ): Promise | void { - const command = new DescribePredictorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.

- *

In addition to listing the properties provided by the user in the - * CreatePredictorBacktestExportJob request, this operation lists the - * following properties:

- *
    - *
  • - *

    - * CreationTime - *

    - *
  • - *
  • - *

    - * LastModificationTime - *

    - *
  • - *
  • - *

    - * Status - *

    - *
  • - *
  • - *

    - * Message (if an error occurred)

    - *
  • - *
+ * @see {@link DescribePredictorBacktestExportJobCommand} */ - public describePredictorBacktestExportJob( + describePredictorBacktestExportJob( args: DescribePredictorBacktestExportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePredictorBacktestExportJob( + describePredictorBacktestExportJob( args: DescribePredictorBacktestExportJobCommandInput, cb: (err: any, data?: DescribePredictorBacktestExportJobCommandOutput) => void ): void; - public describePredictorBacktestExportJob( + describePredictorBacktestExportJob( args: DescribePredictorBacktestExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePredictorBacktestExportJobCommandOutput) => void ): void; - public describePredictorBacktestExportJob( - args: DescribePredictorBacktestExportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePredictorBacktestExportJobCommandOutput) => void), - cb?: (err: any, data?: DescribePredictorBacktestExportJobCommandOutput) => void - ): Promise | void { - const command = new DescribePredictorBacktestExportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the what-if analysis created using the CreateWhatIfAnalysis operation.

- *

In addition to listing the properties provided in the CreateWhatIfAnalysis request, this operation lists the following properties:

- *
    - *
  • - *

    - * CreationTime - *

    - *
  • - *
  • - *

    - * LastModificationTime - *

    - *
  • - *
  • - *

    - * Message - If an error occurred, information about the error.

    - *
  • - *
  • - *

    - * Status - *

    - *
  • - *
+ * @see {@link DescribeWhatIfAnalysisCommand} */ - public describeWhatIfAnalysis( + describeWhatIfAnalysis( args: DescribeWhatIfAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWhatIfAnalysis( + describeWhatIfAnalysis( args: DescribeWhatIfAnalysisCommandInput, cb: (err: any, data?: DescribeWhatIfAnalysisCommandOutput) => void ): void; - public describeWhatIfAnalysis( + describeWhatIfAnalysis( args: DescribeWhatIfAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWhatIfAnalysisCommandOutput) => void ): void; - public describeWhatIfAnalysis( - args: DescribeWhatIfAnalysisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWhatIfAnalysisCommandOutput) => void), - cb?: (err: any, data?: DescribeWhatIfAnalysisCommandOutput) => void - ): Promise | void { - const command = new DescribeWhatIfAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the what-if forecast created using the CreateWhatIfForecast operation.

- *

In addition to listing the properties provided in the CreateWhatIfForecast request, this operation lists the following properties:

- *
    - *
  • - *

    - * CreationTime - *

    - *
  • - *
  • - *

    - * LastModificationTime - *

    - *
  • - *
  • - *

    - * Message - If an error occurred, information about the error.

    - *
  • - *
  • - *

    - * Status - *

    - *
  • - *
+ * @see {@link DescribeWhatIfForecastCommand} */ - public describeWhatIfForecast( + describeWhatIfForecast( args: DescribeWhatIfForecastCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWhatIfForecast( + describeWhatIfForecast( args: DescribeWhatIfForecastCommandInput, cb: (err: any, data?: DescribeWhatIfForecastCommandOutput) => void ): void; - public describeWhatIfForecast( + describeWhatIfForecast( args: DescribeWhatIfForecastCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWhatIfForecastCommandOutput) => void ): void; - public describeWhatIfForecast( - args: DescribeWhatIfForecastCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWhatIfForecastCommandOutput) => void), - cb?: (err: any, data?: DescribeWhatIfForecastCommandOutput) => void - ): Promise | void { - const command = new DescribeWhatIfForecastCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the what-if forecast export created using the CreateWhatIfForecastExport operation.

- *

In addition to listing the properties provided in the CreateWhatIfForecastExport request, this operation lists the following properties:

- *
    - *
  • - *

    - * CreationTime - *

    - *
  • - *
  • - *

    - * LastModificationTime - *

    - *
  • - *
  • - *

    - * Message - If an error occurred, information about the error.

    - *
  • - *
  • - *

    - * Status - *

    - *
  • - *
+ * @see {@link DescribeWhatIfForecastExportCommand} */ - public describeWhatIfForecastExport( + describeWhatIfForecastExport( args: DescribeWhatIfForecastExportCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWhatIfForecastExport( + describeWhatIfForecastExport( args: DescribeWhatIfForecastExportCommandInput, cb: (err: any, data?: DescribeWhatIfForecastExportCommandOutput) => void ): void; - public describeWhatIfForecastExport( + describeWhatIfForecastExport( args: DescribeWhatIfForecastExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWhatIfForecastExportCommandOutput) => void ): void; - public describeWhatIfForecastExport( - args: DescribeWhatIfForecastExportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWhatIfForecastExportCommandOutput) => void), - cb?: (err: any, data?: DescribeWhatIfForecastExportCommandOutput) => void - ): Promise | void { - const command = new DescribeWhatIfForecastExportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides metrics on the accuracy of the models that were trained by the CreatePredictor operation. Use metrics to see how well the model performed and - * to decide whether to use the predictor to generate a forecast. For more information, see - * Predictor - * Metrics.

- *

This operation generates metrics for each backtest window that was evaluated. The number - * of backtest windows (NumberOfBacktestWindows) is specified using the EvaluationParameters object, which is optionally included in the - * CreatePredictor request. If NumberOfBacktestWindows isn't - * specified, the number defaults to one.

- *

The parameters of the filling method determine which items contribute to the - * metrics. If you want all items to contribute, specify zero. If you want only - * those items that have complete data in the range being evaluated to contribute, specify - * nan. For more information, see FeaturizationMethod.

- * - *

Before you can get accuracy metrics, the Status of the predictor must be - * ACTIVE, signifying that training has completed. To get the status, use the - * DescribePredictor operation.

- *
+ * @see {@link GetAccuracyMetricsCommand} */ - public getAccuracyMetrics( + getAccuracyMetrics( args: GetAccuracyMetricsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccuracyMetrics( + getAccuracyMetrics( args: GetAccuracyMetricsCommandInput, cb: (err: any, data?: GetAccuracyMetricsCommandOutput) => void ): void; - public getAccuracyMetrics( + getAccuracyMetrics( args: GetAccuracyMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccuracyMetricsCommandOutput) => void ): void; - public getAccuracyMetrics( - args: GetAccuracyMetricsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccuracyMetricsCommandOutput) => void), - cb?: (err: any, data?: GetAccuracyMetricsCommandOutput) => void - ): Promise | void { - const command = new GetAccuracyMetricsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of dataset groups created using the CreateDatasetGroup operation. - * For each dataset group, this operation returns a summary of its properties, including its - * Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the - * dataset group ARN with the DescribeDatasetGroup - * operation.

+ * @see {@link ListDatasetGroupsCommand} */ - public listDatasetGroups( + listDatasetGroups( args: ListDatasetGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDatasetGroups( + listDatasetGroups( args: ListDatasetGroupsCommandInput, cb: (err: any, data?: ListDatasetGroupsCommandOutput) => void ): void; - public listDatasetGroups( + listDatasetGroups( args: ListDatasetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetGroupsCommandOutput) => void ): void; - public listDatasetGroups( - args: ListDatasetGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatasetGroupsCommandOutput) => void), - cb?: (err: any, data?: ListDatasetGroupsCommandOutput) => void - ): Promise | void { - const command = new ListDatasetGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of dataset import jobs created using the CreateDatasetImportJob - * operation. For each import job, this operation returns a summary of its properties, including - * its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the - * ARN with the DescribeDatasetImportJob - * operation. You can filter the list by providing an array of Filter objects.

+ * @see {@link ListDatasetImportJobsCommand} */ - public listDatasetImportJobs( + listDatasetImportJobs( args: ListDatasetImportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDatasetImportJobs( + listDatasetImportJobs( args: ListDatasetImportJobsCommandInput, cb: (err: any, data?: ListDatasetImportJobsCommandOutput) => void ): void; - public listDatasetImportJobs( + listDatasetImportJobs( args: ListDatasetImportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetImportJobsCommandOutput) => void ): void; - public listDatasetImportJobs( - args: ListDatasetImportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatasetImportJobsCommandOutput) => void), - cb?: (err: any, data?: ListDatasetImportJobsCommandOutput) => void - ): Promise | void { - const command = new ListDatasetImportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of datasets created using the CreateDataset operation. For each - * dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned. - * To retrieve the complete set of properties, use the ARN with the DescribeDataset operation.

+ * @see {@link ListDatasetsCommand} */ - public listDatasets( - args: ListDatasetsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void; - public listDatasets( + listDatasets(args: ListDatasetsCommandInput, options?: __HttpHandlerOptions): Promise; + listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void; + listDatasets( args: ListDatasetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetsCommandOutput) => void ): void; - public listDatasets( - args: ListDatasetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatasetsCommandOutput) => void), - cb?: (err: any, data?: ListDatasetsCommandOutput) => void - ): Promise | void { - const command = new ListDatasetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of Explainability resources created using the CreateExplainability operation. This operation returns a summary for - * each Explainability. You can filter the list using an array of Filter - * objects.

- *

To retrieve the complete set of properties for a particular Explainability resource, - * use the ARN with the DescribeExplainability operation.

+ * @see {@link ListExplainabilitiesCommand} */ - public listExplainabilities( + listExplainabilities( args: ListExplainabilitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listExplainabilities( + listExplainabilities( args: ListExplainabilitiesCommandInput, cb: (err: any, data?: ListExplainabilitiesCommandOutput) => void ): void; - public listExplainabilities( + listExplainabilities( args: ListExplainabilitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExplainabilitiesCommandOutput) => void ): void; - public listExplainabilities( - args: ListExplainabilitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListExplainabilitiesCommandOutput) => void), - cb?: (err: any, data?: ListExplainabilitiesCommandOutput) => void - ): Promise | void { - const command = new ListExplainabilitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of Explainability exports created using the CreateExplainabilityExport operation. This operation returns a summary - * for each Explainability export. You can filter the list using an array of Filter objects.

- *

To retrieve the complete set of properties for a particular Explainability export, use - * the ARN with the DescribeExplainability operation.

+ * @see {@link ListExplainabilityExportsCommand} */ - public listExplainabilityExports( + listExplainabilityExports( args: ListExplainabilityExportsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listExplainabilityExports( + listExplainabilityExports( args: ListExplainabilityExportsCommandInput, cb: (err: any, data?: ListExplainabilityExportsCommandOutput) => void ): void; - public listExplainabilityExports( + listExplainabilityExports( args: ListExplainabilityExportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExplainabilityExportsCommandOutput) => void ): void; - public listExplainabilityExports( - args: ListExplainabilityExportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListExplainabilityExportsCommandOutput) => void), - cb?: (err: any, data?: ListExplainabilityExportsCommandOutput) => void - ): Promise | void { - const command = new ListExplainabilityExportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of forecast export jobs created using the CreateForecastExportJob operation. For each forecast export job, this operation - * returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the - * complete set of properties, use the ARN with the DescribeForecastExportJob - * operation. You can filter the list using an array of Filter objects.

+ * @see {@link ListForecastExportJobsCommand} */ - public listForecastExportJobs( + listForecastExportJobs( args: ListForecastExportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listForecastExportJobs( + listForecastExportJobs( args: ListForecastExportJobsCommandInput, cb: (err: any, data?: ListForecastExportJobsCommandOutput) => void ): void; - public listForecastExportJobs( + listForecastExportJobs( args: ListForecastExportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListForecastExportJobsCommandOutput) => void ): void; - public listForecastExportJobs( - args: ListForecastExportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListForecastExportJobsCommandOutput) => void), - cb?: (err: any, data?: ListForecastExportJobsCommandOutput) => void - ): Promise | void { - const command = new ListForecastExportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of forecasts created using the CreateForecast operation. - * For each forecast, this operation returns a summary of its properties, including its Amazon - * Resource Name (ARN). To retrieve the complete set of properties, specify the ARN with the - * DescribeForecast operation. You can filter the list using an array of - * Filter objects.

+ * @see {@link ListForecastsCommand} */ - public listForecasts( - args: ListForecastsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listForecasts( - args: ListForecastsCommandInput, - cb: (err: any, data?: ListForecastsCommandOutput) => void - ): void; - public listForecasts( + listForecasts(args: ListForecastsCommandInput, options?: __HttpHandlerOptions): Promise; + listForecasts(args: ListForecastsCommandInput, cb: (err: any, data?: ListForecastsCommandOutput) => void): void; + listForecasts( args: ListForecastsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListForecastsCommandOutput) => void ): void; - public listForecasts( - args: ListForecastsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListForecastsCommandOutput) => void), - cb?: (err: any, data?: ListForecastsCommandOutput) => void - ): Promise | void { - const command = new ListForecastsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the monitoring evaluation results and predictor events collected by - * the monitor resource during different windows of time.

- *

For information about monitoring see predictor-monitoring. For - * more information about retrieving monitoring results see Viewing Monitoring Results.

+ * @see {@link ListMonitorEvaluationsCommand} */ - public listMonitorEvaluations( + listMonitorEvaluations( args: ListMonitorEvaluationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMonitorEvaluations( + listMonitorEvaluations( args: ListMonitorEvaluationsCommandInput, cb: (err: any, data?: ListMonitorEvaluationsCommandOutput) => void ): void; - public listMonitorEvaluations( + listMonitorEvaluations( args: ListMonitorEvaluationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMonitorEvaluationsCommandOutput) => void ): void; - public listMonitorEvaluations( - args: ListMonitorEvaluationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMonitorEvaluationsCommandOutput) => void), - cb?: (err: any, data?: ListMonitorEvaluationsCommandOutput) => void - ): Promise | void { - const command = new ListMonitorEvaluationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor operation. For each monitor resource, this operation returns of a summary of its properties, including its Amazon Resource Name (ARN). You - * can retrieve a complete set of properties of a monitor resource by specify the monitor's ARN in the DescribeMonitor operation.

+ * @see {@link ListMonitorsCommand} */ - public listMonitors( - args: ListMonitorsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listMonitors(args: ListMonitorsCommandInput, cb: (err: any, data?: ListMonitorsCommandOutput) => void): void; - public listMonitors( + listMonitors(args: ListMonitorsCommandInput, options?: __HttpHandlerOptions): Promise; + listMonitors(args: ListMonitorsCommandInput, cb: (err: any, data?: ListMonitorsCommandOutput) => void): void; + listMonitors( args: ListMonitorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMonitorsCommandOutput) => void ): void; - public listMonitors( - args: ListMonitorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMonitorsCommandOutput) => void), - cb?: (err: any, data?: ListMonitorsCommandOutput) => void - ): Promise | void { - const command = new ListMonitorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation. This operation returns a - * summary for each backtest export job. You can filter the list using an array of Filter objects.

- *

To retrieve the complete set of properties for a particular backtest export job, use - * the ARN with the DescribePredictorBacktestExportJob operation.

+ * @see {@link ListPredictorBacktestExportJobsCommand} */ - public listPredictorBacktestExportJobs( + listPredictorBacktestExportJobs( args: ListPredictorBacktestExportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPredictorBacktestExportJobs( + listPredictorBacktestExportJobs( args: ListPredictorBacktestExportJobsCommandInput, cb: (err: any, data?: ListPredictorBacktestExportJobsCommandOutput) => void ): void; - public listPredictorBacktestExportJobs( + listPredictorBacktestExportJobs( args: ListPredictorBacktestExportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPredictorBacktestExportJobsCommandOutput) => void ): void; - public listPredictorBacktestExportJobs( - args: ListPredictorBacktestExportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPredictorBacktestExportJobsCommandOutput) => void), - cb?: (err: any, data?: ListPredictorBacktestExportJobsCommandOutput) => void - ): Promise | void { - const command = new ListPredictorBacktestExportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of predictors created using the CreateAutoPredictor or - * CreatePredictor operations. For each predictor, this operation returns a - * summary of its properties, including its Amazon Resource Name (ARN).

- *

You can retrieve the complete set of properties by using the ARN with the DescribeAutoPredictor and DescribePredictor operations. You - * can filter the list using an array of Filter objects.

+ * @see {@link ListPredictorsCommand} */ - public listPredictors( + listPredictors( args: ListPredictorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPredictors( - args: ListPredictorsCommandInput, - cb: (err: any, data?: ListPredictorsCommandOutput) => void - ): void; - public listPredictors( + listPredictors(args: ListPredictorsCommandInput, cb: (err: any, data?: ListPredictorsCommandOutput) => void): void; + listPredictors( args: ListPredictorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPredictorsCommandOutput) => void ): void; - public listPredictors( - args: ListPredictorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPredictorsCommandOutput) => void), - cb?: (err: any, data?: ListPredictorsCommandOutput) => void - ): Promise | void { - const command = new ListPredictorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags for an Amazon Forecast resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of what-if analyses created using the CreateWhatIfAnalysis operation. For each what-if analysis, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if analysis ARN with the DescribeWhatIfAnalysis operation.

+ * @see {@link ListWhatIfAnalysesCommand} */ - public listWhatIfAnalyses( + listWhatIfAnalyses( args: ListWhatIfAnalysesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWhatIfAnalyses( + listWhatIfAnalyses( args: ListWhatIfAnalysesCommandInput, cb: (err: any, data?: ListWhatIfAnalysesCommandOutput) => void ): void; - public listWhatIfAnalyses( + listWhatIfAnalyses( args: ListWhatIfAnalysesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWhatIfAnalysesCommandOutput) => void ): void; - public listWhatIfAnalyses( - args: ListWhatIfAnalysesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWhatIfAnalysesCommandOutput) => void), - cb?: (err: any, data?: ListWhatIfAnalysesCommandOutput) => void - ): Promise | void { - const command = new ListWhatIfAnalysesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport operation. For each what-if forecast export, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if forecast export ARN with the DescribeWhatIfForecastExport operation.

+ * @see {@link ListWhatIfForecastExportsCommand} */ - public listWhatIfForecastExports( + listWhatIfForecastExports( args: ListWhatIfForecastExportsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWhatIfForecastExports( + listWhatIfForecastExports( args: ListWhatIfForecastExportsCommandInput, cb: (err: any, data?: ListWhatIfForecastExportsCommandOutput) => void ): void; - public listWhatIfForecastExports( + listWhatIfForecastExports( args: ListWhatIfForecastExportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWhatIfForecastExportsCommandOutput) => void ): void; - public listWhatIfForecastExports( - args: ListWhatIfForecastExportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWhatIfForecastExportsCommandOutput) => void), - cb?: (err: any, data?: ListWhatIfForecastExportsCommandOutput) => void - ): Promise | void { - const command = new ListWhatIfForecastExportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of what-if forecasts created using the CreateWhatIfForecast operation. For each what-if forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if forecast ARN with the DescribeWhatIfForecast operation.

+ * @see {@link ListWhatIfForecastsCommand} */ - public listWhatIfForecasts( + listWhatIfForecasts( args: ListWhatIfForecastsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWhatIfForecasts( + listWhatIfForecasts( args: ListWhatIfForecastsCommandInput, cb: (err: any, data?: ListWhatIfForecastsCommandOutput) => void ): void; - public listWhatIfForecasts( + listWhatIfForecasts( args: ListWhatIfForecastsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWhatIfForecastsCommandOutput) => void ): void; - public listWhatIfForecasts( - args: ListWhatIfForecastsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWhatIfForecastsCommandOutput) => void), - cb?: (err: any, data?: ListWhatIfForecastsCommandOutput) => void - ): Promise | void { - const command = new ListWhatIfForecastsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Resumes a stopped monitor resource.

+ * @see {@link ResumeResourceCommand} */ - public resumeResource( + resumeResource( args: ResumeResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public resumeResource( - args: ResumeResourceCommandInput, - cb: (err: any, data?: ResumeResourceCommandOutput) => void - ): void; - public resumeResource( + resumeResource(args: ResumeResourceCommandInput, cb: (err: any, data?: ResumeResourceCommandOutput) => void): void; + resumeResource( args: ResumeResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResumeResourceCommandOutput) => void ): void; - public resumeResource( - args: ResumeResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResumeResourceCommandOutput) => void), - cb?: (err: any, data?: ResumeResourceCommandOutput) => void - ): Promise | void { - const command = new ResumeResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops a resource.

- *

The resource undergoes the following states: CREATE_STOPPING and - * CREATE_STOPPED. You cannot resume a resource once it has been - * stopped.

- *

This operation can be applied to the following resources (and their corresponding child - * resources):

- *
    - *
  • - *

    Dataset Import Job

    - *
  • - *
  • - *

    Predictor Job

    - *
  • - *
  • - *

    Forecast Job

    - *
  • - *
  • - *

    Forecast Export Job

    - *
  • - *
  • - *

    Predictor Backtest Export Job

    - *
  • - *
  • - *

    Explainability Job

    - *
  • - *
  • - *

    Explainability Export Job

    - *
  • - *
+ * @see {@link StopResourceCommand} */ - public stopResource( - args: StopResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public stopResource(args: StopResourceCommandInput, cb: (err: any, data?: StopResourceCommandOutput) => void): void; - public stopResource( + stopResource(args: StopResourceCommandInput, options?: __HttpHandlerOptions): Promise; + stopResource(args: StopResourceCommandInput, cb: (err: any, data?: StopResourceCommandOutput) => void): void; + stopResource( args: StopResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopResourceCommandOutput) => void ): void; - public stopResource( - args: StopResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopResourceCommandOutput) => void), - cb?: (err: any, data?: StopResourceCommandOutput) => void - ): Promise | void { - const command = new StopResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates the specified tags to a resource with the specified resourceArn. - * If existing tags on a resource are not specified in the request parameters, they are not - * changed. When a resource is deleted, the tags associated with that resource are also - * deleted.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified tags from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Replaces the datasets in a dataset group with the specified datasets.

- * - *

The Status of the dataset group must be ACTIVE before you can - * use the dataset group to create a predictor. Use the DescribeDatasetGroup - * operation to get the status.

- *
+ * @see {@link UpdateDatasetGroupCommand} */ - public updateDatasetGroup( + updateDatasetGroup( args: UpdateDatasetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDatasetGroup( + updateDatasetGroup( args: UpdateDatasetGroupCommandInput, cb: (err: any, data?: UpdateDatasetGroupCommandOutput) => void ): void; - public updateDatasetGroup( + updateDatasetGroup( args: UpdateDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDatasetGroupCommandOutput) => void ): void; - public updateDatasetGroup( - args: UpdateDatasetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDatasetGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateDatasetGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateDatasetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Provides APIs for creating and managing Amazon Forecast resources.

+ */ +export class Forecast extends ForecastClient implements Forecast {} +createAggregatedClient(commands, Forecast); diff --git a/clients/client-forecastquery/src/Forecastquery.ts b/clients/client-forecastquery/src/Forecastquery.ts index a3b1de3c990c..16b2a972d55e 100644 --- a/clients/client-forecastquery/src/Forecastquery.ts +++ b/clients/client-forecastquery/src/Forecastquery.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -11,87 +12,46 @@ import { QueryWhatIfForecastCommandInput, QueryWhatIfForecastCommandOutput, } from "./commands/QueryWhatIfForecastCommand"; -import { ForecastqueryClient } from "./ForecastqueryClient"; +import { ForecastqueryClient, ForecastqueryClientConfig } from "./ForecastqueryClient"; -/** - * @public - *

Provides APIs for creating and managing Amazon Forecast resources.

- */ -export class Forecastquery extends ForecastqueryClient { +const commands = { + QueryForecastCommand, + QueryWhatIfForecastCommand, +}; + +export interface Forecastquery { /** - * @public - *

Retrieves a forecast for a single item, filtered by the supplied criteria.

- *

The criteria is a key-value pair. The key is either item_id (or the - * equivalent non-timestamp, non-target field) from the TARGET_TIME_SERIES dataset, - * or one of the forecast dimensions specified as part of the FeaturizationConfig - * object.

- *

By default, QueryForecast returns the complete date range for the filtered - * forecast. You can request a specific date range.

- *

To get the full forecast, use the CreateForecastExportJob operation.

- * - *

The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was - * used to create the predictor.

- *
+ * @see {@link QueryForecastCommand} */ - public queryForecast( - args: QueryForecastCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public queryForecast( - args: QueryForecastCommandInput, - cb: (err: any, data?: QueryForecastCommandOutput) => void - ): void; - public queryForecast( + queryForecast(args: QueryForecastCommandInput, options?: __HttpHandlerOptions): Promise; + queryForecast(args: QueryForecastCommandInput, cb: (err: any, data?: QueryForecastCommandOutput) => void): void; + queryForecast( args: QueryForecastCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryForecastCommandOutput) => void ): void; - public queryForecast( - args: QueryForecastCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryForecastCommandOutput) => void), - cb?: (err: any, data?: QueryForecastCommandOutput) => void - ): Promise | void { - const command = new QueryForecastCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a what-if forecast.

+ * @see {@link QueryWhatIfForecastCommand} */ - public queryWhatIfForecast( + queryWhatIfForecast( args: QueryWhatIfForecastCommandInput, options?: __HttpHandlerOptions ): Promise; - public queryWhatIfForecast( + queryWhatIfForecast( args: QueryWhatIfForecastCommandInput, cb: (err: any, data?: QueryWhatIfForecastCommandOutput) => void ): void; - public queryWhatIfForecast( + queryWhatIfForecast( args: QueryWhatIfForecastCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryWhatIfForecastCommandOutput) => void ): void; - public queryWhatIfForecast( - args: QueryWhatIfForecastCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryWhatIfForecastCommandOutput) => void), - cb?: (err: any, data?: QueryWhatIfForecastCommandOutput) => void - ): Promise | void { - const command = new QueryWhatIfForecastCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Provides APIs for creating and managing Amazon Forecast resources.

+ */ +export class Forecastquery extends ForecastqueryClient implements Forecastquery {} +createAggregatedClient(commands, Forecastquery); diff --git a/clients/client-frauddetector/src/FraudDetector.ts b/clients/client-frauddetector/src/FraudDetector.ts index 13d596ed10ea..60bc05d96ef1 100644 --- a/clients/client-frauddetector/src/FraudDetector.ts +++ b/clients/client-frauddetector/src/FraudDetector.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -286,2407 +287,1152 @@ import { UpdateVariableCommandInput, UpdateVariableCommandOutput, } from "./commands/UpdateVariableCommand"; -import { FraudDetectorClient } from "./FraudDetectorClient"; +import { FraudDetectorClient, FraudDetectorClientConfig } from "./FraudDetectorClient"; -/** - * @public - *

This is the Amazon Fraud Detector API Reference. This guide is for developers who need - * detailed information about Amazon Fraud Detector API actions, data types, and errors. For - * more information about Amazon Fraud Detector features, see the Amazon Fraud Detector User Guide.

- *

We provide the Query API as well as AWS software development kits (SDK) for Amazon Fraud Detector in Java and Python programming languages.

- *

The Amazon Fraud Detector Query API provides HTTPS requests that use the HTTP verb GET or POST and a Query parameter Action. AWS SDK provides libraries, - * sample code, tutorials, and other resources for software developers who prefer to build applications using language-specific APIs instead of submitting a request over - * HTTP or HTTPS. These libraries provide basic functions that automatically take care of tasks such as cryptographically signing your requests, retrying requests, and - * handling error responses, so that it is easier for you to get started. For more information about the AWS SDKs, see Tools to build on AWS. - *

- */ -export class FraudDetector extends FraudDetectorClient { +const commands = { + BatchCreateVariableCommand, + BatchGetVariableCommand, + CancelBatchImportJobCommand, + CancelBatchPredictionJobCommand, + CreateBatchImportJobCommand, + CreateBatchPredictionJobCommand, + CreateDetectorVersionCommand, + CreateListCommand, + CreateModelCommand, + CreateModelVersionCommand, + CreateRuleCommand, + CreateVariableCommand, + DeleteBatchImportJobCommand, + DeleteBatchPredictionJobCommand, + DeleteDetectorCommand, + DeleteDetectorVersionCommand, + DeleteEntityTypeCommand, + DeleteEventCommand, + DeleteEventsByEventTypeCommand, + DeleteEventTypeCommand, + DeleteExternalModelCommand, + DeleteLabelCommand, + DeleteListCommand, + DeleteModelCommand, + DeleteModelVersionCommand, + DeleteOutcomeCommand, + DeleteRuleCommand, + DeleteVariableCommand, + DescribeDetectorCommand, + DescribeModelVersionsCommand, + GetBatchImportJobsCommand, + GetBatchPredictionJobsCommand, + GetDeleteEventsByEventTypeStatusCommand, + GetDetectorsCommand, + GetDetectorVersionCommand, + GetEntityTypesCommand, + GetEventCommand, + GetEventPredictionCommand, + GetEventPredictionMetadataCommand, + GetEventTypesCommand, + GetExternalModelsCommand, + GetKMSEncryptionKeyCommand, + GetLabelsCommand, + GetListElementsCommand, + GetListsMetadataCommand, + GetModelsCommand, + GetModelVersionCommand, + GetOutcomesCommand, + GetRulesCommand, + GetVariablesCommand, + ListEventPredictionsCommand, + ListTagsForResourceCommand, + PutDetectorCommand, + PutEntityTypeCommand, + PutEventTypeCommand, + PutExternalModelCommand, + PutKMSEncryptionKeyCommand, + PutLabelCommand, + PutOutcomeCommand, + SendEventCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateDetectorVersionCommand, + UpdateDetectorVersionMetadataCommand, + UpdateDetectorVersionStatusCommand, + UpdateEventLabelCommand, + UpdateListCommand, + UpdateModelCommand, + UpdateModelVersionCommand, + UpdateModelVersionStatusCommand, + UpdateRuleMetadataCommand, + UpdateRuleVersionCommand, + UpdateVariableCommand, +}; + +export interface FraudDetector { /** - * @public - *

Creates a batch of variables.

+ * @see {@link BatchCreateVariableCommand} */ - public batchCreateVariable( + batchCreateVariable( args: BatchCreateVariableCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchCreateVariable( + batchCreateVariable( args: BatchCreateVariableCommandInput, cb: (err: any, data?: BatchCreateVariableCommandOutput) => void ): void; - public batchCreateVariable( + batchCreateVariable( args: BatchCreateVariableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCreateVariableCommandOutput) => void ): void; - public batchCreateVariable( - args: BatchCreateVariableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchCreateVariableCommandOutput) => void), - cb?: (err: any, data?: BatchCreateVariableCommandOutput) => void - ): Promise | void { - const command = new BatchCreateVariableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a batch of variables.

- */ - public batchGetVariable( + + /** + * @see {@link BatchGetVariableCommand} + */ + batchGetVariable( args: BatchGetVariableCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetVariable( + batchGetVariable( args: BatchGetVariableCommandInput, cb: (err: any, data?: BatchGetVariableCommandOutput) => void ): void; - public batchGetVariable( + batchGetVariable( args: BatchGetVariableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetVariableCommandOutput) => void ): void; - public batchGetVariable( - args: BatchGetVariableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetVariableCommandOutput) => void), - cb?: (err: any, data?: BatchGetVariableCommandOutput) => void - ): Promise | void { - const command = new BatchGetVariableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels an in-progress batch import job.

- */ - public cancelBatchImportJob( + + /** + * @see {@link CancelBatchImportJobCommand} + */ + cancelBatchImportJob( args: CancelBatchImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelBatchImportJob( + cancelBatchImportJob( args: CancelBatchImportJobCommandInput, cb: (err: any, data?: CancelBatchImportJobCommandOutput) => void ): void; - public cancelBatchImportJob( + cancelBatchImportJob( args: CancelBatchImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelBatchImportJobCommandOutput) => void ): void; - public cancelBatchImportJob( - args: CancelBatchImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelBatchImportJobCommandOutput) => void), - cb?: (err: any, data?: CancelBatchImportJobCommandOutput) => void - ): Promise | void { - const command = new CancelBatchImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels the specified batch prediction job.

- */ - public cancelBatchPredictionJob( + + /** + * @see {@link CancelBatchPredictionJobCommand} + */ + cancelBatchPredictionJob( args: CancelBatchPredictionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelBatchPredictionJob( + cancelBatchPredictionJob( args: CancelBatchPredictionJobCommandInput, cb: (err: any, data?: CancelBatchPredictionJobCommandOutput) => void ): void; - public cancelBatchPredictionJob( + cancelBatchPredictionJob( args: CancelBatchPredictionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelBatchPredictionJobCommandOutput) => void ): void; - public cancelBatchPredictionJob( - args: CancelBatchPredictionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelBatchPredictionJobCommandOutput) => void), - cb?: (err: any, data?: CancelBatchPredictionJobCommandOutput) => void - ): Promise | void { - const command = new CancelBatchPredictionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a batch import job.

- */ - public createBatchImportJob( + + /** + * @see {@link CreateBatchImportJobCommand} + */ + createBatchImportJob( args: CreateBatchImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBatchImportJob( + createBatchImportJob( args: CreateBatchImportJobCommandInput, cb: (err: any, data?: CreateBatchImportJobCommandOutput) => void ): void; - public createBatchImportJob( + createBatchImportJob( args: CreateBatchImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBatchImportJobCommandOutput) => void ): void; - public createBatchImportJob( - args: CreateBatchImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBatchImportJobCommandOutput) => void), - cb?: (err: any, data?: CreateBatchImportJobCommandOutput) => void - ): Promise | void { - const command = new CreateBatchImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a batch prediction job.

- */ - public createBatchPredictionJob( + + /** + * @see {@link CreateBatchPredictionJobCommand} + */ + createBatchPredictionJob( args: CreateBatchPredictionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBatchPredictionJob( + createBatchPredictionJob( args: CreateBatchPredictionJobCommandInput, cb: (err: any, data?: CreateBatchPredictionJobCommandOutput) => void ): void; - public createBatchPredictionJob( + createBatchPredictionJob( args: CreateBatchPredictionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBatchPredictionJobCommandOutput) => void ): void; - public createBatchPredictionJob( - args: CreateBatchPredictionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBatchPredictionJobCommandOutput) => void), - cb?: (err: any, data?: CreateBatchPredictionJobCommandOutput) => void - ): Promise | void { - const command = new CreateBatchPredictionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a detector version. The detector version starts in a DRAFT status.

- */ - public createDetectorVersion( + + /** + * @see {@link CreateDetectorVersionCommand} + */ + createDetectorVersion( args: CreateDetectorVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDetectorVersion( + createDetectorVersion( args: CreateDetectorVersionCommandInput, cb: (err: any, data?: CreateDetectorVersionCommandOutput) => void ): void; - public createDetectorVersion( + createDetectorVersion( args: CreateDetectorVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDetectorVersionCommandOutput) => void ): void; - public createDetectorVersion( - args: CreateDetectorVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDetectorVersionCommandOutput) => void), - cb?: (err: any, data?: CreateDetectorVersionCommandOutput) => void - ): Promise | void { - const command = new CreateDetectorVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Creates a list. - *

- *

List is a set of input data for a variable in your event dataset. You use the input data in a rule that's associated with your detector. - * For more information, see Lists.

- */ - public createList(args: CreateListCommandInput, options?: __HttpHandlerOptions): Promise; - public createList(args: CreateListCommandInput, cb: (err: any, data?: CreateListCommandOutput) => void): void; - public createList( + + /** + * @see {@link CreateListCommand} + */ + createList(args: CreateListCommandInput, options?: __HttpHandlerOptions): Promise; + createList(args: CreateListCommandInput, cb: (err: any, data?: CreateListCommandOutput) => void): void; + createList( args: CreateListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateListCommandOutput) => void ): void; - public createList( - args: CreateListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateListCommandOutput) => void), - cb?: (err: any, data?: CreateListCommandOutput) => void - ): Promise | void { - const command = new CreateListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a model using the specified model type.

- */ - public createModel(args: CreateModelCommandInput, options?: __HttpHandlerOptions): Promise; - public createModel(args: CreateModelCommandInput, cb: (err: any, data?: CreateModelCommandOutput) => void): void; - public createModel( + + /** + * @see {@link CreateModelCommand} + */ + createModel(args: CreateModelCommandInput, options?: __HttpHandlerOptions): Promise; + createModel(args: CreateModelCommandInput, cb: (err: any, data?: CreateModelCommandOutput) => void): void; + createModel( args: CreateModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateModelCommandOutput) => void ): void; - public createModel( - args: CreateModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateModelCommandOutput) => void), - cb?: (err: any, data?: CreateModelCommandOutput) => void - ): Promise | void { - const command = new CreateModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a version of the model using the specified model type and model id. - *

- */ - public createModelVersion( + + /** + * @see {@link CreateModelVersionCommand} + */ + createModelVersion( args: CreateModelVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createModelVersion( + createModelVersion( args: CreateModelVersionCommandInput, cb: (err: any, data?: CreateModelVersionCommandOutput) => void ): void; - public createModelVersion( + createModelVersion( args: CreateModelVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateModelVersionCommandOutput) => void ): void; - public createModelVersion( - args: CreateModelVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateModelVersionCommandOutput) => void), - cb?: (err: any, data?: CreateModelVersionCommandOutput) => void - ): Promise | void { - const command = new CreateModelVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a rule for use with the specified detector.

- */ - public createRule(args: CreateRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public createRule(args: CreateRuleCommandInput, cb: (err: any, data?: CreateRuleCommandOutput) => void): void; - public createRule( + + /** + * @see {@link CreateRuleCommand} + */ + createRule(args: CreateRuleCommandInput, options?: __HttpHandlerOptions): Promise; + createRule(args: CreateRuleCommandInput, cb: (err: any, data?: CreateRuleCommandOutput) => void): void; + createRule( args: CreateRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRuleCommandOutput) => void ): void; - public createRule( - args: CreateRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRuleCommandOutput) => void), - cb?: (err: any, data?: CreateRuleCommandOutput) => void - ): Promise | void { - const command = new CreateRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a variable.

- */ - public createVariable( + + /** + * @see {@link CreateVariableCommand} + */ + createVariable( args: CreateVariableCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVariable( - args: CreateVariableCommandInput, - cb: (err: any, data?: CreateVariableCommandOutput) => void - ): void; - public createVariable( + createVariable(args: CreateVariableCommandInput, cb: (err: any, data?: CreateVariableCommandOutput) => void): void; + createVariable( args: CreateVariableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVariableCommandOutput) => void ): void; - public createVariable( - args: CreateVariableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVariableCommandOutput) => void), - cb?: (err: any, data?: CreateVariableCommandOutput) => void - ): Promise | void { - const command = new CreateVariableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified batch import job ID record. This action does not delete the data that was batch imported.

- */ - public deleteBatchImportJob( + + /** + * @see {@link DeleteBatchImportJobCommand} + */ + deleteBatchImportJob( args: DeleteBatchImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBatchImportJob( + deleteBatchImportJob( args: DeleteBatchImportJobCommandInput, cb: (err: any, data?: DeleteBatchImportJobCommandOutput) => void ): void; - public deleteBatchImportJob( + deleteBatchImportJob( args: DeleteBatchImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBatchImportJobCommandOutput) => void ): void; - public deleteBatchImportJob( - args: DeleteBatchImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBatchImportJobCommandOutput) => void), - cb?: (err: any, data?: DeleteBatchImportJobCommandOutput) => void - ): Promise | void { - const command = new DeleteBatchImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a batch prediction job.

- */ - public deleteBatchPredictionJob( + + /** + * @see {@link DeleteBatchPredictionJobCommand} + */ + deleteBatchPredictionJob( args: DeleteBatchPredictionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBatchPredictionJob( + deleteBatchPredictionJob( args: DeleteBatchPredictionJobCommandInput, cb: (err: any, data?: DeleteBatchPredictionJobCommandOutput) => void ): void; - public deleteBatchPredictionJob( + deleteBatchPredictionJob( args: DeleteBatchPredictionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBatchPredictionJobCommandOutput) => void ): void; - public deleteBatchPredictionJob( - args: DeleteBatchPredictionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBatchPredictionJobCommandOutput) => void), - cb?: (err: any, data?: DeleteBatchPredictionJobCommandOutput) => void - ): Promise | void { - const command = new DeleteBatchPredictionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the detector. Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector.

- *

When you delete a detector, Amazon Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon Fraud Detector.

- */ - public deleteDetector( + + /** + * @see {@link DeleteDetectorCommand} + */ + deleteDetector( args: DeleteDetectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDetector( - args: DeleteDetectorCommandInput, - cb: (err: any, data?: DeleteDetectorCommandOutput) => void - ): void; - public deleteDetector( + deleteDetector(args: DeleteDetectorCommandInput, cb: (err: any, data?: DeleteDetectorCommandOutput) => void): void; + deleteDetector( args: DeleteDetectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDetectorCommandOutput) => void ): void; - public deleteDetector( - args: DeleteDetectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDetectorCommandOutput) => void), - cb?: (err: any, data?: DeleteDetectorCommandOutput) => void - ): Promise | void { - const command = new DeleteDetectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the detector version. You cannot delete detector versions that are in ACTIVE status.

- *

When you delete a detector version, Amazon Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon Fraud Detector.

- */ - public deleteDetectorVersion( + + /** + * @see {@link DeleteDetectorVersionCommand} + */ + deleteDetectorVersion( args: DeleteDetectorVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDetectorVersion( + deleteDetectorVersion( args: DeleteDetectorVersionCommandInput, cb: (err: any, data?: DeleteDetectorVersionCommandOutput) => void ): void; - public deleteDetectorVersion( + deleteDetectorVersion( args: DeleteDetectorVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDetectorVersionCommandOutput) => void ): void; - public deleteDetectorVersion( - args: DeleteDetectorVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDetectorVersionCommandOutput) => void), - cb?: (err: any, data?: DeleteDetectorVersionCommandOutput) => void - ): Promise | void { - const command = new DeleteDetectorVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an entity type.

- *

You cannot delete an entity type that is included in an event type.

- *

When you delete an entity type, Amazon Fraud Detector permanently deletes that entity type and the data is no longer stored in Amazon Fraud Detector.

- */ - public deleteEntityType( + + /** + * @see {@link DeleteEntityTypeCommand} + */ + deleteEntityType( args: DeleteEntityTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEntityType( + deleteEntityType( args: DeleteEntityTypeCommandInput, cb: (err: any, data?: DeleteEntityTypeCommandOutput) => void ): void; - public deleteEntityType( + deleteEntityType( args: DeleteEntityTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEntityTypeCommandOutput) => void ): void; - public deleteEntityType( - args: DeleteEntityTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEntityTypeCommandOutput) => void), - cb?: (err: any, data?: DeleteEntityTypeCommandOutput) => void - ): Promise | void { - const command = new DeleteEntityTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified event.

- *

When you delete an event, Amazon Fraud Detector permanently deletes that event and the event data is no longer stored in Amazon Fraud Detector.

- */ - public deleteEvent(args: DeleteEventCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteEvent(args: DeleteEventCommandInput, cb: (err: any, data?: DeleteEventCommandOutput) => void): void; - public deleteEvent( + + /** + * @see {@link DeleteEventCommand} + */ + deleteEvent(args: DeleteEventCommandInput, options?: __HttpHandlerOptions): Promise; + deleteEvent(args: DeleteEventCommandInput, cb: (err: any, data?: DeleteEventCommandOutput) => void): void; + deleteEvent( args: DeleteEventCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventCommandOutput) => void ): void; - public deleteEvent( - args: DeleteEventCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEventCommandOutput) => void), - cb?: (err: any, data?: DeleteEventCommandOutput) => void - ): Promise | void { - const command = new DeleteEventCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes all events of a particular event type.

- */ - public deleteEventsByEventType( + + /** + * @see {@link DeleteEventsByEventTypeCommand} + */ + deleteEventsByEventType( args: DeleteEventsByEventTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEventsByEventType( + deleteEventsByEventType( args: DeleteEventsByEventTypeCommandInput, cb: (err: any, data?: DeleteEventsByEventTypeCommandOutput) => void ): void; - public deleteEventsByEventType( + deleteEventsByEventType( args: DeleteEventsByEventTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventsByEventTypeCommandOutput) => void ): void; - public deleteEventsByEventType( - args: DeleteEventsByEventTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEventsByEventTypeCommandOutput) => void), - cb?: (err: any, data?: DeleteEventsByEventTypeCommandOutput) => void - ): Promise | void { - const command = new DeleteEventsByEventTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an event type.

- *

You cannot delete an event type that is used in a detector or a model.

- *

When you delete an event type, Amazon Fraud Detector permanently deletes that event type and the data is no longer stored in Amazon Fraud Detector.

- */ - public deleteEventType( + + /** + * @see {@link DeleteEventTypeCommand} + */ + deleteEventType( args: DeleteEventTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEventType( - args: DeleteEventTypeCommandInput, - cb: (err: any, data?: DeleteEventTypeCommandOutput) => void - ): void; - public deleteEventType( + deleteEventType(args: DeleteEventTypeCommandInput, cb: (err: any, data?: DeleteEventTypeCommandOutput) => void): void; + deleteEventType( args: DeleteEventTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventTypeCommandOutput) => void ): void; - public deleteEventType( - args: DeleteEventTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEventTypeCommandOutput) => void), - cb?: (err: any, data?: DeleteEventTypeCommandOutput) => void - ): Promise | void { - const command = new DeleteEventTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a SageMaker model from Amazon Fraud Detector.

- *

You can remove an Amazon SageMaker model if it is not associated with a detector version. Removing a SageMaker model disconnects it from Amazon Fraud Detector, but the model remains available in SageMaker.

- */ - public deleteExternalModel( + + /** + * @see {@link DeleteExternalModelCommand} + */ + deleteExternalModel( args: DeleteExternalModelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteExternalModel( + deleteExternalModel( args: DeleteExternalModelCommandInput, cb: (err: any, data?: DeleteExternalModelCommandOutput) => void ): void; - public deleteExternalModel( + deleteExternalModel( args: DeleteExternalModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteExternalModelCommandOutput) => void ): void; - public deleteExternalModel( - args: DeleteExternalModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteExternalModelCommandOutput) => void), - cb?: (err: any, data?: DeleteExternalModelCommandOutput) => void - ): Promise | void { - const command = new DeleteExternalModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a label.

- *

You cannot delete labels that are included in an event type in Amazon Fraud Detector.

- *

You cannot delete a label assigned to an event ID. You must first delete the relevant event ID.

- *

When you delete a label, Amazon Fraud Detector permanently deletes that label and the data is no longer stored in Amazon Fraud Detector.

- */ - public deleteLabel(args: DeleteLabelCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteLabel(args: DeleteLabelCommandInput, cb: (err: any, data?: DeleteLabelCommandOutput) => void): void; - public deleteLabel( + + /** + * @see {@link DeleteLabelCommand} + */ + deleteLabel(args: DeleteLabelCommandInput, options?: __HttpHandlerOptions): Promise; + deleteLabel(args: DeleteLabelCommandInput, cb: (err: any, data?: DeleteLabelCommandOutput) => void): void; + deleteLabel( args: DeleteLabelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLabelCommandOutput) => void ): void; - public deleteLabel( - args: DeleteLabelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLabelCommandOutput) => void), - cb?: (err: any, data?: DeleteLabelCommandOutput) => void - ): Promise | void { - const command = new DeleteLabelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Deletes the list, provided it is not used in a rule. - *

- *

When you delete a list, Amazon Fraud Detector permanently deletes that list and the elements in the list.

- */ - public deleteList(args: DeleteListCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteList(args: DeleteListCommandInput, cb: (err: any, data?: DeleteListCommandOutput) => void): void; - public deleteList( + + /** + * @see {@link DeleteListCommand} + */ + deleteList(args: DeleteListCommandInput, options?: __HttpHandlerOptions): Promise; + deleteList(args: DeleteListCommandInput, cb: (err: any, data?: DeleteListCommandOutput) => void): void; + deleteList( args: DeleteListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteListCommandOutput) => void ): void; - public deleteList( - args: DeleteListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteListCommandOutput) => void), - cb?: (err: any, data?: DeleteListCommandOutput) => void - ): Promise | void { - const command = new DeleteListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a model.

- *

You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version.

- *

When you delete a model, Amazon Fraud Detector permanently deletes that model and the data is no longer stored in Amazon Fraud Detector.

- */ - public deleteModel(args: DeleteModelCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteModel(args: DeleteModelCommandInput, cb: (err: any, data?: DeleteModelCommandOutput) => void): void; - public deleteModel( + + /** + * @see {@link DeleteModelCommand} + */ + deleteModel(args: DeleteModelCommandInput, options?: __HttpHandlerOptions): Promise; + deleteModel(args: DeleteModelCommandInput, cb: (err: any, data?: DeleteModelCommandOutput) => void): void; + deleteModel( args: DeleteModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteModelCommandOutput) => void ): void; - public deleteModel( - args: DeleteModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteModelCommandOutput) => void), - cb?: (err: any, data?: DeleteModelCommandOutput) => void - ): Promise | void { - const command = new DeleteModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a model version.

- *

You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version.

- *

When you delete a model version, Amazon Fraud Detector permanently deletes that model version and the data is no longer stored in Amazon Fraud Detector.

- */ - public deleteModelVersion( + + /** + * @see {@link DeleteModelVersionCommand} + */ + deleteModelVersion( args: DeleteModelVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteModelVersion( + deleteModelVersion( args: DeleteModelVersionCommandInput, cb: (err: any, data?: DeleteModelVersionCommandOutput) => void ): void; - public deleteModelVersion( + deleteModelVersion( args: DeleteModelVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteModelVersionCommandOutput) => void ): void; - public deleteModelVersion( - args: DeleteModelVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteModelVersionCommandOutput) => void), - cb?: (err: any, data?: DeleteModelVersionCommandOutput) => void - ): Promise | void { - const command = new DeleteModelVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an outcome.

- *

You cannot delete an outcome that is used in a rule version.

- *

When you delete an outcome, Amazon Fraud Detector permanently deletes that outcome and the data is no longer stored in Amazon Fraud Detector.

- */ - public deleteOutcome( - args: DeleteOutcomeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteOutcome( - args: DeleteOutcomeCommandInput, - cb: (err: any, data?: DeleteOutcomeCommandOutput) => void - ): void; - public deleteOutcome( + + /** + * @see {@link DeleteOutcomeCommand} + */ + deleteOutcome(args: DeleteOutcomeCommandInput, options?: __HttpHandlerOptions): Promise; + deleteOutcome(args: DeleteOutcomeCommandInput, cb: (err: any, data?: DeleteOutcomeCommandOutput) => void): void; + deleteOutcome( args: DeleteOutcomeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOutcomeCommandOutput) => void ): void; - public deleteOutcome( - args: DeleteOutcomeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteOutcomeCommandOutput) => void), - cb?: (err: any, data?: DeleteOutcomeCommandOutput) => void - ): Promise | void { - const command = new DeleteOutcomeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the rule. You cannot delete a rule if it is used by an ACTIVE or INACTIVE detector version.

- *

When you delete a rule, Amazon Fraud Detector permanently deletes that rule and the data is no longer stored in Amazon Fraud Detector.

- */ - public deleteRule(args: DeleteRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteRule(args: DeleteRuleCommandInput, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void; - public deleteRule( + + /** + * @see {@link DeleteRuleCommand} + */ + deleteRule(args: DeleteRuleCommandInput, options?: __HttpHandlerOptions): Promise; + deleteRule(args: DeleteRuleCommandInput, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void; + deleteRule( args: DeleteRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRuleCommandOutput) => void ): void; - public deleteRule( - args: DeleteRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a variable.

- *

You can't delete variables that are included in an event type in Amazon Fraud Detector.

- *

Amazon Fraud Detector automatically deletes model output variables and SageMaker model output variables when you delete the model. You can't delete these variables manually.

- *

When you delete a variable, Amazon Fraud Detector permanently deletes that variable and the data is no longer stored in Amazon Fraud Detector.

- */ - public deleteVariable( + + /** + * @see {@link DeleteVariableCommand} + */ + deleteVariable( args: DeleteVariableCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVariable( - args: DeleteVariableCommandInput, - cb: (err: any, data?: DeleteVariableCommandOutput) => void - ): void; - public deleteVariable( + deleteVariable(args: DeleteVariableCommandInput, cb: (err: any, data?: DeleteVariableCommandOutput) => void): void; + deleteVariable( args: DeleteVariableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVariableCommandOutput) => void ): void; - public deleteVariable( - args: DeleteVariableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVariableCommandOutput) => void), - cb?: (err: any, data?: DeleteVariableCommandOutput) => void - ): Promise | void { - const command = new DeleteVariableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets all versions for a specified detector.

- */ - public describeDetector( + + /** + * @see {@link DescribeDetectorCommand} + */ + describeDetector( args: DescribeDetectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDetector( + describeDetector( args: DescribeDetectorCommandInput, cb: (err: any, data?: DescribeDetectorCommandOutput) => void ): void; - public describeDetector( + describeDetector( args: DescribeDetectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDetectorCommandOutput) => void ): void; - public describeDetector( - args: DescribeDetectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDetectorCommandOutput) => void), - cb?: (err: any, data?: DescribeDetectorCommandOutput) => void - ): Promise | void { - const command = new DescribeDetectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets all of the model versions for the specified model type or for the specified model type and model ID. You can also get details for a single, specified model version.

- */ - public describeModelVersions( + + /** + * @see {@link DescribeModelVersionsCommand} + */ + describeModelVersions( args: DescribeModelVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeModelVersions( + describeModelVersions( args: DescribeModelVersionsCommandInput, cb: (err: any, data?: DescribeModelVersionsCommandOutput) => void ): void; - public describeModelVersions( + describeModelVersions( args: DescribeModelVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeModelVersionsCommandOutput) => void ): void; - public describeModelVersions( - args: DescribeModelVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeModelVersionsCommandOutput) => void), - cb?: (err: any, data?: DescribeModelVersionsCommandOutput) => void - ): Promise | void { - const command = new DescribeModelVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets all batch import jobs or a specific job of the specified ID. This is a paginated API. If you provide a null maxResults, - * this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 1 and 50. - * To get the next page results, provide the pagination token from the GetBatchImportJobsResponse as part of your request. - * A null pagination token fetches the records from the beginning.

- */ - public getBatchImportJobs( + + /** + * @see {@link GetBatchImportJobsCommand} + */ + getBatchImportJobs( args: GetBatchImportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBatchImportJobs( + getBatchImportJobs( args: GetBatchImportJobsCommandInput, cb: (err: any, data?: GetBatchImportJobsCommandOutput) => void ): void; - public getBatchImportJobs( + getBatchImportJobs( args: GetBatchImportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBatchImportJobsCommandOutput) => void ): void; - public getBatchImportJobs( - args: GetBatchImportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBatchImportJobsCommandOutput) => void), - cb?: (err: any, data?: GetBatchImportJobsCommandOutput) => void - ): Promise | void { - const command = new GetBatchImportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets all batch prediction jobs or a specific job if you specify a job ID. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 1 and 50. To get the next page results, provide the pagination token from the GetBatchPredictionJobsResponse as part of your request. A null pagination token fetches the records from the beginning.

- */ - public getBatchPredictionJobs( + + /** + * @see {@link GetBatchPredictionJobsCommand} + */ + getBatchPredictionJobs( args: GetBatchPredictionJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBatchPredictionJobs( + getBatchPredictionJobs( args: GetBatchPredictionJobsCommandInput, cb: (err: any, data?: GetBatchPredictionJobsCommandOutput) => void ): void; - public getBatchPredictionJobs( + getBatchPredictionJobs( args: GetBatchPredictionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBatchPredictionJobsCommandOutput) => void ): void; - public getBatchPredictionJobs( - args: GetBatchPredictionJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBatchPredictionJobsCommandOutput) => void), - cb?: (err: any, data?: GetBatchPredictionJobsCommandOutput) => void - ): Promise | void { - const command = new GetBatchPredictionJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the status of a DeleteEventsByEventType action.

- */ - public getDeleteEventsByEventTypeStatus( + + /** + * @see {@link GetDeleteEventsByEventTypeStatusCommand} + */ + getDeleteEventsByEventTypeStatus( args: GetDeleteEventsByEventTypeStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDeleteEventsByEventTypeStatus( + getDeleteEventsByEventTypeStatus( args: GetDeleteEventsByEventTypeStatusCommandInput, cb: (err: any, data?: GetDeleteEventsByEventTypeStatusCommandOutput) => void ): void; - public getDeleteEventsByEventTypeStatus( + getDeleteEventsByEventTypeStatus( args: GetDeleteEventsByEventTypeStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeleteEventsByEventTypeStatusCommandOutput) => void ): void; - public getDeleteEventsByEventTypeStatus( - args: GetDeleteEventsByEventTypeStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeleteEventsByEventTypeStatusCommandOutput) => void), - cb?: (err: any, data?: GetDeleteEventsByEventTypeStatusCommandOutput) => void - ): Promise | void { - const command = new GetDeleteEventsByEventTypeStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets all detectors or a single detector if a detectorId is specified. This is a paginated API. If you - * provide a null maxResults, this action retrieves a maximum of 10 records - * per page. If you provide a maxResults, the value must be between 5 and 10. - * To get the next page results, provide the pagination token from the - * GetDetectorsResponse as part of your request. A null pagination token - * fetches the records from the beginning.

- */ - public getDetectors( - args: GetDetectorsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getDetectors(args: GetDetectorsCommandInput, cb: (err: any, data?: GetDetectorsCommandOutput) => void): void; - public getDetectors( + + /** + * @see {@link GetDetectorsCommand} + */ + getDetectors(args: GetDetectorsCommandInput, options?: __HttpHandlerOptions): Promise; + getDetectors(args: GetDetectorsCommandInput, cb: (err: any, data?: GetDetectorsCommandOutput) => void): void; + getDetectors( args: GetDetectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDetectorsCommandOutput) => void ): void; - public getDetectors( - args: GetDetectorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDetectorsCommandOutput) => void), - cb?: (err: any, data?: GetDetectorsCommandOutput) => void - ): Promise | void { - const command = new GetDetectorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a particular detector version.

- */ - public getDetectorVersion( + + /** + * @see {@link GetDetectorVersionCommand} + */ + getDetectorVersion( args: GetDetectorVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDetectorVersion( + getDetectorVersion( args: GetDetectorVersionCommandInput, cb: (err: any, data?: GetDetectorVersionCommandOutput) => void ): void; - public getDetectorVersion( + getDetectorVersion( args: GetDetectorVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDetectorVersionCommandOutput) => void ): void; - public getDetectorVersion( - args: GetDetectorVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDetectorVersionCommandOutput) => void), - cb?: (err: any, data?: GetDetectorVersionCommandOutput) => void - ): Promise | void { - const command = new GetDetectorVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets all entity types or a specific entity type if a name is specified. This is a paginated API. If you - * provide a null maxResults, this action retrieves a maximum of 10 records - * per page. If you provide a maxResults, the value must be between 5 and 10. - * To get the next page results, provide the pagination token from the - * GetEntityTypesResponse as part of your request. A null pagination token - * fetches the records from the beginning.

- */ - public getEntityTypes( + + /** + * @see {@link GetEntityTypesCommand} + */ + getEntityTypes( args: GetEntityTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEntityTypes( - args: GetEntityTypesCommandInput, - cb: (err: any, data?: GetEntityTypesCommandOutput) => void - ): void; - public getEntityTypes( + getEntityTypes(args: GetEntityTypesCommandInput, cb: (err: any, data?: GetEntityTypesCommandOutput) => void): void; + getEntityTypes( args: GetEntityTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEntityTypesCommandOutput) => void ): void; - public getEntityTypes( - args: GetEntityTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEntityTypesCommandOutput) => void), - cb?: (err: any, data?: GetEntityTypesCommandOutput) => void - ): Promise | void { - const command = new GetEntityTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves details of events stored with Amazon Fraud Detector. This action does not retrieve prediction results.

- */ - public getEvent(args: GetEventCommandInput, options?: __HttpHandlerOptions): Promise; - public getEvent(args: GetEventCommandInput, cb: (err: any, data?: GetEventCommandOutput) => void): void; - public getEvent( + + /** + * @see {@link GetEventCommand} + */ + getEvent(args: GetEventCommandInput, options?: __HttpHandlerOptions): Promise; + getEvent(args: GetEventCommandInput, cb: (err: any, data?: GetEventCommandOutput) => void): void; + getEvent( args: GetEventCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEventCommandOutput) => void ): void; - public getEvent( - args: GetEventCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEventCommandOutput) => void), - cb?: (err: any, data?: GetEventCommandOutput) => void - ): Promise | void { - const command = new GetEventCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Evaluates an event against a detector version. If a version ID is not provided, the detector’s (ACTIVE) version is used.

- */ - public getEventPrediction( + + /** + * @see {@link GetEventPredictionCommand} + */ + getEventPrediction( args: GetEventPredictionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEventPrediction( + getEventPrediction( args: GetEventPredictionCommandInput, cb: (err: any, data?: GetEventPredictionCommandOutput) => void ): void; - public getEventPrediction( + getEventPrediction( args: GetEventPredictionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEventPredictionCommandOutput) => void ): void; - public getEventPrediction( - args: GetEventPredictionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEventPredictionCommandOutput) => void), - cb?: (err: any, data?: GetEventPredictionCommandOutput) => void - ): Promise | void { - const command = new GetEventPredictionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Gets details of the past fraud predictions for the specified event ID, event type, detector ID, and detector version ID that was generated in the specified time period. - *

- */ - public getEventPredictionMetadata( + + /** + * @see {@link GetEventPredictionMetadataCommand} + */ + getEventPredictionMetadata( args: GetEventPredictionMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEventPredictionMetadata( + getEventPredictionMetadata( args: GetEventPredictionMetadataCommandInput, cb: (err: any, data?: GetEventPredictionMetadataCommandOutput) => void ): void; - public getEventPredictionMetadata( + getEventPredictionMetadata( args: GetEventPredictionMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEventPredictionMetadataCommandOutput) => void ): void; - public getEventPredictionMetadata( - args: GetEventPredictionMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEventPredictionMetadataCommandOutput) => void), - cb?: (err: any, data?: GetEventPredictionMetadataCommandOutput) => void - ): Promise | void { - const command = new GetEventPredictionMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets all event types or a specific event type if name is provided. This is a paginated API. If you - * provide a null maxResults, this action retrieves a maximum of 10 records - * per page. If you provide a maxResults, the value must be between 5 and 10. - * To get the next page results, provide the pagination token from the - * GetEventTypesResponse as part of your request. A null pagination token - * fetches the records from the beginning.

- */ - public getEventTypes( - args: GetEventTypesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getEventTypes( - args: GetEventTypesCommandInput, - cb: (err: any, data?: GetEventTypesCommandOutput) => void - ): void; - public getEventTypes( + + /** + * @see {@link GetEventTypesCommand} + */ + getEventTypes(args: GetEventTypesCommandInput, options?: __HttpHandlerOptions): Promise; + getEventTypes(args: GetEventTypesCommandInput, cb: (err: any, data?: GetEventTypesCommandOutput) => void): void; + getEventTypes( args: GetEventTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEventTypesCommandOutput) => void ): void; - public getEventTypes( - args: GetEventTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEventTypesCommandOutput) => void), - cb?: (err: any, data?: GetEventTypesCommandOutput) => void - ): Promise | void { - const command = new GetEventTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the details for one or more Amazon SageMaker models that have been imported into the - * service. This is a paginated API. If you provide a null maxResults, this - * actions retrieves a maximum of 10 records per page. If you provide a - * maxResults, the value must be between 5 and 10. To get the next page - * results, provide the pagination token from the GetExternalModelsResult as part - * of your request. A null pagination token fetches the records from the beginning.

- */ - public getExternalModels( + + /** + * @see {@link GetExternalModelsCommand} + */ + getExternalModels( args: GetExternalModelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getExternalModels( + getExternalModels( args: GetExternalModelsCommandInput, cb: (err: any, data?: GetExternalModelsCommandOutput) => void ): void; - public getExternalModels( + getExternalModels( args: GetExternalModelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExternalModelsCommandOutput) => void ): void; - public getExternalModels( - args: GetExternalModelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetExternalModelsCommandOutput) => void), - cb?: (err: any, data?: GetExternalModelsCommandOutput) => void - ): Promise | void { - const command = new GetExternalModelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the encryption key if a KMS key has been specified to be used to encrypt content in Amazon Fraud Detector.

- */ - public getKMSEncryptionKey( + + /** + * @see {@link GetKMSEncryptionKeyCommand} + */ + getKMSEncryptionKey( args: GetKMSEncryptionKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getKMSEncryptionKey( + getKMSEncryptionKey( args: GetKMSEncryptionKeyCommandInput, cb: (err: any, data?: GetKMSEncryptionKeyCommandOutput) => void ): void; - public getKMSEncryptionKey( + getKMSEncryptionKey( args: GetKMSEncryptionKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetKMSEncryptionKeyCommandOutput) => void ): void; - public getKMSEncryptionKey( - args: GetKMSEncryptionKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetKMSEncryptionKeyCommandOutput) => void), - cb?: (err: any, data?: GetKMSEncryptionKeyCommandOutput) => void - ): Promise | void { - const command = new GetKMSEncryptionKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets all labels or a specific label if name is provided. This is a paginated API. If you - * provide a null maxResults, this action retrieves a maximum of 50 records - * per page. If you provide a maxResults, the value must be between 10 and 50. - * To get the next page results, provide the pagination token from the - * GetGetLabelsResponse as part of your request. A null pagination token - * fetches the records from the beginning.

- */ - public getLabels(args: GetLabelsCommandInput, options?: __HttpHandlerOptions): Promise; - public getLabels(args: GetLabelsCommandInput, cb: (err: any, data?: GetLabelsCommandOutput) => void): void; - public getLabels( + + /** + * @see {@link GetLabelsCommand} + */ + getLabels(args: GetLabelsCommandInput, options?: __HttpHandlerOptions): Promise; + getLabels(args: GetLabelsCommandInput, cb: (err: any, data?: GetLabelsCommandOutput) => void): void; + getLabels( args: GetLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLabelsCommandOutput) => void ): void; - public getLabels( - args: GetLabelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLabelsCommandOutput) => void), - cb?: (err: any, data?: GetLabelsCommandOutput) => void - ): Promise | void { - const command = new GetLabelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Gets all the elements in the specified list. - *

- */ - public getListElements( + + /** + * @see {@link GetListElementsCommand} + */ + getListElements( args: GetListElementsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getListElements( - args: GetListElementsCommandInput, - cb: (err: any, data?: GetListElementsCommandOutput) => void - ): void; - public getListElements( + getListElements(args: GetListElementsCommandInput, cb: (err: any, data?: GetListElementsCommandOutput) => void): void; + getListElements( args: GetListElementsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetListElementsCommandOutput) => void ): void; - public getListElements( - args: GetListElementsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetListElementsCommandOutput) => void), - cb?: (err: any, data?: GetListElementsCommandOutput) => void - ): Promise | void { - const command = new GetListElementsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Gets the metadata of either all the lists under the account or the specified list. - *

- */ - public getListsMetadata( + + /** + * @see {@link GetListsMetadataCommand} + */ + getListsMetadata( args: GetListsMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getListsMetadata( + getListsMetadata( args: GetListsMetadataCommandInput, cb: (err: any, data?: GetListsMetadataCommandOutput) => void ): void; - public getListsMetadata( + getListsMetadata( args: GetListsMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetListsMetadataCommandOutput) => void ): void; - public getListsMetadata( - args: GetListsMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetListsMetadataCommandOutput) => void), - cb?: (err: any, data?: GetListsMetadataCommandOutput) => void - ): Promise | void { - const command = new GetListsMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets one or more models. Gets all models for the Amazon Web Services account if no model type and no model id provided. Gets all models for the Amazon Web Services account and model type, if the model type is specified but model id is not provided. Gets a specific model if (model type, model id) tuple is specified.

- *

This is a paginated API. If you - * provide a null maxResults, this action retrieves a maximum of 10 records - * per page. If you provide a maxResults, the value must be between 1 and 10. - * To get the next page results, provide the pagination token from the - * response as part of your request. A null pagination token - * fetches the records from the beginning.

- */ - public getModels(args: GetModelsCommandInput, options?: __HttpHandlerOptions): Promise; - public getModels(args: GetModelsCommandInput, cb: (err: any, data?: GetModelsCommandOutput) => void): void; - public getModels( + + /** + * @see {@link GetModelsCommand} + */ + getModels(args: GetModelsCommandInput, options?: __HttpHandlerOptions): Promise; + getModels(args: GetModelsCommandInput, cb: (err: any, data?: GetModelsCommandOutput) => void): void; + getModels( args: GetModelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetModelsCommandOutput) => void ): void; - public getModels( - args: GetModelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetModelsCommandOutput) => void), - cb?: (err: any, data?: GetModelsCommandOutput) => void - ): Promise | void { - const command = new GetModelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the details of the specified model version.

- */ - public getModelVersion( + + /** + * @see {@link GetModelVersionCommand} + */ + getModelVersion( args: GetModelVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getModelVersion( - args: GetModelVersionCommandInput, - cb: (err: any, data?: GetModelVersionCommandOutput) => void - ): void; - public getModelVersion( + getModelVersion(args: GetModelVersionCommandInput, cb: (err: any, data?: GetModelVersionCommandOutput) => void): void; + getModelVersion( args: GetModelVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetModelVersionCommandOutput) => void ): void; - public getModelVersion( - args: GetModelVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetModelVersionCommandOutput) => void), - cb?: (err: any, data?: GetModelVersionCommandOutput) => void - ): Promise | void { - const command = new GetModelVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets one or more outcomes. This is a paginated - * API. If you provide a null maxResults, this actions retrieves a maximum of - * 100 records per page. If you provide a maxResults, the value must be - * between 50 and 100. To get the next page results, provide the pagination token from the - * GetOutcomesResult as part of your request. A null pagination token - * fetches the records from the beginning.

- */ - public getOutcomes(args: GetOutcomesCommandInput, options?: __HttpHandlerOptions): Promise; - public getOutcomes(args: GetOutcomesCommandInput, cb: (err: any, data?: GetOutcomesCommandOutput) => void): void; - public getOutcomes( + + /** + * @see {@link GetOutcomesCommand} + */ + getOutcomes(args: GetOutcomesCommandInput, options?: __HttpHandlerOptions): Promise; + getOutcomes(args: GetOutcomesCommandInput, cb: (err: any, data?: GetOutcomesCommandOutput) => void): void; + getOutcomes( args: GetOutcomesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOutcomesCommandOutput) => void ): void; - public getOutcomes( - args: GetOutcomesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOutcomesCommandOutput) => void), - cb?: (err: any, data?: GetOutcomesCommandOutput) => void - ): Promise | void { - const command = new GetOutcomesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get all rules for a detector (paginated) if ruleId and ruleVersion are not specified. Gets all rules for the detector and the ruleId if present (paginated). Gets a specific rule if both the ruleId and the ruleVersion are specified.

- *

This is a paginated API. Providing null maxResults results in retrieving maximum of 100 records per page. If you provide maxResults the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetRulesResult as part of your request. Null pagination token fetches the records from the beginning.

- */ - public getRules(args: GetRulesCommandInput, options?: __HttpHandlerOptions): Promise; - public getRules(args: GetRulesCommandInput, cb: (err: any, data?: GetRulesCommandOutput) => void): void; - public getRules( + + /** + * @see {@link GetRulesCommand} + */ + getRules(args: GetRulesCommandInput, options?: __HttpHandlerOptions): Promise; + getRules(args: GetRulesCommandInput, cb: (err: any, data?: GetRulesCommandOutput) => void): void; + getRules( args: GetRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRulesCommandOutput) => void ): void; - public getRules( - args: GetRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRulesCommandOutput) => void), - cb?: (err: any, data?: GetRulesCommandOutput) => void - ): Promise | void { - const command = new GetRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets all of the variables or the specific variable. This is a - * paginated API. Providing null maxSizePerPage results in retrieving maximum of - * 100 records per page. If you provide maxSizePerPage the value must be between - * 50 and 100. To get the next page result, a provide a pagination token from - * GetVariablesResult as part of your request. Null pagination token - * fetches the records from the beginning.

- */ - public getVariables( - args: GetVariablesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getVariables(args: GetVariablesCommandInput, cb: (err: any, data?: GetVariablesCommandOutput) => void): void; - public getVariables( + + /** + * @see {@link GetVariablesCommand} + */ + getVariables(args: GetVariablesCommandInput, options?: __HttpHandlerOptions): Promise; + getVariables(args: GetVariablesCommandInput, cb: (err: any, data?: GetVariablesCommandOutput) => void): void; + getVariables( args: GetVariablesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVariablesCommandOutput) => void ): void; - public getVariables( - args: GetVariablesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVariablesCommandOutput) => void), - cb?: (err: any, data?: GetVariablesCommandOutput) => void - ): Promise | void { - const command = new GetVariablesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of past predictions. The list can be filtered by detector ID, detector version ID, event ID, event type, or by specifying a time period. - * If filter is not specified, the most recent prediction is returned.

- *

For example, the following filter lists all past predictions for xyz event type - - * \{ - * "eventType":\{ - * "value": "xyz" \}” - * \} - *

- *

This is a paginated API. If you provide a null maxResults, this action will retrieve a maximum of 10 records per page. - * If you provide a maxResults, the value must be between 50 and 100. To get the next page results, provide - * the nextToken from the response as part of your request. A null nextToken fetches the records from the beginning. - *

- */ - public listEventPredictions( + + /** + * @see {@link ListEventPredictionsCommand} + */ + listEventPredictions( args: ListEventPredictionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEventPredictions( + listEventPredictions( args: ListEventPredictionsCommandInput, cb: (err: any, data?: ListEventPredictionsCommandOutput) => void ): void; - public listEventPredictions( + listEventPredictions( args: ListEventPredictionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventPredictionsCommandOutput) => void ): void; - public listEventPredictions( - args: ListEventPredictionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEventPredictionsCommandOutput) => void), - cb?: (err: any, data?: ListEventPredictionsCommandOutput) => void - ): Promise | void { - const command = new ListEventPredictionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all tags associated with the resource. This is a paginated API. To get the next page results, provide the pagination token from the - * response as part of your request. A null pagination token - * fetches the records from the beginning.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or updates a detector.

- */ - public putDetector(args: PutDetectorCommandInput, options?: __HttpHandlerOptions): Promise; - public putDetector(args: PutDetectorCommandInput, cb: (err: any, data?: PutDetectorCommandOutput) => void): void; - public putDetector( + + /** + * @see {@link PutDetectorCommand} + */ + putDetector(args: PutDetectorCommandInput, options?: __HttpHandlerOptions): Promise; + putDetector(args: PutDetectorCommandInput, cb: (err: any, data?: PutDetectorCommandOutput) => void): void; + putDetector( args: PutDetectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDetectorCommandOutput) => void ): void; - public putDetector( - args: PutDetectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutDetectorCommandOutput) => void), - cb?: (err: any, data?: PutDetectorCommandOutput) => void - ): Promise | void { - const command = new PutDetectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or updates an entity type. An entity represents who is performing the event. As part of a fraud prediction, you pass the entity ID to indicate the specific entity who performed the event. An entity type classifies the entity. Example classifications include customer, merchant, or account.

- */ - public putEntityType( - args: PutEntityTypeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putEntityType( - args: PutEntityTypeCommandInput, - cb: (err: any, data?: PutEntityTypeCommandOutput) => void - ): void; - public putEntityType( + + /** + * @see {@link PutEntityTypeCommand} + */ + putEntityType(args: PutEntityTypeCommandInput, options?: __HttpHandlerOptions): Promise; + putEntityType(args: PutEntityTypeCommandInput, cb: (err: any, data?: PutEntityTypeCommandOutput) => void): void; + putEntityType( args: PutEntityTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEntityTypeCommandOutput) => void ): void; - public putEntityType( - args: PutEntityTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutEntityTypeCommandOutput) => void), - cb?: (err: any, data?: PutEntityTypeCommandOutput) => void - ): Promise | void { - const command = new PutEntityTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or updates an event type. An event is a business activity that is evaluated for fraud risk. With Amazon Fraud Detector, you generate fraud predictions for events. An event type defines the structure for an event sent to Amazon Fraud Detector. This includes the variables sent as part of the event, the entity performing the event (such as a customer), and the labels that classify the event. Example event types include online payment transactions, account registrations, and authentications.

- */ - public putEventType( - args: PutEventTypeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putEventType(args: PutEventTypeCommandInput, cb: (err: any, data?: PutEventTypeCommandOutput) => void): void; - public putEventType( + + /** + * @see {@link PutEventTypeCommand} + */ + putEventType(args: PutEventTypeCommandInput, options?: __HttpHandlerOptions): Promise; + putEventType(args: PutEventTypeCommandInput, cb: (err: any, data?: PutEventTypeCommandOutput) => void): void; + putEventType( args: PutEventTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEventTypeCommandOutput) => void ): void; - public putEventType( - args: PutEventTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutEventTypeCommandOutput) => void), - cb?: (err: any, data?: PutEventTypeCommandOutput) => void - ): Promise | void { - const command = new PutEventTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or updates an Amazon SageMaker model endpoint. You can also use this action to update the configuration of the model endpoint, including the IAM role and/or the mapped variables.

- */ - public putExternalModel( + + /** + * @see {@link PutExternalModelCommand} + */ + putExternalModel( args: PutExternalModelCommandInput, options?: __HttpHandlerOptions ): Promise; - public putExternalModel( + putExternalModel( args: PutExternalModelCommandInput, cb: (err: any, data?: PutExternalModelCommandOutput) => void ): void; - public putExternalModel( + putExternalModel( args: PutExternalModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutExternalModelCommandOutput) => void ): void; - public putExternalModel( - args: PutExternalModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutExternalModelCommandOutput) => void), - cb?: (err: any, data?: PutExternalModelCommandOutput) => void - ): Promise | void { - const command = new PutExternalModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Specifies the KMS key to be used to encrypt content in Amazon Fraud Detector.

- */ - public putKMSEncryptionKey( + + /** + * @see {@link PutKMSEncryptionKeyCommand} + */ + putKMSEncryptionKey( args: PutKMSEncryptionKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putKMSEncryptionKey( + putKMSEncryptionKey( args: PutKMSEncryptionKeyCommandInput, cb: (err: any, data?: PutKMSEncryptionKeyCommandOutput) => void ): void; - public putKMSEncryptionKey( + putKMSEncryptionKey( args: PutKMSEncryptionKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutKMSEncryptionKeyCommandOutput) => void ): void; - public putKMSEncryptionKey( - args: PutKMSEncryptionKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutKMSEncryptionKeyCommandOutput) => void), - cb?: (err: any, data?: PutKMSEncryptionKeyCommandOutput) => void - ): Promise | void { - const command = new PutKMSEncryptionKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or updates label. A label classifies an event as fraudulent or legitimate. Labels are associated with event types and used to train supervised machine learning models in Amazon Fraud Detector.

- */ - public putLabel(args: PutLabelCommandInput, options?: __HttpHandlerOptions): Promise; - public putLabel(args: PutLabelCommandInput, cb: (err: any, data?: PutLabelCommandOutput) => void): void; - public putLabel( + + /** + * @see {@link PutLabelCommand} + */ + putLabel(args: PutLabelCommandInput, options?: __HttpHandlerOptions): Promise; + putLabel(args: PutLabelCommandInput, cb: (err: any, data?: PutLabelCommandOutput) => void): void; + putLabel( args: PutLabelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLabelCommandOutput) => void ): void; - public putLabel( - args: PutLabelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutLabelCommandOutput) => void), - cb?: (err: any, data?: PutLabelCommandOutput) => void - ): Promise | void { - const command = new PutLabelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or updates an outcome.

- */ - public putOutcome(args: PutOutcomeCommandInput, options?: __HttpHandlerOptions): Promise; - public putOutcome(args: PutOutcomeCommandInput, cb: (err: any, data?: PutOutcomeCommandOutput) => void): void; - public putOutcome( + + /** + * @see {@link PutOutcomeCommand} + */ + putOutcome(args: PutOutcomeCommandInput, options?: __HttpHandlerOptions): Promise; + putOutcome(args: PutOutcomeCommandInput, cb: (err: any, data?: PutOutcomeCommandOutput) => void): void; + putOutcome( args: PutOutcomeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutOutcomeCommandOutput) => void ): void; - public putOutcome( - args: PutOutcomeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutOutcomeCommandOutput) => void), - cb?: (err: any, data?: PutOutcomeCommandOutput) => void - ): Promise | void { - const command = new PutOutcomeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stores events in Amazon Fraud Detector without generating fraud predictions for those events. For example, you can use SendEvent to upload a historical dataset, which you can then later use to train a model.

- */ - public sendEvent(args: SendEventCommandInput, options?: __HttpHandlerOptions): Promise; - public sendEvent(args: SendEventCommandInput, cb: (err: any, data?: SendEventCommandOutput) => void): void; - public sendEvent( + + /** + * @see {@link SendEventCommand} + */ + sendEvent(args: SendEventCommandInput, options?: __HttpHandlerOptions): Promise; + sendEvent(args: SendEventCommandInput, cb: (err: any, data?: SendEventCommandOutput) => void): void; + sendEvent( args: SendEventCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendEventCommandOutput) => void ): void; - public sendEvent( - args: SendEventCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendEventCommandOutput) => void), - cb?: (err: any, data?: SendEventCommandOutput) => void - ): Promise | void { - const command = new SendEventCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Assigns tags to a resource.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes tags from a resource.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a detector version. The detector version attributes that you can update include models, external model endpoints, rules, rule execution mode, and description. You can only update a DRAFT detector version.

- */ - public updateDetectorVersion( + + /** + * @see {@link UpdateDetectorVersionCommand} + */ + updateDetectorVersion( args: UpdateDetectorVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDetectorVersion( + updateDetectorVersion( args: UpdateDetectorVersionCommandInput, cb: (err: any, data?: UpdateDetectorVersionCommandOutput) => void ): void; - public updateDetectorVersion( + updateDetectorVersion( args: UpdateDetectorVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDetectorVersionCommandOutput) => void ): void; - public updateDetectorVersion( - args: UpdateDetectorVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDetectorVersionCommandOutput) => void), - cb?: (err: any, data?: UpdateDetectorVersionCommandOutput) => void - ): Promise | void { - const command = new UpdateDetectorVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the detector version's description. You can update the metadata for any detector version (DRAFT, ACTIVE, or - * INACTIVE).

- */ - public updateDetectorVersionMetadata( + + /** + * @see {@link UpdateDetectorVersionMetadataCommand} + */ + updateDetectorVersionMetadata( args: UpdateDetectorVersionMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDetectorVersionMetadata( + updateDetectorVersionMetadata( args: UpdateDetectorVersionMetadataCommandInput, cb: (err: any, data?: UpdateDetectorVersionMetadataCommandOutput) => void ): void; - public updateDetectorVersionMetadata( + updateDetectorVersionMetadata( args: UpdateDetectorVersionMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDetectorVersionMetadataCommandOutput) => void ): void; - public updateDetectorVersionMetadata( - args: UpdateDetectorVersionMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDetectorVersionMetadataCommandOutput) => void), - cb?: (err: any, data?: UpdateDetectorVersionMetadataCommandOutput) => void - ): Promise | void { - const command = new UpdateDetectorVersionMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the detector version’s status. You can perform the following promotions or - * demotions using UpdateDetectorVersionStatus: DRAFT to ACTIVE, ACTIVE to INACTIVE, and INACTIVE to ACTIVE.

- */ - public updateDetectorVersionStatus( + + /** + * @see {@link UpdateDetectorVersionStatusCommand} + */ + updateDetectorVersionStatus( args: UpdateDetectorVersionStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDetectorVersionStatus( + updateDetectorVersionStatus( args: UpdateDetectorVersionStatusCommandInput, cb: (err: any, data?: UpdateDetectorVersionStatusCommandOutput) => void ): void; - public updateDetectorVersionStatus( + updateDetectorVersionStatus( args: UpdateDetectorVersionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDetectorVersionStatusCommandOutput) => void ): void; - public updateDetectorVersionStatus( - args: UpdateDetectorVersionStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDetectorVersionStatusCommandOutput) => void), - cb?: (err: any, data?: UpdateDetectorVersionStatusCommandOutput) => void - ): Promise | void { - const command = new UpdateDetectorVersionStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the specified event with a new label.

- */ - public updateEventLabel( + + /** + * @see {@link UpdateEventLabelCommand} + */ + updateEventLabel( args: UpdateEventLabelCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEventLabel( + updateEventLabel( args: UpdateEventLabelCommandInput, cb: (err: any, data?: UpdateEventLabelCommandOutput) => void ): void; - public updateEventLabel( + updateEventLabel( args: UpdateEventLabelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEventLabelCommandOutput) => void ): void; - public updateEventLabel( - args: UpdateEventLabelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEventLabelCommandOutput) => void), - cb?: (err: any, data?: UpdateEventLabelCommandOutput) => void - ): Promise | void { - const command = new UpdateEventLabelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Updates a list. - *

- */ - public updateList(args: UpdateListCommandInput, options?: __HttpHandlerOptions): Promise; - public updateList(args: UpdateListCommandInput, cb: (err: any, data?: UpdateListCommandOutput) => void): void; - public updateList( + + /** + * @see {@link UpdateListCommand} + */ + updateList(args: UpdateListCommandInput, options?: __HttpHandlerOptions): Promise; + updateList(args: UpdateListCommandInput, cb: (err: any, data?: UpdateListCommandOutput) => void): void; + updateList( args: UpdateListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateListCommandOutput) => void ): void; - public updateList( - args: UpdateListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateListCommandOutput) => void), - cb?: (err: any, data?: UpdateListCommandOutput) => void - ): Promise | void { - const command = new UpdateListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates model description.

- */ - public updateModel(args: UpdateModelCommandInput, options?: __HttpHandlerOptions): Promise; - public updateModel(args: UpdateModelCommandInput, cb: (err: any, data?: UpdateModelCommandOutput) => void): void; - public updateModel( + + /** + * @see {@link UpdateModelCommand} + */ + updateModel(args: UpdateModelCommandInput, options?: __HttpHandlerOptions): Promise; + updateModel(args: UpdateModelCommandInput, cb: (err: any, data?: UpdateModelCommandOutput) => void): void; + updateModel( args: UpdateModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateModelCommandOutput) => void ): void; - public updateModel( - args: UpdateModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateModelCommandOutput) => void), - cb?: (err: any, data?: UpdateModelCommandOutput) => void - ): Promise | void { - const command = new UpdateModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a model version. Updating a model version retrains an existing model version using updated training data and produces a new minor version of the model. You can update the training data set location and data access role attributes using this action. This action creates and trains a new minor version of the model, for example version 1.01, 1.02, 1.03.

- */ - public updateModelVersion( + + /** + * @see {@link UpdateModelVersionCommand} + */ + updateModelVersion( args: UpdateModelVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateModelVersion( + updateModelVersion( args: UpdateModelVersionCommandInput, cb: (err: any, data?: UpdateModelVersionCommandOutput) => void ): void; - public updateModelVersion( + updateModelVersion( args: UpdateModelVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateModelVersionCommandOutput) => void ): void; - public updateModelVersion( - args: UpdateModelVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateModelVersionCommandOutput) => void), - cb?: (err: any, data?: UpdateModelVersionCommandOutput) => void - ): Promise | void { - const command = new UpdateModelVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the status of a model version.

- *

You can perform the following status updates:

- *
    - *
  1. - *

    Change the TRAINING_IN_PROGRESS status to TRAINING_CANCELLED.

    - *
  2. - *
  3. - *

    Change the TRAINING_COMPLETE status to ACTIVE.

    - *
  4. - *
  5. - *

    Change ACTIVE to INACTIVE.

    - *
  6. - *
- */ - public updateModelVersionStatus( + + /** + * @see {@link UpdateModelVersionStatusCommand} + */ + updateModelVersionStatus( args: UpdateModelVersionStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateModelVersionStatus( + updateModelVersionStatus( args: UpdateModelVersionStatusCommandInput, cb: (err: any, data?: UpdateModelVersionStatusCommandOutput) => void ): void; - public updateModelVersionStatus( + updateModelVersionStatus( args: UpdateModelVersionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateModelVersionStatusCommandOutput) => void ): void; - public updateModelVersionStatus( - args: UpdateModelVersionStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateModelVersionStatusCommandOutput) => void), - cb?: (err: any, data?: UpdateModelVersionStatusCommandOutput) => void - ): Promise | void { - const command = new UpdateModelVersionStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a rule's metadata. The description attribute can be updated.

- */ - public updateRuleMetadata( + + /** + * @see {@link UpdateRuleMetadataCommand} + */ + updateRuleMetadata( args: UpdateRuleMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRuleMetadata( + updateRuleMetadata( args: UpdateRuleMetadataCommandInput, cb: (err: any, data?: UpdateRuleMetadataCommandOutput) => void ): void; - public updateRuleMetadata( + updateRuleMetadata( args: UpdateRuleMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRuleMetadataCommandOutput) => void ): void; - public updateRuleMetadata( - args: UpdateRuleMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRuleMetadataCommandOutput) => void), - cb?: (err: any, data?: UpdateRuleMetadataCommandOutput) => void - ): Promise | void { - const command = new UpdateRuleMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a rule version resulting in a new rule version. Updates a rule version resulting in a new rule version (version 1, 2, 3 ...).

- */ - public updateRuleVersion( + + /** + * @see {@link UpdateRuleVersionCommand} + */ + updateRuleVersion( args: UpdateRuleVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRuleVersion( + updateRuleVersion( args: UpdateRuleVersionCommandInput, cb: (err: any, data?: UpdateRuleVersionCommandOutput) => void ): void; - public updateRuleVersion( + updateRuleVersion( args: UpdateRuleVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRuleVersionCommandOutput) => void ): void; - public updateRuleVersion( - args: UpdateRuleVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRuleVersionCommandOutput) => void), - cb?: (err: any, data?: UpdateRuleVersionCommandOutput) => void - ): Promise | void { - const command = new UpdateRuleVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a variable.

- */ - public updateVariable( + + /** + * @see {@link UpdateVariableCommand} + */ + updateVariable( args: UpdateVariableCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVariable( - args: UpdateVariableCommandInput, - cb: (err: any, data?: UpdateVariableCommandOutput) => void - ): void; - public updateVariable( + updateVariable(args: UpdateVariableCommandInput, cb: (err: any, data?: UpdateVariableCommandOutput) => void): void; + updateVariable( args: UpdateVariableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVariableCommandOutput) => void ): void; - public updateVariable( - args: UpdateVariableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVariableCommandOutput) => void), - cb?: (err: any, data?: UpdateVariableCommandOutput) => void - ): Promise | void { - const command = new UpdateVariableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

This is the Amazon Fraud Detector API Reference. This guide is for developers who need + * detailed information about Amazon Fraud Detector API actions, data types, and errors. For + * more information about Amazon Fraud Detector features, see the Amazon Fraud Detector User Guide.

+ *

We provide the Query API as well as AWS software development kits (SDK) for Amazon Fraud Detector in Java and Python programming languages.

+ *

The Amazon Fraud Detector Query API provides HTTPS requests that use the HTTP verb GET or POST and a Query parameter Action. AWS SDK provides libraries, + * sample code, tutorials, and other resources for software developers who prefer to build applications using language-specific APIs instead of submitting a request over + * HTTP or HTTPS. These libraries provide basic functions that automatically take care of tasks such as cryptographically signing your requests, retrying requests, and + * handling error responses, so that it is easier for you to get started. For more information about the AWS SDKs, see Tools to build on AWS. + *

+ */ +export class FraudDetector extends FraudDetectorClient implements FraudDetector {} +createAggregatedClient(commands, FraudDetector); diff --git a/clients/client-fsx/src/FSx.ts b/clients/client-fsx/src/FSx.ts index fc66ecafef29..19563aa57046 100644 --- a/clients/client-fsx/src/FSx.ts +++ b/clients/client-fsx/src/FSx.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -198,1983 +199,683 @@ import { UpdateVolumeCommandInput, UpdateVolumeCommandOutput, } from "./commands/UpdateVolumeCommand"; -import { FSxClient } from "./FSxClient"; +import { FSxClient, FSxClientConfig } from "./FSxClient"; -/** - * @public - *

Amazon FSx is a fully managed service that makes it easy for storage and - * application administrators to launch and use shared file storage.

- */ -export class FSx extends FSxClient { +const commands = { + AssociateFileSystemAliasesCommand, + CancelDataRepositoryTaskCommand, + CopyBackupCommand, + CreateBackupCommand, + CreateDataRepositoryAssociationCommand, + CreateDataRepositoryTaskCommand, + CreateFileCacheCommand, + CreateFileSystemCommand, + CreateFileSystemFromBackupCommand, + CreateSnapshotCommand, + CreateStorageVirtualMachineCommand, + CreateVolumeCommand, + CreateVolumeFromBackupCommand, + DeleteBackupCommand, + DeleteDataRepositoryAssociationCommand, + DeleteFileCacheCommand, + DeleteFileSystemCommand, + DeleteSnapshotCommand, + DeleteStorageVirtualMachineCommand, + DeleteVolumeCommand, + DescribeBackupsCommand, + DescribeDataRepositoryAssociationsCommand, + DescribeDataRepositoryTasksCommand, + DescribeFileCachesCommand, + DescribeFileSystemAliasesCommand, + DescribeFileSystemsCommand, + DescribeSnapshotsCommand, + DescribeStorageVirtualMachinesCommand, + DescribeVolumesCommand, + DisassociateFileSystemAliasesCommand, + ListTagsForResourceCommand, + ReleaseFileSystemNfsV3LocksCommand, + RestoreVolumeFromSnapshotCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateDataRepositoryAssociationCommand, + UpdateFileCacheCommand, + UpdateFileSystemCommand, + UpdateSnapshotCommand, + UpdateStorageVirtualMachineCommand, + UpdateVolumeCommand, +}; + +export interface FSx { /** - * @public - *

Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system. - * A file system can have a maximum of 50 DNS aliases associated with it at any one time. If you try to - * associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. - * For more information, see Working with DNS Aliases and - * Walkthrough 5: Using DNS aliases to access your file system, including - * additional steps you must take to be able to access your file system using a DNS alias.

- *

The system response shows the DNS aliases that - * Amazon FSx is attempting to associate with the file system. - * Use the API - * operation to monitor the status of the aliases Amazon FSx is - * associating with the file system.

+ * @see {@link AssociateFileSystemAliasesCommand} */ - public associateFileSystemAliases( + associateFileSystemAliases( args: AssociateFileSystemAliasesCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateFileSystemAliases( + associateFileSystemAliases( args: AssociateFileSystemAliasesCommandInput, cb: (err: any, data?: AssociateFileSystemAliasesCommandOutput) => void ): void; - public associateFileSystemAliases( + associateFileSystemAliases( args: AssociateFileSystemAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateFileSystemAliasesCommandOutput) => void ): void; - public associateFileSystemAliases( - args: AssociateFileSystemAliasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateFileSystemAliasesCommandOutput) => void), - cb?: (err: any, data?: AssociateFileSystemAliasesCommandOutput) => void - ): Promise | void { - const command = new AssociateFileSystemAliasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the - * PENDING or EXECUTING state. When you cancel a task, Amazon FSx does the following.

- *
    - *
  • - *

    Any files that FSx has already exported are not reverted.

    - *
  • - *
  • - *

    FSx continues to export any files that are "in-flight" when the cancel operation is received.

    - *
  • - *
  • - *

    FSx does not export any files that have not yet been exported.

    - *
  • - *
+ * @see {@link CancelDataRepositoryTaskCommand} */ - public cancelDataRepositoryTask( + cancelDataRepositoryTask( args: CancelDataRepositoryTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelDataRepositoryTask( + cancelDataRepositoryTask( args: CancelDataRepositoryTaskCommandInput, cb: (err: any, data?: CancelDataRepositoryTaskCommandOutput) => void ): void; - public cancelDataRepositoryTask( + cancelDataRepositoryTask( args: CancelDataRepositoryTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelDataRepositoryTaskCommandOutput) => void ): void; - public cancelDataRepositoryTask( - args: CancelDataRepositoryTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelDataRepositoryTaskCommandOutput) => void), - cb?: (err: any, data?: CancelDataRepositoryTaskCommandOutput) => void - ): Promise | void { - const command = new CancelDataRepositoryTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region - * (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five - * backup copy requests in progress to a single destination Region per account.

- *

You can use cross-Region backup copies for cross-Region disaster recovery. You can - * periodically take backups and copy them to another Region so that in the event of a - * disaster in the primary Region, you can restore from backup and recover availability - * quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition. A partition is a grouping of Regions. Amazon Web Services currently - * has three partitions: aws (Standard Regions), aws-cn (China - * Regions), and aws-us-gov (Amazon Web Services GovCloud [US] Regions).

- *

You can also use backup copies to clone your file dataset to another Region or within - * the same Region.

- *

You can use the SourceRegion parameter to specify the Amazon Web Services Region - * from which the backup will be copied. For example, if you make the call from the - * us-west-1 Region and want to copy a backup from the us-east-2 - * Region, you specify us-east-2 in the SourceRegion parameter - * to make a cross-Region copy. If you don't specify a Region, the backup copy is - * created in the same Region where the request is sent from (in-Region copy).

- *

For more information about creating backup copies, see Copying backups - * in the Amazon FSx for Windows User Guide, Copying backups in the Amazon FSx for Lustre User - * Guide, and Copying backups in the Amazon FSx for OpenZFS User - * Guide.

+ * @see {@link CopyBackupCommand} */ - public copyBackup(args: CopyBackupCommandInput, options?: __HttpHandlerOptions): Promise; - public copyBackup(args: CopyBackupCommandInput, cb: (err: any, data?: CopyBackupCommandOutput) => void): void; - public copyBackup( + copyBackup(args: CopyBackupCommandInput, options?: __HttpHandlerOptions): Promise; + copyBackup(args: CopyBackupCommandInput, cb: (err: any, data?: CopyBackupCommandOutput) => void): void; + copyBackup( args: CopyBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyBackupCommandOutput) => void ): void; - public copyBackup( - args: CopyBackupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopyBackupCommandOutput) => void), - cb?: (err: any, data?: CopyBackupCommandOutput) => void - ): Promise | void { - const command = new CopyBackupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a backup of an existing Amazon FSx for Windows File Server file - * system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP - * volume, or Amazon FSx for OpenZFS file system. We recommend creating regular - * backups so that you can restore a file system or volume from a backup if an issue arises - * with the original file system or volume.

- *

For Amazon FSx for Lustre file systems, you can create a backup only for file - * systems that have the following configuration:

- *
    - *
  • - *

    A Persistent deployment type

    - *
  • - *
  • - *

    Are not linked to a data repository

    - *
  • - *
- *

For more information about backups, see the following:

- * - *

If a backup with the specified client request token exists and the parameters match, - * this operation returns the description of the existing backup. If a backup with the - * specified client request token exists and the parameters don't match, this operation - * returns IncompatibleParameterError. If a backup with the specified client - * request token doesn't exist, CreateBackup does the following:

- *
    - *
  • - *

    Creates a new Amazon FSx backup with an assigned ID, and an initial - * lifecycle state of CREATING.

    - *
  • - *
  • - *

    Returns the description of the backup.

    - *
  • - *
- *

By using the idempotent operation, you can retry a CreateBackup - * operation without the risk of creating an extra backup. This approach can be useful when - * an initial call fails in a way that makes it unclear whether a backup was created. If - * you use the same client request token and the initial call created a backup, the - * operation returns a successful result because all the parameters are the same.

- *

The CreateBackup operation returns while the backup's lifecycle state is - * still CREATING. You can check the backup creation status by calling the - * DescribeBackups operation, which returns the backup state along with other - * information.

+ * @see {@link CreateBackupCommand} */ - public createBackup( - args: CreateBackupCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createBackup(args: CreateBackupCommandInput, cb: (err: any, data?: CreateBackupCommandOutput) => void): void; - public createBackup( + createBackup(args: CreateBackupCommandInput, options?: __HttpHandlerOptions): Promise; + createBackup(args: CreateBackupCommandInput, cb: (err: any, data?: CreateBackupCommandOutput) => void): void; + createBackup( args: CreateBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBackupCommandOutput) => void ): void; - public createBackup( - args: CreateBackupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBackupCommandOutput) => void), - cb?: (err: any, data?: CreateBackupCommandOutput) => void - ): Promise | void { - const command = new CreateBackupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Amazon FSx for Lustre data repository association (DRA). A data - * repository association is a link between a directory on the file system and - * an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository - * associations on a file system. Data repository associations are supported - * for all file systems except for Scratch_1 deployment type.

- *

Each data repository association must have a unique Amazon FSx file - * system directory and a unique S3 bucket or prefix associated with it. You - * can configure a data repository association for automatic import only, - * for automatic export only, or for both. To learn more about linking a - * data repository to your file system, see - * Linking your file system to an S3 bucket.

- * - *

- * CreateDataRepositoryAssociation isn't supported - * on Amazon File Cache resources. To create a DRA on Amazon File Cache, - * use the CreateFileCache operation.

- *
+ * @see {@link CreateDataRepositoryAssociationCommand} */ - public createDataRepositoryAssociation( + createDataRepositoryAssociation( args: CreateDataRepositoryAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDataRepositoryAssociation( + createDataRepositoryAssociation( args: CreateDataRepositoryAssociationCommandInput, cb: (err: any, data?: CreateDataRepositoryAssociationCommandOutput) => void ): void; - public createDataRepositoryAssociation( + createDataRepositoryAssociation( args: CreateDataRepositoryAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataRepositoryAssociationCommandOutput) => void ): void; - public createDataRepositoryAssociation( - args: CreateDataRepositoryAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDataRepositoryAssociationCommandOutput) => void), - cb?: (err: any, data?: CreateDataRepositoryAssociationCommandOutput) => void - ): Promise | void { - const command = new CreateDataRepositoryAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Amazon FSx for Lustre data repository task. You use data repository tasks - * to perform bulk operations between your Amazon FSx file system and its linked data - * repositories. An example of a data repository task is exporting any data and metadata - * changes, including POSIX metadata, to files, directories, and symbolic links (symlinks) - * from your FSx file system to a linked data repository. A CreateDataRepositoryTask - * operation will fail if a data repository is not linked to the FSx file system. To learn - * more about data repository tasks, see - * Data Repository Tasks. - * To learn more about linking a data repository to your file system, see - * Linking your file system to an S3 bucket.

+ * @see {@link CreateDataRepositoryTaskCommand} */ - public createDataRepositoryTask( + createDataRepositoryTask( args: CreateDataRepositoryTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDataRepositoryTask( + createDataRepositoryTask( args: CreateDataRepositoryTaskCommandInput, cb: (err: any, data?: CreateDataRepositoryTaskCommandOutput) => void ): void; - public createDataRepositoryTask( + createDataRepositoryTask( args: CreateDataRepositoryTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataRepositoryTaskCommandOutput) => void ): void; - public createDataRepositoryTask( - args: CreateDataRepositoryTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDataRepositoryTaskCommandOutput) => void), - cb?: (err: any, data?: CreateDataRepositoryTaskCommandOutput) => void - ): Promise | void { - const command = new CreateDataRepositoryTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new Amazon File Cache resource.

- *

You can use this operation with a client request token in the request that - * Amazon File Cache uses to ensure idempotent creation. - * If a cache with the specified client request token exists and the parameters - * match, CreateFileCache returns the description of the existing - * cache. If a cache with the specified client request token exists and the - * parameters don't match, this call returns IncompatibleParameterError. - * If a file cache with the specified client request token doesn't exist, - * CreateFileCache does the following:

- *
    - *
  • - *

    Creates a new, empty Amazon File Cache resourcewith an assigned ID, and - * an initial lifecycle state of CREATING.

    - *
  • - *
  • - *

    Returns the description of the cache in JSON format.

    - *
  • - *
- * - *

The CreateFileCache call returns while the cache's lifecycle - * state is still CREATING. You can check the cache creation status - * by calling the DescribeFileCaches operation, which returns the cache state - * along with other information.

- *
+ * @see {@link CreateFileCacheCommand} */ - public createFileCache( + createFileCache( args: CreateFileCacheCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFileCache( - args: CreateFileCacheCommandInput, - cb: (err: any, data?: CreateFileCacheCommandOutput) => void - ): void; - public createFileCache( + createFileCache(args: CreateFileCacheCommandInput, cb: (err: any, data?: CreateFileCacheCommandOutput) => void): void; + createFileCache( args: CreateFileCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFileCacheCommandOutput) => void ): void; - public createFileCache( - args: CreateFileCacheCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFileCacheCommandOutput) => void), - cb?: (err: any, data?: CreateFileCacheCommandOutput) => void - ): Promise | void { - const command = new CreateFileCacheCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new, empty Amazon FSx file system. You can create the following supported - * Amazon FSx file systems using the CreateFileSystem API operation:

- *
    - *
  • - *

    Amazon FSx for Lustre

    - *
  • - *
  • - *

    Amazon FSx for NetApp ONTAP

    - *
  • - *
  • - *

    Amazon FSx for OpenZFS

    - *
  • - *
  • - *

    Amazon FSx for Windows File Server

    - *
  • - *
- *

This operation requires a client request token in the request that Amazon FSx uses - * to ensure idempotent creation. This means that calling the operation multiple times with - * the same client request token has no effect. By using the idempotent operation, you can - * retry a CreateFileSystem operation without the risk of creating an extra - * file system. This approach can be useful when an initial call fails in a way that makes - * it unclear whether a file system was created. Examples are if a transport level timeout - * occurred, or your connection was reset. If you use the same client request token and the - * initial call created a file system, the client receives success as long as the - * parameters are the same.

- *

If a file system with the specified client request token exists and the parameters - * match, CreateFileSystem returns the description of the existing file - * system. If a file system with the specified client request token exists and the - * parameters don't match, this call returns IncompatibleParameterError. If a - * file system with the specified client request token doesn't exist, - * CreateFileSystem does the following:

- *
    - *
  • - *

    Creates a new, empty Amazon FSx file system with an assigned ID, and - * an initial lifecycle state of CREATING.

    - *
  • - *
  • - *

    Returns the description of the file system in JSON format.

    - *
  • - *
- * - *

The CreateFileSystem call returns while the file system's lifecycle - * state is still CREATING. You can check the file-system creation status - * by calling the DescribeFileSystems operation, which returns the file system state - * along with other information.

- *
+ * @see {@link CreateFileSystemCommand} */ - public createFileSystem( + createFileSystem( args: CreateFileSystemCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFileSystem( + createFileSystem( args: CreateFileSystemCommandInput, cb: (err: any, data?: CreateFileSystemCommandOutput) => void ): void; - public createFileSystem( + createFileSystem( args: CreateFileSystemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFileSystemCommandOutput) => void ): void; - public createFileSystem( - args: CreateFileSystemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFileSystemCommandOutput) => void), - cb?: (err: any, data?: CreateFileSystemCommandOutput) => void - ): Promise | void { - const command = new CreateFileSystemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File - * Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.

- *

If a file system with the specified client request token exists and the parameters - * match, this operation returns the description of the file system. If a file system - * with the specified client request token exists but the parameters don't match, this - * call returns IncompatibleParameterError. If a file system with the - * specified client request token doesn't exist, this operation does the following:

- *
    - *
  • - *

    Creates a new Amazon FSx file system from backup with an assigned ID, - * and an initial lifecycle state of CREATING.

    - *
  • - *
  • - *

    Returns the description of the file system.

    - *
  • - *
- *

Parameters like the Active Directory, default share name, automatic backup, and backup - * settings default to the parameters of the file system that was backed up, unless - * overridden. You can explicitly supply other settings.

- *

By using the idempotent operation, you can retry a - * CreateFileSystemFromBackup call without the risk of creating an extra - * file system. This approach can be useful when an initial call fails in a way that makes - * it unclear whether a file system was created. Examples are if a transport level timeout - * occurred, or your connection was reset. If you use the same client request token and the - * initial call created a file system, the client receives a success message as long as the - * parameters are the same.

- * - *

The CreateFileSystemFromBackup call returns while the file system's - * lifecycle state is still CREATING. You can check the file-system - * creation status by calling the - * DescribeFileSystems operation, which returns the file system state along - * with other information.

- *
+ * @see {@link CreateFileSystemFromBackupCommand} */ - public createFileSystemFromBackup( + createFileSystemFromBackup( args: CreateFileSystemFromBackupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFileSystemFromBackup( + createFileSystemFromBackup( args: CreateFileSystemFromBackupCommandInput, cb: (err: any, data?: CreateFileSystemFromBackupCommandOutput) => void ): void; - public createFileSystemFromBackup( + createFileSystemFromBackup( args: CreateFileSystemFromBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFileSystemFromBackupCommandOutput) => void ): void; - public createFileSystemFromBackup( - args: CreateFileSystemFromBackupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFileSystemFromBackupCommandOutput) => void), - cb?: (err: any, data?: CreateFileSystemFromBackupCommandOutput) => void - ): Promise | void { - const command = new CreateFileSystemFromBackupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With - * snapshots, you can easily undo file changes and compare file versions by restoring the - * volume to a previous version.

- *

If a snapshot with the specified client request token exists, and the parameters - * match, this operation returns the description of the existing snapshot. If a snapshot - * with the specified client request token exists, and the parameters don't match, this - * operation returns IncompatibleParameterError. If a snapshot with the - * specified client request token doesn't exist, CreateSnapshot does the - * following:

- *
    - *
  • - *

    Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle - * state of CREATING.

    - *
  • - *
  • - *

    Returns the description of the snapshot.

    - *
  • - *
- *

By using the idempotent operation, you can retry a CreateSnapshot - * operation without the risk of creating an extra snapshot. This approach can be useful - * when an initial call fails in a way that makes it unclear whether a snapshot was - * created. If you use the same client request token and the initial call created a - * snapshot, the operation returns a successful result because all the parameters are the - * same.

- *

The CreateSnapshot operation returns while the snapshot's lifecycle state - * is still CREATING. You can check the snapshot creation status by calling - * the DescribeSnapshots operation, which returns the snapshot state along with - * other information.

+ * @see {@link CreateSnapshotCommand} */ - public createSnapshot( + createSnapshot( args: CreateSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSnapshot( - args: CreateSnapshotCommandInput, - cb: (err: any, data?: CreateSnapshotCommandOutput) => void - ): void; - public createSnapshot( + createSnapshot(args: CreateSnapshotCommandInput, cb: (err: any, data?: CreateSnapshotCommandOutput) => void): void; + createSnapshot( args: CreateSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSnapshotCommandOutput) => void ): void; - public createSnapshot( - args: CreateSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSnapshotCommandOutput) => void), - cb?: (err: any, data?: CreateSnapshotCommandOutput) => void - ): Promise | void { - const command = new CreateSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.

+ * @see {@link CreateStorageVirtualMachineCommand} */ - public createStorageVirtualMachine( + createStorageVirtualMachine( args: CreateStorageVirtualMachineCommandInput, options?: __HttpHandlerOptions ): Promise; - public createStorageVirtualMachine( + createStorageVirtualMachine( args: CreateStorageVirtualMachineCommandInput, cb: (err: any, data?: CreateStorageVirtualMachineCommandOutput) => void ): void; - public createStorageVirtualMachine( + createStorageVirtualMachine( args: CreateStorageVirtualMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStorageVirtualMachineCommandOutput) => void ): void; - public createStorageVirtualMachine( - args: CreateStorageVirtualMachineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStorageVirtualMachineCommandOutput) => void), - cb?: (err: any, data?: CreateStorageVirtualMachineCommandOutput) => void - ): Promise | void { - const command = new CreateStorageVirtualMachineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.

+ * @see {@link CreateVolumeCommand} */ - public createVolume( - args: CreateVolumeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createVolume(args: CreateVolumeCommandInput, cb: (err: any, data?: CreateVolumeCommandOutput) => void): void; - public createVolume( + createVolume(args: CreateVolumeCommandInput, options?: __HttpHandlerOptions): Promise; + createVolume(args: CreateVolumeCommandInput, cb: (err: any, data?: CreateVolumeCommandOutput) => void): void; + createVolume( args: CreateVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVolumeCommandOutput) => void ): void; - public createVolume( - args: CreateVolumeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVolumeCommandOutput) => void), - cb?: (err: any, data?: CreateVolumeCommandOutput) => void - ): Promise | void { - const command = new CreateVolumeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new Amazon FSx for NetApp ONTAP volume from an - * existing Amazon FSx volume backup.

+ * @see {@link CreateVolumeFromBackupCommand} */ - public createVolumeFromBackup( + createVolumeFromBackup( args: CreateVolumeFromBackupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVolumeFromBackup( + createVolumeFromBackup( args: CreateVolumeFromBackupCommandInput, cb: (err: any, data?: CreateVolumeFromBackupCommandOutput) => void ): void; - public createVolumeFromBackup( + createVolumeFromBackup( args: CreateVolumeFromBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVolumeFromBackupCommandOutput) => void ): void; - public createVolumeFromBackup( - args: CreateVolumeFromBackupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVolumeFromBackupCommandOutput) => void), - cb?: (err: any, data?: CreateVolumeFromBackupCommandOutput) => void - ): Promise | void { - const command = new CreateVolumeFromBackupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and - * its data is gone.

- *

The DeleteBackup call returns instantly. The backup won't show up in - * later DescribeBackups calls.

- * - *

The data in a deleted backup is also deleted and can't be recovered by any - * means.

- *
+ * @see {@link DeleteBackupCommand} */ - public deleteBackup( - args: DeleteBackupCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteBackup(args: DeleteBackupCommandInput, cb: (err: any, data?: DeleteBackupCommandOutput) => void): void; - public deleteBackup( + deleteBackup(args: DeleteBackupCommandInput, options?: __HttpHandlerOptions): Promise; + deleteBackup(args: DeleteBackupCommandInput, cb: (err: any, data?: DeleteBackupCommandOutput) => void): void; + deleteBackup( args: DeleteBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackupCommandOutput) => void ): void; - public deleteBackup( - args: DeleteBackupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBackupCommandOutput) => void), - cb?: (err: any, data?: DeleteBackupCommandOutput) => void - ): Promise | void { - const command = new DeleteBackupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a data repository association on an Amazon FSx for Lustre - * file system. Deleting the data repository association unlinks the - * file system from the Amazon S3 bucket. When deleting a data repository - * association, you have the option of deleting the data in the file system - * that corresponds to the data repository association. Data repository - * associations are supported for all file systems except for Scratch_1 - * deployment type.

+ * @see {@link DeleteDataRepositoryAssociationCommand} */ - public deleteDataRepositoryAssociation( + deleteDataRepositoryAssociation( args: DeleteDataRepositoryAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDataRepositoryAssociation( + deleteDataRepositoryAssociation( args: DeleteDataRepositoryAssociationCommandInput, cb: (err: any, data?: DeleteDataRepositoryAssociationCommandOutput) => void ): void; - public deleteDataRepositoryAssociation( + deleteDataRepositoryAssociation( args: DeleteDataRepositoryAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataRepositoryAssociationCommandOutput) => void ): void; - public deleteDataRepositoryAssociation( - args: DeleteDataRepositoryAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDataRepositoryAssociationCommandOutput) => void), - cb?: (err: any, data?: DeleteDataRepositoryAssociationCommandOutput) => void - ): Promise | void { - const command = new DeleteDataRepositoryAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon File Cache resource. After deletion, the cache no longer exists, and its data - * is gone.

- *

The DeleteFileCache operation returns while the cache has the - * DELETING status. You can check the cache deletion status by - * calling the DescribeFileCaches operation, which returns a list of caches in your - * account. If you pass the cache ID for a deleted cache, the - * DescribeFileCaches operation returns a FileCacheNotFound - * error.

- * - *

The data in a deleted cache is also deleted and can't be recovered by - * any means.

- *
+ * @see {@link DeleteFileCacheCommand} */ - public deleteFileCache( + deleteFileCache( args: DeleteFileCacheCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFileCache( - args: DeleteFileCacheCommandInput, - cb: (err: any, data?: DeleteFileCacheCommandOutput) => void - ): void; - public deleteFileCache( + deleteFileCache(args: DeleteFileCacheCommandInput, cb: (err: any, data?: DeleteFileCacheCommandOutput) => void): void; + deleteFileCache( args: DeleteFileCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFileCacheCommandOutput) => void ): void; - public deleteFileCache( - args: DeleteFileCacheCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFileCacheCommandOutput) => void), - cb?: (err: any, data?: DeleteFileCacheCommandOutput) => void - ): Promise | void { - const command = new DeleteFileCacheCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a file system. After deletion, the file system no longer exists, and its data - * is gone. Any existing automatic backups and snapshots are also deleted.

- *

To delete an Amazon FSx for NetApp ONTAP file system, first delete all the - * volumes and storage virtual machines (SVMs) on the file system. Then provide a - * FileSystemId value to the DeleFileSystem operation.

- *

By default, when you delete an Amazon FSx for Windows File Server file system, - * a final backup is created upon deletion. This final backup isn't subject to the file - * system's retention policy, and must be manually deleted.

- *

The DeleteFileSystem operation returns while the file system has the - * DELETING status. You can check the file system deletion status by - * calling the DescribeFileSystems operation, which returns a list of file systems in your - * account. If you pass the file system ID for a deleted file system, the - * DescribeFileSystems operation returns a FileSystemNotFound - * error.

- * - *

If a data repository task is in a PENDING or EXECUTING state, - * deleting an Amazon FSx for Lustre file system will fail with an HTTP status - * code 400 (Bad Request).

- *
- * - *

The data in a deleted file system is also deleted and can't be recovered by - * any means.

- *
+ * @see {@link DeleteFileSystemCommand} */ - public deleteFileSystem( + deleteFileSystem( args: DeleteFileSystemCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFileSystem( + deleteFileSystem( args: DeleteFileSystemCommandInput, cb: (err: any, data?: DeleteFileSystemCommandOutput) => void ): void; - public deleteFileSystem( + deleteFileSystem( args: DeleteFileSystemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFileSystemCommandOutput) => void ): void; - public deleteFileSystem( - args: DeleteFileSystemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFileSystemCommandOutput) => void), - cb?: (err: any, data?: DeleteFileSystemCommandOutput) => void - ): Promise | void { - const command = new DeleteFileSystemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no longer - * exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a - * file system backup.

- *

The DeleteSnapshot operation returns instantly. The snapshot appears with - * the lifecycle status of DELETING until the deletion is complete.

+ * @see {@link DeleteSnapshotCommand} */ - public deleteSnapshot( + deleteSnapshot( args: DeleteSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSnapshot( - args: DeleteSnapshotCommandInput, - cb: (err: any, data?: DeleteSnapshotCommandOutput) => void - ): void; - public deleteSnapshot( + deleteSnapshot(args: DeleteSnapshotCommandInput, cb: (err: any, data?: DeleteSnapshotCommandOutput) => void): void; + deleteSnapshot( args: DeleteSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSnapshotCommandOutput) => void ): void; - public deleteSnapshot( - args: DeleteSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSnapshotCommandOutput) => void), - cb?: (err: any, data?: DeleteSnapshotCommandOutput) => void - ): Promise | void { - const command = new DeleteSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior - * to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail.

+ * @see {@link DeleteStorageVirtualMachineCommand} */ - public deleteStorageVirtualMachine( + deleteStorageVirtualMachine( args: DeleteStorageVirtualMachineCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteStorageVirtualMachine( + deleteStorageVirtualMachine( args: DeleteStorageVirtualMachineCommandInput, cb: (err: any, data?: DeleteStorageVirtualMachineCommandOutput) => void ): void; - public deleteStorageVirtualMachine( + deleteStorageVirtualMachine( args: DeleteStorageVirtualMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStorageVirtualMachineCommandOutput) => void ): void; - public deleteStorageVirtualMachine( - args: DeleteStorageVirtualMachineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStorageVirtualMachineCommandOutput) => void), - cb?: (err: any, data?: DeleteStorageVirtualMachineCommandOutput) => void - ): Promise | void { - const command = new DeleteStorageVirtualMachineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS - * volume.

+ * @see {@link DeleteVolumeCommand} */ - public deleteVolume( - args: DeleteVolumeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteVolume(args: DeleteVolumeCommandInput, cb: (err: any, data?: DeleteVolumeCommandOutput) => void): void; - public deleteVolume( + deleteVolume(args: DeleteVolumeCommandInput, options?: __HttpHandlerOptions): Promise; + deleteVolume(args: DeleteVolumeCommandInput, cb: (err: any, data?: DeleteVolumeCommandOutput) => void): void; + deleteVolume( args: DeleteVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVolumeCommandOutput) => void ): void; - public deleteVolume( - args: DeleteVolumeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVolumeCommandOutput) => void), - cb?: (err: any, data?: DeleteVolumeCommandOutput) => void - ): Promise | void { - const command = new DeleteVolumeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the description of a specific Amazon FSx backup, if a - * BackupIds value is provided for that backup. Otherwise, it returns all - * backups owned by your Amazon Web Services account in the Amazon Web Services Region of the - * endpoint that you're calling.

- *

When retrieving all backups, you can optionally specify the MaxResults - * parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, - * send a later request with the NextToken request parameter set to the value - * of the NextToken value from the last response.

- *

This operation is used in an iterative process to retrieve a list of your backups. - * DescribeBackups is called first without a NextToken value. - * Then the operation continues to be called with the NextToken parameter set - * to the value of the last NextToken value until a response has no - * NextToken value.

- *

When using this operation, keep the following in mind:

- *
    - *
  • - *

    The operation might return fewer than the MaxResults value of - * backup descriptions while still including a NextToken - * value.

    - *
  • - *
  • - *

    The order of the backups returned in the response of one - * DescribeBackups call and the order of the backups returned - * across the responses of a multi-call iteration is unspecified.

    - *
  • - *
+ * @see {@link DescribeBackupsCommand} */ - public describeBackups( + describeBackups( args: DescribeBackupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBackups( - args: DescribeBackupsCommandInput, - cb: (err: any, data?: DescribeBackupsCommandOutput) => void - ): void; - public describeBackups( + describeBackups(args: DescribeBackupsCommandInput, cb: (err: any, data?: DescribeBackupsCommandOutput) => void): void; + describeBackups( args: DescribeBackupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBackupsCommandOutput) => void ): void; - public describeBackups( - args: DescribeBackupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBackupsCommandOutput) => void), - cb?: (err: any, data?: DescribeBackupsCommandOutput) => void - ): Promise | void { - const command = new DescribeBackupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the description of specific Amazon FSx for Lustre or Amazon File Cache - * data repository associations, if one or more AssociationIds values - * are provided in the request, or if filters are used in the request. Data repository - * associations are supported on Amazon File Cache resources and all Amazon FSx for - * Lustre file systems excluding Scratch_1 deployment types.

- *

You can use filters to narrow the response to include just data repository - * associations for specific file systems (use the file-system-id filter with - * the ID of the file system) or caches (use the file-cache-id filter with - * the ID of the cache), or data repository associations for a specific repository type - * (use the data-repository-type filter with a value of S3 - * or NFS). If you don't use filters, the response returns all data - * repository associations owned by your Amazon Web Services account in the Amazon Web Services Region - * of the endpoint that you're calling.

- *

When retrieving all data repository associations, you can paginate the response by using - * the optional MaxResults parameter to limit the number of data repository associations - * returned in a response. If more data repository associations remain, a - * NextToken value is returned in the response. In this case, send a later - * request with the NextToken request parameter set to the value of - * NextToken from the last response.

+ * @see {@link DescribeDataRepositoryAssociationsCommand} */ - public describeDataRepositoryAssociations( + describeDataRepositoryAssociations( args: DescribeDataRepositoryAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDataRepositoryAssociations( + describeDataRepositoryAssociations( args: DescribeDataRepositoryAssociationsCommandInput, cb: (err: any, data?: DescribeDataRepositoryAssociationsCommandOutput) => void ): void; - public describeDataRepositoryAssociations( + describeDataRepositoryAssociations( args: DescribeDataRepositoryAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataRepositoryAssociationsCommandOutput) => void ): void; - public describeDataRepositoryAssociations( - args: DescribeDataRepositoryAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDataRepositoryAssociationsCommandOutput) => void), - cb?: (err: any, data?: DescribeDataRepositoryAssociationsCommandOutput) => void - ): Promise | void { - const command = new DescribeDataRepositoryAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if - * one or more TaskIds values are provided in the request, or if filters are used in the request. - * You can use filters to narrow the response to include just tasks for specific file systems or caches, - * or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned - * by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

- *

When retrieving all tasks, you can paginate the response by using the optional MaxResults - * parameter to limit the number of tasks returned in a response. If more tasks remain, - * a NextToken value is returned in the response. In this case, send a later - * request with the NextToken request parameter set to the value of - * NextToken from the last response.

+ * @see {@link DescribeDataRepositoryTasksCommand} */ - public describeDataRepositoryTasks( + describeDataRepositoryTasks( args: DescribeDataRepositoryTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDataRepositoryTasks( + describeDataRepositoryTasks( args: DescribeDataRepositoryTasksCommandInput, cb: (err: any, data?: DescribeDataRepositoryTasksCommandOutput) => void ): void; - public describeDataRepositoryTasks( + describeDataRepositoryTasks( args: DescribeDataRepositoryTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataRepositoryTasksCommandOutput) => void ): void; - public describeDataRepositoryTasks( - args: DescribeDataRepositoryTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDataRepositoryTasksCommandOutput) => void), - cb?: (err: any, data?: DescribeDataRepositoryTasksCommandOutput) => void - ): Promise | void { - const command = new DescribeDataRepositoryTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the description of a specific Amazon File Cache resource, if a - * FileCacheIds value is provided for that cache. Otherwise, it - * returns descriptions of all caches owned by your Amazon Web Services account in the - * Amazon Web Services Region of the endpoint that you're calling.

- *

When retrieving all cache descriptions, you can optionally specify the - * MaxResults parameter to limit the number of descriptions in a response. - * If more cache descriptions remain, the operation returns a - * NextToken value in the response. In this case, send a later request - * with the NextToken request parameter set to the value of - * NextToken from the last response.

- *

This operation is used in an iterative process to retrieve a list of your cache - * descriptions. DescribeFileCaches is called first without a - * NextTokenvalue. Then the operation continues to be called with the - * NextToken parameter set to the value of the last NextToken - * value until a response has no NextToken.

- *

When using this operation, keep the following in mind:

- *
    - *
  • - *

    The implementation might return fewer than MaxResults - * cache descriptions while still including a NextToken - * value.

    - *
  • - *
  • - *

    The order of caches returned in the response of one - * DescribeFileCaches call and the order of caches returned - * across the responses of a multicall iteration is unspecified.

    - *
  • - *
+ * @see {@link DescribeFileCachesCommand} */ - public describeFileCaches( + describeFileCaches( args: DescribeFileCachesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFileCaches( + describeFileCaches( args: DescribeFileCachesCommandInput, cb: (err: any, data?: DescribeFileCachesCommandOutput) => void ): void; - public describeFileCaches( + describeFileCaches( args: DescribeFileCachesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFileCachesCommandOutput) => void ): void; - public describeFileCaches( - args: DescribeFileCachesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFileCachesCommandOutput) => void), - cb?: (err: any, data?: DescribeFileCachesCommandOutput) => void - ): Promise | void { - const command = new DescribeFileCachesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of - * all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction - * provided in the DescribeFileSystems operation response.

+ * @see {@link DescribeFileSystemAliasesCommand} */ - public describeFileSystemAliases( + describeFileSystemAliases( args: DescribeFileSystemAliasesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFileSystemAliases( + describeFileSystemAliases( args: DescribeFileSystemAliasesCommandInput, cb: (err: any, data?: DescribeFileSystemAliasesCommandOutput) => void ): void; - public describeFileSystemAliases( + describeFileSystemAliases( args: DescribeFileSystemAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFileSystemAliasesCommandOutput) => void ): void; - public describeFileSystemAliases( - args: DescribeFileSystemAliasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFileSystemAliasesCommandOutput) => void), - cb?: (err: any, data?: DescribeFileSystemAliasesCommandOutput) => void - ): Promise | void { - const command = new DescribeFileSystemAliasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the description of specific Amazon FSx file systems, if a - * FileSystemIds value is provided for that file system. Otherwise, it - * returns descriptions of all file systems owned by your Amazon Web Services account in the - * Amazon Web Services Region of the endpoint that you're calling.

- *

When retrieving all file system descriptions, you can optionally specify the - * MaxResults parameter to limit the number of descriptions in a response. - * If more file system descriptions remain, Amazon FSx returns a - * NextToken value in the response. In this case, send a later request - * with the NextToken request parameter set to the value of - * NextToken from the last response.

- *

This operation is used in an iterative process to retrieve a list of your file system - * descriptions. DescribeFileSystems is called first without a - * NextTokenvalue. Then the operation continues to be called with the - * NextToken parameter set to the value of the last NextToken - * value until a response has no NextToken.

- *

When using this operation, keep the following in mind:

- *
    - *
  • - *

    The implementation might return fewer than MaxResults file - * system descriptions while still including a NextToken - * value.

    - *
  • - *
  • - *

    The order of file systems returned in the response of one - * DescribeFileSystems call and the order of file systems returned - * across the responses of a multicall iteration is unspecified.

    - *
  • - *
+ * @see {@link DescribeFileSystemsCommand} */ - public describeFileSystems( + describeFileSystems( args: DescribeFileSystemsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFileSystems( + describeFileSystems( args: DescribeFileSystemsCommandInput, cb: (err: any, data?: DescribeFileSystemsCommandOutput) => void ): void; - public describeFileSystems( + describeFileSystems( args: DescribeFileSystemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFileSystemsCommandOutput) => void ): void; - public describeFileSystems( - args: DescribeFileSystemsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFileSystemsCommandOutput) => void), - cb?: (err: any, data?: DescribeFileSystemsCommandOutput) => void - ): Promise | void { - const command = new DescribeFileSystemsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the description of specific Amazon FSx for OpenZFS snapshots, if a - * SnapshotIds value is provided. Otherwise, this operation returns all - * snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of - * the endpoint that you're calling.

- *

When retrieving all snapshots, you can optionally specify the MaxResults - * parameter to limit the number of snapshots in a response. If more backups remain, - * Amazon FSx returns a NextToken value in the response. In this - * case, send a later request with the NextToken request parameter set to the - * value of NextToken from the last response.

- *

Use this operation in an iterative process to retrieve a list of your snapshots. - * DescribeSnapshots is called first without a NextToken - * value. Then the operation continues to be called with the NextToken - * parameter set to the value of the last NextToken value until a response has - * no NextToken value.

- *

When using this operation, keep the following in mind:

- *
    - *
  • - *

    The operation might return fewer than the MaxResults value of - * snapshot descriptions while still including a NextToken - * value.

    - *
  • - *
  • - *

    The order of snapshots returned in the response of one - * DescribeSnapshots call and the order of backups returned across - * the responses of a multi-call iteration is unspecified.

    - *
  • - *
+ * @see {@link DescribeSnapshotsCommand} */ - public describeSnapshots( + describeSnapshots( args: DescribeSnapshotsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSnapshots( + describeSnapshots( args: DescribeSnapshotsCommandInput, cb: (err: any, data?: DescribeSnapshotsCommandOutput) => void ): void; - public describeSnapshots( + describeSnapshots( args: DescribeSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSnapshotsCommandOutput) => void ): void; - public describeSnapshots( - args: DescribeSnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSnapshotsCommandOutput) => void), - cb?: (err: any, data?: DescribeSnapshotsCommandOutput) => void - ): Promise | void { - const command = new DescribeSnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).

+ * @see {@link DescribeStorageVirtualMachinesCommand} */ - public describeStorageVirtualMachines( + describeStorageVirtualMachines( args: DescribeStorageVirtualMachinesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStorageVirtualMachines( + describeStorageVirtualMachines( args: DescribeStorageVirtualMachinesCommandInput, cb: (err: any, data?: DescribeStorageVirtualMachinesCommandOutput) => void ): void; - public describeStorageVirtualMachines( + describeStorageVirtualMachines( args: DescribeStorageVirtualMachinesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStorageVirtualMachinesCommandOutput) => void ): void; - public describeStorageVirtualMachines( - args: DescribeStorageVirtualMachinesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStorageVirtualMachinesCommandOutput) => void), - cb?: (err: any, data?: DescribeStorageVirtualMachinesCommandOutput) => void - ): Promise | void { - const command = new DescribeStorageVirtualMachinesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for - * OpenZFS volumes.

+ * @see {@link DescribeVolumesCommand} */ - public describeVolumes( + describeVolumes( args: DescribeVolumesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVolumes( - args: DescribeVolumesCommandInput, - cb: (err: any, data?: DescribeVolumesCommandOutput) => void - ): void; - public describeVolumes( + describeVolumes(args: DescribeVolumesCommandInput, cb: (err: any, data?: DescribeVolumesCommandOutput) => void): void; + describeVolumes( args: DescribeVolumesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVolumesCommandOutput) => void ): void; - public describeVolumes( - args: DescribeVolumesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVolumesCommandOutput) => void), - cb?: (err: any, data?: DescribeVolumesCommandOutput) => void - ): Promise | void { - const command = new DescribeVolumesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases - * from an Amazon FSx for Windows File Server file system. If you attempt to disassociate a DNS alias that is not - * associated with the file system, Amazon FSx responds with a 400 Bad Request. For more information, see - * Working with DNS Aliases.

- *

The system generated response showing the DNS aliases that - * Amazon FSx is attempting to disassociate from the file system. - * Use the API - * operation to monitor the status of the aliases Amazon FSx is - * disassociating with the file system.

+ * @see {@link DisassociateFileSystemAliasesCommand} */ - public disassociateFileSystemAliases( + disassociateFileSystemAliases( args: DisassociateFileSystemAliasesCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateFileSystemAliases( + disassociateFileSystemAliases( args: DisassociateFileSystemAliasesCommandInput, cb: (err: any, data?: DisassociateFileSystemAliasesCommandOutput) => void ): void; - public disassociateFileSystemAliases( + disassociateFileSystemAliases( args: DisassociateFileSystemAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateFileSystemAliasesCommandOutput) => void ): void; - public disassociateFileSystemAliases( - args: DisassociateFileSystemAliasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateFileSystemAliasesCommandOutput) => void), - cb?: (err: any, data?: DisassociateFileSystemAliasesCommandOutput) => void - ): Promise | void { - const command = new DisassociateFileSystemAliasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists tags for Amazon FSx resources.

- *

When retrieving all tags, you can optionally specify the MaxResults - * parameter to limit the number of tags in a response. If more tags remain, Amazon FSx - * returns a NextToken value in the response. In this case, send a later - * request with the NextToken request parameter set to the value of - * NextToken from the last response.

- *

This action is used in an iterative process to retrieve a list of your tags. - * ListTagsForResource is called first without a - * NextTokenvalue. Then the action continues to be called with the - * NextToken parameter set to the value of the last NextToken - * value until a response has no NextToken.

- *

When using this action, keep the following in mind:

- *
    - *
  • - *

    The implementation might return fewer than MaxResults file - * system descriptions while still including a NextToken - * value.

    - *
  • - *
  • - *

    The order of tags returned in the response of one - * ListTagsForResource call and the order of tags returned across - * the responses of a multi-call iteration is unspecified.

    - *
  • - *
+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Releases the file system lock from an Amazon FSx for OpenZFS file - * system.

+ * @see {@link ReleaseFileSystemNfsV3LocksCommand} */ - public releaseFileSystemNfsV3Locks( + releaseFileSystemNfsV3Locks( args: ReleaseFileSystemNfsV3LocksCommandInput, options?: __HttpHandlerOptions ): Promise; - public releaseFileSystemNfsV3Locks( + releaseFileSystemNfsV3Locks( args: ReleaseFileSystemNfsV3LocksCommandInput, cb: (err: any, data?: ReleaseFileSystemNfsV3LocksCommandOutput) => void ): void; - public releaseFileSystemNfsV3Locks( + releaseFileSystemNfsV3Locks( args: ReleaseFileSystemNfsV3LocksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReleaseFileSystemNfsV3LocksCommandOutput) => void ): void; - public releaseFileSystemNfsV3Locks( - args: ReleaseFileSystemNfsV3LocksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReleaseFileSystemNfsV3LocksCommandOutput) => void), - cb?: (err: any, data?: ReleaseFileSystemNfsV3LocksCommandOutput) => void - ): Promise | void { - const command = new ReleaseFileSystemNfsV3LocksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an Amazon FSx for OpenZFS volume to the state saved by the specified - * snapshot.

+ * @see {@link RestoreVolumeFromSnapshotCommand} */ - public restoreVolumeFromSnapshot( + restoreVolumeFromSnapshot( args: RestoreVolumeFromSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreVolumeFromSnapshot( + restoreVolumeFromSnapshot( args: RestoreVolumeFromSnapshotCommandInput, cb: (err: any, data?: RestoreVolumeFromSnapshotCommandOutput) => void ): void; - public restoreVolumeFromSnapshot( + restoreVolumeFromSnapshot( args: RestoreVolumeFromSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreVolumeFromSnapshotCommandOutput) => void ): void; - public restoreVolumeFromSnapshot( - args: RestoreVolumeFromSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreVolumeFromSnapshotCommandOutput) => void), - cb?: (err: any, data?: RestoreVolumeFromSnapshotCommandOutput) => void - ): Promise | void { - const command = new RestoreVolumeFromSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Tags an Amazon FSx resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This action removes a tag from an Amazon FSx resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the configuration of an existing data repository association - * on an Amazon FSx for Lustre file system. Data repository associations - * are supported for all file systems except for Scratch_1 - * deployment type.

+ * @see {@link UpdateDataRepositoryAssociationCommand} */ - public updateDataRepositoryAssociation( + updateDataRepositoryAssociation( args: UpdateDataRepositoryAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDataRepositoryAssociation( + updateDataRepositoryAssociation( args: UpdateDataRepositoryAssociationCommandInput, cb: (err: any, data?: UpdateDataRepositoryAssociationCommandOutput) => void ): void; - public updateDataRepositoryAssociation( + updateDataRepositoryAssociation( args: UpdateDataRepositoryAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDataRepositoryAssociationCommandOutput) => void ): void; - public updateDataRepositoryAssociation( - args: UpdateDataRepositoryAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDataRepositoryAssociationCommandOutput) => void), - cb?: (err: any, data?: UpdateDataRepositoryAssociationCommandOutput) => void - ): Promise | void { - const command = new UpdateDataRepositoryAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the configuration of an existing Amazon File Cache resource. - * You can update multiple properties in a single request.

+ * @see {@link UpdateFileCacheCommand} */ - public updateFileCache( + updateFileCache( args: UpdateFileCacheCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFileCache( - args: UpdateFileCacheCommandInput, - cb: (err: any, data?: UpdateFileCacheCommandOutput) => void - ): void; - public updateFileCache( + updateFileCache(args: UpdateFileCacheCommandInput, cb: (err: any, data?: UpdateFileCacheCommandOutput) => void): void; + updateFileCache( args: UpdateFileCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFileCacheCommandOutput) => void ): void; - public updateFileCache( - args: UpdateFileCacheCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFileCacheCommandOutput) => void), - cb?: (err: any, data?: UpdateFileCacheCommandOutput) => void - ): Promise | void { - const command = new UpdateFileCacheCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this operation to update the configuration of an existing Amazon FSx file - * system. You can update multiple properties in a single request.

- *

For FSx for Windows File Server file systems, you can update the following - * properties:

- *
    - *
  • - *

    - * AuditLogConfiguration - *

    - *
  • - *
  • - *

    - * AutomaticBackupRetentionDays - *

    - *
  • - *
  • - *

    - * DailyAutomaticBackupStartTime - *

    - *
  • - *
  • - *

    - * SelfManagedActiveDirectoryConfiguration - *

    - *
  • - *
  • - *

    - * StorageCapacity - *

    - *
  • - *
  • - *

    - * ThroughputCapacity - *

    - *
  • - *
  • - *

    - * WeeklyMaintenanceStartTime - *

    - *
  • - *
- *

For FSx for Lustre file systems, you can update the following - * properties:

- *
    - *
  • - *

    - * AutoImportPolicy - *

    - *
  • - *
  • - *

    - * AutomaticBackupRetentionDays - *

    - *
  • - *
  • - *

    - * DailyAutomaticBackupStartTime - *

    - *
  • - *
  • - *

    - * DataCompressionType - *

    - *
  • - *
  • - *

    - * LustreRootSquashConfiguration - *

    - *
  • - *
  • - *

    - * StorageCapacity - *

    - *
  • - *
  • - *

    - * WeeklyMaintenanceStartTime - *

    - *
  • - *
- *

For FSx for ONTAP file systems, you can update the following - * properties:

- *
    - *
  • - *

    - * AddRouteTableIds - *

    - *
  • - *
  • - *

    - * AutomaticBackupRetentionDays - *

    - *
  • - *
  • - *

    - * DailyAutomaticBackupStartTime - *

    - *
  • - *
  • - *

    - * DiskIopsConfiguration - *

    - *
  • - *
  • - *

    - * FsxAdminPassword - *

    - *
  • - *
  • - *

    - * RemoveRouteTableIds - *

    - *
  • - *
  • - *

    - * StorageCapacity - *

    - *
  • - *
  • - *

    - * ThroughputCapacity - *

    - *
  • - *
  • - *

    - * WeeklyMaintenanceStartTime - *

    - *
  • - *
- *

For FSx for OpenZFS file systems, you can update the following - * properties:

- *
    - *
  • - *

    - * AutomaticBackupRetentionDays - *

    - *
  • - *
  • - *

    - * CopyTagsToBackups - *

    - *
  • - *
  • - *

    - * CopyTagsToVolumes - *

    - *
  • - *
  • - *

    - * DailyAutomaticBackupStartTime - *

    - *
  • - *
  • - *

    - * DiskIopsConfiguration - *

    - *
  • - *
  • - *

    - * StorageCapacity - *

    - *
  • - *
  • - *

    - * ThroughputCapacity - *

    - *
  • - *
  • - *

    - * WeeklyMaintenanceStartTime - *

    - *
  • - *
+ * @see {@link UpdateFileSystemCommand} */ - public updateFileSystem( + updateFileSystem( args: UpdateFileSystemCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFileSystem( + updateFileSystem( args: UpdateFileSystemCommandInput, cb: (err: any, data?: UpdateFileSystemCommandOutput) => void ): void; - public updateFileSystem( + updateFileSystem( args: UpdateFileSystemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFileSystemCommandOutput) => void ): void; - public updateFileSystem( - args: UpdateFileSystemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFileSystemCommandOutput) => void), - cb?: (err: any, data?: UpdateFileSystemCommandOutput) => void - ): Promise | void { - const command = new UpdateFileSystemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the name of an Amazon FSx for OpenZFS snapshot.

+ * @see {@link UpdateSnapshotCommand} */ - public updateSnapshot( + updateSnapshot( args: UpdateSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSnapshot( - args: UpdateSnapshotCommandInput, - cb: (err: any, data?: UpdateSnapshotCommandOutput) => void - ): void; - public updateSnapshot( + updateSnapshot(args: UpdateSnapshotCommandInput, cb: (err: any, data?: UpdateSnapshotCommandOutput) => void): void; + updateSnapshot( args: UpdateSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSnapshotCommandOutput) => void ): void; - public updateSnapshot( - args: UpdateSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSnapshotCommandOutput) => void), - cb?: (err: any, data?: UpdateSnapshotCommandOutput) => void - ): Promise | void { - const command = new UpdateSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an Amazon FSx for ONTAP storage virtual machine (SVM).

+ * @see {@link UpdateStorageVirtualMachineCommand} */ - public updateStorageVirtualMachine( + updateStorageVirtualMachine( args: UpdateStorageVirtualMachineCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateStorageVirtualMachine( + updateStorageVirtualMachine( args: UpdateStorageVirtualMachineCommandInput, cb: (err: any, data?: UpdateStorageVirtualMachineCommandOutput) => void ): void; - public updateStorageVirtualMachine( + updateStorageVirtualMachine( args: UpdateStorageVirtualMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStorageVirtualMachineCommandOutput) => void ): void; - public updateStorageVirtualMachine( - args: UpdateStorageVirtualMachineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStorageVirtualMachineCommandOutput) => void), - cb?: (err: any, data?: UpdateStorageVirtualMachineCommandOutput) => void - ): Promise | void { - const command = new UpdateStorageVirtualMachineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.

+ * @see {@link UpdateVolumeCommand} */ - public updateVolume( - args: UpdateVolumeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateVolume(args: UpdateVolumeCommandInput, cb: (err: any, data?: UpdateVolumeCommandOutput) => void): void; - public updateVolume( + updateVolume(args: UpdateVolumeCommandInput, options?: __HttpHandlerOptions): Promise; + updateVolume(args: UpdateVolumeCommandInput, cb: (err: any, data?: UpdateVolumeCommandOutput) => void): void; + updateVolume( args: UpdateVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVolumeCommandOutput) => void ): void; - public updateVolume( - args: UpdateVolumeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVolumeCommandOutput) => void), - cb?: (err: any, data?: UpdateVolumeCommandOutput) => void - ): Promise | void { - const command = new UpdateVolumeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon FSx is a fully managed service that makes it easy for storage and + * application administrators to launch and use shared file storage.

+ */ +export class FSx extends FSxClient implements FSx {} +createAggregatedClient(commands, FSx); diff --git a/clients/client-gamelift/src/GameLift.ts b/clients/client-gamelift/src/GameLift.ts index 23afd975058d..19cceadb221b 100644 --- a/clients/client-gamelift/src/GameLift.ts +++ b/clients/client-gamelift/src/GameLift.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { AcceptMatchCommand, AcceptMatchCommandInput, AcceptMatchCommandOutput } from "./commands/AcceptMatchCommand"; @@ -461,5563 +462,1783 @@ import { ValidateMatchmakingRuleSetCommandInput, ValidateMatchmakingRuleSetCommandOutput, } from "./commands/ValidateMatchmakingRuleSetCommand"; -import { GameLiftClient } from "./GameLiftClient"; +import { GameLiftClient, GameLiftClientConfig } from "./GameLiftClient"; -/** - * @public - *

Amazon GameLift provides solutions for hosting session-based multiplayer game servers in the - * cloud, including tools for deploying, operating, and scaling game servers. Built on - * Amazon Web Services global computing infrastructure, GameLift helps you deliver high-performance, - * high-reliability, low-cost game servers while dynamically scaling your resource usage to - * meet player demand.

- *

- * About GameLift solutions - *

- *

Get more information on these GameLift solutions in the GameLift Developer Guide.

- *
    - *
  • - *

    GameLift managed hosting -- GameLift offers a fully managed service to set up - * and maintain computing machines for hosting, manage game session and player - * session life cycle, and handle security, storage, and performance tracking. You - * can use automatic scaling tools to balance player demand and hosting costs, - * configure your game session management to minimize player latency, and add - * FlexMatch for matchmaking.

    - *
  • - *
  • - *

    Managed hosting with Realtime Servers -- With GameLift Realtime Servers, you can quickly configure - * and set up ready-to-go game servers for your game. Realtime Servers provides a game server - * framework with core GameLift infrastructure already built in. Then use the full - * range of GameLift managed hosting features, including FlexMatch, for your - * game.

    - *
  • - *
  • - *

    GameLift FleetIQ -- Use GameLift FleetIQ as a standalone service while hosting your games using EC2 - * instances and Auto Scaling groups. GameLift FleetIQ provides optimizations for game - * hosting, including boosting the viability of low-cost Spot Instances gaming. For - * a complete solution, pair the GameLift FleetIQ and FlexMatch standalone services.

    - *
  • - *
  • - *

    GameLift FlexMatch -- Add matchmaking to your game hosting solution. FlexMatch is a - * customizable matchmaking service for multiplayer games. Use FlexMatch as - * integrated with GameLift managed hosting or incorporate FlexMatch as a standalone - * service into your own hosting solution.

    - *
  • - *
- *

- * About this API Reference - *

- *

This reference guide describes the low-level service API for Amazon GameLift. With each topic - * in this guide, you can find links to language-specific SDK guides and the Amazon Web Services CLI - * reference. Useful links:

- * - */ -export class GameLift extends GameLiftClient { +const commands = { + AcceptMatchCommand, + ClaimGameServerCommand, + CreateAliasCommand, + CreateBuildCommand, + CreateFleetCommand, + CreateFleetLocationsCommand, + CreateGameServerGroupCommand, + CreateGameSessionCommand, + CreateGameSessionQueueCommand, + CreateLocationCommand, + CreateMatchmakingConfigurationCommand, + CreateMatchmakingRuleSetCommand, + CreatePlayerSessionCommand, + CreatePlayerSessionsCommand, + CreateScriptCommand, + CreateVpcPeeringAuthorizationCommand, + CreateVpcPeeringConnectionCommand, + DeleteAliasCommand, + DeleteBuildCommand, + DeleteFleetCommand, + DeleteFleetLocationsCommand, + DeleteGameServerGroupCommand, + DeleteGameSessionQueueCommand, + DeleteLocationCommand, + DeleteMatchmakingConfigurationCommand, + DeleteMatchmakingRuleSetCommand, + DeleteScalingPolicyCommand, + DeleteScriptCommand, + DeleteVpcPeeringAuthorizationCommand, + DeleteVpcPeeringConnectionCommand, + DeregisterComputeCommand, + DeregisterGameServerCommand, + DescribeAliasCommand, + DescribeBuildCommand, + DescribeComputeCommand, + DescribeEC2InstanceLimitsCommand, + DescribeFleetAttributesCommand, + DescribeFleetCapacityCommand, + DescribeFleetEventsCommand, + DescribeFleetLocationAttributesCommand, + DescribeFleetLocationCapacityCommand, + DescribeFleetLocationUtilizationCommand, + DescribeFleetPortSettingsCommand, + DescribeFleetUtilizationCommand, + DescribeGameServerCommand, + DescribeGameServerGroupCommand, + DescribeGameServerInstancesCommand, + DescribeGameSessionDetailsCommand, + DescribeGameSessionPlacementCommand, + DescribeGameSessionQueuesCommand, + DescribeGameSessionsCommand, + DescribeInstancesCommand, + DescribeMatchmakingCommand, + DescribeMatchmakingConfigurationsCommand, + DescribeMatchmakingRuleSetsCommand, + DescribePlayerSessionsCommand, + DescribeRuntimeConfigurationCommand, + DescribeScalingPoliciesCommand, + DescribeScriptCommand, + DescribeVpcPeeringAuthorizationsCommand, + DescribeVpcPeeringConnectionsCommand, + GetComputeAccessCommand, + GetComputeAuthTokenCommand, + GetGameSessionLogUrlCommand, + GetInstanceAccessCommand, + ListAliasesCommand, + ListBuildsCommand, + ListComputeCommand, + ListFleetsCommand, + ListGameServerGroupsCommand, + ListGameServersCommand, + ListLocationsCommand, + ListScriptsCommand, + ListTagsForResourceCommand, + PutScalingPolicyCommand, + RegisterComputeCommand, + RegisterGameServerCommand, + RequestUploadCredentialsCommand, + ResolveAliasCommand, + ResumeGameServerGroupCommand, + SearchGameSessionsCommand, + StartFleetActionsCommand, + StartGameSessionPlacementCommand, + StartMatchBackfillCommand, + StartMatchmakingCommand, + StopFleetActionsCommand, + StopGameSessionPlacementCommand, + StopMatchmakingCommand, + SuspendGameServerGroupCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAliasCommand, + UpdateBuildCommand, + UpdateFleetAttributesCommand, + UpdateFleetCapacityCommand, + UpdateFleetPortSettingsCommand, + UpdateGameServerCommand, + UpdateGameServerGroupCommand, + UpdateGameSessionCommand, + UpdateGameSessionQueueCommand, + UpdateMatchmakingConfigurationCommand, + UpdateRuntimeConfigurationCommand, + UpdateScriptCommand, + ValidateMatchmakingRuleSetCommand, +}; + +export interface GameLift { /** - * @public - *

Registers a player's acceptance or rejection of a proposed FlexMatch match. A - * matchmaking configuration may require player acceptance; if so, then matches built with - * that configuration cannot be completed unless all players accept the proposed match - * within a specified time limit.

- *

When FlexMatch builds a match, all the matchmaking tickets involved in the proposed - * match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for - * your game to get acceptance from all players in the ticket. Acceptances are only valid - * for tickets when they are in this status; all other acceptances result in an - * error.

- *

To register acceptance, specify the ticket ID, a response, and one or more players. - * Once all players have registered acceptance, the matchmaking tickets advance to status - * PLACING, where a new game session is created for the match.

- *

If any player rejects the match, or if acceptances are not received before a specified - * timeout, the proposed match is dropped. The matchmaking tickets are then handled in one - * of two ways: For tickets where one or more players rejected the match or failed to - * respond, the ticket status is set to CANCELLED, and processing is - * terminated. For tickets where players have accepted or not yet responded, the ticket - * status is returned to SEARCHING to find a new match. A new matchmaking - * request for these players can be submitted as needed.

- *

- * Learn more - *

- *

- * - * Add FlexMatch to a game client - *

- *

- * - * FlexMatch events (reference)

+ * @see {@link AcceptMatchCommand} */ - public acceptMatch(args: AcceptMatchCommandInput, options?: __HttpHandlerOptions): Promise; - public acceptMatch(args: AcceptMatchCommandInput, cb: (err: any, data?: AcceptMatchCommandOutput) => void): void; - public acceptMatch( + acceptMatch(args: AcceptMatchCommandInput, options?: __HttpHandlerOptions): Promise; + acceptMatch(args: AcceptMatchCommandInput, cb: (err: any, data?: AcceptMatchCommandOutput) => void): void; + acceptMatch( args: AcceptMatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptMatchCommandOutput) => void ): void; - public acceptMatch( - args: AcceptMatchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptMatchCommandOutput) => void), - cb?: (err: any, data?: AcceptMatchCommandOutput) => void - ): Promise | void { - const command = new AcceptMatchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * This operation is used with the GameLift FleetIQ solution and game server groups. - *

- *

Locates an available game server and - * temporarily reserves it to host gameplay and players. This operation is called from a - * game client or client service (such as a matchmaker) to request hosting resources for a - * new game session. In response, GameLift FleetIQ locates an available game server, places it in - * CLAIMED status for 60 seconds, and returns connection information that - * players can use to connect to the game server.

- *

To claim a game server, identify a game server group. You can also specify a game - * server ID, although this approach bypasses GameLift FleetIQ placement optimization. Optionally, - * include game data to pass to the game server at the start of a game session, such as a - * game map or player information.

- *

When a game server is successfully claimed, connection information is returned. A - * claimed game server's utilization status remains AVAILABLE while the claim - * status is set to CLAIMED for up to 60 seconds. This time period gives the - * game server time to update its status to UTILIZED after players join. If - * the game server's status is not updated within 60 seconds, the game server reverts to - * unclaimed status and is available to be claimed by another request. The claim time - * period is a fixed value and is not configurable.

- *

If you try to claim a specific game server, this request will fail in the following - * cases:

- *
    - *
  • - *

    If the game server utilization status is UTILIZED.

    - *
  • - *
  • - *

    If the game server claim status is CLAIMED.

    - *
  • - *
- * - *

When claiming a specific game server, this request will succeed even if the game - * server is running on an instance in DRAINING status. To avoid this, - * first check the instance status by calling DescribeGameServerInstances .

- *
- *

- * Learn more - *

- *

- * GameLift FleetIQ - * Guide - *

+ * @see {@link ClaimGameServerCommand} */ - public claimGameServer( + claimGameServer( args: ClaimGameServerCommandInput, options?: __HttpHandlerOptions ): Promise; - public claimGameServer( - args: ClaimGameServerCommandInput, - cb: (err: any, data?: ClaimGameServerCommandOutput) => void - ): void; - public claimGameServer( + claimGameServer(args: ClaimGameServerCommandInput, cb: (err: any, data?: ClaimGameServerCommandOutput) => void): void; + claimGameServer( args: ClaimGameServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ClaimGameServerCommandOutput) => void ): void; - public claimGameServer( - args: ClaimGameServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ClaimGameServerCommandOutput) => void), - cb?: (err: any, data?: ClaimGameServerCommandOutput) => void - ): Promise | void { - const command = new ClaimGameServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an alias for a fleet. In most situations, you can use an alias ID in place of - * a fleet ID. An alias provides a level of abstraction for a fleet that is useful when - * redirecting player traffic from one fleet to another, such as when updating your game - * build.

- *

Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A - * simple alias points to an active fleet. A terminal alias is used to display messaging or - * link to a URL instead of routing players to an active fleet. For example, you might use - * a terminal alias when a game version is no longer supported and you want to direct - * players to an upgrade site.

- *

To create a fleet alias, specify an alias name, routing strategy, and optional - * description. Each simple alias can point to only one fleet, but a fleet can have - * multiple aliases. If successful, a new alias record is returned, including an alias ID - * and an ARN. You can reassign an alias to another fleet by calling - * UpdateAlias.

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link CreateAliasCommand} */ - public createAlias(args: CreateAliasCommandInput, options?: __HttpHandlerOptions): Promise; - public createAlias(args: CreateAliasCommandInput, cb: (err: any, data?: CreateAliasCommandOutput) => void): void; - public createAlias( + createAlias(args: CreateAliasCommandInput, options?: __HttpHandlerOptions): Promise; + createAlias(args: CreateAliasCommandInput, cb: (err: any, data?: CreateAliasCommandOutput) => void): void; + createAlias( args: CreateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAliasCommandOutput) => void ): void; - public createAlias( - args: CreateAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAliasCommandOutput) => void), - cb?: (err: any, data?: CreateAliasCommandOutput) => void - ): Promise | void { - const command = new CreateAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new Amazon GameLift build resource for your game server binary files. Combine game - * server binaries into a zip file for use with Amazon GameLift.

- * - *

When setting up a new game build for GameLift, we recommend using the CLI command - * upload-build - * . This helper command combines two tasks: (1) it - * uploads your build files from a file directory to a GameLift Amazon S3 location, and (2) - * it creates a new build resource.

- *
- *

You can use the operation in the following scenarios:

- *
    - *
  • - *

    To create a new game build with build files that are in an Amazon S3 location under - * an Amazon Web Services account that you control. To use this option, you give Amazon GameLift access to - * the Amazon S3 bucket. With permissions in place, specify a build name, operating - * system, and the Amazon S3 storage location of your game build.

    - *
  • - *
  • - *

    To directly upload your build files to a GameLift Amazon S3 location. To use this - * option, specify a build name and operating system. This operation creates a new - * build resource and also returns an Amazon S3 location with temporary access - * credentials. Use the credentials to manually upload your build files to the - * specified Amazon S3 location. For more information, see Uploading Objects in - * the Amazon S3 Developer Guide. After you upload build files to - * the GameLift Amazon S3 location, you can't update them.

    - *
  • - *
- *

If successful, this operation creates a new build resource with a unique build ID and - * places it in INITIALIZED status. A build must be in READY - * status before you can create fleets with it.

- *

- * Learn more - *

- *

- * Uploading Your - * Game - *

- *

- * Create a Build with Files in Amazon S3 - *

- *

- * All APIs by task - *

+ * @see {@link CreateBuildCommand} */ - public createBuild(args: CreateBuildCommandInput, options?: __HttpHandlerOptions): Promise; - public createBuild(args: CreateBuildCommandInput, cb: (err: any, data?: CreateBuildCommandOutput) => void): void; - public createBuild( + createBuild(args: CreateBuildCommandInput, options?: __HttpHandlerOptions): Promise; + createBuild(args: CreateBuildCommandInput, cb: (err: any, data?: CreateBuildCommandOutput) => void): void; + createBuild( args: CreateBuildCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBuildCommandOutput) => void ): void; - public createBuild( - args: CreateBuildCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBuildCommandOutput) => void), - cb?: (err: any, data?: CreateBuildCommandOutput) => void - ): Promise | void { - const command = new CreateBuildCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a fleet of Amazon Elastic Compute Cloud (Amazon Elastic Compute Cloud) instances to host your - * custom game server or Realtime Servers. Use this operation to configure the computing resources for - * your fleet and provide instructions for running game servers on each instance.

- *

Most GameLift fleets can deploy instances to multiple locations, including the home - * Region (where the fleet is created) and an optional set of remote locations. Fleets that - * are created in the following Amazon Web Services Regions support multiple locations: us-east-1 (N. - * Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland), - * ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets that - * are created in other GameLift Regions can deploy instances in the fleet's home Region - * only. All fleet instances use the same configuration regardless of location; however, - * you can adjust capacity settings and turn auto-scaling on/off for each location.

- *

To create a fleet, choose the hardware for your instances, specify a game server build - * or Realtime script to deploy, and provide a runtime configuration to direct GameLift how - * to start and run game servers on each instance in the fleet. Set permissions for inbound - * traffic to your game servers, and enable optional features as needed. When creating a - * multi-location fleet, provide a list of additional remote locations.

- *

If you need to debug your fleet, fetch logs, view performance metrics or other actions - * on the fleet, create the development fleet with port 22/3389 open. As a best practice, - * we recommend opening ports for remote access only when you need them and closing them - * when you're finished.

- *

If successful, this operation creates a new Fleet resource and places it in - * NEW status, which prompts GameLift to initiate the fleet creation - * workflow.

- *

- * Learn more - *

- *

- * Setting up - * fleets - *

- *

- * Debug fleet creation issues - *

- *

- * Multi-location fleets - *

+ * @see {@link CreateFleetCommand} */ - public createFleet(args: CreateFleetCommandInput, options?: __HttpHandlerOptions): Promise; - public createFleet(args: CreateFleetCommandInput, cb: (err: any, data?: CreateFleetCommandOutput) => void): void; - public createFleet( + createFleet(args: CreateFleetCommandInput, options?: __HttpHandlerOptions): Promise; + createFleet(args: CreateFleetCommandInput, cb: (err: any, data?: CreateFleetCommandOutput) => void): void; + createFleet( args: CreateFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFleetCommandOutput) => void ): void; - public createFleet( - args: CreateFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFleetCommandOutput) => void), - cb?: (err: any, data?: CreateFleetCommandOutput) => void - ): Promise | void { - const command = new CreateFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds remote locations to a fleet and begins populating the new locations with EC2 - * instances. The new instances conform to the fleet's instance type, auto-scaling, and - * other configuration settings.

- * - *

This operation cannot be used with fleets that don't support remote locations. - * Fleets can have multiple locations only if they reside in Amazon Web Services Regions that support - * this feature and were created after the feature was released in March 2021.

- *
- *

To add fleet locations, specify the fleet to be updated and provide a list of one or - * more locations.

- *

If successful, this operation returns the list of added locations with their status - * set to NEW. GameLift initiates the process of starting an instance in each - * added location. You can track the status of each new location by monitoring location - * creation events using DescribeFleetEvents.

- *

- * Learn more - *

- *

- * Setting up - * fleets - *

- *

- * Multi-location fleets - *

+ * @see {@link CreateFleetLocationsCommand} */ - public createFleetLocations( + createFleetLocations( args: CreateFleetLocationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFleetLocations( + createFleetLocations( args: CreateFleetLocationsCommandInput, cb: (err: any, data?: CreateFleetLocationsCommandOutput) => void ): void; - public createFleetLocations( + createFleetLocations( args: CreateFleetLocationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFleetLocationsCommandOutput) => void ): void; - public createFleetLocations( - args: CreateFleetLocationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFleetLocationsCommandOutput) => void), - cb?: (err: any, data?: CreateFleetLocationsCommandOutput) => void - ): Promise | void { - const command = new CreateFleetLocationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * This operation is used with the GameLift FleetIQ solution and game server groups. - *

- *

Creates a GameLift FleetIQ game server - * group for managing game hosting on a collection of Amazon Elastic Compute Cloud instances for game hosting. - * This operation creates the game server group, creates an Auto Scaling group in your - * Amazon Web Services account, and establishes a link between the two groups. You can view the status of - * your game server groups in the GameLift console. Game server group metrics and events are - * emitted to Amazon CloudWatch.

- *

Before creating a new game server group, you must have the following:

- *
    - *
  • - *

    An Amazon Elastic Compute Cloud launch template that specifies how to launch Amazon Elastic Compute Cloud instances - * with your game server build. For more information, see Launching an Instance from a Launch Template in the - * Amazon Elastic Compute Cloud User Guide.

    - *
  • - *
  • - *

    An IAM role that extends limited access to your Amazon Web Services account to allow GameLift FleetIQ - * to create and interact with the Auto Scaling group. For more information, see - * Create IAM - * roles for cross-service interaction in the GameLift FleetIQ Developer - * Guide.

    - *
  • - *
- *

To create a new game server group, specify a unique group name, IAM role and Amazon Elastic Compute Cloud - * launch template, and provide a list of instance types that can be used in the group. You - * must also set initial maximum and minimum limits on the group's instance count. You can - * optionally set an Auto Scaling policy with target tracking based on a GameLift FleetIQ - * metric.

- *

Once the game server group and corresponding Auto Scaling group are created, you have - * full access to change the Auto Scaling group's configuration as needed. Several - * properties that are set when creating a game server group, including maximum/minimum - * size and auto-scaling policy settings, must be updated directly in the Auto Scaling - * group. Keep in mind that some Auto Scaling group properties are periodically updated by - * GameLift FleetIQ as part of its balancing activities to optimize for availability and cost.

- *

- * Learn more - *

- *

- * GameLift FleetIQ - * Guide - *

+ * @see {@link CreateGameServerGroupCommand} */ - public createGameServerGroup( + createGameServerGroup( args: CreateGameServerGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createGameServerGroup( + createGameServerGroup( args: CreateGameServerGroupCommandInput, cb: (err: any, data?: CreateGameServerGroupCommandOutput) => void ): void; - public createGameServerGroup( + createGameServerGroup( args: CreateGameServerGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGameServerGroupCommandOutput) => void ): void; - public createGameServerGroup( - args: CreateGameServerGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGameServerGroupCommandOutput) => void), - cb?: (err: any, data?: CreateGameServerGroupCommandOutput) => void - ): Promise | void { - const command = new CreateGameServerGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a multiplayer game session for players in a specific fleet location. This - * operation prompts an available server process to start a game session and retrieves - * connection information for the new game session. As an alternative, consider using the - * GameLift game session placement feature with StartGameSessionPlacement , which uses FleetIQ algorithms and queues to - * optimize the placement process.

- *

When creating a game session, you specify exactly where you want to place it and - * provide a set of game session configuration settings. The fleet must be in - * ACTIVE status before a game session can be created in it.

- *

This operation can be used in the following ways:

- *
    - *
  • - *

    To create a game session on an instance in a fleet's home Region, provide a - * fleet or alias ID along with your game session configuration.

    - *
  • - *
  • - *

    To create a game session on an instance in a fleet's remote location, provide - * a fleet or alias ID and a location name, along with your game session - * configuration.

    - *
  • - *
- *

If successful, a workflow is initiated to start a new game session. A - * GameSession object is returned containing the game session - * configuration and status. When the status is ACTIVE, game session - * connection information is provided and player sessions can be created for the game - * session. By default, newly created game sessions are open to new players. You can - * restrict new player access by using UpdateGameSession to change the game session's player session creation - * policy.

- *

Game session logs are retained for all active game sessions for 14 days. To access the - * logs, call GetGameSessionLogUrl to download the log files.

- *

- * Available in Amazon GameLift Local. - *

- *

- * Learn more - *

- *

- * Start a game session - *

- *

- * All APIs by task - *

+ * @see {@link CreateGameSessionCommand} */ - public createGameSession( + createGameSession( args: CreateGameSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createGameSession( + createGameSession( args: CreateGameSessionCommandInput, cb: (err: any, data?: CreateGameSessionCommandOutput) => void ): void; - public createGameSession( + createGameSession( args: CreateGameSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGameSessionCommandOutput) => void ): void; - public createGameSession( - args: CreateGameSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGameSessionCommandOutput) => void), - cb?: (err: any, data?: CreateGameSessionCommandOutput) => void - ): Promise | void { - const command = new CreateGameSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a placement queue that processes requests for new game sessions. A queue uses - * FleetIQ algorithms to determine the best placement locations and find an available game - * server there, then prompts the game server process to start a new game session.

- *

A game session queue is configured with a set of destinations (GameLift fleets or - * aliases), which determine the locations where the queue can place new game sessions. - * These destinations can span multiple fleet types (Spot and On-Demand), instance types, - * and Amazon Web Services Regions. If the queue includes multi-location fleets, the queue is able to - * place game sessions in all of a fleet's remote locations. You can opt to filter out - * individual locations if needed.

- *

The queue configuration also determines how FleetIQ selects the best available placement - * for a new game session. Before searching for an available game server, FleetIQ first - * prioritizes the queue's destinations and locations, with the best placement locations on - * top. You can set up the queue to use the FleetIQ default prioritization or provide an - * alternate set of priorities.

- *

To create a new queue, provide a name, timeout value, and a list of destinations. - * Optionally, specify a sort configuration and/or a filter, and define a set of latency - * cap policies. You can also include the ARN for an Amazon Simple Notification Service - * (SNS) topic to receive notifications of game session placement activity. Notifications - * using SNS or CloudWatch events is the preferred way to track placement activity.

- *

If successful, a new GameSessionQueue object is returned with an assigned - * queue ARN. New game session requests, which are submitted to queue with StartGameSessionPlacement or StartMatchmaking, reference a queue's name or ARN.

- *

- * Learn more - *

- *

- * - * Design a game session queue - *

- *

- * - * Create a game session queue - *

- *

- * Related actions - *

- *

- * CreateGameSessionQueue - * | - * DescribeGameSessionQueues - * | - * UpdateGameSessionQueue - * | - * DeleteGameSessionQueue - * | - * All APIs by task - *

+ * @see {@link CreateGameSessionQueueCommand} */ - public createGameSessionQueue( + createGameSessionQueue( args: CreateGameSessionQueueCommandInput, options?: __HttpHandlerOptions ): Promise; - public createGameSessionQueue( + createGameSessionQueue( args: CreateGameSessionQueueCommandInput, cb: (err: any, data?: CreateGameSessionQueueCommandOutput) => void ): void; - public createGameSessionQueue( + createGameSessionQueue( args: CreateGameSessionQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGameSessionQueueCommandOutput) => void ): void; - public createGameSessionQueue( - args: CreateGameSessionQueueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGameSessionQueueCommandOutput) => void), - cb?: (err: any, data?: CreateGameSessionQueueCommandOutput) => void - ): Promise | void { - const command = new CreateGameSessionQueueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a custom location for use in an Anywhere fleet.

+ * @see {@link CreateLocationCommand} */ - public createLocation( + createLocation( args: CreateLocationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLocation( - args: CreateLocationCommandInput, - cb: (err: any, data?: CreateLocationCommandOutput) => void - ): void; - public createLocation( + createLocation(args: CreateLocationCommandInput, cb: (err: any, data?: CreateLocationCommandOutput) => void): void; + createLocation( args: CreateLocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocationCommandOutput) => void ): void; - public createLocation( - args: CreateLocationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLocationCommandOutput) => void), - cb?: (err: any, data?: CreateLocationCommandOutput) => void - ): Promise | void { - const command = new CreateLocationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Defines a new matchmaking configuration for use with FlexMatch. Whether your are using - * FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking - * configuration sets out rules for matching players and forming teams. If you're also - * using GameLift hosting, it defines how to start game sessions for each match. Your - * matchmaking system can use multiple configurations to handle different game scenarios. - * All matchmaking requests identify the matchmaking configuration to use and provide - * player attributes consistent with that configuration.

- *

To create a matchmaking configuration, you must provide the following: configuration - * name and FlexMatch mode (with or without GameLift hosting); a rule set that specifies how - * to evaluate players and find acceptable matches; whether player acceptance is required; - * and the maximum time allowed for a matchmaking attempt. When using FlexMatch with GameLift - * hosting, you also need to identify the game session queue to use when starting a game - * session for the match.

- *

In addition, you must set up an Amazon Simple Notification Service topic to receive matchmaking notifications. - * Provide the topic ARN in the matchmaking configuration.

- *

- * Learn more - *

- *

- * Design a FlexMatch - * matchmaker - *

- *

- * Set up FlexMatch event - * notification - *

+ * @see {@link CreateMatchmakingConfigurationCommand} */ - public createMatchmakingConfiguration( + createMatchmakingConfiguration( args: CreateMatchmakingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMatchmakingConfiguration( + createMatchmakingConfiguration( args: CreateMatchmakingConfigurationCommandInput, cb: (err: any, data?: CreateMatchmakingConfigurationCommandOutput) => void ): void; - public createMatchmakingConfiguration( + createMatchmakingConfiguration( args: CreateMatchmakingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMatchmakingConfigurationCommandOutput) => void ): void; - public createMatchmakingConfiguration( - args: CreateMatchmakingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMatchmakingConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateMatchmakingConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateMatchmakingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match - * to create, such as the number and size of teams. It also sets the parameters for - * acceptable player matches, such as minimum skill level or character type.

- *

To create a matchmaking rule set, provide unique rule set name and the rule set body - * in JSON format. Rule sets must be defined in the same Region as the matchmaking - * configuration they are used with.

- *

Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set - * syntax using ValidateMatchmakingRuleSet before creating a new rule set.

- *

- * Learn more - *

- * + * @see {@link CreateMatchmakingRuleSetCommand} */ - public createMatchmakingRuleSet( + createMatchmakingRuleSet( args: CreateMatchmakingRuleSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMatchmakingRuleSet( + createMatchmakingRuleSet( args: CreateMatchmakingRuleSetCommandInput, cb: (err: any, data?: CreateMatchmakingRuleSetCommandOutput) => void ): void; - public createMatchmakingRuleSet( + createMatchmakingRuleSet( args: CreateMatchmakingRuleSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMatchmakingRuleSetCommandOutput) => void ): void; - public createMatchmakingRuleSet( - args: CreateMatchmakingRuleSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMatchmakingRuleSetCommandOutput) => void), - cb?: (err: any, data?: CreateMatchmakingRuleSetCommandOutput) => void - ): Promise | void { - const command = new CreateMatchmakingRuleSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Reserves an open player slot in a game session for a player. New player sessions can - * be created in any game session with an open slot that is in ACTIVE status - * and has a player creation policy of ACCEPT_ALL. You can add a group of - * players to a game session with CreatePlayerSessions .

- *

To create a player session, specify a game session ID, player ID, and optionally a set - * of player data.

- *

If successful, a slot is reserved in the game session for the player and a new - * PlayerSessions object is returned with a player session ID. The player - * references the player session ID when sending a connection request to the game session, - * and the game server can use it to validate the player reservation with the GameLift - * service. Player sessions cannot be updated.

- *

The maximum number of players per game session is 200. It is not adjustable.

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link CreatePlayerSessionCommand} */ - public createPlayerSession( + createPlayerSession( args: CreatePlayerSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPlayerSession( + createPlayerSession( args: CreatePlayerSessionCommandInput, cb: (err: any, data?: CreatePlayerSessionCommandOutput) => void ): void; - public createPlayerSession( + createPlayerSession( args: CreatePlayerSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePlayerSessionCommandOutput) => void ): void; - public createPlayerSession( - args: CreatePlayerSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePlayerSessionCommandOutput) => void), - cb?: (err: any, data?: CreatePlayerSessionCommandOutput) => void - ): Promise | void { - const command = new CreatePlayerSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Reserves open slots in a game session for a group of players. New player sessions can - * be created in any game session with an open slot that is in ACTIVE status - * and has a player creation policy of ACCEPT_ALL. To add a single player to a - * game session, use CreatePlayerSession - *

- *

To create player sessions, specify a game session ID and a list of player IDs. - * Optionally, provide a set of player data for each player ID.

- *

If successful, a slot is reserved in the game session for each player, and new - * PlayerSession objects are returned with player session IDs. Each player - * references their player session ID when sending a connection request to the game - * session, and the game server can use it to validate the player reservation with the - * GameLift service. Player sessions cannot be updated.

- *

The maximum number of players per game session is 200. It is not adjustable.

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link CreatePlayerSessionsCommand} */ - public createPlayerSessions( + createPlayerSessions( args: CreatePlayerSessionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPlayerSessions( + createPlayerSessions( args: CreatePlayerSessionsCommandInput, cb: (err: any, data?: CreatePlayerSessionsCommandOutput) => void ): void; - public createPlayerSessions( + createPlayerSessions( args: CreatePlayerSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePlayerSessionsCommandOutput) => void ): void; - public createPlayerSessions( - args: CreatePlayerSessionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePlayerSessionsCommandOutput) => void), - cb?: (err: any, data?: CreatePlayerSessionsCommandOutput) => void - ): Promise | void { - const command = new CreatePlayerSessionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that - * provide configuration settings and optional custom game logic for your game. The script - * is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is - * executed during an active game session.

- *

To create a new script record, specify a script name and provide the script file(s). - * The script files and all dependencies must be zipped into a single file. You can pull - * the zip file from either of these locations:

- *
    - *
  • - *

    A locally available directory. Use the ZipFile parameter - * for this option.

    - *
  • - *
  • - *

    An Amazon Simple Storage Service (Amazon S3) bucket under your Amazon Web Services account. Use the - * StorageLocation parameter for this option. You'll need - * to have an Identity Access Management (IAM) role that allows the Amazon GameLift service - * to access your S3 bucket.

    - *
  • - *
- *

If the call is successful, a new script record is created with a unique script ID. If - * the script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 - * bucket and the script record's storage location reflects this location. If the script - * file is provided as an S3 bucket, Amazon GameLift accesses the file at this storage location as - * needed for deployment.

- *

- * Learn more - *

- * - *

- * Amazon GameLift Realtime Servers - *

- *

- * Set Up a Role for Amazon GameLift Access - *

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link CreateScriptCommand} */ - public createScript( - args: CreateScriptCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createScript(args: CreateScriptCommandInput, cb: (err: any, data?: CreateScriptCommandOutput) => void): void; - public createScript( + createScript(args: CreateScriptCommandInput, options?: __HttpHandlerOptions): Promise; + createScript(args: CreateScriptCommandInput, cb: (err: any, data?: CreateScriptCommandOutput) => void): void; + createScript( args: CreateScriptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateScriptCommandOutput) => void ): void; - public createScript( - args: CreateScriptCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateScriptCommandOutput) => void), - cb?: (err: any, data?: CreateScriptCommandOutput) => void - ): Promise | void { - const command = new CreateScriptCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Requests authorization to create or delete a peer connection between the VPC for your - * Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game servers on - * your fleet to communicate directly with other Amazon Web Services resources. After you've received - * authorization, use CreateVpcPeeringConnection to establish the peering connection. For more - * information, see VPC Peering with Amazon GameLift - * Fleets.

- *

You can peer with VPCs that are owned by any Amazon Web Services account you have access to, - * including the account that you use to manage your Amazon GameLift fleets. You cannot peer with - * VPCs that are in different Regions.

- *

To request authorization to create a connection, call this operation from the Amazon Web Services - * account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to enable - * your game servers to retrieve data from a DynamoDB table, use the account that manages - * that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you - * want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage Amazon GameLift. If - * successful, VPC peering is authorized for the specified VPC.

- *

To request authorization to delete a connection, call this operation from the Amazon Web Services - * account with the VPC that is peered with your Amazon GameLift fleet. Identify the following - * values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the - * Amazon Web Services account that you use to manage Amazon GameLift.

- *

The authorization remains valid for 24 hours unless it is canceled. You must create or - * delete the peering connection while the authorization is valid.

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link CreateVpcPeeringAuthorizationCommand} */ - public createVpcPeeringAuthorization( + createVpcPeeringAuthorization( args: CreateVpcPeeringAuthorizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVpcPeeringAuthorization( + createVpcPeeringAuthorization( args: CreateVpcPeeringAuthorizationCommandInput, cb: (err: any, data?: CreateVpcPeeringAuthorizationCommandOutput) => void ): void; - public createVpcPeeringAuthorization( + createVpcPeeringAuthorization( args: CreateVpcPeeringAuthorizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVpcPeeringAuthorizationCommandOutput) => void ): void; - public createVpcPeeringAuthorization( - args: CreateVpcPeeringAuthorizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVpcPeeringAuthorizationCommandOutput) => void), - cb?: (err: any, data?: CreateVpcPeeringAuthorizationCommandOutput) => void - ): Promise | void { - const command = new CreateVpcPeeringAuthorizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC - * for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate - * directly with other Amazon Web Services resources. You can peer with VPCs in any Amazon Web Services account that - * you have access to, including the account that you use to manage your Amazon GameLift fleets. You - * cannot peer with VPCs that are in different Regions. For more information, see VPC - * Peering with Amazon GameLift Fleets.

- *

Before calling this operation to establish the peering connection, you first need to - * use CreateVpcPeeringAuthorization and identify the VPC you want to peer with. - * Once the authorization for the specified VPC is issued, you have 24 hours to establish - * the connection. These two operations handle all tasks necessary to peer the two VPCs, - * including acceptance, updating routing tables, etc.

- *

To establish the connection, call this operation from the Amazon Web Services account that is used - * to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet you - * want to be enable a VPC peering connection for; (2) The Amazon Web Services account with the VPC that - * you want to peer with; and (3) The ID of the VPC you want to peer with. This operation - * is asynchronous. If successful, a connection request is created. You can use continuous - * polling to track the request's status using DescribeVpcPeeringConnections , or by monitoring fleet events for success - * or failure using DescribeFleetEvents .

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link CreateVpcPeeringConnectionCommand} */ - public createVpcPeeringConnection( + createVpcPeeringConnection( args: CreateVpcPeeringConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVpcPeeringConnection( + createVpcPeeringConnection( args: CreateVpcPeeringConnectionCommandInput, cb: (err: any, data?: CreateVpcPeeringConnectionCommandOutput) => void ): void; - public createVpcPeeringConnection( + createVpcPeeringConnection( args: CreateVpcPeeringConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVpcPeeringConnectionCommandOutput) => void ): void; - public createVpcPeeringConnection( - args: CreateVpcPeeringConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVpcPeeringConnectionCommandOutput) => void), - cb?: (err: any, data?: CreateVpcPeeringConnectionCommandOutput) => void - ): Promise | void { - const command = new CreateVpcPeeringConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an alias. This operation removes all record of the alias. Game clients - * attempting to access a server process using the deleted alias receive an error. To - * delete an alias, specify the alias ID to be deleted.

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link DeleteAliasCommand} */ - public deleteAlias(args: DeleteAliasCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteAlias(args: DeleteAliasCommandInput, cb: (err: any, data?: DeleteAliasCommandOutput) => void): void; - public deleteAlias( + deleteAlias(args: DeleteAliasCommandInput, options?: __HttpHandlerOptions): Promise; + deleteAlias(args: DeleteAliasCommandInput, cb: (err: any, data?: DeleteAliasCommandOutput) => void): void; + deleteAlias( args: DeleteAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAliasCommandOutput) => void ): void; - public deleteAlias( - args: DeleteAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAliasCommandOutput) => void), - cb?: (err: any, data?: DeleteAliasCommandOutput) => void - ): Promise | void { - const command = new DeleteAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a build. This operation permanently deletes the build resource and any - * uploaded build files. Deleting a build does not affect the status of any active fleets - * using the build, but you can no longer create new fleets with the deleted build.

- *

To delete a build, specify the build ID.

- *

- * Learn more - *

- *

- * Upload a Custom - * Server Build - *

- *

- * All APIs by task - *

+ * @see {@link DeleteBuildCommand} */ - public deleteBuild(args: DeleteBuildCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteBuild(args: DeleteBuildCommandInput, cb: (err: any, data?: DeleteBuildCommandOutput) => void): void; - public deleteBuild( + deleteBuild(args: DeleteBuildCommandInput, options?: __HttpHandlerOptions): Promise; + deleteBuild(args: DeleteBuildCommandInput, cb: (err: any, data?: DeleteBuildCommandOutput) => void): void; + deleteBuild( args: DeleteBuildCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBuildCommandOutput) => void ): void; - public deleteBuild( - args: DeleteBuildCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBuildCommandOutput) => void), - cb?: (err: any, data?: DeleteBuildCommandOutput) => void - ): Promise | void { - const command = new DeleteBuildCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes all resources and information related a fleet. Any current fleet instances, - * including those in remote locations, are shut down. You don't need to call - * DeleteFleetLocations separately.

- * - *

If the fleet being deleted has a VPC peering connection, you first need to get a - * valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You do not need to explicitly delete the - * VPC peering connection.

- *
- *

To delete a fleet, specify the fleet ID to be terminated. During the deletion process - * the fleet status is changed to DELETING. When completed, the status - * switches to TERMINATED and the fleet event FLEET_DELETED is - * sent.

- *

- * Learn more - *

- *

- * Setting up GameLift - * Fleets - *

+ * @see {@link DeleteFleetCommand} */ - public deleteFleet(args: DeleteFleetCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteFleet(args: DeleteFleetCommandInput, cb: (err: any, data?: DeleteFleetCommandOutput) => void): void; - public deleteFleet( + deleteFleet(args: DeleteFleetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteFleet(args: DeleteFleetCommandInput, cb: (err: any, data?: DeleteFleetCommandOutput) => void): void; + deleteFleet( args: DeleteFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFleetCommandOutput) => void ): void; - public deleteFleet( - args: DeleteFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFleetCommandOutput) => void), - cb?: (err: any, data?: DeleteFleetCommandOutput) => void - ): Promise | void { - const command = new DeleteFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes locations from a multi-location fleet. When deleting a location, all game - * server process and all instances that are still active in the location are shut down.

- *

To delete fleet locations, identify the fleet ID and provide a list of the locations - * to be deleted.

- *

If successful, GameLift sets the location status to DELETING, and begins - * to shut down existing server processes and terminate instances in each location being - * deleted. When completed, the location status changes to TERMINATED.

- *

- * Learn more - *

- *

- * Setting up GameLift - * fleets - *

+ * @see {@link DeleteFleetLocationsCommand} */ - public deleteFleetLocations( + deleteFleetLocations( args: DeleteFleetLocationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFleetLocations( + deleteFleetLocations( args: DeleteFleetLocationsCommandInput, cb: (err: any, data?: DeleteFleetLocationsCommandOutput) => void ): void; - public deleteFleetLocations( + deleteFleetLocations( args: DeleteFleetLocationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFleetLocationsCommandOutput) => void ): void; - public deleteFleetLocations( - args: DeleteFleetLocationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFleetLocationsCommandOutput) => void), - cb?: (err: any, data?: DeleteFleetLocationsCommandOutput) => void - ): Promise | void { - const command = new DeleteFleetLocationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * This operation is used with the GameLift FleetIQ solution and game server groups. - *

- *

Terminates a game server group - * and permanently deletes the game server group record. You have several options for how - * these resources are impacted when deleting the game server group. Depending on the type - * of delete operation selected, this operation might affect these resources:

- *
    - *
  • - *

    The game server group

    - *
  • - *
  • - *

    The corresponding Auto Scaling group

    - *
  • - *
  • - *

    All game servers that are currently running in the group

    - *
  • - *
- *

To delete a game server group, identify the game server group to delete and specify - * the type of delete operation to initiate. Game server groups can only be deleted if they - * are in ACTIVE or ERROR status.

- *

If the delete request is successful, a series of operations are kicked off. The game - * server group status is changed to DELETE_SCHEDULED, which prevents new game - * servers from being registered and stops automatic scaling activity. Once all game - * servers in the game server group are deregistered, GameLift FleetIQ can begin deleting resources. - * If any of the delete operations fail, the game server group is placed in - * ERROR status.

- *

GameLift FleetIQ emits delete events to Amazon CloudWatch.

- *

- * Learn more - *

- *

- * GameLift FleetIQ - * Guide - *

+ * @see {@link DeleteGameServerGroupCommand} */ - public deleteGameServerGroup( + deleteGameServerGroup( args: DeleteGameServerGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteGameServerGroup( + deleteGameServerGroup( args: DeleteGameServerGroupCommandInput, cb: (err: any, data?: DeleteGameServerGroupCommandOutput) => void ): void; - public deleteGameServerGroup( + deleteGameServerGroup( args: DeleteGameServerGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGameServerGroupCommandOutput) => void ): void; - public deleteGameServerGroup( - args: DeleteGameServerGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGameServerGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteGameServerGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteGameServerGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a game session queue. Once a queue is successfully deleted, unfulfilled StartGameSessionPlacement requests that reference the queue will fail. To - * delete a queue, specify the queue name.

+ * @see {@link DeleteGameSessionQueueCommand} */ - public deleteGameSessionQueue( + deleteGameSessionQueue( args: DeleteGameSessionQueueCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteGameSessionQueue( + deleteGameSessionQueue( args: DeleteGameSessionQueueCommandInput, cb: (err: any, data?: DeleteGameSessionQueueCommandOutput) => void ): void; - public deleteGameSessionQueue( + deleteGameSessionQueue( args: DeleteGameSessionQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGameSessionQueueCommandOutput) => void ): void; - public deleteGameSessionQueue( - args: DeleteGameSessionQueueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGameSessionQueueCommandOutput) => void), - cb?: (err: any, data?: DeleteGameSessionQueueCommandOutput) => void - ): Promise | void { - const command = new DeleteGameSessionQueueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a custom location.

- *

Before deleting a custom location, review any fleets currently using the custom - * location and deregister the location if it is in use. For more information see, DeregisterCompute.

+ * @see {@link DeleteLocationCommand} */ - public deleteLocation( + deleteLocation( args: DeleteLocationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLocation( - args: DeleteLocationCommandInput, - cb: (err: any, data?: DeleteLocationCommandOutput) => void - ): void; - public deleteLocation( + deleteLocation(args: DeleteLocationCommandInput, cb: (err: any, data?: DeleteLocationCommandOutput) => void): void; + deleteLocation( args: DeleteLocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLocationCommandOutput) => void ): void; - public deleteLocation( - args: DeleteLocationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLocationCommandOutput) => void), - cb?: (err: any, data?: DeleteLocationCommandOutput) => void - ): Promise | void { - const command = new DeleteLocationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Permanently removes a FlexMatch matchmaking configuration. To delete, specify the - * configuration name. A matchmaking configuration cannot be deleted if it is being used in - * any active matchmaking tickets.

+ * @see {@link DeleteMatchmakingConfigurationCommand} */ - public deleteMatchmakingConfiguration( + deleteMatchmakingConfiguration( args: DeleteMatchmakingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMatchmakingConfiguration( + deleteMatchmakingConfiguration( args: DeleteMatchmakingConfigurationCommandInput, cb: (err: any, data?: DeleteMatchmakingConfigurationCommandOutput) => void ): void; - public deleteMatchmakingConfiguration( + deleteMatchmakingConfiguration( args: DeleteMatchmakingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMatchmakingConfigurationCommandOutput) => void ): void; - public deleteMatchmakingConfiguration( - args: DeleteMatchmakingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMatchmakingConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteMatchmakingConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteMatchmakingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set - * name. Rule sets cannot be deleted if they are currently being used by a matchmaking - * configuration.

- *

- * Learn more - *

- * + * @see {@link DeleteMatchmakingRuleSetCommand} */ - public deleteMatchmakingRuleSet( + deleteMatchmakingRuleSet( args: DeleteMatchmakingRuleSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMatchmakingRuleSet( + deleteMatchmakingRuleSet( args: DeleteMatchmakingRuleSetCommandInput, cb: (err: any, data?: DeleteMatchmakingRuleSetCommandOutput) => void ): void; - public deleteMatchmakingRuleSet( + deleteMatchmakingRuleSet( args: DeleteMatchmakingRuleSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMatchmakingRuleSetCommandOutput) => void ): void; - public deleteMatchmakingRuleSet( - args: DeleteMatchmakingRuleSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMatchmakingRuleSetCommandOutput) => void), - cb?: (err: any, data?: DeleteMatchmakingRuleSetCommandOutput) => void - ): Promise | void { - const command = new DeleteMatchmakingRuleSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and - * GameLift removes all record of it. To delete a scaling policy, specify both the scaling - * policy name and the fleet ID it is associated with.

- *

To temporarily suspend scaling policies, use StopFleetActions. This operation suspends all policies for the - * fleet.

+ * @see {@link DeleteScalingPolicyCommand} */ - public deleteScalingPolicy( + deleteScalingPolicy( args: DeleteScalingPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteScalingPolicy( + deleteScalingPolicy( args: DeleteScalingPolicyCommandInput, cb: (err: any, data?: DeleteScalingPolicyCommandOutput) => void ): void; - public deleteScalingPolicy( + deleteScalingPolicy( args: DeleteScalingPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteScalingPolicyCommandOutput) => void ): void; - public deleteScalingPolicy( - args: DeleteScalingPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteScalingPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteScalingPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteScalingPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Realtime script. This operation permanently deletes the script record. If - * script files were uploaded, they are also deleted (files stored in an S3 bucket are not - * deleted).

- *

To delete a script, specify the script ID. Before deleting a script, be sure to - * terminate all fleets that are deployed with the script being deleted. Fleet instances - * periodically check for script updates, and if the script record no longer exists, the - * instance will go into an error state and be unable to host game sessions.

- *

- * Learn more - *

- *

- * Amazon GameLift Realtime Servers - *

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link DeleteScriptCommand} */ - public deleteScript( - args: DeleteScriptCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteScript(args: DeleteScriptCommandInput, cb: (err: any, data?: DeleteScriptCommandOutput) => void): void; - public deleteScript( + deleteScript(args: DeleteScriptCommandInput, options?: __HttpHandlerOptions): Promise; + deleteScript(args: DeleteScriptCommandInput, cb: (err: any, data?: DeleteScriptCommandOutput) => void): void; + deleteScript( args: DeleteScriptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteScriptCommandOutput) => void ): void; - public deleteScript( - args: DeleteScriptCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteScriptCommandOutput) => void), - cb?: (err: any, data?: DeleteScriptCommandOutput) => void - ): Promise | void { - const command = new DeleteScriptCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels a pending VPC peering authorization for the specified VPC. If you need to - * delete an existing VPC peering connection, use DeleteVpcPeeringConnection.

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link DeleteVpcPeeringAuthorizationCommand} */ - public deleteVpcPeeringAuthorization( + deleteVpcPeeringAuthorization( args: DeleteVpcPeeringAuthorizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVpcPeeringAuthorization( + deleteVpcPeeringAuthorization( args: DeleteVpcPeeringAuthorizationCommandInput, cb: (err: any, data?: DeleteVpcPeeringAuthorizationCommandOutput) => void ): void; - public deleteVpcPeeringAuthorization( + deleteVpcPeeringAuthorization( args: DeleteVpcPeeringAuthorizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVpcPeeringAuthorizationCommandOutput) => void ): void; - public deleteVpcPeeringAuthorization( - args: DeleteVpcPeeringAuthorizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVpcPeeringAuthorizationCommandOutput) => void), - cb?: (err: any, data?: DeleteVpcPeeringAuthorizationCommandOutput) => void - ): Promise | void { - const command = new DeleteVpcPeeringAuthorizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a VPC peering connection. To delete the connection, you must have a valid - * authorization for the VPC peering connection that you want to delete..

- *

Once a valid authorization exists, call this operation from the Amazon Web Services account that is - * used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection ID - * and fleet ID. If successful, the connection is removed.

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link DeleteVpcPeeringConnectionCommand} */ - public deleteVpcPeeringConnection( + deleteVpcPeeringConnection( args: DeleteVpcPeeringConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVpcPeeringConnection( + deleteVpcPeeringConnection( args: DeleteVpcPeeringConnectionCommandInput, cb: (err: any, data?: DeleteVpcPeeringConnectionCommandOutput) => void ): void; - public deleteVpcPeeringConnection( + deleteVpcPeeringConnection( args: DeleteVpcPeeringConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVpcPeeringConnectionCommandOutput) => void ): void; - public deleteVpcPeeringConnection( - args: DeleteVpcPeeringConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVpcPeeringConnectionCommandOutput) => void), - cb?: (err: any, data?: DeleteVpcPeeringConnectionCommandOutput) => void - ): Promise | void { - const command = new DeleteVpcPeeringConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a compute resource from the specified fleet. Deregister your compute resources - * before you delete the compute.

+ * @see {@link DeregisterComputeCommand} */ - public deregisterCompute( + deregisterCompute( args: DeregisterComputeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterCompute( + deregisterCompute( args: DeregisterComputeCommandInput, cb: (err: any, data?: DeregisterComputeCommandOutput) => void ): void; - public deregisterCompute( + deregisterCompute( args: DeregisterComputeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterComputeCommandOutput) => void ): void; - public deregisterCompute( - args: DeregisterComputeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterComputeCommandOutput) => void), - cb?: (err: any, data?: DeregisterComputeCommandOutput) => void - ): Promise | void { - const command = new DeregisterComputeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * This operation is used with the GameLift FleetIQ solution and game server groups. - *

- *

Removes the game server from a - * game server group. As a result of this operation, the deregistered game server can no - * longer be claimed and will not be returned in a list of active game servers.

- *

To deregister a game server, specify the game server group and game server ID. If - * successful, this operation emits a CloudWatch event with termination timestamp and - * reason.

- *

- * Learn more - *

- *

- * GameLift FleetIQ - * Guide - *

+ * @see {@link DeregisterGameServerCommand} */ - public deregisterGameServer( + deregisterGameServer( args: DeregisterGameServerCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterGameServer( + deregisterGameServer( args: DeregisterGameServerCommandInput, cb: (err: any, data?: DeregisterGameServerCommandOutput) => void ): void; - public deregisterGameServer( + deregisterGameServer( args: DeregisterGameServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterGameServerCommandOutput) => void ): void; - public deregisterGameServer( - args: DeregisterGameServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterGameServerCommandOutput) => void), - cb?: (err: any, data?: DeregisterGameServerCommandOutput) => void - ): Promise | void { - const command = new DeregisterGameServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves properties for an alias. This operation returns all alias metadata and - * settings. To get an alias's target fleet ID only, use ResolveAlias.

- *

To get alias properties, specify the alias ID. If successful, the requested alias - * record is returned.

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link DescribeAliasCommand} */ - public describeAlias( - args: DescribeAliasCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeAlias( - args: DescribeAliasCommandInput, - cb: (err: any, data?: DescribeAliasCommandOutput) => void - ): void; - public describeAlias( + describeAlias(args: DescribeAliasCommandInput, options?: __HttpHandlerOptions): Promise; + describeAlias(args: DescribeAliasCommandInput, cb: (err: any, data?: DescribeAliasCommandOutput) => void): void; + describeAlias( args: DescribeAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAliasCommandOutput) => void ): void; - public describeAlias( - args: DescribeAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAliasCommandOutput) => void), - cb?: (err: any, data?: DescribeAliasCommandOutput) => void - ): Promise | void { - const command = new DescribeAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves properties for a custom game build. To request a build resource, specify a - * build ID. If successful, an object containing the build properties is returned.

- *

- * Learn more - *

- *

- * Upload a Custom - * Server Build - *

- *

- * All APIs by task - *

+ * @see {@link DescribeBuildCommand} */ - public describeBuild( - args: DescribeBuildCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeBuild( - args: DescribeBuildCommandInput, - cb: (err: any, data?: DescribeBuildCommandOutput) => void - ): void; - public describeBuild( + describeBuild(args: DescribeBuildCommandInput, options?: __HttpHandlerOptions): Promise; + describeBuild(args: DescribeBuildCommandInput, cb: (err: any, data?: DescribeBuildCommandOutput) => void): void; + describeBuild( args: DescribeBuildCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBuildCommandOutput) => void ): void; - public describeBuild( - args: DescribeBuildCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBuildCommandOutput) => void), - cb?: (err: any, data?: DescribeBuildCommandOutput) => void - ): Promise | void { - const command = new DescribeBuildCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves properties for a compute resource. To request a compute resource specify the - * fleet ID and compute name. If successful, GameLift returns an object containing the build - * properties.

+ * @see {@link DescribeComputeCommand} */ - public describeCompute( + describeCompute( args: DescribeComputeCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCompute( - args: DescribeComputeCommandInput, - cb: (err: any, data?: DescribeComputeCommandOutput) => void - ): void; - public describeCompute( + describeCompute(args: DescribeComputeCommandInput, cb: (err: any, data?: DescribeComputeCommandOutput) => void): void; + describeCompute( args: DescribeComputeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeComputeCommandOutput) => void ): void; - public describeCompute( - args: DescribeComputeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeComputeCommandOutput) => void), - cb?: (err: any, data?: DescribeComputeCommandOutput) => void - ): Promise | void { - const command = new DescribeComputeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the instance limits and current utilization for an Amazon Web Services Region or location. - * Instance limits control the number of instances, per instance type, per location, that - * your Amazon Web Services account can use. Learn more at Amazon EC2 Instance Types. The information - * returned includes the maximum number of instances allowed and your account's current - * usage across all fleets. This information can affect your ability to scale your GameLift - * fleets. You can request a limit increase for your account by using the Service limits page in the GameLift console.

- *

Instance limits differ based on whether the instances are deployed in a fleet's home - * Region or in a remote location. For remote locations, limits also differ based on the - * combination of home Region and remote location. All requests must specify an Amazon Web Services - * Region (either explicitly or as your default settings). To get the limit for a remote - * location, you must also specify the location. For example, the following requests all - * return different results:

- *
    - *
  • - *

    Request specifies the Region ap-northeast-1 with no location. The - * result is limits and usage data on all instance types that are deployed in - * us-east-2, by all of the fleets that reside in - * ap-northeast-1.

    - *
  • - *
  • - *

    Request specifies the Region us-east-1 with location - * ca-central-1. The result is limits and usage data on all - * instance types that are deployed in ca-central-1, by all of the - * fleets that reside in us-east-2. These limits do not affect fleets - * in any other Regions that deploy instances to ca-central-1.

    - *
  • - *
  • - *

    Request specifies the Region eu-west-1 with location - * ca-central-1. The result is limits and usage data on all - * instance types that are deployed in ca-central-1, by all of the - * fleets that reside in eu-west-1.

    - *
  • - *
- *

This operation can be used in the following ways:

- *
    - *
  • - *

    To get limit and usage data for all instance types that are deployed in an - * Amazon Web Services Region by fleets that reside in the same Region: Specify the Region only. - * Optionally, specify a single instance type to retrieve information for.

    - *
  • - *
  • - *

    To get limit and usage data for all instance types that are deployed to a - * remote location by fleets that reside in different Amazon Web Services Region: Provide both - * the Amazon Web Services Region and the remote location. Optionally, specify a single instance - * type to retrieve information for.

    - *
  • - *
- *

If successful, an EC2InstanceLimits object is returned with limits and - * usage data for each requested instance type.

- *

- * Learn more - *

- *

- * Setting up GameLift fleets - *

+ * @see {@link DescribeEC2InstanceLimitsCommand} */ - public describeEC2InstanceLimits( + describeEC2InstanceLimits( args: DescribeEC2InstanceLimitsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEC2InstanceLimits( + describeEC2InstanceLimits( args: DescribeEC2InstanceLimitsCommandInput, cb: (err: any, data?: DescribeEC2InstanceLimitsCommandOutput) => void ): void; - public describeEC2InstanceLimits( + describeEC2InstanceLimits( args: DescribeEC2InstanceLimitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEC2InstanceLimitsCommandOutput) => void ): void; - public describeEC2InstanceLimits( - args: DescribeEC2InstanceLimitsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEC2InstanceLimitsCommandOutput) => void), - cb?: (err: any, data?: DescribeEC2InstanceLimitsCommandOutput) => void - ): Promise | void { - const command = new DescribeEC2InstanceLimitsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves core fleet-wide properties, including the computing hardware and deployment - * configuration for all instances in the fleet.

- *

This operation can be used in the following ways:

- *
    - *
  • - *

    To get attributes for one or more specific fleets, provide a list of fleet IDs - * or fleet ARNs.

    - *
  • - *
  • - *

    To get attributes for all fleets, do not provide a fleet identifier.

    - *
  • - *
- *

When requesting attributes for multiple fleets, use the pagination parameters to - * retrieve results as a set of sequential pages.

- *

If successful, a FleetAttributes object is returned for each fleet - * requested, unless the fleet identifier is not found.

- * - *

Some API operations limit the number of fleet IDs that allowed in one request. If - * a request exceeds this limit, the request fails and the error message contains the - * maximum allowed number.

- *
- *

- * Learn more - *

- *

- * Setting up GameLift - * fleets - *

+ * @see {@link DescribeFleetAttributesCommand} */ - public describeFleetAttributes( + describeFleetAttributes( args: DescribeFleetAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFleetAttributes( + describeFleetAttributes( args: DescribeFleetAttributesCommandInput, cb: (err: any, data?: DescribeFleetAttributesCommandOutput) => void ): void; - public describeFleetAttributes( + describeFleetAttributes( args: DescribeFleetAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetAttributesCommandOutput) => void ): void; - public describeFleetAttributes( - args: DescribeFleetAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFleetAttributesCommandOutput) => void), - cb?: (err: any, data?: DescribeFleetAttributesCommandOutput) => void - ): Promise | void { - const command = new DescribeFleetAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the resource capacity settings for one or more fleets. The data returned - * includes the current fleet capacity (number of EC2 instances), and settings that can - * control how capacity scaling. For fleets with remote locations, this operation retrieves - * data for the fleet's home Region only.

- *

This operation can be used in the following ways:

- *
    - *
  • - *

    To get capacity data for one or more specific fleets, provide a list of fleet - * IDs or fleet ARNs.

    - *
  • - *
  • - *

    To get capacity data for all fleets, do not provide a fleet identifier. - *

    - *
  • - *
- *

When requesting multiple fleets, use the pagination parameters to retrieve results as - * a set of sequential pages.

- *

If successful, a FleetCapacity object is returned for each requested - * fleet ID. Each FleetCapacity object includes a Location property, which is - * set to the fleet's home Region. When a list of fleet IDs is provided, attribute objects - * are returned only for fleets that currently exist.

- * - *

Some API operations may limit the number of fleet IDs that are allowed in one - * request. If a request exceeds this limit, the request fails and the error message - * includes the maximum allowed.

- *
- *

- * Learn more - *

- *

- * Setting up GameLift - * fleets - *

- *

- * GameLift metrics for fleets - *

+ * @see {@link DescribeFleetCapacityCommand} */ - public describeFleetCapacity( + describeFleetCapacity( args: DescribeFleetCapacityCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFleetCapacity( + describeFleetCapacity( args: DescribeFleetCapacityCommandInput, cb: (err: any, data?: DescribeFleetCapacityCommandOutput) => void ): void; - public describeFleetCapacity( + describeFleetCapacity( args: DescribeFleetCapacityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetCapacityCommandOutput) => void ): void; - public describeFleetCapacity( - args: DescribeFleetCapacityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFleetCapacityCommandOutput) => void), - cb?: (err: any, data?: DescribeFleetCapacityCommandOutput) => void - ): Promise | void { - const command = new DescribeFleetCapacityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves entries from a fleet's event log. Fleet events are initiated by changes in - * status, such as during fleet creation and termination, changes in capacity, etc. If a - * fleet has multiple locations, events are also initiated by changes to status and - * capacity in remote locations.

- *

You can specify a time range to limit the result set. Use the pagination parameters to - * retrieve results as a set of sequential pages.

- *

If successful, a collection of event log entries matching the request are - * returned.

- *

- * Learn more - *

- *

- * Setting up GameLift - * fleets - *

+ * @see {@link DescribeFleetEventsCommand} */ - public describeFleetEvents( + describeFleetEvents( args: DescribeFleetEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFleetEvents( + describeFleetEvents( args: DescribeFleetEventsCommandInput, cb: (err: any, data?: DescribeFleetEventsCommandOutput) => void ): void; - public describeFleetEvents( + describeFleetEvents( args: DescribeFleetEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetEventsCommandOutput) => void ): void; - public describeFleetEvents( - args: DescribeFleetEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFleetEventsCommandOutput) => void), - cb?: (err: any, data?: DescribeFleetEventsCommandOutput) => void - ): Promise | void { - const command = new DescribeFleetEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information on a fleet's remote locations, including life-cycle status and - * any suspended fleet activity.

- *

This operation can be used in the following ways:

- *
    - *
  • - *

    To get data for specific locations, provide a fleet identifier and a list of - * locations. Location data is returned in the order that it is requested.

    - *
  • - *
  • - *

    To get data for all locations, provide a fleet identifier only. Location data - * is returned in no particular order.

    - *
  • - *
- *

When requesting attributes for multiple locations, use the pagination parameters to - * retrieve results as a set of sequential pages.

- *

If successful, a LocationAttributes object is returned for each requested - * location. If the fleet does not have a requested location, no information is returned. - * This operation does not return the home Region. To get information on a fleet's home - * Region, call DescribeFleetAttributes.

- *

- * Learn more - *

- *

- * Setting - * up GameLift fleets - *

+ * @see {@link DescribeFleetLocationAttributesCommand} */ - public describeFleetLocationAttributes( + describeFleetLocationAttributes( args: DescribeFleetLocationAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFleetLocationAttributes( + describeFleetLocationAttributes( args: DescribeFleetLocationAttributesCommandInput, cb: (err: any, data?: DescribeFleetLocationAttributesCommandOutput) => void ): void; - public describeFleetLocationAttributes( + describeFleetLocationAttributes( args: DescribeFleetLocationAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetLocationAttributesCommandOutput) => void ): void; - public describeFleetLocationAttributes( - args: DescribeFleetLocationAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFleetLocationAttributesCommandOutput) => void), - cb?: (err: any, data?: DescribeFleetLocationAttributesCommandOutput) => void - ): Promise | void { - const command = new DescribeFleetLocationAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the resource capacity settings for a fleet location. The data returned - * includes the current capacity (number of EC2 instances) and some scaling settings for - * the requested fleet location. Use this operation to retrieve capacity information for a - * fleet's remote location or home Region (you can also retrieve home Region capacity by - * calling DescribeFleetCapacity).

- *

To retrieve capacity data, identify a fleet and location.

- *

If successful, a FleetCapacity object is returned for the requested fleet - * location.

- *

- * Learn more - *

- *

- * Setting up GameLift - * fleets - *

- *

- * GameLift metrics for fleets - *

+ * @see {@link DescribeFleetLocationCapacityCommand} */ - public describeFleetLocationCapacity( + describeFleetLocationCapacity( args: DescribeFleetLocationCapacityCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFleetLocationCapacity( + describeFleetLocationCapacity( args: DescribeFleetLocationCapacityCommandInput, cb: (err: any, data?: DescribeFleetLocationCapacityCommandOutput) => void ): void; - public describeFleetLocationCapacity( + describeFleetLocationCapacity( args: DescribeFleetLocationCapacityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetLocationCapacityCommandOutput) => void ): void; - public describeFleetLocationCapacity( - args: DescribeFleetLocationCapacityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFleetLocationCapacityCommandOutput) => void), - cb?: (err: any, data?: DescribeFleetLocationCapacityCommandOutput) => void - ): Promise | void { - const command = new DescribeFleetLocationCapacityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves current usage data for a fleet location. Utilization data provides a - * snapshot of current game hosting activity at the requested location. Use this operation - * to retrieve utilization information for a fleet's remote location or home Region (you - * can also retrieve home Region utilization by calling - * DescribeFleetUtilization).

- *

To retrieve utilization data, identify a fleet and location.

- *

If successful, a FleetUtilization object is returned for the requested - * fleet location.

- *

- * Learn more - *

- *

- * Setting up GameLift - * fleets - *

- *

- * GameLift metrics for fleets - *

+ * @see {@link DescribeFleetLocationUtilizationCommand} */ - public describeFleetLocationUtilization( + describeFleetLocationUtilization( args: DescribeFleetLocationUtilizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFleetLocationUtilization( + describeFleetLocationUtilization( args: DescribeFleetLocationUtilizationCommandInput, cb: (err: any, data?: DescribeFleetLocationUtilizationCommandOutput) => void ): void; - public describeFleetLocationUtilization( + describeFleetLocationUtilization( args: DescribeFleetLocationUtilizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetLocationUtilizationCommandOutput) => void ): void; - public describeFleetLocationUtilization( - args: DescribeFleetLocationUtilizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFleetLocationUtilizationCommandOutput) => void), - cb?: (err: any, data?: DescribeFleetLocationUtilizationCommandOutput) => void - ): Promise | void { - const command = new DescribeFleetLocationUtilizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a fleet's inbound connection permissions. Connection permissions specify the - * range of IP addresses and port settings that incoming traffic can use to access server - * processes in the fleet. Game sessions that are running on instances in the fleet must - * use connections that fall in this range.

- *

This operation can be used in the following ways:

- *
    - *
  • - *

    To retrieve the inbound connection permissions for a fleet, identify the - * fleet's unique identifier.

    - *
  • - *
  • - *

    To check the status of recent updates to a fleet remote location, specify the - * fleet ID and a location. Port setting updates can take time to propagate across - * all locations.

    - *
  • - *
- *

If successful, a set of IpPermission objects is returned for the - * requested fleet ID. When a location is specified, a pending status is included. If the - * requested fleet has been deleted, the result set is empty.

- *

- * Learn more - *

- *

- * Setting up GameLift - * fleets - *

+ * @see {@link DescribeFleetPortSettingsCommand} */ - public describeFleetPortSettings( + describeFleetPortSettings( args: DescribeFleetPortSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFleetPortSettings( + describeFleetPortSettings( args: DescribeFleetPortSettingsCommandInput, cb: (err: any, data?: DescribeFleetPortSettingsCommandOutput) => void ): void; - public describeFleetPortSettings( + describeFleetPortSettings( args: DescribeFleetPortSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetPortSettingsCommandOutput) => void ): void; - public describeFleetPortSettings( - args: DescribeFleetPortSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFleetPortSettingsCommandOutput) => void), - cb?: (err: any, data?: DescribeFleetPortSettingsCommandOutput) => void - ): Promise | void { - const command = new DescribeFleetPortSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves utilization statistics for one or more fleets. Utilization data provides a - * snapshot of how the fleet's hosting resources are currently being used. For fleets with - * remote locations, this operation retrieves data for the fleet's home Region only. See - * DescribeFleetLocationUtilization to get utilization statistics for a - * fleet's remote locations.

- *

This operation can be used in the following ways:

- *
    - *
  • - *

    To get utilization data for one or more specific fleets, provide a list of - * fleet IDs or fleet ARNs.

    - *
  • - *
  • - *

    To get utilization data for all fleets, do not provide a fleet identifier. - *

    - *
  • - *
- *

When requesting multiple fleets, use the pagination parameters to retrieve results as - * a set of sequential pages.

- *

If successful, a FleetUtilization object is returned for each requested fleet ID, unless the - * fleet identifier is not found. Each fleet utilization object includes a - * Location property, which is set to the fleet's home Region.

- * - *

Some API operations may limit the number of fleet IDs allowed in one request. If a - * request exceeds this limit, the request fails and the error message includes the - * maximum allowed.

- *
- *

- * Learn more - *

- *

- * Setting up GameLift - * Fleets - *

- *

- * GameLift Metrics for Fleets - *

+ * @see {@link DescribeFleetUtilizationCommand} */ - public describeFleetUtilization( + describeFleetUtilization( args: DescribeFleetUtilizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFleetUtilization( + describeFleetUtilization( args: DescribeFleetUtilizationCommandInput, cb: (err: any, data?: DescribeFleetUtilizationCommandOutput) => void ): void; - public describeFleetUtilization( + describeFleetUtilization( args: DescribeFleetUtilizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetUtilizationCommandOutput) => void ): void; - public describeFleetUtilization( - args: DescribeFleetUtilizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFleetUtilizationCommandOutput) => void), - cb?: (err: any, data?: DescribeFleetUtilizationCommandOutput) => void - ): Promise | void { - const command = new DescribeFleetUtilizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * This operation is used with the GameLift FleetIQ solution and game server groups. - *

- *

Retrieves information for a - * registered game server. Information includes game server status, health check info, and - * the instance that the game server is running on.

- *

To retrieve game server information, specify the game server ID. If successful, the - * requested game server object is returned.

- *

- * Learn more - *

- *

- * GameLift FleetIQ - * Guide - *

+ * @see {@link DescribeGameServerCommand} */ - public describeGameServer( + describeGameServer( args: DescribeGameServerCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGameServer( + describeGameServer( args: DescribeGameServerCommandInput, cb: (err: any, data?: DescribeGameServerCommandOutput) => void ): void; - public describeGameServer( + describeGameServer( args: DescribeGameServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGameServerCommandOutput) => void ): void; - public describeGameServer( - args: DescribeGameServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGameServerCommandOutput) => void), - cb?: (err: any, data?: DescribeGameServerCommandOutput) => void - ): Promise | void { - const command = new DescribeGameServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * This operation is used with the GameLift FleetIQ solution and game server groups. - *

- *

Retrieves information on a - * game server group. This operation returns only properties related to GameLift FleetIQ. To view or - * update properties for the corresponding Auto Scaling group, such as launch template, - * auto scaling policies, and maximum/minimum group size, access the Auto Scaling group - * directly.

- *

To get attributes for a game server group, provide a group name or ARN value. If - * successful, a GameServerGroup object is returned.

- *

- * Learn more - *

- *

- * GameLift FleetIQ - * Guide - *

+ * @see {@link DescribeGameServerGroupCommand} */ - public describeGameServerGroup( + describeGameServerGroup( args: DescribeGameServerGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGameServerGroup( + describeGameServerGroup( args: DescribeGameServerGroupCommandInput, cb: (err: any, data?: DescribeGameServerGroupCommandOutput) => void ): void; - public describeGameServerGroup( + describeGameServerGroup( args: DescribeGameServerGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGameServerGroupCommandOutput) => void ): void; - public describeGameServerGroup( - args: DescribeGameServerGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGameServerGroupCommandOutput) => void), - cb?: (err: any, data?: DescribeGameServerGroupCommandOutput) => void - ): Promise | void { - const command = new DescribeGameServerGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * This operation is used with the GameLift FleetIQ solution and game server groups. - *

- *

Retrieves status - * information about the Amazon EC2 instances associated with a GameLift FleetIQ game server group. - * Use this operation to detect when instances are active or not available to host new game - * servers.

- *

To request status for all instances in the game server group, provide a game server - * group ID only. To request status for specific instances, provide the game server group - * ID and one or more instance IDs. Use the pagination parameters to retrieve results in - * sequential segments. If successful, a collection of GameServerInstance - * objects is returned.

- *

This operation is not designed to be called with every game server claim request; this - * practice can cause you to exceed your API limit, which results in errors. Instead, as a - * best practice, cache the results and refresh your cache no more than once every 10 - * seconds.

- *

- * Learn more - *

- *

- * GameLift FleetIQ - * Guide - *

+ * @see {@link DescribeGameServerInstancesCommand} */ - public describeGameServerInstances( + describeGameServerInstances( args: DescribeGameServerInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGameServerInstances( + describeGameServerInstances( args: DescribeGameServerInstancesCommandInput, cb: (err: any, data?: DescribeGameServerInstancesCommandOutput) => void ): void; - public describeGameServerInstances( + describeGameServerInstances( args: DescribeGameServerInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGameServerInstancesCommandOutput) => void ): void; - public describeGameServerInstances( - args: DescribeGameServerInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGameServerInstancesCommandOutput) => void), - cb?: (err: any, data?: DescribeGameServerInstancesCommandOutput) => void - ): Promise | void { - const command = new DescribeGameServerInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves additional game session properties, including the game session protection - * policy in force, a set of one or more game sessions in a specific fleet location. You - * can optionally filter the results by current game session status.

- *

This operation can be used in the following ways:

- *
    - *
  • - *

    To retrieve details for all game sessions that are currently running on all - * locations in a fleet, provide a fleet or alias ID, with an optional status - * filter. This approach returns details from the fleet's home Region and all - * remote locations.

    - *
  • - *
  • - *

    To retrieve details for all game sessions that are currently running on a - * specific fleet location, provide a fleet or alias ID and a location name, with - * optional status filter. The location can be the fleet's home Region or any - * remote location.

    - *
  • - *
  • - *

    To retrieve details for a specific game session, provide the game session ID. - * This approach looks for the game session ID in all fleets that reside in the - * Amazon Web Services Region defined in the request.

    - *
  • - *
- *

Use the pagination parameters to retrieve results as a set of sequential pages.

- *

If successful, a GameSessionDetail object is returned for each game - * session that matches the request.

- *

- * Learn more - *

- *

- * Find a game session - *

- *

- * All APIs by task - *

+ * @see {@link DescribeGameSessionDetailsCommand} */ - public describeGameSessionDetails( + describeGameSessionDetails( args: DescribeGameSessionDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGameSessionDetails( + describeGameSessionDetails( args: DescribeGameSessionDetailsCommandInput, cb: (err: any, data?: DescribeGameSessionDetailsCommandOutput) => void ): void; - public describeGameSessionDetails( + describeGameSessionDetails( args: DescribeGameSessionDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGameSessionDetailsCommandOutput) => void ): void; - public describeGameSessionDetails( - args: DescribeGameSessionDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGameSessionDetailsCommandOutput) => void), - cb?: (err: any, data?: DescribeGameSessionDetailsCommandOutput) => void - ): Promise | void { - const command = new DescribeGameSessionDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information, including current status, about a game session placement - * request.

- *

To get game session placement details, specify the placement ID.

- *

This operation is not designed to be continually called to track game session status. - * This practice can cause you to exceed your API limit, which results in errors. Instead, - * you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from - * FlexMatch or queues. Continuously polling with DescribeGameSessionPlacement - * should only be used for games in development with low game session usage.

+ * @see {@link DescribeGameSessionPlacementCommand} */ - public describeGameSessionPlacement( + describeGameSessionPlacement( args: DescribeGameSessionPlacementCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGameSessionPlacement( + describeGameSessionPlacement( args: DescribeGameSessionPlacementCommandInput, cb: (err: any, data?: DescribeGameSessionPlacementCommandOutput) => void ): void; - public describeGameSessionPlacement( + describeGameSessionPlacement( args: DescribeGameSessionPlacementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGameSessionPlacementCommandOutput) => void ): void; - public describeGameSessionPlacement( - args: DescribeGameSessionPlacementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGameSessionPlacementCommandOutput) => void), - cb?: (err: any, data?: DescribeGameSessionPlacementCommandOutput) => void - ): Promise | void { - const command = new DescribeGameSessionPlacementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the properties for one or more game session queues. When requesting multiple - * queues, use the pagination parameters to retrieve results as a set of sequential pages. - * When specifying a list of queues, objects are returned only for queues that currently - * exist in the Region.

- *

- * Learn more - *

- *

- * - * View Your Queues - *

+ * @see {@link DescribeGameSessionQueuesCommand} */ - public describeGameSessionQueues( + describeGameSessionQueues( args: DescribeGameSessionQueuesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGameSessionQueues( + describeGameSessionQueues( args: DescribeGameSessionQueuesCommandInput, cb: (err: any, data?: DescribeGameSessionQueuesCommandOutput) => void ): void; - public describeGameSessionQueues( + describeGameSessionQueues( args: DescribeGameSessionQueuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGameSessionQueuesCommandOutput) => void ): void; - public describeGameSessionQueues( - args: DescribeGameSessionQueuesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGameSessionQueuesCommandOutput) => void), - cb?: (err: any, data?: DescribeGameSessionQueuesCommandOutput) => void - ): Promise | void { - const command = new DescribeGameSessionQueuesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a set of one or more game sessions in a specific fleet location. You can - * optionally filter the results by current game session status.

- *

This operation can be used in the following ways:

- *
    - *
  • - *

    To retrieve all game sessions that are currently running on all locations in a - * fleet, provide a fleet or alias ID, with an optional status filter. This - * approach returns all game sessions in the fleet's home Region and all remote - * locations.

    - *
  • - *
  • - *

    To retrieve all game sessions that are currently running on a specific fleet - * location, provide a fleet or alias ID and a location name, with optional status - * filter. The location can be the fleet's home Region or any remote - * location.

    - *
  • - *
  • - *

    To retrieve a specific game session, provide the game session ID. This - * approach looks for the game session ID in all fleets that reside in the Amazon Web Services - * Region defined in the request.

    - *
  • - *
- *

Use the pagination parameters to retrieve results as a set of sequential pages.

- *

If successful, a GameSession object is returned for each game session - * that matches the request.

- *

This operation is not designed to be continually called to track game session status. - * This practice can cause you to exceed your API limit, which results in errors. Instead, - * you must configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or - * queues. Continuously polling with DescribeGameSessions should only be used - * for games in development with low game session usage.

- *

- * Available in Amazon GameLift Local. - *

- *

- * Learn more - *

- *

- * Find a game session - *

- *

- * All APIs by task - *

+ * @see {@link DescribeGameSessionsCommand} */ - public describeGameSessions( + describeGameSessions( args: DescribeGameSessionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGameSessions( + describeGameSessions( args: DescribeGameSessionsCommandInput, cb: (err: any, data?: DescribeGameSessionsCommandOutput) => void ): void; - public describeGameSessions( + describeGameSessions( args: DescribeGameSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGameSessionsCommandOutput) => void ): void; - public describeGameSessions( - args: DescribeGameSessionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGameSessionsCommandOutput) => void), - cb?: (err: any, data?: DescribeGameSessionsCommandOutput) => void - ): Promise | void { - const command = new DescribeGameSessionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a fleet's instances, including instance IDs, connection - * data, and status.

- *

This operation can be used in the following ways:

- *
    - *
  • - *

    To get information on all instances that are deployed to a fleet's home - * Region, provide the fleet ID.

    - *
  • - *
  • - *

    To get information on all instances that are deployed to a fleet's remote - * location, provide the fleet ID and location name.

    - *
  • - *
  • - *

    To get information on a specific instance in a fleet, provide the fleet ID and - * instance ID.

    - *
  • - *
- *

Use the pagination parameters to retrieve results as a set of sequential pages.

- *

If successful, an Instance object is returned for each requested - * instance. Instances are not returned in any particular order.

- *

- * Learn more - *

- *

- * Remotely Access Fleet - * Instances - *

- *

- * Debug Fleet - * Issues - *

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link DescribeInstancesCommand} */ - public describeInstances( + describeInstances( args: DescribeInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInstances( + describeInstances( args: DescribeInstancesCommandInput, cb: (err: any, data?: DescribeInstancesCommandOutput) => void ): void; - public describeInstances( + describeInstances( args: DescribeInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstancesCommandOutput) => void ): void; - public describeInstances( - args: DescribeInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInstancesCommandOutput) => void), - cb?: (err: any, data?: DescribeInstancesCommandOutput) => void - ): Promise | void { - const command = new DescribeInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket - * information, including--after a successful match is made--connection information for the - * resulting new game session.

- *

To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request - * is successful, a ticket object is returned for each requested ID that currently - * exists.

- *

This operation is not designed to be continually called to track matchmaking ticket - * status. This practice can cause you to exceed your API limit, which results in errors. - * Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide - * the topic ARN in the matchmaking configuration.

- *

- *

- * Learn more - *

- *

- * - * Add FlexMatch to a game client - *

- *

- * Set Up FlexMatch event - * notification - *

+ * @see {@link DescribeMatchmakingCommand} */ - public describeMatchmaking( + describeMatchmaking( args: DescribeMatchmakingCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMatchmaking( + describeMatchmaking( args: DescribeMatchmakingCommandInput, cb: (err: any, data?: DescribeMatchmakingCommandOutput) => void ): void; - public describeMatchmaking( + describeMatchmaking( args: DescribeMatchmakingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMatchmakingCommandOutput) => void ): void; - public describeMatchmaking( - args: DescribeMatchmakingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMatchmakingCommandOutput) => void), - cb?: (err: any, data?: DescribeMatchmakingCommandOutput) => void - ): Promise | void { - const command = new DescribeMatchmakingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the details of FlexMatch matchmaking configurations.

- *

This operation offers the following options: (1) retrieve all matchmaking - * configurations, (2) retrieve configurations for a specified list, or (3) retrieve all - * configurations that use a specified rule set name. When requesting multiple items, use - * the pagination parameters to retrieve results as a set of sequential pages.

- *

If successful, a configuration is returned for each requested name. When specifying a - * list of names, only configurations that currently exist are returned.

- *

- * Learn more - *

- *

- * Setting up FlexMatch matchmakers - *

+ * @see {@link DescribeMatchmakingConfigurationsCommand} */ - public describeMatchmakingConfigurations( + describeMatchmakingConfigurations( args: DescribeMatchmakingConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMatchmakingConfigurations( + describeMatchmakingConfigurations( args: DescribeMatchmakingConfigurationsCommandInput, cb: (err: any, data?: DescribeMatchmakingConfigurationsCommandOutput) => void ): void; - public describeMatchmakingConfigurations( + describeMatchmakingConfigurations( args: DescribeMatchmakingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMatchmakingConfigurationsCommandOutput) => void ): void; - public describeMatchmakingConfigurations( - args: DescribeMatchmakingConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMatchmakingConfigurationsCommandOutput) => void), - cb?: (err: any, data?: DescribeMatchmakingConfigurationsCommandOutput) => void - ): Promise | void { - const command = new DescribeMatchmakingConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing - * rule sets for the Region, or provide a list of one or more rule set names. When - * requesting multiple items, use the pagination parameters to retrieve results as a set of - * sequential pages. If successful, a rule set is returned for each requested name.

- *

- * Learn more - *

- * + * @see {@link DescribeMatchmakingRuleSetsCommand} */ - public describeMatchmakingRuleSets( + describeMatchmakingRuleSets( args: DescribeMatchmakingRuleSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMatchmakingRuleSets( + describeMatchmakingRuleSets( args: DescribeMatchmakingRuleSetsCommandInput, cb: (err: any, data?: DescribeMatchmakingRuleSetsCommandOutput) => void ): void; - public describeMatchmakingRuleSets( + describeMatchmakingRuleSets( args: DescribeMatchmakingRuleSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMatchmakingRuleSetsCommandOutput) => void ): void; - public describeMatchmakingRuleSets( - args: DescribeMatchmakingRuleSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMatchmakingRuleSetsCommandOutput) => void), - cb?: (err: any, data?: DescribeMatchmakingRuleSetsCommandOutput) => void - ): Promise | void { - const command = new DescribeMatchmakingRuleSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves properties for one or more player sessions.

- *

This action can be used in the following ways:

- *
    - *
  • - *

    To retrieve a specific player session, provide the player session ID - * only.

    - *
  • - *
  • - *

    To retrieve all player sessions in a game session, provide the game session ID - * only.

    - *
  • - *
  • - *

    To retrieve all player sessions for a specific player, provide a player ID - * only.

    - *
  • - *
- *

To request player sessions, specify either a player session ID, game session ID, or - * player ID. You can filter this request by player session status. Use the pagination - * parameters to retrieve results as a set of sequential pages.

- *

If successful, a PlayerSession object is returned for each session that - * matches the request.

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link DescribePlayerSessionsCommand} */ - public describePlayerSessions( + describePlayerSessions( args: DescribePlayerSessionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePlayerSessions( + describePlayerSessions( args: DescribePlayerSessionsCommandInput, cb: (err: any, data?: DescribePlayerSessionsCommandOutput) => void ): void; - public describePlayerSessions( + describePlayerSessions( args: DescribePlayerSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePlayerSessionsCommandOutput) => void ): void; - public describePlayerSessions( - args: DescribePlayerSessionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePlayerSessionsCommandOutput) => void), - cb?: (err: any, data?: DescribePlayerSessionsCommandOutput) => void - ): Promise | void { - const command = new DescribePlayerSessionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a fleet's runtime configuration settings. The runtime configuration tells - * GameLift which server processes to run (and how) on each instance in the fleet.

- *

To get the runtime configuration that is currently in forces for a fleet, provide the - * fleet ID.

- *

If successful, a RuntimeConfiguration object is returned for the - * requested fleet. If the requested fleet has been deleted, the result set is - * empty.

- *

- * Learn more - *

- *

- * Setting up GameLift - * fleets - *

- *

- * Running multiple - * processes on a fleet - *

+ * @see {@link DescribeRuntimeConfigurationCommand} */ - public describeRuntimeConfiguration( + describeRuntimeConfiguration( args: DescribeRuntimeConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRuntimeConfiguration( + describeRuntimeConfiguration( args: DescribeRuntimeConfigurationCommandInput, cb: (err: any, data?: DescribeRuntimeConfigurationCommandOutput) => void ): void; - public describeRuntimeConfiguration( + describeRuntimeConfiguration( args: DescribeRuntimeConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRuntimeConfigurationCommandOutput) => void ): void; - public describeRuntimeConfiguration( - args: DescribeRuntimeConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRuntimeConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeRuntimeConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeRuntimeConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves all scaling policies applied to a fleet.

- *

To get a fleet's scaling policies, specify the fleet ID. You can filter this request - * by policy status, such as to retrieve only active scaling policies. Use the pagination - * parameters to retrieve results as a set of sequential pages. If successful, set of - * ScalingPolicy objects is returned for the fleet.

- *

A fleet may have all of its scaling policies suspended. This operation does not affect - * the status of the scaling policies, which remains ACTIVE.

+ * @see {@link DescribeScalingPoliciesCommand} */ - public describeScalingPolicies( + describeScalingPolicies( args: DescribeScalingPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeScalingPolicies( + describeScalingPolicies( args: DescribeScalingPoliciesCommandInput, cb: (err: any, data?: DescribeScalingPoliciesCommandOutput) => void ): void; - public describeScalingPolicies( + describeScalingPolicies( args: DescribeScalingPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScalingPoliciesCommandOutput) => void ): void; - public describeScalingPolicies( - args: DescribeScalingPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeScalingPoliciesCommandOutput) => void), - cb?: (err: any, data?: DescribeScalingPoliciesCommandOutput) => void - ): Promise | void { - const command = new DescribeScalingPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves properties for a Realtime script.

- *

To request a script record, specify the script ID. If successful, an object containing - * the script properties is returned.

- *

- * Learn more - *

- *

- * Amazon GameLift Realtime Servers - *

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link DescribeScriptCommand} */ - public describeScript( + describeScript( args: DescribeScriptCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeScript( - args: DescribeScriptCommandInput, - cb: (err: any, data?: DescribeScriptCommandOutput) => void - ): void; - public describeScript( + describeScript(args: DescribeScriptCommandInput, cb: (err: any, data?: DescribeScriptCommandOutput) => void): void; + describeScript( args: DescribeScriptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScriptCommandOutput) => void ): void; - public describeScript( - args: DescribeScriptCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeScriptCommandOutput) => void), - cb?: (err: any, data?: DescribeScriptCommandOutput) => void - ): Promise | void { - const command = new DescribeScriptCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account. - * This operation returns all VPC peering authorizations and requests for peering. This - * includes those initiated and received by this account.

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link DescribeVpcPeeringAuthorizationsCommand} */ - public describeVpcPeeringAuthorizations( + describeVpcPeeringAuthorizations( args: DescribeVpcPeeringAuthorizationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVpcPeeringAuthorizations( + describeVpcPeeringAuthorizations( args: DescribeVpcPeeringAuthorizationsCommandInput, cb: (err: any, data?: DescribeVpcPeeringAuthorizationsCommandOutput) => void ): void; - public describeVpcPeeringAuthorizations( + describeVpcPeeringAuthorizations( args: DescribeVpcPeeringAuthorizationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVpcPeeringAuthorizationsCommandOutput) => void ): void; - public describeVpcPeeringAuthorizations( - args: DescribeVpcPeeringAuthorizationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVpcPeeringAuthorizationsCommandOutput) => void), - cb?: (err: any, data?: DescribeVpcPeeringAuthorizationsCommandOutput) => void - ): Promise | void { - const command = new DescribeVpcPeeringAuthorizationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information on VPC peering connections. Use this operation to get peering - * information for all fleets or for one specific fleet ID.

- *

To retrieve connection information, call this operation from the Amazon Web Services account that is - * used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to - * retrieve all connection records. If successful, the retrieved information includes both - * active and pending connections. Active connections identify the IpV4 CIDR block that the - * VPC uses to connect.

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link DescribeVpcPeeringConnectionsCommand} */ - public describeVpcPeeringConnections( + describeVpcPeeringConnections( args: DescribeVpcPeeringConnectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVpcPeeringConnections( + describeVpcPeeringConnections( args: DescribeVpcPeeringConnectionsCommandInput, cb: (err: any, data?: DescribeVpcPeeringConnectionsCommandOutput) => void ): void; - public describeVpcPeeringConnections( + describeVpcPeeringConnections( args: DescribeVpcPeeringConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVpcPeeringConnectionsCommandOutput) => void ): void; - public describeVpcPeeringConnections( - args: DescribeVpcPeeringConnectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVpcPeeringConnectionsCommandOutput) => void), - cb?: (err: any, data?: DescribeVpcPeeringConnectionsCommandOutput) => void - ): Promise | void { - const command = new DescribeVpcPeeringConnectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Requests remote access to a fleet instance. Remote access is useful for debugging, - * gathering benchmarking data, or observing activity in real time.

- *

To remotely access an instance, you need credentials that match the operating system - * of the instance. For a Windows instance, GameLift returns a user name and password as - * strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift - * returns a user name and RSA private key, also as strings, for use with an SSH client. - * The private key must be saved in the proper format to a .pem file before - * using. If you're making this request using the CLI, saving the secret can be handled - * as part of the GetInstanceAccess request, as shown in one of the examples - * for this operation.

- *

To request access to a specific instance, specify the IDs of both the instance and the - * fleet it belongs to.

- *

- * Learn more - *

- *

- * Remotely Access Fleet - * Instances - *

- *

- * Debug Fleet - * Issues - *

+ * @see {@link GetComputeAccessCommand} */ - public getComputeAccess( + getComputeAccess( args: GetComputeAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public getComputeAccess( + getComputeAccess( args: GetComputeAccessCommandInput, cb: (err: any, data?: GetComputeAccessCommandOutput) => void ): void; - public getComputeAccess( + getComputeAccess( args: GetComputeAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComputeAccessCommandOutput) => void ): void; - public getComputeAccess( - args: GetComputeAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetComputeAccessCommandOutput) => void), - cb?: (err: any, data?: GetComputeAccessCommandOutput) => void - ): Promise | void { - const command = new GetComputeAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Requests an authorization token from GameLift. The authorization token is used by your - * game server to authenticate with GameLift. Each authentication token has an expiration - * token. To continue using the compute resource to host your game server, regularly - * retrieve a new authorization token.

+ * @see {@link GetComputeAuthTokenCommand} */ - public getComputeAuthToken( + getComputeAuthToken( args: GetComputeAuthTokenCommandInput, options?: __HttpHandlerOptions ): Promise; - public getComputeAuthToken( + getComputeAuthToken( args: GetComputeAuthTokenCommandInput, cb: (err: any, data?: GetComputeAuthTokenCommandOutput) => void ): void; - public getComputeAuthToken( + getComputeAuthToken( args: GetComputeAuthTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComputeAuthTokenCommandOutput) => void ): void; - public getComputeAuthToken( - args: GetComputeAuthTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetComputeAuthTokenCommandOutput) => void), - cb?: (err: any, data?: GetComputeAuthTokenCommandOutput) => void - ): Promise | void { - const command = new GetComputeAuthTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the location of stored game session logs for a specified game session. When - * a game session is terminated, GameLift automatically stores the logs in Amazon S3 and - * retains them for 14 days. Use this URL to download the logs.

- * - *

See the Amazon Web Services Service - * Limits page for maximum log file sizes. Log files that exceed this limit - * are not saved.

- *
- *

- * All APIs by task - *

+ * @see {@link GetGameSessionLogUrlCommand} */ - public getGameSessionLogUrl( + getGameSessionLogUrl( args: GetGameSessionLogUrlCommandInput, options?: __HttpHandlerOptions ): Promise; - public getGameSessionLogUrl( + getGameSessionLogUrl( args: GetGameSessionLogUrlCommandInput, cb: (err: any, data?: GetGameSessionLogUrlCommandOutput) => void ): void; - public getGameSessionLogUrl( + getGameSessionLogUrl( args: GetGameSessionLogUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGameSessionLogUrlCommandOutput) => void ): void; - public getGameSessionLogUrl( - args: GetGameSessionLogUrlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGameSessionLogUrlCommandOutput) => void), - cb?: (err: any, data?: GetGameSessionLogUrlCommandOutput) => void - ): Promise | void { - const command = new GetGameSessionLogUrlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Requests remote access to a fleet instance. Remote access is useful for debugging, - * gathering benchmarking data, or observing activity in real time.

- *

To remotely access an instance, you need credentials that match the operating system - * of the instance. For a Windows instance, GameLift returns a user name and password as - * strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift - * returns a user name and RSA private key, also as strings, for use with an SSH client. - * The private key must be saved in the proper format to a .pem file before - * using. If you're making this request using the CLI, saving the secret can be handled - * as part of the GetInstanceAccess request, as shown in one of the examples - * for this operation.

- *

To request access to a specific instance, specify the IDs of both the instance and the - * fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances.

- *

- * Learn more - *

- *

- * Remotely Access Fleet - * Instances - *

- *

- * Debug Fleet - * Issues - *

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link GetInstanceAccessCommand} */ - public getInstanceAccess( + getInstanceAccess( args: GetInstanceAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInstanceAccess( + getInstanceAccess( args: GetInstanceAccessCommandInput, cb: (err: any, data?: GetInstanceAccessCommandOutput) => void ): void; - public getInstanceAccess( + getInstanceAccess( args: GetInstanceAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInstanceAccessCommandOutput) => void ): void; - public getInstanceAccess( - args: GetInstanceAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInstanceAccessCommandOutput) => void), - cb?: (err: any, data?: GetInstanceAccessCommandOutput) => void - ): Promise | void { - const command = new GetInstanceAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves all aliases for this Amazon Web Services account. You can filter the result set by alias - * name and/or routing strategy type. Use the pagination parameters to retrieve results in - * sequential pages.

- * - *

Returned aliases are not listed in any particular order.

- *
- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link ListAliasesCommand} */ - public listAliases(args: ListAliasesCommandInput, options?: __HttpHandlerOptions): Promise; - public listAliases(args: ListAliasesCommandInput, cb: (err: any, data?: ListAliasesCommandOutput) => void): void; - public listAliases( + listAliases(args: ListAliasesCommandInput, options?: __HttpHandlerOptions): Promise; + listAliases(args: ListAliasesCommandInput, cb: (err: any, data?: ListAliasesCommandOutput) => void): void; + listAliases( args: ListAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAliasesCommandOutput) => void ): void; - public listAliases( - args: ListAliasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAliasesCommandOutput) => void), - cb?: (err: any, data?: ListAliasesCommandOutput) => void - ): Promise | void { - const command = new ListAliasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves build resources for all builds associated with the Amazon Web Services account in use. You - * can limit results to builds that are in a specific status by using the - * Status parameter. Use the pagination parameters to retrieve results in - * a set of sequential pages.

- * - *

Build resources are not listed in any particular order.

- *
- *

- * Learn more - *

- *

- * Upload a Custom - * Server Build - *

- *

- * All APIs by task - *

+ * @see {@link ListBuildsCommand} */ - public listBuilds(args: ListBuildsCommandInput, options?: __HttpHandlerOptions): Promise; - public listBuilds(args: ListBuildsCommandInput, cb: (err: any, data?: ListBuildsCommandOutput) => void): void; - public listBuilds( + listBuilds(args: ListBuildsCommandInput, options?: __HttpHandlerOptions): Promise; + listBuilds(args: ListBuildsCommandInput, cb: (err: any, data?: ListBuildsCommandOutput) => void): void; + listBuilds( args: ListBuildsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBuildsCommandOutput) => void ): void; - public listBuilds( - args: ListBuildsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBuildsCommandOutput) => void), - cb?: (err: any, data?: ListBuildsCommandOutput) => void - ): Promise | void { - const command = new ListBuildsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves all compute resources registered to a fleet in your Amazon Web Services account. You can filter the result set by location.

+ * @see {@link ListComputeCommand} */ - public listCompute(args: ListComputeCommandInput, options?: __HttpHandlerOptions): Promise; - public listCompute(args: ListComputeCommandInput, cb: (err: any, data?: ListComputeCommandOutput) => void): void; - public listCompute( + listCompute(args: ListComputeCommandInput, options?: __HttpHandlerOptions): Promise; + listCompute(args: ListComputeCommandInput, cb: (err: any, data?: ListComputeCommandOutput) => void): void; + listCompute( args: ListComputeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComputeCommandOutput) => void ): void; - public listCompute( - args: ListComputeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListComputeCommandOutput) => void), - cb?: (err: any, data?: ListComputeCommandOutput) => void - ): Promise | void { - const command = new ListComputeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a collection of fleet resources in an Amazon Web Services Region. You can call this - * operation to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor - * specify a Region in your request. You can filter the result set to find only those - * fleets that are deployed with a specific build or script. For fleets that have multiple - * locations, this operation retrieves fleets based on their home Region only.

- *

This operation can be used in the following ways:

- *
    - *
  • - *

    To get a list of all fleets in a Region, don't provide a build or script - * identifier.

    - *
  • - *
  • - *

    To get a list of all fleets where a specific custom game build is deployed, - * provide the build ID.

    - *
  • - *
  • - *

    To get a list of all Realtime Servers fleets with a specific configuration script, - * provide the script ID.

    - *
  • - *
- *

Use the pagination parameters to retrieve results as a set of sequential pages.

- *

If successful, a list of fleet IDs that match the request parameters is returned. A - * NextToken value is also returned if there are more result pages to retrieve.

- * - *

Fleet resources are not listed in a particular order.

- *
- *

- * Learn more - *

- *

- * Setting up GameLift - * fleets - *

+ * @see {@link ListFleetsCommand} */ - public listFleets(args: ListFleetsCommandInput, options?: __HttpHandlerOptions): Promise; - public listFleets(args: ListFleetsCommandInput, cb: (err: any, data?: ListFleetsCommandOutput) => void): void; - public listFleets( + listFleets(args: ListFleetsCommandInput, options?: __HttpHandlerOptions): Promise; + listFleets(args: ListFleetsCommandInput, cb: (err: any, data?: ListFleetsCommandOutput) => void): void; + listFleets( args: ListFleetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFleetsCommandOutput) => void ): void; - public listFleets( - args: ListFleetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFleetsCommandOutput) => void), - cb?: (err: any, data?: ListFleetsCommandOutput) => void - ): Promise | void { - const command = new ListFleetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists a game server groups.

+ * @see {@link ListGameServerGroupsCommand} */ - public listGameServerGroups( + listGameServerGroups( args: ListGameServerGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGameServerGroups( + listGameServerGroups( args: ListGameServerGroupsCommandInput, cb: (err: any, data?: ListGameServerGroupsCommandOutput) => void ): void; - public listGameServerGroups( + listGameServerGroups( args: ListGameServerGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGameServerGroupsCommandOutput) => void ): void; - public listGameServerGroups( - args: ListGameServerGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGameServerGroupsCommandOutput) => void), - cb?: (err: any, data?: ListGameServerGroupsCommandOutput) => void - ): Promise | void { - const command = new ListGameServerGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * This operation is used with the GameLift FleetIQ solution and game server groups. - *

- *

Retrieves information on all game - * servers that are currently active in a specified game server group. You can opt to sort - * the list by game server age. Use the pagination parameters to retrieve results in a set - * of sequential segments.

- *

- * Learn more - *

- *

- * GameLift FleetIQ - * Guide - *

+ * @see {@link ListGameServersCommand} */ - public listGameServers( + listGameServers( args: ListGameServersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGameServers( - args: ListGameServersCommandInput, - cb: (err: any, data?: ListGameServersCommandOutput) => void - ): void; - public listGameServers( + listGameServers(args: ListGameServersCommandInput, cb: (err: any, data?: ListGameServersCommandOutput) => void): void; + listGameServers( args: ListGameServersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGameServersCommandOutput) => void ): void; - public listGameServers( - args: ListGameServersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGameServersCommandOutput) => void), - cb?: (err: any, data?: ListGameServersCommandOutput) => void - ): Promise | void { - const command = new ListGameServersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all custom and Amazon Web Services locations.

+ * @see {@link ListLocationsCommand} */ - public listLocations( - args: ListLocationsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listLocations( - args: ListLocationsCommandInput, - cb: (err: any, data?: ListLocationsCommandOutput) => void - ): void; - public listLocations( + listLocations(args: ListLocationsCommandInput, options?: __HttpHandlerOptions): Promise; + listLocations(args: ListLocationsCommandInput, cb: (err: any, data?: ListLocationsCommandOutput) => void): void; + listLocations( args: ListLocationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLocationsCommandOutput) => void ): void; - public listLocations( - args: ListLocationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLocationsCommandOutput) => void), - cb?: (err: any, data?: ListLocationsCommandOutput) => void - ): Promise | void { - const command = new ListLocationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services - * account in use.

- *

- * Learn more - *

- *

- * Amazon GameLift Realtime Servers - *

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link ListScriptsCommand} */ - public listScripts(args: ListScriptsCommandInput, options?: __HttpHandlerOptions): Promise; - public listScripts(args: ListScriptsCommandInput, cb: (err: any, data?: ListScriptsCommandOutput) => void): void; - public listScripts( + listScripts(args: ListScriptsCommandInput, options?: __HttpHandlerOptions): Promise; + listScripts(args: ListScriptsCommandInput, cb: (err: any, data?: ListScriptsCommandOutput) => void): void; + listScripts( args: ListScriptsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListScriptsCommandOutput) => void ): void; - public listScripts( - args: ListScriptsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListScriptsCommandOutput) => void), - cb?: (err: any, data?: ListScriptsCommandOutput) => void - ): Promise | void { - const command = new ListScriptsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves all tags that are assigned to a GameLift resource. Resource tags are used to - * organize Amazon Web Services resources for a range of purposes. This operation handles the permissions - * necessary to manage tags for the following GameLift resource types:

- *
    - *
  • - *

    Build

    - *
  • - *
  • - *

    Script

    - *
  • - *
  • - *

    Fleet

    - *
  • - *
  • - *

    Alias

    - *
  • - *
  • - *

    GameSessionQueue

    - *
  • - *
  • - *

    MatchmakingConfiguration

    - *
  • - *
  • - *

    MatchmakingRuleSet

    - *
  • - *
- *

To list tags for a resource, specify the unique ARN value for the resource.

- *

- * Learn more - *

- *

- * Tagging Amazon Web Services - * Resources in the Amazon Web Services General Reference - *

- *

- * - * Amazon Web Services Tagging Strategies - *

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates a scaling policy for a fleet. Scaling policies are used to - * automatically scale a fleet's hosting capacity to meet player demand. An active scaling - * policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's - * capacity when a certain threshold is reached. There are two types of scaling policies: - * target-based and rule-based. Use a target-based policy to quickly and efficiently manage - * fleet scaling; this option is the most commonly used. Use rule-based policies when you - * need to exert fine-grained control over auto-scaling.

- *

Fleets can have multiple scaling policies of each type in force at the same time; you - * can have one target-based policy, one or multiple rule-based scaling policies, or both. - * We recommend caution, however, because multiple auto-scaling policies can have - * unintended consequences.

- *

Learn more about how to work with auto-scaling in Set Up Fleet Automatic - * Scaling.

- *

- * Target-based policy - *

- *

A target-based policy tracks a single metric: PercentAvailableGameSessions. This - * metric tells us how much of a fleet's hosting capacity is ready to host game sessions - * but is not currently in use. This is the fleet's buffer; it measures the additional - * player demand that the fleet could handle at current capacity. With a target-based - * policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is - * needed to maintain that target.

- *

For example, you might choose to maintain a 10% buffer for a fleet that has the - * capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action - * whenever the fleet's available capacity falls below or rises above 10 game sessions. - * Amazon GameLift will start new instances or stop unused instances in order to return to the 10% - * buffer.

- *

To create or update a target-based policy, specify a fleet ID and name, and set the - * policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions) - * and reference a TargetConfiguration object with your desired buffer value. - * Exclude all other parameters. On a successful request, the policy name is returned. The - * scaling policy is automatically in force as soon as it's successfully created. If the - * fleet's auto-scaling actions are temporarily suspended, the new policy will be in force - * once the fleet actions are restarted.

- *

- * Rule-based policy - *

- *

A rule-based policy tracks specified fleet metric, sets a threshold value, and - * specifies the type of action to initiate when triggered. With a rule-based policy, you - * can select from several available fleet metrics. Each policy specifies whether to scale - * up or scale down (and by how much), so you need one policy for each type of action.

- *

For example, a policy may make the following statement: "If the percentage of idle - * instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity - * by 10%."

- *

A policy's rule statement has the following structure:

- *

If [MetricName] is [ComparisonOperator] - * [Threshold] for [EvaluationPeriods] minutes, then - * [ScalingAdjustmentType] to/by [ScalingAdjustment].

- *

To implement the example, the rule statement would look like this:

- *

If [PercentIdleInstances] is [GreaterThanThreshold] - * [20] for [15] minutes, then - * [PercentChangeInCapacity] to/by [10].

- *

To create or update a scaling policy, specify a unique combination of name and fleet - * ID, and set the policy type to "RuleBased". Specify the parameter values for a policy - * rule statement. On a successful request, the policy name is returned. Scaling policies - * are automatically in force as soon as they're successfully created. If the fleet's - * auto-scaling actions are temporarily suspended, the new policy will be in force once the - * fleet actions are restarted.

+ * @see {@link PutScalingPolicyCommand} */ - public putScalingPolicy( + putScalingPolicy( args: PutScalingPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putScalingPolicy( + putScalingPolicy( args: PutScalingPolicyCommandInput, cb: (err: any, data?: PutScalingPolicyCommandOutput) => void ): void; - public putScalingPolicy( + putScalingPolicy( args: PutScalingPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutScalingPolicyCommandOutput) => void ): void; - public putScalingPolicy( - args: PutScalingPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutScalingPolicyCommandOutput) => void), - cb?: (err: any, data?: PutScalingPolicyCommandOutput) => void - ): Promise | void { - const command = new PutScalingPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers your compute resources in a fleet you previously created. After you register - * a compute to your fleet, you can monitor and manage your compute using GameLift. The - * operation returns the compute resource containing SDK endpoint you can use to connect - * your game server to GameLift.

- *

- * Learn more - *

- * + * @see {@link RegisterComputeCommand} */ - public registerCompute( + registerCompute( args: RegisterComputeCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerCompute( - args: RegisterComputeCommandInput, - cb: (err: any, data?: RegisterComputeCommandOutput) => void - ): void; - public registerCompute( + registerCompute(args: RegisterComputeCommandInput, cb: (err: any, data?: RegisterComputeCommandOutput) => void): void; + registerCompute( args: RegisterComputeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterComputeCommandOutput) => void ): void; - public registerCompute( - args: RegisterComputeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterComputeCommandOutput) => void), - cb?: (err: any, data?: RegisterComputeCommandOutput) => void - ): Promise | void { - const command = new RegisterComputeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * This operation is used with the GameLift FleetIQ solution and game server groups. - *

- *

Creates a new game server - * resource and notifies GameLift FleetIQ that the game server is ready to host gameplay and players. - * This operation is called by a game server process that is running on an instance in a - * game server group. Registering game servers enables GameLift FleetIQ to track available game - * servers and enables game clients and services to claim a game server for a new game - * session.

- *

To register a game server, identify the game server group and instance where the game - * server is running, and provide a unique identifier for the game server. You can also - * include connection and game server data.

- *

Once a game server is successfully registered, it is put in status - * AVAILABLE. A request to register a game server may fail if the instance - * it is running on is in the process of shutting down as part of instance balancing or - * scale-down activity.

- *

- * Learn more - *

- *

- * GameLift FleetIQ - * Guide - *

+ * @see {@link RegisterGameServerCommand} */ - public registerGameServer( + registerGameServer( args: RegisterGameServerCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerGameServer( + registerGameServer( args: RegisterGameServerCommandInput, cb: (err: any, data?: RegisterGameServerCommandOutput) => void ): void; - public registerGameServer( + registerGameServer( args: RegisterGameServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterGameServerCommandOutput) => void ): void; - public registerGameServer( - args: RegisterGameServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterGameServerCommandOutput) => void), - cb?: (err: any, data?: RegisterGameServerCommandOutput) => void - ): Promise | void { - const command = new RegisterGameServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a fresh set of credentials for use when uploading a new set of game build - * files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see - * GameSession.

- *

To request new credentials, specify the build ID as returned with an initial - * CreateBuild request. If successful, a new set of credentials are - * returned, along with the S3 storage location associated with the build ID.

- *

- * Learn more - *

- *

- * Create a Build with Files in S3 - *

- *

- * All APIs by task - *

+ * @see {@link RequestUploadCredentialsCommand} */ - public requestUploadCredentials( + requestUploadCredentials( args: RequestUploadCredentialsCommandInput, options?: __HttpHandlerOptions ): Promise; - public requestUploadCredentials( + requestUploadCredentials( args: RequestUploadCredentialsCommandInput, cb: (err: any, data?: RequestUploadCredentialsCommandOutput) => void ): void; - public requestUploadCredentials( + requestUploadCredentials( args: RequestUploadCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RequestUploadCredentialsCommandOutput) => void ): void; - public requestUploadCredentials( - args: RequestUploadCredentialsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RequestUploadCredentialsCommandOutput) => void), - cb?: (err: any, data?: RequestUploadCredentialsCommandOutput) => void - ): Promise | void { - const command = new RequestUploadCredentialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the fleet ID that an alias is currently pointing to.

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link ResolveAliasCommand} */ - public resolveAlias( - args: ResolveAliasCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public resolveAlias(args: ResolveAliasCommandInput, cb: (err: any, data?: ResolveAliasCommandOutput) => void): void; - public resolveAlias( + resolveAlias(args: ResolveAliasCommandInput, options?: __HttpHandlerOptions): Promise; + resolveAlias(args: ResolveAliasCommandInput, cb: (err: any, data?: ResolveAliasCommandOutput) => void): void; + resolveAlias( args: ResolveAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResolveAliasCommandOutput) => void ): void; - public resolveAlias( - args: ResolveAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResolveAliasCommandOutput) => void), - cb?: (err: any, data?: ResolveAliasCommandOutput) => void - ): Promise | void { - const command = new ResolveAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * This operation is used with the GameLift FleetIQ solution and game server groups. - *

- *

Reinstates activity on a game - * server group after it has been suspended. A game server group might be suspended by the - * SuspendGameServerGroup operation, or it might be suspended involuntarily - * due to a configuration problem. In the second case, you can manually resume activity on - * the group once the configuration problem has been resolved. Refer to the game server - * group status and status reason for more information on why group activity is - * suspended.

- *

To resume activity, specify a game server group ARN and the type of activity to be - * resumed. If successful, a GameServerGroup object is returned showing that - * the resumed activity is no longer listed in SuspendedActions.

- *

- * Learn more - *

- *

- * GameLift FleetIQ - * Guide - *

+ * @see {@link ResumeGameServerGroupCommand} */ - public resumeGameServerGroup( + resumeGameServerGroup( args: ResumeGameServerGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public resumeGameServerGroup( + resumeGameServerGroup( args: ResumeGameServerGroupCommandInput, cb: (err: any, data?: ResumeGameServerGroupCommandOutput) => void ): void; - public resumeGameServerGroup( + resumeGameServerGroup( args: ResumeGameServerGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResumeGameServerGroupCommandOutput) => void ): void; - public resumeGameServerGroup( - args: ResumeGameServerGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResumeGameServerGroupCommandOutput) => void), - cb?: (err: any, data?: ResumeGameServerGroupCommandOutput) => void - ): Promise | void { - const command = new ResumeGameServerGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves all active game sessions that match a set of search criteria and sorts them - * into a specified order.

- *

This operation is not designed to be continually called to track game session status. - * This practice can cause you to exceed your API limit, which results in errors. Instead, - * you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from - * FlexMatch or queues. Continuously polling game session status with - * DescribeGameSessions should only be used for games in development with - * low game session usage.

- *

When searching for game sessions, you specify exactly where you want to search and - * provide a search filter expression, a sort expression, or both. A search request can - * search only one fleet, but it can search all of a fleet's locations.

- *

This operation can be used in the following ways:

- *
    - *
  • - *

    To search all game sessions that are currently running on all locations in a - * fleet, provide a fleet or alias ID. This approach returns game sessions in the - * fleet's home Region and all remote locations that fit the search - * criteria.

    - *
  • - *
  • - *

    To search all game sessions that are currently running on a specific fleet - * location, provide a fleet or alias ID and a location name. For location, you can - * specify a fleet's home Region or any remote location.

    - *
  • - *
- *

Use the pagination parameters to retrieve results as a set of sequential pages.

- *

If successful, a GameSession object is returned for each game session - * that matches the request. Search finds game sessions that are in ACTIVE - * status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions .

- *

You can search or sort by the following game session attributes:

- *
    - *
  • - *

    - * gameSessionId -- A unique identifier for the game session. You can use either a - * GameSessionId or GameSessionArn value.

    - *
  • - *
  • - *

    - * gameSessionName -- Name assigned to a game - * session. Game session names do not need to be unique to a game session.

    - *
  • - *
  • - *

    - * gameSessionProperties -- Custom data defined - * in a game session's GameProperty parameter. - * GameProperty values are stored as key:value pairs; the filter - * expression must indicate the key and a string to search the data values for. For - * example, to search for game sessions with custom data containing the key:value - * pair "gameMode:brawl", specify the following: - * gameSessionProperties.gameMode = "brawl". All custom data - * values are searched as strings.

    - *
  • - *
  • - *

    - * maximumSessions -- Maximum number of player - * sessions allowed for a game session.

    - *
  • - *
  • - *

    - * creationTimeMillis -- Value indicating when a - * game session was created. It is expressed in Unix time as milliseconds.

    - *
  • - *
  • - *

    - * playerSessionCount -- Number of players - * currently connected to a game session. This value changes rapidly as players - * join the session or drop out.

    - *
  • - *
  • - *

    - * hasAvailablePlayerSessions -- Boolean value - * indicating whether a game session has reached its maximum number of players. It - * is highly recommended that all search requests include this filter attribute to - * optimize search performance and return only sessions that players can join. - *

    - *
  • - *
- * - *

Returned values for playerSessionCount and - * hasAvailablePlayerSessions change quickly as players join sessions - * and others drop out. Results should be considered a snapshot in time. Be sure to - * refresh search results often, and handle sessions that fill up before a player can - * join.

- *
- *

- * All APIs by task - *

+ * @see {@link SearchGameSessionsCommand} */ - public searchGameSessions( + searchGameSessions( args: SearchGameSessionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchGameSessions( + searchGameSessions( args: SearchGameSessionsCommandInput, cb: (err: any, data?: SearchGameSessionsCommandOutput) => void ): void; - public searchGameSessions( + searchGameSessions( args: SearchGameSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchGameSessionsCommandOutput) => void ): void; - public searchGameSessions( - args: SearchGameSessionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchGameSessionsCommandOutput) => void), - cb?: (err: any, data?: SearchGameSessionsCommandOutput) => void - ): Promise | void { - const command = new SearchGameSessionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Resumes certain types of activity on fleet instances that were suspended with StopFleetActions. For multi-location fleets, fleet actions are managed - * separately for each location. Currently, this operation is used to restart a fleet's - * auto-scaling activity.

- *

This operation can be used in the following ways:

- *
    - *
  • - *

    To restart actions on instances in the fleet's home Region, provide a fleet ID - * and the type of actions to resume.

    - *
  • - *
  • - *

    To restart actions on instances in one of the fleet's remote locations, - * provide a fleet ID, a location name, and the type of actions to resume.

    - *
  • - *
- *

If successful, GameLift once again initiates scaling events as triggered by the fleet's - * scaling policies. If actions on the fleet location were never stopped, this operation - * will have no effect.

- *

- * Learn more - *

- *

- * Setting up GameLift - * fleets - *

+ * @see {@link StartFleetActionsCommand} */ - public startFleetActions( + startFleetActions( args: StartFleetActionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public startFleetActions( + startFleetActions( args: StartFleetActionsCommandInput, cb: (err: any, data?: StartFleetActionsCommandOutput) => void ): void; - public startFleetActions( + startFleetActions( args: StartFleetActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFleetActionsCommandOutput) => void ): void; - public startFleetActions( - args: StartFleetActionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartFleetActionsCommandOutput) => void), - cb?: (err: any, data?: StartFleetActionsCommandOutput) => void - ): Promise | void { - const command = new StartFleetActionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Places a request for a new game session in a queue. When processing a placement - * request, Amazon GameLift searches for available resources on the queue's destinations, scanning - * each until it finds resources or the placement request times out.

- *

A game session placement request can also request player sessions. When a new game - * session is successfully created, Amazon GameLift creates a player session for each player - * included in the request.

- *

When placing a game session, by default Amazon GameLift tries each fleet in the order they are - * listed in the queue configuration. Ideally, a queue's destinations are listed in - * preference order.

- *

Alternatively, when requesting a game session with players, you can also provide - * latency data for each player in relevant Regions. Latency data indicates the performance - * lag a player experiences when connected to a fleet in the Region. Amazon GameLift uses latency - * data to reorder the list of destinations to place the game session in a Region with - * minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each - * Region's average lag for all players and reorders to get the best game play across all - * players.

- *

To place a new game session request, specify the following:

- *
    - *
  • - *

    The queue name and a set of game session properties and settings

    - *
  • - *
  • - *

    A unique ID (such as a UUID) for the placement. You use this ID to track the - * status of the placement request

    - *
  • - *
  • - *

    (Optional) A set of player data and a unique player ID for each player that - * you are joining to the new game session (player data is optional, but if you - * include it, you must also provide a unique ID for each player)

    - *
  • - *
  • - *

    Latency data for all players (if you want to optimize game play for the - * players)

    - *
  • - *
- *

If successful, a new game session placement is created.

- *

To track the status of a placement request, call DescribeGameSessionPlacement and check the request's status. If the status - * is FULFILLED, a new game session has been created and a game session ARN - * and Region are referenced. If the placement request times out, you can resubmit the - * request or retry it with a different queue.

+ * @see {@link StartGameSessionPlacementCommand} */ - public startGameSessionPlacement( + startGameSessionPlacement( args: StartGameSessionPlacementCommandInput, options?: __HttpHandlerOptions ): Promise; - public startGameSessionPlacement( + startGameSessionPlacement( args: StartGameSessionPlacementCommandInput, cb: (err: any, data?: StartGameSessionPlacementCommandOutput) => void ): void; - public startGameSessionPlacement( + startGameSessionPlacement( args: StartGameSessionPlacementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartGameSessionPlacementCommandOutput) => void ): void; - public startGameSessionPlacement( - args: StartGameSessionPlacementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartGameSessionPlacementCommandOutput) => void), - cb?: (err: any, data?: StartGameSessionPlacementCommandOutput) => void - ): Promise | void { - const command = new StartGameSessionPlacementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Finds new players to fill open slots in currently running game sessions. The backfill - * match process is essentially identical to the process of forming new matches. Backfill - * requests use the same matchmaker that was used to make the original match, and they - * provide matchmaking data for all players currently in the game session. FlexMatch uses - * this information to select new players so that backfilled match continues to meet the - * original match requirements.

- *

When using FlexMatch with GameLift managed hosting, you can request a backfill match from - * a client service by calling this operation with a GameSessions ID. You also - * have the option of making backfill requests directly from your game server. In response - * to a request, FlexMatch creates player sessions for the new players, updates the - * GameSession resource, and sends updated matchmaking data to the game - * server. You can request a backfill match at any point after a game session is started. - * Each game session can have only one active backfill request at a time; a subsequent - * request automatically replaces the earlier request.

- *

When using FlexMatch as a standalone component, request a backfill match by calling this - * operation without a game session identifier. As with newly formed matches, matchmaking - * results are returned in a matchmaking event so that your game can update the game - * session that is being backfilled.

- *

To request a backfill match, specify a unique ticket ID, the original matchmaking - * configuration, and matchmaking data for all current players in the game session being - * backfilled. Optionally, specify the GameSession ARN. If successful, a match - * backfill ticket is created and returned with status set to QUEUED. Track the status of - * backfill tickets using the same method for tracking tickets for new matches.

- *

Only game sessions created by FlexMatch are supported for match backfill.

- *

- * Learn more - *

- *

- * - * Backfill existing games with FlexMatch - *

- *

- * - * Matchmaking events (reference)

- *

- * - * How GameLift FlexMatch works - *

+ * @see {@link StartMatchBackfillCommand} */ - public startMatchBackfill( + startMatchBackfill( args: StartMatchBackfillCommandInput, options?: __HttpHandlerOptions ): Promise; - public startMatchBackfill( + startMatchBackfill( args: StartMatchBackfillCommandInput, cb: (err: any, data?: StartMatchBackfillCommandOutput) => void ): void; - public startMatchBackfill( + startMatchBackfill( args: StartMatchBackfillCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMatchBackfillCommandOutput) => void ): void; - public startMatchBackfill( - args: StartMatchBackfillCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartMatchBackfillCommandOutput) => void), - cb?: (err: any, data?: StartMatchBackfillCommandOutput) => void - ): Promise | void { - const command = new StartMatchBackfillCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Uses FlexMatch to create a game match for a group of players based on custom matchmaking - * rules. With games that use GameLift managed hosting, this operation also triggers GameLift - * to find hosting resources and start a new game session for the new match. Each - * matchmaking request includes information on one or more players and specifies the - * FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch attempts to - * build a match that includes all players in the request, placing them in the same team - * and finding additional players as needed to fill the match.

- *

To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, - * and include the players to be matched. You must also include any player attributes that - * are required by the matchmaking configuration's rule set. If successful, a matchmaking - * ticket is returned with status set to QUEUED.

- *

Track matchmaking events to respond as needed and acquire game session connection - * information for successfully completed matches. Ticket status updates are tracked using - * event notification through Amazon Simple Notification Service, which is defined in the matchmaking - * configuration.

- *

- * Learn more - *

- *

- * - * Add FlexMatch to a game client - *

- *

- * Set Up FlexMatch event - * notification - *

- *

- * - * How GameLift FlexMatch works - *

+ * @see {@link StartMatchmakingCommand} */ - public startMatchmaking( + startMatchmaking( args: StartMatchmakingCommandInput, options?: __HttpHandlerOptions ): Promise; - public startMatchmaking( + startMatchmaking( args: StartMatchmakingCommandInput, cb: (err: any, data?: StartMatchmakingCommandOutput) => void ): void; - public startMatchmaking( + startMatchmaking( args: StartMatchmakingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMatchmakingCommandOutput) => void ): void; - public startMatchmaking( - args: StartMatchmakingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartMatchmakingCommandOutput) => void), - cb?: (err: any, data?: StartMatchmakingCommandOutput) => void - ): Promise | void { - const command = new StartMatchmakingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Suspends certain types of activity in a fleet location. Currently, this operation is - * used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed - * separately for each location.

- *

Stopping fleet actions has several potential purposes. It allows you to temporarily - * stop auto-scaling activity but retain your scaling policies for use in the future. For - * multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it - * for certain locations.

- *

This operation can be used in the following ways:

- *
    - *
  • - *

    To stop actions on instances in the fleet's home Region, provide a fleet ID - * and the type of actions to suspend.

    - *
  • - *
  • - *

    To stop actions on instances in one of the fleet's remote locations, provide a - * fleet ID, a location name, and the type of actions to suspend.

    - *
  • - *
- *

If successful, GameLift no longer initiates scaling events except in response to manual - * changes using UpdateFleetCapacity.

- *

- * Learn more - *

- *

- * Setting up GameLift - * Fleets - *

+ * @see {@link StopFleetActionsCommand} */ - public stopFleetActions( + stopFleetActions( args: StopFleetActionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopFleetActions( + stopFleetActions( args: StopFleetActionsCommandInput, cb: (err: any, data?: StopFleetActionsCommandOutput) => void ): void; - public stopFleetActions( + stopFleetActions( args: StopFleetActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopFleetActionsCommandOutput) => void ): void; - public stopFleetActions( - args: StopFleetActionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopFleetActionsCommandOutput) => void), - cb?: (err: any, data?: StopFleetActionsCommandOutput) => void - ): Promise | void { - const command = new StopFleetActionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels a game session placement that is in PENDING status. To stop a - * placement, provide the placement ID values. If successful, the placement is moved to - * CANCELLED status.

+ * @see {@link StopGameSessionPlacementCommand} */ - public stopGameSessionPlacement( + stopGameSessionPlacement( args: StopGameSessionPlacementCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopGameSessionPlacement( + stopGameSessionPlacement( args: StopGameSessionPlacementCommandInput, cb: (err: any, data?: StopGameSessionPlacementCommandOutput) => void ): void; - public stopGameSessionPlacement( + stopGameSessionPlacement( args: StopGameSessionPlacementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopGameSessionPlacementCommandOutput) => void ): void; - public stopGameSessionPlacement( - args: StopGameSessionPlacementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopGameSessionPlacementCommandOutput) => void), - cb?: (err: any, data?: StopGameSessionPlacementCommandOutput) => void - ): Promise | void { - const command = new StopGameSessionPlacementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels a matchmaking ticket or match backfill ticket that is currently being - * processed. To stop the matchmaking operation, specify the ticket ID. If successful, work - * on the ticket is stopped, and the ticket status is changed to - * CANCELLED.

- *

This call is also used to turn off automatic backfill for an individual game session. - * This is for game sessions that are created with a matchmaking configuration that has - * automatic backfill enabled. The ticket ID is included in the MatchmakerData - * of an updated game session object, which is provided to the game server.

- * - *

If the operation is successful, the service sends back an empty JSON struct with - * the HTTP 200 response (not an empty HTTP body).

- *
- *

- * Learn more - *

- *

- * - * Add FlexMatch to a game client - *

+ * @see {@link StopMatchmakingCommand} */ - public stopMatchmaking( + stopMatchmaking( args: StopMatchmakingCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopMatchmaking( - args: StopMatchmakingCommandInput, - cb: (err: any, data?: StopMatchmakingCommandOutput) => void - ): void; - public stopMatchmaking( + stopMatchmaking(args: StopMatchmakingCommandInput, cb: (err: any, data?: StopMatchmakingCommandOutput) => void): void; + stopMatchmaking( args: StopMatchmakingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopMatchmakingCommandOutput) => void ): void; - public stopMatchmaking( - args: StopMatchmakingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopMatchmakingCommandOutput) => void), - cb?: (err: any, data?: StopMatchmakingCommandOutput) => void - ): Promise | void { - const command = new StopMatchmakingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * This operation is used with the GameLift FleetIQ solution and game server groups. - *

- *

Temporarily stops activity on - * a game server group without terminating instances or the game server group. You can - * restart activity by calling ResumeGameServerGroup. You can suspend the following activity:

- *
    - *
  • - *

    - * Instance type replacement - This activity - * evaluates the current game hosting viability of all Spot instance types that are - * defined for the game server group. It updates the Auto Scaling group to remove - * nonviable Spot Instance types, which have a higher chance of game server - * interruptions. It then balances capacity across the remaining viable Spot - * Instance types. When this activity is suspended, the Auto Scaling group - * continues with its current balance, regardless of viability. Instance - * protection, utilization metrics, and capacity scaling activities continue to be - * active.

    - *
  • - *
- *

To suspend activity, specify a game server group ARN and the type of activity to be - * suspended. If successful, a GameServerGroup object is returned showing that - * the activity is listed in SuspendedActions.

- *

- * Learn more - *

- *

- * GameLift FleetIQ - * Guide - *

+ * @see {@link SuspendGameServerGroupCommand} */ - public suspendGameServerGroup( + suspendGameServerGroup( args: SuspendGameServerGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public suspendGameServerGroup( + suspendGameServerGroup( args: SuspendGameServerGroupCommandInput, cb: (err: any, data?: SuspendGameServerGroupCommandOutput) => void ): void; - public suspendGameServerGroup( + suspendGameServerGroup( args: SuspendGameServerGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SuspendGameServerGroupCommandOutput) => void ): void; - public suspendGameServerGroup( - args: SuspendGameServerGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SuspendGameServerGroupCommandOutput) => void), - cb?: (err: any, data?: SuspendGameServerGroupCommandOutput) => void - ): Promise | void { - const command = new SuspendGameServerGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns a tag to a GameLift resource. Amazon Web Services resource tags provide an additional - * management tool set. You can use tags to organize resources, create IAM permissions - * policies to manage access to groups of resources, customize Amazon Web Services cost breakdowns, etc. - * This operation handles the permissions necessary to manage tags for the following - * GameLift resource types:

- *
    - *
  • - *

    Build

    - *
  • - *
  • - *

    Script

    - *
  • - *
  • - *

    Fleet

    - *
  • - *
  • - *

    Alias

    - *
  • - *
  • - *

    GameSessionQueue

    - *
  • - *
  • - *

    MatchmakingConfiguration

    - *
  • - *
  • - *

    MatchmakingRuleSet

    - *
  • - *
- *

To add a tag to a resource, specify the unique ARN value for the resource and provide - * a tag list containing one or more tags. The operation succeeds even if the list includes - * tags that are already assigned to the specified resource.

- *

- * Learn more - *

- *

- * Tagging Amazon Web Services - * Resources in the Amazon Web Services General Reference - *

- *

- * - * Amazon Web Services Tagging Strategies - *

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a tag that is assigned to a GameLift resource. Resource tags are used to - * organize Amazon Web Services resources for a range of purposes. This operation handles the permissions - * necessary to manage tags for the following GameLift resource types:

- *
    - *
  • - *

    Build

    - *
  • - *
  • - *

    Script

    - *
  • - *
  • - *

    Fleet

    - *
  • - *
  • - *

    Alias

    - *
  • - *
  • - *

    GameSessionQueue

    - *
  • - *
  • - *

    MatchmakingConfiguration

    - *
  • - *
  • - *

    MatchmakingRuleSet

    - *
  • - *
- *

To remove a tag from a resource, specify the unique ARN value for the resource and - * provide a string list containing one or more tags to be removed. This operation succeeds - * even if the list includes tags that are not currently assigned to the specified - * resource.

- *

- * Learn more - *

- *

- * Tagging Amazon Web Services - * Resources in the Amazon Web Services General Reference - *

- *

- * - * Amazon Web Services Tagging Strategies - *

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates properties for an alias. To update properties, specify the alias ID to be - * updated and provide the information to be changed. To reassign an alias to another - * fleet, provide an updated routing strategy. If successful, the updated alias record is - * returned.

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link UpdateAliasCommand} */ - public updateAlias(args: UpdateAliasCommandInput, options?: __HttpHandlerOptions): Promise; - public updateAlias(args: UpdateAliasCommandInput, cb: (err: any, data?: UpdateAliasCommandOutput) => void): void; - public updateAlias( + updateAlias(args: UpdateAliasCommandInput, options?: __HttpHandlerOptions): Promise; + updateAlias(args: UpdateAliasCommandInput, cb: (err: any, data?: UpdateAliasCommandOutput) => void): void; + updateAlias( args: UpdateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAliasCommandOutput) => void ): void; - public updateAlias( - args: UpdateAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAliasCommandOutput) => void), - cb?: (err: any, data?: UpdateAliasCommandOutput) => void - ): Promise | void { - const command = new UpdateAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates metadata in a build resource, including the build name and version. To update - * the metadata, specify the build ID to update and provide the new values. If successful, - * a build object containing the updated metadata is returned.

- *

- * Learn more - *

- *

- * Upload a Custom - * Server Build - *

- *

- * All APIs by task - *

+ * @see {@link UpdateBuildCommand} */ - public updateBuild(args: UpdateBuildCommandInput, options?: __HttpHandlerOptions): Promise; - public updateBuild(args: UpdateBuildCommandInput, cb: (err: any, data?: UpdateBuildCommandOutput) => void): void; - public updateBuild( + updateBuild(args: UpdateBuildCommandInput, options?: __HttpHandlerOptions): Promise; + updateBuild(args: UpdateBuildCommandInput, cb: (err: any, data?: UpdateBuildCommandOutput) => void): void; + updateBuild( args: UpdateBuildCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBuildCommandOutput) => void ): void; - public updateBuild( - args: UpdateBuildCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBuildCommandOutput) => void), - cb?: (err: any, data?: UpdateBuildCommandOutput) => void - ): Promise | void { - const command = new UpdateBuildCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a fleet's mutable attributes, including game session protection and resource - * creation limits.

- *

To update fleet attributes, specify the fleet ID and the property values that you want - * to change.

- *

If successful, an updated FleetAttributes object is returned.

- *

- * Learn more - *

- *

- * Setting up GameLift - * fleets - *

+ * @see {@link UpdateFleetAttributesCommand} */ - public updateFleetAttributes( + updateFleetAttributes( args: UpdateFleetAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFleetAttributes( + updateFleetAttributes( args: UpdateFleetAttributesCommandInput, cb: (err: any, data?: UpdateFleetAttributesCommandOutput) => void ): void; - public updateFleetAttributes( + updateFleetAttributes( args: UpdateFleetAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFleetAttributesCommandOutput) => void ): void; - public updateFleetAttributes( - args: UpdateFleetAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFleetAttributesCommandOutput) => void), - cb?: (err: any, data?: UpdateFleetAttributesCommandOutput) => void - ): Promise | void { - const command = new UpdateFleetAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates capacity settings for a fleet. For fleets with multiple locations, use this - * operation to manage capacity settings in each location individually. Fleet capacity - * determines the number of game sessions and players that can be hosted based on the fleet - * configuration. Use this operation to set the following fleet capacity properties:

- *
    - *
  • - *

    Minimum/maximum size: Set hard limits on fleet capacity. GameLift cannot set - * the fleet's capacity to a value outside of this range, whether the capacity is - * changed manually or through automatic scaling.

    - *
  • - *
  • - *

    Desired capacity: Manually set the number of Amazon EC2 instances to be maintained - * in a fleet location. Before changing a fleet's desired capacity, you may want to - * call DescribeEC2InstanceLimits to get the maximum capacity of the - * fleet's Amazon EC2 instance type. Alternatively, consider using automatic scaling to - * adjust capacity based on player demand.

    - *
  • - *
- *

This operation can be used in the following ways:

- *
    - *
  • - *

    To update capacity for a fleet's home Region, or if the fleet has no remote - * locations, omit the Location parameter. The fleet must be in - * ACTIVE status.

    - *
  • - *
  • - *

    To update capacity for a fleet's remote location, include the - * Location parameter set to the location to be updated. The - * location must be in ACTIVE status.

    - *
  • - *
- *

If successful, capacity settings are updated immediately. In response a change in - * desired capacity, GameLift initiates steps to start new instances or terminate existing - * instances in the requested fleet location. This continues until the location's active - * instance count matches the new desired instance count. You can track a fleet's current - * capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity. If the requested desired instance count is - * higher than the instance type's limit, the LimitExceeded exception - * occurs.

- *

- * Learn more - *

- *

- * Scaling fleet - * capacity - *

+ * @see {@link UpdateFleetCapacityCommand} */ - public updateFleetCapacity( + updateFleetCapacity( args: UpdateFleetCapacityCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFleetCapacity( + updateFleetCapacity( args: UpdateFleetCapacityCommandInput, cb: (err: any, data?: UpdateFleetCapacityCommandOutput) => void ): void; - public updateFleetCapacity( + updateFleetCapacity( args: UpdateFleetCapacityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFleetCapacityCommandOutput) => void ): void; - public updateFleetCapacity( - args: UpdateFleetCapacityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFleetCapacityCommandOutput) => void), - cb?: (err: any, data?: UpdateFleetCapacityCommandOutput) => void - ): Promise | void { - const command = new UpdateFleetCapacityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates permissions that allow inbound traffic to connect to game sessions that are - * being hosted on instances in the fleet.

- *

To update settings, specify the fleet ID to be updated and specify the changes to be - * made. List the permissions you want to add in - * InboundPermissionAuthorizations, and permissions you want to remove in - * InboundPermissionRevocations. Permissions to be removed must match - * existing fleet permissions.

- *

If successful, the fleet ID for the updated fleet is returned. For fleets with remote - * locations, port setting updates can take time to propagate across all locations. You can - * check the status of updates in each location by calling - * DescribeFleetPortSettings with a location name.

- *

- * Learn more - *

- *

- * Setting up GameLift - * fleets - *

+ * @see {@link UpdateFleetPortSettingsCommand} */ - public updateFleetPortSettings( + updateFleetPortSettings( args: UpdateFleetPortSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFleetPortSettings( + updateFleetPortSettings( args: UpdateFleetPortSettingsCommandInput, cb: (err: any, data?: UpdateFleetPortSettingsCommandOutput) => void ): void; - public updateFleetPortSettings( + updateFleetPortSettings( args: UpdateFleetPortSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFleetPortSettingsCommandOutput) => void ): void; - public updateFleetPortSettings( - args: UpdateFleetPortSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFleetPortSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateFleetPortSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateFleetPortSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * This operation is used with the GameLift FleetIQ solution and game server groups. - *

- *

Updates information about a - * registered game server to help GameLift FleetIQ to track game server availability. This operation - * is called by a game server process that is running on an instance in a game server - * group.

- *

Use this operation to update the following types of game server information. You can - * make all three types of updates in the same request:

- *
    - *
  • - *

    To update the game server's utilization status, identify the game server and - * game server group and specify the current utilization status. Use this status to - * identify when game servers are currently hosting games and when they are - * available to be claimed.

    - *
  • - *
  • - *

    To report health status, identify the game server and game server group and - * set health check to HEALTHY. If a game server does not report - * health status for a certain length of time, the game server is no longer - * considered healthy. As a result, it will be eventually deregistered from the - * game server group to avoid affecting utilization metrics. The best practice is - * to report health every 60 seconds.

    - *
  • - *
  • - *

    To change game server metadata, provide updated game server data.

    - *
  • - *
- *

Once a game server is successfully updated, the relevant statuses and timestamps are - * updated.

- *

- * Learn more - *

- *

- * GameLift FleetIQ - * Guide - *

+ * @see {@link UpdateGameServerCommand} */ - public updateGameServer( + updateGameServer( args: UpdateGameServerCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGameServer( + updateGameServer( args: UpdateGameServerCommandInput, cb: (err: any, data?: UpdateGameServerCommandOutput) => void ): void; - public updateGameServer( + updateGameServer( args: UpdateGameServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGameServerCommandOutput) => void ): void; - public updateGameServer( - args: UpdateGameServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGameServerCommandOutput) => void), - cb?: (err: any, data?: UpdateGameServerCommandOutput) => void - ): Promise | void { - const command = new UpdateGameServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * This operation is used with the GameLift FleetIQ solution and game server groups. - *

- *

Updates GameLift FleetIQ-specific - * properties for a game server group. Many Auto Scaling group properties are updated on - * the Auto Scaling group directly, including the launch template, Auto Scaling policies, - * and maximum/minimum/desired instance counts.

- *

To update the game server group, specify the game server group ID and provide the - * updated values. Before applying the updates, the new values are validated to ensure that - * GameLift FleetIQ can continue to perform instance balancing activity. If successful, a - * GameServerGroup object is returned.

- *

- * Learn more - *

- *

- * GameLift FleetIQ - * Guide - *

+ * @see {@link UpdateGameServerGroupCommand} */ - public updateGameServerGroup( + updateGameServerGroup( args: UpdateGameServerGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGameServerGroup( + updateGameServerGroup( args: UpdateGameServerGroupCommandInput, cb: (err: any, data?: UpdateGameServerGroupCommandOutput) => void ): void; - public updateGameServerGroup( + updateGameServerGroup( args: UpdateGameServerGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGameServerGroupCommandOutput) => void ): void; - public updateGameServerGroup( - args: UpdateGameServerGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGameServerGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateGameServerGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateGameServerGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the mutable properties of a game session.

- *

To update a game session, specify the game session ID and the values you want to - * change.

- *

If successful, the updated GameSession object is returned.

- *

- * All APIs by task - *

+ * @see {@link UpdateGameSessionCommand} */ - public updateGameSession( + updateGameSession( args: UpdateGameSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGameSession( + updateGameSession( args: UpdateGameSessionCommandInput, cb: (err: any, data?: UpdateGameSessionCommandOutput) => void ): void; - public updateGameSession( + updateGameSession( args: UpdateGameSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGameSessionCommandOutput) => void ): void; - public updateGameSession( - args: UpdateGameSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGameSessionCommandOutput) => void), - cb?: (err: any, data?: UpdateGameSessionCommandOutput) => void - ): Promise | void { - const command = new UpdateGameSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the configuration of a game session queue, which determines how the queue - * processes new game session requests. To update settings, specify the queue name to be - * updated and provide the new settings. When updating destinations, provide a complete - * list of destinations.

- *

- * Learn more - *

- *

- * - * Using Multi-Region Queues - *

+ * @see {@link UpdateGameSessionQueueCommand} */ - public updateGameSessionQueue( + updateGameSessionQueue( args: UpdateGameSessionQueueCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGameSessionQueue( + updateGameSessionQueue( args: UpdateGameSessionQueueCommandInput, cb: (err: any, data?: UpdateGameSessionQueueCommandOutput) => void ): void; - public updateGameSessionQueue( + updateGameSessionQueue( args: UpdateGameSessionQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGameSessionQueueCommandOutput) => void ): void; - public updateGameSessionQueue( - args: UpdateGameSessionQueueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGameSessionQueueCommandOutput) => void), - cb?: (err: any, data?: UpdateGameSessionQueueCommandOutput) => void - ): Promise | void { - const command = new UpdateGameSessionQueueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates settings for a FlexMatch matchmaking configuration. These changes affect all - * matches and game sessions that are created after the update. To update settings, specify - * the configuration name to be updated and provide the new settings.

- *

- * Learn more - *

- *

- * Design a FlexMatch - * matchmaker - *

+ * @see {@link UpdateMatchmakingConfigurationCommand} */ - public updateMatchmakingConfiguration( + updateMatchmakingConfiguration( args: UpdateMatchmakingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMatchmakingConfiguration( + updateMatchmakingConfiguration( args: UpdateMatchmakingConfigurationCommandInput, cb: (err: any, data?: UpdateMatchmakingConfigurationCommandOutput) => void ): void; - public updateMatchmakingConfiguration( + updateMatchmakingConfiguration( args: UpdateMatchmakingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMatchmakingConfigurationCommandOutput) => void ): void; - public updateMatchmakingConfiguration( - args: UpdateMatchmakingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMatchmakingConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateMatchmakingConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateMatchmakingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the current runtime configuration for the specified fleet, which tells GameLift - * how to launch server processes on all instances in the fleet. You can update a fleet's - * runtime configuration at any time after the fleet is created; it does not need to be in - * ACTIVE status.

- *

To update runtime configuration, specify the fleet ID and provide a - * RuntimeConfiguration with an updated set of server process - * configurations.

- *

If successful, the fleet's runtime configuration settings are updated. Each instance - * in the fleet regularly checks for and retrieves updated runtime configurations. - * Instances immediately begin complying with the new configuration by launching new server - * processes or not replacing existing processes when they shut down. Updating a fleet's - * runtime configuration never affects existing server processes.

- *

- * Learn more - *

- *

- * Setting up GameLift - * fleets - *

+ * @see {@link UpdateRuntimeConfigurationCommand} */ - public updateRuntimeConfiguration( + updateRuntimeConfiguration( args: UpdateRuntimeConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRuntimeConfiguration( + updateRuntimeConfiguration( args: UpdateRuntimeConfigurationCommandInput, cb: (err: any, data?: UpdateRuntimeConfigurationCommandOutput) => void ): void; - public updateRuntimeConfiguration( + updateRuntimeConfiguration( args: UpdateRuntimeConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRuntimeConfigurationCommandOutput) => void ): void; - public updateRuntimeConfiguration( - args: UpdateRuntimeConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRuntimeConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateRuntimeConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateRuntimeConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates Realtime script metadata and content.

- *

To update script metadata, specify the script ID and provide updated name and/or - * version values.

- *

To update script content, provide an updated zip file by pointing to either a local - * file or an Amazon S3 bucket location. You can use either method regardless of how the - * original script was uploaded. Use the Version parameter to track - * updates to the script.

- *

If the call is successful, the updated metadata is stored in the script record and a - * revised script is uploaded to the Amazon GameLift service. Once the script is updated and - * acquired by a fleet instance, the new version is used for all new game sessions.

- *

- * Learn more - *

- *

- * Amazon GameLift Realtime Servers - *

- *

- * Related actions - *

- *

- * All APIs by task - *

+ * @see {@link UpdateScriptCommand} */ - public updateScript( - args: UpdateScriptCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateScript(args: UpdateScriptCommandInput, cb: (err: any, data?: UpdateScriptCommandOutput) => void): void; - public updateScript( + updateScript(args: UpdateScriptCommandInput, options?: __HttpHandlerOptions): Promise; + updateScript(args: UpdateScriptCommandInput, cb: (err: any, data?: UpdateScriptCommandOutput) => void): void; + updateScript( args: UpdateScriptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateScriptCommandOutput) => void ): void; - public updateScript( - args: UpdateScriptCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateScriptCommandOutput) => void), - cb?: (err: any, data?: UpdateScriptCommandOutput) => void - ): Promise | void { - const command = new UpdateScriptCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Validates the syntax of a matchmaking rule or rule set. This operation checks that the - * rule set is using syntactically correct JSON and that it conforms to allowed property - * expressions. To validate syntax, provide a rule set JSON string.

- *

- * Learn more - *

- * + * @see {@link ValidateMatchmakingRuleSetCommand} */ - public validateMatchmakingRuleSet( + validateMatchmakingRuleSet( args: ValidateMatchmakingRuleSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public validateMatchmakingRuleSet( + validateMatchmakingRuleSet( args: ValidateMatchmakingRuleSetCommandInput, cb: (err: any, data?: ValidateMatchmakingRuleSetCommandOutput) => void ): void; - public validateMatchmakingRuleSet( + validateMatchmakingRuleSet( args: ValidateMatchmakingRuleSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidateMatchmakingRuleSetCommandOutput) => void ): void; - public validateMatchmakingRuleSet( - args: ValidateMatchmakingRuleSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ValidateMatchmakingRuleSetCommandOutput) => void), - cb?: (err: any, data?: ValidateMatchmakingRuleSetCommandOutput) => void - ): Promise | void { - const command = new ValidateMatchmakingRuleSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon GameLift provides solutions for hosting session-based multiplayer game servers in the + * cloud, including tools for deploying, operating, and scaling game servers. Built on + * Amazon Web Services global computing infrastructure, GameLift helps you deliver high-performance, + * high-reliability, low-cost game servers while dynamically scaling your resource usage to + * meet player demand.

+ *

+ * About GameLift solutions + *

+ *

Get more information on these GameLift solutions in the GameLift Developer Guide.

+ *
    + *
  • + *

    GameLift managed hosting -- GameLift offers a fully managed service to set up + * and maintain computing machines for hosting, manage game session and player + * session life cycle, and handle security, storage, and performance tracking. You + * can use automatic scaling tools to balance player demand and hosting costs, + * configure your game session management to minimize player latency, and add + * FlexMatch for matchmaking.

    + *
  • + *
  • + *

    Managed hosting with Realtime Servers -- With GameLift Realtime Servers, you can quickly configure + * and set up ready-to-go game servers for your game. Realtime Servers provides a game server + * framework with core GameLift infrastructure already built in. Then use the full + * range of GameLift managed hosting features, including FlexMatch, for your + * game.

    + *
  • + *
  • + *

    GameLift FleetIQ -- Use GameLift FleetIQ as a standalone service while hosting your games using EC2 + * instances and Auto Scaling groups. GameLift FleetIQ provides optimizations for game + * hosting, including boosting the viability of low-cost Spot Instances gaming. For + * a complete solution, pair the GameLift FleetIQ and FlexMatch standalone services.

    + *
  • + *
  • + *

    GameLift FlexMatch -- Add matchmaking to your game hosting solution. FlexMatch is a + * customizable matchmaking service for multiplayer games. Use FlexMatch as + * integrated with GameLift managed hosting or incorporate FlexMatch as a standalone + * service into your own hosting solution.

    + *
  • + *
+ *

+ * About this API Reference + *

+ *

This reference guide describes the low-level service API for Amazon GameLift. With each topic + * in this guide, you can find links to language-specific SDK guides and the Amazon Web Services CLI + * reference. Useful links:

+ * + */ +export class GameLift extends GameLiftClient implements GameLift {} +createAggregatedClient(commands, GameLift); diff --git a/clients/client-gamesparks/src/GameSparks.ts b/clients/client-gamesparks/src/GameSparks.ts index b0b98bd1fdf5..3e6c6cbf628d 100644 --- a/clients/client-gamesparks/src/GameSparks.ts +++ b/clients/client-gamesparks/src/GameSparks.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { CreateGameCommand, CreateGameCommandInput, CreateGameCommandOutput } from "./commands/CreateGameCommand"; @@ -118,1058 +119,508 @@ import { UpdateSnapshotCommandOutput, } from "./commands/UpdateSnapshotCommand"; import { UpdateStageCommand, UpdateStageCommandInput, UpdateStageCommandOutput } from "./commands/UpdateStageCommand"; -import { GameSparksClient } from "./GameSparksClient"; +import { GameSparksClient, GameSparksClientConfig } from "./GameSparksClient"; -/** - * @public - *

- */ -export class GameSparks extends GameSparksClient { +const commands = { + CreateGameCommand, + CreateSnapshotCommand, + CreateStageCommand, + DeleteGameCommand, + DeleteStageCommand, + DisconnectPlayerCommand, + ExportSnapshotCommand, + GetExtensionCommand, + GetExtensionVersionCommand, + GetGameCommand, + GetGameConfigurationCommand, + GetGeneratedCodeJobCommand, + GetPlayerConnectionStatusCommand, + GetSnapshotCommand, + GetStageCommand, + GetStageDeploymentCommand, + ImportGameConfigurationCommand, + ListExtensionsCommand, + ListExtensionVersionsCommand, + ListGamesCommand, + ListGeneratedCodeJobsCommand, + ListSnapshotsCommand, + ListStageDeploymentsCommand, + ListStagesCommand, + ListTagsForResourceCommand, + StartGeneratedCodeJobCommand, + StartStageDeploymentCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateGameCommand, + UpdateGameConfigurationCommand, + UpdateSnapshotCommand, + UpdateStageCommand, +}; + +export interface GameSparks { /** - * @public - *

- * Creates a new game with an empty configuration. - * After creating your game, you can update the configuration using UpdateGameConfiguration or ImportGameConfiguration. - *

+ * @see {@link CreateGameCommand} */ - public createGame(args: CreateGameCommandInput, options?: __HttpHandlerOptions): Promise; - public createGame(args: CreateGameCommandInput, cb: (err: any, data?: CreateGameCommandOutput) => void): void; - public createGame( + createGame(args: CreateGameCommandInput, options?: __HttpHandlerOptions): Promise; + createGame(args: CreateGameCommandInput, cb: (err: any, data?: CreateGameCommandOutput) => void): void; + createGame( args: CreateGameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGameCommandOutput) => void ): void; - public createGame( - args: CreateGameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGameCommandOutput) => void), - cb?: (err: any, data?: CreateGameCommandOutput) => void - ): Promise | void { - const command = new CreateGameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a snapshot of the game configuration.

+ * @see {@link CreateSnapshotCommand} */ - public createSnapshot( + createSnapshot( args: CreateSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSnapshot( - args: CreateSnapshotCommandInput, - cb: (err: any, data?: CreateSnapshotCommandOutput) => void - ): void; - public createSnapshot( + createSnapshot(args: CreateSnapshotCommandInput, cb: (err: any, data?: CreateSnapshotCommandOutput) => void): void; + createSnapshot( args: CreateSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSnapshotCommandOutput) => void ): void; - public createSnapshot( - args: CreateSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSnapshotCommandOutput) => void), - cb?: (err: any, data?: CreateSnapshotCommandOutput) => void - ): Promise | void { - const command = new CreateSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new stage for stage-by-stage game development and deployment.

+ * @see {@link CreateStageCommand} */ - public createStage(args: CreateStageCommandInput, options?: __HttpHandlerOptions): Promise; - public createStage(args: CreateStageCommandInput, cb: (err: any, data?: CreateStageCommandOutput) => void): void; - public createStage( + createStage(args: CreateStageCommandInput, options?: __HttpHandlerOptions): Promise; + createStage(args: CreateStageCommandInput, cb: (err: any, data?: CreateStageCommandOutput) => void): void; + createStage( args: CreateStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStageCommandOutput) => void ): void; - public createStage( - args: CreateStageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStageCommandOutput) => void), - cb?: (err: any, data?: CreateStageCommandOutput) => void - ): Promise | void { - const command = new CreateStageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a game.

+ * @see {@link DeleteGameCommand} */ - public deleteGame(args: DeleteGameCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteGame(args: DeleteGameCommandInput, cb: (err: any, data?: DeleteGameCommandOutput) => void): void; - public deleteGame( + deleteGame(args: DeleteGameCommandInput, options?: __HttpHandlerOptions): Promise; + deleteGame(args: DeleteGameCommandInput, cb: (err: any, data?: DeleteGameCommandOutput) => void): void; + deleteGame( args: DeleteGameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGameCommandOutput) => void ): void; - public deleteGame( - args: DeleteGameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGameCommandOutput) => void), - cb?: (err: any, data?: DeleteGameCommandOutput) => void - ): Promise | void { - const command = new DeleteGameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a stage from a game, along with the associated game runtime.

+ * @see {@link DeleteStageCommand} */ - public deleteStage(args: DeleteStageCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteStage(args: DeleteStageCommandInput, cb: (err: any, data?: DeleteStageCommandOutput) => void): void; - public deleteStage( + deleteStage(args: DeleteStageCommandInput, options?: __HttpHandlerOptions): Promise; + deleteStage(args: DeleteStageCommandInput, cb: (err: any, data?: DeleteStageCommandOutput) => void): void; + deleteStage( args: DeleteStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStageCommandOutput) => void ): void; - public deleteStage( - args: DeleteStageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStageCommandOutput) => void), - cb?: (err: any, data?: DeleteStageCommandOutput) => void - ): Promise | void { - const command = new DeleteStageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disconnects a player from the game runtime.

- *

- * If a player has multiple connections, this operation attempts to close all of them. - *

+ * @see {@link DisconnectPlayerCommand} */ - public disconnectPlayer( + disconnectPlayer( args: DisconnectPlayerCommandInput, options?: __HttpHandlerOptions ): Promise; - public disconnectPlayer( + disconnectPlayer( args: DisconnectPlayerCommandInput, cb: (err: any, data?: DisconnectPlayerCommandOutput) => void ): void; - public disconnectPlayer( + disconnectPlayer( args: DisconnectPlayerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisconnectPlayerCommandOutput) => void ): void; - public disconnectPlayer( - args: DisconnectPlayerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisconnectPlayerCommandOutput) => void), - cb?: (err: any, data?: DisconnectPlayerCommandOutput) => void - ): Promise | void { - const command = new DisconnectPlayerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Exports a game configuration snapshot.

+ * @see {@link ExportSnapshotCommand} */ - public exportSnapshot( + exportSnapshot( args: ExportSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public exportSnapshot( - args: ExportSnapshotCommandInput, - cb: (err: any, data?: ExportSnapshotCommandOutput) => void - ): void; - public exportSnapshot( + exportSnapshot(args: ExportSnapshotCommandInput, cb: (err: any, data?: ExportSnapshotCommandOutput) => void): void; + exportSnapshot( args: ExportSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportSnapshotCommandOutput) => void ): void; - public exportSnapshot( - args: ExportSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportSnapshotCommandOutput) => void), - cb?: (err: any, data?: ExportSnapshotCommandOutput) => void - ): Promise | void { - const command = new ExportSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets details about a specified extension.

+ * @see {@link GetExtensionCommand} */ - public getExtension( - args: GetExtensionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getExtension(args: GetExtensionCommandInput, cb: (err: any, data?: GetExtensionCommandOutput) => void): void; - public getExtension( + getExtension(args: GetExtensionCommandInput, options?: __HttpHandlerOptions): Promise; + getExtension(args: GetExtensionCommandInput, cb: (err: any, data?: GetExtensionCommandOutput) => void): void; + getExtension( args: GetExtensionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExtensionCommandOutput) => void ): void; - public getExtension( - args: GetExtensionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetExtensionCommandOutput) => void), - cb?: (err: any, data?: GetExtensionCommandOutput) => void - ): Promise | void { - const command = new GetExtensionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets details about a specified extension version.

+ * @see {@link GetExtensionVersionCommand} */ - public getExtensionVersion( + getExtensionVersion( args: GetExtensionVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getExtensionVersion( + getExtensionVersion( args: GetExtensionVersionCommandInput, cb: (err: any, data?: GetExtensionVersionCommandOutput) => void ): void; - public getExtensionVersion( + getExtensionVersion( args: GetExtensionVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExtensionVersionCommandOutput) => void ): void; - public getExtensionVersion( - args: GetExtensionVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetExtensionVersionCommandOutput) => void), - cb?: (err: any, data?: GetExtensionVersionCommandOutput) => void - ): Promise | void { - const command = new GetExtensionVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets details about a game.

+ * @see {@link GetGameCommand} */ - public getGame(args: GetGameCommandInput, options?: __HttpHandlerOptions): Promise; - public getGame(args: GetGameCommandInput, cb: (err: any, data?: GetGameCommandOutput) => void): void; - public getGame( + getGame(args: GetGameCommandInput, options?: __HttpHandlerOptions): Promise; + getGame(args: GetGameCommandInput, cb: (err: any, data?: GetGameCommandOutput) => void): void; + getGame( args: GetGameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGameCommandOutput) => void ): void; - public getGame( - args: GetGameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGameCommandOutput) => void), - cb?: (err: any, data?: GetGameCommandOutput) => void - ): Promise | void { - const command = new GetGameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the configuration of the game.

+ * @see {@link GetGameConfigurationCommand} */ - public getGameConfiguration( + getGameConfiguration( args: GetGameConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getGameConfiguration( + getGameConfiguration( args: GetGameConfigurationCommandInput, cb: (err: any, data?: GetGameConfigurationCommandOutput) => void ): void; - public getGameConfiguration( + getGameConfiguration( args: GetGameConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGameConfigurationCommandOutput) => void ): void; - public getGameConfiguration( - args: GetGameConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGameConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetGameConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetGameConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets details about a job that is generating code for a snapshot.

+ * @see {@link GetGeneratedCodeJobCommand} */ - public getGeneratedCodeJob( + getGeneratedCodeJob( args: GetGeneratedCodeJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public getGeneratedCodeJob( + getGeneratedCodeJob( args: GetGeneratedCodeJobCommandInput, cb: (err: any, data?: GetGeneratedCodeJobCommandOutput) => void ): void; - public getGeneratedCodeJob( + getGeneratedCodeJob( args: GetGeneratedCodeJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGeneratedCodeJobCommandOutput) => void ): void; - public getGeneratedCodeJob( - args: GetGeneratedCodeJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGeneratedCodeJobCommandOutput) => void), - cb?: (err: any, data?: GetGeneratedCodeJobCommandOutput) => void - ): Promise | void { - const command = new GetGeneratedCodeJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the status of a player's connection to the game runtime.

- *

- * It's possible for a single player to have multiple connections to the game runtime. - * If a player is not connected, this operation returns an empty list. - *

+ * @see {@link GetPlayerConnectionStatusCommand} */ - public getPlayerConnectionStatus( + getPlayerConnectionStatus( args: GetPlayerConnectionStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPlayerConnectionStatus( + getPlayerConnectionStatus( args: GetPlayerConnectionStatusCommandInput, cb: (err: any, data?: GetPlayerConnectionStatusCommandOutput) => void ): void; - public getPlayerConnectionStatus( + getPlayerConnectionStatus( args: GetPlayerConnectionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPlayerConnectionStatusCommandOutput) => void ): void; - public getPlayerConnectionStatus( - args: GetPlayerConnectionStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPlayerConnectionStatusCommandOutput) => void), - cb?: (err: any, data?: GetPlayerConnectionStatusCommandOutput) => void - ): Promise | void { - const command = new GetPlayerConnectionStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a copy of the game configuration in a snapshot.

+ * @see {@link GetSnapshotCommand} */ - public getSnapshot(args: GetSnapshotCommandInput, options?: __HttpHandlerOptions): Promise; - public getSnapshot(args: GetSnapshotCommandInput, cb: (err: any, data?: GetSnapshotCommandOutput) => void): void; - public getSnapshot( + getSnapshot(args: GetSnapshotCommandInput, options?: __HttpHandlerOptions): Promise; + getSnapshot(args: GetSnapshotCommandInput, cb: (err: any, data?: GetSnapshotCommandOutput) => void): void; + getSnapshot( args: GetSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSnapshotCommandOutput) => void ): void; - public getSnapshot( - args: GetSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSnapshotCommandOutput) => void), - cb?: (err: any, data?: GetSnapshotCommandOutput) => void - ): Promise | void { - const command = new GetSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a stage.

+ * @see {@link GetStageCommand} */ - public getStage(args: GetStageCommandInput, options?: __HttpHandlerOptions): Promise; - public getStage(args: GetStageCommandInput, cb: (err: any, data?: GetStageCommandOutput) => void): void; - public getStage( + getStage(args: GetStageCommandInput, options?: __HttpHandlerOptions): Promise; + getStage(args: GetStageCommandInput, cb: (err: any, data?: GetStageCommandOutput) => void): void; + getStage( args: GetStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStageCommandOutput) => void ): void; - public getStage( - args: GetStageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStageCommandOutput) => void), - cb?: (err: any, data?: GetStageCommandOutput) => void - ): Promise | void { - const command = new GetStageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a stage deployment.

+ * @see {@link GetStageDeploymentCommand} */ - public getStageDeployment( + getStageDeployment( args: GetStageDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getStageDeployment( + getStageDeployment( args: GetStageDeploymentCommandInput, cb: (err: any, data?: GetStageDeploymentCommandOutput) => void ): void; - public getStageDeployment( + getStageDeployment( args: GetStageDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStageDeploymentCommandOutput) => void ): void; - public getStageDeployment( - args: GetStageDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStageDeploymentCommandOutput) => void), - cb?: (err: any, data?: GetStageDeploymentCommandOutput) => void - ): Promise | void { - const command = new GetStageDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Imports a game configuration.

- *

- * This operation replaces the current configuration of the game with the provided input. - * This is not a reversible operation. If you want to preserve the previous configuration, - * use CreateSnapshot to make a new snapshot before importing. - *

+ * @see {@link ImportGameConfigurationCommand} */ - public importGameConfiguration( + importGameConfiguration( args: ImportGameConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public importGameConfiguration( + importGameConfiguration( args: ImportGameConfigurationCommandInput, cb: (err: any, data?: ImportGameConfigurationCommandOutput) => void ): void; - public importGameConfiguration( + importGameConfiguration( args: ImportGameConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportGameConfigurationCommandOutput) => void ): void; - public importGameConfiguration( - args: ImportGameConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportGameConfigurationCommandOutput) => void), - cb?: (err: any, data?: ImportGameConfigurationCommandOutput) => void - ): Promise | void { - const command = new ImportGameConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a paginated list of available extensions.

- *

- * Extensions provide features that games can use from scripts. - *

+ * @see {@link ListExtensionsCommand} */ - public listExtensions( + listExtensions( args: ListExtensionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listExtensions( - args: ListExtensionsCommandInput, - cb: (err: any, data?: ListExtensionsCommandOutput) => void - ): void; - public listExtensions( + listExtensions(args: ListExtensionsCommandInput, cb: (err: any, data?: ListExtensionsCommandOutput) => void): void; + listExtensions( args: ListExtensionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExtensionsCommandOutput) => void ): void; - public listExtensions( - args: ListExtensionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListExtensionsCommandOutput) => void), - cb?: (err: any, data?: ListExtensionsCommandOutput) => void - ): Promise | void { - const command = new ListExtensionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a paginated list of available versions for the extension.

- *

- * Each time an API change is made to an extension, the version is incremented. - * The list retrieved by this operation shows the versions that are currently available. - *

+ * @see {@link ListExtensionVersionsCommand} */ - public listExtensionVersions( + listExtensionVersions( args: ListExtensionVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listExtensionVersions( + listExtensionVersions( args: ListExtensionVersionsCommandInput, cb: (err: any, data?: ListExtensionVersionsCommandOutput) => void ): void; - public listExtensionVersions( + listExtensionVersions( args: ListExtensionVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExtensionVersionsCommandOutput) => void ): void; - public listExtensionVersions( - args: ListExtensionVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListExtensionVersionsCommandOutput) => void), - cb?: (err: any, data?: ListExtensionVersionsCommandOutput) => void - ): Promise | void { - const command = new ListExtensionVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a paginated list of games.

+ * @see {@link ListGamesCommand} */ - public listGames(args: ListGamesCommandInput, options?: __HttpHandlerOptions): Promise; - public listGames(args: ListGamesCommandInput, cb: (err: any, data?: ListGamesCommandOutput) => void): void; - public listGames( + listGames(args: ListGamesCommandInput, options?: __HttpHandlerOptions): Promise; + listGames(args: ListGamesCommandInput, cb: (err: any, data?: ListGamesCommandOutput) => void): void; + listGames( args: ListGamesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGamesCommandOutput) => void ): void; - public listGames( - args: ListGamesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGamesCommandOutput) => void), - cb?: (err: any, data?: ListGamesCommandOutput) => void - ): Promise | void { - const command = new ListGamesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a paginated list of code generation jobs for a snapshot.

+ * @see {@link ListGeneratedCodeJobsCommand} */ - public listGeneratedCodeJobs( + listGeneratedCodeJobs( args: ListGeneratedCodeJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGeneratedCodeJobs( + listGeneratedCodeJobs( args: ListGeneratedCodeJobsCommandInput, cb: (err: any, data?: ListGeneratedCodeJobsCommandOutput) => void ): void; - public listGeneratedCodeJobs( + listGeneratedCodeJobs( args: ListGeneratedCodeJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGeneratedCodeJobsCommandOutput) => void ): void; - public listGeneratedCodeJobs( - args: ListGeneratedCodeJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGeneratedCodeJobsCommandOutput) => void), - cb?: (err: any, data?: ListGeneratedCodeJobsCommandOutput) => void - ): Promise | void { - const command = new ListGeneratedCodeJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a paginated list of snapshot summaries from the game.

+ * @see {@link ListSnapshotsCommand} */ - public listSnapshots( - args: ListSnapshotsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listSnapshots( - args: ListSnapshotsCommandInput, - cb: (err: any, data?: ListSnapshotsCommandOutput) => void - ): void; - public listSnapshots( + listSnapshots(args: ListSnapshotsCommandInput, options?: __HttpHandlerOptions): Promise; + listSnapshots(args: ListSnapshotsCommandInput, cb: (err: any, data?: ListSnapshotsCommandOutput) => void): void; + listSnapshots( args: ListSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSnapshotsCommandOutput) => void ): void; - public listSnapshots( - args: ListSnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSnapshotsCommandOutput) => void), - cb?: (err: any, data?: ListSnapshotsCommandOutput) => void - ): Promise | void { - const command = new ListSnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a paginated list of stage deployment summaries from the game.

+ * @see {@link ListStageDeploymentsCommand} */ - public listStageDeployments( + listStageDeployments( args: ListStageDeploymentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStageDeployments( + listStageDeployments( args: ListStageDeploymentsCommandInput, cb: (err: any, data?: ListStageDeploymentsCommandOutput) => void ): void; - public listStageDeployments( + listStageDeployments( args: ListStageDeploymentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStageDeploymentsCommandOutput) => void ): void; - public listStageDeployments( - args: ListStageDeploymentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStageDeploymentsCommandOutput) => void), - cb?: (err: any, data?: ListStageDeploymentsCommandOutput) => void - ): Promise | void { - const command = new ListStageDeploymentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a paginated list of stage summaries from the game.

+ * @see {@link ListStagesCommand} */ - public listStages(args: ListStagesCommandInput, options?: __HttpHandlerOptions): Promise; - public listStages(args: ListStagesCommandInput, cb: (err: any, data?: ListStagesCommandOutput) => void): void; - public listStages( + listStages(args: ListStagesCommandInput, options?: __HttpHandlerOptions): Promise; + listStages(args: ListStagesCommandInput, cb: (err: any, data?: ListStagesCommandOutput) => void): void; + listStages( args: ListStagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStagesCommandOutput) => void ): void; - public listStages( - args: ListStagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStagesCommandOutput) => void), - cb?: (err: any, data?: ListStagesCommandOutput) => void - ): Promise | void { - const command = new ListStagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags associated with a GameSparks resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Starts an asynchronous process that generates client code for system-defined and custom messages. - * The resulting code is collected as a .zip file and uploaded to a pre-signed Amazon S3 URL. - *

+ * @see {@link StartGeneratedCodeJobCommand} */ - public startGeneratedCodeJob( + startGeneratedCodeJob( args: StartGeneratedCodeJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startGeneratedCodeJob( + startGeneratedCodeJob( args: StartGeneratedCodeJobCommandInput, cb: (err: any, data?: StartGeneratedCodeJobCommandOutput) => void ): void; - public startGeneratedCodeJob( + startGeneratedCodeJob( args: StartGeneratedCodeJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartGeneratedCodeJobCommandOutput) => void ): void; - public startGeneratedCodeJob( - args: StartGeneratedCodeJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartGeneratedCodeJobCommandOutput) => void), - cb?: (err: any, data?: StartGeneratedCodeJobCommandOutput) => void - ): Promise | void { - const command = new StartGeneratedCodeJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deploys a snapshot to the stage and creates a new game runtime.

- *

- * After you call this operation, you can check the deployment status by using GetStageDeployment. - *

- *

- * If there are any players connected to the previous game runtime, then both runtimes persist. - * Existing connections to the previous runtime are maintained. - * When players disconnect and reconnect, they connect to the new runtime. - * After there are no connections to the previous game runtime, it is deleted. - *

+ * @see {@link StartStageDeploymentCommand} */ - public startStageDeployment( + startStageDeployment( args: StartStageDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public startStageDeployment( + startStageDeployment( args: StartStageDeploymentCommandInput, cb: (err: any, data?: StartStageDeploymentCommandOutput) => void ): void; - public startStageDeployment( + startStageDeployment( args: StartStageDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartStageDeploymentCommandOutput) => void ): void; - public startStageDeployment( - args: StartStageDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartStageDeploymentCommandOutput) => void), - cb?: (err: any, data?: StartStageDeploymentCommandOutput) => void - ): Promise | void { - const command = new StartStageDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds tags to a GameSparks resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from a GameSparks resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates details of the game.

+ * @see {@link UpdateGameCommand} */ - public updateGame(args: UpdateGameCommandInput, options?: __HttpHandlerOptions): Promise; - public updateGame(args: UpdateGameCommandInput, cb: (err: any, data?: UpdateGameCommandOutput) => void): void; - public updateGame( + updateGame(args: UpdateGameCommandInput, options?: __HttpHandlerOptions): Promise; + updateGame(args: UpdateGameCommandInput, cb: (err: any, data?: UpdateGameCommandOutput) => void): void; + updateGame( args: UpdateGameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGameCommandOutput) => void ): void; - public updateGame( - args: UpdateGameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGameCommandOutput) => void), - cb?: (err: any, data?: UpdateGameCommandOutput) => void - ): Promise | void { - const command = new UpdateGameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates one or more sections of the game configuration.

+ * @see {@link UpdateGameConfigurationCommand} */ - public updateGameConfiguration( + updateGameConfiguration( args: UpdateGameConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGameConfiguration( + updateGameConfiguration( args: UpdateGameConfigurationCommandInput, cb: (err: any, data?: UpdateGameConfigurationCommandOutput) => void ): void; - public updateGameConfiguration( + updateGameConfiguration( args: UpdateGameConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGameConfigurationCommandOutput) => void ): void; - public updateGameConfiguration( - args: UpdateGameConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGameConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateGameConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateGameConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the metadata of a GameSparks snapshot.

+ * @see {@link UpdateSnapshotCommand} */ - public updateSnapshot( + updateSnapshot( args: UpdateSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSnapshot( - args: UpdateSnapshotCommandInput, - cb: (err: any, data?: UpdateSnapshotCommandOutput) => void - ): void; - public updateSnapshot( + updateSnapshot(args: UpdateSnapshotCommandInput, cb: (err: any, data?: UpdateSnapshotCommandOutput) => void): void; + updateSnapshot( args: UpdateSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSnapshotCommandOutput) => void ): void; - public updateSnapshot( - args: UpdateSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSnapshotCommandOutput) => void), - cb?: (err: any, data?: UpdateSnapshotCommandOutput) => void - ): Promise | void { - const command = new UpdateSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the metadata of a stage.

+ * @see {@link UpdateStageCommand} */ - public updateStage(args: UpdateStageCommandInput, options?: __HttpHandlerOptions): Promise; - public updateStage(args: UpdateStageCommandInput, cb: (err: any, data?: UpdateStageCommandOutput) => void): void; - public updateStage( + updateStage(args: UpdateStageCommandInput, options?: __HttpHandlerOptions): Promise; + updateStage(args: UpdateStageCommandInput, cb: (err: any, data?: UpdateStageCommandOutput) => void): void; + updateStage( args: UpdateStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStageCommandOutput) => void ): void; - public updateStage( - args: UpdateStageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStageCommandOutput) => void), - cb?: (err: any, data?: UpdateStageCommandOutput) => void - ): Promise | void { - const command = new UpdateStageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

+ */ +export class GameSparks extends GameSparksClient implements GameSparks {} +createAggregatedClient(commands, GameSparks); diff --git a/clients/client-glacier/src/Glacier.ts b/clients/client-glacier/src/Glacier.ts index 205743faffff..2ec4f863e1a5 100644 --- a/clients/client-glacier/src/Glacier.ts +++ b/clients/client-glacier/src/Glacier.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -138,1688 +139,569 @@ import { UploadMultipartPartCommandInput, UploadMultipartPartCommandOutput, } from "./commands/UploadMultipartPartCommand"; -import { GlacierClient } from "./GlacierClient"; +import { GlacierClient, GlacierClientConfig } from "./GlacierClient"; -/** - * @public - *

Amazon S3 Glacier (Glacier) is a storage solution for "cold data."

- * - *

Glacier is an extremely low-cost storage service that provides secure, - * durable, and easy-to-use storage for data backup and archival. With Glacier, - * customers can store their data cost effectively for months, years, or decades. - * Glacier also enables customers to offload the administrative burdens of operating and - * scaling storage to AWS, so they don't have to worry about capacity planning, hardware - * provisioning, data replication, hardware failure and recovery, or time-consuming hardware - * migrations.

- * - *

Glacier is a great storage choice when low storage cost is paramount and your - * data is rarely retrieved. If your - * application requires fast or frequent access to your data, consider using Amazon S3. For - * more information, see Amazon Simple Storage Service - * (Amazon S3).

- * - *

You can store any kind of data in any format. There is no maximum limit on the total - * amount of data you can store in Glacier.

- * - *

If you are a first-time user of Glacier, we recommend that you begin by - * reading the following sections in the Amazon S3 Glacier Developer - * Guide:

- *
    - *
  • - *

    - * What is - * Amazon S3 Glacier - This section of the Developer Guide describes the - * underlying data model, the operations it supports, and the AWS SDKs that you can use - * to interact with the service.

    - *
  • - *
  • - *

    - * Getting Started - * with Amazon S3 Glacier - The Getting Started section walks you through the - * process of creating a vault, uploading archives, creating jobs to download archives, - * retrieving the job output, and deleting archives.

    - *
  • - *
- */ -export class Glacier extends GlacierClient { +const commands = { + AbortMultipartUploadCommand, + AbortVaultLockCommand, + AddTagsToVaultCommand, + CompleteMultipartUploadCommand, + CompleteVaultLockCommand, + CreateVaultCommand, + DeleteArchiveCommand, + DeleteVaultCommand, + DeleteVaultAccessPolicyCommand, + DeleteVaultNotificationsCommand, + DescribeJobCommand, + DescribeVaultCommand, + GetDataRetrievalPolicyCommand, + GetJobOutputCommand, + GetVaultAccessPolicyCommand, + GetVaultLockCommand, + GetVaultNotificationsCommand, + InitiateJobCommand, + InitiateMultipartUploadCommand, + InitiateVaultLockCommand, + ListJobsCommand, + ListMultipartUploadsCommand, + ListPartsCommand, + ListProvisionedCapacityCommand, + ListTagsForVaultCommand, + ListVaultsCommand, + PurchaseProvisionedCapacityCommand, + RemoveTagsFromVaultCommand, + SetDataRetrievalPolicyCommand, + SetVaultAccessPolicyCommand, + SetVaultNotificationsCommand, + UploadArchiveCommand, + UploadMultipartPartCommand, +}; + +export interface Glacier { /** - * @public - *

This operation aborts a multipart upload identified by the upload ID.

- * - * - *

After the Abort Multipart Upload request succeeds, you cannot upload any more parts - * to the multipart upload or complete the multipart upload. Aborting a completed upload - * fails. However, aborting an already-aborted upload will succeed, for a short time. For more - * information about uploading a part and completing a multipart upload, see UploadMultipartPart and CompleteMultipartUpload.

- * - *

This operation is idempotent.

- * - *

An AWS account has full permission to perform all operations (actions). However, AWS - * Identity and Access Management (IAM) users don't have any permissions by default. You must - * grant them explicit permission to perform specific actions. For more information, see - * Access Control Using - * AWS Identity and Access Management (IAM).

- *

For conceptual information and underlying REST API, see Working with Archives in - * Amazon S3 Glacier and Abort Multipart - * Upload in the Amazon Glacier Developer Guide.

+ * @see {@link AbortMultipartUploadCommand} */ - public abortMultipartUpload( + abortMultipartUpload( args: AbortMultipartUploadCommandInput, options?: __HttpHandlerOptions ): Promise; - public abortMultipartUpload( + abortMultipartUpload( args: AbortMultipartUploadCommandInput, cb: (err: any, data?: AbortMultipartUploadCommandOutput) => void ): void; - public abortMultipartUpload( + abortMultipartUpload( args: AbortMultipartUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AbortMultipartUploadCommandOutput) => void ): void; - public abortMultipartUpload( - args: AbortMultipartUploadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AbortMultipartUploadCommandOutput) => void), - cb?: (err: any, data?: AbortMultipartUploadCommandOutput) => void - ): Promise | void { - const command = new AbortMultipartUploadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation aborts the vault locking process if the vault lock is not in the - * Locked state. If the vault lock is in the Locked state when - * this operation is requested, the operation returns an AccessDeniedException - * error. Aborting the vault locking process removes the vault lock policy from the specified - * vault.

- *

A vault lock is put into the InProgress state by calling InitiateVaultLock. A vault lock is put into the Locked state by - * calling CompleteVaultLock. You can get the state of a vault lock by - * calling GetVaultLock. For more information about the vault locking - * process, see Amazon Glacier Vault Lock. For more information about vault lock policies, see - * Amazon - * Glacier Access Control with Vault Lock Policies.

- *

This operation is idempotent. You can successfully invoke this operation multiple - * times, if the vault lock is in the InProgress state or if there is no policy - * associated with the vault.

+ * @see {@link AbortVaultLockCommand} */ - public abortVaultLock( + abortVaultLock( args: AbortVaultLockCommandInput, options?: __HttpHandlerOptions ): Promise; - public abortVaultLock( - args: AbortVaultLockCommandInput, - cb: (err: any, data?: AbortVaultLockCommandOutput) => void - ): void; - public abortVaultLock( + abortVaultLock(args: AbortVaultLockCommandInput, cb: (err: any, data?: AbortVaultLockCommandOutput) => void): void; + abortVaultLock( args: AbortVaultLockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AbortVaultLockCommandOutput) => void ): void; - public abortVaultLock( - args: AbortVaultLockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AbortVaultLockCommandOutput) => void), - cb?: (err: any, data?: AbortVaultLockCommandOutput) => void - ): Promise | void { - const command = new AbortVaultLockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation adds the specified tags to a vault. Each tag is composed of a key and - * a value. Each vault can have up to 10 tags. If your request would cause the tag limit for - * the vault to be exceeded, the operation throws the LimitExceededException - * error. If a tag already exists on the vault under a specified key, the existing key value - * will be overwritten. For more information about tags, see Tagging Amazon S3 Glacier Resources. - *

+ * @see {@link AddTagsToVaultCommand} */ - public addTagsToVault( + addTagsToVault( args: AddTagsToVaultCommandInput, options?: __HttpHandlerOptions ): Promise; - public addTagsToVault( - args: AddTagsToVaultCommandInput, - cb: (err: any, data?: AddTagsToVaultCommandOutput) => void - ): void; - public addTagsToVault( + addTagsToVault(args: AddTagsToVaultCommandInput, cb: (err: any, data?: AddTagsToVaultCommandOutput) => void): void; + addTagsToVault( args: AddTagsToVaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsToVaultCommandOutput) => void ): void; - public addTagsToVault( - args: AddTagsToVaultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddTagsToVaultCommandOutput) => void), - cb?: (err: any, data?: AddTagsToVaultCommandOutput) => void - ): Promise | void { - const command = new AddTagsToVaultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

You call this operation to inform Amazon S3 Glacier (Glacier) that all the archive parts have been - * uploaded and that Glacier can now assemble the archive from the uploaded parts. - * After assembling and saving the archive to the vault, Glacier returns the URI path - * of the newly created archive resource. Using the URI path, you can then access the archive. - * After you upload an archive, you should save the archive ID returned to retrieve the - * archive at a later point. You can also get the vault inventory to obtain a list of archive - * IDs in a vault. For more information, see InitiateJob.

- * - *

In the request, you must include the computed SHA256 tree hash of the entire archive - * you have uploaded. For information about computing a SHA256 tree hash, see Computing - * Checksums. On the server side, Glacier also constructs the SHA256 tree - * hash of the assembled archive. If the values match, Glacier saves the archive to the - * vault; otherwise, it returns an error, and the operation fails. The ListParts operation returns a list of parts uploaded for a specific - * multipart upload. It includes checksum information for each uploaded part that can be used - * to debug a bad checksum issue.

- * - *

Additionally, Glacier also checks for any missing content ranges when - * assembling the archive, if missing content ranges are found, Glacier returns an - * error and the operation fails.

- * - *

Complete Multipart Upload is an idempotent operation. After your first successful - * complete multipart upload, if you call the operation again within a short period, the - * operation will succeed and return the same archive ID. This is useful in the event you - * experience a network issue that causes an aborted connection or receive a 500 server error, - * in which case you can repeat your Complete Multipart Upload request and get the same - * archive ID without creating duplicate archives. Note, however, that after the multipart - * upload completes, you cannot call the List Parts operation and the multipart upload will - * not appear in List Multipart Uploads response, even if idempotent complete is - * possible.

- * - *

An AWS account has full permission to perform all operations (actions). However, AWS - * Identity and Access Management (IAM) users don't have any permissions by default. You must - * grant them explicit permission to perform specific actions. For more information, see - * Access Control Using - * AWS Identity and Access Management (IAM).

- *

For conceptual information and underlying REST API, see Uploading Large Archives in - * Parts (Multipart Upload) and Complete Multipart - * Upload in the Amazon Glacier Developer Guide.

+ * @see {@link CompleteMultipartUploadCommand} */ - public completeMultipartUpload( + completeMultipartUpload( args: CompleteMultipartUploadCommandInput, options?: __HttpHandlerOptions ): Promise; - public completeMultipartUpload( + completeMultipartUpload( args: CompleteMultipartUploadCommandInput, cb: (err: any, data?: CompleteMultipartUploadCommandOutput) => void ): void; - public completeMultipartUpload( + completeMultipartUpload( args: CompleteMultipartUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteMultipartUploadCommandOutput) => void ): void; - public completeMultipartUpload( - args: CompleteMultipartUploadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CompleteMultipartUploadCommandOutput) => void), - cb?: (err: any, data?: CompleteMultipartUploadCommandOutput) => void - ): Promise | void { - const command = new CompleteMultipartUploadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation completes the vault locking process by transitioning the vault lock - * from the InProgress state to the Locked state, which causes the - * vault lock policy to become unchangeable. A vault lock is put into the - * InProgress state by calling InitiateVaultLock. You can - * obtain the state of the vault lock by calling GetVaultLock. For more - * information about the vault locking process, Amazon Glacier Vault Lock.

- *

This operation is idempotent. This request is always successful if the vault lock is - * in the Locked state and the provided lock ID matches the lock ID originally - * used to lock the vault.

- *

If an invalid lock ID is passed in the request when the vault lock is in the - * Locked state, the operation returns an AccessDeniedException - * error. If an invalid lock ID is passed in the request when the vault lock is in the - * InProgress state, the operation throws an InvalidParameter - * error.

+ * @see {@link CompleteVaultLockCommand} */ - public completeVaultLock( + completeVaultLock( args: CompleteVaultLockCommandInput, options?: __HttpHandlerOptions ): Promise; - public completeVaultLock( + completeVaultLock( args: CompleteVaultLockCommandInput, cb: (err: any, data?: CompleteVaultLockCommandOutput) => void ): void; - public completeVaultLock( + completeVaultLock( args: CompleteVaultLockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteVaultLockCommandOutput) => void ): void; - public completeVaultLock( - args: CompleteVaultLockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CompleteVaultLockCommandOutput) => void), - cb?: (err: any, data?: CompleteVaultLockCommandOutput) => void - ): Promise | void { - const command = new CompleteVaultLockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation creates a new vault with the specified name. The name of the vault - * must be unique within a region for an AWS account. You can create up to 1,000 vaults per - * account. If you need to create more vaults, contact Amazon S3 Glacier.

- *

You must use the following guidelines when naming a vault.

- *
    - *
  • - *

    Names can be between 1 and 255 characters long.

    - *
  • - *
  • - *

    Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' - * (period).

    - *
  • - *
- * - *

This operation is idempotent.

- * - *

An AWS account has full permission to perform all operations (actions). However, AWS - * Identity and Access Management (IAM) users don't have any permissions by default. You must - * grant them explicit permission to perform specific actions. For more information, see - * Access Control Using - * AWS Identity and Access Management (IAM).

- *

For conceptual information and underlying REST API, see Creating a Vault in Amazon - * Glacier and Create Vault in the - * Amazon Glacier Developer Guide.

+ * @see {@link CreateVaultCommand} */ - public createVault(args: CreateVaultCommandInput, options?: __HttpHandlerOptions): Promise; - public createVault(args: CreateVaultCommandInput, cb: (err: any, data?: CreateVaultCommandOutput) => void): void; - public createVault( + createVault(args: CreateVaultCommandInput, options?: __HttpHandlerOptions): Promise; + createVault(args: CreateVaultCommandInput, cb: (err: any, data?: CreateVaultCommandOutput) => void): void; + createVault( args: CreateVaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVaultCommandOutput) => void ): void; - public createVault( - args: CreateVaultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVaultCommandOutput) => void), - cb?: (err: any, data?: CreateVaultCommandOutput) => void - ): Promise | void { - const command = new CreateVaultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation deletes an archive from a vault. Subsequent requests to initiate a - * retrieval of this archive will fail. Archive retrievals that are in progress for this - * archive ID may or may not succeed according to the following scenarios:

- *
    - *
  • - *

    If the archive retrieval job is actively preparing the data for download when - * Amazon S3 Glacier receives the delete archive request, the archival retrieval operation - * might fail.

    - *
  • - *
  • - *

    If the archive retrieval job has successfully prepared the archive for download - * when Amazon S3 Glacier receives the delete archive request, you will be able to download - * the output.

    - *
  • - *
- * - *

This operation is idempotent. Attempting to delete an already-deleted archive does - * not result in an error.

- * - *

An AWS account has full permission to perform all operations (actions). However, AWS - * Identity and Access Management (IAM) users don't have any permissions by default. You must - * grant them explicit permission to perform specific actions. For more information, see - * Access Control Using - * AWS Identity and Access Management (IAM).

- *

For conceptual information and underlying REST API, see Deleting an Archive in Amazon - * Glacier and Delete Archive in the - * Amazon Glacier Developer Guide.

+ * @see {@link DeleteArchiveCommand} */ - public deleteArchive( - args: DeleteArchiveCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteArchive( - args: DeleteArchiveCommandInput, - cb: (err: any, data?: DeleteArchiveCommandOutput) => void - ): void; - public deleteArchive( + deleteArchive(args: DeleteArchiveCommandInput, options?: __HttpHandlerOptions): Promise; + deleteArchive(args: DeleteArchiveCommandInput, cb: (err: any, data?: DeleteArchiveCommandOutput) => void): void; + deleteArchive( args: DeleteArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteArchiveCommandOutput) => void ): void; - public deleteArchive( - args: DeleteArchiveCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteArchiveCommandOutput) => void), - cb?: (err: any, data?: DeleteArchiveCommandOutput) => void - ): Promise | void { - const command = new DeleteArchiveCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation deletes a vault. Amazon S3 Glacier will delete a vault only if there are - * no archives in the vault as of the last inventory and there have been no writes to the - * vault since the last inventory. If either of these conditions is not satisfied, the vault - * deletion fails (that is, the vault is not removed) and Amazon S3 Glacier returns an error. You - * can use DescribeVault to return the number of archives in a vault, and - * you can use Initiate a Job (POST - * jobs) to initiate a new inventory retrieval for a vault. The inventory contains - * the archive IDs you use to delete archives using Delete Archive (DELETE - * archive).

- * - *

This operation is idempotent.

- * - *

An AWS account has full permission to perform all operations (actions). However, AWS - * Identity and Access Management (IAM) users don't have any permissions by default. You must - * grant them explicit permission to perform specific actions. For more information, see - * Access Control Using - * AWS Identity and Access Management (IAM).

- *

For conceptual information and underlying REST API, see Deleting a Vault in Amazon - * Glacier and Delete Vault in the - * Amazon S3 Glacier Developer Guide.

+ * @see {@link DeleteVaultCommand} */ - public deleteVault(args: DeleteVaultCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteVault(args: DeleteVaultCommandInput, cb: (err: any, data?: DeleteVaultCommandOutput) => void): void; - public deleteVault( + deleteVault(args: DeleteVaultCommandInput, options?: __HttpHandlerOptions): Promise; + deleteVault(args: DeleteVaultCommandInput, cb: (err: any, data?: DeleteVaultCommandOutput) => void): void; + deleteVault( args: DeleteVaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVaultCommandOutput) => void ): void; - public deleteVault( - args: DeleteVaultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVaultCommandOutput) => void), - cb?: (err: any, data?: DeleteVaultCommandOutput) => void - ): Promise | void { - const command = new DeleteVaultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation deletes the access policy associated with the specified vault. The - * operation is eventually consistent; that is, it might take some time for Amazon S3 Glacier to - * completely remove the access policy, and you might still see the effect of the policy for a - * short time after you send the delete request.

- *

This operation is idempotent. You can invoke delete multiple times, even if there is - * no policy associated with the vault. For more information about vault access policies, see - * Amazon Glacier Access Control with Vault Access Policies.

+ * @see {@link DeleteVaultAccessPolicyCommand} */ - public deleteVaultAccessPolicy( + deleteVaultAccessPolicy( args: DeleteVaultAccessPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVaultAccessPolicy( + deleteVaultAccessPolicy( args: DeleteVaultAccessPolicyCommandInput, cb: (err: any, data?: DeleteVaultAccessPolicyCommandOutput) => void ): void; - public deleteVaultAccessPolicy( + deleteVaultAccessPolicy( args: DeleteVaultAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVaultAccessPolicyCommandOutput) => void ): void; - public deleteVaultAccessPolicy( - args: DeleteVaultAccessPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVaultAccessPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteVaultAccessPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteVaultAccessPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation deletes the notification configuration set for a vault. The operation - * is eventually consistent; that is, it might take some time for Amazon S3 Glacier to completely - * disable the notifications and you might still receive some notifications for a short time - * after you send the delete request.

- * - *

An AWS account has full permission to perform all operations (actions). However, AWS - * Identity and Access Management (IAM) users don't have any permissions by default. You must - * grant them explicit permission to perform specific actions. For more information, see - * Access - * Control Using AWS Identity and Access Management (IAM).

- *

For conceptual information and underlying REST API, see Configuring Vault - * Notifications in Amazon S3 Glacier and Delete Vault - * Notification Configuration in the Amazon S3 Glacier Developer Guide.

+ * @see {@link DeleteVaultNotificationsCommand} */ - public deleteVaultNotifications( + deleteVaultNotifications( args: DeleteVaultNotificationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVaultNotifications( + deleteVaultNotifications( args: DeleteVaultNotificationsCommandInput, cb: (err: any, data?: DeleteVaultNotificationsCommandOutput) => void ): void; - public deleteVaultNotifications( + deleteVaultNotifications( args: DeleteVaultNotificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVaultNotificationsCommandOutput) => void ): void; - public deleteVaultNotifications( - args: DeleteVaultNotificationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVaultNotificationsCommandOutput) => void), - cb?: (err: any, data?: DeleteVaultNotificationsCommandOutput) => void - ): Promise | void { - const command = new DeleteVaultNotificationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation returns information about a job you previously initiated, including - * the job initiation date, the user who initiated the job, the job status code/message and - * the Amazon SNS topic to notify after Amazon S3 Glacier (Glacier) completes the job. For more information - * about initiating a job, see InitiateJob.

- * - * - *

This operation enables you to check the status of your job. However, it is - * strongly recommended that you set up an Amazon SNS topic and specify it in your initiate - * job request so that Glacier can notify the topic after it completes the - * job.

- *
- * - *

A job ID will not expire for at least 24 hours after Glacier completes the - * job.

- * - *

An AWS account has full permission to perform all operations (actions). However, AWS - * Identity and Access Management (IAM) users don't have any permissions by default. You must - * grant them explicit permission to perform specific actions. For more information, see - * Access Control Using - * AWS Identity and Access Management (IAM).

- * - *

For more information about using this operation, - * see the documentation for the underlying REST API Describe Job - * in the Amazon Glacier Developer Guide.

+ * @see {@link DescribeJobCommand} */ - public describeJob(args: DescribeJobCommandInput, options?: __HttpHandlerOptions): Promise; - public describeJob(args: DescribeJobCommandInput, cb: (err: any, data?: DescribeJobCommandOutput) => void): void; - public describeJob( + describeJob(args: DescribeJobCommandInput, options?: __HttpHandlerOptions): Promise; + describeJob(args: DescribeJobCommandInput, cb: (err: any, data?: DescribeJobCommandOutput) => void): void; + describeJob( args: DescribeJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobCommandOutput) => void ): void; - public describeJob( - args: DescribeJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeJobCommandOutput) => void), - cb?: (err: any, data?: DescribeJobCommandOutput) => void - ): Promise | void { - const command = new DescribeJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation returns information about a vault, including the vault's Amazon - * Resource Name (ARN), the date the vault was created, the number of archives it contains, - * and the total size of all the archives in the vault. The number of archives and their total - * size are as of the last inventory generation. This means that if you add or remove an - * archive from a vault, and then immediately use Describe Vault, the change in contents will - * not be immediately reflected. If you want to retrieve the latest inventory of the vault, - * use InitiateJob. Amazon S3 Glacier generates vault inventories approximately - * daily. For more information, see Downloading a Vault Inventory in - * Amazon S3 Glacier.

- * - *

An AWS account has full permission to perform all operations (actions). However, AWS - * Identity and Access Management (IAM) users don't have any permissions by default. You must - * grant them explicit permission to perform specific actions. For more information, see - * Access Control Using - * AWS Identity and Access Management (IAM).

- *

For conceptual information and underlying REST API, see Retrieving Vault Metadata in - * Amazon S3 Glacier and Describe Vault in the - * Amazon Glacier Developer Guide.

+ * @see {@link DescribeVaultCommand} */ - public describeVault( - args: DescribeVaultCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeVault( - args: DescribeVaultCommandInput, - cb: (err: any, data?: DescribeVaultCommandOutput) => void - ): void; - public describeVault( + describeVault(args: DescribeVaultCommandInput, options?: __HttpHandlerOptions): Promise; + describeVault(args: DescribeVaultCommandInput, cb: (err: any, data?: DescribeVaultCommandOutput) => void): void; + describeVault( args: DescribeVaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVaultCommandOutput) => void ): void; - public describeVault( - args: DescribeVaultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVaultCommandOutput) => void), - cb?: (err: any, data?: DescribeVaultCommandOutput) => void - ): Promise | void { - const command = new DescribeVaultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation returns the current data retrieval policy for the account and region - * specified in the GET request. For more information about data retrieval policies, see - * Amazon Glacier Data Retrieval Policies.

+ * @see {@link GetDataRetrievalPolicyCommand} */ - public getDataRetrievalPolicy( + getDataRetrievalPolicy( args: GetDataRetrievalPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDataRetrievalPolicy( + getDataRetrievalPolicy( args: GetDataRetrievalPolicyCommandInput, cb: (err: any, data?: GetDataRetrievalPolicyCommandOutput) => void ): void; - public getDataRetrievalPolicy( + getDataRetrievalPolicy( args: GetDataRetrievalPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataRetrievalPolicyCommandOutput) => void ): void; - public getDataRetrievalPolicy( - args: GetDataRetrievalPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDataRetrievalPolicyCommandOutput) => void), - cb?: (err: any, data?: GetDataRetrievalPolicyCommandOutput) => void - ): Promise | void { - const command = new GetDataRetrievalPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation downloads the output of the job you initiated using InitiateJob. Depending on the job type you specified when you initiated the - * job, the output will be either the content of an archive or a vault inventory.

- * - *

You can download all the job output or download a portion of the output by specifying - * a byte range. In the case of an archive retrieval job, depending on the byte range you - * specify, Amazon S3 Glacier (Glacier) returns the checksum for the portion of the data. You can compute the - * checksum on the client and verify that the values match to ensure the portion you downloaded - * is the correct data.

- *

A job ID will not expire for at least 24 hours after Glacier completes the job. That - * a byte range. For both archive and inventory retrieval jobs, you should verify the downloaded - * size against the size returned in the headers from the - * Get Job Output response.

- *

For archive retrieval jobs, you should also verify that the size is what you expected. If - * you download a portion of the output, the expected size is based on the range of bytes - * you specified. For example, if you specify a range of bytes=0-1048575, you should - * verify your download size is 1,048,576 bytes. If you download an entire archive, the - * expected size is the size of the archive when you uploaded it to Amazon S3 Glacier - * The expected size is also returned in the headers from the - * Get Job Output response.

- *

In the case of an archive retrieval job, depending on the byte range you - * specify, Glacier returns the checksum for the portion of the data. To ensure the portion you downloaded - * is the correct data, compute the checksum on the client, verify that the values match, - * and verify that the size is what you expected.

- * - *

A job ID does not expire for at least 24 hours after Glacier completes the - * job. That is, you can download the job output within the 24 hours period after Amazon - * Glacier completes the job.

- * - *

An AWS account has full permission to perform all operations (actions). However, AWS - * Identity and Access Management (IAM) users don't have any permissions by default. You must - * grant them explicit permission to perform specific actions. For more information, see - * Access Control Using - * AWS Identity and Access Management (IAM).

- *

For conceptual information and the underlying REST API, see Downloading a - * Vault Inventory, Downloading an - * Archive, and Get Job Output - *

+ * @see {@link GetJobOutputCommand} */ - public getJobOutput( - args: GetJobOutputCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getJobOutput(args: GetJobOutputCommandInput, cb: (err: any, data?: GetJobOutputCommandOutput) => void): void; - public getJobOutput( + getJobOutput(args: GetJobOutputCommandInput, options?: __HttpHandlerOptions): Promise; + getJobOutput(args: GetJobOutputCommandInput, cb: (err: any, data?: GetJobOutputCommandOutput) => void): void; + getJobOutput( args: GetJobOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobOutputCommandOutput) => void ): void; - public getJobOutput( - args: GetJobOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetJobOutputCommandOutput) => void), - cb?: (err: any, data?: GetJobOutputCommandOutput) => void - ): Promise | void { - const command = new GetJobOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation retrieves the access-policy subresource set on the vault; - * for more information on setting this subresource, see Set Vault Access Policy - * (PUT access-policy). If there is no access policy set on the vault, the - * operation returns a 404 Not found error. For more information about vault - * access policies, see Amazon Glacier Access Control - * with Vault Access Policies.

+ * @see {@link GetVaultAccessPolicyCommand} */ - public getVaultAccessPolicy( + getVaultAccessPolicy( args: GetVaultAccessPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVaultAccessPolicy( + getVaultAccessPolicy( args: GetVaultAccessPolicyCommandInput, cb: (err: any, data?: GetVaultAccessPolicyCommandOutput) => void ): void; - public getVaultAccessPolicy( + getVaultAccessPolicy( args: GetVaultAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVaultAccessPolicyCommandOutput) => void ): void; - public getVaultAccessPolicy( - args: GetVaultAccessPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVaultAccessPolicyCommandOutput) => void), - cb?: (err: any, data?: GetVaultAccessPolicyCommandOutput) => void - ): Promise | void { - const command = new GetVaultAccessPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation retrieves the following attributes from the lock-policy - * subresource set on the specified vault:

- *
    - *
  • - *

    The vault lock policy set on the vault.

    - *
  • - *
  • - *

    The state of the vault lock, which is either InProgess or - * Locked.

    - *
  • - *
  • - *

    When the lock ID expires. The lock ID is used to complete the vault locking - * process.

    - *
  • - *
  • - *

    When the vault lock was initiated and put into the InProgress - * state.

    - *
  • - *
- * - *

A vault lock is put into the InProgress state by calling InitiateVaultLock. A vault lock is put into the Locked state by - * calling CompleteVaultLock. You can abort the vault locking process by - * calling AbortVaultLock. For more information about the vault locking - * process, Amazon - * Glacier Vault Lock.

- *

If there is no vault lock policy set on the vault, the operation returns a 404 - * Not found error. For more information about vault lock policies, Amazon - * Glacier Access Control with Vault Lock Policies.

+ * @see {@link GetVaultLockCommand} */ - public getVaultLock( - args: GetVaultLockCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getVaultLock(args: GetVaultLockCommandInput, cb: (err: any, data?: GetVaultLockCommandOutput) => void): void; - public getVaultLock( + getVaultLock(args: GetVaultLockCommandInput, options?: __HttpHandlerOptions): Promise; + getVaultLock(args: GetVaultLockCommandInput, cb: (err: any, data?: GetVaultLockCommandOutput) => void): void; + getVaultLock( args: GetVaultLockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVaultLockCommandOutput) => void ): void; - public getVaultLock( - args: GetVaultLockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVaultLockCommandOutput) => void), - cb?: (err: any, data?: GetVaultLockCommandOutput) => void - ): Promise | void { - const command = new GetVaultLockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation retrieves the notification-configuration subresource of - * the specified vault.

- * - *

For information about setting a notification configuration on a vault, see SetVaultNotifications. If a notification configuration for a vault is not - * set, the operation returns a 404 Not Found error. For more information about - * vault notifications, see Configuring Vault - * Notifications in Amazon S3 Glacier.

- * - *

An AWS account has full permission to perform all operations (actions). However, AWS - * Identity and Access Management (IAM) users don't have any permissions by default. You must - * grant them explicit permission to perform specific actions. For more information, see - * Access Control Using - * AWS Identity and Access Management (IAM).

- *

For conceptual information and underlying REST API, see Configuring Vault - * Notifications in Amazon S3 Glacier and Get Vault Notification - * Configuration in the Amazon Glacier Developer Guide.

+ * @see {@link GetVaultNotificationsCommand} */ - public getVaultNotifications( + getVaultNotifications( args: GetVaultNotificationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVaultNotifications( + getVaultNotifications( args: GetVaultNotificationsCommandInput, cb: (err: any, data?: GetVaultNotificationsCommandOutput) => void ): void; - public getVaultNotifications( + getVaultNotifications( args: GetVaultNotificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVaultNotificationsCommandOutput) => void ): void; - public getVaultNotifications( - args: GetVaultNotificationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVaultNotificationsCommandOutput) => void), - cb?: (err: any, data?: GetVaultNotificationsCommandOutput) => void - ): Promise | void { - const command = new GetVaultNotificationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation initiates a job of the specified type, which can be a select, an archival retrieval, - * or a vault retrieval. For more information about using this operation, - * see the documentation for the underlying REST API Initiate - * a Job. - *

+ * @see {@link InitiateJobCommand} */ - public initiateJob(args: InitiateJobCommandInput, options?: __HttpHandlerOptions): Promise; - public initiateJob(args: InitiateJobCommandInput, cb: (err: any, data?: InitiateJobCommandOutput) => void): void; - public initiateJob( + initiateJob(args: InitiateJobCommandInput, options?: __HttpHandlerOptions): Promise; + initiateJob(args: InitiateJobCommandInput, cb: (err: any, data?: InitiateJobCommandOutput) => void): void; + initiateJob( args: InitiateJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InitiateJobCommandOutput) => void ): void; - public initiateJob( - args: InitiateJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InitiateJobCommandOutput) => void), - cb?: (err: any, data?: InitiateJobCommandOutput) => void - ): Promise | void { - const command = new InitiateJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation initiates a multipart upload. Amazon S3 Glacier creates a multipart - * upload resource and returns its ID in the response. The multipart upload ID is used in - * subsequent requests to upload parts of an archive (see UploadMultipartPart).

- * - *

When you initiate a multipart upload, you specify the part size in number of bytes. - * The part size must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576 - * (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable - * part size is 1 MB, and the maximum is 4 GB.

- * - *

Every part you upload to this resource (see UploadMultipartPart), - * except the last one, must have the same size. The last one can be the same size or smaller. - * For example, suppose you want to upload a 16.2 MB file. If you initiate the multipart - * upload with a part size of 4 MB, you will upload four parts of 4 MB each and one part of - * 0.2 MB.

- * - * - *

You don't need to know the size of the archive when you start a multipart upload - * because Amazon S3 Glacier does not require you to specify the overall archive - * size.

- *
- * - *

After you complete the multipart upload, Amazon S3 Glacier (Glacier) removes the multipart upload - * resource referenced by the ID. Glacier also removes the multipart upload resource if - * you cancel the multipart upload or it may be removed if there is no activity for a period - * of 24 hours.

- * - *

An AWS account has full permission to perform all operations (actions). However, AWS - * Identity and Access Management (IAM) users don't have any permissions by default. You must - * grant them explicit permission to perform specific actions. For more information, see - * Access Control Using - * AWS Identity and Access Management (IAM).

- *

For conceptual information and underlying REST API, see Uploading Large Archives in - * Parts (Multipart Upload) and Initiate Multipart - * Upload in the Amazon Glacier Developer Guide.

+ * @see {@link InitiateMultipartUploadCommand} */ - public initiateMultipartUpload( + initiateMultipartUpload( args: InitiateMultipartUploadCommandInput, options?: __HttpHandlerOptions ): Promise; - public initiateMultipartUpload( + initiateMultipartUpload( args: InitiateMultipartUploadCommandInput, cb: (err: any, data?: InitiateMultipartUploadCommandOutput) => void ): void; - public initiateMultipartUpload( + initiateMultipartUpload( args: InitiateMultipartUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InitiateMultipartUploadCommandOutput) => void ): void; - public initiateMultipartUpload( - args: InitiateMultipartUploadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InitiateMultipartUploadCommandOutput) => void), - cb?: (err: any, data?: InitiateMultipartUploadCommandOutput) => void - ): Promise | void { - const command = new InitiateMultipartUploadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation initiates the vault locking process by doing the following:

- *
    - *
  • - *

    Installing a vault lock policy on the specified vault.

    - *
  • - *
  • - *

    Setting the lock state of vault lock to InProgress.

    - *
  • - *
  • - *

    Returning a lock ID, which is used to complete the vault locking - * process.

    - *
  • - *
- * - *

You can set one vault lock policy for each vault and this policy can be up to 20 KB - * in size. For more information about vault lock policies, see Amazon Glacier Access Control with - * Vault Lock Policies.

- *

You must complete the vault locking process within 24 hours after the vault lock - * enters the InProgress state. After the 24 hour window ends, the lock ID - * expires, the vault automatically exits the InProgress state, and the vault - * lock policy is removed from the vault. You call CompleteVaultLock to - * complete the vault locking process by setting the state of the vault lock to - * Locked.

- *

After a vault lock is in the Locked state, you cannot initiate a new - * vault lock for the vault.

- * - *

You can abort the vault locking process by calling AbortVaultLock. - * You can get the state of the vault lock by calling GetVaultLock. For more - * information about the vault locking process, Amazon Glacier Vault - * Lock.

- * - *

If this operation is called when the vault lock is in the InProgress - * state, the operation returns an AccessDeniedException error. When the vault - * lock is in the InProgress state you must call AbortVaultLock - * before you can initiate a new vault lock policy.

+ * @see {@link InitiateVaultLockCommand} */ - public initiateVaultLock( + initiateVaultLock( args: InitiateVaultLockCommandInput, options?: __HttpHandlerOptions ): Promise; - public initiateVaultLock( + initiateVaultLock( args: InitiateVaultLockCommandInput, cb: (err: any, data?: InitiateVaultLockCommandOutput) => void ): void; - public initiateVaultLock( + initiateVaultLock( args: InitiateVaultLockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InitiateVaultLockCommandOutput) => void ): void; - public initiateVaultLock( - args: InitiateVaultLockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InitiateVaultLockCommandOutput) => void), - cb?: (err: any, data?: InitiateVaultLockCommandOutput) => void - ): Promise | void { - const command = new InitiateVaultLockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation lists jobs for a vault, including jobs that are in-progress and jobs - * that have recently finished. The List Job operation returns a list of these jobs sorted by job initiation - * time.

- * - * - *

Amazon Glacier retains recently completed jobs for a period before deleting them; - * however, it eventually removes completed jobs. The output of completed jobs can be - * retrieved. Retaining completed jobs for a period of time after they have completed - * enables you to get a job output in the event you miss the job completion notification or - * your first attempt to download it fails. For example, suppose you start an archive - * retrieval job to download an archive. After the job completes, you start to download the - * archive but encounter a network error. In this scenario, you can retry and download the - * archive while the job exists.

- *
- * - *

The List Jobs operation supports pagination. You should always check the response Marker field. - * If there are no more jobs to list, the Marker field is set to null. If there are more jobs to list, - * the Marker field is set to a non-null value, which you can use to continue the pagination of the list. - * To return a list of jobs that begins at a specific job, - * set the marker request parameter to the Marker value for that job that you obtained from a previous List Jobs request.

- * - *

You can set a maximum limit for the number of jobs returned in the response by - * specifying the limit parameter in the request. The default limit is 50. The - * number of jobs returned might be fewer than the limit, but the number of returned jobs - * never exceeds the limit.

- * - *

Additionally, you can filter the jobs list returned by specifying the optional - * statuscode parameter or completed parameter, or both. Using - * the statuscode parameter, you can specify to return only jobs that match - * either the InProgress, Succeeded, or Failed status. - * Using the completed parameter, you can specify to return only jobs that were - * completed (true) or jobs that were not completed - * (false).

- * - *

For more information about using this operation, - * see the documentation for the underlying REST API List Jobs.

+ * @see {@link ListJobsCommand} */ - public listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise; - public listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void; - public listJobs( + listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise; + listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void; + listJobs( args: ListJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobsCommandOutput) => void ): void; - public listJobs( - args: ListJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJobsCommandOutput) => void), - cb?: (err: any, data?: ListJobsCommandOutput) => void - ): Promise | void { - const command = new ListJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation lists in-progress multipart uploads for the specified vault. An - * in-progress multipart upload is a multipart upload that has been initiated by an InitiateMultipartUpload request, but has not yet been completed or aborted. - * The list returned in the List Multipart Upload response has no guaranteed order.

- * - *

The List Multipart Uploads operation supports pagination. By default, this operation - * returns up to 50 multipart uploads in the response. You should always check the response - * for a marker at which to continue the list; if there are no more items the - * marker is null. To return a list of multipart uploads that - * begins at a specific upload, set the marker request parameter to the value you - * obtained from a previous List Multipart Upload request. You can also limit the number of - * uploads returned in the response by specifying the limit parameter in the - * request.

- * - *

Note the difference between this operation and listing parts (ListParts). The List Multipart Uploads operation lists all multipart uploads - * for a vault and does not require a multipart upload ID. The List Parts operation requires a - * multipart upload ID since parts are associated with a single upload.

- * - *

An AWS account has full permission to perform all operations (actions). However, AWS - * Identity and Access Management (IAM) users don't have any permissions by default. You must - * grant them explicit permission to perform specific actions. For more information, see - * Access Control Using - * AWS Identity and Access Management (IAM).

- * - *

For conceptual information and the underlying REST API, see Working - * with Archives in Amazon S3 Glacier and List Multipart Uploads - * in the Amazon Glacier Developer Guide.

+ * @see {@link ListMultipartUploadsCommand} */ - public listMultipartUploads( + listMultipartUploads( args: ListMultipartUploadsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMultipartUploads( + listMultipartUploads( args: ListMultipartUploadsCommandInput, cb: (err: any, data?: ListMultipartUploadsCommandOutput) => void ): void; - public listMultipartUploads( + listMultipartUploads( args: ListMultipartUploadsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMultipartUploadsCommandOutput) => void ): void; - public listMultipartUploads( - args: ListMultipartUploadsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMultipartUploadsCommandOutput) => void), - cb?: (err: any, data?: ListMultipartUploadsCommandOutput) => void - ): Promise | void { - const command = new ListMultipartUploadsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation lists the parts of an archive that have been uploaded in a specific - * multipart upload. You can make this request at any time during an in-progress multipart - * upload before you complete the upload (see CompleteMultipartUpload. List - * Parts returns an error for completed uploads. The list returned in the List Parts response - * is sorted by part range.

- * - *

The List Parts operation supports pagination. By default, this operation returns up - * to 50 uploaded parts in the response. You should always check the response for a - * marker at which to continue the list; if there are no more items the - * marker is null. To return a list of parts that begins at a - * specific part, set the marker request parameter to the value you obtained from - * a previous List Parts request. You can also limit the number of parts returned in the - * response by specifying the limit parameter in the request.

- * - *

An AWS account has full permission to perform all operations (actions). However, AWS - * Identity and Access Management (IAM) users don't have any permissions by default. You must - * grant them explicit permission to perform specific actions. For more information, see - * Access Control Using - * AWS Identity and Access Management (IAM).

- *

For conceptual information and the underlying REST API, see Working - * with Archives in Amazon S3 Glacier and List Parts in the - * Amazon Glacier Developer Guide.

+ * @see {@link ListPartsCommand} */ - public listParts(args: ListPartsCommandInput, options?: __HttpHandlerOptions): Promise; - public listParts(args: ListPartsCommandInput, cb: (err: any, data?: ListPartsCommandOutput) => void): void; - public listParts( + listParts(args: ListPartsCommandInput, options?: __HttpHandlerOptions): Promise; + listParts(args: ListPartsCommandInput, cb: (err: any, data?: ListPartsCommandOutput) => void): void; + listParts( args: ListPartsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPartsCommandOutput) => void ): void; - public listParts( - args: ListPartsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPartsCommandOutput) => void), - cb?: (err: any, data?: ListPartsCommandOutput) => void - ): Promise | void { - const command = new ListPartsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation lists the provisioned capacity units for the specified AWS - * account.

+ * @see {@link ListProvisionedCapacityCommand} */ - public listProvisionedCapacity( + listProvisionedCapacity( args: ListProvisionedCapacityCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProvisionedCapacity( + listProvisionedCapacity( args: ListProvisionedCapacityCommandInput, cb: (err: any, data?: ListProvisionedCapacityCommandOutput) => void ): void; - public listProvisionedCapacity( + listProvisionedCapacity( args: ListProvisionedCapacityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProvisionedCapacityCommandOutput) => void ): void; - public listProvisionedCapacity( - args: ListProvisionedCapacityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProvisionedCapacityCommandOutput) => void), - cb?: (err: any, data?: ListProvisionedCapacityCommandOutput) => void - ): Promise | void { - const command = new ListProvisionedCapacityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation lists all the tags attached to a vault. The operation returns an empty - * map if there are no tags. For more information about tags, see Tagging Amazon S3 Glacier - * Resources.

+ * @see {@link ListTagsForVaultCommand} */ - public listTagsForVault( + listTagsForVault( args: ListTagsForVaultCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForVault( + listTagsForVault( args: ListTagsForVaultCommandInput, cb: (err: any, data?: ListTagsForVaultCommandOutput) => void ): void; - public listTagsForVault( + listTagsForVault( args: ListTagsForVaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForVaultCommandOutput) => void ): void; - public listTagsForVault( - args: ListTagsForVaultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForVaultCommandOutput) => void), - cb?: (err: any, data?: ListTagsForVaultCommandOutput) => void - ): Promise | void { - const command = new ListTagsForVaultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation lists all vaults owned by the calling user's account. The list - * returned in the response is ASCII-sorted by vault name.

- * - *

By default, this operation returns up to 10 items. If there are more vaults to - * list, the response marker field contains the vault Amazon Resource Name (ARN) - * at which to continue the list with a new List Vaults request; otherwise, the - * marker field is null. To return a list of vaults that begins - * at a specific vault, set the marker request parameter to the vault ARN you - * obtained from a previous List Vaults request. You can also limit the number of vaults - * returned in the response by specifying the limit parameter in the request.

- * - *

An AWS account has full permission to perform all operations (actions). However, AWS - * Identity and Access Management (IAM) users don't have any permissions by default. You must - * grant them explicit permission to perform specific actions. For more information, see - * Access Control Using - * AWS Identity and Access Management (IAM).

- *

For conceptual information and underlying REST API, see Retrieving Vault Metadata in - * Amazon S3 Glacier and List Vaults in the - * Amazon Glacier Developer Guide.

+ * @see {@link ListVaultsCommand} */ - public listVaults(args: ListVaultsCommandInput, options?: __HttpHandlerOptions): Promise; - public listVaults(args: ListVaultsCommandInput, cb: (err: any, data?: ListVaultsCommandOutput) => void): void; - public listVaults( + listVaults(args: ListVaultsCommandInput, options?: __HttpHandlerOptions): Promise; + listVaults(args: ListVaultsCommandInput, cb: (err: any, data?: ListVaultsCommandOutput) => void): void; + listVaults( args: ListVaultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVaultsCommandOutput) => void ): void; - public listVaults( - args: ListVaultsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVaultsCommandOutput) => void), - cb?: (err: any, data?: ListVaultsCommandOutput) => void - ): Promise | void { - const command = new ListVaultsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation purchases a provisioned capacity unit for an AWS account.

+ * @see {@link PurchaseProvisionedCapacityCommand} */ - public purchaseProvisionedCapacity( + purchaseProvisionedCapacity( args: PurchaseProvisionedCapacityCommandInput, options?: __HttpHandlerOptions ): Promise; - public purchaseProvisionedCapacity( + purchaseProvisionedCapacity( args: PurchaseProvisionedCapacityCommandInput, cb: (err: any, data?: PurchaseProvisionedCapacityCommandOutput) => void ): void; - public purchaseProvisionedCapacity( + purchaseProvisionedCapacity( args: PurchaseProvisionedCapacityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PurchaseProvisionedCapacityCommandOutput) => void ): void; - public purchaseProvisionedCapacity( - args: PurchaseProvisionedCapacityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PurchaseProvisionedCapacityCommandOutput) => void), - cb?: (err: any, data?: PurchaseProvisionedCapacityCommandOutput) => void - ): Promise | void { - const command = new PurchaseProvisionedCapacityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation removes one or more tags from the set of tags attached to a vault. For - * more information about tags, see Tagging Amazon S3 Glacier Resources. - * This operation is idempotent. The operation will be successful, even if there are no tags - * attached to the vault.

+ * @see {@link RemoveTagsFromVaultCommand} */ - public removeTagsFromVault( + removeTagsFromVault( args: RemoveTagsFromVaultCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeTagsFromVault( + removeTagsFromVault( args: RemoveTagsFromVaultCommandInput, cb: (err: any, data?: RemoveTagsFromVaultCommandOutput) => void ): void; - public removeTagsFromVault( + removeTagsFromVault( args: RemoveTagsFromVaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsFromVaultCommandOutput) => void ): void; - public removeTagsFromVault( - args: RemoveTagsFromVaultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveTagsFromVaultCommandOutput) => void), - cb?: (err: any, data?: RemoveTagsFromVaultCommandOutput) => void - ): Promise | void { - const command = new RemoveTagsFromVaultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation sets and then enacts a data retrieval policy in the region specified - * in the PUT request. You can set one policy per region for an AWS account. The policy is - * enacted within a few minutes of a successful PUT operation.

- *

The set policy operation does not affect retrieval jobs that were in progress before - * the policy was enacted. For more information about data retrieval policies, see Amazon - * Glacier Data Retrieval Policies.

+ * @see {@link SetDataRetrievalPolicyCommand} */ - public setDataRetrievalPolicy( + setDataRetrievalPolicy( args: SetDataRetrievalPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public setDataRetrievalPolicy( + setDataRetrievalPolicy( args: SetDataRetrievalPolicyCommandInput, cb: (err: any, data?: SetDataRetrievalPolicyCommandOutput) => void ): void; - public setDataRetrievalPolicy( + setDataRetrievalPolicy( args: SetDataRetrievalPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetDataRetrievalPolicyCommandOutput) => void ): void; - public setDataRetrievalPolicy( - args: SetDataRetrievalPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetDataRetrievalPolicyCommandOutput) => void), - cb?: (err: any, data?: SetDataRetrievalPolicyCommandOutput) => void - ): Promise | void { - const command = new SetDataRetrievalPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation configures an access policy for a vault and will overwrite an existing - * policy. To configure a vault access policy, send a PUT request to the - * access-policy subresource of the vault. An access policy is specific to a - * vault and is also called a vault subresource. You can set one access policy per vault and - * the policy can be up to 20 KB in size. For more information about vault access policies, - * see Amazon Glacier Access Control with Vault Access Policies.

+ * @see {@link SetVaultAccessPolicyCommand} */ - public setVaultAccessPolicy( + setVaultAccessPolicy( args: SetVaultAccessPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public setVaultAccessPolicy( + setVaultAccessPolicy( args: SetVaultAccessPolicyCommandInput, cb: (err: any, data?: SetVaultAccessPolicyCommandOutput) => void ): void; - public setVaultAccessPolicy( + setVaultAccessPolicy( args: SetVaultAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetVaultAccessPolicyCommandOutput) => void ): void; - public setVaultAccessPolicy( - args: SetVaultAccessPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetVaultAccessPolicyCommandOutput) => void), - cb?: (err: any, data?: SetVaultAccessPolicyCommandOutput) => void - ): Promise | void { - const command = new SetVaultAccessPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation configures notifications that will be sent when specific events happen - * to a vault. By default, you don't get any notifications.

- * - *

To configure vault notifications, send a PUT request to the - * notification-configuration subresource of the vault. The request should - * include a JSON document that provides an Amazon SNS topic and specific events for which you - * want Amazon S3 Glacier to send notifications to the topic.

- * - *

Amazon SNS topics must grant permission to the vault to be allowed to publish - * notifications to the topic. You can configure a vault to publish a notification for the - * following vault events:

- * - *
    - *
  • - *

    - * ArchiveRetrievalCompleted This event occurs when a - * job that was initiated for an archive retrieval is completed (InitiateJob). The status of the completed job can be "Succeeded" or - * "Failed". The notification sent to the SNS topic is the same output as returned from - * DescribeJob.

    - *
  • - *
  • - * - *

    - * InventoryRetrievalCompleted This event occurs when a - * job that was initiated for an inventory retrieval is completed (InitiateJob). The status of the completed job can be "Succeeded" or - * "Failed". The notification sent to the SNS topic is the same output as returned from - * DescribeJob.

    - *
  • - *
- * - *

An AWS account has full permission to perform all operations (actions). However, AWS - * Identity and Access Management (IAM) users don't have any permissions by default. You must - * grant them explicit permission to perform specific actions. For more information, see - * Access Control Using - * AWS Identity and Access Management (IAM).

- *

For conceptual information and underlying REST API, see Configuring Vault - * Notifications in Amazon S3 Glacier and Set Vault Notification - * Configuration in the Amazon Glacier Developer Guide.

+ * @see {@link SetVaultNotificationsCommand} */ - public setVaultNotifications( + setVaultNotifications( args: SetVaultNotificationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public setVaultNotifications( + setVaultNotifications( args: SetVaultNotificationsCommandInput, cb: (err: any, data?: SetVaultNotificationsCommandOutput) => void ): void; - public setVaultNotifications( + setVaultNotifications( args: SetVaultNotificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetVaultNotificationsCommandOutput) => void ): void; - public setVaultNotifications( - args: SetVaultNotificationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetVaultNotificationsCommandOutput) => void), - cb?: (err: any, data?: SetVaultNotificationsCommandOutput) => void - ): Promise | void { - const command = new SetVaultNotificationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation adds an archive to a vault. This is a synchronous operation, and for a - * successful upload, your data is durably persisted. Amazon S3 Glacier returns the archive ID in - * the x-amz-archive-id header of the response.

- * - *

You must use the archive ID to access your data in Amazon S3 Glacier. After you upload - * an archive, you should save the archive ID returned so that you can retrieve or delete the - * archive later. Besides saving the archive ID, you can also index it and give it a friendly - * name to allow for better searching. You can also use the optional archive description field - * to specify how the archive is referred to in an external index of archives, such as you - * might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of - * archive IDs in a vault. For more information, see InitiateJob.

- * - *

You must provide a SHA256 tree hash of the data you are uploading. For information - * about computing a SHA256 tree hash, see Computing Checksums.

- * - *

You can optionally specify an archive description of up to 1,024 printable ASCII - * characters. You can get the archive description when you either retrieve the archive or get - * the vault inventory. For more information, see InitiateJob. Amazon - * Glacier does not interpret the description in any way. An archive description does not need - * to be unique. You cannot use the description to retrieve or sort the archive list.

- * - *

Archives are immutable. After you upload an archive, you cannot edit the archive or - * its description.

- * - *

An AWS account has full permission to perform all operations (actions). However, AWS - * Identity and Access Management (IAM) users don't have any permissions by default. You must - * grant them explicit permission to perform specific actions. For more information, see - * Access Control Using - * AWS Identity and Access Management (IAM).

- *

For conceptual information and underlying REST API, see Uploading an Archive in Amazon - * Glacier and Upload Archive in the - * Amazon Glacier Developer Guide.

+ * @see {@link UploadArchiveCommand} */ - public uploadArchive( - args: UploadArchiveCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public uploadArchive( - args: UploadArchiveCommandInput, - cb: (err: any, data?: UploadArchiveCommandOutput) => void - ): void; - public uploadArchive( + uploadArchive(args: UploadArchiveCommandInput, options?: __HttpHandlerOptions): Promise; + uploadArchive(args: UploadArchiveCommandInput, cb: (err: any, data?: UploadArchiveCommandOutput) => void): void; + uploadArchive( args: UploadArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UploadArchiveCommandOutput) => void ): void; - public uploadArchive( - args: UploadArchiveCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UploadArchiveCommandOutput) => void), - cb?: (err: any, data?: UploadArchiveCommandOutput) => void - ): Promise | void { - const command = new UploadArchiveCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation uploads a part of an archive. You can upload archive parts in any - * order. You can also upload them in parallel. You can upload up to 10,000 parts for a - * multipart upload.

- * - *

Amazon Glacier rejects your upload part request if any of the following conditions is - * true:

- * - *
    - *
  • - *

    - * SHA256 tree hash does not matchTo ensure that part - * data is not corrupted in transmission, you compute a SHA256 tree hash of the part and - * include it in your request. Upon receiving the part data, Amazon S3 Glacier also - * computes a SHA256 tree hash. If these hash values don't match, the operation fails. - * For information about computing a SHA256 tree hash, see Computing - * Checksums.

    - *
  • - *
  • - *

    - * Part size does not matchThe size of each part except - * the last must match the size specified in the corresponding InitiateMultipartUpload request. The size of the last part must be the - * same size as, or smaller than, the specified size.

    - * - *

    If you upload a part whose size is smaller than the part size you specified - * in your initiate multipart upload request and that part is not the last part, then - * the upload part request will succeed. However, the subsequent Complete Multipart - * Upload request will fail.

    - *
    - *
  • - *
  • - *

    - * Range does not alignThe byte range value in the - * request does not align with the part size specified in the corresponding initiate - * request. For example, if you specify a part size of 4194304 bytes (4 MB), then 0 to - * 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to 8388607 (8 MB - 1) are valid part - * ranges. However, if you set a range value of 2 MB to 6 MB, the range does not align - * with the part size and the upload will fail.

    - *
  • - *
- * - *

This operation is idempotent. If you upload the same part multiple times, the data - * included in the most recent request overwrites the previously uploaded data.

- * - *

An AWS account has full permission to perform all operations (actions). However, AWS - * Identity and Access Management (IAM) users don't have any permissions by default. You must - * grant them explicit permission to perform specific actions. For more information, see - * Access Control Using - * AWS Identity and Access Management (IAM).

- *

For conceptual information and underlying REST API, see Uploading Large Archives in - * Parts (Multipart Upload) and Upload Part in the - * Amazon Glacier Developer Guide.

+ * @see {@link UploadMultipartPartCommand} */ - public uploadMultipartPart( + uploadMultipartPart( args: UploadMultipartPartCommandInput, options?: __HttpHandlerOptions ): Promise; - public uploadMultipartPart( + uploadMultipartPart( args: UploadMultipartPartCommandInput, cb: (err: any, data?: UploadMultipartPartCommandOutput) => void ): void; - public uploadMultipartPart( + uploadMultipartPart( args: UploadMultipartPartCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UploadMultipartPartCommandOutput) => void ): void; - public uploadMultipartPart( - args: UploadMultipartPartCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UploadMultipartPartCommandOutput) => void), - cb?: (err: any, data?: UploadMultipartPartCommandOutput) => void - ): Promise | void { - const command = new UploadMultipartPartCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon S3 Glacier (Glacier) is a storage solution for "cold data."

+ * + *

Glacier is an extremely low-cost storage service that provides secure, + * durable, and easy-to-use storage for data backup and archival. With Glacier, + * customers can store their data cost effectively for months, years, or decades. + * Glacier also enables customers to offload the administrative burdens of operating and + * scaling storage to AWS, so they don't have to worry about capacity planning, hardware + * provisioning, data replication, hardware failure and recovery, or time-consuming hardware + * migrations.

+ * + *

Glacier is a great storage choice when low storage cost is paramount and your + * data is rarely retrieved. If your + * application requires fast or frequent access to your data, consider using Amazon S3. For + * more information, see Amazon Simple Storage Service + * (Amazon S3).

+ * + *

You can store any kind of data in any format. There is no maximum limit on the total + * amount of data you can store in Glacier.

+ * + *

If you are a first-time user of Glacier, we recommend that you begin by + * reading the following sections in the Amazon S3 Glacier Developer + * Guide:

+ *
    + *
  • + *

    + * What is + * Amazon S3 Glacier - This section of the Developer Guide describes the + * underlying data model, the operations it supports, and the AWS SDKs that you can use + * to interact with the service.

    + *
  • + *
  • + *

    + * Getting Started + * with Amazon S3 Glacier - The Getting Started section walks you through the + * process of creating a vault, uploading archives, creating jobs to download archives, + * retrieving the job output, and deleting archives.

    + *
  • + *
+ */ +export class Glacier extends GlacierClient implements Glacier {} +createAggregatedClient(commands, Glacier); diff --git a/clients/client-global-accelerator/src/GlobalAccelerator.ts b/clients/client-global-accelerator/src/GlobalAccelerator.ts index 508eeafcb22e..01c910d5f8b1 100644 --- a/clients/client-global-accelerator/src/GlobalAccelerator.ts +++ b/clients/client-global-accelerator/src/GlobalAccelerator.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -242,1823 +243,911 @@ import { WithdrawByoipCidrCommandInput, WithdrawByoipCidrCommandOutput, } from "./commands/WithdrawByoipCidrCommand"; -import { GlobalAcceleratorClient } from "./GlobalAcceleratorClient"; +import { GlobalAcceleratorClient, GlobalAcceleratorClientConfig } from "./GlobalAcceleratorClient"; -/** - * @public - * Global Accelerator - *

This is the Global Accelerator API Reference. This guide is for developers who need detailed information about - * Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the - * Global Accelerator Developer Guide.

- *

Global Accelerator is a service in which you create accelerators to improve the performance - * of your applications for local and global users. Depending on the type of accelerator you choose, you can - * gain additional benefits.

- *
    - *
  • - *

    By using a standard accelerator, you can improve availability of your internet applications - * that are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the Amazon Web Services - * global network.

    - *
  • - *
  • - *

    For other scenarios, you might choose a custom routing accelerator. With a custom routing accelerator, you - * can use application logic to directly map one or more users to a specific endpoint among many endpoints.

    - *
  • - *
- * - *

Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the - * US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 - * on AWS CLI commands.

- *
- * - * - *

By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses - * are anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack, - * Global Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses. - * With a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure - * these entry points to be IPv4 addresses from your own IP address ranges that you bring toGlobal Accelerator (BYOIP).

- * - * - *

For a standard accelerator, - * they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases - * the availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers, - * Amazon EC2 instances, or Elastic IP addresses that are located in one Amazon Web Services Region or multiple Amazon Web Services Regions. For custom routing - * accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that - * are virtual private cloud (VPC) subnets.

- * - * - *

The static IP addresses remain assigned to your accelerator for as long as it exists, even if you - * disable the accelerator and it no longer accepts or routes traffic. However, when you - * delete an accelerator, you lose the static IP addresses that - * are assigned to it, so you can no longer route traffic by using them. You can use - * IAM policies like tag-based permissions with Global Accelerator to limit the users who have - * permissions to delete an accelerator. For more information, see Tag-based policies.

- *
- *

For standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based - * on health, client location, and policies that you configure. The service reacts instantly to - * changes in health or configuration to ensure that internet traffic from clients is always - * directed to healthy endpoints.

- *

For more information about understanding and using Global Accelerator, see the - * Global Accelerator Developer Guide.

- */ -export class GlobalAccelerator extends GlobalAcceleratorClient { +const commands = { + AddCustomRoutingEndpointsCommand, + AddEndpointsCommand, + AdvertiseByoipCidrCommand, + AllowCustomRoutingTrafficCommand, + CreateAcceleratorCommand, + CreateCustomRoutingAcceleratorCommand, + CreateCustomRoutingEndpointGroupCommand, + CreateCustomRoutingListenerCommand, + CreateEndpointGroupCommand, + CreateListenerCommand, + DeleteAcceleratorCommand, + DeleteCustomRoutingAcceleratorCommand, + DeleteCustomRoutingEndpointGroupCommand, + DeleteCustomRoutingListenerCommand, + DeleteEndpointGroupCommand, + DeleteListenerCommand, + DenyCustomRoutingTrafficCommand, + DeprovisionByoipCidrCommand, + DescribeAcceleratorCommand, + DescribeAcceleratorAttributesCommand, + DescribeCustomRoutingAcceleratorCommand, + DescribeCustomRoutingAcceleratorAttributesCommand, + DescribeCustomRoutingEndpointGroupCommand, + DescribeCustomRoutingListenerCommand, + DescribeEndpointGroupCommand, + DescribeListenerCommand, + ListAcceleratorsCommand, + ListByoipCidrsCommand, + ListCustomRoutingAcceleratorsCommand, + ListCustomRoutingEndpointGroupsCommand, + ListCustomRoutingListenersCommand, + ListCustomRoutingPortMappingsCommand, + ListCustomRoutingPortMappingsByDestinationCommand, + ListEndpointGroupsCommand, + ListListenersCommand, + ListTagsForResourceCommand, + ProvisionByoipCidrCommand, + RemoveCustomRoutingEndpointsCommand, + RemoveEndpointsCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAcceleratorCommand, + UpdateAcceleratorAttributesCommand, + UpdateCustomRoutingAcceleratorCommand, + UpdateCustomRoutingAcceleratorAttributesCommand, + UpdateCustomRoutingListenerCommand, + UpdateEndpointGroupCommand, + UpdateListenerCommand, + WithdrawByoipCidrCommand, +}; + +export interface GlobalAccelerator { /** - * @public - *

Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.

- *

The listener port range must be large enough to support the number of IP addresses that can be - * specified in your subnet. The number of ports required is: subnet size times the number - * of ports per destination EC2 instances. For example, a subnet defined as /24 requires a listener - * port range of at least 255 ports.

- *

Note: You must have enough remaining listener ports available to - * map to the subnet ports, or the call will fail with a LimitExceededException.

- *

By default, all destinations in a subnet in a custom routing accelerator cannot receive traffic. To enable all - * destinations to receive traffic, or to specify individual port mappings that can receive - * traffic, see the - * AllowCustomRoutingTraffic operation.

+ * @see {@link AddCustomRoutingEndpointsCommand} */ - public addCustomRoutingEndpoints( + addCustomRoutingEndpoints( args: AddCustomRoutingEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public addCustomRoutingEndpoints( + addCustomRoutingEndpoints( args: AddCustomRoutingEndpointsCommandInput, cb: (err: any, data?: AddCustomRoutingEndpointsCommandOutput) => void ): void; - public addCustomRoutingEndpoints( + addCustomRoutingEndpoints( args: AddCustomRoutingEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddCustomRoutingEndpointsCommandOutput) => void ): void; - public addCustomRoutingEndpoints( - args: AddCustomRoutingEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddCustomRoutingEndpointsCommandOutput) => void), - cb?: (err: any, data?: AddCustomRoutingEndpointsCommandOutput) => void - ): Promise | void { - const command = new AddCustomRoutingEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Add endpoints to an endpoint group. The AddEndpoints API operation is the recommended option for adding endpoints. The - * alternative options are to add endpoints when you create an endpoint group (with the - * CreateEndpointGroup API) - * or when you update an endpoint group (with the - * UpdateEndpointGroup API).

- *

There are two advantages to using AddEndpoints to add endpoints:

- *
    - *
  • - *

    It's faster, because Global Accelerator only has to resolve the new endpoints that - * you're adding.

    - *
  • - *
  • - *

    It's more convenient, because you don't need to specify all of the current - * endpoints that are already in the endpoint group in addition to the new endpoints that you want to add.

    - *
  • - *
+ * @see {@link AddEndpointsCommand} */ - public addEndpoints( - args: AddEndpointsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public addEndpoints(args: AddEndpointsCommandInput, cb: (err: any, data?: AddEndpointsCommandOutput) => void): void; - public addEndpoints( + addEndpoints(args: AddEndpointsCommandInput, options?: __HttpHandlerOptions): Promise; + addEndpoints(args: AddEndpointsCommandInput, cb: (err: any, data?: AddEndpointsCommandOutput) => void): void; + addEndpoints( args: AddEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddEndpointsCommandOutput) => void ): void; - public addEndpoints( - args: AddEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddEndpointsCommandOutput) => void), - cb?: (err: any, data?: AddEndpointsCommandOutput) => void - ): Promise | void { - const command = new AddEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources - * through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to - * the specified addresses starts routing to Amazon Web Services because of propagation delays.

- *

To stop advertising the BYOIP address range, use - * WithdrawByoipCidr.

- *

For more information, see Bring your own - * IP addresses (BYOIP) in the Global Accelerator Developer Guide.

+ * @see {@link AdvertiseByoipCidrCommand} */ - public advertiseByoipCidr( + advertiseByoipCidr( args: AdvertiseByoipCidrCommandInput, options?: __HttpHandlerOptions ): Promise; - public advertiseByoipCidr( + advertiseByoipCidr( args: AdvertiseByoipCidrCommandInput, cb: (err: any, data?: AdvertiseByoipCidrCommandOutput) => void ): void; - public advertiseByoipCidr( + advertiseByoipCidr( args: AdvertiseByoipCidrCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AdvertiseByoipCidrCommandOutput) => void ): void; - public advertiseByoipCidr( - args: AdvertiseByoipCidrCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AdvertiseByoipCidrCommandOutput) => void), - cb?: (err: any, data?: AdvertiseByoipCidrCommandOutput) => void - ): Promise | void { - const command = new AdvertiseByoipCidrCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic - * for a custom routing accelerator. You can allow traffic to all destinations in the subnet endpoint, or allow traffic to a - * specified list of destination IP addresses and ports in the subnet. Note that you cannot specify IP addresses or ports - * outside of the range that you configured for the endpoint group.

- *

After you make changes, you can verify that the updates are complete by checking the status of your - * accelerator: the status changes from IN_PROGRESS to DEPLOYED.

+ * @see {@link AllowCustomRoutingTrafficCommand} */ - public allowCustomRoutingTraffic( + allowCustomRoutingTraffic( args: AllowCustomRoutingTrafficCommandInput, options?: __HttpHandlerOptions ): Promise; - public allowCustomRoutingTraffic( + allowCustomRoutingTraffic( args: AllowCustomRoutingTrafficCommandInput, cb: (err: any, data?: AllowCustomRoutingTrafficCommandOutput) => void ): void; - public allowCustomRoutingTraffic( + allowCustomRoutingTraffic( args: AllowCustomRoutingTrafficCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AllowCustomRoutingTrafficCommandOutput) => void ): void; - public allowCustomRoutingTraffic( - args: AllowCustomRoutingTrafficCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AllowCustomRoutingTrafficCommandOutput) => void), - cb?: (err: any, data?: AllowCustomRoutingTrafficCommandOutput) => void - ): Promise | void { - const command = new AllowCustomRoutingTrafficCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic - * to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers.

- * - *

Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the - * US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 - * on AWS CLI commands.

- *
+ * @see {@link CreateAcceleratorCommand} */ - public createAccelerator( + createAccelerator( args: CreateAcceleratorCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAccelerator( + createAccelerator( args: CreateAcceleratorCommandInput, cb: (err: any, data?: CreateAcceleratorCommandOutput) => void ): void; - public createAccelerator( + createAccelerator( args: CreateAcceleratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAcceleratorCommandOutput) => void ): void; - public createAccelerator( - args: CreateAcceleratorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAcceleratorCommandOutput) => void), - cb?: (err: any, data?: CreateAcceleratorCommandOutput) => void - ): Promise | void { - const command = new CreateAcceleratorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands - * of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints.

- *

Be aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive - * traffic. To enable all destinations to receive traffic, or to specify individual port - * mappings that can receive traffic, see the - * AllowCustomRoutingTraffic operation.

- * - *

Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the - * US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 - * on AWS CLI commands.

- *
+ * @see {@link CreateCustomRoutingAcceleratorCommand} */ - public createCustomRoutingAccelerator( + createCustomRoutingAccelerator( args: CreateCustomRoutingAcceleratorCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCustomRoutingAccelerator( + createCustomRoutingAccelerator( args: CreateCustomRoutingAcceleratorCommandInput, cb: (err: any, data?: CreateCustomRoutingAcceleratorCommandOutput) => void ): void; - public createCustomRoutingAccelerator( + createCustomRoutingAccelerator( args: CreateCustomRoutingAcceleratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomRoutingAcceleratorCommandOutput) => void ): void; - public createCustomRoutingAccelerator( - args: CreateCustomRoutingAcceleratorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCustomRoutingAcceleratorCommandOutput) => void), - cb?: (err: any, data?: CreateCustomRoutingAcceleratorCommandOutput) => void - ): Promise | void { - const command = new CreateCustomRoutingAcceleratorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create an endpoint group for the specified listener for a custom routing accelerator. - * An endpoint group is a collection of endpoints in one Amazon Web Services - * Region.

+ * @see {@link CreateCustomRoutingEndpointGroupCommand} */ - public createCustomRoutingEndpointGroup( + createCustomRoutingEndpointGroup( args: CreateCustomRoutingEndpointGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCustomRoutingEndpointGroup( + createCustomRoutingEndpointGroup( args: CreateCustomRoutingEndpointGroupCommandInput, cb: (err: any, data?: CreateCustomRoutingEndpointGroupCommandOutput) => void ): void; - public createCustomRoutingEndpointGroup( + createCustomRoutingEndpointGroup( args: CreateCustomRoutingEndpointGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomRoutingEndpointGroupCommandOutput) => void ): void; - public createCustomRoutingEndpointGroup( - args: CreateCustomRoutingEndpointGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCustomRoutingEndpointGroupCommandOutput) => void), - cb?: (err: any, data?: CreateCustomRoutingEndpointGroupCommandOutput) => void - ): Promise | void { - const command = new CreateCustomRoutingEndpointGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create a listener to process inbound connections from clients to a custom routing accelerator. - * Connections arrive to assigned static IP addresses on the port range that you specify.

+ * @see {@link CreateCustomRoutingListenerCommand} */ - public createCustomRoutingListener( + createCustomRoutingListener( args: CreateCustomRoutingListenerCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCustomRoutingListener( + createCustomRoutingListener( args: CreateCustomRoutingListenerCommandInput, cb: (err: any, data?: CreateCustomRoutingListenerCommandOutput) => void ): void; - public createCustomRoutingListener( + createCustomRoutingListener( args: CreateCustomRoutingListenerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomRoutingListenerCommandOutput) => void ): void; - public createCustomRoutingListener( - args: CreateCustomRoutingListenerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCustomRoutingListenerCommandOutput) => void), - cb?: (err: any, data?: CreateCustomRoutingListenerCommandOutput) => void - ): Promise | void { - const command = new CreateCustomRoutingListenerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one Amazon Web Services - * Region. A resource must be valid and active when you add it as an endpoint.

+ * @see {@link CreateEndpointGroupCommand} */ - public createEndpointGroup( + createEndpointGroup( args: CreateEndpointGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEndpointGroup( + createEndpointGroup( args: CreateEndpointGroupCommandInput, cb: (err: any, data?: CreateEndpointGroupCommandOutput) => void ): void; - public createEndpointGroup( + createEndpointGroup( args: CreateEndpointGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEndpointGroupCommandOutput) => void ): void; - public createEndpointGroup( - args: CreateEndpointGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEndpointGroupCommandOutput) => void), - cb?: (err: any, data?: CreateEndpointGroupCommandOutput) => void - ): Promise | void { - const command = new CreateEndpointGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static - * IP addresses on a port, port range, or list of port ranges that you specify.

+ * @see {@link CreateListenerCommand} */ - public createListener( + createListener( args: CreateListenerCommandInput, options?: __HttpHandlerOptions ): Promise; - public createListener( - args: CreateListenerCommandInput, - cb: (err: any, data?: CreateListenerCommandOutput) => void - ): void; - public createListener( + createListener(args: CreateListenerCommandInput, cb: (err: any, data?: CreateListenerCommandOutput) => void): void; + createListener( args: CreateListenerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateListenerCommandOutput) => void ): void; - public createListener( - args: CreateListenerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateListenerCommandOutput) => void), - cb?: (err: any, data?: CreateListenerCommandOutput) => void - ): Promise | void { - const command = new CreateListenerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources - * (listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false.

- * - *

When you create an accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. - * Alternatively, you can bring your own IP address ranges to Global Accelerator and assign IP addresses from those ranges. - *

- *

The IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and - * it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the - * static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them. - * As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You - * can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, - * see Identity and access management in - * the Global Accelerator Developer Guide.

- *
+ * @see {@link DeleteAcceleratorCommand} */ - public deleteAccelerator( + deleteAccelerator( args: DeleteAcceleratorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAccelerator( + deleteAccelerator( args: DeleteAcceleratorCommandInput, cb: (err: any, data?: DeleteAcceleratorCommandOutput) => void ): void; - public deleteAccelerator( + deleteAccelerator( args: DeleteAcceleratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAcceleratorCommandOutput) => void ): void; - public deleteAccelerator( - args: DeleteAcceleratorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAcceleratorCommandOutput) => void), - cb?: (err: any, data?: DeleteAcceleratorCommandOutput) => void - ): Promise | void { - const command = new DeleteAcceleratorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete a custom routing accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources - * (listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false.

- * - *

When you create a custom routing accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. - *

- *

The IP - * addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and - * it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the - * static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them. - * As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You - * can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, - * see Identity and access management in - * the Global Accelerator Developer Guide.

- *
+ * @see {@link DeleteCustomRoutingAcceleratorCommand} */ - public deleteCustomRoutingAccelerator( + deleteCustomRoutingAccelerator( args: DeleteCustomRoutingAcceleratorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCustomRoutingAccelerator( + deleteCustomRoutingAccelerator( args: DeleteCustomRoutingAcceleratorCommandInput, cb: (err: any, data?: DeleteCustomRoutingAcceleratorCommandOutput) => void ): void; - public deleteCustomRoutingAccelerator( + deleteCustomRoutingAccelerator( args: DeleteCustomRoutingAcceleratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomRoutingAcceleratorCommandOutput) => void ): void; - public deleteCustomRoutingAccelerator( - args: DeleteCustomRoutingAcceleratorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCustomRoutingAcceleratorCommandOutput) => void), - cb?: (err: any, data?: DeleteCustomRoutingAcceleratorCommandOutput) => void - ): Promise | void { - const command = new DeleteCustomRoutingAcceleratorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete an endpoint group from a listener for a custom routing accelerator.

+ * @see {@link DeleteCustomRoutingEndpointGroupCommand} */ - public deleteCustomRoutingEndpointGroup( + deleteCustomRoutingEndpointGroup( args: DeleteCustomRoutingEndpointGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCustomRoutingEndpointGroup( + deleteCustomRoutingEndpointGroup( args: DeleteCustomRoutingEndpointGroupCommandInput, cb: (err: any, data?: DeleteCustomRoutingEndpointGroupCommandOutput) => void ): void; - public deleteCustomRoutingEndpointGroup( + deleteCustomRoutingEndpointGroup( args: DeleteCustomRoutingEndpointGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomRoutingEndpointGroupCommandOutput) => void ): void; - public deleteCustomRoutingEndpointGroup( - args: DeleteCustomRoutingEndpointGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCustomRoutingEndpointGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteCustomRoutingEndpointGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteCustomRoutingEndpointGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete a listener for a custom routing accelerator.

+ * @see {@link DeleteCustomRoutingListenerCommand} */ - public deleteCustomRoutingListener( + deleteCustomRoutingListener( args: DeleteCustomRoutingListenerCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCustomRoutingListener( + deleteCustomRoutingListener( args: DeleteCustomRoutingListenerCommandInput, cb: (err: any, data?: DeleteCustomRoutingListenerCommandOutput) => void ): void; - public deleteCustomRoutingListener( + deleteCustomRoutingListener( args: DeleteCustomRoutingListenerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomRoutingListenerCommandOutput) => void ): void; - public deleteCustomRoutingListener( - args: DeleteCustomRoutingListenerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCustomRoutingListenerCommandOutput) => void), - cb?: (err: any, data?: DeleteCustomRoutingListenerCommandOutput) => void - ): Promise | void { - const command = new DeleteCustomRoutingListenerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete an endpoint group from a listener.

+ * @see {@link DeleteEndpointGroupCommand} */ - public deleteEndpointGroup( + deleteEndpointGroup( args: DeleteEndpointGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEndpointGroup( + deleteEndpointGroup( args: DeleteEndpointGroupCommandInput, cb: (err: any, data?: DeleteEndpointGroupCommandOutput) => void ): void; - public deleteEndpointGroup( + deleteEndpointGroup( args: DeleteEndpointGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEndpointGroupCommandOutput) => void ): void; - public deleteEndpointGroup( - args: DeleteEndpointGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEndpointGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteEndpointGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteEndpointGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete a listener from an accelerator.

+ * @see {@link DeleteListenerCommand} */ - public deleteListener( + deleteListener( args: DeleteListenerCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteListener( - args: DeleteListenerCommandInput, - cb: (err: any, data?: DeleteListenerCommandOutput) => void - ): void; - public deleteListener( + deleteListener(args: DeleteListenerCommandInput, cb: (err: any, data?: DeleteListenerCommandOutput) => void): void; + deleteListener( args: DeleteListenerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteListenerCommandOutput) => void ): void; - public deleteListener( - args: DeleteListenerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteListenerCommandOutput) => void), - cb?: (err: any, data?: DeleteListenerCommandOutput) => void - ): Promise | void { - const command = new DeleteListenerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic - * for a custom routing accelerator. You can deny traffic to all destinations in the VPC endpoint, or deny traffic to a - * specified list of destination IP addresses and ports. Note that you cannot specify IP addresses - * or ports outside of the range that you configured for the endpoint group.

- *

After you make changes, you can verify that the updates are complete by checking the status of your - * accelerator: the status changes from IN_PROGRESS to DEPLOYED.

+ * @see {@link DenyCustomRoutingTrafficCommand} */ - public denyCustomRoutingTraffic( + denyCustomRoutingTraffic( args: DenyCustomRoutingTrafficCommandInput, options?: __HttpHandlerOptions ): Promise; - public denyCustomRoutingTraffic( + denyCustomRoutingTraffic( args: DenyCustomRoutingTrafficCommandInput, cb: (err: any, data?: DenyCustomRoutingTrafficCommandOutput) => void ): void; - public denyCustomRoutingTraffic( + denyCustomRoutingTraffic( args: DenyCustomRoutingTrafficCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DenyCustomRoutingTrafficCommandOutput) => void ): void; - public denyCustomRoutingTraffic( - args: DenyCustomRoutingTrafficCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DenyCustomRoutingTrafficCommandOutput) => void), - cb?: (err: any, data?: DenyCustomRoutingTrafficCommandOutput) => void - ): Promise | void { - const command = new DenyCustomRoutingTrafficCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Releases the specified address range that you provisioned to use with your Amazon Web Services resources - * through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.

- *

Before you can release an address range, you must stop advertising it by using WithdrawByoipCidr and you must not have - * any accelerators that are using static IP addresses allocated from its address range. - *

- *

For more information, see Bring - * your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

+ * @see {@link DeprovisionByoipCidrCommand} */ - public deprovisionByoipCidr( + deprovisionByoipCidr( args: DeprovisionByoipCidrCommandInput, options?: __HttpHandlerOptions ): Promise; - public deprovisionByoipCidr( + deprovisionByoipCidr( args: DeprovisionByoipCidrCommandInput, cb: (err: any, data?: DeprovisionByoipCidrCommandOutput) => void ): void; - public deprovisionByoipCidr( + deprovisionByoipCidr( args: DeprovisionByoipCidrCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeprovisionByoipCidrCommandOutput) => void ): void; - public deprovisionByoipCidr( - args: DeprovisionByoipCidrCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeprovisionByoipCidrCommandOutput) => void), - cb?: (err: any, data?: DeprovisionByoipCidrCommandOutput) => void - ): Promise | void { - const command = new DeprovisionByoipCidrCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describe an accelerator.

+ * @see {@link DescribeAcceleratorCommand} */ - public describeAccelerator( + describeAccelerator( args: DescribeAcceleratorCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccelerator( + describeAccelerator( args: DescribeAcceleratorCommandInput, cb: (err: any, data?: DescribeAcceleratorCommandOutput) => void ): void; - public describeAccelerator( + describeAccelerator( args: DescribeAcceleratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAcceleratorCommandOutput) => void ): void; - public describeAccelerator( - args: DescribeAcceleratorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAcceleratorCommandOutput) => void), - cb?: (err: any, data?: DescribeAcceleratorCommandOutput) => void - ): Promise | void { - const command = new DescribeAcceleratorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describe the attributes of an accelerator. - *

+ * @see {@link DescribeAcceleratorAttributesCommand} */ - public describeAcceleratorAttributes( + describeAcceleratorAttributes( args: DescribeAcceleratorAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAcceleratorAttributes( + describeAcceleratorAttributes( args: DescribeAcceleratorAttributesCommandInput, cb: (err: any, data?: DescribeAcceleratorAttributesCommandOutput) => void ): void; - public describeAcceleratorAttributes( + describeAcceleratorAttributes( args: DescribeAcceleratorAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAcceleratorAttributesCommandOutput) => void ): void; - public describeAcceleratorAttributes( - args: DescribeAcceleratorAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAcceleratorAttributesCommandOutput) => void), - cb?: (err: any, data?: DescribeAcceleratorAttributesCommandOutput) => void - ): Promise | void { - const command = new DescribeAcceleratorAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describe a custom routing accelerator.

+ * @see {@link DescribeCustomRoutingAcceleratorCommand} */ - public describeCustomRoutingAccelerator( + describeCustomRoutingAccelerator( args: DescribeCustomRoutingAcceleratorCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCustomRoutingAccelerator( + describeCustomRoutingAccelerator( args: DescribeCustomRoutingAcceleratorCommandInput, cb: (err: any, data?: DescribeCustomRoutingAcceleratorCommandOutput) => void ): void; - public describeCustomRoutingAccelerator( + describeCustomRoutingAccelerator( args: DescribeCustomRoutingAcceleratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCustomRoutingAcceleratorCommandOutput) => void ): void; - public describeCustomRoutingAccelerator( - args: DescribeCustomRoutingAcceleratorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCustomRoutingAcceleratorCommandOutput) => void), - cb?: (err: any, data?: DescribeCustomRoutingAcceleratorCommandOutput) => void - ): Promise | void { - const command = new DescribeCustomRoutingAcceleratorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describe the attributes of a custom routing accelerator.

+ * @see {@link DescribeCustomRoutingAcceleratorAttributesCommand} */ - public describeCustomRoutingAcceleratorAttributes( + describeCustomRoutingAcceleratorAttributes( args: DescribeCustomRoutingAcceleratorAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCustomRoutingAcceleratorAttributes( + describeCustomRoutingAcceleratorAttributes( args: DescribeCustomRoutingAcceleratorAttributesCommandInput, cb: (err: any, data?: DescribeCustomRoutingAcceleratorAttributesCommandOutput) => void ): void; - public describeCustomRoutingAcceleratorAttributes( + describeCustomRoutingAcceleratorAttributes( args: DescribeCustomRoutingAcceleratorAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCustomRoutingAcceleratorAttributesCommandOutput) => void ): void; - public describeCustomRoutingAcceleratorAttributes( - args: DescribeCustomRoutingAcceleratorAttributesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeCustomRoutingAcceleratorAttributesCommandOutput) => void), - cb?: (err: any, data?: DescribeCustomRoutingAcceleratorAttributesCommandOutput) => void - ): Promise | void { - const command = new DescribeCustomRoutingAcceleratorAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describe an endpoint group for a custom routing accelerator.

+ * @see {@link DescribeCustomRoutingEndpointGroupCommand} */ - public describeCustomRoutingEndpointGroup( + describeCustomRoutingEndpointGroup( args: DescribeCustomRoutingEndpointGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCustomRoutingEndpointGroup( + describeCustomRoutingEndpointGroup( args: DescribeCustomRoutingEndpointGroupCommandInput, cb: (err: any, data?: DescribeCustomRoutingEndpointGroupCommandOutput) => void ): void; - public describeCustomRoutingEndpointGroup( + describeCustomRoutingEndpointGroup( args: DescribeCustomRoutingEndpointGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCustomRoutingEndpointGroupCommandOutput) => void ): void; - public describeCustomRoutingEndpointGroup( - args: DescribeCustomRoutingEndpointGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCustomRoutingEndpointGroupCommandOutput) => void), - cb?: (err: any, data?: DescribeCustomRoutingEndpointGroupCommandOutput) => void - ): Promise | void { - const command = new DescribeCustomRoutingEndpointGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The description of a listener for a custom routing accelerator.

+ * @see {@link DescribeCustomRoutingListenerCommand} */ - public describeCustomRoutingListener( + describeCustomRoutingListener( args: DescribeCustomRoutingListenerCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCustomRoutingListener( + describeCustomRoutingListener( args: DescribeCustomRoutingListenerCommandInput, cb: (err: any, data?: DescribeCustomRoutingListenerCommandOutput) => void ): void; - public describeCustomRoutingListener( + describeCustomRoutingListener( args: DescribeCustomRoutingListenerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCustomRoutingListenerCommandOutput) => void ): void; - public describeCustomRoutingListener( - args: DescribeCustomRoutingListenerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCustomRoutingListenerCommandOutput) => void), - cb?: (err: any, data?: DescribeCustomRoutingListenerCommandOutput) => void - ): Promise | void { - const command = new DescribeCustomRoutingListenerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describe an endpoint group.

+ * @see {@link DescribeEndpointGroupCommand} */ - public describeEndpointGroup( + describeEndpointGroup( args: DescribeEndpointGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEndpointGroup( + describeEndpointGroup( args: DescribeEndpointGroupCommandInput, cb: (err: any, data?: DescribeEndpointGroupCommandOutput) => void ): void; - public describeEndpointGroup( + describeEndpointGroup( args: DescribeEndpointGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEndpointGroupCommandOutput) => void ): void; - public describeEndpointGroup( - args: DescribeEndpointGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEndpointGroupCommandOutput) => void), - cb?: (err: any, data?: DescribeEndpointGroupCommandOutput) => void - ): Promise | void { - const command = new DescribeEndpointGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describe a listener.

+ * @see {@link DescribeListenerCommand} */ - public describeListener( + describeListener( args: DescribeListenerCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeListener( + describeListener( args: DescribeListenerCommandInput, cb: (err: any, data?: DescribeListenerCommandOutput) => void ): void; - public describeListener( + describeListener( args: DescribeListenerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeListenerCommandOutput) => void ): void; - public describeListener( - args: DescribeListenerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeListenerCommandOutput) => void), - cb?: (err: any, data?: DescribeListenerCommandOutput) => void - ): Promise | void { - const command = new DescribeListenerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the accelerators for an Amazon Web Services account.

+ * @see {@link ListAcceleratorsCommand} */ - public listAccelerators( + listAccelerators( args: ListAcceleratorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAccelerators( + listAccelerators( args: ListAcceleratorsCommandInput, cb: (err: any, data?: ListAcceleratorsCommandOutput) => void ): void; - public listAccelerators( + listAccelerators( args: ListAcceleratorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAcceleratorsCommandOutput) => void ): void; - public listAccelerators( - args: ListAcceleratorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAcceleratorsCommandOutput) => void), - cb?: (err: any, data?: ListAcceleratorsCommandOutput) => void - ): Promise | void { - const command = new ListAcceleratorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including - * the current state and a history of state changes.

+ * @see {@link ListByoipCidrsCommand} */ - public listByoipCidrs( + listByoipCidrs( args: ListByoipCidrsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listByoipCidrs( - args: ListByoipCidrsCommandInput, - cb: (err: any, data?: ListByoipCidrsCommandOutput) => void - ): void; - public listByoipCidrs( + listByoipCidrs(args: ListByoipCidrsCommandInput, cb: (err: any, data?: ListByoipCidrsCommandOutput) => void): void; + listByoipCidrs( args: ListByoipCidrsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListByoipCidrsCommandOutput) => void ): void; - public listByoipCidrs( - args: ListByoipCidrsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListByoipCidrsCommandOutput) => void), - cb?: (err: any, data?: ListByoipCidrsCommandOutput) => void - ): Promise | void { - const command = new ListByoipCidrsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the custom routing accelerators for an Amazon Web Services account.

+ * @see {@link ListCustomRoutingAcceleratorsCommand} */ - public listCustomRoutingAccelerators( + listCustomRoutingAccelerators( args: ListCustomRoutingAcceleratorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCustomRoutingAccelerators( + listCustomRoutingAccelerators( args: ListCustomRoutingAcceleratorsCommandInput, cb: (err: any, data?: ListCustomRoutingAcceleratorsCommandOutput) => void ): void; - public listCustomRoutingAccelerators( + listCustomRoutingAccelerators( args: ListCustomRoutingAcceleratorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCustomRoutingAcceleratorsCommandOutput) => void ): void; - public listCustomRoutingAccelerators( - args: ListCustomRoutingAcceleratorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCustomRoutingAcceleratorsCommandOutput) => void), - cb?: (err: any, data?: ListCustomRoutingAcceleratorsCommandOutput) => void - ): Promise | void { - const command = new ListCustomRoutingAcceleratorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the endpoint groups that are associated with a listener for a custom routing accelerator.

+ * @see {@link ListCustomRoutingEndpointGroupsCommand} */ - public listCustomRoutingEndpointGroups( + listCustomRoutingEndpointGroups( args: ListCustomRoutingEndpointGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCustomRoutingEndpointGroups( + listCustomRoutingEndpointGroups( args: ListCustomRoutingEndpointGroupsCommandInput, cb: (err: any, data?: ListCustomRoutingEndpointGroupsCommandOutput) => void ): void; - public listCustomRoutingEndpointGroups( + listCustomRoutingEndpointGroups( args: ListCustomRoutingEndpointGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCustomRoutingEndpointGroupsCommandOutput) => void ): void; - public listCustomRoutingEndpointGroups( - args: ListCustomRoutingEndpointGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCustomRoutingEndpointGroupsCommandOutput) => void), - cb?: (err: any, data?: ListCustomRoutingEndpointGroupsCommandOutput) => void - ): Promise | void { - const command = new ListCustomRoutingEndpointGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the listeners for a custom routing accelerator.

+ * @see {@link ListCustomRoutingListenersCommand} */ - public listCustomRoutingListeners( + listCustomRoutingListeners( args: ListCustomRoutingListenersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCustomRoutingListeners( + listCustomRoutingListeners( args: ListCustomRoutingListenersCommandInput, cb: (err: any, data?: ListCustomRoutingListenersCommandOutput) => void ): void; - public listCustomRoutingListeners( + listCustomRoutingListeners( args: ListCustomRoutingListenersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCustomRoutingListenersCommandOutput) => void ): void; - public listCustomRoutingListeners( - args: ListCustomRoutingListenersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCustomRoutingListenersCommandOutput) => void), - cb?: (err: any, data?: ListCustomRoutingListenersCommandOutput) => void - ): Promise | void { - const command = new ListCustomRoutingListenersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance - * IP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator. - * For each subnet endpoint that you add, Global Accelerator creates a new static port mapping for the accelerator. The port - * mappings don't change after Global Accelerator generates them, so you can retrieve and cache the full mapping on your servers.

- *

If you remove a subnet from your accelerator, Global Accelerator removes (reclaims) the port mappings. If you add a subnet to - * your accelerator, Global Accelerator creates new port mappings (the existing ones don't change). If you add or remove EC2 instances - * in your subnet, the port mappings don't change, because the mappings are created when you add the subnet to Global Accelerator.

- *

The mappings also include a flag for each destination denoting which destination IP addresses and - * ports are allowed or denied traffic.

+ * @see {@link ListCustomRoutingPortMappingsCommand} */ - public listCustomRoutingPortMappings( + listCustomRoutingPortMappings( args: ListCustomRoutingPortMappingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCustomRoutingPortMappings( + listCustomRoutingPortMappings( args: ListCustomRoutingPortMappingsCommandInput, cb: (err: any, data?: ListCustomRoutingPortMappingsCommandOutput) => void ): void; - public listCustomRoutingPortMappings( + listCustomRoutingPortMappings( args: ListCustomRoutingPortMappingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCustomRoutingPortMappingsCommandOutput) => void ): void; - public listCustomRoutingPortMappings( - args: ListCustomRoutingPortMappingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCustomRoutingPortMappingsCommandOutput) => void), - cb?: (err: any, data?: ListCustomRoutingPortMappingsCommandOutput) => void - ): Promise | void { - const command = new ListCustomRoutingPortMappingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint. The - * response is the mappings for one destination IP address. This is useful when your subnet endpoint has mappings that - * span multiple custom routing accelerators in your account, or for scenarios where you only want to - * list the port mappings for a specific destination instance.

+ * @see {@link ListCustomRoutingPortMappingsByDestinationCommand} */ - public listCustomRoutingPortMappingsByDestination( + listCustomRoutingPortMappingsByDestination( args: ListCustomRoutingPortMappingsByDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCustomRoutingPortMappingsByDestination( + listCustomRoutingPortMappingsByDestination( args: ListCustomRoutingPortMappingsByDestinationCommandInput, cb: (err: any, data?: ListCustomRoutingPortMappingsByDestinationCommandOutput) => void ): void; - public listCustomRoutingPortMappingsByDestination( + listCustomRoutingPortMappingsByDestination( args: ListCustomRoutingPortMappingsByDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCustomRoutingPortMappingsByDestinationCommandOutput) => void ): void; - public listCustomRoutingPortMappingsByDestination( - args: ListCustomRoutingPortMappingsByDestinationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListCustomRoutingPortMappingsByDestinationCommandOutput) => void), - cb?: (err: any, data?: ListCustomRoutingPortMappingsByDestinationCommandOutput) => void - ): Promise | void { - const command = new ListCustomRoutingPortMappingsByDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the endpoint groups that are associated with a listener.

+ * @see {@link ListEndpointGroupsCommand} */ - public listEndpointGroups( + listEndpointGroups( args: ListEndpointGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEndpointGroups( + listEndpointGroups( args: ListEndpointGroupsCommandInput, cb: (err: any, data?: ListEndpointGroupsCommandOutput) => void ): void; - public listEndpointGroups( + listEndpointGroups( args: ListEndpointGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEndpointGroupsCommandOutput) => void ): void; - public listEndpointGroups( - args: ListEndpointGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEndpointGroupsCommandOutput) => void), - cb?: (err: any, data?: ListEndpointGroupsCommandOutput) => void - ): Promise | void { - const command = new ListEndpointGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the listeners for an accelerator.

+ * @see {@link ListListenersCommand} */ - public listListeners( - args: ListListenersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listListeners( - args: ListListenersCommandInput, - cb: (err: any, data?: ListListenersCommandOutput) => void - ): void; - public listListeners( + listListeners(args: ListListenersCommandInput, options?: __HttpHandlerOptions): Promise; + listListeners(args: ListListenersCommandInput, cb: (err: any, data?: ListListenersCommandOutput) => void): void; + listListeners( args: ListListenersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListListenersCommandOutput) => void ): void; - public listListeners( - args: ListListenersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListListenersCommandOutput) => void), - cb?: (err: any, data?: ListListenersCommandOutput) => void - ): Promise | void { - const command = new ListListenersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all tags for an accelerator.

- *

For more information, see Tagging - * in Global Accelerator in the Global Accelerator Developer Guide.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP - * addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, - * it is ready to be advertised using - * AdvertiseByoipCidr.

- *

For more information, see Bring your own - * IP addresses (BYOIP) in the Global Accelerator Developer Guide.

+ * @see {@link ProvisionByoipCidrCommand} */ - public provisionByoipCidr( + provisionByoipCidr( args: ProvisionByoipCidrCommandInput, options?: __HttpHandlerOptions ): Promise; - public provisionByoipCidr( + provisionByoipCidr( args: ProvisionByoipCidrCommandInput, cb: (err: any, data?: ProvisionByoipCidrCommandOutput) => void ): void; - public provisionByoipCidr( + provisionByoipCidr( args: ProvisionByoipCidrCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ProvisionByoipCidrCommandOutput) => void ): void; - public provisionByoipCidr( - args: ProvisionByoipCidrCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ProvisionByoipCidrCommandOutput) => void), - cb?: (err: any, data?: ProvisionByoipCidrCommandOutput) => void - ): Promise | void { - const command = new ProvisionByoipCidrCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Remove endpoints from a custom routing accelerator.

+ * @see {@link RemoveCustomRoutingEndpointsCommand} */ - public removeCustomRoutingEndpoints( + removeCustomRoutingEndpoints( args: RemoveCustomRoutingEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeCustomRoutingEndpoints( + removeCustomRoutingEndpoints( args: RemoveCustomRoutingEndpointsCommandInput, cb: (err: any, data?: RemoveCustomRoutingEndpointsCommandOutput) => void ): void; - public removeCustomRoutingEndpoints( + removeCustomRoutingEndpoints( args: RemoveCustomRoutingEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveCustomRoutingEndpointsCommandOutput) => void ): void; - public removeCustomRoutingEndpoints( - args: RemoveCustomRoutingEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveCustomRoutingEndpointsCommandOutput) => void), - cb?: (err: any, data?: RemoveCustomRoutingEndpointsCommandOutput) => void - ): Promise | void { - const command = new RemoveCustomRoutingEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Remove endpoints from an endpoint group.

- *

The RemoveEndpoints API operation is the recommended option for removing endpoints. The alternative is to remove - * endpoints by updating an endpoint group by using the - * UpdateEndpointGroup - * API operation. There are two advantages to using AddEndpoints to remove endpoints instead:

- *
    - *
  • - *

    It's more convenient, because you only need to specify the endpoints that you want to remove. With the - * UpdateEndpointGroup API operation, you must specify all of the endpoints in the - * endpoint group except the ones that you want to remove from the group.

    - *
  • - *
  • - *

    It's faster, because Global Accelerator doesn't need to resolve any endpoints. With the - * UpdateEndpointGroup API operation, Global Accelerator must resolve all of the endpoints that - * remain in the group.

    - *
  • - *
+ * @see {@link RemoveEndpointsCommand} */ - public removeEndpoints( + removeEndpoints( args: RemoveEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeEndpoints( - args: RemoveEndpointsCommandInput, - cb: (err: any, data?: RemoveEndpointsCommandOutput) => void - ): void; - public removeEndpoints( + removeEndpoints(args: RemoveEndpointsCommandInput, cb: (err: any, data?: RemoveEndpointsCommandOutput) => void): void; + removeEndpoints( args: RemoveEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveEndpointsCommandOutput) => void ): void; - public removeEndpoints( - args: RemoveEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveEndpointsCommandOutput) => void), - cb?: (err: any, data?: RemoveEndpointsCommandOutput) => void - ): Promise | void { - const command = new RemoveEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Add tags to an accelerator resource.

- *

For more information, see Tagging - * in Global Accelerator in the Global Accelerator Developer Guide.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Remove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value. - * The operation succeeds even if you attempt to remove tags from an accelerator that was already removed.

- *

For more information, see Tagging - * in Global Accelerator in the Global Accelerator Developer Guide.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update an accelerator.

- * - * - *

Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the - * US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 - * on AWS CLI commands.

- *
+ * @see {@link UpdateAcceleratorCommand} */ - public updateAccelerator( + updateAccelerator( args: UpdateAcceleratorCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAccelerator( + updateAccelerator( args: UpdateAcceleratorCommandInput, cb: (err: any, data?: UpdateAcceleratorCommandOutput) => void ): void; - public updateAccelerator( + updateAccelerator( args: UpdateAcceleratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAcceleratorCommandOutput) => void ): void; - public updateAccelerator( - args: UpdateAcceleratorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAcceleratorCommandOutput) => void), - cb?: (err: any, data?: UpdateAcceleratorCommandOutput) => void - ): Promise | void { - const command = new UpdateAcceleratorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update the attributes for an accelerator.

+ * @see {@link UpdateAcceleratorAttributesCommand} */ - public updateAcceleratorAttributes( + updateAcceleratorAttributes( args: UpdateAcceleratorAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAcceleratorAttributes( + updateAcceleratorAttributes( args: UpdateAcceleratorAttributesCommandInput, cb: (err: any, data?: UpdateAcceleratorAttributesCommandOutput) => void ): void; - public updateAcceleratorAttributes( + updateAcceleratorAttributes( args: UpdateAcceleratorAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAcceleratorAttributesCommandOutput) => void ): void; - public updateAcceleratorAttributes( - args: UpdateAcceleratorAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAcceleratorAttributesCommandOutput) => void), - cb?: (err: any, data?: UpdateAcceleratorAttributesCommandOutput) => void - ): Promise | void { - const command = new UpdateAcceleratorAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update a custom routing accelerator.

+ * @see {@link UpdateCustomRoutingAcceleratorCommand} */ - public updateCustomRoutingAccelerator( + updateCustomRoutingAccelerator( args: UpdateCustomRoutingAcceleratorCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCustomRoutingAccelerator( + updateCustomRoutingAccelerator( args: UpdateCustomRoutingAcceleratorCommandInput, cb: (err: any, data?: UpdateCustomRoutingAcceleratorCommandOutput) => void ): void; - public updateCustomRoutingAccelerator( + updateCustomRoutingAccelerator( args: UpdateCustomRoutingAcceleratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCustomRoutingAcceleratorCommandOutput) => void ): void; - public updateCustomRoutingAccelerator( - args: UpdateCustomRoutingAcceleratorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCustomRoutingAcceleratorCommandOutput) => void), - cb?: (err: any, data?: UpdateCustomRoutingAcceleratorCommandOutput) => void - ): Promise | void { - const command = new UpdateCustomRoutingAcceleratorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update the attributes for a custom routing accelerator.

+ * @see {@link UpdateCustomRoutingAcceleratorAttributesCommand} */ - public updateCustomRoutingAcceleratorAttributes( + updateCustomRoutingAcceleratorAttributes( args: UpdateCustomRoutingAcceleratorAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCustomRoutingAcceleratorAttributes( + updateCustomRoutingAcceleratorAttributes( args: UpdateCustomRoutingAcceleratorAttributesCommandInput, cb: (err: any, data?: UpdateCustomRoutingAcceleratorAttributesCommandOutput) => void ): void; - public updateCustomRoutingAcceleratorAttributes( + updateCustomRoutingAcceleratorAttributes( args: UpdateCustomRoutingAcceleratorAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCustomRoutingAcceleratorAttributesCommandOutput) => void ): void; - public updateCustomRoutingAcceleratorAttributes( - args: UpdateCustomRoutingAcceleratorAttributesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateCustomRoutingAcceleratorAttributesCommandOutput) => void), - cb?: (err: any, data?: UpdateCustomRoutingAcceleratorAttributesCommandOutput) => void - ): Promise | void { - const command = new UpdateCustomRoutingAcceleratorAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update a listener for a custom routing accelerator.

+ * @see {@link UpdateCustomRoutingListenerCommand} */ - public updateCustomRoutingListener( + updateCustomRoutingListener( args: UpdateCustomRoutingListenerCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCustomRoutingListener( + updateCustomRoutingListener( args: UpdateCustomRoutingListenerCommandInput, cb: (err: any, data?: UpdateCustomRoutingListenerCommandOutput) => void ): void; - public updateCustomRoutingListener( + updateCustomRoutingListener( args: UpdateCustomRoutingListenerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCustomRoutingListenerCommandOutput) => void ): void; - public updateCustomRoutingListener( - args: UpdateCustomRoutingListenerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCustomRoutingListenerCommandOutput) => void), - cb?: (err: any, data?: UpdateCustomRoutingListenerCommandOutput) => void - ): Promise | void { - const command = new UpdateCustomRoutingListenerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update an endpoint group. A resource must be valid and active when you add it as an endpoint.

+ * @see {@link UpdateEndpointGroupCommand} */ - public updateEndpointGroup( + updateEndpointGroup( args: UpdateEndpointGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEndpointGroup( + updateEndpointGroup( args: UpdateEndpointGroupCommandInput, cb: (err: any, data?: UpdateEndpointGroupCommandOutput) => void ): void; - public updateEndpointGroup( + updateEndpointGroup( args: UpdateEndpointGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEndpointGroupCommandOutput) => void ): void; - public updateEndpointGroup( - args: UpdateEndpointGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEndpointGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateEndpointGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateEndpointGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update a listener.

+ * @see {@link UpdateListenerCommand} */ - public updateListener( + updateListener( args: UpdateListenerCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateListener( - args: UpdateListenerCommandInput, - cb: (err: any, data?: UpdateListenerCommandOutput) => void - ): void; - public updateListener( + updateListener(args: UpdateListenerCommandInput, cb: (err: any, data?: UpdateListenerCommandOutput) => void): void; + updateListener( args: UpdateListenerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateListenerCommandOutput) => void ): void; - public updateListener( - args: UpdateListenerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateListenerCommandOutput) => void), - cb?: (err: any, data?: UpdateListenerCommandOutput) => void - ): Promise | void { - const command = new UpdateListenerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops advertising an address range that is provisioned as an address pool. - * You can perform this operation at most once every 10 seconds, even if you specify different address - * ranges each time.

- *

It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of - * propagation delays.

- *

For more information, see Bring your own - * IP addresses (BYOIP) in the Global Accelerator Developer Guide.

+ * @see {@link WithdrawByoipCidrCommand} */ - public withdrawByoipCidr( + withdrawByoipCidr( args: WithdrawByoipCidrCommandInput, options?: __HttpHandlerOptions ): Promise; - public withdrawByoipCidr( + withdrawByoipCidr( args: WithdrawByoipCidrCommandInput, cb: (err: any, data?: WithdrawByoipCidrCommandOutput) => void ): void; - public withdrawByoipCidr( + withdrawByoipCidr( args: WithdrawByoipCidrCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: WithdrawByoipCidrCommandOutput) => void ): void; - public withdrawByoipCidr( - args: WithdrawByoipCidrCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: WithdrawByoipCidrCommandOutput) => void), - cb?: (err: any, data?: WithdrawByoipCidrCommandOutput) => void - ): Promise | void { - const command = new WithdrawByoipCidrCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Global Accelerator + *

This is the Global Accelerator API Reference. This guide is for developers who need detailed information about + * Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the + * Global Accelerator Developer Guide.

+ *

Global Accelerator is a service in which you create accelerators to improve the performance + * of your applications for local and global users. Depending on the type of accelerator you choose, you can + * gain additional benefits.

+ *
    + *
  • + *

    By using a standard accelerator, you can improve availability of your internet applications + * that are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the Amazon Web Services + * global network.

    + *
  • + *
  • + *

    For other scenarios, you might choose a custom routing accelerator. With a custom routing accelerator, you + * can use application logic to directly map one or more users to a specific endpoint among many endpoints.

    + *
  • + *
+ * + *

Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the + * US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 + * on AWS CLI commands.

+ *
+ * + * + *

By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses + * are anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack, + * Global Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses. + * With a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure + * these entry points to be IPv4 addresses from your own IP address ranges that you bring toGlobal Accelerator (BYOIP).

+ * + * + *

For a standard accelerator, + * they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases + * the availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers, + * Amazon EC2 instances, or Elastic IP addresses that are located in one Amazon Web Services Region or multiple Amazon Web Services Regions. For custom routing + * accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that + * are virtual private cloud (VPC) subnets.

+ * + * + *

The static IP addresses remain assigned to your accelerator for as long as it exists, even if you + * disable the accelerator and it no longer accepts or routes traffic. However, when you + * delete an accelerator, you lose the static IP addresses that + * are assigned to it, so you can no longer route traffic by using them. You can use + * IAM policies like tag-based permissions with Global Accelerator to limit the users who have + * permissions to delete an accelerator. For more information, see Tag-based policies.

+ *
+ *

For standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based + * on health, client location, and policies that you configure. The service reacts instantly to + * changes in health or configuration to ensure that internet traffic from clients is always + * directed to healthy endpoints.

+ *

For more information about understanding and using Global Accelerator, see the + * Global Accelerator Developer Guide.

+ */ +export class GlobalAccelerator extends GlobalAcceleratorClient implements GlobalAccelerator {} +createAggregatedClient(commands, GlobalAccelerator); diff --git a/clients/client-glue/src/Glue.ts b/clients/client-glue/src/Glue.ts index 6937b560eea0..12b47f812521 100644 --- a/clients/client-glue/src/Glue.ts +++ b/clients/client-glue/src/Glue.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -883,6700 +884,3176 @@ import { UpdateWorkflowCommandInput, UpdateWorkflowCommandOutput, } from "./commands/UpdateWorkflowCommand"; -import { GlueClient } from "./GlueClient"; +import { GlueClient, GlueClientConfig } from "./GlueClient"; -/** - * @public - * Glue - *

Defines the public endpoint for the Glue service.

- */ -export class Glue extends GlueClient { +const commands = { + BatchCreatePartitionCommand, + BatchDeleteConnectionCommand, + BatchDeletePartitionCommand, + BatchDeleteTableCommand, + BatchDeleteTableVersionCommand, + BatchGetBlueprintsCommand, + BatchGetCrawlersCommand, + BatchGetCustomEntityTypesCommand, + BatchGetDataQualityResultCommand, + BatchGetDevEndpointsCommand, + BatchGetJobsCommand, + BatchGetPartitionCommand, + BatchGetTriggersCommand, + BatchGetWorkflowsCommand, + BatchStopJobRunCommand, + BatchUpdatePartitionCommand, + CancelDataQualityRuleRecommendationRunCommand, + CancelDataQualityRulesetEvaluationRunCommand, + CancelMLTaskRunCommand, + CancelStatementCommand, + CheckSchemaVersionValidityCommand, + CreateBlueprintCommand, + CreateClassifierCommand, + CreateConnectionCommand, + CreateCrawlerCommand, + CreateCustomEntityTypeCommand, + CreateDatabaseCommand, + CreateDataQualityRulesetCommand, + CreateDevEndpointCommand, + CreateJobCommand, + CreateMLTransformCommand, + CreatePartitionCommand, + CreatePartitionIndexCommand, + CreateRegistryCommand, + CreateSchemaCommand, + CreateScriptCommand, + CreateSecurityConfigurationCommand, + CreateSessionCommand, + CreateTableCommand, + CreateTriggerCommand, + CreateUserDefinedFunctionCommand, + CreateWorkflowCommand, + DeleteBlueprintCommand, + DeleteClassifierCommand, + DeleteColumnStatisticsForPartitionCommand, + DeleteColumnStatisticsForTableCommand, + DeleteConnectionCommand, + DeleteCrawlerCommand, + DeleteCustomEntityTypeCommand, + DeleteDatabaseCommand, + DeleteDataQualityRulesetCommand, + DeleteDevEndpointCommand, + DeleteJobCommand, + DeleteMLTransformCommand, + DeletePartitionCommand, + DeletePartitionIndexCommand, + DeleteRegistryCommand, + DeleteResourcePolicyCommand, + DeleteSchemaCommand, + DeleteSchemaVersionsCommand, + DeleteSecurityConfigurationCommand, + DeleteSessionCommand, + DeleteTableCommand, + DeleteTableVersionCommand, + DeleteTriggerCommand, + DeleteUserDefinedFunctionCommand, + DeleteWorkflowCommand, + GetBlueprintCommand, + GetBlueprintRunCommand, + GetBlueprintRunsCommand, + GetCatalogImportStatusCommand, + GetClassifierCommand, + GetClassifiersCommand, + GetColumnStatisticsForPartitionCommand, + GetColumnStatisticsForTableCommand, + GetConnectionCommand, + GetConnectionsCommand, + GetCrawlerCommand, + GetCrawlerMetricsCommand, + GetCrawlersCommand, + GetCustomEntityTypeCommand, + GetDatabaseCommand, + GetDatabasesCommand, + GetDataCatalogEncryptionSettingsCommand, + GetDataflowGraphCommand, + GetDataQualityResultCommand, + GetDataQualityRuleRecommendationRunCommand, + GetDataQualityRulesetCommand, + GetDataQualityRulesetEvaluationRunCommand, + GetDevEndpointCommand, + GetDevEndpointsCommand, + GetJobCommand, + GetJobBookmarkCommand, + GetJobRunCommand, + GetJobRunsCommand, + GetJobsCommand, + GetMappingCommand, + GetMLTaskRunCommand, + GetMLTaskRunsCommand, + GetMLTransformCommand, + GetMLTransformsCommand, + GetPartitionCommand, + GetPartitionIndexesCommand, + GetPartitionsCommand, + GetPlanCommand, + GetRegistryCommand, + GetResourcePoliciesCommand, + GetResourcePolicyCommand, + GetSchemaCommand, + GetSchemaByDefinitionCommand, + GetSchemaVersionCommand, + GetSchemaVersionsDiffCommand, + GetSecurityConfigurationCommand, + GetSecurityConfigurationsCommand, + GetSessionCommand, + GetStatementCommand, + GetTableCommand, + GetTablesCommand, + GetTableVersionCommand, + GetTableVersionsCommand, + GetTagsCommand, + GetTriggerCommand, + GetTriggersCommand, + GetUnfilteredPartitionMetadataCommand, + GetUnfilteredPartitionsMetadataCommand, + GetUnfilteredTableMetadataCommand, + GetUserDefinedFunctionCommand, + GetUserDefinedFunctionsCommand, + GetWorkflowCommand, + GetWorkflowRunCommand, + GetWorkflowRunPropertiesCommand, + GetWorkflowRunsCommand, + ImportCatalogToGlueCommand, + ListBlueprintsCommand, + ListCrawlersCommand, + ListCrawlsCommand, + ListCustomEntityTypesCommand, + ListDataQualityResultsCommand, + ListDataQualityRuleRecommendationRunsCommand, + ListDataQualityRulesetEvaluationRunsCommand, + ListDataQualityRulesetsCommand, + ListDevEndpointsCommand, + ListJobsCommand, + ListMLTransformsCommand, + ListRegistriesCommand, + ListSchemasCommand, + ListSchemaVersionsCommand, + ListSessionsCommand, + ListStatementsCommand, + ListTriggersCommand, + ListWorkflowsCommand, + PutDataCatalogEncryptionSettingsCommand, + PutResourcePolicyCommand, + PutSchemaVersionMetadataCommand, + PutWorkflowRunPropertiesCommand, + QuerySchemaVersionMetadataCommand, + RegisterSchemaVersionCommand, + RemoveSchemaVersionMetadataCommand, + ResetJobBookmarkCommand, + ResumeWorkflowRunCommand, + RunStatementCommand, + SearchTablesCommand, + StartBlueprintRunCommand, + StartCrawlerCommand, + StartCrawlerScheduleCommand, + StartDataQualityRuleRecommendationRunCommand, + StartDataQualityRulesetEvaluationRunCommand, + StartExportLabelsTaskRunCommand, + StartImportLabelsTaskRunCommand, + StartJobRunCommand, + StartMLEvaluationTaskRunCommand, + StartMLLabelingSetGenerationTaskRunCommand, + StartTriggerCommand, + StartWorkflowRunCommand, + StopCrawlerCommand, + StopCrawlerScheduleCommand, + StopSessionCommand, + StopTriggerCommand, + StopWorkflowRunCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateBlueprintCommand, + UpdateClassifierCommand, + UpdateColumnStatisticsForPartitionCommand, + UpdateColumnStatisticsForTableCommand, + UpdateConnectionCommand, + UpdateCrawlerCommand, + UpdateCrawlerScheduleCommand, + UpdateDatabaseCommand, + UpdateDataQualityRulesetCommand, + UpdateDevEndpointCommand, + UpdateJobCommand, + UpdateJobFromSourceControlCommand, + UpdateMLTransformCommand, + UpdatePartitionCommand, + UpdateRegistryCommand, + UpdateSchemaCommand, + UpdateSourceControlFromJobCommand, + UpdateTableCommand, + UpdateTriggerCommand, + UpdateUserDefinedFunctionCommand, + UpdateWorkflowCommand, +}; + +export interface Glue { /** - * @public - *

Creates one or more partitions in a batch operation.

+ * @see {@link BatchCreatePartitionCommand} */ - public batchCreatePartition( + batchCreatePartition( args: BatchCreatePartitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchCreatePartition( + batchCreatePartition( args: BatchCreatePartitionCommandInput, cb: (err: any, data?: BatchCreatePartitionCommandOutput) => void ): void; - public batchCreatePartition( + batchCreatePartition( args: BatchCreatePartitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCreatePartitionCommandOutput) => void ): void; - public batchCreatePartition( - args: BatchCreatePartitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchCreatePartitionCommandOutput) => void), - cb?: (err: any, data?: BatchCreatePartitionCommandOutput) => void - ): Promise | void { - const command = new BatchCreatePartitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a list of connection definitions from the Data Catalog.

- */ - public batchDeleteConnection( + + /** + * @see {@link BatchDeleteConnectionCommand} + */ + batchDeleteConnection( args: BatchDeleteConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeleteConnection( + batchDeleteConnection( args: BatchDeleteConnectionCommandInput, cb: (err: any, data?: BatchDeleteConnectionCommandOutput) => void ): void; - public batchDeleteConnection( + batchDeleteConnection( args: BatchDeleteConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteConnectionCommandOutput) => void ): void; - public batchDeleteConnection( - args: BatchDeleteConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeleteConnectionCommandOutput) => void), - cb?: (err: any, data?: BatchDeleteConnectionCommandOutput) => void - ): Promise | void { - const command = new BatchDeleteConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes one or more partitions in a batch operation.

- */ - public batchDeletePartition( + + /** + * @see {@link BatchDeletePartitionCommand} + */ + batchDeletePartition( args: BatchDeletePartitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeletePartition( + batchDeletePartition( args: BatchDeletePartitionCommandInput, cb: (err: any, data?: BatchDeletePartitionCommandOutput) => void ): void; - public batchDeletePartition( + batchDeletePartition( args: BatchDeletePartitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeletePartitionCommandOutput) => void ): void; - public batchDeletePartition( - args: BatchDeletePartitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeletePartitionCommandOutput) => void), - cb?: (err: any, data?: BatchDeletePartitionCommandOutput) => void - ): Promise | void { - const command = new BatchDeletePartitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes multiple tables at once.

- * - *

After completing this operation, you no longer have access to the table versions and - * partitions that belong to the deleted table. Glue deletes these "orphaned" resources - * asynchronously in a timely manner, at the discretion of the service.

- *

To ensure the immediate deletion of all related resources, before calling - * BatchDeleteTable, use DeleteTableVersion or - * BatchDeleteTableVersion, and DeletePartition or - * BatchDeletePartition, to delete any resources that belong to the - * table.

- *
- */ - public batchDeleteTable( + + /** + * @see {@link BatchDeleteTableCommand} + */ + batchDeleteTable( args: BatchDeleteTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeleteTable( + batchDeleteTable( args: BatchDeleteTableCommandInput, cb: (err: any, data?: BatchDeleteTableCommandOutput) => void ): void; - public batchDeleteTable( + batchDeleteTable( args: BatchDeleteTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteTableCommandOutput) => void ): void; - public batchDeleteTable( - args: BatchDeleteTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeleteTableCommandOutput) => void), - cb?: (err: any, data?: BatchDeleteTableCommandOutput) => void - ): Promise | void { - const command = new BatchDeleteTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specified batch of versions of a table.

- */ - public batchDeleteTableVersion( + + /** + * @see {@link BatchDeleteTableVersionCommand} + */ + batchDeleteTableVersion( args: BatchDeleteTableVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeleteTableVersion( + batchDeleteTableVersion( args: BatchDeleteTableVersionCommandInput, cb: (err: any, data?: BatchDeleteTableVersionCommandOutput) => void ): void; - public batchDeleteTableVersion( + batchDeleteTableVersion( args: BatchDeleteTableVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteTableVersionCommandOutput) => void ): void; - public batchDeleteTableVersion( - args: BatchDeleteTableVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeleteTableVersionCommandOutput) => void), - cb?: (err: any, data?: BatchDeleteTableVersionCommandOutput) => void - ): Promise | void { - const command = new BatchDeleteTableVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about a list of blueprints.

- */ - public batchGetBlueprints( + + /** + * @see {@link BatchGetBlueprintsCommand} + */ + batchGetBlueprints( args: BatchGetBlueprintsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetBlueprints( + batchGetBlueprints( args: BatchGetBlueprintsCommandInput, cb: (err: any, data?: BatchGetBlueprintsCommandOutput) => void ): void; - public batchGetBlueprints( + batchGetBlueprints( args: BatchGetBlueprintsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetBlueprintsCommandOutput) => void ): void; - public batchGetBlueprints( - args: BatchGetBlueprintsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetBlueprintsCommandOutput) => void), - cb?: (err: any, data?: BatchGetBlueprintsCommandOutput) => void - ): Promise | void { - const command = new BatchGetBlueprintsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of resource metadata for a given list of crawler names. After calling the ListCrawlers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.

- */ - public batchGetCrawlers( + + /** + * @see {@link BatchGetCrawlersCommand} + */ + batchGetCrawlers( args: BatchGetCrawlersCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetCrawlers( + batchGetCrawlers( args: BatchGetCrawlersCommandInput, cb: (err: any, data?: BatchGetCrawlersCommandOutput) => void ): void; - public batchGetCrawlers( + batchGetCrawlers( args: BatchGetCrawlersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetCrawlersCommandOutput) => void ): void; - public batchGetCrawlers( - args: BatchGetCrawlersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetCrawlersCommandOutput) => void), - cb?: (err: any, data?: BatchGetCrawlersCommandOutput) => void - ): Promise | void { - const command = new BatchGetCrawlersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the details for the custom patterns specified by a list of names.

- */ - public batchGetCustomEntityTypes( + + /** + * @see {@link BatchGetCustomEntityTypesCommand} + */ + batchGetCustomEntityTypes( args: BatchGetCustomEntityTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetCustomEntityTypes( + batchGetCustomEntityTypes( args: BatchGetCustomEntityTypesCommandInput, cb: (err: any, data?: BatchGetCustomEntityTypesCommandOutput) => void ): void; - public batchGetCustomEntityTypes( + batchGetCustomEntityTypes( args: BatchGetCustomEntityTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetCustomEntityTypesCommandOutput) => void ): void; - public batchGetCustomEntityTypes( - args: BatchGetCustomEntityTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetCustomEntityTypesCommandOutput) => void), - cb?: (err: any, data?: BatchGetCustomEntityTypesCommandOutput) => void - ): Promise | void { - const command = new BatchGetCustomEntityTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of data quality results for the specified result IDs.

- */ - public batchGetDataQualityResult( + + /** + * @see {@link BatchGetDataQualityResultCommand} + */ + batchGetDataQualityResult( args: BatchGetDataQualityResultCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetDataQualityResult( + batchGetDataQualityResult( args: BatchGetDataQualityResultCommandInput, cb: (err: any, data?: BatchGetDataQualityResultCommandOutput) => void ): void; - public batchGetDataQualityResult( + batchGetDataQualityResult( args: BatchGetDataQualityResultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetDataQualityResultCommandOutput) => void ): void; - public batchGetDataQualityResult( - args: BatchGetDataQualityResultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetDataQualityResultCommandOutput) => void), - cb?: (err: any, data?: BatchGetDataQualityResultCommandOutput) => void - ): Promise | void { - const command = new BatchGetDataQualityResultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of resource metadata for a given list of development endpoint names. After - * calling the ListDevEndpoints operation, you can call this operation to access the - * data to which you have been granted permissions. This operation supports all IAM permissions, - * including permission conditions that uses tags.

- */ - public batchGetDevEndpoints( + + /** + * @see {@link BatchGetDevEndpointsCommand} + */ + batchGetDevEndpoints( args: BatchGetDevEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetDevEndpoints( + batchGetDevEndpoints( args: BatchGetDevEndpointsCommandInput, cb: (err: any, data?: BatchGetDevEndpointsCommandOutput) => void ): void; - public batchGetDevEndpoints( + batchGetDevEndpoints( args: BatchGetDevEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetDevEndpointsCommandOutput) => void ): void; - public batchGetDevEndpoints( - args: BatchGetDevEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetDevEndpointsCommandOutput) => void), - cb?: (err: any, data?: BatchGetDevEndpointsCommandOutput) => void - ): Promise | void { - const command = new BatchGetDevEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of resource metadata for a given list of job names. After calling the ListJobs operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags. - *

- */ - public batchGetJobs( - args: BatchGetJobsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public batchGetJobs(args: BatchGetJobsCommandInput, cb: (err: any, data?: BatchGetJobsCommandOutput) => void): void; - public batchGetJobs( + + /** + * @see {@link BatchGetJobsCommand} + */ + batchGetJobs(args: BatchGetJobsCommandInput, options?: __HttpHandlerOptions): Promise; + batchGetJobs(args: BatchGetJobsCommandInput, cb: (err: any, data?: BatchGetJobsCommandOutput) => void): void; + batchGetJobs( args: BatchGetJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetJobsCommandOutput) => void ): void; - public batchGetJobs( - args: BatchGetJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetJobsCommandOutput) => void), - cb?: (err: any, data?: BatchGetJobsCommandOutput) => void - ): Promise | void { - const command = new BatchGetJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves partitions in a batch request.

- */ - public batchGetPartition( + + /** + * @see {@link BatchGetPartitionCommand} + */ + batchGetPartition( args: BatchGetPartitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetPartition( + batchGetPartition( args: BatchGetPartitionCommandInput, cb: (err: any, data?: BatchGetPartitionCommandOutput) => void ): void; - public batchGetPartition( + batchGetPartition( args: BatchGetPartitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetPartitionCommandOutput) => void ): void; - public batchGetPartition( - args: BatchGetPartitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetPartitionCommandOutput) => void), - cb?: (err: any, data?: BatchGetPartitionCommandOutput) => void - ): Promise | void { - const command = new BatchGetPartitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of resource metadata for a given list of trigger names. After calling the ListTriggers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.

- */ - public batchGetTriggers( + + /** + * @see {@link BatchGetTriggersCommand} + */ + batchGetTriggers( args: BatchGetTriggersCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetTriggers( + batchGetTriggers( args: BatchGetTriggersCommandInput, cb: (err: any, data?: BatchGetTriggersCommandOutput) => void ): void; - public batchGetTriggers( + batchGetTriggers( args: BatchGetTriggersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetTriggersCommandOutput) => void ): void; - public batchGetTriggers( - args: BatchGetTriggersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetTriggersCommandOutput) => void), - cb?: (err: any, data?: BatchGetTriggersCommandOutput) => void - ): Promise | void { - const command = new BatchGetTriggersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of resource metadata for a given list of workflow names. After calling the ListWorkflows operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.

- */ - public batchGetWorkflows( + + /** + * @see {@link BatchGetWorkflowsCommand} + */ + batchGetWorkflows( args: BatchGetWorkflowsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetWorkflows( + batchGetWorkflows( args: BatchGetWorkflowsCommandInput, cb: (err: any, data?: BatchGetWorkflowsCommandOutput) => void ): void; - public batchGetWorkflows( + batchGetWorkflows( args: BatchGetWorkflowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetWorkflowsCommandOutput) => void ): void; - public batchGetWorkflows( - args: BatchGetWorkflowsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetWorkflowsCommandOutput) => void), - cb?: (err: any, data?: BatchGetWorkflowsCommandOutput) => void - ): Promise | void { - const command = new BatchGetWorkflowsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops one or more job runs for a specified job definition.

- */ - public batchStopJobRun( + + /** + * @see {@link BatchStopJobRunCommand} + */ + batchStopJobRun( args: BatchStopJobRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchStopJobRun( - args: BatchStopJobRunCommandInput, - cb: (err: any, data?: BatchStopJobRunCommandOutput) => void - ): void; - public batchStopJobRun( + batchStopJobRun(args: BatchStopJobRunCommandInput, cb: (err: any, data?: BatchStopJobRunCommandOutput) => void): void; + batchStopJobRun( args: BatchStopJobRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchStopJobRunCommandOutput) => void ): void; - public batchStopJobRun( - args: BatchStopJobRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchStopJobRunCommandOutput) => void), - cb?: (err: any, data?: BatchStopJobRunCommandOutput) => void - ): Promise | void { - const command = new BatchStopJobRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates one or more partitions in a batch operation.

- */ - public batchUpdatePartition( + + /** + * @see {@link BatchUpdatePartitionCommand} + */ + batchUpdatePartition( args: BatchUpdatePartitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchUpdatePartition( + batchUpdatePartition( args: BatchUpdatePartitionCommandInput, cb: (err: any, data?: BatchUpdatePartitionCommandOutput) => void ): void; - public batchUpdatePartition( + batchUpdatePartition( args: BatchUpdatePartitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchUpdatePartitionCommandOutput) => void ): void; - public batchUpdatePartition( - args: BatchUpdatePartitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchUpdatePartitionCommandOutput) => void), - cb?: (err: any, data?: BatchUpdatePartitionCommandOutput) => void - ): Promise | void { - const command = new BatchUpdatePartitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels the specified recommendation run that was being used to generate rules.

- */ - public cancelDataQualityRuleRecommendationRun( + + /** + * @see {@link CancelDataQualityRuleRecommendationRunCommand} + */ + cancelDataQualityRuleRecommendationRun( args: CancelDataQualityRuleRecommendationRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelDataQualityRuleRecommendationRun( + cancelDataQualityRuleRecommendationRun( args: CancelDataQualityRuleRecommendationRunCommandInput, cb: (err: any, data?: CancelDataQualityRuleRecommendationRunCommandOutput) => void ): void; - public cancelDataQualityRuleRecommendationRun( + cancelDataQualityRuleRecommendationRun( args: CancelDataQualityRuleRecommendationRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelDataQualityRuleRecommendationRunCommandOutput) => void ): void; - public cancelDataQualityRuleRecommendationRun( - args: CancelDataQualityRuleRecommendationRunCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CancelDataQualityRuleRecommendationRunCommandOutput) => void), - cb?: (err: any, data?: CancelDataQualityRuleRecommendationRunCommandOutput) => void - ): Promise | void { - const command = new CancelDataQualityRuleRecommendationRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels a run where a ruleset is being evaluated against a data source.

- */ - public cancelDataQualityRulesetEvaluationRun( + + /** + * @see {@link CancelDataQualityRulesetEvaluationRunCommand} + */ + cancelDataQualityRulesetEvaluationRun( args: CancelDataQualityRulesetEvaluationRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelDataQualityRulesetEvaluationRun( + cancelDataQualityRulesetEvaluationRun( args: CancelDataQualityRulesetEvaluationRunCommandInput, cb: (err: any, data?: CancelDataQualityRulesetEvaluationRunCommandOutput) => void ): void; - public cancelDataQualityRulesetEvaluationRun( + cancelDataQualityRulesetEvaluationRun( args: CancelDataQualityRulesetEvaluationRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelDataQualityRulesetEvaluationRunCommandOutput) => void ): void; - public cancelDataQualityRulesetEvaluationRun( - args: CancelDataQualityRulesetEvaluationRunCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CancelDataQualityRulesetEvaluationRunCommandOutput) => void), - cb?: (err: any, data?: CancelDataQualityRulesetEvaluationRunCommandOutput) => void - ): Promise | void { - const command = new CancelDataQualityRulesetEvaluationRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels (stops) a task run. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can cancel a - * machine learning task run at any time by calling CancelMLTaskRun with a task - * run's parent transform's TransformID and the task run's TaskRunId.

- */ - public cancelMLTaskRun( + + /** + * @see {@link CancelMLTaskRunCommand} + */ + cancelMLTaskRun( args: CancelMLTaskRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelMLTaskRun( - args: CancelMLTaskRunCommandInput, - cb: (err: any, data?: CancelMLTaskRunCommandOutput) => void - ): void; - public cancelMLTaskRun( + cancelMLTaskRun(args: CancelMLTaskRunCommandInput, cb: (err: any, data?: CancelMLTaskRunCommandOutput) => void): void; + cancelMLTaskRun( args: CancelMLTaskRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelMLTaskRunCommandOutput) => void ): void; - public cancelMLTaskRun( - args: CancelMLTaskRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelMLTaskRunCommandOutput) => void), - cb?: (err: any, data?: CancelMLTaskRunCommandOutput) => void - ): Promise | void { - const command = new CancelMLTaskRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels the statement.

- */ - public cancelStatement( + + /** + * @see {@link CancelStatementCommand} + */ + cancelStatement( args: CancelStatementCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelStatement( - args: CancelStatementCommandInput, - cb: (err: any, data?: CancelStatementCommandOutput) => void - ): void; - public cancelStatement( + cancelStatement(args: CancelStatementCommandInput, cb: (err: any, data?: CancelStatementCommandOutput) => void): void; + cancelStatement( args: CancelStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelStatementCommandOutput) => void ): void; - public cancelStatement( - args: CancelStatementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelStatementCommandOutput) => void), - cb?: (err: any, data?: CancelStatementCommandOutput) => void - ): Promise | void { - const command = new CancelStatementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Validates the supplied schema. This call has no side effects, it simply validates using the supplied schema using DataFormat as the format. Since it does not take a schema set name, no compatibility checks are performed.

- */ - public checkSchemaVersionValidity( + + /** + * @see {@link CheckSchemaVersionValidityCommand} + */ + checkSchemaVersionValidity( args: CheckSchemaVersionValidityCommandInput, options?: __HttpHandlerOptions ): Promise; - public checkSchemaVersionValidity( + checkSchemaVersionValidity( args: CheckSchemaVersionValidityCommandInput, cb: (err: any, data?: CheckSchemaVersionValidityCommandOutput) => void ): void; - public checkSchemaVersionValidity( + checkSchemaVersionValidity( args: CheckSchemaVersionValidityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CheckSchemaVersionValidityCommandOutput) => void ): void; - public checkSchemaVersionValidity( - args: CheckSchemaVersionValidityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CheckSchemaVersionValidityCommandOutput) => void), - cb?: (err: any, data?: CheckSchemaVersionValidityCommandOutput) => void - ): Promise | void { - const command = new CheckSchemaVersionValidityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers a blueprint with Glue.

- */ - public createBlueprint( + + /** + * @see {@link CreateBlueprintCommand} + */ + createBlueprint( args: CreateBlueprintCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBlueprint( - args: CreateBlueprintCommandInput, - cb: (err: any, data?: CreateBlueprintCommandOutput) => void - ): void; - public createBlueprint( + createBlueprint(args: CreateBlueprintCommandInput, cb: (err: any, data?: CreateBlueprintCommandOutput) => void): void; + createBlueprint( args: CreateBlueprintCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBlueprintCommandOutput) => void ): void; - public createBlueprint( - args: CreateBlueprintCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBlueprintCommandOutput) => void), - cb?: (err: any, data?: CreateBlueprintCommandOutput) => void - ): Promise | void { - const command = new CreateBlueprintCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a classifier in the user's account. This can be a GrokClassifier, an - * XMLClassifier, a JsonClassifier, or a CsvClassifier, - * depending on which field of the request is present.

- */ - public createClassifier( + + /** + * @see {@link CreateClassifierCommand} + */ + createClassifier( args: CreateClassifierCommandInput, options?: __HttpHandlerOptions ): Promise; - public createClassifier( + createClassifier( args: CreateClassifierCommandInput, cb: (err: any, data?: CreateClassifierCommandOutput) => void ): void; - public createClassifier( + createClassifier( args: CreateClassifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClassifierCommandOutput) => void ): void; - public createClassifier( - args: CreateClassifierCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateClassifierCommandOutput) => void), - cb?: (err: any, data?: CreateClassifierCommandOutput) => void - ): Promise | void { - const command = new CreateClassifierCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a connection definition in the Data Catalog.

- */ - public createConnection( + + /** + * @see {@link CreateConnectionCommand} + */ + createConnection( args: CreateConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConnection( + createConnection( args: CreateConnectionCommandInput, cb: (err: any, data?: CreateConnectionCommandOutput) => void ): void; - public createConnection( + createConnection( args: CreateConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectionCommandOutput) => void ): void; - public createConnection( - args: CreateConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConnectionCommandOutput) => void), - cb?: (err: any, data?: CreateConnectionCommandOutput) => void - ): Promise | void { - const command = new CreateConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new crawler with specified targets, role, configuration, and optional schedule. - * At least one crawl target must be specified, in the s3Targets field, the - * jdbcTargets field, or the DynamoDBTargets field.

- */ - public createCrawler( - args: CreateCrawlerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createCrawler( - args: CreateCrawlerCommandInput, - cb: (err: any, data?: CreateCrawlerCommandOutput) => void - ): void; - public createCrawler( + + /** + * @see {@link CreateCrawlerCommand} + */ + createCrawler(args: CreateCrawlerCommandInput, options?: __HttpHandlerOptions): Promise; + createCrawler(args: CreateCrawlerCommandInput, cb: (err: any, data?: CreateCrawlerCommandOutput) => void): void; + createCrawler( args: CreateCrawlerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCrawlerCommandOutput) => void ): void; - public createCrawler( - args: CreateCrawlerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCrawlerCommandOutput) => void), - cb?: (err: any, data?: CreateCrawlerCommandOutput) => void - ): Promise | void { - const command = new CreateCrawlerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.

- *

Each custom pattern you create specifies a regular expression and an optional list of context words. If no context words are passed only a regular expression is checked.

- */ - public createCustomEntityType( + + /** + * @see {@link CreateCustomEntityTypeCommand} + */ + createCustomEntityType( args: CreateCustomEntityTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCustomEntityType( + createCustomEntityType( args: CreateCustomEntityTypeCommandInput, cb: (err: any, data?: CreateCustomEntityTypeCommandOutput) => void ): void; - public createCustomEntityType( + createCustomEntityType( args: CreateCustomEntityTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomEntityTypeCommandOutput) => void ): void; - public createCustomEntityType( - args: CreateCustomEntityTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCustomEntityTypeCommandOutput) => void), - cb?: (err: any, data?: CreateCustomEntityTypeCommandOutput) => void - ): Promise | void { - const command = new CreateCustomEntityTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new database in a Data Catalog.

- */ - public createDatabase( + + /** + * @see {@link CreateDatabaseCommand} + */ + createDatabase( args: CreateDatabaseCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDatabase( - args: CreateDatabaseCommandInput, - cb: (err: any, data?: CreateDatabaseCommandOutput) => void - ): void; - public createDatabase( + createDatabase(args: CreateDatabaseCommandInput, cb: (err: any, data?: CreateDatabaseCommandOutput) => void): void; + createDatabase( args: CreateDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatabaseCommandOutput) => void ): void; - public createDatabase( - args: CreateDatabaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDatabaseCommandOutput) => void), - cb?: (err: any, data?: CreateDatabaseCommandOutput) => void - ): Promise | void { - const command = new CreateDatabaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a data quality ruleset with DQDL rules applied to a specified Glue table.

- *

You create the ruleset using the Data Quality Definition Language (DQDL). For more information, see the Glue developer guide.

- */ - public createDataQualityRuleset( + + /** + * @see {@link CreateDataQualityRulesetCommand} + */ + createDataQualityRuleset( args: CreateDataQualityRulesetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDataQualityRuleset( + createDataQualityRuleset( args: CreateDataQualityRulesetCommandInput, cb: (err: any, data?: CreateDataQualityRulesetCommandOutput) => void ): void; - public createDataQualityRuleset( + createDataQualityRuleset( args: CreateDataQualityRulesetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataQualityRulesetCommandOutput) => void ): void; - public createDataQualityRuleset( - args: CreateDataQualityRulesetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDataQualityRulesetCommandOutput) => void), - cb?: (err: any, data?: CreateDataQualityRulesetCommandOutput) => void - ): Promise | void { - const command = new CreateDataQualityRulesetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new development endpoint.

- */ - public createDevEndpoint( + + /** + * @see {@link CreateDevEndpointCommand} + */ + createDevEndpoint( args: CreateDevEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDevEndpoint( + createDevEndpoint( args: CreateDevEndpointCommandInput, cb: (err: any, data?: CreateDevEndpointCommandOutput) => void ): void; - public createDevEndpoint( + createDevEndpoint( args: CreateDevEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDevEndpointCommandOutput) => void ): void; - public createDevEndpoint( - args: CreateDevEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDevEndpointCommandOutput) => void), - cb?: (err: any, data?: CreateDevEndpointCommandOutput) => void - ): Promise | void { - const command = new CreateDevEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new job definition.

- */ - public createJob(args: CreateJobCommandInput, options?: __HttpHandlerOptions): Promise; - public createJob(args: CreateJobCommandInput, cb: (err: any, data?: CreateJobCommandOutput) => void): void; - public createJob( + + /** + * @see {@link CreateJobCommand} + */ + createJob(args: CreateJobCommandInput, options?: __HttpHandlerOptions): Promise; + createJob(args: CreateJobCommandInput, cb: (err: any, data?: CreateJobCommandOutput) => void): void; + createJob( args: CreateJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateJobCommandOutput) => void ): void; - public createJob( - args: CreateJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateJobCommandOutput) => void), - cb?: (err: any, data?: CreateJobCommandOutput) => void - ): Promise | void { - const command = new CreateJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Glue machine learning transform. This operation creates the transform and - * all the necessary parameters to train it.

- *

Call this operation as the first step in the process of using a machine learning transform - * (such as the FindMatches transform) for deduplicating data. You can provide an - * optional Description, in addition to the parameters that you want to use for your - * algorithm.

- *

You must also specify certain parameters for the tasks that Glue runs on your - * behalf as part of learning from your data and creating a high-quality machine learning - * transform. These parameters include Role, and optionally, - * AllocatedCapacity, Timeout, and MaxRetries. For more - * information, see Jobs.

- */ - public createMLTransform( + + /** + * @see {@link CreateMLTransformCommand} + */ + createMLTransform( args: CreateMLTransformCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMLTransform( + createMLTransform( args: CreateMLTransformCommandInput, cb: (err: any, data?: CreateMLTransformCommandOutput) => void ): void; - public createMLTransform( + createMLTransform( args: CreateMLTransformCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMLTransformCommandOutput) => void ): void; - public createMLTransform( - args: CreateMLTransformCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMLTransformCommandOutput) => void), - cb?: (err: any, data?: CreateMLTransformCommandOutput) => void - ): Promise | void { - const command = new CreateMLTransformCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new partition.

- */ - public createPartition( + + /** + * @see {@link CreatePartitionCommand} + */ + createPartition( args: CreatePartitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPartition( - args: CreatePartitionCommandInput, - cb: (err: any, data?: CreatePartitionCommandOutput) => void - ): void; - public createPartition( + createPartition(args: CreatePartitionCommandInput, cb: (err: any, data?: CreatePartitionCommandOutput) => void): void; + createPartition( args: CreatePartitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePartitionCommandOutput) => void ): void; - public createPartition( - args: CreatePartitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePartitionCommandOutput) => void), - cb?: (err: any, data?: CreatePartitionCommandOutput) => void - ): Promise | void { - const command = new CreatePartitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a specified partition index in an existing table.

- */ - public createPartitionIndex( + + /** + * @see {@link CreatePartitionIndexCommand} + */ + createPartitionIndex( args: CreatePartitionIndexCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPartitionIndex( + createPartitionIndex( args: CreatePartitionIndexCommandInput, cb: (err: any, data?: CreatePartitionIndexCommandOutput) => void ): void; - public createPartitionIndex( + createPartitionIndex( args: CreatePartitionIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePartitionIndexCommandOutput) => void ): void; - public createPartitionIndex( - args: CreatePartitionIndexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePartitionIndexCommandOutput) => void), - cb?: (err: any, data?: CreatePartitionIndexCommandOutput) => void - ): Promise | void { - const command = new CreatePartitionIndexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new registry which may be used to hold a collection of schemas.

- */ - public createRegistry( + + /** + * @see {@link CreateRegistryCommand} + */ + createRegistry( args: CreateRegistryCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRegistry( - args: CreateRegistryCommandInput, - cb: (err: any, data?: CreateRegistryCommandOutput) => void - ): void; - public createRegistry( + createRegistry(args: CreateRegistryCommandInput, cb: (err: any, data?: CreateRegistryCommandOutput) => void): void; + createRegistry( args: CreateRegistryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRegistryCommandOutput) => void ): void; - public createRegistry( - args: CreateRegistryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRegistryCommandOutput) => void), - cb?: (err: any, data?: CreateRegistryCommandOutput) => void - ): Promise | void { - const command = new CreateRegistryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new schema set and registers the schema definition. Returns an error if the schema set already exists without actually registering the version.

- *

When the schema set is created, a version checkpoint will be set to the first version. Compatibility mode "DISABLED" restricts any additional schema versions from being added after the first schema version. For all other compatibility modes, validation of compatibility settings will be applied only from the second version onwards when the RegisterSchemaVersion API is used.

- *

When this API is called without a RegistryId, this will create an entry for a "default-registry" in the registry database tables, if it is not already present.

- */ - public createSchema( - args: CreateSchemaCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createSchema(args: CreateSchemaCommandInput, cb: (err: any, data?: CreateSchemaCommandOutput) => void): void; - public createSchema( + + /** + * @see {@link CreateSchemaCommand} + */ + createSchema(args: CreateSchemaCommandInput, options?: __HttpHandlerOptions): Promise; + createSchema(args: CreateSchemaCommandInput, cb: (err: any, data?: CreateSchemaCommandOutput) => void): void; + createSchema( args: CreateSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSchemaCommandOutput) => void ): void; - public createSchema( - args: CreateSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSchemaCommandOutput) => void), - cb?: (err: any, data?: CreateSchemaCommandOutput) => void - ): Promise | void { - const command = new CreateSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Transforms a directed acyclic graph (DAG) into code.

- */ - public createScript( - args: CreateScriptCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createScript(args: CreateScriptCommandInput, cb: (err: any, data?: CreateScriptCommandOutput) => void): void; - public createScript( + + /** + * @see {@link CreateScriptCommand} + */ + createScript(args: CreateScriptCommandInput, options?: __HttpHandlerOptions): Promise; + createScript(args: CreateScriptCommandInput, cb: (err: any, data?: CreateScriptCommandOutput) => void): void; + createScript( args: CreateScriptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateScriptCommandOutput) => void ): void; - public createScript( - args: CreateScriptCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateScriptCommandOutput) => void), - cb?: (err: any, data?: CreateScriptCommandOutput) => void - ): Promise | void { - const command = new CreateScriptCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new security configuration. A security configuration is a set of security properties that can be used by Glue. You can use a security configuration to encrypt data at rest. For information about using security configurations in Glue, see Encrypting Data Written by Crawlers, Jobs, and Development Endpoints.

- */ - public createSecurityConfiguration( + + /** + * @see {@link CreateSecurityConfigurationCommand} + */ + createSecurityConfiguration( args: CreateSecurityConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSecurityConfiguration( + createSecurityConfiguration( args: CreateSecurityConfigurationCommandInput, cb: (err: any, data?: CreateSecurityConfigurationCommandOutput) => void ): void; - public createSecurityConfiguration( + createSecurityConfiguration( args: CreateSecurityConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSecurityConfigurationCommandOutput) => void ): void; - public createSecurityConfiguration( - args: CreateSecurityConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSecurityConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateSecurityConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateSecurityConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new session.

- */ - public createSession( - args: CreateSessionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createSession( - args: CreateSessionCommandInput, - cb: (err: any, data?: CreateSessionCommandOutput) => void - ): void; - public createSession( + + /** + * @see {@link CreateSessionCommand} + */ + createSession(args: CreateSessionCommandInput, options?: __HttpHandlerOptions): Promise; + createSession(args: CreateSessionCommandInput, cb: (err: any, data?: CreateSessionCommandOutput) => void): void; + createSession( args: CreateSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSessionCommandOutput) => void ): void; - public createSession( - args: CreateSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSessionCommandOutput) => void), - cb?: (err: any, data?: CreateSessionCommandOutput) => void - ): Promise | void { - const command = new CreateSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new table definition in the Data Catalog.

- */ - public createTable(args: CreateTableCommandInput, options?: __HttpHandlerOptions): Promise; - public createTable(args: CreateTableCommandInput, cb: (err: any, data?: CreateTableCommandOutput) => void): void; - public createTable( + + /** + * @see {@link CreateTableCommand} + */ + createTable(args: CreateTableCommandInput, options?: __HttpHandlerOptions): Promise; + createTable(args: CreateTableCommandInput, cb: (err: any, data?: CreateTableCommandOutput) => void): void; + createTable( args: CreateTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTableCommandOutput) => void ): void; - public createTable( - args: CreateTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTableCommandOutput) => void), - cb?: (err: any, data?: CreateTableCommandOutput) => void - ): Promise | void { - const command = new CreateTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new trigger.

- */ - public createTrigger( - args: CreateTriggerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createTrigger( - args: CreateTriggerCommandInput, - cb: (err: any, data?: CreateTriggerCommandOutput) => void - ): void; - public createTrigger( + + /** + * @see {@link CreateTriggerCommand} + */ + createTrigger(args: CreateTriggerCommandInput, options?: __HttpHandlerOptions): Promise; + createTrigger(args: CreateTriggerCommandInput, cb: (err: any, data?: CreateTriggerCommandOutput) => void): void; + createTrigger( args: CreateTriggerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTriggerCommandOutput) => void ): void; - public createTrigger( - args: CreateTriggerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTriggerCommandOutput) => void), - cb?: (err: any, data?: CreateTriggerCommandOutput) => void - ): Promise | void { - const command = new CreateTriggerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new function definition in the Data Catalog.

- */ - public createUserDefinedFunction( + + /** + * @see {@link CreateUserDefinedFunctionCommand} + */ + createUserDefinedFunction( args: CreateUserDefinedFunctionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createUserDefinedFunction( + createUserDefinedFunction( args: CreateUserDefinedFunctionCommandInput, cb: (err: any, data?: CreateUserDefinedFunctionCommandOutput) => void ): void; - public createUserDefinedFunction( + createUserDefinedFunction( args: CreateUserDefinedFunctionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserDefinedFunctionCommandOutput) => void ): void; - public createUserDefinedFunction( - args: CreateUserDefinedFunctionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserDefinedFunctionCommandOutput) => void), - cb?: (err: any, data?: CreateUserDefinedFunctionCommandOutput) => void - ): Promise | void { - const command = new CreateUserDefinedFunctionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new workflow.

- */ - public createWorkflow( + + /** + * @see {@link CreateWorkflowCommand} + */ + createWorkflow( args: CreateWorkflowCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorkflow( - args: CreateWorkflowCommandInput, - cb: (err: any, data?: CreateWorkflowCommandOutput) => void - ): void; - public createWorkflow( + createWorkflow(args: CreateWorkflowCommandInput, cb: (err: any, data?: CreateWorkflowCommandOutput) => void): void; + createWorkflow( args: CreateWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkflowCommandOutput) => void ): void; - public createWorkflow( - args: CreateWorkflowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorkflowCommandOutput) => void), - cb?: (err: any, data?: CreateWorkflowCommandOutput) => void - ): Promise | void { - const command = new CreateWorkflowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an existing blueprint.

- */ - public deleteBlueprint( + + /** + * @see {@link DeleteBlueprintCommand} + */ + deleteBlueprint( args: DeleteBlueprintCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBlueprint( - args: DeleteBlueprintCommandInput, - cb: (err: any, data?: DeleteBlueprintCommandOutput) => void - ): void; - public deleteBlueprint( + deleteBlueprint(args: DeleteBlueprintCommandInput, cb: (err: any, data?: DeleteBlueprintCommandOutput) => void): void; + deleteBlueprint( args: DeleteBlueprintCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBlueprintCommandOutput) => void ): void; - public deleteBlueprint( - args: DeleteBlueprintCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBlueprintCommandOutput) => void), - cb?: (err: any, data?: DeleteBlueprintCommandOutput) => void - ): Promise | void { - const command = new DeleteBlueprintCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a classifier from the Data Catalog.

- */ - public deleteClassifier( + + /** + * @see {@link DeleteClassifierCommand} + */ + deleteClassifier( args: DeleteClassifierCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteClassifier( + deleteClassifier( args: DeleteClassifierCommandInput, cb: (err: any, data?: DeleteClassifierCommandOutput) => void ): void; - public deleteClassifier( + deleteClassifier( args: DeleteClassifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClassifierCommandOutput) => void ): void; - public deleteClassifier( - args: DeleteClassifierCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteClassifierCommandOutput) => void), - cb?: (err: any, data?: DeleteClassifierCommandOutput) => void - ): Promise | void { - const command = new DeleteClassifierCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete the partition column statistics of a column.

- *

The Identity and Access Management (IAM) permission required for this operation is DeletePartition.

- */ - public deleteColumnStatisticsForPartition( + + /** + * @see {@link DeleteColumnStatisticsForPartitionCommand} + */ + deleteColumnStatisticsForPartition( args: DeleteColumnStatisticsForPartitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteColumnStatisticsForPartition( + deleteColumnStatisticsForPartition( args: DeleteColumnStatisticsForPartitionCommandInput, cb: (err: any, data?: DeleteColumnStatisticsForPartitionCommandOutput) => void ): void; - public deleteColumnStatisticsForPartition( + deleteColumnStatisticsForPartition( args: DeleteColumnStatisticsForPartitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteColumnStatisticsForPartitionCommandOutput) => void ): void; - public deleteColumnStatisticsForPartition( - args: DeleteColumnStatisticsForPartitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteColumnStatisticsForPartitionCommandOutput) => void), - cb?: (err: any, data?: DeleteColumnStatisticsForPartitionCommandOutput) => void - ): Promise | void { - const command = new DeleteColumnStatisticsForPartitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves table statistics of columns.

- *

The Identity and Access Management (IAM) permission required for this operation is DeleteTable.

- */ - public deleteColumnStatisticsForTable( + + /** + * @see {@link DeleteColumnStatisticsForTableCommand} + */ + deleteColumnStatisticsForTable( args: DeleteColumnStatisticsForTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteColumnStatisticsForTable( + deleteColumnStatisticsForTable( args: DeleteColumnStatisticsForTableCommandInput, cb: (err: any, data?: DeleteColumnStatisticsForTableCommandOutput) => void ): void; - public deleteColumnStatisticsForTable( + deleteColumnStatisticsForTable( args: DeleteColumnStatisticsForTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteColumnStatisticsForTableCommandOutput) => void ): void; - public deleteColumnStatisticsForTable( - args: DeleteColumnStatisticsForTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteColumnStatisticsForTableCommandOutput) => void), - cb?: (err: any, data?: DeleteColumnStatisticsForTableCommandOutput) => void - ): Promise | void { - const command = new DeleteColumnStatisticsForTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a connection from the Data Catalog.

- */ - public deleteConnection( + + /** + * @see {@link DeleteConnectionCommand} + */ + deleteConnection( args: DeleteConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, cb: (err: any, data?: DeleteConnectionCommandOutput) => void ): void; - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectionCommandOutput) => void ): void; - public deleteConnection( - args: DeleteConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConnectionCommandOutput) => void), - cb?: (err: any, data?: DeleteConnectionCommandOutput) => void - ): Promise | void { - const command = new DeleteConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a specified crawler from the Glue Data Catalog, unless the crawler state is - * RUNNING.

- */ - public deleteCrawler( - args: DeleteCrawlerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteCrawler( - args: DeleteCrawlerCommandInput, - cb: (err: any, data?: DeleteCrawlerCommandOutput) => void - ): void; - public deleteCrawler( + + /** + * @see {@link DeleteCrawlerCommand} + */ + deleteCrawler(args: DeleteCrawlerCommandInput, options?: __HttpHandlerOptions): Promise; + deleteCrawler(args: DeleteCrawlerCommandInput, cb: (err: any, data?: DeleteCrawlerCommandOutput) => void): void; + deleteCrawler( args: DeleteCrawlerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCrawlerCommandOutput) => void ): void; - public deleteCrawler( - args: DeleteCrawlerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCrawlerCommandOutput) => void), - cb?: (err: any, data?: DeleteCrawlerCommandOutput) => void - ): Promise | void { - const command = new DeleteCrawlerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a custom pattern by specifying its name.

- */ - public deleteCustomEntityType( + + /** + * @see {@link DeleteCustomEntityTypeCommand} + */ + deleteCustomEntityType( args: DeleteCustomEntityTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCustomEntityType( + deleteCustomEntityType( args: DeleteCustomEntityTypeCommandInput, cb: (err: any, data?: DeleteCustomEntityTypeCommandOutput) => void ): void; - public deleteCustomEntityType( + deleteCustomEntityType( args: DeleteCustomEntityTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomEntityTypeCommandOutput) => void ): void; - public deleteCustomEntityType( - args: DeleteCustomEntityTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCustomEntityTypeCommandOutput) => void), - cb?: (err: any, data?: DeleteCustomEntityTypeCommandOutput) => void - ): Promise | void { - const command = new DeleteCustomEntityTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a specified database from a Data Catalog.

- * - *

After completing this operation, you no longer have access to the tables (and all table - * versions and partitions that might belong to the tables) and the user-defined functions in - * the deleted database. Glue deletes these "orphaned" resources asynchronously in a timely - * manner, at the discretion of the service.

- *

To ensure the immediate deletion of all related resources, before calling - * DeleteDatabase, use DeleteTableVersion or - * BatchDeleteTableVersion, DeletePartition or - * BatchDeletePartition, DeleteUserDefinedFunction, and - * DeleteTable or BatchDeleteTable, to delete any resources that - * belong to the database.

- *
- */ - public deleteDatabase( + + /** + * @see {@link DeleteDatabaseCommand} + */ + deleteDatabase( args: DeleteDatabaseCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDatabase( - args: DeleteDatabaseCommandInput, - cb: (err: any, data?: DeleteDatabaseCommandOutput) => void - ): void; - public deleteDatabase( + deleteDatabase(args: DeleteDatabaseCommandInput, cb: (err: any, data?: DeleteDatabaseCommandOutput) => void): void; + deleteDatabase( args: DeleteDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatabaseCommandOutput) => void ): void; - public deleteDatabase( - args: DeleteDatabaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDatabaseCommandOutput) => void), - cb?: (err: any, data?: DeleteDatabaseCommandOutput) => void - ): Promise | void { - const command = new DeleteDatabaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a data quality ruleset.

- */ - public deleteDataQualityRuleset( + + /** + * @see {@link DeleteDataQualityRulesetCommand} + */ + deleteDataQualityRuleset( args: DeleteDataQualityRulesetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDataQualityRuleset( + deleteDataQualityRuleset( args: DeleteDataQualityRulesetCommandInput, cb: (err: any, data?: DeleteDataQualityRulesetCommandOutput) => void ): void; - public deleteDataQualityRuleset( + deleteDataQualityRuleset( args: DeleteDataQualityRulesetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataQualityRulesetCommandOutput) => void ): void; - public deleteDataQualityRuleset( - args: DeleteDataQualityRulesetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDataQualityRulesetCommandOutput) => void), - cb?: (err: any, data?: DeleteDataQualityRulesetCommandOutput) => void - ): Promise | void { - const command = new DeleteDataQualityRulesetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specified development endpoint.

- */ - public deleteDevEndpoint( + + /** + * @see {@link DeleteDevEndpointCommand} + */ + deleteDevEndpoint( args: DeleteDevEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDevEndpoint( + deleteDevEndpoint( args: DeleteDevEndpointCommandInput, cb: (err: any, data?: DeleteDevEndpointCommandOutput) => void ): void; - public deleteDevEndpoint( + deleteDevEndpoint( args: DeleteDevEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDevEndpointCommandOutput) => void ): void; - public deleteDevEndpoint( - args: DeleteDevEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDevEndpointCommandOutput) => void), - cb?: (err: any, data?: DeleteDevEndpointCommandOutput) => void - ): Promise | void { - const command = new DeleteDevEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specified job definition. If the job definition - * is not found, no exception is thrown.

- */ - public deleteJob(args: DeleteJobCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteJob(args: DeleteJobCommandInput, cb: (err: any, data?: DeleteJobCommandOutput) => void): void; - public deleteJob( + + /** + * @see {@link DeleteJobCommand} + */ + deleteJob(args: DeleteJobCommandInput, options?: __HttpHandlerOptions): Promise; + deleteJob(args: DeleteJobCommandInput, cb: (err: any, data?: DeleteJobCommandOutput) => void): void; + deleteJob( args: DeleteJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteJobCommandOutput) => void ): void; - public deleteJob( - args: DeleteJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteJobCommandOutput) => void), - cb?: (err: any, data?: DeleteJobCommandOutput) => void - ): Promise | void { - const command = new DeleteJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an Glue machine learning transform. Machine learning transforms are a special - * type of transform that use machine learning to learn the details of the transformation to be - * performed by learning from examples provided by humans. These transformations are then saved - * by Glue. If you no longer need a transform, you can delete it by calling - * DeleteMLTransforms. However, any Glue jobs that still reference the deleted - * transform will no longer succeed.

- */ - public deleteMLTransform( + + /** + * @see {@link DeleteMLTransformCommand} + */ + deleteMLTransform( args: DeleteMLTransformCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMLTransform( + deleteMLTransform( args: DeleteMLTransformCommandInput, cb: (err: any, data?: DeleteMLTransformCommandOutput) => void ): void; - public deleteMLTransform( + deleteMLTransform( args: DeleteMLTransformCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMLTransformCommandOutput) => void ): void; - public deleteMLTransform( - args: DeleteMLTransformCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMLTransformCommandOutput) => void), - cb?: (err: any, data?: DeleteMLTransformCommandOutput) => void - ): Promise | void { - const command = new DeleteMLTransformCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specified partition.

- */ - public deletePartition( + + /** + * @see {@link DeletePartitionCommand} + */ + deletePartition( args: DeletePartitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePartition( - args: DeletePartitionCommandInput, - cb: (err: any, data?: DeletePartitionCommandOutput) => void - ): void; - public deletePartition( + deletePartition(args: DeletePartitionCommandInput, cb: (err: any, data?: DeletePartitionCommandOutput) => void): void; + deletePartition( args: DeletePartitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePartitionCommandOutput) => void ): void; - public deletePartition( - args: DeletePartitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePartitionCommandOutput) => void), - cb?: (err: any, data?: DeletePartitionCommandOutput) => void - ): Promise | void { - const command = new DeletePartitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specified partition index from an existing table.

- */ - public deletePartitionIndex( + + /** + * @see {@link DeletePartitionIndexCommand} + */ + deletePartitionIndex( args: DeletePartitionIndexCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePartitionIndex( + deletePartitionIndex( args: DeletePartitionIndexCommandInput, cb: (err: any, data?: DeletePartitionIndexCommandOutput) => void ): void; - public deletePartitionIndex( + deletePartitionIndex( args: DeletePartitionIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePartitionIndexCommandOutput) => void ): void; - public deletePartitionIndex( - args: DeletePartitionIndexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePartitionIndexCommandOutput) => void), - cb?: (err: any, data?: DeletePartitionIndexCommandOutput) => void - ): Promise | void { - const command = new DeletePartitionIndexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete the entire registry including schema and all of its versions. To get the status of the delete operation, you can call the GetRegistry API after the asynchronous call. Deleting a registry will deactivate all online operations for the registry such as the UpdateRegistry, CreateSchema, UpdateSchema, and RegisterSchemaVersion APIs.

- */ - public deleteRegistry( + + /** + * @see {@link DeleteRegistryCommand} + */ + deleteRegistry( args: DeleteRegistryCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRegistry( - args: DeleteRegistryCommandInput, - cb: (err: any, data?: DeleteRegistryCommandOutput) => void - ): void; - public deleteRegistry( + deleteRegistry(args: DeleteRegistryCommandInput, cb: (err: any, data?: DeleteRegistryCommandOutput) => void): void; + deleteRegistry( args: DeleteRegistryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRegistryCommandOutput) => void ): void; - public deleteRegistry( - args: DeleteRegistryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRegistryCommandOutput) => void), - cb?: (err: any, data?: DeleteRegistryCommandOutput) => void - ): Promise | void { - const command = new DeleteRegistryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specified policy.

- */ - public deleteResourcePolicy( + + /** + * @see {@link DeleteResourcePolicyCommand} + */ + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( - args: DeleteResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the entire schema set, including the schema set and all of its versions. To get the status of the delete operation, you can call GetSchema API after the asynchronous call. Deleting a registry will deactivate all online operations for the schema, such as the GetSchemaByDefinition, and RegisterSchemaVersion APIs.

- */ - public deleteSchema( - args: DeleteSchemaCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteSchema(args: DeleteSchemaCommandInput, cb: (err: any, data?: DeleteSchemaCommandOutput) => void): void; - public deleteSchema( + + /** + * @see {@link DeleteSchemaCommand} + */ + deleteSchema(args: DeleteSchemaCommandInput, options?: __HttpHandlerOptions): Promise; + deleteSchema(args: DeleteSchemaCommandInput, cb: (err: any, data?: DeleteSchemaCommandOutput) => void): void; + deleteSchema( args: DeleteSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSchemaCommandOutput) => void ): void; - public deleteSchema( - args: DeleteSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSchemaCommandOutput) => void), - cb?: (err: any, data?: DeleteSchemaCommandOutput) => void - ): Promise | void { - const command = new DeleteSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Remove versions from the specified schema. A version number or range may be supplied. If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned. Calling the GetSchemaVersions API after this call will list the status of the deleted versions.

- *

When the range of version numbers contain check pointed version, the API will return a 409 conflict and will not proceed with the deletion. You have to remove the checkpoint first using the DeleteSchemaCheckpoint API before using this API.

- *

You cannot use the DeleteSchemaVersions API to delete the first schema version in the schema set. The first schema version can only be deleted by the DeleteSchema API. This operation will also delete the attached SchemaVersionMetadata under the schema versions. Hard deletes will be enforced on the database.

- *

If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned.

- */ - public deleteSchemaVersions( + + /** + * @see {@link DeleteSchemaVersionsCommand} + */ + deleteSchemaVersions( args: DeleteSchemaVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSchemaVersions( + deleteSchemaVersions( args: DeleteSchemaVersionsCommandInput, cb: (err: any, data?: DeleteSchemaVersionsCommandOutput) => void ): void; - public deleteSchemaVersions( + deleteSchemaVersions( args: DeleteSchemaVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSchemaVersionsCommandOutput) => void ): void; - public deleteSchemaVersions( - args: DeleteSchemaVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSchemaVersionsCommandOutput) => void), - cb?: (err: any, data?: DeleteSchemaVersionsCommandOutput) => void - ): Promise | void { - const command = new DeleteSchemaVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specified security configuration.

- */ - public deleteSecurityConfiguration( + + /** + * @see {@link DeleteSecurityConfigurationCommand} + */ + deleteSecurityConfiguration( args: DeleteSecurityConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSecurityConfiguration( + deleteSecurityConfiguration( args: DeleteSecurityConfigurationCommandInput, cb: (err: any, data?: DeleteSecurityConfigurationCommandOutput) => void ): void; - public deleteSecurityConfiguration( + deleteSecurityConfiguration( args: DeleteSecurityConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSecurityConfigurationCommandOutput) => void ): void; - public deleteSecurityConfiguration( - args: DeleteSecurityConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSecurityConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteSecurityConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteSecurityConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the session.

- */ - public deleteSession( - args: DeleteSessionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteSession( - args: DeleteSessionCommandInput, - cb: (err: any, data?: DeleteSessionCommandOutput) => void - ): void; - public deleteSession( + + /** + * @see {@link DeleteSessionCommand} + */ + deleteSession(args: DeleteSessionCommandInput, options?: __HttpHandlerOptions): Promise; + deleteSession(args: DeleteSessionCommandInput, cb: (err: any, data?: DeleteSessionCommandOutput) => void): void; + deleteSession( args: DeleteSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSessionCommandOutput) => void ): void; - public deleteSession( - args: DeleteSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSessionCommandOutput) => void), - cb?: (err: any, data?: DeleteSessionCommandOutput) => void - ): Promise | void { - const command = new DeleteSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a table definition from the Data Catalog.

- * - *

After completing this operation, you no longer have access to the table versions and - * partitions that belong to the deleted table. Glue deletes these "orphaned" resources - * asynchronously in a timely manner, at the discretion of the service.

- *

To ensure the immediate deletion of all related resources, before calling - * DeleteTable, use DeleteTableVersion or - * BatchDeleteTableVersion, and DeletePartition or - * BatchDeletePartition, to delete any resources that belong to the - * table.

- *
- */ - public deleteTable(args: DeleteTableCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteTable(args: DeleteTableCommandInput, cb: (err: any, data?: DeleteTableCommandOutput) => void): void; - public deleteTable( + + /** + * @see {@link DeleteTableCommand} + */ + deleteTable(args: DeleteTableCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTable(args: DeleteTableCommandInput, cb: (err: any, data?: DeleteTableCommandOutput) => void): void; + deleteTable( args: DeleteTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTableCommandOutput) => void ): void; - public deleteTable( - args: DeleteTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTableCommandOutput) => void), - cb?: (err: any, data?: DeleteTableCommandOutput) => void - ): Promise | void { - const command = new DeleteTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specified version of a table.

- */ - public deleteTableVersion( + + /** + * @see {@link DeleteTableVersionCommand} + */ + deleteTableVersion( args: DeleteTableVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTableVersion( + deleteTableVersion( args: DeleteTableVersionCommandInput, cb: (err: any, data?: DeleteTableVersionCommandOutput) => void ): void; - public deleteTableVersion( + deleteTableVersion( args: DeleteTableVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTableVersionCommandOutput) => void ): void; - public deleteTableVersion( - args: DeleteTableVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTableVersionCommandOutput) => void), - cb?: (err: any, data?: DeleteTableVersionCommandOutput) => void - ): Promise | void { - const command = new DeleteTableVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specified trigger. If the trigger is not found, no - * exception is thrown.

- */ - public deleteTrigger( - args: DeleteTriggerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteTrigger( - args: DeleteTriggerCommandInput, - cb: (err: any, data?: DeleteTriggerCommandOutput) => void - ): void; - public deleteTrigger( + + /** + * @see {@link DeleteTriggerCommand} + */ + deleteTrigger(args: DeleteTriggerCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTrigger(args: DeleteTriggerCommandInput, cb: (err: any, data?: DeleteTriggerCommandOutput) => void): void; + deleteTrigger( args: DeleteTriggerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTriggerCommandOutput) => void ): void; - public deleteTrigger( - args: DeleteTriggerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTriggerCommandOutput) => void), - cb?: (err: any, data?: DeleteTriggerCommandOutput) => void - ): Promise | void { - const command = new DeleteTriggerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an existing function definition from the Data Catalog.

- */ - public deleteUserDefinedFunction( + + /** + * @see {@link DeleteUserDefinedFunctionCommand} + */ + deleteUserDefinedFunction( args: DeleteUserDefinedFunctionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteUserDefinedFunction( + deleteUserDefinedFunction( args: DeleteUserDefinedFunctionCommandInput, cb: (err: any, data?: DeleteUserDefinedFunctionCommandOutput) => void ): void; - public deleteUserDefinedFunction( + deleteUserDefinedFunction( args: DeleteUserDefinedFunctionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserDefinedFunctionCommandOutput) => void ): void; - public deleteUserDefinedFunction( - args: DeleteUserDefinedFunctionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserDefinedFunctionCommandOutput) => void), - cb?: (err: any, data?: DeleteUserDefinedFunctionCommandOutput) => void - ): Promise | void { - const command = new DeleteUserDefinedFunctionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a workflow.

- */ - public deleteWorkflow( + + /** + * @see {@link DeleteWorkflowCommand} + */ + deleteWorkflow( args: DeleteWorkflowCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWorkflow( - args: DeleteWorkflowCommandInput, - cb: (err: any, data?: DeleteWorkflowCommandOutput) => void - ): void; - public deleteWorkflow( + deleteWorkflow(args: DeleteWorkflowCommandInput, cb: (err: any, data?: DeleteWorkflowCommandOutput) => void): void; + deleteWorkflow( args: DeleteWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkflowCommandOutput) => void ): void; - public deleteWorkflow( - args: DeleteWorkflowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorkflowCommandOutput) => void), - cb?: (err: any, data?: DeleteWorkflowCommandOutput) => void - ): Promise | void { - const command = new DeleteWorkflowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the details of a blueprint.

- */ - public getBlueprint( - args: GetBlueprintCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getBlueprint(args: GetBlueprintCommandInput, cb: (err: any, data?: GetBlueprintCommandOutput) => void): void; - public getBlueprint( + + /** + * @see {@link GetBlueprintCommand} + */ + getBlueprint(args: GetBlueprintCommandInput, options?: __HttpHandlerOptions): Promise; + getBlueprint(args: GetBlueprintCommandInput, cb: (err: any, data?: GetBlueprintCommandOutput) => void): void; + getBlueprint( args: GetBlueprintCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBlueprintCommandOutput) => void ): void; - public getBlueprint( - args: GetBlueprintCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBlueprintCommandOutput) => void), - cb?: (err: any, data?: GetBlueprintCommandOutput) => void - ): Promise | void { - const command = new GetBlueprintCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the details of a blueprint run.

- */ - public getBlueprintRun( + + /** + * @see {@link GetBlueprintRunCommand} + */ + getBlueprintRun( args: GetBlueprintRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBlueprintRun( - args: GetBlueprintRunCommandInput, - cb: (err: any, data?: GetBlueprintRunCommandOutput) => void - ): void; - public getBlueprintRun( + getBlueprintRun(args: GetBlueprintRunCommandInput, cb: (err: any, data?: GetBlueprintRunCommandOutput) => void): void; + getBlueprintRun( args: GetBlueprintRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBlueprintRunCommandOutput) => void ): void; - public getBlueprintRun( - args: GetBlueprintRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBlueprintRunCommandOutput) => void), - cb?: (err: any, data?: GetBlueprintRunCommandOutput) => void - ): Promise | void { - const command = new GetBlueprintRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the details of blueprint runs for a specified blueprint.

- */ - public getBlueprintRuns( + + /** + * @see {@link GetBlueprintRunsCommand} + */ + getBlueprintRuns( args: GetBlueprintRunsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBlueprintRuns( + getBlueprintRuns( args: GetBlueprintRunsCommandInput, cb: (err: any, data?: GetBlueprintRunsCommandOutput) => void ): void; - public getBlueprintRuns( + getBlueprintRuns( args: GetBlueprintRunsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBlueprintRunsCommandOutput) => void ): void; - public getBlueprintRuns( - args: GetBlueprintRunsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBlueprintRunsCommandOutput) => void), - cb?: (err: any, data?: GetBlueprintRunsCommandOutput) => void - ): Promise | void { - const command = new GetBlueprintRunsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the status of a migration operation.

- */ - public getCatalogImportStatus( + + /** + * @see {@link GetCatalogImportStatusCommand} + */ + getCatalogImportStatus( args: GetCatalogImportStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCatalogImportStatus( + getCatalogImportStatus( args: GetCatalogImportStatusCommandInput, cb: (err: any, data?: GetCatalogImportStatusCommandOutput) => void ): void; - public getCatalogImportStatus( + getCatalogImportStatus( args: GetCatalogImportStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCatalogImportStatusCommandOutput) => void ): void; - public getCatalogImportStatus( - args: GetCatalogImportStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCatalogImportStatusCommandOutput) => void), - cb?: (err: any, data?: GetCatalogImportStatusCommandOutput) => void - ): Promise | void { - const command = new GetCatalogImportStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieve a classifier by name.

- */ - public getClassifier( - args: GetClassifierCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getClassifier( - args: GetClassifierCommandInput, - cb: (err: any, data?: GetClassifierCommandOutput) => void - ): void; - public getClassifier( + + /** + * @see {@link GetClassifierCommand} + */ + getClassifier(args: GetClassifierCommandInput, options?: __HttpHandlerOptions): Promise; + getClassifier(args: GetClassifierCommandInput, cb: (err: any, data?: GetClassifierCommandOutput) => void): void; + getClassifier( args: GetClassifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetClassifierCommandOutput) => void ): void; - public getClassifier( - args: GetClassifierCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetClassifierCommandOutput) => void), - cb?: (err: any, data?: GetClassifierCommandOutput) => void - ): Promise | void { - const command = new GetClassifierCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all classifier objects in the Data Catalog.

- */ - public getClassifiers( + + /** + * @see {@link GetClassifiersCommand} + */ + getClassifiers( args: GetClassifiersCommandInput, options?: __HttpHandlerOptions ): Promise; - public getClassifiers( - args: GetClassifiersCommandInput, - cb: (err: any, data?: GetClassifiersCommandOutput) => void - ): void; - public getClassifiers( + getClassifiers(args: GetClassifiersCommandInput, cb: (err: any, data?: GetClassifiersCommandOutput) => void): void; + getClassifiers( args: GetClassifiersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetClassifiersCommandOutput) => void ): void; - public getClassifiers( - args: GetClassifiersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetClassifiersCommandOutput) => void), - cb?: (err: any, data?: GetClassifiersCommandOutput) => void - ): Promise | void { - const command = new GetClassifiersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves partition statistics of columns.

- *

The Identity and Access Management (IAM) permission required for this operation is GetPartition.

- */ - public getColumnStatisticsForPartition( + + /** + * @see {@link GetColumnStatisticsForPartitionCommand} + */ + getColumnStatisticsForPartition( args: GetColumnStatisticsForPartitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getColumnStatisticsForPartition( + getColumnStatisticsForPartition( args: GetColumnStatisticsForPartitionCommandInput, cb: (err: any, data?: GetColumnStatisticsForPartitionCommandOutput) => void ): void; - public getColumnStatisticsForPartition( + getColumnStatisticsForPartition( args: GetColumnStatisticsForPartitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetColumnStatisticsForPartitionCommandOutput) => void ): void; - public getColumnStatisticsForPartition( - args: GetColumnStatisticsForPartitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetColumnStatisticsForPartitionCommandOutput) => void), - cb?: (err: any, data?: GetColumnStatisticsForPartitionCommandOutput) => void - ): Promise | void { - const command = new GetColumnStatisticsForPartitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves table statistics of columns.

- *

The Identity and Access Management (IAM) permission required for this operation is GetTable.

- */ - public getColumnStatisticsForTable( + + /** + * @see {@link GetColumnStatisticsForTableCommand} + */ + getColumnStatisticsForTable( args: GetColumnStatisticsForTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public getColumnStatisticsForTable( + getColumnStatisticsForTable( args: GetColumnStatisticsForTableCommandInput, cb: (err: any, data?: GetColumnStatisticsForTableCommandOutput) => void ): void; - public getColumnStatisticsForTable( + getColumnStatisticsForTable( args: GetColumnStatisticsForTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetColumnStatisticsForTableCommandOutput) => void ): void; - public getColumnStatisticsForTable( - args: GetColumnStatisticsForTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetColumnStatisticsForTableCommandOutput) => void), - cb?: (err: any, data?: GetColumnStatisticsForTableCommandOutput) => void - ): Promise | void { - const command = new GetColumnStatisticsForTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a connection definition from the Data Catalog.

- */ - public getConnection( - args: GetConnectionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getConnection( - args: GetConnectionCommandInput, - cb: (err: any, data?: GetConnectionCommandOutput) => void - ): void; - public getConnection( + + /** + * @see {@link GetConnectionCommand} + */ + getConnection(args: GetConnectionCommandInput, options?: __HttpHandlerOptions): Promise; + getConnection(args: GetConnectionCommandInput, cb: (err: any, data?: GetConnectionCommandOutput) => void): void; + getConnection( args: GetConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConnectionCommandOutput) => void ): void; - public getConnection( - args: GetConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConnectionCommandOutput) => void), - cb?: (err: any, data?: GetConnectionCommandOutput) => void - ): Promise | void { - const command = new GetConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of connection definitions from the Data Catalog.

- */ - public getConnections( + + /** + * @see {@link GetConnectionsCommand} + */ + getConnections( args: GetConnectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConnections( - args: GetConnectionsCommandInput, - cb: (err: any, data?: GetConnectionsCommandOutput) => void - ): void; - public getConnections( + getConnections(args: GetConnectionsCommandInput, cb: (err: any, data?: GetConnectionsCommandOutput) => void): void; + getConnections( args: GetConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConnectionsCommandOutput) => void ): void; - public getConnections( - args: GetConnectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConnectionsCommandOutput) => void), - cb?: (err: any, data?: GetConnectionsCommandOutput) => void - ): Promise | void { - const command = new GetConnectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves metadata for a specified crawler.

- */ - public getCrawler(args: GetCrawlerCommandInput, options?: __HttpHandlerOptions): Promise; - public getCrawler(args: GetCrawlerCommandInput, cb: (err: any, data?: GetCrawlerCommandOutput) => void): void; - public getCrawler( + + /** + * @see {@link GetCrawlerCommand} + */ + getCrawler(args: GetCrawlerCommandInput, options?: __HttpHandlerOptions): Promise; + getCrawler(args: GetCrawlerCommandInput, cb: (err: any, data?: GetCrawlerCommandOutput) => void): void; + getCrawler( args: GetCrawlerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCrawlerCommandOutput) => void ): void; - public getCrawler( - args: GetCrawlerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCrawlerCommandOutput) => void), - cb?: (err: any, data?: GetCrawlerCommandOutput) => void - ): Promise | void { - const command = new GetCrawlerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves metrics about specified crawlers.

- */ - public getCrawlerMetrics( + + /** + * @see {@link GetCrawlerMetricsCommand} + */ + getCrawlerMetrics( args: GetCrawlerMetricsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCrawlerMetrics( + getCrawlerMetrics( args: GetCrawlerMetricsCommandInput, cb: (err: any, data?: GetCrawlerMetricsCommandOutput) => void ): void; - public getCrawlerMetrics( + getCrawlerMetrics( args: GetCrawlerMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCrawlerMetricsCommandOutput) => void ): void; - public getCrawlerMetrics( - args: GetCrawlerMetricsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCrawlerMetricsCommandOutput) => void), - cb?: (err: any, data?: GetCrawlerMetricsCommandOutput) => void - ): Promise | void { - const command = new GetCrawlerMetricsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves metadata for all crawlers defined in the customer - * account.

- */ - public getCrawlers(args: GetCrawlersCommandInput, options?: __HttpHandlerOptions): Promise; - public getCrawlers(args: GetCrawlersCommandInput, cb: (err: any, data?: GetCrawlersCommandOutput) => void): void; - public getCrawlers( + + /** + * @see {@link GetCrawlersCommand} + */ + getCrawlers(args: GetCrawlersCommandInput, options?: __HttpHandlerOptions): Promise; + getCrawlers(args: GetCrawlersCommandInput, cb: (err: any, data?: GetCrawlersCommandOutput) => void): void; + getCrawlers( args: GetCrawlersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCrawlersCommandOutput) => void ): void; - public getCrawlers( - args: GetCrawlersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCrawlersCommandOutput) => void), - cb?: (err: any, data?: GetCrawlersCommandOutput) => void - ): Promise | void { - const command = new GetCrawlersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the details of a custom pattern by specifying its name.

- */ - public getCustomEntityType( + + /** + * @see {@link GetCustomEntityTypeCommand} + */ + getCustomEntityType( args: GetCustomEntityTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCustomEntityType( + getCustomEntityType( args: GetCustomEntityTypeCommandInput, cb: (err: any, data?: GetCustomEntityTypeCommandOutput) => void ): void; - public getCustomEntityType( + getCustomEntityType( args: GetCustomEntityTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCustomEntityTypeCommandOutput) => void ): void; - public getCustomEntityType( - args: GetCustomEntityTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCustomEntityTypeCommandOutput) => void), - cb?: (err: any, data?: GetCustomEntityTypeCommandOutput) => void - ): Promise | void { - const command = new GetCustomEntityTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the definition of a specified database.

- */ - public getDatabase(args: GetDatabaseCommandInput, options?: __HttpHandlerOptions): Promise; - public getDatabase(args: GetDatabaseCommandInput, cb: (err: any, data?: GetDatabaseCommandOutput) => void): void; - public getDatabase( + + /** + * @see {@link GetDatabaseCommand} + */ + getDatabase(args: GetDatabaseCommandInput, options?: __HttpHandlerOptions): Promise; + getDatabase(args: GetDatabaseCommandInput, cb: (err: any, data?: GetDatabaseCommandOutput) => void): void; + getDatabase( args: GetDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDatabaseCommandOutput) => void ): void; - public getDatabase( - args: GetDatabaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDatabaseCommandOutput) => void), - cb?: (err: any, data?: GetDatabaseCommandOutput) => void - ): Promise | void { - const command = new GetDatabaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves all databases defined in a given Data Catalog.

- */ - public getDatabases( - args: GetDatabasesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getDatabases(args: GetDatabasesCommandInput, cb: (err: any, data?: GetDatabasesCommandOutput) => void): void; - public getDatabases( + + /** + * @see {@link GetDatabasesCommand} + */ + getDatabases(args: GetDatabasesCommandInput, options?: __HttpHandlerOptions): Promise; + getDatabases(args: GetDatabasesCommandInput, cb: (err: any, data?: GetDatabasesCommandOutput) => void): void; + getDatabases( args: GetDatabasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDatabasesCommandOutput) => void ): void; - public getDatabases( - args: GetDatabasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDatabasesCommandOutput) => void), - cb?: (err: any, data?: GetDatabasesCommandOutput) => void - ): Promise | void { - const command = new GetDatabasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the security configuration for a specified catalog.

- */ - public getDataCatalogEncryptionSettings( + + /** + * @see {@link GetDataCatalogEncryptionSettingsCommand} + */ + getDataCatalogEncryptionSettings( args: GetDataCatalogEncryptionSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDataCatalogEncryptionSettings( + getDataCatalogEncryptionSettings( args: GetDataCatalogEncryptionSettingsCommandInput, cb: (err: any, data?: GetDataCatalogEncryptionSettingsCommandOutput) => void ): void; - public getDataCatalogEncryptionSettings( + getDataCatalogEncryptionSettings( args: GetDataCatalogEncryptionSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataCatalogEncryptionSettingsCommandOutput) => void ): void; - public getDataCatalogEncryptionSettings( - args: GetDataCatalogEncryptionSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDataCatalogEncryptionSettingsCommandOutput) => void), - cb?: (err: any, data?: GetDataCatalogEncryptionSettingsCommandOutput) => void - ): Promise | void { - const command = new GetDataCatalogEncryptionSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Transforms a Python script into a directed acyclic graph (DAG).

- */ - public getDataflowGraph( + + /** + * @see {@link GetDataflowGraphCommand} + */ + getDataflowGraph( args: GetDataflowGraphCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDataflowGraph( + getDataflowGraph( args: GetDataflowGraphCommandInput, cb: (err: any, data?: GetDataflowGraphCommandOutput) => void ): void; - public getDataflowGraph( + getDataflowGraph( args: GetDataflowGraphCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataflowGraphCommandOutput) => void ): void; - public getDataflowGraph( - args: GetDataflowGraphCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDataflowGraphCommandOutput) => void), - cb?: (err: any, data?: GetDataflowGraphCommandOutput) => void - ): Promise | void { - const command = new GetDataflowGraphCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the result of a data quality rule evaluation.

- */ - public getDataQualityResult( + + /** + * @see {@link GetDataQualityResultCommand} + */ + getDataQualityResult( args: GetDataQualityResultCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDataQualityResult( + getDataQualityResult( args: GetDataQualityResultCommandInput, cb: (err: any, data?: GetDataQualityResultCommandOutput) => void ): void; - public getDataQualityResult( + getDataQualityResult( args: GetDataQualityResultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataQualityResultCommandOutput) => void ): void; - public getDataQualityResult( - args: GetDataQualityResultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDataQualityResultCommandOutput) => void), - cb?: (err: any, data?: GetDataQualityResultCommandOutput) => void - ): Promise | void { - const command = new GetDataQualityResultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the specified recommendation run that was used to generate rules.

- */ - public getDataQualityRuleRecommendationRun( + + /** + * @see {@link GetDataQualityRuleRecommendationRunCommand} + */ + getDataQualityRuleRecommendationRun( args: GetDataQualityRuleRecommendationRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDataQualityRuleRecommendationRun( + getDataQualityRuleRecommendationRun( args: GetDataQualityRuleRecommendationRunCommandInput, cb: (err: any, data?: GetDataQualityRuleRecommendationRunCommandOutput) => void ): void; - public getDataQualityRuleRecommendationRun( + getDataQualityRuleRecommendationRun( args: GetDataQualityRuleRecommendationRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataQualityRuleRecommendationRunCommandOutput) => void ): void; - public getDataQualityRuleRecommendationRun( - args: GetDataQualityRuleRecommendationRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDataQualityRuleRecommendationRunCommandOutput) => void), - cb?: (err: any, data?: GetDataQualityRuleRecommendationRunCommandOutput) => void - ): Promise | void { - const command = new GetDataQualityRuleRecommendationRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns an existing ruleset by identifier or name.

- */ - public getDataQualityRuleset( + + /** + * @see {@link GetDataQualityRulesetCommand} + */ + getDataQualityRuleset( args: GetDataQualityRulesetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDataQualityRuleset( + getDataQualityRuleset( args: GetDataQualityRulesetCommandInput, cb: (err: any, data?: GetDataQualityRulesetCommandOutput) => void ): void; - public getDataQualityRuleset( + getDataQualityRuleset( args: GetDataQualityRulesetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataQualityRulesetCommandOutput) => void ): void; - public getDataQualityRuleset( - args: GetDataQualityRulesetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDataQualityRulesetCommandOutput) => void), - cb?: (err: any, data?: GetDataQualityRulesetCommandOutput) => void - ): Promise | void { - const command = new GetDataQualityRulesetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a specific run where a ruleset is evaluated against a data source.

- */ - public getDataQualityRulesetEvaluationRun( + + /** + * @see {@link GetDataQualityRulesetEvaluationRunCommand} + */ + getDataQualityRulesetEvaluationRun( args: GetDataQualityRulesetEvaluationRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDataQualityRulesetEvaluationRun( + getDataQualityRulesetEvaluationRun( args: GetDataQualityRulesetEvaluationRunCommandInput, cb: (err: any, data?: GetDataQualityRulesetEvaluationRunCommandOutput) => void ): void; - public getDataQualityRulesetEvaluationRun( + getDataQualityRulesetEvaluationRun( args: GetDataQualityRulesetEvaluationRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataQualityRulesetEvaluationRunCommandOutput) => void ): void; - public getDataQualityRulesetEvaluationRun( - args: GetDataQualityRulesetEvaluationRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDataQualityRulesetEvaluationRunCommandOutput) => void), - cb?: (err: any, data?: GetDataQualityRulesetEvaluationRunCommandOutput) => void - ): Promise | void { - const command = new GetDataQualityRulesetEvaluationRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about a specified development endpoint.

- * - *

When you create a development endpoint in a virtual private cloud (VPC), Glue returns only - * a private IP address, and the public IP address field is not populated. When you create a - * non-VPC development endpoint, Glue returns only a public IP address.

- *
- */ - public getDevEndpoint( + + /** + * @see {@link GetDevEndpointCommand} + */ + getDevEndpoint( args: GetDevEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDevEndpoint( - args: GetDevEndpointCommandInput, - cb: (err: any, data?: GetDevEndpointCommandOutput) => void - ): void; - public getDevEndpoint( + getDevEndpoint(args: GetDevEndpointCommandInput, cb: (err: any, data?: GetDevEndpointCommandOutput) => void): void; + getDevEndpoint( args: GetDevEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDevEndpointCommandOutput) => void ): void; - public getDevEndpoint( - args: GetDevEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDevEndpointCommandOutput) => void), - cb?: (err: any, data?: GetDevEndpointCommandOutput) => void - ): Promise | void { - const command = new GetDevEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves all the development endpoints in this Amazon Web Services account.

- * - *

When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address - * and the public IP address field is not populated. When you create a non-VPC development - * endpoint, Glue returns only a public IP address.

- *
- */ - public getDevEndpoints( + + /** + * @see {@link GetDevEndpointsCommand} + */ + getDevEndpoints( args: GetDevEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDevEndpoints( - args: GetDevEndpointsCommandInput, - cb: (err: any, data?: GetDevEndpointsCommandOutput) => void - ): void; - public getDevEndpoints( + getDevEndpoints(args: GetDevEndpointsCommandInput, cb: (err: any, data?: GetDevEndpointsCommandOutput) => void): void; + getDevEndpoints( args: GetDevEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDevEndpointsCommandOutput) => void ): void; - public getDevEndpoints( - args: GetDevEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDevEndpointsCommandOutput) => void), - cb?: (err: any, data?: GetDevEndpointsCommandOutput) => void - ): Promise | void { - const command = new GetDevEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves an existing job definition.

- */ - public getJob(args: GetJobCommandInput, options?: __HttpHandlerOptions): Promise; - public getJob(args: GetJobCommandInput, cb: (err: any, data?: GetJobCommandOutput) => void): void; - public getJob( + + /** + * @see {@link GetJobCommand} + */ + getJob(args: GetJobCommandInput, options?: __HttpHandlerOptions): Promise; + getJob(args: GetJobCommandInput, cb: (err: any, data?: GetJobCommandOutput) => void): void; + getJob( args: GetJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobCommandOutput) => void ): void; - public getJob( - args: GetJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetJobCommandOutput) => void), - cb?: (err: any, data?: GetJobCommandOutput) => void - ): Promise | void { - const command = new GetJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information on a job bookmark entry.

- *

For more information about enabling and using job bookmarks, see:

- * - */ - public getJobBookmark( + + /** + * @see {@link GetJobBookmarkCommand} + */ + getJobBookmark( args: GetJobBookmarkCommandInput, options?: __HttpHandlerOptions ): Promise; - public getJobBookmark( - args: GetJobBookmarkCommandInput, - cb: (err: any, data?: GetJobBookmarkCommandOutput) => void - ): void; - public getJobBookmark( + getJobBookmark(args: GetJobBookmarkCommandInput, cb: (err: any, data?: GetJobBookmarkCommandOutput) => void): void; + getJobBookmark( args: GetJobBookmarkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobBookmarkCommandOutput) => void ): void; - public getJobBookmark( - args: GetJobBookmarkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetJobBookmarkCommandOutput) => void), - cb?: (err: any, data?: GetJobBookmarkCommandOutput) => void - ): Promise | void { - const command = new GetJobBookmarkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the metadata for a given job run.

- */ - public getJobRun(args: GetJobRunCommandInput, options?: __HttpHandlerOptions): Promise; - public getJobRun(args: GetJobRunCommandInput, cb: (err: any, data?: GetJobRunCommandOutput) => void): void; - public getJobRun( + + /** + * @see {@link GetJobRunCommand} + */ + getJobRun(args: GetJobRunCommandInput, options?: __HttpHandlerOptions): Promise; + getJobRun(args: GetJobRunCommandInput, cb: (err: any, data?: GetJobRunCommandOutput) => void): void; + getJobRun( args: GetJobRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobRunCommandOutput) => void ): void; - public getJobRun( - args: GetJobRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetJobRunCommandOutput) => void), - cb?: (err: any, data?: GetJobRunCommandOutput) => void - ): Promise | void { - const command = new GetJobRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves metadata for all runs of a given job definition.

- */ - public getJobRuns(args: GetJobRunsCommandInput, options?: __HttpHandlerOptions): Promise; - public getJobRuns(args: GetJobRunsCommandInput, cb: (err: any, data?: GetJobRunsCommandOutput) => void): void; - public getJobRuns( + + /** + * @see {@link GetJobRunsCommand} + */ + getJobRuns(args: GetJobRunsCommandInput, options?: __HttpHandlerOptions): Promise; + getJobRuns(args: GetJobRunsCommandInput, cb: (err: any, data?: GetJobRunsCommandOutput) => void): void; + getJobRuns( args: GetJobRunsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobRunsCommandOutput) => void ): void; - public getJobRuns( - args: GetJobRunsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetJobRunsCommandOutput) => void), - cb?: (err: any, data?: GetJobRunsCommandOutput) => void - ): Promise | void { - const command = new GetJobRunsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves all current job definitions.

- */ - public getJobs(args: GetJobsCommandInput, options?: __HttpHandlerOptions): Promise; - public getJobs(args: GetJobsCommandInput, cb: (err: any, data?: GetJobsCommandOutput) => void): void; - public getJobs( + + /** + * @see {@link GetJobsCommand} + */ + getJobs(args: GetJobsCommandInput, options?: __HttpHandlerOptions): Promise; + getJobs(args: GetJobsCommandInput, cb: (err: any, data?: GetJobsCommandOutput) => void): void; + getJobs( args: GetJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobsCommandOutput) => void ): void; - public getJobs( - args: GetJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetJobsCommandOutput) => void), - cb?: (err: any, data?: GetJobsCommandOutput) => void - ): Promise | void { - const command = new GetJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates mappings.

- */ - public getMapping(args: GetMappingCommandInput, options?: __HttpHandlerOptions): Promise; - public getMapping(args: GetMappingCommandInput, cb: (err: any, data?: GetMappingCommandOutput) => void): void; - public getMapping( + + /** + * @see {@link GetMappingCommand} + */ + getMapping(args: GetMappingCommandInput, options?: __HttpHandlerOptions): Promise; + getMapping(args: GetMappingCommandInput, cb: (err: any, data?: GetMappingCommandOutput) => void): void; + getMapping( args: GetMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMappingCommandOutput) => void ): void; - public getMapping( - args: GetMappingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMappingCommandOutput) => void), - cb?: (err: any, data?: GetMappingCommandOutput) => void - ): Promise | void { - const command = new GetMappingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets details for a specific task run on a machine learning transform. Machine learning - * task runs are asynchronous tasks that Glue runs on your behalf as part of various machine - * learning workflows. You can check the stats of any task run by calling - * GetMLTaskRun with the TaskRunID and its parent transform's - * TransformID.

- */ - public getMLTaskRun( - args: GetMLTaskRunCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getMLTaskRun(args: GetMLTaskRunCommandInput, cb: (err: any, data?: GetMLTaskRunCommandOutput) => void): void; - public getMLTaskRun( - args: GetMLTaskRunCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: GetMLTaskRunCommandOutput) => void - ): void; - public getMLTaskRun( - args: GetMLTaskRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMLTaskRunCommandOutput) => void), - cb?: (err: any, data?: GetMLTaskRunCommandOutput) => void - ): Promise | void { - const command = new GetMLTaskRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of runs for a machine learning transform. Machine learning task runs are - * asynchronous tasks that Glue runs on your behalf as part of various machine learning - * workflows. You can get a sortable, filterable list of machine learning task runs by calling - * GetMLTaskRuns with their parent transform's TransformID and other - * optional parameters as documented in this section.

- *

This operation returns a list of historic runs and must be paginated.

- */ - public getMLTaskRuns( - args: GetMLTaskRunsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getMLTaskRuns( - args: GetMLTaskRunsCommandInput, - cb: (err: any, data?: GetMLTaskRunsCommandOutput) => void + + /** + * @see {@link GetMLTaskRunCommand} + */ + getMLTaskRun(args: GetMLTaskRunCommandInput, options?: __HttpHandlerOptions): Promise; + getMLTaskRun(args: GetMLTaskRunCommandInput, cb: (err: any, data?: GetMLTaskRunCommandOutput) => void): void; + getMLTaskRun( + args: GetMLTaskRunCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: GetMLTaskRunCommandOutput) => void ): void; - public getMLTaskRuns( + + /** + * @see {@link GetMLTaskRunsCommand} + */ + getMLTaskRuns(args: GetMLTaskRunsCommandInput, options?: __HttpHandlerOptions): Promise; + getMLTaskRuns(args: GetMLTaskRunsCommandInput, cb: (err: any, data?: GetMLTaskRunsCommandOutput) => void): void; + getMLTaskRuns( args: GetMLTaskRunsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMLTaskRunsCommandOutput) => void ): void; - public getMLTaskRuns( - args: GetMLTaskRunsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMLTaskRunsCommandOutput) => void), - cb?: (err: any, data?: GetMLTaskRunsCommandOutput) => void - ): Promise | void { - const command = new GetMLTaskRunsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets an Glue machine learning transform artifact and all its corresponding metadata. - * Machine learning transforms are a special type of transform that use machine learning to learn - * the details of the transformation to be performed by learning from examples provided by - * humans. These transformations are then saved by Glue. You can retrieve their metadata by - * calling GetMLTransform.

- */ - public getMLTransform( + + /** + * @see {@link GetMLTransformCommand} + */ + getMLTransform( args: GetMLTransformCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMLTransform( - args: GetMLTransformCommandInput, - cb: (err: any, data?: GetMLTransformCommandOutput) => void - ): void; - public getMLTransform( + getMLTransform(args: GetMLTransformCommandInput, cb: (err: any, data?: GetMLTransformCommandOutput) => void): void; + getMLTransform( args: GetMLTransformCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMLTransformCommandOutput) => void ): void; - public getMLTransform( - args: GetMLTransformCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMLTransformCommandOutput) => void), - cb?: (err: any, data?: GetMLTransformCommandOutput) => void - ): Promise | void { - const command = new GetMLTransformCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a sortable, filterable list of existing Glue machine learning transforms. Machine - * learning transforms are a special type of transform that use machine learning to learn the - * details of the transformation to be performed by learning from examples provided by humans. - * These transformations are then saved by Glue, and you can retrieve their metadata by - * calling GetMLTransforms.

- */ - public getMLTransforms( + + /** + * @see {@link GetMLTransformsCommand} + */ + getMLTransforms( args: GetMLTransformsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMLTransforms( - args: GetMLTransformsCommandInput, - cb: (err: any, data?: GetMLTransformsCommandOutput) => void - ): void; - public getMLTransforms( + getMLTransforms(args: GetMLTransformsCommandInput, cb: (err: any, data?: GetMLTransformsCommandOutput) => void): void; + getMLTransforms( args: GetMLTransformsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMLTransformsCommandOutput) => void ): void; - public getMLTransforms( - args: GetMLTransformsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMLTransformsCommandOutput) => void), - cb?: (err: any, data?: GetMLTransformsCommandOutput) => void - ): Promise | void { - const command = new GetMLTransformsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about a specified partition.

- */ - public getPartition( - args: GetPartitionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getPartition(args: GetPartitionCommandInput, cb: (err: any, data?: GetPartitionCommandOutput) => void): void; - public getPartition( + + /** + * @see {@link GetPartitionCommand} + */ + getPartition(args: GetPartitionCommandInput, options?: __HttpHandlerOptions): Promise; + getPartition(args: GetPartitionCommandInput, cb: (err: any, data?: GetPartitionCommandOutput) => void): void; + getPartition( args: GetPartitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPartitionCommandOutput) => void ): void; - public getPartition( - args: GetPartitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPartitionCommandOutput) => void), - cb?: (err: any, data?: GetPartitionCommandOutput) => void - ): Promise | void { - const command = new GetPartitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the partition indexes associated with a table.

- */ - public getPartitionIndexes( + + /** + * @see {@link GetPartitionIndexesCommand} + */ + getPartitionIndexes( args: GetPartitionIndexesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPartitionIndexes( + getPartitionIndexes( args: GetPartitionIndexesCommandInput, cb: (err: any, data?: GetPartitionIndexesCommandOutput) => void ): void; - public getPartitionIndexes( + getPartitionIndexes( args: GetPartitionIndexesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPartitionIndexesCommandOutput) => void ): void; - public getPartitionIndexes( - args: GetPartitionIndexesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPartitionIndexesCommandOutput) => void), - cb?: (err: any, data?: GetPartitionIndexesCommandOutput) => void - ): Promise | void { - const command = new GetPartitionIndexesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about the partitions in a table.

- */ - public getPartitions( - args: GetPartitionsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getPartitions( - args: GetPartitionsCommandInput, - cb: (err: any, data?: GetPartitionsCommandOutput) => void - ): void; - public getPartitions( + + /** + * @see {@link GetPartitionsCommand} + */ + getPartitions(args: GetPartitionsCommandInput, options?: __HttpHandlerOptions): Promise; + getPartitions(args: GetPartitionsCommandInput, cb: (err: any, data?: GetPartitionsCommandOutput) => void): void; + getPartitions( args: GetPartitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPartitionsCommandOutput) => void ): void; - public getPartitions( - args: GetPartitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPartitionsCommandOutput) => void), - cb?: (err: any, data?: GetPartitionsCommandOutput) => void - ): Promise | void { - const command = new GetPartitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets code to perform a specified mapping.

- */ - public getPlan(args: GetPlanCommandInput, options?: __HttpHandlerOptions): Promise; - public getPlan(args: GetPlanCommandInput, cb: (err: any, data?: GetPlanCommandOutput) => void): void; - public getPlan( + + /** + * @see {@link GetPlanCommand} + */ + getPlan(args: GetPlanCommandInput, options?: __HttpHandlerOptions): Promise; + getPlan(args: GetPlanCommandInput, cb: (err: any, data?: GetPlanCommandOutput) => void): void; + getPlan( args: GetPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPlanCommandOutput) => void ): void; - public getPlan( - args: GetPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPlanCommandOutput) => void), - cb?: (err: any, data?: GetPlanCommandOutput) => void - ): Promise | void { - const command = new GetPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified registry in detail.

- */ - public getRegistry(args: GetRegistryCommandInput, options?: __HttpHandlerOptions): Promise; - public getRegistry(args: GetRegistryCommandInput, cb: (err: any, data?: GetRegistryCommandOutput) => void): void; - public getRegistry( + + /** + * @see {@link GetRegistryCommand} + */ + getRegistry(args: GetRegistryCommandInput, options?: __HttpHandlerOptions): Promise; + getRegistry(args: GetRegistryCommandInput, cb: (err: any, data?: GetRegistryCommandOutput) => void): void; + getRegistry( args: GetRegistryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRegistryCommandOutput) => void ): void; - public getRegistry( - args: GetRegistryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRegistryCommandOutput) => void), - cb?: (err: any, data?: GetRegistryCommandOutput) => void - ): Promise | void { - const command = new GetRegistryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the resource policies set on individual resources by Resource Access Manager - * during cross-account permission grants. Also retrieves the Data Catalog resource - * policy.

- *

If you enabled metadata encryption in Data Catalog settings, and you do not have - * permission on the KMS key, the operation can't return the Data Catalog resource - * policy.

- */ - public getResourcePolicies( + + /** + * @see {@link GetResourcePoliciesCommand} + */ + getResourcePolicies( args: GetResourcePoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourcePolicies( + getResourcePolicies( args: GetResourcePoliciesCommandInput, cb: (err: any, data?: GetResourcePoliciesCommandOutput) => void ): void; - public getResourcePolicies( + getResourcePolicies( args: GetResourcePoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePoliciesCommandOutput) => void ): void; - public getResourcePolicies( - args: GetResourcePoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourcePoliciesCommandOutput) => void), - cb?: (err: any, data?: GetResourcePoliciesCommandOutput) => void - ): Promise | void { - const command = new GetResourcePoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a specified resource policy.

- */ - public getResourcePolicy( + + /** + * @see {@link GetResourcePolicyCommand} + */ + getResourcePolicy( args: GetResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void ): void; - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void ): void; - public getResourcePolicy( - args: GetResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: GetResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new GetResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified schema in detail.

- */ - public getSchema(args: GetSchemaCommandInput, options?: __HttpHandlerOptions): Promise; - public getSchema(args: GetSchemaCommandInput, cb: (err: any, data?: GetSchemaCommandOutput) => void): void; - public getSchema( + + /** + * @see {@link GetSchemaCommand} + */ + getSchema(args: GetSchemaCommandInput, options?: __HttpHandlerOptions): Promise; + getSchema(args: GetSchemaCommandInput, cb: (err: any, data?: GetSchemaCommandOutput) => void): void; + getSchema( args: GetSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSchemaCommandOutput) => void ): void; - public getSchema( - args: GetSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSchemaCommandOutput) => void), - cb?: (err: any, data?: GetSchemaCommandOutput) => void - ): Promise | void { - const command = new GetSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a schema by the SchemaDefinition. The schema definition is sent to the Schema Registry, canonicalized, and hashed. If the hash is matched within the scope of the SchemaName or ARN (or the default registry, if none is supplied), that schema’s metadata is returned. Otherwise, a 404 or NotFound error is returned. Schema versions in Deleted statuses will not be included in the results.

- */ - public getSchemaByDefinition( + + /** + * @see {@link GetSchemaByDefinitionCommand} + */ + getSchemaByDefinition( args: GetSchemaByDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSchemaByDefinition( + getSchemaByDefinition( args: GetSchemaByDefinitionCommandInput, cb: (err: any, data?: GetSchemaByDefinitionCommandOutput) => void ): void; - public getSchemaByDefinition( + getSchemaByDefinition( args: GetSchemaByDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSchemaByDefinitionCommandOutput) => void ): void; - public getSchemaByDefinition( - args: GetSchemaByDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSchemaByDefinitionCommandOutput) => void), - cb?: (err: any, data?: GetSchemaByDefinitionCommandOutput) => void - ): Promise | void { - const command = new GetSchemaByDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get the specified schema by its unique ID assigned when a version of the schema is created or registered. Schema versions in Deleted status will not be included in the results.

- */ - public getSchemaVersion( + + /** + * @see {@link GetSchemaVersionCommand} + */ + getSchemaVersion( args: GetSchemaVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSchemaVersion( + getSchemaVersion( args: GetSchemaVersionCommandInput, cb: (err: any, data?: GetSchemaVersionCommandOutput) => void ): void; - public getSchemaVersion( + getSchemaVersion( args: GetSchemaVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSchemaVersionCommandOutput) => void ): void; - public getSchemaVersion( - args: GetSchemaVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSchemaVersionCommandOutput) => void), - cb?: (err: any, data?: GetSchemaVersionCommandOutput) => void - ): Promise | void { - const command = new GetSchemaVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Fetches the schema version difference in the specified difference type between two stored schema versions in the Schema Registry.

- *

This API allows you to compare two schema versions between two schema definitions under the same schema.

- */ - public getSchemaVersionsDiff( + + /** + * @see {@link GetSchemaVersionsDiffCommand} + */ + getSchemaVersionsDiff( args: GetSchemaVersionsDiffCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSchemaVersionsDiff( + getSchemaVersionsDiff( args: GetSchemaVersionsDiffCommandInput, cb: (err: any, data?: GetSchemaVersionsDiffCommandOutput) => void ): void; - public getSchemaVersionsDiff( + getSchemaVersionsDiff( args: GetSchemaVersionsDiffCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSchemaVersionsDiffCommandOutput) => void ): void; - public getSchemaVersionsDiff( - args: GetSchemaVersionsDiffCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSchemaVersionsDiffCommandOutput) => void), - cb?: (err: any, data?: GetSchemaVersionsDiffCommandOutput) => void - ): Promise | void { - const command = new GetSchemaVersionsDiffCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a specified security configuration.

- */ - public getSecurityConfiguration( + + /** + * @see {@link GetSecurityConfigurationCommand} + */ + getSecurityConfiguration( args: GetSecurityConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSecurityConfiguration( + getSecurityConfiguration( args: GetSecurityConfigurationCommandInput, cb: (err: any, data?: GetSecurityConfigurationCommandOutput) => void ): void; - public getSecurityConfiguration( + getSecurityConfiguration( args: GetSecurityConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSecurityConfigurationCommandOutput) => void ): void; - public getSecurityConfiguration( - args: GetSecurityConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSecurityConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetSecurityConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetSecurityConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of all security configurations.

- */ - public getSecurityConfigurations( + + /** + * @see {@link GetSecurityConfigurationsCommand} + */ + getSecurityConfigurations( args: GetSecurityConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSecurityConfigurations( + getSecurityConfigurations( args: GetSecurityConfigurationsCommandInput, cb: (err: any, data?: GetSecurityConfigurationsCommandOutput) => void ): void; - public getSecurityConfigurations( + getSecurityConfigurations( args: GetSecurityConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSecurityConfigurationsCommandOutput) => void ): void; - public getSecurityConfigurations( - args: GetSecurityConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSecurityConfigurationsCommandOutput) => void), - cb?: (err: any, data?: GetSecurityConfigurationsCommandOutput) => void - ): Promise | void { - const command = new GetSecurityConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the session.

- */ - public getSession(args: GetSessionCommandInput, options?: __HttpHandlerOptions): Promise; - public getSession(args: GetSessionCommandInput, cb: (err: any, data?: GetSessionCommandOutput) => void): void; - public getSession( + + /** + * @see {@link GetSessionCommand} + */ + getSession(args: GetSessionCommandInput, options?: __HttpHandlerOptions): Promise; + getSession(args: GetSessionCommandInput, cb: (err: any, data?: GetSessionCommandOutput) => void): void; + getSession( args: GetSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSessionCommandOutput) => void ): void; - public getSession( - args: GetSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSessionCommandOutput) => void), - cb?: (err: any, data?: GetSessionCommandOutput) => void - ): Promise | void { - const command = new GetSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the statement.

- */ - public getStatement( - args: GetStatementCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getStatement(args: GetStatementCommandInput, cb: (err: any, data?: GetStatementCommandOutput) => void): void; - public getStatement( + + /** + * @see {@link GetStatementCommand} + */ + getStatement(args: GetStatementCommandInput, options?: __HttpHandlerOptions): Promise; + getStatement(args: GetStatementCommandInput, cb: (err: any, data?: GetStatementCommandOutput) => void): void; + getStatement( args: GetStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStatementCommandOutput) => void ): void; - public getStatement( - args: GetStatementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStatementCommandOutput) => void), - cb?: (err: any, data?: GetStatementCommandOutput) => void - ): Promise | void { - const command = new GetStatementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the Table definition in a Data Catalog for - * a specified table.

- */ - public getTable(args: GetTableCommandInput, options?: __HttpHandlerOptions): Promise; - public getTable(args: GetTableCommandInput, cb: (err: any, data?: GetTableCommandOutput) => void): void; - public getTable( + + /** + * @see {@link GetTableCommand} + */ + getTable(args: GetTableCommandInput, options?: __HttpHandlerOptions): Promise; + getTable(args: GetTableCommandInput, cb: (err: any, data?: GetTableCommandOutput) => void): void; + getTable( args: GetTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTableCommandOutput) => void ): void; - public getTable( - args: GetTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTableCommandOutput) => void), - cb?: (err: any, data?: GetTableCommandOutput) => void - ): Promise | void { - const command = new GetTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the definitions of some or all of the tables in a given - * Database.

- */ - public getTables(args: GetTablesCommandInput, options?: __HttpHandlerOptions): Promise; - public getTables(args: GetTablesCommandInput, cb: (err: any, data?: GetTablesCommandOutput) => void): void; - public getTables( + + /** + * @see {@link GetTablesCommand} + */ + getTables(args: GetTablesCommandInput, options?: __HttpHandlerOptions): Promise; + getTables(args: GetTablesCommandInput, cb: (err: any, data?: GetTablesCommandOutput) => void): void; + getTables( args: GetTablesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTablesCommandOutput) => void ): void; - public getTables( - args: GetTablesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTablesCommandOutput) => void), - cb?: (err: any, data?: GetTablesCommandOutput) => void - ): Promise | void { - const command = new GetTablesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a specified version of a table.

- */ - public getTableVersion( + + /** + * @see {@link GetTableVersionCommand} + */ + getTableVersion( args: GetTableVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTableVersion( - args: GetTableVersionCommandInput, - cb: (err: any, data?: GetTableVersionCommandOutput) => void - ): void; - public getTableVersion( + getTableVersion(args: GetTableVersionCommandInput, cb: (err: any, data?: GetTableVersionCommandOutput) => void): void; + getTableVersion( args: GetTableVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTableVersionCommandOutput) => void ): void; - public getTableVersion( - args: GetTableVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTableVersionCommandOutput) => void), - cb?: (err: any, data?: GetTableVersionCommandOutput) => void - ): Promise | void { - const command = new GetTableVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of strings that identify available versions of - * a specified table.

- */ - public getTableVersions( + + /** + * @see {@link GetTableVersionsCommand} + */ + getTableVersions( args: GetTableVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTableVersions( + getTableVersions( args: GetTableVersionsCommandInput, cb: (err: any, data?: GetTableVersionsCommandOutput) => void ): void; - public getTableVersions( + getTableVersions( args: GetTableVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTableVersionsCommandOutput) => void ): void; - public getTableVersions( - args: GetTableVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTableVersionsCommandOutput) => void), - cb?: (err: any, data?: GetTableVersionsCommandOutput) => void - ): Promise | void { - const command = new GetTableVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of tags associated with a resource.

- */ - public getTags(args: GetTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public getTags(args: GetTagsCommandInput, cb: (err: any, data?: GetTagsCommandOutput) => void): void; - public getTags( + + /** + * @see {@link GetTagsCommand} + */ + getTags(args: GetTagsCommandInput, options?: __HttpHandlerOptions): Promise; + getTags(args: GetTagsCommandInput, cb: (err: any, data?: GetTagsCommandOutput) => void): void; + getTags( args: GetTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTagsCommandOutput) => void ): void; - public getTags( - args: GetTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTagsCommandOutput) => void), - cb?: (err: any, data?: GetTagsCommandOutput) => void - ): Promise | void { - const command = new GetTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the definition of a trigger.

- */ - public getTrigger(args: GetTriggerCommandInput, options?: __HttpHandlerOptions): Promise; - public getTrigger(args: GetTriggerCommandInput, cb: (err: any, data?: GetTriggerCommandOutput) => void): void; - public getTrigger( + + /** + * @see {@link GetTriggerCommand} + */ + getTrigger(args: GetTriggerCommandInput, options?: __HttpHandlerOptions): Promise; + getTrigger(args: GetTriggerCommandInput, cb: (err: any, data?: GetTriggerCommandOutput) => void): void; + getTrigger( args: GetTriggerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTriggerCommandOutput) => void ): void; - public getTrigger( - args: GetTriggerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTriggerCommandOutput) => void), - cb?: (err: any, data?: GetTriggerCommandOutput) => void - ): Promise | void { - const command = new GetTriggerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets all the triggers associated with a job.

- */ - public getTriggers(args: GetTriggersCommandInput, options?: __HttpHandlerOptions): Promise; - public getTriggers(args: GetTriggersCommandInput, cb: (err: any, data?: GetTriggersCommandOutput) => void): void; - public getTriggers( + + /** + * @see {@link GetTriggersCommand} + */ + getTriggers(args: GetTriggersCommandInput, options?: __HttpHandlerOptions): Promise; + getTriggers(args: GetTriggersCommandInput, cb: (err: any, data?: GetTriggersCommandOutput) => void): void; + getTriggers( args: GetTriggersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTriggersCommandOutput) => void ): void; - public getTriggers( - args: GetTriggersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTriggersCommandOutput) => void), - cb?: (err: any, data?: GetTriggersCommandOutput) => void - ): Promise | void { - const command = new GetTriggersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves partition metadata from the Data Catalog that contains unfiltered - * metadata.

- *

For IAM authorization, the public IAM action associated with this API is glue:GetPartition.

- */ - public getUnfilteredPartitionMetadata( + + /** + * @see {@link GetUnfilteredPartitionMetadataCommand} + */ + getUnfilteredPartitionMetadata( args: GetUnfilteredPartitionMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUnfilteredPartitionMetadata( + getUnfilteredPartitionMetadata( args: GetUnfilteredPartitionMetadataCommandInput, cb: (err: any, data?: GetUnfilteredPartitionMetadataCommandOutput) => void ): void; - public getUnfilteredPartitionMetadata( + getUnfilteredPartitionMetadata( args: GetUnfilteredPartitionMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUnfilteredPartitionMetadataCommandOutput) => void ): void; - public getUnfilteredPartitionMetadata( - args: GetUnfilteredPartitionMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUnfilteredPartitionMetadataCommandOutput) => void), - cb?: (err: any, data?: GetUnfilteredPartitionMetadataCommandOutput) => void - ): Promise | void { - const command = new GetUnfilteredPartitionMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves partition metadata from the Data Catalog that contains unfiltered - * metadata.

- *

For IAM authorization, the public IAM action associated with this API is glue:GetPartitions.

- */ - public getUnfilteredPartitionsMetadata( + + /** + * @see {@link GetUnfilteredPartitionsMetadataCommand} + */ + getUnfilteredPartitionsMetadata( args: GetUnfilteredPartitionsMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUnfilteredPartitionsMetadata( + getUnfilteredPartitionsMetadata( args: GetUnfilteredPartitionsMetadataCommandInput, cb: (err: any, data?: GetUnfilteredPartitionsMetadataCommandOutput) => void ): void; - public getUnfilteredPartitionsMetadata( + getUnfilteredPartitionsMetadata( args: GetUnfilteredPartitionsMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUnfilteredPartitionsMetadataCommandOutput) => void ): void; - public getUnfilteredPartitionsMetadata( - args: GetUnfilteredPartitionsMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUnfilteredPartitionsMetadataCommandOutput) => void), - cb?: (err: any, data?: GetUnfilteredPartitionsMetadataCommandOutput) => void - ): Promise | void { - const command = new GetUnfilteredPartitionsMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves table metadata from the Data Catalog that contains unfiltered - * metadata.

- *

For IAM authorization, the public IAM action associated with this API is glue:GetTable.

- */ - public getUnfilteredTableMetadata( + + /** + * @see {@link GetUnfilteredTableMetadataCommand} + */ + getUnfilteredTableMetadata( args: GetUnfilteredTableMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUnfilteredTableMetadata( + getUnfilteredTableMetadata( args: GetUnfilteredTableMetadataCommandInput, cb: (err: any, data?: GetUnfilteredTableMetadataCommandOutput) => void ): void; - public getUnfilteredTableMetadata( + getUnfilteredTableMetadata( args: GetUnfilteredTableMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUnfilteredTableMetadataCommandOutput) => void ): void; - public getUnfilteredTableMetadata( - args: GetUnfilteredTableMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUnfilteredTableMetadataCommandOutput) => void), - cb?: (err: any, data?: GetUnfilteredTableMetadataCommandOutput) => void - ): Promise | void { - const command = new GetUnfilteredTableMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a specified function definition from the Data Catalog.

- */ - public getUserDefinedFunction( + + /** + * @see {@link GetUserDefinedFunctionCommand} + */ + getUserDefinedFunction( args: GetUserDefinedFunctionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUserDefinedFunction( + getUserDefinedFunction( args: GetUserDefinedFunctionCommandInput, cb: (err: any, data?: GetUserDefinedFunctionCommandOutput) => void ): void; - public getUserDefinedFunction( + getUserDefinedFunction( args: GetUserDefinedFunctionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserDefinedFunctionCommandOutput) => void ): void; - public getUserDefinedFunction( - args: GetUserDefinedFunctionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUserDefinedFunctionCommandOutput) => void), - cb?: (err: any, data?: GetUserDefinedFunctionCommandOutput) => void - ): Promise | void { - const command = new GetUserDefinedFunctionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves multiple function definitions from the Data Catalog.

- */ - public getUserDefinedFunctions( + + /** + * @see {@link GetUserDefinedFunctionsCommand} + */ + getUserDefinedFunctions( args: GetUserDefinedFunctionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUserDefinedFunctions( + getUserDefinedFunctions( args: GetUserDefinedFunctionsCommandInput, cb: (err: any, data?: GetUserDefinedFunctionsCommandOutput) => void ): void; - public getUserDefinedFunctions( + getUserDefinedFunctions( args: GetUserDefinedFunctionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserDefinedFunctionsCommandOutput) => void ): void; - public getUserDefinedFunctions( - args: GetUserDefinedFunctionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUserDefinedFunctionsCommandOutput) => void), - cb?: (err: any, data?: GetUserDefinedFunctionsCommandOutput) => void - ): Promise | void { - const command = new GetUserDefinedFunctionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves resource metadata for a workflow.

- */ - public getWorkflow(args: GetWorkflowCommandInput, options?: __HttpHandlerOptions): Promise; - public getWorkflow(args: GetWorkflowCommandInput, cb: (err: any, data?: GetWorkflowCommandOutput) => void): void; - public getWorkflow( + + /** + * @see {@link GetWorkflowCommand} + */ + getWorkflow(args: GetWorkflowCommandInput, options?: __HttpHandlerOptions): Promise; + getWorkflow(args: GetWorkflowCommandInput, cb: (err: any, data?: GetWorkflowCommandOutput) => void): void; + getWorkflow( args: GetWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkflowCommandOutput) => void ): void; - public getWorkflow( - args: GetWorkflowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkflowCommandOutput) => void), - cb?: (err: any, data?: GetWorkflowCommandOutput) => void - ): Promise | void { - const command = new GetWorkflowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the metadata for a given workflow run.

- */ - public getWorkflowRun( + + /** + * @see {@link GetWorkflowRunCommand} + */ + getWorkflowRun( args: GetWorkflowRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWorkflowRun( - args: GetWorkflowRunCommandInput, - cb: (err: any, data?: GetWorkflowRunCommandOutput) => void - ): void; - public getWorkflowRun( + getWorkflowRun(args: GetWorkflowRunCommandInput, cb: (err: any, data?: GetWorkflowRunCommandOutput) => void): void; + getWorkflowRun( args: GetWorkflowRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkflowRunCommandOutput) => void ): void; - public getWorkflowRun( - args: GetWorkflowRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkflowRunCommandOutput) => void), - cb?: (err: any, data?: GetWorkflowRunCommandOutput) => void - ): Promise | void { - const command = new GetWorkflowRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the workflow run properties which were set during the run.

- */ - public getWorkflowRunProperties( + + /** + * @see {@link GetWorkflowRunPropertiesCommand} + */ + getWorkflowRunProperties( args: GetWorkflowRunPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWorkflowRunProperties( + getWorkflowRunProperties( args: GetWorkflowRunPropertiesCommandInput, cb: (err: any, data?: GetWorkflowRunPropertiesCommandOutput) => void ): void; - public getWorkflowRunProperties( + getWorkflowRunProperties( args: GetWorkflowRunPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkflowRunPropertiesCommandOutput) => void ): void; - public getWorkflowRunProperties( - args: GetWorkflowRunPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkflowRunPropertiesCommandOutput) => void), - cb?: (err: any, data?: GetWorkflowRunPropertiesCommandOutput) => void - ): Promise | void { - const command = new GetWorkflowRunPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves metadata for all runs of a given workflow.

- */ - public getWorkflowRuns( + + /** + * @see {@link GetWorkflowRunsCommand} + */ + getWorkflowRuns( args: GetWorkflowRunsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWorkflowRuns( - args: GetWorkflowRunsCommandInput, - cb: (err: any, data?: GetWorkflowRunsCommandOutput) => void - ): void; - public getWorkflowRuns( + getWorkflowRuns(args: GetWorkflowRunsCommandInput, cb: (err: any, data?: GetWorkflowRunsCommandOutput) => void): void; + getWorkflowRuns( args: GetWorkflowRunsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkflowRunsCommandOutput) => void ): void; - public getWorkflowRuns( - args: GetWorkflowRunsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkflowRunsCommandOutput) => void), - cb?: (err: any, data?: GetWorkflowRunsCommandOutput) => void - ): Promise | void { - const command = new GetWorkflowRunsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Imports an existing Amazon Athena Data Catalog to Glue.

- */ - public importCatalogToGlue( + + /** + * @see {@link ImportCatalogToGlueCommand} + */ + importCatalogToGlue( args: ImportCatalogToGlueCommandInput, options?: __HttpHandlerOptions ): Promise; - public importCatalogToGlue( + importCatalogToGlue( args: ImportCatalogToGlueCommandInput, cb: (err: any, data?: ImportCatalogToGlueCommandOutput) => void ): void; - public importCatalogToGlue( + importCatalogToGlue( args: ImportCatalogToGlueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportCatalogToGlueCommandOutput) => void ): void; - public importCatalogToGlue( - args: ImportCatalogToGlueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportCatalogToGlueCommandOutput) => void), - cb?: (err: any, data?: ImportCatalogToGlueCommandOutput) => void - ): Promise | void { - const command = new ImportCatalogToGlueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all the blueprint names in an account.

- */ - public listBlueprints( + + /** + * @see {@link ListBlueprintsCommand} + */ + listBlueprints( args: ListBlueprintsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBlueprints( - args: ListBlueprintsCommandInput, - cb: (err: any, data?: ListBlueprintsCommandOutput) => void - ): void; - public listBlueprints( + listBlueprints(args: ListBlueprintsCommandInput, cb: (err: any, data?: ListBlueprintsCommandOutput) => void): void; + listBlueprints( args: ListBlueprintsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBlueprintsCommandOutput) => void ): void; - public listBlueprints( - args: ListBlueprintsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBlueprintsCommandOutput) => void), - cb?: (err: any, data?: ListBlueprintsCommandOutput) => void - ): Promise | void { - const command = new ListBlueprintsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the names of all crawler resources in this Amazon Web Services account, or the - * resources with the specified tag. This operation allows you to see which - * resources are available in your account, and their names.

- *

This operation takes the optional Tags field, which you can use as a filter on - * the response so that tagged resources can be retrieved as a group. If you choose to use tags - * filtering, only resources with the tag are retrieved.

- */ - public listCrawlers( - args: ListCrawlersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listCrawlers(args: ListCrawlersCommandInput, cb: (err: any, data?: ListCrawlersCommandOutput) => void): void; - public listCrawlers( + + /** + * @see {@link ListCrawlersCommand} + */ + listCrawlers(args: ListCrawlersCommandInput, options?: __HttpHandlerOptions): Promise; + listCrawlers(args: ListCrawlersCommandInput, cb: (err: any, data?: ListCrawlersCommandOutput) => void): void; + listCrawlers( args: ListCrawlersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCrawlersCommandOutput) => void ): void; - public listCrawlers( - args: ListCrawlersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCrawlersCommandOutput) => void), - cb?: (err: any, data?: ListCrawlersCommandOutput) => void - ): Promise | void { - const command = new ListCrawlersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns all the crawls of a specified crawler. Returns only the crawls that have occurred since the launch date of the crawler history feature, and only retains up to 12 months of crawls. Older crawls will not be returned.

- *

You may use this API to:

- *
    - *
  • - *

    Retrive all the crawls of a specified crawler.

    - *
  • - *
  • - *

    Retrieve all the crawls of a specified crawler within a limited count.

    - *
  • - *
  • - *

    Retrieve all the crawls of a specified crawler in a specific time range.

    - *
  • - *
  • - *

    Retrieve all the crawls of a specified crawler with a particular state, crawl ID, or DPU hour value.

    - *
  • - *
- */ - public listCrawls(args: ListCrawlsCommandInput, options?: __HttpHandlerOptions): Promise; - public listCrawls(args: ListCrawlsCommandInput, cb: (err: any, data?: ListCrawlsCommandOutput) => void): void; - public listCrawls( + + /** + * @see {@link ListCrawlsCommand} + */ + listCrawls(args: ListCrawlsCommandInput, options?: __HttpHandlerOptions): Promise; + listCrawls(args: ListCrawlsCommandInput, cb: (err: any, data?: ListCrawlsCommandOutput) => void): void; + listCrawls( args: ListCrawlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCrawlsCommandOutput) => void ): void; - public listCrawls( - args: ListCrawlsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCrawlsCommandOutput) => void), - cb?: (err: any, data?: ListCrawlsCommandOutput) => void - ): Promise | void { - const command = new ListCrawlsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all the custom patterns that have been created.

- */ - public listCustomEntityTypes( + + /** + * @see {@link ListCustomEntityTypesCommand} + */ + listCustomEntityTypes( args: ListCustomEntityTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCustomEntityTypes( + listCustomEntityTypes( args: ListCustomEntityTypesCommandInput, cb: (err: any, data?: ListCustomEntityTypesCommandOutput) => void ): void; - public listCustomEntityTypes( + listCustomEntityTypes( args: ListCustomEntityTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCustomEntityTypesCommandOutput) => void ): void; - public listCustomEntityTypes( - args: ListCustomEntityTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCustomEntityTypesCommandOutput) => void), - cb?: (err: any, data?: ListCustomEntityTypesCommandOutput) => void - ): Promise | void { - const command = new ListCustomEntityTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns all data quality execution results for your account.

- */ - public listDataQualityResults( + + /** + * @see {@link ListDataQualityResultsCommand} + */ + listDataQualityResults( args: ListDataQualityResultsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDataQualityResults( + listDataQualityResults( args: ListDataQualityResultsCommandInput, cb: (err: any, data?: ListDataQualityResultsCommandOutput) => void ): void; - public listDataQualityResults( + listDataQualityResults( args: ListDataQualityResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataQualityResultsCommandOutput) => void ): void; - public listDataQualityResults( - args: ListDataQualityResultsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDataQualityResultsCommandOutput) => void), - cb?: (err: any, data?: ListDataQualityResultsCommandOutput) => void - ): Promise | void { - const command = new ListDataQualityResultsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the recommendation runs meeting the filter criteria.

- */ - public listDataQualityRuleRecommendationRuns( + + /** + * @see {@link ListDataQualityRuleRecommendationRunsCommand} + */ + listDataQualityRuleRecommendationRuns( args: ListDataQualityRuleRecommendationRunsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDataQualityRuleRecommendationRuns( + listDataQualityRuleRecommendationRuns( args: ListDataQualityRuleRecommendationRunsCommandInput, cb: (err: any, data?: ListDataQualityRuleRecommendationRunsCommandOutput) => void ): void; - public listDataQualityRuleRecommendationRuns( + listDataQualityRuleRecommendationRuns( args: ListDataQualityRuleRecommendationRunsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataQualityRuleRecommendationRunsCommandOutput) => void ): void; - public listDataQualityRuleRecommendationRuns( - args: ListDataQualityRuleRecommendationRunsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListDataQualityRuleRecommendationRunsCommandOutput) => void), - cb?: (err: any, data?: ListDataQualityRuleRecommendationRunsCommandOutput) => void - ): Promise | void { - const command = new ListDataQualityRuleRecommendationRunsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all the runs meeting the filter criteria, where a ruleset is evaluated against a data source.

- */ - public listDataQualityRulesetEvaluationRuns( + + /** + * @see {@link ListDataQualityRulesetEvaluationRunsCommand} + */ + listDataQualityRulesetEvaluationRuns( args: ListDataQualityRulesetEvaluationRunsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDataQualityRulesetEvaluationRuns( + listDataQualityRulesetEvaluationRuns( args: ListDataQualityRulesetEvaluationRunsCommandInput, cb: (err: any, data?: ListDataQualityRulesetEvaluationRunsCommandOutput) => void ): void; - public listDataQualityRulesetEvaluationRuns( + listDataQualityRulesetEvaluationRuns( args: ListDataQualityRulesetEvaluationRunsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataQualityRulesetEvaluationRunsCommandOutput) => void ): void; - public listDataQualityRulesetEvaluationRuns( - args: ListDataQualityRulesetEvaluationRunsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDataQualityRulesetEvaluationRunsCommandOutput) => void), - cb?: (err: any, data?: ListDataQualityRulesetEvaluationRunsCommandOutput) => void - ): Promise | void { - const command = new ListDataQualityRulesetEvaluationRunsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a paginated list of rulesets for the specified list of Glue tables.

- */ - public listDataQualityRulesets( + + /** + * @see {@link ListDataQualityRulesetsCommand} + */ + listDataQualityRulesets( args: ListDataQualityRulesetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDataQualityRulesets( + listDataQualityRulesets( args: ListDataQualityRulesetsCommandInput, cb: (err: any, data?: ListDataQualityRulesetsCommandOutput) => void ): void; - public listDataQualityRulesets( + listDataQualityRulesets( args: ListDataQualityRulesetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataQualityRulesetsCommandOutput) => void ): void; - public listDataQualityRulesets( - args: ListDataQualityRulesetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDataQualityRulesetsCommandOutput) => void), - cb?: (err: any, data?: ListDataQualityRulesetsCommandOutput) => void - ): Promise | void { - const command = new ListDataQualityRulesetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the names of all DevEndpoint resources in this Amazon Web Services account, or the - * resources with the specified tag. This operation allows you to see which resources are - * available in your account, and their names.

- *

This operation takes the optional Tags field, which you can use as a filter on - * the response so that tagged resources can be retrieved as a group. If you choose to use tags - * filtering, only resources with the tag are retrieved.

- */ - public listDevEndpoints( + + /** + * @see {@link ListDevEndpointsCommand} + */ + listDevEndpoints( args: ListDevEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDevEndpoints( + listDevEndpoints( args: ListDevEndpointsCommandInput, cb: (err: any, data?: ListDevEndpointsCommandOutput) => void ): void; - public listDevEndpoints( + listDevEndpoints( args: ListDevEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDevEndpointsCommandOutput) => void ): void; - public listDevEndpoints( - args: ListDevEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDevEndpointsCommandOutput) => void), - cb?: (err: any, data?: ListDevEndpointsCommandOutput) => void - ): Promise | void { - const command = new ListDevEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the names of all job resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

- *

This operation takes the optional Tags field, which you can use as a filter on - * the response so that tagged resources can be retrieved as a group. If you choose to use tags - * filtering, only resources with the tag are retrieved.

- */ - public listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise; - public listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void; - public listJobs( + + /** + * @see {@link ListJobsCommand} + */ + listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise; + listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void; + listJobs( args: ListJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobsCommandOutput) => void ): void; - public listJobs( - args: ListJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJobsCommandOutput) => void), - cb?: (err: any, data?: ListJobsCommandOutput) => void - ): Promise | void { - const command = new ListJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a sortable, filterable list of existing Glue machine learning transforms in this Amazon Web Services account, - * or the resources with the specified tag. This operation takes the optional Tags field, which you can use as - * a filter of the responses so that tagged resources can be retrieved as a group. If you choose to use tag - * filtering, only resources with the tags are retrieved. - *

- */ - public listMLTransforms( + + /** + * @see {@link ListMLTransformsCommand} + */ + listMLTransforms( args: ListMLTransformsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMLTransforms( + listMLTransforms( args: ListMLTransformsCommandInput, cb: (err: any, data?: ListMLTransformsCommandOutput) => void ): void; - public listMLTransforms( + listMLTransforms( args: ListMLTransformsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMLTransformsCommandOutput) => void ): void; - public listMLTransforms( - args: ListMLTransformsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMLTransformsCommandOutput) => void), - cb?: (err: any, data?: ListMLTransformsCommandOutput) => void - ): Promise | void { - const command = new ListMLTransformsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of registries that you have created, with minimal registry information. Registries in the Deleting status will not be included in the results. Empty results will be returned if there are no registries available.

- */ - public listRegistries( + + /** + * @see {@link ListRegistriesCommand} + */ + listRegistries( args: ListRegistriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRegistries( - args: ListRegistriesCommandInput, - cb: (err: any, data?: ListRegistriesCommandOutput) => void - ): void; - public listRegistries( + listRegistries(args: ListRegistriesCommandInput, cb: (err: any, data?: ListRegistriesCommandOutput) => void): void; + listRegistries( args: ListRegistriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRegistriesCommandOutput) => void ): void; - public listRegistries( - args: ListRegistriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRegistriesCommandOutput) => void), - cb?: (err: any, data?: ListRegistriesCommandOutput) => void - ): Promise | void { - const command = new ListRegistriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of schemas with minimal details. Schemas in Deleting status will not be included in the results. Empty results will be returned if there are no schemas available.

- *

When the RegistryId is not provided, all the schemas across registries will be part of the API response.

- */ - public listSchemas(args: ListSchemasCommandInput, options?: __HttpHandlerOptions): Promise; - public listSchemas(args: ListSchemasCommandInput, cb: (err: any, data?: ListSchemasCommandOutput) => void): void; - public listSchemas( + + /** + * @see {@link ListSchemasCommand} + */ + listSchemas(args: ListSchemasCommandInput, options?: __HttpHandlerOptions): Promise; + listSchemas(args: ListSchemasCommandInput, cb: (err: any, data?: ListSchemasCommandOutput) => void): void; + listSchemas( args: ListSchemasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSchemasCommandOutput) => void ): void; - public listSchemas( - args: ListSchemasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSchemasCommandOutput) => void), - cb?: (err: any, data?: ListSchemasCommandOutput) => void - ): Promise | void { - const command = new ListSchemasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of schema versions that you have created, with minimal information. Schema versions in Deleted status will not be included in the results. Empty results will be returned if there are no schema versions available.

- */ - public listSchemaVersions( + + /** + * @see {@link ListSchemaVersionsCommand} + */ + listSchemaVersions( args: ListSchemaVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSchemaVersions( + listSchemaVersions( args: ListSchemaVersionsCommandInput, cb: (err: any, data?: ListSchemaVersionsCommandOutput) => void ): void; - public listSchemaVersions( + listSchemaVersions( args: ListSchemaVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSchemaVersionsCommandOutput) => void ): void; - public listSchemaVersions( - args: ListSchemaVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSchemaVersionsCommandOutput) => void), - cb?: (err: any, data?: ListSchemaVersionsCommandOutput) => void - ): Promise | void { - const command = new ListSchemaVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieve a list of sessions.

- */ - public listSessions( - args: ListSessionsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listSessions(args: ListSessionsCommandInput, cb: (err: any, data?: ListSessionsCommandOutput) => void): void; - public listSessions( + + /** + * @see {@link ListSessionsCommand} + */ + listSessions(args: ListSessionsCommandInput, options?: __HttpHandlerOptions): Promise; + listSessions(args: ListSessionsCommandInput, cb: (err: any, data?: ListSessionsCommandOutput) => void): void; + listSessions( args: ListSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSessionsCommandOutput) => void ): void; - public listSessions( - args: ListSessionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSessionsCommandOutput) => void), - cb?: (err: any, data?: ListSessionsCommandOutput) => void - ): Promise | void { - const command = new ListSessionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists statements for the session.

- */ - public listStatements( + + /** + * @see {@link ListStatementsCommand} + */ + listStatements( args: ListStatementsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStatements( - args: ListStatementsCommandInput, - cb: (err: any, data?: ListStatementsCommandOutput) => void - ): void; - public listStatements( + listStatements(args: ListStatementsCommandInput, cb: (err: any, data?: ListStatementsCommandOutput) => void): void; + listStatements( args: ListStatementsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStatementsCommandOutput) => void ): void; - public listStatements( - args: ListStatementsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStatementsCommandOutput) => void), - cb?: (err: any, data?: ListStatementsCommandOutput) => void - ): Promise | void { - const command = new ListStatementsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the names of all trigger resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

- *

This operation takes the optional Tags field, which you can use as a filter on - * the response so that tagged resources can be retrieved as a group. If you choose to use tags - * filtering, only resources with the tag are retrieved.

- */ - public listTriggers( - args: ListTriggersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listTriggers(args: ListTriggersCommandInput, cb: (err: any, data?: ListTriggersCommandOutput) => void): void; - public listTriggers( + + /** + * @see {@link ListTriggersCommand} + */ + listTriggers(args: ListTriggersCommandInput, options?: __HttpHandlerOptions): Promise; + listTriggers(args: ListTriggersCommandInput, cb: (err: any, data?: ListTriggersCommandOutput) => void): void; + listTriggers( args: ListTriggersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTriggersCommandOutput) => void ): void; - public listTriggers( - args: ListTriggersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTriggersCommandOutput) => void), - cb?: (err: any, data?: ListTriggersCommandOutput) => void - ): Promise | void { - const command = new ListTriggersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists names of workflows created in the account.

- */ - public listWorkflows( - args: ListWorkflowsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listWorkflows( - args: ListWorkflowsCommandInput, - cb: (err: any, data?: ListWorkflowsCommandOutput) => void - ): void; - public listWorkflows( + + /** + * @see {@link ListWorkflowsCommand} + */ + listWorkflows(args: ListWorkflowsCommandInput, options?: __HttpHandlerOptions): Promise; + listWorkflows(args: ListWorkflowsCommandInput, cb: (err: any, data?: ListWorkflowsCommandOutput) => void): void; + listWorkflows( args: ListWorkflowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkflowsCommandOutput) => void ): void; - public listWorkflows( - args: ListWorkflowsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkflowsCommandOutput) => void), - cb?: (err: any, data?: ListWorkflowsCommandOutput) => void - ): Promise | void { - const command = new ListWorkflowsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the security configuration for a specified catalog. After the configuration has been - * set, the specified encryption is applied to every catalog write thereafter.

- */ - public putDataCatalogEncryptionSettings( + + /** + * @see {@link PutDataCatalogEncryptionSettingsCommand} + */ + putDataCatalogEncryptionSettings( args: PutDataCatalogEncryptionSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putDataCatalogEncryptionSettings( + putDataCatalogEncryptionSettings( args: PutDataCatalogEncryptionSettingsCommandInput, cb: (err: any, data?: PutDataCatalogEncryptionSettingsCommandOutput) => void ): void; - public putDataCatalogEncryptionSettings( + putDataCatalogEncryptionSettings( args: PutDataCatalogEncryptionSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDataCatalogEncryptionSettingsCommandOutput) => void ): void; - public putDataCatalogEncryptionSettings( - args: PutDataCatalogEncryptionSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutDataCatalogEncryptionSettingsCommandOutput) => void), - cb?: (err: any, data?: PutDataCatalogEncryptionSettingsCommandOutput) => void - ): Promise | void { - const command = new PutDataCatalogEncryptionSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the Data Catalog resource policy for access control.

- */ - public putResourcePolicy( + + /** + * @see {@link PutResourcePolicyCommand} + */ + putResourcePolicy( args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( - args: PutResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: PutResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new PutResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Puts the metadata key value pair for a specified schema version ID. A maximum of 10 key value pairs will be allowed per schema version. They can be added over one or more calls.

- */ - public putSchemaVersionMetadata( + + /** + * @see {@link PutSchemaVersionMetadataCommand} + */ + putSchemaVersionMetadata( args: PutSchemaVersionMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public putSchemaVersionMetadata( + putSchemaVersionMetadata( args: PutSchemaVersionMetadataCommandInput, cb: (err: any, data?: PutSchemaVersionMetadataCommandOutput) => void ): void; - public putSchemaVersionMetadata( + putSchemaVersionMetadata( args: PutSchemaVersionMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSchemaVersionMetadataCommandOutput) => void ): void; - public putSchemaVersionMetadata( - args: PutSchemaVersionMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutSchemaVersionMetadataCommandOutput) => void), - cb?: (err: any, data?: PutSchemaVersionMetadataCommandOutput) => void - ): Promise | void { - const command = new PutSchemaVersionMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Puts the specified workflow run properties for the given workflow run. If a property already exists for the specified run, then it overrides the value otherwise adds the property to existing properties.

- */ - public putWorkflowRunProperties( + + /** + * @see {@link PutWorkflowRunPropertiesCommand} + */ + putWorkflowRunProperties( args: PutWorkflowRunPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putWorkflowRunProperties( + putWorkflowRunProperties( args: PutWorkflowRunPropertiesCommandInput, cb: (err: any, data?: PutWorkflowRunPropertiesCommandOutput) => void ): void; - public putWorkflowRunProperties( + putWorkflowRunProperties( args: PutWorkflowRunPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutWorkflowRunPropertiesCommandOutput) => void ): void; - public putWorkflowRunProperties( - args: PutWorkflowRunPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutWorkflowRunPropertiesCommandOutput) => void), - cb?: (err: any, data?: PutWorkflowRunPropertiesCommandOutput) => void - ): Promise | void { - const command = new PutWorkflowRunPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Queries for the schema version metadata information.

- */ - public querySchemaVersionMetadata( + + /** + * @see {@link QuerySchemaVersionMetadataCommand} + */ + querySchemaVersionMetadata( args: QuerySchemaVersionMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public querySchemaVersionMetadata( + querySchemaVersionMetadata( args: QuerySchemaVersionMetadataCommandInput, cb: (err: any, data?: QuerySchemaVersionMetadataCommandOutput) => void ): void; - public querySchemaVersionMetadata( + querySchemaVersionMetadata( args: QuerySchemaVersionMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QuerySchemaVersionMetadataCommandOutput) => void ): void; - public querySchemaVersionMetadata( - args: QuerySchemaVersionMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QuerySchemaVersionMetadataCommandOutput) => void), - cb?: (err: any, data?: QuerySchemaVersionMetadataCommandOutput) => void - ): Promise | void { - const command = new QuerySchemaVersionMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds a new version to the existing schema. Returns an error if new version of schema does not meet the compatibility requirements of the schema set. This API will not create a new schema set and will return a 404 error if the schema set is not already present in the Schema Registry.

- *

If this is the first schema definition to be registered in the Schema Registry, this API will store the schema version and return immediately. Otherwise, this call has the potential to run longer than other operations due to compatibility modes. You can call the GetSchemaVersion API with the SchemaVersionId to check compatibility modes.

- *

If the same schema definition is already stored in Schema Registry as a version, the schema ID of the existing schema is returned to the caller.

- */ - public registerSchemaVersion( + + /** + * @see {@link RegisterSchemaVersionCommand} + */ + registerSchemaVersion( args: RegisterSchemaVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerSchemaVersion( + registerSchemaVersion( args: RegisterSchemaVersionCommandInput, cb: (err: any, data?: RegisterSchemaVersionCommandOutput) => void ): void; - public registerSchemaVersion( + registerSchemaVersion( args: RegisterSchemaVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterSchemaVersionCommandOutput) => void ): void; - public registerSchemaVersion( - args: RegisterSchemaVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterSchemaVersionCommandOutput) => void), - cb?: (err: any, data?: RegisterSchemaVersionCommandOutput) => void - ): Promise | void { - const command = new RegisterSchemaVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a key value pair from the schema version metadata for the specified schema version ID.

- */ - public removeSchemaVersionMetadata( + + /** + * @see {@link RemoveSchemaVersionMetadataCommand} + */ + removeSchemaVersionMetadata( args: RemoveSchemaVersionMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeSchemaVersionMetadata( + removeSchemaVersionMetadata( args: RemoveSchemaVersionMetadataCommandInput, cb: (err: any, data?: RemoveSchemaVersionMetadataCommandOutput) => void ): void; - public removeSchemaVersionMetadata( + removeSchemaVersionMetadata( args: RemoveSchemaVersionMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveSchemaVersionMetadataCommandOutput) => void ): void; - public removeSchemaVersionMetadata( - args: RemoveSchemaVersionMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveSchemaVersionMetadataCommandOutput) => void), - cb?: (err: any, data?: RemoveSchemaVersionMetadataCommandOutput) => void - ): Promise | void { - const command = new RemoveSchemaVersionMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Resets a bookmark entry.

- *

For more information about enabling and using job bookmarks, see:

- * - */ - public resetJobBookmark( + + /** + * @see {@link ResetJobBookmarkCommand} + */ + resetJobBookmark( args: ResetJobBookmarkCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetJobBookmark( + resetJobBookmark( args: ResetJobBookmarkCommandInput, cb: (err: any, data?: ResetJobBookmarkCommandOutput) => void ): void; - public resetJobBookmark( + resetJobBookmark( args: ResetJobBookmarkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetJobBookmarkCommandOutput) => void ): void; - public resetJobBookmark( - args: ResetJobBookmarkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetJobBookmarkCommandOutput) => void), - cb?: (err: any, data?: ResetJobBookmarkCommandOutput) => void - ): Promise | void { - const command = new ResetJobBookmarkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Restarts selected nodes of a previous partially completed workflow run and resumes the workflow run. The selected nodes and all nodes that are downstream from the selected nodes are run.

- */ - public resumeWorkflowRun( + + /** + * @see {@link ResumeWorkflowRunCommand} + */ + resumeWorkflowRun( args: ResumeWorkflowRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public resumeWorkflowRun( + resumeWorkflowRun( args: ResumeWorkflowRunCommandInput, cb: (err: any, data?: ResumeWorkflowRunCommandOutput) => void ): void; - public resumeWorkflowRun( + resumeWorkflowRun( args: ResumeWorkflowRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResumeWorkflowRunCommandOutput) => void ): void; - public resumeWorkflowRun( - args: ResumeWorkflowRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResumeWorkflowRunCommandOutput) => void), - cb?: (err: any, data?: ResumeWorkflowRunCommandOutput) => void - ): Promise | void { - const command = new ResumeWorkflowRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Executes the statement.

- */ - public runStatement( - args: RunStatementCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public runStatement(args: RunStatementCommandInput, cb: (err: any, data?: RunStatementCommandOutput) => void): void; - public runStatement( + + /** + * @see {@link RunStatementCommand} + */ + runStatement(args: RunStatementCommandInput, options?: __HttpHandlerOptions): Promise; + runStatement(args: RunStatementCommandInput, cb: (err: any, data?: RunStatementCommandOutput) => void): void; + runStatement( args: RunStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RunStatementCommandOutput) => void ): void; - public runStatement( - args: RunStatementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RunStatementCommandOutput) => void), - cb?: (err: any, data?: RunStatementCommandOutput) => void - ): Promise | void { - const command = new RunStatementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Searches a set of tables based on properties in the table metadata as well as on the parent database. You can search against text or filter conditions.

- *

You can only get tables that you have access to based on the security policies defined in Lake Formation. You need at least a read-only access to the table for it to be returned. If you do not have access to all the columns in the table, these columns will not be searched against when returning the list of tables back to you. If you have access to the columns but not the data in the columns, those columns and the associated metadata for those columns will be included in the search.

- */ - public searchTables( - args: SearchTablesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public searchTables(args: SearchTablesCommandInput, cb: (err: any, data?: SearchTablesCommandOutput) => void): void; - public searchTables( + + /** + * @see {@link SearchTablesCommand} + */ + searchTables(args: SearchTablesCommandInput, options?: __HttpHandlerOptions): Promise; + searchTables(args: SearchTablesCommandInput, cb: (err: any, data?: SearchTablesCommandOutput) => void): void; + searchTables( args: SearchTablesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchTablesCommandOutput) => void ): void; - public searchTables( - args: SearchTablesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchTablesCommandOutput) => void), - cb?: (err: any, data?: SearchTablesCommandOutput) => void - ): Promise | void { - const command = new SearchTablesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a new run of the specified blueprint.

- */ - public startBlueprintRun( + + /** + * @see {@link StartBlueprintRunCommand} + */ + startBlueprintRun( args: StartBlueprintRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public startBlueprintRun( + startBlueprintRun( args: StartBlueprintRunCommandInput, cb: (err: any, data?: StartBlueprintRunCommandOutput) => void ): void; - public startBlueprintRun( + startBlueprintRun( args: StartBlueprintRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartBlueprintRunCommandOutput) => void ): void; - public startBlueprintRun( - args: StartBlueprintRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartBlueprintRunCommandOutput) => void), - cb?: (err: any, data?: StartBlueprintRunCommandOutput) => void - ): Promise | void { - const command = new StartBlueprintRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a crawl using the specified crawler, regardless - * of what is scheduled. If the crawler is already running, returns a - * CrawlerRunningException.

- */ - public startCrawler( - args: StartCrawlerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public startCrawler(args: StartCrawlerCommandInput, cb: (err: any, data?: StartCrawlerCommandOutput) => void): void; - public startCrawler( + + /** + * @see {@link StartCrawlerCommand} + */ + startCrawler(args: StartCrawlerCommandInput, options?: __HttpHandlerOptions): Promise; + startCrawler(args: StartCrawlerCommandInput, cb: (err: any, data?: StartCrawlerCommandOutput) => void): void; + startCrawler( args: StartCrawlerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCrawlerCommandOutput) => void ): void; - public startCrawler( - args: StartCrawlerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartCrawlerCommandOutput) => void), - cb?: (err: any, data?: StartCrawlerCommandOutput) => void - ): Promise | void { - const command = new StartCrawlerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Changes the schedule state of the specified crawler to - * SCHEDULED, unless the crawler is already running or the - * schedule state is already SCHEDULED.

- */ - public startCrawlerSchedule( + + /** + * @see {@link StartCrawlerScheduleCommand} + */ + startCrawlerSchedule( args: StartCrawlerScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public startCrawlerSchedule( + startCrawlerSchedule( args: StartCrawlerScheduleCommandInput, cb: (err: any, data?: StartCrawlerScheduleCommandOutput) => void ): void; - public startCrawlerSchedule( + startCrawlerSchedule( args: StartCrawlerScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCrawlerScheduleCommandOutput) => void ): void; - public startCrawlerSchedule( - args: StartCrawlerScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartCrawlerScheduleCommandOutput) => void), - cb?: (err: any, data?: StartCrawlerScheduleCommandOutput) => void - ): Promise | void { - const command = new StartCrawlerScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a recommendation run that is used to generate rules when you don't know what rules to write. Glue Data Quality analyzes the data and comes up with recommendations for a potential ruleset. You can then triage the ruleset and modify the generated ruleset to your liking.

- */ - public startDataQualityRuleRecommendationRun( + + /** + * @see {@link StartDataQualityRuleRecommendationRunCommand} + */ + startDataQualityRuleRecommendationRun( args: StartDataQualityRuleRecommendationRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDataQualityRuleRecommendationRun( + startDataQualityRuleRecommendationRun( args: StartDataQualityRuleRecommendationRunCommandInput, cb: (err: any, data?: StartDataQualityRuleRecommendationRunCommandOutput) => void ): void; - public startDataQualityRuleRecommendationRun( + startDataQualityRuleRecommendationRun( args: StartDataQualityRuleRecommendationRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDataQualityRuleRecommendationRunCommandOutput) => void ): void; - public startDataQualityRuleRecommendationRun( - args: StartDataQualityRuleRecommendationRunCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: StartDataQualityRuleRecommendationRunCommandOutput) => void), - cb?: (err: any, data?: StartDataQualityRuleRecommendationRunCommandOutput) => void - ): Promise | void { - const command = new StartDataQualityRuleRecommendationRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Once you have a ruleset definition (either recommended or your own), you call this operation to evaluate the ruleset against a data source (Glue table). The evaluation computes results which you can retrieve with the GetDataQualityResult API.

- */ - public startDataQualityRulesetEvaluationRun( + + /** + * @see {@link StartDataQualityRulesetEvaluationRunCommand} + */ + startDataQualityRulesetEvaluationRun( args: StartDataQualityRulesetEvaluationRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDataQualityRulesetEvaluationRun( + startDataQualityRulesetEvaluationRun( args: StartDataQualityRulesetEvaluationRunCommandInput, cb: (err: any, data?: StartDataQualityRulesetEvaluationRunCommandOutput) => void ): void; - public startDataQualityRulesetEvaluationRun( + startDataQualityRulesetEvaluationRun( args: StartDataQualityRulesetEvaluationRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDataQualityRulesetEvaluationRunCommandOutput) => void ): void; - public startDataQualityRulesetEvaluationRun( - args: StartDataQualityRulesetEvaluationRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDataQualityRulesetEvaluationRunCommandOutput) => void), - cb?: (err: any, data?: StartDataQualityRulesetEvaluationRunCommandOutput) => void - ): Promise | void { - const command = new StartDataQualityRulesetEvaluationRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Begins an asynchronous task to export all labeled data for a particular transform. This - * task is the only label-related API call that is not part of the typical active learning - * workflow. You typically use StartExportLabelsTaskRun when you want to work with - * all of your existing labels at the same time, such as when you want to remove or change labels - * that were previously submitted as truth. This API operation accepts the - * TransformId whose labels you want to export and an Amazon Simple Storage - * Service (Amazon S3) path to export the labels to. The operation returns a - * TaskRunId. You can check on the status of your task run by calling the - * GetMLTaskRun API.

- */ - public startExportLabelsTaskRun( + + /** + * @see {@link StartExportLabelsTaskRunCommand} + */ + startExportLabelsTaskRun( args: StartExportLabelsTaskRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public startExportLabelsTaskRun( + startExportLabelsTaskRun( args: StartExportLabelsTaskRunCommandInput, cb: (err: any, data?: StartExportLabelsTaskRunCommandOutput) => void ): void; - public startExportLabelsTaskRun( + startExportLabelsTaskRun( args: StartExportLabelsTaskRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartExportLabelsTaskRunCommandOutput) => void ): void; - public startExportLabelsTaskRun( - args: StartExportLabelsTaskRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartExportLabelsTaskRunCommandOutput) => void), - cb?: (err: any, data?: StartExportLabelsTaskRunCommandOutput) => void - ): Promise | void { - const command = new StartExportLabelsTaskRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables you to provide additional labels (examples of truth) to be used to teach the - * machine learning transform and improve its quality. This API operation is generally used as - * part of the active learning workflow that starts with the - * StartMLLabelingSetGenerationTaskRun call and that ultimately results in - * improving the quality of your machine learning transform.

- *

After the StartMLLabelingSetGenerationTaskRun finishes, Glue machine learning - * will have generated a series of questions for humans to answer. (Answering these questions is - * often called 'labeling' in the machine learning workflows). In the case of the - * FindMatches transform, these questions are of the form, “What is the correct - * way to group these rows together into groups composed entirely of matching records?” After the - * labeling process is finished, users upload their answers/labels with a call to - * StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes, - * all future runs of the machine learning transform use the new and improved labels and perform - * a higher-quality transformation.

- *

By default, StartMLLabelingSetGenerationTaskRun continually learns from and - * combines all labels that you upload unless you set Replace to true. If you set - * Replace to true, StartImportLabelsTaskRun deletes and forgets all - * previously uploaded labels and learns only from the exact set that you upload. Replacing - * labels can be helpful if you realize that you previously uploaded incorrect labels, and you - * believe that they are having a negative effect on your transform quality.

- *

You can check on the status of your task run by calling the GetMLTaskRun - * operation.

- */ - public startImportLabelsTaskRun( + + /** + * @see {@link StartImportLabelsTaskRunCommand} + */ + startImportLabelsTaskRun( args: StartImportLabelsTaskRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public startImportLabelsTaskRun( + startImportLabelsTaskRun( args: StartImportLabelsTaskRunCommandInput, cb: (err: any, data?: StartImportLabelsTaskRunCommandOutput) => void ): void; - public startImportLabelsTaskRun( + startImportLabelsTaskRun( args: StartImportLabelsTaskRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartImportLabelsTaskRunCommandOutput) => void ): void; - public startImportLabelsTaskRun( - args: StartImportLabelsTaskRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartImportLabelsTaskRunCommandOutput) => void), - cb?: (err: any, data?: StartImportLabelsTaskRunCommandOutput) => void - ): Promise | void { - const command = new StartImportLabelsTaskRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a job run using a job definition.

- */ - public startJobRun(args: StartJobRunCommandInput, options?: __HttpHandlerOptions): Promise; - public startJobRun(args: StartJobRunCommandInput, cb: (err: any, data?: StartJobRunCommandOutput) => void): void; - public startJobRun( + + /** + * @see {@link StartJobRunCommand} + */ + startJobRun(args: StartJobRunCommandInput, options?: __HttpHandlerOptions): Promise; + startJobRun(args: StartJobRunCommandInput, cb: (err: any, data?: StartJobRunCommandOutput) => void): void; + startJobRun( args: StartJobRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartJobRunCommandOutput) => void ): void; - public startJobRun( - args: StartJobRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartJobRunCommandOutput) => void), - cb?: (err: any, data?: StartJobRunCommandOutput) => void - ): Promise | void { - const command = new StartJobRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a task to estimate the quality of the transform.

- *

When you provide label sets as examples of truth, Glue machine learning uses some of - * those examples to learn from them. The rest of the labels are used as a test to estimate - * quality.

- *

Returns a unique identifier for the run. You can call GetMLTaskRun to get more - * information about the stats of the EvaluationTaskRun.

- */ - public startMLEvaluationTaskRun( + + /** + * @see {@link StartMLEvaluationTaskRunCommand} + */ + startMLEvaluationTaskRun( args: StartMLEvaluationTaskRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public startMLEvaluationTaskRun( + startMLEvaluationTaskRun( args: StartMLEvaluationTaskRunCommandInput, cb: (err: any, data?: StartMLEvaluationTaskRunCommandOutput) => void ): void; - public startMLEvaluationTaskRun( + startMLEvaluationTaskRun( args: StartMLEvaluationTaskRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMLEvaluationTaskRunCommandOutput) => void ): void; - public startMLEvaluationTaskRun( - args: StartMLEvaluationTaskRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartMLEvaluationTaskRunCommandOutput) => void), - cb?: (err: any, data?: StartMLEvaluationTaskRunCommandOutput) => void - ): Promise | void { - const command = new StartMLEvaluationTaskRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts the active learning workflow for your machine learning transform to improve the - * transform's quality by generating label sets and adding labels.

- *

When the StartMLLabelingSetGenerationTaskRun finishes, Glue will have - * generated a "labeling set" or a set of questions for humans to answer.

- *

In the case of the FindMatches transform, these questions are of the form, - * “What is the correct way to group these rows together into groups composed entirely of - * matching records?”

- *

After the labeling process is finished, you can upload your labels with a call to - * StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes, - * all future runs of the machine learning transform will use the new and improved labels and - * perform a higher-quality transformation.

- */ - public startMLLabelingSetGenerationTaskRun( + + /** + * @see {@link StartMLLabelingSetGenerationTaskRunCommand} + */ + startMLLabelingSetGenerationTaskRun( args: StartMLLabelingSetGenerationTaskRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public startMLLabelingSetGenerationTaskRun( + startMLLabelingSetGenerationTaskRun( args: StartMLLabelingSetGenerationTaskRunCommandInput, cb: (err: any, data?: StartMLLabelingSetGenerationTaskRunCommandOutput) => void ): void; - public startMLLabelingSetGenerationTaskRun( + startMLLabelingSetGenerationTaskRun( args: StartMLLabelingSetGenerationTaskRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMLLabelingSetGenerationTaskRunCommandOutput) => void ): void; - public startMLLabelingSetGenerationTaskRun( - args: StartMLLabelingSetGenerationTaskRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartMLLabelingSetGenerationTaskRunCommandOutput) => void), - cb?: (err: any, data?: StartMLLabelingSetGenerationTaskRunCommandOutput) => void - ): Promise | void { - const command = new StartMLLabelingSetGenerationTaskRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts an existing trigger. See Triggering - * Jobs for information about how different types of trigger are - * started.

- */ - public startTrigger( - args: StartTriggerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public startTrigger(args: StartTriggerCommandInput, cb: (err: any, data?: StartTriggerCommandOutput) => void): void; - public startTrigger( + + /** + * @see {@link StartTriggerCommand} + */ + startTrigger(args: StartTriggerCommandInput, options?: __HttpHandlerOptions): Promise; + startTrigger(args: StartTriggerCommandInput, cb: (err: any, data?: StartTriggerCommandOutput) => void): void; + startTrigger( args: StartTriggerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTriggerCommandOutput) => void ): void; - public startTrigger( - args: StartTriggerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartTriggerCommandOutput) => void), - cb?: (err: any, data?: StartTriggerCommandOutput) => void - ): Promise | void { - const command = new StartTriggerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a new run of the specified workflow.

- */ - public startWorkflowRun( + + /** + * @see {@link StartWorkflowRunCommand} + */ + startWorkflowRun( args: StartWorkflowRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public startWorkflowRun( + startWorkflowRun( args: StartWorkflowRunCommandInput, cb: (err: any, data?: StartWorkflowRunCommandOutput) => void ): void; - public startWorkflowRun( + startWorkflowRun( args: StartWorkflowRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartWorkflowRunCommandOutput) => void ): void; - public startWorkflowRun( - args: StartWorkflowRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartWorkflowRunCommandOutput) => void), - cb?: (err: any, data?: StartWorkflowRunCommandOutput) => void - ): Promise | void { - const command = new StartWorkflowRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

If the specified crawler is running, stops the crawl.

- */ - public stopCrawler(args: StopCrawlerCommandInput, options?: __HttpHandlerOptions): Promise; - public stopCrawler(args: StopCrawlerCommandInput, cb: (err: any, data?: StopCrawlerCommandOutput) => void): void; - public stopCrawler( + + /** + * @see {@link StopCrawlerCommand} + */ + stopCrawler(args: StopCrawlerCommandInput, options?: __HttpHandlerOptions): Promise; + stopCrawler(args: StopCrawlerCommandInput, cb: (err: any, data?: StopCrawlerCommandOutput) => void): void; + stopCrawler( args: StopCrawlerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopCrawlerCommandOutput) => void ): void; - public stopCrawler( - args: StopCrawlerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopCrawlerCommandOutput) => void), - cb?: (err: any, data?: StopCrawlerCommandOutput) => void - ): Promise | void { - const command = new StopCrawlerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the schedule state of the specified crawler to - * NOT_SCHEDULED, but does not stop the crawler if it is - * already running.

- */ - public stopCrawlerSchedule( + + /** + * @see {@link StopCrawlerScheduleCommand} + */ + stopCrawlerSchedule( args: StopCrawlerScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopCrawlerSchedule( + stopCrawlerSchedule( args: StopCrawlerScheduleCommandInput, cb: (err: any, data?: StopCrawlerScheduleCommandOutput) => void ): void; - public stopCrawlerSchedule( + stopCrawlerSchedule( args: StopCrawlerScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopCrawlerScheduleCommandOutput) => void ): void; - public stopCrawlerSchedule( - args: StopCrawlerScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopCrawlerScheduleCommandOutput) => void), - cb?: (err: any, data?: StopCrawlerScheduleCommandOutput) => void - ): Promise | void { - const command = new StopCrawlerScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops the session.

- */ - public stopSession(args: StopSessionCommandInput, options?: __HttpHandlerOptions): Promise; - public stopSession(args: StopSessionCommandInput, cb: (err: any, data?: StopSessionCommandOutput) => void): void; - public stopSession( + + /** + * @see {@link StopSessionCommand} + */ + stopSession(args: StopSessionCommandInput, options?: __HttpHandlerOptions): Promise; + stopSession(args: StopSessionCommandInput, cb: (err: any, data?: StopSessionCommandOutput) => void): void; + stopSession( args: StopSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopSessionCommandOutput) => void ): void; - public stopSession( - args: StopSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopSessionCommandOutput) => void), - cb?: (err: any, data?: StopSessionCommandOutput) => void - ): Promise | void { - const command = new StopSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a specified trigger.

- */ - public stopTrigger(args: StopTriggerCommandInput, options?: __HttpHandlerOptions): Promise; - public stopTrigger(args: StopTriggerCommandInput, cb: (err: any, data?: StopTriggerCommandOutput) => void): void; - public stopTrigger( + + /** + * @see {@link StopTriggerCommand} + */ + stopTrigger(args: StopTriggerCommandInput, options?: __HttpHandlerOptions): Promise; + stopTrigger(args: StopTriggerCommandInput, cb: (err: any, data?: StopTriggerCommandOutput) => void): void; + stopTrigger( args: StopTriggerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopTriggerCommandOutput) => void ): void; - public stopTrigger( - args: StopTriggerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopTriggerCommandOutput) => void), - cb?: (err: any, data?: StopTriggerCommandOutput) => void - ): Promise | void { - const command = new StopTriggerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops the execution of the specified workflow run.

- */ - public stopWorkflowRun( + + /** + * @see {@link StopWorkflowRunCommand} + */ + stopWorkflowRun( args: StopWorkflowRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopWorkflowRun( - args: StopWorkflowRunCommandInput, - cb: (err: any, data?: StopWorkflowRunCommandOutput) => void - ): void; - public stopWorkflowRun( + stopWorkflowRun(args: StopWorkflowRunCommandInput, cb: (err: any, data?: StopWorkflowRunCommandOutput) => void): void; + stopWorkflowRun( args: StopWorkflowRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopWorkflowRunCommandOutput) => void ): void; - public stopWorkflowRun( - args: StopWorkflowRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopWorkflowRunCommandOutput) => void), - cb?: (err: any, data?: StopWorkflowRunCommandOutput) => void - ): Promise | void { - const command = new StopWorkflowRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds tags to a resource. A tag is a label you can assign to an Amazon Web Services resource. - * In Glue, you can tag only certain resources. For information about what - * resources you can tag, see Amazon Web Services Tags in Glue.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes tags from a resource.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a registered blueprint.

- */ - public updateBlueprint( + + /** + * @see {@link UpdateBlueprintCommand} + */ + updateBlueprint( args: UpdateBlueprintCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBlueprint( - args: UpdateBlueprintCommandInput, - cb: (err: any, data?: UpdateBlueprintCommandOutput) => void - ): void; - public updateBlueprint( + updateBlueprint(args: UpdateBlueprintCommandInput, cb: (err: any, data?: UpdateBlueprintCommandOutput) => void): void; + updateBlueprint( args: UpdateBlueprintCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBlueprintCommandOutput) => void ): void; - public updateBlueprint( - args: UpdateBlueprintCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBlueprintCommandOutput) => void), - cb?: (err: any, data?: UpdateBlueprintCommandOutput) => void - ): Promise | void { - const command = new UpdateBlueprintCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies an existing classifier (a GrokClassifier, - * an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on - * which field is present).

- */ - public updateClassifier( + + /** + * @see {@link UpdateClassifierCommand} + */ + updateClassifier( args: UpdateClassifierCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateClassifier( + updateClassifier( args: UpdateClassifierCommandInput, cb: (err: any, data?: UpdateClassifierCommandOutput) => void ): void; - public updateClassifier( + updateClassifier( args: UpdateClassifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateClassifierCommandOutput) => void ): void; - public updateClassifier( - args: UpdateClassifierCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateClassifierCommandOutput) => void), - cb?: (err: any, data?: UpdateClassifierCommandOutput) => void - ): Promise | void { - const command = new UpdateClassifierCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or updates partition statistics of columns.

- *

The Identity and Access Management (IAM) permission required for this operation is UpdatePartition.

- */ - public updateColumnStatisticsForPartition( + + /** + * @see {@link UpdateColumnStatisticsForPartitionCommand} + */ + updateColumnStatisticsForPartition( args: UpdateColumnStatisticsForPartitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateColumnStatisticsForPartition( + updateColumnStatisticsForPartition( args: UpdateColumnStatisticsForPartitionCommandInput, cb: (err: any, data?: UpdateColumnStatisticsForPartitionCommandOutput) => void ): void; - public updateColumnStatisticsForPartition( + updateColumnStatisticsForPartition( args: UpdateColumnStatisticsForPartitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateColumnStatisticsForPartitionCommandOutput) => void ): void; - public updateColumnStatisticsForPartition( - args: UpdateColumnStatisticsForPartitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateColumnStatisticsForPartitionCommandOutput) => void), - cb?: (err: any, data?: UpdateColumnStatisticsForPartitionCommandOutput) => void - ): Promise | void { - const command = new UpdateColumnStatisticsForPartitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or updates table statistics of columns.

- *

The Identity and Access Management (IAM) permission required for this operation is UpdateTable.

- */ - public updateColumnStatisticsForTable( + + /** + * @see {@link UpdateColumnStatisticsForTableCommand} + */ + updateColumnStatisticsForTable( args: UpdateColumnStatisticsForTableCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateColumnStatisticsForTable( + updateColumnStatisticsForTable( args: UpdateColumnStatisticsForTableCommandInput, cb: (err: any, data?: UpdateColumnStatisticsForTableCommandOutput) => void ): void; - public updateColumnStatisticsForTable( + updateColumnStatisticsForTable( args: UpdateColumnStatisticsForTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateColumnStatisticsForTableCommandOutput) => void ): void; - public updateColumnStatisticsForTable( - args: UpdateColumnStatisticsForTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateColumnStatisticsForTableCommandOutput) => void), - cb?: (err: any, data?: UpdateColumnStatisticsForTableCommandOutput) => void - ): Promise | void { - const command = new UpdateColumnStatisticsForTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a connection definition in the Data Catalog.

- */ - public updateConnection( + + /** + * @see {@link UpdateConnectionCommand} + */ + updateConnection( args: UpdateConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConnection( + updateConnection( args: UpdateConnectionCommandInput, cb: (err: any, data?: UpdateConnectionCommandOutput) => void ): void; - public updateConnection( + updateConnection( args: UpdateConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectionCommandOutput) => void ): void; - public updateConnection( - args: UpdateConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConnectionCommandOutput) => void), - cb?: (err: any, data?: UpdateConnectionCommandOutput) => void - ): Promise | void { - const command = new UpdateConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a crawler. If a crawler is - * running, you must stop it using StopCrawler before updating - * it.

- */ - public updateCrawler( - args: UpdateCrawlerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateCrawler( - args: UpdateCrawlerCommandInput, - cb: (err: any, data?: UpdateCrawlerCommandOutput) => void - ): void; - public updateCrawler( + + /** + * @see {@link UpdateCrawlerCommand} + */ + updateCrawler(args: UpdateCrawlerCommandInput, options?: __HttpHandlerOptions): Promise; + updateCrawler(args: UpdateCrawlerCommandInput, cb: (err: any, data?: UpdateCrawlerCommandOutput) => void): void; + updateCrawler( args: UpdateCrawlerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCrawlerCommandOutput) => void ): void; - public updateCrawler( - args: UpdateCrawlerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCrawlerCommandOutput) => void), - cb?: (err: any, data?: UpdateCrawlerCommandOutput) => void - ): Promise | void { - const command = new UpdateCrawlerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the schedule of a crawler using a cron expression.

- */ - public updateCrawlerSchedule( + + /** + * @see {@link UpdateCrawlerScheduleCommand} + */ + updateCrawlerSchedule( args: UpdateCrawlerScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCrawlerSchedule( + updateCrawlerSchedule( args: UpdateCrawlerScheduleCommandInput, cb: (err: any, data?: UpdateCrawlerScheduleCommandOutput) => void ): void; - public updateCrawlerSchedule( + updateCrawlerSchedule( args: UpdateCrawlerScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCrawlerScheduleCommandOutput) => void ): void; - public updateCrawlerSchedule( - args: UpdateCrawlerScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCrawlerScheduleCommandOutput) => void), - cb?: (err: any, data?: UpdateCrawlerScheduleCommandOutput) => void - ): Promise | void { - const command = new UpdateCrawlerScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing database definition in a Data Catalog.

- */ - public updateDatabase( + + /** + * @see {@link UpdateDatabaseCommand} + */ + updateDatabase( args: UpdateDatabaseCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDatabase( - args: UpdateDatabaseCommandInput, - cb: (err: any, data?: UpdateDatabaseCommandOutput) => void - ): void; - public updateDatabase( + updateDatabase(args: UpdateDatabaseCommandInput, cb: (err: any, data?: UpdateDatabaseCommandOutput) => void): void; + updateDatabase( args: UpdateDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDatabaseCommandOutput) => void ): void; - public updateDatabase( - args: UpdateDatabaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDatabaseCommandOutput) => void), - cb?: (err: any, data?: UpdateDatabaseCommandOutput) => void - ): Promise | void { - const command = new UpdateDatabaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the specified data quality ruleset.

- */ - public updateDataQualityRuleset( + + /** + * @see {@link UpdateDataQualityRulesetCommand} + */ + updateDataQualityRuleset( args: UpdateDataQualityRulesetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDataQualityRuleset( + updateDataQualityRuleset( args: UpdateDataQualityRulesetCommandInput, cb: (err: any, data?: UpdateDataQualityRulesetCommandOutput) => void ): void; - public updateDataQualityRuleset( + updateDataQualityRuleset( args: UpdateDataQualityRulesetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDataQualityRulesetCommandOutput) => void ): void; - public updateDataQualityRuleset( - args: UpdateDataQualityRulesetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDataQualityRulesetCommandOutput) => void), - cb?: (err: any, data?: UpdateDataQualityRulesetCommandOutput) => void - ): Promise | void { - const command = new UpdateDataQualityRulesetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a specified development endpoint.

- */ - public updateDevEndpoint( + + /** + * @see {@link UpdateDevEndpointCommand} + */ + updateDevEndpoint( args: UpdateDevEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDevEndpoint( + updateDevEndpoint( args: UpdateDevEndpointCommandInput, cb: (err: any, data?: UpdateDevEndpointCommandOutput) => void ): void; - public updateDevEndpoint( + updateDevEndpoint( args: UpdateDevEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDevEndpointCommandOutput) => void ): void; - public updateDevEndpoint( - args: UpdateDevEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDevEndpointCommandOutput) => void), - cb?: (err: any, data?: UpdateDevEndpointCommandOutput) => void - ): Promise | void { - const command = new UpdateDevEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing job definition. The previous job definition is completely overwritten by this information.

- */ - public updateJob(args: UpdateJobCommandInput, options?: __HttpHandlerOptions): Promise; - public updateJob(args: UpdateJobCommandInput, cb: (err: any, data?: UpdateJobCommandOutput) => void): void; - public updateJob( + + /** + * @see {@link UpdateJobCommand} + */ + updateJob(args: UpdateJobCommandInput, options?: __HttpHandlerOptions): Promise; + updateJob(args: UpdateJobCommandInput, cb: (err: any, data?: UpdateJobCommandOutput) => void): void; + updateJob( args: UpdateJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateJobCommandOutput) => void ): void; - public updateJob( - args: UpdateJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateJobCommandOutput) => void), - cb?: (err: any, data?: UpdateJobCommandOutput) => void - ): Promise | void { - const command = new UpdateJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Synchronizes a job from the source control repository. This operation takes the job artifacts that are located in the remote repository and updates the Glue internal stores with these artifacts.

- *

This API supports optional parameters which take in the repository information.

- */ - public updateJobFromSourceControl( + + /** + * @see {@link UpdateJobFromSourceControlCommand} + */ + updateJobFromSourceControl( args: UpdateJobFromSourceControlCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateJobFromSourceControl( + updateJobFromSourceControl( args: UpdateJobFromSourceControlCommandInput, cb: (err: any, data?: UpdateJobFromSourceControlCommandOutput) => void ): void; - public updateJobFromSourceControl( + updateJobFromSourceControl( args: UpdateJobFromSourceControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateJobFromSourceControlCommandOutput) => void ): void; - public updateJobFromSourceControl( - args: UpdateJobFromSourceControlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateJobFromSourceControlCommandOutput) => void), - cb?: (err: any, data?: UpdateJobFromSourceControlCommandOutput) => void - ): Promise | void { - const command = new UpdateJobFromSourceControlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing machine learning transform. Call this operation to tune the algorithm parameters to achieve better results.

- *

After calling this operation, you can call the StartMLEvaluationTaskRun - * operation to assess how well your new parameters achieved your goals (such as improving the - * quality of your machine learning transform, or making it more cost-effective).

- */ - public updateMLTransform( + + /** + * @see {@link UpdateMLTransformCommand} + */ + updateMLTransform( args: UpdateMLTransformCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMLTransform( + updateMLTransform( args: UpdateMLTransformCommandInput, cb: (err: any, data?: UpdateMLTransformCommandOutput) => void ): void; - public updateMLTransform( + updateMLTransform( args: UpdateMLTransformCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMLTransformCommandOutput) => void ): void; - public updateMLTransform( - args: UpdateMLTransformCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMLTransformCommandOutput) => void), - cb?: (err: any, data?: UpdateMLTransformCommandOutput) => void - ): Promise | void { - const command = new UpdateMLTransformCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a partition.

- */ - public updatePartition( + + /** + * @see {@link UpdatePartitionCommand} + */ + updatePartition( args: UpdatePartitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePartition( - args: UpdatePartitionCommandInput, - cb: (err: any, data?: UpdatePartitionCommandOutput) => void - ): void; - public updatePartition( + updatePartition(args: UpdatePartitionCommandInput, cb: (err: any, data?: UpdatePartitionCommandOutput) => void): void; + updatePartition( args: UpdatePartitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePartitionCommandOutput) => void ): void; - public updatePartition( - args: UpdatePartitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePartitionCommandOutput) => void), - cb?: (err: any, data?: UpdatePartitionCommandOutput) => void - ): Promise | void { - const command = new UpdatePartitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing registry which is used to hold a collection of schemas. The updated properties relate to the registry, and do not modify any of the schemas within the registry.

- */ - public updateRegistry( + + /** + * @see {@link UpdateRegistryCommand} + */ + updateRegistry( args: UpdateRegistryCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRegistry( - args: UpdateRegistryCommandInput, - cb: (err: any, data?: UpdateRegistryCommandOutput) => void - ): void; - public updateRegistry( + updateRegistry(args: UpdateRegistryCommandInput, cb: (err: any, data?: UpdateRegistryCommandOutput) => void): void; + updateRegistry( args: UpdateRegistryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRegistryCommandOutput) => void ): void; - public updateRegistry( - args: UpdateRegistryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRegistryCommandOutput) => void), - cb?: (err: any, data?: UpdateRegistryCommandOutput) => void - ): Promise | void { - const command = new UpdateRegistryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the description, compatibility setting, or version checkpoint for a schema set.

- *

For updating the compatibility setting, the call will not validate compatibility for the entire set of schema versions with the new compatibility setting. If the value for Compatibility is provided, the VersionNumber (a checkpoint) is also required. The API will validate the checkpoint version number for consistency.

- *

If the value for the VersionNumber (checkpoint) is provided, Compatibility is optional and this can be used to set/reset a checkpoint for the schema.

- *

This update will happen only if the schema is in the AVAILABLE state.

- */ - public updateSchema( - args: UpdateSchemaCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateSchema(args: UpdateSchemaCommandInput, cb: (err: any, data?: UpdateSchemaCommandOutput) => void): void; - public updateSchema( + + /** + * @see {@link UpdateSchemaCommand} + */ + updateSchema(args: UpdateSchemaCommandInput, options?: __HttpHandlerOptions): Promise; + updateSchema(args: UpdateSchemaCommandInput, cb: (err: any, data?: UpdateSchemaCommandOutput) => void): void; + updateSchema( args: UpdateSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSchemaCommandOutput) => void ): void; - public updateSchema( - args: UpdateSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSchemaCommandOutput) => void), - cb?: (err: any, data?: UpdateSchemaCommandOutput) => void - ): Promise | void { - const command = new UpdateSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Synchronizes a job to the source control repository. This operation takes the job artifacts from the Glue internal stores and makes a commit to the remote repository that is configured on the job.

- *

This API supports optional parameters which take in the repository information.

- */ - public updateSourceControlFromJob( + + /** + * @see {@link UpdateSourceControlFromJobCommand} + */ + updateSourceControlFromJob( args: UpdateSourceControlFromJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSourceControlFromJob( + updateSourceControlFromJob( args: UpdateSourceControlFromJobCommandInput, cb: (err: any, data?: UpdateSourceControlFromJobCommandOutput) => void ): void; - public updateSourceControlFromJob( + updateSourceControlFromJob( args: UpdateSourceControlFromJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSourceControlFromJobCommandOutput) => void ): void; - public updateSourceControlFromJob( - args: UpdateSourceControlFromJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSourceControlFromJobCommandOutput) => void), - cb?: (err: any, data?: UpdateSourceControlFromJobCommandOutput) => void - ): Promise | void { - const command = new UpdateSourceControlFromJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a metadata table in the Data Catalog.

- */ - public updateTable(args: UpdateTableCommandInput, options?: __HttpHandlerOptions): Promise; - public updateTable(args: UpdateTableCommandInput, cb: (err: any, data?: UpdateTableCommandOutput) => void): void; - public updateTable( + + /** + * @see {@link UpdateTableCommand} + */ + updateTable(args: UpdateTableCommandInput, options?: __HttpHandlerOptions): Promise; + updateTable(args: UpdateTableCommandInput, cb: (err: any, data?: UpdateTableCommandOutput) => void): void; + updateTable( args: UpdateTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTableCommandOutput) => void ): void; - public updateTable( - args: UpdateTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTableCommandOutput) => void), - cb?: (err: any, data?: UpdateTableCommandOutput) => void - ): Promise | void { - const command = new UpdateTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a trigger definition.

- */ - public updateTrigger( - args: UpdateTriggerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateTrigger( - args: UpdateTriggerCommandInput, - cb: (err: any, data?: UpdateTriggerCommandOutput) => void - ): void; - public updateTrigger( + + /** + * @see {@link UpdateTriggerCommand} + */ + updateTrigger(args: UpdateTriggerCommandInput, options?: __HttpHandlerOptions): Promise; + updateTrigger(args: UpdateTriggerCommandInput, cb: (err: any, data?: UpdateTriggerCommandOutput) => void): void; + updateTrigger( args: UpdateTriggerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTriggerCommandOutput) => void ): void; - public updateTrigger( - args: UpdateTriggerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTriggerCommandOutput) => void), - cb?: (err: any, data?: UpdateTriggerCommandOutput) => void - ): Promise | void { - const command = new UpdateTriggerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing function definition in the Data Catalog.

- */ - public updateUserDefinedFunction( + + /** + * @see {@link UpdateUserDefinedFunctionCommand} + */ + updateUserDefinedFunction( args: UpdateUserDefinedFunctionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateUserDefinedFunction( + updateUserDefinedFunction( args: UpdateUserDefinedFunctionCommandInput, cb: (err: any, data?: UpdateUserDefinedFunctionCommandOutput) => void ): void; - public updateUserDefinedFunction( + updateUserDefinedFunction( args: UpdateUserDefinedFunctionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserDefinedFunctionCommandOutput) => void ): void; - public updateUserDefinedFunction( - args: UpdateUserDefinedFunctionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserDefinedFunctionCommandOutput) => void), - cb?: (err: any, data?: UpdateUserDefinedFunctionCommandOutput) => void - ): Promise | void { - const command = new UpdateUserDefinedFunctionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing workflow.

- */ - public updateWorkflow( + + /** + * @see {@link UpdateWorkflowCommand} + */ + updateWorkflow( args: UpdateWorkflowCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWorkflow( - args: UpdateWorkflowCommandInput, - cb: (err: any, data?: UpdateWorkflowCommandOutput) => void - ): void; - public updateWorkflow( + updateWorkflow(args: UpdateWorkflowCommandInput, cb: (err: any, data?: UpdateWorkflowCommandOutput) => void): void; + updateWorkflow( args: UpdateWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkflowCommandOutput) => void ): void; - public updateWorkflow( - args: UpdateWorkflowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWorkflowCommandOutput) => void), - cb?: (err: any, data?: UpdateWorkflowCommandOutput) => void - ): Promise | void { - const command = new UpdateWorkflowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Glue + *

Defines the public endpoint for the Glue service.

+ */ +export class Glue extends GlueClient implements Glue {} +createAggregatedClient(commands, Glue); diff --git a/clients/client-grafana/src/Grafana.ts b/clients/client-grafana/src/Grafana.ts index 608efd42dc37..f140311a7d41 100644 --- a/clients/client-grafana/src/Grafana.ts +++ b/clients/client-grafana/src/Grafana.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -87,643 +88,321 @@ import { UpdateWorkspaceConfigurationCommandInput, UpdateWorkspaceConfigurationCommandOutput, } from "./commands/UpdateWorkspaceConfigurationCommand"; -import { GrafanaClient } from "./GrafanaClient"; +import { GrafanaClient, GrafanaClientConfig } from "./GrafanaClient"; -/** - * @public - *

Amazon Managed Grafana is a fully managed and secure data visualization service that - * you can use to instantly query, correlate, and visualize operational metrics, logs, and - * traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and - * scale Grafana, a widely deployed data visualization tool that is popular for its - * extensible data support.

- *

With Amazon Managed Grafana, you create logically isolated Grafana servers called - * workspaces. In a workspace, you can create Grafana dashboards - * and visualizations to analyze your metrics, logs, and traces without having to build, - * package, or deploy any hardware to run Grafana servers.

- */ -export class Grafana extends GrafanaClient { +const commands = { + AssociateLicenseCommand, + CreateWorkspaceCommand, + CreateWorkspaceApiKeyCommand, + DeleteWorkspaceCommand, + DeleteWorkspaceApiKeyCommand, + DescribeWorkspaceCommand, + DescribeWorkspaceAuthenticationCommand, + DescribeWorkspaceConfigurationCommand, + DisassociateLicenseCommand, + ListPermissionsCommand, + ListTagsForResourceCommand, + ListWorkspacesCommand, + TagResourceCommand, + UntagResourceCommand, + UpdatePermissionsCommand, + UpdateWorkspaceCommand, + UpdateWorkspaceAuthenticationCommand, + UpdateWorkspaceConfigurationCommand, +}; + +export interface Grafana { /** - * @public - *

Assigns a Grafana Enterprise license to a workspace. Upgrading to Grafana Enterprise - * incurs additional fees. For more information, see Upgrade a - * workspace to Grafana Enterprise.

+ * @see {@link AssociateLicenseCommand} */ - public associateLicense( + associateLicense( args: AssociateLicenseCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateLicense( + associateLicense( args: AssociateLicenseCommandInput, cb: (err: any, data?: AssociateLicenseCommandOutput) => void ): void; - public associateLicense( + associateLicense( args: AssociateLicenseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateLicenseCommandOutput) => void ): void; - public associateLicense( - args: AssociateLicenseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateLicenseCommandOutput) => void), - cb?: (err: any, data?: AssociateLicenseCommandOutput) => void - ): Promise | void { - const command = new AssociateLicenseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a workspace. In a workspace, you can create Grafana - * dashboards and visualizations to analyze your metrics, logs, and traces. You don't have - * to build, package, or deploy any hardware to run the Grafana server.

- *

Don't use CreateWorkspace to modify an existing workspace. Instead, use - * UpdateWorkspace.

+ * @see {@link CreateWorkspaceCommand} */ - public createWorkspace( + createWorkspace( args: CreateWorkspaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorkspace( - args: CreateWorkspaceCommandInput, - cb: (err: any, data?: CreateWorkspaceCommandOutput) => void - ): void; - public createWorkspace( + createWorkspace(args: CreateWorkspaceCommandInput, cb: (err: any, data?: CreateWorkspaceCommandOutput) => void): void; + createWorkspace( args: CreateWorkspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkspaceCommandOutput) => void ): void; - public createWorkspace( - args: CreateWorkspaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorkspaceCommandOutput) => void), - cb?: (err: any, data?: CreateWorkspaceCommandOutput) => void - ): Promise | void { - const command = new CreateWorkspaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a Grafana API key for the workspace. This key can be used to authenticate - * requests sent to the workspace's HTTP API. See https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html - * for available APIs and example requests.

+ * @see {@link CreateWorkspaceApiKeyCommand} */ - public createWorkspaceApiKey( + createWorkspaceApiKey( args: CreateWorkspaceApiKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorkspaceApiKey( + createWorkspaceApiKey( args: CreateWorkspaceApiKeyCommandInput, cb: (err: any, data?: CreateWorkspaceApiKeyCommandOutput) => void ): void; - public createWorkspaceApiKey( + createWorkspaceApiKey( args: CreateWorkspaceApiKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkspaceApiKeyCommandOutput) => void ): void; - public createWorkspaceApiKey( - args: CreateWorkspaceApiKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorkspaceApiKeyCommandOutput) => void), - cb?: (err: any, data?: CreateWorkspaceApiKeyCommandOutput) => void - ): Promise | void { - const command = new CreateWorkspaceApiKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon Managed Grafana workspace.

+ * @see {@link DeleteWorkspaceCommand} */ - public deleteWorkspace( + deleteWorkspace( args: DeleteWorkspaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWorkspace( - args: DeleteWorkspaceCommandInput, - cb: (err: any, data?: DeleteWorkspaceCommandOutput) => void - ): void; - public deleteWorkspace( + deleteWorkspace(args: DeleteWorkspaceCommandInput, cb: (err: any, data?: DeleteWorkspaceCommandOutput) => void): void; + deleteWorkspace( args: DeleteWorkspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkspaceCommandOutput) => void ): void; - public deleteWorkspace( - args: DeleteWorkspaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorkspaceCommandOutput) => void), - cb?: (err: any, data?: DeleteWorkspaceCommandOutput) => void - ): Promise | void { - const command = new DeleteWorkspaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Grafana API key for the workspace.

+ * @see {@link DeleteWorkspaceApiKeyCommand} */ - public deleteWorkspaceApiKey( + deleteWorkspaceApiKey( args: DeleteWorkspaceApiKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWorkspaceApiKey( + deleteWorkspaceApiKey( args: DeleteWorkspaceApiKeyCommandInput, cb: (err: any, data?: DeleteWorkspaceApiKeyCommandOutput) => void ): void; - public deleteWorkspaceApiKey( + deleteWorkspaceApiKey( args: DeleteWorkspaceApiKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkspaceApiKeyCommandOutput) => void ): void; - public deleteWorkspaceApiKey( - args: DeleteWorkspaceApiKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorkspaceApiKeyCommandOutput) => void), - cb?: (err: any, data?: DeleteWorkspaceApiKeyCommandOutput) => void - ): Promise | void { - const command = new DeleteWorkspaceApiKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays information about one Amazon Managed Grafana workspace.

+ * @see {@link DescribeWorkspaceCommand} */ - public describeWorkspace( + describeWorkspace( args: DescribeWorkspaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWorkspace( + describeWorkspace( args: DescribeWorkspaceCommandInput, cb: (err: any, data?: DescribeWorkspaceCommandOutput) => void ): void; - public describeWorkspace( + describeWorkspace( args: DescribeWorkspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspaceCommandOutput) => void ): void; - public describeWorkspace( - args: DescribeWorkspaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWorkspaceCommandOutput) => void), - cb?: (err: any, data?: DescribeWorkspaceCommandOutput) => void - ): Promise | void { - const command = new DescribeWorkspaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays information about the authentication methods used in one Amazon Managed Grafana - * workspace.

+ * @see {@link DescribeWorkspaceAuthenticationCommand} */ - public describeWorkspaceAuthentication( + describeWorkspaceAuthentication( args: DescribeWorkspaceAuthenticationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWorkspaceAuthentication( + describeWorkspaceAuthentication( args: DescribeWorkspaceAuthenticationCommandInput, cb: (err: any, data?: DescribeWorkspaceAuthenticationCommandOutput) => void ): void; - public describeWorkspaceAuthentication( + describeWorkspaceAuthentication( args: DescribeWorkspaceAuthenticationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspaceAuthenticationCommandOutput) => void ): void; - public describeWorkspaceAuthentication( - args: DescribeWorkspaceAuthenticationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWorkspaceAuthenticationCommandOutput) => void), - cb?: (err: any, data?: DescribeWorkspaceAuthenticationCommandOutput) => void - ): Promise | void { - const command = new DescribeWorkspaceAuthenticationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the current configuration string for the given workspace.

+ * @see {@link DescribeWorkspaceConfigurationCommand} */ - public describeWorkspaceConfiguration( + describeWorkspaceConfiguration( args: DescribeWorkspaceConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWorkspaceConfiguration( + describeWorkspaceConfiguration( args: DescribeWorkspaceConfigurationCommandInput, cb: (err: any, data?: DescribeWorkspaceConfigurationCommandOutput) => void ): void; - public describeWorkspaceConfiguration( + describeWorkspaceConfiguration( args: DescribeWorkspaceConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspaceConfigurationCommandOutput) => void ): void; - public describeWorkspaceConfiguration( - args: DescribeWorkspaceConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWorkspaceConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeWorkspaceConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeWorkspaceConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the Grafana Enterprise license from a workspace.

+ * @see {@link DisassociateLicenseCommand} */ - public disassociateLicense( + disassociateLicense( args: DisassociateLicenseCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateLicense( + disassociateLicense( args: DisassociateLicenseCommandInput, cb: (err: any, data?: DisassociateLicenseCommandOutput) => void ): void; - public disassociateLicense( + disassociateLicense( args: DisassociateLicenseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateLicenseCommandOutput) => void ): void; - public disassociateLicense( - args: DisassociateLicenseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateLicenseCommandOutput) => void), - cb?: (err: any, data?: DisassociateLicenseCommandOutput) => void - ): Promise | void { - const command = new DisassociateLicenseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the users and groups who have the Grafana Admin and - * Editor roles in this workspace. If you use this operation without - * specifying userId or groupId, the operation returns the roles - * of all users and groups. If you specify a userId or a groupId, - * only the roles for that user or group are returned. If you do this, you can specify only - * one userId or one groupId.

+ * @see {@link ListPermissionsCommand} */ - public listPermissions( + listPermissions( args: ListPermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPermissions( - args: ListPermissionsCommandInput, - cb: (err: any, data?: ListPermissionsCommandOutput) => void - ): void; - public listPermissions( + listPermissions(args: ListPermissionsCommandInput, cb: (err: any, data?: ListPermissionsCommandOutput) => void): void; + listPermissions( args: ListPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPermissionsCommandOutput) => void ): void; - public listPermissions( - args: ListPermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPermissionsCommandOutput) => void), - cb?: (err: any, data?: ListPermissionsCommandOutput) => void - ): Promise | void { - const command = new ListPermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The ListTagsForResource operation returns the tags that are associated - * with the Amazon Managed Service for Grafana resource specified by the - * resourceArn. Currently, the only resource that can be tagged is a - * workspace.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of Amazon Managed Grafana workspaces in the account, with some information - * about each workspace. For more complete information about one workspace, use DescribeWorkspace.

+ * @see {@link ListWorkspacesCommand} */ - public listWorkspaces( + listWorkspaces( args: ListWorkspacesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWorkspaces( - args: ListWorkspacesCommandInput, - cb: (err: any, data?: ListWorkspacesCommandOutput) => void - ): void; - public listWorkspaces( + listWorkspaces(args: ListWorkspacesCommandInput, cb: (err: any, data?: ListWorkspacesCommandOutput) => void): void; + listWorkspaces( args: ListWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkspacesCommandOutput) => void ): void; - public listWorkspaces( - args: ListWorkspacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkspacesCommandOutput) => void), - cb?: (err: any, data?: ListWorkspacesCommandOutput) => void - ): Promise | void { - const command = new ListWorkspacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The TagResource operation associates tags with an Amazon Managed Grafana - * resource. Currently, the only resource that can be tagged is workspaces.

- *

If you specify a new tag key for the resource, this tag is appended to the list of - * tags associated with the resource. If you specify a tag key that is already associated - * with the resource, the new tag value that you specify replaces the previous value for - * that tag.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The UntagResource operation removes the association of the tag with the - * Amazon Managed Grafana resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates which users in a workspace have the Grafana Admin or - * Editor roles.

+ * @see {@link UpdatePermissionsCommand} */ - public updatePermissions( + updatePermissions( args: UpdatePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePermissions( + updatePermissions( args: UpdatePermissionsCommandInput, cb: (err: any, data?: UpdatePermissionsCommandOutput) => void ): void; - public updatePermissions( + updatePermissions( args: UpdatePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePermissionsCommandOutput) => void ): void; - public updatePermissions( - args: UpdatePermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePermissionsCommandOutput) => void), - cb?: (err: any, data?: UpdatePermissionsCommandOutput) => void - ): Promise | void { - const command = new UpdatePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit - * any optional parameters, the existing values of those parameters are not changed.

- *

To modify the user authentication methods that the workspace uses, such as SAML or - * IAM Identity Center, use UpdateWorkspaceAuthentication.

- *

To modify which users in the workspace have the Admin and - * Editor Grafana roles, use UpdatePermissions.

+ * @see {@link UpdateWorkspaceCommand} */ - public updateWorkspace( + updateWorkspace( args: UpdateWorkspaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWorkspace( - args: UpdateWorkspaceCommandInput, - cb: (err: any, data?: UpdateWorkspaceCommandOutput) => void - ): void; - public updateWorkspace( + updateWorkspace(args: UpdateWorkspaceCommandInput, cb: (err: any, data?: UpdateWorkspaceCommandOutput) => void): void; + updateWorkspace( args: UpdateWorkspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkspaceCommandOutput) => void ): void; - public updateWorkspace( - args: UpdateWorkspaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWorkspaceCommandOutput) => void), - cb?: (err: any, data?: UpdateWorkspaceCommandOutput) => void - ): Promise | void { - const command = new UpdateWorkspaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this operation to define the identity provider (IdP) that this workspace - * authenticates users from, using SAML. You can also map SAML assertion attributes to - * workspace user information and define which groups in the assertion attribute are to - * have the Admin and Editor roles in the workspace.

- * - *

Changes to the authentication method for a workspace may take a few minutes to - * take effect.

- *
+ * @see {@link UpdateWorkspaceAuthenticationCommand} */ - public updateWorkspaceAuthentication( + updateWorkspaceAuthentication( args: UpdateWorkspaceAuthenticationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWorkspaceAuthentication( + updateWorkspaceAuthentication( args: UpdateWorkspaceAuthenticationCommandInput, cb: (err: any, data?: UpdateWorkspaceAuthenticationCommandOutput) => void ): void; - public updateWorkspaceAuthentication( + updateWorkspaceAuthentication( args: UpdateWorkspaceAuthenticationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkspaceAuthenticationCommandOutput) => void ): void; - public updateWorkspaceAuthentication( - args: UpdateWorkspaceAuthenticationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWorkspaceAuthenticationCommandOutput) => void), - cb?: (err: any, data?: UpdateWorkspaceAuthenticationCommandOutput) => void - ): Promise | void { - const command = new UpdateWorkspaceAuthenticationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the configuration string for the given workspace

+ * @see {@link UpdateWorkspaceConfigurationCommand} */ - public updateWorkspaceConfiguration( + updateWorkspaceConfiguration( args: UpdateWorkspaceConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWorkspaceConfiguration( + updateWorkspaceConfiguration( args: UpdateWorkspaceConfigurationCommandInput, cb: (err: any, data?: UpdateWorkspaceConfigurationCommandOutput) => void ): void; - public updateWorkspaceConfiguration( + updateWorkspaceConfiguration( args: UpdateWorkspaceConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkspaceConfigurationCommandOutput) => void ): void; - public updateWorkspaceConfiguration( - args: UpdateWorkspaceConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWorkspaceConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateWorkspaceConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateWorkspaceConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Managed Grafana is a fully managed and secure data visualization service that + * you can use to instantly query, correlate, and visualize operational metrics, logs, and + * traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and + * scale Grafana, a widely deployed data visualization tool that is popular for its + * extensible data support.

+ *

With Amazon Managed Grafana, you create logically isolated Grafana servers called + * workspaces. In a workspace, you can create Grafana dashboards + * and visualizations to analyze your metrics, logs, and traces without having to build, + * package, or deploy any hardware to run Grafana servers.

+ */ +export class Grafana extends GrafanaClient implements Grafana {} +createAggregatedClient(commands, Grafana); diff --git a/clients/client-greengrass/src/Greengrass.ts b/clients/client-greengrass/src/Greengrass.ts index fd41160498fa..efa944d4f84c 100644 --- a/clients/client-greengrass/src/Greengrass.ts +++ b/clients/client-greengrass/src/Greengrass.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -437,3010 +438,1624 @@ import { UpdateThingRuntimeConfigurationCommandInput, UpdateThingRuntimeConfigurationCommandOutput, } from "./commands/UpdateThingRuntimeConfigurationCommand"; -import { GreengrassClient } from "./GreengrassClient"; +import { GreengrassClient, GreengrassClientConfig } from "./GreengrassClient"; -/** - * @public - * AWS IoT Greengrass seamlessly extends AWS onto physical devices so they can act locally on the data they generate, while still using the cloud for management, analytics, and durable storage. AWS IoT Greengrass ensures your devices can respond quickly to local events and operate with intermittent connectivity. AWS IoT Greengrass minimizes the cost of transmitting data to the cloud by allowing you to author AWS Lambda functions that execute locally. - */ -export class Greengrass extends GreengrassClient { +const commands = { + AssociateRoleToGroupCommand, + AssociateServiceRoleToAccountCommand, + CreateConnectorDefinitionCommand, + CreateConnectorDefinitionVersionCommand, + CreateCoreDefinitionCommand, + CreateCoreDefinitionVersionCommand, + CreateDeploymentCommand, + CreateDeviceDefinitionCommand, + CreateDeviceDefinitionVersionCommand, + CreateFunctionDefinitionCommand, + CreateFunctionDefinitionVersionCommand, + CreateGroupCommand, + CreateGroupCertificateAuthorityCommand, + CreateGroupVersionCommand, + CreateLoggerDefinitionCommand, + CreateLoggerDefinitionVersionCommand, + CreateResourceDefinitionCommand, + CreateResourceDefinitionVersionCommand, + CreateSoftwareUpdateJobCommand, + CreateSubscriptionDefinitionCommand, + CreateSubscriptionDefinitionVersionCommand, + DeleteConnectorDefinitionCommand, + DeleteCoreDefinitionCommand, + DeleteDeviceDefinitionCommand, + DeleteFunctionDefinitionCommand, + DeleteGroupCommand, + DeleteLoggerDefinitionCommand, + DeleteResourceDefinitionCommand, + DeleteSubscriptionDefinitionCommand, + DisassociateRoleFromGroupCommand, + DisassociateServiceRoleFromAccountCommand, + GetAssociatedRoleCommand, + GetBulkDeploymentStatusCommand, + GetConnectivityInfoCommand, + GetConnectorDefinitionCommand, + GetConnectorDefinitionVersionCommand, + GetCoreDefinitionCommand, + GetCoreDefinitionVersionCommand, + GetDeploymentStatusCommand, + GetDeviceDefinitionCommand, + GetDeviceDefinitionVersionCommand, + GetFunctionDefinitionCommand, + GetFunctionDefinitionVersionCommand, + GetGroupCommand, + GetGroupCertificateAuthorityCommand, + GetGroupCertificateConfigurationCommand, + GetGroupVersionCommand, + GetLoggerDefinitionCommand, + GetLoggerDefinitionVersionCommand, + GetResourceDefinitionCommand, + GetResourceDefinitionVersionCommand, + GetServiceRoleForAccountCommand, + GetSubscriptionDefinitionCommand, + GetSubscriptionDefinitionVersionCommand, + GetThingRuntimeConfigurationCommand, + ListBulkDeploymentDetailedReportsCommand, + ListBulkDeploymentsCommand, + ListConnectorDefinitionsCommand, + ListConnectorDefinitionVersionsCommand, + ListCoreDefinitionsCommand, + ListCoreDefinitionVersionsCommand, + ListDeploymentsCommand, + ListDeviceDefinitionsCommand, + ListDeviceDefinitionVersionsCommand, + ListFunctionDefinitionsCommand, + ListFunctionDefinitionVersionsCommand, + ListGroupCertificateAuthoritiesCommand, + ListGroupsCommand, + ListGroupVersionsCommand, + ListLoggerDefinitionsCommand, + ListLoggerDefinitionVersionsCommand, + ListResourceDefinitionsCommand, + ListResourceDefinitionVersionsCommand, + ListSubscriptionDefinitionsCommand, + ListSubscriptionDefinitionVersionsCommand, + ListTagsForResourceCommand, + ResetDeploymentsCommand, + StartBulkDeploymentCommand, + StopBulkDeploymentCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateConnectivityInfoCommand, + UpdateConnectorDefinitionCommand, + UpdateCoreDefinitionCommand, + UpdateDeviceDefinitionCommand, + UpdateFunctionDefinitionCommand, + UpdateGroupCommand, + UpdateGroupCertificateConfigurationCommand, + UpdateLoggerDefinitionCommand, + UpdateResourceDefinitionCommand, + UpdateSubscriptionDefinitionCommand, + UpdateThingRuntimeConfigurationCommand, +}; + +export interface Greengrass { /** - * @public - * Associates a role with a group. Your Greengrass core will use the role to access AWS cloud services. The role's permissions should allow Greengrass core Lambda functions to perform actions against the cloud. + * @see {@link AssociateRoleToGroupCommand} */ - public associateRoleToGroup( + associateRoleToGroup( args: AssociateRoleToGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateRoleToGroup( + associateRoleToGroup( args: AssociateRoleToGroupCommandInput, cb: (err: any, data?: AssociateRoleToGroupCommandOutput) => void ): void; - public associateRoleToGroup( + associateRoleToGroup( args: AssociateRoleToGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateRoleToGroupCommandOutput) => void ): void; - public associateRoleToGroup( - args: AssociateRoleToGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateRoleToGroupCommandOutput) => void), - cb?: (err: any, data?: AssociateRoleToGroupCommandOutput) => void - ): Promise | void { - const command = new AssociateRoleToGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Associates a role with your account. AWS IoT Greengrass will use the role to access your Lambda functions and AWS IoT resources. This is necessary for deployments to succeed. The role must have at least minimum permissions in the policy ''AWSGreengrassResourceAccessRolePolicy''. - */ - public associateServiceRoleToAccount( + + /** + * @see {@link AssociateServiceRoleToAccountCommand} + */ + associateServiceRoleToAccount( args: AssociateServiceRoleToAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateServiceRoleToAccount( + associateServiceRoleToAccount( args: AssociateServiceRoleToAccountCommandInput, cb: (err: any, data?: AssociateServiceRoleToAccountCommandOutput) => void ): void; - public associateServiceRoleToAccount( + associateServiceRoleToAccount( args: AssociateServiceRoleToAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateServiceRoleToAccountCommandOutput) => void ): void; - public associateServiceRoleToAccount( - args: AssociateServiceRoleToAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateServiceRoleToAccountCommandOutput) => void), - cb?: (err: any, data?: AssociateServiceRoleToAccountCommandOutput) => void - ): Promise | void { - const command = new AssociateServiceRoleToAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Creates a connector definition. You may provide the initial version of the connector definition now or use ''CreateConnectorDefinitionVersion'' at a later time. - */ - public createConnectorDefinition( + + /** + * @see {@link CreateConnectorDefinitionCommand} + */ + createConnectorDefinition( args: CreateConnectorDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConnectorDefinition( + createConnectorDefinition( args: CreateConnectorDefinitionCommandInput, cb: (err: any, data?: CreateConnectorDefinitionCommandOutput) => void ): void; - public createConnectorDefinition( + createConnectorDefinition( args: CreateConnectorDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectorDefinitionCommandOutput) => void ): void; - public createConnectorDefinition( - args: CreateConnectorDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConnectorDefinitionCommandOutput) => void), - cb?: (err: any, data?: CreateConnectorDefinitionCommandOutput) => void - ): Promise | void { - const command = new CreateConnectorDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Creates a version of a connector definition which has already been defined. - */ - public createConnectorDefinitionVersion( + + /** + * @see {@link CreateConnectorDefinitionVersionCommand} + */ + createConnectorDefinitionVersion( args: CreateConnectorDefinitionVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConnectorDefinitionVersion( + createConnectorDefinitionVersion( args: CreateConnectorDefinitionVersionCommandInput, cb: (err: any, data?: CreateConnectorDefinitionVersionCommandOutput) => void ): void; - public createConnectorDefinitionVersion( + createConnectorDefinitionVersion( args: CreateConnectorDefinitionVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectorDefinitionVersionCommandOutput) => void ): void; - public createConnectorDefinitionVersion( - args: CreateConnectorDefinitionVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConnectorDefinitionVersionCommandOutput) => void), - cb?: (err: any, data?: CreateConnectorDefinitionVersionCommandOutput) => void - ): Promise | void { - const command = new CreateConnectorDefinitionVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Creates a core definition. You may provide the initial version of the core definition now or use ''CreateCoreDefinitionVersion'' at a later time. Greengrass groups must each contain exactly one Greengrass core. - */ - public createCoreDefinition( + + /** + * @see {@link CreateCoreDefinitionCommand} + */ + createCoreDefinition( args: CreateCoreDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCoreDefinition( + createCoreDefinition( args: CreateCoreDefinitionCommandInput, cb: (err: any, data?: CreateCoreDefinitionCommandOutput) => void ): void; - public createCoreDefinition( + createCoreDefinition( args: CreateCoreDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCoreDefinitionCommandOutput) => void ): void; - public createCoreDefinition( - args: CreateCoreDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCoreDefinitionCommandOutput) => void), - cb?: (err: any, data?: CreateCoreDefinitionCommandOutput) => void - ): Promise | void { - const command = new CreateCoreDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Creates a version of a core definition that has already been defined. Greengrass groups must each contain exactly one Greengrass core. - */ - public createCoreDefinitionVersion( + + /** + * @see {@link CreateCoreDefinitionVersionCommand} + */ + createCoreDefinitionVersion( args: CreateCoreDefinitionVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCoreDefinitionVersion( + createCoreDefinitionVersion( args: CreateCoreDefinitionVersionCommandInput, cb: (err: any, data?: CreateCoreDefinitionVersionCommandOutput) => void ): void; - public createCoreDefinitionVersion( + createCoreDefinitionVersion( args: CreateCoreDefinitionVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCoreDefinitionVersionCommandOutput) => void ): void; - public createCoreDefinitionVersion( - args: CreateCoreDefinitionVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCoreDefinitionVersionCommandOutput) => void), - cb?: (err: any, data?: CreateCoreDefinitionVersionCommandOutput) => void - ): Promise | void { - const command = new CreateCoreDefinitionVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Creates a deployment. ''CreateDeployment'' requests are idempotent with respect to the ''X-Amzn-Client-Token'' token and the request parameters. - */ - public createDeployment( + + /** + * @see {@link CreateDeploymentCommand} + */ + createDeployment( args: CreateDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDeployment( + createDeployment( args: CreateDeploymentCommandInput, cb: (err: any, data?: CreateDeploymentCommandOutput) => void ): void; - public createDeployment( + createDeployment( args: CreateDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeploymentCommandOutput) => void ): void; - public createDeployment( - args: CreateDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDeploymentCommandOutput) => void), - cb?: (err: any, data?: CreateDeploymentCommandOutput) => void - ): Promise | void { - const command = new CreateDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Creates a device definition. You may provide the initial version of the device definition now or use ''CreateDeviceDefinitionVersion'' at a later time. - */ - public createDeviceDefinition( + + /** + * @see {@link CreateDeviceDefinitionCommand} + */ + createDeviceDefinition( args: CreateDeviceDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDeviceDefinition( + createDeviceDefinition( args: CreateDeviceDefinitionCommandInput, cb: (err: any, data?: CreateDeviceDefinitionCommandOutput) => void ): void; - public createDeviceDefinition( + createDeviceDefinition( args: CreateDeviceDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeviceDefinitionCommandOutput) => void ): void; - public createDeviceDefinition( - args: CreateDeviceDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDeviceDefinitionCommandOutput) => void), - cb?: (err: any, data?: CreateDeviceDefinitionCommandOutput) => void - ): Promise | void { - const command = new CreateDeviceDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Creates a version of a device definition that has already been defined. - */ - public createDeviceDefinitionVersion( + + /** + * @see {@link CreateDeviceDefinitionVersionCommand} + */ + createDeviceDefinitionVersion( args: CreateDeviceDefinitionVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDeviceDefinitionVersion( + createDeviceDefinitionVersion( args: CreateDeviceDefinitionVersionCommandInput, cb: (err: any, data?: CreateDeviceDefinitionVersionCommandOutput) => void ): void; - public createDeviceDefinitionVersion( + createDeviceDefinitionVersion( args: CreateDeviceDefinitionVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeviceDefinitionVersionCommandOutput) => void ): void; - public createDeviceDefinitionVersion( - args: CreateDeviceDefinitionVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDeviceDefinitionVersionCommandOutput) => void), - cb?: (err: any, data?: CreateDeviceDefinitionVersionCommandOutput) => void - ): Promise | void { - const command = new CreateDeviceDefinitionVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Creates a Lambda function definition which contains a list of Lambda functions and their configurations to be used in a group. You can create an initial version of the definition by providing a list of Lambda functions and their configurations now, or use ''CreateFunctionDefinitionVersion'' later. - */ - public createFunctionDefinition( + + /** + * @see {@link CreateFunctionDefinitionCommand} + */ + createFunctionDefinition( args: CreateFunctionDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFunctionDefinition( + createFunctionDefinition( args: CreateFunctionDefinitionCommandInput, cb: (err: any, data?: CreateFunctionDefinitionCommandOutput) => void ): void; - public createFunctionDefinition( + createFunctionDefinition( args: CreateFunctionDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFunctionDefinitionCommandOutput) => void ): void; - public createFunctionDefinition( - args: CreateFunctionDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFunctionDefinitionCommandOutput) => void), - cb?: (err: any, data?: CreateFunctionDefinitionCommandOutput) => void - ): Promise | void { - const command = new CreateFunctionDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Creates a version of a Lambda function definition that has already been defined. - */ - public createFunctionDefinitionVersion( + + /** + * @see {@link CreateFunctionDefinitionVersionCommand} + */ + createFunctionDefinitionVersion( args: CreateFunctionDefinitionVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFunctionDefinitionVersion( + createFunctionDefinitionVersion( args: CreateFunctionDefinitionVersionCommandInput, cb: (err: any, data?: CreateFunctionDefinitionVersionCommandOutput) => void ): void; - public createFunctionDefinitionVersion( + createFunctionDefinitionVersion( args: CreateFunctionDefinitionVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFunctionDefinitionVersionCommandOutput) => void ): void; - public createFunctionDefinitionVersion( - args: CreateFunctionDefinitionVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFunctionDefinitionVersionCommandOutput) => void), - cb?: (err: any, data?: CreateFunctionDefinitionVersionCommandOutput) => void - ): Promise | void { - const command = new CreateFunctionDefinitionVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Creates a group. You may provide the initial version of the group or use ''CreateGroupVersion'' at a later time. Tip: You can use the ''gg_group_setup'' package (https://github.com/awslabs/aws-greengrass-group-setup) as a library or command-line application to create and deploy Greengrass groups. - */ - public createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void; - public createGroup( + + /** + * @see {@link CreateGroupCommand} + */ + createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise; + createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void; + createGroup( args: CreateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupCommandOutput) => void ): void; - public createGroup( - args: CreateGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGroupCommandOutput) => void), - cb?: (err: any, data?: CreateGroupCommandOutput) => void - ): Promise | void { - const command = new CreateGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Creates a CA for the group. If a CA already exists, it will rotate the existing CA. - */ - public createGroupCertificateAuthority( + + /** + * @see {@link CreateGroupCertificateAuthorityCommand} + */ + createGroupCertificateAuthority( args: CreateGroupCertificateAuthorityCommandInput, options?: __HttpHandlerOptions ): Promise; - public createGroupCertificateAuthority( + createGroupCertificateAuthority( args: CreateGroupCertificateAuthorityCommandInput, cb: (err: any, data?: CreateGroupCertificateAuthorityCommandOutput) => void ): void; - public createGroupCertificateAuthority( + createGroupCertificateAuthority( args: CreateGroupCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupCertificateAuthorityCommandOutput) => void ): void; - public createGroupCertificateAuthority( - args: CreateGroupCertificateAuthorityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGroupCertificateAuthorityCommandOutput) => void), - cb?: (err: any, data?: CreateGroupCertificateAuthorityCommandOutput) => void - ): Promise | void { - const command = new CreateGroupCertificateAuthorityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Creates a version of a group which has already been defined. - */ - public createGroupVersion( + + /** + * @see {@link CreateGroupVersionCommand} + */ + createGroupVersion( args: CreateGroupVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createGroupVersion( + createGroupVersion( args: CreateGroupVersionCommandInput, cb: (err: any, data?: CreateGroupVersionCommandOutput) => void ): void; - public createGroupVersion( + createGroupVersion( args: CreateGroupVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupVersionCommandOutput) => void ): void; - public createGroupVersion( - args: CreateGroupVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGroupVersionCommandOutput) => void), - cb?: (err: any, data?: CreateGroupVersionCommandOutput) => void - ): Promise | void { - const command = new CreateGroupVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Creates a logger definition. You may provide the initial version of the logger definition now or use ''CreateLoggerDefinitionVersion'' at a later time. - */ - public createLoggerDefinition( + + /** + * @see {@link CreateLoggerDefinitionCommand} + */ + createLoggerDefinition( args: CreateLoggerDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLoggerDefinition( + createLoggerDefinition( args: CreateLoggerDefinitionCommandInput, cb: (err: any, data?: CreateLoggerDefinitionCommandOutput) => void ): void; - public createLoggerDefinition( + createLoggerDefinition( args: CreateLoggerDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLoggerDefinitionCommandOutput) => void ): void; - public createLoggerDefinition( - args: CreateLoggerDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLoggerDefinitionCommandOutput) => void), - cb?: (err: any, data?: CreateLoggerDefinitionCommandOutput) => void - ): Promise | void { - const command = new CreateLoggerDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Creates a version of a logger definition that has already been defined. - */ - public createLoggerDefinitionVersion( + + /** + * @see {@link CreateLoggerDefinitionVersionCommand} + */ + createLoggerDefinitionVersion( args: CreateLoggerDefinitionVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLoggerDefinitionVersion( + createLoggerDefinitionVersion( args: CreateLoggerDefinitionVersionCommandInput, cb: (err: any, data?: CreateLoggerDefinitionVersionCommandOutput) => void ): void; - public createLoggerDefinitionVersion( + createLoggerDefinitionVersion( args: CreateLoggerDefinitionVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLoggerDefinitionVersionCommandOutput) => void ): void; - public createLoggerDefinitionVersion( - args: CreateLoggerDefinitionVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLoggerDefinitionVersionCommandOutput) => void), - cb?: (err: any, data?: CreateLoggerDefinitionVersionCommandOutput) => void - ): Promise | void { - const command = new CreateLoggerDefinitionVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Creates a resource definition which contains a list of resources to be used in a group. You can create an initial version of the definition by providing a list of resources now, or use ''CreateResourceDefinitionVersion'' later. - */ - public createResourceDefinition( + + /** + * @see {@link CreateResourceDefinitionCommand} + */ + createResourceDefinition( args: CreateResourceDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createResourceDefinition( + createResourceDefinition( args: CreateResourceDefinitionCommandInput, cb: (err: any, data?: CreateResourceDefinitionCommandOutput) => void ): void; - public createResourceDefinition( + createResourceDefinition( args: CreateResourceDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResourceDefinitionCommandOutput) => void ): void; - public createResourceDefinition( - args: CreateResourceDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateResourceDefinitionCommandOutput) => void), - cb?: (err: any, data?: CreateResourceDefinitionCommandOutput) => void - ): Promise | void { - const command = new CreateResourceDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Creates a version of a resource definition that has already been defined. - */ - public createResourceDefinitionVersion( + + /** + * @see {@link CreateResourceDefinitionVersionCommand} + */ + createResourceDefinitionVersion( args: CreateResourceDefinitionVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createResourceDefinitionVersion( + createResourceDefinitionVersion( args: CreateResourceDefinitionVersionCommandInput, cb: (err: any, data?: CreateResourceDefinitionVersionCommandOutput) => void ): void; - public createResourceDefinitionVersion( + createResourceDefinitionVersion( args: CreateResourceDefinitionVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResourceDefinitionVersionCommandOutput) => void ): void; - public createResourceDefinitionVersion( - args: CreateResourceDefinitionVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateResourceDefinitionVersionCommandOutput) => void), - cb?: (err: any, data?: CreateResourceDefinitionVersionCommandOutput) => void - ): Promise | void { - const command = new CreateResourceDefinitionVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Creates a software update for a core or group of cores (specified as an IoT thing group.) Use this to update the OTA Agent as well as the Greengrass core software. It makes use of the IoT Jobs feature which provides additional commands to manage a Greengrass core software update job. - */ - public createSoftwareUpdateJob( + + /** + * @see {@link CreateSoftwareUpdateJobCommand} + */ + createSoftwareUpdateJob( args: CreateSoftwareUpdateJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSoftwareUpdateJob( + createSoftwareUpdateJob( args: CreateSoftwareUpdateJobCommandInput, cb: (err: any, data?: CreateSoftwareUpdateJobCommandOutput) => void ): void; - public createSoftwareUpdateJob( + createSoftwareUpdateJob( args: CreateSoftwareUpdateJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSoftwareUpdateJobCommandOutput) => void ): void; - public createSoftwareUpdateJob( - args: CreateSoftwareUpdateJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSoftwareUpdateJobCommandOutput) => void), - cb?: (err: any, data?: CreateSoftwareUpdateJobCommandOutput) => void - ): Promise | void { - const command = new CreateSoftwareUpdateJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Creates a subscription definition. You may provide the initial version of the subscription definition now or use ''CreateSubscriptionDefinitionVersion'' at a later time. - */ - public createSubscriptionDefinition( + + /** + * @see {@link CreateSubscriptionDefinitionCommand} + */ + createSubscriptionDefinition( args: CreateSubscriptionDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSubscriptionDefinition( + createSubscriptionDefinition( args: CreateSubscriptionDefinitionCommandInput, cb: (err: any, data?: CreateSubscriptionDefinitionCommandOutput) => void ): void; - public createSubscriptionDefinition( + createSubscriptionDefinition( args: CreateSubscriptionDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSubscriptionDefinitionCommandOutput) => void ): void; - public createSubscriptionDefinition( - args: CreateSubscriptionDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSubscriptionDefinitionCommandOutput) => void), - cb?: (err: any, data?: CreateSubscriptionDefinitionCommandOutput) => void - ): Promise | void { - const command = new CreateSubscriptionDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Creates a version of a subscription definition which has already been defined. - */ - public createSubscriptionDefinitionVersion( + + /** + * @see {@link CreateSubscriptionDefinitionVersionCommand} + */ + createSubscriptionDefinitionVersion( args: CreateSubscriptionDefinitionVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSubscriptionDefinitionVersion( + createSubscriptionDefinitionVersion( args: CreateSubscriptionDefinitionVersionCommandInput, cb: (err: any, data?: CreateSubscriptionDefinitionVersionCommandOutput) => void ): void; - public createSubscriptionDefinitionVersion( + createSubscriptionDefinitionVersion( args: CreateSubscriptionDefinitionVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSubscriptionDefinitionVersionCommandOutput) => void ): void; - public createSubscriptionDefinitionVersion( - args: CreateSubscriptionDefinitionVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSubscriptionDefinitionVersionCommandOutput) => void), - cb?: (err: any, data?: CreateSubscriptionDefinitionVersionCommandOutput) => void - ): Promise | void { - const command = new CreateSubscriptionDefinitionVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Deletes a connector definition. - */ - public deleteConnectorDefinition( + + /** + * @see {@link DeleteConnectorDefinitionCommand} + */ + deleteConnectorDefinition( args: DeleteConnectorDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConnectorDefinition( + deleteConnectorDefinition( args: DeleteConnectorDefinitionCommandInput, cb: (err: any, data?: DeleteConnectorDefinitionCommandOutput) => void ): void; - public deleteConnectorDefinition( + deleteConnectorDefinition( args: DeleteConnectorDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectorDefinitionCommandOutput) => void ): void; - public deleteConnectorDefinition( - args: DeleteConnectorDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConnectorDefinitionCommandOutput) => void), - cb?: (err: any, data?: DeleteConnectorDefinitionCommandOutput) => void - ): Promise | void { - const command = new DeleteConnectorDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Deletes a core definition. - */ - public deleteCoreDefinition( + + /** + * @see {@link DeleteCoreDefinitionCommand} + */ + deleteCoreDefinition( args: DeleteCoreDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCoreDefinition( + deleteCoreDefinition( args: DeleteCoreDefinitionCommandInput, cb: (err: any, data?: DeleteCoreDefinitionCommandOutput) => void ): void; - public deleteCoreDefinition( + deleteCoreDefinition( args: DeleteCoreDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCoreDefinitionCommandOutput) => void ): void; - public deleteCoreDefinition( - args: DeleteCoreDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCoreDefinitionCommandOutput) => void), - cb?: (err: any, data?: DeleteCoreDefinitionCommandOutput) => void - ): Promise | void { - const command = new DeleteCoreDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Deletes a device definition. - */ - public deleteDeviceDefinition( + + /** + * @see {@link DeleteDeviceDefinitionCommand} + */ + deleteDeviceDefinition( args: DeleteDeviceDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDeviceDefinition( + deleteDeviceDefinition( args: DeleteDeviceDefinitionCommandInput, cb: (err: any, data?: DeleteDeviceDefinitionCommandOutput) => void ): void; - public deleteDeviceDefinition( + deleteDeviceDefinition( args: DeleteDeviceDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDeviceDefinitionCommandOutput) => void ): void; - public deleteDeviceDefinition( - args: DeleteDeviceDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDeviceDefinitionCommandOutput) => void), - cb?: (err: any, data?: DeleteDeviceDefinitionCommandOutput) => void - ): Promise | void { - const command = new DeleteDeviceDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Deletes a Lambda function definition. - */ - public deleteFunctionDefinition( + + /** + * @see {@link DeleteFunctionDefinitionCommand} + */ + deleteFunctionDefinition( args: DeleteFunctionDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFunctionDefinition( + deleteFunctionDefinition( args: DeleteFunctionDefinitionCommandInput, cb: (err: any, data?: DeleteFunctionDefinitionCommandOutput) => void ): void; - public deleteFunctionDefinition( + deleteFunctionDefinition( args: DeleteFunctionDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFunctionDefinitionCommandOutput) => void ): void; - public deleteFunctionDefinition( - args: DeleteFunctionDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFunctionDefinitionCommandOutput) => void), - cb?: (err: any, data?: DeleteFunctionDefinitionCommandOutput) => void - ): Promise | void { - const command = new DeleteFunctionDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Deletes a group. - */ - public deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void; - public deleteGroup( + + /** + * @see {@link DeleteGroupCommand} + */ + deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise; + deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void; + deleteGroup( args: DeleteGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupCommandOutput) => void ): void; - public deleteGroup( - args: DeleteGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Deletes a logger definition. - */ - public deleteLoggerDefinition( + + /** + * @see {@link DeleteLoggerDefinitionCommand} + */ + deleteLoggerDefinition( args: DeleteLoggerDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLoggerDefinition( + deleteLoggerDefinition( args: DeleteLoggerDefinitionCommandInput, cb: (err: any, data?: DeleteLoggerDefinitionCommandOutput) => void ): void; - public deleteLoggerDefinition( + deleteLoggerDefinition( args: DeleteLoggerDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLoggerDefinitionCommandOutput) => void ): void; - public deleteLoggerDefinition( - args: DeleteLoggerDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLoggerDefinitionCommandOutput) => void), - cb?: (err: any, data?: DeleteLoggerDefinitionCommandOutput) => void - ): Promise | void { - const command = new DeleteLoggerDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Deletes a resource definition. - */ - public deleteResourceDefinition( + + /** + * @see {@link DeleteResourceDefinitionCommand} + */ + deleteResourceDefinition( args: DeleteResourceDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourceDefinition( + deleteResourceDefinition( args: DeleteResourceDefinitionCommandInput, cb: (err: any, data?: DeleteResourceDefinitionCommandOutput) => void ): void; - public deleteResourceDefinition( + deleteResourceDefinition( args: DeleteResourceDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourceDefinitionCommandOutput) => void ): void; - public deleteResourceDefinition( - args: DeleteResourceDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourceDefinitionCommandOutput) => void), - cb?: (err: any, data?: DeleteResourceDefinitionCommandOutput) => void - ): Promise | void { - const command = new DeleteResourceDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Deletes a subscription definition. - */ - public deleteSubscriptionDefinition( + + /** + * @see {@link DeleteSubscriptionDefinitionCommand} + */ + deleteSubscriptionDefinition( args: DeleteSubscriptionDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSubscriptionDefinition( + deleteSubscriptionDefinition( args: DeleteSubscriptionDefinitionCommandInput, cb: (err: any, data?: DeleteSubscriptionDefinitionCommandOutput) => void ): void; - public deleteSubscriptionDefinition( + deleteSubscriptionDefinition( args: DeleteSubscriptionDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSubscriptionDefinitionCommandOutput) => void ): void; - public deleteSubscriptionDefinition( - args: DeleteSubscriptionDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSubscriptionDefinitionCommandOutput) => void), - cb?: (err: any, data?: DeleteSubscriptionDefinitionCommandOutput) => void - ): Promise | void { - const command = new DeleteSubscriptionDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Disassociates the role from a group. - */ - public disassociateRoleFromGroup( + + /** + * @see {@link DisassociateRoleFromGroupCommand} + */ + disassociateRoleFromGroup( args: DisassociateRoleFromGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateRoleFromGroup( + disassociateRoleFromGroup( args: DisassociateRoleFromGroupCommandInput, cb: (err: any, data?: DisassociateRoleFromGroupCommandOutput) => void ): void; - public disassociateRoleFromGroup( + disassociateRoleFromGroup( args: DisassociateRoleFromGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateRoleFromGroupCommandOutput) => void ): void; - public disassociateRoleFromGroup( - args: DisassociateRoleFromGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateRoleFromGroupCommandOutput) => void), - cb?: (err: any, data?: DisassociateRoleFromGroupCommandOutput) => void - ): Promise | void { - const command = new DisassociateRoleFromGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Disassociates the service role from your account. Without a service role, deployments will not work. - */ - public disassociateServiceRoleFromAccount( + + /** + * @see {@link DisassociateServiceRoleFromAccountCommand} + */ + disassociateServiceRoleFromAccount( args: DisassociateServiceRoleFromAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateServiceRoleFromAccount( + disassociateServiceRoleFromAccount( args: DisassociateServiceRoleFromAccountCommandInput, cb: (err: any, data?: DisassociateServiceRoleFromAccountCommandOutput) => void ): void; - public disassociateServiceRoleFromAccount( + disassociateServiceRoleFromAccount( args: DisassociateServiceRoleFromAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateServiceRoleFromAccountCommandOutput) => void ): void; - public disassociateServiceRoleFromAccount( - args: DisassociateServiceRoleFromAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateServiceRoleFromAccountCommandOutput) => void), - cb?: (err: any, data?: DisassociateServiceRoleFromAccountCommandOutput) => void - ): Promise | void { - const command = new DisassociateServiceRoleFromAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves the role associated with a particular group. - */ - public getAssociatedRole( + + /** + * @see {@link GetAssociatedRoleCommand} + */ + getAssociatedRole( args: GetAssociatedRoleCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAssociatedRole( + getAssociatedRole( args: GetAssociatedRoleCommandInput, cb: (err: any, data?: GetAssociatedRoleCommandOutput) => void ): void; - public getAssociatedRole( + getAssociatedRole( args: GetAssociatedRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAssociatedRoleCommandOutput) => void ): void; - public getAssociatedRole( - args: GetAssociatedRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAssociatedRoleCommandOutput) => void), - cb?: (err: any, data?: GetAssociatedRoleCommandOutput) => void - ): Promise | void { - const command = new GetAssociatedRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Returns the status of a bulk deployment. - */ - public getBulkDeploymentStatus( + + /** + * @see {@link GetBulkDeploymentStatusCommand} + */ + getBulkDeploymentStatus( args: GetBulkDeploymentStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBulkDeploymentStatus( + getBulkDeploymentStatus( args: GetBulkDeploymentStatusCommandInput, cb: (err: any, data?: GetBulkDeploymentStatusCommandOutput) => void ): void; - public getBulkDeploymentStatus( + getBulkDeploymentStatus( args: GetBulkDeploymentStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBulkDeploymentStatusCommandOutput) => void ): void; - public getBulkDeploymentStatus( - args: GetBulkDeploymentStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBulkDeploymentStatusCommandOutput) => void), - cb?: (err: any, data?: GetBulkDeploymentStatusCommandOutput) => void - ): Promise | void { - const command = new GetBulkDeploymentStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves the connectivity information for a core. - */ - public getConnectivityInfo( + + /** + * @see {@link GetConnectivityInfoCommand} + */ + getConnectivityInfo( args: GetConnectivityInfoCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConnectivityInfo( + getConnectivityInfo( args: GetConnectivityInfoCommandInput, cb: (err: any, data?: GetConnectivityInfoCommandOutput) => void ): void; - public getConnectivityInfo( + getConnectivityInfo( args: GetConnectivityInfoCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConnectivityInfoCommandOutput) => void ): void; - public getConnectivityInfo( - args: GetConnectivityInfoCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConnectivityInfoCommandOutput) => void), - cb?: (err: any, data?: GetConnectivityInfoCommandOutput) => void - ): Promise | void { - const command = new GetConnectivityInfoCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves information about a connector definition. - */ - public getConnectorDefinition( + + /** + * @see {@link GetConnectorDefinitionCommand} + */ + getConnectorDefinition( args: GetConnectorDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConnectorDefinition( + getConnectorDefinition( args: GetConnectorDefinitionCommandInput, cb: (err: any, data?: GetConnectorDefinitionCommandOutput) => void ): void; - public getConnectorDefinition( + getConnectorDefinition( args: GetConnectorDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConnectorDefinitionCommandOutput) => void ): void; - public getConnectorDefinition( - args: GetConnectorDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConnectorDefinitionCommandOutput) => void), - cb?: (err: any, data?: GetConnectorDefinitionCommandOutput) => void - ): Promise | void { - const command = new GetConnectorDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves information about a connector definition version, including the connectors that the version contains. Connectors are prebuilt modules that interact with local infrastructure, device protocols, AWS, and other cloud services. - */ - public getConnectorDefinitionVersion( + + /** + * @see {@link GetConnectorDefinitionVersionCommand} + */ + getConnectorDefinitionVersion( args: GetConnectorDefinitionVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConnectorDefinitionVersion( + getConnectorDefinitionVersion( args: GetConnectorDefinitionVersionCommandInput, cb: (err: any, data?: GetConnectorDefinitionVersionCommandOutput) => void ): void; - public getConnectorDefinitionVersion( + getConnectorDefinitionVersion( args: GetConnectorDefinitionVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConnectorDefinitionVersionCommandOutput) => void ): void; - public getConnectorDefinitionVersion( - args: GetConnectorDefinitionVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConnectorDefinitionVersionCommandOutput) => void), - cb?: (err: any, data?: GetConnectorDefinitionVersionCommandOutput) => void - ): Promise | void { - const command = new GetConnectorDefinitionVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves information about a core definition version. - */ - public getCoreDefinition( + + /** + * @see {@link GetCoreDefinitionCommand} + */ + getCoreDefinition( args: GetCoreDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCoreDefinition( + getCoreDefinition( args: GetCoreDefinitionCommandInput, cb: (err: any, data?: GetCoreDefinitionCommandOutput) => void ): void; - public getCoreDefinition( + getCoreDefinition( args: GetCoreDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCoreDefinitionCommandOutput) => void ): void; - public getCoreDefinition( - args: GetCoreDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCoreDefinitionCommandOutput) => void), - cb?: (err: any, data?: GetCoreDefinitionCommandOutput) => void - ): Promise | void { - const command = new GetCoreDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves information about a core definition version. - */ - public getCoreDefinitionVersion( + + /** + * @see {@link GetCoreDefinitionVersionCommand} + */ + getCoreDefinitionVersion( args: GetCoreDefinitionVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCoreDefinitionVersion( + getCoreDefinitionVersion( args: GetCoreDefinitionVersionCommandInput, cb: (err: any, data?: GetCoreDefinitionVersionCommandOutput) => void ): void; - public getCoreDefinitionVersion( + getCoreDefinitionVersion( args: GetCoreDefinitionVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCoreDefinitionVersionCommandOutput) => void ): void; - public getCoreDefinitionVersion( - args: GetCoreDefinitionVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCoreDefinitionVersionCommandOutput) => void), - cb?: (err: any, data?: GetCoreDefinitionVersionCommandOutput) => void - ): Promise | void { - const command = new GetCoreDefinitionVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Returns the status of a deployment. - */ - public getDeploymentStatus( + + /** + * @see {@link GetDeploymentStatusCommand} + */ + getDeploymentStatus( args: GetDeploymentStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDeploymentStatus( + getDeploymentStatus( args: GetDeploymentStatusCommandInput, cb: (err: any, data?: GetDeploymentStatusCommandOutput) => void ): void; - public getDeploymentStatus( + getDeploymentStatus( args: GetDeploymentStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeploymentStatusCommandOutput) => void ): void; - public getDeploymentStatus( - args: GetDeploymentStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeploymentStatusCommandOutput) => void), - cb?: (err: any, data?: GetDeploymentStatusCommandOutput) => void - ): Promise | void { - const command = new GetDeploymentStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves information about a device definition. - */ - public getDeviceDefinition( + + /** + * @see {@link GetDeviceDefinitionCommand} + */ + getDeviceDefinition( args: GetDeviceDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDeviceDefinition( + getDeviceDefinition( args: GetDeviceDefinitionCommandInput, cb: (err: any, data?: GetDeviceDefinitionCommandOutput) => void ): void; - public getDeviceDefinition( + getDeviceDefinition( args: GetDeviceDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeviceDefinitionCommandOutput) => void ): void; - public getDeviceDefinition( - args: GetDeviceDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeviceDefinitionCommandOutput) => void), - cb?: (err: any, data?: GetDeviceDefinitionCommandOutput) => void - ): Promise | void { - const command = new GetDeviceDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves information about a device definition version. - */ - public getDeviceDefinitionVersion( + + /** + * @see {@link GetDeviceDefinitionVersionCommand} + */ + getDeviceDefinitionVersion( args: GetDeviceDefinitionVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDeviceDefinitionVersion( + getDeviceDefinitionVersion( args: GetDeviceDefinitionVersionCommandInput, cb: (err: any, data?: GetDeviceDefinitionVersionCommandOutput) => void ): void; - public getDeviceDefinitionVersion( + getDeviceDefinitionVersion( args: GetDeviceDefinitionVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeviceDefinitionVersionCommandOutput) => void ): void; - public getDeviceDefinitionVersion( - args: GetDeviceDefinitionVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeviceDefinitionVersionCommandOutput) => void), - cb?: (err: any, data?: GetDeviceDefinitionVersionCommandOutput) => void - ): Promise | void { - const command = new GetDeviceDefinitionVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves information about a Lambda function definition, including its creation time and latest version. - */ - public getFunctionDefinition( + + /** + * @see {@link GetFunctionDefinitionCommand} + */ + getFunctionDefinition( args: GetFunctionDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFunctionDefinition( + getFunctionDefinition( args: GetFunctionDefinitionCommandInput, cb: (err: any, data?: GetFunctionDefinitionCommandOutput) => void ): void; - public getFunctionDefinition( + getFunctionDefinition( args: GetFunctionDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFunctionDefinitionCommandOutput) => void ): void; - public getFunctionDefinition( - args: GetFunctionDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFunctionDefinitionCommandOutput) => void), - cb?: (err: any, data?: GetFunctionDefinitionCommandOutput) => void - ): Promise | void { - const command = new GetFunctionDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations. - */ - public getFunctionDefinitionVersion( + + /** + * @see {@link GetFunctionDefinitionVersionCommand} + */ + getFunctionDefinitionVersion( args: GetFunctionDefinitionVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFunctionDefinitionVersion( + getFunctionDefinitionVersion( args: GetFunctionDefinitionVersionCommandInput, cb: (err: any, data?: GetFunctionDefinitionVersionCommandOutput) => void ): void; - public getFunctionDefinitionVersion( + getFunctionDefinitionVersion( args: GetFunctionDefinitionVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFunctionDefinitionVersionCommandOutput) => void ): void; - public getFunctionDefinitionVersion( - args: GetFunctionDefinitionVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFunctionDefinitionVersionCommandOutput) => void), - cb?: (err: any, data?: GetFunctionDefinitionVersionCommandOutput) => void - ): Promise | void { - const command = new GetFunctionDefinitionVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves information about a group. - */ - public getGroup(args: GetGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public getGroup(args: GetGroupCommandInput, cb: (err: any, data?: GetGroupCommandOutput) => void): void; - public getGroup( + + /** + * @see {@link GetGroupCommand} + */ + getGroup(args: GetGroupCommandInput, options?: __HttpHandlerOptions): Promise; + getGroup(args: GetGroupCommandInput, cb: (err: any, data?: GetGroupCommandOutput) => void): void; + getGroup( args: GetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupCommandOutput) => void ): void; - public getGroup( - args: GetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGroupCommandOutput) => void), - cb?: (err: any, data?: GetGroupCommandOutput) => void - ): Promise | void { - const command = new GetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retreives the CA associated with a group. Returns the public key of the CA. - */ - public getGroupCertificateAuthority( + + /** + * @see {@link GetGroupCertificateAuthorityCommand} + */ + getGroupCertificateAuthority( args: GetGroupCertificateAuthorityCommandInput, options?: __HttpHandlerOptions ): Promise; - public getGroupCertificateAuthority( + getGroupCertificateAuthority( args: GetGroupCertificateAuthorityCommandInput, cb: (err: any, data?: GetGroupCertificateAuthorityCommandOutput) => void ): void; - public getGroupCertificateAuthority( + getGroupCertificateAuthority( args: GetGroupCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupCertificateAuthorityCommandOutput) => void ): void; - public getGroupCertificateAuthority( - args: GetGroupCertificateAuthorityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGroupCertificateAuthorityCommandOutput) => void), - cb?: (err: any, data?: GetGroupCertificateAuthorityCommandOutput) => void - ): Promise | void { - const command = new GetGroupCertificateAuthorityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves the current configuration for the CA used by the group. - */ - public getGroupCertificateConfiguration( + + /** + * @see {@link GetGroupCertificateConfigurationCommand} + */ + getGroupCertificateConfiguration( args: GetGroupCertificateConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getGroupCertificateConfiguration( + getGroupCertificateConfiguration( args: GetGroupCertificateConfigurationCommandInput, cb: (err: any, data?: GetGroupCertificateConfigurationCommandOutput) => void ): void; - public getGroupCertificateConfiguration( + getGroupCertificateConfiguration( args: GetGroupCertificateConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupCertificateConfigurationCommandOutput) => void ): void; - public getGroupCertificateConfiguration( - args: GetGroupCertificateConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGroupCertificateConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetGroupCertificateConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetGroupCertificateConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves information about a group version. - */ - public getGroupVersion( + + /** + * @see {@link GetGroupVersionCommand} + */ + getGroupVersion( args: GetGroupVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getGroupVersion( - args: GetGroupVersionCommandInput, - cb: (err: any, data?: GetGroupVersionCommandOutput) => void - ): void; - public getGroupVersion( + getGroupVersion(args: GetGroupVersionCommandInput, cb: (err: any, data?: GetGroupVersionCommandOutput) => void): void; + getGroupVersion( args: GetGroupVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupVersionCommandOutput) => void ): void; - public getGroupVersion( - args: GetGroupVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGroupVersionCommandOutput) => void), - cb?: (err: any, data?: GetGroupVersionCommandOutput) => void - ): Promise | void { - const command = new GetGroupVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves information about a logger definition. - */ - public getLoggerDefinition( + + /** + * @see {@link GetLoggerDefinitionCommand} + */ + getLoggerDefinition( args: GetLoggerDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLoggerDefinition( + getLoggerDefinition( args: GetLoggerDefinitionCommandInput, cb: (err: any, data?: GetLoggerDefinitionCommandOutput) => void ): void; - public getLoggerDefinition( + getLoggerDefinition( args: GetLoggerDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLoggerDefinitionCommandOutput) => void ): void; - public getLoggerDefinition( - args: GetLoggerDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLoggerDefinitionCommandOutput) => void), - cb?: (err: any, data?: GetLoggerDefinitionCommandOutput) => void - ): Promise | void { - const command = new GetLoggerDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves information about a logger definition version. - */ - public getLoggerDefinitionVersion( + + /** + * @see {@link GetLoggerDefinitionVersionCommand} + */ + getLoggerDefinitionVersion( args: GetLoggerDefinitionVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLoggerDefinitionVersion( + getLoggerDefinitionVersion( args: GetLoggerDefinitionVersionCommandInput, cb: (err: any, data?: GetLoggerDefinitionVersionCommandOutput) => void ): void; - public getLoggerDefinitionVersion( + getLoggerDefinitionVersion( args: GetLoggerDefinitionVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLoggerDefinitionVersionCommandOutput) => void ): void; - public getLoggerDefinitionVersion( - args: GetLoggerDefinitionVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLoggerDefinitionVersionCommandOutput) => void), - cb?: (err: any, data?: GetLoggerDefinitionVersionCommandOutput) => void - ): Promise | void { - const command = new GetLoggerDefinitionVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves information about a resource definition, including its creation time and latest version. - */ - public getResourceDefinition( + + /** + * @see {@link GetResourceDefinitionCommand} + */ + getResourceDefinition( args: GetResourceDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourceDefinition( + getResourceDefinition( args: GetResourceDefinitionCommandInput, cb: (err: any, data?: GetResourceDefinitionCommandOutput) => void ): void; - public getResourceDefinition( + getResourceDefinition( args: GetResourceDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceDefinitionCommandOutput) => void ): void; - public getResourceDefinition( - args: GetResourceDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourceDefinitionCommandOutput) => void), - cb?: (err: any, data?: GetResourceDefinitionCommandOutput) => void - ): Promise | void { - const command = new GetResourceDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves information about a resource definition version, including which resources are included in the version. - */ - public getResourceDefinitionVersion( + + /** + * @see {@link GetResourceDefinitionVersionCommand} + */ + getResourceDefinitionVersion( args: GetResourceDefinitionVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourceDefinitionVersion( + getResourceDefinitionVersion( args: GetResourceDefinitionVersionCommandInput, cb: (err: any, data?: GetResourceDefinitionVersionCommandOutput) => void ): void; - public getResourceDefinitionVersion( + getResourceDefinitionVersion( args: GetResourceDefinitionVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceDefinitionVersionCommandOutput) => void ): void; - public getResourceDefinitionVersion( - args: GetResourceDefinitionVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourceDefinitionVersionCommandOutput) => void), - cb?: (err: any, data?: GetResourceDefinitionVersionCommandOutput) => void - ): Promise | void { - const command = new GetResourceDefinitionVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves the service role that is attached to your account. - */ - public getServiceRoleForAccount( + + /** + * @see {@link GetServiceRoleForAccountCommand} + */ + getServiceRoleForAccount( args: GetServiceRoleForAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServiceRoleForAccount( + getServiceRoleForAccount( args: GetServiceRoleForAccountCommandInput, cb: (err: any, data?: GetServiceRoleForAccountCommandOutput) => void ): void; - public getServiceRoleForAccount( + getServiceRoleForAccount( args: GetServiceRoleForAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceRoleForAccountCommandOutput) => void ): void; - public getServiceRoleForAccount( - args: GetServiceRoleForAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceRoleForAccountCommandOutput) => void), - cb?: (err: any, data?: GetServiceRoleForAccountCommandOutput) => void - ): Promise | void { - const command = new GetServiceRoleForAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves information about a subscription definition. - */ - public getSubscriptionDefinition( + + /** + * @see {@link GetSubscriptionDefinitionCommand} + */ + getSubscriptionDefinition( args: GetSubscriptionDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSubscriptionDefinition( + getSubscriptionDefinition( args: GetSubscriptionDefinitionCommandInput, cb: (err: any, data?: GetSubscriptionDefinitionCommandOutput) => void ): void; - public getSubscriptionDefinition( + getSubscriptionDefinition( args: GetSubscriptionDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSubscriptionDefinitionCommandOutput) => void ): void; - public getSubscriptionDefinition( - args: GetSubscriptionDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSubscriptionDefinitionCommandOutput) => void), - cb?: (err: any, data?: GetSubscriptionDefinitionCommandOutput) => void - ): Promise | void { - const command = new GetSubscriptionDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves information about a subscription definition version. - */ - public getSubscriptionDefinitionVersion( + + /** + * @see {@link GetSubscriptionDefinitionVersionCommand} + */ + getSubscriptionDefinitionVersion( args: GetSubscriptionDefinitionVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSubscriptionDefinitionVersion( + getSubscriptionDefinitionVersion( args: GetSubscriptionDefinitionVersionCommandInput, cb: (err: any, data?: GetSubscriptionDefinitionVersionCommandOutput) => void ): void; - public getSubscriptionDefinitionVersion( + getSubscriptionDefinitionVersion( args: GetSubscriptionDefinitionVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSubscriptionDefinitionVersionCommandOutput) => void ): void; - public getSubscriptionDefinitionVersion( - args: GetSubscriptionDefinitionVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSubscriptionDefinitionVersionCommandOutput) => void), - cb?: (err: any, data?: GetSubscriptionDefinitionVersionCommandOutput) => void - ): Promise | void { - const command = new GetSubscriptionDefinitionVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Get the runtime configuration of a thing. - */ - public getThingRuntimeConfiguration( + + /** + * @see {@link GetThingRuntimeConfigurationCommand} + */ + getThingRuntimeConfiguration( args: GetThingRuntimeConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getThingRuntimeConfiguration( + getThingRuntimeConfiguration( args: GetThingRuntimeConfigurationCommandInput, cb: (err: any, data?: GetThingRuntimeConfigurationCommandOutput) => void ): void; - public getThingRuntimeConfiguration( + getThingRuntimeConfiguration( args: GetThingRuntimeConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetThingRuntimeConfigurationCommandOutput) => void ): void; - public getThingRuntimeConfiguration( - args: GetThingRuntimeConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetThingRuntimeConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetThingRuntimeConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetThingRuntimeConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status. - */ - public listBulkDeploymentDetailedReports( + + /** + * @see {@link ListBulkDeploymentDetailedReportsCommand} + */ + listBulkDeploymentDetailedReports( args: ListBulkDeploymentDetailedReportsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBulkDeploymentDetailedReports( + listBulkDeploymentDetailedReports( args: ListBulkDeploymentDetailedReportsCommandInput, cb: (err: any, data?: ListBulkDeploymentDetailedReportsCommandOutput) => void ): void; - public listBulkDeploymentDetailedReports( + listBulkDeploymentDetailedReports( args: ListBulkDeploymentDetailedReportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBulkDeploymentDetailedReportsCommandOutput) => void ): void; - public listBulkDeploymentDetailedReports( - args: ListBulkDeploymentDetailedReportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBulkDeploymentDetailedReportsCommandOutput) => void), - cb?: (err: any, data?: ListBulkDeploymentDetailedReportsCommandOutput) => void - ): Promise | void { - const command = new ListBulkDeploymentDetailedReportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Returns a list of bulk deployments. - */ - public listBulkDeployments( + + /** + * @see {@link ListBulkDeploymentsCommand} + */ + listBulkDeployments( args: ListBulkDeploymentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBulkDeployments( + listBulkDeployments( args: ListBulkDeploymentsCommandInput, cb: (err: any, data?: ListBulkDeploymentsCommandOutput) => void ): void; - public listBulkDeployments( + listBulkDeployments( args: ListBulkDeploymentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBulkDeploymentsCommandOutput) => void ): void; - public listBulkDeployments( - args: ListBulkDeploymentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBulkDeploymentsCommandOutput) => void), - cb?: (err: any, data?: ListBulkDeploymentsCommandOutput) => void - ): Promise | void { - const command = new ListBulkDeploymentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves a list of connector definitions. - */ - public listConnectorDefinitions( + + /** + * @see {@link ListConnectorDefinitionsCommand} + */ + listConnectorDefinitions( args: ListConnectorDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConnectorDefinitions( + listConnectorDefinitions( args: ListConnectorDefinitionsCommandInput, cb: (err: any, data?: ListConnectorDefinitionsCommandOutput) => void ): void; - public listConnectorDefinitions( + listConnectorDefinitions( args: ListConnectorDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConnectorDefinitionsCommandOutput) => void ): void; - public listConnectorDefinitions( - args: ListConnectorDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConnectorDefinitionsCommandOutput) => void), - cb?: (err: any, data?: ListConnectorDefinitionsCommandOutput) => void - ): Promise | void { - const command = new ListConnectorDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Lists the versions of a connector definition, which are containers for connectors. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services. - */ - public listConnectorDefinitionVersions( + + /** + * @see {@link ListConnectorDefinitionVersionsCommand} + */ + listConnectorDefinitionVersions( args: ListConnectorDefinitionVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConnectorDefinitionVersions( + listConnectorDefinitionVersions( args: ListConnectorDefinitionVersionsCommandInput, cb: (err: any, data?: ListConnectorDefinitionVersionsCommandOutput) => void ): void; - public listConnectorDefinitionVersions( + listConnectorDefinitionVersions( args: ListConnectorDefinitionVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConnectorDefinitionVersionsCommandOutput) => void ): void; - public listConnectorDefinitionVersions( - args: ListConnectorDefinitionVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConnectorDefinitionVersionsCommandOutput) => void), - cb?: (err: any, data?: ListConnectorDefinitionVersionsCommandOutput) => void - ): Promise | void { - const command = new ListConnectorDefinitionVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves a list of core definitions. - */ - public listCoreDefinitions( + + /** + * @see {@link ListCoreDefinitionsCommand} + */ + listCoreDefinitions( args: ListCoreDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCoreDefinitions( + listCoreDefinitions( args: ListCoreDefinitionsCommandInput, cb: (err: any, data?: ListCoreDefinitionsCommandOutput) => void ): void; - public listCoreDefinitions( + listCoreDefinitions( args: ListCoreDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCoreDefinitionsCommandOutput) => void ): void; - public listCoreDefinitions( - args: ListCoreDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCoreDefinitionsCommandOutput) => void), - cb?: (err: any, data?: ListCoreDefinitionsCommandOutput) => void - ): Promise | void { - const command = new ListCoreDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Lists the versions of a core definition. - */ - public listCoreDefinitionVersions( + + /** + * @see {@link ListCoreDefinitionVersionsCommand} + */ + listCoreDefinitionVersions( args: ListCoreDefinitionVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCoreDefinitionVersions( + listCoreDefinitionVersions( args: ListCoreDefinitionVersionsCommandInput, cb: (err: any, data?: ListCoreDefinitionVersionsCommandOutput) => void ): void; - public listCoreDefinitionVersions( + listCoreDefinitionVersions( args: ListCoreDefinitionVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCoreDefinitionVersionsCommandOutput) => void ): void; - public listCoreDefinitionVersions( - args: ListCoreDefinitionVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCoreDefinitionVersionsCommandOutput) => void), - cb?: (err: any, data?: ListCoreDefinitionVersionsCommandOutput) => void - ): Promise | void { - const command = new ListCoreDefinitionVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Returns a history of deployments for the group. - */ - public listDeployments( + + /** + * @see {@link ListDeploymentsCommand} + */ + listDeployments( args: ListDeploymentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeployments( - args: ListDeploymentsCommandInput, - cb: (err: any, data?: ListDeploymentsCommandOutput) => void - ): void; - public listDeployments( + listDeployments(args: ListDeploymentsCommandInput, cb: (err: any, data?: ListDeploymentsCommandOutput) => void): void; + listDeployments( args: ListDeploymentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeploymentsCommandOutput) => void ): void; - public listDeployments( - args: ListDeploymentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeploymentsCommandOutput) => void), - cb?: (err: any, data?: ListDeploymentsCommandOutput) => void - ): Promise | void { - const command = new ListDeploymentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves a list of device definitions. - */ - public listDeviceDefinitions( + + /** + * @see {@link ListDeviceDefinitionsCommand} + */ + listDeviceDefinitions( args: ListDeviceDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeviceDefinitions( + listDeviceDefinitions( args: ListDeviceDefinitionsCommandInput, cb: (err: any, data?: ListDeviceDefinitionsCommandOutput) => void ): void; - public listDeviceDefinitions( + listDeviceDefinitions( args: ListDeviceDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeviceDefinitionsCommandOutput) => void ): void; - public listDeviceDefinitions( - args: ListDeviceDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeviceDefinitionsCommandOutput) => void), - cb?: (err: any, data?: ListDeviceDefinitionsCommandOutput) => void - ): Promise | void { - const command = new ListDeviceDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Lists the versions of a device definition. - */ - public listDeviceDefinitionVersions( + + /** + * @see {@link ListDeviceDefinitionVersionsCommand} + */ + listDeviceDefinitionVersions( args: ListDeviceDefinitionVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeviceDefinitionVersions( + listDeviceDefinitionVersions( args: ListDeviceDefinitionVersionsCommandInput, cb: (err: any, data?: ListDeviceDefinitionVersionsCommandOutput) => void ): void; - public listDeviceDefinitionVersions( + listDeviceDefinitionVersions( args: ListDeviceDefinitionVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeviceDefinitionVersionsCommandOutput) => void ): void; - public listDeviceDefinitionVersions( - args: ListDeviceDefinitionVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeviceDefinitionVersionsCommandOutput) => void), - cb?: (err: any, data?: ListDeviceDefinitionVersionsCommandOutput) => void - ): Promise | void { - const command = new ListDeviceDefinitionVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves a list of Lambda function definitions. - */ - public listFunctionDefinitions( + + /** + * @see {@link ListFunctionDefinitionsCommand} + */ + listFunctionDefinitions( args: ListFunctionDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFunctionDefinitions( + listFunctionDefinitions( args: ListFunctionDefinitionsCommandInput, cb: (err: any, data?: ListFunctionDefinitionsCommandOutput) => void ): void; - public listFunctionDefinitions( + listFunctionDefinitions( args: ListFunctionDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFunctionDefinitionsCommandOutput) => void ): void; - public listFunctionDefinitions( - args: ListFunctionDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFunctionDefinitionsCommandOutput) => void), - cb?: (err: any, data?: ListFunctionDefinitionsCommandOutput) => void - ): Promise | void { - const command = new ListFunctionDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Lists the versions of a Lambda function definition. - */ - public listFunctionDefinitionVersions( + + /** + * @see {@link ListFunctionDefinitionVersionsCommand} + */ + listFunctionDefinitionVersions( args: ListFunctionDefinitionVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFunctionDefinitionVersions( + listFunctionDefinitionVersions( args: ListFunctionDefinitionVersionsCommandInput, cb: (err: any, data?: ListFunctionDefinitionVersionsCommandOutput) => void ): void; - public listFunctionDefinitionVersions( + listFunctionDefinitionVersions( args: ListFunctionDefinitionVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFunctionDefinitionVersionsCommandOutput) => void ): void; - public listFunctionDefinitionVersions( - args: ListFunctionDefinitionVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFunctionDefinitionVersionsCommandOutput) => void), - cb?: (err: any, data?: ListFunctionDefinitionVersionsCommandOutput) => void - ): Promise | void { - const command = new ListFunctionDefinitionVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves the current CAs for a group. - */ - public listGroupCertificateAuthorities( + + /** + * @see {@link ListGroupCertificateAuthoritiesCommand} + */ + listGroupCertificateAuthorities( args: ListGroupCertificateAuthoritiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGroupCertificateAuthorities( + listGroupCertificateAuthorities( args: ListGroupCertificateAuthoritiesCommandInput, cb: (err: any, data?: ListGroupCertificateAuthoritiesCommandOutput) => void ): void; - public listGroupCertificateAuthorities( + listGroupCertificateAuthorities( args: ListGroupCertificateAuthoritiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupCertificateAuthoritiesCommandOutput) => void ): void; - public listGroupCertificateAuthorities( - args: ListGroupCertificateAuthoritiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGroupCertificateAuthoritiesCommandOutput) => void), - cb?: (err: any, data?: ListGroupCertificateAuthoritiesCommandOutput) => void - ): Promise | void { - const command = new ListGroupCertificateAuthoritiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves a list of groups. - */ - public listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise; - public listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void; - public listGroups( + + /** + * @see {@link ListGroupsCommand} + */ + listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise; + listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void; + listGroups( args: ListGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsCommandOutput) => void ): void; - public listGroups( - args: ListGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGroupsCommandOutput) => void), - cb?: (err: any, data?: ListGroupsCommandOutput) => void - ): Promise | void { - const command = new ListGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Lists the versions of a group. - */ - public listGroupVersions( + + /** + * @see {@link ListGroupVersionsCommand} + */ + listGroupVersions( args: ListGroupVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGroupVersions( + listGroupVersions( args: ListGroupVersionsCommandInput, cb: (err: any, data?: ListGroupVersionsCommandOutput) => void ): void; - public listGroupVersions( + listGroupVersions( args: ListGroupVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupVersionsCommandOutput) => void ): void; - public listGroupVersions( - args: ListGroupVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGroupVersionsCommandOutput) => void), - cb?: (err: any, data?: ListGroupVersionsCommandOutput) => void - ): Promise | void { - const command = new ListGroupVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves a list of logger definitions. - */ - public listLoggerDefinitions( + + /** + * @see {@link ListLoggerDefinitionsCommand} + */ + listLoggerDefinitions( args: ListLoggerDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLoggerDefinitions( + listLoggerDefinitions( args: ListLoggerDefinitionsCommandInput, cb: (err: any, data?: ListLoggerDefinitionsCommandOutput) => void ): void; - public listLoggerDefinitions( + listLoggerDefinitions( args: ListLoggerDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLoggerDefinitionsCommandOutput) => void ): void; - public listLoggerDefinitions( - args: ListLoggerDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLoggerDefinitionsCommandOutput) => void), - cb?: (err: any, data?: ListLoggerDefinitionsCommandOutput) => void - ): Promise | void { - const command = new ListLoggerDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Lists the versions of a logger definition. - */ - public listLoggerDefinitionVersions( + + /** + * @see {@link ListLoggerDefinitionVersionsCommand} + */ + listLoggerDefinitionVersions( args: ListLoggerDefinitionVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLoggerDefinitionVersions( + listLoggerDefinitionVersions( args: ListLoggerDefinitionVersionsCommandInput, cb: (err: any, data?: ListLoggerDefinitionVersionsCommandOutput) => void ): void; - public listLoggerDefinitionVersions( + listLoggerDefinitionVersions( args: ListLoggerDefinitionVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLoggerDefinitionVersionsCommandOutput) => void ): void; - public listLoggerDefinitionVersions( - args: ListLoggerDefinitionVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLoggerDefinitionVersionsCommandOutput) => void), - cb?: (err: any, data?: ListLoggerDefinitionVersionsCommandOutput) => void - ): Promise | void { - const command = new ListLoggerDefinitionVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves a list of resource definitions. - */ - public listResourceDefinitions( + + /** + * @see {@link ListResourceDefinitionsCommand} + */ + listResourceDefinitions( args: ListResourceDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourceDefinitions( + listResourceDefinitions( args: ListResourceDefinitionsCommandInput, cb: (err: any, data?: ListResourceDefinitionsCommandOutput) => void ): void; - public listResourceDefinitions( + listResourceDefinitions( args: ListResourceDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceDefinitionsCommandOutput) => void ): void; - public listResourceDefinitions( - args: ListResourceDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourceDefinitionsCommandOutput) => void), - cb?: (err: any, data?: ListResourceDefinitionsCommandOutput) => void - ): Promise | void { - const command = new ListResourceDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Lists the versions of a resource definition. - */ - public listResourceDefinitionVersions( + + /** + * @see {@link ListResourceDefinitionVersionsCommand} + */ + listResourceDefinitionVersions( args: ListResourceDefinitionVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourceDefinitionVersions( + listResourceDefinitionVersions( args: ListResourceDefinitionVersionsCommandInput, cb: (err: any, data?: ListResourceDefinitionVersionsCommandOutput) => void ): void; - public listResourceDefinitionVersions( + listResourceDefinitionVersions( args: ListResourceDefinitionVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceDefinitionVersionsCommandOutput) => void ): void; - public listResourceDefinitionVersions( - args: ListResourceDefinitionVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourceDefinitionVersionsCommandOutput) => void), - cb?: (err: any, data?: ListResourceDefinitionVersionsCommandOutput) => void - ): Promise | void { - const command = new ListResourceDefinitionVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves a list of subscription definitions. - */ - public listSubscriptionDefinitions( + + /** + * @see {@link ListSubscriptionDefinitionsCommand} + */ + listSubscriptionDefinitions( args: ListSubscriptionDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSubscriptionDefinitions( + listSubscriptionDefinitions( args: ListSubscriptionDefinitionsCommandInput, cb: (err: any, data?: ListSubscriptionDefinitionsCommandOutput) => void ): void; - public listSubscriptionDefinitions( + listSubscriptionDefinitions( args: ListSubscriptionDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSubscriptionDefinitionsCommandOutput) => void ): void; - public listSubscriptionDefinitions( - args: ListSubscriptionDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSubscriptionDefinitionsCommandOutput) => void), - cb?: (err: any, data?: ListSubscriptionDefinitionsCommandOutput) => void - ): Promise | void { - const command = new ListSubscriptionDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Lists the versions of a subscription definition. - */ - public listSubscriptionDefinitionVersions( + + /** + * @see {@link ListSubscriptionDefinitionVersionsCommand} + */ + listSubscriptionDefinitionVersions( args: ListSubscriptionDefinitionVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSubscriptionDefinitionVersions( + listSubscriptionDefinitionVersions( args: ListSubscriptionDefinitionVersionsCommandInput, cb: (err: any, data?: ListSubscriptionDefinitionVersionsCommandOutput) => void ): void; - public listSubscriptionDefinitionVersions( + listSubscriptionDefinitionVersions( args: ListSubscriptionDefinitionVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSubscriptionDefinitionVersionsCommandOutput) => void ): void; - public listSubscriptionDefinitionVersions( - args: ListSubscriptionDefinitionVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSubscriptionDefinitionVersionsCommandOutput) => void), - cb?: (err: any, data?: ListSubscriptionDefinitionVersionsCommandOutput) => void - ): Promise | void { - const command = new ListSubscriptionDefinitionVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Retrieves a list of resource tags for a resource arn. - */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Resets a group's deployments. - */ - public resetDeployments( + + /** + * @see {@link ResetDeploymentsCommand} + */ + resetDeployments( args: ResetDeploymentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetDeployments( + resetDeployments( args: ResetDeploymentsCommandInput, cb: (err: any, data?: ResetDeploymentsCommandOutput) => void ): void; - public resetDeployments( + resetDeployments( args: ResetDeploymentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetDeploymentsCommandOutput) => void ): void; - public resetDeployments( - args: ResetDeploymentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetDeploymentsCommandOutput) => void), - cb?: (err: any, data?: ResetDeploymentsCommandOutput) => void - ): Promise | void { - const command = new ResetDeploymentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Deploys multiple groups in one operation. This action starts the bulk deployment of a specified set of group versions. Each group version deployment will be triggered with an adaptive rate that has a fixed upper limit. We recommend that you include an ''X-Amzn-Client-Token'' token in every ''StartBulkDeployment'' request. These requests are idempotent with respect to the token and the request parameters. - */ - public startBulkDeployment( + + /** + * @see {@link StartBulkDeploymentCommand} + */ + startBulkDeployment( args: StartBulkDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public startBulkDeployment( + startBulkDeployment( args: StartBulkDeploymentCommandInput, cb: (err: any, data?: StartBulkDeploymentCommandOutput) => void ): void; - public startBulkDeployment( + startBulkDeployment( args: StartBulkDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartBulkDeploymentCommandOutput) => void ): void; - public startBulkDeployment( - args: StartBulkDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartBulkDeploymentCommandOutput) => void), - cb?: (err: any, data?: StartBulkDeploymentCommandOutput) => void - ): Promise | void { - const command = new StartBulkDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Stops the execution of a bulk deployment. This action returns a status of ''Stopping'' until the deployment is stopped. You cannot start a new bulk deployment while a previous deployment is in the ''Stopping'' state. This action doesn't rollback completed deployments or cancel pending deployments. - */ - public stopBulkDeployment( + + /** + * @see {@link StopBulkDeploymentCommand} + */ + stopBulkDeployment( args: StopBulkDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopBulkDeployment( + stopBulkDeployment( args: StopBulkDeploymentCommandInput, cb: (err: any, data?: StopBulkDeploymentCommandOutput) => void ): void; - public stopBulkDeployment( + stopBulkDeployment( args: StopBulkDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopBulkDeploymentCommandOutput) => void ): void; - public stopBulkDeployment( - args: StopBulkDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopBulkDeploymentCommandOutput) => void), - cb?: (err: any, data?: StopBulkDeploymentCommandOutput) => void - ): Promise | void { - const command = new StopBulkDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Adds tags to a Greengrass resource. Valid resources are 'Group', 'ConnectorDefinition', 'CoreDefinition', 'DeviceDefinition', 'FunctionDefinition', 'LoggerDefinition', 'SubscriptionDefinition', 'ResourceDefinition', and 'BulkDeployment'. - */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Remove resource tags from a Greengrass Resource. - */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Updates the connectivity information for the core. Any devices that belong to the group which has this core will receive this information in order to find the location of the core and connect to it. - */ - public updateConnectivityInfo( + + /** + * @see {@link UpdateConnectivityInfoCommand} + */ + updateConnectivityInfo( args: UpdateConnectivityInfoCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConnectivityInfo( + updateConnectivityInfo( args: UpdateConnectivityInfoCommandInput, cb: (err: any, data?: UpdateConnectivityInfoCommandOutput) => void ): void; - public updateConnectivityInfo( + updateConnectivityInfo( args: UpdateConnectivityInfoCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectivityInfoCommandOutput) => void ): void; - public updateConnectivityInfo( - args: UpdateConnectivityInfoCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConnectivityInfoCommandOutput) => void), - cb?: (err: any, data?: UpdateConnectivityInfoCommandOutput) => void - ): Promise | void { - const command = new UpdateConnectivityInfoCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Updates a connector definition. - */ - public updateConnectorDefinition( + + /** + * @see {@link UpdateConnectorDefinitionCommand} + */ + updateConnectorDefinition( args: UpdateConnectorDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConnectorDefinition( + updateConnectorDefinition( args: UpdateConnectorDefinitionCommandInput, cb: (err: any, data?: UpdateConnectorDefinitionCommandOutput) => void ): void; - public updateConnectorDefinition( + updateConnectorDefinition( args: UpdateConnectorDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectorDefinitionCommandOutput) => void ): void; - public updateConnectorDefinition( - args: UpdateConnectorDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConnectorDefinitionCommandOutput) => void), - cb?: (err: any, data?: UpdateConnectorDefinitionCommandOutput) => void - ): Promise | void { - const command = new UpdateConnectorDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Updates a core definition. - */ - public updateCoreDefinition( + + /** + * @see {@link UpdateCoreDefinitionCommand} + */ + updateCoreDefinition( args: UpdateCoreDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCoreDefinition( + updateCoreDefinition( args: UpdateCoreDefinitionCommandInput, cb: (err: any, data?: UpdateCoreDefinitionCommandOutput) => void ): void; - public updateCoreDefinition( + updateCoreDefinition( args: UpdateCoreDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCoreDefinitionCommandOutput) => void ): void; - public updateCoreDefinition( - args: UpdateCoreDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCoreDefinitionCommandOutput) => void), - cb?: (err: any, data?: UpdateCoreDefinitionCommandOutput) => void - ): Promise | void { - const command = new UpdateCoreDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Updates a device definition. - */ - public updateDeviceDefinition( + + /** + * @see {@link UpdateDeviceDefinitionCommand} + */ + updateDeviceDefinition( args: UpdateDeviceDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDeviceDefinition( + updateDeviceDefinition( args: UpdateDeviceDefinitionCommandInput, cb: (err: any, data?: UpdateDeviceDefinitionCommandOutput) => void ): void; - public updateDeviceDefinition( + updateDeviceDefinition( args: UpdateDeviceDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDeviceDefinitionCommandOutput) => void ): void; - public updateDeviceDefinition( - args: UpdateDeviceDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDeviceDefinitionCommandOutput) => void), - cb?: (err: any, data?: UpdateDeviceDefinitionCommandOutput) => void - ): Promise | void { - const command = new UpdateDeviceDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Updates a Lambda function definition. - */ - public updateFunctionDefinition( + + /** + * @see {@link UpdateFunctionDefinitionCommand} + */ + updateFunctionDefinition( args: UpdateFunctionDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFunctionDefinition( + updateFunctionDefinition( args: UpdateFunctionDefinitionCommandInput, cb: (err: any, data?: UpdateFunctionDefinitionCommandOutput) => void ): void; - public updateFunctionDefinition( + updateFunctionDefinition( args: UpdateFunctionDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFunctionDefinitionCommandOutput) => void ): void; - public updateFunctionDefinition( - args: UpdateFunctionDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFunctionDefinitionCommandOutput) => void), - cb?: (err: any, data?: UpdateFunctionDefinitionCommandOutput) => void - ): Promise | void { - const command = new UpdateFunctionDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Updates a group. - */ - public updateGroup(args: UpdateGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void; - public updateGroup( + + /** + * @see {@link UpdateGroupCommand} + */ + updateGroup(args: UpdateGroupCommandInput, options?: __HttpHandlerOptions): Promise; + updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void; + updateGroup( args: UpdateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGroupCommandOutput) => void ): void; - public updateGroup( - args: UpdateGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Updates the Certificate expiry time for a group. - */ - public updateGroupCertificateConfiguration( + + /** + * @see {@link UpdateGroupCertificateConfigurationCommand} + */ + updateGroupCertificateConfiguration( args: UpdateGroupCertificateConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGroupCertificateConfiguration( + updateGroupCertificateConfiguration( args: UpdateGroupCertificateConfigurationCommandInput, cb: (err: any, data?: UpdateGroupCertificateConfigurationCommandOutput) => void ): void; - public updateGroupCertificateConfiguration( + updateGroupCertificateConfiguration( args: UpdateGroupCertificateConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGroupCertificateConfigurationCommandOutput) => void ): void; - public updateGroupCertificateConfiguration( - args: UpdateGroupCertificateConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGroupCertificateConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateGroupCertificateConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateGroupCertificateConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Updates a logger definition. - */ - public updateLoggerDefinition( + + /** + * @see {@link UpdateLoggerDefinitionCommand} + */ + updateLoggerDefinition( args: UpdateLoggerDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLoggerDefinition( + updateLoggerDefinition( args: UpdateLoggerDefinitionCommandInput, cb: (err: any, data?: UpdateLoggerDefinitionCommandOutput) => void ): void; - public updateLoggerDefinition( + updateLoggerDefinition( args: UpdateLoggerDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLoggerDefinitionCommandOutput) => void ): void; - public updateLoggerDefinition( - args: UpdateLoggerDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLoggerDefinitionCommandOutput) => void), - cb?: (err: any, data?: UpdateLoggerDefinitionCommandOutput) => void - ): Promise | void { - const command = new UpdateLoggerDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Updates a resource definition. - */ - public updateResourceDefinition( + + /** + * @see {@link UpdateResourceDefinitionCommand} + */ + updateResourceDefinition( args: UpdateResourceDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateResourceDefinition( + updateResourceDefinition( args: UpdateResourceDefinitionCommandInput, cb: (err: any, data?: UpdateResourceDefinitionCommandOutput) => void ): void; - public updateResourceDefinition( + updateResourceDefinition( args: UpdateResourceDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResourceDefinitionCommandOutput) => void ): void; - public updateResourceDefinition( - args: UpdateResourceDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResourceDefinitionCommandOutput) => void), - cb?: (err: any, data?: UpdateResourceDefinitionCommandOutput) => void - ): Promise | void { - const command = new UpdateResourceDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Updates a subscription definition. - */ - public updateSubscriptionDefinition( + + /** + * @see {@link UpdateSubscriptionDefinitionCommand} + */ + updateSubscriptionDefinition( args: UpdateSubscriptionDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSubscriptionDefinition( + updateSubscriptionDefinition( args: UpdateSubscriptionDefinitionCommandInput, cb: (err: any, data?: UpdateSubscriptionDefinitionCommandOutput) => void ): void; - public updateSubscriptionDefinition( + updateSubscriptionDefinition( args: UpdateSubscriptionDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSubscriptionDefinitionCommandOutput) => void ): void; - public updateSubscriptionDefinition( - args: UpdateSubscriptionDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSubscriptionDefinitionCommandOutput) => void), - cb?: (err: any, data?: UpdateSubscriptionDefinitionCommandOutput) => void - ): Promise | void { - const command = new UpdateSubscriptionDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Updates the runtime configuration of a thing. - */ - public updateThingRuntimeConfiguration( + + /** + * @see {@link UpdateThingRuntimeConfigurationCommand} + */ + updateThingRuntimeConfiguration( args: UpdateThingRuntimeConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateThingRuntimeConfiguration( + updateThingRuntimeConfiguration( args: UpdateThingRuntimeConfigurationCommandInput, cb: (err: any, data?: UpdateThingRuntimeConfigurationCommandOutput) => void ): void; - public updateThingRuntimeConfiguration( + updateThingRuntimeConfiguration( args: UpdateThingRuntimeConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateThingRuntimeConfigurationCommandOutput) => void ): void; - public updateThingRuntimeConfiguration( - args: UpdateThingRuntimeConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateThingRuntimeConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateThingRuntimeConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateThingRuntimeConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * AWS IoT Greengrass seamlessly extends AWS onto physical devices so they can act locally on the data they generate, while still using the cloud for management, analytics, and durable storage. AWS IoT Greengrass ensures your devices can respond quickly to local events and operate with intermittent connectivity. AWS IoT Greengrass minimizes the cost of transmitting data to the cloud by allowing you to author AWS Lambda functions that execute locally. + */ +export class Greengrass extends GreengrassClient implements Greengrass {} +createAggregatedClient(commands, Greengrass); diff --git a/clients/client-greengrassv2/src/GreengrassV2.ts b/clients/client-greengrassv2/src/GreengrassV2.ts index 0a67de757543..3b92de7d3391 100644 --- a/clients/client-greengrassv2/src/GreengrassV2.ts +++ b/clients/client-greengrassv2/src/GreengrassV2.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -142,1206 +143,506 @@ import { UpdateConnectivityInfoCommandInput, UpdateConnectivityInfoCommandOutput, } from "./commands/UpdateConnectivityInfoCommand"; -import { GreengrassV2Client } from "./GreengrassV2Client"; +import { GreengrassV2Client, GreengrassV2ClientConfig } from "./GreengrassV2Client"; -/** - * @public - *

IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities - * to edge devices. This enables devices to collect and analyze data closer to the source of - * information, react autonomously to local events, and communicate securely with each other on - * local networks. Local devices can also communicate securely with Amazon Web Services IoT Core and export IoT data - * to the Amazon Web Services Cloud. IoT Greengrass developers can use Lambda functions and components to create and - * deploy applications to fleets of edge devices for local operation.

- *

IoT Greengrass Version 2 provides a new major version of the IoT Greengrass Core software, new APIs, and a new console. - * Use this API reference to learn how to use the IoT Greengrass V2 API operations to manage components, - * manage deployments, and core devices.

- *

For more information, see What is IoT Greengrass? in the - * IoT Greengrass V2 Developer Guide.

- */ -export class GreengrassV2 extends GreengrassV2Client { +const commands = { + AssociateServiceRoleToAccountCommand, + BatchAssociateClientDeviceWithCoreDeviceCommand, + BatchDisassociateClientDeviceFromCoreDeviceCommand, + CancelDeploymentCommand, + CreateComponentVersionCommand, + CreateDeploymentCommand, + DeleteComponentCommand, + DeleteCoreDeviceCommand, + DeleteDeploymentCommand, + DescribeComponentCommand, + DisassociateServiceRoleFromAccountCommand, + GetComponentCommand, + GetComponentVersionArtifactCommand, + GetConnectivityInfoCommand, + GetCoreDeviceCommand, + GetDeploymentCommand, + GetServiceRoleForAccountCommand, + ListClientDevicesAssociatedWithCoreDeviceCommand, + ListComponentsCommand, + ListComponentVersionsCommand, + ListCoreDevicesCommand, + ListDeploymentsCommand, + ListEffectiveDeploymentsCommand, + ListInstalledComponentsCommand, + ListTagsForResourceCommand, + ResolveComponentCandidatesCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateConnectivityInfoCommand, +}; + +export interface GreengrassV2 { /** - * @public - *

Associates a Greengrass service role with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass - * uses this role to verify the identity of client devices and manage core device connectivity - * information. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy or a custom policy that - * defines equivalent permissions for the IoT Greengrass features that you use. For more information, see - * Greengrass service role in the IoT Greengrass Version 2 Developer Guide.

+ * @see {@link AssociateServiceRoleToAccountCommand} */ - public associateServiceRoleToAccount( + associateServiceRoleToAccount( args: AssociateServiceRoleToAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateServiceRoleToAccount( + associateServiceRoleToAccount( args: AssociateServiceRoleToAccountCommandInput, cb: (err: any, data?: AssociateServiceRoleToAccountCommandOutput) => void ): void; - public associateServiceRoleToAccount( + associateServiceRoleToAccount( args: AssociateServiceRoleToAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateServiceRoleToAccountCommandOutput) => void ): void; - public associateServiceRoleToAccount( - args: AssociateServiceRoleToAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateServiceRoleToAccountCommandOutput) => void), - cb?: (err: any, data?: AssociateServiceRoleToAccountCommandOutput) => void - ): Promise | void { - const command = new AssociateServiceRoleToAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a list of client devices with a core device. Use this API operation to specify - * which client devices can discover a core device through cloud discovery. With cloud discovery, - * client devices connect to IoT Greengrass to retrieve associated core devices' connectivity information - * and certificates. For more information, see Configure cloud - * discovery in the IoT Greengrass V2 Developer Guide.

- * - *

Client devices are local IoT devices that connect to and communicate with an IoT Greengrass core - * device over MQTT. You can connect client devices to a core device to sync MQTT messages and - * data to Amazon Web Services IoT Core and interact with client devices in Greengrass components. For more information, - * see Interact with - * local IoT devices in the IoT Greengrass V2 Developer Guide.

- *
+ * @see {@link BatchAssociateClientDeviceWithCoreDeviceCommand} */ - public batchAssociateClientDeviceWithCoreDevice( + batchAssociateClientDeviceWithCoreDevice( args: BatchAssociateClientDeviceWithCoreDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchAssociateClientDeviceWithCoreDevice( + batchAssociateClientDeviceWithCoreDevice( args: BatchAssociateClientDeviceWithCoreDeviceCommandInput, cb: (err: any, data?: BatchAssociateClientDeviceWithCoreDeviceCommandOutput) => void ): void; - public batchAssociateClientDeviceWithCoreDevice( + batchAssociateClientDeviceWithCoreDevice( args: BatchAssociateClientDeviceWithCoreDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchAssociateClientDeviceWithCoreDeviceCommandOutput) => void ): void; - public batchAssociateClientDeviceWithCoreDevice( - args: BatchAssociateClientDeviceWithCoreDeviceCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: BatchAssociateClientDeviceWithCoreDeviceCommandOutput) => void), - cb?: (err: any, data?: BatchAssociateClientDeviceWithCoreDeviceCommandOutput) => void - ): Promise | void { - const command = new BatchAssociateClientDeviceWithCoreDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates a list of client devices from a core device. After you disassociate a client - * device from a core device, the client device won't be able to use cloud discovery to retrieve - * the core device's connectivity information and certificates.

+ * @see {@link BatchDisassociateClientDeviceFromCoreDeviceCommand} */ - public batchDisassociateClientDeviceFromCoreDevice( + batchDisassociateClientDeviceFromCoreDevice( args: BatchDisassociateClientDeviceFromCoreDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDisassociateClientDeviceFromCoreDevice( + batchDisassociateClientDeviceFromCoreDevice( args: BatchDisassociateClientDeviceFromCoreDeviceCommandInput, cb: (err: any, data?: BatchDisassociateClientDeviceFromCoreDeviceCommandOutput) => void ): void; - public batchDisassociateClientDeviceFromCoreDevice( + batchDisassociateClientDeviceFromCoreDevice( args: BatchDisassociateClientDeviceFromCoreDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDisassociateClientDeviceFromCoreDeviceCommandOutput) => void ): void; - public batchDisassociateClientDeviceFromCoreDevice( - args: BatchDisassociateClientDeviceFromCoreDeviceCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: BatchDisassociateClientDeviceFromCoreDeviceCommandOutput) => void), - cb?: (err: any, data?: BatchDisassociateClientDeviceFromCoreDeviceCommandOutput) => void - ): Promise | void { - const command = new BatchDisassociateClientDeviceFromCoreDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels a deployment. This operation cancels the deployment for devices that haven't yet - * received it. If a device already received the deployment, this operation doesn't change - * anything for that device.

+ * @see {@link CancelDeploymentCommand} */ - public cancelDeployment( + cancelDeployment( args: CancelDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelDeployment( + cancelDeployment( args: CancelDeploymentCommandInput, cb: (err: any, data?: CancelDeploymentCommandOutput) => void ): void; - public cancelDeployment( + cancelDeployment( args: CancelDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelDeploymentCommandOutput) => void ): void; - public cancelDeployment( - args: CancelDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelDeploymentCommandOutput) => void), - cb?: (err: any, data?: CancelDeploymentCommandOutput) => void - ): Promise | void { - const command = new CancelDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a component. Components are software that run on Greengrass core devices. After you - * develop and test a component on your core device, you can use this operation to upload your - * component to IoT Greengrass. Then, you can deploy the component to other core devices.

- *

You can use this operation to do the following:

- *
    - *
  • - *

    - * Create components from recipes - *

    - *

    Create a component from a recipe, which is a file that defines the component's - * metadata, parameters, dependencies, lifecycle, artifacts, and platform capability. For - * more information, see IoT Greengrass component recipe - * reference in the IoT Greengrass V2 Developer Guide.

    - *

    To create a component from a recipe, specify inlineRecipe when you call - * this operation.

    - *
  • - *
  • - *

    - * Create components from Lambda functions - *

    - *

    Create a component from an Lambda function that runs on IoT Greengrass. This creates a recipe - * and artifacts from the Lambda function's deployment package. You can use this operation to - * migrate Lambda functions from IoT Greengrass V1 to IoT Greengrass V2.

    - *

    This function only accepts Lambda functions that use the following runtimes:

    - *
      - *
    • - *

      Python 2.7 – python2.7 - *

      - *
    • - *
    • - *

      Python 3.7 – python3.7 - *

      - *
    • - *
    • - *

      Python 3.8 – python3.8 - *

      - *
    • - *
    • - *

      Python 3.9 – python3.9 - *

      - *
    • - *
    • - *

      Java 8 – java8 - *

      - *
    • - *
    • - *

      Java 11 – java11 - *

      - *
    • - *
    • - *

      Node.js 10 – nodejs10.x - *

      - *
    • - *
    • - *

      Node.js 12 – nodejs12.x - *

      - *
    • - *
    • - *

      Node.js 14 – nodejs14.x - *

      - *
    • - *
    - *

    To create a component from a Lambda function, specify lambdaFunction when - * you call this operation.

    - * - *

    IoT Greengrass currently supports Lambda functions on only Linux core devices.

    - *
    - *
  • - *
+ * @see {@link CreateComponentVersionCommand} */ - public createComponentVersion( + createComponentVersion( args: CreateComponentVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createComponentVersion( + createComponentVersion( args: CreateComponentVersionCommandInput, cb: (err: any, data?: CreateComponentVersionCommandOutput) => void ): void; - public createComponentVersion( + createComponentVersion( args: CreateComponentVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateComponentVersionCommandOutput) => void ): void; - public createComponentVersion( - args: CreateComponentVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateComponentVersionCommandOutput) => void), - cb?: (err: any, data?: CreateComponentVersionCommandOutput) => void - ): Promise | void { - const command = new CreateComponentVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a continuous deployment for a target, which is a Greengrass core device or group of core - * devices. When you add a new core device to a group of core devices that has a deployment, IoT Greengrass - * deploys that group's deployment to the new device.

- *

You can define one deployment for each target. When you create a new deployment for a - * target that has an existing deployment, you replace the previous deployment. IoT Greengrass applies the - * new deployment to the target devices.

- *

Every deployment has a revision number that indicates how many deployment revisions you - * define for a target. Use this operation to create a new revision of an existing - * deployment.

- *

For more information, see the Create deployments in the - * IoT Greengrass V2 Developer Guide.

+ * @see {@link CreateDeploymentCommand} */ - public createDeployment( + createDeployment( args: CreateDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDeployment( + createDeployment( args: CreateDeploymentCommandInput, cb: (err: any, data?: CreateDeploymentCommandOutput) => void ): void; - public createDeployment( + createDeployment( args: CreateDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeploymentCommandOutput) => void ): void; - public createDeployment( - args: CreateDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDeploymentCommandOutput) => void), - cb?: (err: any, data?: CreateDeploymentCommandOutput) => void - ): Promise | void { - const command = new CreateDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a version of a component from IoT Greengrass.

- * - *

This operation deletes the component's recipe and artifacts. As a result, deployments - * that refer to this component version will fail. If you have deployments that use this - * component version, you can remove the component from the deployment or update the deployment - * to use a valid version.

- *
+ * @see {@link DeleteComponentCommand} */ - public deleteComponent( + deleteComponent( args: DeleteComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteComponent( - args: DeleteComponentCommandInput, - cb: (err: any, data?: DeleteComponentCommandOutput) => void - ): void; - public deleteComponent( + deleteComponent(args: DeleteComponentCommandInput, cb: (err: any, data?: DeleteComponentCommandOutput) => void): void; + deleteComponent( args: DeleteComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteComponentCommandOutput) => void ): void; - public deleteComponent( - args: DeleteComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteComponentCommandOutput) => void), - cb?: (err: any, data?: DeleteComponentCommandOutput) => void - ): Promise | void { - const command = new DeleteComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Greengrass core device, which is an IoT thing. This operation removes the core - * device from the list of core devices. This operation doesn't delete the IoT thing. For more - * information about how to delete the IoT thing, see DeleteThing in the - * IoT API Reference.

+ * @see {@link DeleteCoreDeviceCommand} */ - public deleteCoreDevice( + deleteCoreDevice( args: DeleteCoreDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCoreDevice( + deleteCoreDevice( args: DeleteCoreDeviceCommandInput, cb: (err: any, data?: DeleteCoreDeviceCommandOutput) => void ): void; - public deleteCoreDevice( + deleteCoreDevice( args: DeleteCoreDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCoreDeviceCommandOutput) => void ): void; - public deleteCoreDevice( - args: DeleteCoreDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCoreDeviceCommandOutput) => void), - cb?: (err: any, data?: DeleteCoreDeviceCommandOutput) => void - ): Promise | void { - const command = new DeleteCoreDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a deployment. To delete an active deployment, you must first cancel it. For more - * information, see CancelDeployment.

- *

Deleting a deployment doesn't affect core devices that run that deployment, because core - * devices store the deployment's configuration on the device. Additionally, core devices can - * roll back to a previous deployment that has been deleted.

+ * @see {@link DeleteDeploymentCommand} */ - public deleteDeployment( + deleteDeployment( args: DeleteDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDeployment( + deleteDeployment( args: DeleteDeploymentCommandInput, cb: (err: any, data?: DeleteDeploymentCommandOutput) => void ): void; - public deleteDeployment( + deleteDeployment( args: DeleteDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDeploymentCommandOutput) => void ): void; - public deleteDeployment( - args: DeleteDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDeploymentCommandOutput) => void), - cb?: (err: any, data?: DeleteDeploymentCommandOutput) => void - ): Promise | void { - const command = new DeleteDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves metadata for a version of a component.

+ * @see {@link DescribeComponentCommand} */ - public describeComponent( + describeComponent( args: DescribeComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeComponent( + describeComponent( args: DescribeComponentCommandInput, cb: (err: any, data?: DescribeComponentCommandOutput) => void ): void; - public describeComponent( + describeComponent( args: DescribeComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeComponentCommandOutput) => void ): void; - public describeComponent( - args: DescribeComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeComponentCommandOutput) => void), - cb?: (err: any, data?: DescribeComponentCommandOutput) => void - ): Promise | void { - const command = new DescribeComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. - * Without a service role, IoT Greengrass can't verify the identity of client devices or manage core device - * connectivity information. For more information, see Greengrass service role in - * the IoT Greengrass Version 2 Developer Guide.

+ * @see {@link DisassociateServiceRoleFromAccountCommand} */ - public disassociateServiceRoleFromAccount( + disassociateServiceRoleFromAccount( args: DisassociateServiceRoleFromAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateServiceRoleFromAccount( + disassociateServiceRoleFromAccount( args: DisassociateServiceRoleFromAccountCommandInput, cb: (err: any, data?: DisassociateServiceRoleFromAccountCommandOutput) => void ): void; - public disassociateServiceRoleFromAccount( + disassociateServiceRoleFromAccount( args: DisassociateServiceRoleFromAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateServiceRoleFromAccountCommandOutput) => void ): void; - public disassociateServiceRoleFromAccount( - args: DisassociateServiceRoleFromAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateServiceRoleFromAccountCommandOutput) => void), - cb?: (err: any, data?: DisassociateServiceRoleFromAccountCommandOutput) => void - ): Promise | void { - const command = new DisassociateServiceRoleFromAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the recipe for a version of a component.

+ * @see {@link GetComponentCommand} */ - public getComponent( - args: GetComponentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getComponent(args: GetComponentCommandInput, cb: (err: any, data?: GetComponentCommandOutput) => void): void; - public getComponent( + getComponent(args: GetComponentCommandInput, options?: __HttpHandlerOptions): Promise; + getComponent(args: GetComponentCommandInput, cb: (err: any, data?: GetComponentCommandOutput) => void): void; + getComponent( args: GetComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComponentCommandOutput) => void ): void; - public getComponent( - args: GetComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetComponentCommandOutput) => void), - cb?: (err: any, data?: GetComponentCommandOutput) => void - ): Promise | void { - const command = new GetComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the pre-signed URL to download a public or a Lambda component artifact. Core devices - * call this operation to identify the URL that they can use to download an artifact to - * install.

+ * @see {@link GetComponentVersionArtifactCommand} */ - public getComponentVersionArtifact( + getComponentVersionArtifact( args: GetComponentVersionArtifactCommandInput, options?: __HttpHandlerOptions ): Promise; - public getComponentVersionArtifact( + getComponentVersionArtifact( args: GetComponentVersionArtifactCommandInput, cb: (err: any, data?: GetComponentVersionArtifactCommandOutput) => void ): void; - public getComponentVersionArtifact( + getComponentVersionArtifact( args: GetComponentVersionArtifactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComponentVersionArtifactCommandOutput) => void ): void; - public getComponentVersionArtifact( - args: GetComponentVersionArtifactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetComponentVersionArtifactCommandOutput) => void), - cb?: (err: any, data?: GetComponentVersionArtifactCommandOutput) => void - ): Promise | void { - const command = new GetComponentVersionArtifactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves connectivity information for a Greengrass core device.

- *

Connectivity information includes endpoints and ports where client devices - * can connect to an MQTT broker on the core device. When a client device - * calls the IoT Greengrass discovery API, - * IoT Greengrass returns connectivity information for all of the core devices where the client device can - * connect. For more information, see Connect client devices to - * core devices in the IoT Greengrass Version 2 Developer Guide.

+ * @see {@link GetConnectivityInfoCommand} */ - public getConnectivityInfo( + getConnectivityInfo( args: GetConnectivityInfoCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConnectivityInfo( + getConnectivityInfo( args: GetConnectivityInfoCommandInput, cb: (err: any, data?: GetConnectivityInfoCommandOutput) => void ): void; - public getConnectivityInfo( + getConnectivityInfo( args: GetConnectivityInfoCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConnectivityInfoCommandOutput) => void ): void; - public getConnectivityInfo( - args: GetConnectivityInfoCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConnectivityInfoCommandOutput) => void), - cb?: (err: any, data?: GetConnectivityInfoCommandOutput) => void - ): Promise | void { - const command = new GetConnectivityInfoCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves metadata for a Greengrass core device.

- * - *

IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the - * IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, - * then the reported status of that device might not reflect its current status. The status - * timestamp indicates when the device status was last updated.

- *

Core devices send status updates at the following times:

- *
    - *
  • - *

    When the IoT Greengrass Core software starts

    - *
  • - *
  • - *

    When the core device receives a deployment from the Amazon Web Services Cloud

    - *
  • - *
  • - *

    When the status of any component on the core device becomes - * BROKEN - *

    - *
  • - *
  • - *

    At a regular interval that you can configure, which defaults to 24 hours

    - *
  • - *
  • - *

    For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and - * cloud deployment

    - *
  • - *
- *
+ * @see {@link GetCoreDeviceCommand} */ - public getCoreDevice( - args: GetCoreDeviceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getCoreDevice( - args: GetCoreDeviceCommandInput, - cb: (err: any, data?: GetCoreDeviceCommandOutput) => void - ): void; - public getCoreDevice( + getCoreDevice(args: GetCoreDeviceCommandInput, options?: __HttpHandlerOptions): Promise; + getCoreDevice(args: GetCoreDeviceCommandInput, cb: (err: any, data?: GetCoreDeviceCommandOutput) => void): void; + getCoreDevice( args: GetCoreDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCoreDeviceCommandOutput) => void ): void; - public getCoreDevice( - args: GetCoreDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCoreDeviceCommandOutput) => void), - cb?: (err: any, data?: GetCoreDeviceCommandOutput) => void - ): Promise | void { - const command = new GetCoreDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a deployment. Deployments define the components that run on Greengrass core devices.

+ * @see {@link GetDeploymentCommand} */ - public getDeployment( - args: GetDeploymentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getDeployment( - args: GetDeploymentCommandInput, - cb: (err: any, data?: GetDeploymentCommandOutput) => void - ): void; - public getDeployment( + getDeployment(args: GetDeploymentCommandInput, options?: __HttpHandlerOptions): Promise; + getDeployment(args: GetDeploymentCommandInput, cb: (err: any, data?: GetDeploymentCommandOutput) => void): void; + getDeployment( args: GetDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeploymentCommandOutput) => void ): void; - public getDeployment( - args: GetDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeploymentCommandOutput) => void), - cb?: (err: any, data?: GetDeploymentCommandOutput) => void - ): Promise | void { - const command = new GetDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the service role associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. - * IoT Greengrass uses this role to verify the identity of client devices and manage core device - * connectivity information. For more information, see Greengrass service role in - * the IoT Greengrass Version 2 Developer Guide.

+ * @see {@link GetServiceRoleForAccountCommand} */ - public getServiceRoleForAccount( + getServiceRoleForAccount( args: GetServiceRoleForAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServiceRoleForAccount( + getServiceRoleForAccount( args: GetServiceRoleForAccountCommandInput, cb: (err: any, data?: GetServiceRoleForAccountCommandOutput) => void ): void; - public getServiceRoleForAccount( + getServiceRoleForAccount( args: GetServiceRoleForAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceRoleForAccountCommandOutput) => void ): void; - public getServiceRoleForAccount( - args: GetServiceRoleForAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceRoleForAccountCommandOutput) => void), - cb?: (err: any, data?: GetServiceRoleForAccountCommandOutput) => void - ): Promise | void { - const command = new GetServiceRoleForAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a paginated list of client devices that are associated with a core - * device.

+ * @see {@link ListClientDevicesAssociatedWithCoreDeviceCommand} */ - public listClientDevicesAssociatedWithCoreDevice( + listClientDevicesAssociatedWithCoreDevice( args: ListClientDevicesAssociatedWithCoreDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listClientDevicesAssociatedWithCoreDevice( + listClientDevicesAssociatedWithCoreDevice( args: ListClientDevicesAssociatedWithCoreDeviceCommandInput, cb: (err: any, data?: ListClientDevicesAssociatedWithCoreDeviceCommandOutput) => void ): void; - public listClientDevicesAssociatedWithCoreDevice( + listClientDevicesAssociatedWithCoreDevice( args: ListClientDevicesAssociatedWithCoreDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListClientDevicesAssociatedWithCoreDeviceCommandOutput) => void ): void; - public listClientDevicesAssociatedWithCoreDevice( - args: ListClientDevicesAssociatedWithCoreDeviceCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListClientDevicesAssociatedWithCoreDeviceCommandOutput) => void), - cb?: (err: any, data?: ListClientDevicesAssociatedWithCoreDeviceCommandOutput) => void - ): Promise | void { - const command = new ListClientDevicesAssociatedWithCoreDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a paginated list of component summaries. This list includes components that you - * have permission to view.

+ * @see {@link ListComponentsCommand} */ - public listComponents( + listComponents( args: ListComponentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listComponents( - args: ListComponentsCommandInput, - cb: (err: any, data?: ListComponentsCommandOutput) => void - ): void; - public listComponents( + listComponents(args: ListComponentsCommandInput, cb: (err: any, data?: ListComponentsCommandOutput) => void): void; + listComponents( args: ListComponentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComponentsCommandOutput) => void ): void; - public listComponents( - args: ListComponentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListComponentsCommandOutput) => void), - cb?: (err: any, data?: ListComponentsCommandOutput) => void - ): Promise | void { - const command = new ListComponentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a paginated list of all versions for a component. Greater versions are listed - * first.

+ * @see {@link ListComponentVersionsCommand} */ - public listComponentVersions( + listComponentVersions( args: ListComponentVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listComponentVersions( + listComponentVersions( args: ListComponentVersionsCommandInput, cb: (err: any, data?: ListComponentVersionsCommandOutput) => void ): void; - public listComponentVersions( + listComponentVersions( args: ListComponentVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComponentVersionsCommandOutput) => void ): void; - public listComponentVersions( - args: ListComponentVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListComponentVersionsCommandOutput) => void), - cb?: (err: any, data?: ListComponentVersionsCommandOutput) => void - ): Promise | void { - const command = new ListComponentVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a paginated list of Greengrass core devices.

- * - *

IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the - * IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, - * then the reported status of that device might not reflect its current status. The status - * timestamp indicates when the device status was last updated.

- *

Core devices send status updates at the following times:

- *
    - *
  • - *

    When the IoT Greengrass Core software starts

    - *
  • - *
  • - *

    When the core device receives a deployment from the Amazon Web Services Cloud

    - *
  • - *
  • - *

    When the status of any component on the core device becomes - * BROKEN - *

    - *
  • - *
  • - *

    At a regular interval that you can configure, which defaults to 24 hours

    - *
  • - *
  • - *

    For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and - * cloud deployment

    - *
  • - *
- *
+ * @see {@link ListCoreDevicesCommand} */ - public listCoreDevices( + listCoreDevices( args: ListCoreDevicesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCoreDevices( - args: ListCoreDevicesCommandInput, - cb: (err: any, data?: ListCoreDevicesCommandOutput) => void - ): void; - public listCoreDevices( + listCoreDevices(args: ListCoreDevicesCommandInput, cb: (err: any, data?: ListCoreDevicesCommandOutput) => void): void; + listCoreDevices( args: ListCoreDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCoreDevicesCommandOutput) => void ): void; - public listCoreDevices( - args: ListCoreDevicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCoreDevicesCommandOutput) => void), - cb?: (err: any, data?: ListCoreDevicesCommandOutput) => void - ): Promise | void { - const command = new ListCoreDevicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a paginated list of deployments.

+ * @see {@link ListDeploymentsCommand} */ - public listDeployments( + listDeployments( args: ListDeploymentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeployments( - args: ListDeploymentsCommandInput, - cb: (err: any, data?: ListDeploymentsCommandOutput) => void - ): void; - public listDeployments( + listDeployments(args: ListDeploymentsCommandInput, cb: (err: any, data?: ListDeploymentsCommandOutput) => void): void; + listDeployments( args: ListDeploymentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeploymentsCommandOutput) => void ): void; - public listDeployments( - args: ListDeploymentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeploymentsCommandOutput) => void), - cb?: (err: any, data?: ListDeploymentsCommandOutput) => void - ): Promise | void { - const command = new ListDeploymentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.

+ * @see {@link ListEffectiveDeploymentsCommand} */ - public listEffectiveDeployments( + listEffectiveDeployments( args: ListEffectiveDeploymentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEffectiveDeployments( + listEffectiveDeployments( args: ListEffectiveDeploymentsCommandInput, cb: (err: any, data?: ListEffectiveDeploymentsCommandOutput) => void ): void; - public listEffectiveDeployments( + listEffectiveDeployments( args: ListEffectiveDeploymentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEffectiveDeploymentsCommandOutput) => void ): void; - public listEffectiveDeployments( - args: ListEffectiveDeploymentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEffectiveDeploymentsCommandOutput) => void), - cb?: (err: any, data?: ListEffectiveDeploymentsCommandOutput) => void - ): Promise | void { - const command = new ListEffectiveDeploymentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a paginated list of the components that a Greengrass core device runs. By default, - * this list doesn't include components that are deployed as dependencies of other components. To - * include dependencies in the response, set the topologyFilter parameter to - * ALL.

- * - *

IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the - * IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, - * then the reported status of that device might not reflect its current status. The status - * timestamp indicates when the device status was last updated.

- *

Core devices send status updates at the following times:

- *
    - *
  • - *

    When the IoT Greengrass Core software starts

    - *
  • - *
  • - *

    When the core device receives a deployment from the Amazon Web Services Cloud

    - *
  • - *
  • - *

    When the status of any component on the core device becomes - * BROKEN - *

    - *
  • - *
  • - *

    At a regular interval that you can configure, which defaults to 24 hours

    - *
  • - *
  • - *

    For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and - * cloud deployment

    - *
  • - *
- *
+ * @see {@link ListInstalledComponentsCommand} */ - public listInstalledComponents( + listInstalledComponents( args: ListInstalledComponentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInstalledComponents( + listInstalledComponents( args: ListInstalledComponentsCommandInput, cb: (err: any, data?: ListInstalledComponentsCommandOutput) => void ): void; - public listInstalledComponents( + listInstalledComponents( args: ListInstalledComponentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInstalledComponentsCommandOutput) => void ): void; - public listInstalledComponents( - args: ListInstalledComponentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInstalledComponentsCommandOutput) => void), - cb?: (err: any, data?: ListInstalledComponentsCommandOutput) => void - ): Promise | void { - const command = new ListInstalledComponentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the list of tags for an IoT Greengrass resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of components that meet the component, version, and platform requirements - * of a deployment. Greengrass core devices call this operation when they receive a deployment to - * identify the components to install.

- *

This operation identifies components that meet all dependency requirements for a - * deployment. If the requirements conflict, then this operation returns an error and the - * deployment fails. For example, this occurs if component A requires version - * >2.0.0 and component B requires version <2.0.0 - * of a component dependency.

- *

When you specify the component candidates to resolve, IoT Greengrass compares each component's - * digest from the core device with the component's digest in the Amazon Web Services Cloud. If the digests - * don't match, then IoT Greengrass specifies to use the version from the Amazon Web Services Cloud.

- * - *

To use this operation, you must use the data plane API endpoint and authenticate with an - * IoT device certificate. For more information, see IoT Greengrass endpoints and quotas.

- *
+ * @see {@link ResolveComponentCandidatesCommand} */ - public resolveComponentCandidates( + resolveComponentCandidates( args: ResolveComponentCandidatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public resolveComponentCandidates( + resolveComponentCandidates( args: ResolveComponentCandidatesCommandInput, cb: (err: any, data?: ResolveComponentCandidatesCommandOutput) => void ): void; - public resolveComponentCandidates( + resolveComponentCandidates( args: ResolveComponentCandidatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResolveComponentCandidatesCommandOutput) => void ): void; - public resolveComponentCandidates( - args: ResolveComponentCandidatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResolveComponentCandidatesCommandOutput) => void), - cb?: (err: any, data?: ResolveComponentCandidatesCommandOutput) => void - ): Promise | void { - const command = new ResolveComponentCandidatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds tags to an IoT Greengrass resource. If a tag already exists for the resource, this operation - * updates the tag's value.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a tag from an IoT Greengrass resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates connectivity information for a Greengrass core device.

- *

Connectivity information includes endpoints and ports where client devices - * can connect to an MQTT broker on the core device. When a client device - * calls the IoT Greengrass discovery API, - * IoT Greengrass returns connectivity information for all of the core devices where the client device can - * connect. For more information, see Connect client devices to - * core devices in the IoT Greengrass Version 2 Developer Guide.

+ * @see {@link UpdateConnectivityInfoCommand} */ - public updateConnectivityInfo( + updateConnectivityInfo( args: UpdateConnectivityInfoCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConnectivityInfo( + updateConnectivityInfo( args: UpdateConnectivityInfoCommandInput, cb: (err: any, data?: UpdateConnectivityInfoCommandOutput) => void ): void; - public updateConnectivityInfo( + updateConnectivityInfo( args: UpdateConnectivityInfoCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectivityInfoCommandOutput) => void ): void; - public updateConnectivityInfo( - args: UpdateConnectivityInfoCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConnectivityInfoCommandOutput) => void), - cb?: (err: any, data?: UpdateConnectivityInfoCommandOutput) => void - ): Promise | void { - const command = new UpdateConnectivityInfoCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities + * to edge devices. This enables devices to collect and analyze data closer to the source of + * information, react autonomously to local events, and communicate securely with each other on + * local networks. Local devices can also communicate securely with Amazon Web Services IoT Core and export IoT data + * to the Amazon Web Services Cloud. IoT Greengrass developers can use Lambda functions and components to create and + * deploy applications to fleets of edge devices for local operation.

+ *

IoT Greengrass Version 2 provides a new major version of the IoT Greengrass Core software, new APIs, and a new console. + * Use this API reference to learn how to use the IoT Greengrass V2 API operations to manage components, + * manage deployments, and core devices.

+ *

For more information, see What is IoT Greengrass? in the + * IoT Greengrass V2 Developer Guide.

+ */ +export class GreengrassV2 extends GreengrassV2Client implements GreengrassV2 {} +createAggregatedClient(commands, GreengrassV2); diff --git a/clients/client-groundstation/src/GroundStation.ts b/clients/client-groundstation/src/GroundStation.ts index a523f3e1ba8d..df5f28459029 100644 --- a/clients/client-groundstation/src/GroundStation.ts +++ b/clients/client-groundstation/src/GroundStation.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -154,1094 +155,523 @@ import { UpdateMissionProfileCommandInput, UpdateMissionProfileCommandOutput, } from "./commands/UpdateMissionProfileCommand"; -import { GroundStationClient } from "./GroundStationClient"; +import { GroundStationClient, GroundStationClientConfig } from "./GroundStationClient"; -/** - * @public - *

Welcome to the AWS Ground Station API Reference. AWS Ground Station is a fully managed service that - * enables you to control satellite communications, downlink and process satellite data, and - * scale your satellite operations efficiently and cost-effectively without having - * to build or manage your own ground station infrastructure.

- */ -export class GroundStation extends GroundStationClient { +const commands = { + CancelContactCommand, + CreateConfigCommand, + CreateDataflowEndpointGroupCommand, + CreateEphemerisCommand, + CreateMissionProfileCommand, + DeleteConfigCommand, + DeleteDataflowEndpointGroupCommand, + DeleteEphemerisCommand, + DeleteMissionProfileCommand, + DescribeContactCommand, + DescribeEphemerisCommand, + GetAgentConfigurationCommand, + GetConfigCommand, + GetDataflowEndpointGroupCommand, + GetMinuteUsageCommand, + GetMissionProfileCommand, + GetSatelliteCommand, + ListConfigsCommand, + ListContactsCommand, + ListDataflowEndpointGroupsCommand, + ListEphemeridesCommand, + ListGroundStationsCommand, + ListMissionProfilesCommand, + ListSatellitesCommand, + ListTagsForResourceCommand, + RegisterAgentCommand, + ReserveContactCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAgentStatusCommand, + UpdateConfigCommand, + UpdateEphemerisCommand, + UpdateMissionProfileCommand, +}; + +export interface GroundStation { /** - * @public - *

Cancels a contact with a specified contact ID.

+ * @see {@link CancelContactCommand} */ - public cancelContact( - args: CancelContactCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public cancelContact( - args: CancelContactCommandInput, - cb: (err: any, data?: CancelContactCommandOutput) => void - ): void; - public cancelContact( + cancelContact(args: CancelContactCommandInput, options?: __HttpHandlerOptions): Promise; + cancelContact(args: CancelContactCommandInput, cb: (err: any, data?: CancelContactCommandOutput) => void): void; + cancelContact( args: CancelContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelContactCommandOutput) => void ): void; - public cancelContact( - args: CancelContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelContactCommandOutput) => void), - cb?: (err: any, data?: CancelContactCommandOutput) => void - ): Promise | void { - const command = new CancelContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a Config with the specified configData parameters.

- *

Only one type of configData can be specified.

+ * @see {@link CreateConfigCommand} */ - public createConfig( - args: CreateConfigCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createConfig(args: CreateConfigCommandInput, cb: (err: any, data?: CreateConfigCommandOutput) => void): void; - public createConfig( + createConfig(args: CreateConfigCommandInput, options?: __HttpHandlerOptions): Promise; + createConfig(args: CreateConfigCommandInput, cb: (err: any, data?: CreateConfigCommandOutput) => void): void; + createConfig( args: CreateConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfigCommandOutput) => void ): void; - public createConfig( - args: CreateConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConfigCommandOutput) => void), - cb?: (err: any, data?: CreateConfigCommandOutput) => void - ): Promise | void { - const command = new CreateConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a DataflowEndpoint group containing the specified list of DataflowEndpoint objects.

- *

The name field in each endpoint is used in your mission profile DataflowEndpointConfig - * to specify which endpoints to use during a contact.

- *

When a contact uses multiple DataflowEndpointConfig objects, each Config - * must match a DataflowEndpoint in the same group.

+ * @see {@link CreateDataflowEndpointGroupCommand} */ - public createDataflowEndpointGroup( + createDataflowEndpointGroup( args: CreateDataflowEndpointGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDataflowEndpointGroup( + createDataflowEndpointGroup( args: CreateDataflowEndpointGroupCommandInput, cb: (err: any, data?: CreateDataflowEndpointGroupCommandOutput) => void ): void; - public createDataflowEndpointGroup( + createDataflowEndpointGroup( args: CreateDataflowEndpointGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataflowEndpointGroupCommandOutput) => void ): void; - public createDataflowEndpointGroup( - args: CreateDataflowEndpointGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDataflowEndpointGroupCommandOutput) => void), - cb?: (err: any, data?: CreateDataflowEndpointGroupCommandOutput) => void - ): Promise | void { - const command = new CreateDataflowEndpointGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Ephemeris with the specified EphemerisData.

+ * @see {@link CreateEphemerisCommand} */ - public createEphemeris( + createEphemeris( args: CreateEphemerisCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEphemeris( - args: CreateEphemerisCommandInput, - cb: (err: any, data?: CreateEphemerisCommandOutput) => void - ): void; - public createEphemeris( + createEphemeris(args: CreateEphemerisCommandInput, cb: (err: any, data?: CreateEphemerisCommandOutput) => void): void; + createEphemeris( args: CreateEphemerisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEphemerisCommandOutput) => void ): void; - public createEphemeris( - args: CreateEphemerisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEphemerisCommandOutput) => void), - cb?: (err: any, data?: CreateEphemerisCommandOutput) => void - ): Promise | void { - const command = new CreateEphemerisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a mission profile.

- *

- * dataflowEdges is a list of lists of strings. Each lower level list of strings - * has two elements: a from ARN and a to ARN.

+ * @see {@link CreateMissionProfileCommand} */ - public createMissionProfile( + createMissionProfile( args: CreateMissionProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMissionProfile( + createMissionProfile( args: CreateMissionProfileCommandInput, cb: (err: any, data?: CreateMissionProfileCommandOutput) => void ): void; - public createMissionProfile( + createMissionProfile( args: CreateMissionProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMissionProfileCommandOutput) => void ): void; - public createMissionProfile( - args: CreateMissionProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMissionProfileCommandOutput) => void), - cb?: (err: any, data?: CreateMissionProfileCommandOutput) => void - ): Promise | void { - const command = new CreateMissionProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Config.

+ * @see {@link DeleteConfigCommand} */ - public deleteConfig( - args: DeleteConfigCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteConfig(args: DeleteConfigCommandInput, cb: (err: any, data?: DeleteConfigCommandOutput) => void): void; - public deleteConfig( + deleteConfig(args: DeleteConfigCommandInput, options?: __HttpHandlerOptions): Promise; + deleteConfig(args: DeleteConfigCommandInput, cb: (err: any, data?: DeleteConfigCommandOutput) => void): void; + deleteConfig( args: DeleteConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigCommandOutput) => void ): void; - public deleteConfig( - args: DeleteConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConfigCommandOutput) => void), - cb?: (err: any, data?: DeleteConfigCommandOutput) => void - ): Promise | void { - const command = new DeleteConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a dataflow endpoint group.

+ * @see {@link DeleteDataflowEndpointGroupCommand} */ - public deleteDataflowEndpointGroup( + deleteDataflowEndpointGroup( args: DeleteDataflowEndpointGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDataflowEndpointGroup( + deleteDataflowEndpointGroup( args: DeleteDataflowEndpointGroupCommandInput, cb: (err: any, data?: DeleteDataflowEndpointGroupCommandOutput) => void ): void; - public deleteDataflowEndpointGroup( + deleteDataflowEndpointGroup( args: DeleteDataflowEndpointGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataflowEndpointGroupCommandOutput) => void ): void; - public deleteDataflowEndpointGroup( - args: DeleteDataflowEndpointGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDataflowEndpointGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteDataflowEndpointGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteDataflowEndpointGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an ephemeris

+ * @see {@link DeleteEphemerisCommand} */ - public deleteEphemeris( + deleteEphemeris( args: DeleteEphemerisCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEphemeris( - args: DeleteEphemerisCommandInput, - cb: (err: any, data?: DeleteEphemerisCommandOutput) => void - ): void; - public deleteEphemeris( + deleteEphemeris(args: DeleteEphemerisCommandInput, cb: (err: any, data?: DeleteEphemerisCommandOutput) => void): void; + deleteEphemeris( args: DeleteEphemerisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEphemerisCommandOutput) => void ): void; - public deleteEphemeris( - args: DeleteEphemerisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEphemerisCommandOutput) => void), - cb?: (err: any, data?: DeleteEphemerisCommandOutput) => void - ): Promise | void { - const command = new DeleteEphemerisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a mission profile.

+ * @see {@link DeleteMissionProfileCommand} */ - public deleteMissionProfile( + deleteMissionProfile( args: DeleteMissionProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMissionProfile( + deleteMissionProfile( args: DeleteMissionProfileCommandInput, cb: (err: any, data?: DeleteMissionProfileCommandOutput) => void ): void; - public deleteMissionProfile( + deleteMissionProfile( args: DeleteMissionProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMissionProfileCommandOutput) => void ): void; - public deleteMissionProfile( - args: DeleteMissionProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMissionProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteMissionProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteMissionProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an existing contact.

+ * @see {@link DescribeContactCommand} */ - public describeContact( + describeContact( args: DescribeContactCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeContact( - args: DescribeContactCommandInput, - cb: (err: any, data?: DescribeContactCommandOutput) => void - ): void; - public describeContact( + describeContact(args: DescribeContactCommandInput, cb: (err: any, data?: DescribeContactCommandOutput) => void): void; + describeContact( args: DescribeContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeContactCommandOutput) => void ): void; - public describeContact( - args: DescribeContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeContactCommandOutput) => void), - cb?: (err: any, data?: DescribeContactCommandOutput) => void - ): Promise | void { - const command = new DescribeContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an existing ephemeris.

+ * @see {@link DescribeEphemerisCommand} */ - public describeEphemeris( + describeEphemeris( args: DescribeEphemerisCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEphemeris( + describeEphemeris( args: DescribeEphemerisCommandInput, cb: (err: any, data?: DescribeEphemerisCommandOutput) => void ): void; - public describeEphemeris( + describeEphemeris( args: DescribeEphemerisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEphemerisCommandOutput) => void ): void; - public describeEphemeris( - args: DescribeEphemerisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEphemerisCommandOutput) => void), - cb?: (err: any, data?: DescribeEphemerisCommandOutput) => void - ): Promise | void { - const command = new DescribeEphemerisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

For use by AWS Ground Station Agent and shouldn't be called directly.

- *
- *

Gets the latest configuration information for a registered agent.

+ * @see {@link GetAgentConfigurationCommand} */ - public getAgentConfiguration( + getAgentConfiguration( args: GetAgentConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAgentConfiguration( + getAgentConfiguration( args: GetAgentConfigurationCommandInput, cb: (err: any, data?: GetAgentConfigurationCommandOutput) => void ): void; - public getAgentConfiguration( + getAgentConfiguration( args: GetAgentConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAgentConfigurationCommandOutput) => void ): void; - public getAgentConfiguration( - args: GetAgentConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAgentConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetAgentConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetAgentConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns Config information.

- *

Only one Config response can be returned.

+ * @see {@link GetConfigCommand} */ - public getConfig(args: GetConfigCommandInput, options?: __HttpHandlerOptions): Promise; - public getConfig(args: GetConfigCommandInput, cb: (err: any, data?: GetConfigCommandOutput) => void): void; - public getConfig( + getConfig(args: GetConfigCommandInput, options?: __HttpHandlerOptions): Promise; + getConfig(args: GetConfigCommandInput, cb: (err: any, data?: GetConfigCommandOutput) => void): void; + getConfig( args: GetConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConfigCommandOutput) => void ): void; - public getConfig( - args: GetConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConfigCommandOutput) => void), - cb?: (err: any, data?: GetConfigCommandOutput) => void - ): Promise | void { - const command = new GetConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the dataflow endpoint group.

+ * @see {@link GetDataflowEndpointGroupCommand} */ - public getDataflowEndpointGroup( + getDataflowEndpointGroup( args: GetDataflowEndpointGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDataflowEndpointGroup( + getDataflowEndpointGroup( args: GetDataflowEndpointGroupCommandInput, cb: (err: any, data?: GetDataflowEndpointGroupCommandOutput) => void ): void; - public getDataflowEndpointGroup( + getDataflowEndpointGroup( args: GetDataflowEndpointGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataflowEndpointGroupCommandOutput) => void ): void; - public getDataflowEndpointGroup( - args: GetDataflowEndpointGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDataflowEndpointGroupCommandOutput) => void), - cb?: (err: any, data?: GetDataflowEndpointGroupCommandOutput) => void - ): Promise | void { - const command = new GetDataflowEndpointGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the number of minutes used by account.

+ * @see {@link GetMinuteUsageCommand} */ - public getMinuteUsage( + getMinuteUsage( args: GetMinuteUsageCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMinuteUsage( - args: GetMinuteUsageCommandInput, - cb: (err: any, data?: GetMinuteUsageCommandOutput) => void - ): void; - public getMinuteUsage( + getMinuteUsage(args: GetMinuteUsageCommandInput, cb: (err: any, data?: GetMinuteUsageCommandOutput) => void): void; + getMinuteUsage( args: GetMinuteUsageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMinuteUsageCommandOutput) => void ): void; - public getMinuteUsage( - args: GetMinuteUsageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMinuteUsageCommandOutput) => void), - cb?: (err: any, data?: GetMinuteUsageCommandOutput) => void - ): Promise | void { - const command = new GetMinuteUsageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a mission profile.

+ * @see {@link GetMissionProfileCommand} */ - public getMissionProfile( + getMissionProfile( args: GetMissionProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMissionProfile( + getMissionProfile( args: GetMissionProfileCommandInput, cb: (err: any, data?: GetMissionProfileCommandOutput) => void ): void; - public getMissionProfile( + getMissionProfile( args: GetMissionProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMissionProfileCommandOutput) => void ): void; - public getMissionProfile( - args: GetMissionProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMissionProfileCommandOutput) => void), - cb?: (err: any, data?: GetMissionProfileCommandOutput) => void - ): Promise | void { - const command = new GetMissionProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a satellite.

+ * @see {@link GetSatelliteCommand} */ - public getSatellite( - args: GetSatelliteCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getSatellite(args: GetSatelliteCommandInput, cb: (err: any, data?: GetSatelliteCommandOutput) => void): void; - public getSatellite( + getSatellite(args: GetSatelliteCommandInput, options?: __HttpHandlerOptions): Promise; + getSatellite(args: GetSatelliteCommandInput, cb: (err: any, data?: GetSatelliteCommandOutput) => void): void; + getSatellite( args: GetSatelliteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSatelliteCommandOutput) => void ): void; - public getSatellite( - args: GetSatelliteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSatelliteCommandOutput) => void), - cb?: (err: any, data?: GetSatelliteCommandOutput) => void - ): Promise | void { - const command = new GetSatelliteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of Config objects.

+ * @see {@link ListConfigsCommand} */ - public listConfigs(args: ListConfigsCommandInput, options?: __HttpHandlerOptions): Promise; - public listConfigs(args: ListConfigsCommandInput, cb: (err: any, data?: ListConfigsCommandOutput) => void): void; - public listConfigs( + listConfigs(args: ListConfigsCommandInput, options?: __HttpHandlerOptions): Promise; + listConfigs(args: ListConfigsCommandInput, cb: (err: any, data?: ListConfigsCommandOutput) => void): void; + listConfigs( args: ListConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConfigsCommandOutput) => void ): void; - public listConfigs( - args: ListConfigsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConfigsCommandOutput) => void), - cb?: (err: any, data?: ListConfigsCommandOutput) => void - ): Promise | void { - const command = new ListConfigsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of contacts.

- *

If statusList contains AVAILABLE, the request must include - * groundStation, missionprofileArn, and satelliteArn. - *

+ * @see {@link ListContactsCommand} */ - public listContacts( - args: ListContactsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listContacts(args: ListContactsCommandInput, cb: (err: any, data?: ListContactsCommandOutput) => void): void; - public listContacts( + listContacts(args: ListContactsCommandInput, options?: __HttpHandlerOptions): Promise; + listContacts(args: ListContactsCommandInput, cb: (err: any, data?: ListContactsCommandOutput) => void): void; + listContacts( args: ListContactsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListContactsCommandOutput) => void ): void; - public listContacts( - args: ListContactsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListContactsCommandOutput) => void), - cb?: (err: any, data?: ListContactsCommandOutput) => void - ): Promise | void { - const command = new ListContactsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of DataflowEndpoint groups.

+ * @see {@link ListDataflowEndpointGroupsCommand} */ - public listDataflowEndpointGroups( + listDataflowEndpointGroups( args: ListDataflowEndpointGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDataflowEndpointGroups( + listDataflowEndpointGroups( args: ListDataflowEndpointGroupsCommandInput, cb: (err: any, data?: ListDataflowEndpointGroupsCommandOutput) => void ): void; - public listDataflowEndpointGroups( + listDataflowEndpointGroups( args: ListDataflowEndpointGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataflowEndpointGroupsCommandOutput) => void ): void; - public listDataflowEndpointGroups( - args: ListDataflowEndpointGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDataflowEndpointGroupsCommandOutput) => void), - cb?: (err: any, data?: ListDataflowEndpointGroupsCommandOutput) => void - ): Promise | void { - const command = new ListDataflowEndpointGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List existing ephemerides.

+ * @see {@link ListEphemeridesCommand} */ - public listEphemerides( + listEphemerides( args: ListEphemeridesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEphemerides( - args: ListEphemeridesCommandInput, - cb: (err: any, data?: ListEphemeridesCommandOutput) => void - ): void; - public listEphemerides( + listEphemerides(args: ListEphemeridesCommandInput, cb: (err: any, data?: ListEphemeridesCommandOutput) => void): void; + listEphemerides( args: ListEphemeridesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEphemeridesCommandOutput) => void ): void; - public listEphemerides( - args: ListEphemeridesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEphemeridesCommandOutput) => void), - cb?: (err: any, data?: ListEphemeridesCommandOutput) => void - ): Promise | void { - const command = new ListEphemeridesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of ground stations.

+ * @see {@link ListGroundStationsCommand} */ - public listGroundStations( + listGroundStations( args: ListGroundStationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGroundStations( + listGroundStations( args: ListGroundStationsCommandInput, cb: (err: any, data?: ListGroundStationsCommandOutput) => void ): void; - public listGroundStations( + listGroundStations( args: ListGroundStationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroundStationsCommandOutput) => void ): void; - public listGroundStations( - args: ListGroundStationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGroundStationsCommandOutput) => void), - cb?: (err: any, data?: ListGroundStationsCommandOutput) => void - ): Promise | void { - const command = new ListGroundStationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of mission profiles.

+ * @see {@link ListMissionProfilesCommand} */ - public listMissionProfiles( + listMissionProfiles( args: ListMissionProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMissionProfiles( + listMissionProfiles( args: ListMissionProfilesCommandInput, cb: (err: any, data?: ListMissionProfilesCommandOutput) => void ): void; - public listMissionProfiles( + listMissionProfiles( args: ListMissionProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMissionProfilesCommandOutput) => void ): void; - public listMissionProfiles( - args: ListMissionProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMissionProfilesCommandOutput) => void), - cb?: (err: any, data?: ListMissionProfilesCommandOutput) => void - ): Promise | void { - const command = new ListMissionProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of satellites.

+ * @see {@link ListSatellitesCommand} */ - public listSatellites( + listSatellites( args: ListSatellitesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSatellites( - args: ListSatellitesCommandInput, - cb: (err: any, data?: ListSatellitesCommandOutput) => void - ): void; - public listSatellites( + listSatellites(args: ListSatellitesCommandInput, cb: (err: any, data?: ListSatellitesCommandOutput) => void): void; + listSatellites( args: ListSatellitesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSatellitesCommandOutput) => void ): void; - public listSatellites( - args: ListSatellitesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSatellitesCommandOutput) => void), - cb?: (err: any, data?: ListSatellitesCommandOutput) => void - ): Promise | void { - const command = new ListSatellitesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of tags for a specified resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

For use by AWS Ground Station Agent and shouldn't be called directly.

- *
- *

Registers a new agent with AWS Ground Station.

+ * @see {@link RegisterAgentCommand} */ - public registerAgent( - args: RegisterAgentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public registerAgent( - args: RegisterAgentCommandInput, - cb: (err: any, data?: RegisterAgentCommandOutput) => void - ): void; - public registerAgent( + registerAgent(args: RegisterAgentCommandInput, options?: __HttpHandlerOptions): Promise; + registerAgent(args: RegisterAgentCommandInput, cb: (err: any, data?: RegisterAgentCommandOutput) => void): void; + registerAgent( args: RegisterAgentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterAgentCommandOutput) => void ): void; - public registerAgent( - args: RegisterAgentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterAgentCommandOutput) => void), - cb?: (err: any, data?: RegisterAgentCommandOutput) => void - ): Promise | void { - const command = new RegisterAgentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Reserves a contact using specified parameters.

+ * @see {@link ReserveContactCommand} */ - public reserveContact( + reserveContact( args: ReserveContactCommandInput, options?: __HttpHandlerOptions ): Promise; - public reserveContact( - args: ReserveContactCommandInput, - cb: (err: any, data?: ReserveContactCommandOutput) => void - ): void; - public reserveContact( + reserveContact(args: ReserveContactCommandInput, cb: (err: any, data?: ReserveContactCommandOutput) => void): void; + reserveContact( args: ReserveContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReserveContactCommandOutput) => void ): void; - public reserveContact( - args: ReserveContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReserveContactCommandOutput) => void), - cb?: (err: any, data?: ReserveContactCommandOutput) => void - ): Promise | void { - const command = new ReserveContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns a tag to a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deassigns a resource tag.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

For use by AWS Ground Station Agent and shouldn't be called directly.

- *
- *

Update the status of the agent.

+ * @see {@link UpdateAgentStatusCommand} */ - public updateAgentStatus( + updateAgentStatus( args: UpdateAgentStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAgentStatus( + updateAgentStatus( args: UpdateAgentStatusCommandInput, cb: (err: any, data?: UpdateAgentStatusCommandOutput) => void ): void; - public updateAgentStatus( + updateAgentStatus( args: UpdateAgentStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAgentStatusCommandOutput) => void ): void; - public updateAgentStatus( - args: UpdateAgentStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAgentStatusCommandOutput) => void), - cb?: (err: any, data?: UpdateAgentStatusCommandOutput) => void - ): Promise | void { - const command = new UpdateAgentStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the Config used when scheduling contacts.

- *

Updating a Config will not update the execution parameters - * for existing future contacts scheduled with this Config.

+ * @see {@link UpdateConfigCommand} */ - public updateConfig( - args: UpdateConfigCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateConfig(args: UpdateConfigCommandInput, cb: (err: any, data?: UpdateConfigCommandOutput) => void): void; - public updateConfig( + updateConfig(args: UpdateConfigCommandInput, options?: __HttpHandlerOptions): Promise; + updateConfig(args: UpdateConfigCommandInput, cb: (err: any, data?: UpdateConfigCommandOutput) => void): void; + updateConfig( args: UpdateConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConfigCommandOutput) => void ): void; - public updateConfig( - args: UpdateConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing ephemeris

+ * @see {@link UpdateEphemerisCommand} */ - public updateEphemeris( + updateEphemeris( args: UpdateEphemerisCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEphemeris( - args: UpdateEphemerisCommandInput, - cb: (err: any, data?: UpdateEphemerisCommandOutput) => void - ): void; - public updateEphemeris( + updateEphemeris(args: UpdateEphemerisCommandInput, cb: (err: any, data?: UpdateEphemerisCommandOutput) => void): void; + updateEphemeris( args: UpdateEphemerisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEphemerisCommandOutput) => void ): void; - public updateEphemeris( - args: UpdateEphemerisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEphemerisCommandOutput) => void), - cb?: (err: any, data?: UpdateEphemerisCommandOutput) => void - ): Promise | void { - const command = new UpdateEphemerisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a mission profile.

- *

Updating a mission profile will not update the execution parameters - * for existing future contacts.

+ * @see {@link UpdateMissionProfileCommand} */ - public updateMissionProfile( + updateMissionProfile( args: UpdateMissionProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMissionProfile( + updateMissionProfile( args: UpdateMissionProfileCommandInput, cb: (err: any, data?: UpdateMissionProfileCommandOutput) => void ): void; - public updateMissionProfile( + updateMissionProfile( args: UpdateMissionProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMissionProfileCommandOutput) => void ): void; - public updateMissionProfile( - args: UpdateMissionProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMissionProfileCommandOutput) => void), - cb?: (err: any, data?: UpdateMissionProfileCommandOutput) => void - ): Promise | void { - const command = new UpdateMissionProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Welcome to the AWS Ground Station API Reference. AWS Ground Station is a fully managed service that + * enables you to control satellite communications, downlink and process satellite data, and + * scale your satellite operations efficiently and cost-effectively without having + * to build or manage your own ground station infrastructure.

+ */ +export class GroundStation extends GroundStationClient implements GroundStation {} +createAggregatedClient(commands, GroundStation); diff --git a/clients/client-guardduty/src/GuardDuty.ts b/clients/client-guardduty/src/GuardDuty.ts index 6c1216a242be..bc196c28043c 100644 --- a/clients/client-guardduty/src/GuardDuty.ts +++ b/clients/client-guardduty/src/GuardDuty.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -288,2265 +289,1093 @@ import { UpdateThreatIntelSetCommandInput, UpdateThreatIntelSetCommandOutput, } from "./commands/UpdateThreatIntelSetCommand"; -import { GuardDutyClient } from "./GuardDutyClient"; +import { GuardDutyClient, GuardDutyClientConfig } from "./GuardDutyClient"; -/** - * @public - *

Amazon GuardDuty is a continuous security monitoring service that analyzes and processes - * the following data sources: VPC flow logs, Amazon Web Services CloudTrail management event logs, CloudTrail S3 data event - * logs, EKS audit logs, DNS logs, and Amazon EBS volume data. - * It uses threat intelligence - * feeds, such as lists of malicious IPs and domains, and machine learning to identify - * unexpected, potentially unauthorized, and malicious activity within your Amazon Web Services environment. - * This can include issues like escalations of privileges, uses of exposed credentials, or - * communication with malicious IPs, domains, or presence of malware on your Amazon EC2 instances - * and container workloads. For example, GuardDuty can detect compromised EC2 instances and - * container workloads serving malware, or mining bitcoin.

- *

GuardDuty also monitors Amazon Web Services account access behavior for signs of compromise, such as - * unauthorized infrastructure deployments like EC2 instances deployed in a Region that has never - * been used, or unusual API calls like a password policy change to reduce password strength.

- *

GuardDuty informs you about the status of your Amazon Web Services environment by producing security - * findings that you can view in the GuardDuty console or through Amazon EventBridge. For more - * information, see the - * Amazon - * GuardDuty User Guide - * .

- */ -export class GuardDuty extends GuardDutyClient { +const commands = { + AcceptAdministratorInvitationCommand, + AcceptInvitationCommand, + ArchiveFindingsCommand, + CreateDetectorCommand, + CreateFilterCommand, + CreateIPSetCommand, + CreateMembersCommand, + CreatePublishingDestinationCommand, + CreateSampleFindingsCommand, + CreateThreatIntelSetCommand, + DeclineInvitationsCommand, + DeleteDetectorCommand, + DeleteFilterCommand, + DeleteInvitationsCommand, + DeleteIPSetCommand, + DeleteMembersCommand, + DeletePublishingDestinationCommand, + DeleteThreatIntelSetCommand, + DescribeMalwareScansCommand, + DescribeOrganizationConfigurationCommand, + DescribePublishingDestinationCommand, + DisableOrganizationAdminAccountCommand, + DisassociateFromAdministratorAccountCommand, + DisassociateFromMasterAccountCommand, + DisassociateMembersCommand, + EnableOrganizationAdminAccountCommand, + GetAdministratorAccountCommand, + GetCoverageStatisticsCommand, + GetDetectorCommand, + GetFilterCommand, + GetFindingsCommand, + GetFindingsStatisticsCommand, + GetInvitationsCountCommand, + GetIPSetCommand, + GetMalwareScanSettingsCommand, + GetMasterAccountCommand, + GetMemberDetectorsCommand, + GetMembersCommand, + GetRemainingFreeTrialDaysCommand, + GetThreatIntelSetCommand, + GetUsageStatisticsCommand, + InviteMembersCommand, + ListCoverageCommand, + ListDetectorsCommand, + ListFiltersCommand, + ListFindingsCommand, + ListInvitationsCommand, + ListIPSetsCommand, + ListMembersCommand, + ListOrganizationAdminAccountsCommand, + ListPublishingDestinationsCommand, + ListTagsForResourceCommand, + ListThreatIntelSetsCommand, + StartMonitoringMembersCommand, + StopMonitoringMembersCommand, + TagResourceCommand, + UnarchiveFindingsCommand, + UntagResourceCommand, + UpdateDetectorCommand, + UpdateFilterCommand, + UpdateFindingsFeedbackCommand, + UpdateIPSetCommand, + UpdateMalwareScanSettingsCommand, + UpdateMemberDetectorsCommand, + UpdateOrganizationConfigurationCommand, + UpdatePublishingDestinationCommand, + UpdateThreatIntelSetCommand, +}; + +export interface GuardDuty { /** - * @public - *

Accepts the invitation to be a member account and get monitored by a GuardDuty - * administrator account that sent the invitation.

+ * @see {@link AcceptAdministratorInvitationCommand} */ - public acceptAdministratorInvitation( + acceptAdministratorInvitation( args: AcceptAdministratorInvitationCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptAdministratorInvitation( + acceptAdministratorInvitation( args: AcceptAdministratorInvitationCommandInput, cb: (err: any, data?: AcceptAdministratorInvitationCommandOutput) => void ): void; - public acceptAdministratorInvitation( + acceptAdministratorInvitation( args: AcceptAdministratorInvitationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptAdministratorInvitationCommandOutput) => void ): void; - public acceptAdministratorInvitation( - args: AcceptAdministratorInvitationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptAdministratorInvitationCommandOutput) => void), - cb?: (err: any, data?: AcceptAdministratorInvitationCommandOutput) => void - ): Promise | void { - const command = new AcceptAdministratorInvitationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * @deprecated - * - *

Accepts the invitation to be monitored by a GuardDuty administrator account.

- */ - public acceptInvitation( + + /** + * @see {@link AcceptInvitationCommand} + */ + acceptInvitation( args: AcceptInvitationCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptInvitation( + acceptInvitation( args: AcceptInvitationCommandInput, cb: (err: any, data?: AcceptInvitationCommandOutput) => void ): void; - public acceptInvitation( + acceptInvitation( args: AcceptInvitationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptInvitationCommandOutput) => void ): void; - public acceptInvitation( - args: AcceptInvitationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptInvitationCommandOutput) => void), - cb?: (err: any, data?: AcceptInvitationCommandOutput) => void - ): Promise | void { - const command = new AcceptInvitationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Archives GuardDuty findings that are specified by the list of finding IDs.

- * - *

Only the administrator account can archive findings. Member accounts don't have - * permission to archive findings from their accounts.

- *
- */ - public archiveFindings( + + /** + * @see {@link ArchiveFindingsCommand} + */ + archiveFindings( args: ArchiveFindingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public archiveFindings( - args: ArchiveFindingsCommandInput, - cb: (err: any, data?: ArchiveFindingsCommandOutput) => void - ): void; - public archiveFindings( + archiveFindings(args: ArchiveFindingsCommandInput, cb: (err: any, data?: ArchiveFindingsCommandOutput) => void): void; + archiveFindings( args: ArchiveFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ArchiveFindingsCommandOutput) => void ): void; - public archiveFindings( - args: ArchiveFindingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ArchiveFindingsCommandOutput) => void), - cb?: (err: any, data?: ArchiveFindingsCommandOutput) => void - ): Promise | void { - const command = new ArchiveFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a single Amazon GuardDuty detector. A detector is a resource that represents the - * GuardDuty service. To start using GuardDuty, you must create a detector in each Region where - * you enable the service. You can have only one detector per account per Region. All data - * sources are enabled in a new detector by default.

- *

There might be regional differences because some data sources might not be - * available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more - * information, see Regions and endpoints.

- */ - public createDetector( + + /** + * @see {@link CreateDetectorCommand} + */ + createDetector( args: CreateDetectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDetector( - args: CreateDetectorCommandInput, - cb: (err: any, data?: CreateDetectorCommandOutput) => void - ): void; - public createDetector( + createDetector(args: CreateDetectorCommandInput, cb: (err: any, data?: CreateDetectorCommandOutput) => void): void; + createDetector( args: CreateDetectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDetectorCommandOutput) => void ): void; - public createDetector( - args: CreateDetectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDetectorCommandOutput) => void), - cb?: (err: any, data?: CreateDetectorCommandOutput) => void - ): Promise | void { - const command = new CreateDetectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a filter using the specified finding criteria. The maximum number of saved filters - * per Amazon Web Services account per Region is 100. For more information, see Quotas for GuardDuty.

- */ - public createFilter( - args: CreateFilterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createFilter(args: CreateFilterCommandInput, cb: (err: any, data?: CreateFilterCommandOutput) => void): void; - public createFilter( + + /** + * @see {@link CreateFilterCommand} + */ + createFilter(args: CreateFilterCommandInput, options?: __HttpHandlerOptions): Promise; + createFilter(args: CreateFilterCommandInput, cb: (err: any, data?: CreateFilterCommandOutput) => void): void; + createFilter( args: CreateFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFilterCommandOutput) => void ): void; - public createFilter( - args: CreateFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFilterCommandOutput) => void), - cb?: (err: any, data?: CreateFilterCommandOutput) => void - ): Promise | void { - const command = new CreateFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new IPSet, which is called a trusted IP list in the console user interface. An - * IPSet is a list of IP addresses that are trusted for secure communication with Amazon Web Services - * infrastructure and applications. GuardDuty doesn't generate findings for IP addresses that are - * included in IPSets. Only users from the administrator account can use this operation.

- */ - public createIPSet(args: CreateIPSetCommandInput, options?: __HttpHandlerOptions): Promise; - public createIPSet(args: CreateIPSetCommandInput, cb: (err: any, data?: CreateIPSetCommandOutput) => void): void; - public createIPSet( + + /** + * @see {@link CreateIPSetCommand} + */ + createIPSet(args: CreateIPSetCommandInput, options?: __HttpHandlerOptions): Promise; + createIPSet(args: CreateIPSetCommandInput, cb: (err: any, data?: CreateIPSetCommandOutput) => void): void; + createIPSet( args: CreateIPSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIPSetCommandOutput) => void ): void; - public createIPSet( - args: CreateIPSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIPSetCommandOutput) => void), - cb?: (err: any, data?: CreateIPSetCommandOutput) => void - ): Promise | void { - const command = new CreateIPSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account - * IDs. This step is a prerequisite for managing the associated member accounts either by - * invitation or through an organization.

- *

When using Create Members as an organizations delegated administrator this - * action will enable GuardDuty in the added member accounts, with the exception of the - * organization delegated administrator account, which must enable GuardDuty prior to being added - * as a member.

- *

If you are adding accounts by invitation, use this action after GuardDuty has bee enabled in - * potential member accounts and before using InviteMembers.

- */ - public createMembers( - args: CreateMembersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createMembers( - args: CreateMembersCommandInput, - cb: (err: any, data?: CreateMembersCommandOutput) => void - ): void; - public createMembers( + + /** + * @see {@link CreateMembersCommand} + */ + createMembers(args: CreateMembersCommandInput, options?: __HttpHandlerOptions): Promise; + createMembers(args: CreateMembersCommandInput, cb: (err: any, data?: CreateMembersCommandOutput) => void): void; + createMembers( args: CreateMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMembersCommandOutput) => void ): void; - public createMembers( - args: CreateMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMembersCommandOutput) => void), - cb?: (err: any, data?: CreateMembersCommandOutput) => void - ): Promise | void { - const command = new CreateMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a publishing destination to export findings to. The resource to export findings to - * must exist before you use this operation.

- */ - public createPublishingDestination( + + /** + * @see {@link CreatePublishingDestinationCommand} + */ + createPublishingDestination( args: CreatePublishingDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPublishingDestination( + createPublishingDestination( args: CreatePublishingDestinationCommandInput, cb: (err: any, data?: CreatePublishingDestinationCommandOutput) => void ): void; - public createPublishingDestination( + createPublishingDestination( args: CreatePublishingDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePublishingDestinationCommandOutput) => void ): void; - public createPublishingDestination( - args: CreatePublishingDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePublishingDestinationCommandOutput) => void), - cb?: (err: any, data?: CreatePublishingDestinationCommandOutput) => void - ): Promise | void { - const command = new CreatePublishingDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Generates sample findings of types specified by the list of finding types. If 'NULL' is - * specified for findingTypes, the API generates sample findings of all supported - * finding types.

- */ - public createSampleFindings( + + /** + * @see {@link CreateSampleFindingsCommand} + */ + createSampleFindings( args: CreateSampleFindingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSampleFindings( + createSampleFindings( args: CreateSampleFindingsCommandInput, cb: (err: any, data?: CreateSampleFindingsCommandOutput) => void ): void; - public createSampleFindings( + createSampleFindings( args: CreateSampleFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSampleFindingsCommandOutput) => void ): void; - public createSampleFindings( - args: CreateSampleFindingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSampleFindingsCommandOutput) => void), - cb?: (err: any, data?: CreateSampleFindingsCommandOutput) => void - ): Promise | void { - const command = new CreateSampleFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. - * GuardDuty generates findings based on ThreatIntelSets. Only users of the administrator - * account can use this operation.

- */ - public createThreatIntelSet( + + /** + * @see {@link CreateThreatIntelSetCommand} + */ + createThreatIntelSet( args: CreateThreatIntelSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createThreatIntelSet( + createThreatIntelSet( args: CreateThreatIntelSetCommandInput, cb: (err: any, data?: CreateThreatIntelSetCommandOutput) => void ): void; - public createThreatIntelSet( + createThreatIntelSet( args: CreateThreatIntelSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateThreatIntelSetCommandOutput) => void ): void; - public createThreatIntelSet( - args: CreateThreatIntelSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateThreatIntelSetCommandOutput) => void), - cb?: (err: any, data?: CreateThreatIntelSetCommandOutput) => void - ): Promise | void { - const command = new CreateThreatIntelSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Declines invitations sent to the current member account by Amazon Web Services accounts specified by - * their account IDs.

- */ - public declineInvitations( + + /** + * @see {@link DeclineInvitationsCommand} + */ + declineInvitations( args: DeclineInvitationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public declineInvitations( + declineInvitations( args: DeclineInvitationsCommandInput, cb: (err: any, data?: DeclineInvitationsCommandOutput) => void ): void; - public declineInvitations( + declineInvitations( args: DeclineInvitationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeclineInvitationsCommandOutput) => void ): void; - public declineInvitations( - args: DeclineInvitationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeclineInvitationsCommandOutput) => void), - cb?: (err: any, data?: DeclineInvitationsCommandOutput) => void - ): Promise | void { - const command = new DeclineInvitationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an Amazon GuardDuty detector that is specified by the detector ID.

- */ - public deleteDetector( + + /** + * @see {@link DeleteDetectorCommand} + */ + deleteDetector( args: DeleteDetectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDetector( - args: DeleteDetectorCommandInput, - cb: (err: any, data?: DeleteDetectorCommandOutput) => void - ): void; - public deleteDetector( + deleteDetector(args: DeleteDetectorCommandInput, cb: (err: any, data?: DeleteDetectorCommandOutput) => void): void; + deleteDetector( args: DeleteDetectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDetectorCommandOutput) => void ): void; - public deleteDetector( - args: DeleteDetectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDetectorCommandOutput) => void), - cb?: (err: any, data?: DeleteDetectorCommandOutput) => void - ): Promise | void { - const command = new DeleteDetectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the filter specified by the filter name.

- */ - public deleteFilter( - args: DeleteFilterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteFilter(args: DeleteFilterCommandInput, cb: (err: any, data?: DeleteFilterCommandOutput) => void): void; - public deleteFilter( + + /** + * @see {@link DeleteFilterCommand} + */ + deleteFilter(args: DeleteFilterCommandInput, options?: __HttpHandlerOptions): Promise; + deleteFilter(args: DeleteFilterCommandInput, cb: (err: any, data?: DeleteFilterCommandOutput) => void): void; + deleteFilter( args: DeleteFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFilterCommandOutput) => void ): void; - public deleteFilter( - args: DeleteFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFilterCommandOutput) => void), - cb?: (err: any, data?: DeleteFilterCommandOutput) => void - ): Promise | void { - const command = new DeleteFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes invitations sent to the current member account by Amazon Web Services accounts specified by - * their account IDs.

- */ - public deleteInvitations( + + /** + * @see {@link DeleteInvitationsCommand} + */ + deleteInvitations( args: DeleteInvitationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInvitations( + deleteInvitations( args: DeleteInvitationsCommandInput, cb: (err: any, data?: DeleteInvitationsCommandOutput) => void ): void; - public deleteInvitations( + deleteInvitations( args: DeleteInvitationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInvitationsCommandOutput) => void ): void; - public deleteInvitations( - args: DeleteInvitationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInvitationsCommandOutput) => void), - cb?: (err: any, data?: DeleteInvitationsCommandOutput) => void - ): Promise | void { - const command = new DeleteInvitationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the IPSet specified by the ipSetId. IPSets are called trusted IP - * lists in the console user interface.

- */ - public deleteIPSet(args: DeleteIPSetCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteIPSet(args: DeleteIPSetCommandInput, cb: (err: any, data?: DeleteIPSetCommandOutput) => void): void; - public deleteIPSet( + + /** + * @see {@link DeleteIPSetCommand} + */ + deleteIPSet(args: DeleteIPSetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteIPSet(args: DeleteIPSetCommandInput, cb: (err: any, data?: DeleteIPSetCommandOutput) => void): void; + deleteIPSet( args: DeleteIPSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIPSetCommandOutput) => void ): void; - public deleteIPSet( - args: DeleteIPSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIPSetCommandOutput) => void), - cb?: (err: any, data?: DeleteIPSetCommandOutput) => void - ): Promise | void { - const command = new DeleteIPSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes GuardDuty member accounts (to the current GuardDuty administrator account) - * specified by the account IDs.

- *

With autoEnableOrganizationMembers configuration for your organization set to - * ALL, you'll receive an error if you attempt to disable GuardDuty for a member - * account in your organization.

- */ - public deleteMembers( - args: DeleteMembersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteMembers( - args: DeleteMembersCommandInput, - cb: (err: any, data?: DeleteMembersCommandOutput) => void - ): void; - public deleteMembers( + + /** + * @see {@link DeleteMembersCommand} + */ + deleteMembers(args: DeleteMembersCommandInput, options?: __HttpHandlerOptions): Promise; + deleteMembers(args: DeleteMembersCommandInput, cb: (err: any, data?: DeleteMembersCommandOutput) => void): void; + deleteMembers( args: DeleteMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMembersCommandOutput) => void ): void; - public deleteMembers( - args: DeleteMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMembersCommandOutput) => void), - cb?: (err: any, data?: DeleteMembersCommandOutput) => void - ): Promise | void { - const command = new DeleteMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the publishing definition with the specified destinationId.

- */ - public deletePublishingDestination( + + /** + * @see {@link DeletePublishingDestinationCommand} + */ + deletePublishingDestination( args: DeletePublishingDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePublishingDestination( + deletePublishingDestination( args: DeletePublishingDestinationCommandInput, cb: (err: any, data?: DeletePublishingDestinationCommandOutput) => void ): void; - public deletePublishingDestination( + deletePublishingDestination( args: DeletePublishingDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePublishingDestinationCommandOutput) => void ): void; - public deletePublishingDestination( - args: DeletePublishingDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePublishingDestinationCommandOutput) => void), - cb?: (err: any, data?: DeletePublishingDestinationCommandOutput) => void - ): Promise | void { - const command = new DeletePublishingDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the ThreatIntelSet specified by the ThreatIntelSet ID.

- */ - public deleteThreatIntelSet( + + /** + * @see {@link DeleteThreatIntelSetCommand} + */ + deleteThreatIntelSet( args: DeleteThreatIntelSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteThreatIntelSet( + deleteThreatIntelSet( args: DeleteThreatIntelSetCommandInput, cb: (err: any, data?: DeleteThreatIntelSetCommandOutput) => void ): void; - public deleteThreatIntelSet( + deleteThreatIntelSet( args: DeleteThreatIntelSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteThreatIntelSetCommandOutput) => void ): void; - public deleteThreatIntelSet( - args: DeleteThreatIntelSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteThreatIntelSetCommandOutput) => void), - cb?: (err: any, data?: DeleteThreatIntelSetCommandOutput) => void - ): Promise | void { - const command = new DeleteThreatIntelSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of malware scans. Each member account can view the malware scans for their - * own accounts. An administrator can view the malware scans for all the member accounts.

- *

There might be regional differences because some data sources might not be - * available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more - * information, see Regions and endpoints.

- */ - public describeMalwareScans( + + /** + * @see {@link DescribeMalwareScansCommand} + */ + describeMalwareScans( args: DescribeMalwareScansCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMalwareScans( + describeMalwareScans( args: DescribeMalwareScansCommandInput, cb: (err: any, data?: DescribeMalwareScansCommandOutput) => void ): void; - public describeMalwareScans( + describeMalwareScans( args: DescribeMalwareScansCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMalwareScansCommandOutput) => void ): void; - public describeMalwareScans( - args: DescribeMalwareScansCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMalwareScansCommandOutput) => void), - cb?: (err: any, data?: DescribeMalwareScansCommandOutput) => void - ): Promise | void { - const command = new DescribeMalwareScansCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the account selected as the delegated administrator for - * GuardDuty.

- *

There might be regional differences because some data sources might not be - * available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more - * information, see Regions and endpoints.

- */ - public describeOrganizationConfiguration( + + /** + * @see {@link DescribeOrganizationConfigurationCommand} + */ + describeOrganizationConfiguration( args: DescribeOrganizationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOrganizationConfiguration( + describeOrganizationConfiguration( args: DescribeOrganizationConfigurationCommandInput, cb: (err: any, data?: DescribeOrganizationConfigurationCommandOutput) => void ): void; - public describeOrganizationConfiguration( + describeOrganizationConfiguration( args: DescribeOrganizationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrganizationConfigurationCommandOutput) => void ): void; - public describeOrganizationConfiguration( - args: DescribeOrganizationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOrganizationConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeOrganizationConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeOrganizationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the publishing destination specified by the provided - * destinationId.

- */ - public describePublishingDestination( + + /** + * @see {@link DescribePublishingDestinationCommand} + */ + describePublishingDestination( args: DescribePublishingDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePublishingDestination( + describePublishingDestination( args: DescribePublishingDestinationCommandInput, cb: (err: any, data?: DescribePublishingDestinationCommandOutput) => void ): void; - public describePublishingDestination( + describePublishingDestination( args: DescribePublishingDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePublishingDestinationCommandOutput) => void ): void; - public describePublishingDestination( - args: DescribePublishingDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePublishingDestinationCommandOutput) => void), - cb?: (err: any, data?: DescribePublishingDestinationCommandOutput) => void - ): Promise | void { - const command = new DescribePublishingDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables an Amazon Web Services account within the Organization as the GuardDuty delegated - * administrator.

- */ - public disableOrganizationAdminAccount( + + /** + * @see {@link DisableOrganizationAdminAccountCommand} + */ + disableOrganizationAdminAccount( args: DisableOrganizationAdminAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableOrganizationAdminAccount( + disableOrganizationAdminAccount( args: DisableOrganizationAdminAccountCommandInput, cb: (err: any, data?: DisableOrganizationAdminAccountCommandOutput) => void ): void; - public disableOrganizationAdminAccount( + disableOrganizationAdminAccount( args: DisableOrganizationAdminAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableOrganizationAdminAccountCommandOutput) => void ): void; - public disableOrganizationAdminAccount( - args: DisableOrganizationAdminAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableOrganizationAdminAccountCommandOutput) => void), - cb?: (err: any, data?: DisableOrganizationAdminAccountCommandOutput) => void - ): Promise | void { - const command = new DisableOrganizationAdminAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates the current GuardDuty member account from its administrator account.

- *

With autoEnableOrganizationMembers configuration for your organization set to - * ALL, you'll receive an error if you attempt to disable GuardDuty in a member - * account.

- */ - public disassociateFromAdministratorAccount( + + /** + * @see {@link DisassociateFromAdministratorAccountCommand} + */ + disassociateFromAdministratorAccount( args: DisassociateFromAdministratorAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateFromAdministratorAccount( + disassociateFromAdministratorAccount( args: DisassociateFromAdministratorAccountCommandInput, cb: (err: any, data?: DisassociateFromAdministratorAccountCommandOutput) => void ): void; - public disassociateFromAdministratorAccount( + disassociateFromAdministratorAccount( args: DisassociateFromAdministratorAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateFromAdministratorAccountCommandOutput) => void ): void; - public disassociateFromAdministratorAccount( - args: DisassociateFromAdministratorAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateFromAdministratorAccountCommandOutput) => void), - cb?: (err: any, data?: DisassociateFromAdministratorAccountCommandOutput) => void - ): Promise | void { - const command = new DisassociateFromAdministratorAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * @deprecated - * - *

Disassociates the current GuardDuty member account from its administrator account.

- */ - public disassociateFromMasterAccount( + + /** + * @see {@link DisassociateFromMasterAccountCommand} + */ + disassociateFromMasterAccount( args: DisassociateFromMasterAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateFromMasterAccount( + disassociateFromMasterAccount( args: DisassociateFromMasterAccountCommandInput, cb: (err: any, data?: DisassociateFromMasterAccountCommandOutput) => void ): void; - public disassociateFromMasterAccount( + disassociateFromMasterAccount( args: DisassociateFromMasterAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateFromMasterAccountCommandOutput) => void ): void; - public disassociateFromMasterAccount( - args: DisassociateFromMasterAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateFromMasterAccountCommandOutput) => void), - cb?: (err: any, data?: DisassociateFromMasterAccountCommandOutput) => void - ): Promise | void { - const command = new DisassociateFromMasterAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates GuardDuty member accounts (to the current administrator account) specified - * by the account IDs.

- *

With autoEnableOrganizationMembers configuration for your organization set to - * ALL, you'll receive an error if you attempt to disassociate a member account - * before removing them from your Amazon Web Services organization.

- */ - public disassociateMembers( + + /** + * @see {@link DisassociateMembersCommand} + */ + disassociateMembers( args: DisassociateMembersCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateMembers( + disassociateMembers( args: DisassociateMembersCommandInput, cb: (err: any, data?: DisassociateMembersCommandOutput) => void ): void; - public disassociateMembers( + disassociateMembers( args: DisassociateMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateMembersCommandOutput) => void ): void; - public disassociateMembers( - args: DisassociateMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateMembersCommandOutput) => void), - cb?: (err: any, data?: DisassociateMembersCommandOutput) => void - ): Promise | void { - const command = new DisassociateMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables an Amazon Web Services account within the organization as the GuardDuty delegated - * administrator.

- */ - public enableOrganizationAdminAccount( + + /** + * @see {@link EnableOrganizationAdminAccountCommand} + */ + enableOrganizationAdminAccount( args: EnableOrganizationAdminAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableOrganizationAdminAccount( + enableOrganizationAdminAccount( args: EnableOrganizationAdminAccountCommandInput, cb: (err: any, data?: EnableOrganizationAdminAccountCommandOutput) => void ): void; - public enableOrganizationAdminAccount( + enableOrganizationAdminAccount( args: EnableOrganizationAdminAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableOrganizationAdminAccountCommandOutput) => void ): void; - public enableOrganizationAdminAccount( - args: EnableOrganizationAdminAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableOrganizationAdminAccountCommandOutput) => void), - cb?: (err: any, data?: EnableOrganizationAdminAccountCommandOutput) => void - ): Promise | void { - const command = new EnableOrganizationAdminAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides the details for the GuardDuty administrator account associated with the current - * GuardDuty member account.

- */ - public getAdministratorAccount( + + /** + * @see {@link GetAdministratorAccountCommand} + */ + getAdministratorAccount( args: GetAdministratorAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAdministratorAccount( + getAdministratorAccount( args: GetAdministratorAccountCommandInput, cb: (err: any, data?: GetAdministratorAccountCommandOutput) => void ): void; - public getAdministratorAccount( + getAdministratorAccount( args: GetAdministratorAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAdministratorAccountCommandOutput) => void ): void; - public getAdministratorAccount( - args: GetAdministratorAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAdministratorAccountCommandOutput) => void), - cb?: (err: any, data?: GetAdministratorAccountCommandOutput) => void - ): Promise | void { - const command = new GetAdministratorAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves aggregated statistics for your account. If you are a GuardDuty administrator, you - * can retrieve the statistics for all the resources associated with the active member accounts - * in your organization who have enabled EKS Runtime Monitoring and have the GuardDuty agent running - * on their EKS nodes.

- */ - public getCoverageStatistics( + + /** + * @see {@link GetCoverageStatisticsCommand} + */ + getCoverageStatistics( args: GetCoverageStatisticsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCoverageStatistics( + getCoverageStatistics( args: GetCoverageStatisticsCommandInput, cb: (err: any, data?: GetCoverageStatisticsCommandOutput) => void ): void; - public getCoverageStatistics( + getCoverageStatistics( args: GetCoverageStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCoverageStatisticsCommandOutput) => void ): void; - public getCoverageStatistics( - args: GetCoverageStatisticsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCoverageStatisticsCommandOutput) => void), - cb?: (err: any, data?: GetCoverageStatisticsCommandOutput) => void - ): Promise | void { - const command = new GetCoverageStatisticsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves an Amazon GuardDuty detector specified by the detectorId.

- *

There might be regional differences because some data sources might not be - * available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more - * information, see Regions and endpoints.

- */ - public getDetector(args: GetDetectorCommandInput, options?: __HttpHandlerOptions): Promise; - public getDetector(args: GetDetectorCommandInput, cb: (err: any, data?: GetDetectorCommandOutput) => void): void; - public getDetector( + + /** + * @see {@link GetDetectorCommand} + */ + getDetector(args: GetDetectorCommandInput, options?: __HttpHandlerOptions): Promise; + getDetector(args: GetDetectorCommandInput, cb: (err: any, data?: GetDetectorCommandOutput) => void): void; + getDetector( args: GetDetectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDetectorCommandOutput) => void ): void; - public getDetector( - args: GetDetectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDetectorCommandOutput) => void), - cb?: (err: any, data?: GetDetectorCommandOutput) => void - ): Promise | void { - const command = new GetDetectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the details of the filter specified by the filter name.

- */ - public getFilter(args: GetFilterCommandInput, options?: __HttpHandlerOptions): Promise; - public getFilter(args: GetFilterCommandInput, cb: (err: any, data?: GetFilterCommandOutput) => void): void; - public getFilter( + + /** + * @see {@link GetFilterCommand} + */ + getFilter(args: GetFilterCommandInput, options?: __HttpHandlerOptions): Promise; + getFilter(args: GetFilterCommandInput, cb: (err: any, data?: GetFilterCommandOutput) => void): void; + getFilter( args: GetFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFilterCommandOutput) => void ): void; - public getFilter( - args: GetFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFilterCommandOutput) => void), - cb?: (err: any, data?: GetFilterCommandOutput) => void - ): Promise | void { - const command = new GetFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes Amazon GuardDuty findings specified by finding IDs.

- */ - public getFindings(args: GetFindingsCommandInput, options?: __HttpHandlerOptions): Promise; - public getFindings(args: GetFindingsCommandInput, cb: (err: any, data?: GetFindingsCommandOutput) => void): void; - public getFindings( + + /** + * @see {@link GetFindingsCommand} + */ + getFindings(args: GetFindingsCommandInput, options?: __HttpHandlerOptions): Promise; + getFindings(args: GetFindingsCommandInput, cb: (err: any, data?: GetFindingsCommandOutput) => void): void; + getFindings( args: GetFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFindingsCommandOutput) => void ): void; - public getFindings( - args: GetFindingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFindingsCommandOutput) => void), - cb?: (err: any, data?: GetFindingsCommandOutput) => void - ): Promise | void { - const command = new GetFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists Amazon GuardDuty findings statistics for the specified detector ID.

- */ - public getFindingsStatistics( + + /** + * @see {@link GetFindingsStatisticsCommand} + */ + getFindingsStatistics( args: GetFindingsStatisticsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFindingsStatistics( + getFindingsStatistics( args: GetFindingsStatisticsCommandInput, cb: (err: any, data?: GetFindingsStatisticsCommandOutput) => void ): void; - public getFindingsStatistics( + getFindingsStatistics( args: GetFindingsStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFindingsStatisticsCommandOutput) => void ): void; - public getFindingsStatistics( - args: GetFindingsStatisticsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFindingsStatisticsCommandOutput) => void), - cb?: (err: any, data?: GetFindingsStatisticsCommandOutput) => void - ): Promise | void { - const command = new GetFindingsStatisticsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the count of all GuardDuty membership invitations that were sent to the current - * member account except the currently accepted invitation.

- */ - public getInvitationsCount( + + /** + * @see {@link GetInvitationsCountCommand} + */ + getInvitationsCount( args: GetInvitationsCountCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInvitationsCount( + getInvitationsCount( args: GetInvitationsCountCommandInput, cb: (err: any, data?: GetInvitationsCountCommandOutput) => void ): void; - public getInvitationsCount( + getInvitationsCount( args: GetInvitationsCountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInvitationsCountCommandOutput) => void ): void; - public getInvitationsCount( - args: GetInvitationsCountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInvitationsCountCommandOutput) => void), - cb?: (err: any, data?: GetInvitationsCountCommandOutput) => void - ): Promise | void { - const command = new GetInvitationsCountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the IPSet specified by the ipSetId.

- */ - public getIPSet(args: GetIPSetCommandInput, options?: __HttpHandlerOptions): Promise; - public getIPSet(args: GetIPSetCommandInput, cb: (err: any, data?: GetIPSetCommandOutput) => void): void; - public getIPSet( + + /** + * @see {@link GetIPSetCommand} + */ + getIPSet(args: GetIPSetCommandInput, options?: __HttpHandlerOptions): Promise; + getIPSet(args: GetIPSetCommandInput, cb: (err: any, data?: GetIPSetCommandOutput) => void): void; + getIPSet( args: GetIPSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIPSetCommandOutput) => void ): void; - public getIPSet( - args: GetIPSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIPSetCommandOutput) => void), - cb?: (err: any, data?: GetIPSetCommandOutput) => void - ): Promise | void { - const command = new GetIPSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the details of the malware scan settings.

- *

There might be regional differences because some data sources might not be - * available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more - * information, see Regions and endpoints.

- */ - public getMalwareScanSettings( + + /** + * @see {@link GetMalwareScanSettingsCommand} + */ + getMalwareScanSettings( args: GetMalwareScanSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMalwareScanSettings( + getMalwareScanSettings( args: GetMalwareScanSettingsCommandInput, cb: (err: any, data?: GetMalwareScanSettingsCommandOutput) => void ): void; - public getMalwareScanSettings( + getMalwareScanSettings( args: GetMalwareScanSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMalwareScanSettingsCommandOutput) => void ): void; - public getMalwareScanSettings( - args: GetMalwareScanSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMalwareScanSettingsCommandOutput) => void), - cb?: (err: any, data?: GetMalwareScanSettingsCommandOutput) => void - ): Promise | void { - const command = new GetMalwareScanSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * @deprecated - * - *

Provides the details for the GuardDuty administrator account associated with the current - * GuardDuty member account.

- */ - public getMasterAccount( + + /** + * @see {@link GetMasterAccountCommand} + */ + getMasterAccount( args: GetMasterAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMasterAccount( + getMasterAccount( args: GetMasterAccountCommandInput, cb: (err: any, data?: GetMasterAccountCommandOutput) => void ): void; - public getMasterAccount( + getMasterAccount( args: GetMasterAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMasterAccountCommandOutput) => void ): void; - public getMasterAccount( - args: GetMasterAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMasterAccountCommandOutput) => void), - cb?: (err: any, data?: GetMasterAccountCommandOutput) => void - ): Promise | void { - const command = new GetMasterAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes which data sources are enabled for the member account's detector.

- *

There might be regional differences because some data sources might not be - * available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more - * information, see Regions and endpoints.

- */ - public getMemberDetectors( + + /** + * @see {@link GetMemberDetectorsCommand} + */ + getMemberDetectors( args: GetMemberDetectorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMemberDetectors( + getMemberDetectors( args: GetMemberDetectorsCommandInput, cb: (err: any, data?: GetMemberDetectorsCommandOutput) => void ): void; - public getMemberDetectors( + getMemberDetectors( args: GetMemberDetectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMemberDetectorsCommandOutput) => void ): void; - public getMemberDetectors( - args: GetMemberDetectorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMemberDetectorsCommandOutput) => void), - cb?: (err: any, data?: GetMemberDetectorsCommandOutput) => void - ): Promise | void { - const command = new GetMemberDetectorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves GuardDuty member accounts (of the current GuardDuty administrator account) - * specified by the account IDs.

- */ - public getMembers(args: GetMembersCommandInput, options?: __HttpHandlerOptions): Promise; - public getMembers(args: GetMembersCommandInput, cb: (err: any, data?: GetMembersCommandOutput) => void): void; - public getMembers( + + /** + * @see {@link GetMembersCommand} + */ + getMembers(args: GetMembersCommandInput, options?: __HttpHandlerOptions): Promise; + getMembers(args: GetMembersCommandInput, cb: (err: any, data?: GetMembersCommandOutput) => void): void; + getMembers( args: GetMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMembersCommandOutput) => void ): void; - public getMembers( - args: GetMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMembersCommandOutput) => void), - cb?: (err: any, data?: GetMembersCommandOutput) => void - ): Promise | void { - const command = new GetMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides the number of days left for each data source used in the free trial - * period.

- */ - public getRemainingFreeTrialDays( + + /** + * @see {@link GetRemainingFreeTrialDaysCommand} + */ + getRemainingFreeTrialDays( args: GetRemainingFreeTrialDaysCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRemainingFreeTrialDays( + getRemainingFreeTrialDays( args: GetRemainingFreeTrialDaysCommandInput, cb: (err: any, data?: GetRemainingFreeTrialDaysCommandOutput) => void ): void; - public getRemainingFreeTrialDays( + getRemainingFreeTrialDays( args: GetRemainingFreeTrialDaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRemainingFreeTrialDaysCommandOutput) => void ): void; - public getRemainingFreeTrialDays( - args: GetRemainingFreeTrialDaysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRemainingFreeTrialDaysCommandOutput) => void), - cb?: (err: any, data?: GetRemainingFreeTrialDaysCommandOutput) => void - ): Promise | void { - const command = new GetRemainingFreeTrialDaysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.

- */ - public getThreatIntelSet( + + /** + * @see {@link GetThreatIntelSetCommand} + */ + getThreatIntelSet( args: GetThreatIntelSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getThreatIntelSet( + getThreatIntelSet( args: GetThreatIntelSetCommandInput, cb: (err: any, data?: GetThreatIntelSetCommandOutput) => void ): void; - public getThreatIntelSet( + getThreatIntelSet( args: GetThreatIntelSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetThreatIntelSetCommandOutput) => void ): void; - public getThreatIntelSet( - args: GetThreatIntelSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetThreatIntelSetCommandOutput) => void), - cb?: (err: any, data?: GetThreatIntelSetCommandOutput) => void - ): Promise | void { - const command = new GetThreatIntelSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists Amazon GuardDuty usage statistics over the last 30 days for the specified detector - * ID. For newly enabled detectors or data sources, the cost returned will include only the usage - * so far under 30 days. This may differ from the cost metrics in the console, which project - * usage over 30 days to provide a monthly cost estimate. For more information, see Understanding How Usage Costs are Calculated.

- */ - public getUsageStatistics( + + /** + * @see {@link GetUsageStatisticsCommand} + */ + getUsageStatistics( args: GetUsageStatisticsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUsageStatistics( + getUsageStatistics( args: GetUsageStatisticsCommandInput, cb: (err: any, data?: GetUsageStatisticsCommandOutput) => void ): void; - public getUsageStatistics( + getUsageStatistics( args: GetUsageStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUsageStatisticsCommandOutput) => void ): void; - public getUsageStatistics( - args: GetUsageStatisticsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUsageStatisticsCommandOutput) => void), - cb?: (err: any, data?: GetUsageStatisticsCommandOutput) => void - ): Promise | void { - const command = new GetUsageStatisticsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Invites other Amazon Web Services accounts (created as members of the current Amazon Web Services account by - * CreateMembers) to enable GuardDuty, and allow the current Amazon Web Services account to view and manage - * these accounts' findings on their behalf as the GuardDuty administrator account.

- */ - public inviteMembers( - args: InviteMembersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public inviteMembers( - args: InviteMembersCommandInput, - cb: (err: any, data?: InviteMembersCommandOutput) => void - ): void; - public inviteMembers( + + /** + * @see {@link InviteMembersCommand} + */ + inviteMembers(args: InviteMembersCommandInput, options?: __HttpHandlerOptions): Promise; + inviteMembers(args: InviteMembersCommandInput, cb: (err: any, data?: InviteMembersCommandOutput) => void): void; + inviteMembers( args: InviteMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InviteMembersCommandOutput) => void ): void; - public inviteMembers( - args: InviteMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InviteMembersCommandOutput) => void), - cb?: (err: any, data?: InviteMembersCommandOutput) => void - ): Promise | void { - const command = new InviteMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists coverage details for your GuardDuty account. If you're a GuardDuty administrator, you can - * retrieve all resources associated with the active member accounts in your organization.

- *

Make sure the accounts have EKS Runtime Monitoring enabled and GuardDuty agent running on - * their EKS nodes.

- */ - public listCoverage( - args: ListCoverageCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listCoverage(args: ListCoverageCommandInput, cb: (err: any, data?: ListCoverageCommandOutput) => void): void; - public listCoverage( + + /** + * @see {@link ListCoverageCommand} + */ + listCoverage(args: ListCoverageCommandInput, options?: __HttpHandlerOptions): Promise; + listCoverage(args: ListCoverageCommandInput, cb: (err: any, data?: ListCoverageCommandOutput) => void): void; + listCoverage( args: ListCoverageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCoverageCommandOutput) => void ): void; - public listCoverage( - args: ListCoverageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCoverageCommandOutput) => void), - cb?: (err: any, data?: ListCoverageCommandOutput) => void - ): Promise | void { - const command = new ListCoverageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists detectorIds of all the existing Amazon GuardDuty detector resources.

- */ - public listDetectors( - args: ListDetectorsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listDetectors( - args: ListDetectorsCommandInput, - cb: (err: any, data?: ListDetectorsCommandOutput) => void - ): void; - public listDetectors( + + /** + * @see {@link ListDetectorsCommand} + */ + listDetectors(args: ListDetectorsCommandInput, options?: __HttpHandlerOptions): Promise; + listDetectors(args: ListDetectorsCommandInput, cb: (err: any, data?: ListDetectorsCommandOutput) => void): void; + listDetectors( args: ListDetectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDetectorsCommandOutput) => void ): void; - public listDetectors( - args: ListDetectorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDetectorsCommandOutput) => void), - cb?: (err: any, data?: ListDetectorsCommandOutput) => void - ): Promise | void { - const command = new ListDetectorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a paginated list of the current filters.

- */ - public listFilters(args: ListFiltersCommandInput, options?: __HttpHandlerOptions): Promise; - public listFilters(args: ListFiltersCommandInput, cb: (err: any, data?: ListFiltersCommandOutput) => void): void; - public listFilters( + + /** + * @see {@link ListFiltersCommand} + */ + listFilters(args: ListFiltersCommandInput, options?: __HttpHandlerOptions): Promise; + listFilters(args: ListFiltersCommandInput, cb: (err: any, data?: ListFiltersCommandOutput) => void): void; + listFilters( args: ListFiltersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFiltersCommandOutput) => void ): void; - public listFilters( - args: ListFiltersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFiltersCommandOutput) => void), - cb?: (err: any, data?: ListFiltersCommandOutput) => void - ): Promise | void { - const command = new ListFiltersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists Amazon GuardDuty findings for the specified detector ID.

- */ - public listFindings( - args: ListFindingsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listFindings(args: ListFindingsCommandInput, cb: (err: any, data?: ListFindingsCommandOutput) => void): void; - public listFindings( + + /** + * @see {@link ListFindingsCommand} + */ + listFindings(args: ListFindingsCommandInput, options?: __HttpHandlerOptions): Promise; + listFindings(args: ListFindingsCommandInput, cb: (err: any, data?: ListFindingsCommandOutput) => void): void; + listFindings( args: ListFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFindingsCommandOutput) => void ): void; - public listFindings( - args: ListFindingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFindingsCommandOutput) => void), - cb?: (err: any, data?: ListFindingsCommandOutput) => void - ): Promise | void { - const command = new ListFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all GuardDuty membership invitations that were sent to the current Amazon Web Services - * account.

- */ - public listInvitations( + + /** + * @see {@link ListInvitationsCommand} + */ + listInvitations( args: ListInvitationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInvitations( - args: ListInvitationsCommandInput, - cb: (err: any, data?: ListInvitationsCommandOutput) => void - ): void; - public listInvitations( + listInvitations(args: ListInvitationsCommandInput, cb: (err: any, data?: ListInvitationsCommandOutput) => void): void; + listInvitations( args: ListInvitationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInvitationsCommandOutput) => void ): void; - public listInvitations( - args: ListInvitationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInvitationsCommandOutput) => void), - cb?: (err: any, data?: ListInvitationsCommandOutput) => void - ): Promise | void { - const command = new ListInvitationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the IPSets of the GuardDuty service specified by the detector ID. If you use this - * operation from a member account, the IPSets returned are the IPSets from the associated - * administrator account.

- */ - public listIPSets(args: ListIPSetsCommandInput, options?: __HttpHandlerOptions): Promise; - public listIPSets(args: ListIPSetsCommandInput, cb: (err: any, data?: ListIPSetsCommandOutput) => void): void; - public listIPSets( + + /** + * @see {@link ListIPSetsCommand} + */ + listIPSets(args: ListIPSetsCommandInput, options?: __HttpHandlerOptions): Promise; + listIPSets(args: ListIPSetsCommandInput, cb: (err: any, data?: ListIPSetsCommandOutput) => void): void; + listIPSets( args: ListIPSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIPSetsCommandOutput) => void ): void; - public listIPSets( - args: ListIPSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIPSetsCommandOutput) => void), - cb?: (err: any, data?: ListIPSetsCommandOutput) => void - ): Promise | void { - const command = new ListIPSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists details about all member accounts for the current GuardDuty administrator - * account.

- */ - public listMembers(args: ListMembersCommandInput, options?: __HttpHandlerOptions): Promise; - public listMembers(args: ListMembersCommandInput, cb: (err: any, data?: ListMembersCommandOutput) => void): void; - public listMembers( + + /** + * @see {@link ListMembersCommand} + */ + listMembers(args: ListMembersCommandInput, options?: __HttpHandlerOptions): Promise; + listMembers(args: ListMembersCommandInput, cb: (err: any, data?: ListMembersCommandOutput) => void): void; + listMembers( args: ListMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMembersCommandOutput) => void ): void; - public listMembers( - args: ListMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMembersCommandOutput) => void), - cb?: (err: any, data?: ListMembersCommandOutput) => void - ): Promise | void { - const command = new ListMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the accounts configured as GuardDuty delegated administrators.

- */ - public listOrganizationAdminAccounts( + + /** + * @see {@link ListOrganizationAdminAccountsCommand} + */ + listOrganizationAdminAccounts( args: ListOrganizationAdminAccountsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOrganizationAdminAccounts( + listOrganizationAdminAccounts( args: ListOrganizationAdminAccountsCommandInput, cb: (err: any, data?: ListOrganizationAdminAccountsCommandOutput) => void ): void; - public listOrganizationAdminAccounts( + listOrganizationAdminAccounts( args: ListOrganizationAdminAccountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOrganizationAdminAccountsCommandOutput) => void ): void; - public listOrganizationAdminAccounts( - args: ListOrganizationAdminAccountsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOrganizationAdminAccountsCommandOutput) => void), - cb?: (err: any, data?: ListOrganizationAdminAccountsCommandOutput) => void - ): Promise | void { - const command = new ListOrganizationAdminAccountsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of publishing destinations associated with the specified - * detectorId.

- */ - public listPublishingDestinations( + + /** + * @see {@link ListPublishingDestinationsCommand} + */ + listPublishingDestinations( args: ListPublishingDestinationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPublishingDestinations( + listPublishingDestinations( args: ListPublishingDestinationsCommandInput, cb: (err: any, data?: ListPublishingDestinationsCommandOutput) => void ): void; - public listPublishingDestinations( + listPublishingDestinations( args: ListPublishingDestinationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPublishingDestinationsCommandOutput) => void ): void; - public listPublishingDestinations( - args: ListPublishingDestinationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPublishingDestinationsCommandOutput) => void), - cb?: (err: any, data?: ListPublishingDestinationsCommandOutput) => void - ): Promise | void { - const command = new ListPublishingDestinationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists tags for a resource. Tagging is currently supported for detectors, finding filters, - * IP sets, and threat intel sets, with a limit of 50 tags per resource. When invoked, this - * operation returns all assigned tags for a given resource.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID. If you - * use this operation from a member account, the ThreatIntelSets associated with the - * administrator account are returned.

- */ - public listThreatIntelSets( + + /** + * @see {@link ListThreatIntelSetsCommand} + */ + listThreatIntelSets( args: ListThreatIntelSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listThreatIntelSets( + listThreatIntelSets( args: ListThreatIntelSetsCommandInput, cb: (err: any, data?: ListThreatIntelSetsCommandOutput) => void ): void; - public listThreatIntelSets( + listThreatIntelSets( args: ListThreatIntelSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListThreatIntelSetsCommandOutput) => void ): void; - public listThreatIntelSets( - args: ListThreatIntelSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListThreatIntelSetsCommandOutput) => void), - cb?: (err: any, data?: ListThreatIntelSetsCommandOutput) => void - ): Promise | void { - const command = new ListThreatIntelSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Turns on GuardDuty monitoring of the specified member accounts. Use this operation to - * restart monitoring of accounts that you stopped monitoring with the StopMonitoringMembers operation.

- */ - public startMonitoringMembers( + + /** + * @see {@link StartMonitoringMembersCommand} + */ + startMonitoringMembers( args: StartMonitoringMembersCommandInput, options?: __HttpHandlerOptions ): Promise; - public startMonitoringMembers( + startMonitoringMembers( args: StartMonitoringMembersCommandInput, cb: (err: any, data?: StartMonitoringMembersCommandOutput) => void ): void; - public startMonitoringMembers( + startMonitoringMembers( args: StartMonitoringMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMonitoringMembersCommandOutput) => void ): void; - public startMonitoringMembers( - args: StartMonitoringMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartMonitoringMembersCommandOutput) => void), - cb?: (err: any, data?: StartMonitoringMembersCommandOutput) => void - ): Promise | void { - const command = new StartMonitoringMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops GuardDuty monitoring for the specified member accounts. Use the - * StartMonitoringMembers operation to restart monitoring for those - * accounts.

- *

With autoEnableOrganizationMembers configuration for your organization set to - * ALL, you'll receive an error if you attempt to stop monitoring the member - * accounts in your organization.

- */ - public stopMonitoringMembers( + + /** + * @see {@link StopMonitoringMembersCommand} + */ + stopMonitoringMembers( args: StopMonitoringMembersCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopMonitoringMembers( + stopMonitoringMembers( args: StopMonitoringMembersCommandInput, cb: (err: any, data?: StopMonitoringMembersCommandOutput) => void ): void; - public stopMonitoringMembers( + stopMonitoringMembers( args: StopMonitoringMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopMonitoringMembersCommandOutput) => void ): void; - public stopMonitoringMembers( - args: StopMonitoringMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopMonitoringMembersCommandOutput) => void), - cb?: (err: any, data?: StopMonitoringMembersCommandOutput) => void - ): Promise | void { - const command = new StopMonitoringMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds tags to a resource.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Unarchives GuardDuty findings specified by the findingIds.

- */ - public unarchiveFindings( + + /** + * @see {@link UnarchiveFindingsCommand} + */ + unarchiveFindings( args: UnarchiveFindingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public unarchiveFindings( + unarchiveFindings( args: UnarchiveFindingsCommandInput, cb: (err: any, data?: UnarchiveFindingsCommandOutput) => void ): void; - public unarchiveFindings( + unarchiveFindings( args: UnarchiveFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnarchiveFindingsCommandOutput) => void ): void; - public unarchiveFindings( - args: UnarchiveFindingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnarchiveFindingsCommandOutput) => void), - cb?: (err: any, data?: UnarchiveFindingsCommandOutput) => void - ): Promise | void { - const command = new UnarchiveFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes tags from a resource.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the Amazon GuardDuty detector specified by the detectorId.

- *

There might be regional differences because some data sources might not be - * available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more - * information, see Regions and endpoints.

- */ - public updateDetector( + + /** + * @see {@link UpdateDetectorCommand} + */ + updateDetector( args: UpdateDetectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDetector( - args: UpdateDetectorCommandInput, - cb: (err: any, data?: UpdateDetectorCommandOutput) => void - ): void; - public updateDetector( + updateDetector(args: UpdateDetectorCommandInput, cb: (err: any, data?: UpdateDetectorCommandOutput) => void): void; + updateDetector( args: UpdateDetectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDetectorCommandOutput) => void ): void; - public updateDetector( - args: UpdateDetectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDetectorCommandOutput) => void), - cb?: (err: any, data?: UpdateDetectorCommandOutput) => void - ): Promise | void { - const command = new UpdateDetectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the filter specified by the filter name.

- */ - public updateFilter( - args: UpdateFilterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateFilter(args: UpdateFilterCommandInput, cb: (err: any, data?: UpdateFilterCommandOutput) => void): void; - public updateFilter( + + /** + * @see {@link UpdateFilterCommand} + */ + updateFilter(args: UpdateFilterCommandInput, options?: __HttpHandlerOptions): Promise; + updateFilter(args: UpdateFilterCommandInput, cb: (err: any, data?: UpdateFilterCommandOutput) => void): void; + updateFilter( args: UpdateFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFilterCommandOutput) => void ): void; - public updateFilter( - args: UpdateFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFilterCommandOutput) => void), - cb?: (err: any, data?: UpdateFilterCommandOutput) => void - ): Promise | void { - const command = new UpdateFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Marks the specified GuardDuty findings as useful or not useful.

- */ - public updateFindingsFeedback( + + /** + * @see {@link UpdateFindingsFeedbackCommand} + */ + updateFindingsFeedback( args: UpdateFindingsFeedbackCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFindingsFeedback( + updateFindingsFeedback( args: UpdateFindingsFeedbackCommandInput, cb: (err: any, data?: UpdateFindingsFeedbackCommandOutput) => void ): void; - public updateFindingsFeedback( + updateFindingsFeedback( args: UpdateFindingsFeedbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFindingsFeedbackCommandOutput) => void ): void; - public updateFindingsFeedback( - args: UpdateFindingsFeedbackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFindingsFeedbackCommandOutput) => void), - cb?: (err: any, data?: UpdateFindingsFeedbackCommandOutput) => void - ): Promise | void { - const command = new UpdateFindingsFeedbackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the IPSet specified by the IPSet ID.

- */ - public updateIPSet(args: UpdateIPSetCommandInput, options?: __HttpHandlerOptions): Promise; - public updateIPSet(args: UpdateIPSetCommandInput, cb: (err: any, data?: UpdateIPSetCommandOutput) => void): void; - public updateIPSet( + + /** + * @see {@link UpdateIPSetCommand} + */ + updateIPSet(args: UpdateIPSetCommandInput, options?: __HttpHandlerOptions): Promise; + updateIPSet(args: UpdateIPSetCommandInput, cb: (err: any, data?: UpdateIPSetCommandOutput) => void): void; + updateIPSet( args: UpdateIPSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIPSetCommandOutput) => void ): void; - public updateIPSet( - args: UpdateIPSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateIPSetCommandOutput) => void), - cb?: (err: any, data?: UpdateIPSetCommandOutput) => void - ): Promise | void { - const command = new UpdateIPSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the malware scan settings.

- *

There might be regional differences because some data sources might not be - * available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more - * information, see Regions and endpoints.

- */ - public updateMalwareScanSettings( + + /** + * @see {@link UpdateMalwareScanSettingsCommand} + */ + updateMalwareScanSettings( args: UpdateMalwareScanSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMalwareScanSettings( + updateMalwareScanSettings( args: UpdateMalwareScanSettingsCommandInput, cb: (err: any, data?: UpdateMalwareScanSettingsCommandOutput) => void ): void; - public updateMalwareScanSettings( + updateMalwareScanSettings( args: UpdateMalwareScanSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMalwareScanSettingsCommandOutput) => void ): void; - public updateMalwareScanSettings( - args: UpdateMalwareScanSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMalwareScanSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateMalwareScanSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateMalwareScanSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Contains information on member accounts to be updated.

- *

There might be regional differences because some data sources might not be - * available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more - * information, see Regions and endpoints.

- */ - public updateMemberDetectors( + + /** + * @see {@link UpdateMemberDetectorsCommand} + */ + updateMemberDetectors( args: UpdateMemberDetectorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMemberDetectors( + updateMemberDetectors( args: UpdateMemberDetectorsCommandInput, cb: (err: any, data?: UpdateMemberDetectorsCommandOutput) => void ): void; - public updateMemberDetectors( + updateMemberDetectors( args: UpdateMemberDetectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMemberDetectorsCommandOutput) => void ): void; - public updateMemberDetectors( - args: UpdateMemberDetectorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMemberDetectorsCommandOutput) => void), - cb?: (err: any, data?: UpdateMemberDetectorsCommandOutput) => void - ): Promise | void { - const command = new UpdateMemberDetectorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Configures the delegated administrator account with the provided values. You must provide - * the value for either autoEnableOrganizationMembers or autoEnable.

- *

There might be regional differences because some data sources might not be - * available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more - * information, see Regions and endpoints.

- */ - public updateOrganizationConfiguration( + + /** + * @see {@link UpdateOrganizationConfigurationCommand} + */ + updateOrganizationConfiguration( args: UpdateOrganizationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateOrganizationConfiguration( + updateOrganizationConfiguration( args: UpdateOrganizationConfigurationCommandInput, cb: (err: any, data?: UpdateOrganizationConfigurationCommandOutput) => void ): void; - public updateOrganizationConfiguration( + updateOrganizationConfiguration( args: UpdateOrganizationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateOrganizationConfigurationCommandOutput) => void ): void; - public updateOrganizationConfiguration( - args: UpdateOrganizationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateOrganizationConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateOrganizationConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateOrganizationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates information about the publishing destination specified by the - * destinationId.

- */ - public updatePublishingDestination( + + /** + * @see {@link UpdatePublishingDestinationCommand} + */ + updatePublishingDestination( args: UpdatePublishingDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePublishingDestination( + updatePublishingDestination( args: UpdatePublishingDestinationCommandInput, cb: (err: any, data?: UpdatePublishingDestinationCommandOutput) => void ): void; - public updatePublishingDestination( + updatePublishingDestination( args: UpdatePublishingDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePublishingDestinationCommandOutput) => void ): void; - public updatePublishingDestination( - args: UpdatePublishingDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePublishingDestinationCommandOutput) => void), - cb?: (err: any, data?: UpdatePublishingDestinationCommandOutput) => void - ): Promise | void { - const command = new UpdatePublishingDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the ThreatIntelSet specified by the ThreatIntelSet ID.

- */ - public updateThreatIntelSet( + + /** + * @see {@link UpdateThreatIntelSetCommand} + */ + updateThreatIntelSet( args: UpdateThreatIntelSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateThreatIntelSet( + updateThreatIntelSet( args: UpdateThreatIntelSetCommandInput, cb: (err: any, data?: UpdateThreatIntelSetCommandOutput) => void ): void; - public updateThreatIntelSet( + updateThreatIntelSet( args: UpdateThreatIntelSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateThreatIntelSetCommandOutput) => void ): void; - public updateThreatIntelSet( - args: UpdateThreatIntelSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateThreatIntelSetCommandOutput) => void), - cb?: (err: any, data?: UpdateThreatIntelSetCommandOutput) => void - ): Promise | void { - const command = new UpdateThreatIntelSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon GuardDuty is a continuous security monitoring service that analyzes and processes + * the following data sources: VPC flow logs, Amazon Web Services CloudTrail management event logs, CloudTrail S3 data event + * logs, EKS audit logs, DNS logs, and Amazon EBS volume data. + * It uses threat intelligence + * feeds, such as lists of malicious IPs and domains, and machine learning to identify + * unexpected, potentially unauthorized, and malicious activity within your Amazon Web Services environment. + * This can include issues like escalations of privileges, uses of exposed credentials, or + * communication with malicious IPs, domains, or presence of malware on your Amazon EC2 instances + * and container workloads. For example, GuardDuty can detect compromised EC2 instances and + * container workloads serving malware, or mining bitcoin.

+ *

GuardDuty also monitors Amazon Web Services account access behavior for signs of compromise, such as + * unauthorized infrastructure deployments like EC2 instances deployed in a Region that has never + * been used, or unusual API calls like a password policy change to reduce password strength.

+ *

GuardDuty informs you about the status of your Amazon Web Services environment by producing security + * findings that you can view in the GuardDuty console or through Amazon EventBridge. For more + * information, see the + * Amazon + * GuardDuty User Guide + * .

+ */ +export class GuardDuty extends GuardDutyClient implements GuardDuty {} +createAggregatedClient(commands, GuardDuty); diff --git a/clients/client-health/src/Health.ts b/clients/client-health/src/Health.ts index 05a49b30c668..a404adfa7ebc 100644 --- a/clients/client-health/src/Health.ts +++ b/clients/client-health/src/Health.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -66,686 +67,295 @@ import { EnableHealthServiceAccessForOrganizationCommandInput, EnableHealthServiceAccessForOrganizationCommandOutput, } from "./commands/EnableHealthServiceAccessForOrganizationCommand"; -import { HealthClient } from "./HealthClient"; +import { HealthClient, HealthClientConfig } from "./HealthClient"; -/** - * @public - * Health - * - *

The Health API provides programmatic access to the Health information that - * appears in the Personal Health Dashboard. You - * can use the API operations to get information about events that might affect your Amazon Web Services services and resources.

- * - *
    - *
  • - *

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from Amazon Web Services Support to use the Health - * API. If you call the Health API from an Amazon Web Services account that - * doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a - * SubscriptionRequiredException error.

    - *
  • - *
  • - *

    You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to - * call the Health API operations. Health supports a multi-Region - * application architecture and has two regional endpoints in an active-passive - * configuration. You can use the high availability endpoint example to determine - * which Amazon Web Services Region is active, so that you can get the latest information from the - * API. For more information, see Accessing the Health API in the - * Health User Guide.

    - *
  • - *
- *
- *

For authentication of requests, Health uses the Signature Version 4 Signing - * Process.

- *

If your Amazon Web Services account is part of Organizations, you can use the Health organizational - * view feature. This feature provides a centralized view of Health events across all - * accounts in your organization. You can aggregate Health events in real time to - * identify accounts in your organization that are affected by an operational event or get - * notified of security vulnerabilities. Use the organizational view API operations to enable - * this feature and return event information. For more information, see Aggregating - * Health events in the Health User Guide.

- * - *

When you use the Health API operations to return Health events, see the - * following recommendations:

- *
    - *
  • - *

    Use the eventScopeCode parameter to specify whether to return Health - * events that are public or account-specific.

    - *
  • - *
  • - *

    Use pagination to view all events from the response. For example, if you call - * the DescribeEventsForOrganization operation to get all events in your - * organization, you might receive several page results. Specify the - * nextToken in the next request to return more results.

    - *
  • - *
- *
- */ -export class Health extends HealthClient { +const commands = { + DescribeAffectedAccountsForOrganizationCommand, + DescribeAffectedEntitiesCommand, + DescribeAffectedEntitiesForOrganizationCommand, + DescribeEntityAggregatesCommand, + DescribeEventAggregatesCommand, + DescribeEventDetailsCommand, + DescribeEventDetailsForOrganizationCommand, + DescribeEventsCommand, + DescribeEventsForOrganizationCommand, + DescribeEventTypesCommand, + DescribeHealthServiceStatusForOrganizationCommand, + DisableHealthServiceAccessForOrganizationCommand, + EnableHealthServiceAccessForOrganizationCommand, +}; + +export interface Health { /** - * @public - *

Returns a list of accounts in the organization from Organizations that are affected by the - * provided event. For more information about the different types of Health events, see - * Event.

- *

Before you can call this operation, you must first enable Health to work with - * Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's - * management account.

- * - *

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

- *
+ * @see {@link DescribeAffectedAccountsForOrganizationCommand} */ - public describeAffectedAccountsForOrganization( + describeAffectedAccountsForOrganization( args: DescribeAffectedAccountsForOrganizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAffectedAccountsForOrganization( + describeAffectedAccountsForOrganization( args: DescribeAffectedAccountsForOrganizationCommandInput, cb: (err: any, data?: DescribeAffectedAccountsForOrganizationCommandOutput) => void ): void; - public describeAffectedAccountsForOrganization( + describeAffectedAccountsForOrganization( args: DescribeAffectedAccountsForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAffectedAccountsForOrganizationCommandOutput) => void ): void; - public describeAffectedAccountsForOrganization( - args: DescribeAffectedAccountsForOrganizationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeAffectedAccountsForOrganizationCommandOutput) => void), - cb?: (err: any, data?: DescribeAffectedAccountsForOrganizationCommandOutput) => void - ): Promise | void { - const command = new DescribeAffectedAccountsForOrganizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of entities that have been affected by the specified events, based on the - * specified filter criteria. Entities can refer to individual customer resources, groups of - * customer resources, or any other construct, depending on the Amazon Web Services service. Events that - * have impact beyond that of the affected entities, or where the extent of impact is unknown, - * include at least one entity indicating this.

- *

At least one event ARN is required.

- * - * - *
    - *
  • - *

    This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

    - *
  • - *
  • - *

    This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more - * information, see Resource- and action-based conditions in the Health User Guide.

    - *
  • - *
- *
+ * @see {@link DescribeAffectedEntitiesCommand} */ - public describeAffectedEntities( + describeAffectedEntities( args: DescribeAffectedEntitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAffectedEntities( + describeAffectedEntities( args: DescribeAffectedEntitiesCommandInput, cb: (err: any, data?: DescribeAffectedEntitiesCommandOutput) => void ): void; - public describeAffectedEntities( + describeAffectedEntities( args: DescribeAffectedEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAffectedEntitiesCommandOutput) => void ): void; - public describeAffectedEntities( - args: DescribeAffectedEntitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAffectedEntitiesCommandOutput) => void), - cb?: (err: any, data?: DescribeAffectedEntitiesCommandOutput) => void - ): Promise | void { - const command = new DescribeAffectedEntitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of entities that have been affected by one or more events for one or more - * accounts in your organization in Organizations, based on the filter criteria. Entities can refer - * to individual customer resources, groups of customer resources, or any other construct, - * depending on the Amazon Web Services service.

- *

At least one event Amazon Resource Name (ARN) and account ID are required.

- *

Before you can call this operation, you must first enable Health to work with - * Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's - * management account.

- * - *
    - *
  • - *

    This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

    - *
  • - *
  • - *

    This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more - * information, see Resource- and action-based conditions in the Health User Guide.

    - *
  • - *
- * - *
+ * @see {@link DescribeAffectedEntitiesForOrganizationCommand} */ - public describeAffectedEntitiesForOrganization( + describeAffectedEntitiesForOrganization( args: DescribeAffectedEntitiesForOrganizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAffectedEntitiesForOrganization( + describeAffectedEntitiesForOrganization( args: DescribeAffectedEntitiesForOrganizationCommandInput, cb: (err: any, data?: DescribeAffectedEntitiesForOrganizationCommandOutput) => void ): void; - public describeAffectedEntitiesForOrganization( + describeAffectedEntitiesForOrganization( args: DescribeAffectedEntitiesForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAffectedEntitiesForOrganizationCommandOutput) => void ): void; - public describeAffectedEntitiesForOrganization( - args: DescribeAffectedEntitiesForOrganizationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeAffectedEntitiesForOrganizationCommandOutput) => void), - cb?: (err: any, data?: DescribeAffectedEntitiesForOrganizationCommandOutput) => void - ): Promise | void { - const command = new DescribeAffectedEntitiesForOrganizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the number of entities that are affected by each of the specified events.

+ * @see {@link DescribeEntityAggregatesCommand} */ - public describeEntityAggregates( + describeEntityAggregates( args: DescribeEntityAggregatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEntityAggregates( + describeEntityAggregates( args: DescribeEntityAggregatesCommandInput, cb: (err: any, data?: DescribeEntityAggregatesCommandOutput) => void ): void; - public describeEntityAggregates( + describeEntityAggregates( args: DescribeEntityAggregatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEntityAggregatesCommandOutput) => void ): void; - public describeEntityAggregates( - args: DescribeEntityAggregatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEntityAggregatesCommandOutput) => void), - cb?: (err: any, data?: DescribeEntityAggregatesCommandOutput) => void - ): Promise | void { - const command = new DescribeEntityAggregatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the number of events of each event type (issue, scheduled change, and account - * notification). If no filter is specified, the counts of all events in each category are - * returned.

- * - *

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

- *
+ * @see {@link DescribeEventAggregatesCommand} */ - public describeEventAggregates( + describeEventAggregates( args: DescribeEventAggregatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventAggregates( + describeEventAggregates( args: DescribeEventAggregatesCommandInput, cb: (err: any, data?: DescribeEventAggregatesCommandOutput) => void ): void; - public describeEventAggregates( + describeEventAggregates( args: DescribeEventAggregatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventAggregatesCommandOutput) => void ): void; - public describeEventAggregates( - args: DescribeEventAggregatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventAggregatesCommandOutput) => void), - cb?: (err: any, data?: DescribeEventAggregatesCommandOutput) => void - ): Promise | void { - const command = new DescribeEventAggregatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns detailed information about one or more specified events. Information includes - * standard event data (Amazon Web Services Region, service, and so on, as returned by DescribeEvents), a detailed event description, and possible additional metadata - * that depends upon the nature of the event. Affected entities are not included. To retrieve - * the entities, use the DescribeAffectedEntities operation.

- *

If a specified event can't be retrieved, an error message is returned for that - * event.

- * - *

This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more - * information, see Resource- and action-based conditions in the Health User Guide.

- *
+ * @see {@link DescribeEventDetailsCommand} */ - public describeEventDetails( + describeEventDetails( args: DescribeEventDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventDetails( + describeEventDetails( args: DescribeEventDetailsCommandInput, cb: (err: any, data?: DescribeEventDetailsCommandOutput) => void ): void; - public describeEventDetails( + describeEventDetails( args: DescribeEventDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventDetailsCommandOutput) => void ): void; - public describeEventDetails( - args: DescribeEventDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventDetailsCommandOutput) => void), - cb?: (err: any, data?: DescribeEventDetailsCommandOutput) => void - ): Promise | void { - const command = new DescribeEventDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns detailed information about one or more specified events for one or more - * Amazon Web Services accounts in your organization. This information includes standard event data (such as - * the Amazon Web Services Region and service), an event description, and (depending on the event) possible - * metadata. This operation doesn't return affected entities, such as the resources related to - * the event. To return affected entities, use the DescribeAffectedEntitiesForOrganization operation.

- * - *

Before you can call this operation, you must first enable Health to work with - * Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's - * management account.

- *
- *

When you call the DescribeEventDetailsForOrganization operation, specify - * the organizationEventDetailFilters object in the request. Depending on the - * Health event type, note the following differences:

- *
    - *
  • - *

    To return event details for a public event, you must specify a null value for the - * awsAccountId parameter. If you specify an account ID for a public - * event, Health returns an error message because public events aren't specific to - * an account.

    - *
  • - *
  • - *

    To return event details for an event that is specific to an account in your - * organization, you must specify the awsAccountId parameter in the - * request. If you don't specify an account ID, Health returns an error message - * because the event is specific to an account in your organization.

    - *
  • - *
- *

For more information, see Event.

- * - * - *

This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more - * information, see Resource- and action-based conditions in the Health User Guide.

- *
+ * @see {@link DescribeEventDetailsForOrganizationCommand} */ - public describeEventDetailsForOrganization( + describeEventDetailsForOrganization( args: DescribeEventDetailsForOrganizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventDetailsForOrganization( + describeEventDetailsForOrganization( args: DescribeEventDetailsForOrganizationCommandInput, cb: (err: any, data?: DescribeEventDetailsForOrganizationCommandOutput) => void ): void; - public describeEventDetailsForOrganization( + describeEventDetailsForOrganization( args: DescribeEventDetailsForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventDetailsForOrganizationCommandOutput) => void ): void; - public describeEventDetailsForOrganization( - args: DescribeEventDetailsForOrganizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventDetailsForOrganizationCommandOutput) => void), - cb?: (err: any, data?: DescribeEventDetailsForOrganizationCommandOutput) => void - ): Promise | void { - const command = new DescribeEventDetailsForOrganizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about events that meet the specified filter criteria. Events are - * returned in a summary form and do not include the detailed description, any additional - * metadata that depends on the event type, or any affected resources. To retrieve that - * information, use the DescribeEventDetails and DescribeAffectedEntities operations.

- *

If no filter criteria are specified, all events are returned. Results are sorted by - * lastModifiedTime, starting with the most recent event.

- * - *
    - *
  • - *

    When you call the DescribeEvents operation and specify an entity - * for the entityValues parameter, Health might return public - * events that aren't specific to that resource. For example, if you call - * DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) - * instance, Health might return events that aren't specific to that resource or - * service. To get events that are specific to a service, use the - * services parameter in the filter object. For more - * information, see Event.

    - *
  • - *
  • - *

    This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

    - *
  • - *
- *
+ * @see {@link DescribeEventsCommand} */ - public describeEvents( + describeEvents( args: DescribeEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEvents( - args: DescribeEventsCommandInput, - cb: (err: any, data?: DescribeEventsCommandOutput) => void - ): void; - public describeEvents( + describeEvents(args: DescribeEventsCommandInput, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void; + describeEvents( args: DescribeEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsCommandOutput) => void ): void; - public describeEvents( - args: DescribeEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventsCommandOutput) => void), - cb?: (err: any, data?: DescribeEventsCommandOutput) => void - ): Promise | void { - const command = new DescribeEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about events across your organization in Organizations. You can use - * thefilters parameter to specify the events that you want to return. Events - * are returned in a summary form and don't include the affected accounts, detailed - * description, any additional metadata that depends on the event type, or any affected - * resources. To retrieve that information, use the following operations:

- * - *

If you don't specify a filter, the - * DescribeEventsForOrganizations returns all events across your organization. - * Results are sorted by lastModifiedTime, starting with the most recent event.

- *

For more information about the different types of Health events, see Event.

- *

Before you can call this operation, you must first enable Health to work with - * Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's - * management account.

- * - *

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

- *
+ * @see {@link DescribeEventsForOrganizationCommand} */ - public describeEventsForOrganization( + describeEventsForOrganization( args: DescribeEventsForOrganizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventsForOrganization( + describeEventsForOrganization( args: DescribeEventsForOrganizationCommandInput, cb: (err: any, data?: DescribeEventsForOrganizationCommandOutput) => void ): void; - public describeEventsForOrganization( + describeEventsForOrganization( args: DescribeEventsForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsForOrganizationCommandOutput) => void ): void; - public describeEventsForOrganization( - args: DescribeEventsForOrganizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventsForOrganizationCommandOutput) => void), - cb?: (err: any, data?: DescribeEventsForOrganizationCommandOutput) => void - ): Promise | void { - const command = new DescribeEventsForOrganizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the event types that meet the specified filter criteria. You can use this API - * operation to find information about the Health event, such as the category, Amazon Web Services - * service, and event code. The metadata for each event appears in the EventType object.

- *

If you don't specify a filter criteria, the API operation returns all event types, in no - * particular order.

- * - *

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

- *
+ * @see {@link DescribeEventTypesCommand} */ - public describeEventTypes( + describeEventTypes( args: DescribeEventTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventTypes( + describeEventTypes( args: DescribeEventTypesCommandInput, cb: (err: any, data?: DescribeEventTypesCommandOutput) => void ): void; - public describeEventTypes( + describeEventTypes( args: DescribeEventTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventTypesCommandOutput) => void ): void; - public describeEventTypes( - args: DescribeEventTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventTypesCommandOutput) => void), - cb?: (err: any, data?: DescribeEventTypesCommandOutput) => void - ): Promise | void { - const command = new DescribeEventTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation provides status information on enabling or disabling Health to work - * with your organization. To call this operation, you must sign in as an IAM user, assume - * an IAM role, or sign in as the root user (not recommended) in the organization's - * management account.

+ * @see {@link DescribeHealthServiceStatusForOrganizationCommand} */ - public describeHealthServiceStatusForOrganization( + describeHealthServiceStatusForOrganization( args: DescribeHealthServiceStatusForOrganizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeHealthServiceStatusForOrganization( + describeHealthServiceStatusForOrganization( args: DescribeHealthServiceStatusForOrganizationCommandInput, cb: (err: any, data?: DescribeHealthServiceStatusForOrganizationCommandOutput) => void ): void; - public describeHealthServiceStatusForOrganization( + describeHealthServiceStatusForOrganization( args: DescribeHealthServiceStatusForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHealthServiceStatusForOrganizationCommandOutput) => void ): void; - public describeHealthServiceStatusForOrganization( - args: DescribeHealthServiceStatusForOrganizationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeHealthServiceStatusForOrganizationCommandOutput) => void), - cb?: (err: any, data?: DescribeHealthServiceStatusForOrganizationCommandOutput) => void - ): Promise | void { - const command = new DescribeHealthServiceStatusForOrganizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables Health from working with Organizations. To call this operation, you must sign - * in as an Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not - * recommended) in the organization's management account. For more information, see Aggregating - * Health events in the Health User Guide.

- *

This operation doesn't remove the service-linked role from the management account in your - * organization. You must use the IAM console, API, or Command Line Interface (CLI) to remove the - * service-linked role. For more information, see Deleting a Service-Linked Role in the - * IAM User Guide.

- * - *

You can also disable the organizational feature by using the Organizations DisableAWSServiceAccess API operation. After you call this operation, - * Health stops aggregating events for all other Amazon Web Services accounts in your organization. - * If you call the Health API operations for organizational view, Health returns - * an error. Health continues to aggregate health events for your - * Amazon Web Services account.

- *
+ * @see {@link DisableHealthServiceAccessForOrganizationCommand} */ - public disableHealthServiceAccessForOrganization( + disableHealthServiceAccessForOrganization( args: DisableHealthServiceAccessForOrganizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableHealthServiceAccessForOrganization( + disableHealthServiceAccessForOrganization( args: DisableHealthServiceAccessForOrganizationCommandInput, cb: (err: any, data?: DisableHealthServiceAccessForOrganizationCommandOutput) => void ): void; - public disableHealthServiceAccessForOrganization( + disableHealthServiceAccessForOrganization( args: DisableHealthServiceAccessForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableHealthServiceAccessForOrganizationCommandOutput) => void ): void; - public disableHealthServiceAccessForOrganization( - args: DisableHealthServiceAccessForOrganizationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisableHealthServiceAccessForOrganizationCommandOutput) => void), - cb?: (err: any, data?: DisableHealthServiceAccessForOrganizationCommandOutput) => void - ): Promise | void { - const command = new DisableHealthServiceAccessForOrganizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables Health to work with Organizations. You can use the organizational view feature - * to aggregate events from all Amazon Web Services accounts in your organization in a centralized location.

- *

This operation also creates a service-linked role for the management account in the - * organization.

- * - *

To call this operation, you must meet the following requirements:

- *
    - *
  • - *

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from Amazon Web Services Support to use the Health - * API. If you call the Health API from an Amazon Web Services account that doesn't have a - * Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a - * SubscriptionRequiredException error.

    - *
  • - *
  • - *

    You must have permission to call this operation from the organization's - * management account. For example IAM policies, see Health - * identity-based policy examples.

    - *
  • - *
- *
- *

If you don't have the required support plan, you can instead use the Health console - * to enable the organizational view feature. For more information, see Aggregating - * Health events in the Health User Guide.

+ * @see {@link EnableHealthServiceAccessForOrganizationCommand} */ - public enableHealthServiceAccessForOrganization( + enableHealthServiceAccessForOrganization( args: EnableHealthServiceAccessForOrganizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableHealthServiceAccessForOrganization( + enableHealthServiceAccessForOrganization( args: EnableHealthServiceAccessForOrganizationCommandInput, cb: (err: any, data?: EnableHealthServiceAccessForOrganizationCommandOutput) => void ): void; - public enableHealthServiceAccessForOrganization( + enableHealthServiceAccessForOrganization( args: EnableHealthServiceAccessForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableHealthServiceAccessForOrganizationCommandOutput) => void ): void; - public enableHealthServiceAccessForOrganization( - args: EnableHealthServiceAccessForOrganizationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: EnableHealthServiceAccessForOrganizationCommandOutput) => void), - cb?: (err: any, data?: EnableHealthServiceAccessForOrganizationCommandOutput) => void - ): Promise | void { - const command = new EnableHealthServiceAccessForOrganizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Health + * + *

The Health API provides programmatic access to the Health information that + * appears in the Personal Health Dashboard. You + * can use the API operations to get information about events that might affect your Amazon Web Services services and resources.

+ * + *
    + *
  • + *

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from Amazon Web Services Support to use the Health + * API. If you call the Health API from an Amazon Web Services account that + * doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a + * SubscriptionRequiredException error.

    + *
  • + *
  • + *

    You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to + * call the Health API operations. Health supports a multi-Region + * application architecture and has two regional endpoints in an active-passive + * configuration. You can use the high availability endpoint example to determine + * which Amazon Web Services Region is active, so that you can get the latest information from the + * API. For more information, see Accessing the Health API in the + * Health User Guide.

    + *
  • + *
+ *
+ *

For authentication of requests, Health uses the Signature Version 4 Signing + * Process.

+ *

If your Amazon Web Services account is part of Organizations, you can use the Health organizational + * view feature. This feature provides a centralized view of Health events across all + * accounts in your organization. You can aggregate Health events in real time to + * identify accounts in your organization that are affected by an operational event or get + * notified of security vulnerabilities. Use the organizational view API operations to enable + * this feature and return event information. For more information, see Aggregating + * Health events in the Health User Guide.

+ * + *

When you use the Health API operations to return Health events, see the + * following recommendations:

+ *
    + *
  • + *

    Use the eventScopeCode parameter to specify whether to return Health + * events that are public or account-specific.

    + *
  • + *
  • + *

    Use pagination to view all events from the response. For example, if you call + * the DescribeEventsForOrganization operation to get all events in your + * organization, you might receive several page results. Specify the + * nextToken in the next request to return more results.

    + *
  • + *
+ *
+ */ +export class Health extends HealthClient implements Health {} +createAggregatedClient(commands, Health); diff --git a/clients/client-healthlake/src/HealthLake.ts b/clients/client-healthlake/src/HealthLake.ts index 74098645b4af..cca8a1fe8b96 100644 --- a/clients/client-healthlake/src/HealthLake.ts +++ b/clients/client-healthlake/src/HealthLake.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -62,447 +63,239 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; -import { HealthLakeClient } from "./HealthLakeClient"; +import { HealthLakeClient, HealthLakeClientConfig } from "./HealthLakeClient"; -/** - * @public - *

Amazon HealthLake is a HIPAA eligibile service that allows customers to store, - * transform, query, and analyze their FHIR-formatted data in a consistent fashion in the cloud.

- */ -export class HealthLake extends HealthLakeClient { +const commands = { + CreateFHIRDatastoreCommand, + DeleteFHIRDatastoreCommand, + DescribeFHIRDatastoreCommand, + DescribeFHIRExportJobCommand, + DescribeFHIRImportJobCommand, + ListFHIRDatastoresCommand, + ListFHIRExportJobsCommand, + ListFHIRImportJobsCommand, + ListTagsForResourceCommand, + StartFHIRExportJobCommand, + StartFHIRImportJobCommand, + TagResourceCommand, + UntagResourceCommand, +}; + +export interface HealthLake { /** - * @public - *

Creates a Data Store that can ingest and export FHIR formatted data.

+ * @see {@link CreateFHIRDatastoreCommand} */ - public createFHIRDatastore( + createFHIRDatastore( args: CreateFHIRDatastoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFHIRDatastore( + createFHIRDatastore( args: CreateFHIRDatastoreCommandInput, cb: (err: any, data?: CreateFHIRDatastoreCommandOutput) => void ): void; - public createFHIRDatastore( + createFHIRDatastore( args: CreateFHIRDatastoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFHIRDatastoreCommandOutput) => void ): void; - public createFHIRDatastore( - args: CreateFHIRDatastoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFHIRDatastoreCommandOutput) => void), - cb?: (err: any, data?: CreateFHIRDatastoreCommandOutput) => void - ): Promise | void { - const command = new CreateFHIRDatastoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Data Store.

+ * @see {@link DeleteFHIRDatastoreCommand} */ - public deleteFHIRDatastore( + deleteFHIRDatastore( args: DeleteFHIRDatastoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFHIRDatastore( + deleteFHIRDatastore( args: DeleteFHIRDatastoreCommandInput, cb: (err: any, data?: DeleteFHIRDatastoreCommandOutput) => void ): void; - public deleteFHIRDatastore( + deleteFHIRDatastore( args: DeleteFHIRDatastoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFHIRDatastoreCommandOutput) => void ): void; - public deleteFHIRDatastore( - args: DeleteFHIRDatastoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFHIRDatastoreCommandOutput) => void), - cb?: (err: any, data?: DeleteFHIRDatastoreCommandOutput) => void - ): Promise | void { - const command = new DeleteFHIRDatastoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the properties associated with the FHIR Data Store, including the Data Store ID, - * Data Store ARN, Data Store name, Data Store status, created at, Data Store type version, and - * Data Store endpoint.

+ * @see {@link DescribeFHIRDatastoreCommand} */ - public describeFHIRDatastore( + describeFHIRDatastore( args: DescribeFHIRDatastoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFHIRDatastore( + describeFHIRDatastore( args: DescribeFHIRDatastoreCommandInput, cb: (err: any, data?: DescribeFHIRDatastoreCommandOutput) => void ): void; - public describeFHIRDatastore( + describeFHIRDatastore( args: DescribeFHIRDatastoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFHIRDatastoreCommandOutput) => void ): void; - public describeFHIRDatastore( - args: DescribeFHIRDatastoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFHIRDatastoreCommandOutput) => void), - cb?: (err: any, data?: DescribeFHIRDatastoreCommandOutput) => void - ): Promise | void { - const command = new DescribeFHIRDatastoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.

+ * @see {@link DescribeFHIRExportJobCommand} */ - public describeFHIRExportJob( + describeFHIRExportJob( args: DescribeFHIRExportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFHIRExportJob( + describeFHIRExportJob( args: DescribeFHIRExportJobCommandInput, cb: (err: any, data?: DescribeFHIRExportJobCommandOutput) => void ): void; - public describeFHIRExportJob( + describeFHIRExportJob( args: DescribeFHIRExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFHIRExportJobCommandOutput) => void ): void; - public describeFHIRExportJob( - args: DescribeFHIRExportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFHIRExportJobCommandOutput) => void), - cb?: (err: any, data?: DescribeFHIRExportJobCommandOutput) => void - ): Promise | void { - const command = new DescribeFHIRExportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.

+ * @see {@link DescribeFHIRImportJobCommand} */ - public describeFHIRImportJob( + describeFHIRImportJob( args: DescribeFHIRImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFHIRImportJob( + describeFHIRImportJob( args: DescribeFHIRImportJobCommandInput, cb: (err: any, data?: DescribeFHIRImportJobCommandOutput) => void ): void; - public describeFHIRImportJob( + describeFHIRImportJob( args: DescribeFHIRImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFHIRImportJobCommandOutput) => void ): void; - public describeFHIRImportJob( - args: DescribeFHIRImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFHIRImportJobCommandOutput) => void), - cb?: (err: any, data?: DescribeFHIRImportJobCommandOutput) => void - ): Promise | void { - const command = new DescribeFHIRImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store - * status.

+ * @see {@link ListFHIRDatastoresCommand} */ - public listFHIRDatastores( + listFHIRDatastores( args: ListFHIRDatastoresCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFHIRDatastores( + listFHIRDatastores( args: ListFHIRDatastoresCommandInput, cb: (err: any, data?: ListFHIRDatastoresCommandOutput) => void ): void; - public listFHIRDatastores( + listFHIRDatastores( args: ListFHIRDatastoresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFHIRDatastoresCommandOutput) => void ): void; - public listFHIRDatastores( - args: ListFHIRDatastoresCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFHIRDatastoresCommandOutput) => void), - cb?: (err: any, data?: ListFHIRDatastoresCommandOutput) => void - ): Promise | void { - const command = new ListFHIRDatastoresCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Lists all FHIR export jobs associated with an account and their statuses. - *

+ * @see {@link ListFHIRExportJobsCommand} */ - public listFHIRExportJobs( + listFHIRExportJobs( args: ListFHIRExportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFHIRExportJobs( + listFHIRExportJobs( args: ListFHIRExportJobsCommandInput, cb: (err: any, data?: ListFHIRExportJobsCommandOutput) => void ): void; - public listFHIRExportJobs( + listFHIRExportJobs( args: ListFHIRExportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFHIRExportJobsCommandOutput) => void ): void; - public listFHIRExportJobs( - args: ListFHIRExportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFHIRExportJobsCommandOutput) => void), - cb?: (err: any, data?: ListFHIRExportJobsCommandOutput) => void - ): Promise | void { - const command = new ListFHIRExportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Lists all FHIR import jobs associated with an account and their statuses. - *

+ * @see {@link ListFHIRImportJobsCommand} */ - public listFHIRImportJobs( + listFHIRImportJobs( args: ListFHIRImportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFHIRImportJobs( + listFHIRImportJobs( args: ListFHIRImportJobsCommandInput, cb: (err: any, data?: ListFHIRImportJobsCommandOutput) => void ): void; - public listFHIRImportJobs( + listFHIRImportJobs( args: ListFHIRImportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFHIRImportJobsCommandOutput) => void ): void; - public listFHIRImportJobs( - args: ListFHIRImportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFHIRImportJobsCommandOutput) => void), - cb?: (err: any, data?: ListFHIRImportJobsCommandOutput) => void - ): Promise | void { - const command = new ListFHIRImportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns a list of all existing tags associated with a Data Store. - *

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Begins a FHIR export job.

+ * @see {@link StartFHIRExportJobCommand} */ - public startFHIRExportJob( + startFHIRExportJob( args: StartFHIRExportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startFHIRExportJob( + startFHIRExportJob( args: StartFHIRExportJobCommandInput, cb: (err: any, data?: StartFHIRExportJobCommandOutput) => void ): void; - public startFHIRExportJob( + startFHIRExportJob( args: StartFHIRExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFHIRExportJobCommandOutput) => void ): void; - public startFHIRExportJob( - args: StartFHIRExportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartFHIRExportJobCommandOutput) => void), - cb?: (err: any, data?: StartFHIRExportJobCommandOutput) => void - ): Promise | void { - const command = new StartFHIRExportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Begins a FHIR Import job.

+ * @see {@link StartFHIRImportJobCommand} */ - public startFHIRImportJob( + startFHIRImportJob( args: StartFHIRImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startFHIRImportJob( + startFHIRImportJob( args: StartFHIRImportJobCommandInput, cb: (err: any, data?: StartFHIRImportJobCommandOutput) => void ): void; - public startFHIRImportJob( + startFHIRImportJob( args: StartFHIRImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFHIRImportJobCommandOutput) => void ): void; - public startFHIRImportJob( - args: StartFHIRImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartFHIRImportJobCommandOutput) => void), - cb?: (err: any, data?: StartFHIRImportJobCommandOutput) => void - ): Promise | void { - const command = new StartFHIRImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Adds a user specifed key and value tag to a Data Store. - *

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Removes tags from a Data Store. - *

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon HealthLake is a HIPAA eligibile service that allows customers to store, + * transform, query, and analyze their FHIR-formatted data in a consistent fashion in the cloud.

+ */ +export class HealthLake extends HealthLakeClient implements HealthLake {} +createAggregatedClient(commands, HealthLake); diff --git a/clients/client-honeycode/src/Honeycode.ts b/clients/client-honeycode/src/Honeycode.ts index 123d2b68c480..ace992f91562 100644 --- a/clients/client-honeycode/src/Honeycode.ts +++ b/clients/client-honeycode/src/Honeycode.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -68,560 +69,257 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; -import { HoneycodeClient } from "./HoneycodeClient"; +import { HoneycodeClient, HoneycodeClientConfig } from "./HoneycodeClient"; -/** - * @public - *

- * Amazon Honeycode is a fully managed service that allows you to quickly build mobile and web apps for teams—without - * programming. Build Honeycode apps for managing almost anything, like projects, customers, operations, approvals, - * resources, and even your team. - *

- */ -export class Honeycode extends HoneycodeClient { +const commands = { + BatchCreateTableRowsCommand, + BatchDeleteTableRowsCommand, + BatchUpdateTableRowsCommand, + BatchUpsertTableRowsCommand, + DescribeTableDataImportJobCommand, + GetScreenDataCommand, + InvokeScreenAutomationCommand, + ListTableColumnsCommand, + ListTableRowsCommand, + ListTablesCommand, + ListTagsForResourceCommand, + QueryTableRowsCommand, + StartTableDataImportJobCommand, + TagResourceCommand, + UntagResourceCommand, +}; + +export interface Honeycode { /** - * @public - *

- * The BatchCreateTableRows API allows you to create one or more rows at the end of a table in a workbook. - * The API allows you to specify the values to set in some or all of the columns in the new rows. - *

- *

- * If a column is not explicitly set in a specific row, then the column level formula specified in the table - * will be applied to the new row. If there is no column level formula but the last row of the table has a - * formula, then that formula will be copied down to the new row. If there is no column level formula and - * no formula in the last row of the table, then that column will be left blank for the new rows. - *

+ * @see {@link BatchCreateTableRowsCommand} */ - public batchCreateTableRows( + batchCreateTableRows( args: BatchCreateTableRowsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchCreateTableRows( + batchCreateTableRows( args: BatchCreateTableRowsCommandInput, cb: (err: any, data?: BatchCreateTableRowsCommandOutput) => void ): void; - public batchCreateTableRows( + batchCreateTableRows( args: BatchCreateTableRowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCreateTableRowsCommandOutput) => void ): void; - public batchCreateTableRows( - args: BatchCreateTableRowsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchCreateTableRowsCommandOutput) => void), - cb?: (err: any, data?: BatchCreateTableRowsCommandOutput) => void - ): Promise | void { - const command = new BatchCreateTableRowsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The BatchDeleteTableRows API allows you to delete one or more rows from a table in a workbook. - * You need to specify the ids of the rows that you want to delete from the table. - *

+ * @see {@link BatchDeleteTableRowsCommand} */ - public batchDeleteTableRows( + batchDeleteTableRows( args: BatchDeleteTableRowsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeleteTableRows( + batchDeleteTableRows( args: BatchDeleteTableRowsCommandInput, cb: (err: any, data?: BatchDeleteTableRowsCommandOutput) => void ): void; - public batchDeleteTableRows( + batchDeleteTableRows( args: BatchDeleteTableRowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteTableRowsCommandOutput) => void ): void; - public batchDeleteTableRows( - args: BatchDeleteTableRowsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeleteTableRowsCommandOutput) => void), - cb?: (err: any, data?: BatchDeleteTableRowsCommandOutput) => void - ): Promise | void { - const command = new BatchDeleteTableRowsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The BatchUpdateTableRows API allows you to update one or more rows in a table in a workbook. - *

- *

- * You can specify the values to set in some or all of the columns in the table for the specified - * rows. - * If a column is not explicitly specified in a particular row, then that column will not be updated - * for that row. To clear out the data in a specific cell, you need to set the value as an empty string - * (""). - *

+ * @see {@link BatchUpdateTableRowsCommand} */ - public batchUpdateTableRows( + batchUpdateTableRows( args: BatchUpdateTableRowsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchUpdateTableRows( + batchUpdateTableRows( args: BatchUpdateTableRowsCommandInput, cb: (err: any, data?: BatchUpdateTableRowsCommandOutput) => void ): void; - public batchUpdateTableRows( + batchUpdateTableRows( args: BatchUpdateTableRowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchUpdateTableRowsCommandOutput) => void ): void; - public batchUpdateTableRows( - args: BatchUpdateTableRowsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchUpdateTableRowsCommandOutput) => void), - cb?: (err: any, data?: BatchUpdateTableRowsCommandOutput) => void - ): Promise | void { - const command = new BatchUpdateTableRowsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The BatchUpsertTableRows API allows you to upsert one or more rows in a table. The upsert - * operation takes a filter expression as input and evaluates it to find matching rows on the destination - * table. If matching rows are found, it will update the cells in the matching rows to new values specified - * in the request. If no matching rows are found, a new row is added at the end of the table and the cells in - * that row are set to the new values specified in the request. - *

- *

- * You can specify the values to set in some or all of the columns in the table for the - * matching or newly appended rows. If a column is not explicitly specified for a particular row, then that - * column will not be updated for that row. To clear out the data in a specific cell, you need to set the value - * as an empty string (""). - *

+ * @see {@link BatchUpsertTableRowsCommand} */ - public batchUpsertTableRows( + batchUpsertTableRows( args: BatchUpsertTableRowsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchUpsertTableRows( + batchUpsertTableRows( args: BatchUpsertTableRowsCommandInput, cb: (err: any, data?: BatchUpsertTableRowsCommandOutput) => void ): void; - public batchUpsertTableRows( + batchUpsertTableRows( args: BatchUpsertTableRowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchUpsertTableRowsCommandOutput) => void ): void; - public batchUpsertTableRows( - args: BatchUpsertTableRowsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchUpsertTableRowsCommandOutput) => void), - cb?: (err: any, data?: BatchUpsertTableRowsCommandOutput) => void - ): Promise | void { - const command = new BatchUpsertTableRowsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job. - *

+ * @see {@link DescribeTableDataImportJobCommand} */ - public describeTableDataImportJob( + describeTableDataImportJob( args: DescribeTableDataImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTableDataImportJob( + describeTableDataImportJob( args: DescribeTableDataImportJobCommandInput, cb: (err: any, data?: DescribeTableDataImportJobCommandOutput) => void ): void; - public describeTableDataImportJob( + describeTableDataImportJob( args: DescribeTableDataImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTableDataImportJobCommandOutput) => void ): void; - public describeTableDataImportJob( - args: DescribeTableDataImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTableDataImportJobCommandOutput) => void), - cb?: (err: any, data?: DescribeTableDataImportJobCommandOutput) => void - ): Promise | void { - const command = new DescribeTableDataImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The GetScreenData API allows retrieval of data from a screen in a Honeycode app. - * The API allows setting local variables in the screen to filter, sort or otherwise affect what will be - * displayed on the screen. - *

+ * @see {@link GetScreenDataCommand} */ - public getScreenData( - args: GetScreenDataCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getScreenData( - args: GetScreenDataCommandInput, - cb: (err: any, data?: GetScreenDataCommandOutput) => void - ): void; - public getScreenData( + getScreenData(args: GetScreenDataCommandInput, options?: __HttpHandlerOptions): Promise; + getScreenData(args: GetScreenDataCommandInput, cb: (err: any, data?: GetScreenDataCommandOutput) => void): void; + getScreenData( args: GetScreenDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetScreenDataCommandOutput) => void ): void; - public getScreenData( - args: GetScreenDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetScreenDataCommandOutput) => void), - cb?: (err: any, data?: GetScreenDataCommandOutput) => void - ): Promise | void { - const command = new GetScreenDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app. - * The API allows setting local variables, which can then be used in the automation being invoked. - * This allows automating the Honeycode app interactions to write, update or delete data in the workbook. - *

+ * @see {@link InvokeScreenAutomationCommand} */ - public invokeScreenAutomation( + invokeScreenAutomation( args: InvokeScreenAutomationCommandInput, options?: __HttpHandlerOptions ): Promise; - public invokeScreenAutomation( + invokeScreenAutomation( args: InvokeScreenAutomationCommandInput, cb: (err: any, data?: InvokeScreenAutomationCommandOutput) => void ): void; - public invokeScreenAutomation( + invokeScreenAutomation( args: InvokeScreenAutomationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InvokeScreenAutomationCommandOutput) => void ): void; - public invokeScreenAutomation( - args: InvokeScreenAutomationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InvokeScreenAutomationCommandOutput) => void), - cb?: (err: any, data?: InvokeScreenAutomationCommandOutput) => void - ): Promise | void { - const command = new InvokeScreenAutomationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook. - *

+ * @see {@link ListTableColumnsCommand} */ - public listTableColumns( + listTableColumns( args: ListTableColumnsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTableColumns( + listTableColumns( args: ListTableColumnsCommandInput, cb: (err: any, data?: ListTableColumnsCommandOutput) => void ): void; - public listTableColumns( + listTableColumns( args: ListTableColumnsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTableColumnsCommandOutput) => void ): void; - public listTableColumns( - args: ListTableColumnsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTableColumnsCommandOutput) => void), - cb?: (err: any, data?: ListTableColumnsCommandOutput) => void - ): Promise | void { - const command = new ListTableColumnsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook. - *

+ * @see {@link ListTableRowsCommand} */ - public listTableRows( - args: ListTableRowsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listTableRows( - args: ListTableRowsCommandInput, - cb: (err: any, data?: ListTableRowsCommandOutput) => void - ): void; - public listTableRows( + listTableRows(args: ListTableRowsCommandInput, options?: __HttpHandlerOptions): Promise; + listTableRows(args: ListTableRowsCommandInput, cb: (err: any, data?: ListTableRowsCommandOutput) => void): void; + listTableRows( args: ListTableRowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTableRowsCommandOutput) => void ): void; - public listTableRows( - args: ListTableRowsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTableRowsCommandOutput) => void), - cb?: (err: any, data?: ListTableRowsCommandOutput) => void - ): Promise | void { - const command = new ListTableRowsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The ListTables API allows you to retrieve a list of all the tables in a workbook. - *

+ * @see {@link ListTablesCommand} */ - public listTables(args: ListTablesCommandInput, options?: __HttpHandlerOptions): Promise; - public listTables(args: ListTablesCommandInput, cb: (err: any, data?: ListTablesCommandOutput) => void): void; - public listTables( + listTables(args: ListTablesCommandInput, options?: __HttpHandlerOptions): Promise; + listTables(args: ListTablesCommandInput, cb: (err: any, data?: ListTablesCommandOutput) => void): void; + listTables( args: ListTablesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTablesCommandOutput) => void ): void; - public listTables( - args: ListTablesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTablesCommandOutput) => void), - cb?: (err: any, data?: ListTablesCommandOutput) => void - ): Promise | void { - const command = new ListTablesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The ListTagsForResource API allows you to return a resource's tags. - *

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The QueryTableRows API allows you to use a filter formula to query for specific rows in a table. - *

+ * @see {@link QueryTableRowsCommand} */ - public queryTableRows( + queryTableRows( args: QueryTableRowsCommandInput, options?: __HttpHandlerOptions ): Promise; - public queryTableRows( - args: QueryTableRowsCommandInput, - cb: (err: any, data?: QueryTableRowsCommandOutput) => void - ): void; - public queryTableRows( + queryTableRows(args: QueryTableRowsCommandInput, cb: (err: any, data?: QueryTableRowsCommandOutput) => void): void; + queryTableRows( args: QueryTableRowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryTableRowsCommandOutput) => void ): void; - public queryTableRows( - args: QueryTableRowsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryTableRowsCommandOutput) => void), - cb?: (err: any, data?: QueryTableRowsCommandOutput) => void - ): Promise | void { - const command = new QueryTableRowsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The StartTableDataImportJob API allows you to start an import job on a table. This API will only return - * the id of the job that was started. To find out the status of the import request, you need to call the - * DescribeTableDataImportJob API. - *

+ * @see {@link StartTableDataImportJobCommand} */ - public startTableDataImportJob( + startTableDataImportJob( args: StartTableDataImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startTableDataImportJob( + startTableDataImportJob( args: StartTableDataImportJobCommandInput, cb: (err: any, data?: StartTableDataImportJobCommandOutput) => void ): void; - public startTableDataImportJob( + startTableDataImportJob( args: StartTableDataImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTableDataImportJobCommandOutput) => void ): void; - public startTableDataImportJob( - args: StartTableDataImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartTableDataImportJobCommandOutput) => void), - cb?: (err: any, data?: StartTableDataImportJobCommandOutput) => void - ): Promise | void { - const command = new StartTableDataImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The TagResource API allows you to add tags to an ARN-able resource. Resource includes workbook, table, - * screen and screen-automation. - *

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The UntagResource API allows you to removes tags from an ARN-able resource. Resource includes workbook, table, - * screen and screen-automation. - *

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

+ * Amazon Honeycode is a fully managed service that allows you to quickly build mobile and web apps for teams—without + * programming. Build Honeycode apps for managing almost anything, like projects, customers, operations, approvals, + * resources, and even your team. + *

+ */ +export class Honeycode extends HoneycodeClient implements Honeycode {} +createAggregatedClient(commands, Honeycode); diff --git a/clients/client-iam/src/IAM.ts b/clients/client-iam/src/IAM.ts index 4b7615db9bc4..7141fad2ae31 100644 --- a/clients/client-iam/src/IAM.ts +++ b/clients/client-iam/src/IAM.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -703,6823 +704,2621 @@ import { UploadSSHPublicKeyCommandInput, UploadSSHPublicKeyCommandOutput, } from "./commands/UploadSSHPublicKeyCommand"; -import { IAMClient } from "./IAMClient"; +import { IAMClient, IAMClientConfig } from "./IAMClient"; -/** - * @public - * Identity and Access Management - *

Identity and Access Management (IAM) is a web service for securely controlling - * access to Amazon Web Services services. With IAM, you can centrally manage users, security credentials - * such as access keys, and permissions that control which Amazon Web Services resources users and - * applications can access. For more information about IAM, see Identity and Access Management (IAM) and the Identity and Access Management User Guide.

- */ -export class IAM extends IAMClient { +const commands = { + AddClientIDToOpenIDConnectProviderCommand, + AddRoleToInstanceProfileCommand, + AddUserToGroupCommand, + AttachGroupPolicyCommand, + AttachRolePolicyCommand, + AttachUserPolicyCommand, + ChangePasswordCommand, + CreateAccessKeyCommand, + CreateAccountAliasCommand, + CreateGroupCommand, + CreateInstanceProfileCommand, + CreateLoginProfileCommand, + CreateOpenIDConnectProviderCommand, + CreatePolicyCommand, + CreatePolicyVersionCommand, + CreateRoleCommand, + CreateSAMLProviderCommand, + CreateServiceLinkedRoleCommand, + CreateServiceSpecificCredentialCommand, + CreateUserCommand, + CreateVirtualMFADeviceCommand, + DeactivateMFADeviceCommand, + DeleteAccessKeyCommand, + DeleteAccountAliasCommand, + DeleteAccountPasswordPolicyCommand, + DeleteGroupCommand, + DeleteGroupPolicyCommand, + DeleteInstanceProfileCommand, + DeleteLoginProfileCommand, + DeleteOpenIDConnectProviderCommand, + DeletePolicyCommand, + DeletePolicyVersionCommand, + DeleteRoleCommand, + DeleteRolePermissionsBoundaryCommand, + DeleteRolePolicyCommand, + DeleteSAMLProviderCommand, + DeleteServerCertificateCommand, + DeleteServiceLinkedRoleCommand, + DeleteServiceSpecificCredentialCommand, + DeleteSigningCertificateCommand, + DeleteSSHPublicKeyCommand, + DeleteUserCommand, + DeleteUserPermissionsBoundaryCommand, + DeleteUserPolicyCommand, + DeleteVirtualMFADeviceCommand, + DetachGroupPolicyCommand, + DetachRolePolicyCommand, + DetachUserPolicyCommand, + EnableMFADeviceCommand, + GenerateCredentialReportCommand, + GenerateOrganizationsAccessReportCommand, + GenerateServiceLastAccessedDetailsCommand, + GetAccessKeyLastUsedCommand, + GetAccountAuthorizationDetailsCommand, + GetAccountPasswordPolicyCommand, + GetAccountSummaryCommand, + GetContextKeysForCustomPolicyCommand, + GetContextKeysForPrincipalPolicyCommand, + GetCredentialReportCommand, + GetGroupCommand, + GetGroupPolicyCommand, + GetInstanceProfileCommand, + GetLoginProfileCommand, + GetOpenIDConnectProviderCommand, + GetOrganizationsAccessReportCommand, + GetPolicyCommand, + GetPolicyVersionCommand, + GetRoleCommand, + GetRolePolicyCommand, + GetSAMLProviderCommand, + GetServerCertificateCommand, + GetServiceLastAccessedDetailsCommand, + GetServiceLastAccessedDetailsWithEntitiesCommand, + GetServiceLinkedRoleDeletionStatusCommand, + GetSSHPublicKeyCommand, + GetUserCommand, + GetUserPolicyCommand, + ListAccessKeysCommand, + ListAccountAliasesCommand, + ListAttachedGroupPoliciesCommand, + ListAttachedRolePoliciesCommand, + ListAttachedUserPoliciesCommand, + ListEntitiesForPolicyCommand, + ListGroupPoliciesCommand, + ListGroupsCommand, + ListGroupsForUserCommand, + ListInstanceProfilesCommand, + ListInstanceProfilesForRoleCommand, + ListInstanceProfileTagsCommand, + ListMFADevicesCommand, + ListMFADeviceTagsCommand, + ListOpenIDConnectProvidersCommand, + ListOpenIDConnectProviderTagsCommand, + ListPoliciesCommand, + ListPoliciesGrantingServiceAccessCommand, + ListPolicyTagsCommand, + ListPolicyVersionsCommand, + ListRolePoliciesCommand, + ListRolesCommand, + ListRoleTagsCommand, + ListSAMLProvidersCommand, + ListSAMLProviderTagsCommand, + ListServerCertificatesCommand, + ListServerCertificateTagsCommand, + ListServiceSpecificCredentialsCommand, + ListSigningCertificatesCommand, + ListSSHPublicKeysCommand, + ListUserPoliciesCommand, + ListUsersCommand, + ListUserTagsCommand, + ListVirtualMFADevicesCommand, + PutGroupPolicyCommand, + PutRolePermissionsBoundaryCommand, + PutRolePolicyCommand, + PutUserPermissionsBoundaryCommand, + PutUserPolicyCommand, + RemoveClientIDFromOpenIDConnectProviderCommand, + RemoveRoleFromInstanceProfileCommand, + RemoveUserFromGroupCommand, + ResetServiceSpecificCredentialCommand, + ResyncMFADeviceCommand, + SetDefaultPolicyVersionCommand, + SetSecurityTokenServicePreferencesCommand, + SimulateCustomPolicyCommand, + SimulatePrincipalPolicyCommand, + TagInstanceProfileCommand, + TagMFADeviceCommand, + TagOpenIDConnectProviderCommand, + TagPolicyCommand, + TagRoleCommand, + TagSAMLProviderCommand, + TagServerCertificateCommand, + TagUserCommand, + UntagInstanceProfileCommand, + UntagMFADeviceCommand, + UntagOpenIDConnectProviderCommand, + UntagPolicyCommand, + UntagRoleCommand, + UntagSAMLProviderCommand, + UntagServerCertificateCommand, + UntagUserCommand, + UpdateAccessKeyCommand, + UpdateAccountPasswordPolicyCommand, + UpdateAssumeRolePolicyCommand, + UpdateGroupCommand, + UpdateLoginProfileCommand, + UpdateOpenIDConnectProviderThumbprintCommand, + UpdateRoleCommand, + UpdateRoleDescriptionCommand, + UpdateSAMLProviderCommand, + UpdateServerCertificateCommand, + UpdateServiceSpecificCredentialCommand, + UpdateSigningCertificateCommand, + UpdateSSHPublicKeyCommand, + UpdateUserCommand, + UploadServerCertificateCommand, + UploadSigningCertificateCommand, + UploadSSHPublicKeyCommand, +}; + +export interface IAM { /** - * @public - *

Adds a new client ID (also known as audience) to the list of client IDs already - * registered for the specified IAM OpenID Connect (OIDC) provider resource.

- *

This operation is idempotent; it does not fail or return an error if you add an - * existing client ID to the provider.

+ * @see {@link AddClientIDToOpenIDConnectProviderCommand} */ - public addClientIDToOpenIDConnectProvider( + addClientIDToOpenIDConnectProvider( args: AddClientIDToOpenIDConnectProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public addClientIDToOpenIDConnectProvider( + addClientIDToOpenIDConnectProvider( args: AddClientIDToOpenIDConnectProviderCommandInput, cb: (err: any, data?: AddClientIDToOpenIDConnectProviderCommandOutput) => void ): void; - public addClientIDToOpenIDConnectProvider( + addClientIDToOpenIDConnectProvider( args: AddClientIDToOpenIDConnectProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddClientIDToOpenIDConnectProviderCommandOutput) => void ): void; - public addClientIDToOpenIDConnectProvider( - args: AddClientIDToOpenIDConnectProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddClientIDToOpenIDConnectProviderCommandOutput) => void), - cb?: (err: any, data?: AddClientIDToOpenIDConnectProviderCommandOutput) => void - ): Promise | void { - const command = new AddClientIDToOpenIDConnectProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds the specified IAM role to the specified instance profile. An instance profile - * can contain only one role, and this quota cannot be increased. You can remove the - * existing role and then add a different role to an instance profile. You must then wait - * for the change to appear across all of Amazon Web Services because of eventual - * consistency. To force the change, you must disassociate the instance profile and then associate the - * instance profile, or you can stop your instance and then restart it.

- * - *

The caller of this operation must be granted the PassRole permission - * on the IAM role by a permissions policy.

- *
- *

For more information about roles, see Working with roles. For more - * information about instance profiles, see About instance - * profiles.

- */ - public addRoleToInstanceProfile( + + /** + * @see {@link AddRoleToInstanceProfileCommand} + */ + addRoleToInstanceProfile( args: AddRoleToInstanceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public addRoleToInstanceProfile( + addRoleToInstanceProfile( args: AddRoleToInstanceProfileCommandInput, cb: (err: any, data?: AddRoleToInstanceProfileCommandOutput) => void ): void; - public addRoleToInstanceProfile( + addRoleToInstanceProfile( args: AddRoleToInstanceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddRoleToInstanceProfileCommandOutput) => void ): void; - public addRoleToInstanceProfile( - args: AddRoleToInstanceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddRoleToInstanceProfileCommandOutput) => void), - cb?: (err: any, data?: AddRoleToInstanceProfileCommandOutput) => void - ): Promise | void { - const command = new AddRoleToInstanceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds the specified user to the specified group.

- */ - public addUserToGroup( + + /** + * @see {@link AddUserToGroupCommand} + */ + addUserToGroup( args: AddUserToGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public addUserToGroup( - args: AddUserToGroupCommandInput, - cb: (err: any, data?: AddUserToGroupCommandOutput) => void - ): void; - public addUserToGroup( + addUserToGroup(args: AddUserToGroupCommandInput, cb: (err: any, data?: AddUserToGroupCommandOutput) => void): void; + addUserToGroup( args: AddUserToGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddUserToGroupCommandOutput) => void ): void; - public addUserToGroup( - args: AddUserToGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddUserToGroupCommandOutput) => void), - cb?: (err: any, data?: AddUserToGroupCommandOutput) => void - ): Promise | void { - const command = new AddUserToGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attaches the specified managed policy to the specified IAM group.

- *

You use this operation to attach a managed policy to a group. To embed an inline - * policy in a group, use PutGroupPolicy.

- *

As a best practice, you can validate your IAM policies. - * To learn more, see Validating IAM policies - * in the IAM User Guide.

- *

For more information about policies, see Managed policies and inline - * policies in the IAM User Guide.

- */ - public attachGroupPolicy( + + /** + * @see {@link AttachGroupPolicyCommand} + */ + attachGroupPolicy( args: AttachGroupPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachGroupPolicy( + attachGroupPolicy( args: AttachGroupPolicyCommandInput, cb: (err: any, data?: AttachGroupPolicyCommandOutput) => void ): void; - public attachGroupPolicy( + attachGroupPolicy( args: AttachGroupPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachGroupPolicyCommandOutput) => void ): void; - public attachGroupPolicy( - args: AttachGroupPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachGroupPolicyCommandOutput) => void), - cb?: (err: any, data?: AttachGroupPolicyCommandOutput) => void - ): Promise | void { - const command = new AttachGroupPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attaches the specified managed policy to the specified IAM role. When you attach a - * managed policy to a role, the managed policy becomes part of the role's permission - * (access) policy.

- * - *

You cannot use a managed policy as the role's trust policy. The role's trust - * policy is created at the same time as the role, using CreateRole. - * You can update a role's trust policy using UpdateAssumeRolePolicy.

- *
- *

Use this operation to attach a managed policy to a role. To embed - * an inline policy in a role, use PutRolePolicy. For more information - * about policies, see Managed policies and inline - * policies in the IAM User Guide.

- *

As a best practice, you can validate your IAM policies. - * To learn more, see Validating IAM policies - * in the IAM User Guide.

- */ - public attachRolePolicy( + + /** + * @see {@link AttachRolePolicyCommand} + */ + attachRolePolicy( args: AttachRolePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachRolePolicy( + attachRolePolicy( args: AttachRolePolicyCommandInput, cb: (err: any, data?: AttachRolePolicyCommandOutput) => void ): void; - public attachRolePolicy( + attachRolePolicy( args: AttachRolePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachRolePolicyCommandOutput) => void ): void; - public attachRolePolicy( - args: AttachRolePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachRolePolicyCommandOutput) => void), - cb?: (err: any, data?: AttachRolePolicyCommandOutput) => void - ): Promise | void { - const command = new AttachRolePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attaches the specified managed policy to the specified user.

- *

You use this operation to attach a managed policy to a user. To - * embed an inline policy in a user, use PutUserPolicy.

- *

As a best practice, you can validate your IAM policies. - * To learn more, see Validating IAM policies - * in the IAM User Guide.

- *

For more information about policies, see Managed policies and inline - * policies in the IAM User Guide.

- */ - public attachUserPolicy( + + /** + * @see {@link AttachUserPolicyCommand} + */ + attachUserPolicy( args: AttachUserPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachUserPolicy( + attachUserPolicy( args: AttachUserPolicyCommandInput, cb: (err: any, data?: AttachUserPolicyCommandOutput) => void ): void; - public attachUserPolicy( + attachUserPolicy( args: AttachUserPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachUserPolicyCommandOutput) => void ): void; - public attachUserPolicy( - args: AttachUserPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachUserPolicyCommandOutput) => void), - cb?: (err: any, data?: AttachUserPolicyCommandOutput) => void - ): Promise | void { - const command = new AttachUserPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Changes the password of the IAM user who is calling this operation. This operation - * can be performed using the CLI, the Amazon Web Services API, or the My - * Security Credentials page in the Amazon Web Services Management Console. The Amazon Web Services account root user password is - * not affected by this operation.

- *

Use UpdateLoginProfile to use the CLI, the Amazon Web Services API, or the - * Users page in the IAM console to change the - * password for any IAM user. For more information about modifying passwords, see Managing - * passwords in the IAM User Guide.

- */ - public changePassword( + + /** + * @see {@link ChangePasswordCommand} + */ + changePassword( args: ChangePasswordCommandInput, options?: __HttpHandlerOptions ): Promise; - public changePassword( - args: ChangePasswordCommandInput, - cb: (err: any, data?: ChangePasswordCommandOutput) => void - ): void; - public changePassword( + changePassword(args: ChangePasswordCommandInput, cb: (err: any, data?: ChangePasswordCommandOutput) => void): void; + changePassword( args: ChangePasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChangePasswordCommandOutput) => void ): void; - public changePassword( - args: ChangePasswordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ChangePasswordCommandOutput) => void), - cb?: (err: any, data?: ChangePasswordCommandOutput) => void - ): Promise | void { - const command = new ChangePasswordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services access key ID for the - * specified user. The default status for new keys is Active.

- *

If you do not specify a user name, IAM determines the user name implicitly based on - * the Amazon Web Services access key ID signing the request. This operation works for access keys under - * the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root - * user credentials. This is true even if the Amazon Web Services account has no associated users.

- *

For information about quotas on the number of keys you can create, see IAM and STS - * quotas in the IAM User Guide.

- * - *

To ensure the security of your Amazon Web Services account, the secret access key is accessible - * only during key and user creation. You must save the key (for example, in a text - * file) if you want to be able to access it again. If a secret key is lost, you can - * delete the access keys for the associated user and then create new keys.

- *
- */ - public createAccessKey( + + /** + * @see {@link CreateAccessKeyCommand} + */ + createAccessKey( args: CreateAccessKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAccessKey( - args: CreateAccessKeyCommandInput, - cb: (err: any, data?: CreateAccessKeyCommandOutput) => void - ): void; - public createAccessKey( + createAccessKey(args: CreateAccessKeyCommandInput, cb: (err: any, data?: CreateAccessKeyCommandOutput) => void): void; + createAccessKey( args: CreateAccessKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessKeyCommandOutput) => void ): void; - public createAccessKey( - args: CreateAccessKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAccessKeyCommandOutput) => void), - cb?: (err: any, data?: CreateAccessKeyCommandOutput) => void - ): Promise | void { - const command = new CreateAccessKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account - * alias, see Using an - * alias for your Amazon Web Services account ID in the - * IAM User Guide.

- */ - public createAccountAlias( + + /** + * @see {@link CreateAccountAliasCommand} + */ + createAccountAlias( args: CreateAccountAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAccountAlias( + createAccountAlias( args: CreateAccountAliasCommandInput, cb: (err: any, data?: CreateAccountAliasCommandOutput) => void ): void; - public createAccountAlias( + createAccountAlias( args: CreateAccountAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccountAliasCommandOutput) => void ): void; - public createAccountAlias( - args: CreateAccountAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAccountAliasCommandOutput) => void), - cb?: (err: any, data?: CreateAccountAliasCommandOutput) => void - ): Promise | void { - const command = new CreateAccountAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new group.

- *

For information about the number of groups you can create, see IAM and STS - * quotas in the IAM User Guide.

- */ - public createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void; - public createGroup( + + /** + * @see {@link CreateGroupCommand} + */ + createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise; + createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void; + createGroup( args: CreateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupCommandOutput) => void ): void; - public createGroup( - args: CreateGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGroupCommandOutput) => void), - cb?: (err: any, data?: CreateGroupCommandOutput) => void - ): Promise | void { - const command = new CreateGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new instance profile. For information about instance profiles, see Using - * roles for applications on Amazon EC2 in the - * IAM User Guide, and Instance profiles in the Amazon EC2 User Guide.

- *

For information about the number of instance profiles you can create, see IAM object - * quotas in the IAM User Guide.

- */ - public createInstanceProfile( + + /** + * @see {@link CreateInstanceProfileCommand} + */ + createInstanceProfile( args: CreateInstanceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public createInstanceProfile( + createInstanceProfile( args: CreateInstanceProfileCommandInput, cb: (err: any, data?: CreateInstanceProfileCommandOutput) => void ): void; - public createInstanceProfile( + createInstanceProfile( args: CreateInstanceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInstanceProfileCommandOutput) => void ): void; - public createInstanceProfile( - args: CreateInstanceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateInstanceProfileCommandOutput) => void), - cb?: (err: any, data?: CreateInstanceProfileCommandOutput) => void - ): Promise | void { - const command = new CreateInstanceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a password for the specified IAM user. A password allows an IAM user to - * access Amazon Web Services services through the Amazon Web Services Management Console.

- *

You can use the CLI, the Amazon Web Services API, or the Users - * page in the IAM console to create a password for any IAM user. Use ChangePassword to update your own existing password in the My Security Credentials page in the Amazon Web Services Management Console.

- *

For more information about managing passwords, see Managing passwords in the - * IAM User Guide.

- */ - public createLoginProfile( + + /** + * @see {@link CreateLoginProfileCommand} + */ + createLoginProfile( args: CreateLoginProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLoginProfile( + createLoginProfile( args: CreateLoginProfileCommandInput, cb: (err: any, data?: CreateLoginProfileCommandOutput) => void ): void; - public createLoginProfile( + createLoginProfile( args: CreateLoginProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLoginProfileCommandOutput) => void ): void; - public createLoginProfile( - args: CreateLoginProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLoginProfileCommandOutput) => void), - cb?: (err: any, data?: CreateLoginProfileCommandOutput) => void - ): Promise | void { - const command = new CreateLoginProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).

- *

The OIDC provider that you create with this operation can be used as a principal in a - * role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and - * the OIDC provider.

- *

If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't - * need to create a separate IAM identity provider. These OIDC identity providers are - * already built-in to Amazon Web Services and are available for your use. Instead, you can move directly - * to creating new roles using your identity provider. To learn more, see Creating - * a role for web identity or OpenID connect federation in the IAM - * User Guide.

- *

When you create the IAM OIDC provider, you specify the following:

- *
    - *
  • - *

    The URL of the OIDC identity provider (IdP) to trust

    - *
  • - *
  • - *

    A list of client IDs (also known as audiences) that identify the application - * or applications allowed to authenticate using the OIDC provider

    - *
  • - *
  • - *

    A list of tags that are attached to the specified IAM OIDC provider

    - *
  • - *
  • - *

    A list of thumbprints of one or more server certificates that the IdP - * uses

    - *
  • - *
- *

You get all of this information from the OIDC IdP you want to use to access - * Amazon Web Services.

- * - *

Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our - * library of trusted certificate authorities (CAs) instead of using a certificate - * thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, Auth0, - * and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these - * cases, your legacy thumbprint remains in your configuration, but is no longer used for - * validation.

- *
- * - *

The trust for the OIDC provider is derived from the IAM provider that this - * operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation to highly privileged - * users.

- *
- */ - public createOpenIDConnectProvider( + + /** + * @see {@link CreateOpenIDConnectProviderCommand} + */ + createOpenIDConnectProvider( args: CreateOpenIDConnectProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public createOpenIDConnectProvider( + createOpenIDConnectProvider( args: CreateOpenIDConnectProviderCommandInput, cb: (err: any, data?: CreateOpenIDConnectProviderCommandOutput) => void ): void; - public createOpenIDConnectProvider( + createOpenIDConnectProvider( args: CreateOpenIDConnectProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateOpenIDConnectProviderCommandOutput) => void ): void; - public createOpenIDConnectProvider( - args: CreateOpenIDConnectProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateOpenIDConnectProviderCommandOutput) => void), - cb?: (err: any, data?: CreateOpenIDConnectProviderCommandOutput) => void - ): Promise | void { - const command = new CreateOpenIDConnectProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new managed policy for your Amazon Web Services account.

- *

This operation creates a policy version with a version identifier of v1 - * and sets v1 as the policy's default version. For more information about policy versions, - * see Versioning for managed policies in the - * IAM User Guide.

- *

As a best practice, you can validate your IAM policies. - * To learn more, see Validating IAM policies - * in the IAM User Guide.

- *

For more information about managed policies in general, see Managed - * policies and inline policies in the - * IAM User Guide.

- */ - public createPolicy( - args: CreatePolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createPolicy(args: CreatePolicyCommandInput, cb: (err: any, data?: CreatePolicyCommandOutput) => void): void; - public createPolicy( + + /** + * @see {@link CreatePolicyCommand} + */ + createPolicy(args: CreatePolicyCommandInput, options?: __HttpHandlerOptions): Promise; + createPolicy(args: CreatePolicyCommandInput, cb: (err: any, data?: CreatePolicyCommandOutput) => void): void; + createPolicy( args: CreatePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePolicyCommandOutput) => void ): void; - public createPolicy( - args: CreatePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePolicyCommandOutput) => void), - cb?: (err: any, data?: CreatePolicyCommandOutput) => void - ): Promise | void { - const command = new CreatePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new version of the specified managed policy. To update a managed policy, you - * create a new policy version. A managed policy can have up to five versions. If the - * policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version.

- *

Optionally, you can set the new version as the policy's default version. The default - * version is the version that is in effect for the IAM users, groups, and roles to which - * the policy is attached.

- *

For more information about managed policy versions, see Versioning for managed - * policies in the IAM User Guide.

- */ - public createPolicyVersion( + + /** + * @see {@link CreatePolicyVersionCommand} + */ + createPolicyVersion( args: CreatePolicyVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPolicyVersion( + createPolicyVersion( args: CreatePolicyVersionCommandInput, cb: (err: any, data?: CreatePolicyVersionCommandOutput) => void ): void; - public createPolicyVersion( + createPolicyVersion( args: CreatePolicyVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePolicyVersionCommandOutput) => void ): void; - public createPolicyVersion( - args: CreatePolicyVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePolicyVersionCommandOutput) => void), - cb?: (err: any, data?: CreatePolicyVersionCommandOutput) => void - ): Promise | void { - const command = new CreatePolicyVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new role for your Amazon Web Services account. For more information about roles, see - * IAM - * roles. For information about quotas for role names and the number of roles - * you can create, see IAM and STS quotas in the - * IAM User Guide.

- */ - public createRole(args: CreateRoleCommandInput, options?: __HttpHandlerOptions): Promise; - public createRole(args: CreateRoleCommandInput, cb: (err: any, data?: CreateRoleCommandOutput) => void): void; - public createRole( + + /** + * @see {@link CreateRoleCommand} + */ + createRole(args: CreateRoleCommandInput, options?: __HttpHandlerOptions): Promise; + createRole(args: CreateRoleCommandInput, cb: (err: any, data?: CreateRoleCommandOutput) => void): void; + createRole( args: CreateRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRoleCommandOutput) => void ): void; - public createRole( - args: CreateRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRoleCommandOutput) => void), - cb?: (err: any, data?: CreateRoleCommandOutput) => void - ): Promise | void { - const command = new CreateRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an IAM resource that describes an identity provider (IdP) that supports SAML - * 2.0.

- *

The SAML provider resource that you create with this operation can be used as a - * principal in an IAM role's trust policy. Such a policy can enable federated users who - * sign in using the SAML IdP to assume the role. You can create an IAM role that - * supports Web-based single sign-on (SSO) to the Amazon Web Services Management Console or one that supports API access - * to Amazon Web Services.

- *

When you create the SAML provider resource, you upload a SAML metadata document that - * you get from your IdP. That document includes the issuer's name, expiration information, - * and keys that can be used to validate the SAML authentication response (assertions) that - * the IdP sends. You must generate the metadata document using the identity management - * software that is used as your organization's IdP.

- * - *

This operation requires Signature Version 4.

- *
- *

For more information, see Enabling SAML 2.0 - * federated users to access the Amazon Web Services Management Console and About SAML 2.0-based - * federation in the IAM User Guide.

- */ - public createSAMLProvider( + + /** + * @see {@link CreateSAMLProviderCommand} + */ + createSAMLProvider( args: CreateSAMLProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSAMLProvider( + createSAMLProvider( args: CreateSAMLProviderCommandInput, cb: (err: any, data?: CreateSAMLProviderCommandOutput) => void ): void; - public createSAMLProvider( + createSAMLProvider( args: CreateSAMLProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSAMLProviderCommandOutput) => void ): void; - public createSAMLProvider( - args: CreateSAMLProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSAMLProviderCommandOutput) => void), - cb?: (err: any, data?: CreateSAMLProviderCommandOutput) => void - ): Promise | void { - const command = new CreateSAMLProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an IAM role that is linked to a specific Amazon Web Services service. The service controls - * the attached policies and when the role can be deleted. This helps ensure that the - * service is not broken by an unexpectedly changed or deleted role, which could put your - * Amazon Web Services resources into an unknown state. Allowing the service to control the role helps - * improve service stability and proper cleanup when a service and its role are no longer - * needed. For more information, see Using service-linked - * roles in the IAM User Guide.

- *

To attach a policy to this service-linked role, you must make the request using the - * Amazon Web Services service that depends on this role.

- */ - public createServiceLinkedRole( + + /** + * @see {@link CreateServiceLinkedRoleCommand} + */ + createServiceLinkedRole( args: CreateServiceLinkedRoleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createServiceLinkedRole( + createServiceLinkedRole( args: CreateServiceLinkedRoleCommandInput, cb: (err: any, data?: CreateServiceLinkedRoleCommandOutput) => void ): void; - public createServiceLinkedRole( + createServiceLinkedRole( args: CreateServiceLinkedRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceLinkedRoleCommandOutput) => void ): void; - public createServiceLinkedRole( - args: CreateServiceLinkedRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateServiceLinkedRoleCommandOutput) => void), - cb?: (err: any, data?: CreateServiceLinkedRoleCommandOutput) => void - ): Promise | void { - const command = new CreateServiceLinkedRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Generates a set of credentials consisting of a user name and password that can be used - * to access the service specified in the request. These credentials are generated by - * IAM, and can be used only for the specified service.

- *

You can have a maximum of two sets of service-specific credentials for each supported - * service per user.

- *

You can create service-specific credentials for CodeCommit and Amazon Keyspaces (for Apache - * Cassandra).

- *

You can reset the password to a new service-generated value by calling ResetServiceSpecificCredential.

- *

For more information about service-specific credentials, see Using IAM - * with CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys in the - * IAM User Guide.

- */ - public createServiceSpecificCredential( + + /** + * @see {@link CreateServiceSpecificCredentialCommand} + */ + createServiceSpecificCredential( args: CreateServiceSpecificCredentialCommandInput, options?: __HttpHandlerOptions ): Promise; - public createServiceSpecificCredential( + createServiceSpecificCredential( args: CreateServiceSpecificCredentialCommandInput, cb: (err: any, data?: CreateServiceSpecificCredentialCommandOutput) => void ): void; - public createServiceSpecificCredential( + createServiceSpecificCredential( args: CreateServiceSpecificCredentialCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceSpecificCredentialCommandOutput) => void ): void; - public createServiceSpecificCredential( - args: CreateServiceSpecificCredentialCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateServiceSpecificCredentialCommandOutput) => void), - cb?: (err: any, data?: CreateServiceSpecificCredentialCommandOutput) => void - ): Promise | void { - const command = new CreateServiceSpecificCredentialCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new IAM user for your Amazon Web Services account.

- *

For information about quotas for the number of IAM users you can create, see IAM and STS - * quotas in the IAM User Guide.

- */ - public createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; - public createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; - public createUser( + + /** + * @see {@link CreateUserCommand} + */ + createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; + createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; + createUser( args: CreateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserCommandOutput) => void ): void; - public createUser( - args: CreateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserCommandOutput) => void), - cb?: (err: any, data?: CreateUserCommandOutput) => void - ): Promise | void { - const command = new CreateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new virtual MFA device for the Amazon Web Services account. After creating the virtual - * MFA, use EnableMFADevice to attach the MFA device to an IAM user. - * For more information about creating and working with virtual MFA devices, see Using a virtual MFA - * device in the IAM User Guide.

- *

For information about the maximum number of MFA devices you can create, see IAM and STS - * quotas in the IAM User Guide.

- * - *

The seed information contained in the QR code and the Base32 string should be - * treated like any other secret access information. In other words, protect the seed - * information as you would your Amazon Web Services access keys or your passwords. After you - * provision your virtual device, you should ensure that the information is destroyed - * following secure procedures.

- *
- */ - public createVirtualMFADevice( + + /** + * @see {@link CreateVirtualMFADeviceCommand} + */ + createVirtualMFADevice( args: CreateVirtualMFADeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVirtualMFADevice( + createVirtualMFADevice( args: CreateVirtualMFADeviceCommandInput, cb: (err: any, data?: CreateVirtualMFADeviceCommandOutput) => void ): void; - public createVirtualMFADevice( + createVirtualMFADevice( args: CreateVirtualMFADeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVirtualMFADeviceCommandOutput) => void ): void; - public createVirtualMFADevice( - args: CreateVirtualMFADeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVirtualMFADeviceCommandOutput) => void), - cb?: (err: any, data?: CreateVirtualMFADeviceCommandOutput) => void - ): Promise | void { - const command = new CreateVirtualMFADeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deactivates the specified MFA device and removes it from association with the user - * name for which it was originally enabled.

- *

For more information about creating and working with virtual MFA devices, see Enabling a virtual - * multi-factor authentication (MFA) device in the - * IAM User Guide.

- */ - public deactivateMFADevice( + + /** + * @see {@link DeactivateMFADeviceCommand} + */ + deactivateMFADevice( args: DeactivateMFADeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deactivateMFADevice( + deactivateMFADevice( args: DeactivateMFADeviceCommandInput, cb: (err: any, data?: DeactivateMFADeviceCommandOutput) => void ): void; - public deactivateMFADevice( + deactivateMFADevice( args: DeactivateMFADeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeactivateMFADeviceCommandOutput) => void ): void; - public deactivateMFADevice( - args: DeactivateMFADeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeactivateMFADeviceCommandOutput) => void), - cb?: (err: any, data?: DeactivateMFADeviceCommandOutput) => void - ): Promise | void { - const command = new DeactivateMFADeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the access key pair associated with the specified IAM user.

- *

If you do not specify a user name, IAM determines the user name implicitly based on - * the Amazon Web Services access key ID signing the request. This operation works for access keys under - * the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root - * user credentials even if the Amazon Web Services account has no associated users.

- */ - public deleteAccessKey( + + /** + * @see {@link DeleteAccessKeyCommand} + */ + deleteAccessKey( args: DeleteAccessKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAccessKey( - args: DeleteAccessKeyCommandInput, - cb: (err: any, data?: DeleteAccessKeyCommandOutput) => void - ): void; - public deleteAccessKey( + deleteAccessKey(args: DeleteAccessKeyCommandInput, cb: (err: any, data?: DeleteAccessKeyCommandOutput) => void): void; + deleteAccessKey( args: DeleteAccessKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessKeyCommandOutput) => void ): void; - public deleteAccessKey( - args: DeleteAccessKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAccessKeyCommandOutput) => void), - cb?: (err: any, data?: DeleteAccessKeyCommandOutput) => void - ): Promise | void { - const command = new DeleteAccessKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services - * account alias, see Using an alias for your Amazon Web Services account ID in the - * IAM User Guide.

- */ - public deleteAccountAlias( + + /** + * @see {@link DeleteAccountAliasCommand} + */ + deleteAccountAlias( args: DeleteAccountAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAccountAlias( + deleteAccountAlias( args: DeleteAccountAliasCommandInput, cb: (err: any, data?: DeleteAccountAliasCommandOutput) => void ): void; - public deleteAccountAlias( + deleteAccountAlias( args: DeleteAccountAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccountAliasCommandOutput) => void ): void; - public deleteAccountAlias( - args: DeleteAccountAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAccountAliasCommandOutput) => void), - cb?: (err: any, data?: DeleteAccountAliasCommandOutput) => void - ): Promise | void { - const command = new DeleteAccountAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the password policy for the Amazon Web Services account. There are no parameters.

- */ - public deleteAccountPasswordPolicy( + + /** + * @see {@link DeleteAccountPasswordPolicyCommand} + */ + deleteAccountPasswordPolicy( args: DeleteAccountPasswordPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAccountPasswordPolicy( + deleteAccountPasswordPolicy( args: DeleteAccountPasswordPolicyCommandInput, cb: (err: any, data?: DeleteAccountPasswordPolicyCommandOutput) => void ): void; - public deleteAccountPasswordPolicy( + deleteAccountPasswordPolicy( args: DeleteAccountPasswordPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccountPasswordPolicyCommandOutput) => void ): void; - public deleteAccountPasswordPolicy( - args: DeleteAccountPasswordPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAccountPasswordPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteAccountPasswordPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteAccountPasswordPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified IAM group. The group must not contain any users or have any - * attached policies.

- */ - public deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void; - public deleteGroup( + + /** + * @see {@link DeleteGroupCommand} + */ + deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise; + deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void; + deleteGroup( args: DeleteGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupCommandOutput) => void ): void; - public deleteGroup( - args: DeleteGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified inline policy that is embedded in the specified IAM - * group.

- *

A group can also have managed policies attached to it. To detach a managed policy from - * a group, use DetachGroupPolicy. For more information about policies, - * refer to Managed policies and inline - * policies in the IAM User Guide.

- */ - public deleteGroupPolicy( + + /** + * @see {@link DeleteGroupPolicyCommand} + */ + deleteGroupPolicy( args: DeleteGroupPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteGroupPolicy( + deleteGroupPolicy( args: DeleteGroupPolicyCommandInput, cb: (err: any, data?: DeleteGroupPolicyCommandOutput) => void ): void; - public deleteGroupPolicy( + deleteGroupPolicy( args: DeleteGroupPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupPolicyCommandOutput) => void ): void; - public deleteGroupPolicy( - args: DeleteGroupPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGroupPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteGroupPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteGroupPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified instance profile. The instance profile must not have an - * associated role.

- * - *

Make sure that you do not have any Amazon EC2 instances running with the instance - * profile you are about to delete. Deleting a role or instance profile that is - * associated with a running instance will break any applications running on the - * instance.

- *
- *

For more information about instance profiles, see About instance - * profiles.

- */ - public deleteInstanceProfile( + + /** + * @see {@link DeleteInstanceProfileCommand} + */ + deleteInstanceProfile( args: DeleteInstanceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInstanceProfile( + deleteInstanceProfile( args: DeleteInstanceProfileCommandInput, cb: (err: any, data?: DeleteInstanceProfileCommandOutput) => void ): void; - public deleteInstanceProfile( + deleteInstanceProfile( args: DeleteInstanceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInstanceProfileCommandOutput) => void ): void; - public deleteInstanceProfile( - args: DeleteInstanceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInstanceProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteInstanceProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteInstanceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the password for the specified IAM user, For more information, see Managing - * passwords for IAM users.

- *

You can use the CLI, the Amazon Web Services API, or the Users - * page in the IAM console to delete a password for any IAM user. You can use ChangePassword to update, but not delete, your own password in the - * My Security Credentials page in the - * Amazon Web Services Management Console.

- * - *

Deleting a user's password does not prevent a user from accessing Amazon Web Services through - * the command line interface or the API. To prevent all user access, you must also - * either make any access keys inactive or delete them. For more information about - * making keys inactive or deleting them, see UpdateAccessKey and - * DeleteAccessKey.

- *
- */ - public deleteLoginProfile( + + /** + * @see {@link DeleteLoginProfileCommand} + */ + deleteLoginProfile( args: DeleteLoginProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLoginProfile( + deleteLoginProfile( args: DeleteLoginProfileCommandInput, cb: (err: any, data?: DeleteLoginProfileCommandOutput) => void ): void; - public deleteLoginProfile( + deleteLoginProfile( args: DeleteLoginProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLoginProfileCommandOutput) => void ): void; - public deleteLoginProfile( - args: DeleteLoginProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLoginProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteLoginProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteLoginProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an OpenID Connect identity provider (IdP) resource object in IAM.

- *

Deleting an IAM OIDC provider resource does not update any roles that reference the - * provider as a principal in their trust policies. Any attempt to assume a role that - * references a deleted provider fails.

- *

This operation is idempotent; it does not fail or return an error if you call the - * operation for a provider that does not exist.

- */ - public deleteOpenIDConnectProvider( + + /** + * @see {@link DeleteOpenIDConnectProviderCommand} + */ + deleteOpenIDConnectProvider( args: DeleteOpenIDConnectProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteOpenIDConnectProvider( + deleteOpenIDConnectProvider( args: DeleteOpenIDConnectProviderCommandInput, cb: (err: any, data?: DeleteOpenIDConnectProviderCommandOutput) => void ): void; - public deleteOpenIDConnectProvider( + deleteOpenIDConnectProvider( args: DeleteOpenIDConnectProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOpenIDConnectProviderCommandOutput) => void ): void; - public deleteOpenIDConnectProvider( - args: DeleteOpenIDConnectProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteOpenIDConnectProviderCommandOutput) => void), - cb?: (err: any, data?: DeleteOpenIDConnectProviderCommandOutput) => void - ): Promise | void { - const command = new DeleteOpenIDConnectProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified managed policy.

- *

Before you can delete a managed policy, you must first detach the policy from all - * users, groups, and roles that it is attached to. In addition, you must delete all the - * policy's versions. The following steps describe the process for deleting a managed - * policy:

- *
    - *
  • - *

    Detach the policy from all users, groups, and roles that the policy is - * attached to, using DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy. To - * list all the users, groups, and roles that a policy is attached to, use ListEntitiesForPolicy.

    - *
  • - *
  • - *

    Delete all versions of the policy using DeletePolicyVersion. - * To list the policy's versions, use ListPolicyVersions. You - * cannot use DeletePolicyVersion to delete the version that is - * marked as the default version. You delete the policy's default version in the - * next step of the process.

    - *
  • - *
  • - *

    Delete the policy (this automatically deletes the policy's default version) - * using this operation.

    - *
  • - *
- *

For information about managed policies, see Managed policies and inline - * policies in the IAM User Guide.

- */ - public deletePolicy( - args: DeletePolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deletePolicy(args: DeletePolicyCommandInput, cb: (err: any, data?: DeletePolicyCommandOutput) => void): void; - public deletePolicy( + + /** + * @see {@link DeletePolicyCommand} + */ + deletePolicy(args: DeletePolicyCommandInput, options?: __HttpHandlerOptions): Promise; + deletePolicy(args: DeletePolicyCommandInput, cb: (err: any, data?: DeletePolicyCommandOutput) => void): void; + deletePolicy( args: DeletePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePolicyCommandOutput) => void ): void; - public deletePolicy( - args: DeletePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePolicyCommandOutput) => void), - cb?: (err: any, data?: DeletePolicyCommandOutput) => void - ): Promise | void { - const command = new DeletePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified version from the specified managed policy.

- *

You cannot delete the default version from a policy using this operation. To delete - * the default version from a policy, use DeletePolicy. To find out which - * version of a policy is marked as the default version, use ListPolicyVersions.

- *

For information about versions for managed policies, see Versioning for managed - * policies in the IAM User Guide.

- */ - public deletePolicyVersion( + + /** + * @see {@link DeletePolicyVersionCommand} + */ + deletePolicyVersion( args: DeletePolicyVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePolicyVersion( + deletePolicyVersion( args: DeletePolicyVersionCommandInput, cb: (err: any, data?: DeletePolicyVersionCommandOutput) => void ): void; - public deletePolicyVersion( + deletePolicyVersion( args: DeletePolicyVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePolicyVersionCommandOutput) => void ): void; - public deletePolicyVersion( - args: DeletePolicyVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePolicyVersionCommandOutput) => void), - cb?: (err: any, data?: DeletePolicyVersionCommandOutput) => void - ): Promise | void { - const command = new DeletePolicyVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified role. Unlike the Amazon Web Services Management Console, when you delete a role - * programmatically, you must delete the items attached to the role manually, or the - * deletion fails. For more information, see Deleting an IAM role. Before attempting to delete a role, remove the - * following attached items:

- * - * - *

Make sure that you do not have any Amazon EC2 instances running with the role you - * are about to delete. Deleting a role or instance profile that is associated with a - * running instance will break any applications running on the instance.

- *
- */ - public deleteRole(args: DeleteRoleCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteRole(args: DeleteRoleCommandInput, cb: (err: any, data?: DeleteRoleCommandOutput) => void): void; - public deleteRole( + + /** + * @see {@link DeleteRoleCommand} + */ + deleteRole(args: DeleteRoleCommandInput, options?: __HttpHandlerOptions): Promise; + deleteRole(args: DeleteRoleCommandInput, cb: (err: any, data?: DeleteRoleCommandOutput) => void): void; + deleteRole( args: DeleteRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRoleCommandOutput) => void ): void; - public deleteRole( - args: DeleteRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRoleCommandOutput) => void), - cb?: (err: any, data?: DeleteRoleCommandOutput) => void - ): Promise | void { - const command = new DeleteRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the permissions boundary for the specified IAM role.

- *

You cannot set the boundary for a service-linked role.

- * - *

Deleting the permissions boundary for a role might increase its permissions. For - * example, it might allow anyone who assumes the role to perform all the actions - * granted in its permissions policies.

- *
- */ - public deleteRolePermissionsBoundary( + + /** + * @see {@link DeleteRolePermissionsBoundaryCommand} + */ + deleteRolePermissionsBoundary( args: DeleteRolePermissionsBoundaryCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRolePermissionsBoundary( + deleteRolePermissionsBoundary( args: DeleteRolePermissionsBoundaryCommandInput, cb: (err: any, data?: DeleteRolePermissionsBoundaryCommandOutput) => void ): void; - public deleteRolePermissionsBoundary( + deleteRolePermissionsBoundary( args: DeleteRolePermissionsBoundaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRolePermissionsBoundaryCommandOutput) => void ): void; - public deleteRolePermissionsBoundary( - args: DeleteRolePermissionsBoundaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRolePermissionsBoundaryCommandOutput) => void), - cb?: (err: any, data?: DeleteRolePermissionsBoundaryCommandOutput) => void - ): Promise | void { - const command = new DeleteRolePermissionsBoundaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified inline policy that is embedded in the specified IAM - * role.

- *

A role can also have managed policies attached to it. To detach a managed policy from - * a role, use DetachRolePolicy. For more information about policies, - * refer to Managed policies and inline - * policies in the IAM User Guide.

- */ - public deleteRolePolicy( + + /** + * @see {@link DeleteRolePolicyCommand} + */ + deleteRolePolicy( args: DeleteRolePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRolePolicy( + deleteRolePolicy( args: DeleteRolePolicyCommandInput, cb: (err: any, data?: DeleteRolePolicyCommandOutput) => void ): void; - public deleteRolePolicy( + deleteRolePolicy( args: DeleteRolePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRolePolicyCommandOutput) => void ): void; - public deleteRolePolicy( - args: DeleteRolePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRolePolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteRolePolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteRolePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a SAML provider resource in IAM.

- *

Deleting the provider resource from IAM does not update any roles that reference the - * SAML provider resource's ARN as a principal in their trust policies. Any attempt to - * assume a role that references a non-existent provider resource ARN fails.

- * - *

This operation requires Signature Version 4.

- *
- */ - public deleteSAMLProvider( + + /** + * @see {@link DeleteSAMLProviderCommand} + */ + deleteSAMLProvider( args: DeleteSAMLProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSAMLProvider( + deleteSAMLProvider( args: DeleteSAMLProviderCommandInput, cb: (err: any, data?: DeleteSAMLProviderCommandOutput) => void ): void; - public deleteSAMLProvider( + deleteSAMLProvider( args: DeleteSAMLProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSAMLProviderCommandOutput) => void ): void; - public deleteSAMLProvider( - args: DeleteSAMLProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSAMLProviderCommandOutput) => void), - cb?: (err: any, data?: DeleteSAMLProviderCommandOutput) => void - ): Promise | void { - const command = new DeleteSAMLProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified server certificate.

- *

For more information about working with server certificates, see Working - * with server certificates in the IAM User Guide. This - * topic also includes a list of Amazon Web Services services that can use the server certificates that - * you manage with IAM.

- * - *

If you are using a server certificate with Elastic Load Balancing, deleting the - * certificate could have implications for your application. If Elastic Load Balancing - * doesn't detect the deletion of bound certificates, it may continue to use the - * certificates. This could cause Elastic Load Balancing to stop accepting traffic. We - * recommend that you remove the reference to the certificate from Elastic Load - * Balancing before using this command to delete the certificate. For more information, - * see DeleteLoadBalancerListeners in the Elastic Load Balancing API - * Reference.

- *
- */ - public deleteServerCertificate( + + /** + * @see {@link DeleteServerCertificateCommand} + */ + deleteServerCertificate( args: DeleteServerCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteServerCertificate( + deleteServerCertificate( args: DeleteServerCertificateCommandInput, cb: (err: any, data?: DeleteServerCertificateCommandOutput) => void ): void; - public deleteServerCertificate( + deleteServerCertificate( args: DeleteServerCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServerCertificateCommandOutput) => void ): void; - public deleteServerCertificate( - args: DeleteServerCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteServerCertificateCommandOutput) => void), - cb?: (err: any, data?: DeleteServerCertificateCommandOutput) => void - ): Promise | void { - const command = new DeleteServerCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Submits a service-linked role deletion request and returns a - * DeletionTaskId, which you can use to check the status of the deletion. - * Before you call this operation, confirm that the role has no active sessions and that - * any resources used by the role in the linked service are deleted. If you call this - * operation more than once for the same service-linked role and an earlier deletion task - * is not complete, then the DeletionTaskId of the earlier request is - * returned.

- *

If you submit a deletion request for a service-linked role whose linked service is - * still accessing a resource, then the deletion task fails. If it fails, the GetServiceLinkedRoleDeletionStatus operation returns the reason for the - * failure, usually including the resources that must be deleted. To delete the - * service-linked role, you must first remove those resources from the linked service and - * then submit the deletion request again. Resources are specific to the service that is - * linked to the role. For more information about removing resources from a service, see - * the Amazon Web Services documentation for your - * service.

- *

For more information about service-linked roles, see Roles terms and concepts: Amazon Web Services service-linked role in the - * IAM User Guide.

- */ - public deleteServiceLinkedRole( + + /** + * @see {@link DeleteServiceLinkedRoleCommand} + */ + deleteServiceLinkedRole( args: DeleteServiceLinkedRoleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteServiceLinkedRole( + deleteServiceLinkedRole( args: DeleteServiceLinkedRoleCommandInput, cb: (err: any, data?: DeleteServiceLinkedRoleCommandOutput) => void ): void; - public deleteServiceLinkedRole( + deleteServiceLinkedRole( args: DeleteServiceLinkedRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceLinkedRoleCommandOutput) => void ): void; - public deleteServiceLinkedRole( - args: DeleteServiceLinkedRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteServiceLinkedRoleCommandOutput) => void), - cb?: (err: any, data?: DeleteServiceLinkedRoleCommandOutput) => void - ): Promise | void { - const command = new DeleteServiceLinkedRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified service-specific credential.

- */ - public deleteServiceSpecificCredential( + + /** + * @see {@link DeleteServiceSpecificCredentialCommand} + */ + deleteServiceSpecificCredential( args: DeleteServiceSpecificCredentialCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteServiceSpecificCredential( + deleteServiceSpecificCredential( args: DeleteServiceSpecificCredentialCommandInput, cb: (err: any, data?: DeleteServiceSpecificCredentialCommandOutput) => void ): void; - public deleteServiceSpecificCredential( + deleteServiceSpecificCredential( args: DeleteServiceSpecificCredentialCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceSpecificCredentialCommandOutput) => void ): void; - public deleteServiceSpecificCredential( - args: DeleteServiceSpecificCredentialCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteServiceSpecificCredentialCommandOutput) => void), - cb?: (err: any, data?: DeleteServiceSpecificCredentialCommandOutput) => void - ): Promise | void { - const command = new DeleteServiceSpecificCredentialCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a signing certificate associated with the specified IAM user.

- *

If you do not specify a user name, IAM determines the user name implicitly based on - * the Amazon Web Services access key ID signing the request. This operation works for access keys under - * the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root - * user credentials even if the Amazon Web Services account has no associated IAM users.

- */ - public deleteSigningCertificate( + + /** + * @see {@link DeleteSigningCertificateCommand} + */ + deleteSigningCertificate( args: DeleteSigningCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSigningCertificate( + deleteSigningCertificate( args: DeleteSigningCertificateCommandInput, cb: (err: any, data?: DeleteSigningCertificateCommandOutput) => void ): void; - public deleteSigningCertificate( + deleteSigningCertificate( args: DeleteSigningCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSigningCertificateCommandOutput) => void ): void; - public deleteSigningCertificate( - args: DeleteSigningCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSigningCertificateCommandOutput) => void), - cb?: (err: any, data?: DeleteSigningCertificateCommandOutput) => void - ): Promise | void { - const command = new DeleteSigningCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified SSH public key.

- *

The SSH public key deleted by this operation is used only for authenticating the - * associated IAM user to an CodeCommit repository. For more information about using SSH keys - * to authenticate to an CodeCommit repository, see Set up CodeCommit for - * SSH connections in the CodeCommit User Guide.

- */ - public deleteSSHPublicKey( + + /** + * @see {@link DeleteSSHPublicKeyCommand} + */ + deleteSSHPublicKey( args: DeleteSSHPublicKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSSHPublicKey( + deleteSSHPublicKey( args: DeleteSSHPublicKeyCommandInput, cb: (err: any, data?: DeleteSSHPublicKeyCommandOutput) => void ): void; - public deleteSSHPublicKey( + deleteSSHPublicKey( args: DeleteSSHPublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSSHPublicKeyCommandOutput) => void ): void; - public deleteSSHPublicKey( - args: DeleteSSHPublicKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSSHPublicKeyCommandOutput) => void), - cb?: (err: any, data?: DeleteSSHPublicKeyCommandOutput) => void - ): Promise | void { - const command = new DeleteSSHPublicKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified IAM user. Unlike the Amazon Web Services Management Console, when you delete a user - * programmatically, you must delete the items attached to the user manually, or the - * deletion fails. For more information, see Deleting an IAM - * user. Before attempting to delete a user, remove the following items:

- * - */ - public deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; - public deleteUser( + + /** + * @see {@link DeleteUserCommand} + */ + deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; + deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; + deleteUser( args: DeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserCommandOutput) => void ): void; - public deleteUser( - args: DeleteUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserCommandOutput) => void), - cb?: (err: any, data?: DeleteUserCommandOutput) => void - ): Promise | void { - const command = new DeleteUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the permissions boundary for the specified IAM user.

- * - *

Deleting the permissions boundary for a user might increase its permissions by - * allowing the user to perform all the actions granted in its permissions policies. - *

- *
- */ - public deleteUserPermissionsBoundary( + + /** + * @see {@link DeleteUserPermissionsBoundaryCommand} + */ + deleteUserPermissionsBoundary( args: DeleteUserPermissionsBoundaryCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteUserPermissionsBoundary( + deleteUserPermissionsBoundary( args: DeleteUserPermissionsBoundaryCommandInput, cb: (err: any, data?: DeleteUserPermissionsBoundaryCommandOutput) => void ): void; - public deleteUserPermissionsBoundary( + deleteUserPermissionsBoundary( args: DeleteUserPermissionsBoundaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserPermissionsBoundaryCommandOutput) => void ): void; - public deleteUserPermissionsBoundary( - args: DeleteUserPermissionsBoundaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserPermissionsBoundaryCommandOutput) => void), - cb?: (err: any, data?: DeleteUserPermissionsBoundaryCommandOutput) => void - ): Promise | void { - const command = new DeleteUserPermissionsBoundaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified inline policy that is embedded in the specified IAM - * user.

- *

A user can also have managed policies attached to it. To detach a managed policy from - * a user, use DetachUserPolicy. For more information about policies, - * refer to Managed policies and inline - * policies in the IAM User Guide.

- */ - public deleteUserPolicy( + + /** + * @see {@link DeleteUserPolicyCommand} + */ + deleteUserPolicy( args: DeleteUserPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteUserPolicy( + deleteUserPolicy( args: DeleteUserPolicyCommandInput, cb: (err: any, data?: DeleteUserPolicyCommandOutput) => void ): void; - public deleteUserPolicy( + deleteUserPolicy( args: DeleteUserPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserPolicyCommandOutput) => void ): void; - public deleteUserPolicy( - args: DeleteUserPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteUserPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteUserPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a virtual MFA device.

- * - *

You must deactivate a user's virtual MFA device before you can delete it. For - * information about deactivating MFA devices, see DeactivateMFADevice.

- *
- */ - public deleteVirtualMFADevice( + + /** + * @see {@link DeleteVirtualMFADeviceCommand} + */ + deleteVirtualMFADevice( args: DeleteVirtualMFADeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVirtualMFADevice( + deleteVirtualMFADevice( args: DeleteVirtualMFADeviceCommandInput, cb: (err: any, data?: DeleteVirtualMFADeviceCommandOutput) => void ): void; - public deleteVirtualMFADevice( + deleteVirtualMFADevice( args: DeleteVirtualMFADeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVirtualMFADeviceCommandOutput) => void ): void; - public deleteVirtualMFADevice( - args: DeleteVirtualMFADeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVirtualMFADeviceCommandOutput) => void), - cb?: (err: any, data?: DeleteVirtualMFADeviceCommandOutput) => void - ): Promise | void { - const command = new DeleteVirtualMFADeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the specified managed policy from the specified IAM group.

- *

A group can also have inline policies embedded with it. To delete an inline policy, - * use DeleteGroupPolicy. For information about policies, see Managed - * policies and inline policies in the - * IAM User Guide.

- */ - public detachGroupPolicy( + + /** + * @see {@link DetachGroupPolicyCommand} + */ + detachGroupPolicy( args: DetachGroupPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachGroupPolicy( + detachGroupPolicy( args: DetachGroupPolicyCommandInput, cb: (err: any, data?: DetachGroupPolicyCommandOutput) => void ): void; - public detachGroupPolicy( + detachGroupPolicy( args: DetachGroupPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachGroupPolicyCommandOutput) => void ): void; - public detachGroupPolicy( - args: DetachGroupPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachGroupPolicyCommandOutput) => void), - cb?: (err: any, data?: DetachGroupPolicyCommandOutput) => void - ): Promise | void { - const command = new DetachGroupPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the specified managed policy from the specified role.

- *

A role can also have inline policies embedded with it. To delete an inline policy, use - * DeleteRolePolicy. For information about policies, see Managed - * policies and inline policies in the - * IAM User Guide.

- */ - public detachRolePolicy( + + /** + * @see {@link DetachRolePolicyCommand} + */ + detachRolePolicy( args: DetachRolePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachRolePolicy( + detachRolePolicy( args: DetachRolePolicyCommandInput, cb: (err: any, data?: DetachRolePolicyCommandOutput) => void ): void; - public detachRolePolicy( + detachRolePolicy( args: DetachRolePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachRolePolicyCommandOutput) => void ): void; - public detachRolePolicy( - args: DetachRolePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachRolePolicyCommandOutput) => void), - cb?: (err: any, data?: DetachRolePolicyCommandOutput) => void - ): Promise | void { - const command = new DetachRolePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the specified managed policy from the specified user.

- *

A user can also have inline policies embedded with it. To delete an inline policy, use - * DeleteUserPolicy. For information about policies, see Managed - * policies and inline policies in the - * IAM User Guide.

- */ - public detachUserPolicy( + + /** + * @see {@link DetachUserPolicyCommand} + */ + detachUserPolicy( args: DetachUserPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachUserPolicy( + detachUserPolicy( args: DetachUserPolicyCommandInput, cb: (err: any, data?: DetachUserPolicyCommandOutput) => void ): void; - public detachUserPolicy( + detachUserPolicy( args: DetachUserPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachUserPolicyCommandOutput) => void ): void; - public detachUserPolicy( - args: DetachUserPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachUserPolicyCommandOutput) => void), - cb?: (err: any, data?: DetachUserPolicyCommandOutput) => void - ): Promise | void { - const command = new DetachUserPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables the specified MFA device and associates it with the specified IAM user. When - * enabled, the MFA device is required for every subsequent login by the IAM user - * associated with the device.

- */ - public enableMFADevice( - args: EnableMFADeviceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public enableMFADevice( + + /** + * @see {@link EnableMFADeviceCommand} + */ + enableMFADevice( args: EnableMFADeviceCommandInput, - cb: (err: any, data?: EnableMFADeviceCommandOutput) => void - ): void; - public enableMFADevice( + options?: __HttpHandlerOptions + ): Promise; + enableMFADevice(args: EnableMFADeviceCommandInput, cb: (err: any, data?: EnableMFADeviceCommandOutput) => void): void; + enableMFADevice( args: EnableMFADeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableMFADeviceCommandOutput) => void ): void; - public enableMFADevice( - args: EnableMFADeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableMFADeviceCommandOutput) => void), - cb?: (err: any, data?: EnableMFADeviceCommandOutput) => void - ): Promise | void { - const command = new EnableMFADeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Generates a credential report for the Amazon Web Services account. For more information about the - * credential report, see Getting credential reports in - * the IAM User Guide.

- */ - public generateCredentialReport( + + /** + * @see {@link GenerateCredentialReportCommand} + */ + generateCredentialReport( args: GenerateCredentialReportCommandInput, options?: __HttpHandlerOptions ): Promise; - public generateCredentialReport( + generateCredentialReport( args: GenerateCredentialReportCommandInput, cb: (err: any, data?: GenerateCredentialReportCommandOutput) => void ): void; - public generateCredentialReport( + generateCredentialReport( args: GenerateCredentialReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateCredentialReportCommandOutput) => void ): void; - public generateCredentialReport( - args: GenerateCredentialReportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GenerateCredentialReportCommandOutput) => void), - cb?: (err: any, data?: GenerateCredentialReportCommandOutput) => void - ): Promise | void { - const command = new GenerateCredentialReportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Generates a report for service last accessed data for Organizations. You can generate a - * report for any entities (organization root, organizational unit, or account) or policies - * in your organization.

- *

To call this operation, you must be signed in using your Organizations management account - * credentials. You can use your long-term IAM user or root user credentials, or temporary - * credentials from assuming an IAM role. SCPs must be enabled for your organization - * root. You must have the required IAM and Organizations permissions. For more information, see - * Refining permissions using service last accessed data in the - * IAM User Guide.

- *

You can generate a service last accessed data report for entities by specifying only - * the entity's path. This data includes a list of services that are allowed by any service - * control policies (SCPs) that apply to the entity.

- *

You can generate a service last accessed data report for a policy by specifying an - * entity's path and an optional Organizations policy ID. This data includes a list of services that - * are allowed by the specified SCP.

- *

For each service in both report types, the data includes the most recent account - * activity that the policy allows to account principals in the entity or the entity's - * children. For important information about the data, reporting period, permissions - * required, troubleshooting, and supported Regions see Reducing permissions using - * service last accessed data in the - * IAM User Guide.

- * - *

The data includes all attempts to access Amazon Web Services, not just the successful ones. This - * includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any - * of the SDKs, or any of the command line tools. An unexpected entry in the service - * last accessed data does not mean that an account has been compromised, because the - * request might have been denied. Refer to your CloudTrail logs as the authoritative - * source for information about all API calls and whether they were successful or - * denied access. For more information, see Logging IAM events with - * CloudTrail in the IAM User Guide.

- *
- *

This operation returns a JobId. Use this parameter in the - * GetOrganizationsAccessReport - * operation to check the status of - * the report generation. To check the status of this request, use the JobId - * parameter in the - * GetOrganizationsAccessReport - * operation - * and test the JobStatus response parameter. When the job is complete, you - * can retrieve the report.

- *

To generate a service last accessed data report for entities, specify an entity path - * without specifying the optional Organizations policy ID. The type of entity that you specify - * determines the data returned in the report.

- *
    - *
  • - *

    - * Root – When you specify the - * organizations root as the entity, the resulting report lists all of the services - * allowed by SCPs that are attached to your root. For each service, the report - * includes data for all accounts in your organization except the - * management account, because the management account is not limited by SCPs.

    - *
  • - *
  • - *

    - * OU – When you specify an - * organizational unit (OU) as the entity, the resulting report lists all of the - * services allowed by SCPs that are attached to the OU and its parents. For each - * service, the report includes data for all accounts in the OU or its children. - * This data excludes the management account, because the management account is not - * limited by SCPs.

    - *
  • - *
  • - *

    - * management account – When you specify the - * management account, the resulting report lists all Amazon Web Services services, because the - * management account is not limited by SCPs. For each service, the report includes - * data for only the management account.

    - *
  • - *
  • - *

    - * Account – When you specify another - * account as the entity, the resulting report lists all of the services allowed by - * SCPs that are attached to the account and its parents. For each service, the - * report includes data for only the specified account.

    - *
  • - *
- *

To generate a service last accessed data report for policies, specify an entity path - * and the optional Organizations policy ID. The type of entity that you specify determines the data - * returned for each service.

- *
    - *
  • - *

    - * Root – When you specify the root - * entity and a policy ID, the resulting report lists all of the services that are - * allowed by the specified SCP. For each service, the report includes data for all - * accounts in your organization to which the SCP applies. This data excludes the - * management account, because the management account is not limited by SCPs. If the - * SCP is not attached to any entities in the organization, then the report will - * return a list of services with no data.

    - *
  • - *
  • - *

    - * OU – When you specify an OU entity and - * a policy ID, the resulting report lists all of the services that are allowed by - * the specified SCP. For each service, the report includes data for all accounts - * in the OU or its children to which the SCP applies. This means that other - * accounts outside the OU that are affected by the SCP might not be included in - * the data. This data excludes the management account, because the - * management account is not limited by SCPs. If the SCP is not attached to the OU - * or one of its children, the report will return a list of services with no - * data.

    - *
  • - *
  • - *

    - * management account – When you specify the - * management account, the resulting report lists all Amazon Web Services services, because the - * management account is not limited by SCPs. If you specify a policy ID in the CLI - * or API, the policy is ignored. For each service, the report includes data for - * only the management account.

    - *
  • - *
  • - *

    - * Account – When you specify another - * account entity and a policy ID, the resulting report lists all of the services - * that are allowed by the specified SCP. For each service, the report includes - * data for only the specified account. This means that other accounts in the - * organization that are affected by the SCP might not be included in the data. If - * the SCP is not attached to the account, the report will return a list of - * services with no data.

    - *
  • - *
- * - *

Service last accessed data does not use other policy types when determining - * whether a principal could access a service. These other policy types include - * identity-based policies, resource-based policies, access control lists, IAM - * permissions boundaries, and STS assume role policies. It only applies SCP logic. - * For more about the evaluation of policy types, see Evaluating policies in the - * IAM User Guide.

- *
- *

For more information about service last accessed data, see Reducing policy scope by - * viewing user activity in the IAM User Guide.

- */ - public generateOrganizationsAccessReport( + + /** + * @see {@link GenerateOrganizationsAccessReportCommand} + */ + generateOrganizationsAccessReport( args: GenerateOrganizationsAccessReportCommandInput, options?: __HttpHandlerOptions ): Promise; - public generateOrganizationsAccessReport( + generateOrganizationsAccessReport( args: GenerateOrganizationsAccessReportCommandInput, cb: (err: any, data?: GenerateOrganizationsAccessReportCommandOutput) => void ): void; - public generateOrganizationsAccessReport( + generateOrganizationsAccessReport( args: GenerateOrganizationsAccessReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateOrganizationsAccessReportCommandOutput) => void ): void; - public generateOrganizationsAccessReport( - args: GenerateOrganizationsAccessReportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GenerateOrganizationsAccessReportCommandOutput) => void), - cb?: (err: any, data?: GenerateOrganizationsAccessReportCommandOutput) => void - ): Promise | void { - const command = new GenerateOrganizationsAccessReportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Generates a report that includes details about when an IAM resource (user, group, - * role, or policy) was last used in an attempt to access Amazon Web Services services. Recent activity - * usually appears within four hours. IAM reports activity for at least the last 400 - * days, or less if your Region began supporting this feature within the last year. For - * more information, see Regions where data is tracked.

- * - *

The service last accessed data includes all attempts to access an Amazon Web Services API, not - * just the successful ones. This includes all attempts that were made using the - * Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. - * An unexpected entry in the service last accessed data does not mean that your - * account has been compromised, because the request might have been denied. Refer to - * your CloudTrail logs as the authoritative source for information about all API calls - * and whether they were successful or denied access. For more information, see Logging - * IAM events with CloudTrail in the - * IAM User Guide.

- *
- *

The GenerateServiceLastAccessedDetails operation returns a - * JobId. Use this parameter in the following operations to retrieve the - * following details from your report:

- *
    - *
  • - *

    - * GetServiceLastAccessedDetails – Use this operation - * for users, groups, roles, or policies to list every Amazon Web Services service that the - * resource could access using permissions policies. For each service, the response - * includes information about the most recent access attempt.

    - *

    The JobId returned by - * GenerateServiceLastAccessedDetail must be used by the same role - * within a session, or by the same user when used to call - * GetServiceLastAccessedDetail.

    - *
  • - *
  • - *

    - * GetServiceLastAccessedDetailsWithEntities – Use this - * operation for groups and policies to list information about the associated - * entities (users or roles) that attempted to access a specific Amazon Web Services service. - *

    - *
  • - *
- *

To check the status of the GenerateServiceLastAccessedDetails request, - * use the JobId parameter in the same operations and test the - * JobStatus response parameter.

- *

For additional information about the permissions policies that allow an identity - * (user, group, or role) to access specific services, use the ListPoliciesGrantingServiceAccess operation.

- * - *

Service last accessed data does not use other policy types when determining - * whether a resource could access a service. These other policy types include - * resource-based policies, access control lists, Organizations policies, IAM permissions - * boundaries, and STS assume role policies. It only applies permissions policy - * logic. For more about the evaluation of policy types, see Evaluating policies in the - * IAM User Guide.

- *
- *

For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the - * IAM User Guide.

- */ - public generateServiceLastAccessedDetails( + + /** + * @see {@link GenerateServiceLastAccessedDetailsCommand} + */ + generateServiceLastAccessedDetails( args: GenerateServiceLastAccessedDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public generateServiceLastAccessedDetails( + generateServiceLastAccessedDetails( args: GenerateServiceLastAccessedDetailsCommandInput, cb: (err: any, data?: GenerateServiceLastAccessedDetailsCommandOutput) => void ): void; - public generateServiceLastAccessedDetails( + generateServiceLastAccessedDetails( args: GenerateServiceLastAccessedDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateServiceLastAccessedDetailsCommandOutput) => void ): void; - public generateServiceLastAccessedDetails( - args: GenerateServiceLastAccessedDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GenerateServiceLastAccessedDetailsCommandOutput) => void), - cb?: (err: any, data?: GenerateServiceLastAccessedDetailsCommandOutput) => void - ): Promise | void { - const command = new GenerateServiceLastAccessedDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about when the specified access key was last used. The - * information includes the date and time of last use, along with the Amazon Web Services service and - * Region that were specified in the last request made with that key.

- */ - public getAccessKeyLastUsed( + + /** + * @see {@link GetAccessKeyLastUsedCommand} + */ + getAccessKeyLastUsed( args: GetAccessKeyLastUsedCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccessKeyLastUsed( + getAccessKeyLastUsed( args: GetAccessKeyLastUsedCommandInput, cb: (err: any, data?: GetAccessKeyLastUsedCommandOutput) => void ): void; - public getAccessKeyLastUsed( + getAccessKeyLastUsed( args: GetAccessKeyLastUsedCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessKeyLastUsedCommandOutput) => void ): void; - public getAccessKeyLastUsed( - args: GetAccessKeyLastUsedCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccessKeyLastUsedCommandOutput) => void), - cb?: (err: any, data?: GetAccessKeyLastUsedCommandOutput) => void - ): Promise | void { - const command = new GetAccessKeyLastUsedCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services - * account, including their relationships to one another. Use this operation to obtain a - * snapshot of the configuration of IAM permissions (users, groups, roles, and policies) - * in your account.

- * - *

Policies returned by this operation are URL-encoded compliant - * with RFC 3986. You can use a URL - * decoding method to convert the policy back to plain JSON text. For example, if you use Java, you - * can use the decode method of the java.net.URLDecoder utility class in - * the Java SDK. Other languages and SDKs provide similar functionality.

- *
- *

You can optionally filter the results using the Filter parameter. You can - * paginate the results using the MaxItems and Marker - * parameters.

- */ - public getAccountAuthorizationDetails( + + /** + * @see {@link GetAccountAuthorizationDetailsCommand} + */ + getAccountAuthorizationDetails( args: GetAccountAuthorizationDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccountAuthorizationDetails( + getAccountAuthorizationDetails( args: GetAccountAuthorizationDetailsCommandInput, cb: (err: any, data?: GetAccountAuthorizationDetailsCommandOutput) => void ): void; - public getAccountAuthorizationDetails( + getAccountAuthorizationDetails( args: GetAccountAuthorizationDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountAuthorizationDetailsCommandOutput) => void ): void; - public getAccountAuthorizationDetails( - args: GetAccountAuthorizationDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccountAuthorizationDetailsCommandOutput) => void), - cb?: (err: any, data?: GetAccountAuthorizationDetailsCommandOutput) => void - ): Promise | void { - const command = new GetAccountAuthorizationDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the password policy for the Amazon Web Services account. This tells you the complexity - * requirements and mandatory rotation periods for the IAM user passwords in your account. - * For more information about using a password policy, see Managing an IAM password - * policy.

- */ - public getAccountPasswordPolicy( + + /** + * @see {@link GetAccountPasswordPolicyCommand} + */ + getAccountPasswordPolicy( args: GetAccountPasswordPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccountPasswordPolicy( + getAccountPasswordPolicy( args: GetAccountPasswordPolicyCommandInput, cb: (err: any, data?: GetAccountPasswordPolicyCommandOutput) => void ): void; - public getAccountPasswordPolicy( + getAccountPasswordPolicy( args: GetAccountPasswordPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountPasswordPolicyCommandOutput) => void ): void; - public getAccountPasswordPolicy( - args: GetAccountPasswordPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccountPasswordPolicyCommandOutput) => void), - cb?: (err: any, data?: GetAccountPasswordPolicyCommandOutput) => void - ): Promise | void { - const command = new GetAccountPasswordPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services - * account.

- *

For information about IAM quotas, see IAM and STS quotas in the - * IAM User Guide.

- */ - public getAccountSummary( + + /** + * @see {@link GetAccountSummaryCommand} + */ + getAccountSummary( args: GetAccountSummaryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccountSummary( + getAccountSummary( args: GetAccountSummaryCommandInput, cb: (err: any, data?: GetAccountSummaryCommandOutput) => void ): void; - public getAccountSummary( + getAccountSummary( args: GetAccountSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountSummaryCommandOutput) => void ): void; - public getAccountSummary( - args: GetAccountSummaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccountSummaryCommandOutput) => void), - cb?: (err: any, data?: GetAccountSummaryCommandOutput) => void - ): Promise | void { - const command = new GetAccountSummaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of all of the context keys referenced in the input policies. The policies - * are supplied as a list of one or more strings. To get the context keys from policies - * associated with an IAM user, group, or role, use GetContextKeysForPrincipalPolicy.

- *

Context keys are variables maintained by Amazon Web Services and its services that provide details - * about the context of an API query request. Context keys can be evaluated by testing - * against a value specified in an IAM policy. Use - * GetContextKeysForCustomPolicy to understand what key names and values - * you must supply when you call SimulateCustomPolicy. Note that all - * parameters are shown in unencoded form here for clarity but must be URL encoded to be - * included as a part of a real HTML request.

- */ - public getContextKeysForCustomPolicy( + + /** + * @see {@link GetContextKeysForCustomPolicyCommand} + */ + getContextKeysForCustomPolicy( args: GetContextKeysForCustomPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getContextKeysForCustomPolicy( + getContextKeysForCustomPolicy( args: GetContextKeysForCustomPolicyCommandInput, cb: (err: any, data?: GetContextKeysForCustomPolicyCommandOutput) => void ): void; - public getContextKeysForCustomPolicy( + getContextKeysForCustomPolicy( args: GetContextKeysForCustomPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContextKeysForCustomPolicyCommandOutput) => void ): void; - public getContextKeysForCustomPolicy( - args: GetContextKeysForCustomPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContextKeysForCustomPolicyCommandOutput) => void), - cb?: (err: any, data?: GetContextKeysForCustomPolicyCommandOutput) => void - ): Promise | void { - const command = new GetContextKeysForCustomPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of all of the context keys referenced in all the IAM policies that are - * attached to the specified IAM entity. The entity can be an IAM user, group, or role. - * If you specify a user, then the request also includes all of the policies attached to - * groups that the user is a member of.

- *

You can optionally include a list of one or more additional policies, specified as - * strings. If you want to include only a list of policies by string, - * use GetContextKeysForCustomPolicy instead.

- *

- * Note: This operation discloses information about the - * permissions granted to other users. If you do not want users to see other user's - * permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.

- *

Context keys are variables maintained by Amazon Web Services and its services that provide details - * about the context of an API query request. Context keys can be evaluated by testing - * against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy.

- */ - public getContextKeysForPrincipalPolicy( + + /** + * @see {@link GetContextKeysForPrincipalPolicyCommand} + */ + getContextKeysForPrincipalPolicy( args: GetContextKeysForPrincipalPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getContextKeysForPrincipalPolicy( + getContextKeysForPrincipalPolicy( args: GetContextKeysForPrincipalPolicyCommandInput, cb: (err: any, data?: GetContextKeysForPrincipalPolicyCommandOutput) => void ): void; - public getContextKeysForPrincipalPolicy( + getContextKeysForPrincipalPolicy( args: GetContextKeysForPrincipalPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContextKeysForPrincipalPolicyCommandOutput) => void ): void; - public getContextKeysForPrincipalPolicy( - args: GetContextKeysForPrincipalPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContextKeysForPrincipalPolicyCommandOutput) => void), - cb?: (err: any, data?: GetContextKeysForPrincipalPolicyCommandOutput) => void - ): Promise | void { - const command = new GetContextKeysForPrincipalPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a credential report for the Amazon Web Services account. For more information about the - * credential report, see Getting credential reports in - * the IAM User Guide.

- */ - public getCredentialReport( + + /** + * @see {@link GetCredentialReportCommand} + */ + getCredentialReport( args: GetCredentialReportCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCredentialReport( + getCredentialReport( args: GetCredentialReportCommandInput, cb: (err: any, data?: GetCredentialReportCommandOutput) => void ): void; - public getCredentialReport( + getCredentialReport( args: GetCredentialReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCredentialReportCommandOutput) => void ): void; - public getCredentialReport( - args: GetCredentialReportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCredentialReportCommandOutput) => void), - cb?: (err: any, data?: GetCredentialReportCommandOutput) => void - ): Promise | void { - const command = new GetCredentialReportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of IAM users that are in the specified IAM group. You can paginate - * the results using the MaxItems and Marker parameters.

- */ - public getGroup(args: GetGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public getGroup(args: GetGroupCommandInput, cb: (err: any, data?: GetGroupCommandOutput) => void): void; - public getGroup( + + /** + * @see {@link GetGroupCommand} + */ + getGroup(args: GetGroupCommandInput, options?: __HttpHandlerOptions): Promise; + getGroup(args: GetGroupCommandInput, cb: (err: any, data?: GetGroupCommandOutput) => void): void; + getGroup( args: GetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupCommandOutput) => void ): void; - public getGroup( - args: GetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGroupCommandOutput) => void), - cb?: (err: any, data?: GetGroupCommandOutput) => void - ): Promise | void { - const command = new GetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the specified inline policy document that is embedded in the specified IAM - * group.

- * - *

Policies returned by this operation are URL-encoded compliant - * with RFC 3986. You can use a URL - * decoding method to convert the policy back to plain JSON text. For example, if you use Java, you - * can use the decode method of the java.net.URLDecoder utility class in - * the Java SDK. Other languages and SDKs provide similar functionality.

- *
- *

An IAM group can also have managed policies attached to it. To retrieve a managed - * policy document that is attached to a group, use GetPolicy to - * determine the policy's default version, then use GetPolicyVersion to - * retrieve the policy document.

- *

For more information about policies, see Managed policies and inline - * policies in the IAM User Guide.

- */ - public getGroupPolicy( + + /** + * @see {@link GetGroupPolicyCommand} + */ + getGroupPolicy( args: GetGroupPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getGroupPolicy( - args: GetGroupPolicyCommandInput, - cb: (err: any, data?: GetGroupPolicyCommandOutput) => void - ): void; - public getGroupPolicy( + getGroupPolicy(args: GetGroupPolicyCommandInput, cb: (err: any, data?: GetGroupPolicyCommandOutput) => void): void; + getGroupPolicy( args: GetGroupPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupPolicyCommandOutput) => void ): void; - public getGroupPolicy( - args: GetGroupPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGroupPolicyCommandOutput) => void), - cb?: (err: any, data?: GetGroupPolicyCommandOutput) => void - ): Promise | void { - const command = new GetGroupPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about the specified instance profile, including the instance - * profile's path, GUID, ARN, and role. For more information about instance profiles, see - * About - * instance profiles in the IAM User Guide.

- */ - public getInstanceProfile( + + /** + * @see {@link GetInstanceProfileCommand} + */ + getInstanceProfile( args: GetInstanceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInstanceProfile( + getInstanceProfile( args: GetInstanceProfileCommandInput, cb: (err: any, data?: GetInstanceProfileCommandOutput) => void ): void; - public getInstanceProfile( + getInstanceProfile( args: GetInstanceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInstanceProfileCommandOutput) => void ): void; - public getInstanceProfile( - args: GetInstanceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInstanceProfileCommandOutput) => void), - cb?: (err: any, data?: GetInstanceProfileCommandOutput) => void - ): Promise | void { - const command = new GetInstanceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the user name for the specified IAM user. A login profile is created when - * you create a password for the user to access the Amazon Web Services Management Console. If the user does not exist - * or does not have a password, the operation returns a 404 (NoSuchEntity) - * error.

- *

If you create an IAM user with access to the console, the CreateDate - * reflects the date you created the initial password for the user.

- *

If you create an IAM user with programmatic access, and then later add a password - * for the user to access the Amazon Web Services Management Console, the CreateDate reflects the initial - * password creation date. A user with programmatic access does not have a login profile - * unless you create a password for the user to access the Amazon Web Services Management Console.

- */ - public getLoginProfile( + + /** + * @see {@link GetLoginProfileCommand} + */ + getLoginProfile( args: GetLoginProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLoginProfile( - args: GetLoginProfileCommandInput, - cb: (err: any, data?: GetLoginProfileCommandOutput) => void - ): void; - public getLoginProfile( + getLoginProfile(args: GetLoginProfileCommandInput, cb: (err: any, data?: GetLoginProfileCommandOutput) => void): void; + getLoginProfile( args: GetLoginProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLoginProfileCommandOutput) => void ): void; - public getLoginProfile( - args: GetLoginProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLoginProfileCommandOutput) => void), - cb?: (err: any, data?: GetLoginProfileCommandOutput) => void - ): Promise | void { - const command = new GetLoginProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the specified OpenID Connect (OIDC) provider resource object - * in IAM.

- */ - public getOpenIDConnectProvider( + + /** + * @see {@link GetOpenIDConnectProviderCommand} + */ + getOpenIDConnectProvider( args: GetOpenIDConnectProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public getOpenIDConnectProvider( + getOpenIDConnectProvider( args: GetOpenIDConnectProviderCommandInput, cb: (err: any, data?: GetOpenIDConnectProviderCommandOutput) => void ): void; - public getOpenIDConnectProvider( + getOpenIDConnectProvider( args: GetOpenIDConnectProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOpenIDConnectProviderCommandOutput) => void ): void; - public getOpenIDConnectProvider( - args: GetOpenIDConnectProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOpenIDConnectProviderCommandOutput) => void), - cb?: (err: any, data?: GetOpenIDConnectProviderCommandOutput) => void - ): Promise | void { - const command = new GetOpenIDConnectProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the service last accessed data report for Organizations that was previously - * generated using the - * GenerateOrganizationsAccessReport - * - * operation. This operation retrieves the status of your report job and the report - * contents.

- *

Depending on the parameters that you passed when you generated the report, the data - * returned could include different information. For details, see GenerateOrganizationsAccessReport.

- *

To call this operation, you must be signed in to the management account in your - * organization. SCPs must be enabled for your organization root. You must have permissions - * to perform this operation. For more information, see Refining permissions using - * service last accessed data in the - * IAM User Guide.

- *

For each service that principals in an account (root user, IAM users, or IAM roles) - * could access using SCPs, the operation returns details about the most recent access - * attempt. If there was no attempt, the service is listed without details about the most - * recent attempt to access the service. If the operation fails, it returns the reason that - * it failed.

- *

By default, the list is sorted by service namespace.

- */ - public getOrganizationsAccessReport( + + /** + * @see {@link GetOrganizationsAccessReportCommand} + */ + getOrganizationsAccessReport( args: GetOrganizationsAccessReportCommandInput, options?: __HttpHandlerOptions ): Promise; - public getOrganizationsAccessReport( + getOrganizationsAccessReport( args: GetOrganizationsAccessReportCommandInput, cb: (err: any, data?: GetOrganizationsAccessReportCommandOutput) => void ): void; - public getOrganizationsAccessReport( + getOrganizationsAccessReport( args: GetOrganizationsAccessReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOrganizationsAccessReportCommandOutput) => void ): void; - public getOrganizationsAccessReport( - args: GetOrganizationsAccessReportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOrganizationsAccessReportCommandOutput) => void), - cb?: (err: any, data?: GetOrganizationsAccessReportCommandOutput) => void - ): Promise | void { - const command = new GetOrganizationsAccessReportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about the specified managed policy, including the policy's - * default version and the total number of IAM users, groups, and roles to which the - * policy is attached. To retrieve the list of the specific users, groups, and roles that - * the policy is attached to, use ListEntitiesForPolicy. This operation - * returns metadata about the policy. To retrieve the actual policy document for a specific - * version of the policy, use GetPolicyVersion.

- *

This operation retrieves information about managed policies. To retrieve information - * about an inline policy that is embedded with an IAM user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.

- *

For more information about policies, see Managed policies and inline - * policies in the IAM User Guide.

- */ - public getPolicy(args: GetPolicyCommandInput, options?: __HttpHandlerOptions): Promise; - public getPolicy(args: GetPolicyCommandInput, cb: (err: any, data?: GetPolicyCommandOutput) => void): void; - public getPolicy( + + /** + * @see {@link GetPolicyCommand} + */ + getPolicy(args: GetPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + getPolicy(args: GetPolicyCommandInput, cb: (err: any, data?: GetPolicyCommandOutput) => void): void; + getPolicy( args: GetPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPolicyCommandOutput) => void ): void; - public getPolicy( - args: GetPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPolicyCommandOutput) => void), - cb?: (err: any, data?: GetPolicyCommandOutput) => void - ): Promise | void { - const command = new GetPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about the specified version of the specified managed policy, - * including the policy document.

- * - *

Policies returned by this operation are URL-encoded compliant - * with RFC 3986. You can use a URL - * decoding method to convert the policy back to plain JSON text. For example, if you use Java, you - * can use the decode method of the java.net.URLDecoder utility class in - * the Java SDK. Other languages and SDKs provide similar functionality.

- *
- *

To list the available versions for a policy, use ListPolicyVersions.

- *

This operation retrieves information about managed policies. To retrieve information - * about an inline policy that is embedded in a user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.

- *

For more information about the types of policies, see Managed policies and inline - * policies in the IAM User Guide.

- *

For more information about managed policy versions, see Versioning for managed - * policies in the IAM User Guide.

- */ - public getPolicyVersion( + + /** + * @see {@link GetPolicyVersionCommand} + */ + getPolicyVersion( args: GetPolicyVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPolicyVersion( + getPolicyVersion( args: GetPolicyVersionCommandInput, cb: (err: any, data?: GetPolicyVersionCommandOutput) => void ): void; - public getPolicyVersion( + getPolicyVersion( args: GetPolicyVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPolicyVersionCommandOutput) => void ): void; - public getPolicyVersion( - args: GetPolicyVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPolicyVersionCommandOutput) => void), - cb?: (err: any, data?: GetPolicyVersionCommandOutput) => void - ): Promise | void { - const command = new GetPolicyVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about the specified role, including the role's path, GUID, ARN, - * and the role's trust policy that grants permission to assume the role. For more - * information about roles, see Working with roles.

- * - *

Policies returned by this operation are URL-encoded compliant - * with RFC 3986. You can use a URL - * decoding method to convert the policy back to plain JSON text. For example, if you use Java, you - * can use the decode method of the java.net.URLDecoder utility class in - * the Java SDK. Other languages and SDKs provide similar functionality.

- *
- */ - public getRole(args: GetRoleCommandInput, options?: __HttpHandlerOptions): Promise; - public getRole(args: GetRoleCommandInput, cb: (err: any, data?: GetRoleCommandOutput) => void): void; - public getRole( + + /** + * @see {@link GetRoleCommand} + */ + getRole(args: GetRoleCommandInput, options?: __HttpHandlerOptions): Promise; + getRole(args: GetRoleCommandInput, cb: (err: any, data?: GetRoleCommandOutput) => void): void; + getRole( args: GetRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRoleCommandOutput) => void ): void; - public getRole( - args: GetRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRoleCommandOutput) => void), - cb?: (err: any, data?: GetRoleCommandOutput) => void - ): Promise | void { - const command = new GetRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the specified inline policy document that is embedded with the specified - * IAM role.

- * - *

Policies returned by this operation are URL-encoded compliant - * with RFC 3986. You can use a URL - * decoding method to convert the policy back to plain JSON text. For example, if you use Java, you - * can use the decode method of the java.net.URLDecoder utility class in - * the Java SDK. Other languages and SDKs provide similar functionality.

- *
- *

An IAM role can also have managed policies attached to it. To retrieve a managed - * policy document that is attached to a role, use GetPolicy to determine - * the policy's default version, then use GetPolicyVersion to retrieve - * the policy document.

- *

For more information about policies, see Managed policies and inline - * policies in the IAM User Guide.

- *

For more information about roles, see Using roles to delegate permissions and - * federate identities.

- */ - public getRolePolicy( - args: GetRolePolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getRolePolicy( - args: GetRolePolicyCommandInput, - cb: (err: any, data?: GetRolePolicyCommandOutput) => void - ): void; - public getRolePolicy( + + /** + * @see {@link GetRolePolicyCommand} + */ + getRolePolicy(args: GetRolePolicyCommandInput, options?: __HttpHandlerOptions): Promise; + getRolePolicy(args: GetRolePolicyCommandInput, cb: (err: any, data?: GetRolePolicyCommandOutput) => void): void; + getRolePolicy( args: GetRolePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRolePolicyCommandOutput) => void ): void; - public getRolePolicy( - args: GetRolePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRolePolicyCommandOutput) => void), - cb?: (err: any, data?: GetRolePolicyCommandOutput) => void - ): Promise | void { - const command = new GetRolePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the SAML provider metadocument that was uploaded when the IAM SAML provider - * resource object was created or updated.

- * - *

This operation requires Signature Version 4.

- *
- */ - public getSAMLProvider( + + /** + * @see {@link GetSAMLProviderCommand} + */ + getSAMLProvider( args: GetSAMLProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSAMLProvider( - args: GetSAMLProviderCommandInput, - cb: (err: any, data?: GetSAMLProviderCommandOutput) => void - ): void; - public getSAMLProvider( + getSAMLProvider(args: GetSAMLProviderCommandInput, cb: (err: any, data?: GetSAMLProviderCommandOutput) => void): void; + getSAMLProvider( args: GetSAMLProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSAMLProviderCommandOutput) => void ): void; - public getSAMLProvider( - args: GetSAMLProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSAMLProviderCommandOutput) => void), - cb?: (err: any, data?: GetSAMLProviderCommandOutput) => void - ): Promise | void { - const command = new GetSAMLProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about the specified server certificate stored in IAM.

- *

For more information about working with server certificates, see Working - * with server certificates in the IAM User Guide. This - * topic includes a list of Amazon Web Services services that can use the server certificates that you - * manage with IAM.

- */ - public getServerCertificate( + + /** + * @see {@link GetServerCertificateCommand} + */ + getServerCertificate( args: GetServerCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServerCertificate( + getServerCertificate( args: GetServerCertificateCommandInput, cb: (err: any, data?: GetServerCertificateCommandOutput) => void ): void; - public getServerCertificate( + getServerCertificate( args: GetServerCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServerCertificateCommandOutput) => void ): void; - public getServerCertificate( - args: GetServerCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServerCertificateCommandOutput) => void), - cb?: (err: any, data?: GetServerCertificateCommandOutput) => void - ): Promise | void { - const command = new GetServerCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a service last accessed report that was created using the - * GenerateServiceLastAccessedDetails operation. You can use the - * JobId parameter in GetServiceLastAccessedDetails to - * retrieve the status of your report job. When the report is complete, you can retrieve - * the generated report. The report includes a list of Amazon Web Services services that the resource - * (user, group, role, or managed policy) can access.

- * - *

Service last accessed data does not use other policy types when determining - * whether a resource could access a service. These other policy types include - * resource-based policies, access control lists, Organizations policies, IAM permissions - * boundaries, and STS assume role policies. It only applies permissions policy - * logic. For more about the evaluation of policy types, see Evaluating policies in the - * IAM User Guide.

- *
- *

For each service that the resource could access using permissions policies, the - * operation returns details about the most recent access attempt. If there was no attempt, - * the service is listed without details about the most recent attempt to access the - * service. If the operation fails, the GetServiceLastAccessedDetails - * operation returns the reason that it failed.

- *

The GetServiceLastAccessedDetails operation returns a list of services. - * This list includes the number of entities that have attempted to access the service and - * the date and time of the last attempt. It also returns the ARN of the following entity, - * depending on the resource ARN that you used to generate the report:

- *
    - *
  • - *

    - * User – Returns the user ARN that you - * used to generate the report

    - *
  • - *
  • - *

    - * Group – Returns the ARN of the group - * member (user) that last attempted to access the service

    - *
  • - *
  • - *

    - * Role – Returns the role ARN that you - * used to generate the report

    - *
  • - *
  • - *

    - * Policy – Returns the ARN of the user - * or role that last used the policy to attempt to access the service

    - *
  • - *
- *

By default, the list is sorted by service namespace.

- *

If you specified ACTION_LEVEL granularity when you generated the report, - * this operation returns service and action last accessed data. This includes the most - * recent access attempt for each tracked action within a service. Otherwise, this - * operation returns only service data.

- *

For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the - * IAM User Guide.

- */ - public getServiceLastAccessedDetails( + + /** + * @see {@link GetServiceLastAccessedDetailsCommand} + */ + getServiceLastAccessedDetails( args: GetServiceLastAccessedDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServiceLastAccessedDetails( + getServiceLastAccessedDetails( args: GetServiceLastAccessedDetailsCommandInput, cb: (err: any, data?: GetServiceLastAccessedDetailsCommandOutput) => void ): void; - public getServiceLastAccessedDetails( + getServiceLastAccessedDetails( args: GetServiceLastAccessedDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceLastAccessedDetailsCommandOutput) => void ): void; - public getServiceLastAccessedDetails( - args: GetServiceLastAccessedDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceLastAccessedDetailsCommandOutput) => void), - cb?: (err: any, data?: GetServiceLastAccessedDetailsCommandOutput) => void - ): Promise | void { - const command = new GetServiceLastAccessedDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

After you generate a group or policy report using the - * GenerateServiceLastAccessedDetails operation, you can use the - * JobId parameter in - * GetServiceLastAccessedDetailsWithEntities. This operation retrieves the - * status of your report job and a list of entities that could have used group or policy - * permissions to access the specified service.

- *
    - *
  • - *

    - * Group – For a group report, this - * operation returns a list of users in the group that could have used the group’s - * policies in an attempt to access the service.

    - *
  • - *
  • - *

    - * Policy – For a policy report, this - * operation returns a list of entities (users or roles) that could have used the - * policy in an attempt to access the service.

    - *
  • - *
- *

You can also use this operation for user or role reports to retrieve details about - * those entities.

- *

If the operation fails, the GetServiceLastAccessedDetailsWithEntities - * operation returns the reason that it failed.

- *

By default, the list of associated entities is sorted by date, with the most recent - * access listed first.

- */ - public getServiceLastAccessedDetailsWithEntities( + + /** + * @see {@link GetServiceLastAccessedDetailsWithEntitiesCommand} + */ + getServiceLastAccessedDetailsWithEntities( args: GetServiceLastAccessedDetailsWithEntitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServiceLastAccessedDetailsWithEntities( + getServiceLastAccessedDetailsWithEntities( args: GetServiceLastAccessedDetailsWithEntitiesCommandInput, cb: (err: any, data?: GetServiceLastAccessedDetailsWithEntitiesCommandOutput) => void ): void; - public getServiceLastAccessedDetailsWithEntities( + getServiceLastAccessedDetailsWithEntities( args: GetServiceLastAccessedDetailsWithEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceLastAccessedDetailsWithEntitiesCommandOutput) => void ): void; - public getServiceLastAccessedDetailsWithEntities( - args: GetServiceLastAccessedDetailsWithEntitiesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetServiceLastAccessedDetailsWithEntitiesCommandOutput) => void), - cb?: (err: any, data?: GetServiceLastAccessedDetailsWithEntitiesCommandOutput) => void - ): Promise | void { - const command = new GetServiceLastAccessedDetailsWithEntitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the status of your service-linked role deletion. After you use DeleteServiceLinkedRole to submit a service-linked role for deletion, - * you can use the DeletionTaskId parameter in - * GetServiceLinkedRoleDeletionStatus to check the status of the deletion. - * If the deletion fails, this operation returns the reason that it failed, if that - * information is returned by the service.

- */ - public getServiceLinkedRoleDeletionStatus( + + /** + * @see {@link GetServiceLinkedRoleDeletionStatusCommand} + */ + getServiceLinkedRoleDeletionStatus( args: GetServiceLinkedRoleDeletionStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServiceLinkedRoleDeletionStatus( + getServiceLinkedRoleDeletionStatus( args: GetServiceLinkedRoleDeletionStatusCommandInput, cb: (err: any, data?: GetServiceLinkedRoleDeletionStatusCommandOutput) => void ): void; - public getServiceLinkedRoleDeletionStatus( + getServiceLinkedRoleDeletionStatus( args: GetServiceLinkedRoleDeletionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceLinkedRoleDeletionStatusCommandOutput) => void ): void; - public getServiceLinkedRoleDeletionStatus( - args: GetServiceLinkedRoleDeletionStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceLinkedRoleDeletionStatusCommandOutput) => void), - cb?: (err: any, data?: GetServiceLinkedRoleDeletionStatusCommandOutput) => void - ): Promise | void { - const command = new GetServiceLinkedRoleDeletionStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the specified SSH public key, including metadata about the key.

- *

The SSH public key retrieved by this operation is used only for authenticating the - * associated IAM user to an CodeCommit repository. For more information about using SSH keys - * to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH - * connections in the CodeCommit User Guide.

- */ - public getSSHPublicKey( + + /** + * @see {@link GetSSHPublicKeyCommand} + */ + getSSHPublicKey( args: GetSSHPublicKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSSHPublicKey( - args: GetSSHPublicKeyCommandInput, - cb: (err: any, data?: GetSSHPublicKeyCommandOutput) => void - ): void; - public getSSHPublicKey( + getSSHPublicKey(args: GetSSHPublicKeyCommandInput, cb: (err: any, data?: GetSSHPublicKeyCommandOutput) => void): void; + getSSHPublicKey( args: GetSSHPublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSSHPublicKeyCommandOutput) => void ): void; - public getSSHPublicKey( - args: GetSSHPublicKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSSHPublicKeyCommandOutput) => void), - cb?: (err: any, data?: GetSSHPublicKeyCommandOutput) => void - ): Promise | void { - const command = new GetSSHPublicKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about the specified IAM user, including the user's creation - * date, path, unique ID, and ARN.

- *

If you do not specify a user name, IAM determines the user name implicitly based on - * the Amazon Web Services access key ID used to sign the request to this operation.

- */ - public getUser(args: GetUserCommandInput, options?: __HttpHandlerOptions): Promise; - public getUser(args: GetUserCommandInput, cb: (err: any, data?: GetUserCommandOutput) => void): void; - public getUser( + + /** + * @see {@link GetUserCommand} + */ + getUser(args: GetUserCommandInput, options?: __HttpHandlerOptions): Promise; + getUser(args: GetUserCommandInput, cb: (err: any, data?: GetUserCommandOutput) => void): void; + getUser( args: GetUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserCommandOutput) => void ): void; - public getUser( - args: GetUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUserCommandOutput) => void), - cb?: (err: any, data?: GetUserCommandOutput) => void - ): Promise | void { - const command = new GetUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the specified inline policy document that is embedded in the specified IAM - * user.

- * - *

Policies returned by this operation are URL-encoded compliant - * with RFC 3986. You can use a URL - * decoding method to convert the policy back to plain JSON text. For example, if you use Java, you - * can use the decode method of the java.net.URLDecoder utility class in - * the Java SDK. Other languages and SDKs provide similar functionality.

- *
- *

An IAM user can also have managed policies attached to it. To retrieve a managed - * policy document that is attached to a user, use GetPolicy to determine - * the policy's default version. Then use GetPolicyVersion to retrieve - * the policy document.

- *

For more information about policies, see Managed policies and inline - * policies in the IAM User Guide.

- */ - public getUserPolicy( - args: GetUserPolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getUserPolicy( - args: GetUserPolicyCommandInput, - cb: (err: any, data?: GetUserPolicyCommandOutput) => void - ): void; - public getUserPolicy( + + /** + * @see {@link GetUserPolicyCommand} + */ + getUserPolicy(args: GetUserPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + getUserPolicy(args: GetUserPolicyCommandInput, cb: (err: any, data?: GetUserPolicyCommandOutput) => void): void; + getUserPolicy( args: GetUserPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserPolicyCommandOutput) => void ): void; - public getUserPolicy( - args: GetUserPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUserPolicyCommandOutput) => void), - cb?: (err: any, data?: GetUserPolicyCommandOutput) => void - ): Promise | void { - const command = new GetUserPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the access key IDs associated with the specified IAM user. - * If there is none, the operation returns an empty list.

- *

Although each user is limited to a small number of keys, you can still paginate the - * results using the MaxItems and Marker parameters.

- *

If the UserName is not specified, the user name is determined implicitly - * based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is - * used, then UserName is required. If a long-term key is assigned to the - * user, then UserName is not required. This operation works for access keys - * under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user - * credentials even if the Amazon Web Services account has no associated users.

- * - *

To ensure the security of your Amazon Web Services account, the secret access key is accessible - * only during key and user creation.

- *
- */ - public listAccessKeys( + + /** + * @see {@link ListAccessKeysCommand} + */ + listAccessKeys( args: ListAccessKeysCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAccessKeys( - args: ListAccessKeysCommandInput, - cb: (err: any, data?: ListAccessKeysCommandOutput) => void - ): void; - public listAccessKeys( + listAccessKeys(args: ListAccessKeysCommandInput, cb: (err: any, data?: ListAccessKeysCommandOutput) => void): void; + listAccessKeys( args: ListAccessKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessKeysCommandOutput) => void ): void; - public listAccessKeys( - args: ListAccessKeysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccessKeysCommandOutput) => void), - cb?: (err: any, data?: ListAccessKeysCommandOutput) => void - ): Promise | void { - const command = new ListAccessKeysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the account alias associated with the Amazon Web Services account (Note: you can have only - * one). For information about using an Amazon Web Services account alias, see Using an alias for your - * Amazon Web Services account ID in the IAM User Guide.

- */ - public listAccountAliases( + + /** + * @see {@link ListAccountAliasesCommand} + */ + listAccountAliases( args: ListAccountAliasesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAccountAliases( + listAccountAliases( args: ListAccountAliasesCommandInput, cb: (err: any, data?: ListAccountAliasesCommandOutput) => void ): void; - public listAccountAliases( + listAccountAliases( args: ListAccountAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccountAliasesCommandOutput) => void ): void; - public listAccountAliases( - args: ListAccountAliasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccountAliasesCommandOutput) => void), - cb?: (err: any, data?: ListAccountAliasesCommandOutput) => void - ): Promise | void { - const command = new ListAccountAliasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all managed policies that are attached to the specified IAM group.

- *

An IAM group can also have inline policies embedded with it. To list the inline - * policies for a group, use ListGroupPolicies. For information about - * policies, see Managed policies and inline - * policies in the IAM User Guide.

- *

You can paginate the results using the MaxItems and Marker - * parameters. You can use the PathPrefix parameter to limit the list of - * policies to only those matching the specified path prefix. If there are no policies - * attached to the specified group (or none that match the specified path prefix), the - * operation returns an empty list.

- */ - public listAttachedGroupPolicies( + + /** + * @see {@link ListAttachedGroupPoliciesCommand} + */ + listAttachedGroupPolicies( args: ListAttachedGroupPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAttachedGroupPolicies( + listAttachedGroupPolicies( args: ListAttachedGroupPoliciesCommandInput, cb: (err: any, data?: ListAttachedGroupPoliciesCommandOutput) => void ): void; - public listAttachedGroupPolicies( + listAttachedGroupPolicies( args: ListAttachedGroupPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAttachedGroupPoliciesCommandOutput) => void ): void; - public listAttachedGroupPolicies( - args: ListAttachedGroupPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAttachedGroupPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListAttachedGroupPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListAttachedGroupPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all managed policies that are attached to the specified IAM role.

- *

An IAM role can also have inline policies embedded with it. To list the inline - * policies for a role, use ListRolePolicies. For information about - * policies, see Managed policies and inline - * policies in the IAM User Guide.

- *

You can paginate the results using the MaxItems and Marker - * parameters. You can use the PathPrefix parameter to limit the list of - * policies to only those matching the specified path prefix. If there are no policies - * attached to the specified role (or none that match the specified path prefix), the - * operation returns an empty list.

- */ - public listAttachedRolePolicies( + + /** + * @see {@link ListAttachedRolePoliciesCommand} + */ + listAttachedRolePolicies( args: ListAttachedRolePoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAttachedRolePolicies( + listAttachedRolePolicies( args: ListAttachedRolePoliciesCommandInput, cb: (err: any, data?: ListAttachedRolePoliciesCommandOutput) => void ): void; - public listAttachedRolePolicies( + listAttachedRolePolicies( args: ListAttachedRolePoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAttachedRolePoliciesCommandOutput) => void ): void; - public listAttachedRolePolicies( - args: ListAttachedRolePoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAttachedRolePoliciesCommandOutput) => void), - cb?: (err: any, data?: ListAttachedRolePoliciesCommandOutput) => void - ): Promise | void { - const command = new ListAttachedRolePoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all managed policies that are attached to the specified IAM user.

- *

An IAM user can also have inline policies embedded with it. To list the inline - * policies for a user, use ListUserPolicies. For information about - * policies, see Managed policies and inline - * policies in the IAM User Guide.

- *

You can paginate the results using the MaxItems and Marker - * parameters. You can use the PathPrefix parameter to limit the list of - * policies to only those matching the specified path prefix. If there are no policies - * attached to the specified group (or none that match the specified path prefix), the - * operation returns an empty list.

- */ - public listAttachedUserPolicies( + + /** + * @see {@link ListAttachedUserPoliciesCommand} + */ + listAttachedUserPolicies( args: ListAttachedUserPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAttachedUserPolicies( + listAttachedUserPolicies( args: ListAttachedUserPoliciesCommandInput, cb: (err: any, data?: ListAttachedUserPoliciesCommandOutput) => void ): void; - public listAttachedUserPolicies( + listAttachedUserPolicies( args: ListAttachedUserPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAttachedUserPoliciesCommandOutput) => void ): void; - public listAttachedUserPolicies( - args: ListAttachedUserPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAttachedUserPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListAttachedUserPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListAttachedUserPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all IAM users, groups, and roles that the specified managed policy is attached - * to.

- *

You can use the optional EntityFilter parameter to limit the results to a - * particular type of entity (users, groups, or roles). For example, to list only the roles - * that are attached to the specified policy, set EntityFilter to - * Role.

- *

You can paginate the results using the MaxItems and Marker - * parameters.

- */ - public listEntitiesForPolicy( + + /** + * @see {@link ListEntitiesForPolicyCommand} + */ + listEntitiesForPolicy( args: ListEntitiesForPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEntitiesForPolicy( + listEntitiesForPolicy( args: ListEntitiesForPolicyCommandInput, cb: (err: any, data?: ListEntitiesForPolicyCommandOutput) => void ): void; - public listEntitiesForPolicy( + listEntitiesForPolicy( args: ListEntitiesForPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEntitiesForPolicyCommandOutput) => void ): void; - public listEntitiesForPolicy( - args: ListEntitiesForPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEntitiesForPolicyCommandOutput) => void), - cb?: (err: any, data?: ListEntitiesForPolicyCommandOutput) => void - ): Promise | void { - const command = new ListEntitiesForPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the names of the inline policies that are embedded in the specified IAM - * group.

- *

An IAM group can also have managed policies attached to it. To list the managed - * policies that are attached to a group, use ListAttachedGroupPolicies. - * For more information about policies, see Managed policies and inline - * policies in the IAM User Guide.

- *

You can paginate the results using the MaxItems and Marker - * parameters. If there are no inline policies embedded with the specified group, the - * operation returns an empty list.

- */ - public listGroupPolicies( + + /** + * @see {@link ListGroupPoliciesCommand} + */ + listGroupPolicies( args: ListGroupPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGroupPolicies( + listGroupPolicies( args: ListGroupPoliciesCommandInput, cb: (err: any, data?: ListGroupPoliciesCommandOutput) => void ): void; - public listGroupPolicies( + listGroupPolicies( args: ListGroupPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupPoliciesCommandOutput) => void ): void; - public listGroupPolicies( - args: ListGroupPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGroupPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListGroupPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListGroupPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the IAM groups that have the specified path prefix.

- *

You can paginate the results using the MaxItems and Marker - * parameters.

- */ - public listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise; - public listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void; - public listGroups( + + /** + * @see {@link ListGroupsCommand} + */ + listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise; + listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void; + listGroups( args: ListGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsCommandOutput) => void ): void; - public listGroups( - args: ListGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGroupsCommandOutput) => void), - cb?: (err: any, data?: ListGroupsCommandOutput) => void - ): Promise | void { - const command = new ListGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the IAM groups that the specified IAM user belongs to.

- *

You can paginate the results using the MaxItems and Marker - * parameters.

- */ - public listGroupsForUser( + + /** + * @see {@link ListGroupsForUserCommand} + */ + listGroupsForUser( args: ListGroupsForUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGroupsForUser( + listGroupsForUser( args: ListGroupsForUserCommandInput, cb: (err: any, data?: ListGroupsForUserCommandOutput) => void ): void; - public listGroupsForUser( + listGroupsForUser( args: ListGroupsForUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsForUserCommandOutput) => void ): void; - public listGroupsForUser( - args: ListGroupsForUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGroupsForUserCommandOutput) => void), - cb?: (err: any, data?: ListGroupsForUserCommandOutput) => void - ): Promise | void { - const command = new ListGroupsForUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the instance profiles that have the specified path prefix. If there are none, - * the operation returns an empty list. For more information about instance profiles, see - * About - * instance profiles.

- * - *

IAM resource-listing operations return a subset of the available - * attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an instance profile, see GetInstanceProfile.

- *
- *

You can paginate the results using the MaxItems and Marker - * parameters.

- */ - public listInstanceProfiles( + + /** + * @see {@link ListInstanceProfilesCommand} + */ + listInstanceProfiles( args: ListInstanceProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInstanceProfiles( + listInstanceProfiles( args: ListInstanceProfilesCommandInput, cb: (err: any, data?: ListInstanceProfilesCommandOutput) => void ): void; - public listInstanceProfiles( + listInstanceProfiles( args: ListInstanceProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInstanceProfilesCommandOutput) => void ): void; - public listInstanceProfiles( - args: ListInstanceProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInstanceProfilesCommandOutput) => void), - cb?: (err: any, data?: ListInstanceProfilesCommandOutput) => void - ): Promise | void { - const command = new ListInstanceProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the instance profiles that have the specified associated IAM role. If there - * are none, the operation returns an empty list. For more information about instance - * profiles, go to About instance - * profiles.

- *

You can paginate the results using the MaxItems and Marker - * parameters.

- */ - public listInstanceProfilesForRole( + + /** + * @see {@link ListInstanceProfilesForRoleCommand} + */ + listInstanceProfilesForRole( args: ListInstanceProfilesForRoleCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInstanceProfilesForRole( + listInstanceProfilesForRole( args: ListInstanceProfilesForRoleCommandInput, cb: (err: any, data?: ListInstanceProfilesForRoleCommandOutput) => void ): void; - public listInstanceProfilesForRole( + listInstanceProfilesForRole( args: ListInstanceProfilesForRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInstanceProfilesForRoleCommandOutput) => void ): void; - public listInstanceProfilesForRole( - args: ListInstanceProfilesForRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInstanceProfilesForRoleCommandOutput) => void), - cb?: (err: any, data?: ListInstanceProfilesForRoleCommandOutput) => void - ): Promise | void { - const command = new ListInstanceProfilesForRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the tags that are attached to the specified IAM instance profile. The returned list of tags is sorted by tag key. - * For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

- */ - public listInstanceProfileTags( + + /** + * @see {@link ListInstanceProfileTagsCommand} + */ + listInstanceProfileTags( args: ListInstanceProfileTagsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInstanceProfileTags( + listInstanceProfileTags( args: ListInstanceProfileTagsCommandInput, cb: (err: any, data?: ListInstanceProfileTagsCommandOutput) => void ): void; - public listInstanceProfileTags( + listInstanceProfileTags( args: ListInstanceProfileTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInstanceProfileTagsCommandOutput) => void ): void; - public listInstanceProfileTags( - args: ListInstanceProfileTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInstanceProfileTagsCommandOutput) => void), - cb?: (err: any, data?: ListInstanceProfileTagsCommandOutput) => void - ): Promise | void { - const command = new ListInstanceProfileTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the MFA devices for an IAM user. If the request includes a IAM user name, - * then this operation lists all the MFA devices associated with the specified user. If you - * do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services - * access key ID signing the request for this operation.

- *

You can paginate the results using the MaxItems and Marker - * parameters.

- */ - public listMFADevices( + + /** + * @see {@link ListMFADevicesCommand} + */ + listMFADevices( args: ListMFADevicesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMFADevices( - args: ListMFADevicesCommandInput, - cb: (err: any, data?: ListMFADevicesCommandOutput) => void - ): void; - public listMFADevices( + listMFADevices(args: ListMFADevicesCommandInput, cb: (err: any, data?: ListMFADevicesCommandOutput) => void): void; + listMFADevices( args: ListMFADevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMFADevicesCommandOutput) => void ): void; - public listMFADevices( - args: ListMFADevicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMFADevicesCommandOutput) => void), - cb?: (err: any, data?: ListMFADevicesCommandOutput) => void - ): Promise | void { - const command = new ListMFADevicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device. The returned list of tags is - * sorted by tag key. For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

- */ - public listMFADeviceTags( + + /** + * @see {@link ListMFADeviceTagsCommand} + */ + listMFADeviceTags( args: ListMFADeviceTagsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMFADeviceTags( + listMFADeviceTags( args: ListMFADeviceTagsCommandInput, cb: (err: any, data?: ListMFADeviceTagsCommandOutput) => void ): void; - public listMFADeviceTags( + listMFADeviceTags( args: ListMFADeviceTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMFADeviceTagsCommandOutput) => void ): void; - public listMFADeviceTags( - args: ListMFADeviceTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMFADeviceTagsCommandOutput) => void), - cb?: (err: any, data?: ListMFADeviceTagsCommandOutput) => void - ): Promise | void { - const command = new ListMFADeviceTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists information about the IAM OpenID Connect (OIDC) provider resource objects - * defined in the Amazon Web Services account.

- * - *

IAM resource-listing operations return a subset of the available - * attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an OIDC provider, see GetOpenIDConnectProvider.

- *
- */ - public listOpenIDConnectProviders( + + /** + * @see {@link ListOpenIDConnectProvidersCommand} + */ + listOpenIDConnectProviders( args: ListOpenIDConnectProvidersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOpenIDConnectProviders( + listOpenIDConnectProviders( args: ListOpenIDConnectProvidersCommandInput, cb: (err: any, data?: ListOpenIDConnectProvidersCommandOutput) => void ): void; - public listOpenIDConnectProviders( + listOpenIDConnectProviders( args: ListOpenIDConnectProvidersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOpenIDConnectProvidersCommandOutput) => void ): void; - public listOpenIDConnectProviders( - args: ListOpenIDConnectProvidersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOpenIDConnectProvidersCommandOutput) => void), - cb?: (err: any, data?: ListOpenIDConnectProvidersCommandOutput) => void - ): Promise | void { - const command = new ListOpenIDConnectProvidersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible - * identity provider. The returned list of tags is sorted by tag key. For more information, see About web identity - * federation.

- *

For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

- */ - public listOpenIDConnectProviderTags( + + /** + * @see {@link ListOpenIDConnectProviderTagsCommand} + */ + listOpenIDConnectProviderTags( args: ListOpenIDConnectProviderTagsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOpenIDConnectProviderTags( + listOpenIDConnectProviderTags( args: ListOpenIDConnectProviderTagsCommandInput, cb: (err: any, data?: ListOpenIDConnectProviderTagsCommandOutput) => void ): void; - public listOpenIDConnectProviderTags( + listOpenIDConnectProviderTags( args: ListOpenIDConnectProviderTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOpenIDConnectProviderTagsCommandOutput) => void ): void; - public listOpenIDConnectProviderTags( - args: ListOpenIDConnectProviderTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOpenIDConnectProviderTagsCommandOutput) => void), - cb?: (err: any, data?: ListOpenIDConnectProviderTagsCommandOutput) => void - ): Promise | void { - const command = new ListOpenIDConnectProviderTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all the managed policies that are available in your Amazon Web Services account, including - * your own customer-defined managed policies and all Amazon Web Services managed policies.

- *

You can filter the list of policies that is returned using the optional - * OnlyAttached, Scope, and PathPrefix - * parameters. For example, to list only the customer managed policies in your Amazon Web Services - * account, set Scope to Local. To list only Amazon Web Services managed - * policies, set Scope to AWS.

- *

You can paginate the results using the MaxItems and Marker - * parameters.

- *

For more information about managed policies, see Managed policies and inline - * policies in the IAM User Guide.

- * - *

IAM resource-listing operations return a subset of the available - * attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a customer manged policy, see - * GetPolicy.

- *
- */ - public listPolicies( - args: ListPoliciesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listPolicies(args: ListPoliciesCommandInput, cb: (err: any, data?: ListPoliciesCommandOutput) => void): void; - public listPolicies( + + /** + * @see {@link ListPoliciesCommand} + */ + listPolicies(args: ListPoliciesCommandInput, options?: __HttpHandlerOptions): Promise; + listPolicies(args: ListPoliciesCommandInput, cb: (err: any, data?: ListPoliciesCommandOutput) => void): void; + listPolicies( args: ListPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPoliciesCommandOutput) => void ): void; - public listPolicies( - args: ListPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of policies that the IAM identity (user, group, or role) can use to - * access each specified service.

- * - *

This operation does not use other policy types when determining whether a resource - * could access a service. These other policy types include resource-based policies, - * access control lists, Organizations policies, IAM permissions boundaries, and STS - * assume role policies. It only applies permissions policy logic. For more about the - * evaluation of policy types, see Evaluating policies in the - * IAM User Guide.

- *
- *

The list of policies returned by the operation depends on the ARN of the identity that - * you provide.

- *
    - *
  • - *

    - * User – The list of policies includes - * the managed and inline policies that are attached to the user directly. The list - * also includes any additional managed and inline policies that are attached to - * the group to which the user belongs.

    - *
  • - *
  • - *

    - * Group – The list of policies includes - * only the managed and inline policies that are attached to the group directly. - * Policies that are attached to the group’s user are not included.

    - *
  • - *
  • - *

    - * Role – The list of policies includes - * only the managed and inline policies that are attached to the role.

    - *
  • - *
- *

For each managed policy, this operation returns the ARN and policy name. For each - * inline policy, it returns the policy name and the entity to which it is attached. Inline - * policies do not have an ARN. For more information about these policy types, see Managed policies and inline policies in the - * IAM User Guide.

- *

Policies that are attached to users and roles as permissions boundaries are not - * returned. To view which managed policy is currently used to set the permissions boundary - * for a user or role, use the GetUser or GetRole - * operations.

- */ - public listPoliciesGrantingServiceAccess( + + /** + * @see {@link ListPoliciesGrantingServiceAccessCommand} + */ + listPoliciesGrantingServiceAccess( args: ListPoliciesGrantingServiceAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPoliciesGrantingServiceAccess( + listPoliciesGrantingServiceAccess( args: ListPoliciesGrantingServiceAccessCommandInput, cb: (err: any, data?: ListPoliciesGrantingServiceAccessCommandOutput) => void ): void; - public listPoliciesGrantingServiceAccess( + listPoliciesGrantingServiceAccess( args: ListPoliciesGrantingServiceAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPoliciesGrantingServiceAccessCommandOutput) => void ): void; - public listPoliciesGrantingServiceAccess( - args: ListPoliciesGrantingServiceAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPoliciesGrantingServiceAccessCommandOutput) => void), - cb?: (err: any, data?: ListPoliciesGrantingServiceAccessCommandOutput) => void - ): Promise | void { - const command = new ListPoliciesGrantingServiceAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the tags that are attached to the specified IAM customer managed policy. - * The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

- */ - public listPolicyTags( + + /** + * @see {@link ListPolicyTagsCommand} + */ + listPolicyTags( args: ListPolicyTagsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPolicyTags( - args: ListPolicyTagsCommandInput, - cb: (err: any, data?: ListPolicyTagsCommandOutput) => void - ): void; - public listPolicyTags( + listPolicyTags(args: ListPolicyTagsCommandInput, cb: (err: any, data?: ListPolicyTagsCommandOutput) => void): void; + listPolicyTags( args: ListPolicyTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPolicyTagsCommandOutput) => void ): void; - public listPolicyTags( - args: ListPolicyTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPolicyTagsCommandOutput) => void), - cb?: (err: any, data?: ListPolicyTagsCommandOutput) => void - ): Promise | void { - const command = new ListPolicyTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists information about the versions of the specified managed policy, including the - * version that is currently set as the policy's default version.

- *

For more information about managed policies, see Managed policies and inline - * policies in the IAM User Guide.

- */ - public listPolicyVersions( + + /** + * @see {@link ListPolicyVersionsCommand} + */ + listPolicyVersions( args: ListPolicyVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPolicyVersions( + listPolicyVersions( args: ListPolicyVersionsCommandInput, cb: (err: any, data?: ListPolicyVersionsCommandOutput) => void ): void; - public listPolicyVersions( + listPolicyVersions( args: ListPolicyVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPolicyVersionsCommandOutput) => void ): void; - public listPolicyVersions( - args: ListPolicyVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPolicyVersionsCommandOutput) => void), - cb?: (err: any, data?: ListPolicyVersionsCommandOutput) => void - ): Promise | void { - const command = new ListPolicyVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the names of the inline policies that are embedded in the specified IAM - * role.

- *

An IAM role can also have managed policies attached to it. To list the managed - * policies that are attached to a role, use ListAttachedRolePolicies. - * For more information about policies, see Managed policies and inline - * policies in the IAM User Guide.

- *

You can paginate the results using the MaxItems and Marker - * parameters. If there are no inline policies embedded with the specified role, the - * operation returns an empty list.

- */ - public listRolePolicies( + + /** + * @see {@link ListRolePoliciesCommand} + */ + listRolePolicies( args: ListRolePoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRolePolicies( + listRolePolicies( args: ListRolePoliciesCommandInput, cb: (err: any, data?: ListRolePoliciesCommandOutput) => void ): void; - public listRolePolicies( + listRolePolicies( args: ListRolePoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRolePoliciesCommandOutput) => void ): void; - public listRolePolicies( - args: ListRolePoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRolePoliciesCommandOutput) => void), - cb?: (err: any, data?: ListRolePoliciesCommandOutput) => void - ): Promise | void { - const command = new ListRolePoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the IAM roles that have the specified path prefix. If there are none, the - * operation returns an empty list. For more information about roles, see Working with - * roles.

- * - *

IAM resource-listing operations return a subset of the available - * attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a role, see GetRole.

- *
- *

You can paginate the results using the MaxItems and Marker - * parameters.

- */ - public listRoles(args: ListRolesCommandInput, options?: __HttpHandlerOptions): Promise; - public listRoles(args: ListRolesCommandInput, cb: (err: any, data?: ListRolesCommandOutput) => void): void; - public listRoles( + + /** + * @see {@link ListRolesCommand} + */ + listRoles(args: ListRolesCommandInput, options?: __HttpHandlerOptions): Promise; + listRoles(args: ListRolesCommandInput, cb: (err: any, data?: ListRolesCommandOutput) => void): void; + listRoles( args: ListRolesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRolesCommandOutput) => void ): void; - public listRoles( - args: ListRolesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRolesCommandOutput) => void), - cb?: (err: any, data?: ListRolesCommandOutput) => void - ): Promise | void { - const command = new ListRolesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the tags that are attached to the specified role. The returned list of tags is - * sorted by tag key. For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

- */ - public listRoleTags( - args: ListRoleTagsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listRoleTags(args: ListRoleTagsCommandInput, cb: (err: any, data?: ListRoleTagsCommandOutput) => void): void; - public listRoleTags( + + /** + * @see {@link ListRoleTagsCommand} + */ + listRoleTags(args: ListRoleTagsCommandInput, options?: __HttpHandlerOptions): Promise; + listRoleTags(args: ListRoleTagsCommandInput, cb: (err: any, data?: ListRoleTagsCommandOutput) => void): void; + listRoleTags( args: ListRoleTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRoleTagsCommandOutput) => void ): void; - public listRoleTags( - args: ListRoleTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRoleTagsCommandOutput) => void), - cb?: (err: any, data?: ListRoleTagsCommandOutput) => void - ): Promise | void { - const command = new ListRoleTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the SAML provider resource objects defined in IAM in the account. - * IAM resource-listing operations return a subset of the available - * attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a SAML provider, see GetSAMLProvider.

- * - *

This operation requires Signature Version 4.

- *
- */ - public listSAMLProviders( + + /** + * @see {@link ListSAMLProvidersCommand} + */ + listSAMLProviders( args: ListSAMLProvidersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSAMLProviders( + listSAMLProviders( args: ListSAMLProvidersCommandInput, cb: (err: any, data?: ListSAMLProvidersCommandOutput) => void ): void; - public listSAMLProviders( + listSAMLProviders( args: ListSAMLProvidersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSAMLProvidersCommandOutput) => void ): void; - public listSAMLProviders( - args: ListSAMLProvidersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSAMLProvidersCommandOutput) => void), - cb?: (err: any, data?: ListSAMLProvidersCommandOutput) => void - ): Promise | void { - const command = new ListSAMLProvidersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the tags that are attached to the specified Security Assertion Markup Language - * (SAML) identity provider. The returned list of tags is sorted by tag key. For more information, see About SAML 2.0-based - * federation.

- *

For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

- */ - public listSAMLProviderTags( + + /** + * @see {@link ListSAMLProviderTagsCommand} + */ + listSAMLProviderTags( args: ListSAMLProviderTagsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSAMLProviderTags( + listSAMLProviderTags( args: ListSAMLProviderTagsCommandInput, cb: (err: any, data?: ListSAMLProviderTagsCommandOutput) => void ): void; - public listSAMLProviderTags( + listSAMLProviderTags( args: ListSAMLProviderTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSAMLProviderTagsCommandOutput) => void ): void; - public listSAMLProviderTags( - args: ListSAMLProviderTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSAMLProviderTagsCommandOutput) => void), - cb?: (err: any, data?: ListSAMLProviderTagsCommandOutput) => void - ): Promise | void { - const command = new ListSAMLProviderTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the server certificates stored in IAM that have the specified path prefix. If - * none exist, the operation returns an empty list.

- *

You can paginate the results using the MaxItems and Marker - * parameters.

- *

For more information about working with server certificates, see Working - * with server certificates in the IAM User Guide. This - * topic also includes a list of Amazon Web Services services that can use the server certificates that - * you manage with IAM.

- * - *

IAM resource-listing operations return a subset of the available - * attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a servercertificate, see GetServerCertificate.

- *
- */ - public listServerCertificates( + + /** + * @see {@link ListServerCertificatesCommand} + */ + listServerCertificates( args: ListServerCertificatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listServerCertificates( + listServerCertificates( args: ListServerCertificatesCommandInput, cb: (err: any, data?: ListServerCertificatesCommandOutput) => void ): void; - public listServerCertificates( + listServerCertificates( args: ListServerCertificatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServerCertificatesCommandOutput) => void ): void; - public listServerCertificates( - args: ListServerCertificatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServerCertificatesCommandOutput) => void), - cb?: (err: any, data?: ListServerCertificatesCommandOutput) => void - ): Promise | void { - const command = new ListServerCertificatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the tags that are attached to the specified IAM server certificate. The - * returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

- * - *

For certificates in a Region supported by Certificate Manager (ACM), we - * recommend that you don't use IAM server certificates. Instead, use ACM to provision, - * manage, and deploy your server certificates. For more information about IAM server - * certificates, Working with server - * certificates in the IAM User Guide.

- *
- */ - public listServerCertificateTags( + + /** + * @see {@link ListServerCertificateTagsCommand} + */ + listServerCertificateTags( args: ListServerCertificateTagsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listServerCertificateTags( + listServerCertificateTags( args: ListServerCertificateTagsCommandInput, cb: (err: any, data?: ListServerCertificateTagsCommandOutput) => void ): void; - public listServerCertificateTags( + listServerCertificateTags( args: ListServerCertificateTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServerCertificateTagsCommandOutput) => void ): void; - public listServerCertificateTags( - args: ListServerCertificateTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServerCertificateTagsCommandOutput) => void), - cb?: (err: any, data?: ListServerCertificateTagsCommandOutput) => void - ): Promise | void { - const command = new ListServerCertificateTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the service-specific credentials associated with the - * specified IAM user. If none exists, the operation returns an empty list. The - * service-specific credentials returned by this operation are used only for authenticating - * the IAM user to a specific service. For more information about using service-specific - * credentials to authenticate to an Amazon Web Services service, see Set up service-specific credentials - * in the CodeCommit User Guide.

- */ - public listServiceSpecificCredentials( + + /** + * @see {@link ListServiceSpecificCredentialsCommand} + */ + listServiceSpecificCredentials( args: ListServiceSpecificCredentialsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listServiceSpecificCredentials( + listServiceSpecificCredentials( args: ListServiceSpecificCredentialsCommandInput, cb: (err: any, data?: ListServiceSpecificCredentialsCommandOutput) => void ): void; - public listServiceSpecificCredentials( + listServiceSpecificCredentials( args: ListServiceSpecificCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceSpecificCredentialsCommandOutput) => void ): void; - public listServiceSpecificCredentials( - args: ListServiceSpecificCredentialsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServiceSpecificCredentialsCommandOutput) => void), - cb?: (err: any, data?: ListServiceSpecificCredentialsCommandOutput) => void - ): Promise | void { - const command = new ListServiceSpecificCredentialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the signing certificates associated with the specified IAM - * user. If none exists, the operation returns an empty list.

- *

Although each user is limited to a small number of signing certificates, you can still - * paginate the results using the MaxItems and Marker - * parameters.

- *

If the UserName field is not specified, the user name is determined - * implicitly based on the Amazon Web Services access key ID used to sign the request for this operation. - * This operation works for access keys under the Amazon Web Services account. Consequently, you can use - * this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no - * associated users.

- */ - public listSigningCertificates( + + /** + * @see {@link ListSigningCertificatesCommand} + */ + listSigningCertificates( args: ListSigningCertificatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSigningCertificates( + listSigningCertificates( args: ListSigningCertificatesCommandInput, cb: (err: any, data?: ListSigningCertificatesCommandOutput) => void ): void; - public listSigningCertificates( + listSigningCertificates( args: ListSigningCertificatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSigningCertificatesCommandOutput) => void ): void; - public listSigningCertificates( - args: ListSigningCertificatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSigningCertificatesCommandOutput) => void), - cb?: (err: any, data?: ListSigningCertificatesCommandOutput) => void - ): Promise | void { - const command = new ListSigningCertificatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the SSH public keys associated with the specified IAM - * user. If none exists, the operation returns an empty list.

- *

The SSH public keys returned by this operation are used only for authenticating the - * IAM user to an CodeCommit repository. For more information about using SSH keys to - * authenticate to an CodeCommit repository, see Set up CodeCommit for - * SSH connections in the CodeCommit User Guide.

- *

Although each user is limited to a small number of keys, you can still paginate the - * results using the MaxItems and Marker parameters.

- */ - public listSSHPublicKeys( + + /** + * @see {@link ListSSHPublicKeysCommand} + */ + listSSHPublicKeys( args: ListSSHPublicKeysCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSSHPublicKeys( + listSSHPublicKeys( args: ListSSHPublicKeysCommandInput, cb: (err: any, data?: ListSSHPublicKeysCommandOutput) => void ): void; - public listSSHPublicKeys( + listSSHPublicKeys( args: ListSSHPublicKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSSHPublicKeysCommandOutput) => void ): void; - public listSSHPublicKeys( - args: ListSSHPublicKeysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSSHPublicKeysCommandOutput) => void), - cb?: (err: any, data?: ListSSHPublicKeysCommandOutput) => void - ): Promise | void { - const command = new ListSSHPublicKeysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the names of the inline policies embedded in the specified IAM user.

- *

An IAM user can also have managed policies attached to it. To list the managed - * policies that are attached to a user, use ListAttachedUserPolicies. - * For more information about policies, see Managed policies and inline - * policies in the IAM User Guide.

- *

You can paginate the results using the MaxItems and Marker - * parameters. If there are no inline policies embedded with the specified user, the - * operation returns an empty list.

- */ - public listUserPolicies( + + /** + * @see {@link ListUserPoliciesCommand} + */ + listUserPolicies( args: ListUserPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listUserPolicies( + listUserPolicies( args: ListUserPoliciesCommandInput, cb: (err: any, data?: ListUserPoliciesCommandOutput) => void ): void; - public listUserPolicies( + listUserPolicies( args: ListUserPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUserPoliciesCommandOutput) => void ): void; - public listUserPolicies( - args: ListUserPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUserPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListUserPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListUserPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the IAM users that have the specified path prefix. If no path prefix is - * specified, the operation returns all users in the Amazon Web Services account. If there are none, the - * operation returns an empty list.

- * - *

IAM resource-listing operations return a subset of the available - * attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a user, see GetUser.

- *
- *

You can paginate the results using the MaxItems and Marker - * parameters.

- */ - public listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise; - public listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void; - public listUsers( + + /** + * @see {@link ListUsersCommand} + */ + listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise; + listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void; + listUsers( args: ListUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersCommandOutput) => void ): void; - public listUsers( - args: ListUsersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUsersCommandOutput) => void), - cb?: (err: any, data?: ListUsersCommandOutput) => void - ): Promise | void { - const command = new ListUsersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the tags that are attached to the specified IAM user. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

- */ - public listUserTags( - args: ListUserTagsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listUserTags(args: ListUserTagsCommandInput, cb: (err: any, data?: ListUserTagsCommandOutput) => void): void; - public listUserTags( + + /** + * @see {@link ListUserTagsCommand} + */ + listUserTags(args: ListUserTagsCommandInput, options?: __HttpHandlerOptions): Promise; + listUserTags(args: ListUserTagsCommandInput, cb: (err: any, data?: ListUserTagsCommandOutput) => void): void; + listUserTags( args: ListUserTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUserTagsCommandOutput) => void ): void; - public listUserTags( - args: ListUserTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUserTagsCommandOutput) => void), - cb?: (err: any, data?: ListUserTagsCommandOutput) => void - ): Promise | void { - const command = new ListUserTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status. If - * you do not specify an assignment status, the operation returns a list of all virtual MFA - * devices. Assignment status can be Assigned, Unassigned, or - * Any.

- * - *

IAM resource-listing operations return a subset of the available - * attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view tag information for a virtual MFA device, see ListMFADeviceTags.

- *
- *

You can paginate the results using the MaxItems and Marker - * parameters.

- */ - public listVirtualMFADevices( + + /** + * @see {@link ListVirtualMFADevicesCommand} + */ + listVirtualMFADevices( args: ListVirtualMFADevicesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVirtualMFADevices( + listVirtualMFADevices( args: ListVirtualMFADevicesCommandInput, cb: (err: any, data?: ListVirtualMFADevicesCommandOutput) => void ): void; - public listVirtualMFADevices( + listVirtualMFADevices( args: ListVirtualMFADevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVirtualMFADevicesCommandOutput) => void ): void; - public listVirtualMFADevices( - args: ListVirtualMFADevicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVirtualMFADevicesCommandOutput) => void), - cb?: (err: any, data?: ListVirtualMFADevicesCommandOutput) => void - ): Promise | void { - const command = new ListVirtualMFADevicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds or updates an inline policy document that is embedded in the specified IAM - * group.

- *

A user can also have managed policies attached to it. To attach a managed policy to a - * group, use AttachGroupPolicy. To create a new managed policy, use - * CreatePolicy. For information about policies, see Managed - * policies and inline policies in the - * IAM User Guide.

- *

For information about the maximum number of inline policies that you can embed in a - * group, see IAM and STS quotas in the IAM User Guide.

- * - *

Because policy documents can be large, you should use POST rather than GET when - * calling PutGroupPolicy. For general information about using the Query - * API with IAM, see Making query requests in the - * IAM User Guide.

- *
- */ - public putGroupPolicy( + + /** + * @see {@link PutGroupPolicyCommand} + */ + putGroupPolicy( args: PutGroupPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putGroupPolicy( - args: PutGroupPolicyCommandInput, - cb: (err: any, data?: PutGroupPolicyCommandOutput) => void - ): void; - public putGroupPolicy( + putGroupPolicy(args: PutGroupPolicyCommandInput, cb: (err: any, data?: PutGroupPolicyCommandOutput) => void): void; + putGroupPolicy( args: PutGroupPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutGroupPolicyCommandOutput) => void ): void; - public putGroupPolicy( - args: PutGroupPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutGroupPolicyCommandOutput) => void), - cb?: (err: any, data?: PutGroupPolicyCommandOutput) => void - ): Promise | void { - const command = new PutGroupPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds or updates the policy that is specified as the IAM role's permissions boundary. - * You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for - * a role. Use the boundary to control the maximum permissions that the role can have. - * Setting a permissions boundary is an advanced feature that can affect the permissions - * for the role.

- *

You cannot set the boundary for a service-linked role.

- * - *

Policies used as permissions boundaries do not provide permissions. You must also - * attach a permissions policy to the role. To learn how the effective permissions for - * a role are evaluated, see IAM JSON policy - * evaluation logic in the IAM User Guide.

- *
- */ - public putRolePermissionsBoundary( + + /** + * @see {@link PutRolePermissionsBoundaryCommand} + */ + putRolePermissionsBoundary( args: PutRolePermissionsBoundaryCommandInput, options?: __HttpHandlerOptions ): Promise; - public putRolePermissionsBoundary( + putRolePermissionsBoundary( args: PutRolePermissionsBoundaryCommandInput, cb: (err: any, data?: PutRolePermissionsBoundaryCommandOutput) => void ): void; - public putRolePermissionsBoundary( + putRolePermissionsBoundary( args: PutRolePermissionsBoundaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRolePermissionsBoundaryCommandOutput) => void ): void; - public putRolePermissionsBoundary( - args: PutRolePermissionsBoundaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRolePermissionsBoundaryCommandOutput) => void), - cb?: (err: any, data?: PutRolePermissionsBoundaryCommandOutput) => void - ): Promise | void { - const command = new PutRolePermissionsBoundaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds or updates an inline policy document that is embedded in the specified IAM - * role.

- *

When you embed an inline policy in a role, the inline policy is used as part of the - * role's access (permissions) policy. The role's trust policy is created at the same time - * as the role, using CreateRole. You can update a role's trust policy - * using UpdateAssumeRolePolicy. For more information about IAM roles, - * see Using roles to - * delegate permissions and federate identities.

- *

A role can also have a managed policy attached to it. To attach a managed policy to a - * role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed - * policies and inline policies in the - * IAM User Guide.

- *

For information about the maximum number of inline policies that you can embed with a - * role, see IAM and STS quotas in the IAM User Guide.

- * - *

Because policy documents can be large, you should use POST rather than GET when - * calling PutRolePolicy. For general information about using the Query - * API with IAM, see Making query requests in the - * IAM User Guide.

- *
- */ - public putRolePolicy( - args: PutRolePolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putRolePolicy( - args: PutRolePolicyCommandInput, - cb: (err: any, data?: PutRolePolicyCommandOutput) => void - ): void; - public putRolePolicy( + + /** + * @see {@link PutRolePolicyCommand} + */ + putRolePolicy(args: PutRolePolicyCommandInput, options?: __HttpHandlerOptions): Promise; + putRolePolicy(args: PutRolePolicyCommandInput, cb: (err: any, data?: PutRolePolicyCommandOutput) => void): void; + putRolePolicy( args: PutRolePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRolePolicyCommandOutput) => void ): void; - public putRolePolicy( - args: PutRolePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRolePolicyCommandOutput) => void), - cb?: (err: any, data?: PutRolePolicyCommandOutput) => void - ): Promise | void { - const command = new PutRolePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds or updates the policy that is specified as the IAM user's permissions - * boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the - * boundary for a user. Use the boundary to control the maximum permissions that the user - * can have. Setting a permissions boundary is an advanced feature that can affect the - * permissions for the user.

- * - *

Policies that are used as permissions boundaries do not provide permissions. You - * must also attach a permissions policy to the user. To learn how the effective - * permissions for a user are evaluated, see IAM JSON policy - * evaluation logic in the IAM User Guide.

- *
- */ - public putUserPermissionsBoundary( + + /** + * @see {@link PutUserPermissionsBoundaryCommand} + */ + putUserPermissionsBoundary( args: PutUserPermissionsBoundaryCommandInput, options?: __HttpHandlerOptions ): Promise; - public putUserPermissionsBoundary( + putUserPermissionsBoundary( args: PutUserPermissionsBoundaryCommandInput, cb: (err: any, data?: PutUserPermissionsBoundaryCommandOutput) => void ): void; - public putUserPermissionsBoundary( + putUserPermissionsBoundary( args: PutUserPermissionsBoundaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutUserPermissionsBoundaryCommandOutput) => void ): void; - public putUserPermissionsBoundary( - args: PutUserPermissionsBoundaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutUserPermissionsBoundaryCommandOutput) => void), - cb?: (err: any, data?: PutUserPermissionsBoundaryCommandOutput) => void - ): Promise | void { - const command = new PutUserPermissionsBoundaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds or updates an inline policy document that is embedded in the specified IAM - * user.

- *

An IAM user can also have a managed policy attached to it. To attach a managed - * policy to a user, use AttachUserPolicy. To create a new managed - * policy, use CreatePolicy. For information about policies, see Managed - * policies and inline policies in the - * IAM User Guide.

- *

For information about the maximum number of inline policies that you can embed in a - * user, see IAM and STS quotas in the IAM User Guide.

- * - *

Because policy documents can be large, you should use POST rather than GET when - * calling PutUserPolicy. For general information about using the Query - * API with IAM, see Making query requests in the - * IAM User Guide.

- *
- */ - public putUserPolicy( - args: PutUserPolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putUserPolicy( - args: PutUserPolicyCommandInput, - cb: (err: any, data?: PutUserPolicyCommandOutput) => void - ): void; - public putUserPolicy( + + /** + * @see {@link PutUserPolicyCommand} + */ + putUserPolicy(args: PutUserPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + putUserPolicy(args: PutUserPolicyCommandInput, cb: (err: any, data?: PutUserPolicyCommandOutput) => void): void; + putUserPolicy( args: PutUserPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutUserPolicyCommandOutput) => void ): void; - public putUserPolicy( - args: PutUserPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutUserPolicyCommandOutput) => void), - cb?: (err: any, data?: PutUserPolicyCommandOutput) => void - ): Promise | void { - const command = new PutUserPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the specified client ID (also known as audience) from the list of client IDs - * registered for the specified IAM OpenID Connect (OIDC) provider resource - * object.

- *

This operation is idempotent; it does not fail or return an error if you try to remove - * a client ID that does not exist.

- */ - public removeClientIDFromOpenIDConnectProvider( + + /** + * @see {@link RemoveClientIDFromOpenIDConnectProviderCommand} + */ + removeClientIDFromOpenIDConnectProvider( args: RemoveClientIDFromOpenIDConnectProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeClientIDFromOpenIDConnectProvider( + removeClientIDFromOpenIDConnectProvider( args: RemoveClientIDFromOpenIDConnectProviderCommandInput, cb: (err: any, data?: RemoveClientIDFromOpenIDConnectProviderCommandOutput) => void ): void; - public removeClientIDFromOpenIDConnectProvider( + removeClientIDFromOpenIDConnectProvider( args: RemoveClientIDFromOpenIDConnectProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveClientIDFromOpenIDConnectProviderCommandOutput) => void ): void; - public removeClientIDFromOpenIDConnectProvider( - args: RemoveClientIDFromOpenIDConnectProviderCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: RemoveClientIDFromOpenIDConnectProviderCommandOutput) => void), - cb?: (err: any, data?: RemoveClientIDFromOpenIDConnectProviderCommandOutput) => void - ): Promise | void { - const command = new RemoveClientIDFromOpenIDConnectProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the specified IAM role from the specified EC2 instance profile.

- * - *

Make sure that you do not have any Amazon EC2 instances running with the role you - * are about to remove from the instance profile. Removing a role from an instance - * profile that is associated with a running instance might break any applications - * running on the instance.

- *
- *

For more information about IAM roles, see Working with roles. For more - * information about instance profiles, see About instance - * profiles.

- */ - public removeRoleFromInstanceProfile( + + /** + * @see {@link RemoveRoleFromInstanceProfileCommand} + */ + removeRoleFromInstanceProfile( args: RemoveRoleFromInstanceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeRoleFromInstanceProfile( + removeRoleFromInstanceProfile( args: RemoveRoleFromInstanceProfileCommandInput, cb: (err: any, data?: RemoveRoleFromInstanceProfileCommandOutput) => void ): void; - public removeRoleFromInstanceProfile( + removeRoleFromInstanceProfile( args: RemoveRoleFromInstanceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveRoleFromInstanceProfileCommandOutput) => void ): void; - public removeRoleFromInstanceProfile( - args: RemoveRoleFromInstanceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveRoleFromInstanceProfileCommandOutput) => void), - cb?: (err: any, data?: RemoveRoleFromInstanceProfileCommandOutput) => void - ): Promise | void { - const command = new RemoveRoleFromInstanceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the specified user from the specified group.

- */ - public removeUserFromGroup( + + /** + * @see {@link RemoveUserFromGroupCommand} + */ + removeUserFromGroup( args: RemoveUserFromGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeUserFromGroup( + removeUserFromGroup( args: RemoveUserFromGroupCommandInput, cb: (err: any, data?: RemoveUserFromGroupCommandOutput) => void ): void; - public removeUserFromGroup( + removeUserFromGroup( args: RemoveUserFromGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveUserFromGroupCommandOutput) => void ): void; - public removeUserFromGroup( - args: RemoveUserFromGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveUserFromGroupCommandOutput) => void), - cb?: (err: any, data?: RemoveUserFromGroupCommandOutput) => void - ): Promise | void { - const command = new RemoveUserFromGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Resets the password for a service-specific credential. The new password is Amazon Web Services - * generated and cryptographically strong. It cannot be configured by the user. Resetting - * the password immediately invalidates the previous password associated with this - * user.

- */ - public resetServiceSpecificCredential( + + /** + * @see {@link ResetServiceSpecificCredentialCommand} + */ + resetServiceSpecificCredential( args: ResetServiceSpecificCredentialCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetServiceSpecificCredential( + resetServiceSpecificCredential( args: ResetServiceSpecificCredentialCommandInput, cb: (err: any, data?: ResetServiceSpecificCredentialCommandOutput) => void ): void; - public resetServiceSpecificCredential( + resetServiceSpecificCredential( args: ResetServiceSpecificCredentialCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetServiceSpecificCredentialCommandOutput) => void ): void; - public resetServiceSpecificCredential( - args: ResetServiceSpecificCredentialCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetServiceSpecificCredentialCommandOutput) => void), - cb?: (err: any, data?: ResetServiceSpecificCredentialCommandOutput) => void - ): Promise | void { - const command = new ResetServiceSpecificCredentialCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services - * servers.

- *

For more information about creating and working with virtual MFA devices, see Using a virtual MFA - * device in the IAM User Guide.

- */ - public resyncMFADevice( + + /** + * @see {@link ResyncMFADeviceCommand} + */ + resyncMFADevice( args: ResyncMFADeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public resyncMFADevice( - args: ResyncMFADeviceCommandInput, - cb: (err: any, data?: ResyncMFADeviceCommandOutput) => void - ): void; - public resyncMFADevice( + resyncMFADevice(args: ResyncMFADeviceCommandInput, cb: (err: any, data?: ResyncMFADeviceCommandOutput) => void): void; + resyncMFADevice( args: ResyncMFADeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResyncMFADeviceCommandOutput) => void ): void; - public resyncMFADevice( - args: ResyncMFADeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResyncMFADeviceCommandOutput) => void), - cb?: (err: any, data?: ResyncMFADeviceCommandOutput) => void - ): Promise | void { - const command = new ResyncMFADeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the specified version of the specified policy as the policy's default (operative) - * version.

- *

This operation affects all users, groups, and roles that the policy is attached to. To - * list the users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy.

- *

For information about managed policies, see Managed policies and inline - * policies in the IAM User Guide.

- */ - public setDefaultPolicyVersion( + + /** + * @see {@link SetDefaultPolicyVersionCommand} + */ + setDefaultPolicyVersion( args: SetDefaultPolicyVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public setDefaultPolicyVersion( + setDefaultPolicyVersion( args: SetDefaultPolicyVersionCommandInput, cb: (err: any, data?: SetDefaultPolicyVersionCommandOutput) => void ): void; - public setDefaultPolicyVersion( + setDefaultPolicyVersion( args: SetDefaultPolicyVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetDefaultPolicyVersionCommandOutput) => void ): void; - public setDefaultPolicyVersion( - args: SetDefaultPolicyVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetDefaultPolicyVersionCommandOutput) => void), - cb?: (err: any, data?: SetDefaultPolicyVersionCommandOutput) => void - ): Promise | void { - const command = new SetDefaultPolicyVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the specified version of the global endpoint token as the token version used for - * the Amazon Web Services account.

- *

By default, Security Token Service (STS) is available as a global service, and all STS requests - * go to a single endpoint at https://sts.amazonaws.com. Amazon Web Services recommends - * using Regional STS endpoints to reduce latency, build in redundancy, and increase - * session token availability. For information about Regional endpoints for STS, see - * Security Token Service - * endpoints and quotas in the Amazon Web Services General Reference.

- *

If you make an STS call to the global endpoint, the resulting session tokens might - * be valid in some Regions but not others. It depends on the version that is set in this - * operation. Version 1 tokens are valid only in Amazon Web Services Regions that are - * available by default. These tokens do not work in manually enabled Regions, such as Asia - * Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 - * tokens are longer and might affect systems where you temporarily store tokens. For - * information, see Activating and - * deactivating STS in an Amazon Web Services Region in the - * IAM User Guide.

- *

To view the current session token version, see the - * GlobalEndpointTokenVersion entry in the response of the GetAccountSummary operation.

- */ - public setSecurityTokenServicePreferences( + + /** + * @see {@link SetSecurityTokenServicePreferencesCommand} + */ + setSecurityTokenServicePreferences( args: SetSecurityTokenServicePreferencesCommandInput, options?: __HttpHandlerOptions ): Promise; - public setSecurityTokenServicePreferences( + setSecurityTokenServicePreferences( args: SetSecurityTokenServicePreferencesCommandInput, cb: (err: any, data?: SetSecurityTokenServicePreferencesCommandOutput) => void ): void; - public setSecurityTokenServicePreferences( + setSecurityTokenServicePreferences( args: SetSecurityTokenServicePreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetSecurityTokenServicePreferencesCommandOutput) => void ): void; - public setSecurityTokenServicePreferences( - args: SetSecurityTokenServicePreferencesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetSecurityTokenServicePreferencesCommandOutput) => void), - cb?: (err: any, data?: SetSecurityTokenServicePreferencesCommandOutput) => void - ): Promise | void { - const command = new SetSecurityTokenServicePreferencesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Simulate how a set of IAM policies and optionally a resource-based policy works with - * a list of API operations and Amazon Web Services resources to determine the policies' effective - * permissions. The policies are provided as strings.

- *

The simulation does not perform the API operations; it only checks the authorization - * to determine if the simulated policies allow or deny the operations. You can simulate - * resources that don't exist in your account.

- *

If you want to simulate existing policies that are attached to an IAM user, group, - * or role, use SimulatePrincipalPolicy instead.

- *

Context keys are variables that are maintained by Amazon Web Services and its services and which - * provide details about the context of an API query request. You can use the - * Condition element of an IAM policy to evaluate context keys. To get - * the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy.

- *

If the output is long, you can use MaxItems and Marker - * parameters to paginate the results.

- * - *

The IAM policy simulator evaluates statements in the identity-based policy and - * the inputs that you provide during simulation. The policy simulator results can - * differ from your live Amazon Web Services environment. We recommend that you check your policies - * against your live Amazon Web Services environment after testing using the policy simulator to - * confirm that you have the desired results. For more information about using the - * policy simulator, see Testing IAM - * policies with the IAM policy simulator in the - * IAM User Guide.

- *
- */ - public simulateCustomPolicy( + + /** + * @see {@link SimulateCustomPolicyCommand} + */ + simulateCustomPolicy( args: SimulateCustomPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public simulateCustomPolicy( + simulateCustomPolicy( args: SimulateCustomPolicyCommandInput, cb: (err: any, data?: SimulateCustomPolicyCommandOutput) => void ): void; - public simulateCustomPolicy( + simulateCustomPolicy( args: SimulateCustomPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SimulateCustomPolicyCommandOutput) => void ): void; - public simulateCustomPolicy( - args: SimulateCustomPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SimulateCustomPolicyCommandOutput) => void), - cb?: (err: any, data?: SimulateCustomPolicyCommandOutput) => void - ): Promise | void { - const command = new SimulateCustomPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Simulate how a set of IAM policies attached to an IAM entity works with a list of - * API operations and Amazon Web Services resources to determine the policies' effective permissions. The - * entity can be an IAM user, group, or role. If you specify a user, then the simulation - * also includes all of the policies that are attached to groups that the user belongs to. - * You can simulate resources that don't exist in your account.

- *

You can optionally include a list of one or more additional policies specified as - * strings to include in the simulation. If you want to simulate only policies specified as - * strings, use SimulateCustomPolicy instead.

- *

You can also optionally include one resource-based policy to be evaluated with each of - * the resources included in the simulation for IAM users only.

- *

The simulation does not perform the API operations; it only checks the authorization - * to determine if the simulated policies allow or deny the operations.

- *

- * Note: This operation discloses information about the - * permissions granted to other users. If you do not want users to see other user's - * permissions, then consider allowing them to use SimulateCustomPolicy - * instead.

- *

Context keys are variables maintained by Amazon Web Services and its services that provide details - * about the context of an API query request. You can use the Condition - * element of an IAM policy to evaluate context keys. To get the list of context keys - * that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy.

- *

If the output is long, you can use the MaxItems and Marker - * parameters to paginate the results.

- * - *

The IAM policy simulator evaluates statements in the identity-based policy and - * the inputs that you provide during simulation. The policy simulator results can - * differ from your live Amazon Web Services environment. We recommend that you check your policies - * against your live Amazon Web Services environment after testing using the policy simulator to - * confirm that you have the desired results. For more information about using the - * policy simulator, see Testing IAM - * policies with the IAM policy simulator in the - * IAM User Guide.

- *
- */ - public simulatePrincipalPolicy( + + /** + * @see {@link SimulatePrincipalPolicyCommand} + */ + simulatePrincipalPolicy( args: SimulatePrincipalPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public simulatePrincipalPolicy( + simulatePrincipalPolicy( args: SimulatePrincipalPolicyCommandInput, cb: (err: any, data?: SimulatePrincipalPolicyCommandOutput) => void ): void; - public simulatePrincipalPolicy( + simulatePrincipalPolicy( args: SimulatePrincipalPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SimulatePrincipalPolicyCommandOutput) => void ): void; - public simulatePrincipalPolicy( - args: SimulatePrincipalPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SimulatePrincipalPolicyCommandOutput) => void), - cb?: (err: any, data?: SimulatePrincipalPolicyCommandOutput) => void - ): Promise | void { - const command = new SimulatePrincipalPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds one or more tags to an IAM instance profile. If a tag with the same key name - * already exists, then that tag is overwritten with the new value.

- *

Each tag consists of a key name and an associated value. By assigning tags to your resources, you can do the - * following:

- *
    - *
  • - *

    - * Administrative grouping and discovery - Attach - * tags to resources to aid in organization and search. For example, you could search for all - * resources with the key name Project and the value - * MyImportantProject. Or search for all resources with the key name - * Cost Center and the value 41200.

    - *
  • - *
  • - *

    - * Access control - Include tags in IAM user-based - * and resource-based policies. You can use tags to restrict access to only an IAM instance - * profile that has a specified tag attached. For examples of policies that show how to use - * tags to control access, see Control access using IAM tags in the - * IAM User Guide.

    - *
  • - *
- * - *
    - *
  • - *

    If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request - * fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

    - *
  • - *
  • - *

    Amazon Web Services always interprets the tag Value as a single string. If you - * need to store an array, you can store comma-separated values in the string. However, you - * must interpret the value in your code.

    - *
  • - *
- *
- */ - public tagInstanceProfile( + + /** + * @see {@link TagInstanceProfileCommand} + */ + tagInstanceProfile( args: TagInstanceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public tagInstanceProfile( + tagInstanceProfile( args: TagInstanceProfileCommandInput, cb: (err: any, data?: TagInstanceProfileCommandOutput) => void ): void; - public tagInstanceProfile( + tagInstanceProfile( args: TagInstanceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagInstanceProfileCommandOutput) => void ): void; - public tagInstanceProfile( - args: TagInstanceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagInstanceProfileCommandOutput) => void), - cb?: (err: any, data?: TagInstanceProfileCommandOutput) => void - ): Promise | void { - const command = new TagInstanceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device. If - * a tag with the same key name already exists, then that tag is overwritten with the new - * value.

- *

A tag consists of a key name and an associated value. By assigning tags to your - * resources, you can do the following:

- *
    - *
  • - *

    - * Administrative grouping and discovery - Attach - * tags to resources to aid in organization and search. For example, you could search for all - * resources with the key name Project and the value - * MyImportantProject. Or search for all resources with the key name - * Cost Center and the value 41200.

    - *
  • - *
  • - *

    - * Access control - Include tags in IAM user-based - * and resource-based policies. You can use tags to restrict access to only an IAM virtual - * MFA device that has a specified tag attached. For examples of policies that show how to - * use tags to control access, see Control access using IAM tags in the - * IAM User Guide.

    - *
  • - *
- * - *
    - *
  • - *

    If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request - * fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

    - *
  • - *
  • - *

    Amazon Web Services always interprets the tag Value as a single string. If you - * need to store an array, you can store comma-separated values in the string. However, you - * must interpret the value in your code.

    - *
  • - *
- *
- */ - public tagMFADevice( - args: TagMFADeviceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public tagMFADevice(args: TagMFADeviceCommandInput, cb: (err: any, data?: TagMFADeviceCommandOutput) => void): void; - public tagMFADevice( + + /** + * @see {@link TagMFADeviceCommand} + */ + tagMFADevice(args: TagMFADeviceCommandInput, options?: __HttpHandlerOptions): Promise; + tagMFADevice(args: TagMFADeviceCommandInput, cb: (err: any, data?: TagMFADeviceCommandOutput) => void): void; + tagMFADevice( args: TagMFADeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagMFADeviceCommandOutput) => void ): void; - public tagMFADevice( - args: TagMFADeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagMFADeviceCommandOutput) => void), - cb?: (err: any, data?: TagMFADeviceCommandOutput) => void - ): Promise | void { - const command = new TagMFADeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider. For - * more information about these providers, see About web identity federation. If - * a tag with the same key name already exists, then that tag is overwritten with the new - * value.

- *

A tag consists of a key name and an associated value. By assigning tags to your - * resources, you can do the following:

- *
    - *
  • - *

    - * Administrative grouping and discovery - Attach - * tags to resources to aid in organization and search. For example, you could search for all - * resources with the key name Project and the value - * MyImportantProject. Or search for all resources with the key name - * Cost Center and the value 41200.

    - *
  • - *
  • - *

    - * Access control - Include tags in IAM identity-based - * and resource-based policies. You can use tags to restrict access to only an OIDC provider - * that has a specified tag attached. For examples of policies that show how to use tags to - * control access, see Control access using IAM tags in the - * IAM User Guide.

    - *
  • - *
- * - *
    - *
  • - *

    If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request - * fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

    - *
  • - *
  • - *

    Amazon Web Services always interprets the tag Value as a single string. If you - * need to store an array, you can store comma-separated values in the string. However, you - * must interpret the value in your code.

    - *
  • - *
- *
- */ - public tagOpenIDConnectProvider( + + /** + * @see {@link TagOpenIDConnectProviderCommand} + */ + tagOpenIDConnectProvider( args: TagOpenIDConnectProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public tagOpenIDConnectProvider( + tagOpenIDConnectProvider( args: TagOpenIDConnectProviderCommandInput, cb: (err: any, data?: TagOpenIDConnectProviderCommandOutput) => void ): void; - public tagOpenIDConnectProvider( + tagOpenIDConnectProvider( args: TagOpenIDConnectProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagOpenIDConnectProviderCommandOutput) => void ): void; - public tagOpenIDConnectProvider( - args: TagOpenIDConnectProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagOpenIDConnectProviderCommandOutput) => void), - cb?: (err: any, data?: TagOpenIDConnectProviderCommandOutput) => void - ): Promise | void { - const command = new TagOpenIDConnectProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds one or more tags to an IAM customer managed policy. If a tag with the same key - * name already exists, then that tag is overwritten with the new value.

- *

A tag consists of a key name and an associated value. By assigning tags to your - * resources, you can do the following:

- *
    - *
  • - *

    - * Administrative grouping and discovery - Attach - * tags to resources to aid in organization and search. For example, you could search for all - * resources with the key name Project and the value - * MyImportantProject. Or search for all resources with the key name - * Cost Center and the value 41200.

    - *
  • - *
  • - *

    - * Access control - Include tags in IAM user-based - * and resource-based policies. You can use tags to restrict access to only an IAM customer - * managed policy that has a specified tag attached. For examples of policies that show how - * to use tags to control access, see Control access using IAM tags in the - * IAM User Guide.

    - *
  • - *
- * - *
    - *
  • - *

    If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request - * fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

    - *
  • - *
  • - *

    Amazon Web Services always interprets the tag Value as a single string. If you - * need to store an array, you can store comma-separated values in the string. However, you - * must interpret the value in your code.

    - *
  • - *
- *
- */ - public tagPolicy(args: TagPolicyCommandInput, options?: __HttpHandlerOptions): Promise; - public tagPolicy(args: TagPolicyCommandInput, cb: (err: any, data?: TagPolicyCommandOutput) => void): void; - public tagPolicy( + + /** + * @see {@link TagPolicyCommand} + */ + tagPolicy(args: TagPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + tagPolicy(args: TagPolicyCommandInput, cb: (err: any, data?: TagPolicyCommandOutput) => void): void; + tagPolicy( args: TagPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagPolicyCommandOutput) => void ): void; - public tagPolicy( - args: TagPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagPolicyCommandOutput) => void), - cb?: (err: any, data?: TagPolicyCommandOutput) => void - ): Promise | void { - const command = new TagPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds one or more tags to an IAM role. The role can be a regular role or a - * service-linked role. If a tag with the same key name already exists, then that tag is - * overwritten with the new value.

- *

A tag consists of a key name and an associated value. By assigning tags to your - * resources, you can do the following:

- *
    - *
  • - *

    - * Administrative grouping and discovery - Attach - * tags to resources to aid in organization and search. For example, you could search for all - * resources with the key name Project and the value - * MyImportantProject. Or search for all resources with the key name - * Cost Center and the value 41200.

    - *
  • - *
  • - *

    - * Access control - Include tags in IAM user-based - * and resource-based policies. You can use tags to restrict access to only an IAM role - * that has a specified tag attached. You can also restrict access to only those resources - * that have a certain tag attached. For examples of policies that show how to use tags to - * control access, see Control access using IAM tags in the - * IAM User Guide.

    - *
  • - *
  • - *

    - * Cost allocation - Use tags to help track which - * individuals and teams are using which Amazon Web Services resources.

    - *
  • - *
- * - *
    - *
  • - *

    If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request - * fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

    - *
  • - *
  • - *

    Amazon Web Services always interprets the tag Value as a single string. If you - * need to store an array, you can store comma-separated values in the string. However, you - * must interpret the value in your code.

    - *
  • - *
- *
- *

For more information about tagging, see Tagging IAM identities in the - * IAM User Guide.

- */ - public tagRole(args: TagRoleCommandInput, options?: __HttpHandlerOptions): Promise; - public tagRole(args: TagRoleCommandInput, cb: (err: any, data?: TagRoleCommandOutput) => void): void; - public tagRole( + + /** + * @see {@link TagRoleCommand} + */ + tagRole(args: TagRoleCommandInput, options?: __HttpHandlerOptions): Promise; + tagRole(args: TagRoleCommandInput, cb: (err: any, data?: TagRoleCommandOutput) => void): void; + tagRole( args: TagRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagRoleCommandOutput) => void ): void; - public tagRole( - args: TagRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagRoleCommandOutput) => void), - cb?: (err: any, data?: TagRoleCommandOutput) => void - ): Promise | void { - const command = new TagRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider. - * For more information about these providers, see About SAML 2.0-based federation . - * If a tag with the same key name already exists, then that tag is overwritten with the new - * value.

- *

A tag consists of a key name and an associated value. By assigning tags to your - * resources, you can do the following:

- *
    - *
  • - *

    - * Administrative grouping and discovery - Attach - * tags to resources to aid in organization and search. For example, you could search for all - * resources with the key name Project and the value - * MyImportantProject. Or search for all resources with the key name - * Cost Center and the value 41200.

    - *
  • - *
  • - *

    - * Access control - Include tags in IAM user-based - * and resource-based policies. You can use tags to restrict access to only a SAML identity - * provider that has a specified tag attached. For examples of policies that show how to use - * tags to control access, see Control access using IAM tags in the - * IAM User Guide.

    - *
  • - *
- * - *
    - *
  • - *

    If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request - * fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

    - *
  • - *
  • - *

    Amazon Web Services always interprets the tag Value as a single string. If you - * need to store an array, you can store comma-separated values in the string. However, you - * must interpret the value in your code.

    - *
  • - *
- *
- */ - public tagSAMLProvider( + + /** + * @see {@link TagSAMLProviderCommand} + */ + tagSAMLProvider( args: TagSAMLProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public tagSAMLProvider( - args: TagSAMLProviderCommandInput, - cb: (err: any, data?: TagSAMLProviderCommandOutput) => void - ): void; - public tagSAMLProvider( + tagSAMLProvider(args: TagSAMLProviderCommandInput, cb: (err: any, data?: TagSAMLProviderCommandOutput) => void): void; + tagSAMLProvider( args: TagSAMLProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagSAMLProviderCommandOutput) => void ): void; - public tagSAMLProvider( - args: TagSAMLProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagSAMLProviderCommandOutput) => void), - cb?: (err: any, data?: TagSAMLProviderCommandOutput) => void - ): Promise | void { - const command = new TagSAMLProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds one or more tags to an IAM server certificate. If a tag with the same key name - * already exists, then that tag is overwritten with the new value.

- * - *

For certificates in a Region supported by Certificate Manager (ACM), we - * recommend that you don't use IAM server certificates. Instead, use ACM to provision, - * manage, and deploy your server certificates. For more information about IAM server - * certificates, Working with server - * certificates in the IAM User Guide.

- *
- *

A tag consists of a key name and an associated value. By assigning tags to your - * resources, you can do the following:

- *
    - *
  • - *

    - * Administrative grouping and discovery - Attach - * tags to resources to aid in organization and search. For example, you could search for all - * resources with the key name Project and the value - * MyImportantProject. Or search for all resources with the key name - * Cost Center and the value 41200.

    - *
  • - *
  • - *

    - * Access control - Include tags in IAM user-based - * and resource-based policies. You can use tags to restrict access to only a server - * certificate that has a specified tag attached. For examples of policies that show how to - * use tags to control access, see Control access using IAM tags in the - * IAM User Guide.

    - *
  • - *
  • - *

    - * Cost allocation - Use tags to help track which - * individuals and teams are using which Amazon Web Services resources.

    - *
  • - *
- * - *
    - *
  • - *

    If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request - * fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

    - *
  • - *
  • - *

    Amazon Web Services always interprets the tag Value as a single string. If you - * need to store an array, you can store comma-separated values in the string. However, you - * must interpret the value in your code.

    - *
  • - *
- *
- */ - public tagServerCertificate( + + /** + * @see {@link TagServerCertificateCommand} + */ + tagServerCertificate( args: TagServerCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public tagServerCertificate( + tagServerCertificate( args: TagServerCertificateCommandInput, cb: (err: any, data?: TagServerCertificateCommandOutput) => void ): void; - public tagServerCertificate( + tagServerCertificate( args: TagServerCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagServerCertificateCommandOutput) => void ): void; - public tagServerCertificate( - args: TagServerCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagServerCertificateCommandOutput) => void), - cb?: (err: any, data?: TagServerCertificateCommandOutput) => void - ): Promise | void { - const command = new TagServerCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds one or more tags to an IAM user. If a tag with the same key name already exists, - * then that tag is overwritten with the new value.

- *

A tag consists of a key name and an associated value. By assigning tags to your - * resources, you can do the following:

- *
    - *
  • - *

    - * Administrative grouping and discovery - Attach - * tags to resources to aid in organization and search. For example, you could search for all - * resources with the key name Project and the value - * MyImportantProject. Or search for all resources with the key name - * Cost Center and the value 41200.

    - *
  • - *
  • - *

    - * Access control - Include tags in IAM identity-based - * and resource-based policies. You can use tags to restrict access to only an IAM - * requesting user that has a specified tag attached. You can also restrict access to only - * those resources that have a certain tag attached. For examples of policies that show how - * to use tags to control access, see Control access using IAM tags in the - * IAM User Guide.

    - *
  • - *
  • - *

    - * Cost allocation - Use tags to help track which - * individuals and teams are using which Amazon Web Services resources.

    - *
  • - *
- * - *
    - *
  • - *

    If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request - * fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

    - *
  • - *
  • - *

    Amazon Web Services always interprets the tag Value as a single string. If you - * need to store an array, you can store comma-separated values in the string. However, you - * must interpret the value in your code.

    - *
  • - *
- *
- *

For more information about tagging, see Tagging IAM identities in the - * IAM User Guide.

- */ - public tagUser(args: TagUserCommandInput, options?: __HttpHandlerOptions): Promise; - public tagUser(args: TagUserCommandInput, cb: (err: any, data?: TagUserCommandOutput) => void): void; - public tagUser( + + /** + * @see {@link TagUserCommand} + */ + tagUser(args: TagUserCommandInput, options?: __HttpHandlerOptions): Promise; + tagUser(args: TagUserCommandInput, cb: (err: any, data?: TagUserCommandOutput) => void): void; + tagUser( args: TagUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagUserCommandOutput) => void ): void; - public tagUser( - args: TagUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagUserCommandOutput) => void), - cb?: (err: any, data?: TagUserCommandOutput) => void - ): Promise | void { - const command = new TagUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the specified tags from the IAM instance profile. For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

- */ - public untagInstanceProfile( + + /** + * @see {@link UntagInstanceProfileCommand} + */ + untagInstanceProfile( args: UntagInstanceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public untagInstanceProfile( + untagInstanceProfile( args: UntagInstanceProfileCommandInput, cb: (err: any, data?: UntagInstanceProfileCommandOutput) => void ): void; - public untagInstanceProfile( + untagInstanceProfile( args: UntagInstanceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagInstanceProfileCommandOutput) => void ): void; - public untagInstanceProfile( - args: UntagInstanceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagInstanceProfileCommandOutput) => void), - cb?: (err: any, data?: UntagInstanceProfileCommandOutput) => void - ): Promise | void { - const command = new UntagInstanceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the specified tags from the IAM virtual multi-factor authentication (MFA) - * device. For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

- */ - public untagMFADevice( + + /** + * @see {@link UntagMFADeviceCommand} + */ + untagMFADevice( args: UntagMFADeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public untagMFADevice( - args: UntagMFADeviceCommandInput, - cb: (err: any, data?: UntagMFADeviceCommandOutput) => void - ): void; - public untagMFADevice( + untagMFADevice(args: UntagMFADeviceCommandInput, cb: (err: any, data?: UntagMFADeviceCommandOutput) => void): void; + untagMFADevice( args: UntagMFADeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagMFADeviceCommandOutput) => void ): void; - public untagMFADevice( - args: UntagMFADeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagMFADeviceCommandOutput) => void), - cb?: (err: any, data?: UntagMFADeviceCommandOutput) => void - ): Promise | void { - const command = new UntagMFADeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the specified tags from the specified OpenID Connect (OIDC)-compatible identity - * provider in IAM. For more information about OIDC providers, see About web identity federation. - * For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

- */ - public untagOpenIDConnectProvider( + + /** + * @see {@link UntagOpenIDConnectProviderCommand} + */ + untagOpenIDConnectProvider( args: UntagOpenIDConnectProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public untagOpenIDConnectProvider( + untagOpenIDConnectProvider( args: UntagOpenIDConnectProviderCommandInput, cb: (err: any, data?: UntagOpenIDConnectProviderCommandOutput) => void ): void; - public untagOpenIDConnectProvider( + untagOpenIDConnectProvider( args: UntagOpenIDConnectProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagOpenIDConnectProviderCommandOutput) => void ): void; - public untagOpenIDConnectProvider( - args: UntagOpenIDConnectProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagOpenIDConnectProviderCommandOutput) => void), - cb?: (err: any, data?: UntagOpenIDConnectProviderCommandOutput) => void - ): Promise | void { - const command = new UntagOpenIDConnectProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the specified tags from the customer managed policy. For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

- */ - public untagPolicy(args: UntagPolicyCommandInput, options?: __HttpHandlerOptions): Promise; - public untagPolicy(args: UntagPolicyCommandInput, cb: (err: any, data?: UntagPolicyCommandOutput) => void): void; - public untagPolicy( + + /** + * @see {@link UntagPolicyCommand} + */ + untagPolicy(args: UntagPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + untagPolicy(args: UntagPolicyCommandInput, cb: (err: any, data?: UntagPolicyCommandOutput) => void): void; + untagPolicy( args: UntagPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagPolicyCommandOutput) => void ): void; - public untagPolicy( - args: UntagPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagPolicyCommandOutput) => void), - cb?: (err: any, data?: UntagPolicyCommandOutput) => void - ): Promise | void { - const command = new UntagPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the specified tags from the role. For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

- */ - public untagRole(args: UntagRoleCommandInput, options?: __HttpHandlerOptions): Promise; - public untagRole(args: UntagRoleCommandInput, cb: (err: any, data?: UntagRoleCommandOutput) => void): void; - public untagRole( + + /** + * @see {@link UntagRoleCommand} + */ + untagRole(args: UntagRoleCommandInput, options?: __HttpHandlerOptions): Promise; + untagRole(args: UntagRoleCommandInput, cb: (err: any, data?: UntagRoleCommandOutput) => void): void; + untagRole( args: UntagRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagRoleCommandOutput) => void ): void; - public untagRole( - args: UntagRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagRoleCommandOutput) => void), - cb?: (err: any, data?: UntagRoleCommandOutput) => void - ): Promise | void { - const command = new UntagRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the specified tags from the specified Security Assertion Markup Language (SAML) - * identity provider in IAM. For more information about these providers, see About web identity - * federation. For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

- */ - public untagSAMLProvider( + + /** + * @see {@link UntagSAMLProviderCommand} + */ + untagSAMLProvider( args: UntagSAMLProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public untagSAMLProvider( + untagSAMLProvider( args: UntagSAMLProviderCommandInput, cb: (err: any, data?: UntagSAMLProviderCommandOutput) => void ): void; - public untagSAMLProvider( + untagSAMLProvider( args: UntagSAMLProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagSAMLProviderCommandOutput) => void ): void; - public untagSAMLProvider( - args: UntagSAMLProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagSAMLProviderCommandOutput) => void), - cb?: (err: any, data?: UntagSAMLProviderCommandOutput) => void - ): Promise | void { - const command = new UntagSAMLProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the specified tags from the IAM server certificate. - * For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

- * - *

For certificates in a Region supported by Certificate Manager (ACM), we - * recommend that you don't use IAM server certificates. Instead, use ACM to provision, - * manage, and deploy your server certificates. For more information about IAM server - * certificates, Working with server - * certificates in the IAM User Guide.

- *
- */ - public untagServerCertificate( + + /** + * @see {@link UntagServerCertificateCommand} + */ + untagServerCertificate( args: UntagServerCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public untagServerCertificate( + untagServerCertificate( args: UntagServerCertificateCommandInput, cb: (err: any, data?: UntagServerCertificateCommandOutput) => void ): void; - public untagServerCertificate( + untagServerCertificate( args: UntagServerCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagServerCertificateCommandOutput) => void ): void; - public untagServerCertificate( - args: UntagServerCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagServerCertificateCommandOutput) => void), - cb?: (err: any, data?: UntagServerCertificateCommandOutput) => void - ): Promise | void { - const command = new UntagServerCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the specified tags from the user. For more information about tagging, see Tagging IAM resources in the - * IAM User Guide.

- */ - public untagUser(args: UntagUserCommandInput, options?: __HttpHandlerOptions): Promise; - public untagUser(args: UntagUserCommandInput, cb: (err: any, data?: UntagUserCommandOutput) => void): void; - public untagUser( + + /** + * @see {@link UntagUserCommand} + */ + untagUser(args: UntagUserCommandInput, options?: __HttpHandlerOptions): Promise; + untagUser(args: UntagUserCommandInput, cb: (err: any, data?: UntagUserCommandOutput) => void): void; + untagUser( args: UntagUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagUserCommandOutput) => void ): void; - public untagUser( - args: UntagUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagUserCommandOutput) => void), - cb?: (err: any, data?: UntagUserCommandOutput) => void - ): Promise | void { - const command = new UntagUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Changes the status of the specified access key from Active to Inactive, or vice versa. - * This operation can be used to disable a user's key as part of a key rotation - * workflow.

- *

If the UserName is not specified, the user name is determined implicitly - * based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is - * used, then UserName is required. If a long-term key is assigned to the - * user, then UserName is not required. This operation works for access keys - * under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user - * credentials even if the Amazon Web Services account has no associated users.

- *

For information about rotating keys, see Managing keys and certificates - * in the IAM User Guide.

- */ - public updateAccessKey( + + /** + * @see {@link UpdateAccessKeyCommand} + */ + updateAccessKey( args: UpdateAccessKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAccessKey( - args: UpdateAccessKeyCommandInput, - cb: (err: any, data?: UpdateAccessKeyCommandOutput) => void - ): void; - public updateAccessKey( + updateAccessKey(args: UpdateAccessKeyCommandInput, cb: (err: any, data?: UpdateAccessKeyCommandOutput) => void): void; + updateAccessKey( args: UpdateAccessKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccessKeyCommandOutput) => void ): void; - public updateAccessKey( - args: UpdateAccessKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAccessKeyCommandOutput) => void), - cb?: (err: any, data?: UpdateAccessKeyCommandOutput) => void - ): Promise | void { - const command = new UpdateAccessKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the password policy settings for the Amazon Web Services account.

- * - *

This operation does not support partial updates. No parameters are required, but - * if you do not specify a parameter, that parameter's value reverts to its default - * value. See the Request Parameters section for each - * parameter's default value. Also note that some parameters do not allow the default - * parameter to be explicitly set. Instead, to invoke the default value, do not include - * that parameter when you invoke the operation.

- *
- *

For more information about using a password policy, see Managing an IAM password - * policy in the IAM User Guide.

- */ - public updateAccountPasswordPolicy( + + /** + * @see {@link UpdateAccountPasswordPolicyCommand} + */ + updateAccountPasswordPolicy( args: UpdateAccountPasswordPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAccountPasswordPolicy( + updateAccountPasswordPolicy( args: UpdateAccountPasswordPolicyCommandInput, cb: (err: any, data?: UpdateAccountPasswordPolicyCommandOutput) => void ): void; - public updateAccountPasswordPolicy( + updateAccountPasswordPolicy( args: UpdateAccountPasswordPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccountPasswordPolicyCommandOutput) => void ): void; - public updateAccountPasswordPolicy( - args: UpdateAccountPasswordPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAccountPasswordPolicyCommandOutput) => void), - cb?: (err: any, data?: UpdateAccountPasswordPolicyCommandOutput) => void - ): Promise | void { - const command = new UpdateAccountPasswordPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the policy that grants an IAM entity permission to assume a role. This is - * typically referred to as the "role trust policy". For more information about roles, see - * Using roles to - * delegate permissions and federate identities.

- */ - public updateAssumeRolePolicy( + + /** + * @see {@link UpdateAssumeRolePolicyCommand} + */ + updateAssumeRolePolicy( args: UpdateAssumeRolePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAssumeRolePolicy( + updateAssumeRolePolicy( args: UpdateAssumeRolePolicyCommandInput, cb: (err: any, data?: UpdateAssumeRolePolicyCommandOutput) => void ): void; - public updateAssumeRolePolicy( + updateAssumeRolePolicy( args: UpdateAssumeRolePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAssumeRolePolicyCommandOutput) => void ): void; - public updateAssumeRolePolicy( - args: UpdateAssumeRolePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAssumeRolePolicyCommandOutput) => void), - cb?: (err: any, data?: UpdateAssumeRolePolicyCommandOutput) => void - ): Promise | void { - const command = new UpdateAssumeRolePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the name and/or the path of the specified IAM group.

- * - *

You should understand the implications of changing a group's path or name. For - * more information, see Renaming users and - * groups in the IAM User Guide.

- *
- * - *

The person making the request (the principal), must have permission to change the - * role group with the old name and the new name. For example, to change the group - * named Managers to MGRs, the principal must have a policy - * that allows them to update both groups. If the principal has permission to update - * the Managers group, but not the MGRs group, then the - * update fails. For more information about permissions, see Access management. - *

- *
- */ - public updateGroup(args: UpdateGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void; - public updateGroup( + + /** + * @see {@link UpdateGroupCommand} + */ + updateGroup(args: UpdateGroupCommandInput, options?: __HttpHandlerOptions): Promise; + updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void; + updateGroup( args: UpdateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGroupCommandOutput) => void ): void; - public updateGroup( - args: UpdateGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Changes the password for the specified IAM user. You can use the CLI, the Amazon Web Services - * API, or the Users page in the IAM console to change - * the password for any IAM user. Use ChangePassword to change your own - * password in the My Security Credentials page in the - * Amazon Web Services Management Console.

- *

For more information about modifying passwords, see Managing passwords in the - * IAM User Guide.

- */ - public updateLoginProfile( + + /** + * @see {@link UpdateLoginProfileCommand} + */ + updateLoginProfile( args: UpdateLoginProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLoginProfile( + updateLoginProfile( args: UpdateLoginProfileCommandInput, cb: (err: any, data?: UpdateLoginProfileCommandOutput) => void ): void; - public updateLoginProfile( + updateLoginProfile( args: UpdateLoginProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLoginProfileCommandOutput) => void ): void; - public updateLoginProfile( - args: UpdateLoginProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLoginProfileCommandOutput) => void), - cb?: (err: any, data?: UpdateLoginProfileCommandOutput) => void - ): Promise | void { - const command = new UpdateLoginProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Replaces the existing list of server certificate thumbprints associated with an OpenID - * Connect (OIDC) provider resource object with a new list of thumbprints.

- *

The list that you pass with this operation completely replaces the existing list of - * thumbprints. (The lists are not merged.)

- *

Typically, you need to update a thumbprint only when the identity provider certificate - * changes, which occurs rarely. However, if the provider's certificate - * does change, any attempt to assume an IAM role that specifies - * the OIDC provider as a principal fails until the certificate thumbprint is - * updated.

- * - *

Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our - * library of trusted certificate authorities (CAs) instead of using a certificate - * thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, Auth0, - * and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these - * cases, your legacy thumbprint remains in your configuration, but is no longer used for - * validation.

- *
- * - *

Trust for the OIDC provider is derived from the provider certificate and is - * validated by the thumbprint. Therefore, it is best to limit access to the - * UpdateOpenIDConnectProviderThumbprint operation to highly - * privileged users.

- *
- */ - public updateOpenIDConnectProviderThumbprint( + + /** + * @see {@link UpdateOpenIDConnectProviderThumbprintCommand} + */ + updateOpenIDConnectProviderThumbprint( args: UpdateOpenIDConnectProviderThumbprintCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateOpenIDConnectProviderThumbprint( + updateOpenIDConnectProviderThumbprint( args: UpdateOpenIDConnectProviderThumbprintCommandInput, cb: (err: any, data?: UpdateOpenIDConnectProviderThumbprintCommandOutput) => void ): void; - public updateOpenIDConnectProviderThumbprint( + updateOpenIDConnectProviderThumbprint( args: UpdateOpenIDConnectProviderThumbprintCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateOpenIDConnectProviderThumbprintCommandOutput) => void ): void; - public updateOpenIDConnectProviderThumbprint( - args: UpdateOpenIDConnectProviderThumbprintCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateOpenIDConnectProviderThumbprintCommandOutput) => void), - cb?: (err: any, data?: UpdateOpenIDConnectProviderThumbprintCommandOutput) => void - ): Promise | void { - const command = new UpdateOpenIDConnectProviderThumbprintCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the description or maximum session duration setting of a role.

- */ - public updateRole(args: UpdateRoleCommandInput, options?: __HttpHandlerOptions): Promise; - public updateRole(args: UpdateRoleCommandInput, cb: (err: any, data?: UpdateRoleCommandOutput) => void): void; - public updateRole( + + /** + * @see {@link UpdateRoleCommand} + */ + updateRole(args: UpdateRoleCommandInput, options?: __HttpHandlerOptions): Promise; + updateRole(args: UpdateRoleCommandInput, cb: (err: any, data?: UpdateRoleCommandOutput) => void): void; + updateRole( args: UpdateRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRoleCommandOutput) => void ): void; - public updateRole( - args: UpdateRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRoleCommandOutput) => void), - cb?: (err: any, data?: UpdateRoleCommandOutput) => void - ): Promise | void { - const command = new UpdateRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Use UpdateRole instead.

- *

Modifies only the description of a role. This operation performs the same function as - * the Description parameter in the UpdateRole operation.

- */ - public updateRoleDescription( + + /** + * @see {@link UpdateRoleDescriptionCommand} + */ + updateRoleDescription( args: UpdateRoleDescriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRoleDescription( + updateRoleDescription( args: UpdateRoleDescriptionCommandInput, cb: (err: any, data?: UpdateRoleDescriptionCommandOutput) => void ): void; - public updateRoleDescription( + updateRoleDescription( args: UpdateRoleDescriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRoleDescriptionCommandOutput) => void ): void; - public updateRoleDescription( - args: UpdateRoleDescriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRoleDescriptionCommandOutput) => void), - cb?: (err: any, data?: UpdateRoleDescriptionCommandOutput) => void - ): Promise | void { - const command = new UpdateRoleDescriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the metadata document for an existing SAML provider resource object.

- * - *

This operation requires Signature Version 4.

- *
- */ - public updateSAMLProvider( + + /** + * @see {@link UpdateSAMLProviderCommand} + */ + updateSAMLProvider( args: UpdateSAMLProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSAMLProvider( + updateSAMLProvider( args: UpdateSAMLProviderCommandInput, cb: (err: any, data?: UpdateSAMLProviderCommandOutput) => void ): void; - public updateSAMLProvider( + updateSAMLProvider( args: UpdateSAMLProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSAMLProviderCommandOutput) => void ): void; - public updateSAMLProvider( - args: UpdateSAMLProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSAMLProviderCommandOutput) => void), - cb?: (err: any, data?: UpdateSAMLProviderCommandOutput) => void - ): Promise | void { - const command = new UpdateSAMLProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the name and/or the path of the specified server certificate stored in - * IAM.

- *

For more information about working with server certificates, see Working - * with server certificates in the IAM User Guide. This - * topic also includes a list of Amazon Web Services services that can use the server certificates that - * you manage with IAM.

- * - *

You should understand the implications of changing a server certificate's path or - * name. For more information, see Renaming a server certificate in the - * IAM User Guide.

- *
- * - *

The person making the request (the principal), must have permission to change the - * server certificate with the old name and the new name. For example, to change the - * certificate named ProductionCert to ProdCert, the - * principal must have a policy that allows them to update both certificates. If the - * principal has permission to update the ProductionCert group, but not - * the ProdCert certificate, then the update fails. For more information - * about permissions, see Access management in the IAM User Guide.

- *
- */ - public updateServerCertificate( + + /** + * @see {@link UpdateServerCertificateCommand} + */ + updateServerCertificate( args: UpdateServerCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateServerCertificate( + updateServerCertificate( args: UpdateServerCertificateCommandInput, cb: (err: any, data?: UpdateServerCertificateCommandOutput) => void ): void; - public updateServerCertificate( + updateServerCertificate( args: UpdateServerCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServerCertificateCommandOutput) => void ): void; - public updateServerCertificate( - args: UpdateServerCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServerCertificateCommandOutput) => void), - cb?: (err: any, data?: UpdateServerCertificateCommandOutput) => void - ): Promise | void { - const command = new UpdateServerCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the status of a service-specific credential to Active or - * Inactive. Service-specific credentials that are inactive cannot be used - * for authentication to the service. This operation can be used to disable a user's - * service-specific credential as part of a credential rotation work flow.

- */ - public updateServiceSpecificCredential( + + /** + * @see {@link UpdateServiceSpecificCredentialCommand} + */ + updateServiceSpecificCredential( args: UpdateServiceSpecificCredentialCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateServiceSpecificCredential( + updateServiceSpecificCredential( args: UpdateServiceSpecificCredentialCommandInput, cb: (err: any, data?: UpdateServiceSpecificCredentialCommandOutput) => void ): void; - public updateServiceSpecificCredential( + updateServiceSpecificCredential( args: UpdateServiceSpecificCredentialCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceSpecificCredentialCommandOutput) => void ): void; - public updateServiceSpecificCredential( - args: UpdateServiceSpecificCredentialCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServiceSpecificCredentialCommandOutput) => void), - cb?: (err: any, data?: UpdateServiceSpecificCredentialCommandOutput) => void - ): Promise | void { - const command = new UpdateServiceSpecificCredentialCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Changes the status of the specified user signing certificate from active to disabled, - * or vice versa. This operation can be used to disable an IAM user's signing - * certificate as part of a certificate rotation work flow.

- *

If the UserName field is not specified, the user name is determined - * implicitly based on the Amazon Web Services access key ID used to sign the request. This operation - * works for access keys under the Amazon Web Services account. Consequently, you can use this operation - * to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated - * users.

- */ - public updateSigningCertificate( + + /** + * @see {@link UpdateSigningCertificateCommand} + */ + updateSigningCertificate( args: UpdateSigningCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSigningCertificate( + updateSigningCertificate( args: UpdateSigningCertificateCommandInput, cb: (err: any, data?: UpdateSigningCertificateCommandOutput) => void ): void; - public updateSigningCertificate( + updateSigningCertificate( args: UpdateSigningCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSigningCertificateCommandOutput) => void ): void; - public updateSigningCertificate( - args: UpdateSigningCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSigningCertificateCommandOutput) => void), - cb?: (err: any, data?: UpdateSigningCertificateCommandOutput) => void - ): Promise | void { - const command = new UpdateSigningCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the status of an IAM user's SSH public key to active or inactive. SSH public - * keys that are inactive cannot be used for authentication. This operation can be used to - * disable a user's SSH public key as part of a key rotation work flow.

- *

The SSH public key affected by this operation is used only for authenticating the - * associated IAM user to an CodeCommit repository. For more information about using SSH keys - * to authenticate to an CodeCommit repository, see Set up CodeCommit for - * SSH connections in the CodeCommit User Guide.

- */ - public updateSSHPublicKey( + + /** + * @see {@link UpdateSSHPublicKeyCommand} + */ + updateSSHPublicKey( args: UpdateSSHPublicKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSSHPublicKey( + updateSSHPublicKey( args: UpdateSSHPublicKeyCommandInput, cb: (err: any, data?: UpdateSSHPublicKeyCommandOutput) => void ): void; - public updateSSHPublicKey( + updateSSHPublicKey( args: UpdateSSHPublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSSHPublicKeyCommandOutput) => void ): void; - public updateSSHPublicKey( - args: UpdateSSHPublicKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSSHPublicKeyCommandOutput) => void), - cb?: (err: any, data?: UpdateSSHPublicKeyCommandOutput) => void - ): Promise | void { - const command = new UpdateSSHPublicKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the name and/or the path of the specified IAM user.

- * - *

You should understand the implications of changing an IAM user's path or - * name. For more information, see Renaming an IAM - * user and Renaming an IAM - * group in the IAM User Guide.

- *
- * - *

To change a user name, the requester must have appropriate permissions on both - * the source object and the target object. For example, to change Bob to Robert, the - * entity making the request must have permission on Bob and Robert, or must have - * permission on all (*). For more information about permissions, see Permissions and policies.

- *
- */ - public updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise; - public updateUser(args: UpdateUserCommandInput, cb: (err: any, data?: UpdateUserCommandOutput) => void): void; - public updateUser( + + /** + * @see {@link UpdateUserCommand} + */ + updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise; + updateUser(args: UpdateUserCommandInput, cb: (err: any, data?: UpdateUserCommandOutput) => void): void; + updateUser( args: UpdateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserCommandOutput) => void ): void; - public updateUser( - args: UpdateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserCommandOutput) => void), - cb?: (err: any, data?: UpdateUserCommandOutput) => void - ): Promise | void { - const command = new UpdateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Uploads a server certificate entity for the Amazon Web Services account. The server certificate - * entity includes a public key certificate, a private key, and an optional certificate - * chain, which should all be PEM-encoded.

- *

We recommend that you use Certificate Manager to - * provision, manage, and deploy your server certificates. With ACM you can request a - * certificate, deploy it to Amazon Web Services resources, and let ACM handle certificate renewals for - * you. Certificates provided by ACM are free. For more information about using ACM, - * see the Certificate Manager User - * Guide.

- *

For more information about working with server certificates, see Working - * with server certificates in the IAM User Guide. This - * topic includes a list of Amazon Web Services services that can use the server certificates that you - * manage with IAM.

- *

For information about the number of server certificates you can upload, see IAM and STS - * quotas in the IAM User Guide.

- * - *

Because the body of the public key certificate, private key, and the certificate - * chain can be large, you should use POST rather than GET when calling - * UploadServerCertificate. For information about setting up - * signatures and authorization through the API, see Signing Amazon Web Services API - * requests in the Amazon Web Services General Reference. For general - * information about using the Query API with IAM, see Calling the API by making HTTP query - * requests in the IAM User Guide.

- *
- */ - public uploadServerCertificate( + + /** + * @see {@link UploadServerCertificateCommand} + */ + uploadServerCertificate( args: UploadServerCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public uploadServerCertificate( + uploadServerCertificate( args: UploadServerCertificateCommandInput, cb: (err: any, data?: UploadServerCertificateCommandOutput) => void ): void; - public uploadServerCertificate( + uploadServerCertificate( args: UploadServerCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UploadServerCertificateCommandOutput) => void ): void; - public uploadServerCertificate( - args: UploadServerCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UploadServerCertificateCommandOutput) => void), - cb?: (err: any, data?: UploadServerCertificateCommandOutput) => void - ): Promise | void { - const command = new UploadServerCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Uploads an X.509 signing certificate and associates it with the specified IAM user. - * Some Amazon Web Services services require you to use certificates to validate requests that are signed - * with a corresponding private key. When you upload the certificate, its default status is - * Active.

- *

For information about when you would use an X.509 signing certificate, see Managing - * server certificates in IAM in the - * IAM User Guide.

- *

If the UserName is not specified, the IAM user name is determined - * implicitly based on the Amazon Web Services access key ID used to sign the request. This operation - * works for access keys under the Amazon Web Services account. Consequently, you can use this operation - * to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated - * users.

- * - *

Because the body of an X.509 certificate can be large, you should use POST rather - * than GET when calling UploadSigningCertificate. For information about - * setting up signatures and authorization through the API, see Signing - * Amazon Web Services API requests in the Amazon Web Services General Reference. For - * general information about using the Query API with IAM, see Making query - * requests in the IAM User Guide.

- *
- */ - public uploadSigningCertificate( + + /** + * @see {@link UploadSigningCertificateCommand} + */ + uploadSigningCertificate( args: UploadSigningCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public uploadSigningCertificate( + uploadSigningCertificate( args: UploadSigningCertificateCommandInput, cb: (err: any, data?: UploadSigningCertificateCommandOutput) => void ): void; - public uploadSigningCertificate( + uploadSigningCertificate( args: UploadSigningCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UploadSigningCertificateCommandOutput) => void ): void; - public uploadSigningCertificate( - args: UploadSigningCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UploadSigningCertificateCommandOutput) => void), - cb?: (err: any, data?: UploadSigningCertificateCommandOutput) => void - ): Promise | void { - const command = new UploadSigningCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Uploads an SSH public key and associates it with the specified IAM user.

- *

The SSH public key uploaded by this operation can be used only for authenticating the - * associated IAM user to an CodeCommit repository. For more information about using SSH keys - * to authenticate to an CodeCommit repository, see Set up CodeCommit for - * SSH connections in the CodeCommit User Guide.

- */ - public uploadSSHPublicKey( + + /** + * @see {@link UploadSSHPublicKeyCommand} + */ + uploadSSHPublicKey( args: UploadSSHPublicKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public uploadSSHPublicKey( + uploadSSHPublicKey( args: UploadSSHPublicKeyCommandInput, cb: (err: any, data?: UploadSSHPublicKeyCommandOutput) => void ): void; - public uploadSSHPublicKey( + uploadSSHPublicKey( args: UploadSSHPublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UploadSSHPublicKeyCommandOutput) => void ): void; - public uploadSSHPublicKey( - args: UploadSSHPublicKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UploadSSHPublicKeyCommandOutput) => void), - cb?: (err: any, data?: UploadSSHPublicKeyCommandOutput) => void - ): Promise | void { - const command = new UploadSSHPublicKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Identity and Access Management + *

Identity and Access Management (IAM) is a web service for securely controlling + * access to Amazon Web Services services. With IAM, you can centrally manage users, security credentials + * such as access keys, and permissions that control which Amazon Web Services resources users and + * applications can access. For more information about IAM, see Identity and Access Management (IAM) and the Identity and Access Management User Guide.

+ */ +export class IAM extends IAMClient implements IAM {} +createAggregatedClient(commands, IAM); diff --git a/clients/client-identitystore/src/Identitystore.ts b/clients/client-identitystore/src/Identitystore.ts index 816eebed3151..7038421a65e6 100644 --- a/clients/client-identitystore/src/Identitystore.ts +++ b/clients/client-identitystore/src/Identitystore.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { CreateGroupCommand, CreateGroupCommandInput, CreateGroupCommandOutput } from "./commands/CreateGroupCommand"; @@ -56,588 +57,297 @@ import { ListGroupsCommand, ListGroupsCommandInput, ListGroupsCommandOutput } fr import { ListUsersCommand, ListUsersCommandInput, ListUsersCommandOutput } from "./commands/ListUsersCommand"; import { UpdateGroupCommand, UpdateGroupCommandInput, UpdateGroupCommandOutput } from "./commands/UpdateGroupCommand"; import { UpdateUserCommand, UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand"; -import { IdentitystoreClient } from "./IdentitystoreClient"; +import { IdentitystoreClient, IdentitystoreClientConfig } from "./IdentitystoreClient"; -/** - * @public - *

The Identity Store service used by AWS IAM Identity Center (successor to AWS Single Sign-On) provides a single place to retrieve all of - * your identities (users and groups). For more information, see the IAM Identity Center User - * Guide.

- * - * - *

Although AWS Single Sign-On was renamed, the sso and - * identitystore API namespaces will continue to retain their original name for - * backward compatibility purposes. For more information, see IAM Identity Center rename.

- *
- * - *

This reference guide describes the identity store operations that you can call - * programatically and includes detailed information about data types and errors.

- */ -export class Identitystore extends IdentitystoreClient { +const commands = { + CreateGroupCommand, + CreateGroupMembershipCommand, + CreateUserCommand, + DeleteGroupCommand, + DeleteGroupMembershipCommand, + DeleteUserCommand, + DescribeGroupCommand, + DescribeGroupMembershipCommand, + DescribeUserCommand, + GetGroupIdCommand, + GetGroupMembershipIdCommand, + GetUserIdCommand, + IsMemberInGroupsCommand, + ListGroupMembershipsCommand, + ListGroupMembershipsForMemberCommand, + ListGroupsCommand, + ListUsersCommand, + UpdateGroupCommand, + UpdateUserCommand, +}; + +export interface Identitystore { /** - * @public - *

Creates a group within the specified identity store.

+ * @see {@link CreateGroupCommand} */ - public createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void; - public createGroup( + createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise; + createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void; + createGroup( args: CreateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupCommandOutput) => void ): void; - public createGroup( - args: CreateGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGroupCommandOutput) => void), - cb?: (err: any, data?: CreateGroupCommandOutput) => void - ): Promise | void { - const command = new CreateGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a relationship between a member and a group. The following identifiers must be specified: GroupId, IdentityStoreId, and MemberId.

+ * @see {@link CreateGroupMembershipCommand} */ - public createGroupMembership( + createGroupMembership( args: CreateGroupMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public createGroupMembership( + createGroupMembership( args: CreateGroupMembershipCommandInput, cb: (err: any, data?: CreateGroupMembershipCommandOutput) => void ): void; - public createGroupMembership( + createGroupMembership( args: CreateGroupMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupMembershipCommandOutput) => void ): void; - public createGroupMembership( - args: CreateGroupMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGroupMembershipCommandOutput) => void), - cb?: (err: any, data?: CreateGroupMembershipCommandOutput) => void - ): Promise | void { - const command = new CreateGroupMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a user within the specified identity store.

+ * @see {@link CreateUserCommand} */ - public createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; - public createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; - public createUser( + createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; + createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; + createUser( args: CreateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserCommandOutput) => void ): void; - public createUser( - args: CreateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserCommandOutput) => void), - cb?: (err: any, data?: CreateUserCommandOutput) => void - ): Promise | void { - const command = new CreateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete a group within an identity store given GroupId.

+ * @see {@link DeleteGroupCommand} */ - public deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void; - public deleteGroup( + deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise; + deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void; + deleteGroup( args: DeleteGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupCommandOutput) => void ): void; - public deleteGroup( - args: DeleteGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete a membership within a group given MembershipId.

+ * @see {@link DeleteGroupMembershipCommand} */ - public deleteGroupMembership( + deleteGroupMembership( args: DeleteGroupMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteGroupMembership( + deleteGroupMembership( args: DeleteGroupMembershipCommandInput, cb: (err: any, data?: DeleteGroupMembershipCommandOutput) => void ): void; - public deleteGroupMembership( + deleteGroupMembership( args: DeleteGroupMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupMembershipCommandOutput) => void ): void; - public deleteGroupMembership( - args: DeleteGroupMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGroupMembershipCommandOutput) => void), - cb?: (err: any, data?: DeleteGroupMembershipCommandOutput) => void - ): Promise | void { - const command = new DeleteGroupMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a user within an identity store given UserId.

+ * @see {@link DeleteUserCommand} */ - public deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; - public deleteUser( + deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; + deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; + deleteUser( args: DeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserCommandOutput) => void ): void; - public deleteUser( - args: DeleteUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserCommandOutput) => void), - cb?: (err: any, data?: DeleteUserCommandOutput) => void - ): Promise | void { - const command = new DeleteUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the group metadata and attributes from GroupId in an identity - * store.

+ * @see {@link DescribeGroupCommand} */ - public describeGroup( - args: DescribeGroupCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeGroup( - args: DescribeGroupCommandInput, - cb: (err: any, data?: DescribeGroupCommandOutput) => void - ): void; - public describeGroup( + describeGroup(args: DescribeGroupCommandInput, options?: __HttpHandlerOptions): Promise; + describeGroup(args: DescribeGroupCommandInput, cb: (err: any, data?: DescribeGroupCommandOutput) => void): void; + describeGroup( args: DescribeGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGroupCommandOutput) => void ): void; - public describeGroup( - args: DescribeGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGroupCommandOutput) => void), - cb?: (err: any, data?: DescribeGroupCommandOutput) => void - ): Promise | void { - const command = new DescribeGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves membership metadata and attributes from MembershipId in an identity store.

+ * @see {@link DescribeGroupMembershipCommand} */ - public describeGroupMembership( + describeGroupMembership( args: DescribeGroupMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGroupMembership( + describeGroupMembership( args: DescribeGroupMembershipCommandInput, cb: (err: any, data?: DescribeGroupMembershipCommandOutput) => void ): void; - public describeGroupMembership( + describeGroupMembership( args: DescribeGroupMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGroupMembershipCommandOutput) => void ): void; - public describeGroupMembership( - args: DescribeGroupMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGroupMembershipCommandOutput) => void), - cb?: (err: any, data?: DescribeGroupMembershipCommandOutput) => void - ): Promise | void { - const command = new DescribeGroupMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the user metadata and attributes from the UserId in an identity store.

+ * @see {@link DescribeUserCommand} */ - public describeUser( - args: DescribeUserCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeUser(args: DescribeUserCommandInput, cb: (err: any, data?: DescribeUserCommandOutput) => void): void; - public describeUser( + describeUser(args: DescribeUserCommandInput, options?: __HttpHandlerOptions): Promise; + describeUser(args: DescribeUserCommandInput, cb: (err: any, data?: DescribeUserCommandOutput) => void): void; + describeUser( args: DescribeUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserCommandOutput) => void ): void; - public describeUser( - args: DescribeUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUserCommandOutput) => void), - cb?: (err: any, data?: DescribeUserCommandOutput) => void - ): Promise | void { - const command = new DescribeUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves GroupId in an identity store.

+ * @see {@link GetGroupIdCommand} */ - public getGroupId(args: GetGroupIdCommandInput, options?: __HttpHandlerOptions): Promise; - public getGroupId(args: GetGroupIdCommandInput, cb: (err: any, data?: GetGroupIdCommandOutput) => void): void; - public getGroupId( + getGroupId(args: GetGroupIdCommandInput, options?: __HttpHandlerOptions): Promise; + getGroupId(args: GetGroupIdCommandInput, cb: (err: any, data?: GetGroupIdCommandOutput) => void): void; + getGroupId( args: GetGroupIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupIdCommandOutput) => void ): void; - public getGroupId( - args: GetGroupIdCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGroupIdCommandOutput) => void), - cb?: (err: any, data?: GetGroupIdCommandOutput) => void - ): Promise | void { - const command = new GetGroupIdCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the MembershipId in an identity store.

+ * @see {@link GetGroupMembershipIdCommand} */ - public getGroupMembershipId( + getGroupMembershipId( args: GetGroupMembershipIdCommandInput, options?: __HttpHandlerOptions ): Promise; - public getGroupMembershipId( + getGroupMembershipId( args: GetGroupMembershipIdCommandInput, cb: (err: any, data?: GetGroupMembershipIdCommandOutput) => void ): void; - public getGroupMembershipId( + getGroupMembershipId( args: GetGroupMembershipIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupMembershipIdCommandOutput) => void ): void; - public getGroupMembershipId( - args: GetGroupMembershipIdCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGroupMembershipIdCommandOutput) => void), - cb?: (err: any, data?: GetGroupMembershipIdCommandOutput) => void - ): Promise | void { - const command = new GetGroupMembershipIdCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the UserId in an identity store.

+ * @see {@link GetUserIdCommand} */ - public getUserId(args: GetUserIdCommandInput, options?: __HttpHandlerOptions): Promise; - public getUserId(args: GetUserIdCommandInput, cb: (err: any, data?: GetUserIdCommandOutput) => void): void; - public getUserId( + getUserId(args: GetUserIdCommandInput, options?: __HttpHandlerOptions): Promise; + getUserId(args: GetUserIdCommandInput, cb: (err: any, data?: GetUserIdCommandOutput) => void): void; + getUserId( args: GetUserIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserIdCommandOutput) => void ): void; - public getUserId( - args: GetUserIdCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUserIdCommandOutput) => void), - cb?: (err: any, data?: GetUserIdCommandOutput) => void - ): Promise | void { - const command = new GetUserIdCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Checks the user's membership in all requested groups and returns if the member exists in all queried groups.

+ * @see {@link IsMemberInGroupsCommand} */ - public isMemberInGroups( + isMemberInGroups( args: IsMemberInGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public isMemberInGroups( + isMemberInGroups( args: IsMemberInGroupsCommandInput, cb: (err: any, data?: IsMemberInGroupsCommandOutput) => void ): void; - public isMemberInGroups( + isMemberInGroups( args: IsMemberInGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IsMemberInGroupsCommandOutput) => void ): void; - public isMemberInGroups( - args: IsMemberInGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: IsMemberInGroupsCommandOutput) => void), - cb?: (err: any, data?: IsMemberInGroupsCommandOutput) => void - ): Promise | void { - const command = new IsMemberInGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

For the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

+ * @see {@link ListGroupMembershipsCommand} */ - public listGroupMemberships( + listGroupMemberships( args: ListGroupMembershipsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGroupMemberships( + listGroupMemberships( args: ListGroupMembershipsCommandInput, cb: (err: any, data?: ListGroupMembershipsCommandOutput) => void ): void; - public listGroupMemberships( + listGroupMemberships( args: ListGroupMembershipsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupMembershipsCommandOutput) => void ): void; - public listGroupMemberships( - args: ListGroupMembershipsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGroupMembershipsCommandOutput) => void), - cb?: (err: any, data?: ListGroupMembershipsCommandOutput) => void - ): Promise | void { - const command = new ListGroupMembershipsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

For the specified member in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

+ * @see {@link ListGroupMembershipsForMemberCommand} */ - public listGroupMembershipsForMember( + listGroupMembershipsForMember( args: ListGroupMembershipsForMemberCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGroupMembershipsForMember( + listGroupMembershipsForMember( args: ListGroupMembershipsForMemberCommandInput, cb: (err: any, data?: ListGroupMembershipsForMemberCommandOutput) => void ): void; - public listGroupMembershipsForMember( + listGroupMembershipsForMember( args: ListGroupMembershipsForMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupMembershipsForMemberCommandOutput) => void ): void; - public listGroupMembershipsForMember( - args: ListGroupMembershipsForMemberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGroupMembershipsForMemberCommandOutput) => void), - cb?: (err: any, data?: ListGroupMembershipsForMemberCommandOutput) => void - ): Promise | void { - const command = new ListGroupMembershipsForMemberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all groups in the identity store. Returns a paginated list of complete Group objects. - * Filtering for a Group by the DisplayName attribute is deprecated. Instead, use the GetGroupId API action.

+ * @see {@link ListGroupsCommand} */ - public listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise; - public listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void; - public listGroups( + listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise; + listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void; + listGroups( args: ListGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsCommandOutput) => void ): void; - public listGroups( - args: ListGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGroupsCommandOutput) => void), - cb?: (err: any, data?: ListGroupsCommandOutput) => void - ): Promise | void { - const command = new ListGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all users in the identity store. Returns a paginated list of complete User objects. - * Filtering for a User by the UserName attribute is deprecated. Instead, use the GetUserId API action.

+ * @see {@link ListUsersCommand} */ - public listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise; - public listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void; - public listUsers( + listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise; + listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void; + listUsers( args: ListUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersCommandOutput) => void ): void; - public listUsers( - args: ListUsersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUsersCommandOutput) => void), - cb?: (err: any, data?: ListUsersCommandOutput) => void - ): Promise | void { - const command = new ListUsersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

For the specified group in the specified identity store, updates the group metadata and attributes.

+ * @see {@link UpdateGroupCommand} */ - public updateGroup(args: UpdateGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void; - public updateGroup( + updateGroup(args: UpdateGroupCommandInput, options?: __HttpHandlerOptions): Promise; + updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void; + updateGroup( args: UpdateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGroupCommandOutput) => void ): void; - public updateGroup( - args: UpdateGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

For the specified user in the specified identity store, updates the user metadata and attributes.

+ * @see {@link UpdateUserCommand} */ - public updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise; - public updateUser(args: UpdateUserCommandInput, cb: (err: any, data?: UpdateUserCommandOutput) => void): void; - public updateUser( + updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise; + updateUser(args: UpdateUserCommandInput, cb: (err: any, data?: UpdateUserCommandOutput) => void): void; + updateUser( args: UpdateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserCommandOutput) => void ): void; - public updateUser( - args: UpdateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserCommandOutput) => void), - cb?: (err: any, data?: UpdateUserCommandOutput) => void - ): Promise | void { - const command = new UpdateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The Identity Store service used by AWS IAM Identity Center (successor to AWS Single Sign-On) provides a single place to retrieve all of + * your identities (users and groups). For more information, see the IAM Identity Center User + * Guide.

+ * + * + *

Although AWS Single Sign-On was renamed, the sso and + * identitystore API namespaces will continue to retain their original name for + * backward compatibility purposes. For more information, see IAM Identity Center rename.

+ *
+ * + *

This reference guide describes the identity store operations that you can call + * programatically and includes detailed information about data types and errors.

+ */ +export class Identitystore extends IdentitystoreClient implements Identitystore {} +createAggregatedClient(commands, Identitystore); diff --git a/clients/client-imagebuilder/src/Imagebuilder.ts b/clients/client-imagebuilder/src/Imagebuilder.ts index bd6c57e95da7..b16321daba7d 100644 --- a/clients/client-imagebuilder/src/Imagebuilder.ts +++ b/clients/client-imagebuilder/src/Imagebuilder.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -261,1951 +262,958 @@ import { UpdateInfrastructureConfigurationCommandInput, UpdateInfrastructureConfigurationCommandOutput, } from "./commands/UpdateInfrastructureConfigurationCommand"; -import { ImagebuilderClient } from "./ImagebuilderClient"; +import { ImagebuilderClient, ImagebuilderClientConfig } from "./ImagebuilderClient"; -/** - * @public - *

EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the - * creation, management, and deployment of customized, secure, and up-to-date - * "golden" server images that are pre-installed and pre-configured with software - * and settings to meet specific IT standards.

- */ -export class Imagebuilder extends ImagebuilderClient { +const commands = { + CancelImageCreationCommand, + CreateComponentCommand, + CreateContainerRecipeCommand, + CreateDistributionConfigurationCommand, + CreateImageCommand, + CreateImagePipelineCommand, + CreateImageRecipeCommand, + CreateInfrastructureConfigurationCommand, + DeleteComponentCommand, + DeleteContainerRecipeCommand, + DeleteDistributionConfigurationCommand, + DeleteImageCommand, + DeleteImagePipelineCommand, + DeleteImageRecipeCommand, + DeleteInfrastructureConfigurationCommand, + GetComponentCommand, + GetComponentPolicyCommand, + GetContainerRecipeCommand, + GetContainerRecipePolicyCommand, + GetDistributionConfigurationCommand, + GetImageCommand, + GetImagePipelineCommand, + GetImagePolicyCommand, + GetImageRecipeCommand, + GetImageRecipePolicyCommand, + GetInfrastructureConfigurationCommand, + GetWorkflowExecutionCommand, + GetWorkflowStepExecutionCommand, + ImportComponentCommand, + ImportVmImageCommand, + ListComponentBuildVersionsCommand, + ListComponentsCommand, + ListContainerRecipesCommand, + ListDistributionConfigurationsCommand, + ListImageBuildVersionsCommand, + ListImagePackagesCommand, + ListImagePipelineImagesCommand, + ListImagePipelinesCommand, + ListImageRecipesCommand, + ListImagesCommand, + ListImageScanFindingAggregationsCommand, + ListImageScanFindingsCommand, + ListInfrastructureConfigurationsCommand, + ListTagsForResourceCommand, + ListWorkflowExecutionsCommand, + ListWorkflowStepExecutionsCommand, + PutComponentPolicyCommand, + PutContainerRecipePolicyCommand, + PutImagePolicyCommand, + PutImageRecipePolicyCommand, + StartImagePipelineExecutionCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateDistributionConfigurationCommand, + UpdateImagePipelineCommand, + UpdateInfrastructureConfigurationCommand, +}; + +export interface Imagebuilder { /** - * @public - *

CancelImageCreation cancels the creation of Image. This operation can only be used on - * images in a non-terminal state.

+ * @see {@link CancelImageCreationCommand} */ - public cancelImageCreation( + cancelImageCreation( args: CancelImageCreationCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelImageCreation( + cancelImageCreation( args: CancelImageCreationCommandInput, cb: (err: any, data?: CancelImageCreationCommandOutput) => void ): void; - public cancelImageCreation( + cancelImageCreation( args: CancelImageCreationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelImageCreationCommandOutput) => void ): void; - public cancelImageCreation( - args: CancelImageCreationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelImageCreationCommandOutput) => void), - cb?: (err: any, data?: CancelImageCreationCommandOutput) => void - ): Promise | void { - const command = new CancelImageCreationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new component that can be used to build, validate, test, and assess your - * image. The component is based on a YAML document that you specify using exactly one of - * the following methods:

- *
    - *
  • - *

    Inline, using the data property in the request body.

    - *
  • - *
  • - *

    A URL that points to a YAML document file stored in Amazon S3, using the - * uri property in the request body.

    - *
  • - *
+ * @see {@link CreateComponentCommand} */ - public createComponent( + createComponent( args: CreateComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createComponent( - args: CreateComponentCommandInput, - cb: (err: any, data?: CreateComponentCommandOutput) => void - ): void; - public createComponent( + createComponent(args: CreateComponentCommandInput, cb: (err: any, data?: CreateComponentCommandOutput) => void): void; + createComponent( args: CreateComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateComponentCommandOutput) => void ): void; - public createComponent( - args: CreateComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateComponentCommandOutput) => void), - cb?: (err: any, data?: CreateComponentCommandOutput) => void - ): Promise | void { - const command = new CreateComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new container recipe. Container recipes define how images are configured, - * tested, and assessed.

+ * @see {@link CreateContainerRecipeCommand} */ - public createContainerRecipe( + createContainerRecipe( args: CreateContainerRecipeCommandInput, options?: __HttpHandlerOptions ): Promise; - public createContainerRecipe( + createContainerRecipe( args: CreateContainerRecipeCommandInput, cb: (err: any, data?: CreateContainerRecipeCommandOutput) => void ): void; - public createContainerRecipe( + createContainerRecipe( args: CreateContainerRecipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateContainerRecipeCommandOutput) => void ): void; - public createContainerRecipe( - args: CreateContainerRecipeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateContainerRecipeCommandOutput) => void), - cb?: (err: any, data?: CreateContainerRecipeCommandOutput) => void - ): Promise | void { - const command = new CreateContainerRecipeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new distribution configuration. Distribution configurations define and - * configure the outputs of your pipeline.

+ * @see {@link CreateDistributionConfigurationCommand} */ - public createDistributionConfiguration( + createDistributionConfiguration( args: CreateDistributionConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDistributionConfiguration( + createDistributionConfiguration( args: CreateDistributionConfigurationCommandInput, cb: (err: any, data?: CreateDistributionConfigurationCommandOutput) => void ): void; - public createDistributionConfiguration( + createDistributionConfiguration( args: CreateDistributionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDistributionConfigurationCommandOutput) => void ): void; - public createDistributionConfiguration( - args: CreateDistributionConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDistributionConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateDistributionConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateDistributionConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new image. This request will create a new image along with all of the - * configured output resources defined in the distribution configuration. You must specify - * exactly one recipe for your image, using either a ContainerRecipeArn or an - * ImageRecipeArn.

+ * @see {@link CreateImageCommand} */ - public createImage(args: CreateImageCommandInput, options?: __HttpHandlerOptions): Promise; - public createImage(args: CreateImageCommandInput, cb: (err: any, data?: CreateImageCommandOutput) => void): void; - public createImage( + createImage(args: CreateImageCommandInput, options?: __HttpHandlerOptions): Promise; + createImage(args: CreateImageCommandInput, cb: (err: any, data?: CreateImageCommandOutput) => void): void; + createImage( args: CreateImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateImageCommandOutput) => void ): void; - public createImage( - args: CreateImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateImageCommandOutput) => void), - cb?: (err: any, data?: CreateImageCommandOutput) => void - ): Promise | void { - const command = new CreateImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new image pipeline. Image pipelines enable you to automate the creation and - * distribution of images.

+ * @see {@link CreateImagePipelineCommand} */ - public createImagePipeline( + createImagePipeline( args: CreateImagePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public createImagePipeline( + createImagePipeline( args: CreateImagePipelineCommandInput, cb: (err: any, data?: CreateImagePipelineCommandOutput) => void ): void; - public createImagePipeline( + createImagePipeline( args: CreateImagePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateImagePipelineCommandOutput) => void ): void; - public createImagePipeline( - args: CreateImagePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateImagePipelineCommandOutput) => void), - cb?: (err: any, data?: CreateImagePipelineCommandOutput) => void - ): Promise | void { - const command = new CreateImagePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new image recipe. Image recipes define how images are configured, tested, - * and assessed.

+ * @see {@link CreateImageRecipeCommand} */ - public createImageRecipe( + createImageRecipe( args: CreateImageRecipeCommandInput, options?: __HttpHandlerOptions ): Promise; - public createImageRecipe( + createImageRecipe( args: CreateImageRecipeCommandInput, cb: (err: any, data?: CreateImageRecipeCommandOutput) => void ): void; - public createImageRecipe( + createImageRecipe( args: CreateImageRecipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateImageRecipeCommandOutput) => void ): void; - public createImageRecipe( - args: CreateImageRecipeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateImageRecipeCommandOutput) => void), - cb?: (err: any, data?: CreateImageRecipeCommandOutput) => void - ): Promise | void { - const command = new CreateImageRecipeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new infrastructure configuration. An infrastructure configuration defines - * the environment in which your image will be built and tested.

+ * @see {@link CreateInfrastructureConfigurationCommand} */ - public createInfrastructureConfiguration( + createInfrastructureConfiguration( args: CreateInfrastructureConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createInfrastructureConfiguration( + createInfrastructureConfiguration( args: CreateInfrastructureConfigurationCommandInput, cb: (err: any, data?: CreateInfrastructureConfigurationCommandOutput) => void ): void; - public createInfrastructureConfiguration( + createInfrastructureConfiguration( args: CreateInfrastructureConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInfrastructureConfigurationCommandOutput) => void ): void; - public createInfrastructureConfiguration( - args: CreateInfrastructureConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateInfrastructureConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateInfrastructureConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateInfrastructureConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a component build version.

+ * @see {@link DeleteComponentCommand} */ - public deleteComponent( + deleteComponent( args: DeleteComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteComponent( - args: DeleteComponentCommandInput, - cb: (err: any, data?: DeleteComponentCommandOutput) => void - ): void; - public deleteComponent( + deleteComponent(args: DeleteComponentCommandInput, cb: (err: any, data?: DeleteComponentCommandOutput) => void): void; + deleteComponent( args: DeleteComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteComponentCommandOutput) => void ): void; - public deleteComponent( - args: DeleteComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteComponentCommandOutput) => void), - cb?: (err: any, data?: DeleteComponentCommandOutput) => void - ): Promise | void { - const command = new DeleteComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a container recipe.

+ * @see {@link DeleteContainerRecipeCommand} */ - public deleteContainerRecipe( + deleteContainerRecipe( args: DeleteContainerRecipeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteContainerRecipe( + deleteContainerRecipe( args: DeleteContainerRecipeCommandInput, cb: (err: any, data?: DeleteContainerRecipeCommandOutput) => void ): void; - public deleteContainerRecipe( + deleteContainerRecipe( args: DeleteContainerRecipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteContainerRecipeCommandOutput) => void ): void; - public deleteContainerRecipe( - args: DeleteContainerRecipeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteContainerRecipeCommandOutput) => void), - cb?: (err: any, data?: DeleteContainerRecipeCommandOutput) => void - ): Promise | void { - const command = new DeleteContainerRecipeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a distribution configuration.

+ * @see {@link DeleteDistributionConfigurationCommand} */ - public deleteDistributionConfiguration( + deleteDistributionConfiguration( args: DeleteDistributionConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDistributionConfiguration( + deleteDistributionConfiguration( args: DeleteDistributionConfigurationCommandInput, cb: (err: any, data?: DeleteDistributionConfigurationCommandOutput) => void ): void; - public deleteDistributionConfiguration( + deleteDistributionConfiguration( args: DeleteDistributionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDistributionConfigurationCommandOutput) => void ): void; - public deleteDistributionConfiguration( - args: DeleteDistributionConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDistributionConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteDistributionConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteDistributionConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Image Builder image resource. This does not delete any EC2 AMIs or ECR container - * images that are created during the image build process. You must clean those up - * separately, using the appropriate Amazon EC2 or Amazon ECR console actions, or API or CLI - * commands.

- * + * @see {@link DeleteImageCommand} */ - public deleteImage(args: DeleteImageCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteImage(args: DeleteImageCommandInput, cb: (err: any, data?: DeleteImageCommandOutput) => void): void; - public deleteImage( + deleteImage(args: DeleteImageCommandInput, options?: __HttpHandlerOptions): Promise; + deleteImage(args: DeleteImageCommandInput, cb: (err: any, data?: DeleteImageCommandOutput) => void): void; + deleteImage( args: DeleteImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteImageCommandOutput) => void ): void; - public deleteImage( - args: DeleteImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteImageCommandOutput) => void), - cb?: (err: any, data?: DeleteImageCommandOutput) => void - ): Promise | void { - const command = new DeleteImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an image pipeline.

+ * @see {@link DeleteImagePipelineCommand} */ - public deleteImagePipeline( + deleteImagePipeline( args: DeleteImagePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteImagePipeline( + deleteImagePipeline( args: DeleteImagePipelineCommandInput, cb: (err: any, data?: DeleteImagePipelineCommandOutput) => void ): void; - public deleteImagePipeline( + deleteImagePipeline( args: DeleteImagePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteImagePipelineCommandOutput) => void ): void; - public deleteImagePipeline( - args: DeleteImagePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteImagePipelineCommandOutput) => void), - cb?: (err: any, data?: DeleteImagePipelineCommandOutput) => void - ): Promise | void { - const command = new DeleteImagePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an image recipe.

+ * @see {@link DeleteImageRecipeCommand} */ - public deleteImageRecipe( + deleteImageRecipe( args: DeleteImageRecipeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteImageRecipe( + deleteImageRecipe( args: DeleteImageRecipeCommandInput, cb: (err: any, data?: DeleteImageRecipeCommandOutput) => void ): void; - public deleteImageRecipe( + deleteImageRecipe( args: DeleteImageRecipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteImageRecipeCommandOutput) => void ): void; - public deleteImageRecipe( - args: DeleteImageRecipeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteImageRecipeCommandOutput) => void), - cb?: (err: any, data?: DeleteImageRecipeCommandOutput) => void - ): Promise | void { - const command = new DeleteImageRecipeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an infrastructure configuration.

+ * @see {@link DeleteInfrastructureConfigurationCommand} */ - public deleteInfrastructureConfiguration( + deleteInfrastructureConfiguration( args: DeleteInfrastructureConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInfrastructureConfiguration( + deleteInfrastructureConfiguration( args: DeleteInfrastructureConfigurationCommandInput, cb: (err: any, data?: DeleteInfrastructureConfigurationCommandOutput) => void ): void; - public deleteInfrastructureConfiguration( + deleteInfrastructureConfiguration( args: DeleteInfrastructureConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInfrastructureConfigurationCommandOutput) => void ): void; - public deleteInfrastructureConfiguration( - args: DeleteInfrastructureConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInfrastructureConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteInfrastructureConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteInfrastructureConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a component object.

+ * @see {@link GetComponentCommand} */ - public getComponent( - args: GetComponentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getComponent(args: GetComponentCommandInput, cb: (err: any, data?: GetComponentCommandOutput) => void): void; - public getComponent( + getComponent(args: GetComponentCommandInput, options?: __HttpHandlerOptions): Promise; + getComponent(args: GetComponentCommandInput, cb: (err: any, data?: GetComponentCommandOutput) => void): void; + getComponent( args: GetComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComponentCommandOutput) => void ): void; - public getComponent( - args: GetComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetComponentCommandOutput) => void), - cb?: (err: any, data?: GetComponentCommandOutput) => void - ): Promise | void { - const command = new GetComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a component policy.

+ * @see {@link GetComponentPolicyCommand} */ - public getComponentPolicy( + getComponentPolicy( args: GetComponentPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getComponentPolicy( + getComponentPolicy( args: GetComponentPolicyCommandInput, cb: (err: any, data?: GetComponentPolicyCommandOutput) => void ): void; - public getComponentPolicy( + getComponentPolicy( args: GetComponentPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComponentPolicyCommandOutput) => void ): void; - public getComponentPolicy( - args: GetComponentPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetComponentPolicyCommandOutput) => void), - cb?: (err: any, data?: GetComponentPolicyCommandOutput) => void - ): Promise | void { - const command = new GetComponentPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a container recipe.

+ * @see {@link GetContainerRecipeCommand} */ - public getContainerRecipe( + getContainerRecipe( args: GetContainerRecipeCommandInput, options?: __HttpHandlerOptions ): Promise; - public getContainerRecipe( + getContainerRecipe( args: GetContainerRecipeCommandInput, cb: (err: any, data?: GetContainerRecipeCommandOutput) => void ): void; - public getContainerRecipe( + getContainerRecipe( args: GetContainerRecipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContainerRecipeCommandOutput) => void ): void; - public getContainerRecipe( - args: GetContainerRecipeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContainerRecipeCommandOutput) => void), - cb?: (err: any, data?: GetContainerRecipeCommandOutput) => void - ): Promise | void { - const command = new GetContainerRecipeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the policy for a container recipe.

+ * @see {@link GetContainerRecipePolicyCommand} */ - public getContainerRecipePolicy( + getContainerRecipePolicy( args: GetContainerRecipePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getContainerRecipePolicy( + getContainerRecipePolicy( args: GetContainerRecipePolicyCommandInput, cb: (err: any, data?: GetContainerRecipePolicyCommandOutput) => void ): void; - public getContainerRecipePolicy( + getContainerRecipePolicy( args: GetContainerRecipePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContainerRecipePolicyCommandOutput) => void ): void; - public getContainerRecipePolicy( - args: GetContainerRecipePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContainerRecipePolicyCommandOutput) => void), - cb?: (err: any, data?: GetContainerRecipePolicyCommandOutput) => void - ): Promise | void { - const command = new GetContainerRecipePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a distribution configuration.

+ * @see {@link GetDistributionConfigurationCommand} */ - public getDistributionConfiguration( + getDistributionConfiguration( args: GetDistributionConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDistributionConfiguration( + getDistributionConfiguration( args: GetDistributionConfigurationCommandInput, cb: (err: any, data?: GetDistributionConfigurationCommandOutput) => void ): void; - public getDistributionConfiguration( + getDistributionConfiguration( args: GetDistributionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDistributionConfigurationCommandOutput) => void ): void; - public getDistributionConfiguration( - args: GetDistributionConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDistributionConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetDistributionConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetDistributionConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets an image.

+ * @see {@link GetImageCommand} */ - public getImage(args: GetImageCommandInput, options?: __HttpHandlerOptions): Promise; - public getImage(args: GetImageCommandInput, cb: (err: any, data?: GetImageCommandOutput) => void): void; - public getImage( + getImage(args: GetImageCommandInput, options?: __HttpHandlerOptions): Promise; + getImage(args: GetImageCommandInput, cb: (err: any, data?: GetImageCommandOutput) => void): void; + getImage( args: GetImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetImageCommandOutput) => void ): void; - public getImage( - args: GetImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetImageCommandOutput) => void), - cb?: (err: any, data?: GetImageCommandOutput) => void - ): Promise | void { - const command = new GetImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets an image pipeline.

+ * @see {@link GetImagePipelineCommand} */ - public getImagePipeline( + getImagePipeline( args: GetImagePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public getImagePipeline( + getImagePipeline( args: GetImagePipelineCommandInput, cb: (err: any, data?: GetImagePipelineCommandOutput) => void ): void; - public getImagePipeline( + getImagePipeline( args: GetImagePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetImagePipelineCommandOutput) => void ): void; - public getImagePipeline( - args: GetImagePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetImagePipelineCommandOutput) => void), - cb?: (err: any, data?: GetImagePipelineCommandOutput) => void - ): Promise | void { - const command = new GetImagePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets an image policy.

+ * @see {@link GetImagePolicyCommand} */ - public getImagePolicy( + getImagePolicy( args: GetImagePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getImagePolicy( - args: GetImagePolicyCommandInput, - cb: (err: any, data?: GetImagePolicyCommandOutput) => void - ): void; - public getImagePolicy( + getImagePolicy(args: GetImagePolicyCommandInput, cb: (err: any, data?: GetImagePolicyCommandOutput) => void): void; + getImagePolicy( args: GetImagePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetImagePolicyCommandOutput) => void ): void; - public getImagePolicy( - args: GetImagePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetImagePolicyCommandOutput) => void), - cb?: (err: any, data?: GetImagePolicyCommandOutput) => void - ): Promise | void { - const command = new GetImagePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets an image recipe.

+ * @see {@link GetImageRecipeCommand} */ - public getImageRecipe( + getImageRecipe( args: GetImageRecipeCommandInput, options?: __HttpHandlerOptions ): Promise; - public getImageRecipe( - args: GetImageRecipeCommandInput, - cb: (err: any, data?: GetImageRecipeCommandOutput) => void - ): void; - public getImageRecipe( + getImageRecipe(args: GetImageRecipeCommandInput, cb: (err: any, data?: GetImageRecipeCommandOutput) => void): void; + getImageRecipe( args: GetImageRecipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetImageRecipeCommandOutput) => void ): void; - public getImageRecipe( - args: GetImageRecipeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetImageRecipeCommandOutput) => void), - cb?: (err: any, data?: GetImageRecipeCommandOutput) => void - ): Promise | void { - const command = new GetImageRecipeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets an image recipe policy.

+ * @see {@link GetImageRecipePolicyCommand} */ - public getImageRecipePolicy( + getImageRecipePolicy( args: GetImageRecipePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getImageRecipePolicy( + getImageRecipePolicy( args: GetImageRecipePolicyCommandInput, cb: (err: any, data?: GetImageRecipePolicyCommandOutput) => void ): void; - public getImageRecipePolicy( + getImageRecipePolicy( args: GetImageRecipePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetImageRecipePolicyCommandOutput) => void ): void; - public getImageRecipePolicy( - args: GetImageRecipePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetImageRecipePolicyCommandOutput) => void), - cb?: (err: any, data?: GetImageRecipePolicyCommandOutput) => void - ): Promise | void { - const command = new GetImageRecipePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets an infrastructure configuration.

+ * @see {@link GetInfrastructureConfigurationCommand} */ - public getInfrastructureConfiguration( + getInfrastructureConfiguration( args: GetInfrastructureConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInfrastructureConfiguration( + getInfrastructureConfiguration( args: GetInfrastructureConfigurationCommandInput, cb: (err: any, data?: GetInfrastructureConfigurationCommandOutput) => void ): void; - public getInfrastructureConfiguration( + getInfrastructureConfiguration( args: GetInfrastructureConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInfrastructureConfigurationCommandOutput) => void ): void; - public getInfrastructureConfiguration( - args: GetInfrastructureConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInfrastructureConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetInfrastructureConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetInfrastructureConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the runtime information that was logged for a specific runtime instance - * of the workflow.

+ * @see {@link GetWorkflowExecutionCommand} */ - public getWorkflowExecution( + getWorkflowExecution( args: GetWorkflowExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWorkflowExecution( + getWorkflowExecution( args: GetWorkflowExecutionCommandInput, cb: (err: any, data?: GetWorkflowExecutionCommandOutput) => void ): void; - public getWorkflowExecution( + getWorkflowExecution( args: GetWorkflowExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkflowExecutionCommandOutput) => void ): void; - public getWorkflowExecution( - args: GetWorkflowExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkflowExecutionCommandOutput) => void), - cb?: (err: any, data?: GetWorkflowExecutionCommandOutput) => void - ): Promise | void { - const command = new GetWorkflowExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the runtime information that was logged for a specific runtime instance of - * the workflow step.

+ * @see {@link GetWorkflowStepExecutionCommand} */ - public getWorkflowStepExecution( + getWorkflowStepExecution( args: GetWorkflowStepExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWorkflowStepExecution( + getWorkflowStepExecution( args: GetWorkflowStepExecutionCommandInput, cb: (err: any, data?: GetWorkflowStepExecutionCommandOutput) => void ): void; - public getWorkflowStepExecution( + getWorkflowStepExecution( args: GetWorkflowStepExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkflowStepExecutionCommandOutput) => void ): void; - public getWorkflowStepExecution( - args: GetWorkflowStepExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkflowStepExecutionCommandOutput) => void), - cb?: (err: any, data?: GetWorkflowStepExecutionCommandOutput) => void - ): Promise | void { - const command = new GetWorkflowStepExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Imports a component and transforms its data into a component document.

+ * @see {@link ImportComponentCommand} */ - public importComponent( + importComponent( args: ImportComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public importComponent( - args: ImportComponentCommandInput, - cb: (err: any, data?: ImportComponentCommandOutput) => void - ): void; - public importComponent( + importComponent(args: ImportComponentCommandInput, cb: (err: any, data?: ImportComponentCommandOutput) => void): void; + importComponent( args: ImportComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportComponentCommandOutput) => void ): void; - public importComponent( - args: ImportComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportComponentCommandOutput) => void), - cb?: (err: any, data?: ImportComponentCommandOutput) => void - ): Promise | void { - const command = new ImportComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

When you export your virtual machine (VM) from its virtualization environment, that - * process creates a set of one or more disk container files that act as snapshots of your - * VM’s environment, settings, and data. The Amazon EC2 API ImportImage - * action uses those files to import your VM and create an AMI. To import using the CLI - * command, see import-image - *

- *

You can reference the task ID from the VM import to pull in the AMI that the import - * created as the base image for your Image Builder recipe.

+ * @see {@link ImportVmImageCommand} */ - public importVmImage( - args: ImportVmImageCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public importVmImage( - args: ImportVmImageCommandInput, - cb: (err: any, data?: ImportVmImageCommandOutput) => void - ): void; - public importVmImage( + importVmImage(args: ImportVmImageCommandInput, options?: __HttpHandlerOptions): Promise; + importVmImage(args: ImportVmImageCommandInput, cb: (err: any, data?: ImportVmImageCommandOutput) => void): void; + importVmImage( args: ImportVmImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportVmImageCommandOutput) => void ): void; - public importVmImage( - args: ImportVmImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportVmImageCommandOutput) => void), - cb?: (err: any, data?: ImportVmImageCommandOutput) => void - ): Promise | void { - const command = new ImportVmImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the list of component build versions for the specified semantic - * version.

- * - *

The semantic version has four nodes: ../. - * You can assign values for the first three, and can filter on all of them.

- *

- * Filtering: With semantic versioning, you have the flexibility to use wildcards (x) - * to specify the most recent versions or nodes when selecting the base image or components for your - * recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be - * wildcards.

- *
+ * @see {@link ListComponentBuildVersionsCommand} */ - public listComponentBuildVersions( + listComponentBuildVersions( args: ListComponentBuildVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listComponentBuildVersions( + listComponentBuildVersions( args: ListComponentBuildVersionsCommandInput, cb: (err: any, data?: ListComponentBuildVersionsCommandOutput) => void ): void; - public listComponentBuildVersions( + listComponentBuildVersions( args: ListComponentBuildVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComponentBuildVersionsCommandOutput) => void ): void; - public listComponentBuildVersions( - args: ListComponentBuildVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListComponentBuildVersionsCommandOutput) => void), - cb?: (err: any, data?: ListComponentBuildVersionsCommandOutput) => void - ): Promise | void { - const command = new ListComponentBuildVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the list of components that can be filtered by name, or by using the listed - * filters to streamline results. Newly created components can take up to - * two minutes to appear in the ListComponents API Results.

- * - *

The semantic version has four nodes: ../. - * You can assign values for the first three, and can filter on all of them.

- *

- * Filtering: With semantic versioning, you have the flexibility to use wildcards (x) - * to specify the most recent versions or nodes when selecting the base image or components for your - * recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be - * wildcards.

- *
+ * @see {@link ListComponentsCommand} */ - public listComponents( + listComponents( args: ListComponentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listComponents( - args: ListComponentsCommandInput, - cb: (err: any, data?: ListComponentsCommandOutput) => void - ): void; - public listComponents( + listComponents(args: ListComponentsCommandInput, cb: (err: any, data?: ListComponentsCommandOutput) => void): void; + listComponents( args: ListComponentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComponentsCommandOutput) => void ): void; - public listComponents( - args: ListComponentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListComponentsCommandOutput) => void), - cb?: (err: any, data?: ListComponentsCommandOutput) => void - ): Promise | void { - const command = new ListComponentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of container recipes.

+ * @see {@link ListContainerRecipesCommand} */ - public listContainerRecipes( + listContainerRecipes( args: ListContainerRecipesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listContainerRecipes( + listContainerRecipes( args: ListContainerRecipesCommandInput, cb: (err: any, data?: ListContainerRecipesCommandOutput) => void ): void; - public listContainerRecipes( + listContainerRecipes( args: ListContainerRecipesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListContainerRecipesCommandOutput) => void ): void; - public listContainerRecipes( - args: ListContainerRecipesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListContainerRecipesCommandOutput) => void), - cb?: (err: any, data?: ListContainerRecipesCommandOutput) => void - ): Promise | void { - const command = new ListContainerRecipesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of distribution configurations.

+ * @see {@link ListDistributionConfigurationsCommand} */ - public listDistributionConfigurations( + listDistributionConfigurations( args: ListDistributionConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDistributionConfigurations( + listDistributionConfigurations( args: ListDistributionConfigurationsCommandInput, cb: (err: any, data?: ListDistributionConfigurationsCommandOutput) => void ): void; - public listDistributionConfigurations( + listDistributionConfigurations( args: ListDistributionConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDistributionConfigurationsCommandOutput) => void ): void; - public listDistributionConfigurations( - args: ListDistributionConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDistributionConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListDistributionConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListDistributionConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of image build versions.

+ * @see {@link ListImageBuildVersionsCommand} */ - public listImageBuildVersions( + listImageBuildVersions( args: ListImageBuildVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listImageBuildVersions( + listImageBuildVersions( args: ListImageBuildVersionsCommandInput, cb: (err: any, data?: ListImageBuildVersionsCommandOutput) => void ): void; - public listImageBuildVersions( + listImageBuildVersions( args: ListImageBuildVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImageBuildVersionsCommandOutput) => void ): void; - public listImageBuildVersions( - args: ListImageBuildVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListImageBuildVersionsCommandOutput) => void), - cb?: (err: any, data?: ListImageBuildVersionsCommandOutput) => void - ): Promise | void { - const command = new ListImageBuildVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the Packages that are associated with an Image Build Version, as determined by - * Amazon Web Services Systems Manager Inventory at build time.

+ * @see {@link ListImagePackagesCommand} */ - public listImagePackages( + listImagePackages( args: ListImagePackagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listImagePackages( + listImagePackages( args: ListImagePackagesCommandInput, cb: (err: any, data?: ListImagePackagesCommandOutput) => void ): void; - public listImagePackages( + listImagePackages( args: ListImagePackagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImagePackagesCommandOutput) => void ): void; - public listImagePackages( - args: ListImagePackagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListImagePackagesCommandOutput) => void), - cb?: (err: any, data?: ListImagePackagesCommandOutput) => void - ): Promise | void { - const command = new ListImagePackagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of images created by the specified pipeline.

+ * @see {@link ListImagePipelineImagesCommand} */ - public listImagePipelineImages( + listImagePipelineImages( args: ListImagePipelineImagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listImagePipelineImages( + listImagePipelineImages( args: ListImagePipelineImagesCommandInput, cb: (err: any, data?: ListImagePipelineImagesCommandOutput) => void ): void; - public listImagePipelineImages( + listImagePipelineImages( args: ListImagePipelineImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImagePipelineImagesCommandOutput) => void ): void; - public listImagePipelineImages( - args: ListImagePipelineImagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListImagePipelineImagesCommandOutput) => void), - cb?: (err: any, data?: ListImagePipelineImagesCommandOutput) => void - ): Promise | void { - const command = new ListImagePipelineImagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of image pipelines.

+ * @see {@link ListImagePipelinesCommand} */ - public listImagePipelines( + listImagePipelines( args: ListImagePipelinesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listImagePipelines( + listImagePipelines( args: ListImagePipelinesCommandInput, cb: (err: any, data?: ListImagePipelinesCommandOutput) => void ): void; - public listImagePipelines( + listImagePipelines( args: ListImagePipelinesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImagePipelinesCommandOutput) => void ): void; - public listImagePipelines( - args: ListImagePipelinesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListImagePipelinesCommandOutput) => void), - cb?: (err: any, data?: ListImagePipelinesCommandOutput) => void - ): Promise | void { - const command = new ListImagePipelinesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of image recipes.

+ * @see {@link ListImageRecipesCommand} */ - public listImageRecipes( + listImageRecipes( args: ListImageRecipesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listImageRecipes( + listImageRecipes( args: ListImageRecipesCommandInput, cb: (err: any, data?: ListImageRecipesCommandOutput) => void ): void; - public listImageRecipes( + listImageRecipes( args: ListImageRecipesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImageRecipesCommandOutput) => void ): void; - public listImageRecipes( - args: ListImageRecipesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListImageRecipesCommandOutput) => void), - cb?: (err: any, data?: ListImageRecipesCommandOutput) => void - ): Promise | void { - const command = new ListImageRecipesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the list of images that you have access to. Newly created images can take up - * to two minutes to appear in the ListImages API Results.

+ * @see {@link ListImagesCommand} */ - public listImages(args: ListImagesCommandInput, options?: __HttpHandlerOptions): Promise; - public listImages(args: ListImagesCommandInput, cb: (err: any, data?: ListImagesCommandOutput) => void): void; - public listImages( + listImages(args: ListImagesCommandInput, options?: __HttpHandlerOptions): Promise; + listImages(args: ListImagesCommandInput, cb: (err: any, data?: ListImagesCommandOutput) => void): void; + listImages( args: ListImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImagesCommandOutput) => void ): void; - public listImages( - args: ListImagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListImagesCommandOutput) => void), - cb?: (err: any, data?: ListImagesCommandOutput) => void - ): Promise | void { - const command = new ListImagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of image scan aggregations for your account. You can filter by the type - * of key that Image Builder uses to group results. For example, if you want to get a list of - * findings by severity level for one of your pipelines, you might specify your pipeline - * with the imagePipelineArn filter. If you don't specify a filter, Image Builder - * returns an aggregation for your account.

- *

To streamline results, you can use the following filters in your request:

- *
    - *
  • - *

    - * accountId - *

    - *
  • - *
  • - *

    - * imageBuildVersionArn - *

    - *
  • - *
  • - *

    - * imagePipelineArn - *

    - *
  • - *
  • - *

    - * vulnerabilityId - *

    - *
  • - *
+ * @see {@link ListImageScanFindingAggregationsCommand} */ - public listImageScanFindingAggregations( + listImageScanFindingAggregations( args: ListImageScanFindingAggregationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listImageScanFindingAggregations( + listImageScanFindingAggregations( args: ListImageScanFindingAggregationsCommandInput, cb: (err: any, data?: ListImageScanFindingAggregationsCommandOutput) => void ): void; - public listImageScanFindingAggregations( + listImageScanFindingAggregations( args: ListImageScanFindingAggregationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImageScanFindingAggregationsCommandOutput) => void ): void; - public listImageScanFindingAggregations( - args: ListImageScanFindingAggregationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListImageScanFindingAggregationsCommandOutput) => void), - cb?: (err: any, data?: ListImageScanFindingAggregationsCommandOutput) => void - ): Promise | void { - const command = new ListImageScanFindingAggregationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of image scan findings for your account.

+ * @see {@link ListImageScanFindingsCommand} */ - public listImageScanFindings( + listImageScanFindings( args: ListImageScanFindingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listImageScanFindings( + listImageScanFindings( args: ListImageScanFindingsCommandInput, cb: (err: any, data?: ListImageScanFindingsCommandOutput) => void ): void; - public listImageScanFindings( + listImageScanFindings( args: ListImageScanFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImageScanFindingsCommandOutput) => void ): void; - public listImageScanFindings( - args: ListImageScanFindingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListImageScanFindingsCommandOutput) => void), - cb?: (err: any, data?: ListImageScanFindingsCommandOutput) => void - ): Promise | void { - const command = new ListImageScanFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of infrastructure configurations.

+ * @see {@link ListInfrastructureConfigurationsCommand} */ - public listInfrastructureConfigurations( + listInfrastructureConfigurations( args: ListInfrastructureConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInfrastructureConfigurations( + listInfrastructureConfigurations( args: ListInfrastructureConfigurationsCommandInput, cb: (err: any, data?: ListInfrastructureConfigurationsCommandOutput) => void ): void; - public listInfrastructureConfigurations( + listInfrastructureConfigurations( args: ListInfrastructureConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInfrastructureConfigurationsCommandOutput) => void ): void; - public listInfrastructureConfigurations( - args: ListInfrastructureConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInfrastructureConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListInfrastructureConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListInfrastructureConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the list of tags for the specified resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of workflow runtime instance metadata objects for a specific image build - * version.

+ * @see {@link ListWorkflowExecutionsCommand} */ - public listWorkflowExecutions( + listWorkflowExecutions( args: ListWorkflowExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWorkflowExecutions( + listWorkflowExecutions( args: ListWorkflowExecutionsCommandInput, cb: (err: any, data?: ListWorkflowExecutionsCommandOutput) => void ): void; - public listWorkflowExecutions( + listWorkflowExecutions( args: ListWorkflowExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkflowExecutionsCommandOutput) => void ): void; - public listWorkflowExecutions( - args: ListWorkflowExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkflowExecutionsCommandOutput) => void), - cb?: (err: any, data?: ListWorkflowExecutionsCommandOutput) => void - ): Promise | void { - const command = new ListWorkflowExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Shows runtime data for each step in a runtime instance of the workflow - * that you specify in the request.

+ * @see {@link ListWorkflowStepExecutionsCommand} */ - public listWorkflowStepExecutions( + listWorkflowStepExecutions( args: ListWorkflowStepExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWorkflowStepExecutions( + listWorkflowStepExecutions( args: ListWorkflowStepExecutionsCommandInput, cb: (err: any, data?: ListWorkflowStepExecutionsCommandOutput) => void ): void; - public listWorkflowStepExecutions( + listWorkflowStepExecutions( args: ListWorkflowStepExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkflowStepExecutionsCommandOutput) => void ): void; - public listWorkflowStepExecutions( - args: ListWorkflowStepExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkflowStepExecutionsCommandOutput) => void), - cb?: (err: any, data?: ListWorkflowStepExecutionsCommandOutput) => void - ): Promise | void { - const command = new ListWorkflowStepExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Applies a policy to a component. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API - * PutComponentPolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be - * visible to all principals with whom the resource is shared.

+ * @see {@link PutComponentPolicyCommand} */ - public putComponentPolicy( + putComponentPolicy( args: PutComponentPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putComponentPolicy( + putComponentPolicy( args: PutComponentPolicyCommandInput, cb: (err: any, data?: PutComponentPolicyCommandOutput) => void ): void; - public putComponentPolicy( + putComponentPolicy( args: PutComponentPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutComponentPolicyCommandOutput) => void ): void; - public putComponentPolicy( - args: PutComponentPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutComponentPolicyCommandOutput) => void), - cb?: (err: any, data?: PutComponentPolicyCommandOutput) => void - ): Promise | void { - const command = new PutComponentPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Applies a policy to a container image. We recommend that you call the RAM API - * CreateResourceShare - * (https://docs.aws.amazon.com//ram/latest/APIReference/API_CreateResourceShare.html) to share - * resources. If you call the Image Builder API PutContainerImagePolicy, you must also - * call the RAM API PromoteResourceShareCreatedFromPolicy - * (https://docs.aws.amazon.com//ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) - * in order for the resource to be visible to all principals with whom the resource is - * shared.

+ * @see {@link PutContainerRecipePolicyCommand} */ - public putContainerRecipePolicy( + putContainerRecipePolicy( args: PutContainerRecipePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putContainerRecipePolicy( + putContainerRecipePolicy( args: PutContainerRecipePolicyCommandInput, cb: (err: any, data?: PutContainerRecipePolicyCommandOutput) => void ): void; - public putContainerRecipePolicy( + putContainerRecipePolicy( args: PutContainerRecipePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutContainerRecipePolicyCommandOutput) => void ): void; - public putContainerRecipePolicy( - args: PutContainerRecipePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutContainerRecipePolicyCommandOutput) => void), - cb?: (err: any, data?: PutContainerRecipePolicyCommandOutput) => void - ): Promise | void { - const command = new PutContainerRecipePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Applies a policy to an image. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API - * PutImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be - * visible to all principals with whom the resource is shared.

+ * @see {@link PutImagePolicyCommand} */ - public putImagePolicy( + putImagePolicy( args: PutImagePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putImagePolicy( - args: PutImagePolicyCommandInput, - cb: (err: any, data?: PutImagePolicyCommandOutput) => void - ): void; - public putImagePolicy( + putImagePolicy(args: PutImagePolicyCommandInput, cb: (err: any, data?: PutImagePolicyCommandOutput) => void): void; + putImagePolicy( args: PutImagePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutImagePolicyCommandOutput) => void ): void; - public putImagePolicy( - args: PutImagePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutImagePolicyCommandOutput) => void), - cb?: (err: any, data?: PutImagePolicyCommandOutput) => void - ): Promise | void { - const command = new PutImagePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Applies a policy to an image recipe. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API - * PutImageRecipePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be - * visible to all principals with whom the resource is shared.

+ * @see {@link PutImageRecipePolicyCommand} */ - public putImageRecipePolicy( + putImageRecipePolicy( args: PutImageRecipePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putImageRecipePolicy( + putImageRecipePolicy( args: PutImageRecipePolicyCommandInput, cb: (err: any, data?: PutImageRecipePolicyCommandOutput) => void ): void; - public putImageRecipePolicy( + putImageRecipePolicy( args: PutImageRecipePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutImageRecipePolicyCommandOutput) => void ): void; - public putImageRecipePolicy( - args: PutImageRecipePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutImageRecipePolicyCommandOutput) => void), - cb?: (err: any, data?: PutImageRecipePolicyCommandOutput) => void - ): Promise | void { - const command = new PutImageRecipePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Manually triggers a pipeline to create an image.

+ * @see {@link StartImagePipelineExecutionCommand} */ - public startImagePipelineExecution( + startImagePipelineExecution( args: StartImagePipelineExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startImagePipelineExecution( + startImagePipelineExecution( args: StartImagePipelineExecutionCommandInput, cb: (err: any, data?: StartImagePipelineExecutionCommandOutput) => void ): void; - public startImagePipelineExecution( + startImagePipelineExecution( args: StartImagePipelineExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartImagePipelineExecutionCommandOutput) => void ): void; - public startImagePipelineExecution( - args: StartImagePipelineExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartImagePipelineExecutionCommandOutput) => void), - cb?: (err: any, data?: StartImagePipelineExecutionCommandOutput) => void - ): Promise | void { - const command = new StartImagePipelineExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a tag to a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a tag from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a new distribution configuration. Distribution configurations define and - * configure the outputs of your pipeline.

+ * @see {@link UpdateDistributionConfigurationCommand} */ - public updateDistributionConfiguration( + updateDistributionConfiguration( args: UpdateDistributionConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDistributionConfiguration( + updateDistributionConfiguration( args: UpdateDistributionConfigurationCommandInput, cb: (err: any, data?: UpdateDistributionConfigurationCommandOutput) => void ): void; - public updateDistributionConfiguration( + updateDistributionConfiguration( args: UpdateDistributionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDistributionConfigurationCommandOutput) => void ): void; - public updateDistributionConfiguration( - args: UpdateDistributionConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDistributionConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateDistributionConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateDistributionConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an image pipeline. Image pipelines enable you to automate the creation and - * distribution of images.

- * - *

UpdateImagePipeline does not support selective updates for the pipeline. You must - * specify all of the required properties in the update request, not just the - * properties that have changed.

- *
+ * @see {@link UpdateImagePipelineCommand} */ - public updateImagePipeline( + updateImagePipeline( args: UpdateImagePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateImagePipeline( + updateImagePipeline( args: UpdateImagePipelineCommandInput, cb: (err: any, data?: UpdateImagePipelineCommandOutput) => void ): void; - public updateImagePipeline( + updateImagePipeline( args: UpdateImagePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateImagePipelineCommandOutput) => void ): void; - public updateImagePipeline( - args: UpdateImagePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateImagePipelineCommandOutput) => void), - cb?: (err: any, data?: UpdateImagePipelineCommandOutput) => void - ): Promise | void { - const command = new UpdateImagePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a new infrastructure configuration. An infrastructure configuration defines - * the environment in which your image will be built and tested.

+ * @see {@link UpdateInfrastructureConfigurationCommand} */ - public updateInfrastructureConfiguration( + updateInfrastructureConfiguration( args: UpdateInfrastructureConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateInfrastructureConfiguration( + updateInfrastructureConfiguration( args: UpdateInfrastructureConfigurationCommandInput, cb: (err: any, data?: UpdateInfrastructureConfigurationCommandOutput) => void ): void; - public updateInfrastructureConfiguration( + updateInfrastructureConfiguration( args: UpdateInfrastructureConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateInfrastructureConfigurationCommandOutput) => void ): void; - public updateInfrastructureConfiguration( - args: UpdateInfrastructureConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateInfrastructureConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateInfrastructureConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateInfrastructureConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the + * creation, management, and deployment of customized, secure, and up-to-date + * "golden" server images that are pre-installed and pre-configured with software + * and settings to meet specific IT standards.

+ */ +export class Imagebuilder extends ImagebuilderClient implements Imagebuilder {} +createAggregatedClient(commands, Imagebuilder); diff --git a/clients/client-inspector/src/Inspector.ts b/clients/client-inspector/src/Inspector.ts index a680a3bd5aa7..df036d861a26 100644 --- a/clients/client-inspector/src/Inspector.ts +++ b/clients/client-inspector/src/Inspector.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -186,1279 +187,670 @@ import { UpdateAssessmentTargetCommandInput, UpdateAssessmentTargetCommandOutput, } from "./commands/UpdateAssessmentTargetCommand"; -import { InspectorClient } from "./InspectorClient"; +import { InspectorClient, InspectorClientConfig } from "./InspectorClient"; -/** - * @public - * Amazon Inspector - *

Amazon Inspector enables you to analyze the behavior of your AWS resources and to - * identify potential security issues. For more information, see Amazon Inspector User - * Guide.

- */ -export class Inspector extends InspectorClient { +const commands = { + AddAttributesToFindingsCommand, + CreateAssessmentTargetCommand, + CreateAssessmentTemplateCommand, + CreateExclusionsPreviewCommand, + CreateResourceGroupCommand, + DeleteAssessmentRunCommand, + DeleteAssessmentTargetCommand, + DeleteAssessmentTemplateCommand, + DescribeAssessmentRunsCommand, + DescribeAssessmentTargetsCommand, + DescribeAssessmentTemplatesCommand, + DescribeCrossAccountAccessRoleCommand, + DescribeExclusionsCommand, + DescribeFindingsCommand, + DescribeResourceGroupsCommand, + DescribeRulesPackagesCommand, + GetAssessmentReportCommand, + GetExclusionsPreviewCommand, + GetTelemetryMetadataCommand, + ListAssessmentRunAgentsCommand, + ListAssessmentRunsCommand, + ListAssessmentTargetsCommand, + ListAssessmentTemplatesCommand, + ListEventSubscriptionsCommand, + ListExclusionsCommand, + ListFindingsCommand, + ListRulesPackagesCommand, + ListTagsForResourceCommand, + PreviewAgentsCommand, + RegisterCrossAccountAccessRoleCommand, + RemoveAttributesFromFindingsCommand, + SetTagsForResourceCommand, + StartAssessmentRunCommand, + StopAssessmentRunCommand, + SubscribeToEventCommand, + UnsubscribeFromEventCommand, + UpdateAssessmentTargetCommand, +}; + +export interface Inspector { /** - * @public - *

Assigns attributes (key and value pairs) to the findings that are specified by the - * ARNs of the findings.

+ * @see {@link AddAttributesToFindingsCommand} */ - public addAttributesToFindings( + addAttributesToFindings( args: AddAttributesToFindingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public addAttributesToFindings( + addAttributesToFindings( args: AddAttributesToFindingsCommandInput, cb: (err: any, data?: AddAttributesToFindingsCommandOutput) => void ): void; - public addAttributesToFindings( + addAttributesToFindings( args: AddAttributesToFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddAttributesToFindingsCommandOutput) => void ): void; - public addAttributesToFindings( - args: AddAttributesToFindingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddAttributesToFindingsCommandOutput) => void), - cb?: (err: any, data?: AddAttributesToFindingsCommandOutput) => void - ): Promise | void { - const command = new AddAttributesToFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new assessment target using the ARN of the resource group that is generated - * by CreateResourceGroup. If resourceGroupArn is not specified, all EC2 - * instances in the current AWS account and region are included in the assessment target. If - * the service-linked role isn’t already registered, this action also creates and - * registers a service-linked role to grant Amazon Inspector access to AWS Services needed to - * perform security assessments. You can create up to 50 assessment targets per AWS account. - * You can run up to 500 concurrent agents per AWS account. For more information, see - * Amazon Inspector Assessment Targets.

+ * @see {@link CreateAssessmentTargetCommand} */ - public createAssessmentTarget( + createAssessmentTarget( args: CreateAssessmentTargetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAssessmentTarget( + createAssessmentTarget( args: CreateAssessmentTargetCommandInput, cb: (err: any, data?: CreateAssessmentTargetCommandOutput) => void ): void; - public createAssessmentTarget( + createAssessmentTarget( args: CreateAssessmentTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAssessmentTargetCommandOutput) => void ): void; - public createAssessmentTarget( - args: CreateAssessmentTargetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAssessmentTargetCommandOutput) => void), - cb?: (err: any, data?: CreateAssessmentTargetCommandOutput) => void - ): Promise | void { - const command = new CreateAssessmentTargetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an assessment template for the assessment target that is specified by the ARN - * of the assessment target. If the service-linked role isn’t already registered, this action also creates and - * registers a service-linked role to grant Amazon Inspector access to AWS Services needed to - * perform security assessments.

+ * @see {@link CreateAssessmentTemplateCommand} */ - public createAssessmentTemplate( + createAssessmentTemplate( args: CreateAssessmentTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAssessmentTemplate( + createAssessmentTemplate( args: CreateAssessmentTemplateCommandInput, cb: (err: any, data?: CreateAssessmentTemplateCommandOutput) => void ): void; - public createAssessmentTemplate( + createAssessmentTemplate( args: CreateAssessmentTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAssessmentTemplateCommandOutput) => void ): void; - public createAssessmentTemplate( - args: CreateAssessmentTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAssessmentTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateAssessmentTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateAssessmentTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts the generation of an exclusions preview for the specified assessment template. - * The exclusions preview lists the potential exclusions (ExclusionPreview) that Inspector can - * detect before it runs the assessment.

+ * @see {@link CreateExclusionsPreviewCommand} */ - public createExclusionsPreview( + createExclusionsPreview( args: CreateExclusionsPreviewCommandInput, options?: __HttpHandlerOptions ): Promise; - public createExclusionsPreview( + createExclusionsPreview( args: CreateExclusionsPreviewCommandInput, cb: (err: any, data?: CreateExclusionsPreviewCommandOutput) => void ): void; - public createExclusionsPreview( + createExclusionsPreview( args: CreateExclusionsPreviewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExclusionsPreviewCommandOutput) => void ): void; - public createExclusionsPreview( - args: CreateExclusionsPreviewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateExclusionsPreviewCommandOutput) => void), - cb?: (err: any, data?: CreateExclusionsPreviewCommandOutput) => void - ): Promise | void { - const command = new CreateExclusionsPreviewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a resource group using the specified set of tags (key and value pairs) that - * are used to select the EC2 instances to be included in an Amazon Inspector assessment - * target. The created resource group is then used to create an Amazon Inspector assessment - * target. For more information, see CreateAssessmentTarget.

+ * @see {@link CreateResourceGroupCommand} */ - public createResourceGroup( + createResourceGroup( args: CreateResourceGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createResourceGroup( + createResourceGroup( args: CreateResourceGroupCommandInput, cb: (err: any, data?: CreateResourceGroupCommandOutput) => void ): void; - public createResourceGroup( + createResourceGroup( args: CreateResourceGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResourceGroupCommandOutput) => void ): void; - public createResourceGroup( - args: CreateResourceGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateResourceGroupCommandOutput) => void), - cb?: (err: any, data?: CreateResourceGroupCommandOutput) => void - ): Promise | void { - const command = new CreateResourceGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the assessment run that is specified by the ARN of the assessment - * run.

+ * @see {@link DeleteAssessmentRunCommand} */ - public deleteAssessmentRun( + deleteAssessmentRun( args: DeleteAssessmentRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAssessmentRun( + deleteAssessmentRun( args: DeleteAssessmentRunCommandInput, cb: (err: any, data?: DeleteAssessmentRunCommandOutput) => void ): void; - public deleteAssessmentRun( + deleteAssessmentRun( args: DeleteAssessmentRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAssessmentRunCommandOutput) => void ): void; - public deleteAssessmentRun( - args: DeleteAssessmentRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAssessmentRunCommandOutput) => void), - cb?: (err: any, data?: DeleteAssessmentRunCommandOutput) => void - ): Promise | void { - const command = new DeleteAssessmentRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the assessment target that is specified by the ARN of the assessment - * target.

+ * @see {@link DeleteAssessmentTargetCommand} */ - public deleteAssessmentTarget( + deleteAssessmentTarget( args: DeleteAssessmentTargetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAssessmentTarget( + deleteAssessmentTarget( args: DeleteAssessmentTargetCommandInput, cb: (err: any, data?: DeleteAssessmentTargetCommandOutput) => void ): void; - public deleteAssessmentTarget( + deleteAssessmentTarget( args: DeleteAssessmentTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAssessmentTargetCommandOutput) => void ): void; - public deleteAssessmentTarget( - args: DeleteAssessmentTargetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAssessmentTargetCommandOutput) => void), - cb?: (err: any, data?: DeleteAssessmentTargetCommandOutput) => void - ): Promise | void { - const command = new DeleteAssessmentTargetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the assessment template that is specified by the ARN of the assessment - * template.

+ * @see {@link DeleteAssessmentTemplateCommand} */ - public deleteAssessmentTemplate( + deleteAssessmentTemplate( args: DeleteAssessmentTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAssessmentTemplate( + deleteAssessmentTemplate( args: DeleteAssessmentTemplateCommandInput, cb: (err: any, data?: DeleteAssessmentTemplateCommandOutput) => void ): void; - public deleteAssessmentTemplate( + deleteAssessmentTemplate( args: DeleteAssessmentTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAssessmentTemplateCommandOutput) => void ): void; - public deleteAssessmentTemplate( - args: DeleteAssessmentTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAssessmentTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteAssessmentTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteAssessmentTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the assessment runs that are specified by the ARNs of the assessment - * runs.

+ * @see {@link DescribeAssessmentRunsCommand} */ - public describeAssessmentRuns( + describeAssessmentRuns( args: DescribeAssessmentRunsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAssessmentRuns( + describeAssessmentRuns( args: DescribeAssessmentRunsCommandInput, cb: (err: any, data?: DescribeAssessmentRunsCommandOutput) => void ): void; - public describeAssessmentRuns( + describeAssessmentRuns( args: DescribeAssessmentRunsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAssessmentRunsCommandOutput) => void ): void; - public describeAssessmentRuns( - args: DescribeAssessmentRunsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAssessmentRunsCommandOutput) => void), - cb?: (err: any, data?: DescribeAssessmentRunsCommandOutput) => void - ): Promise | void { - const command = new DescribeAssessmentRunsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the assessment targets that are specified by the ARNs of the assessment - * targets.

+ * @see {@link DescribeAssessmentTargetsCommand} */ - public describeAssessmentTargets( + describeAssessmentTargets( args: DescribeAssessmentTargetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAssessmentTargets( + describeAssessmentTargets( args: DescribeAssessmentTargetsCommandInput, cb: (err: any, data?: DescribeAssessmentTargetsCommandOutput) => void ): void; - public describeAssessmentTargets( + describeAssessmentTargets( args: DescribeAssessmentTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAssessmentTargetsCommandOutput) => void ): void; - public describeAssessmentTargets( - args: DescribeAssessmentTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAssessmentTargetsCommandOutput) => void), - cb?: (err: any, data?: DescribeAssessmentTargetsCommandOutput) => void - ): Promise | void { - const command = new DescribeAssessmentTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the assessment templates that are specified by the ARNs of the assessment - * templates.

+ * @see {@link DescribeAssessmentTemplatesCommand} */ - public describeAssessmentTemplates( + describeAssessmentTemplates( args: DescribeAssessmentTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAssessmentTemplates( + describeAssessmentTemplates( args: DescribeAssessmentTemplatesCommandInput, cb: (err: any, data?: DescribeAssessmentTemplatesCommandOutput) => void ): void; - public describeAssessmentTemplates( + describeAssessmentTemplates( args: DescribeAssessmentTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAssessmentTemplatesCommandOutput) => void ): void; - public describeAssessmentTemplates( - args: DescribeAssessmentTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAssessmentTemplatesCommandOutput) => void), - cb?: (err: any, data?: DescribeAssessmentTemplatesCommandOutput) => void - ): Promise | void { - const command = new DescribeAssessmentTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the IAM role that enables Amazon Inspector to access your AWS - * account.

+ * @see {@link DescribeCrossAccountAccessRoleCommand} */ - public describeCrossAccountAccessRole( + describeCrossAccountAccessRole( args: DescribeCrossAccountAccessRoleCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCrossAccountAccessRole( + describeCrossAccountAccessRole( args: DescribeCrossAccountAccessRoleCommandInput, cb: (err: any, data?: DescribeCrossAccountAccessRoleCommandOutput) => void ): void; - public describeCrossAccountAccessRole( + describeCrossAccountAccessRole( args: DescribeCrossAccountAccessRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCrossAccountAccessRoleCommandOutput) => void ): void; - public describeCrossAccountAccessRole( - args: DescribeCrossAccountAccessRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCrossAccountAccessRoleCommandOutput) => void), - cb?: (err: any, data?: DescribeCrossAccountAccessRoleCommandOutput) => void - ): Promise | void { - const command = new DescribeCrossAccountAccessRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the exclusions that are specified by the exclusions' ARNs.

+ * @see {@link DescribeExclusionsCommand} */ - public describeExclusions( + describeExclusions( args: DescribeExclusionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeExclusions( + describeExclusions( args: DescribeExclusionsCommandInput, cb: (err: any, data?: DescribeExclusionsCommandOutput) => void ): void; - public describeExclusions( + describeExclusions( args: DescribeExclusionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExclusionsCommandOutput) => void ): void; - public describeExclusions( - args: DescribeExclusionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeExclusionsCommandOutput) => void), - cb?: (err: any, data?: DescribeExclusionsCommandOutput) => void - ): Promise | void { - const command = new DescribeExclusionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the findings that are specified by the ARNs of the findings.

+ * @see {@link DescribeFindingsCommand} */ - public describeFindings( + describeFindings( args: DescribeFindingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFindings( + describeFindings( args: DescribeFindingsCommandInput, cb: (err: any, data?: DescribeFindingsCommandOutput) => void ): void; - public describeFindings( + describeFindings( args: DescribeFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFindingsCommandOutput) => void ): void; - public describeFindings( - args: DescribeFindingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFindingsCommandOutput) => void), - cb?: (err: any, data?: DescribeFindingsCommandOutput) => void - ): Promise | void { - const command = new DescribeFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the resource groups that are specified by the ARNs of the resource - * groups.

+ * @see {@link DescribeResourceGroupsCommand} */ - public describeResourceGroups( + describeResourceGroups( args: DescribeResourceGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeResourceGroups( + describeResourceGroups( args: DescribeResourceGroupsCommandInput, cb: (err: any, data?: DescribeResourceGroupsCommandOutput) => void ): void; - public describeResourceGroups( + describeResourceGroups( args: DescribeResourceGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeResourceGroupsCommandOutput) => void ): void; - public describeResourceGroups( - args: DescribeResourceGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeResourceGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeResourceGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeResourceGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the rules packages that are specified by the ARNs of the rules - * packages.

+ * @see {@link DescribeRulesPackagesCommand} */ - public describeRulesPackages( + describeRulesPackages( args: DescribeRulesPackagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRulesPackages( + describeRulesPackages( args: DescribeRulesPackagesCommandInput, cb: (err: any, data?: DescribeRulesPackagesCommandOutput) => void ): void; - public describeRulesPackages( + describeRulesPackages( args: DescribeRulesPackagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRulesPackagesCommandOutput) => void ): void; - public describeRulesPackages( - args: DescribeRulesPackagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRulesPackagesCommandOutput) => void), - cb?: (err: any, data?: DescribeRulesPackagesCommandOutput) => void - ): Promise | void { - const command = new DescribeRulesPackagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Produces an assessment report that includes detailed and comprehensive results of a - * specified assessment run.

+ * @see {@link GetAssessmentReportCommand} */ - public getAssessmentReport( + getAssessmentReport( args: GetAssessmentReportCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAssessmentReport( + getAssessmentReport( args: GetAssessmentReportCommandInput, cb: (err: any, data?: GetAssessmentReportCommandOutput) => void ): void; - public getAssessmentReport( + getAssessmentReport( args: GetAssessmentReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAssessmentReportCommandOutput) => void ): void; - public getAssessmentReport( - args: GetAssessmentReportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAssessmentReportCommandOutput) => void), - cb?: (err: any, data?: GetAssessmentReportCommandOutput) => void - ): Promise | void { - const command = new GetAssessmentReportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by - * the preview token. You can obtain the preview token by running the CreateExclusionsPreview - * API.

+ * @see {@link GetExclusionsPreviewCommand} */ - public getExclusionsPreview( + getExclusionsPreview( args: GetExclusionsPreviewCommandInput, options?: __HttpHandlerOptions ): Promise; - public getExclusionsPreview( + getExclusionsPreview( args: GetExclusionsPreviewCommandInput, cb: (err: any, data?: GetExclusionsPreviewCommandOutput) => void ): void; - public getExclusionsPreview( + getExclusionsPreview( args: GetExclusionsPreviewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExclusionsPreviewCommandOutput) => void ): void; - public getExclusionsPreview( - args: GetExclusionsPreviewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetExclusionsPreviewCommandOutput) => void), - cb?: (err: any, data?: GetExclusionsPreviewCommandOutput) => void - ): Promise | void { - const command = new GetExclusionsPreviewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Information about the data that is collected for the specified assessment - * run.

+ * @see {@link GetTelemetryMetadataCommand} */ - public getTelemetryMetadata( + getTelemetryMetadata( args: GetTelemetryMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTelemetryMetadata( + getTelemetryMetadata( args: GetTelemetryMetadataCommandInput, cb: (err: any, data?: GetTelemetryMetadataCommandOutput) => void ): void; - public getTelemetryMetadata( + getTelemetryMetadata( args: GetTelemetryMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTelemetryMetadataCommandOutput) => void ): void; - public getTelemetryMetadata( - args: GetTelemetryMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTelemetryMetadataCommandOutput) => void), - cb?: (err: any, data?: GetTelemetryMetadataCommandOutput) => void - ): Promise | void { - const command = new GetTelemetryMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the agents of the assessment runs that are specified by the ARNs of the - * assessment runs.

+ * @see {@link ListAssessmentRunAgentsCommand} */ - public listAssessmentRunAgents( + listAssessmentRunAgents( args: ListAssessmentRunAgentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssessmentRunAgents( + listAssessmentRunAgents( args: ListAssessmentRunAgentsCommandInput, cb: (err: any, data?: ListAssessmentRunAgentsCommandOutput) => void ): void; - public listAssessmentRunAgents( + listAssessmentRunAgents( args: ListAssessmentRunAgentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssessmentRunAgentsCommandOutput) => void ): void; - public listAssessmentRunAgents( - args: ListAssessmentRunAgentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssessmentRunAgentsCommandOutput) => void), - cb?: (err: any, data?: ListAssessmentRunAgentsCommandOutput) => void - ): Promise | void { - const command = new ListAssessmentRunAgentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the assessment runs that correspond to the assessment templates that are - * specified by the ARNs of the assessment templates.

+ * @see {@link ListAssessmentRunsCommand} */ - public listAssessmentRuns( + listAssessmentRuns( args: ListAssessmentRunsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssessmentRuns( + listAssessmentRuns( args: ListAssessmentRunsCommandInput, cb: (err: any, data?: ListAssessmentRunsCommandOutput) => void ): void; - public listAssessmentRuns( + listAssessmentRuns( args: ListAssessmentRunsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssessmentRunsCommandOutput) => void ): void; - public listAssessmentRuns( - args: ListAssessmentRunsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssessmentRunsCommandOutput) => void), - cb?: (err: any, data?: ListAssessmentRunsCommandOutput) => void - ): Promise | void { - const command = new ListAssessmentRunsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the ARNs of the assessment targets within this AWS account. For more - * information about assessment targets, see Amazon Inspector Assessment - * Targets.

+ * @see {@link ListAssessmentTargetsCommand} */ - public listAssessmentTargets( + listAssessmentTargets( args: ListAssessmentTargetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssessmentTargets( + listAssessmentTargets( args: ListAssessmentTargetsCommandInput, cb: (err: any, data?: ListAssessmentTargetsCommandOutput) => void ): void; - public listAssessmentTargets( + listAssessmentTargets( args: ListAssessmentTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssessmentTargetsCommandOutput) => void ): void; - public listAssessmentTargets( - args: ListAssessmentTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssessmentTargetsCommandOutput) => void), - cb?: (err: any, data?: ListAssessmentTargetsCommandOutput) => void - ): Promise | void { - const command = new ListAssessmentTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the assessment templates that correspond to the assessment targets that are - * specified by the ARNs of the assessment targets.

+ * @see {@link ListAssessmentTemplatesCommand} */ - public listAssessmentTemplates( + listAssessmentTemplates( args: ListAssessmentTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssessmentTemplates( + listAssessmentTemplates( args: ListAssessmentTemplatesCommandInput, cb: (err: any, data?: ListAssessmentTemplatesCommandOutput) => void ): void; - public listAssessmentTemplates( + listAssessmentTemplates( args: ListAssessmentTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssessmentTemplatesCommandOutput) => void ): void; - public listAssessmentTemplates( - args: ListAssessmentTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssessmentTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListAssessmentTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListAssessmentTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the event subscriptions for the assessment template that is specified by - * the ARN of the assessment template. For more information, see SubscribeToEvent and UnsubscribeFromEvent.

+ * @see {@link ListEventSubscriptionsCommand} */ - public listEventSubscriptions( + listEventSubscriptions( args: ListEventSubscriptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEventSubscriptions( + listEventSubscriptions( args: ListEventSubscriptionsCommandInput, cb: (err: any, data?: ListEventSubscriptionsCommandOutput) => void ): void; - public listEventSubscriptions( + listEventSubscriptions( args: ListEventSubscriptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventSubscriptionsCommandOutput) => void ): void; - public listEventSubscriptions( - args: ListEventSubscriptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEventSubscriptionsCommandOutput) => void), - cb?: (err: any, data?: ListEventSubscriptionsCommandOutput) => void - ): Promise | void { - const command = new ListEventSubscriptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List exclusions that are generated by the assessment run.

+ * @see {@link ListExclusionsCommand} */ - public listExclusions( + listExclusions( args: ListExclusionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listExclusions( - args: ListExclusionsCommandInput, - cb: (err: any, data?: ListExclusionsCommandOutput) => void - ): void; - public listExclusions( + listExclusions(args: ListExclusionsCommandInput, cb: (err: any, data?: ListExclusionsCommandOutput) => void): void; + listExclusions( args: ListExclusionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExclusionsCommandOutput) => void ): void; - public listExclusions( - args: ListExclusionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListExclusionsCommandOutput) => void), - cb?: (err: any, data?: ListExclusionsCommandOutput) => void - ): Promise | void { - const command = new ListExclusionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists findings that are generated by the assessment runs that are specified by the - * ARNs of the assessment runs.

+ * @see {@link ListFindingsCommand} */ - public listFindings( - args: ListFindingsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listFindings(args: ListFindingsCommandInput, cb: (err: any, data?: ListFindingsCommandOutput) => void): void; - public listFindings( + listFindings(args: ListFindingsCommandInput, options?: __HttpHandlerOptions): Promise; + listFindings(args: ListFindingsCommandInput, cb: (err: any, data?: ListFindingsCommandOutput) => void): void; + listFindings( args: ListFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFindingsCommandOutput) => void ): void; - public listFindings( - args: ListFindingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFindingsCommandOutput) => void), - cb?: (err: any, data?: ListFindingsCommandOutput) => void - ): Promise | void { - const command = new ListFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all available Amazon Inspector rules packages.

+ * @see {@link ListRulesPackagesCommand} */ - public listRulesPackages( + listRulesPackages( args: ListRulesPackagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRulesPackages( + listRulesPackages( args: ListRulesPackagesCommandInput, cb: (err: any, data?: ListRulesPackagesCommandOutput) => void ): void; - public listRulesPackages( + listRulesPackages( args: ListRulesPackagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRulesPackagesCommandOutput) => void ): void; - public listRulesPackages( - args: ListRulesPackagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRulesPackagesCommandOutput) => void), - cb?: (err: any, data?: ListRulesPackagesCommandOutput) => void - ): Promise | void { - const command = new ListRulesPackagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all tags associated with an assessment template.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Previews the agents installed on the EC2 instances that are part of the specified - * assessment target.

+ * @see {@link PreviewAgentsCommand} */ - public previewAgents( - args: PreviewAgentsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public previewAgents( - args: PreviewAgentsCommandInput, - cb: (err: any, data?: PreviewAgentsCommandOutput) => void - ): void; - public previewAgents( + previewAgents(args: PreviewAgentsCommandInput, options?: __HttpHandlerOptions): Promise; + previewAgents(args: PreviewAgentsCommandInput, cb: (err: any, data?: PreviewAgentsCommandOutput) => void): void; + previewAgents( args: PreviewAgentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PreviewAgentsCommandOutput) => void ): void; - public previewAgents( - args: PreviewAgentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PreviewAgentsCommandOutput) => void), - cb?: (err: any, data?: PreviewAgentsCommandOutput) => void - ): Promise | void { - const command = new PreviewAgentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers the IAM role that grants Amazon Inspector access to AWS Services needed to - * perform security assessments.

+ * @see {@link RegisterCrossAccountAccessRoleCommand} */ - public registerCrossAccountAccessRole( + registerCrossAccountAccessRole( args: RegisterCrossAccountAccessRoleCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerCrossAccountAccessRole( + registerCrossAccountAccessRole( args: RegisterCrossAccountAccessRoleCommandInput, cb: (err: any, data?: RegisterCrossAccountAccessRoleCommandOutput) => void ): void; - public registerCrossAccountAccessRole( + registerCrossAccountAccessRole( args: RegisterCrossAccountAccessRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterCrossAccountAccessRoleCommandOutput) => void ): void; - public registerCrossAccountAccessRole( - args: RegisterCrossAccountAccessRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterCrossAccountAccessRoleCommandOutput) => void), - cb?: (err: any, data?: RegisterCrossAccountAccessRoleCommandOutput) => void - ): Promise | void { - const command = new RegisterCrossAccountAccessRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes entire attributes (key and value pairs) from the findings that are specified - * by the ARNs of the findings where an attribute with the specified key exists.

+ * @see {@link RemoveAttributesFromFindingsCommand} */ - public removeAttributesFromFindings( + removeAttributesFromFindings( args: RemoveAttributesFromFindingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeAttributesFromFindings( + removeAttributesFromFindings( args: RemoveAttributesFromFindingsCommandInput, cb: (err: any, data?: RemoveAttributesFromFindingsCommandOutput) => void ): void; - public removeAttributesFromFindings( + removeAttributesFromFindings( args: RemoveAttributesFromFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveAttributesFromFindingsCommandOutput) => void ): void; - public removeAttributesFromFindings( - args: RemoveAttributesFromFindingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveAttributesFromFindingsCommandOutput) => void), - cb?: (err: any, data?: RemoveAttributesFromFindingsCommandOutput) => void - ): Promise | void { - const command = new RemoveAttributesFromFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets tags (key and value pairs) to the assessment template that is specified by the - * ARN of the assessment template.

+ * @see {@link SetTagsForResourceCommand} */ - public setTagsForResource( + setTagsForResource( args: SetTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public setTagsForResource( + setTagsForResource( args: SetTagsForResourceCommandInput, cb: (err: any, data?: SetTagsForResourceCommandOutput) => void ): void; - public setTagsForResource( + setTagsForResource( args: SetTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetTagsForResourceCommandOutput) => void ): void; - public setTagsForResource( - args: SetTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: SetTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new SetTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts the assessment run specified by the ARN of the assessment template. For this - * API to function properly, you must not exceed the limit of running up to 500 concurrent - * agents per AWS account.

+ * @see {@link StartAssessmentRunCommand} */ - public startAssessmentRun( + startAssessmentRun( args: StartAssessmentRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public startAssessmentRun( + startAssessmentRun( args: StartAssessmentRunCommandInput, cb: (err: any, data?: StartAssessmentRunCommandOutput) => void ): void; - public startAssessmentRun( + startAssessmentRun( args: StartAssessmentRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartAssessmentRunCommandOutput) => void ): void; - public startAssessmentRun( - args: StartAssessmentRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartAssessmentRunCommandOutput) => void), - cb?: (err: any, data?: StartAssessmentRunCommandOutput) => void - ): Promise | void { - const command = new StartAssessmentRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops the assessment run that is specified by the ARN of the assessment - * run.

+ * @see {@link StopAssessmentRunCommand} */ - public stopAssessmentRun( + stopAssessmentRun( args: StopAssessmentRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopAssessmentRun( + stopAssessmentRun( args: StopAssessmentRunCommandInput, cb: (err: any, data?: StopAssessmentRunCommandOutput) => void ): void; - public stopAssessmentRun( + stopAssessmentRun( args: StopAssessmentRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopAssessmentRunCommandOutput) => void ): void; - public stopAssessmentRun( - args: StopAssessmentRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopAssessmentRunCommandOutput) => void), - cb?: (err: any, data?: StopAssessmentRunCommandOutput) => void - ): Promise | void { - const command = new StopAssessmentRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the process of sending Amazon Simple Notification Service (SNS) notifications - * about a specified event to a specified SNS topic.

+ * @see {@link SubscribeToEventCommand} */ - public subscribeToEvent( + subscribeToEvent( args: SubscribeToEventCommandInput, options?: __HttpHandlerOptions ): Promise; - public subscribeToEvent( + subscribeToEvent( args: SubscribeToEventCommandInput, cb: (err: any, data?: SubscribeToEventCommandOutput) => void ): void; - public subscribeToEvent( + subscribeToEvent( args: SubscribeToEventCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubscribeToEventCommandOutput) => void ): void; - public subscribeToEvent( - args: SubscribeToEventCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SubscribeToEventCommandOutput) => void), - cb?: (err: any, data?: SubscribeToEventCommandOutput) => void - ): Promise | void { - const command = new SubscribeToEventCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables the process of sending Amazon Simple Notification Service (SNS) - * notifications about a specified event to a specified SNS topic.

+ * @see {@link UnsubscribeFromEventCommand} */ - public unsubscribeFromEvent( + unsubscribeFromEvent( args: UnsubscribeFromEventCommandInput, options?: __HttpHandlerOptions ): Promise; - public unsubscribeFromEvent( + unsubscribeFromEvent( args: UnsubscribeFromEventCommandInput, cb: (err: any, data?: UnsubscribeFromEventCommandOutput) => void ): void; - public unsubscribeFromEvent( + unsubscribeFromEvent( args: UnsubscribeFromEventCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnsubscribeFromEventCommandOutput) => void ): void; - public unsubscribeFromEvent( - args: UnsubscribeFromEventCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnsubscribeFromEventCommandOutput) => void), - cb?: (err: any, data?: UnsubscribeFromEventCommandOutput) => void - ): Promise | void { - const command = new UnsubscribeFromEventCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the assessment target that is specified by the ARN of the assessment - * target.

- *

If resourceGroupArn is not specified, all EC2 instances in the current AWS account - * and region are included in the assessment target.

+ * @see {@link UpdateAssessmentTargetCommand} */ - public updateAssessmentTarget( + updateAssessmentTarget( args: UpdateAssessmentTargetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAssessmentTarget( + updateAssessmentTarget( args: UpdateAssessmentTargetCommandInput, cb: (err: any, data?: UpdateAssessmentTargetCommandOutput) => void ): void; - public updateAssessmentTarget( + updateAssessmentTarget( args: UpdateAssessmentTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAssessmentTargetCommandOutput) => void ): void; - public updateAssessmentTarget( - args: UpdateAssessmentTargetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAssessmentTargetCommandOutput) => void), - cb?: (err: any, data?: UpdateAssessmentTargetCommandOutput) => void - ): Promise | void { - const command = new UpdateAssessmentTargetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Inspector + *

Amazon Inspector enables you to analyze the behavior of your AWS resources and to + * identify potential security issues. For more information, see Amazon Inspector User + * Guide.

+ */ +export class Inspector extends InspectorClient implements Inspector {} +createAggregatedClient(commands, Inspector); diff --git a/clients/client-inspector2/src/Inspector2.ts b/clients/client-inspector2/src/Inspector2.ts index 431668804ca3..41871ed76c85 100644 --- a/clients/client-inspector2/src/Inspector2.ts +++ b/clients/client-inspector2/src/Inspector2.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -137,1020 +138,515 @@ import { UpdateOrganizationConfigurationCommandInput, UpdateOrganizationConfigurationCommandOutput, } from "./commands/UpdateOrganizationConfigurationCommand"; -import { Inspector2Client } from "./Inspector2Client"; +import { Inspector2Client, Inspector2ClientConfig } from "./Inspector2Client"; -/** - * @public - *

Amazon Inspector is a vulnerability discovery service that automates continuous scanning for - * security vulnerabilities within your Amazon EC2 and Amazon ECR environments.

- */ -export class Inspector2 extends Inspector2Client { +const commands = { + AssociateMemberCommand, + BatchGetAccountStatusCommand, + BatchGetFreeTrialInfoCommand, + CancelFindingsReportCommand, + CreateFilterCommand, + CreateFindingsReportCommand, + DeleteFilterCommand, + DescribeOrganizationConfigurationCommand, + DisableCommand, + DisableDelegatedAdminAccountCommand, + DisassociateMemberCommand, + EnableCommand, + EnableDelegatedAdminAccountCommand, + GetConfigurationCommand, + GetDelegatedAdminAccountCommand, + GetFindingsReportStatusCommand, + GetMemberCommand, + ListAccountPermissionsCommand, + ListCoverageCommand, + ListCoverageStatisticsCommand, + ListDelegatedAdminAccountsCommand, + ListFiltersCommand, + ListFindingAggregationsCommand, + ListFindingsCommand, + ListMembersCommand, + ListTagsForResourceCommand, + ListUsageTotalsCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateConfigurationCommand, + UpdateFilterCommand, + UpdateOrganizationConfigurationCommand, +}; + +export interface Inspector2 { /** - * @public - *

Associates an Amazon Web Services account with an Amazon Inspector delegated administrator.

+ * @see {@link AssociateMemberCommand} */ - public associateMember( + associateMember( args: AssociateMemberCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateMember( - args: AssociateMemberCommandInput, - cb: (err: any, data?: AssociateMemberCommandOutput) => void - ): void; - public associateMember( + associateMember(args: AssociateMemberCommandInput, cb: (err: any, data?: AssociateMemberCommandOutput) => void): void; + associateMember( args: AssociateMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateMemberCommandOutput) => void ): void; - public associateMember( - args: AssociateMemberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateMemberCommandOutput) => void), - cb?: (err: any, data?: AssociateMemberCommandOutput) => void - ): Promise | void { - const command = new AssociateMemberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.

+ * @see {@link BatchGetAccountStatusCommand} */ - public batchGetAccountStatus( + batchGetAccountStatus( args: BatchGetAccountStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetAccountStatus( + batchGetAccountStatus( args: BatchGetAccountStatusCommandInput, cb: (err: any, data?: BatchGetAccountStatusCommandOutput) => void ): void; - public batchGetAccountStatus( + batchGetAccountStatus( args: BatchGetAccountStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetAccountStatusCommandOutput) => void ): void; - public batchGetAccountStatus( - args: BatchGetAccountStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetAccountStatusCommandOutput) => void), - cb?: (err: any, data?: BatchGetAccountStatusCommandOutput) => void - ): Promise | void { - const command = new BatchGetAccountStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets free trial status for multiple Amazon Web Services accounts.

+ * @see {@link BatchGetFreeTrialInfoCommand} */ - public batchGetFreeTrialInfo( + batchGetFreeTrialInfo( args: BatchGetFreeTrialInfoCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetFreeTrialInfo( + batchGetFreeTrialInfo( args: BatchGetFreeTrialInfoCommandInput, cb: (err: any, data?: BatchGetFreeTrialInfoCommandOutput) => void ): void; - public batchGetFreeTrialInfo( + batchGetFreeTrialInfo( args: BatchGetFreeTrialInfoCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetFreeTrialInfoCommandOutput) => void ): void; - public batchGetFreeTrialInfo( - args: BatchGetFreeTrialInfoCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetFreeTrialInfoCommandOutput) => void), - cb?: (err: any, data?: BatchGetFreeTrialInfoCommandOutput) => void - ): Promise | void { - const command = new BatchGetFreeTrialInfoCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels the given findings report.

+ * @see {@link CancelFindingsReportCommand} */ - public cancelFindingsReport( + cancelFindingsReport( args: CancelFindingsReportCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelFindingsReport( + cancelFindingsReport( args: CancelFindingsReportCommandInput, cb: (err: any, data?: CancelFindingsReportCommandOutput) => void ): void; - public cancelFindingsReport( + cancelFindingsReport( args: CancelFindingsReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelFindingsReportCommandOutput) => void ): void; - public cancelFindingsReport( - args: CancelFindingsReportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelFindingsReportCommandOutput) => void), - cb?: (err: any, data?: CancelFindingsReportCommandOutput) => void - ): Promise | void { - const command = new CancelFindingsReportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a filter resource using specified filter criteria.

+ * @see {@link CreateFilterCommand} */ - public createFilter( - args: CreateFilterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createFilter(args: CreateFilterCommandInput, cb: (err: any, data?: CreateFilterCommandOutput) => void): void; - public createFilter( + createFilter(args: CreateFilterCommandInput, options?: __HttpHandlerOptions): Promise; + createFilter(args: CreateFilterCommandInput, cb: (err: any, data?: CreateFilterCommandOutput) => void): void; + createFilter( args: CreateFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFilterCommandOutput) => void ): void; - public createFilter( - args: CreateFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFilterCommandOutput) => void), - cb?: (err: any, data?: CreateFilterCommandOutput) => void - ): Promise | void { - const command = new CreateFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a finding report.

+ * @see {@link CreateFindingsReportCommand} */ - public createFindingsReport( + createFindingsReport( args: CreateFindingsReportCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFindingsReport( + createFindingsReport( args: CreateFindingsReportCommandInput, cb: (err: any, data?: CreateFindingsReportCommandOutput) => void ): void; - public createFindingsReport( + createFindingsReport( args: CreateFindingsReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFindingsReportCommandOutput) => void ): void; - public createFindingsReport( - args: CreateFindingsReportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFindingsReportCommandOutput) => void), - cb?: (err: any, data?: CreateFindingsReportCommandOutput) => void - ): Promise | void { - const command = new CreateFindingsReportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a filter resource.

+ * @see {@link DeleteFilterCommand} */ - public deleteFilter( - args: DeleteFilterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteFilter(args: DeleteFilterCommandInput, cb: (err: any, data?: DeleteFilterCommandOutput) => void): void; - public deleteFilter( + deleteFilter(args: DeleteFilterCommandInput, options?: __HttpHandlerOptions): Promise; + deleteFilter(args: DeleteFilterCommandInput, cb: (err: any, data?: DeleteFilterCommandOutput) => void): void; + deleteFilter( args: DeleteFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFilterCommandOutput) => void ): void; - public deleteFilter( - args: DeleteFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFilterCommandOutput) => void), - cb?: (err: any, data?: DeleteFilterCommandOutput) => void - ): Promise | void { - const command = new DeleteFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describe Amazon Inspector configuration settings for an Amazon Web Services organization.

+ * @see {@link DescribeOrganizationConfigurationCommand} */ - public describeOrganizationConfiguration( + describeOrganizationConfiguration( args: DescribeOrganizationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOrganizationConfiguration( + describeOrganizationConfiguration( args: DescribeOrganizationConfigurationCommandInput, cb: (err: any, data?: DescribeOrganizationConfigurationCommandOutput) => void ): void; - public describeOrganizationConfiguration( + describeOrganizationConfiguration( args: DescribeOrganizationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrganizationConfigurationCommandOutput) => void ): void; - public describeOrganizationConfiguration( - args: DescribeOrganizationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOrganizationConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeOrganizationConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeOrganizationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables Amazon Inspector scans for one or more Amazon Web Services accounts. Disabling all scan types in an account - * disables the Amazon Inspector service.

+ * @see {@link DisableCommand} */ - public disable(args: DisableCommandInput, options?: __HttpHandlerOptions): Promise; - public disable(args: DisableCommandInput, cb: (err: any, data?: DisableCommandOutput) => void): void; - public disable( + disable(args: DisableCommandInput, options?: __HttpHandlerOptions): Promise; + disable(args: DisableCommandInput, cb: (err: any, data?: DisableCommandOutput) => void): void; + disable( args: DisableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableCommandOutput) => void ): void; - public disable( - args: DisableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableCommandOutput) => void), - cb?: (err: any, data?: DisableCommandOutput) => void - ): Promise | void { - const command = new DisableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables the Amazon Inspector delegated administrator for your organization.

+ * @see {@link DisableDelegatedAdminAccountCommand} */ - public disableDelegatedAdminAccount( + disableDelegatedAdminAccount( args: DisableDelegatedAdminAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableDelegatedAdminAccount( + disableDelegatedAdminAccount( args: DisableDelegatedAdminAccountCommandInput, cb: (err: any, data?: DisableDelegatedAdminAccountCommandOutput) => void ): void; - public disableDelegatedAdminAccount( + disableDelegatedAdminAccount( args: DisableDelegatedAdminAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableDelegatedAdminAccountCommandOutput) => void ): void; - public disableDelegatedAdminAccount( - args: DisableDelegatedAdminAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableDelegatedAdminAccountCommandOutput) => void), - cb?: (err: any, data?: DisableDelegatedAdminAccountCommandOutput) => void - ): Promise | void { - const command = new DisableDelegatedAdminAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates a member account from an Amazon Inspector delegated administrator.

+ * @see {@link DisassociateMemberCommand} */ - public disassociateMember( + disassociateMember( args: DisassociateMemberCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateMember( + disassociateMember( args: DisassociateMemberCommandInput, cb: (err: any, data?: DisassociateMemberCommandOutput) => void ): void; - public disassociateMember( + disassociateMember( args: DisassociateMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateMemberCommandOutput) => void ): void; - public disassociateMember( - args: DisassociateMemberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateMemberCommandOutput) => void), - cb?: (err: any, data?: DisassociateMemberCommandOutput) => void - ): Promise | void { - const command = new DisassociateMemberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables Amazon Inspector scans for one or more Amazon Web Services accounts.

+ * @see {@link EnableCommand} */ - public enable(args: EnableCommandInput, options?: __HttpHandlerOptions): Promise; - public enable(args: EnableCommandInput, cb: (err: any, data?: EnableCommandOutput) => void): void; - public enable( + enable(args: EnableCommandInput, options?: __HttpHandlerOptions): Promise; + enable(args: EnableCommandInput, cb: (err: any, data?: EnableCommandOutput) => void): void; + enable( args: EnableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableCommandOutput) => void ): void; - public enable( - args: EnableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableCommandOutput) => void), - cb?: (err: any, data?: EnableCommandOutput) => void - ): Promise | void { - const command = new EnableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the Amazon Inspector delegated administrator for your Organizations organization.

+ * @see {@link EnableDelegatedAdminAccountCommand} */ - public enableDelegatedAdminAccount( + enableDelegatedAdminAccount( args: EnableDelegatedAdminAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableDelegatedAdminAccount( + enableDelegatedAdminAccount( args: EnableDelegatedAdminAccountCommandInput, cb: (err: any, data?: EnableDelegatedAdminAccountCommandOutput) => void ): void; - public enableDelegatedAdminAccount( + enableDelegatedAdminAccount( args: EnableDelegatedAdminAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableDelegatedAdminAccountCommandOutput) => void ): void; - public enableDelegatedAdminAccount( - args: EnableDelegatedAdminAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableDelegatedAdminAccountCommandOutput) => void), - cb?: (err: any, data?: EnableDelegatedAdminAccountCommandOutput) => void - ): Promise | void { - const command = new EnableDelegatedAdminAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves setting configurations for Inspector scans.

+ * @see {@link GetConfigurationCommand} */ - public getConfiguration( + getConfiguration( args: GetConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConfiguration( + getConfiguration( args: GetConfigurationCommandInput, cb: (err: any, data?: GetConfigurationCommandOutput) => void ): void; - public getConfiguration( + getConfiguration( args: GetConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConfigurationCommandOutput) => void ): void; - public getConfiguration( - args: GetConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the Amazon Inspector delegated administrator for your - * organization.

+ * @see {@link GetDelegatedAdminAccountCommand} */ - public getDelegatedAdminAccount( + getDelegatedAdminAccount( args: GetDelegatedAdminAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDelegatedAdminAccount( + getDelegatedAdminAccount( args: GetDelegatedAdminAccountCommandInput, cb: (err: any, data?: GetDelegatedAdminAccountCommandOutput) => void ): void; - public getDelegatedAdminAccount( + getDelegatedAdminAccount( args: GetDelegatedAdminAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDelegatedAdminAccountCommandOutput) => void ): void; - public getDelegatedAdminAccount( - args: GetDelegatedAdminAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDelegatedAdminAccountCommandOutput) => void), - cb?: (err: any, data?: GetDelegatedAdminAccountCommandOutput) => void - ): Promise | void { - const command = new GetDelegatedAdminAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the status of a findings report.

+ * @see {@link GetFindingsReportStatusCommand} */ - public getFindingsReportStatus( + getFindingsReportStatus( args: GetFindingsReportStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFindingsReportStatus( + getFindingsReportStatus( args: GetFindingsReportStatusCommandInput, cb: (err: any, data?: GetFindingsReportStatusCommandOutput) => void ): void; - public getFindingsReportStatus( + getFindingsReportStatus( args: GetFindingsReportStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFindingsReportStatusCommandOutput) => void ): void; - public getFindingsReportStatus( - args: GetFindingsReportStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFindingsReportStatusCommandOutput) => void), - cb?: (err: any, data?: GetFindingsReportStatusCommandOutput) => void - ): Promise | void { - const command = new GetFindingsReportStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets member information for your organization.

+ * @see {@link GetMemberCommand} */ - public getMember(args: GetMemberCommandInput, options?: __HttpHandlerOptions): Promise; - public getMember(args: GetMemberCommandInput, cb: (err: any, data?: GetMemberCommandOutput) => void): void; - public getMember( + getMember(args: GetMemberCommandInput, options?: __HttpHandlerOptions): Promise; + getMember(args: GetMemberCommandInput, cb: (err: any, data?: GetMemberCommandOutput) => void): void; + getMember( args: GetMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMemberCommandOutput) => void ): void; - public getMember( - args: GetMemberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMemberCommandOutput) => void), - cb?: (err: any, data?: GetMemberCommandOutput) => void - ): Promise | void { - const command = new GetMemberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the permissions an account has to configure Amazon Inspector.

+ * @see {@link ListAccountPermissionsCommand} */ - public listAccountPermissions( + listAccountPermissions( args: ListAccountPermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAccountPermissions( + listAccountPermissions( args: ListAccountPermissionsCommandInput, cb: (err: any, data?: ListAccountPermissionsCommandOutput) => void ): void; - public listAccountPermissions( + listAccountPermissions( args: ListAccountPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccountPermissionsCommandOutput) => void ): void; - public listAccountPermissions( - args: ListAccountPermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccountPermissionsCommandOutput) => void), - cb?: (err: any, data?: ListAccountPermissionsCommandOutput) => void - ): Promise | void { - const command = new ListAccountPermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists coverage details for you environment.

+ * @see {@link ListCoverageCommand} */ - public listCoverage( - args: ListCoverageCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listCoverage(args: ListCoverageCommandInput, cb: (err: any, data?: ListCoverageCommandOutput) => void): void; - public listCoverage( + listCoverage(args: ListCoverageCommandInput, options?: __HttpHandlerOptions): Promise; + listCoverage(args: ListCoverageCommandInput, cb: (err: any, data?: ListCoverageCommandOutput) => void): void; + listCoverage( args: ListCoverageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCoverageCommandOutput) => void ): void; - public listCoverage( - args: ListCoverageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCoverageCommandOutput) => void), - cb?: (err: any, data?: ListCoverageCommandOutput) => void - ): Promise | void { - const command = new ListCoverageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists Amazon Inspector coverage statistics for your environment.

+ * @see {@link ListCoverageStatisticsCommand} */ - public listCoverageStatistics( + listCoverageStatistics( args: ListCoverageStatisticsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCoverageStatistics( + listCoverageStatistics( args: ListCoverageStatisticsCommandInput, cb: (err: any, data?: ListCoverageStatisticsCommandOutput) => void ): void; - public listCoverageStatistics( + listCoverageStatistics( args: ListCoverageStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCoverageStatisticsCommandOutput) => void ): void; - public listCoverageStatistics( - args: ListCoverageStatisticsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCoverageStatisticsCommandOutput) => void), - cb?: (err: any, data?: ListCoverageStatisticsCommandOutput) => void - ): Promise | void { - const command = new ListCoverageStatisticsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists information about the Amazon Inspector delegated administrator of your - * organization.

+ * @see {@link ListDelegatedAdminAccountsCommand} */ - public listDelegatedAdminAccounts( + listDelegatedAdminAccounts( args: ListDelegatedAdminAccountsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDelegatedAdminAccounts( + listDelegatedAdminAccounts( args: ListDelegatedAdminAccountsCommandInput, cb: (err: any, data?: ListDelegatedAdminAccountsCommandOutput) => void ): void; - public listDelegatedAdminAccounts( + listDelegatedAdminAccounts( args: ListDelegatedAdminAccountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDelegatedAdminAccountsCommandOutput) => void ): void; - public listDelegatedAdminAccounts( - args: ListDelegatedAdminAccountsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDelegatedAdminAccountsCommandOutput) => void), - cb?: (err: any, data?: ListDelegatedAdminAccountsCommandOutput) => void - ): Promise | void { - const command = new ListDelegatedAdminAccountsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the filters associated with your account.

+ * @see {@link ListFiltersCommand} */ - public listFilters(args: ListFiltersCommandInput, options?: __HttpHandlerOptions): Promise; - public listFilters(args: ListFiltersCommandInput, cb: (err: any, data?: ListFiltersCommandOutput) => void): void; - public listFilters( + listFilters(args: ListFiltersCommandInput, options?: __HttpHandlerOptions): Promise; + listFilters(args: ListFiltersCommandInput, cb: (err: any, data?: ListFiltersCommandOutput) => void): void; + listFilters( args: ListFiltersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFiltersCommandOutput) => void ): void; - public listFilters( - args: ListFiltersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFiltersCommandOutput) => void), - cb?: (err: any, data?: ListFiltersCommandOutput) => void - ): Promise | void { - const command = new ListFiltersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists aggregated finding data for your environment based on specific criteria.

+ * @see {@link ListFindingAggregationsCommand} */ - public listFindingAggregations( + listFindingAggregations( args: ListFindingAggregationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFindingAggregations( + listFindingAggregations( args: ListFindingAggregationsCommandInput, cb: (err: any, data?: ListFindingAggregationsCommandOutput) => void ): void; - public listFindingAggregations( + listFindingAggregations( args: ListFindingAggregationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFindingAggregationsCommandOutput) => void ): void; - public listFindingAggregations( - args: ListFindingAggregationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFindingAggregationsCommandOutput) => void), - cb?: (err: any, data?: ListFindingAggregationsCommandOutput) => void - ): Promise | void { - const command = new ListFindingAggregationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists findings for your environment.

+ * @see {@link ListFindingsCommand} */ - public listFindings( - args: ListFindingsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listFindings(args: ListFindingsCommandInput, cb: (err: any, data?: ListFindingsCommandOutput) => void): void; - public listFindings( + listFindings(args: ListFindingsCommandInput, options?: __HttpHandlerOptions): Promise; + listFindings(args: ListFindingsCommandInput, cb: (err: any, data?: ListFindingsCommandOutput) => void): void; + listFindings( args: ListFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFindingsCommandOutput) => void ): void; - public listFindings( - args: ListFindingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFindingsCommandOutput) => void), - cb?: (err: any, data?: ListFindingsCommandOutput) => void - ): Promise | void { - const command = new ListFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List members associated with the Amazon Inspector delegated administrator for your - * organization.

+ * @see {@link ListMembersCommand} */ - public listMembers(args: ListMembersCommandInput, options?: __HttpHandlerOptions): Promise; - public listMembers(args: ListMembersCommandInput, cb: (err: any, data?: ListMembersCommandOutput) => void): void; - public listMembers( + listMembers(args: ListMembersCommandInput, options?: __HttpHandlerOptions): Promise; + listMembers(args: ListMembersCommandInput, cb: (err: any, data?: ListMembersCommandOutput) => void): void; + listMembers( args: ListMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMembersCommandOutput) => void ): void; - public listMembers( - args: ListMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMembersCommandOutput) => void), - cb?: (err: any, data?: ListMembersCommandOutput) => void - ): Promise | void { - const command = new ListMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all tags attached to a given resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the Amazon Inspector usage totals over the last 30 days.

+ * @see {@link ListUsageTotalsCommand} */ - public listUsageTotals( + listUsageTotals( args: ListUsageTotalsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listUsageTotals( - args: ListUsageTotalsCommandInput, - cb: (err: any, data?: ListUsageTotalsCommandOutput) => void - ): void; - public listUsageTotals( + listUsageTotals(args: ListUsageTotalsCommandInput, cb: (err: any, data?: ListUsageTotalsCommandOutput) => void): void; + listUsageTotals( args: ListUsageTotalsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsageTotalsCommandOutput) => void ): void; - public listUsageTotals( - args: ListUsageTotalsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUsageTotalsCommandOutput) => void), - cb?: (err: any, data?: ListUsageTotalsCommandOutput) => void - ): Promise | void { - const command = new ListUsageTotalsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds tags to a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates setting configurations for your Amazon Inspector account. When you use this API as an Amazon Inspector delegated administrator this updates the setting for all accounts you manage. Member accounts in an organization cannot update this setting.

+ * @see {@link UpdateConfigurationCommand} */ - public updateConfiguration( + updateConfiguration( args: UpdateConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConfiguration( + updateConfiguration( args: UpdateConfigurationCommandInput, cb: (err: any, data?: UpdateConfigurationCommandOutput) => void ): void; - public updateConfiguration( + updateConfiguration( args: UpdateConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConfigurationCommandOutput) => void ): void; - public updateConfiguration( - args: UpdateConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Specifies the action that is to be applied to the findings that match the filter.

+ * @see {@link UpdateFilterCommand} */ - public updateFilter( - args: UpdateFilterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateFilter(args: UpdateFilterCommandInput, cb: (err: any, data?: UpdateFilterCommandOutput) => void): void; - public updateFilter( + updateFilter(args: UpdateFilterCommandInput, options?: __HttpHandlerOptions): Promise; + updateFilter(args: UpdateFilterCommandInput, cb: (err: any, data?: UpdateFilterCommandOutput) => void): void; + updateFilter( args: UpdateFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFilterCommandOutput) => void ): void; - public updateFilter( - args: UpdateFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFilterCommandOutput) => void), - cb?: (err: any, data?: UpdateFilterCommandOutput) => void - ): Promise | void { - const command = new UpdateFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the configurations for your Amazon Inspector organization.

+ * @see {@link UpdateOrganizationConfigurationCommand} */ - public updateOrganizationConfiguration( + updateOrganizationConfiguration( args: UpdateOrganizationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateOrganizationConfiguration( + updateOrganizationConfiguration( args: UpdateOrganizationConfigurationCommandInput, cb: (err: any, data?: UpdateOrganizationConfigurationCommandOutput) => void ): void; - public updateOrganizationConfiguration( + updateOrganizationConfiguration( args: UpdateOrganizationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateOrganizationConfigurationCommandOutput) => void ): void; - public updateOrganizationConfiguration( - args: UpdateOrganizationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateOrganizationConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateOrganizationConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateOrganizationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Inspector is a vulnerability discovery service that automates continuous scanning for + * security vulnerabilities within your Amazon EC2 and Amazon ECR environments.

+ */ +export class Inspector2 extends Inspector2Client implements Inspector2 {} +createAggregatedClient(commands, Inspector2); diff --git a/clients/client-internetmonitor/src/InternetMonitor.ts b/clients/client-internetmonitor/src/InternetMonitor.ts index f8eb33538aed..b2d7f29579a5 100644 --- a/clients/client-internetmonitor/src/InternetMonitor.ts +++ b/clients/client-internetmonitor/src/InternetMonitor.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -43,360 +44,166 @@ import { UpdateMonitorCommandInput, UpdateMonitorCommandOutput, } from "./commands/UpdateMonitorCommand"; -import { InternetMonitorClient } from "./InternetMonitorClient"; +import { InternetMonitorClient, InternetMonitorClientConfig } from "./InternetMonitorClient"; -/** - * @public - *

Amazon CloudWatch Internet Monitor provides visibility into how internet issues impact the performance and availability - * between your applications hosted on Amazon Web Services and your end users. It reduces the time it takes for you to diagnose - * internet issues from days to minutes. Internet Monitor uses the connectivity data that Amazon Web Services captures from its global - * networking footprint to calculate a baseline of performance and availability for internet traffic. This - * is the same data that Amazon Web Services uses to monitor internet uptime and availability. With those measurements - * as a baseline, Internet Monitor raises awareness for you when there are significant problems for your - * end users in the different geographic locations where your application runs.

- *

Internet Monitor publishes internet measurements to CloudWatch Logs and CloudWatch Metrics, - * to easily support using CloudWatch tools with health information for geographies and networks specific to your application. - * Internet Monitor sends health events to Amazon EventBridge so that you can set up notifications. If an issue is caused by the Amazon Web Services network, - * you also automatically receive an Amazon Web Services Health Dashboard notification with the steps that Amazon Web Services is taking to mitigate the problem.

- *

To use Internet Monitor, you create a monitor and associate your application's resources - * with it, VPCs, CloudFront distributions, or WorkSpaces directories, to enable Internet Monitor to know - * where your application's internet traffic is. Internet Monitor then provides internet measurements from Amazon Web Services that are specific to - * the locations and networks that communicate with your application.

- *

For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.

- */ -export class InternetMonitor extends InternetMonitorClient { +const commands = { + CreateMonitorCommand, + DeleteMonitorCommand, + GetHealthEventCommand, + GetMonitorCommand, + ListHealthEventsCommand, + ListMonitorsCommand, + ListTagsForResourceCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateMonitorCommand, +}; + +export interface InternetMonitor { /** - * @public - *

Creates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on information from the application resources that you add: Amazon Virtual Private Clouds (VPCs), - * Amazon CloudFront distributions, and WorkSpaces directories. Internet Monitor then publishes internet measurements from Amazon Web Services that are specific to - * the city-networks, that is, the locations and ASNs (typically internet service providers or ISPs), - * where clients access your application. For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.

- *

When you create a monitor, you set a maximum limit for the number of city-networks where client traffic is monitored. The city-network maximum - * that you choose is the limit, but you only pay for the number of city-networks that are actually monitored. You can change the maximum at any time - * by updating your monitor. For more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.

+ * @see {@link CreateMonitorCommand} */ - public createMonitor( - args: CreateMonitorCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createMonitor( - args: CreateMonitorCommandInput, - cb: (err: any, data?: CreateMonitorCommandOutput) => void - ): void; - public createMonitor( + createMonitor(args: CreateMonitorCommandInput, options?: __HttpHandlerOptions): Promise; + createMonitor(args: CreateMonitorCommandInput, cb: (err: any, data?: CreateMonitorCommandOutput) => void): void; + createMonitor( args: CreateMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMonitorCommandOutput) => void ): void; - public createMonitor( - args: CreateMonitorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMonitorCommandOutput) => void), - cb?: (err: any, data?: CreateMonitorCommandOutput) => void - ): Promise | void { - const command = new CreateMonitorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a monitor in Amazon CloudWatch Internet Monitor.

+ * @see {@link DeleteMonitorCommand} */ - public deleteMonitor( - args: DeleteMonitorCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteMonitor( - args: DeleteMonitorCommandInput, - cb: (err: any, data?: DeleteMonitorCommandOutput) => void - ): void; - public deleteMonitor( + deleteMonitor(args: DeleteMonitorCommandInput, options?: __HttpHandlerOptions): Promise; + deleteMonitor(args: DeleteMonitorCommandInput, cb: (err: any, data?: DeleteMonitorCommandOutput) => void): void; + deleteMonitor( args: DeleteMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMonitorCommandOutput) => void ): void; - public deleteMonitor( - args: DeleteMonitorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMonitorCommandOutput) => void), - cb?: (err: any, data?: DeleteMonitorCommandOutput) => void - ): Promise | void { - const command = new DeleteMonitorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information the Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations, - * and all of the information related to the event by location.

- *

The information returned includes the performance, availability, and round-trip time impact, information about the network providers, the event type, - * and so on.

- *

Information rolled up at the global traffic level is also returned, including the impact type and total traffic impact.

+ * @see {@link GetHealthEventCommand} */ - public getHealthEvent( + getHealthEvent( args: GetHealthEventCommandInput, options?: __HttpHandlerOptions ): Promise; - public getHealthEvent( - args: GetHealthEventCommandInput, - cb: (err: any, data?: GetHealthEventCommandOutput) => void - ): void; - public getHealthEvent( + getHealthEvent(args: GetHealthEventCommandInput, cb: (err: any, data?: GetHealthEventCommandOutput) => void): void; + getHealthEvent( args: GetHealthEventCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHealthEventCommandOutput) => void ): void; - public getHealthEvent( - args: GetHealthEventCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetHealthEventCommandOutput) => void), - cb?: (err: any, data?: GetHealthEventCommandOutput) => void - ): Promise | void { - const command = new GetHealthEventCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name. The information returned includes the Amazon Resource Name (ARN), create time, - * modified time, resources included in the monitor, and status information.

+ * @see {@link GetMonitorCommand} */ - public getMonitor(args: GetMonitorCommandInput, options?: __HttpHandlerOptions): Promise; - public getMonitor(args: GetMonitorCommandInput, cb: (err: any, data?: GetMonitorCommandOutput) => void): void; - public getMonitor( + getMonitor(args: GetMonitorCommandInput, options?: __HttpHandlerOptions): Promise; + getMonitor(args: GetMonitorCommandInput, cb: (err: any, data?: GetMonitorCommandOutput) => void): void; + getMonitor( args: GetMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMonitorCommandOutput) => void ): void; - public getMonitor( - args: GetMonitorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMonitorCommandOutput) => void), - cb?: (err: any, data?: GetMonitorCommandOutput) => void - ): Promise | void { - const command = new GetMonitorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns all information for health events including the client location information the network - * cause and status, event start and end time, percentage of total traffic impacted, and status.

- * - *

Health events that have start times during the time frame that is requested are not included in the list of health events.

- *
+ * @see {@link ListHealthEventsCommand} */ - public listHealthEvents( + listHealthEvents( args: ListHealthEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listHealthEvents( + listHealthEvents( args: ListHealthEventsCommandInput, cb: (err: any, data?: ListHealthEventsCommandOutput) => void ): void; - public listHealthEvents( + listHealthEvents( args: ListHealthEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHealthEventsCommandOutput) => void ): void; - public listHealthEvents( - args: ListHealthEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListHealthEventsCommandOutput) => void), - cb?: (err: any, data?: ListHealthEventsCommandOutput) => void - ): Promise | void { - const command = new ListHealthEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along with the Amazon Resource Name (ARN) and name of each monitor.

+ * @see {@link ListMonitorsCommand} */ - public listMonitors( - args: ListMonitorsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listMonitors(args: ListMonitorsCommandInput, cb: (err: any, data?: ListMonitorsCommandOutput) => void): void; - public listMonitors( + listMonitors(args: ListMonitorsCommandInput, options?: __HttpHandlerOptions): Promise; + listMonitors(args: ListMonitorsCommandInput, cb: (err: any, data?: ListMonitorsCommandOutput) => void): void; + listMonitors( args: ListMonitorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMonitorsCommandOutput) => void ): void; - public listMonitors( - args: ListMonitorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMonitorsCommandOutput) => void), - cb?: (err: any, data?: ListMonitorsCommandOutput) => void - ): Promise | void { - const command = new ListMonitorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags for a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a tag to a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor. You can add a maximum of 50 tags in Internet Monitor.

- *

A minimum of one tag is required for this call. It returns an error if you use the TagResource request with 0 tags.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a tag from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a monitor. You can update a monitor to change the maximum number of city-networks (locations and ASNs or - * internet service providers), to add or remove resources, - * or to change the status of the monitor. Note that you can't change the name of a monitor.

- *

The city-network maximum that you choose is the limit, but you only pay for the number of city-networks that are actually monitored. - * For more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.

+ * @see {@link UpdateMonitorCommand} */ - public updateMonitor( - args: UpdateMonitorCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateMonitor( - args: UpdateMonitorCommandInput, - cb: (err: any, data?: UpdateMonitorCommandOutput) => void - ): void; - public updateMonitor( + updateMonitor(args: UpdateMonitorCommandInput, options?: __HttpHandlerOptions): Promise; + updateMonitor(args: UpdateMonitorCommandInput, cb: (err: any, data?: UpdateMonitorCommandOutput) => void): void; + updateMonitor( args: UpdateMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMonitorCommandOutput) => void ): void; - public updateMonitor( - args: UpdateMonitorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMonitorCommandOutput) => void), - cb?: (err: any, data?: UpdateMonitorCommandOutput) => void - ): Promise | void { - const command = new UpdateMonitorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon CloudWatch Internet Monitor provides visibility into how internet issues impact the performance and availability + * between your applications hosted on Amazon Web Services and your end users. It reduces the time it takes for you to diagnose + * internet issues from days to minutes. Internet Monitor uses the connectivity data that Amazon Web Services captures from its global + * networking footprint to calculate a baseline of performance and availability for internet traffic. This + * is the same data that Amazon Web Services uses to monitor internet uptime and availability. With those measurements + * as a baseline, Internet Monitor raises awareness for you when there are significant problems for your + * end users in the different geographic locations where your application runs.

+ *

Internet Monitor publishes internet measurements to CloudWatch Logs and CloudWatch Metrics, + * to easily support using CloudWatch tools with health information for geographies and networks specific to your application. + * Internet Monitor sends health events to Amazon EventBridge so that you can set up notifications. If an issue is caused by the Amazon Web Services network, + * you also automatically receive an Amazon Web Services Health Dashboard notification with the steps that Amazon Web Services is taking to mitigate the problem.

+ *

To use Internet Monitor, you create a monitor and associate your application's resources + * with it, VPCs, CloudFront distributions, or WorkSpaces directories, to enable Internet Monitor to know + * where your application's internet traffic is. Internet Monitor then provides internet measurements from Amazon Web Services that are specific to + * the locations and networks that communicate with your application.

+ *

For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.

+ */ +export class InternetMonitor extends InternetMonitorClient implements InternetMonitor {} +createAggregatedClient(commands, InternetMonitor); diff --git a/clients/client-iot-1click-devices-service/src/IoT1ClickDevicesService.ts b/clients/client-iot-1click-devices-service/src/IoT1ClickDevicesService.ts index a1b2f9f619b4..2fe788fd9907 100644 --- a/clients/client-iot-1click-devices-service/src/IoT1ClickDevicesService.ts +++ b/clients/client-iot-1click-devices-service/src/IoT1ClickDevicesService.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -58,444 +59,225 @@ import { UpdateDeviceStateCommandInput, UpdateDeviceStateCommandOutput, } from "./commands/UpdateDeviceStateCommand"; -import { IoT1ClickDevicesServiceClient } from "./IoT1ClickDevicesServiceClient"; +import { IoT1ClickDevicesServiceClient, IoT1ClickDevicesServiceClientConfig } from "./IoT1ClickDevicesServiceClient"; -/** - * @public - *

Describes all of the AWS IoT 1-Click device-related API operations for the service. - * Also provides sample requests, responses, and errors for the supported web services - * protocols.

- */ -export class IoT1ClickDevicesService extends IoT1ClickDevicesServiceClient { +const commands = { + ClaimDevicesByClaimCodeCommand, + DescribeDeviceCommand, + FinalizeDeviceClaimCommand, + GetDeviceMethodsCommand, + InitiateDeviceClaimCommand, + InvokeDeviceMethodCommand, + ListDeviceEventsCommand, + ListDevicesCommand, + ListTagsForResourceCommand, + TagResourceCommand, + UnclaimDeviceCommand, + UntagResourceCommand, + UpdateDeviceStateCommand, +}; + +export interface IoT1ClickDevicesService { /** - * @public - *

Adds device(s) to your account (i.e., claim one or more devices) if and only if you - * received a claim code with the device(s).

+ * @see {@link ClaimDevicesByClaimCodeCommand} */ - public claimDevicesByClaimCode( + claimDevicesByClaimCode( args: ClaimDevicesByClaimCodeCommandInput, options?: __HttpHandlerOptions ): Promise; - public claimDevicesByClaimCode( + claimDevicesByClaimCode( args: ClaimDevicesByClaimCodeCommandInput, cb: (err: any, data?: ClaimDevicesByClaimCodeCommandOutput) => void ): void; - public claimDevicesByClaimCode( + claimDevicesByClaimCode( args: ClaimDevicesByClaimCodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ClaimDevicesByClaimCodeCommandOutput) => void ): void; - public claimDevicesByClaimCode( - args: ClaimDevicesByClaimCodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ClaimDevicesByClaimCodeCommandOutput) => void), - cb?: (err: any, data?: ClaimDevicesByClaimCodeCommandOutput) => void - ): Promise | void { - const command = new ClaimDevicesByClaimCodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Given a device ID, returns a DescribeDeviceResponse object describing the - * details of the device.

+ * @see {@link DescribeDeviceCommand} */ - public describeDevice( + describeDevice( args: DescribeDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDevice( - args: DescribeDeviceCommandInput, - cb: (err: any, data?: DescribeDeviceCommandOutput) => void - ): void; - public describeDevice( + describeDevice(args: DescribeDeviceCommandInput, cb: (err: any, data?: DescribeDeviceCommandOutput) => void): void; + describeDevice( args: DescribeDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDeviceCommandOutput) => void ): void; - public describeDevice( - args: DescribeDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDeviceCommandOutput) => void), - cb?: (err: any, data?: DescribeDeviceCommandOutput) => void - ): Promise | void { - const command = new DescribeDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Given a device ID, finalizes the claim request for the associated device.

- *

Claiming a device consists of initiating a claim, then publishing a device event, - * and finalizing the claim. For a device of type button, a device event can - * be published by simply clicking the device.

- *
+ * @see {@link FinalizeDeviceClaimCommand} */ - public finalizeDeviceClaim( + finalizeDeviceClaim( args: FinalizeDeviceClaimCommandInput, options?: __HttpHandlerOptions ): Promise; - public finalizeDeviceClaim( + finalizeDeviceClaim( args: FinalizeDeviceClaimCommandInput, cb: (err: any, data?: FinalizeDeviceClaimCommandOutput) => void ): void; - public finalizeDeviceClaim( + finalizeDeviceClaim( args: FinalizeDeviceClaimCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FinalizeDeviceClaimCommandOutput) => void ): void; - public finalizeDeviceClaim( - args: FinalizeDeviceClaimCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FinalizeDeviceClaimCommandOutput) => void), - cb?: (err: any, data?: FinalizeDeviceClaimCommandOutput) => void - ): Promise | void { - const command = new FinalizeDeviceClaimCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Given a device ID, returns the invokable methods associated with the device.

+ * @see {@link GetDeviceMethodsCommand} */ - public getDeviceMethods( + getDeviceMethods( args: GetDeviceMethodsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDeviceMethods( + getDeviceMethods( args: GetDeviceMethodsCommandInput, cb: (err: any, data?: GetDeviceMethodsCommandOutput) => void ): void; - public getDeviceMethods( + getDeviceMethods( args: GetDeviceMethodsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeviceMethodsCommandOutput) => void ): void; - public getDeviceMethods( - args: GetDeviceMethodsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeviceMethodsCommandOutput) => void), - cb?: (err: any, data?: GetDeviceMethodsCommandOutput) => void - ): Promise | void { - const command = new GetDeviceMethodsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Given a device ID, initiates a claim request for the associated device.

- *

Claiming a device consists of initiating a claim, then publishing a device event, - * and finalizing the claim. For a device of type button, a device event can - * be published by simply clicking the device.

- *
+ * @see {@link InitiateDeviceClaimCommand} */ - public initiateDeviceClaim( + initiateDeviceClaim( args: InitiateDeviceClaimCommandInput, options?: __HttpHandlerOptions ): Promise; - public initiateDeviceClaim( + initiateDeviceClaim( args: InitiateDeviceClaimCommandInput, cb: (err: any, data?: InitiateDeviceClaimCommandOutput) => void ): void; - public initiateDeviceClaim( + initiateDeviceClaim( args: InitiateDeviceClaimCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InitiateDeviceClaimCommandOutput) => void ): void; - public initiateDeviceClaim( - args: InitiateDeviceClaimCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InitiateDeviceClaimCommandOutput) => void), - cb?: (err: any, data?: InitiateDeviceClaimCommandOutput) => void - ): Promise | void { - const command = new InitiateDeviceClaimCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Given a device ID, issues a request to invoke a named device method (with possible - * parameters). See the "Example POST" code snippet below.

+ * @see {@link InvokeDeviceMethodCommand} */ - public invokeDeviceMethod( + invokeDeviceMethod( args: InvokeDeviceMethodCommandInput, options?: __HttpHandlerOptions ): Promise; - public invokeDeviceMethod( + invokeDeviceMethod( args: InvokeDeviceMethodCommandInput, cb: (err: any, data?: InvokeDeviceMethodCommandOutput) => void ): void; - public invokeDeviceMethod( + invokeDeviceMethod( args: InvokeDeviceMethodCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InvokeDeviceMethodCommandOutput) => void ): void; - public invokeDeviceMethod( - args: InvokeDeviceMethodCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InvokeDeviceMethodCommandOutput) => void), - cb?: (err: any, data?: InvokeDeviceMethodCommandOutput) => void - ): Promise | void { - const command = new InvokeDeviceMethodCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Using a device ID, returns a DeviceEventsResponse object containing an - * array of events for the device.

+ * @see {@link ListDeviceEventsCommand} */ - public listDeviceEvents( + listDeviceEvents( args: ListDeviceEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeviceEvents( + listDeviceEvents( args: ListDeviceEventsCommandInput, cb: (err: any, data?: ListDeviceEventsCommandOutput) => void ): void; - public listDeviceEvents( + listDeviceEvents( args: ListDeviceEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeviceEventsCommandOutput) => void ): void; - public listDeviceEvents( - args: ListDeviceEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeviceEventsCommandOutput) => void), - cb?: (err: any, data?: ListDeviceEventsCommandOutput) => void - ): Promise | void { - const command = new ListDeviceEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the 1-Click compatible devices associated with your AWS account.

+ * @see {@link ListDevicesCommand} */ - public listDevices(args: ListDevicesCommandInput, options?: __HttpHandlerOptions): Promise; - public listDevices(args: ListDevicesCommandInput, cb: (err: any, data?: ListDevicesCommandOutput) => void): void; - public listDevices( + listDevices(args: ListDevicesCommandInput, options?: __HttpHandlerOptions): Promise; + listDevices(args: ListDevicesCommandInput, cb: (err: any, data?: ListDevicesCommandOutput) => void): void; + listDevices( args: ListDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDevicesCommandOutput) => void ): void; - public listDevices( - args: ListDevicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDevicesCommandOutput) => void), - cb?: (err: any, data?: ListDevicesCommandOutput) => void - ): Promise | void { - const command = new ListDevicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags associated with the specified resource ARN.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or updates the tags associated with the resource ARN. See AWS IoT 1-Click Service Limits for the maximum number of tags allowed per - * resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates a device from your AWS account using its device ID.

+ * @see {@link UnclaimDeviceCommand} */ - public unclaimDevice( - args: UnclaimDeviceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public unclaimDevice( - args: UnclaimDeviceCommandInput, - cb: (err: any, data?: UnclaimDeviceCommandOutput) => void - ): void; - public unclaimDevice( + unclaimDevice(args: UnclaimDeviceCommandInput, options?: __HttpHandlerOptions): Promise; + unclaimDevice(args: UnclaimDeviceCommandInput, cb: (err: any, data?: UnclaimDeviceCommandOutput) => void): void; + unclaimDevice( args: UnclaimDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnclaimDeviceCommandOutput) => void ): void; - public unclaimDevice( - args: UnclaimDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnclaimDeviceCommandOutput) => void), - cb?: (err: any, data?: UnclaimDeviceCommandOutput) => void - ): Promise | void { - const command = new UnclaimDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Using tag keys, deletes the tags (key/value pairs) associated with the specified - * resource ARN.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Using a Boolean value (true or false), this operation - * enables or disables the device given a device ID.

+ * @see {@link UpdateDeviceStateCommand} */ - public updateDeviceState( + updateDeviceState( args: UpdateDeviceStateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDeviceState( + updateDeviceState( args: UpdateDeviceStateCommandInput, cb: (err: any, data?: UpdateDeviceStateCommandOutput) => void ): void; - public updateDeviceState( + updateDeviceState( args: UpdateDeviceStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDeviceStateCommandOutput) => void ): void; - public updateDeviceState( - args: UpdateDeviceStateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDeviceStateCommandOutput) => void), - cb?: (err: any, data?: UpdateDeviceStateCommandOutput) => void - ): Promise | void { - const command = new UpdateDeviceStateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Describes all of the AWS IoT 1-Click device-related API operations for the service. + * Also provides sample requests, responses, and errors for the supported web services + * protocols.

+ */ +export class IoT1ClickDevicesService extends IoT1ClickDevicesServiceClient implements IoT1ClickDevicesService {} +createAggregatedClient(commands, IoT1ClickDevicesService); diff --git a/clients/client-iot-1click-projects/src/IoT1ClickProjects.ts b/clients/client-iot-1click-projects/src/IoT1ClickProjects.ts index 21426b9921f1..ce9ee6410b08 100644 --- a/clients/client-iot-1click-projects/src/IoT1ClickProjects.ts +++ b/clients/client-iot-1click-projects/src/IoT1ClickProjects.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -77,544 +78,253 @@ import { UpdateProjectCommandInput, UpdateProjectCommandOutput, } from "./commands/UpdateProjectCommand"; -import { IoT1ClickProjectsClient } from "./IoT1ClickProjectsClient"; +import { IoT1ClickProjectsClient, IoT1ClickProjectsClientConfig } from "./IoT1ClickProjectsClient"; -/** - * @public - *

The AWS IoT 1-Click Projects API Reference

- */ -export class IoT1ClickProjects extends IoT1ClickProjectsClient { +const commands = { + AssociateDeviceWithPlacementCommand, + CreatePlacementCommand, + CreateProjectCommand, + DeletePlacementCommand, + DeleteProjectCommand, + DescribePlacementCommand, + DescribeProjectCommand, + DisassociateDeviceFromPlacementCommand, + GetDevicesInPlacementCommand, + ListPlacementsCommand, + ListProjectsCommand, + ListTagsForResourceCommand, + TagResourceCommand, + UntagResourceCommand, + UpdatePlacementCommand, + UpdateProjectCommand, +}; + +export interface IoT1ClickProjects { /** - * @public - *

Associates a physical device with a placement.

+ * @see {@link AssociateDeviceWithPlacementCommand} */ - public associateDeviceWithPlacement( + associateDeviceWithPlacement( args: AssociateDeviceWithPlacementCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateDeviceWithPlacement( + associateDeviceWithPlacement( args: AssociateDeviceWithPlacementCommandInput, cb: (err: any, data?: AssociateDeviceWithPlacementCommandOutput) => void ): void; - public associateDeviceWithPlacement( + associateDeviceWithPlacement( args: AssociateDeviceWithPlacementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateDeviceWithPlacementCommandOutput) => void ): void; - public associateDeviceWithPlacement( - args: AssociateDeviceWithPlacementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateDeviceWithPlacementCommandOutput) => void), - cb?: (err: any, data?: AssociateDeviceWithPlacementCommandOutput) => void - ): Promise | void { - const command = new AssociateDeviceWithPlacementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an empty placement.

+ * @see {@link CreatePlacementCommand} */ - public createPlacement( + createPlacement( args: CreatePlacementCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPlacement( - args: CreatePlacementCommandInput, - cb: (err: any, data?: CreatePlacementCommandOutput) => void - ): void; - public createPlacement( + createPlacement(args: CreatePlacementCommandInput, cb: (err: any, data?: CreatePlacementCommandOutput) => void): void; + createPlacement( args: CreatePlacementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePlacementCommandOutput) => void ): void; - public createPlacement( - args: CreatePlacementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePlacementCommandOutput) => void), - cb?: (err: any, data?: CreatePlacementCommandOutput) => void - ): Promise | void { - const command = new CreatePlacementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an empty project with a placement template. A project contains zero or more - * placements that adhere to the placement template defined in the project.

+ * @see {@link CreateProjectCommand} */ - public createProject( - args: CreateProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createProject( - args: CreateProjectCommandInput, - cb: (err: any, data?: CreateProjectCommandOutput) => void - ): void; - public createProject( + createProject(args: CreateProjectCommandInput, options?: __HttpHandlerOptions): Promise; + createProject(args: CreateProjectCommandInput, cb: (err: any, data?: CreateProjectCommandOutput) => void): void; + createProject( args: CreateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectCommandOutput) => void ): void; - public createProject( - args: CreateProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProjectCommandOutput) => void), - cb?: (err: any, data?: CreateProjectCommandOutput) => void - ): Promise | void { - const command = new CreateProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a placement. To delete a placement, it must not have any devices associated with - * it.

- * - *

When you delete a placement, all associated data becomes irretrievable.

- *
+ * @see {@link DeletePlacementCommand} */ - public deletePlacement( + deletePlacement( args: DeletePlacementCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePlacement( - args: DeletePlacementCommandInput, - cb: (err: any, data?: DeletePlacementCommandOutput) => void - ): void; - public deletePlacement( + deletePlacement(args: DeletePlacementCommandInput, cb: (err: any, data?: DeletePlacementCommandOutput) => void): void; + deletePlacement( args: DeletePlacementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePlacementCommandOutput) => void ): void; - public deletePlacement( - args: DeletePlacementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePlacementCommandOutput) => void), - cb?: (err: any, data?: DeletePlacementCommandOutput) => void - ): Promise | void { - const command = new DeletePlacementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a project. To delete a project, it must not have any placements associated with - * it.

- * - *

When you delete a project, all associated data becomes irretrievable.

- *
+ * @see {@link DeleteProjectCommand} */ - public deleteProject( - args: DeleteProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteProject( - args: DeleteProjectCommandInput, - cb: (err: any, data?: DeleteProjectCommandOutput) => void - ): void; - public deleteProject( + deleteProject(args: DeleteProjectCommandInput, options?: __HttpHandlerOptions): Promise; + deleteProject(args: DeleteProjectCommandInput, cb: (err: any, data?: DeleteProjectCommandOutput) => void): void; + deleteProject( args: DeleteProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProjectCommandOutput) => void ): void; - public deleteProject( - args: DeleteProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProjectCommandOutput) => void), - cb?: (err: any, data?: DeleteProjectCommandOutput) => void - ): Promise | void { - const command = new DeleteProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a placement in a project.

+ * @see {@link DescribePlacementCommand} */ - public describePlacement( + describePlacement( args: DescribePlacementCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePlacement( + describePlacement( args: DescribePlacementCommandInput, cb: (err: any, data?: DescribePlacementCommandOutput) => void ): void; - public describePlacement( + describePlacement( args: DescribePlacementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePlacementCommandOutput) => void ): void; - public describePlacement( - args: DescribePlacementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePlacementCommandOutput) => void), - cb?: (err: any, data?: DescribePlacementCommandOutput) => void - ): Promise | void { - const command = new DescribePlacementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an object describing a project.

+ * @see {@link DescribeProjectCommand} */ - public describeProject( + describeProject( args: DescribeProjectCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProject( - args: DescribeProjectCommandInput, - cb: (err: any, data?: DescribeProjectCommandOutput) => void - ): void; - public describeProject( + describeProject(args: DescribeProjectCommandInput, cb: (err: any, data?: DescribeProjectCommandOutput) => void): void; + describeProject( args: DescribeProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProjectCommandOutput) => void ): void; - public describeProject( - args: DescribeProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProjectCommandOutput) => void), - cb?: (err: any, data?: DescribeProjectCommandOutput) => void - ): Promise | void { - const command = new DescribeProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a physical device from a placement.

+ * @see {@link DisassociateDeviceFromPlacementCommand} */ - public disassociateDeviceFromPlacement( + disassociateDeviceFromPlacement( args: DisassociateDeviceFromPlacementCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateDeviceFromPlacement( + disassociateDeviceFromPlacement( args: DisassociateDeviceFromPlacementCommandInput, cb: (err: any, data?: DisassociateDeviceFromPlacementCommandOutput) => void ): void; - public disassociateDeviceFromPlacement( + disassociateDeviceFromPlacement( args: DisassociateDeviceFromPlacementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateDeviceFromPlacementCommandOutput) => void ): void; - public disassociateDeviceFromPlacement( - args: DisassociateDeviceFromPlacementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateDeviceFromPlacementCommandOutput) => void), - cb?: (err: any, data?: DisassociateDeviceFromPlacementCommandOutput) => void - ): Promise | void { - const command = new DisassociateDeviceFromPlacementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an object enumerating the devices in a placement.

+ * @see {@link GetDevicesInPlacementCommand} */ - public getDevicesInPlacement( + getDevicesInPlacement( args: GetDevicesInPlacementCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDevicesInPlacement( + getDevicesInPlacement( args: GetDevicesInPlacementCommandInput, cb: (err: any, data?: GetDevicesInPlacementCommandOutput) => void ): void; - public getDevicesInPlacement( + getDevicesInPlacement( args: GetDevicesInPlacementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDevicesInPlacementCommandOutput) => void ): void; - public getDevicesInPlacement( - args: GetDevicesInPlacementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDevicesInPlacementCommandOutput) => void), - cb?: (err: any, data?: GetDevicesInPlacementCommandOutput) => void - ): Promise | void { - const command = new GetDevicesInPlacementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the placement(s) of a project.

+ * @see {@link ListPlacementsCommand} */ - public listPlacements( + listPlacements( args: ListPlacementsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPlacements( - args: ListPlacementsCommandInput, - cb: (err: any, data?: ListPlacementsCommandOutput) => void - ): void; - public listPlacements( + listPlacements(args: ListPlacementsCommandInput, cb: (err: any, data?: ListPlacementsCommandOutput) => void): void; + listPlacements( args: ListPlacementsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPlacementsCommandOutput) => void ): void; - public listPlacements( - args: ListPlacementsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPlacementsCommandOutput) => void), - cb?: (err: any, data?: ListPlacementsCommandOutput) => void - ): Promise | void { - const command = new ListPlacementsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.

+ * @see {@link ListProjectsCommand} */ - public listProjects( - args: ListProjectsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void; - public listProjects( + listProjects(args: ListProjectsCommandInput, options?: __HttpHandlerOptions): Promise; + listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void; + listProjects( args: ListProjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProjectsCommandOutput) => void ): void; - public listProjects( - args: ListProjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProjectsCommandOutput) => void), - cb?: (err: any, data?: ListProjectsCommandOutput) => void - ): Promise | void { - const command = new ListProjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags (metadata key/value pairs) which you have assigned to the resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or modifies tags for a resource. Tags are key/value pairs (metadata) that can be - * used to manage a resource. For more information, see AWS Tagging - * Strategies.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags (metadata key/value pairs) from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a placement with the given attributes. To clear an attribute, pass an empty value - * (i.e., "").

+ * @see {@link UpdatePlacementCommand} */ - public updatePlacement( + updatePlacement( args: UpdatePlacementCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePlacement( - args: UpdatePlacementCommandInput, - cb: (err: any, data?: UpdatePlacementCommandOutput) => void - ): void; - public updatePlacement( + updatePlacement(args: UpdatePlacementCommandInput, cb: (err: any, data?: UpdatePlacementCommandOutput) => void): void; + updatePlacement( args: UpdatePlacementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePlacementCommandOutput) => void ): void; - public updatePlacement( - args: UpdatePlacementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePlacementCommandOutput) => void), - cb?: (err: any, data?: UpdatePlacementCommandOutput) => void - ): Promise | void { - const command = new UpdatePlacementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a project associated with your AWS account and region. With the exception of - * device template names, you can pass just the values that need to be updated because the update - * request will change only the values that are provided. To clear a value, pass the empty string - * (i.e., "").

+ * @see {@link UpdateProjectCommand} */ - public updateProject( - args: UpdateProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateProject( - args: UpdateProjectCommandInput, - cb: (err: any, data?: UpdateProjectCommandOutput) => void - ): void; - public updateProject( + updateProject(args: UpdateProjectCommandInput, options?: __HttpHandlerOptions): Promise; + updateProject(args: UpdateProjectCommandInput, cb: (err: any, data?: UpdateProjectCommandOutput) => void): void; + updateProject( args: UpdateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProjectCommandOutput) => void ): void; - public updateProject( - args: UpdateProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProjectCommandOutput) => void), - cb?: (err: any, data?: UpdateProjectCommandOutput) => void - ): Promise | void { - const command = new UpdateProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The AWS IoT 1-Click Projects API Reference

+ */ +export class IoT1ClickProjects extends IoT1ClickProjectsClient implements IoT1ClickProjects {} +createAggregatedClient(commands, IoT1ClickProjects); diff --git a/clients/client-iot-data-plane/src/IoTDataPlane.ts b/clients/client-iot-data-plane/src/IoTDataPlane.ts index f826a8b4a81e..ec748404ae52 100644 --- a/clients/client-iot-data-plane/src/IoTDataPlane.ts +++ b/clients/client-iot-data-plane/src/IoTDataPlane.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -32,275 +33,143 @@ import { UpdateThingShadowCommandInput, UpdateThingShadowCommandOutput, } from "./commands/UpdateThingShadowCommand"; -import { IoTDataPlaneClient } from "./IoTDataPlaneClient"; +import { IoTDataPlaneClient, IoTDataPlaneClientConfig } from "./IoTDataPlaneClient"; -/** - * @public - * IoT data - *

IoT data enables secure, bi-directional communication between Internet-connected things (such as sensors, - * actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. It implements a broker for applications and - * things to publish messages over HTTP (Publish) and retrieve, update, and delete shadows. A shadow is a - * persistent representation of your things and their state in the Amazon Web Services cloud.

- *

Find the endpoint address for actions in IoT data by running this CLI command:

- *

- * aws iot describe-endpoint --endpoint-type iot:Data-ATS - *

- *

The service name used by Amazon Web ServicesSignature Version 4 - * to sign requests is: iotdevicegateway.

- */ -export class IoTDataPlane extends IoTDataPlaneClient { +const commands = { + DeleteThingShadowCommand, + GetRetainedMessageCommand, + GetThingShadowCommand, + ListNamedShadowsForThingCommand, + ListRetainedMessagesCommand, + PublishCommand, + UpdateThingShadowCommand, +}; + +export interface IoTDataPlane { /** - * @public - *

Deletes the shadow for the specified thing.

- *

Requires permission to access the DeleteThingShadow action.

- *

For more information, see DeleteThingShadow in the IoT Developer Guide.

+ * @see {@link DeleteThingShadowCommand} */ - public deleteThingShadow( + deleteThingShadow( args: DeleteThingShadowCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteThingShadow( + deleteThingShadow( args: DeleteThingShadowCommandInput, cb: (err: any, data?: DeleteThingShadowCommandOutput) => void ): void; - public deleteThingShadow( + deleteThingShadow( args: DeleteThingShadowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteThingShadowCommandOutput) => void ): void; - public deleteThingShadow( - args: DeleteThingShadowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteThingShadowCommandOutput) => void), - cb?: (err: any, data?: DeleteThingShadowCommandOutput) => void - ): Promise | void { - const command = new DeleteThingShadowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the details of a single retained message for the specified topic.

- *

This action returns the message payload of the retained message, which can - * incur messaging costs. To list only the topic names of the retained messages, call - * ListRetainedMessages.

- *

Requires permission to access the GetRetainedMessage action.

- *

For more information about messaging costs, see Amazon Web Services IoT Core - * pricing - Messaging.

+ * @see {@link GetRetainedMessageCommand} */ - public getRetainedMessage( + getRetainedMessage( args: GetRetainedMessageCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRetainedMessage( + getRetainedMessage( args: GetRetainedMessageCommandInput, cb: (err: any, data?: GetRetainedMessageCommandOutput) => void ): void; - public getRetainedMessage( + getRetainedMessage( args: GetRetainedMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRetainedMessageCommandOutput) => void ): void; - public getRetainedMessage( - args: GetRetainedMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRetainedMessageCommandOutput) => void), - cb?: (err: any, data?: GetRetainedMessageCommandOutput) => void - ): Promise | void { - const command = new GetRetainedMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the shadow for the specified thing.

- *

Requires permission to access the GetThingShadow action.

- *

For more information, see GetThingShadow in the - * IoT Developer Guide.

+ * @see {@link GetThingShadowCommand} */ - public getThingShadow( + getThingShadow( args: GetThingShadowCommandInput, options?: __HttpHandlerOptions ): Promise; - public getThingShadow( - args: GetThingShadowCommandInput, - cb: (err: any, data?: GetThingShadowCommandOutput) => void - ): void; - public getThingShadow( + getThingShadow(args: GetThingShadowCommandInput, cb: (err: any, data?: GetThingShadowCommandOutput) => void): void; + getThingShadow( args: GetThingShadowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetThingShadowCommandOutput) => void ): void; - public getThingShadow( - args: GetThingShadowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetThingShadowCommandOutput) => void), - cb?: (err: any, data?: GetThingShadowCommandOutput) => void - ): Promise | void { - const command = new GetThingShadowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the shadows for the specified thing.

- *

Requires permission to access the ListNamedShadowsForThing action.

+ * @see {@link ListNamedShadowsForThingCommand} */ - public listNamedShadowsForThing( + listNamedShadowsForThing( args: ListNamedShadowsForThingCommandInput, options?: __HttpHandlerOptions ): Promise; - public listNamedShadowsForThing( + listNamedShadowsForThing( args: ListNamedShadowsForThingCommandInput, cb: (err: any, data?: ListNamedShadowsForThingCommandOutput) => void ): void; - public listNamedShadowsForThing( + listNamedShadowsForThing( args: ListNamedShadowsForThingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNamedShadowsForThingCommandOutput) => void ): void; - public listNamedShadowsForThing( - args: ListNamedShadowsForThingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNamedShadowsForThingCommandOutput) => void), - cb?: (err: any, data?: ListNamedShadowsForThingCommandOutput) => void - ): Promise | void { - const command = new ListNamedShadowsForThingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists summary information about the retained messages stored for the account.

- *

This action returns only the topic names of the retained messages. It doesn't - * return any message payloads. Although this action doesn't return a message payload, - * it can still incur messaging costs.

- *

To get the message payload of a retained message, call - * GetRetainedMessage - * with the topic name of the retained message.

- *

Requires permission to access the ListRetainedMessages action.

- *

For more information about messaging costs, see Amazon Web Services IoT Core - * pricing - Messaging.

+ * @see {@link ListRetainedMessagesCommand} */ - public listRetainedMessages( + listRetainedMessages( args: ListRetainedMessagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRetainedMessages( + listRetainedMessages( args: ListRetainedMessagesCommandInput, cb: (err: any, data?: ListRetainedMessagesCommandOutput) => void ): void; - public listRetainedMessages( + listRetainedMessages( args: ListRetainedMessagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRetainedMessagesCommandOutput) => void ): void; - public listRetainedMessages( - args: ListRetainedMessagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRetainedMessagesCommandOutput) => void), - cb?: (err: any, data?: ListRetainedMessagesCommandOutput) => void - ): Promise | void { - const command = new ListRetainedMessagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Publishes an MQTT message.

- *

Requires permission to access the Publish action.

- *

For more information about MQTT messages, see - * MQTT Protocol in the - * IoT Developer Guide.

- *

For more information about messaging costs, see Amazon Web Services IoT Core - * pricing - Messaging.

+ * @see {@link PublishCommand} */ - public publish(args: PublishCommandInput, options?: __HttpHandlerOptions): Promise; - public publish(args: PublishCommandInput, cb: (err: any, data?: PublishCommandOutput) => void): void; - public publish( + publish(args: PublishCommandInput, options?: __HttpHandlerOptions): Promise; + publish(args: PublishCommandInput, cb: (err: any, data?: PublishCommandOutput) => void): void; + publish( args: PublishCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishCommandOutput) => void ): void; - public publish( - args: PublishCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PublishCommandOutput) => void), - cb?: (err: any, data?: PublishCommandOutput) => void - ): Promise | void { - const command = new PublishCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the shadow for the specified thing.

- *

Requires permission to access the UpdateThingShadow action.

- *

For more information, see UpdateThingShadow in the - * IoT Developer Guide.

+ * @see {@link UpdateThingShadowCommand} */ - public updateThingShadow( + updateThingShadow( args: UpdateThingShadowCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateThingShadow( + updateThingShadow( args: UpdateThingShadowCommandInput, cb: (err: any, data?: UpdateThingShadowCommandOutput) => void ): void; - public updateThingShadow( + updateThingShadow( args: UpdateThingShadowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateThingShadowCommandOutput) => void ): void; - public updateThingShadow( - args: UpdateThingShadowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateThingShadowCommandOutput) => void), - cb?: (err: any, data?: UpdateThingShadowCommandOutput) => void - ): Promise | void { - const command = new UpdateThingShadowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * IoT data + *

IoT data enables secure, bi-directional communication between Internet-connected things (such as sensors, + * actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. It implements a broker for applications and + * things to publish messages over HTTP (Publish) and retrieve, update, and delete shadows. A shadow is a + * persistent representation of your things and their state in the Amazon Web Services cloud.

+ *

Find the endpoint address for actions in IoT data by running this CLI command:

+ *

+ * aws iot describe-endpoint --endpoint-type iot:Data-ATS + *

+ *

The service name used by Amazon Web ServicesSignature Version 4 + * to sign requests is: iotdevicegateway.

+ */ +export class IoTDataPlane extends IoTDataPlaneClient implements IoTDataPlane {} +createAggregatedClient(commands, IoTDataPlane); diff --git a/clients/client-iot-events-data/src/IoTEventsData.ts b/clients/client-iot-events-data/src/IoTEventsData.ts index 89bf57d4a842..84b712cb6e05 100644 --- a/clients/client-iot-events-data/src/IoTEventsData.ts +++ b/clients/client-iot-events-data/src/IoTEventsData.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -57,415 +58,212 @@ import { ListDetectorsCommandInput, ListDetectorsCommandOutput, } from "./commands/ListDetectorsCommand"; -import { IoTEventsDataClient } from "./IoTEventsDataClient"; +import { IoTEventsDataClient, IoTEventsDataClientConfig } from "./IoTEventsDataClient"; -/** - * @public - *

IoT Events monitors your equipment or device fleets for failures or changes in operation, and - * triggers actions when such events occur. You can use IoT Events Data API commands to send inputs to - * detectors, list detectors, and view or update a detector's status.

- *

For more information, see What is IoT Events? in the - * IoT Events Developer Guide.

- */ -export class IoTEventsData extends IoTEventsDataClient { +const commands = { + BatchAcknowledgeAlarmCommand, + BatchDeleteDetectorCommand, + BatchDisableAlarmCommand, + BatchEnableAlarmCommand, + BatchPutMessageCommand, + BatchResetAlarmCommand, + BatchSnoozeAlarmCommand, + BatchUpdateDetectorCommand, + DescribeAlarmCommand, + DescribeDetectorCommand, + ListAlarmsCommand, + ListDetectorsCommand, +}; + +export interface IoTEventsData { /** - * @public - *

Acknowledges one or more alarms. The alarms change to the ACKNOWLEDGED state - * after you acknowledge them.

+ * @see {@link BatchAcknowledgeAlarmCommand} */ - public batchAcknowledgeAlarm( + batchAcknowledgeAlarm( args: BatchAcknowledgeAlarmCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchAcknowledgeAlarm( + batchAcknowledgeAlarm( args: BatchAcknowledgeAlarmCommandInput, cb: (err: any, data?: BatchAcknowledgeAlarmCommandOutput) => void ): void; - public batchAcknowledgeAlarm( + batchAcknowledgeAlarm( args: BatchAcknowledgeAlarmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchAcknowledgeAlarmCommandOutput) => void ): void; - public batchAcknowledgeAlarm( - args: BatchAcknowledgeAlarmCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchAcknowledgeAlarmCommandOutput) => void), - cb?: (err: any, data?: BatchAcknowledgeAlarmCommandOutput) => void - ): Promise | void { - const command = new BatchAcknowledgeAlarmCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes one or more detectors that were created. When a detector is deleted, its state will be cleared and the detector will be removed from the list of detectors. The deleted detector will no longer appear if referenced in the ListDetectors API call.

+ * @see {@link BatchDeleteDetectorCommand} */ - public batchDeleteDetector( + batchDeleteDetector( args: BatchDeleteDetectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeleteDetector( + batchDeleteDetector( args: BatchDeleteDetectorCommandInput, cb: (err: any, data?: BatchDeleteDetectorCommandOutput) => void ): void; - public batchDeleteDetector( + batchDeleteDetector( args: BatchDeleteDetectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteDetectorCommandOutput) => void ): void; - public batchDeleteDetector( - args: BatchDeleteDetectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeleteDetectorCommandOutput) => void), - cb?: (err: any, data?: BatchDeleteDetectorCommandOutput) => void - ): Promise | void { - const command = new BatchDeleteDetectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables one or more alarms. The alarms change to the DISABLED state after - * you disable them.

+ * @see {@link BatchDisableAlarmCommand} */ - public batchDisableAlarm( + batchDisableAlarm( args: BatchDisableAlarmCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDisableAlarm( + batchDisableAlarm( args: BatchDisableAlarmCommandInput, cb: (err: any, data?: BatchDisableAlarmCommandOutput) => void ): void; - public batchDisableAlarm( + batchDisableAlarm( args: BatchDisableAlarmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDisableAlarmCommandOutput) => void ): void; - public batchDisableAlarm( - args: BatchDisableAlarmCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDisableAlarmCommandOutput) => void), - cb?: (err: any, data?: BatchDisableAlarmCommandOutput) => void - ): Promise | void { - const command = new BatchDisableAlarmCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables one or more alarms. The alarms change to the NORMAL state after you - * enable them.

+ * @see {@link BatchEnableAlarmCommand} */ - public batchEnableAlarm( + batchEnableAlarm( args: BatchEnableAlarmCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchEnableAlarm( + batchEnableAlarm( args: BatchEnableAlarmCommandInput, cb: (err: any, data?: BatchEnableAlarmCommandOutput) => void ): void; - public batchEnableAlarm( + batchEnableAlarm( args: BatchEnableAlarmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchEnableAlarmCommandOutput) => void ): void; - public batchEnableAlarm( - args: BatchEnableAlarmCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchEnableAlarmCommandOutput) => void), - cb?: (err: any, data?: BatchEnableAlarmCommandOutput) => void - ): Promise | void { - const command = new BatchEnableAlarmCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sends a set of messages to the IoT Events system. Each message payload is transformed into - * the input you specify ("inputName") and ingested into any detectors that monitor - * that input. If multiple messages are sent, the order in which the messages are processed isn't - * guaranteed. To guarantee ordering, you must send messages one at a time and wait for a - * successful response.

+ * @see {@link BatchPutMessageCommand} */ - public batchPutMessage( + batchPutMessage( args: BatchPutMessageCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchPutMessage( - args: BatchPutMessageCommandInput, - cb: (err: any, data?: BatchPutMessageCommandOutput) => void - ): void; - public batchPutMessage( + batchPutMessage(args: BatchPutMessageCommandInput, cb: (err: any, data?: BatchPutMessageCommandOutput) => void): void; + batchPutMessage( args: BatchPutMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchPutMessageCommandOutput) => void ): void; - public batchPutMessage( - args: BatchPutMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchPutMessageCommandOutput) => void), - cb?: (err: any, data?: BatchPutMessageCommandOutput) => void - ): Promise | void { - const command = new BatchPutMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Resets one or more alarms. The alarms return to the NORMAL state after you - * reset them.

+ * @see {@link BatchResetAlarmCommand} */ - public batchResetAlarm( + batchResetAlarm( args: BatchResetAlarmCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchResetAlarm( - args: BatchResetAlarmCommandInput, - cb: (err: any, data?: BatchResetAlarmCommandOutput) => void - ): void; - public batchResetAlarm( + batchResetAlarm(args: BatchResetAlarmCommandInput, cb: (err: any, data?: BatchResetAlarmCommandOutput) => void): void; + batchResetAlarm( args: BatchResetAlarmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchResetAlarmCommandOutput) => void ): void; - public batchResetAlarm( - args: BatchResetAlarmCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchResetAlarmCommandOutput) => void), - cb?: (err: any, data?: BatchResetAlarmCommandOutput) => void - ): Promise | void { - const command = new BatchResetAlarmCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes one or more alarms to the snooze mode. The alarms change to the - * SNOOZE_DISABLED state after you set them to the snooze mode.

+ * @see {@link BatchSnoozeAlarmCommand} */ - public batchSnoozeAlarm( + batchSnoozeAlarm( args: BatchSnoozeAlarmCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchSnoozeAlarm( + batchSnoozeAlarm( args: BatchSnoozeAlarmCommandInput, cb: (err: any, data?: BatchSnoozeAlarmCommandOutput) => void ): void; - public batchSnoozeAlarm( + batchSnoozeAlarm( args: BatchSnoozeAlarmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchSnoozeAlarmCommandOutput) => void ): void; - public batchSnoozeAlarm( - args: BatchSnoozeAlarmCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchSnoozeAlarmCommandOutput) => void), - cb?: (err: any, data?: BatchSnoozeAlarmCommandOutput) => void - ): Promise | void { - const command = new BatchSnoozeAlarmCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the state, variable values, and timer settings of one or more detectors - * (instances) of a specified detector model.

+ * @see {@link BatchUpdateDetectorCommand} */ - public batchUpdateDetector( + batchUpdateDetector( args: BatchUpdateDetectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchUpdateDetector( + batchUpdateDetector( args: BatchUpdateDetectorCommandInput, cb: (err: any, data?: BatchUpdateDetectorCommandOutput) => void ): void; - public batchUpdateDetector( + batchUpdateDetector( args: BatchUpdateDetectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchUpdateDetectorCommandOutput) => void ): void; - public batchUpdateDetector( - args: BatchUpdateDetectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchUpdateDetectorCommandOutput) => void), - cb?: (err: any, data?: BatchUpdateDetectorCommandOutput) => void - ): Promise | void { - const command = new BatchUpdateDetectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about an alarm.

+ * @see {@link DescribeAlarmCommand} */ - public describeAlarm( - args: DescribeAlarmCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeAlarm( - args: DescribeAlarmCommandInput, - cb: (err: any, data?: DescribeAlarmCommandOutput) => void - ): void; - public describeAlarm( + describeAlarm(args: DescribeAlarmCommandInput, options?: __HttpHandlerOptions): Promise; + describeAlarm(args: DescribeAlarmCommandInput, cb: (err: any, data?: DescribeAlarmCommandOutput) => void): void; + describeAlarm( args: DescribeAlarmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAlarmCommandOutput) => void ): void; - public describeAlarm( - args: DescribeAlarmCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAlarmCommandOutput) => void), - cb?: (err: any, data?: DescribeAlarmCommandOutput) => void - ): Promise | void { - const command = new DescribeAlarmCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the specified detector (instance).

+ * @see {@link DescribeDetectorCommand} */ - public describeDetector( + describeDetector( args: DescribeDetectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDetector( + describeDetector( args: DescribeDetectorCommandInput, cb: (err: any, data?: DescribeDetectorCommandOutput) => void ): void; - public describeDetector( + describeDetector( args: DescribeDetectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDetectorCommandOutput) => void ): void; - public describeDetector( - args: DescribeDetectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDetectorCommandOutput) => void), - cb?: (err: any, data?: DescribeDetectorCommandOutput) => void - ): Promise | void { - const command = new DescribeDetectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists one or more alarms. The operation returns only the metadata associated with each - * alarm.

+ * @see {@link ListAlarmsCommand} */ - public listAlarms(args: ListAlarmsCommandInput, options?: __HttpHandlerOptions): Promise; - public listAlarms(args: ListAlarmsCommandInput, cb: (err: any, data?: ListAlarmsCommandOutput) => void): void; - public listAlarms( + listAlarms(args: ListAlarmsCommandInput, options?: __HttpHandlerOptions): Promise; + listAlarms(args: ListAlarmsCommandInput, cb: (err: any, data?: ListAlarmsCommandOutput) => void): void; + listAlarms( args: ListAlarmsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAlarmsCommandOutput) => void ): void; - public listAlarms( - args: ListAlarmsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAlarmsCommandOutput) => void), - cb?: (err: any, data?: ListAlarmsCommandOutput) => void - ): Promise | void { - const command = new ListAlarmsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists detectors (the instances of a detector model).

+ * @see {@link ListDetectorsCommand} */ - public listDetectors( - args: ListDetectorsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listDetectors( - args: ListDetectorsCommandInput, - cb: (err: any, data?: ListDetectorsCommandOutput) => void - ): void; - public listDetectors( + listDetectors(args: ListDetectorsCommandInput, options?: __HttpHandlerOptions): Promise; + listDetectors(args: ListDetectorsCommandInput, cb: (err: any, data?: ListDetectorsCommandOutput) => void): void; + listDetectors( args: ListDetectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDetectorsCommandOutput) => void ): void; - public listDetectors( - args: ListDetectorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDetectorsCommandOutput) => void), - cb?: (err: any, data?: ListDetectorsCommandOutput) => void - ): Promise | void { - const command = new ListDetectorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

IoT Events monitors your equipment or device fleets for failures or changes in operation, and + * triggers actions when such events occur. You can use IoT Events Data API commands to send inputs to + * detectors, list detectors, and view or update a detector's status.

+ *

For more information, see What is IoT Events? in the + * IoT Events Developer Guide.

+ */ +export class IoTEventsData extends IoTEventsDataClient implements IoTEventsData {} +createAggregatedClient(commands, IoTEventsData); diff --git a/clients/client-iot-events/src/IoTEvents.ts b/clients/client-iot-events/src/IoTEvents.ts index 496b313ef1c8..a6fd43b6d6ca 100644 --- a/clients/client-iot-events/src/IoTEvents.ts +++ b/clients/client-iot-events/src/IoTEvents.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -111,867 +112,441 @@ import { UpdateDetectorModelCommandOutput, } from "./commands/UpdateDetectorModelCommand"; import { UpdateInputCommand, UpdateInputCommandInput, UpdateInputCommandOutput } from "./commands/UpdateInputCommand"; -import { IoTEventsClient } from "./IoTEventsClient"; +import { IoTEventsClient, IoTEventsClientConfig } from "./IoTEventsClient"; -/** - * @public - *

AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and - * triggers actions when such events occur. You can use AWS IoT Events API operations to create, read, - * update, and delete inputs and detector models, and to list their versions.

- */ -export class IoTEvents extends IoTEventsClient { +const commands = { + CreateAlarmModelCommand, + CreateDetectorModelCommand, + CreateInputCommand, + DeleteAlarmModelCommand, + DeleteDetectorModelCommand, + DeleteInputCommand, + DescribeAlarmModelCommand, + DescribeDetectorModelCommand, + DescribeDetectorModelAnalysisCommand, + DescribeInputCommand, + DescribeLoggingOptionsCommand, + GetDetectorModelAnalysisResultsCommand, + ListAlarmModelsCommand, + ListAlarmModelVersionsCommand, + ListDetectorModelsCommand, + ListDetectorModelVersionsCommand, + ListInputRoutingsCommand, + ListInputsCommand, + ListTagsForResourceCommand, + PutLoggingOptionsCommand, + StartDetectorModelAnalysisCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAlarmModelCommand, + UpdateDetectorModelCommand, + UpdateInputCommand, +}; + +export interface IoTEvents { /** - * @public - *

Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get - * notified when the value is outside a specified range. For more information, see Create an - * alarm model in the AWS IoT Events Developer Guide.

+ * @see {@link CreateAlarmModelCommand} */ - public createAlarmModel( + createAlarmModel( args: CreateAlarmModelCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAlarmModel( + createAlarmModel( args: CreateAlarmModelCommandInput, cb: (err: any, data?: CreateAlarmModelCommandOutput) => void ): void; - public createAlarmModel( + createAlarmModel( args: CreateAlarmModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAlarmModelCommandOutput) => void ): void; - public createAlarmModel( - args: CreateAlarmModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAlarmModelCommandOutput) => void), - cb?: (err: any, data?: CreateAlarmModelCommandOutput) => void - ): Promise | void { - const command = new CreateAlarmModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a detector model.

+ * @see {@link CreateDetectorModelCommand} */ - public createDetectorModel( + createDetectorModel( args: CreateDetectorModelCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDetectorModel( + createDetectorModel( args: CreateDetectorModelCommandInput, cb: (err: any, data?: CreateDetectorModelCommandOutput) => void ): void; - public createDetectorModel( + createDetectorModel( args: CreateDetectorModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDetectorModelCommandOutput) => void ): void; - public createDetectorModel( - args: CreateDetectorModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDetectorModelCommandOutput) => void), - cb?: (err: any, data?: CreateDetectorModelCommandOutput) => void - ): Promise | void { - const command = new CreateDetectorModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an input.

+ * @see {@link CreateInputCommand} */ - public createInput(args: CreateInputCommandInput, options?: __HttpHandlerOptions): Promise; - public createInput(args: CreateInputCommandInput, cb: (err: any, data?: CreateInputCommandOutput) => void): void; - public createInput( + createInput(args: CreateInputCommandInput, options?: __HttpHandlerOptions): Promise; + createInput(args: CreateInputCommandInput, cb: (err: any, data?: CreateInputCommandOutput) => void): void; + createInput( args: CreateInputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInputCommandOutput) => void ): void; - public createInput( - args: CreateInputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateInputCommandOutput) => void), - cb?: (err: any, data?: CreateInputCommandOutput) => void - ): Promise | void { - const command = new CreateInputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an alarm model. Any alarm instances that were created based on this alarm model - * are also deleted. This action can't be undone.

+ * @see {@link DeleteAlarmModelCommand} */ - public deleteAlarmModel( + deleteAlarmModel( args: DeleteAlarmModelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAlarmModel( + deleteAlarmModel( args: DeleteAlarmModelCommandInput, cb: (err: any, data?: DeleteAlarmModelCommandOutput) => void ): void; - public deleteAlarmModel( + deleteAlarmModel( args: DeleteAlarmModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAlarmModelCommandOutput) => void ): void; - public deleteAlarmModel( - args: DeleteAlarmModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAlarmModelCommandOutput) => void), - cb?: (err: any, data?: DeleteAlarmModelCommandOutput) => void - ): Promise | void { - const command = new DeleteAlarmModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a detector model. Any active instances of the detector model are also - * deleted.

+ * @see {@link DeleteDetectorModelCommand} */ - public deleteDetectorModel( + deleteDetectorModel( args: DeleteDetectorModelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDetectorModel( + deleteDetectorModel( args: DeleteDetectorModelCommandInput, cb: (err: any, data?: DeleteDetectorModelCommandOutput) => void ): void; - public deleteDetectorModel( + deleteDetectorModel( args: DeleteDetectorModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDetectorModelCommandOutput) => void ): void; - public deleteDetectorModel( - args: DeleteDetectorModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDetectorModelCommandOutput) => void), - cb?: (err: any, data?: DeleteDetectorModelCommandOutput) => void - ): Promise | void { - const command = new DeleteDetectorModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an input.

+ * @see {@link DeleteInputCommand} */ - public deleteInput(args: DeleteInputCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteInput(args: DeleteInputCommandInput, cb: (err: any, data?: DeleteInputCommandOutput) => void): void; - public deleteInput( + deleteInput(args: DeleteInputCommandInput, options?: __HttpHandlerOptions): Promise; + deleteInput(args: DeleteInputCommandInput, cb: (err: any, data?: DeleteInputCommandOutput) => void): void; + deleteInput( args: DeleteInputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInputCommandOutput) => void ): void; - public deleteInput( - args: DeleteInputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInputCommandOutput) => void), - cb?: (err: any, data?: DeleteInputCommandOutput) => void - ): Promise | void { - const command = new DeleteInputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about an alarm model. If you don't specify a value for the - * alarmModelVersion parameter, the latest version is returned.

+ * @see {@link DescribeAlarmModelCommand} */ - public describeAlarmModel( + describeAlarmModel( args: DescribeAlarmModelCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAlarmModel( + describeAlarmModel( args: DescribeAlarmModelCommandInput, cb: (err: any, data?: DescribeAlarmModelCommandOutput) => void ): void; - public describeAlarmModel( + describeAlarmModel( args: DescribeAlarmModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAlarmModelCommandOutput) => void ): void; - public describeAlarmModel( - args: DescribeAlarmModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAlarmModelCommandOutput) => void), - cb?: (err: any, data?: DescribeAlarmModelCommandOutput) => void - ): Promise | void { - const command = new DescribeAlarmModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a detector model. If the version parameter is not specified, - * information about the latest version is returned.

+ * @see {@link DescribeDetectorModelCommand} */ - public describeDetectorModel( + describeDetectorModel( args: DescribeDetectorModelCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDetectorModel( + describeDetectorModel( args: DescribeDetectorModelCommandInput, cb: (err: any, data?: DescribeDetectorModelCommandOutput) => void ): void; - public describeDetectorModel( + describeDetectorModel( args: DescribeDetectorModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDetectorModelCommandOutput) => void ): void; - public describeDetectorModel( - args: DescribeDetectorModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDetectorModelCommandOutput) => void), - cb?: (err: any, data?: DescribeDetectorModelCommandOutput) => void - ): Promise | void { - const command = new DescribeDetectorModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves runtime information about a detector model analysis.

- * - *

After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.

- *
+ * @see {@link DescribeDetectorModelAnalysisCommand} */ - public describeDetectorModelAnalysis( + describeDetectorModelAnalysis( args: DescribeDetectorModelAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDetectorModelAnalysis( + describeDetectorModelAnalysis( args: DescribeDetectorModelAnalysisCommandInput, cb: (err: any, data?: DescribeDetectorModelAnalysisCommandOutput) => void ): void; - public describeDetectorModelAnalysis( + describeDetectorModelAnalysis( args: DescribeDetectorModelAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDetectorModelAnalysisCommandOutput) => void ): void; - public describeDetectorModelAnalysis( - args: DescribeDetectorModelAnalysisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDetectorModelAnalysisCommandOutput) => void), - cb?: (err: any, data?: DescribeDetectorModelAnalysisCommandOutput) => void - ): Promise | void { - const command = new DescribeDetectorModelAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an input.

+ * @see {@link DescribeInputCommand} */ - public describeInput( - args: DescribeInputCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeInput( - args: DescribeInputCommandInput, - cb: (err: any, data?: DescribeInputCommandOutput) => void - ): void; - public describeInput( + describeInput(args: DescribeInputCommandInput, options?: __HttpHandlerOptions): Promise; + describeInput(args: DescribeInputCommandInput, cb: (err: any, data?: DescribeInputCommandOutput) => void): void; + describeInput( args: DescribeInputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInputCommandOutput) => void ): void; - public describeInput( - args: DescribeInputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInputCommandOutput) => void), - cb?: (err: any, data?: DescribeInputCommandOutput) => void - ): Promise | void { - const command = new DescribeInputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the current settings of the AWS IoT Events logging options.

+ * @see {@link DescribeLoggingOptionsCommand} */ - public describeLoggingOptions( + describeLoggingOptions( args: DescribeLoggingOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLoggingOptions( + describeLoggingOptions( args: DescribeLoggingOptionsCommandInput, cb: (err: any, data?: DescribeLoggingOptionsCommandOutput) => void ): void; - public describeLoggingOptions( + describeLoggingOptions( args: DescribeLoggingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLoggingOptionsCommandOutput) => void ): void; - public describeLoggingOptions( - args: DescribeLoggingOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLoggingOptionsCommandOutput) => void), - cb?: (err: any, data?: DescribeLoggingOptionsCommandOutput) => void - ): Promise | void { - const command = new DescribeLoggingOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves one or more analysis results of the detector model.

- * - *

After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.

- *
+ * @see {@link GetDetectorModelAnalysisResultsCommand} */ - public getDetectorModelAnalysisResults( + getDetectorModelAnalysisResults( args: GetDetectorModelAnalysisResultsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDetectorModelAnalysisResults( + getDetectorModelAnalysisResults( args: GetDetectorModelAnalysisResultsCommandInput, cb: (err: any, data?: GetDetectorModelAnalysisResultsCommandOutput) => void ): void; - public getDetectorModelAnalysisResults( + getDetectorModelAnalysisResults( args: GetDetectorModelAnalysisResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDetectorModelAnalysisResultsCommandOutput) => void ): void; - public getDetectorModelAnalysisResults( - args: GetDetectorModelAnalysisResultsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDetectorModelAnalysisResultsCommandOutput) => void), - cb?: (err: any, data?: GetDetectorModelAnalysisResultsCommandOutput) => void - ): Promise | void { - const command = new GetDetectorModelAnalysisResultsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the alarm models that you created. The operation returns only the metadata - * associated with each alarm model.

+ * @see {@link ListAlarmModelsCommand} */ - public listAlarmModels( + listAlarmModels( args: ListAlarmModelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAlarmModels( - args: ListAlarmModelsCommandInput, - cb: (err: any, data?: ListAlarmModelsCommandOutput) => void - ): void; - public listAlarmModels( + listAlarmModels(args: ListAlarmModelsCommandInput, cb: (err: any, data?: ListAlarmModelsCommandOutput) => void): void; + listAlarmModels( args: ListAlarmModelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAlarmModelsCommandOutput) => void ): void; - public listAlarmModels( - args: ListAlarmModelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAlarmModelsCommandOutput) => void), - cb?: (err: any, data?: ListAlarmModelsCommandOutput) => void - ): Promise | void { - const command = new ListAlarmModelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the versions of an alarm model. The operation returns only the metadata - * associated with each alarm model version.

+ * @see {@link ListAlarmModelVersionsCommand} */ - public listAlarmModelVersions( + listAlarmModelVersions( args: ListAlarmModelVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAlarmModelVersions( + listAlarmModelVersions( args: ListAlarmModelVersionsCommandInput, cb: (err: any, data?: ListAlarmModelVersionsCommandOutput) => void ): void; - public listAlarmModelVersions( + listAlarmModelVersions( args: ListAlarmModelVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAlarmModelVersionsCommandOutput) => void ): void; - public listAlarmModelVersions( - args: ListAlarmModelVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAlarmModelVersionsCommandOutput) => void), - cb?: (err: any, data?: ListAlarmModelVersionsCommandOutput) => void - ): Promise | void { - const command = new ListAlarmModelVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the detector models you have created. Only the metadata associated with each - * detector model is returned.

+ * @see {@link ListDetectorModelsCommand} */ - public listDetectorModels( + listDetectorModels( args: ListDetectorModelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDetectorModels( + listDetectorModels( args: ListDetectorModelsCommandInput, cb: (err: any, data?: ListDetectorModelsCommandOutput) => void ): void; - public listDetectorModels( + listDetectorModels( args: ListDetectorModelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDetectorModelsCommandOutput) => void ): void; - public listDetectorModels( - args: ListDetectorModelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDetectorModelsCommandOutput) => void), - cb?: (err: any, data?: ListDetectorModelsCommandOutput) => void - ): Promise | void { - const command = new ListDetectorModelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the versions of a detector model. Only the metadata associated with each - * detector model version is returned.

+ * @see {@link ListDetectorModelVersionsCommand} */ - public listDetectorModelVersions( + listDetectorModelVersions( args: ListDetectorModelVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDetectorModelVersions( + listDetectorModelVersions( args: ListDetectorModelVersionsCommandInput, cb: (err: any, data?: ListDetectorModelVersionsCommandOutput) => void ): void; - public listDetectorModelVersions( + listDetectorModelVersions( args: ListDetectorModelVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDetectorModelVersionsCommandOutput) => void ): void; - public listDetectorModelVersions( - args: ListDetectorModelVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDetectorModelVersionsCommandOutput) => void), - cb?: (err: any, data?: ListDetectorModelVersionsCommandOutput) => void - ): Promise | void { - const command = new ListDetectorModelVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Lists one or more input routings. - *

+ * @see {@link ListInputRoutingsCommand} */ - public listInputRoutings( + listInputRoutings( args: ListInputRoutingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInputRoutings( + listInputRoutings( args: ListInputRoutingsCommandInput, cb: (err: any, data?: ListInputRoutingsCommandOutput) => void ): void; - public listInputRoutings( + listInputRoutings( args: ListInputRoutingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInputRoutingsCommandOutput) => void ): void; - public listInputRoutings( - args: ListInputRoutingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInputRoutingsCommandOutput) => void), - cb?: (err: any, data?: ListInputRoutingsCommandOutput) => void - ): Promise | void { - const command = new ListInputRoutingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the inputs you have created.

+ * @see {@link ListInputsCommand} */ - public listInputs(args: ListInputsCommandInput, options?: __HttpHandlerOptions): Promise; - public listInputs(args: ListInputsCommandInput, cb: (err: any, data?: ListInputsCommandOutput) => void): void; - public listInputs( + listInputs(args: ListInputsCommandInput, options?: __HttpHandlerOptions): Promise; + listInputs(args: ListInputsCommandInput, cb: (err: any, data?: ListInputsCommandOutput) => void): void; + listInputs( args: ListInputsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInputsCommandOutput) => void ): void; - public listInputs( - args: ListInputsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInputsCommandOutput) => void), - cb?: (err: any, data?: ListInputsCommandOutput) => void - ): Promise | void { - const command = new ListInputsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags (metadata) you have assigned to the resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets or updates the AWS IoT Events logging options.

- *

If you update the value of any loggingOptions field, it takes up to one - * minute for the change to take effect. If you change the policy attached to the role you - * specified in the roleArn field (for example, to correct an invalid policy), it - * takes up to five minutes for that change to take effect.

+ * @see {@link PutLoggingOptionsCommand} */ - public putLoggingOptions( + putLoggingOptions( args: PutLoggingOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putLoggingOptions( + putLoggingOptions( args: PutLoggingOptionsCommandInput, cb: (err: any, data?: PutLoggingOptionsCommandOutput) => void ): void; - public putLoggingOptions( + putLoggingOptions( args: PutLoggingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLoggingOptionsCommandOutput) => void ): void; - public putLoggingOptions( - args: PutLoggingOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutLoggingOptionsCommandOutput) => void), - cb?: (err: any, data?: PutLoggingOptionsCommandOutput) => void - ): Promise | void { - const command = new PutLoggingOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Performs an analysis of your detector model. For more information, - * see Troubleshooting a detector model - * in the AWS IoT Events Developer Guide.

+ * @see {@link StartDetectorModelAnalysisCommand} */ - public startDetectorModelAnalysis( + startDetectorModelAnalysis( args: StartDetectorModelAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDetectorModelAnalysis( + startDetectorModelAnalysis( args: StartDetectorModelAnalysisCommandInput, cb: (err: any, data?: StartDetectorModelAnalysisCommandOutput) => void ): void; - public startDetectorModelAnalysis( + startDetectorModelAnalysis( args: StartDetectorModelAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDetectorModelAnalysisCommandOutput) => void ): void; - public startDetectorModelAnalysis( - args: StartDetectorModelAnalysisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDetectorModelAnalysisCommandOutput) => void), - cb?: (err: any, data?: StartDetectorModelAnalysisCommandOutput) => void - ): Promise | void { - const command = new StartDetectorModelAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to - * manage a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the given tags (metadata) from the resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an alarm model. Any alarms that were created based on the previous version are - * deleted and then created again as new data arrives.

+ * @see {@link UpdateAlarmModelCommand} */ - public updateAlarmModel( + updateAlarmModel( args: UpdateAlarmModelCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAlarmModel( + updateAlarmModel( args: UpdateAlarmModelCommandInput, cb: (err: any, data?: UpdateAlarmModelCommandOutput) => void ): void; - public updateAlarmModel( + updateAlarmModel( args: UpdateAlarmModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAlarmModelCommandOutput) => void ): void; - public updateAlarmModel( - args: UpdateAlarmModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAlarmModelCommandOutput) => void), - cb?: (err: any, data?: UpdateAlarmModelCommandOutput) => void - ): Promise | void { - const command = new UpdateAlarmModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a detector model. Detectors (instances) spawned by the previous version are - * deleted and then re-created as new inputs arrive.

+ * @see {@link UpdateDetectorModelCommand} */ - public updateDetectorModel( + updateDetectorModel( args: UpdateDetectorModelCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDetectorModel( + updateDetectorModel( args: UpdateDetectorModelCommandInput, cb: (err: any, data?: UpdateDetectorModelCommandOutput) => void ): void; - public updateDetectorModel( + updateDetectorModel( args: UpdateDetectorModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDetectorModelCommandOutput) => void ): void; - public updateDetectorModel( - args: UpdateDetectorModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDetectorModelCommandOutput) => void), - cb?: (err: any, data?: UpdateDetectorModelCommandOutput) => void - ): Promise | void { - const command = new UpdateDetectorModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an input.

+ * @see {@link UpdateInputCommand} */ - public updateInput(args: UpdateInputCommandInput, options?: __HttpHandlerOptions): Promise; - public updateInput(args: UpdateInputCommandInput, cb: (err: any, data?: UpdateInputCommandOutput) => void): void; - public updateInput( + updateInput(args: UpdateInputCommandInput, options?: __HttpHandlerOptions): Promise; + updateInput(args: UpdateInputCommandInput, cb: (err: any, data?: UpdateInputCommandOutput) => void): void; + updateInput( args: UpdateInputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateInputCommandOutput) => void ): void; - public updateInput( - args: UpdateInputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateInputCommandOutput) => void), - cb?: (err: any, data?: UpdateInputCommandOutput) => void - ): Promise | void { - const command = new UpdateInputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and + * triggers actions when such events occur. You can use AWS IoT Events API operations to create, read, + * update, and delete inputs and detector models, and to list their versions.

+ */ +export class IoTEvents extends IoTEventsClient implements IoTEvents {} +createAggregatedClient(commands, IoTEvents); diff --git a/clients/client-iot-jobs-data-plane/src/IoTJobsDataPlane.ts b/clients/client-iot-jobs-data-plane/src/IoTJobsDataPlane.ts index 708335bfae09..2f4933a156f3 100644 --- a/clients/client-iot-jobs-data-plane/src/IoTJobsDataPlane.ts +++ b/clients/client-iot-jobs-data-plane/src/IoTJobsDataPlane.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -21,152 +22,98 @@ import { UpdateJobExecutionCommandInput, UpdateJobExecutionCommandOutput, } from "./commands/UpdateJobExecutionCommand"; -import { IoTJobsDataPlaneClient } from "./IoTJobsDataPlaneClient"; +import { IoTJobsDataPlaneClient, IoTJobsDataPlaneClientConfig } from "./IoTJobsDataPlaneClient"; -/** - * @public - *

AWS IoT Jobs is a service that allows you to define a set of jobs — remote operations that are sent to - * and executed on one or more devices connected to AWS IoT. For example, you can define a job that instructs a - * set of devices to download and install application or firmware updates, reboot, rotate certificates, or perform - * remote troubleshooting operations.

- *

To create a job, you make a job document which is a description of the remote operations to be - * performed, and you specify a list of targets that should perform the operations. The targets can be individual - * things, thing groups or both.

- *

AWS IoT Jobs sends a message to inform the targets that a job is available. The target starts the - * execution of the job by downloading the job document, performing the operations it specifies, and reporting its - * progress to AWS IoT. The Jobs service provides commands to track the progress of a job on a specific target and - * for all the targets of the job

- */ -export class IoTJobsDataPlane extends IoTJobsDataPlaneClient { +const commands = { + DescribeJobExecutionCommand, + GetPendingJobExecutionsCommand, + StartNextPendingJobExecutionCommand, + UpdateJobExecutionCommand, +}; + +export interface IoTJobsDataPlane { /** - * @public - *

Gets details of a job execution.

+ * @see {@link DescribeJobExecutionCommand} */ - public describeJobExecution( + describeJobExecution( args: DescribeJobExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeJobExecution( + describeJobExecution( args: DescribeJobExecutionCommandInput, cb: (err: any, data?: DescribeJobExecutionCommandOutput) => void ): void; - public describeJobExecution( + describeJobExecution( args: DescribeJobExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobExecutionCommandOutput) => void ): void; - public describeJobExecution( - args: DescribeJobExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeJobExecutionCommandOutput) => void), - cb?: (err: any, data?: DescribeJobExecutionCommandOutput) => void - ): Promise | void { - const command = new DescribeJobExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the list of all jobs for a thing that are not in a terminal status.

+ * @see {@link GetPendingJobExecutionsCommand} */ - public getPendingJobExecutions( + getPendingJobExecutions( args: GetPendingJobExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPendingJobExecutions( + getPendingJobExecutions( args: GetPendingJobExecutionsCommandInput, cb: (err: any, data?: GetPendingJobExecutionsCommandOutput) => void ): void; - public getPendingJobExecutions( + getPendingJobExecutions( args: GetPendingJobExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPendingJobExecutionsCommandOutput) => void ): void; - public getPendingJobExecutions( - args: GetPendingJobExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPendingJobExecutionsCommandOutput) => void), - cb?: (err: any, data?: GetPendingJobExecutionsCommandOutput) => void - ): Promise | void { - const command = new GetPendingJobExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.

+ * @see {@link StartNextPendingJobExecutionCommand} */ - public startNextPendingJobExecution( + startNextPendingJobExecution( args: StartNextPendingJobExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startNextPendingJobExecution( + startNextPendingJobExecution( args: StartNextPendingJobExecutionCommandInput, cb: (err: any, data?: StartNextPendingJobExecutionCommandOutput) => void ): void; - public startNextPendingJobExecution( + startNextPendingJobExecution( args: StartNextPendingJobExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartNextPendingJobExecutionCommandOutput) => void ): void; - public startNextPendingJobExecution( - args: StartNextPendingJobExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartNextPendingJobExecutionCommandOutput) => void), - cb?: (err: any, data?: StartNextPendingJobExecutionCommandOutput) => void - ): Promise | void { - const command = new StartNextPendingJobExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the status of a job execution.

+ * @see {@link UpdateJobExecutionCommand} */ - public updateJobExecution( + updateJobExecution( args: UpdateJobExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateJobExecution( + updateJobExecution( args: UpdateJobExecutionCommandInput, cb: (err: any, data?: UpdateJobExecutionCommandOutput) => void ): void; - public updateJobExecution( + updateJobExecution( args: UpdateJobExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateJobExecutionCommandOutput) => void ): void; - public updateJobExecution( - args: UpdateJobExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateJobExecutionCommandOutput) => void), - cb?: (err: any, data?: UpdateJobExecutionCommandOutput) => void - ): Promise | void { - const command = new UpdateJobExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

AWS IoT Jobs is a service that allows you to define a set of jobs — remote operations that are sent to + * and executed on one or more devices connected to AWS IoT. For example, you can define a job that instructs a + * set of devices to download and install application or firmware updates, reboot, rotate certificates, or perform + * remote troubleshooting operations.

+ *

To create a job, you make a job document which is a description of the remote operations to be + * performed, and you specify a list of targets that should perform the operations. The targets can be individual + * things, thing groups or both.

+ *

AWS IoT Jobs sends a message to inform the targets that a job is available. The target starts the + * execution of the job by downloading the job document, performing the operations it specifies, and reporting its + * progress to AWS IoT. The Jobs service provides commands to track the progress of a job on a specific target and + * for all the targets of the job

+ */ +export class IoTJobsDataPlane extends IoTJobsDataPlaneClient implements IoTJobsDataPlane {} +createAggregatedClient(commands, IoTJobsDataPlane); diff --git a/clients/client-iot-roborunner/src/IoTRoboRunner.ts b/clients/client-iot-roborunner/src/IoTRoboRunner.ts index f581176b9f34..2b713d427efa 100644 --- a/clients/client-iot-roborunner/src/IoTRoboRunner.ts +++ b/clients/client-iot-roborunner/src/IoTRoboRunner.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -73,620 +74,311 @@ import { UpdateWorkerFleetCommandInput, UpdateWorkerFleetCommandOutput, } from "./commands/UpdateWorkerFleetCommand"; -import { IoTRoboRunnerClient } from "./IoTRoboRunnerClient"; +import { IoTRoboRunnerClient, IoTRoboRunnerClientConfig } from "./IoTRoboRunnerClient"; -/** - * @public - * An example service, deployed with the Octane Service creator, - * which will echo the string - */ -export class IoTRoboRunner extends IoTRoboRunnerClient { +const commands = { + CreateDestinationCommand, + CreateSiteCommand, + CreateWorkerCommand, + CreateWorkerFleetCommand, + DeleteDestinationCommand, + DeleteSiteCommand, + DeleteWorkerCommand, + DeleteWorkerFleetCommand, + GetDestinationCommand, + GetSiteCommand, + GetWorkerCommand, + GetWorkerFleetCommand, + ListDestinationsCommand, + ListSitesCommand, + ListWorkerFleetsCommand, + ListWorkersCommand, + UpdateDestinationCommand, + UpdateSiteCommand, + UpdateWorkerCommand, + UpdateWorkerFleetCommand, +}; + +export interface IoTRoboRunner { /** - * @public - * Grants permission to create a destination + * @see {@link CreateDestinationCommand} */ - public createDestination( + createDestination( args: CreateDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDestination( + createDestination( args: CreateDestinationCommandInput, cb: (err: any, data?: CreateDestinationCommandOutput) => void ): void; - public createDestination( + createDestination( args: CreateDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDestinationCommandOutput) => void ): void; - public createDestination( - args: CreateDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDestinationCommandOutput) => void), - cb?: (err: any, data?: CreateDestinationCommandOutput) => void - ): Promise | void { - const command = new CreateDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Grants permission to create a site + * @see {@link CreateSiteCommand} */ - public createSite(args: CreateSiteCommandInput, options?: __HttpHandlerOptions): Promise; - public createSite(args: CreateSiteCommandInput, cb: (err: any, data?: CreateSiteCommandOutput) => void): void; - public createSite( + createSite(args: CreateSiteCommandInput, options?: __HttpHandlerOptions): Promise; + createSite(args: CreateSiteCommandInput, cb: (err: any, data?: CreateSiteCommandOutput) => void): void; + createSite( args: CreateSiteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSiteCommandOutput) => void ): void; - public createSite( - args: CreateSiteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSiteCommandOutput) => void), - cb?: (err: any, data?: CreateSiteCommandOutput) => void - ): Promise | void { - const command = new CreateSiteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Grants permission to create a worker + * @see {@link CreateWorkerCommand} */ - public createWorker( - args: CreateWorkerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createWorker(args: CreateWorkerCommandInput, cb: (err: any, data?: CreateWorkerCommandOutput) => void): void; - public createWorker( + createWorker(args: CreateWorkerCommandInput, options?: __HttpHandlerOptions): Promise; + createWorker(args: CreateWorkerCommandInput, cb: (err: any, data?: CreateWorkerCommandOutput) => void): void; + createWorker( args: CreateWorkerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkerCommandOutput) => void ): void; - public createWorker( - args: CreateWorkerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorkerCommandOutput) => void), - cb?: (err: any, data?: CreateWorkerCommandOutput) => void - ): Promise | void { - const command = new CreateWorkerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Grants permission to create a worker fleet + * @see {@link CreateWorkerFleetCommand} */ - public createWorkerFleet( + createWorkerFleet( args: CreateWorkerFleetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorkerFleet( + createWorkerFleet( args: CreateWorkerFleetCommandInput, cb: (err: any, data?: CreateWorkerFleetCommandOutput) => void ): void; - public createWorkerFleet( + createWorkerFleet( args: CreateWorkerFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkerFleetCommandOutput) => void ): void; - public createWorkerFleet( - args: CreateWorkerFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorkerFleetCommandOutput) => void), - cb?: (err: any, data?: CreateWorkerFleetCommandOutput) => void - ): Promise | void { - const command = new CreateWorkerFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Grants permission to delete a destination + * @see {@link DeleteDestinationCommand} */ - public deleteDestination( + deleteDestination( args: DeleteDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDestination( + deleteDestination( args: DeleteDestinationCommandInput, cb: (err: any, data?: DeleteDestinationCommandOutput) => void ): void; - public deleteDestination( + deleteDestination( args: DeleteDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDestinationCommandOutput) => void ): void; - public deleteDestination( - args: DeleteDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDestinationCommandOutput) => void), - cb?: (err: any, data?: DeleteDestinationCommandOutput) => void - ): Promise | void { - const command = new DeleteDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Grants permission to delete a site + * @see {@link DeleteSiteCommand} */ - public deleteSite(args: DeleteSiteCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteSite(args: DeleteSiteCommandInput, cb: (err: any, data?: DeleteSiteCommandOutput) => void): void; - public deleteSite( + deleteSite(args: DeleteSiteCommandInput, options?: __HttpHandlerOptions): Promise; + deleteSite(args: DeleteSiteCommandInput, cb: (err: any, data?: DeleteSiteCommandOutput) => void): void; + deleteSite( args: DeleteSiteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSiteCommandOutput) => void ): void; - public deleteSite( - args: DeleteSiteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSiteCommandOutput) => void), - cb?: (err: any, data?: DeleteSiteCommandOutput) => void - ): Promise | void { - const command = new DeleteSiteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Grants permission to delete a worker + * @see {@link DeleteWorkerCommand} */ - public deleteWorker( - args: DeleteWorkerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteWorker(args: DeleteWorkerCommandInput, cb: (err: any, data?: DeleteWorkerCommandOutput) => void): void; - public deleteWorker( + deleteWorker(args: DeleteWorkerCommandInput, options?: __HttpHandlerOptions): Promise; + deleteWorker(args: DeleteWorkerCommandInput, cb: (err: any, data?: DeleteWorkerCommandOutput) => void): void; + deleteWorker( args: DeleteWorkerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkerCommandOutput) => void ): void; - public deleteWorker( - args: DeleteWorkerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorkerCommandOutput) => void), - cb?: (err: any, data?: DeleteWorkerCommandOutput) => void - ): Promise | void { - const command = new DeleteWorkerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Grants permission to delete a worker fleet + * @see {@link DeleteWorkerFleetCommand} */ - public deleteWorkerFleet( + deleteWorkerFleet( args: DeleteWorkerFleetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWorkerFleet( + deleteWorkerFleet( args: DeleteWorkerFleetCommandInput, cb: (err: any, data?: DeleteWorkerFleetCommandOutput) => void ): void; - public deleteWorkerFleet( + deleteWorkerFleet( args: DeleteWorkerFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkerFleetCommandOutput) => void ): void; - public deleteWorkerFleet( - args: DeleteWorkerFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorkerFleetCommandOutput) => void), - cb?: (err: any, data?: DeleteWorkerFleetCommandOutput) => void - ): Promise | void { - const command = new DeleteWorkerFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Grants permission to get a destination + * @see {@link GetDestinationCommand} */ - public getDestination( + getDestination( args: GetDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDestination( - args: GetDestinationCommandInput, - cb: (err: any, data?: GetDestinationCommandOutput) => void - ): void; - public getDestination( + getDestination(args: GetDestinationCommandInput, cb: (err: any, data?: GetDestinationCommandOutput) => void): void; + getDestination( args: GetDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDestinationCommandOutput) => void ): void; - public getDestination( - args: GetDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDestinationCommandOutput) => void), - cb?: (err: any, data?: GetDestinationCommandOutput) => void - ): Promise | void { - const command = new GetDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Grants permission to get a site + * @see {@link GetSiteCommand} */ - public getSite(args: GetSiteCommandInput, options?: __HttpHandlerOptions): Promise; - public getSite(args: GetSiteCommandInput, cb: (err: any, data?: GetSiteCommandOutput) => void): void; - public getSite( + getSite(args: GetSiteCommandInput, options?: __HttpHandlerOptions): Promise; + getSite(args: GetSiteCommandInput, cb: (err: any, data?: GetSiteCommandOutput) => void): void; + getSite( args: GetSiteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSiteCommandOutput) => void ): void; - public getSite( - args: GetSiteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSiteCommandOutput) => void), - cb?: (err: any, data?: GetSiteCommandOutput) => void - ): Promise | void { - const command = new GetSiteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Grants permission to get a worker + * @see {@link GetWorkerCommand} */ - public getWorker(args: GetWorkerCommandInput, options?: __HttpHandlerOptions): Promise; - public getWorker(args: GetWorkerCommandInput, cb: (err: any, data?: GetWorkerCommandOutput) => void): void; - public getWorker( + getWorker(args: GetWorkerCommandInput, options?: __HttpHandlerOptions): Promise; + getWorker(args: GetWorkerCommandInput, cb: (err: any, data?: GetWorkerCommandOutput) => void): void; + getWorker( args: GetWorkerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkerCommandOutput) => void ): void; - public getWorker( - args: GetWorkerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkerCommandOutput) => void), - cb?: (err: any, data?: GetWorkerCommandOutput) => void - ): Promise | void { - const command = new GetWorkerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Grants permission to get a worker fleet + * @see {@link GetWorkerFleetCommand} */ - public getWorkerFleet( + getWorkerFleet( args: GetWorkerFleetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWorkerFleet( - args: GetWorkerFleetCommandInput, - cb: (err: any, data?: GetWorkerFleetCommandOutput) => void - ): void; - public getWorkerFleet( + getWorkerFleet(args: GetWorkerFleetCommandInput, cb: (err: any, data?: GetWorkerFleetCommandOutput) => void): void; + getWorkerFleet( args: GetWorkerFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkerFleetCommandOutput) => void ): void; - public getWorkerFleet( - args: GetWorkerFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkerFleetCommandOutput) => void), - cb?: (err: any, data?: GetWorkerFleetCommandOutput) => void - ): Promise | void { - const command = new GetWorkerFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Grants permission to list destinations + * @see {@link ListDestinationsCommand} */ - public listDestinations( + listDestinations( args: ListDestinationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDestinations( + listDestinations( args: ListDestinationsCommandInput, cb: (err: any, data?: ListDestinationsCommandOutput) => void ): void; - public listDestinations( + listDestinations( args: ListDestinationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDestinationsCommandOutput) => void ): void; - public listDestinations( - args: ListDestinationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDestinationsCommandOutput) => void), - cb?: (err: any, data?: ListDestinationsCommandOutput) => void - ): Promise | void { - const command = new ListDestinationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Grants permission to list sites + * @see {@link ListSitesCommand} */ - public listSites(args: ListSitesCommandInput, options?: __HttpHandlerOptions): Promise; - public listSites(args: ListSitesCommandInput, cb: (err: any, data?: ListSitesCommandOutput) => void): void; - public listSites( + listSites(args: ListSitesCommandInput, options?: __HttpHandlerOptions): Promise; + listSites(args: ListSitesCommandInput, cb: (err: any, data?: ListSitesCommandOutput) => void): void; + listSites( args: ListSitesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSitesCommandOutput) => void ): void; - public listSites( - args: ListSitesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSitesCommandOutput) => void), - cb?: (err: any, data?: ListSitesCommandOutput) => void - ): Promise | void { - const command = new ListSitesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Grants permission to list worker fleets + * @see {@link ListWorkerFleetsCommand} */ - public listWorkerFleets( + listWorkerFleets( args: ListWorkerFleetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWorkerFleets( + listWorkerFleets( args: ListWorkerFleetsCommandInput, cb: (err: any, data?: ListWorkerFleetsCommandOutput) => void ): void; - public listWorkerFleets( + listWorkerFleets( args: ListWorkerFleetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkerFleetsCommandOutput) => void ): void; - public listWorkerFleets( - args: ListWorkerFleetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkerFleetsCommandOutput) => void), - cb?: (err: any, data?: ListWorkerFleetsCommandOutput) => void - ): Promise | void { - const command = new ListWorkerFleetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Grants permission to list workers + * @see {@link ListWorkersCommand} */ - public listWorkers(args: ListWorkersCommandInput, options?: __HttpHandlerOptions): Promise; - public listWorkers(args: ListWorkersCommandInput, cb: (err: any, data?: ListWorkersCommandOutput) => void): void; - public listWorkers( + listWorkers(args: ListWorkersCommandInput, options?: __HttpHandlerOptions): Promise; + listWorkers(args: ListWorkersCommandInput, cb: (err: any, data?: ListWorkersCommandOutput) => void): void; + listWorkers( args: ListWorkersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkersCommandOutput) => void ): void; - public listWorkers( - args: ListWorkersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkersCommandOutput) => void), - cb?: (err: any, data?: ListWorkersCommandOutput) => void - ): Promise | void { - const command = new ListWorkersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Grants permission to update a destination + * @see {@link UpdateDestinationCommand} */ - public updateDestination( + updateDestination( args: UpdateDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDestination( + updateDestination( args: UpdateDestinationCommandInput, cb: (err: any, data?: UpdateDestinationCommandOutput) => void ): void; - public updateDestination( + updateDestination( args: UpdateDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDestinationCommandOutput) => void ): void; - public updateDestination( - args: UpdateDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDestinationCommandOutput) => void), - cb?: (err: any, data?: UpdateDestinationCommandOutput) => void - ): Promise | void { - const command = new UpdateDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Grants permission to update a site + * @see {@link UpdateSiteCommand} */ - public updateSite(args: UpdateSiteCommandInput, options?: __HttpHandlerOptions): Promise; - public updateSite(args: UpdateSiteCommandInput, cb: (err: any, data?: UpdateSiteCommandOutput) => void): void; - public updateSite( + updateSite(args: UpdateSiteCommandInput, options?: __HttpHandlerOptions): Promise; + updateSite(args: UpdateSiteCommandInput, cb: (err: any, data?: UpdateSiteCommandOutput) => void): void; + updateSite( args: UpdateSiteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSiteCommandOutput) => void ): void; - public updateSite( - args: UpdateSiteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSiteCommandOutput) => void), - cb?: (err: any, data?: UpdateSiteCommandOutput) => void - ): Promise | void { - const command = new UpdateSiteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Grants permission to update a worker + * @see {@link UpdateWorkerCommand} */ - public updateWorker( - args: UpdateWorkerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateWorker(args: UpdateWorkerCommandInput, cb: (err: any, data?: UpdateWorkerCommandOutput) => void): void; - public updateWorker( + updateWorker(args: UpdateWorkerCommandInput, options?: __HttpHandlerOptions): Promise; + updateWorker(args: UpdateWorkerCommandInput, cb: (err: any, data?: UpdateWorkerCommandOutput) => void): void; + updateWorker( args: UpdateWorkerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkerCommandOutput) => void ): void; - public updateWorker( - args: UpdateWorkerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWorkerCommandOutput) => void), - cb?: (err: any, data?: UpdateWorkerCommandOutput) => void - ): Promise | void { - const command = new UpdateWorkerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Grants permission to update a worker fleet + * @see {@link UpdateWorkerFleetCommand} */ - public updateWorkerFleet( + updateWorkerFleet( args: UpdateWorkerFleetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWorkerFleet( + updateWorkerFleet( args: UpdateWorkerFleetCommandInput, cb: (err: any, data?: UpdateWorkerFleetCommandOutput) => void ): void; - public updateWorkerFleet( + updateWorkerFleet( args: UpdateWorkerFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkerFleetCommandOutput) => void ): void; - public updateWorkerFleet( - args: UpdateWorkerFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWorkerFleetCommandOutput) => void), - cb?: (err: any, data?: UpdateWorkerFleetCommandOutput) => void - ): Promise | void { - const command = new UpdateWorkerFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * An example service, deployed with the Octane Service creator, + * which will echo the string + */ +export class IoTRoboRunner extends IoTRoboRunnerClient implements IoTRoboRunner {} +createAggregatedClient(commands, IoTRoboRunner); diff --git a/clients/client-iot-wireless/src/IoTWireless.ts b/clients/client-iot-wireless/src/IoTWireless.ts index 31f456f25821..8c09f3208863 100644 --- a/clients/client-iot-wireless/src/IoTWireless.ts +++ b/clients/client-iot-wireless/src/IoTWireless.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -538,3672 +539,1943 @@ import { UpdateWirelessGatewayCommandInput, UpdateWirelessGatewayCommandOutput, } from "./commands/UpdateWirelessGatewayCommand"; -import { IoTWirelessClient } from "./IoTWirelessClient"; +import { IoTWirelessClient, IoTWirelessClientConfig } from "./IoTWirelessClient"; -/** - * @public - *

AWS IoT Wireless provides bi-directional communication between internet-connected wireless - * devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS IoT, use the - * IoT Wireless API. These wireless devices use the Low Power Wide Area Networking (LPWAN) - * communication protocol to communicate with AWS IoT.

- *

Using the API, you can perform create, read, update, and delete operations for your wireless - * devices, gateways, destinations, and profiles. After onboarding your devices, you - * can use the API operations to set log levels and monitor your devices with CloudWatch.

- *

You can also use the API operations to create multicast groups and schedule a multicast session for - * sending a downlink message to devices in the group. By using Firmware Updates Over-The-Air - * (FUOTA) API operations, you can create a FUOTA task and schedule a session to update the firmware - * of individual devices or an entire group of devices in a multicast group.

- */ -export class IoTWireless extends IoTWirelessClient { +const commands = { + AssociateAwsAccountWithPartnerAccountCommand, + AssociateMulticastGroupWithFuotaTaskCommand, + AssociateWirelessDeviceWithFuotaTaskCommand, + AssociateWirelessDeviceWithMulticastGroupCommand, + AssociateWirelessDeviceWithThingCommand, + AssociateWirelessGatewayWithCertificateCommand, + AssociateWirelessGatewayWithThingCommand, + CancelMulticastGroupSessionCommand, + CreateDestinationCommand, + CreateDeviceProfileCommand, + CreateFuotaTaskCommand, + CreateMulticastGroupCommand, + CreateNetworkAnalyzerConfigurationCommand, + CreateServiceProfileCommand, + CreateWirelessDeviceCommand, + CreateWirelessGatewayCommand, + CreateWirelessGatewayTaskCommand, + CreateWirelessGatewayTaskDefinitionCommand, + DeleteDestinationCommand, + DeleteDeviceProfileCommand, + DeleteFuotaTaskCommand, + DeleteMulticastGroupCommand, + DeleteNetworkAnalyzerConfigurationCommand, + DeleteQueuedMessagesCommand, + DeleteServiceProfileCommand, + DeleteWirelessDeviceCommand, + DeleteWirelessDeviceImportTaskCommand, + DeleteWirelessGatewayCommand, + DeleteWirelessGatewayTaskCommand, + DeleteWirelessGatewayTaskDefinitionCommand, + DeregisterWirelessDeviceCommand, + DisassociateAwsAccountFromPartnerAccountCommand, + DisassociateMulticastGroupFromFuotaTaskCommand, + DisassociateWirelessDeviceFromFuotaTaskCommand, + DisassociateWirelessDeviceFromMulticastGroupCommand, + DisassociateWirelessDeviceFromThingCommand, + DisassociateWirelessGatewayFromCertificateCommand, + DisassociateWirelessGatewayFromThingCommand, + GetDestinationCommand, + GetDeviceProfileCommand, + GetEventConfigurationByResourceTypesCommand, + GetFuotaTaskCommand, + GetLogLevelsByResourceTypesCommand, + GetMulticastGroupCommand, + GetMulticastGroupSessionCommand, + GetNetworkAnalyzerConfigurationCommand, + GetPartnerAccountCommand, + GetPositionCommand, + GetPositionConfigurationCommand, + GetPositionEstimateCommand, + GetResourceEventConfigurationCommand, + GetResourceLogLevelCommand, + GetResourcePositionCommand, + GetServiceEndpointCommand, + GetServiceProfileCommand, + GetWirelessDeviceCommand, + GetWirelessDeviceImportTaskCommand, + GetWirelessDeviceStatisticsCommand, + GetWirelessGatewayCommand, + GetWirelessGatewayCertificateCommand, + GetWirelessGatewayFirmwareInformationCommand, + GetWirelessGatewayStatisticsCommand, + GetWirelessGatewayTaskCommand, + GetWirelessGatewayTaskDefinitionCommand, + ListDestinationsCommand, + ListDeviceProfilesCommand, + ListDevicesForWirelessDeviceImportTaskCommand, + ListEventConfigurationsCommand, + ListFuotaTasksCommand, + ListMulticastGroupsCommand, + ListMulticastGroupsByFuotaTaskCommand, + ListNetworkAnalyzerConfigurationsCommand, + ListPartnerAccountsCommand, + ListPositionConfigurationsCommand, + ListQueuedMessagesCommand, + ListServiceProfilesCommand, + ListTagsForResourceCommand, + ListWirelessDeviceImportTasksCommand, + ListWirelessDevicesCommand, + ListWirelessGatewaysCommand, + ListWirelessGatewayTaskDefinitionsCommand, + PutPositionConfigurationCommand, + PutResourceLogLevelCommand, + ResetAllResourceLogLevelsCommand, + ResetResourceLogLevelCommand, + SendDataToMulticastGroupCommand, + SendDataToWirelessDeviceCommand, + StartBulkAssociateWirelessDeviceWithMulticastGroupCommand, + StartBulkDisassociateWirelessDeviceFromMulticastGroupCommand, + StartFuotaTaskCommand, + StartMulticastGroupSessionCommand, + StartSingleWirelessDeviceImportTaskCommand, + StartWirelessDeviceImportTaskCommand, + TagResourceCommand, + TestWirelessDeviceCommand, + UntagResourceCommand, + UpdateDestinationCommand, + UpdateEventConfigurationByResourceTypesCommand, + UpdateFuotaTaskCommand, + UpdateLogLevelsByResourceTypesCommand, + UpdateMulticastGroupCommand, + UpdateNetworkAnalyzerConfigurationCommand, + UpdatePartnerAccountCommand, + UpdatePositionCommand, + UpdateResourceEventConfigurationCommand, + UpdateResourcePositionCommand, + UpdateWirelessDeviceCommand, + UpdateWirelessDeviceImportTaskCommand, + UpdateWirelessGatewayCommand, +}; + +export interface IoTWireless { /** - * @public - *

Associates a partner account with your AWS account.

+ * @see {@link AssociateAwsAccountWithPartnerAccountCommand} */ - public associateAwsAccountWithPartnerAccount( + associateAwsAccountWithPartnerAccount( args: AssociateAwsAccountWithPartnerAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateAwsAccountWithPartnerAccount( + associateAwsAccountWithPartnerAccount( args: AssociateAwsAccountWithPartnerAccountCommandInput, cb: (err: any, data?: AssociateAwsAccountWithPartnerAccountCommandOutput) => void ): void; - public associateAwsAccountWithPartnerAccount( + associateAwsAccountWithPartnerAccount( args: AssociateAwsAccountWithPartnerAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateAwsAccountWithPartnerAccountCommandOutput) => void ): void; - public associateAwsAccountWithPartnerAccount( - args: AssociateAwsAccountWithPartnerAccountCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AssociateAwsAccountWithPartnerAccountCommandOutput) => void), - cb?: (err: any, data?: AssociateAwsAccountWithPartnerAccountCommandOutput) => void - ): Promise | void { - const command = new AssociateAwsAccountWithPartnerAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associate a multicast group with a FUOTA task.

+ * @see {@link AssociateMulticastGroupWithFuotaTaskCommand} */ - public associateMulticastGroupWithFuotaTask( + associateMulticastGroupWithFuotaTask( args: AssociateMulticastGroupWithFuotaTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateMulticastGroupWithFuotaTask( + associateMulticastGroupWithFuotaTask( args: AssociateMulticastGroupWithFuotaTaskCommandInput, cb: (err: any, data?: AssociateMulticastGroupWithFuotaTaskCommandOutput) => void ): void; - public associateMulticastGroupWithFuotaTask( + associateMulticastGroupWithFuotaTask( args: AssociateMulticastGroupWithFuotaTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateMulticastGroupWithFuotaTaskCommandOutput) => void ): void; - public associateMulticastGroupWithFuotaTask( - args: AssociateMulticastGroupWithFuotaTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateMulticastGroupWithFuotaTaskCommandOutput) => void), - cb?: (err: any, data?: AssociateMulticastGroupWithFuotaTaskCommandOutput) => void - ): Promise | void { - const command = new AssociateMulticastGroupWithFuotaTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associate a wireless device with a FUOTA task.

+ * @see {@link AssociateWirelessDeviceWithFuotaTaskCommand} */ - public associateWirelessDeviceWithFuotaTask( + associateWirelessDeviceWithFuotaTask( args: AssociateWirelessDeviceWithFuotaTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateWirelessDeviceWithFuotaTask( + associateWirelessDeviceWithFuotaTask( args: AssociateWirelessDeviceWithFuotaTaskCommandInput, cb: (err: any, data?: AssociateWirelessDeviceWithFuotaTaskCommandOutput) => void ): void; - public associateWirelessDeviceWithFuotaTask( + associateWirelessDeviceWithFuotaTask( args: AssociateWirelessDeviceWithFuotaTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateWirelessDeviceWithFuotaTaskCommandOutput) => void ): void; - public associateWirelessDeviceWithFuotaTask( - args: AssociateWirelessDeviceWithFuotaTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateWirelessDeviceWithFuotaTaskCommandOutput) => void), - cb?: (err: any, data?: AssociateWirelessDeviceWithFuotaTaskCommandOutput) => void - ): Promise | void { - const command = new AssociateWirelessDeviceWithFuotaTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a wireless device with a multicast group.

+ * @see {@link AssociateWirelessDeviceWithMulticastGroupCommand} */ - public associateWirelessDeviceWithMulticastGroup( + associateWirelessDeviceWithMulticastGroup( args: AssociateWirelessDeviceWithMulticastGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateWirelessDeviceWithMulticastGroup( + associateWirelessDeviceWithMulticastGroup( args: AssociateWirelessDeviceWithMulticastGroupCommandInput, cb: (err: any, data?: AssociateWirelessDeviceWithMulticastGroupCommandOutput) => void ): void; - public associateWirelessDeviceWithMulticastGroup( + associateWirelessDeviceWithMulticastGroup( args: AssociateWirelessDeviceWithMulticastGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateWirelessDeviceWithMulticastGroupCommandOutput) => void ): void; - public associateWirelessDeviceWithMulticastGroup( - args: AssociateWirelessDeviceWithMulticastGroupCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AssociateWirelessDeviceWithMulticastGroupCommandOutput) => void), - cb?: (err: any, data?: AssociateWirelessDeviceWithMulticastGroupCommandOutput) => void - ): Promise | void { - const command = new AssociateWirelessDeviceWithMulticastGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a wireless device with a thing.

+ * @see {@link AssociateWirelessDeviceWithThingCommand} */ - public associateWirelessDeviceWithThing( + associateWirelessDeviceWithThing( args: AssociateWirelessDeviceWithThingCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateWirelessDeviceWithThing( + associateWirelessDeviceWithThing( args: AssociateWirelessDeviceWithThingCommandInput, cb: (err: any, data?: AssociateWirelessDeviceWithThingCommandOutput) => void ): void; - public associateWirelessDeviceWithThing( + associateWirelessDeviceWithThing( args: AssociateWirelessDeviceWithThingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateWirelessDeviceWithThingCommandOutput) => void ): void; - public associateWirelessDeviceWithThing( - args: AssociateWirelessDeviceWithThingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateWirelessDeviceWithThingCommandOutput) => void), - cb?: (err: any, data?: AssociateWirelessDeviceWithThingCommandOutput) => void - ): Promise | void { - const command = new AssociateWirelessDeviceWithThingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a wireless gateway with a certificate.

+ * @see {@link AssociateWirelessGatewayWithCertificateCommand} */ - public associateWirelessGatewayWithCertificate( + associateWirelessGatewayWithCertificate( args: AssociateWirelessGatewayWithCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateWirelessGatewayWithCertificate( + associateWirelessGatewayWithCertificate( args: AssociateWirelessGatewayWithCertificateCommandInput, cb: (err: any, data?: AssociateWirelessGatewayWithCertificateCommandOutput) => void ): void; - public associateWirelessGatewayWithCertificate( + associateWirelessGatewayWithCertificate( args: AssociateWirelessGatewayWithCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateWirelessGatewayWithCertificateCommandOutput) => void ): void; - public associateWirelessGatewayWithCertificate( - args: AssociateWirelessGatewayWithCertificateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AssociateWirelessGatewayWithCertificateCommandOutput) => void), - cb?: (err: any, data?: AssociateWirelessGatewayWithCertificateCommandOutput) => void - ): Promise | void { - const command = new AssociateWirelessGatewayWithCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a wireless gateway with a thing.

+ * @see {@link AssociateWirelessGatewayWithThingCommand} */ - public associateWirelessGatewayWithThing( + associateWirelessGatewayWithThing( args: AssociateWirelessGatewayWithThingCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateWirelessGatewayWithThing( + associateWirelessGatewayWithThing( args: AssociateWirelessGatewayWithThingCommandInput, cb: (err: any, data?: AssociateWirelessGatewayWithThingCommandOutput) => void ): void; - public associateWirelessGatewayWithThing( + associateWirelessGatewayWithThing( args: AssociateWirelessGatewayWithThingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateWirelessGatewayWithThingCommandOutput) => void ): void; - public associateWirelessGatewayWithThing( - args: AssociateWirelessGatewayWithThingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateWirelessGatewayWithThingCommandOutput) => void), - cb?: (err: any, data?: AssociateWirelessGatewayWithThingCommandOutput) => void - ): Promise | void { - const command = new AssociateWirelessGatewayWithThingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels an existing multicast group session.

+ * @see {@link CancelMulticastGroupSessionCommand} */ - public cancelMulticastGroupSession( + cancelMulticastGroupSession( args: CancelMulticastGroupSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelMulticastGroupSession( + cancelMulticastGroupSession( args: CancelMulticastGroupSessionCommandInput, cb: (err: any, data?: CancelMulticastGroupSessionCommandOutput) => void ): void; - public cancelMulticastGroupSession( + cancelMulticastGroupSession( args: CancelMulticastGroupSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelMulticastGroupSessionCommandOutput) => void ): void; - public cancelMulticastGroupSession( - args: CancelMulticastGroupSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelMulticastGroupSessionCommandOutput) => void), - cb?: (err: any, data?: CancelMulticastGroupSessionCommandOutput) => void - ): Promise | void { - const command = new CancelMulticastGroupSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new destination that maps a device message to an AWS IoT rule.

+ * @see {@link CreateDestinationCommand} */ - public createDestination( + createDestination( args: CreateDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDestination( + createDestination( args: CreateDestinationCommandInput, cb: (err: any, data?: CreateDestinationCommandOutput) => void ): void; - public createDestination( + createDestination( args: CreateDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDestinationCommandOutput) => void ): void; - public createDestination( - args: CreateDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDestinationCommandOutput) => void), - cb?: (err: any, data?: CreateDestinationCommandOutput) => void - ): Promise | void { - const command = new CreateDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new device profile.

+ * @see {@link CreateDeviceProfileCommand} */ - public createDeviceProfile( + createDeviceProfile( args: CreateDeviceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDeviceProfile( + createDeviceProfile( args: CreateDeviceProfileCommandInput, cb: (err: any, data?: CreateDeviceProfileCommandOutput) => void ): void; - public createDeviceProfile( + createDeviceProfile( args: CreateDeviceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeviceProfileCommandOutput) => void ): void; - public createDeviceProfile( - args: CreateDeviceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDeviceProfileCommandOutput) => void), - cb?: (err: any, data?: CreateDeviceProfileCommandOutput) => void - ): Promise | void { - const command = new CreateDeviceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a FUOTA task.

+ * @see {@link CreateFuotaTaskCommand} */ - public createFuotaTask( + createFuotaTask( args: CreateFuotaTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFuotaTask( - args: CreateFuotaTaskCommandInput, - cb: (err: any, data?: CreateFuotaTaskCommandOutput) => void - ): void; - public createFuotaTask( + createFuotaTask(args: CreateFuotaTaskCommandInput, cb: (err: any, data?: CreateFuotaTaskCommandOutput) => void): void; + createFuotaTask( args: CreateFuotaTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFuotaTaskCommandOutput) => void ): void; - public createFuotaTask( - args: CreateFuotaTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFuotaTaskCommandOutput) => void), - cb?: (err: any, data?: CreateFuotaTaskCommandOutput) => void - ): Promise | void { - const command = new CreateFuotaTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a multicast group.

+ * @see {@link CreateMulticastGroupCommand} */ - public createMulticastGroup( + createMulticastGroup( args: CreateMulticastGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMulticastGroup( + createMulticastGroup( args: CreateMulticastGroupCommandInput, cb: (err: any, data?: CreateMulticastGroupCommandOutput) => void ): void; - public createMulticastGroup( + createMulticastGroup( args: CreateMulticastGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMulticastGroupCommandOutput) => void ): void; - public createMulticastGroup( - args: CreateMulticastGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMulticastGroupCommandOutput) => void), - cb?: (err: any, data?: CreateMulticastGroupCommandOutput) => void - ): Promise | void { - const command = new CreateMulticastGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new network analyzer configuration.

+ * @see {@link CreateNetworkAnalyzerConfigurationCommand} */ - public createNetworkAnalyzerConfiguration( + createNetworkAnalyzerConfiguration( args: CreateNetworkAnalyzerConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNetworkAnalyzerConfiguration( + createNetworkAnalyzerConfiguration( args: CreateNetworkAnalyzerConfigurationCommandInput, cb: (err: any, data?: CreateNetworkAnalyzerConfigurationCommandOutput) => void ): void; - public createNetworkAnalyzerConfiguration( + createNetworkAnalyzerConfiguration( args: CreateNetworkAnalyzerConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNetworkAnalyzerConfigurationCommandOutput) => void ): void; - public createNetworkAnalyzerConfiguration( - args: CreateNetworkAnalyzerConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNetworkAnalyzerConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateNetworkAnalyzerConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateNetworkAnalyzerConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new service profile.

+ * @see {@link CreateServiceProfileCommand} */ - public createServiceProfile( + createServiceProfile( args: CreateServiceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public createServiceProfile( + createServiceProfile( args: CreateServiceProfileCommandInput, cb: (err: any, data?: CreateServiceProfileCommandOutput) => void ): void; - public createServiceProfile( + createServiceProfile( args: CreateServiceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceProfileCommandOutput) => void ): void; - public createServiceProfile( - args: CreateServiceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateServiceProfileCommandOutput) => void), - cb?: (err: any, data?: CreateServiceProfileCommandOutput) => void - ): Promise | void { - const command = new CreateServiceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provisions a wireless device.

+ * @see {@link CreateWirelessDeviceCommand} */ - public createWirelessDevice( + createWirelessDevice( args: CreateWirelessDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWirelessDevice( + createWirelessDevice( args: CreateWirelessDeviceCommandInput, cb: (err: any, data?: CreateWirelessDeviceCommandOutput) => void ): void; - public createWirelessDevice( + createWirelessDevice( args: CreateWirelessDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWirelessDeviceCommandOutput) => void ): void; - public createWirelessDevice( - args: CreateWirelessDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWirelessDeviceCommandOutput) => void), - cb?: (err: any, data?: CreateWirelessDeviceCommandOutput) => void - ): Promise | void { - const command = new CreateWirelessDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provisions a wireless gateway.

+ * @see {@link CreateWirelessGatewayCommand} */ - public createWirelessGateway( + createWirelessGateway( args: CreateWirelessGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWirelessGateway( + createWirelessGateway( args: CreateWirelessGatewayCommandInput, cb: (err: any, data?: CreateWirelessGatewayCommandOutput) => void ): void; - public createWirelessGateway( + createWirelessGateway( args: CreateWirelessGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWirelessGatewayCommandOutput) => void ): void; - public createWirelessGateway( - args: CreateWirelessGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWirelessGatewayCommandOutput) => void), - cb?: (err: any, data?: CreateWirelessGatewayCommandOutput) => void - ): Promise | void { - const command = new CreateWirelessGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a task for a wireless gateway.

+ * @see {@link CreateWirelessGatewayTaskCommand} */ - public createWirelessGatewayTask( + createWirelessGatewayTask( args: CreateWirelessGatewayTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWirelessGatewayTask( + createWirelessGatewayTask( args: CreateWirelessGatewayTaskCommandInput, cb: (err: any, data?: CreateWirelessGatewayTaskCommandOutput) => void ): void; - public createWirelessGatewayTask( + createWirelessGatewayTask( args: CreateWirelessGatewayTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWirelessGatewayTaskCommandOutput) => void ): void; - public createWirelessGatewayTask( - args: CreateWirelessGatewayTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWirelessGatewayTaskCommandOutput) => void), - cb?: (err: any, data?: CreateWirelessGatewayTaskCommandOutput) => void - ): Promise | void { - const command = new CreateWirelessGatewayTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a gateway task definition.

+ * @see {@link CreateWirelessGatewayTaskDefinitionCommand} */ - public createWirelessGatewayTaskDefinition( + createWirelessGatewayTaskDefinition( args: CreateWirelessGatewayTaskDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWirelessGatewayTaskDefinition( + createWirelessGatewayTaskDefinition( args: CreateWirelessGatewayTaskDefinitionCommandInput, cb: (err: any, data?: CreateWirelessGatewayTaskDefinitionCommandOutput) => void ): void; - public createWirelessGatewayTaskDefinition( + createWirelessGatewayTaskDefinition( args: CreateWirelessGatewayTaskDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWirelessGatewayTaskDefinitionCommandOutput) => void ): void; - public createWirelessGatewayTaskDefinition( - args: CreateWirelessGatewayTaskDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWirelessGatewayTaskDefinitionCommandOutput) => void), - cb?: (err: any, data?: CreateWirelessGatewayTaskDefinitionCommandOutput) => void - ): Promise | void { - const command = new CreateWirelessGatewayTaskDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a destination.

+ * @see {@link DeleteDestinationCommand} */ - public deleteDestination( + deleteDestination( args: DeleteDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDestination( + deleteDestination( args: DeleteDestinationCommandInput, cb: (err: any, data?: DeleteDestinationCommandOutput) => void ): void; - public deleteDestination( + deleteDestination( args: DeleteDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDestinationCommandOutput) => void ): void; - public deleteDestination( - args: DeleteDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDestinationCommandOutput) => void), - cb?: (err: any, data?: DeleteDestinationCommandOutput) => void - ): Promise | void { - const command = new DeleteDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a device profile.

+ * @see {@link DeleteDeviceProfileCommand} */ - public deleteDeviceProfile( + deleteDeviceProfile( args: DeleteDeviceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDeviceProfile( + deleteDeviceProfile( args: DeleteDeviceProfileCommandInput, cb: (err: any, data?: DeleteDeviceProfileCommandOutput) => void ): void; - public deleteDeviceProfile( + deleteDeviceProfile( args: DeleteDeviceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDeviceProfileCommandOutput) => void ): void; - public deleteDeviceProfile( - args: DeleteDeviceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDeviceProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteDeviceProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteDeviceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a FUOTA task.

+ * @see {@link DeleteFuotaTaskCommand} */ - public deleteFuotaTask( + deleteFuotaTask( args: DeleteFuotaTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFuotaTask( - args: DeleteFuotaTaskCommandInput, - cb: (err: any, data?: DeleteFuotaTaskCommandOutput) => void - ): void; - public deleteFuotaTask( + deleteFuotaTask(args: DeleteFuotaTaskCommandInput, cb: (err: any, data?: DeleteFuotaTaskCommandOutput) => void): void; + deleteFuotaTask( args: DeleteFuotaTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFuotaTaskCommandOutput) => void ): void; - public deleteFuotaTask( - args: DeleteFuotaTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFuotaTaskCommandOutput) => void), - cb?: (err: any, data?: DeleteFuotaTaskCommandOutput) => void - ): Promise | void { - const command = new DeleteFuotaTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a multicast group if it is not in use by a fuota task.

+ * @see {@link DeleteMulticastGroupCommand} */ - public deleteMulticastGroup( + deleteMulticastGroup( args: DeleteMulticastGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMulticastGroup( + deleteMulticastGroup( args: DeleteMulticastGroupCommandInput, cb: (err: any, data?: DeleteMulticastGroupCommandOutput) => void ): void; - public deleteMulticastGroup( + deleteMulticastGroup( args: DeleteMulticastGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMulticastGroupCommandOutput) => void ): void; - public deleteMulticastGroup( - args: DeleteMulticastGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMulticastGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteMulticastGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteMulticastGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a network analyzer configuration.

+ * @see {@link DeleteNetworkAnalyzerConfigurationCommand} */ - public deleteNetworkAnalyzerConfiguration( + deleteNetworkAnalyzerConfiguration( args: DeleteNetworkAnalyzerConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNetworkAnalyzerConfiguration( + deleteNetworkAnalyzerConfiguration( args: DeleteNetworkAnalyzerConfigurationCommandInput, cb: (err: any, data?: DeleteNetworkAnalyzerConfigurationCommandOutput) => void ): void; - public deleteNetworkAnalyzerConfiguration( + deleteNetworkAnalyzerConfiguration( args: DeleteNetworkAnalyzerConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNetworkAnalyzerConfigurationCommandOutput) => void ): void; - public deleteNetworkAnalyzerConfiguration( - args: DeleteNetworkAnalyzerConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNetworkAnalyzerConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteNetworkAnalyzerConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteNetworkAnalyzerConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Remove queued messages from the downlink queue.

+ * @see {@link DeleteQueuedMessagesCommand} */ - public deleteQueuedMessages( + deleteQueuedMessages( args: DeleteQueuedMessagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteQueuedMessages( + deleteQueuedMessages( args: DeleteQueuedMessagesCommandInput, cb: (err: any, data?: DeleteQueuedMessagesCommandOutput) => void ): void; - public deleteQueuedMessages( + deleteQueuedMessages( args: DeleteQueuedMessagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteQueuedMessagesCommandOutput) => void ): void; - public deleteQueuedMessages( - args: DeleteQueuedMessagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteQueuedMessagesCommandOutput) => void), - cb?: (err: any, data?: DeleteQueuedMessagesCommandOutput) => void - ): Promise | void { - const command = new DeleteQueuedMessagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a service profile.

+ * @see {@link DeleteServiceProfileCommand} */ - public deleteServiceProfile( + deleteServiceProfile( args: DeleteServiceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteServiceProfile( + deleteServiceProfile( args: DeleteServiceProfileCommandInput, cb: (err: any, data?: DeleteServiceProfileCommandOutput) => void ): void; - public deleteServiceProfile( + deleteServiceProfile( args: DeleteServiceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceProfileCommandOutput) => void ): void; - public deleteServiceProfile( - args: DeleteServiceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteServiceProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteServiceProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteServiceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a wireless device.

+ * @see {@link DeleteWirelessDeviceCommand} */ - public deleteWirelessDevice( + deleteWirelessDevice( args: DeleteWirelessDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWirelessDevice( + deleteWirelessDevice( args: DeleteWirelessDeviceCommandInput, cb: (err: any, data?: DeleteWirelessDeviceCommandOutput) => void ): void; - public deleteWirelessDevice( + deleteWirelessDevice( args: DeleteWirelessDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWirelessDeviceCommandOutput) => void ): void; - public deleteWirelessDevice( - args: DeleteWirelessDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWirelessDeviceCommandOutput) => void), - cb?: (err: any, data?: DeleteWirelessDeviceCommandOutput) => void - ): Promise | void { - const command = new DeleteWirelessDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete an import task.

+ * @see {@link DeleteWirelessDeviceImportTaskCommand} */ - public deleteWirelessDeviceImportTask( + deleteWirelessDeviceImportTask( args: DeleteWirelessDeviceImportTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWirelessDeviceImportTask( + deleteWirelessDeviceImportTask( args: DeleteWirelessDeviceImportTaskCommandInput, cb: (err: any, data?: DeleteWirelessDeviceImportTaskCommandOutput) => void ): void; - public deleteWirelessDeviceImportTask( + deleteWirelessDeviceImportTask( args: DeleteWirelessDeviceImportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWirelessDeviceImportTaskCommandOutput) => void ): void; - public deleteWirelessDeviceImportTask( - args: DeleteWirelessDeviceImportTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWirelessDeviceImportTaskCommandOutput) => void), - cb?: (err: any, data?: DeleteWirelessDeviceImportTaskCommandOutput) => void - ): Promise | void { - const command = new DeleteWirelessDeviceImportTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a wireless gateway.

+ * @see {@link DeleteWirelessGatewayCommand} */ - public deleteWirelessGateway( + deleteWirelessGateway( args: DeleteWirelessGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWirelessGateway( + deleteWirelessGateway( args: DeleteWirelessGatewayCommandInput, cb: (err: any, data?: DeleteWirelessGatewayCommandOutput) => void ): void; - public deleteWirelessGateway( + deleteWirelessGateway( args: DeleteWirelessGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWirelessGatewayCommandOutput) => void ): void; - public deleteWirelessGateway( - args: DeleteWirelessGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWirelessGatewayCommandOutput) => void), - cb?: (err: any, data?: DeleteWirelessGatewayCommandOutput) => void - ): Promise | void { - const command = new DeleteWirelessGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a wireless gateway task.

+ * @see {@link DeleteWirelessGatewayTaskCommand} */ - public deleteWirelessGatewayTask( + deleteWirelessGatewayTask( args: DeleteWirelessGatewayTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWirelessGatewayTask( + deleteWirelessGatewayTask( args: DeleteWirelessGatewayTaskCommandInput, cb: (err: any, data?: DeleteWirelessGatewayTaskCommandOutput) => void ): void; - public deleteWirelessGatewayTask( + deleteWirelessGatewayTask( args: DeleteWirelessGatewayTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWirelessGatewayTaskCommandOutput) => void ): void; - public deleteWirelessGatewayTask( - args: DeleteWirelessGatewayTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWirelessGatewayTaskCommandOutput) => void), - cb?: (err: any, data?: DeleteWirelessGatewayTaskCommandOutput) => void - ): Promise | void { - const command = new DeleteWirelessGatewayTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.

+ * @see {@link DeleteWirelessGatewayTaskDefinitionCommand} */ - public deleteWirelessGatewayTaskDefinition( + deleteWirelessGatewayTaskDefinition( args: DeleteWirelessGatewayTaskDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWirelessGatewayTaskDefinition( + deleteWirelessGatewayTaskDefinition( args: DeleteWirelessGatewayTaskDefinitionCommandInput, cb: (err: any, data?: DeleteWirelessGatewayTaskDefinitionCommandOutput) => void ): void; - public deleteWirelessGatewayTaskDefinition( + deleteWirelessGatewayTaskDefinition( args: DeleteWirelessGatewayTaskDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWirelessGatewayTaskDefinitionCommandOutput) => void ): void; - public deleteWirelessGatewayTaskDefinition( - args: DeleteWirelessGatewayTaskDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWirelessGatewayTaskDefinitionCommandOutput) => void), - cb?: (err: any, data?: DeleteWirelessGatewayTaskDefinitionCommandOutput) => void - ): Promise | void { - const command = new DeleteWirelessGatewayTaskDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deregister a wireless device from AWS IoT Wireless.

+ * @see {@link DeregisterWirelessDeviceCommand} */ - public deregisterWirelessDevice( + deregisterWirelessDevice( args: DeregisterWirelessDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterWirelessDevice( + deregisterWirelessDevice( args: DeregisterWirelessDeviceCommandInput, cb: (err: any, data?: DeregisterWirelessDeviceCommandOutput) => void ): void; - public deregisterWirelessDevice( + deregisterWirelessDevice( args: DeregisterWirelessDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterWirelessDeviceCommandOutput) => void ): void; - public deregisterWirelessDevice( - args: DeregisterWirelessDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterWirelessDeviceCommandOutput) => void), - cb?: (err: any, data?: DeregisterWirelessDeviceCommandOutput) => void - ): Promise | void { - const command = new DeregisterWirelessDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates your AWS account from a partner account. If PartnerAccountId and PartnerType are null, disassociates your AWS account from all partner accounts.

+ * @see {@link DisassociateAwsAccountFromPartnerAccountCommand} */ - public disassociateAwsAccountFromPartnerAccount( + disassociateAwsAccountFromPartnerAccount( args: DisassociateAwsAccountFromPartnerAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateAwsAccountFromPartnerAccount( + disassociateAwsAccountFromPartnerAccount( args: DisassociateAwsAccountFromPartnerAccountCommandInput, cb: (err: any, data?: DisassociateAwsAccountFromPartnerAccountCommandOutput) => void ): void; - public disassociateAwsAccountFromPartnerAccount( + disassociateAwsAccountFromPartnerAccount( args: DisassociateAwsAccountFromPartnerAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateAwsAccountFromPartnerAccountCommandOutput) => void ): void; - public disassociateAwsAccountFromPartnerAccount( - args: DisassociateAwsAccountFromPartnerAccountCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociateAwsAccountFromPartnerAccountCommandOutput) => void), - cb?: (err: any, data?: DisassociateAwsAccountFromPartnerAccountCommandOutput) => void - ): Promise | void { - const command = new DisassociateAwsAccountFromPartnerAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates a multicast group from a fuota task.

+ * @see {@link DisassociateMulticastGroupFromFuotaTaskCommand} */ - public disassociateMulticastGroupFromFuotaTask( + disassociateMulticastGroupFromFuotaTask( args: DisassociateMulticastGroupFromFuotaTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateMulticastGroupFromFuotaTask( + disassociateMulticastGroupFromFuotaTask( args: DisassociateMulticastGroupFromFuotaTaskCommandInput, cb: (err: any, data?: DisassociateMulticastGroupFromFuotaTaskCommandOutput) => void ): void; - public disassociateMulticastGroupFromFuotaTask( + disassociateMulticastGroupFromFuotaTask( args: DisassociateMulticastGroupFromFuotaTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateMulticastGroupFromFuotaTaskCommandOutput) => void ): void; - public disassociateMulticastGroupFromFuotaTask( - args: DisassociateMulticastGroupFromFuotaTaskCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociateMulticastGroupFromFuotaTaskCommandOutput) => void), - cb?: (err: any, data?: DisassociateMulticastGroupFromFuotaTaskCommandOutput) => void - ): Promise | void { - const command = new DisassociateMulticastGroupFromFuotaTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates a wireless device from a FUOTA task.

+ * @see {@link DisassociateWirelessDeviceFromFuotaTaskCommand} */ - public disassociateWirelessDeviceFromFuotaTask( + disassociateWirelessDeviceFromFuotaTask( args: DisassociateWirelessDeviceFromFuotaTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateWirelessDeviceFromFuotaTask( + disassociateWirelessDeviceFromFuotaTask( args: DisassociateWirelessDeviceFromFuotaTaskCommandInput, cb: (err: any, data?: DisassociateWirelessDeviceFromFuotaTaskCommandOutput) => void ): void; - public disassociateWirelessDeviceFromFuotaTask( + disassociateWirelessDeviceFromFuotaTask( args: DisassociateWirelessDeviceFromFuotaTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateWirelessDeviceFromFuotaTaskCommandOutput) => void ): void; - public disassociateWirelessDeviceFromFuotaTask( - args: DisassociateWirelessDeviceFromFuotaTaskCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociateWirelessDeviceFromFuotaTaskCommandOutput) => void), - cb?: (err: any, data?: DisassociateWirelessDeviceFromFuotaTaskCommandOutput) => void - ): Promise | void { - const command = new DisassociateWirelessDeviceFromFuotaTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates a wireless device from a multicast group.

+ * @see {@link DisassociateWirelessDeviceFromMulticastGroupCommand} */ - public disassociateWirelessDeviceFromMulticastGroup( + disassociateWirelessDeviceFromMulticastGroup( args: DisassociateWirelessDeviceFromMulticastGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateWirelessDeviceFromMulticastGroup( + disassociateWirelessDeviceFromMulticastGroup( args: DisassociateWirelessDeviceFromMulticastGroupCommandInput, cb: (err: any, data?: DisassociateWirelessDeviceFromMulticastGroupCommandOutput) => void ): void; - public disassociateWirelessDeviceFromMulticastGroup( + disassociateWirelessDeviceFromMulticastGroup( args: DisassociateWirelessDeviceFromMulticastGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateWirelessDeviceFromMulticastGroupCommandOutput) => void ): void; - public disassociateWirelessDeviceFromMulticastGroup( - args: DisassociateWirelessDeviceFromMulticastGroupCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociateWirelessDeviceFromMulticastGroupCommandOutput) => void), - cb?: (err: any, data?: DisassociateWirelessDeviceFromMulticastGroupCommandOutput) => void - ): Promise | void { - const command = new DisassociateWirelessDeviceFromMulticastGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates a wireless device from its currently associated thing.

+ * @see {@link DisassociateWirelessDeviceFromThingCommand} */ - public disassociateWirelessDeviceFromThing( + disassociateWirelessDeviceFromThing( args: DisassociateWirelessDeviceFromThingCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateWirelessDeviceFromThing( + disassociateWirelessDeviceFromThing( args: DisassociateWirelessDeviceFromThingCommandInput, cb: (err: any, data?: DisassociateWirelessDeviceFromThingCommandOutput) => void ): void; - public disassociateWirelessDeviceFromThing( + disassociateWirelessDeviceFromThing( args: DisassociateWirelessDeviceFromThingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateWirelessDeviceFromThingCommandOutput) => void ): void; - public disassociateWirelessDeviceFromThing( - args: DisassociateWirelessDeviceFromThingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateWirelessDeviceFromThingCommandOutput) => void), - cb?: (err: any, data?: DisassociateWirelessDeviceFromThingCommandOutput) => void - ): Promise | void { - const command = new DisassociateWirelessDeviceFromThingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates a wireless gateway from its currently associated certificate.

+ * @see {@link DisassociateWirelessGatewayFromCertificateCommand} */ - public disassociateWirelessGatewayFromCertificate( + disassociateWirelessGatewayFromCertificate( args: DisassociateWirelessGatewayFromCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateWirelessGatewayFromCertificate( + disassociateWirelessGatewayFromCertificate( args: DisassociateWirelessGatewayFromCertificateCommandInput, cb: (err: any, data?: DisassociateWirelessGatewayFromCertificateCommandOutput) => void ): void; - public disassociateWirelessGatewayFromCertificate( + disassociateWirelessGatewayFromCertificate( args: DisassociateWirelessGatewayFromCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateWirelessGatewayFromCertificateCommandOutput) => void ): void; - public disassociateWirelessGatewayFromCertificate( - args: DisassociateWirelessGatewayFromCertificateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociateWirelessGatewayFromCertificateCommandOutput) => void), - cb?: (err: any, data?: DisassociateWirelessGatewayFromCertificateCommandOutput) => void - ): Promise | void { - const command = new DisassociateWirelessGatewayFromCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates a wireless gateway from its currently associated thing.

+ * @see {@link DisassociateWirelessGatewayFromThingCommand} */ - public disassociateWirelessGatewayFromThing( + disassociateWirelessGatewayFromThing( args: DisassociateWirelessGatewayFromThingCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateWirelessGatewayFromThing( + disassociateWirelessGatewayFromThing( args: DisassociateWirelessGatewayFromThingCommandInput, cb: (err: any, data?: DisassociateWirelessGatewayFromThingCommandOutput) => void ): void; - public disassociateWirelessGatewayFromThing( + disassociateWirelessGatewayFromThing( args: DisassociateWirelessGatewayFromThingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateWirelessGatewayFromThingCommandOutput) => void ): void; - public disassociateWirelessGatewayFromThing( - args: DisassociateWirelessGatewayFromThingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateWirelessGatewayFromThingCommandOutput) => void), - cb?: (err: any, data?: DisassociateWirelessGatewayFromThingCommandOutput) => void - ): Promise | void { - const command = new DisassociateWirelessGatewayFromThingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a destination.

+ * @see {@link GetDestinationCommand} */ - public getDestination( + getDestination( args: GetDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDestination( - args: GetDestinationCommandInput, - cb: (err: any, data?: GetDestinationCommandOutput) => void - ): void; - public getDestination( + getDestination(args: GetDestinationCommandInput, cb: (err: any, data?: GetDestinationCommandOutput) => void): void; + getDestination( args: GetDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDestinationCommandOutput) => void ): void; - public getDestination( - args: GetDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDestinationCommandOutput) => void), - cb?: (err: any, data?: GetDestinationCommandOutput) => void - ): Promise | void { - const command = new GetDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a device profile.

+ * @see {@link GetDeviceProfileCommand} */ - public getDeviceProfile( + getDeviceProfile( args: GetDeviceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDeviceProfile( + getDeviceProfile( args: GetDeviceProfileCommandInput, cb: (err: any, data?: GetDeviceProfileCommandOutput) => void ): void; - public getDeviceProfile( + getDeviceProfile( args: GetDeviceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeviceProfileCommandOutput) => void ): void; - public getDeviceProfile( - args: GetDeviceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeviceProfileCommandOutput) => void), - cb?: (err: any, data?: GetDeviceProfileCommandOutput) => void - ): Promise | void { - const command = new GetDeviceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the event configuration based on resource types.

+ * @see {@link GetEventConfigurationByResourceTypesCommand} */ - public getEventConfigurationByResourceTypes( + getEventConfigurationByResourceTypes( args: GetEventConfigurationByResourceTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEventConfigurationByResourceTypes( + getEventConfigurationByResourceTypes( args: GetEventConfigurationByResourceTypesCommandInput, cb: (err: any, data?: GetEventConfigurationByResourceTypesCommandOutput) => void ): void; - public getEventConfigurationByResourceTypes( + getEventConfigurationByResourceTypes( args: GetEventConfigurationByResourceTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEventConfigurationByResourceTypesCommandOutput) => void ): void; - public getEventConfigurationByResourceTypes( - args: GetEventConfigurationByResourceTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEventConfigurationByResourceTypesCommandOutput) => void), - cb?: (err: any, data?: GetEventConfigurationByResourceTypesCommandOutput) => void - ): Promise | void { - const command = new GetEventConfigurationByResourceTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a FUOTA task.

+ * @see {@link GetFuotaTaskCommand} */ - public getFuotaTask( - args: GetFuotaTaskCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getFuotaTask(args: GetFuotaTaskCommandInput, cb: (err: any, data?: GetFuotaTaskCommandOutput) => void): void; - public getFuotaTask( + getFuotaTask(args: GetFuotaTaskCommandInput, options?: __HttpHandlerOptions): Promise; + getFuotaTask(args: GetFuotaTaskCommandInput, cb: (err: any, data?: GetFuotaTaskCommandOutput) => void): void; + getFuotaTask( args: GetFuotaTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFuotaTaskCommandOutput) => void ): void; - public getFuotaTask( - args: GetFuotaTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFuotaTaskCommandOutput) => void), - cb?: (err: any, data?: GetFuotaTaskCommandOutput) => void - ): Promise | void { - const command = new GetFuotaTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns current default log levels or log levels by resource types. Based on resource types, log levels can be - * for wireless device log options or wireless gateway log options.

+ * @see {@link GetLogLevelsByResourceTypesCommand} */ - public getLogLevelsByResourceTypes( + getLogLevelsByResourceTypes( args: GetLogLevelsByResourceTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLogLevelsByResourceTypes( + getLogLevelsByResourceTypes( args: GetLogLevelsByResourceTypesCommandInput, cb: (err: any, data?: GetLogLevelsByResourceTypesCommandOutput) => void ): void; - public getLogLevelsByResourceTypes( + getLogLevelsByResourceTypes( args: GetLogLevelsByResourceTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLogLevelsByResourceTypesCommandOutput) => void ): void; - public getLogLevelsByResourceTypes( - args: GetLogLevelsByResourceTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLogLevelsByResourceTypesCommandOutput) => void), - cb?: (err: any, data?: GetLogLevelsByResourceTypesCommandOutput) => void - ): Promise | void { - const command = new GetLogLevelsByResourceTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a multicast group.

+ * @see {@link GetMulticastGroupCommand} */ - public getMulticastGroup( + getMulticastGroup( args: GetMulticastGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMulticastGroup( + getMulticastGroup( args: GetMulticastGroupCommandInput, cb: (err: any, data?: GetMulticastGroupCommandOutput) => void ): void; - public getMulticastGroup( + getMulticastGroup( args: GetMulticastGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMulticastGroupCommandOutput) => void ): void; - public getMulticastGroup( - args: GetMulticastGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMulticastGroupCommandOutput) => void), - cb?: (err: any, data?: GetMulticastGroupCommandOutput) => void - ): Promise | void { - const command = new GetMulticastGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a multicast group session.

+ * @see {@link GetMulticastGroupSessionCommand} */ - public getMulticastGroupSession( + getMulticastGroupSession( args: GetMulticastGroupSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMulticastGroupSession( + getMulticastGroupSession( args: GetMulticastGroupSessionCommandInput, cb: (err: any, data?: GetMulticastGroupSessionCommandOutput) => void ): void; - public getMulticastGroupSession( + getMulticastGroupSession( args: GetMulticastGroupSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMulticastGroupSessionCommandOutput) => void ): void; - public getMulticastGroupSession( - args: GetMulticastGroupSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMulticastGroupSessionCommandOutput) => void), - cb?: (err: any, data?: GetMulticastGroupSessionCommandOutput) => void - ): Promise | void { - const command = new GetMulticastGroupSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get network analyzer configuration.

+ * @see {@link GetNetworkAnalyzerConfigurationCommand} */ - public getNetworkAnalyzerConfiguration( + getNetworkAnalyzerConfiguration( args: GetNetworkAnalyzerConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getNetworkAnalyzerConfiguration( + getNetworkAnalyzerConfiguration( args: GetNetworkAnalyzerConfigurationCommandInput, cb: (err: any, data?: GetNetworkAnalyzerConfigurationCommandOutput) => void ): void; - public getNetworkAnalyzerConfiguration( + getNetworkAnalyzerConfiguration( args: GetNetworkAnalyzerConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNetworkAnalyzerConfigurationCommandOutput) => void ): void; - public getNetworkAnalyzerConfiguration( - args: GetNetworkAnalyzerConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetNetworkAnalyzerConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetNetworkAnalyzerConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetNetworkAnalyzerConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a partner account. If PartnerAccountId and PartnerType are null, returns all partner accounts.

+ * @see {@link GetPartnerAccountCommand} */ - public getPartnerAccount( + getPartnerAccount( args: GetPartnerAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPartnerAccount( + getPartnerAccount( args: GetPartnerAccountCommandInput, cb: (err: any, data?: GetPartnerAccountCommandOutput) => void ): void; - public getPartnerAccount( + getPartnerAccount( args: GetPartnerAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPartnerAccountCommandOutput) => void ): void; - public getPartnerAccount( - args: GetPartnerAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPartnerAccountCommandOutput) => void), - cb?: (err: any, data?: GetPartnerAccountCommandOutput) => void - ): Promise | void { - const command = new GetPartnerAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Get the position information for a given resource.

- * - *

This action is no longer supported. Calls to retrieve the position information - * should use the GetResourcePosition - * API operation instead.

- *
+ * @see {@link GetPositionCommand} */ - public getPosition(args: GetPositionCommandInput, options?: __HttpHandlerOptions): Promise; - public getPosition(args: GetPositionCommandInput, cb: (err: any, data?: GetPositionCommandOutput) => void): void; - public getPosition( + getPosition(args: GetPositionCommandInput, options?: __HttpHandlerOptions): Promise; + getPosition(args: GetPositionCommandInput, cb: (err: any, data?: GetPositionCommandOutput) => void): void; + getPosition( args: GetPositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPositionCommandOutput) => void ): void; - public getPosition( - args: GetPositionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPositionCommandOutput) => void), - cb?: (err: any, data?: GetPositionCommandOutput) => void - ): Promise | void { - const command = new GetPositionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Get position configuration for a given resource.

- * - *

This action is no longer supported. Calls to retrieve the position configuration - * should use the GetResourcePosition - * API operation instead.

- *
+ * @see {@link GetPositionConfigurationCommand} */ - public getPositionConfiguration( + getPositionConfiguration( args: GetPositionConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPositionConfiguration( + getPositionConfiguration( args: GetPositionConfigurationCommandInput, cb: (err: any, data?: GetPositionConfigurationCommandOutput) => void ): void; - public getPositionConfiguration( + getPositionConfiguration( args: GetPositionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPositionConfigurationCommandOutput) => void ): void; - public getPositionConfiguration( - args: GetPositionConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPositionConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetPositionConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetPositionConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get estimated position information as a payload in GeoJSON format. The payload measurement data is - * resolved using solvers that are provided by third-party vendors.

+ * @see {@link GetPositionEstimateCommand} */ - public getPositionEstimate( + getPositionEstimate( args: GetPositionEstimateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPositionEstimate( + getPositionEstimate( args: GetPositionEstimateCommandInput, cb: (err: any, data?: GetPositionEstimateCommandOutput) => void ): void; - public getPositionEstimate( + getPositionEstimate( args: GetPositionEstimateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPositionEstimateCommandOutput) => void ): void; - public getPositionEstimate( - args: GetPositionEstimateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPositionEstimateCommandOutput) => void), - cb?: (err: any, data?: GetPositionEstimateCommandOutput) => void - ): Promise | void { - const command = new GetPositionEstimateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the event configuration for a particular resource identifier.

+ * @see {@link GetResourceEventConfigurationCommand} */ - public getResourceEventConfiguration( + getResourceEventConfiguration( args: GetResourceEventConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourceEventConfiguration( + getResourceEventConfiguration( args: GetResourceEventConfigurationCommandInput, cb: (err: any, data?: GetResourceEventConfigurationCommandOutput) => void ): void; - public getResourceEventConfiguration( + getResourceEventConfiguration( args: GetResourceEventConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceEventConfigurationCommandOutput) => void ): void; - public getResourceEventConfiguration( - args: GetResourceEventConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourceEventConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetResourceEventConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetResourceEventConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Fetches the log-level override, if any, for a given resource-ID and resource-type. It can be used for - * a wireless device or a wireless gateway.

+ * @see {@link GetResourceLogLevelCommand} */ - public getResourceLogLevel( + getResourceLogLevel( args: GetResourceLogLevelCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourceLogLevel( + getResourceLogLevel( args: GetResourceLogLevelCommandInput, cb: (err: any, data?: GetResourceLogLevelCommandOutput) => void ): void; - public getResourceLogLevel( + getResourceLogLevel( args: GetResourceLogLevelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceLogLevelCommandOutput) => void ): void; - public getResourceLogLevel( - args: GetResourceLogLevelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourceLogLevelCommandOutput) => void), - cb?: (err: any, data?: GetResourceLogLevelCommandOutput) => void - ): Promise | void { - const command = new GetResourceLogLevelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the position information for a given wireless device or a wireless gateway resource. - * The position information uses the World Geodetic System - * (WGS84).

+ * @see {@link GetResourcePositionCommand} */ - public getResourcePosition( + getResourcePosition( args: GetResourcePositionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourcePosition( + getResourcePosition( args: GetResourcePositionCommandInput, cb: (err: any, data?: GetResourcePositionCommandOutput) => void ): void; - public getResourcePosition( + getResourcePosition( args: GetResourcePositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePositionCommandOutput) => void ): void; - public getResourcePosition( - args: GetResourcePositionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourcePositionCommandOutput) => void), - cb?: (err: any, data?: GetResourcePositionCommandOutput) => void - ): Promise | void { - const command = new GetResourcePositionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.

+ * @see {@link GetServiceEndpointCommand} */ - public getServiceEndpoint( + getServiceEndpoint( args: GetServiceEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServiceEndpoint( + getServiceEndpoint( args: GetServiceEndpointCommandInput, cb: (err: any, data?: GetServiceEndpointCommandOutput) => void ): void; - public getServiceEndpoint( + getServiceEndpoint( args: GetServiceEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceEndpointCommandOutput) => void ): void; - public getServiceEndpoint( - args: GetServiceEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceEndpointCommandOutput) => void), - cb?: (err: any, data?: GetServiceEndpointCommandOutput) => void - ): Promise | void { - const command = new GetServiceEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a service profile.

+ * @see {@link GetServiceProfileCommand} */ - public getServiceProfile( + getServiceProfile( args: GetServiceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServiceProfile( + getServiceProfile( args: GetServiceProfileCommandInput, cb: (err: any, data?: GetServiceProfileCommandOutput) => void ): void; - public getServiceProfile( + getServiceProfile( args: GetServiceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceProfileCommandOutput) => void ): void; - public getServiceProfile( - args: GetServiceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceProfileCommandOutput) => void), - cb?: (err: any, data?: GetServiceProfileCommandOutput) => void - ): Promise | void { - const command = new GetServiceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a wireless device.

+ * @see {@link GetWirelessDeviceCommand} */ - public getWirelessDevice( + getWirelessDevice( args: GetWirelessDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWirelessDevice( + getWirelessDevice( args: GetWirelessDeviceCommandInput, cb: (err: any, data?: GetWirelessDeviceCommandOutput) => void ): void; - public getWirelessDevice( + getWirelessDevice( args: GetWirelessDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWirelessDeviceCommandOutput) => void ): void; - public getWirelessDevice( - args: GetWirelessDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWirelessDeviceCommandOutput) => void), - cb?: (err: any, data?: GetWirelessDeviceCommandOutput) => void - ): Promise | void { - const command = new GetWirelessDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get information about an import task and count of device onboarding summary information for the - * import task.

+ * @see {@link GetWirelessDeviceImportTaskCommand} */ - public getWirelessDeviceImportTask( + getWirelessDeviceImportTask( args: GetWirelessDeviceImportTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWirelessDeviceImportTask( + getWirelessDeviceImportTask( args: GetWirelessDeviceImportTaskCommandInput, cb: (err: any, data?: GetWirelessDeviceImportTaskCommandOutput) => void ): void; - public getWirelessDeviceImportTask( + getWirelessDeviceImportTask( args: GetWirelessDeviceImportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWirelessDeviceImportTaskCommandOutput) => void ): void; - public getWirelessDeviceImportTask( - args: GetWirelessDeviceImportTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWirelessDeviceImportTaskCommandOutput) => void), - cb?: (err: any, data?: GetWirelessDeviceImportTaskCommandOutput) => void - ): Promise | void { - const command = new GetWirelessDeviceImportTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets operating information about a wireless device.

+ * @see {@link GetWirelessDeviceStatisticsCommand} */ - public getWirelessDeviceStatistics( + getWirelessDeviceStatistics( args: GetWirelessDeviceStatisticsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWirelessDeviceStatistics( + getWirelessDeviceStatistics( args: GetWirelessDeviceStatisticsCommandInput, cb: (err: any, data?: GetWirelessDeviceStatisticsCommandOutput) => void ): void; - public getWirelessDeviceStatistics( + getWirelessDeviceStatistics( args: GetWirelessDeviceStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWirelessDeviceStatisticsCommandOutput) => void ): void; - public getWirelessDeviceStatistics( - args: GetWirelessDeviceStatisticsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWirelessDeviceStatisticsCommandOutput) => void), - cb?: (err: any, data?: GetWirelessDeviceStatisticsCommandOutput) => void - ): Promise | void { - const command = new GetWirelessDeviceStatisticsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a wireless gateway.

+ * @see {@link GetWirelessGatewayCommand} */ - public getWirelessGateway( + getWirelessGateway( args: GetWirelessGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWirelessGateway( + getWirelessGateway( args: GetWirelessGatewayCommandInput, cb: (err: any, data?: GetWirelessGatewayCommandOutput) => void ): void; - public getWirelessGateway( + getWirelessGateway( args: GetWirelessGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWirelessGatewayCommandOutput) => void ): void; - public getWirelessGateway( - args: GetWirelessGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWirelessGatewayCommandOutput) => void), - cb?: (err: any, data?: GetWirelessGatewayCommandOutput) => void - ): Promise | void { - const command = new GetWirelessGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the ID of the certificate that is currently associated with a wireless gateway.

+ * @see {@link GetWirelessGatewayCertificateCommand} */ - public getWirelessGatewayCertificate( + getWirelessGatewayCertificate( args: GetWirelessGatewayCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWirelessGatewayCertificate( + getWirelessGatewayCertificate( args: GetWirelessGatewayCertificateCommandInput, cb: (err: any, data?: GetWirelessGatewayCertificateCommandOutput) => void ): void; - public getWirelessGatewayCertificate( + getWirelessGatewayCertificate( args: GetWirelessGatewayCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWirelessGatewayCertificateCommandOutput) => void ): void; - public getWirelessGatewayCertificate( - args: GetWirelessGatewayCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWirelessGatewayCertificateCommandOutput) => void), - cb?: (err: any, data?: GetWirelessGatewayCertificateCommandOutput) => void - ): Promise | void { - const command = new GetWirelessGatewayCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the firmware version and other information about a wireless gateway.

+ * @see {@link GetWirelessGatewayFirmwareInformationCommand} */ - public getWirelessGatewayFirmwareInformation( + getWirelessGatewayFirmwareInformation( args: GetWirelessGatewayFirmwareInformationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWirelessGatewayFirmwareInformation( + getWirelessGatewayFirmwareInformation( args: GetWirelessGatewayFirmwareInformationCommandInput, cb: (err: any, data?: GetWirelessGatewayFirmwareInformationCommandOutput) => void ): void; - public getWirelessGatewayFirmwareInformation( + getWirelessGatewayFirmwareInformation( args: GetWirelessGatewayFirmwareInformationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWirelessGatewayFirmwareInformationCommandOutput) => void ): void; - public getWirelessGatewayFirmwareInformation( - args: GetWirelessGatewayFirmwareInformationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetWirelessGatewayFirmwareInformationCommandOutput) => void), - cb?: (err: any, data?: GetWirelessGatewayFirmwareInformationCommandOutput) => void - ): Promise | void { - const command = new GetWirelessGatewayFirmwareInformationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets operating information about a wireless gateway.

+ * @see {@link GetWirelessGatewayStatisticsCommand} */ - public getWirelessGatewayStatistics( + getWirelessGatewayStatistics( args: GetWirelessGatewayStatisticsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWirelessGatewayStatistics( + getWirelessGatewayStatistics( args: GetWirelessGatewayStatisticsCommandInput, cb: (err: any, data?: GetWirelessGatewayStatisticsCommandOutput) => void ): void; - public getWirelessGatewayStatistics( + getWirelessGatewayStatistics( args: GetWirelessGatewayStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWirelessGatewayStatisticsCommandOutput) => void ): void; - public getWirelessGatewayStatistics( - args: GetWirelessGatewayStatisticsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWirelessGatewayStatisticsCommandOutput) => void), - cb?: (err: any, data?: GetWirelessGatewayStatisticsCommandOutput) => void - ): Promise | void { - const command = new GetWirelessGatewayStatisticsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a wireless gateway task.

+ * @see {@link GetWirelessGatewayTaskCommand} */ - public getWirelessGatewayTask( + getWirelessGatewayTask( args: GetWirelessGatewayTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWirelessGatewayTask( + getWirelessGatewayTask( args: GetWirelessGatewayTaskCommandInput, cb: (err: any, data?: GetWirelessGatewayTaskCommandOutput) => void ): void; - public getWirelessGatewayTask( + getWirelessGatewayTask( args: GetWirelessGatewayTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWirelessGatewayTaskCommandOutput) => void ): void; - public getWirelessGatewayTask( - args: GetWirelessGatewayTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWirelessGatewayTaskCommandOutput) => void), - cb?: (err: any, data?: GetWirelessGatewayTaskCommandOutput) => void - ): Promise | void { - const command = new GetWirelessGatewayTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a wireless gateway task definition.

+ * @see {@link GetWirelessGatewayTaskDefinitionCommand} */ - public getWirelessGatewayTaskDefinition( + getWirelessGatewayTaskDefinition( args: GetWirelessGatewayTaskDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWirelessGatewayTaskDefinition( + getWirelessGatewayTaskDefinition( args: GetWirelessGatewayTaskDefinitionCommandInput, cb: (err: any, data?: GetWirelessGatewayTaskDefinitionCommandOutput) => void ): void; - public getWirelessGatewayTaskDefinition( + getWirelessGatewayTaskDefinition( args: GetWirelessGatewayTaskDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWirelessGatewayTaskDefinitionCommandOutput) => void ): void; - public getWirelessGatewayTaskDefinition( - args: GetWirelessGatewayTaskDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWirelessGatewayTaskDefinitionCommandOutput) => void), - cb?: (err: any, data?: GetWirelessGatewayTaskDefinitionCommandOutput) => void - ): Promise | void { - const command = new GetWirelessGatewayTaskDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the destinations registered to your AWS account.

+ * @see {@link ListDestinationsCommand} */ - public listDestinations( + listDestinations( args: ListDestinationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDestinations( + listDestinations( args: ListDestinationsCommandInput, cb: (err: any, data?: ListDestinationsCommandOutput) => void ): void; - public listDestinations( + listDestinations( args: ListDestinationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDestinationsCommandOutput) => void ): void; - public listDestinations( - args: ListDestinationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDestinationsCommandOutput) => void), - cb?: (err: any, data?: ListDestinationsCommandOutput) => void - ): Promise | void { - const command = new ListDestinationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the device profiles registered to your AWS account.

+ * @see {@link ListDeviceProfilesCommand} */ - public listDeviceProfiles( + listDeviceProfiles( args: ListDeviceProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeviceProfiles( + listDeviceProfiles( args: ListDeviceProfilesCommandInput, cb: (err: any, data?: ListDeviceProfilesCommandOutput) => void ): void; - public listDeviceProfiles( + listDeviceProfiles( args: ListDeviceProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeviceProfilesCommandOutput) => void ): void; - public listDeviceProfiles( - args: ListDeviceProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeviceProfilesCommandOutput) => void), - cb?: (err: any, data?: ListDeviceProfilesCommandOutput) => void - ): Promise | void { - const command = new ListDeviceProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the Sidewalk devices in an import task and their onboarding status.

+ * @see {@link ListDevicesForWirelessDeviceImportTaskCommand} */ - public listDevicesForWirelessDeviceImportTask( + listDevicesForWirelessDeviceImportTask( args: ListDevicesForWirelessDeviceImportTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDevicesForWirelessDeviceImportTask( + listDevicesForWirelessDeviceImportTask( args: ListDevicesForWirelessDeviceImportTaskCommandInput, cb: (err: any, data?: ListDevicesForWirelessDeviceImportTaskCommandOutput) => void ): void; - public listDevicesForWirelessDeviceImportTask( + listDevicesForWirelessDeviceImportTask( args: ListDevicesForWirelessDeviceImportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDevicesForWirelessDeviceImportTaskCommandOutput) => void ): void; - public listDevicesForWirelessDeviceImportTask( - args: ListDevicesForWirelessDeviceImportTaskCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListDevicesForWirelessDeviceImportTaskCommandOutput) => void), - cb?: (err: any, data?: ListDevicesForWirelessDeviceImportTaskCommandOutput) => void - ): Promise | void { - const command = new ListDevicesForWirelessDeviceImportTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List event configurations where at least one event topic has been enabled.

+ * @see {@link ListEventConfigurationsCommand} */ - public listEventConfigurations( + listEventConfigurations( args: ListEventConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEventConfigurations( + listEventConfigurations( args: ListEventConfigurationsCommandInput, cb: (err: any, data?: ListEventConfigurationsCommandOutput) => void ): void; - public listEventConfigurations( + listEventConfigurations( args: ListEventConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventConfigurationsCommandOutput) => void ): void; - public listEventConfigurations( - args: ListEventConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEventConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListEventConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListEventConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the FUOTA tasks registered to your AWS account.

+ * @see {@link ListFuotaTasksCommand} */ - public listFuotaTasks( + listFuotaTasks( args: ListFuotaTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFuotaTasks( - args: ListFuotaTasksCommandInput, - cb: (err: any, data?: ListFuotaTasksCommandOutput) => void - ): void; - public listFuotaTasks( + listFuotaTasks(args: ListFuotaTasksCommandInput, cb: (err: any, data?: ListFuotaTasksCommandOutput) => void): void; + listFuotaTasks( args: ListFuotaTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFuotaTasksCommandOutput) => void ): void; - public listFuotaTasks( - args: ListFuotaTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFuotaTasksCommandOutput) => void), - cb?: (err: any, data?: ListFuotaTasksCommandOutput) => void - ): Promise | void { - const command = new ListFuotaTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the multicast groups registered to your AWS account.

+ * @see {@link ListMulticastGroupsCommand} */ - public listMulticastGroups( + listMulticastGroups( args: ListMulticastGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMulticastGroups( + listMulticastGroups( args: ListMulticastGroupsCommandInput, cb: (err: any, data?: ListMulticastGroupsCommandOutput) => void ): void; - public listMulticastGroups( + listMulticastGroups( args: ListMulticastGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMulticastGroupsCommandOutput) => void ): void; - public listMulticastGroups( - args: ListMulticastGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMulticastGroupsCommandOutput) => void), - cb?: (err: any, data?: ListMulticastGroupsCommandOutput) => void - ): Promise | void { - const command = new ListMulticastGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all multicast groups associated with a fuota task.

+ * @see {@link ListMulticastGroupsByFuotaTaskCommand} */ - public listMulticastGroupsByFuotaTask( + listMulticastGroupsByFuotaTask( args: ListMulticastGroupsByFuotaTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMulticastGroupsByFuotaTask( + listMulticastGroupsByFuotaTask( args: ListMulticastGroupsByFuotaTaskCommandInput, cb: (err: any, data?: ListMulticastGroupsByFuotaTaskCommandOutput) => void ): void; - public listMulticastGroupsByFuotaTask( + listMulticastGroupsByFuotaTask( args: ListMulticastGroupsByFuotaTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMulticastGroupsByFuotaTaskCommandOutput) => void ): void; - public listMulticastGroupsByFuotaTask( - args: ListMulticastGroupsByFuotaTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMulticastGroupsByFuotaTaskCommandOutput) => void), - cb?: (err: any, data?: ListMulticastGroupsByFuotaTaskCommandOutput) => void - ): Promise | void { - const command = new ListMulticastGroupsByFuotaTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the network analyzer configurations.

+ * @see {@link ListNetworkAnalyzerConfigurationsCommand} */ - public listNetworkAnalyzerConfigurations( + listNetworkAnalyzerConfigurations( args: ListNetworkAnalyzerConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listNetworkAnalyzerConfigurations( + listNetworkAnalyzerConfigurations( args: ListNetworkAnalyzerConfigurationsCommandInput, cb: (err: any, data?: ListNetworkAnalyzerConfigurationsCommandOutput) => void ): void; - public listNetworkAnalyzerConfigurations( + listNetworkAnalyzerConfigurations( args: ListNetworkAnalyzerConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNetworkAnalyzerConfigurationsCommandOutput) => void ): void; - public listNetworkAnalyzerConfigurations( - args: ListNetworkAnalyzerConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNetworkAnalyzerConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListNetworkAnalyzerConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListNetworkAnalyzerConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the partner accounts associated with your AWS account.

+ * @see {@link ListPartnerAccountsCommand} */ - public listPartnerAccounts( + listPartnerAccounts( args: ListPartnerAccountsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPartnerAccounts( + listPartnerAccounts( args: ListPartnerAccountsCommandInput, cb: (err: any, data?: ListPartnerAccountsCommandOutput) => void ): void; - public listPartnerAccounts( + listPartnerAccounts( args: ListPartnerAccountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPartnerAccountsCommandOutput) => void ): void; - public listPartnerAccounts( - args: ListPartnerAccountsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPartnerAccountsCommandOutput) => void), - cb?: (err: any, data?: ListPartnerAccountsCommandOutput) => void - ): Promise | void { - const command = new ListPartnerAccountsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

List position configurations for a given resource, such as positioning solvers.

- * - *

This action is no longer supported. Calls to retrieve position information - * should use the GetResourcePosition - * API operation instead.

- *
+ * @see {@link ListPositionConfigurationsCommand} */ - public listPositionConfigurations( + listPositionConfigurations( args: ListPositionConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPositionConfigurations( + listPositionConfigurations( args: ListPositionConfigurationsCommandInput, cb: (err: any, data?: ListPositionConfigurationsCommandOutput) => void ): void; - public listPositionConfigurations( + listPositionConfigurations( args: ListPositionConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPositionConfigurationsCommandOutput) => void ): void; - public listPositionConfigurations( - args: ListPositionConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPositionConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListPositionConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListPositionConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List queued messages in the downlink queue.

+ * @see {@link ListQueuedMessagesCommand} */ - public listQueuedMessages( + listQueuedMessages( args: ListQueuedMessagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listQueuedMessages( + listQueuedMessages( args: ListQueuedMessagesCommandInput, cb: (err: any, data?: ListQueuedMessagesCommandOutput) => void ): void; - public listQueuedMessages( + listQueuedMessages( args: ListQueuedMessagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQueuedMessagesCommandOutput) => void ): void; - public listQueuedMessages( - args: ListQueuedMessagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListQueuedMessagesCommandOutput) => void), - cb?: (err: any, data?: ListQueuedMessagesCommandOutput) => void - ): Promise | void { - const command = new ListQueuedMessagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the service profiles registered to your AWS account.

+ * @see {@link ListServiceProfilesCommand} */ - public listServiceProfiles( + listServiceProfiles( args: ListServiceProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listServiceProfiles( + listServiceProfiles( args: ListServiceProfilesCommandInput, cb: (err: any, data?: ListServiceProfilesCommandOutput) => void ): void; - public listServiceProfiles( + listServiceProfiles( args: ListServiceProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceProfilesCommandOutput) => void ): void; - public listServiceProfiles( - args: ListServiceProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServiceProfilesCommandOutput) => void), - cb?: (err: any, data?: ListServiceProfilesCommandOutput) => void - ): Promise | void { - const command = new ListServiceProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags (metadata) you have assigned to the resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List wireless devices that have been added to an import task.

+ * @see {@link ListWirelessDeviceImportTasksCommand} */ - public listWirelessDeviceImportTasks( + listWirelessDeviceImportTasks( args: ListWirelessDeviceImportTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWirelessDeviceImportTasks( + listWirelessDeviceImportTasks( args: ListWirelessDeviceImportTasksCommandInput, cb: (err: any, data?: ListWirelessDeviceImportTasksCommandOutput) => void ): void; - public listWirelessDeviceImportTasks( + listWirelessDeviceImportTasks( args: ListWirelessDeviceImportTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWirelessDeviceImportTasksCommandOutput) => void ): void; - public listWirelessDeviceImportTasks( - args: ListWirelessDeviceImportTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWirelessDeviceImportTasksCommandOutput) => void), - cb?: (err: any, data?: ListWirelessDeviceImportTasksCommandOutput) => void - ): Promise | void { - const command = new ListWirelessDeviceImportTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the wireless devices registered to your AWS account.

+ * @see {@link ListWirelessDevicesCommand} */ - public listWirelessDevices( + listWirelessDevices( args: ListWirelessDevicesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWirelessDevices( + listWirelessDevices( args: ListWirelessDevicesCommandInput, cb: (err: any, data?: ListWirelessDevicesCommandOutput) => void ): void; - public listWirelessDevices( + listWirelessDevices( args: ListWirelessDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWirelessDevicesCommandOutput) => void ): void; - public listWirelessDevices( - args: ListWirelessDevicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWirelessDevicesCommandOutput) => void), - cb?: (err: any, data?: ListWirelessDevicesCommandOutput) => void - ): Promise | void { - const command = new ListWirelessDevicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the wireless gateways registered to your AWS account.

+ * @see {@link ListWirelessGatewaysCommand} */ - public listWirelessGateways( + listWirelessGateways( args: ListWirelessGatewaysCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWirelessGateways( + listWirelessGateways( args: ListWirelessGatewaysCommandInput, cb: (err: any, data?: ListWirelessGatewaysCommandOutput) => void ): void; - public listWirelessGateways( + listWirelessGateways( args: ListWirelessGatewaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWirelessGatewaysCommandOutput) => void ): void; - public listWirelessGateways( - args: ListWirelessGatewaysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWirelessGatewaysCommandOutput) => void), - cb?: (err: any, data?: ListWirelessGatewaysCommandOutput) => void - ): Promise | void { - const command = new ListWirelessGatewaysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the wireless gateway tasks definitions registered to your AWS account.

+ * @see {@link ListWirelessGatewayTaskDefinitionsCommand} */ - public listWirelessGatewayTaskDefinitions( + listWirelessGatewayTaskDefinitions( args: ListWirelessGatewayTaskDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWirelessGatewayTaskDefinitions( + listWirelessGatewayTaskDefinitions( args: ListWirelessGatewayTaskDefinitionsCommandInput, cb: (err: any, data?: ListWirelessGatewayTaskDefinitionsCommandOutput) => void ): void; - public listWirelessGatewayTaskDefinitions( + listWirelessGatewayTaskDefinitions( args: ListWirelessGatewayTaskDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWirelessGatewayTaskDefinitionsCommandOutput) => void ): void; - public listWirelessGatewayTaskDefinitions( - args: ListWirelessGatewayTaskDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWirelessGatewayTaskDefinitionsCommandOutput) => void), - cb?: (err: any, data?: ListWirelessGatewayTaskDefinitionsCommandOutput) => void - ): Promise | void { - const command = new ListWirelessGatewayTaskDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Put position configuration for a given resource.

- * - *

This action is no longer supported. Calls to update the position configuration - * should use the UpdateResourcePosition API operation instead.

- *
+ * @see {@link PutPositionConfigurationCommand} */ - public putPositionConfiguration( + putPositionConfiguration( args: PutPositionConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putPositionConfiguration( + putPositionConfiguration( args: PutPositionConfigurationCommandInput, cb: (err: any, data?: PutPositionConfigurationCommandOutput) => void ): void; - public putPositionConfiguration( + putPositionConfiguration( args: PutPositionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPositionConfigurationCommandOutput) => void ): void; - public putPositionConfiguration( - args: PutPositionConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutPositionConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutPositionConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutPositionConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the log-level override for a resource-ID and resource-type. This option can be specified for a wireless gateway - * or a wireless device. A limit of 200 log level override can be set per account.

+ * @see {@link PutResourceLogLevelCommand} */ - public putResourceLogLevel( + putResourceLogLevel( args: PutResourceLogLevelCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResourceLogLevel( + putResourceLogLevel( args: PutResourceLogLevelCommandInput, cb: (err: any, data?: PutResourceLogLevelCommandOutput) => void ): void; - public putResourceLogLevel( + putResourceLogLevel( args: PutResourceLogLevelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourceLogLevelCommandOutput) => void ): void; - public putResourceLogLevel( - args: PutResourceLogLevelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourceLogLevelCommandOutput) => void), - cb?: (err: any, data?: PutResourceLogLevelCommandOutput) => void - ): Promise | void { - const command = new PutResourceLogLevelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the log-level overrides for all resources; both wireless devices and wireless gateways.

+ * @see {@link ResetAllResourceLogLevelsCommand} */ - public resetAllResourceLogLevels( + resetAllResourceLogLevels( args: ResetAllResourceLogLevelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetAllResourceLogLevels( + resetAllResourceLogLevels( args: ResetAllResourceLogLevelsCommandInput, cb: (err: any, data?: ResetAllResourceLogLevelsCommandOutput) => void ): void; - public resetAllResourceLogLevels( + resetAllResourceLogLevels( args: ResetAllResourceLogLevelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetAllResourceLogLevelsCommandOutput) => void ): void; - public resetAllResourceLogLevels( - args: ResetAllResourceLogLevelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetAllResourceLogLevelsCommandOutput) => void), - cb?: (err: any, data?: ResetAllResourceLogLevelsCommandOutput) => void - ): Promise | void { - const command = new ResetAllResourceLogLevelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the log-level override, if any, for a specific resource-ID and resource-type. It can be used for - * a wireless device or a wireless gateway.

+ * @see {@link ResetResourceLogLevelCommand} */ - public resetResourceLogLevel( + resetResourceLogLevel( args: ResetResourceLogLevelCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetResourceLogLevel( + resetResourceLogLevel( args: ResetResourceLogLevelCommandInput, cb: (err: any, data?: ResetResourceLogLevelCommandOutput) => void ): void; - public resetResourceLogLevel( + resetResourceLogLevel( args: ResetResourceLogLevelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetResourceLogLevelCommandOutput) => void ): void; - public resetResourceLogLevel( - args: ResetResourceLogLevelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetResourceLogLevelCommandOutput) => void), - cb?: (err: any, data?: ResetResourceLogLevelCommandOutput) => void - ): Promise | void { - const command = new ResetResourceLogLevelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sends the specified data to a multicast group.

+ * @see {@link SendDataToMulticastGroupCommand} */ - public sendDataToMulticastGroup( + sendDataToMulticastGroup( args: SendDataToMulticastGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendDataToMulticastGroup( + sendDataToMulticastGroup( args: SendDataToMulticastGroupCommandInput, cb: (err: any, data?: SendDataToMulticastGroupCommandOutput) => void ): void; - public sendDataToMulticastGroup( + sendDataToMulticastGroup( args: SendDataToMulticastGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendDataToMulticastGroupCommandOutput) => void ): void; - public sendDataToMulticastGroup( - args: SendDataToMulticastGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendDataToMulticastGroupCommandOutput) => void), - cb?: (err: any, data?: SendDataToMulticastGroupCommandOutput) => void - ): Promise | void { - const command = new SendDataToMulticastGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sends a decrypted application data frame to a device.

+ * @see {@link SendDataToWirelessDeviceCommand} */ - public sendDataToWirelessDevice( + sendDataToWirelessDevice( args: SendDataToWirelessDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendDataToWirelessDevice( + sendDataToWirelessDevice( args: SendDataToWirelessDeviceCommandInput, cb: (err: any, data?: SendDataToWirelessDeviceCommandOutput) => void ): void; - public sendDataToWirelessDevice( + sendDataToWirelessDevice( args: SendDataToWirelessDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendDataToWirelessDeviceCommandOutput) => void ): void; - public sendDataToWirelessDevice( - args: SendDataToWirelessDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendDataToWirelessDeviceCommandOutput) => void), - cb?: (err: any, data?: SendDataToWirelessDeviceCommandOutput) => void - ): Promise | void { - const command = new SendDataToWirelessDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a bulk association of all qualifying wireless devices with a multicast group.

+ * @see {@link StartBulkAssociateWirelessDeviceWithMulticastGroupCommand} */ - public startBulkAssociateWirelessDeviceWithMulticastGroup( + startBulkAssociateWirelessDeviceWithMulticastGroup( args: StartBulkAssociateWirelessDeviceWithMulticastGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public startBulkAssociateWirelessDeviceWithMulticastGroup( + startBulkAssociateWirelessDeviceWithMulticastGroup( args: StartBulkAssociateWirelessDeviceWithMulticastGroupCommandInput, cb: (err: any, data?: StartBulkAssociateWirelessDeviceWithMulticastGroupCommandOutput) => void ): void; - public startBulkAssociateWirelessDeviceWithMulticastGroup( + startBulkAssociateWirelessDeviceWithMulticastGroup( args: StartBulkAssociateWirelessDeviceWithMulticastGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartBulkAssociateWirelessDeviceWithMulticastGroupCommandOutput) => void ): void; - public startBulkAssociateWirelessDeviceWithMulticastGroup( - args: StartBulkAssociateWirelessDeviceWithMulticastGroupCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: StartBulkAssociateWirelessDeviceWithMulticastGroupCommandOutput) => void), - cb?: (err: any, data?: StartBulkAssociateWirelessDeviceWithMulticastGroupCommandOutput) => void - ): Promise | void { - const command = new StartBulkAssociateWirelessDeviceWithMulticastGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a bulk disassociatin of all qualifying wireless devices from a multicast group.

+ * @see {@link StartBulkDisassociateWirelessDeviceFromMulticastGroupCommand} */ - public startBulkDisassociateWirelessDeviceFromMulticastGroup( + startBulkDisassociateWirelessDeviceFromMulticastGroup( args: StartBulkDisassociateWirelessDeviceFromMulticastGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public startBulkDisassociateWirelessDeviceFromMulticastGroup( + startBulkDisassociateWirelessDeviceFromMulticastGroup( args: StartBulkDisassociateWirelessDeviceFromMulticastGroupCommandInput, cb: (err: any, data?: StartBulkDisassociateWirelessDeviceFromMulticastGroupCommandOutput) => void ): void; - public startBulkDisassociateWirelessDeviceFromMulticastGroup( + startBulkDisassociateWirelessDeviceFromMulticastGroup( args: StartBulkDisassociateWirelessDeviceFromMulticastGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartBulkDisassociateWirelessDeviceFromMulticastGroupCommandOutput) => void ): void; - public startBulkDisassociateWirelessDeviceFromMulticastGroup( - args: StartBulkDisassociateWirelessDeviceFromMulticastGroupCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: StartBulkDisassociateWirelessDeviceFromMulticastGroupCommandOutput) => void), - cb?: (err: any, data?: StartBulkDisassociateWirelessDeviceFromMulticastGroupCommandOutput) => void - ): Promise | void { - const command = new StartBulkDisassociateWirelessDeviceFromMulticastGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a FUOTA task.

+ * @see {@link StartFuotaTaskCommand} */ - public startFuotaTask( + startFuotaTask( args: StartFuotaTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public startFuotaTask( - args: StartFuotaTaskCommandInput, - cb: (err: any, data?: StartFuotaTaskCommandOutput) => void - ): void; - public startFuotaTask( + startFuotaTask(args: StartFuotaTaskCommandInput, cb: (err: any, data?: StartFuotaTaskCommandOutput) => void): void; + startFuotaTask( args: StartFuotaTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFuotaTaskCommandOutput) => void ): void; - public startFuotaTask( - args: StartFuotaTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartFuotaTaskCommandOutput) => void), - cb?: (err: any, data?: StartFuotaTaskCommandOutput) => void - ): Promise | void { - const command = new StartFuotaTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a multicast group session.

+ * @see {@link StartMulticastGroupSessionCommand} */ - public startMulticastGroupSession( + startMulticastGroupSession( args: StartMulticastGroupSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startMulticastGroupSession( + startMulticastGroupSession( args: StartMulticastGroupSessionCommandInput, cb: (err: any, data?: StartMulticastGroupSessionCommandOutput) => void ): void; - public startMulticastGroupSession( + startMulticastGroupSession( args: StartMulticastGroupSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMulticastGroupSessionCommandOutput) => void ): void; - public startMulticastGroupSession( - args: StartMulticastGroupSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartMulticastGroupSessionCommandOutput) => void), - cb?: (err: any, data?: StartMulticastGroupSessionCommandOutput) => void - ): Promise | void { - const command = new StartMulticastGroupSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Start import task for a single wireless device.

+ * @see {@link StartSingleWirelessDeviceImportTaskCommand} */ - public startSingleWirelessDeviceImportTask( + startSingleWirelessDeviceImportTask( args: StartSingleWirelessDeviceImportTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public startSingleWirelessDeviceImportTask( + startSingleWirelessDeviceImportTask( args: StartSingleWirelessDeviceImportTaskCommandInput, cb: (err: any, data?: StartSingleWirelessDeviceImportTaskCommandOutput) => void ): void; - public startSingleWirelessDeviceImportTask( + startSingleWirelessDeviceImportTask( args: StartSingleWirelessDeviceImportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSingleWirelessDeviceImportTaskCommandOutput) => void ): void; - public startSingleWirelessDeviceImportTask( - args: StartSingleWirelessDeviceImportTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartSingleWirelessDeviceImportTaskCommandOutput) => void), - cb?: (err: any, data?: StartSingleWirelessDeviceImportTaskCommandOutput) => void - ): Promise | void { - const command = new StartSingleWirelessDeviceImportTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Start import task for provisioning Sidewalk devices in bulk using an S3 CSV file.

+ * @see {@link StartWirelessDeviceImportTaskCommand} */ - public startWirelessDeviceImportTask( + startWirelessDeviceImportTask( args: StartWirelessDeviceImportTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public startWirelessDeviceImportTask( + startWirelessDeviceImportTask( args: StartWirelessDeviceImportTaskCommandInput, cb: (err: any, data?: StartWirelessDeviceImportTaskCommandOutput) => void ): void; - public startWirelessDeviceImportTask( + startWirelessDeviceImportTask( args: StartWirelessDeviceImportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartWirelessDeviceImportTaskCommandOutput) => void ): void; - public startWirelessDeviceImportTask( - args: StartWirelessDeviceImportTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartWirelessDeviceImportTaskCommandOutput) => void), - cb?: (err: any, data?: StartWirelessDeviceImportTaskCommandOutput) => void - ): Promise | void { - const command = new StartWirelessDeviceImportTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a tag to a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Simulates a provisioned device by sending an uplink data payload of Hello.

+ * @see {@link TestWirelessDeviceCommand} */ - public testWirelessDevice( + testWirelessDevice( args: TestWirelessDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public testWirelessDevice( + testWirelessDevice( args: TestWirelessDeviceCommandInput, cb: (err: any, data?: TestWirelessDeviceCommandOutput) => void ): void; - public testWirelessDevice( + testWirelessDevice( args: TestWirelessDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestWirelessDeviceCommandOutput) => void ): void; - public testWirelessDevice( - args: TestWirelessDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestWirelessDeviceCommandOutput) => void), - cb?: (err: any, data?: TestWirelessDeviceCommandOutput) => void - ): Promise | void { - const command = new TestWirelessDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates properties of a destination.

+ * @see {@link UpdateDestinationCommand} */ - public updateDestination( + updateDestination( args: UpdateDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDestination( + updateDestination( args: UpdateDestinationCommandInput, cb: (err: any, data?: UpdateDestinationCommandOutput) => void ): void; - public updateDestination( + updateDestination( args: UpdateDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDestinationCommandOutput) => void ): void; - public updateDestination( - args: UpdateDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDestinationCommandOutput) => void), - cb?: (err: any, data?: UpdateDestinationCommandOutput) => void - ): Promise | void { - const command = new UpdateDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update the event configuration based on resource types.

+ * @see {@link UpdateEventConfigurationByResourceTypesCommand} */ - public updateEventConfigurationByResourceTypes( + updateEventConfigurationByResourceTypes( args: UpdateEventConfigurationByResourceTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEventConfigurationByResourceTypes( + updateEventConfigurationByResourceTypes( args: UpdateEventConfigurationByResourceTypesCommandInput, cb: (err: any, data?: UpdateEventConfigurationByResourceTypesCommandOutput) => void ): void; - public updateEventConfigurationByResourceTypes( + updateEventConfigurationByResourceTypes( args: UpdateEventConfigurationByResourceTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEventConfigurationByResourceTypesCommandOutput) => void ): void; - public updateEventConfigurationByResourceTypes( - args: UpdateEventConfigurationByResourceTypesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateEventConfigurationByResourceTypesCommandOutput) => void), - cb?: (err: any, data?: UpdateEventConfigurationByResourceTypesCommandOutput) => void - ): Promise | void { - const command = new UpdateEventConfigurationByResourceTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates properties of a FUOTA task.

+ * @see {@link UpdateFuotaTaskCommand} */ - public updateFuotaTask( + updateFuotaTask( args: UpdateFuotaTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFuotaTask( - args: UpdateFuotaTaskCommandInput, - cb: (err: any, data?: UpdateFuotaTaskCommandOutput) => void - ): void; - public updateFuotaTask( + updateFuotaTask(args: UpdateFuotaTaskCommandInput, cb: (err: any, data?: UpdateFuotaTaskCommandOutput) => void): void; + updateFuotaTask( args: UpdateFuotaTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFuotaTaskCommandOutput) => void ): void; - public updateFuotaTask( - args: UpdateFuotaTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFuotaTaskCommandOutput) => void), - cb?: (err: any, data?: UpdateFuotaTaskCommandOutput) => void - ): Promise | void { - const command = new UpdateFuotaTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Set default log level, or log levels by resource types. This can be for wireless device log options or - * wireless gateways log options and is used to control the log messages that'll be displayed in CloudWatch.

+ * @see {@link UpdateLogLevelsByResourceTypesCommand} */ - public updateLogLevelsByResourceTypes( + updateLogLevelsByResourceTypes( args: UpdateLogLevelsByResourceTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLogLevelsByResourceTypes( + updateLogLevelsByResourceTypes( args: UpdateLogLevelsByResourceTypesCommandInput, cb: (err: any, data?: UpdateLogLevelsByResourceTypesCommandOutput) => void ): void; - public updateLogLevelsByResourceTypes( + updateLogLevelsByResourceTypes( args: UpdateLogLevelsByResourceTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLogLevelsByResourceTypesCommandOutput) => void ): void; - public updateLogLevelsByResourceTypes( - args: UpdateLogLevelsByResourceTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLogLevelsByResourceTypesCommandOutput) => void), - cb?: (err: any, data?: UpdateLogLevelsByResourceTypesCommandOutput) => void - ): Promise | void { - const command = new UpdateLogLevelsByResourceTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates properties of a multicast group session.

+ * @see {@link UpdateMulticastGroupCommand} */ - public updateMulticastGroup( + updateMulticastGroup( args: UpdateMulticastGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMulticastGroup( + updateMulticastGroup( args: UpdateMulticastGroupCommandInput, cb: (err: any, data?: UpdateMulticastGroupCommandOutput) => void ): void; - public updateMulticastGroup( + updateMulticastGroup( args: UpdateMulticastGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMulticastGroupCommandOutput) => void ): void; - public updateMulticastGroup( - args: UpdateMulticastGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMulticastGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateMulticastGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateMulticastGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update network analyzer configuration.

+ * @see {@link UpdateNetworkAnalyzerConfigurationCommand} */ - public updateNetworkAnalyzerConfiguration( + updateNetworkAnalyzerConfiguration( args: UpdateNetworkAnalyzerConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateNetworkAnalyzerConfiguration( + updateNetworkAnalyzerConfiguration( args: UpdateNetworkAnalyzerConfigurationCommandInput, cb: (err: any, data?: UpdateNetworkAnalyzerConfigurationCommandOutput) => void ): void; - public updateNetworkAnalyzerConfiguration( + updateNetworkAnalyzerConfiguration( args: UpdateNetworkAnalyzerConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNetworkAnalyzerConfigurationCommandOutput) => void ): void; - public updateNetworkAnalyzerConfiguration( - args: UpdateNetworkAnalyzerConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateNetworkAnalyzerConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateNetworkAnalyzerConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateNetworkAnalyzerConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates properties of a partner account.

+ * @see {@link UpdatePartnerAccountCommand} */ - public updatePartnerAccount( + updatePartnerAccount( args: UpdatePartnerAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePartnerAccount( + updatePartnerAccount( args: UpdatePartnerAccountCommandInput, cb: (err: any, data?: UpdatePartnerAccountCommandOutput) => void ): void; - public updatePartnerAccount( + updatePartnerAccount( args: UpdatePartnerAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePartnerAccountCommandOutput) => void ): void; - public updatePartnerAccount( - args: UpdatePartnerAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePartnerAccountCommandOutput) => void), - cb?: (err: any, data?: UpdatePartnerAccountCommandOutput) => void - ): Promise | void { - const command = new UpdatePartnerAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Update the position information of a resource.

- * - *

This action is no longer supported. Calls to update the position information - * should use the UpdateResourcePosition API operation instead.

- *
+ * @see {@link UpdatePositionCommand} */ - public updatePosition( + updatePosition( args: UpdatePositionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePosition( - args: UpdatePositionCommandInput, - cb: (err: any, data?: UpdatePositionCommandOutput) => void - ): void; - public updatePosition( + updatePosition(args: UpdatePositionCommandInput, cb: (err: any, data?: UpdatePositionCommandOutput) => void): void; + updatePosition( args: UpdatePositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePositionCommandOutput) => void ): void; - public updatePosition( - args: UpdatePositionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePositionCommandOutput) => void), - cb?: (err: any, data?: UpdatePositionCommandOutput) => void - ): Promise | void { - const command = new UpdatePositionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update the event configuration for a particular resource identifier.

+ * @see {@link UpdateResourceEventConfigurationCommand} */ - public updateResourceEventConfiguration( + updateResourceEventConfiguration( args: UpdateResourceEventConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateResourceEventConfiguration( + updateResourceEventConfiguration( args: UpdateResourceEventConfigurationCommandInput, cb: (err: any, data?: UpdateResourceEventConfigurationCommandOutput) => void ): void; - public updateResourceEventConfiguration( + updateResourceEventConfiguration( args: UpdateResourceEventConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResourceEventConfigurationCommandOutput) => void ): void; - public updateResourceEventConfiguration( - args: UpdateResourceEventConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResourceEventConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateResourceEventConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateResourceEventConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update the position information of a given wireless device or a wireless gateway - * resource. The position coordinates are based on the World Geodetic System - * (WGS84).

+ * @see {@link UpdateResourcePositionCommand} */ - public updateResourcePosition( + updateResourcePosition( args: UpdateResourcePositionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateResourcePosition( + updateResourcePosition( args: UpdateResourcePositionCommandInput, cb: (err: any, data?: UpdateResourcePositionCommandOutput) => void ): void; - public updateResourcePosition( + updateResourcePosition( args: UpdateResourcePositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResourcePositionCommandOutput) => void ): void; - public updateResourcePosition( - args: UpdateResourcePositionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResourcePositionCommandOutput) => void), - cb?: (err: any, data?: UpdateResourcePositionCommandOutput) => void - ): Promise | void { - const command = new UpdateResourcePositionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates properties of a wireless device.

+ * @see {@link UpdateWirelessDeviceCommand} */ - public updateWirelessDevice( + updateWirelessDevice( args: UpdateWirelessDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWirelessDevice( + updateWirelessDevice( args: UpdateWirelessDeviceCommandInput, cb: (err: any, data?: UpdateWirelessDeviceCommandOutput) => void ): void; - public updateWirelessDevice( + updateWirelessDevice( args: UpdateWirelessDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWirelessDeviceCommandOutput) => void ): void; - public updateWirelessDevice( - args: UpdateWirelessDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWirelessDeviceCommandOutput) => void), - cb?: (err: any, data?: UpdateWirelessDeviceCommandOutput) => void - ): Promise | void { - const command = new UpdateWirelessDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update an import task to add more devices to the task.

+ * @see {@link UpdateWirelessDeviceImportTaskCommand} */ - public updateWirelessDeviceImportTask( + updateWirelessDeviceImportTask( args: UpdateWirelessDeviceImportTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWirelessDeviceImportTask( + updateWirelessDeviceImportTask( args: UpdateWirelessDeviceImportTaskCommandInput, cb: (err: any, data?: UpdateWirelessDeviceImportTaskCommandOutput) => void ): void; - public updateWirelessDeviceImportTask( + updateWirelessDeviceImportTask( args: UpdateWirelessDeviceImportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWirelessDeviceImportTaskCommandOutput) => void ): void; - public updateWirelessDeviceImportTask( - args: UpdateWirelessDeviceImportTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWirelessDeviceImportTaskCommandOutput) => void), - cb?: (err: any, data?: UpdateWirelessDeviceImportTaskCommandOutput) => void - ): Promise | void { - const command = new UpdateWirelessDeviceImportTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates properties of a wireless gateway.

+ * @see {@link UpdateWirelessGatewayCommand} */ - public updateWirelessGateway( + updateWirelessGateway( args: UpdateWirelessGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWirelessGateway( + updateWirelessGateway( args: UpdateWirelessGatewayCommandInput, cb: (err: any, data?: UpdateWirelessGatewayCommandOutput) => void ): void; - public updateWirelessGateway( + updateWirelessGateway( args: UpdateWirelessGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWirelessGatewayCommandOutput) => void ): void; - public updateWirelessGateway( - args: UpdateWirelessGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWirelessGatewayCommandOutput) => void), - cb?: (err: any, data?: UpdateWirelessGatewayCommandOutput) => void - ): Promise | void { - const command = new UpdateWirelessGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

AWS IoT Wireless provides bi-directional communication between internet-connected wireless + * devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS IoT, use the + * IoT Wireless API. These wireless devices use the Low Power Wide Area Networking (LPWAN) + * communication protocol to communicate with AWS IoT.

+ *

Using the API, you can perform create, read, update, and delete operations for your wireless + * devices, gateways, destinations, and profiles. After onboarding your devices, you + * can use the API operations to set log levels and monitor your devices with CloudWatch.

+ *

You can also use the API operations to create multicast groups and schedule a multicast session for + * sending a downlink message to devices in the group. By using Firmware Updates Over-The-Air + * (FUOTA) API operations, you can create a FUOTA task and schedule a session to update the firmware + * of individual devices or an entire group of devices in a multicast group.

+ */ +export class IoTWireless extends IoTWirelessClient implements IoTWireless {} +createAggregatedClient(commands, IoTWireless); diff --git a/clients/client-iot/src/IoT.ts b/clients/client-iot/src/IoT.ts index 6b5059412b7f..2c4ff9272623 100644 --- a/clients/client-iot/src/IoT.ts +++ b/clients/client-iot/src/IoT.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -1131,8343 +1132,4057 @@ import { ValidateSecurityProfileBehaviorsCommandInput, ValidateSecurityProfileBehaviorsCommandOutput, } from "./commands/ValidateSecurityProfileBehaviorsCommand"; -import { IoTClient } from "./IoTClient"; +import { IoTClient, IoTClientConfig } from "./IoTClient"; -/** - * @public - * IoT - *

IoT provides secure, bi-directional communication between Internet-connected - * devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services - * cloud. You can discover your custom IoT-Data endpoint to communicate with, configure - * rules for data processing and integration with other services, organize resources - * associated with each device (Registry), configure logging, and create and manage - * policies and credentials to authenticate devices.

- *

The service endpoints that expose this API are listed in - * Amazon Web Services IoT Core Endpoints and Quotas. - * You must use the endpoint for the region that has the resources you want to access.

- *

The service name used by Amazon Web Services - * Signature Version 4 to sign the request is: - * execute-api.

- *

For more information about how IoT works, see the Developer - * Guide.

- *

For information about how to use the credentials provider for IoT, see Authorizing Direct Calls to Amazon Web Services Services.

- */ -export class IoT extends IoTClient { +const commands = { + AcceptCertificateTransferCommand, + AddThingToBillingGroupCommand, + AddThingToThingGroupCommand, + AssociateTargetsWithJobCommand, + AttachPolicyCommand, + AttachPrincipalPolicyCommand, + AttachSecurityProfileCommand, + AttachThingPrincipalCommand, + CancelAuditMitigationActionsTaskCommand, + CancelAuditTaskCommand, + CancelCertificateTransferCommand, + CancelDetectMitigationActionsTaskCommand, + CancelJobCommand, + CancelJobExecutionCommand, + ClearDefaultAuthorizerCommand, + ConfirmTopicRuleDestinationCommand, + CreateAuditSuppressionCommand, + CreateAuthorizerCommand, + CreateBillingGroupCommand, + CreateCertificateFromCsrCommand, + CreateCustomMetricCommand, + CreateDimensionCommand, + CreateDomainConfigurationCommand, + CreateDynamicThingGroupCommand, + CreateFleetMetricCommand, + CreateJobCommand, + CreateJobTemplateCommand, + CreateKeysAndCertificateCommand, + CreateMitigationActionCommand, + CreateOTAUpdateCommand, + CreatePolicyCommand, + CreatePolicyVersionCommand, + CreateProvisioningClaimCommand, + CreateProvisioningTemplateCommand, + CreateProvisioningTemplateVersionCommand, + CreateRoleAliasCommand, + CreateScheduledAuditCommand, + CreateSecurityProfileCommand, + CreateStreamCommand, + CreateThingCommand, + CreateThingGroupCommand, + CreateThingTypeCommand, + CreateTopicRuleCommand, + CreateTopicRuleDestinationCommand, + DeleteAccountAuditConfigurationCommand, + DeleteAuditSuppressionCommand, + DeleteAuthorizerCommand, + DeleteBillingGroupCommand, + DeleteCACertificateCommand, + DeleteCertificateCommand, + DeleteCustomMetricCommand, + DeleteDimensionCommand, + DeleteDomainConfigurationCommand, + DeleteDynamicThingGroupCommand, + DeleteFleetMetricCommand, + DeleteJobCommand, + DeleteJobExecutionCommand, + DeleteJobTemplateCommand, + DeleteMitigationActionCommand, + DeleteOTAUpdateCommand, + DeletePolicyCommand, + DeletePolicyVersionCommand, + DeleteProvisioningTemplateCommand, + DeleteProvisioningTemplateVersionCommand, + DeleteRegistrationCodeCommand, + DeleteRoleAliasCommand, + DeleteScheduledAuditCommand, + DeleteSecurityProfileCommand, + DeleteStreamCommand, + DeleteThingCommand, + DeleteThingGroupCommand, + DeleteThingTypeCommand, + DeleteTopicRuleCommand, + DeleteTopicRuleDestinationCommand, + DeleteV2LoggingLevelCommand, + DeprecateThingTypeCommand, + DescribeAccountAuditConfigurationCommand, + DescribeAuditFindingCommand, + DescribeAuditMitigationActionsTaskCommand, + DescribeAuditSuppressionCommand, + DescribeAuditTaskCommand, + DescribeAuthorizerCommand, + DescribeBillingGroupCommand, + DescribeCACertificateCommand, + DescribeCertificateCommand, + DescribeCustomMetricCommand, + DescribeDefaultAuthorizerCommand, + DescribeDetectMitigationActionsTaskCommand, + DescribeDimensionCommand, + DescribeDomainConfigurationCommand, + DescribeEndpointCommand, + DescribeEventConfigurationsCommand, + DescribeFleetMetricCommand, + DescribeIndexCommand, + DescribeJobCommand, + DescribeJobExecutionCommand, + DescribeJobTemplateCommand, + DescribeManagedJobTemplateCommand, + DescribeMitigationActionCommand, + DescribeProvisioningTemplateCommand, + DescribeProvisioningTemplateVersionCommand, + DescribeRoleAliasCommand, + DescribeScheduledAuditCommand, + DescribeSecurityProfileCommand, + DescribeStreamCommand, + DescribeThingCommand, + DescribeThingGroupCommand, + DescribeThingRegistrationTaskCommand, + DescribeThingTypeCommand, + DetachPolicyCommand, + DetachPrincipalPolicyCommand, + DetachSecurityProfileCommand, + DetachThingPrincipalCommand, + DisableTopicRuleCommand, + EnableTopicRuleCommand, + GetBehaviorModelTrainingSummariesCommand, + GetBucketsAggregationCommand, + GetCardinalityCommand, + GetEffectivePoliciesCommand, + GetIndexingConfigurationCommand, + GetJobDocumentCommand, + GetLoggingOptionsCommand, + GetOTAUpdateCommand, + GetPercentilesCommand, + GetPolicyCommand, + GetPolicyVersionCommand, + GetRegistrationCodeCommand, + GetStatisticsCommand, + GetTopicRuleCommand, + GetTopicRuleDestinationCommand, + GetV2LoggingOptionsCommand, + ListActiveViolationsCommand, + ListAttachedPoliciesCommand, + ListAuditFindingsCommand, + ListAuditMitigationActionsExecutionsCommand, + ListAuditMitigationActionsTasksCommand, + ListAuditSuppressionsCommand, + ListAuditTasksCommand, + ListAuthorizersCommand, + ListBillingGroupsCommand, + ListCACertificatesCommand, + ListCertificatesCommand, + ListCertificatesByCACommand, + ListCustomMetricsCommand, + ListDetectMitigationActionsExecutionsCommand, + ListDetectMitigationActionsTasksCommand, + ListDimensionsCommand, + ListDomainConfigurationsCommand, + ListFleetMetricsCommand, + ListIndicesCommand, + ListJobExecutionsForJobCommand, + ListJobExecutionsForThingCommand, + ListJobsCommand, + ListJobTemplatesCommand, + ListManagedJobTemplatesCommand, + ListMetricValuesCommand, + ListMitigationActionsCommand, + ListOTAUpdatesCommand, + ListOutgoingCertificatesCommand, + ListPoliciesCommand, + ListPolicyPrincipalsCommand, + ListPolicyVersionsCommand, + ListPrincipalPoliciesCommand, + ListPrincipalThingsCommand, + ListProvisioningTemplatesCommand, + ListProvisioningTemplateVersionsCommand, + ListRelatedResourcesForAuditFindingCommand, + ListRoleAliasesCommand, + ListScheduledAuditsCommand, + ListSecurityProfilesCommand, + ListSecurityProfilesForTargetCommand, + ListStreamsCommand, + ListTagsForResourceCommand, + ListTargetsForPolicyCommand, + ListTargetsForSecurityProfileCommand, + ListThingGroupsCommand, + ListThingGroupsForThingCommand, + ListThingPrincipalsCommand, + ListThingRegistrationTaskReportsCommand, + ListThingRegistrationTasksCommand, + ListThingsCommand, + ListThingsInBillingGroupCommand, + ListThingsInThingGroupCommand, + ListThingTypesCommand, + ListTopicRuleDestinationsCommand, + ListTopicRulesCommand, + ListV2LoggingLevelsCommand, + ListViolationEventsCommand, + PutVerificationStateOnViolationCommand, + RegisterCACertificateCommand, + RegisterCertificateCommand, + RegisterCertificateWithoutCACommand, + RegisterThingCommand, + RejectCertificateTransferCommand, + RemoveThingFromBillingGroupCommand, + RemoveThingFromThingGroupCommand, + ReplaceTopicRuleCommand, + SearchIndexCommand, + SetDefaultAuthorizerCommand, + SetDefaultPolicyVersionCommand, + SetLoggingOptionsCommand, + SetV2LoggingLevelCommand, + SetV2LoggingOptionsCommand, + StartAuditMitigationActionsTaskCommand, + StartDetectMitigationActionsTaskCommand, + StartOnDemandAuditTaskCommand, + StartThingRegistrationTaskCommand, + StopThingRegistrationTaskCommand, + TagResourceCommand, + TestAuthorizationCommand, + TestInvokeAuthorizerCommand, + TransferCertificateCommand, + UntagResourceCommand, + UpdateAccountAuditConfigurationCommand, + UpdateAuditSuppressionCommand, + UpdateAuthorizerCommand, + UpdateBillingGroupCommand, + UpdateCACertificateCommand, + UpdateCertificateCommand, + UpdateCustomMetricCommand, + UpdateDimensionCommand, + UpdateDomainConfigurationCommand, + UpdateDynamicThingGroupCommand, + UpdateEventConfigurationsCommand, + UpdateFleetMetricCommand, + UpdateIndexingConfigurationCommand, + UpdateJobCommand, + UpdateMitigationActionCommand, + UpdateProvisioningTemplateCommand, + UpdateRoleAliasCommand, + UpdateScheduledAuditCommand, + UpdateSecurityProfileCommand, + UpdateStreamCommand, + UpdateThingCommand, + UpdateThingGroupCommand, + UpdateThingGroupsForThingCommand, + UpdateTopicRuleDestinationCommand, + ValidateSecurityProfileBehaviorsCommand, +}; + +export interface IoT { /** - * @public - *

Accepts a pending certificate transfer. The default state of the certificate is - * INACTIVE.

- *

To check for pending certificate transfers, call ListCertificates - * to enumerate your certificates.

- *

Requires permission to access the AcceptCertificateTransfer action.

+ * @see {@link AcceptCertificateTransferCommand} */ - public acceptCertificateTransfer( + acceptCertificateTransfer( args: AcceptCertificateTransferCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptCertificateTransfer( + acceptCertificateTransfer( args: AcceptCertificateTransferCommandInput, cb: (err: any, data?: AcceptCertificateTransferCommandOutput) => void ): void; - public acceptCertificateTransfer( + acceptCertificateTransfer( args: AcceptCertificateTransferCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptCertificateTransferCommandOutput) => void ): void; - public acceptCertificateTransfer( - args: AcceptCertificateTransferCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptCertificateTransferCommandOutput) => void), - cb?: (err: any, data?: AcceptCertificateTransferCommandOutput) => void - ): Promise | void { - const command = new AcceptCertificateTransferCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds a thing to a billing group.

- *

Requires permission to access the AddThingToBillingGroup action.

- */ - public addThingToBillingGroup( + + /** + * @see {@link AddThingToBillingGroupCommand} + */ + addThingToBillingGroup( args: AddThingToBillingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public addThingToBillingGroup( + addThingToBillingGroup( args: AddThingToBillingGroupCommandInput, cb: (err: any, data?: AddThingToBillingGroupCommandOutput) => void ): void; - public addThingToBillingGroup( + addThingToBillingGroup( args: AddThingToBillingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddThingToBillingGroupCommandOutput) => void ): void; - public addThingToBillingGroup( - args: AddThingToBillingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddThingToBillingGroupCommandOutput) => void), - cb?: (err: any, data?: AddThingToBillingGroupCommandOutput) => void - ): Promise | void { - const command = new AddThingToBillingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds a thing to a thing group.

- *

Requires permission to access the AddThingToThingGroup action.

- */ - public addThingToThingGroup( + + /** + * @see {@link AddThingToThingGroupCommand} + */ + addThingToThingGroup( args: AddThingToThingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public addThingToThingGroup( + addThingToThingGroup( args: AddThingToThingGroupCommandInput, cb: (err: any, data?: AddThingToThingGroupCommandOutput) => void ): void; - public addThingToThingGroup( + addThingToThingGroup( args: AddThingToThingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddThingToThingGroupCommandOutput) => void ): void; - public addThingToThingGroup( - args: AddThingToThingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddThingToThingGroupCommandOutput) => void), - cb?: (err: any, data?: AddThingToThingGroupCommandOutput) => void - ): Promise | void { - const command = new AddThingToThingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a group with a continuous job. The following criteria must be met:

- *
    - *
  • - *

    The job must have been created with the targetSelection field set to - * "CONTINUOUS".

    - *
  • - *
  • - *

    The job status must currently be "IN_PROGRESS".

    - *
  • - *
  • - *

    The total number of targets associated with a job must not exceed 100.

    - *
  • - *
- *

Requires permission to access the AssociateTargetsWithJob action.

- */ - public associateTargetsWithJob( + + /** + * @see {@link AssociateTargetsWithJobCommand} + */ + associateTargetsWithJob( args: AssociateTargetsWithJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateTargetsWithJob( + associateTargetsWithJob( args: AssociateTargetsWithJobCommandInput, cb: (err: any, data?: AssociateTargetsWithJobCommandOutput) => void ): void; - public associateTargetsWithJob( + associateTargetsWithJob( args: AssociateTargetsWithJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateTargetsWithJobCommandOutput) => void ): void; - public associateTargetsWithJob( - args: AssociateTargetsWithJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateTargetsWithJobCommandOutput) => void), - cb?: (err: any, data?: AssociateTargetsWithJobCommandOutput) => void - ): Promise | void { - const command = new AssociateTargetsWithJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attaches the specified policy to the specified principal (certificate or other - * credential).

- *

Requires permission to access the AttachPolicy action.

- */ - public attachPolicy( - args: AttachPolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public attachPolicy(args: AttachPolicyCommandInput, cb: (err: any, data?: AttachPolicyCommandOutput) => void): void; - public attachPolicy( + + /** + * @see {@link AttachPolicyCommand} + */ + attachPolicy(args: AttachPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + attachPolicy(args: AttachPolicyCommandInput, cb: (err: any, data?: AttachPolicyCommandOutput) => void): void; + attachPolicy( args: AttachPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachPolicyCommandOutput) => void ): void; - public attachPolicy( - args: AttachPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachPolicyCommandOutput) => void), - cb?: (err: any, data?: AttachPolicyCommandOutput) => void - ): Promise | void { - const command = new AttachPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * @deprecated - * - *

Attaches the specified policy to the specified principal (certificate or other - * credential).

- *

- * Note: This action is deprecated and works as - * expected for backward compatibility, but we won't add enhancements. Use AttachPolicy instead.

- *

Requires permission to access the AttachPrincipalPolicy action.

- */ - public attachPrincipalPolicy( + + /** + * @see {@link AttachPrincipalPolicyCommand} + */ + attachPrincipalPolicy( args: AttachPrincipalPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachPrincipalPolicy( + attachPrincipalPolicy( args: AttachPrincipalPolicyCommandInput, cb: (err: any, data?: AttachPrincipalPolicyCommandOutput) => void ): void; - public attachPrincipalPolicy( + attachPrincipalPolicy( args: AttachPrincipalPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachPrincipalPolicyCommandOutput) => void ): void; - public attachPrincipalPolicy( - args: AttachPrincipalPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachPrincipalPolicyCommandOutput) => void), - cb?: (err: any, data?: AttachPrincipalPolicyCommandOutput) => void - ): Promise | void { - const command = new AttachPrincipalPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a Device Defender security profile with a thing group or this account. Each - * thing group or account can have up to five security profiles associated with it.

- *

Requires permission to access the AttachSecurityProfile action.

- */ - public attachSecurityProfile( + + /** + * @see {@link AttachSecurityProfileCommand} + */ + attachSecurityProfile( args: AttachSecurityProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachSecurityProfile( + attachSecurityProfile( args: AttachSecurityProfileCommandInput, cb: (err: any, data?: AttachSecurityProfileCommandOutput) => void ): void; - public attachSecurityProfile( + attachSecurityProfile( args: AttachSecurityProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachSecurityProfileCommandOutput) => void ): void; - public attachSecurityProfile( - args: AttachSecurityProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachSecurityProfileCommandOutput) => void), - cb?: (err: any, data?: AttachSecurityProfileCommandOutput) => void - ): Promise | void { - const command = new AttachSecurityProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attaches the specified principal to the specified thing. A principal can be X.509 - * certificates, Amazon Cognito identities or federated identities.

- *

Requires permission to access the AttachThingPrincipal action.

- */ - public attachThingPrincipal( + + /** + * @see {@link AttachThingPrincipalCommand} + */ + attachThingPrincipal( args: AttachThingPrincipalCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachThingPrincipal( + attachThingPrincipal( args: AttachThingPrincipalCommandInput, cb: (err: any, data?: AttachThingPrincipalCommandOutput) => void ): void; - public attachThingPrincipal( + attachThingPrincipal( args: AttachThingPrincipalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachThingPrincipalCommandOutput) => void ): void; - public attachThingPrincipal( - args: AttachThingPrincipalCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachThingPrincipalCommandOutput) => void), - cb?: (err: any, data?: AttachThingPrincipalCommandOutput) => void - ): Promise | void { - const command = new AttachThingPrincipalCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels a mitigation action task that is in progress. If the task - * is not - * in progress, an InvalidRequestException occurs.

- *

Requires permission to access the CancelAuditMitigationActionsTask action.

- */ - public cancelAuditMitigationActionsTask( + + /** + * @see {@link CancelAuditMitigationActionsTaskCommand} + */ + cancelAuditMitigationActionsTask( args: CancelAuditMitigationActionsTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelAuditMitigationActionsTask( + cancelAuditMitigationActionsTask( args: CancelAuditMitigationActionsTaskCommandInput, cb: (err: any, data?: CancelAuditMitigationActionsTaskCommandOutput) => void ): void; - public cancelAuditMitigationActionsTask( + cancelAuditMitigationActionsTask( args: CancelAuditMitigationActionsTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelAuditMitigationActionsTaskCommandOutput) => void ): void; - public cancelAuditMitigationActionsTask( - args: CancelAuditMitigationActionsTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelAuditMitigationActionsTaskCommandOutput) => void), - cb?: (err: any, data?: CancelAuditMitigationActionsTaskCommandOutput) => void - ): Promise | void { - const command = new CancelAuditMitigationActionsTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn't in progress, an "InvalidRequestException" occurs.

- *

Requires permission to access the CancelAuditTask action.

- */ - public cancelAuditTask( + + /** + * @see {@link CancelAuditTaskCommand} + */ + cancelAuditTask( args: CancelAuditTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelAuditTask( - args: CancelAuditTaskCommandInput, - cb: (err: any, data?: CancelAuditTaskCommandOutput) => void - ): void; - public cancelAuditTask( + cancelAuditTask(args: CancelAuditTaskCommandInput, cb: (err: any, data?: CancelAuditTaskCommandOutput) => void): void; + cancelAuditTask( args: CancelAuditTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelAuditTaskCommandOutput) => void ): void; - public cancelAuditTask( - args: CancelAuditTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelAuditTaskCommandOutput) => void), - cb?: (err: any, data?: CancelAuditTaskCommandOutput) => void - ): Promise | void { - const command = new CancelAuditTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels a pending transfer for the specified certificate.

- *

- * Note Only the transfer source account can use this - * operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, IoT returns the - * certificate to the source account in the INACTIVE state. After the destination account has - * accepted the transfer, the transfer cannot be cancelled.

- *

After a certificate transfer is cancelled, the status of the certificate changes from - * PENDING_TRANSFER to INACTIVE.

- *

Requires permission to access the CancelCertificateTransfer action.

- */ - public cancelCertificateTransfer( + + /** + * @see {@link CancelCertificateTransferCommand} + */ + cancelCertificateTransfer( args: CancelCertificateTransferCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelCertificateTransfer( + cancelCertificateTransfer( args: CancelCertificateTransferCommandInput, cb: (err: any, data?: CancelCertificateTransferCommandOutput) => void ): void; - public cancelCertificateTransfer( + cancelCertificateTransfer( args: CancelCertificateTransferCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelCertificateTransferCommandOutput) => void ): void; - public cancelCertificateTransfer( - args: CancelCertificateTransferCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelCertificateTransferCommandOutput) => void), - cb?: (err: any, data?: CancelCertificateTransferCommandOutput) => void - ): Promise | void { - const command = new CancelCertificateTransferCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Cancels a Device Defender ML Detect mitigation action. - *

- *

Requires permission to access the CancelDetectMitigationActionsTask action.

- */ - public cancelDetectMitigationActionsTask( + + /** + * @see {@link CancelDetectMitigationActionsTaskCommand} + */ + cancelDetectMitigationActionsTask( args: CancelDetectMitigationActionsTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelDetectMitigationActionsTask( + cancelDetectMitigationActionsTask( args: CancelDetectMitigationActionsTaskCommandInput, cb: (err: any, data?: CancelDetectMitigationActionsTaskCommandOutput) => void ): void; - public cancelDetectMitigationActionsTask( + cancelDetectMitigationActionsTask( args: CancelDetectMitigationActionsTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelDetectMitigationActionsTaskCommandOutput) => void ): void; - public cancelDetectMitigationActionsTask( - args: CancelDetectMitigationActionsTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelDetectMitigationActionsTaskCommandOutput) => void), - cb?: (err: any, data?: CancelDetectMitigationActionsTaskCommandOutput) => void - ): Promise | void { - const command = new CancelDetectMitigationActionsTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels a job.

- *

Requires permission to access the CancelJob action.

- */ - public cancelJob(args: CancelJobCommandInput, options?: __HttpHandlerOptions): Promise; - public cancelJob(args: CancelJobCommandInput, cb: (err: any, data?: CancelJobCommandOutput) => void): void; - public cancelJob( + + /** + * @see {@link CancelJobCommand} + */ + cancelJob(args: CancelJobCommandInput, options?: __HttpHandlerOptions): Promise; + cancelJob(args: CancelJobCommandInput, cb: (err: any, data?: CancelJobCommandOutput) => void): void; + cancelJob( args: CancelJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelJobCommandOutput) => void ): void; - public cancelJob( - args: CancelJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelJobCommandOutput) => void), - cb?: (err: any, data?: CancelJobCommandOutput) => void - ): Promise | void { - const command = new CancelJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels the execution of a job for a given thing.

- *

Requires permission to access the CancelJobExecution action.

- */ - public cancelJobExecution( + + /** + * @see {@link CancelJobExecutionCommand} + */ + cancelJobExecution( args: CancelJobExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelJobExecution( + cancelJobExecution( args: CancelJobExecutionCommandInput, cb: (err: any, data?: CancelJobExecutionCommandOutput) => void ): void; - public cancelJobExecution( + cancelJobExecution( args: CancelJobExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelJobExecutionCommandOutput) => void ): void; - public cancelJobExecution( - args: CancelJobExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelJobExecutionCommandOutput) => void), - cb?: (err: any, data?: CancelJobExecutionCommandOutput) => void - ): Promise | void { - const command = new CancelJobExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Clears the default authorizer.

- *

Requires permission to access the ClearDefaultAuthorizer action.

- */ - public clearDefaultAuthorizer( + + /** + * @see {@link ClearDefaultAuthorizerCommand} + */ + clearDefaultAuthorizer( args: ClearDefaultAuthorizerCommandInput, options?: __HttpHandlerOptions ): Promise; - public clearDefaultAuthorizer( + clearDefaultAuthorizer( args: ClearDefaultAuthorizerCommandInput, cb: (err: any, data?: ClearDefaultAuthorizerCommandOutput) => void ): void; - public clearDefaultAuthorizer( + clearDefaultAuthorizer( args: ClearDefaultAuthorizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ClearDefaultAuthorizerCommandOutput) => void ): void; - public clearDefaultAuthorizer( - args: ClearDefaultAuthorizerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ClearDefaultAuthorizerCommandOutput) => void), - cb?: (err: any, data?: ClearDefaultAuthorizerCommandOutput) => void - ): Promise | void { - const command = new ClearDefaultAuthorizerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Confirms a topic rule destination. When you create a rule requiring a destination, IoT - * sends a confirmation message to the endpoint or base address you specify. The message - * includes a token which you pass back when calling ConfirmTopicRuleDestination - * to confirm that you own or have access to the endpoint.

- *

Requires permission to access the ConfirmTopicRuleDestination action.

- */ - public confirmTopicRuleDestination( + + /** + * @see {@link ConfirmTopicRuleDestinationCommand} + */ + confirmTopicRuleDestination( args: ConfirmTopicRuleDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public confirmTopicRuleDestination( + confirmTopicRuleDestination( args: ConfirmTopicRuleDestinationCommandInput, cb: (err: any, data?: ConfirmTopicRuleDestinationCommandOutput) => void ): void; - public confirmTopicRuleDestination( + confirmTopicRuleDestination( args: ConfirmTopicRuleDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfirmTopicRuleDestinationCommandOutput) => void ): void; - public confirmTopicRuleDestination( - args: ConfirmTopicRuleDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConfirmTopicRuleDestinationCommandOutput) => void), - cb?: (err: any, data?: ConfirmTopicRuleDestinationCommandOutput) => void - ): Promise | void { - const command = new ConfirmTopicRuleDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Creates a Device Defender audit suppression. - *

- *

Requires permission to access the CreateAuditSuppression action.

- */ - public createAuditSuppression( + + /** + * @see {@link CreateAuditSuppressionCommand} + */ + createAuditSuppression( args: CreateAuditSuppressionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAuditSuppression( + createAuditSuppression( args: CreateAuditSuppressionCommandInput, cb: (err: any, data?: CreateAuditSuppressionCommandOutput) => void ): void; - public createAuditSuppression( + createAuditSuppression( args: CreateAuditSuppressionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAuditSuppressionCommandOutput) => void ): void; - public createAuditSuppression( - args: CreateAuditSuppressionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAuditSuppressionCommandOutput) => void), - cb?: (err: any, data?: CreateAuditSuppressionCommandOutput) => void - ): Promise | void { - const command = new CreateAuditSuppressionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an authorizer.

- *

Requires permission to access the CreateAuthorizer action.

- */ - public createAuthorizer( + + /** + * @see {@link CreateAuthorizerCommand} + */ + createAuthorizer( args: CreateAuthorizerCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAuthorizer( + createAuthorizer( args: CreateAuthorizerCommandInput, cb: (err: any, data?: CreateAuthorizerCommandOutput) => void ): void; - public createAuthorizer( + createAuthorizer( args: CreateAuthorizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAuthorizerCommandOutput) => void ): void; - public createAuthorizer( - args: CreateAuthorizerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAuthorizerCommandOutput) => void), - cb?: (err: any, data?: CreateAuthorizerCommandOutput) => void - ): Promise | void { - const command = new CreateAuthorizerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a billing group.

- *

Requires permission to access the CreateBillingGroup action.

- */ - public createBillingGroup( + + /** + * @see {@link CreateBillingGroupCommand} + */ + createBillingGroup( args: CreateBillingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBillingGroup( + createBillingGroup( args: CreateBillingGroupCommandInput, cb: (err: any, data?: CreateBillingGroupCommandOutput) => void ): void; - public createBillingGroup( + createBillingGroup( args: CreateBillingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBillingGroupCommandOutput) => void ): void; - public createBillingGroup( - args: CreateBillingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBillingGroupCommandOutput) => void), - cb?: (err: any, data?: CreateBillingGroupCommandOutput) => void - ): Promise | void { - const command = new CreateBillingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an X.509 certificate using the specified certificate signing - * request. - *

- *

Requires permission to access the CreateCertificateFromCsr action. - *

- * - *

The CSR must include a public key that is either an - * RSA key with a length of at least 2048 bits or an ECC key from NIST P-25 or NIST P-384 curves. - * For supported certificates, consult - * Certificate signing algorithms supported by IoT. - *

- *
- * - *

Reusing the same certificate signing request (CSR) - * results in a distinct certificate.

- *
- *

You can create multiple certificates in a batch by creating a directory, copying - * multiple .csr files into that directory, and then specifying that directory on the command - * line. The following commands show how to create a batch of certificates given a batch of - * CSRs. In the following commands, we assume that a set of CSRs are located inside of the - * directory my-csr-directory:

- *

On Linux and OS X, the command is:

- *

- * $ ls my-csr-directory/ | xargs -I \{\} aws iot create-certificate-from-csr - * --certificate-signing-request file://my-csr-directory/\{\} - *

- *

This command lists all of the CSRs in my-csr-directory and pipes each CSR file name - * to the aws iot create-certificate-from-csr Amazon Web Services CLI command to create a certificate for - * the corresponding CSR.

- *

You can also run the aws iot create-certificate-from-csr part of the - * command in parallel to speed up the certificate creation process:

- *

- * $ ls my-csr-directory/ | xargs -P 10 -I \{\} aws iot create-certificate-from-csr - * --certificate-signing-request file://my-csr-directory/\{\} - * - *

- *

On Windows PowerShell, the command to create certificates for all CSRs in - * my-csr-directory is:

- *

- * > ls -Name my-csr-directory | %\{aws iot create-certificate-from-csr - * --certificate-signing-request file://my-csr-directory/$_\} - * - *

- *

On a Windows command prompt, the command to create certificates for all CSRs in - * my-csr-directory is:

- *

- * > forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr - * --certificate-signing-request file://@path" - * - *

- */ - public createCertificateFromCsr( + + /** + * @see {@link CreateCertificateFromCsrCommand} + */ + createCertificateFromCsr( args: CreateCertificateFromCsrCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCertificateFromCsr( + createCertificateFromCsr( args: CreateCertificateFromCsrCommandInput, cb: (err: any, data?: CreateCertificateFromCsrCommandOutput) => void ): void; - public createCertificateFromCsr( + createCertificateFromCsr( args: CreateCertificateFromCsrCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCertificateFromCsrCommandOutput) => void ): void; - public createCertificateFromCsr( - args: CreateCertificateFromCsrCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCertificateFromCsrCommandOutput) => void), - cb?: (err: any, data?: CreateCertificateFromCsrCommandOutput) => void - ): Promise | void { - const command = new CreateCertificateFromCsrCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Use this API to define a - * Custom - * Metric - * published by your devices to Device Defender.

- *

Requires permission to access the CreateCustomMetric action.

- */ - public createCustomMetric( + + /** + * @see {@link CreateCustomMetricCommand} + */ + createCustomMetric( args: CreateCustomMetricCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCustomMetric( + createCustomMetric( args: CreateCustomMetricCommandInput, cb: (err: any, data?: CreateCustomMetricCommandOutput) => void ): void; - public createCustomMetric( + createCustomMetric( args: CreateCustomMetricCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomMetricCommandOutput) => void ): void; - public createCustomMetric( - args: CreateCustomMetricCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCustomMetricCommandOutput) => void), - cb?: (err: any, data?: CreateCustomMetricCommandOutput) => void - ): Promise | void { - const command = new CreateCustomMetricCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender. - * For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

- *

Requires permission to access the CreateDimension action.

- */ - public createDimension( + + /** + * @see {@link CreateDimensionCommand} + */ + createDimension( args: CreateDimensionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDimension( - args: CreateDimensionCommandInput, - cb: (err: any, data?: CreateDimensionCommandOutput) => void - ): void; - public createDimension( + createDimension(args: CreateDimensionCommandInput, cb: (err: any, data?: CreateDimensionCommandOutput) => void): void; + createDimension( args: CreateDimensionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDimensionCommandOutput) => void ): void; - public createDimension( - args: CreateDimensionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDimensionCommandOutput) => void), - cb?: (err: any, data?: CreateDimensionCommandOutput) => void - ): Promise | void { - const command = new CreateDimensionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a domain configuration.

- *

Requires permission to access the CreateDomainConfiguration action.

- */ - public createDomainConfiguration( + + /** + * @see {@link CreateDomainConfigurationCommand} + */ + createDomainConfiguration( args: CreateDomainConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDomainConfiguration( + createDomainConfiguration( args: CreateDomainConfigurationCommandInput, cb: (err: any, data?: CreateDomainConfigurationCommandOutput) => void ): void; - public createDomainConfiguration( + createDomainConfiguration( args: CreateDomainConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDomainConfigurationCommandOutput) => void ): void; - public createDomainConfiguration( - args: CreateDomainConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDomainConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateDomainConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateDomainConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a dynamic thing group.

- *

Requires permission to access the CreateDynamicThingGroup action.

- */ - public createDynamicThingGroup( + + /** + * @see {@link CreateDynamicThingGroupCommand} + */ + createDynamicThingGroup( args: CreateDynamicThingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDynamicThingGroup( + createDynamicThingGroup( args: CreateDynamicThingGroupCommandInput, cb: (err: any, data?: CreateDynamicThingGroupCommandOutput) => void ): void; - public createDynamicThingGroup( + createDynamicThingGroup( args: CreateDynamicThingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDynamicThingGroupCommandOutput) => void ): void; - public createDynamicThingGroup( - args: CreateDynamicThingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDynamicThingGroupCommandOutput) => void), - cb?: (err: any, data?: CreateDynamicThingGroupCommandOutput) => void - ): Promise | void { - const command = new CreateDynamicThingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a fleet metric.

- *

Requires permission to access the CreateFleetMetric action.

- */ - public createFleetMetric( + + /** + * @see {@link CreateFleetMetricCommand} + */ + createFleetMetric( args: CreateFleetMetricCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFleetMetric( + createFleetMetric( args: CreateFleetMetricCommandInput, cb: (err: any, data?: CreateFleetMetricCommandOutput) => void ): void; - public createFleetMetric( + createFleetMetric( args: CreateFleetMetricCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFleetMetricCommandOutput) => void ): void; - public createFleetMetric( - args: CreateFleetMetricCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFleetMetricCommandOutput) => void), - cb?: (err: any, data?: CreateFleetMetricCommandOutput) => void - ): Promise | void { - const command = new CreateFleetMetricCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a job.

- *

Requires permission to access the CreateJob action.

- */ - public createJob(args: CreateJobCommandInput, options?: __HttpHandlerOptions): Promise; - public createJob(args: CreateJobCommandInput, cb: (err: any, data?: CreateJobCommandOutput) => void): void; - public createJob( + + /** + * @see {@link CreateJobCommand} + */ + createJob(args: CreateJobCommandInput, options?: __HttpHandlerOptions): Promise; + createJob(args: CreateJobCommandInput, cb: (err: any, data?: CreateJobCommandOutput) => void): void; + createJob( args: CreateJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateJobCommandOutput) => void ): void; - public createJob( - args: CreateJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateJobCommandOutput) => void), - cb?: (err: any, data?: CreateJobCommandOutput) => void - ): Promise | void { - const command = new CreateJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a job template.

- *

Requires permission to access the CreateJobTemplate action.

- */ - public createJobTemplate( + + /** + * @see {@link CreateJobTemplateCommand} + */ + createJobTemplate( args: CreateJobTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createJobTemplate( + createJobTemplate( args: CreateJobTemplateCommandInput, cb: (err: any, data?: CreateJobTemplateCommandOutput) => void ): void; - public createJobTemplate( + createJobTemplate( args: CreateJobTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateJobTemplateCommandOutput) => void ): void; - public createJobTemplate( - args: CreateJobTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateJobTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateJobTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateJobTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued - * public key. You can also call CreateKeysAndCertificate over MQTT from a - * device, for more information, see Provisioning MQTT API.

- *

- * Note This is the only time IoT issues the private key - * for this certificate, so it is important to keep it in a secure location.

- *

Requires permission to access the CreateKeysAndCertificate action.

- */ - public createKeysAndCertificate( + + /** + * @see {@link CreateKeysAndCertificateCommand} + */ + createKeysAndCertificate( args: CreateKeysAndCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createKeysAndCertificate( + createKeysAndCertificate( args: CreateKeysAndCertificateCommandInput, cb: (err: any, data?: CreateKeysAndCertificateCommandOutput) => void ): void; - public createKeysAndCertificate( + createKeysAndCertificate( args: CreateKeysAndCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateKeysAndCertificateCommandOutput) => void ): void; - public createKeysAndCertificate( - args: CreateKeysAndCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateKeysAndCertificateCommandOutput) => void), - cb?: (err: any, data?: CreateKeysAndCertificateCommandOutput) => void - ): Promise | void { - const command = new CreateKeysAndCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. - * For more information, see Mitigation actions. Each mitigation action can apply only one type of change.

- *

Requires permission to access the CreateMitigationAction action.

- */ - public createMitigationAction( + + /** + * @see {@link CreateMitigationActionCommand} + */ + createMitigationAction( args: CreateMitigationActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMitigationAction( + createMitigationAction( args: CreateMitigationActionCommandInput, cb: (err: any, data?: CreateMitigationActionCommandOutput) => void ): void; - public createMitigationAction( + createMitigationAction( args: CreateMitigationActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMitigationActionCommandOutput) => void ): void; - public createMitigationAction( - args: CreateMitigationActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMitigationActionCommandOutput) => void), - cb?: (err: any, data?: CreateMitigationActionCommandOutput) => void - ): Promise | void { - const command = new CreateMitigationActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an IoT OTA update on a target group of things or groups.

- *

Requires permission to access the CreateOTAUpdate action.

- */ - public createOTAUpdate( + + /** + * @see {@link CreateOTAUpdateCommand} + */ + createOTAUpdate( args: CreateOTAUpdateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createOTAUpdate( - args: CreateOTAUpdateCommandInput, - cb: (err: any, data?: CreateOTAUpdateCommandOutput) => void - ): void; - public createOTAUpdate( + createOTAUpdate(args: CreateOTAUpdateCommandInput, cb: (err: any, data?: CreateOTAUpdateCommandOutput) => void): void; + createOTAUpdate( args: CreateOTAUpdateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateOTAUpdateCommandOutput) => void ): void; - public createOTAUpdate( - args: CreateOTAUpdateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateOTAUpdateCommandOutput) => void), - cb?: (err: any, data?: CreateOTAUpdateCommandOutput) => void - ): Promise | void { - const command = new CreateOTAUpdateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an IoT policy.

- *

The created policy is the default version for the policy. This operation creates a - * policy version with a version identifier of 1 and sets - * 1 as the policy's default version.

- *

Requires permission to access the CreatePolicy action.

- */ - public createPolicy( - args: CreatePolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createPolicy(args: CreatePolicyCommandInput, cb: (err: any, data?: CreatePolicyCommandOutput) => void): void; - public createPolicy( + + /** + * @see {@link CreatePolicyCommand} + */ + createPolicy(args: CreatePolicyCommandInput, options?: __HttpHandlerOptions): Promise; + createPolicy(args: CreatePolicyCommandInput, cb: (err: any, data?: CreatePolicyCommandOutput) => void): void; + createPolicy( args: CreatePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePolicyCommandOutput) => void ): void; - public createPolicy( - args: CreatePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePolicyCommandOutput) => void), - cb?: (err: any, data?: CreatePolicyCommandOutput) => void - ): Promise | void { - const command = new CreatePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new version of the specified IoT policy. To update a policy, create a - * new policy version. A managed policy can have up to five versions. If the policy has five - * versions, you must use DeletePolicyVersion to delete an existing version - * before you create a new one.

- *

Optionally, you can set the new version as the policy's default version. The default - * version is the operative version (that is, the version that is in effect for the - * certificates to which the policy is attached).

- *

Requires permission to access the CreatePolicyVersion action.

- */ - public createPolicyVersion( + + /** + * @see {@link CreatePolicyVersionCommand} + */ + createPolicyVersion( args: CreatePolicyVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPolicyVersion( + createPolicyVersion( args: CreatePolicyVersionCommandInput, cb: (err: any, data?: CreatePolicyVersionCommandOutput) => void ): void; - public createPolicyVersion( + createPolicyVersion( args: CreatePolicyVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePolicyVersionCommandOutput) => void ): void; - public createPolicyVersion( - args: CreatePolicyVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePolicyVersionCommandOutput) => void), - cb?: (err: any, data?: CreatePolicyVersionCommandOutput) => void - ): Promise | void { - const command = new CreatePolicyVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a provisioning claim.

- *

Requires permission to access the CreateProvisioningClaim action.

- */ - public createProvisioningClaim( + + /** + * @see {@link CreateProvisioningClaimCommand} + */ + createProvisioningClaim( args: CreateProvisioningClaimCommandInput, options?: __HttpHandlerOptions ): Promise; - public createProvisioningClaim( + createProvisioningClaim( args: CreateProvisioningClaimCommandInput, cb: (err: any, data?: CreateProvisioningClaimCommandOutput) => void ): void; - public createProvisioningClaim( + createProvisioningClaim( args: CreateProvisioningClaimCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProvisioningClaimCommandOutput) => void ): void; - public createProvisioningClaim( - args: CreateProvisioningClaimCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProvisioningClaimCommandOutput) => void), - cb?: (err: any, data?: CreateProvisioningClaimCommandOutput) => void - ): Promise | void { - const command = new CreateProvisioningClaimCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a provisioning template.

- *

Requires permission to access the CreateProvisioningTemplate action.

- */ - public createProvisioningTemplate( + + /** + * @see {@link CreateProvisioningTemplateCommand} + */ + createProvisioningTemplate( args: CreateProvisioningTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createProvisioningTemplate( + createProvisioningTemplate( args: CreateProvisioningTemplateCommandInput, cb: (err: any, data?: CreateProvisioningTemplateCommandOutput) => void ): void; - public createProvisioningTemplate( + createProvisioningTemplate( args: CreateProvisioningTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProvisioningTemplateCommandOutput) => void ): void; - public createProvisioningTemplate( - args: CreateProvisioningTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProvisioningTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateProvisioningTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateProvisioningTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new version of a provisioning template.

- *

Requires permission to access the CreateProvisioningTemplateVersion action.

- */ - public createProvisioningTemplateVersion( + + /** + * @see {@link CreateProvisioningTemplateVersionCommand} + */ + createProvisioningTemplateVersion( args: CreateProvisioningTemplateVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createProvisioningTemplateVersion( + createProvisioningTemplateVersion( args: CreateProvisioningTemplateVersionCommandInput, cb: (err: any, data?: CreateProvisioningTemplateVersionCommandOutput) => void ): void; - public createProvisioningTemplateVersion( + createProvisioningTemplateVersion( args: CreateProvisioningTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProvisioningTemplateVersionCommandOutput) => void ): void; - public createProvisioningTemplateVersion( - args: CreateProvisioningTemplateVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProvisioningTemplateVersionCommandOutput) => void), - cb?: (err: any, data?: CreateProvisioningTemplateVersionCommandOutput) => void - ): Promise | void { - const command = new CreateProvisioningTemplateVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a role alias.

- *

Requires permission to access the CreateRoleAlias action.

- */ - public createRoleAlias( + + /** + * @see {@link CreateRoleAliasCommand} + */ + createRoleAlias( args: CreateRoleAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRoleAlias( - args: CreateRoleAliasCommandInput, - cb: (err: any, data?: CreateRoleAliasCommandOutput) => void - ): void; - public createRoleAlias( + createRoleAlias(args: CreateRoleAliasCommandInput, cb: (err: any, data?: CreateRoleAliasCommandOutput) => void): void; + createRoleAlias( args: CreateRoleAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRoleAliasCommandOutput) => void ): void; - public createRoleAlias( - args: CreateRoleAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRoleAliasCommandOutput) => void), - cb?: (err: any, data?: CreateRoleAliasCommandOutput) => void - ): Promise | void { - const command = new CreateRoleAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a scheduled audit that is run at a specified - * time interval.

- *

Requires permission to access the CreateScheduledAudit action.

- */ - public createScheduledAudit( + + /** + * @see {@link CreateScheduledAuditCommand} + */ + createScheduledAudit( args: CreateScheduledAuditCommandInput, options?: __HttpHandlerOptions ): Promise; - public createScheduledAudit( + createScheduledAudit( args: CreateScheduledAuditCommandInput, cb: (err: any, data?: CreateScheduledAuditCommandOutput) => void ): void; - public createScheduledAudit( + createScheduledAudit( args: CreateScheduledAuditCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateScheduledAuditCommandOutput) => void ): void; - public createScheduledAudit( - args: CreateScheduledAuditCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateScheduledAuditCommandOutput) => void), - cb?: (err: any, data?: CreateScheduledAuditCommandOutput) => void - ): Promise | void { - const command = new CreateScheduledAuditCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Device Defender security profile.

- *

Requires permission to access the CreateSecurityProfile action.

- */ - public createSecurityProfile( + + /** + * @see {@link CreateSecurityProfileCommand} + */ + createSecurityProfile( args: CreateSecurityProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSecurityProfile( + createSecurityProfile( args: CreateSecurityProfileCommandInput, cb: (err: any, data?: CreateSecurityProfileCommandOutput) => void ): void; - public createSecurityProfile( + createSecurityProfile( args: CreateSecurityProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSecurityProfileCommandOutput) => void ): void; - public createSecurityProfile( - args: CreateSecurityProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSecurityProfileCommandOutput) => void), - cb?: (err: any, data?: CreateSecurityProfileCommandOutput) => void - ): Promise | void { - const command = new CreateSecurityProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data - * bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files - * associated with a stream.

- *

Requires permission to access the CreateStream action.

- */ - public createStream( - args: CreateStreamCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createStream(args: CreateStreamCommandInput, cb: (err: any, data?: CreateStreamCommandOutput) => void): void; - public createStream( + + /** + * @see {@link CreateStreamCommand} + */ + createStream(args: CreateStreamCommandInput, options?: __HttpHandlerOptions): Promise; + createStream(args: CreateStreamCommandInput, cb: (err: any, data?: CreateStreamCommandOutput) => void): void; + createStream( args: CreateStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStreamCommandOutput) => void ): void; - public createStream( - args: CreateStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStreamCommandOutput) => void), - cb?: (err: any, data?: CreateStreamCommandOutput) => void - ): Promise | void { - const command = new CreateStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a thing record in the registry. If this call is made multiple times using - * the same thing name and configuration, the call will succeed. If this call is made with - * the same thing name but different configuration a - * ResourceAlreadyExistsException is thrown.

- * - *

This is a control plane operation. See Authorization for - * information about authorizing control plane actions.

- *
- *

Requires permission to access the CreateThing action.

- */ - public createThing(args: CreateThingCommandInput, options?: __HttpHandlerOptions): Promise; - public createThing(args: CreateThingCommandInput, cb: (err: any, data?: CreateThingCommandOutput) => void): void; - public createThing( + + /** + * @see {@link CreateThingCommand} + */ + createThing(args: CreateThingCommandInput, options?: __HttpHandlerOptions): Promise; + createThing(args: CreateThingCommandInput, cb: (err: any, data?: CreateThingCommandOutput) => void): void; + createThing( args: CreateThingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateThingCommandOutput) => void ): void; - public createThing( - args: CreateThingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateThingCommandOutput) => void), - cb?: (err: any, data?: CreateThingCommandOutput) => void - ): Promise | void { - const command = new CreateThingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Create a thing group.

- * - *

This is a control plane operation. See Authorization for - * information about authorizing control plane actions.

- *
- *

Requires permission to access the CreateThingGroup action.

- */ - public createThingGroup( + + /** + * @see {@link CreateThingGroupCommand} + */ + createThingGroup( args: CreateThingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createThingGroup( + createThingGroup( args: CreateThingGroupCommandInput, cb: (err: any, data?: CreateThingGroupCommandOutput) => void ): void; - public createThingGroup( + createThingGroup( args: CreateThingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateThingGroupCommandOutput) => void ): void; - public createThingGroup( - args: CreateThingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateThingGroupCommandOutput) => void), - cb?: (err: any, data?: CreateThingGroupCommandOutput) => void - ): Promise | void { - const command = new CreateThingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new thing type.

- *

Requires permission to access the CreateThingType action.

- */ - public createThingType( + + /** + * @see {@link CreateThingTypeCommand} + */ + createThingType( args: CreateThingTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public createThingType( - args: CreateThingTypeCommandInput, - cb: (err: any, data?: CreateThingTypeCommandOutput) => void - ): void; - public createThingType( + createThingType(args: CreateThingTypeCommandInput, cb: (err: any, data?: CreateThingTypeCommandOutput) => void): void; + createThingType( args: CreateThingTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateThingTypeCommandOutput) => void ): void; - public createThingType( - args: CreateThingTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateThingTypeCommandOutput) => void), - cb?: (err: any, data?: CreateThingTypeCommandOutput) => void - ): Promise | void { - const command = new CreateThingTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a rule. Creating rules is an administrator-level action. Any user who has - * permission to create rules will be able to access data processed by the rule.

- *

Requires permission to access the CreateTopicRule action.

- */ - public createTopicRule( + + /** + * @see {@link CreateTopicRuleCommand} + */ + createTopicRule( args: CreateTopicRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTopicRule( - args: CreateTopicRuleCommandInput, - cb: (err: any, data?: CreateTopicRuleCommandOutput) => void - ): void; - public createTopicRule( + createTopicRule(args: CreateTopicRuleCommandInput, cb: (err: any, data?: CreateTopicRuleCommandOutput) => void): void; + createTopicRule( args: CreateTopicRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTopicRuleCommandOutput) => void ): void; - public createTopicRule( - args: CreateTopicRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTopicRuleCommandOutput) => void), - cb?: (err: any, data?: CreateTopicRuleCommandOutput) => void - ): Promise | void { - const command = new CreateTopicRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a topic rule destination. The destination must be confirmed prior to use.

- *

Requires permission to access the CreateTopicRuleDestination action.

- */ - public createTopicRuleDestination( + + /** + * @see {@link CreateTopicRuleDestinationCommand} + */ + createTopicRuleDestination( args: CreateTopicRuleDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTopicRuleDestination( + createTopicRuleDestination( args: CreateTopicRuleDestinationCommandInput, cb: (err: any, data?: CreateTopicRuleDestinationCommandOutput) => void ): void; - public createTopicRuleDestination( + createTopicRuleDestination( args: CreateTopicRuleDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTopicRuleDestinationCommandOutput) => void ): void; - public createTopicRuleDestination( - args: CreateTopicRuleDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTopicRuleDestinationCommandOutput) => void), - cb?: (err: any, data?: CreateTopicRuleDestinationCommandOutput) => void - ): Promise | void { - const command = new CreateTopicRuleDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Restores the default settings for Device Defender audits for this account. Any - * configuration data you entered is deleted and all audit checks are reset to - * disabled.

- *

Requires permission to access the DeleteAccountAuditConfiguration action.

- */ - public deleteAccountAuditConfiguration( + + /** + * @see {@link DeleteAccountAuditConfigurationCommand} + */ + deleteAccountAuditConfiguration( args: DeleteAccountAuditConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAccountAuditConfiguration( + deleteAccountAuditConfiguration( args: DeleteAccountAuditConfigurationCommandInput, cb: (err: any, data?: DeleteAccountAuditConfigurationCommandOutput) => void ): void; - public deleteAccountAuditConfiguration( + deleteAccountAuditConfiguration( args: DeleteAccountAuditConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccountAuditConfigurationCommandOutput) => void ): void; - public deleteAccountAuditConfiguration( - args: DeleteAccountAuditConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAccountAuditConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteAccountAuditConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteAccountAuditConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Deletes a Device Defender audit suppression. - *

- *

Requires permission to access the DeleteAuditSuppression action.

- */ - public deleteAuditSuppression( + + /** + * @see {@link DeleteAuditSuppressionCommand} + */ + deleteAuditSuppression( args: DeleteAuditSuppressionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAuditSuppression( + deleteAuditSuppression( args: DeleteAuditSuppressionCommandInput, cb: (err: any, data?: DeleteAuditSuppressionCommandOutput) => void ): void; - public deleteAuditSuppression( + deleteAuditSuppression( args: DeleteAuditSuppressionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAuditSuppressionCommandOutput) => void ): void; - public deleteAuditSuppression( - args: DeleteAuditSuppressionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAuditSuppressionCommandOutput) => void), - cb?: (err: any, data?: DeleteAuditSuppressionCommandOutput) => void - ): Promise | void { - const command = new DeleteAuditSuppressionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an authorizer.

- *

Requires permission to access the DeleteAuthorizer action.

- */ - public deleteAuthorizer( + + /** + * @see {@link DeleteAuthorizerCommand} + */ + deleteAuthorizer( args: DeleteAuthorizerCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAuthorizer( + deleteAuthorizer( args: DeleteAuthorizerCommandInput, cb: (err: any, data?: DeleteAuthorizerCommandOutput) => void ): void; - public deleteAuthorizer( + deleteAuthorizer( args: DeleteAuthorizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAuthorizerCommandOutput) => void ): void; - public deleteAuthorizer( - args: DeleteAuthorizerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAuthorizerCommandOutput) => void), - cb?: (err: any, data?: DeleteAuthorizerCommandOutput) => void - ): Promise | void { - const command = new DeleteAuthorizerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the billing group.

- *

Requires permission to access the DeleteBillingGroup action.

- */ - public deleteBillingGroup( + + /** + * @see {@link DeleteBillingGroupCommand} + */ + deleteBillingGroup( args: DeleteBillingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBillingGroup( + deleteBillingGroup( args: DeleteBillingGroupCommandInput, cb: (err: any, data?: DeleteBillingGroupCommandOutput) => void ): void; - public deleteBillingGroup( + deleteBillingGroup( args: DeleteBillingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBillingGroupCommandOutput) => void ): void; - public deleteBillingGroup( - args: DeleteBillingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBillingGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteBillingGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteBillingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a registered CA certificate.

- *

Requires permission to access the DeleteCACertificate action.

- */ - public deleteCACertificate( + + /** + * @see {@link DeleteCACertificateCommand} + */ + deleteCACertificate( args: DeleteCACertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCACertificate( + deleteCACertificate( args: DeleteCACertificateCommandInput, cb: (err: any, data?: DeleteCACertificateCommandOutput) => void ): void; - public deleteCACertificate( + deleteCACertificate( args: DeleteCACertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCACertificateCommandOutput) => void ): void; - public deleteCACertificate( - args: DeleteCACertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCACertificateCommandOutput) => void), - cb?: (err: any, data?: DeleteCACertificateCommandOutput) => void - ): Promise | void { - const command = new DeleteCACertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified certificate.

- *

A certificate cannot be deleted if it has a policy or IoT thing attached to it or if - * its status is set to ACTIVE. To delete a certificate, first use the DetachPolicy action to detach all policies. Next, use the UpdateCertificate action to set the certificate to the INACTIVE - * status.

- *

Requires permission to access the DeleteCertificate action.

- */ - public deleteCertificate( + + /** + * @see {@link DeleteCertificateCommand} + */ + deleteCertificate( args: DeleteCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCertificate( + deleteCertificate( args: DeleteCertificateCommandInput, cb: (err: any, data?: DeleteCertificateCommandOutput) => void ): void; - public deleteCertificate( + deleteCertificate( args: DeleteCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCertificateCommandOutput) => void ): void; - public deleteCertificate( - args: DeleteCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCertificateCommandOutput) => void), - cb?: (err: any, data?: DeleteCertificateCommandOutput) => void - ): Promise | void { - const command = new DeleteCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Deletes a Device Defender detect custom metric. - *

- *

Requires permission to access the DeleteCustomMetric action.

- * - *

Before you can delete a custom metric, you must first remove the custom metric from all - * security profiles it's a part of. - * The - * security - * profile associated with the custom metric can be found using the ListSecurityProfiles - * API with metricName set to your custom metric name.

- *
- */ - public deleteCustomMetric( + + /** + * @see {@link DeleteCustomMetricCommand} + */ + deleteCustomMetric( args: DeleteCustomMetricCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCustomMetric( + deleteCustomMetric( args: DeleteCustomMetricCommandInput, cb: (err: any, data?: DeleteCustomMetricCommandOutput) => void ): void; - public deleteCustomMetric( + deleteCustomMetric( args: DeleteCustomMetricCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomMetricCommandOutput) => void ): void; - public deleteCustomMetric( - args: DeleteCustomMetricCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCustomMetricCommandOutput) => void), - cb?: (err: any, data?: DeleteCustomMetricCommandOutput) => void - ): Promise | void { - const command = new DeleteCustomMetricCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the specified dimension from your Amazon Web Services accounts.

- *

Requires permission to access the DeleteDimension action.

- */ - public deleteDimension( + + /** + * @see {@link DeleteDimensionCommand} + */ + deleteDimension( args: DeleteDimensionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDimension( - args: DeleteDimensionCommandInput, - cb: (err: any, data?: DeleteDimensionCommandOutput) => void - ): void; - public deleteDimension( + deleteDimension(args: DeleteDimensionCommandInput, cb: (err: any, data?: DeleteDimensionCommandOutput) => void): void; + deleteDimension( args: DeleteDimensionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDimensionCommandOutput) => void ): void; - public deleteDimension( - args: DeleteDimensionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDimensionCommandOutput) => void), - cb?: (err: any, data?: DeleteDimensionCommandOutput) => void - ): Promise | void { - const command = new DeleteDimensionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified domain configuration.

- *

Requires permission to access the DeleteDomainConfiguration action.

- */ - public deleteDomainConfiguration( + + /** + * @see {@link DeleteDomainConfigurationCommand} + */ + deleteDomainConfiguration( args: DeleteDomainConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDomainConfiguration( + deleteDomainConfiguration( args: DeleteDomainConfigurationCommandInput, cb: (err: any, data?: DeleteDomainConfigurationCommandOutput) => void ): void; - public deleteDomainConfiguration( + deleteDomainConfiguration( args: DeleteDomainConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDomainConfigurationCommandOutput) => void ): void; - public deleteDomainConfiguration( - args: DeleteDomainConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDomainConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteDomainConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteDomainConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a dynamic thing group.

- *

Requires permission to access the DeleteDynamicThingGroup action.

- */ - public deleteDynamicThingGroup( + + /** + * @see {@link DeleteDynamicThingGroupCommand} + */ + deleteDynamicThingGroup( args: DeleteDynamicThingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDynamicThingGroup( + deleteDynamicThingGroup( args: DeleteDynamicThingGroupCommandInput, cb: (err: any, data?: DeleteDynamicThingGroupCommandOutput) => void ): void; - public deleteDynamicThingGroup( + deleteDynamicThingGroup( args: DeleteDynamicThingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDynamicThingGroupCommandOutput) => void ): void; - public deleteDynamicThingGroup( - args: DeleteDynamicThingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDynamicThingGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteDynamicThingGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteDynamicThingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified fleet metric. - * Returns successfully with no error if the deletion is successful or you specify a fleet metric that doesn't exist.

- *

Requires permission to access the DeleteFleetMetric action.

- */ - public deleteFleetMetric( + + /** + * @see {@link DeleteFleetMetricCommand} + */ + deleteFleetMetric( args: DeleteFleetMetricCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFleetMetric( + deleteFleetMetric( args: DeleteFleetMetricCommandInput, cb: (err: any, data?: DeleteFleetMetricCommandOutput) => void ): void; - public deleteFleetMetric( + deleteFleetMetric( args: DeleteFleetMetricCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFleetMetricCommandOutput) => void ): void; - public deleteFleetMetric( - args: DeleteFleetMetricCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFleetMetricCommandOutput) => void), - cb?: (err: any, data?: DeleteFleetMetricCommandOutput) => void - ): Promise | void { - const command = new DeleteFleetMetricCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a job and its related job executions.

- *

Deleting a job may take time, depending on the number of job - * executions created for the job and various other factors. While the job - * is being deleted, the status of the job will be shown as - * "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status - * is already "DELETION_IN_PROGRESS" will result in an error.

- *

Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or - * a LimitExceededException will occur.

- *

Requires permission to access the DeleteJob action.

- */ - public deleteJob(args: DeleteJobCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteJob(args: DeleteJobCommandInput, cb: (err: any, data?: DeleteJobCommandOutput) => void): void; - public deleteJob( + + /** + * @see {@link DeleteJobCommand} + */ + deleteJob(args: DeleteJobCommandInput, options?: __HttpHandlerOptions): Promise; + deleteJob(args: DeleteJobCommandInput, cb: (err: any, data?: DeleteJobCommandOutput) => void): void; + deleteJob( args: DeleteJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteJobCommandOutput) => void ): void; - public deleteJob( - args: DeleteJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteJobCommandOutput) => void), - cb?: (err: any, data?: DeleteJobCommandOutput) => void - ): Promise | void { - const command = new DeleteJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a job execution.

- *

Requires permission to access the DeleteJobExecution action.

- */ - public deleteJobExecution( + + /** + * @see {@link DeleteJobExecutionCommand} + */ + deleteJobExecution( args: DeleteJobExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteJobExecution( + deleteJobExecution( args: DeleteJobExecutionCommandInput, cb: (err: any, data?: DeleteJobExecutionCommandOutput) => void ): void; - public deleteJobExecution( + deleteJobExecution( args: DeleteJobExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteJobExecutionCommandOutput) => void ): void; - public deleteJobExecution( - args: DeleteJobExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteJobExecutionCommandOutput) => void), - cb?: (err: any, data?: DeleteJobExecutionCommandOutput) => void - ): Promise | void { - const command = new DeleteJobExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified job template.

- */ - public deleteJobTemplate( + + /** + * @see {@link DeleteJobTemplateCommand} + */ + deleteJobTemplate( args: DeleteJobTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteJobTemplate( + deleteJobTemplate( args: DeleteJobTemplateCommandInput, cb: (err: any, data?: DeleteJobTemplateCommandOutput) => void ): void; - public deleteJobTemplate( + deleteJobTemplate( args: DeleteJobTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteJobTemplateCommandOutput) => void ): void; - public deleteJobTemplate( - args: DeleteJobTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteJobTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteJobTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteJobTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a defined mitigation action from your Amazon Web Services accounts.

- *

Requires permission to access the DeleteMitigationAction action.

- */ - public deleteMitigationAction( + + /** + * @see {@link DeleteMitigationActionCommand} + */ + deleteMitigationAction( args: DeleteMitigationActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMitigationAction( + deleteMitigationAction( args: DeleteMitigationActionCommandInput, cb: (err: any, data?: DeleteMitigationActionCommandOutput) => void ): void; - public deleteMitigationAction( + deleteMitigationAction( args: DeleteMitigationActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMitigationActionCommandOutput) => void ): void; - public deleteMitigationAction( - args: DeleteMitigationActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMitigationActionCommandOutput) => void), - cb?: (err: any, data?: DeleteMitigationActionCommandOutput) => void - ): Promise | void { - const command = new DeleteMitigationActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete an OTA update.

- *

Requires permission to access the DeleteOTAUpdate action.

- */ - public deleteOTAUpdate( + + /** + * @see {@link DeleteOTAUpdateCommand} + */ + deleteOTAUpdate( args: DeleteOTAUpdateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteOTAUpdate( - args: DeleteOTAUpdateCommandInput, - cb: (err: any, data?: DeleteOTAUpdateCommandOutput) => void - ): void; - public deleteOTAUpdate( + deleteOTAUpdate(args: DeleteOTAUpdateCommandInput, cb: (err: any, data?: DeleteOTAUpdateCommandOutput) => void): void; + deleteOTAUpdate( args: DeleteOTAUpdateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOTAUpdateCommandOutput) => void ): void; - public deleteOTAUpdate( - args: DeleteOTAUpdateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteOTAUpdateCommandOutput) => void), - cb?: (err: any, data?: DeleteOTAUpdateCommandOutput) => void - ): Promise | void { - const command = new DeleteOTAUpdateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified policy.

- *

A policy cannot be deleted if it has non-default versions or it is attached to any - * certificate.

- *

To delete a policy, use the DeletePolicyVersion action to delete all non-default - * versions of the policy; use the DetachPolicy action to detach the policy from any - * certificate; and then use the DeletePolicy action to delete the policy.

- *

When a policy is deleted using DeletePolicy, its default version is deleted with - * it.

- * - *

Because of the distributed nature of Amazon Web Services, it can take up to five minutes after - * a policy is detached before it's ready to be deleted.

- *
- *

Requires permission to access the DeletePolicy action.

- */ - public deletePolicy( - args: DeletePolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deletePolicy(args: DeletePolicyCommandInput, cb: (err: any, data?: DeletePolicyCommandOutput) => void): void; - public deletePolicy( + + /** + * @see {@link DeletePolicyCommand} + */ + deletePolicy(args: DeletePolicyCommandInput, options?: __HttpHandlerOptions): Promise; + deletePolicy(args: DeletePolicyCommandInput, cb: (err: any, data?: DeletePolicyCommandOutput) => void): void; + deletePolicy( args: DeletePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePolicyCommandOutput) => void ): void; - public deletePolicy( - args: DeletePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePolicyCommandOutput) => void), - cb?: (err: any, data?: DeletePolicyCommandOutput) => void - ): Promise | void { - const command = new DeletePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified version of the specified policy. You cannot delete the default - * version of a policy using this action. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default - * version, use ListPolicyVersions.

- *

Requires permission to access the DeletePolicyVersion action.

- */ - public deletePolicyVersion( + + /** + * @see {@link DeletePolicyVersionCommand} + */ + deletePolicyVersion( args: DeletePolicyVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePolicyVersion( + deletePolicyVersion( args: DeletePolicyVersionCommandInput, cb: (err: any, data?: DeletePolicyVersionCommandOutput) => void ): void; - public deletePolicyVersion( + deletePolicyVersion( args: DeletePolicyVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePolicyVersionCommandOutput) => void ): void; - public deletePolicyVersion( - args: DeletePolicyVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePolicyVersionCommandOutput) => void), - cb?: (err: any, data?: DeletePolicyVersionCommandOutput) => void - ): Promise | void { - const command = new DeletePolicyVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a provisioning template.

- *

Requires permission to access the DeleteProvisioningTemplate action.

- */ - public deleteProvisioningTemplate( + + /** + * @see {@link DeleteProvisioningTemplateCommand} + */ + deleteProvisioningTemplate( args: DeleteProvisioningTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteProvisioningTemplate( + deleteProvisioningTemplate( args: DeleteProvisioningTemplateCommandInput, cb: (err: any, data?: DeleteProvisioningTemplateCommandOutput) => void ): void; - public deleteProvisioningTemplate( + deleteProvisioningTemplate( args: DeleteProvisioningTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProvisioningTemplateCommandOutput) => void ): void; - public deleteProvisioningTemplate( - args: DeleteProvisioningTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProvisioningTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteProvisioningTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteProvisioningTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a provisioning template version.

- *

Requires permission to access the DeleteProvisioningTemplateVersion action.

- */ - public deleteProvisioningTemplateVersion( + + /** + * @see {@link DeleteProvisioningTemplateVersionCommand} + */ + deleteProvisioningTemplateVersion( args: DeleteProvisioningTemplateVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteProvisioningTemplateVersion( + deleteProvisioningTemplateVersion( args: DeleteProvisioningTemplateVersionCommandInput, cb: (err: any, data?: DeleteProvisioningTemplateVersionCommandOutput) => void ): void; - public deleteProvisioningTemplateVersion( + deleteProvisioningTemplateVersion( args: DeleteProvisioningTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProvisioningTemplateVersionCommandOutput) => void ): void; - public deleteProvisioningTemplateVersion( - args: DeleteProvisioningTemplateVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProvisioningTemplateVersionCommandOutput) => void), - cb?: (err: any, data?: DeleteProvisioningTemplateVersionCommandOutput) => void - ): Promise | void { - const command = new DeleteProvisioningTemplateVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a CA certificate registration code.

- *

Requires permission to access the DeleteRegistrationCode action.

- */ - public deleteRegistrationCode( + + /** + * @see {@link DeleteRegistrationCodeCommand} + */ + deleteRegistrationCode( args: DeleteRegistrationCodeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRegistrationCode( + deleteRegistrationCode( args: DeleteRegistrationCodeCommandInput, cb: (err: any, data?: DeleteRegistrationCodeCommandOutput) => void ): void; - public deleteRegistrationCode( + deleteRegistrationCode( args: DeleteRegistrationCodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRegistrationCodeCommandOutput) => void ): void; - public deleteRegistrationCode( - args: DeleteRegistrationCodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRegistrationCodeCommandOutput) => void), - cb?: (err: any, data?: DeleteRegistrationCodeCommandOutput) => void - ): Promise | void { - const command = new DeleteRegistrationCodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a role alias

- *

Requires permission to access the DeleteRoleAlias action.

- */ - public deleteRoleAlias( + + /** + * @see {@link DeleteRoleAliasCommand} + */ + deleteRoleAlias( args: DeleteRoleAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRoleAlias( - args: DeleteRoleAliasCommandInput, - cb: (err: any, data?: DeleteRoleAliasCommandOutput) => void - ): void; - public deleteRoleAlias( + deleteRoleAlias(args: DeleteRoleAliasCommandInput, cb: (err: any, data?: DeleteRoleAliasCommandOutput) => void): void; + deleteRoleAlias( args: DeleteRoleAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRoleAliasCommandOutput) => void ): void; - public deleteRoleAlias( - args: DeleteRoleAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRoleAliasCommandOutput) => void), - cb?: (err: any, data?: DeleteRoleAliasCommandOutput) => void - ): Promise | void { - const command = new DeleteRoleAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a scheduled audit.

- *

Requires permission to access the DeleteScheduledAudit action.

- */ - public deleteScheduledAudit( + + /** + * @see {@link DeleteScheduledAuditCommand} + */ + deleteScheduledAudit( args: DeleteScheduledAuditCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteScheduledAudit( + deleteScheduledAudit( args: DeleteScheduledAuditCommandInput, cb: (err: any, data?: DeleteScheduledAuditCommandOutput) => void ): void; - public deleteScheduledAudit( + deleteScheduledAudit( args: DeleteScheduledAuditCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteScheduledAuditCommandOutput) => void ): void; - public deleteScheduledAudit( - args: DeleteScheduledAuditCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteScheduledAuditCommandOutput) => void), - cb?: (err: any, data?: DeleteScheduledAuditCommandOutput) => void - ): Promise | void { - const command = new DeleteScheduledAuditCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a Device Defender security profile.

- *

Requires permission to access the DeleteSecurityProfile action.

- */ - public deleteSecurityProfile( + + /** + * @see {@link DeleteSecurityProfileCommand} + */ + deleteSecurityProfile( args: DeleteSecurityProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSecurityProfile( + deleteSecurityProfile( args: DeleteSecurityProfileCommandInput, cb: (err: any, data?: DeleteSecurityProfileCommandOutput) => void ): void; - public deleteSecurityProfile( + deleteSecurityProfile( args: DeleteSecurityProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSecurityProfileCommandOutput) => void ): void; - public deleteSecurityProfile( - args: DeleteSecurityProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSecurityProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteSecurityProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteSecurityProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a stream.

- *

Requires permission to access the DeleteStream action.

- */ - public deleteStream( - args: DeleteStreamCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteStream(args: DeleteStreamCommandInput, cb: (err: any, data?: DeleteStreamCommandOutput) => void): void; - public deleteStream( + + /** + * @see {@link DeleteStreamCommand} + */ + deleteStream(args: DeleteStreamCommandInput, options?: __HttpHandlerOptions): Promise; + deleteStream(args: DeleteStreamCommandInput, cb: (err: any, data?: DeleteStreamCommandOutput) => void): void; + deleteStream( args: DeleteStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStreamCommandOutput) => void ): void; - public deleteStream( - args: DeleteStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStreamCommandOutput) => void), - cb?: (err: any, data?: DeleteStreamCommandOutput) => void - ): Promise | void { - const command = new DeleteStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified thing. Returns successfully with no error if the deletion is - * successful or you specify a thing that doesn't exist.

- *

Requires permission to access the DeleteThing action.

- */ - public deleteThing(args: DeleteThingCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteThing(args: DeleteThingCommandInput, cb: (err: any, data?: DeleteThingCommandOutput) => void): void; - public deleteThing( + + /** + * @see {@link DeleteThingCommand} + */ + deleteThing(args: DeleteThingCommandInput, options?: __HttpHandlerOptions): Promise; + deleteThing(args: DeleteThingCommandInput, cb: (err: any, data?: DeleteThingCommandOutput) => void): void; + deleteThing( args: DeleteThingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteThingCommandOutput) => void ): void; - public deleteThing( - args: DeleteThingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteThingCommandOutput) => void), - cb?: (err: any, data?: DeleteThingCommandOutput) => void - ): Promise | void { - const command = new DeleteThingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a thing group.

- *

Requires permission to access the DeleteThingGroup action.

- */ - public deleteThingGroup( + + /** + * @see {@link DeleteThingGroupCommand} + */ + deleteThingGroup( args: DeleteThingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteThingGroup( + deleteThingGroup( args: DeleteThingGroupCommandInput, cb: (err: any, data?: DeleteThingGroupCommandOutput) => void ): void; - public deleteThingGroup( + deleteThingGroup( args: DeleteThingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteThingGroupCommandOutput) => void ): void; - public deleteThingGroup( - args: DeleteThingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteThingGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteThingGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteThingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified thing type. You cannot delete a thing type if it has things - * associated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and - * finally use DeleteThingType to delete the thing type.

- *

Requires permission to access the DeleteThingType action.

- */ - public deleteThingType( + + /** + * @see {@link DeleteThingTypeCommand} + */ + deleteThingType( args: DeleteThingTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteThingType( - args: DeleteThingTypeCommandInput, - cb: (err: any, data?: DeleteThingTypeCommandOutput) => void - ): void; - public deleteThingType( + deleteThingType(args: DeleteThingTypeCommandInput, cb: (err: any, data?: DeleteThingTypeCommandOutput) => void): void; + deleteThingType( args: DeleteThingTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteThingTypeCommandOutput) => void ): void; - public deleteThingType( - args: DeleteThingTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteThingTypeCommandOutput) => void), - cb?: (err: any, data?: DeleteThingTypeCommandOutput) => void - ): Promise | void { - const command = new DeleteThingTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the rule.

- *

Requires permission to access the DeleteTopicRule action.

- */ - public deleteTopicRule( + + /** + * @see {@link DeleteTopicRuleCommand} + */ + deleteTopicRule( args: DeleteTopicRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTopicRule( - args: DeleteTopicRuleCommandInput, - cb: (err: any, data?: DeleteTopicRuleCommandOutput) => void - ): void; - public deleteTopicRule( + deleteTopicRule(args: DeleteTopicRuleCommandInput, cb: (err: any, data?: DeleteTopicRuleCommandOutput) => void): void; + deleteTopicRule( args: DeleteTopicRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTopicRuleCommandOutput) => void ): void; - public deleteTopicRule( - args: DeleteTopicRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTopicRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteTopicRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteTopicRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a topic rule destination.

- *

Requires permission to access the DeleteTopicRuleDestination action.

- */ - public deleteTopicRuleDestination( + + /** + * @see {@link DeleteTopicRuleDestinationCommand} + */ + deleteTopicRuleDestination( args: DeleteTopicRuleDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTopicRuleDestination( + deleteTopicRuleDestination( args: DeleteTopicRuleDestinationCommandInput, cb: (err: any, data?: DeleteTopicRuleDestinationCommandOutput) => void ): void; - public deleteTopicRuleDestination( + deleteTopicRuleDestination( args: DeleteTopicRuleDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTopicRuleDestinationCommandOutput) => void ): void; - public deleteTopicRuleDestination( - args: DeleteTopicRuleDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTopicRuleDestinationCommandOutput) => void), - cb?: (err: any, data?: DeleteTopicRuleDestinationCommandOutput) => void - ): Promise | void { - const command = new DeleteTopicRuleDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a logging level.

- *

Requires permission to access the DeleteV2LoggingLevel action.

- */ - public deleteV2LoggingLevel( + + /** + * @see {@link DeleteV2LoggingLevelCommand} + */ + deleteV2LoggingLevel( args: DeleteV2LoggingLevelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteV2LoggingLevel( + deleteV2LoggingLevel( args: DeleteV2LoggingLevelCommandInput, cb: (err: any, data?: DeleteV2LoggingLevelCommandOutput) => void ): void; - public deleteV2LoggingLevel( + deleteV2LoggingLevel( args: DeleteV2LoggingLevelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteV2LoggingLevelCommandOutput) => void ): void; - public deleteV2LoggingLevel( - args: DeleteV2LoggingLevelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteV2LoggingLevelCommandOutput) => void), - cb?: (err: any, data?: DeleteV2LoggingLevelCommandOutput) => void - ): Promise | void { - const command = new DeleteV2LoggingLevelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deprecates a thing type. You can not associate new things with deprecated thing - * type.

- *

Requires permission to access the DeprecateThingType action.

- */ - public deprecateThingType( + + /** + * @see {@link DeprecateThingTypeCommand} + */ + deprecateThingType( args: DeprecateThingTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deprecateThingType( + deprecateThingType( args: DeprecateThingTypeCommandInput, cb: (err: any, data?: DeprecateThingTypeCommandOutput) => void ): void; - public deprecateThingType( + deprecateThingType( args: DeprecateThingTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeprecateThingTypeCommandOutput) => void ): void; - public deprecateThingType( - args: DeprecateThingTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeprecateThingTypeCommandOutput) => void), - cb?: (err: any, data?: DeprecateThingTypeCommandOutput) => void - ): Promise | void { - const command = new DeprecateThingTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the Device Defender audit settings for this account. - * Settings include how audit notifications are sent and which audit checks are - * enabled or disabled.

- *

Requires permission to access the DescribeAccountAuditConfiguration action.

- */ - public describeAccountAuditConfiguration( + + /** + * @see {@link DescribeAccountAuditConfigurationCommand} + */ + describeAccountAuditConfiguration( args: DescribeAccountAuditConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccountAuditConfiguration( + describeAccountAuditConfiguration( args: DescribeAccountAuditConfigurationCommandInput, cb: (err: any, data?: DescribeAccountAuditConfigurationCommandOutput) => void ): void; - public describeAccountAuditConfiguration( + describeAccountAuditConfiguration( args: DescribeAccountAuditConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountAuditConfigurationCommandOutput) => void ): void; - public describeAccountAuditConfiguration( - args: DescribeAccountAuditConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccountAuditConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountAuditConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountAuditConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a single audit finding. Properties include the reason for - * noncompliance, the severity of the issue, - * and the start time - * when the audit that returned the - * finding.

- *

Requires permission to access the DescribeAuditFinding action.

- */ - public describeAuditFinding( + + /** + * @see {@link DescribeAuditFindingCommand} + */ + describeAuditFinding( args: DescribeAuditFindingCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAuditFinding( + describeAuditFinding( args: DescribeAuditFindingCommandInput, cb: (err: any, data?: DescribeAuditFindingCommandOutput) => void ): void; - public describeAuditFinding( + describeAuditFinding( args: DescribeAuditFindingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAuditFindingCommandOutput) => void ): void; - public describeAuditFinding( - args: DescribeAuditFindingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAuditFindingCommandOutput) => void), - cb?: (err: any, data?: DescribeAuditFindingCommandOutput) => void - ): Promise | void { - const command = new DescribeAuditFindingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.

- */ - public describeAuditMitigationActionsTask( + + /** + * @see {@link DescribeAuditMitigationActionsTaskCommand} + */ + describeAuditMitigationActionsTask( args: DescribeAuditMitigationActionsTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAuditMitigationActionsTask( + describeAuditMitigationActionsTask( args: DescribeAuditMitigationActionsTaskCommandInput, cb: (err: any, data?: DescribeAuditMitigationActionsTaskCommandOutput) => void ): void; - public describeAuditMitigationActionsTask( + describeAuditMitigationActionsTask( args: DescribeAuditMitigationActionsTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAuditMitigationActionsTaskCommandOutput) => void ): void; - public describeAuditMitigationActionsTask( - args: DescribeAuditMitigationActionsTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAuditMitigationActionsTaskCommandOutput) => void), - cb?: (err: any, data?: DescribeAuditMitigationActionsTaskCommandOutput) => void - ): Promise | void { - const command = new DescribeAuditMitigationActionsTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Gets information about a Device Defender audit suppression. - *

- */ - public describeAuditSuppression( + + /** + * @see {@link DescribeAuditSuppressionCommand} + */ + describeAuditSuppression( args: DescribeAuditSuppressionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAuditSuppression( + describeAuditSuppression( args: DescribeAuditSuppressionCommandInput, cb: (err: any, data?: DescribeAuditSuppressionCommandOutput) => void ): void; - public describeAuditSuppression( + describeAuditSuppression( args: DescribeAuditSuppressionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAuditSuppressionCommandOutput) => void ): void; - public describeAuditSuppression( - args: DescribeAuditSuppressionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAuditSuppressionCommandOutput) => void), - cb?: (err: any, data?: DescribeAuditSuppressionCommandOutput) => void - ): Promise | void { - const command = new DescribeAuditSuppressionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a Device Defender audit.

- *

Requires permission to access the DescribeAuditTask action.

- */ - public describeAuditTask( + + /** + * @see {@link DescribeAuditTaskCommand} + */ + describeAuditTask( args: DescribeAuditTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAuditTask( + describeAuditTask( args: DescribeAuditTaskCommandInput, cb: (err: any, data?: DescribeAuditTaskCommandOutput) => void ): void; - public describeAuditTask( + describeAuditTask( args: DescribeAuditTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAuditTaskCommandOutput) => void ): void; - public describeAuditTask( - args: DescribeAuditTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAuditTaskCommandOutput) => void), - cb?: (err: any, data?: DescribeAuditTaskCommandOutput) => void - ): Promise | void { - const command = new DescribeAuditTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes an authorizer.

- *

Requires permission to access the DescribeAuthorizer action.

- */ - public describeAuthorizer( + + /** + * @see {@link DescribeAuthorizerCommand} + */ + describeAuthorizer( args: DescribeAuthorizerCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAuthorizer( + describeAuthorizer( args: DescribeAuthorizerCommandInput, cb: (err: any, data?: DescribeAuthorizerCommandOutput) => void ): void; - public describeAuthorizer( + describeAuthorizer( args: DescribeAuthorizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAuthorizerCommandOutput) => void ): void; - public describeAuthorizer( - args: DescribeAuthorizerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAuthorizerCommandOutput) => void), - cb?: (err: any, data?: DescribeAuthorizerCommandOutput) => void - ): Promise | void { - const command = new DescribeAuthorizerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a billing group.

- *

Requires permission to access the DescribeBillingGroup action.

- */ - public describeBillingGroup( + + /** + * @see {@link DescribeBillingGroupCommand} + */ + describeBillingGroup( args: DescribeBillingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBillingGroup( + describeBillingGroup( args: DescribeBillingGroupCommandInput, cb: (err: any, data?: DescribeBillingGroupCommandOutput) => void ): void; - public describeBillingGroup( + describeBillingGroup( args: DescribeBillingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBillingGroupCommandOutput) => void ): void; - public describeBillingGroup( - args: DescribeBillingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBillingGroupCommandOutput) => void), - cb?: (err: any, data?: DescribeBillingGroupCommandOutput) => void - ): Promise | void { - const command = new DescribeBillingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a registered CA certificate.

- *

Requires permission to access the DescribeCACertificate action.

- */ - public describeCACertificate( + + /** + * @see {@link DescribeCACertificateCommand} + */ + describeCACertificate( args: DescribeCACertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCACertificate( + describeCACertificate( args: DescribeCACertificateCommandInput, cb: (err: any, data?: DescribeCACertificateCommandOutput) => void ): void; - public describeCACertificate( + describeCACertificate( args: DescribeCACertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCACertificateCommandOutput) => void ): void; - public describeCACertificate( - args: DescribeCACertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCACertificateCommandOutput) => void), - cb?: (err: any, data?: DescribeCACertificateCommandOutput) => void - ): Promise | void { - const command = new DescribeCACertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the specified certificate.

- *

Requires permission to access the DescribeCertificate action.

- */ - public describeCertificate( + + /** + * @see {@link DescribeCertificateCommand} + */ + describeCertificate( args: DescribeCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCertificate( + describeCertificate( args: DescribeCertificateCommandInput, cb: (err: any, data?: DescribeCertificateCommandOutput) => void ): void; - public describeCertificate( + describeCertificate( args: DescribeCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCertificateCommandOutput) => void ): void; - public describeCertificate( - args: DescribeCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCertificateCommandOutput) => void), - cb?: (err: any, data?: DescribeCertificateCommandOutput) => void - ): Promise | void { - const command = new DescribeCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Gets information about a Device Defender detect custom metric. - *

- *

Requires permission to access the DescribeCustomMetric action.

- */ - public describeCustomMetric( + + /** + * @see {@link DescribeCustomMetricCommand} + */ + describeCustomMetric( args: DescribeCustomMetricCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCustomMetric( + describeCustomMetric( args: DescribeCustomMetricCommandInput, cb: (err: any, data?: DescribeCustomMetricCommandOutput) => void ): void; - public describeCustomMetric( + describeCustomMetric( args: DescribeCustomMetricCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCustomMetricCommandOutput) => void ): void; - public describeCustomMetric( - args: DescribeCustomMetricCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCustomMetricCommandOutput) => void), - cb?: (err: any, data?: DescribeCustomMetricCommandOutput) => void - ): Promise | void { - const command = new DescribeCustomMetricCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the default authorizer.

- *

Requires permission to access the DescribeDefaultAuthorizer action.

- */ - public describeDefaultAuthorizer( + + /** + * @see {@link DescribeDefaultAuthorizerCommand} + */ + describeDefaultAuthorizer( args: DescribeDefaultAuthorizerCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDefaultAuthorizer( + describeDefaultAuthorizer( args: DescribeDefaultAuthorizerCommandInput, cb: (err: any, data?: DescribeDefaultAuthorizerCommandOutput) => void ): void; - public describeDefaultAuthorizer( + describeDefaultAuthorizer( args: DescribeDefaultAuthorizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDefaultAuthorizerCommandOutput) => void ): void; - public describeDefaultAuthorizer( - args: DescribeDefaultAuthorizerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDefaultAuthorizerCommandOutput) => void), - cb?: (err: any, data?: DescribeDefaultAuthorizerCommandOutput) => void - ): Promise | void { - const command = new DescribeDefaultAuthorizerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Gets information about a Device Defender ML Detect mitigation action. - *

- *

Requires permission to access the DescribeDetectMitigationActionsTask action.

- */ - public describeDetectMitigationActionsTask( + + /** + * @see {@link DescribeDetectMitigationActionsTaskCommand} + */ + describeDetectMitigationActionsTask( args: DescribeDetectMitigationActionsTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDetectMitigationActionsTask( + describeDetectMitigationActionsTask( args: DescribeDetectMitigationActionsTaskCommandInput, cb: (err: any, data?: DescribeDetectMitigationActionsTaskCommandOutput) => void ): void; - public describeDetectMitigationActionsTask( + describeDetectMitigationActionsTask( args: DescribeDetectMitigationActionsTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDetectMitigationActionsTaskCommandOutput) => void ): void; - public describeDetectMitigationActionsTask( - args: DescribeDetectMitigationActionsTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDetectMitigationActionsTaskCommandOutput) => void), - cb?: (err: any, data?: DescribeDetectMitigationActionsTaskCommandOutput) => void - ): Promise | void { - const command = new DescribeDetectMitigationActionsTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides details about a dimension that is defined in your Amazon Web Services accounts.

- *

Requires permission to access the DescribeDimension action.

- */ - public describeDimension( + + /** + * @see {@link DescribeDimensionCommand} + */ + describeDimension( args: DescribeDimensionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDimension( + describeDimension( args: DescribeDimensionCommandInput, cb: (err: any, data?: DescribeDimensionCommandOutput) => void ): void; - public describeDimension( + describeDimension( args: DescribeDimensionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDimensionCommandOutput) => void ): void; - public describeDimension( - args: DescribeDimensionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDimensionCommandOutput) => void), - cb?: (err: any, data?: DescribeDimensionCommandOutput) => void - ): Promise | void { - const command = new DescribeDimensionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets summary information about a domain configuration.

- *

Requires permission to access the DescribeDomainConfiguration action.

- */ - public describeDomainConfiguration( + + /** + * @see {@link DescribeDomainConfigurationCommand} + */ + describeDomainConfiguration( args: DescribeDomainConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDomainConfiguration( + describeDomainConfiguration( args: DescribeDomainConfigurationCommandInput, cb: (err: any, data?: DescribeDomainConfigurationCommandOutput) => void ): void; - public describeDomainConfiguration( + describeDomainConfiguration( args: DescribeDomainConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDomainConfigurationCommandOutput) => void ): void; - public describeDomainConfiguration( - args: DescribeDomainConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDomainConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeDomainConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeDomainConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a unique endpoint specific to the Amazon Web Services account making the call.

- *

Requires permission to access the DescribeEndpoint action.

- */ - public describeEndpoint( + + /** + * @see {@link DescribeEndpointCommand} + */ + describeEndpoint( args: DescribeEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEndpoint( + describeEndpoint( args: DescribeEndpointCommandInput, cb: (err: any, data?: DescribeEndpointCommandOutput) => void ): void; - public describeEndpoint( + describeEndpoint( args: DescribeEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEndpointCommandOutput) => void ): void; - public describeEndpoint( - args: DescribeEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEndpointCommandOutput) => void), - cb?: (err: any, data?: DescribeEndpointCommandOutput) => void - ): Promise | void { - const command = new DescribeEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes event configurations.

- *

Requires permission to access the DescribeEventConfigurations action.

- */ - public describeEventConfigurations( + + /** + * @see {@link DescribeEventConfigurationsCommand} + */ + describeEventConfigurations( args: DescribeEventConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventConfigurations( + describeEventConfigurations( args: DescribeEventConfigurationsCommandInput, cb: (err: any, data?: DescribeEventConfigurationsCommandOutput) => void ): void; - public describeEventConfigurations( + describeEventConfigurations( args: DescribeEventConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventConfigurationsCommandOutput) => void ): void; - public describeEventConfigurations( - args: DescribeEventConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventConfigurationsCommandOutput) => void), - cb?: (err: any, data?: DescribeEventConfigurationsCommandOutput) => void - ): Promise | void { - const command = new DescribeEventConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the specified fleet metric.

- *

Requires permission to access the DescribeFleetMetric action.

- */ - public describeFleetMetric( + + /** + * @see {@link DescribeFleetMetricCommand} + */ + describeFleetMetric( args: DescribeFleetMetricCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFleetMetric( + describeFleetMetric( args: DescribeFleetMetricCommandInput, cb: (err: any, data?: DescribeFleetMetricCommandOutput) => void ): void; - public describeFleetMetric( + describeFleetMetric( args: DescribeFleetMetricCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetMetricCommandOutput) => void ): void; - public describeFleetMetric( - args: DescribeFleetMetricCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFleetMetricCommandOutput) => void), - cb?: (err: any, data?: DescribeFleetMetricCommandOutput) => void - ): Promise | void { - const command = new DescribeFleetMetricCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a search index.

- *

Requires permission to access the DescribeIndex action.

- */ - public describeIndex( - args: DescribeIndexCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeIndex( - args: DescribeIndexCommandInput, - cb: (err: any, data?: DescribeIndexCommandOutput) => void - ): void; - public describeIndex( + + /** + * @see {@link DescribeIndexCommand} + */ + describeIndex(args: DescribeIndexCommandInput, options?: __HttpHandlerOptions): Promise; + describeIndex(args: DescribeIndexCommandInput, cb: (err: any, data?: DescribeIndexCommandOutput) => void): void; + describeIndex( args: DescribeIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIndexCommandOutput) => void ): void; - public describeIndex( - args: DescribeIndexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeIndexCommandOutput) => void), - cb?: (err: any, data?: DescribeIndexCommandOutput) => void - ): Promise | void { - const command = new DescribeIndexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a job.

- *

Requires permission to access the DescribeJob action.

- */ - public describeJob(args: DescribeJobCommandInput, options?: __HttpHandlerOptions): Promise; - public describeJob(args: DescribeJobCommandInput, cb: (err: any, data?: DescribeJobCommandOutput) => void): void; - public describeJob( + + /** + * @see {@link DescribeJobCommand} + */ + describeJob(args: DescribeJobCommandInput, options?: __HttpHandlerOptions): Promise; + describeJob(args: DescribeJobCommandInput, cb: (err: any, data?: DescribeJobCommandOutput) => void): void; + describeJob( args: DescribeJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobCommandOutput) => void ): void; - public describeJob( - args: DescribeJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeJobCommandOutput) => void), - cb?: (err: any, data?: DescribeJobCommandOutput) => void - ): Promise | void { - const command = new DescribeJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a job execution.

- *

Requires permission to access the DescribeJobExecution action.

- */ - public describeJobExecution( + + /** + * @see {@link DescribeJobExecutionCommand} + */ + describeJobExecution( args: DescribeJobExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeJobExecution( + describeJobExecution( args: DescribeJobExecutionCommandInput, cb: (err: any, data?: DescribeJobExecutionCommandOutput) => void ): void; - public describeJobExecution( + describeJobExecution( args: DescribeJobExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobExecutionCommandOutput) => void ): void; - public describeJobExecution( - args: DescribeJobExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeJobExecutionCommandOutput) => void), - cb?: (err: any, data?: DescribeJobExecutionCommandOutput) => void - ): Promise | void { - const command = new DescribeJobExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a job template.

- */ - public describeJobTemplate( + + /** + * @see {@link DescribeJobTemplateCommand} + */ + describeJobTemplate( args: DescribeJobTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeJobTemplate( + describeJobTemplate( args: DescribeJobTemplateCommandInput, cb: (err: any, data?: DescribeJobTemplateCommandOutput) => void ): void; - public describeJobTemplate( + describeJobTemplate( args: DescribeJobTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobTemplateCommandOutput) => void ): void; - public describeJobTemplate( - args: DescribeJobTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeJobTemplateCommandOutput) => void), - cb?: (err: any, data?: DescribeJobTemplateCommandOutput) => void - ): Promise | void { - const command = new DescribeJobTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

View details of a managed job template.

- */ - public describeManagedJobTemplate( + + /** + * @see {@link DescribeManagedJobTemplateCommand} + */ + describeManagedJobTemplate( args: DescribeManagedJobTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeManagedJobTemplate( + describeManagedJobTemplate( args: DescribeManagedJobTemplateCommandInput, cb: (err: any, data?: DescribeManagedJobTemplateCommandOutput) => void ): void; - public describeManagedJobTemplate( + describeManagedJobTemplate( args: DescribeManagedJobTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeManagedJobTemplateCommandOutput) => void ): void; - public describeManagedJobTemplate( - args: DescribeManagedJobTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeManagedJobTemplateCommandOutput) => void), - cb?: (err: any, data?: DescribeManagedJobTemplateCommandOutput) => void - ): Promise | void { - const command = new DescribeManagedJobTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a mitigation action.

- *

Requires permission to access the DescribeMitigationAction action.

- */ - public describeMitigationAction( + + /** + * @see {@link DescribeMitigationActionCommand} + */ + describeMitigationAction( args: DescribeMitigationActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMitigationAction( + describeMitigationAction( args: DescribeMitigationActionCommandInput, cb: (err: any, data?: DescribeMitigationActionCommandOutput) => void ): void; - public describeMitigationAction( + describeMitigationAction( args: DescribeMitigationActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMitigationActionCommandOutput) => void ): void; - public describeMitigationAction( - args: DescribeMitigationActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMitigationActionCommandOutput) => void), - cb?: (err: any, data?: DescribeMitigationActionCommandOutput) => void - ): Promise | void { - const command = new DescribeMitigationActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a provisioning template.

- *

Requires permission to access the DescribeProvisioningTemplate action.

- */ - public describeProvisioningTemplate( + + /** + * @see {@link DescribeProvisioningTemplateCommand} + */ + describeProvisioningTemplate( args: DescribeProvisioningTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProvisioningTemplate( + describeProvisioningTemplate( args: DescribeProvisioningTemplateCommandInput, cb: (err: any, data?: DescribeProvisioningTemplateCommandOutput) => void ): void; - public describeProvisioningTemplate( + describeProvisioningTemplate( args: DescribeProvisioningTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProvisioningTemplateCommandOutput) => void ): void; - public describeProvisioningTemplate( - args: DescribeProvisioningTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProvisioningTemplateCommandOutput) => void), - cb?: (err: any, data?: DescribeProvisioningTemplateCommandOutput) => void - ): Promise | void { - const command = new DescribeProvisioningTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a provisioning template version.

- *

Requires permission to access the DescribeProvisioningTemplateVersion action.

- */ - public describeProvisioningTemplateVersion( + + /** + * @see {@link DescribeProvisioningTemplateVersionCommand} + */ + describeProvisioningTemplateVersion( args: DescribeProvisioningTemplateVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProvisioningTemplateVersion( + describeProvisioningTemplateVersion( args: DescribeProvisioningTemplateVersionCommandInput, cb: (err: any, data?: DescribeProvisioningTemplateVersionCommandOutput) => void ): void; - public describeProvisioningTemplateVersion( + describeProvisioningTemplateVersion( args: DescribeProvisioningTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProvisioningTemplateVersionCommandOutput) => void ): void; - public describeProvisioningTemplateVersion( - args: DescribeProvisioningTemplateVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProvisioningTemplateVersionCommandOutput) => void), - cb?: (err: any, data?: DescribeProvisioningTemplateVersionCommandOutput) => void - ): Promise | void { - const command = new DescribeProvisioningTemplateVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a role alias.

- *

Requires permission to access the DescribeRoleAlias action.

- */ - public describeRoleAlias( + + /** + * @see {@link DescribeRoleAliasCommand} + */ + describeRoleAlias( args: DescribeRoleAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRoleAlias( + describeRoleAlias( args: DescribeRoleAliasCommandInput, cb: (err: any, data?: DescribeRoleAliasCommandOutput) => void ): void; - public describeRoleAlias( + describeRoleAlias( args: DescribeRoleAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRoleAliasCommandOutput) => void ): void; - public describeRoleAlias( - args: DescribeRoleAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRoleAliasCommandOutput) => void), - cb?: (err: any, data?: DescribeRoleAliasCommandOutput) => void - ): Promise | void { - const command = new DescribeRoleAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a scheduled audit.

- *

Requires permission to access the DescribeScheduledAudit action.

- */ - public describeScheduledAudit( + + /** + * @see {@link DescribeScheduledAuditCommand} + */ + describeScheduledAudit( args: DescribeScheduledAuditCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeScheduledAudit( + describeScheduledAudit( args: DescribeScheduledAuditCommandInput, cb: (err: any, data?: DescribeScheduledAuditCommandOutput) => void ): void; - public describeScheduledAudit( + describeScheduledAudit( args: DescribeScheduledAuditCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScheduledAuditCommandOutput) => void ): void; - public describeScheduledAudit( - args: DescribeScheduledAuditCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeScheduledAuditCommandOutput) => void), - cb?: (err: any, data?: DescribeScheduledAuditCommandOutput) => void - ): Promise | void { - const command = new DescribeScheduledAuditCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a Device Defender security profile.

- *

Requires permission to access the DescribeSecurityProfile action.

- */ - public describeSecurityProfile( + + /** + * @see {@link DescribeSecurityProfileCommand} + */ + describeSecurityProfile( args: DescribeSecurityProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSecurityProfile( + describeSecurityProfile( args: DescribeSecurityProfileCommandInput, cb: (err: any, data?: DescribeSecurityProfileCommandOutput) => void ): void; - public describeSecurityProfile( + describeSecurityProfile( args: DescribeSecurityProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSecurityProfileCommandOutput) => void ): void; - public describeSecurityProfile( - args: DescribeSecurityProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSecurityProfileCommandOutput) => void), - cb?: (err: any, data?: DescribeSecurityProfileCommandOutput) => void - ): Promise | void { - const command = new DescribeSecurityProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a stream.

- *

Requires permission to access the DescribeStream action.

- */ - public describeStream( + + /** + * @see {@link DescribeStreamCommand} + */ + describeStream( args: DescribeStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStream( - args: DescribeStreamCommandInput, - cb: (err: any, data?: DescribeStreamCommandOutput) => void - ): void; - public describeStream( + describeStream(args: DescribeStreamCommandInput, cb: (err: any, data?: DescribeStreamCommandOutput) => void): void; + describeStream( args: DescribeStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStreamCommandOutput) => void ): void; - public describeStream( - args: DescribeStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStreamCommandOutput) => void), - cb?: (err: any, data?: DescribeStreamCommandOutput) => void - ): Promise | void { - const command = new DescribeStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the specified thing.

- *

Requires permission to access the DescribeThing action.

- */ - public describeThing( - args: DescribeThingCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeThing( - args: DescribeThingCommandInput, - cb: (err: any, data?: DescribeThingCommandOutput) => void - ): void; - public describeThing( + + /** + * @see {@link DescribeThingCommand} + */ + describeThing(args: DescribeThingCommandInput, options?: __HttpHandlerOptions): Promise; + describeThing(args: DescribeThingCommandInput, cb: (err: any, data?: DescribeThingCommandOutput) => void): void; + describeThing( args: DescribeThingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeThingCommandOutput) => void ): void; - public describeThing( - args: DescribeThingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeThingCommandOutput) => void), - cb?: (err: any, data?: DescribeThingCommandOutput) => void - ): Promise | void { - const command = new DescribeThingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describe a thing group.

- *

Requires permission to access the DescribeThingGroup action.

- */ - public describeThingGroup( + + /** + * @see {@link DescribeThingGroupCommand} + */ + describeThingGroup( args: DescribeThingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeThingGroup( + describeThingGroup( args: DescribeThingGroupCommandInput, cb: (err: any, data?: DescribeThingGroupCommandOutput) => void ): void; - public describeThingGroup( + describeThingGroup( args: DescribeThingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeThingGroupCommandOutput) => void ): void; - public describeThingGroup( - args: DescribeThingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeThingGroupCommandOutput) => void), - cb?: (err: any, data?: DescribeThingGroupCommandOutput) => void - ): Promise | void { - const command = new DescribeThingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a bulk thing provisioning task.

- *

Requires permission to access the DescribeThingRegistrationTask action.

- */ - public describeThingRegistrationTask( + + /** + * @see {@link DescribeThingRegistrationTaskCommand} + */ + describeThingRegistrationTask( args: DescribeThingRegistrationTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeThingRegistrationTask( + describeThingRegistrationTask( args: DescribeThingRegistrationTaskCommandInput, cb: (err: any, data?: DescribeThingRegistrationTaskCommandOutput) => void ): void; - public describeThingRegistrationTask( + describeThingRegistrationTask( args: DescribeThingRegistrationTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeThingRegistrationTaskCommandOutput) => void ): void; - public describeThingRegistrationTask( - args: DescribeThingRegistrationTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeThingRegistrationTaskCommandOutput) => void), - cb?: (err: any, data?: DescribeThingRegistrationTaskCommandOutput) => void - ): Promise | void { - const command = new DescribeThingRegistrationTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the specified thing type.

- *

Requires permission to access the DescribeThingType action.

- */ - public describeThingType( + + /** + * @see {@link DescribeThingTypeCommand} + */ + describeThingType( args: DescribeThingTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeThingType( + describeThingType( args: DescribeThingTypeCommandInput, cb: (err: any, data?: DescribeThingTypeCommandOutput) => void ): void; - public describeThingType( + describeThingType( args: DescribeThingTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeThingTypeCommandOutput) => void ): void; - public describeThingType( - args: DescribeThingTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeThingTypeCommandOutput) => void), - cb?: (err: any, data?: DescribeThingTypeCommandOutput) => void - ): Promise | void { - const command = new DescribeThingTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detaches a policy from the specified target.

- * - *

Because of the distributed nature of Amazon Web Services, it can take up to five minutes after - * a policy is detached before it's ready to be deleted.

- *
- *

Requires permission to access the DetachPolicy action.

- */ - public detachPolicy( - args: DetachPolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public detachPolicy(args: DetachPolicyCommandInput, cb: (err: any, data?: DetachPolicyCommandOutput) => void): void; - public detachPolicy( + + /** + * @see {@link DetachPolicyCommand} + */ + detachPolicy(args: DetachPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + detachPolicy(args: DetachPolicyCommandInput, cb: (err: any, data?: DetachPolicyCommandOutput) => void): void; + detachPolicy( args: DetachPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachPolicyCommandOutput) => void ): void; - public detachPolicy( - args: DetachPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachPolicyCommandOutput) => void), - cb?: (err: any, data?: DetachPolicyCommandOutput) => void - ): Promise | void { - const command = new DetachPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * @deprecated - * - *

Removes the specified policy from the specified certificate.

- *

- * Note: This action is deprecated and works as - * expected for backward compatibility, but we won't add enhancements. Use DetachPolicy instead.

- *

Requires permission to access the DetachPrincipalPolicy action.

- */ - public detachPrincipalPolicy( + + /** + * @see {@link DetachPrincipalPolicyCommand} + */ + detachPrincipalPolicy( args: DetachPrincipalPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachPrincipalPolicy( + detachPrincipalPolicy( args: DetachPrincipalPolicyCommandInput, cb: (err: any, data?: DetachPrincipalPolicyCommandOutput) => void ): void; - public detachPrincipalPolicy( + detachPrincipalPolicy( args: DetachPrincipalPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachPrincipalPolicyCommandOutput) => void ): void; - public detachPrincipalPolicy( - args: DetachPrincipalPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachPrincipalPolicyCommandOutput) => void), - cb?: (err: any, data?: DetachPrincipalPolicyCommandOutput) => void - ): Promise | void { - const command = new DetachPrincipalPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a Device Defender security profile from a thing group or from this account.

- *

Requires permission to access the DetachSecurityProfile action.

- */ - public detachSecurityProfile( + + /** + * @see {@link DetachSecurityProfileCommand} + */ + detachSecurityProfile( args: DetachSecurityProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachSecurityProfile( + detachSecurityProfile( args: DetachSecurityProfileCommandInput, cb: (err: any, data?: DetachSecurityProfileCommandOutput) => void ): void; - public detachSecurityProfile( + detachSecurityProfile( args: DetachSecurityProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachSecurityProfileCommandOutput) => void ): void; - public detachSecurityProfile( - args: DetachSecurityProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachSecurityProfileCommandOutput) => void), - cb?: (err: any, data?: DetachSecurityProfileCommandOutput) => void - ): Promise | void { - const command = new DetachSecurityProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detaches the specified principal from the specified thing. A principal can be X.509 - * certificates, IAM users, groups, and roles, Amazon Cognito identities or federated - * identities.

- * - *

This call is asynchronous. It might take several seconds for the detachment to - * propagate.

- *
- *

Requires permission to access the DetachThingPrincipal action.

- */ - public detachThingPrincipal( + + /** + * @see {@link DetachThingPrincipalCommand} + */ + detachThingPrincipal( args: DetachThingPrincipalCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachThingPrincipal( + detachThingPrincipal( args: DetachThingPrincipalCommandInput, cb: (err: any, data?: DetachThingPrincipalCommandOutput) => void ): void; - public detachThingPrincipal( + detachThingPrincipal( args: DetachThingPrincipalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachThingPrincipalCommandOutput) => void ): void; - public detachThingPrincipal( - args: DetachThingPrincipalCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachThingPrincipalCommandOutput) => void), - cb?: (err: any, data?: DetachThingPrincipalCommandOutput) => void - ): Promise | void { - const command = new DetachThingPrincipalCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables the rule.

- *

Requires permission to access the DisableTopicRule action.

- */ - public disableTopicRule( + + /** + * @see {@link DisableTopicRuleCommand} + */ + disableTopicRule( args: DisableTopicRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableTopicRule( + disableTopicRule( args: DisableTopicRuleCommandInput, cb: (err: any, data?: DisableTopicRuleCommandOutput) => void ): void; - public disableTopicRule( + disableTopicRule( args: DisableTopicRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableTopicRuleCommandOutput) => void ): void; - public disableTopicRule( - args: DisableTopicRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableTopicRuleCommandOutput) => void), - cb?: (err: any, data?: DisableTopicRuleCommandOutput) => void - ): Promise | void { - const command = new DisableTopicRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables the rule.

- *

Requires permission to access the EnableTopicRule action.

- */ - public enableTopicRule( + + /** + * @see {@link EnableTopicRuleCommand} + */ + enableTopicRule( args: EnableTopicRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableTopicRule( - args: EnableTopicRuleCommandInput, - cb: (err: any, data?: EnableTopicRuleCommandOutput) => void - ): void; - public enableTopicRule( + enableTopicRule(args: EnableTopicRuleCommandInput, cb: (err: any, data?: EnableTopicRuleCommandOutput) => void): void; + enableTopicRule( args: EnableTopicRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableTopicRuleCommandOutput) => void ): void; - public enableTopicRule( - args: EnableTopicRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableTopicRuleCommandOutput) => void), - cb?: (err: any, data?: EnableTopicRuleCommandOutput) => void - ): Promise | void { - const command = new EnableTopicRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Returns a Device Defender's ML Detect Security Profile training model's status. - *

- *

Requires permission to access the GetBehaviorModelTrainingSummaries action.

- */ - public getBehaviorModelTrainingSummaries( + + /** + * @see {@link GetBehaviorModelTrainingSummariesCommand} + */ + getBehaviorModelTrainingSummaries( args: GetBehaviorModelTrainingSummariesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBehaviorModelTrainingSummaries( + getBehaviorModelTrainingSummaries( args: GetBehaviorModelTrainingSummariesCommandInput, cb: (err: any, data?: GetBehaviorModelTrainingSummariesCommandOutput) => void ): void; - public getBehaviorModelTrainingSummaries( + getBehaviorModelTrainingSummaries( args: GetBehaviorModelTrainingSummariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBehaviorModelTrainingSummariesCommandOutput) => void ): void; - public getBehaviorModelTrainingSummaries( - args: GetBehaviorModelTrainingSummariesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBehaviorModelTrainingSummariesCommandOutput) => void), - cb?: (err: any, data?: GetBehaviorModelTrainingSummariesCommandOutput) => void - ): Promise | void { - const command = new GetBehaviorModelTrainingSummariesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Aggregates on indexed data with search queries pertaining to particular fields.

- *

Requires permission to access the GetBucketsAggregation action.

- */ - public getBucketsAggregation( + + /** + * @see {@link GetBucketsAggregationCommand} + */ + getBucketsAggregation( args: GetBucketsAggregationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketsAggregation( + getBucketsAggregation( args: GetBucketsAggregationCommandInput, cb: (err: any, data?: GetBucketsAggregationCommandOutput) => void ): void; - public getBucketsAggregation( + getBucketsAggregation( args: GetBucketsAggregationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketsAggregationCommandOutput) => void ): void; - public getBucketsAggregation( - args: GetBucketsAggregationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketsAggregationCommandOutput) => void), - cb?: (err: any, data?: GetBucketsAggregationCommandOutput) => void - ): Promise | void { - const command = new GetBucketsAggregationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the approximate count of unique values that match the query.

- *

Requires permission to access the GetCardinality action.

- */ - public getCardinality( + + /** + * @see {@link GetCardinalityCommand} + */ + getCardinality( args: GetCardinalityCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCardinality( - args: GetCardinalityCommandInput, - cb: (err: any, data?: GetCardinalityCommandOutput) => void - ): void; - public getCardinality( + getCardinality(args: GetCardinalityCommandInput, cb: (err: any, data?: GetCardinalityCommandOutput) => void): void; + getCardinality( args: GetCardinalityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCardinalityCommandOutput) => void ): void; - public getCardinality( - args: GetCardinalityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCardinalityCommandOutput) => void), - cb?: (err: any, data?: GetCardinalityCommandOutput) => void - ): Promise | void { - const command = new GetCardinalityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of the policies that have an effect on the authorization behavior of the - * specified device when it connects to the IoT device gateway.

- *

Requires permission to access the GetEffectivePolicies action.

- */ - public getEffectivePolicies( + + /** + * @see {@link GetEffectivePoliciesCommand} + */ + getEffectivePolicies( args: GetEffectivePoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEffectivePolicies( + getEffectivePolicies( args: GetEffectivePoliciesCommandInput, cb: (err: any, data?: GetEffectivePoliciesCommandOutput) => void ): void; - public getEffectivePolicies( + getEffectivePolicies( args: GetEffectivePoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEffectivePoliciesCommandOutput) => void ): void; - public getEffectivePolicies( - args: GetEffectivePoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEffectivePoliciesCommandOutput) => void), - cb?: (err: any, data?: GetEffectivePoliciesCommandOutput) => void - ): Promise | void { - const command = new GetEffectivePoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the indexing configuration.

- *

Requires permission to access the GetIndexingConfiguration action.

- */ - public getIndexingConfiguration( + + /** + * @see {@link GetIndexingConfigurationCommand} + */ + getIndexingConfiguration( args: GetIndexingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIndexingConfiguration( + getIndexingConfiguration( args: GetIndexingConfigurationCommandInput, cb: (err: any, data?: GetIndexingConfigurationCommandOutput) => void ): void; - public getIndexingConfiguration( + getIndexingConfiguration( args: GetIndexingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIndexingConfigurationCommandOutput) => void ): void; - public getIndexingConfiguration( - args: GetIndexingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIndexingConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetIndexingConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetIndexingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a job document.

- *

Requires permission to access the GetJobDocument action.

- */ - public getJobDocument( + + /** + * @see {@link GetJobDocumentCommand} + */ + getJobDocument( args: GetJobDocumentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getJobDocument( - args: GetJobDocumentCommandInput, - cb: (err: any, data?: GetJobDocumentCommandOutput) => void - ): void; - public getJobDocument( + getJobDocument(args: GetJobDocumentCommandInput, cb: (err: any, data?: GetJobDocumentCommandOutput) => void): void; + getJobDocument( args: GetJobDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobDocumentCommandOutput) => void ): void; - public getJobDocument( - args: GetJobDocumentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetJobDocumentCommandOutput) => void), - cb?: (err: any, data?: GetJobDocumentCommandOutput) => void - ): Promise | void { - const command = new GetJobDocumentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the logging options.

- *

NOTE: use of this command is not recommended. Use GetV2LoggingOptions - * instead.

- *

Requires permission to access the GetLoggingOptions action.

- */ - public getLoggingOptions( + + /** + * @see {@link GetLoggingOptionsCommand} + */ + getLoggingOptions( args: GetLoggingOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLoggingOptions( + getLoggingOptions( args: GetLoggingOptionsCommandInput, cb: (err: any, data?: GetLoggingOptionsCommandOutput) => void ): void; - public getLoggingOptions( + getLoggingOptions( args: GetLoggingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLoggingOptionsCommandOutput) => void ): void; - public getLoggingOptions( - args: GetLoggingOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLoggingOptionsCommandOutput) => void), - cb?: (err: any, data?: GetLoggingOptionsCommandOutput) => void - ): Promise | void { - const command = new GetLoggingOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets an OTA update.

- *

Requires permission to access the GetOTAUpdate action.

- */ - public getOTAUpdate( - args: GetOTAUpdateCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getOTAUpdate(args: GetOTAUpdateCommandInput, cb: (err: any, data?: GetOTAUpdateCommandOutput) => void): void; - public getOTAUpdate( + + /** + * @see {@link GetOTAUpdateCommand} + */ + getOTAUpdate(args: GetOTAUpdateCommandInput, options?: __HttpHandlerOptions): Promise; + getOTAUpdate(args: GetOTAUpdateCommandInput, cb: (err: any, data?: GetOTAUpdateCommandOutput) => void): void; + getOTAUpdate( args: GetOTAUpdateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOTAUpdateCommandOutput) => void ): void; - public getOTAUpdate( - args: GetOTAUpdateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOTAUpdateCommandOutput) => void), - cb?: (err: any, data?: GetOTAUpdateCommandOutput) => void - ): Promise | void { - const command = new GetOTAUpdateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Groups the aggregated values that match the query into percentile groupings. The default - * percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own - * when you call GetPercentiles. This function returns a value for each - * percentile group specified (or the default percentile groupings). The percentile group - * "1" contains the aggregated field value that occurs in approximately one percent of the - * values that match the query. The percentile group "5" contains the aggregated field value - * that occurs in approximately five percent of the values that match the query, and so on. - * The result is an approximation, the more values that match the query, the more accurate - * the percentile values.

- *

Requires permission to access the GetPercentiles action.

- */ - public getPercentiles( + + /** + * @see {@link GetPercentilesCommand} + */ + getPercentiles( args: GetPercentilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPercentiles( - args: GetPercentilesCommandInput, - cb: (err: any, data?: GetPercentilesCommandOutput) => void - ): void; - public getPercentiles( + getPercentiles(args: GetPercentilesCommandInput, cb: (err: any, data?: GetPercentilesCommandOutput) => void): void; + getPercentiles( args: GetPercentilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPercentilesCommandOutput) => void ): void; - public getPercentiles( - args: GetPercentilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPercentilesCommandOutput) => void), - cb?: (err: any, data?: GetPercentilesCommandOutput) => void - ): Promise | void { - const command = new GetPercentilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the specified policy with the policy document of the default - * version.

- *

Requires permission to access the GetPolicy action.

- */ - public getPolicy(args: GetPolicyCommandInput, options?: __HttpHandlerOptions): Promise; - public getPolicy(args: GetPolicyCommandInput, cb: (err: any, data?: GetPolicyCommandOutput) => void): void; - public getPolicy( + + /** + * @see {@link GetPolicyCommand} + */ + getPolicy(args: GetPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + getPolicy(args: GetPolicyCommandInput, cb: (err: any, data?: GetPolicyCommandOutput) => void): void; + getPolicy( args: GetPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPolicyCommandOutput) => void ): void; - public getPolicy( - args: GetPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPolicyCommandOutput) => void), - cb?: (err: any, data?: GetPolicyCommandOutput) => void - ): Promise | void { - const command = new GetPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the specified policy version.

- *

Requires permission to access the GetPolicyVersion action.

- */ - public getPolicyVersion( + + /** + * @see {@link GetPolicyVersionCommand} + */ + getPolicyVersion( args: GetPolicyVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPolicyVersion( + getPolicyVersion( args: GetPolicyVersionCommandInput, cb: (err: any, data?: GetPolicyVersionCommandOutput) => void ): void; - public getPolicyVersion( + getPolicyVersion( args: GetPolicyVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPolicyVersionCommandOutput) => void ): void; - public getPolicyVersion( - args: GetPolicyVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPolicyVersionCommandOutput) => void), - cb?: (err: any, data?: GetPolicyVersionCommandOutput) => void - ): Promise | void { - const command = new GetPolicyVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a registration code used to register a CA certificate with IoT.

- *

Requires permission to access the GetRegistrationCode action.

- */ - public getRegistrationCode( + + /** + * @see {@link GetRegistrationCodeCommand} + */ + getRegistrationCode( args: GetRegistrationCodeCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRegistrationCode( + getRegistrationCode( args: GetRegistrationCodeCommandInput, cb: (err: any, data?: GetRegistrationCodeCommandOutput) => void ): void; - public getRegistrationCode( + getRegistrationCode( args: GetRegistrationCodeCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: GetRegistrationCodeCommandOutput) => void - ): void; - public getRegistrationCode( - args: GetRegistrationCodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRegistrationCodeCommandOutput) => void), - cb?: (err: any, data?: GetRegistrationCodeCommandOutput) => void - ): Promise | void { - const command = new GetRegistrationCodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the count, average, sum, minimum, maximum, sum of squares, variance, - * and standard deviation for the specified aggregated field. If the aggregation field is of type - * String, only the count statistic is returned.

- *

Requires permission to access the GetStatistics action.

- */ - public getStatistics( - args: GetStatisticsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getStatistics( - args: GetStatisticsCommandInput, - cb: (err: any, data?: GetStatisticsCommandOutput) => void + options: __HttpHandlerOptions, + cb: (err: any, data?: GetRegistrationCodeCommandOutput) => void ): void; - public getStatistics( + + /** + * @see {@link GetStatisticsCommand} + */ + getStatistics(args: GetStatisticsCommandInput, options?: __HttpHandlerOptions): Promise; + getStatistics(args: GetStatisticsCommandInput, cb: (err: any, data?: GetStatisticsCommandOutput) => void): void; + getStatistics( args: GetStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStatisticsCommandOutput) => void ): void; - public getStatistics( - args: GetStatisticsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStatisticsCommandOutput) => void), - cb?: (err: any, data?: GetStatisticsCommandOutput) => void - ): Promise | void { - const command = new GetStatisticsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the rule.

- *

Requires permission to access the GetTopicRule action.

- */ - public getTopicRule( - args: GetTopicRuleCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getTopicRule(args: GetTopicRuleCommandInput, cb: (err: any, data?: GetTopicRuleCommandOutput) => void): void; - public getTopicRule( + + /** + * @see {@link GetTopicRuleCommand} + */ + getTopicRule(args: GetTopicRuleCommandInput, options?: __HttpHandlerOptions): Promise; + getTopicRule(args: GetTopicRuleCommandInput, cb: (err: any, data?: GetTopicRuleCommandOutput) => void): void; + getTopicRule( args: GetTopicRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTopicRuleCommandOutput) => void ): void; - public getTopicRule( - args: GetTopicRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTopicRuleCommandOutput) => void), - cb?: (err: any, data?: GetTopicRuleCommandOutput) => void - ): Promise | void { - const command = new GetTopicRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a topic rule destination.

- *

Requires permission to access the GetTopicRuleDestination action.

- */ - public getTopicRuleDestination( + + /** + * @see {@link GetTopicRuleDestinationCommand} + */ + getTopicRuleDestination( args: GetTopicRuleDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTopicRuleDestination( + getTopicRuleDestination( args: GetTopicRuleDestinationCommandInput, cb: (err: any, data?: GetTopicRuleDestinationCommandOutput) => void ): void; - public getTopicRuleDestination( + getTopicRuleDestination( args: GetTopicRuleDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTopicRuleDestinationCommandOutput) => void ): void; - public getTopicRuleDestination( - args: GetTopicRuleDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTopicRuleDestinationCommandOutput) => void), - cb?: (err: any, data?: GetTopicRuleDestinationCommandOutput) => void - ): Promise | void { - const command = new GetTopicRuleDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the fine grained logging options.

- *

Requires permission to access the GetV2LoggingOptions action.

- */ - public getV2LoggingOptions( + + /** + * @see {@link GetV2LoggingOptionsCommand} + */ + getV2LoggingOptions( args: GetV2LoggingOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getV2LoggingOptions( + getV2LoggingOptions( args: GetV2LoggingOptionsCommandInput, cb: (err: any, data?: GetV2LoggingOptionsCommandOutput) => void ): void; - public getV2LoggingOptions( + getV2LoggingOptions( args: GetV2LoggingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetV2LoggingOptionsCommandOutput) => void ): void; - public getV2LoggingOptions( - args: GetV2LoggingOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetV2LoggingOptionsCommandOutput) => void), - cb?: (err: any, data?: GetV2LoggingOptionsCommandOutput) => void - ): Promise | void { - const command = new GetV2LoggingOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the active violations for a given Device Defender security profile.

- *

Requires permission to access the ListActiveViolations action.

- */ - public listActiveViolations( + + /** + * @see {@link ListActiveViolationsCommand} + */ + listActiveViolations( args: ListActiveViolationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listActiveViolations( + listActiveViolations( args: ListActiveViolationsCommandInput, cb: (err: any, data?: ListActiveViolationsCommandOutput) => void ): void; - public listActiveViolations( + listActiveViolations( args: ListActiveViolationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListActiveViolationsCommandOutput) => void ): void; - public listActiveViolations( - args: ListActiveViolationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListActiveViolationsCommandOutput) => void), - cb?: (err: any, data?: ListActiveViolationsCommandOutput) => void - ): Promise | void { - const command = new ListActiveViolationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the policies attached to the specified thing group.

- *

Requires permission to access the ListAttachedPolicies action.

- */ - public listAttachedPolicies( + + /** + * @see {@link ListAttachedPoliciesCommand} + */ + listAttachedPolicies( args: ListAttachedPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAttachedPolicies( + listAttachedPolicies( args: ListAttachedPoliciesCommandInput, cb: (err: any, data?: ListAttachedPoliciesCommandOutput) => void ): void; - public listAttachedPolicies( + listAttachedPolicies( args: ListAttachedPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAttachedPoliciesCommandOutput) => void ): void; - public listAttachedPolicies( - args: ListAttachedPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAttachedPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListAttachedPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListAttachedPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the findings (results) of a Device Defender audit or of the audits - * performed during a specified time period. (Findings are retained for 90 days.)

- *

Requires permission to access the ListAuditFindings action.

- */ - public listAuditFindings( + + /** + * @see {@link ListAuditFindingsCommand} + */ + listAuditFindings( args: ListAuditFindingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAuditFindings( + listAuditFindings( args: ListAuditFindingsCommandInput, cb: (err: any, data?: ListAuditFindingsCommandOutput) => void ): void; - public listAuditFindings( + listAuditFindings( args: ListAuditFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAuditFindingsCommandOutput) => void ): void; - public listAuditFindings( - args: ListAuditFindingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAuditFindingsCommandOutput) => void), - cb?: (err: any, data?: ListAuditFindingsCommandOutput) => void - ): Promise | void { - const command = new ListAuditFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the status of audit mitigation action tasks that were - * executed.

- *

Requires permission to access the ListAuditMitigationActionsExecutions action.

- */ - public listAuditMitigationActionsExecutions( + + /** + * @see {@link ListAuditMitigationActionsExecutionsCommand} + */ + listAuditMitigationActionsExecutions( args: ListAuditMitigationActionsExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAuditMitigationActionsExecutions( + listAuditMitigationActionsExecutions( args: ListAuditMitigationActionsExecutionsCommandInput, cb: (err: any, data?: ListAuditMitigationActionsExecutionsCommandOutput) => void ): void; - public listAuditMitigationActionsExecutions( + listAuditMitigationActionsExecutions( args: ListAuditMitigationActionsExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAuditMitigationActionsExecutionsCommandOutput) => void ): void; - public listAuditMitigationActionsExecutions( - args: ListAuditMitigationActionsExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAuditMitigationActionsExecutionsCommandOutput) => void), - cb?: (err: any, data?: ListAuditMitigationActionsExecutionsCommandOutput) => void - ): Promise | void { - const command = new ListAuditMitigationActionsExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of audit mitigation action tasks that match the specified filters.

- *

Requires permission to access the ListAuditMitigationActionsTasks action.

- */ - public listAuditMitigationActionsTasks( + + /** + * @see {@link ListAuditMitigationActionsTasksCommand} + */ + listAuditMitigationActionsTasks( args: ListAuditMitigationActionsTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAuditMitigationActionsTasks( + listAuditMitigationActionsTasks( args: ListAuditMitigationActionsTasksCommandInput, cb: (err: any, data?: ListAuditMitigationActionsTasksCommandOutput) => void ): void; - public listAuditMitigationActionsTasks( + listAuditMitigationActionsTasks( args: ListAuditMitigationActionsTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAuditMitigationActionsTasksCommandOutput) => void ): void; - public listAuditMitigationActionsTasks( - args: ListAuditMitigationActionsTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAuditMitigationActionsTasksCommandOutput) => void), - cb?: (err: any, data?: ListAuditMitigationActionsTasksCommandOutput) => void - ): Promise | void { - const command = new ListAuditMitigationActionsTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Lists your Device Defender audit listings. - *

- *

Requires permission to access the ListAuditSuppressions action.

- */ - public listAuditSuppressions( + + /** + * @see {@link ListAuditSuppressionsCommand} + */ + listAuditSuppressions( args: ListAuditSuppressionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAuditSuppressions( + listAuditSuppressions( args: ListAuditSuppressionsCommandInput, cb: (err: any, data?: ListAuditSuppressionsCommandOutput) => void ): void; - public listAuditSuppressions( + listAuditSuppressions( args: ListAuditSuppressionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAuditSuppressionsCommandOutput) => void ): void; - public listAuditSuppressions( - args: ListAuditSuppressionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAuditSuppressionsCommandOutput) => void), - cb?: (err: any, data?: ListAuditSuppressionsCommandOutput) => void - ): Promise | void { - const command = new ListAuditSuppressionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the Device Defender audits that have been performed during a given - * time period.

- *

Requires permission to access the ListAuditTasks action.

- */ - public listAuditTasks( + + /** + * @see {@link ListAuditTasksCommand} + */ + listAuditTasks( args: ListAuditTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAuditTasks( - args: ListAuditTasksCommandInput, - cb: (err: any, data?: ListAuditTasksCommandOutput) => void - ): void; - public listAuditTasks( + listAuditTasks(args: ListAuditTasksCommandInput, cb: (err: any, data?: ListAuditTasksCommandOutput) => void): void; + listAuditTasks( args: ListAuditTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAuditTasksCommandOutput) => void ): void; - public listAuditTasks( - args: ListAuditTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAuditTasksCommandOutput) => void), - cb?: (err: any, data?: ListAuditTasksCommandOutput) => void - ): Promise | void { - const command = new ListAuditTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the authorizers registered in your account.

- *

Requires permission to access the ListAuthorizers action.

- */ - public listAuthorizers( + + /** + * @see {@link ListAuthorizersCommand} + */ + listAuthorizers( args: ListAuthorizersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAuthorizers( - args: ListAuthorizersCommandInput, - cb: (err: any, data?: ListAuthorizersCommandOutput) => void - ): void; - public listAuthorizers( + listAuthorizers(args: ListAuthorizersCommandInput, cb: (err: any, data?: ListAuthorizersCommandOutput) => void): void; + listAuthorizers( args: ListAuthorizersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAuthorizersCommandOutput) => void ): void; - public listAuthorizers( - args: ListAuthorizersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAuthorizersCommandOutput) => void), - cb?: (err: any, data?: ListAuthorizersCommandOutput) => void - ): Promise | void { - const command = new ListAuthorizersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the billing groups you have created.

- *

Requires permission to access the ListBillingGroups action.

- */ - public listBillingGroups( + + /** + * @see {@link ListBillingGroupsCommand} + */ + listBillingGroups( args: ListBillingGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBillingGroups( + listBillingGroups( args: ListBillingGroupsCommandInput, cb: (err: any, data?: ListBillingGroupsCommandOutput) => void ): void; - public listBillingGroups( + listBillingGroups( args: ListBillingGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBillingGroupsCommandOutput) => void ): void; - public listBillingGroups( - args: ListBillingGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBillingGroupsCommandOutput) => void), - cb?: (err: any, data?: ListBillingGroupsCommandOutput) => void - ): Promise | void { - const command = new ListBillingGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the CA certificates registered for your Amazon Web Services account.

- *

The results are paginated with a default page size of 25. You can use the returned - * marker to retrieve additional results.

- *

Requires permission to access the ListCACertificates action.

- */ - public listCACertificates( + + /** + * @see {@link ListCACertificatesCommand} + */ + listCACertificates( args: ListCACertificatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCACertificates( + listCACertificates( args: ListCACertificatesCommandInput, cb: (err: any, data?: ListCACertificatesCommandOutput) => void ): void; - public listCACertificates( + listCACertificates( args: ListCACertificatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCACertificatesCommandOutput) => void ): void; - public listCACertificates( - args: ListCACertificatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCACertificatesCommandOutput) => void), - cb?: (err: any, data?: ListCACertificatesCommandOutput) => void - ): Promise | void { - const command = new ListCACertificatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the certificates registered in your Amazon Web Services account.

- *

The results are paginated with a default page size of 25. You can use the returned - * marker to retrieve additional results.

- *

Requires permission to access the ListCertificates action.

- */ - public listCertificates( + + /** + * @see {@link ListCertificatesCommand} + */ + listCertificates( args: ListCertificatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCertificates( + listCertificates( args: ListCertificatesCommandInput, cb: (err: any, data?: ListCertificatesCommandOutput) => void ): void; - public listCertificates( + listCertificates( args: ListCertificatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCertificatesCommandOutput) => void ): void; - public listCertificates( - args: ListCertificatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCertificatesCommandOutput) => void), - cb?: (err: any, data?: ListCertificatesCommandOutput) => void - ): Promise | void { - const command = new ListCertificatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List the device certificates signed by the specified CA certificate.

- *

Requires permission to access the ListCertificatesByCA action.

- */ - public listCertificatesByCA( + + /** + * @see {@link ListCertificatesByCACommand} + */ + listCertificatesByCA( args: ListCertificatesByCACommandInput, options?: __HttpHandlerOptions ): Promise; - public listCertificatesByCA( + listCertificatesByCA( args: ListCertificatesByCACommandInput, cb: (err: any, data?: ListCertificatesByCACommandOutput) => void ): void; - public listCertificatesByCA( + listCertificatesByCA( args: ListCertificatesByCACommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCertificatesByCACommandOutput) => void ): void; - public listCertificatesByCA( - args: ListCertificatesByCACommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCertificatesByCACommandOutput) => void), - cb?: (err: any, data?: ListCertificatesByCACommandOutput) => void - ): Promise | void { - const command = new ListCertificatesByCACommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Lists your Device Defender detect custom metrics. - *

- *

Requires permission to access the ListCustomMetrics action.

- */ - public listCustomMetrics( + + /** + * @see {@link ListCustomMetricsCommand} + */ + listCustomMetrics( args: ListCustomMetricsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCustomMetrics( + listCustomMetrics( args: ListCustomMetricsCommandInput, cb: (err: any, data?: ListCustomMetricsCommandOutput) => void ): void; - public listCustomMetrics( + listCustomMetrics( args: ListCustomMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCustomMetricsCommandOutput) => void ): void; - public listCustomMetrics( - args: ListCustomMetricsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCustomMetricsCommandOutput) => void), - cb?: (err: any, data?: ListCustomMetricsCommandOutput) => void - ): Promise | void { - const command = new ListCustomMetricsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Lists mitigation actions executions for a Device Defender ML Detect Security Profile. - *

- *

Requires permission to access the ListDetectMitigationActionsExecutions action.

- */ - public listDetectMitigationActionsExecutions( + + /** + * @see {@link ListDetectMitigationActionsExecutionsCommand} + */ + listDetectMitigationActionsExecutions( args: ListDetectMitigationActionsExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDetectMitigationActionsExecutions( + listDetectMitigationActionsExecutions( args: ListDetectMitigationActionsExecutionsCommandInput, cb: (err: any, data?: ListDetectMitigationActionsExecutionsCommandOutput) => void ): void; - public listDetectMitigationActionsExecutions( + listDetectMitigationActionsExecutions( args: ListDetectMitigationActionsExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDetectMitigationActionsExecutionsCommandOutput) => void ): void; - public listDetectMitigationActionsExecutions( - args: ListDetectMitigationActionsExecutionsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListDetectMitigationActionsExecutionsCommandOutput) => void), - cb?: (err: any, data?: ListDetectMitigationActionsExecutionsCommandOutput) => void - ): Promise | void { - const command = new ListDetectMitigationActionsExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * List of Device Defender ML Detect mitigation actions tasks. - *

- *

Requires permission to access the ListDetectMitigationActionsTasks action.

- */ - public listDetectMitigationActionsTasks( + + /** + * @see {@link ListDetectMitigationActionsTasksCommand} + */ + listDetectMitigationActionsTasks( args: ListDetectMitigationActionsTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDetectMitigationActionsTasks( + listDetectMitigationActionsTasks( args: ListDetectMitigationActionsTasksCommandInput, cb: (err: any, data?: ListDetectMitigationActionsTasksCommandOutput) => void ): void; - public listDetectMitigationActionsTasks( + listDetectMitigationActionsTasks( args: ListDetectMitigationActionsTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDetectMitigationActionsTasksCommandOutput) => void ): void; - public listDetectMitigationActionsTasks( - args: ListDetectMitigationActionsTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDetectMitigationActionsTasksCommandOutput) => void), - cb?: (err: any, data?: ListDetectMitigationActionsTasksCommandOutput) => void - ): Promise | void { - const command = new ListDetectMitigationActionsTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List the set of dimensions that are defined for your Amazon Web Services accounts.

- *

Requires permission to access the ListDimensions action.

- */ - public listDimensions( + + /** + * @see {@link ListDimensionsCommand} + */ + listDimensions( args: ListDimensionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDimensions( - args: ListDimensionsCommandInput, - cb: (err: any, data?: ListDimensionsCommandOutput) => void - ): void; - public listDimensions( + listDimensions(args: ListDimensionsCommandInput, cb: (err: any, data?: ListDimensionsCommandOutput) => void): void; + listDimensions( args: ListDimensionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDimensionsCommandOutput) => void ): void; - public listDimensions( - args: ListDimensionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDimensionsCommandOutput) => void), - cb?: (err: any, data?: ListDimensionsCommandOutput) => void - ): Promise | void { - const command = new ListDimensionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of domain configurations for the user. This list is sorted - * alphabetically by domain configuration name.

- *

Requires permission to access the ListDomainConfigurations action.

- */ - public listDomainConfigurations( + + /** + * @see {@link ListDomainConfigurationsCommand} + */ + listDomainConfigurations( args: ListDomainConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDomainConfigurations( + listDomainConfigurations( args: ListDomainConfigurationsCommandInput, cb: (err: any, data?: ListDomainConfigurationsCommandOutput) => void ): void; - public listDomainConfigurations( + listDomainConfigurations( args: ListDomainConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainConfigurationsCommandOutput) => void ): void; - public listDomainConfigurations( - args: ListDomainConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDomainConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListDomainConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListDomainConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all your fleet metrics.

- *

Requires permission to access the ListFleetMetrics action.

- */ - public listFleetMetrics( + + /** + * @see {@link ListFleetMetricsCommand} + */ + listFleetMetrics( args: ListFleetMetricsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFleetMetrics( + listFleetMetrics( args: ListFleetMetricsCommandInput, cb: (err: any, data?: ListFleetMetricsCommandOutput) => void ): void; - public listFleetMetrics( + listFleetMetrics( args: ListFleetMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFleetMetricsCommandOutput) => void ): void; - public listFleetMetrics( - args: ListFleetMetricsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFleetMetricsCommandOutput) => void), - cb?: (err: any, data?: ListFleetMetricsCommandOutput) => void - ): Promise | void { - const command = new ListFleetMetricsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the search indices.

- *

Requires permission to access the ListIndices action.

- */ - public listIndices(args: ListIndicesCommandInput, options?: __HttpHandlerOptions): Promise; - public listIndices(args: ListIndicesCommandInput, cb: (err: any, data?: ListIndicesCommandOutput) => void): void; - public listIndices( + + /** + * @see {@link ListIndicesCommand} + */ + listIndices(args: ListIndicesCommandInput, options?: __HttpHandlerOptions): Promise; + listIndices(args: ListIndicesCommandInput, cb: (err: any, data?: ListIndicesCommandOutput) => void): void; + listIndices( args: ListIndicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIndicesCommandOutput) => void ): void; - public listIndices( - args: ListIndicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIndicesCommandOutput) => void), - cb?: (err: any, data?: ListIndicesCommandOutput) => void - ): Promise | void { - const command = new ListIndicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the job executions for a job.

- *

Requires permission to access the ListJobExecutionsForJob action.

- */ - public listJobExecutionsForJob( + + /** + * @see {@link ListJobExecutionsForJobCommand} + */ + listJobExecutionsForJob( args: ListJobExecutionsForJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public listJobExecutionsForJob( + listJobExecutionsForJob( args: ListJobExecutionsForJobCommandInput, cb: (err: any, data?: ListJobExecutionsForJobCommandOutput) => void ): void; - public listJobExecutionsForJob( + listJobExecutionsForJob( args: ListJobExecutionsForJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobExecutionsForJobCommandOutput) => void ): void; - public listJobExecutionsForJob( - args: ListJobExecutionsForJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJobExecutionsForJobCommandOutput) => void), - cb?: (err: any, data?: ListJobExecutionsForJobCommandOutput) => void - ): Promise | void { - const command = new ListJobExecutionsForJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the job executions for the specified thing.

- *

Requires permission to access the ListJobExecutionsForThing action.

- */ - public listJobExecutionsForThing( + + /** + * @see {@link ListJobExecutionsForThingCommand} + */ + listJobExecutionsForThing( args: ListJobExecutionsForThingCommandInput, options?: __HttpHandlerOptions ): Promise; - public listJobExecutionsForThing( + listJobExecutionsForThing( args: ListJobExecutionsForThingCommandInput, cb: (err: any, data?: ListJobExecutionsForThingCommandOutput) => void ): void; - public listJobExecutionsForThing( + listJobExecutionsForThing( args: ListJobExecutionsForThingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobExecutionsForThingCommandOutput) => void ): void; - public listJobExecutionsForThing( - args: ListJobExecutionsForThingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJobExecutionsForThingCommandOutput) => void), - cb?: (err: any, data?: ListJobExecutionsForThingCommandOutput) => void - ): Promise | void { - const command = new ListJobExecutionsForThingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists jobs.

- *

Requires permission to access the ListJobs action.

- */ - public listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise; - public listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void; - public listJobs( + + /** + * @see {@link ListJobsCommand} + */ + listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise; + listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void; + listJobs( args: ListJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobsCommandOutput) => void ): void; - public listJobs( - args: ListJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJobsCommandOutput) => void), - cb?: (err: any, data?: ListJobsCommandOutput) => void - ): Promise | void { - const command = new ListJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of job templates.

- *

Requires permission to access the ListJobTemplates action.

- */ - public listJobTemplates( + + /** + * @see {@link ListJobTemplatesCommand} + */ + listJobTemplates( args: ListJobTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listJobTemplates( + listJobTemplates( args: ListJobTemplatesCommandInput, cb: (err: any, data?: ListJobTemplatesCommandOutput) => void ): void; - public listJobTemplates( + listJobTemplates( args: ListJobTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobTemplatesCommandOutput) => void ): void; - public listJobTemplates( - args: ListJobTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJobTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListJobTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListJobTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of managed job templates.

- */ - public listManagedJobTemplates( + + /** + * @see {@link ListManagedJobTemplatesCommand} + */ + listManagedJobTemplates( args: ListManagedJobTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listManagedJobTemplates( + listManagedJobTemplates( args: ListManagedJobTemplatesCommandInput, cb: (err: any, data?: ListManagedJobTemplatesCommandOutput) => void ): void; - public listManagedJobTemplates( + listManagedJobTemplates( args: ListManagedJobTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListManagedJobTemplatesCommandOutput) => void ): void; - public listManagedJobTemplates( - args: ListManagedJobTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListManagedJobTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListManagedJobTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListManagedJobTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) - * by the given thing during the specified time period.

- */ - public listMetricValues( + + /** + * @see {@link ListMetricValuesCommand} + */ + listMetricValues( args: ListMetricValuesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMetricValues( + listMetricValues( args: ListMetricValuesCommandInput, cb: (err: any, data?: ListMetricValuesCommandOutput) => void ): void; - public listMetricValues( + listMetricValues( args: ListMetricValuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMetricValuesCommandOutput) => void ): void; - public listMetricValues( - args: ListMetricValuesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMetricValuesCommandOutput) => void), - cb?: (err: any, data?: ListMetricValuesCommandOutput) => void - ): Promise | void { - const command = new ListMetricValuesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of all mitigation actions that match the specified filter criteria.

- *

Requires permission to access the ListMitigationActions action.

- */ - public listMitigationActions( + + /** + * @see {@link ListMitigationActionsCommand} + */ + listMitigationActions( args: ListMitigationActionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMitigationActions( + listMitigationActions( args: ListMitigationActionsCommandInput, cb: (err: any, data?: ListMitigationActionsCommandOutput) => void ): void; - public listMitigationActions( + listMitigationActions( args: ListMitigationActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMitigationActionsCommandOutput) => void ): void; - public listMitigationActions( - args: ListMitigationActionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMitigationActionsCommandOutput) => void), - cb?: (err: any, data?: ListMitigationActionsCommandOutput) => void - ): Promise | void { - const command = new ListMitigationActionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists OTA updates.

- *

Requires permission to access the ListOTAUpdates action.

- */ - public listOTAUpdates( + + /** + * @see {@link ListOTAUpdatesCommand} + */ + listOTAUpdates( args: ListOTAUpdatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOTAUpdates( - args: ListOTAUpdatesCommandInput, - cb: (err: any, data?: ListOTAUpdatesCommandOutput) => void - ): void; - public listOTAUpdates( + listOTAUpdates(args: ListOTAUpdatesCommandInput, cb: (err: any, data?: ListOTAUpdatesCommandOutput) => void): void; + listOTAUpdates( args: ListOTAUpdatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOTAUpdatesCommandOutput) => void ): void; - public listOTAUpdates( - args: ListOTAUpdatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOTAUpdatesCommandOutput) => void), - cb?: (err: any, data?: ListOTAUpdatesCommandOutput) => void - ): Promise | void { - const command = new ListOTAUpdatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists certificates that are being transferred but not yet accepted.

- *

Requires permission to access the ListOutgoingCertificates action.

- */ - public listOutgoingCertificates( + + /** + * @see {@link ListOutgoingCertificatesCommand} + */ + listOutgoingCertificates( args: ListOutgoingCertificatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOutgoingCertificates( + listOutgoingCertificates( args: ListOutgoingCertificatesCommandInput, cb: (err: any, data?: ListOutgoingCertificatesCommandOutput) => void ): void; - public listOutgoingCertificates( + listOutgoingCertificates( args: ListOutgoingCertificatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOutgoingCertificatesCommandOutput) => void ): void; - public listOutgoingCertificates( - args: ListOutgoingCertificatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOutgoingCertificatesCommandOutput) => void), - cb?: (err: any, data?: ListOutgoingCertificatesCommandOutput) => void - ): Promise | void { - const command = new ListOutgoingCertificatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists your policies.

- *

Requires permission to access the ListPolicies action.

- */ - public listPolicies( - args: ListPoliciesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listPolicies(args: ListPoliciesCommandInput, cb: (err: any, data?: ListPoliciesCommandOutput) => void): void; - public listPolicies( + + /** + * @see {@link ListPoliciesCommand} + */ + listPolicies(args: ListPoliciesCommandInput, options?: __HttpHandlerOptions): Promise; + listPolicies(args: ListPoliciesCommandInput, cb: (err: any, data?: ListPoliciesCommandOutput) => void): void; + listPolicies( args: ListPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPoliciesCommandOutput) => void ): void; - public listPolicies( - args: ListPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * @deprecated - * - *

Lists the principals associated with the specified policy.

- *

- * Note: This action is deprecated and works as - * expected for backward compatibility, but we won't add enhancements. Use ListTargetsForPolicy instead.

- *

Requires permission to access the ListPolicyPrincipals action.

- */ - public listPolicyPrincipals( + + /** + * @see {@link ListPolicyPrincipalsCommand} + */ + listPolicyPrincipals( args: ListPolicyPrincipalsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPolicyPrincipals( + listPolicyPrincipals( args: ListPolicyPrincipalsCommandInput, cb: (err: any, data?: ListPolicyPrincipalsCommandOutput) => void ): void; - public listPolicyPrincipals( + listPolicyPrincipals( args: ListPolicyPrincipalsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPolicyPrincipalsCommandOutput) => void ): void; - public listPolicyPrincipals( - args: ListPolicyPrincipalsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPolicyPrincipalsCommandOutput) => void), - cb?: (err: any, data?: ListPolicyPrincipalsCommandOutput) => void - ): Promise | void { - const command = new ListPolicyPrincipalsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the versions of the specified policy and identifies the default - * version.

- *

Requires permission to access the ListPolicyVersions action.

- */ - public listPolicyVersions( + + /** + * @see {@link ListPolicyVersionsCommand} + */ + listPolicyVersions( args: ListPolicyVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPolicyVersions( + listPolicyVersions( args: ListPolicyVersionsCommandInput, cb: (err: any, data?: ListPolicyVersionsCommandOutput) => void ): void; - public listPolicyVersions( + listPolicyVersions( args: ListPolicyVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPolicyVersionsCommandOutput) => void ): void; - public listPolicyVersions( - args: ListPolicyVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPolicyVersionsCommandOutput) => void), - cb?: (err: any, data?: ListPolicyVersionsCommandOutput) => void - ): Promise | void { - const command = new ListPolicyVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * @deprecated - * - *

Lists the policies attached to the specified principal. If you use an Cognito - * identity, the ID must be in AmazonCognito Identity format.

- *

- * Note: This action is deprecated and works as - * expected for backward compatibility, but we won't add enhancements. Use ListAttachedPolicies instead.

- *

Requires permission to access the ListPrincipalPolicies action.

- */ - public listPrincipalPolicies( + + /** + * @see {@link ListPrincipalPoliciesCommand} + */ + listPrincipalPolicies( args: ListPrincipalPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPrincipalPolicies( + listPrincipalPolicies( args: ListPrincipalPoliciesCommandInput, cb: (err: any, data?: ListPrincipalPoliciesCommandOutput) => void ): void; - public listPrincipalPolicies( + listPrincipalPolicies( args: ListPrincipalPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPrincipalPoliciesCommandOutput) => void ): void; - public listPrincipalPolicies( - args: ListPrincipalPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPrincipalPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListPrincipalPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListPrincipalPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the things associated with the specified principal. A principal can be X.509 - * certificates, IAM users, groups, and roles, Amazon Cognito identities or federated - * identities.

- *

Requires permission to access the ListPrincipalThings action.

- */ - public listPrincipalThings( + + /** + * @see {@link ListPrincipalThingsCommand} + */ + listPrincipalThings( args: ListPrincipalThingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPrincipalThings( + listPrincipalThings( args: ListPrincipalThingsCommandInput, cb: (err: any, data?: ListPrincipalThingsCommandOutput) => void ): void; - public listPrincipalThings( + listPrincipalThings( args: ListPrincipalThingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPrincipalThingsCommandOutput) => void ): void; - public listPrincipalThings( - args: ListPrincipalThingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPrincipalThingsCommandOutput) => void), - cb?: (err: any, data?: ListPrincipalThingsCommandOutput) => void - ): Promise | void { - const command = new ListPrincipalThingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the provisioning templates in your Amazon Web Services account.

- *

Requires permission to access the ListProvisioningTemplates action.

- */ - public listProvisioningTemplates( + + /** + * @see {@link ListProvisioningTemplatesCommand} + */ + listProvisioningTemplates( args: ListProvisioningTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProvisioningTemplates( + listProvisioningTemplates( args: ListProvisioningTemplatesCommandInput, cb: (err: any, data?: ListProvisioningTemplatesCommandOutput) => void ): void; - public listProvisioningTemplates( + listProvisioningTemplates( args: ListProvisioningTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProvisioningTemplatesCommandOutput) => void ): void; - public listProvisioningTemplates( - args: ListProvisioningTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProvisioningTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListProvisioningTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListProvisioningTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

A list of provisioning template versions.

- *

Requires permission to access the ListProvisioningTemplateVersions action.

- */ - public listProvisioningTemplateVersions( + + /** + * @see {@link ListProvisioningTemplateVersionsCommand} + */ + listProvisioningTemplateVersions( args: ListProvisioningTemplateVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProvisioningTemplateVersions( + listProvisioningTemplateVersions( args: ListProvisioningTemplateVersionsCommandInput, cb: (err: any, data?: ListProvisioningTemplateVersionsCommandOutput) => void ): void; - public listProvisioningTemplateVersions( + listProvisioningTemplateVersions( args: ListProvisioningTemplateVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProvisioningTemplateVersionsCommandOutput) => void ): void; - public listProvisioningTemplateVersions( - args: ListProvisioningTemplateVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProvisioningTemplateVersionsCommandOutput) => void), - cb?: (err: any, data?: ListProvisioningTemplateVersionsCommandOutput) => void - ): Promise | void { - const command = new ListProvisioningTemplateVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

The related resources of an Audit finding. - * The following resources can be returned from calling this API:

- *
    - *
  • - *

    DEVICE_CERTIFICATE

    - *
  • - *
  • - *

    CA_CERTIFICATE

    - *
  • - *
  • - *

    IOT_POLICY

    - *
  • - *
  • - *

    COGNITO_IDENTITY_POOL

    - *
  • - *
  • - *

    CLIENT_ID

    - *
  • - *
  • - *

    ACCOUNT_SETTINGS

    - *
  • - *
  • - *

    ROLE_ALIAS

    - *
  • - *
  • - *

    IAM_ROLE

    - *
  • - *
  • - *

    ISSUER_CERTIFICATE

    - *
  • - *
- * - *

This API is similar to DescribeAuditFinding's RelatedResources - * but provides pagination and is not limited to 10 resources. - * When calling DescribeAuditFinding for the intermediate CA revoked for - * active device certificates check, RelatedResources will not be populated. You must use this API, ListRelatedResourcesForAuditFinding, to list the certificates.

- *
- */ - public listRelatedResourcesForAuditFinding( + + /** + * @see {@link ListRelatedResourcesForAuditFindingCommand} + */ + listRelatedResourcesForAuditFinding( args: ListRelatedResourcesForAuditFindingCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRelatedResourcesForAuditFinding( + listRelatedResourcesForAuditFinding( args: ListRelatedResourcesForAuditFindingCommandInput, cb: (err: any, data?: ListRelatedResourcesForAuditFindingCommandOutput) => void ): void; - public listRelatedResourcesForAuditFinding( + listRelatedResourcesForAuditFinding( args: ListRelatedResourcesForAuditFindingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRelatedResourcesForAuditFindingCommandOutput) => void ): void; - public listRelatedResourcesForAuditFinding( - args: ListRelatedResourcesForAuditFindingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRelatedResourcesForAuditFindingCommandOutput) => void), - cb?: (err: any, data?: ListRelatedResourcesForAuditFindingCommandOutput) => void - ): Promise | void { - const command = new ListRelatedResourcesForAuditFindingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the role aliases registered in your account.

- *

Requires permission to access the ListRoleAliases action.

- */ - public listRoleAliases( + + /** + * @see {@link ListRoleAliasesCommand} + */ + listRoleAliases( args: ListRoleAliasesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRoleAliases( - args: ListRoleAliasesCommandInput, - cb: (err: any, data?: ListRoleAliasesCommandOutput) => void - ): void; - public listRoleAliases( + listRoleAliases(args: ListRoleAliasesCommandInput, cb: (err: any, data?: ListRoleAliasesCommandOutput) => void): void; + listRoleAliases( args: ListRoleAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRoleAliasesCommandOutput) => void ): void; - public listRoleAliases( - args: ListRoleAliasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRoleAliasesCommandOutput) => void), - cb?: (err: any, data?: ListRoleAliasesCommandOutput) => void - ): Promise | void { - const command = new ListRoleAliasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all of your scheduled audits.

- *

Requires permission to access the ListScheduledAudits action.

- */ - public listScheduledAudits( + + /** + * @see {@link ListScheduledAuditsCommand} + */ + listScheduledAudits( args: ListScheduledAuditsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listScheduledAudits( + listScheduledAudits( args: ListScheduledAuditsCommandInput, cb: (err: any, data?: ListScheduledAuditsCommandOutput) => void ): void; - public listScheduledAudits( + listScheduledAudits( args: ListScheduledAuditsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListScheduledAuditsCommandOutput) => void ): void; - public listScheduledAudits( - args: ListScheduledAuditsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListScheduledAuditsCommandOutput) => void), - cb?: (err: any, data?: ListScheduledAuditsCommandOutput) => void - ): Promise | void { - const command = new ListScheduledAuditsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the Device Defender security profiles - * you've - * created. You can filter security profiles by dimension or custom metric.

- *

Requires permission to access the ListSecurityProfiles action.

- * - *

- * dimensionName and metricName cannot be used in the same request.

- *
- */ - public listSecurityProfiles( + + /** + * @see {@link ListSecurityProfilesCommand} + */ + listSecurityProfiles( args: ListSecurityProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSecurityProfiles( + listSecurityProfiles( args: ListSecurityProfilesCommandInput, cb: (err: any, data?: ListSecurityProfilesCommandOutput) => void ): void; - public listSecurityProfiles( + listSecurityProfiles( args: ListSecurityProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSecurityProfilesCommandOutput) => void ): void; - public listSecurityProfiles( - args: ListSecurityProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSecurityProfilesCommandOutput) => void), - cb?: (err: any, data?: ListSecurityProfilesCommandOutput) => void - ): Promise | void { - const command = new ListSecurityProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the Device Defender security profiles attached to a target (thing group).

- *

Requires permission to access the ListSecurityProfilesForTarget action.

- */ - public listSecurityProfilesForTarget( + + /** + * @see {@link ListSecurityProfilesForTargetCommand} + */ + listSecurityProfilesForTarget( args: ListSecurityProfilesForTargetCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSecurityProfilesForTarget( + listSecurityProfilesForTarget( args: ListSecurityProfilesForTargetCommandInput, cb: (err: any, data?: ListSecurityProfilesForTargetCommandOutput) => void ): void; - public listSecurityProfilesForTarget( + listSecurityProfilesForTarget( args: ListSecurityProfilesForTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSecurityProfilesForTargetCommandOutput) => void ): void; - public listSecurityProfilesForTarget( - args: ListSecurityProfilesForTargetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSecurityProfilesForTargetCommandOutput) => void), - cb?: (err: any, data?: ListSecurityProfilesForTargetCommandOutput) => void - ): Promise | void { - const command = new ListSecurityProfilesForTargetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all of the streams in your Amazon Web Services account.

- *

Requires permission to access the ListStreams action.

- */ - public listStreams(args: ListStreamsCommandInput, options?: __HttpHandlerOptions): Promise; - public listStreams(args: ListStreamsCommandInput, cb: (err: any, data?: ListStreamsCommandOutput) => void): void; - public listStreams( + + /** + * @see {@link ListStreamsCommand} + */ + listStreams(args: ListStreamsCommandInput, options?: __HttpHandlerOptions): Promise; + listStreams(args: ListStreamsCommandInput, cb: (err: any, data?: ListStreamsCommandOutput) => void): void; + listStreams( args: ListStreamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamsCommandOutput) => void ): void; - public listStreams( - args: ListStreamsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStreamsCommandOutput) => void), - cb?: (err: any, data?: ListStreamsCommandOutput) => void - ): Promise | void { - const command = new ListStreamsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the tags (metadata) you have assigned to the resource.

- *

Requires permission to access the ListTagsForResource action.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List targets for the specified policy.

- *

Requires permission to access the ListTargetsForPolicy action.

- */ - public listTargetsForPolicy( + + /** + * @see {@link ListTargetsForPolicyCommand} + */ + listTargetsForPolicy( args: ListTargetsForPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTargetsForPolicy( + listTargetsForPolicy( args: ListTargetsForPolicyCommandInput, cb: (err: any, data?: ListTargetsForPolicyCommandOutput) => void ): void; - public listTargetsForPolicy( + listTargetsForPolicy( args: ListTargetsForPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTargetsForPolicyCommandOutput) => void ): void; - public listTargetsForPolicy( - args: ListTargetsForPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTargetsForPolicyCommandOutput) => void), - cb?: (err: any, data?: ListTargetsForPolicyCommandOutput) => void - ): Promise | void { - const command = new ListTargetsForPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the targets (thing groups) associated with a given Device Defender security profile.

- *

Requires permission to access the ListTargetsForSecurityProfile action.

- */ - public listTargetsForSecurityProfile( + + /** + * @see {@link ListTargetsForSecurityProfileCommand} + */ + listTargetsForSecurityProfile( args: ListTargetsForSecurityProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTargetsForSecurityProfile( + listTargetsForSecurityProfile( args: ListTargetsForSecurityProfileCommandInput, cb: (err: any, data?: ListTargetsForSecurityProfileCommandOutput) => void ): void; - public listTargetsForSecurityProfile( + listTargetsForSecurityProfile( args: ListTargetsForSecurityProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTargetsForSecurityProfileCommandOutput) => void ): void; - public listTargetsForSecurityProfile( - args: ListTargetsForSecurityProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTargetsForSecurityProfileCommandOutput) => void), - cb?: (err: any, data?: ListTargetsForSecurityProfileCommandOutput) => void - ): Promise | void { - const command = new ListTargetsForSecurityProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List the thing groups in your account.

- *

Requires permission to access the ListThingGroups action.

- */ - public listThingGroups( + + /** + * @see {@link ListThingGroupsCommand} + */ + listThingGroups( args: ListThingGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listThingGroups( - args: ListThingGroupsCommandInput, - cb: (err: any, data?: ListThingGroupsCommandOutput) => void - ): void; - public listThingGroups( + listThingGroups(args: ListThingGroupsCommandInput, cb: (err: any, data?: ListThingGroupsCommandOutput) => void): void; + listThingGroups( args: ListThingGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListThingGroupsCommandOutput) => void ): void; - public listThingGroups( - args: ListThingGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListThingGroupsCommandOutput) => void), - cb?: (err: any, data?: ListThingGroupsCommandOutput) => void - ): Promise | void { - const command = new ListThingGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List the thing groups to which the specified thing belongs.

- *

Requires permission to access the ListThingGroupsForThing action.

- */ - public listThingGroupsForThing( + + /** + * @see {@link ListThingGroupsForThingCommand} + */ + listThingGroupsForThing( args: ListThingGroupsForThingCommandInput, options?: __HttpHandlerOptions ): Promise; - public listThingGroupsForThing( + listThingGroupsForThing( args: ListThingGroupsForThingCommandInput, cb: (err: any, data?: ListThingGroupsForThingCommandOutput) => void ): void; - public listThingGroupsForThing( + listThingGroupsForThing( args: ListThingGroupsForThingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListThingGroupsForThingCommandOutput) => void ): void; - public listThingGroupsForThing( - args: ListThingGroupsForThingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListThingGroupsForThingCommandOutput) => void), - cb?: (err: any, data?: ListThingGroupsForThingCommandOutput) => void - ): Promise | void { - const command = new ListThingGroupsForThingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the principals associated with the specified thing. A principal can be X.509 - * certificates, IAM users, groups, and roles, Amazon Cognito identities or federated - * identities.

- *

Requires permission to access the ListThingPrincipals action.

- */ - public listThingPrincipals( + + /** + * @see {@link ListThingPrincipalsCommand} + */ + listThingPrincipals( args: ListThingPrincipalsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listThingPrincipals( + listThingPrincipals( args: ListThingPrincipalsCommandInput, cb: (err: any, data?: ListThingPrincipalsCommandOutput) => void ): void; - public listThingPrincipals( + listThingPrincipals( args: ListThingPrincipalsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListThingPrincipalsCommandOutput) => void ): void; - public listThingPrincipals( - args: ListThingPrincipalsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListThingPrincipalsCommandOutput) => void), - cb?: (err: any, data?: ListThingPrincipalsCommandOutput) => void - ): Promise | void { - const command = new ListThingPrincipalsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Information about the thing registration tasks.

- */ - public listThingRegistrationTaskReports( + + /** + * @see {@link ListThingRegistrationTaskReportsCommand} + */ + listThingRegistrationTaskReports( args: ListThingRegistrationTaskReportsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listThingRegistrationTaskReports( + listThingRegistrationTaskReports( args: ListThingRegistrationTaskReportsCommandInput, cb: (err: any, data?: ListThingRegistrationTaskReportsCommandOutput) => void ): void; - public listThingRegistrationTaskReports( + listThingRegistrationTaskReports( args: ListThingRegistrationTaskReportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListThingRegistrationTaskReportsCommandOutput) => void ): void; - public listThingRegistrationTaskReports( - args: ListThingRegistrationTaskReportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListThingRegistrationTaskReportsCommandOutput) => void), - cb?: (err: any, data?: ListThingRegistrationTaskReportsCommandOutput) => void - ): Promise | void { - const command = new ListThingRegistrationTaskReportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List bulk thing provisioning tasks.

- *

Requires permission to access the ListThingRegistrationTasks action.

- */ - public listThingRegistrationTasks( + + /** + * @see {@link ListThingRegistrationTasksCommand} + */ + listThingRegistrationTasks( args: ListThingRegistrationTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listThingRegistrationTasks( + listThingRegistrationTasks( args: ListThingRegistrationTasksCommandInput, cb: (err: any, data?: ListThingRegistrationTasksCommandOutput) => void ): void; - public listThingRegistrationTasks( + listThingRegistrationTasks( args: ListThingRegistrationTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListThingRegistrationTasksCommandOutput) => void ): void; - public listThingRegistrationTasks( - args: ListThingRegistrationTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListThingRegistrationTasksCommandOutput) => void), - cb?: (err: any, data?: ListThingRegistrationTasksCommandOutput) => void - ): Promise | void { - const command = new ListThingRegistrationTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, - * calling ListThings with attributeName=Color and attributeValue=Red - * retrieves all things in the registry that contain an attribute Color with the value Red. For more - * information, see List Things from the Amazon Web Services IoT Core Developer - * Guide.

- *

Requires permission to access the ListThings action.

- * - *

You will not be charged for calling this API if an Access denied error is returned. You will also not be charged if no attributes or pagination token was provided in request and no pagination token and no results were returned.

- *
- */ - public listThings(args: ListThingsCommandInput, options?: __HttpHandlerOptions): Promise; - public listThings(args: ListThingsCommandInput, cb: (err: any, data?: ListThingsCommandOutput) => void): void; - public listThings( + + /** + * @see {@link ListThingsCommand} + */ + listThings(args: ListThingsCommandInput, options?: __HttpHandlerOptions): Promise; + listThings(args: ListThingsCommandInput, cb: (err: any, data?: ListThingsCommandOutput) => void): void; + listThings( args: ListThingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListThingsCommandOutput) => void ): void; - public listThings( - args: ListThingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListThingsCommandOutput) => void), - cb?: (err: any, data?: ListThingsCommandOutput) => void - ): Promise | void { - const command = new ListThingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the things you have added to the given billing group.

- *

Requires permission to access the ListThingsInBillingGroup action.

- */ - public listThingsInBillingGroup( + + /** + * @see {@link ListThingsInBillingGroupCommand} + */ + listThingsInBillingGroup( args: ListThingsInBillingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public listThingsInBillingGroup( + listThingsInBillingGroup( args: ListThingsInBillingGroupCommandInput, cb: (err: any, data?: ListThingsInBillingGroupCommandOutput) => void ): void; - public listThingsInBillingGroup( + listThingsInBillingGroup( args: ListThingsInBillingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListThingsInBillingGroupCommandOutput) => void ): void; - public listThingsInBillingGroup( - args: ListThingsInBillingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListThingsInBillingGroupCommandOutput) => void), - cb?: (err: any, data?: ListThingsInBillingGroupCommandOutput) => void - ): Promise | void { - const command = new ListThingsInBillingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the things in the specified group.

- *

Requires permission to access the ListThingsInThingGroup action.

- */ - public listThingsInThingGroup( + + /** + * @see {@link ListThingsInThingGroupCommand} + */ + listThingsInThingGroup( args: ListThingsInThingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public listThingsInThingGroup( + listThingsInThingGroup( args: ListThingsInThingGroupCommandInput, cb: (err: any, data?: ListThingsInThingGroupCommandOutput) => void ): void; - public listThingsInThingGroup( + listThingsInThingGroup( args: ListThingsInThingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListThingsInThingGroupCommandOutput) => void ): void; - public listThingsInThingGroup( - args: ListThingsInThingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListThingsInThingGroupCommandOutput) => void), - cb?: (err: any, data?: ListThingsInThingGroupCommandOutput) => void - ): Promise | void { - const command = new ListThingsInThingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the existing thing types.

- *

Requires permission to access the ListThingTypes action.

- */ - public listThingTypes( + + /** + * @see {@link ListThingTypesCommand} + */ + listThingTypes( args: ListThingTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listThingTypes( - args: ListThingTypesCommandInput, - cb: (err: any, data?: ListThingTypesCommandOutput) => void - ): void; - public listThingTypes( + listThingTypes(args: ListThingTypesCommandInput, cb: (err: any, data?: ListThingTypesCommandOutput) => void): void; + listThingTypes( args: ListThingTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListThingTypesCommandOutput) => void ): void; - public listThingTypes( - args: ListThingTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListThingTypesCommandOutput) => void), - cb?: (err: any, data?: ListThingTypesCommandOutput) => void - ): Promise | void { - const command = new ListThingTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all the topic rule destinations in your Amazon Web Services account.

- *

Requires permission to access the ListTopicRuleDestinations action.

- */ - public listTopicRuleDestinations( + + /** + * @see {@link ListTopicRuleDestinationsCommand} + */ + listTopicRuleDestinations( args: ListTopicRuleDestinationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTopicRuleDestinations( + listTopicRuleDestinations( args: ListTopicRuleDestinationsCommandInput, cb: (err: any, data?: ListTopicRuleDestinationsCommandOutput) => void ): void; - public listTopicRuleDestinations( + listTopicRuleDestinations( args: ListTopicRuleDestinationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTopicRuleDestinationsCommandOutput) => void ): void; - public listTopicRuleDestinations( - args: ListTopicRuleDestinationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTopicRuleDestinationsCommandOutput) => void), - cb?: (err: any, data?: ListTopicRuleDestinationsCommandOutput) => void - ): Promise | void { - const command = new ListTopicRuleDestinationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the rules for the specific topic.

- *

Requires permission to access the ListTopicRules action.

- */ - public listTopicRules( + + /** + * @see {@link ListTopicRulesCommand} + */ + listTopicRules( args: ListTopicRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTopicRules( - args: ListTopicRulesCommandInput, - cb: (err: any, data?: ListTopicRulesCommandOutput) => void - ): void; - public listTopicRules( + listTopicRules(args: ListTopicRulesCommandInput, cb: (err: any, data?: ListTopicRulesCommandOutput) => void): void; + listTopicRules( args: ListTopicRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTopicRulesCommandOutput) => void ): void; - public listTopicRules( - args: ListTopicRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTopicRulesCommandOutput) => void), - cb?: (err: any, data?: ListTopicRulesCommandOutput) => void - ): Promise | void { - const command = new ListTopicRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists logging levels.

- *

Requires permission to access the ListV2LoggingLevels action.

- */ - public listV2LoggingLevels( + + /** + * @see {@link ListV2LoggingLevelsCommand} + */ + listV2LoggingLevels( args: ListV2LoggingLevelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listV2LoggingLevels( + listV2LoggingLevels( args: ListV2LoggingLevelsCommandInput, cb: (err: any, data?: ListV2LoggingLevelsCommandOutput) => void ): void; - public listV2LoggingLevels( + listV2LoggingLevels( args: ListV2LoggingLevelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListV2LoggingLevelsCommandOutput) => void ): void; - public listV2LoggingLevels( - args: ListV2LoggingLevelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListV2LoggingLevelsCommandOutput) => void), - cb?: (err: any, data?: ListV2LoggingLevelsCommandOutput) => void - ): Promise | void { - const command = new ListV2LoggingLevelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the Device Defender security profile violations discovered during the given time period. - * You can use filters to limit the results to those alerts issued for a particular security profile, - * behavior, or thing (device).

- *

Requires permission to access the ListViolationEvents action.

- */ - public listViolationEvents( + + /** + * @see {@link ListViolationEventsCommand} + */ + listViolationEvents( args: ListViolationEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listViolationEvents( + listViolationEvents( args: ListViolationEventsCommandInput, cb: (err: any, data?: ListViolationEventsCommandOutput) => void ): void; - public listViolationEvents( + listViolationEvents( args: ListViolationEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListViolationEventsCommandOutput) => void ): void; - public listViolationEvents( - args: ListViolationEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListViolationEventsCommandOutput) => void), - cb?: (err: any, data?: ListViolationEventsCommandOutput) => void - ): Promise | void { - const command = new ListViolationEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Set a verification state and provide a description of that verification state on a violation (detect alarm).

- */ - public putVerificationStateOnViolation( + + /** + * @see {@link PutVerificationStateOnViolationCommand} + */ + putVerificationStateOnViolation( args: PutVerificationStateOnViolationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putVerificationStateOnViolation( + putVerificationStateOnViolation( args: PutVerificationStateOnViolationCommandInput, cb: (err: any, data?: PutVerificationStateOnViolationCommandOutput) => void ): void; - public putVerificationStateOnViolation( + putVerificationStateOnViolation( args: PutVerificationStateOnViolationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutVerificationStateOnViolationCommandOutput) => void ): void; - public putVerificationStateOnViolation( - args: PutVerificationStateOnViolationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutVerificationStateOnViolationCommandOutput) => void), - cb?: (err: any, data?: PutVerificationStateOnViolationCommandOutput) => void - ): Promise | void { - const command = new PutVerificationStateOnViolationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers a CA certificate with Amazon Web Services IoT Core. There is no limit to the number of CA - * certificates you can register in your Amazon Web Services account. You can register up to 10 CA - * certificates with the same CA subject field per Amazon Web Services account.

- *

Requires permission to access the RegisterCACertificate action.

- */ - public registerCACertificate( + + /** + * @see {@link RegisterCACertificateCommand} + */ + registerCACertificate( args: RegisterCACertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerCACertificate( + registerCACertificate( args: RegisterCACertificateCommandInput, cb: (err: any, data?: RegisterCACertificateCommandOutput) => void ): void; - public registerCACertificate( + registerCACertificate( args: RegisterCACertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterCACertificateCommandOutput) => void ): void; - public registerCACertificate( - args: RegisterCACertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterCACertificateCommandOutput) => void), - cb?: (err: any, data?: RegisterCACertificateCommandOutput) => void - ): Promise | void { - const command = new RegisterCACertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers a device certificate with IoT in the same certificate mode as the signing CA. If you have more than one CA certificate that has the same subject field, you must - * specify the CA certificate that was used to sign the device certificate being - * registered.

- *

Requires permission to access the RegisterCertificate action.

- */ - public registerCertificate( + + /** + * @see {@link RegisterCertificateCommand} + */ + registerCertificate( args: RegisterCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerCertificate( + registerCertificate( args: RegisterCertificateCommandInput, cb: (err: any, data?: RegisterCertificateCommandOutput) => void ): void; - public registerCertificate( + registerCertificate( args: RegisterCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterCertificateCommandOutput) => void ): void; - public registerCertificate( - args: RegisterCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterCertificateCommandOutput) => void), - cb?: (err: any, data?: RegisterCertificateCommandOutput) => void - ): Promise | void { - const command = new RegisterCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Register a certificate that does not have a certificate authority (CA). - * For supported certificates, consult - * Certificate signing algorithms supported by IoT. - *

- */ - public registerCertificateWithoutCA( + + /** + * @see {@link RegisterCertificateWithoutCACommand} + */ + registerCertificateWithoutCA( args: RegisterCertificateWithoutCACommandInput, options?: __HttpHandlerOptions ): Promise; - public registerCertificateWithoutCA( + registerCertificateWithoutCA( args: RegisterCertificateWithoutCACommandInput, cb: (err: any, data?: RegisterCertificateWithoutCACommandOutput) => void ): void; - public registerCertificateWithoutCA( + registerCertificateWithoutCA( args: RegisterCertificateWithoutCACommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterCertificateWithoutCACommandOutput) => void ): void; - public registerCertificateWithoutCA( - args: RegisterCertificateWithoutCACommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterCertificateWithoutCACommandOutput) => void), - cb?: (err: any, data?: RegisterCertificateWithoutCACommandOutput) => void - ): Promise | void { - const command = new RegisterCertificateWithoutCACommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provisions a thing in the device registry. RegisterThing calls other IoT control - * plane APIs. These calls might exceed your account level - * IoT Throttling Limits and cause throttle errors. Please contact Amazon Web Services Customer Support to raise - * your throttling limits if necessary.

- *

Requires permission to access the RegisterThing action.

- */ - public registerThing( - args: RegisterThingCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public registerThing( - args: RegisterThingCommandInput, - cb: (err: any, data?: RegisterThingCommandOutput) => void - ): void; - public registerThing( + + /** + * @see {@link RegisterThingCommand} + */ + registerThing(args: RegisterThingCommandInput, options?: __HttpHandlerOptions): Promise; + registerThing(args: RegisterThingCommandInput, cb: (err: any, data?: RegisterThingCommandOutput) => void): void; + registerThing( args: RegisterThingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterThingCommandOutput) => void ): void; - public registerThing( - args: RegisterThingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterThingCommandOutput) => void), - cb?: (err: any, data?: RegisterThingCommandOutput) => void - ): Promise | void { - const command = new RegisterThingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Rejects a pending certificate transfer. After IoT rejects a certificate transfer, - * the certificate status changes from PENDING_TRANSFER to - * INACTIVE.

- *

To check for pending certificate transfers, call ListCertificates - * to enumerate your certificates.

- *

This operation can only be called by the transfer destination. After it is called, - * the certificate will be returned to the source's account in the INACTIVE state.

- *

Requires permission to access the RejectCertificateTransfer action.

- */ - public rejectCertificateTransfer( + + /** + * @see {@link RejectCertificateTransferCommand} + */ + rejectCertificateTransfer( args: RejectCertificateTransferCommandInput, options?: __HttpHandlerOptions ): Promise; - public rejectCertificateTransfer( + rejectCertificateTransfer( args: RejectCertificateTransferCommandInput, cb: (err: any, data?: RejectCertificateTransferCommandOutput) => void ): void; - public rejectCertificateTransfer( + rejectCertificateTransfer( args: RejectCertificateTransferCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectCertificateTransferCommandOutput) => void ): void; - public rejectCertificateTransfer( - args: RejectCertificateTransferCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RejectCertificateTransferCommandOutput) => void), - cb?: (err: any, data?: RejectCertificateTransferCommandOutput) => void - ): Promise | void { - const command = new RejectCertificateTransferCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the given thing from the billing group.

- *

Requires permission to access the RemoveThingFromBillingGroup action.

- * - *

This call is asynchronous. It might take several seconds for the detachment to propagate.

- *
- */ - public removeThingFromBillingGroup( + + /** + * @see {@link RemoveThingFromBillingGroupCommand} + */ + removeThingFromBillingGroup( args: RemoveThingFromBillingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeThingFromBillingGroup( + removeThingFromBillingGroup( args: RemoveThingFromBillingGroupCommandInput, cb: (err: any, data?: RemoveThingFromBillingGroupCommandOutput) => void ): void; - public removeThingFromBillingGroup( + removeThingFromBillingGroup( args: RemoveThingFromBillingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveThingFromBillingGroupCommandOutput) => void ): void; - public removeThingFromBillingGroup( - args: RemoveThingFromBillingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveThingFromBillingGroupCommandOutput) => void), - cb?: (err: any, data?: RemoveThingFromBillingGroupCommandOutput) => void - ): Promise | void { - const command = new RemoveThingFromBillingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Remove the specified thing from the specified group.

- *

You must specify either a thingGroupArn or a - * thingGroupName to identify the thing group and - * either a thingArn or a thingName to - * identify the thing to remove from the thing group. - *

- *

Requires permission to access the RemoveThingFromThingGroup action.

- */ - public removeThingFromThingGroup( + + /** + * @see {@link RemoveThingFromThingGroupCommand} + */ + removeThingFromThingGroup( args: RemoveThingFromThingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeThingFromThingGroup( + removeThingFromThingGroup( args: RemoveThingFromThingGroupCommandInput, cb: (err: any, data?: RemoveThingFromThingGroupCommandOutput) => void ): void; - public removeThingFromThingGroup( + removeThingFromThingGroup( args: RemoveThingFromThingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveThingFromThingGroupCommandOutput) => void ): void; - public removeThingFromThingGroup( - args: RemoveThingFromThingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveThingFromThingGroupCommandOutput) => void), - cb?: (err: any, data?: RemoveThingFromThingGroupCommandOutput) => void - ): Promise | void { - const command = new RemoveThingFromThingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Replaces the rule. You must specify all parameters for the new rule. Creating rules - * is an administrator-level action. Any user who has permission to create rules will be able - * to access data processed by the rule.

- *

Requires permission to access the ReplaceTopicRule action.

- */ - public replaceTopicRule( + + /** + * @see {@link ReplaceTopicRuleCommand} + */ + replaceTopicRule( args: ReplaceTopicRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public replaceTopicRule( + replaceTopicRule( args: ReplaceTopicRuleCommandInput, cb: (err: any, data?: ReplaceTopicRuleCommandOutput) => void ): void; - public replaceTopicRule( + replaceTopicRule( args: ReplaceTopicRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReplaceTopicRuleCommandOutput) => void ): void; - public replaceTopicRule( - args: ReplaceTopicRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReplaceTopicRuleCommandOutput) => void), - cb?: (err: any, data?: ReplaceTopicRuleCommandOutput) => void - ): Promise | void { - const command = new ReplaceTopicRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

The query search index.

- *

Requires permission to access the SearchIndex action.

- */ - public searchIndex(args: SearchIndexCommandInput, options?: __HttpHandlerOptions): Promise; - public searchIndex(args: SearchIndexCommandInput, cb: (err: any, data?: SearchIndexCommandOutput) => void): void; - public searchIndex( + + /** + * @see {@link SearchIndexCommand} + */ + searchIndex(args: SearchIndexCommandInput, options?: __HttpHandlerOptions): Promise; + searchIndex(args: SearchIndexCommandInput, cb: (err: any, data?: SearchIndexCommandOutput) => void): void; + searchIndex( args: SearchIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchIndexCommandOutput) => void ): void; - public searchIndex( - args: SearchIndexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchIndexCommandOutput) => void), - cb?: (err: any, data?: SearchIndexCommandOutput) => void - ): Promise | void { - const command = new SearchIndexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the default authorizer. This will be used if a websocket connection is made - * without specifying an authorizer.

- *

Requires permission to access the SetDefaultAuthorizer action.

- */ - public setDefaultAuthorizer( + + /** + * @see {@link SetDefaultAuthorizerCommand} + */ + setDefaultAuthorizer( args: SetDefaultAuthorizerCommandInput, options?: __HttpHandlerOptions ): Promise; - public setDefaultAuthorizer( + setDefaultAuthorizer( args: SetDefaultAuthorizerCommandInput, cb: (err: any, data?: SetDefaultAuthorizerCommandOutput) => void ): void; - public setDefaultAuthorizer( + setDefaultAuthorizer( args: SetDefaultAuthorizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetDefaultAuthorizerCommandOutput) => void ): void; - public setDefaultAuthorizer( - args: SetDefaultAuthorizerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetDefaultAuthorizerCommandOutput) => void), - cb?: (err: any, data?: SetDefaultAuthorizerCommandOutput) => void - ): Promise | void { - const command = new SetDefaultAuthorizerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the specified version of the specified policy as the policy's default - * (operative) version. This action affects all certificates to which the policy is attached. - * To list the principals the policy is attached to, use the ListPrincipalPolicies - * action.

- *

Requires permission to access the SetDefaultPolicyVersion action.

- */ - public setDefaultPolicyVersion( + + /** + * @see {@link SetDefaultPolicyVersionCommand} + */ + setDefaultPolicyVersion( args: SetDefaultPolicyVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public setDefaultPolicyVersion( + setDefaultPolicyVersion( args: SetDefaultPolicyVersionCommandInput, cb: (err: any, data?: SetDefaultPolicyVersionCommandOutput) => void ): void; - public setDefaultPolicyVersion( + setDefaultPolicyVersion( args: SetDefaultPolicyVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetDefaultPolicyVersionCommandOutput) => void ): void; - public setDefaultPolicyVersion( - args: SetDefaultPolicyVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetDefaultPolicyVersionCommandOutput) => void), - cb?: (err: any, data?: SetDefaultPolicyVersionCommandOutput) => void - ): Promise | void { - const command = new SetDefaultPolicyVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the logging options.

- *

NOTE: use of this command is not recommended. Use SetV2LoggingOptions - * instead.

- *

Requires permission to access the SetLoggingOptions action.

- */ - public setLoggingOptions( + + /** + * @see {@link SetLoggingOptionsCommand} + */ + setLoggingOptions( args: SetLoggingOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public setLoggingOptions( + setLoggingOptions( args: SetLoggingOptionsCommandInput, cb: (err: any, data?: SetLoggingOptionsCommandOutput) => void ): void; - public setLoggingOptions( + setLoggingOptions( args: SetLoggingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetLoggingOptionsCommandOutput) => void ): void; - public setLoggingOptions( - args: SetLoggingOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetLoggingOptionsCommandOutput) => void), - cb?: (err: any, data?: SetLoggingOptionsCommandOutput) => void - ): Promise | void { - const command = new SetLoggingOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the logging level.

- *

Requires permission to access the SetV2LoggingLevel action.

- */ - public setV2LoggingLevel( + + /** + * @see {@link SetV2LoggingLevelCommand} + */ + setV2LoggingLevel( args: SetV2LoggingLevelCommandInput, options?: __HttpHandlerOptions ): Promise; - public setV2LoggingLevel( + setV2LoggingLevel( args: SetV2LoggingLevelCommandInput, cb: (err: any, data?: SetV2LoggingLevelCommandOutput) => void ): void; - public setV2LoggingLevel( + setV2LoggingLevel( args: SetV2LoggingLevelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetV2LoggingLevelCommandOutput) => void ): void; - public setV2LoggingLevel( - args: SetV2LoggingLevelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetV2LoggingLevelCommandOutput) => void), - cb?: (err: any, data?: SetV2LoggingLevelCommandOutput) => void - ): Promise | void { - const command = new SetV2LoggingLevelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the logging options for the V2 logging service.

- *

Requires permission to access the SetV2LoggingOptions action.

- */ - public setV2LoggingOptions( + + /** + * @see {@link SetV2LoggingOptionsCommand} + */ + setV2LoggingOptions( args: SetV2LoggingOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public setV2LoggingOptions( + setV2LoggingOptions( args: SetV2LoggingOptionsCommandInput, cb: (err: any, data?: SetV2LoggingOptionsCommandOutput) => void ): void; - public setV2LoggingOptions( + setV2LoggingOptions( args: SetV2LoggingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetV2LoggingOptionsCommandOutput) => void ): void; - public setV2LoggingOptions( - args: SetV2LoggingOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetV2LoggingOptionsCommandOutput) => void), - cb?: (err: any, data?: SetV2LoggingOptionsCommandOutput) => void - ): Promise | void { - const command = new SetV2LoggingOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a task that applies a set of mitigation actions to the specified target.

- *

Requires permission to access the StartAuditMitigationActionsTask action.

- */ - public startAuditMitigationActionsTask( + + /** + * @see {@link StartAuditMitigationActionsTaskCommand} + */ + startAuditMitigationActionsTask( args: StartAuditMitigationActionsTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public startAuditMitigationActionsTask( + startAuditMitigationActionsTask( args: StartAuditMitigationActionsTaskCommandInput, cb: (err: any, data?: StartAuditMitigationActionsTaskCommandOutput) => void ): void; - public startAuditMitigationActionsTask( + startAuditMitigationActionsTask( args: StartAuditMitigationActionsTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartAuditMitigationActionsTaskCommandOutput) => void ): void; - public startAuditMitigationActionsTask( - args: StartAuditMitigationActionsTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartAuditMitigationActionsTaskCommandOutput) => void), - cb?: (err: any, data?: StartAuditMitigationActionsTaskCommandOutput) => void - ): Promise | void { - const command = new StartAuditMitigationActionsTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Starts a Device Defender ML Detect mitigation actions task. - *

- *

Requires permission to access the StartDetectMitigationActionsTask action.

- */ - public startDetectMitigationActionsTask( + + /** + * @see {@link StartDetectMitigationActionsTaskCommand} + */ + startDetectMitigationActionsTask( args: StartDetectMitigationActionsTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDetectMitigationActionsTask( + startDetectMitigationActionsTask( args: StartDetectMitigationActionsTaskCommandInput, cb: (err: any, data?: StartDetectMitigationActionsTaskCommandOutput) => void ): void; - public startDetectMitigationActionsTask( + startDetectMitigationActionsTask( args: StartDetectMitigationActionsTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDetectMitigationActionsTaskCommandOutput) => void ): void; - public startDetectMitigationActionsTask( - args: StartDetectMitigationActionsTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDetectMitigationActionsTaskCommandOutput) => void), - cb?: (err: any, data?: StartDetectMitigationActionsTaskCommandOutput) => void - ): Promise | void { - const command = new StartDetectMitigationActionsTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts an on-demand Device Defender audit.

- *

Requires permission to access the StartOnDemandAuditTask action.

- */ - public startOnDemandAuditTask( + + /** + * @see {@link StartOnDemandAuditTaskCommand} + */ + startOnDemandAuditTask( args: StartOnDemandAuditTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public startOnDemandAuditTask( + startOnDemandAuditTask( args: StartOnDemandAuditTaskCommandInput, cb: (err: any, data?: StartOnDemandAuditTaskCommandOutput) => void ): void; - public startOnDemandAuditTask( + startOnDemandAuditTask( args: StartOnDemandAuditTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartOnDemandAuditTaskCommandOutput) => void ): void; - public startOnDemandAuditTask( - args: StartOnDemandAuditTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartOnDemandAuditTaskCommandOutput) => void), - cb?: (err: any, data?: StartOnDemandAuditTaskCommandOutput) => void - ): Promise | void { - const command = new StartOnDemandAuditTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a bulk thing provisioning task.

- *

Requires permission to access the StartThingRegistrationTask action.

- */ - public startThingRegistrationTask( + + /** + * @see {@link StartThingRegistrationTaskCommand} + */ + startThingRegistrationTask( args: StartThingRegistrationTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public startThingRegistrationTask( + startThingRegistrationTask( args: StartThingRegistrationTaskCommandInput, cb: (err: any, data?: StartThingRegistrationTaskCommandOutput) => void ): void; - public startThingRegistrationTask( + startThingRegistrationTask( args: StartThingRegistrationTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartThingRegistrationTaskCommandOutput) => void ): void; - public startThingRegistrationTask( - args: StartThingRegistrationTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartThingRegistrationTaskCommandOutput) => void), - cb?: (err: any, data?: StartThingRegistrationTaskCommandOutput) => void - ): Promise | void { - const command = new StartThingRegistrationTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels a bulk thing provisioning task.

- *

Requires permission to access the StopThingRegistrationTask action.

- */ - public stopThingRegistrationTask( + + /** + * @see {@link StopThingRegistrationTaskCommand} + */ + stopThingRegistrationTask( args: StopThingRegistrationTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopThingRegistrationTask( + stopThingRegistrationTask( args: StopThingRegistrationTaskCommandInput, cb: (err: any, data?: StopThingRegistrationTaskCommandOutput) => void ): void; - public stopThingRegistrationTask( + stopThingRegistrationTask( args: StopThingRegistrationTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopThingRegistrationTaskCommandOutput) => void ): void; - public stopThingRegistrationTask( - args: StopThingRegistrationTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopThingRegistrationTaskCommandOutput) => void), - cb?: (err: any, data?: StopThingRegistrationTaskCommandOutput) => void - ): Promise | void { - const command = new StopThingRegistrationTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds to or modifies the tags of the given resource. Tags are metadata which can be - * used to manage a resource.

- *

Requires permission to access the TagResource action.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Tests if a specified principal is authorized to perform an IoT action on a - * specified resource. Use this to test and debug the authorization behavior of devices that - * connect to the IoT device gateway.

- *

Requires permission to access the TestAuthorization action.

- */ - public testAuthorization( + + /** + * @see {@link TestAuthorizationCommand} + */ + testAuthorization( args: TestAuthorizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public testAuthorization( + testAuthorization( args: TestAuthorizationCommandInput, cb: (err: any, data?: TestAuthorizationCommandOutput) => void ): void; - public testAuthorization( + testAuthorization( args: TestAuthorizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestAuthorizationCommandOutput) => void ): void; - public testAuthorization( - args: TestAuthorizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestAuthorizationCommandOutput) => void), - cb?: (err: any, data?: TestAuthorizationCommandOutput) => void - ): Promise | void { - const command = new TestAuthorizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Tests a custom authorization behavior by invoking a specified custom authorizer. Use - * this to test and debug the custom authorization behavior of devices that connect to the IoT - * device gateway.

- *

Requires permission to access the TestInvokeAuthorizer action.

- */ - public testInvokeAuthorizer( + + /** + * @see {@link TestInvokeAuthorizerCommand} + */ + testInvokeAuthorizer( args: TestInvokeAuthorizerCommandInput, options?: __HttpHandlerOptions ): Promise; - public testInvokeAuthorizer( + testInvokeAuthorizer( args: TestInvokeAuthorizerCommandInput, cb: (err: any, data?: TestInvokeAuthorizerCommandOutput) => void ): void; - public testInvokeAuthorizer( + testInvokeAuthorizer( args: TestInvokeAuthorizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestInvokeAuthorizerCommandOutput) => void ): void; - public testInvokeAuthorizer( - args: TestInvokeAuthorizerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestInvokeAuthorizerCommandOutput) => void), - cb?: (err: any, data?: TestInvokeAuthorizerCommandOutput) => void - ): Promise | void { - const command = new TestInvokeAuthorizerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Transfers the specified certificate to the specified Amazon Web Services account.

- *

Requires permission to access the TransferCertificate action.

- *

You can cancel the transfer until it is acknowledged by the recipient.

- *

No notification is sent to the transfer destination's account. It is up to the caller - * to notify the transfer target.

- *

The certificate being transferred must not be in the ACTIVE state. You can use the - * UpdateCertificate action to deactivate it.

- *

The certificate must not have any policies attached to it. You can use the - * DetachPolicy action to detach them.

- */ - public transferCertificate( + + /** + * @see {@link TransferCertificateCommand} + */ + transferCertificate( args: TransferCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public transferCertificate( + transferCertificate( args: TransferCertificateCommandInput, cb: (err: any, data?: TransferCertificateCommandOutput) => void ): void; - public transferCertificate( + transferCertificate( args: TransferCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TransferCertificateCommandOutput) => void ): void; - public transferCertificate( - args: TransferCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TransferCertificateCommandOutput) => void), - cb?: (err: any, data?: TransferCertificateCommandOutput) => void - ): Promise | void { - const command = new TransferCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the given tags (metadata) from the resource.

- *

Requires permission to access the UntagResource action.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Configures or reconfigures the Device Defender audit settings for this account. - * Settings include how audit notifications are sent and which audit checks are - * enabled or disabled.

- *

Requires permission to access the UpdateAccountAuditConfiguration action.

- */ - public updateAccountAuditConfiguration( + + /** + * @see {@link UpdateAccountAuditConfigurationCommand} + */ + updateAccountAuditConfiguration( args: UpdateAccountAuditConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAccountAuditConfiguration( + updateAccountAuditConfiguration( args: UpdateAccountAuditConfigurationCommandInput, cb: (err: any, data?: UpdateAccountAuditConfigurationCommandOutput) => void ): void; - public updateAccountAuditConfiguration( + updateAccountAuditConfiguration( args: UpdateAccountAuditConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccountAuditConfigurationCommandOutput) => void ): void; - public updateAccountAuditConfiguration( - args: UpdateAccountAuditConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAccountAuditConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateAccountAuditConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateAccountAuditConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Updates a Device Defender audit suppression. - *

- */ - public updateAuditSuppression( + + /** + * @see {@link UpdateAuditSuppressionCommand} + */ + updateAuditSuppression( args: UpdateAuditSuppressionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAuditSuppression( + updateAuditSuppression( args: UpdateAuditSuppressionCommandInput, cb: (err: any, data?: UpdateAuditSuppressionCommandOutput) => void ): void; - public updateAuditSuppression( + updateAuditSuppression( args: UpdateAuditSuppressionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAuditSuppressionCommandOutput) => void ): void; - public updateAuditSuppression( - args: UpdateAuditSuppressionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAuditSuppressionCommandOutput) => void), - cb?: (err: any, data?: UpdateAuditSuppressionCommandOutput) => void - ): Promise | void { - const command = new UpdateAuditSuppressionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an authorizer.

- *

Requires permission to access the UpdateAuthorizer action.

- */ - public updateAuthorizer( + + /** + * @see {@link UpdateAuthorizerCommand} + */ + updateAuthorizer( args: UpdateAuthorizerCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAuthorizer( + updateAuthorizer( args: UpdateAuthorizerCommandInput, cb: (err: any, data?: UpdateAuthorizerCommandOutput) => void ): void; - public updateAuthorizer( + updateAuthorizer( args: UpdateAuthorizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAuthorizerCommandOutput) => void ): void; - public updateAuthorizer( - args: UpdateAuthorizerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAuthorizerCommandOutput) => void), - cb?: (err: any, data?: UpdateAuthorizerCommandOutput) => void - ): Promise | void { - const command = new UpdateAuthorizerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates information about the billing group.

- *

Requires permission to access the UpdateBillingGroup action.

- */ - public updateBillingGroup( + + /** + * @see {@link UpdateBillingGroupCommand} + */ + updateBillingGroup( args: UpdateBillingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBillingGroup( + updateBillingGroup( args: UpdateBillingGroupCommandInput, cb: (err: any, data?: UpdateBillingGroupCommandOutput) => void ): void; - public updateBillingGroup( + updateBillingGroup( args: UpdateBillingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBillingGroupCommandOutput) => void ): void; - public updateBillingGroup( - args: UpdateBillingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBillingGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateBillingGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateBillingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a registered CA certificate.

- *

Requires permission to access the UpdateCACertificate action.

- */ - public updateCACertificate( + + /** + * @see {@link UpdateCACertificateCommand} + */ + updateCACertificate( args: UpdateCACertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCACertificate( + updateCACertificate( args: UpdateCACertificateCommandInput, cb: (err: any, data?: UpdateCACertificateCommandOutput) => void ): void; - public updateCACertificate( + updateCACertificate( args: UpdateCACertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCACertificateCommandOutput) => void ): void; - public updateCACertificate( - args: UpdateCACertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCACertificateCommandOutput) => void), - cb?: (err: any, data?: UpdateCACertificateCommandOutput) => void - ): Promise | void { - const command = new UpdateCACertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the status of the specified certificate. This operation is - * idempotent.

- *

Requires permission to access the UpdateCertificate action.

- *

Certificates must be in the ACTIVE state to authenticate devices that use - * a certificate to connect to IoT.

- *

Within a few minutes of updating a certificate from the ACTIVE state to any other - * state, IoT disconnects all devices that used that certificate to connect. Devices cannot - * use a certificate that is not in the ACTIVE state to reconnect.

- */ - public updateCertificate( + + /** + * @see {@link UpdateCertificateCommand} + */ + updateCertificate( args: UpdateCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCertificate( + updateCertificate( args: UpdateCertificateCommandInput, cb: (err: any, data?: UpdateCertificateCommandOutput) => void ): void; - public updateCertificate( + updateCertificate( args: UpdateCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCertificateCommandOutput) => void ): void; - public updateCertificate( - args: UpdateCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCertificateCommandOutput) => void), - cb?: (err: any, data?: UpdateCertificateCommandOutput) => void - ): Promise | void { - const command = new UpdateCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a - * Device Defender detect custom metric.

- *

Requires permission to access the UpdateCustomMetric action.

- */ - public updateCustomMetric( + + /** + * @see {@link UpdateCustomMetricCommand} + */ + updateCustomMetric( args: UpdateCustomMetricCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCustomMetric( + updateCustomMetric( args: UpdateCustomMetricCommandInput, cb: (err: any, data?: UpdateCustomMetricCommandOutput) => void ): void; - public updateCustomMetric( + updateCustomMetric( args: UpdateCustomMetricCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCustomMetricCommandOutput) => void ): void; - public updateCustomMetric( - args: UpdateCustomMetricCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCustomMetricCommandOutput) => void), - cb?: (err: any, data?: UpdateCustomMetricCommandOutput) => void - ): Promise | void { - const command = new UpdateCustomMetricCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the definition for a dimension. You - * cannot - * change the type of a dimension after - * it is created (you can delete it and - * recreate - * it).

- *

Requires permission to access the UpdateDimension action.

- */ - public updateDimension( + + /** + * @see {@link UpdateDimensionCommand} + */ + updateDimension( args: UpdateDimensionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDimension( - args: UpdateDimensionCommandInput, - cb: (err: any, data?: UpdateDimensionCommandOutput) => void - ): void; - public updateDimension( + updateDimension(args: UpdateDimensionCommandInput, cb: (err: any, data?: UpdateDimensionCommandOutput) => void): void; + updateDimension( args: UpdateDimensionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDimensionCommandOutput) => void ): void; - public updateDimension( - args: UpdateDimensionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDimensionCommandOutput) => void), - cb?: (err: any, data?: UpdateDimensionCommandOutput) => void - ): Promise | void { - const command = new UpdateDimensionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates values stored in the domain configuration. Domain configurations for default - * endpoints can't be updated.

- *

Requires permission to access the UpdateDomainConfiguration action.

- */ - public updateDomainConfiguration( + + /** + * @see {@link UpdateDomainConfigurationCommand} + */ + updateDomainConfiguration( args: UpdateDomainConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDomainConfiguration( + updateDomainConfiguration( args: UpdateDomainConfigurationCommandInput, cb: (err: any, data?: UpdateDomainConfigurationCommandOutput) => void ): void; - public updateDomainConfiguration( + updateDomainConfiguration( args: UpdateDomainConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDomainConfigurationCommandOutput) => void ): void; - public updateDomainConfiguration( - args: UpdateDomainConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDomainConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateDomainConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateDomainConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a dynamic thing group.

- *

Requires permission to access the UpdateDynamicThingGroup action.

- */ - public updateDynamicThingGroup( + + /** + * @see {@link UpdateDynamicThingGroupCommand} + */ + updateDynamicThingGroup( args: UpdateDynamicThingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDynamicThingGroup( + updateDynamicThingGroup( args: UpdateDynamicThingGroupCommandInput, cb: (err: any, data?: UpdateDynamicThingGroupCommandOutput) => void ): void; - public updateDynamicThingGroup( + updateDynamicThingGroup( args: UpdateDynamicThingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDynamicThingGroupCommandOutput) => void ): void; - public updateDynamicThingGroup( - args: UpdateDynamicThingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDynamicThingGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateDynamicThingGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateDynamicThingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the event configurations.

- *

Requires permission to access the UpdateEventConfigurations action.

- */ - public updateEventConfigurations( + + /** + * @see {@link UpdateEventConfigurationsCommand} + */ + updateEventConfigurations( args: UpdateEventConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEventConfigurations( + updateEventConfigurations( args: UpdateEventConfigurationsCommandInput, cb: (err: any, data?: UpdateEventConfigurationsCommandOutput) => void ): void; - public updateEventConfigurations( + updateEventConfigurations( args: UpdateEventConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEventConfigurationsCommandOutput) => void ): void; - public updateEventConfigurations( - args: UpdateEventConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEventConfigurationsCommandOutput) => void), - cb?: (err: any, data?: UpdateEventConfigurationsCommandOutput) => void - ): Promise | void { - const command = new UpdateEventConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the data for a fleet metric.

- *

Requires permission to access the UpdateFleetMetric action.

- */ - public updateFleetMetric( + + /** + * @see {@link UpdateFleetMetricCommand} + */ + updateFleetMetric( args: UpdateFleetMetricCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFleetMetric( + updateFleetMetric( args: UpdateFleetMetricCommandInput, cb: (err: any, data?: UpdateFleetMetricCommandOutput) => void ): void; - public updateFleetMetric( + updateFleetMetric( args: UpdateFleetMetricCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFleetMetricCommandOutput) => void ): void; - public updateFleetMetric( - args: UpdateFleetMetricCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFleetMetricCommandOutput) => void), - cb?: (err: any, data?: UpdateFleetMetricCommandOutput) => void - ): Promise | void { - const command = new UpdateFleetMetricCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the search configuration.

- *

Requires permission to access the UpdateIndexingConfiguration action.

- */ - public updateIndexingConfiguration( + + /** + * @see {@link UpdateIndexingConfigurationCommand} + */ + updateIndexingConfiguration( args: UpdateIndexingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateIndexingConfiguration( + updateIndexingConfiguration( args: UpdateIndexingConfigurationCommandInput, cb: (err: any, data?: UpdateIndexingConfigurationCommandOutput) => void ): void; - public updateIndexingConfiguration( + updateIndexingConfiguration( args: UpdateIndexingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIndexingConfigurationCommandOutput) => void ): void; - public updateIndexingConfiguration( - args: UpdateIndexingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateIndexingConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateIndexingConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateIndexingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates supported fields of the specified job.

- *

Requires permission to access the UpdateJob action.

- */ - public updateJob(args: UpdateJobCommandInput, options?: __HttpHandlerOptions): Promise; - public updateJob(args: UpdateJobCommandInput, cb: (err: any, data?: UpdateJobCommandOutput) => void): void; - public updateJob( + + /** + * @see {@link UpdateJobCommand} + */ + updateJob(args: UpdateJobCommandInput, options?: __HttpHandlerOptions): Promise; + updateJob(args: UpdateJobCommandInput, cb: (err: any, data?: UpdateJobCommandOutput) => void): void; + updateJob( args: UpdateJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateJobCommandOutput) => void ): void; - public updateJob( - args: UpdateJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateJobCommandOutput) => void), - cb?: (err: any, data?: UpdateJobCommandOutput) => void - ): Promise | void { - const command = new UpdateJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the definition for the specified mitigation action.

- *

Requires permission to access the UpdateMitigationAction action.

- */ - public updateMitigationAction( + + /** + * @see {@link UpdateMitigationActionCommand} + */ + updateMitigationAction( args: UpdateMitigationActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMitigationAction( + updateMitigationAction( args: UpdateMitigationActionCommandInput, cb: (err: any, data?: UpdateMitigationActionCommandOutput) => void ): void; - public updateMitigationAction( + updateMitigationAction( args: UpdateMitigationActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMitigationActionCommandOutput) => void ): void; - public updateMitigationAction( - args: UpdateMitigationActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMitigationActionCommandOutput) => void), - cb?: (err: any, data?: UpdateMitigationActionCommandOutput) => void - ): Promise | void { - const command = new UpdateMitigationActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a provisioning template.

- *

Requires permission to access the UpdateProvisioningTemplate action.

- */ - public updateProvisioningTemplate( + + /** + * @see {@link UpdateProvisioningTemplateCommand} + */ + updateProvisioningTemplate( args: UpdateProvisioningTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateProvisioningTemplate( + updateProvisioningTemplate( args: UpdateProvisioningTemplateCommandInput, cb: (err: any, data?: UpdateProvisioningTemplateCommandOutput) => void ): void; - public updateProvisioningTemplate( + updateProvisioningTemplate( args: UpdateProvisioningTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProvisioningTemplateCommandOutput) => void ): void; - public updateProvisioningTemplate( - args: UpdateProvisioningTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProvisioningTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateProvisioningTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateProvisioningTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a role alias.

- *

Requires permission to access the UpdateRoleAlias action.

- */ - public updateRoleAlias( + + /** + * @see {@link UpdateRoleAliasCommand} + */ + updateRoleAlias( args: UpdateRoleAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRoleAlias( - args: UpdateRoleAliasCommandInput, - cb: (err: any, data?: UpdateRoleAliasCommandOutput) => void - ): void; - public updateRoleAlias( + updateRoleAlias(args: UpdateRoleAliasCommandInput, cb: (err: any, data?: UpdateRoleAliasCommandOutput) => void): void; + updateRoleAlias( args: UpdateRoleAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRoleAliasCommandOutput) => void ): void; - public updateRoleAlias( - args: UpdateRoleAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRoleAliasCommandOutput) => void), - cb?: (err: any, data?: UpdateRoleAliasCommandOutput) => void - ): Promise | void { - const command = new UpdateRoleAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a scheduled audit, including which checks are performed and - * how often the audit takes place.

- *

Requires permission to access the UpdateScheduledAudit action.

- */ - public updateScheduledAudit( + + /** + * @see {@link UpdateScheduledAuditCommand} + */ + updateScheduledAudit( args: UpdateScheduledAuditCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateScheduledAudit( + updateScheduledAudit( args: UpdateScheduledAuditCommandInput, cb: (err: any, data?: UpdateScheduledAuditCommandOutput) => void ): void; - public updateScheduledAudit( + updateScheduledAudit( args: UpdateScheduledAuditCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateScheduledAuditCommandOutput) => void ): void; - public updateScheduledAudit( - args: UpdateScheduledAuditCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateScheduledAuditCommandOutput) => void), - cb?: (err: any, data?: UpdateScheduledAuditCommandOutput) => void - ): Promise | void { - const command = new UpdateScheduledAuditCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a Device Defender security profile.

- *

Requires permission to access the UpdateSecurityProfile action.

- */ - public updateSecurityProfile( + + /** + * @see {@link UpdateSecurityProfileCommand} + */ + updateSecurityProfile( args: UpdateSecurityProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSecurityProfile( + updateSecurityProfile( args: UpdateSecurityProfileCommandInput, cb: (err: any, data?: UpdateSecurityProfileCommandOutput) => void ): void; - public updateSecurityProfile( + updateSecurityProfile( args: UpdateSecurityProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSecurityProfileCommandOutput) => void ): void; - public updateSecurityProfile( - args: UpdateSecurityProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSecurityProfileCommandOutput) => void), - cb?: (err: any, data?: UpdateSecurityProfileCommandOutput) => void - ): Promise | void { - const command = new UpdateSecurityProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing stream. The stream version will be incremented by one.

- *

Requires permission to access the UpdateStream action.

- */ - public updateStream( - args: UpdateStreamCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateStream(args: UpdateStreamCommandInput, cb: (err: any, data?: UpdateStreamCommandOutput) => void): void; - public updateStream( + + /** + * @see {@link UpdateStreamCommand} + */ + updateStream(args: UpdateStreamCommandInput, options?: __HttpHandlerOptions): Promise; + updateStream(args: UpdateStreamCommandInput, cb: (err: any, data?: UpdateStreamCommandOutput) => void): void; + updateStream( args: UpdateStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStreamCommandOutput) => void ): void; - public updateStream( - args: UpdateStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStreamCommandOutput) => void), - cb?: (err: any, data?: UpdateStreamCommandOutput) => void - ): Promise | void { - const command = new UpdateStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the data for a thing.

- *

Requires permission to access the UpdateThing action.

- */ - public updateThing(args: UpdateThingCommandInput, options?: __HttpHandlerOptions): Promise; - public updateThing(args: UpdateThingCommandInput, cb: (err: any, data?: UpdateThingCommandOutput) => void): void; - public updateThing( + + /** + * @see {@link UpdateThingCommand} + */ + updateThing(args: UpdateThingCommandInput, options?: __HttpHandlerOptions): Promise; + updateThing(args: UpdateThingCommandInput, cb: (err: any, data?: UpdateThingCommandOutput) => void): void; + updateThing( args: UpdateThingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateThingCommandOutput) => void ): void; - public updateThing( - args: UpdateThingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateThingCommandOutput) => void), - cb?: (err: any, data?: UpdateThingCommandOutput) => void - ): Promise | void { - const command = new UpdateThingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update a thing group.

- *

Requires permission to access the UpdateThingGroup action.

- */ - public updateThingGroup( + + /** + * @see {@link UpdateThingGroupCommand} + */ + updateThingGroup( args: UpdateThingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateThingGroup( + updateThingGroup( args: UpdateThingGroupCommandInput, cb: (err: any, data?: UpdateThingGroupCommandOutput) => void ): void; - public updateThingGroup( + updateThingGroup( args: UpdateThingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateThingGroupCommandOutput) => void ): void; - public updateThingGroup( - args: UpdateThingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateThingGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateThingGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateThingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the groups to which the thing belongs.

- *

Requires permission to access the UpdateThingGroupsForThing action.

- */ - public updateThingGroupsForThing( + + /** + * @see {@link UpdateThingGroupsForThingCommand} + */ + updateThingGroupsForThing( args: UpdateThingGroupsForThingCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateThingGroupsForThing( + updateThingGroupsForThing( args: UpdateThingGroupsForThingCommandInput, cb: (err: any, data?: UpdateThingGroupsForThingCommandOutput) => void ): void; - public updateThingGroupsForThing( + updateThingGroupsForThing( args: UpdateThingGroupsForThingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateThingGroupsForThingCommandOutput) => void ): void; - public updateThingGroupsForThing( - args: UpdateThingGroupsForThingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateThingGroupsForThingCommandOutput) => void), - cb?: (err: any, data?: UpdateThingGroupsForThingCommandOutput) => void - ): Promise | void { - const command = new UpdateThingGroupsForThingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a topic rule destination. You use this to change the status, endpoint URL, or - * confirmation URL of the destination.

- *

Requires permission to access the UpdateTopicRuleDestination action.

- */ - public updateTopicRuleDestination( + + /** + * @see {@link UpdateTopicRuleDestinationCommand} + */ + updateTopicRuleDestination( args: UpdateTopicRuleDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTopicRuleDestination( + updateTopicRuleDestination( args: UpdateTopicRuleDestinationCommandInput, cb: (err: any, data?: UpdateTopicRuleDestinationCommandOutput) => void ): void; - public updateTopicRuleDestination( + updateTopicRuleDestination( args: UpdateTopicRuleDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTopicRuleDestinationCommandOutput) => void ): void; - public updateTopicRuleDestination( - args: UpdateTopicRuleDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTopicRuleDestinationCommandOutput) => void), - cb?: (err: any, data?: UpdateTopicRuleDestinationCommandOutput) => void - ): Promise | void { - const command = new UpdateTopicRuleDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Validates a Device Defender security profile behaviors specification.

- *

Requires permission to access the ValidateSecurityProfileBehaviors action.

- */ - public validateSecurityProfileBehaviors( + + /** + * @see {@link ValidateSecurityProfileBehaviorsCommand} + */ + validateSecurityProfileBehaviors( args: ValidateSecurityProfileBehaviorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public validateSecurityProfileBehaviors( + validateSecurityProfileBehaviors( args: ValidateSecurityProfileBehaviorsCommandInput, cb: (err: any, data?: ValidateSecurityProfileBehaviorsCommandOutput) => void ): void; - public validateSecurityProfileBehaviors( + validateSecurityProfileBehaviors( args: ValidateSecurityProfileBehaviorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidateSecurityProfileBehaviorsCommandOutput) => void ): void; - public validateSecurityProfileBehaviors( - args: ValidateSecurityProfileBehaviorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ValidateSecurityProfileBehaviorsCommandOutput) => void), - cb?: (err: any, data?: ValidateSecurityProfileBehaviorsCommandOutput) => void - ): Promise | void { - const command = new ValidateSecurityProfileBehaviorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * IoT + *

IoT provides secure, bi-directional communication between Internet-connected + * devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services + * cloud. You can discover your custom IoT-Data endpoint to communicate with, configure + * rules for data processing and integration with other services, organize resources + * associated with each device (Registry), configure logging, and create and manage + * policies and credentials to authenticate devices.

+ *

The service endpoints that expose this API are listed in + * Amazon Web Services IoT Core Endpoints and Quotas. + * You must use the endpoint for the region that has the resources you want to access.

+ *

The service name used by Amazon Web Services + * Signature Version 4 to sign the request is: + * execute-api.

+ *

For more information about how IoT works, see the Developer + * Guide.

+ *

For information about how to use the credentials provider for IoT, see Authorizing Direct Calls to Amazon Web Services Services.

+ */ +export class IoT extends IoTClient implements IoT {} +createAggregatedClient(commands, IoT); diff --git a/clients/client-iotanalytics/src/IoTAnalytics.ts b/clients/client-iotanalytics/src/IoTAnalytics.ts index f7861a3b5fcf..f3bfa6f52f3e 100644 --- a/clients/client-iotanalytics/src/IoTAnalytics.ts +++ b/clients/client-iotanalytics/src/IoTAnalytics.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -167,1157 +168,550 @@ import { UpdatePipelineCommandInput, UpdatePipelineCommandOutput, } from "./commands/UpdatePipelineCommand"; -import { IoTAnalyticsClient } from "./IoTAnalyticsClient"; +import { IoTAnalyticsClient, IoTAnalyticsClientConfig } from "./IoTAnalyticsClient"; -/** - * @public - *

IoT Analytics allows you to collect large amounts of device data, process messages, and store them. - * You can then query the data and run sophisticated analytics on it. IoT Analytics enables advanced - * data exploration through integration with Jupyter Notebooks and data visualization through integration - * with Amazon QuickSight.

- * - *

Traditional analytics and business intelligence tools are designed to process structured data. IoT data - * often comes from devices that record noisy processes (such as temperature, motion, or sound). As a result - * the data from these devices can have significant gaps, corrupted messages, and false readings that must be - * cleaned up before analysis can occur. Also, IoT data is often only meaningful in the context of other data - * from external sources.

- * - *

IoT Analytics automates the steps required to analyze data from IoT devices. IoT Analytics - * filters, transforms, and enriches IoT data before storing it in a time-series data store for analysis. You - * can set up the service to collect only the data you need from your devices, apply mathematical transforms - * to process the data, and enrich the data with device-specific metadata such as device type and location - * before storing it. Then, you can analyze your data by running queries using the built-in SQL query engine, - * or perform more complex analytics and machine learning inference. IoT Analytics includes pre-built models - * for common IoT use cases so you can answer questions like which devices are about to fail or which customers - * are at risk of abandoning their wearable devices.

- */ -export class IoTAnalytics extends IoTAnalyticsClient { +const commands = { + BatchPutMessageCommand, + CancelPipelineReprocessingCommand, + CreateChannelCommand, + CreateDatasetCommand, + CreateDatasetContentCommand, + CreateDatastoreCommand, + CreatePipelineCommand, + DeleteChannelCommand, + DeleteDatasetCommand, + DeleteDatasetContentCommand, + DeleteDatastoreCommand, + DeletePipelineCommand, + DescribeChannelCommand, + DescribeDatasetCommand, + DescribeDatastoreCommand, + DescribeLoggingOptionsCommand, + DescribePipelineCommand, + GetDatasetContentCommand, + ListChannelsCommand, + ListDatasetContentsCommand, + ListDatasetsCommand, + ListDatastoresCommand, + ListPipelinesCommand, + ListTagsForResourceCommand, + PutLoggingOptionsCommand, + RunPipelineActivityCommand, + SampleChannelDataCommand, + StartPipelineReprocessingCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateChannelCommand, + UpdateDatasetCommand, + UpdateDatastoreCommand, + UpdatePipelineCommand, +}; + +export interface IoTAnalytics { /** - * @public - *

Sends messages to a channel.

+ * @see {@link BatchPutMessageCommand} */ - public batchPutMessage( + batchPutMessage( args: BatchPutMessageCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchPutMessage( - args: BatchPutMessageCommandInput, - cb: (err: any, data?: BatchPutMessageCommandOutput) => void - ): void; - public batchPutMessage( + batchPutMessage(args: BatchPutMessageCommandInput, cb: (err: any, data?: BatchPutMessageCommandOutput) => void): void; + batchPutMessage( args: BatchPutMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchPutMessageCommandOutput) => void ): void; - public batchPutMessage( - args: BatchPutMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchPutMessageCommandOutput) => void), - cb?: (err: any, data?: BatchPutMessageCommandOutput) => void - ): Promise | void { - const command = new BatchPutMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels the reprocessing of data through the pipeline.

+ * @see {@link CancelPipelineReprocessingCommand} */ - public cancelPipelineReprocessing( + cancelPipelineReprocessing( args: CancelPipelineReprocessingCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelPipelineReprocessing( + cancelPipelineReprocessing( args: CancelPipelineReprocessingCommandInput, cb: (err: any, data?: CancelPipelineReprocessingCommandOutput) => void ): void; - public cancelPipelineReprocessing( + cancelPipelineReprocessing( args: CancelPipelineReprocessingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelPipelineReprocessingCommandOutput) => void ): void; - public cancelPipelineReprocessing( - args: CancelPipelineReprocessingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelPipelineReprocessingCommandOutput) => void), - cb?: (err: any, data?: CancelPipelineReprocessingCommandOutput) => void - ): Promise | void { - const command = new CancelPipelineReprocessingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used to create a channel. A channel collects data from an MQTT topic and archives the raw, - * unprocessed messages before publishing the data to a pipeline.

+ * @see {@link CreateChannelCommand} */ - public createChannel( - args: CreateChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createChannel( - args: CreateChannelCommandInput, - cb: (err: any, data?: CreateChannelCommandOutput) => void - ): void; - public createChannel( + createChannel(args: CreateChannelCommandInput, options?: __HttpHandlerOptions): Promise; + createChannel(args: CreateChannelCommandInput, cb: (err: any, data?: CreateChannelCommandOutput) => void): void; + createChannel( args: CreateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelCommandOutput) => void ): void; - public createChannel( - args: CreateChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateChannelCommandOutput) => void), - cb?: (err: any, data?: CreateChannelCommandOutput) => void - ): Promise | void { - const command = new CreateChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used to create a dataset. A dataset stores data retrieved from a data store by applying a - * queryAction (a SQL query) or a containerAction (executing a - * containerized application). This operation creates the skeleton of a dataset. The dataset can - * be populated manually by calling CreateDatasetContent or automatically according - * to a trigger you specify.

+ * @see {@link CreateDatasetCommand} */ - public createDataset( - args: CreateDatasetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createDataset( - args: CreateDatasetCommandInput, - cb: (err: any, data?: CreateDatasetCommandOutput) => void - ): void; - public createDataset( + createDataset(args: CreateDatasetCommandInput, options?: __HttpHandlerOptions): Promise; + createDataset(args: CreateDatasetCommandInput, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void; + createDataset( args: CreateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetCommandOutput) => void ): void; - public createDataset( - args: CreateDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDatasetCommandOutput) => void), - cb?: (err: any, data?: CreateDatasetCommandOutput) => void - ): Promise | void { - const command = new CreateDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates the content of a dataset by applying a queryAction (a SQL query) or a - * containerAction (executing a containerized application).

+ * @see {@link CreateDatasetContentCommand} */ - public createDatasetContent( + createDatasetContent( args: CreateDatasetContentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDatasetContent( + createDatasetContent( args: CreateDatasetContentCommandInput, cb: (err: any, data?: CreateDatasetContentCommandOutput) => void ): void; - public createDatasetContent( + createDatasetContent( args: CreateDatasetContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetContentCommandOutput) => void ): void; - public createDatasetContent( - args: CreateDatasetContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDatasetContentCommandOutput) => void), - cb?: (err: any, data?: CreateDatasetContentCommandOutput) => void - ): Promise | void { - const command = new CreateDatasetContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a data store, which is a repository for messages.

+ * @see {@link CreateDatastoreCommand} */ - public createDatastore( + createDatastore( args: CreateDatastoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDatastore( - args: CreateDatastoreCommandInput, - cb: (err: any, data?: CreateDatastoreCommandOutput) => void - ): void; - public createDatastore( + createDatastore(args: CreateDatastoreCommandInput, cb: (err: any, data?: CreateDatastoreCommandOutput) => void): void; + createDatastore( args: CreateDatastoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatastoreCommandOutput) => void ): void; - public createDatastore( - args: CreateDatastoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDatastoreCommandOutput) => void), - cb?: (err: any, data?: CreateDatastoreCommandOutput) => void - ): Promise | void { - const command = new CreateDatastoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a pipeline. A pipeline consumes messages from a channel and allows you to process - * the messages before storing them in a data store. You must specify both a channel - * and a datastore activity and, optionally, as many as 23 additional activities in - * the pipelineActivities array.

+ * @see {@link CreatePipelineCommand} */ - public createPipeline( + createPipeline( args: CreatePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPipeline( - args: CreatePipelineCommandInput, - cb: (err: any, data?: CreatePipelineCommandOutput) => void - ): void; - public createPipeline( + createPipeline(args: CreatePipelineCommandInput, cb: (err: any, data?: CreatePipelineCommandOutput) => void): void; + createPipeline( args: CreatePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePipelineCommandOutput) => void ): void; - public createPipeline( - args: CreatePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePipelineCommandOutput) => void), - cb?: (err: any, data?: CreatePipelineCommandOutput) => void - ): Promise | void { - const command = new CreatePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified channel.

+ * @see {@link DeleteChannelCommand} */ - public deleteChannel( - args: DeleteChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteChannel( - args: DeleteChannelCommandInput, - cb: (err: any, data?: DeleteChannelCommandOutput) => void - ): void; - public deleteChannel( + deleteChannel(args: DeleteChannelCommandInput, options?: __HttpHandlerOptions): Promise; + deleteChannel(args: DeleteChannelCommandInput, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void; + deleteChannel( args: DeleteChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelCommandOutput) => void ): void; - public deleteChannel( - args: DeleteChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteChannelCommandOutput) => void), - cb?: (err: any, data?: DeleteChannelCommandOutput) => void - ): Promise | void { - const command = new DeleteChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified dataset.

- *

You do not have to delete the content of the dataset before you perform this - * operation.

+ * @see {@link DeleteDatasetCommand} */ - public deleteDataset( - args: DeleteDatasetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDataset( - args: DeleteDatasetCommandInput, - cb: (err: any, data?: DeleteDatasetCommandOutput) => void - ): void; - public deleteDataset( + deleteDataset(args: DeleteDatasetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDataset(args: DeleteDatasetCommandInput, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void; + deleteDataset( args: DeleteDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetCommandOutput) => void ): void; - public deleteDataset( - args: DeleteDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDatasetCommandOutput) => void), - cb?: (err: any, data?: DeleteDatasetCommandOutput) => void - ): Promise | void { - const command = new DeleteDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the content of the specified dataset.

+ * @see {@link DeleteDatasetContentCommand} */ - public deleteDatasetContent( + deleteDatasetContent( args: DeleteDatasetContentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDatasetContent( + deleteDatasetContent( args: DeleteDatasetContentCommandInput, cb: (err: any, data?: DeleteDatasetContentCommandOutput) => void ): void; - public deleteDatasetContent( + deleteDatasetContent( args: DeleteDatasetContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetContentCommandOutput) => void ): void; - public deleteDatasetContent( - args: DeleteDatasetContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDatasetContentCommandOutput) => void), - cb?: (err: any, data?: DeleteDatasetContentCommandOutput) => void - ): Promise | void { - const command = new DeleteDatasetContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified data store.

+ * @see {@link DeleteDatastoreCommand} */ - public deleteDatastore( + deleteDatastore( args: DeleteDatastoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDatastore( - args: DeleteDatastoreCommandInput, - cb: (err: any, data?: DeleteDatastoreCommandOutput) => void - ): void; - public deleteDatastore( + deleteDatastore(args: DeleteDatastoreCommandInput, cb: (err: any, data?: DeleteDatastoreCommandOutput) => void): void; + deleteDatastore( args: DeleteDatastoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatastoreCommandOutput) => void ): void; - public deleteDatastore( - args: DeleteDatastoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDatastoreCommandOutput) => void), - cb?: (err: any, data?: DeleteDatastoreCommandOutput) => void - ): Promise | void { - const command = new DeleteDatastoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified pipeline.

+ * @see {@link DeletePipelineCommand} */ - public deletePipeline( + deletePipeline( args: DeletePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePipeline( - args: DeletePipelineCommandInput, - cb: (err: any, data?: DeletePipelineCommandOutput) => void - ): void; - public deletePipeline( + deletePipeline(args: DeletePipelineCommandInput, cb: (err: any, data?: DeletePipelineCommandOutput) => void): void; + deletePipeline( args: DeletePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePipelineCommandOutput) => void ): void; - public deletePipeline( - args: DeletePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePipelineCommandOutput) => void), - cb?: (err: any, data?: DeletePipelineCommandOutput) => void - ): Promise | void { - const command = new DeletePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a channel.

+ * @see {@link DescribeChannelCommand} */ - public describeChannel( + describeChannel( args: DescribeChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeChannel( - args: DescribeChannelCommandInput, - cb: (err: any, data?: DescribeChannelCommandOutput) => void - ): void; - public describeChannel( + describeChannel(args: DescribeChannelCommandInput, cb: (err: any, data?: DescribeChannelCommandOutput) => void): void; + describeChannel( args: DescribeChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelCommandOutput) => void ): void; - public describeChannel( - args: DescribeChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeChannelCommandOutput) => void), - cb?: (err: any, data?: DescribeChannelCommandOutput) => void - ): Promise | void { - const command = new DescribeChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a dataset.

+ * @see {@link DescribeDatasetCommand} */ - public describeDataset( + describeDataset( args: DescribeDatasetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDataset( - args: DescribeDatasetCommandInput, - cb: (err: any, data?: DescribeDatasetCommandOutput) => void - ): void; - public describeDataset( + describeDataset(args: DescribeDatasetCommandInput, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void; + describeDataset( args: DescribeDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetCommandOutput) => void ): void; - public describeDataset( - args: DescribeDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDatasetCommandOutput) => void), - cb?: (err: any, data?: DescribeDatasetCommandOutput) => void - ): Promise | void { - const command = new DescribeDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a data store.

+ * @see {@link DescribeDatastoreCommand} */ - public describeDatastore( + describeDatastore( args: DescribeDatastoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDatastore( + describeDatastore( args: DescribeDatastoreCommandInput, cb: (err: any, data?: DescribeDatastoreCommandOutput) => void ): void; - public describeDatastore( + describeDatastore( args: DescribeDatastoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatastoreCommandOutput) => void ): void; - public describeDatastore( - args: DescribeDatastoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDatastoreCommandOutput) => void), - cb?: (err: any, data?: DescribeDatastoreCommandOutput) => void - ): Promise | void { - const command = new DescribeDatastoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the current settings of the IoT Analytics logging options.

+ * @see {@link DescribeLoggingOptionsCommand} */ - public describeLoggingOptions( + describeLoggingOptions( args: DescribeLoggingOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLoggingOptions( + describeLoggingOptions( args: DescribeLoggingOptionsCommandInput, cb: (err: any, data?: DescribeLoggingOptionsCommandOutput) => void ): void; - public describeLoggingOptions( + describeLoggingOptions( args: DescribeLoggingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLoggingOptionsCommandOutput) => void ): void; - public describeLoggingOptions( - args: DescribeLoggingOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLoggingOptionsCommandOutput) => void), - cb?: (err: any, data?: DescribeLoggingOptionsCommandOutput) => void - ): Promise | void { - const command = new DescribeLoggingOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a pipeline.

+ * @see {@link DescribePipelineCommand} */ - public describePipeline( + describePipeline( args: DescribePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePipeline( + describePipeline( args: DescribePipelineCommandInput, cb: (err: any, data?: DescribePipelineCommandOutput) => void ): void; - public describePipeline( + describePipeline( args: DescribePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePipelineCommandOutput) => void ): void; - public describePipeline( - args: DescribePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePipelineCommandOutput) => void), - cb?: (err: any, data?: DescribePipelineCommandOutput) => void - ): Promise | void { - const command = new DescribePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the contents of a dataset as presigned URIs.

+ * @see {@link GetDatasetContentCommand} */ - public getDatasetContent( + getDatasetContent( args: GetDatasetContentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDatasetContent( + getDatasetContent( args: GetDatasetContentCommandInput, cb: (err: any, data?: GetDatasetContentCommandOutput) => void ): void; - public getDatasetContent( + getDatasetContent( args: GetDatasetContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDatasetContentCommandOutput) => void ): void; - public getDatasetContent( - args: GetDatasetContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDatasetContentCommandOutput) => void), - cb?: (err: any, data?: GetDatasetContentCommandOutput) => void - ): Promise | void { - const command = new GetDatasetContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of channels.

+ * @see {@link ListChannelsCommand} */ - public listChannels( - args: ListChannelsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void; - public listChannels( + listChannels(args: ListChannelsCommandInput, options?: __HttpHandlerOptions): Promise; + listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void; + listChannels( args: ListChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsCommandOutput) => void ): void; - public listChannels( - args: ListChannelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListChannelsCommandOutput) => void), - cb?: (err: any, data?: ListChannelsCommandOutput) => void - ): Promise | void { - const command = new ListChannelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists information about dataset contents that have been created.

+ * @see {@link ListDatasetContentsCommand} */ - public listDatasetContents( + listDatasetContents( args: ListDatasetContentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDatasetContents( + listDatasetContents( args: ListDatasetContentsCommandInput, cb: (err: any, data?: ListDatasetContentsCommandOutput) => void ): void; - public listDatasetContents( + listDatasetContents( args: ListDatasetContentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetContentsCommandOutput) => void ): void; - public listDatasetContents( - args: ListDatasetContentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatasetContentsCommandOutput) => void), - cb?: (err: any, data?: ListDatasetContentsCommandOutput) => void - ): Promise | void { - const command = new ListDatasetContentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about datasets.

+ * @see {@link ListDatasetsCommand} */ - public listDatasets( - args: ListDatasetsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void; - public listDatasets( + listDatasets(args: ListDatasetsCommandInput, options?: __HttpHandlerOptions): Promise; + listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void; + listDatasets( args: ListDatasetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetsCommandOutput) => void ): void; - public listDatasets( - args: ListDatasetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatasetsCommandOutput) => void), - cb?: (err: any, data?: ListDatasetsCommandOutput) => void - ): Promise | void { - const command = new ListDatasetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of data stores.

+ * @see {@link ListDatastoresCommand} */ - public listDatastores( + listDatastores( args: ListDatastoresCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDatastores( - args: ListDatastoresCommandInput, - cb: (err: any, data?: ListDatastoresCommandOutput) => void - ): void; - public listDatastores( + listDatastores(args: ListDatastoresCommandInput, cb: (err: any, data?: ListDatastoresCommandOutput) => void): void; + listDatastores( args: ListDatastoresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatastoresCommandOutput) => void ): void; - public listDatastores( - args: ListDatastoresCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatastoresCommandOutput) => void), - cb?: (err: any, data?: ListDatastoresCommandOutput) => void - ): Promise | void { - const command = new ListDatastoresCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of pipelines.

+ * @see {@link ListPipelinesCommand} */ - public listPipelines( - args: ListPipelinesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listPipelines( - args: ListPipelinesCommandInput, - cb: (err: any, data?: ListPipelinesCommandOutput) => void - ): void; - public listPipelines( + listPipelines(args: ListPipelinesCommandInput, options?: __HttpHandlerOptions): Promise; + listPipelines(args: ListPipelinesCommandInput, cb: (err: any, data?: ListPipelinesCommandOutput) => void): void; + listPipelines( args: ListPipelinesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPipelinesCommandOutput) => void ): void; - public listPipelines( - args: ListPipelinesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPipelinesCommandOutput) => void), - cb?: (err: any, data?: ListPipelinesCommandOutput) => void - ): Promise | void { - const command = new ListPipelinesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags (metadata) that you have assigned to the resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets or updates the IoT Analytics logging options.

- *

If you update the value of any loggingOptions field, it takes up to one - * minute for the change to take effect. Also, if you change the policy attached to the role you - * specified in the roleArn field (for example, to correct an invalid policy), it - * takes up to five minutes for that change to take effect.

+ * @see {@link PutLoggingOptionsCommand} */ - public putLoggingOptions( + putLoggingOptions( args: PutLoggingOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putLoggingOptions( + putLoggingOptions( args: PutLoggingOptionsCommandInput, cb: (err: any, data?: PutLoggingOptionsCommandOutput) => void ): void; - public putLoggingOptions( + putLoggingOptions( args: PutLoggingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLoggingOptionsCommandOutput) => void ): void; - public putLoggingOptions( - args: PutLoggingOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutLoggingOptionsCommandOutput) => void), - cb?: (err: any, data?: PutLoggingOptionsCommandOutput) => void - ): Promise | void { - const command = new PutLoggingOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Simulates the results of running a pipeline activity on a message payload.

+ * @see {@link RunPipelineActivityCommand} */ - public runPipelineActivity( + runPipelineActivity( args: RunPipelineActivityCommandInput, options?: __HttpHandlerOptions ): Promise; - public runPipelineActivity( + runPipelineActivity( args: RunPipelineActivityCommandInput, cb: (err: any, data?: RunPipelineActivityCommandOutput) => void ): void; - public runPipelineActivity( + runPipelineActivity( args: RunPipelineActivityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RunPipelineActivityCommandOutput) => void ): void; - public runPipelineActivity( - args: RunPipelineActivityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RunPipelineActivityCommandOutput) => void), - cb?: (err: any, data?: RunPipelineActivityCommandOutput) => void - ): Promise | void { - const command = new RunPipelineActivityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a sample of messages from the specified channel ingested during the specified - * timeframe. Up to 10 messages can be retrieved.

+ * @see {@link SampleChannelDataCommand} */ - public sampleChannelData( + sampleChannelData( args: SampleChannelDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public sampleChannelData( + sampleChannelData( args: SampleChannelDataCommandInput, cb: (err: any, data?: SampleChannelDataCommandOutput) => void ): void; - public sampleChannelData( + sampleChannelData( args: SampleChannelDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SampleChannelDataCommandOutput) => void ): void; - public sampleChannelData( - args: SampleChannelDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SampleChannelDataCommandOutput) => void), - cb?: (err: any, data?: SampleChannelDataCommandOutput) => void - ): Promise | void { - const command = new SampleChannelDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts the reprocessing of raw message data through the pipeline.

+ * @see {@link StartPipelineReprocessingCommand} */ - public startPipelineReprocessing( + startPipelineReprocessing( args: StartPipelineReprocessingCommandInput, options?: __HttpHandlerOptions ): Promise; - public startPipelineReprocessing( + startPipelineReprocessing( args: StartPipelineReprocessingCommandInput, cb: (err: any, data?: StartPipelineReprocessingCommandOutput) => void ): void; - public startPipelineReprocessing( + startPipelineReprocessing( args: StartPipelineReprocessingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartPipelineReprocessingCommandOutput) => void ): void; - public startPipelineReprocessing( - args: StartPipelineReprocessingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartPipelineReprocessingCommandOutput) => void), - cb?: (err: any, data?: StartPipelineReprocessingCommandOutput) => void - ): Promise | void { - const command = new StartPipelineReprocessingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to - * manage a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the given tags (metadata) from the resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used to update the settings of a channel.

+ * @see {@link UpdateChannelCommand} */ - public updateChannel( - args: UpdateChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateChannel( - args: UpdateChannelCommandInput, - cb: (err: any, data?: UpdateChannelCommandOutput) => void - ): void; - public updateChannel( + updateChannel(args: UpdateChannelCommandInput, options?: __HttpHandlerOptions): Promise; + updateChannel(args: UpdateChannelCommandInput, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void; + updateChannel( args: UpdateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelCommandOutput) => void ): void; - public updateChannel( - args: UpdateChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateChannelCommandOutput) => void), - cb?: (err: any, data?: UpdateChannelCommandOutput) => void - ): Promise | void { - const command = new UpdateChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the settings of a dataset.

+ * @see {@link UpdateDatasetCommand} */ - public updateDataset( - args: UpdateDatasetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateDataset( - args: UpdateDatasetCommandInput, - cb: (err: any, data?: UpdateDatasetCommandOutput) => void - ): void; - public updateDataset( + updateDataset(args: UpdateDatasetCommandInput, options?: __HttpHandlerOptions): Promise; + updateDataset(args: UpdateDatasetCommandInput, cb: (err: any, data?: UpdateDatasetCommandOutput) => void): void; + updateDataset( args: UpdateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDatasetCommandOutput) => void ): void; - public updateDataset( - args: UpdateDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDatasetCommandOutput) => void), - cb?: (err: any, data?: UpdateDatasetCommandOutput) => void - ): Promise | void { - const command = new UpdateDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used to update the settings of a data store.

+ * @see {@link UpdateDatastoreCommand} */ - public updateDatastore( + updateDatastore( args: UpdateDatastoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDatastore( - args: UpdateDatastoreCommandInput, - cb: (err: any, data?: UpdateDatastoreCommandOutput) => void - ): void; - public updateDatastore( + updateDatastore(args: UpdateDatastoreCommandInput, cb: (err: any, data?: UpdateDatastoreCommandOutput) => void): void; + updateDatastore( args: UpdateDatastoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDatastoreCommandOutput) => void ): void; - public updateDatastore( - args: UpdateDatastoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDatastoreCommandOutput) => void), - cb?: (err: any, data?: UpdateDatastoreCommandOutput) => void - ): Promise | void { - const command = new UpdateDatastoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the settings of a pipeline. You must specify both a channel and a - * datastore activity and, optionally, as many as 23 additional activities in the - * pipelineActivities array.

+ * @see {@link UpdatePipelineCommand} */ - public updatePipeline( + updatePipeline( args: UpdatePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePipeline( - args: UpdatePipelineCommandInput, - cb: (err: any, data?: UpdatePipelineCommandOutput) => void - ): void; - public updatePipeline( + updatePipeline(args: UpdatePipelineCommandInput, cb: (err: any, data?: UpdatePipelineCommandOutput) => void): void; + updatePipeline( args: UpdatePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePipelineCommandOutput) => void ): void; - public updatePipeline( - args: UpdatePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePipelineCommandOutput) => void), - cb?: (err: any, data?: UpdatePipelineCommandOutput) => void - ): Promise | void { - const command = new UpdatePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

IoT Analytics allows you to collect large amounts of device data, process messages, and store them. + * You can then query the data and run sophisticated analytics on it. IoT Analytics enables advanced + * data exploration through integration with Jupyter Notebooks and data visualization through integration + * with Amazon QuickSight.

+ * + *

Traditional analytics and business intelligence tools are designed to process structured data. IoT data + * often comes from devices that record noisy processes (such as temperature, motion, or sound). As a result + * the data from these devices can have significant gaps, corrupted messages, and false readings that must be + * cleaned up before analysis can occur. Also, IoT data is often only meaningful in the context of other data + * from external sources.

+ * + *

IoT Analytics automates the steps required to analyze data from IoT devices. IoT Analytics + * filters, transforms, and enriches IoT data before storing it in a time-series data store for analysis. You + * can set up the service to collect only the data you need from your devices, apply mathematical transforms + * to process the data, and enrich the data with device-specific metadata such as device type and location + * before storing it. Then, you can analyze your data by running queries using the built-in SQL query engine, + * or perform more complex analytics and machine learning inference. IoT Analytics includes pre-built models + * for common IoT use cases so you can answer questions like which devices are about to fail or which customers + * are at risk of abandoning their wearable devices.

+ */ +export class IoTAnalytics extends IoTAnalyticsClient implements IoTAnalytics {} +createAggregatedClient(commands, IoTAnalytics); diff --git a/clients/client-iotdeviceadvisor/src/IotDeviceAdvisor.ts b/clients/client-iotdeviceadvisor/src/IotDeviceAdvisor.ts index ed593f95a57b..121093dc3da7 100644 --- a/clients/client-iotdeviceadvisor/src/IotDeviceAdvisor.ts +++ b/clients/client-iotdeviceadvisor/src/IotDeviceAdvisor.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -59,473 +60,234 @@ import { UpdateSuiteDefinitionCommandInput, UpdateSuiteDefinitionCommandOutput, } from "./commands/UpdateSuiteDefinitionCommand"; -import { IotDeviceAdvisorClient } from "./IotDeviceAdvisorClient"; +import { IotDeviceAdvisorClient, IotDeviceAdvisorClientConfig } from "./IotDeviceAdvisorClient"; -/** - * @public - *

Amazon Web Services IoT Core Device Advisor is a cloud-based, fully managed test capability for validating IoT - * devices during device software development. Device Advisor provides pre-built tests that you - * can use to validate IoT devices for reliable and secure connectivity with Amazon Web Services IoT Core - * before deploying devices to production. By using Device Advisor, you can confirm that your - * devices can connect to Amazon Web Services IoT Core, follow security best practices and, if applicable, - * receive software updates from IoT Device Management. You can also download signed - * qualification reports to submit to the Amazon Web Services Partner Network to get your device - * qualified for the Amazon Web Services Partner Device Catalog without the need to send your device in - * and wait for it to be tested.

- */ -export class IotDeviceAdvisor extends IotDeviceAdvisorClient { +const commands = { + CreateSuiteDefinitionCommand, + DeleteSuiteDefinitionCommand, + GetEndpointCommand, + GetSuiteDefinitionCommand, + GetSuiteRunCommand, + GetSuiteRunReportCommand, + ListSuiteDefinitionsCommand, + ListSuiteRunsCommand, + ListTagsForResourceCommand, + StartSuiteRunCommand, + StopSuiteRunCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateSuiteDefinitionCommand, +}; + +export interface IotDeviceAdvisor { /** - * @public - *

Creates a Device Advisor test suite.

- *

Requires permission to access the CreateSuiteDefinition action.

+ * @see {@link CreateSuiteDefinitionCommand} */ - public createSuiteDefinition( + createSuiteDefinition( args: CreateSuiteDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSuiteDefinition( + createSuiteDefinition( args: CreateSuiteDefinitionCommandInput, cb: (err: any, data?: CreateSuiteDefinitionCommandOutput) => void ): void; - public createSuiteDefinition( + createSuiteDefinition( args: CreateSuiteDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSuiteDefinitionCommandOutput) => void ): void; - public createSuiteDefinition( - args: CreateSuiteDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSuiteDefinitionCommandOutput) => void), - cb?: (err: any, data?: CreateSuiteDefinitionCommandOutput) => void - ): Promise | void { - const command = new CreateSuiteDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Device Advisor test suite.

- *

Requires permission to access the DeleteSuiteDefinition action.

+ * @see {@link DeleteSuiteDefinitionCommand} */ - public deleteSuiteDefinition( + deleteSuiteDefinition( args: DeleteSuiteDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSuiteDefinition( + deleteSuiteDefinition( args: DeleteSuiteDefinitionCommandInput, cb: (err: any, data?: DeleteSuiteDefinitionCommandOutput) => void ): void; - public deleteSuiteDefinition( + deleteSuiteDefinition( args: DeleteSuiteDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSuiteDefinitionCommandOutput) => void ): void; - public deleteSuiteDefinition( - args: DeleteSuiteDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSuiteDefinitionCommandOutput) => void), - cb?: (err: any, data?: DeleteSuiteDefinitionCommandOutput) => void - ): Promise | void { - const command = new DeleteSuiteDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about an Device Advisor endpoint.

+ * @see {@link GetEndpointCommand} */ - public getEndpoint(args: GetEndpointCommandInput, options?: __HttpHandlerOptions): Promise; - public getEndpoint(args: GetEndpointCommandInput, cb: (err: any, data?: GetEndpointCommandOutput) => void): void; - public getEndpoint( + getEndpoint(args: GetEndpointCommandInput, options?: __HttpHandlerOptions): Promise; + getEndpoint(args: GetEndpointCommandInput, cb: (err: any, data?: GetEndpointCommandOutput) => void): void; + getEndpoint( args: GetEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEndpointCommandOutput) => void ): void; - public getEndpoint( - args: GetEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEndpointCommandOutput) => void), - cb?: (err: any, data?: GetEndpointCommandOutput) => void - ): Promise | void { - const command = new GetEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a Device Advisor test suite.

- *

Requires permission to access the GetSuiteDefinition action.

+ * @see {@link GetSuiteDefinitionCommand} */ - public getSuiteDefinition( + getSuiteDefinition( args: GetSuiteDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSuiteDefinition( + getSuiteDefinition( args: GetSuiteDefinitionCommandInput, cb: (err: any, data?: GetSuiteDefinitionCommandOutput) => void ): void; - public getSuiteDefinition( + getSuiteDefinition( args: GetSuiteDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSuiteDefinitionCommandOutput) => void ): void; - public getSuiteDefinition( - args: GetSuiteDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSuiteDefinitionCommandOutput) => void), - cb?: (err: any, data?: GetSuiteDefinitionCommandOutput) => void - ): Promise | void { - const command = new GetSuiteDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a Device Advisor test suite run.

- *

Requires permission to access the GetSuiteRun action.

+ * @see {@link GetSuiteRunCommand} */ - public getSuiteRun(args: GetSuiteRunCommandInput, options?: __HttpHandlerOptions): Promise; - public getSuiteRun(args: GetSuiteRunCommandInput, cb: (err: any, data?: GetSuiteRunCommandOutput) => void): void; - public getSuiteRun( + getSuiteRun(args: GetSuiteRunCommandInput, options?: __HttpHandlerOptions): Promise; + getSuiteRun(args: GetSuiteRunCommandInput, cb: (err: any, data?: GetSuiteRunCommandOutput) => void): void; + getSuiteRun( args: GetSuiteRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSuiteRunCommandOutput) => void ): void; - public getSuiteRun( - args: GetSuiteRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSuiteRunCommandOutput) => void), - cb?: (err: any, data?: GetSuiteRunCommandOutput) => void - ): Promise | void { - const command = new GetSuiteRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a report download link for a successful Device Advisor qualifying test suite run.

- *

Requires permission to access the GetSuiteRunReport action.

+ * @see {@link GetSuiteRunReportCommand} */ - public getSuiteRunReport( + getSuiteRunReport( args: GetSuiteRunReportCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSuiteRunReport( + getSuiteRunReport( args: GetSuiteRunReportCommandInput, cb: (err: any, data?: GetSuiteRunReportCommandOutput) => void ): void; - public getSuiteRunReport( + getSuiteRunReport( args: GetSuiteRunReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSuiteRunReportCommandOutput) => void ): void; - public getSuiteRunReport( - args: GetSuiteRunReportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSuiteRunReportCommandOutput) => void), - cb?: (err: any, data?: GetSuiteRunReportCommandOutput) => void - ): Promise | void { - const command = new GetSuiteRunReportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the Device Advisor test suites you have created.

- *

Requires permission to access the ListSuiteDefinitions action.

+ * @see {@link ListSuiteDefinitionsCommand} */ - public listSuiteDefinitions( + listSuiteDefinitions( args: ListSuiteDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSuiteDefinitions( + listSuiteDefinitions( args: ListSuiteDefinitionsCommandInput, cb: (err: any, data?: ListSuiteDefinitionsCommandOutput) => void ): void; - public listSuiteDefinitions( + listSuiteDefinitions( args: ListSuiteDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSuiteDefinitionsCommandOutput) => void ): void; - public listSuiteDefinitions( - args: ListSuiteDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSuiteDefinitionsCommandOutput) => void), - cb?: (err: any, data?: ListSuiteDefinitionsCommandOutput) => void - ): Promise | void { - const command = new ListSuiteDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists runs of the specified Device Advisor test suite. You can list all runs of the test - * suite, or the runs of a specific version of the test suite.

- *

Requires permission to access the ListSuiteRuns action.

+ * @see {@link ListSuiteRunsCommand} */ - public listSuiteRuns( - args: ListSuiteRunsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listSuiteRuns( - args: ListSuiteRunsCommandInput, - cb: (err: any, data?: ListSuiteRunsCommandOutput) => void - ): void; - public listSuiteRuns( + listSuiteRuns(args: ListSuiteRunsCommandInput, options?: __HttpHandlerOptions): Promise; + listSuiteRuns(args: ListSuiteRunsCommandInput, cb: (err: any, data?: ListSuiteRunsCommandOutput) => void): void; + listSuiteRuns( args: ListSuiteRunsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSuiteRunsCommandOutput) => void ): void; - public listSuiteRuns( - args: ListSuiteRunsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSuiteRunsCommandOutput) => void), - cb?: (err: any, data?: ListSuiteRunsCommandOutput) => void - ): Promise | void { - const command = new ListSuiteRunsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags attached to an IoT Device Advisor resource.

- *

Requires permission to access the ListTagsForResource action.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a Device Advisor test suite run.

- *

Requires permission to access the StartSuiteRun action.

+ * @see {@link StartSuiteRunCommand} */ - public startSuiteRun( - args: StartSuiteRunCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public startSuiteRun( - args: StartSuiteRunCommandInput, - cb: (err: any, data?: StartSuiteRunCommandOutput) => void - ): void; - public startSuiteRun( + startSuiteRun(args: StartSuiteRunCommandInput, options?: __HttpHandlerOptions): Promise; + startSuiteRun(args: StartSuiteRunCommandInput, cb: (err: any, data?: StartSuiteRunCommandOutput) => void): void; + startSuiteRun( args: StartSuiteRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSuiteRunCommandOutput) => void ): void; - public startSuiteRun( - args: StartSuiteRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartSuiteRunCommandOutput) => void), - cb?: (err: any, data?: StartSuiteRunCommandOutput) => void - ): Promise | void { - const command = new StartSuiteRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops a Device Advisor test suite run that is currently running.

- *

Requires permission to access the StopSuiteRun action.

+ * @see {@link StopSuiteRunCommand} */ - public stopSuiteRun( - args: StopSuiteRunCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public stopSuiteRun(args: StopSuiteRunCommandInput, cb: (err: any, data?: StopSuiteRunCommandOutput) => void): void; - public stopSuiteRun( + stopSuiteRun(args: StopSuiteRunCommandInput, options?: __HttpHandlerOptions): Promise; + stopSuiteRun(args: StopSuiteRunCommandInput, cb: (err: any, data?: StopSuiteRunCommandOutput) => void): void; + stopSuiteRun( args: StopSuiteRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopSuiteRunCommandOutput) => void ): void; - public stopSuiteRun( - args: StopSuiteRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopSuiteRunCommandOutput) => void), - cb?: (err: any, data?: StopSuiteRunCommandOutput) => void - ): Promise | void { - const command = new StopSuiteRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds to and modifies existing tags of an IoT Device Advisor resource.

- *

Requires permission to access the TagResource action.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from an IoT Device Advisor resource.

- *

Requires permission to access the UntagResource action.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a Device Advisor test suite.

- *

Requires permission to access the UpdateSuiteDefinition action.

+ * @see {@link UpdateSuiteDefinitionCommand} */ - public updateSuiteDefinition( + updateSuiteDefinition( args: UpdateSuiteDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSuiteDefinition( + updateSuiteDefinition( args: UpdateSuiteDefinitionCommandInput, cb: (err: any, data?: UpdateSuiteDefinitionCommandOutput) => void ): void; - public updateSuiteDefinition( + updateSuiteDefinition( args: UpdateSuiteDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSuiteDefinitionCommandOutput) => void ): void; - public updateSuiteDefinition( - args: UpdateSuiteDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSuiteDefinitionCommandOutput) => void), - cb?: (err: any, data?: UpdateSuiteDefinitionCommandOutput) => void - ): Promise | void { - const command = new UpdateSuiteDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Web Services IoT Core Device Advisor is a cloud-based, fully managed test capability for validating IoT + * devices during device software development. Device Advisor provides pre-built tests that you + * can use to validate IoT devices for reliable and secure connectivity with Amazon Web Services IoT Core + * before deploying devices to production. By using Device Advisor, you can confirm that your + * devices can connect to Amazon Web Services IoT Core, follow security best practices and, if applicable, + * receive software updates from IoT Device Management. You can also download signed + * qualification reports to submit to the Amazon Web Services Partner Network to get your device + * qualified for the Amazon Web Services Partner Device Catalog without the need to send your device in + * and wait for it to be tested.

+ */ +export class IotDeviceAdvisor extends IotDeviceAdvisorClient implements IotDeviceAdvisor {} +createAggregatedClient(commands, IotDeviceAdvisor); diff --git a/clients/client-iotfleethub/src/IoTFleetHub.ts b/clients/client-iotfleethub/src/IoTFleetHub.ts index d6cb685905fb..a47379ae3692 100644 --- a/clients/client-iotfleethub/src/IoTFleetHub.ts +++ b/clients/client-iotfleethub/src/IoTFleetHub.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -37,295 +38,151 @@ import { UpdateApplicationCommandInput, UpdateApplicationCommandOutput, } from "./commands/UpdateApplicationCommand"; -import { IoTFleetHubClient } from "./IoTFleetHubClient"; +import { IoTFleetHubClient, IoTFleetHubClientConfig } from "./IoTFleetHubClient"; -/** - * @public - *

With Fleet Hub for AWS IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets.

- * - *

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

- *
- */ -export class IoTFleetHub extends IoTFleetHubClient { +const commands = { + CreateApplicationCommand, + DeleteApplicationCommand, + DescribeApplicationCommand, + ListApplicationsCommand, + ListTagsForResourceCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateApplicationCommand, +}; + +export interface IoTFleetHub { /** - * @public - *

Creates a Fleet Hub for AWS IoT Device Management web application.

- * - *

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

- *
+ * @see {@link CreateApplicationCommand} */ - public createApplication( + createApplication( args: CreateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApplication( + createApplication( args: CreateApplicationCommandInput, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( + createApplication( args: CreateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( - args: CreateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApplicationCommandOutput) => void), - cb?: (err: any, data?: CreateApplicationCommandOutput) => void - ): Promise | void { - const command = new CreateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Fleet Hub for AWS IoT Device Management web application.

- * - *

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

- *
+ * @see {@link DeleteApplicationCommand} */ - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( - args: DeleteApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApplicationCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a Fleet Hub for AWS IoT Device Management web application.

- * - *

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

- *
+ * @see {@link DescribeApplicationCommand} */ - public describeApplication( + describeApplication( args: DescribeApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeApplication( + describeApplication( args: DescribeApplicationCommandInput, cb: (err: any, data?: DescribeApplicationCommandOutput) => void ): void; - public describeApplication( + describeApplication( args: DescribeApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeApplicationCommandOutput) => void ): void; - public describeApplication( - args: DescribeApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeApplicationCommandOutput) => void), - cb?: (err: any, data?: DescribeApplicationCommandOutput) => void - ): Promise | void { - const command = new DescribeApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account.

- * - *

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

- *
+ * @see {@link ListApplicationsCommand} */ - public listApplications( + listApplications( args: ListApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplications( + listApplications( args: ListApplicationsCommandInput, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( + listApplications( args: ListApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( - args: ListApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationsCommandOutput) => void), - cb?: (err: any, data?: ListApplicationsCommandOutput) => void - ): Promise | void { - const command = new ListApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags for the specified resource.

- * - *

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

- *
+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.

- * - *

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

- *
+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified tags (metadata) from the resource.

- * - *

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

- *
+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates information about a Fleet Hub for a AWS IoT Device Management web application.

- * - *

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

- *
+ * @see {@link UpdateApplicationCommand} */ - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( - args: UpdateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApplicationCommandOutput) => void), - cb?: (err: any, data?: UpdateApplicationCommandOutput) => void - ): Promise | void { - const command = new UpdateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

With Fleet Hub for AWS IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets.

+ * + *

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

+ *
+ */ +export class IoTFleetHub extends IoTFleetHubClient implements IoTFleetHub {} +createAggregatedClient(commands, IoTFleetHub); diff --git a/clients/client-iotfleetwise/src/IoTFleetWise.ts b/clients/client-iotfleetwise/src/IoTFleetWise.ts index 711607f0d4d7..9f5fc49eaf40 100644 --- a/clients/client-iotfleetwise/src/IoTFleetWise.ts +++ b/clients/client-iotfleetwise/src/IoTFleetWise.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -219,1760 +220,826 @@ import { UpdateVehicleCommandInput, UpdateVehicleCommandOutput, } from "./commands/UpdateVehicleCommand"; -import { IoTFleetWiseClient } from "./IoTFleetWiseClient"; +import { IoTFleetWiseClient, IoTFleetWiseClientConfig } from "./IoTFleetWiseClient"; -/** - * @public - *

Amazon Web Services IoT FleetWise is a fully managed service that you can use to collect, model, and transfer - * vehicle data to the Amazon Web Services cloud at scale. With Amazon Web Services IoT FleetWise, you can standardize all of - * your vehicle data models, independent of the in-vehicle communication architecture, and - * define data collection rules to transfer only high-value data to the cloud. - *

- *

For more information, see What is Amazon Web Services IoT FleetWise? in the - * Amazon Web Services IoT FleetWise Developer Guide.

- */ -export class IoTFleetWise extends IoTFleetWiseClient { +const commands = { + AssociateVehicleFleetCommand, + BatchCreateVehicleCommand, + BatchUpdateVehicleCommand, + CreateCampaignCommand, + CreateDecoderManifestCommand, + CreateFleetCommand, + CreateModelManifestCommand, + CreateSignalCatalogCommand, + CreateVehicleCommand, + DeleteCampaignCommand, + DeleteDecoderManifestCommand, + DeleteFleetCommand, + DeleteModelManifestCommand, + DeleteSignalCatalogCommand, + DeleteVehicleCommand, + DisassociateVehicleFleetCommand, + GetCampaignCommand, + GetDecoderManifestCommand, + GetFleetCommand, + GetLoggingOptionsCommand, + GetModelManifestCommand, + GetRegisterAccountStatusCommand, + GetSignalCatalogCommand, + GetVehicleCommand, + GetVehicleStatusCommand, + ImportDecoderManifestCommand, + ImportSignalCatalogCommand, + ListCampaignsCommand, + ListDecoderManifestNetworkInterfacesCommand, + ListDecoderManifestsCommand, + ListDecoderManifestSignalsCommand, + ListFleetsCommand, + ListFleetsForVehicleCommand, + ListModelManifestNodesCommand, + ListModelManifestsCommand, + ListSignalCatalogNodesCommand, + ListSignalCatalogsCommand, + ListTagsForResourceCommand, + ListVehiclesCommand, + ListVehiclesInFleetCommand, + PutLoggingOptionsCommand, + RegisterAccountCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateCampaignCommand, + UpdateDecoderManifestCommand, + UpdateFleetCommand, + UpdateModelManifestCommand, + UpdateSignalCatalogCommand, + UpdateVehicleCommand, +}; + +export interface IoTFleetWise { /** - * @public - *

Adds, or associates, a vehicle with a fleet.

+ * @see {@link AssociateVehicleFleetCommand} */ - public associateVehicleFleet( + associateVehicleFleet( args: AssociateVehicleFleetCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateVehicleFleet( + associateVehicleFleet( args: AssociateVehicleFleetCommandInput, cb: (err: any, data?: AssociateVehicleFleetCommandOutput) => void ): void; - public associateVehicleFleet( + associateVehicleFleet( args: AssociateVehicleFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateVehicleFleetCommandOutput) => void ): void; - public associateVehicleFleet( - args: AssociateVehicleFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateVehicleFleetCommandOutput) => void), - cb?: (err: any, data?: AssociateVehicleFleetCommandOutput) => void - ): Promise | void { - const command = new AssociateVehicleFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a group, or batch, of vehicles.

- * - *

You must specify a decoder manifest and a vehicle model (model manifest) for each - * vehicle.

- *
- *

For more information, see Create multiple - * vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.

+ * @see {@link BatchCreateVehicleCommand} */ - public batchCreateVehicle( + batchCreateVehicle( args: BatchCreateVehicleCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchCreateVehicle( + batchCreateVehicle( args: BatchCreateVehicleCommandInput, cb: (err: any, data?: BatchCreateVehicleCommandOutput) => void ): void; - public batchCreateVehicle( + batchCreateVehicle( args: BatchCreateVehicleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCreateVehicleCommandOutput) => void ): void; - public batchCreateVehicle( - args: BatchCreateVehicleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchCreateVehicleCommandOutput) => void), - cb?: (err: any, data?: BatchCreateVehicleCommandOutput) => void - ): Promise | void { - const command = new BatchCreateVehicleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a group, or batch, of vehicles.

- * - *

You must specify a decoder manifest and a vehicle model (model manifest) for each - * vehicle.

- *
- *

For more information, see Update multiple - * vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.

+ * @see {@link BatchUpdateVehicleCommand} */ - public batchUpdateVehicle( + batchUpdateVehicle( args: BatchUpdateVehicleCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchUpdateVehicle( + batchUpdateVehicle( args: BatchUpdateVehicleCommandInput, cb: (err: any, data?: BatchUpdateVehicleCommandOutput) => void ): void; - public batchUpdateVehicle( + batchUpdateVehicle( args: BatchUpdateVehicleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchUpdateVehicleCommandOutput) => void ): void; - public batchUpdateVehicle( - args: BatchUpdateVehicleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchUpdateVehicleCommandOutput) => void), - cb?: (err: any, data?: BatchUpdateVehicleCommandOutput) => void - ): Promise | void { - const command = new BatchUpdateVehicleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an orchestration of data collection rules. The Amazon Web Services IoT FleetWise Edge Agent software - * running in vehicles uses campaigns to decide how to collect and transfer data to the - * cloud. You create campaigns in the cloud. After you or your team approve campaigns, - * Amazon Web Services IoT FleetWise automatically deploys them to vehicles.

- *

For more information, see Collect and transfer data - * with campaigns in the Amazon Web Services IoT FleetWise Developer Guide.

+ * @see {@link CreateCampaignCommand} */ - public createCampaign( + createCampaign( args: CreateCampaignCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCampaign( - args: CreateCampaignCommandInput, - cb: (err: any, data?: CreateCampaignCommandOutput) => void - ): void; - public createCampaign( + createCampaign(args: CreateCampaignCommandInput, cb: (err: any, data?: CreateCampaignCommandOutput) => void): void; + createCampaign( args: CreateCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCampaignCommandOutput) => void ): void; - public createCampaign( - args: CreateCampaignCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCampaignCommandOutput) => void), - cb?: (err: any, data?: CreateCampaignCommandOutput) => void - ): Promise | void { - const command = new CreateCampaignCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates the decoder manifest associated with a model manifest. To create a decoder - * manifest, the following must be true:

- *
    - *
  • - *

    Every signal decoder has a unique name.

    - *
  • - *
  • - *

    Each signal decoder is associated with a network interface.

    - *
  • - *
  • - *

    Each network interface has a unique ID.

    - *
  • - *
  • - *

    The signal decoders are specified in the model manifest.

    - *
  • - *
+ * @see {@link CreateDecoderManifestCommand} */ - public createDecoderManifest( + createDecoderManifest( args: CreateDecoderManifestCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDecoderManifest( + createDecoderManifest( args: CreateDecoderManifestCommandInput, cb: (err: any, data?: CreateDecoderManifestCommandOutput) => void ): void; - public createDecoderManifest( + createDecoderManifest( args: CreateDecoderManifestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDecoderManifestCommandOutput) => void ): void; - public createDecoderManifest( - args: CreateDecoderManifestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDecoderManifestCommandOutput) => void), - cb?: (err: any, data?: CreateDecoderManifestCommandOutput) => void - ): Promise | void { - const command = new CreateDecoderManifestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a fleet that represents a group of vehicles. - *

- * - *

You must create both a signal catalog and vehicles before you can create a fleet. - *

- *
- *

For more information, see Fleets in the - * Amazon Web Services IoT FleetWise Developer Guide.

+ * @see {@link CreateFleetCommand} */ - public createFleet(args: CreateFleetCommandInput, options?: __HttpHandlerOptions): Promise; - public createFleet(args: CreateFleetCommandInput, cb: (err: any, data?: CreateFleetCommandOutput) => void): void; - public createFleet( + createFleet(args: CreateFleetCommandInput, options?: __HttpHandlerOptions): Promise; + createFleet(args: CreateFleetCommandInput, cb: (err: any, data?: CreateFleetCommandOutput) => void): void; + createFleet( args: CreateFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFleetCommandOutput) => void ): void; - public createFleet( - args: CreateFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFleetCommandOutput) => void), - cb?: (err: any, data?: CreateFleetCommandOutput) => void - ): Promise | void { - const command = new CreateFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a vehicle model (model manifest) that specifies signals (attributes, - * branches, sensors, and actuators).

- *

For more information, see Vehicle models - * in the Amazon Web Services IoT FleetWise Developer Guide.

+ * @see {@link CreateModelManifestCommand} */ - public createModelManifest( + createModelManifest( args: CreateModelManifestCommandInput, options?: __HttpHandlerOptions ): Promise; - public createModelManifest( + createModelManifest( args: CreateModelManifestCommandInput, cb: (err: any, data?: CreateModelManifestCommandOutput) => void ): void; - public createModelManifest( + createModelManifest( args: CreateModelManifestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateModelManifestCommandOutput) => void ): void; - public createModelManifest( - args: CreateModelManifestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateModelManifestCommandOutput) => void), - cb?: (err: any, data?: CreateModelManifestCommandOutput) => void - ): Promise | void { - const command = new CreateModelManifestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a collection of standardized signals that can be reused to create vehicle - * models.

+ * @see {@link CreateSignalCatalogCommand} */ - public createSignalCatalog( + createSignalCatalog( args: CreateSignalCatalogCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSignalCatalog( + createSignalCatalog( args: CreateSignalCatalogCommandInput, cb: (err: any, data?: CreateSignalCatalogCommandOutput) => void ): void; - public createSignalCatalog( + createSignalCatalog( args: CreateSignalCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSignalCatalogCommandOutput) => void ): void; - public createSignalCatalog( - args: CreateSignalCatalogCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSignalCatalogCommandOutput) => void), - cb?: (err: any, data?: CreateSignalCatalogCommandOutput) => void - ): Promise | void { - const command = new CreateSignalCatalogCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a vehicle, which is an instance of a vehicle model (model manifest). Vehicles - * created from the same vehicle model consist of the same signals inherited from the - * vehicle model.

- * - *

If you have an existing Amazon Web Services IoT Thing, you can use Amazon Web Services IoT FleetWise to create a - * vehicle and collect data from your thing.

- *
- *

For more information, see Create a vehicle - * (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.

+ * @see {@link CreateVehicleCommand} */ - public createVehicle( - args: CreateVehicleCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createVehicle( - args: CreateVehicleCommandInput, - cb: (err: any, data?: CreateVehicleCommandOutput) => void - ): void; - public createVehicle( + createVehicle(args: CreateVehicleCommandInput, options?: __HttpHandlerOptions): Promise; + createVehicle(args: CreateVehicleCommandInput, cb: (err: any, data?: CreateVehicleCommandOutput) => void): void; + createVehicle( args: CreateVehicleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVehicleCommandOutput) => void ): void; - public createVehicle( - args: CreateVehicleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVehicleCommandOutput) => void), - cb?: (err: any, data?: CreateVehicleCommandOutput) => void - ): Promise | void { - const command = new CreateVehicleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a data collection campaign. Deleting a campaign suspends all data collection - * and removes it from any vehicles.

+ * @see {@link DeleteCampaignCommand} */ - public deleteCampaign( + deleteCampaign( args: DeleteCampaignCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCampaign( - args: DeleteCampaignCommandInput, - cb: (err: any, data?: DeleteCampaignCommandOutput) => void - ): void; - public deleteCampaign( + deleteCampaign(args: DeleteCampaignCommandInput, cb: (err: any, data?: DeleteCampaignCommandOutput) => void): void; + deleteCampaign( args: DeleteCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCampaignCommandOutput) => void ): void; - public deleteCampaign( - args: DeleteCampaignCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCampaignCommandOutput) => void), - cb?: (err: any, data?: DeleteCampaignCommandOutput) => void - ): Promise | void { - const command = new DeleteCampaignCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a decoder manifest. You can't delete a decoder manifest if it has vehicles - * associated with it.

- * - *

If the decoder manifest is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 - * response with an empty body.

- *
+ * @see {@link DeleteDecoderManifestCommand} */ - public deleteDecoderManifest( + deleteDecoderManifest( args: DeleteDecoderManifestCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDecoderManifest( + deleteDecoderManifest( args: DeleteDecoderManifestCommandInput, cb: (err: any, data?: DeleteDecoderManifestCommandOutput) => void ): void; - public deleteDecoderManifest( + deleteDecoderManifest( args: DeleteDecoderManifestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDecoderManifestCommandOutput) => void ): void; - public deleteDecoderManifest( - args: DeleteDecoderManifestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDecoderManifestCommandOutput) => void), - cb?: (err: any, data?: DeleteDecoderManifestCommandOutput) => void - ): Promise | void { - const command = new DeleteDecoderManifestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a fleet. Before you delete a fleet, all vehicles must be - * dissociated from the fleet. For more information, see Delete a fleet (AWS - * CLI) in the Amazon Web Services IoT FleetWise Developer Guide.

- * - *

If the fleet is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response - * with an empty body.

- *
+ * @see {@link DeleteFleetCommand} */ - public deleteFleet(args: DeleteFleetCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteFleet(args: DeleteFleetCommandInput, cb: (err: any, data?: DeleteFleetCommandOutput) => void): void; - public deleteFleet( + deleteFleet(args: DeleteFleetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteFleet(args: DeleteFleetCommandInput, cb: (err: any, data?: DeleteFleetCommandOutput) => void): void; + deleteFleet( args: DeleteFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFleetCommandOutput) => void ): void; - public deleteFleet( - args: DeleteFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFleetCommandOutput) => void), - cb?: (err: any, data?: DeleteFleetCommandOutput) => void - ): Promise | void { - const command = new DeleteFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a vehicle model (model manifest).

- * - *

If the vehicle model is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 - * response with an empty body.

- *
+ * @see {@link DeleteModelManifestCommand} */ - public deleteModelManifest( + deleteModelManifest( args: DeleteModelManifestCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteModelManifest( + deleteModelManifest( args: DeleteModelManifestCommandInput, cb: (err: any, data?: DeleteModelManifestCommandOutput) => void ): void; - public deleteModelManifest( + deleteModelManifest( args: DeleteModelManifestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteModelManifestCommandOutput) => void ): void; - public deleteModelManifest( - args: DeleteModelManifestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteModelManifestCommandOutput) => void), - cb?: (err: any, data?: DeleteModelManifestCommandOutput) => void - ): Promise | void { - const command = new DeleteModelManifestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a signal catalog.

- * - *

If the signal catalog is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 - * response with an empty body.

- *
+ * @see {@link DeleteSignalCatalogCommand} */ - public deleteSignalCatalog( + deleteSignalCatalog( args: DeleteSignalCatalogCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSignalCatalog( + deleteSignalCatalog( args: DeleteSignalCatalogCommandInput, cb: (err: any, data?: DeleteSignalCatalogCommandOutput) => void ): void; - public deleteSignalCatalog( + deleteSignalCatalog( args: DeleteSignalCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSignalCatalogCommandOutput) => void ): void; - public deleteSignalCatalog( - args: DeleteSignalCatalogCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSignalCatalogCommandOutput) => void), - cb?: (err: any, data?: DeleteSignalCatalogCommandOutput) => void - ): Promise | void { - const command = new DeleteSignalCatalogCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a vehicle and removes it from any campaigns.

- * - *

If the vehicle is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response - * with an empty body.

- *
+ * @see {@link DeleteVehicleCommand} */ - public deleteVehicle( - args: DeleteVehicleCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteVehicle( - args: DeleteVehicleCommandInput, - cb: (err: any, data?: DeleteVehicleCommandOutput) => void - ): void; - public deleteVehicle( + deleteVehicle(args: DeleteVehicleCommandInput, options?: __HttpHandlerOptions): Promise; + deleteVehicle(args: DeleteVehicleCommandInput, cb: (err: any, data?: DeleteVehicleCommandOutput) => void): void; + deleteVehicle( args: DeleteVehicleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVehicleCommandOutput) => void ): void; - public deleteVehicle( - args: DeleteVehicleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVehicleCommandOutput) => void), - cb?: (err: any, data?: DeleteVehicleCommandOutput) => void - ): Promise | void { - const command = new DeleteVehicleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a - * fleet doesn't delete the vehicle.

- * - *

If the vehicle is successfully dissociated from a fleet, Amazon Web Services IoT FleetWise sends back an - * HTTP 200 response with an empty body.

- *
+ * @see {@link DisassociateVehicleFleetCommand} */ - public disassociateVehicleFleet( + disassociateVehicleFleet( args: DisassociateVehicleFleetCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateVehicleFleet( + disassociateVehicleFleet( args: DisassociateVehicleFleetCommandInput, cb: (err: any, data?: DisassociateVehicleFleetCommandOutput) => void ): void; - public disassociateVehicleFleet( + disassociateVehicleFleet( args: DisassociateVehicleFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateVehicleFleetCommandOutput) => void ): void; - public disassociateVehicleFleet( - args: DisassociateVehicleFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateVehicleFleetCommandOutput) => void), - cb?: (err: any, data?: DisassociateVehicleFleetCommandOutput) => void - ): Promise | void { - const command = new DisassociateVehicleFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a campaign.

+ * @see {@link GetCampaignCommand} */ - public getCampaign(args: GetCampaignCommandInput, options?: __HttpHandlerOptions): Promise; - public getCampaign(args: GetCampaignCommandInput, cb: (err: any, data?: GetCampaignCommandOutput) => void): void; - public getCampaign( + getCampaign(args: GetCampaignCommandInput, options?: __HttpHandlerOptions): Promise; + getCampaign(args: GetCampaignCommandInput, cb: (err: any, data?: GetCampaignCommandOutput) => void): void; + getCampaign( args: GetCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCampaignCommandOutput) => void ): void; - public getCampaign( - args: GetCampaignCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCampaignCommandOutput) => void), - cb?: (err: any, data?: GetCampaignCommandOutput) => void - ): Promise | void { - const command = new GetCampaignCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a created decoder manifest.

+ * @see {@link GetDecoderManifestCommand} */ - public getDecoderManifest( + getDecoderManifest( args: GetDecoderManifestCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDecoderManifest( + getDecoderManifest( args: GetDecoderManifestCommandInput, cb: (err: any, data?: GetDecoderManifestCommandOutput) => void ): void; - public getDecoderManifest( + getDecoderManifest( args: GetDecoderManifestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDecoderManifestCommandOutput) => void ): void; - public getDecoderManifest( - args: GetDecoderManifestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDecoderManifestCommandOutput) => void), - cb?: (err: any, data?: GetDecoderManifestCommandOutput) => void - ): Promise | void { - const command = new GetDecoderManifestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a fleet.

+ * @see {@link GetFleetCommand} */ - public getFleet(args: GetFleetCommandInput, options?: __HttpHandlerOptions): Promise; - public getFleet(args: GetFleetCommandInput, cb: (err: any, data?: GetFleetCommandOutput) => void): void; - public getFleet( + getFleet(args: GetFleetCommandInput, options?: __HttpHandlerOptions): Promise; + getFleet(args: GetFleetCommandInput, cb: (err: any, data?: GetFleetCommandOutput) => void): void; + getFleet( args: GetFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFleetCommandOutput) => void ): void; - public getFleet( - args: GetFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFleetCommandOutput) => void), - cb?: (err: any, data?: GetFleetCommandOutput) => void - ): Promise | void { - const command = new GetFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the logging options.

+ * @see {@link GetLoggingOptionsCommand} */ - public getLoggingOptions( + getLoggingOptions( args: GetLoggingOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLoggingOptions( + getLoggingOptions( args: GetLoggingOptionsCommandInput, cb: (err: any, data?: GetLoggingOptionsCommandOutput) => void ): void; - public getLoggingOptions( + getLoggingOptions( args: GetLoggingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLoggingOptionsCommandOutput) => void ): void; - public getLoggingOptions( - args: GetLoggingOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLoggingOptionsCommandOutput) => void), - cb?: (err: any, data?: GetLoggingOptionsCommandOutput) => void - ): Promise | void { - const command = new GetLoggingOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a vehicle model (model manifest).

+ * @see {@link GetModelManifestCommand} */ - public getModelManifest( + getModelManifest( args: GetModelManifestCommandInput, options?: __HttpHandlerOptions ): Promise; - public getModelManifest( + getModelManifest( args: GetModelManifestCommandInput, cb: (err: any, data?: GetModelManifestCommandOutput) => void ): void; - public getModelManifest( + getModelManifest( args: GetModelManifestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetModelManifestCommandOutput) => void ): void; - public getModelManifest( - args: GetModelManifestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetModelManifestCommandOutput) => void), - cb?: (err: any, data?: GetModelManifestCommandOutput) => void - ): Promise | void { - const command = new GetModelManifestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status of registering your Amazon Web Services account, IAM, and - * Amazon Timestream resources so that Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services - * Cloud.

- *

For more information, including step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise.

- * - *

This API operation doesn't require input parameters.

- *
+ * @see {@link GetRegisterAccountStatusCommand} */ - public getRegisterAccountStatus( + getRegisterAccountStatus( args: GetRegisterAccountStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRegisterAccountStatus( + getRegisterAccountStatus( args: GetRegisterAccountStatusCommandInput, cb: (err: any, data?: GetRegisterAccountStatusCommandOutput) => void ): void; - public getRegisterAccountStatus( + getRegisterAccountStatus( args: GetRegisterAccountStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRegisterAccountStatusCommandOutput) => void ): void; - public getRegisterAccountStatus( - args: GetRegisterAccountStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRegisterAccountStatusCommandOutput) => void), - cb?: (err: any, data?: GetRegisterAccountStatusCommandOutput) => void - ): Promise | void { - const command = new GetRegisterAccountStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a signal catalog.

+ * @see {@link GetSignalCatalogCommand} */ - public getSignalCatalog( + getSignalCatalog( args: GetSignalCatalogCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSignalCatalog( + getSignalCatalog( args: GetSignalCatalogCommandInput, cb: (err: any, data?: GetSignalCatalogCommandOutput) => void ): void; - public getSignalCatalog( + getSignalCatalog( args: GetSignalCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSignalCatalogCommandOutput) => void ): void; - public getSignalCatalog( - args: GetSignalCatalogCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSignalCatalogCommandOutput) => void), - cb?: (err: any, data?: GetSignalCatalogCommandOutput) => void - ): Promise | void { - const command = new GetSignalCatalogCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a vehicle.

+ * @see {@link GetVehicleCommand} */ - public getVehicle(args: GetVehicleCommandInput, options?: __HttpHandlerOptions): Promise; - public getVehicle(args: GetVehicleCommandInput, cb: (err: any, data?: GetVehicleCommandOutput) => void): void; - public getVehicle( + getVehicle(args: GetVehicleCommandInput, options?: __HttpHandlerOptions): Promise; + getVehicle(args: GetVehicleCommandInput, cb: (err: any, data?: GetVehicleCommandOutput) => void): void; + getVehicle( args: GetVehicleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVehicleCommandOutput) => void ): void; - public getVehicle( - args: GetVehicleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVehicleCommandOutput) => void), - cb?: (err: any, data?: GetVehicleCommandOutput) => void - ): Promise | void { - const command = new GetVehicleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status of a vehicle with any associated campaigns. - *

+ * @see {@link GetVehicleStatusCommand} */ - public getVehicleStatus( + getVehicleStatus( args: GetVehicleStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVehicleStatus( + getVehicleStatus( args: GetVehicleStatusCommandInput, cb: (err: any, data?: GetVehicleStatusCommandOutput) => void ): void; - public getVehicleStatus( + getVehicleStatus( args: GetVehicleStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVehicleStatusCommandOutput) => void ): void; - public getVehicleStatus( - args: GetVehicleStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVehicleStatusCommandOutput) => void), - cb?: (err: any, data?: GetVehicleStatusCommandOutput) => void - ): Promise | void { - const command = new GetVehicleStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a decoder manifest using your existing CAN DBC file from your local device. - *

+ * @see {@link ImportDecoderManifestCommand} */ - public importDecoderManifest( + importDecoderManifest( args: ImportDecoderManifestCommandInput, options?: __HttpHandlerOptions ): Promise; - public importDecoderManifest( + importDecoderManifest( args: ImportDecoderManifestCommandInput, cb: (err: any, data?: ImportDecoderManifestCommandOutput) => void ): void; - public importDecoderManifest( + importDecoderManifest( args: ImportDecoderManifestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportDecoderManifestCommandOutput) => void ): void; - public importDecoderManifest( - args: ImportDecoderManifestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportDecoderManifestCommandOutput) => void), - cb?: (err: any, data?: ImportDecoderManifestCommandOutput) => void - ): Promise | void { - const command = new ImportDecoderManifestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a signal catalog using your existing VSS formatted content from your local - * device.

+ * @see {@link ImportSignalCatalogCommand} */ - public importSignalCatalog( + importSignalCatalog( args: ImportSignalCatalogCommandInput, options?: __HttpHandlerOptions ): Promise; - public importSignalCatalog( + importSignalCatalog( args: ImportSignalCatalogCommandInput, cb: (err: any, data?: ImportSignalCatalogCommandOutput) => void ): void; - public importSignalCatalog( + importSignalCatalog( args: ImportSignalCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportSignalCatalogCommandOutput) => void ): void; - public importSignalCatalog( - args: ImportSignalCatalogCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportSignalCatalogCommandOutput) => void), - cb?: (err: any, data?: ImportSignalCatalogCommandOutput) => void - ): Promise | void { - const command = new ImportSignalCatalogCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists information about created campaigns.

- * - *

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

- *
+ * @see {@link ListCampaignsCommand} */ - public listCampaigns( - args: ListCampaignsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listCampaigns( - args: ListCampaignsCommandInput, - cb: (err: any, data?: ListCampaignsCommandOutput) => void - ): void; - public listCampaigns( + listCampaigns(args: ListCampaignsCommandInput, options?: __HttpHandlerOptions): Promise; + listCampaigns(args: ListCampaignsCommandInput, cb: (err: any, data?: ListCampaignsCommandOutput) => void): void; + listCampaigns( args: ListCampaignsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCampaignsCommandOutput) => void ): void; - public listCampaigns( - args: ListCampaignsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCampaignsCommandOutput) => void), - cb?: (err: any, data?: ListCampaignsCommandOutput) => void - ): Promise | void { - const command = new ListCampaignsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the network interfaces specified in a decoder manifest.

- * - *

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

- *
+ * @see {@link ListDecoderManifestNetworkInterfacesCommand} */ - public listDecoderManifestNetworkInterfaces( + listDecoderManifestNetworkInterfaces( args: ListDecoderManifestNetworkInterfacesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDecoderManifestNetworkInterfaces( + listDecoderManifestNetworkInterfaces( args: ListDecoderManifestNetworkInterfacesCommandInput, cb: (err: any, data?: ListDecoderManifestNetworkInterfacesCommandOutput) => void ): void; - public listDecoderManifestNetworkInterfaces( + listDecoderManifestNetworkInterfaces( args: ListDecoderManifestNetworkInterfacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDecoderManifestNetworkInterfacesCommandOutput) => void ): void; - public listDecoderManifestNetworkInterfaces( - args: ListDecoderManifestNetworkInterfacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDecoderManifestNetworkInterfacesCommandOutput) => void), - cb?: (err: any, data?: ListDecoderManifestNetworkInterfacesCommandOutput) => void - ): Promise | void { - const command = new ListDecoderManifestNetworkInterfacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists decoder manifests.

- * - *

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

- *
+ * @see {@link ListDecoderManifestsCommand} */ - public listDecoderManifests( + listDecoderManifests( args: ListDecoderManifestsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDecoderManifests( + listDecoderManifests( args: ListDecoderManifestsCommandInput, cb: (err: any, data?: ListDecoderManifestsCommandOutput) => void ): void; - public listDecoderManifests( + listDecoderManifests( args: ListDecoderManifestsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDecoderManifestsCommandOutput) => void ): void; - public listDecoderManifests( - args: ListDecoderManifestsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDecoderManifestsCommandOutput) => void), - cb?: (err: any, data?: ListDecoderManifestsCommandOutput) => void - ): Promise | void { - const command = new ListDecoderManifestsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A list of information about signal decoders specified in a decoder manifest.

- * - *

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

- *
+ * @see {@link ListDecoderManifestSignalsCommand} */ - public listDecoderManifestSignals( + listDecoderManifestSignals( args: ListDecoderManifestSignalsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDecoderManifestSignals( + listDecoderManifestSignals( args: ListDecoderManifestSignalsCommandInput, cb: (err: any, data?: ListDecoderManifestSignalsCommandOutput) => void ): void; - public listDecoderManifestSignals( + listDecoderManifestSignals( args: ListDecoderManifestSignalsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDecoderManifestSignalsCommandOutput) => void ): void; - public listDecoderManifestSignals( - args: ListDecoderManifestSignalsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDecoderManifestSignalsCommandOutput) => void), - cb?: (err: any, data?: ListDecoderManifestSignalsCommandOutput) => void - ): Promise | void { - const command = new ListDecoderManifestSignalsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information for each created fleet in an Amazon Web Services account.

- * - *

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

- *
+ * @see {@link ListFleetsCommand} */ - public listFleets(args: ListFleetsCommandInput, options?: __HttpHandlerOptions): Promise; - public listFleets(args: ListFleetsCommandInput, cb: (err: any, data?: ListFleetsCommandOutput) => void): void; - public listFleets( + listFleets(args: ListFleetsCommandInput, options?: __HttpHandlerOptions): Promise; + listFleets(args: ListFleetsCommandInput, cb: (err: any, data?: ListFleetsCommandOutput) => void): void; + listFleets( args: ListFleetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFleetsCommandOutput) => void ): void; - public listFleets( - args: ListFleetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFleetsCommandOutput) => void), - cb?: (err: any, data?: ListFleetsCommandOutput) => void - ): Promise | void { - const command = new ListFleetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of IDs for all fleets that the vehicle is associated with.

- * - *

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

- *
+ * @see {@link ListFleetsForVehicleCommand} */ - public listFleetsForVehicle( + listFleetsForVehicle( args: ListFleetsForVehicleCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFleetsForVehicle( + listFleetsForVehicle( args: ListFleetsForVehicleCommandInput, cb: (err: any, data?: ListFleetsForVehicleCommandOutput) => void ): void; - public listFleetsForVehicle( + listFleetsForVehicle( args: ListFleetsForVehicleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFleetsForVehicleCommandOutput) => void ): void; - public listFleetsForVehicle( - args: ListFleetsForVehicleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFleetsForVehicleCommandOutput) => void), - cb?: (err: any, data?: ListFleetsForVehicleCommandOutput) => void - ): Promise | void { - const command = new ListFleetsForVehicleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists information about nodes specified in a vehicle model (model manifest).

- * - *

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

- *
+ * @see {@link ListModelManifestNodesCommand} */ - public listModelManifestNodes( + listModelManifestNodes( args: ListModelManifestNodesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listModelManifestNodes( + listModelManifestNodes( args: ListModelManifestNodesCommandInput, cb: (err: any, data?: ListModelManifestNodesCommandOutput) => void ): void; - public listModelManifestNodes( + listModelManifestNodes( args: ListModelManifestNodesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListModelManifestNodesCommandOutput) => void ): void; - public listModelManifestNodes( - args: ListModelManifestNodesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListModelManifestNodesCommandOutput) => void), - cb?: (err: any, data?: ListModelManifestNodesCommandOutput) => void - ): Promise | void { - const command = new ListModelManifestNodesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of vehicle models (model manifests).

- * - *

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

- *
+ * @see {@link ListModelManifestsCommand} */ - public listModelManifests( + listModelManifests( args: ListModelManifestsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listModelManifests( + listModelManifests( args: ListModelManifestsCommandInput, cb: (err: any, data?: ListModelManifestsCommandOutput) => void ): void; - public listModelManifests( + listModelManifests( args: ListModelManifestsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListModelManifestsCommandOutput) => void ): void; - public listModelManifests( - args: ListModelManifestsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListModelManifestsCommandOutput) => void), - cb?: (err: any, data?: ListModelManifestsCommandOutput) => void - ): Promise | void { - const command = new ListModelManifestsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists of information about the signals (nodes) specified in a signal catalog.

- * - *

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

- *
+ * @see {@link ListSignalCatalogNodesCommand} */ - public listSignalCatalogNodes( + listSignalCatalogNodes( args: ListSignalCatalogNodesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSignalCatalogNodes( + listSignalCatalogNodes( args: ListSignalCatalogNodesCommandInput, cb: (err: any, data?: ListSignalCatalogNodesCommandOutput) => void ): void; - public listSignalCatalogNodes( + listSignalCatalogNodes( args: ListSignalCatalogNodesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSignalCatalogNodesCommandOutput) => void ): void; - public listSignalCatalogNodes( - args: ListSignalCatalogNodesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSignalCatalogNodesCommandOutput) => void), - cb?: (err: any, data?: ListSignalCatalogNodesCommandOutput) => void - ): Promise | void { - const command = new ListSignalCatalogNodesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the created signal catalogs in an Amazon Web Services account.

- *

You can use to list information about - * each signal (node) specified in a signal catalog.

- * - *

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

- *
+ * @see {@link ListSignalCatalogsCommand} */ - public listSignalCatalogs( + listSignalCatalogs( args: ListSignalCatalogsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSignalCatalogs( + listSignalCatalogs( args: ListSignalCatalogsCommandInput, cb: (err: any, data?: ListSignalCatalogsCommandOutput) => void ): void; - public listSignalCatalogs( + listSignalCatalogs( args: ListSignalCatalogsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSignalCatalogsCommandOutput) => void ): void; - public listSignalCatalogs( - args: ListSignalCatalogsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSignalCatalogsCommandOutput) => void), - cb?: (err: any, data?: ListSignalCatalogsCommandOutput) => void - ): Promise | void { - const command = new ListSignalCatalogsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags (metadata) you have assigned to the resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of summaries of created vehicles.

- * - *

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

- *
+ * @see {@link ListVehiclesCommand} */ - public listVehicles( - args: ListVehiclesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listVehicles(args: ListVehiclesCommandInput, cb: (err: any, data?: ListVehiclesCommandOutput) => void): void; - public listVehicles( + listVehicles(args: ListVehiclesCommandInput, options?: __HttpHandlerOptions): Promise; + listVehicles(args: ListVehiclesCommandInput, cb: (err: any, data?: ListVehiclesCommandOutput) => void): void; + listVehicles( args: ListVehiclesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVehiclesCommandOutput) => void ): void; - public listVehicles( - args: ListVehiclesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVehiclesCommandOutput) => void), - cb?: (err: any, data?: ListVehiclesCommandOutput) => void - ): Promise | void { - const command = new ListVehiclesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of summaries of all vehicles associated with a fleet.

- * - *

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

- *
+ * @see {@link ListVehiclesInFleetCommand} */ - public listVehiclesInFleet( + listVehiclesInFleet( args: ListVehiclesInFleetCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVehiclesInFleet( + listVehiclesInFleet( args: ListVehiclesInFleetCommandInput, cb: (err: any, data?: ListVehiclesInFleetCommandOutput) => void ): void; - public listVehiclesInFleet( + listVehiclesInFleet( args: ListVehiclesInFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVehiclesInFleetCommandOutput) => void ): void; - public listVehiclesInFleet( - args: ListVehiclesInFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVehiclesInFleetCommandOutput) => void), - cb?: (err: any, data?: ListVehiclesInFleetCommandOutput) => void - ): Promise | void { - const command = new ListVehiclesInFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates the logging option.

+ * @see {@link PutLoggingOptionsCommand} */ - public putLoggingOptions( + putLoggingOptions( args: PutLoggingOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putLoggingOptions( + putLoggingOptions( args: PutLoggingOptionsCommandInput, cb: (err: any, data?: PutLoggingOptionsCommandOutput) => void ): void; - public putLoggingOptions( + putLoggingOptions( args: PutLoggingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLoggingOptionsCommandOutput) => void ): void; - public putLoggingOptions( - args: PutLoggingOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutLoggingOptionsCommandOutput) => void), - cb?: (err: any, data?: PutLoggingOptionsCommandOutput) => void - ): Promise | void { - const command = new PutLoggingOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers your Amazon Web Services account, IAM, and Amazon Timestream resources so Amazon Web Services IoT FleetWise can - * transfer your vehicle data to the Amazon Web Services Cloud. For more information, including - * step-by-step procedures, see Setting up - * Amazon Web Services IoT FleetWise.

- * - *

An Amazon Web Services account is not the same thing as a "user - * account". An Amazon Web Services user is an identity that you create using Identity and Access Management (IAM) and - * takes the form of either an IAM user or an IAM role, both - * with credentials. A single Amazon Web Services account can, and typically does, - * contain many users and roles.

- *
+ * @see {@link RegisterAccountCommand} */ - public registerAccount( + registerAccount( args: RegisterAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerAccount( - args: RegisterAccountCommandInput, - cb: (err: any, data?: RegisterAccountCommandOutput) => void - ): void; - public registerAccount( + registerAccount(args: RegisterAccountCommandInput, cb: (err: any, data?: RegisterAccountCommandOutput) => void): void; + registerAccount( args: RegisterAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterAccountCommandOutput) => void ): void; - public registerAccount( - args: RegisterAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterAccountCommandOutput) => void), - cb?: (err: any, data?: RegisterAccountCommandOutput) => void - ): Promise | void { - const command = new RegisterAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds to or modifies the tags of the given resource. Tags are metadata which can be - * used to manage a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the given tags (metadata) from the resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a campaign.

+ * @see {@link UpdateCampaignCommand} */ - public updateCampaign( + updateCampaign( args: UpdateCampaignCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCampaign( - args: UpdateCampaignCommandInput, - cb: (err: any, data?: UpdateCampaignCommandOutput) => void - ): void; - public updateCampaign( + updateCampaign(args: UpdateCampaignCommandInput, cb: (err: any, data?: UpdateCampaignCommandOutput) => void): void; + updateCampaign( args: UpdateCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCampaignCommandOutput) => void ): void; - public updateCampaign( - args: UpdateCampaignCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCampaignCommandOutput) => void), - cb?: (err: any, data?: UpdateCampaignCommandOutput) => void - ): Promise | void { - const command = new UpdateCampaignCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a decoder manifest.

- *

A decoder manifest can only be updated when the status is DRAFT. Only - * ACTIVE decoder manifests can be associated with vehicles.

+ * @see {@link UpdateDecoderManifestCommand} */ - public updateDecoderManifest( + updateDecoderManifest( args: UpdateDecoderManifestCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDecoderManifest( + updateDecoderManifest( args: UpdateDecoderManifestCommandInput, cb: (err: any, data?: UpdateDecoderManifestCommandOutput) => void ): void; - public updateDecoderManifest( + updateDecoderManifest( args: UpdateDecoderManifestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDecoderManifestCommandOutput) => void ): void; - public updateDecoderManifest( - args: UpdateDecoderManifestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDecoderManifestCommandOutput) => void), - cb?: (err: any, data?: UpdateDecoderManifestCommandOutput) => void - ): Promise | void { - const command = new UpdateDecoderManifestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the description of an existing fleet.

- * - *

If the fleet is successfully updated, Amazon Web Services IoT FleetWise sends back an HTTP 200 response - * with an empty HTTP body.

- *
+ * @see {@link UpdateFleetCommand} */ - public updateFleet(args: UpdateFleetCommandInput, options?: __HttpHandlerOptions): Promise; - public updateFleet(args: UpdateFleetCommandInput, cb: (err: any, data?: UpdateFleetCommandOutput) => void): void; - public updateFleet( + updateFleet(args: UpdateFleetCommandInput, options?: __HttpHandlerOptions): Promise; + updateFleet(args: UpdateFleetCommandInput, cb: (err: any, data?: UpdateFleetCommandOutput) => void): void; + updateFleet( args: UpdateFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFleetCommandOutput) => void ): void; - public updateFleet( - args: UpdateFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFleetCommandOutput) => void), - cb?: (err: any, data?: UpdateFleetCommandOutput) => void - ): Promise | void { - const command = new UpdateFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a vehicle model (model manifest). If created vehicles are associated with a - * vehicle model, it can't be updated.

+ * @see {@link UpdateModelManifestCommand} */ - public updateModelManifest( + updateModelManifest( args: UpdateModelManifestCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateModelManifest( + updateModelManifest( args: UpdateModelManifestCommandInput, cb: (err: any, data?: UpdateModelManifestCommandOutput) => void ): void; - public updateModelManifest( + updateModelManifest( args: UpdateModelManifestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateModelManifestCommandOutput) => void ): void; - public updateModelManifest( - args: UpdateModelManifestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateModelManifestCommandOutput) => void), - cb?: (err: any, data?: UpdateModelManifestCommandOutput) => void - ): Promise | void { - const command = new UpdateModelManifestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a signal catalog.

+ * @see {@link UpdateSignalCatalogCommand} */ - public updateSignalCatalog( + updateSignalCatalog( args: UpdateSignalCatalogCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSignalCatalog( + updateSignalCatalog( args: UpdateSignalCatalogCommandInput, cb: (err: any, data?: UpdateSignalCatalogCommandOutput) => void ): void; - public updateSignalCatalog( + updateSignalCatalog( args: UpdateSignalCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSignalCatalogCommandOutput) => void ): void; - public updateSignalCatalog( - args: UpdateSignalCatalogCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSignalCatalogCommandOutput) => void), - cb?: (err: any, data?: UpdateSignalCatalogCommandOutput) => void - ): Promise | void { - const command = new UpdateSignalCatalogCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a vehicle.

+ * @see {@link UpdateVehicleCommand} */ - public updateVehicle( - args: UpdateVehicleCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateVehicle( - args: UpdateVehicleCommandInput, - cb: (err: any, data?: UpdateVehicleCommandOutput) => void - ): void; - public updateVehicle( + updateVehicle(args: UpdateVehicleCommandInput, options?: __HttpHandlerOptions): Promise; + updateVehicle(args: UpdateVehicleCommandInput, cb: (err: any, data?: UpdateVehicleCommandOutput) => void): void; + updateVehicle( args: UpdateVehicleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVehicleCommandOutput) => void ): void; - public updateVehicle( - args: UpdateVehicleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVehicleCommandOutput) => void), - cb?: (err: any, data?: UpdateVehicleCommandOutput) => void - ): Promise | void { - const command = new UpdateVehicleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Web Services IoT FleetWise is a fully managed service that you can use to collect, model, and transfer + * vehicle data to the Amazon Web Services cloud at scale. With Amazon Web Services IoT FleetWise, you can standardize all of + * your vehicle data models, independent of the in-vehicle communication architecture, and + * define data collection rules to transfer only high-value data to the cloud. + *

+ *

For more information, see What is Amazon Web Services IoT FleetWise? in the + * Amazon Web Services IoT FleetWise Developer Guide.

+ */ +export class IoTFleetWise extends IoTFleetWiseClient implements IoTFleetWise {} +createAggregatedClient(commands, IoTFleetWise); diff --git a/clients/client-iotsecuretunneling/src/IoTSecureTunneling.ts b/clients/client-iotsecuretunneling/src/IoTSecureTunneling.ts index 36ee58787dd8..99c400705362 100644 --- a/clients/client-iotsecuretunneling/src/IoTSecureTunneling.ts +++ b/clients/client-iotsecuretunneling/src/IoTSecureTunneling.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { CloseTunnelCommand, CloseTunnelCommandInput, CloseTunnelCommandOutput } from "./commands/CloseTunnelCommand"; @@ -25,270 +26,131 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; -import { IoTSecureTunnelingClient } from "./IoTSecureTunnelingClient"; +import { IoTSecureTunnelingClient, IoTSecureTunnelingClientConfig } from "./IoTSecureTunnelingClient"; -/** - * @public - * IoT Secure Tunneling - *

IoT Secure Tunneling creates remote connections to devices deployed in the - * field.

- *

For more information about how IoT Secure Tunneling works, see IoT - * Secure Tunneling.

- */ -export class IoTSecureTunneling extends IoTSecureTunnelingClient { +const commands = { + CloseTunnelCommand, + DescribeTunnelCommand, + ListTagsForResourceCommand, + ListTunnelsCommand, + OpenTunnelCommand, + RotateTunnelAccessTokenCommand, + TagResourceCommand, + UntagResourceCommand, +}; + +export interface IoTSecureTunneling { /** - * @public - *

Closes a tunnel identified by the unique tunnel id. When a CloseTunnel - * request is received, we close the WebSocket connections between the client and proxy - * server so no data can be transmitted.

- *

Requires permission to access the CloseTunnel action.

+ * @see {@link CloseTunnelCommand} */ - public closeTunnel(args: CloseTunnelCommandInput, options?: __HttpHandlerOptions): Promise; - public closeTunnel(args: CloseTunnelCommandInput, cb: (err: any, data?: CloseTunnelCommandOutput) => void): void; - public closeTunnel( + closeTunnel(args: CloseTunnelCommandInput, options?: __HttpHandlerOptions): Promise; + closeTunnel(args: CloseTunnelCommandInput, cb: (err: any, data?: CloseTunnelCommandOutput) => void): void; + closeTunnel( args: CloseTunnelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CloseTunnelCommandOutput) => void ): void; - public closeTunnel( - args: CloseTunnelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CloseTunnelCommandOutput) => void), - cb?: (err: any, data?: CloseTunnelCommandOutput) => void - ): Promise | void { - const command = new CloseTunnelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a tunnel identified by the unique tunnel id.

- *

Requires permission to access the DescribeTunnel action.

+ * @see {@link DescribeTunnelCommand} */ - public describeTunnel( + describeTunnel( args: DescribeTunnelCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTunnel( - args: DescribeTunnelCommandInput, - cb: (err: any, data?: DescribeTunnelCommandOutput) => void - ): void; - public describeTunnel( + describeTunnel(args: DescribeTunnelCommandInput, cb: (err: any, data?: DescribeTunnelCommandOutput) => void): void; + describeTunnel( args: DescribeTunnelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTunnelCommandOutput) => void ): void; - public describeTunnel( - args: DescribeTunnelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTunnelCommandOutput) => void), - cb?: (err: any, data?: DescribeTunnelCommandOutput) => void - ): Promise | void { - const command = new DescribeTunnelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags for the specified resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all tunnels for an Amazon Web Services account. Tunnels are listed by creation time in - * descending order, newer tunnels will be listed before older tunnels.

- *

Requires permission to access the ListTunnels action.

+ * @see {@link ListTunnelsCommand} */ - public listTunnels(args: ListTunnelsCommandInput, options?: __HttpHandlerOptions): Promise; - public listTunnels(args: ListTunnelsCommandInput, cb: (err: any, data?: ListTunnelsCommandOutput) => void): void; - public listTunnels( + listTunnels(args: ListTunnelsCommandInput, options?: __HttpHandlerOptions): Promise; + listTunnels(args: ListTunnelsCommandInput, cb: (err: any, data?: ListTunnelsCommandOutput) => void): void; + listTunnels( args: ListTunnelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTunnelsCommandOutput) => void ): void; - public listTunnels( - args: ListTunnelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTunnelsCommandOutput) => void), - cb?: (err: any, data?: ListTunnelsCommandOutput) => void - ): Promise | void { - const command = new ListTunnelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new tunnel, and returns two client access tokens for clients to use to - * connect to the IoT Secure Tunneling proxy server.

- *

Requires permission to access the OpenTunnel action.

+ * @see {@link OpenTunnelCommand} */ - public openTunnel(args: OpenTunnelCommandInput, options?: __HttpHandlerOptions): Promise; - public openTunnel(args: OpenTunnelCommandInput, cb: (err: any, data?: OpenTunnelCommandOutput) => void): void; - public openTunnel( + openTunnel(args: OpenTunnelCommandInput, options?: __HttpHandlerOptions): Promise; + openTunnel(args: OpenTunnelCommandInput, cb: (err: any, data?: OpenTunnelCommandOutput) => void): void; + openTunnel( args: OpenTunnelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: OpenTunnelCommandOutput) => void ): void; - public openTunnel( - args: OpenTunnelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: OpenTunnelCommandOutput) => void), - cb?: (err: any, data?: OpenTunnelCommandOutput) => void - ): Promise | void { - const command = new OpenTunnelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Revokes the current client access token (CAT) and returns new CAT for clients to - * use when reconnecting to secure tunneling to access the same tunnel.

- *

Requires permission to access the RotateTunnelAccessToken action.

- * - *

Rotating the CAT doesn't extend the tunnel duration. For example, say the tunnel - * duration is 12 hours and the tunnel has already been open for 4 hours. When you - * rotate the access tokens, the new tokens that are generated can only be used for the - * remaining 8 hours.

- *
+ * @see {@link RotateTunnelAccessTokenCommand} */ - public rotateTunnelAccessToken( + rotateTunnelAccessToken( args: RotateTunnelAccessTokenCommandInput, options?: __HttpHandlerOptions ): Promise; - public rotateTunnelAccessToken( + rotateTunnelAccessToken( args: RotateTunnelAccessTokenCommandInput, cb: (err: any, data?: RotateTunnelAccessTokenCommandOutput) => void ): void; - public rotateTunnelAccessToken( + rotateTunnelAccessToken( args: RotateTunnelAccessTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RotateTunnelAccessTokenCommandOutput) => void ): void; - public rotateTunnelAccessToken( - args: RotateTunnelAccessTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RotateTunnelAccessTokenCommandOutput) => void), - cb?: (err: any, data?: RotateTunnelAccessTokenCommandOutput) => void - ): Promise | void { - const command = new RotateTunnelAccessTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A resource tag.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a tag from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * IoT Secure Tunneling + *

IoT Secure Tunneling creates remote connections to devices deployed in the + * field.

+ *

For more information about how IoT Secure Tunneling works, see IoT + * Secure Tunneling.

+ */ +export class IoTSecureTunneling extends IoTSecureTunnelingClient implements IoTSecureTunneling {} +createAggregatedClient(commands, IoTSecureTunneling); diff --git a/clients/client-iotsitewise/src/IoTSiteWise.ts b/clients/client-iotsitewise/src/IoTSiteWise.ts index e71e92764075..6fcb46de676c 100644 --- a/clients/client-iotsitewise/src/IoTSiteWise.ts +++ b/clients/client-iotsitewise/src/IoTSiteWise.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -342,2598 +343,1187 @@ import { UpdateProjectCommandInput, UpdateProjectCommandOutput, } from "./commands/UpdateProjectCommand"; -import { IoTSiteWiseClient } from "./IoTSiteWiseClient"; +import { IoTSiteWiseClient, IoTSiteWiseClientConfig } from "./IoTSiteWiseClient"; -/** - * @public - *

Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects Industrial Internet of Things (IIoT) devices to the power of the Amazon Web Services Cloud. For more information, see the - * IoT SiteWise User Guide. For information about IoT SiteWise quotas, see Quotas in the IoT SiteWise User Guide.

- */ -export class IoTSiteWise extends IoTSiteWiseClient { +const commands = { + AssociateAssetsCommand, + AssociateTimeSeriesToAssetPropertyCommand, + BatchAssociateProjectAssetsCommand, + BatchDisassociateProjectAssetsCommand, + BatchGetAssetPropertyAggregatesCommand, + BatchGetAssetPropertyValueCommand, + BatchGetAssetPropertyValueHistoryCommand, + BatchPutAssetPropertyValueCommand, + CreateAccessPolicyCommand, + CreateAssetCommand, + CreateAssetModelCommand, + CreateBulkImportJobCommand, + CreateDashboardCommand, + CreateGatewayCommand, + CreatePortalCommand, + CreateProjectCommand, + DeleteAccessPolicyCommand, + DeleteAssetCommand, + DeleteAssetModelCommand, + DeleteDashboardCommand, + DeleteGatewayCommand, + DeletePortalCommand, + DeleteProjectCommand, + DeleteTimeSeriesCommand, + DescribeAccessPolicyCommand, + DescribeAssetCommand, + DescribeAssetModelCommand, + DescribeAssetPropertyCommand, + DescribeBulkImportJobCommand, + DescribeDashboardCommand, + DescribeDefaultEncryptionConfigurationCommand, + DescribeGatewayCommand, + DescribeGatewayCapabilityConfigurationCommand, + DescribeLoggingOptionsCommand, + DescribePortalCommand, + DescribeProjectCommand, + DescribeStorageConfigurationCommand, + DescribeTimeSeriesCommand, + DisassociateAssetsCommand, + DisassociateTimeSeriesFromAssetPropertyCommand, + GetAssetPropertyAggregatesCommand, + GetAssetPropertyValueCommand, + GetAssetPropertyValueHistoryCommand, + GetInterpolatedAssetPropertyValuesCommand, + ListAccessPoliciesCommand, + ListAssetModelPropertiesCommand, + ListAssetModelsCommand, + ListAssetPropertiesCommand, + ListAssetRelationshipsCommand, + ListAssetsCommand, + ListAssociatedAssetsCommand, + ListBulkImportJobsCommand, + ListDashboardsCommand, + ListGatewaysCommand, + ListPortalsCommand, + ListProjectAssetsCommand, + ListProjectsCommand, + ListTagsForResourceCommand, + ListTimeSeriesCommand, + PutDefaultEncryptionConfigurationCommand, + PutLoggingOptionsCommand, + PutStorageConfigurationCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAccessPolicyCommand, + UpdateAssetCommand, + UpdateAssetModelCommand, + UpdateAssetPropertyCommand, + UpdateDashboardCommand, + UpdateGatewayCommand, + UpdateGatewayCapabilityConfigurationCommand, + UpdatePortalCommand, + UpdateProjectCommand, +}; + +export interface IoTSiteWise { /** - * @public - *

Associates a child asset with the given parent asset through a hierarchy defined in the - * parent asset's model. For more information, see Associating assets in the - * IoT SiteWise User Guide.

+ * @see {@link AssociateAssetsCommand} */ - public associateAssets( + associateAssets( args: AssociateAssetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateAssets( - args: AssociateAssetsCommandInput, - cb: (err: any, data?: AssociateAssetsCommandOutput) => void - ): void; - public associateAssets( + associateAssets(args: AssociateAssetsCommandInput, cb: (err: any, data?: AssociateAssetsCommandOutput) => void): void; + associateAssets( args: AssociateAssetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateAssetsCommandOutput) => void ): void; - public associateAssets( - args: AssociateAssetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateAssetsCommandOutput) => void), - cb?: (err: any, data?: AssociateAssetsCommandOutput) => void - ): Promise | void { - const command = new AssociateAssetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a time series (data stream) with an asset property.

- */ - public associateTimeSeriesToAssetProperty( + + /** + * @see {@link AssociateTimeSeriesToAssetPropertyCommand} + */ + associateTimeSeriesToAssetProperty( args: AssociateTimeSeriesToAssetPropertyCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateTimeSeriesToAssetProperty( + associateTimeSeriesToAssetProperty( args: AssociateTimeSeriesToAssetPropertyCommandInput, cb: (err: any, data?: AssociateTimeSeriesToAssetPropertyCommandOutput) => void ): void; - public associateTimeSeriesToAssetProperty( + associateTimeSeriesToAssetProperty( args: AssociateTimeSeriesToAssetPropertyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateTimeSeriesToAssetPropertyCommandOutput) => void ): void; - public associateTimeSeriesToAssetProperty( - args: AssociateTimeSeriesToAssetPropertyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateTimeSeriesToAssetPropertyCommandOutput) => void), - cb?: (err: any, data?: AssociateTimeSeriesToAssetPropertyCommandOutput) => void - ): Promise | void { - const command = new AssociateTimeSeriesToAssetPropertyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a group (batch) of assets with an IoT SiteWise Monitor project.

- */ - public batchAssociateProjectAssets( + + /** + * @see {@link BatchAssociateProjectAssetsCommand} + */ + batchAssociateProjectAssets( args: BatchAssociateProjectAssetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchAssociateProjectAssets( + batchAssociateProjectAssets( args: BatchAssociateProjectAssetsCommandInput, cb: (err: any, data?: BatchAssociateProjectAssetsCommandOutput) => void ): void; - public batchAssociateProjectAssets( + batchAssociateProjectAssets( args: BatchAssociateProjectAssetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchAssociateProjectAssetsCommandOutput) => void ): void; - public batchAssociateProjectAssets( - args: BatchAssociateProjectAssetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchAssociateProjectAssetsCommandOutput) => void), - cb?: (err: any, data?: BatchAssociateProjectAssetsCommandOutput) => void - ): Promise | void { - const command = new BatchAssociateProjectAssetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.

- */ - public batchDisassociateProjectAssets( + + /** + * @see {@link BatchDisassociateProjectAssetsCommand} + */ + batchDisassociateProjectAssets( args: BatchDisassociateProjectAssetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDisassociateProjectAssets( + batchDisassociateProjectAssets( args: BatchDisassociateProjectAssetsCommandInput, cb: (err: any, data?: BatchDisassociateProjectAssetsCommandOutput) => void ): void; - public batchDisassociateProjectAssets( + batchDisassociateProjectAssets( args: BatchDisassociateProjectAssetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDisassociateProjectAssetsCommandOutput) => void ): void; - public batchDisassociateProjectAssets( - args: BatchDisassociateProjectAssetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDisassociateProjectAssetsCommandOutput) => void), - cb?: (err: any, data?: BatchDisassociateProjectAssetsCommandOutput) => void - ): Promise | void { - const command = new BatchDisassociateProjectAssetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets aggregated values (for example, average, minimum, and maximum) for one or more asset - * properties. For more information, see Querying aggregates in the - * IoT SiteWise User Guide.

- */ - public batchGetAssetPropertyAggregates( + + /** + * @see {@link BatchGetAssetPropertyAggregatesCommand} + */ + batchGetAssetPropertyAggregates( args: BatchGetAssetPropertyAggregatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetAssetPropertyAggregates( + batchGetAssetPropertyAggregates( args: BatchGetAssetPropertyAggregatesCommandInput, cb: (err: any, data?: BatchGetAssetPropertyAggregatesCommandOutput) => void ): void; - public batchGetAssetPropertyAggregates( + batchGetAssetPropertyAggregates( args: BatchGetAssetPropertyAggregatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetAssetPropertyAggregatesCommandOutput) => void ): void; - public batchGetAssetPropertyAggregates( - args: BatchGetAssetPropertyAggregatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetAssetPropertyAggregatesCommandOutput) => void), - cb?: (err: any, data?: BatchGetAssetPropertyAggregatesCommandOutput) => void - ): Promise | void { - const command = new BatchGetAssetPropertyAggregatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the current value for one or more asset properties. For more information, see Querying - * current values in the IoT SiteWise User Guide.

- */ - public batchGetAssetPropertyValue( + + /** + * @see {@link BatchGetAssetPropertyValueCommand} + */ + batchGetAssetPropertyValue( args: BatchGetAssetPropertyValueCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetAssetPropertyValue( + batchGetAssetPropertyValue( args: BatchGetAssetPropertyValueCommandInput, cb: (err: any, data?: BatchGetAssetPropertyValueCommandOutput) => void ): void; - public batchGetAssetPropertyValue( + batchGetAssetPropertyValue( args: BatchGetAssetPropertyValueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetAssetPropertyValueCommandOutput) => void ): void; - public batchGetAssetPropertyValue( - args: BatchGetAssetPropertyValueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetAssetPropertyValueCommandOutput) => void), - cb?: (err: any, data?: BatchGetAssetPropertyValueCommandOutput) => void - ): Promise | void { - const command = new BatchGetAssetPropertyValueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the historical values for one or more asset properties. For more information, see - * Querying historical values in the IoT SiteWise User Guide.

- */ - public batchGetAssetPropertyValueHistory( + + /** + * @see {@link BatchGetAssetPropertyValueHistoryCommand} + */ + batchGetAssetPropertyValueHistory( args: BatchGetAssetPropertyValueHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetAssetPropertyValueHistory( + batchGetAssetPropertyValueHistory( args: BatchGetAssetPropertyValueHistoryCommandInput, cb: (err: any, data?: BatchGetAssetPropertyValueHistoryCommandOutput) => void ): void; - public batchGetAssetPropertyValueHistory( + batchGetAssetPropertyValueHistory( args: BatchGetAssetPropertyValueHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetAssetPropertyValueHistoryCommandOutput) => void ): void; - public batchGetAssetPropertyValueHistory( - args: BatchGetAssetPropertyValueHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetAssetPropertyValueHistoryCommandOutput) => void), - cb?: (err: any, data?: BatchGetAssetPropertyValueHistoryCommandOutput) => void - ): Promise | void { - const command = new BatchGetAssetPropertyValueHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value - * (TQV) data point. For more information, see Ingesting data using the API in the - * IoT SiteWise User Guide.

- *

To identify an asset property, you must specify one of the following:

- *
    - *
  • - *

    The assetId and propertyId of an asset property.

    - *
  • - *
  • - *

    A propertyAlias, which is a data stream alias (for example, - * /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

    - *
  • - *
- * - *

With respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a timestamp of no more - * than 7 days in the past and no more than 10 minutes in the future. IoT SiteWise rejects timestamps - * outside of the inclusive range of [-7 days, +10 minutes] and returns a - * TimestampOutOfRangeException error.

- *

For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer - * TQV has a different quality. For example, if you store a TQV \{T1, GOOD, V1\}, - * then storing \{T1, GOOD, V2\} replaces the existing TQV.

- *
- *

IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. - * For more information, see BatchPutAssetPropertyValue authorization in the - * IoT SiteWise User Guide.

- */ - public batchPutAssetPropertyValue( + + /** + * @see {@link BatchPutAssetPropertyValueCommand} + */ + batchPutAssetPropertyValue( args: BatchPutAssetPropertyValueCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchPutAssetPropertyValue( + batchPutAssetPropertyValue( args: BatchPutAssetPropertyValueCommandInput, cb: (err: any, data?: BatchPutAssetPropertyValueCommandOutput) => void ): void; - public batchPutAssetPropertyValue( + batchPutAssetPropertyValue( args: BatchPutAssetPropertyValueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchPutAssetPropertyValueCommandOutput) => void ): void; - public batchPutAssetPropertyValue( - args: BatchPutAssetPropertyValueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchPutAssetPropertyValueCommandOutput) => void), - cb?: (err: any, data?: BatchPutAssetPropertyValueCommandOutput) => void - ): Promise | void { - const command = new BatchPutAssetPropertyValueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or - * IAM user) access to the specified IoT SiteWise Monitor portal or project resource.

- */ - public createAccessPolicy( + + /** + * @see {@link CreateAccessPolicyCommand} + */ + createAccessPolicy( args: CreateAccessPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAccessPolicy( + createAccessPolicy( args: CreateAccessPolicyCommandInput, cb: (err: any, data?: CreateAccessPolicyCommandOutput) => void ): void; - public createAccessPolicy( + createAccessPolicy( args: CreateAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessPolicyCommandOutput) => void ): void; - public createAccessPolicy( - args: CreateAccessPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAccessPolicyCommandOutput) => void), - cb?: (err: any, data?: CreateAccessPolicyCommandOutput) => void - ): Promise | void { - const command = new CreateAccessPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an asset from an existing asset model. For more information, see Creating assets in the - * IoT SiteWise User Guide.

- */ - public createAsset(args: CreateAssetCommandInput, options?: __HttpHandlerOptions): Promise; - public createAsset(args: CreateAssetCommandInput, cb: (err: any, data?: CreateAssetCommandOutput) => void): void; - public createAsset( + + /** + * @see {@link CreateAssetCommand} + */ + createAsset(args: CreateAssetCommandInput, options?: __HttpHandlerOptions): Promise; + createAsset(args: CreateAssetCommandInput, cb: (err: any, data?: CreateAssetCommandOutput) => void): void; + createAsset( args: CreateAssetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAssetCommandOutput) => void ): void; - public createAsset( - args: CreateAssetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAssetCommandOutput) => void), - cb?: (err: any, data?: CreateAssetCommandOutput) => void - ): Promise | void { - const command = new CreateAssetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an asset model from specified property and hierarchy definitions. You create - * assets from asset models. With asset models, you can easily create assets of the same type - * that have standardized definitions. Each asset created from a model inherits the asset model's - * property and hierarchy definitions. For more information, see Defining asset models in the - * IoT SiteWise User Guide.

- */ - public createAssetModel( + + /** + * @see {@link CreateAssetModelCommand} + */ + createAssetModel( args: CreateAssetModelCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAssetModel( + createAssetModel( args: CreateAssetModelCommandInput, cb: (err: any, data?: CreateAssetModelCommandOutput) => void ): void; - public createAssetModel( + createAssetModel( args: CreateAssetModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAssetModelCommandOutput) => void ): void; - public createAssetModel( - args: CreateAssetModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAssetModelCommandOutput) => void), - cb?: (err: any, data?: CreateAssetModelCommandOutput) => void - ): Promise | void { - const command = new CreateAssetModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a - * bulk import job (CLI) in the Amazon Simple Storage Service User Guide.

- * - *

You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. For - * more information about how to configure storage settings, see PutStorageConfiguration.

- *
- */ - public createBulkImportJob( + + /** + * @see {@link CreateBulkImportJobCommand} + */ + createBulkImportJob( args: CreateBulkImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBulkImportJob( + createBulkImportJob( args: CreateBulkImportJobCommandInput, cb: (err: any, data?: CreateBulkImportJobCommandOutput) => void ): void; - public createBulkImportJob( + createBulkImportJob( args: CreateBulkImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBulkImportJobCommandOutput) => void ): void; - public createBulkImportJob( - args: CreateBulkImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBulkImportJobCommandOutput) => void), - cb?: (err: any, data?: CreateBulkImportJobCommandOutput) => void - ): Promise | void { - const command = new CreateBulkImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a dashboard in an IoT SiteWise Monitor project.

- */ - public createDashboard( + + /** + * @see {@link CreateDashboardCommand} + */ + createDashboard( args: CreateDashboardCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDashboard( - args: CreateDashboardCommandInput, - cb: (err: any, data?: CreateDashboardCommandOutput) => void - ): void; - public createDashboard( + createDashboard(args: CreateDashboardCommandInput, cb: (err: any, data?: CreateDashboardCommandOutput) => void): void; + createDashboard( args: CreateDashboardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDashboardCommandOutput) => void ): void; - public createDashboard( - args: CreateDashboardCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDashboardCommandOutput) => void), - cb?: (err: any, data?: CreateDashboardCommandOutput) => void - ): Promise | void { - const command = new CreateDashboardCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a gateway, which is a virtual or edge device that delivers industrial data streams - * from local servers to IoT SiteWise. For more information, see Ingesting data using a gateway in the - * IoT SiteWise User Guide.

- */ - public createGateway( - args: CreateGatewayCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createGateway( - args: CreateGatewayCommandInput, - cb: (err: any, data?: CreateGatewayCommandOutput) => void - ): void; - public createGateway( + + /** + * @see {@link CreateGatewayCommand} + */ + createGateway(args: CreateGatewayCommandInput, options?: __HttpHandlerOptions): Promise; + createGateway(args: CreateGatewayCommandInput, cb: (err: any, data?: CreateGatewayCommandOutput) => void): void; + createGateway( args: CreateGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGatewayCommandOutput) => void ): void; - public createGateway( - args: CreateGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGatewayCommandOutput) => void), - cb?: (err: any, data?: CreateGatewayCommandOutput) => void - ): Promise | void { - const command = new CreateGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center or IAM - * to authenticate portal users and manage user permissions.

- * - *

Before you can sign in to a new portal, you must add at least one identity to that - * portal. For more information, see Adding or removing portal - * administrators in the IoT SiteWise User Guide.

- *
- */ - public createPortal( - args: CreatePortalCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createPortal(args: CreatePortalCommandInput, cb: (err: any, data?: CreatePortalCommandOutput) => void): void; - public createPortal( + + /** + * @see {@link CreatePortalCommand} + */ + createPortal(args: CreatePortalCommandInput, options?: __HttpHandlerOptions): Promise; + createPortal(args: CreatePortalCommandInput, cb: (err: any, data?: CreatePortalCommandOutput) => void): void; + createPortal( args: CreatePortalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePortalCommandOutput) => void ): void; - public createPortal( - args: CreatePortalCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePortalCommandOutput) => void), - cb?: (err: any, data?: CreatePortalCommandOutput) => void - ): Promise | void { - const command = new CreatePortalCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a project in the specified portal.

- * - *

Make sure that the project name and description don't contain confidential - * information.

- *
- */ - public createProject( - args: CreateProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createProject( - args: CreateProjectCommandInput, - cb: (err: any, data?: CreateProjectCommandOutput) => void - ): void; - public createProject( + + /** + * @see {@link CreateProjectCommand} + */ + createProject(args: CreateProjectCommandInput, options?: __HttpHandlerOptions): Promise; + createProject(args: CreateProjectCommandInput, cb: (err: any, data?: CreateProjectCommandOutput) => void): void; + createProject( args: CreateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectCommandOutput) => void ): void; - public createProject( - args: CreateProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProjectCommandOutput) => void), - cb?: (err: any, data?: CreateProjectCommandOutput) => void - ): Promise | void { - const command = new CreateProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an access policy that grants the specified identity access to the specified - * IoT SiteWise Monitor resource. You can use this operation to revoke access to an IoT SiteWise Monitor - * resource.

- */ - public deleteAccessPolicy( + + /** + * @see {@link DeleteAccessPolicyCommand} + */ + deleteAccessPolicy( args: DeleteAccessPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAccessPolicy( + deleteAccessPolicy( args: DeleteAccessPolicyCommandInput, cb: (err: any, data?: DeleteAccessPolicyCommandOutput) => void ): void; - public deleteAccessPolicy( + deleteAccessPolicy( args: DeleteAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessPolicyCommandOutput) => void ): void; - public deleteAccessPolicy( - args: DeleteAccessPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAccessPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteAccessPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteAccessPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an asset. This action can't be undone. For more information, see Deleting assets and - * models in the IoT SiteWise User Guide.

- * - *

You can't delete an asset that's associated to another asset. For more information, see - * DisassociateAssets.

- *
- */ - public deleteAsset(args: DeleteAssetCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteAsset(args: DeleteAssetCommandInput, cb: (err: any, data?: DeleteAssetCommandOutput) => void): void; - public deleteAsset( + + /** + * @see {@link DeleteAssetCommand} + */ + deleteAsset(args: DeleteAssetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteAsset(args: DeleteAssetCommandInput, cb: (err: any, data?: DeleteAssetCommandOutput) => void): void; + deleteAsset( args: DeleteAssetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAssetCommandOutput) => void ): void; - public deleteAsset( - args: DeleteAssetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAssetCommandOutput) => void), - cb?: (err: any, data?: DeleteAssetCommandOutput) => void - ): Promise | void { - const command = new DeleteAssetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an asset model. This action can't be undone. You must delete all assets created - * from an asset model before you can delete the model. Also, you can't delete an asset model if - * a parent asset model exists that contains a property formula expression that depends on the - * asset model that you want to delete. For more information, see Deleting assets and models in the - * IoT SiteWise User Guide.

- */ - public deleteAssetModel( + + /** + * @see {@link DeleteAssetModelCommand} + */ + deleteAssetModel( args: DeleteAssetModelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAssetModel( + deleteAssetModel( args: DeleteAssetModelCommandInput, cb: (err: any, data?: DeleteAssetModelCommandOutput) => void ): void; - public deleteAssetModel( + deleteAssetModel( args: DeleteAssetModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAssetModelCommandOutput) => void ): void; - public deleteAssetModel( - args: DeleteAssetModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAssetModelCommandOutput) => void), - cb?: (err: any, data?: DeleteAssetModelCommandOutput) => void - ): Promise | void { - const command = new DeleteAssetModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a dashboard from IoT SiteWise Monitor.

- */ - public deleteDashboard( + + /** + * @see {@link DeleteDashboardCommand} + */ + deleteDashboard( args: DeleteDashboardCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDashboard( - args: DeleteDashboardCommandInput, - cb: (err: any, data?: DeleteDashboardCommandOutput) => void - ): void; - public deleteDashboard( + deleteDashboard(args: DeleteDashboardCommandInput, cb: (err: any, data?: DeleteDashboardCommandOutput) => void): void; + deleteDashboard( args: DeleteDashboardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDashboardCommandOutput) => void ): void; - public deleteDashboard( - args: DeleteDashboardCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDashboardCommandOutput) => void), - cb?: (err: any, data?: DeleteDashboardCommandOutput) => void - ): Promise | void { - const command = new DeleteDashboardCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain - * in your gateway's file system.

- */ - public deleteGateway( - args: DeleteGatewayCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteGateway( - args: DeleteGatewayCommandInput, - cb: (err: any, data?: DeleteGatewayCommandOutput) => void - ): void; - public deleteGateway( + + /** + * @see {@link DeleteGatewayCommand} + */ + deleteGateway(args: DeleteGatewayCommandInput, options?: __HttpHandlerOptions): Promise; + deleteGateway(args: DeleteGatewayCommandInput, cb: (err: any, data?: DeleteGatewayCommandOutput) => void): void; + deleteGateway( args: DeleteGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGatewayCommandOutput) => void ): void; - public deleteGateway( - args: DeleteGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGatewayCommandOutput) => void), - cb?: (err: any, data?: DeleteGatewayCommandOutput) => void - ): Promise | void { - const command = new DeleteGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a portal from IoT SiteWise Monitor.

- */ - public deletePortal( - args: DeletePortalCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deletePortal(args: DeletePortalCommandInput, cb: (err: any, data?: DeletePortalCommandOutput) => void): void; - public deletePortal( + + /** + * @see {@link DeletePortalCommand} + */ + deletePortal(args: DeletePortalCommandInput, options?: __HttpHandlerOptions): Promise; + deletePortal(args: DeletePortalCommandInput, cb: (err: any, data?: DeletePortalCommandOutput) => void): void; + deletePortal( args: DeletePortalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePortalCommandOutput) => void ): void; - public deletePortal( - args: DeletePortalCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePortalCommandOutput) => void), - cb?: (err: any, data?: DeletePortalCommandOutput) => void - ): Promise | void { - const command = new DeletePortalCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a project from IoT SiteWise Monitor.

- */ - public deleteProject( - args: DeleteProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteProject( - args: DeleteProjectCommandInput, - cb: (err: any, data?: DeleteProjectCommandOutput) => void - ): void; - public deleteProject( + + /** + * @see {@link DeleteProjectCommand} + */ + deleteProject(args: DeleteProjectCommandInput, options?: __HttpHandlerOptions): Promise; + deleteProject(args: DeleteProjectCommandInput, cb: (err: any, data?: DeleteProjectCommandOutput) => void): void; + deleteProject( args: DeleteProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProjectCommandOutput) => void ): void; - public deleteProject( - args: DeleteProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProjectCommandOutput) => void), - cb?: (err: any, data?: DeleteProjectCommandOutput) => void - ): Promise | void { - const command = new DeleteProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a time series (data stream). If you delete a time series that's associated with an - * asset property, the asset property still exists, but the time series will no longer be - * associated with this asset property.

- *

To identify a time series, do one of the following:

- *
    - *
  • - *

    If the time series isn't associated with an asset property, - * specify the alias of the time series.

    - *
  • - *
  • - *

    If the time series is associated with an asset property, - * specify one of the following:

    - *
      - *
    • - *

      The alias of the time series.

      - *
    • - *
    • - *

      The assetId and propertyId that identifies the asset property.

      - *
    • - *
    - *
  • - *
- */ - public deleteTimeSeries( + + /** + * @see {@link DeleteTimeSeriesCommand} + */ + deleteTimeSeries( args: DeleteTimeSeriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTimeSeries( + deleteTimeSeries( args: DeleteTimeSeriesCommandInput, cb: (err: any, data?: DeleteTimeSeriesCommandOutput) => void ): void; - public deleteTimeSeries( + deleteTimeSeries( args: DeleteTimeSeriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTimeSeriesCommandOutput) => void ): void; - public deleteTimeSeries( - args: DeleteTimeSeriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTimeSeriesCommandOutput) => void), - cb?: (err: any, data?: DeleteTimeSeriesCommandOutput) => void - ): Promise | void { - const command = new DeleteTimeSeriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or - * project.

- */ - public describeAccessPolicy( + + /** + * @see {@link DescribeAccessPolicyCommand} + */ + describeAccessPolicy( args: DescribeAccessPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccessPolicy( + describeAccessPolicy( args: DescribeAccessPolicyCommandInput, cb: (err: any, data?: DescribeAccessPolicyCommandOutput) => void ): void; - public describeAccessPolicy( + describeAccessPolicy( args: DescribeAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccessPolicyCommandOutput) => void ): void; - public describeAccessPolicy( - args: DescribeAccessPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccessPolicyCommandOutput) => void), - cb?: (err: any, data?: DescribeAccessPolicyCommandOutput) => void - ): Promise | void { - const command = new DescribeAccessPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about an asset.

- */ - public describeAsset( - args: DescribeAssetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeAsset( - args: DescribeAssetCommandInput, - cb: (err: any, data?: DescribeAssetCommandOutput) => void - ): void; - public describeAsset( + + /** + * @see {@link DescribeAssetCommand} + */ + describeAsset(args: DescribeAssetCommandInput, options?: __HttpHandlerOptions): Promise; + describeAsset(args: DescribeAssetCommandInput, cb: (err: any, data?: DescribeAssetCommandOutput) => void): void; + describeAsset( args: DescribeAssetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAssetCommandOutput) => void ): void; - public describeAsset( - args: DescribeAssetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAssetCommandOutput) => void), - cb?: (err: any, data?: DescribeAssetCommandOutput) => void - ): Promise | void { - const command = new DescribeAssetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about an asset model.

- */ - public describeAssetModel( + + /** + * @see {@link DescribeAssetModelCommand} + */ + describeAssetModel( args: DescribeAssetModelCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAssetModel( + describeAssetModel( args: DescribeAssetModelCommandInput, cb: (err: any, data?: DescribeAssetModelCommandOutput) => void ): void; - public describeAssetModel( + describeAssetModel( args: DescribeAssetModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAssetModelCommandOutput) => void ): void; - public describeAssetModel( - args: DescribeAssetModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAssetModelCommandOutput) => void), - cb?: (err: any, data?: DescribeAssetModelCommandOutput) => void - ): Promise | void { - const command = new DescribeAssetModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about an asset property.

- * - *

When you call this operation for an attribute property, this response includes the - * default attribute value that you define in the asset model. If you update the default value - * in the model, this operation's response includes the new default value.

- *
- *

This operation doesn't return the value of the asset property. To get the value of an - * asset property, use GetAssetPropertyValue.

- */ - public describeAssetProperty( + + /** + * @see {@link DescribeAssetPropertyCommand} + */ + describeAssetProperty( args: DescribeAssetPropertyCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAssetProperty( + describeAssetProperty( args: DescribeAssetPropertyCommandInput, cb: (err: any, data?: DescribeAssetPropertyCommandOutput) => void ): void; - public describeAssetProperty( + describeAssetProperty( args: DescribeAssetPropertyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAssetPropertyCommandOutput) => void ): void; - public describeAssetProperty( - args: DescribeAssetPropertyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAssetPropertyCommandOutput) => void), - cb?: (err: any, data?: DescribeAssetPropertyCommandOutput) => void - ): Promise | void { - const command = new DescribeAssetPropertyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about a bulk import job request. For more information, see Describe - * a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.

- */ - public describeBulkImportJob( + + /** + * @see {@link DescribeBulkImportJobCommand} + */ + describeBulkImportJob( args: DescribeBulkImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBulkImportJob( + describeBulkImportJob( args: DescribeBulkImportJobCommandInput, cb: (err: any, data?: DescribeBulkImportJobCommandOutput) => void ): void; - public describeBulkImportJob( + describeBulkImportJob( args: DescribeBulkImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBulkImportJobCommandOutput) => void ): void; - public describeBulkImportJob( - args: DescribeBulkImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBulkImportJobCommandOutput) => void), - cb?: (err: any, data?: DescribeBulkImportJobCommandOutput) => void - ): Promise | void { - const command = new DescribeBulkImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about a dashboard.

- */ - public describeDashboard( + + /** + * @see {@link DescribeDashboardCommand} + */ + describeDashboard( args: DescribeDashboardCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDashboard( + describeDashboard( args: DescribeDashboardCommandInput, cb: (err: any, data?: DescribeDashboardCommandOutput) => void ): void; - public describeDashboard( + describeDashboard( args: DescribeDashboardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDashboardCommandOutput) => void ): void; - public describeDashboard( - args: DescribeDashboardCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDashboardCommandOutput) => void), - cb?: (err: any, data?: DescribeDashboardCommandOutput) => void - ): Promise | void { - const command = new DescribeDashboardCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about the default encryption configuration for the Amazon Web Services account in - * the default or specified Region. For more information, see Key management in the - * IoT SiteWise User Guide.

- */ - public describeDefaultEncryptionConfiguration( + + /** + * @see {@link DescribeDefaultEncryptionConfigurationCommand} + */ + describeDefaultEncryptionConfiguration( args: DescribeDefaultEncryptionConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDefaultEncryptionConfiguration( + describeDefaultEncryptionConfiguration( args: DescribeDefaultEncryptionConfigurationCommandInput, cb: (err: any, data?: DescribeDefaultEncryptionConfigurationCommandOutput) => void ): void; - public describeDefaultEncryptionConfiguration( + describeDefaultEncryptionConfiguration( args: DescribeDefaultEncryptionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDefaultEncryptionConfigurationCommandOutput) => void ): void; - public describeDefaultEncryptionConfiguration( - args: DescribeDefaultEncryptionConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeDefaultEncryptionConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeDefaultEncryptionConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeDefaultEncryptionConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about a gateway.

- */ - public describeGateway( + + /** + * @see {@link DescribeGatewayCommand} + */ + describeGateway( args: DescribeGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGateway( - args: DescribeGatewayCommandInput, - cb: (err: any, data?: DescribeGatewayCommandOutput) => void - ): void; - public describeGateway( + describeGateway(args: DescribeGatewayCommandInput, cb: (err: any, data?: DescribeGatewayCommandOutput) => void): void; + describeGateway( args: DescribeGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGatewayCommandOutput) => void ): void; - public describeGateway( - args: DescribeGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGatewayCommandOutput) => void), - cb?: (err: any, data?: DescribeGatewayCommandOutput) => void - ): Promise | void { - const command = new DescribeGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about a gateway capability configuration. - * Each gateway capability defines data sources for a gateway. A capability configuration - * can contain multiple data source configurations. If you define OPC-UA sources for a gateway in - * the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To - * list all capability configurations for a gateway, use DescribeGateway.

- */ - public describeGatewayCapabilityConfiguration( + + /** + * @see {@link DescribeGatewayCapabilityConfigurationCommand} + */ + describeGatewayCapabilityConfiguration( args: DescribeGatewayCapabilityConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGatewayCapabilityConfiguration( + describeGatewayCapabilityConfiguration( args: DescribeGatewayCapabilityConfigurationCommandInput, cb: (err: any, data?: DescribeGatewayCapabilityConfigurationCommandOutput) => void ): void; - public describeGatewayCapabilityConfiguration( + describeGatewayCapabilityConfiguration( args: DescribeGatewayCapabilityConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGatewayCapabilityConfigurationCommandOutput) => void ): void; - public describeGatewayCapabilityConfiguration( - args: DescribeGatewayCapabilityConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeGatewayCapabilityConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeGatewayCapabilityConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeGatewayCapabilityConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the current IoT SiteWise logging options.

- */ - public describeLoggingOptions( + + /** + * @see {@link DescribeLoggingOptionsCommand} + */ + describeLoggingOptions( args: DescribeLoggingOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLoggingOptions( + describeLoggingOptions( args: DescribeLoggingOptionsCommandInput, cb: (err: any, data?: DescribeLoggingOptionsCommandOutput) => void ): void; - public describeLoggingOptions( + describeLoggingOptions( args: DescribeLoggingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLoggingOptionsCommandOutput) => void ): void; - public describeLoggingOptions( - args: DescribeLoggingOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLoggingOptionsCommandOutput) => void), - cb?: (err: any, data?: DescribeLoggingOptionsCommandOutput) => void - ): Promise | void { - const command = new DescribeLoggingOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about a portal.

- */ - public describePortal( + + /** + * @see {@link DescribePortalCommand} + */ + describePortal( args: DescribePortalCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePortal( - args: DescribePortalCommandInput, - cb: (err: any, data?: DescribePortalCommandOutput) => void - ): void; - public describePortal( + describePortal(args: DescribePortalCommandInput, cb: (err: any, data?: DescribePortalCommandOutput) => void): void; + describePortal( args: DescribePortalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePortalCommandOutput) => void ): void; - public describePortal( - args: DescribePortalCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePortalCommandOutput) => void), - cb?: (err: any, data?: DescribePortalCommandOutput) => void - ): Promise | void { - const command = new DescribePortalCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about a project.

- */ - public describeProject( + + /** + * @see {@link DescribeProjectCommand} + */ + describeProject( args: DescribeProjectCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProject( - args: DescribeProjectCommandInput, - cb: (err: any, data?: DescribeProjectCommandOutput) => void - ): void; - public describeProject( + describeProject(args: DescribeProjectCommandInput, cb: (err: any, data?: DescribeProjectCommandOutput) => void): void; + describeProject( args: DescribeProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProjectCommandOutput) => void ): void; - public describeProject( - args: DescribeProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProjectCommandOutput) => void), - cb?: (err: any, data?: DescribeProjectCommandOutput) => void - ): Promise | void { - const command = new DescribeProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about the storage configuration for IoT SiteWise.

- */ - public describeStorageConfiguration( + + /** + * @see {@link DescribeStorageConfigurationCommand} + */ + describeStorageConfiguration( args: DescribeStorageConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStorageConfiguration( + describeStorageConfiguration( args: DescribeStorageConfigurationCommandInput, cb: (err: any, data?: DescribeStorageConfigurationCommandOutput) => void ): void; - public describeStorageConfiguration( + describeStorageConfiguration( args: DescribeStorageConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStorageConfigurationCommandOutput) => void ): void; - public describeStorageConfiguration( - args: DescribeStorageConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStorageConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeStorageConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeStorageConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about a time series (data stream).

- *

To identify a time series, do one of the following:

- *
    - *
  • - *

    If the time series isn't associated with an asset property, - * specify the alias of the time series.

    - *
  • - *
  • - *

    If the time series is associated with an asset property, - * specify one of the following:

    - *
      - *
    • - *

      The alias of the time series.

      - *
    • - *
    • - *

      The assetId and propertyId that identifies the asset property.

      - *
    • - *
    - *
  • - *
- */ - public describeTimeSeries( + + /** + * @see {@link DescribeTimeSeriesCommand} + */ + describeTimeSeries( args: DescribeTimeSeriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTimeSeries( + describeTimeSeries( args: DescribeTimeSeriesCommandInput, cb: (err: any, data?: DescribeTimeSeriesCommandOutput) => void ): void; - public describeTimeSeries( + describeTimeSeries( args: DescribeTimeSeriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTimeSeriesCommandOutput) => void ): void; - public describeTimeSeries( - args: DescribeTimeSeriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTimeSeriesCommandOutput) => void), - cb?: (err: any, data?: DescribeTimeSeriesCommandOutput) => void - ): Promise | void { - const command = new DescribeTimeSeriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a child asset from the given parent asset through a hierarchy defined in the - * parent asset's model.

- */ - public disassociateAssets( + + /** + * @see {@link DisassociateAssetsCommand} + */ + disassociateAssets( args: DisassociateAssetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateAssets( + disassociateAssets( args: DisassociateAssetsCommandInput, cb: (err: any, data?: DisassociateAssetsCommandOutput) => void ): void; - public disassociateAssets( + disassociateAssets( args: DisassociateAssetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateAssetsCommandOutput) => void ): void; - public disassociateAssets( - args: DisassociateAssetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateAssetsCommandOutput) => void), - cb?: (err: any, data?: DisassociateAssetsCommandOutput) => void - ): Promise | void { - const command = new DisassociateAssetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a time series (data stream) from an asset property.

- */ - public disassociateTimeSeriesFromAssetProperty( + + /** + * @see {@link DisassociateTimeSeriesFromAssetPropertyCommand} + */ + disassociateTimeSeriesFromAssetProperty( args: DisassociateTimeSeriesFromAssetPropertyCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateTimeSeriesFromAssetProperty( + disassociateTimeSeriesFromAssetProperty( args: DisassociateTimeSeriesFromAssetPropertyCommandInput, cb: (err: any, data?: DisassociateTimeSeriesFromAssetPropertyCommandOutput) => void ): void; - public disassociateTimeSeriesFromAssetProperty( + disassociateTimeSeriesFromAssetProperty( args: DisassociateTimeSeriesFromAssetPropertyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateTimeSeriesFromAssetPropertyCommandOutput) => void ): void; - public disassociateTimeSeriesFromAssetProperty( - args: DisassociateTimeSeriesFromAssetPropertyCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociateTimeSeriesFromAssetPropertyCommandOutput) => void), - cb?: (err: any, data?: DisassociateTimeSeriesFromAssetPropertyCommandOutput) => void - ): Promise | void { - const command = new DisassociateTimeSeriesFromAssetPropertyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets aggregated values for an asset property. For more information, see Querying - * aggregates in the IoT SiteWise User Guide.

- *

To identify an asset property, you must specify one of the following:

- *
    - *
  • - *

    The assetId and propertyId of an asset property.

    - *
  • - *
  • - *

    A propertyAlias, which is a data stream alias (for example, - * /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

    - *
  • - *
- */ - public getAssetPropertyAggregates( + + /** + * @see {@link GetAssetPropertyAggregatesCommand} + */ + getAssetPropertyAggregates( args: GetAssetPropertyAggregatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAssetPropertyAggregates( + getAssetPropertyAggregates( args: GetAssetPropertyAggregatesCommandInput, cb: (err: any, data?: GetAssetPropertyAggregatesCommandOutput) => void ): void; - public getAssetPropertyAggregates( + getAssetPropertyAggregates( args: GetAssetPropertyAggregatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAssetPropertyAggregatesCommandOutput) => void ): void; - public getAssetPropertyAggregates( - args: GetAssetPropertyAggregatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAssetPropertyAggregatesCommandOutput) => void), - cb?: (err: any, data?: GetAssetPropertyAggregatesCommandOutput) => void - ): Promise | void { - const command = new GetAssetPropertyAggregatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets an asset property's current value. For more information, see Querying - * current values in the IoT SiteWise User Guide.

- *

To identify an asset property, you must specify one of the following:

- *
    - *
  • - *

    The assetId and propertyId of an asset property.

    - *
  • - *
  • - *

    A propertyAlias, which is a data stream alias (for example, - * /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

    - *
  • - *
- */ - public getAssetPropertyValue( + + /** + * @see {@link GetAssetPropertyValueCommand} + */ + getAssetPropertyValue( args: GetAssetPropertyValueCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAssetPropertyValue( + getAssetPropertyValue( args: GetAssetPropertyValueCommandInput, cb: (err: any, data?: GetAssetPropertyValueCommandOutput) => void ): void; - public getAssetPropertyValue( + getAssetPropertyValue( args: GetAssetPropertyValueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAssetPropertyValueCommandOutput) => void ): void; - public getAssetPropertyValue( - args: GetAssetPropertyValueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAssetPropertyValueCommandOutput) => void), - cb?: (err: any, data?: GetAssetPropertyValueCommandOutput) => void - ): Promise | void { - const command = new GetAssetPropertyValueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the history of an asset property's values. For more information, see Querying - * historical values in the IoT SiteWise User Guide.

- *

To identify an asset property, you must specify one of the following:

- *
    - *
  • - *

    The assetId and propertyId of an asset property.

    - *
  • - *
  • - *

    A propertyAlias, which is a data stream alias (for example, - * /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

    - *
  • - *
- */ - public getAssetPropertyValueHistory( + + /** + * @see {@link GetAssetPropertyValueHistoryCommand} + */ + getAssetPropertyValueHistory( args: GetAssetPropertyValueHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAssetPropertyValueHistory( + getAssetPropertyValueHistory( args: GetAssetPropertyValueHistoryCommandInput, cb: (err: any, data?: GetAssetPropertyValueHistoryCommandOutput) => void ): void; - public getAssetPropertyValueHistory( + getAssetPropertyValueHistory( args: GetAssetPropertyValueHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAssetPropertyValueHistoryCommandOutput) => void ): void; - public getAssetPropertyValueHistory( - args: GetAssetPropertyValueHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAssetPropertyValueHistoryCommandOutput) => void), - cb?: (err: any, data?: GetAssetPropertyValueHistoryCommandOutput) => void - ): Promise | void { - const command = new GetAssetPropertyValueHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get interpolated values for an asset property for a specified time interval, during a - * period of time. If your time series is missing data points during the specified time interval, - * you can use interpolation to estimate the missing data.

- *

For example, you can use this operation to return the interpolated temperature values for - * a wind turbine every 24 hours over a duration of 7 days.

- *

To identify an asset property, you must specify one of the following:

- *
    - *
  • - *

    The assetId and propertyId of an asset property.

    - *
  • - *
  • - *

    A propertyAlias, which is a data stream alias (for example, - * /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

    - *
  • - *
- */ - public getInterpolatedAssetPropertyValues( + + /** + * @see {@link GetInterpolatedAssetPropertyValuesCommand} + */ + getInterpolatedAssetPropertyValues( args: GetInterpolatedAssetPropertyValuesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInterpolatedAssetPropertyValues( + getInterpolatedAssetPropertyValues( args: GetInterpolatedAssetPropertyValuesCommandInput, cb: (err: any, data?: GetInterpolatedAssetPropertyValuesCommandOutput) => void ): void; - public getInterpolatedAssetPropertyValues( + getInterpolatedAssetPropertyValues( args: GetInterpolatedAssetPropertyValuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInterpolatedAssetPropertyValuesCommandOutput) => void ): void; - public getInterpolatedAssetPropertyValues( - args: GetInterpolatedAssetPropertyValuesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInterpolatedAssetPropertyValuesCommandOutput) => void), - cb?: (err: any, data?: GetInterpolatedAssetPropertyValuesCommandOutput) => void - ): Promise | void { - const command = new GetInterpolatedAssetPropertyValuesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity Center - * group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).

- */ - public listAccessPolicies( + + /** + * @see {@link ListAccessPoliciesCommand} + */ + listAccessPolicies( args: ListAccessPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAccessPolicies( + listAccessPolicies( args: ListAccessPoliciesCommandInput, cb: (err: any, data?: ListAccessPoliciesCommandOutput) => void ): void; - public listAccessPolicies( + listAccessPolicies( args: ListAccessPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessPoliciesCommandOutput) => void ): void; - public listAccessPolicies( - args: ListAccessPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccessPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListAccessPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListAccessPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a paginated list of properties associated with an asset model. - * If you update properties associated with the model before you finish listing all the properties, - * you need to start all over again.

- */ - public listAssetModelProperties( + + /** + * @see {@link ListAssetModelPropertiesCommand} + */ + listAssetModelProperties( args: ListAssetModelPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssetModelProperties( + listAssetModelProperties( args: ListAssetModelPropertiesCommandInput, cb: (err: any, data?: ListAssetModelPropertiesCommandOutput) => void ): void; - public listAssetModelProperties( + listAssetModelProperties( args: ListAssetModelPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssetModelPropertiesCommandOutput) => void ): void; - public listAssetModelProperties( - args: ListAssetModelPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssetModelPropertiesCommandOutput) => void), - cb?: (err: any, data?: ListAssetModelPropertiesCommandOutput) => void - ): Promise | void { - const command = new ListAssetModelPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a paginated list of summaries of all asset models.

- */ - public listAssetModels( + + /** + * @see {@link ListAssetModelsCommand} + */ + listAssetModels( args: ListAssetModelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssetModels( - args: ListAssetModelsCommandInput, - cb: (err: any, data?: ListAssetModelsCommandOutput) => void - ): void; - public listAssetModels( + listAssetModels(args: ListAssetModelsCommandInput, cb: (err: any, data?: ListAssetModelsCommandOutput) => void): void; + listAssetModels( args: ListAssetModelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssetModelsCommandOutput) => void ): void; - public listAssetModels( - args: ListAssetModelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssetModelsCommandOutput) => void), - cb?: (err: any, data?: ListAssetModelsCommandOutput) => void - ): Promise | void { - const command = new ListAssetModelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a paginated list of properties associated with an asset. - * If you update properties associated with the model before you finish listing all the properties, - * you need to start all over again.

- */ - public listAssetProperties( + + /** + * @see {@link ListAssetPropertiesCommand} + */ + listAssetProperties( args: ListAssetPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssetProperties( + listAssetProperties( args: ListAssetPropertiesCommandInput, cb: (err: any, data?: ListAssetPropertiesCommandOutput) => void ): void; - public listAssetProperties( + listAssetProperties( args: ListAssetPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssetPropertiesCommandOutput) => void ): void; - public listAssetProperties( - args: ListAssetPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssetPropertiesCommandOutput) => void), - cb?: (err: any, data?: ListAssetPropertiesCommandOutput) => void - ): Promise | void { - const command = new ListAssetPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a paginated list of asset relationships for an asset. You can use this operation - * to identify an asset's root asset and all associated assets between that asset and its - * root.

- */ - public listAssetRelationships( + + /** + * @see {@link ListAssetRelationshipsCommand} + */ + listAssetRelationships( args: ListAssetRelationshipsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssetRelationships( + listAssetRelationships( args: ListAssetRelationshipsCommandInput, cb: (err: any, data?: ListAssetRelationshipsCommandOutput) => void ): void; - public listAssetRelationships( + listAssetRelationships( args: ListAssetRelationshipsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssetRelationshipsCommandOutput) => void ): void; - public listAssetRelationships( - args: ListAssetRelationshipsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssetRelationshipsCommandOutput) => void), - cb?: (err: any, data?: ListAssetRelationshipsCommandOutput) => void - ): Promise | void { - const command = new ListAssetRelationshipsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a paginated list of asset summaries.

- *

You can use this operation to do the following:

- *
    - *
  • - *

    List assets based on a specific asset model.

    - *
  • - *
  • - *

    List top-level assets.

    - *
  • - *
- *

You can't use this operation to list all assets. To retrieve summaries for all of your - * assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all - * assets for each asset model.

- */ - public listAssets(args: ListAssetsCommandInput, options?: __HttpHandlerOptions): Promise; - public listAssets(args: ListAssetsCommandInput, cb: (err: any, data?: ListAssetsCommandOutput) => void): void; - public listAssets( + + /** + * @see {@link ListAssetsCommand} + */ + listAssets(args: ListAssetsCommandInput, options?: __HttpHandlerOptions): Promise; + listAssets(args: ListAssetsCommandInput, cb: (err: any, data?: ListAssetsCommandOutput) => void): void; + listAssets( args: ListAssetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssetsCommandOutput) => void ): void; - public listAssets( - args: ListAssetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssetsCommandOutput) => void), - cb?: (err: any, data?: ListAssetsCommandOutput) => void - ): Promise | void { - const command = new ListAssetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a paginated list of associated assets.

- *

You can use this operation to do the following:

- *
    - *
  • - *

    List child assets associated to a parent asset by a hierarchy that you specify.

    - *
  • - *
  • - *

    List an asset's parent asset.

    - *
  • - *
- */ - public listAssociatedAssets( + + /** + * @see {@link ListAssociatedAssetsCommand} + */ + listAssociatedAssets( args: ListAssociatedAssetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssociatedAssets( + listAssociatedAssets( args: ListAssociatedAssetsCommandInput, cb: (err: any, data?: ListAssociatedAssetsCommandOutput) => void ): void; - public listAssociatedAssets( + listAssociatedAssets( args: ListAssociatedAssetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssociatedAssetsCommandOutput) => void ): void; - public listAssociatedAssets( - args: ListAssociatedAssetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssociatedAssetsCommandOutput) => void), - cb?: (err: any, data?: ListAssociatedAssetsCommandOutput) => void - ): Promise | void { - const command = new ListAssociatedAssetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a paginated list of bulk import job requests. For more information, see List bulk - * import jobs (CLI) in the IoT SiteWise User Guide.

- */ - public listBulkImportJobs( + + /** + * @see {@link ListBulkImportJobsCommand} + */ + listBulkImportJobs( args: ListBulkImportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBulkImportJobs( + listBulkImportJobs( args: ListBulkImportJobsCommandInput, cb: (err: any, data?: ListBulkImportJobsCommandOutput) => void ): void; - public listBulkImportJobs( + listBulkImportJobs( args: ListBulkImportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBulkImportJobsCommandOutput) => void ): void; - public listBulkImportJobs( - args: ListBulkImportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBulkImportJobsCommandOutput) => void), - cb?: (err: any, data?: ListBulkImportJobsCommandOutput) => void - ): Promise | void { - const command = new ListBulkImportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.

- */ - public listDashboards( + + /** + * @see {@link ListDashboardsCommand} + */ + listDashboards( args: ListDashboardsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDashboards( - args: ListDashboardsCommandInput, - cb: (err: any, data?: ListDashboardsCommandOutput) => void - ): void; - public listDashboards( + listDashboards(args: ListDashboardsCommandInput, cb: (err: any, data?: ListDashboardsCommandOutput) => void): void; + listDashboards( args: ListDashboardsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDashboardsCommandOutput) => void ): void; - public listDashboards( - args: ListDashboardsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDashboardsCommandOutput) => void), - cb?: (err: any, data?: ListDashboardsCommandOutput) => void - ): Promise | void { - const command = new ListDashboardsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a paginated list of gateways.

- */ - public listGateways( - args: ListGatewaysCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listGateways(args: ListGatewaysCommandInput, cb: (err: any, data?: ListGatewaysCommandOutput) => void): void; - public listGateways( + + /** + * @see {@link ListGatewaysCommand} + */ + listGateways(args: ListGatewaysCommandInput, options?: __HttpHandlerOptions): Promise; + listGateways(args: ListGatewaysCommandInput, cb: (err: any, data?: ListGatewaysCommandOutput) => void): void; + listGateways( args: ListGatewaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGatewaysCommandOutput) => void ): void; - public listGateways( - args: ListGatewaysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGatewaysCommandOutput) => void), - cb?: (err: any, data?: ListGatewaysCommandOutput) => void - ): Promise | void { - const command = new ListGatewaysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a paginated list of IoT SiteWise Monitor portals.

- */ - public listPortals(args: ListPortalsCommandInput, options?: __HttpHandlerOptions): Promise; - public listPortals(args: ListPortalsCommandInput, cb: (err: any, data?: ListPortalsCommandOutput) => void): void; - public listPortals( + + /** + * @see {@link ListPortalsCommand} + */ + listPortals(args: ListPortalsCommandInput, options?: __HttpHandlerOptions): Promise; + listPortals(args: ListPortalsCommandInput, cb: (err: any, data?: ListPortalsCommandOutput) => void): void; + listPortals( args: ListPortalsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPortalsCommandOutput) => void ): void; - public listPortals( - args: ListPortalsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPortalsCommandOutput) => void), - cb?: (err: any, data?: ListPortalsCommandOutput) => void - ): Promise | void { - const command = new ListPortalsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.

- */ - public listProjectAssets( + + /** + * @see {@link ListProjectAssetsCommand} + */ + listProjectAssets( args: ListProjectAssetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProjectAssets( + listProjectAssets( args: ListProjectAssetsCommandInput, cb: (err: any, data?: ListProjectAssetsCommandOutput) => void ): void; - public listProjectAssets( + listProjectAssets( args: ListProjectAssetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProjectAssetsCommandOutput) => void ): void; - public listProjectAssets( - args: ListProjectAssetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProjectAssetsCommandOutput) => void), - cb?: (err: any, data?: ListProjectAssetsCommandOutput) => void - ): Promise | void { - const command = new ListProjectAssetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.

- */ - public listProjects( - args: ListProjectsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void; - public listProjects( + + /** + * @see {@link ListProjectsCommand} + */ + listProjects(args: ListProjectsCommandInput, options?: __HttpHandlerOptions): Promise; + listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void; + listProjects( args: ListProjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProjectsCommandOutput) => void ): void; - public listProjects( - args: ListProjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProjectsCommandOutput) => void), - cb?: (err: any, data?: ListProjectsCommandOutput) => void - ): Promise | void { - const command = new ListProjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the list of tags for an IoT SiteWise resource.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a paginated list of time series (data streams).

- */ - public listTimeSeries( + + /** + * @see {@link ListTimeSeriesCommand} + */ + listTimeSeries( args: ListTimeSeriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTimeSeries( - args: ListTimeSeriesCommandInput, - cb: (err: any, data?: ListTimeSeriesCommandOutput) => void - ): void; - public listTimeSeries( + listTimeSeries(args: ListTimeSeriesCommandInput, cb: (err: any, data?: ListTimeSeriesCommandOutput) => void): void; + listTimeSeries( args: ListTimeSeriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTimeSeriesCommandOutput) => void ): void; - public listTimeSeries( - args: ListTimeSeriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTimeSeriesCommandOutput) => void), - cb?: (err: any, data?: ListTimeSeriesCommandOutput) => void - ): Promise | void { - const command = new ListTimeSeriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the default encryption configuration for the Amazon Web Services account. For more information, see - * Key management in - * the IoT SiteWise User Guide.

- */ - public putDefaultEncryptionConfiguration( + + /** + * @see {@link PutDefaultEncryptionConfigurationCommand} + */ + putDefaultEncryptionConfiguration( args: PutDefaultEncryptionConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putDefaultEncryptionConfiguration( + putDefaultEncryptionConfiguration( args: PutDefaultEncryptionConfigurationCommandInput, cb: (err: any, data?: PutDefaultEncryptionConfigurationCommandOutput) => void ): void; - public putDefaultEncryptionConfiguration( + putDefaultEncryptionConfiguration( args: PutDefaultEncryptionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDefaultEncryptionConfigurationCommandOutput) => void ): void; - public putDefaultEncryptionConfiguration( - args: PutDefaultEncryptionConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutDefaultEncryptionConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutDefaultEncryptionConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutDefaultEncryptionConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets logging options for IoT SiteWise.

- */ - public putLoggingOptions( + + /** + * @see {@link PutLoggingOptionsCommand} + */ + putLoggingOptions( args: PutLoggingOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putLoggingOptions( + putLoggingOptions( args: PutLoggingOptionsCommandInput, cb: (err: any, data?: PutLoggingOptionsCommandOutput) => void ): void; - public putLoggingOptions( + putLoggingOptions( args: PutLoggingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLoggingOptionsCommandOutput) => void ): void; - public putLoggingOptions( - args: PutLoggingOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutLoggingOptionsCommandOutput) => void), - cb?: (err: any, data?: PutLoggingOptionsCommandOutput) => void - ): Promise | void { - const command = new PutLoggingOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Configures storage settings for IoT SiteWise.

- */ - public putStorageConfiguration( + + /** + * @see {@link PutStorageConfigurationCommand} + */ + putStorageConfiguration( args: PutStorageConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putStorageConfiguration( + putStorageConfiguration( args: PutStorageConfigurationCommandInput, cb: (err: any, data?: PutStorageConfigurationCommandOutput) => void ): void; - public putStorageConfiguration( + putStorageConfiguration( args: PutStorageConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutStorageConfigurationCommandOutput) => void ): void; - public putStorageConfiguration( - args: PutStorageConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutStorageConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutStorageConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutStorageConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation - * updates the tag's value.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a tag from an IoT SiteWise resource.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor - * portal or project resource.

- */ - public updateAccessPolicy( + + /** + * @see {@link UpdateAccessPolicyCommand} + */ + updateAccessPolicy( args: UpdateAccessPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAccessPolicy( + updateAccessPolicy( args: UpdateAccessPolicyCommandInput, cb: (err: any, data?: UpdateAccessPolicyCommandOutput) => void ): void; - public updateAccessPolicy( + updateAccessPolicy( args: UpdateAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccessPolicyCommandOutput) => void ): void; - public updateAccessPolicy( - args: UpdateAccessPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAccessPolicyCommandOutput) => void), - cb?: (err: any, data?: UpdateAccessPolicyCommandOutput) => void - ): Promise | void { - const command = new UpdateAccessPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an asset's name. For more information, see Updating assets and models in the - * IoT SiteWise User Guide.

- */ - public updateAsset(args: UpdateAssetCommandInput, options?: __HttpHandlerOptions): Promise; - public updateAsset(args: UpdateAssetCommandInput, cb: (err: any, data?: UpdateAssetCommandOutput) => void): void; - public updateAsset( + + /** + * @see {@link UpdateAssetCommand} + */ + updateAsset(args: UpdateAssetCommandInput, options?: __HttpHandlerOptions): Promise; + updateAsset(args: UpdateAssetCommandInput, cb: (err: any, data?: UpdateAssetCommandOutput) => void): void; + updateAsset( args: UpdateAssetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAssetCommandOutput) => void ): void; - public updateAsset( - args: UpdateAssetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAssetCommandOutput) => void), - cb?: (err: any, data?: UpdateAssetCommandOutput) => void - ): Promise | void { - const command = new UpdateAssetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an asset model and all of the assets that were created from the model. Each asset - * created from the model inherits the updated asset model's property and hierarchy definitions. - * For more information, see Updating assets and models in the - * IoT SiteWise User Guide.

- * - *

This operation overwrites the existing model with the provided model. To avoid deleting - * your asset model's properties or hierarchies, you must include their IDs and definitions in - * the updated asset model payload. For more information, see DescribeAssetModel.

- *

If you remove a property from an asset model, IoT SiteWise deletes all previous data for that - * property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every - * asset associated with that hierarchy. You can't change the type or data type of an existing - * property.

- *
- */ - public updateAssetModel( + + /** + * @see {@link UpdateAssetModelCommand} + */ + updateAssetModel( args: UpdateAssetModelCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAssetModel( + updateAssetModel( args: UpdateAssetModelCommandInput, cb: (err: any, data?: UpdateAssetModelCommandOutput) => void ): void; - public updateAssetModel( + updateAssetModel( args: UpdateAssetModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAssetModelCommandOutput) => void ): void; - public updateAssetModel( - args: UpdateAssetModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAssetModelCommandOutput) => void), - cb?: (err: any, data?: UpdateAssetModelCommandOutput) => void - ): Promise | void { - const command = new UpdateAssetModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an asset property's alias and notification state.

- * - *

This operation overwrites the property's existing alias and notification state. To keep - * your existing property's alias or notification state, you must include the existing values - * in the UpdateAssetProperty request. For more information, see DescribeAssetProperty.

- *
- */ - public updateAssetProperty( + + /** + * @see {@link UpdateAssetPropertyCommand} + */ + updateAssetProperty( args: UpdateAssetPropertyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAssetProperty( + updateAssetProperty( args: UpdateAssetPropertyCommandInput, cb: (err: any, data?: UpdateAssetPropertyCommandOutput) => void ): void; - public updateAssetProperty( + updateAssetProperty( args: UpdateAssetPropertyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAssetPropertyCommandOutput) => void ): void; - public updateAssetProperty( - args: UpdateAssetPropertyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAssetPropertyCommandOutput) => void), - cb?: (err: any, data?: UpdateAssetPropertyCommandOutput) => void - ): Promise | void { - const command = new UpdateAssetPropertyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an IoT SiteWise Monitor dashboard.

- */ - public updateDashboard( + + /** + * @see {@link UpdateDashboardCommand} + */ + updateDashboard( args: UpdateDashboardCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDashboard( - args: UpdateDashboardCommandInput, - cb: (err: any, data?: UpdateDashboardCommandOutput) => void - ): void; - public updateDashboard( + updateDashboard(args: UpdateDashboardCommandInput, cb: (err: any, data?: UpdateDashboardCommandOutput) => void): void; + updateDashboard( args: UpdateDashboardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDashboardCommandOutput) => void ): void; - public updateDashboard( - args: UpdateDashboardCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDashboardCommandOutput) => void), - cb?: (err: any, data?: UpdateDashboardCommandOutput) => void - ): Promise | void { - const command = new UpdateDashboardCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a gateway's name.

- */ - public updateGateway( - args: UpdateGatewayCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateGateway( - args: UpdateGatewayCommandInput, - cb: (err: any, data?: UpdateGatewayCommandOutput) => void - ): void; - public updateGateway( + + /** + * @see {@link UpdateGatewayCommand} + */ + updateGateway(args: UpdateGatewayCommandInput, options?: __HttpHandlerOptions): Promise; + updateGateway(args: UpdateGatewayCommandInput, cb: (err: any, data?: UpdateGatewayCommandOutput) => void): void; + updateGateway( args: UpdateGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGatewayCommandOutput) => void ): void; - public updateGateway( - args: UpdateGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGatewayCommandOutput) => void), - cb?: (err: any, data?: UpdateGatewayCommandOutput) => void - ): Promise | void { - const command = new UpdateGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a gateway capability configuration or defines a new capability configuration. - * Each gateway capability defines data sources for a gateway. A capability configuration - * can contain multiple data source configurations. If you define OPC-UA sources for a gateway in - * the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To - * list all capability configurations for a gateway, use DescribeGateway.

- */ - public updateGatewayCapabilityConfiguration( + + /** + * @see {@link UpdateGatewayCapabilityConfigurationCommand} + */ + updateGatewayCapabilityConfiguration( args: UpdateGatewayCapabilityConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGatewayCapabilityConfiguration( + updateGatewayCapabilityConfiguration( args: UpdateGatewayCapabilityConfigurationCommandInput, cb: (err: any, data?: UpdateGatewayCapabilityConfigurationCommandOutput) => void ): void; - public updateGatewayCapabilityConfiguration( + updateGatewayCapabilityConfiguration( args: UpdateGatewayCapabilityConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGatewayCapabilityConfigurationCommandOutput) => void ): void; - public updateGatewayCapabilityConfiguration( - args: UpdateGatewayCapabilityConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGatewayCapabilityConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateGatewayCapabilityConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateGatewayCapabilityConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an IoT SiteWise Monitor portal.

- */ - public updatePortal( - args: UpdatePortalCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updatePortal(args: UpdatePortalCommandInput, cb: (err: any, data?: UpdatePortalCommandOutput) => void): void; - public updatePortal( + + /** + * @see {@link UpdatePortalCommand} + */ + updatePortal(args: UpdatePortalCommandInput, options?: __HttpHandlerOptions): Promise; + updatePortal(args: UpdatePortalCommandInput, cb: (err: any, data?: UpdatePortalCommandOutput) => void): void; + updatePortal( args: UpdatePortalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePortalCommandOutput) => void ): void; - public updatePortal( - args: UpdatePortalCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePortalCommandOutput) => void), - cb?: (err: any, data?: UpdatePortalCommandOutput) => void - ): Promise | void { - const command = new UpdatePortalCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an IoT SiteWise Monitor project.

- */ - public updateProject( - args: UpdateProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateProject( - args: UpdateProjectCommandInput, - cb: (err: any, data?: UpdateProjectCommandOutput) => void - ): void; - public updateProject( + + /** + * @see {@link UpdateProjectCommand} + */ + updateProject(args: UpdateProjectCommandInput, options?: __HttpHandlerOptions): Promise; + updateProject(args: UpdateProjectCommandInput, cb: (err: any, data?: UpdateProjectCommandOutput) => void): void; + updateProject( args: UpdateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProjectCommandOutput) => void ): void; - public updateProject( - args: UpdateProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProjectCommandOutput) => void), - cb?: (err: any, data?: UpdateProjectCommandOutput) => void - ): Promise | void { - const command = new UpdateProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects Industrial Internet of Things (IIoT) devices to the power of the Amazon Web Services Cloud. For more information, see the + * IoT SiteWise User Guide. For information about IoT SiteWise quotas, see Quotas in the IoT SiteWise User Guide.

+ */ +export class IoTSiteWise extends IoTSiteWiseClient implements IoTSiteWise {} +createAggregatedClient(commands, IoTSiteWise); diff --git a/clients/client-iotthingsgraph/src/IoTThingsGraph.ts b/clients/client-iotthingsgraph/src/IoTThingsGraph.ts index 4e9f90237c50..07c6930b5271 100644 --- a/clients/client-iotthingsgraph/src/IoTThingsGraph.ts +++ b/clients/client-iotthingsgraph/src/IoTThingsGraph.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -168,1302 +169,616 @@ import { UploadEntityDefinitionsCommandInput, UploadEntityDefinitionsCommandOutput, } from "./commands/UploadEntityDefinitionsCommand"; -import { IoTThingsGraphClient } from "./IoTThingsGraphClient"; +import { IoTThingsGraphClient, IoTThingsGraphClientConfig } from "./IoTThingsGraphClient"; -/** - * @public - * AWS IoT Things Graph - *

AWS IoT Things Graph provides an integrated set of tools that enable developers to connect devices and services that use different standards, - * such as units of measure and communication protocols. AWS IoT Things Graph makes it possible to build IoT applications with little to no code by connecting devices and services - * and defining how they interact at an abstract level.

- *

For more information about how AWS IoT Things Graph works, see the User Guide.

- * - *

The AWS IoT Things Graph service is discontinued.

- */ -export class IoTThingsGraph extends IoTThingsGraphClient { +const commands = { + AssociateEntityToThingCommand, + CreateFlowTemplateCommand, + CreateSystemInstanceCommand, + CreateSystemTemplateCommand, + DeleteFlowTemplateCommand, + DeleteNamespaceCommand, + DeleteSystemInstanceCommand, + DeleteSystemTemplateCommand, + DeploySystemInstanceCommand, + DeprecateFlowTemplateCommand, + DeprecateSystemTemplateCommand, + DescribeNamespaceCommand, + DissociateEntityFromThingCommand, + GetEntitiesCommand, + GetFlowTemplateCommand, + GetFlowTemplateRevisionsCommand, + GetNamespaceDeletionStatusCommand, + GetSystemInstanceCommand, + GetSystemTemplateCommand, + GetSystemTemplateRevisionsCommand, + GetUploadStatusCommand, + ListFlowExecutionMessagesCommand, + ListTagsForResourceCommand, + SearchEntitiesCommand, + SearchFlowExecutionsCommand, + SearchFlowTemplatesCommand, + SearchSystemInstancesCommand, + SearchSystemTemplatesCommand, + SearchThingsCommand, + TagResourceCommand, + UndeploySystemInstanceCommand, + UntagResourceCommand, + UpdateFlowTemplateCommand, + UpdateSystemTemplateCommand, + UploadEntityDefinitionsCommand, +}; + +export interface IoTThingsGraph { /** - * @public - * @deprecated - * - *

Associates a device with a concrete thing that is in the user's registry.

- *

A thing can be associated with only one device at a time. If you associate a thing with a new device id, its previous association will be removed.

+ * @see {@link AssociateEntityToThingCommand} */ - public associateEntityToThing( + associateEntityToThing( args: AssociateEntityToThingCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateEntityToThing( + associateEntityToThing( args: AssociateEntityToThingCommandInput, cb: (err: any, data?: AssociateEntityToThingCommandOutput) => void ): void; - public associateEntityToThing( + associateEntityToThing( args: AssociateEntityToThingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateEntityToThingCommandOutput) => void ): void; - public associateEntityToThing( - args: AssociateEntityToThingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateEntityToThingCommandOutput) => void), - cb?: (err: any, data?: AssociateEntityToThingCommandOutput) => void - ): Promise | void { - const command = new AssociateEntityToThingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Creates a workflow template. Workflows can be created only in the user's namespace. (The public namespace contains only - * entities.) The workflow can contain only entities in the specified namespace. The workflow is validated against the entities in the - * latest version of the user's namespace unless another namespace version is specified in the request.

+ * @see {@link CreateFlowTemplateCommand} */ - public createFlowTemplate( + createFlowTemplate( args: CreateFlowTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFlowTemplate( + createFlowTemplate( args: CreateFlowTemplateCommandInput, cb: (err: any, data?: CreateFlowTemplateCommandOutput) => void ): void; - public createFlowTemplate( + createFlowTemplate( args: CreateFlowTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFlowTemplateCommandOutput) => void ): void; - public createFlowTemplate( - args: CreateFlowTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFlowTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateFlowTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateFlowTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Creates a system instance.

- *

This action validates the system instance, prepares the deployment-related resources. For Greengrass deployments, it updates the Greengrass group that is - * specified by the greengrassGroupName parameter. It also adds a file to the S3 bucket specified by the s3BucketName parameter. You need to - * call DeploySystemInstance after running this action.

- *

For Greengrass deployments, since this action modifies and adds resources to a Greengrass group and an S3 bucket on the caller's behalf, the calling identity must have write permissions - * to both the specified Greengrass group and S3 bucket. Otherwise, the call will fail with an authorization error.

- *

For cloud deployments, this action requires a flowActionsRoleArn value. This is an IAM role - * that has permissions to access AWS services, such as AWS Lambda and AWS IoT, that the flow uses when it executes.

- *

If the definition document doesn't specify a version of the user's namespace, the latest version will be used by default.

+ * @see {@link CreateSystemInstanceCommand} */ - public createSystemInstance( + createSystemInstance( args: CreateSystemInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSystemInstance( + createSystemInstance( args: CreateSystemInstanceCommandInput, cb: (err: any, data?: CreateSystemInstanceCommandOutput) => void ): void; - public createSystemInstance( + createSystemInstance( args: CreateSystemInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSystemInstanceCommandOutput) => void ): void; - public createSystemInstance( - args: CreateSystemInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSystemInstanceCommandOutput) => void), - cb?: (err: any, data?: CreateSystemInstanceCommandOutput) => void - ): Promise | void { - const command = new CreateSystemInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Creates a system. The system is validated against the entities in the - * latest version of the user's namespace unless another namespace version is specified in the request.

+ * @see {@link CreateSystemTemplateCommand} */ - public createSystemTemplate( + createSystemTemplate( args: CreateSystemTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSystemTemplate( + createSystemTemplate( args: CreateSystemTemplateCommandInput, cb: (err: any, data?: CreateSystemTemplateCommandOutput) => void ): void; - public createSystemTemplate( + createSystemTemplate( args: CreateSystemTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSystemTemplateCommandOutput) => void ): void; - public createSystemTemplate( - args: CreateSystemTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSystemTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateSystemTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateSystemTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Deletes a workflow. Any new system or deployment that contains this workflow will fail to update or deploy. - * Existing deployments that contain the workflow will continue to run (since they use a snapshot of the workflow taken at the time of deployment).

+ * @see {@link DeleteFlowTemplateCommand} */ - public deleteFlowTemplate( + deleteFlowTemplate( args: DeleteFlowTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFlowTemplate( + deleteFlowTemplate( args: DeleteFlowTemplateCommandInput, cb: (err: any, data?: DeleteFlowTemplateCommandOutput) => void ): void; - public deleteFlowTemplate( + deleteFlowTemplate( args: DeleteFlowTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFlowTemplateCommandOutput) => void ): void; - public deleteFlowTemplate( - args: DeleteFlowTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFlowTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteFlowTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteFlowTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Deletes the specified namespace. This action deletes all of the entities in the namespace. Delete the systems and flows that use entities in the namespace before performing this action. This action takes no - * request parameters.

+ * @see {@link DeleteNamespaceCommand} */ - public deleteNamespace( + deleteNamespace( args: DeleteNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNamespace( - args: DeleteNamespaceCommandInput, - cb: (err: any, data?: DeleteNamespaceCommandOutput) => void - ): void; - public deleteNamespace( + deleteNamespace(args: DeleteNamespaceCommandInput, cb: (err: any, data?: DeleteNamespaceCommandOutput) => void): void; + deleteNamespace( args: DeleteNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNamespaceCommandOutput) => void ): void; - public deleteNamespace( - args: DeleteNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNamespaceCommandOutput) => void), - cb?: (err: any, data?: DeleteNamespaceCommandOutput) => void - ): Promise | void { - const command = new DeleteNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Deletes a system instance. - * Only system instances that have never been deployed, or that have been undeployed can be deleted.

- *

Users can create a new system instance that has the same ID as a deleted system instance.

+ * @see {@link DeleteSystemInstanceCommand} */ - public deleteSystemInstance( + deleteSystemInstance( args: DeleteSystemInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSystemInstance( + deleteSystemInstance( args: DeleteSystemInstanceCommandInput, cb: (err: any, data?: DeleteSystemInstanceCommandOutput) => void ): void; - public deleteSystemInstance( + deleteSystemInstance( args: DeleteSystemInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSystemInstanceCommandOutput) => void ): void; - public deleteSystemInstance( - args: DeleteSystemInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSystemInstanceCommandOutput) => void), - cb?: (err: any, data?: DeleteSystemInstanceCommandOutput) => void - ): Promise | void { - const command = new DeleteSystemInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Deletes a system. New deployments can't contain the system after its deletion. - * Existing deployments that contain the system will continue to work because they use a snapshot of the system that is taken when it is deployed.

+ * @see {@link DeleteSystemTemplateCommand} */ - public deleteSystemTemplate( + deleteSystemTemplate( args: DeleteSystemTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSystemTemplate( + deleteSystemTemplate( args: DeleteSystemTemplateCommandInput, cb: (err: any, data?: DeleteSystemTemplateCommandOutput) => void ): void; - public deleteSystemTemplate( + deleteSystemTemplate( args: DeleteSystemTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSystemTemplateCommandOutput) => void ): void; - public deleteSystemTemplate( - args: DeleteSystemTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSystemTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteSystemTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteSystemTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

- * Greengrass and Cloud Deployments - *

- *

Deploys the system instance to the target specified in CreateSystemInstance.

- *

- * Greengrass Deployments - *

- *

If the system or any workflows and entities have been updated before this action is called, then the deployment will create a new Amazon Simple Storage Service - * resource file and then deploy it.

- *

Since this action creates a Greengrass deployment on the caller's behalf, the calling identity must have write permissions - * to the specified Greengrass group. Otherwise, the call will fail with an authorization error.

- *

For information about the artifacts that get added to your Greengrass core device when you use this API, see AWS IoT Things Graph and AWS IoT Greengrass.

+ * @see {@link DeploySystemInstanceCommand} */ - public deploySystemInstance( + deploySystemInstance( args: DeploySystemInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deploySystemInstance( + deploySystemInstance( args: DeploySystemInstanceCommandInput, cb: (err: any, data?: DeploySystemInstanceCommandOutput) => void ): void; - public deploySystemInstance( + deploySystemInstance( args: DeploySystemInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeploySystemInstanceCommandOutput) => void ): void; - public deploySystemInstance( - args: DeploySystemInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeploySystemInstanceCommandOutput) => void), - cb?: (err: any, data?: DeploySystemInstanceCommandOutput) => void - ): Promise | void { - const command = new DeploySystemInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run.

+ * @see {@link DeprecateFlowTemplateCommand} */ - public deprecateFlowTemplate( + deprecateFlowTemplate( args: DeprecateFlowTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deprecateFlowTemplate( + deprecateFlowTemplate( args: DeprecateFlowTemplateCommandInput, cb: (err: any, data?: DeprecateFlowTemplateCommandOutput) => void ): void; - public deprecateFlowTemplate( + deprecateFlowTemplate( args: DeprecateFlowTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeprecateFlowTemplateCommandOutput) => void ): void; - public deprecateFlowTemplate( - args: DeprecateFlowTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeprecateFlowTemplateCommandOutput) => void), - cb?: (err: any, data?: DeprecateFlowTemplateCommandOutput) => void - ): Promise | void { - const command = new DeprecateFlowTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Deprecates the specified system.

+ * @see {@link DeprecateSystemTemplateCommand} */ - public deprecateSystemTemplate( + deprecateSystemTemplate( args: DeprecateSystemTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deprecateSystemTemplate( + deprecateSystemTemplate( args: DeprecateSystemTemplateCommandInput, cb: (err: any, data?: DeprecateSystemTemplateCommandOutput) => void ): void; - public deprecateSystemTemplate( + deprecateSystemTemplate( args: DeprecateSystemTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeprecateSystemTemplateCommandOutput) => void ): void; - public deprecateSystemTemplate( - args: DeprecateSystemTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeprecateSystemTemplateCommandOutput) => void), - cb?: (err: any, data?: DeprecateSystemTemplateCommandOutput) => void - ): Promise | void { - const command = new DeprecateSystemTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Gets the latest version of the user's namespace and the public version that it is tracking.

+ * @see {@link DescribeNamespaceCommand} */ - public describeNamespace( + describeNamespace( args: DescribeNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNamespace( + describeNamespace( args: DescribeNamespaceCommandInput, cb: (err: any, data?: DescribeNamespaceCommandOutput) => void ): void; - public describeNamespace( + describeNamespace( args: DescribeNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNamespaceCommandOutput) => void ): void; - public describeNamespace( - args: DescribeNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeNamespaceCommandOutput) => void), - cb?: (err: any, data?: DescribeNamespaceCommandOutput) => void - ): Promise | void { - const command = new DescribeNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Dissociates a device entity from a concrete thing. The action takes only the type of the entity that you need to dissociate because only - * one entity of a particular type can be associated with a thing.

+ * @see {@link DissociateEntityFromThingCommand} */ - public dissociateEntityFromThing( + dissociateEntityFromThing( args: DissociateEntityFromThingCommandInput, options?: __HttpHandlerOptions ): Promise; - public dissociateEntityFromThing( + dissociateEntityFromThing( args: DissociateEntityFromThingCommandInput, cb: (err: any, data?: DissociateEntityFromThingCommandOutput) => void ): void; - public dissociateEntityFromThing( + dissociateEntityFromThing( args: DissociateEntityFromThingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DissociateEntityFromThingCommandOutput) => void ): void; - public dissociateEntityFromThing( - args: DissociateEntityFromThingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DissociateEntityFromThingCommandOutput) => void), - cb?: (err: any, data?: DissociateEntityFromThingCommandOutput) => void - ): Promise | void { - const command = new DissociateEntityFromThingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the - * following TDM entities.

- *
    - *
  • - *

    Properties

    - *
  • - *
  • - *

    States

    - *
  • - *
  • - *

    Events

    - *
  • - *
  • - *

    Actions

    - *
  • - *
  • - *

    Capabilities

    - *
  • - *
  • - *

    Mappings

    - *
  • - *
  • - *

    Devices

    - *
  • - *
  • - *

    Device Models

    - *
  • - *
  • - *

    Services

    - *
  • - *
- *

This action doesn't return definitions for systems, flows, and deployments.

+ * @see {@link GetEntitiesCommand} */ - public getEntities(args: GetEntitiesCommandInput, options?: __HttpHandlerOptions): Promise; - public getEntities(args: GetEntitiesCommandInput, cb: (err: any, data?: GetEntitiesCommandOutput) => void): void; - public getEntities( + getEntities(args: GetEntitiesCommandInput, options?: __HttpHandlerOptions): Promise; + getEntities(args: GetEntitiesCommandInput, cb: (err: any, data?: GetEntitiesCommandOutput) => void): void; + getEntities( args: GetEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEntitiesCommandOutput) => void ): void; - public getEntities( - args: GetEntitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEntitiesCommandOutput) => void), - cb?: (err: any, data?: GetEntitiesCommandOutput) => void - ): Promise | void { - const command = new GetEntitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the specified workflow.

+ * @see {@link GetFlowTemplateCommand} */ - public getFlowTemplate( + getFlowTemplate( args: GetFlowTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFlowTemplate( - args: GetFlowTemplateCommandInput, - cb: (err: any, data?: GetFlowTemplateCommandOutput) => void - ): void; - public getFlowTemplate( + getFlowTemplate(args: GetFlowTemplateCommandInput, cb: (err: any, data?: GetFlowTemplateCommandOutput) => void): void; + getFlowTemplate( args: GetFlowTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFlowTemplateCommandOutput) => void ): void; - public getFlowTemplate( - args: GetFlowTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFlowTemplateCommandOutput) => void), - cb?: (err: any, data?: GetFlowTemplateCommandOutput) => void - ): Promise | void { - const command = new GetFlowTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Gets revisions of the specified workflow. Only the last 100 revisions are stored. If the workflow has been deprecated, - * this action will return revisions that occurred before the deprecation. This action won't work for workflows that have been deleted.

+ * @see {@link GetFlowTemplateRevisionsCommand} */ - public getFlowTemplateRevisions( + getFlowTemplateRevisions( args: GetFlowTemplateRevisionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFlowTemplateRevisions( + getFlowTemplateRevisions( args: GetFlowTemplateRevisionsCommandInput, cb: (err: any, data?: GetFlowTemplateRevisionsCommandOutput) => void ): void; - public getFlowTemplateRevisions( + getFlowTemplateRevisions( args: GetFlowTemplateRevisionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFlowTemplateRevisionsCommandOutput) => void ): void; - public getFlowTemplateRevisions( - args: GetFlowTemplateRevisionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFlowTemplateRevisionsCommandOutput) => void), - cb?: (err: any, data?: GetFlowTemplateRevisionsCommandOutput) => void - ): Promise | void { - const command = new GetFlowTemplateRevisionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Gets the status of a namespace deletion task.

+ * @see {@link GetNamespaceDeletionStatusCommand} */ - public getNamespaceDeletionStatus( + getNamespaceDeletionStatus( args: GetNamespaceDeletionStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getNamespaceDeletionStatus( + getNamespaceDeletionStatus( args: GetNamespaceDeletionStatusCommandInput, cb: (err: any, data?: GetNamespaceDeletionStatusCommandOutput) => void ): void; - public getNamespaceDeletionStatus( + getNamespaceDeletionStatus( args: GetNamespaceDeletionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNamespaceDeletionStatusCommandOutput) => void ): void; - public getNamespaceDeletionStatus( - args: GetNamespaceDeletionStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetNamespaceDeletionStatusCommandOutput) => void), - cb?: (err: any, data?: GetNamespaceDeletionStatusCommandOutput) => void - ): Promise | void { - const command = new GetNamespaceDeletionStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Gets a system instance.

+ * @see {@link GetSystemInstanceCommand} */ - public getSystemInstance( + getSystemInstance( args: GetSystemInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSystemInstance( + getSystemInstance( args: GetSystemInstanceCommandInput, cb: (err: any, data?: GetSystemInstanceCommandOutput) => void ): void; - public getSystemInstance( + getSystemInstance( args: GetSystemInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSystemInstanceCommandOutput) => void ): void; - public getSystemInstance( - args: GetSystemInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSystemInstanceCommandOutput) => void), - cb?: (err: any, data?: GetSystemInstanceCommandOutput) => void - ): Promise | void { - const command = new GetSystemInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Gets a system.

+ * @see {@link GetSystemTemplateCommand} */ - public getSystemTemplate( + getSystemTemplate( args: GetSystemTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSystemTemplate( + getSystemTemplate( args: GetSystemTemplateCommandInput, cb: (err: any, data?: GetSystemTemplateCommandOutput) => void ): void; - public getSystemTemplate( + getSystemTemplate( args: GetSystemTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSystemTemplateCommandOutput) => void ): void; - public getSystemTemplate( - args: GetSystemTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSystemTemplateCommandOutput) => void), - cb?: (err: any, data?: GetSystemTemplateCommandOutput) => void - ): Promise | void { - const command = new GetSystemTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Gets revisions made to the specified system template. Only the previous 100 revisions are stored. If the system has been deprecated, this action will return - * the revisions that occurred before its deprecation. This action won't work with systems that have been deleted.

+ * @see {@link GetSystemTemplateRevisionsCommand} */ - public getSystemTemplateRevisions( + getSystemTemplateRevisions( args: GetSystemTemplateRevisionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSystemTemplateRevisions( + getSystemTemplateRevisions( args: GetSystemTemplateRevisionsCommandInput, cb: (err: any, data?: GetSystemTemplateRevisionsCommandOutput) => void ): void; - public getSystemTemplateRevisions( + getSystemTemplateRevisions( args: GetSystemTemplateRevisionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSystemTemplateRevisionsCommandOutput) => void ): void; - public getSystemTemplateRevisions( - args: GetSystemTemplateRevisionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSystemTemplateRevisionsCommandOutput) => void), - cb?: (err: any, data?: GetSystemTemplateRevisionsCommandOutput) => void - ): Promise | void { - const command = new GetSystemTemplateRevisionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Gets the status of the specified upload.

+ * @see {@link GetUploadStatusCommand} */ - public getUploadStatus( + getUploadStatus( args: GetUploadStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUploadStatus( - args: GetUploadStatusCommandInput, - cb: (err: any, data?: GetUploadStatusCommandOutput) => void - ): void; - public getUploadStatus( + getUploadStatus(args: GetUploadStatusCommandInput, cb: (err: any, data?: GetUploadStatusCommandOutput) => void): void; + getUploadStatus( args: GetUploadStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUploadStatusCommandOutput) => void ): void; - public getUploadStatus( - args: GetUploadStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUploadStatusCommandOutput) => void), - cb?: (err: any, data?: GetUploadStatusCommandOutput) => void - ): Promise | void { - const command = new GetUploadStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Returns a list of objects that contain information about events in a flow execution.

+ * @see {@link ListFlowExecutionMessagesCommand} */ - public listFlowExecutionMessages( + listFlowExecutionMessages( args: ListFlowExecutionMessagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFlowExecutionMessages( + listFlowExecutionMessages( args: ListFlowExecutionMessagesCommandInput, cb: (err: any, data?: ListFlowExecutionMessagesCommandOutput) => void ): void; - public listFlowExecutionMessages( + listFlowExecutionMessages( args: ListFlowExecutionMessagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFlowExecutionMessagesCommandOutput) => void ): void; - public listFlowExecutionMessages( - args: ListFlowExecutionMessagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFlowExecutionMessagesCommandOutput) => void), - cb?: (err: any, data?: ListFlowExecutionMessagesCommandOutput) => void - ): Promise | void { - const command = new ListFlowExecutionMessagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Lists all tags on an AWS IoT Things Graph resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.

+ * @see {@link SearchEntitiesCommand} */ - public searchEntities( + searchEntities( args: SearchEntitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchEntities( - args: SearchEntitiesCommandInput, - cb: (err: any, data?: SearchEntitiesCommandOutput) => void - ): void; - public searchEntities( + searchEntities(args: SearchEntitiesCommandInput, cb: (err: any, data?: SearchEntitiesCommandOutput) => void): void; + searchEntities( args: SearchEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchEntitiesCommandOutput) => void ): void; - public searchEntities( - args: SearchEntitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchEntitiesCommandOutput) => void), - cb?: (err: any, data?: SearchEntitiesCommandOutput) => void - ): Promise | void { - const command = new SearchEntitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Searches for AWS IoT Things Graph workflow execution instances.

+ * @see {@link SearchFlowExecutionsCommand} */ - public searchFlowExecutions( + searchFlowExecutions( args: SearchFlowExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchFlowExecutions( + searchFlowExecutions( args: SearchFlowExecutionsCommandInput, cb: (err: any, data?: SearchFlowExecutionsCommandOutput) => void ): void; - public searchFlowExecutions( + searchFlowExecutions( args: SearchFlowExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchFlowExecutionsCommandOutput) => void ): void; - public searchFlowExecutions( - args: SearchFlowExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchFlowExecutionsCommandOutput) => void), - cb?: (err: any, data?: SearchFlowExecutionsCommandOutput) => void - ): Promise | void { - const command = new SearchFlowExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Searches for summary information about workflows.

+ * @see {@link SearchFlowTemplatesCommand} */ - public searchFlowTemplates( + searchFlowTemplates( args: SearchFlowTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchFlowTemplates( + searchFlowTemplates( args: SearchFlowTemplatesCommandInput, cb: (err: any, data?: SearchFlowTemplatesCommandOutput) => void ): void; - public searchFlowTemplates( + searchFlowTemplates( args: SearchFlowTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchFlowTemplatesCommandOutput) => void ): void; - public searchFlowTemplates( - args: SearchFlowTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchFlowTemplatesCommandOutput) => void), - cb?: (err: any, data?: SearchFlowTemplatesCommandOutput) => void - ): Promise | void { - const command = new SearchFlowTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Searches for system instances in the user's account.

+ * @see {@link SearchSystemInstancesCommand} */ - public searchSystemInstances( + searchSystemInstances( args: SearchSystemInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchSystemInstances( + searchSystemInstances( args: SearchSystemInstancesCommandInput, cb: (err: any, data?: SearchSystemInstancesCommandOutput) => void ): void; - public searchSystemInstances( + searchSystemInstances( args: SearchSystemInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchSystemInstancesCommandOutput) => void ): void; - public searchSystemInstances( - args: SearchSystemInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchSystemInstancesCommandOutput) => void), - cb?: (err: any, data?: SearchSystemInstancesCommandOutput) => void - ): Promise | void { - const command = new SearchSystemInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Searches for summary information about systems in the user's account. You can filter by the ID of a workflow to return only systems that use the specified workflow.

+ * @see {@link SearchSystemTemplatesCommand} */ - public searchSystemTemplates( + searchSystemTemplates( args: SearchSystemTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchSystemTemplates( + searchSystemTemplates( args: SearchSystemTemplatesCommandInput, cb: (err: any, data?: SearchSystemTemplatesCommandOutput) => void ): void; - public searchSystemTemplates( + searchSystemTemplates( args: SearchSystemTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchSystemTemplatesCommandOutput) => void ): void; - public searchSystemTemplates( - args: SearchSystemTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchSystemTemplatesCommandOutput) => void), - cb?: (err: any, data?: SearchSystemTemplatesCommandOutput) => void - ): Promise | void { - const command = new SearchSystemTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Searches for things associated with the specified entity. You can search by both device and device model.

- *

For example, if two different devices, camera1 and camera2, implement the camera device model, the user can associate thing1 to camera1 and thing2 to camera2. - * SearchThings(camera2) will return only thing2, but SearchThings(camera) will return both thing1 and thing2.

- *

This action searches for exact matches and doesn't perform partial text matching.

+ * @see {@link SearchThingsCommand} */ - public searchThings( - args: SearchThingsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public searchThings(args: SearchThingsCommandInput, cb: (err: any, data?: SearchThingsCommandOutput) => void): void; - public searchThings( + searchThings(args: SearchThingsCommandInput, options?: __HttpHandlerOptions): Promise; + searchThings(args: SearchThingsCommandInput, cb: (err: any, data?: SearchThingsCommandOutput) => void): void; + searchThings( args: SearchThingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchThingsCommandOutput) => void ): void; - public searchThings( - args: SearchThingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchThingsCommandOutput) => void), - cb?: (err: any, data?: SearchThingsCommandOutput) => void - ): Promise | void { - const command = new SearchThingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Creates a tag for the specified resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Removes a system instance from its target (Cloud or Greengrass).

+ * @see {@link UndeploySystemInstanceCommand} */ - public undeploySystemInstance( + undeploySystemInstance( args: UndeploySystemInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public undeploySystemInstance( + undeploySystemInstance( args: UndeploySystemInstanceCommandInput, cb: (err: any, data?: UndeploySystemInstanceCommandOutput) => void ): void; - public undeploySystemInstance( + undeploySystemInstance( args: UndeploySystemInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UndeploySystemInstanceCommandOutput) => void ): void; - public undeploySystemInstance( - args: UndeploySystemInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UndeploySystemInstanceCommandOutput) => void), - cb?: (err: any, data?: UndeploySystemInstanceCommandOutput) => void - ): Promise | void { - const command = new UndeploySystemInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Removes a tag from the specified resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Updates the specified workflow. All deployed systems and system instances that use the workflow will see the changes in the flow when it is redeployed. If you don't want this - * behavior, copy the workflow (creating a new workflow with a different ID), and update the copy. The workflow can contain only entities in the specified namespace.

+ * @see {@link UpdateFlowTemplateCommand} */ - public updateFlowTemplate( + updateFlowTemplate( args: UpdateFlowTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFlowTemplate( + updateFlowTemplate( args: UpdateFlowTemplateCommandInput, cb: (err: any, data?: UpdateFlowTemplateCommandOutput) => void ): void; - public updateFlowTemplate( + updateFlowTemplate( args: UpdateFlowTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFlowTemplateCommandOutput) => void ): void; - public updateFlowTemplate( - args: UpdateFlowTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFlowTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateFlowTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateFlowTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Updates the specified system. You don't need to run this action after updating a workflow. Any deployment that uses the system will see the changes in the system when it is redeployed.

+ * @see {@link UpdateSystemTemplateCommand} */ - public updateSystemTemplate( + updateSystemTemplate( args: UpdateSystemTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSystemTemplate( + updateSystemTemplate( args: UpdateSystemTemplateCommandInput, cb: (err: any, data?: UpdateSystemTemplateCommandOutput) => void ): void; - public updateSystemTemplate( + updateSystemTemplate( args: UpdateSystemTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSystemTemplateCommandOutput) => void ): void; - public updateSystemTemplate( - args: UpdateSystemTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSystemTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateSystemTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateSystemTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Asynchronously uploads one or more entity definitions to the user's namespace. The document parameter is required if - * syncWithPublicNamespace and deleteExistingEntites are false. If the syncWithPublicNamespace parameter is set to - * true, the user's namespace will synchronize with the latest version of the public namespace. If deprecateExistingEntities is set to true, - * all entities in the latest version will be deleted before the new DefinitionDocument is uploaded.

- *

When a user uploads entity definitions for the first time, the service creates a new namespace for the user. The new namespace tracks the public namespace. Currently users - * can have only one namespace. The namespace version increments whenever a user uploads entity definitions that are backwards-incompatible and whenever a user sets the - * syncWithPublicNamespace parameter or the deprecateExistingEntities parameter to true.

- *

The IDs for all of the entities should be in URN format. Each entity must be in the user's namespace. Users can't create entities in the public namespace, but entity definitions can refer to entities in the public namespace.

- *

Valid entities are Device, DeviceModel, Service, Capability, State, Action, Event, Property, - * Mapping, Enum. - *

+ * @see {@link UploadEntityDefinitionsCommand} */ - public uploadEntityDefinitions( + uploadEntityDefinitions( args: UploadEntityDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public uploadEntityDefinitions( + uploadEntityDefinitions( args: UploadEntityDefinitionsCommandInput, cb: (err: any, data?: UploadEntityDefinitionsCommandOutput) => void ): void; - public uploadEntityDefinitions( + uploadEntityDefinitions( args: UploadEntityDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UploadEntityDefinitionsCommandOutput) => void ): void; - public uploadEntityDefinitions( - args: UploadEntityDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UploadEntityDefinitionsCommandOutput) => void), - cb?: (err: any, data?: UploadEntityDefinitionsCommandOutput) => void - ): Promise | void { - const command = new UploadEntityDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * AWS IoT Things Graph + *

AWS IoT Things Graph provides an integrated set of tools that enable developers to connect devices and services that use different standards, + * such as units of measure and communication protocols. AWS IoT Things Graph makes it possible to build IoT applications with little to no code by connecting devices and services + * and defining how they interact at an abstract level.

+ *

For more information about how AWS IoT Things Graph works, see the User Guide.

+ * + *

The AWS IoT Things Graph service is discontinued.

+ */ +export class IoTThingsGraph extends IoTThingsGraphClient implements IoTThingsGraph {} +createAggregatedClient(commands, IoTThingsGraph); diff --git a/clients/client-iottwinmaker/src/IoTTwinMaker.ts b/clients/client-iottwinmaker/src/IoTTwinMaker.ts index 7cb3c0eccace..323894ce1b00 100644 --- a/clients/client-iottwinmaker/src/IoTTwinMaker.ts +++ b/clients/client-iottwinmaker/src/IoTTwinMaker.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -139,1076 +140,511 @@ import { UpdateWorkspaceCommandInput, UpdateWorkspaceCommandOutput, } from "./commands/UpdateWorkspaceCommand"; -import { IoTTwinMakerClient } from "./IoTTwinMakerClient"; +import { IoTTwinMakerClient, IoTTwinMakerClientConfig } from "./IoTTwinMakerClient"; -/** - * @public - *

IoT TwinMaker is a service with which you - * can - * build operational digital twins of physical systems. IoT TwinMaker overlays measurements - * and analysis from real-world sensors, cameras, and enterprise applications so you can - * create data visualizations to monitor your physical factory, building, or industrial plant. - * You can use this real-world data to monitor operations and diagnose and repair - * errors.

- */ -export class IoTTwinMaker extends IoTTwinMakerClient { +const commands = { + BatchPutPropertyValuesCommand, + CreateComponentTypeCommand, + CreateEntityCommand, + CreateSceneCommand, + CreateSyncJobCommand, + CreateWorkspaceCommand, + DeleteComponentTypeCommand, + DeleteEntityCommand, + DeleteSceneCommand, + DeleteSyncJobCommand, + DeleteWorkspaceCommand, + ExecuteQueryCommand, + GetComponentTypeCommand, + GetEntityCommand, + GetPricingPlanCommand, + GetPropertyValueCommand, + GetPropertyValueHistoryCommand, + GetSceneCommand, + GetSyncJobCommand, + GetWorkspaceCommand, + ListComponentTypesCommand, + ListEntitiesCommand, + ListScenesCommand, + ListSyncJobsCommand, + ListSyncResourcesCommand, + ListTagsForResourceCommand, + ListWorkspacesCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateComponentTypeCommand, + UpdateEntityCommand, + UpdatePricingPlanCommand, + UpdateSceneCommand, + UpdateWorkspaceCommand, +}; + +export interface IoTTwinMaker { /** - * @public - *

Sets values for multiple time series properties.

+ * @see {@link BatchPutPropertyValuesCommand} */ - public batchPutPropertyValues( + batchPutPropertyValues( args: BatchPutPropertyValuesCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchPutPropertyValues( + batchPutPropertyValues( args: BatchPutPropertyValuesCommandInput, cb: (err: any, data?: BatchPutPropertyValuesCommandOutput) => void ): void; - public batchPutPropertyValues( + batchPutPropertyValues( args: BatchPutPropertyValuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchPutPropertyValuesCommandOutput) => void ): void; - public batchPutPropertyValues( - args: BatchPutPropertyValuesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchPutPropertyValuesCommandOutput) => void), - cb?: (err: any, data?: BatchPutPropertyValuesCommandOutput) => void - ): Promise | void { - const command = new BatchPutPropertyValuesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a component type.

+ * @see {@link CreateComponentTypeCommand} */ - public createComponentType( + createComponentType( args: CreateComponentTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public createComponentType( + createComponentType( args: CreateComponentTypeCommandInput, cb: (err: any, data?: CreateComponentTypeCommandOutput) => void ): void; - public createComponentType( + createComponentType( args: CreateComponentTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateComponentTypeCommandOutput) => void ): void; - public createComponentType( - args: CreateComponentTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateComponentTypeCommandOutput) => void), - cb?: (err: any, data?: CreateComponentTypeCommandOutput) => void - ): Promise | void { - const command = new CreateComponentTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an entity.

+ * @see {@link CreateEntityCommand} */ - public createEntity( - args: CreateEntityCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createEntity(args: CreateEntityCommandInput, cb: (err: any, data?: CreateEntityCommandOutput) => void): void; - public createEntity( + createEntity(args: CreateEntityCommandInput, options?: __HttpHandlerOptions): Promise; + createEntity(args: CreateEntityCommandInput, cb: (err: any, data?: CreateEntityCommandOutput) => void): void; + createEntity( args: CreateEntityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEntityCommandOutput) => void ): void; - public createEntity( - args: CreateEntityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEntityCommandOutput) => void), - cb?: (err: any, data?: CreateEntityCommandOutput) => void - ): Promise | void { - const command = new CreateEntityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a scene.

+ * @see {@link CreateSceneCommand} */ - public createScene(args: CreateSceneCommandInput, options?: __HttpHandlerOptions): Promise; - public createScene(args: CreateSceneCommandInput, cb: (err: any, data?: CreateSceneCommandOutput) => void): void; - public createScene( + createScene(args: CreateSceneCommandInput, options?: __HttpHandlerOptions): Promise; + createScene(args: CreateSceneCommandInput, cb: (err: any, data?: CreateSceneCommandOutput) => void): void; + createScene( args: CreateSceneCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSceneCommandOutput) => void ): void; - public createScene( - args: CreateSceneCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSceneCommandOutput) => void), - cb?: (err: any, data?: CreateSceneCommandOutput) => void - ): Promise | void { - const command = new CreateSceneCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This action creates a SyncJob.

+ * @see {@link CreateSyncJobCommand} */ - public createSyncJob( - args: CreateSyncJobCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createSyncJob( - args: CreateSyncJobCommandInput, - cb: (err: any, data?: CreateSyncJobCommandOutput) => void - ): void; - public createSyncJob( + createSyncJob(args: CreateSyncJobCommandInput, options?: __HttpHandlerOptions): Promise; + createSyncJob(args: CreateSyncJobCommandInput, cb: (err: any, data?: CreateSyncJobCommandOutput) => void): void; + createSyncJob( args: CreateSyncJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSyncJobCommandOutput) => void ): void; - public createSyncJob( - args: CreateSyncJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSyncJobCommandOutput) => void), - cb?: (err: any, data?: CreateSyncJobCommandOutput) => void - ): Promise | void { - const command = new CreateSyncJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a workplace.

+ * @see {@link CreateWorkspaceCommand} */ - public createWorkspace( + createWorkspace( args: CreateWorkspaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorkspace( - args: CreateWorkspaceCommandInput, - cb: (err: any, data?: CreateWorkspaceCommandOutput) => void - ): void; - public createWorkspace( + createWorkspace(args: CreateWorkspaceCommandInput, cb: (err: any, data?: CreateWorkspaceCommandOutput) => void): void; + createWorkspace( args: CreateWorkspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkspaceCommandOutput) => void ): void; - public createWorkspace( - args: CreateWorkspaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorkspaceCommandOutput) => void), - cb?: (err: any, data?: CreateWorkspaceCommandOutput) => void - ): Promise | void { - const command = new CreateWorkspaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a component type.

+ * @see {@link DeleteComponentTypeCommand} */ - public deleteComponentType( + deleteComponentType( args: DeleteComponentTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteComponentType( + deleteComponentType( args: DeleteComponentTypeCommandInput, cb: (err: any, data?: DeleteComponentTypeCommandOutput) => void ): void; - public deleteComponentType( + deleteComponentType( args: DeleteComponentTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteComponentTypeCommandOutput) => void ): void; - public deleteComponentType( - args: DeleteComponentTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteComponentTypeCommandOutput) => void), - cb?: (err: any, data?: DeleteComponentTypeCommandOutput) => void - ): Promise | void { - const command = new DeleteComponentTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an entity.

+ * @see {@link DeleteEntityCommand} */ - public deleteEntity( - args: DeleteEntityCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteEntity(args: DeleteEntityCommandInput, cb: (err: any, data?: DeleteEntityCommandOutput) => void): void; - public deleteEntity( + deleteEntity(args: DeleteEntityCommandInput, options?: __HttpHandlerOptions): Promise; + deleteEntity(args: DeleteEntityCommandInput, cb: (err: any, data?: DeleteEntityCommandOutput) => void): void; + deleteEntity( args: DeleteEntityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEntityCommandOutput) => void ): void; - public deleteEntity( - args: DeleteEntityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEntityCommandOutput) => void), - cb?: (err: any, data?: DeleteEntityCommandOutput) => void - ): Promise | void { - const command = new DeleteEntityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a scene.

+ * @see {@link DeleteSceneCommand} */ - public deleteScene(args: DeleteSceneCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteScene(args: DeleteSceneCommandInput, cb: (err: any, data?: DeleteSceneCommandOutput) => void): void; - public deleteScene( + deleteScene(args: DeleteSceneCommandInput, options?: __HttpHandlerOptions): Promise; + deleteScene(args: DeleteSceneCommandInput, cb: (err: any, data?: DeleteSceneCommandOutput) => void): void; + deleteScene( args: DeleteSceneCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSceneCommandOutput) => void ): void; - public deleteScene( - args: DeleteSceneCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSceneCommandOutput) => void), - cb?: (err: any, data?: DeleteSceneCommandOutput) => void - ): Promise | void { - const command = new DeleteSceneCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete the SyncJob.

+ * @see {@link DeleteSyncJobCommand} */ - public deleteSyncJob( - args: DeleteSyncJobCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteSyncJob( - args: DeleteSyncJobCommandInput, - cb: (err: any, data?: DeleteSyncJobCommandOutput) => void - ): void; - public deleteSyncJob( + deleteSyncJob(args: DeleteSyncJobCommandInput, options?: __HttpHandlerOptions): Promise; + deleteSyncJob(args: DeleteSyncJobCommandInput, cb: (err: any, data?: DeleteSyncJobCommandOutput) => void): void; + deleteSyncJob( args: DeleteSyncJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSyncJobCommandOutput) => void ): void; - public deleteSyncJob( - args: DeleteSyncJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSyncJobCommandOutput) => void), - cb?: (err: any, data?: DeleteSyncJobCommandOutput) => void - ): Promise | void { - const command = new DeleteSyncJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a workspace.

+ * @see {@link DeleteWorkspaceCommand} */ - public deleteWorkspace( + deleteWorkspace( args: DeleteWorkspaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWorkspace( - args: DeleteWorkspaceCommandInput, - cb: (err: any, data?: DeleteWorkspaceCommandOutput) => void - ): void; - public deleteWorkspace( + deleteWorkspace(args: DeleteWorkspaceCommandInput, cb: (err: any, data?: DeleteWorkspaceCommandOutput) => void): void; + deleteWorkspace( args: DeleteWorkspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkspaceCommandOutput) => void ): void; - public deleteWorkspace( - args: DeleteWorkspaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorkspaceCommandOutput) => void), - cb?: (err: any, data?: DeleteWorkspaceCommandOutput) => void - ): Promise | void { - const command = new DeleteWorkspaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Run queries to access information from your knowledge graph of entities within - * individual workspaces.

+ * @see {@link ExecuteQueryCommand} */ - public executeQuery( - args: ExecuteQueryCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public executeQuery(args: ExecuteQueryCommandInput, cb: (err: any, data?: ExecuteQueryCommandOutput) => void): void; - public executeQuery( + executeQuery(args: ExecuteQueryCommandInput, options?: __HttpHandlerOptions): Promise; + executeQuery(args: ExecuteQueryCommandInput, cb: (err: any, data?: ExecuteQueryCommandOutput) => void): void; + executeQuery( args: ExecuteQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteQueryCommandOutput) => void ): void; - public executeQuery( - args: ExecuteQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExecuteQueryCommandOutput) => void), - cb?: (err: any, data?: ExecuteQueryCommandOutput) => void - ): Promise | void { - const command = new ExecuteQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a component type.

+ * @see {@link GetComponentTypeCommand} */ - public getComponentType( + getComponentType( args: GetComponentTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public getComponentType( + getComponentType( args: GetComponentTypeCommandInput, cb: (err: any, data?: GetComponentTypeCommandOutput) => void ): void; - public getComponentType( + getComponentType( args: GetComponentTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComponentTypeCommandOutput) => void ): void; - public getComponentType( - args: GetComponentTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetComponentTypeCommandOutput) => void), - cb?: (err: any, data?: GetComponentTypeCommandOutput) => void - ): Promise | void { - const command = new GetComponentTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about an entity.

+ * @see {@link GetEntityCommand} */ - public getEntity(args: GetEntityCommandInput, options?: __HttpHandlerOptions): Promise; - public getEntity(args: GetEntityCommandInput, cb: (err: any, data?: GetEntityCommandOutput) => void): void; - public getEntity( + getEntity(args: GetEntityCommandInput, options?: __HttpHandlerOptions): Promise; + getEntity(args: GetEntityCommandInput, cb: (err: any, data?: GetEntityCommandOutput) => void): void; + getEntity( args: GetEntityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEntityCommandOutput) => void ): void; - public getEntity( - args: GetEntityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEntityCommandOutput) => void), - cb?: (err: any, data?: GetEntityCommandOutput) => void - ): Promise | void { - const command = new GetEntityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the pricing plan.

+ * @see {@link GetPricingPlanCommand} */ - public getPricingPlan( + getPricingPlan( args: GetPricingPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPricingPlan( - args: GetPricingPlanCommandInput, - cb: (err: any, data?: GetPricingPlanCommandOutput) => void - ): void; - public getPricingPlan( + getPricingPlan(args: GetPricingPlanCommandInput, cb: (err: any, data?: GetPricingPlanCommandOutput) => void): void; + getPricingPlan( args: GetPricingPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPricingPlanCommandOutput) => void ): void; - public getPricingPlan( - args: GetPricingPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPricingPlanCommandOutput) => void), - cb?: (err: any, data?: GetPricingPlanCommandOutput) => void - ): Promise | void { - const command = new GetPricingPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the property values for a component, component type, entity, or workspace.

- *

You must specify a value for either componentName, - * componentTypeId, entityId, or workspaceId.

+ * @see {@link GetPropertyValueCommand} */ - public getPropertyValue( + getPropertyValue( args: GetPropertyValueCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPropertyValue( + getPropertyValue( args: GetPropertyValueCommandInput, cb: (err: any, data?: GetPropertyValueCommandOutput) => void ): void; - public getPropertyValue( + getPropertyValue( args: GetPropertyValueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPropertyValueCommandOutput) => void ): void; - public getPropertyValue( - args: GetPropertyValueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPropertyValueCommandOutput) => void), - cb?: (err: any, data?: GetPropertyValueCommandOutput) => void - ): Promise | void { - const command = new GetPropertyValueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the history of a time series property value for a component, - * component type, entity, or workspace.

- *

You must specify a value for workspaceId. For entity-specific queries, - * specify values for componentName and entityId. For cross-entity - * quries, specify a value for componentTypeId.

+ * @see {@link GetPropertyValueHistoryCommand} */ - public getPropertyValueHistory( + getPropertyValueHistory( args: GetPropertyValueHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPropertyValueHistory( + getPropertyValueHistory( args: GetPropertyValueHistoryCommandInput, cb: (err: any, data?: GetPropertyValueHistoryCommandOutput) => void ): void; - public getPropertyValueHistory( + getPropertyValueHistory( args: GetPropertyValueHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPropertyValueHistoryCommandOutput) => void ): void; - public getPropertyValueHistory( - args: GetPropertyValueHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPropertyValueHistoryCommandOutput) => void), - cb?: (err: any, data?: GetPropertyValueHistoryCommandOutput) => void - ): Promise | void { - const command = new GetPropertyValueHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a scene.

+ * @see {@link GetSceneCommand} */ - public getScene(args: GetSceneCommandInput, options?: __HttpHandlerOptions): Promise; - public getScene(args: GetSceneCommandInput, cb: (err: any, data?: GetSceneCommandOutput) => void): void; - public getScene( + getScene(args: GetSceneCommandInput, options?: __HttpHandlerOptions): Promise; + getScene(args: GetSceneCommandInput, cb: (err: any, data?: GetSceneCommandOutput) => void): void; + getScene( args: GetSceneCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSceneCommandOutput) => void ): void; - public getScene( - args: GetSceneCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSceneCommandOutput) => void), - cb?: (err: any, data?: GetSceneCommandOutput) => void - ): Promise | void { - const command = new GetSceneCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the SyncJob.

+ * @see {@link GetSyncJobCommand} */ - public getSyncJob(args: GetSyncJobCommandInput, options?: __HttpHandlerOptions): Promise; - public getSyncJob(args: GetSyncJobCommandInput, cb: (err: any, data?: GetSyncJobCommandOutput) => void): void; - public getSyncJob( + getSyncJob(args: GetSyncJobCommandInput, options?: __HttpHandlerOptions): Promise; + getSyncJob(args: GetSyncJobCommandInput, cb: (err: any, data?: GetSyncJobCommandOutput) => void): void; + getSyncJob( args: GetSyncJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSyncJobCommandOutput) => void ): void; - public getSyncJob( - args: GetSyncJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSyncJobCommandOutput) => void), - cb?: (err: any, data?: GetSyncJobCommandOutput) => void - ): Promise | void { - const command = new GetSyncJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a workspace.

+ * @see {@link GetWorkspaceCommand} */ - public getWorkspace( - args: GetWorkspaceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getWorkspace(args: GetWorkspaceCommandInput, cb: (err: any, data?: GetWorkspaceCommandOutput) => void): void; - public getWorkspace( + getWorkspace(args: GetWorkspaceCommandInput, options?: __HttpHandlerOptions): Promise; + getWorkspace(args: GetWorkspaceCommandInput, cb: (err: any, data?: GetWorkspaceCommandOutput) => void): void; + getWorkspace( args: GetWorkspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkspaceCommandOutput) => void ): void; - public getWorkspace( - args: GetWorkspaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkspaceCommandOutput) => void), - cb?: (err: any, data?: GetWorkspaceCommandOutput) => void - ): Promise | void { - const command = new GetWorkspaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all component types in a workspace.

+ * @see {@link ListComponentTypesCommand} */ - public listComponentTypes( + listComponentTypes( args: ListComponentTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listComponentTypes( + listComponentTypes( args: ListComponentTypesCommandInput, cb: (err: any, data?: ListComponentTypesCommandOutput) => void ): void; - public listComponentTypes( + listComponentTypes( args: ListComponentTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComponentTypesCommandOutput) => void ): void; - public listComponentTypes( - args: ListComponentTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListComponentTypesCommandOutput) => void), - cb?: (err: any, data?: ListComponentTypesCommandOutput) => void - ): Promise | void { - const command = new ListComponentTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all entities in a workspace.

+ * @see {@link ListEntitiesCommand} */ - public listEntities( - args: ListEntitiesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listEntities(args: ListEntitiesCommandInput, cb: (err: any, data?: ListEntitiesCommandOutput) => void): void; - public listEntities( + listEntities(args: ListEntitiesCommandInput, options?: __HttpHandlerOptions): Promise; + listEntities(args: ListEntitiesCommandInput, cb: (err: any, data?: ListEntitiesCommandOutput) => void): void; + listEntities( args: ListEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEntitiesCommandOutput) => void ): void; - public listEntities( - args: ListEntitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEntitiesCommandOutput) => void), - cb?: (err: any, data?: ListEntitiesCommandOutput) => void - ): Promise | void { - const command = new ListEntitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all scenes in a workspace.

+ * @see {@link ListScenesCommand} */ - public listScenes(args: ListScenesCommandInput, options?: __HttpHandlerOptions): Promise; - public listScenes(args: ListScenesCommandInput, cb: (err: any, data?: ListScenesCommandOutput) => void): void; - public listScenes( + listScenes(args: ListScenesCommandInput, options?: __HttpHandlerOptions): Promise; + listScenes(args: ListScenesCommandInput, cb: (err: any, data?: ListScenesCommandOutput) => void): void; + listScenes( args: ListScenesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListScenesCommandOutput) => void ): void; - public listScenes( - args: ListScenesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListScenesCommandOutput) => void), - cb?: (err: any, data?: ListScenesCommandOutput) => void - ): Promise | void { - const command = new ListScenesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all SyncJobs.

+ * @see {@link ListSyncJobsCommand} */ - public listSyncJobs( - args: ListSyncJobsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listSyncJobs(args: ListSyncJobsCommandInput, cb: (err: any, data?: ListSyncJobsCommandOutput) => void): void; - public listSyncJobs( + listSyncJobs(args: ListSyncJobsCommandInput, options?: __HttpHandlerOptions): Promise; + listSyncJobs(args: ListSyncJobsCommandInput, cb: (err: any, data?: ListSyncJobsCommandOutput) => void): void; + listSyncJobs( args: ListSyncJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSyncJobsCommandOutput) => void ): void; - public listSyncJobs( - args: ListSyncJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSyncJobsCommandOutput) => void), - cb?: (err: any, data?: ListSyncJobsCommandOutput) => void - ): Promise | void { - const command = new ListSyncJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the sync resources.

+ * @see {@link ListSyncResourcesCommand} */ - public listSyncResources( + listSyncResources( args: ListSyncResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSyncResources( + listSyncResources( args: ListSyncResourcesCommandInput, cb: (err: any, data?: ListSyncResourcesCommandOutput) => void ): void; - public listSyncResources( + listSyncResources( args: ListSyncResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSyncResourcesCommandOutput) => void ): void; - public listSyncResources( - args: ListSyncResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSyncResourcesCommandOutput) => void), - cb?: (err: any, data?: ListSyncResourcesCommandOutput) => void - ): Promise | void { - const command = new ListSyncResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all tags associated with a resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about workspaces in the current account.

+ * @see {@link ListWorkspacesCommand} */ - public listWorkspaces( + listWorkspaces( args: ListWorkspacesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWorkspaces( - args: ListWorkspacesCommandInput, - cb: (err: any, data?: ListWorkspacesCommandOutput) => void - ): void; - public listWorkspaces( + listWorkspaces(args: ListWorkspacesCommandInput, cb: (err: any, data?: ListWorkspacesCommandOutput) => void): void; + listWorkspaces( args: ListWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkspacesCommandOutput) => void ): void; - public listWorkspaces( - args: ListWorkspacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkspacesCommandOutput) => void), - cb?: (err: any, data?: ListWorkspacesCommandOutput) => void - ): Promise | void { - const command = new ListWorkspacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds tags to a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates information in a component type.

+ * @see {@link UpdateComponentTypeCommand} */ - public updateComponentType( + updateComponentType( args: UpdateComponentTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateComponentType( + updateComponentType( args: UpdateComponentTypeCommandInput, cb: (err: any, data?: UpdateComponentTypeCommandOutput) => void ): void; - public updateComponentType( + updateComponentType( args: UpdateComponentTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateComponentTypeCommandOutput) => void ): void; - public updateComponentType( - args: UpdateComponentTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateComponentTypeCommandOutput) => void), - cb?: (err: any, data?: UpdateComponentTypeCommandOutput) => void - ): Promise | void { - const command = new UpdateComponentTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an entity.

+ * @see {@link UpdateEntityCommand} */ - public updateEntity( - args: UpdateEntityCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateEntity(args: UpdateEntityCommandInput, cb: (err: any, data?: UpdateEntityCommandOutput) => void): void; - public updateEntity( + updateEntity(args: UpdateEntityCommandInput, options?: __HttpHandlerOptions): Promise; + updateEntity(args: UpdateEntityCommandInput, cb: (err: any, data?: UpdateEntityCommandOutput) => void): void; + updateEntity( args: UpdateEntityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEntityCommandOutput) => void ): void; - public updateEntity( - args: UpdateEntityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEntityCommandOutput) => void), - cb?: (err: any, data?: UpdateEntityCommandOutput) => void - ): Promise | void { - const command = new UpdateEntityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update the pricing plan.

+ * @see {@link UpdatePricingPlanCommand} */ - public updatePricingPlan( + updatePricingPlan( args: UpdatePricingPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePricingPlan( + updatePricingPlan( args: UpdatePricingPlanCommandInput, cb: (err: any, data?: UpdatePricingPlanCommandOutput) => void ): void; - public updatePricingPlan( + updatePricingPlan( args: UpdatePricingPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePricingPlanCommandOutput) => void ): void; - public updatePricingPlan( - args: UpdatePricingPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePricingPlanCommandOutput) => void), - cb?: (err: any, data?: UpdatePricingPlanCommandOutput) => void - ): Promise | void { - const command = new UpdatePricingPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a scene.

+ * @see {@link UpdateSceneCommand} */ - public updateScene(args: UpdateSceneCommandInput, options?: __HttpHandlerOptions): Promise; - public updateScene(args: UpdateSceneCommandInput, cb: (err: any, data?: UpdateSceneCommandOutput) => void): void; - public updateScene( + updateScene(args: UpdateSceneCommandInput, options?: __HttpHandlerOptions): Promise; + updateScene(args: UpdateSceneCommandInput, cb: (err: any, data?: UpdateSceneCommandOutput) => void): void; + updateScene( args: UpdateSceneCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSceneCommandOutput) => void ): void; - public updateScene( - args: UpdateSceneCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSceneCommandOutput) => void), - cb?: (err: any, data?: UpdateSceneCommandOutput) => void - ): Promise | void { - const command = new UpdateSceneCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a workspace.

+ * @see {@link UpdateWorkspaceCommand} */ - public updateWorkspace( + updateWorkspace( args: UpdateWorkspaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWorkspace( - args: UpdateWorkspaceCommandInput, - cb: (err: any, data?: UpdateWorkspaceCommandOutput) => void - ): void; - public updateWorkspace( + updateWorkspace(args: UpdateWorkspaceCommandInput, cb: (err: any, data?: UpdateWorkspaceCommandOutput) => void): void; + updateWorkspace( args: UpdateWorkspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkspaceCommandOutput) => void ): void; - public updateWorkspace( - args: UpdateWorkspaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWorkspaceCommandOutput) => void), - cb?: (err: any, data?: UpdateWorkspaceCommandOutput) => void - ): Promise | void { - const command = new UpdateWorkspaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

IoT TwinMaker is a service with which you + * can + * build operational digital twins of physical systems. IoT TwinMaker overlays measurements + * and analysis from real-world sensors, cameras, and enterprise applications so you can + * create data visualizations to monitor your physical factory, building, or industrial plant. + * You can use this real-world data to monitor operations and diagnose and repair + * errors.

+ */ +export class IoTTwinMaker extends IoTTwinMakerClient implements IoTTwinMaker {} +createAggregatedClient(commands, IoTTwinMaker); diff --git a/clients/client-ivs-realtime/src/IVSRealTime.ts b/clients/client-ivs-realtime/src/IVSRealTime.ts index 015cee550c4e..f8f6b88cf2b5 100644 --- a/clients/client-ivs-realtime/src/IVSRealTime.ts +++ b/clients/client-ivs-realtime/src/IVSRealTime.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -27,7 +28,150 @@ import { UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; import { UpdateStageCommand, UpdateStageCommandInput, UpdateStageCommandOutput } from "./commands/UpdateStageCommand"; -import { IVSRealTimeClient } from "./IVSRealTimeClient"; +import { IVSRealTimeClient, IVSRealTimeClientConfig } from "./IVSRealTimeClient"; + +const commands = { + CreateParticipantTokenCommand, + CreateStageCommand, + DeleteStageCommand, + DisconnectParticipantCommand, + GetStageCommand, + ListStagesCommand, + ListTagsForResourceCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateStageCommand, +}; + +export interface IVSRealTime { + /** + * @see {@link CreateParticipantTokenCommand} + */ + createParticipantToken( + args: CreateParticipantTokenCommandInput, + options?: __HttpHandlerOptions + ): Promise; + createParticipantToken( + args: CreateParticipantTokenCommandInput, + cb: (err: any, data?: CreateParticipantTokenCommandOutput) => void + ): void; + createParticipantToken( + args: CreateParticipantTokenCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: CreateParticipantTokenCommandOutput) => void + ): void; + + /** + * @see {@link CreateStageCommand} + */ + createStage(args: CreateStageCommandInput, options?: __HttpHandlerOptions): Promise; + createStage(args: CreateStageCommandInput, cb: (err: any, data?: CreateStageCommandOutput) => void): void; + createStage( + args: CreateStageCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: CreateStageCommandOutput) => void + ): void; + + /** + * @see {@link DeleteStageCommand} + */ + deleteStage(args: DeleteStageCommandInput, options?: __HttpHandlerOptions): Promise; + deleteStage(args: DeleteStageCommandInput, cb: (err: any, data?: DeleteStageCommandOutput) => void): void; + deleteStage( + args: DeleteStageCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DeleteStageCommandOutput) => void + ): void; + + /** + * @see {@link DisconnectParticipantCommand} + */ + disconnectParticipant( + args: DisconnectParticipantCommandInput, + options?: __HttpHandlerOptions + ): Promise; + disconnectParticipant( + args: DisconnectParticipantCommandInput, + cb: (err: any, data?: DisconnectParticipantCommandOutput) => void + ): void; + disconnectParticipant( + args: DisconnectParticipantCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DisconnectParticipantCommandOutput) => void + ): void; + + /** + * @see {@link GetStageCommand} + */ + getStage(args: GetStageCommandInput, options?: __HttpHandlerOptions): Promise; + getStage(args: GetStageCommandInput, cb: (err: any, data?: GetStageCommandOutput) => void): void; + getStage( + args: GetStageCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: GetStageCommandOutput) => void + ): void; + + /** + * @see {@link ListStagesCommand} + */ + listStages(args: ListStagesCommandInput, options?: __HttpHandlerOptions): Promise; + listStages(args: ListStagesCommandInput, cb: (err: any, data?: ListStagesCommandOutput) => void): void; + listStages( + args: ListStagesCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: ListStagesCommandOutput) => void + ): void; + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( + args: ListTagsForResourceCommandInput, + options?: __HttpHandlerOptions + ): Promise; + listTagsForResource( + args: ListTagsForResourceCommandInput, + cb: (err: any, data?: ListTagsForResourceCommandOutput) => void + ): void; + listTagsForResource( + args: ListTagsForResourceCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: ListTagsForResourceCommandOutput) => void + ): void; + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( + args: TagResourceCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: TagResourceCommandOutput) => void + ): void; + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( + args: UntagResourceCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: UntagResourceCommandOutput) => void + ): void; + + /** + * @see {@link UpdateStageCommand} + */ + updateStage(args: UpdateStageCommandInput, options?: __HttpHandlerOptions): Promise; + updateStage(args: UpdateStageCommandInput, cb: (err: any, data?: UpdateStageCommandOutput) => void): void; + updateStage( + args: UpdateStageCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: UpdateStageCommandOutput) => void + ): void; +} /** * @public @@ -118,300 +262,5 @@ import { IVSRealTimeClient } from "./IVSRealTimeClient"; * * */ -export class IVSRealTime extends IVSRealTimeClient { - /** - * @public - *

Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire. - * Tokens always are scoped to the stage for which they are created.

- *

Encryption keys are owned by Amazon IVS and never used directly by your application.

- */ - public createParticipantToken( - args: CreateParticipantTokenCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createParticipantToken( - args: CreateParticipantTokenCommandInput, - cb: (err: any, data?: CreateParticipantTokenCommandOutput) => void - ): void; - public createParticipantToken( - args: CreateParticipantTokenCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: CreateParticipantTokenCommandOutput) => void - ): void; - public createParticipantToken( - args: CreateParticipantTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateParticipantTokenCommandOutput) => void), - cb?: (err: any, data?: CreateParticipantTokenCommandOutput) => void - ): Promise | void { - const command = new CreateParticipantTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new stage (and optionally participant tokens).

- */ - public createStage(args: CreateStageCommandInput, options?: __HttpHandlerOptions): Promise; - public createStage(args: CreateStageCommandInput, cb: (err: any, data?: CreateStageCommandOutput) => void): void; - public createStage( - args: CreateStageCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: CreateStageCommandOutput) => void - ): void; - public createStage( - args: CreateStageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStageCommandOutput) => void), - cb?: (err: any, data?: CreateStageCommandOutput) => void - ): Promise | void { - const command = new CreateStageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Shuts down and deletes the specified stage (disconnecting all participants).

- */ - public deleteStage(args: DeleteStageCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteStage(args: DeleteStageCommandInput, cb: (err: any, data?: DeleteStageCommandOutput) => void): void; - public deleteStage( - args: DeleteStageCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: DeleteStageCommandOutput) => void - ): void; - public deleteStage( - args: DeleteStageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStageCommandOutput) => void), - cb?: (err: any, data?: DeleteStageCommandOutput) => void - ): Promise | void { - const command = new DeleteStageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disconnects a specified participant and revokes the participant permanently from a specified stage.

- */ - public disconnectParticipant( - args: DisconnectParticipantCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public disconnectParticipant( - args: DisconnectParticipantCommandInput, - cb: (err: any, data?: DisconnectParticipantCommandOutput) => void - ): void; - public disconnectParticipant( - args: DisconnectParticipantCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: DisconnectParticipantCommandOutput) => void - ): void; - public disconnectParticipant( - args: DisconnectParticipantCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisconnectParticipantCommandOutput) => void), - cb?: (err: any, data?: DisconnectParticipantCommandOutput) => void - ): Promise | void { - const command = new DisconnectParticipantCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information for the specified stage.

- */ - public getStage(args: GetStageCommandInput, options?: __HttpHandlerOptions): Promise; - public getStage(args: GetStageCommandInput, cb: (err: any, data?: GetStageCommandOutput) => void): void; - public getStage( - args: GetStageCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: GetStageCommandOutput) => void - ): void; - public getStage( - args: GetStageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStageCommandOutput) => void), - cb?: (err: any, data?: GetStageCommandOutput) => void - ): Promise | void { - const command = new GetStageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets summary information about all stages in your account, in the AWS region where the API request is processed.

- */ - public listStages(args: ListStagesCommandInput, options?: __HttpHandlerOptions): Promise; - public listStages(args: ListStagesCommandInput, cb: (err: any, data?: ListStagesCommandOutput) => void): void; - public listStages( - args: ListStagesCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: ListStagesCommandOutput) => void - ): void; - public listStages( - args: ListStagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStagesCommandOutput) => void), - cb?: (err: any, data?: ListStagesCommandOutput) => void - ): Promise | void { - const command = new ListStagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about AWS tags for the specified ARN.

- */ - public listTagsForResource( - args: ListTagsForResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - cb: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds or updates tags for the AWS resource with the specified ARN.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( - args: TagResourceCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: TagResourceCommandOutput) => void - ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes tags from the resource with the specified ARN.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( - args: UntagResourceCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a stage’s configuration.

- */ - public updateStage(args: UpdateStageCommandInput, options?: __HttpHandlerOptions): Promise; - public updateStage(args: UpdateStageCommandInput, cb: (err: any, data?: UpdateStageCommandOutput) => void): void; - public updateStage( - args: UpdateStageCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: UpdateStageCommandOutput) => void - ): void; - public updateStage( - args: UpdateStageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStageCommandOutput) => void), - cb?: (err: any, data?: UpdateStageCommandOutput) => void - ): Promise | void { - const command = new UpdateStageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } -} +export class IVSRealTime extends IVSRealTimeClient implements IVSRealTime {} +createAggregatedClient(commands, IVSRealTime); diff --git a/clients/client-ivs/src/Ivs.ts b/clients/client-ivs/src/Ivs.ts index a758b3b3da88..03425483de59 100644 --- a/clients/client-ivs/src/Ivs.ts +++ b/clients/client-ivs/src/Ivs.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -117,1271 +118,762 @@ import { UpdateChannelCommandInput, UpdateChannelCommandOutput, } from "./commands/UpdateChannelCommand"; -import { IvsClient } from "./IvsClient"; +import { IvsClient, IvsClientConfig } from "./IvsClient"; -/** - * @public - *

- * Introduction - *

- *

The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP - * API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both - * requests and responses, including errors.

- *

The API is an Amazon Web Services regional service. For a list of supported regions and - * Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the - * Amazon Web Services General Reference.

- *

- * - * All API request parameters and URLs are case sensitive. - * - * - *

- *

For a summary of notable documentation changes in each release, see Document - * History.

- *

- * Allowed Header Values - *

- *
    - *
  • - *

    - * - * Accept: - * application/json

    - *
  • - *
  • - *

    - * - * Accept-Encoding: - * gzip, deflate

    - *
  • - *
  • - *

    - * - * Content-Type: - * application/json

    - *
  • - *
- *

- * Resources - *

- *

The following resources contain information about your IVS live stream (see Getting Started with - * Amazon IVS):

- *
    - *
  • - *

    - * Channel — Stores configuration data related to your live stream. You first create a - * channel and then use the channel’s stream key to start your live stream. See the Channel - * endpoints for more information.

    - *
  • - *
  • - *

    - * Stream key — An identifier assigned by Amazon IVS when you create a channel, which is - * then used to authorize streaming. See the StreamKey endpoints for more information. - * - * Treat the stream key like a secret, since it allows - * anyone to stream to the channel. - * - *

    - *
  • - *
  • - *

    - * Playback key pair — Video playback may be restricted using playback-authorization - * tokens, which use public-key encryption. A playback key pair is the public-private pair of - * keys used to sign and validate the playback-authorization token. See the PlaybackKeyPair - * endpoints for more information.

    - *
  • - *
  • - *

    - * Recording configuration — Stores configuration related to recording a live stream and - * where to store the recorded content. Multiple channels can reference the same recording - * configuration. See the Recording Configuration endpoints for more information.

    - *
  • - *
- *

- * Tagging - *

- *

A tag is a metadata label that you assign to an Amazon Web Services - * resource. A tag comprises a key and a value, both - * set by you. For example, you might set a tag as topic:nature to label a - * particular video category. See Tagging Amazon Web Services Resources for - * more information, including restrictions that apply to tags and "Tag naming limits and - * requirements"; Amazon IVS has no service-specific constraints beyond what is documented - * there.

- *

Tags can help you identify and organize your Amazon Web Services resources. For example, - * you can use the same tag for different resources to indicate that they are related. You can - * also use tags to manage access (see Access Tags).

- *

The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following - * resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording - * Configurations.

- *

At most 50 tags can be applied to a resource.

- *

- * Authentication versus Authorization - *

- *

Note the differences between these concepts:

- *
    - *
  • - *

    - * Authentication is about verifying identity. You need to be - * authenticated to sign Amazon IVS API requests.

    - *
  • - *
  • - *

    - * Authorization is about granting permissions. Your IAM roles need - * to have permissions for Amazon IVS API requests. In addition, authorization is needed to - * view Amazon - * IVS private channels. (Private channels are channels that are enabled for - * "playback authorization.")

    - *
  • - *
- *

- * Authentication - *

- *

All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services - * Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying - * API calls for you. However, if your application calls the Amazon IVS API directly, it’s your - * responsibility to sign the requests.

- *

You generate a signature using valid Amazon Web Services credentials that have permission - * to perform the requested action. For example, you must sign PutMetadata requests with a - * signature generated from a user account that has the ivs:PutMetadata - * permission.

- *

For more information:

- * - *

- * Amazon Resource Names (ARNs) - *

- *

ARNs uniquely identify AWS resources. An ARN is required when you need to specify a - * resource unambiguously across all of AWS, such as in IAM policies and API calls. For more - * information, see Amazon Resource Names in the AWS General - * Reference.

- *

- * Channel Endpoints - *

- *
    - *
  • - *

    - * CreateChannel — Creates a new channel and an associated stream - * key to start streaming.

    - *
  • - *
  • - *

    - * GetChannel — Gets the channel configuration for the specified - * channel ARN.

    - *
  • - *
  • - *

    - * BatchGetChannel — Performs GetChannel on - * multiple ARNs simultaneously.

    - *
  • - *
  • - *

    - * ListChannels — Gets summary information about all channels in - * your account, in the Amazon Web Services region where the API request is processed. This - * list can be filtered to match a specified name or recording-configuration ARN. Filters are - * mutually exclusive and cannot be used together. If you try to use both filters, you will - * get an error (409 Conflict Exception).

    - *
  • - *
  • - *

    - * UpdateChannel — Updates a channel's configuration. This does - * not affect an ongoing stream of this channel. You must stop and restart the stream for the - * changes to take effect.

    - *
  • - *
  • - *

    - * DeleteChannel — Deletes the specified channel.

    - *
  • - *
- *

- * StreamKey Endpoints - *

- *
    - *
  • - *

    - * CreateStreamKey — Creates a stream key, used to initiate a - * stream, for the specified channel ARN.

    - *
  • - *
  • - *

    - * GetStreamKey — Gets stream key information for the specified - * ARN.

    - *
  • - *
  • - *

    - * BatchGetStreamKey — Performs GetStreamKey on - * multiple ARNs simultaneously.

    - *
  • - *
  • - *

    - * ListStreamKeys — Gets summary information about stream keys - * for the specified channel.

    - *
  • - *
  • - *

    - * DeleteStreamKey — Deletes the stream key for the specified - * ARN, so it can no longer be used to stream.

    - *
  • - *
- *

- * Stream Endpoints - *

- *
    - *
  • - *

    - * GetStream — Gets information about the active (live) stream on - * a specified channel.

    - *
  • - *
  • - *

    - * GetStreamSession — Gets metadata on a specified stream.

    - *
  • - *
  • - *

    - * ListStreams — Gets summary information about live streams in - * your account, in the Amazon Web Services region where the API request is processed.

    - *
  • - *
  • - *

    - * ListStreamSessions — Gets a summary of current and previous - * streams for a specified channel in your account, in the AWS region where the API request - * is processed.

    - *
  • - *
  • - *

    - * StopStream — Disconnects the incoming RTMPS stream for the - * specified channel. Can be used in conjunction with DeleteStreamKey to - * prevent further streaming to a channel.

    - *
  • - *
  • - *

    - * PutMetadata — Inserts metadata into the active stream of the - * specified channel. At most 5 requests per second per channel are allowed, each with a - * maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching - * your data into a single PutMetadata call.) At most 155 requests per second per account are - * allowed.

    - *
  • - *
- *

- * PlaybackKeyPair Endpoints - *

- *

For more information, see Setting Up Private Channels in the - * Amazon IVS User Guide.

- *
    - *
  • - *

    - * ImportPlaybackKeyPair — Imports the public portion of a new - * key pair and returns its arn and fingerprint. The - * privateKey can then be used to generate viewer authorization tokens, to - * grant viewers access to private channels (channels enabled for playback - * authorization).

    - *
  • - *
  • - *

    - * GetPlaybackKeyPair — Gets a specified playback authorization - * key pair and returns the arn and fingerprint. The - * privateKey held by the caller can be used to generate viewer authorization - * tokens, to grant viewers access to private channels.

    - *
  • - *
  • - *

    - * ListPlaybackKeyPairs — Gets summary information about playback - * key pairs.

    - *
  • - *
  • - *

    - * DeletePlaybackKeyPair — Deletes a specified authorization key - * pair. This invalidates future viewer tokens generated using the key pair’s - * privateKey.

    - *
  • - *
- *

- * RecordingConfiguration Endpoints - *

- *
    - *
  • - *

    - * CreateRecordingConfiguration — Creates a new recording - * configuration, used to enable recording to Amazon S3.

    - *
  • - *
  • - *

    - * GetRecordingConfiguration — Gets the recording-configuration - * metadata for the specified ARN.

    - *
  • - *
  • - *

    - * ListRecordingConfigurations — Gets summary information about - * all recording configurations in your account, in the Amazon Web Services region where the - * API request is processed.

    - *
  • - *
  • - *

    - * DeleteRecordingConfiguration — Deletes the recording - * configuration for the specified ARN.

    - *
  • - *
- *

- * Amazon Web Services Tags Endpoints - *

- *
    - *
  • - *

    - * TagResource — Adds or updates tags for the Amazon Web Services - * resource with the specified ARN.

    - *
  • - *
  • - *

    - * UntagResource — Removes tags from the resource with the - * specified ARN.

    - *
  • - *
  • - *

    - * ListTagsForResource — Gets information about Amazon Web Services tags for the specified ARN.

    - *
  • - *
- */ -export class Ivs extends IvsClient { +const commands = { + BatchGetChannelCommand, + BatchGetStreamKeyCommand, + CreateChannelCommand, + CreateRecordingConfigurationCommand, + CreateStreamKeyCommand, + DeleteChannelCommand, + DeletePlaybackKeyPairCommand, + DeleteRecordingConfigurationCommand, + DeleteStreamKeyCommand, + GetChannelCommand, + GetPlaybackKeyPairCommand, + GetRecordingConfigurationCommand, + GetStreamCommand, + GetStreamKeyCommand, + GetStreamSessionCommand, + ImportPlaybackKeyPairCommand, + ListChannelsCommand, + ListPlaybackKeyPairsCommand, + ListRecordingConfigurationsCommand, + ListStreamKeysCommand, + ListStreamsCommand, + ListStreamSessionsCommand, + ListTagsForResourceCommand, + PutMetadataCommand, + StopStreamCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateChannelCommand, +}; + +export interface Ivs { /** - * @public - *

Performs GetChannel on multiple ARNs simultaneously.

+ * @see {@link BatchGetChannelCommand} */ - public batchGetChannel( + batchGetChannel( args: BatchGetChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetChannel( - args: BatchGetChannelCommandInput, - cb: (err: any, data?: BatchGetChannelCommandOutput) => void - ): void; - public batchGetChannel( + batchGetChannel(args: BatchGetChannelCommandInput, cb: (err: any, data?: BatchGetChannelCommandOutput) => void): void; + batchGetChannel( args: BatchGetChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetChannelCommandOutput) => void ): void; - public batchGetChannel( - args: BatchGetChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetChannelCommandOutput) => void), - cb?: (err: any, data?: BatchGetChannelCommandOutput) => void - ): Promise | void { - const command = new BatchGetChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Performs GetStreamKey on multiple ARNs simultaneously.

+ * @see {@link BatchGetStreamKeyCommand} */ - public batchGetStreamKey( + batchGetStreamKey( args: BatchGetStreamKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetStreamKey( + batchGetStreamKey( args: BatchGetStreamKeyCommandInput, cb: (err: any, data?: BatchGetStreamKeyCommandOutput) => void ): void; - public batchGetStreamKey( + batchGetStreamKey( args: BatchGetStreamKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetStreamKeyCommandOutput) => void ): void; - public batchGetStreamKey( - args: BatchGetStreamKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetStreamKeyCommandOutput) => void), - cb?: (err: any, data?: BatchGetStreamKeyCommandOutput) => void - ): Promise | void { - const command = new BatchGetStreamKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new channel and an associated stream key to start streaming.

+ * @see {@link CreateChannelCommand} */ - public createChannel( - args: CreateChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createChannel( - args: CreateChannelCommandInput, - cb: (err: any, data?: CreateChannelCommandOutput) => void - ): void; - public createChannel( + createChannel(args: CreateChannelCommandInput, options?: __HttpHandlerOptions): Promise; + createChannel(args: CreateChannelCommandInput, cb: (err: any, data?: CreateChannelCommandOutput) => void): void; + createChannel( args: CreateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelCommandOutput) => void ): void; - public createChannel( - args: CreateChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateChannelCommandOutput) => void), - cb?: (err: any, data?: CreateChannelCommandOutput) => void - ): Promise | void { - const command = new CreateChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new recording configuration, used to enable recording to Amazon S3.

- *

- * Known issue: In the us-east-1 region, if you use the - * Amazon Web Services CLI to create a recording configuration, it returns success even if the - * S3 bucket is in a different region. In this case, the state of the recording - * configuration is CREATE_FAILED (instead of ACTIVE). (In other - * regions, the CLI correctly returns failure if the bucket is in a different region.)

- *

- * Workaround: Ensure that your S3 bucket is in the same - * region as the recording configuration. If you create a recording configuration in a different - * region as your S3 bucket, delete that recording configuration and create a new one with an S3 - * bucket from the correct region.

+ * @see {@link CreateRecordingConfigurationCommand} */ - public createRecordingConfiguration( + createRecordingConfiguration( args: CreateRecordingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRecordingConfiguration( + createRecordingConfiguration( args: CreateRecordingConfigurationCommandInput, cb: (err: any, data?: CreateRecordingConfigurationCommandOutput) => void ): void; - public createRecordingConfiguration( + createRecordingConfiguration( args: CreateRecordingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRecordingConfigurationCommandOutput) => void ): void; - public createRecordingConfiguration( - args: CreateRecordingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRecordingConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateRecordingConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateRecordingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a stream key, used to initiate a stream, for the specified channel ARN.

- *

Note that CreateChannel creates a stream key. If you subsequently use - * CreateStreamKey on the same channel, it will fail because a stream key already exists and - * there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.

+ * @see {@link CreateStreamKeyCommand} */ - public createStreamKey( + createStreamKey( args: CreateStreamKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createStreamKey( - args: CreateStreamKeyCommandInput, - cb: (err: any, data?: CreateStreamKeyCommandOutput) => void - ): void; - public createStreamKey( + createStreamKey(args: CreateStreamKeyCommandInput, cb: (err: any, data?: CreateStreamKeyCommandOutput) => void): void; + createStreamKey( args: CreateStreamKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStreamKeyCommandOutput) => void ): void; - public createStreamKey( - args: CreateStreamKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStreamKeyCommandOutput) => void), - cb?: (err: any, data?: CreateStreamKeyCommandOutput) => void - ): Promise | void { - const command = new CreateStreamKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified channel and its associated stream keys.

- *

If you try to delete a live channel, you will get an error (409 ConflictException). To - * delete a channel that is live, call StopStream, wait for the Amazon - * EventBridge "Stream End" event (to verify that the stream's state is no longer Live), then - * call DeleteChannel. (See Using EventBridge with Amazon IVS.)

+ * @see {@link DeleteChannelCommand} */ - public deleteChannel( - args: DeleteChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteChannel( - args: DeleteChannelCommandInput, - cb: (err: any, data?: DeleteChannelCommandOutput) => void - ): void; - public deleteChannel( + deleteChannel(args: DeleteChannelCommandInput, options?: __HttpHandlerOptions): Promise; + deleteChannel(args: DeleteChannelCommandInput, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void; + deleteChannel( args: DeleteChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelCommandOutput) => void ): void; - public deleteChannel( - args: DeleteChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteChannelCommandOutput) => void), - cb?: (err: any, data?: DeleteChannelCommandOutput) => void - ): Promise | void { - const command = new DeleteChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a specified authorization key pair. This invalidates future viewer tokens - * generated using the key pair’s privateKey. For more information, see Setting Up Private - * Channels in the Amazon IVS User Guide.

+ * @see {@link DeletePlaybackKeyPairCommand} */ - public deletePlaybackKeyPair( + deletePlaybackKeyPair( args: DeletePlaybackKeyPairCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePlaybackKeyPair( + deletePlaybackKeyPair( args: DeletePlaybackKeyPairCommandInput, cb: (err: any, data?: DeletePlaybackKeyPairCommandOutput) => void ): void; - public deletePlaybackKeyPair( + deletePlaybackKeyPair( args: DeletePlaybackKeyPairCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePlaybackKeyPairCommandOutput) => void ): void; - public deletePlaybackKeyPair( - args: DeletePlaybackKeyPairCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePlaybackKeyPairCommandOutput) => void), - cb?: (err: any, data?: DeletePlaybackKeyPairCommandOutput) => void - ): Promise | void { - const command = new DeletePlaybackKeyPairCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the recording configuration for the specified ARN.

- *

If you try to delete a recording configuration that is associated with a channel, you will - * get an error (409 ConflictException). To avoid this, for all channels that reference the - * recording configuration, first use UpdateChannel to set the - * recordingConfigurationArn field to an empty string, then use - * DeleteRecordingConfiguration.

+ * @see {@link DeleteRecordingConfigurationCommand} */ - public deleteRecordingConfiguration( + deleteRecordingConfiguration( args: DeleteRecordingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRecordingConfiguration( + deleteRecordingConfiguration( args: DeleteRecordingConfigurationCommandInput, cb: (err: any, data?: DeleteRecordingConfigurationCommandOutput) => void ): void; - public deleteRecordingConfiguration( + deleteRecordingConfiguration( args: DeleteRecordingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRecordingConfigurationCommandOutput) => void ): void; - public deleteRecordingConfiguration( - args: DeleteRecordingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRecordingConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteRecordingConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteRecordingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the stream key for the specified ARN, so it can no longer be used to - * stream.

+ * @see {@link DeleteStreamKeyCommand} */ - public deleteStreamKey( + deleteStreamKey( args: DeleteStreamKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteStreamKey( - args: DeleteStreamKeyCommandInput, - cb: (err: any, data?: DeleteStreamKeyCommandOutput) => void - ): void; - public deleteStreamKey( + deleteStreamKey(args: DeleteStreamKeyCommandInput, cb: (err: any, data?: DeleteStreamKeyCommandOutput) => void): void; + deleteStreamKey( args: DeleteStreamKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStreamKeyCommandOutput) => void ): void; - public deleteStreamKey( - args: DeleteStreamKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStreamKeyCommandOutput) => void), - cb?: (err: any, data?: DeleteStreamKeyCommandOutput) => void - ): Promise | void { - const command = new DeleteStreamKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.

+ * @see {@link GetChannelCommand} */ - public getChannel(args: GetChannelCommandInput, options?: __HttpHandlerOptions): Promise; - public getChannel(args: GetChannelCommandInput, cb: (err: any, data?: GetChannelCommandOutput) => void): void; - public getChannel( + getChannel(args: GetChannelCommandInput, options?: __HttpHandlerOptions): Promise; + getChannel(args: GetChannelCommandInput, cb: (err: any, data?: GetChannelCommandOutput) => void): void; + getChannel( args: GetChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelCommandOutput) => void ): void; - public getChannel( - args: GetChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetChannelCommandOutput) => void), - cb?: (err: any, data?: GetChannelCommandOutput) => void - ): Promise | void { - const command = new GetChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a specified playback authorization key pair and returns the arn and - * fingerprint. The privateKey held by the caller can be used to - * generate viewer authorization tokens, to grant viewers access to private channels. For more - * information, see Setting Up Private Channels in the Amazon IVS User - * Guide.

+ * @see {@link GetPlaybackKeyPairCommand} */ - public getPlaybackKeyPair( + getPlaybackKeyPair( args: GetPlaybackKeyPairCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPlaybackKeyPair( + getPlaybackKeyPair( args: GetPlaybackKeyPairCommandInput, cb: (err: any, data?: GetPlaybackKeyPairCommandOutput) => void ): void; - public getPlaybackKeyPair( + getPlaybackKeyPair( args: GetPlaybackKeyPairCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPlaybackKeyPairCommandOutput) => void ): void; - public getPlaybackKeyPair( - args: GetPlaybackKeyPairCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPlaybackKeyPairCommandOutput) => void), - cb?: (err: any, data?: GetPlaybackKeyPairCommandOutput) => void - ): Promise | void { - const command = new GetPlaybackKeyPairCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the recording configuration for the specified ARN.

+ * @see {@link GetRecordingConfigurationCommand} */ - public getRecordingConfiguration( + getRecordingConfiguration( args: GetRecordingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRecordingConfiguration( + getRecordingConfiguration( args: GetRecordingConfigurationCommandInput, cb: (err: any, data?: GetRecordingConfigurationCommandOutput) => void ): void; - public getRecordingConfiguration( + getRecordingConfiguration( args: GetRecordingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRecordingConfigurationCommandOutput) => void ): void; - public getRecordingConfiguration( - args: GetRecordingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRecordingConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetRecordingConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetRecordingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about the active (live) stream on a specified channel.

+ * @see {@link GetStreamCommand} */ - public getStream(args: GetStreamCommandInput, options?: __HttpHandlerOptions): Promise; - public getStream(args: GetStreamCommandInput, cb: (err: any, data?: GetStreamCommandOutput) => void): void; - public getStream( + getStream(args: GetStreamCommandInput, options?: __HttpHandlerOptions): Promise; + getStream(args: GetStreamCommandInput, cb: (err: any, data?: GetStreamCommandOutput) => void): void; + getStream( args: GetStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStreamCommandOutput) => void ): void; - public getStream( - args: GetStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStreamCommandOutput) => void), - cb?: (err: any, data?: GetStreamCommandOutput) => void - ): Promise | void { - const command = new GetStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets stream-key information for a specified ARN.

+ * @see {@link GetStreamKeyCommand} */ - public getStreamKey( - args: GetStreamKeyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getStreamKey(args: GetStreamKeyCommandInput, cb: (err: any, data?: GetStreamKeyCommandOutput) => void): void; - public getStreamKey( + getStreamKey(args: GetStreamKeyCommandInput, options?: __HttpHandlerOptions): Promise; + getStreamKey(args: GetStreamKeyCommandInput, cb: (err: any, data?: GetStreamKeyCommandOutput) => void): void; + getStreamKey( args: GetStreamKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStreamKeyCommandOutput) => void ): void; - public getStreamKey( - args: GetStreamKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStreamKeyCommandOutput) => void), - cb?: (err: any, data?: GetStreamKeyCommandOutput) => void - ): Promise | void { - const command = new GetStreamKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets metadata on a specified stream.

+ * @see {@link GetStreamSessionCommand} */ - public getStreamSession( + getStreamSession( args: GetStreamSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getStreamSession( + getStreamSession( args: GetStreamSessionCommandInput, cb: (err: any, data?: GetStreamSessionCommandOutput) => void ): void; - public getStreamSession( + getStreamSession( args: GetStreamSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStreamSessionCommandOutput) => void ): void; - public getStreamSession( - args: GetStreamSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStreamSessionCommandOutput) => void), - cb?: (err: any, data?: GetStreamSessionCommandOutput) => void - ): Promise | void { - const command = new GetStreamSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Imports the public portion of a new key pair and returns its arn and - * fingerprint. The privateKey can then be used to generate viewer - * authorization tokens, to grant viewers access to private channels. For more information, see - * Setting Up - * Private Channels in the Amazon IVS User Guide.

+ * @see {@link ImportPlaybackKeyPairCommand} */ - public importPlaybackKeyPair( + importPlaybackKeyPair( args: ImportPlaybackKeyPairCommandInput, options?: __HttpHandlerOptions ): Promise; - public importPlaybackKeyPair( + importPlaybackKeyPair( args: ImportPlaybackKeyPairCommandInput, cb: (err: any, data?: ImportPlaybackKeyPairCommandOutput) => void ): void; - public importPlaybackKeyPair( + importPlaybackKeyPair( args: ImportPlaybackKeyPairCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportPlaybackKeyPairCommandOutput) => void ): void; - public importPlaybackKeyPair( - args: ImportPlaybackKeyPairCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportPlaybackKeyPairCommandOutput) => void), - cb?: (err: any, data?: ImportPlaybackKeyPairCommandOutput) => void - ): Promise | void { - const command = new ImportPlaybackKeyPairCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets summary information about all channels in your account, in the Amazon Web Services - * region where the API request is processed. This list can be filtered to match a specified name - * or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If - * you try to use both filters, you will get an error (409 ConflictException).

+ * @see {@link ListChannelsCommand} */ - public listChannels( - args: ListChannelsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void; - public listChannels( + listChannels(args: ListChannelsCommandInput, options?: __HttpHandlerOptions): Promise; + listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void; + listChannels( args: ListChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsCommandOutput) => void ): void; - public listChannels( - args: ListChannelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListChannelsCommandOutput) => void), - cb?: (err: any, data?: ListChannelsCommandOutput) => void - ): Promise | void { - const command = new ListChannelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets summary information about playback key pairs. For more information, see Setting Up Private - * Channels in the Amazon IVS User Guide.

+ * @see {@link ListPlaybackKeyPairsCommand} */ - public listPlaybackKeyPairs( + listPlaybackKeyPairs( args: ListPlaybackKeyPairsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPlaybackKeyPairs( + listPlaybackKeyPairs( args: ListPlaybackKeyPairsCommandInput, cb: (err: any, data?: ListPlaybackKeyPairsCommandOutput) => void ): void; - public listPlaybackKeyPairs( + listPlaybackKeyPairs( args: ListPlaybackKeyPairsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPlaybackKeyPairsCommandOutput) => void ): void; - public listPlaybackKeyPairs( - args: ListPlaybackKeyPairsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPlaybackKeyPairsCommandOutput) => void), - cb?: (err: any, data?: ListPlaybackKeyPairsCommandOutput) => void - ): Promise | void { - const command = new ListPlaybackKeyPairsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets summary information about all recording configurations in your account, in the - * Amazon Web Services region where the API request is processed.

+ * @see {@link ListRecordingConfigurationsCommand} */ - public listRecordingConfigurations( + listRecordingConfigurations( args: ListRecordingConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRecordingConfigurations( + listRecordingConfigurations( args: ListRecordingConfigurationsCommandInput, cb: (err: any, data?: ListRecordingConfigurationsCommandOutput) => void ): void; - public listRecordingConfigurations( + listRecordingConfigurations( args: ListRecordingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecordingConfigurationsCommandOutput) => void ): void; - public listRecordingConfigurations( - args: ListRecordingConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRecordingConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListRecordingConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListRecordingConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets summary information about stream keys for the specified channel.

+ * @see {@link ListStreamKeysCommand} */ - public listStreamKeys( + listStreamKeys( args: ListStreamKeysCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStreamKeys( - args: ListStreamKeysCommandInput, - cb: (err: any, data?: ListStreamKeysCommandOutput) => void - ): void; - public listStreamKeys( + listStreamKeys(args: ListStreamKeysCommandInput, cb: (err: any, data?: ListStreamKeysCommandOutput) => void): void; + listStreamKeys( args: ListStreamKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamKeysCommandOutput) => void ): void; - public listStreamKeys( - args: ListStreamKeysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStreamKeysCommandOutput) => void), - cb?: (err: any, data?: ListStreamKeysCommandOutput) => void - ): Promise | void { - const command = new ListStreamKeysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets summary information about live streams in your account, in the Amazon Web Services - * region where the API request is processed.

+ * @see {@link ListStreamsCommand} */ - public listStreams(args: ListStreamsCommandInput, options?: __HttpHandlerOptions): Promise; - public listStreams(args: ListStreamsCommandInput, cb: (err: any, data?: ListStreamsCommandOutput) => void): void; - public listStreams( + listStreams(args: ListStreamsCommandInput, options?: __HttpHandlerOptions): Promise; + listStreams(args: ListStreamsCommandInput, cb: (err: any, data?: ListStreamsCommandOutput) => void): void; + listStreams( args: ListStreamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamsCommandOutput) => void ): void; - public listStreams( - args: ListStreamsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStreamsCommandOutput) => void), - cb?: (err: any, data?: ListStreamsCommandOutput) => void - ): Promise | void { - const command = new ListStreamsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a summary of current and previous streams for a specified channel in your account, in - * the AWS region where the API request is processed.

+ * @see {@link ListStreamSessionsCommand} */ - public listStreamSessions( + listStreamSessions( args: ListStreamSessionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStreamSessions( + listStreamSessions( args: ListStreamSessionsCommandInput, cb: (err: any, data?: ListStreamSessionsCommandOutput) => void ): void; - public listStreamSessions( + listStreamSessions( args: ListStreamSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamSessionsCommandOutput) => void ): void; - public listStreamSessions( - args: ListStreamSessionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStreamSessionsCommandOutput) => void), - cb?: (err: any, data?: ListStreamSessionsCommandOutput) => void - ): Promise | void { - const command = new ListStreamSessionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about Amazon Web Services tags for the specified ARN.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Inserts metadata into the active stream of the specified channel. At most 5 requests per - * second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient - * for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 - * requests per second per account are allowed. Also see Embedding Metadata within a Video Stream in - * the Amazon IVS User Guide.

+ * @see {@link PutMetadataCommand} */ - public putMetadata(args: PutMetadataCommandInput, options?: __HttpHandlerOptions): Promise; - public putMetadata(args: PutMetadataCommandInput, cb: (err: any, data?: PutMetadataCommandOutput) => void): void; - public putMetadata( + putMetadata(args: PutMetadataCommandInput, options?: __HttpHandlerOptions): Promise; + putMetadata(args: PutMetadataCommandInput, cb: (err: any, data?: PutMetadataCommandOutput) => void): void; + putMetadata( args: PutMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMetadataCommandOutput) => void ): void; - public putMetadata( - args: PutMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutMetadataCommandOutput) => void), - cb?: (err: any, data?: PutMetadataCommandOutput) => void - ): Promise | void { - const command = new PutMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disconnects the incoming RTMPS stream for the specified channel. Can be used in - * conjunction with DeleteStreamKey to prevent further streaming to a - * channel.

- * - *

Many streaming client-software libraries automatically reconnect a dropped RTMPS - * session, so to stop the stream permanently, you may want to first revoke the - * streamKey attached to the channel.

- *
+ * @see {@link StopStreamCommand} */ - public stopStream(args: StopStreamCommandInput, options?: __HttpHandlerOptions): Promise; - public stopStream(args: StopStreamCommandInput, cb: (err: any, data?: StopStreamCommandOutput) => void): void; - public stopStream( + stopStream(args: StopStreamCommandInput, options?: __HttpHandlerOptions): Promise; + stopStream(args: StopStreamCommandInput, cb: (err: any, data?: StopStreamCommandOutput) => void): void; + stopStream( args: StopStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopStreamCommandOutput) => void ): void; - public stopStream( - args: StopStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopStreamCommandOutput) => void), - cb?: (err: any, data?: StopStreamCommandOutput) => void - ): Promise | void { - const command = new StopStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or updates tags for the Amazon Web Services resource with the specified ARN.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from the resource with the specified ARN.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a channel's configuration. This does not affect an ongoing stream of this channel. - * You must stop and restart the stream for the changes to take effect.

+ * @see {@link UpdateChannelCommand} */ - public updateChannel( - args: UpdateChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateChannel( - args: UpdateChannelCommandInput, - cb: (err: any, data?: UpdateChannelCommandOutput) => void - ): void; - public updateChannel( + updateChannel(args: UpdateChannelCommandInput, options?: __HttpHandlerOptions): Promise; + updateChannel(args: UpdateChannelCommandInput, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void; + updateChannel( args: UpdateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelCommandOutput) => void ): void; - public updateChannel( - args: UpdateChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateChannelCommandOutput) => void), - cb?: (err: any, data?: UpdateChannelCommandOutput) => void - ): Promise | void { - const command = new UpdateChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

+ * Introduction + *

+ *

The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP + * API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both + * requests and responses, including errors.

+ *

The API is an Amazon Web Services regional service. For a list of supported regions and + * Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the + * Amazon Web Services General Reference.

+ *

+ * + * All API request parameters and URLs are case sensitive. + * + * + *

+ *

For a summary of notable documentation changes in each release, see Document + * History.

+ *

+ * Allowed Header Values + *

+ *
    + *
  • + *

    + * + * Accept: + * application/json

    + *
  • + *
  • + *

    + * + * Accept-Encoding: + * gzip, deflate

    + *
  • + *
  • + *

    + * + * Content-Type: + * application/json

    + *
  • + *
+ *

+ * Resources + *

+ *

The following resources contain information about your IVS live stream (see Getting Started with + * Amazon IVS):

+ *
    + *
  • + *

    + * Channel — Stores configuration data related to your live stream. You first create a + * channel and then use the channel’s stream key to start your live stream. See the Channel + * endpoints for more information.

    + *
  • + *
  • + *

    + * Stream key — An identifier assigned by Amazon IVS when you create a channel, which is + * then used to authorize streaming. See the StreamKey endpoints for more information. + * + * Treat the stream key like a secret, since it allows + * anyone to stream to the channel. + * + *

    + *
  • + *
  • + *

    + * Playback key pair — Video playback may be restricted using playback-authorization + * tokens, which use public-key encryption. A playback key pair is the public-private pair of + * keys used to sign and validate the playback-authorization token. See the PlaybackKeyPair + * endpoints for more information.

    + *
  • + *
  • + *

    + * Recording configuration — Stores configuration related to recording a live stream and + * where to store the recorded content. Multiple channels can reference the same recording + * configuration. See the Recording Configuration endpoints for more information.

    + *
  • + *
+ *

+ * Tagging + *

+ *

A tag is a metadata label that you assign to an Amazon Web Services + * resource. A tag comprises a key and a value, both + * set by you. For example, you might set a tag as topic:nature to label a + * particular video category. See Tagging Amazon Web Services Resources for + * more information, including restrictions that apply to tags and "Tag naming limits and + * requirements"; Amazon IVS has no service-specific constraints beyond what is documented + * there.

+ *

Tags can help you identify and organize your Amazon Web Services resources. For example, + * you can use the same tag for different resources to indicate that they are related. You can + * also use tags to manage access (see Access Tags).

+ *

The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following + * resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording + * Configurations.

+ *

At most 50 tags can be applied to a resource.

+ *

+ * Authentication versus Authorization + *

+ *

Note the differences between these concepts:

+ *
    + *
  • + *

    + * Authentication is about verifying identity. You need to be + * authenticated to sign Amazon IVS API requests.

    + *
  • + *
  • + *

    + * Authorization is about granting permissions. Your IAM roles need + * to have permissions for Amazon IVS API requests. In addition, authorization is needed to + * view Amazon + * IVS private channels. (Private channels are channels that are enabled for + * "playback authorization.")

    + *
  • + *
+ *

+ * Authentication + *

+ *

All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services + * Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying + * API calls for you. However, if your application calls the Amazon IVS API directly, it’s your + * responsibility to sign the requests.

+ *

You generate a signature using valid Amazon Web Services credentials that have permission + * to perform the requested action. For example, you must sign PutMetadata requests with a + * signature generated from a user account that has the ivs:PutMetadata + * permission.

+ *

For more information:

+ * + *

+ * Amazon Resource Names (ARNs) + *

+ *

ARNs uniquely identify AWS resources. An ARN is required when you need to specify a + * resource unambiguously across all of AWS, such as in IAM policies and API calls. For more + * information, see Amazon Resource Names in the AWS General + * Reference.

+ *

+ * Channel Endpoints + *

+ *
    + *
  • + *

    + * CreateChannel — Creates a new channel and an associated stream + * key to start streaming.

    + *
  • + *
  • + *

    + * GetChannel — Gets the channel configuration for the specified + * channel ARN.

    + *
  • + *
  • + *

    + * BatchGetChannel — Performs GetChannel on + * multiple ARNs simultaneously.

    + *
  • + *
  • + *

    + * ListChannels — Gets summary information about all channels in + * your account, in the Amazon Web Services region where the API request is processed. This + * list can be filtered to match a specified name or recording-configuration ARN. Filters are + * mutually exclusive and cannot be used together. If you try to use both filters, you will + * get an error (409 Conflict Exception).

    + *
  • + *
  • + *

    + * UpdateChannel — Updates a channel's configuration. This does + * not affect an ongoing stream of this channel. You must stop and restart the stream for the + * changes to take effect.

    + *
  • + *
  • + *

    + * DeleteChannel — Deletes the specified channel.

    + *
  • + *
+ *

+ * StreamKey Endpoints + *

+ *
    + *
  • + *

    + * CreateStreamKey — Creates a stream key, used to initiate a + * stream, for the specified channel ARN.

    + *
  • + *
  • + *

    + * GetStreamKey — Gets stream key information for the specified + * ARN.

    + *
  • + *
  • + *

    + * BatchGetStreamKey — Performs GetStreamKey on + * multiple ARNs simultaneously.

    + *
  • + *
  • + *

    + * ListStreamKeys — Gets summary information about stream keys + * for the specified channel.

    + *
  • + *
  • + *

    + * DeleteStreamKey — Deletes the stream key for the specified + * ARN, so it can no longer be used to stream.

    + *
  • + *
+ *

+ * Stream Endpoints + *

+ *
    + *
  • + *

    + * GetStream — Gets information about the active (live) stream on + * a specified channel.

    + *
  • + *
  • + *

    + * GetStreamSession — Gets metadata on a specified stream.

    + *
  • + *
  • + *

    + * ListStreams — Gets summary information about live streams in + * your account, in the Amazon Web Services region where the API request is processed.

    + *
  • + *
  • + *

    + * ListStreamSessions — Gets a summary of current and previous + * streams for a specified channel in your account, in the AWS region where the API request + * is processed.

    + *
  • + *
  • + *

    + * StopStream — Disconnects the incoming RTMPS stream for the + * specified channel. Can be used in conjunction with DeleteStreamKey to + * prevent further streaming to a channel.

    + *
  • + *
  • + *

    + * PutMetadata — Inserts metadata into the active stream of the + * specified channel. At most 5 requests per second per channel are allowed, each with a + * maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching + * your data into a single PutMetadata call.) At most 155 requests per second per account are + * allowed.

    + *
  • + *
+ *

+ * PlaybackKeyPair Endpoints + *

+ *

For more information, see Setting Up Private Channels in the + * Amazon IVS User Guide.

+ *
    + *
  • + *

    + * ImportPlaybackKeyPair — Imports the public portion of a new + * key pair and returns its arn and fingerprint. The + * privateKey can then be used to generate viewer authorization tokens, to + * grant viewers access to private channels (channels enabled for playback + * authorization).

    + *
  • + *
  • + *

    + * GetPlaybackKeyPair — Gets a specified playback authorization + * key pair and returns the arn and fingerprint. The + * privateKey held by the caller can be used to generate viewer authorization + * tokens, to grant viewers access to private channels.

    + *
  • + *
  • + *

    + * ListPlaybackKeyPairs — Gets summary information about playback + * key pairs.

    + *
  • + *
  • + *

    + * DeletePlaybackKeyPair — Deletes a specified authorization key + * pair. This invalidates future viewer tokens generated using the key pair’s + * privateKey.

    + *
  • + *
+ *

+ * RecordingConfiguration Endpoints + *

+ *
    + *
  • + *

    + * CreateRecordingConfiguration — Creates a new recording + * configuration, used to enable recording to Amazon S3.

    + *
  • + *
  • + *

    + * GetRecordingConfiguration — Gets the recording-configuration + * metadata for the specified ARN.

    + *
  • + *
  • + *

    + * ListRecordingConfigurations — Gets summary information about + * all recording configurations in your account, in the Amazon Web Services region where the + * API request is processed.

    + *
  • + *
  • + *

    + * DeleteRecordingConfiguration — Deletes the recording + * configuration for the specified ARN.

    + *
  • + *
+ *

+ * Amazon Web Services Tags Endpoints + *

+ *
    + *
  • + *

    + * TagResource — Adds or updates tags for the Amazon Web Services + * resource with the specified ARN.

    + *
  • + *
  • + *

    + * UntagResource — Removes tags from the resource with the + * specified ARN.

    + *
  • + *
  • + *

    + * ListTagsForResource — Gets information about Amazon Web Services tags for the specified ARN.

    + *
  • + *
+ */ +export class Ivs extends IvsClient implements Ivs {} +createAggregatedClient(commands, Ivs); diff --git a/clients/client-ivschat/src/Ivschat.ts b/clients/client-ivschat/src/Ivschat.ts index 121d12493dc6..a065c720ecd7 100644 --- a/clients/client-ivschat/src/Ivschat.ts +++ b/clients/client-ivschat/src/Ivschat.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -58,7 +59,258 @@ import { UpdateLoggingConfigurationCommandOutput, } from "./commands/UpdateLoggingConfigurationCommand"; import { UpdateRoomCommand, UpdateRoomCommandInput, UpdateRoomCommandOutput } from "./commands/UpdateRoomCommand"; -import { IvschatClient } from "./IvschatClient"; +import { IvschatClient, IvschatClientConfig } from "./IvschatClient"; + +const commands = { + CreateChatTokenCommand, + CreateLoggingConfigurationCommand, + CreateRoomCommand, + DeleteLoggingConfigurationCommand, + DeleteMessageCommand, + DeleteRoomCommand, + DisconnectUserCommand, + GetLoggingConfigurationCommand, + GetRoomCommand, + ListLoggingConfigurationsCommand, + ListRoomsCommand, + ListTagsForResourceCommand, + SendEventCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateLoggingConfigurationCommand, + UpdateRoomCommand, +}; + +export interface Ivschat { + /** + * @see {@link CreateChatTokenCommand} + */ + createChatToken( + args: CreateChatTokenCommandInput, + options?: __HttpHandlerOptions + ): Promise; + createChatToken(args: CreateChatTokenCommandInput, cb: (err: any, data?: CreateChatTokenCommandOutput) => void): void; + createChatToken( + args: CreateChatTokenCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: CreateChatTokenCommandOutput) => void + ): void; + + /** + * @see {@link CreateLoggingConfigurationCommand} + */ + createLoggingConfiguration( + args: CreateLoggingConfigurationCommandInput, + options?: __HttpHandlerOptions + ): Promise; + createLoggingConfiguration( + args: CreateLoggingConfigurationCommandInput, + cb: (err: any, data?: CreateLoggingConfigurationCommandOutput) => void + ): void; + createLoggingConfiguration( + args: CreateLoggingConfigurationCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: CreateLoggingConfigurationCommandOutput) => void + ): void; + + /** + * @see {@link CreateRoomCommand} + */ + createRoom(args: CreateRoomCommandInput, options?: __HttpHandlerOptions): Promise; + createRoom(args: CreateRoomCommandInput, cb: (err: any, data?: CreateRoomCommandOutput) => void): void; + createRoom( + args: CreateRoomCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: CreateRoomCommandOutput) => void + ): void; + + /** + * @see {@link DeleteLoggingConfigurationCommand} + */ + deleteLoggingConfiguration( + args: DeleteLoggingConfigurationCommandInput, + options?: __HttpHandlerOptions + ): Promise; + deleteLoggingConfiguration( + args: DeleteLoggingConfigurationCommandInput, + cb: (err: any, data?: DeleteLoggingConfigurationCommandOutput) => void + ): void; + deleteLoggingConfiguration( + args: DeleteLoggingConfigurationCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DeleteLoggingConfigurationCommandOutput) => void + ): void; + + /** + * @see {@link DeleteMessageCommand} + */ + deleteMessage(args: DeleteMessageCommandInput, options?: __HttpHandlerOptions): Promise; + deleteMessage(args: DeleteMessageCommandInput, cb: (err: any, data?: DeleteMessageCommandOutput) => void): void; + deleteMessage( + args: DeleteMessageCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DeleteMessageCommandOutput) => void + ): void; + + /** + * @see {@link DeleteRoomCommand} + */ + deleteRoom(args: DeleteRoomCommandInput, options?: __HttpHandlerOptions): Promise; + deleteRoom(args: DeleteRoomCommandInput, cb: (err: any, data?: DeleteRoomCommandOutput) => void): void; + deleteRoom( + args: DeleteRoomCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DeleteRoomCommandOutput) => void + ): void; + + /** + * @see {@link DisconnectUserCommand} + */ + disconnectUser( + args: DisconnectUserCommandInput, + options?: __HttpHandlerOptions + ): Promise; + disconnectUser(args: DisconnectUserCommandInput, cb: (err: any, data?: DisconnectUserCommandOutput) => void): void; + disconnectUser( + args: DisconnectUserCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DisconnectUserCommandOutput) => void + ): void; + + /** + * @see {@link GetLoggingConfigurationCommand} + */ + getLoggingConfiguration( + args: GetLoggingConfigurationCommandInput, + options?: __HttpHandlerOptions + ): Promise; + getLoggingConfiguration( + args: GetLoggingConfigurationCommandInput, + cb: (err: any, data?: GetLoggingConfigurationCommandOutput) => void + ): void; + getLoggingConfiguration( + args: GetLoggingConfigurationCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: GetLoggingConfigurationCommandOutput) => void + ): void; + + /** + * @see {@link GetRoomCommand} + */ + getRoom(args: GetRoomCommandInput, options?: __HttpHandlerOptions): Promise; + getRoom(args: GetRoomCommandInput, cb: (err: any, data?: GetRoomCommandOutput) => void): void; + getRoom( + args: GetRoomCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: GetRoomCommandOutput) => void + ): void; + + /** + * @see {@link ListLoggingConfigurationsCommand} + */ + listLoggingConfigurations( + args: ListLoggingConfigurationsCommandInput, + options?: __HttpHandlerOptions + ): Promise; + listLoggingConfigurations( + args: ListLoggingConfigurationsCommandInput, + cb: (err: any, data?: ListLoggingConfigurationsCommandOutput) => void + ): void; + listLoggingConfigurations( + args: ListLoggingConfigurationsCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: ListLoggingConfigurationsCommandOutput) => void + ): void; + + /** + * @see {@link ListRoomsCommand} + */ + listRooms(args: ListRoomsCommandInput, options?: __HttpHandlerOptions): Promise; + listRooms(args: ListRoomsCommandInput, cb: (err: any, data?: ListRoomsCommandOutput) => void): void; + listRooms( + args: ListRoomsCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: ListRoomsCommandOutput) => void + ): void; + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( + args: ListTagsForResourceCommandInput, + options?: __HttpHandlerOptions + ): Promise; + listTagsForResource( + args: ListTagsForResourceCommandInput, + cb: (err: any, data?: ListTagsForResourceCommandOutput) => void + ): void; + listTagsForResource( + args: ListTagsForResourceCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: ListTagsForResourceCommandOutput) => void + ): void; + + /** + * @see {@link SendEventCommand} + */ + sendEvent(args: SendEventCommandInput, options?: __HttpHandlerOptions): Promise; + sendEvent(args: SendEventCommandInput, cb: (err: any, data?: SendEventCommandOutput) => void): void; + sendEvent( + args: SendEventCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: SendEventCommandOutput) => void + ): void; + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( + args: TagResourceCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: TagResourceCommandOutput) => void + ): void; + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( + args: UntagResourceCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: UntagResourceCommandOutput) => void + ): void; + + /** + * @see {@link UpdateLoggingConfigurationCommand} + */ + updateLoggingConfiguration( + args: UpdateLoggingConfigurationCommandInput, + options?: __HttpHandlerOptions + ): Promise; + updateLoggingConfiguration( + args: UpdateLoggingConfigurationCommandInput, + cb: (err: any, data?: UpdateLoggingConfigurationCommandOutput) => void + ): void; + updateLoggingConfiguration( + args: UpdateLoggingConfigurationCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: UpdateLoggingConfigurationCommandOutput) => void + ): void; + + /** + * @see {@link UpdateRoomCommand} + */ + updateRoom(args: UpdateRoomCommandInput, options?: __HttpHandlerOptions): Promise; + updateRoom(args: UpdateRoomCommandInput, cb: (err: any, data?: UpdateRoomCommandOutput) => void): void; + updateRoom( + args: UpdateRoomCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: UpdateRoomCommandOutput) => void + ): void; +} /** * @public @@ -282,544 +534,5 @@ import { IvschatClient } from "./IvschatClient"; * for managing Chat resources; see the Amazon IVS Chat Messaging API * Reference.

*/ -export class Ivschat extends IvschatClient { - /** - * @public - *

Creates an encrypted token that is used by a chat participant to establish an individual - * WebSocket chat connection to a room. When the token is used to connect to chat, the - * connection is valid for the session duration specified in the request. The token becomes - * invalid at the token-expiration timestamp included in the response.

- *

Use the capabilities field to permit an end user to send messages or - * moderate a room.

- *

The attributes field securely attaches structured data to the chat session; the data is - * included within each message sent by the end user and received by other participants in the - * room. Common use cases for attributes include passing end-user profile data like an icon, - * display name, colors, badges, and other display features.

- *

Encryption keys are owned by Amazon IVS Chat and never used directly by your - * application.

- */ - public createChatToken( - args: CreateChatTokenCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createChatToken( - args: CreateChatTokenCommandInput, - cb: (err: any, data?: CreateChatTokenCommandOutput) => void - ): void; - public createChatToken( - args: CreateChatTokenCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: CreateChatTokenCommandOutput) => void - ): void; - public createChatToken( - args: CreateChatTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateChatTokenCommandOutput) => void), - cb?: (err: any, data?: CreateChatTokenCommandOutput) => void - ): Promise | void { - const command = new CreateChatTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a logging configuration that allows clients to store and record sent - * messages.

- */ - public createLoggingConfiguration( - args: CreateLoggingConfigurationCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createLoggingConfiguration( - args: CreateLoggingConfigurationCommandInput, - cb: (err: any, data?: CreateLoggingConfigurationCommandOutput) => void - ): void; - public createLoggingConfiguration( - args: CreateLoggingConfigurationCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: CreateLoggingConfigurationCommandOutput) => void - ): void; - public createLoggingConfiguration( - args: CreateLoggingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a room that allows clients to connect and pass messages.

- */ - public createRoom(args: CreateRoomCommandInput, options?: __HttpHandlerOptions): Promise; - public createRoom(args: CreateRoomCommandInput, cb: (err: any, data?: CreateRoomCommandOutput) => void): void; - public createRoom( - args: CreateRoomCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: CreateRoomCommandOutput) => void - ): void; - public createRoom( - args: CreateRoomCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRoomCommandOutput) => void), - cb?: (err: any, data?: CreateRoomCommandOutput) => void - ): Promise | void { - const command = new CreateRoomCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified logging configuration.

- */ - public deleteLoggingConfiguration( - args: DeleteLoggingConfigurationCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteLoggingConfiguration( - args: DeleteLoggingConfigurationCommandInput, - cb: (err: any, data?: DeleteLoggingConfigurationCommandOutput) => void - ): void; - public deleteLoggingConfiguration( - args: DeleteLoggingConfigurationCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: DeleteLoggingConfigurationCommandOutput) => void - ): void; - public deleteLoggingConfiguration( - args: DeleteLoggingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sends an event to a specific room which directs clients to delete a specific message; - * that is, unrender it from view and delete it from the client’s chat history. This event’s - * EventName is aws:DELETE_MESSAGE. This replicates the - * DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.

- */ - public deleteMessage( - args: DeleteMessageCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteMessage( - args: DeleteMessageCommandInput, - cb: (err: any, data?: DeleteMessageCommandOutput) => void - ): void; - public deleteMessage( - args: DeleteMessageCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: DeleteMessageCommandOutput) => void - ): void; - public deleteMessage( - args: DeleteMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMessageCommandOutput) => void), - cb?: (err: any, data?: DeleteMessageCommandOutput) => void - ): Promise | void { - const command = new DeleteMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified room.

- */ - public deleteRoom(args: DeleteRoomCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteRoom(args: DeleteRoomCommandInput, cb: (err: any, data?: DeleteRoomCommandOutput) => void): void; - public deleteRoom( - args: DeleteRoomCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: DeleteRoomCommandOutput) => void - ): void; - public deleteRoom( - args: DeleteRoomCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRoomCommandOutput) => void), - cb?: (err: any, data?: DeleteRoomCommandOutput) => void - ): Promise | void { - const command = new DeleteRoomCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disconnects all connections using a specified user ID from a room. This replicates the - * - * DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.

- */ - public disconnectUser( - args: DisconnectUserCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public disconnectUser( - args: DisconnectUserCommandInput, - cb: (err: any, data?: DisconnectUserCommandOutput) => void - ): void; - public disconnectUser( - args: DisconnectUserCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: DisconnectUserCommandOutput) => void - ): void; - public disconnectUser( - args: DisconnectUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisconnectUserCommandOutput) => void), - cb?: (err: any, data?: DisconnectUserCommandOutput) => void - ): Promise | void { - const command = new DisconnectUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the specified logging configuration.

- */ - public getLoggingConfiguration( - args: GetLoggingConfigurationCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getLoggingConfiguration( - args: GetLoggingConfigurationCommandInput, - cb: (err: any, data?: GetLoggingConfigurationCommandOutput) => void - ): void; - public getLoggingConfiguration( - args: GetLoggingConfigurationCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: GetLoggingConfigurationCommandOutput) => void - ): void; - public getLoggingConfiguration( - args: GetLoggingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the specified room.

- */ - public getRoom(args: GetRoomCommandInput, options?: __HttpHandlerOptions): Promise; - public getRoom(args: GetRoomCommandInput, cb: (err: any, data?: GetRoomCommandOutput) => void): void; - public getRoom( - args: GetRoomCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: GetRoomCommandOutput) => void - ): void; - public getRoom( - args: GetRoomCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRoomCommandOutput) => void), - cb?: (err: any, data?: GetRoomCommandOutput) => void - ): Promise | void { - const command = new GetRoomCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets summary information about all your logging configurations in the AWS region where - * the API request is processed.

- */ - public listLoggingConfigurations( - args: ListLoggingConfigurationsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listLoggingConfigurations( - args: ListLoggingConfigurationsCommandInput, - cb: (err: any, data?: ListLoggingConfigurationsCommandOutput) => void - ): void; - public listLoggingConfigurations( - args: ListLoggingConfigurationsCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: ListLoggingConfigurationsCommandOutput) => void - ): void; - public listLoggingConfigurations( - args: ListLoggingConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLoggingConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListLoggingConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListLoggingConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets summary information about all your rooms in the AWS region where the API request is - * processed. Results are sorted in descending order of updateTime.

- */ - public listRooms(args: ListRoomsCommandInput, options?: __HttpHandlerOptions): Promise; - public listRooms(args: ListRoomsCommandInput, cb: (err: any, data?: ListRoomsCommandOutput) => void): void; - public listRooms( - args: ListRoomsCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: ListRoomsCommandOutput) => void - ): void; - public listRooms( - args: ListRoomsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRoomsCommandOutput) => void), - cb?: (err: any, data?: ListRoomsCommandOutput) => void - ): Promise | void { - const command = new ListRoomsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about AWS tags for the specified ARN.

- */ - public listTagsForResource( - args: ListTagsForResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - cb: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sends an event to a room. Use this within your application’s business logic to send - * events to clients of a room; e.g., to notify clients to change the way the chat UI is - * rendered.

- */ - public sendEvent(args: SendEventCommandInput, options?: __HttpHandlerOptions): Promise; - public sendEvent(args: SendEventCommandInput, cb: (err: any, data?: SendEventCommandOutput) => void): void; - public sendEvent( - args: SendEventCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: SendEventCommandOutput) => void - ): void; - public sendEvent( - args: SendEventCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendEventCommandOutput) => void), - cb?: (err: any, data?: SendEventCommandOutput) => void - ): Promise | void { - const command = new SendEventCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds or updates tags for the AWS resource with the specified ARN.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( - args: TagResourceCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: TagResourceCommandOutput) => void - ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes tags from the resource with the specified ARN.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( - args: UntagResourceCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a specified logging configuration.

- */ - public updateLoggingConfiguration( - args: UpdateLoggingConfigurationCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateLoggingConfiguration( - args: UpdateLoggingConfigurationCommandInput, - cb: (err: any, data?: UpdateLoggingConfigurationCommandOutput) => void - ): void; - public updateLoggingConfiguration( - args: UpdateLoggingConfigurationCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: UpdateLoggingConfigurationCommandOutput) => void - ): void; - public updateLoggingConfiguration( - args: UpdateLoggingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a room’s configuration.

- */ - public updateRoom(args: UpdateRoomCommandInput, options?: __HttpHandlerOptions): Promise; - public updateRoom(args: UpdateRoomCommandInput, cb: (err: any, data?: UpdateRoomCommandOutput) => void): void; - public updateRoom( - args: UpdateRoomCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: UpdateRoomCommandOutput) => void - ): void; - public updateRoom( - args: UpdateRoomCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRoomCommandOutput) => void), - cb?: (err: any, data?: UpdateRoomCommandOutput) => void - ): Promise | void { - const command = new UpdateRoomCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } -} +export class Ivschat extends IvschatClient implements Ivschat {} +createAggregatedClient(commands, Ivschat); diff --git a/clients/client-kafka/src/Kafka.ts b/clients/client-kafka/src/Kafka.ts index 16eca48c39d8..3acea4baa2a5 100644 --- a/clients/client-kafka/src/Kafka.ts +++ b/clients/client-kafka/src/Kafka.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -173,1180 +174,604 @@ import { UpdateStorageCommandInput, UpdateStorageCommandOutput, } from "./commands/UpdateStorageCommand"; -import { KafkaClient } from "./KafkaClient"; +import { KafkaClient, KafkaClientConfig } from "./KafkaClient"; -/** - * @public - *

The operations for managing an Amazon MSK cluster.

- */ -export class Kafka extends KafkaClient { +const commands = { + BatchAssociateScramSecretCommand, + BatchDisassociateScramSecretCommand, + CreateClusterCommand, + CreateClusterV2Command, + CreateConfigurationCommand, + DeleteClusterCommand, + DeleteConfigurationCommand, + DescribeClusterCommand, + DescribeClusterOperationCommand, + DescribeClusterV2Command, + DescribeConfigurationCommand, + DescribeConfigurationRevisionCommand, + GetBootstrapBrokersCommand, + GetCompatibleKafkaVersionsCommand, + ListClusterOperationsCommand, + ListClustersCommand, + ListClustersV2Command, + ListConfigurationRevisionsCommand, + ListConfigurationsCommand, + ListKafkaVersionsCommand, + ListNodesCommand, + ListScramSecretsCommand, + ListTagsForResourceCommand, + RebootBrokerCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateBrokerCountCommand, + UpdateBrokerStorageCommand, + UpdateBrokerTypeCommand, + UpdateClusterConfigurationCommand, + UpdateClusterKafkaVersionCommand, + UpdateConfigurationCommand, + UpdateConnectivityCommand, + UpdateMonitoringCommand, + UpdateSecurityCommand, + UpdateStorageCommand, +}; + +export interface Kafka { /** - * @public - *

Associates one or more Scram Secrets with an Amazon MSK cluster.

+ * @see {@link BatchAssociateScramSecretCommand} */ - public batchAssociateScramSecret( + batchAssociateScramSecret( args: BatchAssociateScramSecretCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchAssociateScramSecret( + batchAssociateScramSecret( args: BatchAssociateScramSecretCommandInput, cb: (err: any, data?: BatchAssociateScramSecretCommandOutput) => void ): void; - public batchAssociateScramSecret( + batchAssociateScramSecret( args: BatchAssociateScramSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchAssociateScramSecretCommandOutput) => void ): void; - public batchAssociateScramSecret( - args: BatchAssociateScramSecretCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchAssociateScramSecretCommandOutput) => void), - cb?: (err: any, data?: BatchAssociateScramSecretCommandOutput) => void - ): Promise | void { - const command = new BatchAssociateScramSecretCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates one or more Scram Secrets from an Amazon MSK cluster.

+ * @see {@link BatchDisassociateScramSecretCommand} */ - public batchDisassociateScramSecret( + batchDisassociateScramSecret( args: BatchDisassociateScramSecretCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDisassociateScramSecret( + batchDisassociateScramSecret( args: BatchDisassociateScramSecretCommandInput, cb: (err: any, data?: BatchDisassociateScramSecretCommandOutput) => void ): void; - public batchDisassociateScramSecret( + batchDisassociateScramSecret( args: BatchDisassociateScramSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDisassociateScramSecretCommandOutput) => void ): void; - public batchDisassociateScramSecret( - args: BatchDisassociateScramSecretCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDisassociateScramSecretCommandOutput) => void), - cb?: (err: any, data?: BatchDisassociateScramSecretCommandOutput) => void - ): Promise | void { - const command = new BatchDisassociateScramSecretCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new MSK cluster.

+ * @see {@link CreateClusterCommand} */ - public createCluster( - args: CreateClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createCluster( - args: CreateClusterCommandInput, - cb: (err: any, data?: CreateClusterCommandOutput) => void - ): void; - public createCluster( + createCluster(args: CreateClusterCommandInput, options?: __HttpHandlerOptions): Promise; + createCluster(args: CreateClusterCommandInput, cb: (err: any, data?: CreateClusterCommandOutput) => void): void; + createCluster( args: CreateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterCommandOutput) => void ): void; - public createCluster( - args: CreateClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateClusterCommandOutput) => void), - cb?: (err: any, data?: CreateClusterCommandOutput) => void - ): Promise | void { - const command = new CreateClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new MSK cluster.

+ * @see {@link CreateClusterV2Command} */ - public createClusterV2( + createClusterV2( args: CreateClusterV2CommandInput, options?: __HttpHandlerOptions ): Promise; - public createClusterV2( - args: CreateClusterV2CommandInput, - cb: (err: any, data?: CreateClusterV2CommandOutput) => void - ): void; - public createClusterV2( + createClusterV2(args: CreateClusterV2CommandInput, cb: (err: any, data?: CreateClusterV2CommandOutput) => void): void; + createClusterV2( args: CreateClusterV2CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterV2CommandOutput) => void ): void; - public createClusterV2( - args: CreateClusterV2CommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateClusterV2CommandOutput) => void), - cb?: (err: any, data?: CreateClusterV2CommandOutput) => void - ): Promise | void { - const command = new CreateClusterV2Command(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new MSK configuration.

+ * @see {@link CreateConfigurationCommand} */ - public createConfiguration( + createConfiguration( args: CreateConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConfiguration( + createConfiguration( args: CreateConfigurationCommandInput, cb: (err: any, data?: CreateConfigurationCommandOutput) => void ): void; - public createConfiguration( + createConfiguration( args: CreateConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfigurationCommandOutput) => void ): void; - public createConfiguration( - args: CreateConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.

+ * @see {@link DeleteClusterCommand} */ - public deleteCluster( - args: DeleteClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteCluster( - args: DeleteClusterCommandInput, - cb: (err: any, data?: DeleteClusterCommandOutput) => void - ): void; - public deleteCluster( + deleteCluster(args: DeleteClusterCommandInput, options?: __HttpHandlerOptions): Promise; + deleteCluster(args: DeleteClusterCommandInput, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void; + deleteCluster( args: DeleteClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClusterCommandOutput) => void ): void; - public deleteCluster( - args: DeleteClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteClusterCommandOutput) => void), - cb?: (err: any, data?: DeleteClusterCommandOutput) => void - ): Promise | void { - const command = new DeleteClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an MSK Configuration.

+ * @see {@link DeleteConfigurationCommand} */ - public deleteConfiguration( + deleteConfiguration( args: DeleteConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConfiguration( + deleteConfiguration( args: DeleteConfigurationCommandInput, cb: (err: any, data?: DeleteConfigurationCommandOutput) => void ): void; - public deleteConfiguration( + deleteConfiguration( args: DeleteConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationCommandOutput) => void ): void; - public deleteConfiguration( - args: DeleteConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.

+ * @see {@link DescribeClusterCommand} */ - public describeCluster( + describeCluster( args: DescribeClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCluster( - args: DescribeClusterCommandInput, - cb: (err: any, data?: DescribeClusterCommandOutput) => void - ): void; - public describeCluster( + describeCluster(args: DescribeClusterCommandInput, cb: (err: any, data?: DescribeClusterCommandOutput) => void): void; + describeCluster( args: DescribeClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClusterCommandOutput) => void ): void; - public describeCluster( - args: DescribeClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClusterCommandOutput) => void), - cb?: (err: any, data?: DescribeClusterCommandOutput) => void - ): Promise | void { - const command = new DescribeClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a description of the cluster operation specified by the ARN.

+ * @see {@link DescribeClusterOperationCommand} */ - public describeClusterOperation( + describeClusterOperation( args: DescribeClusterOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClusterOperation( + describeClusterOperation( args: DescribeClusterOperationCommandInput, cb: (err: any, data?: DescribeClusterOperationCommandOutput) => void ): void; - public describeClusterOperation( + describeClusterOperation( args: DescribeClusterOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClusterOperationCommandOutput) => void ): void; - public describeClusterOperation( - args: DescribeClusterOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClusterOperationCommandOutput) => void), - cb?: (err: any, data?: DescribeClusterOperationCommandOutput) => void - ): Promise | void { - const command = new DescribeClusterOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.

+ * @see {@link DescribeClusterV2Command} */ - public describeClusterV2( + describeClusterV2( args: DescribeClusterV2CommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClusterV2( + describeClusterV2( args: DescribeClusterV2CommandInput, cb: (err: any, data?: DescribeClusterV2CommandOutput) => void ): void; - public describeClusterV2( + describeClusterV2( args: DescribeClusterV2CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClusterV2CommandOutput) => void ): void; - public describeClusterV2( - args: DescribeClusterV2CommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClusterV2CommandOutput) => void), - cb?: (err: any, data?: DescribeClusterV2CommandOutput) => void - ): Promise | void { - const command = new DescribeClusterV2Command(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a description of this MSK configuration.

+ * @see {@link DescribeConfigurationCommand} */ - public describeConfiguration( + describeConfiguration( args: DescribeConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConfiguration( + describeConfiguration( args: DescribeConfigurationCommandInput, cb: (err: any, data?: DescribeConfigurationCommandOutput) => void ): void; - public describeConfiguration( + describeConfiguration( args: DescribeConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigurationCommandOutput) => void ): void; - public describeConfiguration( - args: DescribeConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a description of this revision of the configuration.

+ * @see {@link DescribeConfigurationRevisionCommand} */ - public describeConfigurationRevision( + describeConfigurationRevision( args: DescribeConfigurationRevisionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConfigurationRevision( + describeConfigurationRevision( args: DescribeConfigurationRevisionCommandInput, cb: (err: any, data?: DescribeConfigurationRevisionCommandOutput) => void ): void; - public describeConfigurationRevision( + describeConfigurationRevision( args: DescribeConfigurationRevisionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigurationRevisionCommandOutput) => void ): void; - public describeConfigurationRevision( - args: DescribeConfigurationRevisionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConfigurationRevisionCommandOutput) => void), - cb?: (err: any, data?: DescribeConfigurationRevisionCommandOutput) => void - ): Promise | void { - const command = new DescribeConfigurationRevisionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A list of brokers that a client application can use to bootstrap.

+ * @see {@link GetBootstrapBrokersCommand} */ - public getBootstrapBrokers( + getBootstrapBrokers( args: GetBootstrapBrokersCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBootstrapBrokers( + getBootstrapBrokers( args: GetBootstrapBrokersCommandInput, cb: (err: any, data?: GetBootstrapBrokersCommandOutput) => void ): void; - public getBootstrapBrokers( + getBootstrapBrokers( args: GetBootstrapBrokersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBootstrapBrokersCommandOutput) => void ): void; - public getBootstrapBrokers( - args: GetBootstrapBrokersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBootstrapBrokersCommandOutput) => void), - cb?: (err: any, data?: GetBootstrapBrokersCommandOutput) => void - ): Promise | void { - const command = new GetBootstrapBrokersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the Apache Kafka versions to which you can update the MSK cluster.

+ * @see {@link GetCompatibleKafkaVersionsCommand} */ - public getCompatibleKafkaVersions( + getCompatibleKafkaVersions( args: GetCompatibleKafkaVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCompatibleKafkaVersions( + getCompatibleKafkaVersions( args: GetCompatibleKafkaVersionsCommandInput, cb: (err: any, data?: GetCompatibleKafkaVersionsCommandOutput) => void ): void; - public getCompatibleKafkaVersions( + getCompatibleKafkaVersions( args: GetCompatibleKafkaVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCompatibleKafkaVersionsCommandOutput) => void ): void; - public getCompatibleKafkaVersions( - args: GetCompatibleKafkaVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCompatibleKafkaVersionsCommandOutput) => void), - cb?: (err: any, data?: GetCompatibleKafkaVersionsCommandOutput) => void - ): Promise | void { - const command = new GetCompatibleKafkaVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all the operations that have been performed on the specified MSK cluster.

+ * @see {@link ListClusterOperationsCommand} */ - public listClusterOperations( + listClusterOperations( args: ListClusterOperationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listClusterOperations( + listClusterOperations( args: ListClusterOperationsCommandInput, cb: (err: any, data?: ListClusterOperationsCommandOutput) => void ): void; - public listClusterOperations( + listClusterOperations( args: ListClusterOperationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListClusterOperationsCommandOutput) => void ): void; - public listClusterOperations( - args: ListClusterOperationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListClusterOperationsCommandOutput) => void), - cb?: (err: any, data?: ListClusterOperationsCommandOutput) => void - ): Promise | void { - const command = new ListClusterOperationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all the MSK clusters in the current Region.

+ * @see {@link ListClustersCommand} */ - public listClusters( - args: ListClustersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listClusters(args: ListClustersCommandInput, cb: (err: any, data?: ListClustersCommandOutput) => void): void; - public listClusters( + listClusters(args: ListClustersCommandInput, options?: __HttpHandlerOptions): Promise; + listClusters(args: ListClustersCommandInput, cb: (err: any, data?: ListClustersCommandOutput) => void): void; + listClusters( args: ListClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListClustersCommandOutput) => void ): void; - public listClusters( - args: ListClustersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListClustersCommandOutput) => void), - cb?: (err: any, data?: ListClustersCommandOutput) => void - ): Promise | void { - const command = new ListClustersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all the MSK clusters in the current Region.

+ * @see {@link ListClustersV2Command} */ - public listClustersV2( + listClustersV2( args: ListClustersV2CommandInput, options?: __HttpHandlerOptions ): Promise; - public listClustersV2( - args: ListClustersV2CommandInput, - cb: (err: any, data?: ListClustersV2CommandOutput) => void - ): void; - public listClustersV2( + listClustersV2(args: ListClustersV2CommandInput, cb: (err: any, data?: ListClustersV2CommandOutput) => void): void; + listClustersV2( args: ListClustersV2CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListClustersV2CommandOutput) => void ): void; - public listClustersV2( - args: ListClustersV2CommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListClustersV2CommandOutput) => void), - cb?: (err: any, data?: ListClustersV2CommandOutput) => void - ): Promise | void { - const command = new ListClustersV2Command(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all the MSK configurations in this Region.

+ * @see {@link ListConfigurationRevisionsCommand} */ - public listConfigurationRevisions( + listConfigurationRevisions( args: ListConfigurationRevisionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConfigurationRevisions( + listConfigurationRevisions( args: ListConfigurationRevisionsCommandInput, cb: (err: any, data?: ListConfigurationRevisionsCommandOutput) => void ): void; - public listConfigurationRevisions( + listConfigurationRevisions( args: ListConfigurationRevisionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConfigurationRevisionsCommandOutput) => void ): void; - public listConfigurationRevisions( - args: ListConfigurationRevisionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConfigurationRevisionsCommandOutput) => void), - cb?: (err: any, data?: ListConfigurationRevisionsCommandOutput) => void - ): Promise | void { - const command = new ListConfigurationRevisionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all the MSK configurations in this Region.

+ * @see {@link ListConfigurationsCommand} */ - public listConfigurations( + listConfigurations( args: ListConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConfigurations( + listConfigurations( args: ListConfigurationsCommandInput, cb: (err: any, data?: ListConfigurationsCommandOutput) => void ): void; - public listConfigurations( + listConfigurations( args: ListConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConfigurationsCommandOutput) => void ): void; - public listConfigurations( - args: ListConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of Apache Kafka versions.

+ * @see {@link ListKafkaVersionsCommand} */ - public listKafkaVersions( + listKafkaVersions( args: ListKafkaVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listKafkaVersions( + listKafkaVersions( args: ListKafkaVersionsCommandInput, cb: (err: any, data?: ListKafkaVersionsCommandOutput) => void ): void; - public listKafkaVersions( + listKafkaVersions( args: ListKafkaVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKafkaVersionsCommandOutput) => void ): void; - public listKafkaVersions( - args: ListKafkaVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListKafkaVersionsCommandOutput) => void), - cb?: (err: any, data?: ListKafkaVersionsCommandOutput) => void - ): Promise | void { - const command = new ListKafkaVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the broker nodes in the cluster.

+ * @see {@link ListNodesCommand} */ - public listNodes(args: ListNodesCommandInput, options?: __HttpHandlerOptions): Promise; - public listNodes(args: ListNodesCommandInput, cb: (err: any, data?: ListNodesCommandOutput) => void): void; - public listNodes( + listNodes(args: ListNodesCommandInput, options?: __HttpHandlerOptions): Promise; + listNodes(args: ListNodesCommandInput, cb: (err: any, data?: ListNodesCommandOutput) => void): void; + listNodes( args: ListNodesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNodesCommandOutput) => void ): void; - public listNodes( - args: ListNodesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNodesCommandOutput) => void), - cb?: (err: any, data?: ListNodesCommandOutput) => void - ): Promise | void { - const command = new ListNodesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the Scram Secrets associated with an Amazon MSK cluster.

+ * @see {@link ListScramSecretsCommand} */ - public listScramSecrets( + listScramSecrets( args: ListScramSecretsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listScramSecrets( + listScramSecrets( args: ListScramSecretsCommandInput, cb: (err: any, data?: ListScramSecretsCommandOutput) => void ): void; - public listScramSecrets( + listScramSecrets( args: ListScramSecretsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListScramSecretsCommandOutput) => void ): void; - public listScramSecrets( - args: ListScramSecretsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListScramSecretsCommandOutput) => void), - cb?: (err: any, data?: ListScramSecretsCommandOutput) => void - ): Promise | void { - const command = new ListScramSecretsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the tags associated with the specified resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Reboots brokers. + * @see {@link RebootBrokerCommand} */ - public rebootBroker( - args: RebootBrokerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public rebootBroker(args: RebootBrokerCommandInput, cb: (err: any, data?: RebootBrokerCommandOutput) => void): void; - public rebootBroker( + rebootBroker(args: RebootBrokerCommandInput, options?: __HttpHandlerOptions): Promise; + rebootBroker(args: RebootBrokerCommandInput, cb: (err: any, data?: RebootBrokerCommandOutput) => void): void; + rebootBroker( args: RebootBrokerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebootBrokerCommandOutput) => void ): void; - public rebootBroker( - args: RebootBrokerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RebootBrokerCommandOutput) => void), - cb?: (err: any, data?: RebootBrokerCommandOutput) => void - ): Promise | void { - const command = new RebootBrokerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds tags to the specified MSK resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the tags associated with the keys that are provided in the query.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the number of broker nodes in the cluster.

+ * @see {@link UpdateBrokerCountCommand} */ - public updateBrokerCount( + updateBrokerCount( args: UpdateBrokerCountCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBrokerCount( + updateBrokerCount( args: UpdateBrokerCountCommandInput, cb: (err: any, data?: UpdateBrokerCountCommandOutput) => void ): void; - public updateBrokerCount( + updateBrokerCount( args: UpdateBrokerCountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBrokerCountCommandOutput) => void ): void; - public updateBrokerCount( - args: UpdateBrokerCountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBrokerCountCommandOutput) => void), - cb?: (err: any, data?: UpdateBrokerCountCommandOutput) => void - ): Promise | void { - const command = new UpdateBrokerCountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the EBS storage associated with MSK brokers.

+ * @see {@link UpdateBrokerStorageCommand} */ - public updateBrokerStorage( + updateBrokerStorage( args: UpdateBrokerStorageCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBrokerStorage( + updateBrokerStorage( args: UpdateBrokerStorageCommandInput, cb: (err: any, data?: UpdateBrokerStorageCommandOutput) => void ): void; - public updateBrokerStorage( + updateBrokerStorage( args: UpdateBrokerStorageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBrokerStorageCommandOutput) => void ): void; - public updateBrokerStorage( - args: UpdateBrokerStorageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBrokerStorageCommandOutput) => void), - cb?: (err: any, data?: UpdateBrokerStorageCommandOutput) => void - ): Promise | void { - const command = new UpdateBrokerStorageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates EC2 instance type.

+ * @see {@link UpdateBrokerTypeCommand} */ - public updateBrokerType( + updateBrokerType( args: UpdateBrokerTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBrokerType( + updateBrokerType( args: UpdateBrokerTypeCommandInput, cb: (err: any, data?: UpdateBrokerTypeCommandOutput) => void ): void; - public updateBrokerType( + updateBrokerType( args: UpdateBrokerTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBrokerTypeCommandOutput) => void ): void; - public updateBrokerType( - args: UpdateBrokerTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBrokerTypeCommandOutput) => void), - cb?: (err: any, data?: UpdateBrokerTypeCommandOutput) => void - ): Promise | void { - const command = new UpdateBrokerTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the cluster with the configuration that is specified in the request body.

+ * @see {@link UpdateClusterConfigurationCommand} */ - public updateClusterConfiguration( + updateClusterConfiguration( args: UpdateClusterConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateClusterConfiguration( + updateClusterConfiguration( args: UpdateClusterConfigurationCommandInput, cb: (err: any, data?: UpdateClusterConfigurationCommandOutput) => void ): void; - public updateClusterConfiguration( + updateClusterConfiguration( args: UpdateClusterConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateClusterConfigurationCommandOutput) => void ): void; - public updateClusterConfiguration( - args: UpdateClusterConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateClusterConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateClusterConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateClusterConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the Apache Kafka version for the cluster.

+ * @see {@link UpdateClusterKafkaVersionCommand} */ - public updateClusterKafkaVersion( + updateClusterKafkaVersion( args: UpdateClusterKafkaVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateClusterKafkaVersion( + updateClusterKafkaVersion( args: UpdateClusterKafkaVersionCommandInput, cb: (err: any, data?: UpdateClusterKafkaVersionCommandOutput) => void ): void; - public updateClusterKafkaVersion( + updateClusterKafkaVersion( args: UpdateClusterKafkaVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateClusterKafkaVersionCommandOutput) => void ): void; - public updateClusterKafkaVersion( - args: UpdateClusterKafkaVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateClusterKafkaVersionCommandOutput) => void), - cb?: (err: any, data?: UpdateClusterKafkaVersionCommandOutput) => void - ): Promise | void { - const command = new UpdateClusterKafkaVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an MSK configuration.

+ * @see {@link UpdateConfigurationCommand} */ - public updateConfiguration( + updateConfiguration( args: UpdateConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConfiguration( + updateConfiguration( args: UpdateConfigurationCommandInput, cb: (err: any, data?: UpdateConfigurationCommandOutput) => void ): void; - public updateConfiguration( + updateConfiguration( args: UpdateConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConfigurationCommandOutput) => void ): void; - public updateConfiguration( - args: UpdateConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the cluster's connectivity configuration.

+ * @see {@link UpdateConnectivityCommand} */ - public updateConnectivity( + updateConnectivity( args: UpdateConnectivityCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConnectivity( + updateConnectivity( args: UpdateConnectivityCommandInput, cb: (err: any, data?: UpdateConnectivityCommandOutput) => void ): void; - public updateConnectivity( + updateConnectivity( args: UpdateConnectivityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectivityCommandOutput) => void ): void; - public updateConnectivity( - args: UpdateConnectivityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConnectivityCommandOutput) => void), - cb?: (err: any, data?: UpdateConnectivityCommandOutput) => void - ): Promise | void { - const command = new UpdateConnectivityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus.

+ * @see {@link UpdateMonitoringCommand} */ - public updateMonitoring( + updateMonitoring( args: UpdateMonitoringCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMonitoring( + updateMonitoring( args: UpdateMonitoringCommandInput, cb: (err: any, data?: UpdateMonitoringCommandOutput) => void ): void; - public updateMonitoring( + updateMonitoring( args: UpdateMonitoringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMonitoringCommandOutput) => void ): void; - public updateMonitoring( - args: UpdateMonitoringCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMonitoringCommandOutput) => void), - cb?: (err: any, data?: UpdateMonitoringCommandOutput) => void - ): Promise | void { - const command = new UpdateMonitoringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters.

+ * @see {@link UpdateSecurityCommand} */ - public updateSecurity( + updateSecurity( args: UpdateSecurityCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSecurity( - args: UpdateSecurityCommandInput, - cb: (err: any, data?: UpdateSecurityCommandOutput) => void - ): void; - public updateSecurity( + updateSecurity(args: UpdateSecurityCommandInput, cb: (err: any, data?: UpdateSecurityCommandOutput) => void): void; + updateSecurity( args: UpdateSecurityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSecurityCommandOutput) => void ): void; - public updateSecurity( - args: UpdateSecurityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSecurityCommandOutput) => void), - cb?: (err: any, data?: UpdateSecurityCommandOutput) => void - ): Promise | void { - const command = new UpdateSecurityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Updates cluster broker volume size (or) sets cluster storage mode to TIERED. + * @see {@link UpdateStorageCommand} */ - public updateStorage( - args: UpdateStorageCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateStorage( - args: UpdateStorageCommandInput, - cb: (err: any, data?: UpdateStorageCommandOutput) => void - ): void; - public updateStorage( + updateStorage(args: UpdateStorageCommandInput, options?: __HttpHandlerOptions): Promise; + updateStorage(args: UpdateStorageCommandInput, cb: (err: any, data?: UpdateStorageCommandOutput) => void): void; + updateStorage( args: UpdateStorageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStorageCommandOutput) => void ): void; - public updateStorage( - args: UpdateStorageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStorageCommandOutput) => void), - cb?: (err: any, data?: UpdateStorageCommandOutput) => void - ): Promise | void { - const command = new UpdateStorageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The operations for managing an Amazon MSK cluster.

+ */ +export class Kafka extends KafkaClient implements Kafka {} +createAggregatedClient(commands, Kafka); diff --git a/clients/client-kafkaconnect/src/KafkaConnect.ts b/clients/client-kafkaconnect/src/KafkaConnect.ts index 15971692a824..3f60c9099599 100644 --- a/clients/client-kafkaconnect/src/KafkaConnect.ts +++ b/clients/client-kafkaconnect/src/KafkaConnect.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -61,408 +62,220 @@ import { UpdateConnectorCommandInput, UpdateConnectorCommandOutput, } from "./commands/UpdateConnectorCommand"; -import { KafkaConnectClient } from "./KafkaConnectClient"; +import { KafkaConnectClient, KafkaConnectClientConfig } from "./KafkaConnectClient"; -/** - * @public - *

- */ -export class KafkaConnect extends KafkaConnectClient { +const commands = { + CreateConnectorCommand, + CreateCustomPluginCommand, + CreateWorkerConfigurationCommand, + DeleteConnectorCommand, + DeleteCustomPluginCommand, + DescribeConnectorCommand, + DescribeCustomPluginCommand, + DescribeWorkerConfigurationCommand, + ListConnectorsCommand, + ListCustomPluginsCommand, + ListWorkerConfigurationsCommand, + UpdateConnectorCommand, +}; + +export interface KafkaConnect { /** - * @public - *

Creates a connector using the specified properties.

+ * @see {@link CreateConnectorCommand} */ - public createConnector( + createConnector( args: CreateConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConnector( - args: CreateConnectorCommandInput, - cb: (err: any, data?: CreateConnectorCommandOutput) => void - ): void; - public createConnector( + createConnector(args: CreateConnectorCommandInput, cb: (err: any, data?: CreateConnectorCommandOutput) => void): void; + createConnector( args: CreateConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectorCommandOutput) => void ): void; - public createConnector( - args: CreateConnectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConnectorCommandOutput) => void), - cb?: (err: any, data?: CreateConnectorCommandOutput) => void - ): Promise | void { - const command = new CreateConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a custom plugin using the specified properties.

+ * @see {@link CreateCustomPluginCommand} */ - public createCustomPlugin( + createCustomPlugin( args: CreateCustomPluginCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCustomPlugin( + createCustomPlugin( args: CreateCustomPluginCommandInput, cb: (err: any, data?: CreateCustomPluginCommandOutput) => void ): void; - public createCustomPlugin( + createCustomPlugin( args: CreateCustomPluginCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomPluginCommandOutput) => void ): void; - public createCustomPlugin( - args: CreateCustomPluginCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCustomPluginCommandOutput) => void), - cb?: (err: any, data?: CreateCustomPluginCommandOutput) => void - ): Promise | void { - const command = new CreateCustomPluginCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a worker configuration using the specified properties.

+ * @see {@link CreateWorkerConfigurationCommand} */ - public createWorkerConfiguration( + createWorkerConfiguration( args: CreateWorkerConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorkerConfiguration( + createWorkerConfiguration( args: CreateWorkerConfigurationCommandInput, cb: (err: any, data?: CreateWorkerConfigurationCommandOutput) => void ): void; - public createWorkerConfiguration( + createWorkerConfiguration( args: CreateWorkerConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkerConfigurationCommandOutput) => void ): void; - public createWorkerConfiguration( - args: CreateWorkerConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorkerConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateWorkerConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateWorkerConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified connector.

+ * @see {@link DeleteConnectorCommand} */ - public deleteConnector( + deleteConnector( args: DeleteConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConnector( - args: DeleteConnectorCommandInput, - cb: (err: any, data?: DeleteConnectorCommandOutput) => void - ): void; - public deleteConnector( + deleteConnector(args: DeleteConnectorCommandInput, cb: (err: any, data?: DeleteConnectorCommandOutput) => void): void; + deleteConnector( args: DeleteConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectorCommandOutput) => void ): void; - public deleteConnector( - args: DeleteConnectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConnectorCommandOutput) => void), - cb?: (err: any, data?: DeleteConnectorCommandOutput) => void - ): Promise | void { - const command = new DeleteConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a custom plugin.

+ * @see {@link DeleteCustomPluginCommand} */ - public deleteCustomPlugin( + deleteCustomPlugin( args: DeleteCustomPluginCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCustomPlugin( + deleteCustomPlugin( args: DeleteCustomPluginCommandInput, cb: (err: any, data?: DeleteCustomPluginCommandOutput) => void ): void; - public deleteCustomPlugin( + deleteCustomPlugin( args: DeleteCustomPluginCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomPluginCommandOutput) => void ): void; - public deleteCustomPlugin( - args: DeleteCustomPluginCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCustomPluginCommandOutput) => void), - cb?: (err: any, data?: DeleteCustomPluginCommandOutput) => void - ): Promise | void { - const command = new DeleteCustomPluginCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns summary information about the connector.

+ * @see {@link DescribeConnectorCommand} */ - public describeConnector( + describeConnector( args: DescribeConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConnector( + describeConnector( args: DescribeConnectorCommandInput, cb: (err: any, data?: DescribeConnectorCommandOutput) => void ): void; - public describeConnector( + describeConnector( args: DescribeConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectorCommandOutput) => void ): void; - public describeConnector( - args: DescribeConnectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConnectorCommandOutput) => void), - cb?: (err: any, data?: DescribeConnectorCommandOutput) => void - ): Promise | void { - const command = new DescribeConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A summary description of the custom plugin.

+ * @see {@link DescribeCustomPluginCommand} */ - public describeCustomPlugin( + describeCustomPlugin( args: DescribeCustomPluginCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCustomPlugin( + describeCustomPlugin( args: DescribeCustomPluginCommandInput, cb: (err: any, data?: DescribeCustomPluginCommandOutput) => void ): void; - public describeCustomPlugin( + describeCustomPlugin( args: DescribeCustomPluginCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCustomPluginCommandOutput) => void ): void; - public describeCustomPlugin( - args: DescribeCustomPluginCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCustomPluginCommandOutput) => void), - cb?: (err: any, data?: DescribeCustomPluginCommandOutput) => void - ): Promise | void { - const command = new DescribeCustomPluginCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a worker configuration.

+ * @see {@link DescribeWorkerConfigurationCommand} */ - public describeWorkerConfiguration( + describeWorkerConfiguration( args: DescribeWorkerConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWorkerConfiguration( + describeWorkerConfiguration( args: DescribeWorkerConfigurationCommandInput, cb: (err: any, data?: DescribeWorkerConfigurationCommandOutput) => void ): void; - public describeWorkerConfiguration( + describeWorkerConfiguration( args: DescribeWorkerConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkerConfigurationCommandOutput) => void ): void; - public describeWorkerConfiguration( - args: DescribeWorkerConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWorkerConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeWorkerConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeWorkerConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all the connectors in this account and Region. The list is limited to - * connectors whose name starts with the specified prefix. The response also includes a - * description of each of the listed connectors.

+ * @see {@link ListConnectorsCommand} */ - public listConnectors( + listConnectors( args: ListConnectorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConnectors( - args: ListConnectorsCommandInput, - cb: (err: any, data?: ListConnectorsCommandOutput) => void - ): void; - public listConnectors( + listConnectors(args: ListConnectorsCommandInput, cb: (err: any, data?: ListConnectorsCommandOutput) => void): void; + listConnectors( args: ListConnectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConnectorsCommandOutput) => void ): void; - public listConnectors( - args: ListConnectorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConnectorsCommandOutput) => void), - cb?: (err: any, data?: ListConnectorsCommandOutput) => void - ): Promise | void { - const command = new ListConnectorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all of the custom plugins in this account and Region.

+ * @see {@link ListCustomPluginsCommand} */ - public listCustomPlugins( + listCustomPlugins( args: ListCustomPluginsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCustomPlugins( + listCustomPlugins( args: ListCustomPluginsCommandInput, cb: (err: any, data?: ListCustomPluginsCommandOutput) => void ): void; - public listCustomPlugins( + listCustomPlugins( args: ListCustomPluginsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCustomPluginsCommandOutput) => void ): void; - public listCustomPlugins( - args: ListCustomPluginsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCustomPluginsCommandOutput) => void), - cb?: (err: any, data?: ListCustomPluginsCommandOutput) => void - ): Promise | void { - const command = new ListCustomPluginsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all of the worker configurations in this account and Region.

+ * @see {@link ListWorkerConfigurationsCommand} */ - public listWorkerConfigurations( + listWorkerConfigurations( args: ListWorkerConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWorkerConfigurations( + listWorkerConfigurations( args: ListWorkerConfigurationsCommandInput, cb: (err: any, data?: ListWorkerConfigurationsCommandOutput) => void ): void; - public listWorkerConfigurations( + listWorkerConfigurations( args: ListWorkerConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkerConfigurationsCommandOutput) => void ): void; - public listWorkerConfigurations( - args: ListWorkerConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkerConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListWorkerConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListWorkerConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified connector.

+ * @see {@link UpdateConnectorCommand} */ - public updateConnector( + updateConnector( args: UpdateConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConnector( - args: UpdateConnectorCommandInput, - cb: (err: any, data?: UpdateConnectorCommandOutput) => void - ): void; - public updateConnector( + updateConnector(args: UpdateConnectorCommandInput, cb: (err: any, data?: UpdateConnectorCommandOutput) => void): void; + updateConnector( args: UpdateConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectorCommandOutput) => void ): void; - public updateConnector( - args: UpdateConnectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConnectorCommandOutput) => void), - cb?: (err: any, data?: UpdateConnectorCommandOutput) => void - ): Promise | void { - const command = new UpdateConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

+ */ +export class KafkaConnect extends KafkaConnectClient implements KafkaConnect {} +createAggregatedClient(commands, KafkaConnect); diff --git a/clients/client-kendra-ranking/src/KendraRanking.ts b/clients/client-kendra-ranking/src/KendraRanking.ts index 65c3c3ec04d3..30d7a123bfbb 100644 --- a/clients/client-kendra-ranking/src/KendraRanking.ts +++ b/clients/client-kendra-ranking/src/KendraRanking.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -38,329 +39,162 @@ import { UpdateRescoreExecutionPlanCommandInput, UpdateRescoreExecutionPlanCommandOutput, } from "./commands/UpdateRescoreExecutionPlanCommand"; -import { KendraRankingClient } from "./KendraRankingClient"; +import { KendraRankingClient, KendraRankingClientConfig } from "./KendraRankingClient"; -/** - * @public - *

Amazon Kendra Intelligent Ranking uses Amazon Kendra - * semantic search capabilities to intelligently re-rank a search - * service's results.

- */ -export class KendraRanking extends KendraRankingClient { +const commands = { + CreateRescoreExecutionPlanCommand, + DeleteRescoreExecutionPlanCommand, + DescribeRescoreExecutionPlanCommand, + ListRescoreExecutionPlansCommand, + ListTagsForResourceCommand, + RescoreCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateRescoreExecutionPlanCommand, +}; + +export interface KendraRanking { /** - * @public - *

Creates a rescore execution plan. A rescore execution - * plan is an Amazon Kendra Intelligent Ranking resource - * used for provisioning the Rescore API. You set - * the number of capacity units that you require for - * Amazon Kendra Intelligent Ranking to rescore or re-rank - * a search service's results.

- *

For an example of using the - * CreateRescoreExecutionPlan API, including using - * the Python and Java SDKs, see Semantically - * ranking a search service's results.

+ * @see {@link CreateRescoreExecutionPlanCommand} */ - public createRescoreExecutionPlan( + createRescoreExecutionPlan( args: CreateRescoreExecutionPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRescoreExecutionPlan( + createRescoreExecutionPlan( args: CreateRescoreExecutionPlanCommandInput, cb: (err: any, data?: CreateRescoreExecutionPlanCommandOutput) => void ): void; - public createRescoreExecutionPlan( + createRescoreExecutionPlan( args: CreateRescoreExecutionPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRescoreExecutionPlanCommandOutput) => void ): void; - public createRescoreExecutionPlan( - args: CreateRescoreExecutionPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRescoreExecutionPlanCommandOutput) => void), - cb?: (err: any, data?: CreateRescoreExecutionPlanCommandOutput) => void - ): Promise | void { - const command = new CreateRescoreExecutionPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a rescore execution plan. A rescore execution - * plan is an Amazon Kendra Intelligent Ranking resource - * used for provisioning the Rescore API.

+ * @see {@link DeleteRescoreExecutionPlanCommand} */ - public deleteRescoreExecutionPlan( + deleteRescoreExecutionPlan( args: DeleteRescoreExecutionPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRescoreExecutionPlan( + deleteRescoreExecutionPlan( args: DeleteRescoreExecutionPlanCommandInput, cb: (err: any, data?: DeleteRescoreExecutionPlanCommandOutput) => void ): void; - public deleteRescoreExecutionPlan( + deleteRescoreExecutionPlan( args: DeleteRescoreExecutionPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRescoreExecutionPlanCommandOutput) => void ): void; - public deleteRescoreExecutionPlan( - args: DeleteRescoreExecutionPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRescoreExecutionPlanCommandOutput) => void), - cb?: (err: any, data?: DeleteRescoreExecutionPlanCommandOutput) => void - ): Promise | void { - const command = new DeleteRescoreExecutionPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a rescore execution plan. A rescore - * execution plan is an Amazon Kendra Intelligent Ranking - * resource used for provisioning the Rescore API.

+ * @see {@link DescribeRescoreExecutionPlanCommand} */ - public describeRescoreExecutionPlan( + describeRescoreExecutionPlan( args: DescribeRescoreExecutionPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRescoreExecutionPlan( + describeRescoreExecutionPlan( args: DescribeRescoreExecutionPlanCommandInput, cb: (err: any, data?: DescribeRescoreExecutionPlanCommandOutput) => void ): void; - public describeRescoreExecutionPlan( + describeRescoreExecutionPlan( args: DescribeRescoreExecutionPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRescoreExecutionPlanCommandOutput) => void ): void; - public describeRescoreExecutionPlan( - args: DescribeRescoreExecutionPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRescoreExecutionPlanCommandOutput) => void), - cb?: (err: any, data?: DescribeRescoreExecutionPlanCommandOutput) => void - ): Promise | void { - const command = new DescribeRescoreExecutionPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists your rescore execution plans. A rescore execution plan - * is an Amazon Kendra Intelligent Ranking resource used for - * provisioning the Rescore API.

+ * @see {@link ListRescoreExecutionPlansCommand} */ - public listRescoreExecutionPlans( + listRescoreExecutionPlans( args: ListRescoreExecutionPlansCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRescoreExecutionPlans( + listRescoreExecutionPlans( args: ListRescoreExecutionPlansCommandInput, cb: (err: any, data?: ListRescoreExecutionPlansCommandOutput) => void ): void; - public listRescoreExecutionPlans( + listRescoreExecutionPlans( args: ListRescoreExecutionPlansCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRescoreExecutionPlansCommandOutput) => void ): void; - public listRescoreExecutionPlans( - args: ListRescoreExecutionPlansCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRescoreExecutionPlansCommandOutput) => void), - cb?: (err: any, data?: ListRescoreExecutionPlansCommandOutput) => void - ): Promise | void { - const command = new ListRescoreExecutionPlansCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of tags associated with a specified resource. - * A rescore execution plan is an example of a resource that - * can have tags associated with it.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Rescores or re-ranks search results from a search service - * such as OpenSearch (self managed). You use the semantic search - * capabilities of Amazon Kendra Intelligent Ranking to - * improve the search service's results.

+ * @see {@link RescoreCommand} */ - public rescore(args: RescoreCommandInput, options?: __HttpHandlerOptions): Promise; - public rescore(args: RescoreCommandInput, cb: (err: any, data?: RescoreCommandOutput) => void): void; - public rescore( + rescore(args: RescoreCommandInput, options?: __HttpHandlerOptions): Promise; + rescore(args: RescoreCommandInput, cb: (err: any, data?: RescoreCommandOutput) => void): void; + rescore( args: RescoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RescoreCommandOutput) => void ): void; - public rescore( - args: RescoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RescoreCommandOutput) => void), - cb?: (err: any, data?: RescoreCommandOutput) => void - ): Promise | void { - const command = new RescoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a specified tag to a specified rescore execution - * plan. A rescore execution plan is an Amazon Kendra - * Intelligent Ranking resource used for provisioning the - * Rescore API. If the tag already exists, - * the existing value is replaced with the new value.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a tag from a rescore execution plan. A rescore - * execution plan is an Amazon Kendra Intelligent - * Ranking resource used for provisioning the - * Rescore operation.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a rescore execution plan. A rescore execution plan - * is an Amazon Kendra Intelligent Ranking resource used for - * provisioning the Rescore API. You can update the - * number of capacity units you require for Amazon Kendra - * Intelligent Ranking to rescore or re-rank a search service's - * results.

+ * @see {@link UpdateRescoreExecutionPlanCommand} */ - public updateRescoreExecutionPlan( + updateRescoreExecutionPlan( args: UpdateRescoreExecutionPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRescoreExecutionPlan( + updateRescoreExecutionPlan( args: UpdateRescoreExecutionPlanCommandInput, cb: (err: any, data?: UpdateRescoreExecutionPlanCommandOutput) => void ): void; - public updateRescoreExecutionPlan( + updateRescoreExecutionPlan( args: UpdateRescoreExecutionPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRescoreExecutionPlanCommandOutput) => void ): void; - public updateRescoreExecutionPlan( - args: UpdateRescoreExecutionPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRescoreExecutionPlanCommandOutput) => void), - cb?: (err: any, data?: UpdateRescoreExecutionPlanCommandOutput) => void - ): Promise | void { - const command = new UpdateRescoreExecutionPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Kendra Intelligent Ranking uses Amazon Kendra + * semantic search capabilities to intelligently re-rank a search + * service's results.

+ */ +export class KendraRanking extends KendraRankingClient implements KendraRanking {} +createAggregatedClient(commands, KendraRanking); diff --git a/clients/client-kendra/src/Kendra.ts b/clients/client-kendra/src/Kendra.ts index d24f36370d80..3236606a51e2 100644 --- a/clients/client-kendra/src/Kendra.ts +++ b/clients/client-kendra/src/Kendra.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -286,2373 +287,1084 @@ import { UpdateThesaurusCommandInput, UpdateThesaurusCommandOutput, } from "./commands/UpdateThesaurusCommand"; -import { KendraClient } from "./KendraClient"; +import { KendraClient, KendraClientConfig } from "./KendraClient"; -/** - * @public - *

Amazon Kendra is a service for indexing large document sets.

- */ -export class Kendra extends KendraClient { +const commands = { + AssociateEntitiesToExperienceCommand, + AssociatePersonasToEntitiesCommand, + BatchDeleteDocumentCommand, + BatchDeleteFeaturedResultsSetCommand, + BatchGetDocumentStatusCommand, + BatchPutDocumentCommand, + ClearQuerySuggestionsCommand, + CreateAccessControlConfigurationCommand, + CreateDataSourceCommand, + CreateExperienceCommand, + CreateFaqCommand, + CreateFeaturedResultsSetCommand, + CreateIndexCommand, + CreateQuerySuggestionsBlockListCommand, + CreateThesaurusCommand, + DeleteAccessControlConfigurationCommand, + DeleteDataSourceCommand, + DeleteExperienceCommand, + DeleteFaqCommand, + DeleteIndexCommand, + DeletePrincipalMappingCommand, + DeleteQuerySuggestionsBlockListCommand, + DeleteThesaurusCommand, + DescribeAccessControlConfigurationCommand, + DescribeDataSourceCommand, + DescribeExperienceCommand, + DescribeFaqCommand, + DescribeFeaturedResultsSetCommand, + DescribeIndexCommand, + DescribePrincipalMappingCommand, + DescribeQuerySuggestionsBlockListCommand, + DescribeQuerySuggestionsConfigCommand, + DescribeThesaurusCommand, + DisassociateEntitiesFromExperienceCommand, + DisassociatePersonasFromEntitiesCommand, + GetQuerySuggestionsCommand, + GetSnapshotsCommand, + ListAccessControlConfigurationsCommand, + ListDataSourcesCommand, + ListDataSourceSyncJobsCommand, + ListEntityPersonasCommand, + ListExperienceEntitiesCommand, + ListExperiencesCommand, + ListFaqsCommand, + ListFeaturedResultsSetsCommand, + ListGroupsOlderThanOrderingIdCommand, + ListIndicesCommand, + ListQuerySuggestionsBlockListsCommand, + ListTagsForResourceCommand, + ListThesauriCommand, + PutPrincipalMappingCommand, + QueryCommand, + StartDataSourceSyncJobCommand, + StopDataSourceSyncJobCommand, + SubmitFeedbackCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAccessControlConfigurationCommand, + UpdateDataSourceCommand, + UpdateExperienceCommand, + UpdateFeaturedResultsSetCommand, + UpdateIndexCommand, + UpdateQuerySuggestionsBlockListCommand, + UpdateQuerySuggestionsConfigCommand, + UpdateThesaurusCommand, +}; + +export interface Kendra { /** - * @public - *

Grants users or groups in your IAM Identity Center identity source access - * to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a - * search application. For more information on creating a search application - * experience, see Building - * a search experience with no code.

+ * @see {@link AssociateEntitiesToExperienceCommand} */ - public associateEntitiesToExperience( + associateEntitiesToExperience( args: AssociateEntitiesToExperienceCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateEntitiesToExperience( + associateEntitiesToExperience( args: AssociateEntitiesToExperienceCommandInput, cb: (err: any, data?: AssociateEntitiesToExperienceCommandOutput) => void ): void; - public associateEntitiesToExperience( + associateEntitiesToExperience( args: AssociateEntitiesToExperienceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateEntitiesToExperienceCommandOutput) => void ): void; - public associateEntitiesToExperience( - args: AssociateEntitiesToExperienceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateEntitiesToExperienceCommandOutput) => void), - cb?: (err: any, data?: AssociateEntitiesToExperienceCommandOutput) => void - ): Promise | void { - const command = new AssociateEntitiesToExperienceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Defines the specific permissions of users or groups in your IAM Identity Center - * identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra - * experience such as a search application. For more information on creating a - * search application experience, see Building - * a search experience with no code.

- */ - public associatePersonasToEntities( + + /** + * @see {@link AssociatePersonasToEntitiesCommand} + */ + associatePersonasToEntities( args: AssociatePersonasToEntitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public associatePersonasToEntities( + associatePersonasToEntities( args: AssociatePersonasToEntitiesCommandInput, cb: (err: any, data?: AssociatePersonasToEntitiesCommandOutput) => void ): void; - public associatePersonasToEntities( + associatePersonasToEntities( args: AssociatePersonasToEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociatePersonasToEntitiesCommandOutput) => void ): void; - public associatePersonasToEntities( - args: AssociatePersonasToEntitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociatePersonasToEntitiesCommandOutput) => void), - cb?: (err: any, data?: AssociatePersonasToEntitiesCommandOutput) => void - ): Promise | void { - const command = new AssociatePersonasToEntitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes one or more documents from an index. The documents must have been added with - * the BatchPutDocument API.

- *

The documents are deleted asynchronously. You can see the progress of the deletion by - * using Amazon Web Services CloudWatch. Any error messages related to the processing of the - * batch are sent to you CloudWatch log.

- */ - public batchDeleteDocument( + + /** + * @see {@link BatchDeleteDocumentCommand} + */ + batchDeleteDocument( args: BatchDeleteDocumentCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeleteDocument( + batchDeleteDocument( args: BatchDeleteDocumentCommandInput, cb: (err: any, data?: BatchDeleteDocumentCommandOutput) => void ): void; - public batchDeleteDocument( + batchDeleteDocument( args: BatchDeleteDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteDocumentCommandOutput) => void ): void; - public batchDeleteDocument( - args: BatchDeleteDocumentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeleteDocumentCommandOutput) => void), - cb?: (err: any, data?: BatchDeleteDocumentCommandOutput) => void - ): Promise | void { - const command = new BatchDeleteDocumentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes one or more sets of featured results. Features results are placed - * above all other results for certain queries. If there's an exact match of a - * query, then one or more specific documents are featured in the search results.

- */ - public batchDeleteFeaturedResultsSet( + + /** + * @see {@link BatchDeleteFeaturedResultsSetCommand} + */ + batchDeleteFeaturedResultsSet( args: BatchDeleteFeaturedResultsSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeleteFeaturedResultsSet( + batchDeleteFeaturedResultsSet( args: BatchDeleteFeaturedResultsSetCommandInput, cb: (err: any, data?: BatchDeleteFeaturedResultsSetCommandOutput) => void ): void; - public batchDeleteFeaturedResultsSet( + batchDeleteFeaturedResultsSet( args: BatchDeleteFeaturedResultsSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteFeaturedResultsSetCommandOutput) => void ): void; - public batchDeleteFeaturedResultsSet( - args: BatchDeleteFeaturedResultsSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeleteFeaturedResultsSetCommandOutput) => void), - cb?: (err: any, data?: BatchDeleteFeaturedResultsSetCommandOutput) => void - ): Promise | void { - const command = new BatchDeleteFeaturedResultsSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the indexing status for one or more documents submitted with the - * BatchPutDocument API.

- *

When you use the BatchPutDocument API, documents are indexed - * asynchronously. You can use the BatchGetDocumentStatus API to get the - * current status of a list of documents so that you can determine if they have been - * successfully indexed.

- *

You can also use the BatchGetDocumentStatus API to check the status of - * the - * BatchDeleteDocument API. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.

- */ - public batchGetDocumentStatus( + + /** + * @see {@link BatchGetDocumentStatusCommand} + */ + batchGetDocumentStatus( args: BatchGetDocumentStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetDocumentStatus( + batchGetDocumentStatus( args: BatchGetDocumentStatusCommandInput, cb: (err: any, data?: BatchGetDocumentStatusCommandOutput) => void ): void; - public batchGetDocumentStatus( + batchGetDocumentStatus( args: BatchGetDocumentStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetDocumentStatusCommandOutput) => void ): void; - public batchGetDocumentStatus( - args: BatchGetDocumentStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetDocumentStatusCommandOutput) => void), - cb?: (err: any, data?: BatchGetDocumentStatusCommandOutput) => void - ): Promise | void { - const command = new BatchGetDocumentStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds one or more documents to an index.

- *

The BatchPutDocument API enables you to ingest inline documents or a set - * of documents stored in an Amazon S3 bucket. Use this API to ingest your text and - * unstructured text into an index, add custom attributes to the documents, and to attach - * an access control list to the documents added to the index.

- *

The documents are indexed asynchronously. You can see the progress of the batch using - * Amazon Web Services - * CloudWatch. Any error messages related to processing the batch are sent to your - * Amazon Web Services - * CloudWatch log.

- *

For an example of ingesting inline documents using Python and Java SDKs, see Adding files - * directly to an index.

- */ - public batchPutDocument( + + /** + * @see {@link BatchPutDocumentCommand} + */ + batchPutDocument( args: BatchPutDocumentCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchPutDocument( + batchPutDocument( args: BatchPutDocumentCommandInput, cb: (err: any, data?: BatchPutDocumentCommandOutput) => void ): void; - public batchPutDocument( + batchPutDocument( args: BatchPutDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchPutDocumentCommandOutput) => void ): void; - public batchPutDocument( - args: BatchPutDocumentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchPutDocumentCommandOutput) => void), - cb?: (err: any, data?: BatchPutDocumentCommandOutput) => void - ): Promise | void { - const command = new BatchPutDocumentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Clears existing query suggestions from an index.

- *

This deletes existing suggestions only, not the queries - * in the query log. After you clear suggestions, Amazon Kendra learns - * new suggestions based on new queries added to the query log - * from the time you cleared suggestions. If you do not see any - * new suggestions, then please allow Amazon Kendra to collect - * enough queries to learn new suggestions.

- *

- * ClearQuerySuggestions is currently not supported in the - * Amazon Web Services GovCloud (US-West) region.

- */ - public clearQuerySuggestions( + + /** + * @see {@link ClearQuerySuggestionsCommand} + */ + clearQuerySuggestions( args: ClearQuerySuggestionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public clearQuerySuggestions( + clearQuerySuggestions( args: ClearQuerySuggestionsCommandInput, cb: (err: any, data?: ClearQuerySuggestionsCommandOutput) => void ): void; - public clearQuerySuggestions( + clearQuerySuggestions( args: ClearQuerySuggestionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ClearQuerySuggestionsCommandOutput) => void ): void; - public clearQuerySuggestions( - args: ClearQuerySuggestionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ClearQuerySuggestionsCommandOutput) => void), - cb?: (err: any, data?: ClearQuerySuggestionsCommandOutput) => void - ): Promise | void { - const command = new ClearQuerySuggestionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an access configuration for your documents. This includes user and group - * access information for your documents. This is useful for user context filtering, where - * search results are filtered based on the user or their group access to documents.

- *

You can use this to re-configure your existing document level access control without - * indexing all of your documents again. For example, your index contains top-secret - * company documents that only certain employees or users should access. One of these users - * leaves the company or switches to a team that should be blocked from accessing - * top-secret documents. The user still has access to top-secret documents because the user - * had access when your documents were previously indexed. You can create a specific access - * control configuration for the user with deny access. You can later update the access - * control configuration to allow access if the user returns to the company and re-joins - * the 'top-secret' team. You can re-configure access control for your documents as - * circumstances change.

- *

To apply your access control configuration to certain documents, you call the BatchPutDocument API with the AccessControlConfigurationId - * included in the Document object. If you use an S3 bucket as a data source, you update the - * .metadata.json with the AccessControlConfigurationId and - * synchronize your data source. Amazon Kendra currently only supports access control - * configuration for S3 data sources and documents indexed using the - * BatchPutDocument API.

- */ - public createAccessControlConfiguration( + + /** + * @see {@link CreateAccessControlConfigurationCommand} + */ + createAccessControlConfiguration( args: CreateAccessControlConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAccessControlConfiguration( + createAccessControlConfiguration( args: CreateAccessControlConfigurationCommandInput, cb: (err: any, data?: CreateAccessControlConfigurationCommandOutput) => void ): void; - public createAccessControlConfiguration( + createAccessControlConfiguration( args: CreateAccessControlConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessControlConfigurationCommandOutput) => void ): void; - public createAccessControlConfiguration( - args: CreateAccessControlConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAccessControlConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateAccessControlConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateAccessControlConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a data source connector that you want to use with an Amazon Kendra - * index.

- *

You specify a name, data source connector type and description for your data source. You - * also specify configuration information for the data source connector.

- *

- * CreateDataSource is a synchronous operation. The operation returns 200 if the - * data source was successfully created. Otherwise, an exception is raised.

- *

For an example of creating an index and data source using the Python SDK, see Getting started with Python - * SDK. For an example of creating an index and data source using the Java SDK, see - * Getting started with Java - * SDK.

- */ - public createDataSource( + + /** + * @see {@link CreateDataSourceCommand} + */ + createDataSource( args: CreateDataSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDataSource( + createDataSource( args: CreateDataSourceCommandInput, cb: (err: any, data?: CreateDataSourceCommandOutput) => void ): void; - public createDataSource( + createDataSource( args: CreateDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataSourceCommandOutput) => void ): void; - public createDataSource( - args: CreateDataSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDataSourceCommandOutput) => void), - cb?: (err: any, data?: CreateDataSourceCommandOutput) => void - ): Promise | void { - const command = new CreateDataSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon Kendra experience such as a search application. For more information - * on creating a search application experience, including using the Python and Java SDKs, - * see Building a - * search experience with no code.

- */ - public createExperience( + + /** + * @see {@link CreateExperienceCommand} + */ + createExperience( args: CreateExperienceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createExperience( + createExperience( args: CreateExperienceCommandInput, cb: (err: any, data?: CreateExperienceCommandOutput) => void ): void; - public createExperience( + createExperience( args: CreateExperienceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExperienceCommandOutput) => void ): void; - public createExperience( - args: CreateExperienceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateExperienceCommandOutput) => void), - cb?: (err: any, data?: CreateExperienceCommandOutput) => void - ): Promise | void { - const command = new CreateExperienceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored - * in an Amazon S3 bucket.

- *

Adding FAQs to an index is an asynchronous operation.

- *

For an example of adding an FAQ to an index using Python and Java SDKs, see Using your FAQ file.

- */ - public createFaq(args: CreateFaqCommandInput, options?: __HttpHandlerOptions): Promise; - public createFaq(args: CreateFaqCommandInput, cb: (err: any, data?: CreateFaqCommandOutput) => void): void; - public createFaq( + + /** + * @see {@link CreateFaqCommand} + */ + createFaq(args: CreateFaqCommandInput, options?: __HttpHandlerOptions): Promise; + createFaq(args: CreateFaqCommandInput, cb: (err: any, data?: CreateFaqCommandOutput) => void): void; + createFaq( args: CreateFaqCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFaqCommandOutput) => void ): void; - public createFaq( - args: CreateFaqCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFaqCommandOutput) => void), - cb?: (err: any, data?: CreateFaqCommandOutput) => void - ): Promise | void { - const command = new CreateFaqCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a set of featured results to display at the top of the search results page. - * Featured results are placed above all other results for certain queries. You map - * specific queries to specific documents for featuring in the results. If a query - * contains an exact match, then one or more specific documents are featured in the - * search results.

- *

You can create up to 50 sets of featured results per index. You can request to - * increase this limit by contacting Support.

- */ - public createFeaturedResultsSet( + + /** + * @see {@link CreateFeaturedResultsSetCommand} + */ + createFeaturedResultsSet( args: CreateFeaturedResultsSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFeaturedResultsSet( + createFeaturedResultsSet( args: CreateFeaturedResultsSetCommandInput, cb: (err: any, data?: CreateFeaturedResultsSetCommandOutput) => void ): void; - public createFeaturedResultsSet( + createFeaturedResultsSet( args: CreateFeaturedResultsSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFeaturedResultsSetCommandOutput) => void ): void; - public createFeaturedResultsSet( - args: CreateFeaturedResultsSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFeaturedResultsSetCommandOutput) => void), - cb?: (err: any, data?: CreateFeaturedResultsSetCommandOutput) => void - ): Promise | void { - const command = new CreateFeaturedResultsSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine - * if index creation has completed, check the Status field returned from a call to - * DescribeIndex. The Status field is set to ACTIVE when - * the index is ready to use.

- *

Once the index is active you can index your documents using the - * BatchPutDocument API or using one of the supported data sources.

- *

For an example of creating an index and data source using the Python SDK, see Getting started with Python - * SDK. For an example of creating an index and data source using the Java SDK, see - * Getting started with Java - * SDK.

- */ - public createIndex(args: CreateIndexCommandInput, options?: __HttpHandlerOptions): Promise; - public createIndex(args: CreateIndexCommandInput, cb: (err: any, data?: CreateIndexCommandOutput) => void): void; - public createIndex( + + /** + * @see {@link CreateIndexCommand} + */ + createIndex(args: CreateIndexCommandInput, options?: __HttpHandlerOptions): Promise; + createIndex(args: CreateIndexCommandInput, cb: (err: any, data?: CreateIndexCommandOutput) => void): void; + createIndex( args: CreateIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIndexCommandOutput) => void ): void; - public createIndex( - args: CreateIndexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIndexCommandOutput) => void), - cb?: (err: any, data?: CreateIndexCommandOutput) => void - ): Promise | void { - const command = new CreateIndexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a block list to exlcude certain queries from suggestions.

- *

Any query that contains words or phrases specified in the block - * list is blocked or filtered out from being shown as a suggestion.

- *

You need to provide the file location of your block list text file - * in your S3 bucket. In your text file, enter each block word or phrase - * on a separate line.

- *

For information on the current quota limits for block lists, see - * Quotas - * for Amazon Kendra.

- *

- * CreateQuerySuggestionsBlockList is currently not supported in the - * Amazon Web Services GovCloud (US-West) region.

- *

For an example of creating a block list for query suggestions using the - * Python SDK, see Query - * suggestions block list.

- */ - public createQuerySuggestionsBlockList( + + /** + * @see {@link CreateQuerySuggestionsBlockListCommand} + */ + createQuerySuggestionsBlockList( args: CreateQuerySuggestionsBlockListCommandInput, options?: __HttpHandlerOptions ): Promise; - public createQuerySuggestionsBlockList( + createQuerySuggestionsBlockList( args: CreateQuerySuggestionsBlockListCommandInput, cb: (err: any, data?: CreateQuerySuggestionsBlockListCommandOutput) => void ): void; - public createQuerySuggestionsBlockList( + createQuerySuggestionsBlockList( args: CreateQuerySuggestionsBlockListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateQuerySuggestionsBlockListCommandOutput) => void ): void; - public createQuerySuggestionsBlockList( - args: CreateQuerySuggestionsBlockListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateQuerySuggestionsBlockListCommandOutput) => void), - cb?: (err: any, data?: CreateQuerySuggestionsBlockListCommandOutput) => void - ): Promise | void { - const command = new CreateQuerySuggestionsBlockListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a thesaurus for an index. The thesaurus - * contains a list of synonyms in Solr format.

- *

For an example of adding a thesaurus file to an index, see - * Adding - * custom synonyms to an index.

- */ - public createThesaurus( + + /** + * @see {@link CreateThesaurusCommand} + */ + createThesaurus( args: CreateThesaurusCommandInput, options?: __HttpHandlerOptions ): Promise; - public createThesaurus( - args: CreateThesaurusCommandInput, - cb: (err: any, data?: CreateThesaurusCommandOutput) => void - ): void; - public createThesaurus( + createThesaurus(args: CreateThesaurusCommandInput, cb: (err: any, data?: CreateThesaurusCommandOutput) => void): void; + createThesaurus( args: CreateThesaurusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateThesaurusCommandOutput) => void ): void; - public createThesaurus( - args: CreateThesaurusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateThesaurusCommandOutput) => void), - cb?: (err: any, data?: CreateThesaurusCommandOutput) => void - ): Promise | void { - const command = new CreateThesaurusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an access control configuration that you created for your documents in an - * index. This includes user and group access information for your documents. This is - * useful for user context filtering, where search results are filtered based on the user - * or their group access to documents.

- */ - public deleteAccessControlConfiguration( + + /** + * @see {@link DeleteAccessControlConfigurationCommand} + */ + deleteAccessControlConfiguration( args: DeleteAccessControlConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAccessControlConfiguration( + deleteAccessControlConfiguration( args: DeleteAccessControlConfigurationCommandInput, cb: (err: any, data?: DeleteAccessControlConfigurationCommandOutput) => void ): void; - public deleteAccessControlConfiguration( + deleteAccessControlConfiguration( args: DeleteAccessControlConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessControlConfigurationCommandOutput) => void ): void; - public deleteAccessControlConfiguration( - args: DeleteAccessControlConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAccessControlConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteAccessControlConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteAccessControlConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an Amazon Kendra data source connector. An exception is not thrown if the - * data source is already being deleted. While the data source is being deleted, the - * Status field returned by a call to the DescribeDataSource API is - * set to DELETING. For more information, see Deleting Data Sources.

- */ - public deleteDataSource( + + /** + * @see {@link DeleteDataSourceCommand} + */ + deleteDataSource( args: DeleteDataSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDataSource( + deleteDataSource( args: DeleteDataSourceCommandInput, cb: (err: any, data?: DeleteDataSourceCommandOutput) => void ): void; - public deleteDataSource( + deleteDataSource( args: DeleteDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataSourceCommandOutput) => void ): void; - public deleteDataSource( - args: DeleteDataSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDataSourceCommandOutput) => void), - cb?: (err: any, data?: DeleteDataSourceCommandOutput) => void - ): Promise | void { - const command = new DeleteDataSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes your Amazon Kendra experience such as a search application. For more information on - * creating a search application experience, see Building a search - * experience with no code.

- */ - public deleteExperience( + + /** + * @see {@link DeleteExperienceCommand} + */ + deleteExperience( args: DeleteExperienceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteExperience( + deleteExperience( args: DeleteExperienceCommandInput, cb: (err: any, data?: DeleteExperienceCommandOutput) => void ): void; - public deleteExperience( + deleteExperience( args: DeleteExperienceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteExperienceCommandOutput) => void ): void; - public deleteExperience( - args: DeleteExperienceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteExperienceCommandOutput) => void), - cb?: (err: any, data?: DeleteExperienceCommandOutput) => void - ): Promise | void { - const command = new DeleteExperienceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes an FAQ from an index.

- */ - public deleteFaq(args: DeleteFaqCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteFaq(args: DeleteFaqCommandInput, cb: (err: any, data?: DeleteFaqCommandOutput) => void): void; - public deleteFaq( + + /** + * @see {@link DeleteFaqCommand} + */ + deleteFaq(args: DeleteFaqCommandInput, options?: __HttpHandlerOptions): Promise; + deleteFaq(args: DeleteFaqCommandInput, cb: (err: any, data?: DeleteFaqCommandOutput) => void): void; + deleteFaq( args: DeleteFaqCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFaqCommandOutput) => void ): void; - public deleteFaq( - args: DeleteFaqCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFaqCommandOutput) => void), - cb?: (err: any, data?: DeleteFaqCommandOutput) => void - ): Promise | void { - const command = new DeleteFaqCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an existing Amazon Kendra index. An exception is not thrown if the index is - * already being deleted. While the index is being deleted, the Status field - * returned by a call to the DescribeIndex API is set to - * DELETING.

- */ - public deleteIndex(args: DeleteIndexCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteIndex(args: DeleteIndexCommandInput, cb: (err: any, data?: DeleteIndexCommandOutput) => void): void; - public deleteIndex( + + /** + * @see {@link DeleteIndexCommand} + */ + deleteIndex(args: DeleteIndexCommandInput, options?: __HttpHandlerOptions): Promise; + deleteIndex(args: DeleteIndexCommandInput, cb: (err: any, data?: DeleteIndexCommandOutput) => void): void; + deleteIndex( args: DeleteIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIndexCommandOutput) => void ): void; - public deleteIndex( - args: DeleteIndexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIndexCommandOutput) => void), - cb?: (err: any, data?: DeleteIndexCommandOutput) => void - ): Promise | void { - const command = new DeleteIndexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a group so that all users and sub groups that belong to the group can no - * longer access documents only available to that group.

- *

For example, after deleting the group "Summer Interns", all interns who belonged to - * that group no longer see intern-only documents in their search results.

- *

If you want to delete or replace users or sub groups of a group, you need to use the - * PutPrincipalMapping operation. For example, if a user in the group - * "Engineering" leaves the engineering team and another user takes their place, you - * provide an updated list of users or sub groups that belong to the "Engineering" group - * when calling PutPrincipalMapping. You can update your internal list of - * users or sub groups and input this list when calling - * PutPrincipalMapping.

- *

- * DeletePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.

- */ - public deletePrincipalMapping( + + /** + * @see {@link DeletePrincipalMappingCommand} + */ + deletePrincipalMapping( args: DeletePrincipalMappingCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePrincipalMapping( + deletePrincipalMapping( args: DeletePrincipalMappingCommandInput, cb: (err: any, data?: DeletePrincipalMappingCommandOutput) => void ): void; - public deletePrincipalMapping( + deletePrincipalMapping( args: DeletePrincipalMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePrincipalMappingCommandOutput) => void ): void; - public deletePrincipalMapping( - args: DeletePrincipalMappingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePrincipalMappingCommandOutput) => void), - cb?: (err: any, data?: DeletePrincipalMappingCommandOutput) => void - ): Promise | void { - const command = new DeletePrincipalMappingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a block list used for query suggestions for an index.

- *

A deleted block list might not take effect right away. Amazon Kendra - * needs to refresh the entire suggestions list to add back the - * queries that were previously blocked.

- *

- * DeleteQuerySuggestionsBlockList is currently not supported in the - * Amazon Web Services GovCloud (US-West) region.

- */ - public deleteQuerySuggestionsBlockList( + + /** + * @see {@link DeleteQuerySuggestionsBlockListCommand} + */ + deleteQuerySuggestionsBlockList( args: DeleteQuerySuggestionsBlockListCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteQuerySuggestionsBlockList( + deleteQuerySuggestionsBlockList( args: DeleteQuerySuggestionsBlockListCommandInput, cb: (err: any, data?: DeleteQuerySuggestionsBlockListCommandOutput) => void ): void; - public deleteQuerySuggestionsBlockList( + deleteQuerySuggestionsBlockList( args: DeleteQuerySuggestionsBlockListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteQuerySuggestionsBlockListCommandOutput) => void ): void; - public deleteQuerySuggestionsBlockList( - args: DeleteQuerySuggestionsBlockListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteQuerySuggestionsBlockListCommandOutput) => void), - cb?: (err: any, data?: DeleteQuerySuggestionsBlockListCommandOutput) => void - ): Promise | void { - const command = new DeleteQuerySuggestionsBlockListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an existing Amazon Kendra thesaurus. - *

- */ - public deleteThesaurus( + + /** + * @see {@link DeleteThesaurusCommand} + */ + deleteThesaurus( args: DeleteThesaurusCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteThesaurus( - args: DeleteThesaurusCommandInput, - cb: (err: any, data?: DeleteThesaurusCommandOutput) => void - ): void; - public deleteThesaurus( + deleteThesaurus(args: DeleteThesaurusCommandInput, cb: (err: any, data?: DeleteThesaurusCommandOutput) => void): void; + deleteThesaurus( args: DeleteThesaurusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteThesaurusCommandOutput) => void ): void; - public deleteThesaurus( - args: DeleteThesaurusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteThesaurusCommandOutput) => void), - cb?: (err: any, data?: DeleteThesaurusCommandOutput) => void - ): Promise | void { - const command = new DeleteThesaurusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about an access control configuration that you created for your - * documents in an index. This includes user and group access information for your - * documents. This is useful for user context filtering, where search results are filtered - * based on the user or their group access to documents.

- */ - public describeAccessControlConfiguration( + + /** + * @see {@link DescribeAccessControlConfigurationCommand} + */ + describeAccessControlConfiguration( args: DescribeAccessControlConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccessControlConfiguration( + describeAccessControlConfiguration( args: DescribeAccessControlConfigurationCommandInput, cb: (err: any, data?: DescribeAccessControlConfigurationCommandOutput) => void ): void; - public describeAccessControlConfiguration( + describeAccessControlConfiguration( args: DescribeAccessControlConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccessControlConfigurationCommandOutput) => void ): void; - public describeAccessControlConfiguration( - args: DescribeAccessControlConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccessControlConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeAccessControlConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeAccessControlConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about an Amazon Kendra data source connector.

- */ - public describeDataSource( + + /** + * @see {@link DescribeDataSourceCommand} + */ + describeDataSource( args: DescribeDataSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDataSource( + describeDataSource( args: DescribeDataSourceCommandInput, cb: (err: any, data?: DescribeDataSourceCommandOutput) => void ): void; - public describeDataSource( + describeDataSource( args: DescribeDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataSourceCommandOutput) => void ): void; - public describeDataSource( - args: DescribeDataSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDataSourceCommandOutput) => void), - cb?: (err: any, data?: DescribeDataSourceCommandOutput) => void - ): Promise | void { - const command = new DescribeDataSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about your Amazon Kendra experience such as a search application. - * For more information on creating a search application experience, - * see Building - * a search experience with no code.

- */ - public describeExperience( + + /** + * @see {@link DescribeExperienceCommand} + */ + describeExperience( args: DescribeExperienceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeExperience( + describeExperience( args: DescribeExperienceCommandInput, cb: (err: any, data?: DescribeExperienceCommandOutput) => void ): void; - public describeExperience( + describeExperience( args: DescribeExperienceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExperienceCommandOutput) => void ): void; - public describeExperience( - args: DescribeExperienceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeExperienceCommandOutput) => void), - cb?: (err: any, data?: DescribeExperienceCommandOutput) => void - ): Promise | void { - const command = new DescribeExperienceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about an FAQ list.

- */ - public describeFaq(args: DescribeFaqCommandInput, options?: __HttpHandlerOptions): Promise; - public describeFaq(args: DescribeFaqCommandInput, cb: (err: any, data?: DescribeFaqCommandOutput) => void): void; - public describeFaq( + + /** + * @see {@link DescribeFaqCommand} + */ + describeFaq(args: DescribeFaqCommandInput, options?: __HttpHandlerOptions): Promise; + describeFaq(args: DescribeFaqCommandInput, cb: (err: any, data?: DescribeFaqCommandOutput) => void): void; + describeFaq( args: DescribeFaqCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFaqCommandOutput) => void ): void; - public describeFaq( - args: DescribeFaqCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFaqCommandOutput) => void), - cb?: (err: any, data?: DescribeFaqCommandOutput) => void - ): Promise | void { - const command = new DescribeFaqCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a set of featured results. Features results are placed - * above all other results for certain queries. If there's an exact match of a query, - * then one or more specific documents are featured in the search results.

- */ - public describeFeaturedResultsSet( + + /** + * @see {@link DescribeFeaturedResultsSetCommand} + */ + describeFeaturedResultsSet( args: DescribeFeaturedResultsSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFeaturedResultsSet( + describeFeaturedResultsSet( args: DescribeFeaturedResultsSetCommandInput, cb: (err: any, data?: DescribeFeaturedResultsSetCommandOutput) => void ): void; - public describeFeaturedResultsSet( + describeFeaturedResultsSet( args: DescribeFeaturedResultsSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFeaturedResultsSetCommandOutput) => void ): void; - public describeFeaturedResultsSet( - args: DescribeFeaturedResultsSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFeaturedResultsSetCommandOutput) => void), - cb?: (err: any, data?: DescribeFeaturedResultsSetCommandOutput) => void - ): Promise | void { - const command = new DescribeFeaturedResultsSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about an existing Amazon Kendra index.

- */ - public describeIndex( - args: DescribeIndexCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeIndex( - args: DescribeIndexCommandInput, - cb: (err: any, data?: DescribeIndexCommandOutput) => void - ): void; - public describeIndex( + + /** + * @see {@link DescribeIndexCommand} + */ + describeIndex(args: DescribeIndexCommandInput, options?: __HttpHandlerOptions): Promise; + describeIndex(args: DescribeIndexCommandInput, cb: (err: any, data?: DescribeIndexCommandOutput) => void): void; + describeIndex( args: DescribeIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIndexCommandOutput) => void ): void; - public describeIndex( - args: DescribeIndexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeIndexCommandOutput) => void), - cb?: (err: any, data?: DescribeIndexCommandOutput) => void - ): Promise | void { - const command = new DescribeIndexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the processing of PUT and DELETE actions for - * mapping users to their groups. This includes information on the status of actions - * currently processing or yet to be processed, when actions were last updated, when - * actions were received by Amazon Kendra, the latest action that should process and - * apply after other actions, and useful error messages if an action could not be - * processed.

- *

- * DescribePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.

- */ - public describePrincipalMapping( + + /** + * @see {@link DescribePrincipalMappingCommand} + */ + describePrincipalMapping( args: DescribePrincipalMappingCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePrincipalMapping( + describePrincipalMapping( args: DescribePrincipalMappingCommandInput, cb: (err: any, data?: DescribePrincipalMappingCommandOutput) => void ): void; - public describePrincipalMapping( + describePrincipalMapping( args: DescribePrincipalMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePrincipalMappingCommandOutput) => void ): void; - public describePrincipalMapping( - args: DescribePrincipalMappingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePrincipalMappingCommandOutput) => void), - cb?: (err: any, data?: DescribePrincipalMappingCommandOutput) => void - ): Promise | void { - const command = new DescribePrincipalMappingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a block list used for query suggestions for - * an index.

- *

This is used to check the current settings that are applied to a - * block list.

- *

- * DescribeQuerySuggestionsBlockList is currently not supported in the - * Amazon Web Services GovCloud (US-West) region.

- */ - public describeQuerySuggestionsBlockList( + + /** + * @see {@link DescribeQuerySuggestionsBlockListCommand} + */ + describeQuerySuggestionsBlockList( args: DescribeQuerySuggestionsBlockListCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeQuerySuggestionsBlockList( + describeQuerySuggestionsBlockList( args: DescribeQuerySuggestionsBlockListCommandInput, cb: (err: any, data?: DescribeQuerySuggestionsBlockListCommandOutput) => void ): void; - public describeQuerySuggestionsBlockList( + describeQuerySuggestionsBlockList( args: DescribeQuerySuggestionsBlockListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeQuerySuggestionsBlockListCommandOutput) => void ): void; - public describeQuerySuggestionsBlockList( - args: DescribeQuerySuggestionsBlockListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeQuerySuggestionsBlockListCommandOutput) => void), - cb?: (err: any, data?: DescribeQuerySuggestionsBlockListCommandOutput) => void - ): Promise | void { - const command = new DescribeQuerySuggestionsBlockListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information on the settings of query suggestions for an index.

- *

This is used to check the current settings applied - * to query suggestions.

- *

- * DescribeQuerySuggestionsConfig is currently not supported in the - * Amazon Web Services GovCloud (US-West) region.

- */ - public describeQuerySuggestionsConfig( + + /** + * @see {@link DescribeQuerySuggestionsConfigCommand} + */ + describeQuerySuggestionsConfig( args: DescribeQuerySuggestionsConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeQuerySuggestionsConfig( + describeQuerySuggestionsConfig( args: DescribeQuerySuggestionsConfigCommandInput, cb: (err: any, data?: DescribeQuerySuggestionsConfigCommandOutput) => void ): void; - public describeQuerySuggestionsConfig( + describeQuerySuggestionsConfig( args: DescribeQuerySuggestionsConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeQuerySuggestionsConfigCommandOutput) => void ): void; - public describeQuerySuggestionsConfig( - args: DescribeQuerySuggestionsConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeQuerySuggestionsConfigCommandOutput) => void), - cb?: (err: any, data?: DescribeQuerySuggestionsConfigCommandOutput) => void - ): Promise | void { - const command = new DescribeQuerySuggestionsConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about an existing Amazon Kendra thesaurus.

- */ - public describeThesaurus( + + /** + * @see {@link DescribeThesaurusCommand} + */ + describeThesaurus( args: DescribeThesaurusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeThesaurus( + describeThesaurus( args: DescribeThesaurusCommandInput, cb: (err: any, data?: DescribeThesaurusCommandOutput) => void ): void; - public describeThesaurus( + describeThesaurus( args: DescribeThesaurusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeThesaurusCommandOutput) => void ): void; - public describeThesaurus( - args: DescribeThesaurusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeThesaurusCommandOutput) => void), - cb?: (err: any, data?: DescribeThesaurusCommandOutput) => void - ): Promise | void { - const command = new DescribeThesaurusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Prevents users or groups in your IAM Identity Center identity source - * from accessing your Amazon Kendra experience. You can create an Amazon Kendra experience - * such as a search application. For more information on creating a search - * application experience, see Building - * a search experience with no code.

- */ - public disassociateEntitiesFromExperience( + + /** + * @see {@link DisassociateEntitiesFromExperienceCommand} + */ + disassociateEntitiesFromExperience( args: DisassociateEntitiesFromExperienceCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateEntitiesFromExperience( + disassociateEntitiesFromExperience( args: DisassociateEntitiesFromExperienceCommandInput, cb: (err: any, data?: DisassociateEntitiesFromExperienceCommandOutput) => void ): void; - public disassociateEntitiesFromExperience( + disassociateEntitiesFromExperience( args: DisassociateEntitiesFromExperienceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateEntitiesFromExperienceCommandOutput) => void ): void; - public disassociateEntitiesFromExperience( - args: DisassociateEntitiesFromExperienceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateEntitiesFromExperienceCommandOutput) => void), - cb?: (err: any, data?: DisassociateEntitiesFromExperienceCommandOutput) => void - ): Promise | void { - const command = new DisassociateEntitiesFromExperienceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the specific permissions of users or groups in your IAM Identity Center - * identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra - * experience such as a search application. For more information on creating a - * search application experience, see Building a - * search experience with no code.

- */ - public disassociatePersonasFromEntities( + + /** + * @see {@link DisassociatePersonasFromEntitiesCommand} + */ + disassociatePersonasFromEntities( args: DisassociatePersonasFromEntitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociatePersonasFromEntities( + disassociatePersonasFromEntities( args: DisassociatePersonasFromEntitiesCommandInput, cb: (err: any, data?: DisassociatePersonasFromEntitiesCommandOutput) => void ): void; - public disassociatePersonasFromEntities( + disassociatePersonasFromEntities( args: DisassociatePersonasFromEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociatePersonasFromEntitiesCommandOutput) => void ): void; - public disassociatePersonasFromEntities( - args: DisassociatePersonasFromEntitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociatePersonasFromEntitiesCommandOutput) => void), - cb?: (err: any, data?: DisassociatePersonasFromEntitiesCommandOutput) => void - ): Promise | void { - const command = new DisassociatePersonasFromEntitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Fetches the queries that are suggested to your users.

- *

- * GetQuerySuggestions is currently not supported in the - * Amazon Web Services GovCloud (US-West) region.

- */ - public getQuerySuggestions( + + /** + * @see {@link GetQuerySuggestionsCommand} + */ + getQuerySuggestions( args: GetQuerySuggestionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getQuerySuggestions( + getQuerySuggestions( args: GetQuerySuggestionsCommandInput, cb: (err: any, data?: GetQuerySuggestionsCommandOutput) => void ): void; - public getQuerySuggestions( + getQuerySuggestions( args: GetQuerySuggestionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQuerySuggestionsCommandOutput) => void ): void; - public getQuerySuggestions( - args: GetQuerySuggestionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetQuerySuggestionsCommandOutput) => void), - cb?: (err: any, data?: GetQuerySuggestionsCommandOutput) => void - ): Promise | void { - const command = new GetQuerySuggestionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves search metrics data. The data provides a snapshot of how your users interact - * with your search application and how effective the application is.

- */ - public getSnapshots( - args: GetSnapshotsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getSnapshots(args: GetSnapshotsCommandInput, cb: (err: any, data?: GetSnapshotsCommandOutput) => void): void; - public getSnapshots( + + /** + * @see {@link GetSnapshotsCommand} + */ + getSnapshots(args: GetSnapshotsCommandInput, options?: __HttpHandlerOptions): Promise; + getSnapshots(args: GetSnapshotsCommandInput, cb: (err: any, data?: GetSnapshotsCommandOutput) => void): void; + getSnapshots( args: GetSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSnapshotsCommandOutput) => void ): void; - public getSnapshots( - args: GetSnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSnapshotsCommandOutput) => void), - cb?: (err: any, data?: GetSnapshotsCommandOutput) => void - ): Promise | void { - const command = new GetSnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists one or more access control configurations for an index. This includes user and - * group access information for your documents. This is useful for user context filtering, - * where search results are filtered based on the user or their group access to - * documents.

- */ - public listAccessControlConfigurations( + + /** + * @see {@link ListAccessControlConfigurationsCommand} + */ + listAccessControlConfigurations( args: ListAccessControlConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAccessControlConfigurations( + listAccessControlConfigurations( args: ListAccessControlConfigurationsCommandInput, cb: (err: any, data?: ListAccessControlConfigurationsCommandOutput) => void ): void; - public listAccessControlConfigurations( + listAccessControlConfigurations( args: ListAccessControlConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessControlConfigurationsCommandOutput) => void ): void; - public listAccessControlConfigurations( - args: ListAccessControlConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccessControlConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListAccessControlConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListAccessControlConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the data source connectors that you have created.

- */ - public listDataSources( + + /** + * @see {@link ListDataSourcesCommand} + */ + listDataSources( args: ListDataSourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDataSources( - args: ListDataSourcesCommandInput, - cb: (err: any, data?: ListDataSourcesCommandOutput) => void - ): void; - public listDataSources( + listDataSources(args: ListDataSourcesCommandInput, cb: (err: any, data?: ListDataSourcesCommandOutput) => void): void; + listDataSources( args: ListDataSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataSourcesCommandOutput) => void ): void; - public listDataSources( - args: ListDataSourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDataSourcesCommandOutput) => void), - cb?: (err: any, data?: ListDataSourcesCommandOutput) => void - ): Promise | void { - const command = new ListDataSourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets statistics about synchronizing a data source connector.

- */ - public listDataSourceSyncJobs( + + /** + * @see {@link ListDataSourceSyncJobsCommand} + */ + listDataSourceSyncJobs( args: ListDataSourceSyncJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDataSourceSyncJobs( + listDataSourceSyncJobs( args: ListDataSourceSyncJobsCommandInput, cb: (err: any, data?: ListDataSourceSyncJobsCommandOutput) => void ): void; - public listDataSourceSyncJobs( + listDataSourceSyncJobs( args: ListDataSourceSyncJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataSourceSyncJobsCommandOutput) => void ): void; - public listDataSourceSyncJobs( - args: ListDataSourceSyncJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDataSourceSyncJobsCommandOutput) => void), - cb?: (err: any, data?: ListDataSourceSyncJobsCommandOutput) => void - ): Promise | void { - const command = new ListDataSourceSyncJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists specific permissions of users and groups with access to your - * Amazon Kendra experience.

- */ - public listEntityPersonas( + + /** + * @see {@link ListEntityPersonasCommand} + */ + listEntityPersonas( args: ListEntityPersonasCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEntityPersonas( + listEntityPersonas( args: ListEntityPersonasCommandInput, cb: (err: any, data?: ListEntityPersonasCommandOutput) => void ): void; - public listEntityPersonas( + listEntityPersonas( args: ListEntityPersonasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEntityPersonasCommandOutput) => void ): void; - public listEntityPersonas( - args: ListEntityPersonasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEntityPersonasCommandOutput) => void), - cb?: (err: any, data?: ListEntityPersonasCommandOutput) => void - ): Promise | void { - const command = new ListEntityPersonasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists users or groups in your IAM Identity Center identity source that are - * granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience - * such as a search application. For more information on creating a search - * application experience, see Building - * a search experience with no code.

- */ - public listExperienceEntities( + + /** + * @see {@link ListExperienceEntitiesCommand} + */ + listExperienceEntities( args: ListExperienceEntitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listExperienceEntities( + listExperienceEntities( args: ListExperienceEntitiesCommandInput, cb: (err: any, data?: ListExperienceEntitiesCommandOutput) => void ): void; - public listExperienceEntities( + listExperienceEntities( args: ListExperienceEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExperienceEntitiesCommandOutput) => void ): void; - public listExperienceEntities( - args: ListExperienceEntitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListExperienceEntitiesCommandOutput) => void), - cb?: (err: any, data?: ListExperienceEntitiesCommandOutput) => void - ): Promise | void { - const command = new ListExperienceEntitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such - * as a search application. For more information on creating a search application - * experience, see Building a - * search experience with no code.

- */ - public listExperiences( + + /** + * @see {@link ListExperiencesCommand} + */ + listExperiences( args: ListExperiencesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listExperiences( - args: ListExperiencesCommandInput, - cb: (err: any, data?: ListExperiencesCommandOutput) => void - ): void; - public listExperiences( + listExperiences(args: ListExperiencesCommandInput, cb: (err: any, data?: ListExperiencesCommandOutput) => void): void; + listExperiences( args: ListExperiencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExperiencesCommandOutput) => void ): void; - public listExperiences( - args: ListExperiencesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListExperiencesCommandOutput) => void), - cb?: (err: any, data?: ListExperiencesCommandOutput) => void - ): Promise | void { - const command = new ListExperiencesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of FAQ lists associated with an index.

- */ - public listFaqs(args: ListFaqsCommandInput, options?: __HttpHandlerOptions): Promise; - public listFaqs(args: ListFaqsCommandInput, cb: (err: any, data?: ListFaqsCommandOutput) => void): void; - public listFaqs( + + /** + * @see {@link ListFaqsCommand} + */ + listFaqs(args: ListFaqsCommandInput, options?: __HttpHandlerOptions): Promise; + listFaqs(args: ListFaqsCommandInput, cb: (err: any, data?: ListFaqsCommandOutput) => void): void; + listFaqs( args: ListFaqsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFaqsCommandOutput) => void ): void; - public listFaqs( - args: ListFaqsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFaqsCommandOutput) => void), - cb?: (err: any, data?: ListFaqsCommandOutput) => void - ): Promise | void { - const command = new ListFaqsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all your sets of featured results for a given index. Features results - * are placed above all other results for certain queries. If there's an exact match - * of a query, then one or more specific documents are featured in the search results.

- */ - public listFeaturedResultsSets( + + /** + * @see {@link ListFeaturedResultsSetsCommand} + */ + listFeaturedResultsSets( args: ListFeaturedResultsSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFeaturedResultsSets( + listFeaturedResultsSets( args: ListFeaturedResultsSetsCommandInput, cb: (err: any, data?: ListFeaturedResultsSetsCommandOutput) => void ): void; - public listFeaturedResultsSets( + listFeaturedResultsSets( args: ListFeaturedResultsSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFeaturedResultsSetsCommandOutput) => void ): void; - public listFeaturedResultsSets( - args: ListFeaturedResultsSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFeaturedResultsSetsCommandOutput) => void), - cb?: (err: any, data?: ListFeaturedResultsSetsCommandOutput) => void - ): Promise | void { - const command = new ListFeaturedResultsSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides a list of groups that are mapped to users before a given ordering or - * timestamp identifier.

- *

- * ListGroupsOlderThanOrderingId is currently not supported in the Amazon Web Services GovCloud (US-West) region.

- */ - public listGroupsOlderThanOrderingId( + + /** + * @see {@link ListGroupsOlderThanOrderingIdCommand} + */ + listGroupsOlderThanOrderingId( args: ListGroupsOlderThanOrderingIdCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGroupsOlderThanOrderingId( + listGroupsOlderThanOrderingId( args: ListGroupsOlderThanOrderingIdCommandInput, cb: (err: any, data?: ListGroupsOlderThanOrderingIdCommandOutput) => void ): void; - public listGroupsOlderThanOrderingId( + listGroupsOlderThanOrderingId( args: ListGroupsOlderThanOrderingIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsOlderThanOrderingIdCommandOutput) => void ): void; - public listGroupsOlderThanOrderingId( - args: ListGroupsOlderThanOrderingIdCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGroupsOlderThanOrderingIdCommandOutput) => void), - cb?: (err: any, data?: ListGroupsOlderThanOrderingIdCommandOutput) => void - ): Promise | void { - const command = new ListGroupsOlderThanOrderingIdCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the Amazon Kendra indexes that you created.

- */ - public listIndices(args: ListIndicesCommandInput, options?: __HttpHandlerOptions): Promise; - public listIndices(args: ListIndicesCommandInput, cb: (err: any, data?: ListIndicesCommandOutput) => void): void; - public listIndices( + + /** + * @see {@link ListIndicesCommand} + */ + listIndices(args: ListIndicesCommandInput, options?: __HttpHandlerOptions): Promise; + listIndices(args: ListIndicesCommandInput, cb: (err: any, data?: ListIndicesCommandOutput) => void): void; + listIndices( args: ListIndicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIndicesCommandOutput) => void ): void; - public listIndices( - args: ListIndicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIndicesCommandOutput) => void), - cb?: (err: any, data?: ListIndicesCommandOutput) => void - ): Promise | void { - const command = new ListIndicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the block lists used for query suggestions for an index.

- *

For information on the current quota limits for block lists, see - * Quotas - * for Amazon Kendra.

- *

- * ListQuerySuggestionsBlockLists is currently not supported in the - * Amazon Web Services GovCloud (US-West) region.

- */ - public listQuerySuggestionsBlockLists( + + /** + * @see {@link ListQuerySuggestionsBlockListsCommand} + */ + listQuerySuggestionsBlockLists( args: ListQuerySuggestionsBlockListsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listQuerySuggestionsBlockLists( + listQuerySuggestionsBlockLists( args: ListQuerySuggestionsBlockListsCommandInput, cb: (err: any, data?: ListQuerySuggestionsBlockListsCommandOutput) => void ): void; - public listQuerySuggestionsBlockLists( + listQuerySuggestionsBlockLists( args: ListQuerySuggestionsBlockListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQuerySuggestionsBlockListsCommandOutput) => void ): void; - public listQuerySuggestionsBlockLists( - args: ListQuerySuggestionsBlockListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListQuerySuggestionsBlockListsCommandOutput) => void), - cb?: (err: any, data?: ListQuerySuggestionsBlockListsCommandOutput) => void - ): Promise | void { - const command = new ListQuerySuggestionsBlockListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources - * can have tags associated with them.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the thesauri for an index.

- */ - public listThesauri( - args: ListThesauriCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listThesauri(args: ListThesauriCommandInput, cb: (err: any, data?: ListThesauriCommandOutput) => void): void; - public listThesauri( + + /** + * @see {@link ListThesauriCommand} + */ + listThesauri(args: ListThesauriCommandInput, options?: __HttpHandlerOptions): Promise; + listThesauri(args: ListThesauriCommandInput, cb: (err: any, data?: ListThesauriCommandOutput) => void): void; + listThesauri( args: ListThesauriCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListThesauriCommandOutput) => void ): void; - public listThesauri( - args: ListThesauriCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListThesauriCommandOutput) => void), - cb?: (err: any, data?: ListThesauriCommandOutput) => void - ): Promise | void { - const command = new ListThesauriCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Maps users to their groups so that you only need to provide the user ID when you issue - * the query.

- *

You can also map sub groups to groups. For example, the group "Company Intellectual - * Property Teams" includes sub groups "Research" and "Engineering". These sub groups - * include their own list of users or people who work in these teams. Only users who work - * in research and engineering, and therefore belong in the intellectual property group, - * can see top-secret company documents in their search results.

- *

This is useful for user context filtering, where search results are filtered based on - * the user or their group access to documents. For more information, see Filtering on - * user context.

- *

If more than five PUT actions for a group are currently processing, a - * validation exception is thrown.

- */ - public putPrincipalMapping( + + /** + * @see {@link PutPrincipalMappingCommand} + */ + putPrincipalMapping( args: PutPrincipalMappingCommandInput, options?: __HttpHandlerOptions ): Promise; - public putPrincipalMapping( + putPrincipalMapping( args: PutPrincipalMappingCommandInput, cb: (err: any, data?: PutPrincipalMappingCommandOutput) => void ): void; - public putPrincipalMapping( + putPrincipalMapping( args: PutPrincipalMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPrincipalMappingCommandOutput) => void ): void; - public putPrincipalMapping( - args: PutPrincipalMappingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutPrincipalMappingCommandOutput) => void), - cb?: (err: any, data?: PutPrincipalMappingCommandOutput) => void - ): Promise | void { - const command = new PutPrincipalMappingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Searches an active index. Use this API to search your documents using query. The - * Query API enables to do faceted search and to filter results based on - * document attributes.

- *

It also enables you to provide user context that Amazon Kendra uses to enforce - * document access control in the search results.

- *

Amazon Kendra searches your index for text content and question and answer (FAQ) - * content. By default the response contains three types of results.

- *
    - *
  • - *

    Relevant passages

    - *
  • - *
  • - *

    Matching FAQs

    - *
  • - *
  • - *

    Relevant documents

    - *
  • - *
- *

You can specify that the query return only one type of result using the - * QueryResultTypeFilter parameter.

- *

Each query returns the 100 most relevant results.

- */ - public query(args: QueryCommandInput, options?: __HttpHandlerOptions): Promise; - public query(args: QueryCommandInput, cb: (err: any, data?: QueryCommandOutput) => void): void; - public query( + + /** + * @see {@link QueryCommand} + */ + query(args: QueryCommandInput, options?: __HttpHandlerOptions): Promise; + query(args: QueryCommandInput, cb: (err: any, data?: QueryCommandOutput) => void): void; + query( args: QueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryCommandOutput) => void ): void; - public query( - args: QueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryCommandOutput) => void), - cb?: (err: any, data?: QueryCommandOutput) => void - ): Promise | void { - const command = new QueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a synchronization job for a data source connector. If a synchronization job is - * already in progress, Amazon Kendra returns a ResourceInUseException - * exception.

- */ - public startDataSourceSyncJob( + + /** + * @see {@link StartDataSourceSyncJobCommand} + */ + startDataSourceSyncJob( args: StartDataSourceSyncJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDataSourceSyncJob( + startDataSourceSyncJob( args: StartDataSourceSyncJobCommandInput, cb: (err: any, data?: StartDataSourceSyncJobCommandOutput) => void ): void; - public startDataSourceSyncJob( + startDataSourceSyncJob( args: StartDataSourceSyncJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDataSourceSyncJobCommandOutput) => void ): void; - public startDataSourceSyncJob( - args: StartDataSourceSyncJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDataSourceSyncJobCommandOutput) => void), - cb?: (err: any, data?: StartDataSourceSyncJobCommandOutput) => void - ): Promise | void { - const command = new StartDataSourceSyncJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a synchronization job that is currently running. You can't stop a scheduled - * synchronization job.

- */ - public stopDataSourceSyncJob( + + /** + * @see {@link StopDataSourceSyncJobCommand} + */ + stopDataSourceSyncJob( args: StopDataSourceSyncJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopDataSourceSyncJob( + stopDataSourceSyncJob( args: StopDataSourceSyncJobCommandInput, cb: (err: any, data?: StopDataSourceSyncJobCommandOutput) => void ): void; - public stopDataSourceSyncJob( + stopDataSourceSyncJob( args: StopDataSourceSyncJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDataSourceSyncJobCommandOutput) => void ): void; - public stopDataSourceSyncJob( - args: StopDataSourceSyncJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopDataSourceSyncJobCommandOutput) => void), - cb?: (err: any, data?: StopDataSourceSyncJobCommandOutput) => void - ): Promise | void { - const command = new StopDataSourceSyncJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables you to provide feedback to Amazon Kendra to improve the - * performance of your index.

- *

- * SubmitFeedback is currently not supported in the - * Amazon Web Services GovCloud (US-West) region.

- */ - public submitFeedback( + + /** + * @see {@link SubmitFeedbackCommand} + */ + submitFeedback( args: SubmitFeedbackCommandInput, options?: __HttpHandlerOptions ): Promise; - public submitFeedback( - args: SubmitFeedbackCommandInput, - cb: (err: any, data?: SubmitFeedbackCommandOutput) => void - ): void; - public submitFeedback( + submitFeedback(args: SubmitFeedbackCommandInput, cb: (err: any, data?: SubmitFeedbackCommandOutput) => void): void; + submitFeedback( args: SubmitFeedbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubmitFeedbackCommandOutput) => void ): void; - public submitFeedback( - args: SubmitFeedbackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SubmitFeedbackCommandOutput) => void), - cb?: (err: any, data?: SubmitFeedbackCommandOutput) => void - ): Promise | void { - const command = new SubmitFeedbackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds the specified tag to the specified index, FAQ, or data source resource. If the tag - * already exists, the existing value is replaced with the new value.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a tag from an index, FAQ, or a data source.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an access control configuration for your documents in an index. This includes - * user and group access information for your documents. This is useful for user context - * filtering, where search results are filtered based on the user or their group access to - * documents.

- *

You can update an access control configuration you created without indexing all of - * your documents again. For example, your index contains top-secret company documents that - * only certain employees or users should access. You created an 'allow' access control - * configuration for one user who recently joined the 'top-secret' team, switching from a - * team with 'deny' access to top-secret documents. However, the user suddenly returns to - * their previous team and should no longer have access to top secret documents. You can - * update the access control configuration to re-configure access control for your - * documents as circumstances change.

- *

You call the BatchPutDocument API to - * apply the updated access control configuration, with the - * AccessControlConfigurationId included in the Document - * object. If you use an S3 bucket as a data source, you synchronize your data source to - * apply the AccessControlConfigurationId in the .metadata.json - * file. Amazon Kendra currently only supports access control configuration for S3 - * data sources and documents indexed using the BatchPutDocument API.

- */ - public updateAccessControlConfiguration( + + /** + * @see {@link UpdateAccessControlConfigurationCommand} + */ + updateAccessControlConfiguration( args: UpdateAccessControlConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAccessControlConfiguration( + updateAccessControlConfiguration( args: UpdateAccessControlConfigurationCommandInput, cb: (err: any, data?: UpdateAccessControlConfigurationCommandOutput) => void ): void; - public updateAccessControlConfiguration( + updateAccessControlConfiguration( args: UpdateAccessControlConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccessControlConfigurationCommandOutput) => void ): void; - public updateAccessControlConfiguration( - args: UpdateAccessControlConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAccessControlConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateAccessControlConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateAccessControlConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing Amazon Kendra data source connector.

- */ - public updateDataSource( + + /** + * @see {@link UpdateDataSourceCommand} + */ + updateDataSource( args: UpdateDataSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDataSource( + updateDataSource( args: UpdateDataSourceCommandInput, cb: (err: any, data?: UpdateDataSourceCommandOutput) => void ): void; - public updateDataSource( + updateDataSource( args: UpdateDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDataSourceCommandOutput) => void ): void; - public updateDataSource( - args: UpdateDataSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDataSourceCommandOutput) => void), - cb?: (err: any, data?: UpdateDataSourceCommandOutput) => void - ): Promise | void { - const command = new UpdateDataSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates your Amazon Kendra experience such as a search application. For more information on - * creating a search application experience, see Building a - * search experience with no code.

- */ - public updateExperience( + + /** + * @see {@link UpdateExperienceCommand} + */ + updateExperience( args: UpdateExperienceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateExperience( + updateExperience( args: UpdateExperienceCommandInput, cb: (err: any, data?: UpdateExperienceCommandOutput) => void ): void; - public updateExperience( + updateExperience( args: UpdateExperienceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateExperienceCommandOutput) => void ): void; - public updateExperience( - args: UpdateExperienceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateExperienceCommandOutput) => void), - cb?: (err: any, data?: UpdateExperienceCommandOutput) => void - ): Promise | void { - const command = new UpdateExperienceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a set of featured results. Features results are placed - * above - * all other results for certain queries. You map specific queries to specific documents - * for featuring in the results. If a query contains an exact match of a query, then one - * or more specific documents are featured in the search results.

- */ - public updateFeaturedResultsSet( + + /** + * @see {@link UpdateFeaturedResultsSetCommand} + */ + updateFeaturedResultsSet( args: UpdateFeaturedResultsSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFeaturedResultsSet( + updateFeaturedResultsSet( args: UpdateFeaturedResultsSetCommandInput, cb: (err: any, data?: UpdateFeaturedResultsSetCommandOutput) => void ): void; - public updateFeaturedResultsSet( + updateFeaturedResultsSet( args: UpdateFeaturedResultsSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFeaturedResultsSetCommandOutput) => void ): void; - public updateFeaturedResultsSet( - args: UpdateFeaturedResultsSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFeaturedResultsSetCommandOutput) => void), - cb?: (err: any, data?: UpdateFeaturedResultsSetCommandOutput) => void - ): Promise | void { - const command = new UpdateFeaturedResultsSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing Amazon Kendra index.

- */ - public updateIndex(args: UpdateIndexCommandInput, options?: __HttpHandlerOptions): Promise; - public updateIndex(args: UpdateIndexCommandInput, cb: (err: any, data?: UpdateIndexCommandOutput) => void): void; - public updateIndex( + + /** + * @see {@link UpdateIndexCommand} + */ + updateIndex(args: UpdateIndexCommandInput, options?: __HttpHandlerOptions): Promise; + updateIndex(args: UpdateIndexCommandInput, cb: (err: any, data?: UpdateIndexCommandOutput) => void): void; + updateIndex( args: UpdateIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIndexCommandOutput) => void ): void; - public updateIndex( - args: UpdateIndexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateIndexCommandOutput) => void), - cb?: (err: any, data?: UpdateIndexCommandOutput) => void - ): Promise | void { - const command = new UpdateIndexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a block list used for query suggestions for an index.

- *

Updates to a block list might not take effect right away. Amazon Kendra - * needs to refresh the entire suggestions list to apply any updates to the - * block list. Other changes not related to the block list apply immediately.

- *

If a block list is updating, then you need to wait for the first update to - * finish before submitting another update.

- *

Amazon Kendra supports partial updates, so you only need to provide the fields - * you want to update.

- *

- * UpdateQuerySuggestionsBlockList is currently not supported in the - * Amazon Web Services GovCloud (US-West) region.

- */ - public updateQuerySuggestionsBlockList( + + /** + * @see {@link UpdateQuerySuggestionsBlockListCommand} + */ + updateQuerySuggestionsBlockList( args: UpdateQuerySuggestionsBlockListCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateQuerySuggestionsBlockList( + updateQuerySuggestionsBlockList( args: UpdateQuerySuggestionsBlockListCommandInput, cb: (err: any, data?: UpdateQuerySuggestionsBlockListCommandOutput) => void ): void; - public updateQuerySuggestionsBlockList( + updateQuerySuggestionsBlockList( args: UpdateQuerySuggestionsBlockListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateQuerySuggestionsBlockListCommandOutput) => void ): void; - public updateQuerySuggestionsBlockList( - args: UpdateQuerySuggestionsBlockListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateQuerySuggestionsBlockListCommandOutput) => void), - cb?: (err: any, data?: UpdateQuerySuggestionsBlockListCommandOutput) => void - ): Promise | void { - const command = new UpdateQuerySuggestionsBlockListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the settings of query suggestions for an index.

- *

Amazon Kendra supports partial updates, so you only need to provide - * the fields you want to update.

- *

If an update is currently processing (i.e. 'happening'), you - * need to wait for the update to finish before making another update.

- *

Updates to query suggestions settings might not take effect right away. - * The time for your updated settings to take effect depends on the updates - * made and the number of search queries in your index.

- *

You can still enable/disable query suggestions at any time.

- *

- * UpdateQuerySuggestionsConfig is currently not supported in the - * Amazon Web Services GovCloud (US-West) region.

- */ - public updateQuerySuggestionsConfig( + + /** + * @see {@link UpdateQuerySuggestionsConfigCommand} + */ + updateQuerySuggestionsConfig( args: UpdateQuerySuggestionsConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateQuerySuggestionsConfig( + updateQuerySuggestionsConfig( args: UpdateQuerySuggestionsConfigCommandInput, cb: (err: any, data?: UpdateQuerySuggestionsConfigCommandOutput) => void ): void; - public updateQuerySuggestionsConfig( + updateQuerySuggestionsConfig( args: UpdateQuerySuggestionsConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateQuerySuggestionsConfigCommandOutput) => void ): void; - public updateQuerySuggestionsConfig( - args: UpdateQuerySuggestionsConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateQuerySuggestionsConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateQuerySuggestionsConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateQuerySuggestionsConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a thesaurus for an index.

- */ - public updateThesaurus( + + /** + * @see {@link UpdateThesaurusCommand} + */ + updateThesaurus( args: UpdateThesaurusCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateThesaurus( - args: UpdateThesaurusCommandInput, - cb: (err: any, data?: UpdateThesaurusCommandOutput) => void - ): void; - public updateThesaurus( + updateThesaurus(args: UpdateThesaurusCommandInput, cb: (err: any, data?: UpdateThesaurusCommandOutput) => void): void; + updateThesaurus( args: UpdateThesaurusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateThesaurusCommandOutput) => void ): void; - public updateThesaurus( - args: UpdateThesaurusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateThesaurusCommandOutput) => void), - cb?: (err: any, data?: UpdateThesaurusCommandOutput) => void - ): Promise | void { - const command = new UpdateThesaurusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Kendra is a service for indexing large document sets.

+ */ +export class Kendra extends KendraClient implements Kendra {} +createAggregatedClient(commands, Kendra); diff --git a/clients/client-keyspaces/src/Keyspaces.ts b/clients/client-keyspaces/src/Keyspaces.ts index d4d39c1aba8a..ab24cde90553 100644 --- a/clients/client-keyspaces/src/Keyspaces.ts +++ b/clients/client-keyspaces/src/Keyspaces.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -38,481 +39,197 @@ import { UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; import { UpdateTableCommand, UpdateTableCommandInput, UpdateTableCommandOutput } from "./commands/UpdateTableCommand"; -import { KeyspacesClient } from "./KeyspacesClient"; +import { KeyspacesClient, KeyspacesClientConfig } from "./KeyspacesClient"; -/** - * @public - *

Amazon Keyspaces (for Apache Cassandra) is a scalable, - * highly available, and managed Apache Cassandra-compatible database service. Amazon Keyspaces makes it easy to migrate, - * run, and scale Cassandra workloads in the Amazon Web Services Cloud. With just a few clicks on the Amazon Web Services Management Console or a few lines of code, - * you can create keyspaces and tables in Amazon Keyspaces, without deploying any infrastructure or installing software.

- *

In addition to supporting Cassandra Query Language (CQL) requests via open-source Cassandra drivers, - * Amazon Keyspaces supports data definition language (DDL) operations to manage keyspaces and tables using the Amazon Web Services SDK and CLI, as well as - * infrastructure as code (IaC) services and tools such as CloudFormation and Terraform. This API reference describes - * the supported DDL operations in detail.

- *

For the list of all supported CQL APIs, see Supported Cassandra APIs, operations, and data types - * in Amazon Keyspaces in the Amazon Keyspaces Developer - * Guide.

- *

To learn how Amazon Keyspaces API actions are recorded with CloudTrail, see Amazon Keyspaces information in CloudTrail in the Amazon Keyspaces Developer - * Guide.

- *

For more information about Amazon Web Services APIs, for example how to implement retry logic or how to sign Amazon Web Services API requests, see Amazon Web Services APIs in the General Reference.

- */ -export class Keyspaces extends KeyspacesClient { +const commands = { + CreateKeyspaceCommand, + CreateTableCommand, + DeleteKeyspaceCommand, + DeleteTableCommand, + GetKeyspaceCommand, + GetTableCommand, + ListKeyspacesCommand, + ListTablesCommand, + ListTagsForResourceCommand, + RestoreTableCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateTableCommand, +}; + +export interface Keyspaces { /** - * @public - *

The CreateKeyspace operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names - * must be unique within each Region.

- *

- * CreateKeyspace is an asynchronous operation. You can monitor the creation status of the new keyspace - * by using the GetKeyspace operation.

- *

For more information, see Creating keyspaces in the Amazon Keyspaces Developer - * Guide.

+ * @see {@link CreateKeyspaceCommand} */ - public createKeyspace( + createKeyspace( args: CreateKeyspaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createKeyspace( - args: CreateKeyspaceCommandInput, - cb: (err: any, data?: CreateKeyspaceCommandOutput) => void - ): void; - public createKeyspace( + createKeyspace(args: CreateKeyspaceCommandInput, cb: (err: any, data?: CreateKeyspaceCommandOutput) => void): void; + createKeyspace( args: CreateKeyspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateKeyspaceCommandOutput) => void ): void; - public createKeyspace( - args: CreateKeyspaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateKeyspaceCommandOutput) => void), - cb?: (err: any, data?: CreateKeyspaceCommandOutput) => void - ): Promise | void { - const command = new CreateKeyspaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The CreateTable operation adds a new table to the specified keyspace. Within a keyspace, table names - * must be unique.

- *

- * CreateTable is an asynchronous operation. When the request is received, the status of the table is set to CREATING. - * You can monitor the creation status of the new table by using the GetTable - * operation, which returns the current status of the table. You can start using a table when the status is ACTIVE.

- *

For more information, see Creating tables in the Amazon Keyspaces Developer - * Guide.

+ * @see {@link CreateTableCommand} */ - public createTable(args: CreateTableCommandInput, options?: __HttpHandlerOptions): Promise; - public createTable(args: CreateTableCommandInput, cb: (err: any, data?: CreateTableCommandOutput) => void): void; - public createTable( + createTable(args: CreateTableCommandInput, options?: __HttpHandlerOptions): Promise; + createTable(args: CreateTableCommandInput, cb: (err: any, data?: CreateTableCommandOutput) => void): void; + createTable( args: CreateTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTableCommandOutput) => void ): void; - public createTable( - args: CreateTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTableCommandOutput) => void), - cb?: (err: any, data?: CreateTableCommandOutput) => void - ): Promise | void { - const command = new CreateTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The DeleteKeyspace operation deletes a keyspace and all of its tables.

+ * @see {@link DeleteKeyspaceCommand} */ - public deleteKeyspace( + deleteKeyspace( args: DeleteKeyspaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteKeyspace( - args: DeleteKeyspaceCommandInput, - cb: (err: any, data?: DeleteKeyspaceCommandOutput) => void - ): void; - public deleteKeyspace( + deleteKeyspace(args: DeleteKeyspaceCommandInput, cb: (err: any, data?: DeleteKeyspaceCommandOutput) => void): void; + deleteKeyspace( args: DeleteKeyspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteKeyspaceCommandOutput) => void ): void; - public deleteKeyspace( - args: DeleteKeyspaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteKeyspaceCommandOutput) => void), - cb?: (err: any, data?: DeleteKeyspaceCommandOutput) => void - ): Promise | void { - const command = new DeleteKeyspaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The DeleteTable operation deletes a table and all of its data. After a DeleteTable request is received, - * the specified table is in the DELETING state until Amazon Keyspaces completes the deletion. If the table - * is in the ACTIVE state, you can delete it. If a table is either in the CREATING or UPDATING states, then - * Amazon Keyspaces returns a ResourceInUseException. If the specified table does not exist, Amazon Keyspaces returns - * a ResourceNotFoundException. If the table is already in the DELETING state, no error is returned.

+ * @see {@link DeleteTableCommand} */ - public deleteTable(args: DeleteTableCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteTable(args: DeleteTableCommandInput, cb: (err: any, data?: DeleteTableCommandOutput) => void): void; - public deleteTable( + deleteTable(args: DeleteTableCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTable(args: DeleteTableCommandInput, cb: (err: any, data?: DeleteTableCommandOutput) => void): void; + deleteTable( args: DeleteTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTableCommandOutput) => void ): void; - public deleteTable( - args: DeleteTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTableCommandOutput) => void), - cb?: (err: any, data?: DeleteTableCommandOutput) => void - ): Promise | void { - const command = new DeleteTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the name and the Amazon Resource Name (ARN) of the specified table.

+ * @see {@link GetKeyspaceCommand} */ - public getKeyspace(args: GetKeyspaceCommandInput, options?: __HttpHandlerOptions): Promise; - public getKeyspace(args: GetKeyspaceCommandInput, cb: (err: any, data?: GetKeyspaceCommandOutput) => void): void; - public getKeyspace( + getKeyspace(args: GetKeyspaceCommandInput, options?: __HttpHandlerOptions): Promise; + getKeyspace(args: GetKeyspaceCommandInput, cb: (err: any, data?: GetKeyspaceCommandOutput) => void): void; + getKeyspace( args: GetKeyspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetKeyspaceCommandOutput) => void ): void; - public getKeyspace( - args: GetKeyspaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetKeyspaceCommandOutput) => void), - cb?: (err: any, data?: GetKeyspaceCommandOutput) => void - ): Promise | void { - const command = new GetKeyspaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the table, including the table's name and current status, the keyspace name, - * configuration settings, and metadata.

- *

To read table metadata using GetTable, Select action - * permissions for the table and system tables are required to complete the operation.

+ * @see {@link GetTableCommand} */ - public getTable(args: GetTableCommandInput, options?: __HttpHandlerOptions): Promise; - public getTable(args: GetTableCommandInput, cb: (err: any, data?: GetTableCommandOutput) => void): void; - public getTable( + getTable(args: GetTableCommandInput, options?: __HttpHandlerOptions): Promise; + getTable(args: GetTableCommandInput, cb: (err: any, data?: GetTableCommandOutput) => void): void; + getTable( args: GetTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTableCommandOutput) => void ): void; - public getTable( - args: GetTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTableCommandOutput) => void), - cb?: (err: any, data?: GetTableCommandOutput) => void - ): Promise | void { - const command = new GetTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of keyspaces.

+ * @see {@link ListKeyspacesCommand} */ - public listKeyspaces( - args: ListKeyspacesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listKeyspaces( - args: ListKeyspacesCommandInput, - cb: (err: any, data?: ListKeyspacesCommandOutput) => void - ): void; - public listKeyspaces( + listKeyspaces(args: ListKeyspacesCommandInput, options?: __HttpHandlerOptions): Promise; + listKeyspaces(args: ListKeyspacesCommandInput, cb: (err: any, data?: ListKeyspacesCommandOutput) => void): void; + listKeyspaces( args: ListKeyspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKeyspacesCommandOutput) => void ): void; - public listKeyspaces( - args: ListKeyspacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListKeyspacesCommandOutput) => void), - cb?: (err: any, data?: ListKeyspacesCommandOutput) => void - ): Promise | void { - const command = new ListKeyspacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of tables for a specified keyspace.

+ * @see {@link ListTablesCommand} */ - public listTables(args: ListTablesCommandInput, options?: __HttpHandlerOptions): Promise; - public listTables(args: ListTablesCommandInput, cb: (err: any, data?: ListTablesCommandOutput) => void): void; - public listTables( + listTables(args: ListTablesCommandInput, options?: __HttpHandlerOptions): Promise; + listTables(args: ListTablesCommandInput, cb: (err: any, data?: ListTablesCommandOutput) => void): void; + listTables( args: ListTablesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTablesCommandOutput) => void ): void; - public listTables( - args: ListTablesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTablesCommandOutput) => void), - cb?: (err: any, data?: ListTablesCommandOutput) => void - ): Promise | void { - const command = new ListTablesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all tags associated with the specified Amazon Keyspaces resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Restores the specified table to the specified point in time within the - * earliest_restorable_timestamp and the current time. For more information about restore points, see - * - * Time window for PITR continuous backups in the Amazon Keyspaces Developer Guide.

- *

Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.

- *

When you restore using point in time recovery, - * Amazon Keyspaces restores your source table's schema and data to the state - * based on the selected timestamp (day:hour:minute:second) to a new table. The Time to Live (TTL) settings - * are also restored to the state based on the selected timestamp.

- *

In addition to the table's schema, data, and TTL settings, - * RestoreTable restores the capacity mode, encryption, and - * point-in-time recovery settings from the source table. - * Unlike the table's schema data and TTL settings, which are restored based on the selected timestamp, - * these settings are always restored based on the table's settings as of the current time or when the table was deleted.

- *

You can also overwrite - * these settings during restore:

- *
    - *
  • - *

    Read/write capacity mode

    - *
  • - *
  • - *

    Provisioned throughput capacity settings

    - *
  • - *
  • - *

    Point-in-time (PITR) settings

    - *
  • - *
  • - *

    Tags

    - *
  • - *
- *

For more - * information, see PITR restore settings in the Amazon Keyspaces Developer - * Guide.

- *

Note that the following settings are not restored, and you must configure them manually for - * the new table:

- *
    - *
  • - *

    Automatic scaling policies (for tables that use provisioned capacity - * mode)

    - *
  • - *
  • - *

    Identity and Access Management (IAM) policies

    - *
  • - *
  • - *

    Amazon CloudWatch metrics and alarms

    - *
  • - *
+ * @see {@link RestoreTableCommand} */ - public restoreTable( - args: RestoreTableCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public restoreTable(args: RestoreTableCommandInput, cb: (err: any, data?: RestoreTableCommandOutput) => void): void; - public restoreTable( + restoreTable(args: RestoreTableCommandInput, options?: __HttpHandlerOptions): Promise; + restoreTable(args: RestoreTableCommandInput, cb: (err: any, data?: RestoreTableCommandOutput) => void): void; + restoreTable( args: RestoreTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreTableCommandOutput) => void ): void; - public restoreTable( - args: RestoreTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreTableCommandOutput) => void), - cb?: (err: any, data?: RestoreTableCommandOutput) => void - ): Promise | void { - const command = new RestoreTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a set of tags with a Amazon Keyspaces resource. You can then - * activate these user-defined tags so that they appear on the Cost Management Console for cost allocation tracking. - * For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer - * Guide.

- *

For IAM policy examples that show how to control access to Amazon Keyspaces resources based on tags, - * see Amazon Keyspaces resource access based on tags - * in the Amazon Keyspaces Developer Guide.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the association of tags from a Amazon Keyspaces resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds new columns to the table or updates one of the table's settings, for example - * capacity mode, encryption, point-in-time recovery, or ttl settings. - * Note that you can only update one specific table setting per update operation.

+ * @see {@link UpdateTableCommand} */ - public updateTable(args: UpdateTableCommandInput, options?: __HttpHandlerOptions): Promise; - public updateTable(args: UpdateTableCommandInput, cb: (err: any, data?: UpdateTableCommandOutput) => void): void; - public updateTable( + updateTable(args: UpdateTableCommandInput, options?: __HttpHandlerOptions): Promise; + updateTable(args: UpdateTableCommandInput, cb: (err: any, data?: UpdateTableCommandOutput) => void): void; + updateTable( args: UpdateTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTableCommandOutput) => void ): void; - public updateTable( - args: UpdateTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTableCommandOutput) => void), - cb?: (err: any, data?: UpdateTableCommandOutput) => void - ): Promise | void { - const command = new UpdateTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Keyspaces (for Apache Cassandra) is a scalable, + * highly available, and managed Apache Cassandra-compatible database service. Amazon Keyspaces makes it easy to migrate, + * run, and scale Cassandra workloads in the Amazon Web Services Cloud. With just a few clicks on the Amazon Web Services Management Console or a few lines of code, + * you can create keyspaces and tables in Amazon Keyspaces, without deploying any infrastructure or installing software.

+ *

In addition to supporting Cassandra Query Language (CQL) requests via open-source Cassandra drivers, + * Amazon Keyspaces supports data definition language (DDL) operations to manage keyspaces and tables using the Amazon Web Services SDK and CLI, as well as + * infrastructure as code (IaC) services and tools such as CloudFormation and Terraform. This API reference describes + * the supported DDL operations in detail.

+ *

For the list of all supported CQL APIs, see Supported Cassandra APIs, operations, and data types + * in Amazon Keyspaces in the Amazon Keyspaces Developer + * Guide.

+ *

To learn how Amazon Keyspaces API actions are recorded with CloudTrail, see Amazon Keyspaces information in CloudTrail in the Amazon Keyspaces Developer + * Guide.

+ *

For more information about Amazon Web Services APIs, for example how to implement retry logic or how to sign Amazon Web Services API requests, see Amazon Web Services APIs in the General Reference.

+ */ +export class Keyspaces extends KeyspacesClient implements Keyspaces {} +createAggregatedClient(commands, Keyspaces); diff --git a/clients/client-kinesis-analytics-v2/src/KinesisAnalyticsV2.ts b/clients/client-kinesis-analytics-v2/src/KinesisAnalyticsV2.ts index 6ebad9436122..7d6f5e61ed18 100644 --- a/clients/client-kinesis-analytics-v2/src/KinesisAnalyticsV2.ts +++ b/clients/client-kinesis-analytics-v2/src/KinesisAnalyticsV2.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -152,1157 +153,561 @@ import { UpdateApplicationMaintenanceConfigurationCommandInput, UpdateApplicationMaintenanceConfigurationCommandOutput, } from "./commands/UpdateApplicationMaintenanceConfigurationCommand"; -import { KinesisAnalyticsV2Client } from "./KinesisAnalyticsV2Client"; +import { KinesisAnalyticsV2Client, KinesisAnalyticsV2ClientConfig } from "./KinesisAnalyticsV2Client"; -/** - * @public - *

Amazon Kinesis Data Analytics is a fully managed service that you can use to process and analyze streaming data using Java, SQL, or Scala. The service - * enables you to quickly author and run Java, SQL, or Scala code against streaming sources to perform time - * series analytics, feed real-time dashboards, and create real-time metrics.

- */ -export class KinesisAnalyticsV2 extends KinesisAnalyticsV2Client { +const commands = { + AddApplicationCloudWatchLoggingOptionCommand, + AddApplicationInputCommand, + AddApplicationInputProcessingConfigurationCommand, + AddApplicationOutputCommand, + AddApplicationReferenceDataSourceCommand, + AddApplicationVpcConfigurationCommand, + CreateApplicationCommand, + CreateApplicationPresignedUrlCommand, + CreateApplicationSnapshotCommand, + DeleteApplicationCommand, + DeleteApplicationCloudWatchLoggingOptionCommand, + DeleteApplicationInputProcessingConfigurationCommand, + DeleteApplicationOutputCommand, + DeleteApplicationReferenceDataSourceCommand, + DeleteApplicationSnapshotCommand, + DeleteApplicationVpcConfigurationCommand, + DescribeApplicationCommand, + DescribeApplicationSnapshotCommand, + DescribeApplicationVersionCommand, + DiscoverInputSchemaCommand, + ListApplicationsCommand, + ListApplicationSnapshotsCommand, + ListApplicationVersionsCommand, + ListTagsForResourceCommand, + RollbackApplicationCommand, + StartApplicationCommand, + StopApplicationCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateApplicationCommand, + UpdateApplicationMaintenanceConfigurationCommand, +}; + +export interface KinesisAnalyticsV2 { /** - * @public - *

Adds an Amazon CloudWatch log stream to monitor application configuration errors.

+ * @see {@link AddApplicationCloudWatchLoggingOptionCommand} */ - public addApplicationCloudWatchLoggingOption( + addApplicationCloudWatchLoggingOption( args: AddApplicationCloudWatchLoggingOptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public addApplicationCloudWatchLoggingOption( + addApplicationCloudWatchLoggingOption( args: AddApplicationCloudWatchLoggingOptionCommandInput, cb: (err: any, data?: AddApplicationCloudWatchLoggingOptionCommandOutput) => void ): void; - public addApplicationCloudWatchLoggingOption( + addApplicationCloudWatchLoggingOption( args: AddApplicationCloudWatchLoggingOptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddApplicationCloudWatchLoggingOptionCommandOutput) => void ): void; - public addApplicationCloudWatchLoggingOption( - args: AddApplicationCloudWatchLoggingOptionCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AddApplicationCloudWatchLoggingOptionCommandOutput) => void), - cb?: (err: any, data?: AddApplicationCloudWatchLoggingOptionCommandOutput) => void - ): Promise | void { - const command = new AddApplicationCloudWatchLoggingOptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Adds a streaming source to your SQL-based Kinesis Data Analytics application. - *

- *

You can add a streaming source when you create an application, or you can use this - * operation to add a streaming source after you create an application. For more information, see - * CreateApplication.

- *

Any configuration update, including adding a streaming source using this operation, - * results in a new version of the application. You can use the DescribeApplication operation - * to find the current application version. - *

+ * @see {@link AddApplicationInputCommand} */ - public addApplicationInput( + addApplicationInput( args: AddApplicationInputCommandInput, options?: __HttpHandlerOptions ): Promise; - public addApplicationInput( + addApplicationInput( args: AddApplicationInputCommandInput, cb: (err: any, data?: AddApplicationInputCommandOutput) => void ): void; - public addApplicationInput( + addApplicationInput( args: AddApplicationInputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddApplicationInputCommandOutput) => void ): void; - public addApplicationInput( - args: AddApplicationInputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddApplicationInputCommandOutput) => void), - cb?: (err: any, data?: AddApplicationInputCommandOutput) => void - ): Promise | void { - const command = new AddApplicationInputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application. An input processor pre-processes records - * on the input stream before the - * application's SQL code executes. Currently, the only input processor available is Amazon Lambda.

+ * @see {@link AddApplicationInputProcessingConfigurationCommand} */ - public addApplicationInputProcessingConfiguration( + addApplicationInputProcessingConfiguration( args: AddApplicationInputProcessingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public addApplicationInputProcessingConfiguration( + addApplicationInputProcessingConfiguration( args: AddApplicationInputProcessingConfigurationCommandInput, cb: (err: any, data?: AddApplicationInputProcessingConfigurationCommandOutput) => void ): void; - public addApplicationInputProcessingConfiguration( + addApplicationInputProcessingConfiguration( args: AddApplicationInputProcessingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddApplicationInputProcessingConfigurationCommandOutput) => void ): void; - public addApplicationInputProcessingConfiguration( - args: AddApplicationInputProcessingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AddApplicationInputProcessingConfigurationCommandOutput) => void), - cb?: (err: any, data?: AddApplicationInputProcessingConfigurationCommandOutput) => void - ): Promise | void { - const command = new AddApplicationInputProcessingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds an external destination to your SQL-based Kinesis Data Analytics application.

- *

If you want Kinesis Data Analytics to deliver data from an in-application stream within - * your application to an external destination (such as an Kinesis data stream, a Kinesis Data - * Firehose delivery stream, or an Amazon Lambda function), you add the relevant configuration to - * your application using this operation. You can configure one or more outputs for your - * application. Each output configuration maps an in-application stream and an external - * destination.

- *

You can use one of the output configurations to deliver data from your - * in-application error stream to an external destination so that you can analyze the - * errors.

- *

Any configuration update, including adding a streaming source using this - * operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application - * version.

+ * @see {@link AddApplicationOutputCommand} */ - public addApplicationOutput( + addApplicationOutput( args: AddApplicationOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public addApplicationOutput( + addApplicationOutput( args: AddApplicationOutputCommandInput, cb: (err: any, data?: AddApplicationOutputCommandOutput) => void ): void; - public addApplicationOutput( + addApplicationOutput( args: AddApplicationOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddApplicationOutputCommandOutput) => void ): void; - public addApplicationOutput( - args: AddApplicationOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddApplicationOutputCommandOutput) => void), - cb?: (err: any, data?: AddApplicationOutputCommandOutput) => void - ): Promise | void { - const command = new AddApplicationOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a reference data source to an existing SQL-based Kinesis Data Analytics application.

- *

Kinesis Data Analytics reads reference data (that is, an Amazon S3 object) and creates an - * in-application table within your application. In the request, you provide the source (S3 - * bucket name and object key name), name of the in-application table to create, and the - * necessary mapping information that describes how data in an Amazon S3 object maps to columns - * in the resulting in-application table.

+ * @see {@link AddApplicationReferenceDataSourceCommand} */ - public addApplicationReferenceDataSource( + addApplicationReferenceDataSource( args: AddApplicationReferenceDataSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public addApplicationReferenceDataSource( + addApplicationReferenceDataSource( args: AddApplicationReferenceDataSourceCommandInput, cb: (err: any, data?: AddApplicationReferenceDataSourceCommandOutput) => void ): void; - public addApplicationReferenceDataSource( + addApplicationReferenceDataSource( args: AddApplicationReferenceDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddApplicationReferenceDataSourceCommandOutput) => void ): void; - public addApplicationReferenceDataSource( - args: AddApplicationReferenceDataSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddApplicationReferenceDataSourceCommandOutput) => void), - cb?: (err: any, data?: AddApplicationReferenceDataSourceCommandOutput) => void - ): Promise | void { - const command = new AddApplicationReferenceDataSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to store - * and access resources securely.

- *

Note the following about VPC configurations for Kinesis Data Analytics applications:

- *
    - *
  • - *

    VPC configurations are not supported for SQL applications.

    - *
  • - *
  • - *

    When a VPC is added to a Kinesis Data Analytics application, the application can no longer be accessed from the - * Internet directly. To enable Internet access to the application, add an Internet gateway to your VPC.

    - *
  • - *
+ * @see {@link AddApplicationVpcConfigurationCommand} */ - public addApplicationVpcConfiguration( + addApplicationVpcConfiguration( args: AddApplicationVpcConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public addApplicationVpcConfiguration( + addApplicationVpcConfiguration( args: AddApplicationVpcConfigurationCommandInput, cb: (err: any, data?: AddApplicationVpcConfigurationCommandOutput) => void ): void; - public addApplicationVpcConfiguration( + addApplicationVpcConfiguration( args: AddApplicationVpcConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddApplicationVpcConfigurationCommandOutput) => void ): void; - public addApplicationVpcConfiguration( - args: AddApplicationVpcConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddApplicationVpcConfigurationCommandOutput) => void), - cb?: (err: any, data?: AddApplicationVpcConfigurationCommandOutput) => void - ): Promise | void { - const command = new AddApplicationVpcConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a Kinesis Data Analytics application. For information about creating a - * Kinesis Data Analytics application, see Creating an - * Application.

+ * @see {@link CreateApplicationCommand} */ - public createApplication( + createApplication( args: CreateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApplication( + createApplication( args: CreateApplicationCommandInput, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( + createApplication( args: CreateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( - args: CreateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApplicationCommandOutput) => void), - cb?: (err: any, data?: CreateApplicationCommandOutput) => void - ): Promise | void { - const command = new CreateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates and returns a URL that you can use to connect to - * an application's extension.

- *

The IAM role or user used to call this API defines the permissions to access the - * extension. After the presigned URL is created, no additional permission is required to access - * this URL. IAM authorization policies for this API are also enforced for every HTTP request - * that attempts to connect to the extension.

- *

You control the amount of time that the URL will be valid using the SessionExpirationDurationInSeconds - * parameter. If you do not provide this parameter, the returned URL is valid for twelve hours.

- * - *

The URL that you get from a call to CreateApplicationPresignedUrl must be used within 3 minutes - * to be valid. - * If you first try to use the URL after the 3-minute limit expires, the service returns an HTTP 403 Forbidden error.

- *
+ * @see {@link CreateApplicationPresignedUrlCommand} */ - public createApplicationPresignedUrl( + createApplicationPresignedUrl( args: CreateApplicationPresignedUrlCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApplicationPresignedUrl( + createApplicationPresignedUrl( args: CreateApplicationPresignedUrlCommandInput, cb: (err: any, data?: CreateApplicationPresignedUrlCommandOutput) => void ): void; - public createApplicationPresignedUrl( + createApplicationPresignedUrl( args: CreateApplicationPresignedUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApplicationPresignedUrlCommandOutput) => void ): void; - public createApplicationPresignedUrl( - args: CreateApplicationPresignedUrlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApplicationPresignedUrlCommandOutput) => void), - cb?: (err: any, data?: CreateApplicationPresignedUrlCommandOutput) => void - ): Promise | void { - const command = new CreateApplicationPresignedUrlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a snapshot of the application's state data.

+ * @see {@link CreateApplicationSnapshotCommand} */ - public createApplicationSnapshot( + createApplicationSnapshot( args: CreateApplicationSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApplicationSnapshot( + createApplicationSnapshot( args: CreateApplicationSnapshotCommandInput, cb: (err: any, data?: CreateApplicationSnapshotCommandOutput) => void ): void; - public createApplicationSnapshot( + createApplicationSnapshot( args: CreateApplicationSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApplicationSnapshotCommandOutput) => void ): void; - public createApplicationSnapshot( - args: CreateApplicationSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApplicationSnapshotCommandOutput) => void), - cb?: (err: any, data?: CreateApplicationSnapshotCommandOutput) => void - ): Promise | void { - const command = new CreateApplicationSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the application.

+ * @see {@link DeleteApplicationCommand} */ - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( - args: DeleteApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApplicationCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application.

+ * @see {@link DeleteApplicationCloudWatchLoggingOptionCommand} */ - public deleteApplicationCloudWatchLoggingOption( + deleteApplicationCloudWatchLoggingOption( args: DeleteApplicationCloudWatchLoggingOptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplicationCloudWatchLoggingOption( + deleteApplicationCloudWatchLoggingOption( args: DeleteApplicationCloudWatchLoggingOptionCommandInput, cb: (err: any, data?: DeleteApplicationCloudWatchLoggingOptionCommandOutput) => void ): void; - public deleteApplicationCloudWatchLoggingOption( + deleteApplicationCloudWatchLoggingOption( args: DeleteApplicationCloudWatchLoggingOptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationCloudWatchLoggingOptionCommandOutput) => void ): void; - public deleteApplicationCloudWatchLoggingOption( - args: DeleteApplicationCloudWatchLoggingOptionCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteApplicationCloudWatchLoggingOptionCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationCloudWatchLoggingOptionCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationCloudWatchLoggingOptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an InputProcessingConfiguration from an input.

+ * @see {@link DeleteApplicationInputProcessingConfigurationCommand} */ - public deleteApplicationInputProcessingConfiguration( + deleteApplicationInputProcessingConfiguration( args: DeleteApplicationInputProcessingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplicationInputProcessingConfiguration( + deleteApplicationInputProcessingConfiguration( args: DeleteApplicationInputProcessingConfigurationCommandInput, cb: (err: any, data?: DeleteApplicationInputProcessingConfigurationCommandOutput) => void ): void; - public deleteApplicationInputProcessingConfiguration( + deleteApplicationInputProcessingConfiguration( args: DeleteApplicationInputProcessingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationInputProcessingConfigurationCommandOutput) => void ): void; - public deleteApplicationInputProcessingConfiguration( - args: DeleteApplicationInputProcessingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteApplicationInputProcessingConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationInputProcessingConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationInputProcessingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application's configuration. - * Kinesis Data Analytics will no longer write data from - * the corresponding in-application stream to the external output destination.

+ * @see {@link DeleteApplicationOutputCommand} */ - public deleteApplicationOutput( + deleteApplicationOutput( args: DeleteApplicationOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplicationOutput( + deleteApplicationOutput( args: DeleteApplicationOutputCommandInput, cb: (err: any, data?: DeleteApplicationOutputCommandOutput) => void ): void; - public deleteApplicationOutput( + deleteApplicationOutput( args: DeleteApplicationOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationOutputCommandOutput) => void ): void; - public deleteApplicationOutput( - args: DeleteApplicationOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApplicationOutputCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationOutputCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's configuration.

- *

If the application is running, Kinesis Data Analytics immediately removes the in-application table - * that you created using the AddApplicationReferenceDataSource operation.

+ * @see {@link DeleteApplicationReferenceDataSourceCommand} */ - public deleteApplicationReferenceDataSource( + deleteApplicationReferenceDataSource( args: DeleteApplicationReferenceDataSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplicationReferenceDataSource( + deleteApplicationReferenceDataSource( args: DeleteApplicationReferenceDataSourceCommandInput, cb: (err: any, data?: DeleteApplicationReferenceDataSourceCommandOutput) => void ): void; - public deleteApplicationReferenceDataSource( + deleteApplicationReferenceDataSource( args: DeleteApplicationReferenceDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationReferenceDataSourceCommandOutput) => void ): void; - public deleteApplicationReferenceDataSource( - args: DeleteApplicationReferenceDataSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApplicationReferenceDataSourceCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationReferenceDataSourceCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationReferenceDataSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a snapshot of application state.

+ * @see {@link DeleteApplicationSnapshotCommand} */ - public deleteApplicationSnapshot( + deleteApplicationSnapshot( args: DeleteApplicationSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplicationSnapshot( + deleteApplicationSnapshot( args: DeleteApplicationSnapshotCommandInput, cb: (err: any, data?: DeleteApplicationSnapshotCommandOutput) => void ): void; - public deleteApplicationSnapshot( + deleteApplicationSnapshot( args: DeleteApplicationSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationSnapshotCommandOutput) => void ): void; - public deleteApplicationSnapshot( - args: DeleteApplicationSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApplicationSnapshotCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationSnapshotCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a VPC configuration from a Kinesis Data Analytics application.

+ * @see {@link DeleteApplicationVpcConfigurationCommand} */ - public deleteApplicationVpcConfiguration( + deleteApplicationVpcConfiguration( args: DeleteApplicationVpcConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplicationVpcConfiguration( + deleteApplicationVpcConfiguration( args: DeleteApplicationVpcConfigurationCommandInput, cb: (err: any, data?: DeleteApplicationVpcConfigurationCommandOutput) => void ): void; - public deleteApplicationVpcConfiguration( + deleteApplicationVpcConfiguration( args: DeleteApplicationVpcConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationVpcConfigurationCommandOutput) => void ): void; - public deleteApplicationVpcConfiguration( - args: DeleteApplicationVpcConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApplicationVpcConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationVpcConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationVpcConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a specific Kinesis Data Analytics application.

- *

If you want to retrieve a list of all applications in your account, - * use the ListApplications operation.

+ * @see {@link DescribeApplicationCommand} */ - public describeApplication( + describeApplication( args: DescribeApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeApplication( + describeApplication( args: DescribeApplicationCommandInput, cb: (err: any, data?: DescribeApplicationCommandOutput) => void ): void; - public describeApplication( + describeApplication( args: DescribeApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeApplicationCommandOutput) => void ): void; - public describeApplication( - args: DescribeApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeApplicationCommandOutput) => void), - cb?: (err: any, data?: DescribeApplicationCommandOutput) => void - ): Promise | void { - const command = new DescribeApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a snapshot of application state data.

+ * @see {@link DescribeApplicationSnapshotCommand} */ - public describeApplicationSnapshot( + describeApplicationSnapshot( args: DescribeApplicationSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeApplicationSnapshot( + describeApplicationSnapshot( args: DescribeApplicationSnapshotCommandInput, cb: (err: any, data?: DescribeApplicationSnapshotCommandOutput) => void ): void; - public describeApplicationSnapshot( + describeApplicationSnapshot( args: DescribeApplicationSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeApplicationSnapshotCommandOutput) => void ): void; - public describeApplicationSnapshot( - args: DescribeApplicationSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeApplicationSnapshotCommandOutput) => void), - cb?: (err: any, data?: DescribeApplicationSnapshotCommandOutput) => void - ): Promise | void { - const command = new DescribeApplicationSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a detailed description of a specified version of the application. To see a list of all the versions of an application, invoke the ListApplicationVersions operation.

- * - *

This operation is supported only for Amazon Kinesis Data Analytics for Apache Flink.

- *
+ * @see {@link DescribeApplicationVersionCommand} */ - public describeApplicationVersion( + describeApplicationVersion( args: DescribeApplicationVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeApplicationVersion( + describeApplicationVersion( args: DescribeApplicationVersionCommandInput, cb: (err: any, data?: DescribeApplicationVersionCommandOutput) => void ): void; - public describeApplicationVersion( + describeApplicationVersion( args: DescribeApplicationVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeApplicationVersionCommandOutput) => void ): void; - public describeApplicationVersion( - args: DescribeApplicationVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeApplicationVersionCommandOutput) => void), - cb?: (err: any, data?: DescribeApplicationVersionCommandOutput) => void - ): Promise | void { - const command = new DescribeApplicationVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating - * sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose - * delivery stream) or Amazon S3 object. In the response, the operation returns the inferred - * schema and also the sample records that the operation used to infer the schema.

- *

You can use the inferred schema when configuring a streaming source for your application. - * When you create an application using the Kinesis Data Analytics console, the console uses this - * operation to infer a schema and show it in the console user interface.

+ * @see {@link DiscoverInputSchemaCommand} */ - public discoverInputSchema( + discoverInputSchema( args: DiscoverInputSchemaCommandInput, options?: __HttpHandlerOptions ): Promise; - public discoverInputSchema( + discoverInputSchema( args: DiscoverInputSchemaCommandInput, cb: (err: any, data?: DiscoverInputSchemaCommandOutput) => void ): void; - public discoverInputSchema( + discoverInputSchema( args: DiscoverInputSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DiscoverInputSchemaCommandOutput) => void ): void; - public discoverInputSchema( - args: DiscoverInputSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DiscoverInputSchemaCommandOutput) => void), - cb?: (err: any, data?: DiscoverInputSchemaCommandOutput) => void - ): Promise | void { - const command = new DiscoverInputSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of Kinesis Data Analytics applications in your account. For each - * application, the response includes the application name, Amazon Resource Name (ARN), and - * status.

- *

If you want detailed information about a specific application, use - * DescribeApplication.

+ * @see {@link ListApplicationsCommand} */ - public listApplications( + listApplications( args: ListApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplications( + listApplications( args: ListApplicationsCommandInput, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( + listApplications( args: ListApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( - args: ListApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationsCommandOutput) => void), - cb?: (err: any, data?: ListApplicationsCommandOutput) => void - ): Promise | void { - const command = new ListApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists information about the current application snapshots.

+ * @see {@link ListApplicationSnapshotsCommand} */ - public listApplicationSnapshots( + listApplicationSnapshots( args: ListApplicationSnapshotsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplicationSnapshots( + listApplicationSnapshots( args: ListApplicationSnapshotsCommandInput, cb: (err: any, data?: ListApplicationSnapshotsCommandOutput) => void ): void; - public listApplicationSnapshots( + listApplicationSnapshots( args: ListApplicationSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationSnapshotsCommandOutput) => void ): void; - public listApplicationSnapshots( - args: ListApplicationSnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationSnapshotsCommandOutput) => void), - cb?: (err: any, data?: ListApplicationSnapshotsCommandOutput) => void - ): Promise | void { - const command = new ListApplicationSnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the versions for the specified application, including versions that were rolled back. The response also includes a summary of the configuration - * associated with each version.

- * - *

To get the complete description of a specific application version, invoke the DescribeApplicationVersion operation.

- * - *

This operation is supported only for Amazon Kinesis Data Analytics for Apache Flink.

- *
+ * @see {@link ListApplicationVersionsCommand} */ - public listApplicationVersions( + listApplicationVersions( args: ListApplicationVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplicationVersions( + listApplicationVersions( args: ListApplicationVersionsCommandInput, cb: (err: any, data?: ListApplicationVersionsCommandOutput) => void ): void; - public listApplicationVersions( + listApplicationVersions( args: ListApplicationVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationVersionsCommandOutput) => void ): void; - public listApplicationVersions( - args: ListApplicationVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationVersionsCommandOutput) => void), - cb?: (err: any, data?: ListApplicationVersionsCommandOutput) => void - ): Promise | void { - const command = new ListApplicationVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the list of key-value tags assigned to the application. For more information, see - * Using Tagging.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Reverts the application to the previous running version. You can - * roll back an application if you suspect it is stuck in a transient status.

- *

You can roll back an application only if it is in the UPDATING - * or AUTOSCALING status.

- *

When you rollback an application, it loads state data from the last successful snapshot. - * If the application has no snapshots, Kinesis Data Analytics rejects the rollback request.

- *

This action is not supported for Kinesis Data Analytics for SQL applications.

+ * @see {@link RollbackApplicationCommand} */ - public rollbackApplication( + rollbackApplication( args: RollbackApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public rollbackApplication( + rollbackApplication( args: RollbackApplicationCommandInput, cb: (err: any, data?: RollbackApplicationCommandOutput) => void ): void; - public rollbackApplication( + rollbackApplication( args: RollbackApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RollbackApplicationCommandOutput) => void ): void; - public rollbackApplication( - args: RollbackApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RollbackApplicationCommandOutput) => void), - cb?: (err: any, data?: RollbackApplicationCommandOutput) => void - ): Promise | void { - const command = new RollbackApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts the specified Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to - * start your application.

+ * @see {@link StartApplicationCommand} */ - public startApplication( + startApplication( args: StartApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startApplication( + startApplication( args: StartApplicationCommandInput, cb: (err: any, data?: StartApplicationCommandOutput) => void ): void; - public startApplication( + startApplication( args: StartApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartApplicationCommandOutput) => void ): void; - public startApplication( - args: StartApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartApplicationCommandOutput) => void), - cb?: (err: any, data?: StartApplicationCommandOutput) => void - ): Promise | void { - const command = new StartApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops the application from processing data. You can stop - * an application only if it is in the running status, unless you set the Force - * parameter to true.

- *

You can use the DescribeApplication operation to find the application status. - *

- *

Kinesis Data Analytics takes a snapshot when the application is stopped, unless Force is set - * to true.

+ * @see {@link StopApplicationCommand} */ - public stopApplication( + stopApplication( args: StopApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopApplication( - args: StopApplicationCommandInput, - cb: (err: any, data?: StopApplicationCommandOutput) => void - ): void; - public stopApplication( + stopApplication(args: StopApplicationCommandInput, cb: (err: any, data?: StopApplicationCommandOutput) => void): void; + stopApplication( args: StopApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopApplicationCommandOutput) => void ): void; - public stopApplication( - args: StopApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopApplicationCommandOutput) => void), - cb?: (err: any, data?: StopApplicationCommandOutput) => void - ): Promise | void { - const command = new StopApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more key-value tags to a Kinesis Data Analytics application. Note that the maximum number of application - * tags includes system tags. The maximum number of user-defined application tags is 50. - * For more information, see Using Tagging.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from a Kinesis Data Analytics application. For more information, see - * Using Tagging.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing Kinesis Data Analytics application. Using this operation, you - * can update application code, input configuration, and output configuration.

- *

Kinesis Data Analytics updates the ApplicationVersionId each time you update - * your application.

- * - *

You cannot update the RuntimeEnvironment of an existing application. If you - * need to update an application's RuntimeEnvironment, you must delete the application - * and create it again.

- *
+ * @see {@link UpdateApplicationCommand} */ - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( - args: UpdateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApplicationCommandOutput) => void), - cb?: (err: any, data?: UpdateApplicationCommandOutput) => void - ): Promise | void { - const command = new UpdateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the maintenance configuration of the Kinesis Data Analytics application.

- *

You can invoke this operation on an application that is in one of the two following - * states: READY or RUNNING. If you invoke it when the application is - * in a state other than these two states, it throws a ResourceInUseException. The - * service makes use of the updated configuration the next time it schedules maintenance for the - * application. If you invoke this operation after the service schedules maintenance, the service - * will apply the configuration update the next time it schedules maintenance for the - * application. This means that you might not see the maintenance configuration update applied to - * the maintenance process that follows a successful invocation of this operation, but to the - * following maintenance process instead.

- *

To see the current maintenance configuration of your application, invoke the - * DescribeApplication operation.

- *

For information about application maintenance, see Kinesis Data Analytics for Apache Flink Maintenance.

- * - *

This operation is supported only for Amazon Kinesis Data Analytics for Apache Flink.

- *
+ * @see {@link UpdateApplicationMaintenanceConfigurationCommand} */ - public updateApplicationMaintenanceConfiguration( + updateApplicationMaintenanceConfiguration( args: UpdateApplicationMaintenanceConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApplicationMaintenanceConfiguration( + updateApplicationMaintenanceConfiguration( args: UpdateApplicationMaintenanceConfigurationCommandInput, cb: (err: any, data?: UpdateApplicationMaintenanceConfigurationCommandOutput) => void ): void; - public updateApplicationMaintenanceConfiguration( + updateApplicationMaintenanceConfiguration( args: UpdateApplicationMaintenanceConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationMaintenanceConfigurationCommandOutput) => void ): void; - public updateApplicationMaintenanceConfiguration( - args: UpdateApplicationMaintenanceConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateApplicationMaintenanceConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateApplicationMaintenanceConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateApplicationMaintenanceConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Kinesis Data Analytics is a fully managed service that you can use to process and analyze streaming data using Java, SQL, or Scala. The service + * enables you to quickly author and run Java, SQL, or Scala code against streaming sources to perform time + * series analytics, feed real-time dashboards, and create real-time metrics.

+ */ +export class KinesisAnalyticsV2 extends KinesisAnalyticsV2Client implements KinesisAnalyticsV2 {} +createAggregatedClient(commands, KinesisAnalyticsV2); diff --git a/clients/client-kinesis-analytics/src/KinesisAnalytics.ts b/clients/client-kinesis-analytics/src/KinesisAnalytics.ts index 57cd09198375..0cbd669cb94e 100644 --- a/clients/client-kinesis-analytics/src/KinesisAnalytics.ts +++ b/clients/client-kinesis-analytics/src/KinesisAnalytics.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -97,862 +98,370 @@ import { UpdateApplicationCommandInput, UpdateApplicationCommandOutput, } from "./commands/UpdateApplicationCommand"; -import { KinesisAnalyticsClient } from "./KinesisAnalyticsClient"; +import { KinesisAnalyticsClient, KinesisAnalyticsClientConfig } from "./KinesisAnalyticsClient"; -/** - * @public - * Amazon Kinesis Analytics - *

- * Overview - *

- * - *

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

- *
- *

This is the Amazon Kinesis Analytics v1 API Reference. - * The Amazon Kinesis Analytics Developer Guide provides additional information. - *

- */ -export class KinesisAnalytics extends KinesisAnalyticsClient { +const commands = { + AddApplicationCloudWatchLoggingOptionCommand, + AddApplicationInputCommand, + AddApplicationInputProcessingConfigurationCommand, + AddApplicationOutputCommand, + AddApplicationReferenceDataSourceCommand, + CreateApplicationCommand, + DeleteApplicationCommand, + DeleteApplicationCloudWatchLoggingOptionCommand, + DeleteApplicationInputProcessingConfigurationCommand, + DeleteApplicationOutputCommand, + DeleteApplicationReferenceDataSourceCommand, + DescribeApplicationCommand, + DiscoverInputSchemaCommand, + ListApplicationsCommand, + ListTagsForResourceCommand, + StartApplicationCommand, + StopApplicationCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateApplicationCommand, +}; + +export interface KinesisAnalytics { /** - * @public - * - *

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

- *
- *

Adds a CloudWatch log stream to monitor application configuration errors. For more - * information about using CloudWatch log streams with Amazon Kinesis Analytics - * applications, see Working with Amazon - * CloudWatch Logs.

+ * @see {@link AddApplicationCloudWatchLoggingOptionCommand} */ - public addApplicationCloudWatchLoggingOption( + addApplicationCloudWatchLoggingOption( args: AddApplicationCloudWatchLoggingOptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public addApplicationCloudWatchLoggingOption( + addApplicationCloudWatchLoggingOption( args: AddApplicationCloudWatchLoggingOptionCommandInput, cb: (err: any, data?: AddApplicationCloudWatchLoggingOptionCommandOutput) => void ): void; - public addApplicationCloudWatchLoggingOption( + addApplicationCloudWatchLoggingOption( args: AddApplicationCloudWatchLoggingOptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddApplicationCloudWatchLoggingOptionCommandOutput) => void ): void; - public addApplicationCloudWatchLoggingOption( - args: AddApplicationCloudWatchLoggingOptionCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AddApplicationCloudWatchLoggingOptionCommandOutput) => void), - cb?: (err: any, data?: AddApplicationCloudWatchLoggingOptionCommandOutput) => void - ): Promise | void { - const command = new AddApplicationCloudWatchLoggingOptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

- *
- *

- * Adds a streaming source to your Amazon Kinesis application. - * For conceptual information, - * see Configuring Application Input. - *

- *

You can add a streaming source either when you create an application or you can use - * this operation to add a streaming source after you create an application. For more information, see - * CreateApplication.

- *

Any configuration update, including adding a streaming source using this operation, - * results in a new version of the application. You can use the DescribeApplication operation - * to find the current application version. - *

- *

This operation requires permissions to perform the - * kinesisanalytics:AddApplicationInput action.

+ * @see {@link AddApplicationInputCommand} */ - public addApplicationInput( + addApplicationInput( args: AddApplicationInputCommandInput, options?: __HttpHandlerOptions ): Promise; - public addApplicationInput( + addApplicationInput( args: AddApplicationInputCommandInput, cb: (err: any, data?: AddApplicationInputCommandOutput) => void ): void; - public addApplicationInput( + addApplicationInput( args: AddApplicationInputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddApplicationInputCommandOutput) => void ): void; - public addApplicationInput( - args: AddApplicationInputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddApplicationInputCommandOutput) => void), - cb?: (err: any, data?: AddApplicationInputCommandOutput) => void - ): Promise | void { - const command = new AddApplicationInputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

- *
- *

Adds an InputProcessingConfiguration to an application. An input processor preprocesses records on the input stream - * before the application's SQL code executes. Currently, the only input processor available is - * AWS Lambda.

+ * @see {@link AddApplicationInputProcessingConfigurationCommand} */ - public addApplicationInputProcessingConfiguration( + addApplicationInputProcessingConfiguration( args: AddApplicationInputProcessingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public addApplicationInputProcessingConfiguration( + addApplicationInputProcessingConfiguration( args: AddApplicationInputProcessingConfigurationCommandInput, cb: (err: any, data?: AddApplicationInputProcessingConfigurationCommandOutput) => void ): void; - public addApplicationInputProcessingConfiguration( + addApplicationInputProcessingConfiguration( args: AddApplicationInputProcessingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddApplicationInputProcessingConfigurationCommandOutput) => void ): void; - public addApplicationInputProcessingConfiguration( - args: AddApplicationInputProcessingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AddApplicationInputProcessingConfigurationCommandOutput) => void), - cb?: (err: any, data?: AddApplicationInputProcessingConfigurationCommandOutput) => void - ): Promise | void { - const command = new AddApplicationInputProcessingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

- *
- *

Adds an external destination to your Amazon Kinesis Analytics application.

- *

If you want Amazon Kinesis Analytics to deliver data from an in-application stream - * within your application to an external destination (such as an Amazon Kinesis stream, an - * Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), you add the - * relevant configuration to your application using this operation. You can configure one - * or more outputs for your application. Each output configuration maps an in-application - * stream and an external destination.

- *

You can use one of the output configurations to deliver data from your - * in-application error stream to an external destination so that you can analyze the - * errors. For more information, see Understanding Application - * Output (Destination).

- *

Any configuration update, including adding a streaming source using this - * operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application - * version.

- *

For the limits on the number of application inputs and outputs - * you can configure, see Limits.

- *

This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.

+ * @see {@link AddApplicationOutputCommand} */ - public addApplicationOutput( + addApplicationOutput( args: AddApplicationOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public addApplicationOutput( + addApplicationOutput( args: AddApplicationOutputCommandInput, cb: (err: any, data?: AddApplicationOutputCommandOutput) => void ): void; - public addApplicationOutput( + addApplicationOutput( args: AddApplicationOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddApplicationOutputCommandOutput) => void ): void; - public addApplicationOutput( - args: AddApplicationOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddApplicationOutputCommandOutput) => void), - cb?: (err: any, data?: AddApplicationOutputCommandOutput) => void - ): Promise | void { - const command = new AddApplicationOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

- *
- *

Adds a reference data source to an existing application.

- *

Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table.

- *

- * For conceptual information, - * see Configuring Application Input. - * For the limits on data sources you can add to your application, see - * Limits. - *

- *

- * This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action. - *

+ * @see {@link AddApplicationReferenceDataSourceCommand} */ - public addApplicationReferenceDataSource( + addApplicationReferenceDataSource( args: AddApplicationReferenceDataSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public addApplicationReferenceDataSource( + addApplicationReferenceDataSource( args: AddApplicationReferenceDataSourceCommandInput, cb: (err: any, data?: AddApplicationReferenceDataSourceCommandOutput) => void ): void; - public addApplicationReferenceDataSource( + addApplicationReferenceDataSource( args: AddApplicationReferenceDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddApplicationReferenceDataSourceCommandOutput) => void ): void; - public addApplicationReferenceDataSource( - args: AddApplicationReferenceDataSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddApplicationReferenceDataSourceCommandOutput) => void), - cb?: (err: any, data?: AddApplicationReferenceDataSourceCommandOutput) => void - ): Promise | void { - const command = new AddApplicationReferenceDataSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

- *
- * - *

- * Creates an Amazon Kinesis Analytics application. - * You can configure each application with one streaming source as input, - * application code to process the input, and up to - * three destinations where - * you want Amazon Kinesis Analytics to write the output data from your application. - * For an overview, see - * How it Works. - *

- *

In the input configuration, you map the streaming source to an in-application stream, which you can think of as a constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each data column in the in-application stream to a - * data element in the streaming source.

- * - *

Your application code is one or more SQL statements that read input data, transform it, and generate output. Your application code can create one or more SQL artifacts like SQL streams or pumps.

- *

In the output configuration, you can configure the application to write data from in-application streams created in your applications to up to three destinations.

- *

- * To read data from your source stream or write data to destination streams, Amazon Kinesis Analytics - * needs your permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform the - * kinesisanalytics:CreateApplication action. - *

- *

- * For introductory exercises to create an Amazon Kinesis Analytics application, see - * Getting Started. - *

+ * @see {@link CreateApplicationCommand} */ - public createApplication( + createApplication( args: CreateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApplication( + createApplication( args: CreateApplicationCommandInput, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( + createApplication( args: CreateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( - args: CreateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApplicationCommandOutput) => void), - cb?: (err: any, data?: CreateApplicationCommandOutput) => void - ): Promise | void { - const command = new CreateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

- *
- *

Deletes the specified application. Amazon Kinesis Analytics halts application execution and deletes the application, including any application artifacts (such as in-application streams, reference table, and application code).

- * - *

This operation requires permissions to perform the kinesisanalytics:DeleteApplication action.

+ * @see {@link DeleteApplicationCommand} */ - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( - args: DeleteApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApplicationCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

- *
- *

Deletes a CloudWatch log stream from an application. For more information about - * using CloudWatch log streams with Amazon Kinesis Analytics applications, see - * Working with Amazon CloudWatch Logs.

+ * @see {@link DeleteApplicationCloudWatchLoggingOptionCommand} */ - public deleteApplicationCloudWatchLoggingOption( + deleteApplicationCloudWatchLoggingOption( args: DeleteApplicationCloudWatchLoggingOptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplicationCloudWatchLoggingOption( + deleteApplicationCloudWatchLoggingOption( args: DeleteApplicationCloudWatchLoggingOptionCommandInput, cb: (err: any, data?: DeleteApplicationCloudWatchLoggingOptionCommandOutput) => void ): void; - public deleteApplicationCloudWatchLoggingOption( + deleteApplicationCloudWatchLoggingOption( args: DeleteApplicationCloudWatchLoggingOptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationCloudWatchLoggingOptionCommandOutput) => void ): void; - public deleteApplicationCloudWatchLoggingOption( - args: DeleteApplicationCloudWatchLoggingOptionCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteApplicationCloudWatchLoggingOptionCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationCloudWatchLoggingOptionCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationCloudWatchLoggingOptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

- *
- *

Deletes an InputProcessingConfiguration from an input.

+ * @see {@link DeleteApplicationInputProcessingConfigurationCommand} */ - public deleteApplicationInputProcessingConfiguration( + deleteApplicationInputProcessingConfiguration( args: DeleteApplicationInputProcessingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplicationInputProcessingConfiguration( + deleteApplicationInputProcessingConfiguration( args: DeleteApplicationInputProcessingConfigurationCommandInput, cb: (err: any, data?: DeleteApplicationInputProcessingConfigurationCommandOutput) => void ): void; - public deleteApplicationInputProcessingConfiguration( + deleteApplicationInputProcessingConfiguration( args: DeleteApplicationInputProcessingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationInputProcessingConfigurationCommandOutput) => void ): void; - public deleteApplicationInputProcessingConfiguration( - args: DeleteApplicationInputProcessingConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteApplicationInputProcessingConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationInputProcessingConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationInputProcessingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

- *
- *

Deletes output destination configuration from your application configuration. Amazon Kinesis Analytics will no longer write data from the corresponding in-application stream to the external output destination.

- *

This operation requires permissions to perform the - * kinesisanalytics:DeleteApplicationOutput action.

+ * @see {@link DeleteApplicationOutputCommand} */ - public deleteApplicationOutput( + deleteApplicationOutput( args: DeleteApplicationOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplicationOutput( + deleteApplicationOutput( args: DeleteApplicationOutputCommandInput, cb: (err: any, data?: DeleteApplicationOutputCommandOutput) => void ): void; - public deleteApplicationOutput( + deleteApplicationOutput( args: DeleteApplicationOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationOutputCommandOutput) => void ): void; - public deleteApplicationOutput( - args: DeleteApplicationOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApplicationOutputCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationOutputCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

- *
- *

Deletes a reference data source configuration from the specified application configuration.

- *

If the application is running, Amazon Kinesis Analytics immediately removes the in-application table - * that you created using the AddApplicationReferenceDataSource operation.

- * - *

This operation requires permissions to perform the kinesisanalytics.DeleteApplicationReferenceDataSource - * action.

+ * @see {@link DeleteApplicationReferenceDataSourceCommand} */ - public deleteApplicationReferenceDataSource( + deleteApplicationReferenceDataSource( args: DeleteApplicationReferenceDataSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplicationReferenceDataSource( + deleteApplicationReferenceDataSource( args: DeleteApplicationReferenceDataSourceCommandInput, cb: (err: any, data?: DeleteApplicationReferenceDataSourceCommandOutput) => void ): void; - public deleteApplicationReferenceDataSource( + deleteApplicationReferenceDataSource( args: DeleteApplicationReferenceDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationReferenceDataSourceCommandOutput) => void ): void; - public deleteApplicationReferenceDataSource( - args: DeleteApplicationReferenceDataSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApplicationReferenceDataSourceCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationReferenceDataSourceCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationReferenceDataSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

- *
- *

Returns information about a specific Amazon Kinesis Analytics application.

- *

If you want to retrieve a list of all applications in your account, - * use the ListApplications operation.

- *

This operation requires permissions to perform the kinesisanalytics:DescribeApplication - * action. You can use DescribeApplication to get the current application versionId, which you need to call other - * operations such as Update. - *

+ * @see {@link DescribeApplicationCommand} */ - public describeApplication( + describeApplication( args: DescribeApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeApplication( + describeApplication( args: DescribeApplicationCommandInput, cb: (err: any, data?: DescribeApplicationCommandOutput) => void ): void; - public describeApplication( + describeApplication( args: DescribeApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeApplicationCommandOutput) => void ): void; - public describeApplication( - args: DescribeApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeApplicationCommandOutput) => void), - cb?: (err: any, data?: DescribeApplicationCommandOutput) => void - ): Promise | void { - const command = new DescribeApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

- *
- *

Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream) or S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema.

- *

- * You can use the inferred schema when configuring a streaming source - * for your application. For conceptual information, - * see Configuring Application Input. - * Note that when you create an application using the Amazon Kinesis Analytics console, - * the console uses this operation to infer a schema and show it in the console user interface. - *

- *

- * This operation requires permissions to perform the - * kinesisanalytics:DiscoverInputSchema action. - *

+ * @see {@link DiscoverInputSchemaCommand} */ - public discoverInputSchema( + discoverInputSchema( args: DiscoverInputSchemaCommandInput, options?: __HttpHandlerOptions ): Promise; - public discoverInputSchema( + discoverInputSchema( args: DiscoverInputSchemaCommandInput, cb: (err: any, data?: DiscoverInputSchemaCommandOutput) => void ): void; - public discoverInputSchema( + discoverInputSchema( args: DiscoverInputSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DiscoverInputSchemaCommandOutput) => void ): void; - public discoverInputSchema( - args: DiscoverInputSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DiscoverInputSchemaCommandOutput) => void), - cb?: (err: any, data?: DiscoverInputSchemaCommandOutput) => void - ): Promise | void { - const command = new DiscoverInputSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

- *
- *

Returns a list of Amazon Kinesis Analytics applications in your account. - * For each application, the response includes the application name, - * Amazon Resource Name (ARN), and status. - * - * If the response returns the HasMoreApplications value as true, - * you can send another request by adding the - * ExclusiveStartApplicationName in the request body, and - * set the value of this to the last application name from - * the previous response. - *

- *

If you want detailed information about a specific application, use - * DescribeApplication.

- *

This operation requires permissions to perform the - * kinesisanalytics:ListApplications action.

+ * @see {@link ListApplicationsCommand} */ - public listApplications( + listApplications( args: ListApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplications( + listApplications( args: ListApplicationsCommandInput, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( + listApplications( args: ListApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( - args: ListApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationsCommandOutput) => void), - cb?: (err: any, data?: ListApplicationsCommandOutput) => void - ): Promise | void { - const command = new ListApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

- *
- *

Starts the specified Amazon Kinesis Analytics application. After creating an application, you must exclusively call this operation to start your application.

- *

After the application starts, it begins consuming the input data, processes it, and writes the output to the configured destination.

- *

- * The application status must be READY for you to start an application. You can - * get the application status in the console or using the DescribeApplication operation.

- *

After you start the application, you can stop the application from processing - * the input by calling the StopApplication operation.

- *

This operation requires permissions to perform the - * kinesisanalytics:StartApplication action.

+ * @see {@link StartApplicationCommand} */ - public startApplication( + startApplication( args: StartApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startApplication( + startApplication( args: StartApplicationCommandInput, cb: (err: any, data?: StartApplicationCommandOutput) => void ): void; - public startApplication( + startApplication( args: StartApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartApplicationCommandOutput) => void ): void; - public startApplication( - args: StartApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartApplicationCommandOutput) => void), - cb?: (err: any, data?: StartApplicationCommandOutput) => void - ): Promise | void { - const command = new StartApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

- *
- *

Stops the application from processing input data. You can stop - * an application only if it is in the running state. - * You can use the DescribeApplication operation to find the application state. - * After the application is stopped, - * Amazon Kinesis Analytics stops reading data from the input, the - * application stops processing data, and there is no output written to the destination.

- *

This operation requires permissions to perform the - * kinesisanalytics:StopApplication action.

+ * @see {@link StopApplicationCommand} */ - public stopApplication( + stopApplication( args: StopApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopApplication( - args: StopApplicationCommandInput, - cb: (err: any, data?: StopApplicationCommandOutput) => void - ): void; - public stopApplication( + stopApplication(args: StopApplicationCommandInput, cb: (err: any, data?: StopApplicationCommandOutput) => void): void; + stopApplication( args: StopApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopApplicationCommandOutput) => void ): void; - public stopApplication( - args: StopApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopApplicationCommandOutput) => void), - cb?: (err: any, data?: StopApplicationCommandOutput) => void - ): Promise | void { - const command = new StopApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more key-value tags to a Kinesis Analytics application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. - * For more information, see Using Tagging.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from a Kinesis Analytics application. For more information, see Using Tagging.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

- *
- *

Updates an existing Amazon Kinesis Analytics application. Using this API, - * you can update application code, input configuration, and - * output configuration.

- *

Note that Amazon Kinesis Analytics updates the CurrentApplicationVersionId - * each time you update your application.

- *

This operation requires permission for the - * kinesisanalytics:UpdateApplication action.

+ * @see {@link UpdateApplicationCommand} */ - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( - args: UpdateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApplicationCommandOutput) => void), - cb?: (err: any, data?: UpdateApplicationCommandOutput) => void - ): Promise | void { - const command = new UpdateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Kinesis Analytics + *

+ * Overview + *

+ * + *

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

+ *
+ *

This is the Amazon Kinesis Analytics v1 API Reference. + * The Amazon Kinesis Analytics Developer Guide provides additional information. + *

+ */ +export class KinesisAnalytics extends KinesisAnalyticsClient implements KinesisAnalytics {} +createAggregatedClient(commands, KinesisAnalytics); diff --git a/clients/client-kinesis-video-archived-media/src/KinesisVideoArchivedMedia.ts b/clients/client-kinesis-video-archived-media/src/KinesisVideoArchivedMedia.ts index ba051a5a9fc6..7eb574a77e36 100644 --- a/clients/client-kinesis-video-archived-media/src/KinesisVideoArchivedMedia.ts +++ b/clients/client-kinesis-video-archived-media/src/KinesisVideoArchivedMedia.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { GetClipCommand, GetClipCommandInput, GetClipCommandOutput } from "./commands/GetClipCommand"; @@ -23,633 +24,109 @@ import { ListFragmentsCommandInput, ListFragmentsCommandOutput, } from "./commands/ListFragmentsCommand"; -import { KinesisVideoArchivedMediaClient } from "./KinesisVideoArchivedMediaClient"; +import { + KinesisVideoArchivedMediaClient, + KinesisVideoArchivedMediaClientConfig, +} from "./KinesisVideoArchivedMediaClient"; -/** - * @public - *

- */ -export class KinesisVideoArchivedMedia extends KinesisVideoArchivedMediaClient { +const commands = { + GetClipCommand, + GetDASHStreamingSessionURLCommand, + GetHLSStreamingSessionURLCommand, + GetImagesCommand, + GetMediaForFragmentListCommand, + ListFragmentsCommand, +}; + +export interface KinesisVideoArchivedMedia { /** - * @public - *

Downloads an MP4 file (clip) containing the archived, on-demand media from the - * specified video stream over the specified time range.

- *

Both the StreamName and the StreamARN parameters are optional, but you must specify - * either the StreamName or the StreamARN when invoking this API operation.

- * - *

As a prerequisite to using GetCLip API, you must obtain an endpoint using - * GetDataEndpoint, specifying GET_CLIP for the - * APIName parameter.

- *

An Amazon Kinesis video stream has the following requirements for providing data - * through MP4:

- *
    - *
  • - *

    The media must contain h.264 or h.265 encoded video and, optionally, AAC or - * G.711 encoded audio. Specifically, the codec ID of track 1 should be - * V_MPEG/ISO/AVC (for h.264) or V_MPEGH/ISO/HEVC (for H.265). - * Optionally, the codec ID of track 2 should be A_AAC (for AAC) or - * A_MS/ACM (for G.711).

    - *
  • - *
  • - *

    Data retention must be greater than 0.

    - *
  • - *
  • - *

    The video track of each fragment must contain codec private data in the - * Advanced Video Coding (AVC) for H.264 format and HEVC for H.265 format. For more - * information, see MPEG-4 - * specification ISO/IEC 14496-15. For information about adapting - * stream data to a given format, see NAL Adaptation Flags.

    - *
  • - *
  • - *

    The audio track (if present) of each fragment must contain codec private data - * in the AAC format (AAC - * specification ISO/IEC 13818-7) or the MS - * Wave format.

    - *
  • - *
- * - *

You can monitor the amount of outgoing data by monitoring the - * GetClip.OutgoingBytes Amazon CloudWatch metric. For information about - * using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video - * Streams Pricing and AWS - * Pricing. Charges for outgoing AWS data apply.

+ * @see {@link GetClipCommand} */ - public getClip(args: GetClipCommandInput, options?: __HttpHandlerOptions): Promise; - public getClip(args: GetClipCommandInput, cb: (err: any, data?: GetClipCommandOutput) => void): void; - public getClip( + getClip(args: GetClipCommandInput, options?: __HttpHandlerOptions): Promise; + getClip(args: GetClipCommandInput, cb: (err: any, data?: GetClipCommandOutput) => void): void; + getClip( args: GetClipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetClipCommandOutput) => void ): void; - public getClip( - args: GetClipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetClipCommandOutput) => void), - cb?: (err: any, data?: GetClipCommandOutput) => void - ): Promise | void { - const command = new GetClipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves an MPEG Dynamic Adaptive Streaming over HTTP (DASH) URL for the stream. You - * can then open the URL in a media player to view the stream contents.

- * - *

Both the StreamName and the StreamARN parameters are - * optional, but you must specify either the StreamName or the - * StreamARN when invoking this API operation.

- *

An Amazon Kinesis video stream has the following requirements for providing data - * through MPEG-DASH:

- *
    - *
  • - *

    The media must contain h.264 or h.265 encoded video and, optionally, AAC or - * G.711 encoded audio. Specifically, the codec ID of track 1 should be - * V_MPEG/ISO/AVC (for h.264) or V_MPEGH/ISO/HEVC (for H.265). - * Optionally, the codec ID of track 2 should be A_AAC (for AAC) or - * A_MS/ACM (for G.711).

    - *
  • - *
  • - *

    Data retention must be greater than 0.

    - *
  • - *
  • - *

    The video track of each fragment must contain codec private data in the - * Advanced Video Coding (AVC) for H.264 format and HEVC for H.265 format. For more - * information, see MPEG-4 - * specification ISO/IEC 14496-15. For information about adapting - * stream data to a given format, see NAL Adaptation Flags.

    - *
  • - *
  • - *

    The audio track (if present) of each fragment must contain codec private data - * in the AAC format (AAC - * specification ISO/IEC 13818-7) or the MS - * Wave format.

    - *
  • - *
- * - *

The following procedure shows how to use MPEG-DASH with Kinesis Video Streams:

- *
    - *
  1. - *

    Get an endpoint using GetDataEndpoint, specifying - * GET_DASH_STREAMING_SESSION_URL for the APIName - * parameter.

    - *
  2. - *
  3. - *

    Retrieve the MPEG-DASH URL using GetDASHStreamingSessionURL. - * Kinesis Video Streams creates an MPEG-DASH streaming session to be used for - * accessing content in a stream using the MPEG-DASH protocol. - * GetDASHStreamingSessionURL returns an authenticated URL (that - * includes an encrypted session token) for the session's MPEG-DASH - * manifest (the root resource needed for streaming with - * MPEG-DASH).

    - * - *

    Don't share or store this token where an unauthorized entity can access - * it. The token provides access to the content of the stream. Safeguard the - * token with the same measures that you use with your AWS credentials.

    - *
    - *

    The media that is made available through the manifest consists only of the - * requested stream, time range, and format. No other media data (such as frames - * outside the requested window or alternate bitrates) is made available.

    - *
  4. - *
  5. - *

    Provide the URL (containing the encrypted session token) for the MPEG-DASH - * manifest to a media player that supports the MPEG-DASH protocol. Kinesis Video - * Streams makes the initialization fragment and media fragments available through - * the manifest URL. The initialization fragment contains the codec private data - * for the stream, and other data needed to set up the video or audio decoder and - * renderer. The media fragments contain encoded video frames or encoded audio - * samples.

    - *
  6. - *
  7. - *

    The media player receives the authenticated URL and requests stream metadata - * and media data normally. When the media player requests data, it calls the - * following actions:

    - *
      - *
    • - *

      - * GetDASHManifest: Retrieves an MPEG DASH - * manifest, which contains the metadata for the media that you want to - * playback.

      - *
    • - *
    • - *

      - * GetMP4InitFragment: Retrieves the MP4 - * initialization fragment. The media player typically loads the - * initialization fragment before loading any media fragments. This - * fragment contains the "fytp" and "moov" MP4 - * atoms, and the child atoms that are needed to initialize the media - * player decoder.

      - *

      The initialization fragment does not correspond to a fragment in a - * Kinesis video stream. It contains only the codec private data for the - * stream and respective track, which the media player needs to decode the - * media frames.

      - *
    • - *
    • - *

      - * GetMP4MediaFragment: Retrieves MP4 - * media fragments. These fragments contain the "moof" and - * "mdat" MP4 atoms and their child atoms, containing the - * encoded fragment's media frames and their timestamps.

      - * - *

      After the first media fragment is made available in a streaming - * session, any fragments that don't contain the same codec private - * data cause an error to be returned when those different media - * fragments are loaded. Therefore, the codec private data should not - * change between fragments in a session. This also means that the - * session fails if the fragments in a stream change from having only - * video to having both audio and video.

      - *
      - *

      Data retrieved with this action is billable. See Pricing for details.

      - *
    • - *
    - *
  8. - *
- * - *

For restrictions that apply to MPEG-DASH sessions, see Kinesis Video Streams Limits.

- *
- *

You can monitor the amount of data that the media player consumes by monitoring the - * GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For - * information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video - * Streams Pricing and AWS - * Pricing. Charges for both HLS sessions and outgoing AWS data apply.

- *

For more information about HLS, see HTTP Live Streaming on the - * Apple Developer site.

- * - * - *

If an error is thrown after invoking a Kinesis Video Streams archived media API, - * in addition to the HTTP status code and the response body, it includes the following - * pieces of information:

- *
    - *
  • - *

    - * x-amz-ErrorType HTTP header – contains a more specific error - * type in addition to what the HTTP status code provides.

    - *
  • - *
  • - *

    - * x-amz-RequestId HTTP header – if you want to report an issue to - * AWS, the support team can better diagnose the problem if given the Request - * Id.

    - *
  • - *
- *

Both the HTTP status code and the ErrorType header can be utilized to make - * programmatic decisions about whether errors are retry-able and under what - * conditions, as well as provide information on what actions the client programmer - * might need to take in order to successfully try again.

- *

For more information, see the Errors section at - * the bottom of this topic, as well as Common Errors. - *

- *
+ * @see {@link GetDASHStreamingSessionURLCommand} */ - public getDASHStreamingSessionURL( + getDASHStreamingSessionURL( args: GetDASHStreamingSessionURLCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDASHStreamingSessionURL( + getDASHStreamingSessionURL( args: GetDASHStreamingSessionURLCommandInput, cb: (err: any, data?: GetDASHStreamingSessionURLCommandOutput) => void ): void; - public getDASHStreamingSessionURL( + getDASHStreamingSessionURL( args: GetDASHStreamingSessionURLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDASHStreamingSessionURLCommandOutput) => void ): void; - public getDASHStreamingSessionURL( - args: GetDASHStreamingSessionURLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDASHStreamingSessionURLCommandOutput) => void), - cb?: (err: any, data?: GetDASHStreamingSessionURLCommandOutput) => void - ): Promise | void { - const command = new GetDASHStreamingSessionURLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves an HTTP Live Streaming (HLS) URL for the stream. You can then open the URL - * in a browser or media player to view the stream contents.

- *

Both the StreamName and the StreamARN parameters are - * optional, but you must specify either the StreamName or the - * StreamARN when invoking this API operation.

- *

An Amazon Kinesis video stream has the following requirements for providing data - * through HLS:

- *
    - *
  • - *

    The media must contain h.264 or h.265 encoded video and, optionally, AAC - * encoded audio. Specifically, the codec ID of track 1 should be - * V_MPEG/ISO/AVC (for h.264) or V_MPEG/ISO/HEVC (for - * h.265). Optionally, the codec ID of track 2 should be A_AAC.

    - *
  • - *
  • - *

    Data retention must be greater than 0.

    - *
  • - *
  • - *

    The video track of each fragment must contain codec private data in the - * Advanced Video Coding (AVC) for H.264 format or HEVC for H.265 format (MPEG-4 specification ISO/IEC - * 14496-15). For information about adapting stream data to a given - * format, see NAL Adaptation Flags.

    - *
  • - *
  • - *

    The audio track (if present) of each fragment must contain codec private data - * in the AAC format (AAC - * specification ISO/IEC 13818-7).

    - *
  • - *
- *

Kinesis Video Streams HLS sessions contain fragments in the fragmented MPEG-4 form - * (also called fMP4 or CMAF) or the MPEG-2 form (also called TS chunks, which the HLS - * specification also supports). For more information about HLS fragment types, see the - * HLS - * specification.

- *

The following procedure shows how to use HLS with Kinesis Video Streams:

- *
    - *
  1. - *

    Get an endpoint using GetDataEndpoint, specifying - * GET_HLS_STREAMING_SESSION_URL for the APIName - * parameter.

    - *
  2. - *
  3. - *

    Retrieve the HLS URL using GetHLSStreamingSessionURL. Kinesis - * Video Streams creates an HLS streaming session to be used for accessing content - * in a stream using the HLS protocol. GetHLSStreamingSessionURL - * returns an authenticated URL (that includes an encrypted session token) for the - * session's HLS master playlist (the root resource needed for - * streaming with HLS).

    - * - *

    Don't share or store this token where an unauthorized entity could access - * it. The token provides access to the content of the stream. Safeguard the - * token with the same measures that you would use with your AWS - * credentials.

    - *
    - *

    The media that is made available through the playlist consists only of the - * requested stream, time range, and format. No other media data (such as frames - * outside the requested window or alternate bitrates) is made available.

    - *
  4. - *
  5. - *

    Provide the URL (containing the encrypted session token) for the HLS master - * playlist to a media player that supports the HLS protocol. Kinesis Video Streams - * makes the HLS media playlist, initialization fragment, and media fragments - * available through the master playlist URL. The initialization fragment contains - * the codec private data for the stream, and other data needed to set up the video - * or audio decoder and renderer. The media fragments contain H.264-encoded video - * frames or AAC-encoded audio samples.

    - *
  6. - *
  7. - *

    The media player receives the authenticated URL and requests stream metadata - * and media data normally. When the media player requests data, it calls the - * following actions:

    - *
      - *
    • - *

      - * GetHLSMasterPlaylist: Retrieves an HLS - * master playlist, which contains a URL for the - * GetHLSMediaPlaylist action for each track, and - * additional metadata for the media player, including estimated bitrate - * and resolution.

      - *
    • - *
    • - *

      - * GetHLSMediaPlaylist: Retrieves an HLS - * media playlist, which contains a URL to access the MP4 initialization - * fragment with the GetMP4InitFragment action, and URLs to - * access the MP4 media fragments with the GetMP4MediaFragment - * actions. The HLS media playlist also contains metadata about the stream - * that the player needs to play it, such as whether the - * PlaybackMode is LIVE or - * ON_DEMAND. The HLS media playlist is typically static - * for sessions with a PlaybackType of ON_DEMAND. - * The HLS media playlist is continually updated with new fragments for - * sessions with a PlaybackType of LIVE. There is - * a distinct HLS media playlist for the video track and the audio track - * (if applicable) that contains MP4 media URLs for the specific track. - *

      - *
    • - *
    • - *

      - * GetMP4InitFragment: Retrieves the MP4 - * initialization fragment. The media player typically loads the - * initialization fragment before loading any media fragments. This - * fragment contains the "fytp" and "moov" MP4 - * atoms, and the child atoms that are needed to initialize the media - * player decoder.

      - *

      The initialization fragment does not correspond to a fragment in a - * Kinesis video stream. It contains only the codec private data for the - * stream and respective track, which the media player needs to decode the - * media frames.

      - *
    • - *
    • - *

      - * GetMP4MediaFragment: Retrieves MP4 - * media fragments. These fragments contain the "moof" and - * "mdat" MP4 atoms and their child atoms, containing the - * encoded fragment's media frames and their timestamps.

      - * - *

      After the first media fragment is made available in a streaming - * session, any fragments that don't contain the same codec private - * data cause an error to be returned when those different media - * fragments are loaded. Therefore, the codec private data should not - * change between fragments in a session. This also means that the - * session fails if the fragments in a stream change from having only - * video to having both audio and video.

      - *
      - *

      Data retrieved with this action is billable. See Pricing for details.

      - *
    • - *
    • - *

      - * GetTSFragment: Retrieves MPEG TS - * fragments containing both initialization and media data for all tracks - * in the stream.

      - * - *

      If the ContainerFormat is MPEG_TS, this - * API is used instead of GetMP4InitFragment and - * GetMP4MediaFragment to retrieve stream - * media.

      - *
      - *

      Data retrieved with this action is billable. For more information, see - * Kinesis Video Streams pricing.

      - *
    • - *
    - *
  8. - *
- *

A streaming session URL must not be shared between players. The service - * might throttle a session if multiple media players are sharing it. For - * connection limits, see Kinesis Video Streams Limits.

- *

You can monitor the amount of data that the media player consumes by monitoring the - * GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For - * information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video - * Streams Pricing and AWS - * Pricing. Charges for both HLS sessions and outgoing AWS data apply.

- *

For more information about HLS, see HTTP Live Streaming on the - * Apple Developer site.

- * - * - *

If an error is thrown after invoking a Kinesis Video Streams archived media API, - * in addition to the HTTP status code and the response body, it includes the following - * pieces of information:

- *
    - *
  • - *

    - * x-amz-ErrorType HTTP header – contains a more specific error - * type in addition to what the HTTP status code provides.

    - *
  • - *
  • - *

    - * x-amz-RequestId HTTP header – if you want to report an issue to - * AWS, the support team can better diagnose the problem if given the Request - * Id.

    - *
  • - *
- *

Both the HTTP status code and the ErrorType header can be utilized to make - * programmatic decisions about whether errors are retry-able and under what - * conditions, as well as provide information on what actions the client programmer - * might need to take in order to successfully try again.

- *

For more information, see the Errors section at - * the bottom of this topic, as well as Common Errors. - *

- *
+ * @see {@link GetHLSStreamingSessionURLCommand} */ - public getHLSStreamingSessionURL( + getHLSStreamingSessionURL( args: GetHLSStreamingSessionURLCommandInput, options?: __HttpHandlerOptions ): Promise; - public getHLSStreamingSessionURL( + getHLSStreamingSessionURL( args: GetHLSStreamingSessionURLCommandInput, cb: (err: any, data?: GetHLSStreamingSessionURLCommandOutput) => void ): void; - public getHLSStreamingSessionURL( + getHLSStreamingSessionURL( args: GetHLSStreamingSessionURLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHLSStreamingSessionURLCommandOutput) => void ): void; - public getHLSStreamingSessionURL( - args: GetHLSStreamingSessionURLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetHLSStreamingSessionURLCommandOutput) => void), - cb?: (err: any, data?: GetHLSStreamingSessionURLCommandOutput) => void - ): Promise | void { - const command = new GetHLSStreamingSessionURLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of Images corresponding to each timestamp for a given time range, sampling interval, and image format configuration.

+ * @see {@link GetImagesCommand} */ - public getImages(args: GetImagesCommandInput, options?: __HttpHandlerOptions): Promise; - public getImages(args: GetImagesCommandInput, cb: (err: any, data?: GetImagesCommandOutput) => void): void; - public getImages( + getImages(args: GetImagesCommandInput, options?: __HttpHandlerOptions): Promise; + getImages(args: GetImagesCommandInput, cb: (err: any, data?: GetImagesCommandOutput) => void): void; + getImages( args: GetImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetImagesCommandOutput) => void ): void; - public getImages( - args: GetImagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetImagesCommandOutput) => void), - cb?: (err: any, data?: GetImagesCommandOutput) => void - ): Promise | void { - const command = new GetImagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets media for a list of fragments (specified by fragment number) from the archived - * data in an Amazon Kinesis video stream.

- * - * - *

You must first call the GetDataEndpoint API to get an endpoint. - * Then send the GetMediaForFragmentList requests to this endpoint using - * the --endpoint-url - * parameter.

- *
- * - *

For limits, see Kinesis Video Streams Limits.

- * - * - *

If an error is thrown after invoking a Kinesis Video Streams archived media API, - * in addition to the HTTP status code and the response body, it includes the following - * pieces of information:

- *
    - *
  • - *

    - * x-amz-ErrorType HTTP header – contains a more specific error - * type in addition to what the HTTP status code provides.

    - *
  • - *
  • - *

    - * x-amz-RequestId HTTP header – if you want to report an issue to - * AWS, the support team can better diagnose the problem if given the Request - * Id.

    - *
  • - *
- *

Both the HTTP status code and the ErrorType header can be utilized to make - * programmatic decisions about whether errors are retry-able and under what - * conditions, as well as provide information on what actions the client programmer - * might need to take in order to successfully try again.

- *

For more information, see the Errors section at - * the bottom of this topic, as well as Common Errors. - *

- *
+ * @see {@link GetMediaForFragmentListCommand} */ - public getMediaForFragmentList( + getMediaForFragmentList( args: GetMediaForFragmentListCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMediaForFragmentList( + getMediaForFragmentList( args: GetMediaForFragmentListCommandInput, cb: (err: any, data?: GetMediaForFragmentListCommandOutput) => void ): void; - public getMediaForFragmentList( + getMediaForFragmentList( args: GetMediaForFragmentListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMediaForFragmentListCommandOutput) => void ): void; - public getMediaForFragmentList( - args: GetMediaForFragmentListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMediaForFragmentListCommandOutput) => void), - cb?: (err: any, data?: GetMediaForFragmentListCommandOutput) => void - ): Promise | void { - const command = new GetMediaForFragmentListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of Fragment objects from the specified stream and - * timestamp range within the archived data.

- *

Listing fragments is eventually consistent. This means that even if the producer - * receives an acknowledgment that a fragment is persisted, the result might not be - * returned immediately from a request to ListFragments. However, results are - * typically available in less than one second.

- * - *

You must first call the GetDataEndpoint API to get an endpoint. - * Then send the ListFragments requests to this endpoint using the --endpoint-url - * parameter.

- *
- * - * - *

If an error is thrown after invoking a Kinesis Video Streams archived media API, - * in addition to the HTTP status code and the response body, it includes the following - * pieces of information:

- *
    - *
  • - *

    - * x-amz-ErrorType HTTP header – contains a more specific error - * type in addition to what the HTTP status code provides.

    - *
  • - *
  • - *

    - * x-amz-RequestId HTTP header – if you want to report an issue to - * AWS, the support team can better diagnose the problem if given the Request - * Id.

    - *
  • - *
- *

Both the HTTP status code and the ErrorType header can be utilized to make - * programmatic decisions about whether errors are retry-able and under what - * conditions, as well as provide information on what actions the client programmer - * might need to take in order to successfully try again.

- *

For more information, see the Errors section at - * the bottom of this topic, as well as Common Errors. - *

- *
+ * @see {@link ListFragmentsCommand} */ - public listFragments( - args: ListFragmentsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listFragments( - args: ListFragmentsCommandInput, - cb: (err: any, data?: ListFragmentsCommandOutput) => void - ): void; - public listFragments( + listFragments(args: ListFragmentsCommandInput, options?: __HttpHandlerOptions): Promise; + listFragments(args: ListFragmentsCommandInput, cb: (err: any, data?: ListFragmentsCommandOutput) => void): void; + listFragments( args: ListFragmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFragmentsCommandOutput) => void ): void; - public listFragments( - args: ListFragmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFragmentsCommandOutput) => void), - cb?: (err: any, data?: ListFragmentsCommandOutput) => void - ): Promise | void { - const command = new ListFragmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

+ */ +export class KinesisVideoArchivedMedia extends KinesisVideoArchivedMediaClient implements KinesisVideoArchivedMedia {} +createAggregatedClient(commands, KinesisVideoArchivedMedia); diff --git a/clients/client-kinesis-video-media/src/KinesisVideoMedia.ts b/clients/client-kinesis-video-media/src/KinesisVideoMedia.ts index 3c72144b82bc..1f11da3a0309 100644 --- a/clients/client-kinesis-video-media/src/KinesisVideoMedia.ts +++ b/clients/client-kinesis-video-media/src/KinesisVideoMedia.ts @@ -1,83 +1,30 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { GetMediaCommand, GetMediaCommandInput, GetMediaCommandOutput } from "./commands/GetMediaCommand"; -import { KinesisVideoMediaClient } from "./KinesisVideoMediaClient"; +import { KinesisVideoMediaClient, KinesisVideoMediaClientConfig } from "./KinesisVideoMediaClient"; -/** - * @public - *

- */ -export class KinesisVideoMedia extends KinesisVideoMediaClient { +const commands = { + GetMediaCommand, +}; + +export interface KinesisVideoMedia { /** - * @public - *

Use this API to retrieve media content from a Kinesis video stream. In the request, - * you identify the stream name or stream Amazon Resource Name (ARN), and the starting chunk. - * Kinesis Video Streams then returns a stream of chunks in order by fragment number.

- * - *

You must first call the GetDataEndpoint API to get an endpoint. Then - * send the GetMedia requests to this endpoint using the --endpoint-url parameter. - *

- *
- *

When you put media data (fragments) on a stream, Kinesis Video Streams stores each - * incoming fragment and related metadata in what is called a "chunk." For more information, see - * PutMedia. The GetMedia API returns a stream of these chunks starting - * from the chunk that you specify in the request.

- *

The following limits apply when using the GetMedia API:

- *
    - *
  • - *

    A client can call GetMedia up to five times per second per stream. - *

    - *
  • - *
  • - *

    Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second - * (or 200 megabits per second) during a GetMedia session.

    - *
  • - *
- * - * - *

If an error is thrown after invoking a Kinesis Video Streams media API, in addition to - * the HTTP status code and the response body, it includes the following pieces of information:

- *
    - *
  • - *

    - * x-amz-ErrorType HTTP header – contains a more specific error type in - * addition to what the HTTP status code provides.

    - *
  • - *
  • - *

    - * x-amz-RequestId HTTP header – if you want to report an issue to AWS, - * the support team can better diagnose the problem if given the Request Id.

    - *
  • - *
- *

Both the HTTP status code and the ErrorType header can be utilized to make programmatic - * decisions about whether errors are retry-able and under what conditions, as well as provide - * information on what actions the client programmer might need to take in order to - * successfully try again.

- *

For more information, see the Errors section at the - * bottom of this topic, as well as Common Errors.

- *
+ * @see {@link GetMediaCommand} */ - public getMedia(args: GetMediaCommandInput, options?: __HttpHandlerOptions): Promise; - public getMedia(args: GetMediaCommandInput, cb: (err: any, data?: GetMediaCommandOutput) => void): void; - public getMedia( + getMedia(args: GetMediaCommandInput, options?: __HttpHandlerOptions): Promise; + getMedia(args: GetMediaCommandInput, cb: (err: any, data?: GetMediaCommandOutput) => void): void; + getMedia( args: GetMediaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMediaCommandOutput) => void ): void; - public getMedia( - args: GetMediaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMediaCommandOutput) => void), - cb?: (err: any, data?: GetMediaCommandOutput) => void - ): Promise | void { - const command = new GetMediaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

+ */ +export class KinesisVideoMedia extends KinesisVideoMediaClient implements KinesisVideoMedia {} +createAggregatedClient(commands, KinesisVideoMedia); diff --git a/clients/client-kinesis-video-signaling/src/KinesisVideoSignaling.ts b/clients/client-kinesis-video-signaling/src/KinesisVideoSignaling.ts index 32efd1280137..8a701f94d740 100644 --- a/clients/client-kinesis-video-signaling/src/KinesisVideoSignaling.ts +++ b/clients/client-kinesis-video-signaling/src/KinesisVideoSignaling.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -11,96 +12,54 @@ import { SendAlexaOfferToMasterCommandInput, SendAlexaOfferToMasterCommandOutput, } from "./commands/SendAlexaOfferToMasterCommand"; -import { KinesisVideoSignalingClient } from "./KinesisVideoSignalingClient"; +import { KinesisVideoSignalingClient, KinesisVideoSignalingClientConfig } from "./KinesisVideoSignalingClient"; -/** - * @public - *

Kinesis Video Streams Signaling Service is a intermediate service that establishes a - * communication channel for discovering peers, transmitting offers and answers in order to - * establish peer-to-peer connection in webRTC technology.

- */ -export class KinesisVideoSignaling extends KinesisVideoSignalingClient { +const commands = { + GetIceServerConfigCommand, + SendAlexaOfferToMasterCommand, +}; + +export interface KinesisVideoSignaling { /** - * @public - *

Gets the Interactive Connectivity Establishment (ICE) server configuration - * information, including URIs, username, and password which can be used to configure the - * WebRTC connection. The ICE component uses this configuration information to setup the - * WebRTC connection, including authenticating with the Traversal Using Relays around NAT - * (TURN) relay server.

- *

TURN is a protocol that is used to improve the connectivity of peer-to-peer - * applications. By providing a cloud-based relay service, TURN ensures that a connection - * can be established even when one or more peers are incapable of a direct peer-to-peer - * connection. For more information, see A REST API For - * Access To TURN Services.

- *

You can invoke this API to establish a fallback mechanism in case either of the peers - * is unable to establish a direct peer-to-peer connection over a signaling channel. You - * must specify either a signaling channel ARN or the client ID in order to invoke this - * API.

+ * @see {@link GetIceServerConfigCommand} */ - public getIceServerConfig( + getIceServerConfig( args: GetIceServerConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIceServerConfig( + getIceServerConfig( args: GetIceServerConfigCommandInput, cb: (err: any, data?: GetIceServerConfigCommandOutput) => void ): void; - public getIceServerConfig( + getIceServerConfig( args: GetIceServerConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIceServerConfigCommandOutput) => void ): void; - public getIceServerConfig( - args: GetIceServerConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIceServerConfigCommandOutput) => void), - cb?: (err: any, data?: GetIceServerConfigCommandOutput) => void - ): Promise | void { - const command = new GetIceServerConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This API allows you to connect WebRTC-enabled devices with Alexa display devices. When - * invoked, it sends the Alexa Session Description Protocol (SDP) offer to the master peer. - * The offer is delivered as soon as the master is connected to the specified signaling - * channel. This API returns the SDP answer from the connected master. If the master is not - * connected to the signaling channel, redelivery requests are made until the message - * expires.

+ * @see {@link SendAlexaOfferToMasterCommand} */ - public sendAlexaOfferToMaster( + sendAlexaOfferToMaster( args: SendAlexaOfferToMasterCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendAlexaOfferToMaster( + sendAlexaOfferToMaster( args: SendAlexaOfferToMasterCommandInput, cb: (err: any, data?: SendAlexaOfferToMasterCommandOutput) => void ): void; - public sendAlexaOfferToMaster( + sendAlexaOfferToMaster( args: SendAlexaOfferToMasterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendAlexaOfferToMasterCommandOutput) => void ): void; - public sendAlexaOfferToMaster( - args: SendAlexaOfferToMasterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendAlexaOfferToMasterCommandOutput) => void), - cb?: (err: any, data?: SendAlexaOfferToMasterCommandOutput) => void - ): Promise | void { - const command = new SendAlexaOfferToMasterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Kinesis Video Streams Signaling Service is a intermediate service that establishes a + * communication channel for discovering peers, transmitting offers and answers in order to + * establish peer-to-peer connection in webRTC technology.

+ */ +export class KinesisVideoSignaling extends KinesisVideoSignalingClient implements KinesisVideoSignaling {} +createAggregatedClient(commands, KinesisVideoSignaling); diff --git a/clients/client-kinesis-video-webrtc-storage/src/KinesisVideoWebRTCStorage.ts b/clients/client-kinesis-video-webrtc-storage/src/KinesisVideoWebRTCStorage.ts index 69f246ac82c8..c6fd099ffc67 100644 --- a/clients/client-kinesis-video-webrtc-storage/src/KinesisVideoWebRTCStorage.ts +++ b/clients/client-kinesis-video-webrtc-storage/src/KinesisVideoWebRTCStorage.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -6,65 +7,38 @@ import { JoinStorageSessionCommandInput, JoinStorageSessionCommandOutput, } from "./commands/JoinStorageSessionCommand"; -import { KinesisVideoWebRTCStorageClient } from "./KinesisVideoWebRTCStorageClient"; +import { + KinesisVideoWebRTCStorageClient, + KinesisVideoWebRTCStorageClientConfig, +} from "./KinesisVideoWebRTCStorageClient"; -/** - * @public - *

- *

- */ -export class KinesisVideoWebRTCStorage extends KinesisVideoWebRTCStorageClient { +const commands = { + JoinStorageSessionCommand, +}; + +export interface KinesisVideoWebRTCStorage { /** - * @public - *

- * Join the ongoing one way-video and/or multi-way audio WebRTC session as - * a video producing device for an input channel. If there’s no existing - * session for the channel, a new streaming session needs to be created, and the - * Amazon Resource Name (ARN) of the signaling channel must be provided. - *

- *

Currently for the SINGLE_MASTER type, a video producing - * device is able to ingest both audio and video media into a stream, - * while viewers can only ingest audio. Both a video producing device - * and viewers can join the session first, and wait for other participants.

- *

While participants are having peer to peer conversations through webRTC, - * the ingested media session will be stored into the Kinesis Video Stream. - * Multiple viewers are able to playback real-time media.

- *

Customers can also use existing Kinesis Video Streams features like - * HLS or DASH playback, Image generation, and more - * with ingested WebRTC media.

- * - *

Assume that only one video producing device client - * can be associated with a session for the channel. If more than one - * client joins the session of a specific channel as a video producing device, - * the most recent client request takes precedence.

- *
+ * @see {@link JoinStorageSessionCommand} */ - public joinStorageSession( + joinStorageSession( args: JoinStorageSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public joinStorageSession( + joinStorageSession( args: JoinStorageSessionCommandInput, cb: (err: any, data?: JoinStorageSessionCommandOutput) => void ): void; - public joinStorageSession( + joinStorageSession( args: JoinStorageSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JoinStorageSessionCommandOutput) => void ): void; - public joinStorageSession( - args: JoinStorageSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: JoinStorageSessionCommandOutput) => void), - cb?: (err: any, data?: JoinStorageSessionCommandOutput) => void - ): Promise | void { - const command = new JoinStorageSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

+ *

+ */ +export class KinesisVideoWebRTCStorage extends KinesisVideoWebRTCStorageClient implements KinesisVideoWebRTCStorage {} +createAggregatedClient(commands, KinesisVideoWebRTCStorage); diff --git a/clients/client-kinesis-video/src/KinesisVideo.ts b/clients/client-kinesis-video/src/KinesisVideo.ts index b66b17102388..d8c28e811282 100644 --- a/clients/client-kinesis-video/src/KinesisVideo.ts +++ b/clients/client-kinesis-video/src/KinesisVideo.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -125,1038 +126,466 @@ import { UpdateStreamCommandInput, UpdateStreamCommandOutput, } from "./commands/UpdateStreamCommand"; -import { KinesisVideoClient } from "./KinesisVideoClient"; +import { KinesisVideoClient, KinesisVideoClientConfig } from "./KinesisVideoClient"; -/** - * @public - *

- */ -export class KinesisVideo extends KinesisVideoClient { +const commands = { + CreateSignalingChannelCommand, + CreateStreamCommand, + DeleteSignalingChannelCommand, + DeleteStreamCommand, + DescribeEdgeConfigurationCommand, + DescribeImageGenerationConfigurationCommand, + DescribeMappedResourceConfigurationCommand, + DescribeMediaStorageConfigurationCommand, + DescribeNotificationConfigurationCommand, + DescribeSignalingChannelCommand, + DescribeStreamCommand, + GetDataEndpointCommand, + GetSignalingChannelEndpointCommand, + ListSignalingChannelsCommand, + ListStreamsCommand, + ListTagsForResourceCommand, + ListTagsForStreamCommand, + StartEdgeConfigurationUpdateCommand, + TagResourceCommand, + TagStreamCommand, + UntagResourceCommand, + UntagStreamCommand, + UpdateDataRetentionCommand, + UpdateImageGenerationConfigurationCommand, + UpdateMediaStorageConfigurationCommand, + UpdateNotificationConfigurationCommand, + UpdateSignalingChannelCommand, + UpdateStreamCommand, +}; + +export interface KinesisVideo { /** - * @public - *

Creates a signaling channel.

- *

- * CreateSignalingChannel is an asynchronous operation.

+ * @see {@link CreateSignalingChannelCommand} */ - public createSignalingChannel( + createSignalingChannel( args: CreateSignalingChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSignalingChannel( + createSignalingChannel( args: CreateSignalingChannelCommandInput, cb: (err: any, data?: CreateSignalingChannelCommandOutput) => void ): void; - public createSignalingChannel( + createSignalingChannel( args: CreateSignalingChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSignalingChannelCommandOutput) => void ): void; - public createSignalingChannel( - args: CreateSignalingChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSignalingChannelCommandOutput) => void), - cb?: (err: any, data?: CreateSignalingChannelCommandOutput) => void - ): Promise | void { - const command = new CreateSignalingChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new Kinesis video stream.

- *

When you create a new stream, Kinesis Video Streams assigns it a version number. - * When you change the stream's metadata, Kinesis Video Streams updates the version.

- *

- * CreateStream is an asynchronous operation.

- *

For information about how the service works, see How it Works.

- *

You must have permissions for the KinesisVideo:CreateStream - * action.

+ * @see {@link CreateStreamCommand} */ - public createStream( - args: CreateStreamCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createStream(args: CreateStreamCommandInput, cb: (err: any, data?: CreateStreamCommandOutput) => void): void; - public createStream( + createStream(args: CreateStreamCommandInput, options?: __HttpHandlerOptions): Promise; + createStream(args: CreateStreamCommandInput, cb: (err: any, data?: CreateStreamCommandOutput) => void): void; + createStream( args: CreateStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStreamCommandOutput) => void ): void; - public createStream( - args: CreateStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStreamCommandOutput) => void), - cb?: (err: any, data?: CreateStreamCommandOutput) => void - ): Promise | void { - const command = new CreateStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a specified signaling channel. DeleteSignalingChannel is an - * asynchronous operation. If you don't specify the channel's current version, the most - * recent version is deleted.

+ * @see {@link DeleteSignalingChannelCommand} */ - public deleteSignalingChannel( + deleteSignalingChannel( args: DeleteSignalingChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSignalingChannel( + deleteSignalingChannel( args: DeleteSignalingChannelCommandInput, cb: (err: any, data?: DeleteSignalingChannelCommandOutput) => void ): void; - public deleteSignalingChannel( + deleteSignalingChannel( args: DeleteSignalingChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSignalingChannelCommandOutput) => void ): void; - public deleteSignalingChannel( - args: DeleteSignalingChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSignalingChannelCommandOutput) => void), - cb?: (err: any, data?: DeleteSignalingChannelCommandOutput) => void - ): Promise | void { - const command = new DeleteSignalingChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Kinesis video stream and the data contained in the stream.

- *

This method marks the stream for deletion, and makes the data in the stream - * inaccessible immediately.

- *

- *

To ensure that you have the latest version of the stream before deleting it, you - * can specify the stream version. Kinesis Video Streams assigns a version to each stream. - * When you update a stream, Kinesis Video Streams assigns a new version number. To get the - * latest stream version, use the DescribeStream API.

- *

This operation requires permission for the KinesisVideo:DeleteStream - * action.

+ * @see {@link DeleteStreamCommand} */ - public deleteStream( - args: DeleteStreamCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteStream(args: DeleteStreamCommandInput, cb: (err: any, data?: DeleteStreamCommandOutput) => void): void; - public deleteStream( + deleteStream(args: DeleteStreamCommandInput, options?: __HttpHandlerOptions): Promise; + deleteStream(args: DeleteStreamCommandInput, cb: (err: any, data?: DeleteStreamCommandOutput) => void): void; + deleteStream( args: DeleteStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStreamCommandOutput) => void ): void; - public deleteStream( - args: DeleteStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStreamCommandOutput) => void), - cb?: (err: any, data?: DeleteStreamCommandOutput) => void - ): Promise | void { - const command = new DeleteStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API. - * Use this API to get the status of the configuration if the configuration is in sync with the - * Edge Agent.

+ * @see {@link DescribeEdgeConfigurationCommand} */ - public describeEdgeConfiguration( + describeEdgeConfiguration( args: DescribeEdgeConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEdgeConfiguration( + describeEdgeConfiguration( args: DescribeEdgeConfigurationCommandInput, cb: (err: any, data?: DescribeEdgeConfigurationCommandOutput) => void ): void; - public describeEdgeConfiguration( + describeEdgeConfiguration( args: DescribeEdgeConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEdgeConfigurationCommandOutput) => void ): void; - public describeEdgeConfiguration( - args: DescribeEdgeConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEdgeConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeEdgeConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeEdgeConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the ImageGenerationConfiguration for a given Kinesis video stream.

+ * @see {@link DescribeImageGenerationConfigurationCommand} */ - public describeImageGenerationConfiguration( + describeImageGenerationConfiguration( args: DescribeImageGenerationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeImageGenerationConfiguration( + describeImageGenerationConfiguration( args: DescribeImageGenerationConfigurationCommandInput, cb: (err: any, data?: DescribeImageGenerationConfigurationCommandOutput) => void ): void; - public describeImageGenerationConfiguration( + describeImageGenerationConfiguration( args: DescribeImageGenerationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImageGenerationConfigurationCommandOutput) => void ): void; - public describeImageGenerationConfiguration( - args: DescribeImageGenerationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeImageGenerationConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeImageGenerationConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeImageGenerationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the most current information about the stream. Either streamName or streamARN should be provided in the input.

- *

Returns the most current information about the stream. The streamName - * or streamARN should be provided in the input.

+ * @see {@link DescribeMappedResourceConfigurationCommand} */ - public describeMappedResourceConfiguration( + describeMappedResourceConfiguration( args: DescribeMappedResourceConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMappedResourceConfiguration( + describeMappedResourceConfiguration( args: DescribeMappedResourceConfigurationCommandInput, cb: (err: any, data?: DescribeMappedResourceConfigurationCommandOutput) => void ): void; - public describeMappedResourceConfiguration( + describeMappedResourceConfiguration( args: DescribeMappedResourceConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMappedResourceConfigurationCommandOutput) => void ): void; - public describeMappedResourceConfiguration( - args: DescribeMappedResourceConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMappedResourceConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeMappedResourceConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeMappedResourceConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the most current information about the channel. Specify the ChannelName - * or ChannelARN in the input.

+ * @see {@link DescribeMediaStorageConfigurationCommand} */ - public describeMediaStorageConfiguration( + describeMediaStorageConfiguration( args: DescribeMediaStorageConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMediaStorageConfiguration( + describeMediaStorageConfiguration( args: DescribeMediaStorageConfigurationCommandInput, cb: (err: any, data?: DescribeMediaStorageConfigurationCommandOutput) => void ): void; - public describeMediaStorageConfiguration( + describeMediaStorageConfiguration( args: DescribeMediaStorageConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMediaStorageConfigurationCommandOutput) => void ): void; - public describeMediaStorageConfiguration( - args: DescribeMediaStorageConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMediaStorageConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeMediaStorageConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeMediaStorageConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the NotificationConfiguration for a given Kinesis video stream.

+ * @see {@link DescribeNotificationConfigurationCommand} */ - public describeNotificationConfiguration( + describeNotificationConfiguration( args: DescribeNotificationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNotificationConfiguration( + describeNotificationConfiguration( args: DescribeNotificationConfigurationCommandInput, cb: (err: any, data?: DescribeNotificationConfigurationCommandOutput) => void ): void; - public describeNotificationConfiguration( + describeNotificationConfiguration( args: DescribeNotificationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNotificationConfigurationCommandOutput) => void ): void; - public describeNotificationConfiguration( - args: DescribeNotificationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeNotificationConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeNotificationConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeNotificationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the most current information about the signaling channel. You must specify - * either the name or the Amazon Resource Name (ARN) of the channel that you want to - * describe.

+ * @see {@link DescribeSignalingChannelCommand} */ - public describeSignalingChannel( + describeSignalingChannel( args: DescribeSignalingChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSignalingChannel( + describeSignalingChannel( args: DescribeSignalingChannelCommandInput, cb: (err: any, data?: DescribeSignalingChannelCommandOutput) => void ): void; - public describeSignalingChannel( + describeSignalingChannel( args: DescribeSignalingChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSignalingChannelCommandOutput) => void ): void; - public describeSignalingChannel( - args: DescribeSignalingChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSignalingChannelCommandOutput) => void), - cb?: (err: any, data?: DescribeSignalingChannelCommandOutput) => void - ): Promise | void { - const command = new DescribeSignalingChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the most current information about the specified stream. You must specify - * either the StreamName or the StreamARN.

+ * @see {@link DescribeStreamCommand} */ - public describeStream( + describeStream( args: DescribeStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStream( - args: DescribeStreamCommandInput, - cb: (err: any, data?: DescribeStreamCommandOutput) => void - ): void; - public describeStream( + describeStream(args: DescribeStreamCommandInput, cb: (err: any, data?: DescribeStreamCommandOutput) => void): void; + describeStream( args: DescribeStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStreamCommandOutput) => void ): void; - public describeStream( - args: DescribeStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStreamCommandOutput) => void), - cb?: (err: any, data?: DescribeStreamCommandOutput) => void - ): Promise | void { - const command = new DescribeStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets an endpoint for a specified stream for either reading or writing. Use this - * endpoint in your application to read from the specified stream (using the - * GetMedia or GetMediaForFragmentList operations) or write - * to it (using the PutMedia operation). - *

- * - *

The returned endpoint does not have the API name appended. The client needs to - * add the API name to the returned endpoint.

- *
- *

In the request, specify the stream either by StreamName or - * StreamARN.

+ * @see {@link GetDataEndpointCommand} */ - public getDataEndpoint( + getDataEndpoint( args: GetDataEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDataEndpoint( - args: GetDataEndpointCommandInput, - cb: (err: any, data?: GetDataEndpointCommandOutput) => void - ): void; - public getDataEndpoint( + getDataEndpoint(args: GetDataEndpointCommandInput, cb: (err: any, data?: GetDataEndpointCommandOutput) => void): void; + getDataEndpoint( args: GetDataEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataEndpointCommandOutput) => void ): void; - public getDataEndpoint( - args: GetDataEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDataEndpointCommandOutput) => void), - cb?: (err: any, data?: GetDataEndpointCommandOutput) => void - ): Promise | void { - const command = new GetDataEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides an endpoint for the specified signaling channel to send and receive messages. - * This API uses the SingleMasterChannelEndpointConfiguration input parameter, - * which consists of the Protocols and Role properties.

- *

- * Protocols is used to determine the communication mechanism. For example, - * if you specify WSS as the protocol, this API produces a secure websocket - * endpoint. If you specify HTTPS as the protocol, this API generates an HTTPS - * endpoint.

- *

- * Role determines the messaging permissions. A MASTER role - * results in this API generating an endpoint that a client can use to communicate with any - * of the viewers on the channel. A VIEWER role results in this API generating - * an endpoint that a client can use to communicate only with a MASTER. - *

+ * @see {@link GetSignalingChannelEndpointCommand} */ - public getSignalingChannelEndpoint( + getSignalingChannelEndpoint( args: GetSignalingChannelEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSignalingChannelEndpoint( + getSignalingChannelEndpoint( args: GetSignalingChannelEndpointCommandInput, cb: (err: any, data?: GetSignalingChannelEndpointCommandOutput) => void ): void; - public getSignalingChannelEndpoint( + getSignalingChannelEndpoint( args: GetSignalingChannelEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSignalingChannelEndpointCommandOutput) => void ): void; - public getSignalingChannelEndpoint( - args: GetSignalingChannelEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSignalingChannelEndpointCommandOutput) => void), - cb?: (err: any, data?: GetSignalingChannelEndpointCommandOutput) => void - ): Promise | void { - const command = new GetSignalingChannelEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of ChannelInfo objects. Each object describes a - * signaling channel. To retrieve only those channels that satisfy a specific condition, - * you can specify a ChannelNameCondition.

+ * @see {@link ListSignalingChannelsCommand} */ - public listSignalingChannels( + listSignalingChannels( args: ListSignalingChannelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSignalingChannels( + listSignalingChannels( args: ListSignalingChannelsCommandInput, cb: (err: any, data?: ListSignalingChannelsCommandOutput) => void ): void; - public listSignalingChannels( + listSignalingChannels( args: ListSignalingChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSignalingChannelsCommandOutput) => void ): void; - public listSignalingChannels( - args: ListSignalingChannelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSignalingChannelsCommandOutput) => void), - cb?: (err: any, data?: ListSignalingChannelsCommandOutput) => void - ): Promise | void { - const command = new ListSignalingChannelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of StreamInfo objects. Each object describes a - * stream. To retrieve only streams that satisfy a specific condition, you can specify a - * StreamNameCondition.

+ * @see {@link ListStreamsCommand} */ - public listStreams(args: ListStreamsCommandInput, options?: __HttpHandlerOptions): Promise; - public listStreams(args: ListStreamsCommandInput, cb: (err: any, data?: ListStreamsCommandOutput) => void): void; - public listStreams( + listStreams(args: ListStreamsCommandInput, options?: __HttpHandlerOptions): Promise; + listStreams(args: ListStreamsCommandInput, cb: (err: any, data?: ListStreamsCommandOutput) => void): void; + listStreams( args: ListStreamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamsCommandOutput) => void ): void; - public listStreams( - args: ListStreamsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStreamsCommandOutput) => void), - cb?: (err: any, data?: ListStreamsCommandOutput) => void - ): Promise | void { - const command = new ListStreamsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of tags associated with the specified signaling channel.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of tags associated with the specified stream.

- *

In the request, you must specify either the StreamName or the - * StreamARN.

+ * @see {@link ListTagsForStreamCommand} */ - public listTagsForStream( + listTagsForStream( args: ListTagsForStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForStream( + listTagsForStream( args: ListTagsForStreamCommandInput, cb: (err: any, data?: ListTagsForStreamCommandOutput) => void ): void; - public listTagsForStream( + listTagsForStream( args: ListTagsForStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForStreamCommandOutput) => void ): void; - public listTagsForStream( - args: ListTagsForStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForStreamCommandOutput) => void), - cb?: (err: any, data?: ListTagsForStreamCommandOutput) => void - ): Promise | void { - const command = new ListTagsForStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

An asynchronous API that updates a stream’s existing edge configuration. - * The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass - * component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary - * and depends on the connectivity of the Hub Device. - * The SyncStatus will be updated as the edge configuration is acknowledged, - * and synced with the Edge Agent.

- *

If this API is invoked for the first time, a new edge configuration will be created for the stream, - * and the sync status will be set to SYNCING. You will have to wait for the sync status - * to reach a terminal state such as: IN_SYNC, or SYNC_FAILED, before using this API again. - * If you invoke this API during the syncing process, a ResourceInUseException will be thrown. - * The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes, - * the status will transition into the SYNC_FAILED state.

+ * @see {@link StartEdgeConfigurationUpdateCommand} */ - public startEdgeConfigurationUpdate( + startEdgeConfigurationUpdate( args: StartEdgeConfigurationUpdateCommandInput, options?: __HttpHandlerOptions ): Promise; - public startEdgeConfigurationUpdate( + startEdgeConfigurationUpdate( args: StartEdgeConfigurationUpdateCommandInput, cb: (err: any, data?: StartEdgeConfigurationUpdateCommandOutput) => void ): void; - public startEdgeConfigurationUpdate( + startEdgeConfigurationUpdate( args: StartEdgeConfigurationUpdateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartEdgeConfigurationUpdateCommandOutput) => void ): void; - public startEdgeConfigurationUpdate( - args: StartEdgeConfigurationUpdateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartEdgeConfigurationUpdateCommandOutput) => void), - cb?: (err: any, data?: StartEdgeConfigurationUpdateCommandOutput) => void - ): Promise | void { - const command = new StartEdgeConfigurationUpdateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more tags to a signaling channel. A tag is a - * key-value pair (the value is optional) that you can define and assign to Amazon Web Services resources. - * If you specify a tag that already exists, the tag value is replaced with the value that - * you specify in the request. For more information, see Using Cost Allocation - * Tags in the Billing and Cost Management and Cost Management User - * Guide.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more tags to a stream. A tag is a key-value pair - * (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify - * a tag that already exists, the tag value is replaced with the value that you specify in - * the request. For more information, see Using Cost Allocation - * Tags in the Billing and Cost Management and Cost Management User Guide.

- *

You must provide either the StreamName or the - * StreamARN.

- *

This operation requires permission for the KinesisVideo:TagStream - * action.

- *

A Kinesis video stream can support up to 50 tags.

+ * @see {@link TagStreamCommand} */ - public tagStream(args: TagStreamCommandInput, options?: __HttpHandlerOptions): Promise; - public tagStream(args: TagStreamCommandInput, cb: (err: any, data?: TagStreamCommandOutput) => void): void; - public tagStream( + tagStream(args: TagStreamCommandInput, options?: __HttpHandlerOptions): Promise; + tagStream(args: TagStreamCommandInput, cb: (err: any, data?: TagStreamCommandOutput) => void): void; + tagStream( args: TagStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagStreamCommandOutput) => void ): void; - public tagStream( - args: TagStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagStreamCommandOutput) => void), - cb?: (err: any, data?: TagStreamCommandOutput) => void - ): Promise | void { - const command = new TagStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from a signaling channel. In the request, specify only a tag - * key or keys; don't specify the value. If you specify a tag key that does not exist, it's - * ignored.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from a stream. In the request, specify only a tag key or - * keys; don't specify the value. If you specify a tag key that does not exist, it's - * ignored.

- *

In the request, you must provide the StreamName or - * StreamARN.

+ * @see {@link UntagStreamCommand} */ - public untagStream(args: UntagStreamCommandInput, options?: __HttpHandlerOptions): Promise; - public untagStream(args: UntagStreamCommandInput, cb: (err: any, data?: UntagStreamCommandOutput) => void): void; - public untagStream( + untagStream(args: UntagStreamCommandInput, options?: __HttpHandlerOptions): Promise; + untagStream(args: UntagStreamCommandInput, cb: (err: any, data?: UntagStreamCommandOutput) => void): void; + untagStream( args: UntagStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagStreamCommandOutput) => void ): void; - public untagStream( - args: UntagStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagStreamCommandOutput) => void), - cb?: (err: any, data?: UntagStreamCommandOutput) => void - ): Promise | void { - const command = new UntagStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Increases or decreases the stream's data retention period by the value that you - * specify. To indicate whether you want to increase or decrease the data retention period, - * specify the Operation parameter in the request body. In the request, you - * must specify either the StreamName or the StreamARN.

- * - *

The retention period that you specify replaces the current value.

- *
- *

This operation requires permission for the - * KinesisVideo:UpdateDataRetention action.

- *

Changing the data retention period affects the data in the stream as - * follows:

- *
    - *
  • - *

    If the data retention period is increased, existing data is retained for - * the new retention period. For example, if the data retention period is increased - * from one hour to seven hours, all existing data is retained for seven - * hours.

    - *
  • - *
  • - *

    If the data retention period is decreased, existing data is retained for - * the new retention period. For example, if the data retention period is decreased - * from seven hours to one hour, all existing data is retained for one hour, and - * any data older than one hour is deleted immediately.

    - *
  • - *
+ * @see {@link UpdateDataRetentionCommand} */ - public updateDataRetention( + updateDataRetention( args: UpdateDataRetentionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDataRetention( + updateDataRetention( args: UpdateDataRetentionCommandInput, cb: (err: any, data?: UpdateDataRetentionCommandOutput) => void ): void; - public updateDataRetention( + updateDataRetention( args: UpdateDataRetentionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDataRetentionCommandOutput) => void ): void; - public updateDataRetention( - args: UpdateDataRetentionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDataRetentionCommandOutput) => void), - cb?: (err: any, data?: UpdateDataRetentionCommandOutput) => void - ): Promise | void { - const command = new UpdateDataRetentionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the StreamInfo and ImageProcessingConfiguration fields.

+ * @see {@link UpdateImageGenerationConfigurationCommand} */ - public updateImageGenerationConfiguration( + updateImageGenerationConfiguration( args: UpdateImageGenerationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateImageGenerationConfiguration( + updateImageGenerationConfiguration( args: UpdateImageGenerationConfigurationCommandInput, cb: (err: any, data?: UpdateImageGenerationConfigurationCommandOutput) => void ): void; - public updateImageGenerationConfiguration( + updateImageGenerationConfiguration( args: UpdateImageGenerationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateImageGenerationConfigurationCommandOutput) => void ): void; - public updateImageGenerationConfiguration( - args: UpdateImageGenerationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateImageGenerationConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateImageGenerationConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateImageGenerationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a SignalingChannel to a stream to store the media. There are two signaling modes that - * can specified :

- *
    - *
  • - *

    If the StorageStatus is disabled, no data will be stored, - * and the StreamARN parameter will not be needed.

    - *
  • - *
  • - *

    If the StorageStatus is enabled, the data will be stored in the - * StreamARN provided.

    - *
  • - *
+ * @see {@link UpdateMediaStorageConfigurationCommand} */ - public updateMediaStorageConfiguration( + updateMediaStorageConfiguration( args: UpdateMediaStorageConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMediaStorageConfiguration( + updateMediaStorageConfiguration( args: UpdateMediaStorageConfigurationCommandInput, cb: (err: any, data?: UpdateMediaStorageConfigurationCommandOutput) => void ): void; - public updateMediaStorageConfiguration( + updateMediaStorageConfiguration( args: UpdateMediaStorageConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMediaStorageConfigurationCommandOutput) => void ): void; - public updateMediaStorageConfiguration( - args: UpdateMediaStorageConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMediaStorageConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateMediaStorageConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateMediaStorageConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the notification information for a stream.

+ * @see {@link UpdateNotificationConfigurationCommand} */ - public updateNotificationConfiguration( + updateNotificationConfiguration( args: UpdateNotificationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateNotificationConfiguration( + updateNotificationConfiguration( args: UpdateNotificationConfigurationCommandInput, cb: (err: any, data?: UpdateNotificationConfigurationCommandOutput) => void ): void; - public updateNotificationConfiguration( + updateNotificationConfiguration( args: UpdateNotificationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNotificationConfigurationCommandOutput) => void ): void; - public updateNotificationConfiguration( - args: UpdateNotificationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateNotificationConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateNotificationConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateNotificationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the existing signaling channel. This is an asynchronous operation and takes - * time to complete.

- *

If the MessageTtlSeconds value is updated (either increased or reduced), - * it only applies to new messages sent via this channel after it's been updated. Existing - * messages are still expired as per the previous MessageTtlSeconds - * value.

+ * @see {@link UpdateSignalingChannelCommand} */ - public updateSignalingChannel( + updateSignalingChannel( args: UpdateSignalingChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSignalingChannel( + updateSignalingChannel( args: UpdateSignalingChannelCommandInput, cb: (err: any, data?: UpdateSignalingChannelCommandOutput) => void ): void; - public updateSignalingChannel( + updateSignalingChannel( args: UpdateSignalingChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSignalingChannelCommandOutput) => void ): void; - public updateSignalingChannel( - args: UpdateSignalingChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSignalingChannelCommandOutput) => void), - cb?: (err: any, data?: UpdateSignalingChannelCommandOutput) => void - ): Promise | void { - const command = new UpdateSignalingChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates stream metadata, such as the device name and media type.

- *

You must provide the stream name or the Amazon Resource Name (ARN) of the - * stream.

- *

To make sure that you have the latest version of the stream before updating it, you - * can specify the stream version. Kinesis Video Streams assigns a version to each stream. - * When you update a stream, Kinesis Video Streams assigns a new version number. To get the - * latest stream version, use the DescribeStream API.

- *

- * UpdateStream is an asynchronous operation, and takes time to - * complete.

+ * @see {@link UpdateStreamCommand} */ - public updateStream( - args: UpdateStreamCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateStream(args: UpdateStreamCommandInput, cb: (err: any, data?: UpdateStreamCommandOutput) => void): void; - public updateStream( + updateStream(args: UpdateStreamCommandInput, options?: __HttpHandlerOptions): Promise; + updateStream(args: UpdateStreamCommandInput, cb: (err: any, data?: UpdateStreamCommandOutput) => void): void; + updateStream( args: UpdateStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStreamCommandOutput) => void ): void; - public updateStream( - args: UpdateStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStreamCommandOutput) => void), - cb?: (err: any, data?: UpdateStreamCommandOutput) => void - ): Promise | void { - const command = new UpdateStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

+ */ +export class KinesisVideo extends KinesisVideoClient implements KinesisVideo {} +createAggregatedClient(commands, KinesisVideo); diff --git a/clients/client-kinesis/src/Kinesis.ts b/clients/client-kinesis/src/Kinesis.ts index 45f5a23a8b26..2ccb4dc206f8 100644 --- a/clients/client-kinesis/src/Kinesis.ts +++ b/clients/client-kinesis/src/Kinesis.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -118,1513 +119,477 @@ import { UpdateStreamModeCommandInput, UpdateStreamModeCommandOutput, } from "./commands/UpdateStreamModeCommand"; -import { KinesisClient } from "./KinesisClient"; +import { KinesisClient, KinesisClientConfig } from "./KinesisClient"; -/** - * @public - * Amazon Kinesis Data Streams Service API Reference - *

Amazon Kinesis Data Streams is a managed service that scales elastically for real-time - * processing of streaming big data.

- */ -export class Kinesis extends KinesisClient { +const commands = { + AddTagsToStreamCommand, + CreateStreamCommand, + DecreaseStreamRetentionPeriodCommand, + DeleteStreamCommand, + DeregisterStreamConsumerCommand, + DescribeLimitsCommand, + DescribeStreamCommand, + DescribeStreamConsumerCommand, + DescribeStreamSummaryCommand, + DisableEnhancedMonitoringCommand, + EnableEnhancedMonitoringCommand, + GetRecordsCommand, + GetShardIteratorCommand, + IncreaseStreamRetentionPeriodCommand, + ListShardsCommand, + ListStreamConsumersCommand, + ListStreamsCommand, + ListTagsForStreamCommand, + MergeShardsCommand, + PutRecordCommand, + PutRecordsCommand, + RegisterStreamConsumerCommand, + RemoveTagsFromStreamCommand, + SplitShardCommand, + StartStreamEncryptionCommand, + StopStreamEncryptionCommand, + SubscribeToShardCommand, + UpdateShardCountCommand, + UpdateStreamModeCommand, +}; + +export interface Kinesis { /** - * @public - *

Adds or updates tags for the specified Kinesis data stream. You can assign up to 50 - * tags to a data stream.

- * - *

When invoking this API, it is recommended you use the StreamARN input - * parameter rather than the StreamName input parameter.

- *
- *

If tags have already been assigned to the stream, AddTagsToStream - * overwrites any existing tags that correspond to the specified tag keys.

- *

- * AddTagsToStream has a limit of five transactions per second per - * account.

+ * @see {@link AddTagsToStreamCommand} */ - public addTagsToStream( + addTagsToStream( args: AddTagsToStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public addTagsToStream( - args: AddTagsToStreamCommandInput, - cb: (err: any, data?: AddTagsToStreamCommandOutput) => void - ): void; - public addTagsToStream( + addTagsToStream(args: AddTagsToStreamCommandInput, cb: (err: any, data?: AddTagsToStreamCommandOutput) => void): void; + addTagsToStream( args: AddTagsToStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsToStreamCommandOutput) => void ): void; - public addTagsToStream( - args: AddTagsToStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddTagsToStreamCommandOutput) => void), - cb?: (err: any, data?: AddTagsToStreamCommandOutput) => void - ): Promise | void { - const command = new AddTagsToStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a Kinesis data stream. A stream captures and transports data records that are - * continuously emitted from different data sources or producers. - * Scale-out within a stream is explicitly supported by means of shards, which are uniquely - * identified groups of data records in a stream.

- *

You can create your data stream using either on-demand or provisioned capacity mode. - * Data streams with an on-demand mode require no capacity planning and automatically scale - * to handle gigabytes of write and read throughput per minute. With the on-demand mode, - * Kinesis Data Streams automatically manages the shards in order to provide the necessary - * throughput. For the data streams with a provisioned mode, you must specify the number of - * shards for the data stream. Each shard can support reads up to five transactions per - * second, up to a maximum data read total of 2 MiB per second. Each shard can support - * writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per - * second. If the amount of data input increases or decreases, you can add or remove - * shards.

- *

The stream name identifies the stream. The name is scoped to the Amazon Web Services - * account used by the application. It is also scoped by Amazon Web Services Region. That - * is, two streams in two different accounts can have the same name, and two streams in the - * same account, but in two different Regions, can have the same name.

- *

- * CreateStream is an asynchronous operation. Upon receiving a - * CreateStream request, Kinesis Data Streams immediately returns and sets - * the stream status to CREATING. After the stream is created, Kinesis Data - * Streams sets the stream status to ACTIVE. You should perform read and write - * operations only on an ACTIVE stream.

- *

You receive a LimitExceededException when making a - * CreateStream request when you try to do one of the following:

- *
    - *
  • - *

    Have more than five streams in the CREATING state at any point in - * time.

    - *
  • - *
  • - *

    Create more shards than are authorized for your account.

    - *
  • - *
- *

For the default shard limit for an Amazon Web Services account, see Amazon - * Kinesis Data Streams Limits in the Amazon Kinesis Data Streams - * Developer Guide. To increase this limit, contact Amazon Web Services - * Support.

- *

You can use DescribeStreamSummary to check the stream status, which - * is returned in StreamStatus.

- *

- * CreateStream has a limit of five transactions per second per - * account.

+ * @see {@link CreateStreamCommand} */ - public createStream( - args: CreateStreamCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createStream(args: CreateStreamCommandInput, cb: (err: any, data?: CreateStreamCommandOutput) => void): void; - public createStream( + createStream(args: CreateStreamCommandInput, options?: __HttpHandlerOptions): Promise; + createStream(args: CreateStreamCommandInput, cb: (err: any, data?: CreateStreamCommandOutput) => void): void; + createStream( args: CreateStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStreamCommandOutput) => void ): void; - public createStream( - args: CreateStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStreamCommandOutput) => void), - cb?: (err: any, data?: CreateStreamCommandOutput) => void - ): Promise | void { - const command = new CreateStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Decreases the Kinesis data stream's retention period, which is the length of time data - * records are accessible after they are added to the stream. The minimum value of a - * stream's retention period is 24 hours.

- * - *

When invoking this API, it is recommended you use the StreamARN input - * parameter rather than the StreamName input parameter.

- *
- *

This operation may result in lost data. For example, if the stream's retention period - * is 48 hours and is decreased to 24 hours, any data already in the stream that is older - * than 24 hours is inaccessible.

+ * @see {@link DecreaseStreamRetentionPeriodCommand} */ - public decreaseStreamRetentionPeriod( + decreaseStreamRetentionPeriod( args: DecreaseStreamRetentionPeriodCommandInput, options?: __HttpHandlerOptions ): Promise; - public decreaseStreamRetentionPeriod( + decreaseStreamRetentionPeriod( args: DecreaseStreamRetentionPeriodCommandInput, cb: (err: any, data?: DecreaseStreamRetentionPeriodCommandOutput) => void ): void; - public decreaseStreamRetentionPeriod( + decreaseStreamRetentionPeriod( args: DecreaseStreamRetentionPeriodCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DecreaseStreamRetentionPeriodCommandOutput) => void ): void; - public decreaseStreamRetentionPeriod( - args: DecreaseStreamRetentionPeriodCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DecreaseStreamRetentionPeriodCommandOutput) => void), - cb?: (err: any, data?: DecreaseStreamRetentionPeriodCommandOutput) => void - ): Promise | void { - const command = new DecreaseStreamRetentionPeriodCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Kinesis data stream and all its shards and data. You must shut down any - * applications that are operating on the stream before you delete the stream. If an - * application attempts to operate on a deleted stream, it receives the exception - * ResourceNotFoundException.

- * - *

When invoking this API, it is recommended you use the StreamARN input - * parameter rather than the StreamName input parameter.

- *
- *

If the stream is in the ACTIVE state, you can delete it. After a - * DeleteStream request, the specified stream is in the - * DELETING state until Kinesis Data Streams completes the - * deletion.

- *

- * Note: Kinesis Data Streams might continue to accept - * data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the - * DELETING state until the stream deletion is complete.

- *

When you delete a stream, any shards in that stream are also deleted, and any tags are - * dissociated from the stream.

- *

You can use the DescribeStreamSummary operation to check the state - * of the stream, which is returned in StreamStatus.

- *

- * DeleteStream has a limit of five transactions per second per - * account.

+ * @see {@link DeleteStreamCommand} */ - public deleteStream( - args: DeleteStreamCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteStream(args: DeleteStreamCommandInput, cb: (err: any, data?: DeleteStreamCommandOutput) => void): void; - public deleteStream( + deleteStream(args: DeleteStreamCommandInput, options?: __HttpHandlerOptions): Promise; + deleteStream(args: DeleteStreamCommandInput, cb: (err: any, data?: DeleteStreamCommandOutput) => void): void; + deleteStream( args: DeleteStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStreamCommandOutput) => void ): void; - public deleteStream( - args: DeleteStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStreamCommandOutput) => void), - cb?: (err: any, data?: DeleteStreamCommandOutput) => void - ): Promise | void { - const command = new DeleteStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of - * the data stream and the name you gave the consumer when you registered it. You may also - * provide all three parameters, as long as they don't conflict with each other. If you - * don't know the name or ARN of the consumer that you want to deregister, you can use the - * ListStreamConsumers operation to get a list of the descriptions of - * all the consumers that are currently registered with a given data stream. The - * description of a consumer contains its name and ARN.

- *

This operation has a limit of five transactions per second per stream.

+ * @see {@link DeregisterStreamConsumerCommand} */ - public deregisterStreamConsumer( + deregisterStreamConsumer( args: DeregisterStreamConsumerCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterStreamConsumer( + deregisterStreamConsumer( args: DeregisterStreamConsumerCommandInput, cb: (err: any, data?: DeregisterStreamConsumerCommandOutput) => void ): void; - public deregisterStreamConsumer( + deregisterStreamConsumer( args: DeregisterStreamConsumerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterStreamConsumerCommandOutput) => void ): void; - public deregisterStreamConsumer( - args: DeregisterStreamConsumerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterStreamConsumerCommandOutput) => void), - cb?: (err: any, data?: DeregisterStreamConsumerCommandOutput) => void - ): Promise | void { - const command = new DeregisterStreamConsumerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the shard limits and usage for the account.

- *

If you update your account limits, the old limits might be returned for a few - * minutes.

- *

This operation has a limit of one transaction per second per account.

+ * @see {@link DescribeLimitsCommand} */ - public describeLimits( + describeLimits( args: DescribeLimitsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLimits( - args: DescribeLimitsCommandInput, - cb: (err: any, data?: DescribeLimitsCommandOutput) => void - ): void; - public describeLimits( + describeLimits(args: DescribeLimitsCommandInput, cb: (err: any, data?: DescribeLimitsCommandOutput) => void): void; + describeLimits( args: DescribeLimitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLimitsCommandOutput) => void ): void; - public describeLimits( - args: DescribeLimitsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLimitsCommandOutput) => void), - cb?: (err: any, data?: DescribeLimitsCommandOutput) => void - ): Promise | void { - const command = new DescribeLimitsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified Kinesis data stream.

- * - *

This API has been revised. It's highly recommended that you use the DescribeStreamSummary API to get a summarized description of the - * specified Kinesis data stream and the ListShards API to list the - * shards in a specified data stream and obtain information about each shard.

- *
- * - *

When invoking this API, it is recommended you use the StreamARN input - * parameter rather than the StreamName input parameter.

- *
- *

The information returned includes the stream name, Amazon Resource Name (ARN), - * creation time, enhanced metric configuration, and shard map. The shard map is an array - * of shard objects. For each shard object, there is the hash key and sequence number - * ranges that the shard spans, and the IDs of any earlier shards that played in a role in - * creating the shard. Every record ingested in the stream is identified by a sequence - * number, which is assigned when the record is put into the stream.

- *

You can limit the number of shards returned by each call. For more information, see - * Retrieving - * Shards from a Stream in the Amazon Kinesis Data Streams Developer - * Guide.

- *

There are no guarantees about the chronological order shards returned. To process - * shards in chronological order, use the ID of the parent shard to track the lineage to - * the oldest shard.

- *

This operation has a limit of 10 transactions per second per account.

+ * @see {@link DescribeStreamCommand} */ - public describeStream( + describeStream( args: DescribeStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStream( - args: DescribeStreamCommandInput, - cb: (err: any, data?: DescribeStreamCommandOutput) => void - ): void; - public describeStream( + describeStream(args: DescribeStreamCommandInput, cb: (err: any, data?: DescribeStreamCommandOutput) => void): void; + describeStream( args: DescribeStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStreamCommandOutput) => void ): void; - public describeStream( - args: DescribeStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStreamCommandOutput) => void), - cb?: (err: any, data?: DescribeStreamCommandOutput) => void - ): Promise | void { - const command = new DescribeStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

To get the description of a registered consumer, provide the ARN of the consumer. - * Alternatively, you can provide the ARN of the data stream and the name you gave the - * consumer when you registered it. You may also provide all three parameters, as long as - * they don't conflict with each other. If you don't know the name or ARN of the consumer - * that you want to describe, you can use the ListStreamConsumers - * operation to get a list of the descriptions of all the consumers that are currently - * registered with a given data stream.

- *

This operation has a limit of 20 transactions per second per stream.

+ * @see {@link DescribeStreamConsumerCommand} */ - public describeStreamConsumer( + describeStreamConsumer( args: DescribeStreamConsumerCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStreamConsumer( + describeStreamConsumer( args: DescribeStreamConsumerCommandInput, cb: (err: any, data?: DescribeStreamConsumerCommandOutput) => void ): void; - public describeStreamConsumer( + describeStreamConsumer( args: DescribeStreamConsumerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStreamConsumerCommandOutput) => void ): void; - public describeStreamConsumer( - args: DescribeStreamConsumerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStreamConsumerCommandOutput) => void), - cb?: (err: any, data?: DescribeStreamConsumerCommandOutput) => void - ): Promise | void { - const command = new DescribeStreamConsumerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a summarized description of the specified Kinesis data stream without the - * shard list.

- * - *

When invoking this API, it is recommended you use the StreamARN input - * parameter rather than the StreamName input parameter.

- *
- *

The information returned includes the stream name, Amazon Resource Name (ARN), status, - * record retention period, approximate creation time, monitoring, encryption details, and - * open shard count.

- *

- * DescribeStreamSummary has a limit of 20 transactions per second per - * account.

+ * @see {@link DescribeStreamSummaryCommand} */ - public describeStreamSummary( + describeStreamSummary( args: DescribeStreamSummaryCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStreamSummary( + describeStreamSummary( args: DescribeStreamSummaryCommandInput, cb: (err: any, data?: DescribeStreamSummaryCommandOutput) => void ): void; - public describeStreamSummary( + describeStreamSummary( args: DescribeStreamSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStreamSummaryCommandOutput) => void ): void; - public describeStreamSummary( - args: DescribeStreamSummaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStreamSummaryCommandOutput) => void), - cb?: (err: any, data?: DescribeStreamSummaryCommandOutput) => void - ): Promise | void { - const command = new DescribeStreamSummaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables enhanced monitoring.

- * - *

When invoking this API, it is recommended you use the StreamARN input - * parameter rather than the StreamName input parameter.

- *
+ * @see {@link DisableEnhancedMonitoringCommand} */ - public disableEnhancedMonitoring( + disableEnhancedMonitoring( args: DisableEnhancedMonitoringCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableEnhancedMonitoring( + disableEnhancedMonitoring( args: DisableEnhancedMonitoringCommandInput, cb: (err: any, data?: DisableEnhancedMonitoringCommandOutput) => void ): void; - public disableEnhancedMonitoring( + disableEnhancedMonitoring( args: DisableEnhancedMonitoringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableEnhancedMonitoringCommandOutput) => void ): void; - public disableEnhancedMonitoring( - args: DisableEnhancedMonitoringCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableEnhancedMonitoringCommandOutput) => void), - cb?: (err: any, data?: DisableEnhancedMonitoringCommandOutput) => void - ): Promise | void { - const command = new DisableEnhancedMonitoringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables enhanced Kinesis data stream monitoring for shard-level metrics.

- * - *

When invoking this API, it is recommended you use the StreamARN input - * parameter rather than the StreamName input parameter.

- *
+ * @see {@link EnableEnhancedMonitoringCommand} */ - public enableEnhancedMonitoring( + enableEnhancedMonitoring( args: EnableEnhancedMonitoringCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableEnhancedMonitoring( + enableEnhancedMonitoring( args: EnableEnhancedMonitoringCommandInput, cb: (err: any, data?: EnableEnhancedMonitoringCommandOutput) => void ): void; - public enableEnhancedMonitoring( + enableEnhancedMonitoring( args: EnableEnhancedMonitoringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableEnhancedMonitoringCommandOutput) => void ): void; - public enableEnhancedMonitoring( - args: EnableEnhancedMonitoringCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableEnhancedMonitoringCommandOutput) => void), - cb?: (err: any, data?: EnableEnhancedMonitoringCommandOutput) => void - ): Promise | void { - const command = new EnableEnhancedMonitoringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets data records from a Kinesis data stream's shard.

- * - *

When invoking this API, it is recommended you use the StreamARN input - * parameter in addition to the ShardIterator parameter.

- *
- *

Specify a shard iterator using the ShardIterator parameter. The shard - * iterator specifies the position in the shard from which you want to start reading data - * records sequentially. If there are no records available in the portion of the shard that - * the iterator points to, GetRecords returns an empty list. It might - * take multiple calls to get to a portion of the shard that contains records.

- *

You can scale by provisioning multiple shards per stream while considering service - * limits (for more information, see Amazon Kinesis Data Streams - * Limits in the Amazon Kinesis Data Streams Developer - * Guide). Your application should have one thread per shard, each reading - * continuously from its stream. To read from a stream continually, call GetRecords in a loop. Use GetShardIterator to get the - * shard iterator to specify in the first GetRecords call. GetRecords returns a new shard iterator in - * NextShardIterator. Specify the shard iterator returned in - * NextShardIterator in subsequent calls to GetRecords. - * If the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator. - * You can terminate the loop when the shard is closed, or when the shard iterator reaches - * the record with the sequence number or other attribute that marks it as the last record - * to process.

- *

Each data record can be up to 1 MiB in size, and each shard can read up to 2 MiB per - * second. You can ensure that your calls don't exceed the maximum supported size or - * throughput by using the Limit parameter to specify the maximum number of - * records that GetRecords can return. Consider your average record size - * when determining this limit. The maximum number of records that can be returned per call - * is 10,000.

- *

The size of the data returned by GetRecords varies depending on the - * utilization of the shard. It is recommended that consumer applications retrieve records - * via the GetRecords command using the 5 TPS limit to remain caught up. - * Retrieving records less frequently can lead to consumer applications falling behind. The - * maximum size of data that GetRecords can return is 10 MiB. If a call - * returns this amount of data, subsequent calls made within the next 5 seconds throw - * ProvisionedThroughputExceededException. If there is insufficient - * provisioned throughput on the stream, subsequent calls made within the next 1 second - * throw ProvisionedThroughputExceededException. GetRecords - * doesn't return any data when it throws an exception. For this reason, we recommend that - * you wait 1 second between calls to GetRecords. However, it's possible - * that the application will get exceptions for longer than 1 second.

- *

To detect whether the application is falling behind in processing, you can use the - * MillisBehindLatest response attribute. You can also monitor the stream - * using CloudWatch metrics and other mechanisms (see Monitoring in the Amazon - * Kinesis Data Streams Developer Guide).

- *

Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp, - * that is set when a stream successfully receives and stores a record. This is commonly - * referred to as a server-side time stamp, whereas a client-side time stamp is set when a - * data producer creates or sends the record to a stream (a data producer is any data - * source putting data records into a stream, for example with PutRecords). The time stamp has millisecond precision. There are no guarantees about the time - * stamp accuracy, or that the time stamp is always increasing. For example, records in a - * shard or across a stream might have time stamps that are out of order.

- *

This operation has a limit of five transactions per second per shard.

+ * @see {@link GetRecordsCommand} */ - public getRecords(args: GetRecordsCommandInput, options?: __HttpHandlerOptions): Promise; - public getRecords(args: GetRecordsCommandInput, cb: (err: any, data?: GetRecordsCommandOutput) => void): void; - public getRecords( + getRecords(args: GetRecordsCommandInput, options?: __HttpHandlerOptions): Promise; + getRecords(args: GetRecordsCommandInput, cb: (err: any, data?: GetRecordsCommandOutput) => void): void; + getRecords( args: GetRecordsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRecordsCommandOutput) => void ): void; - public getRecords( - args: GetRecordsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRecordsCommandOutput) => void), - cb?: (err: any, data?: GetRecordsCommandOutput) => void - ): Promise | void { - const command = new GetRecordsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is - * returned to the requester.

- * - *

When invoking this API, it is recommended you use the StreamARN input - * parameter rather than the StreamName input parameter.

- *
- *

A shard iterator specifies the shard position from which to start reading data records - * sequentially. The position is specified using the sequence number of a data record in a - * shard. A sequence number is the identifier associated with every record ingested in the - * stream, and is assigned when a record is put into the stream. Each stream has one or - * more shards.

- *

You must specify the shard iterator type. For example, you can set the - * ShardIteratorType parameter to read exactly from the position denoted - * by a specific sequence number by using the AT_SEQUENCE_NUMBER shard - * iterator type. Alternatively, the parameter can read right after the sequence number by - * using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers - * returned by earlier calls to PutRecord, PutRecords, - * GetRecords, or DescribeStream. In the request, - * you can specify the shard iterator type AT_TIMESTAMP to read records from - * an arbitrary point in time, TRIM_HORIZON to cause - * ShardIterator to point to the last untrimmed record in the shard in the - * system (the oldest data record in the shard), or LATEST so that you always - * read the most recent data in the shard.

- *

When you read repeatedly from a stream, use a GetShardIterator - * request to get the first shard iterator for use in your first GetRecords request and for subsequent reads use the shard iterator returned by the GetRecords request in NextShardIterator. A new shard - * iterator is returned by every GetRecords request in - * NextShardIterator, which you use in the ShardIterator - * parameter of the next GetRecords request.

- *

If a GetShardIterator request is made too often, you receive a - * ProvisionedThroughputExceededException. For more information about - * throughput limits, see GetRecords, and Streams Limits in the - * Amazon Kinesis Data Streams Developer Guide.

- *

If the shard is closed, GetShardIterator returns a valid iterator - * for the last sequence number of the shard. A shard can be closed as a result of using - * SplitShard or MergeShards.

- *

- * GetShardIterator has a limit of five transactions per second per - * account per open shard.

+ * @see {@link GetShardIteratorCommand} */ - public getShardIterator( + getShardIterator( args: GetShardIteratorCommandInput, options?: __HttpHandlerOptions ): Promise; - public getShardIterator( + getShardIterator( args: GetShardIteratorCommandInput, cb: (err: any, data?: GetShardIteratorCommandOutput) => void ): void; - public getShardIterator( + getShardIterator( args: GetShardIteratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetShardIteratorCommandOutput) => void ): void; - public getShardIterator( - args: GetShardIteratorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetShardIteratorCommandOutput) => void), - cb?: (err: any, data?: GetShardIteratorCommandOutput) => void - ): Promise | void { - const command = new GetShardIteratorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Increases the Kinesis data stream's retention period, which is the length of time data - * records are accessible after they are added to the stream. The maximum value of a - * stream's retention period is 8760 hours (365 days).

- * - *

When invoking this API, it is recommended you use the StreamARN input - * parameter rather than the StreamName input parameter.

- *
- *

If you choose a longer stream retention period, this operation increases the time - * period during which records that have not yet expired are accessible. However, it does - * not make previous, expired data (older than the stream's previous retention period) - * accessible after the operation has been called. For example, if a stream's retention - * period is set to 24 hours and is increased to 168 hours, any data that is older than 24 - * hours remains inaccessible to consumer applications.

+ * @see {@link IncreaseStreamRetentionPeriodCommand} */ - public increaseStreamRetentionPeriod( + increaseStreamRetentionPeriod( args: IncreaseStreamRetentionPeriodCommandInput, options?: __HttpHandlerOptions ): Promise; - public increaseStreamRetentionPeriod( + increaseStreamRetentionPeriod( args: IncreaseStreamRetentionPeriodCommandInput, cb: (err: any, data?: IncreaseStreamRetentionPeriodCommandOutput) => void ): void; - public increaseStreamRetentionPeriod( + increaseStreamRetentionPeriod( args: IncreaseStreamRetentionPeriodCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IncreaseStreamRetentionPeriodCommandOutput) => void ): void; - public increaseStreamRetentionPeriod( - args: IncreaseStreamRetentionPeriodCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: IncreaseStreamRetentionPeriodCommandOutput) => void), - cb?: (err: any, data?: IncreaseStreamRetentionPeriodCommandOutput) => void - ): Promise | void { - const command = new IncreaseStreamRetentionPeriodCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the shards in a stream and provides information about each shard. This operation - * has a limit of 1000 transactions per second per data stream.

- * - *

When invoking this API, it is recommended you use the StreamARN input - * parameter rather than the StreamName input parameter.

- *
- *

This action does not list expired shards. For information about expired shards, see - * Data Routing, Data Persistence, and Shard State after a Reshard.

- * - *

This API is a new operation that is used by the Amazon Kinesis Client Library - * (KCL). If you have a fine-grained IAM policy that only allows specific operations, - * you must update your policy to allow calls to this API. For more information, see - * Controlling Access to Amazon Kinesis Data Streams Resources Using - * IAM.

- *
+ * @see {@link ListShardsCommand} */ - public listShards(args: ListShardsCommandInput, options?: __HttpHandlerOptions): Promise; - public listShards(args: ListShardsCommandInput, cb: (err: any, data?: ListShardsCommandOutput) => void): void; - public listShards( + listShards(args: ListShardsCommandInput, options?: __HttpHandlerOptions): Promise; + listShards(args: ListShardsCommandInput, cb: (err: any, data?: ListShardsCommandOutput) => void): void; + listShards( args: ListShardsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListShardsCommandOutput) => void ): void; - public listShards( - args: ListShardsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListShardsCommandOutput) => void), - cb?: (err: any, data?: ListShardsCommandOutput) => void - ): Promise | void { - const command = new ListShardsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the consumers registered to receive data from a stream using enhanced fan-out, - * and provides information about each consumer.

- *

This operation has a limit of 5 transactions per second per stream.

+ * @see {@link ListStreamConsumersCommand} */ - public listStreamConsumers( + listStreamConsumers( args: ListStreamConsumersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStreamConsumers( + listStreamConsumers( args: ListStreamConsumersCommandInput, cb: (err: any, data?: ListStreamConsumersCommandOutput) => void ): void; - public listStreamConsumers( + listStreamConsumers( args: ListStreamConsumersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamConsumersCommandOutput) => void ): void; - public listStreamConsumers( - args: ListStreamConsumersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStreamConsumersCommandOutput) => void), - cb?: (err: any, data?: ListStreamConsumersCommandOutput) => void - ): Promise | void { - const command = new ListStreamConsumersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists your Kinesis data streams.

- *

The number of streams may be too large to return from a single call to - * ListStreams. You can limit the number of returned streams using the - * Limit parameter. If you do not specify a value for the - * Limit parameter, Kinesis Data Streams uses the default limit, which is - * currently 100.

- *

You can detect if there are more streams available to list by using the - * HasMoreStreams flag from the returned output. If there are more streams - * available, you can request more streams by using the name of the last stream returned by - * the ListStreams request in the ExclusiveStartStreamName - * parameter in a subsequent request to ListStreams. The group of stream names - * returned by the subsequent request is then added to the list. You can continue this - * process until all the stream names have been collected in the list.

- *

- * ListStreams has a limit of five transactions per second per - * account.

+ * @see {@link ListStreamsCommand} */ - public listStreams(args: ListStreamsCommandInput, options?: __HttpHandlerOptions): Promise; - public listStreams(args: ListStreamsCommandInput, cb: (err: any, data?: ListStreamsCommandOutput) => void): void; - public listStreams( + listStreams(args: ListStreamsCommandInput, options?: __HttpHandlerOptions): Promise; + listStreams(args: ListStreamsCommandInput, cb: (err: any, data?: ListStreamsCommandOutput) => void): void; + listStreams( args: ListStreamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamsCommandOutput) => void ): void; - public listStreams( - args: ListStreamsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStreamsCommandOutput) => void), - cb?: (err: any, data?: ListStreamsCommandOutput) => void - ): Promise | void { - const command = new ListStreamsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags for the specified Kinesis data stream. This operation has a limit of - * five transactions per second per account.

- * - *

When invoking this API, it is recommended you use the StreamARN input - * parameter rather than the StreamName input parameter.

- *
+ * @see {@link ListTagsForStreamCommand} */ - public listTagsForStream( + listTagsForStream( args: ListTagsForStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForStream( + listTagsForStream( args: ListTagsForStreamCommandInput, cb: (err: any, data?: ListTagsForStreamCommandOutput) => void ): void; - public listTagsForStream( + listTagsForStream( args: ListTagsForStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForStreamCommandOutput) => void ): void; - public listTagsForStream( - args: ListTagsForStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForStreamCommandOutput) => void), - cb?: (err: any, data?: ListTagsForStreamCommandOutput) => void - ): Promise | void { - const command = new ListTagsForStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Merges two adjacent shards in a Kinesis data stream and combines them into a single - * shard to reduce the stream's capacity to ingest and transport data. This API is only - * supported for the data streams with the provisioned capacity mode. Two shards are - * considered adjacent if the union of the hash key ranges for the two shards form a - * contiguous set with no gaps. For example, if you have two shards, one with a hash key - * range of 276...381 and the other with a hash key range of 382...454, then you could - * merge these two shards into a single shard that would have a hash key range of - * 276...454. After the merge, the single child shard receives data for all hash key values - * covered by the two parent shards.

- * - *

When invoking this API, it is recommended you use the StreamARN input - * parameter rather than the StreamName input parameter.

- *
- *

- * MergeShards is called when there is a need to reduce the overall capacity - * of a stream because of excess capacity that is not being used. You must specify the - * shard to be merged and the adjacent shard for a stream. For more information about - * merging shards, see Merge Two - * Shards in the Amazon Kinesis Data Streams Developer - * Guide.

- *

If the stream is in the ACTIVE state, you can call - * MergeShards. If a stream is in the CREATING, - * UPDATING, or DELETING state, MergeShards - * returns a ResourceInUseException. If the specified stream does not exist, - * MergeShards returns a ResourceNotFoundException.

- *

You can use DescribeStreamSummary to check the state of the stream, - * which is returned in StreamStatus.

- *

- * MergeShards is an asynchronous operation. Upon receiving a - * MergeShards request, Amazon Kinesis Data Streams immediately returns a - * response and sets the StreamStatus to UPDATING. After the - * operation is completed, Kinesis Data Streams sets the StreamStatus to - * ACTIVE. Read and write operations continue to work while the stream is - * in the UPDATING state.

- *

You use DescribeStreamSummary and the ListShards - * APIs to determine the shard IDs that are specified in the MergeShards - * request.

- *

If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards, - * or SplitShard, you receive a LimitExceededException.

- *

- * MergeShards has a limit of five transactions per second per account.

+ * @see {@link MergeShardsCommand} */ - public mergeShards(args: MergeShardsCommandInput, options?: __HttpHandlerOptions): Promise; - public mergeShards(args: MergeShardsCommandInput, cb: (err: any, data?: MergeShardsCommandOutput) => void): void; - public mergeShards( + mergeShards(args: MergeShardsCommandInput, options?: __HttpHandlerOptions): Promise; + mergeShards(args: MergeShardsCommandInput, cb: (err: any, data?: MergeShardsCommandOutput) => void): void; + mergeShards( args: MergeShardsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MergeShardsCommandOutput) => void ): void; - public mergeShards( - args: MergeShardsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MergeShardsCommandOutput) => void), - cb?: (err: any, data?: MergeShardsCommandOutput) => void - ): Promise | void { - const command = new MergeShardsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Writes a single data record into an Amazon Kinesis data stream. Call - * PutRecord to send data into the stream for real-time ingestion and - * subsequent processing, one record at a time. Each shard can support writes up to 1,000 - * records per second, up to a maximum data write total of 1 MiB per second.

- * - *

When invoking this API, it is recommended you use the StreamARN input - * parameter rather than the StreamName input parameter.

- *
- *

You must specify the name of the stream that captures, stores, and transports the - * data; a partition key; and the data blob itself.

- *

The data blob can be any type of data; for example, a segment from a log file, - * geographic/location data, website clickstream data, and so on.

- *

The partition key is used by Kinesis Data Streams to distribute data across shards. - * Kinesis Data Streams segregates the data records that belong to a stream into multiple - * shards, using the partition key associated with each data record to determine the shard - * to which a given data record belongs.

- *

Partition keys are Unicode strings, with a maximum length limit of 256 characters for - * each key. An MD5 hash function is used to map partition keys to 128-bit integer values - * and to map associated data records to shards using the hash key ranges of the shards. - * You can override hashing the partition key to determine the shard by explicitly - * specifying a hash value using the ExplicitHashKey parameter. For more - * information, see Adding Data to a Stream in the Amazon Kinesis Data Streams - * Developer Guide.

- *

- * PutRecord returns the shard ID of where the data record was placed and the - * sequence number that was assigned to the data record.

- *

Sequence numbers increase over time and are specific to a shard within a stream, not - * across all shards within a stream. To guarantee strictly increasing ordering, write - * serially to a shard and use the SequenceNumberForOrdering parameter. For - * more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams - * Developer Guide.

- * - *

After you write a record to a stream, you cannot modify that record or its order - * within the stream.

- *
- *

If a PutRecord request cannot be processed because of insufficient - * provisioned throughput on the shard involved in the request, PutRecord - * throws ProvisionedThroughputExceededException.

- *

By default, data records are accessible for 24 hours from the time that they are added - * to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.

+ * @see {@link PutRecordCommand} */ - public putRecord(args: PutRecordCommandInput, options?: __HttpHandlerOptions): Promise; - public putRecord(args: PutRecordCommandInput, cb: (err: any, data?: PutRecordCommandOutput) => void): void; - public putRecord( + putRecord(args: PutRecordCommandInput, options?: __HttpHandlerOptions): Promise; + putRecord(args: PutRecordCommandInput, cb: (err: any, data?: PutRecordCommandOutput) => void): void; + putRecord( args: PutRecordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRecordCommandOutput) => void ): void; - public putRecord( - args: PutRecordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRecordCommandOutput) => void), - cb?: (err: any, data?: PutRecordCommandOutput) => void - ): Promise | void { - const command = new PutRecordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Writes multiple data records into a Kinesis data stream in a single call (also - * referred to as a PutRecords request). Use this operation to send data into - * the stream for data ingestion and processing.

- * - *

When invoking this API, it is recommended you use the StreamARN input - * parameter rather than the StreamName input parameter.

- *
- *

Each PutRecords request can support up to 500 records. Each record in the - * request can be as large as 1 MiB, up to a limit of 5 MiB for the entire request, - * including partition keys. Each shard can support writes up to 1,000 records per second, - * up to a maximum data write total of 1 MiB per second.

- *

You must specify the name of the stream that captures, stores, and transports the - * data; and an array of request Records, with each record in the array - * requiring a partition key and data blob. The record size limit applies to the total size - * of the partition key and data blob.

- *

The data blob can be any type of data; for example, a segment from a log file, - * geographic/location data, website clickstream data, and so on.

- *

The partition key is used by Kinesis Data Streams as input to a hash function that - * maps the partition key and associated data to a specific shard. An MD5 hash function is - * used to map partition keys to 128-bit integer values and to map associated data records - * to shards. As a result of this hashing mechanism, all data records with the same - * partition key map to the same shard within the stream. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams - * Developer Guide.

- *

Each record in the Records array may include an optional parameter, - * ExplicitHashKey, which overrides the partition key to shard mapping. - * This parameter allows a data producer to determine explicitly the shard where the record - * is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis - * Data Streams Developer Guide.

- *

The PutRecords response includes an array of response - * Records. Each record in the response array directly correlates with a - * record in the request array using natural ordering, from the top to the bottom of the - * request and response. The response Records array always includes the same - * number of records as the request array.

- *

The response Records array includes both successfully and unsuccessfully - * processed records. Kinesis Data Streams attempts to process all records in each - * PutRecords request. A single record failure does not stop the - * processing of subsequent records. As a result, PutRecords doesn't guarantee the ordering - * of records. If you need to read records in the same order they are written to the - * stream, use PutRecord instead of PutRecords, and write to - * the same shard.

- *

A successfully processed record includes ShardId and - * SequenceNumber values. The ShardId parameter identifies - * the shard in the stream where the record is stored. The SequenceNumber - * parameter is an identifier assigned to the put record, unique to all records in the - * stream.

- *

An unsuccessfully processed record includes ErrorCode and - * ErrorMessage values. ErrorCode reflects the type of error - * and can be one of the following values: - * ProvisionedThroughputExceededException or InternalFailure. - * ErrorMessage provides more detailed information about the - * ProvisionedThroughputExceededException exception including the account - * ID, stream name, and shard ID of the record that was throttled. For more information - * about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis - * Data Streams Developer Guide.

- * - *

After you write a record to a stream, you cannot modify that record or its order - * within the stream.

- *
- *

By default, data records are accessible for 24 hours from the time that they are added - * to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.

+ * @see {@link PutRecordsCommand} */ - public putRecords(args: PutRecordsCommandInput, options?: __HttpHandlerOptions): Promise; - public putRecords(args: PutRecordsCommandInput, cb: (err: any, data?: PutRecordsCommandOutput) => void): void; - public putRecords( + putRecords(args: PutRecordsCommandInput, options?: __HttpHandlerOptions): Promise; + putRecords(args: PutRecordsCommandInput, cb: (err: any, data?: PutRecordsCommandOutput) => void): void; + putRecords( args: PutRecordsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRecordsCommandOutput) => void ): void; - public putRecords( - args: PutRecordsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRecordsCommandOutput) => void), - cb?: (err: any, data?: PutRecordsCommandOutput) => void - ): Promise | void { - const command = new PutRecordsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers a consumer with a Kinesis data stream. When you use this operation, the - * consumer you register can then call SubscribeToShard to receive data - * from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every - * shard you subscribe to. This rate is unaffected by the total number of consumers that - * read from the same stream.

- *

You can register up to 20 consumers per stream. A given consumer can only be - * registered with one stream at a time.

- *

For an example of how to use this operations, see Enhanced Fan-Out - * Using the Kinesis Data Streams API.

- *

The use of this operation has a limit of five transactions per second per account. - * Also, only 5 consumers can be created simultaneously. In other words, you cannot have - * more than 5 consumers in a CREATING status at the same time. Registering a - * 6th consumer while there are 5 in a CREATING status results in a - * LimitExceededException.

+ * @see {@link RegisterStreamConsumerCommand} */ - public registerStreamConsumer( + registerStreamConsumer( args: RegisterStreamConsumerCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerStreamConsumer( + registerStreamConsumer( args: RegisterStreamConsumerCommandInput, cb: (err: any, data?: RegisterStreamConsumerCommandOutput) => void ): void; - public registerStreamConsumer( + registerStreamConsumer( args: RegisterStreamConsumerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterStreamConsumerCommandOutput) => void ): void; - public registerStreamConsumer( - args: RegisterStreamConsumerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterStreamConsumerCommandOutput) => void), - cb?: (err: any, data?: RegisterStreamConsumerCommandOutput) => void - ): Promise | void { - const command = new RegisterStreamConsumerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from the specified Kinesis data stream. Removed tags are deleted and - * cannot be recovered after this operation successfully completes.

- * - *

When invoking this API, it is recommended you use the StreamARN input - * parameter rather than the StreamName input parameter.

- *
- *

If you specify a tag that does not exist, it is ignored.

- *

- * RemoveTagsFromStream has a limit of five transactions per second per - * account.

+ * @see {@link RemoveTagsFromStreamCommand} */ - public removeTagsFromStream( + removeTagsFromStream( args: RemoveTagsFromStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeTagsFromStream( + removeTagsFromStream( args: RemoveTagsFromStreamCommandInput, cb: (err: any, data?: RemoveTagsFromStreamCommandOutput) => void ): void; - public removeTagsFromStream( + removeTagsFromStream( args: RemoveTagsFromStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsFromStreamCommandOutput) => void ): void; - public removeTagsFromStream( - args: RemoveTagsFromStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveTagsFromStreamCommandOutput) => void), - cb?: (err: any, data?: RemoveTagsFromStreamCommandOutput) => void - ): Promise | void { - const command = new RemoveTagsFromStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Splits a shard into two new shards in the Kinesis data stream, to increase the - * stream's capacity to ingest and transport data. SplitShard is called when - * there is a need to increase the overall capacity of a stream because of an expected - * increase in the volume of data records being ingested. This API is only supported for - * the data streams with the provisioned capacity mode.

- * - *

When invoking this API, it is recommended you use the StreamARN input - * parameter rather than the StreamName input parameter.

- *
- *

You can also use SplitShard when a shard appears to be approaching its - * maximum utilization; for example, the producers sending data into the specific shard are - * suddenly sending more than previously anticipated. You can also call - * SplitShard to increase stream capacity, so that more Kinesis Data - * Streams applications can simultaneously read data from the stream for real-time - * processing.

- *

You must specify the shard to be split and the new hash key, which is the position in - * the shard where the shard gets split in two. In many cases, the new hash key might be - * the average of the beginning and ending hash key, but it can be any hash key value in - * the range being mapped into the shard. For more information, see Split a - * Shard in the Amazon Kinesis Data Streams Developer - * Guide.

- *

You can use DescribeStreamSummary and the ListShards APIs to determine the shard ID and hash key values for the ShardToSplit - * and NewStartingHashKey parameters that are specified in the - * SplitShard request.

- *

- * SplitShard is an asynchronous operation. Upon receiving a - * SplitShard request, Kinesis Data Streams immediately returns a response - * and sets the stream status to UPDATING. After the operation is completed, - * Kinesis Data Streams sets the stream status to ACTIVE. Read and write - * operations continue to work while the stream is in the UPDATING state.

- *

You can use DescribeStreamSummary to check the status of the stream, - * which is returned in StreamStatus. If the stream is in the - * ACTIVE state, you can call SplitShard. - *

- *

If the specified stream does not exist, DescribeStreamSummary - * returns a ResourceNotFoundException. If you try to create more shards than - * are authorized for your account, you receive a LimitExceededException.

- *

For the default shard limit for an Amazon Web Services account, see Kinesis - * Data Streams Limits in the Amazon Kinesis Data Streams Developer - * Guide. To increase this limit, contact Amazon Web Services - * Support.

- *

If you try to operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards, and/or SplitShard, you receive a - * LimitExceededException.

- *

- * SplitShard has a limit of five transactions per second per account.

+ * @see {@link SplitShardCommand} */ - public splitShard(args: SplitShardCommandInput, options?: __HttpHandlerOptions): Promise; - public splitShard(args: SplitShardCommandInput, cb: (err: any, data?: SplitShardCommandOutput) => void): void; - public splitShard( + splitShard(args: SplitShardCommandInput, options?: __HttpHandlerOptions): Promise; + splitShard(args: SplitShardCommandInput, cb: (err: any, data?: SplitShardCommandOutput) => void): void; + splitShard( args: SplitShardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SplitShardCommandOutput) => void ): void; - public splitShard( - args: SplitShardCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SplitShardCommandOutput) => void), - cb?: (err: any, data?: SplitShardCommandOutput) => void - ): Promise | void { - const command = new SplitShardCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables or updates server-side encryption using an Amazon Web Services KMS key for a - * specified stream.

- *

Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis - * Data Streams returns immediately and sets the status of the stream to - * UPDATING. After the update is complete, Kinesis Data Streams sets the - * status of the stream back to ACTIVE. Updating or applying encryption - * normally takes a few seconds to complete, but it can take minutes. You can continue to - * read and write data to your stream while its status is UPDATING. Once the - * status of the stream is ACTIVE, encryption begins for records written to - * the stream.

- *

API Limits: You can successfully apply a new Amazon Web Services KMS key for - * server-side encryption 25 times in a rolling 24-hour period.

- *

Note: It can take up to 5 seconds after the stream is in an ACTIVE status - * before all records written to the stream are encrypted. After you enable encryption, you - * can verify that encryption is applied by inspecting the API response from - * PutRecord or PutRecords.

- * - *

When invoking this API, it is recommended you use the StreamARN input - * parameter rather than the StreamName input parameter.

- *
+ * @see {@link StartStreamEncryptionCommand} */ - public startStreamEncryption( + startStreamEncryption( args: StartStreamEncryptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startStreamEncryption( + startStreamEncryption( args: StartStreamEncryptionCommandInput, cb: (err: any, data?: StartStreamEncryptionCommandOutput) => void ): void; - public startStreamEncryption( + startStreamEncryption( args: StartStreamEncryptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartStreamEncryptionCommandOutput) => void ): void; - public startStreamEncryption( - args: StartStreamEncryptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartStreamEncryptionCommandOutput) => void), - cb?: (err: any, data?: StartStreamEncryptionCommandOutput) => void - ): Promise | void { - const command = new StartStreamEncryptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables server-side encryption for a specified stream.

- * - *

When invoking this API, it is recommended you use the StreamARN input - * parameter rather than the StreamName input parameter.

- *
- *

Stopping encryption is an asynchronous operation. Upon receiving the request, Kinesis - * Data Streams returns immediately and sets the status of the stream to - * UPDATING. After the update is complete, Kinesis Data Streams sets the - * status of the stream back to ACTIVE. Stopping encryption normally takes a - * few seconds to complete, but it can take minutes. You can continue to read and write - * data to your stream while its status is UPDATING. Once the status of the - * stream is ACTIVE, records written to the stream are no longer encrypted by - * Kinesis Data Streams.

- *

API Limits: You can successfully disable server-side encryption 25 times in a rolling - * 24-hour period.

- *

Note: It can take up to 5 seconds after the stream is in an ACTIVE status - * before all records written to the stream are no longer subject to encryption. After you - * disabled encryption, you can verify that encryption is not applied by inspecting the API - * response from PutRecord or PutRecords.

+ * @see {@link StopStreamEncryptionCommand} */ - public stopStreamEncryption( + stopStreamEncryption( args: StopStreamEncryptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopStreamEncryption( + stopStreamEncryption( args: StopStreamEncryptionCommandInput, cb: (err: any, data?: StopStreamEncryptionCommandOutput) => void ): void; - public stopStreamEncryption( + stopStreamEncryption( args: StopStreamEncryptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopStreamEncryptionCommandOutput) => void ): void; - public stopStreamEncryption( - args: StopStreamEncryptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopStreamEncryptionCommandOutput) => void), - cb?: (err: any, data?: StopStreamEncryptionCommandOutput) => void - ): Promise | void { - const command = new StopStreamEncryptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation establishes an HTTP/2 connection between the consumer you specify in - * the ConsumerARN parameter and the shard you specify in the - * ShardId parameter. After the connection is successfully established, - * Kinesis Data Streams pushes records from the shard to the consumer over this connection. - * Before you call this operation, call RegisterStreamConsumer to - * register the consumer with Kinesis Data Streams.

- *

When the SubscribeToShard call succeeds, your consumer starts receiving - * events of type SubscribeToShardEvent over the HTTP/2 connection for up - * to 5 minutes, after which time you need to call SubscribeToShard again to - * renew the subscription if you want to continue to receive records.

- *

You can make one call to SubscribeToShard per second per registered - * consumer per shard. For example, if you have a 4000 shard stream and two registered - * stream consumers, you can make one SubscribeToShard request per second for - * each combination of shard and registered consumer, allowing you to subscribe both - * consumers to all 4000 shards in one second.

- *

If you call SubscribeToShard again with the same ConsumerARN - * and ShardId within 5 seconds of a successful call, you'll get a - * ResourceInUseException. If you call SubscribeToShard 5 - * seconds or more after a successful call, the second call takes over the subscription and - * the previous connection expires or fails with a - * ResourceInUseException.

- *

For an example of how to use this operations, see Enhanced Fan-Out - * Using the Kinesis Data Streams API.

+ * @see {@link SubscribeToShardCommand} */ - public subscribeToShard( + subscribeToShard( args: SubscribeToShardCommandInput, options?: __HttpHandlerOptions ): Promise; - public subscribeToShard( + subscribeToShard( args: SubscribeToShardCommandInput, cb: (err: any, data?: SubscribeToShardCommandOutput) => void ): void; - public subscribeToShard( + subscribeToShard( args: SubscribeToShardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubscribeToShardCommandOutput) => void ): void; - public subscribeToShard( - args: SubscribeToShardCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SubscribeToShardCommandOutput) => void), - cb?: (err: any, data?: SubscribeToShardCommandOutput) => void - ): Promise | void { - const command = new SubscribeToShardCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the shard count of the specified stream to the specified number of shards. - * This API is only supported for the data streams with the provisioned capacity - * mode.

- * - *

When invoking this API, it is recommended you use the StreamARN input - * parameter rather than the StreamName input parameter.

- *
- *

Updating the shard count is an asynchronous operation. Upon receiving the request, - * Kinesis Data Streams returns immediately and sets the status of the stream to - * UPDATING. After the update is complete, Kinesis Data Streams sets the - * status of the stream back to ACTIVE. Depending on the size of the stream, - * the scaling action could take a few minutes to complete. You can continue to read and - * write data to your stream while its status is UPDATING.

- *

To update the shard count, Kinesis Data Streams performs splits or merges on - * individual shards. This can cause short-lived shards to be created, in addition to the - * final shards. These short-lived shards count towards your total shard limit for your - * account in the Region.

- *

When using this operation, we recommend that you specify a target shard count that is - * a multiple of 25% (25%, 50%, 75%, 100%). You can specify any target value within your - * shard limit. However, if you specify a target that isn't a multiple of 25%, the scaling - * action might take longer to complete.

- *

This operation has the following default limits. By default, you cannot do the - * following:

- *
    - *
  • - *

    Scale more than ten times per rolling 24-hour period per stream

    - *
  • - *
  • - *

    Scale up to more than double your current shard count for a stream

    - *
  • - *
  • - *

    Scale down below half your current shard count for a stream

    - *
  • - *
  • - *

    Scale up to more than 10000 shards in a stream

    - *
  • - *
  • - *

    Scale a stream with more than 10000 shards down unless the result is less than - * 10000 shards

    - *
  • - *
  • - *

    Scale up to more than the shard limit for your account

    - *
  • - *
- *

For the default limits for an Amazon Web Services account, see Streams - * Limits in the Amazon Kinesis Data Streams Developer - * Guide. To request an increase in the call rate limit, the shard limit for - * this API, or your overall shard limit, use the limits form.

+ * @see {@link UpdateShardCountCommand} */ - public updateShardCount( + updateShardCount( args: UpdateShardCountCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateShardCount( + updateShardCount( args: UpdateShardCountCommandInput, cb: (err: any, data?: UpdateShardCountCommandOutput) => void ): void; - public updateShardCount( + updateShardCount( args: UpdateShardCountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateShardCountCommandOutput) => void ): void; - public updateShardCount( - args: UpdateShardCountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateShardCountCommandOutput) => void), - cb?: (err: any, data?: UpdateShardCountCommandOutput) => void - ): Promise | void { - const command = new UpdateShardCountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you - * can choose between an on-demand capacity mode and a - * provisioned capacity mode for your data stream. - *

+ * @see {@link UpdateStreamModeCommand} */ - public updateStreamMode( + updateStreamMode( args: UpdateStreamModeCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateStreamMode( + updateStreamMode( args: UpdateStreamModeCommandInput, cb: (err: any, data?: UpdateStreamModeCommandOutput) => void ): void; - public updateStreamMode( + updateStreamMode( args: UpdateStreamModeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStreamModeCommandOutput) => void ): void; - public updateStreamMode( - args: UpdateStreamModeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStreamModeCommandOutput) => void), - cb?: (err: any, data?: UpdateStreamModeCommandOutput) => void - ): Promise | void { - const command = new UpdateStreamModeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Kinesis Data Streams Service API Reference + *

Amazon Kinesis Data Streams is a managed service that scales elastically for real-time + * processing of streaming big data.

+ */ +export class Kinesis extends KinesisClient implements Kinesis {} +createAggregatedClient(commands, Kinesis); diff --git a/clients/client-kms/src/KMS.ts b/clients/client-kms/src/KMS.ts index 19ac9e85aa70..4bfa68154392 100644 --- a/clients/client-kms/src/KMS.ts +++ b/clients/client-kms/src/KMS.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -167,4212 +168,841 @@ import { } from "./commands/UpdatePrimaryRegionCommand"; import { VerifyCommand, VerifyCommandInput, VerifyCommandOutput } from "./commands/VerifyCommand"; import { VerifyMacCommand, VerifyMacCommandInput, VerifyMacCommandOutput } from "./commands/VerifyMacCommand"; -import { KMSClient } from "./KMSClient"; +import { KMSClient, KMSClientConfig } from "./KMSClient"; -/** - * @public - * Key Management Service - *

Key Management Service (KMS) is an encryption and key management web service. This guide describes - * the KMS operations that you can call programmatically. For general information about KMS, - * see the - * Key Management Service Developer Guide - * .

- * - *

KMS has replaced the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.

- *

Amazon Web Services provides SDKs that consist of libraries and sample code for various programming - * languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a - * convenient way to create programmatic access to KMS and other Amazon Web Services services. For example, - * the SDKs take care of tasks such as signing requests (see below), managing errors, and - * retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to - * download and install them, see Tools for Amazon Web - * Services.

- *
- *

We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.

- *

If you need to use FIPS 140-2 validated cryptographic modules when communicating with - * Amazon Web Services, use the FIPS endpoint in your preferred Amazon Web Services Region. For more information about the - * available FIPS endpoints, see Service endpoints in the Key Management Service topic of - * the Amazon Web Services General Reference.

- *

All KMS API calls must be signed and be transmitted using Transport Layer Security - * (TLS). KMS recommends you always use the latest supported TLS version. Clients must also - * support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman - * (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 - * and later support these modes.

- *

- * Signing Requests - *

- *

Requests must be signed using an access key ID and a secret access key. We strongly - * recommend that you do not use your Amazon Web Services account root access key ID and secret access key for - * everyday work. You can use the access key ID and secret access key for an IAM user or you - * can use the Security Token Service (STS) to generate temporary security credentials and use those to sign - * requests.

- *

All KMS requests must be signed with Signature Version 4.

- *

- * Logging API Requests - *

- *

KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your - * Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the - * information collected by CloudTrail, you can determine what requests were made to KMS, who made - * the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it - * on and find your log files, see the CloudTrail User Guide.

- *

- * Additional Resources - *

- *

For more information about credentials and request signing, see the following:

- * - *

- * Commonly Used API Operations - *

- *

Of the API operations discussed in this guide, the following will prove the most useful - * for most applications. You will likely perform operations other than these, such as creating - * keys and assigning policies, by using the console.

- * - */ -export class KMS extends KMSClient { +const commands = { + CancelKeyDeletionCommand, + ConnectCustomKeyStoreCommand, + CreateAliasCommand, + CreateCustomKeyStoreCommand, + CreateGrantCommand, + CreateKeyCommand, + DecryptCommand, + DeleteAliasCommand, + DeleteCustomKeyStoreCommand, + DeleteImportedKeyMaterialCommand, + DescribeCustomKeyStoresCommand, + DescribeKeyCommand, + DisableKeyCommand, + DisableKeyRotationCommand, + DisconnectCustomKeyStoreCommand, + EnableKeyCommand, + EnableKeyRotationCommand, + EncryptCommand, + GenerateDataKeyCommand, + GenerateDataKeyPairCommand, + GenerateDataKeyPairWithoutPlaintextCommand, + GenerateDataKeyWithoutPlaintextCommand, + GenerateMacCommand, + GenerateRandomCommand, + GetKeyPolicyCommand, + GetKeyRotationStatusCommand, + GetParametersForImportCommand, + GetPublicKeyCommand, + ImportKeyMaterialCommand, + ListAliasesCommand, + ListGrantsCommand, + ListKeyPoliciesCommand, + ListKeysCommand, + ListResourceTagsCommand, + ListRetirableGrantsCommand, + PutKeyPolicyCommand, + ReEncryptCommand, + ReplicateKeyCommand, + RetireGrantCommand, + RevokeGrantCommand, + ScheduleKeyDeletionCommand, + SignCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAliasCommand, + UpdateCustomKeyStoreCommand, + UpdateKeyDescriptionCommand, + UpdatePrimaryRegionCommand, + VerifyCommand, + VerifyMacCommand, +}; + +export interface KMS { /** - * @public - *

Cancels the deletion of a KMS key. When this operation succeeds, the key state of the KMS - * key is Disabled. To enable the KMS key, use EnableKey.

- *

For more information about scheduling and canceling deletion of a KMS key, see Deleting KMS keys in the - * Key Management Service Developer Guide.

- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

- *

- * Required permissions: kms:CancelKeyDeletion (key policy)

- *

- * Related operations: ScheduleKeyDeletion - *

+ * @see {@link CancelKeyDeletionCommand} */ - public cancelKeyDeletion( + cancelKeyDeletion( args: CancelKeyDeletionCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelKeyDeletion( + cancelKeyDeletion( args: CancelKeyDeletionCommandInput, cb: (err: any, data?: CancelKeyDeletionCommandOutput) => void ): void; - public cancelKeyDeletion( + cancelKeyDeletion( args: CancelKeyDeletionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelKeyDeletionCommandOutput) => void ): void; - public cancelKeyDeletion( - args: CancelKeyDeletionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelKeyDeletionCommandOutput) => void), - cb?: (err: any, data?: CancelKeyDeletionCommandOutput) => void - ): Promise | void { - const command = new CancelKeyDeletionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Connects or reconnects a custom key store to its backing key store. For an CloudHSM key - * store, ConnectCustomKeyStore connects the key store to its associated CloudHSM - * cluster. For an external key store, ConnectCustomKeyStore connects the key store - * to the external key store proxy that communicates with your external key manager.

- *

The custom key store must be connected before you can create KMS keys in the key store or - * use the KMS keys it contains. You can disconnect and reconnect a custom key store at any - * time.

- *

The connection process for a custom key store can take an extended amount of time to - * complete. This operation starts the connection process, but it does not wait for it to - * complete. When it succeeds, this operation quickly returns an HTTP 200 response and a JSON - * object with no properties. However, this response does not indicate that the custom key store - * is connected. To get the connection state of the custom key store, use the DescribeCustomKeyStores operation.

- *

This operation is part of the custom key stores feature in KMS, which - * combines the convenience and extensive integration of KMS with the isolation and control of a - * key store that you own and manage.

- *

The ConnectCustomKeyStore operation might fail for various reasons. To find - * the reason, use the DescribeCustomKeyStores operation and see the - * ConnectionErrorCode in the response. For help interpreting the - * ConnectionErrorCode, see CustomKeyStoresListEntry.

- *

To fix the failure, use the DisconnectCustomKeyStore operation to - * disconnect the custom key store, correct the error, use the UpdateCustomKeyStore operation if necessary, and then use - * ConnectCustomKeyStore again.

- *

- * CloudHSM key store - *

- *

During the connection process for an CloudHSM key store, KMS finds the CloudHSM cluster that - * is associated with the custom key store, creates the connection infrastructure, connects to - * the cluster, logs into the CloudHSM client as the kmsuser CU, and rotates its - * password.

- *

To connect an CloudHSM key store, its associated CloudHSM cluster must have at least one active - * HSM. To get the number of active HSMs in a cluster, use the DescribeClusters operation. To add HSMs - * to the cluster, use the CreateHsm operation. Also, the - * kmsuser crypto - * user (CU) must not be logged into the cluster. This prevents KMS from using this - * account to log in.

- *

If you are having trouble connecting or disconnecting a CloudHSM key store, see Troubleshooting an CloudHSM key - * store in the Key Management Service Developer Guide.

- *

- * External key store - *

- *

When you connect an external key store that uses public endpoint connectivity, KMS tests - * its ability to communicate with your external key manager by sending a request via the - * external key store proxy.

- *

When you connect to an external key store that uses VPC endpoint service connectivity, - * KMS establishes the networking elements that it needs to communicate with your external key - * manager via the external key store proxy. This includes creating an interface endpoint to the - * VPC endpoint service and a private hosted zone for traffic between KMS and the VPC endpoint - * service.

- *

To connect an external key store, KMS must be able to connect to the external key store - * proxy, the external key store proxy must be able to communicate with your external key - * manager, and the external key manager must be available for cryptographic operations.

- *

If you are having trouble connecting or disconnecting an external key store, see Troubleshooting an external - * key store in the Key Management Service Developer Guide.

- *

- * Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.

- *

- * Required permissions: kms:ConnectCustomKeyStore (IAM policy)

- *

- * Related operations - *

- * + * @see {@link ConnectCustomKeyStoreCommand} */ - public connectCustomKeyStore( + connectCustomKeyStore( args: ConnectCustomKeyStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public connectCustomKeyStore( + connectCustomKeyStore( args: ConnectCustomKeyStoreCommandInput, cb: (err: any, data?: ConnectCustomKeyStoreCommandOutput) => void ): void; - public connectCustomKeyStore( + connectCustomKeyStore( args: ConnectCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConnectCustomKeyStoreCommandOutput) => void ): void; - public connectCustomKeyStore( - args: ConnectCustomKeyStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConnectCustomKeyStoreCommandOutput) => void), - cb?: (err: any, data?: ConnectCustomKeyStoreCommandOutput) => void - ): Promise | void { - const command = new ConnectCustomKeyStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a friendly name for a KMS key.

- * - *

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

- *
- *

You can use an alias to identify a KMS key in the KMS console, in the DescribeKey operation and in cryptographic operations, such as Encrypt and - * GenerateDataKey. You can also change the KMS key that's associated with - * the alias (UpdateAlias) or delete the alias (DeleteAlias) - * at any time. These operations don't affect the underlying KMS key.

- *

You can associate the alias with any customer managed key in the same Amazon Web Services Region. Each - * alias is associated with only one KMS key at a time, but a KMS key can have multiple aliases. - * A valid KMS key is required. You can't create an alias without a KMS key.

- *

The alias must be unique in the account and Region, but you can have aliases with the same - * name in different Regions. For detailed information about aliases, see Using aliases in the - * Key Management Service Developer Guide.

- *

This operation does not return a response. To get the alias that you created, use the - * ListAliases operation.

- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: No. You cannot perform this operation on an alias in a different Amazon Web Services account.

- *

- * Required permissions - *

- * - *

For details, see Controlling access to aliases in the - * Key Management Service Developer Guide.

- *

- * Related operations: - *

- * + * @see {@link CreateAliasCommand} */ - public createAlias(args: CreateAliasCommandInput, options?: __HttpHandlerOptions): Promise; - public createAlias(args: CreateAliasCommandInput, cb: (err: any, data?: CreateAliasCommandOutput) => void): void; - public createAlias( + createAlias(args: CreateAliasCommandInput, options?: __HttpHandlerOptions): Promise; + createAlias(args: CreateAliasCommandInput, cb: (err: any, data?: CreateAliasCommandOutput) => void): void; + createAlias( args: CreateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAliasCommandOutput) => void ): void; - public createAlias( - args: CreateAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAliasCommandOutput) => void), - cb?: (err: any, data?: CreateAliasCommandOutput) => void - ): Promise | void { - const command = new CreateAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a custom key store backed by a key store that you own and manage. When you use a - * KMS key in a custom key store for a cryptographic operation, the cryptographic operation is - * actually performed in your key store using your keys. KMS supports CloudHSM key stores - * backed by an CloudHSM cluster - * and external key stores backed by an external key store proxy and - * external key manager outside of Amazon Web Services.

- *

This operation is part of the custom key stores feature in KMS, which - * combines the convenience and extensive integration of KMS with the isolation and control of a - * key store that you own and manage.

- *

Before you create the custom key store, the required elements must be in place and - * operational. We recommend that you use the test tools that KMS provides to verify the - * configuration your external key store proxy. For details about the required elements and - * verification tests, see Assemble the prerequisites (for - * CloudHSM key stores) or Assemble the prerequisites (for - * external key stores) in the Key Management Service Developer Guide.

- *

To create a custom key store, use the following parameters.

- *
    - *
  • - *

    To create an CloudHSM key store, specify the CustomKeyStoreName, - * CloudHsmClusterId, KeyStorePassword, and - * TrustAnchorCertificate. The CustomKeyStoreType parameter is - * optional for CloudHSM key stores. If you include it, set it to the default value, - * AWS_CLOUDHSM. For help with failures, see Troubleshooting an CloudHSM key store in the - * Key Management Service Developer Guide.

    - *
  • - *
  • - *

    To create an external key store, specify the CustomKeyStoreName and a - * CustomKeyStoreType of EXTERNAL_KEY_STORE. Also, specify values - * for XksProxyConnectivity, XksProxyAuthenticationCredential, - * XksProxyUriEndpoint, and XksProxyUriPath. If your - * XksProxyConnectivity value is VPC_ENDPOINT_SERVICE, specify - * the XksProxyVpcEndpointServiceName parameter. For help with failures, see - * Troubleshooting - * an external key store in the Key Management Service Developer Guide.

    - *
  • - *
- * - *

For external key stores:

- *

Some external key managers provide a simpler method for creating an external key store. - * For details, see your external key manager documentation.

- *

When creating an external key store in the KMS console, you can upload a JSON-based - * proxy configuration file with the desired values. You cannot use a proxy configuration - * with the CreateCustomKeyStore operation. However, you can use the values in - * the file to help you determine the correct values for the CreateCustomKeyStore - * parameters.

- *
- *

When the operation completes successfully, it returns the ID of the new custom key store. - * Before you can use your new custom key store, you need to use the ConnectCustomKeyStore operation to connect a new CloudHSM key store to its CloudHSM - * cluster, or to connect a new external key store to the external key store proxy for your - * external key manager. Even if you are not going to use your custom key store immediately, you - * might want to connect it to verify that all settings are correct and then disconnect it until - * you are ready to use it.

- *

For help with failures, see Troubleshooting a custom key store in the - * Key Management Service Developer Guide.

- *

- * Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.

- *

- * Required permissions: kms:CreateCustomKeyStore (IAM policy).

- *

- * Related operations: - *

- * + * @see {@link CreateCustomKeyStoreCommand} */ - public createCustomKeyStore( + createCustomKeyStore( args: CreateCustomKeyStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCustomKeyStore( + createCustomKeyStore( args: CreateCustomKeyStoreCommandInput, cb: (err: any, data?: CreateCustomKeyStoreCommandOutput) => void ): void; - public createCustomKeyStore( + createCustomKeyStore( args: CreateCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomKeyStoreCommandOutput) => void ): void; - public createCustomKeyStore( - args: CreateCustomKeyStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCustomKeyStoreCommandOutput) => void), - cb?: (err: any, data?: CreateCustomKeyStoreCommandOutput) => void - ): Promise | void { - const command = new CreateCustomKeyStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a grant to a KMS key.

- *

A grant is a policy instrument that allows Amazon Web Services principals to use - * KMS keys in cryptographic operations. It also can allow them to view a KMS key (DescribeKey) and create and manage grants. When authorizing access to a KMS key, - * grants are considered along with key policies and IAM policies. Grants are often used for - * temporary permissions because you can create one, use its permissions, and delete it without - * changing your key policies or IAM policies.

- *

For detailed information about grants, including grant terminology, see Grants in KMS in the - * - * Key Management Service Developer Guide - * . For examples of working with grants in several - * programming languages, see Programming grants.

- *

The CreateGrant operation returns a GrantToken and a - * GrantId.

- *
    - *
  • - *

    When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as eventual consistency. Once the grant has achieved eventual consistency, the grantee - * principal can use the permissions in the grant without identifying the grant.

    - *

    However, to use the permissions in the grant immediately, use the - * GrantToken that CreateGrant returns. For details, see Using a - * grant token in the - * Key Management Service Developer Guide - * .

    - *
  • - *
  • - *

    The CreateGrant operation also returns a GrantId. You can - * use the GrantId and a key identifier to identify the grant in the RetireGrant and RevokeGrant operations. To find the grant - * ID, use the ListGrants or ListRetirableGrants - * operations.

    - *
  • - *
- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key - * ARN in the value of the KeyId parameter.

- *

- * Required permissions: kms:CreateGrant (key policy)

- *

- * Related operations: - *

- * + * @see {@link CreateGrantCommand} */ - public createGrant(args: CreateGrantCommandInput, options?: __HttpHandlerOptions): Promise; - public createGrant(args: CreateGrantCommandInput, cb: (err: any, data?: CreateGrantCommandOutput) => void): void; - public createGrant( + createGrant(args: CreateGrantCommandInput, options?: __HttpHandlerOptions): Promise; + createGrant(args: CreateGrantCommandInput, cb: (err: any, data?: CreateGrantCommandOutput) => void): void; + createGrant( args: CreateGrantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGrantCommandOutput) => void ): void; - public createGrant( - args: CreateGrantCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGrantCommandOutput) => void), - cb?: (err: any, data?: CreateGrantCommandOutput) => void - ): Promise | void { - const command = new CreateGrantCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a unique customer managed KMS key in your Amazon Web Services account and Region. - * You can use a KMS key in cryptographic operations, such as encryption and signing. Some Amazon Web Services - * services let you use KMS keys that you create and manage to protect your service - * resources.

- *

A KMS key is a logical representation of a cryptographic key. In addition to the key - * material used in cryptographic operations, a KMS key includes metadata, such as the key ID, - * key policy, creation date, description, and key state. For details, see Managing keys in the - * Key Management Service Developer Guide - *

- *

Use the parameters of CreateKey to specify the type of KMS key, the source of - * its key material, its key policy, description, tags, and other properties.

- * - *

KMS has replaced the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.

- *
- *

To create different types of KMS keys, use the following guidance:

- *
- *
Symmetric encryption KMS key
- *
- *

By default, CreateKey creates a symmetric encryption KMS key with key - * material that KMS generates. This is the basic and most widely used type of KMS key, and - * provides the best performance.

- *

To create a symmetric encryption KMS key, you don't need to specify any parameters. - * The default value for KeySpec, SYMMETRIC_DEFAULT, the default - * value for KeyUsage, ENCRYPT_DECRYPT, and the default value for - * Origin, AWS_KMS, create a symmetric encryption KMS key with - * KMS key material.

- *

If you need a key for basic encryption and decryption or you are creating a KMS key - * to protect your resources in an Amazon Web Services service, create a symmetric encryption KMS key. - * The key material in a symmetric encryption key never leaves KMS unencrypted. You can - * use a symmetric encryption KMS key to encrypt and decrypt data up to 4,096 bytes, but - * they are typically used to generate data keys and data keys pairs. For details, see - * GenerateDataKey and GenerateDataKeyPair.

- *

- *
- *
Asymmetric KMS keys
- *
- *

To create an asymmetric KMS key, use the KeySpec parameter to specify - * the type of key material in the KMS key. Then, use the KeyUsage parameter - * to determine whether the KMS key will be used to encrypt and decrypt or sign and verify. - * You can't change these properties after the KMS key is created.

- *

Asymmetric KMS keys contain an RSA key pair, Elliptic Curve (ECC) key pair, or an SM2 key pair (China Regions only). The private key in an asymmetric - * KMS key never leaves KMS unencrypted. However, you can use the GetPublicKey operation to download the public key - * so it can be used outside of KMS. KMS keys with RSA or SM2 key pairs can be used to encrypt or decrypt data or sign and verify messages (but not both). - * KMS keys with ECC key pairs can be used only to sign and verify messages. - * For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

- *

- *
- *
HMAC KMS key
- *
- *

To create an HMAC KMS key, set the KeySpec parameter to a key spec - * value for HMAC KMS keys. Then set the KeyUsage parameter to - * GENERATE_VERIFY_MAC. You must set the key usage even though - * GENERATE_VERIFY_MAC is the only valid key usage value for HMAC KMS keys. - * You can't change these properties after the KMS key is created.

- *

HMAC KMS keys are symmetric keys that never leave KMS unencrypted. You can use - * HMAC keys to generate (GenerateMac) and verify (VerifyMac) HMAC codes for messages up to 4096 bytes.

- *

HMAC KMS keys are not supported in all Amazon Web Services Regions. If you try to create an HMAC - * KMS key in an Amazon Web Services Region in which HMAC keys are not supported, the - * CreateKey operation returns an - * UnsupportedOperationException. For a list of Regions in which HMAC KMS keys - * are supported, see HMAC keys in - * KMS in the Key Management Service Developer Guide.

- *

- *
- *
Multi-Region primary keys
- *
Imported key material
- *
- *

To create a multi-Region primary key in the local Amazon Web Services Region, - * use the MultiRegion parameter with a value of True. To create - * a multi-Region replica key, that is, a KMS key with the same key ID - * and key material as a primary key, but in a different Amazon Web Services Region, use the ReplicateKey operation. To change a replica key to a primary key, and its - * primary key to a replica key, use the UpdatePrimaryRegion - * operation.

- *

You can create multi-Region KMS keys for all supported KMS key types: symmetric - * encryption KMS keys, HMAC KMS keys, asymmetric encryption KMS keys, and asymmetric - * signing KMS keys. You can also create multi-Region keys with imported key material. - * However, you can't create multi-Region keys in a custom key store.

- *

This operation supports multi-Region keys, an KMS feature that lets you create multiple - * interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key - * material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt - * it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

- *

- *
- *
- *

To import your own key material into a KMS key, begin by creating a symmetric - * encryption KMS key with no key material. To do this, use the Origin - * parameter of CreateKey with a value of EXTERNAL. Next, use - * GetParametersForImport operation to get a public key and import - * token, and use the public key to encrypt your key material. Then, use ImportKeyMaterial with your import token to import the key material. For - * step-by-step instructions, see Importing Key Material in the - * Key Management Service Developer Guide - * .

- *

This feature supports only symmetric encryption KMS keys, including multi-Region - * symmetric encryption KMS keys. You cannot import key material into any other type of KMS - * key.

- *

To create a multi-Region primary key with imported key material, use the - * Origin parameter of CreateKey with a value of - * EXTERNAL and the MultiRegion parameter with a value of - * True. To create replicas of the multi-Region primary key, use the ReplicateKey operation. For instructions, see Importing key material into - * multi-Region keys. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

- *

- *
- *
Custom key store
- *
- *

A custom key store lets you protect your Amazon Web Services resources using keys in a backing key - * store that you own and manage. When you request a cryptographic operation with a KMS key - * in a custom key store, the operation is performed in the backing key store using its - * cryptographic keys.

- *

KMS supports CloudHSM key stores backed by an CloudHSM cluster and external key stores backed by an - * external key manager outside of Amazon Web Services. When you create a KMS key in an CloudHSM key store, - * KMS generates an encryption key in the CloudHSM cluster and associates it with the KMS - * key. When you create a KMS key in an external key store, you specify an existing - * encryption key in the external key manager.

- * - *

Some external key managers provide a simpler method for creating a KMS key in an - * external key store. For details, see your external key manager documentation.

- *
- *

Before you create a KMS key in a custom key store, the ConnectionState - * of the key store must be CONNECTED. To connect the custom key store, use - * the ConnectCustomKeyStore operation. To find the - * ConnectionState, use the DescribeCustomKeyStores - * operation.

- *

To create a KMS key in a custom key store, use the CustomKeyStoreId. - * Use the default KeySpec value, SYMMETRIC_DEFAULT, and the - * default KeyUsage value, ENCRYPT_DECRYPT to create a symmetric - * encryption key. No other key type is supported in a custom key store.

- *

To create a KMS key in an CloudHSM key store, use the - * Origin parameter with a value of AWS_CLOUDHSM. The CloudHSM - * cluster that is associated with the custom key store must have at least two active HSMs - * in different Availability Zones in the Amazon Web Services Region.

- *

To create a KMS key in an external key store, use the Origin parameter - * with a value of EXTERNAL_KEY_STORE and an XksKeyId parameter - * that identifies an existing external key.

- * - *

Some external key managers provide a simpler method for creating a KMS key in an - * external key store. For details, see your external key manager documentation.

- *
- *
- *
- *

- * Cross-account use: No. You cannot use this operation to - * create a KMS key in a different Amazon Web Services account.

- *

- * Required permissions: kms:CreateKey (IAM policy). To use the - * Tags parameter, kms:TagResource (IAM policy). For examples and information about related - * permissions, see Allow a user to create - * KMS keys in the Key Management Service Developer Guide.

- *

- * Related operations: - *

- * + * @see {@link CreateKeyCommand} */ - public createKey(args: CreateKeyCommandInput, options?: __HttpHandlerOptions): Promise; - public createKey(args: CreateKeyCommandInput, cb: (err: any, data?: CreateKeyCommandOutput) => void): void; - public createKey( + createKey(args: CreateKeyCommandInput, options?: __HttpHandlerOptions): Promise; + createKey(args: CreateKeyCommandInput, cb: (err: any, data?: CreateKeyCommandOutput) => void): void; + createKey( args: CreateKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateKeyCommandOutput) => void ): void; - public createKey( - args: CreateKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateKeyCommandOutput) => void), - cb?: (err: any, data?: CreateKeyCommandOutput) => void - ): Promise | void { - const command = new CreateKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Decrypts ciphertext that was encrypted by a KMS key using any of the following - * operations:

- * - *

You can use this operation to decrypt ciphertext that was encrypted under a symmetric - * encryption KMS key or an asymmetric encryption KMS key. When the KMS key is asymmetric, you - * must specify the KMS key and the encryption algorithm that was used to encrypt the ciphertext. - * For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

- *

The Decrypt operation also decrypts ciphertext that was encrypted outside of - * KMS by the public key in an KMS asymmetric KMS key. However, it cannot decrypt symmetric - * ciphertext produced by other libraries, such as the Amazon Web Services Encryption SDK or Amazon S3 client-side encryption. - * These libraries return a ciphertext format that is incompatible with KMS.

- *

If the ciphertext was encrypted under a symmetric encryption KMS key, the - * KeyId parameter is optional. KMS can get this information from metadata that - * it adds to the symmetric ciphertext blob. This feature adds durability to your implementation - * by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even - * if they've lost track of the key ID. However, specifying the KMS key is always recommended as - * a best practice. When you use the KeyId parameter to specify a KMS key, KMS - * only uses the KMS key you specify. If the ciphertext was encrypted under a different KMS key, - * the Decrypt operation fails. This practice ensures that you use the KMS key that - * you intend.

- *

Whenever possible, use key policies to give users permission to call the - * Decrypt operation on a particular KMS key, instead of using &IAM; policies. - * Otherwise, you might create an &IAM; policy that gives the user Decrypt - * permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys - * in other accounts if the key policy for the cross-account KMS key permits it. If you must use - * an IAM policy for Decrypt permissions, limit the user to particular KMS keys or - * particular trusted accounts. For details, see Best practices for IAM - * policies in the Key Management Service Developer Guide.

- *

Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.

- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: Yes. If you use the KeyId - * parameter to identify a KMS key in a different Amazon Web Services account, specify the key ARN or the alias - * ARN of the KMS key.

- *

- * Required permissions: kms:Decrypt (key policy)

- *

- * Related operations: - *

- * + * @see {@link DecryptCommand} */ - public decrypt(args: DecryptCommandInput, options?: __HttpHandlerOptions): Promise; - public decrypt(args: DecryptCommandInput, cb: (err: any, data?: DecryptCommandOutput) => void): void; - public decrypt( + decrypt(args: DecryptCommandInput, options?: __HttpHandlerOptions): Promise; + decrypt(args: DecryptCommandInput, cb: (err: any, data?: DecryptCommandOutput) => void): void; + decrypt( args: DecryptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DecryptCommandOutput) => void ): void; - public decrypt( - args: DecryptCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DecryptCommandOutput) => void), - cb?: (err: any, data?: DecryptCommandOutput) => void - ): Promise | void { - const command = new DecryptCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified alias.

- * - *

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

- *
- *

Because an alias is not a property of a KMS key, you can delete and change the aliases of - * a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the - * DescribeKey operation. To get the aliases of all KMS keys, use the ListAliases operation.

- *

Each KMS key can have multiple aliases. To change the alias of a KMS key, use DeleteAlias to delete the current alias and CreateAlias to - * create a new alias. To associate an existing alias with a different KMS key, call UpdateAlias.

- *

- * Cross-account use: No. You cannot perform this operation on an alias in a different Amazon Web Services account.

- *

- * Required permissions - *

- * - *

For details, see Controlling access to aliases in the - * Key Management Service Developer Guide.

- *

- * Related operations: - *

- * + * @see {@link DeleteAliasCommand} */ - public deleteAlias(args: DeleteAliasCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteAlias(args: DeleteAliasCommandInput, cb: (err: any, data?: DeleteAliasCommandOutput) => void): void; - public deleteAlias( + deleteAlias(args: DeleteAliasCommandInput, options?: __HttpHandlerOptions): Promise; + deleteAlias(args: DeleteAliasCommandInput, cb: (err: any, data?: DeleteAliasCommandOutput) => void): void; + deleteAlias( args: DeleteAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAliasCommandOutput) => void ): void; - public deleteAlias( - args: DeleteAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAliasCommandOutput) => void), - cb?: (err: any, data?: DeleteAliasCommandOutput) => void - ): Promise | void { - const command = new DeleteAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a custom key store. This operation does not affect any backing elements of the - * custom key store. It does not delete the CloudHSM cluster that is associated with an CloudHSM key - * store, or affect any users or keys in the cluster. For an external key store, it does not - * affect the external key store proxy, external key manager, or any external keys.

- *

This operation is part of the custom key stores feature in KMS, which - * combines the convenience and extensive integration of KMS with the isolation and control of a - * key store that you own and manage.

- *

The custom key store that you delete cannot contain any KMS keys. Before deleting the key store, - * verify that you will never need to use any of the KMS keys in the key store for any - * cryptographic operations. Then, use ScheduleKeyDeletion to delete the KMS keys from the - * key store. After the required waiting period expires and all KMS keys are deleted from the - * custom key store, use DisconnectCustomKeyStore to disconnect the key store - * from KMS. Then, you can delete the custom key store.

- *

For keys in an CloudHSM key store, the ScheduleKeyDeletion operation makes a - * best effort to delete the key material from the associated cluster. However, you might need to - * manually delete the orphaned key - * material from the cluster and its backups. KMS never creates, manages, or deletes - * cryptographic keys in the external key manager associated with an external key store. You must - * manage them using your external key manager tools.

- *

Instead of deleting the custom key store, consider using the DisconnectCustomKeyStore operation to disconnect the custom key store from its - * backing key store. While the key store is disconnected, you cannot create or use the KMS keys - * in the key store. But, you do not need to delete KMS keys and you can reconnect a disconnected - * custom key store at any time.

- *

If the operation succeeds, it returns a JSON object with no - * properties.

- *

- * Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.

- *

- * Required permissions: kms:DeleteCustomKeyStore (IAM policy)

- *

- * Related operations: - *

- * + * @see {@link DeleteCustomKeyStoreCommand} */ - public deleteCustomKeyStore( + deleteCustomKeyStore( args: DeleteCustomKeyStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCustomKeyStore( + deleteCustomKeyStore( args: DeleteCustomKeyStoreCommandInput, cb: (err: any, data?: DeleteCustomKeyStoreCommandOutput) => void ): void; - public deleteCustomKeyStore( + deleteCustomKeyStore( args: DeleteCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomKeyStoreCommandOutput) => void ): void; - public deleteCustomKeyStore( - args: DeleteCustomKeyStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCustomKeyStoreCommandOutput) => void), - cb?: (err: any, data?: DeleteCustomKeyStoreCommandOutput) => void - ): Promise | void { - const command = new DeleteCustomKeyStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes key material that you previously imported. This operation makes the specified KMS - * key unusable. For more information about importing key material into KMS, see Importing Key Material - * in the Key Management Service Developer Guide.

- *

When the specified KMS key is in the PendingDeletion state, this operation - * does not change the KMS key's state. Otherwise, it changes the KMS key's state to - * PendingImport.

- *

After you delete key material, you can use ImportKeyMaterial to reimport - * the same key material into the KMS key.

- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

- *

- * Required permissions: kms:DeleteImportedKeyMaterial (key policy)

- *

- * Related operations: - *

- * + * @see {@link DeleteImportedKeyMaterialCommand} */ - public deleteImportedKeyMaterial( + deleteImportedKeyMaterial( args: DeleteImportedKeyMaterialCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteImportedKeyMaterial( + deleteImportedKeyMaterial( args: DeleteImportedKeyMaterialCommandInput, cb: (err: any, data?: DeleteImportedKeyMaterialCommandOutput) => void ): void; - public deleteImportedKeyMaterial( + deleteImportedKeyMaterial( args: DeleteImportedKeyMaterialCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteImportedKeyMaterialCommandOutput) => void ): void; - public deleteImportedKeyMaterial( - args: DeleteImportedKeyMaterialCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteImportedKeyMaterialCommandOutput) => void), - cb?: (err: any, data?: DeleteImportedKeyMaterialCommandOutput) => void - ): Promise | void { - const command = new DeleteImportedKeyMaterialCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about custom key stores in the account and Region.

- *

This operation is part of the custom key stores feature in KMS, which - * combines the convenience and extensive integration of KMS with the isolation and control of a - * key store that you own and manage.

- *

By default, this operation returns information about all custom key stores in the account - * and Region. To get only information about a particular custom key store, use either the - * CustomKeyStoreName or CustomKeyStoreId parameter (but not - * both).

- *

To determine whether the custom key store is connected to its CloudHSM cluster or external - * key store proxy, use the ConnectionState element in the response. If an attempt - * to connect the custom key store failed, the ConnectionState value is - * FAILED and the ConnectionErrorCode element in the response - * indicates the cause of the failure. For help interpreting the - * ConnectionErrorCode, see CustomKeyStoresListEntry.

- *

Custom key stores have a DISCONNECTED connection state if the key store has - * never been connected or you used the DisconnectCustomKeyStore operation to - * disconnect it. Otherwise, the connection state is CONNECTED. If your custom key store - * connection state is CONNECTED but you are having trouble using it, verify that - * the backing store is active and available. For an CloudHSM key store, verify that the associated - * CloudHSM cluster is active and contains the minimum number of HSMs required for the operation, if - * any. For an external key store, verify that the external key store proxy and its associated - * external key manager are reachable and enabled.

- *

For help repairing your CloudHSM key store, see the Troubleshooting CloudHSM key stores. For help - * repairing your external key store, see the Troubleshooting external key stores. Both - * topics are in the Key Management Service Developer Guide.

- *

- * Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.

- *

- * Required permissions: kms:DescribeCustomKeyStores (IAM policy)

- *

- * Related operations: - *

- * + * @see {@link DescribeCustomKeyStoresCommand} */ - public describeCustomKeyStores( + describeCustomKeyStores( args: DescribeCustomKeyStoresCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCustomKeyStores( + describeCustomKeyStores( args: DescribeCustomKeyStoresCommandInput, cb: (err: any, data?: DescribeCustomKeyStoresCommandOutput) => void ): void; - public describeCustomKeyStores( + describeCustomKeyStores( args: DescribeCustomKeyStoresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCustomKeyStoresCommandOutput) => void ): void; - public describeCustomKeyStores( - args: DescribeCustomKeyStoresCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCustomKeyStoresCommandOutput) => void), - cb?: (err: any, data?: DescribeCustomKeyStoresCommandOutput) => void - ): Promise | void { - const command = new DescribeCustomKeyStoresCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides detailed information about a KMS key. You can run DescribeKey on a - * customer managed - * key or an Amazon Web Services managed key.

- *

This detailed information includes the key ARN, creation date (and deletion date, if - * applicable), the key state, and the origin and expiration date (if any) of the key material. - * It includes fields, like KeySpec, that help you distinguish different types of - * KMS keys. It also displays the key usage (encryption, signing, or generating and verifying - * MACs) and the algorithms that the KMS key supports.

- *

For multi-Region keys, - * DescribeKey displays the primary key and all related replica keys. For KMS keys - * in CloudHSM key stores, it includes - * information about the key store, such as the key store ID and the CloudHSM cluster ID. For KMS - * keys in external key stores, it - * includes the custom key store ID and the ID of the external key.

- *

- * DescribeKey does not return the following information:

- *
    - *
  • - *

    Aliases associated with the KMS key. To get this information, use ListAliases.

    - *
  • - *
  • - *

    Whether automatic key rotation is enabled on the KMS key. To get this information, use - * GetKeyRotationStatus. Also, some key states prevent a KMS key from - * being automatically rotated. For details, see How Automatic Key Rotation - * Works in the Key Management Service Developer Guide.

    - *
  • - *
  • - *

    Tags on the KMS key. To get this information, use ListResourceTags.

    - *
  • - *
  • - *

    Key policies and grants on the KMS key. To get this information, use GetKeyPolicy and ListGrants.

    - *
  • - *
- *

In general, DescribeKey is a non-mutating operation. It returns data about - * KMS keys, but doesn't change them. However, Amazon Web Services services use DescribeKey to - * create Amazon Web Services - * managed keys from a predefined Amazon Web Services alias with no key - * ID.

- *

- * Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify - * the key ARN or alias ARN in the value of the KeyId parameter.

- *

- * Required permissions: kms:DescribeKey (key policy)

- *

- * Related operations: - *

- * + * @see {@link DescribeKeyCommand} */ - public describeKey(args: DescribeKeyCommandInput, options?: __HttpHandlerOptions): Promise; - public describeKey(args: DescribeKeyCommandInput, cb: (err: any, data?: DescribeKeyCommandOutput) => void): void; - public describeKey( + describeKey(args: DescribeKeyCommandInput, options?: __HttpHandlerOptions): Promise; + describeKey(args: DescribeKeyCommandInput, cb: (err: any, data?: DescribeKeyCommandOutput) => void): void; + describeKey( args: DescribeKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeKeyCommandOutput) => void ): void; - public describeKey( - args: DescribeKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeKeyCommandOutput) => void), - cb?: (err: any, data?: DescribeKeyCommandOutput) => void - ): Promise | void { - const command = new DescribeKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the state of a KMS key to disabled. This change temporarily prevents use of the KMS - * key for cryptographic operations.

- *

For more information about how key state affects the use of a KMS key, see - * Key states of KMS keys in the - * Key Management Service Developer Guide - * .

- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

- *

- * Required permissions: kms:DisableKey (key policy)

- *

- * Related operations: EnableKey - *

+ * @see {@link DisableKeyCommand} */ - public disableKey(args: DisableKeyCommandInput, options?: __HttpHandlerOptions): Promise; - public disableKey(args: DisableKeyCommandInput, cb: (err: any, data?: DisableKeyCommandOutput) => void): void; - public disableKey( + disableKey(args: DisableKeyCommandInput, options?: __HttpHandlerOptions): Promise; + disableKey(args: DisableKeyCommandInput, cb: (err: any, data?: DisableKeyCommandOutput) => void): void; + disableKey( args: DisableKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableKeyCommandOutput) => void ): void; - public disableKey( - args: DisableKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableKeyCommandOutput) => void), - cb?: (err: any, data?: DisableKeyCommandOutput) => void - ): Promise | void { - const command = new DisableKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables automatic - * rotation of the key material of the specified symmetric encryption KMS key.

- *

Automatic key rotation is supported only on symmetric encryption KMS keys. - * You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

- *

You can enable (EnableKeyRotation) and disable automatic rotation of the - * key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not - * configurable. KMS always rotates the key material for every year. Rotation of Amazon Web Services owned KMS - * keys varies.

- * - *

In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three - * years to every year. For details, see EnableKeyRotation.

- *
- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

- *

- * Required permissions: kms:DisableKeyRotation (key policy)

- *

- * Related operations: - *

- * + * @see {@link DisableKeyRotationCommand} */ - public disableKeyRotation( + disableKeyRotation( args: DisableKeyRotationCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableKeyRotation( + disableKeyRotation( args: DisableKeyRotationCommandInput, cb: (err: any, data?: DisableKeyRotationCommandOutput) => void ): void; - public disableKeyRotation( + disableKeyRotation( args: DisableKeyRotationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableKeyRotationCommandOutput) => void ): void; - public disableKeyRotation( - args: DisableKeyRotationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableKeyRotationCommandOutput) => void), - cb?: (err: any, data?: DisableKeyRotationCommandOutput) => void - ): Promise | void { - const command = new DisableKeyRotationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disconnects the custom key store from its backing key store. This operation disconnects an - * CloudHSM key store from its associated CloudHSM cluster or disconnects an external key store from - * the external key store proxy that communicates with your external key manager.

- *

This operation is part of the custom key stores feature in KMS, which - * combines the convenience and extensive integration of KMS with the isolation and control of a - * key store that you own and manage.

- *

While a custom key store is disconnected, you can manage the custom key store and its KMS - * keys, but you cannot create or use its KMS keys. You can reconnect the custom key store at any - * time.

- * - *

While a custom key store is disconnected, all attempts to create KMS keys in the custom key store or to use existing KMS keys in cryptographic operations will - * fail. This action can prevent users from storing and accessing sensitive data.

- *
- *

When you disconnect a custom key store, its ConnectionState changes to - * Disconnected. To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. To reconnect a custom key store, use the - * ConnectCustomKeyStore operation.

- *

If the operation succeeds, it returns a JSON object with no - * properties.

- *

- * Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.

- *

- * Required permissions: kms:DisconnectCustomKeyStore (IAM policy)

- *

- * Related operations: - *

- * + * @see {@link DisconnectCustomKeyStoreCommand} */ - public disconnectCustomKeyStore( + disconnectCustomKeyStore( args: DisconnectCustomKeyStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public disconnectCustomKeyStore( + disconnectCustomKeyStore( args: DisconnectCustomKeyStoreCommandInput, cb: (err: any, data?: DisconnectCustomKeyStoreCommandOutput) => void ): void; - public disconnectCustomKeyStore( + disconnectCustomKeyStore( args: DisconnectCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisconnectCustomKeyStoreCommandOutput) => void ): void; - public disconnectCustomKeyStore( - args: DisconnectCustomKeyStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisconnectCustomKeyStoreCommandOutput) => void), - cb?: (err: any, data?: DisconnectCustomKeyStoreCommandOutput) => void - ): Promise | void { - const command = new DisconnectCustomKeyStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the key state of a KMS key to enabled. This allows you to use the KMS key for - * cryptographic operations.

- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

- *

- * Required permissions: kms:EnableKey (key policy)

- *

- * Related operations: DisableKey - *

+ * @see {@link EnableKeyCommand} */ - public enableKey(args: EnableKeyCommandInput, options?: __HttpHandlerOptions): Promise; - public enableKey(args: EnableKeyCommandInput, cb: (err: any, data?: EnableKeyCommandOutput) => void): void; - public enableKey( + enableKey(args: EnableKeyCommandInput, options?: __HttpHandlerOptions): Promise; + enableKey(args: EnableKeyCommandInput, cb: (err: any, data?: EnableKeyCommandOutput) => void): void; + enableKey( args: EnableKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableKeyCommandOutput) => void ): void; - public enableKey( - args: EnableKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableKeyCommandOutput) => void), - cb?: (err: any, data?: EnableKeyCommandOutput) => void - ): Promise | void { - const command = new EnableKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables automatic rotation - * of the key material of the specified symmetric encryption KMS key.

- *

When you enable automatic rotation of acustomer managed KMS key, KMS - * rotates the key material of the KMS key one year (approximately 365 days) from the enable date - * and every year thereafter. You can monitor rotation of the key material for your KMS keys in - * CloudTrail and Amazon CloudWatch. To disable rotation of the key material in a customer - * managed KMS key, use the DisableKeyRotation operation.

- *

Automatic key rotation is supported only on symmetric encryption KMS keys. - * You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

- *

You cannot enable or disable automatic rotation Amazon Web Services managed KMS keys. KMS - * always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS - * keys varies.

- * - *

In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three - * years (approximately 1,095 days) to every year (approximately 365 days).

- *

New Amazon Web Services managed keys are automatically rotated one year after they are created, and - * approximately every year thereafter.

- *

Existing Amazon Web Services managed keys are automatically rotated one year after their most recent - * rotation, and every year thereafter.

- *
- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

- *

- * Required permissions: kms:EnableKeyRotation (key policy)

- *

- * Related operations: - *

- * + * @see {@link EnableKeyRotationCommand} */ - public enableKeyRotation( + enableKeyRotation( args: EnableKeyRotationCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableKeyRotation( + enableKeyRotation( args: EnableKeyRotationCommandInput, cb: (err: any, data?: EnableKeyRotationCommandOutput) => void ): void; - public enableKeyRotation( + enableKeyRotation( args: EnableKeyRotationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableKeyRotationCommandOutput) => void ): void; - public enableKeyRotation( - args: EnableKeyRotationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableKeyRotationCommandOutput) => void), - cb?: (err: any, data?: EnableKeyRotationCommandOutput) => void - ): Promise | void { - const command = new EnableKeyRotationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Encrypts plaintext of up to 4,096 bytes using a KMS key. You can use a symmetric or - * asymmetric KMS key with a KeyUsage of ENCRYPT_DECRYPT.

- *

You can use this operation to encrypt small amounts of arbitrary data, such as a personal - * identifier or database password, or other sensitive information. You don't need to use the - * Encrypt operation to encrypt a data key. The GenerateDataKey - * and GenerateDataKeyPair operations return a plaintext data key and an - * encrypted copy of that data key.

- *

If you use a symmetric encryption KMS key, you can use an encryption context to add - * additional security to your encryption operation. If you specify an - * EncryptionContext when encrypting data, you must specify the same encryption - * context (a case-sensitive exact match) when decrypting the data. Otherwise, the request to - * decrypt fails with an InvalidCiphertextException. For more information, see - * Encryption - * Context in the Key Management Service Developer Guide.

- *

If you specify an asymmetric KMS key, you must also specify the encryption algorithm. The - * algorithm must be compatible with the KMS key spec.

- * - *

When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.

- *

You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric encryption KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.

- *
- *

The maximum size of the data that you can encrypt varies with the type of KMS key and the - * encryption algorithm that you choose.

- *
    - *
  • - *

    Symmetric encryption KMS keys

    - *
      - *
    • - *

      - * SYMMETRIC_DEFAULT: 4096 bytes

      - *
    • - *
    - *
  • - *
  • - *

    - * RSA_2048 - *

    - *
      - *
    • - *

      - * RSAES_OAEP_SHA_1: 214 bytes

      - *
    • - *
    • - *

      - * RSAES_OAEP_SHA_256: 190 bytes

      - *
    • - *
    - *
  • - *
  • - *

    - * RSA_3072 - *

    - *
      - *
    • - *

      - * RSAES_OAEP_SHA_1: 342 bytes

      - *
    • - *
    • - *

      - * RSAES_OAEP_SHA_256: 318 bytes

      - *
    • - *
    - *
  • - *
  • - *

    - * RSA_4096 - *

    - *
      - *
    • - *

      - * RSAES_OAEP_SHA_1: 470 bytes

      - *
    • - *
    • - *

      - * RSAES_OAEP_SHA_256: 446 bytes

      - *
    • - *
    - *
  • - *
  • - *

    - * SM2PKE: 1024 bytes (China Regions only)

    - *
  • - *
- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: Yes. - * To perform this operation with a KMS key in a different Amazon Web Services account, specify - * the key ARN or alias ARN in the value of the KeyId parameter.

- *

- * Required permissions: kms:Encrypt (key policy)

- *

- * Related operations: - *

- * + * @see {@link EncryptCommand} */ - public encrypt(args: EncryptCommandInput, options?: __HttpHandlerOptions): Promise; - public encrypt(args: EncryptCommandInput, cb: (err: any, data?: EncryptCommandOutput) => void): void; - public encrypt( + encrypt(args: EncryptCommandInput, options?: __HttpHandlerOptions): Promise; + encrypt(args: EncryptCommandInput, cb: (err: any, data?: EncryptCommandOutput) => void): void; + encrypt( args: EncryptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EncryptCommandOutput) => void ): void; - public encrypt( - args: EncryptCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EncryptCommandOutput) => void), - cb?: (err: any, data?: EncryptCommandOutput) => void - ): Promise | void { - const command = new EncryptCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a unique symmetric data key for use outside of KMS. This operation returns a - * plaintext copy of the data key and a copy that is encrypted under a symmetric encryption KMS - * key that you specify. The bytes in the plaintext key are random; they are not related - * to the caller or the KMS key. You can use the plaintext key to encrypt your data outside of KMS - * and store the encrypted data key with the encrypted data.

- *

To generate a data key, specify the symmetric encryption KMS key that will be used to - * encrypt the data key. You cannot use an asymmetric KMS key to encrypt data keys. To get the - * type of your KMS key, use the DescribeKey operation.

- *

You must also specify the length of the data key. Use either the KeySpec or - * NumberOfBytes parameters (but not both). For 128-bit and 256-bit data keys, use - * the KeySpec parameter.

- *

To generate a 128-bit SM4 data key (China Regions only), specify a KeySpec value of - * AES_128 or a NumberOfBytes value of 16. The symmetric - * encryption key used in China Regions to encrypt your data key is an SM4 encryption key.

- *

To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use - * the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure - * random byte string, use GenerateRandom.

- *

You can use an optional encryption context to add additional security to the encryption - * operation. If you specify an EncryptionContext, you must specify the same - * encryption context (a case-sensitive exact match) when decrypting the encrypted data key. - * Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the - * Key Management Service Developer Guide.

- *

Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.

- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * How to use your data key - *

- *

We recommend that you use the following pattern to encrypt data locally in your - * application. You can write your own code or use a client-side encryption library, such as the - * Amazon Web Services Encryption SDK, the - * Amazon DynamoDB Encryption Client, - * or Amazon S3 - * client-side encryption to do these tasks for you.

- *

To encrypt data outside of KMS:

- *
    - *
  1. - *

    Use the GenerateDataKey operation to get a data key.

    - *
  2. - *
  3. - *

    Use the plaintext data key (in the Plaintext field of the response) to - * encrypt your data outside of KMS. Then erase the plaintext data key from memory.

    - *
  4. - *
  5. - *

    Store the encrypted data key (in the CiphertextBlob field of the - * response) with the encrypted data.

    - *
  6. - *
- *

To decrypt data outside of KMS:

- *
    - *
  1. - *

    Use the Decrypt operation to decrypt the encrypted data key. The - * operation returns a plaintext copy of the data key.

    - *
  2. - *
  3. - *

    Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext - * data key from memory.

    - *
  4. - *
- *

- * Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify - * the key ARN or alias ARN in the value of the KeyId parameter.

- *

- * Required permissions: kms:GenerateDataKey (key policy)

- *

- * Related operations: - *

- * + * @see {@link GenerateDataKeyCommand} */ - public generateDataKey( + generateDataKey( args: GenerateDataKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public generateDataKey( - args: GenerateDataKeyCommandInput, - cb: (err: any, data?: GenerateDataKeyCommandOutput) => void - ): void; - public generateDataKey( + generateDataKey(args: GenerateDataKeyCommandInput, cb: (err: any, data?: GenerateDataKeyCommandOutput) => void): void; + generateDataKey( args: GenerateDataKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateDataKeyCommandOutput) => void ): void; - public generateDataKey( - args: GenerateDataKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GenerateDataKeyCommandOutput) => void), - cb?: (err: any, data?: GenerateDataKeyCommandOutput) => void - ): Promise | void { - const command = new GenerateDataKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a unique asymmetric data key pair for use outside of KMS. This operation returns - * a plaintext public key, a plaintext private key, and a copy of the private key that is - * encrypted under the symmetric encryption KMS key you specify. You can use the data key pair to - * perform asymmetric cryptography and implement digital signatures outside of KMS. The bytes - * in the keys are random; they not related to the caller or to the KMS key that is used to - * encrypt the private key.

- *

You can use the public key that GenerateDataKeyPair returns to encrypt data - * or verify a signature outside of KMS. Then, store the encrypted private key with the data. - * When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

- *

To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt - * the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a - * custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

- *

Use the KeyPairSpec parameter to choose an RSA or Elliptic Curve (ECC) data - * key pair. In China Regions, you can also choose an SM2 data key pair. KMS recommends that you use - * ECC key pairs for signing, and use RSA and SM2 key pairs for either encryption or signing, but not both. - * However, KMS cannot enforce any restrictions on the use of data key pairs outside of KMS.

- *

If you are using the data key pair to encrypt data, or for any operation where you don't - * immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation. - * GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an - * encrypted private key, but omits the plaintext private key that you need only to decrypt - * ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use - * the Decrypt operation to decrypt the encrypted private key in the data key - * pair.

- *

- * GenerateDataKeyPair returns a unique data key pair for each request. The - * bytes in the keys are random; they are not related to the caller or the KMS key that is used - * to encrypt the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as - * specified in RFC 5280. The private - * key is a DER-encoded PKCS8 PrivateKeyInfo, as specified in RFC 5958.

- *

You can use an optional encryption context to add additional security to the encryption - * operation. If you specify an EncryptionContext, you must specify the same - * encryption context (a case-sensitive exact match) when decrypting the encrypted data key. - * Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the - * Key Management Service Developer Guide.

- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify - * the key ARN or alias ARN in the value of the KeyId parameter.

- *

- * Required permissions: kms:GenerateDataKeyPair (key policy)

- *

- * Related operations: - *

- * + * @see {@link GenerateDataKeyPairCommand} */ - public generateDataKeyPair( + generateDataKeyPair( args: GenerateDataKeyPairCommandInput, options?: __HttpHandlerOptions ): Promise; - public generateDataKeyPair( + generateDataKeyPair( args: GenerateDataKeyPairCommandInput, cb: (err: any, data?: GenerateDataKeyPairCommandOutput) => void ): void; - public generateDataKeyPair( + generateDataKeyPair( args: GenerateDataKeyPairCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateDataKeyPairCommandOutput) => void ): void; - public generateDataKeyPair( - args: GenerateDataKeyPairCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GenerateDataKeyPairCommandOutput) => void), - cb?: (err: any, data?: GenerateDataKeyPairCommandOutput) => void - ): Promise | void { - const command = new GenerateDataKeyPairCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a unique asymmetric data key pair for use outside of KMS. This operation returns - * a plaintext public key and a copy of the private key that is encrypted under the symmetric - * encryption KMS key you specify. Unlike GenerateDataKeyPair, this operation - * does not return a plaintext private key. The bytes in the keys are random; they are not - * related to the caller or to the KMS key that is used to encrypt the private key.

- *

You can use the public key that GenerateDataKeyPairWithoutPlaintext returns - * to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key - * with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

- *

To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt - * the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a - * custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

- *

Use the KeyPairSpec parameter to choose an RSA or Elliptic Curve (ECC) data - * key pair. In China Regions, you can also choose an SM2 data key pair. KMS recommends that you - * use ECC key pairs for signing, and use RSA and SM2 key pairs for either encryption or signing, but not - * both. However, KMS cannot enforce any restrictions on the use of data key pairs outside of KMS.

- *

- * GenerateDataKeyPairWithoutPlaintext returns a unique data key pair for each - * request. The bytes in the key are not related to the caller or KMS key that is used to encrypt - * the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in - * RFC 5280.

- *

You can use an optional encryption context to add additional security to the encryption - * operation. If you specify an EncryptionContext, you must specify the same - * encryption context (a case-sensitive exact match) when decrypting the encrypted data key. - * Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the - * Key Management Service Developer Guide.

- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify - * the key ARN or alias ARN in the value of the KeyId parameter.

- *

- * Required permissions: kms:GenerateDataKeyPairWithoutPlaintext (key - * policy)

- *

- * Related operations: - *

- * + * @see {@link GenerateDataKeyPairWithoutPlaintextCommand} */ - public generateDataKeyPairWithoutPlaintext( + generateDataKeyPairWithoutPlaintext( args: GenerateDataKeyPairWithoutPlaintextCommandInput, options?: __HttpHandlerOptions ): Promise; - public generateDataKeyPairWithoutPlaintext( + generateDataKeyPairWithoutPlaintext( args: GenerateDataKeyPairWithoutPlaintextCommandInput, cb: (err: any, data?: GenerateDataKeyPairWithoutPlaintextCommandOutput) => void ): void; - public generateDataKeyPairWithoutPlaintext( + generateDataKeyPairWithoutPlaintext( args: GenerateDataKeyPairWithoutPlaintextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateDataKeyPairWithoutPlaintextCommandOutput) => void ): void; - public generateDataKeyPairWithoutPlaintext( - args: GenerateDataKeyPairWithoutPlaintextCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GenerateDataKeyPairWithoutPlaintextCommandOutput) => void), - cb?: (err: any, data?: GenerateDataKeyPairWithoutPlaintextCommandOutput) => void - ): Promise | void { - const command = new GenerateDataKeyPairWithoutPlaintextCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a unique symmetric data key for use outside of KMS. This operation returns a - * data key that is encrypted under a symmetric encryption KMS key that you specify. The bytes in - * the key are random; they are not related to the caller or to the KMS key.

- *

- * GenerateDataKeyWithoutPlaintext is identical to the GenerateDataKey operation except that it does not return a plaintext copy of the - * data key.

- *

This operation is useful for systems that need to encrypt data at some point, but not - * immediately. When you need to encrypt the data, you call the Decrypt - * operation on the encrypted copy of the key.

- *

It's also useful in distributed systems with different levels of trust. For example, you - * might store encrypted data in containers. One component of your system creates new containers - * and stores an encrypted data key with each container. Then, a different component puts the - * data into the containers. That component first decrypts the data key, uses the plaintext data - * key to encrypt data, puts the encrypted data into the container, and then destroys the - * plaintext data key. In this system, the component that creates the containers never sees the - * plaintext data key.

- *

To request an asymmetric data key pair, use the GenerateDataKeyPair or - * GenerateDataKeyPairWithoutPlaintext operations.

- *

To generate a data key, you must specify the symmetric encryption KMS key that is used to - * encrypt the data key. You cannot use an asymmetric KMS key or a key in a custom key store to generate a data key. To get the - * type of your KMS key, use the DescribeKey operation.

- *

You must also specify the length of the data key. Use either the KeySpec or - * NumberOfBytes parameters (but not both). For 128-bit and 256-bit data keys, use - * the KeySpec parameter.

- *

To generate an SM4 data key (China Regions only), specify a KeySpec value of - * AES_128 or NumberOfBytes value of 128. The symmetric - * encryption key used in China Regions to encrypt your data key is an SM4 encryption key.

- *

If the operation succeeds, you will find the encrypted copy of the data key in the - * CiphertextBlob field.

- *

You can use an optional encryption context to add additional security to the encryption - * operation. If you specify an EncryptionContext, you must specify the same - * encryption context (a case-sensitive exact match) when decrypting the encrypted data key. - * Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the - * Key Management Service Developer Guide.

- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify - * the key ARN or alias ARN in the value of the KeyId parameter.

- *

- * Required permissions: kms:GenerateDataKeyWithoutPlaintext (key - * policy)

- *

- * Related operations: - *

- * + * @see {@link GenerateDataKeyWithoutPlaintextCommand} */ - public generateDataKeyWithoutPlaintext( + generateDataKeyWithoutPlaintext( args: GenerateDataKeyWithoutPlaintextCommandInput, options?: __HttpHandlerOptions ): Promise; - public generateDataKeyWithoutPlaintext( + generateDataKeyWithoutPlaintext( args: GenerateDataKeyWithoutPlaintextCommandInput, cb: (err: any, data?: GenerateDataKeyWithoutPlaintextCommandOutput) => void ): void; - public generateDataKeyWithoutPlaintext( + generateDataKeyWithoutPlaintext( args: GenerateDataKeyWithoutPlaintextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateDataKeyWithoutPlaintextCommandOutput) => void ): void; - public generateDataKeyWithoutPlaintext( - args: GenerateDataKeyWithoutPlaintextCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GenerateDataKeyWithoutPlaintextCommandOutput) => void), - cb?: (err: any, data?: GenerateDataKeyWithoutPlaintextCommandOutput) => void - ): Promise | void { - const command = new GenerateDataKeyWithoutPlaintextCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS key and a MAC algorithm that the key supports. - * HMAC KMS keys and the HMAC algorithms that KMS uses conform to industry standards defined in RFC 2104.

- *

You can use value that GenerateMac returns in the VerifyMac operation to - * demonstrate that the original message has not changed. Also, because a secret key is used to - * create the hash, you can verify that the party that generated the hash has the required secret - * key. You can also use the raw result to implement HMAC-based algorithms such as key derivation - * functions. This operation is part of KMS support for HMAC KMS keys. For - * details, see HMAC keys in - * KMS in the - * Key Management Service Developer Guide - * .

- * - *

Best practices recommend that you limit the time during which any signing mechanism, - * including an HMAC, is effective. This deters an attack where the actor uses a signed message - * to establish validity repeatedly or long after the message is superseded. HMAC tags do not - * include a timestamp, but you can include a timestamp in the token or message to help you - * detect when its time to refresh the HMAC.

- *
- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify - * the key ARN or alias ARN in the value of the KeyId parameter.

- *

- * Required permissions: kms:GenerateMac (key policy)

- *

- * Related operations: VerifyMac - *

+ * @see {@link GenerateMacCommand} */ - public generateMac(args: GenerateMacCommandInput, options?: __HttpHandlerOptions): Promise; - public generateMac(args: GenerateMacCommandInput, cb: (err: any, data?: GenerateMacCommandOutput) => void): void; - public generateMac( + generateMac(args: GenerateMacCommandInput, options?: __HttpHandlerOptions): Promise; + generateMac(args: GenerateMacCommandInput, cb: (err: any, data?: GenerateMacCommandOutput) => void): void; + generateMac( args: GenerateMacCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateMacCommandOutput) => void ): void; - public generateMac( - args: GenerateMacCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GenerateMacCommandOutput) => void), - cb?: (err: any, data?: GenerateMacCommandOutput) => void - ): Promise | void { - const command = new GenerateMacCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a random byte string that is cryptographically secure.

- *

You must use the NumberOfBytes parameter to specify the length of the random - * byte string. There is no default value for string length.

- *

By default, the random byte string is generated in KMS. To generate the byte string in - * the CloudHSM cluster associated with an CloudHSM key store, use the CustomKeyStoreId - * parameter.

- *

Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.

- *

For more information about entropy and random number generation, see - * Key Management Service Cryptographic Details.

- *

- * Cross-account use: Not applicable. - * GenerateRandom does not use any account-specific resources, such as KMS - * keys.

- *

- * Required permissions: kms:GenerateRandom (IAM policy)

+ * @see {@link GenerateRandomCommand} */ - public generateRandom( + generateRandom( args: GenerateRandomCommandInput, options?: __HttpHandlerOptions ): Promise; - public generateRandom( - args: GenerateRandomCommandInput, - cb: (err: any, data?: GenerateRandomCommandOutput) => void - ): void; - public generateRandom( + generateRandom(args: GenerateRandomCommandInput, cb: (err: any, data?: GenerateRandomCommandOutput) => void): void; + generateRandom( args: GenerateRandomCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateRandomCommandOutput) => void ): void; - public generateRandom( - args: GenerateRandomCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GenerateRandomCommandOutput) => void), - cb?: (err: any, data?: GenerateRandomCommandOutput) => void - ): Promise | void { - const command = new GenerateRandomCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a key policy attached to the specified KMS key.

- *

- * Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

- *

- * Required permissions: kms:GetKeyPolicy (key policy)

- *

- * Related operations: PutKeyPolicy - *

+ * @see {@link GetKeyPolicyCommand} */ - public getKeyPolicy( - args: GetKeyPolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getKeyPolicy(args: GetKeyPolicyCommandInput, cb: (err: any, data?: GetKeyPolicyCommandOutput) => void): void; - public getKeyPolicy( + getKeyPolicy(args: GetKeyPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + getKeyPolicy(args: GetKeyPolicyCommandInput, cb: (err: any, data?: GetKeyPolicyCommandOutput) => void): void; + getKeyPolicy( args: GetKeyPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetKeyPolicyCommandOutput) => void ): void; - public getKeyPolicy( - args: GetKeyPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetKeyPolicyCommandOutput) => void), - cb?: (err: any, data?: GetKeyPolicyCommandOutput) => void - ): Promise | void { - const command = new GetKeyPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a Boolean value that indicates whether automatic rotation of the key material is - * enabled for the specified KMS key.

- *

When you enable automatic rotation for customer managed KMS keys, KMS - * rotates the key material of the KMS key one year (approximately 365 days) from the enable date - * and every year thereafter. You can monitor rotation of the key material for your KMS keys in - * CloudTrail and Amazon CloudWatch.

- *

Automatic key rotation is supported only on symmetric encryption KMS keys. - * You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key..

- *

You can enable (EnableKeyRotation) and disable automatic rotation (DisableKeyRotation) of the key material in customer managed KMS keys. Key - * material rotation of Amazon Web Services managed KMS keys is not - * configurable. KMS always rotates the key material in Amazon Web Services managed KMS keys every year. The - * key rotation status for Amazon Web Services managed KMS keys is always true.

- * - *

In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three - * years to every year. For details, see EnableKeyRotation.

- *
- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *
    - *
  • - *

    Disabled: The key rotation status does not change when you disable a KMS key. However, - * while the KMS key is disabled, KMS does not rotate the key material. When you re-enable - * the KMS key, rotation resumes. If the key material in the re-enabled KMS key hasn't been - * rotated in one year, KMS rotates it immediately, and every year thereafter. If it's been - * less than a year since the key material in the re-enabled KMS key was rotated, the KMS key - * resumes its prior rotation schedule.

    - *
  • - *
  • - *

    Pending deletion: While a KMS key is pending deletion, its key rotation status is - * false and KMS does not rotate the key material. If you cancel the - * deletion, the original key rotation status returns to true.

    - *
  • - *
- *

- * Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key - * ARN in the value of the KeyId parameter.

- *

- * Required permissions: kms:GetKeyRotationStatus (key policy)

- *

- * Related operations: - *

- * + * @see {@link GetKeyRotationStatusCommand} */ - public getKeyRotationStatus( + getKeyRotationStatus( args: GetKeyRotationStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getKeyRotationStatus( + getKeyRotationStatus( args: GetKeyRotationStatusCommandInput, cb: (err: any, data?: GetKeyRotationStatusCommandOutput) => void ): void; - public getKeyRotationStatus( + getKeyRotationStatus( args: GetKeyRotationStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetKeyRotationStatusCommandOutput) => void ): void; - public getKeyRotationStatus( - args: GetKeyRotationStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetKeyRotationStatusCommandOutput) => void), - cb?: (err: any, data?: GetKeyRotationStatusCommandOutput) => void - ): Promise | void { - const command = new GetKeyRotationStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the items you need to import key material into a symmetric encryption KMS key. For - * more information about importing key material into KMS, see Importing key material in the - * Key Management Service Developer Guide.

- *

This operation returns a public key and an import token. Use the public key to encrypt the - * symmetric key material. Store the import token to send with a subsequent ImportKeyMaterial request.

- *

You must specify the key ID of the symmetric encryption KMS key into which you will import - * key material. The KMS key Origin must be EXTERNAL. You must also - * specify the wrapping algorithm and type of wrapping key (public key) that you will use to - * encrypt the key material. You cannot perform this operation on an asymmetric KMS key, an HMAC KMS key, or on any KMS key in a different Amazon Web Services account.

- *

To import key material, you must use the public key and import token from the same - * response. These items are valid for 24 hours. The expiration date and time appear in the - * GetParametersForImport response. You cannot use an expired token in an ImportKeyMaterial request. If your key and token expire, send another - * GetParametersForImport request.

- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

- *

- * Required permissions: kms:GetParametersForImport (key policy)

- *

- * Related operations: - *

- * + * @see {@link GetParametersForImportCommand} */ - public getParametersForImport( + getParametersForImport( args: GetParametersForImportCommandInput, options?: __HttpHandlerOptions ): Promise; - public getParametersForImport( + getParametersForImport( args: GetParametersForImportCommandInput, cb: (err: any, data?: GetParametersForImportCommandOutput) => void ): void; - public getParametersForImport( + getParametersForImport( args: GetParametersForImportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetParametersForImportCommandOutput) => void ): void; - public getParametersForImport( - args: GetParametersForImportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetParametersForImportCommandOutput) => void), - cb?: (err: any, data?: GetParametersForImportCommandOutput) => void - ): Promise | void { - const command = new GetParametersForImportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the public key of an asymmetric KMS key. Unlike the private key of a asymmetric - * KMS key, which never leaves KMS unencrypted, callers with kms:GetPublicKey - * permission can download the public key of an asymmetric KMS key. You can share the public key - * to allow others to encrypt messages and verify signatures outside of KMS. - * For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

- *

You do not need to download the public key. Instead, you can use the public key within - * KMS by calling the Encrypt, ReEncrypt, or Verify operations with the identifier of an asymmetric KMS key. When you use the - * public key within KMS, you benefit from the authentication, authorization, and logging that - * are part of every KMS operation. You also reduce of risk of encrypting data that cannot be - * decrypted. These features are not effective outside of KMS.

- *

To help you use the public key safely outside of KMS, GetPublicKey returns - * important information about the public key in the response, including:

- *
    - *
  • - *

    - * KeySpec: The type of key material in the public key, such as - * RSA_4096 or ECC_NIST_P521.

    - *
  • - *
  • - *

    - * KeyUsage: Whether the key is used for encryption or signing.

    - *
  • - *
  • - *

    - * EncryptionAlgorithms or SigningAlgorithms: A list of the encryption algorithms or the signing - * algorithms for the key.

    - *
  • - *
- *

Although KMS cannot enforce these restrictions on external operations, it is crucial - * that you use this information to prevent the public key from being used improperly. For - * example, you can prevent a public signing key from being used encrypt data, or prevent a - * public key from being used with an encryption algorithm that is not supported by KMS. You - * can also avoid errors, such as using the wrong signing algorithm in a verification - * operation.

- *

To verify a signature outside of KMS with an SM2 public key (China Regions only), you must - * specify the distinguishing ID. By default, KMS uses 1234567812345678 as the - * distinguishing ID. For more information, see Offline verification - * with SM2 key pairs.

- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: - * Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify - * the key ARN or alias ARN in the value of the KeyId parameter.

- *

- * Required permissions: kms:GetPublicKey (key policy)

- *

- * Related operations: CreateKey - *

+ * @see {@link GetPublicKeyCommand} */ - public getPublicKey( - args: GetPublicKeyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getPublicKey(args: GetPublicKeyCommandInput, cb: (err: any, data?: GetPublicKeyCommandOutput) => void): void; - public getPublicKey( + getPublicKey(args: GetPublicKeyCommandInput, options?: __HttpHandlerOptions): Promise; + getPublicKey(args: GetPublicKeyCommandInput, cb: (err: any, data?: GetPublicKeyCommandOutput) => void): void; + getPublicKey( args: GetPublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPublicKeyCommandOutput) => void ): void; - public getPublicKey( - args: GetPublicKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPublicKeyCommandOutput) => void), - cb?: (err: any, data?: GetPublicKeyCommandOutput) => void - ): Promise | void { - const command = new GetPublicKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Imports key material into an existing symmetric encryption KMS key that was created - * without key material. After you successfully import key material into a KMS key, you can - * reimport the same key material into that KMS key, but you cannot import different - * key material.

- *

You cannot perform this operation on an asymmetric KMS key, an HMAC KMS key, or on any KMS key in a different Amazon Web Services account. For more information about creating KMS keys with no key material - * and then importing key material, see Importing Key Material in the - * Key Management Service Developer Guide.

- *

Before using this operation, call GetParametersForImport. Its response - * includes a public key and an import token. Use the public key to encrypt the key material. - * Then, submit the import token from the same GetParametersForImport - * response.

- *

When calling this operation, you must specify the following values:

- *
    - *
  • - *

    The key ID or key ARN of a KMS key with no key material. Its Origin must - * be EXTERNAL.

    - *

    To create a KMS key with no key material, call CreateKey and set the - * value of its Origin parameter to EXTERNAL. To get the - * Origin of a KMS key, call DescribeKey.)

    - *
  • - *
  • - *

    The encrypted key material. To get the public key to encrypt the key material, call - * GetParametersForImport.

    - *
  • - *
  • - *

    The import token that GetParametersForImport returned. You must use - * a public key and token from the same GetParametersForImport response.

    - *
  • - *
  • - *

    Whether the key material expires (ExpirationModel) and, if so, when - * (ValidTo). If you set an expiration date, on the specified date, KMS - * deletes the key material from the KMS key, making the KMS key unusable. To use the KMS key - * in cryptographic operations again, you must reimport the same key material. The only way - * to change the expiration model or expiration date is by reimporting the same key material - * and specifying a new expiration date.

    - *
  • - *
- *

When this operation is successful, the key state of the KMS key changes from - * PendingImport to Enabled, and you can use the KMS key.

- *

If this operation fails, use the exception to help determine the problem. If the error is - * related to the key material, the import token, or wrapping key, use GetParametersForImport to get a new public key and import token for the KMS key - * and repeat the import procedure. For help, see How To Import Key - * Material in the Key Management Service Developer Guide.

- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

- *

- * Required permissions: kms:ImportKeyMaterial (key policy)

- *

- * Related operations: - *

- * + * @see {@link ImportKeyMaterialCommand} */ - public importKeyMaterial( + importKeyMaterial( args: ImportKeyMaterialCommandInput, options?: __HttpHandlerOptions ): Promise; - public importKeyMaterial( + importKeyMaterial( args: ImportKeyMaterialCommandInput, cb: (err: any, data?: ImportKeyMaterialCommandOutput) => void ): void; - public importKeyMaterial( + importKeyMaterial( args: ImportKeyMaterialCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportKeyMaterialCommandOutput) => void ): void; - public importKeyMaterial( - args: ImportKeyMaterialCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportKeyMaterialCommandOutput) => void), - cb?: (err: any, data?: ImportKeyMaterialCommandOutput) => void - ): Promise | void { - const command = new ImportKeyMaterialCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of aliases in the caller's Amazon Web Services account and region. For more information - * about aliases, see CreateAlias.

- *

By default, the ListAliases operation returns all aliases in the account and - * region. To get only the aliases associated with a particular KMS key, use the - * KeyId parameter.

- *

The ListAliases response can include aliases that you created and associated - * with your customer managed keys, and aliases that Amazon Web Services created and associated with Amazon Web Services - * managed keys in your account. You can recognize Amazon Web Services aliases because their names have the - * format aws/, such as aws/dynamodb.

- *

The response might also include aliases that have no TargetKeyId field. These - * are predefined aliases that Amazon Web Services has created but has not yet associated with a KMS key. - * Aliases that Amazon Web Services creates in your account, including predefined aliases, do not count against - * your KMS aliases - * quota.

- *

- * Cross-account use: No. ListAliases does not - * return aliases in other Amazon Web Services accounts.

- *

- * Required permissions: kms:ListAliases (IAM policy)

- *

For details, see Controlling access to aliases in the - * Key Management Service Developer Guide.

- *

- * Related operations: - *

- * + * @see {@link ListAliasesCommand} */ - public listAliases(args: ListAliasesCommandInput, options?: __HttpHandlerOptions): Promise; - public listAliases(args: ListAliasesCommandInput, cb: (err: any, data?: ListAliasesCommandOutput) => void): void; - public listAliases( + listAliases(args: ListAliasesCommandInput, options?: __HttpHandlerOptions): Promise; + listAliases(args: ListAliasesCommandInput, cb: (err: any, data?: ListAliasesCommandOutput) => void): void; + listAliases( args: ListAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAliasesCommandOutput) => void ): void; - public listAliases( - args: ListAliasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAliasesCommandOutput) => void), - cb?: (err: any, data?: ListAliasesCommandOutput) => void - ): Promise | void { - const command = new ListAliasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of all grants for the specified KMS key.

- *

You must specify the KMS key in all requests. You can filter the grant list by grant ID or - * grantee principal.

- *

For detailed information about grants, including grant terminology, see Grants in KMS in the - * - * Key Management Service Developer Guide - * . For examples of working with grants in several - * programming languages, see Programming grants.

- * - *

The GranteePrincipal field in the ListGrants response usually contains the - * user or role designated as the grantee principal in the grant. However, when the grantee - * principal in the grant is an Amazon Web Services service, the GranteePrincipal field contains - * the service - * principal, which might represent several different grantee principals.

- *
- *

- * Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key - * ARN in the value of the KeyId parameter.

- *

- * Required permissions: kms:ListGrants (key policy)

- *

- * Related operations: - *

- * + * @see {@link ListGrantsCommand} */ - public listGrants(args: ListGrantsCommandInput, options?: __HttpHandlerOptions): Promise; - public listGrants(args: ListGrantsCommandInput, cb: (err: any, data?: ListGrantsCommandOutput) => void): void; - public listGrants( + listGrants(args: ListGrantsCommandInput, options?: __HttpHandlerOptions): Promise; + listGrants(args: ListGrantsCommandInput, cb: (err: any, data?: ListGrantsCommandOutput) => void): void; + listGrants( args: ListGrantsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGrantsCommandOutput) => void ): void; - public listGrants( - args: ListGrantsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGrantsCommandOutput) => void), - cb?: (err: any, data?: ListGrantsCommandOutput) => void - ): Promise | void { - const command = new ListGrantsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the names of the key policies that are attached to a KMS key. This operation is - * designed to get policy names that you can use in a GetKeyPolicy operation. - * However, the only valid policy name is default.

- *

- * Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

- *

- * Required permissions: kms:ListKeyPolicies (key policy)

- *

- * Related operations: - *

- * + * @see {@link ListKeyPoliciesCommand} */ - public listKeyPolicies( + listKeyPolicies( args: ListKeyPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listKeyPolicies( - args: ListKeyPoliciesCommandInput, - cb: (err: any, data?: ListKeyPoliciesCommandOutput) => void - ): void; - public listKeyPolicies( + listKeyPolicies(args: ListKeyPoliciesCommandInput, cb: (err: any, data?: ListKeyPoliciesCommandOutput) => void): void; + listKeyPolicies( args: ListKeyPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKeyPoliciesCommandOutput) => void ): void; - public listKeyPolicies( - args: ListKeyPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListKeyPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListKeyPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListKeyPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of all KMS keys in the caller's Amazon Web Services account and Region.

- *

- * Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

- *

- * Required permissions: kms:ListKeys (IAM policy)

- *

- * Related operations: - *

- * + * @see {@link ListKeysCommand} */ - public listKeys(args: ListKeysCommandInput, options?: __HttpHandlerOptions): Promise; - public listKeys(args: ListKeysCommandInput, cb: (err: any, data?: ListKeysCommandOutput) => void): void; - public listKeys( + listKeys(args: ListKeysCommandInput, options?: __HttpHandlerOptions): Promise; + listKeys(args: ListKeysCommandInput, cb: (err: any, data?: ListKeysCommandOutput) => void): void; + listKeys( args: ListKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKeysCommandOutput) => void ): void; - public listKeys( - args: ListKeysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListKeysCommandOutput) => void), - cb?: (err: any, data?: ListKeysCommandOutput) => void - ): Promise | void { - const command = new ListKeysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns all tags on the specified KMS key.

- *

For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources in - * the Amazon Web Services General Reference. For information about using - * tags in KMS, see Tagging - * keys.

- *

- * Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

- *

- * Required permissions: kms:ListResourceTags (key policy)

- *

- * Related operations: - *

- * + * @see {@link ListResourceTagsCommand} */ - public listResourceTags( + listResourceTags( args: ListResourceTagsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourceTags( + listResourceTags( args: ListResourceTagsCommandInput, cb: (err: any, data?: ListResourceTagsCommandOutput) => void ): void; - public listResourceTags( + listResourceTags( args: ListResourceTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceTagsCommandOutput) => void ): void; - public listResourceTags( - args: ListResourceTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourceTagsCommandOutput) => void), - cb?: (err: any, data?: ListResourceTagsCommandOutput) => void - ): Promise | void { - const command = new ListResourceTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about all grants in the Amazon Web Services account and Region that have the - * specified retiring principal.

- *

You can specify any principal in your Amazon Web Services account. The grants that are returned include - * grants for KMS keys in your Amazon Web Services account and other Amazon Web Services accounts. You might use this - * operation to determine which grants you may retire. To retire a grant, use the RetireGrant operation.

- *

For detailed information about grants, including grant terminology, see Grants in KMS in the - * - * Key Management Service Developer Guide - * . For examples of working with grants in several - * programming languages, see Programming grants.

- *

- * Cross-account use: You must specify a principal in your - * Amazon Web Services account. However, this operation can return grants in any Amazon Web Services account. You do not need - * kms:ListRetirableGrants permission (or any other additional permission) in any - * Amazon Web Services account other than your own.

- *

- * Required permissions: kms:ListRetirableGrants (IAM policy) in your - * Amazon Web Services account.

- *

- * Related operations: - *

- * + * @see {@link ListRetirableGrantsCommand} */ - public listRetirableGrants( + listRetirableGrants( args: ListRetirableGrantsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRetirableGrants( + listRetirableGrants( args: ListRetirableGrantsCommandInput, cb: (err: any, data?: ListRetirableGrantsCommandOutput) => void ): void; - public listRetirableGrants( + listRetirableGrants( args: ListRetirableGrantsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRetirableGrantsCommandOutput) => void ): void; - public listRetirableGrants( - args: ListRetirableGrantsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRetirableGrantsCommandOutput) => void), - cb?: (err: any, data?: ListRetirableGrantsCommandOutput) => void - ): Promise | void { - const command = new ListRetirableGrantsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Attaches a key policy to the specified KMS key.

- *

For more information about key policies, see Key Policies in the Key Management Service Developer Guide. - * For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the - * Identity and Access Management User Guide - * . For examples of adding a key policy in multiple programming languages, - * see Setting a key policy in the Key Management Service Developer Guide.

- *

- * Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

- *

- * Required permissions: kms:PutKeyPolicy (key policy)

- *

- * Related operations: GetKeyPolicy - *

+ * @see {@link PutKeyPolicyCommand} */ - public putKeyPolicy( - args: PutKeyPolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putKeyPolicy(args: PutKeyPolicyCommandInput, cb: (err: any, data?: PutKeyPolicyCommandOutput) => void): void; - public putKeyPolicy( + putKeyPolicy(args: PutKeyPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + putKeyPolicy(args: PutKeyPolicyCommandInput, cb: (err: any, data?: PutKeyPolicyCommandOutput) => void): void; + putKeyPolicy( args: PutKeyPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutKeyPolicyCommandOutput) => void ): void; - public putKeyPolicy( - args: PutKeyPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutKeyPolicyCommandOutput) => void), - cb?: (err: any, data?: PutKeyPolicyCommandOutput) => void - ): Promise | void { - const command = new PutKeyPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Decrypts ciphertext and then reencrypts it entirely within KMS. You can use this - * operation to change the KMS key under which data is encrypted, such as when you manually - * rotate a KMS key or change the KMS key that protects a ciphertext. You can also use - * it to reencrypt ciphertext under the same KMS key, such as to change the encryption - * context of a ciphertext.

- *

The ReEncrypt operation can decrypt ciphertext that was encrypted by using a - * KMS key in an KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the - * public key of an asymmetric KMS key - * outside of KMS. However, it cannot decrypt ciphertext produced by other libraries, such as - * the Amazon Web Services Encryption SDK or - * Amazon S3 - * client-side encryption. These libraries return a ciphertext format that is - * incompatible with KMS.

- *

When you use the ReEncrypt operation, you need to provide information for the - * decrypt operation and the subsequent encrypt operation.

- *
    - *
  • - *

    If your ciphertext was encrypted under an asymmetric KMS key, you must use the - * SourceKeyId parameter to identify the KMS key that encrypted the - * ciphertext. You must also supply the encryption algorithm that was used. This information - * is required to decrypt the data.

    - *
  • - *
  • - *

    If your ciphertext was encrypted under a symmetric encryption KMS key, the - * SourceKeyId parameter is optional. KMS can get this information from - * metadata that it adds to the symmetric ciphertext blob. This feature adds durability to - * your implementation by ensuring that authorized users can decrypt ciphertext decades after - * it was encrypted, even if they've lost track of the key ID. However, specifying the source - * KMS key is always recommended as a best practice. When you use the - * SourceKeyId parameter to specify a KMS key, KMS uses only the KMS key you - * specify. If the ciphertext was encrypted under a different KMS key, the - * ReEncrypt operation fails. This practice ensures that you use the KMS key - * that you intend.

    - *
  • - *
  • - *

    To reencrypt the data, you must use the DestinationKeyId parameter to - * specify the KMS key that re-encrypts the data after it is decrypted. If the destination - * KMS key is an asymmetric KMS key, you must also provide the encryption algorithm. The - * algorithm that you choose must be compatible with the KMS key.

    - * - *

    When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.

    - *

    You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric encryption KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.

    - *
    - *
  • - *
- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: Yes. The source KMS key and - * destination KMS key can be in different Amazon Web Services accounts. Either or both KMS keys can be in a - * different account than the caller. To specify a KMS key in a different account, you must use - * its key ARN or alias ARN.

- *

- * Required permissions:

- *
    - *
  • - *

    - * kms:ReEncryptFrom - * permission on the source KMS key (key policy)

    - *
  • - *
  • - *

    - * kms:ReEncryptTo - * permission on the destination KMS key (key policy)

    - *
  • - *
- *

To permit reencryption from or to a KMS key, include the "kms:ReEncrypt*" - * permission in your key policy. This permission is - * automatically included in the key policy when you use the console to create a KMS key. But you - * must include it manually when you create a KMS key programmatically or when you use the PutKeyPolicy operation to set a key policy.

- *

- * Related operations: - *

- * + * @see {@link ReEncryptCommand} */ - public reEncrypt(args: ReEncryptCommandInput, options?: __HttpHandlerOptions): Promise; - public reEncrypt(args: ReEncryptCommandInput, cb: (err: any, data?: ReEncryptCommandOutput) => void): void; - public reEncrypt( + reEncrypt(args: ReEncryptCommandInput, options?: __HttpHandlerOptions): Promise; + reEncrypt(args: ReEncryptCommandInput, cb: (err: any, data?: ReEncryptCommandOutput) => void): void; + reEncrypt( args: ReEncryptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReEncryptCommandOutput) => void ): void; - public reEncrypt( - args: ReEncryptCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReEncryptCommandOutput) => void), - cb?: (err: any, data?: ReEncryptCommandOutput) => void - ): Promise | void { - const command = new ReEncryptCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Replicates a multi-Region key into the specified Region. This operation creates a - * multi-Region replica key based on a multi-Region primary key in a different Region of the same - * Amazon Web Services partition. You can create multiple replicas of a primary key, but each must be in a - * different Region. To create a multi-Region primary key, use the CreateKey - * operation.

- *

This operation supports multi-Region keys, an KMS feature that lets you create multiple - * interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key - * material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt - * it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

- *

A replica key is a fully-functional KMS key that can be used - * independently of its primary and peer replica keys. A primary key and its replica keys share - * properties that make them interoperable. They have the same key ID and key material. They also - * have the same key - * spec, key - * usage, key - * material origin, and automatic key rotation status. KMS automatically synchronizes these shared - * properties among related multi-Region keys. All other properties of a replica key can differ, - * including its key - * policy, tags, aliases, and Key states of KMS keys. KMS pricing and quotas for KMS keys apply to each - * primary key and replica key.

- *

When this operation completes, the new replica key has a transient key state of - * Creating. This key state changes to Enabled (or - * PendingImport) after a few seconds when the process of creating the new replica - * key is complete. While the key state is Creating, you can manage key, but you - * cannot yet use it in cryptographic operations. If you are creating and using the replica key - * programmatically, retry on KMSInvalidStateException or call - * DescribeKey to check its KeyState value before using it. For - * details about the Creating key state, see Key states of KMS keys in the - * Key Management Service Developer Guide.

- *

You cannot create more than one replica of a primary key in any Region. If the Region - * already includes a replica of the key you're trying to replicate, ReplicateKey - * returns an AlreadyExistsException error. If the key state of the existing replica - * is PendingDeletion, you can cancel the scheduled key deletion (CancelKeyDeletion) or wait for the key to be deleted. The new replica key you - * create will have the same shared - * properties as the original replica key.

- *

The CloudTrail log of a ReplicateKey operation records a - * ReplicateKey operation in the primary key's Region and a CreateKey operation in the replica key's Region.

- *

If you replicate a multi-Region primary key with imported key material, the replica key is - * created with no key material. You must import the same key material that you imported into the - * primary key. For details, see Importing key material into multi-Region keys in the Key Management Service Developer Guide.

- *

To convert a replica key to a primary key, use the UpdatePrimaryRegion - * operation.

- * - *

- * ReplicateKey uses different default values for the KeyPolicy - * and Tags parameters than those used in the KMS console. For details, see the - * parameter descriptions.

- *
- *

- * Cross-account use: No. You cannot use this operation to - * create a replica key in a different Amazon Web Services account.

- *

- * Required permissions:

- *
    - *
  • - *

    - * kms:ReplicateKey on the primary key (in the primary key's Region). - * Include this permission in the primary key's key policy.

    - *
  • - *
  • - *

    - * kms:CreateKey in an IAM policy in the replica Region.

    - *
  • - *
  • - *

    To use the Tags parameter, kms:TagResource in an IAM policy - * in the replica Region.

    - *
  • - *
- *

- * Related operations - *

- * + * @see {@link ReplicateKeyCommand} */ - public replicateKey( - args: ReplicateKeyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public replicateKey(args: ReplicateKeyCommandInput, cb: (err: any, data?: ReplicateKeyCommandOutput) => void): void; - public replicateKey( + replicateKey(args: ReplicateKeyCommandInput, options?: __HttpHandlerOptions): Promise; + replicateKey(args: ReplicateKeyCommandInput, cb: (err: any, data?: ReplicateKeyCommandOutput) => void): void; + replicateKey( args: ReplicateKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReplicateKeyCommandOutput) => void ): void; - public replicateKey( - args: ReplicateKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReplicateKeyCommandOutput) => void), - cb?: (err: any, data?: ReplicateKeyCommandOutput) => void - ): Promise | void { - const command = new ReplicateKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a grant. Typically, you retire a grant when you no longer need its permissions. To - * identify the grant to retire, use a grant token, or both the grant ID and a - * key identifier (key ID or key ARN) of the KMS key. The CreateGrant operation - * returns both values.

- *

This operation can be called by the retiring principal for a grant, - * by the grantee principal if the grant allows the RetireGrant - * operation, and by the Amazon Web Services account in which the grant is created. It can also be called by - * principals to whom permission for retiring a grant is delegated. For details, see Retiring and revoking - * grants in the Key Management Service Developer Guide.

- *

For detailed information about grants, including grant terminology, see Grants in KMS in the - * - * Key Management Service Developer Guide - * . For examples of working with grants in several - * programming languages, see Programming grants.

- *

- * Cross-account use: Yes. You can retire a grant on a KMS - * key in a different Amazon Web Services account.

- *

- * Required permissions::Permission to retire a grant is - * determined primarily by the grant. For details, see Retiring and revoking grants in - * the Key Management Service Developer Guide.

- *

- * Related operations: - *

- * + * @see {@link RetireGrantCommand} */ - public retireGrant(args: RetireGrantCommandInput, options?: __HttpHandlerOptions): Promise; - public retireGrant(args: RetireGrantCommandInput, cb: (err: any, data?: RetireGrantCommandOutput) => void): void; - public retireGrant( + retireGrant(args: RetireGrantCommandInput, options?: __HttpHandlerOptions): Promise; + retireGrant(args: RetireGrantCommandInput, cb: (err: any, data?: RetireGrantCommandOutput) => void): void; + retireGrant( args: RetireGrantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RetireGrantCommandOutput) => void ): void; - public retireGrant( - args: RetireGrantCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RetireGrantCommandOutput) => void), - cb?: (err: any, data?: RetireGrantCommandOutput) => void - ): Promise | void { - const command = new RetireGrantCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified grant. You revoke a grant to terminate the permissions that the - * grant allows. For more information, see Retiring and revoking grants in - * the - * Key Management Service Developer Guide - * .

- *

When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as eventual consistency. For details, see Eventual consistency in - * the - * Key Management Service Developer Guide - * .

- *

For detailed information about grants, including grant terminology, see Grants in KMS in the - * - * Key Management Service Developer Guide - * . For examples of working with grants in several - * programming languages, see Programming grants.

- *

- * Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key - * ARN in the value of the KeyId parameter.

- *

- * Required permissions: kms:RevokeGrant (key policy).

- *

- * Related operations: - *

- * + * @see {@link RevokeGrantCommand} */ - public revokeGrant(args: RevokeGrantCommandInput, options?: __HttpHandlerOptions): Promise; - public revokeGrant(args: RevokeGrantCommandInput, cb: (err: any, data?: RevokeGrantCommandOutput) => void): void; - public revokeGrant( + revokeGrant(args: RevokeGrantCommandInput, options?: __HttpHandlerOptions): Promise; + revokeGrant(args: RevokeGrantCommandInput, cb: (err: any, data?: RevokeGrantCommandOutput) => void): void; + revokeGrant( args: RevokeGrantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeGrantCommandOutput) => void ): void; - public revokeGrant( - args: RevokeGrantCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RevokeGrantCommandOutput) => void), - cb?: (err: any, data?: RevokeGrantCommandOutput) => void - ): Promise | void { - const command = new RevokeGrantCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30 - * days, but you can specify a waiting period of 7-30 days. When this operation is successful, - * the key state of the KMS key changes to PendingDeletion and the key can't be used - * in any cryptographic operations. It remains in this state for the duration of the waiting - * period. Before the waiting period ends, you can use CancelKeyDeletion to - * cancel the deletion of the KMS key. After the waiting period ends, KMS deletes the KMS key, - * its key material, and all KMS data associated with it, including all aliases that refer to - * it.

- * - *

Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key - * is deleted, all data that was encrypted under the KMS key is unrecoverable. (The only - * exception is a multi-Region replica key.) To prevent the use of a KMS key without deleting - * it, use DisableKey.

- *
- *

You can schedule the deletion of a multi-Region primary key and its replica keys at any - * time. However, KMS will not delete a multi-Region primary key with existing replica keys. If - * you schedule the deletion of a primary key with replicas, its key state changes to - * PendingReplicaDeletion and it cannot be replicated or used in cryptographic - * operations. This status can continue indefinitely. When the last of its replicas keys is - * deleted (not just scheduled), the key state of the primary key changes to - * PendingDeletion and its waiting period (PendingWindowInDays) - * begins. For details, see Deleting multi-Region keys in the - * Key Management Service Developer Guide.

- *

When KMS deletes - * a KMS key from an CloudHSM key store, it makes a best effort to delete the associated - * key material from the associated CloudHSM cluster. However, you might need to manually delete - * the orphaned key material from the cluster and its backups. Deleting a KMS key from an - * external key store has no effect on the associated external key. However, for both - * types of custom key stores, deleting a KMS key is destructive and irreversible. You cannot - * decrypt ciphertext encrypted under the KMS key by using only its associated external key or - * CloudHSM key. Also, you cannot recreate a KMS key in an external key store by creating a new KMS - * key with the same key material.

- *

For more information about scheduling a KMS key for deletion, see Deleting KMS keys in the - * Key Management Service Developer Guide.

- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

- *

- * Required permissions: kms:ScheduleKeyDeletion (key - * policy)

- *

- * Related operations - *

- * + * @see {@link ScheduleKeyDeletionCommand} */ - public scheduleKeyDeletion( + scheduleKeyDeletion( args: ScheduleKeyDeletionCommandInput, options?: __HttpHandlerOptions ): Promise; - public scheduleKeyDeletion( + scheduleKeyDeletion( args: ScheduleKeyDeletionCommandInput, cb: (err: any, data?: ScheduleKeyDeletionCommandOutput) => void ): void; - public scheduleKeyDeletion( + scheduleKeyDeletion( args: ScheduleKeyDeletionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ScheduleKeyDeletionCommandOutput) => void ): void; - public scheduleKeyDeletion( - args: ScheduleKeyDeletionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ScheduleKeyDeletionCommandOutput) => void), - cb?: (err: any, data?: ScheduleKeyDeletionCommandOutput) => void - ): Promise | void { - const command = new ScheduleKeyDeletionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a digital - * signature for a message or message digest by using the private key in an asymmetric - * signing KMS key. To verify the signature, use the Verify operation, or use - * the public key in the same asymmetric KMS key outside of KMS. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

- *

Digital signatures are generated and verified by using asymmetric key pair, such as an RSA - * or ECC pair that is represented by an asymmetric KMS key. The key owner (or an authorized - * user) uses their private key to sign a message. Anyone with the public key can verify that the - * message was signed with that particular private key and that the message hasn't changed since - * it was signed.

- *

To use the Sign operation, provide the following information:

- *
    - *
  • - *

    Use the KeyId parameter to identify an asymmetric KMS key with a - * KeyUsage value of SIGN_VERIFY. To get the - * KeyUsage value of a KMS key, use the DescribeKey - * operation. The caller must have kms:Sign permission on the KMS key.

    - *
  • - *
  • - *

    Use the Message parameter to specify the message or message digest to - * sign. You can submit messages of up to 4096 bytes. To sign a larger message, generate a - * hash digest of the message, and then provide the hash digest in the Message - * parameter. To indicate whether the message is a full message or a digest, use the - * MessageType parameter.

    - *
  • - *
  • - *

    Choose a signing algorithm that is compatible with the KMS key.

    - *
  • - *
- * - *

When signing a message, be sure to record the KMS key and the signing algorithm. This - * information is required to verify the signature.

- *
- * - *

Best practices recommend that you limit the time during which any signature is - * effective. This deters an attack where the actor uses a signed message to establish validity - * repeatedly or long after the message is superseded. Signatures do not include a timestamp, - * but you can include a timestamp in the signed message to help you detect when its time to - * refresh the signature.

- *
- *

To verify the signature that this operation generates, use the Verify - * operation. Or use the GetPublicKey operation to download the public key and - * then use the public key to verify the signature outside of KMS.

- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify - * the key ARN or alias ARN in the value of the KeyId parameter.

- *

- * Required permissions: kms:Sign (key policy)

- *

- * Related operations: Verify - *

+ * @see {@link SignCommand} */ - public sign(args: SignCommandInput, options?: __HttpHandlerOptions): Promise; - public sign(args: SignCommandInput, cb: (err: any, data?: SignCommandOutput) => void): void; - public sign( - args: SignCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: SignCommandOutput) => void - ): void; - public sign( - args: SignCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SignCommandOutput) => void), - cb?: (err: any, data?: SignCommandOutput) => void - ): Promise | void { - const command = new SignCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } + sign(args: SignCommandInput, options?: __HttpHandlerOptions): Promise; + sign(args: SignCommandInput, cb: (err: any, data?: SignCommandOutput) => void): void; + sign(args: SignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SignCommandOutput) => void): void; /** - * @public - *

Adds or edits tags on a customer managed key.

- * - *

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

- *
- *

Each tag consists of a tag key and a tag value, both of which are case-sensitive strings. - * The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag - * value. To edit a tag, specify an existing tag key and a new tag value.

- *

You can use this operation to tag a customer managed key, but you cannot - * tag an Amazon Web Services - * managed key, an Amazon Web Services owned key, a custom key - * store, or an alias.

- *

You can also add tags to a KMS key while creating it (CreateKey) or - * replicating it (ReplicateKey).

- *

For information about using tags in KMS, see Tagging keys. For general information about - * tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon - * Web Services General Reference.

- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

- *

- * Required permissions: kms:TagResource (key policy)

- *

- * Related operations - *

- * + * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes tags from a customer managed key. To delete a tag, - * specify the tag key and the KMS key.

- * - *

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

- *
- *

When it succeeds, the UntagResource operation doesn't return any output. - * Also, if the specified tag key isn't found on the KMS key, it doesn't throw an exception or - * return a response. To confirm that the operation worked, use the ListResourceTags operation.

- *

For information about using tags in KMS, see Tagging keys. For general information about - * tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon - * Web Services General Reference.

- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

- *

- * Required permissions: kms:UntagResource (key policy)

- *

- * Related operations - *

- * + * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates an existing KMS alias with a different KMS key. Each alias is associated with - * only one KMS key at a time, although a KMS key can have multiple aliases. The alias and the - * KMS key must be in the same Amazon Web Services account and Region.

- * - *

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

- *
- *

The current and new KMS key must be the same type (both symmetric or both asymmetric or - * both HMAC), and they must have the same key usage. This restriction prevents errors in code - * that uses aliases. If you must assign an alias to a different type of KMS key, use DeleteAlias to delete the old alias and CreateAlias to create - * a new alias.

- *

You cannot use UpdateAlias to change an alias name. To change an alias name, - * use DeleteAlias to delete the old alias and CreateAlias to - * create a new alias.

- *

Because an alias is not a property of a KMS key, you can create, update, and delete the - * aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the - * response from the DescribeKey operation. To get the aliases of all KMS keys - * in the account, use the ListAliases operation.

- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

- *

- * Required permissions - *

- * - *

For details, see Controlling access to aliases in the - * Key Management Service Developer Guide.

- *

- * Related operations: - *

- * + * @see {@link UpdateAliasCommand} */ - public updateAlias(args: UpdateAliasCommandInput, options?: __HttpHandlerOptions): Promise; - public updateAlias(args: UpdateAliasCommandInput, cb: (err: any, data?: UpdateAliasCommandOutput) => void): void; - public updateAlias( + updateAlias(args: UpdateAliasCommandInput, options?: __HttpHandlerOptions): Promise; + updateAlias(args: UpdateAliasCommandInput, cb: (err: any, data?: UpdateAliasCommandOutput) => void): void; + updateAlias( args: UpdateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAliasCommandOutput) => void ): void; - public updateAlias( - args: UpdateAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAliasCommandOutput) => void), - cb?: (err: any, data?: UpdateAliasCommandOutput) => void - ): Promise | void { - const command = new UpdateAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes the properties of a custom key store. You can use this operation to change the - * properties of an CloudHSM key store or an external key store.

- *

Use the required CustomKeyStoreId parameter to identify the custom key store. - * Use the remaining optional parameters to change its properties. This operation does not return - * any property values. To verify the updated property values, use the DescribeCustomKeyStores operation.

- *

This operation is part of the custom key stores feature in KMS, which - * combines the convenience and extensive integration of KMS with the isolation and control of a - * key store that you own and manage.

- * - *

When updating the properties of an external key store, verify that the updated settings - * connect your key store, via the external key store proxy, to the same external key manager - * as the previous settings, or to a backup or snapshot of the external key manager with the - * same cryptographic keys. If the updated connection settings fail, you can fix them and - * retry, although an extended delay might disrupt Amazon Web Services services. However, if KMS - * permanently loses its access to cryptographic keys, ciphertext encrypted under those keys is - * unrecoverable.

- *
- * - *

For external key stores:

- *

Some external key managers provide a simpler method for updating an external key store. - * For details, see your external key manager documentation.

- *

When updating an external key store in the KMS console, you can upload a JSON-based - * proxy configuration file with the desired values. You cannot upload the proxy configuration - * file to the UpdateCustomKeyStore operation. However, you can use the file to - * help you determine the correct values for the UpdateCustomKeyStore - * parameters.

- *
- *

For an CloudHSM key store, you can use this operation to change the custom key store friendly - * name (NewCustomKeyStoreName), to tell KMS about a change to the - * kmsuser crypto user password (KeyStorePassword), or to associate - * the custom key store with a different, but related, CloudHSM cluster - * (CloudHsmClusterId). To update any property of an CloudHSM key store, the - * ConnectionState of the CloudHSM key store must be DISCONNECTED.

- *

For an external key store, you can use this operation to change the custom key store - * friendly name (NewCustomKeyStoreName), or to tell KMS about a change to the - * external key store proxy authentication credentials - * (XksProxyAuthenticationCredential), connection method - * (XksProxyConnectivity), external proxy endpoint - * (XksProxyUriEndpoint) and path (XksProxyUriPath). For external key - * stores with an XksProxyConnectivity of VPC_ENDPOINT_SERVICE, you can - * also update the Amazon VPC endpoint service name (XksProxyVpcEndpointServiceName). To - * update most properties of an external key store, the ConnectionState of the - * external key store must be DISCONNECTED. However, you can update the - * CustomKeyStoreName, XksProxyAuthenticationCredential, and - * XksProxyUriPath of an external key store when it is in the CONNECTED or - * DISCONNECTED state.

- *

If your update requires a DISCONNECTED state, before using - * UpdateCustomKeyStore, use the DisconnectCustomKeyStore - * operation to disconnect the custom key store. After the UpdateCustomKeyStore - * operation completes, use the ConnectCustomKeyStore to reconnect the custom - * key store. To find the ConnectionState of the custom key store, use the DescribeCustomKeyStores operation.

- *

- *

- *

Before updating the custom key store, verify that the new values allow KMS to connect - * the custom key store to its backing key store. For example, before you change the - * XksProxyUriPath value, verify that the external key store proxy is reachable at - * the new path.

- *

If the operation succeeds, it returns a JSON object with no - * properties.

- *

- * Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.

- *

- * Required permissions: kms:UpdateCustomKeyStore (IAM policy)

- *

- * Related operations: - *

- * + * @see {@link UpdateCustomKeyStoreCommand} */ - public updateCustomKeyStore( + updateCustomKeyStore( args: UpdateCustomKeyStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCustomKeyStore( + updateCustomKeyStore( args: UpdateCustomKeyStoreCommandInput, cb: (err: any, data?: UpdateCustomKeyStoreCommandOutput) => void ): void; - public updateCustomKeyStore( + updateCustomKeyStore( args: UpdateCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCustomKeyStoreCommandOutput) => void ): void; - public updateCustomKeyStore( - args: UpdateCustomKeyStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCustomKeyStoreCommandOutput) => void), - cb?: (err: any, data?: UpdateCustomKeyStoreCommandOutput) => void - ): Promise | void { - const command = new UpdateCustomKeyStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the description of a KMS key. To see the description of a KMS key, use DescribeKey.

- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

- *

- * Required permissions: kms:UpdateKeyDescription (key policy)

- *

- * Related operations - *

- * + * @see {@link UpdateKeyDescriptionCommand} */ - public updateKeyDescription( + updateKeyDescription( args: UpdateKeyDescriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateKeyDescription( + updateKeyDescription( args: UpdateKeyDescriptionCommandInput, cb: (err: any, data?: UpdateKeyDescriptionCommandOutput) => void ): void; - public updateKeyDescription( + updateKeyDescription( args: UpdateKeyDescriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateKeyDescriptionCommandOutput) => void ): void; - public updateKeyDescription( - args: UpdateKeyDescriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateKeyDescriptionCommandOutput) => void), - cb?: (err: any, data?: UpdateKeyDescriptionCommandOutput) => void - ): Promise | void { - const command = new UpdateKeyDescriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes the primary key of a multi-Region key.

- *

This operation changes the replica key in the specified Region to a primary key and - * changes the former primary key to a replica key. For example, suppose you have a primary key - * in us-east-1 and a replica key in eu-west-2. If you run - * UpdatePrimaryRegion with a PrimaryRegion value of - * eu-west-2, the primary key is now the key in eu-west-2, and the - * key in us-east-1 becomes a replica key. For details, see Updating the primary Region in the Key Management Service Developer Guide.

- *

This operation supports multi-Region keys, an KMS feature that lets you create multiple - * interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key - * material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt - * it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

- *

The primary key of a multi-Region key is the source for properties - * that are always shared by primary and replica keys, including the key material, key ID, key spec, key usage, key material - * origin, and automatic - * key rotation. It's the only key that can be replicated. You cannot delete the primary - * key until all replica keys are deleted.

- *

The key ID and primary Region that you specify uniquely identify the replica key that will - * become the primary key. The primary Region must already have a replica key. This operation - * does not create a KMS key in the specified Region. To find the replica keys, use the DescribeKey operation on the primary key or any replica key. To create a replica - * key, use the ReplicateKey operation.

- *

You can run this operation while using the affected multi-Region keys in cryptographic - * operations. This operation should not delay, interrupt, or cause failures in cryptographic - * operations.

- *

Even after this operation completes, the process of updating the primary Region might - * still be in progress for a few more seconds. Operations such as DescribeKey might - * display both the old and new primary keys as replicas. The old and new primary keys have a - * transient key state of Updating. The original key state is restored when the - * update is complete. While the key state is Updating, you can use the keys in - * cryptographic operations, but you cannot replicate the new primary key or perform certain - * management operations, such as enabling or disabling these keys. For details about the - * Updating key state, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

This operation does not return any output. To verify that primary key is changed, use the - * DescribeKey operation.

- *

- * Cross-account use: No. You cannot use this operation in a - * different Amazon Web Services account.

- *

- * Required permissions:

- *
    - *
  • - *

    - * kms:UpdatePrimaryRegion on the current primary key (in the primary key's - * Region). Include this permission primary key's key policy.

    - *
  • - *
  • - *

    - * kms:UpdatePrimaryRegion on the current replica key (in the replica key's - * Region). Include this permission in the replica key's key policy.

    - *
  • - *
- *

- * Related operations - *

- * + * @see {@link UpdatePrimaryRegionCommand} */ - public updatePrimaryRegion( + updatePrimaryRegion( args: UpdatePrimaryRegionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePrimaryRegion( + updatePrimaryRegion( args: UpdatePrimaryRegionCommandInput, cb: (err: any, data?: UpdatePrimaryRegionCommandOutput) => void ): void; - public updatePrimaryRegion( + updatePrimaryRegion( args: UpdatePrimaryRegionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePrimaryRegionCommandOutput) => void ): void; - public updatePrimaryRegion( - args: UpdatePrimaryRegionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePrimaryRegionCommandOutput) => void), - cb?: (err: any, data?: UpdatePrimaryRegionCommandOutput) => void - ): Promise | void { - const command = new UpdatePrimaryRegionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Verifies a digital signature that was generated by the Sign operation.

- *

- *

Verification confirms that an authorized user signed the message with the specified KMS - * key and signing algorithm, and the message hasn't changed since it was signed. If the - * signature is verified, the value of the SignatureValid field in the response is - * True. If the signature verification fails, the Verify operation - * fails with an KMSInvalidSignatureException exception.

- *

A digital signature is generated by using the private key in an asymmetric KMS key. The - * signature is verified by using the public key in the same asymmetric KMS key. - * For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

- *

To use the Verify operation, specify the - * same asymmetric KMS key, message, and signing algorithm that were used to produce the - * signature. The message type does not need to be the same as the one used for signing, but it must - * indicate whether the value of the Message parameter should be - * hashed as part of the verification process.

- *

You can also verify the digital signature by using the public key of the KMS key outside - * of KMS. Use the GetPublicKey operation to download the public key in the - * asymmetric KMS key and then use the public key to verify the signature outside of KMS. The - * advantage of using the Verify operation is that it is performed within KMS. As - * a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged - * in CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use - * the KMS key to verify signatures.

- *

To verify a signature outside of KMS with an SM2 public key (China Regions only), you must - * specify the distinguishing ID. By default, KMS uses 1234567812345678 as the - * distinguishing ID. For more information, see Offline verification - * with SM2 key pairs.

- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify - * the key ARN or alias ARN in the value of the KeyId parameter.

- *

- * Required permissions: kms:Verify (key policy)

- *

- * Related operations: Sign - *

+ * @see {@link VerifyCommand} */ - public verify(args: VerifyCommandInput, options?: __HttpHandlerOptions): Promise; - public verify(args: VerifyCommandInput, cb: (err: any, data?: VerifyCommandOutput) => void): void; - public verify( + verify(args: VerifyCommandInput, options?: __HttpHandlerOptions): Promise; + verify(args: VerifyCommandInput, cb: (err: any, data?: VerifyCommandOutput) => void): void; + verify( args: VerifyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifyCommandOutput) => void ): void; - public verify( - args: VerifyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: VerifyCommandOutput) => void), - cb?: (err: any, data?: VerifyCommandOutput) => void - ): Promise | void { - const command = new VerifyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Verifies the hash-based message authentication code (HMAC) for a specified message, HMAC - * KMS key, and MAC algorithm. To verify the HMAC, VerifyMac computes an HMAC using - * the message, HMAC KMS key, and MAC algorithm that you specify, and compares the computed HMAC - * to the HMAC that you specify. If the HMACs are identical, the verification succeeds; - * otherwise, it fails. Verification indicates that the message hasn't changed since the HMAC was - * calculated, and the specified key was used to generate and verify the HMAC.

- *

HMAC KMS keys and the HMAC algorithms that KMS uses conform to industry standards - * defined in RFC 2104.

- *

This operation is part of KMS support for HMAC KMS keys. For details, see - * HMAC keys in KMS in the - * Key Management Service Developer Guide.

- *

The KMS key that you use for this operation must be in a compatible key state. For - * details, see Key states of KMS keys in the Key Management Service Developer Guide.

- *

- * Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify - * the key ARN or alias ARN in the value of the KeyId parameter.

- *

- * Required permissions: kms:VerifyMac (key policy)

- *

- * Related operations: GenerateMac - *

+ * @see {@link VerifyMacCommand} */ - public verifyMac(args: VerifyMacCommandInput, options?: __HttpHandlerOptions): Promise; - public verifyMac(args: VerifyMacCommandInput, cb: (err: any, data?: VerifyMacCommandOutput) => void): void; - public verifyMac( + verifyMac(args: VerifyMacCommandInput, options?: __HttpHandlerOptions): Promise; + verifyMac(args: VerifyMacCommandInput, cb: (err: any, data?: VerifyMacCommandOutput) => void): void; + verifyMac( args: VerifyMacCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifyMacCommandOutput) => void ): void; - public verifyMac( - args: VerifyMacCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: VerifyMacCommandOutput) => void), - cb?: (err: any, data?: VerifyMacCommandOutput) => void - ): Promise | void { - const command = new VerifyMacCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Key Management Service + *

Key Management Service (KMS) is an encryption and key management web service. This guide describes + * the KMS operations that you can call programmatically. For general information about KMS, + * see the + * Key Management Service Developer Guide + * .

+ * + *

KMS has replaced the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.

+ *

Amazon Web Services provides SDKs that consist of libraries and sample code for various programming + * languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a + * convenient way to create programmatic access to KMS and other Amazon Web Services services. For example, + * the SDKs take care of tasks such as signing requests (see below), managing errors, and + * retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to + * download and install them, see Tools for Amazon Web + * Services.

+ *
+ *

We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.

+ *

If you need to use FIPS 140-2 validated cryptographic modules when communicating with + * Amazon Web Services, use the FIPS endpoint in your preferred Amazon Web Services Region. For more information about the + * available FIPS endpoints, see Service endpoints in the Key Management Service topic of + * the Amazon Web Services General Reference.

+ *

All KMS API calls must be signed and be transmitted using Transport Layer Security + * (TLS). KMS recommends you always use the latest supported TLS version. Clients must also + * support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman + * (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 + * and later support these modes.

+ *

+ * Signing Requests + *

+ *

Requests must be signed using an access key ID and a secret access key. We strongly + * recommend that you do not use your Amazon Web Services account root access key ID and secret access key for + * everyday work. You can use the access key ID and secret access key for an IAM user or you + * can use the Security Token Service (STS) to generate temporary security credentials and use those to sign + * requests.

+ *

All KMS requests must be signed with Signature Version 4.

+ *

+ * Logging API Requests + *

+ *

KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your + * Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the + * information collected by CloudTrail, you can determine what requests were made to KMS, who made + * the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it + * on and find your log files, see the CloudTrail User Guide.

+ *

+ * Additional Resources + *

+ *

For more information about credentials and request signing, see the following:

+ * + *

+ * Commonly Used API Operations + *

+ *

Of the API operations discussed in this guide, the following will prove the most useful + * for most applications. You will likely perform operations other than these, such as creating + * keys and assigning policies, by using the console.

+ * + */ +export class KMS extends KMSClient implements KMS {} +createAggregatedClient(commands, KMS); diff --git a/clients/client-lakeformation/src/LakeFormation.ts b/clients/client-lakeformation/src/LakeFormation.ts index b6a891a7439b..9872cc292191 100644 --- a/clients/client-lakeformation/src/LakeFormation.ts +++ b/clients/client-lakeformation/src/LakeFormation.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -216,1560 +217,806 @@ import { UpdateTableStorageOptimizerCommandInput, UpdateTableStorageOptimizerCommandOutput, } from "./commands/UpdateTableStorageOptimizerCommand"; -import { LakeFormationClient } from "./LakeFormationClient"; +import { LakeFormationClient, LakeFormationClientConfig } from "./LakeFormationClient"; -/** - * @public - * Lake Formation - *

Defines the public endpoint for the Lake Formation service.

- */ -export class LakeFormation extends LakeFormationClient { +const commands = { + AddLFTagsToResourceCommand, + AssumeDecoratedRoleWithSAMLCommand, + BatchGrantPermissionsCommand, + BatchRevokePermissionsCommand, + CancelTransactionCommand, + CommitTransactionCommand, + CreateDataCellsFilterCommand, + CreateLFTagCommand, + DeleteDataCellsFilterCommand, + DeleteLFTagCommand, + DeleteObjectsOnCancelCommand, + DeregisterResourceCommand, + DescribeResourceCommand, + DescribeTransactionCommand, + ExtendTransactionCommand, + GetDataCellsFilterCommand, + GetDataLakeSettingsCommand, + GetEffectivePermissionsForPathCommand, + GetLFTagCommand, + GetQueryStateCommand, + GetQueryStatisticsCommand, + GetResourceLFTagsCommand, + GetTableObjectsCommand, + GetTemporaryGluePartitionCredentialsCommand, + GetTemporaryGlueTableCredentialsCommand, + GetWorkUnitResultsCommand, + GetWorkUnitsCommand, + GrantPermissionsCommand, + ListDataCellsFilterCommand, + ListLFTagsCommand, + ListPermissionsCommand, + ListResourcesCommand, + ListTableStorageOptimizersCommand, + ListTransactionsCommand, + PutDataLakeSettingsCommand, + RegisterResourceCommand, + RemoveLFTagsFromResourceCommand, + RevokePermissionsCommand, + SearchDatabasesByLFTagsCommand, + SearchTablesByLFTagsCommand, + StartQueryPlanningCommand, + StartTransactionCommand, + UpdateDataCellsFilterCommand, + UpdateLFTagCommand, + UpdateResourceCommand, + UpdateTableObjectsCommand, + UpdateTableStorageOptimizerCommand, +}; + +export interface LakeFormation { /** - * @public - *

Attaches one or more LF-tags to an existing resource.

+ * @see {@link AddLFTagsToResourceCommand} */ - public addLFTagsToResource( + addLFTagsToResource( args: AddLFTagsToResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public addLFTagsToResource( + addLFTagsToResource( args: AddLFTagsToResourceCommandInput, cb: (err: any, data?: AddLFTagsToResourceCommandOutput) => void ): void; - public addLFTagsToResource( + addLFTagsToResource( args: AddLFTagsToResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddLFTagsToResourceCommandOutput) => void ): void; - public addLFTagsToResource( - args: AddLFTagsToResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddLFTagsToResourceCommandOutput) => void), - cb?: (err: any, data?: AddLFTagsToResourceCommandOutput) => void - ): Promise | void { - const command = new AddLFTagsToResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request. This decoration allows Lake Formation to enforce access policies against the SAML users and groups. This API operation requires SAML federation setup in the caller’s account as it can only be called with valid SAML assertions. - * Lake Formation does not scope down the permission of the assumed role. All permissions attached to the role via the SAML federation setup will be included in the role session. - *

- *

- * This decorated role is expected to access data in Amazon S3 by getting temporary access from Lake Formation which is authorized via the virtual API GetDataAccess. Therefore, all SAML roles that can be assumed via AssumeDecoratedRoleWithSAML must at a minimum include lakeformation:GetDataAccess in their role policies. A typical IAM policy attached to such a role would look as follows: - *

+ * @see {@link AssumeDecoratedRoleWithSAMLCommand} */ - public assumeDecoratedRoleWithSAML( + assumeDecoratedRoleWithSAML( args: AssumeDecoratedRoleWithSAMLCommandInput, options?: __HttpHandlerOptions ): Promise; - public assumeDecoratedRoleWithSAML( + assumeDecoratedRoleWithSAML( args: AssumeDecoratedRoleWithSAMLCommandInput, cb: (err: any, data?: AssumeDecoratedRoleWithSAMLCommandOutput) => void ): void; - public assumeDecoratedRoleWithSAML( + assumeDecoratedRoleWithSAML( args: AssumeDecoratedRoleWithSAMLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssumeDecoratedRoleWithSAMLCommandOutput) => void ): void; - public assumeDecoratedRoleWithSAML( - args: AssumeDecoratedRoleWithSAMLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssumeDecoratedRoleWithSAMLCommandOutput) => void), - cb?: (err: any, data?: AssumeDecoratedRoleWithSAMLCommandOutput) => void - ): Promise | void { - const command = new AssumeDecoratedRoleWithSAMLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Batch operation to grant permissions to the principal.

+ * @see {@link BatchGrantPermissionsCommand} */ - public batchGrantPermissions( + batchGrantPermissions( args: BatchGrantPermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGrantPermissions( + batchGrantPermissions( args: BatchGrantPermissionsCommandInput, cb: (err: any, data?: BatchGrantPermissionsCommandOutput) => void ): void; - public batchGrantPermissions( + batchGrantPermissions( args: BatchGrantPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGrantPermissionsCommandOutput) => void ): void; - public batchGrantPermissions( - args: BatchGrantPermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGrantPermissionsCommandOutput) => void), - cb?: (err: any, data?: BatchGrantPermissionsCommandOutput) => void - ): Promise | void { - const command = new BatchGrantPermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Batch operation to revoke permissions from the principal.

+ * @see {@link BatchRevokePermissionsCommand} */ - public batchRevokePermissions( + batchRevokePermissions( args: BatchRevokePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchRevokePermissions( + batchRevokePermissions( args: BatchRevokePermissionsCommandInput, cb: (err: any, data?: BatchRevokePermissionsCommandOutput) => void ): void; - public batchRevokePermissions( + batchRevokePermissions( args: BatchRevokePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchRevokePermissionsCommandOutput) => void ): void; - public batchRevokePermissions( - args: BatchRevokePermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchRevokePermissionsCommandOutput) => void), - cb?: (err: any, data?: BatchRevokePermissionsCommandOutput) => void - ): Promise | void { - const command = new BatchRevokePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Attempts to cancel the specified transaction. Returns an exception if the transaction was previously committed.

+ * @see {@link CancelTransactionCommand} */ - public cancelTransaction( + cancelTransaction( args: CancelTransactionCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelTransaction( + cancelTransaction( args: CancelTransactionCommandInput, cb: (err: any, data?: CancelTransactionCommandOutput) => void ): void; - public cancelTransaction( + cancelTransaction( args: CancelTransactionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelTransactionCommandOutput) => void ): void; - public cancelTransaction( - args: CancelTransactionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelTransactionCommandOutput) => void), - cb?: (err: any, data?: CancelTransactionCommandOutput) => void - ): Promise | void { - const command = new CancelTransactionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Attempts to commit the specified transaction. Returns an exception if the transaction was previously aborted. This API action is idempotent if called multiple times for the same transaction.

+ * @see {@link CommitTransactionCommand} */ - public commitTransaction( + commitTransaction( args: CommitTransactionCommandInput, options?: __HttpHandlerOptions ): Promise; - public commitTransaction( + commitTransaction( args: CommitTransactionCommandInput, cb: (err: any, data?: CommitTransactionCommandOutput) => void ): void; - public commitTransaction( + commitTransaction( args: CommitTransactionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CommitTransactionCommandOutput) => void ): void; - public commitTransaction( - args: CommitTransactionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CommitTransactionCommandOutput) => void), - cb?: (err: any, data?: CommitTransactionCommandOutput) => void - ): Promise | void { - const command = new CommitTransactionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a data cell filter to allow one to grant access to certain columns on certain rows.

+ * @see {@link CreateDataCellsFilterCommand} */ - public createDataCellsFilter( + createDataCellsFilter( args: CreateDataCellsFilterCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDataCellsFilter( + createDataCellsFilter( args: CreateDataCellsFilterCommandInput, cb: (err: any, data?: CreateDataCellsFilterCommandOutput) => void ): void; - public createDataCellsFilter( + createDataCellsFilter( args: CreateDataCellsFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataCellsFilterCommandOutput) => void ): void; - public createDataCellsFilter( - args: CreateDataCellsFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDataCellsFilterCommandOutput) => void), - cb?: (err: any, data?: CreateDataCellsFilterCommandOutput) => void - ): Promise | void { - const command = new CreateDataCellsFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an LF-tag with the specified name and values.

+ * @see {@link CreateLFTagCommand} */ - public createLFTag(args: CreateLFTagCommandInput, options?: __HttpHandlerOptions): Promise; - public createLFTag(args: CreateLFTagCommandInput, cb: (err: any, data?: CreateLFTagCommandOutput) => void): void; - public createLFTag( + createLFTag(args: CreateLFTagCommandInput, options?: __HttpHandlerOptions): Promise; + createLFTag(args: CreateLFTagCommandInput, cb: (err: any, data?: CreateLFTagCommandOutput) => void): void; + createLFTag( args: CreateLFTagCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLFTagCommandOutput) => void ): void; - public createLFTag( - args: CreateLFTagCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLFTagCommandOutput) => void), - cb?: (err: any, data?: CreateLFTagCommandOutput) => void - ): Promise | void { - const command = new CreateLFTagCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a data cell filter.

+ * @see {@link DeleteDataCellsFilterCommand} */ - public deleteDataCellsFilter( + deleteDataCellsFilter( args: DeleteDataCellsFilterCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDataCellsFilter( + deleteDataCellsFilter( args: DeleteDataCellsFilterCommandInput, cb: (err: any, data?: DeleteDataCellsFilterCommandOutput) => void ): void; - public deleteDataCellsFilter( + deleteDataCellsFilter( args: DeleteDataCellsFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataCellsFilterCommandOutput) => void ): void; - public deleteDataCellsFilter( - args: DeleteDataCellsFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDataCellsFilterCommandOutput) => void), - cb?: (err: any, data?: DeleteDataCellsFilterCommandOutput) => void - ): Promise | void { - const command = new DeleteDataCellsFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified LF-tag given a key name. If the input parameter tag key was not found, then the operation will throw an exception. When you delete an LF-tag, the LFTagPolicy attached to the LF-tag becomes invalid. If the deleted LF-tag was still assigned to any resource, the tag policy attach to the deleted LF-tag will no longer be applied to the resource.

+ * @see {@link DeleteLFTagCommand} */ - public deleteLFTag(args: DeleteLFTagCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteLFTag(args: DeleteLFTagCommandInput, cb: (err: any, data?: DeleteLFTagCommandOutput) => void): void; - public deleteLFTag( + deleteLFTag(args: DeleteLFTagCommandInput, options?: __HttpHandlerOptions): Promise; + deleteLFTag(args: DeleteLFTagCommandInput, cb: (err: any, data?: DeleteLFTagCommandOutput) => void): void; + deleteLFTag( args: DeleteLFTagCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLFTagCommandOutput) => void ): void; - public deleteLFTag( - args: DeleteLFTagCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLFTagCommandOutput) => void), - cb?: (err: any, data?: DeleteLFTagCommandOutput) => void - ): Promise | void { - const command = new DeleteLFTagCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

For a specific governed table, provides a list of Amazon S3 objects that will be written during the current transaction and that can be automatically deleted - * if the transaction is canceled. Without this call, no Amazon S3 objects are automatically deleted when a transaction cancels. - *

- *

- * The Glue ETL library function write_dynamic_frame.from_catalog() includes an option to automatically - * call DeleteObjectsOnCancel before writes. For more information, see - * Rolling Back Amazon S3 Writes. - *

+ * @see {@link DeleteObjectsOnCancelCommand} */ - public deleteObjectsOnCancel( + deleteObjectsOnCancel( args: DeleteObjectsOnCancelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteObjectsOnCancel( + deleteObjectsOnCancel( args: DeleteObjectsOnCancelCommandInput, cb: (err: any, data?: DeleteObjectsOnCancelCommandOutput) => void ): void; - public deleteObjectsOnCancel( + deleteObjectsOnCancel( args: DeleteObjectsOnCancelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteObjectsOnCancelCommandOutput) => void ): void; - public deleteObjectsOnCancel( - args: DeleteObjectsOnCancelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteObjectsOnCancelCommandOutput) => void), - cb?: (err: any, data?: DeleteObjectsOnCancelCommandOutput) => void - ): Promise | void { - const command = new DeleteObjectsOnCancelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deregisters the resource as managed by the Data Catalog.

- *

When you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role.

+ * @see {@link DeregisterResourceCommand} */ - public deregisterResource( + deregisterResource( args: DeregisterResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterResource( + deregisterResource( args: DeregisterResourceCommandInput, cb: (err: any, data?: DeregisterResourceCommandOutput) => void ): void; - public deregisterResource( + deregisterResource( args: DeregisterResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterResourceCommandOutput) => void ): void; - public deregisterResource( - args: DeregisterResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterResourceCommandOutput) => void), - cb?: (err: any, data?: DeregisterResourceCommandOutput) => void - ): Promise | void { - const command = new DeregisterResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the current data access role for the given resource registered in Lake Formation.

+ * @see {@link DescribeResourceCommand} */ - public describeResource( + describeResource( args: DescribeResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeResource( + describeResource( args: DescribeResourceCommandInput, cb: (err: any, data?: DescribeResourceCommandOutput) => void ): void; - public describeResource( + describeResource( args: DescribeResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeResourceCommandOutput) => void ): void; - public describeResource( - args: DescribeResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeResourceCommandOutput) => void), - cb?: (err: any, data?: DescribeResourceCommandOutput) => void - ): Promise | void { - const command = new DescribeResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the details of a single transaction.

+ * @see {@link DescribeTransactionCommand} */ - public describeTransaction( + describeTransaction( args: DescribeTransactionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTransaction( + describeTransaction( args: DescribeTransactionCommandInput, cb: (err: any, data?: DescribeTransactionCommandOutput) => void ): void; - public describeTransaction( + describeTransaction( args: DescribeTransactionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTransactionCommandOutput) => void ): void; - public describeTransaction( - args: DescribeTransactionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTransactionCommandOutput) => void), - cb?: (err: any, data?: DescribeTransactionCommandOutput) => void - ): Promise | void { - const command = new DescribeTransactionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted.

- *

Write transactions that remain idle for a long period are automatically aborted unless explicitly extended.

+ * @see {@link ExtendTransactionCommand} */ - public extendTransaction( + extendTransaction( args: ExtendTransactionCommandInput, options?: __HttpHandlerOptions ): Promise; - public extendTransaction( + extendTransaction( args: ExtendTransactionCommandInput, cb: (err: any, data?: ExtendTransactionCommandOutput) => void ): void; - public extendTransaction( + extendTransaction( args: ExtendTransactionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExtendTransactionCommandOutput) => void ): void; - public extendTransaction( - args: ExtendTransactionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExtendTransactionCommandOutput) => void), - cb?: (err: any, data?: ExtendTransactionCommandOutput) => void - ): Promise | void { - const command = new ExtendTransactionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a data cells filter.

+ * @see {@link GetDataCellsFilterCommand} */ - public getDataCellsFilter( + getDataCellsFilter( args: GetDataCellsFilterCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDataCellsFilter( + getDataCellsFilter( args: GetDataCellsFilterCommandInput, cb: (err: any, data?: GetDataCellsFilterCommandOutput) => void ): void; - public getDataCellsFilter( + getDataCellsFilter( args: GetDataCellsFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataCellsFilterCommandOutput) => void ): void; - public getDataCellsFilter( - args: GetDataCellsFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDataCellsFilterCommandOutput) => void), - cb?: (err: any, data?: GetDataCellsFilterCommandOutput) => void - ): Promise | void { - const command = new GetDataCellsFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.

+ * @see {@link GetDataLakeSettingsCommand} */ - public getDataLakeSettings( + getDataLakeSettings( args: GetDataLakeSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDataLakeSettings( + getDataLakeSettings( args: GetDataLakeSettingsCommandInput, cb: (err: any, data?: GetDataLakeSettingsCommandOutput) => void ): void; - public getDataLakeSettings( + getDataLakeSettings( args: GetDataLakeSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataLakeSettingsCommandOutput) => void ): void; - public getDataLakeSettings( - args: GetDataLakeSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDataLakeSettingsCommandOutput) => void), - cb?: (err: any, data?: GetDataLakeSettingsCommandOutput) => void - ): Promise | void { - const command = new GetDataLakeSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the Lake Formation permissions for a specified table or database resource located - * at a path in Amazon S3. GetEffectivePermissionsForPath will not return databases and tables if the catalog is encrypted.

+ * @see {@link GetEffectivePermissionsForPathCommand} */ - public getEffectivePermissionsForPath( + getEffectivePermissionsForPath( args: GetEffectivePermissionsForPathCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEffectivePermissionsForPath( + getEffectivePermissionsForPath( args: GetEffectivePermissionsForPathCommandInput, cb: (err: any, data?: GetEffectivePermissionsForPathCommandOutput) => void ): void; - public getEffectivePermissionsForPath( + getEffectivePermissionsForPath( args: GetEffectivePermissionsForPathCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEffectivePermissionsForPathCommandOutput) => void ): void; - public getEffectivePermissionsForPath( - args: GetEffectivePermissionsForPathCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEffectivePermissionsForPathCommandOutput) => void), - cb?: (err: any, data?: GetEffectivePermissionsForPathCommandOutput) => void - ): Promise | void { - const command = new GetEffectivePermissionsForPathCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an LF-tag definition.

+ * @see {@link GetLFTagCommand} */ - public getLFTag(args: GetLFTagCommandInput, options?: __HttpHandlerOptions): Promise; - public getLFTag(args: GetLFTagCommandInput, cb: (err: any, data?: GetLFTagCommandOutput) => void): void; - public getLFTag( + getLFTag(args: GetLFTagCommandInput, options?: __HttpHandlerOptions): Promise; + getLFTag(args: GetLFTagCommandInput, cb: (err: any, data?: GetLFTagCommandOutput) => void): void; + getLFTag( args: GetLFTagCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLFTagCommandOutput) => void ): void; - public getLFTag( - args: GetLFTagCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLFTagCommandOutput) => void), - cb?: (err: any, data?: GetLFTagCommandOutput) => void - ): Promise | void { - const command = new GetLFTagCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the state of a query previously submitted. Clients are expected to poll GetQueryState to monitor the current state of the planning before retrieving the work units. A query state is only visible to the principal that made the initial call to StartQueryPlanning.

+ * @see {@link GetQueryStateCommand} */ - public getQueryState( - args: GetQueryStateCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getQueryState( - args: GetQueryStateCommandInput, - cb: (err: any, data?: GetQueryStateCommandOutput) => void - ): void; - public getQueryState( + getQueryState(args: GetQueryStateCommandInput, options?: __HttpHandlerOptions): Promise; + getQueryState(args: GetQueryStateCommandInput, cb: (err: any, data?: GetQueryStateCommandOutput) => void): void; + getQueryState( args: GetQueryStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueryStateCommandOutput) => void ): void; - public getQueryState( - args: GetQueryStateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetQueryStateCommandOutput) => void), - cb?: (err: any, data?: GetQueryStateCommandOutput) => void - ): Promise | void { - const command = new GetQueryStateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves statistics on the planning and execution of a query.

+ * @see {@link GetQueryStatisticsCommand} */ - public getQueryStatistics( + getQueryStatistics( args: GetQueryStatisticsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getQueryStatistics( + getQueryStatistics( args: GetQueryStatisticsCommandInput, cb: (err: any, data?: GetQueryStatisticsCommandOutput) => void ): void; - public getQueryStatistics( + getQueryStatistics( args: GetQueryStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueryStatisticsCommandOutput) => void ): void; - public getQueryStatistics( - args: GetQueryStatisticsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetQueryStatisticsCommandOutput) => void), - cb?: (err: any, data?: GetQueryStatisticsCommandOutput) => void - ): Promise | void { - const command = new GetQueryStatisticsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the LF-tags applied to a resource.

+ * @see {@link GetResourceLFTagsCommand} */ - public getResourceLFTags( + getResourceLFTags( args: GetResourceLFTagsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourceLFTags( + getResourceLFTags( args: GetResourceLFTagsCommandInput, cb: (err: any, data?: GetResourceLFTagsCommandOutput) => void ): void; - public getResourceLFTags( + getResourceLFTags( args: GetResourceLFTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceLFTagsCommandOutput) => void ): void; - public getResourceLFTags( - args: GetResourceLFTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourceLFTagsCommandOutput) => void), - cb?: (err: any, data?: GetResourceLFTagsCommandOutput) => void - ): Promise | void { - const command = new GetResourceLFTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the set of Amazon S3 objects that make up the specified governed table. A transaction ID or timestamp can be specified for time-travel queries.

+ * @see {@link GetTableObjectsCommand} */ - public getTableObjects( + getTableObjects( args: GetTableObjectsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTableObjects( - args: GetTableObjectsCommandInput, - cb: (err: any, data?: GetTableObjectsCommandOutput) => void - ): void; - public getTableObjects( + getTableObjects(args: GetTableObjectsCommandInput, cb: (err: any, data?: GetTableObjectsCommandOutput) => void): void; + getTableObjects( args: GetTableObjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTableObjectsCommandOutput) => void ): void; - public getTableObjects( - args: GetTableObjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTableObjectsCommandOutput) => void), - cb?: (err: any, data?: GetTableObjectsCommandOutput) => void - ): Promise | void { - const command = new GetTableObjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This API is identical to GetTemporaryTableCredentials except that this is used when the target Data Catalog resource is of type Partition. Lake Formation restricts the permission of the vended credentials with the same scope down policy which restricts access to a single Amazon S3 prefix.

+ * @see {@link GetTemporaryGluePartitionCredentialsCommand} */ - public getTemporaryGluePartitionCredentials( + getTemporaryGluePartitionCredentials( args: GetTemporaryGluePartitionCredentialsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTemporaryGluePartitionCredentials( + getTemporaryGluePartitionCredentials( args: GetTemporaryGluePartitionCredentialsCommandInput, cb: (err: any, data?: GetTemporaryGluePartitionCredentialsCommandOutput) => void ): void; - public getTemporaryGluePartitionCredentials( + getTemporaryGluePartitionCredentials( args: GetTemporaryGluePartitionCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTemporaryGluePartitionCredentialsCommandOutput) => void ): void; - public getTemporaryGluePartitionCredentials( - args: GetTemporaryGluePartitionCredentialsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTemporaryGluePartitionCredentialsCommandOutput) => void), - cb?: (err: any, data?: GetTemporaryGluePartitionCredentialsCommandOutput) => void - ): Promise | void { - const command = new GetTemporaryGluePartitionCredentialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows a caller in a secure environment to assume a role with permission to access Amazon S3. In order to vend such credentials, Lake Formation assumes the role associated with a registered location, for example an Amazon S3 bucket, with a scope down policy which restricts the access to a single prefix.

+ * @see {@link GetTemporaryGlueTableCredentialsCommand} */ - public getTemporaryGlueTableCredentials( + getTemporaryGlueTableCredentials( args: GetTemporaryGlueTableCredentialsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTemporaryGlueTableCredentials( + getTemporaryGlueTableCredentials( args: GetTemporaryGlueTableCredentialsCommandInput, cb: (err: any, data?: GetTemporaryGlueTableCredentialsCommandOutput) => void ): void; - public getTemporaryGlueTableCredentials( + getTemporaryGlueTableCredentials( args: GetTemporaryGlueTableCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTemporaryGlueTableCredentialsCommandOutput) => void ): void; - public getTemporaryGlueTableCredentials( - args: GetTemporaryGlueTableCredentialsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTemporaryGlueTableCredentialsCommandOutput) => void), - cb?: (err: any, data?: GetTemporaryGlueTableCredentialsCommandOutput) => void - ): Promise | void { - const command = new GetTemporaryGlueTableCredentialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the work units resulting from the query. Work units can be executed in any order and in parallel.

+ * @see {@link GetWorkUnitResultsCommand} */ - public getWorkUnitResults( + getWorkUnitResults( args: GetWorkUnitResultsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWorkUnitResults( + getWorkUnitResults( args: GetWorkUnitResultsCommandInput, cb: (err: any, data?: GetWorkUnitResultsCommandOutput) => void ): void; - public getWorkUnitResults( + getWorkUnitResults( args: GetWorkUnitResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkUnitResultsCommandOutput) => void ): void; - public getWorkUnitResults( - args: GetWorkUnitResultsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkUnitResultsCommandOutput) => void), - cb?: (err: any, data?: GetWorkUnitResultsCommandOutput) => void - ): Promise | void { - const command = new GetWorkUnitResultsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the work units generated by the StartQueryPlanning operation.

+ * @see {@link GetWorkUnitsCommand} */ - public getWorkUnits( - args: GetWorkUnitsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getWorkUnits(args: GetWorkUnitsCommandInput, cb: (err: any, data?: GetWorkUnitsCommandOutput) => void): void; - public getWorkUnits( + getWorkUnits(args: GetWorkUnitsCommandInput, options?: __HttpHandlerOptions): Promise; + getWorkUnits(args: GetWorkUnitsCommandInput, cb: (err: any, data?: GetWorkUnitsCommandOutput) => void): void; + getWorkUnits( args: GetWorkUnitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkUnitsCommandOutput) => void ): void; - public getWorkUnits( - args: GetWorkUnitsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkUnitsCommandOutput) => void), - cb?: (err: any, data?: GetWorkUnitsCommandOutput) => void - ): Promise | void { - const command = new GetWorkUnitsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.

- *

For information about permissions, see Security and Access Control to Metadata and Data.

+ * @see {@link GrantPermissionsCommand} */ - public grantPermissions( + grantPermissions( args: GrantPermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public grantPermissions( + grantPermissions( args: GrantPermissionsCommandInput, cb: (err: any, data?: GrantPermissionsCommandOutput) => void ): void; - public grantPermissions( + grantPermissions( args: GrantPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GrantPermissionsCommandOutput) => void ): void; - public grantPermissions( - args: GrantPermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GrantPermissionsCommandOutput) => void), - cb?: (err: any, data?: GrantPermissionsCommandOutput) => void - ): Promise | void { - const command = new GrantPermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the data cell filters on a table.

+ * @see {@link ListDataCellsFilterCommand} */ - public listDataCellsFilter( + listDataCellsFilter( args: ListDataCellsFilterCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDataCellsFilter( + listDataCellsFilter( args: ListDataCellsFilterCommandInput, cb: (err: any, data?: ListDataCellsFilterCommandOutput) => void ): void; - public listDataCellsFilter( + listDataCellsFilter( args: ListDataCellsFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataCellsFilterCommandOutput) => void ): void; - public listDataCellsFilter( - args: ListDataCellsFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDataCellsFilterCommandOutput) => void), - cb?: (err: any, data?: ListDataCellsFilterCommandOutput) => void - ): Promise | void { - const command = new ListDataCellsFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists LF-tags that the requester has permission to view.

+ * @see {@link ListLFTagsCommand} */ - public listLFTags(args: ListLFTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public listLFTags(args: ListLFTagsCommandInput, cb: (err: any, data?: ListLFTagsCommandOutput) => void): void; - public listLFTags( + listLFTags(args: ListLFTagsCommandInput, options?: __HttpHandlerOptions): Promise; + listLFTags(args: ListLFTagsCommandInput, cb: (err: any, data?: ListLFTagsCommandOutput) => void): void; + listLFTags( args: ListLFTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLFTagsCommandOutput) => void ): void; - public listLFTags( - args: ListLFTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLFTagsCommandOutput) => void), - cb?: (err: any, data?: ListLFTagsCommandOutput) => void - ): Promise | void { - const command = new ListLFTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.

- *

This operation returns only those permissions that have been explicitly granted.

- *

For information about permissions, see Security and Access Control to Metadata and Data.

+ * @see {@link ListPermissionsCommand} */ - public listPermissions( + listPermissions( args: ListPermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPermissions( - args: ListPermissionsCommandInput, - cb: (err: any, data?: ListPermissionsCommandOutput) => void - ): void; - public listPermissions( + listPermissions(args: ListPermissionsCommandInput, cb: (err: any, data?: ListPermissionsCommandOutput) => void): void; + listPermissions( args: ListPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPermissionsCommandOutput) => void ): void; - public listPermissions( - args: ListPermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPermissionsCommandOutput) => void), - cb?: (err: any, data?: ListPermissionsCommandOutput) => void - ): Promise | void { - const command = new ListPermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the resources registered to be managed by the Data Catalog.

+ * @see {@link ListResourcesCommand} */ - public listResources( - args: ListResourcesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listResources( - args: ListResourcesCommandInput, - cb: (err: any, data?: ListResourcesCommandOutput) => void - ): void; - public listResources( + listResources(args: ListResourcesCommandInput, options?: __HttpHandlerOptions): Promise; + listResources(args: ListResourcesCommandInput, cb: (err: any, data?: ListResourcesCommandOutput) => void): void; + listResources( args: ListResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourcesCommandOutput) => void ): void; - public listResources( - args: ListResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourcesCommandOutput) => void), - cb?: (err: any, data?: ListResourcesCommandOutput) => void - ): Promise | void { - const command = new ListResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the configuration of all storage optimizers associated with a specified table.

+ * @see {@link ListTableStorageOptimizersCommand} */ - public listTableStorageOptimizers( + listTableStorageOptimizers( args: ListTableStorageOptimizersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTableStorageOptimizers( + listTableStorageOptimizers( args: ListTableStorageOptimizersCommandInput, cb: (err: any, data?: ListTableStorageOptimizersCommandOutput) => void ): void; - public listTableStorageOptimizers( + listTableStorageOptimizers( args: ListTableStorageOptimizersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTableStorageOptimizersCommandOutput) => void ): void; - public listTableStorageOptimizers( - args: ListTableStorageOptimizersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTableStorageOptimizersCommandOutput) => void), - cb?: (err: any, data?: ListTableStorageOptimizersCommandOutput) => void - ): Promise | void { - const command = new ListTableStorageOptimizersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns metadata about transactions and their status. To prevent the response from growing indefinitely, only uncommitted transactions and those available for time-travel queries are returned.

- *

This operation can help you identify uncommitted transactions or to get information about transactions.

+ * @see {@link ListTransactionsCommand} */ - public listTransactions( + listTransactions( args: ListTransactionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTransactions( + listTransactions( args: ListTransactionsCommandInput, cb: (err: any, data?: ListTransactionsCommandOutput) => void ): void; - public listTransactions( + listTransactions( args: ListTransactionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTransactionsCommandOutput) => void ): void; - public listTransactions( - args: ListTransactionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTransactionsCommandOutput) => void), - cb?: (err: any, data?: ListTransactionsCommandOutput) => void - ): Promise | void { - const command = new ListTransactionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation. For more information on admin privileges, see Granting Lake Formation Permissions.

- *

This API replaces the current list of data lake admins with the new list being passed. To add an admin, fetch the current list and add the new admin to that list and pass that list in this API.

+ * @see {@link PutDataLakeSettingsCommand} */ - public putDataLakeSettings( + putDataLakeSettings( args: PutDataLakeSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putDataLakeSettings( + putDataLakeSettings( args: PutDataLakeSettingsCommandInput, cb: (err: any, data?: PutDataLakeSettingsCommandOutput) => void ): void; - public putDataLakeSettings( + putDataLakeSettings( args: PutDataLakeSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDataLakeSettingsCommandOutput) => void ): void; - public putDataLakeSettings( - args: PutDataLakeSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutDataLakeSettingsCommandOutput) => void), - cb?: (err: any, data?: PutDataLakeSettingsCommandOutput) => void - ): Promise | void { - const command = new PutDataLakeSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers the resource as managed by the Data Catalog.

- *

To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.

- *

The following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location.

- *

- * ResourceArn = arn:aws:s3:::my-bucket - * UseServiceLinkedRole = true - *

- *

If UseServiceLinkedRole is not set to true, you must provide or set the RoleArn:

- *

- * arn:aws:iam::12345:role/my-data-access-role - *

+ * @see {@link RegisterResourceCommand} */ - public registerResource( + registerResource( args: RegisterResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerResource( + registerResource( args: RegisterResourceCommandInput, cb: (err: any, data?: RegisterResourceCommandOutput) => void ): void; - public registerResource( + registerResource( args: RegisterResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterResourceCommandOutput) => void ): void; - public registerResource( - args: RegisterResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterResourceCommandOutput) => void), - cb?: (err: any, data?: RegisterResourceCommandOutput) => void - ): Promise | void { - const command = new RegisterResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes an LF-tag from the resource. Only database, table, or tableWithColumns resource are allowed. To tag columns, use the column inclusion list in tableWithColumns to specify column input.

+ * @see {@link RemoveLFTagsFromResourceCommand} */ - public removeLFTagsFromResource( + removeLFTagsFromResource( args: RemoveLFTagsFromResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeLFTagsFromResource( + removeLFTagsFromResource( args: RemoveLFTagsFromResourceCommandInput, cb: (err: any, data?: RemoveLFTagsFromResourceCommandOutput) => void ): void; - public removeLFTagsFromResource( + removeLFTagsFromResource( args: RemoveLFTagsFromResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveLFTagsFromResourceCommandOutput) => void ): void; - public removeLFTagsFromResource( - args: RemoveLFTagsFromResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveLFTagsFromResourceCommandOutput) => void), - cb?: (err: any, data?: RemoveLFTagsFromResourceCommandOutput) => void - ): Promise | void { - const command = new RemoveLFTagsFromResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.

+ * @see {@link RevokePermissionsCommand} */ - public revokePermissions( + revokePermissions( args: RevokePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public revokePermissions( + revokePermissions( args: RevokePermissionsCommandInput, cb: (err: any, data?: RevokePermissionsCommandOutput) => void ): void; - public revokePermissions( + revokePermissions( args: RevokePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokePermissionsCommandOutput) => void ): void; - public revokePermissions( - args: RevokePermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RevokePermissionsCommandOutput) => void), - cb?: (err: any, data?: RevokePermissionsCommandOutput) => void - ): Promise | void { - const command = new RevokePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation allows a search on DATABASE resources by TagCondition. This operation is used by admins who want to grant user permissions on certain TagConditions. Before making a grant, the admin can use SearchDatabasesByTags to find all resources where the given TagConditions are valid to verify whether the returned resources can be shared.

+ * @see {@link SearchDatabasesByLFTagsCommand} */ - public searchDatabasesByLFTags( + searchDatabasesByLFTags( args: SearchDatabasesByLFTagsCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchDatabasesByLFTags( + searchDatabasesByLFTags( args: SearchDatabasesByLFTagsCommandInput, cb: (err: any, data?: SearchDatabasesByLFTagsCommandOutput) => void ): void; - public searchDatabasesByLFTags( + searchDatabasesByLFTags( args: SearchDatabasesByLFTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchDatabasesByLFTagsCommandOutput) => void ): void; - public searchDatabasesByLFTags( - args: SearchDatabasesByLFTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchDatabasesByLFTagsCommandOutput) => void), - cb?: (err: any, data?: SearchDatabasesByLFTagsCommandOutput) => void - ): Promise | void { - const command = new SearchDatabasesByLFTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation allows a search on TABLE resources by LFTags. This will be used by admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can use SearchTablesByLFTags to find all resources where the given LFTags are valid to verify whether the returned resources can be shared.

+ * @see {@link SearchTablesByLFTagsCommand} */ - public searchTablesByLFTags( + searchTablesByLFTags( args: SearchTablesByLFTagsCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchTablesByLFTags( + searchTablesByLFTags( args: SearchTablesByLFTagsCommandInput, cb: (err: any, data?: SearchTablesByLFTagsCommandOutput) => void ): void; - public searchTablesByLFTags( + searchTablesByLFTags( args: SearchTablesByLFTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchTablesByLFTagsCommandOutput) => void ): void; - public searchTablesByLFTags( - args: SearchTablesByLFTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchTablesByLFTagsCommandOutput) => void), - cb?: (err: any, data?: SearchTablesByLFTagsCommandOutput) => void - ): Promise | void { - const command = new SearchTablesByLFTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Submits a request to process a query statement.

- *

This operation generates work units that can be retrieved with the GetWorkUnits operation as soon as the query state is WORKUNITS_AVAILABLE or FINISHED.

+ * @see {@link StartQueryPlanningCommand} */ - public startQueryPlanning( + startQueryPlanning( args: StartQueryPlanningCommandInput, options?: __HttpHandlerOptions ): Promise; - public startQueryPlanning( + startQueryPlanning( args: StartQueryPlanningCommandInput, cb: (err: any, data?: StartQueryPlanningCommandOutput) => void ): void; - public startQueryPlanning( + startQueryPlanning( args: StartQueryPlanningCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartQueryPlanningCommandOutput) => void ): void; - public startQueryPlanning( - args: StartQueryPlanningCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartQueryPlanningCommandOutput) => void), - cb?: (err: any, data?: StartQueryPlanningCommandOutput) => void - ): Promise | void { - const command = new StartQueryPlanningCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a new transaction and returns its transaction ID. Transaction IDs are opaque objects that you can use to identify a transaction.

+ * @see {@link StartTransactionCommand} */ - public startTransaction( + startTransaction( args: StartTransactionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startTransaction( + startTransaction( args: StartTransactionCommandInput, cb: (err: any, data?: StartTransactionCommandOutput) => void ): void; - public startTransaction( + startTransaction( args: StartTransactionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTransactionCommandOutput) => void ): void; - public startTransaction( - args: StartTransactionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartTransactionCommandOutput) => void), - cb?: (err: any, data?: StartTransactionCommandOutput) => void - ): Promise | void { - const command = new StartTransactionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a data cell filter.

+ * @see {@link UpdateDataCellsFilterCommand} */ - public updateDataCellsFilter( + updateDataCellsFilter( args: UpdateDataCellsFilterCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDataCellsFilter( + updateDataCellsFilter( args: UpdateDataCellsFilterCommandInput, cb: (err: any, data?: UpdateDataCellsFilterCommandOutput) => void ): void; - public updateDataCellsFilter( + updateDataCellsFilter( args: UpdateDataCellsFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDataCellsFilterCommandOutput) => void ): void; - public updateDataCellsFilter( - args: UpdateDataCellsFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDataCellsFilterCommandOutput) => void), - cb?: (err: any, data?: UpdateDataCellsFilterCommandOutput) => void - ): Promise | void { - const command = new UpdateDataCellsFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the list of possible values for the specified LF-tag key. If the LF-tag does not exist, the operation throws an EntityNotFoundException. The values in the delete key values will be deleted from list of possible values. If any value in the delete key values is attached to a resource, then API errors out with a 400 Exception - "Update not allowed". Untag the attribute before deleting the LF-tag key's value.

+ * @see {@link UpdateLFTagCommand} */ - public updateLFTag(args: UpdateLFTagCommandInput, options?: __HttpHandlerOptions): Promise; - public updateLFTag(args: UpdateLFTagCommandInput, cb: (err: any, data?: UpdateLFTagCommandOutput) => void): void; - public updateLFTag( + updateLFTag(args: UpdateLFTagCommandInput, options?: __HttpHandlerOptions): Promise; + updateLFTag(args: UpdateLFTagCommandInput, cb: (err: any, data?: UpdateLFTagCommandOutput) => void): void; + updateLFTag( args: UpdateLFTagCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLFTagCommandOutput) => void ): void; - public updateLFTag( - args: UpdateLFTagCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLFTagCommandOutput) => void), - cb?: (err: any, data?: UpdateLFTagCommandOutput) => void - ): Promise | void { - const command = new UpdateLFTagCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the data access role used for vending access to the given (registered) resource in Lake Formation.

+ * @see {@link UpdateResourceCommand} */ - public updateResource( + updateResource( args: UpdateResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateResource( - args: UpdateResourceCommandInput, - cb: (err: any, data?: UpdateResourceCommandOutput) => void - ): void; - public updateResource( + updateResource(args: UpdateResourceCommandInput, cb: (err: any, data?: UpdateResourceCommandOutput) => void): void; + updateResource( args: UpdateResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResourceCommandOutput) => void ): void; - public updateResource( - args: UpdateResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResourceCommandOutput) => void), - cb?: (err: any, data?: UpdateResourceCommandOutput) => void - ): Promise | void { - const command = new UpdateResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the manifest of Amazon S3 objects that make up the specified governed table.

+ * @see {@link UpdateTableObjectsCommand} */ - public updateTableObjects( + updateTableObjects( args: UpdateTableObjectsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTableObjects( + updateTableObjects( args: UpdateTableObjectsCommandInput, cb: (err: any, data?: UpdateTableObjectsCommandOutput) => void ): void; - public updateTableObjects( + updateTableObjects( args: UpdateTableObjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTableObjectsCommandOutput) => void ): void; - public updateTableObjects( - args: UpdateTableObjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTableObjectsCommandOutput) => void), - cb?: (err: any, data?: UpdateTableObjectsCommandOutput) => void - ): Promise | void { - const command = new UpdateTableObjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the configuration of the storage optimizers for a table.

+ * @see {@link UpdateTableStorageOptimizerCommand} */ - public updateTableStorageOptimizer( + updateTableStorageOptimizer( args: UpdateTableStorageOptimizerCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTableStorageOptimizer( + updateTableStorageOptimizer( args: UpdateTableStorageOptimizerCommandInput, cb: (err: any, data?: UpdateTableStorageOptimizerCommandOutput) => void ): void; - public updateTableStorageOptimizer( + updateTableStorageOptimizer( args: UpdateTableStorageOptimizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTableStorageOptimizerCommandOutput) => void ): void; - public updateTableStorageOptimizer( - args: UpdateTableStorageOptimizerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTableStorageOptimizerCommandOutput) => void), - cb?: (err: any, data?: UpdateTableStorageOptimizerCommandOutput) => void - ): Promise | void { - const command = new UpdateTableStorageOptimizerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Lake Formation + *

Defines the public endpoint for the Lake Formation service.

+ */ +export class LakeFormation extends LakeFormationClient implements LakeFormation {} +createAggregatedClient(commands, LakeFormation); diff --git a/clients/client-lambda/src/Lambda.ts b/clients/client-lambda/src/Lambda.ts index eb641c3e7395..0b678625e11a 100644 --- a/clients/client-lambda/src/Lambda.ts +++ b/clients/client-lambda/src/Lambda.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -283,2610 +284,1166 @@ import { UpdateFunctionUrlConfigCommandInput, UpdateFunctionUrlConfigCommandOutput, } from "./commands/UpdateFunctionUrlConfigCommand"; -import { LambdaClient } from "./LambdaClient"; +import { LambdaClient, LambdaClientConfig } from "./LambdaClient"; -/** - * @public - * Lambda - *

- * Overview - *

- *

Lambda is a compute service that lets you run code without provisioning or managing servers. - * Lambda runs your code on a high-availability compute infrastructure and performs all of the - * administration of the compute resources, including server and operating system maintenance, capacity provisioning - * and automatic scaling, code monitoring and logging. With Lambda, you can run code for virtually any - * type of application or backend service. For more information about the Lambda service, see What is Lambda in the Lambda Developer Guide.

- *

The Lambda API Reference provides information about - * each of the API methods, including details about the parameters in each API request and - * response.

- *

- *

You can use Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command - * line tools to access the API. For installation instructions, see Tools for - * Amazon Web Services.

- *

For a list of Region-specific endpoints that Lambda supports, - * see Lambda - * endpoints and quotas in the Amazon Web Services General Reference..

- *

When making the API calls, you will need to - * authenticate your request by providing a signature. Lambda supports signature version 4. For more information, - * see Signature Version 4 signing process in the - * Amazon Web Services General Reference..

- *

- * CA certificates - *

- *

Because Amazon Web Services SDKs use the CA certificates from your computer, changes to the certificates on the Amazon Web Services servers - * can cause connection failures when you attempt to use an SDK. You can prevent these failures by keeping your - * computer's CA certificates and operating system up-to-date. If you encounter this issue in a corporate - * environment and do not manage your own computer, you might need to ask an administrator to assist with the - * update process. The following list shows minimum operating system and Java versions:

- *
    - *
  • - *

    Microsoft Windows versions that have updates from January 2005 or later installed contain at least one - * of the required CAs in their trust list.

    - *
  • - *
  • - *

    Mac OS X 10.4 with Java for Mac OS X 10.4 Release 5 (February 2007), Mac OS X 10.5 (October 2007), and - * later versions contain at least one of the required CAs in their trust list.

    - *
  • - *
  • - *

    Red Hat Enterprise Linux 5 (March 2007), 6, and 7 and CentOS 5, 6, and 7 all contain at least one of the - * required CAs in their default trusted CA list.

    - *
  • - *
  • - *

    Java 1.4.2_12 (May 2006), 5 Update 2 (March 2005), and all later versions, including Java 6 (December - * 2006), 7, and 8, contain at least one of the required CAs in their default trusted CA list.

    - *
  • - *
- *

When accessing the Lambda management console or Lambda API endpoints, whether through browsers or - * programmatically, you will need to ensure your client machines support any of the following CAs:

- *
    - *
  • - *

    Amazon Root CA 1

    - *
  • - *
  • - *

    Starfield Services Root Certificate Authority - G2

    - *
  • - *
  • - *

    Starfield Class 2 Certification Authority

    - *
  • - *
- *

Root certificates from the first two authorities are available from Amazon trust services, but keeping your computer - * up-to-date is the more straightforward solution. To learn more about ACM-provided certificates, see Amazon Web Services Certificate Manager FAQs. - *

- */ -export class Lambda extends LambdaClient { +const commands = { + AddLayerVersionPermissionCommand, + AddPermissionCommand, + CreateAliasCommand, + CreateCodeSigningConfigCommand, + CreateEventSourceMappingCommand, + CreateFunctionCommand, + CreateFunctionUrlConfigCommand, + DeleteAliasCommand, + DeleteCodeSigningConfigCommand, + DeleteEventSourceMappingCommand, + DeleteFunctionCommand, + DeleteFunctionCodeSigningConfigCommand, + DeleteFunctionConcurrencyCommand, + DeleteFunctionEventInvokeConfigCommand, + DeleteFunctionUrlConfigCommand, + DeleteLayerVersionCommand, + DeleteProvisionedConcurrencyConfigCommand, + GetAccountSettingsCommand, + GetAliasCommand, + GetCodeSigningConfigCommand, + GetEventSourceMappingCommand, + GetFunctionCommand, + GetFunctionCodeSigningConfigCommand, + GetFunctionConcurrencyCommand, + GetFunctionConfigurationCommand, + GetFunctionEventInvokeConfigCommand, + GetFunctionUrlConfigCommand, + GetLayerVersionCommand, + GetLayerVersionByArnCommand, + GetLayerVersionPolicyCommand, + GetPolicyCommand, + GetProvisionedConcurrencyConfigCommand, + GetRuntimeManagementConfigCommand, + InvokeCommand, + InvokeAsyncCommand, + InvokeWithResponseStreamCommand, + ListAliasesCommand, + ListCodeSigningConfigsCommand, + ListEventSourceMappingsCommand, + ListFunctionEventInvokeConfigsCommand, + ListFunctionsCommand, + ListFunctionsByCodeSigningConfigCommand, + ListFunctionUrlConfigsCommand, + ListLayersCommand, + ListLayerVersionsCommand, + ListProvisionedConcurrencyConfigsCommand, + ListTagsCommand, + ListVersionsByFunctionCommand, + PublishLayerVersionCommand, + PublishVersionCommand, + PutFunctionCodeSigningConfigCommand, + PutFunctionConcurrencyCommand, + PutFunctionEventInvokeConfigCommand, + PutProvisionedConcurrencyConfigCommand, + PutRuntimeManagementConfigCommand, + RemoveLayerVersionPermissionCommand, + RemovePermissionCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAliasCommand, + UpdateCodeSigningConfigCommand, + UpdateEventSourceMappingCommand, + UpdateFunctionCodeCommand, + UpdateFunctionConfigurationCommand, + UpdateFunctionEventInvokeConfigCommand, + UpdateFunctionUrlConfigCommand, +}; + +export interface Lambda { /** - * @public - *

Adds permissions to the resource-based policy of a version of an Lambda - * layer. Use this action to grant layer - * usage permission to other accounts. You can grant permission to a single account, all accounts in an organization, - * or all Amazon Web Services accounts.

- *

To revoke permission, call RemoveLayerVersionPermission with the statement ID that you - * specified when you added it.

+ * @see {@link AddLayerVersionPermissionCommand} */ - public addLayerVersionPermission( + addLayerVersionPermission( args: AddLayerVersionPermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public addLayerVersionPermission( + addLayerVersionPermission( args: AddLayerVersionPermissionCommandInput, cb: (err: any, data?: AddLayerVersionPermissionCommandOutput) => void ): void; - public addLayerVersionPermission( + addLayerVersionPermission( args: AddLayerVersionPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddLayerVersionPermissionCommandOutput) => void ): void; - public addLayerVersionPermission( - args: AddLayerVersionPermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddLayerVersionPermissionCommandOutput) => void), - cb?: (err: any, data?: AddLayerVersionPermissionCommandOutput) => void - ): Promise | void { - const command = new AddLayerVersionPermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Grants an Amazon Web Service, Amazon Web Services account, or Amazon Web Services organization - * permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict - * access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name - * (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies - * to version $LATEST.

- *

To grant permission to another account, specify the account ID as the Principal. To grant - * permission to an organization defined in Organizations, specify the organization ID as the - * PrincipalOrgID. For Amazon Web Services, the principal is a domain-style identifier that - * the service defines, such as s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Services, you can also specify the ARN of the associated resource as the SourceArn. If - * you grant permission to a service principal without specifying the source, other accounts could potentially - * configure resources in their account to invoke your Lambda function.

- *

This operation adds a statement to a resource-based permissions policy for the function. For more information - * about function policies, see Using resource-based policies for Lambda.

- */ - public addPermission( - args: AddPermissionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public addPermission( - args: AddPermissionCommandInput, - cb: (err: any, data?: AddPermissionCommandOutput) => void - ): void; - public addPermission( + + /** + * @see {@link AddPermissionCommand} + */ + addPermission(args: AddPermissionCommandInput, options?: __HttpHandlerOptions): Promise; + addPermission(args: AddPermissionCommandInput, cb: (err: any, data?: AddPermissionCommandOutput) => void): void; + addPermission( args: AddPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddPermissionCommandOutput) => void ): void; - public addPermission( - args: AddPermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddPermissionCommandOutput) => void), - cb?: (err: any, data?: AddPermissionCommandOutput) => void - ): Promise | void { - const command = new AddPermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an alias for a - * Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a - * different version.

- *

You can also map an alias to split invocation requests between two versions. Use the - * RoutingConfig parameter to specify a second version and the percentage of invocation requests that - * it receives.

- */ - public createAlias(args: CreateAliasCommandInput, options?: __HttpHandlerOptions): Promise; - public createAlias(args: CreateAliasCommandInput, cb: (err: any, data?: CreateAliasCommandOutput) => void): void; - public createAlias( + + /** + * @see {@link CreateAliasCommand} + */ + createAlias(args: CreateAliasCommandInput, options?: __HttpHandlerOptions): Promise; + createAlias(args: CreateAliasCommandInput, cb: (err: any, data?: CreateAliasCommandOutput) => void): void; + createAlias( args: CreateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAliasCommandOutput) => void ): void; - public createAlias( - args: CreateAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAliasCommandOutput) => void), - cb?: (err: any, data?: CreateAliasCommandOutput) => void - ): Promise | void { - const command = new CreateAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a code signing configuration. A code signing configuration defines a list of - * allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment - * validation checks fail).

- */ - public createCodeSigningConfig( + + /** + * @see {@link CreateCodeSigningConfigCommand} + */ + createCodeSigningConfig( args: CreateCodeSigningConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCodeSigningConfig( + createCodeSigningConfig( args: CreateCodeSigningConfigCommandInput, cb: (err: any, data?: CreateCodeSigningConfigCommandOutput) => void ): void; - public createCodeSigningConfig( + createCodeSigningConfig( args: CreateCodeSigningConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCodeSigningConfigCommandOutput) => void ): void; - public createCodeSigningConfig( - args: CreateCodeSigningConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCodeSigningConfigCommandOutput) => void), - cb?: (err: any, data?: CreateCodeSigningConfigCommandOutput) => void - ): Promise | void { - const command = new CreateCodeSigningConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and invokes the function.

- *

For details about how to configure different event sources, see the following topics.

- * - *

The following error handling options are available only for stream sources (DynamoDB and Kinesis):

- *
    - *
  • - *

    - * BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.

    - *
  • - *
  • - *

    - * DestinationConfig – Send discarded records to an Amazon SQS queue or Amazon SNS topic.

    - *
  • - *
  • - *

    - * MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires

    - *
  • - *
  • - *

    - * MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

    - *
  • - *
  • - *

    - * ParallelizationFactor – Process multiple batches from each shard concurrently.

    - *
  • - *
- *

For information about which configuration parameters apply to each event source, see the following topics.

- * - */ - public createEventSourceMapping( + + /** + * @see {@link CreateEventSourceMappingCommand} + */ + createEventSourceMapping( args: CreateEventSourceMappingCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEventSourceMapping( + createEventSourceMapping( args: CreateEventSourceMappingCommandInput, cb: (err: any, data?: CreateEventSourceMappingCommandOutput) => void ): void; - public createEventSourceMapping( + createEventSourceMapping( args: CreateEventSourceMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEventSourceMappingCommandOutput) => void ): void; - public createEventSourceMapping( - args: CreateEventSourceMappingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEventSourceMappingCommandOutput) => void), - cb?: (err: any, data?: CreateEventSourceMappingCommandOutput) => void - ): Promise | void { - const command = new CreateEventSourceMappingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Lambda function. To create a function, you need a deployment package and an execution role. The - * deployment package is a .zip file archive or container image that contains your function code. The execution role - * grants the function permission to use Amazon Web Services, such as Amazon CloudWatch Logs for log - * streaming and X-Ray for request tracing.

- *

If the deployment package is a container - * image, then you set the package type to Image. For a container image, the code property - * must include the URI of a container image in the Amazon ECR registry. You do not need to specify the - * handler and runtime properties.

- *

If the deployment package is a .zip file archive, then - * you set the package type to Zip. For a .zip file archive, the code property specifies the location of - * the .zip file. You must also specify the handler and runtime properties. The code in the deployment package must - * be compatible with the target instruction set architecture of the function (x86-64 or - * arm64). If you do not specify the architecture, then the default value is - * x86-64.

- *

When you create a function, Lambda provisions an instance of the function and its supporting - * resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't - * invoke or modify the function. The State, StateReason, and StateReasonCode - * fields in the response from GetFunctionConfiguration indicate when the function is ready to - * invoke. For more information, see Lambda function states.

- *

A function has an unpublished version, and can have published versions and aliases. The unpublished version - * changes when you update your function's code and configuration. A published version is a snapshot of your function - * code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be - * changed to map to a different version. Use the Publish parameter to create version 1 of - * your function from its initial configuration.

- *

The other parameters let you configure version-specific and function-level settings. You can modify - * version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply - * to both the unpublished and published versions of the function, and include tags (TagResource) - * and per-function concurrency limits (PutFunctionConcurrency).

- *

You can use code signing if your deployment package is a .zip file archive. To enable code signing for this - * function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with - * UpdateFunctionCode, Lambda checks that the code package has a valid signature from - * a trusted publisher. The code-signing configuration includes set of signing profiles, which define the trusted - * publishers for this function.

- *

If another Amazon Web Services account or an Amazon Web Service invokes your function, use AddPermission to grant permission by creating a resource-based Identity and Access Management (IAM) policy. You can grant permissions at the function level, on a version, or on an alias.

- *

To invoke your function directly, use Invoke. To invoke your function in response to events - * in other Amazon Web Services, create an event source mapping (CreateEventSourceMapping), - * or configure a function trigger in the other service. For more information, see Invoking Lambda - * functions.

- */ - public createFunction( + + /** + * @see {@link CreateFunctionCommand} + */ + createFunction( args: CreateFunctionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFunction( - args: CreateFunctionCommandInput, - cb: (err: any, data?: CreateFunctionCommandOutput) => void - ): void; - public createFunction( + createFunction(args: CreateFunctionCommandInput, cb: (err: any, data?: CreateFunctionCommandOutput) => void): void; + createFunction( args: CreateFunctionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFunctionCommandOutput) => void ): void; - public createFunction( - args: CreateFunctionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFunctionCommandOutput) => void), - cb?: (err: any, data?: CreateFunctionCommandOutput) => void - ): Promise | void { - const command = new CreateFunctionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Lambda function URL with the specified configuration parameters. A function URL is - * a dedicated HTTP(S) endpoint that you can use to invoke your function.

- */ - public createFunctionUrlConfig( + + /** + * @see {@link CreateFunctionUrlConfigCommand} + */ + createFunctionUrlConfig( args: CreateFunctionUrlConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFunctionUrlConfig( + createFunctionUrlConfig( args: CreateFunctionUrlConfigCommandInput, cb: (err: any, data?: CreateFunctionUrlConfigCommandOutput) => void ): void; - public createFunctionUrlConfig( + createFunctionUrlConfig( args: CreateFunctionUrlConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFunctionUrlConfigCommandOutput) => void ): void; - public createFunctionUrlConfig( - args: CreateFunctionUrlConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFunctionUrlConfigCommandOutput) => void), - cb?: (err: any, data?: CreateFunctionUrlConfigCommandOutput) => void - ): Promise | void { - const command = new CreateFunctionUrlConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a Lambda function alias.

- */ - public deleteAlias(args: DeleteAliasCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteAlias(args: DeleteAliasCommandInput, cb: (err: any, data?: DeleteAliasCommandOutput) => void): void; - public deleteAlias( + + /** + * @see {@link DeleteAliasCommand} + */ + deleteAlias(args: DeleteAliasCommandInput, options?: __HttpHandlerOptions): Promise; + deleteAlias(args: DeleteAliasCommandInput, cb: (err: any, data?: DeleteAliasCommandOutput) => void): void; + deleteAlias( args: DeleteAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAliasCommandOutput) => void ): void; - public deleteAlias( - args: DeleteAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAliasCommandOutput) => void), - cb?: (err: any, data?: DeleteAliasCommandOutput) => void - ): Promise | void { - const command = new DeleteAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the code signing configuration. You can delete the code signing configuration only if no function is - * using it.

- */ - public deleteCodeSigningConfig( + + /** + * @see {@link DeleteCodeSigningConfigCommand} + */ + deleteCodeSigningConfig( args: DeleteCodeSigningConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCodeSigningConfig( + deleteCodeSigningConfig( args: DeleteCodeSigningConfigCommandInput, cb: (err: any, data?: DeleteCodeSigningConfigCommandOutput) => void ): void; - public deleteCodeSigningConfig( + deleteCodeSigningConfig( args: DeleteCodeSigningConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCodeSigningConfigCommandOutput) => void ): void; - public deleteCodeSigningConfig( - args: DeleteCodeSigningConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCodeSigningConfigCommandOutput) => void), - cb?: (err: any, data?: DeleteCodeSigningConfigCommandOutput) => void - ): Promise | void { - const command = new DeleteCodeSigningConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an event source - * mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

- *

When you delete an event source mapping, it enters a Deleting state and might not be completely - * deleted for several seconds.

- */ - public deleteEventSourceMapping( + + /** + * @see {@link DeleteEventSourceMappingCommand} + */ + deleteEventSourceMapping( args: DeleteEventSourceMappingCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEventSourceMapping( + deleteEventSourceMapping( args: DeleteEventSourceMappingCommandInput, cb: (err: any, data?: DeleteEventSourceMappingCommandOutput) => void ): void; - public deleteEventSourceMapping( + deleteEventSourceMapping( args: DeleteEventSourceMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventSourceMappingCommandOutput) => void ): void; - public deleteEventSourceMapping( - args: DeleteEventSourceMappingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEventSourceMappingCommandOutput) => void), - cb?: (err: any, data?: DeleteEventSourceMappingCommandOutput) => void - ): Promise | void { - const command = new DeleteEventSourceMappingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. - * Otherwise, all versions and aliases are deleted.

- *

To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Services and resources that invoke your function - * directly, delete the trigger in the service where you originally configured it.

- */ - public deleteFunction( + + /** + * @see {@link DeleteFunctionCommand} + */ + deleteFunction( args: DeleteFunctionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFunction( - args: DeleteFunctionCommandInput, - cb: (err: any, data?: DeleteFunctionCommandOutput) => void - ): void; - public deleteFunction( + deleteFunction(args: DeleteFunctionCommandInput, cb: (err: any, data?: DeleteFunctionCommandOutput) => void): void; + deleteFunction( args: DeleteFunctionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFunctionCommandOutput) => void ): void; - public deleteFunction( - args: DeleteFunctionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFunctionCommandOutput) => void), - cb?: (err: any, data?: DeleteFunctionCommandOutput) => void - ): Promise | void { - const command = new DeleteFunctionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the code signing configuration from the function.

- */ - public deleteFunctionCodeSigningConfig( + + /** + * @see {@link DeleteFunctionCodeSigningConfigCommand} + */ + deleteFunctionCodeSigningConfig( args: DeleteFunctionCodeSigningConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFunctionCodeSigningConfig( + deleteFunctionCodeSigningConfig( args: DeleteFunctionCodeSigningConfigCommandInput, cb: (err: any, data?: DeleteFunctionCodeSigningConfigCommandOutput) => void ): void; - public deleteFunctionCodeSigningConfig( + deleteFunctionCodeSigningConfig( args: DeleteFunctionCodeSigningConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFunctionCodeSigningConfigCommandOutput) => void ): void; - public deleteFunctionCodeSigningConfig( - args: DeleteFunctionCodeSigningConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFunctionCodeSigningConfigCommandOutput) => void), - cb?: (err: any, data?: DeleteFunctionCodeSigningConfigCommandOutput) => void - ): Promise | void { - const command = new DeleteFunctionCodeSigningConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a concurrent execution limit from a function.

- */ - public deleteFunctionConcurrency( + + /** + * @see {@link DeleteFunctionConcurrencyCommand} + */ + deleteFunctionConcurrency( args: DeleteFunctionConcurrencyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFunctionConcurrency( + deleteFunctionConcurrency( args: DeleteFunctionConcurrencyCommandInput, cb: (err: any, data?: DeleteFunctionConcurrencyCommandOutput) => void ): void; - public deleteFunctionConcurrency( + deleteFunctionConcurrency( args: DeleteFunctionConcurrencyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFunctionConcurrencyCommandOutput) => void ): void; - public deleteFunctionConcurrency( - args: DeleteFunctionConcurrencyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFunctionConcurrencyCommandOutput) => void), - cb?: (err: any, data?: DeleteFunctionConcurrencyCommandOutput) => void - ): Promise | void { - const command = new DeleteFunctionConcurrencyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the configuration for asynchronous invocation for a function, version, or alias.

- *

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

- */ - public deleteFunctionEventInvokeConfig( + + /** + * @see {@link DeleteFunctionEventInvokeConfigCommand} + */ + deleteFunctionEventInvokeConfig( args: DeleteFunctionEventInvokeConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFunctionEventInvokeConfig( + deleteFunctionEventInvokeConfig( args: DeleteFunctionEventInvokeConfigCommandInput, cb: (err: any, data?: DeleteFunctionEventInvokeConfigCommandOutput) => void ): void; - public deleteFunctionEventInvokeConfig( + deleteFunctionEventInvokeConfig( args: DeleteFunctionEventInvokeConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFunctionEventInvokeConfigCommandOutput) => void ): void; - public deleteFunctionEventInvokeConfig( - args: DeleteFunctionEventInvokeConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFunctionEventInvokeConfigCommandOutput) => void), - cb?: (err: any, data?: DeleteFunctionEventInvokeConfigCommandOutput) => void - ): Promise | void { - const command = new DeleteFunctionEventInvokeConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a Lambda function URL. When you delete a function URL, you - * can't recover it. Creating a new function URL results in a different URL address.

- */ - public deleteFunctionUrlConfig( + + /** + * @see {@link DeleteFunctionUrlConfigCommand} + */ + deleteFunctionUrlConfig( args: DeleteFunctionUrlConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFunctionUrlConfig( + deleteFunctionUrlConfig( args: DeleteFunctionUrlConfigCommandInput, cb: (err: any, data?: DeleteFunctionUrlConfigCommandOutput) => void ): void; - public deleteFunctionUrlConfig( + deleteFunctionUrlConfig( args: DeleteFunctionUrlConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFunctionUrlConfigCommandOutput) => void ): void; - public deleteFunctionUrlConfig( - args: DeleteFunctionUrlConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFunctionUrlConfigCommandOutput) => void), - cb?: (err: any, data?: DeleteFunctionUrlConfigCommandOutput) => void - ): Promise | void { - const command = new DeleteFunctionUrlConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a version of an Lambda - * layer. Deleted versions can no longer be viewed or added to functions. To avoid - * breaking functions, a copy of the version remains in Lambda until no functions refer to it.

- */ - public deleteLayerVersion( + + /** + * @see {@link DeleteLayerVersionCommand} + */ + deleteLayerVersion( args: DeleteLayerVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLayerVersion( + deleteLayerVersion( args: DeleteLayerVersionCommandInput, cb: (err: any, data?: DeleteLayerVersionCommandOutput) => void ): void; - public deleteLayerVersion( + deleteLayerVersion( args: DeleteLayerVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLayerVersionCommandOutput) => void ): void; - public deleteLayerVersion( - args: DeleteLayerVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLayerVersionCommandOutput) => void), - cb?: (err: any, data?: DeleteLayerVersionCommandOutput) => void - ): Promise | void { - const command = new DeleteLayerVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the provisioned concurrency configuration for a function.

- */ - public deleteProvisionedConcurrencyConfig( + + /** + * @see {@link DeleteProvisionedConcurrencyConfigCommand} + */ + deleteProvisionedConcurrencyConfig( args: DeleteProvisionedConcurrencyConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteProvisionedConcurrencyConfig( + deleteProvisionedConcurrencyConfig( args: DeleteProvisionedConcurrencyConfigCommandInput, cb: (err: any, data?: DeleteProvisionedConcurrencyConfigCommandOutput) => void ): void; - public deleteProvisionedConcurrencyConfig( + deleteProvisionedConcurrencyConfig( args: DeleteProvisionedConcurrencyConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProvisionedConcurrencyConfigCommandOutput) => void ): void; - public deleteProvisionedConcurrencyConfig( - args: DeleteProvisionedConcurrencyConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProvisionedConcurrencyConfigCommandOutput) => void), - cb?: (err: any, data?: DeleteProvisionedConcurrencyConfigCommandOutput) => void - ): Promise | void { - const command = new DeleteProvisionedConcurrencyConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves details about your account's limits and usage in an Amazon Web Services Region.

- */ - public getAccountSettings( + + /** + * @see {@link GetAccountSettingsCommand} + */ + getAccountSettings( args: GetAccountSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccountSettings( + getAccountSettings( args: GetAccountSettingsCommandInput, cb: (err: any, data?: GetAccountSettingsCommandOutput) => void ): void; - public getAccountSettings( + getAccountSettings( args: GetAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountSettingsCommandOutput) => void ): void; - public getAccountSettings( - args: GetAccountSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccountSettingsCommandOutput) => void), - cb?: (err: any, data?: GetAccountSettingsCommandOutput) => void - ): Promise | void { - const command = new GetAccountSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns details about a Lambda function alias.

- */ - public getAlias(args: GetAliasCommandInput, options?: __HttpHandlerOptions): Promise; - public getAlias(args: GetAliasCommandInput, cb: (err: any, data?: GetAliasCommandOutput) => void): void; - public getAlias( + + /** + * @see {@link GetAliasCommand} + */ + getAlias(args: GetAliasCommandInput, options?: __HttpHandlerOptions): Promise; + getAlias(args: GetAliasCommandInput, cb: (err: any, data?: GetAliasCommandOutput) => void): void; + getAlias( args: GetAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAliasCommandOutput) => void ): void; - public getAlias( - args: GetAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAliasCommandOutput) => void), - cb?: (err: any, data?: GetAliasCommandOutput) => void - ): Promise | void { - const command = new GetAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the specified code signing configuration.

- */ - public getCodeSigningConfig( + + /** + * @see {@link GetCodeSigningConfigCommand} + */ + getCodeSigningConfig( args: GetCodeSigningConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCodeSigningConfig( + getCodeSigningConfig( args: GetCodeSigningConfigCommandInput, cb: (err: any, data?: GetCodeSigningConfigCommandOutput) => void ): void; - public getCodeSigningConfig( + getCodeSigningConfig( args: GetCodeSigningConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCodeSigningConfigCommandOutput) => void ): void; - public getCodeSigningConfig( - args: GetCodeSigningConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCodeSigningConfigCommandOutput) => void), - cb?: (err: any, data?: GetCodeSigningConfigCommandOutput) => void - ): Promise | void { - const command = new GetCodeSigningConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns details about an event source mapping. You can get the identifier of a mapping from the output of - * ListEventSourceMappings.

- */ - public getEventSourceMapping( + + /** + * @see {@link GetEventSourceMappingCommand} + */ + getEventSourceMapping( args: GetEventSourceMappingCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEventSourceMapping( + getEventSourceMapping( args: GetEventSourceMappingCommandInput, cb: (err: any, data?: GetEventSourceMappingCommandOutput) => void ): void; - public getEventSourceMapping( + getEventSourceMapping( args: GetEventSourceMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEventSourceMappingCommandOutput) => void ): void; - public getEventSourceMapping( - args: GetEventSourceMappingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEventSourceMappingCommandOutput) => void), - cb?: (err: any, data?: GetEventSourceMappingCommandOutput) => void - ): Promise | void { - const command = new GetEventSourceMappingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the function or function version, with a link to download the deployment package - * that's valid for 10 minutes. If you specify a function version, only details that are specific to that version are - * returned.

- */ - public getFunction(args: GetFunctionCommandInput, options?: __HttpHandlerOptions): Promise; - public getFunction(args: GetFunctionCommandInput, cb: (err: any, data?: GetFunctionCommandOutput) => void): void; - public getFunction( + + /** + * @see {@link GetFunctionCommand} + */ + getFunction(args: GetFunctionCommandInput, options?: __HttpHandlerOptions): Promise; + getFunction(args: GetFunctionCommandInput, cb: (err: any, data?: GetFunctionCommandOutput) => void): void; + getFunction( args: GetFunctionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFunctionCommandOutput) => void ): void; - public getFunction( - args: GetFunctionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFunctionCommandOutput) => void), - cb?: (err: any, data?: GetFunctionCommandOutput) => void - ): Promise | void { - const command = new GetFunctionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the code signing configuration for the specified function.

- */ - public getFunctionCodeSigningConfig( + + /** + * @see {@link GetFunctionCodeSigningConfigCommand} + */ + getFunctionCodeSigningConfig( args: GetFunctionCodeSigningConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFunctionCodeSigningConfig( + getFunctionCodeSigningConfig( args: GetFunctionCodeSigningConfigCommandInput, cb: (err: any, data?: GetFunctionCodeSigningConfigCommandOutput) => void ): void; - public getFunctionCodeSigningConfig( + getFunctionCodeSigningConfig( args: GetFunctionCodeSigningConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFunctionCodeSigningConfigCommandOutput) => void ): void; - public getFunctionCodeSigningConfig( - args: GetFunctionCodeSigningConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFunctionCodeSigningConfigCommandOutput) => void), - cb?: (err: any, data?: GetFunctionCodeSigningConfigCommandOutput) => void - ): Promise | void { - const command = new GetFunctionCodeSigningConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a - * function, use PutFunctionConcurrency.

- */ - public getFunctionConcurrency( + + /** + * @see {@link GetFunctionConcurrencyCommand} + */ + getFunctionConcurrency( args: GetFunctionConcurrencyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFunctionConcurrency( + getFunctionConcurrency( args: GetFunctionConcurrencyCommandInput, cb: (err: any, data?: GetFunctionConcurrencyCommandOutput) => void ): void; - public getFunctionConcurrency( + getFunctionConcurrency( args: GetFunctionConcurrencyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFunctionConcurrencyCommandOutput) => void ): void; - public getFunctionConcurrency( - args: GetFunctionConcurrencyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFunctionConcurrencyCommandOutput) => void), - cb?: (err: any, data?: GetFunctionConcurrencyCommandOutput) => void - ): Promise | void { - const command = new GetFunctionConcurrencyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the version-specific settings of a Lambda function or version. The output includes only options that - * can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration.

- *

To get all of a function's details, including function-level settings, use GetFunction.

- */ - public getFunctionConfiguration( + + /** + * @see {@link GetFunctionConfigurationCommand} + */ + getFunctionConfiguration( args: GetFunctionConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFunctionConfiguration( + getFunctionConfiguration( args: GetFunctionConfigurationCommandInput, cb: (err: any, data?: GetFunctionConfigurationCommandOutput) => void ): void; - public getFunctionConfiguration( + getFunctionConfiguration( args: GetFunctionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFunctionConfigurationCommandOutput) => void ): void; - public getFunctionConfiguration( - args: GetFunctionConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFunctionConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetFunctionConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetFunctionConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the configuration for asynchronous invocation for a function, version, or alias.

- *

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

- */ - public getFunctionEventInvokeConfig( + + /** + * @see {@link GetFunctionEventInvokeConfigCommand} + */ + getFunctionEventInvokeConfig( args: GetFunctionEventInvokeConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFunctionEventInvokeConfig( + getFunctionEventInvokeConfig( args: GetFunctionEventInvokeConfigCommandInput, cb: (err: any, data?: GetFunctionEventInvokeConfigCommandOutput) => void ): void; - public getFunctionEventInvokeConfig( + getFunctionEventInvokeConfig( args: GetFunctionEventInvokeConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFunctionEventInvokeConfigCommandOutput) => void ): void; - public getFunctionEventInvokeConfig( - args: GetFunctionEventInvokeConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFunctionEventInvokeConfigCommandOutput) => void), - cb?: (err: any, data?: GetFunctionEventInvokeConfigCommandOutput) => void - ): Promise | void { - const command = new GetFunctionEventInvokeConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns details about a Lambda function URL.

- */ - public getFunctionUrlConfig( + + /** + * @see {@link GetFunctionUrlConfigCommand} + */ + getFunctionUrlConfig( args: GetFunctionUrlConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFunctionUrlConfig( + getFunctionUrlConfig( args: GetFunctionUrlConfigCommandInput, cb: (err: any, data?: GetFunctionUrlConfigCommandOutput) => void ): void; - public getFunctionUrlConfig( + getFunctionUrlConfig( args: GetFunctionUrlConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFunctionUrlConfigCommandOutput) => void ): void; - public getFunctionUrlConfig( - args: GetFunctionUrlConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFunctionUrlConfigCommandOutput) => void), - cb?: (err: any, data?: GetFunctionUrlConfigCommandOutput) => void - ): Promise | void { - const command = new GetFunctionUrlConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a version of an Lambda - * layer, with a link to download the layer archive - * that's valid for 10 minutes.

- */ - public getLayerVersion( + + /** + * @see {@link GetLayerVersionCommand} + */ + getLayerVersion( args: GetLayerVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLayerVersion( - args: GetLayerVersionCommandInput, - cb: (err: any, data?: GetLayerVersionCommandOutput) => void - ): void; - public getLayerVersion( + getLayerVersion(args: GetLayerVersionCommandInput, cb: (err: any, data?: GetLayerVersionCommandOutput) => void): void; + getLayerVersion( args: GetLayerVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLayerVersionCommandOutput) => void ): void; - public getLayerVersion( - args: GetLayerVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLayerVersionCommandOutput) => void), - cb?: (err: any, data?: GetLayerVersionCommandOutput) => void - ): Promise | void { - const command = new GetLayerVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a version of an Lambda - * layer, with a link to download the layer archive - * that's valid for 10 minutes.

- */ - public getLayerVersionByArn( + + /** + * @see {@link GetLayerVersionByArnCommand} + */ + getLayerVersionByArn( args: GetLayerVersionByArnCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLayerVersionByArn( + getLayerVersionByArn( args: GetLayerVersionByArnCommandInput, cb: (err: any, data?: GetLayerVersionByArnCommandOutput) => void ): void; - public getLayerVersionByArn( + getLayerVersionByArn( args: GetLayerVersionByArnCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLayerVersionByArnCommandOutput) => void ): void; - public getLayerVersionByArn( - args: GetLayerVersionByArnCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLayerVersionByArnCommandOutput) => void), - cb?: (err: any, data?: GetLayerVersionByArnCommandOutput) => void - ): Promise | void { - const command = new GetLayerVersionByArnCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the permission policy for a version of an Lambda - * layer. For more information, see AddLayerVersionPermission.

- */ - public getLayerVersionPolicy( + + /** + * @see {@link GetLayerVersionPolicyCommand} + */ + getLayerVersionPolicy( args: GetLayerVersionPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLayerVersionPolicy( + getLayerVersionPolicy( args: GetLayerVersionPolicyCommandInput, cb: (err: any, data?: GetLayerVersionPolicyCommandOutput) => void ): void; - public getLayerVersionPolicy( + getLayerVersionPolicy( args: GetLayerVersionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLayerVersionPolicyCommandOutput) => void ): void; - public getLayerVersionPolicy( - args: GetLayerVersionPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLayerVersionPolicyCommandOutput) => void), - cb?: (err: any, data?: GetLayerVersionPolicyCommandOutput) => void - ): Promise | void { - const command = new GetLayerVersionPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the resource-based IAM policy for a function, version, or alias.

- */ - public getPolicy(args: GetPolicyCommandInput, options?: __HttpHandlerOptions): Promise; - public getPolicy(args: GetPolicyCommandInput, cb: (err: any, data?: GetPolicyCommandOutput) => void): void; - public getPolicy( + + /** + * @see {@link GetPolicyCommand} + */ + getPolicy(args: GetPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + getPolicy(args: GetPolicyCommandInput, cb: (err: any, data?: GetPolicyCommandOutput) => void): void; + getPolicy( args: GetPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPolicyCommandOutput) => void ): void; - public getPolicy( - args: GetPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPolicyCommandOutput) => void), - cb?: (err: any, data?: GetPolicyCommandOutput) => void - ): Promise | void { - const command = new GetPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the provisioned concurrency configuration for a function's alias or version.

- */ - public getProvisionedConcurrencyConfig( + + /** + * @see {@link GetProvisionedConcurrencyConfigCommand} + */ + getProvisionedConcurrencyConfig( args: GetProvisionedConcurrencyConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getProvisionedConcurrencyConfig( + getProvisionedConcurrencyConfig( args: GetProvisionedConcurrencyConfigCommandInput, cb: (err: any, data?: GetProvisionedConcurrencyConfigCommandOutput) => void ): void; - public getProvisionedConcurrencyConfig( + getProvisionedConcurrencyConfig( args: GetProvisionedConcurrencyConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProvisionedConcurrencyConfigCommandOutput) => void ): void; - public getProvisionedConcurrencyConfig( - args: GetProvisionedConcurrencyConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetProvisionedConcurrencyConfigCommandOutput) => void), - cb?: (err: any, data?: GetProvisionedConcurrencyConfigCommandOutput) => void - ): Promise | void { - const command = new GetProvisionedConcurrencyConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the runtime management configuration for a function's version. If the runtime update mode is Manual, this includes the ARN of the - * runtime version and the runtime update mode. If the runtime update mode is Auto or Function update, - * this includes the runtime update mode and null is returned for the ARN. For more information, see Runtime updates.

- */ - public getRuntimeManagementConfig( + + /** + * @see {@link GetRuntimeManagementConfigCommand} + */ + getRuntimeManagementConfig( args: GetRuntimeManagementConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRuntimeManagementConfig( + getRuntimeManagementConfig( args: GetRuntimeManagementConfigCommandInput, cb: (err: any, data?: GetRuntimeManagementConfigCommandOutput) => void ): void; - public getRuntimeManagementConfig( + getRuntimeManagementConfig( args: GetRuntimeManagementConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRuntimeManagementConfigCommandOutput) => void ): void; - public getRuntimeManagementConfig( - args: GetRuntimeManagementConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRuntimeManagementConfigCommandOutput) => void), - cb?: (err: any, data?: GetRuntimeManagementConfigCommandOutput) => void - ): Promise | void { - const command = new GetRuntimeManagementConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or - * asynchronously. To invoke a function asynchronously, set InvocationType to Event.

- *

For synchronous invocation, - * details about the function response, including errors, are included in the response body and headers. For either - * invocation type, you can find more information in the execution log and trace.

- *

When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, - * client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an - * error, Lambda executes the function up to two more times. For more information, see Error handling and automatic retries in - * Lambda.

- *

For asynchronous invocation, - * Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity - * to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple - * times, even if no error occurs. To retain events that were not processed, configure your function with a dead-letter queue.

- *

The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that - * prevent your function from executing, such as permissions errors, quota errors, or issues with your function's code and - * configuration. For example, Lambda returns TooManyRequestsException if running the - * function would cause you to exceed a concurrency limit at either the account level - * (ConcurrentInvocationLimitExceeded) or function level - * (ReservedFunctionConcurrentInvocationLimitExceeded).

- *

For functions with a long timeout, your client might disconnect during synchronous invocation while it waits - * for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long - * connections with timeout or keep-alive settings.

- *

This operation requires permission for the lambda:InvokeFunction action. For details on how to set up - * permissions for cross-account invocations, see Granting function - * access to other accounts.

- */ - public invoke(args: InvokeCommandInput, options?: __HttpHandlerOptions): Promise; - public invoke(args: InvokeCommandInput, cb: (err: any, data?: InvokeCommandOutput) => void): void; - public invoke( + + /** + * @see {@link InvokeCommand} + */ + invoke(args: InvokeCommandInput, options?: __HttpHandlerOptions): Promise; + invoke(args: InvokeCommandInput, cb: (err: any, data?: InvokeCommandOutput) => void): void; + invoke( args: InvokeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InvokeCommandOutput) => void ): void; - public invoke( - args: InvokeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InvokeCommandOutput) => void), - cb?: (err: any, data?: InvokeCommandOutput) => void - ): Promise | void { - const command = new InvokeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * @deprecated - * - * - *

For asynchronous function invocation, use Invoke.

- *
- *

Invokes a function asynchronously.

- */ - public invokeAsync(args: InvokeAsyncCommandInput, options?: __HttpHandlerOptions): Promise; - public invokeAsync(args: InvokeAsyncCommandInput, cb: (err: any, data?: InvokeAsyncCommandOutput) => void): void; - public invokeAsync( + + /** + * @see {@link InvokeAsyncCommand} + */ + invokeAsync(args: InvokeAsyncCommandInput, options?: __HttpHandlerOptions): Promise; + invokeAsync(args: InvokeAsyncCommandInput, cb: (err: any, data?: InvokeAsyncCommandOutput) => void): void; + invokeAsync( args: InvokeAsyncCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InvokeAsyncCommandOutput) => void ): void; - public invokeAsync( - args: InvokeAsyncCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InvokeAsyncCommandOutput) => void), - cb?: (err: any, data?: InvokeAsyncCommandOutput) => void - ): Promise | void { - const command = new InvokeAsyncCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Configure your Lambda functions to stream response payloads back to clients. For more information, see Configuring a Lambda function to stream responses.

- *

This operation requires permission for the lambda:InvokeFunction action. For details on how to set up - * permissions for cross-account invocations, see Granting function - * access to other accounts.

- */ - public invokeWithResponseStream( + + /** + * @see {@link InvokeWithResponseStreamCommand} + */ + invokeWithResponseStream( args: InvokeWithResponseStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public invokeWithResponseStream( + invokeWithResponseStream( args: InvokeWithResponseStreamCommandInput, cb: (err: any, data?: InvokeWithResponseStreamCommandOutput) => void ): void; - public invokeWithResponseStream( + invokeWithResponseStream( args: InvokeWithResponseStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InvokeWithResponseStreamCommandOutput) => void ): void; - public invokeWithResponseStream( - args: InvokeWithResponseStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InvokeWithResponseStreamCommandOutput) => void), - cb?: (err: any, data?: InvokeWithResponseStreamCommandOutput) => void - ): Promise | void { - const command = new InvokeWithResponseStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of aliases - * for a Lambda function.

- */ - public listAliases(args: ListAliasesCommandInput, options?: __HttpHandlerOptions): Promise; - public listAliases(args: ListAliasesCommandInput, cb: (err: any, data?: ListAliasesCommandOutput) => void): void; - public listAliases( + + /** + * @see {@link ListAliasesCommand} + */ + listAliases(args: ListAliasesCommandInput, options?: __HttpHandlerOptions): Promise; + listAliases(args: ListAliasesCommandInput, cb: (err: any, data?: ListAliasesCommandOutput) => void): void; + listAliases( args: ListAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAliasesCommandOutput) => void ): void; - public listAliases( - args: ListAliasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAliasesCommandOutput) => void), - cb?: (err: any, data?: ListAliasesCommandOutput) => void - ): Promise | void { - const command = new ListAliasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of code - * signing configurations. A request returns up to 10,000 configurations per - * call. You can use the MaxItems parameter to return fewer configurations per call.

- */ - public listCodeSigningConfigs( + + /** + * @see {@link ListCodeSigningConfigsCommand} + */ + listCodeSigningConfigs( args: ListCodeSigningConfigsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCodeSigningConfigs( + listCodeSigningConfigs( args: ListCodeSigningConfigsCommandInput, cb: (err: any, data?: ListCodeSigningConfigsCommandOutput) => void ): void; - public listCodeSigningConfigs( + listCodeSigningConfigs( args: ListCodeSigningConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCodeSigningConfigsCommandOutput) => void ): void; - public listCodeSigningConfigs( - args: ListCodeSigningConfigsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCodeSigningConfigsCommandOutput) => void), - cb?: (err: any, data?: ListCodeSigningConfigsCommandOutput) => void - ): Promise | void { - const command = new ListCodeSigningConfigsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists event source mappings. Specify an EventSourceArn to show only event source mappings for a - * single event source.

- */ - public listEventSourceMappings( + + /** + * @see {@link ListEventSourceMappingsCommand} + */ + listEventSourceMappings( args: ListEventSourceMappingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEventSourceMappings( + listEventSourceMappings( args: ListEventSourceMappingsCommandInput, cb: (err: any, data?: ListEventSourceMappingsCommandOutput) => void ): void; - public listEventSourceMappings( + listEventSourceMappings( args: ListEventSourceMappingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventSourceMappingsCommandOutput) => void ): void; - public listEventSourceMappings( - args: ListEventSourceMappingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEventSourceMappingsCommandOutput) => void), - cb?: (err: any, data?: ListEventSourceMappingsCommandOutput) => void - ): Promise | void { - const command = new ListEventSourceMappingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of configurations for asynchronous invocation for a function.

- *

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

- */ - public listFunctionEventInvokeConfigs( + + /** + * @see {@link ListFunctionEventInvokeConfigsCommand} + */ + listFunctionEventInvokeConfigs( args: ListFunctionEventInvokeConfigsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFunctionEventInvokeConfigs( + listFunctionEventInvokeConfigs( args: ListFunctionEventInvokeConfigsCommandInput, cb: (err: any, data?: ListFunctionEventInvokeConfigsCommandOutput) => void ): void; - public listFunctionEventInvokeConfigs( + listFunctionEventInvokeConfigs( args: ListFunctionEventInvokeConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFunctionEventInvokeConfigsCommandOutput) => void ): void; - public listFunctionEventInvokeConfigs( - args: ListFunctionEventInvokeConfigsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFunctionEventInvokeConfigsCommandOutput) => void), - cb?: (err: any, data?: ListFunctionEventInvokeConfigsCommandOutput) => void - ): Promise | void { - const command = new ListFunctionEventInvokeConfigsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 - * functions per call.

- *

Set FunctionVersion to ALL to include all published versions of each function in - * addition to the unpublished version.

- * - *

The ListFunctions operation returns a subset of the FunctionConfiguration fields. - * To get the additional fields (State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason, - * LastUpdateStatusReasonCode, RuntimeVersionConfig) for a function or version, use GetFunction.

- *
- */ - public listFunctions( - args: ListFunctionsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listFunctions( - args: ListFunctionsCommandInput, - cb: (err: any, data?: ListFunctionsCommandOutput) => void - ): void; - public listFunctions( + + /** + * @see {@link ListFunctionsCommand} + */ + listFunctions(args: ListFunctionsCommandInput, options?: __HttpHandlerOptions): Promise; + listFunctions(args: ListFunctionsCommandInput, cb: (err: any, data?: ListFunctionsCommandOutput) => void): void; + listFunctions( args: ListFunctionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFunctionsCommandOutput) => void ): void; - public listFunctions( - args: ListFunctionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFunctionsCommandOutput) => void), - cb?: (err: any, data?: ListFunctionsCommandOutput) => void - ): Promise | void { - const command = new ListFunctionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List the functions that use the specified code signing configuration. You can use this method prior to deleting a - * code signing configuration, to verify that no functions are using it.

- */ - public listFunctionsByCodeSigningConfig( + + /** + * @see {@link ListFunctionsByCodeSigningConfigCommand} + */ + listFunctionsByCodeSigningConfig( args: ListFunctionsByCodeSigningConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFunctionsByCodeSigningConfig( + listFunctionsByCodeSigningConfig( args: ListFunctionsByCodeSigningConfigCommandInput, cb: (err: any, data?: ListFunctionsByCodeSigningConfigCommandOutput) => void ): void; - public listFunctionsByCodeSigningConfig( + listFunctionsByCodeSigningConfig( args: ListFunctionsByCodeSigningConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFunctionsByCodeSigningConfigCommandOutput) => void ): void; - public listFunctionsByCodeSigningConfig( - args: ListFunctionsByCodeSigningConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFunctionsByCodeSigningConfigCommandOutput) => void), - cb?: (err: any, data?: ListFunctionsByCodeSigningConfigCommandOutput) => void - ): Promise | void { - const command = new ListFunctionsByCodeSigningConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of Lambda function URLs for the specified function.

- */ - public listFunctionUrlConfigs( + + /** + * @see {@link ListFunctionUrlConfigsCommand} + */ + listFunctionUrlConfigs( args: ListFunctionUrlConfigsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFunctionUrlConfigs( + listFunctionUrlConfigs( args: ListFunctionUrlConfigsCommandInput, cb: (err: any, data?: ListFunctionUrlConfigsCommandOutput) => void ): void; - public listFunctionUrlConfigs( + listFunctionUrlConfigs( args: ListFunctionUrlConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFunctionUrlConfigsCommandOutput) => void ): void; - public listFunctionUrlConfigs( - args: ListFunctionUrlConfigsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFunctionUrlConfigsCommandOutput) => void), - cb?: (err: any, data?: ListFunctionUrlConfigsCommandOutput) => void - ): Promise | void { - const command = new ListFunctionUrlConfigsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists Lambda - * layers and shows information about the latest version of each. Specify a - * runtime - * identifier to list only layers that indicate that they're compatible with that - * runtime. Specify a compatible architecture to include only layers that are compatible with - * that instruction set architecture.

- */ - public listLayers(args: ListLayersCommandInput, options?: __HttpHandlerOptions): Promise; - public listLayers(args: ListLayersCommandInput, cb: (err: any, data?: ListLayersCommandOutput) => void): void; - public listLayers( + + /** + * @see {@link ListLayersCommand} + */ + listLayers(args: ListLayersCommandInput, options?: __HttpHandlerOptions): Promise; + listLayers(args: ListLayersCommandInput, cb: (err: any, data?: ListLayersCommandOutput) => void): void; + listLayers( args: ListLayersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLayersCommandOutput) => void ): void; - public listLayers( - args: ListLayersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLayersCommandOutput) => void), - cb?: (err: any, data?: ListLayersCommandOutput) => void - ): Promise | void { - const command = new ListLayersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the versions of an Lambda - * layer. Versions that have been deleted aren't listed. Specify a runtime identifier to list only - * versions that indicate that they're compatible with that runtime. Specify a compatible architecture to include only - * layer versions that are compatible with that architecture.

- */ - public listLayerVersions( + + /** + * @see {@link ListLayerVersionsCommand} + */ + listLayerVersions( args: ListLayerVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLayerVersions( + listLayerVersions( args: ListLayerVersionsCommandInput, cb: (err: any, data?: ListLayerVersionsCommandOutput) => void ): void; - public listLayerVersions( + listLayerVersions( args: ListLayerVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLayerVersionsCommandOutput) => void ): void; - public listLayerVersions( - args: ListLayerVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLayerVersionsCommandOutput) => void), - cb?: (err: any, data?: ListLayerVersionsCommandOutput) => void - ): Promise | void { - const command = new ListLayerVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of provisioned concurrency configurations for a function.

- */ - public listProvisionedConcurrencyConfigs( + + /** + * @see {@link ListProvisionedConcurrencyConfigsCommand} + */ + listProvisionedConcurrencyConfigs( args: ListProvisionedConcurrencyConfigsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProvisionedConcurrencyConfigs( + listProvisionedConcurrencyConfigs( args: ListProvisionedConcurrencyConfigsCommandInput, cb: (err: any, data?: ListProvisionedConcurrencyConfigsCommandOutput) => void ): void; - public listProvisionedConcurrencyConfigs( + listProvisionedConcurrencyConfigs( args: ListProvisionedConcurrencyConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProvisionedConcurrencyConfigsCommandOutput) => void ): void; - public listProvisionedConcurrencyConfigs( - args: ListProvisionedConcurrencyConfigsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProvisionedConcurrencyConfigsCommandOutput) => void), - cb?: (err: any, data?: ListProvisionedConcurrencyConfigsCommandOutput) => void - ): Promise | void { - const command = new ListProvisionedConcurrencyConfigsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a function's tags. You can - * also view tags with GetFunction.

- */ - public listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; - public listTags( + + /** + * @see {@link ListTagsCommand} + */ + listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; + listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; + listTags( args: ListTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsCommandOutput) => void ): void; - public listTags( - args: ListTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsCommandOutput) => void), - cb?: (err: any, data?: ListTagsCommandOutput) => void - ): Promise | void { - const command = new ListTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of versions, - * with the version-specific configuration of each. Lambda returns up to 50 versions per call.

- */ - public listVersionsByFunction( + + /** + * @see {@link ListVersionsByFunctionCommand} + */ + listVersionsByFunction( args: ListVersionsByFunctionCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVersionsByFunction( + listVersionsByFunction( args: ListVersionsByFunctionCommandInput, cb: (err: any, data?: ListVersionsByFunctionCommandOutput) => void ): void; - public listVersionsByFunction( + listVersionsByFunction( args: ListVersionsByFunctionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVersionsByFunctionCommandOutput) => void ): void; - public listVersionsByFunction( - args: ListVersionsByFunctionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVersionsByFunctionCommandOutput) => void), - cb?: (err: any, data?: ListVersionsByFunctionCommandOutput) => void - ): Promise | void { - const command = new ListVersionsByFunctionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Lambda - * layer from a ZIP archive. Each time you call PublishLayerVersion with the same - * layer name, a new version is created.

- *

Add layers to your function with CreateFunction or UpdateFunctionConfiguration.

- */ - public publishLayerVersion( + + /** + * @see {@link PublishLayerVersionCommand} + */ + publishLayerVersion( args: PublishLayerVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public publishLayerVersion( + publishLayerVersion( args: PublishLayerVersionCommandInput, cb: (err: any, data?: PublishLayerVersionCommandOutput) => void ): void; - public publishLayerVersion( + publishLayerVersion( args: PublishLayerVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishLayerVersionCommandOutput) => void ): void; - public publishLayerVersion( - args: PublishLayerVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PublishLayerVersionCommandOutput) => void), - cb?: (err: any, data?: PublishLayerVersionCommandOutput) => void - ): Promise | void { - const command = new PublishLayerVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a version from the - * current code and configuration of a function. Use versions to create a snapshot of your function code and - * configuration that doesn't change.

- *

Lambda doesn't publish a version if the function's configuration and code haven't changed since the last - * version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the - * function before publishing a version.

- *

Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias.

- */ - public publishVersion( + + /** + * @see {@link PublishVersionCommand} + */ + publishVersion( args: PublishVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public publishVersion( - args: PublishVersionCommandInput, - cb: (err: any, data?: PublishVersionCommandOutput) => void - ): void; - public publishVersion( + publishVersion(args: PublishVersionCommandInput, cb: (err: any, data?: PublishVersionCommandOutput) => void): void; + publishVersion( args: PublishVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishVersionCommandOutput) => void ): void; - public publishVersion( - args: PublishVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PublishVersionCommandOutput) => void), - cb?: (err: any, data?: PublishVersionCommandOutput) => void - ): Promise | void { - const command = new PublishVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update the code signing configuration for the function. Changes to the code signing configuration take effect the - * next time a user tries to deploy a code package to the function.

- */ - public putFunctionCodeSigningConfig( + + /** + * @see {@link PutFunctionCodeSigningConfigCommand} + */ + putFunctionCodeSigningConfig( args: PutFunctionCodeSigningConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public putFunctionCodeSigningConfig( + putFunctionCodeSigningConfig( args: PutFunctionCodeSigningConfigCommandInput, cb: (err: any, data?: PutFunctionCodeSigningConfigCommandOutput) => void ): void; - public putFunctionCodeSigningConfig( + putFunctionCodeSigningConfig( args: PutFunctionCodeSigningConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutFunctionCodeSigningConfigCommandOutput) => void ): void; - public putFunctionCodeSigningConfig( - args: PutFunctionCodeSigningConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutFunctionCodeSigningConfigCommandOutput) => void), - cb?: (err: any, data?: PutFunctionCodeSigningConfigCommandOutput) => void - ): Promise | void { - const command = new PutFunctionCodeSigningConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency - * level.

- *

Concurrency settings apply to the function as a whole, including all published versions and the unpublished - * version. Reserving concurrency both ensures that your function has capacity to process the specified number of - * events simultaneously, and prevents it from scaling beyond that level. Use GetFunction to see - * the current setting for a function.

- *

Use GetAccountSettings to see your Regional concurrency limit. You can reserve concurrency - * for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for - * functions that aren't configured with a per-function limit. For more information, see Lambda function scaling.

- */ - public putFunctionConcurrency( + + /** + * @see {@link PutFunctionConcurrencyCommand} + */ + putFunctionConcurrency( args: PutFunctionConcurrencyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putFunctionConcurrency( + putFunctionConcurrency( args: PutFunctionConcurrencyCommandInput, cb: (err: any, data?: PutFunctionConcurrencyCommandOutput) => void ): void; - public putFunctionConcurrency( + putFunctionConcurrency( args: PutFunctionConcurrencyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutFunctionConcurrencyCommandOutput) => void ): void; - public putFunctionConcurrency( - args: PutFunctionConcurrencyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutFunctionConcurrencyCommandOutput) => void), - cb?: (err: any, data?: PutFunctionConcurrencyCommandOutput) => void - ): Promise | void { - const command = new PutFunctionConcurrencyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Configures options for asynchronous - * invocation on a function, version, or alias. If a configuration already exists for a function, version, - * or alias, this operation overwrites it. If you exclude any settings, they are removed. To set one option without - * affecting existing settings for other options, use UpdateFunctionEventInvokeConfig.

- *

By default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains - * events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous - * invocation queue for too long, Lambda discards it. To retain discarded events, configure a dead-letter queue with - * UpdateFunctionConfiguration.

- *

To send an invocation record to a queue, topic, function, or event bus, specify a destination. You can configure separate destinations for successful invocations (on-success) and events - * that fail all processing attempts (on-failure). You can configure destinations in addition to or instead of a - * dead-letter queue.

- */ - public putFunctionEventInvokeConfig( + + /** + * @see {@link PutFunctionEventInvokeConfigCommand} + */ + putFunctionEventInvokeConfig( args: PutFunctionEventInvokeConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public putFunctionEventInvokeConfig( + putFunctionEventInvokeConfig( args: PutFunctionEventInvokeConfigCommandInput, cb: (err: any, data?: PutFunctionEventInvokeConfigCommandOutput) => void ): void; - public putFunctionEventInvokeConfig( + putFunctionEventInvokeConfig( args: PutFunctionEventInvokeConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutFunctionEventInvokeConfigCommandOutput) => void ): void; - public putFunctionEventInvokeConfig( - args: PutFunctionEventInvokeConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutFunctionEventInvokeConfigCommandOutput) => void), - cb?: (err: any, data?: PutFunctionEventInvokeConfigCommandOutput) => void - ): Promise | void { - const command = new PutFunctionEventInvokeConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds a provisioned concurrency configuration to a function's alias or version.

- */ - public putProvisionedConcurrencyConfig( + + /** + * @see {@link PutProvisionedConcurrencyConfigCommand} + */ + putProvisionedConcurrencyConfig( args: PutProvisionedConcurrencyConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public putProvisionedConcurrencyConfig( + putProvisionedConcurrencyConfig( args: PutProvisionedConcurrencyConfigCommandInput, cb: (err: any, data?: PutProvisionedConcurrencyConfigCommandOutput) => void ): void; - public putProvisionedConcurrencyConfig( + putProvisionedConcurrencyConfig( args: PutProvisionedConcurrencyConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutProvisionedConcurrencyConfigCommandOutput) => void ): void; - public putProvisionedConcurrencyConfig( - args: PutProvisionedConcurrencyConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutProvisionedConcurrencyConfigCommandOutput) => void), - cb?: (err: any, data?: PutProvisionedConcurrencyConfigCommandOutput) => void - ): Promise | void { - const command = new PutProvisionedConcurrencyConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the runtime management configuration for a function's version. For more information, - * see Runtime updates.

- */ - public putRuntimeManagementConfig( + + /** + * @see {@link PutRuntimeManagementConfigCommand} + */ + putRuntimeManagementConfig( args: PutRuntimeManagementConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public putRuntimeManagementConfig( + putRuntimeManagementConfig( args: PutRuntimeManagementConfigCommandInput, cb: (err: any, data?: PutRuntimeManagementConfigCommandOutput) => void ): void; - public putRuntimeManagementConfig( + putRuntimeManagementConfig( args: PutRuntimeManagementConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRuntimeManagementConfigCommandOutput) => void ): void; - public putRuntimeManagementConfig( - args: PutRuntimeManagementConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRuntimeManagementConfigCommandOutput) => void), - cb?: (err: any, data?: PutRuntimeManagementConfigCommandOutput) => void - ): Promise | void { - const command = new PutRuntimeManagementConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a statement from the permissions policy for a version of an Lambda - * layer. For more information, see - * AddLayerVersionPermission.

- */ - public removeLayerVersionPermission( + + /** + * @see {@link RemoveLayerVersionPermissionCommand} + */ + removeLayerVersionPermission( args: RemoveLayerVersionPermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeLayerVersionPermission( + removeLayerVersionPermission( args: RemoveLayerVersionPermissionCommandInput, cb: (err: any, data?: RemoveLayerVersionPermissionCommandOutput) => void ): void; - public removeLayerVersionPermission( + removeLayerVersionPermission( args: RemoveLayerVersionPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveLayerVersionPermissionCommandOutput) => void ): void; - public removeLayerVersionPermission( - args: RemoveLayerVersionPermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveLayerVersionPermissionCommandOutput) => void), - cb?: (err: any, data?: RemoveLayerVersionPermissionCommandOutput) => void - ): Promise | void { - const command = new RemoveLayerVersionPermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Revokes function-use permission from an Amazon Web Service or another Amazon Web Services account. You - * can get the ID of the statement from the output of GetPolicy.

- */ - public removePermission( + + /** + * @see {@link RemovePermissionCommand} + */ + removePermission( args: RemovePermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public removePermission( + removePermission( args: RemovePermissionCommandInput, cb: (err: any, data?: RemovePermissionCommandOutput) => void ): void; - public removePermission( + removePermission( args: RemovePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemovePermissionCommandOutput) => void ): void; - public removePermission( - args: RemovePermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemovePermissionCommandOutput) => void), - cb?: (err: any, data?: RemovePermissionCommandOutput) => void - ): Promise | void { - const command = new RemovePermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds tags to a function.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes tags from a function.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the configuration of a Lambda function alias.

- */ - public updateAlias(args: UpdateAliasCommandInput, options?: __HttpHandlerOptions): Promise; - public updateAlias(args: UpdateAliasCommandInput, cb: (err: any, data?: UpdateAliasCommandOutput) => void): void; - public updateAlias( + + /** + * @see {@link UpdateAliasCommand} + */ + updateAlias(args: UpdateAliasCommandInput, options?: __HttpHandlerOptions): Promise; + updateAlias(args: UpdateAliasCommandInput, cb: (err: any, data?: UpdateAliasCommandOutput) => void): void; + updateAlias( args: UpdateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAliasCommandOutput) => void ): void; - public updateAlias( - args: UpdateAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAliasCommandOutput) => void), - cb?: (err: any, data?: UpdateAliasCommandOutput) => void - ): Promise | void { - const command = new UpdateAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update the code signing configuration. Changes to the code signing configuration take effect the next time a - * user tries to deploy a code package to the function.

- */ - public updateCodeSigningConfig( + + /** + * @see {@link UpdateCodeSigningConfigCommand} + */ + updateCodeSigningConfig( args: UpdateCodeSigningConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCodeSigningConfig( + updateCodeSigningConfig( args: UpdateCodeSigningConfigCommandInput, cb: (err: any, data?: UpdateCodeSigningConfigCommandOutput) => void ): void; - public updateCodeSigningConfig( + updateCodeSigningConfig( args: UpdateCodeSigningConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCodeSigningConfigCommandOutput) => void ): void; - public updateCodeSigningConfig( - args: UpdateCodeSigningConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCodeSigningConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateCodeSigningConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateCodeSigningConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an event source mapping. You can change the function that Lambda invokes, or pause - * invocation and resume later from the same location.

- *

For details about how to configure different event sources, see the following topics.

- * - *

The following error handling options are available only for stream sources (DynamoDB and Kinesis):

- *
    - *
  • - *

    - * BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.

    - *
  • - *
  • - *

    - * DestinationConfig – Send discarded records to an Amazon SQS queue or Amazon SNS topic.

    - *
  • - *
  • - *

    - * MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires

    - *
  • - *
  • - *

    - * MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

    - *
  • - *
  • - *

    - * ParallelizationFactor – Process multiple batches from each shard concurrently.

    - *
  • - *
- *

For information about which configuration parameters apply to each event source, see the following topics.

- * - */ - public updateEventSourceMapping( + + /** + * @see {@link UpdateEventSourceMappingCommand} + */ + updateEventSourceMapping( args: UpdateEventSourceMappingCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEventSourceMapping( + updateEventSourceMapping( args: UpdateEventSourceMappingCommandInput, cb: (err: any, data?: UpdateEventSourceMappingCommandOutput) => void ): void; - public updateEventSourceMapping( + updateEventSourceMapping( args: UpdateEventSourceMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEventSourceMappingCommandOutput) => void ): void; - public updateEventSourceMapping( - args: UpdateEventSourceMappingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEventSourceMappingCommandOutput) => void), - cb?: (err: any, data?: UpdateEventSourceMappingCommandOutput) => void - ): Promise | void { - const command = new UpdateEventSourceMappingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a Lambda function's code. If code signing is enabled for the function, the code package - * must be signed by a trusted publisher. For more information, see Configuring code signing for Lambda.

- *

If the function's package type is Image, then you must specify the code package in - * ImageUri as the URI of a container image in the Amazon ECR registry.

- *

If the function's package type is Zip, then you must specify the deployment package as a .zip file - * archive. Enter the Amazon S3 bucket and key of the code .zip file location. You can also provide - * the function code inline using the ZipFile field.

- *

The code in the deployment package must be compatible with the target instruction set architecture of the - * function (x86-64 or arm64).

- *

The function's code is locked when you publish a version. You can't modify the code of a published version, - * only the unpublished version.

- * - *

For a function defined as a container image, Lambda resolves the image tag to an image digest. In - * Amazon ECR, if you update the image tag to a new image, Lambda does not automatically - * update the function.

- *
- */ - public updateFunctionCode( + + /** + * @see {@link UpdateFunctionCodeCommand} + */ + updateFunctionCode( args: UpdateFunctionCodeCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFunctionCode( + updateFunctionCode( args: UpdateFunctionCodeCommandInput, cb: (err: any, data?: UpdateFunctionCodeCommandOutput) => void ): void; - public updateFunctionCode( + updateFunctionCode( args: UpdateFunctionCodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFunctionCodeCommandOutput) => void ): void; - public updateFunctionCode( - args: UpdateFunctionCodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFunctionCodeCommandOutput) => void), - cb?: (err: any, data?: UpdateFunctionCodeCommandOutput) => void - ): Promise | void { - const command = new UpdateFunctionCodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modify the version-specific settings of a Lambda function.

- *

When you update a function, Lambda provisions an instance of the function and its supporting - * resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify - * the function, but you can still invoke it. The LastUpdateStatus, LastUpdateStatusReason, - * and LastUpdateStatusReasonCode fields in the response from GetFunctionConfiguration - * indicate when the update is complete and the function is processing events with the new configuration. For more - * information, see Lambda - * function states.

- *

These settings can vary between versions of a function and are locked when you publish a version. You can't - * modify the configuration of a published version, only the unpublished version.

- *

To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions - * to an Amazon Web Services account or Amazon Web Service, use AddPermission.

- */ - public updateFunctionConfiguration( + + /** + * @see {@link UpdateFunctionConfigurationCommand} + */ + updateFunctionConfiguration( args: UpdateFunctionConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFunctionConfiguration( + updateFunctionConfiguration( args: UpdateFunctionConfigurationCommandInput, cb: (err: any, data?: UpdateFunctionConfigurationCommandOutput) => void ): void; - public updateFunctionConfiguration( + updateFunctionConfiguration( args: UpdateFunctionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFunctionConfigurationCommandOutput) => void ): void; - public updateFunctionConfiguration( - args: UpdateFunctionConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFunctionConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateFunctionConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateFunctionConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the configuration for asynchronous invocation for a function, version, or alias.

- *

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

- */ - public updateFunctionEventInvokeConfig( + + /** + * @see {@link UpdateFunctionEventInvokeConfigCommand} + */ + updateFunctionEventInvokeConfig( args: UpdateFunctionEventInvokeConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFunctionEventInvokeConfig( + updateFunctionEventInvokeConfig( args: UpdateFunctionEventInvokeConfigCommandInput, cb: (err: any, data?: UpdateFunctionEventInvokeConfigCommandOutput) => void ): void; - public updateFunctionEventInvokeConfig( + updateFunctionEventInvokeConfig( args: UpdateFunctionEventInvokeConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFunctionEventInvokeConfigCommandOutput) => void ): void; - public updateFunctionEventInvokeConfig( - args: UpdateFunctionEventInvokeConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFunctionEventInvokeConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateFunctionEventInvokeConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateFunctionEventInvokeConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the configuration for a Lambda function URL.

- */ - public updateFunctionUrlConfig( + + /** + * @see {@link UpdateFunctionUrlConfigCommand} + */ + updateFunctionUrlConfig( args: UpdateFunctionUrlConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFunctionUrlConfig( + updateFunctionUrlConfig( args: UpdateFunctionUrlConfigCommandInput, cb: (err: any, data?: UpdateFunctionUrlConfigCommandOutput) => void ): void; - public updateFunctionUrlConfig( + updateFunctionUrlConfig( args: UpdateFunctionUrlConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFunctionUrlConfigCommandOutput) => void ): void; - public updateFunctionUrlConfig( - args: UpdateFunctionUrlConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFunctionUrlConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateFunctionUrlConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateFunctionUrlConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Lambda + *

+ * Overview + *

+ *

Lambda is a compute service that lets you run code without provisioning or managing servers. + * Lambda runs your code on a high-availability compute infrastructure and performs all of the + * administration of the compute resources, including server and operating system maintenance, capacity provisioning + * and automatic scaling, code monitoring and logging. With Lambda, you can run code for virtually any + * type of application or backend service. For more information about the Lambda service, see What is Lambda in the Lambda Developer Guide.

+ *

The Lambda API Reference provides information about + * each of the API methods, including details about the parameters in each API request and + * response.

+ *

+ *

You can use Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command + * line tools to access the API. For installation instructions, see Tools for + * Amazon Web Services.

+ *

For a list of Region-specific endpoints that Lambda supports, + * see Lambda + * endpoints and quotas in the Amazon Web Services General Reference..

+ *

When making the API calls, you will need to + * authenticate your request by providing a signature. Lambda supports signature version 4. For more information, + * see Signature Version 4 signing process in the + * Amazon Web Services General Reference..

+ *

+ * CA certificates + *

+ *

Because Amazon Web Services SDKs use the CA certificates from your computer, changes to the certificates on the Amazon Web Services servers + * can cause connection failures when you attempt to use an SDK. You can prevent these failures by keeping your + * computer's CA certificates and operating system up-to-date. If you encounter this issue in a corporate + * environment and do not manage your own computer, you might need to ask an administrator to assist with the + * update process. The following list shows minimum operating system and Java versions:

+ *
    + *
  • + *

    Microsoft Windows versions that have updates from January 2005 or later installed contain at least one + * of the required CAs in their trust list.

    + *
  • + *
  • + *

    Mac OS X 10.4 with Java for Mac OS X 10.4 Release 5 (February 2007), Mac OS X 10.5 (October 2007), and + * later versions contain at least one of the required CAs in their trust list.

    + *
  • + *
  • + *

    Red Hat Enterprise Linux 5 (March 2007), 6, and 7 and CentOS 5, 6, and 7 all contain at least one of the + * required CAs in their default trusted CA list.

    + *
  • + *
  • + *

    Java 1.4.2_12 (May 2006), 5 Update 2 (March 2005), and all later versions, including Java 6 (December + * 2006), 7, and 8, contain at least one of the required CAs in their default trusted CA list.

    + *
  • + *
+ *

When accessing the Lambda management console or Lambda API endpoints, whether through browsers or + * programmatically, you will need to ensure your client machines support any of the following CAs:

+ *
    + *
  • + *

    Amazon Root CA 1

    + *
  • + *
  • + *

    Starfield Services Root Certificate Authority - G2

    + *
  • + *
  • + *

    Starfield Class 2 Certification Authority

    + *
  • + *
+ *

Root certificates from the first two authorities are available from Amazon trust services, but keeping your computer + * up-to-date is the more straightforward solution. To learn more about ACM-provided certificates, see Amazon Web Services Certificate Manager FAQs. + *

+ */ +export class Lambda extends LambdaClient implements Lambda {} +createAggregatedClient(commands, Lambda); diff --git a/clients/client-lex-model-building-service/src/LexModelBuildingService.ts b/clients/client-lex-model-building-service/src/LexModelBuildingService.ts index d22e6c494857..940e548f4554 100644 --- a/clients/client-lex-model-building-service/src/LexModelBuildingService.ts +++ b/clients/client-lex-model-building-service/src/LexModelBuildingService.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -151,1651 +152,637 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; -import { LexModelBuildingServiceClient } from "./LexModelBuildingServiceClient"; +import { LexModelBuildingServiceClient, LexModelBuildingServiceClientConfig } from "./LexModelBuildingServiceClient"; -/** - * @public - * Amazon Lex Build-Time Actions - *

Amazon Lex is an AWS service for building conversational voice and text - * interfaces. Use these actions to create, update, and delete conversational - * bots for new and existing client applications.

- */ -export class LexModelBuildingService extends LexModelBuildingServiceClient { +const commands = { + CreateBotVersionCommand, + CreateIntentVersionCommand, + CreateSlotTypeVersionCommand, + DeleteBotCommand, + DeleteBotAliasCommand, + DeleteBotChannelAssociationCommand, + DeleteBotVersionCommand, + DeleteIntentCommand, + DeleteIntentVersionCommand, + DeleteSlotTypeCommand, + DeleteSlotTypeVersionCommand, + DeleteUtterancesCommand, + GetBotCommand, + GetBotAliasCommand, + GetBotAliasesCommand, + GetBotChannelAssociationCommand, + GetBotChannelAssociationsCommand, + GetBotsCommand, + GetBotVersionsCommand, + GetBuiltinIntentCommand, + GetBuiltinIntentsCommand, + GetBuiltinSlotTypesCommand, + GetExportCommand, + GetImportCommand, + GetIntentCommand, + GetIntentsCommand, + GetIntentVersionsCommand, + GetMigrationCommand, + GetMigrationsCommand, + GetSlotTypeCommand, + GetSlotTypesCommand, + GetSlotTypeVersionsCommand, + GetUtterancesViewCommand, + ListTagsForResourceCommand, + PutBotCommand, + PutBotAliasCommand, + PutIntentCommand, + PutSlotTypeCommand, + StartImportCommand, + StartMigrationCommand, + TagResourceCommand, + UntagResourceCommand, +}; + +export interface LexModelBuildingService { /** - * @public - *

Creates a new version of the bot based on the $LATEST - * version. If the $LATEST version of this resource hasn't - * changed since you created the last version, Amazon Lex doesn't create a new - * version. It returns the last created version.

- * - *

You can update only the $LATEST version of the bot. - * You can't update the numbered versions that you create with the - * CreateBotVersion operation.

- *
- *

When you create the first version of a bot, Amazon Lex sets the version - * to 1. Subsequent versions increment by 1. For more information, see versioning-intro.

- *

This operation requires permission for the - * lex:CreateBotVersion action.

+ * @see {@link CreateBotVersionCommand} */ - public createBotVersion( + createBotVersion( args: CreateBotVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBotVersion( + createBotVersion( args: CreateBotVersionCommandInput, cb: (err: any, data?: CreateBotVersionCommandOutput) => void ): void; - public createBotVersion( + createBotVersion( args: CreateBotVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBotVersionCommandOutput) => void ): void; - public createBotVersion( - args: CreateBotVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBotVersionCommandOutput) => void), - cb?: (err: any, data?: CreateBotVersionCommandOutput) => void - ): Promise | void { - const command = new CreateBotVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new version of an intent based on the - * $LATEST version of the intent. If the $LATEST - * version of this intent hasn't changed since you last updated it, Amazon Lex - * doesn't create a new version. It returns the last version you - * created.

- * - *

You can update only the $LATEST version of the - * intent. You can't update the numbered versions that you create with the - * CreateIntentVersion operation.

- *
- *

When you create a version of an intent, Amazon Lex sets the version to - * 1. Subsequent versions increment by 1. For more information, see versioning-intro.

- *

This operation requires permissions to perform the - * lex:CreateIntentVersion action.

+ * @see {@link CreateIntentVersionCommand} */ - public createIntentVersion( + createIntentVersion( args: CreateIntentVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createIntentVersion( + createIntentVersion( args: CreateIntentVersionCommandInput, cb: (err: any, data?: CreateIntentVersionCommandOutput) => void ): void; - public createIntentVersion( + createIntentVersion( args: CreateIntentVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIntentVersionCommandOutput) => void ): void; - public createIntentVersion( - args: CreateIntentVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIntentVersionCommandOutput) => void), - cb?: (err: any, data?: CreateIntentVersionCommandOutput) => void - ): Promise | void { - const command = new CreateIntentVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new version of a slot type based on the - * $LATEST version of the specified slot type. If the - * $LATEST version of this resource has not changed since the - * last version that you created, Amazon Lex doesn't create a new version. It - * returns the last version that you created.

- * - *

You can update only the $LATEST version of a slot - * type. You can't update the numbered versions that you create with the - * CreateSlotTypeVersion operation.

- *
- * - *

When you create a version of a slot type, Amazon Lex sets the version to - * 1. Subsequent versions increment by 1. For more information, see versioning-intro.

- * - *

This operation requires permissions for the - * lex:CreateSlotTypeVersion action.

+ * @see {@link CreateSlotTypeVersionCommand} */ - public createSlotTypeVersion( + createSlotTypeVersion( args: CreateSlotTypeVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSlotTypeVersion( + createSlotTypeVersion( args: CreateSlotTypeVersionCommandInput, cb: (err: any, data?: CreateSlotTypeVersionCommandOutput) => void ): void; - public createSlotTypeVersion( + createSlotTypeVersion( args: CreateSlotTypeVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSlotTypeVersionCommandOutput) => void ): void; - public createSlotTypeVersion( - args: CreateSlotTypeVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSlotTypeVersionCommandOutput) => void), - cb?: (err: any, data?: CreateSlotTypeVersionCommandOutput) => void - ): Promise | void { - const command = new CreateSlotTypeVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes all versions of the bot, including the $LATEST - * version. To delete a specific version of the bot, use the DeleteBotVersion operation. The DeleteBot - * operation doesn't immediately remove the bot schema. Instead, it is marked - * for deletion and removed later.

- *

Amazon Lex stores utterances indefinitely for improving the ability of - * your bot to respond to user inputs. These utterances are not removed when - * the bot is deleted. To remove the utterances, use the DeleteUtterances operation.

- *

If a bot has an alias, you can't delete it. Instead, the - * DeleteBot operation returns a - * ResourceInUseException exception that includes a reference - * to the alias that refers to the bot. To remove the reference to the bot, - * delete the alias. If you get the same exception again, delete the - * referring alias until the DeleteBot operation is - * successful.

- * - *

This operation requires permissions for the - * lex:DeleteBot action.

+ * @see {@link DeleteBotCommand} */ - public deleteBot(args: DeleteBotCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteBot(args: DeleteBotCommandInput, cb: (err: any, data?: DeleteBotCommandOutput) => void): void; - public deleteBot( + deleteBot(args: DeleteBotCommandInput, options?: __HttpHandlerOptions): Promise; + deleteBot(args: DeleteBotCommandInput, cb: (err: any, data?: DeleteBotCommandOutput) => void): void; + deleteBot( args: DeleteBotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBotCommandOutput) => void ): void; - public deleteBot( - args: DeleteBotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBotCommandOutput) => void), - cb?: (err: any, data?: DeleteBotCommandOutput) => void - ): Promise | void { - const command = new DeleteBotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an alias for the specified bot.

- *

You can't delete an alias that is used in the association between a - * bot and a messaging channel. If an alias is used in a channel association, - * the DeleteBot operation returns a - * ResourceInUseException exception that includes a reference - * to the channel association that refers to the bot. You can remove the - * reference to the alias by deleting the channel association. If you get the - * same exception again, delete the referring association until the - * DeleteBotAlias operation is successful.

+ * @see {@link DeleteBotAliasCommand} */ - public deleteBotAlias( + deleteBotAlias( args: DeleteBotAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBotAlias( - args: DeleteBotAliasCommandInput, - cb: (err: any, data?: DeleteBotAliasCommandOutput) => void - ): void; - public deleteBotAlias( + deleteBotAlias(args: DeleteBotAliasCommandInput, cb: (err: any, data?: DeleteBotAliasCommandOutput) => void): void; + deleteBotAlias( args: DeleteBotAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBotAliasCommandOutput) => void ): void; - public deleteBotAlias( - args: DeleteBotAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBotAliasCommandOutput) => void), - cb?: (err: any, data?: DeleteBotAliasCommandOutput) => void - ): Promise | void { - const command = new DeleteBotAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the association between an Amazon Lex bot and a messaging - * platform.

- *

This operation requires permission for the - * lex:DeleteBotChannelAssociation action.

+ * @see {@link DeleteBotChannelAssociationCommand} */ - public deleteBotChannelAssociation( + deleteBotChannelAssociation( args: DeleteBotChannelAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBotChannelAssociation( + deleteBotChannelAssociation( args: DeleteBotChannelAssociationCommandInput, cb: (err: any, data?: DeleteBotChannelAssociationCommandOutput) => void ): void; - public deleteBotChannelAssociation( + deleteBotChannelAssociation( args: DeleteBotChannelAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBotChannelAssociationCommandOutput) => void ): void; - public deleteBotChannelAssociation( - args: DeleteBotChannelAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBotChannelAssociationCommandOutput) => void), - cb?: (err: any, data?: DeleteBotChannelAssociationCommandOutput) => void - ): Promise | void { - const command = new DeleteBotChannelAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a specific version of a bot. To delete all versions of a - * bot, use the DeleteBot operation.

- *

This operation requires permissions for the - * lex:DeleteBotVersion action.

+ * @see {@link DeleteBotVersionCommand} */ - public deleteBotVersion( + deleteBotVersion( args: DeleteBotVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBotVersion( + deleteBotVersion( args: DeleteBotVersionCommandInput, cb: (err: any, data?: DeleteBotVersionCommandOutput) => void ): void; - public deleteBotVersion( + deleteBotVersion( args: DeleteBotVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBotVersionCommandOutput) => void ): void; - public deleteBotVersion( - args: DeleteBotVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBotVersionCommandOutput) => void), - cb?: (err: any, data?: DeleteBotVersionCommandOutput) => void - ): Promise | void { - const command = new DeleteBotVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes all versions of the intent, including the - * $LATEST version. To delete a specific version of the - * intent, use the DeleteIntentVersion operation.

- *

You can delete a version of an intent only if it is not - * referenced. To delete an intent that is referred to in one or more bots - * (see how-it-works), you must remove those references - * first.

- * - *

If you get the ResourceInUseException exception, it - * provides an example reference that shows where the intent is referenced. - * To remove the reference to the intent, either update the bot or delete - * it. If you get the same exception when you attempt to delete the intent - * again, repeat until the intent has no references and the call to - * DeleteIntent is successful.

- *
- * - *

This operation requires permission for the - * lex:DeleteIntent action.

+ * @see {@link DeleteIntentCommand} */ - public deleteIntent( - args: DeleteIntentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteIntent(args: DeleteIntentCommandInput, cb: (err: any, data?: DeleteIntentCommandOutput) => void): void; - public deleteIntent( + deleteIntent(args: DeleteIntentCommandInput, options?: __HttpHandlerOptions): Promise; + deleteIntent(args: DeleteIntentCommandInput, cb: (err: any, data?: DeleteIntentCommandOutput) => void): void; + deleteIntent( args: DeleteIntentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIntentCommandOutput) => void ): void; - public deleteIntent( - args: DeleteIntentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIntentCommandOutput) => void), - cb?: (err: any, data?: DeleteIntentCommandOutput) => void - ): Promise | void { - const command = new DeleteIntentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a specific version of an intent. To delete all versions of - * a intent, use the DeleteIntent operation.

- *

This operation requires permissions for the - * lex:DeleteIntentVersion action.

+ * @see {@link DeleteIntentVersionCommand} */ - public deleteIntentVersion( + deleteIntentVersion( args: DeleteIntentVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteIntentVersion( + deleteIntentVersion( args: DeleteIntentVersionCommandInput, cb: (err: any, data?: DeleteIntentVersionCommandOutput) => void ): void; - public deleteIntentVersion( + deleteIntentVersion( args: DeleteIntentVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIntentVersionCommandOutput) => void ): void; - public deleteIntentVersion( - args: DeleteIntentVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIntentVersionCommandOutput) => void), - cb?: (err: any, data?: DeleteIntentVersionCommandOutput) => void - ): Promise | void { - const command = new DeleteIntentVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes all versions of the slot type, including the - * $LATEST version. To delete a specific version of the slot - * type, use the DeleteSlotTypeVersion operation.

- *

You can delete a version of a slot type only if it is not - * referenced. To delete a slot type that is referred to in one or more - * intents, you must remove those references first.

- * - *

If you get the ResourceInUseException exception, - * the exception provides an example reference that shows the intent where - * the slot type is referenced. To remove the reference to the slot type, - * either update the intent or delete it. If you get the same exception - * when you attempt to delete the slot type again, repeat until the slot - * type has no references and the DeleteSlotType call is - * successful.

- *
- *

This operation requires permission for the - * lex:DeleteSlotType action.

+ * @see {@link DeleteSlotTypeCommand} */ - public deleteSlotType( + deleteSlotType( args: DeleteSlotTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSlotType( - args: DeleteSlotTypeCommandInput, - cb: (err: any, data?: DeleteSlotTypeCommandOutput) => void - ): void; - public deleteSlotType( + deleteSlotType(args: DeleteSlotTypeCommandInput, cb: (err: any, data?: DeleteSlotTypeCommandOutput) => void): void; + deleteSlotType( args: DeleteSlotTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSlotTypeCommandOutput) => void ): void; - public deleteSlotType( - args: DeleteSlotTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSlotTypeCommandOutput) => void), - cb?: (err: any, data?: DeleteSlotTypeCommandOutput) => void - ): Promise | void { - const command = new DeleteSlotTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a specific version of a slot type. To delete all versions - * of a slot type, use the DeleteSlotType operation.

- *

This operation requires permissions for the - * lex:DeleteSlotTypeVersion action.

+ * @see {@link DeleteSlotTypeVersionCommand} */ - public deleteSlotTypeVersion( + deleteSlotTypeVersion( args: DeleteSlotTypeVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSlotTypeVersion( + deleteSlotTypeVersion( args: DeleteSlotTypeVersionCommandInput, cb: (err: any, data?: DeleteSlotTypeVersionCommandOutput) => void ): void; - public deleteSlotTypeVersion( + deleteSlotTypeVersion( args: DeleteSlotTypeVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSlotTypeVersionCommandOutput) => void ): void; - public deleteSlotTypeVersion( - args: DeleteSlotTypeVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSlotTypeVersionCommandOutput) => void), - cb?: (err: any, data?: DeleteSlotTypeVersionCommandOutput) => void - ): Promise | void { - const command = new DeleteSlotTypeVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes stored utterances.

- *

Amazon Lex stores the utterances that users send to your bot. Utterances - * are stored for 15 days for use with the GetUtterancesView operation, and then stored indefinitely for use in improving the - * ability of your bot to respond to user input.

- *

Use the DeleteUtterances operation to manually delete - * stored utterances for a specific user. When you use the - * DeleteUtterances operation, utterances stored for improving - * your bot's ability to respond to user input are deleted immediately. - * Utterances stored for use with the GetUtterancesView - * operation are deleted after 15 days.

- *

This operation requires permissions for the - * lex:DeleteUtterances action.

+ * @see {@link DeleteUtterancesCommand} */ - public deleteUtterances( + deleteUtterances( args: DeleteUtterancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteUtterances( + deleteUtterances( args: DeleteUtterancesCommandInput, cb: (err: any, data?: DeleteUtterancesCommandOutput) => void ): void; - public deleteUtterances( + deleteUtterances( args: DeleteUtterancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUtterancesCommandOutput) => void ): void; - public deleteUtterances( - args: DeleteUtterancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUtterancesCommandOutput) => void), - cb?: (err: any, data?: DeleteUtterancesCommandOutput) => void - ): Promise | void { - const command = new DeleteUtterancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns metadata information for a specific bot. You must provide - * the bot name and the bot version or alias.

- *

This operation requires permissions for the - * lex:GetBot action.

+ * @see {@link GetBotCommand} */ - public getBot(args: GetBotCommandInput, options?: __HttpHandlerOptions): Promise; - public getBot(args: GetBotCommandInput, cb: (err: any, data?: GetBotCommandOutput) => void): void; - public getBot( + getBot(args: GetBotCommandInput, options?: __HttpHandlerOptions): Promise; + getBot(args: GetBotCommandInput, cb: (err: any, data?: GetBotCommandOutput) => void): void; + getBot( args: GetBotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBotCommandOutput) => void ): void; - public getBot( - args: GetBotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBotCommandOutput) => void), - cb?: (err: any, data?: GetBotCommandOutput) => void - ): Promise | void { - const command = new GetBotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about an Amazon Lex bot alias. For more information - * about aliases, see versioning-aliases.

- *

This operation requires permissions for the - * lex:GetBotAlias action.

+ * @see {@link GetBotAliasCommand} */ - public getBotAlias(args: GetBotAliasCommandInput, options?: __HttpHandlerOptions): Promise; - public getBotAlias(args: GetBotAliasCommandInput, cb: (err: any, data?: GetBotAliasCommandOutput) => void): void; - public getBotAlias( + getBotAlias(args: GetBotAliasCommandInput, options?: __HttpHandlerOptions): Promise; + getBotAlias(args: GetBotAliasCommandInput, cb: (err: any, data?: GetBotAliasCommandOutput) => void): void; + getBotAlias( args: GetBotAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBotAliasCommandOutput) => void ): void; - public getBotAlias( - args: GetBotAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBotAliasCommandOutput) => void), - cb?: (err: any, data?: GetBotAliasCommandOutput) => void - ): Promise | void { - const command = new GetBotAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of aliases for a specified Amazon Lex bot.

- *

This operation requires permissions for the - * lex:GetBotAliases action.

+ * @see {@link GetBotAliasesCommand} */ - public getBotAliases( - args: GetBotAliasesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getBotAliases( - args: GetBotAliasesCommandInput, - cb: (err: any, data?: GetBotAliasesCommandOutput) => void - ): void; - public getBotAliases( + getBotAliases(args: GetBotAliasesCommandInput, options?: __HttpHandlerOptions): Promise; + getBotAliases(args: GetBotAliasesCommandInput, cb: (err: any, data?: GetBotAliasesCommandOutput) => void): void; + getBotAliases( args: GetBotAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBotAliasesCommandOutput) => void ): void; - public getBotAliases( - args: GetBotAliasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBotAliasesCommandOutput) => void), - cb?: (err: any, data?: GetBotAliasesCommandOutput) => void - ): Promise | void { - const command = new GetBotAliasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the association between an Amazon Lex bot and - * a messaging platform.

- *

This operation requires permissions for the - * lex:GetBotChannelAssociation action.

+ * @see {@link GetBotChannelAssociationCommand} */ - public getBotChannelAssociation( + getBotChannelAssociation( args: GetBotChannelAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBotChannelAssociation( + getBotChannelAssociation( args: GetBotChannelAssociationCommandInput, cb: (err: any, data?: GetBotChannelAssociationCommandOutput) => void ): void; - public getBotChannelAssociation( + getBotChannelAssociation( args: GetBotChannelAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBotChannelAssociationCommandOutput) => void ): void; - public getBotChannelAssociation( - args: GetBotChannelAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBotChannelAssociationCommandOutput) => void), - cb?: (err: any, data?: GetBotChannelAssociationCommandOutput) => void - ): Promise | void { - const command = new GetBotChannelAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all of the channels associated with the - * specified bot.

- *

The GetBotChannelAssociations operation requires - * permissions for the lex:GetBotChannelAssociations - * action.

+ * @see {@link GetBotChannelAssociationsCommand} */ - public getBotChannelAssociations( + getBotChannelAssociations( args: GetBotChannelAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBotChannelAssociations( + getBotChannelAssociations( args: GetBotChannelAssociationsCommandInput, cb: (err: any, data?: GetBotChannelAssociationsCommandOutput) => void ): void; - public getBotChannelAssociations( + getBotChannelAssociations( args: GetBotChannelAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBotChannelAssociationsCommandOutput) => void ): void; - public getBotChannelAssociations( - args: GetBotChannelAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBotChannelAssociationsCommandOutput) => void), - cb?: (err: any, data?: GetBotChannelAssociationsCommandOutput) => void - ): Promise | void { - const command = new GetBotChannelAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns bot information as follows:

- *
    - *
  • - *

    If you provide the nameContains field, the - * response includes information for the $LATEST version of - * all bots whose name contains the specified string.

    - *
  • - *
  • - *

    If you don't specify the nameContains field, the - * operation returns information about the $LATEST version - * of all of your bots.

    - *
  • - *
- *

This operation requires permission for the lex:GetBots - * action.

+ * @see {@link GetBotsCommand} */ - public getBots(args: GetBotsCommandInput, options?: __HttpHandlerOptions): Promise; - public getBots(args: GetBotsCommandInput, cb: (err: any, data?: GetBotsCommandOutput) => void): void; - public getBots( + getBots(args: GetBotsCommandInput, options?: __HttpHandlerOptions): Promise; + getBots(args: GetBotsCommandInput, cb: (err: any, data?: GetBotsCommandOutput) => void): void; + getBots( args: GetBotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBotsCommandOutput) => void ): void; - public getBots( - args: GetBotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBotsCommandOutput) => void), - cb?: (err: any, data?: GetBotsCommandOutput) => void - ): Promise | void { - const command = new GetBotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about all of the versions of a bot.

- *

The GetBotVersions operation returns a - * BotMetadata object for each version of a bot. For example, - * if a bot has three numbered versions, the GetBotVersions - * operation returns four BotMetadata objects in the response, - * one for each numbered version and one for the $LATEST - * version.

- *

The GetBotVersions operation always returns at least - * one version, the $LATEST version.

- *

This operation requires permissions for the - * lex:GetBotVersions action.

+ * @see {@link GetBotVersionsCommand} */ - public getBotVersions( + getBotVersions( args: GetBotVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBotVersions( - args: GetBotVersionsCommandInput, - cb: (err: any, data?: GetBotVersionsCommandOutput) => void - ): void; - public getBotVersions( + getBotVersions(args: GetBotVersionsCommandInput, cb: (err: any, data?: GetBotVersionsCommandOutput) => void): void; + getBotVersions( args: GetBotVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBotVersionsCommandOutput) => void ): void; - public getBotVersions( - args: GetBotVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBotVersionsCommandOutput) => void), - cb?: (err: any, data?: GetBotVersionsCommandOutput) => void - ): Promise | void { - const command = new GetBotVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a built-in intent.

- *

This operation requires permission for the - * lex:GetBuiltinIntent action.

+ * @see {@link GetBuiltinIntentCommand} */ - public getBuiltinIntent( + getBuiltinIntent( args: GetBuiltinIntentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBuiltinIntent( + getBuiltinIntent( args: GetBuiltinIntentCommandInput, cb: (err: any, data?: GetBuiltinIntentCommandOutput) => void ): void; - public getBuiltinIntent( + getBuiltinIntent( args: GetBuiltinIntentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBuiltinIntentCommandOutput) => void ): void; - public getBuiltinIntent( - args: GetBuiltinIntentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBuiltinIntentCommandOutput) => void), - cb?: (err: any, data?: GetBuiltinIntentCommandOutput) => void - ): Promise | void { - const command = new GetBuiltinIntentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of built-in intents that meet the specified - * criteria.

- *

This operation requires permission for the - * lex:GetBuiltinIntents action.

+ * @see {@link GetBuiltinIntentsCommand} */ - public getBuiltinIntents( + getBuiltinIntents( args: GetBuiltinIntentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBuiltinIntents( + getBuiltinIntents( args: GetBuiltinIntentsCommandInput, cb: (err: any, data?: GetBuiltinIntentsCommandOutput) => void ): void; - public getBuiltinIntents( + getBuiltinIntents( args: GetBuiltinIntentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBuiltinIntentsCommandOutput) => void ): void; - public getBuiltinIntents( - args: GetBuiltinIntentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBuiltinIntentsCommandOutput) => void), - cb?: (err: any, data?: GetBuiltinIntentsCommandOutput) => void - ): Promise | void { - const command = new GetBuiltinIntentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of built-in slot types that meet the specified - * criteria.

- *

For a list of built-in slot types, see Slot Type Reference in the Alexa Skills - * Kit.

- * - *

This operation requires permission for the - * lex:GetBuiltInSlotTypes action.

+ * @see {@link GetBuiltinSlotTypesCommand} */ - public getBuiltinSlotTypes( + getBuiltinSlotTypes( args: GetBuiltinSlotTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBuiltinSlotTypes( + getBuiltinSlotTypes( args: GetBuiltinSlotTypesCommandInput, cb: (err: any, data?: GetBuiltinSlotTypesCommandOutput) => void ): void; - public getBuiltinSlotTypes( + getBuiltinSlotTypes( args: GetBuiltinSlotTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBuiltinSlotTypesCommandOutput) => void ): void; - public getBuiltinSlotTypes( - args: GetBuiltinSlotTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBuiltinSlotTypesCommandOutput) => void), - cb?: (err: any, data?: GetBuiltinSlotTypesCommandOutput) => void - ): Promise | void { - const command = new GetBuiltinSlotTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Exports the contents of a Amazon Lex resource in a specified format. - *

+ * @see {@link GetExportCommand} */ - public getExport(args: GetExportCommandInput, options?: __HttpHandlerOptions): Promise; - public getExport(args: GetExportCommandInput, cb: (err: any, data?: GetExportCommandOutput) => void): void; - public getExport( + getExport(args: GetExportCommandInput, options?: __HttpHandlerOptions): Promise; + getExport(args: GetExportCommandInput, cb: (err: any, data?: GetExportCommandOutput) => void): void; + getExport( args: GetExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExportCommandOutput) => void ): void; - public getExport( - args: GetExportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetExportCommandOutput) => void), - cb?: (err: any, data?: GetExportCommandOutput) => void - ): Promise | void { - const command = new GetExportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about an import job started with the - * StartImport operation.

+ * @see {@link GetImportCommand} */ - public getImport(args: GetImportCommandInput, options?: __HttpHandlerOptions): Promise; - public getImport(args: GetImportCommandInput, cb: (err: any, data?: GetImportCommandOutput) => void): void; - public getImport( + getImport(args: GetImportCommandInput, options?: __HttpHandlerOptions): Promise; + getImport(args: GetImportCommandInput, cb: (err: any, data?: GetImportCommandOutput) => void): void; + getImport( args: GetImportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetImportCommandOutput) => void ): void; - public getImport( - args: GetImportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetImportCommandOutput) => void), - cb?: (err: any, data?: GetImportCommandOutput) => void - ): Promise | void { - const command = new GetImportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about an intent. In addition to the intent - * name, you must specify the intent version.

- *

This operation requires permissions to perform the - * lex:GetIntent action.

+ * @see {@link GetIntentCommand} */ - public getIntent(args: GetIntentCommandInput, options?: __HttpHandlerOptions): Promise; - public getIntent(args: GetIntentCommandInput, cb: (err: any, data?: GetIntentCommandOutput) => void): void; - public getIntent( + getIntent(args: GetIntentCommandInput, options?: __HttpHandlerOptions): Promise; + getIntent(args: GetIntentCommandInput, cb: (err: any, data?: GetIntentCommandOutput) => void): void; + getIntent( args: GetIntentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIntentCommandOutput) => void ): void; - public getIntent( - args: GetIntentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIntentCommandOutput) => void), - cb?: (err: any, data?: GetIntentCommandOutput) => void - ): Promise | void { - const command = new GetIntentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns intent information as follows:

- *
    - *
  • - *

    If you specify the nameContains field, returns the - * $LATEST version of all intents that contain the - * specified string.

    - *
  • - *
  • - *

    If you don't specify the nameContains field, - * returns information about the $LATEST version of all - * intents.

    - *
  • - *
- *

The operation requires permission for the - * lex:GetIntents action.

+ * @see {@link GetIntentsCommand} */ - public getIntents(args: GetIntentsCommandInput, options?: __HttpHandlerOptions): Promise; - public getIntents(args: GetIntentsCommandInput, cb: (err: any, data?: GetIntentsCommandOutput) => void): void; - public getIntents( + getIntents(args: GetIntentsCommandInput, options?: __HttpHandlerOptions): Promise; + getIntents(args: GetIntentsCommandInput, cb: (err: any, data?: GetIntentsCommandOutput) => void): void; + getIntents( args: GetIntentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIntentsCommandOutput) => void ): void; - public getIntents( - args: GetIntentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIntentsCommandOutput) => void), - cb?: (err: any, data?: GetIntentsCommandOutput) => void - ): Promise | void { - const command = new GetIntentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about all of the versions of an intent.

- *

The GetIntentVersions operation returns an - * IntentMetadata object for each version of an intent. For - * example, if an intent has three numbered versions, the - * GetIntentVersions operation returns four - * IntentMetadata objects in the response, one for each - * numbered version and one for the $LATEST version.

- *

The GetIntentVersions operation always returns at - * least one version, the $LATEST version.

- *

This operation requires permissions for the - * lex:GetIntentVersions action.

+ * @see {@link GetIntentVersionsCommand} */ - public getIntentVersions( + getIntentVersions( args: GetIntentVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIntentVersions( + getIntentVersions( args: GetIntentVersionsCommandInput, cb: (err: any, data?: GetIntentVersionsCommandOutput) => void ): void; - public getIntentVersions( + getIntentVersions( args: GetIntentVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIntentVersionsCommandOutput) => void ): void; - public getIntentVersions( - args: GetIntentVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIntentVersionsCommandOutput) => void), - cb?: (err: any, data?: GetIntentVersionsCommandOutput) => void - ): Promise | void { - const command = new GetIntentVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides details about an ongoing or complete migration from an - * Amazon Lex V1 bot to an Amazon Lex V2 bot. Use this operation to view the migration - * alerts and warnings related to the migration.

+ * @see {@link GetMigrationCommand} */ - public getMigration( - args: GetMigrationCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getMigration(args: GetMigrationCommandInput, cb: (err: any, data?: GetMigrationCommandOutput) => void): void; - public getMigration( + getMigration(args: GetMigrationCommandInput, options?: __HttpHandlerOptions): Promise; + getMigration(args: GetMigrationCommandInput, cb: (err: any, data?: GetMigrationCommandOutput) => void): void; + getMigration( args: GetMigrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMigrationCommandOutput) => void ): void; - public getMigration( - args: GetMigrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMigrationCommandOutput) => void), - cb?: (err: any, data?: GetMigrationCommandOutput) => void - ): Promise | void { - const command = new GetMigrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.

+ * @see {@link GetMigrationsCommand} */ - public getMigrations( - args: GetMigrationsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getMigrations( - args: GetMigrationsCommandInput, - cb: (err: any, data?: GetMigrationsCommandOutput) => void - ): void; - public getMigrations( + getMigrations(args: GetMigrationsCommandInput, options?: __HttpHandlerOptions): Promise; + getMigrations(args: GetMigrationsCommandInput, cb: (err: any, data?: GetMigrationsCommandOutput) => void): void; + getMigrations( args: GetMigrationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMigrationsCommandOutput) => void ): void; - public getMigrations( - args: GetMigrationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMigrationsCommandOutput) => void), - cb?: (err: any, data?: GetMigrationsCommandOutput) => void - ): Promise | void { - const command = new GetMigrationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a specific version of a slot type. In - * addition to specifying the slot type name, you must specify the slot type - * version.

- *

This operation requires permissions for the - * lex:GetSlotType action.

+ * @see {@link GetSlotTypeCommand} */ - public getSlotType(args: GetSlotTypeCommandInput, options?: __HttpHandlerOptions): Promise; - public getSlotType(args: GetSlotTypeCommandInput, cb: (err: any, data?: GetSlotTypeCommandOutput) => void): void; - public getSlotType( + getSlotType(args: GetSlotTypeCommandInput, options?: __HttpHandlerOptions): Promise; + getSlotType(args: GetSlotTypeCommandInput, cb: (err: any, data?: GetSlotTypeCommandOutput) => void): void; + getSlotType( args: GetSlotTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSlotTypeCommandOutput) => void ): void; - public getSlotType( - args: GetSlotTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSlotTypeCommandOutput) => void), - cb?: (err: any, data?: GetSlotTypeCommandOutput) => void - ): Promise | void { - const command = new GetSlotTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns slot type information as follows:

- *
    - *
  • - *

    If you specify the nameContains field, returns the - * $LATEST version of all slot types that contain the - * specified string.

    - *
  • - *
  • - *

    If you don't specify the nameContains field, - * returns information about the $LATEST version of all slot - * types.

    - *
  • - *
- *

The operation requires permission for the - * lex:GetSlotTypes action.

+ * @see {@link GetSlotTypesCommand} */ - public getSlotTypes( - args: GetSlotTypesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getSlotTypes(args: GetSlotTypesCommandInput, cb: (err: any, data?: GetSlotTypesCommandOutput) => void): void; - public getSlotTypes( + getSlotTypes(args: GetSlotTypesCommandInput, options?: __HttpHandlerOptions): Promise; + getSlotTypes(args: GetSlotTypesCommandInput, cb: (err: any, data?: GetSlotTypesCommandOutput) => void): void; + getSlotTypes( args: GetSlotTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSlotTypesCommandOutput) => void ): void; - public getSlotTypes( - args: GetSlotTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSlotTypesCommandOutput) => void), - cb?: (err: any, data?: GetSlotTypesCommandOutput) => void - ): Promise | void { - const command = new GetSlotTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about all versions of a slot type.

- *

The GetSlotTypeVersions operation returns a - * SlotTypeMetadata object for each version of a slot type. - * For example, if a slot type has three numbered versions, the - * GetSlotTypeVersions operation returns four - * SlotTypeMetadata objects in the response, one for each - * numbered version and one for the $LATEST version.

- *

The GetSlotTypeVersions operation always returns at - * least one version, the $LATEST version.

- *

This operation requires permissions for the - * lex:GetSlotTypeVersions action.

+ * @see {@link GetSlotTypeVersionsCommand} */ - public getSlotTypeVersions( + getSlotTypeVersions( args: GetSlotTypeVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSlotTypeVersions( + getSlotTypeVersions( args: GetSlotTypeVersionsCommandInput, cb: (err: any, data?: GetSlotTypeVersionsCommandOutput) => void ): void; - public getSlotTypeVersions( + getSlotTypeVersions( args: GetSlotTypeVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSlotTypeVersionsCommandOutput) => void ): void; - public getSlotTypeVersions( - args: GetSlotTypeVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSlotTypeVersionsCommandOutput) => void), - cb?: (err: any, data?: GetSlotTypeVersionsCommandOutput) => void - ): Promise | void { - const command = new GetSlotTypeVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use the GetUtterancesView operation to get information - * about the utterances that your users have made to your bot. You can use - * this list to tune the utterances that your bot responds to.

- *

For example, say that you have created a bot to order flowers. - * After your users have used your bot for a while, use the - * GetUtterancesView operation to see the requests that they - * have made and whether they have been successful. You might find that the - * utterance "I want flowers" is not being recognized. You could add this - * utterance to the OrderFlowers intent so that your bot - * recognizes that utterance.

- *

After you publish a new version of a bot, you can get information - * about the old version and the new so that you can compare the performance - * across the two versions.

- *

Utterance statistics are generated once a day. Data is available - * for the last 15 days. You can request information for up to 5 versions of - * your bot in each request. Amazon Lex returns the most frequent utterances - * received by the bot in the last 15 days. The response contains information - * about a maximum of 100 utterances for each version.

- *

If you set childDirected field to true when you - * created your bot, if you are using slot obfuscation with one or more - * slots, or if you opted out of participating in improving Amazon Lex, utterances - * are not available.

- *

This operation requires permissions for the - * lex:GetUtterancesView action.

+ * @see {@link GetUtterancesViewCommand} */ - public getUtterancesView( + getUtterancesView( args: GetUtterancesViewCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUtterancesView( + getUtterancesView( args: GetUtterancesViewCommandInput, cb: (err: any, data?: GetUtterancesViewCommandOutput) => void ): void; - public getUtterancesView( + getUtterancesView( args: GetUtterancesViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUtterancesViewCommandOutput) => void ): void; - public getUtterancesView( - args: GetUtterancesViewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUtterancesViewCommandOutput) => void), - cb?: (err: any, data?: GetUtterancesViewCommandOutput) => void - ): Promise | void { - const command = new GetUtterancesViewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of tags associated with the specified resource. Only bots, - * bot aliases, and bot channels can have tags associated with them.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Amazon Lex conversational bot or replaces an existing bot. - * When you create or update a bot you are only required to specify a name, a - * locale, and whether the bot is directed toward children under age 13. You - * can use this to add intents later, or to remove intents from an existing - * bot. When you create a bot with the minimum information, the bot is - * created or updated but Amazon Lex returns the response - * FAILED. You can build the bot after you add one or more - * intents. For more information about Amazon Lex bots, see how-it-works.

- *

If you specify the name of an existing bot, the fields in the - * request replace the existing values in the $LATEST version of - * the bot. Amazon Lex removes any fields that you don't provide values for in the - * request, except for the idleTTLInSeconds and - * privacySettings fields, which are set to their default - * values. If you don't specify values for required fields, Amazon Lex throws an - * exception.

- * - *

This operation requires permissions for the lex:PutBot - * action. For more information, see security-iam.

+ * @see {@link PutBotCommand} */ - public putBot(args: PutBotCommandInput, options?: __HttpHandlerOptions): Promise; - public putBot(args: PutBotCommandInput, cb: (err: any, data?: PutBotCommandOutput) => void): void; - public putBot( + putBot(args: PutBotCommandInput, options?: __HttpHandlerOptions): Promise; + putBot(args: PutBotCommandInput, cb: (err: any, data?: PutBotCommandOutput) => void): void; + putBot( args: PutBotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBotCommandOutput) => void ): void; - public putBot( - args: PutBotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBotCommandOutput) => void), - cb?: (err: any, data?: PutBotCommandOutput) => void - ): Promise | void { - const command = new PutBotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an alias for the specified version of the bot or replaces - * an alias for the specified bot. To change the version of the bot that the - * alias points to, replace the alias. For more information about aliases, - * see versioning-aliases.

- *

This operation requires permissions for the - * lex:PutBotAlias action.

+ * @see {@link PutBotAliasCommand} */ - public putBotAlias(args: PutBotAliasCommandInput, options?: __HttpHandlerOptions): Promise; - public putBotAlias(args: PutBotAliasCommandInput, cb: (err: any, data?: PutBotAliasCommandOutput) => void): void; - public putBotAlias( + putBotAlias(args: PutBotAliasCommandInput, options?: __HttpHandlerOptions): Promise; + putBotAlias(args: PutBotAliasCommandInput, cb: (err: any, data?: PutBotAliasCommandOutput) => void): void; + putBotAlias( args: PutBotAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBotAliasCommandOutput) => void ): void; - public putBotAlias( - args: PutBotAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBotAliasCommandOutput) => void), - cb?: (err: any, data?: PutBotAliasCommandOutput) => void - ): Promise | void { - const command = new PutBotAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an intent or replaces an existing intent.

- *

To define the interaction between the user and your bot, you use - * one or more intents. For a pizza ordering bot, for example, you would - * create an OrderPizza intent.

- *

To create an intent or replace an existing intent, you must provide - * the following:

- *
    - *
  • - *

    Intent name. For example, OrderPizza.

    - *
  • - *
  • - *

    Sample utterances. For example, "Can I order a pizza, please." - * and "I want to order a pizza."

    - *
  • - *
  • - *

    Information to be gathered. You specify slot types for the - * information that your bot will request from the user. You can specify - * standard slot types, such as a date or a time, or custom slot types - * such as the size and crust of a pizza.

    - *
  • - *
  • - *

    How the intent will be fulfilled. You can provide a Lambda - * function or configure the intent to return the intent information to - * the client application. If you use a Lambda function, when all of the - * intent information is available, Amazon Lex invokes your Lambda function. - * If you configure your intent to return the intent information to the - * client application.

    - *
  • - *
- *

You can specify other optional information in the request, such - * as:

- * - *
    - *
  • - *

    A confirmation prompt to ask the user to confirm an intent. For - * example, "Shall I order your pizza?"

    - *
  • - *
  • - *

    A conclusion statement to send to the user after the intent has - * been fulfilled. For example, "I placed your pizza order."

    - *
  • - *
  • - *

    A follow-up prompt that asks the user for additional activity. - * For example, asking "Do you want to order a drink with your - * pizza?"

    - *
  • - *
- *

If you specify an existing intent name to update the intent, Amazon Lex - * replaces the values in the $LATEST version of the intent with - * the values in the request. Amazon Lex removes fields that you don't provide in - * the request. If you don't specify the required fields, Amazon Lex throws an - * exception. When you update the $LATEST version of an intent, - * the status field of any bot that uses the - * $LATEST version of the intent is set to - * NOT_BUILT.

- *

For more information, see how-it-works.

- *

This operation requires permissions for the - * lex:PutIntent action.

+ * @see {@link PutIntentCommand} */ - public putIntent(args: PutIntentCommandInput, options?: __HttpHandlerOptions): Promise; - public putIntent(args: PutIntentCommandInput, cb: (err: any, data?: PutIntentCommandOutput) => void): void; - public putIntent( + putIntent(args: PutIntentCommandInput, options?: __HttpHandlerOptions): Promise; + putIntent(args: PutIntentCommandInput, cb: (err: any, data?: PutIntentCommandOutput) => void): void; + putIntent( args: PutIntentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutIntentCommandOutput) => void ): void; - public putIntent( - args: PutIntentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutIntentCommandOutput) => void), - cb?: (err: any, data?: PutIntentCommandOutput) => void - ): Promise | void { - const command = new PutIntentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a custom slot type or replaces an existing custom slot - * type.

- *

To create a custom slot type, specify a name for the slot type and - * a set of enumeration values, which are the values that a slot of this type - * can assume. For more information, see how-it-works.

- *

If you specify the name of an existing slot type, the fields in the - * request replace the existing values in the $LATEST version of - * the slot type. Amazon Lex removes the fields that you don't provide in the - * request. If you don't specify required fields, Amazon Lex throws an exception. - * When you update the $LATEST version of a slot type, if a bot - * uses the $LATEST version of an intent that contains the slot - * type, the bot's status field is set to - * NOT_BUILT.

- * - *

This operation requires permissions for the - * lex:PutSlotType action.

+ * @see {@link PutSlotTypeCommand} */ - public putSlotType(args: PutSlotTypeCommandInput, options?: __HttpHandlerOptions): Promise; - public putSlotType(args: PutSlotTypeCommandInput, cb: (err: any, data?: PutSlotTypeCommandOutput) => void): void; - public putSlotType( + putSlotType(args: PutSlotTypeCommandInput, options?: __HttpHandlerOptions): Promise; + putSlotType(args: PutSlotTypeCommandInput, cb: (err: any, data?: PutSlotTypeCommandOutput) => void): void; + putSlotType( args: PutSlotTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSlotTypeCommandOutput) => void ): void; - public putSlotType( - args: PutSlotTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutSlotTypeCommandOutput) => void), - cb?: (err: any, data?: PutSlotTypeCommandOutput) => void - ): Promise | void { - const command = new PutSlotTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a job to import a resource to Amazon Lex.

+ * @see {@link StartImportCommand} */ - public startImport(args: StartImportCommandInput, options?: __HttpHandlerOptions): Promise; - public startImport(args: StartImportCommandInput, cb: (err: any, data?: StartImportCommandOutput) => void): void; - public startImport( + startImport(args: StartImportCommandInput, options?: __HttpHandlerOptions): Promise; + startImport(args: StartImportCommandInput, cb: (err: any, data?: StartImportCommandOutput) => void): void; + startImport( args: StartImportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartImportCommandOutput) => void ): void; - public startImport( - args: StartImportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartImportCommandOutput) => void), - cb?: (err: any, data?: StartImportCommandOutput) => void - ): Promise | void { - const command = new StartImportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2. Migrate your bot when - * you want to take advantage of the new features of Amazon Lex V2.

- *

For more information, see Migrating a bot in the Amazon Lex - * developer guide.

+ * @see {@link StartMigrationCommand} */ - public startMigration( + startMigration( args: StartMigrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startMigration( - args: StartMigrationCommandInput, - cb: (err: any, data?: StartMigrationCommandOutput) => void - ): void; - public startMigration( + startMigration(args: StartMigrationCommandInput, cb: (err: any, data?: StartMigrationCommandOutput) => void): void; + startMigration( args: StartMigrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMigrationCommandOutput) => void ): void; - public startMigration( - args: StartMigrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartMigrationCommandOutput) => void), - cb?: (err: any, data?: StartMigrationCommandOutput) => void - ): Promise | void { - const command = new StartMigrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds the specified tags to the specified resource. If a tag key - * already exists, the existing value is replaced with the new value.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from a bot, bot alias or bot channel.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Lex Build-Time Actions + *

Amazon Lex is an AWS service for building conversational voice and text + * interfaces. Use these actions to create, update, and delete conversational + * bots for new and existing client applications.

+ */ +export class LexModelBuildingService extends LexModelBuildingServiceClient implements LexModelBuildingService {} +createAggregatedClient(commands, LexModelBuildingService); diff --git a/clients/client-lex-models-v2/src/LexModelsV2.ts b/clients/client-lex-models-v2/src/LexModelsV2.ts index d4f2b0192a58..f9e0791b63f5 100644 --- a/clients/client-lex-models-v2/src/LexModelsV2.ts +++ b/clients/client-lex-models-v2/src/LexModelsV2.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -300,2418 +301,1099 @@ import { UpdateSlotTypeCommandInput, UpdateSlotTypeCommandOutput, } from "./commands/UpdateSlotTypeCommand"; -import { LexModelsV2Client } from "./LexModelsV2Client"; +import { LexModelsV2Client, LexModelsV2ClientConfig } from "./LexModelsV2Client"; -/** - * @public - *

- */ -export class LexModelsV2 extends LexModelsV2Client { +const commands = { + BatchCreateCustomVocabularyItemCommand, + BatchDeleteCustomVocabularyItemCommand, + BatchUpdateCustomVocabularyItemCommand, + BuildBotLocaleCommand, + CreateBotCommand, + CreateBotAliasCommand, + CreateBotLocaleCommand, + CreateBotVersionCommand, + CreateExportCommand, + CreateIntentCommand, + CreateResourcePolicyCommand, + CreateResourcePolicyStatementCommand, + CreateSlotCommand, + CreateSlotTypeCommand, + CreateUploadUrlCommand, + DeleteBotCommand, + DeleteBotAliasCommand, + DeleteBotLocaleCommand, + DeleteBotVersionCommand, + DeleteCustomVocabularyCommand, + DeleteExportCommand, + DeleteImportCommand, + DeleteIntentCommand, + DeleteResourcePolicyCommand, + DeleteResourcePolicyStatementCommand, + DeleteSlotCommand, + DeleteSlotTypeCommand, + DeleteUtterancesCommand, + DescribeBotCommand, + DescribeBotAliasCommand, + DescribeBotLocaleCommand, + DescribeBotRecommendationCommand, + DescribeBotVersionCommand, + DescribeCustomVocabularyMetadataCommand, + DescribeExportCommand, + DescribeImportCommand, + DescribeIntentCommand, + DescribeResourcePolicyCommand, + DescribeSlotCommand, + DescribeSlotTypeCommand, + ListAggregatedUtterancesCommand, + ListBotAliasesCommand, + ListBotLocalesCommand, + ListBotRecommendationsCommand, + ListBotsCommand, + ListBotVersionsCommand, + ListBuiltInIntentsCommand, + ListBuiltInSlotTypesCommand, + ListCustomVocabularyItemsCommand, + ListExportsCommand, + ListImportsCommand, + ListIntentsCommand, + ListRecommendedIntentsCommand, + ListSlotsCommand, + ListSlotTypesCommand, + ListTagsForResourceCommand, + SearchAssociatedTranscriptsCommand, + StartBotRecommendationCommand, + StartImportCommand, + StopBotRecommendationCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateBotCommand, + UpdateBotAliasCommand, + UpdateBotLocaleCommand, + UpdateBotRecommendationCommand, + UpdateExportCommand, + UpdateIntentCommand, + UpdateResourcePolicyCommand, + UpdateSlotCommand, + UpdateSlotTypeCommand, +}; + +export interface LexModelsV2 { /** - * @public - *

Create a batch of custom vocabulary items for a given bot locale's - * custom vocabulary.

+ * @see {@link BatchCreateCustomVocabularyItemCommand} */ - public batchCreateCustomVocabularyItem( + batchCreateCustomVocabularyItem( args: BatchCreateCustomVocabularyItemCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchCreateCustomVocabularyItem( + batchCreateCustomVocabularyItem( args: BatchCreateCustomVocabularyItemCommandInput, cb: (err: any, data?: BatchCreateCustomVocabularyItemCommandOutput) => void ): void; - public batchCreateCustomVocabularyItem( + batchCreateCustomVocabularyItem( args: BatchCreateCustomVocabularyItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCreateCustomVocabularyItemCommandOutput) => void ): void; - public batchCreateCustomVocabularyItem( - args: BatchCreateCustomVocabularyItemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchCreateCustomVocabularyItemCommandOutput) => void), - cb?: (err: any, data?: BatchCreateCustomVocabularyItemCommandOutput) => void - ): Promise | void { - const command = new BatchCreateCustomVocabularyItemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete a batch of custom vocabulary items for a given bot locale's - * custom vocabulary.

- */ - public batchDeleteCustomVocabularyItem( + + /** + * @see {@link BatchDeleteCustomVocabularyItemCommand} + */ + batchDeleteCustomVocabularyItem( args: BatchDeleteCustomVocabularyItemCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeleteCustomVocabularyItem( + batchDeleteCustomVocabularyItem( args: BatchDeleteCustomVocabularyItemCommandInput, cb: (err: any, data?: BatchDeleteCustomVocabularyItemCommandOutput) => void ): void; - public batchDeleteCustomVocabularyItem( + batchDeleteCustomVocabularyItem( args: BatchDeleteCustomVocabularyItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteCustomVocabularyItemCommandOutput) => void ): void; - public batchDeleteCustomVocabularyItem( - args: BatchDeleteCustomVocabularyItemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeleteCustomVocabularyItemCommandOutput) => void), - cb?: (err: any, data?: BatchDeleteCustomVocabularyItemCommandOutput) => void - ): Promise | void { - const command = new BatchDeleteCustomVocabularyItemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update a batch of custom vocabulary items for a given bot locale's custom - * vocabulary.

- */ - public batchUpdateCustomVocabularyItem( + + /** + * @see {@link BatchUpdateCustomVocabularyItemCommand} + */ + batchUpdateCustomVocabularyItem( args: BatchUpdateCustomVocabularyItemCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchUpdateCustomVocabularyItem( + batchUpdateCustomVocabularyItem( args: BatchUpdateCustomVocabularyItemCommandInput, cb: (err: any, data?: BatchUpdateCustomVocabularyItemCommandOutput) => void ): void; - public batchUpdateCustomVocabularyItem( + batchUpdateCustomVocabularyItem( args: BatchUpdateCustomVocabularyItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchUpdateCustomVocabularyItemCommandOutput) => void ): void; - public batchUpdateCustomVocabularyItem( - args: BatchUpdateCustomVocabularyItemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchUpdateCustomVocabularyItemCommandOutput) => void), - cb?: (err: any, data?: BatchUpdateCustomVocabularyItemCommandOutput) => void - ): Promise | void { - const command = new BatchUpdateCustomVocabularyItemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Builds a bot, its intents, and its slot types into a specific - * locale. A bot can be built into multiple locales. At runtime the locale - * is used to choose a specific build of the bot.

- */ - public buildBotLocale( + + /** + * @see {@link BuildBotLocaleCommand} + */ + buildBotLocale( args: BuildBotLocaleCommandInput, options?: __HttpHandlerOptions ): Promise; - public buildBotLocale( - args: BuildBotLocaleCommandInput, - cb: (err: any, data?: BuildBotLocaleCommandOutput) => void - ): void; - public buildBotLocale( + buildBotLocale(args: BuildBotLocaleCommandInput, cb: (err: any, data?: BuildBotLocaleCommandOutput) => void): void; + buildBotLocale( args: BuildBotLocaleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BuildBotLocaleCommandOutput) => void ): void; - public buildBotLocale( - args: BuildBotLocaleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BuildBotLocaleCommandOutput) => void), - cb?: (err: any, data?: BuildBotLocaleCommandOutput) => void - ): Promise | void { - const command = new BuildBotLocaleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon Lex conversational bot.

- */ - public createBot(args: CreateBotCommandInput, options?: __HttpHandlerOptions): Promise; - public createBot(args: CreateBotCommandInput, cb: (err: any, data?: CreateBotCommandOutput) => void): void; - public createBot( + + /** + * @see {@link CreateBotCommand} + */ + createBot(args: CreateBotCommandInput, options?: __HttpHandlerOptions): Promise; + createBot(args: CreateBotCommandInput, cb: (err: any, data?: CreateBotCommandOutput) => void): void; + createBot( args: CreateBotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBotCommandOutput) => void ): void; - public createBot( - args: CreateBotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBotCommandOutput) => void), - cb?: (err: any, data?: CreateBotCommandOutput) => void - ): Promise | void { - const command = new CreateBotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an alias for the specified version of a bot. Use an alias to - * enable you to change the version of a bot without updating applications - * that use the bot.

- *

For example, you can create an alias called "PROD" that your - * applications use to call the Amazon Lex bot.

- */ - public createBotAlias( + + /** + * @see {@link CreateBotAliasCommand} + */ + createBotAlias( args: CreateBotAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBotAlias( - args: CreateBotAliasCommandInput, - cb: (err: any, data?: CreateBotAliasCommandOutput) => void - ): void; - public createBotAlias( + createBotAlias(args: CreateBotAliasCommandInput, cb: (err: any, data?: CreateBotAliasCommandOutput) => void): void; + createBotAlias( args: CreateBotAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBotAliasCommandOutput) => void ): void; - public createBotAlias( - args: CreateBotAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBotAliasCommandOutput) => void), - cb?: (err: any, data?: CreateBotAliasCommandOutput) => void - ): Promise | void { - const command = new CreateBotAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a locale in the bot. The locale contains the intents and - * slot types that the bot uses in conversations with users in the - * specified language and locale. You must add a locale to a bot before - * you can add intents and slot types to the bot.

- */ - public createBotLocale( + + /** + * @see {@link CreateBotLocaleCommand} + */ + createBotLocale( args: CreateBotLocaleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBotLocale( - args: CreateBotLocaleCommandInput, - cb: (err: any, data?: CreateBotLocaleCommandOutput) => void - ): void; - public createBotLocale( + createBotLocale(args: CreateBotLocaleCommandInput, cb: (err: any, data?: CreateBotLocaleCommandOutput) => void): void; + createBotLocale( args: CreateBotLocaleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBotLocaleCommandOutput) => void ): void; - public createBotLocale( - args: CreateBotLocaleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBotLocaleCommandOutput) => void), - cb?: (err: any, data?: CreateBotLocaleCommandOutput) => void - ): Promise | void { - const command = new CreateBotLocaleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new version of the bot based on the DRAFT - * version. If the DRAFT version of this resource hasn't - * changed since you created the last version, Amazon Lex doesn't create a new - * version, it returns the last created version.

- *

When you create the first version of a bot, Amazon Lex sets the version - * to 1. Subsequent versions increment by 1.

- */ - public createBotVersion( + + /** + * @see {@link CreateBotVersionCommand} + */ + createBotVersion( args: CreateBotVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBotVersion( + createBotVersion( args: CreateBotVersionCommandInput, cb: (err: any, data?: CreateBotVersionCommandOutput) => void ): void; - public createBotVersion( + createBotVersion( args: CreateBotVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBotVersionCommandOutput) => void ): void; - public createBotVersion( - args: CreateBotVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBotVersionCommandOutput) => void), - cb?: (err: any, data?: CreateBotVersionCommandOutput) => void - ): Promise | void { - const command = new CreateBotVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a zip archive containing the contents of a bot or a bot - * locale. The archive contains a directory structure that contains JSON - * files that define the bot.

- *

You can create an archive that contains the complete definition of a - * bot, or you can specify that the archive contain only the definition of - * a single bot locale.

- *

For more information about exporting bots, and about the structure - * of the export archive, see Importing and - * exporting bots - *

- */ - public createExport( - args: CreateExportCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createExport(args: CreateExportCommandInput, cb: (err: any, data?: CreateExportCommandOutput) => void): void; - public createExport( + + /** + * @see {@link CreateExportCommand} + */ + createExport(args: CreateExportCommandInput, options?: __HttpHandlerOptions): Promise; + createExport(args: CreateExportCommandInput, cb: (err: any, data?: CreateExportCommandOutput) => void): void; + createExport( args: CreateExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExportCommandOutput) => void ): void; - public createExport( - args: CreateExportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateExportCommandOutput) => void), - cb?: (err: any, data?: CreateExportCommandOutput) => void - ): Promise | void { - const command = new CreateExportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an intent.

- *

To define the interaction between the user and your bot, you define - * one or more intents. For example, for a pizza ordering bot you would - * create an OrderPizza intent.

- *

When you create an intent, you must provide a name. You can - * optionally provide the following:

- *
    - *
  • - *

    Sample utterances. For example, "I want to order a pizza" and - * "Can I order a pizza." You can't provide utterances for built-in - * intents.

    - *
  • - *
  • - *

    Information to be gathered. You specify slots for the - * information that you bot requests from the user. You can specify - * standard slot types, such as date and time, or custom slot types - * for your application.

    - *
  • - *
  • - *

    How the intent is fulfilled. You can provide a Lambda function - * or configure the intent to return the intent information to your - * client application. If you use a Lambda function, Amazon Lex invokes - * the function when all of the intent information is - * available.

    - *
  • - *
  • - *

    A confirmation prompt to send to the user to confirm an - * intent. For example, "Shall I order your pizza?"

    - *
  • - *
  • - *

    A conclusion statement to send to the user after the intent is - * fulfilled. For example, "I ordered your pizza."

    - *
  • - *
  • - *

    A follow-up prompt that asks the user for additional activity. - * For example, "Do you want a drink with your pizza?"

    - *
  • - *
- */ - public createIntent( - args: CreateIntentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createIntent(args: CreateIntentCommandInput, cb: (err: any, data?: CreateIntentCommandOutput) => void): void; - public createIntent( + + /** + * @see {@link CreateIntentCommand} + */ + createIntent(args: CreateIntentCommandInput, options?: __HttpHandlerOptions): Promise; + createIntent(args: CreateIntentCommandInput, cb: (err: any, data?: CreateIntentCommandOutput) => void): void; + createIntent( args: CreateIntentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIntentCommandOutput) => void ): void; - public createIntent( - args: CreateIntentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIntentCommandOutput) => void), - cb?: (err: any, data?: CreateIntentCommandOutput) => void - ): Promise | void { - const command = new CreateIntentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new resource policy with the specified policy - * statements.

- */ - public createResourcePolicy( + + /** + * @see {@link CreateResourcePolicyCommand} + */ + createResourcePolicy( args: CreateResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createResourcePolicy( + createResourcePolicy( args: CreateResourcePolicyCommandInput, cb: (err: any, data?: CreateResourcePolicyCommandOutput) => void ): void; - public createResourcePolicy( + createResourcePolicy( args: CreateResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResourcePolicyCommandOutput) => void ): void; - public createResourcePolicy( - args: CreateResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: CreateResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new CreateResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds a new resource policy statement to a bot or bot alias. If a - * resource policy exists, the statement is added to the current resource - * policy. If a policy doesn't exist, a new policy is created.

- *

You can't create a resource policy statement that allows - * cross-account access.

- */ - public createResourcePolicyStatement( + + /** + * @see {@link CreateResourcePolicyStatementCommand} + */ + createResourcePolicyStatement( args: CreateResourcePolicyStatementCommandInput, options?: __HttpHandlerOptions ): Promise; - public createResourcePolicyStatement( + createResourcePolicyStatement( args: CreateResourcePolicyStatementCommandInput, cb: (err: any, data?: CreateResourcePolicyStatementCommandOutput) => void ): void; - public createResourcePolicyStatement( + createResourcePolicyStatement( args: CreateResourcePolicyStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResourcePolicyStatementCommandOutput) => void ): void; - public createResourcePolicyStatement( - args: CreateResourcePolicyStatementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateResourcePolicyStatementCommandOutput) => void), - cb?: (err: any, data?: CreateResourcePolicyStatementCommandOutput) => void - ): Promise | void { - const command = new CreateResourcePolicyStatementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a slot in an intent. A slot is a variable needed to fulfill - * an intent. For example, an OrderPizza intent might need - * slots for size, crust, and number of pizzas. For each slot, you define - * one or more utterances that Amazon Lex uses to elicit a response from the - * user.

- */ - public createSlot(args: CreateSlotCommandInput, options?: __HttpHandlerOptions): Promise; - public createSlot(args: CreateSlotCommandInput, cb: (err: any, data?: CreateSlotCommandOutput) => void): void; - public createSlot( + + /** + * @see {@link CreateSlotCommand} + */ + createSlot(args: CreateSlotCommandInput, options?: __HttpHandlerOptions): Promise; + createSlot(args: CreateSlotCommandInput, cb: (err: any, data?: CreateSlotCommandOutput) => void): void; + createSlot( args: CreateSlotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSlotCommandOutput) => void ): void; - public createSlot( - args: CreateSlotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSlotCommandOutput) => void), - cb?: (err: any, data?: CreateSlotCommandOutput) => void - ): Promise | void { - const command = new CreateSlotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a custom slot type

- *

To create a custom slot type, specify a name for the slot type and - * a set of enumeration values, the values that a slot of this type can - * assume.

- */ - public createSlotType( + + /** + * @see {@link CreateSlotTypeCommand} + */ + createSlotType( args: CreateSlotTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSlotType( - args: CreateSlotTypeCommandInput, - cb: (err: any, data?: CreateSlotTypeCommandOutput) => void - ): void; - public createSlotType( + createSlotType(args: CreateSlotTypeCommandInput, cb: (err: any, data?: CreateSlotTypeCommandOutput) => void): void; + createSlotType( args: CreateSlotTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSlotTypeCommandOutput) => void ): void; - public createSlotType( - args: CreateSlotTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSlotTypeCommandOutput) => void), - cb?: (err: any, data?: CreateSlotTypeCommandOutput) => void - ): Promise | void { - const command = new CreateSlotTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a pre-signed S3 write URL that you use to upload the zip - * archive when importing a bot or a bot locale.

- */ - public createUploadUrl( + + /** + * @see {@link CreateUploadUrlCommand} + */ + createUploadUrl( args: CreateUploadUrlCommandInput, options?: __HttpHandlerOptions ): Promise; - public createUploadUrl( - args: CreateUploadUrlCommandInput, - cb: (err: any, data?: CreateUploadUrlCommandOutput) => void - ): void; - public createUploadUrl( + createUploadUrl(args: CreateUploadUrlCommandInput, cb: (err: any, data?: CreateUploadUrlCommandOutput) => void): void; + createUploadUrl( args: CreateUploadUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUploadUrlCommandOutput) => void ): void; - public createUploadUrl( - args: CreateUploadUrlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUploadUrlCommandOutput) => void), - cb?: (err: any, data?: CreateUploadUrlCommandOutput) => void - ): Promise | void { - const command = new CreateUploadUrlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes all versions of a bot, including the Draft - * version. To delete a specific version, use the - * DeleteBotVersion operation.

- *

When you delete a bot, all of the resources contained in the bot are - * also deleted. Deleting a bot removes all locales, intents, slot, and - * slot types defined for the bot.

- *

If a bot has an alias, the DeleteBot operation returns - * a ResourceInUseException exception. If you want to delete - * the bot and the alias, set the skipResourceInUseCheck - * parameter to true.

- */ - public deleteBot(args: DeleteBotCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteBot(args: DeleteBotCommandInput, cb: (err: any, data?: DeleteBotCommandOutput) => void): void; - public deleteBot( + + /** + * @see {@link DeleteBotCommand} + */ + deleteBot(args: DeleteBotCommandInput, options?: __HttpHandlerOptions): Promise; + deleteBot(args: DeleteBotCommandInput, cb: (err: any, data?: DeleteBotCommandOutput) => void): void; + deleteBot( args: DeleteBotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBotCommandOutput) => void ): void; - public deleteBot( - args: DeleteBotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBotCommandOutput) => void), - cb?: (err: any, data?: DeleteBotCommandOutput) => void - ): Promise | void { - const command = new DeleteBotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified bot alias.

- */ - public deleteBotAlias( + + /** + * @see {@link DeleteBotAliasCommand} + */ + deleteBotAlias( args: DeleteBotAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBotAlias( - args: DeleteBotAliasCommandInput, - cb: (err: any, data?: DeleteBotAliasCommandOutput) => void - ): void; - public deleteBotAlias( + deleteBotAlias(args: DeleteBotAliasCommandInput, cb: (err: any, data?: DeleteBotAliasCommandOutput) => void): void; + deleteBotAlias( args: DeleteBotAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBotAliasCommandOutput) => void ): void; - public deleteBotAlias( - args: DeleteBotAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBotAliasCommandOutput) => void), - cb?: (err: any, data?: DeleteBotAliasCommandOutput) => void - ): Promise | void { - const command = new DeleteBotAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a locale from a bot.

- *

When you delete a locale, all intents, slots, and slot types defined - * for the locale are also deleted.

- */ - public deleteBotLocale( + + /** + * @see {@link DeleteBotLocaleCommand} + */ + deleteBotLocale( args: DeleteBotLocaleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBotLocale( - args: DeleteBotLocaleCommandInput, - cb: (err: any, data?: DeleteBotLocaleCommandOutput) => void - ): void; - public deleteBotLocale( + deleteBotLocale(args: DeleteBotLocaleCommandInput, cb: (err: any, data?: DeleteBotLocaleCommandOutput) => void): void; + deleteBotLocale( args: DeleteBotLocaleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBotLocaleCommandOutput) => void ): void; - public deleteBotLocale( - args: DeleteBotLocaleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBotLocaleCommandOutput) => void), - cb?: (err: any, data?: DeleteBotLocaleCommandOutput) => void - ): Promise | void { - const command = new DeleteBotLocaleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specific version of a bot. To delete all versions of a bot, - * use the DeleteBot operation.

- */ - public deleteBotVersion( + + /** + * @see {@link DeleteBotVersionCommand} + */ + deleteBotVersion( args: DeleteBotVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBotVersion( + deleteBotVersion( args: DeleteBotVersionCommandInput, cb: (err: any, data?: DeleteBotVersionCommandOutput) => void ): void; - public deleteBotVersion( + deleteBotVersion( args: DeleteBotVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBotVersionCommandOutput) => void ): void; - public deleteBotVersion( - args: DeleteBotVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBotVersionCommandOutput) => void), - cb?: (err: any, data?: DeleteBotVersionCommandOutput) => void - ): Promise | void { - const command = new DeleteBotVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a custom vocabulary from the specified locale - * in the specified bot.

- */ - public deleteCustomVocabulary( + + /** + * @see {@link DeleteCustomVocabularyCommand} + */ + deleteCustomVocabulary( args: DeleteCustomVocabularyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCustomVocabulary( + deleteCustomVocabulary( args: DeleteCustomVocabularyCommandInput, cb: (err: any, data?: DeleteCustomVocabularyCommandOutput) => void ): void; - public deleteCustomVocabulary( + deleteCustomVocabulary( args: DeleteCustomVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomVocabularyCommandOutput) => void ): void; - public deleteCustomVocabulary( - args: DeleteCustomVocabularyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCustomVocabularyCommandOutput) => void), - cb?: (err: any, data?: DeleteCustomVocabularyCommandOutput) => void - ): Promise | void { - const command = new DeleteCustomVocabularyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a previous export and the associated files stored in an S3 - * bucket.

- */ - public deleteExport( - args: DeleteExportCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteExport(args: DeleteExportCommandInput, cb: (err: any, data?: DeleteExportCommandOutput) => void): void; - public deleteExport( + + /** + * @see {@link DeleteExportCommand} + */ + deleteExport(args: DeleteExportCommandInput, options?: __HttpHandlerOptions): Promise; + deleteExport(args: DeleteExportCommandInput, cb: (err: any, data?: DeleteExportCommandOutput) => void): void; + deleteExport( args: DeleteExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteExportCommandOutput) => void ): void; - public deleteExport( - args: DeleteExportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteExportCommandOutput) => void), - cb?: (err: any, data?: DeleteExportCommandOutput) => void - ): Promise | void { - const command = new DeleteExportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a previous import and the associated file stored in an S3 - * bucket.

- */ - public deleteImport( - args: DeleteImportCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteImport(args: DeleteImportCommandInput, cb: (err: any, data?: DeleteImportCommandOutput) => void): void; - public deleteImport( + + /** + * @see {@link DeleteImportCommand} + */ + deleteImport(args: DeleteImportCommandInput, options?: __HttpHandlerOptions): Promise; + deleteImport(args: DeleteImportCommandInput, cb: (err: any, data?: DeleteImportCommandOutput) => void): void; + deleteImport( args: DeleteImportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteImportCommandOutput) => void ): void; - public deleteImport( - args: DeleteImportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteImportCommandOutput) => void), - cb?: (err: any, data?: DeleteImportCommandOutput) => void - ): Promise | void { - const command = new DeleteImportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the specified intent.

- *

Deleting an intent also deletes the slots associated with the - * intent.

- */ - public deleteIntent( - args: DeleteIntentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteIntent(args: DeleteIntentCommandInput, cb: (err: any, data?: DeleteIntentCommandOutput) => void): void; - public deleteIntent( + + /** + * @see {@link DeleteIntentCommand} + */ + deleteIntent(args: DeleteIntentCommandInput, options?: __HttpHandlerOptions): Promise; + deleteIntent(args: DeleteIntentCommandInput, cb: (err: any, data?: DeleteIntentCommandOutput) => void): void; + deleteIntent( args: DeleteIntentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIntentCommandOutput) => void ): void; - public deleteIntent( - args: DeleteIntentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIntentCommandOutput) => void), - cb?: (err: any, data?: DeleteIntentCommandOutput) => void - ): Promise | void { - const command = new DeleteIntentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes an existing policy from a bot or bot alias. If the resource - * doesn't have a policy attached, Amazon Lex returns an exception.

- */ - public deleteResourcePolicy( + + /** + * @see {@link DeleteResourcePolicyCommand} + */ + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( - args: DeleteResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a policy statement from a resource policy. If you delete the - * last statement from a policy, the policy is deleted. If you specify a - * statement ID that doesn't exist in the policy, or if the bot or bot - * alias doesn't have a policy attached, Amazon Lex returns an - * exception.

- */ - public deleteResourcePolicyStatement( + + /** + * @see {@link DeleteResourcePolicyStatementCommand} + */ + deleteResourcePolicyStatement( args: DeleteResourcePolicyStatementCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourcePolicyStatement( + deleteResourcePolicyStatement( args: DeleteResourcePolicyStatementCommandInput, cb: (err: any, data?: DeleteResourcePolicyStatementCommandOutput) => void ): void; - public deleteResourcePolicyStatement( + deleteResourcePolicyStatement( args: DeleteResourcePolicyStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyStatementCommandOutput) => void ): void; - public deleteResourcePolicyStatement( - args: DeleteResourcePolicyStatementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourcePolicyStatementCommandOutput) => void), - cb?: (err: any, data?: DeleteResourcePolicyStatementCommandOutput) => void - ): Promise | void { - const command = new DeleteResourcePolicyStatementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified slot from an intent.

- */ - public deleteSlot(args: DeleteSlotCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteSlot(args: DeleteSlotCommandInput, cb: (err: any, data?: DeleteSlotCommandOutput) => void): void; - public deleteSlot( + + /** + * @see {@link DeleteSlotCommand} + */ + deleteSlot(args: DeleteSlotCommandInput, options?: __HttpHandlerOptions): Promise; + deleteSlot(args: DeleteSlotCommandInput, cb: (err: any, data?: DeleteSlotCommandOutput) => void): void; + deleteSlot( args: DeleteSlotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSlotCommandOutput) => void ): void; - public deleteSlot( - args: DeleteSlotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSlotCommandOutput) => void), - cb?: (err: any, data?: DeleteSlotCommandOutput) => void - ): Promise | void { - const command = new DeleteSlotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a slot type from a bot locale.

- *

If a slot is using the slot type, Amazon Lex throws a - * ResourceInUseException exception. To avoid the - * exception, set the skipResourceInUseCheck parameter to - * true.

- */ - public deleteSlotType( + + /** + * @see {@link DeleteSlotTypeCommand} + */ + deleteSlotType( args: DeleteSlotTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSlotType( - args: DeleteSlotTypeCommandInput, - cb: (err: any, data?: DeleteSlotTypeCommandOutput) => void - ): void; - public deleteSlotType( + deleteSlotType(args: DeleteSlotTypeCommandInput, cb: (err: any, data?: DeleteSlotTypeCommandOutput) => void): void; + deleteSlotType( args: DeleteSlotTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSlotTypeCommandOutput) => void ): void; - public deleteSlotType( - args: DeleteSlotTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSlotTypeCommandOutput) => void), - cb?: (err: any, data?: DeleteSlotTypeCommandOutput) => void - ): Promise | void { - const command = new DeleteSlotTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes stored utterances.

- *

Amazon Lex stores the utterances that users send to your bot. Utterances - * are stored for 15 days for use with the ListAggregatedUtterances operation, and - * then stored indefinitely for use in improving the ability of your bot - * to respond to user input..

- *

Use the DeleteUtterances operation to manually delete - * utterances for a specific session. When you use the - * DeleteUtterances operation, utterances stored for - * improving your bot's ability to respond to user input are deleted - * immediately. Utterances stored for use with the - * ListAggregatedUtterances operation are deleted after 15 - * days.

- */ - public deleteUtterances( + + /** + * @see {@link DeleteUtterancesCommand} + */ + deleteUtterances( args: DeleteUtterancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteUtterances( + deleteUtterances( args: DeleteUtterancesCommandInput, cb: (err: any, data?: DeleteUtterancesCommandOutput) => void ): void; - public deleteUtterances( + deleteUtterances( args: DeleteUtterancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUtterancesCommandOutput) => void ): void; - public deleteUtterances( - args: DeleteUtterancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUtterancesCommandOutput) => void), - cb?: (err: any, data?: DeleteUtterancesCommandOutput) => void - ): Promise | void { - const command = new DeleteUtterancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides metadata information about a bot.

- */ - public describeBot(args: DescribeBotCommandInput, options?: __HttpHandlerOptions): Promise; - public describeBot(args: DescribeBotCommandInput, cb: (err: any, data?: DescribeBotCommandOutput) => void): void; - public describeBot( + + /** + * @see {@link DescribeBotCommand} + */ + describeBot(args: DescribeBotCommandInput, options?: __HttpHandlerOptions): Promise; + describeBot(args: DescribeBotCommandInput, cb: (err: any, data?: DescribeBotCommandOutput) => void): void; + describeBot( args: DescribeBotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBotCommandOutput) => void ): void; - public describeBot( - args: DescribeBotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBotCommandOutput) => void), - cb?: (err: any, data?: DescribeBotCommandOutput) => void - ): Promise | void { - const command = new DescribeBotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get information about a specific bot alias.

- */ - public describeBotAlias( + + /** + * @see {@link DescribeBotAliasCommand} + */ + describeBotAlias( args: DescribeBotAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBotAlias( + describeBotAlias( args: DescribeBotAliasCommandInput, cb: (err: any, data?: DescribeBotAliasCommandOutput) => void ): void; - public describeBotAlias( + describeBotAlias( args: DescribeBotAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBotAliasCommandOutput) => void ): void; - public describeBotAlias( - args: DescribeBotAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBotAliasCommandOutput) => void), - cb?: (err: any, data?: DescribeBotAliasCommandOutput) => void - ): Promise | void { - const command = new DescribeBotAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the settings that a bot has for a specific locale.

- */ - public describeBotLocale( + + /** + * @see {@link DescribeBotLocaleCommand} + */ + describeBotLocale( args: DescribeBotLocaleCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBotLocale( + describeBotLocale( args: DescribeBotLocaleCommandInput, cb: (err: any, data?: DescribeBotLocaleCommandOutput) => void ): void; - public describeBotLocale( + describeBotLocale( args: DescribeBotLocaleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBotLocaleCommandOutput) => void ): void; - public describeBotLocale( - args: DescribeBotLocaleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBotLocaleCommandOutput) => void), - cb?: (err: any, data?: DescribeBotLocaleCommandOutput) => void - ): Promise | void { - const command = new DescribeBotLocaleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides metadata information about a bot recommendation. This - * information will enable you to get a description on the request inputs, - * to download associated transcripts after processing is complete, and to - * download intents and slot-types generated by the bot - * recommendation.

- */ - public describeBotRecommendation( + + /** + * @see {@link DescribeBotRecommendationCommand} + */ + describeBotRecommendation( args: DescribeBotRecommendationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBotRecommendation( + describeBotRecommendation( args: DescribeBotRecommendationCommandInput, cb: (err: any, data?: DescribeBotRecommendationCommandOutput) => void ): void; - public describeBotRecommendation( + describeBotRecommendation( args: DescribeBotRecommendationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBotRecommendationCommandOutput) => void ): void; - public describeBotRecommendation( - args: DescribeBotRecommendationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBotRecommendationCommandOutput) => void), - cb?: (err: any, data?: DescribeBotRecommendationCommandOutput) => void - ): Promise | void { - const command = new DescribeBotRecommendationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides metadata about a version of a bot.

- */ - public describeBotVersion( + + /** + * @see {@link DescribeBotVersionCommand} + */ + describeBotVersion( args: DescribeBotVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBotVersion( + describeBotVersion( args: DescribeBotVersionCommandInput, cb: (err: any, data?: DescribeBotVersionCommandOutput) => void ): void; - public describeBotVersion( + describeBotVersion( args: DescribeBotVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBotVersionCommandOutput) => void ): void; - public describeBotVersion( - args: DescribeBotVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBotVersionCommandOutput) => void), - cb?: (err: any, data?: DescribeBotVersionCommandOutput) => void - ): Promise | void { - const command = new DescribeBotVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides metadata information about a custom vocabulary.

- */ - public describeCustomVocabularyMetadata( + + /** + * @see {@link DescribeCustomVocabularyMetadataCommand} + */ + describeCustomVocabularyMetadata( args: DescribeCustomVocabularyMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCustomVocabularyMetadata( + describeCustomVocabularyMetadata( args: DescribeCustomVocabularyMetadataCommandInput, cb: (err: any, data?: DescribeCustomVocabularyMetadataCommandOutput) => void ): void; - public describeCustomVocabularyMetadata( + describeCustomVocabularyMetadata( args: DescribeCustomVocabularyMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCustomVocabularyMetadataCommandOutput) => void ): void; - public describeCustomVocabularyMetadata( - args: DescribeCustomVocabularyMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCustomVocabularyMetadataCommandOutput) => void), - cb?: (err: any, data?: DescribeCustomVocabularyMetadataCommandOutput) => void - ): Promise | void { - const command = new DescribeCustomVocabularyMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a specific export.

- */ - public describeExport( + + /** + * @see {@link DescribeExportCommand} + */ + describeExport( args: DescribeExportCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeExport( - args: DescribeExportCommandInput, - cb: (err: any, data?: DescribeExportCommandOutput) => void - ): void; - public describeExport( + describeExport(args: DescribeExportCommandInput, cb: (err: any, data?: DescribeExportCommandOutput) => void): void; + describeExport( args: DescribeExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExportCommandOutput) => void ): void; - public describeExport( - args: DescribeExportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeExportCommandOutput) => void), - cb?: (err: any, data?: DescribeExportCommandOutput) => void - ): Promise | void { - const command = new DescribeExportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a specific import.

- */ - public describeImport( + + /** + * @see {@link DescribeImportCommand} + */ + describeImport( args: DescribeImportCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeImport( - args: DescribeImportCommandInput, - cb: (err: any, data?: DescribeImportCommandOutput) => void - ): void; - public describeImport( + describeImport(args: DescribeImportCommandInput, cb: (err: any, data?: DescribeImportCommandOutput) => void): void; + describeImport( args: DescribeImportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImportCommandOutput) => void ): void; - public describeImport( - args: DescribeImportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeImportCommandOutput) => void), - cb?: (err: any, data?: DescribeImportCommandOutput) => void - ): Promise | void { - const command = new DescribeImportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns metadata about an intent.

- */ - public describeIntent( + + /** + * @see {@link DescribeIntentCommand} + */ + describeIntent( args: DescribeIntentCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeIntent( - args: DescribeIntentCommandInput, - cb: (err: any, data?: DescribeIntentCommandOutput) => void - ): void; - public describeIntent( + describeIntent(args: DescribeIntentCommandInput, cb: (err: any, data?: DescribeIntentCommandOutput) => void): void; + describeIntent( args: DescribeIntentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIntentCommandOutput) => void ): void; - public describeIntent( - args: DescribeIntentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeIntentCommandOutput) => void), - cb?: (err: any, data?: DescribeIntentCommandOutput) => void - ): Promise | void { - const command = new DescribeIntentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the resource policy and policy revision for a bot or bot - * alias.

- */ - public describeResourcePolicy( + + /** + * @see {@link DescribeResourcePolicyCommand} + */ + describeResourcePolicy( args: DescribeResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeResourcePolicy( + describeResourcePolicy( args: DescribeResourcePolicyCommandInput, cb: (err: any, data?: DescribeResourcePolicyCommandOutput) => void ): void; - public describeResourcePolicy( + describeResourcePolicy( args: DescribeResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeResourcePolicyCommandOutput) => void ): void; - public describeResourcePolicy( - args: DescribeResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: DescribeResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new DescribeResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets metadata information about a slot.

- */ - public describeSlot( - args: DescribeSlotCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeSlot(args: DescribeSlotCommandInput, cb: (err: any, data?: DescribeSlotCommandOutput) => void): void; - public describeSlot( + + /** + * @see {@link DescribeSlotCommand} + */ + describeSlot(args: DescribeSlotCommandInput, options?: __HttpHandlerOptions): Promise; + describeSlot(args: DescribeSlotCommandInput, cb: (err: any, data?: DescribeSlotCommandOutput) => void): void; + describeSlot( args: DescribeSlotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSlotCommandOutput) => void ): void; - public describeSlot( - args: DescribeSlotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSlotCommandOutput) => void), - cb?: (err: any, data?: DescribeSlotCommandOutput) => void - ): Promise | void { - const command = new DescribeSlotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets metadata information about a slot type.

- */ - public describeSlotType( + + /** + * @see {@link DescribeSlotTypeCommand} + */ + describeSlotType( args: DescribeSlotTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSlotType( + describeSlotType( args: DescribeSlotTypeCommandInput, cb: (err: any, data?: DescribeSlotTypeCommandOutput) => void ): void; - public describeSlotType( + describeSlotType( args: DescribeSlotTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSlotTypeCommandOutput) => void ): void; - public describeSlotType( - args: DescribeSlotTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSlotTypeCommandOutput) => void), - cb?: (err: any, data?: DescribeSlotTypeCommandOutput) => void - ): Promise | void { - const command = new DescribeSlotTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides a list of utterances that users have sent to the - * bot.

- *

Utterances are aggregated by the text of the utterance. For example, - * all instances where customers used the phrase "I want to order pizza" - * are aggregated into the same line in the response.

- *

You can see both detected utterances and missed utterances. A - * detected utterance is where the bot properly recognized the utterance - * and activated the associated intent. A missed utterance was not - * recognized by the bot and didn't activate an intent.

- *

Utterances can be aggregated for a bot alias or for a bot version, - * but not both at the same time.

- *

Utterances statistics are not generated under the following - * conditions:

- *
    - *
  • - *

    The childDirected field was set to true when the - * bot was created.

    - *
  • - *
  • - *

    You are using slot obfuscation with one or more slots.

    - *
  • - *
  • - *

    You opted out of participating in improving Amazon Lex.

    - *
  • - *
- */ - public listAggregatedUtterances( + + /** + * @see {@link ListAggregatedUtterancesCommand} + */ + listAggregatedUtterances( args: ListAggregatedUtterancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAggregatedUtterances( + listAggregatedUtterances( args: ListAggregatedUtterancesCommandInput, cb: (err: any, data?: ListAggregatedUtterancesCommandOutput) => void ): void; - public listAggregatedUtterances( + listAggregatedUtterances( args: ListAggregatedUtterancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAggregatedUtterancesCommandOutput) => void ): void; - public listAggregatedUtterances( - args: ListAggregatedUtterancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAggregatedUtterancesCommandOutput) => void), - cb?: (err: any, data?: ListAggregatedUtterancesCommandOutput) => void - ): Promise | void { - const command = new ListAggregatedUtterancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of aliases for the specified bot.

- */ - public listBotAliases( + + /** + * @see {@link ListBotAliasesCommand} + */ + listBotAliases( args: ListBotAliasesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBotAliases( - args: ListBotAliasesCommandInput, - cb: (err: any, data?: ListBotAliasesCommandOutput) => void - ): void; - public listBotAliases( + listBotAliases(args: ListBotAliasesCommandInput, cb: (err: any, data?: ListBotAliasesCommandOutput) => void): void; + listBotAliases( args: ListBotAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBotAliasesCommandOutput) => void ): void; - public listBotAliases( - args: ListBotAliasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBotAliasesCommandOutput) => void), - cb?: (err: any, data?: ListBotAliasesCommandOutput) => void - ): Promise | void { - const command = new ListBotAliasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of locales for the specified bot.

- */ - public listBotLocales( + + /** + * @see {@link ListBotLocalesCommand} + */ + listBotLocales( args: ListBotLocalesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBotLocales( - args: ListBotLocalesCommandInput, - cb: (err: any, data?: ListBotLocalesCommandOutput) => void - ): void; - public listBotLocales( + listBotLocales(args: ListBotLocalesCommandInput, cb: (err: any, data?: ListBotLocalesCommandOutput) => void): void; + listBotLocales( args: ListBotLocalesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBotLocalesCommandOutput) => void ): void; - public listBotLocales( - args: ListBotLocalesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBotLocalesCommandOutput) => void), - cb?: (err: any, data?: ListBotLocalesCommandOutput) => void - ): Promise | void { - const command = new ListBotLocalesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get a list of bot recommendations that meet the specified - * criteria.

- */ - public listBotRecommendations( + + /** + * @see {@link ListBotRecommendationsCommand} + */ + listBotRecommendations( args: ListBotRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBotRecommendations( + listBotRecommendations( args: ListBotRecommendationsCommandInput, cb: (err: any, data?: ListBotRecommendationsCommandOutput) => void ): void; - public listBotRecommendations( + listBotRecommendations( args: ListBotRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBotRecommendationsCommandOutput) => void ): void; - public listBotRecommendations( - args: ListBotRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBotRecommendationsCommandOutput) => void), - cb?: (err: any, data?: ListBotRecommendationsCommandOutput) => void - ): Promise | void { - const command = new ListBotRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of available bots.

- */ - public listBots(args: ListBotsCommandInput, options?: __HttpHandlerOptions): Promise; - public listBots(args: ListBotsCommandInput, cb: (err: any, data?: ListBotsCommandOutput) => void): void; - public listBots( + + /** + * @see {@link ListBotsCommand} + */ + listBots(args: ListBotsCommandInput, options?: __HttpHandlerOptions): Promise; + listBots(args: ListBotsCommandInput, cb: (err: any, data?: ListBotsCommandOutput) => void): void; + listBots( args: ListBotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBotsCommandOutput) => void ): void; - public listBots( - args: ListBotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBotsCommandOutput) => void), - cb?: (err: any, data?: ListBotsCommandOutput) => void - ): Promise | void { - const command = new ListBotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about all of the versions of a bot.

- *

The ListBotVersions operation returns a summary of each - * version of a bot. For example, if a bot has three numbered versions, - * the ListBotVersions operation returns for summaries, one - * for each numbered version and one for the DRAFT - * version.

- *

The ListBotVersions operation always returns at least - * one version, the DRAFT version.

- */ - public listBotVersions( + + /** + * @see {@link ListBotVersionsCommand} + */ + listBotVersions( args: ListBotVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBotVersions( - args: ListBotVersionsCommandInput, - cb: (err: any, data?: ListBotVersionsCommandOutput) => void - ): void; - public listBotVersions( + listBotVersions(args: ListBotVersionsCommandInput, cb: (err: any, data?: ListBotVersionsCommandOutput) => void): void; + listBotVersions( args: ListBotVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBotVersionsCommandOutput) => void ): void; - public listBotVersions( - args: ListBotVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBotVersionsCommandOutput) => void), - cb?: (err: any, data?: ListBotVersionsCommandOutput) => void - ): Promise | void { - const command = new ListBotVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of built-in intents provided by Amazon Lex that you can use - * in your bot.

- *

To use a built-in intent as a the base for your own intent, include - * the built-in intent signature in the parentIntentSignature - * parameter when you call the CreateIntent operation. For - * more information, see CreateIntent.

- */ - public listBuiltInIntents( + + /** + * @see {@link ListBuiltInIntentsCommand} + */ + listBuiltInIntents( args: ListBuiltInIntentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBuiltInIntents( + listBuiltInIntents( args: ListBuiltInIntentsCommandInput, cb: (err: any, data?: ListBuiltInIntentsCommandOutput) => void ): void; - public listBuiltInIntents( + listBuiltInIntents( args: ListBuiltInIntentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBuiltInIntentsCommandOutput) => void ): void; - public listBuiltInIntents( - args: ListBuiltInIntentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBuiltInIntentsCommandOutput) => void), - cb?: (err: any, data?: ListBuiltInIntentsCommandOutput) => void - ): Promise | void { - const command = new ListBuiltInIntentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of built-in slot types that meet the specified - * criteria.

- */ - public listBuiltInSlotTypes( + + /** + * @see {@link ListBuiltInSlotTypesCommand} + */ + listBuiltInSlotTypes( args: ListBuiltInSlotTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBuiltInSlotTypes( + listBuiltInSlotTypes( args: ListBuiltInSlotTypesCommandInput, cb: (err: any, data?: ListBuiltInSlotTypesCommandOutput) => void ): void; - public listBuiltInSlotTypes( + listBuiltInSlotTypes( args: ListBuiltInSlotTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBuiltInSlotTypesCommandOutput) => void ): void; - public listBuiltInSlotTypes( - args: ListBuiltInSlotTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBuiltInSlotTypesCommandOutput) => void), - cb?: (err: any, data?: ListBuiltInSlotTypesCommandOutput) => void - ): Promise | void { - const command = new ListBuiltInSlotTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Paginated list of custom vocabulary items for a given bot locale's - * custom vocabulary.

- */ - public listCustomVocabularyItems( + + /** + * @see {@link ListCustomVocabularyItemsCommand} + */ + listCustomVocabularyItems( args: ListCustomVocabularyItemsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCustomVocabularyItems( + listCustomVocabularyItems( args: ListCustomVocabularyItemsCommandInput, cb: (err: any, data?: ListCustomVocabularyItemsCommandOutput) => void ): void; - public listCustomVocabularyItems( + listCustomVocabularyItems( args: ListCustomVocabularyItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCustomVocabularyItemsCommandOutput) => void ): void; - public listCustomVocabularyItems( - args: ListCustomVocabularyItemsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCustomVocabularyItemsCommandOutput) => void), - cb?: (err: any, data?: ListCustomVocabularyItemsCommandOutput) => void - ): Promise | void { - const command = new ListCustomVocabularyItemsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the exports for a bot, bot locale, or custom vocabulary. - * Exports are kept in the list for 7 days.

- */ - public listExports(args: ListExportsCommandInput, options?: __HttpHandlerOptions): Promise; - public listExports(args: ListExportsCommandInput, cb: (err: any, data?: ListExportsCommandOutput) => void): void; - public listExports( + + /** + * @see {@link ListExportsCommand} + */ + listExports(args: ListExportsCommandInput, options?: __HttpHandlerOptions): Promise; + listExports(args: ListExportsCommandInput, cb: (err: any, data?: ListExportsCommandOutput) => void): void; + listExports( args: ListExportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExportsCommandOutput) => void ): void; - public listExports( - args: ListExportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListExportsCommandOutput) => void), - cb?: (err: any, data?: ListExportsCommandOutput) => void - ): Promise | void { - const command = new ListExportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the imports for a bot, bot locale, or custom vocabulary. - * Imports are kept in the list for 7 days.

- */ - public listImports(args: ListImportsCommandInput, options?: __HttpHandlerOptions): Promise; - public listImports(args: ListImportsCommandInput, cb: (err: any, data?: ListImportsCommandOutput) => void): void; - public listImports( + + /** + * @see {@link ListImportsCommand} + */ + listImports(args: ListImportsCommandInput, options?: __HttpHandlerOptions): Promise; + listImports(args: ListImportsCommandInput, cb: (err: any, data?: ListImportsCommandOutput) => void): void; + listImports( args: ListImportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImportsCommandOutput) => void ): void; - public listImports( - args: ListImportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListImportsCommandOutput) => void), - cb?: (err: any, data?: ListImportsCommandOutput) => void - ): Promise | void { - const command = new ListImportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get a list of intents that meet the specified criteria.

- */ - public listIntents(args: ListIntentsCommandInput, options?: __HttpHandlerOptions): Promise; - public listIntents(args: ListIntentsCommandInput, cb: (err: any, data?: ListIntentsCommandOutput) => void): void; - public listIntents( + + /** + * @see {@link ListIntentsCommand} + */ + listIntents(args: ListIntentsCommandInput, options?: __HttpHandlerOptions): Promise; + listIntents(args: ListIntentsCommandInput, cb: (err: any, data?: ListIntentsCommandOutput) => void): void; + listIntents( args: ListIntentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIntentsCommandOutput) => void ): void; - public listIntents( - args: ListIntentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIntentsCommandOutput) => void), - cb?: (err: any, data?: ListIntentsCommandOutput) => void - ): Promise | void { - const command = new ListIntentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of recommended intents provided by the bot - * recommendation that you can use in your bot. Intents in the - * response are ordered by relevance.

- */ - public listRecommendedIntents( + + /** + * @see {@link ListRecommendedIntentsCommand} + */ + listRecommendedIntents( args: ListRecommendedIntentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRecommendedIntents( + listRecommendedIntents( args: ListRecommendedIntentsCommandInput, cb: (err: any, data?: ListRecommendedIntentsCommandOutput) => void ): void; - public listRecommendedIntents( + listRecommendedIntents( args: ListRecommendedIntentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecommendedIntentsCommandOutput) => void ): void; - public listRecommendedIntents( - args: ListRecommendedIntentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRecommendedIntentsCommandOutput) => void), - cb?: (err: any, data?: ListRecommendedIntentsCommandOutput) => void - ): Promise | void { - const command = new ListRecommendedIntentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of slots that match the specified criteria.

- */ - public listSlots(args: ListSlotsCommandInput, options?: __HttpHandlerOptions): Promise; - public listSlots(args: ListSlotsCommandInput, cb: (err: any, data?: ListSlotsCommandOutput) => void): void; - public listSlots( + + /** + * @see {@link ListSlotsCommand} + */ + listSlots(args: ListSlotsCommandInput, options?: __HttpHandlerOptions): Promise; + listSlots(args: ListSlotsCommandInput, cb: (err: any, data?: ListSlotsCommandOutput) => void): void; + listSlots( args: ListSlotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSlotsCommandOutput) => void ): void; - public listSlots( - args: ListSlotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSlotsCommandOutput) => void), - cb?: (err: any, data?: ListSlotsCommandOutput) => void - ): Promise | void { - const command = new ListSlotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of slot types that match the specified criteria.

- */ - public listSlotTypes( - args: ListSlotTypesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listSlotTypes( - args: ListSlotTypesCommandInput, - cb: (err: any, data?: ListSlotTypesCommandOutput) => void - ): void; - public listSlotTypes( + + /** + * @see {@link ListSlotTypesCommand} + */ + listSlotTypes(args: ListSlotTypesCommandInput, options?: __HttpHandlerOptions): Promise; + listSlotTypes(args: ListSlotTypesCommandInput, cb: (err: any, data?: ListSlotTypesCommandOutput) => void): void; + listSlotTypes( args: ListSlotTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSlotTypesCommandOutput) => void ): void; - public listSlotTypes( - args: ListSlotTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSlotTypesCommandOutput) => void), - cb?: (err: any, data?: ListSlotTypesCommandOutput) => void - ): Promise | void { - const command = new ListSlotTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of tags associated with a resource. Only bots, bot - * aliases, and bot channels can have tags associated with them.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Search for associated transcripts that meet the specified - * criteria.

- */ - public searchAssociatedTranscripts( + + /** + * @see {@link SearchAssociatedTranscriptsCommand} + */ + searchAssociatedTranscripts( args: SearchAssociatedTranscriptsCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchAssociatedTranscripts( + searchAssociatedTranscripts( args: SearchAssociatedTranscriptsCommandInput, cb: (err: any, data?: SearchAssociatedTranscriptsCommandOutput) => void ): void; - public searchAssociatedTranscripts( + searchAssociatedTranscripts( args: SearchAssociatedTranscriptsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchAssociatedTranscriptsCommandOutput) => void ): void; - public searchAssociatedTranscripts( - args: SearchAssociatedTranscriptsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchAssociatedTranscriptsCommandOutput) => void), - cb?: (err: any, data?: SearchAssociatedTranscriptsCommandOutput) => void - ): Promise | void { - const command = new SearchAssociatedTranscriptsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Use this to provide your transcript data, and to start the bot - * recommendation process.

- */ - public startBotRecommendation( + + /** + * @see {@link StartBotRecommendationCommand} + */ + startBotRecommendation( args: StartBotRecommendationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startBotRecommendation( + startBotRecommendation( args: StartBotRecommendationCommandInput, cb: (err: any, data?: StartBotRecommendationCommandOutput) => void ): void; - public startBotRecommendation( + startBotRecommendation( args: StartBotRecommendationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartBotRecommendationCommandOutput) => void ): void; - public startBotRecommendation( - args: StartBotRecommendationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartBotRecommendationCommandOutput) => void), - cb?: (err: any, data?: StartBotRecommendationCommandOutput) => void - ): Promise | void { - const command = new StartBotRecommendationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts importing a bot, bot locale, or custom vocabulary from a zip - * archive that you uploaded to an S3 bucket.

- */ - public startImport(args: StartImportCommandInput, options?: __HttpHandlerOptions): Promise; - public startImport(args: StartImportCommandInput, cb: (err: any, data?: StartImportCommandOutput) => void): void; - public startImport( + + /** + * @see {@link StartImportCommand} + */ + startImport(args: StartImportCommandInput, options?: __HttpHandlerOptions): Promise; + startImport(args: StartImportCommandInput, cb: (err: any, data?: StartImportCommandOutput) => void): void; + startImport( args: StartImportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartImportCommandOutput) => void ): void; - public startImport( - args: StartImportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartImportCommandOutput) => void), - cb?: (err: any, data?: StartImportCommandOutput) => void - ): Promise | void { - const command = new StartImportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stop an already running Bot Recommendation request.

- */ - public stopBotRecommendation( + + /** + * @see {@link StopBotRecommendationCommand} + */ + stopBotRecommendation( args: StopBotRecommendationCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopBotRecommendation( + stopBotRecommendation( args: StopBotRecommendationCommandInput, cb: (err: any, data?: StopBotRecommendationCommandOutput) => void ): void; - public stopBotRecommendation( + stopBotRecommendation( args: StopBotRecommendationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopBotRecommendationCommandOutput) => void ): void; - public stopBotRecommendation( - args: StopBotRecommendationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopBotRecommendationCommandOutput) => void), - cb?: (err: any, data?: StopBotRecommendationCommandOutput) => void - ): Promise | void { - const command = new StopBotRecommendationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds the specified tags to the specified resource. If a tag key - * already exists, the existing value is replaced with the new - * value.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes tags from a bot, bot alias, or bot channel.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the configuration of an existing bot.

- */ - public updateBot(args: UpdateBotCommandInput, options?: __HttpHandlerOptions): Promise; - public updateBot(args: UpdateBotCommandInput, cb: (err: any, data?: UpdateBotCommandOutput) => void): void; - public updateBot( + + /** + * @see {@link UpdateBotCommand} + */ + updateBot(args: UpdateBotCommandInput, options?: __HttpHandlerOptions): Promise; + updateBot(args: UpdateBotCommandInput, cb: (err: any, data?: UpdateBotCommandOutput) => void): void; + updateBot( args: UpdateBotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBotCommandOutput) => void ): void; - public updateBot( - args: UpdateBotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBotCommandOutput) => void), - cb?: (err: any, data?: UpdateBotCommandOutput) => void - ): Promise | void { - const command = new UpdateBotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the configuration of an existing bot alias.

- */ - public updateBotAlias( + + /** + * @see {@link UpdateBotAliasCommand} + */ + updateBotAlias( args: UpdateBotAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBotAlias( - args: UpdateBotAliasCommandInput, - cb: (err: any, data?: UpdateBotAliasCommandOutput) => void - ): void; - public updateBotAlias( + updateBotAlias(args: UpdateBotAliasCommandInput, cb: (err: any, data?: UpdateBotAliasCommandOutput) => void): void; + updateBotAlias( args: UpdateBotAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBotAliasCommandOutput) => void ): void; - public updateBotAlias( - args: UpdateBotAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBotAliasCommandOutput) => void), - cb?: (err: any, data?: UpdateBotAliasCommandOutput) => void - ): Promise | void { - const command = new UpdateBotAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the settings that a bot has for a specific locale.

- */ - public updateBotLocale( + + /** + * @see {@link UpdateBotLocaleCommand} + */ + updateBotLocale( args: UpdateBotLocaleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBotLocale( - args: UpdateBotLocaleCommandInput, - cb: (err: any, data?: UpdateBotLocaleCommandOutput) => void - ): void; - public updateBotLocale( + updateBotLocale(args: UpdateBotLocaleCommandInput, cb: (err: any, data?: UpdateBotLocaleCommandOutput) => void): void; + updateBotLocale( args: UpdateBotLocaleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBotLocaleCommandOutput) => void ): void; - public updateBotLocale( - args: UpdateBotLocaleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBotLocaleCommandOutput) => void), - cb?: (err: any, data?: UpdateBotLocaleCommandOutput) => void - ): Promise | void { - const command = new UpdateBotLocaleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing bot recommendation request.

- */ - public updateBotRecommendation( + + /** + * @see {@link UpdateBotRecommendationCommand} + */ + updateBotRecommendation( args: UpdateBotRecommendationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBotRecommendation( + updateBotRecommendation( args: UpdateBotRecommendationCommandInput, cb: (err: any, data?: UpdateBotRecommendationCommandOutput) => void ): void; - public updateBotRecommendation( + updateBotRecommendation( args: UpdateBotRecommendationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBotRecommendationCommandOutput) => void ): void; - public updateBotRecommendation( - args: UpdateBotRecommendationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBotRecommendationCommandOutput) => void), - cb?: (err: any, data?: UpdateBotRecommendationCommandOutput) => void - ): Promise | void { - const command = new UpdateBotRecommendationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the password used to protect an export zip archive.

- *

The password is not required. If you don't supply a password, Amazon Lex - * generates a zip file that is not protected by a password. This is the - * archive that is available at the pre-signed S3 URL provided by the - * DescribeExport operation.

- */ - public updateExport( - args: UpdateExportCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateExport(args: UpdateExportCommandInput, cb: (err: any, data?: UpdateExportCommandOutput) => void): void; - public updateExport( + + /** + * @see {@link UpdateExportCommand} + */ + updateExport(args: UpdateExportCommandInput, options?: __HttpHandlerOptions): Promise; + updateExport(args: UpdateExportCommandInput, cb: (err: any, data?: UpdateExportCommandOutput) => void): void; + updateExport( args: UpdateExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateExportCommandOutput) => void ): void; - public updateExport( - args: UpdateExportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateExportCommandOutput) => void), - cb?: (err: any, data?: UpdateExportCommandOutput) => void - ): Promise | void { - const command = new UpdateExportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the settings for an intent.

- */ - public updateIntent( - args: UpdateIntentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateIntent(args: UpdateIntentCommandInput, cb: (err: any, data?: UpdateIntentCommandOutput) => void): void; - public updateIntent( + + /** + * @see {@link UpdateIntentCommand} + */ + updateIntent(args: UpdateIntentCommandInput, options?: __HttpHandlerOptions): Promise; + updateIntent(args: UpdateIntentCommandInput, cb: (err: any, data?: UpdateIntentCommandOutput) => void): void; + updateIntent( args: UpdateIntentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIntentCommandOutput) => void ): void; - public updateIntent( - args: UpdateIntentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateIntentCommandOutput) => void), - cb?: (err: any, data?: UpdateIntentCommandOutput) => void - ): Promise | void { - const command = new UpdateIntentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Replaces the existing resource policy for a bot or bot alias with a - * new one. If the policy doesn't exist, Amazon Lex returns an - * exception.

- */ - public updateResourcePolicy( + + /** + * @see {@link UpdateResourcePolicyCommand} + */ + updateResourcePolicy( args: UpdateResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateResourcePolicy( + updateResourcePolicy( args: UpdateResourcePolicyCommandInput, cb: (err: any, data?: UpdateResourcePolicyCommandOutput) => void ): void; - public updateResourcePolicy( + updateResourcePolicy( args: UpdateResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResourcePolicyCommandOutput) => void ): void; - public updateResourcePolicy( - args: UpdateResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: UpdateResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new UpdateResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the settings for a slot.

- */ - public updateSlot(args: UpdateSlotCommandInput, options?: __HttpHandlerOptions): Promise; - public updateSlot(args: UpdateSlotCommandInput, cb: (err: any, data?: UpdateSlotCommandOutput) => void): void; - public updateSlot( + + /** + * @see {@link UpdateSlotCommand} + */ + updateSlot(args: UpdateSlotCommandInput, options?: __HttpHandlerOptions): Promise; + updateSlot(args: UpdateSlotCommandInput, cb: (err: any, data?: UpdateSlotCommandOutput) => void): void; + updateSlot( args: UpdateSlotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSlotCommandOutput) => void ): void; - public updateSlot( - args: UpdateSlotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSlotCommandOutput) => void), - cb?: (err: any, data?: UpdateSlotCommandOutput) => void - ): Promise | void { - const command = new UpdateSlotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the configuration of an existing slot type.

- */ - public updateSlotType( + + /** + * @see {@link UpdateSlotTypeCommand} + */ + updateSlotType( args: UpdateSlotTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSlotType( - args: UpdateSlotTypeCommandInput, - cb: (err: any, data?: UpdateSlotTypeCommandOutput) => void - ): void; - public updateSlotType( + updateSlotType(args: UpdateSlotTypeCommandInput, cb: (err: any, data?: UpdateSlotTypeCommandOutput) => void): void; + updateSlotType( args: UpdateSlotTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSlotTypeCommandOutput) => void ): void; - public updateSlotType( - args: UpdateSlotTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSlotTypeCommandOutput) => void), - cb?: (err: any, data?: UpdateSlotTypeCommandOutput) => void - ): Promise | void { - const command = new UpdateSlotTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

+ */ +export class LexModelsV2 extends LexModelsV2Client implements LexModelsV2 {} +createAggregatedClient(commands, LexModelsV2); diff --git a/clients/client-lex-runtime-service/src/LexRuntimeService.ts b/clients/client-lex-runtime-service/src/LexRuntimeService.ts index be5cdbcdb1e4..8962c1090300 100644 --- a/clients/client-lex-runtime-service/src/LexRuntimeService.ts +++ b/clients/client-lex-runtime-service/src/LexRuntimeService.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -10,319 +11,87 @@ import { GetSessionCommand, GetSessionCommandInput, GetSessionCommandOutput } fr import { PostContentCommand, PostContentCommandInput, PostContentCommandOutput } from "./commands/PostContentCommand"; import { PostTextCommand, PostTextCommandInput, PostTextCommandOutput } from "./commands/PostTextCommand"; import { PutSessionCommand, PutSessionCommandInput, PutSessionCommandOutput } from "./commands/PutSessionCommand"; -import { LexRuntimeServiceClient } from "./LexRuntimeServiceClient"; +import { LexRuntimeServiceClient, LexRuntimeServiceClientConfig } from "./LexRuntimeServiceClient"; -/** - * @public - *

Amazon Lex provides both build and runtime endpoints. Each endpoint - * provides a set of operations (API). Your conversational bot uses the - * runtime API to understand user utterances (user input text or voice). For - * example, suppose a user says "I want pizza", your bot sends this input to - * Amazon Lex using the runtime API. Amazon Lex recognizes that the user - * request is for the OrderPizza intent (one of the intents defined in the - * bot). Then Amazon Lex engages in user conversation on behalf of the bot to - * elicit required information (slot values, such as pizza size and crust - * type), and then performs fulfillment activity (that you configured when - * you created the bot). You use the build-time API to create and manage your - * Amazon Lex bot. For a list of build-time operations, see the build-time - * API, .

- */ -export class LexRuntimeService extends LexRuntimeServiceClient { +const commands = { + DeleteSessionCommand, + GetSessionCommand, + PostContentCommand, + PostTextCommand, + PutSessionCommand, +}; + +export interface LexRuntimeService { /** - * @public - *

Removes session information for a specified bot, alias, and user ID. - *

+ * @see {@link DeleteSessionCommand} */ - public deleteSession( - args: DeleteSessionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteSession( - args: DeleteSessionCommandInput, - cb: (err: any, data?: DeleteSessionCommandOutput) => void - ): void; - public deleteSession( + deleteSession(args: DeleteSessionCommandInput, options?: __HttpHandlerOptions): Promise; + deleteSession(args: DeleteSessionCommandInput, cb: (err: any, data?: DeleteSessionCommandOutput) => void): void; + deleteSession( args: DeleteSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSessionCommandOutput) => void ): void; - public deleteSession( - args: DeleteSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSessionCommandOutput) => void), - cb?: (err: any, data?: DeleteSessionCommandOutput) => void - ): Promise | void { - const command = new DeleteSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns session information for a specified bot, alias, and user - * ID.

+ * @see {@link GetSessionCommand} */ - public getSession(args: GetSessionCommandInput, options?: __HttpHandlerOptions): Promise; - public getSession(args: GetSessionCommandInput, cb: (err: any, data?: GetSessionCommandOutput) => void): void; - public getSession( + getSession(args: GetSessionCommandInput, options?: __HttpHandlerOptions): Promise; + getSession(args: GetSessionCommandInput, cb: (err: any, data?: GetSessionCommandOutput) => void): void; + getSession( args: GetSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSessionCommandOutput) => void ): void; - public getSession( - args: GetSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSessionCommandOutput) => void), - cb?: (err: any, data?: GetSessionCommandOutput) => void - ): Promise | void { - const command = new GetSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sends user input (text or speech) to Amazon Lex. Clients use this API to - * send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the - * user input using the machine learning model that it built for the bot.

- *

The PostContent operation supports audio input at 8kHz - * and 16kHz. You can use 8kHz audio to achieve higher speech recognition - * accuracy in telephone audio applications.

- *

In response, Amazon Lex returns the next message to convey to the user. - * Consider the following example messages:

- *
    - *
  • - *

    For a user input "I would like a pizza," Amazon Lex might return a - * response with a message eliciting slot data (for example, - * PizzaSize): "What size pizza would you like?".

    - *
  • - *
  • - *

    After the user provides all of the pizza order information, Amazon Lex - * might return a response with a message to get user confirmation: - * "Order the pizza?".

    - *
  • - *
  • - *

    After the user replies "Yes" to the confirmation prompt, Amazon Lex - * might return a conclusion statement: "Thank you, your cheese pizza has - * been ordered.".

    - *
  • - *
- *

Not all Amazon Lex messages require a response from the user. For example, - * conclusion statements do not require a response. Some messages require - * only a yes or no response. In addition to the message, Amazon Lex - * provides additional context about the message in the response that you can - * use to enhance client behavior, such as displaying the appropriate client - * user interface. Consider the following examples:

- *
    - *
  • - *

    If the message is to elicit slot data, Amazon Lex returns the - * following context information:

    - *
      - *
    • - *

      - * x-amz-lex-dialog-state header set to - * ElicitSlot - *

      - *
    • - *
    • - *

      - * x-amz-lex-intent-name header set to the intent name - * in the current context

      - *
    • - *
    • - *

      - * x-amz-lex-slot-to-elicit header set to the slot name - * for which the message is eliciting information - *

      - *
    • - *
    • - *

      - * x-amz-lex-slots header set to a map of slots - * configured for the intent with their current values

      - *
    • - *
    - *
  • - *
  • - *

    If the message is a confirmation prompt, the - * x-amz-lex-dialog-state header is set to - * Confirmation and the - * x-amz-lex-slot-to-elicit header is omitted.

    - *
  • - *
  • - *

    If the message is a clarification prompt configured for the - * intent, indicating that the user intent is not understood, the - * x-amz-dialog-state header is set to - * ElicitIntent and the x-amz-slot-to-elicit - * header is omitted.

    - *
  • - *
- *

In addition, Amazon Lex also returns your application-specific - * sessionAttributes. For more information, see Managing - * Conversation Context.

+ * @see {@link PostContentCommand} */ - public postContent(args: PostContentCommandInput, options?: __HttpHandlerOptions): Promise; - public postContent(args: PostContentCommandInput, cb: (err: any, data?: PostContentCommandOutput) => void): void; - public postContent( + postContent(args: PostContentCommandInput, options?: __HttpHandlerOptions): Promise; + postContent(args: PostContentCommandInput, cb: (err: any, data?: PostContentCommandOutput) => void): void; + postContent( args: PostContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PostContentCommandOutput) => void ): void; - public postContent( - args: PostContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PostContentCommandOutput) => void), - cb?: (err: any, data?: PostContentCommandOutput) => void - ): Promise | void { - const command = new PostContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sends user input to Amazon Lex. Client applications can use this API to - * send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input - * using the machine learning model it built for the bot.

- *

In response, Amazon Lex returns the next message to convey to - * the user an optional responseCard to display. Consider the - * following example messages:

- *
    - *
  • - *

    For a user input "I would like a pizza", Amazon Lex might return a - * response with a message eliciting slot data (for example, PizzaSize): - * "What size pizza would you like?"

    - *
  • - *
  • - *

    After the user provides all of the pizza order information, - * Amazon Lex might return a response with a message to obtain user - * confirmation "Proceed with the pizza order?".

    - *
  • - *
  • - *

    After the user replies to a confirmation prompt with a "yes", - * Amazon Lex might return a conclusion statement: "Thank you, your cheese - * pizza has been ordered.".

    - *
  • - *
- * - *

Not all Amazon Lex messages require a user response. For example, a - * conclusion statement does not require a response. Some messages require - * only a "yes" or "no" user response. In addition to the - * message, Amazon Lex provides additional context about the - * message in the response that you might use to enhance client behavior, for - * example, to display the appropriate client user interface. These are the - * slotToElicit, dialogState, - * intentName, and slots fields in the response. - * Consider the following examples:

- * - *
    - *
  • - *

    If the message is to elicit slot data, Amazon Lex returns the - * following context information:

    - *
      - *
    • - *

      - * dialogState set to ElicitSlot

      - *
    • - *
    • - *

      - * intentName set to the intent name in the current - * context

      - *
    • - *
    • - *

      - * slotToElicit set to the slot name for which the - * message is eliciting information

      - *
    • - *
    • - *

      - * slots set to a map of slots, configured for the - * intent, with currently known values

      - *
    • - *
    - *
  • - *
  • - *

    If the message is a confirmation prompt, the - * dialogState is set to ConfirmIntent and - * SlotToElicit is set to null.

    - *
  • - *
  • - *

    If the message is a clarification prompt (configured for the - * intent) that indicates that user intent is not understood, the - * dialogState is set to ElicitIntent and - * slotToElicit is set to null.

    - *
  • - *
- * - *

In addition, Amazon Lex also returns your application-specific - * sessionAttributes. For more information, see Managing - * Conversation Context.

+ * @see {@link PostTextCommand} */ - public postText(args: PostTextCommandInput, options?: __HttpHandlerOptions): Promise; - public postText(args: PostTextCommandInput, cb: (err: any, data?: PostTextCommandOutput) => void): void; - public postText( + postText(args: PostTextCommandInput, options?: __HttpHandlerOptions): Promise; + postText(args: PostTextCommandInput, cb: (err: any, data?: PostTextCommandOutput) => void): void; + postText( args: PostTextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PostTextCommandOutput) => void ): void; - public postText( - args: PostTextCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PostTextCommandOutput) => void), - cb?: (err: any, data?: PostTextCommandOutput) => void - ): Promise | void { - const command = new PostTextCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new session or modifies an existing session with an Amazon Lex - * bot. Use this operation to enable your application to set the state of the - * bot.

- *

For more information, see Managing - * Sessions.

+ * @see {@link PutSessionCommand} */ - public putSession(args: PutSessionCommandInput, options?: __HttpHandlerOptions): Promise; - public putSession(args: PutSessionCommandInput, cb: (err: any, data?: PutSessionCommandOutput) => void): void; - public putSession( + putSession(args: PutSessionCommandInput, options?: __HttpHandlerOptions): Promise; + putSession(args: PutSessionCommandInput, cb: (err: any, data?: PutSessionCommandOutput) => void): void; + putSession( args: PutSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSessionCommandOutput) => void ): void; - public putSession( - args: PutSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutSessionCommandOutput) => void), - cb?: (err: any, data?: PutSessionCommandOutput) => void - ): Promise | void { - const command = new PutSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Lex provides both build and runtime endpoints. Each endpoint + * provides a set of operations (API). Your conversational bot uses the + * runtime API to understand user utterances (user input text or voice). For + * example, suppose a user says "I want pizza", your bot sends this input to + * Amazon Lex using the runtime API. Amazon Lex recognizes that the user + * request is for the OrderPizza intent (one of the intents defined in the + * bot). Then Amazon Lex engages in user conversation on behalf of the bot to + * elicit required information (slot values, such as pizza size and crust + * type), and then performs fulfillment activity (that you configured when + * you created the bot). You use the build-time API to create and manage your + * Amazon Lex bot. For a list of build-time operations, see the build-time + * API, .

+ */ +export class LexRuntimeService extends LexRuntimeServiceClient implements LexRuntimeService {} +createAggregatedClient(commands, LexRuntimeService); diff --git a/clients/client-lex-runtime-v2/src/LexRuntimeV2.ts b/clients/client-lex-runtime-v2/src/LexRuntimeV2.ts index ee8026ce074d..6552bc5f1333 100644 --- a/clients/client-lex-runtime-v2/src/LexRuntimeV2.ts +++ b/clients/client-lex-runtime-v2/src/LexRuntimeV2.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -23,370 +24,100 @@ import { StartConversationCommandInput, StartConversationCommandOutput, } from "./commands/StartConversationCommand"; -import { LexRuntimeV2Client } from "./LexRuntimeV2Client"; +import { LexRuntimeV2Client, LexRuntimeV2ClientConfig } from "./LexRuntimeV2Client"; -/** - * @public - *

This section contains documentation for the Amazon Lex V2 Runtime V2 API operations.

- */ -export class LexRuntimeV2 extends LexRuntimeV2Client { +const commands = { + DeleteSessionCommand, + GetSessionCommand, + PutSessionCommand, + RecognizeTextCommand, + RecognizeUtteranceCommand, + StartConversationCommand, +}; + +export interface LexRuntimeV2 { /** - * @public - *

Removes session information for a specified bot, alias, and user ID.

- *

You can use this operation to restart a conversation with a bot. - * When you remove a session, the entire history of the session is removed - * so that you can start again.

- *

You don't need to delete a session. Sessions have a time limit and - * will expire. Set the session time limit when you create the bot. The - * default is 5 minutes, but you can specify anything between 1 minute and - * 24 hours.

- *

If you specify a bot or alias ID that doesn't exist, you receive a - * BadRequestException. - *

- *

If the locale doesn't exist in the bot, or if the locale hasn't been - * enables for the alias, you receive a - * BadRequestException.

+ * @see {@link DeleteSessionCommand} */ - public deleteSession( - args: DeleteSessionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteSession( - args: DeleteSessionCommandInput, - cb: (err: any, data?: DeleteSessionCommandOutput) => void - ): void; - public deleteSession( + deleteSession(args: DeleteSessionCommandInput, options?: __HttpHandlerOptions): Promise; + deleteSession(args: DeleteSessionCommandInput, cb: (err: any, data?: DeleteSessionCommandOutput) => void): void; + deleteSession( args: DeleteSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSessionCommandOutput) => void ): void; - public deleteSession( - args: DeleteSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSessionCommandOutput) => void), - cb?: (err: any, data?: DeleteSessionCommandOutput) => void - ): Promise | void { - const command = new DeleteSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns session information for a specified bot, alias, and - * user.

- *

For example, you can use this operation to retrieve session - * information for a user that has left a long-running session in - * use.

- *

If the bot, alias, or session identifier doesn't exist, Amazon Lex V2 - * returns a BadRequestException. If the locale doesn't exist - * or is not enabled for the alias, you receive a - * BadRequestException.

+ * @see {@link GetSessionCommand} */ - public getSession(args: GetSessionCommandInput, options?: __HttpHandlerOptions): Promise; - public getSession(args: GetSessionCommandInput, cb: (err: any, data?: GetSessionCommandOutput) => void): void; - public getSession( + getSession(args: GetSessionCommandInput, options?: __HttpHandlerOptions): Promise; + getSession(args: GetSessionCommandInput, cb: (err: any, data?: GetSessionCommandOutput) => void): void; + getSession( args: GetSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSessionCommandOutput) => void ): void; - public getSession( - args: GetSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSessionCommandOutput) => void), - cb?: (err: any, data?: GetSessionCommandOutput) => void - ): Promise | void { - const command = new GetSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new session or modifies an existing session with an Amazon Lex V2 - * bot. Use this operation to enable your application to set the state of - * the bot.

+ * @see {@link PutSessionCommand} */ - public putSession(args: PutSessionCommandInput, options?: __HttpHandlerOptions): Promise; - public putSession(args: PutSessionCommandInput, cb: (err: any, data?: PutSessionCommandOutput) => void): void; - public putSession( + putSession(args: PutSessionCommandInput, options?: __HttpHandlerOptions): Promise; + putSession(args: PutSessionCommandInput, cb: (err: any, data?: PutSessionCommandOutput) => void): void; + putSession( args: PutSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSessionCommandOutput) => void ): void; - public putSession( - args: PutSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutSessionCommandOutput) => void), - cb?: (err: any, data?: PutSessionCommandOutput) => void - ): Promise | void { - const command = new PutSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sends user input to Amazon Lex V2. Client applications use this API to send - * requests to Amazon Lex V2 at runtime. Amazon Lex V2 then interprets the user input - * using the machine learning model that it build for the bot.

- *

In response, Amazon Lex V2 returns the next message to convey to the user - * and an optional response card to display.

- *

If the optional post-fulfillment response is specified, the messages - * are returned as follows. For more information, see PostFulfillmentStatusSpecification.

- *
    - *
  • - *

    - * Success message - Returned if - * the Lambda function completes successfully and the intent state is - * fulfilled or ready fulfillment if the message is present.

    - *
  • - *
  • - *

    - * Failed message - The failed - * message is returned if the Lambda function throws an exception or - * if the Lambda function returns a failed intent state without a - * message.

    - *
  • - *
  • - *

    - * Timeout message - If you - * don't configure a timeout message and a timeout, and the Lambda - * function doesn't return within 30 seconds, the timeout message is - * returned. If you configure a timeout, the timeout message is - * returned when the period times out.

    - *
  • - *
- *

For more information, see Completion message.

+ * @see {@link RecognizeTextCommand} */ - public recognizeText( - args: RecognizeTextCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public recognizeText( - args: RecognizeTextCommandInput, - cb: (err: any, data?: RecognizeTextCommandOutput) => void - ): void; - public recognizeText( + recognizeText(args: RecognizeTextCommandInput, options?: __HttpHandlerOptions): Promise; + recognizeText(args: RecognizeTextCommandInput, cb: (err: any, data?: RecognizeTextCommandOutput) => void): void; + recognizeText( args: RecognizeTextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RecognizeTextCommandOutput) => void ): void; - public recognizeText( - args: RecognizeTextCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RecognizeTextCommandOutput) => void), - cb?: (err: any, data?: RecognizeTextCommandOutput) => void - ): Promise | void { - const command = new RecognizeTextCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sends user input to Amazon Lex V2. You can send text or speech. Clients use - * this API to send text and audio requests to Amazon Lex V2 at runtime. Amazon Lex V2 - * interprets the user input using the machine learning model built for - * the bot.

- *

The following request fields must be compressed with gzip and then - * base64 encoded before you send them to Amazon Lex V2.

- *
    - *
  • - *

    requestAttributes

    - *
  • - *
  • - *

    sessionState

    - *
  • - *
- *

The following response fields are compressed using gzip and then - * base64 encoded by Amazon Lex V2. Before you can use these fields, you must - * decode and decompress them.

- *
    - *
  • - *

    inputTranscript

    - *
  • - *
  • - *

    interpretations

    - *
  • - *
  • - *

    messages

    - *
  • - *
  • - *

    requestAttributes

    - *
  • - *
  • - *

    sessionState

    - *
  • - *
- *

The example contains a Java application that compresses and encodes - * a Java object to send to Amazon Lex V2, and a second that decodes and - * decompresses a response from Amazon Lex V2.

- *

If the optional post-fulfillment response is specified, the messages - * are returned as follows. For more information, see PostFulfillmentStatusSpecification.

- *
    - *
  • - *

    - * Success message - Returned if - * the Lambda function completes successfully and the intent state is - * fulfilled or ready fulfillment if the message is present.

    - *
  • - *
  • - *

    - * Failed message - The failed - * message is returned if the Lambda function throws an exception or - * if the Lambda function returns a failed intent state without a - * message.

    - *
  • - *
  • - *

    - * Timeout message - If you - * don't configure a timeout message and a timeout, and the Lambda - * function doesn't return within 30 seconds, the timeout message is - * returned. If you configure a timeout, the timeout message is - * returned when the period times out.

    - *
  • - *
- *

For more information, see Completion message.

+ * @see {@link RecognizeUtteranceCommand} */ - public recognizeUtterance( + recognizeUtterance( args: RecognizeUtteranceCommandInput, options?: __HttpHandlerOptions ): Promise; - public recognizeUtterance( + recognizeUtterance( args: RecognizeUtteranceCommandInput, cb: (err: any, data?: RecognizeUtteranceCommandOutput) => void ): void; - public recognizeUtterance( + recognizeUtterance( args: RecognizeUtteranceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RecognizeUtteranceCommandOutput) => void ): void; - public recognizeUtterance( - args: RecognizeUtteranceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RecognizeUtteranceCommandOutput) => void), - cb?: (err: any, data?: RecognizeUtteranceCommandOutput) => void - ): Promise | void { - const command = new RecognizeUtteranceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts an HTTP/2 bidirectional event stream that enables you to send - * audio, text, or DTMF input in real time. After your application starts - * a conversation, users send input to Amazon Lex V2 as a stream of events. Amazon Lex V2 - * processes the incoming events and responds with streaming text or audio - * events. - *

- *

Audio input must be in the following format: audio/lpcm - * sample-rate=8000 sample-size-bits=16 channel-count=1; - * is-big-endian=false.

- *

If the optional post-fulfillment response is specified, the messages - * are returned as follows. For more information, see PostFulfillmentStatusSpecification.

- *
    - *
  • - *

    - * Success message - Returned if - * the Lambda function completes successfully and the intent state is - * fulfilled or ready fulfillment if the message is present.

    - *
  • - *
  • - *

    - * Failed message - The failed - * message is returned if the Lambda function throws an exception or - * if the Lambda function returns a failed intent state without a - * message.

    - *
  • - *
  • - *

    - * Timeout message - If you - * don't configure a timeout message and a timeout, and the Lambda - * function doesn't return within 30 seconds, the timeout message is - * returned. If you configure a timeout, the timeout message is - * returned when the period times out.

    - *
  • - *
- *

For more information, see Completion message.

- *

If the optional update message is configured, it is played at the - * specified frequency while the Lambda function is running and the update - * message state is active. If the fulfillment update message is not - * active, the Lambda function runs with a 30 second timeout.

- *

For more information, see Update message - *

- *

The StartConversation operation is supported only in - * the following SDKs:

- * + * @see {@link StartConversationCommand} */ - public startConversation( + startConversation( args: StartConversationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startConversation( + startConversation( args: StartConversationCommandInput, cb: (err: any, data?: StartConversationCommandOutput) => void ): void; - public startConversation( + startConversation( args: StartConversationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartConversationCommandOutput) => void ): void; - public startConversation( - args: StartConversationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartConversationCommandOutput) => void), - cb?: (err: any, data?: StartConversationCommandOutput) => void - ): Promise | void { - const command = new StartConversationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

This section contains documentation for the Amazon Lex V2 Runtime V2 API operations.

+ */ +export class LexRuntimeV2 extends LexRuntimeV2Client implements LexRuntimeV2 {} +createAggregatedClient(commands, LexRuntimeV2); diff --git a/clients/client-license-manager-linux-subscriptions/src/LicenseManagerLinuxSubscriptions.ts b/clients/client-license-manager-linux-subscriptions/src/LicenseManagerLinuxSubscriptions.ts index 12ede56ddd5d..bba0059e977a 100644 --- a/clients/client-license-manager-linux-subscriptions/src/LicenseManagerLinuxSubscriptions.ts +++ b/clients/client-license-manager-linux-subscriptions/src/LicenseManagerLinuxSubscriptions.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -21,146 +22,94 @@ import { UpdateServiceSettingsCommandInput, UpdateServiceSettingsCommandOutput, } from "./commands/UpdateServiceSettingsCommand"; -import { LicenseManagerLinuxSubscriptionsClient } from "./LicenseManagerLinuxSubscriptionsClient"; +import { + LicenseManagerLinuxSubscriptionsClient, + LicenseManagerLinuxSubscriptionsClientConfig, +} from "./LicenseManagerLinuxSubscriptionsClient"; -/** - * @public - *

With License Manager, you can discover and track your commercial Linux subscriptions on running - * Amazon EC2 instances.

- */ -export class LicenseManagerLinuxSubscriptions extends LicenseManagerLinuxSubscriptionsClient { +const commands = { + GetServiceSettingsCommand, + ListLinuxSubscriptionInstancesCommand, + ListLinuxSubscriptionsCommand, + UpdateServiceSettingsCommand, +}; + +export interface LicenseManagerLinuxSubscriptions { /** - * @public - *

Lists the Linux subscriptions service settings.

+ * @see {@link GetServiceSettingsCommand} */ - public getServiceSettings( + getServiceSettings( args: GetServiceSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServiceSettings( + getServiceSettings( args: GetServiceSettingsCommandInput, cb: (err: any, data?: GetServiceSettingsCommandOutput) => void ): void; - public getServiceSettings( + getServiceSettings( args: GetServiceSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceSettingsCommandOutput) => void ): void; - public getServiceSettings( - args: GetServiceSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceSettingsCommandOutput) => void), - cb?: (err: any, data?: GetServiceSettingsCommandOutput) => void - ): Promise | void { - const command = new GetServiceSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the running Amazon EC2 instances that were discovered with commercial Linux - * subscriptions.

+ * @see {@link ListLinuxSubscriptionInstancesCommand} */ - public listLinuxSubscriptionInstances( + listLinuxSubscriptionInstances( args: ListLinuxSubscriptionInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLinuxSubscriptionInstances( + listLinuxSubscriptionInstances( args: ListLinuxSubscriptionInstancesCommandInput, cb: (err: any, data?: ListLinuxSubscriptionInstancesCommandOutput) => void ): void; - public listLinuxSubscriptionInstances( + listLinuxSubscriptionInstances( args: ListLinuxSubscriptionInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLinuxSubscriptionInstancesCommandOutput) => void ): void; - public listLinuxSubscriptionInstances( - args: ListLinuxSubscriptionInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLinuxSubscriptionInstancesCommandOutput) => void), - cb?: (err: any, data?: ListLinuxSubscriptionInstancesCommandOutput) => void - ): Promise | void { - const command = new ListLinuxSubscriptionInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the Linux subscriptions that have been discovered. If you have linked your - * organization, the returned results will include data aggregated across your accounts in - * Organizations.

+ * @see {@link ListLinuxSubscriptionsCommand} */ - public listLinuxSubscriptions( + listLinuxSubscriptions( args: ListLinuxSubscriptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLinuxSubscriptions( + listLinuxSubscriptions( args: ListLinuxSubscriptionsCommandInput, cb: (err: any, data?: ListLinuxSubscriptionsCommandOutput) => void ): void; - public listLinuxSubscriptions( + listLinuxSubscriptions( args: ListLinuxSubscriptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLinuxSubscriptionsCommandOutput) => void ): void; - public listLinuxSubscriptions( - args: ListLinuxSubscriptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLinuxSubscriptionsCommandOutput) => void), - cb?: (err: any, data?: ListLinuxSubscriptionsCommandOutput) => void - ): Promise | void { - const command = new ListLinuxSubscriptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the service settings for Linux subscriptions.

+ * @see {@link UpdateServiceSettingsCommand} */ - public updateServiceSettings( + updateServiceSettings( args: UpdateServiceSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateServiceSettings( + updateServiceSettings( args: UpdateServiceSettingsCommandInput, cb: (err: any, data?: UpdateServiceSettingsCommandOutput) => void ): void; - public updateServiceSettings( + updateServiceSettings( args: UpdateServiceSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceSettingsCommandOutput) => void ): void; - public updateServiceSettings( - args: UpdateServiceSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServiceSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateServiceSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateServiceSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

With License Manager, you can discover and track your commercial Linux subscriptions on running + * Amazon EC2 instances.

+ */ +export class LicenseManagerLinuxSubscriptions + extends LicenseManagerLinuxSubscriptionsClient + implements LicenseManagerLinuxSubscriptions {} +createAggregatedClient(commands, LicenseManagerLinuxSubscriptions); diff --git a/clients/client-license-manager-user-subscriptions/src/LicenseManagerUserSubscriptions.ts b/clients/client-license-manager-user-subscriptions/src/LicenseManagerUserSubscriptions.ts index 6cac9989ed61..9aeba446c582 100644 --- a/clients/client-license-manager-user-subscriptions/src/LicenseManagerUserSubscriptions.ts +++ b/clients/client-license-manager-user-subscriptions/src/LicenseManagerUserSubscriptions.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -56,385 +57,208 @@ import { UpdateIdentityProviderSettingsCommandInput, UpdateIdentityProviderSettingsCommandOutput, } from "./commands/UpdateIdentityProviderSettingsCommand"; -import { LicenseManagerUserSubscriptionsClient } from "./LicenseManagerUserSubscriptionsClient"; +import { + LicenseManagerUserSubscriptionsClient, + LicenseManagerUserSubscriptionsClientConfig, +} from "./LicenseManagerUserSubscriptionsClient"; -/** - * @public - *

With License Manager, you can create user-based subscriptions to utilize licensed software with - * a per user subscription fee on Amazon EC2 instances.

- */ -export class LicenseManagerUserSubscriptions extends LicenseManagerUserSubscriptionsClient { +const commands = { + AssociateUserCommand, + DeregisterIdentityProviderCommand, + DisassociateUserCommand, + ListIdentityProvidersCommand, + ListInstancesCommand, + ListProductSubscriptionsCommand, + ListUserAssociationsCommand, + RegisterIdentityProviderCommand, + StartProductSubscriptionCommand, + StopProductSubscriptionCommand, + UpdateIdentityProviderSettingsCommand, +}; + +export interface LicenseManagerUserSubscriptions { /** - * @public - *

Associates the user to an EC2 instance to utilize user-based subscriptions.

- * - *

Your estimated bill for charges on the number of users and related costs will take 48 - * hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your - * monthly charges in the Amazon Web Services Billing User Guide.

- *
+ * @see {@link AssociateUserCommand} */ - public associateUser( - args: AssociateUserCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public associateUser( - args: AssociateUserCommandInput, - cb: (err: any, data?: AssociateUserCommandOutput) => void - ): void; - public associateUser( + associateUser(args: AssociateUserCommandInput, options?: __HttpHandlerOptions): Promise; + associateUser(args: AssociateUserCommandInput, cb: (err: any, data?: AssociateUserCommandOutput) => void): void; + associateUser( args: AssociateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateUserCommandOutput) => void ): void; - public associateUser( - args: AssociateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateUserCommandOutput) => void), - cb?: (err: any, data?: AssociateUserCommandOutput) => void - ): Promise | void { - const command = new AssociateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deregisters the identity provider from providing user-based subscriptions.

+ * @see {@link DeregisterIdentityProviderCommand} */ - public deregisterIdentityProvider( + deregisterIdentityProvider( args: DeregisterIdentityProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterIdentityProvider( + deregisterIdentityProvider( args: DeregisterIdentityProviderCommandInput, cb: (err: any, data?: DeregisterIdentityProviderCommandOutput) => void ): void; - public deregisterIdentityProvider( + deregisterIdentityProvider( args: DeregisterIdentityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterIdentityProviderCommandOutput) => void ): void; - public deregisterIdentityProvider( - args: DeregisterIdentityProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterIdentityProviderCommandOutput) => void), - cb?: (err: any, data?: DeregisterIdentityProviderCommandOutput) => void - ): Promise | void { - const command = new DeregisterIdentityProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates the user from an EC2 instance providing user-based subscriptions.

+ * @see {@link DisassociateUserCommand} */ - public disassociateUser( + disassociateUser( args: DisassociateUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateUser( + disassociateUser( args: DisassociateUserCommandInput, cb: (err: any, data?: DisassociateUserCommandOutput) => void ): void; - public disassociateUser( + disassociateUser( args: DisassociateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateUserCommandOutput) => void ): void; - public disassociateUser( - args: DisassociateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateUserCommandOutput) => void), - cb?: (err: any, data?: DisassociateUserCommandOutput) => void - ): Promise | void { - const command = new DisassociateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the identity providers for user-based subscriptions.

+ * @see {@link ListIdentityProvidersCommand} */ - public listIdentityProviders( + listIdentityProviders( args: ListIdentityProvidersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listIdentityProviders( + listIdentityProviders( args: ListIdentityProvidersCommandInput, cb: (err: any, data?: ListIdentityProvidersCommandOutput) => void ): void; - public listIdentityProviders( + listIdentityProviders( args: ListIdentityProvidersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIdentityProvidersCommandOutput) => void ): void; - public listIdentityProviders( - args: ListIdentityProvidersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIdentityProvidersCommandOutput) => void), - cb?: (err: any, data?: ListIdentityProvidersCommandOutput) => void - ): Promise | void { - const command = new ListIdentityProvidersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the EC2 instances providing user-based subscriptions.

+ * @see {@link ListInstancesCommand} */ - public listInstances( - args: ListInstancesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listInstances( - args: ListInstancesCommandInput, - cb: (err: any, data?: ListInstancesCommandOutput) => void - ): void; - public listInstances( + listInstances(args: ListInstancesCommandInput, options?: __HttpHandlerOptions): Promise; + listInstances(args: ListInstancesCommandInput, cb: (err: any, data?: ListInstancesCommandOutput) => void): void; + listInstances( args: ListInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInstancesCommandOutput) => void ): void; - public listInstances( - args: ListInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInstancesCommandOutput) => void), - cb?: (err: any, data?: ListInstancesCommandOutput) => void - ): Promise | void { - const command = new ListInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the user-based subscription products available from an identity provider.

+ * @see {@link ListProductSubscriptionsCommand} */ - public listProductSubscriptions( + listProductSubscriptions( args: ListProductSubscriptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProductSubscriptions( + listProductSubscriptions( args: ListProductSubscriptionsCommandInput, cb: (err: any, data?: ListProductSubscriptionsCommandOutput) => void ): void; - public listProductSubscriptions( + listProductSubscriptions( args: ListProductSubscriptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProductSubscriptionsCommandOutput) => void ): void; - public listProductSubscriptions( - args: ListProductSubscriptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProductSubscriptionsCommandOutput) => void), - cb?: (err: any, data?: ListProductSubscriptionsCommandOutput) => void - ): Promise | void { - const command = new ListProductSubscriptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists user associations for an identity provider.

+ * @see {@link ListUserAssociationsCommand} */ - public listUserAssociations( + listUserAssociations( args: ListUserAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listUserAssociations( + listUserAssociations( args: ListUserAssociationsCommandInput, cb: (err: any, data?: ListUserAssociationsCommandOutput) => void ): void; - public listUserAssociations( + listUserAssociations( args: ListUserAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUserAssociationsCommandOutput) => void ): void; - public listUserAssociations( - args: ListUserAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUserAssociationsCommandOutput) => void), - cb?: (err: any, data?: ListUserAssociationsCommandOutput) => void - ): Promise | void { - const command = new ListUserAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers an identity provider for user-based subscriptions.

+ * @see {@link RegisterIdentityProviderCommand} */ - public registerIdentityProvider( + registerIdentityProvider( args: RegisterIdentityProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerIdentityProvider( + registerIdentityProvider( args: RegisterIdentityProviderCommandInput, cb: (err: any, data?: RegisterIdentityProviderCommandOutput) => void ): void; - public registerIdentityProvider( + registerIdentityProvider( args: RegisterIdentityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterIdentityProviderCommandOutput) => void ): void; - public registerIdentityProvider( - args: RegisterIdentityProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterIdentityProviderCommandOutput) => void), - cb?: (err: any, data?: RegisterIdentityProviderCommandOutput) => void - ): Promise | void { - const command = new RegisterIdentityProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a product subscription for a user with the specified identity provider.

- * - *

Your estimated bill for charges on the number of users and related costs will take 48 - * hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your - * monthly charges in the Amazon Web Services Billing User Guide.

- *
+ * @see {@link StartProductSubscriptionCommand} */ - public startProductSubscription( + startProductSubscription( args: StartProductSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startProductSubscription( + startProductSubscription( args: StartProductSubscriptionCommandInput, cb: (err: any, data?: StartProductSubscriptionCommandOutput) => void ): void; - public startProductSubscription( + startProductSubscription( args: StartProductSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartProductSubscriptionCommandOutput) => void ): void; - public startProductSubscription( - args: StartProductSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartProductSubscriptionCommandOutput) => void), - cb?: (err: any, data?: StartProductSubscriptionCommandOutput) => void - ): Promise | void { - const command = new StartProductSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops a product subscription for a user with the specified identity provider.

+ * @see {@link StopProductSubscriptionCommand} */ - public stopProductSubscription( + stopProductSubscription( args: StopProductSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopProductSubscription( + stopProductSubscription( args: StopProductSubscriptionCommandInput, cb: (err: any, data?: StopProductSubscriptionCommandOutput) => void ): void; - public stopProductSubscription( + stopProductSubscription( args: StopProductSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopProductSubscriptionCommandOutput) => void ): void; - public stopProductSubscription( - args: StopProductSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopProductSubscriptionCommandOutput) => void), - cb?: (err: any, data?: StopProductSubscriptionCommandOutput) => void - ): Promise | void { - const command = new StopProductSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates additional product configuration settings for the registered identity - * provider.

+ * @see {@link UpdateIdentityProviderSettingsCommand} */ - public updateIdentityProviderSettings( + updateIdentityProviderSettings( args: UpdateIdentityProviderSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateIdentityProviderSettings( + updateIdentityProviderSettings( args: UpdateIdentityProviderSettingsCommandInput, cb: (err: any, data?: UpdateIdentityProviderSettingsCommandOutput) => void ): void; - public updateIdentityProviderSettings( + updateIdentityProviderSettings( args: UpdateIdentityProviderSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIdentityProviderSettingsCommandOutput) => void ): void; - public updateIdentityProviderSettings( - args: UpdateIdentityProviderSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateIdentityProviderSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateIdentityProviderSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateIdentityProviderSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

With License Manager, you can create user-based subscriptions to utilize licensed software with + * a per user subscription fee on Amazon EC2 instances.

+ */ +export class LicenseManagerUserSubscriptions + extends LicenseManagerUserSubscriptionsClient + implements LicenseManagerUserSubscriptions {} +createAggregatedClient(commands, LicenseManagerUserSubscriptions); diff --git a/clients/client-license-manager/src/LicenseManager.ts b/clients/client-license-manager/src/LicenseManager.ts index 14d4a65d9fee..971b65576ef9 100644 --- a/clients/client-license-manager/src/LicenseManager.ts +++ b/clients/client-license-manager/src/LicenseManager.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { AcceptGrantCommand, AcceptGrantCommandInput, AcceptGrantCommandOutput } from "./commands/AcceptGrantCommand"; @@ -211,1636 +212,821 @@ import { UpdateServiceSettingsCommandInput, UpdateServiceSettingsCommandOutput, } from "./commands/UpdateServiceSettingsCommand"; -import { LicenseManagerClient } from "./LicenseManagerClient"; +import { LicenseManagerClient, LicenseManagerClientConfig } from "./LicenseManagerClient"; -/** - * @public - *

License Manager makes it easier to manage licenses from software vendors across multiple - * Amazon Web Services accounts and on-premises servers.

- */ -export class LicenseManager extends LicenseManagerClient { +const commands = { + AcceptGrantCommand, + CheckInLicenseCommand, + CheckoutBorrowLicenseCommand, + CheckoutLicenseCommand, + CreateGrantCommand, + CreateGrantVersionCommand, + CreateLicenseCommand, + CreateLicenseConfigurationCommand, + CreateLicenseConversionTaskForResourceCommand, + CreateLicenseManagerReportGeneratorCommand, + CreateLicenseVersionCommand, + CreateTokenCommand, + DeleteGrantCommand, + DeleteLicenseCommand, + DeleteLicenseConfigurationCommand, + DeleteLicenseManagerReportGeneratorCommand, + DeleteTokenCommand, + ExtendLicenseConsumptionCommand, + GetAccessTokenCommand, + GetGrantCommand, + GetLicenseCommand, + GetLicenseConfigurationCommand, + GetLicenseConversionTaskCommand, + GetLicenseManagerReportGeneratorCommand, + GetLicenseUsageCommand, + GetServiceSettingsCommand, + ListAssociationsForLicenseConfigurationCommand, + ListDistributedGrantsCommand, + ListFailuresForLicenseConfigurationOperationsCommand, + ListLicenseConfigurationsCommand, + ListLicenseConversionTasksCommand, + ListLicenseManagerReportGeneratorsCommand, + ListLicensesCommand, + ListLicenseSpecificationsForResourceCommand, + ListLicenseVersionsCommand, + ListReceivedGrantsCommand, + ListReceivedGrantsForOrganizationCommand, + ListReceivedLicensesCommand, + ListReceivedLicensesForOrganizationCommand, + ListResourceInventoryCommand, + ListTagsForResourceCommand, + ListTokensCommand, + ListUsageForLicenseConfigurationCommand, + RejectGrantCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateLicenseConfigurationCommand, + UpdateLicenseManagerReportGeneratorCommand, + UpdateLicenseSpecificationsForResourceCommand, + UpdateServiceSettingsCommand, +}; + +export interface LicenseManager { /** - * @public - *

Accepts the specified grant.

+ * @see {@link AcceptGrantCommand} */ - public acceptGrant(args: AcceptGrantCommandInput, options?: __HttpHandlerOptions): Promise; - public acceptGrant(args: AcceptGrantCommandInput, cb: (err: any, data?: AcceptGrantCommandOutput) => void): void; - public acceptGrant( + acceptGrant(args: AcceptGrantCommandInput, options?: __HttpHandlerOptions): Promise; + acceptGrant(args: AcceptGrantCommandInput, cb: (err: any, data?: AcceptGrantCommandOutput) => void): void; + acceptGrant( args: AcceptGrantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptGrantCommandOutput) => void ): void; - public acceptGrant( - args: AcceptGrantCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptGrantCommandOutput) => void), - cb?: (err: any, data?: AcceptGrantCommandOutput) => void - ): Promise | void { - const command = new AcceptGrantCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Checks in the specified license. Check in a license when it is no longer in use.

+ * @see {@link CheckInLicenseCommand} */ - public checkInLicense( + checkInLicense( args: CheckInLicenseCommandInput, options?: __HttpHandlerOptions ): Promise; - public checkInLicense( - args: CheckInLicenseCommandInput, - cb: (err: any, data?: CheckInLicenseCommandOutput) => void - ): void; - public checkInLicense( + checkInLicense(args: CheckInLicenseCommandInput, cb: (err: any, data?: CheckInLicenseCommandOutput) => void): void; + checkInLicense( args: CheckInLicenseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CheckInLicenseCommandOutput) => void ): void; - public checkInLicense( - args: CheckInLicenseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CheckInLicenseCommandOutput) => void), - cb?: (err: any, data?: CheckInLicenseCommandOutput) => void - ): Promise | void { - const command = new CheckInLicenseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Checks out the specified license for offline use.

+ * @see {@link CheckoutBorrowLicenseCommand} */ - public checkoutBorrowLicense( + checkoutBorrowLicense( args: CheckoutBorrowLicenseCommandInput, options?: __HttpHandlerOptions ): Promise; - public checkoutBorrowLicense( + checkoutBorrowLicense( args: CheckoutBorrowLicenseCommandInput, cb: (err: any, data?: CheckoutBorrowLicenseCommandOutput) => void ): void; - public checkoutBorrowLicense( + checkoutBorrowLicense( args: CheckoutBorrowLicenseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CheckoutBorrowLicenseCommandOutput) => void ): void; - public checkoutBorrowLicense( - args: CheckoutBorrowLicenseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CheckoutBorrowLicenseCommandOutput) => void), - cb?: (err: any, data?: CheckoutBorrowLicenseCommandOutput) => void - ): Promise | void { - const command = new CheckoutBorrowLicenseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Checks out the specified license.

- * - *

If the account that created the license is the same that is performing the check out, you must - * specify the account as the beneficiary.

- *
+ * @see {@link CheckoutLicenseCommand} */ - public checkoutLicense( + checkoutLicense( args: CheckoutLicenseCommandInput, options?: __HttpHandlerOptions ): Promise; - public checkoutLicense( - args: CheckoutLicenseCommandInput, - cb: (err: any, data?: CheckoutLicenseCommandOutput) => void - ): void; - public checkoutLicense( + checkoutLicense(args: CheckoutLicenseCommandInput, cb: (err: any, data?: CheckoutLicenseCommandOutput) => void): void; + checkoutLicense( args: CheckoutLicenseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CheckoutLicenseCommandOutput) => void ): void; - public checkoutLicense( - args: CheckoutLicenseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CheckoutLicenseCommandOutput) => void), - cb?: (err: any, data?: CheckoutLicenseCommandOutput) => void - ): Promise | void { - const command = new CheckoutLicenseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a grant for the specified license. A grant shares the use of license - * entitlements with a specific Amazon Web Services account, an organization, or an - * organizational unit (OU). For more information, see Granted licenses in License Manager in the License Manager User Guide.

+ * @see {@link CreateGrantCommand} */ - public createGrant(args: CreateGrantCommandInput, options?: __HttpHandlerOptions): Promise; - public createGrant(args: CreateGrantCommandInput, cb: (err: any, data?: CreateGrantCommandOutput) => void): void; - public createGrant( + createGrant(args: CreateGrantCommandInput, options?: __HttpHandlerOptions): Promise; + createGrant(args: CreateGrantCommandInput, cb: (err: any, data?: CreateGrantCommandOutput) => void): void; + createGrant( args: CreateGrantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGrantCommandOutput) => void ): void; - public createGrant( - args: CreateGrantCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGrantCommandOutput) => void), - cb?: (err: any, data?: CreateGrantCommandOutput) => void - ): Promise | void { - const command = new CreateGrantCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new version of the specified grant. For more information, see - * Granted licenses in License Manager in the License Manager User Guide.

+ * @see {@link CreateGrantVersionCommand} */ - public createGrantVersion( + createGrantVersion( args: CreateGrantVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createGrantVersion( + createGrantVersion( args: CreateGrantVersionCommandInput, cb: (err: any, data?: CreateGrantVersionCommandOutput) => void ): void; - public createGrantVersion( + createGrantVersion( args: CreateGrantVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGrantVersionCommandOutput) => void ): void; - public createGrantVersion( - args: CreateGrantVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGrantVersionCommandOutput) => void), - cb?: (err: any, data?: CreateGrantVersionCommandOutput) => void - ): Promise | void { - const command = new CreateGrantVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a license.

+ * @see {@link CreateLicenseCommand} */ - public createLicense( - args: CreateLicenseCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createLicense( - args: CreateLicenseCommandInput, - cb: (err: any, data?: CreateLicenseCommandOutput) => void - ): void; - public createLicense( + createLicense(args: CreateLicenseCommandInput, options?: __HttpHandlerOptions): Promise; + createLicense(args: CreateLicenseCommandInput, cb: (err: any, data?: CreateLicenseCommandOutput) => void): void; + createLicense( args: CreateLicenseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLicenseCommandOutput) => void ): void; - public createLicense( - args: CreateLicenseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLicenseCommandOutput) => void), - cb?: (err: any, data?: CreateLicenseCommandOutput) => void - ): Promise | void { - const command = new CreateLicenseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a license configuration.

- *

A license configuration is an abstraction of a customer license agreement that can be - * consumed and enforced by License Manager. Components include specifications for the license - * type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, - * Dedicated Instance, Dedicated Host, or all of these), license affinity to host (how long a - * license must be associated with a host), and the number of licenses purchased and used.

+ * @see {@link CreateLicenseConfigurationCommand} */ - public createLicenseConfiguration( + createLicenseConfiguration( args: CreateLicenseConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLicenseConfiguration( + createLicenseConfiguration( args: CreateLicenseConfigurationCommandInput, cb: (err: any, data?: CreateLicenseConfigurationCommandOutput) => void ): void; - public createLicenseConfiguration( + createLicenseConfiguration( args: CreateLicenseConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLicenseConfigurationCommandOutput) => void ): void; - public createLicenseConfiguration( - args: CreateLicenseConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLicenseConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateLicenseConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateLicenseConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new license conversion task.

+ * @see {@link CreateLicenseConversionTaskForResourceCommand} */ - public createLicenseConversionTaskForResource( + createLicenseConversionTaskForResource( args: CreateLicenseConversionTaskForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLicenseConversionTaskForResource( + createLicenseConversionTaskForResource( args: CreateLicenseConversionTaskForResourceCommandInput, cb: (err: any, data?: CreateLicenseConversionTaskForResourceCommandOutput) => void ): void; - public createLicenseConversionTaskForResource( + createLicenseConversionTaskForResource( args: CreateLicenseConversionTaskForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLicenseConversionTaskForResourceCommandOutput) => void ): void; - public createLicenseConversionTaskForResource( - args: CreateLicenseConversionTaskForResourceCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateLicenseConversionTaskForResourceCommandOutput) => void), - cb?: (err: any, data?: CreateLicenseConversionTaskForResourceCommandOutput) => void - ): Promise | void { - const command = new CreateLicenseConversionTaskForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a report generator.

+ * @see {@link CreateLicenseManagerReportGeneratorCommand} */ - public createLicenseManagerReportGenerator( + createLicenseManagerReportGenerator( args: CreateLicenseManagerReportGeneratorCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLicenseManagerReportGenerator( + createLicenseManagerReportGenerator( args: CreateLicenseManagerReportGeneratorCommandInput, cb: (err: any, data?: CreateLicenseManagerReportGeneratorCommandOutput) => void ): void; - public createLicenseManagerReportGenerator( + createLicenseManagerReportGenerator( args: CreateLicenseManagerReportGeneratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLicenseManagerReportGeneratorCommandOutput) => void ): void; - public createLicenseManagerReportGenerator( - args: CreateLicenseManagerReportGeneratorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLicenseManagerReportGeneratorCommandOutput) => void), - cb?: (err: any, data?: CreateLicenseManagerReportGeneratorCommandOutput) => void - ): Promise | void { - const command = new CreateLicenseManagerReportGeneratorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new version of the specified license.

+ * @see {@link CreateLicenseVersionCommand} */ - public createLicenseVersion( + createLicenseVersion( args: CreateLicenseVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLicenseVersion( + createLicenseVersion( args: CreateLicenseVersionCommandInput, cb: (err: any, data?: CreateLicenseVersionCommandOutput) => void ): void; - public createLicenseVersion( + createLicenseVersion( args: CreateLicenseVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLicenseVersionCommandOutput) => void ): void; - public createLicenseVersion( - args: CreateLicenseVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLicenseVersionCommandOutput) => void), - cb?: (err: any, data?: CreateLicenseVersionCommandOutput) => void - ): Promise | void { - const command = new CreateLicenseVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a long-lived token.

- *

A refresh token is a JWT token used to get an access token. With an access token, - * you can call AssumeRoleWithWebIdentity to get role credentials that you can use to - * call License Manager to manage the specified license.

+ * @see {@link CreateTokenCommand} */ - public createToken(args: CreateTokenCommandInput, options?: __HttpHandlerOptions): Promise; - public createToken(args: CreateTokenCommandInput, cb: (err: any, data?: CreateTokenCommandOutput) => void): void; - public createToken( + createToken(args: CreateTokenCommandInput, options?: __HttpHandlerOptions): Promise; + createToken(args: CreateTokenCommandInput, cb: (err: any, data?: CreateTokenCommandOutput) => void): void; + createToken( args: CreateTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTokenCommandOutput) => void ): void; - public createToken( - args: CreateTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTokenCommandOutput) => void), - cb?: (err: any, data?: CreateTokenCommandOutput) => void - ): Promise | void { - const command = new CreateTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified grant.

+ * @see {@link DeleteGrantCommand} */ - public deleteGrant(args: DeleteGrantCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteGrant(args: DeleteGrantCommandInput, cb: (err: any, data?: DeleteGrantCommandOutput) => void): void; - public deleteGrant( + deleteGrant(args: DeleteGrantCommandInput, options?: __HttpHandlerOptions): Promise; + deleteGrant(args: DeleteGrantCommandInput, cb: (err: any, data?: DeleteGrantCommandOutput) => void): void; + deleteGrant( args: DeleteGrantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGrantCommandOutput) => void ): void; - public deleteGrant( - args: DeleteGrantCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGrantCommandOutput) => void), - cb?: (err: any, data?: DeleteGrantCommandOutput) => void - ): Promise | void { - const command = new DeleteGrantCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified license.

+ * @see {@link DeleteLicenseCommand} */ - public deleteLicense( - args: DeleteLicenseCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteLicense( - args: DeleteLicenseCommandInput, - cb: (err: any, data?: DeleteLicenseCommandOutput) => void - ): void; - public deleteLicense( + deleteLicense(args: DeleteLicenseCommandInput, options?: __HttpHandlerOptions): Promise; + deleteLicense(args: DeleteLicenseCommandInput, cb: (err: any, data?: DeleteLicenseCommandOutput) => void): void; + deleteLicense( args: DeleteLicenseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLicenseCommandOutput) => void ): void; - public deleteLicense( - args: DeleteLicenseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLicenseCommandOutput) => void), - cb?: (err: any, data?: DeleteLicenseCommandOutput) => void - ): Promise | void { - const command = new DeleteLicenseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified license configuration.

- *

You cannot delete a license configuration that is in use.

+ * @see {@link DeleteLicenseConfigurationCommand} */ - public deleteLicenseConfiguration( + deleteLicenseConfiguration( args: DeleteLicenseConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLicenseConfiguration( + deleteLicenseConfiguration( args: DeleteLicenseConfigurationCommandInput, cb: (err: any, data?: DeleteLicenseConfigurationCommandOutput) => void ): void; - public deleteLicenseConfiguration( + deleteLicenseConfiguration( args: DeleteLicenseConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLicenseConfigurationCommandOutput) => void ): void; - public deleteLicenseConfiguration( - args: DeleteLicenseConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLicenseConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteLicenseConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteLicenseConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified report generator.

- *

This action deletes the report generator, which stops it from generating future reports. - * The action cannot be reversed. It has no effect on the previous reports from this generator.

+ * @see {@link DeleteLicenseManagerReportGeneratorCommand} */ - public deleteLicenseManagerReportGenerator( + deleteLicenseManagerReportGenerator( args: DeleteLicenseManagerReportGeneratorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLicenseManagerReportGenerator( + deleteLicenseManagerReportGenerator( args: DeleteLicenseManagerReportGeneratorCommandInput, cb: (err: any, data?: DeleteLicenseManagerReportGeneratorCommandOutput) => void ): void; - public deleteLicenseManagerReportGenerator( + deleteLicenseManagerReportGenerator( args: DeleteLicenseManagerReportGeneratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLicenseManagerReportGeneratorCommandOutput) => void ): void; - public deleteLicenseManagerReportGenerator( - args: DeleteLicenseManagerReportGeneratorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLicenseManagerReportGeneratorCommandOutput) => void), - cb?: (err: any, data?: DeleteLicenseManagerReportGeneratorCommandOutput) => void - ): Promise | void { - const command = new DeleteLicenseManagerReportGeneratorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified token. Must be called in the license home Region.

+ * @see {@link DeleteTokenCommand} */ - public deleteToken(args: DeleteTokenCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteToken(args: DeleteTokenCommandInput, cb: (err: any, data?: DeleteTokenCommandOutput) => void): void; - public deleteToken( + deleteToken(args: DeleteTokenCommandInput, options?: __HttpHandlerOptions): Promise; + deleteToken(args: DeleteTokenCommandInput, cb: (err: any, data?: DeleteTokenCommandOutput) => void): void; + deleteToken( args: DeleteTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTokenCommandOutput) => void ): void; - public deleteToken( - args: DeleteTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTokenCommandOutput) => void), - cb?: (err: any, data?: DeleteTokenCommandOutput) => void - ): Promise | void { - const command = new DeleteTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Extends the expiration date for license consumption.

+ * @see {@link ExtendLicenseConsumptionCommand} */ - public extendLicenseConsumption( + extendLicenseConsumption( args: ExtendLicenseConsumptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public extendLicenseConsumption( + extendLicenseConsumption( args: ExtendLicenseConsumptionCommandInput, cb: (err: any, data?: ExtendLicenseConsumptionCommandOutput) => void ): void; - public extendLicenseConsumption( + extendLicenseConsumption( args: ExtendLicenseConsumptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExtendLicenseConsumptionCommandOutput) => void ): void; - public extendLicenseConsumption( - args: ExtendLicenseConsumptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExtendLicenseConsumptionCommandOutput) => void), - cb?: (err: any, data?: ExtendLicenseConsumptionCommandOutput) => void - ): Promise | void { - const command = new ExtendLicenseConsumptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a temporary access token to use with AssumeRoleWithWebIdentity. Access tokens - * are valid for one hour.

+ * @see {@link GetAccessTokenCommand} */ - public getAccessToken( + getAccessToken( args: GetAccessTokenCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccessToken( - args: GetAccessTokenCommandInput, - cb: (err: any, data?: GetAccessTokenCommandOutput) => void - ): void; - public getAccessToken( + getAccessToken(args: GetAccessTokenCommandInput, cb: (err: any, data?: GetAccessTokenCommandOutput) => void): void; + getAccessToken( args: GetAccessTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessTokenCommandOutput) => void ): void; - public getAccessToken( - args: GetAccessTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccessTokenCommandOutput) => void), - cb?: (err: any, data?: GetAccessTokenCommandOutput) => void - ): Promise | void { - const command = new GetAccessTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets detailed information about the specified grant.

+ * @see {@link GetGrantCommand} */ - public getGrant(args: GetGrantCommandInput, options?: __HttpHandlerOptions): Promise; - public getGrant(args: GetGrantCommandInput, cb: (err: any, data?: GetGrantCommandOutput) => void): void; - public getGrant( + getGrant(args: GetGrantCommandInput, options?: __HttpHandlerOptions): Promise; + getGrant(args: GetGrantCommandInput, cb: (err: any, data?: GetGrantCommandOutput) => void): void; + getGrant( args: GetGrantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGrantCommandOutput) => void ): void; - public getGrant( - args: GetGrantCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGrantCommandOutput) => void), - cb?: (err: any, data?: GetGrantCommandOutput) => void - ): Promise | void { - const command = new GetGrantCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets detailed information about the specified license.

+ * @see {@link GetLicenseCommand} */ - public getLicense(args: GetLicenseCommandInput, options?: __HttpHandlerOptions): Promise; - public getLicense(args: GetLicenseCommandInput, cb: (err: any, data?: GetLicenseCommandOutput) => void): void; - public getLicense( + getLicense(args: GetLicenseCommandInput, options?: __HttpHandlerOptions): Promise; + getLicense(args: GetLicenseCommandInput, cb: (err: any, data?: GetLicenseCommandOutput) => void): void; + getLicense( args: GetLicenseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLicenseCommandOutput) => void ): void; - public getLicense( - args: GetLicenseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLicenseCommandOutput) => void), - cb?: (err: any, data?: GetLicenseCommandOutput) => void - ): Promise | void { - const command = new GetLicenseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets detailed information about the specified license configuration.

+ * @see {@link GetLicenseConfigurationCommand} */ - public getLicenseConfiguration( + getLicenseConfiguration( args: GetLicenseConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLicenseConfiguration( + getLicenseConfiguration( args: GetLicenseConfigurationCommandInput, cb: (err: any, data?: GetLicenseConfigurationCommandOutput) => void ): void; - public getLicenseConfiguration( + getLicenseConfiguration( args: GetLicenseConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLicenseConfigurationCommandOutput) => void ): void; - public getLicenseConfiguration( - args: GetLicenseConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLicenseConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetLicenseConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetLicenseConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about the specified license type conversion task.

+ * @see {@link GetLicenseConversionTaskCommand} */ - public getLicenseConversionTask( + getLicenseConversionTask( args: GetLicenseConversionTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLicenseConversionTask( + getLicenseConversionTask( args: GetLicenseConversionTaskCommandInput, cb: (err: any, data?: GetLicenseConversionTaskCommandOutput) => void ): void; - public getLicenseConversionTask( + getLicenseConversionTask( args: GetLicenseConversionTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLicenseConversionTaskCommandOutput) => void ): void; - public getLicenseConversionTask( - args: GetLicenseConversionTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLicenseConversionTaskCommandOutput) => void), - cb?: (err: any, data?: GetLicenseConversionTaskCommandOutput) => void - ): Promise | void { - const command = new GetLicenseConversionTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about the specified report generator.

+ * @see {@link GetLicenseManagerReportGeneratorCommand} */ - public getLicenseManagerReportGenerator( + getLicenseManagerReportGenerator( args: GetLicenseManagerReportGeneratorCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLicenseManagerReportGenerator( + getLicenseManagerReportGenerator( args: GetLicenseManagerReportGeneratorCommandInput, cb: (err: any, data?: GetLicenseManagerReportGeneratorCommandOutput) => void ): void; - public getLicenseManagerReportGenerator( + getLicenseManagerReportGenerator( args: GetLicenseManagerReportGeneratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLicenseManagerReportGeneratorCommandOutput) => void ): void; - public getLicenseManagerReportGenerator( - args: GetLicenseManagerReportGeneratorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLicenseManagerReportGeneratorCommandOutput) => void), - cb?: (err: any, data?: GetLicenseManagerReportGeneratorCommandOutput) => void - ): Promise | void { - const command = new GetLicenseManagerReportGeneratorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets detailed information about the usage of the specified license.

+ * @see {@link GetLicenseUsageCommand} */ - public getLicenseUsage( + getLicenseUsage( args: GetLicenseUsageCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLicenseUsage( - args: GetLicenseUsageCommandInput, - cb: (err: any, data?: GetLicenseUsageCommandOutput) => void - ): void; - public getLicenseUsage( + getLicenseUsage(args: GetLicenseUsageCommandInput, cb: (err: any, data?: GetLicenseUsageCommandOutput) => void): void; + getLicenseUsage( args: GetLicenseUsageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLicenseUsageCommandOutput) => void ): void; - public getLicenseUsage( - args: GetLicenseUsageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLicenseUsageCommandOutput) => void), - cb?: (err: any, data?: GetLicenseUsageCommandOutput) => void - ): Promise | void { - const command = new GetLicenseUsageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the License Manager settings for the current Region.

+ * @see {@link GetServiceSettingsCommand} */ - public getServiceSettings( + getServiceSettings( args: GetServiceSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServiceSettings( + getServiceSettings( args: GetServiceSettingsCommandInput, cb: (err: any, data?: GetServiceSettingsCommandOutput) => void ): void; - public getServiceSettings( + getServiceSettings( args: GetServiceSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceSettingsCommandOutput) => void ): void; - public getServiceSettings( - args: GetServiceSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceSettingsCommandOutput) => void), - cb?: (err: any, data?: GetServiceSettingsCommandOutput) => void - ): Promise | void { - const command = new GetServiceSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the resource associations for the specified license configuration.

- *

Resource associations need not consume licenses from a license configuration. - * For example, an AMI or a stopped instance might not consume a license (depending on - * the license rules).

+ * @see {@link ListAssociationsForLicenseConfigurationCommand} */ - public listAssociationsForLicenseConfiguration( + listAssociationsForLicenseConfiguration( args: ListAssociationsForLicenseConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssociationsForLicenseConfiguration( + listAssociationsForLicenseConfiguration( args: ListAssociationsForLicenseConfigurationCommandInput, cb: (err: any, data?: ListAssociationsForLicenseConfigurationCommandOutput) => void ): void; - public listAssociationsForLicenseConfiguration( + listAssociationsForLicenseConfiguration( args: ListAssociationsForLicenseConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssociationsForLicenseConfigurationCommandOutput) => void ): void; - public listAssociationsForLicenseConfiguration( - args: ListAssociationsForLicenseConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListAssociationsForLicenseConfigurationCommandOutput) => void), - cb?: (err: any, data?: ListAssociationsForLicenseConfigurationCommandOutput) => void - ): Promise | void { - const command = new ListAssociationsForLicenseConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the grants distributed for the specified license.

+ * @see {@link ListDistributedGrantsCommand} */ - public listDistributedGrants( + listDistributedGrants( args: ListDistributedGrantsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDistributedGrants( + listDistributedGrants( args: ListDistributedGrantsCommandInput, cb: (err: any, data?: ListDistributedGrantsCommandOutput) => void ): void; - public listDistributedGrants( + listDistributedGrants( args: ListDistributedGrantsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDistributedGrantsCommandOutput) => void ): void; - public listDistributedGrants( - args: ListDistributedGrantsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDistributedGrantsCommandOutput) => void), - cb?: (err: any, data?: ListDistributedGrantsCommandOutput) => void - ): Promise | void { - const command = new ListDistributedGrantsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the license configuration operations that failed.

+ * @see {@link ListFailuresForLicenseConfigurationOperationsCommand} */ - public listFailuresForLicenseConfigurationOperations( + listFailuresForLicenseConfigurationOperations( args: ListFailuresForLicenseConfigurationOperationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFailuresForLicenseConfigurationOperations( + listFailuresForLicenseConfigurationOperations( args: ListFailuresForLicenseConfigurationOperationsCommandInput, cb: (err: any, data?: ListFailuresForLicenseConfigurationOperationsCommandOutput) => void ): void; - public listFailuresForLicenseConfigurationOperations( + listFailuresForLicenseConfigurationOperations( args: ListFailuresForLicenseConfigurationOperationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFailuresForLicenseConfigurationOperationsCommandOutput) => void ): void; - public listFailuresForLicenseConfigurationOperations( - args: ListFailuresForLicenseConfigurationOperationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListFailuresForLicenseConfigurationOperationsCommandOutput) => void), - cb?: (err: any, data?: ListFailuresForLicenseConfigurationOperationsCommandOutput) => void - ): Promise | void { - const command = new ListFailuresForLicenseConfigurationOperationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the license configurations for your account.

+ * @see {@link ListLicenseConfigurationsCommand} */ - public listLicenseConfigurations( + listLicenseConfigurations( args: ListLicenseConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLicenseConfigurations( + listLicenseConfigurations( args: ListLicenseConfigurationsCommandInput, cb: (err: any, data?: ListLicenseConfigurationsCommandOutput) => void ): void; - public listLicenseConfigurations( + listLicenseConfigurations( args: ListLicenseConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLicenseConfigurationsCommandOutput) => void ): void; - public listLicenseConfigurations( - args: ListLicenseConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLicenseConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListLicenseConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListLicenseConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the license type conversion tasks for your account.

+ * @see {@link ListLicenseConversionTasksCommand} */ - public listLicenseConversionTasks( + listLicenseConversionTasks( args: ListLicenseConversionTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLicenseConversionTasks( + listLicenseConversionTasks( args: ListLicenseConversionTasksCommandInput, cb: (err: any, data?: ListLicenseConversionTasksCommandOutput) => void ): void; - public listLicenseConversionTasks( + listLicenseConversionTasks( args: ListLicenseConversionTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLicenseConversionTasksCommandOutput) => void ): void; - public listLicenseConversionTasks( - args: ListLicenseConversionTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLicenseConversionTasksCommandOutput) => void), - cb?: (err: any, data?: ListLicenseConversionTasksCommandOutput) => void - ): Promise | void { - const command = new ListLicenseConversionTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the report generators for your account.

+ * @see {@link ListLicenseManagerReportGeneratorsCommand} */ - public listLicenseManagerReportGenerators( + listLicenseManagerReportGenerators( args: ListLicenseManagerReportGeneratorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLicenseManagerReportGenerators( + listLicenseManagerReportGenerators( args: ListLicenseManagerReportGeneratorsCommandInput, cb: (err: any, data?: ListLicenseManagerReportGeneratorsCommandOutput) => void ): void; - public listLicenseManagerReportGenerators( + listLicenseManagerReportGenerators( args: ListLicenseManagerReportGeneratorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLicenseManagerReportGeneratorsCommandOutput) => void ): void; - public listLicenseManagerReportGenerators( - args: ListLicenseManagerReportGeneratorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLicenseManagerReportGeneratorsCommandOutput) => void), - cb?: (err: any, data?: ListLicenseManagerReportGeneratorsCommandOutput) => void - ): Promise | void { - const command = new ListLicenseManagerReportGeneratorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the licenses for your account.

+ * @see {@link ListLicensesCommand} */ - public listLicenses( - args: ListLicensesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listLicenses(args: ListLicensesCommandInput, cb: (err: any, data?: ListLicensesCommandOutput) => void): void; - public listLicenses( + listLicenses(args: ListLicensesCommandInput, options?: __HttpHandlerOptions): Promise; + listLicenses(args: ListLicensesCommandInput, cb: (err: any, data?: ListLicensesCommandOutput) => void): void; + listLicenses( args: ListLicensesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLicensesCommandOutput) => void ): void; - public listLicenses( - args: ListLicensesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLicensesCommandOutput) => void), - cb?: (err: any, data?: ListLicensesCommandOutput) => void - ): Promise | void { - const command = new ListLicensesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the license configurations for the specified resource.

+ * @see {@link ListLicenseSpecificationsForResourceCommand} */ - public listLicenseSpecificationsForResource( + listLicenseSpecificationsForResource( args: ListLicenseSpecificationsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLicenseSpecificationsForResource( + listLicenseSpecificationsForResource( args: ListLicenseSpecificationsForResourceCommandInput, cb: (err: any, data?: ListLicenseSpecificationsForResourceCommandOutput) => void ): void; - public listLicenseSpecificationsForResource( + listLicenseSpecificationsForResource( args: ListLicenseSpecificationsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLicenseSpecificationsForResourceCommandOutput) => void ): void; - public listLicenseSpecificationsForResource( - args: ListLicenseSpecificationsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLicenseSpecificationsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListLicenseSpecificationsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListLicenseSpecificationsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all versions of the specified license.

+ * @see {@link ListLicenseVersionsCommand} */ - public listLicenseVersions( + listLicenseVersions( args: ListLicenseVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLicenseVersions( + listLicenseVersions( args: ListLicenseVersionsCommandInput, cb: (err: any, data?: ListLicenseVersionsCommandOutput) => void ): void; - public listLicenseVersions( + listLicenseVersions( args: ListLicenseVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLicenseVersionsCommandOutput) => void ): void; - public listLicenseVersions( - args: ListLicenseVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLicenseVersionsCommandOutput) => void), - cb?: (err: any, data?: ListLicenseVersionsCommandOutput) => void - ): Promise | void { - const command = new ListLicenseVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists grants that are received. Received grants are grants created while specifying the - * recipient as this Amazon Web Services account, your organization, or an organizational unit - * (OU) to which this member account belongs.

+ * @see {@link ListReceivedGrantsCommand} */ - public listReceivedGrants( + listReceivedGrants( args: ListReceivedGrantsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReceivedGrants( + listReceivedGrants( args: ListReceivedGrantsCommandInput, cb: (err: any, data?: ListReceivedGrantsCommandOutput) => void ): void; - public listReceivedGrants( + listReceivedGrants( args: ListReceivedGrantsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReceivedGrantsCommandOutput) => void ): void; - public listReceivedGrants( - args: ListReceivedGrantsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReceivedGrantsCommandOutput) => void), - cb?: (err: any, data?: ListReceivedGrantsCommandOutput) => void - ): Promise | void { - const command = new ListReceivedGrantsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the grants received for all accounts in the organization.

+ * @see {@link ListReceivedGrantsForOrganizationCommand} */ - public listReceivedGrantsForOrganization( + listReceivedGrantsForOrganization( args: ListReceivedGrantsForOrganizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReceivedGrantsForOrganization( + listReceivedGrantsForOrganization( args: ListReceivedGrantsForOrganizationCommandInput, cb: (err: any, data?: ListReceivedGrantsForOrganizationCommandOutput) => void ): void; - public listReceivedGrantsForOrganization( + listReceivedGrantsForOrganization( args: ListReceivedGrantsForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReceivedGrantsForOrganizationCommandOutput) => void ): void; - public listReceivedGrantsForOrganization( - args: ListReceivedGrantsForOrganizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReceivedGrantsForOrganizationCommandOutput) => void), - cb?: (err: any, data?: ListReceivedGrantsForOrganizationCommandOutput) => void - ): Promise | void { - const command = new ListReceivedGrantsForOrganizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists received licenses.

+ * @see {@link ListReceivedLicensesCommand} */ - public listReceivedLicenses( + listReceivedLicenses( args: ListReceivedLicensesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReceivedLicenses( + listReceivedLicenses( args: ListReceivedLicensesCommandInput, cb: (err: any, data?: ListReceivedLicensesCommandOutput) => void ): void; - public listReceivedLicenses( + listReceivedLicenses( args: ListReceivedLicensesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReceivedLicensesCommandOutput) => void ): void; - public listReceivedLicenses( - args: ListReceivedLicensesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReceivedLicensesCommandOutput) => void), - cb?: (err: any, data?: ListReceivedLicensesCommandOutput) => void - ): Promise | void { - const command = new ListReceivedLicensesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the licenses received for all accounts in the organization.

+ * @see {@link ListReceivedLicensesForOrganizationCommand} */ - public listReceivedLicensesForOrganization( + listReceivedLicensesForOrganization( args: ListReceivedLicensesForOrganizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReceivedLicensesForOrganization( + listReceivedLicensesForOrganization( args: ListReceivedLicensesForOrganizationCommandInput, cb: (err: any, data?: ListReceivedLicensesForOrganizationCommandOutput) => void ): void; - public listReceivedLicensesForOrganization( + listReceivedLicensesForOrganization( args: ListReceivedLicensesForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReceivedLicensesForOrganizationCommandOutput) => void ): void; - public listReceivedLicensesForOrganization( - args: ListReceivedLicensesForOrganizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReceivedLicensesForOrganizationCommandOutput) => void), - cb?: (err: any, data?: ListReceivedLicensesForOrganizationCommandOutput) => void - ): Promise | void { - const command = new ListReceivedLicensesForOrganizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists resources managed using Systems Manager inventory.

+ * @see {@link ListResourceInventoryCommand} */ - public listResourceInventory( + listResourceInventory( args: ListResourceInventoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourceInventory( + listResourceInventory( args: ListResourceInventoryCommandInput, cb: (err: any, data?: ListResourceInventoryCommandOutput) => void ): void; - public listResourceInventory( + listResourceInventory( args: ListResourceInventoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceInventoryCommandOutput) => void ): void; - public listResourceInventory( - args: ListResourceInventoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourceInventoryCommandOutput) => void), - cb?: (err: any, data?: ListResourceInventoryCommandOutput) => void - ): Promise | void { - const command = new ListResourceInventoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags for the specified license configuration.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists your tokens.

+ * @see {@link ListTokensCommand} */ - public listTokens(args: ListTokensCommandInput, options?: __HttpHandlerOptions): Promise; - public listTokens(args: ListTokensCommandInput, cb: (err: any, data?: ListTokensCommandOutput) => void): void; - public listTokens( + listTokens(args: ListTokensCommandInput, options?: __HttpHandlerOptions): Promise; + listTokens(args: ListTokensCommandInput, cb: (err: any, data?: ListTokensCommandOutput) => void): void; + listTokens( args: ListTokensCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTokensCommandOutput) => void ): void; - public listTokens( - args: ListTokensCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTokensCommandOutput) => void), - cb?: (err: any, data?: ListTokensCommandOutput) => void - ): Promise | void { - const command = new ListTokensCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all license usage records for a license configuration, displaying license - * consumption details by resource at a selected point in time. Use this action to audit the - * current license consumption for any license inventory and configuration.

+ * @see {@link ListUsageForLicenseConfigurationCommand} */ - public listUsageForLicenseConfiguration( + listUsageForLicenseConfiguration( args: ListUsageForLicenseConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public listUsageForLicenseConfiguration( + listUsageForLicenseConfiguration( args: ListUsageForLicenseConfigurationCommandInput, cb: (err: any, data?: ListUsageForLicenseConfigurationCommandOutput) => void ): void; - public listUsageForLicenseConfiguration( + listUsageForLicenseConfiguration( args: ListUsageForLicenseConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsageForLicenseConfigurationCommandOutput) => void ): void; - public listUsageForLicenseConfiguration( - args: ListUsageForLicenseConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUsageForLicenseConfigurationCommandOutput) => void), - cb?: (err: any, data?: ListUsageForLicenseConfigurationCommandOutput) => void - ): Promise | void { - const command = new ListUsageForLicenseConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Rejects the specified grant.

+ * @see {@link RejectGrantCommand} */ - public rejectGrant(args: RejectGrantCommandInput, options?: __HttpHandlerOptions): Promise; - public rejectGrant(args: RejectGrantCommandInput, cb: (err: any, data?: RejectGrantCommandOutput) => void): void; - public rejectGrant( + rejectGrant(args: RejectGrantCommandInput, options?: __HttpHandlerOptions): Promise; + rejectGrant(args: RejectGrantCommandInput, cb: (err: any, data?: RejectGrantCommandOutput) => void): void; + rejectGrant( args: RejectGrantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectGrantCommandOutput) => void ): void; - public rejectGrant( - args: RejectGrantCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RejectGrantCommandOutput) => void), - cb?: (err: any, data?: RejectGrantCommandOutput) => void - ): Promise | void { - const command = new RejectGrantCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds the specified tags to the specified license configuration.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified tags from the specified license configuration.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the attributes of an existing license configuration.

+ * @see {@link UpdateLicenseConfigurationCommand} */ - public updateLicenseConfiguration( + updateLicenseConfiguration( args: UpdateLicenseConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLicenseConfiguration( + updateLicenseConfiguration( args: UpdateLicenseConfigurationCommandInput, cb: (err: any, data?: UpdateLicenseConfigurationCommandOutput) => void ): void; - public updateLicenseConfiguration( + updateLicenseConfiguration( args: UpdateLicenseConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLicenseConfigurationCommandOutput) => void ): void; - public updateLicenseConfiguration( - args: UpdateLicenseConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLicenseConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateLicenseConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateLicenseConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a report generator.

- *

After you make changes to a report generator, it starts generating new reports within 60 minutes of being updated.

+ * @see {@link UpdateLicenseManagerReportGeneratorCommand} */ - public updateLicenseManagerReportGenerator( + updateLicenseManagerReportGenerator( args: UpdateLicenseManagerReportGeneratorCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLicenseManagerReportGenerator( + updateLicenseManagerReportGenerator( args: UpdateLicenseManagerReportGeneratorCommandInput, cb: (err: any, data?: UpdateLicenseManagerReportGeneratorCommandOutput) => void ): void; - public updateLicenseManagerReportGenerator( + updateLicenseManagerReportGenerator( args: UpdateLicenseManagerReportGeneratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLicenseManagerReportGeneratorCommandOutput) => void ): void; - public updateLicenseManagerReportGenerator( - args: UpdateLicenseManagerReportGeneratorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLicenseManagerReportGeneratorCommandOutput) => void), - cb?: (err: any, data?: UpdateLicenseManagerReportGeneratorCommandOutput) => void - ): Promise | void { - const command = new UpdateLicenseManagerReportGeneratorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or removes the specified license configurations for the specified Amazon Web Services resource.

- *

You can update the license specifications of AMIs, instances, and hosts. - * You cannot update the license specifications for launch templates and CloudFormation templates, - * as they send license configurations to the operation that creates the resource.

+ * @see {@link UpdateLicenseSpecificationsForResourceCommand} */ - public updateLicenseSpecificationsForResource( + updateLicenseSpecificationsForResource( args: UpdateLicenseSpecificationsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLicenseSpecificationsForResource( + updateLicenseSpecificationsForResource( args: UpdateLicenseSpecificationsForResourceCommandInput, cb: (err: any, data?: UpdateLicenseSpecificationsForResourceCommandOutput) => void ): void; - public updateLicenseSpecificationsForResource( + updateLicenseSpecificationsForResource( args: UpdateLicenseSpecificationsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLicenseSpecificationsForResourceCommandOutput) => void ): void; - public updateLicenseSpecificationsForResource( - args: UpdateLicenseSpecificationsForResourceCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateLicenseSpecificationsForResourceCommandOutput) => void), - cb?: (err: any, data?: UpdateLicenseSpecificationsForResourceCommandOutput) => void - ): Promise | void { - const command = new UpdateLicenseSpecificationsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates License Manager settings for the current Region.

+ * @see {@link UpdateServiceSettingsCommand} */ - public updateServiceSettings( + updateServiceSettings( args: UpdateServiceSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateServiceSettings( + updateServiceSettings( args: UpdateServiceSettingsCommandInput, cb: (err: any, data?: UpdateServiceSettingsCommandOutput) => void ): void; - public updateServiceSettings( + updateServiceSettings( args: UpdateServiceSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceSettingsCommandOutput) => void ): void; - public updateServiceSettings( - args: UpdateServiceSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServiceSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateServiceSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateServiceSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

License Manager makes it easier to manage licenses from software vendors across multiple + * Amazon Web Services accounts and on-premises servers.

+ */ +export class LicenseManager extends LicenseManagerClient implements LicenseManager {} +createAggregatedClient(commands, LicenseManager); diff --git a/clients/client-lightsail/src/Lightsail.ts b/clients/client-lightsail/src/Lightsail.ts index ed069db078dd..bf6fbaa46078 100644 --- a/clients/client-lightsail/src/Lightsail.ts +++ b/clients/client-lightsail/src/Lightsail.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -700,5679 +701,2594 @@ import { UpdateRelationalDatabaseParametersCommandInput, UpdateRelationalDatabaseParametersCommandOutput, } from "./commands/UpdateRelationalDatabaseParametersCommand"; -import { LightsailClient } from "./LightsailClient"; +import { LightsailClient, LightsailClientConfig } from "./LightsailClient"; -/** - * @public - *

Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes - * everything you need to launch your project quickly - instances (virtual private servers), - * container services, storage buckets, managed databases, SSD-based block storage, static IP - * addresses, load balancers, content delivery network (CDN) distributions, DNS management of - * registered domains, and resource snapshots (backups) - for a low, predictable monthly - * price.

- *

You can manage your Lightsail resources using the Lightsail console, Lightsail API, - * Command Line Interface (CLI), or SDKs. For more information about Lightsail - * concepts and tasks, see the Amazon Lightsail Developer Guide.

- *

This API Reference provides detailed information about the actions, data types, - * parameters, and errors of the Lightsail service. For more information about the supported - * Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see - * Amazon Lightsail Endpoints - * and Quotas in the Amazon Web Services General Reference.

- */ -export class Lightsail extends LightsailClient { +const commands = { + AllocateStaticIpCommand, + AttachCertificateToDistributionCommand, + AttachDiskCommand, + AttachInstancesToLoadBalancerCommand, + AttachLoadBalancerTlsCertificateCommand, + AttachStaticIpCommand, + CloseInstancePublicPortsCommand, + CopySnapshotCommand, + CreateBucketCommand, + CreateBucketAccessKeyCommand, + CreateCertificateCommand, + CreateCloudFormationStackCommand, + CreateContactMethodCommand, + CreateContainerServiceCommand, + CreateContainerServiceDeploymentCommand, + CreateContainerServiceRegistryLoginCommand, + CreateDiskCommand, + CreateDiskFromSnapshotCommand, + CreateDiskSnapshotCommand, + CreateDistributionCommand, + CreateDomainCommand, + CreateDomainEntryCommand, + CreateGUISessionAccessDetailsCommand, + CreateInstancesCommand, + CreateInstancesFromSnapshotCommand, + CreateInstanceSnapshotCommand, + CreateKeyPairCommand, + CreateLoadBalancerCommand, + CreateLoadBalancerTlsCertificateCommand, + CreateRelationalDatabaseCommand, + CreateRelationalDatabaseFromSnapshotCommand, + CreateRelationalDatabaseSnapshotCommand, + DeleteAlarmCommand, + DeleteAutoSnapshotCommand, + DeleteBucketCommand, + DeleteBucketAccessKeyCommand, + DeleteCertificateCommand, + DeleteContactMethodCommand, + DeleteContainerImageCommand, + DeleteContainerServiceCommand, + DeleteDiskCommand, + DeleteDiskSnapshotCommand, + DeleteDistributionCommand, + DeleteDomainCommand, + DeleteDomainEntryCommand, + DeleteInstanceCommand, + DeleteInstanceSnapshotCommand, + DeleteKeyPairCommand, + DeleteKnownHostKeysCommand, + DeleteLoadBalancerCommand, + DeleteLoadBalancerTlsCertificateCommand, + DeleteRelationalDatabaseCommand, + DeleteRelationalDatabaseSnapshotCommand, + DetachCertificateFromDistributionCommand, + DetachDiskCommand, + DetachInstancesFromLoadBalancerCommand, + DetachStaticIpCommand, + DisableAddOnCommand, + DownloadDefaultKeyPairCommand, + EnableAddOnCommand, + ExportSnapshotCommand, + GetActiveNamesCommand, + GetAlarmsCommand, + GetAutoSnapshotsCommand, + GetBlueprintsCommand, + GetBucketAccessKeysCommand, + GetBucketBundlesCommand, + GetBucketMetricDataCommand, + GetBucketsCommand, + GetBundlesCommand, + GetCertificatesCommand, + GetCloudFormationStackRecordsCommand, + GetContactMethodsCommand, + GetContainerAPIMetadataCommand, + GetContainerImagesCommand, + GetContainerLogCommand, + GetContainerServiceDeploymentsCommand, + GetContainerServiceMetricDataCommand, + GetContainerServicePowersCommand, + GetContainerServicesCommand, + GetCostEstimateCommand, + GetDiskCommand, + GetDisksCommand, + GetDiskSnapshotCommand, + GetDiskSnapshotsCommand, + GetDistributionBundlesCommand, + GetDistributionLatestCacheResetCommand, + GetDistributionMetricDataCommand, + GetDistributionsCommand, + GetDomainCommand, + GetDomainsCommand, + GetExportSnapshotRecordsCommand, + GetInstanceCommand, + GetInstanceAccessDetailsCommand, + GetInstanceMetricDataCommand, + GetInstancePortStatesCommand, + GetInstancesCommand, + GetInstanceSnapshotCommand, + GetInstanceSnapshotsCommand, + GetInstanceStateCommand, + GetKeyPairCommand, + GetKeyPairsCommand, + GetLoadBalancerCommand, + GetLoadBalancerMetricDataCommand, + GetLoadBalancersCommand, + GetLoadBalancerTlsCertificatesCommand, + GetLoadBalancerTlsPoliciesCommand, + GetOperationCommand, + GetOperationsCommand, + GetOperationsForResourceCommand, + GetRegionsCommand, + GetRelationalDatabaseCommand, + GetRelationalDatabaseBlueprintsCommand, + GetRelationalDatabaseBundlesCommand, + GetRelationalDatabaseEventsCommand, + GetRelationalDatabaseLogEventsCommand, + GetRelationalDatabaseLogStreamsCommand, + GetRelationalDatabaseMasterUserPasswordCommand, + GetRelationalDatabaseMetricDataCommand, + GetRelationalDatabaseParametersCommand, + GetRelationalDatabasesCommand, + GetRelationalDatabaseSnapshotCommand, + GetRelationalDatabaseSnapshotsCommand, + GetStaticIpCommand, + GetStaticIpsCommand, + ImportKeyPairCommand, + IsVpcPeeredCommand, + OpenInstancePublicPortsCommand, + PeerVpcCommand, + PutAlarmCommand, + PutInstancePublicPortsCommand, + RebootInstanceCommand, + RebootRelationalDatabaseCommand, + RegisterContainerImageCommand, + ReleaseStaticIpCommand, + ResetDistributionCacheCommand, + SendContactMethodVerificationCommand, + SetIpAddressTypeCommand, + SetResourceAccessForBucketCommand, + StartGUISessionCommand, + StartInstanceCommand, + StartRelationalDatabaseCommand, + StopGUISessionCommand, + StopInstanceCommand, + StopRelationalDatabaseCommand, + TagResourceCommand, + TestAlarmCommand, + UnpeerVpcCommand, + UntagResourceCommand, + UpdateBucketCommand, + UpdateBucketBundleCommand, + UpdateContainerServiceCommand, + UpdateDistributionCommand, + UpdateDistributionBundleCommand, + UpdateDomainEntryCommand, + UpdateInstanceMetadataOptionsCommand, + UpdateLoadBalancerAttributeCommand, + UpdateRelationalDatabaseCommand, + UpdateRelationalDatabaseParametersCommand, +}; + +export interface Lightsail { /** - * @public - *

Allocates a static IP address.

+ * @see {@link AllocateStaticIpCommand} */ - public allocateStaticIp( + allocateStaticIp( args: AllocateStaticIpCommandInput, options?: __HttpHandlerOptions ): Promise; - public allocateStaticIp( + allocateStaticIp( args: AllocateStaticIpCommandInput, cb: (err: any, data?: AllocateStaticIpCommandOutput) => void ): void; - public allocateStaticIp( + allocateStaticIp( args: AllocateStaticIpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AllocateStaticIpCommandOutput) => void ): void; - public allocateStaticIp( - args: AllocateStaticIpCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AllocateStaticIpCommandOutput) => void), - cb?: (err: any, data?: AllocateStaticIpCommandOutput) => void - ): Promise | void { - const command = new AllocateStaticIpCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) - * distribution.

- *

After the certificate is attached, your distribution accepts HTTPS traffic for all of the - * domains that are associated with the certificate.

- *

Use the CreateCertificate action to create a certificate that you can attach - * to your distribution.

- * - *

Only certificates created in the us-east-1 - * Amazon Web Services Region can be attached to Lightsail distributions. Lightsail - * distributions are global resources that can reference an origin in any Amazon Web Services - * Region, and distribute its content globally. However, all distributions are located in the - * us-east-1 Region.

- *
- */ - public attachCertificateToDistribution( + + /** + * @see {@link AttachCertificateToDistributionCommand} + */ + attachCertificateToDistribution( args: AttachCertificateToDistributionCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachCertificateToDistribution( + attachCertificateToDistribution( args: AttachCertificateToDistributionCommandInput, cb: (err: any, data?: AttachCertificateToDistributionCommandOutput) => void ): void; - public attachCertificateToDistribution( + attachCertificateToDistribution( args: AttachCertificateToDistributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachCertificateToDistributionCommandOutput) => void ): void; - public attachCertificateToDistribution( - args: AttachCertificateToDistributionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachCertificateToDistributionCommandOutput) => void), - cb?: (err: any, data?: AttachCertificateToDistributionCommandOutput) => void - ): Promise | void { - const command = new AttachCertificateToDistributionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attaches a block storage disk to a running or stopped Lightsail instance and exposes it - * to the instance with the specified disk name.

- *

The attach disk operation supports tag-based access control via resource tags - * applied to the resource identified by disk name. For more information, see the - * Amazon Lightsail Developer Guide.

- */ - public attachDisk(args: AttachDiskCommandInput, options?: __HttpHandlerOptions): Promise; - public attachDisk(args: AttachDiskCommandInput, cb: (err: any, data?: AttachDiskCommandOutput) => void): void; - public attachDisk( + + /** + * @see {@link AttachDiskCommand} + */ + attachDisk(args: AttachDiskCommandInput, options?: __HttpHandlerOptions): Promise; + attachDisk(args: AttachDiskCommandInput, cb: (err: any, data?: AttachDiskCommandOutput) => void): void; + attachDisk( args: AttachDiskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachDiskCommandOutput) => void ): void; - public attachDisk( - args: AttachDiskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachDiskCommandOutput) => void), - cb?: (err: any, data?: AttachDiskCommandOutput) => void - ): Promise | void { - const command = new AttachDiskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attaches one or more Lightsail instances to a load balancer.

- *

After some time, the instances are attached to the load balancer and the health check - * status is available.

- *

The attach instances to load balancer operation supports tag-based access - * control via resource tags applied to the resource identified by load balancer - * name. For more information, see the Lightsail Developer Guide.

- */ - public attachInstancesToLoadBalancer( + + /** + * @see {@link AttachInstancesToLoadBalancerCommand} + */ + attachInstancesToLoadBalancer( args: AttachInstancesToLoadBalancerCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachInstancesToLoadBalancer( + attachInstancesToLoadBalancer( args: AttachInstancesToLoadBalancerCommandInput, cb: (err: any, data?: AttachInstancesToLoadBalancerCommandOutput) => void ): void; - public attachInstancesToLoadBalancer( + attachInstancesToLoadBalancer( args: AttachInstancesToLoadBalancerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachInstancesToLoadBalancerCommandOutput) => void ): void; - public attachInstancesToLoadBalancer( - args: AttachInstancesToLoadBalancerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachInstancesToLoadBalancerCommandOutput) => void), - cb?: (err: any, data?: AttachInstancesToLoadBalancerCommandOutput) => void - ): Promise | void { - const command = new AttachInstancesToLoadBalancerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just - * an updated, more secure version of Secure Socket Layer (SSL).

- *

Once you create and validate your certificate, you can attach it to your load balancer. - * You can also use this API to rotate the certificates on your account. Use the - * AttachLoadBalancerTlsCertificate action with the non-attached certificate, and - * it will replace the existing one and become the attached certificate.

- *

The AttachLoadBalancerTlsCertificate operation supports tag-based access - * control via resource tags applied to the resource identified by load balancer - * name. For more information, see the Amazon Lightsail Developer Guide.

- */ - public attachLoadBalancerTlsCertificate( + + /** + * @see {@link AttachLoadBalancerTlsCertificateCommand} + */ + attachLoadBalancerTlsCertificate( args: AttachLoadBalancerTlsCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachLoadBalancerTlsCertificate( + attachLoadBalancerTlsCertificate( args: AttachLoadBalancerTlsCertificateCommandInput, cb: (err: any, data?: AttachLoadBalancerTlsCertificateCommandOutput) => void ): void; - public attachLoadBalancerTlsCertificate( + attachLoadBalancerTlsCertificate( args: AttachLoadBalancerTlsCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachLoadBalancerTlsCertificateCommandOutput) => void ): void; - public attachLoadBalancerTlsCertificate( - args: AttachLoadBalancerTlsCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachLoadBalancerTlsCertificateCommandOutput) => void), - cb?: (err: any, data?: AttachLoadBalancerTlsCertificateCommandOutput) => void - ): Promise | void { - const command = new AttachLoadBalancerTlsCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attaches a static IP address to a specific Amazon Lightsail instance.

- */ - public attachStaticIp( + + /** + * @see {@link AttachStaticIpCommand} + */ + attachStaticIp( args: AttachStaticIpCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachStaticIp( - args: AttachStaticIpCommandInput, - cb: (err: any, data?: AttachStaticIpCommandOutput) => void - ): void; - public attachStaticIp( + attachStaticIp(args: AttachStaticIpCommandInput, cb: (err: any, data?: AttachStaticIpCommandOutput) => void): void; + attachStaticIp( args: AttachStaticIpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachStaticIpCommandOutput) => void ): void; - public attachStaticIp( - args: AttachStaticIpCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachStaticIpCommandOutput) => void), - cb?: (err: any, data?: AttachStaticIpCommandOutput) => void - ): Promise | void { - const command = new AttachStaticIpCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Closes ports for a specific Amazon Lightsail instance.

- *

The CloseInstancePublicPorts action supports tag-based access control via - * resource tags applied to the resource identified by instanceName. For more - * information, see the Amazon Lightsail Developer Guide.

- */ - public closeInstancePublicPorts( + + /** + * @see {@link CloseInstancePublicPortsCommand} + */ + closeInstancePublicPorts( args: CloseInstancePublicPortsCommandInput, options?: __HttpHandlerOptions ): Promise; - public closeInstancePublicPorts( + closeInstancePublicPorts( args: CloseInstancePublicPortsCommandInput, cb: (err: any, data?: CloseInstancePublicPortsCommandOutput) => void ): void; - public closeInstancePublicPorts( + closeInstancePublicPorts( args: CloseInstancePublicPortsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CloseInstancePublicPortsCommandOutput) => void ): void; - public closeInstancePublicPorts( - args: CloseInstancePublicPortsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CloseInstancePublicPortsCommandOutput) => void), - cb?: (err: any, data?: CloseInstancePublicPortsCommandOutput) => void - ): Promise | void { - const command = new CloseInstancePublicPortsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an - * automatic snapshot of an instance or disk as a manual snapshot. This operation can also be - * used to copy a manual or automatic snapshot of an instance or a disk from one Amazon Web Services Region to another in Amazon Lightsail.

- *

When copying a manual snapshot, be sure to define the source - * region, source snapshot name, and target snapshot name - * parameters.

- *

When copying an automatic snapshot, be sure to define the - * source region, source resource name, target snapshot - * name, and either the restore date or the use latest restorable - * auto snapshot parameters.

- */ - public copySnapshot( - args: CopySnapshotCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public copySnapshot(args: CopySnapshotCommandInput, cb: (err: any, data?: CopySnapshotCommandOutput) => void): void; - public copySnapshot( + + /** + * @see {@link CopySnapshotCommand} + */ + copySnapshot(args: CopySnapshotCommandInput, options?: __HttpHandlerOptions): Promise; + copySnapshot(args: CopySnapshotCommandInput, cb: (err: any, data?: CopySnapshotCommandOutput) => void): void; + copySnapshot( args: CopySnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopySnapshotCommandOutput) => void ): void; - public copySnapshot( - args: CopySnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopySnapshotCommandOutput) => void), - cb?: (err: any, data?: CopySnapshotCommandOutput) => void - ): Promise | void { - const command = new CopySnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon Lightsail bucket.

- *

A bucket is a cloud storage resource available in the Lightsail object storage service. - * Use buckets to store objects such as data and its descriptive metadata. For more information - * about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer - * Guide.

- */ - public createBucket( - args: CreateBucketCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createBucket(args: CreateBucketCommandInput, cb: (err: any, data?: CreateBucketCommandOutput) => void): void; - public createBucket( + + /** + * @see {@link CreateBucketCommand} + */ + createBucket(args: CreateBucketCommandInput, options?: __HttpHandlerOptions): Promise; + createBucket(args: CreateBucketCommandInput, cb: (err: any, data?: CreateBucketCommandOutput) => void): void; + createBucket( args: CreateBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBucketCommandOutput) => void ): void; - public createBucket( - args: CreateBucketCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBucketCommandOutput) => void), - cb?: (err: any, data?: CreateBucketCommandOutput) => void - ): Promise | void { - const command = new CreateBucketCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of - * an access key ID and corresponding secret access key.

- *

Access keys grant full programmatic access to the specified bucket and its objects. You - * can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more - * information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the - * Amazon Lightsail Developer Guide.

- * - *

The secretAccessKey value is returned only in response to the - * CreateBucketAccessKey action. You can get a secret access key only when you - * first create an access key; you cannot get the secret access key later. If you lose the - * secret access key, you must create a new access key.

- *
- */ - public createBucketAccessKey( + + /** + * @see {@link CreateBucketAccessKeyCommand} + */ + createBucketAccessKey( args: CreateBucketAccessKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBucketAccessKey( + createBucketAccessKey( args: CreateBucketAccessKeyCommandInput, cb: (err: any, data?: CreateBucketAccessKeyCommandOutput) => void ): void; - public createBucketAccessKey( + createBucketAccessKey( args: CreateBucketAccessKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBucketAccessKeyCommandOutput) => void ): void; - public createBucketAccessKey( - args: CreateBucketAccessKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBucketAccessKeyCommandOutput) => void), - cb?: (err: any, data?: CreateBucketAccessKeyCommandOutput) => void - ): Promise | void { - const command = new CreateBucketAccessKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) - * distribution and a container service.

- *

After the certificate is valid, use the AttachCertificateToDistribution - * action to use the certificate and its domains with your distribution. Or use the - * UpdateContainerService action to use the certificate and its domains with your - * container service.

- * - *

Only certificates created in the us-east-1 - * Amazon Web Services Region can be attached to Lightsail distributions. Lightsail - * distributions are global resources that can reference an origin in any Amazon Web Services - * Region, and distribute its content globally. However, all distributions are located in the - * us-east-1 Region.

- *
- */ - public createCertificate( + + /** + * @see {@link CreateCertificateCommand} + */ + createCertificate( args: CreateCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCertificate( + createCertificate( args: CreateCertificateCommandInput, cb: (err: any, data?: CreateCertificateCommandOutput) => void ): void; - public createCertificate( + createCertificate( args: CreateCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCertificateCommandOutput) => void ): void; - public createCertificate( - args: CreateCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCertificateCommandOutput) => void), - cb?: (err: any, data?: CreateCertificateCommandOutput) => void - ): Promise | void { - const command = new CreateCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported - * Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be - * used to track the AWS CloudFormation stack created. Use the get cloud formation stack - * records operation to get a list of the CloudFormation stacks created.

- * - *

Wait until after your new Amazon EC2 instance is created before running the create - * cloud formation stack operation again with the same export snapshot record.

- *
- */ - public createCloudFormationStack( + + /** + * @see {@link CreateCloudFormationStackCommand} + */ + createCloudFormationStack( args: CreateCloudFormationStackCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCloudFormationStack( + createCloudFormationStack( args: CreateCloudFormationStackCommandInput, cb: (err: any, data?: CreateCloudFormationStackCommandOutput) => void ): void; - public createCloudFormationStack( + createCloudFormationStack( args: CreateCloudFormationStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCloudFormationStackCommandOutput) => void ): void; - public createCloudFormationStack( - args: CreateCloudFormationStackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCloudFormationStackCommandOutput) => void), - cb?: (err: any, data?: CreateCloudFormationStackCommandOutput) => void - ): Promise | void { - const command = new CreateCloudFormationStackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an email or SMS text message contact method.

- *

A contact method is used to send you notifications about your Amazon Lightsail resources. - * You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services - * Regions, and SMS text messages cannot be sent to some countries/regions. For more information, - * see Notifications in Amazon Lightsail.

- */ - public createContactMethod( + + /** + * @see {@link CreateContactMethodCommand} + */ + createContactMethod( args: CreateContactMethodCommandInput, options?: __HttpHandlerOptions ): Promise; - public createContactMethod( + createContactMethod( args: CreateContactMethodCommandInput, cb: (err: any, data?: CreateContactMethodCommandOutput) => void ): void; - public createContactMethod( + createContactMethod( args: CreateContactMethodCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateContactMethodCommandOutput) => void ): void; - public createContactMethod( - args: CreateContactMethodCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateContactMethodCommandOutput) => void), - cb?: (err: any, data?: CreateContactMethodCommandOutput) => void - ): Promise | void { - const command = new CreateContactMethodCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon Lightsail container service.

- *

A Lightsail container service is a compute resource to which you can deploy containers. - * For more information, see Container services in Amazon Lightsail in the Lightsail Dev - * Guide.

- */ - public createContainerService( + + /** + * @see {@link CreateContainerServiceCommand} + */ + createContainerService( args: CreateContainerServiceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createContainerService( + createContainerService( args: CreateContainerServiceCommandInput, cb: (err: any, data?: CreateContainerServiceCommandOutput) => void ): void; - public createContainerService( + createContainerService( args: CreateContainerServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateContainerServiceCommandOutput) => void ): void; - public createContainerService( - args: CreateContainerServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateContainerServiceCommandOutput) => void), - cb?: (err: any, data?: CreateContainerServiceCommandOutput) => void - ): Promise | void { - const command = new CreateContainerServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a deployment for your Amazon Lightsail container service.

- *

A deployment specifies the containers that will be launched on the container service and - * their settings, such as the ports to open, the environment variables to apply, and the launch - * command to run. It also specifies the container that will serve as the public endpoint of the - * deployment and its settings, such as the HTTP or HTTPS port to use, and the health check - * configuration.

- *

You can deploy containers to your container service using container images from a public - * registry such as Amazon ECR Public, or from your local machine. For more information, see - * Creating container images for your Amazon Lightsail container services in the - * Amazon Lightsail Developer Guide.

- */ - public createContainerServiceDeployment( + + /** + * @see {@link CreateContainerServiceDeploymentCommand} + */ + createContainerServiceDeployment( args: CreateContainerServiceDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createContainerServiceDeployment( + createContainerServiceDeployment( args: CreateContainerServiceDeploymentCommandInput, cb: (err: any, data?: CreateContainerServiceDeploymentCommandOutput) => void ): void; - public createContainerServiceDeployment( + createContainerServiceDeployment( args: CreateContainerServiceDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateContainerServiceDeploymentCommandOutput) => void ): void; - public createContainerServiceDeployment( - args: CreateContainerServiceDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateContainerServiceDeploymentCommandOutput) => void), - cb?: (err: any, data?: CreateContainerServiceDeploymentCommandOutput) => void - ): Promise | void { - const command = new CreateContainerServiceDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a temporary set of log in credentials that you can use to log in to the Docker - * process on your local machine. After you're logged in, you can use the native Docker commands - * to push your local container images to the container image registry of your Amazon Lightsail - * account so that you can use them with your Lightsail container service. The log in - * credentials expire 12 hours after they are created, at which point you will need to create a - * new set of log in credentials.

- * - *

You can only push container images to the container service registry of your Lightsail - * account. You cannot pull container images or perform any other container image management - * actions on the container service registry.

- *
- *

After you push your container images to the container image registry of your Lightsail - * account, use the RegisterContainerImage action to register the pushed images to a - * specific Lightsail container service.

- * - *

This action is not required if you install and use the Lightsail Control - * (lightsailctl) plugin to push container images to your Lightsail container service. For - * more information, see Pushing and managing container images on your Amazon Lightsail container services - * in the Amazon Lightsail Developer Guide.

- *
- */ - public createContainerServiceRegistryLogin( + + /** + * @see {@link CreateContainerServiceRegistryLoginCommand} + */ + createContainerServiceRegistryLogin( args: CreateContainerServiceRegistryLoginCommandInput, options?: __HttpHandlerOptions ): Promise; - public createContainerServiceRegistryLogin( + createContainerServiceRegistryLogin( args: CreateContainerServiceRegistryLoginCommandInput, cb: (err: any, data?: CreateContainerServiceRegistryLoginCommandOutput) => void ): void; - public createContainerServiceRegistryLogin( + createContainerServiceRegistryLogin( args: CreateContainerServiceRegistryLoginCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateContainerServiceRegistryLoginCommandOutput) => void ): void; - public createContainerServiceRegistryLogin( - args: CreateContainerServiceRegistryLoginCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateContainerServiceRegistryLoginCommandOutput) => void), - cb?: (err: any, data?: CreateContainerServiceRegistryLoginCommandOutput) => void - ): Promise | void { - const command = new CreateContainerServiceRegistryLoginCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a block storage disk that can be attached to an Amazon Lightsail instance in the - * same Availability Zone (e.g., us-east-2a).

- *

The create disk operation supports tag-based access control via request tags. - * For more information, see the Amazon Lightsail Developer Guide.

- */ - public createDisk(args: CreateDiskCommandInput, options?: __HttpHandlerOptions): Promise; - public createDisk(args: CreateDiskCommandInput, cb: (err: any, data?: CreateDiskCommandOutput) => void): void; - public createDisk( + + /** + * @see {@link CreateDiskCommand} + */ + createDisk(args: CreateDiskCommandInput, options?: __HttpHandlerOptions): Promise; + createDisk(args: CreateDiskCommandInput, cb: (err: any, data?: CreateDiskCommandOutput) => void): void; + createDisk( args: CreateDiskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDiskCommandOutput) => void ): void; - public createDisk( - args: CreateDiskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDiskCommandOutput) => void), - cb?: (err: any, data?: CreateDiskCommandOutput) => void - ): Promise | void { - const command = new CreateDiskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting - * disk can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., - * us-east-2a).

- *

The create disk from snapshot operation supports tag-based access control via - * request tags and resource tags applied to the resource identified by disk snapshot - * name. For more information, see the Amazon Lightsail Developer Guide.

- */ - public createDiskFromSnapshot( + + /** + * @see {@link CreateDiskFromSnapshotCommand} + */ + createDiskFromSnapshot( args: CreateDiskFromSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDiskFromSnapshot( + createDiskFromSnapshot( args: CreateDiskFromSnapshotCommandInput, cb: (err: any, data?: CreateDiskFromSnapshotCommandOutput) => void ): void; - public createDiskFromSnapshot( + createDiskFromSnapshot( args: CreateDiskFromSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDiskFromSnapshotCommandOutput) => void ): void; - public createDiskFromSnapshot( - args: CreateDiskFromSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDiskFromSnapshotCommandOutput) => void), - cb?: (err: any, data?: CreateDiskFromSnapshotCommandOutput) => void - ): Promise | void { - const command = new CreateDiskFromSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a snapshot of a block storage disk. You can use snapshots for backups, to make - * copies of disks, and to save data before shutting down a Lightsail instance.

- *

You can take a snapshot of an attached disk that is in use; however, snapshots only - * capture data that has been written to your disk at the time the snapshot command is issued. - * This may exclude any data that has been cached by any applications or the operating system. If - * you can pause any file systems on the disk long enough to take a snapshot, your snapshot - * should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should - * unmount the disk from within the Lightsail instance, issue the create disk snapshot command, - * and then remount the disk to ensure a consistent and complete snapshot. You may remount and - * use your disk while the snapshot status is pending.

- *

You can also use this operation to create a snapshot of an instance's system volume. You - * might want to do this, for example, to recover data from the system volume of a botched - * instance or to create a backup of the system volume like you would for a block storage disk. - * To create a snapshot of a system volume, just define the instance name parameter - * when issuing the snapshot command, and a snapshot of the defined instance's system volume will - * be created. After the snapshot is available, you can create a block storage disk from the - * snapshot and attach it to a running instance to access the data on the disk.

- *

The create disk snapshot operation supports tag-based access control via - * request tags. For more information, see the Amazon Lightsail Developer Guide.

- */ - public createDiskSnapshot( + + /** + * @see {@link CreateDiskSnapshotCommand} + */ + createDiskSnapshot( args: CreateDiskSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDiskSnapshot( + createDiskSnapshot( args: CreateDiskSnapshotCommandInput, cb: (err: any, data?: CreateDiskSnapshotCommandOutput) => void ): void; - public createDiskSnapshot( + createDiskSnapshot( args: CreateDiskSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDiskSnapshotCommandOutput) => void ): void; - public createDiskSnapshot( - args: CreateDiskSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDiskSnapshotCommandOutput) => void), - cb?: (err: any, data?: CreateDiskSnapshotCommandOutput) => void - ): Promise | void { - const command = new CreateDiskSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon Lightsail content delivery network (CDN) distribution.

- *

A distribution is a globally distributed network of caching servers that improve the - * performance of your website or web application hosted on a Lightsail instance. For more - * information, see Content delivery networks in Amazon Lightsail.

- */ - public createDistribution( + + /** + * @see {@link CreateDistributionCommand} + */ + createDistribution( args: CreateDistributionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDistribution( + createDistribution( args: CreateDistributionCommandInput, cb: (err: any, data?: CreateDistributionCommandOutput) => void ): void; - public createDistribution( + createDistribution( args: CreateDistributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDistributionCommandOutput) => void ): void; - public createDistribution( - args: CreateDistributionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDistributionCommandOutput) => void), - cb?: (err: any, data?: CreateDistributionCommandOutput) => void - ): Promise | void { - const command = new CreateDistributionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a domain resource for the specified domain (e.g., example.com).

- *

The create domain operation supports tag-based access control via request - * tags. For more information, see the Amazon Lightsail Developer Guide.

- */ - public createDomain( - args: CreateDomainCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createDomain(args: CreateDomainCommandInput, cb: (err: any, data?: CreateDomainCommandOutput) => void): void; - public createDomain( + + /** + * @see {@link CreateDomainCommand} + */ + createDomain(args: CreateDomainCommandInput, options?: __HttpHandlerOptions): Promise; + createDomain(args: CreateDomainCommandInput, cb: (err: any, data?: CreateDomainCommandOutput) => void): void; + createDomain( args: CreateDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDomainCommandOutput) => void ): void; - public createDomain( - args: CreateDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDomainCommandOutput) => void), - cb?: (err: any, data?: CreateDomainCommandOutput) => void - ): Promise | void { - const command = new CreateDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates one of the following domain name system (DNS) records in a domain DNS zone: - * Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority - * (SOA), service locator (SRV), or text (TXT).

- *

The create domain entry operation supports tag-based access control via - * resource tags applied to the resource identified by domain name. For more - * information, see the Amazon Lightsail Developer Guide.

- */ - public createDomainEntry( + + /** + * @see {@link CreateDomainEntryCommand} + */ + createDomainEntry( args: CreateDomainEntryCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDomainEntry( + createDomainEntry( args: CreateDomainEntryCommandInput, cb: (err: any, data?: CreateDomainEntryCommandOutput) => void ): void; - public createDomainEntry( + createDomainEntry( args: CreateDomainEntryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDomainEntryCommandOutput) => void ): void; - public createDomainEntry( - args: CreateDomainEntryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDomainEntryCommandOutput) => void), - cb?: (err: any, data?: CreateDomainEntryCommandOutput) => void - ): Promise | void { - const command = new CreateDomainEntryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) - * session. The primary URL initiates a web-based NICE DCV session to the virtual computer's application. The secondary URL initiates a web-based NICE DCV session to the virtual computer's operating session.

- *

Use StartGUISession to open the session.

- */ - public createGUISessionAccessDetails( + + /** + * @see {@link CreateGUISessionAccessDetailsCommand} + */ + createGUISessionAccessDetails( args: CreateGUISessionAccessDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public createGUISessionAccessDetails( + createGUISessionAccessDetails( args: CreateGUISessionAccessDetailsCommandInput, cb: (err: any, data?: CreateGUISessionAccessDetailsCommandOutput) => void ): void; - public createGUISessionAccessDetails( + createGUISessionAccessDetails( args: CreateGUISessionAccessDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGUISessionAccessDetailsCommandOutput) => void ): void; - public createGUISessionAccessDetails( - args: CreateGUISessionAccessDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGUISessionAccessDetailsCommandOutput) => void), - cb?: (err: any, data?: CreateGUISessionAccessDetailsCommandOutput) => void - ): Promise | void { - const command = new CreateGUISessionAccessDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates one or more Amazon Lightsail instances.

- *

The create instances operation supports tag-based access control via request - * tags. For more information, see the Lightsail Developer Guide.

- */ - public createInstances( + + /** + * @see {@link CreateInstancesCommand} + */ + createInstances( args: CreateInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public createInstances( - args: CreateInstancesCommandInput, - cb: (err: any, data?: CreateInstancesCommandOutput) => void - ): void; - public createInstances( + createInstances(args: CreateInstancesCommandInput, cb: (err: any, data?: CreateInstancesCommandOutput) => void): void; + createInstances( args: CreateInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInstancesCommandOutput) => void ): void; - public createInstances( - args: CreateInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateInstancesCommandOutput) => void), - cb?: (err: any, data?: CreateInstancesCommandOutput) => void - ): Promise | void { - const command = new CreateInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates one or more new instances from a manual or automatic snapshot of an - * instance.

- *

The create instances from snapshot operation supports tag-based access - * control via request tags and resource tags applied to the resource identified by - * instance snapshot name. For more information, see the Amazon Lightsail Developer Guide.

- */ - public createInstancesFromSnapshot( + + /** + * @see {@link CreateInstancesFromSnapshotCommand} + */ + createInstancesFromSnapshot( args: CreateInstancesFromSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public createInstancesFromSnapshot( + createInstancesFromSnapshot( args: CreateInstancesFromSnapshotCommandInput, cb: (err: any, data?: CreateInstancesFromSnapshotCommandOutput) => void ): void; - public createInstancesFromSnapshot( + createInstancesFromSnapshot( args: CreateInstancesFromSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInstancesFromSnapshotCommandOutput) => void ): void; - public createInstancesFromSnapshot( - args: CreateInstancesFromSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateInstancesFromSnapshotCommandOutput) => void), - cb?: (err: any, data?: CreateInstancesFromSnapshotCommandOutput) => void - ): Promise | void { - const command = new CreateInstancesFromSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a snapshot of a specific virtual private server, or instance. - * You can use a snapshot to create a new instance that is based on that snapshot.

- *

The create instance snapshot operation supports tag-based access control via - * request tags. For more information, see the Amazon Lightsail Developer Guide.

- */ - public createInstanceSnapshot( + + /** + * @see {@link CreateInstanceSnapshotCommand} + */ + createInstanceSnapshot( args: CreateInstanceSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public createInstanceSnapshot( + createInstanceSnapshot( args: CreateInstanceSnapshotCommandInput, cb: (err: any, data?: CreateInstanceSnapshotCommandOutput) => void ): void; - public createInstanceSnapshot( + createInstanceSnapshot( args: CreateInstanceSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInstanceSnapshotCommandOutput) => void ): void; - public createInstanceSnapshot( - args: CreateInstanceSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateInstanceSnapshotCommandOutput) => void), - cb?: (err: any, data?: CreateInstanceSnapshotCommandOutput) => void - ): Promise | void { - const command = new CreateInstanceSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a custom SSH key pair that you can use with an Amazon Lightsail - * instance.

- * - *

Use the DownloadDefaultKeyPair action to create a Lightsail default key - * pair in an Amazon Web Services Region where a default key pair does not currently - * exist.

- *
- *

The create key pair operation supports tag-based access control via request - * tags. For more information, see the Amazon Lightsail Developer Guide.

- */ - public createKeyPair( - args: CreateKeyPairCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createKeyPair( - args: CreateKeyPairCommandInput, - cb: (err: any, data?: CreateKeyPairCommandOutput) => void - ): void; - public createKeyPair( + + /** + * @see {@link CreateKeyPairCommand} + */ + createKeyPair(args: CreateKeyPairCommandInput, options?: __HttpHandlerOptions): Promise; + createKeyPair(args: CreateKeyPairCommandInput, cb: (err: any, data?: CreateKeyPairCommandOutput) => void): void; + createKeyPair( args: CreateKeyPairCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateKeyPairCommandOutput) => void ): void; - public createKeyPair( - args: CreateKeyPairCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateKeyPairCommandOutput) => void), - cb?: (err: any, data?: CreateKeyPairCommandOutput) => void - ): Promise | void { - const command = new CreateKeyPairCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Lightsail load balancer. To learn more about deciding whether to load balance - * your application, see Configure your Lightsail instances for load balancing. You can create up to 5 - * load balancers per AWS Region in your account.

- *

When you create a load balancer, you can specify a unique name and port settings. To - * change additional load balancer settings, use the UpdateLoadBalancerAttribute - * operation.

- *

The create load balancer operation supports tag-based access control via - * request tags. For more information, see the Amazon Lightsail Developer Guide.

- */ - public createLoadBalancer( + + /** + * @see {@link CreateLoadBalancerCommand} + */ + createLoadBalancer( args: CreateLoadBalancerCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLoadBalancer( + createLoadBalancer( args: CreateLoadBalancerCommandInput, cb: (err: any, data?: CreateLoadBalancerCommandOutput) => void ): void; - public createLoadBalancer( + createLoadBalancer( args: CreateLoadBalancerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLoadBalancerCommandOutput) => void ): void; - public createLoadBalancer( - args: CreateLoadBalancerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLoadBalancerCommandOutput) => void), - cb?: (err: any, data?: CreateLoadBalancerCommandOutput) => void - ): Promise | void { - const command = new CreateLoadBalancerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.

- *

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

- *

The CreateLoadBalancerTlsCertificate operation supports tag-based access - * control via resource tags applied to the resource identified by load balancer - * name. For more information, see the Amazon Lightsail Developer Guide.

- */ - public createLoadBalancerTlsCertificate( + + /** + * @see {@link CreateLoadBalancerTlsCertificateCommand} + */ + createLoadBalancerTlsCertificate( args: CreateLoadBalancerTlsCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLoadBalancerTlsCertificate( + createLoadBalancerTlsCertificate( args: CreateLoadBalancerTlsCertificateCommandInput, cb: (err: any, data?: CreateLoadBalancerTlsCertificateCommandOutput) => void ): void; - public createLoadBalancerTlsCertificate( + createLoadBalancerTlsCertificate( args: CreateLoadBalancerTlsCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLoadBalancerTlsCertificateCommandOutput) => void ): void; - public createLoadBalancerTlsCertificate( - args: CreateLoadBalancerTlsCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLoadBalancerTlsCertificateCommandOutput) => void), - cb?: (err: any, data?: CreateLoadBalancerTlsCertificateCommandOutput) => void - ): Promise | void { - const command = new CreateLoadBalancerTlsCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new database in Amazon Lightsail.

- *

The create relational database operation supports tag-based access control - * via request tags. For more information, see the Amazon Lightsail Developer Guide.

- */ - public createRelationalDatabase( + + /** + * @see {@link CreateRelationalDatabaseCommand} + */ + createRelationalDatabase( args: CreateRelationalDatabaseCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRelationalDatabase( + createRelationalDatabase( args: CreateRelationalDatabaseCommandInput, cb: (err: any, data?: CreateRelationalDatabaseCommandOutput) => void ): void; - public createRelationalDatabase( + createRelationalDatabase( args: CreateRelationalDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRelationalDatabaseCommandOutput) => void ): void; - public createRelationalDatabase( - args: CreateRelationalDatabaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRelationalDatabaseCommandOutput) => void), - cb?: (err: any, data?: CreateRelationalDatabaseCommandOutput) => void - ): Promise | void { - const command = new CreateRelationalDatabaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new database from an existing database snapshot in Amazon Lightsail.

- *

You can create a new database from a snapshot in if something goes wrong with your - * original database, or to change it to a different plan, such as a high availability or - * standard plan.

- *

The create relational database from snapshot operation supports tag-based - * access control via request tags and resource tags applied to the resource identified by - * relationalDatabaseSnapshotName. For more information, see the Amazon Lightsail Developer Guide.

- */ - public createRelationalDatabaseFromSnapshot( + + /** + * @see {@link CreateRelationalDatabaseFromSnapshotCommand} + */ + createRelationalDatabaseFromSnapshot( args: CreateRelationalDatabaseFromSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRelationalDatabaseFromSnapshot( + createRelationalDatabaseFromSnapshot( args: CreateRelationalDatabaseFromSnapshotCommandInput, cb: (err: any, data?: CreateRelationalDatabaseFromSnapshotCommandOutput) => void ): void; - public createRelationalDatabaseFromSnapshot( + createRelationalDatabaseFromSnapshot( args: CreateRelationalDatabaseFromSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRelationalDatabaseFromSnapshotCommandOutput) => void ): void; - public createRelationalDatabaseFromSnapshot( - args: CreateRelationalDatabaseFromSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRelationalDatabaseFromSnapshotCommandOutput) => void), - cb?: (err: any, data?: CreateRelationalDatabaseFromSnapshotCommandOutput) => void - ): Promise | void { - const command = new CreateRelationalDatabaseFromSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, - * to make copies of a database, and to save data before deleting a database.

- *

The create relational database snapshot operation supports tag-based access - * control via request tags. For more information, see the Amazon Lightsail Developer Guide.

- */ - public createRelationalDatabaseSnapshot( + + /** + * @see {@link CreateRelationalDatabaseSnapshotCommand} + */ + createRelationalDatabaseSnapshot( args: CreateRelationalDatabaseSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRelationalDatabaseSnapshot( + createRelationalDatabaseSnapshot( args: CreateRelationalDatabaseSnapshotCommandInput, cb: (err: any, data?: CreateRelationalDatabaseSnapshotCommandOutput) => void ): void; - public createRelationalDatabaseSnapshot( + createRelationalDatabaseSnapshot( args: CreateRelationalDatabaseSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRelationalDatabaseSnapshotCommandOutput) => void ): void; - public createRelationalDatabaseSnapshot( - args: CreateRelationalDatabaseSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRelationalDatabaseSnapshotCommandOutput) => void), - cb?: (err: any, data?: CreateRelationalDatabaseSnapshotCommandOutput) => void - ): Promise | void { - const command = new CreateRelationalDatabaseSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an alarm.

- *

An alarm is used to monitor a single metric for one of your resources. When a metric - * condition is met, the alarm can notify you by email, SMS text message, and a banner displayed - * on the Amazon Lightsail console. For more information, see Alarms - * in Amazon Lightsail.

- */ - public deleteAlarm(args: DeleteAlarmCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteAlarm(args: DeleteAlarmCommandInput, cb: (err: any, data?: DeleteAlarmCommandOutput) => void): void; - public deleteAlarm( + + /** + * @see {@link DeleteAlarmCommand} + */ + deleteAlarm(args: DeleteAlarmCommandInput, options?: __HttpHandlerOptions): Promise; + deleteAlarm(args: DeleteAlarmCommandInput, cb: (err: any, data?: DeleteAlarmCommandOutput) => void): void; + deleteAlarm( args: DeleteAlarmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAlarmCommandOutput) => void ): void; - public deleteAlarm( - args: DeleteAlarmCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAlarmCommandOutput) => void), - cb?: (err: any, data?: DeleteAlarmCommandOutput) => void - ): Promise | void { - const command = new DeleteAlarmCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.

- */ - public deleteAutoSnapshot( + + /** + * @see {@link DeleteAutoSnapshotCommand} + */ + deleteAutoSnapshot( args: DeleteAutoSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAutoSnapshot( + deleteAutoSnapshot( args: DeleteAutoSnapshotCommandInput, cb: (err: any, data?: DeleteAutoSnapshotCommandOutput) => void ): void; - public deleteAutoSnapshot( + deleteAutoSnapshot( args: DeleteAutoSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAutoSnapshotCommandOutput) => void ): void; - public deleteAutoSnapshot( - args: DeleteAutoSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAutoSnapshotCommandOutput) => void), - cb?: (err: any, data?: DeleteAutoSnapshotCommandOutput) => void - ): Promise | void { - const command = new DeleteAutoSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a Amazon Lightsail bucket.

- * - *

When you delete your bucket, the bucket name is released and can be reused for a new - * bucket in your account or another Amazon Web Services account.

- *
- */ - public deleteBucket( - args: DeleteBucketCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteBucket(args: DeleteBucketCommandInput, cb: (err: any, data?: DeleteBucketCommandOutput) => void): void; - public deleteBucket( + + /** + * @see {@link DeleteBucketCommand} + */ + deleteBucket(args: DeleteBucketCommandInput, options?: __HttpHandlerOptions): Promise; + deleteBucket(args: DeleteBucketCommandInput, cb: (err: any, data?: DeleteBucketCommandOutput) => void): void; + deleteBucket( args: DeleteBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketCommandOutput) => void ): void; - public deleteBucket( - args: DeleteBucketCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an access key for the specified Amazon Lightsail bucket.

- *

We recommend that you delete an access key if the secret access key is compromised.

- *

For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the - * Amazon Lightsail Developer Guide.

- */ - public deleteBucketAccessKey( + + /** + * @see {@link DeleteBucketAccessKeyCommand} + */ + deleteBucketAccessKey( args: DeleteBucketAccessKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketAccessKey( + deleteBucketAccessKey( args: DeleteBucketAccessKeyCommandInput, cb: (err: any, data?: DeleteBucketAccessKeyCommandOutput) => void ): void; - public deleteBucketAccessKey( + deleteBucketAccessKey( args: DeleteBucketAccessKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketAccessKeyCommandOutput) => void ): void; - public deleteBucketAccessKey( - args: DeleteBucketAccessKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketAccessKeyCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketAccessKeyCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketAccessKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) - * distribution.

- *

Certificates that are currently attached to a distribution cannot be deleted. Use the - * DetachCertificateFromDistribution action to detach a certificate from a - * distribution.

- */ - public deleteCertificate( + + /** + * @see {@link DeleteCertificateCommand} + */ + deleteCertificate( args: DeleteCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCertificate( + deleteCertificate( args: DeleteCertificateCommandInput, cb: (err: any, data?: DeleteCertificateCommandOutput) => void ): void; - public deleteCertificate( + deleteCertificate( args: DeleteCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCertificateCommandOutput) => void ): void; - public deleteCertificate( - args: DeleteCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCertificateCommandOutput) => void), - cb?: (err: any, data?: DeleteCertificateCommandOutput) => void - ): Promise | void { - const command = new DeleteCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a contact method.

- *

A contact method is used to send you notifications about your Amazon Lightsail resources. - * You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services - * Regions, and SMS text messages cannot be sent to some countries/regions. For more information, - * see Notifications in Amazon Lightsail.

- */ - public deleteContactMethod( + + /** + * @see {@link DeleteContactMethodCommand} + */ + deleteContactMethod( args: DeleteContactMethodCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteContactMethod( + deleteContactMethod( args: DeleteContactMethodCommandInput, cb: (err: any, data?: DeleteContactMethodCommandOutput) => void ): void; - public deleteContactMethod( + deleteContactMethod( args: DeleteContactMethodCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteContactMethodCommandOutput) => void ): void; - public deleteContactMethod( - args: DeleteContactMethodCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteContactMethodCommandOutput) => void), - cb?: (err: any, data?: DeleteContactMethodCommandOutput) => void - ): Promise | void { - const command = new DeleteContactMethodCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a container image that is registered to your Amazon Lightsail container - * service.

- */ - public deleteContainerImage( + + /** + * @see {@link DeleteContainerImageCommand} + */ + deleteContainerImage( args: DeleteContainerImageCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteContainerImage( + deleteContainerImage( args: DeleteContainerImageCommandInput, cb: (err: any, data?: DeleteContainerImageCommandOutput) => void ): void; - public deleteContainerImage( + deleteContainerImage( args: DeleteContainerImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteContainerImageCommandOutput) => void ): void; - public deleteContainerImage( - args: DeleteContainerImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteContainerImageCommandOutput) => void), - cb?: (err: any, data?: DeleteContainerImageCommandOutput) => void - ): Promise | void { - const command = new DeleteContainerImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes your Amazon Lightsail container service.

- */ - public deleteContainerService( + + /** + * @see {@link DeleteContainerServiceCommand} + */ + deleteContainerService( args: DeleteContainerServiceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteContainerService( + deleteContainerService( args: DeleteContainerServiceCommandInput, cb: (err: any, data?: DeleteContainerServiceCommandOutput) => void ): void; - public deleteContainerService( + deleteContainerService( args: DeleteContainerServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteContainerServiceCommandOutput) => void ): void; - public deleteContainerService( - args: DeleteContainerServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteContainerServiceCommandOutput) => void), - cb?: (err: any, data?: DeleteContainerServiceCommandOutput) => void - ): Promise | void { - const command = new DeleteContainerServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified block storage disk. The disk must be in the available - * state (not attached to a Lightsail instance).

- * - *

The disk may remain in the deleting state for several minutes.

- *
- *

The delete disk operation supports tag-based access control via resource tags - * applied to the resource identified by disk name. For more information, see the - * Amazon Lightsail Developer Guide.

- */ - public deleteDisk(args: DeleteDiskCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteDisk(args: DeleteDiskCommandInput, cb: (err: any, data?: DeleteDiskCommandOutput) => void): void; - public deleteDisk( + + /** + * @see {@link DeleteDiskCommand} + */ + deleteDisk(args: DeleteDiskCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDisk(args: DeleteDiskCommandInput, cb: (err: any, data?: DeleteDiskCommandOutput) => void): void; + deleteDisk( args: DeleteDiskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDiskCommandOutput) => void ): void; - public deleteDisk( - args: DeleteDiskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDiskCommandOutput) => void), - cb?: (err: any, data?: DeleteDiskCommandOutput) => void - ): Promise | void { - const command = new DeleteDiskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified disk snapshot.

- *

When you make periodic snapshots of a disk, the snapshots are incremental, and only the - * blocks on the device that have changed since your last snapshot are saved in the new snapshot. - * When you delete a snapshot, only the data not needed for any other snapshot is removed. So - * regardless of which prior snapshots have been deleted, all active snapshots will have access - * to all the information needed to restore the disk.

- *

The delete disk snapshot operation supports tag-based access control via - * resource tags applied to the resource identified by disk snapshot name. For more - * information, see the Amazon Lightsail Developer Guide.

- */ - public deleteDiskSnapshot( + + /** + * @see {@link DeleteDiskSnapshotCommand} + */ + deleteDiskSnapshot( args: DeleteDiskSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDiskSnapshot( + deleteDiskSnapshot( args: DeleteDiskSnapshotCommandInput, cb: (err: any, data?: DeleteDiskSnapshotCommandOutput) => void ): void; - public deleteDiskSnapshot( + deleteDiskSnapshot( args: DeleteDiskSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDiskSnapshotCommandOutput) => void ): void; - public deleteDiskSnapshot( - args: DeleteDiskSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDiskSnapshotCommandOutput) => void), - cb?: (err: any, data?: DeleteDiskSnapshotCommandOutput) => void - ): Promise | void { - const command = new DeleteDiskSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes your Amazon Lightsail content delivery network (CDN) distribution.

- */ - public deleteDistribution( + + /** + * @see {@link DeleteDistributionCommand} + */ + deleteDistribution( args: DeleteDistributionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDistribution( + deleteDistribution( args: DeleteDistributionCommandInput, cb: (err: any, data?: DeleteDistributionCommandOutput) => void ): void; - public deleteDistribution( + deleteDistribution( args: DeleteDistributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDistributionCommandOutput) => void ): void; - public deleteDistribution( - args: DeleteDistributionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDistributionCommandOutput) => void), - cb?: (err: any, data?: DeleteDistributionCommandOutput) => void - ): Promise | void { - const command = new DeleteDistributionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified domain recordset and all of its domain records.

- *

The delete domain operation supports tag-based access control via resource - * tags applied to the resource identified by domain name. For more information, see - * the Amazon Lightsail Developer Guide.

- */ - public deleteDomain( - args: DeleteDomainCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDomain(args: DeleteDomainCommandInput, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void; - public deleteDomain( + + /** + * @see {@link DeleteDomainCommand} + */ + deleteDomain(args: DeleteDomainCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDomain(args: DeleteDomainCommandInput, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void; + deleteDomain( args: DeleteDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDomainCommandOutput) => void ): void; - public deleteDomain( - args: DeleteDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDomainCommandOutput) => void), - cb?: (err: any, data?: DeleteDomainCommandOutput) => void - ): Promise | void { - const command = new DeleteDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specific domain entry.

- *

The delete domain entry operation supports tag-based access control via - * resource tags applied to the resource identified by domain name. For more - * information, see the Amazon Lightsail Developer Guide.

- */ - public deleteDomainEntry( + + /** + * @see {@link DeleteDomainEntryCommand} + */ + deleteDomainEntry( args: DeleteDomainEntryCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDomainEntry( + deleteDomainEntry( args: DeleteDomainEntryCommandInput, cb: (err: any, data?: DeleteDomainEntryCommandOutput) => void ): void; - public deleteDomainEntry( + deleteDomainEntry( args: DeleteDomainEntryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDomainEntryCommandOutput) => void ): void; - public deleteDomainEntry( - args: DeleteDomainEntryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDomainEntryCommandOutput) => void), - cb?: (err: any, data?: DeleteDomainEntryCommandOutput) => void - ): Promise | void { - const command = new DeleteDomainEntryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an Amazon Lightsail instance.

- *

The delete instance operation supports tag-based access control via resource - * tags applied to the resource identified by instance name. For more information, - * see the Amazon Lightsail Developer Guide.

- */ - public deleteInstance( + + /** + * @see {@link DeleteInstanceCommand} + */ + deleteInstance( args: DeleteInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInstance( - args: DeleteInstanceCommandInput, - cb: (err: any, data?: DeleteInstanceCommandOutput) => void - ): void; - public deleteInstance( + deleteInstance(args: DeleteInstanceCommandInput, cb: (err: any, data?: DeleteInstanceCommandOutput) => void): void; + deleteInstance( args: DeleteInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInstanceCommandOutput) => void ): void; - public deleteInstance( - args: DeleteInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInstanceCommandOutput) => void), - cb?: (err: any, data?: DeleteInstanceCommandOutput) => void - ): Promise | void { - const command = new DeleteInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specific snapshot of a virtual private server (or - * instance).

- *

The delete instance snapshot operation supports tag-based access control via - * resource tags applied to the resource identified by instance snapshot name. For - * more information, see the Amazon Lightsail Developer Guide.

- */ - public deleteInstanceSnapshot( + + /** + * @see {@link DeleteInstanceSnapshotCommand} + */ + deleteInstanceSnapshot( args: DeleteInstanceSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInstanceSnapshot( + deleteInstanceSnapshot( args: DeleteInstanceSnapshotCommandInput, cb: (err: any, data?: DeleteInstanceSnapshotCommandOutput) => void ): void; - public deleteInstanceSnapshot( + deleteInstanceSnapshot( args: DeleteInstanceSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInstanceSnapshotCommandOutput) => void ): void; - public deleteInstanceSnapshot( - args: DeleteInstanceSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInstanceSnapshotCommandOutput) => void), - cb?: (err: any, data?: DeleteInstanceSnapshotCommandOutput) => void - ): Promise | void { - const command = new DeleteInstanceSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified key pair by removing the public key from Amazon Lightsail.

- *

You can delete key pairs that were created using the ImportKeyPair and - * CreateKeyPair actions, as well as the Lightsail default key pair. A new default - * key pair will not be created unless you launch an instance without specifying a custom key - * pair, or you call the DownloadDefaultKeyPair API.

- *

The delete key pair operation supports tag-based access control via resource - * tags applied to the resource identified by key pair name. For more information, - * see the Amazon Lightsail Developer Guide.

- */ - public deleteKeyPair( - args: DeleteKeyPairCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteKeyPair( - args: DeleteKeyPairCommandInput, - cb: (err: any, data?: DeleteKeyPairCommandOutput) => void - ): void; - public deleteKeyPair( + + /** + * @see {@link DeleteKeyPairCommand} + */ + deleteKeyPair(args: DeleteKeyPairCommandInput, options?: __HttpHandlerOptions): Promise; + deleteKeyPair(args: DeleteKeyPairCommandInput, cb: (err: any, data?: DeleteKeyPairCommandOutput) => void): void; + deleteKeyPair( args: DeleteKeyPairCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteKeyPairCommandOutput) => void ): void; - public deleteKeyPair( - args: DeleteKeyPairCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteKeyPairCommandOutput) => void), - cb?: (err: any, data?: DeleteKeyPairCommandOutput) => void - ): Promise | void { - const command = new DeleteKeyPairCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or - * RDP clients to authenticate an instance. This operation enables the Lightsail browser-based - * SSH or RDP clients to connect to the instance after a host key mismatch.

- * - *

Perform this operation only if you were expecting the host key or certificate mismatch - * or if you are familiar with the new host key or certificate on the instance. For more - * information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP - * client.

- *
- */ - public deleteKnownHostKeys( + + /** + * @see {@link DeleteKnownHostKeysCommand} + */ + deleteKnownHostKeys( args: DeleteKnownHostKeysCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteKnownHostKeys( + deleteKnownHostKeys( args: DeleteKnownHostKeysCommandInput, cb: (err: any, data?: DeleteKnownHostKeysCommandOutput) => void ): void; - public deleteKnownHostKeys( + deleteKnownHostKeys( args: DeleteKnownHostKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteKnownHostKeysCommandOutput) => void ): void; - public deleteKnownHostKeys( - args: DeleteKnownHostKeysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteKnownHostKeysCommandOutput) => void), - cb?: (err: any, data?: DeleteKnownHostKeysCommandOutput) => void - ): Promise | void { - const command = new DeleteKnownHostKeysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the - * load balancer is deleted, you will need to create a new load balancer, create a new - * certificate, and verify domain ownership again.

- *

The delete load balancer operation supports tag-based access control via - * resource tags applied to the resource identified by load balancer name. For more - * information, see the Amazon Lightsail Developer Guide.

- */ - public deleteLoadBalancer( + + /** + * @see {@link DeleteLoadBalancerCommand} + */ + deleteLoadBalancer( args: DeleteLoadBalancerCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLoadBalancer( + deleteLoadBalancer( args: DeleteLoadBalancerCommandInput, cb: (err: any, data?: DeleteLoadBalancerCommandOutput) => void ): void; - public deleteLoadBalancer( + deleteLoadBalancer( args: DeleteLoadBalancerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLoadBalancerCommandOutput) => void ): void; - public deleteLoadBalancer( - args: DeleteLoadBalancerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLoadBalancerCommandOutput) => void), - cb?: (err: any, data?: DeleteLoadBalancerCommandOutput) => void - ): Promise | void { - const command = new DeleteLoadBalancerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an SSL/TLS certificate associated with a Lightsail load balancer.

- *

The DeleteLoadBalancerTlsCertificate operation supports tag-based access - * control via resource tags applied to the resource identified by load balancer - * name. For more information, see the Amazon Lightsail Developer Guide.

- */ - public deleteLoadBalancerTlsCertificate( + + /** + * @see {@link DeleteLoadBalancerTlsCertificateCommand} + */ + deleteLoadBalancerTlsCertificate( args: DeleteLoadBalancerTlsCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLoadBalancerTlsCertificate( + deleteLoadBalancerTlsCertificate( args: DeleteLoadBalancerTlsCertificateCommandInput, cb: (err: any, data?: DeleteLoadBalancerTlsCertificateCommandOutput) => void ): void; - public deleteLoadBalancerTlsCertificate( + deleteLoadBalancerTlsCertificate( args: DeleteLoadBalancerTlsCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLoadBalancerTlsCertificateCommandOutput) => void ): void; - public deleteLoadBalancerTlsCertificate( - args: DeleteLoadBalancerTlsCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLoadBalancerTlsCertificateCommandOutput) => void), - cb?: (err: any, data?: DeleteLoadBalancerTlsCertificateCommandOutput) => void - ): Promise | void { - const command = new DeleteLoadBalancerTlsCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a database in Amazon Lightsail.

- *

The delete relational database operation supports tag-based access control - * via resource tags applied to the resource identified by relationalDatabaseName. For more - * information, see the Amazon Lightsail Developer Guide.

- */ - public deleteRelationalDatabase( + + /** + * @see {@link DeleteRelationalDatabaseCommand} + */ + deleteRelationalDatabase( args: DeleteRelationalDatabaseCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRelationalDatabase( + deleteRelationalDatabase( args: DeleteRelationalDatabaseCommandInput, cb: (err: any, data?: DeleteRelationalDatabaseCommandOutput) => void ): void; - public deleteRelationalDatabase( + deleteRelationalDatabase( args: DeleteRelationalDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRelationalDatabaseCommandOutput) => void ): void; - public deleteRelationalDatabase( - args: DeleteRelationalDatabaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRelationalDatabaseCommandOutput) => void), - cb?: (err: any, data?: DeleteRelationalDatabaseCommandOutput) => void - ): Promise | void { - const command = new DeleteRelationalDatabaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a database snapshot in Amazon Lightsail.

- *

The delete relational database snapshot operation supports tag-based access - * control via resource tags applied to the resource identified by relationalDatabaseName. For - * more information, see the Amazon Lightsail Developer Guide.

- */ - public deleteRelationalDatabaseSnapshot( + + /** + * @see {@link DeleteRelationalDatabaseSnapshotCommand} + */ + deleteRelationalDatabaseSnapshot( args: DeleteRelationalDatabaseSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRelationalDatabaseSnapshot( + deleteRelationalDatabaseSnapshot( args: DeleteRelationalDatabaseSnapshotCommandInput, cb: (err: any, data?: DeleteRelationalDatabaseSnapshotCommandOutput) => void ): void; - public deleteRelationalDatabaseSnapshot( + deleteRelationalDatabaseSnapshot( args: DeleteRelationalDatabaseSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRelationalDatabaseSnapshotCommandOutput) => void ): void; - public deleteRelationalDatabaseSnapshot( - args: DeleteRelationalDatabaseSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRelationalDatabaseSnapshotCommandOutput) => void), - cb?: (err: any, data?: DeleteRelationalDatabaseSnapshotCommandOutput) => void - ): Promise | void { - const command = new DeleteRelationalDatabaseSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) - * distribution.

- *

After the certificate is detached, your distribution stops accepting traffic for all of - * the domains that are associated with the certificate.

- */ - public detachCertificateFromDistribution( + + /** + * @see {@link DetachCertificateFromDistributionCommand} + */ + detachCertificateFromDistribution( args: DetachCertificateFromDistributionCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachCertificateFromDistribution( + detachCertificateFromDistribution( args: DetachCertificateFromDistributionCommandInput, cb: (err: any, data?: DetachCertificateFromDistributionCommandOutput) => void ): void; - public detachCertificateFromDistribution( + detachCertificateFromDistribution( args: DetachCertificateFromDistributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachCertificateFromDistributionCommandOutput) => void ): void; - public detachCertificateFromDistribution( - args: DetachCertificateFromDistributionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachCertificateFromDistributionCommandOutput) => void), - cb?: (err: any, data?: DetachCertificateFromDistributionCommandOutput) => void - ): Promise | void { - const command = new DetachCertificateFromDistributionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount - * any file systems on the device within your operating system before stopping the instance and - * detaching the disk.

- *

The detach disk operation supports tag-based access control via resource tags - * applied to the resource identified by disk name. For more information, see the - * Amazon Lightsail Developer Guide.

- */ - public detachDisk(args: DetachDiskCommandInput, options?: __HttpHandlerOptions): Promise; - public detachDisk(args: DetachDiskCommandInput, cb: (err: any, data?: DetachDiskCommandOutput) => void): void; - public detachDisk( + + /** + * @see {@link DetachDiskCommand} + */ + detachDisk(args: DetachDiskCommandInput, options?: __HttpHandlerOptions): Promise; + detachDisk(args: DetachDiskCommandInput, cb: (err: any, data?: DetachDiskCommandOutput) => void): void; + detachDisk( args: DetachDiskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachDiskCommandOutput) => void ): void; - public detachDisk( - args: DetachDiskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachDiskCommandOutput) => void), - cb?: (err: any, data?: DetachDiskCommandOutput) => void - ): Promise | void { - const command = new DetachDiskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detaches the specified instances from a Lightsail load balancer.

- *

This operation waits until the instances are no longer needed before they are detached - * from the load balancer.

- *

The detach instances from load balancer operation supports tag-based access - * control via resource tags applied to the resource identified by load balancer - * name. For more information, see the Amazon Lightsail Developer Guide.

- */ - public detachInstancesFromLoadBalancer( + + /** + * @see {@link DetachInstancesFromLoadBalancerCommand} + */ + detachInstancesFromLoadBalancer( args: DetachInstancesFromLoadBalancerCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachInstancesFromLoadBalancer( + detachInstancesFromLoadBalancer( args: DetachInstancesFromLoadBalancerCommandInput, cb: (err: any, data?: DetachInstancesFromLoadBalancerCommandOutput) => void ): void; - public detachInstancesFromLoadBalancer( + detachInstancesFromLoadBalancer( args: DetachInstancesFromLoadBalancerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachInstancesFromLoadBalancerCommandOutput) => void ): void; - public detachInstancesFromLoadBalancer( - args: DetachInstancesFromLoadBalancerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachInstancesFromLoadBalancerCommandOutput) => void), - cb?: (err: any, data?: DetachInstancesFromLoadBalancerCommandOutput) => void - ): Promise | void { - const command = new DetachInstancesFromLoadBalancerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detaches a static IP from the Amazon Lightsail instance to which it is attached.

- */ - public detachStaticIp( + + /** + * @see {@link DetachStaticIpCommand} + */ + detachStaticIp( args: DetachStaticIpCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachStaticIp( - args: DetachStaticIpCommandInput, - cb: (err: any, data?: DetachStaticIpCommandOutput) => void - ): void; - public detachStaticIp( + detachStaticIp(args: DetachStaticIpCommandInput, cb: (err: any, data?: DetachStaticIpCommandOutput) => void): void; + detachStaticIp( args: DetachStaticIpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachStaticIpCommandOutput) => void ): void; - public detachStaticIp( - args: DetachStaticIpCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachStaticIpCommandOutput) => void), - cb?: (err: any, data?: DetachStaticIpCommandOutput) => void - ): Promise | void { - const command = new DetachStaticIpCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.

- */ - public disableAddOn( - args: DisableAddOnCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public disableAddOn(args: DisableAddOnCommandInput, cb: (err: any, data?: DisableAddOnCommandOutput) => void): void; - public disableAddOn( + + /** + * @see {@link DisableAddOnCommand} + */ + disableAddOn(args: DisableAddOnCommandInput, options?: __HttpHandlerOptions): Promise; + disableAddOn(args: DisableAddOnCommandInput, cb: (err: any, data?: DisableAddOnCommandOutput) => void): void; + disableAddOn( args: DisableAddOnCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableAddOnCommandOutput) => void ): void; - public disableAddOn( - args: DisableAddOnCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableAddOnCommandOutput) => void), - cb?: (err: any, data?: DisableAddOnCommandOutput) => void - ): Promise | void { - const command = new DisableAddOnCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Downloads the regional Amazon Lightsail default key pair.

- *

This action also creates a Lightsail default key pair if a default key pair - * does not currently exist in the Amazon Web Services Region.

- */ - public downloadDefaultKeyPair( + + /** + * @see {@link DownloadDefaultKeyPairCommand} + */ + downloadDefaultKeyPair( args: DownloadDefaultKeyPairCommandInput, options?: __HttpHandlerOptions ): Promise; - public downloadDefaultKeyPair( + downloadDefaultKeyPair( args: DownloadDefaultKeyPairCommandInput, cb: (err: any, data?: DownloadDefaultKeyPairCommandOutput) => void ): void; - public downloadDefaultKeyPair( + downloadDefaultKeyPair( args: DownloadDefaultKeyPairCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DownloadDefaultKeyPairCommandOutput) => void ): void; - public downloadDefaultKeyPair( - args: DownloadDefaultKeyPairCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DownloadDefaultKeyPairCommandOutput) => void), - cb?: (err: any, data?: DownloadDefaultKeyPairCommandOutput) => void - ): Promise | void { - const command = new DownloadDefaultKeyPairCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see - * the Amazon Lightsail Developer Guide.

- */ - public enableAddOn(args: EnableAddOnCommandInput, options?: __HttpHandlerOptions): Promise; - public enableAddOn(args: EnableAddOnCommandInput, cb: (err: any, data?: EnableAddOnCommandOutput) => void): void; - public enableAddOn( + + /** + * @see {@link EnableAddOnCommand} + */ + enableAddOn(args: EnableAddOnCommandInput, options?: __HttpHandlerOptions): Promise; + enableAddOn(args: EnableAddOnCommandInput, cb: (err: any, data?: EnableAddOnCommandOutput) => void): void; + enableAddOn( args: EnableAddOnCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableAddOnCommandOutput) => void ): void; - public enableAddOn( - args: EnableAddOnCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableAddOnCommandOutput) => void), - cb?: (err: any, data?: EnableAddOnCommandOutput) => void - ): Promise | void { - const command = new EnableAddOnCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). - * This operation results in an export snapshot record that can be used with the create - * cloud formation stack operation to create new Amazon EC2 instances.

- *

Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the - * instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in - * Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in - * Amazon EC2 as the source Lightsail snapshot.

- *

- *

The export snapshot operation supports tag-based access control via resource - * tags applied to the resource identified by source snapshot name. For more - * information, see the Amazon Lightsail Developer Guide.

- * - *

Use the get instance snapshots or get disk snapshots - * operations to get a list of snapshots that you can export to Amazon EC2.

- *
- */ - public exportSnapshot( + + /** + * @see {@link ExportSnapshotCommand} + */ + exportSnapshot( args: ExportSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public exportSnapshot( - args: ExportSnapshotCommandInput, - cb: (err: any, data?: ExportSnapshotCommandOutput) => void - ): void; - public exportSnapshot( + exportSnapshot(args: ExportSnapshotCommandInput, cb: (err: any, data?: ExportSnapshotCommandOutput) => void): void; + exportSnapshot( args: ExportSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportSnapshotCommandOutput) => void ): void; - public exportSnapshot( - args: ExportSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportSnapshotCommandOutput) => void), - cb?: (err: any, data?: ExportSnapshotCommandOutput) => void - ): Promise | void { - const command = new ExportSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the names of all active (not deleted) resources.

- */ - public getActiveNames( + + /** + * @see {@link GetActiveNamesCommand} + */ + getActiveNames( args: GetActiveNamesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getActiveNames( - args: GetActiveNamesCommandInput, - cb: (err: any, data?: GetActiveNamesCommandOutput) => void - ): void; - public getActiveNames( + getActiveNames(args: GetActiveNamesCommandInput, cb: (err: any, data?: GetActiveNamesCommandOutput) => void): void; + getActiveNames( args: GetActiveNamesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetActiveNamesCommandOutput) => void ): void; - public getActiveNames( - args: GetActiveNamesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetActiveNamesCommandOutput) => void), - cb?: (err: any, data?: GetActiveNamesCommandOutput) => void - ): Promise | void { - const command = new GetActiveNamesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the configured alarms. Specify an alarm name in your request to - * return information about a specific alarm, or specify a monitored resource name to return - * information about all alarms for a specific resource.

- *

An alarm is used to monitor a single metric for one of your resources. When a metric - * condition is met, the alarm can notify you by email, SMS text message, and a banner displayed - * on the Amazon Lightsail console. For more information, see Alarms - * in Amazon Lightsail.

- */ - public getAlarms(args: GetAlarmsCommandInput, options?: __HttpHandlerOptions): Promise; - public getAlarms(args: GetAlarmsCommandInput, cb: (err: any, data?: GetAlarmsCommandOutput) => void): void; - public getAlarms( + + /** + * @see {@link GetAlarmsCommand} + */ + getAlarms(args: GetAlarmsCommandInput, options?: __HttpHandlerOptions): Promise; + getAlarms(args: GetAlarmsCommandInput, cb: (err: any, data?: GetAlarmsCommandOutput) => void): void; + getAlarms( args: GetAlarmsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAlarmsCommandOutput) => void ): void; - public getAlarms( - args: GetAlarmsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAlarmsCommandOutput) => void), - cb?: (err: any, data?: GetAlarmsCommandOutput) => void - ): Promise | void { - const command = new GetAlarmsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the available automatic snapshots for an instance or disk. For more information, - * see the Amazon Lightsail Developer Guide.

- */ - public getAutoSnapshots( + + /** + * @see {@link GetAutoSnapshotsCommand} + */ + getAutoSnapshots( args: GetAutoSnapshotsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAutoSnapshots( + getAutoSnapshots( args: GetAutoSnapshotsCommandInput, cb: (err: any, data?: GetAutoSnapshotsCommandOutput) => void ): void; - public getAutoSnapshots( + getAutoSnapshots( args: GetAutoSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAutoSnapshotsCommandOutput) => void ): void; - public getAutoSnapshots( - args: GetAutoSnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAutoSnapshotsCommandOutput) => void), - cb?: (err: any, data?: GetAutoSnapshotsCommandOutput) => void - ): Promise | void { - const command = new GetAutoSnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the list of available instance images, or blueprints. You can - * use a blueprint to create a new instance already running a specific operating system, as well - * as a preinstalled app or development stack. The software each instance is running depends on - * the blueprint image you choose.

- * - *

Use active blueprints when creating new instances. Inactive blueprints are listed to - * support customers with existing instances and are not necessarily available to create new - * instances. Blueprints are marked inactive when they become outdated due to operating system - * updates or new application releases.

- *
- */ - public getBlueprints( - args: GetBlueprintsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getBlueprints( - args: GetBlueprintsCommandInput, - cb: (err: any, data?: GetBlueprintsCommandOutput) => void - ): void; - public getBlueprints( + + /** + * @see {@link GetBlueprintsCommand} + */ + getBlueprints(args: GetBlueprintsCommandInput, options?: __HttpHandlerOptions): Promise; + getBlueprints(args: GetBlueprintsCommandInput, cb: (err: any, data?: GetBlueprintsCommandOutput) => void): void; + getBlueprints( args: GetBlueprintsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBlueprintsCommandOutput) => void ): void; - public getBlueprints( - args: GetBlueprintsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBlueprintsCommandOutput) => void), - cb?: (err: any, data?: GetBlueprintsCommandOutput) => void - ): Promise | void { - const command = new GetBlueprintsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the existing access key IDs for the specified Amazon Lightsail bucket.

- * - *

This action does not return the secret access key value of an access key. You can get a - * secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, you must create - * a new access key.

- *
- */ - public getBucketAccessKeys( + + /** + * @see {@link GetBucketAccessKeysCommand} + */ + getBucketAccessKeys( args: GetBucketAccessKeysCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketAccessKeys( + getBucketAccessKeys( args: GetBucketAccessKeysCommandInput, cb: (err: any, data?: GetBucketAccessKeysCommandOutput) => void ): void; - public getBucketAccessKeys( + getBucketAccessKeys( args: GetBucketAccessKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketAccessKeysCommandOutput) => void ): void; - public getBucketAccessKeys( - args: GetBucketAccessKeysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketAccessKeysCommandOutput) => void), - cb?: (err: any, data?: GetBucketAccessKeysCommandOutput) => void - ): Promise | void { - const command = new GetBucketAccessKeysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the bundles that you can apply to a Amazon Lightsail bucket.

- *

The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a - * bucket.

- *

Use the UpdateBucketBundle action to update the - * bundle for a bucket.

- */ - public getBucketBundles( + + /** + * @see {@link GetBucketBundlesCommand} + */ + getBucketBundles( args: GetBucketBundlesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketBundles( + getBucketBundles( args: GetBucketBundlesCommandInput, cb: (err: any, data?: GetBucketBundlesCommandOutput) => void ): void; - public getBucketBundles( + getBucketBundles( args: GetBucketBundlesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketBundlesCommandOutput) => void ): void; - public getBucketBundles( - args: GetBucketBundlesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketBundlesCommandOutput) => void), - cb?: (err: any, data?: GetBucketBundlesCommandOutput) => void - ): Promise | void { - const command = new GetBucketBundlesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the data points of a specific metric for an Amazon Lightsail bucket.

- *

Metrics report the utilization of a bucket. View and collect metric data regularly to - * monitor the number of objects stored in a bucket (including object versions) and the storage - * space used by those objects.

- */ - public getBucketMetricData( + + /** + * @see {@link GetBucketMetricDataCommand} + */ + getBucketMetricData( args: GetBucketMetricDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketMetricData( + getBucketMetricData( args: GetBucketMetricDataCommandInput, cb: (err: any, data?: GetBucketMetricDataCommandOutput) => void ): void; - public getBucketMetricData( + getBucketMetricData( args: GetBucketMetricDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketMetricDataCommandOutput) => void ): void; - public getBucketMetricData( - args: GetBucketMetricDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketMetricDataCommandOutput) => void), - cb?: (err: any, data?: GetBucketMetricDataCommandOutput) => void - ): Promise | void { - const command = new GetBucketMetricDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about one or more Amazon Lightsail buckets. The information returned - * includes the synchronization status of the Amazon Simple Storage Service (Amazon S3) - * account-level block public access feature for your Lightsail buckets.

- *

For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer - * Guide.

- */ - public getBuckets(args: GetBucketsCommandInput, options?: __HttpHandlerOptions): Promise; - public getBuckets(args: GetBucketsCommandInput, cb: (err: any, data?: GetBucketsCommandOutput) => void): void; - public getBuckets( + + /** + * @see {@link GetBucketsCommand} + */ + getBuckets(args: GetBucketsCommandInput, options?: __HttpHandlerOptions): Promise; + getBuckets(args: GetBucketsCommandInput, cb: (err: any, data?: GetBucketsCommandOutput) => void): void; + getBuckets( args: GetBucketsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketsCommandOutput) => void ): void; - public getBuckets( - args: GetBucketsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketsCommandOutput) => void), - cb?: (err: any, data?: GetBucketsCommandOutput) => void - ): Promise | void { - const command = new GetBucketsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the bundles that you can apply to an Amazon Lightsail instance when you create - * it.

- *

A bundle describes the specifications of an instance, such as the monthly cost, amount of - * memory, the number of vCPUs, amount of storage space, and monthly network data transfer - * quota.

- * - *

Bundles are referred to as instance plans in the Lightsail - * console.

- *
- */ - public getBundles(args: GetBundlesCommandInput, options?: __HttpHandlerOptions): Promise; - public getBundles(args: GetBundlesCommandInput, cb: (err: any, data?: GetBundlesCommandOutput) => void): void; - public getBundles( + + /** + * @see {@link GetBundlesCommand} + */ + getBundles(args: GetBundlesCommandInput, options?: __HttpHandlerOptions): Promise; + getBundles(args: GetBundlesCommandInput, cb: (err: any, data?: GetBundlesCommandOutput) => void): void; + getBundles( args: GetBundlesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBundlesCommandOutput) => void ): void; - public getBundles( - args: GetBundlesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBundlesCommandOutput) => void), - cb?: (err: any, data?: GetBundlesCommandOutput) => void - ): Promise | void { - const command = new GetBundlesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about one or more Amazon Lightsail SSL/TLS certificates.

- * - *

To get a summary of a certificate, ommit includeCertificateDetails from - * your request. The response will include only the certificate Amazon Resource Name (ARN), - * certificate name, domain name, and tags.

- *
- */ - public getCertificates( + + /** + * @see {@link GetCertificatesCommand} + */ + getCertificates( args: GetCertificatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCertificates( - args: GetCertificatesCommandInput, - cb: (err: any, data?: GetCertificatesCommandOutput) => void - ): void; - public getCertificates( + getCertificates(args: GetCertificatesCommandInput, cb: (err: any, data?: GetCertificatesCommandOutput) => void): void; + getCertificates( args: GetCertificatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCertificatesCommandOutput) => void ): void; - public getCertificates( - args: GetCertificatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCertificatesCommandOutput) => void), - cb?: (err: any, data?: GetCertificatesCommandOutput) => void - ): Promise | void { - const command = new GetCertificatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the CloudFormation stack record created as a result of the create cloud - * formation stack operation.

- *

An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail - * snapshot.

- */ - public getCloudFormationStackRecords( + + /** + * @see {@link GetCloudFormationStackRecordsCommand} + */ + getCloudFormationStackRecords( args: GetCloudFormationStackRecordsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCloudFormationStackRecords( + getCloudFormationStackRecords( args: GetCloudFormationStackRecordsCommandInput, cb: (err: any, data?: GetCloudFormationStackRecordsCommandOutput) => void ): void; - public getCloudFormationStackRecords( + getCloudFormationStackRecords( args: GetCloudFormationStackRecordsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCloudFormationStackRecordsCommandOutput) => void ): void; - public getCloudFormationStackRecords( - args: GetCloudFormationStackRecordsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCloudFormationStackRecordsCommandOutput) => void), - cb?: (err: any, data?: GetCloudFormationStackRecordsCommandOutput) => void - ): Promise | void { - const command = new GetCloudFormationStackRecordsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the configured contact methods. Specify a protocol in your - * request to return information about a specific contact method.

- *

A contact method is used to send you notifications about your Amazon Lightsail resources. - * You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services - * Regions, and SMS text messages cannot be sent to some countries/regions. For more information, - * see Notifications in Amazon Lightsail.

- */ - public getContactMethods( + + /** + * @see {@link GetContactMethodsCommand} + */ + getContactMethods( args: GetContactMethodsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getContactMethods( + getContactMethods( args: GetContactMethodsCommandInput, cb: (err: any, data?: GetContactMethodsCommandOutput) => void ): void; - public getContactMethods( + getContactMethods( args: GetContactMethodsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContactMethodsCommandOutput) => void ): void; - public getContactMethods( - args: GetContactMethodsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContactMethodsCommandOutput) => void), - cb?: (err: any, data?: GetContactMethodsCommandOutput) => void - ): Promise | void { - const command = new GetContactMethodsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about Amazon Lightsail containers, such as the current version of the - * Lightsail Control (lightsailctl) plugin.

- */ - public getContainerAPIMetadata( + + /** + * @see {@link GetContainerAPIMetadataCommand} + */ + getContainerAPIMetadata( args: GetContainerAPIMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getContainerAPIMetadata( + getContainerAPIMetadata( args: GetContainerAPIMetadataCommandInput, cb: (err: any, data?: GetContainerAPIMetadataCommandOutput) => void ): void; - public getContainerAPIMetadata( + getContainerAPIMetadata( args: GetContainerAPIMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContainerAPIMetadataCommandOutput) => void ): void; - public getContainerAPIMetadata( - args: GetContainerAPIMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContainerAPIMetadataCommandOutput) => void), - cb?: (err: any, data?: GetContainerAPIMetadataCommandOutput) => void - ): Promise | void { - const command = new GetContainerAPIMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the container images that are registered to your Amazon Lightsail container - * service.

- * - *

If you created a deployment on your Lightsail container service that uses container - * images from a public registry like Docker Hub, those images are not returned as part of this - * action. Those images are not registered to your Lightsail container service.

- *
- */ - public getContainerImages( + + /** + * @see {@link GetContainerImagesCommand} + */ + getContainerImages( args: GetContainerImagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getContainerImages( + getContainerImages( args: GetContainerImagesCommandInput, cb: (err: any, data?: GetContainerImagesCommandOutput) => void ): void; - public getContainerImages( + getContainerImages( args: GetContainerImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContainerImagesCommandOutput) => void ): void; - public getContainerImages( - args: GetContainerImagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContainerImagesCommandOutput) => void), - cb?: (err: any, data?: GetContainerImagesCommandOutput) => void - ): Promise | void { - const command = new GetContainerImagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the log events of a container of your Amazon Lightsail container service.

- *

If your container service has more than one node (i.e., a scale greater than 1), then the - * log events that are returned for the specified container are merged from all nodes on your - * container service.

- * - *

Container logs are retained for a certain amount of time. For more information, see - * Amazon Lightsail - * endpoints and quotas in the Amazon Web Services General - * Reference.

- *
- */ - public getContainerLog( + + /** + * @see {@link GetContainerLogCommand} + */ + getContainerLog( args: GetContainerLogCommandInput, options?: __HttpHandlerOptions ): Promise; - public getContainerLog( - args: GetContainerLogCommandInput, - cb: (err: any, data?: GetContainerLogCommandOutput) => void - ): void; - public getContainerLog( + getContainerLog(args: GetContainerLogCommandInput, cb: (err: any, data?: GetContainerLogCommandOutput) => void): void; + getContainerLog( args: GetContainerLogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContainerLogCommandOutput) => void ): void; - public getContainerLog( - args: GetContainerLogCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContainerLogCommandOutput) => void), - cb?: (err: any, data?: GetContainerLogCommandOutput) => void - ): Promise | void { - const command = new GetContainerLogCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the deployments for your Amazon Lightsail container service

- *

A deployment specifies the settings, such as the ports and launch command, of containers - * that are deployed to your container service.

- *

The deployments are ordered by version in ascending order. The newest version is listed at - * the top of the response.

- * - *

A set number of deployments are kept before the oldest one is replaced with the newest - * one. For more information, see Amazon Lightsail - * endpoints and quotas in the Amazon Web Services General - * Reference.

- *
- */ - public getContainerServiceDeployments( + + /** + * @see {@link GetContainerServiceDeploymentsCommand} + */ + getContainerServiceDeployments( args: GetContainerServiceDeploymentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getContainerServiceDeployments( + getContainerServiceDeployments( args: GetContainerServiceDeploymentsCommandInput, cb: (err: any, data?: GetContainerServiceDeploymentsCommandOutput) => void ): void; - public getContainerServiceDeployments( + getContainerServiceDeployments( args: GetContainerServiceDeploymentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContainerServiceDeploymentsCommandOutput) => void ): void; - public getContainerServiceDeployments( - args: GetContainerServiceDeploymentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContainerServiceDeploymentsCommandOutput) => void), - cb?: (err: any, data?: GetContainerServiceDeploymentsCommandOutput) => void - ): Promise | void { - const command = new GetContainerServiceDeploymentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the data points of a specific metric of your Amazon Lightsail container - * service.

- *

Metrics report the utilization of your resources. Monitor and collect metric data - * regularly to maintain the reliability, availability, and performance of your resources.

- */ - public getContainerServiceMetricData( + + /** + * @see {@link GetContainerServiceMetricDataCommand} + */ + getContainerServiceMetricData( args: GetContainerServiceMetricDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getContainerServiceMetricData( + getContainerServiceMetricData( args: GetContainerServiceMetricDataCommandInput, cb: (err: any, data?: GetContainerServiceMetricDataCommandOutput) => void ): void; - public getContainerServiceMetricData( + getContainerServiceMetricData( args: GetContainerServiceMetricDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContainerServiceMetricDataCommandOutput) => void ): void; - public getContainerServiceMetricData( - args: GetContainerServiceMetricDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContainerServiceMetricDataCommandOutput) => void), - cb?: (err: any, data?: GetContainerServiceMetricDataCommandOutput) => void - ): Promise | void { - const command = new GetContainerServiceMetricDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the list of powers that can be specified for your Amazon Lightsail container - * services.

- *

The power specifies the amount of memory, the number of vCPUs, and the base price of the - * container service.

- */ - public getContainerServicePowers( + + /** + * @see {@link GetContainerServicePowersCommand} + */ + getContainerServicePowers( args: GetContainerServicePowersCommandInput, options?: __HttpHandlerOptions ): Promise; - public getContainerServicePowers( + getContainerServicePowers( args: GetContainerServicePowersCommandInput, cb: (err: any, data?: GetContainerServicePowersCommandOutput) => void ): void; - public getContainerServicePowers( + getContainerServicePowers( args: GetContainerServicePowersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContainerServicePowersCommandOutput) => void ): void; - public getContainerServicePowers( - args: GetContainerServicePowersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContainerServicePowersCommandOutput) => void), - cb?: (err: any, data?: GetContainerServicePowersCommandOutput) => void - ): Promise | void { - const command = new GetContainerServicePowersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about one or more of your Amazon Lightsail container services.

- */ - public getContainerServices( + + /** + * @see {@link GetContainerServicesCommand} + */ + getContainerServices( args: GetContainerServicesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getContainerServices( + getContainerServices( args: GetContainerServicesCommandInput, cb: (err: any, data?: GetContainerServicesCommandOutput) => void ): void; - public getContainerServices( + getContainerServices( args: GetContainerServicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContainerServicesCommandOutput) => void ): void; - public getContainerServices( - args: GetContainerServicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContainerServicesCommandOutput) => void), - cb?: (err: any, data?: GetContainerServicesCommandOutput) => void - ): Promise | void { - const command = new GetContainerServicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a resource that has been deleted.

- */ - public getCostEstimate( + + /** + * @see {@link GetCostEstimateCommand} + */ + getCostEstimate( args: GetCostEstimateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCostEstimate( - args: GetCostEstimateCommandInput, - cb: (err: any, data?: GetCostEstimateCommandOutput) => void - ): void; - public getCostEstimate( + getCostEstimate(args: GetCostEstimateCommandInput, cb: (err: any, data?: GetCostEstimateCommandOutput) => void): void; + getCostEstimate( args: GetCostEstimateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCostEstimateCommandOutput) => void ): void; - public getCostEstimate( - args: GetCostEstimateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCostEstimateCommandOutput) => void), - cb?: (err: any, data?: GetCostEstimateCommandOutput) => void - ): Promise | void { - const command = new GetCostEstimateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a specific block storage disk.

- */ - public getDisk(args: GetDiskCommandInput, options?: __HttpHandlerOptions): Promise; - public getDisk(args: GetDiskCommandInput, cb: (err: any, data?: GetDiskCommandOutput) => void): void; - public getDisk( + + /** + * @see {@link GetDiskCommand} + */ + getDisk(args: GetDiskCommandInput, options?: __HttpHandlerOptions): Promise; + getDisk(args: GetDiskCommandInput, cb: (err: any, data?: GetDiskCommandOutput) => void): void; + getDisk( args: GetDiskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDiskCommandOutput) => void ): void; - public getDisk( - args: GetDiskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDiskCommandOutput) => void), - cb?: (err: any, data?: GetDiskCommandOutput) => void - ): Promise | void { - const command = new GetDiskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about all block storage disks in your AWS account and region.

- */ - public getDisks(args: GetDisksCommandInput, options?: __HttpHandlerOptions): Promise; - public getDisks(args: GetDisksCommandInput, cb: (err: any, data?: GetDisksCommandOutput) => void): void; - public getDisks( + + /** + * @see {@link GetDisksCommand} + */ + getDisks(args: GetDisksCommandInput, options?: __HttpHandlerOptions): Promise; + getDisks(args: GetDisksCommandInput, cb: (err: any, data?: GetDisksCommandOutput) => void): void; + getDisks( args: GetDisksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDisksCommandOutput) => void ): void; - public getDisks( - args: GetDisksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDisksCommandOutput) => void), - cb?: (err: any, data?: GetDisksCommandOutput) => void - ): Promise | void { - const command = new GetDisksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a specific block storage disk snapshot.

- */ - public getDiskSnapshot( + + /** + * @see {@link GetDiskSnapshotCommand} + */ + getDiskSnapshot( args: GetDiskSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDiskSnapshot( - args: GetDiskSnapshotCommandInput, - cb: (err: any, data?: GetDiskSnapshotCommandOutput) => void - ): void; - public getDiskSnapshot( + getDiskSnapshot(args: GetDiskSnapshotCommandInput, cb: (err: any, data?: GetDiskSnapshotCommandOutput) => void): void; + getDiskSnapshot( args: GetDiskSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDiskSnapshotCommandOutput) => void ): void; - public getDiskSnapshot( - args: GetDiskSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDiskSnapshotCommandOutput) => void), - cb?: (err: any, data?: GetDiskSnapshotCommandOutput) => void - ): Promise | void { - const command = new GetDiskSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about all block storage disk snapshots in your AWS account and - * region.

- */ - public getDiskSnapshots( + + /** + * @see {@link GetDiskSnapshotsCommand} + */ + getDiskSnapshots( args: GetDiskSnapshotsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDiskSnapshots( + getDiskSnapshots( args: GetDiskSnapshotsCommandInput, cb: (err: any, data?: GetDiskSnapshotsCommandOutput) => void ): void; - public getDiskSnapshots( + getDiskSnapshots( args: GetDiskSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDiskSnapshotsCommandOutput) => void ): void; - public getDiskSnapshots( - args: GetDiskSnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDiskSnapshotsCommandOutput) => void), - cb?: (err: any, data?: GetDiskSnapshotsCommandOutput) => void - ): Promise | void { - const command = new GetDiskSnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the bundles that can be applied to your Amazon Lightsail content delivery network - * (CDN) distributions.

- *

A distribution bundle specifies the monthly network transfer quota and monthly cost of - * your distribution.

- */ - public getDistributionBundles( + + /** + * @see {@link GetDistributionBundlesCommand} + */ + getDistributionBundles( args: GetDistributionBundlesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDistributionBundles( + getDistributionBundles( args: GetDistributionBundlesCommandInput, cb: (err: any, data?: GetDistributionBundlesCommandOutput) => void ): void; - public getDistributionBundles( + getDistributionBundles( args: GetDistributionBundlesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDistributionBundlesCommandOutput) => void ): void; - public getDistributionBundles( - args: GetDistributionBundlesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDistributionBundlesCommandOutput) => void), - cb?: (err: any, data?: GetDistributionBundlesCommandOutput) => void - ): Promise | void { - const command = new GetDistributionBundlesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail - * content delivery network (CDN) distribution.

- */ - public getDistributionLatestCacheReset( + + /** + * @see {@link GetDistributionLatestCacheResetCommand} + */ + getDistributionLatestCacheReset( args: GetDistributionLatestCacheResetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDistributionLatestCacheReset( + getDistributionLatestCacheReset( args: GetDistributionLatestCacheResetCommandInput, cb: (err: any, data?: GetDistributionLatestCacheResetCommandOutput) => void ): void; - public getDistributionLatestCacheReset( + getDistributionLatestCacheReset( args: GetDistributionLatestCacheResetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDistributionLatestCacheResetCommandOutput) => void ): void; - public getDistributionLatestCacheReset( - args: GetDistributionLatestCacheResetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDistributionLatestCacheResetCommandOutput) => void), - cb?: (err: any, data?: GetDistributionLatestCacheResetCommandOutput) => void - ): Promise | void { - const command = new GetDistributionLatestCacheResetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the data points of a specific metric for an Amazon Lightsail content delivery - * network (CDN) distribution.

- *

Metrics report the utilization of your resources, and the error counts generated by them. - * Monitor and collect metric data regularly to maintain the reliability, availability, and - * performance of your resources.

- */ - public getDistributionMetricData( + + /** + * @see {@link GetDistributionMetricDataCommand} + */ + getDistributionMetricData( args: GetDistributionMetricDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDistributionMetricData( + getDistributionMetricData( args: GetDistributionMetricDataCommandInput, cb: (err: any, data?: GetDistributionMetricDataCommandOutput) => void ): void; - public getDistributionMetricData( + getDistributionMetricData( args: GetDistributionMetricDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDistributionMetricDataCommandOutput) => void ): void; - public getDistributionMetricData( - args: GetDistributionMetricDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDistributionMetricDataCommandOutput) => void), - cb?: (err: any, data?: GetDistributionMetricDataCommandOutput) => void - ): Promise | void { - const command = new GetDistributionMetricDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about one or more of your Amazon Lightsail content delivery network - * (CDN) distributions.

- */ - public getDistributions( + + /** + * @see {@link GetDistributionsCommand} + */ + getDistributions( args: GetDistributionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDistributions( + getDistributions( args: GetDistributionsCommandInput, cb: (err: any, data?: GetDistributionsCommandOutput) => void ): void; - public getDistributions( + getDistributions( args: GetDistributionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDistributionsCommandOutput) => void ): void; - public getDistributions( - args: GetDistributionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDistributionsCommandOutput) => void), - cb?: (err: any, data?: GetDistributionsCommandOutput) => void - ): Promise | void { - const command = new GetDistributionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a specific domain recordset.

- */ - public getDomain(args: GetDomainCommandInput, options?: __HttpHandlerOptions): Promise; - public getDomain(args: GetDomainCommandInput, cb: (err: any, data?: GetDomainCommandOutput) => void): void; - public getDomain( + + /** + * @see {@link GetDomainCommand} + */ + getDomain(args: GetDomainCommandInput, options?: __HttpHandlerOptions): Promise; + getDomain(args: GetDomainCommandInput, cb: (err: any, data?: GetDomainCommandOutput) => void): void; + getDomain( args: GetDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDomainCommandOutput) => void ): void; - public getDomain( - args: GetDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDomainCommandOutput) => void), - cb?: (err: any, data?: GetDomainCommandOutput) => void - ): Promise | void { - const command = new GetDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of all domains in the user's account.

- */ - public getDomains(args: GetDomainsCommandInput, options?: __HttpHandlerOptions): Promise; - public getDomains(args: GetDomainsCommandInput, cb: (err: any, data?: GetDomainsCommandOutput) => void): void; - public getDomains( + + /** + * @see {@link GetDomainsCommand} + */ + getDomains(args: GetDomainsCommandInput, options?: __HttpHandlerOptions): Promise; + getDomains(args: GetDomainsCommandInput, cb: (err: any, data?: GetDomainsCommandOutput) => void): void; + getDomains( args: GetDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDomainsCommandOutput) => void ): void; - public getDomains( - args: GetDomainsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDomainsCommandOutput) => void), - cb?: (err: any, data?: GetDomainsCommandOutput) => void - ): Promise | void { - const command = new GetDomainsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns all export snapshot records created as a result of the export - * snapshot operation.

- *

An export snapshot record can be used to create a new Amazon EC2 instance and its related - * resources with the CreateCloudFormationStack - * action.

- */ - public getExportSnapshotRecords( + + /** + * @see {@link GetExportSnapshotRecordsCommand} + */ + getExportSnapshotRecords( args: GetExportSnapshotRecordsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getExportSnapshotRecords( + getExportSnapshotRecords( args: GetExportSnapshotRecordsCommandInput, cb: (err: any, data?: GetExportSnapshotRecordsCommandOutput) => void ): void; - public getExportSnapshotRecords( + getExportSnapshotRecords( args: GetExportSnapshotRecordsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExportSnapshotRecordsCommandOutput) => void ): void; - public getExportSnapshotRecords( - args: GetExportSnapshotRecordsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetExportSnapshotRecordsCommandOutput) => void), - cb?: (err: any, data?: GetExportSnapshotRecordsCommandOutput) => void - ): Promise | void { - const command = new GetExportSnapshotRecordsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a specific Amazon Lightsail instance, which is a virtual private - * server.

- */ - public getInstance(args: GetInstanceCommandInput, options?: __HttpHandlerOptions): Promise; - public getInstance(args: GetInstanceCommandInput, cb: (err: any, data?: GetInstanceCommandOutput) => void): void; - public getInstance( + + /** + * @see {@link GetInstanceCommand} + */ + getInstance(args: GetInstanceCommandInput, options?: __HttpHandlerOptions): Promise; + getInstance(args: GetInstanceCommandInput, cb: (err: any, data?: GetInstanceCommandOutput) => void): void; + getInstance( args: GetInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInstanceCommandOutput) => void ): void; - public getInstance( - args: GetInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInstanceCommandOutput) => void), - cb?: (err: any, data?: GetInstanceCommandOutput) => void - ): Promise | void { - const command = new GetInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns temporary SSH keys you can use to connect to a specific virtual private server, or - * instance.

- *

The get instance access details operation supports tag-based access control - * via resource tags applied to the resource identified by instance name. For more - * information, see the Amazon Lightsail Developer Guide.

- */ - public getInstanceAccessDetails( + + /** + * @see {@link GetInstanceAccessDetailsCommand} + */ + getInstanceAccessDetails( args: GetInstanceAccessDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInstanceAccessDetails( + getInstanceAccessDetails( args: GetInstanceAccessDetailsCommandInput, cb: (err: any, data?: GetInstanceAccessDetailsCommandOutput) => void ): void; - public getInstanceAccessDetails( + getInstanceAccessDetails( args: GetInstanceAccessDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInstanceAccessDetailsCommandOutput) => void ): void; - public getInstanceAccessDetails( - args: GetInstanceAccessDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInstanceAccessDetailsCommandOutput) => void), - cb?: (err: any, data?: GetInstanceAccessDetailsCommandOutput) => void - ): Promise | void { - const command = new GetInstanceAccessDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the data points for the specified Amazon Lightsail instance metric, given an - * instance name.

- *

Metrics report the utilization of your resources, and the error counts generated by them. - * Monitor and collect metric data regularly to maintain the reliability, availability, and - * performance of your resources.

- */ - public getInstanceMetricData( + + /** + * @see {@link GetInstanceMetricDataCommand} + */ + getInstanceMetricData( args: GetInstanceMetricDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInstanceMetricData( + getInstanceMetricData( args: GetInstanceMetricDataCommandInput, cb: (err: any, data?: GetInstanceMetricDataCommandOutput) => void ): void; - public getInstanceMetricData( + getInstanceMetricData( args: GetInstanceMetricDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInstanceMetricDataCommandOutput) => void ): void; - public getInstanceMetricData( - args: GetInstanceMetricDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInstanceMetricDataCommandOutput) => void), - cb?: (err: any, data?: GetInstanceMetricDataCommandOutput) => void - ): Promise | void { - const command = new GetInstanceMetricDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses - * allowed to connect to the instance through the ports, and the protocol.

- */ - public getInstancePortStates( + + /** + * @see {@link GetInstancePortStatesCommand} + */ + getInstancePortStates( args: GetInstancePortStatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInstancePortStates( + getInstancePortStates( args: GetInstancePortStatesCommandInput, cb: (err: any, data?: GetInstancePortStatesCommandOutput) => void ): void; - public getInstancePortStates( + getInstancePortStates( args: GetInstancePortStatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInstancePortStatesCommandOutput) => void ): void; - public getInstancePortStates( - args: GetInstancePortStatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInstancePortStatesCommandOutput) => void), - cb?: (err: any, data?: GetInstancePortStatesCommandOutput) => void - ): Promise | void { - const command = new GetInstancePortStatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about all Amazon Lightsail virtual private servers, or - * instances.

- */ - public getInstances( - args: GetInstancesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getInstances(args: GetInstancesCommandInput, cb: (err: any, data?: GetInstancesCommandOutput) => void): void; - public getInstances( + + /** + * @see {@link GetInstancesCommand} + */ + getInstances(args: GetInstancesCommandInput, options?: __HttpHandlerOptions): Promise; + getInstances(args: GetInstancesCommandInput, cb: (err: any, data?: GetInstancesCommandOutput) => void): void; + getInstances( args: GetInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInstancesCommandOutput) => void ): void; - public getInstances( - args: GetInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInstancesCommandOutput) => void), - cb?: (err: any, data?: GetInstancesCommandOutput) => void - ): Promise | void { - const command = new GetInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a specific instance snapshot.

- */ - public getInstanceSnapshot( + + /** + * @see {@link GetInstanceSnapshotCommand} + */ + getInstanceSnapshot( args: GetInstanceSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInstanceSnapshot( + getInstanceSnapshot( args: GetInstanceSnapshotCommandInput, cb: (err: any, data?: GetInstanceSnapshotCommandOutput) => void ): void; - public getInstanceSnapshot( + getInstanceSnapshot( args: GetInstanceSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInstanceSnapshotCommandOutput) => void ): void; - public getInstanceSnapshot( - args: GetInstanceSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInstanceSnapshotCommandOutput) => void), - cb?: (err: any, data?: GetInstanceSnapshotCommandOutput) => void - ): Promise | void { - const command = new GetInstanceSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns all instance snapshots for the user's account.

- */ - public getInstanceSnapshots( + + /** + * @see {@link GetInstanceSnapshotsCommand} + */ + getInstanceSnapshots( args: GetInstanceSnapshotsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInstanceSnapshots( + getInstanceSnapshots( args: GetInstanceSnapshotsCommandInput, cb: (err: any, data?: GetInstanceSnapshotsCommandOutput) => void ): void; - public getInstanceSnapshots( + getInstanceSnapshots( args: GetInstanceSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInstanceSnapshotsCommandOutput) => void ): void; - public getInstanceSnapshots( - args: GetInstanceSnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInstanceSnapshotsCommandOutput) => void), - cb?: (err: any, data?: GetInstanceSnapshotsCommandOutput) => void - ): Promise | void { - const command = new GetInstanceSnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the state of a specific instance. Works on one instance at a time.

- */ - public getInstanceState( + + /** + * @see {@link GetInstanceStateCommand} + */ + getInstanceState( args: GetInstanceStateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInstanceState( + getInstanceState( args: GetInstanceStateCommandInput, cb: (err: any, data?: GetInstanceStateCommandOutput) => void ): void; - public getInstanceState( + getInstanceState( args: GetInstanceStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInstanceStateCommandOutput) => void ): void; - public getInstanceState( - args: GetInstanceStateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInstanceStateCommandOutput) => void), - cb?: (err: any, data?: GetInstanceStateCommandOutput) => void - ): Promise | void { - const command = new GetInstanceStateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a specific key pair.

- */ - public getKeyPair(args: GetKeyPairCommandInput, options?: __HttpHandlerOptions): Promise; - public getKeyPair(args: GetKeyPairCommandInput, cb: (err: any, data?: GetKeyPairCommandOutput) => void): void; - public getKeyPair( + + /** + * @see {@link GetKeyPairCommand} + */ + getKeyPair(args: GetKeyPairCommandInput, options?: __HttpHandlerOptions): Promise; + getKeyPair(args: GetKeyPairCommandInput, cb: (err: any, data?: GetKeyPairCommandOutput) => void): void; + getKeyPair( args: GetKeyPairCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetKeyPairCommandOutput) => void ): void; - public getKeyPair( - args: GetKeyPairCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetKeyPairCommandOutput) => void), - cb?: (err: any, data?: GetKeyPairCommandOutput) => void - ): Promise | void { - const command = new GetKeyPairCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about all key pairs in the user's account.

- */ - public getKeyPairs(args: GetKeyPairsCommandInput, options?: __HttpHandlerOptions): Promise; - public getKeyPairs(args: GetKeyPairsCommandInput, cb: (err: any, data?: GetKeyPairsCommandOutput) => void): void; - public getKeyPairs( + + /** + * @see {@link GetKeyPairsCommand} + */ + getKeyPairs(args: GetKeyPairsCommandInput, options?: __HttpHandlerOptions): Promise; + getKeyPairs(args: GetKeyPairsCommandInput, cb: (err: any, data?: GetKeyPairsCommandOutput) => void): void; + getKeyPairs( args: GetKeyPairsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetKeyPairsCommandOutput) => void ): void; - public getKeyPairs( - args: GetKeyPairsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetKeyPairsCommandOutput) => void), - cb?: (err: any, data?: GetKeyPairsCommandOutput) => void - ): Promise | void { - const command = new GetKeyPairsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the specified Lightsail load balancer.

- */ - public getLoadBalancer( + + /** + * @see {@link GetLoadBalancerCommand} + */ + getLoadBalancer( args: GetLoadBalancerCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLoadBalancer( - args: GetLoadBalancerCommandInput, - cb: (err: any, data?: GetLoadBalancerCommandOutput) => void - ): void; - public getLoadBalancer( + getLoadBalancer(args: GetLoadBalancerCommandInput, cb: (err: any, data?: GetLoadBalancerCommandOutput) => void): void; + getLoadBalancer( args: GetLoadBalancerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLoadBalancerCommandOutput) => void ): void; - public getLoadBalancer( - args: GetLoadBalancerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLoadBalancerCommandOutput) => void), - cb?: (err: any, data?: GetLoadBalancerCommandOutput) => void - ): Promise | void { - const command = new GetLoadBalancerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about health metrics for your Lightsail load balancer.

- *

Metrics report the utilization of your resources, and the error counts generated by them. - * Monitor and collect metric data regularly to maintain the reliability, availability, and - * performance of your resources.

- */ - public getLoadBalancerMetricData( + + /** + * @see {@link GetLoadBalancerMetricDataCommand} + */ + getLoadBalancerMetricData( args: GetLoadBalancerMetricDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLoadBalancerMetricData( + getLoadBalancerMetricData( args: GetLoadBalancerMetricDataCommandInput, cb: (err: any, data?: GetLoadBalancerMetricDataCommandOutput) => void ): void; - public getLoadBalancerMetricData( + getLoadBalancerMetricData( args: GetLoadBalancerMetricDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLoadBalancerMetricDataCommandOutput) => void ): void; - public getLoadBalancerMetricData( - args: GetLoadBalancerMetricDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLoadBalancerMetricDataCommandOutput) => void), - cb?: (err: any, data?: GetLoadBalancerMetricDataCommandOutput) => void - ): Promise | void { - const command = new GetLoadBalancerMetricDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about all load balancers in an account.

- */ - public getLoadBalancers( + + /** + * @see {@link GetLoadBalancersCommand} + */ + getLoadBalancers( args: GetLoadBalancersCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLoadBalancers( + getLoadBalancers( args: GetLoadBalancersCommandInput, cb: (err: any, data?: GetLoadBalancersCommandOutput) => void ): void; - public getLoadBalancers( + getLoadBalancers( args: GetLoadBalancersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLoadBalancersCommandOutput) => void ): void; - public getLoadBalancers( - args: GetLoadBalancersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLoadBalancersCommandOutput) => void), - cb?: (err: any, data?: GetLoadBalancersCommandOutput) => void - ): Promise | void { - const command = new GetLoadBalancersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the TLS certificates that are associated with the specified - * Lightsail load balancer.

- *

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

- *

You can have a maximum of 2 certificates associated with a Lightsail load balancer. One - * is active and the other is inactive.

- */ - public getLoadBalancerTlsCertificates( + + /** + * @see {@link GetLoadBalancerTlsCertificatesCommand} + */ + getLoadBalancerTlsCertificates( args: GetLoadBalancerTlsCertificatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLoadBalancerTlsCertificates( + getLoadBalancerTlsCertificates( args: GetLoadBalancerTlsCertificatesCommandInput, cb: (err: any, data?: GetLoadBalancerTlsCertificatesCommandOutput) => void ): void; - public getLoadBalancerTlsCertificates( + getLoadBalancerTlsCertificates( args: GetLoadBalancerTlsCertificatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLoadBalancerTlsCertificatesCommandOutput) => void ): void; - public getLoadBalancerTlsCertificates( - args: GetLoadBalancerTlsCertificatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLoadBalancerTlsCertificatesCommandOutput) => void), - cb?: (err: any, data?: GetLoadBalancerTlsCertificatesCommandOutput) => void - ): Promise | void { - const command = new GetLoadBalancerTlsCertificatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of TLS security policies that you can apply to Lightsail load - * balancers.

- *

For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load - * balancers in the Amazon Lightsail Developer Guide.

- */ - public getLoadBalancerTlsPolicies( + + /** + * @see {@link GetLoadBalancerTlsPoliciesCommand} + */ + getLoadBalancerTlsPolicies( args: GetLoadBalancerTlsPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLoadBalancerTlsPolicies( + getLoadBalancerTlsPolicies( args: GetLoadBalancerTlsPoliciesCommandInput, cb: (err: any, data?: GetLoadBalancerTlsPoliciesCommandOutput) => void ): void; - public getLoadBalancerTlsPolicies( + getLoadBalancerTlsPolicies( args: GetLoadBalancerTlsPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLoadBalancerTlsPoliciesCommandOutput) => void ): void; - public getLoadBalancerTlsPolicies( - args: GetLoadBalancerTlsPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLoadBalancerTlsPoliciesCommandOutput) => void), - cb?: (err: any, data?: GetLoadBalancerTlsPoliciesCommandOutput) => void - ): Promise | void { - const command = new GetLoadBalancerTlsPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a specific operation. Operations include events such as when you - * create an instance, allocate a static IP, attach a static IP, and so on.

- */ - public getOperation( - args: GetOperationCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getOperation(args: GetOperationCommandInput, cb: (err: any, data?: GetOperationCommandOutput) => void): void; - public getOperation( + + /** + * @see {@link GetOperationCommand} + */ + getOperation(args: GetOperationCommandInput, options?: __HttpHandlerOptions): Promise; + getOperation(args: GetOperationCommandInput, cb: (err: any, data?: GetOperationCommandOutput) => void): void; + getOperation( args: GetOperationCommandInput, options: __HttpHandlerOptions, - cb: (err: any, data?: GetOperationCommandOutput) => void - ): void; - public getOperation( - args: GetOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOperationCommandOutput) => void), - cb?: (err: any, data?: GetOperationCommandOutput) => void - ): Promise | void { - const command = new GetOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about all operations.

- *

Results are returned from oldest to newest, up to a maximum of 200. Results can be paged - * by making each subsequent call to GetOperations use the maximum (last) - * statusChangedAt value from the previous request.

- */ - public getOperations( - args: GetOperationsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getOperations( - args: GetOperationsCommandInput, - cb: (err: any, data?: GetOperationsCommandOutput) => void + cb: (err: any, data?: GetOperationCommandOutput) => void ): void; - public getOperations( + + /** + * @see {@link GetOperationsCommand} + */ + getOperations(args: GetOperationsCommandInput, options?: __HttpHandlerOptions): Promise; + getOperations(args: GetOperationsCommandInput, cb: (err: any, data?: GetOperationsCommandOutput) => void): void; + getOperations( args: GetOperationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOperationsCommandOutput) => void ): void; - public getOperations( - args: GetOperationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOperationsCommandOutput) => void), - cb?: (err: any, data?: GetOperationsCommandOutput) => void - ): Promise | void { - const command = new GetOperationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets operations for a specific resource (e.g., an instance or a static IP).

- */ - public getOperationsForResource( + + /** + * @see {@link GetOperationsForResourceCommand} + */ + getOperationsForResource( args: GetOperationsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public getOperationsForResource( + getOperationsForResource( args: GetOperationsForResourceCommandInput, cb: (err: any, data?: GetOperationsForResourceCommandOutput) => void ): void; - public getOperationsForResource( + getOperationsForResource( args: GetOperationsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOperationsForResourceCommandOutput) => void ): void; - public getOperationsForResource( - args: GetOperationsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOperationsForResourceCommandOutput) => void), - cb?: (err: any, data?: GetOperationsForResourceCommandOutput) => void - ): Promise | void { - const command = new GetOperationsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of all valid regions for Amazon Lightsail. Use the include - * availability zones parameter to also return the Availability Zones in a - * region.

- */ - public getRegions(args: GetRegionsCommandInput, options?: __HttpHandlerOptions): Promise; - public getRegions(args: GetRegionsCommandInput, cb: (err: any, data?: GetRegionsCommandOutput) => void): void; - public getRegions( + + /** + * @see {@link GetRegionsCommand} + */ + getRegions(args: GetRegionsCommandInput, options?: __HttpHandlerOptions): Promise; + getRegions(args: GetRegionsCommandInput, cb: (err: any, data?: GetRegionsCommandOutput) => void): void; + getRegions( args: GetRegionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRegionsCommandOutput) => void ): void; - public getRegions( - args: GetRegionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRegionsCommandOutput) => void), - cb?: (err: any, data?: GetRegionsCommandOutput) => void - ): Promise | void { - const command = new GetRegionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a specific database in Amazon Lightsail.

- */ - public getRelationalDatabase( + + /** + * @see {@link GetRelationalDatabaseCommand} + */ + getRelationalDatabase( args: GetRelationalDatabaseCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRelationalDatabase( + getRelationalDatabase( args: GetRelationalDatabaseCommandInput, cb: (err: any, data?: GetRelationalDatabaseCommandOutput) => void ): void; - public getRelationalDatabase( + getRelationalDatabase( args: GetRelationalDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRelationalDatabaseCommandOutput) => void ): void; - public getRelationalDatabase( - args: GetRelationalDatabaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRelationalDatabaseCommandOutput) => void), - cb?: (err: any, data?: GetRelationalDatabaseCommandOutput) => void - ): Promise | void { - const command = new GetRelationalDatabaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes - * the major engine version of a database.

- *

You can use a blueprint ID to create a new database that runs a specific database - * engine.

- */ - public getRelationalDatabaseBlueprints( + + /** + * @see {@link GetRelationalDatabaseBlueprintsCommand} + */ + getRelationalDatabaseBlueprints( args: GetRelationalDatabaseBlueprintsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRelationalDatabaseBlueprints( + getRelationalDatabaseBlueprints( args: GetRelationalDatabaseBlueprintsCommandInput, cb: (err: any, data?: GetRelationalDatabaseBlueprintsCommandOutput) => void ): void; - public getRelationalDatabaseBlueprints( + getRelationalDatabaseBlueprints( args: GetRelationalDatabaseBlueprintsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRelationalDatabaseBlueprintsCommandOutput) => void ): void; - public getRelationalDatabaseBlueprints( - args: GetRelationalDatabaseBlueprintsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRelationalDatabaseBlueprintsCommandOutput) => void), - cb?: (err: any, data?: GetRelationalDatabaseBlueprintsCommandOutput) => void - ): Promise | void { - const command = new GetRelationalDatabaseBlueprintsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the - * performance specifications for a database.

- *

You can use a bundle ID to create a new database with explicit performance - * specifications.

- */ - public getRelationalDatabaseBundles( + + /** + * @see {@link GetRelationalDatabaseBundlesCommand} + */ + getRelationalDatabaseBundles( args: GetRelationalDatabaseBundlesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRelationalDatabaseBundles( + getRelationalDatabaseBundles( args: GetRelationalDatabaseBundlesCommandInput, cb: (err: any, data?: GetRelationalDatabaseBundlesCommandOutput) => void ): void; - public getRelationalDatabaseBundles( + getRelationalDatabaseBundles( args: GetRelationalDatabaseBundlesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRelationalDatabaseBundlesCommandOutput) => void ): void; - public getRelationalDatabaseBundles( - args: GetRelationalDatabaseBundlesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRelationalDatabaseBundlesCommandOutput) => void), - cb?: (err: any, data?: GetRelationalDatabaseBundlesCommandOutput) => void - ): Promise | void { - const command = new GetRelationalDatabaseBundlesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of events for a specific database in Amazon Lightsail.

- */ - public getRelationalDatabaseEvents( + + /** + * @see {@link GetRelationalDatabaseEventsCommand} + */ + getRelationalDatabaseEvents( args: GetRelationalDatabaseEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRelationalDatabaseEvents( + getRelationalDatabaseEvents( args: GetRelationalDatabaseEventsCommandInput, cb: (err: any, data?: GetRelationalDatabaseEventsCommandOutput) => void ): void; - public getRelationalDatabaseEvents( + getRelationalDatabaseEvents( args: GetRelationalDatabaseEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRelationalDatabaseEventsCommandOutput) => void ): void; - public getRelationalDatabaseEvents( - args: GetRelationalDatabaseEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRelationalDatabaseEventsCommandOutput) => void), - cb?: (err: any, data?: GetRelationalDatabaseEventsCommandOutput) => void - ): Promise | void { - const command = new GetRelationalDatabaseEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of log events for a database in Amazon Lightsail.

- */ - public getRelationalDatabaseLogEvents( + + /** + * @see {@link GetRelationalDatabaseLogEventsCommand} + */ + getRelationalDatabaseLogEvents( args: GetRelationalDatabaseLogEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRelationalDatabaseLogEvents( + getRelationalDatabaseLogEvents( args: GetRelationalDatabaseLogEventsCommandInput, cb: (err: any, data?: GetRelationalDatabaseLogEventsCommandOutput) => void ): void; - public getRelationalDatabaseLogEvents( + getRelationalDatabaseLogEvents( args: GetRelationalDatabaseLogEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRelationalDatabaseLogEventsCommandOutput) => void ): void; - public getRelationalDatabaseLogEvents( - args: GetRelationalDatabaseLogEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRelationalDatabaseLogEventsCommandOutput) => void), - cb?: (err: any, data?: GetRelationalDatabaseLogEventsCommandOutput) => void - ): Promise | void { - const command = new GetRelationalDatabaseLogEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of available log streams for a specific database in Amazon Lightsail.

- */ - public getRelationalDatabaseLogStreams( + + /** + * @see {@link GetRelationalDatabaseLogStreamsCommand} + */ + getRelationalDatabaseLogStreams( args: GetRelationalDatabaseLogStreamsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRelationalDatabaseLogStreams( + getRelationalDatabaseLogStreams( args: GetRelationalDatabaseLogStreamsCommandInput, cb: (err: any, data?: GetRelationalDatabaseLogStreamsCommandOutput) => void ): void; - public getRelationalDatabaseLogStreams( + getRelationalDatabaseLogStreams( args: GetRelationalDatabaseLogStreamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRelationalDatabaseLogStreamsCommandOutput) => void ): void; - public getRelationalDatabaseLogStreams( - args: GetRelationalDatabaseLogStreamsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRelationalDatabaseLogStreamsCommandOutput) => void), - cb?: (err: any, data?: GetRelationalDatabaseLogStreamsCommandOutput) => void - ): Promise | void { - const command = new GetRelationalDatabaseLogStreamsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the current, previous, or pending versions of the master user password for a - * Lightsail database.

- *

The GetRelationalDatabaseMasterUserPassword operation supports tag-based - * access control via resource tags applied to the resource identified by - * relationalDatabaseName.

- */ - public getRelationalDatabaseMasterUserPassword( + + /** + * @see {@link GetRelationalDatabaseMasterUserPasswordCommand} + */ + getRelationalDatabaseMasterUserPassword( args: GetRelationalDatabaseMasterUserPasswordCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRelationalDatabaseMasterUserPassword( + getRelationalDatabaseMasterUserPassword( args: GetRelationalDatabaseMasterUserPasswordCommandInput, cb: (err: any, data?: GetRelationalDatabaseMasterUserPasswordCommandOutput) => void ): void; - public getRelationalDatabaseMasterUserPassword( + getRelationalDatabaseMasterUserPassword( args: GetRelationalDatabaseMasterUserPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRelationalDatabaseMasterUserPasswordCommandOutput) => void ): void; - public getRelationalDatabaseMasterUserPassword( - args: GetRelationalDatabaseMasterUserPasswordCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetRelationalDatabaseMasterUserPasswordCommandOutput) => void), - cb?: (err: any, data?: GetRelationalDatabaseMasterUserPasswordCommandOutput) => void - ): Promise | void { - const command = new GetRelationalDatabaseMasterUserPasswordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the data points of the specified metric for a database in Amazon Lightsail.

- *

Metrics report the utilization of your resources, and the error counts generated by them. - * Monitor and collect metric data regularly to maintain the reliability, availability, and - * performance of your resources.

- */ - public getRelationalDatabaseMetricData( + + /** + * @see {@link GetRelationalDatabaseMetricDataCommand} + */ + getRelationalDatabaseMetricData( args: GetRelationalDatabaseMetricDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRelationalDatabaseMetricData( + getRelationalDatabaseMetricData( args: GetRelationalDatabaseMetricDataCommandInput, cb: (err: any, data?: GetRelationalDatabaseMetricDataCommandOutput) => void ): void; - public getRelationalDatabaseMetricData( + getRelationalDatabaseMetricData( args: GetRelationalDatabaseMetricDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRelationalDatabaseMetricDataCommandOutput) => void ): void; - public getRelationalDatabaseMetricData( - args: GetRelationalDatabaseMetricDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRelationalDatabaseMetricDataCommandOutput) => void), - cb?: (err: any, data?: GetRelationalDatabaseMetricDataCommandOutput) => void - ): Promise | void { - const command = new GetRelationalDatabaseMetricDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns all of the runtime parameters offered by the underlying database software, or - * engine, for a specific database in Amazon Lightsail.

- *

In addition to the parameter names and values, this operation returns other information - * about each parameter. This information includes whether changes require a reboot, whether the - * parameter is modifiable, the allowed values, and the data types.

- */ - public getRelationalDatabaseParameters( + + /** + * @see {@link GetRelationalDatabaseParametersCommand} + */ + getRelationalDatabaseParameters( args: GetRelationalDatabaseParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRelationalDatabaseParameters( + getRelationalDatabaseParameters( args: GetRelationalDatabaseParametersCommandInput, cb: (err: any, data?: GetRelationalDatabaseParametersCommandOutput) => void ): void; - public getRelationalDatabaseParameters( + getRelationalDatabaseParameters( args: GetRelationalDatabaseParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRelationalDatabaseParametersCommandOutput) => void ): void; - public getRelationalDatabaseParameters( - args: GetRelationalDatabaseParametersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRelationalDatabaseParametersCommandOutput) => void), - cb?: (err: any, data?: GetRelationalDatabaseParametersCommandOutput) => void - ): Promise | void { - const command = new GetRelationalDatabaseParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about all of your databases in Amazon Lightsail.

- */ - public getRelationalDatabases( + + /** + * @see {@link GetRelationalDatabasesCommand} + */ + getRelationalDatabases( args: GetRelationalDatabasesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRelationalDatabases( + getRelationalDatabases( args: GetRelationalDatabasesCommandInput, cb: (err: any, data?: GetRelationalDatabasesCommandOutput) => void ): void; - public getRelationalDatabases( + getRelationalDatabases( args: GetRelationalDatabasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRelationalDatabasesCommandOutput) => void ): void; - public getRelationalDatabases( - args: GetRelationalDatabasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRelationalDatabasesCommandOutput) => void), - cb?: (err: any, data?: GetRelationalDatabasesCommandOutput) => void - ): Promise | void { - const command = new GetRelationalDatabasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a specific database snapshot in Amazon Lightsail.

- */ - public getRelationalDatabaseSnapshot( + + /** + * @see {@link GetRelationalDatabaseSnapshotCommand} + */ + getRelationalDatabaseSnapshot( args: GetRelationalDatabaseSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRelationalDatabaseSnapshot( + getRelationalDatabaseSnapshot( args: GetRelationalDatabaseSnapshotCommandInput, cb: (err: any, data?: GetRelationalDatabaseSnapshotCommandOutput) => void ): void; - public getRelationalDatabaseSnapshot( + getRelationalDatabaseSnapshot( args: GetRelationalDatabaseSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRelationalDatabaseSnapshotCommandOutput) => void ): void; - public getRelationalDatabaseSnapshot( - args: GetRelationalDatabaseSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRelationalDatabaseSnapshotCommandOutput) => void), - cb?: (err: any, data?: GetRelationalDatabaseSnapshotCommandOutput) => void - ): Promise | void { - const command = new GetRelationalDatabaseSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about all of your database snapshots in Amazon Lightsail.

- */ - public getRelationalDatabaseSnapshots( + + /** + * @see {@link GetRelationalDatabaseSnapshotsCommand} + */ + getRelationalDatabaseSnapshots( args: GetRelationalDatabaseSnapshotsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRelationalDatabaseSnapshots( + getRelationalDatabaseSnapshots( args: GetRelationalDatabaseSnapshotsCommandInput, cb: (err: any, data?: GetRelationalDatabaseSnapshotsCommandOutput) => void ): void; - public getRelationalDatabaseSnapshots( + getRelationalDatabaseSnapshots( args: GetRelationalDatabaseSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRelationalDatabaseSnapshotsCommandOutput) => void ): void; - public getRelationalDatabaseSnapshots( - args: GetRelationalDatabaseSnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRelationalDatabaseSnapshotsCommandOutput) => void), - cb?: (err: any, data?: GetRelationalDatabaseSnapshotsCommandOutput) => void - ): Promise | void { - const command = new GetRelationalDatabaseSnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about an Amazon Lightsail static IP.

- */ - public getStaticIp(args: GetStaticIpCommandInput, options?: __HttpHandlerOptions): Promise; - public getStaticIp(args: GetStaticIpCommandInput, cb: (err: any, data?: GetStaticIpCommandOutput) => void): void; - public getStaticIp( + + /** + * @see {@link GetStaticIpCommand} + */ + getStaticIp(args: GetStaticIpCommandInput, options?: __HttpHandlerOptions): Promise; + getStaticIp(args: GetStaticIpCommandInput, cb: (err: any, data?: GetStaticIpCommandOutput) => void): void; + getStaticIp( args: GetStaticIpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStaticIpCommandOutput) => void ): void; - public getStaticIp( - args: GetStaticIpCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStaticIpCommandOutput) => void), - cb?: (err: any, data?: GetStaticIpCommandOutput) => void - ): Promise | void { - const command = new GetStaticIpCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about all static IPs in the user's account.

- */ - public getStaticIps( - args: GetStaticIpsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getStaticIps(args: GetStaticIpsCommandInput, cb: (err: any, data?: GetStaticIpsCommandOutput) => void): void; - public getStaticIps( + + /** + * @see {@link GetStaticIpsCommand} + */ + getStaticIps(args: GetStaticIpsCommandInput, options?: __HttpHandlerOptions): Promise; + getStaticIps(args: GetStaticIpsCommandInput, cb: (err: any, data?: GetStaticIpsCommandOutput) => void): void; + getStaticIps( args: GetStaticIpsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStaticIpsCommandOutput) => void ): void; - public getStaticIps( - args: GetStaticIpsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStaticIpsCommandOutput) => void), - cb?: (err: any, data?: GetStaticIpsCommandOutput) => void - ): Promise | void { - const command = new GetStaticIpsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Imports a public SSH key from a specific key pair.

- */ - public importKeyPair( - args: ImportKeyPairCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public importKeyPair( - args: ImportKeyPairCommandInput, - cb: (err: any, data?: ImportKeyPairCommandOutput) => void - ): void; - public importKeyPair( + + /** + * @see {@link ImportKeyPairCommand} + */ + importKeyPair(args: ImportKeyPairCommandInput, options?: __HttpHandlerOptions): Promise; + importKeyPair(args: ImportKeyPairCommandInput, cb: (err: any, data?: ImportKeyPairCommandOutput) => void): void; + importKeyPair( args: ImportKeyPairCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportKeyPairCommandOutput) => void ): void; - public importKeyPair( - args: ImportKeyPairCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportKeyPairCommandOutput) => void), - cb?: (err: any, data?: ImportKeyPairCommandOutput) => void - ): Promise | void { - const command = new ImportKeyPairCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a Boolean value indicating whether your Lightsail VPC is peered.

- */ - public isVpcPeered(args: IsVpcPeeredCommandInput, options?: __HttpHandlerOptions): Promise; - public isVpcPeered(args: IsVpcPeeredCommandInput, cb: (err: any, data?: IsVpcPeeredCommandOutput) => void): void; - public isVpcPeered( + + /** + * @see {@link IsVpcPeeredCommand} + */ + isVpcPeered(args: IsVpcPeeredCommandInput, options?: __HttpHandlerOptions): Promise; + isVpcPeered(args: IsVpcPeeredCommandInput, cb: (err: any, data?: IsVpcPeeredCommandOutput) => void): void; + isVpcPeered( args: IsVpcPeeredCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IsVpcPeeredCommandOutput) => void ): void; - public isVpcPeered( - args: IsVpcPeeredCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: IsVpcPeeredCommandOutput) => void), - cb?: (err: any, data?: IsVpcPeeredCommandOutput) => void - ): Promise | void { - const command = new IsVpcPeeredCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses - * allowed to connect to the instance through the ports, and the protocol.

- *

The OpenInstancePublicPorts action supports tag-based access control via - * resource tags applied to the resource identified by instanceName. For more - * information, see the Amazon Lightsail Developer Guide.

- */ - public openInstancePublicPorts( + + /** + * @see {@link OpenInstancePublicPortsCommand} + */ + openInstancePublicPorts( args: OpenInstancePublicPortsCommandInput, options?: __HttpHandlerOptions ): Promise; - public openInstancePublicPorts( + openInstancePublicPorts( args: OpenInstancePublicPortsCommandInput, cb: (err: any, data?: OpenInstancePublicPortsCommandOutput) => void ): void; - public openInstancePublicPorts( + openInstancePublicPorts( args: OpenInstancePublicPortsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: OpenInstancePublicPortsCommandOutput) => void ): void; - public openInstancePublicPorts( - args: OpenInstancePublicPortsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: OpenInstancePublicPortsCommandOutput) => void), - cb?: (err: any, data?: OpenInstancePublicPortsCommandOutput) => void - ): Promise | void { - const command = new OpenInstancePublicPortsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Peers the Lightsail VPC with the user's default VPC.

- */ - public peerVpc(args: PeerVpcCommandInput, options?: __HttpHandlerOptions): Promise; - public peerVpc(args: PeerVpcCommandInput, cb: (err: any, data?: PeerVpcCommandOutput) => void): void; - public peerVpc( + + /** + * @see {@link PeerVpcCommand} + */ + peerVpc(args: PeerVpcCommandInput, options?: __HttpHandlerOptions): Promise; + peerVpc(args: PeerVpcCommandInput, cb: (err: any, data?: PeerVpcCommandOutput) => void): void; + peerVpc( args: PeerVpcCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PeerVpcCommandOutput) => void ): void; - public peerVpc( - args: PeerVpcCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PeerVpcCommandOutput) => void), - cb?: (err: any, data?: PeerVpcCommandOutput) => void - ): Promise | void { - const command = new PeerVpcCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or updates an alarm, and associates it with the specified metric.

- *

An alarm is used to monitor a single metric for one of your resources. When a metric - * condition is met, the alarm can notify you by email, SMS text message, and a banner displayed - * on the Amazon Lightsail console. For more information, see Alarms - * in Amazon Lightsail.

- *

When this action creates an alarm, the alarm state is immediately set to - * INSUFFICIENT_DATA. The alarm is then evaluated and its state is set - * appropriately. Any actions associated with the new state are then executed.

- *

When you update an existing alarm, its state is left unchanged, but the update completely - * overwrites the previous configuration of the alarm. The alarm is then evaluated with the - * updated configuration.

- */ - public putAlarm(args: PutAlarmCommandInput, options?: __HttpHandlerOptions): Promise; - public putAlarm(args: PutAlarmCommandInput, cb: (err: any, data?: PutAlarmCommandOutput) => void): void; - public putAlarm( + + /** + * @see {@link PutAlarmCommand} + */ + putAlarm(args: PutAlarmCommandInput, options?: __HttpHandlerOptions): Promise; + putAlarm(args: PutAlarmCommandInput, cb: (err: any, data?: PutAlarmCommandOutput) => void): void; + putAlarm( args: PutAlarmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAlarmCommandOutput) => void ): void; - public putAlarm( - args: PutAlarmCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAlarmCommandOutput) => void), - cb?: (err: any, data?: PutAlarmCommandOutput) => void - ): Promise | void { - const command = new PutAlarmCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses - * allowed to connect to the instance through the ports, and the protocol. This action also - * closes all currently open ports that are not included in the request. Include all of the ports - * and the protocols you want to open in your PutInstancePublicPortsrequest. Or use - * the OpenInstancePublicPorts action to open ports without closing currently open - * ports.

- *

The PutInstancePublicPorts action supports tag-based access control via - * resource tags applied to the resource identified by instanceName. For more - * information, see the Amazon Lightsail Developer Guide.

- */ - public putInstancePublicPorts( + + /** + * @see {@link PutInstancePublicPortsCommand} + */ + putInstancePublicPorts( args: PutInstancePublicPortsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putInstancePublicPorts( + putInstancePublicPorts( args: PutInstancePublicPortsCommandInput, cb: (err: any, data?: PutInstancePublicPortsCommandOutput) => void ): void; - public putInstancePublicPorts( + putInstancePublicPorts( args: PutInstancePublicPortsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutInstancePublicPortsCommandOutput) => void ): void; - public putInstancePublicPorts( - args: PutInstancePublicPortsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutInstancePublicPortsCommandOutput) => void), - cb?: (err: any, data?: PutInstancePublicPortsCommandOutput) => void - ): Promise | void { - const command = new PutInstancePublicPortsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Restarts a specific instance.

- *

The reboot instance operation supports tag-based access control via resource - * tags applied to the resource identified by instance name. For more information, - * see the Amazon Lightsail Developer Guide.

- */ - public rebootInstance( + + /** + * @see {@link RebootInstanceCommand} + */ + rebootInstance( args: RebootInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public rebootInstance( - args: RebootInstanceCommandInput, - cb: (err: any, data?: RebootInstanceCommandOutput) => void - ): void; - public rebootInstance( + rebootInstance(args: RebootInstanceCommandInput, cb: (err: any, data?: RebootInstanceCommandOutput) => void): void; + rebootInstance( args: RebootInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebootInstanceCommandOutput) => void ): void; - public rebootInstance( - args: RebootInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RebootInstanceCommandOutput) => void), - cb?: (err: any, data?: RebootInstanceCommandOutput) => void - ): Promise | void { - const command = new RebootInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Restarts a specific database in Amazon Lightsail.

- *

The reboot relational database operation supports tag-based access control - * via resource tags applied to the resource identified by relationalDatabaseName. For more - * information, see the Amazon Lightsail Developer Guide.

- */ - public rebootRelationalDatabase( + + /** + * @see {@link RebootRelationalDatabaseCommand} + */ + rebootRelationalDatabase( args: RebootRelationalDatabaseCommandInput, options?: __HttpHandlerOptions ): Promise; - public rebootRelationalDatabase( + rebootRelationalDatabase( args: RebootRelationalDatabaseCommandInput, cb: (err: any, data?: RebootRelationalDatabaseCommandOutput) => void ): void; - public rebootRelationalDatabase( + rebootRelationalDatabase( args: RebootRelationalDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebootRelationalDatabaseCommandOutput) => void ): void; - public rebootRelationalDatabase( - args: RebootRelationalDatabaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RebootRelationalDatabaseCommandOutput) => void), - cb?: (err: any, data?: RebootRelationalDatabaseCommandOutput) => void - ): Promise | void { - const command = new RebootRelationalDatabaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers a container image to your Amazon Lightsail container service.

- * - *

This action is not required if you install and use the Lightsail Control - * (lightsailctl) plugin to push container images to your Lightsail container service. For - * more information, see Pushing and managing container images on your Amazon Lightsail container services - * in the Amazon Lightsail Developer Guide.

- *
- */ - public registerContainerImage( + + /** + * @see {@link RegisterContainerImageCommand} + */ + registerContainerImage( args: RegisterContainerImageCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerContainerImage( + registerContainerImage( args: RegisterContainerImageCommandInput, cb: (err: any, data?: RegisterContainerImageCommandOutput) => void ): void; - public registerContainerImage( + registerContainerImage( args: RegisterContainerImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterContainerImageCommandOutput) => void ): void; - public registerContainerImage( - args: RegisterContainerImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterContainerImageCommandOutput) => void), - cb?: (err: any, data?: RegisterContainerImageCommandOutput) => void - ): Promise | void { - const command = new RegisterContainerImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specific static IP from your account.

- */ - public releaseStaticIp( + + /** + * @see {@link ReleaseStaticIpCommand} + */ + releaseStaticIp( args: ReleaseStaticIpCommandInput, options?: __HttpHandlerOptions ): Promise; - public releaseStaticIp( - args: ReleaseStaticIpCommandInput, - cb: (err: any, data?: ReleaseStaticIpCommandOutput) => void - ): void; - public releaseStaticIp( + releaseStaticIp(args: ReleaseStaticIpCommandInput, cb: (err: any, data?: ReleaseStaticIpCommandOutput) => void): void; + releaseStaticIp( args: ReleaseStaticIpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReleaseStaticIpCommandOutput) => void ): void; - public releaseStaticIp( - args: ReleaseStaticIpCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReleaseStaticIpCommandOutput) => void), - cb?: (err: any, data?: ReleaseStaticIpCommandOutput) => void - ): Promise | void { - const command = new ReleaseStaticIpCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) - * distribution.

- *

After resetting the cache, the next time a content request is made, your distribution - * pulls, serves, and caches it from the origin.

- */ - public resetDistributionCache( + + /** + * @see {@link ResetDistributionCacheCommand} + */ + resetDistributionCache( args: ResetDistributionCacheCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetDistributionCache( + resetDistributionCache( args: ResetDistributionCacheCommandInput, cb: (err: any, data?: ResetDistributionCacheCommandOutput) => void ): void; - public resetDistributionCache( + resetDistributionCache( args: ResetDistributionCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetDistributionCacheCommandOutput) => void ): void; - public resetDistributionCache( - args: ResetDistributionCacheCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetDistributionCacheCommandOutput) => void), - cb?: (err: any, data?: ResetDistributionCacheCommandOutput) => void - ): Promise | void { - const command = new ResetDistributionCacheCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sends a verification request to an email contact method to ensure it's owned by the - * requester. SMS contact methods don't need to be verified.

- *

A contact method is used to send you notifications about your Amazon Lightsail resources. - * You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services - * Regions, and SMS text messages cannot be sent to some countries/regions. For more information, - * see Notifications in Amazon Lightsail.

- *

A verification request is sent to the contact method when you initially create it. Use - * this action to send another verification request if a previous verification request was - * deleted, or has expired.

- * - *

Notifications are not sent to an email contact method until after it is verified, and - * confirmed as valid.

- *
- */ - public sendContactMethodVerification( + + /** + * @see {@link SendContactMethodVerificationCommand} + */ + sendContactMethodVerification( args: SendContactMethodVerificationCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendContactMethodVerification( + sendContactMethodVerification( args: SendContactMethodVerificationCommandInput, cb: (err: any, data?: SendContactMethodVerificationCommandOutput) => void ): void; - public sendContactMethodVerification( + sendContactMethodVerification( args: SendContactMethodVerificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendContactMethodVerificationCommandOutput) => void ): void; - public sendContactMethodVerification( - args: SendContactMethodVerificationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendContactMethodVerificationCommandOutput) => void), - cb?: (err: any, data?: SendContactMethodVerificationCommandOutput) => void - ): Promise | void { - const command = new SendContactMethodVerificationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the IP address type for an Amazon Lightsail resource.

- *

Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the - * specified resource. Alternately, you can use this action to disable dual-stack, and enable - * IPv4 only.

- */ - public setIpAddressType( + + /** + * @see {@link SetIpAddressTypeCommand} + */ + setIpAddressType( args: SetIpAddressTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public setIpAddressType( + setIpAddressType( args: SetIpAddressTypeCommandInput, cb: (err: any, data?: SetIpAddressTypeCommandOutput) => void ): void; - public setIpAddressType( + setIpAddressType( args: SetIpAddressTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetIpAddressTypeCommandOutput) => void ): void; - public setIpAddressType( - args: SetIpAddressTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetIpAddressTypeCommandOutput) => void), - cb?: (err: any, data?: SetIpAddressTypeCommandOutput) => void - ): Promise | void { - const command = new SetIpAddressTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the Amazon Lightsail resources that can access the specified Lightsail - * bucket.

- *

Lightsail buckets currently support setting access for Lightsail instances in the same - * Amazon Web Services Region.

- */ - public setResourceAccessForBucket( + + /** + * @see {@link SetResourceAccessForBucketCommand} + */ + setResourceAccessForBucket( args: SetResourceAccessForBucketCommandInput, options?: __HttpHandlerOptions ): Promise; - public setResourceAccessForBucket( + setResourceAccessForBucket( args: SetResourceAccessForBucketCommandInput, cb: (err: any, data?: SetResourceAccessForBucketCommandOutput) => void ): void; - public setResourceAccessForBucket( + setResourceAccessForBucket( args: SetResourceAccessForBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetResourceAccessForBucketCommandOutput) => void ): void; - public setResourceAccessForBucket( - args: SetResourceAccessForBucketCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetResourceAccessForBucketCommandOutput) => void), - cb?: (err: any, data?: SetResourceAccessForBucketCommandOutput) => void - ): Promise | void { - const command = new SetResourceAccessForBucketCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Initiates a graphical user interface (GUI) session that’s used to access a virtual - * computer’s operating system and application. The session will be active for 1 hour. Use this action to resume the session after it expires.

- */ - public startGUISession( + + /** + * @see {@link StartGUISessionCommand} + */ + startGUISession( args: StartGUISessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startGUISession( - args: StartGUISessionCommandInput, - cb: (err: any, data?: StartGUISessionCommandOutput) => void - ): void; - public startGUISession( + startGUISession(args: StartGUISessionCommandInput, cb: (err: any, data?: StartGUISessionCommandOutput) => void): void; + startGUISession( args: StartGUISessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartGUISessionCommandOutput) => void ): void; - public startGUISession( - args: StartGUISessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartGUISessionCommandOutput) => void), - cb?: (err: any, data?: StartGUISessionCommandOutput) => void - ): Promise | void { - const command = new StartGUISessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, - * use the reboot instance operation.

- * - *

When you start a stopped instance, Lightsail assigns a new public IP address to the - * instance. To use the same IP address after stopping and starting an instance, create a - * static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.

- *
- *

The start instance operation supports tag-based access control via resource - * tags applied to the resource identified by instance name. For more information, - * see the Amazon Lightsail Developer Guide.

- */ - public startInstance( - args: StartInstanceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public startInstance( - args: StartInstanceCommandInput, - cb: (err: any, data?: StartInstanceCommandOutput) => void - ): void; - public startInstance( + + /** + * @see {@link StartInstanceCommand} + */ + startInstance(args: StartInstanceCommandInput, options?: __HttpHandlerOptions): Promise; + startInstance(args: StartInstanceCommandInput, cb: (err: any, data?: StartInstanceCommandOutput) => void): void; + startInstance( args: StartInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartInstanceCommandOutput) => void ): void; - public startInstance( - args: StartInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartInstanceCommandOutput) => void), - cb?: (err: any, data?: StartInstanceCommandOutput) => void - ): Promise | void { - const command = new StartInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, - * use the reboot relational database operation.

- *

The start relational database operation supports tag-based access control via - * resource tags applied to the resource identified by relationalDatabaseName. For more - * information, see the Amazon Lightsail Developer Guide.

- */ - public startRelationalDatabase( + + /** + * @see {@link StartRelationalDatabaseCommand} + */ + startRelationalDatabase( args: StartRelationalDatabaseCommandInput, options?: __HttpHandlerOptions ): Promise; - public startRelationalDatabase( + startRelationalDatabase( args: StartRelationalDatabaseCommandInput, cb: (err: any, data?: StartRelationalDatabaseCommandOutput) => void ): void; - public startRelationalDatabase( + startRelationalDatabase( args: StartRelationalDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartRelationalDatabaseCommandOutput) => void ): void; - public startRelationalDatabase( - args: StartRelationalDatabaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartRelationalDatabaseCommandOutput) => void), - cb?: (err: any, data?: StartRelationalDatabaseCommandOutput) => void - ): Promise | void { - const command = new StartRelationalDatabaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Terminates a web-based NICE DCV session that’s used to access a virtual computer’s - * operating system or application. The session will close and any unsaved data will be lost.

- */ - public stopGUISession( + + /** + * @see {@link StopGUISessionCommand} + */ + stopGUISession( args: StopGUISessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopGUISession( - args: StopGUISessionCommandInput, - cb: (err: any, data?: StopGUISessionCommandOutput) => void - ): void; - public stopGUISession( + stopGUISession(args: StopGUISessionCommandInput, cb: (err: any, data?: StopGUISessionCommandOutput) => void): void; + stopGUISession( args: StopGUISessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopGUISessionCommandOutput) => void ): void; - public stopGUISession( - args: StopGUISessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopGUISessionCommandOutput) => void), - cb?: (err: any, data?: StopGUISessionCommandOutput) => void - ): Promise | void { - const command = new StopGUISessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a specific Amazon Lightsail instance that is currently running.

- * - *

When you start a stopped instance, Lightsail assigns a new public IP address to the - * instance. To use the same IP address after stopping and starting an instance, create a - * static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.

- *
- *

The stop instance operation supports tag-based access control via resource - * tags applied to the resource identified by instance name. For more information, - * see the Amazon Lightsail Developer Guide.

- */ - public stopInstance( - args: StopInstanceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public stopInstance(args: StopInstanceCommandInput, cb: (err: any, data?: StopInstanceCommandOutput) => void): void; - public stopInstance( + + /** + * @see {@link StopInstanceCommand} + */ + stopInstance(args: StopInstanceCommandInput, options?: __HttpHandlerOptions): Promise; + stopInstance(args: StopInstanceCommandInput, cb: (err: any, data?: StopInstanceCommandOutput) => void): void; + stopInstance( args: StopInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopInstanceCommandOutput) => void ): void; - public stopInstance( - args: StopInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopInstanceCommandOutput) => void), - cb?: (err: any, data?: StopInstanceCommandOutput) => void - ): Promise | void { - const command = new StopInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a specific database that is currently running in Amazon Lightsail.

- *

The stop relational database operation supports tag-based access control via - * resource tags applied to the resource identified by relationalDatabaseName. For more - * information, see the Amazon Lightsail Developer Guide.

- */ - public stopRelationalDatabase( + + /** + * @see {@link StopRelationalDatabaseCommand} + */ + stopRelationalDatabase( args: StopRelationalDatabaseCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopRelationalDatabase( + stopRelationalDatabase( args: StopRelationalDatabaseCommandInput, cb: (err: any, data?: StopRelationalDatabaseCommandOutput) => void ): void; - public stopRelationalDatabase( + stopRelationalDatabase( args: StopRelationalDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopRelationalDatabaseCommandOutput) => void ): void; - public stopRelationalDatabase( - args: StopRelationalDatabaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopRelationalDatabaseCommandOutput) => void), - cb?: (err: any, data?: StopRelationalDatabaseCommandOutput) => void - ): Promise | void { - const command = new StopRelationalDatabaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a - * maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique - * per resource. For more information about tags, see the Amazon Lightsail Developer Guide.

- *

The tag resource operation supports tag-based access control via request tags - * and resource tags applied to the resource identified by resource name. For more - * information, see the Amazon Lightsail Developer Guide.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification - * trigger is configured for the specified alarm, the test also sends a notification to the - * notification protocol (Email and/or SMS) configured for the - * alarm.

- *

An alarm is used to monitor a single metric for one of your resources. When a metric - * condition is met, the alarm can notify you by email, SMS text message, and a banner displayed - * on the Amazon Lightsail console. For more information, see Alarms - * in Amazon Lightsail.

- */ - public testAlarm(args: TestAlarmCommandInput, options?: __HttpHandlerOptions): Promise; - public testAlarm(args: TestAlarmCommandInput, cb: (err: any, data?: TestAlarmCommandOutput) => void): void; - public testAlarm( + + /** + * @see {@link TestAlarmCommand} + */ + testAlarm(args: TestAlarmCommandInput, options?: __HttpHandlerOptions): Promise; + testAlarm(args: TestAlarmCommandInput, cb: (err: any, data?: TestAlarmCommandOutput) => void): void; + testAlarm( args: TestAlarmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestAlarmCommandOutput) => void ): void; - public testAlarm( - args: TestAlarmCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestAlarmCommandOutput) => void), - cb?: (err: any, data?: TestAlarmCommandOutput) => void - ): Promise | void { - const command = new TestAlarmCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Unpeers the Lightsail VPC from the user's default VPC.

- */ - public unpeerVpc(args: UnpeerVpcCommandInput, options?: __HttpHandlerOptions): Promise; - public unpeerVpc(args: UnpeerVpcCommandInput, cb: (err: any, data?: UnpeerVpcCommandOutput) => void): void; - public unpeerVpc( + + /** + * @see {@link UnpeerVpcCommand} + */ + unpeerVpc(args: UnpeerVpcCommandInput, options?: __HttpHandlerOptions): Promise; + unpeerVpc(args: UnpeerVpcCommandInput, cb: (err: any, data?: UnpeerVpcCommandOutput) => void): void; + unpeerVpc( args: UnpeerVpcCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnpeerVpcCommandOutput) => void ): void; - public unpeerVpc( - args: UnpeerVpcCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnpeerVpcCommandOutput) => void), - cb?: (err: any, data?: UnpeerVpcCommandOutput) => void - ): Promise | void { - const command = new UnpeerVpcCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified set of tag keys and their values from the specified Amazon Lightsail - * resource.

- *

The untag resource operation supports tag-based access control via request - * tags and resource tags applied to the resource identified by resource name. For - * more information, see the Amazon Lightsail Developer Guide.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing Amazon Lightsail bucket.

- *

Use this action to update the configuration of an existing bucket, such as versioning, - * public accessibility, and the Amazon Web Services accounts that can access the bucket.

- */ - public updateBucket( - args: UpdateBucketCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateBucket(args: UpdateBucketCommandInput, cb: (err: any, data?: UpdateBucketCommandOutput) => void): void; - public updateBucket( + + /** + * @see {@link UpdateBucketCommand} + */ + updateBucket(args: UpdateBucketCommandInput, options?: __HttpHandlerOptions): Promise; + updateBucket(args: UpdateBucketCommandInput, cb: (err: any, data?: UpdateBucketCommandOutput) => void): void; + updateBucket( args: UpdateBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBucketCommandOutput) => void ): void; - public updateBucket( - args: UpdateBucketCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBucketCommandOutput) => void), - cb?: (err: any, data?: UpdateBucketCommandOutput) => void - ): Promise | void { - const command = new UpdateBucketCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.

- *

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a - * bucket. You can update a bucket's bundle only one time within a monthly Amazon Web Services - * billing cycle. To determine if you can update a bucket's bundle, use the GetBuckets action. The - * ableToUpdateBundle parameter in the response will indicate whether you can - * currently update a bucket's bundle.

- *

Update a bucket's bundle if it's consistently going over its storage space or data - * transfer quota, or if a bucket's usage is consistently in the lower range of its storage space - * or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might - * experience, we strongly recommend that you update a bucket's bundle only as a long-term - * strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle - * that will provide the bucket with ample storage space and data transfer for a long time to - * come.

- */ - public updateBucketBundle( + + /** + * @see {@link UpdateBucketBundleCommand} + */ + updateBucketBundle( args: UpdateBucketBundleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBucketBundle( + updateBucketBundle( args: UpdateBucketBundleCommandInput, cb: (err: any, data?: UpdateBucketBundleCommandOutput) => void ): void; - public updateBucketBundle( + updateBucketBundle( args: UpdateBucketBundleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBucketBundleCommandOutput) => void ): void; - public updateBucketBundle( - args: UpdateBucketBundleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBucketBundleCommandOutput) => void), - cb?: (err: any, data?: UpdateBucketBundleCommandOutput) => void - ): Promise | void { - const command = new UpdateBucketBundleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the configuration of your Amazon Lightsail container service, such as its power, - * scale, and public domain names.

- */ - public updateContainerService( + + /** + * @see {@link UpdateContainerServiceCommand} + */ + updateContainerService( args: UpdateContainerServiceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateContainerService( + updateContainerService( args: UpdateContainerServiceCommandInput, cb: (err: any, data?: UpdateContainerServiceCommandOutput) => void ): void; - public updateContainerService( + updateContainerService( args: UpdateContainerServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContainerServiceCommandOutput) => void ): void; - public updateContainerService( - args: UpdateContainerServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateContainerServiceCommandOutput) => void), - cb?: (err: any, data?: UpdateContainerServiceCommandOutput) => void - ): Promise | void { - const command = new UpdateContainerServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing Amazon Lightsail content delivery network (CDN) distribution.

- *

Use this action to update the configuration of your existing distribution.

- */ - public updateDistribution( + + /** + * @see {@link UpdateDistributionCommand} + */ + updateDistribution( args: UpdateDistributionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDistribution( + updateDistribution( args: UpdateDistributionCommandInput, cb: (err: any, data?: UpdateDistributionCommandOutput) => void ): void; - public updateDistribution( + updateDistribution( args: UpdateDistributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDistributionCommandOutput) => void ): void; - public updateDistribution( - args: UpdateDistributionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDistributionCommandOutput) => void), - cb?: (err: any, data?: UpdateDistributionCommandOutput) => void - ): Promise | void { - const command = new UpdateDistributionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the bundle of your Amazon Lightsail content delivery network (CDN) - * distribution.

- *

A distribution bundle specifies the monthly network transfer quota and monthly cost of - * your distribution.

- *

Update your distribution's bundle if your distribution is going over its monthly network - * transfer quota and is incurring an overage fee.

- *

You can update your distribution's bundle only one time within your monthly Amazon Web Services billing cycle. To determine if you can update your distribution's bundle, use the - * GetDistributions action. The ableToUpdateBundle parameter in the - * result will indicate whether you can currently update your distribution's bundle.

- */ - public updateDistributionBundle( + + /** + * @see {@link UpdateDistributionBundleCommand} + */ + updateDistributionBundle( args: UpdateDistributionBundleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDistributionBundle( + updateDistributionBundle( args: UpdateDistributionBundleCommandInput, cb: (err: any, data?: UpdateDistributionBundleCommandOutput) => void ): void; - public updateDistributionBundle( + updateDistributionBundle( args: UpdateDistributionBundleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDistributionBundleCommandOutput) => void ): void; - public updateDistributionBundle( - args: UpdateDistributionBundleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDistributionBundleCommandOutput) => void), - cb?: (err: any, data?: UpdateDistributionBundleCommandOutput) => void - ): Promise | void { - const command = new UpdateDistributionBundleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a domain recordset after it is created.

- *

The update domain entry operation supports tag-based access control via - * resource tags applied to the resource identified by domain name. For more - * information, see the Amazon Lightsail Developer Guide.

- */ - public updateDomainEntry( + + /** + * @see {@link UpdateDomainEntryCommand} + */ + updateDomainEntry( args: UpdateDomainEntryCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDomainEntry( + updateDomainEntry( args: UpdateDomainEntryCommandInput, cb: (err: any, data?: UpdateDomainEntryCommandOutput) => void ): void; - public updateDomainEntry( + updateDomainEntry( args: UpdateDomainEntryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDomainEntryCommandOutput) => void ): void; - public updateDomainEntry( - args: UpdateDomainEntryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDomainEntryCommandOutput) => void), - cb?: (err: any, data?: UpdateDomainEntryCommandOutput) => void - ): Promise | void { - const command = new UpdateDomainEntryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the Amazon Lightsail instance metadata parameters on a running or stopped - * instance. When you modify the parameters on a running instance, the GetInstance - * or GetInstances API operation initially responds with a state of - * pending. After the parameter modifications are successfully applied, the state - * changes to applied in subsequent GetInstance or - * GetInstances API calls. For more information, see Use IMDSv2 with an Amazon Lightsail instance in the Amazon Lightsail Developer Guide.

- */ - public updateInstanceMetadataOptions( + + /** + * @see {@link UpdateInstanceMetadataOptionsCommand} + */ + updateInstanceMetadataOptions( args: UpdateInstanceMetadataOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateInstanceMetadataOptions( + updateInstanceMetadataOptions( args: UpdateInstanceMetadataOptionsCommandInput, cb: (err: any, data?: UpdateInstanceMetadataOptionsCommandOutput) => void ): void; - public updateInstanceMetadataOptions( + updateInstanceMetadataOptions( args: UpdateInstanceMetadataOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateInstanceMetadataOptionsCommandOutput) => void ): void; - public updateInstanceMetadataOptions( - args: UpdateInstanceMetadataOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateInstanceMetadataOptionsCommandOutput) => void), - cb?: (err: any, data?: UpdateInstanceMetadataOptionsCommandOutput) => void - ): Promise | void { - const command = new UpdateInstanceMetadataOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the specified attribute for a load balancer. You can only update one attribute at - * a time.

- *

The update load balancer attribute operation supports tag-based access - * control via resource tags applied to the resource identified by load balancer - * name. For more information, see the Amazon Lightsail Developer Guide.

- */ - public updateLoadBalancerAttribute( + + /** + * @see {@link UpdateLoadBalancerAttributeCommand} + */ + updateLoadBalancerAttribute( args: UpdateLoadBalancerAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLoadBalancerAttribute( + updateLoadBalancerAttribute( args: UpdateLoadBalancerAttributeCommandInput, cb: (err: any, data?: UpdateLoadBalancerAttributeCommandOutput) => void ): void; - public updateLoadBalancerAttribute( + updateLoadBalancerAttribute( args: UpdateLoadBalancerAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLoadBalancerAttributeCommandOutput) => void ): void; - public updateLoadBalancerAttribute( - args: UpdateLoadBalancerAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLoadBalancerAttributeCommandOutput) => void), - cb?: (err: any, data?: UpdateLoadBalancerAttributeCommandOutput) => void - ): Promise | void { - const command = new UpdateLoadBalancerAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Allows the update of one or more attributes of a database in Amazon Lightsail.

- *

Updates are applied immediately, or in cases where the updates could result in an outage, - * are applied during the database's predefined maintenance window.

- *

The update relational database operation supports tag-based access control - * via resource tags applied to the resource identified by relationalDatabaseName. For more - * information, see the Amazon Lightsail Developer Guide.

- */ - public updateRelationalDatabase( + + /** + * @see {@link UpdateRelationalDatabaseCommand} + */ + updateRelationalDatabase( args: UpdateRelationalDatabaseCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRelationalDatabase( + updateRelationalDatabase( args: UpdateRelationalDatabaseCommandInput, cb: (err: any, data?: UpdateRelationalDatabaseCommandOutput) => void ): void; - public updateRelationalDatabase( + updateRelationalDatabase( args: UpdateRelationalDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRelationalDatabaseCommandOutput) => void ): void; - public updateRelationalDatabase( - args: UpdateRelationalDatabaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRelationalDatabaseCommandOutput) => void), - cb?: (err: any, data?: UpdateRelationalDatabaseCommandOutput) => void - ): Promise | void { - const command = new UpdateRelationalDatabaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Allows the update of one or more parameters of a database in Amazon Lightsail.

- *

Parameter updates don't cause outages; therefore, their application is not subject to the - * preferred maintenance window. However, there are two ways in which parameter updates are - * applied: dynamic or pending-reboot. Parameters marked with a - * dynamic apply type are applied immediately. Parameters marked with a - * pending-reboot apply type are applied only after the database is rebooted using - * the reboot relational database operation.

- *

The update relational database parameters operation supports tag-based access - * control via resource tags applied to the resource identified by relationalDatabaseName. For - * more information, see the Amazon Lightsail Developer Guide.

- */ - public updateRelationalDatabaseParameters( + + /** + * @see {@link UpdateRelationalDatabaseParametersCommand} + */ + updateRelationalDatabaseParameters( args: UpdateRelationalDatabaseParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRelationalDatabaseParameters( + updateRelationalDatabaseParameters( args: UpdateRelationalDatabaseParametersCommandInput, cb: (err: any, data?: UpdateRelationalDatabaseParametersCommandOutput) => void ): void; - public updateRelationalDatabaseParameters( + updateRelationalDatabaseParameters( args: UpdateRelationalDatabaseParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRelationalDatabaseParametersCommandOutput) => void ): void; - public updateRelationalDatabaseParameters( - args: UpdateRelationalDatabaseParametersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRelationalDatabaseParametersCommandOutput) => void), - cb?: (err: any, data?: UpdateRelationalDatabaseParametersCommandOutput) => void - ): Promise | void { - const command = new UpdateRelationalDatabaseParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes + * everything you need to launch your project quickly - instances (virtual private servers), + * container services, storage buckets, managed databases, SSD-based block storage, static IP + * addresses, load balancers, content delivery network (CDN) distributions, DNS management of + * registered domains, and resource snapshots (backups) - for a low, predictable monthly + * price.

+ *

You can manage your Lightsail resources using the Lightsail console, Lightsail API, + * Command Line Interface (CLI), or SDKs. For more information about Lightsail + * concepts and tasks, see the Amazon Lightsail Developer Guide.

+ *

This API Reference provides detailed information about the actions, data types, + * parameters, and errors of the Lightsail service. For more information about the supported + * Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see + * Amazon Lightsail Endpoints + * and Quotas in the Amazon Web Services General Reference.

+ */ +export class Lightsail extends LightsailClient implements Lightsail {} +createAggregatedClient(commands, Lightsail); diff --git a/clients/client-location/src/Location.ts b/clients/client-location/src/Location.ts index 1997b09d46e5..d57fc26c662b 100644 --- a/clients/client-location/src/Location.ts +++ b/clients/client-location/src/Location.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -231,2096 +232,916 @@ import { UpdateTrackerCommandInput, UpdateTrackerCommandOutput, } from "./commands/UpdateTrackerCommand"; -import { LocationClient } from "./LocationClient"; +import { LocationClient, LocationClientConfig } from "./LocationClient"; -/** - * @public - *

"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"

- */ -export class Location extends LocationClient { +const commands = { + AssociateTrackerConsumerCommand, + BatchDeleteDevicePositionHistoryCommand, + BatchDeleteGeofenceCommand, + BatchEvaluateGeofencesCommand, + BatchGetDevicePositionCommand, + BatchPutGeofenceCommand, + BatchUpdateDevicePositionCommand, + CalculateRouteCommand, + CalculateRouteMatrixCommand, + CreateGeofenceCollectionCommand, + CreateKeyCommand, + CreateMapCommand, + CreatePlaceIndexCommand, + CreateRouteCalculatorCommand, + CreateTrackerCommand, + DeleteGeofenceCollectionCommand, + DeleteKeyCommand, + DeleteMapCommand, + DeletePlaceIndexCommand, + DeleteRouteCalculatorCommand, + DeleteTrackerCommand, + DescribeGeofenceCollectionCommand, + DescribeKeyCommand, + DescribeMapCommand, + DescribePlaceIndexCommand, + DescribeRouteCalculatorCommand, + DescribeTrackerCommand, + DisassociateTrackerConsumerCommand, + GetDevicePositionCommand, + GetDevicePositionHistoryCommand, + GetGeofenceCommand, + GetMapGlyphsCommand, + GetMapSpritesCommand, + GetMapStyleDescriptorCommand, + GetMapTileCommand, + GetPlaceCommand, + ListDevicePositionsCommand, + ListGeofenceCollectionsCommand, + ListGeofencesCommand, + ListKeysCommand, + ListMapsCommand, + ListPlaceIndexesCommand, + ListRouteCalculatorsCommand, + ListTagsForResourceCommand, + ListTrackerConsumersCommand, + ListTrackersCommand, + PutGeofenceCommand, + SearchPlaceIndexForPositionCommand, + SearchPlaceIndexForSuggestionsCommand, + SearchPlaceIndexForTextCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateGeofenceCollectionCommand, + UpdateKeyCommand, + UpdateMapCommand, + UpdatePlaceIndexCommand, + UpdateRouteCalculatorCommand, + UpdateTrackerCommand, +}; + +export interface Location { /** - * @public - *

Creates an association between a geofence collection and a tracker resource. This - * allows the tracker resource to communicate location data to the linked geofence - * collection.

- *

You can associate up to five geofence collections to each tracker resource.

- * - *

Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.

- *
+ * @see {@link AssociateTrackerConsumerCommand} */ - public associateTrackerConsumer( + associateTrackerConsumer( args: AssociateTrackerConsumerCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateTrackerConsumer( + associateTrackerConsumer( args: AssociateTrackerConsumerCommandInput, cb: (err: any, data?: AssociateTrackerConsumerCommandOutput) => void ): void; - public associateTrackerConsumer( + associateTrackerConsumer( args: AssociateTrackerConsumerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateTrackerConsumerCommandOutput) => void ): void; - public associateTrackerConsumer( - args: AssociateTrackerConsumerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateTrackerConsumerCommandOutput) => void), - cb?: (err: any, data?: AssociateTrackerConsumerCommandOutput) => void - ): Promise | void { - const command = new AssociateTrackerConsumerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the position history of one or more devices from a tracker resource.

+ * @see {@link BatchDeleteDevicePositionHistoryCommand} */ - public batchDeleteDevicePositionHistory( + batchDeleteDevicePositionHistory( args: BatchDeleteDevicePositionHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeleteDevicePositionHistory( + batchDeleteDevicePositionHistory( args: BatchDeleteDevicePositionHistoryCommandInput, cb: (err: any, data?: BatchDeleteDevicePositionHistoryCommandOutput) => void ): void; - public batchDeleteDevicePositionHistory( + batchDeleteDevicePositionHistory( args: BatchDeleteDevicePositionHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteDevicePositionHistoryCommandOutput) => void ): void; - public batchDeleteDevicePositionHistory( - args: BatchDeleteDevicePositionHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeleteDevicePositionHistoryCommandOutput) => void), - cb?: (err: any, data?: BatchDeleteDevicePositionHistoryCommandOutput) => void - ): Promise | void { - const command = new BatchDeleteDevicePositionHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a batch of geofences from a geofence collection.

- * - *

This operation deletes the resource permanently.

- *
+ * @see {@link BatchDeleteGeofenceCommand} */ - public batchDeleteGeofence( + batchDeleteGeofence( args: BatchDeleteGeofenceCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeleteGeofence( + batchDeleteGeofence( args: BatchDeleteGeofenceCommandInput, cb: (err: any, data?: BatchDeleteGeofenceCommandOutput) => void ): void; - public batchDeleteGeofence( + batchDeleteGeofence( args: BatchDeleteGeofenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteGeofenceCommandOutput) => void ): void; - public batchDeleteGeofence( - args: BatchDeleteGeofenceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeleteGeofenceCommandOutput) => void), - cb?: (err: any, data?: BatchDeleteGeofenceCommandOutput) => void - ): Promise | void { - const command = new BatchDeleteGeofenceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Evaluates device positions against the geofence geometries from a given geofence - * collection.

- *

This operation always returns an empty response because geofences are asynchronously - * evaluated. The evaluation determines if the device has entered or exited a geofenced - * area, and then publishes one of the following events to Amazon EventBridge:

- *
    - *
  • - *

    - * ENTER if Amazon Location determines that the tracked device has entered - * a geofenced area.

    - *
  • - *
  • - *

    - * EXIT if Amazon Location determines that the tracked device has exited a - * geofenced area.

    - *
  • - *
- * - *

The last geofence that a device was observed within is tracked for 30 days after - * the most recent device position update.

- *
- * - *

Geofence evaluation uses the given device position. It does not account for the - * optional Accuracy of a DevicePositionUpdate.

- *
- * - *

The DeviceID is used as a string to represent the device. You do not - * need to have a Tracker associated with the DeviceID.

- *
+ * @see {@link BatchEvaluateGeofencesCommand} */ - public batchEvaluateGeofences( + batchEvaluateGeofences( args: BatchEvaluateGeofencesCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchEvaluateGeofences( + batchEvaluateGeofences( args: BatchEvaluateGeofencesCommandInput, cb: (err: any, data?: BatchEvaluateGeofencesCommandOutput) => void ): void; - public batchEvaluateGeofences( + batchEvaluateGeofences( args: BatchEvaluateGeofencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchEvaluateGeofencesCommandOutput) => void ): void; - public batchEvaluateGeofences( - args: BatchEvaluateGeofencesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchEvaluateGeofencesCommandOutput) => void), - cb?: (err: any, data?: BatchEvaluateGeofencesCommandOutput) => void - ): Promise | void { - const command = new BatchEvaluateGeofencesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the latest device positions for requested devices.

+ * @see {@link BatchGetDevicePositionCommand} */ - public batchGetDevicePosition( + batchGetDevicePosition( args: BatchGetDevicePositionCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetDevicePosition( + batchGetDevicePosition( args: BatchGetDevicePositionCommandInput, cb: (err: any, data?: BatchGetDevicePositionCommandOutput) => void ): void; - public batchGetDevicePosition( + batchGetDevicePosition( args: BatchGetDevicePositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetDevicePositionCommandOutput) => void ): void; - public batchGetDevicePosition( - args: BatchGetDevicePositionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetDevicePositionCommandOutput) => void), - cb?: (err: any, data?: BatchGetDevicePositionCommandOutput) => void - ): Promise | void { - const command = new BatchGetDevicePositionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A batch request for storing geofence geometries into a given geofence collection, or - * updates the geometry of an existing geofence if a geofence ID is included in the request.

+ * @see {@link BatchPutGeofenceCommand} */ - public batchPutGeofence( + batchPutGeofence( args: BatchPutGeofenceCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchPutGeofence( + batchPutGeofence( args: BatchPutGeofenceCommandInput, cb: (err: any, data?: BatchPutGeofenceCommandOutput) => void ): void; - public batchPutGeofence( + batchPutGeofence( args: BatchPutGeofenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchPutGeofenceCommandOutput) => void ): void; - public batchPutGeofence( - args: BatchPutGeofenceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchPutGeofenceCommandOutput) => void), - cb?: (err: any, data?: BatchPutGeofenceCommandOutput) => void - ): Promise | void { - const command = new BatchPutGeofenceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Uploads position update data for one or more devices to a tracker resource. Amazon Location - * uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30 - * days.

- * - *

Position updates are handled based on the PositionFiltering property of the tracker. - * When PositionFiltering is set to TimeBased, updates are evaluated against linked geofence collections, - * and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than - * every 30 seconds, only one update per 30 seconds is stored for each unique device ID.

- *

When PositionFiltering is set to DistanceBased filtering, location data is stored and evaluated against linked geofence - * collections only if the device has moved more than 30 m (98.4 ft).

- *

When PositionFiltering is set to AccuracyBased filtering, - * location data is stored and evaluated against linked geofence collections only if the - * device has moved more than the measured accuracy. For example, if two consecutive - * updates from a device have a horizontal accuracy of 5 m and 10 m, the second update - * is neither stored or evaluated if the device has moved less than 15 m. If - * PositionFiltering is set to AccuracyBased filtering, Amazon Location - * uses the default value \{ "Horizontal": 0\} when accuracy is not provided on - * a DevicePositionUpdate.

- *
+ * @see {@link BatchUpdateDevicePositionCommand} */ - public batchUpdateDevicePosition( + batchUpdateDevicePosition( args: BatchUpdateDevicePositionCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchUpdateDevicePosition( + batchUpdateDevicePosition( args: BatchUpdateDevicePositionCommandInput, cb: (err: any, data?: BatchUpdateDevicePositionCommandOutput) => void ): void; - public batchUpdateDevicePosition( + batchUpdateDevicePosition( args: BatchUpdateDevicePositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchUpdateDevicePositionCommandOutput) => void ): void; - public batchUpdateDevicePosition( - args: BatchUpdateDevicePositionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchUpdateDevicePositionCommandOutput) => void), - cb?: (err: any, data?: BatchUpdateDevicePositionCommandOutput) => void - ): Promise | void { - const command = new BatchUpdateDevicePositionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Calculates a route given the following required parameters: - * DeparturePosition and DestinationPosition. Requires that - * you first create a - * route calculator resource.

- *

By default, a request that doesn't specify a departure time uses the best time of day - * to travel with the best traffic conditions when calculating the route.

- *

Additional options include:

- *
    - *
  • - *

    - * Specifying a - * departure time using either DepartureTime or - * DepartNow. This calculates a route based on predictive traffic - * data at the given time.

    - * - *

    You can't specify both DepartureTime and - * DepartNow in a single request. Specifying both parameters - * returns a validation error.

    - *
    - *
  • - *
  • - *

    - * Specifying a travel - * mode using TravelMode sets the transportation mode used to calculate - * the routes. This also lets you specify additional route preferences in - * CarModeOptions if traveling by Car, or - * TruckModeOptions if traveling by Truck.

    - * - *

    If you specify walking for the travel mode and your data - * provider is Esri, the start and destination must be within 40km.

    - *
    - *
  • - *
+ * @see {@link CalculateRouteCommand} */ - public calculateRoute( + calculateRoute( args: CalculateRouteCommandInput, options?: __HttpHandlerOptions ): Promise; - public calculateRoute( - args: CalculateRouteCommandInput, - cb: (err: any, data?: CalculateRouteCommandOutput) => void - ): void; - public calculateRoute( + calculateRoute(args: CalculateRouteCommandInput, cb: (err: any, data?: CalculateRouteCommandOutput) => void): void; + calculateRoute( args: CalculateRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CalculateRouteCommandOutput) => void ): void; - public calculateRoute( - args: CalculateRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CalculateRouteCommandOutput) => void), - cb?: (err: any, data?: CalculateRouteCommandOutput) => void - ): Promise | void { - const command = new CalculateRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Calculates a route - * matrix given the following required parameters: - * DeparturePositions and DestinationPositions. - * CalculateRouteMatrix calculates routes and returns the travel time and - * travel distance from each departure position to each destination position in the - * request. For example, given departure positions A and B, and destination positions X and - * Y, CalculateRouteMatrix will return time and distance for routes from A to - * X, A to Y, B to X, and B to Y (in that order). The number of results returned (and - * routes calculated) will be the number of DeparturePositions times the - * number of DestinationPositions.

- * - *

Your account is charged for each route calculated, not the number of - * requests.

- *
- *

Requires that you first create a - * route calculator resource.

- *

By default, a request that doesn't specify a departure time uses the best time of day - * to travel with the best traffic conditions when calculating routes.

- *

Additional options include:

- *
    - *
  • - *

    - * Specifying a - * departure time using either DepartureTime or - * DepartNow. This calculates routes based on predictive traffic - * data at the given time.

    - * - *

    You can't specify both DepartureTime and - * DepartNow in a single request. Specifying both parameters - * returns a validation error.

    - *
    - *
  • - *
  • - *

    - * Specifying a travel - * mode using TravelMode sets the transportation mode used to calculate - * the routes. This also lets you specify additional route preferences in - * CarModeOptions if traveling by Car, or - * TruckModeOptions if traveling by Truck.

    - *
  • - *
+ * @see {@link CalculateRouteMatrixCommand} */ - public calculateRouteMatrix( + calculateRouteMatrix( args: CalculateRouteMatrixCommandInput, options?: __HttpHandlerOptions ): Promise; - public calculateRouteMatrix( + calculateRouteMatrix( args: CalculateRouteMatrixCommandInput, cb: (err: any, data?: CalculateRouteMatrixCommandOutput) => void ): void; - public calculateRouteMatrix( + calculateRouteMatrix( args: CalculateRouteMatrixCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CalculateRouteMatrixCommandOutput) => void ): void; - public calculateRouteMatrix( - args: CalculateRouteMatrixCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CalculateRouteMatrixCommandOutput) => void), - cb?: (err: any, data?: CalculateRouteMatrixCommandOutput) => void - ): Promise | void { - const command = new CalculateRouteMatrixCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a geofence collection, which manages and stores geofences.

+ * @see {@link CreateGeofenceCollectionCommand} */ - public createGeofenceCollection( + createGeofenceCollection( args: CreateGeofenceCollectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createGeofenceCollection( + createGeofenceCollection( args: CreateGeofenceCollectionCommandInput, cb: (err: any, data?: CreateGeofenceCollectionCommandOutput) => void ): void; - public createGeofenceCollection( + createGeofenceCollection( args: CreateGeofenceCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGeofenceCollectionCommandOutput) => void ): void; - public createGeofenceCollection( - args: CreateGeofenceCollectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGeofenceCollectionCommandOutput) => void), - cb?: (err: any, data?: CreateGeofenceCollectionCommandOutput) => void - ): Promise | void { - const command = new CreateGeofenceCollectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an API key resource in your Amazon Web Services account, which lets you grant - * geo:GetMap* actions for Amazon Location Map resources to the API key - * bearer.

- * - *

The API keys feature is in preview. We may add, change, or remove - * features before announcing general availability. For more information, see - * Using API keys.

- *
+ * @see {@link CreateKeyCommand} */ - public createKey(args: CreateKeyCommandInput, options?: __HttpHandlerOptions): Promise; - public createKey(args: CreateKeyCommandInput, cb: (err: any, data?: CreateKeyCommandOutput) => void): void; - public createKey( + createKey(args: CreateKeyCommandInput, options?: __HttpHandlerOptions): Promise; + createKey(args: CreateKeyCommandInput, cb: (err: any, data?: CreateKeyCommandOutput) => void): void; + createKey( args: CreateKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateKeyCommandOutput) => void ): void; - public createKey( - args: CreateKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateKeyCommandOutput) => void), - cb?: (err: any, data?: CreateKeyCommandOutput) => void - ): Promise | void { - const command = new CreateKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a map resource in your Amazon Web Services account, which provides map tiles of different - * styles sourced from global location data providers.

- * - *

If your application is tracking or routing assets you use in your business, such - * as delivery vehicles or employees, you must not use Esri as your geolocation - * provider. See section 82 of the Amazon Web Services - * service terms for more details.

- *
+ * @see {@link CreateMapCommand} */ - public createMap(args: CreateMapCommandInput, options?: __HttpHandlerOptions): Promise; - public createMap(args: CreateMapCommandInput, cb: (err: any, data?: CreateMapCommandOutput) => void): void; - public createMap( + createMap(args: CreateMapCommandInput, options?: __HttpHandlerOptions): Promise; + createMap(args: CreateMapCommandInput, cb: (err: any, data?: CreateMapCommandOutput) => void): void; + createMap( args: CreateMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMapCommandOutput) => void ): void; - public createMap( - args: CreateMapCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMapCommandOutput) => void), - cb?: (err: any, data?: CreateMapCommandOutput) => void - ): Promise | void { - const command = new CreateMapCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a place index resource in your Amazon Web Services account. Use a place index resource to - * geocode addresses and other text queries by using the - * SearchPlaceIndexForText operation, and reverse geocode coordinates by - * using the SearchPlaceIndexForPosition operation, and enable autosuggestions - * by using the SearchPlaceIndexForSuggestions operation.

- * - *

If your application is tracking or routing assets you use in your business, such - * as delivery vehicles or employees, you must not use Esri as your geolocation - * provider. See section 82 of the Amazon Web Services - * service terms for more details.

- *
+ * @see {@link CreatePlaceIndexCommand} */ - public createPlaceIndex( + createPlaceIndex( args: CreatePlaceIndexCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPlaceIndex( + createPlaceIndex( args: CreatePlaceIndexCommandInput, cb: (err: any, data?: CreatePlaceIndexCommandOutput) => void ): void; - public createPlaceIndex( + createPlaceIndex( args: CreatePlaceIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePlaceIndexCommandOutput) => void ): void; - public createPlaceIndex( - args: CreatePlaceIndexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePlaceIndexCommandOutput) => void), - cb?: (err: any, data?: CreatePlaceIndexCommandOutput) => void - ): Promise | void { - const command = new CreatePlaceIndexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a route calculator resource in your Amazon Web Services account.

- *

You can send requests to a route calculator resource to estimate travel time, - * distance, and get directions. A route calculator sources traffic and road network data - * from your chosen data provider.

- * - *

If your application is tracking or routing assets you use in your business, such - * as delivery vehicles or employees, you must not use Esri as your geolocation - * provider. See section 82 of the Amazon Web Services - * service terms for more details.

- *
+ * @see {@link CreateRouteCalculatorCommand} */ - public createRouteCalculator( + createRouteCalculator( args: CreateRouteCalculatorCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRouteCalculator( + createRouteCalculator( args: CreateRouteCalculatorCommandInput, cb: (err: any, data?: CreateRouteCalculatorCommandOutput) => void ): void; - public createRouteCalculator( + createRouteCalculator( args: CreateRouteCalculatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRouteCalculatorCommandOutput) => void ): void; - public createRouteCalculator( - args: CreateRouteCalculatorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRouteCalculatorCommandOutput) => void), - cb?: (err: any, data?: CreateRouteCalculatorCommandOutput) => void - ): Promise | void { - const command = new CreateRouteCalculatorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and - * historical location of devices.

+ * @see {@link CreateTrackerCommand} */ - public createTracker( - args: CreateTrackerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createTracker( - args: CreateTrackerCommandInput, - cb: (err: any, data?: CreateTrackerCommandOutput) => void - ): void; - public createTracker( + createTracker(args: CreateTrackerCommandInput, options?: __HttpHandlerOptions): Promise; + createTracker(args: CreateTrackerCommandInput, cb: (err: any, data?: CreateTrackerCommandOutput) => void): void; + createTracker( args: CreateTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTrackerCommandOutput) => void ): void; - public createTracker( - args: CreateTrackerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTrackerCommandOutput) => void), - cb?: (err: any, data?: CreateTrackerCommandOutput) => void - ): Promise | void { - const command = new CreateTrackerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a geofence collection from your Amazon Web Services account.

- * - *

This operation deletes the resource permanently. If the geofence collection is the - * target of a tracker resource, the devices will no longer be monitored.

- *
+ * @see {@link DeleteGeofenceCollectionCommand} */ - public deleteGeofenceCollection( + deleteGeofenceCollection( args: DeleteGeofenceCollectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteGeofenceCollection( + deleteGeofenceCollection( args: DeleteGeofenceCollectionCommandInput, cb: (err: any, data?: DeleteGeofenceCollectionCommandOutput) => void ): void; - public deleteGeofenceCollection( + deleteGeofenceCollection( args: DeleteGeofenceCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGeofenceCollectionCommandOutput) => void ): void; - public deleteGeofenceCollection( - args: DeleteGeofenceCollectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGeofenceCollectionCommandOutput) => void), - cb?: (err: any, data?: DeleteGeofenceCollectionCommandOutput) => void - ): Promise | void { - const command = new DeleteGeofenceCollectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified API key. The API key must have been deactivated more than - * 90 days previously.

+ * @see {@link DeleteKeyCommand} */ - public deleteKey(args: DeleteKeyCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteKey(args: DeleteKeyCommandInput, cb: (err: any, data?: DeleteKeyCommandOutput) => void): void; - public deleteKey( + deleteKey(args: DeleteKeyCommandInput, options?: __HttpHandlerOptions): Promise; + deleteKey(args: DeleteKeyCommandInput, cb: (err: any, data?: DeleteKeyCommandOutput) => void): void; + deleteKey( args: DeleteKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteKeyCommandOutput) => void ): void; - public deleteKey( - args: DeleteKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteKeyCommandOutput) => void), - cb?: (err: any, data?: DeleteKeyCommandOutput) => void - ): Promise | void { - const command = new DeleteKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a map resource from your Amazon Web Services account.

- * - *

This operation deletes the resource permanently. If the map is being used in an application, - * the map may not render.

- *
+ * @see {@link DeleteMapCommand} */ - public deleteMap(args: DeleteMapCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteMap(args: DeleteMapCommandInput, cb: (err: any, data?: DeleteMapCommandOutput) => void): void; - public deleteMap( + deleteMap(args: DeleteMapCommandInput, options?: __HttpHandlerOptions): Promise; + deleteMap(args: DeleteMapCommandInput, cb: (err: any, data?: DeleteMapCommandOutput) => void): void; + deleteMap( args: DeleteMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMapCommandOutput) => void ): void; - public deleteMap( - args: DeleteMapCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMapCommandOutput) => void), - cb?: (err: any, data?: DeleteMapCommandOutput) => void - ): Promise | void { - const command = new DeleteMapCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a place index resource from your Amazon Web Services account.

- * - *

This operation deletes the resource permanently.

- *
+ * @see {@link DeletePlaceIndexCommand} */ - public deletePlaceIndex( + deletePlaceIndex( args: DeletePlaceIndexCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePlaceIndex( + deletePlaceIndex( args: DeletePlaceIndexCommandInput, cb: (err: any, data?: DeletePlaceIndexCommandOutput) => void ): void; - public deletePlaceIndex( + deletePlaceIndex( args: DeletePlaceIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePlaceIndexCommandOutput) => void ): void; - public deletePlaceIndex( - args: DeletePlaceIndexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePlaceIndexCommandOutput) => void), - cb?: (err: any, data?: DeletePlaceIndexCommandOutput) => void - ): Promise | void { - const command = new DeletePlaceIndexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a route calculator resource from your Amazon Web Services account.

- * - *

This operation deletes the resource permanently.

- *
+ * @see {@link DeleteRouteCalculatorCommand} */ - public deleteRouteCalculator( + deleteRouteCalculator( args: DeleteRouteCalculatorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRouteCalculator( + deleteRouteCalculator( args: DeleteRouteCalculatorCommandInput, cb: (err: any, data?: DeleteRouteCalculatorCommandOutput) => void ): void; - public deleteRouteCalculator( + deleteRouteCalculator( args: DeleteRouteCalculatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRouteCalculatorCommandOutput) => void ): void; - public deleteRouteCalculator( - args: DeleteRouteCalculatorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRouteCalculatorCommandOutput) => void), - cb?: (err: any, data?: DeleteRouteCalculatorCommandOutput) => void - ): Promise | void { - const command = new DeleteRouteCalculatorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a tracker resource from your Amazon Web Services account.

- * - *

This operation deletes the resource permanently. If the tracker resource is in use, you may - * encounter an error. Make sure that the target resource isn't a dependency for your - * applications.

- *
+ * @see {@link DeleteTrackerCommand} */ - public deleteTracker( - args: DeleteTrackerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteTracker( - args: DeleteTrackerCommandInput, - cb: (err: any, data?: DeleteTrackerCommandOutput) => void - ): void; - public deleteTracker( + deleteTracker(args: DeleteTrackerCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTracker(args: DeleteTrackerCommandInput, cb: (err: any, data?: DeleteTrackerCommandOutput) => void): void; + deleteTracker( args: DeleteTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTrackerCommandOutput) => void ): void; - public deleteTracker( - args: DeleteTrackerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTrackerCommandOutput) => void), - cb?: (err: any, data?: DeleteTrackerCommandOutput) => void - ): Promise | void { - const command = new DeleteTrackerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the geofence collection details.

+ * @see {@link DescribeGeofenceCollectionCommand} */ - public describeGeofenceCollection( + describeGeofenceCollection( args: DescribeGeofenceCollectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGeofenceCollection( + describeGeofenceCollection( args: DescribeGeofenceCollectionCommandInput, cb: (err: any, data?: DescribeGeofenceCollectionCommandOutput) => void ): void; - public describeGeofenceCollection( + describeGeofenceCollection( args: DescribeGeofenceCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGeofenceCollectionCommandOutput) => void ): void; - public describeGeofenceCollection( - args: DescribeGeofenceCollectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGeofenceCollectionCommandOutput) => void), - cb?: (err: any, data?: DescribeGeofenceCollectionCommandOutput) => void - ): Promise | void { - const command = new DescribeGeofenceCollectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the API key resource details.

- * - *

The API keys feature is in preview. We may add, change, or remove - * features before announcing general availability. For more information, see - * Using API keys.

- *
+ * @see {@link DescribeKeyCommand} */ - public describeKey(args: DescribeKeyCommandInput, options?: __HttpHandlerOptions): Promise; - public describeKey(args: DescribeKeyCommandInput, cb: (err: any, data?: DescribeKeyCommandOutput) => void): void; - public describeKey( + describeKey(args: DescribeKeyCommandInput, options?: __HttpHandlerOptions): Promise; + describeKey(args: DescribeKeyCommandInput, cb: (err: any, data?: DescribeKeyCommandOutput) => void): void; + describeKey( args: DescribeKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeKeyCommandOutput) => void ): void; - public describeKey( - args: DescribeKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeKeyCommandOutput) => void), - cb?: (err: any, data?: DescribeKeyCommandOutput) => void - ): Promise | void { - const command = new DescribeKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the map resource details.

+ * @see {@link DescribeMapCommand} */ - public describeMap(args: DescribeMapCommandInput, options?: __HttpHandlerOptions): Promise; - public describeMap(args: DescribeMapCommandInput, cb: (err: any, data?: DescribeMapCommandOutput) => void): void; - public describeMap( + describeMap(args: DescribeMapCommandInput, options?: __HttpHandlerOptions): Promise; + describeMap(args: DescribeMapCommandInput, cb: (err: any, data?: DescribeMapCommandOutput) => void): void; + describeMap( args: DescribeMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMapCommandOutput) => void ): void; - public describeMap( - args: DescribeMapCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMapCommandOutput) => void), - cb?: (err: any, data?: DescribeMapCommandOutput) => void - ): Promise | void { - const command = new DescribeMapCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the place index resource details.

+ * @see {@link DescribePlaceIndexCommand} */ - public describePlaceIndex( + describePlaceIndex( args: DescribePlaceIndexCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePlaceIndex( + describePlaceIndex( args: DescribePlaceIndexCommandInput, cb: (err: any, data?: DescribePlaceIndexCommandOutput) => void ): void; - public describePlaceIndex( + describePlaceIndex( args: DescribePlaceIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePlaceIndexCommandOutput) => void ): void; - public describePlaceIndex( - args: DescribePlaceIndexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePlaceIndexCommandOutput) => void), - cb?: (err: any, data?: DescribePlaceIndexCommandOutput) => void - ): Promise | void { - const command = new DescribePlaceIndexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the route calculator resource details.

+ * @see {@link DescribeRouteCalculatorCommand} */ - public describeRouteCalculator( + describeRouteCalculator( args: DescribeRouteCalculatorCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRouteCalculator( + describeRouteCalculator( args: DescribeRouteCalculatorCommandInput, cb: (err: any, data?: DescribeRouteCalculatorCommandOutput) => void ): void; - public describeRouteCalculator( + describeRouteCalculator( args: DescribeRouteCalculatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRouteCalculatorCommandOutput) => void ): void; - public describeRouteCalculator( - args: DescribeRouteCalculatorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRouteCalculatorCommandOutput) => void), - cb?: (err: any, data?: DescribeRouteCalculatorCommandOutput) => void - ): Promise | void { - const command = new DescribeRouteCalculatorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the tracker resource details.

+ * @see {@link DescribeTrackerCommand} */ - public describeTracker( + describeTracker( args: DescribeTrackerCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTracker( - args: DescribeTrackerCommandInput, - cb: (err: any, data?: DescribeTrackerCommandOutput) => void - ): void; - public describeTracker( + describeTracker(args: DescribeTrackerCommandInput, cb: (err: any, data?: DescribeTrackerCommandOutput) => void): void; + describeTracker( args: DescribeTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrackerCommandOutput) => void ): void; - public describeTracker( - args: DescribeTrackerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTrackerCommandOutput) => void), - cb?: (err: any, data?: DescribeTrackerCommandOutput) => void - ): Promise | void { - const command = new DescribeTrackerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the association between a tracker resource and a geofence collection.

- * - *

Once you unlink a tracker resource from a geofence collection, the tracker - * positions will no longer be automatically evaluated against geofences.

- *
+ * @see {@link DisassociateTrackerConsumerCommand} */ - public disassociateTrackerConsumer( + disassociateTrackerConsumer( args: DisassociateTrackerConsumerCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateTrackerConsumer( + disassociateTrackerConsumer( args: DisassociateTrackerConsumerCommandInput, cb: (err: any, data?: DisassociateTrackerConsumerCommandOutput) => void ): void; - public disassociateTrackerConsumer( + disassociateTrackerConsumer( args: DisassociateTrackerConsumerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateTrackerConsumerCommandOutput) => void ): void; - public disassociateTrackerConsumer( - args: DisassociateTrackerConsumerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateTrackerConsumerCommandOutput) => void), - cb?: (err: any, data?: DisassociateTrackerConsumerCommandOutput) => void - ): Promise | void { - const command = new DisassociateTrackerConsumerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a device's most recent position according to its sample time.

- * - *

Device positions are deleted after 30 days.

- *
+ * @see {@link GetDevicePositionCommand} */ - public getDevicePosition( + getDevicePosition( args: GetDevicePositionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDevicePosition( + getDevicePosition( args: GetDevicePositionCommandInput, cb: (err: any, data?: GetDevicePositionCommandOutput) => void ): void; - public getDevicePosition( + getDevicePosition( args: GetDevicePositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDevicePositionCommandOutput) => void ): void; - public getDevicePosition( - args: GetDevicePositionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDevicePositionCommandOutput) => void), - cb?: (err: any, data?: GetDevicePositionCommandOutput) => void - ): Promise | void { - const command = new GetDevicePositionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the device position history from a tracker resource within a specified range - * of time.

- * - *

Device positions are deleted after 30 days.

- *
+ * @see {@link GetDevicePositionHistoryCommand} */ - public getDevicePositionHistory( + getDevicePositionHistory( args: GetDevicePositionHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDevicePositionHistory( + getDevicePositionHistory( args: GetDevicePositionHistoryCommandInput, cb: (err: any, data?: GetDevicePositionHistoryCommandOutput) => void ): void; - public getDevicePositionHistory( + getDevicePositionHistory( args: GetDevicePositionHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDevicePositionHistoryCommandOutput) => void ): void; - public getDevicePositionHistory( - args: GetDevicePositionHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDevicePositionHistoryCommandOutput) => void), - cb?: (err: any, data?: GetDevicePositionHistoryCommandOutput) => void - ): Promise | void { - const command = new GetDevicePositionHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the geofence details from a geofence collection.

+ * @see {@link GetGeofenceCommand} */ - public getGeofence(args: GetGeofenceCommandInput, options?: __HttpHandlerOptions): Promise; - public getGeofence(args: GetGeofenceCommandInput, cb: (err: any, data?: GetGeofenceCommandOutput) => void): void; - public getGeofence( + getGeofence(args: GetGeofenceCommandInput, options?: __HttpHandlerOptions): Promise; + getGeofence(args: GetGeofenceCommandInput, cb: (err: any, data?: GetGeofenceCommandOutput) => void): void; + getGeofence( args: GetGeofenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGeofenceCommandOutput) => void ): void; - public getGeofence( - args: GetGeofenceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGeofenceCommandOutput) => void), - cb?: (err: any, data?: GetGeofenceCommandOutput) => void - ): Promise | void { - const command = new GetGeofenceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves glyphs used to display labels on a map.

+ * @see {@link GetMapGlyphsCommand} */ - public getMapGlyphs( - args: GetMapGlyphsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getMapGlyphs(args: GetMapGlyphsCommandInput, cb: (err: any, data?: GetMapGlyphsCommandOutput) => void): void; - public getMapGlyphs( + getMapGlyphs(args: GetMapGlyphsCommandInput, options?: __HttpHandlerOptions): Promise; + getMapGlyphs(args: GetMapGlyphsCommandInput, cb: (err: any, data?: GetMapGlyphsCommandOutput) => void): void; + getMapGlyphs( args: GetMapGlyphsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMapGlyphsCommandOutput) => void ): void; - public getMapGlyphs( - args: GetMapGlyphsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMapGlyphsCommandOutput) => void), - cb?: (err: any, data?: GetMapGlyphsCommandOutput) => void - ): Promise | void { - const command = new GetMapGlyphsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG - * image paired with a JSON document describing the offsets of individual icons that will - * be displayed on a rendered map.

+ * @see {@link GetMapSpritesCommand} */ - public getMapSprites( - args: GetMapSpritesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getMapSprites( - args: GetMapSpritesCommandInput, - cb: (err: any, data?: GetMapSpritesCommandOutput) => void - ): void; - public getMapSprites( + getMapSprites(args: GetMapSpritesCommandInput, options?: __HttpHandlerOptions): Promise; + getMapSprites(args: GetMapSpritesCommandInput, cb: (err: any, data?: GetMapSpritesCommandOutput) => void): void; + getMapSprites( args: GetMapSpritesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMapSpritesCommandOutput) => void ): void; - public getMapSprites( - args: GetMapSpritesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMapSpritesCommandOutput) => void), - cb?: (err: any, data?: GetMapSpritesCommandOutput) => void - ): Promise | void { - const command = new GetMapSpritesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the map style descriptor from a map resource.

- *

The style descriptor contains specifications on how features render on a map. For - * example, what data to display, what order to display the data in, and the style for the - * data. Style descriptors follow the Mapbox Style Specification.

+ * @see {@link GetMapStyleDescriptorCommand} */ - public getMapStyleDescriptor( + getMapStyleDescriptor( args: GetMapStyleDescriptorCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMapStyleDescriptor( + getMapStyleDescriptor( args: GetMapStyleDescriptorCommandInput, cb: (err: any, data?: GetMapStyleDescriptorCommandOutput) => void ): void; - public getMapStyleDescriptor( + getMapStyleDescriptor( args: GetMapStyleDescriptorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMapStyleDescriptorCommandOutput) => void ): void; - public getMapStyleDescriptor( - args: GetMapStyleDescriptorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMapStyleDescriptorCommandOutput) => void), - cb?: (err: any, data?: GetMapStyleDescriptorCommandOutput) => void - ): Promise | void { - const command = new GetMapStyleDescriptorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a vector data tile from the map resource. Map tiles are used by clients to - * render a map. they're addressed using a grid arrangement with an X coordinate, Y - * coordinate, and Z (zoom) level.

- *

The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles - * both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0) - * will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).

+ * @see {@link GetMapTileCommand} */ - public getMapTile(args: GetMapTileCommandInput, options?: __HttpHandlerOptions): Promise; - public getMapTile(args: GetMapTileCommandInput, cb: (err: any, data?: GetMapTileCommandOutput) => void): void; - public getMapTile( + getMapTile(args: GetMapTileCommandInput, options?: __HttpHandlerOptions): Promise; + getMapTile(args: GetMapTileCommandInput, cb: (err: any, data?: GetMapTileCommandOutput) => void): void; + getMapTile( args: GetMapTileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMapTileCommandOutput) => void ): void; - public getMapTile( - args: GetMapTileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMapTileCommandOutput) => void), - cb?: (err: any, data?: GetMapTileCommandOutput) => void - ): Promise | void { - const command = new GetMapTileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Finds a place by its unique ID. A PlaceId is returned by other search - * operations.

- * - *

A PlaceId is valid only if all of the following are the same in the original - * search request and the call to GetPlace.

- *
    - *
  • - *

    Customer Amazon Web Services account

    - *
  • - *
  • - *

    Amazon Web Services Region

    - *
  • - *
  • - *

    Data provider specified in the place index resource

    - *
  • - *
- *
+ * @see {@link GetPlaceCommand} */ - public getPlace(args: GetPlaceCommandInput, options?: __HttpHandlerOptions): Promise; - public getPlace(args: GetPlaceCommandInput, cb: (err: any, data?: GetPlaceCommandOutput) => void): void; - public getPlace( + getPlace(args: GetPlaceCommandInput, options?: __HttpHandlerOptions): Promise; + getPlace(args: GetPlaceCommandInput, cb: (err: any, data?: GetPlaceCommandOutput) => void): void; + getPlace( args: GetPlaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPlaceCommandOutput) => void ): void; - public getPlace( - args: GetPlaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPlaceCommandOutput) => void), - cb?: (err: any, data?: GetPlaceCommandOutput) => void - ): Promise | void { - const command = new GetPlaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A batch request to retrieve all device positions.

+ * @see {@link ListDevicePositionsCommand} */ - public listDevicePositions( + listDevicePositions( args: ListDevicePositionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDevicePositions( + listDevicePositions( args: ListDevicePositionsCommandInput, cb: (err: any, data?: ListDevicePositionsCommandOutput) => void ): void; - public listDevicePositions( + listDevicePositions( args: ListDevicePositionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDevicePositionsCommandOutput) => void ): void; - public listDevicePositions( - args: ListDevicePositionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDevicePositionsCommandOutput) => void), - cb?: (err: any, data?: ListDevicePositionsCommandOutput) => void - ): Promise | void { - const command = new ListDevicePositionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists geofence collections in your Amazon Web Services account.

+ * @see {@link ListGeofenceCollectionsCommand} */ - public listGeofenceCollections( + listGeofenceCollections( args: ListGeofenceCollectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGeofenceCollections( + listGeofenceCollections( args: ListGeofenceCollectionsCommandInput, cb: (err: any, data?: ListGeofenceCollectionsCommandOutput) => void ): void; - public listGeofenceCollections( + listGeofenceCollections( args: ListGeofenceCollectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGeofenceCollectionsCommandOutput) => void ): void; - public listGeofenceCollections( - args: ListGeofenceCollectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGeofenceCollectionsCommandOutput) => void), - cb?: (err: any, data?: ListGeofenceCollectionsCommandOutput) => void - ): Promise | void { - const command = new ListGeofenceCollectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists geofences stored in a given geofence collection.

+ * @see {@link ListGeofencesCommand} */ - public listGeofences( - args: ListGeofencesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listGeofences( - args: ListGeofencesCommandInput, - cb: (err: any, data?: ListGeofencesCommandOutput) => void - ): void; - public listGeofences( + listGeofences(args: ListGeofencesCommandInput, options?: __HttpHandlerOptions): Promise; + listGeofences(args: ListGeofencesCommandInput, cb: (err: any, data?: ListGeofencesCommandOutput) => void): void; + listGeofences( args: ListGeofencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGeofencesCommandOutput) => void ): void; - public listGeofences( - args: ListGeofencesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGeofencesCommandOutput) => void), - cb?: (err: any, data?: ListGeofencesCommandOutput) => void - ): Promise | void { - const command = new ListGeofencesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists API key resources in your Amazon Web Services account.

- * - *

The API keys feature is in preview. We may add, change, or remove - * features before announcing general availability. For more information, see - * Using API keys.

- *
+ * @see {@link ListKeysCommand} */ - public listKeys(args: ListKeysCommandInput, options?: __HttpHandlerOptions): Promise; - public listKeys(args: ListKeysCommandInput, cb: (err: any, data?: ListKeysCommandOutput) => void): void; - public listKeys( + listKeys(args: ListKeysCommandInput, options?: __HttpHandlerOptions): Promise; + listKeys(args: ListKeysCommandInput, cb: (err: any, data?: ListKeysCommandOutput) => void): void; + listKeys( args: ListKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKeysCommandOutput) => void ): void; - public listKeys( - args: ListKeysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListKeysCommandOutput) => void), - cb?: (err: any, data?: ListKeysCommandOutput) => void - ): Promise | void { - const command = new ListKeysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists map resources in your Amazon Web Services account.

+ * @see {@link ListMapsCommand} */ - public listMaps(args: ListMapsCommandInput, options?: __HttpHandlerOptions): Promise; - public listMaps(args: ListMapsCommandInput, cb: (err: any, data?: ListMapsCommandOutput) => void): void; - public listMaps( + listMaps(args: ListMapsCommandInput, options?: __HttpHandlerOptions): Promise; + listMaps(args: ListMapsCommandInput, cb: (err: any, data?: ListMapsCommandOutput) => void): void; + listMaps( args: ListMapsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMapsCommandOutput) => void ): void; - public listMaps( - args: ListMapsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMapsCommandOutput) => void), - cb?: (err: any, data?: ListMapsCommandOutput) => void - ): Promise | void { - const command = new ListMapsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists place index resources in your Amazon Web Services account.

+ * @see {@link ListPlaceIndexesCommand} */ - public listPlaceIndexes( + listPlaceIndexes( args: ListPlaceIndexesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPlaceIndexes( + listPlaceIndexes( args: ListPlaceIndexesCommandInput, cb: (err: any, data?: ListPlaceIndexesCommandOutput) => void ): void; - public listPlaceIndexes( + listPlaceIndexes( args: ListPlaceIndexesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPlaceIndexesCommandOutput) => void ): void; - public listPlaceIndexes( - args: ListPlaceIndexesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPlaceIndexesCommandOutput) => void), - cb?: (err: any, data?: ListPlaceIndexesCommandOutput) => void - ): Promise | void { - const command = new ListPlaceIndexesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists route calculator resources in your Amazon Web Services account.

+ * @see {@link ListRouteCalculatorsCommand} */ - public listRouteCalculators( + listRouteCalculators( args: ListRouteCalculatorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRouteCalculators( + listRouteCalculators( args: ListRouteCalculatorsCommandInput, cb: (err: any, data?: ListRouteCalculatorsCommandOutput) => void ): void; - public listRouteCalculators( + listRouteCalculators( args: ListRouteCalculatorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRouteCalculatorsCommandOutput) => void ): void; - public listRouteCalculators( - args: ListRouteCalculatorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRouteCalculatorsCommandOutput) => void), - cb?: (err: any, data?: ListRouteCalculatorsCommandOutput) => void - ): Promise | void { - const command = new ListRouteCalculatorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of tags that are applied to the specified Amazon Location resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists geofence collections currently associated to the given tracker resource.

+ * @see {@link ListTrackerConsumersCommand} */ - public listTrackerConsumers( + listTrackerConsumers( args: ListTrackerConsumersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTrackerConsumers( + listTrackerConsumers( args: ListTrackerConsumersCommandInput, cb: (err: any, data?: ListTrackerConsumersCommandOutput) => void ): void; - public listTrackerConsumers( + listTrackerConsumers( args: ListTrackerConsumersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTrackerConsumersCommandOutput) => void ): void; - public listTrackerConsumers( - args: ListTrackerConsumersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTrackerConsumersCommandOutput) => void), - cb?: (err: any, data?: ListTrackerConsumersCommandOutput) => void - ): Promise | void { - const command = new ListTrackerConsumersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists tracker resources in your Amazon Web Services account.

+ * @see {@link ListTrackersCommand} */ - public listTrackers( - args: ListTrackersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listTrackers(args: ListTrackersCommandInput, cb: (err: any, data?: ListTrackersCommandOutput) => void): void; - public listTrackers( + listTrackers(args: ListTrackersCommandInput, options?: __HttpHandlerOptions): Promise; + listTrackers(args: ListTrackersCommandInput, cb: (err: any, data?: ListTrackersCommandOutput) => void): void; + listTrackers( args: ListTrackersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTrackersCommandOutput) => void ): void; - public listTrackers( - args: ListTrackersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTrackersCommandOutput) => void), - cb?: (err: any, data?: ListTrackersCommandOutput) => void - ): Promise | void { - const command = new ListTrackersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stores a geofence geometry in a given geofence collection, or updates the geometry of - * an existing geofence if a geofence ID is included in the request.

+ * @see {@link PutGeofenceCommand} */ - public putGeofence(args: PutGeofenceCommandInput, options?: __HttpHandlerOptions): Promise; - public putGeofence(args: PutGeofenceCommandInput, cb: (err: any, data?: PutGeofenceCommandOutput) => void): void; - public putGeofence( + putGeofence(args: PutGeofenceCommandInput, options?: __HttpHandlerOptions): Promise; + putGeofence(args: PutGeofenceCommandInput, cb: (err: any, data?: PutGeofenceCommandOutput) => void): void; + putGeofence( args: PutGeofenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutGeofenceCommandOutput) => void ): void; - public putGeofence( - args: PutGeofenceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutGeofenceCommandOutput) => void), - cb?: (err: any, data?: PutGeofenceCommandOutput) => void - ): Promise | void { - const command = new PutGeofenceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Reverse geocodes a given coordinate and returns a legible address. Allows you to - * search for Places or points of interest near a given position.

+ * @see {@link SearchPlaceIndexForPositionCommand} */ - public searchPlaceIndexForPosition( + searchPlaceIndexForPosition( args: SearchPlaceIndexForPositionCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchPlaceIndexForPosition( + searchPlaceIndexForPosition( args: SearchPlaceIndexForPositionCommandInput, cb: (err: any, data?: SearchPlaceIndexForPositionCommandOutput) => void ): void; - public searchPlaceIndexForPosition( + searchPlaceIndexForPosition( args: SearchPlaceIndexForPositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchPlaceIndexForPositionCommandOutput) => void ): void; - public searchPlaceIndexForPosition( - args: SearchPlaceIndexForPositionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchPlaceIndexForPositionCommandOutput) => void), - cb?: (err: any, data?: SearchPlaceIndexForPositionCommandOutput) => void - ): Promise | void { - const command = new SearchPlaceIndexForPositionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Generates suggestions for addresses and points of interest based on partial or - * misspelled free-form text. This operation is also known as autocomplete, autosuggest, or - * fuzzy matching.

- *

Optional parameters let you narrow your search results by bounding box or country, or - * bias your search toward a specific position on the globe.

- * - *

You can search for suggested place names near a specified position by using - * BiasPosition, or filter results within a bounding box by using - * FilterBBox. These parameters are mutually exclusive; using both - * BiasPosition and FilterBBox in the same command - * returns an error.

- *
+ * @see {@link SearchPlaceIndexForSuggestionsCommand} */ - public searchPlaceIndexForSuggestions( + searchPlaceIndexForSuggestions( args: SearchPlaceIndexForSuggestionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchPlaceIndexForSuggestions( + searchPlaceIndexForSuggestions( args: SearchPlaceIndexForSuggestionsCommandInput, cb: (err: any, data?: SearchPlaceIndexForSuggestionsCommandOutput) => void ): void; - public searchPlaceIndexForSuggestions( + searchPlaceIndexForSuggestions( args: SearchPlaceIndexForSuggestionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchPlaceIndexForSuggestionsCommandOutput) => void ): void; - public searchPlaceIndexForSuggestions( - args: SearchPlaceIndexForSuggestionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchPlaceIndexForSuggestionsCommandOutput) => void), - cb?: (err: any, data?: SearchPlaceIndexForSuggestionsCommandOutput) => void - ): Promise | void { - const command = new SearchPlaceIndexForSuggestionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Geocodes free-form text, such as an address, name, city, or region to allow you to - * search for Places or points of interest.

- *

Optional parameters let you narrow your search results by bounding box or country, or - * bias your search toward a specific position on the globe.

- * - *

You can search for places near a given position using BiasPosition, - * or filter results within a bounding box using FilterBBox. Providing - * both parameters simultaneously returns an error.

- *
- *

Search results are returned in order of highest to lowest relevance.

+ * @see {@link SearchPlaceIndexForTextCommand} */ - public searchPlaceIndexForText( + searchPlaceIndexForText( args: SearchPlaceIndexForTextCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchPlaceIndexForText( + searchPlaceIndexForText( args: SearchPlaceIndexForTextCommandInput, cb: (err: any, data?: SearchPlaceIndexForTextCommandOutput) => void ): void; - public searchPlaceIndexForText( + searchPlaceIndexForText( args: SearchPlaceIndexForTextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchPlaceIndexForTextCommandOutput) => void ): void; - public searchPlaceIndexForText( - args: SearchPlaceIndexForTextCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchPlaceIndexForTextCommandOutput) => void), - cb?: (err: any, data?: SearchPlaceIndexForTextCommandOutput) => void - ): Promise | void { - const command = new SearchPlaceIndexForTextCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns one or more tags (key-value pairs) to the specified Amazon Location Service - * resource.

- *

Tags can help you organize and categorize your resources. You can also use them to - * scope user permissions, by granting a user permission to access or change only resources - * with certain tag values.

- *

You can use the TagResource operation with an Amazon Location Service - * resource that already has tags. If you specify a new tag key for the resource, this tag - * is appended to the tags already associated with the resource. If you specify a tag key - * that's already associated with the resource, the new tag value that you specify replaces - * the previous value for that tag.

- *

You can associate up to 50 tags with a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from the specified Amazon Location resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified properties of a given geofence collection.

+ * @see {@link UpdateGeofenceCollectionCommand} */ - public updateGeofenceCollection( + updateGeofenceCollection( args: UpdateGeofenceCollectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGeofenceCollection( + updateGeofenceCollection( args: UpdateGeofenceCollectionCommandInput, cb: (err: any, data?: UpdateGeofenceCollectionCommandOutput) => void ): void; - public updateGeofenceCollection( + updateGeofenceCollection( args: UpdateGeofenceCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGeofenceCollectionCommandOutput) => void ): void; - public updateGeofenceCollection( - args: UpdateGeofenceCollectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGeofenceCollectionCommandOutput) => void), - cb?: (err: any, data?: UpdateGeofenceCollectionCommandOutput) => void - ): Promise | void { - const command = new UpdateGeofenceCollectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified properties of a given API key resource.

- * - *

The API keys feature is in preview. We may add, change, or remove - * features before announcing general availability. For more information, see - * Using API keys.

- *
+ * @see {@link UpdateKeyCommand} */ - public updateKey(args: UpdateKeyCommandInput, options?: __HttpHandlerOptions): Promise; - public updateKey(args: UpdateKeyCommandInput, cb: (err: any, data?: UpdateKeyCommandOutput) => void): void; - public updateKey( + updateKey(args: UpdateKeyCommandInput, options?: __HttpHandlerOptions): Promise; + updateKey(args: UpdateKeyCommandInput, cb: (err: any, data?: UpdateKeyCommandOutput) => void): void; + updateKey( args: UpdateKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateKeyCommandOutput) => void ): void; - public updateKey( - args: UpdateKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateKeyCommandOutput) => void), - cb?: (err: any, data?: UpdateKeyCommandOutput) => void - ): Promise | void { - const command = new UpdateKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified properties of a given map resource.

+ * @see {@link UpdateMapCommand} */ - public updateMap(args: UpdateMapCommandInput, options?: __HttpHandlerOptions): Promise; - public updateMap(args: UpdateMapCommandInput, cb: (err: any, data?: UpdateMapCommandOutput) => void): void; - public updateMap( + updateMap(args: UpdateMapCommandInput, options?: __HttpHandlerOptions): Promise; + updateMap(args: UpdateMapCommandInput, cb: (err: any, data?: UpdateMapCommandOutput) => void): void; + updateMap( args: UpdateMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMapCommandOutput) => void ): void; - public updateMap( - args: UpdateMapCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMapCommandOutput) => void), - cb?: (err: any, data?: UpdateMapCommandOutput) => void - ): Promise | void { - const command = new UpdateMapCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified properties of a given place index resource.

+ * @see {@link UpdatePlaceIndexCommand} */ - public updatePlaceIndex( + updatePlaceIndex( args: UpdatePlaceIndexCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePlaceIndex( + updatePlaceIndex( args: UpdatePlaceIndexCommandInput, cb: (err: any, data?: UpdatePlaceIndexCommandOutput) => void ): void; - public updatePlaceIndex( + updatePlaceIndex( args: UpdatePlaceIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePlaceIndexCommandOutput) => void ): void; - public updatePlaceIndex( - args: UpdatePlaceIndexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePlaceIndexCommandOutput) => void), - cb?: (err: any, data?: UpdatePlaceIndexCommandOutput) => void - ): Promise | void { - const command = new UpdatePlaceIndexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified properties for a given route calculator resource.

+ * @see {@link UpdateRouteCalculatorCommand} */ - public updateRouteCalculator( + updateRouteCalculator( args: UpdateRouteCalculatorCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRouteCalculator( + updateRouteCalculator( args: UpdateRouteCalculatorCommandInput, cb: (err: any, data?: UpdateRouteCalculatorCommandOutput) => void ): void; - public updateRouteCalculator( + updateRouteCalculator( args: UpdateRouteCalculatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRouteCalculatorCommandOutput) => void ): void; - public updateRouteCalculator( - args: UpdateRouteCalculatorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRouteCalculatorCommandOutput) => void), - cb?: (err: any, data?: UpdateRouteCalculatorCommandOutput) => void - ): Promise | void { - const command = new UpdateRouteCalculatorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified properties of a given tracker resource.

+ * @see {@link UpdateTrackerCommand} */ - public updateTracker( - args: UpdateTrackerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateTracker( - args: UpdateTrackerCommandInput, - cb: (err: any, data?: UpdateTrackerCommandOutput) => void - ): void; - public updateTracker( + updateTracker(args: UpdateTrackerCommandInput, options?: __HttpHandlerOptions): Promise; + updateTracker(args: UpdateTrackerCommandInput, cb: (err: any, data?: UpdateTrackerCommandOutput) => void): void; + updateTracker( args: UpdateTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTrackerCommandOutput) => void ): void; - public updateTracker( - args: UpdateTrackerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTrackerCommandOutput) => void), - cb?: (err: any, data?: UpdateTrackerCommandOutput) => void - ): Promise | void { - const command = new UpdateTrackerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"

+ */ +export class Location extends LocationClient implements Location {} +createAggregatedClient(commands, Location); diff --git a/clients/client-lookoutequipment/src/LookoutEquipment.ts b/clients/client-lookoutequipment/src/LookoutEquipment.ts index 878624ae46c2..b249280b6599 100644 --- a/clients/client-lookoutequipment/src/LookoutEquipment.ts +++ b/clients/client-lookoutequipment/src/LookoutEquipment.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -138,1113 +139,527 @@ import { UpdateLabelGroupCommandInput, UpdateLabelGroupCommandOutput, } from "./commands/UpdateLabelGroupCommand"; -import { LookoutEquipmentClient } from "./LookoutEquipmentClient"; +import { LookoutEquipmentClient, LookoutEquipmentClientConfig } from "./LookoutEquipmentClient"; -/** - * @public - *

Amazon Lookout for Equipment is a machine learning service that uses advanced analytics to identify - * anomalies in machines from sensor data for use in predictive maintenance.

- */ -export class LookoutEquipment extends LookoutEquipmentClient { +const commands = { + CreateDatasetCommand, + CreateInferenceSchedulerCommand, + CreateLabelCommand, + CreateLabelGroupCommand, + CreateModelCommand, + DeleteDatasetCommand, + DeleteInferenceSchedulerCommand, + DeleteLabelCommand, + DeleteLabelGroupCommand, + DeleteModelCommand, + DescribeDataIngestionJobCommand, + DescribeDatasetCommand, + DescribeInferenceSchedulerCommand, + DescribeLabelCommand, + DescribeLabelGroupCommand, + DescribeModelCommand, + ListDataIngestionJobsCommand, + ListDatasetsCommand, + ListInferenceEventsCommand, + ListInferenceExecutionsCommand, + ListInferenceSchedulersCommand, + ListLabelGroupsCommand, + ListLabelsCommand, + ListModelsCommand, + ListSensorStatisticsCommand, + ListTagsForResourceCommand, + StartDataIngestionJobCommand, + StartInferenceSchedulerCommand, + StopInferenceSchedulerCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateInferenceSchedulerCommand, + UpdateLabelGroupCommand, +}; + +export interface LookoutEquipment { /** - * @public - *

Creates a container for a collection of data being ingested for analysis. The dataset - * contains the metadata describing where the data is and what the data actually looks like. - * In other words, it contains the location of the data source, the data schema, and other - * information. A dataset also contains any tags associated with the ingested data.

+ * @see {@link CreateDatasetCommand} */ - public createDataset( - args: CreateDatasetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createDataset( - args: CreateDatasetCommandInput, - cb: (err: any, data?: CreateDatasetCommandOutput) => void - ): void; - public createDataset( + createDataset(args: CreateDatasetCommandInput, options?: __HttpHandlerOptions): Promise; + createDataset(args: CreateDatasetCommandInput, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void; + createDataset( args: CreateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetCommandOutput) => void ): void; - public createDataset( - args: CreateDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDatasetCommandOutput) => void), - cb?: (err: any, data?: CreateDatasetCommandOutput) => void - ): Promise | void { - const command = new CreateDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a scheduled inference. Scheduling an inference is setting up a continuous - * real-time inference plan to analyze new measurement data. When setting up the schedule, you - * provide an S3 bucket location for the input data, assign it a delimiter between separate - * entries in the data, set an offset delay if desired, and set the frequency of inferencing. - * You must also provide an S3 bucket location for the output data.

+ * @see {@link CreateInferenceSchedulerCommand} */ - public createInferenceScheduler( + createInferenceScheduler( args: CreateInferenceSchedulerCommandInput, options?: __HttpHandlerOptions ): Promise; - public createInferenceScheduler( + createInferenceScheduler( args: CreateInferenceSchedulerCommandInput, cb: (err: any, data?: CreateInferenceSchedulerCommandOutput) => void ): void; - public createInferenceScheduler( + createInferenceScheduler( args: CreateInferenceSchedulerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInferenceSchedulerCommandOutput) => void ): void; - public createInferenceScheduler( - args: CreateInferenceSchedulerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateInferenceSchedulerCommandOutput) => void), - cb?: (err: any, data?: CreateInferenceSchedulerCommandOutput) => void - ): Promise | void { - const command = new CreateInferenceSchedulerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Creates a label for an event. - *

+ * @see {@link CreateLabelCommand} */ - public createLabel(args: CreateLabelCommandInput, options?: __HttpHandlerOptions): Promise; - public createLabel(args: CreateLabelCommandInput, cb: (err: any, data?: CreateLabelCommandOutput) => void): void; - public createLabel( + createLabel(args: CreateLabelCommandInput, options?: __HttpHandlerOptions): Promise; + createLabel(args: CreateLabelCommandInput, cb: (err: any, data?: CreateLabelCommandOutput) => void): void; + createLabel( args: CreateLabelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLabelCommandOutput) => void ): void; - public createLabel( - args: CreateLabelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLabelCommandOutput) => void), - cb?: (err: any, data?: CreateLabelCommandOutput) => void - ): Promise | void { - const command = new CreateLabelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Creates a group of labels. - *

+ * @see {@link CreateLabelGroupCommand} */ - public createLabelGroup( + createLabelGroup( args: CreateLabelGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLabelGroup( + createLabelGroup( args: CreateLabelGroupCommandInput, cb: (err: any, data?: CreateLabelGroupCommandOutput) => void ): void; - public createLabelGroup( + createLabelGroup( args: CreateLabelGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLabelGroupCommandOutput) => void ): void; - public createLabelGroup( - args: CreateLabelGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLabelGroupCommandOutput) => void), - cb?: (err: any, data?: CreateLabelGroupCommandOutput) => void - ): Promise | void { - const command = new CreateLabelGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an ML model for data inference.

- *

A machine-learning (ML) model is a mathematical model that finds patterns in your data. - * In Amazon Lookout for Equipment, the model learns the patterns of normal behavior and - * detects abnormal behavior that could be potential equipment failure (or maintenance - * events). The models are made by analyzing normal data and abnormalities in machine behavior - * that have already occurred.

- *

Your model is trained using a portion of the data from your dataset and uses that data - * to learn patterns of normal behavior and abnormal patterns that lead to equipment failure. - * Another portion of the data is used to evaluate the model's accuracy.

+ * @see {@link CreateModelCommand} */ - public createModel(args: CreateModelCommandInput, options?: __HttpHandlerOptions): Promise; - public createModel(args: CreateModelCommandInput, cb: (err: any, data?: CreateModelCommandOutput) => void): void; - public createModel( + createModel(args: CreateModelCommandInput, options?: __HttpHandlerOptions): Promise; + createModel(args: CreateModelCommandInput, cb: (err: any, data?: CreateModelCommandOutput) => void): void; + createModel( args: CreateModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateModelCommandOutput) => void ): void; - public createModel( - args: CreateModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateModelCommandOutput) => void), - cb?: (err: any, data?: CreateModelCommandOutput) => void - ): Promise | void { - const command = new CreateModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a dataset and associated artifacts. The operation will check to see if any - * inference scheduler or data ingestion job is currently using the dataset, and if there - * isn't, the dataset, its metadata, and any associated data stored in S3 will be deleted. - * This does not affect any models that used this dataset for training and evaluation, but - * does prevent it from being used in the future.

+ * @see {@link DeleteDatasetCommand} */ - public deleteDataset( - args: DeleteDatasetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDataset( - args: DeleteDatasetCommandInput, - cb: (err: any, data?: DeleteDatasetCommandOutput) => void - ): void; - public deleteDataset( + deleteDataset(args: DeleteDatasetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDataset(args: DeleteDatasetCommandInput, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void; + deleteDataset( args: DeleteDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetCommandOutput) => void ): void; - public deleteDataset( - args: DeleteDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDatasetCommandOutput) => void), - cb?: (err: any, data?: DeleteDatasetCommandOutput) => void - ): Promise | void { - const command = new DeleteDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an inference scheduler that has been set up. Already processed output results - * are not affected.

+ * @see {@link DeleteInferenceSchedulerCommand} */ - public deleteInferenceScheduler( + deleteInferenceScheduler( args: DeleteInferenceSchedulerCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInferenceScheduler( + deleteInferenceScheduler( args: DeleteInferenceSchedulerCommandInput, cb: (err: any, data?: DeleteInferenceSchedulerCommandOutput) => void ): void; - public deleteInferenceScheduler( + deleteInferenceScheduler( args: DeleteInferenceSchedulerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInferenceSchedulerCommandOutput) => void ): void; - public deleteInferenceScheduler( - args: DeleteInferenceSchedulerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInferenceSchedulerCommandOutput) => void), - cb?: (err: any, data?: DeleteInferenceSchedulerCommandOutput) => void - ): Promise | void { - const command = new DeleteInferenceSchedulerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Deletes a label. - *

+ * @see {@link DeleteLabelCommand} */ - public deleteLabel(args: DeleteLabelCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteLabel(args: DeleteLabelCommandInput, cb: (err: any, data?: DeleteLabelCommandOutput) => void): void; - public deleteLabel( + deleteLabel(args: DeleteLabelCommandInput, options?: __HttpHandlerOptions): Promise; + deleteLabel(args: DeleteLabelCommandInput, cb: (err: any, data?: DeleteLabelCommandOutput) => void): void; + deleteLabel( args: DeleteLabelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLabelCommandOutput) => void ): void; - public deleteLabel( - args: DeleteLabelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLabelCommandOutput) => void), - cb?: (err: any, data?: DeleteLabelCommandOutput) => void - ): Promise | void { - const command = new DeleteLabelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Deletes a group of labels. - *

+ * @see {@link DeleteLabelGroupCommand} */ - public deleteLabelGroup( + deleteLabelGroup( args: DeleteLabelGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLabelGroup( + deleteLabelGroup( args: DeleteLabelGroupCommandInput, cb: (err: any, data?: DeleteLabelGroupCommandOutput) => void ): void; - public deleteLabelGroup( + deleteLabelGroup( args: DeleteLabelGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLabelGroupCommandOutput) => void ): void; - public deleteLabelGroup( - args: DeleteLabelGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLabelGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteLabelGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteLabelGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an ML model currently available for Amazon Lookout for Equipment. This will - * prevent it from being used with an inference scheduler, even one that is already set up. - *

+ * @see {@link DeleteModelCommand} */ - public deleteModel(args: DeleteModelCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteModel(args: DeleteModelCommandInput, cb: (err: any, data?: DeleteModelCommandOutput) => void): void; - public deleteModel( + deleteModel(args: DeleteModelCommandInput, options?: __HttpHandlerOptions): Promise; + deleteModel(args: DeleteModelCommandInput, cb: (err: any, data?: DeleteModelCommandOutput) => void): void; + deleteModel( args: DeleteModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteModelCommandOutput) => void ): void; - public deleteModel( - args: DeleteModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteModelCommandOutput) => void), - cb?: (err: any, data?: DeleteModelCommandOutput) => void - ): Promise | void { - const command = new DeleteModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides information on a specific data ingestion job such as creation time, dataset - * ARN, and status.

+ * @see {@link DescribeDataIngestionJobCommand} */ - public describeDataIngestionJob( + describeDataIngestionJob( args: DescribeDataIngestionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDataIngestionJob( + describeDataIngestionJob( args: DescribeDataIngestionJobCommandInput, cb: (err: any, data?: DescribeDataIngestionJobCommandOutput) => void ): void; - public describeDataIngestionJob( + describeDataIngestionJob( args: DescribeDataIngestionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataIngestionJobCommandOutput) => void ): void; - public describeDataIngestionJob( - args: DescribeDataIngestionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDataIngestionJobCommandOutput) => void), - cb?: (err: any, data?: DescribeDataIngestionJobCommandOutput) => void - ): Promise | void { - const command = new DescribeDataIngestionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a JSON description of the data in each time series dataset, including names, - * column names, and data types.

+ * @see {@link DescribeDatasetCommand} */ - public describeDataset( + describeDataset( args: DescribeDatasetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDataset( - args: DescribeDatasetCommandInput, - cb: (err: any, data?: DescribeDatasetCommandOutput) => void - ): void; - public describeDataset( + describeDataset(args: DescribeDatasetCommandInput, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void; + describeDataset( args: DescribeDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetCommandOutput) => void ): void; - public describeDataset( - args: DescribeDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDatasetCommandOutput) => void), - cb?: (err: any, data?: DescribeDatasetCommandOutput) => void - ): Promise | void { - const command = new DescribeDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Specifies information about the inference scheduler being used, including name, model, - * status, and associated metadata

+ * @see {@link DescribeInferenceSchedulerCommand} */ - public describeInferenceScheduler( + describeInferenceScheduler( args: DescribeInferenceSchedulerCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInferenceScheduler( + describeInferenceScheduler( args: DescribeInferenceSchedulerCommandInput, cb: (err: any, data?: DescribeInferenceSchedulerCommandOutput) => void ): void; - public describeInferenceScheduler( + describeInferenceScheduler( args: DescribeInferenceSchedulerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInferenceSchedulerCommandOutput) => void ): void; - public describeInferenceScheduler( - args: DescribeInferenceSchedulerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInferenceSchedulerCommandOutput) => void), - cb?: (err: any, data?: DescribeInferenceSchedulerCommandOutput) => void - ): Promise | void { - const command = new DescribeInferenceSchedulerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns the name of the label. - *

+ * @see {@link DescribeLabelCommand} */ - public describeLabel( - args: DescribeLabelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeLabel( - args: DescribeLabelCommandInput, - cb: (err: any, data?: DescribeLabelCommandOutput) => void - ): void; - public describeLabel( + describeLabel(args: DescribeLabelCommandInput, options?: __HttpHandlerOptions): Promise; + describeLabel(args: DescribeLabelCommandInput, cb: (err: any, data?: DescribeLabelCommandOutput) => void): void; + describeLabel( args: DescribeLabelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLabelCommandOutput) => void ): void; - public describeLabel( - args: DescribeLabelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLabelCommandOutput) => void), - cb?: (err: any, data?: DescribeLabelCommandOutput) => void - ): Promise | void { - const command = new DescribeLabelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns information about the label group. - *

+ * @see {@link DescribeLabelGroupCommand} */ - public describeLabelGroup( + describeLabelGroup( args: DescribeLabelGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLabelGroup( + describeLabelGroup( args: DescribeLabelGroupCommandInput, cb: (err: any, data?: DescribeLabelGroupCommandOutput) => void ): void; - public describeLabelGroup( + describeLabelGroup( args: DescribeLabelGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLabelGroupCommandOutput) => void ): void; - public describeLabelGroup( - args: DescribeLabelGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLabelGroupCommandOutput) => void), - cb?: (err: any, data?: DescribeLabelGroupCommandOutput) => void - ): Promise | void { - const command = new DescribeLabelGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a JSON containing the overall information about a specific ML model, including - * model name and ARN, dataset, training and evaluation information, status, and so on. - *

+ * @see {@link DescribeModelCommand} */ - public describeModel( - args: DescribeModelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeModel( - args: DescribeModelCommandInput, - cb: (err: any, data?: DescribeModelCommandOutput) => void - ): void; - public describeModel( + describeModel(args: DescribeModelCommandInput, options?: __HttpHandlerOptions): Promise; + describeModel(args: DescribeModelCommandInput, cb: (err: any, data?: DescribeModelCommandOutput) => void): void; + describeModel( args: DescribeModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeModelCommandOutput) => void ): void; - public describeModel( - args: DescribeModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeModelCommandOutput) => void), - cb?: (err: any, data?: DescribeModelCommandOutput) => void - ): Promise | void { - const command = new DescribeModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a list of all data ingestion jobs, including dataset name and ARN, S3 location - * of the input data, status, and so on.

+ * @see {@link ListDataIngestionJobsCommand} */ - public listDataIngestionJobs( + listDataIngestionJobs( args: ListDataIngestionJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDataIngestionJobs( + listDataIngestionJobs( args: ListDataIngestionJobsCommandInput, cb: (err: any, data?: ListDataIngestionJobsCommandOutput) => void ): void; - public listDataIngestionJobs( + listDataIngestionJobs( args: ListDataIngestionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataIngestionJobsCommandOutput) => void ): void; - public listDataIngestionJobs( - args: ListDataIngestionJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDataIngestionJobsCommandOutput) => void), - cb?: (err: any, data?: ListDataIngestionJobsCommandOutput) => void - ): Promise | void { - const command = new ListDataIngestionJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all datasets currently available in your account, filtering on the dataset name. - *

+ * @see {@link ListDatasetsCommand} */ - public listDatasets( - args: ListDatasetsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void; - public listDatasets( + listDatasets(args: ListDatasetsCommandInput, options?: __HttpHandlerOptions): Promise; + listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void; + listDatasets( args: ListDatasetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetsCommandOutput) => void ): void; - public listDatasets( - args: ListDatasetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatasetsCommandOutput) => void), - cb?: (err: any, data?: ListDatasetsCommandOutput) => void - ): Promise | void { - const command = new ListDatasetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all inference events that have been found for the specified inference scheduler. - *

+ * @see {@link ListInferenceEventsCommand} */ - public listInferenceEvents( + listInferenceEvents( args: ListInferenceEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInferenceEvents( + listInferenceEvents( args: ListInferenceEventsCommandInput, cb: (err: any, data?: ListInferenceEventsCommandOutput) => void ): void; - public listInferenceEvents( + listInferenceEvents( args: ListInferenceEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInferenceEventsCommandOutput) => void ): void; - public listInferenceEvents( - args: ListInferenceEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInferenceEventsCommandOutput) => void), - cb?: (err: any, data?: ListInferenceEventsCommandOutput) => void - ): Promise | void { - const command = new ListInferenceEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all inference executions that have been performed by the specified inference - * scheduler.

+ * @see {@link ListInferenceExecutionsCommand} */ - public listInferenceExecutions( + listInferenceExecutions( args: ListInferenceExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInferenceExecutions( + listInferenceExecutions( args: ListInferenceExecutionsCommandInput, cb: (err: any, data?: ListInferenceExecutionsCommandOutput) => void ): void; - public listInferenceExecutions( + listInferenceExecutions( args: ListInferenceExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInferenceExecutionsCommandOutput) => void ): void; - public listInferenceExecutions( - args: ListInferenceExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInferenceExecutionsCommandOutput) => void), - cb?: (err: any, data?: ListInferenceExecutionsCommandOutput) => void - ): Promise | void { - const command = new ListInferenceExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of all inference schedulers currently available for your account. - *

+ * @see {@link ListInferenceSchedulersCommand} */ - public listInferenceSchedulers( + listInferenceSchedulers( args: ListInferenceSchedulersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInferenceSchedulers( + listInferenceSchedulers( args: ListInferenceSchedulersCommandInput, cb: (err: any, data?: ListInferenceSchedulersCommandOutput) => void ): void; - public listInferenceSchedulers( + listInferenceSchedulers( args: ListInferenceSchedulersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInferenceSchedulersCommandOutput) => void ): void; - public listInferenceSchedulers( - args: ListInferenceSchedulersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInferenceSchedulersCommandOutput) => void), - cb?: (err: any, data?: ListInferenceSchedulersCommandOutput) => void - ): Promise | void { - const command = new ListInferenceSchedulersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns a list of the label groups. - *

+ * @see {@link ListLabelGroupsCommand} */ - public listLabelGroups( + listLabelGroups( args: ListLabelGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLabelGroups( - args: ListLabelGroupsCommandInput, - cb: (err: any, data?: ListLabelGroupsCommandOutput) => void - ): void; - public listLabelGroups( + listLabelGroups(args: ListLabelGroupsCommandInput, cb: (err: any, data?: ListLabelGroupsCommandOutput) => void): void; + listLabelGroups( args: ListLabelGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLabelGroupsCommandOutput) => void ): void; - public listLabelGroups( - args: ListLabelGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLabelGroupsCommandOutput) => void), - cb?: (err: any, data?: ListLabelGroupsCommandOutput) => void - ): Promise | void { - const command = new ListLabelGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Provides a list of labels. - *

+ * @see {@link ListLabelsCommand} */ - public listLabels(args: ListLabelsCommandInput, options?: __HttpHandlerOptions): Promise; - public listLabels(args: ListLabelsCommandInput, cb: (err: any, data?: ListLabelsCommandOutput) => void): void; - public listLabels( + listLabels(args: ListLabelsCommandInput, options?: __HttpHandlerOptions): Promise; + listLabels(args: ListLabelsCommandInput, cb: (err: any, data?: ListLabelsCommandOutput) => void): void; + listLabels( args: ListLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLabelsCommandOutput) => void ): void; - public listLabels( - args: ListLabelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLabelsCommandOutput) => void), - cb?: (err: any, data?: ListLabelsCommandOutput) => void - ): Promise | void { - const command = new ListLabelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Generates a list of all models in the account, including model name and ARN, dataset, - * and status.

+ * @see {@link ListModelsCommand} */ - public listModels(args: ListModelsCommandInput, options?: __HttpHandlerOptions): Promise; - public listModels(args: ListModelsCommandInput, cb: (err: any, data?: ListModelsCommandOutput) => void): void; - public listModels( + listModels(args: ListModelsCommandInput, options?: __HttpHandlerOptions): Promise; + listModels(args: ListModelsCommandInput, cb: (err: any, data?: ListModelsCommandOutput) => void): void; + listModels( args: ListModelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListModelsCommandOutput) => void ): void; - public listModels( - args: ListModelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListModelsCommandOutput) => void), - cb?: (err: any, data?: ListModelsCommandOutput) => void - ): Promise | void { - const command = new ListModelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists statistics about the data collected for each of the sensors that have been - * successfully ingested in the particular dataset. Can also be used to retreive Sensor - * Statistics for a previous ingestion job.

+ * @see {@link ListSensorStatisticsCommand} */ - public listSensorStatistics( + listSensorStatistics( args: ListSensorStatisticsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSensorStatistics( + listSensorStatistics( args: ListSensorStatisticsCommandInput, cb: (err: any, data?: ListSensorStatisticsCommandOutput) => void ): void; - public listSensorStatistics( + listSensorStatistics( args: ListSensorStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSensorStatisticsCommandOutput) => void ): void; - public listSensorStatistics( - args: ListSensorStatisticsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSensorStatisticsCommandOutput) => void), - cb?: (err: any, data?: ListSensorStatisticsCommandOutput) => void - ): Promise | void { - const command = new ListSensorStatisticsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the tags for a specified resource, including key and value.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a data ingestion job. Amazon Lookout for Equipment returns the job status. - *

+ * @see {@link StartDataIngestionJobCommand} */ - public startDataIngestionJob( + startDataIngestionJob( args: StartDataIngestionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDataIngestionJob( + startDataIngestionJob( args: StartDataIngestionJobCommandInput, cb: (err: any, data?: StartDataIngestionJobCommandOutput) => void ): void; - public startDataIngestionJob( + startDataIngestionJob( args: StartDataIngestionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDataIngestionJobCommandOutput) => void ): void; - public startDataIngestionJob( - args: StartDataIngestionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDataIngestionJobCommandOutput) => void), - cb?: (err: any, data?: StartDataIngestionJobCommandOutput) => void - ): Promise | void { - const command = new StartDataIngestionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts an inference scheduler.

+ * @see {@link StartInferenceSchedulerCommand} */ - public startInferenceScheduler( + startInferenceScheduler( args: StartInferenceSchedulerCommandInput, options?: __HttpHandlerOptions ): Promise; - public startInferenceScheduler( + startInferenceScheduler( args: StartInferenceSchedulerCommandInput, cb: (err: any, data?: StartInferenceSchedulerCommandOutput) => void ): void; - public startInferenceScheduler( + startInferenceScheduler( args: StartInferenceSchedulerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartInferenceSchedulerCommandOutput) => void ): void; - public startInferenceScheduler( - args: StartInferenceSchedulerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartInferenceSchedulerCommandOutput) => void), - cb?: (err: any, data?: StartInferenceSchedulerCommandOutput) => void - ): Promise | void { - const command = new StartInferenceSchedulerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops an inference scheduler.

+ * @see {@link StopInferenceSchedulerCommand} */ - public stopInferenceScheduler( + stopInferenceScheduler( args: StopInferenceSchedulerCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopInferenceScheduler( + stopInferenceScheduler( args: StopInferenceSchedulerCommandInput, cb: (err: any, data?: StopInferenceSchedulerCommandOutput) => void ): void; - public stopInferenceScheduler( + stopInferenceScheduler( args: StopInferenceSchedulerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopInferenceSchedulerCommandOutput) => void ): void; - public stopInferenceScheduler( - args: StopInferenceSchedulerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopInferenceSchedulerCommandOutput) => void), - cb?: (err: any, data?: StopInferenceSchedulerCommandOutput) => void - ): Promise | void { - const command = new StopInferenceSchedulerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a given tag to a resource in your account. A tag is a key-value pair which - * can be added to an Amazon Lookout for Equipment resource as metadata. Tags can be used for - * organizing your resources as well as helping you to search and filter by tag. Multiple tags - * can be added to a resource, either when you create it, or later. Up to 50 tags can be - * associated with each resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a specific tag from a given resource. The tag is specified by its key.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an inference scheduler.

+ * @see {@link UpdateInferenceSchedulerCommand} */ - public updateInferenceScheduler( + updateInferenceScheduler( args: UpdateInferenceSchedulerCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateInferenceScheduler( + updateInferenceScheduler( args: UpdateInferenceSchedulerCommandInput, cb: (err: any, data?: UpdateInferenceSchedulerCommandOutput) => void ): void; - public updateInferenceScheduler( + updateInferenceScheduler( args: UpdateInferenceSchedulerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateInferenceSchedulerCommandOutput) => void ): void; - public updateInferenceScheduler( - args: UpdateInferenceSchedulerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateInferenceSchedulerCommandOutput) => void), - cb?: (err: any, data?: UpdateInferenceSchedulerCommandOutput) => void - ): Promise | void { - const command = new UpdateInferenceSchedulerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Updates the label group. - *

+ * @see {@link UpdateLabelGroupCommand} */ - public updateLabelGroup( + updateLabelGroup( args: UpdateLabelGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLabelGroup( + updateLabelGroup( args: UpdateLabelGroupCommandInput, cb: (err: any, data?: UpdateLabelGroupCommandOutput) => void ): void; - public updateLabelGroup( + updateLabelGroup( args: UpdateLabelGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLabelGroupCommandOutput) => void ): void; - public updateLabelGroup( - args: UpdateLabelGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLabelGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateLabelGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateLabelGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Lookout for Equipment is a machine learning service that uses advanced analytics to identify + * anomalies in machines from sensor data for use in predictive maintenance.

+ */ +export class LookoutEquipment extends LookoutEquipmentClient implements LookoutEquipment {} +createAggregatedClient(commands, LookoutEquipment); diff --git a/clients/client-lookoutmetrics/src/LookoutMetrics.ts b/clients/client-lookoutmetrics/src/LookoutMetrics.ts index 35504b0800ba..5f36a5c5c5b3 100644 --- a/clients/client-lookoutmetrics/src/LookoutMetrics.ts +++ b/clients/client-lookoutmetrics/src/LookoutMetrics.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -123,974 +124,486 @@ import { UpdateMetricSetCommandInput, UpdateMetricSetCommandOutput, } from "./commands/UpdateMetricSetCommand"; -import { LookoutMetricsClient } from "./LookoutMetricsClient"; +import { LookoutMetricsClient, LookoutMetricsClientConfig } from "./LookoutMetricsClient"; -/** - * @public - *

This is the Amazon Lookout for Metrics API Reference. For an introduction to the service - * with tutorials for getting started, visit Amazon - * Lookout for Metrics Developer Guide.

- */ -export class LookoutMetrics extends LookoutMetricsClient { +const commands = { + ActivateAnomalyDetectorCommand, + BackTestAnomalyDetectorCommand, + CreateAlertCommand, + CreateAnomalyDetectorCommand, + CreateMetricSetCommand, + DeactivateAnomalyDetectorCommand, + DeleteAlertCommand, + DeleteAnomalyDetectorCommand, + DescribeAlertCommand, + DescribeAnomalyDetectionExecutionsCommand, + DescribeAnomalyDetectorCommand, + DescribeMetricSetCommand, + DetectMetricSetConfigCommand, + GetAnomalyGroupCommand, + GetDataQualityMetricsCommand, + GetFeedbackCommand, + GetSampleDataCommand, + ListAlertsCommand, + ListAnomalyDetectorsCommand, + ListAnomalyGroupRelatedMetricsCommand, + ListAnomalyGroupSummariesCommand, + ListAnomalyGroupTimeSeriesCommand, + ListMetricSetsCommand, + ListTagsForResourceCommand, + PutFeedbackCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAlertCommand, + UpdateAnomalyDetectorCommand, + UpdateMetricSetCommand, +}; + +export interface LookoutMetrics { /** - * @public - *

Activates an anomaly detector.

+ * @see {@link ActivateAnomalyDetectorCommand} */ - public activateAnomalyDetector( + activateAnomalyDetector( args: ActivateAnomalyDetectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public activateAnomalyDetector( + activateAnomalyDetector( args: ActivateAnomalyDetectorCommandInput, cb: (err: any, data?: ActivateAnomalyDetectorCommandOutput) => void ): void; - public activateAnomalyDetector( + activateAnomalyDetector( args: ActivateAnomalyDetectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ActivateAnomalyDetectorCommandOutput) => void ): void; - public activateAnomalyDetector( - args: ActivateAnomalyDetectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ActivateAnomalyDetectorCommandOutput) => void), - cb?: (err: any, data?: ActivateAnomalyDetectorCommandOutput) => void - ): Promise | void { - const command = new ActivateAnomalyDetectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Runs a backtest for anomaly detection for the specified resource.

+ * @see {@link BackTestAnomalyDetectorCommand} */ - public backTestAnomalyDetector( + backTestAnomalyDetector( args: BackTestAnomalyDetectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public backTestAnomalyDetector( + backTestAnomalyDetector( args: BackTestAnomalyDetectorCommandInput, cb: (err: any, data?: BackTestAnomalyDetectorCommandOutput) => void ): void; - public backTestAnomalyDetector( + backTestAnomalyDetector( args: BackTestAnomalyDetectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BackTestAnomalyDetectorCommandOutput) => void ): void; - public backTestAnomalyDetector( - args: BackTestAnomalyDetectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BackTestAnomalyDetectorCommandOutput) => void), - cb?: (err: any, data?: BackTestAnomalyDetectorCommandOutput) => void - ): Promise | void { - const command = new BackTestAnomalyDetectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an alert for an anomaly detector.

+ * @see {@link CreateAlertCommand} */ - public createAlert(args: CreateAlertCommandInput, options?: __HttpHandlerOptions): Promise; - public createAlert(args: CreateAlertCommandInput, cb: (err: any, data?: CreateAlertCommandOutput) => void): void; - public createAlert( + createAlert(args: CreateAlertCommandInput, options?: __HttpHandlerOptions): Promise; + createAlert(args: CreateAlertCommandInput, cb: (err: any, data?: CreateAlertCommandOutput) => void): void; + createAlert( args: CreateAlertCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAlertCommandOutput) => void ): void; - public createAlert( - args: CreateAlertCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAlertCommandOutput) => void), - cb?: (err: any, data?: CreateAlertCommandOutput) => void - ): Promise | void { - const command = new CreateAlertCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an anomaly detector.

+ * @see {@link CreateAnomalyDetectorCommand} */ - public createAnomalyDetector( + createAnomalyDetector( args: CreateAnomalyDetectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAnomalyDetector( + createAnomalyDetector( args: CreateAnomalyDetectorCommandInput, cb: (err: any, data?: CreateAnomalyDetectorCommandOutput) => void ): void; - public createAnomalyDetector( + createAnomalyDetector( args: CreateAnomalyDetectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAnomalyDetectorCommandOutput) => void ): void; - public createAnomalyDetector( - args: CreateAnomalyDetectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAnomalyDetectorCommandOutput) => void), - cb?: (err: any, data?: CreateAnomalyDetectorCommandOutput) => void - ): Promise | void { - const command = new CreateAnomalyDetectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a dataset.

+ * @see {@link CreateMetricSetCommand} */ - public createMetricSet( + createMetricSet( args: CreateMetricSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMetricSet( - args: CreateMetricSetCommandInput, - cb: (err: any, data?: CreateMetricSetCommandOutput) => void - ): void; - public createMetricSet( + createMetricSet(args: CreateMetricSetCommandInput, cb: (err: any, data?: CreateMetricSetCommandOutput) => void): void; + createMetricSet( args: CreateMetricSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMetricSetCommandOutput) => void ): void; - public createMetricSet( - args: CreateMetricSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMetricSetCommandOutput) => void), - cb?: (err: any, data?: CreateMetricSetCommandOutput) => void - ): Promise | void { - const command = new CreateMetricSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deactivates an anomaly detector.

+ * @see {@link DeactivateAnomalyDetectorCommand} */ - public deactivateAnomalyDetector( + deactivateAnomalyDetector( args: DeactivateAnomalyDetectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deactivateAnomalyDetector( + deactivateAnomalyDetector( args: DeactivateAnomalyDetectorCommandInput, cb: (err: any, data?: DeactivateAnomalyDetectorCommandOutput) => void ): void; - public deactivateAnomalyDetector( + deactivateAnomalyDetector( args: DeactivateAnomalyDetectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeactivateAnomalyDetectorCommandOutput) => void ): void; - public deactivateAnomalyDetector( - args: DeactivateAnomalyDetectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeactivateAnomalyDetectorCommandOutput) => void), - cb?: (err: any, data?: DeactivateAnomalyDetectorCommandOutput) => void - ): Promise | void { - const command = new DeactivateAnomalyDetectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an alert.

+ * @see {@link DeleteAlertCommand} */ - public deleteAlert(args: DeleteAlertCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteAlert(args: DeleteAlertCommandInput, cb: (err: any, data?: DeleteAlertCommandOutput) => void): void; - public deleteAlert( + deleteAlert(args: DeleteAlertCommandInput, options?: __HttpHandlerOptions): Promise; + deleteAlert(args: DeleteAlertCommandInput, cb: (err: any, data?: DeleteAlertCommandOutput) => void): void; + deleteAlert( args: DeleteAlertCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAlertCommandOutput) => void ): void; - public deleteAlert( - args: DeleteAlertCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAlertCommandOutput) => void), - cb?: (err: any, data?: DeleteAlertCommandOutput) => void - ): Promise | void { - const command = new DeleteAlertCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any - * configured datasets and alerts.

+ * @see {@link DeleteAnomalyDetectorCommand} */ - public deleteAnomalyDetector( + deleteAnomalyDetector( args: DeleteAnomalyDetectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAnomalyDetector( + deleteAnomalyDetector( args: DeleteAnomalyDetectorCommandInput, cb: (err: any, data?: DeleteAnomalyDetectorCommandOutput) => void ): void; - public deleteAnomalyDetector( + deleteAnomalyDetector( args: DeleteAnomalyDetectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAnomalyDetectorCommandOutput) => void ): void; - public deleteAnomalyDetector( - args: DeleteAnomalyDetectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAnomalyDetectorCommandOutput) => void), - cb?: (err: any, data?: DeleteAnomalyDetectorCommandOutput) => void - ): Promise | void { - const command = new DeleteAnomalyDetectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an alert.

- *

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource - * immediately after creating or modifying it, use retries to allow time for the write operation to complete.

+ * @see {@link DescribeAlertCommand} */ - public describeAlert( - args: DescribeAlertCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeAlert( - args: DescribeAlertCommandInput, - cb: (err: any, data?: DescribeAlertCommandOutput) => void - ): void; - public describeAlert( + describeAlert(args: DescribeAlertCommandInput, options?: __HttpHandlerOptions): Promise; + describeAlert(args: DescribeAlertCommandInput, cb: (err: any, data?: DescribeAlertCommandOutput) => void): void; + describeAlert( args: DescribeAlertCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAlertCommandOutput) => void ): void; - public describeAlert( - args: DescribeAlertCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAlertCommandOutput) => void), - cb?: (err: any, data?: DescribeAlertCommandOutput) => void - ): Promise | void { - const command = new DescribeAlertCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the status of the specified anomaly detection jobs.

+ * @see {@link DescribeAnomalyDetectionExecutionsCommand} */ - public describeAnomalyDetectionExecutions( + describeAnomalyDetectionExecutions( args: DescribeAnomalyDetectionExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAnomalyDetectionExecutions( + describeAnomalyDetectionExecutions( args: DescribeAnomalyDetectionExecutionsCommandInput, cb: (err: any, data?: DescribeAnomalyDetectionExecutionsCommandOutput) => void ): void; - public describeAnomalyDetectionExecutions( + describeAnomalyDetectionExecutions( args: DescribeAnomalyDetectionExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAnomalyDetectionExecutionsCommandOutput) => void ): void; - public describeAnomalyDetectionExecutions( - args: DescribeAnomalyDetectionExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAnomalyDetectionExecutionsCommandOutput) => void), - cb?: (err: any, data?: DescribeAnomalyDetectionExecutionsCommandOutput) => void - ): Promise | void { - const command = new DescribeAnomalyDetectionExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a detector.

- *

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource - * immediately after creating or modifying it, use retries to allow time for the write operation to complete.

+ * @see {@link DescribeAnomalyDetectorCommand} */ - public describeAnomalyDetector( + describeAnomalyDetector( args: DescribeAnomalyDetectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAnomalyDetector( + describeAnomalyDetector( args: DescribeAnomalyDetectorCommandInput, cb: (err: any, data?: DescribeAnomalyDetectorCommandOutput) => void ): void; - public describeAnomalyDetector( + describeAnomalyDetector( args: DescribeAnomalyDetectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAnomalyDetectorCommandOutput) => void ): void; - public describeAnomalyDetector( - args: DescribeAnomalyDetectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAnomalyDetectorCommandOutput) => void), - cb?: (err: any, data?: DescribeAnomalyDetectorCommandOutput) => void - ): Promise | void { - const command = new DescribeAnomalyDetectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a dataset.

- *

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource - * immediately after creating or modifying it, use retries to allow time for the write operation to complete.

+ * @see {@link DescribeMetricSetCommand} */ - public describeMetricSet( + describeMetricSet( args: DescribeMetricSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMetricSet( + describeMetricSet( args: DescribeMetricSetCommandInput, cb: (err: any, data?: DescribeMetricSetCommandOutput) => void ): void; - public describeMetricSet( + describeMetricSet( args: DescribeMetricSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMetricSetCommandOutput) => void ): void; - public describeMetricSet( - args: DescribeMetricSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMetricSetCommandOutput) => void), - cb?: (err: any, data?: DescribeMetricSetCommandOutput) => void - ): Promise | void { - const command = new DescribeMetricSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Detects an Amazon S3 dataset's file format, interval, and offset.

+ * @see {@link DetectMetricSetConfigCommand} */ - public detectMetricSetConfig( + detectMetricSetConfig( args: DetectMetricSetConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public detectMetricSetConfig( + detectMetricSetConfig( args: DetectMetricSetConfigCommandInput, cb: (err: any, data?: DetectMetricSetConfigCommandOutput) => void ): void; - public detectMetricSetConfig( + detectMetricSetConfig( args: DetectMetricSetConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectMetricSetConfigCommandOutput) => void ): void; - public detectMetricSetConfig( - args: DetectMetricSetConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectMetricSetConfigCommandOutput) => void), - cb?: (err: any, data?: DetectMetricSetConfigCommandOutput) => void - ): Promise | void { - const command = new DetectMetricSetConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns details about a group of anomalous metrics.

+ * @see {@link GetAnomalyGroupCommand} */ - public getAnomalyGroup( + getAnomalyGroup( args: GetAnomalyGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAnomalyGroup( - args: GetAnomalyGroupCommandInput, - cb: (err: any, data?: GetAnomalyGroupCommandOutput) => void - ): void; - public getAnomalyGroup( + getAnomalyGroup(args: GetAnomalyGroupCommandInput, cb: (err: any, data?: GetAnomalyGroupCommandOutput) => void): void; + getAnomalyGroup( args: GetAnomalyGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAnomalyGroupCommandOutput) => void ): void; - public getAnomalyGroup( - args: GetAnomalyGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAnomalyGroupCommandOutput) => void), - cb?: (err: any, data?: GetAnomalyGroupCommandOutput) => void - ): Promise | void { - const command = new GetAnomalyGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns details about the requested data quality metrics.

+ * @see {@link GetDataQualityMetricsCommand} */ - public getDataQualityMetrics( + getDataQualityMetrics( args: GetDataQualityMetricsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDataQualityMetrics( + getDataQualityMetrics( args: GetDataQualityMetricsCommandInput, cb: (err: any, data?: GetDataQualityMetricsCommandOutput) => void ): void; - public getDataQualityMetrics( + getDataQualityMetrics( args: GetDataQualityMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataQualityMetricsCommandOutput) => void ): void; - public getDataQualityMetrics( - args: GetDataQualityMetricsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDataQualityMetricsCommandOutput) => void), - cb?: (err: any, data?: GetDataQualityMetricsCommandOutput) => void - ): Promise | void { - const command = new GetDataQualityMetricsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get feedback for an anomaly group.

+ * @see {@link GetFeedbackCommand} */ - public getFeedback(args: GetFeedbackCommandInput, options?: __HttpHandlerOptions): Promise; - public getFeedback(args: GetFeedbackCommandInput, cb: (err: any, data?: GetFeedbackCommandOutput) => void): void; - public getFeedback( + getFeedback(args: GetFeedbackCommandInput, options?: __HttpHandlerOptions): Promise; + getFeedback(args: GetFeedbackCommandInput, cb: (err: any, data?: GetFeedbackCommandOutput) => void): void; + getFeedback( args: GetFeedbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFeedbackCommandOutput) => void ): void; - public getFeedback( - args: GetFeedbackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFeedbackCommandOutput) => void), - cb?: (err: any, data?: GetFeedbackCommandOutput) => void - ): Promise | void { - const command = new GetFeedbackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a selection of sample records from an Amazon S3 datasource.

+ * @see {@link GetSampleDataCommand} */ - public getSampleData( - args: GetSampleDataCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getSampleData( - args: GetSampleDataCommandInput, - cb: (err: any, data?: GetSampleDataCommandOutput) => void - ): void; - public getSampleData( + getSampleData(args: GetSampleDataCommandInput, options?: __HttpHandlerOptions): Promise; + getSampleData(args: GetSampleDataCommandInput, cb: (err: any, data?: GetSampleDataCommandOutput) => void): void; + getSampleData( args: GetSampleDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSampleDataCommandOutput) => void ): void; - public getSampleData( - args: GetSampleDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSampleDataCommandOutput) => void), - cb?: (err: any, data?: GetSampleDataCommandOutput) => void - ): Promise | void { - const command = new GetSampleDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the alerts attached to a detector.

- *

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource - * immediately after creating or modifying it, use retries to allow time for the write operation to complete.

+ * @see {@link ListAlertsCommand} */ - public listAlerts(args: ListAlertsCommandInput, options?: __HttpHandlerOptions): Promise; - public listAlerts(args: ListAlertsCommandInput, cb: (err: any, data?: ListAlertsCommandOutput) => void): void; - public listAlerts( + listAlerts(args: ListAlertsCommandInput, options?: __HttpHandlerOptions): Promise; + listAlerts(args: ListAlertsCommandInput, cb: (err: any, data?: ListAlertsCommandOutput) => void): void; + listAlerts( args: ListAlertsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAlertsCommandOutput) => void ): void; - public listAlerts( - args: ListAlertsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAlertsCommandOutput) => void), - cb?: (err: any, data?: ListAlertsCommandOutput) => void - ): Promise | void { - const command = new ListAlertsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the detectors in the current AWS Region.

- *

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource - * immediately after creating or modifying it, use retries to allow time for the write operation to complete.

+ * @see {@link ListAnomalyDetectorsCommand} */ - public listAnomalyDetectors( + listAnomalyDetectors( args: ListAnomalyDetectorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAnomalyDetectors( + listAnomalyDetectors( args: ListAnomalyDetectorsCommandInput, cb: (err: any, data?: ListAnomalyDetectorsCommandOutput) => void ): void; - public listAnomalyDetectors( + listAnomalyDetectors( args: ListAnomalyDetectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAnomalyDetectorsCommandOutput) => void ): void; - public listAnomalyDetectors( - args: ListAnomalyDetectorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAnomalyDetectorsCommandOutput) => void), - cb?: (err: any, data?: ListAnomalyDetectorsCommandOutput) => void - ): Promise | void { - const command = new ListAnomalyDetectorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of measures that are potential causes or effects of an - * anomaly group.

+ * @see {@link ListAnomalyGroupRelatedMetricsCommand} */ - public listAnomalyGroupRelatedMetrics( + listAnomalyGroupRelatedMetrics( args: ListAnomalyGroupRelatedMetricsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAnomalyGroupRelatedMetrics( + listAnomalyGroupRelatedMetrics( args: ListAnomalyGroupRelatedMetricsCommandInput, cb: (err: any, data?: ListAnomalyGroupRelatedMetricsCommandOutput) => void ): void; - public listAnomalyGroupRelatedMetrics( + listAnomalyGroupRelatedMetrics( args: ListAnomalyGroupRelatedMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAnomalyGroupRelatedMetricsCommandOutput) => void ): void; - public listAnomalyGroupRelatedMetrics( - args: ListAnomalyGroupRelatedMetricsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAnomalyGroupRelatedMetricsCommandOutput) => void), - cb?: (err: any, data?: ListAnomalyGroupRelatedMetricsCommandOutput) => void - ): Promise | void { - const command = new ListAnomalyGroupRelatedMetricsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of anomaly groups.

+ * @see {@link ListAnomalyGroupSummariesCommand} */ - public listAnomalyGroupSummaries( + listAnomalyGroupSummaries( args: ListAnomalyGroupSummariesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAnomalyGroupSummaries( + listAnomalyGroupSummaries( args: ListAnomalyGroupSummariesCommandInput, cb: (err: any, data?: ListAnomalyGroupSummariesCommandOutput) => void ): void; - public listAnomalyGroupSummaries( + listAnomalyGroupSummaries( args: ListAnomalyGroupSummariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAnomalyGroupSummariesCommandOutput) => void ): void; - public listAnomalyGroupSummaries( - args: ListAnomalyGroupSummariesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAnomalyGroupSummariesCommandOutput) => void), - cb?: (err: any, data?: ListAnomalyGroupSummariesCommandOutput) => void - ): Promise | void { - const command = new ListAnomalyGroupSummariesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of anomalous metrics for a measure in an anomaly group.

+ * @see {@link ListAnomalyGroupTimeSeriesCommand} */ - public listAnomalyGroupTimeSeries( + listAnomalyGroupTimeSeries( args: ListAnomalyGroupTimeSeriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAnomalyGroupTimeSeries( + listAnomalyGroupTimeSeries( args: ListAnomalyGroupTimeSeriesCommandInput, cb: (err: any, data?: ListAnomalyGroupTimeSeriesCommandOutput) => void ): void; - public listAnomalyGroupTimeSeries( + listAnomalyGroupTimeSeries( args: ListAnomalyGroupTimeSeriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAnomalyGroupTimeSeriesCommandOutput) => void ): void; - public listAnomalyGroupTimeSeries( - args: ListAnomalyGroupTimeSeriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAnomalyGroupTimeSeriesCommandOutput) => void), - cb?: (err: any, data?: ListAnomalyGroupTimeSeriesCommandOutput) => void - ): Promise | void { - const command = new ListAnomalyGroupTimeSeriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the datasets in the current AWS Region.

- *

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource - * immediately after creating or modifying it, use retries to allow time for the write operation to complete.

+ * @see {@link ListMetricSetsCommand} */ - public listMetricSets( + listMetricSets( args: ListMetricSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMetricSets( - args: ListMetricSetsCommandInput, - cb: (err: any, data?: ListMetricSetsCommandOutput) => void - ): void; - public listMetricSets( + listMetricSets(args: ListMetricSetsCommandInput, cb: (err: any, data?: ListMetricSetsCommandOutput) => void): void; + listMetricSets( args: ListMetricSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMetricSetsCommandOutput) => void ): void; - public listMetricSets( - args: ListMetricSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMetricSetsCommandOutput) => void), - cb?: (err: any, data?: ListMetricSetsCommandOutput) => void - ): Promise | void { - const command = new ListMetricSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of tags for a detector, dataset, or alert.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Add feedback for an anomalous metric.

+ * @see {@link PutFeedbackCommand} */ - public putFeedback(args: PutFeedbackCommandInput, options?: __HttpHandlerOptions): Promise; - public putFeedback(args: PutFeedbackCommandInput, cb: (err: any, data?: PutFeedbackCommandOutput) => void): void; - public putFeedback( + putFeedback(args: PutFeedbackCommandInput, options?: __HttpHandlerOptions): Promise; + putFeedback(args: PutFeedbackCommandInput, cb: (err: any, data?: PutFeedbackCommandOutput) => void): void; + putFeedback( args: PutFeedbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutFeedbackCommandOutput) => void ): void; - public putFeedback( - args: PutFeedbackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutFeedbackCommandOutput) => void), - cb?: (err: any, data?: PutFeedbackCommandOutput) => void - ): Promise | void { - const command = new PutFeedbackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds tags to a detector, dataset, or alert.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from a detector, dataset, or alert.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Make changes to an existing alert.

+ * @see {@link UpdateAlertCommand} */ - public updateAlert(args: UpdateAlertCommandInput, options?: __HttpHandlerOptions): Promise; - public updateAlert(args: UpdateAlertCommandInput, cb: (err: any, data?: UpdateAlertCommandOutput) => void): void; - public updateAlert( + updateAlert(args: UpdateAlertCommandInput, options?: __HttpHandlerOptions): Promise; + updateAlert(args: UpdateAlertCommandInput, cb: (err: any, data?: UpdateAlertCommandOutput) => void): void; + updateAlert( args: UpdateAlertCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAlertCommandOutput) => void ): void; - public updateAlert( - args: UpdateAlertCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAlertCommandOutput) => void), - cb?: (err: any, data?: UpdateAlertCommandOutput) => void - ): Promise | void { - const command = new UpdateAlertCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a detector. After activation, you can only change a detector's ingestion delay and description.

+ * @see {@link UpdateAnomalyDetectorCommand} */ - public updateAnomalyDetector( + updateAnomalyDetector( args: UpdateAnomalyDetectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAnomalyDetector( + updateAnomalyDetector( args: UpdateAnomalyDetectorCommandInput, cb: (err: any, data?: UpdateAnomalyDetectorCommandOutput) => void ): void; - public updateAnomalyDetector( + updateAnomalyDetector( args: UpdateAnomalyDetectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAnomalyDetectorCommandOutput) => void ): void; - public updateAnomalyDetector( - args: UpdateAnomalyDetectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAnomalyDetectorCommandOutput) => void), - cb?: (err: any, data?: UpdateAnomalyDetectorCommandOutput) => void - ): Promise | void { - const command = new UpdateAnomalyDetectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a dataset.

+ * @see {@link UpdateMetricSetCommand} */ - public updateMetricSet( + updateMetricSet( args: UpdateMetricSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMetricSet( - args: UpdateMetricSetCommandInput, - cb: (err: any, data?: UpdateMetricSetCommandOutput) => void - ): void; - public updateMetricSet( + updateMetricSet(args: UpdateMetricSetCommandInput, cb: (err: any, data?: UpdateMetricSetCommandOutput) => void): void; + updateMetricSet( args: UpdateMetricSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMetricSetCommandOutput) => void ): void; - public updateMetricSet( - args: UpdateMetricSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMetricSetCommandOutput) => void), - cb?: (err: any, data?: UpdateMetricSetCommandOutput) => void - ): Promise | void { - const command = new UpdateMetricSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

This is the Amazon Lookout for Metrics API Reference. For an introduction to the service + * with tutorials for getting started, visit Amazon + * Lookout for Metrics Developer Guide.

+ */ +export class LookoutMetrics extends LookoutMetricsClient implements LookoutMetrics {} +createAggregatedClient(commands, LookoutMetrics); diff --git a/clients/client-lookoutvision/src/LookoutVision.ts b/clients/client-lookoutvision/src/LookoutVision.ts index 5067dab90a5c..3a40f28c2caa 100644 --- a/clients/client-lookoutvision/src/LookoutVision.ts +++ b/clients/client-lookoutvision/src/LookoutVision.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -87,894 +88,331 @@ import { UpdateDatasetEntriesCommandInput, UpdateDatasetEntriesCommandOutput, } from "./commands/UpdateDatasetEntriesCommand"; -import { LookoutVisionClient } from "./LookoutVisionClient"; +import { LookoutVisionClient, LookoutVisionClientConfig } from "./LookoutVisionClient"; -/** - * @public - *

This is the Amazon Lookout for Vision API Reference. It provides descriptions of actions, - * data types, common parameters, and common errors.

- *

Amazon Lookout for Vision enables you to find visual defects in industrial products, - * accurately and at scale. It uses computer vision to identify missing components in an industrial product, - * damage to vehicles or structures, irregularities in production lines, and even minuscule defects in - * silicon wafers — or any other physical item where quality is important such as a missing capacitor - * on printed circuit boards.

- */ -export class LookoutVision extends LookoutVisionClient { +const commands = { + CreateDatasetCommand, + CreateModelCommand, + CreateProjectCommand, + DeleteDatasetCommand, + DeleteModelCommand, + DeleteProjectCommand, + DescribeDatasetCommand, + DescribeModelCommand, + DescribeModelPackagingJobCommand, + DescribeProjectCommand, + DetectAnomaliesCommand, + ListDatasetEntriesCommand, + ListModelPackagingJobsCommand, + ListModelsCommand, + ListProjectsCommand, + ListTagsForResourceCommand, + StartModelCommand, + StartModelPackagingJobCommand, + StopModelCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateDatasetEntriesCommand, +}; + +export interface LookoutVision { /** - * @public - *

Creates a new dataset in an Amazon Lookout for Vision project. CreateDataset can create a - * training or a test dataset from a valid dataset source (DatasetSource).

- *

If you want a single dataset project, specify train for the value of - * DatasetType.

- *

To have a project with separate training and test datasets, call CreateDataset twice. - * On the first call, specify train for the value of - * DatasetType. On the second call, specify test for the value of - * DatasetType.

- *

This operation requires permissions to perform the - * lookoutvision:CreateDataset operation.

+ * @see {@link CreateDatasetCommand} */ - public createDataset( - args: CreateDatasetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createDataset( - args: CreateDatasetCommandInput, - cb: (err: any, data?: CreateDatasetCommandOutput) => void - ): void; - public createDataset( + createDataset(args: CreateDatasetCommandInput, options?: __HttpHandlerOptions): Promise; + createDataset(args: CreateDatasetCommandInput, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void; + createDataset( args: CreateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetCommandOutput) => void ): void; - public createDataset( - args: CreateDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDatasetCommandOutput) => void), - cb?: (err: any, data?: CreateDatasetCommandOutput) => void - ): Promise | void { - const command = new CreateDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new version of a model within an an Amazon Lookout for Vision project. - * CreateModel is an asynchronous operation in which Amazon Lookout for Vision trains, tests, - * and evaluates a new version of a model.

- *

To get the current status, check the Status field returned - * in the response from DescribeModel.

- *

If the project has a single dataset, Amazon Lookout for Vision internally splits the dataset - * to create a training and a test dataset. - * If the project has a training and a test dataset, Lookout for Vision uses the respective datasets to train and test - * the model.

- *

After training completes, the evaluation metrics are stored at the location specified in - * OutputConfig.

- *

This operation requires permissions to perform the - * lookoutvision:CreateModel operation. If you want to tag your model, you also require - * permission to the lookoutvision:TagResource operation.

+ * @see {@link CreateModelCommand} */ - public createModel(args: CreateModelCommandInput, options?: __HttpHandlerOptions): Promise; - public createModel(args: CreateModelCommandInput, cb: (err: any, data?: CreateModelCommandOutput) => void): void; - public createModel( + createModel(args: CreateModelCommandInput, options?: __HttpHandlerOptions): Promise; + createModel(args: CreateModelCommandInput, cb: (err: any, data?: CreateModelCommandOutput) => void): void; + createModel( args: CreateModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateModelCommandOutput) => void ): void; - public createModel( - args: CreateModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateModelCommandOutput) => void), - cb?: (err: any, data?: CreateModelCommandOutput) => void - ): Promise | void { - const command = new CreateModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an empty Amazon Lookout for Vision project. After you create the project, add a dataset by calling - * CreateDataset.

- *

This operation requires permissions to perform the - * lookoutvision:CreateProject operation.

+ * @see {@link CreateProjectCommand} */ - public createProject( - args: CreateProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createProject( - args: CreateProjectCommandInput, - cb: (err: any, data?: CreateProjectCommandOutput) => void - ): void; - public createProject( + createProject(args: CreateProjectCommandInput, options?: __HttpHandlerOptions): Promise; + createProject(args: CreateProjectCommandInput, cb: (err: any, data?: CreateProjectCommandOutput) => void): void; + createProject( args: CreateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectCommandOutput) => void ): void; - public createProject( - args: CreateProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProjectCommandOutput) => void), - cb?: (err: any, data?: CreateProjectCommandOutput) => void - ): Promise | void { - const command = new CreateProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing Amazon Lookout for Vision dataset.

- *

If your the project has a single - * dataset, you must create a new dataset before you can create a model.

- *

If you project has a training dataset and a test dataset consider the following.

- *
    - *
  • - *

    If you delete the test dataset, your project reverts to a single dataset project. If you then - * train the model, Amazon Lookout for Vision internally splits the remaining dataset into a training and test dataset.

    - *
  • - *
  • - *

    If you delete the training dataset, you must create a training dataset before you can create a model.

    - *
  • - *
- *

This operation requires permissions to perform the - * lookoutvision:DeleteDataset operation.

+ * @see {@link DeleteDatasetCommand} */ - public deleteDataset( - args: DeleteDatasetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDataset( - args: DeleteDatasetCommandInput, - cb: (err: any, data?: DeleteDatasetCommandOutput) => void - ): void; - public deleteDataset( + deleteDataset(args: DeleteDatasetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDataset(args: DeleteDatasetCommandInput, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void; + deleteDataset( args: DeleteDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetCommandOutput) => void ): void; - public deleteDataset( - args: DeleteDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDatasetCommandOutput) => void), - cb?: (err: any, data?: DeleteDatasetCommandOutput) => void - ): Promise | void { - const command = new DeleteDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon Lookout for Vision model. You can't delete a running model. To stop a running model, - * use the StopModel operation.

- *

It might take a few seconds to delete a model. To determine if a model has been deleted, call - * ListModels and check if the version of the model (ModelVersion) is in the - * Models array.

- *

- *

This operation requires permissions to perform the - * lookoutvision:DeleteModel operation.

+ * @see {@link DeleteModelCommand} */ - public deleteModel(args: DeleteModelCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteModel(args: DeleteModelCommandInput, cb: (err: any, data?: DeleteModelCommandOutput) => void): void; - public deleteModel( + deleteModel(args: DeleteModelCommandInput, options?: __HttpHandlerOptions): Promise; + deleteModel(args: DeleteModelCommandInput, cb: (err: any, data?: DeleteModelCommandOutput) => void): void; + deleteModel( args: DeleteModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteModelCommandOutput) => void ): void; - public deleteModel( - args: DeleteModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteModelCommandOutput) => void), - cb?: (err: any, data?: DeleteModelCommandOutput) => void - ): Promise | void { - const command = new DeleteModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon Lookout for Vision project.

- *

To delete a project, you must first delete each version of the model associated with - * the project. To delete a model use the DeleteModel operation.

- *

You also have to delete the dataset(s) associated with the model. For more information, see - * DeleteDataset. The images referenced by the training and test datasets aren't deleted. - *

- *

This operation requires permissions to perform the - * lookoutvision:DeleteProject operation.

+ * @see {@link DeleteProjectCommand} */ - public deleteProject( - args: DeleteProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteProject( - args: DeleteProjectCommandInput, - cb: (err: any, data?: DeleteProjectCommandOutput) => void - ): void; - public deleteProject( + deleteProject(args: DeleteProjectCommandInput, options?: __HttpHandlerOptions): Promise; + deleteProject(args: DeleteProjectCommandInput, cb: (err: any, data?: DeleteProjectCommandOutput) => void): void; + deleteProject( args: DeleteProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProjectCommandOutput) => void ): void; - public deleteProject( - args: DeleteProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProjectCommandOutput) => void), - cb?: (err: any, data?: DeleteProjectCommandOutput) => void - ): Promise | void { - const command = new DeleteProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describe an Amazon Lookout for Vision dataset.

- *

This operation requires permissions to perform the - * lookoutvision:DescribeDataset operation.

+ * @see {@link DescribeDatasetCommand} */ - public describeDataset( + describeDataset( args: DescribeDatasetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDataset( - args: DescribeDatasetCommandInput, - cb: (err: any, data?: DescribeDatasetCommandOutput) => void - ): void; - public describeDataset( + describeDataset(args: DescribeDatasetCommandInput, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void; + describeDataset( args: DescribeDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetCommandOutput) => void ): void; - public describeDataset( - args: DescribeDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDatasetCommandOutput) => void), - cb?: (err: any, data?: DescribeDatasetCommandOutput) => void - ): Promise | void { - const command = new DescribeDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a version of an Amazon Lookout for Vision model.

- *

This operation requires permissions to perform the - * lookoutvision:DescribeModel operation.

+ * @see {@link DescribeModelCommand} */ - public describeModel( - args: DescribeModelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeModel( - args: DescribeModelCommandInput, - cb: (err: any, data?: DescribeModelCommandOutput) => void - ): void; - public describeModel( + describeModel(args: DescribeModelCommandInput, options?: __HttpHandlerOptions): Promise; + describeModel(args: DescribeModelCommandInput, cb: (err: any, data?: DescribeModelCommandOutput) => void): void; + describeModel( args: DescribeModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeModelCommandOutput) => void ): void; - public describeModel( - args: DescribeModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeModelCommandOutput) => void), - cb?: (err: any, data?: DescribeModelCommandOutput) => void - ): Promise | void { - const command = new DescribeModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an Amazon Lookout for Vision model packaging job. - *

- *

This operation requires permissions to perform the - * lookoutvision:DescribeModelPackagingJob operation.

- * - *

For more information, see - * Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.

+ * @see {@link DescribeModelPackagingJobCommand} */ - public describeModelPackagingJob( + describeModelPackagingJob( args: DescribeModelPackagingJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeModelPackagingJob( + describeModelPackagingJob( args: DescribeModelPackagingJobCommandInput, cb: (err: any, data?: DescribeModelPackagingJobCommandOutput) => void ): void; - public describeModelPackagingJob( + describeModelPackagingJob( args: DescribeModelPackagingJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeModelPackagingJobCommandOutput) => void ): void; - public describeModelPackagingJob( - args: DescribeModelPackagingJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeModelPackagingJobCommandOutput) => void), - cb?: (err: any, data?: DescribeModelPackagingJobCommandOutput) => void - ): Promise | void { - const command = new DescribeModelPackagingJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an Amazon Lookout for Vision project.

- *

This operation requires permissions to perform the - * lookoutvision:DescribeProject operation.

+ * @see {@link DescribeProjectCommand} */ - public describeProject( + describeProject( args: DescribeProjectCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProject( - args: DescribeProjectCommandInput, - cb: (err: any, data?: DescribeProjectCommandOutput) => void - ): void; - public describeProject( + describeProject(args: DescribeProjectCommandInput, cb: (err: any, data?: DescribeProjectCommandOutput) => void): void; + describeProject( args: DescribeProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProjectCommandOutput) => void ): void; - public describeProject( - args: DescribeProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProjectCommandOutput) => void), - cb?: (err: any, data?: DescribeProjectCommandOutput) => void - ): Promise | void { - const command = new DescribeProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Detects anomalies in an image that you supply.

- *

The response from DetectAnomalies includes a boolean prediction - * that the image contains one or more anomalies and a confidence value for the prediction. - * If the model is an image segmentation model, the response also includes segmentation - * information for each type of anomaly found in the image.

- * - *

Before calling DetectAnomalies, you must first start your model with the StartModel operation. - * You are charged for the amount of time, in minutes, that a model runs and for the number of anomaly detection units that your - * model uses. If you are not using a model, use the StopModel operation to stop your model.

- *
- * - *

For more information, see Detecting anomalies in an image in the Amazon Lookout for Vision developer guide.

- * - *

This operation requires permissions to perform the - * lookoutvision:DetectAnomalies operation.

+ * @see {@link DetectAnomaliesCommand} */ - public detectAnomalies( + detectAnomalies( args: DetectAnomaliesCommandInput, options?: __HttpHandlerOptions ): Promise; - public detectAnomalies( - args: DetectAnomaliesCommandInput, - cb: (err: any, data?: DetectAnomaliesCommandOutput) => void - ): void; - public detectAnomalies( + detectAnomalies(args: DetectAnomaliesCommandInput, cb: (err: any, data?: DetectAnomaliesCommandOutput) => void): void; + detectAnomalies( args: DetectAnomaliesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectAnomaliesCommandOutput) => void ): void; - public detectAnomalies( - args: DetectAnomaliesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectAnomaliesCommandOutput) => void), - cb?: (err: any, data?: DetectAnomaliesCommandOutput) => void - ): Promise | void { - const command = new DetectAnomaliesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the JSON Lines within a dataset. An Amazon Lookout for Vision JSON Line contains the anomaly - * information for a single image, including the image location and the assigned label.

- *

This operation requires permissions to perform the - * lookoutvision:ListDatasetEntries operation.

+ * @see {@link ListDatasetEntriesCommand} */ - public listDatasetEntries( + listDatasetEntries( args: ListDatasetEntriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDatasetEntries( + listDatasetEntries( args: ListDatasetEntriesCommandInput, cb: (err: any, data?: ListDatasetEntriesCommandOutput) => void ): void; - public listDatasetEntries( + listDatasetEntries( args: ListDatasetEntriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetEntriesCommandOutput) => void ): void; - public listDatasetEntries( - args: ListDatasetEntriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatasetEntriesCommandOutput) => void), - cb?: (err: any, data?: ListDatasetEntriesCommandOutput) => void - ): Promise | void { - const command = new ListDatasetEntriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Lists the model packaging jobs created for an Amazon Lookout for Vision project. - *

- *

This operation requires permissions to perform the - * lookoutvision:ListModelPackagingJobs operation. - *

- * - *

For more information, see - * Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.

+ * @see {@link ListModelPackagingJobsCommand} */ - public listModelPackagingJobs( + listModelPackagingJobs( args: ListModelPackagingJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listModelPackagingJobs( + listModelPackagingJobs( args: ListModelPackagingJobsCommandInput, cb: (err: any, data?: ListModelPackagingJobsCommandOutput) => void ): void; - public listModelPackagingJobs( + listModelPackagingJobs( args: ListModelPackagingJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListModelPackagingJobsCommandOutput) => void ): void; - public listModelPackagingJobs( - args: ListModelPackagingJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListModelPackagingJobsCommandOutput) => void), - cb?: (err: any, data?: ListModelPackagingJobsCommandOutput) => void - ): Promise | void { - const command = new ListModelPackagingJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the versions of a model in an Amazon Lookout for Vision project.

- *

The ListModels operation is eventually consistent. - * Recent calls to CreateModel might - * take a while to appear in the response from ListProjects.

- *

This operation requires permissions to perform the - * lookoutvision:ListModels operation.

+ * @see {@link ListModelsCommand} */ - public listModels(args: ListModelsCommandInput, options?: __HttpHandlerOptions): Promise; - public listModels(args: ListModelsCommandInput, cb: (err: any, data?: ListModelsCommandOutput) => void): void; - public listModels( + listModels(args: ListModelsCommandInput, options?: __HttpHandlerOptions): Promise; + listModels(args: ListModelsCommandInput, cb: (err: any, data?: ListModelsCommandOutput) => void): void; + listModels( args: ListModelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListModelsCommandOutput) => void ): void; - public listModels( - args: ListModelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListModelsCommandOutput) => void), - cb?: (err: any, data?: ListModelsCommandOutput) => void - ): Promise | void { - const command = new ListModelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the Amazon Lookout for Vision projects in your AWS account that are in the AWS Region in - * which you call ListProjects.

- *

The ListProjects operation is eventually consistent. - * Recent calls to CreateProject and DeleteProject might - * take a while to appear in the response from ListProjects.

- *

This operation requires permissions to perform the - * lookoutvision:ListProjects operation.

+ * @see {@link ListProjectsCommand} */ - public listProjects( - args: ListProjectsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void; - public listProjects( + listProjects(args: ListProjectsCommandInput, options?: __HttpHandlerOptions): Promise; + listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void; + listProjects( args: ListProjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProjectsCommandOutput) => void ): void; - public listProjects( - args: ListProjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProjectsCommandOutput) => void), - cb?: (err: any, data?: ListProjectsCommandOutput) => void - ): Promise | void { - const command = new ListProjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of tags attached to the specified Amazon Lookout for Vision model.

- *

This operation requires permissions to perform the - * lookoutvision:ListTagsForResource operation.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts the running of the version of an Amazon Lookout for Vision model. Starting a model takes a while - * to complete. To check the current state of the model, use DescribeModel.

- *

A model is ready to use when its status is HOSTED.

- *

Once the model is running, you can detect custom labels in new images by calling - * DetectAnomalies.

- * - *

You are charged for the amount of time that the model is running. To stop a running - * model, call StopModel.

- *
- *

This operation requires permissions to perform the - * lookoutvision:StartModel operation.

+ * @see {@link StartModelCommand} */ - public startModel(args: StartModelCommandInput, options?: __HttpHandlerOptions): Promise; - public startModel(args: StartModelCommandInput, cb: (err: any, data?: StartModelCommandOutput) => void): void; - public startModel( + startModel(args: StartModelCommandInput, options?: __HttpHandlerOptions): Promise; + startModel(args: StartModelCommandInput, cb: (err: any, data?: StartModelCommandOutput) => void): void; + startModel( args: StartModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartModelCommandOutput) => void ): void; - public startModel( - args: StartModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartModelCommandOutput) => void), - cb?: (err: any, data?: StartModelCommandOutput) => void - ): Promise | void { - const command = new StartModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts an Amazon Lookout for Vision model packaging job. A model packaging job creates an AWS IoT Greengrass component for - * a Lookout for Vision model. You can use the component to deploy your model to an edge device managed by Greengrass. - *

- * - *

Use the DescribeModelPackagingJob API to determine the current status of the job. - * - * The model packaging job is complete if the value of Status is SUCCEEDED.

- *

To deploy the component - * to the target device, use the component name and component version - * with the AWS IoT Greengrass CreateDeployment API.

- * - *

This operation requires the following permissions:

- *
    - *
  • - *

    - * lookoutvision:StartModelPackagingJob - *

    - *
  • - *
  • - *

    - * s3:PutObject - *

    - *
  • - *
  • - *

    - * s3:GetBucketLocation - *

    - *
  • - *
  • - *

    - * kms:GenerateDataKey - *

    - *
  • - *
  • - *

    - * greengrass:CreateComponentVersion - *

    - *
  • - *
  • - *

    - * greengrass:DescribeComponent - *

    - *
  • - *
  • - *

    (Optional) greengrass:TagResource. Only required if you want to tag the component.

    - *
  • - *
- * - * - *

For more information, see - * Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.

+ * @see {@link StartModelPackagingJobCommand} */ - public startModelPackagingJob( + startModelPackagingJob( args: StartModelPackagingJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startModelPackagingJob( + startModelPackagingJob( args: StartModelPackagingJobCommandInput, cb: (err: any, data?: StartModelPackagingJobCommandOutput) => void ): void; - public startModelPackagingJob( + startModelPackagingJob( args: StartModelPackagingJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartModelPackagingJobCommandOutput) => void ): void; - public startModelPackagingJob( - args: StartModelPackagingJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartModelPackagingJobCommandOutput) => void), - cb?: (err: any, data?: StartModelPackagingJobCommandOutput) => void - ): Promise | void { - const command = new StartModelPackagingJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops the hosting of a running model. The operation might take a while to complete. To - * check the current status, call DescribeModel.

- *

After the model hosting stops, the Status of the model is TRAINED.

- *

This operation requires permissions to perform the - * lookoutvision:StopModel operation.

+ * @see {@link StopModelCommand} */ - public stopModel(args: StopModelCommandInput, options?: __HttpHandlerOptions): Promise; - public stopModel(args: StopModelCommandInput, cb: (err: any, data?: StopModelCommandOutput) => void): void; - public stopModel( + stopModel(args: StopModelCommandInput, options?: __HttpHandlerOptions): Promise; + stopModel(args: StopModelCommandInput, cb: (err: any, data?: StopModelCommandOutput) => void): void; + stopModel( args: StopModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopModelCommandOutput) => void ): void; - public stopModel( - args: StopModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopModelCommandOutput) => void), - cb?: (err: any, data?: StopModelCommandOutput) => void - ): Promise | void { - const command = new StopModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more key-value tags to an Amazon Lookout for Vision model. - * For more information, see Tagging a model in the Amazon Lookout for Vision Developer Guide.

- *

This operation requires permissions to perform the - * lookoutvision:TagResource operation.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from an Amazon Lookout for Vision model. For more information, see - * Tagging a model in the Amazon Lookout for Vision Developer Guide.

- *

This operation requires permissions to perform the - * lookoutvision:UntagResource operation.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or updates one or more JSON Line entries in a dataset. A JSON Line includes information about an image - * used for training or testing an Amazon Lookout for Vision model.

- *

To update an existing JSON Line, use the source-ref field to identify the JSON Line. The JSON line - * that you supply replaces the existing JSON line. Any existing annotations that are not in the new JSON line are removed from the dataset. - *

- * - * - *

For more information, see - * Defining JSON lines for anomaly classification in the Amazon Lookout for Vision Developer Guide.

- * - * - *

The images you reference in the source-ref field of a JSON line, must be - * in the same S3 bucket as the existing images in the dataset.

- *
- * - *

Updating a dataset might take a while to complete. To check the current status, call DescribeDataset and - * check the Status field in the response.

- *

This operation requires permissions to perform the - * lookoutvision:UpdateDatasetEntries operation.

+ * @see {@link UpdateDatasetEntriesCommand} */ - public updateDatasetEntries( + updateDatasetEntries( args: UpdateDatasetEntriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDatasetEntries( + updateDatasetEntries( args: UpdateDatasetEntriesCommandInput, cb: (err: any, data?: UpdateDatasetEntriesCommandOutput) => void ): void; - public updateDatasetEntries( + updateDatasetEntries( args: UpdateDatasetEntriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDatasetEntriesCommandOutput) => void ): void; - public updateDatasetEntries( - args: UpdateDatasetEntriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDatasetEntriesCommandOutput) => void), - cb?: (err: any, data?: UpdateDatasetEntriesCommandOutput) => void - ): Promise | void { - const command = new UpdateDatasetEntriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

This is the Amazon Lookout for Vision API Reference. It provides descriptions of actions, + * data types, common parameters, and common errors.

+ *

Amazon Lookout for Vision enables you to find visual defects in industrial products, + * accurately and at scale. It uses computer vision to identify missing components in an industrial product, + * damage to vehicles or structures, irregularities in production lines, and even minuscule defects in + * silicon wafers — or any other physical item where quality is important such as a missing capacitor + * on printed circuit boards.

+ */ +export class LookoutVision extends LookoutVisionClient implements LookoutVision {} +createAggregatedClient(commands, LookoutVision); diff --git a/clients/client-m2/src/M2.ts b/clients/client-m2/src/M2.ts index c01704b07ef0..2f89473be480 100644 --- a/clients/client-m2/src/M2.ts +++ b/clients/client-m2/src/M2.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -157,1076 +158,554 @@ import { UpdateEnvironmentCommandInput, UpdateEnvironmentCommandOutput, } from "./commands/UpdateEnvironmentCommand"; -import { M2Client } from "./M2Client"; +import { M2Client, M2ClientConfig } from "./M2Client"; -/** - * @public - *

Amazon Web Services Mainframe Modernization provides tools and resources to help you plan and implement migration and - * modernization from mainframes to Amazon Web Services managed runtime environments. It provides tools for - * analyzing existing mainframe applications, developing or updating mainframe applications - * using COBOL or PL/I, and implementing an automated pipeline for continuous integration and - * continuous delivery (CI/CD) of the applications.

- */ -export class M2 extends M2Client { +const commands = { + CancelBatchJobExecutionCommand, + CreateApplicationCommand, + CreateDataSetImportTaskCommand, + CreateDeploymentCommand, + CreateEnvironmentCommand, + DeleteApplicationCommand, + DeleteApplicationFromEnvironmentCommand, + DeleteEnvironmentCommand, + GetApplicationCommand, + GetApplicationVersionCommand, + GetBatchJobExecutionCommand, + GetDataSetDetailsCommand, + GetDataSetImportTaskCommand, + GetDeploymentCommand, + GetEnvironmentCommand, + ListApplicationsCommand, + ListApplicationVersionsCommand, + ListBatchJobDefinitionsCommand, + ListBatchJobExecutionsCommand, + ListDataSetImportHistoryCommand, + ListDataSetsCommand, + ListDeploymentsCommand, + ListEngineVersionsCommand, + ListEnvironmentsCommand, + ListTagsForResourceCommand, + StartApplicationCommand, + StartBatchJobCommand, + StopApplicationCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateApplicationCommand, + UpdateEnvironmentCommand, +}; + +export interface M2 { /** - * @public - *

Cancels the running of a specific batch job execution.

+ * @see {@link CancelBatchJobExecutionCommand} */ - public cancelBatchJobExecution( + cancelBatchJobExecution( args: CancelBatchJobExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelBatchJobExecution( + cancelBatchJobExecution( args: CancelBatchJobExecutionCommandInput, cb: (err: any, data?: CancelBatchJobExecutionCommandOutput) => void ): void; - public cancelBatchJobExecution( + cancelBatchJobExecution( args: CancelBatchJobExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelBatchJobExecutionCommandOutput) => void ): void; - public cancelBatchJobExecution( - args: CancelBatchJobExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelBatchJobExecutionCommandOutput) => void), - cb?: (err: any, data?: CancelBatchJobExecutionCommandOutput) => void - ): Promise | void { - const command = new CancelBatchJobExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new application with given parameters. Requires an existing runtime environment and - * application definition file.

+ * @see {@link CreateApplicationCommand} */ - public createApplication( + createApplication( args: CreateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApplication( + createApplication( args: CreateApplicationCommandInput, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( + createApplication( args: CreateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( - args: CreateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApplicationCommandOutput) => void), - cb?: (err: any, data?: CreateApplicationCommandOutput) => void - ): Promise | void { - const command = new CreateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a data set import task for a specific application.

+ * @see {@link CreateDataSetImportTaskCommand} */ - public createDataSetImportTask( + createDataSetImportTask( args: CreateDataSetImportTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDataSetImportTask( + createDataSetImportTask( args: CreateDataSetImportTaskCommandInput, cb: (err: any, data?: CreateDataSetImportTaskCommandOutput) => void ): void; - public createDataSetImportTask( + createDataSetImportTask( args: CreateDataSetImportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataSetImportTaskCommandOutput) => void ): void; - public createDataSetImportTask( - args: CreateDataSetImportTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDataSetImportTaskCommandOutput) => void), - cb?: (err: any, data?: CreateDataSetImportTaskCommandOutput) => void - ): Promise | void { - const command = new CreateDataSetImportTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates and starts a deployment to deploy an application into a runtime environment.

+ * @see {@link CreateDeploymentCommand} */ - public createDeployment( + createDeployment( args: CreateDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDeployment( + createDeployment( args: CreateDeploymentCommandInput, cb: (err: any, data?: CreateDeploymentCommandOutput) => void ): void; - public createDeployment( + createDeployment( args: CreateDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeploymentCommandOutput) => void ): void; - public createDeployment( - args: CreateDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDeploymentCommandOutput) => void), - cb?: (err: any, data?: CreateDeploymentCommandOutput) => void - ): Promise | void { - const command = new CreateDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a runtime environment for a given runtime engine.

+ * @see {@link CreateEnvironmentCommand} */ - public createEnvironment( + createEnvironment( args: CreateEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEnvironment( + createEnvironment( args: CreateEnvironmentCommandInput, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void ): void; - public createEnvironment( + createEnvironment( args: CreateEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void ): void; - public createEnvironment( - args: CreateEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEnvironmentCommandOutput) => void), - cb?: (err: any, data?: CreateEnvironmentCommandOutput) => void - ): Promise | void { - const command = new CreateEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a specific application. You cannot delete a running application.

+ * @see {@link DeleteApplicationCommand} */ - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( - args: DeleteApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApplicationCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a specific application from the specific runtime environment where it was previously - * deployed. You cannot delete a runtime environment using DeleteEnvironment if any application has - * ever been deployed to it. This API removes the association of the application with the - * runtime environment so you can delete the environment smoothly.

+ * @see {@link DeleteApplicationFromEnvironmentCommand} */ - public deleteApplicationFromEnvironment( + deleteApplicationFromEnvironment( args: DeleteApplicationFromEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplicationFromEnvironment( + deleteApplicationFromEnvironment( args: DeleteApplicationFromEnvironmentCommandInput, cb: (err: any, data?: DeleteApplicationFromEnvironmentCommandOutput) => void ): void; - public deleteApplicationFromEnvironment( + deleteApplicationFromEnvironment( args: DeleteApplicationFromEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationFromEnvironmentCommandOutput) => void ): void; - public deleteApplicationFromEnvironment( - args: DeleteApplicationFromEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApplicationFromEnvironmentCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationFromEnvironmentCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationFromEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a specific runtime environment. The environment cannot contain deployed applications. If - * it does, you must delete those applications before you delete the environment.

+ * @see {@link DeleteEnvironmentCommand} */ - public deleteEnvironment( + deleteEnvironment( args: DeleteEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEnvironment( + deleteEnvironment( args: DeleteEnvironmentCommandInput, cb: (err: any, data?: DeleteEnvironmentCommandOutput) => void ): void; - public deleteEnvironment( + deleteEnvironment( args: DeleteEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEnvironmentCommandOutput) => void ): void; - public deleteEnvironment( - args: DeleteEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEnvironmentCommandOutput) => void), - cb?: (err: any, data?: DeleteEnvironmentCommandOutput) => void - ): Promise | void { - const command = new DeleteEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the details of a specific application.

+ * @see {@link GetApplicationCommand} */ - public getApplication( + getApplication( args: GetApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getApplication( - args: GetApplicationCommandInput, - cb: (err: any, data?: GetApplicationCommandOutput) => void - ): void; - public getApplication( + getApplication(args: GetApplicationCommandInput, cb: (err: any, data?: GetApplicationCommandOutput) => void): void; + getApplication( args: GetApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApplicationCommandOutput) => void ): void; - public getApplication( - args: GetApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApplicationCommandOutput) => void), - cb?: (err: any, data?: GetApplicationCommandOutput) => void - ): Promise | void { - const command = new GetApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns details about a specific version of a specific application.

+ * @see {@link GetApplicationVersionCommand} */ - public getApplicationVersion( + getApplicationVersion( args: GetApplicationVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getApplicationVersion( + getApplicationVersion( args: GetApplicationVersionCommandInput, cb: (err: any, data?: GetApplicationVersionCommandOutput) => void ): void; - public getApplicationVersion( + getApplicationVersion( args: GetApplicationVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApplicationVersionCommandOutput) => void ): void; - public getApplicationVersion( - args: GetApplicationVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApplicationVersionCommandOutput) => void), - cb?: (err: any, data?: GetApplicationVersionCommandOutput) => void - ): Promise | void { - const command = new GetApplicationVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the details of a specific batch job execution for a specific application.

+ * @see {@link GetBatchJobExecutionCommand} */ - public getBatchJobExecution( + getBatchJobExecution( args: GetBatchJobExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBatchJobExecution( + getBatchJobExecution( args: GetBatchJobExecutionCommandInput, cb: (err: any, data?: GetBatchJobExecutionCommandOutput) => void ): void; - public getBatchJobExecution( + getBatchJobExecution( args: GetBatchJobExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBatchJobExecutionCommandOutput) => void ): void; - public getBatchJobExecution( - args: GetBatchJobExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBatchJobExecutionCommandOutput) => void), - cb?: (err: any, data?: GetBatchJobExecutionCommandOutput) => void - ): Promise | void { - const command = new GetBatchJobExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the details of a specific data set.

+ * @see {@link GetDataSetDetailsCommand} */ - public getDataSetDetails( + getDataSetDetails( args: GetDataSetDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDataSetDetails( + getDataSetDetails( args: GetDataSetDetailsCommandInput, cb: (err: any, data?: GetDataSetDetailsCommandOutput) => void ): void; - public getDataSetDetails( + getDataSetDetails( args: GetDataSetDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataSetDetailsCommandOutput) => void ): void; - public getDataSetDetails( - args: GetDataSetDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDataSetDetailsCommandOutput) => void), - cb?: (err: any, data?: GetDataSetDetailsCommandOutput) => void - ): Promise | void { - const command = new GetDataSetDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.

+ * @see {@link GetDataSetImportTaskCommand} */ - public getDataSetImportTask( + getDataSetImportTask( args: GetDataSetImportTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDataSetImportTask( + getDataSetImportTask( args: GetDataSetImportTaskCommandInput, cb: (err: any, data?: GetDataSetImportTaskCommandOutput) => void ): void; - public getDataSetImportTask( + getDataSetImportTask( args: GetDataSetImportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataSetImportTaskCommandOutput) => void ): void; - public getDataSetImportTask( - args: GetDataSetImportTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDataSetImportTaskCommandOutput) => void), - cb?: (err: any, data?: GetDataSetImportTaskCommandOutput) => void - ): Promise | void { - const command = new GetDataSetImportTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets details of a specific deployment with a given deployment identifier.

+ * @see {@link GetDeploymentCommand} */ - public getDeployment( - args: GetDeploymentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getDeployment( - args: GetDeploymentCommandInput, - cb: (err: any, data?: GetDeploymentCommandOutput) => void - ): void; - public getDeployment( + getDeployment(args: GetDeploymentCommandInput, options?: __HttpHandlerOptions): Promise; + getDeployment(args: GetDeploymentCommandInput, cb: (err: any, data?: GetDeploymentCommandOutput) => void): void; + getDeployment( args: GetDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeploymentCommandOutput) => void ): void; - public getDeployment( - args: GetDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeploymentCommandOutput) => void), - cb?: (err: any, data?: GetDeploymentCommandOutput) => void - ): Promise | void { - const command = new GetDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a specific runtime environment.

+ * @see {@link GetEnvironmentCommand} */ - public getEnvironment( + getEnvironment( args: GetEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEnvironment( - args: GetEnvironmentCommandInput, - cb: (err: any, data?: GetEnvironmentCommandOutput) => void - ): void; - public getEnvironment( + getEnvironment(args: GetEnvironmentCommandInput, cb: (err: any, data?: GetEnvironmentCommandOutput) => void): void; + getEnvironment( args: GetEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEnvironmentCommandOutput) => void ): void; - public getEnvironment( - args: GetEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEnvironmentCommandOutput) => void), - cb?: (err: any, data?: GetEnvironmentCommandOutput) => void - ): Promise | void { - const command = new GetEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the applications associated with a specific Amazon Web Services account. You can provide the - * unique identifier of a specific runtime environment in a query parameter to see all applications - * associated with that environment.

+ * @see {@link ListApplicationsCommand} */ - public listApplications( + listApplications( args: ListApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplications( + listApplications( args: ListApplicationsCommandInput, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( + listApplications( args: ListApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( - args: ListApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationsCommandOutput) => void), - cb?: (err: any, data?: ListApplicationsCommandOutput) => void - ): Promise | void { - const command = new ListApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the application versions for a specific application.

+ * @see {@link ListApplicationVersionsCommand} */ - public listApplicationVersions( + listApplicationVersions( args: ListApplicationVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplicationVersions( + listApplicationVersions( args: ListApplicationVersionsCommandInput, cb: (err: any, data?: ListApplicationVersionsCommandOutput) => void ): void; - public listApplicationVersions( + listApplicationVersions( args: ListApplicationVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationVersionsCommandOutput) => void ): void; - public listApplicationVersions( - args: ListApplicationVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationVersionsCommandOutput) => void), - cb?: (err: any, data?: ListApplicationVersionsCommandOutput) => void - ): Promise | void { - const command = new ListApplicationVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the available batch job definitions based on the batch job resources uploaded - * during the application creation. You can use the batch job definitions in the list to start - * a batch job.

+ * @see {@link ListBatchJobDefinitionsCommand} */ - public listBatchJobDefinitions( + listBatchJobDefinitions( args: ListBatchJobDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBatchJobDefinitions( + listBatchJobDefinitions( args: ListBatchJobDefinitionsCommandInput, cb: (err: any, data?: ListBatchJobDefinitionsCommandOutput) => void ): void; - public listBatchJobDefinitions( + listBatchJobDefinitions( args: ListBatchJobDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBatchJobDefinitionsCommandOutput) => void ): void; - public listBatchJobDefinitions( - args: ListBatchJobDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBatchJobDefinitionsCommandOutput) => void), - cb?: (err: any, data?: ListBatchJobDefinitionsCommandOutput) => void - ): Promise | void { - const command = new ListBatchJobDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists historical, current, and scheduled batch job executions for a specific - * application.

+ * @see {@link ListBatchJobExecutionsCommand} */ - public listBatchJobExecutions( + listBatchJobExecutions( args: ListBatchJobExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBatchJobExecutions( + listBatchJobExecutions( args: ListBatchJobExecutionsCommandInput, cb: (err: any, data?: ListBatchJobExecutionsCommandOutput) => void ): void; - public listBatchJobExecutions( + listBatchJobExecutions( args: ListBatchJobExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBatchJobExecutionsCommandOutput) => void ): void; - public listBatchJobExecutions( - args: ListBatchJobExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBatchJobExecutionsCommandOutput) => void), - cb?: (err: any, data?: ListBatchJobExecutionsCommandOutput) => void - ): Promise | void { - const command = new ListBatchJobExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the data set imports for the specified application.

+ * @see {@link ListDataSetImportHistoryCommand} */ - public listDataSetImportHistory( + listDataSetImportHistory( args: ListDataSetImportHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDataSetImportHistory( + listDataSetImportHistory( args: ListDataSetImportHistoryCommandInput, cb: (err: any, data?: ListDataSetImportHistoryCommandOutput) => void ): void; - public listDataSetImportHistory( + listDataSetImportHistory( args: ListDataSetImportHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataSetImportHistoryCommandOutput) => void ): void; - public listDataSetImportHistory( - args: ListDataSetImportHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDataSetImportHistoryCommandOutput) => void), - cb?: (err: any, data?: ListDataSetImportHistoryCommandOutput) => void - ): Promise | void { - const command = new ListDataSetImportHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the data sets imported for a specific application. In Amazon Web Services Mainframe Modernization, data sets are - * associated with applications deployed on runtime environments. This is known as importing data - * sets. Currently, Amazon Web Services Mainframe Modernization can import data sets into catalogs using CreateDataSetImportTask.

+ * @see {@link ListDataSetsCommand} */ - public listDataSets( - args: ListDataSetsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listDataSets(args: ListDataSetsCommandInput, cb: (err: any, data?: ListDataSetsCommandOutput) => void): void; - public listDataSets( + listDataSets(args: ListDataSetsCommandInput, options?: __HttpHandlerOptions): Promise; + listDataSets(args: ListDataSetsCommandInput, cb: (err: any, data?: ListDataSetsCommandOutput) => void): void; + listDataSets( args: ListDataSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataSetsCommandOutput) => void ): void; - public listDataSets( - args: ListDataSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDataSetsCommandOutput) => void), - cb?: (err: any, data?: ListDataSetsCommandOutput) => void - ): Promise | void { - const command = new ListDataSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all deployments of a specific application. A deployment is a - * combination of a specific application and a specific version of that application. Each - * deployment is mapped to a particular application version.

+ * @see {@link ListDeploymentsCommand} */ - public listDeployments( + listDeployments( args: ListDeploymentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeployments( - args: ListDeploymentsCommandInput, - cb: (err: any, data?: ListDeploymentsCommandOutput) => void - ): void; - public listDeployments( + listDeployments(args: ListDeploymentsCommandInput, cb: (err: any, data?: ListDeploymentsCommandOutput) => void): void; + listDeployments( args: ListDeploymentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeploymentsCommandOutput) => void ): void; - public listDeployments( - args: ListDeploymentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeploymentsCommandOutput) => void), - cb?: (err: any, data?: ListDeploymentsCommandOutput) => void - ): Promise | void { - const command = new ListDeploymentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the available engine versions.

+ * @see {@link ListEngineVersionsCommand} */ - public listEngineVersions( + listEngineVersions( args: ListEngineVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEngineVersions( + listEngineVersions( args: ListEngineVersionsCommandInput, cb: (err: any, data?: ListEngineVersionsCommandOutput) => void ): void; - public listEngineVersions( + listEngineVersions( args: ListEngineVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEngineVersionsCommandOutput) => void ): void; - public listEngineVersions( - args: ListEngineVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEngineVersionsCommandOutput) => void), - cb?: (err: any, data?: ListEngineVersionsCommandOutput) => void - ): Promise | void { - const command = new ListEngineVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the runtime environments.

+ * @see {@link ListEnvironmentsCommand} */ - public listEnvironments( + listEnvironments( args: ListEnvironmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEnvironments( + listEnvironments( args: ListEnvironmentsCommandInput, cb: (err: any, data?: ListEnvironmentsCommandOutput) => void ): void; - public listEnvironments( + listEnvironments( args: ListEnvironmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnvironmentsCommandOutput) => void ): void; - public listEnvironments( - args: ListEnvironmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEnvironmentsCommandOutput) => void), - cb?: (err: any, data?: ListEnvironmentsCommandOutput) => void - ): Promise | void { - const command = new ListEnvironmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags for the specified resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts an application that is currently stopped.

+ * @see {@link StartApplicationCommand} */ - public startApplication( + startApplication( args: StartApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startApplication( + startApplication( args: StartApplicationCommandInput, cb: (err: any, data?: StartApplicationCommandOutput) => void ): void; - public startApplication( + startApplication( args: StartApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartApplicationCommandOutput) => void ): void; - public startApplication( - args: StartApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartApplicationCommandOutput) => void), - cb?: (err: any, data?: StartApplicationCommandOutput) => void - ): Promise | void { - const command = new StartApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a batch job and returns the unique identifier of this execution of the batch job. - * The associated application must be running in order to start the batch job.

+ * @see {@link StartBatchJobCommand} */ - public startBatchJob( - args: StartBatchJobCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public startBatchJob( - args: StartBatchJobCommandInput, - cb: (err: any, data?: StartBatchJobCommandOutput) => void - ): void; - public startBatchJob( + startBatchJob(args: StartBatchJobCommandInput, options?: __HttpHandlerOptions): Promise; + startBatchJob(args: StartBatchJobCommandInput, cb: (err: any, data?: StartBatchJobCommandOutput) => void): void; + startBatchJob( args: StartBatchJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartBatchJobCommandOutput) => void ): void; - public startBatchJob( - args: StartBatchJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartBatchJobCommandOutput) => void), - cb?: (err: any, data?: StartBatchJobCommandOutput) => void - ): Promise | void { - const command = new StartBatchJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops a running application.

+ * @see {@link StopApplicationCommand} */ - public stopApplication( + stopApplication( args: StopApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopApplication( - args: StopApplicationCommandInput, - cb: (err: any, data?: StopApplicationCommandOutput) => void - ): void; - public stopApplication( + stopApplication(args: StopApplicationCommandInput, cb: (err: any, data?: StopApplicationCommandOutput) => void): void; + stopApplication( args: StopApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopApplicationCommandOutput) => void ): void; - public stopApplication( - args: StopApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopApplicationCommandOutput) => void), - cb?: (err: any, data?: StopApplicationCommandOutput) => void - ): Promise | void { - const command = new StopApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more tags to the specified resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from the specified resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an application and creates a new version.

+ * @see {@link UpdateApplicationCommand} */ - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( - args: UpdateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApplicationCommandOutput) => void), - cb?: (err: any, data?: UpdateApplicationCommandOutput) => void - ): Promise | void { - const command = new UpdateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the configuration details for a specific runtime environment.

+ * @see {@link UpdateEnvironmentCommand} */ - public updateEnvironment( + updateEnvironment( args: UpdateEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEnvironment( + updateEnvironment( args: UpdateEnvironmentCommandInput, cb: (err: any, data?: UpdateEnvironmentCommandOutput) => void ): void; - public updateEnvironment( + updateEnvironment( args: UpdateEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEnvironmentCommandOutput) => void ): void; - public updateEnvironment( - args: UpdateEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEnvironmentCommandOutput) => void), - cb?: (err: any, data?: UpdateEnvironmentCommandOutput) => void - ): Promise | void { - const command = new UpdateEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Web Services Mainframe Modernization provides tools and resources to help you plan and implement migration and + * modernization from mainframes to Amazon Web Services managed runtime environments. It provides tools for + * analyzing existing mainframe applications, developing or updating mainframe applications + * using COBOL or PL/I, and implementing an automated pipeline for continuous integration and + * continuous delivery (CI/CD) of the applications.

+ */ +export class M2 extends M2Client implements M2 {} +createAggregatedClient(commands, M2); diff --git a/clients/client-machine-learning/src/MachineLearning.ts b/clients/client-machine-learning/src/MachineLearning.ts index 472955fea084..4e209efc1e52 100644 --- a/clients/client-machine-learning/src/MachineLearning.ts +++ b/clients/client-machine-learning/src/MachineLearning.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { AddTagsCommand, AddTagsCommandInput, AddTagsCommandOutput } from "./commands/AddTagsCommand"; @@ -125,1056 +126,461 @@ import { UpdateMLModelCommandInput, UpdateMLModelCommandOutput, } from "./commands/UpdateMLModelCommand"; -import { MachineLearningClient } from "./MachineLearningClient"; +import { MachineLearningClient, MachineLearningClientConfig } from "./MachineLearningClient"; -/** - * @public - * Definition of the public APIs - * exposed by Amazon Machine Learning - */ -export class MachineLearning extends MachineLearningClient { +const commands = { + AddTagsCommand, + CreateBatchPredictionCommand, + CreateDataSourceFromRDSCommand, + CreateDataSourceFromRedshiftCommand, + CreateDataSourceFromS3Command, + CreateEvaluationCommand, + CreateMLModelCommand, + CreateRealtimeEndpointCommand, + DeleteBatchPredictionCommand, + DeleteDataSourceCommand, + DeleteEvaluationCommand, + DeleteMLModelCommand, + DeleteRealtimeEndpointCommand, + DeleteTagsCommand, + DescribeBatchPredictionsCommand, + DescribeDataSourcesCommand, + DescribeEvaluationsCommand, + DescribeMLModelsCommand, + DescribeTagsCommand, + GetBatchPredictionCommand, + GetDataSourceCommand, + GetEvaluationCommand, + GetMLModelCommand, + PredictCommand, + UpdateBatchPredictionCommand, + UpdateDataSourceCommand, + UpdateEvaluationCommand, + UpdateMLModelCommand, +}; + +export interface MachineLearning { /** - * @public - *

Adds one or more tags to an object, up to a limit of 10. Each tag consists of a key - * and an optional value. If you add a tag using a key that is already associated with the ML object, - * AddTags updates the tag's value.

+ * @see {@link AddTagsCommand} */ - public addTags(args: AddTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public addTags(args: AddTagsCommandInput, cb: (err: any, data?: AddTagsCommandOutput) => void): void; - public addTags( + addTags(args: AddTagsCommandInput, options?: __HttpHandlerOptions): Promise; + addTags(args: AddTagsCommandInput, cb: (err: any, data?: AddTagsCommandOutput) => void): void; + addTags( args: AddTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsCommandOutput) => void ): void; - public addTags( - args: AddTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddTagsCommandOutput) => void), - cb?: (err: any, data?: AddTagsCommandOutput) => void - ): Promise | void { - const command = new AddTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Generates predictions for a group of observations. The observations to process exist in one or more data files referenced - * by a DataSource. This operation creates a new BatchPrediction, and uses an MLModel and the data - * files referenced by the DataSource as information sources. - *

- * - *

- * CreateBatchPrediction is an asynchronous operation. In response to CreateBatchPrediction, - * Amazon Machine Learning (Amazon ML) immediately returns and sets the BatchPrediction status to PENDING. - * After the BatchPrediction completes, Amazon ML sets the status to COMPLETED. - *

- *

You can poll for status updates by using the GetBatchPrediction operation and checking the Status parameter of the result. After the COMPLETED status appears, - * the results are available in the location specified by the OutputUri parameter.

+ * @see {@link CreateBatchPredictionCommand} */ - public createBatchPrediction( + createBatchPrediction( args: CreateBatchPredictionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBatchPrediction( + createBatchPrediction( args: CreateBatchPredictionCommandInput, cb: (err: any, data?: CreateBatchPredictionCommandOutput) => void ): void; - public createBatchPrediction( + createBatchPrediction( args: CreateBatchPredictionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBatchPredictionCommandOutput) => void ): void; - public createBatchPrediction( - args: CreateBatchPredictionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBatchPredictionCommandOutput) => void), - cb?: (err: any, data?: CreateBatchPredictionCommandOutput) => void - ): Promise | void { - const command = new CreateBatchPredictionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a DataSource object from an Amazon Relational Database Service (Amazon RDS). A DataSource references data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.

- * - *

- * CreateDataSourceFromRDS is an asynchronous operation. In response to CreateDataSourceFromRDS, - * Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. - * After the DataSource is created and ready for use, Amazon ML sets the Status parameter to COMPLETED. - * DataSource in the COMPLETED or PENDING state can - * be used only to perform >CreateMLModel>, CreateEvaluation, or CreateBatchPrediction operations. - *

- *

- * If Amazon ML cannot accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response. - *

+ * @see {@link CreateDataSourceFromRDSCommand} */ - public createDataSourceFromRDS( + createDataSourceFromRDS( args: CreateDataSourceFromRDSCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDataSourceFromRDS( + createDataSourceFromRDS( args: CreateDataSourceFromRDSCommandInput, cb: (err: any, data?: CreateDataSourceFromRDSCommandOutput) => void ): void; - public createDataSourceFromRDS( + createDataSourceFromRDS( args: CreateDataSourceFromRDSCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataSourceFromRDSCommandOutput) => void ): void; - public createDataSourceFromRDS( - args: CreateDataSourceFromRDSCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDataSourceFromRDSCommandOutput) => void), - cb?: (err: any, data?: CreateDataSourceFromRDSCommandOutput) => void - ): Promise | void { - const command = new CreateDataSourceFromRDSCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a DataSource from a database hosted on an Amazon Redshift cluster. A - * DataSource references data that can be used to perform either CreateMLModel, CreateEvaluation, or CreateBatchPrediction - * operations.

- * - *

- * CreateDataSourceFromRedshift is an asynchronous operation. In response to CreateDataSourceFromRedshift, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. - * After the DataSource is created and ready for use, Amazon ML sets the Status parameter to COMPLETED. - * DataSource in COMPLETED or PENDING states can be - * used to perform only CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations. - *

- * - *

- * If Amazon ML can't accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message - * attribute of the GetDataSource operation response. - *

- * - *

The observations should be contained in the database hosted on an Amazon Redshift cluster - * and should be specified by a SelectSqlQuery query. Amazon ML executes an - * Unload command in Amazon Redshift to transfer the result set of - * the SelectSqlQuery query to S3StagingLocation.

- * - *

After the DataSource has been created, it's ready for use in evaluations and - * batch predictions. If you plan to use the DataSource to train an - * MLModel, the DataSource also requires a recipe. A recipe - * describes how each input variable will be used in training an MLModel. Will - * the variable be included or excluded from training? Will the variable be manipulated; - * for example, will it be combined with another variable or will it be split apart into - * word combinations? The recipe provides answers to these questions.

- *

You can't change an existing datasource, but you can copy and modify the settings from an - * existing Amazon Redshift datasource to create a new datasource. To do so, call - * GetDataSource for an existing datasource and copy the values to a - * CreateDataSource call. Change the settings that you want to change and - * make sure that all required fields have the appropriate values.

+ * @see {@link CreateDataSourceFromRedshiftCommand} */ - public createDataSourceFromRedshift( + createDataSourceFromRedshift( args: CreateDataSourceFromRedshiftCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDataSourceFromRedshift( + createDataSourceFromRedshift( args: CreateDataSourceFromRedshiftCommandInput, cb: (err: any, data?: CreateDataSourceFromRedshiftCommandOutput) => void ): void; - public createDataSourceFromRedshift( + createDataSourceFromRedshift( args: CreateDataSourceFromRedshiftCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataSourceFromRedshiftCommandOutput) => void ): void; - public createDataSourceFromRedshift( - args: CreateDataSourceFromRedshiftCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDataSourceFromRedshiftCommandOutput) => void), - cb?: (err: any, data?: CreateDataSourceFromRedshiftCommandOutput) => void - ): Promise | void { - const command = new CreateDataSourceFromRedshiftCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a DataSource object. A DataSource references data that - * can be used to perform CreateMLModel, CreateEvaluation, or - * CreateBatchPrediction operations.

- * - *

- * CreateDataSourceFromS3 is an asynchronous operation. In response to - * CreateDataSourceFromS3, Amazon Machine Learning (Amazon ML) immediately - * returns and sets the DataSource status to PENDING. After the - * DataSource has been created and is ready for use, Amazon ML sets the - * Status parameter to COMPLETED. DataSource in - * the COMPLETED or PENDING state can be used to perform only - * CreateMLModel, CreateEvaluation or - * CreateBatchPrediction operations.

- * - *

If Amazon ML can't accept the input source, it sets the Status parameter to - * FAILED and includes an error message in the Message - * attribute of the GetDataSource operation response.

- * - *

The observation data used in a DataSource should be ready to use; that is, - * it should have a consistent structure, and missing data values should be kept to a - * minimum. The observation data must reside in one or more .csv files in an Amazon Simple - * Storage Service (Amazon S3) location, along with a schema that describes the data items - * by name and type. The same schema must be used for all of the data files referenced by - * the DataSource.

- *

After the DataSource has been created, it's ready to use in evaluations and - * batch predictions. If you plan to use the DataSource to train an - * MLModel, the DataSource also needs a recipe. A recipe - * describes how each input variable will be used in training an MLModel. Will - * the variable be included or excluded from training? Will the variable be manipulated; - * for example, will it be combined with another variable or will it be split apart into - * word combinations? The recipe provides answers to these questions.

+ * @see {@link CreateDataSourceFromS3Command} */ - public createDataSourceFromS3( + createDataSourceFromS3( args: CreateDataSourceFromS3CommandInput, options?: __HttpHandlerOptions ): Promise; - public createDataSourceFromS3( + createDataSourceFromS3( args: CreateDataSourceFromS3CommandInput, cb: (err: any, data?: CreateDataSourceFromS3CommandOutput) => void ): void; - public createDataSourceFromS3( + createDataSourceFromS3( args: CreateDataSourceFromS3CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataSourceFromS3CommandOutput) => void ): void; - public createDataSourceFromS3( - args: CreateDataSourceFromS3CommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDataSourceFromS3CommandOutput) => void), - cb?: (err: any, data?: CreateDataSourceFromS3CommandOutput) => void - ): Promise | void { - const command = new CreateDataSourceFromS3Command(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new Evaluation of an MLModel. An MLModel is evaluated on a set of observations associated to a DataSource. Like a DataSource - * for an MLModel, the DataSource for an Evaluation contains values for the Target Variable. The Evaluation compares the predicted result for each observation to the actual outcome and provides a - * summary so that you know how effective the MLModel functions on the test - * data. Evaluation generates a relevant performance metric, such as BinaryAUC, RegressionRMSE or MulticlassAvgFScore based on the corresponding MLModelType: BINARY, REGRESSION or MULTICLASS. - * - *

- *

- * CreateEvaluation is an asynchronous operation. In response to CreateEvaluation, Amazon Machine Learning (Amazon ML) immediately - * returns and sets the evaluation status to PENDING. After the Evaluation is created and ready for use, - * Amazon ML sets the status to COMPLETED. - *

- *

You can use the GetEvaluation operation to check progress of the evaluation during the creation operation.

+ * @see {@link CreateEvaluationCommand} */ - public createEvaluation( + createEvaluation( args: CreateEvaluationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEvaluation( + createEvaluation( args: CreateEvaluationCommandInput, cb: (err: any, data?: CreateEvaluationCommandOutput) => void ): void; - public createEvaluation( + createEvaluation( args: CreateEvaluationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEvaluationCommandOutput) => void ): void; - public createEvaluation( - args: CreateEvaluationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEvaluationCommandOutput) => void), - cb?: (err: any, data?: CreateEvaluationCommandOutput) => void - ): Promise | void { - const command = new CreateEvaluationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new MLModel using the DataSource and the recipe as - * information sources.

- *

An MLModel is nearly immutable. Users can update only the - * MLModelName and the ScoreThreshold in an - * MLModel without creating a new MLModel.

- *

- * CreateMLModel is an asynchronous operation. In response to - * CreateMLModel, Amazon Machine Learning (Amazon ML) immediately returns - * and sets the MLModel status to PENDING. After the - * MLModel has been created and ready is for use, Amazon ML sets the - * status to COMPLETED.

- *

You can use the GetMLModel operation to check the progress of the - * MLModel during the creation operation.

- * - *

- * CreateMLModel requires a DataSource with computed statistics, - * which can be created by setting ComputeStatistics to true in - * CreateDataSourceFromRDS, CreateDataSourceFromS3, or - * CreateDataSourceFromRedshift operations. - *

+ * @see {@link CreateMLModelCommand} */ - public createMLModel( - args: CreateMLModelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createMLModel( - args: CreateMLModelCommandInput, - cb: (err: any, data?: CreateMLModelCommandOutput) => void - ): void; - public createMLModel( + createMLModel(args: CreateMLModelCommandInput, options?: __HttpHandlerOptions): Promise; + createMLModel(args: CreateMLModelCommandInput, cb: (err: any, data?: CreateMLModelCommandOutput) => void): void; + createMLModel( args: CreateMLModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMLModelCommandOutput) => void ): void; - public createMLModel( - args: CreateMLModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMLModelCommandOutput) => void), - cb?: (err: any, data?: CreateMLModelCommandOutput) => void - ): Promise | void { - const command = new CreateMLModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a real-time endpoint for the MLModel. The endpoint contains the URI of the MLModel; that is, the location to send real-time prediction requests for the specified MLModel.

+ * @see {@link CreateRealtimeEndpointCommand} */ - public createRealtimeEndpoint( + createRealtimeEndpoint( args: CreateRealtimeEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRealtimeEndpoint( + createRealtimeEndpoint( args: CreateRealtimeEndpointCommandInput, cb: (err: any, data?: CreateRealtimeEndpointCommandOutput) => void ): void; - public createRealtimeEndpoint( + createRealtimeEndpoint( args: CreateRealtimeEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRealtimeEndpointCommandOutput) => void ): void; - public createRealtimeEndpoint( - args: CreateRealtimeEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRealtimeEndpointCommandOutput) => void), - cb?: (err: any, data?: CreateRealtimeEndpointCommandOutput) => void - ): Promise | void { - const command = new CreateRealtimeEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns the DELETED status to a BatchPrediction, rendering it unusable.

- *

After using the DeleteBatchPrediction operation, you can use the GetBatchPrediction - * operation to verify that the status of the BatchPrediction changed to DELETED.

- * - *

- * Caution: The result of the DeleteBatchPrediction operation is irreversible.

+ * @see {@link DeleteBatchPredictionCommand} */ - public deleteBatchPrediction( + deleteBatchPrediction( args: DeleteBatchPredictionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBatchPrediction( + deleteBatchPrediction( args: DeleteBatchPredictionCommandInput, cb: (err: any, data?: DeleteBatchPredictionCommandOutput) => void ): void; - public deleteBatchPrediction( + deleteBatchPrediction( args: DeleteBatchPredictionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBatchPredictionCommandOutput) => void ): void; - public deleteBatchPrediction( - args: DeleteBatchPredictionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBatchPredictionCommandOutput) => void), - cb?: (err: any, data?: DeleteBatchPredictionCommandOutput) => void - ): Promise | void { - const command = new DeleteBatchPredictionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns the DELETED status to a DataSource, rendering it unusable.

- *

After using the DeleteDataSource operation, you can use the GetDataSource operation to verify that the status of the DataSource changed to DELETED.

- *

- * Caution: The results of the DeleteDataSource operation are irreversible.

+ * @see {@link DeleteDataSourceCommand} */ - public deleteDataSource( + deleteDataSource( args: DeleteDataSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDataSource( + deleteDataSource( args: DeleteDataSourceCommandInput, cb: (err: any, data?: DeleteDataSourceCommandOutput) => void ): void; - public deleteDataSource( + deleteDataSource( args: DeleteDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataSourceCommandOutput) => void ): void; - public deleteDataSource( - args: DeleteDataSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDataSourceCommandOutput) => void), - cb?: (err: any, data?: DeleteDataSourceCommandOutput) => void - ): Promise | void { - const command = new DeleteDataSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns the DELETED status to an Evaluation, rendering it unusable.

- * - *

After invoking the DeleteEvaluation operation, you can use the - * GetEvaluation operation to verify that the status of the Evaluation changed to DELETED.

- *

- * Caution: The results of the DeleteEvaluation operation are irreversible.

+ * @see {@link DeleteEvaluationCommand} */ - public deleteEvaluation( + deleteEvaluation( args: DeleteEvaluationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEvaluation( + deleteEvaluation( args: DeleteEvaluationCommandInput, cb: (err: any, data?: DeleteEvaluationCommandOutput) => void ): void; - public deleteEvaluation( + deleteEvaluation( args: DeleteEvaluationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEvaluationCommandOutput) => void ): void; - public deleteEvaluation( - args: DeleteEvaluationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEvaluationCommandOutput) => void), - cb?: (err: any, data?: DeleteEvaluationCommandOutput) => void - ): Promise | void { - const command = new DeleteEvaluationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns the DELETED status to an MLModel, rendering it unusable.

- *

After using the DeleteMLModel operation, you can use the - * GetMLModel operation to verify that the status of the MLModel changed to DELETED.

- * - *

- * Caution: The result of the DeleteMLModel operation is irreversible.

+ * @see {@link DeleteMLModelCommand} */ - public deleteMLModel( - args: DeleteMLModelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteMLModel( - args: DeleteMLModelCommandInput, - cb: (err: any, data?: DeleteMLModelCommandOutput) => void - ): void; - public deleteMLModel( + deleteMLModel(args: DeleteMLModelCommandInput, options?: __HttpHandlerOptions): Promise; + deleteMLModel(args: DeleteMLModelCommandInput, cb: (err: any, data?: DeleteMLModelCommandOutput) => void): void; + deleteMLModel( args: DeleteMLModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMLModelCommandOutput) => void ): void; - public deleteMLModel( - args: DeleteMLModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMLModelCommandOutput) => void), - cb?: (err: any, data?: DeleteMLModelCommandOutput) => void - ): Promise | void { - const command = new DeleteMLModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a real time endpoint of an MLModel.

+ * @see {@link DeleteRealtimeEndpointCommand} */ - public deleteRealtimeEndpoint( + deleteRealtimeEndpoint( args: DeleteRealtimeEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRealtimeEndpoint( + deleteRealtimeEndpoint( args: DeleteRealtimeEndpointCommandInput, cb: (err: any, data?: DeleteRealtimeEndpointCommandOutput) => void ): void; - public deleteRealtimeEndpoint( + deleteRealtimeEndpoint( args: DeleteRealtimeEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRealtimeEndpointCommandOutput) => void ): void; - public deleteRealtimeEndpoint( - args: DeleteRealtimeEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRealtimeEndpointCommandOutput) => void), - cb?: (err: any, data?: DeleteRealtimeEndpointCommandOutput) => void - ): Promise | void { - const command = new DeleteRealtimeEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified tags associated with an ML object. After this operation is complete, you can't recover deleted tags.

- *

If you specify a tag that doesn't exist, Amazon ML ignores it.

+ * @see {@link DeleteTagsCommand} */ - public deleteTags(args: DeleteTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteTags(args: DeleteTagsCommandInput, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void; - public deleteTags( + deleteTags(args: DeleteTagsCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTags(args: DeleteTagsCommandInput, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void; + deleteTags( args: DeleteTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTagsCommandOutput) => void ): void; - public deleteTags( - args: DeleteTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTagsCommandOutput) => void), - cb?: (err: any, data?: DeleteTagsCommandOutput) => void - ): Promise | void { - const command = new DeleteTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of BatchPrediction operations that match the search criteria in the request.

+ * @see {@link DescribeBatchPredictionsCommand} */ - public describeBatchPredictions( + describeBatchPredictions( args: DescribeBatchPredictionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBatchPredictions( + describeBatchPredictions( args: DescribeBatchPredictionsCommandInput, cb: (err: any, data?: DescribeBatchPredictionsCommandOutput) => void ): void; - public describeBatchPredictions( + describeBatchPredictions( args: DescribeBatchPredictionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBatchPredictionsCommandOutput) => void ): void; - public describeBatchPredictions( - args: DescribeBatchPredictionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBatchPredictionsCommandOutput) => void), - cb?: (err: any, data?: DescribeBatchPredictionsCommandOutput) => void - ): Promise | void { - const command = new DescribeBatchPredictionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of DataSource that match the search criteria in the request.

+ * @see {@link DescribeDataSourcesCommand} */ - public describeDataSources( + describeDataSources( args: DescribeDataSourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDataSources( + describeDataSources( args: DescribeDataSourcesCommandInput, cb: (err: any, data?: DescribeDataSourcesCommandOutput) => void ): void; - public describeDataSources( + describeDataSources( args: DescribeDataSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataSourcesCommandOutput) => void ): void; - public describeDataSources( - args: DescribeDataSourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDataSourcesCommandOutput) => void), - cb?: (err: any, data?: DescribeDataSourcesCommandOutput) => void - ): Promise | void { - const command = new DescribeDataSourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of DescribeEvaluations that match the search criteria in the request.

+ * @see {@link DescribeEvaluationsCommand} */ - public describeEvaluations( + describeEvaluations( args: DescribeEvaluationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEvaluations( + describeEvaluations( args: DescribeEvaluationsCommandInput, cb: (err: any, data?: DescribeEvaluationsCommandOutput) => void ): void; - public describeEvaluations( + describeEvaluations( args: DescribeEvaluationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEvaluationsCommandOutput) => void ): void; - public describeEvaluations( - args: DescribeEvaluationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEvaluationsCommandOutput) => void), - cb?: (err: any, data?: DescribeEvaluationsCommandOutput) => void - ): Promise | void { - const command = new DescribeEvaluationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of MLModel that match the search criteria in the request.

+ * @see {@link DescribeMLModelsCommand} */ - public describeMLModels( + describeMLModels( args: DescribeMLModelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMLModels( + describeMLModels( args: DescribeMLModelsCommandInput, cb: (err: any, data?: DescribeMLModelsCommandOutput) => void ): void; - public describeMLModels( + describeMLModels( args: DescribeMLModelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMLModelsCommandOutput) => void ): void; - public describeMLModels( - args: DescribeMLModelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMLModelsCommandOutput) => void), - cb?: (err: any, data?: DescribeMLModelsCommandOutput) => void - ): Promise | void { - const command = new DescribeMLModelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes one or more of the tags for your Amazon ML object.

+ * @see {@link DescribeTagsCommand} */ - public describeTags( - args: DescribeTagsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeTags(args: DescribeTagsCommandInput, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void; - public describeTags( + describeTags(args: DescribeTagsCommandInput, options?: __HttpHandlerOptions): Promise; + describeTags(args: DescribeTagsCommandInput, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void; + describeTags( args: DescribeTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTagsCommandOutput) => void ): void; - public describeTags( - args: DescribeTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTagsCommandOutput) => void), - cb?: (err: any, data?: DescribeTagsCommandOutput) => void - ): Promise | void { - const command = new DescribeTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a BatchPrediction that includes detailed metadata, status, and data file information for a - * Batch Prediction request.

+ * @see {@link GetBatchPredictionCommand} */ - public getBatchPrediction( + getBatchPrediction( args: GetBatchPredictionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBatchPrediction( + getBatchPrediction( args: GetBatchPredictionCommandInput, cb: (err: any, data?: GetBatchPredictionCommandOutput) => void ): void; - public getBatchPrediction( + getBatchPrediction( args: GetBatchPredictionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBatchPredictionCommandOutput) => void ): void; - public getBatchPrediction( - args: GetBatchPredictionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBatchPredictionCommandOutput) => void), - cb?: (err: any, data?: GetBatchPredictionCommandOutput) => void - ): Promise | void { - const command = new GetBatchPredictionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a DataSource that includes metadata and data file information, as well as the current status of the DataSource.

- *

- * GetDataSource provides results in normal or verbose format. The verbose format - * adds the schema description and the list of files pointed to by the DataSource to the normal format.

+ * @see {@link GetDataSourceCommand} */ - public getDataSource( - args: GetDataSourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getDataSource( - args: GetDataSourceCommandInput, - cb: (err: any, data?: GetDataSourceCommandOutput) => void - ): void; - public getDataSource( + getDataSource(args: GetDataSourceCommandInput, options?: __HttpHandlerOptions): Promise; + getDataSource(args: GetDataSourceCommandInput, cb: (err: any, data?: GetDataSourceCommandOutput) => void): void; + getDataSource( args: GetDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataSourceCommandOutput) => void ): void; - public getDataSource( - args: GetDataSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDataSourceCommandOutput) => void), - cb?: (err: any, data?: GetDataSourceCommandOutput) => void - ): Promise | void { - const command = new GetDataSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an Evaluation that includes metadata as well as the current status of the Evaluation.

+ * @see {@link GetEvaluationCommand} */ - public getEvaluation( - args: GetEvaluationCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getEvaluation( - args: GetEvaluationCommandInput, - cb: (err: any, data?: GetEvaluationCommandOutput) => void - ): void; - public getEvaluation( + getEvaluation(args: GetEvaluationCommandInput, options?: __HttpHandlerOptions): Promise; + getEvaluation(args: GetEvaluationCommandInput, cb: (err: any, data?: GetEvaluationCommandOutput) => void): void; + getEvaluation( args: GetEvaluationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEvaluationCommandOutput) => void ): void; - public getEvaluation( - args: GetEvaluationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEvaluationCommandOutput) => void), - cb?: (err: any, data?: GetEvaluationCommandOutput) => void - ): Promise | void { - const command = new GetEvaluationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an MLModel that includes detailed metadata, data source information, and the current status of the MLModel.

- *

- * GetMLModel provides results in normal or verbose format.

+ * @see {@link GetMLModelCommand} */ - public getMLModel(args: GetMLModelCommandInput, options?: __HttpHandlerOptions): Promise; - public getMLModel(args: GetMLModelCommandInput, cb: (err: any, data?: GetMLModelCommandOutput) => void): void; - public getMLModel( + getMLModel(args: GetMLModelCommandInput, options?: __HttpHandlerOptions): Promise; + getMLModel(args: GetMLModelCommandInput, cb: (err: any, data?: GetMLModelCommandOutput) => void): void; + getMLModel( args: GetMLModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMLModelCommandOutput) => void ): void; - public getMLModel( - args: GetMLModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMLModelCommandOutput) => void), - cb?: (err: any, data?: GetMLModelCommandOutput) => void - ): Promise | void { - const command = new GetMLModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Generates a prediction for the observation using the specified ML Model.

- *

- * Note: Not all response parameters will be populated. Whether a - * response parameter is populated depends on the type of model requested.

+ * @see {@link PredictCommand} */ - public predict(args: PredictCommandInput, options?: __HttpHandlerOptions): Promise; - public predict(args: PredictCommandInput, cb: (err: any, data?: PredictCommandOutput) => void): void; - public predict( + predict(args: PredictCommandInput, options?: __HttpHandlerOptions): Promise; + predict(args: PredictCommandInput, cb: (err: any, data?: PredictCommandOutput) => void): void; + predict( args: PredictCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PredictCommandOutput) => void ): void; - public predict( - args: PredictCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PredictCommandOutput) => void), - cb?: (err: any, data?: PredictCommandOutput) => void - ): Promise | void { - const command = new PredictCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the BatchPredictionName of a BatchPrediction.

- *

You can use the GetBatchPrediction operation to view the contents of the updated data element.

+ * @see {@link UpdateBatchPredictionCommand} */ - public updateBatchPrediction( + updateBatchPrediction( args: UpdateBatchPredictionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBatchPrediction( + updateBatchPrediction( args: UpdateBatchPredictionCommandInput, cb: (err: any, data?: UpdateBatchPredictionCommandOutput) => void ): void; - public updateBatchPrediction( + updateBatchPrediction( args: UpdateBatchPredictionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBatchPredictionCommandOutput) => void ): void; - public updateBatchPrediction( - args: UpdateBatchPredictionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBatchPredictionCommandOutput) => void), - cb?: (err: any, data?: UpdateBatchPredictionCommandOutput) => void - ): Promise | void { - const command = new UpdateBatchPredictionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the DataSourceName of a DataSource.

- *

You can use the GetDataSource operation to view the contents of the updated data element.

+ * @see {@link UpdateDataSourceCommand} */ - public updateDataSource( + updateDataSource( args: UpdateDataSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDataSource( + updateDataSource( args: UpdateDataSourceCommandInput, cb: (err: any, data?: UpdateDataSourceCommandOutput) => void ): void; - public updateDataSource( + updateDataSource( args: UpdateDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDataSourceCommandOutput) => void ): void; - public updateDataSource( - args: UpdateDataSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDataSourceCommandOutput) => void), - cb?: (err: any, data?: UpdateDataSourceCommandOutput) => void - ): Promise | void { - const command = new UpdateDataSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the EvaluationName of an Evaluation.

- *

You can use the GetEvaluation operation to view the contents of the updated data element.

+ * @see {@link UpdateEvaluationCommand} */ - public updateEvaluation( + updateEvaluation( args: UpdateEvaluationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEvaluation( + updateEvaluation( args: UpdateEvaluationCommandInput, cb: (err: any, data?: UpdateEvaluationCommandOutput) => void ): void; - public updateEvaluation( + updateEvaluation( args: UpdateEvaluationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEvaluationCommandOutput) => void ): void; - public updateEvaluation( - args: UpdateEvaluationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEvaluationCommandOutput) => void), - cb?: (err: any, data?: UpdateEvaluationCommandOutput) => void - ): Promise | void { - const command = new UpdateEvaluationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the MLModelName and the ScoreThreshold of an MLModel.

- *

You can use the GetMLModel operation to view the contents of the updated data element.

+ * @see {@link UpdateMLModelCommand} */ - public updateMLModel( - args: UpdateMLModelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateMLModel( - args: UpdateMLModelCommandInput, - cb: (err: any, data?: UpdateMLModelCommandOutput) => void - ): void; - public updateMLModel( + updateMLModel(args: UpdateMLModelCommandInput, options?: __HttpHandlerOptions): Promise; + updateMLModel(args: UpdateMLModelCommandInput, cb: (err: any, data?: UpdateMLModelCommandOutput) => void): void; + updateMLModel( args: UpdateMLModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMLModelCommandOutput) => void ): void; - public updateMLModel( - args: UpdateMLModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMLModelCommandOutput) => void), - cb?: (err: any, data?: UpdateMLModelCommandOutput) => void - ): Promise | void { - const command = new UpdateMLModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Definition of the public APIs + * exposed by Amazon Machine Learning + */ +export class MachineLearning extends MachineLearningClient implements MachineLearning {} +createAggregatedClient(commands, MachineLearning); diff --git a/clients/client-macie/src/Macie.ts b/clients/client-macie/src/Macie.ts index 66d355b81c29..4769d8fd17bf 100644 --- a/clients/client-macie/src/Macie.ts +++ b/clients/client-macie/src/Macie.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -36,266 +37,145 @@ import { UpdateS3ResourcesCommandInput, UpdateS3ResourcesCommandOutput, } from "./commands/UpdateS3ResourcesCommand"; -import { MacieClient } from "./MacieClient"; +import { MacieClient, MacieClientConfig } from "./MacieClient"; -/** - * @public - * Amazon Macie Classic - *

Amazon Macie Classic has been discontinued and is no longer available.

- * - *

A new Amazon Macie is now available with significant design improvements and additional - * features, at a lower price and in most Amazon Web Services Regions. We encourage you to take advantage of the - * new and improved features, and benefit from the reduced cost. To learn about features and pricing for the new Macie, see Amazon Macie. To learn how to use the new Macie, see the Amazon Macie User - * Guide.

- */ -export class Macie extends MacieClient { +const commands = { + AssociateMemberAccountCommand, + AssociateS3ResourcesCommand, + DisassociateMemberAccountCommand, + DisassociateS3ResourcesCommand, + ListMemberAccountsCommand, + ListS3ResourcesCommand, + UpdateS3ResourcesCommand, +}; + +export interface Macie { /** - * @public - *

(Discontinued) Associates a specified Amazon Web Services account with Amazon Macie Classic as a member - * account.

+ * @see {@link AssociateMemberAccountCommand} */ - public associateMemberAccount( + associateMemberAccount( args: AssociateMemberAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateMemberAccount( + associateMemberAccount( args: AssociateMemberAccountCommandInput, cb: (err: any, data?: AssociateMemberAccountCommandOutput) => void ): void; - public associateMemberAccount( + associateMemberAccount( args: AssociateMemberAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateMemberAccountCommandOutput) => void ): void; - public associateMemberAccount( - args: AssociateMemberAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateMemberAccountCommandOutput) => void), - cb?: (err: any, data?: AssociateMemberAccountCommandOutput) => void - ): Promise | void { - const command = new AssociateMemberAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

(Discontinued) Associates specified S3 resources with Amazon Macie Classic for - * monitoring and data classification. If memberAccountId isn't specified, the action associates - * specified S3 resources with Macie Classic for the current Macie Classic administrator account. - * If memberAccountId is specified, the action associates specified S3 resources with Macie - * Classic for the specified member account.

+ * @see {@link AssociateS3ResourcesCommand} */ - public associateS3Resources( + associateS3Resources( args: AssociateS3ResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateS3Resources( + associateS3Resources( args: AssociateS3ResourcesCommandInput, cb: (err: any, data?: AssociateS3ResourcesCommandOutput) => void ): void; - public associateS3Resources( + associateS3Resources( args: AssociateS3ResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateS3ResourcesCommandOutput) => void ): void; - public associateS3Resources( - args: AssociateS3ResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateS3ResourcesCommandOutput) => void), - cb?: (err: any, data?: AssociateS3ResourcesCommandOutput) => void - ): Promise | void { - const command = new AssociateS3ResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

(Discontinued) Removes the specified member account from Amazon Macie - * Classic.

+ * @see {@link DisassociateMemberAccountCommand} */ - public disassociateMemberAccount( + disassociateMemberAccount( args: DisassociateMemberAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateMemberAccount( + disassociateMemberAccount( args: DisassociateMemberAccountCommandInput, cb: (err: any, data?: DisassociateMemberAccountCommandOutput) => void ): void; - public disassociateMemberAccount( + disassociateMemberAccount( args: DisassociateMemberAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateMemberAccountCommandOutput) => void ): void; - public disassociateMemberAccount( - args: DisassociateMemberAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateMemberAccountCommandOutput) => void), - cb?: (err: any, data?: DisassociateMemberAccountCommandOutput) => void - ): Promise | void { - const command = new DisassociateMemberAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

(Discontinued) Removes specified S3 resources from being monitored by Amazon Macie - * Classic. If memberAccountId isn't specified, the action removes specified S3 resources from - * Macie Classic for the current Macie Classic administrator account. If memberAccountId is - * specified, the action removes specified S3 resources from Macie Classic for the specified - * member account.

+ * @see {@link DisassociateS3ResourcesCommand} */ - public disassociateS3Resources( + disassociateS3Resources( args: DisassociateS3ResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateS3Resources( + disassociateS3Resources( args: DisassociateS3ResourcesCommandInput, cb: (err: any, data?: DisassociateS3ResourcesCommandOutput) => void ): void; - public disassociateS3Resources( + disassociateS3Resources( args: DisassociateS3ResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateS3ResourcesCommandOutput) => void ): void; - public disassociateS3Resources( - args: DisassociateS3ResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateS3ResourcesCommandOutput) => void), - cb?: (err: any, data?: DisassociateS3ResourcesCommandOutput) => void - ): Promise | void { - const command = new DisassociateS3ResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

(Discontinued) Lists all Amazon Macie Classic member accounts for the current Macie - * Classic administrator account.

+ * @see {@link ListMemberAccountsCommand} */ - public listMemberAccounts( + listMemberAccounts( args: ListMemberAccountsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMemberAccounts( + listMemberAccounts( args: ListMemberAccountsCommandInput, cb: (err: any, data?: ListMemberAccountsCommandOutput) => void ): void; - public listMemberAccounts( + listMemberAccounts( args: ListMemberAccountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMemberAccountsCommandOutput) => void ): void; - public listMemberAccounts( - args: ListMemberAccountsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMemberAccountsCommandOutput) => void), - cb?: (err: any, data?: ListMemberAccountsCommandOutput) => void - ): Promise | void { - const command = new ListMemberAccountsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

(Discontinued) Lists all the S3 resources associated with Amazon Macie Classic. If - * memberAccountId isn't specified, the action lists the S3 resources associated with Macie - * Classic for the current Macie Classic administrator account. If memberAccountId is specified, - * the action lists the S3 resources associated with Macie Classic for the specified member - * account.

+ * @see {@link ListS3ResourcesCommand} */ - public listS3Resources( + listS3Resources( args: ListS3ResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listS3Resources( - args: ListS3ResourcesCommandInput, - cb: (err: any, data?: ListS3ResourcesCommandOutput) => void - ): void; - public listS3Resources( + listS3Resources(args: ListS3ResourcesCommandInput, cb: (err: any, data?: ListS3ResourcesCommandOutput) => void): void; + listS3Resources( args: ListS3ResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListS3ResourcesCommandOutput) => void ): void; - public listS3Resources( - args: ListS3ResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListS3ResourcesCommandOutput) => void), - cb?: (err: any, data?: ListS3ResourcesCommandOutput) => void - ): Promise | void { - const command = new ListS3ResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

(Discontinued) Updates the classification types for the specified S3 resources. If - * memberAccountId isn't specified, the action updates the classification types of the S3 - * resources associated with Amazon Macie Classic for the current Macie Classic administrator - * account. If memberAccountId is specified, the action updates the classification types of the - * S3 resources associated with Macie Classic for the specified member account.

+ * @see {@link UpdateS3ResourcesCommand} */ - public updateS3Resources( + updateS3Resources( args: UpdateS3ResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateS3Resources( + updateS3Resources( args: UpdateS3ResourcesCommandInput, cb: (err: any, data?: UpdateS3ResourcesCommandOutput) => void ): void; - public updateS3Resources( + updateS3Resources( args: UpdateS3ResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateS3ResourcesCommandOutput) => void ): void; - public updateS3Resources( - args: UpdateS3ResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateS3ResourcesCommandOutput) => void), - cb?: (err: any, data?: UpdateS3ResourcesCommandOutput) => void - ): Promise | void { - const command = new UpdateS3ResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Macie Classic + *

Amazon Macie Classic has been discontinued and is no longer available.

+ * + *

A new Amazon Macie is now available with significant design improvements and additional + * features, at a lower price and in most Amazon Web Services Regions. We encourage you to take advantage of the + * new and improved features, and benefit from the reduced cost. To learn about features and pricing for the new Macie, see Amazon Macie. To learn how to use the new Macie, see the Amazon Macie User + * Guide.

+ */ +export class Macie extends MacieClient implements Macie {} +createAggregatedClient(commands, Macie); diff --git a/clients/client-macie2/src/Macie2.ts b/clients/client-macie2/src/Macie2.ts index e3fa03b3d76b..9778bdcc29c5 100644 --- a/clients/client-macie2/src/Macie2.ts +++ b/clients/client-macie2/src/Macie2.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -376,2576 +377,1345 @@ import { UpdateSensitivityInspectionTemplateCommandInput, UpdateSensitivityInspectionTemplateCommandOutput, } from "./commands/UpdateSensitivityInspectionTemplateCommand"; -import { Macie2Client } from "./Macie2Client"; +import { Macie2Client, Macie2ClientConfig } from "./Macie2Client"; -/** - * @public - *

Amazon Macie

- */ -export class Macie2 extends Macie2Client { +const commands = { + AcceptInvitationCommand, + BatchGetCustomDataIdentifiersCommand, + CreateAllowListCommand, + CreateClassificationJobCommand, + CreateCustomDataIdentifierCommand, + CreateFindingsFilterCommand, + CreateInvitationsCommand, + CreateMemberCommand, + CreateSampleFindingsCommand, + DeclineInvitationsCommand, + DeleteAllowListCommand, + DeleteCustomDataIdentifierCommand, + DeleteFindingsFilterCommand, + DeleteInvitationsCommand, + DeleteMemberCommand, + DescribeBucketsCommand, + DescribeClassificationJobCommand, + DescribeOrganizationConfigurationCommand, + DisableMacieCommand, + DisableOrganizationAdminAccountCommand, + DisassociateFromAdministratorAccountCommand, + DisassociateFromMasterAccountCommand, + DisassociateMemberCommand, + EnableMacieCommand, + EnableOrganizationAdminAccountCommand, + GetAdministratorAccountCommand, + GetAllowListCommand, + GetAutomatedDiscoveryConfigurationCommand, + GetBucketStatisticsCommand, + GetClassificationExportConfigurationCommand, + GetClassificationScopeCommand, + GetCustomDataIdentifierCommand, + GetFindingsCommand, + GetFindingsFilterCommand, + GetFindingsPublicationConfigurationCommand, + GetFindingStatisticsCommand, + GetInvitationsCountCommand, + GetMacieSessionCommand, + GetMasterAccountCommand, + GetMemberCommand, + GetResourceProfileCommand, + GetRevealConfigurationCommand, + GetSensitiveDataOccurrencesCommand, + GetSensitiveDataOccurrencesAvailabilityCommand, + GetSensitivityInspectionTemplateCommand, + GetUsageStatisticsCommand, + GetUsageTotalsCommand, + ListAllowListsCommand, + ListClassificationJobsCommand, + ListClassificationScopesCommand, + ListCustomDataIdentifiersCommand, + ListFindingsCommand, + ListFindingsFiltersCommand, + ListInvitationsCommand, + ListManagedDataIdentifiersCommand, + ListMembersCommand, + ListOrganizationAdminAccountsCommand, + ListResourceProfileArtifactsCommand, + ListResourceProfileDetectionsCommand, + ListSensitivityInspectionTemplatesCommand, + ListTagsForResourceCommand, + PutClassificationExportConfigurationCommand, + PutFindingsPublicationConfigurationCommand, + SearchResourcesCommand, + TagResourceCommand, + TestCustomDataIdentifierCommand, + UntagResourceCommand, + UpdateAllowListCommand, + UpdateAutomatedDiscoveryConfigurationCommand, + UpdateClassificationJobCommand, + UpdateClassificationScopeCommand, + UpdateFindingsFilterCommand, + UpdateMacieSessionCommand, + UpdateMemberSessionCommand, + UpdateOrganizationConfigurationCommand, + UpdateResourceProfileCommand, + UpdateResourceProfileDetectionsCommand, + UpdateRevealConfigurationCommand, + UpdateSensitivityInspectionTemplateCommand, +}; + +export interface Macie2 { /** - * @public - *

Accepts an Amazon Macie membership invitation that was received from a specific account.

+ * @see {@link AcceptInvitationCommand} */ - public acceptInvitation( + acceptInvitation( args: AcceptInvitationCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptInvitation( + acceptInvitation( args: AcceptInvitationCommandInput, cb: (err: any, data?: AcceptInvitationCommandOutput) => void ): void; - public acceptInvitation( + acceptInvitation( args: AcceptInvitationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptInvitationCommandOutput) => void ): void; - public acceptInvitation( - args: AcceptInvitationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptInvitationCommandOutput) => void), - cb?: (err: any, data?: AcceptInvitationCommandOutput) => void - ): Promise | void { - const command = new AcceptInvitationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about one or more custom data identifiers.

- */ - public batchGetCustomDataIdentifiers( + + /** + * @see {@link BatchGetCustomDataIdentifiersCommand} + */ + batchGetCustomDataIdentifiers( args: BatchGetCustomDataIdentifiersCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetCustomDataIdentifiers( + batchGetCustomDataIdentifiers( args: BatchGetCustomDataIdentifiersCommandInput, cb: (err: any, data?: BatchGetCustomDataIdentifiersCommandOutput) => void ): void; - public batchGetCustomDataIdentifiers( + batchGetCustomDataIdentifiers( args: BatchGetCustomDataIdentifiersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetCustomDataIdentifiersCommandOutput) => void ): void; - public batchGetCustomDataIdentifiers( - args: BatchGetCustomDataIdentifiersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetCustomDataIdentifiersCommandOutput) => void), - cb?: (err: any, data?: BatchGetCustomDataIdentifiersCommandOutput) => void - ): Promise | void { - const command = new BatchGetCustomDataIdentifiersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates and defines the settings for an allow list.

- */ - public createAllowList( + + /** + * @see {@link CreateAllowListCommand} + */ + createAllowList( args: CreateAllowListCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAllowList( - args: CreateAllowListCommandInput, - cb: (err: any, data?: CreateAllowListCommandOutput) => void - ): void; - public createAllowList( + createAllowList(args: CreateAllowListCommandInput, cb: (err: any, data?: CreateAllowListCommandOutput) => void): void; + createAllowList( args: CreateAllowListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAllowListCommandOutput) => void ): void; - public createAllowList( - args: CreateAllowListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAllowListCommandOutput) => void), - cb?: (err: any, data?: CreateAllowListCommandOutput) => void - ): Promise | void { - const command = new CreateAllowListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates and defines the settings for a classification job.

- */ - public createClassificationJob( + + /** + * @see {@link CreateClassificationJobCommand} + */ + createClassificationJob( args: CreateClassificationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createClassificationJob( + createClassificationJob( args: CreateClassificationJobCommandInput, cb: (err: any, data?: CreateClassificationJobCommandOutput) => void ): void; - public createClassificationJob( + createClassificationJob( args: CreateClassificationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClassificationJobCommandOutput) => void ): void; - public createClassificationJob( - args: CreateClassificationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateClassificationJobCommandOutput) => void), - cb?: (err: any, data?: CreateClassificationJobCommandOutput) => void - ): Promise | void { - const command = new CreateClassificationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates and defines the criteria and other settings for a custom data identifier.

- */ - public createCustomDataIdentifier( + + /** + * @see {@link CreateCustomDataIdentifierCommand} + */ + createCustomDataIdentifier( args: CreateCustomDataIdentifierCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCustomDataIdentifier( + createCustomDataIdentifier( args: CreateCustomDataIdentifierCommandInput, cb: (err: any, data?: CreateCustomDataIdentifierCommandOutput) => void ): void; - public createCustomDataIdentifier( + createCustomDataIdentifier( args: CreateCustomDataIdentifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomDataIdentifierCommandOutput) => void ): void; - public createCustomDataIdentifier( - args: CreateCustomDataIdentifierCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCustomDataIdentifierCommandOutput) => void), - cb?: (err: any, data?: CreateCustomDataIdentifierCommandOutput) => void - ): Promise | void { - const command = new CreateCustomDataIdentifierCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates and defines the criteria and other settings for a findings filter.

- */ - public createFindingsFilter( + + /** + * @see {@link CreateFindingsFilterCommand} + */ + createFindingsFilter( args: CreateFindingsFilterCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFindingsFilter( + createFindingsFilter( args: CreateFindingsFilterCommandInput, cb: (err: any, data?: CreateFindingsFilterCommandOutput) => void ): void; - public createFindingsFilter( + createFindingsFilter( args: CreateFindingsFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFindingsFilterCommandOutput) => void ): void; - public createFindingsFilter( - args: CreateFindingsFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFindingsFilterCommandOutput) => void), - cb?: (err: any, data?: CreateFindingsFilterCommandOutput) => void - ): Promise | void { - const command = new CreateFindingsFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sends an Amazon Macie membership invitation to one or more accounts.

- */ - public createInvitations( + + /** + * @see {@link CreateInvitationsCommand} + */ + createInvitations( args: CreateInvitationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public createInvitations( + createInvitations( args: CreateInvitationsCommandInput, cb: (err: any, data?: CreateInvitationsCommandOutput) => void ): void; - public createInvitations( + createInvitations( args: CreateInvitationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInvitationsCommandOutput) => void ): void; - public createInvitations( - args: CreateInvitationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateInvitationsCommandOutput) => void), - cb?: (err: any, data?: CreateInvitationsCommandOutput) => void - ): Promise | void { - const command = new CreateInvitationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates an account with an Amazon Macie administrator account.

- */ - public createMember( - args: CreateMemberCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createMember(args: CreateMemberCommandInput, cb: (err: any, data?: CreateMemberCommandOutput) => void): void; - public createMember( + + /** + * @see {@link CreateMemberCommand} + */ + createMember(args: CreateMemberCommandInput, options?: __HttpHandlerOptions): Promise; + createMember(args: CreateMemberCommandInput, cb: (err: any, data?: CreateMemberCommandOutput) => void): void; + createMember( args: CreateMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMemberCommandOutput) => void ): void; - public createMember( - args: CreateMemberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMemberCommandOutput) => void), - cb?: (err: any, data?: CreateMemberCommandOutput) => void - ): Promise | void { - const command = new CreateMemberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates sample findings.

- */ - public createSampleFindings( + + /** + * @see {@link CreateSampleFindingsCommand} + */ + createSampleFindings( args: CreateSampleFindingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSampleFindings( + createSampleFindings( args: CreateSampleFindingsCommandInput, cb: (err: any, data?: CreateSampleFindingsCommandOutput) => void ): void; - public createSampleFindings( + createSampleFindings( args: CreateSampleFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSampleFindingsCommandOutput) => void ): void; - public createSampleFindings( - args: CreateSampleFindingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSampleFindingsCommandOutput) => void), - cb?: (err: any, data?: CreateSampleFindingsCommandOutput) => void - ): Promise | void { - const command = new CreateSampleFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Declines Amazon Macie membership invitations that were received from specific accounts.

- */ - public declineInvitations( + + /** + * @see {@link DeclineInvitationsCommand} + */ + declineInvitations( args: DeclineInvitationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public declineInvitations( + declineInvitations( args: DeclineInvitationsCommandInput, cb: (err: any, data?: DeclineInvitationsCommandOutput) => void ): void; - public declineInvitations( + declineInvitations( args: DeclineInvitationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeclineInvitationsCommandOutput) => void ): void; - public declineInvitations( - args: DeclineInvitationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeclineInvitationsCommandOutput) => void), - cb?: (err: any, data?: DeclineInvitationsCommandOutput) => void - ): Promise | void { - const command = new DeclineInvitationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an allow list.

- */ - public deleteAllowList( + + /** + * @see {@link DeleteAllowListCommand} + */ + deleteAllowList( args: DeleteAllowListCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAllowList( - args: DeleteAllowListCommandInput, - cb: (err: any, data?: DeleteAllowListCommandOutput) => void - ): void; - public deleteAllowList( + deleteAllowList(args: DeleteAllowListCommandInput, cb: (err: any, data?: DeleteAllowListCommandOutput) => void): void; + deleteAllowList( args: DeleteAllowListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAllowListCommandOutput) => void ): void; - public deleteAllowList( - args: DeleteAllowListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAllowListCommandOutput) => void), - cb?: (err: any, data?: DeleteAllowListCommandOutput) => void - ): Promise | void { - const command = new DeleteAllowListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Soft deletes a custom data identifier.

- */ - public deleteCustomDataIdentifier( + + /** + * @see {@link DeleteCustomDataIdentifierCommand} + */ + deleteCustomDataIdentifier( args: DeleteCustomDataIdentifierCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCustomDataIdentifier( + deleteCustomDataIdentifier( args: DeleteCustomDataIdentifierCommandInput, cb: (err: any, data?: DeleteCustomDataIdentifierCommandOutput) => void ): void; - public deleteCustomDataIdentifier( + deleteCustomDataIdentifier( args: DeleteCustomDataIdentifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomDataIdentifierCommandOutput) => void ): void; - public deleteCustomDataIdentifier( - args: DeleteCustomDataIdentifierCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCustomDataIdentifierCommandOutput) => void), - cb?: (err: any, data?: DeleteCustomDataIdentifierCommandOutput) => void - ): Promise | void { - const command = new DeleteCustomDataIdentifierCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a findings filter.

- */ - public deleteFindingsFilter( + + /** + * @see {@link DeleteFindingsFilterCommand} + */ + deleteFindingsFilter( args: DeleteFindingsFilterCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFindingsFilter( + deleteFindingsFilter( args: DeleteFindingsFilterCommandInput, cb: (err: any, data?: DeleteFindingsFilterCommandOutput) => void ): void; - public deleteFindingsFilter( + deleteFindingsFilter( args: DeleteFindingsFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFindingsFilterCommandOutput) => void ): void; - public deleteFindingsFilter( - args: DeleteFindingsFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFindingsFilterCommandOutput) => void), - cb?: (err: any, data?: DeleteFindingsFilterCommandOutput) => void - ): Promise | void { - const command = new DeleteFindingsFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes Amazon Macie membership invitations that were received from specific accounts.

- */ - public deleteInvitations( + + /** + * @see {@link DeleteInvitationsCommand} + */ + deleteInvitations( args: DeleteInvitationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInvitations( + deleteInvitations( args: DeleteInvitationsCommandInput, cb: (err: any, data?: DeleteInvitationsCommandOutput) => void ): void; - public deleteInvitations( + deleteInvitations( args: DeleteInvitationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInvitationsCommandOutput) => void ): void; - public deleteInvitations( - args: DeleteInvitationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInvitationsCommandOutput) => void), - cb?: (err: any, data?: DeleteInvitationsCommandOutput) => void - ): Promise | void { - const command = new DeleteInvitationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the association between an Amazon Macie administrator account and an account.

- */ - public deleteMember( - args: DeleteMemberCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteMember(args: DeleteMemberCommandInput, cb: (err: any, data?: DeleteMemberCommandOutput) => void): void; - public deleteMember( + + /** + * @see {@link DeleteMemberCommand} + */ + deleteMember(args: DeleteMemberCommandInput, options?: __HttpHandlerOptions): Promise; + deleteMember(args: DeleteMemberCommandInput, cb: (err: any, data?: DeleteMemberCommandOutput) => void): void; + deleteMember( args: DeleteMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMemberCommandOutput) => void ): void; - public deleteMember( - args: DeleteMemberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMemberCommandOutput) => void), - cb?: (err: any, data?: DeleteMemberCommandOutput) => void - ): Promise | void { - const command = new DeleteMemberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes for an account.

- */ - public describeBuckets( + + /** + * @see {@link DescribeBucketsCommand} + */ + describeBuckets( args: DescribeBucketsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBuckets( - args: DescribeBucketsCommandInput, - cb: (err: any, data?: DescribeBucketsCommandOutput) => void - ): void; - public describeBuckets( + describeBuckets(args: DescribeBucketsCommandInput, cb: (err: any, data?: DescribeBucketsCommandOutput) => void): void; + describeBuckets( args: DescribeBucketsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBucketsCommandOutput) => void ): void; - public describeBuckets( - args: DescribeBucketsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBucketsCommandOutput) => void), - cb?: (err: any, data?: DescribeBucketsCommandOutput) => void - ): Promise | void { - const command = new DescribeBucketsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the status and settings for a classification job.

- */ - public describeClassificationJob( + + /** + * @see {@link DescribeClassificationJobCommand} + */ + describeClassificationJob( args: DescribeClassificationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClassificationJob( + describeClassificationJob( args: DescribeClassificationJobCommandInput, cb: (err: any, data?: DescribeClassificationJobCommandOutput) => void ): void; - public describeClassificationJob( + describeClassificationJob( args: DescribeClassificationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClassificationJobCommandOutput) => void ): void; - public describeClassificationJob( - args: DescribeClassificationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClassificationJobCommandOutput) => void), - cb?: (err: any, data?: DescribeClassificationJobCommandOutput) => void - ): Promise | void { - const command = new DescribeClassificationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the Amazon Macie configuration settings for an organization in Organizations.

- */ - public describeOrganizationConfiguration( + + /** + * @see {@link DescribeOrganizationConfigurationCommand} + */ + describeOrganizationConfiguration( args: DescribeOrganizationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOrganizationConfiguration( + describeOrganizationConfiguration( args: DescribeOrganizationConfigurationCommandInput, cb: (err: any, data?: DescribeOrganizationConfigurationCommandOutput) => void ): void; - public describeOrganizationConfiguration( + describeOrganizationConfiguration( args: DescribeOrganizationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrganizationConfigurationCommandOutput) => void ): void; - public describeOrganizationConfiguration( - args: DescribeOrganizationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOrganizationConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeOrganizationConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeOrganizationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables Amazon Macie and deletes all settings and resources for a Macie account.

- */ - public disableMacie( - args: DisableMacieCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public disableMacie(args: DisableMacieCommandInput, cb: (err: any, data?: DisableMacieCommandOutput) => void): void; - public disableMacie( + + /** + * @see {@link DisableMacieCommand} + */ + disableMacie(args: DisableMacieCommandInput, options?: __HttpHandlerOptions): Promise; + disableMacie(args: DisableMacieCommandInput, cb: (err: any, data?: DisableMacieCommandOutput) => void): void; + disableMacie( args: DisableMacieCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableMacieCommandOutput) => void ): void; - public disableMacie( - args: DisableMacieCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableMacieCommandOutput) => void), - cb?: (err: any, data?: DisableMacieCommandOutput) => void - ): Promise | void { - const command = new DisableMacieCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables an account as the delegated Amazon Macie administrator account for an organization in Organizations.

- */ - public disableOrganizationAdminAccount( + + /** + * @see {@link DisableOrganizationAdminAccountCommand} + */ + disableOrganizationAdminAccount( args: DisableOrganizationAdminAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableOrganizationAdminAccount( + disableOrganizationAdminAccount( args: DisableOrganizationAdminAccountCommandInput, cb: (err: any, data?: DisableOrganizationAdminAccountCommandOutput) => void ): void; - public disableOrganizationAdminAccount( + disableOrganizationAdminAccount( args: DisableOrganizationAdminAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableOrganizationAdminAccountCommandOutput) => void ): void; - public disableOrganizationAdminAccount( - args: DisableOrganizationAdminAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableOrganizationAdminAccountCommandOutput) => void), - cb?: (err: any, data?: DisableOrganizationAdminAccountCommandOutput) => void - ): Promise | void { - const command = new DisableOrganizationAdminAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a member account from its Amazon Macie administrator account.

- */ - public disassociateFromAdministratorAccount( + + /** + * @see {@link DisassociateFromAdministratorAccountCommand} + */ + disassociateFromAdministratorAccount( args: DisassociateFromAdministratorAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateFromAdministratorAccount( + disassociateFromAdministratorAccount( args: DisassociateFromAdministratorAccountCommandInput, cb: (err: any, data?: DisassociateFromAdministratorAccountCommandOutput) => void ): void; - public disassociateFromAdministratorAccount( + disassociateFromAdministratorAccount( args: DisassociateFromAdministratorAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateFromAdministratorAccountCommandOutput) => void ): void; - public disassociateFromAdministratorAccount( - args: DisassociateFromAdministratorAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateFromAdministratorAccountCommandOutput) => void), - cb?: (err: any, data?: DisassociateFromAdministratorAccountCommandOutput) => void - ): Promise | void { - const command = new DisassociateFromAdministratorAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

(Deprecated) Disassociates a member account from its Amazon Macie administrator account. This operation has been replaced by the DisassociateFromAdministratorAccount operation.

- */ - public disassociateFromMasterAccount( + + /** + * @see {@link DisassociateFromMasterAccountCommand} + */ + disassociateFromMasterAccount( args: DisassociateFromMasterAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateFromMasterAccount( + disassociateFromMasterAccount( args: DisassociateFromMasterAccountCommandInput, cb: (err: any, data?: DisassociateFromMasterAccountCommandOutput) => void ): void; - public disassociateFromMasterAccount( + disassociateFromMasterAccount( args: DisassociateFromMasterAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateFromMasterAccountCommandOutput) => void ): void; - public disassociateFromMasterAccount( - args: DisassociateFromMasterAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateFromMasterAccountCommandOutput) => void), - cb?: (err: any, data?: DisassociateFromMasterAccountCommandOutput) => void - ): Promise | void { - const command = new DisassociateFromMasterAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates an Amazon Macie administrator account from a member account.

- */ - public disassociateMember( + + /** + * @see {@link DisassociateMemberCommand} + */ + disassociateMember( args: DisassociateMemberCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateMember( + disassociateMember( args: DisassociateMemberCommandInput, cb: (err: any, data?: DisassociateMemberCommandOutput) => void ): void; - public disassociateMember( + disassociateMember( args: DisassociateMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateMemberCommandOutput) => void ): void; - public disassociateMember( - args: DisassociateMemberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateMemberCommandOutput) => void), - cb?: (err: any, data?: DisassociateMemberCommandOutput) => void - ): Promise | void { - const command = new DisassociateMemberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables Amazon Macie and specifies the configuration settings for a Macie account.

- */ - public enableMacie(args: EnableMacieCommandInput, options?: __HttpHandlerOptions): Promise; - public enableMacie(args: EnableMacieCommandInput, cb: (err: any, data?: EnableMacieCommandOutput) => void): void; - public enableMacie( + + /** + * @see {@link EnableMacieCommand} + */ + enableMacie(args: EnableMacieCommandInput, options?: __HttpHandlerOptions): Promise; + enableMacie(args: EnableMacieCommandInput, cb: (err: any, data?: EnableMacieCommandOutput) => void): void; + enableMacie( args: EnableMacieCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableMacieCommandOutput) => void ): void; - public enableMacie( - args: EnableMacieCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableMacieCommandOutput) => void), - cb?: (err: any, data?: EnableMacieCommandOutput) => void - ): Promise | void { - const command = new EnableMacieCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Designates an account as the delegated Amazon Macie administrator account for an organization in Organizations.

- */ - public enableOrganizationAdminAccount( + + /** + * @see {@link EnableOrganizationAdminAccountCommand} + */ + enableOrganizationAdminAccount( args: EnableOrganizationAdminAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableOrganizationAdminAccount( + enableOrganizationAdminAccount( args: EnableOrganizationAdminAccountCommandInput, cb: (err: any, data?: EnableOrganizationAdminAccountCommandOutput) => void ): void; - public enableOrganizationAdminAccount( + enableOrganizationAdminAccount( args: EnableOrganizationAdminAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableOrganizationAdminAccountCommandOutput) => void ): void; - public enableOrganizationAdminAccount( - args: EnableOrganizationAdminAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableOrganizationAdminAccountCommandOutput) => void), - cb?: (err: any, data?: EnableOrganizationAdminAccountCommandOutput) => void - ): Promise | void { - const command = new EnableOrganizationAdminAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about the Amazon Macie administrator account for an account.

- */ - public getAdministratorAccount( + + /** + * @see {@link GetAdministratorAccountCommand} + */ + getAdministratorAccount( args: GetAdministratorAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAdministratorAccount( + getAdministratorAccount( args: GetAdministratorAccountCommandInput, cb: (err: any, data?: GetAdministratorAccountCommandOutput) => void ): void; - public getAdministratorAccount( + getAdministratorAccount( args: GetAdministratorAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAdministratorAccountCommandOutput) => void ): void; - public getAdministratorAccount( - args: GetAdministratorAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAdministratorAccountCommandOutput) => void), - cb?: (err: any, data?: GetAdministratorAccountCommandOutput) => void - ): Promise | void { - const command = new GetAdministratorAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the settings and status of an allow list.

- */ - public getAllowList( - args: GetAllowListCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getAllowList(args: GetAllowListCommandInput, cb: (err: any, data?: GetAllowListCommandOutput) => void): void; - public getAllowList( + + /** + * @see {@link GetAllowListCommand} + */ + getAllowList(args: GetAllowListCommandInput, options?: __HttpHandlerOptions): Promise; + getAllowList(args: GetAllowListCommandInput, cb: (err: any, data?: GetAllowListCommandOutput) => void): void; + getAllowList( args: GetAllowListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAllowListCommandOutput) => void ): void; - public getAllowList( - args: GetAllowListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAllowListCommandOutput) => void), - cb?: (err: any, data?: GetAllowListCommandOutput) => void - ): Promise | void { - const command = new GetAllowListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the configuration settings and status of automated sensitive data discovery for an account.

- */ - public getAutomatedDiscoveryConfiguration( + + /** + * @see {@link GetAutomatedDiscoveryConfigurationCommand} + */ + getAutomatedDiscoveryConfiguration( args: GetAutomatedDiscoveryConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAutomatedDiscoveryConfiguration( + getAutomatedDiscoveryConfiguration( args: GetAutomatedDiscoveryConfigurationCommandInput, cb: (err: any, data?: GetAutomatedDiscoveryConfigurationCommandOutput) => void ): void; - public getAutomatedDiscoveryConfiguration( + getAutomatedDiscoveryConfiguration( args: GetAutomatedDiscoveryConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAutomatedDiscoveryConfigurationCommandOutput) => void ): void; - public getAutomatedDiscoveryConfiguration( - args: GetAutomatedDiscoveryConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAutomatedDiscoveryConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetAutomatedDiscoveryConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetAutomatedDiscoveryConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves (queries) aggregated statistical data about all the S3 buckets that Amazon Macie monitors and analyzes for an account.

- */ - public getBucketStatistics( + + /** + * @see {@link GetBucketStatisticsCommand} + */ + getBucketStatistics( args: GetBucketStatisticsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketStatistics( + getBucketStatistics( args: GetBucketStatisticsCommandInput, cb: (err: any, data?: GetBucketStatisticsCommandOutput) => void ): void; - public getBucketStatistics( + getBucketStatistics( args: GetBucketStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketStatisticsCommandOutput) => void ): void; - public getBucketStatistics( - args: GetBucketStatisticsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketStatisticsCommandOutput) => void), - cb?: (err: any, data?: GetBucketStatisticsCommandOutput) => void - ): Promise | void { - const command = new GetBucketStatisticsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the configuration settings for storing data classification results.

- */ - public getClassificationExportConfiguration( + + /** + * @see {@link GetClassificationExportConfigurationCommand} + */ + getClassificationExportConfiguration( args: GetClassificationExportConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getClassificationExportConfiguration( + getClassificationExportConfiguration( args: GetClassificationExportConfigurationCommandInput, cb: (err: any, data?: GetClassificationExportConfigurationCommandOutput) => void ): void; - public getClassificationExportConfiguration( + getClassificationExportConfiguration( args: GetClassificationExportConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetClassificationExportConfigurationCommandOutput) => void ): void; - public getClassificationExportConfiguration( - args: GetClassificationExportConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetClassificationExportConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetClassificationExportConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetClassificationExportConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the classification scope settings for an account.

- */ - public getClassificationScope( + + /** + * @see {@link GetClassificationScopeCommand} + */ + getClassificationScope( args: GetClassificationScopeCommandInput, options?: __HttpHandlerOptions ): Promise; - public getClassificationScope( + getClassificationScope( args: GetClassificationScopeCommandInput, cb: (err: any, data?: GetClassificationScopeCommandOutput) => void ): void; - public getClassificationScope( + getClassificationScope( args: GetClassificationScopeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetClassificationScopeCommandOutput) => void ): void; - public getClassificationScope( - args: GetClassificationScopeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetClassificationScopeCommandOutput) => void), - cb?: (err: any, data?: GetClassificationScopeCommandOutput) => void - ): Promise | void { - const command = new GetClassificationScopeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the criteria and other settings for a custom data identifier.

- */ - public getCustomDataIdentifier( + + /** + * @see {@link GetCustomDataIdentifierCommand} + */ + getCustomDataIdentifier( args: GetCustomDataIdentifierCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCustomDataIdentifier( + getCustomDataIdentifier( args: GetCustomDataIdentifierCommandInput, cb: (err: any, data?: GetCustomDataIdentifierCommandOutput) => void ): void; - public getCustomDataIdentifier( + getCustomDataIdentifier( args: GetCustomDataIdentifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCustomDataIdentifierCommandOutput) => void ): void; - public getCustomDataIdentifier( - args: GetCustomDataIdentifierCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCustomDataIdentifierCommandOutput) => void), - cb?: (err: any, data?: GetCustomDataIdentifierCommandOutput) => void - ): Promise | void { - const command = new GetCustomDataIdentifierCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the details of one or more findings.

- */ - public getFindings(args: GetFindingsCommandInput, options?: __HttpHandlerOptions): Promise; - public getFindings(args: GetFindingsCommandInput, cb: (err: any, data?: GetFindingsCommandOutput) => void): void; - public getFindings( + + /** + * @see {@link GetFindingsCommand} + */ + getFindings(args: GetFindingsCommandInput, options?: __HttpHandlerOptions): Promise; + getFindings(args: GetFindingsCommandInput, cb: (err: any, data?: GetFindingsCommandOutput) => void): void; + getFindings( args: GetFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFindingsCommandOutput) => void ): void; - public getFindings( - args: GetFindingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFindingsCommandOutput) => void), - cb?: (err: any, data?: GetFindingsCommandOutput) => void - ): Promise | void { - const command = new GetFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the criteria and other settings for a findings filter.

- */ - public getFindingsFilter( + + /** + * @see {@link GetFindingsFilterCommand} + */ + getFindingsFilter( args: GetFindingsFilterCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFindingsFilter( + getFindingsFilter( args: GetFindingsFilterCommandInput, cb: (err: any, data?: GetFindingsFilterCommandOutput) => void ): void; - public getFindingsFilter( + getFindingsFilter( args: GetFindingsFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFindingsFilterCommandOutput) => void ): void; - public getFindingsFilter( - args: GetFindingsFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFindingsFilterCommandOutput) => void), - cb?: (err: any, data?: GetFindingsFilterCommandOutput) => void - ): Promise | void { - const command = new GetFindingsFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the configuration settings for publishing findings to Security Hub.

- */ - public getFindingsPublicationConfiguration( + + /** + * @see {@link GetFindingsPublicationConfigurationCommand} + */ + getFindingsPublicationConfiguration( args: GetFindingsPublicationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFindingsPublicationConfiguration( + getFindingsPublicationConfiguration( args: GetFindingsPublicationConfigurationCommandInput, cb: (err: any, data?: GetFindingsPublicationConfigurationCommandOutput) => void ): void; - public getFindingsPublicationConfiguration( + getFindingsPublicationConfiguration( args: GetFindingsPublicationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFindingsPublicationConfigurationCommandOutput) => void ): void; - public getFindingsPublicationConfiguration( - args: GetFindingsPublicationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFindingsPublicationConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetFindingsPublicationConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetFindingsPublicationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves (queries) aggregated statistical data about findings.

- */ - public getFindingStatistics( + + /** + * @see {@link GetFindingStatisticsCommand} + */ + getFindingStatistics( args: GetFindingStatisticsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFindingStatistics( + getFindingStatistics( args: GetFindingStatisticsCommandInput, cb: (err: any, data?: GetFindingStatisticsCommandOutput) => void ): void; - public getFindingStatistics( + getFindingStatistics( args: GetFindingStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFindingStatisticsCommandOutput) => void ): void; - public getFindingStatistics( - args: GetFindingStatisticsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFindingStatisticsCommandOutput) => void), - cb?: (err: any, data?: GetFindingStatisticsCommandOutput) => void - ): Promise | void { - const command = new GetFindingStatisticsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the count of Amazon Macie membership invitations that were received by an account.

- */ - public getInvitationsCount( + + /** + * @see {@link GetInvitationsCountCommand} + */ + getInvitationsCount( args: GetInvitationsCountCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInvitationsCount( + getInvitationsCount( args: GetInvitationsCountCommandInput, cb: (err: any, data?: GetInvitationsCountCommandOutput) => void ): void; - public getInvitationsCount( + getInvitationsCount( args: GetInvitationsCountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInvitationsCountCommandOutput) => void ): void; - public getInvitationsCount( - args: GetInvitationsCountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInvitationsCountCommandOutput) => void), - cb?: (err: any, data?: GetInvitationsCountCommandOutput) => void - ): Promise | void { - const command = new GetInvitationsCountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the status and configuration settings for an Amazon Macie account.

- */ - public getMacieSession( + + /** + * @see {@link GetMacieSessionCommand} + */ + getMacieSession( args: GetMacieSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMacieSession( - args: GetMacieSessionCommandInput, - cb: (err: any, data?: GetMacieSessionCommandOutput) => void - ): void; - public getMacieSession( + getMacieSession(args: GetMacieSessionCommandInput, cb: (err: any, data?: GetMacieSessionCommandOutput) => void): void; + getMacieSession( args: GetMacieSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMacieSessionCommandOutput) => void ): void; - public getMacieSession( - args: GetMacieSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMacieSessionCommandOutput) => void), - cb?: (err: any, data?: GetMacieSessionCommandOutput) => void - ): Promise | void { - const command = new GetMacieSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

(Deprecated) Retrieves information about the Amazon Macie administrator account for an account. This operation has been replaced by the GetAdministratorAccount operation.

- */ - public getMasterAccount( + + /** + * @see {@link GetMasterAccountCommand} + */ + getMasterAccount( args: GetMasterAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMasterAccount( + getMasterAccount( args: GetMasterAccountCommandInput, cb: (err: any, data?: GetMasterAccountCommandOutput) => void ): void; - public getMasterAccount( + getMasterAccount( args: GetMasterAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMasterAccountCommandOutput) => void ): void; - public getMasterAccount( - args: GetMasterAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMasterAccountCommandOutput) => void), - cb?: (err: any, data?: GetMasterAccountCommandOutput) => void - ): Promise | void { - const command = new GetMasterAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about an account that's associated with an Amazon Macie administrator account.

- */ - public getMember(args: GetMemberCommandInput, options?: __HttpHandlerOptions): Promise; - public getMember(args: GetMemberCommandInput, cb: (err: any, data?: GetMemberCommandOutput) => void): void; - public getMember( + + /** + * @see {@link GetMemberCommand} + */ + getMember(args: GetMemberCommandInput, options?: __HttpHandlerOptions): Promise; + getMember(args: GetMemberCommandInput, cb: (err: any, data?: GetMemberCommandOutput) => void): void; + getMember( args: GetMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMemberCommandOutput) => void ): void; - public getMember( - args: GetMemberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMemberCommandOutput) => void), - cb?: (err: any, data?: GetMemberCommandOutput) => void - ): Promise | void { - const command = new GetMemberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves (queries) sensitive data discovery statistics and the sensitivity score for an S3 bucket.

- */ - public getResourceProfile( + + /** + * @see {@link GetResourceProfileCommand} + */ + getResourceProfile( args: GetResourceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourceProfile( + getResourceProfile( args: GetResourceProfileCommandInput, cb: (err: any, data?: GetResourceProfileCommandOutput) => void ): void; - public getResourceProfile( + getResourceProfile( args: GetResourceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceProfileCommandOutput) => void ): void; - public getResourceProfile( - args: GetResourceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourceProfileCommandOutput) => void), - cb?: (err: any, data?: GetResourceProfileCommandOutput) => void - ): Promise | void { - const command = new GetResourceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the status and configuration settings for retrieving occurrences of sensitive data reported by findings.

- */ - public getRevealConfiguration( + + /** + * @see {@link GetRevealConfigurationCommand} + */ + getRevealConfiguration( args: GetRevealConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRevealConfiguration( + getRevealConfiguration( args: GetRevealConfigurationCommandInput, cb: (err: any, data?: GetRevealConfigurationCommandOutput) => void ): void; - public getRevealConfiguration( + getRevealConfiguration( args: GetRevealConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRevealConfigurationCommandOutput) => void ): void; - public getRevealConfiguration( - args: GetRevealConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRevealConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetRevealConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetRevealConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves occurrences of sensitive data reported by a finding.

- */ - public getSensitiveDataOccurrences( + + /** + * @see {@link GetSensitiveDataOccurrencesCommand} + */ + getSensitiveDataOccurrences( args: GetSensitiveDataOccurrencesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSensitiveDataOccurrences( + getSensitiveDataOccurrences( args: GetSensitiveDataOccurrencesCommandInput, cb: (err: any, data?: GetSensitiveDataOccurrencesCommandOutput) => void ): void; - public getSensitiveDataOccurrences( + getSensitiveDataOccurrences( args: GetSensitiveDataOccurrencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSensitiveDataOccurrencesCommandOutput) => void ): void; - public getSensitiveDataOccurrences( - args: GetSensitiveDataOccurrencesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSensitiveDataOccurrencesCommandOutput) => void), - cb?: (err: any, data?: GetSensitiveDataOccurrencesCommandOutput) => void - ): Promise | void { - const command = new GetSensitiveDataOccurrencesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Checks whether occurrences of sensitive data can be retrieved for a finding.

- */ - public getSensitiveDataOccurrencesAvailability( + + /** + * @see {@link GetSensitiveDataOccurrencesAvailabilityCommand} + */ + getSensitiveDataOccurrencesAvailability( args: GetSensitiveDataOccurrencesAvailabilityCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSensitiveDataOccurrencesAvailability( + getSensitiveDataOccurrencesAvailability( args: GetSensitiveDataOccurrencesAvailabilityCommandInput, cb: (err: any, data?: GetSensitiveDataOccurrencesAvailabilityCommandOutput) => void ): void; - public getSensitiveDataOccurrencesAvailability( + getSensitiveDataOccurrencesAvailability( args: GetSensitiveDataOccurrencesAvailabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSensitiveDataOccurrencesAvailabilityCommandOutput) => void ): void; - public getSensitiveDataOccurrencesAvailability( - args: GetSensitiveDataOccurrencesAvailabilityCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetSensitiveDataOccurrencesAvailabilityCommandOutput) => void), - cb?: (err: any, data?: GetSensitiveDataOccurrencesAvailabilityCommandOutput) => void - ): Promise | void { - const command = new GetSensitiveDataOccurrencesAvailabilityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the settings for the sensitivity inspection template for an account.

- */ - public getSensitivityInspectionTemplate( + + /** + * @see {@link GetSensitivityInspectionTemplateCommand} + */ + getSensitivityInspectionTemplate( args: GetSensitivityInspectionTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSensitivityInspectionTemplate( + getSensitivityInspectionTemplate( args: GetSensitivityInspectionTemplateCommandInput, cb: (err: any, data?: GetSensitivityInspectionTemplateCommandOutput) => void ): void; - public getSensitivityInspectionTemplate( + getSensitivityInspectionTemplate( args: GetSensitivityInspectionTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSensitivityInspectionTemplateCommandOutput) => void ): void; - public getSensitivityInspectionTemplate( - args: GetSensitivityInspectionTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSensitivityInspectionTemplateCommandOutput) => void), - cb?: (err: any, data?: GetSensitivityInspectionTemplateCommandOutput) => void - ): Promise | void { - const command = new GetSensitivityInspectionTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves (queries) quotas and aggregated usage data for one or more accounts.

- */ - public getUsageStatistics( + + /** + * @see {@link GetUsageStatisticsCommand} + */ + getUsageStatistics( args: GetUsageStatisticsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUsageStatistics( + getUsageStatistics( args: GetUsageStatisticsCommandInput, cb: (err: any, data?: GetUsageStatisticsCommandOutput) => void ): void; - public getUsageStatistics( + getUsageStatistics( args: GetUsageStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUsageStatisticsCommandOutput) => void ): void; - public getUsageStatistics( - args: GetUsageStatisticsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUsageStatisticsCommandOutput) => void), - cb?: (err: any, data?: GetUsageStatisticsCommandOutput) => void - ): Promise | void { - const command = new GetUsageStatisticsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves (queries) aggregated usage data for an account.

- */ - public getUsageTotals( + + /** + * @see {@link GetUsageTotalsCommand} + */ + getUsageTotals( args: GetUsageTotalsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUsageTotals( - args: GetUsageTotalsCommandInput, - cb: (err: any, data?: GetUsageTotalsCommandOutput) => void - ): void; - public getUsageTotals( + getUsageTotals(args: GetUsageTotalsCommandInput, cb: (err: any, data?: GetUsageTotalsCommandOutput) => void): void; + getUsageTotals( args: GetUsageTotalsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUsageTotalsCommandOutput) => void ): void; - public getUsageTotals( - args: GetUsageTotalsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUsageTotalsCommandOutput) => void), - cb?: (err: any, data?: GetUsageTotalsCommandOutput) => void - ): Promise | void { - const command = new GetUsageTotalsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a subset of information about all the allow lists for an account.

- */ - public listAllowLists( + + /** + * @see {@link ListAllowListsCommand} + */ + listAllowLists( args: ListAllowListsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAllowLists( - args: ListAllowListsCommandInput, - cb: (err: any, data?: ListAllowListsCommandOutput) => void - ): void; - public listAllowLists( + listAllowLists(args: ListAllowListsCommandInput, cb: (err: any, data?: ListAllowListsCommandOutput) => void): void; + listAllowLists( args: ListAllowListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAllowListsCommandOutput) => void ): void; - public listAllowLists( - args: ListAllowListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAllowListsCommandOutput) => void), - cb?: (err: any, data?: ListAllowListsCommandOutput) => void - ): Promise | void { - const command = new ListAllowListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a subset of information about one or more classification jobs.

- */ - public listClassificationJobs( + + /** + * @see {@link ListClassificationJobsCommand} + */ + listClassificationJobs( args: ListClassificationJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listClassificationJobs( + listClassificationJobs( args: ListClassificationJobsCommandInput, cb: (err: any, data?: ListClassificationJobsCommandOutput) => void ): void; - public listClassificationJobs( + listClassificationJobs( args: ListClassificationJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListClassificationJobsCommandOutput) => void ): void; - public listClassificationJobs( - args: ListClassificationJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListClassificationJobsCommandOutput) => void), - cb?: (err: any, data?: ListClassificationJobsCommandOutput) => void - ): Promise | void { - const command = new ListClassificationJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a subset of information about the classification scope for an account.

- */ - public listClassificationScopes( + + /** + * @see {@link ListClassificationScopesCommand} + */ + listClassificationScopes( args: ListClassificationScopesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listClassificationScopes( + listClassificationScopes( args: ListClassificationScopesCommandInput, cb: (err: any, data?: ListClassificationScopesCommandOutput) => void ): void; - public listClassificationScopes( + listClassificationScopes( args: ListClassificationScopesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListClassificationScopesCommandOutput) => void ): void; - public listClassificationScopes( - args: ListClassificationScopesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListClassificationScopesCommandOutput) => void), - cb?: (err: any, data?: ListClassificationScopesCommandOutput) => void - ): Promise | void { - const command = new ListClassificationScopesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a subset of information about all the custom data identifiers for an account.

- */ - public listCustomDataIdentifiers( + + /** + * @see {@link ListCustomDataIdentifiersCommand} + */ + listCustomDataIdentifiers( args: ListCustomDataIdentifiersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCustomDataIdentifiers( + listCustomDataIdentifiers( args: ListCustomDataIdentifiersCommandInput, cb: (err: any, data?: ListCustomDataIdentifiersCommandOutput) => void ): void; - public listCustomDataIdentifiers( + listCustomDataIdentifiers( args: ListCustomDataIdentifiersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCustomDataIdentifiersCommandOutput) => void ): void; - public listCustomDataIdentifiers( - args: ListCustomDataIdentifiersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCustomDataIdentifiersCommandOutput) => void), - cb?: (err: any, data?: ListCustomDataIdentifiersCommandOutput) => void - ): Promise | void { - const command = new ListCustomDataIdentifiersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a subset of information about one or more findings.

- */ - public listFindings( - args: ListFindingsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listFindings(args: ListFindingsCommandInput, cb: (err: any, data?: ListFindingsCommandOutput) => void): void; - public listFindings( + + /** + * @see {@link ListFindingsCommand} + */ + listFindings(args: ListFindingsCommandInput, options?: __HttpHandlerOptions): Promise; + listFindings(args: ListFindingsCommandInput, cb: (err: any, data?: ListFindingsCommandOutput) => void): void; + listFindings( args: ListFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFindingsCommandOutput) => void ): void; - public listFindings( - args: ListFindingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFindingsCommandOutput) => void), - cb?: (err: any, data?: ListFindingsCommandOutput) => void - ): Promise | void { - const command = new ListFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a subset of information about all the findings filters for an account.

- */ - public listFindingsFilters( + + /** + * @see {@link ListFindingsFiltersCommand} + */ + listFindingsFilters( args: ListFindingsFiltersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFindingsFilters( + listFindingsFilters( args: ListFindingsFiltersCommandInput, cb: (err: any, data?: ListFindingsFiltersCommandOutput) => void ): void; - public listFindingsFilters( + listFindingsFilters( args: ListFindingsFiltersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFindingsFiltersCommandOutput) => void ): void; - public listFindingsFilters( - args: ListFindingsFiltersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFindingsFiltersCommandOutput) => void), - cb?: (err: any, data?: ListFindingsFiltersCommandOutput) => void - ): Promise | void { - const command = new ListFindingsFiltersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about the Amazon Macie membership invitations that were received by an account.

- */ - public listInvitations( + + /** + * @see {@link ListInvitationsCommand} + */ + listInvitations( args: ListInvitationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInvitations( - args: ListInvitationsCommandInput, - cb: (err: any, data?: ListInvitationsCommandOutput) => void - ): void; - public listInvitations( + listInvitations(args: ListInvitationsCommandInput, cb: (err: any, data?: ListInvitationsCommandOutput) => void): void; + listInvitations( args: ListInvitationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInvitationsCommandOutput) => void ): void; - public listInvitations( - args: ListInvitationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInvitationsCommandOutput) => void), - cb?: (err: any, data?: ListInvitationsCommandOutput) => void - ): Promise | void { - const command = new ListInvitationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about all the managed data identifiers that Amazon Macie currently provides.

- */ - public listManagedDataIdentifiers( + + /** + * @see {@link ListManagedDataIdentifiersCommand} + */ + listManagedDataIdentifiers( args: ListManagedDataIdentifiersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listManagedDataIdentifiers( + listManagedDataIdentifiers( args: ListManagedDataIdentifiersCommandInput, cb: (err: any, data?: ListManagedDataIdentifiersCommandOutput) => void ): void; - public listManagedDataIdentifiers( + listManagedDataIdentifiers( args: ListManagedDataIdentifiersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListManagedDataIdentifiersCommandOutput) => void ): void; - public listManagedDataIdentifiers( - args: ListManagedDataIdentifiersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListManagedDataIdentifiersCommandOutput) => void), - cb?: (err: any, data?: ListManagedDataIdentifiersCommandOutput) => void - ): Promise | void { - const command = new ListManagedDataIdentifiersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about the accounts that are associated with an Amazon Macie administrator account.

- */ - public listMembers(args: ListMembersCommandInput, options?: __HttpHandlerOptions): Promise; - public listMembers(args: ListMembersCommandInput, cb: (err: any, data?: ListMembersCommandOutput) => void): void; - public listMembers( + + /** + * @see {@link ListMembersCommand} + */ + listMembers(args: ListMembersCommandInput, options?: __HttpHandlerOptions): Promise; + listMembers(args: ListMembersCommandInput, cb: (err: any, data?: ListMembersCommandOutput) => void): void; + listMembers( args: ListMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMembersCommandOutput) => void ): void; - public listMembers( - args: ListMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMembersCommandOutput) => void), - cb?: (err: any, data?: ListMembersCommandOutput) => void - ): Promise | void { - const command = new ListMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about the delegated Amazon Macie administrator account for an organization in Organizations.

- */ - public listOrganizationAdminAccounts( + + /** + * @see {@link ListOrganizationAdminAccountsCommand} + */ + listOrganizationAdminAccounts( args: ListOrganizationAdminAccountsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOrganizationAdminAccounts( + listOrganizationAdminAccounts( args: ListOrganizationAdminAccountsCommandInput, cb: (err: any, data?: ListOrganizationAdminAccountsCommandOutput) => void ): void; - public listOrganizationAdminAccounts( + listOrganizationAdminAccounts( args: ListOrganizationAdminAccountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOrganizationAdminAccountsCommandOutput) => void ): void; - public listOrganizationAdminAccounts( - args: ListOrganizationAdminAccountsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOrganizationAdminAccountsCommandOutput) => void), - cb?: (err: any, data?: ListOrganizationAdminAccountsCommandOutput) => void - ): Promise | void { - const command = new ListOrganizationAdminAccountsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about objects that were selected from an S3 bucket for automated sensitive data discovery.

- */ - public listResourceProfileArtifacts( + + /** + * @see {@link ListResourceProfileArtifactsCommand} + */ + listResourceProfileArtifacts( args: ListResourceProfileArtifactsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourceProfileArtifacts( + listResourceProfileArtifacts( args: ListResourceProfileArtifactsCommandInput, cb: (err: any, data?: ListResourceProfileArtifactsCommandOutput) => void ): void; - public listResourceProfileArtifacts( + listResourceProfileArtifacts( args: ListResourceProfileArtifactsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceProfileArtifactsCommandOutput) => void ): void; - public listResourceProfileArtifacts( - args: ListResourceProfileArtifactsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourceProfileArtifactsCommandOutput) => void), - cb?: (err: any, data?: ListResourceProfileArtifactsCommandOutput) => void - ): Promise | void { - const command = new ListResourceProfileArtifactsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about the types and amount of sensitive data that Amazon Macie found in an S3 bucket.

- */ - public listResourceProfileDetections( + + /** + * @see {@link ListResourceProfileDetectionsCommand} + */ + listResourceProfileDetections( args: ListResourceProfileDetectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourceProfileDetections( + listResourceProfileDetections( args: ListResourceProfileDetectionsCommandInput, cb: (err: any, data?: ListResourceProfileDetectionsCommandOutput) => void ): void; - public listResourceProfileDetections( + listResourceProfileDetections( args: ListResourceProfileDetectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceProfileDetectionsCommandOutput) => void ): void; - public listResourceProfileDetections( - args: ListResourceProfileDetectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourceProfileDetectionsCommandOutput) => void), - cb?: (err: any, data?: ListResourceProfileDetectionsCommandOutput) => void - ): Promise | void { - const command = new ListResourceProfileDetectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a subset of information about the sensitivity inspection template for an account.

- */ - public listSensitivityInspectionTemplates( + + /** + * @see {@link ListSensitivityInspectionTemplatesCommand} + */ + listSensitivityInspectionTemplates( args: ListSensitivityInspectionTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSensitivityInspectionTemplates( + listSensitivityInspectionTemplates( args: ListSensitivityInspectionTemplatesCommandInput, cb: (err: any, data?: ListSensitivityInspectionTemplatesCommandOutput) => void ): void; - public listSensitivityInspectionTemplates( + listSensitivityInspectionTemplates( args: ListSensitivityInspectionTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSensitivityInspectionTemplatesCommandOutput) => void ): void; - public listSensitivityInspectionTemplates( - args: ListSensitivityInspectionTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSensitivityInspectionTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListSensitivityInspectionTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListSensitivityInspectionTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the tags (keys and values) that are associated with an Amazon Macie resource.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or updates the configuration settings for storing data classification results.

- */ - public putClassificationExportConfiguration( + + /** + * @see {@link PutClassificationExportConfigurationCommand} + */ + putClassificationExportConfiguration( args: PutClassificationExportConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putClassificationExportConfiguration( + putClassificationExportConfiguration( args: PutClassificationExportConfigurationCommandInput, cb: (err: any, data?: PutClassificationExportConfigurationCommandOutput) => void ): void; - public putClassificationExportConfiguration( + putClassificationExportConfiguration( args: PutClassificationExportConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutClassificationExportConfigurationCommandOutput) => void ): void; - public putClassificationExportConfiguration( - args: PutClassificationExportConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutClassificationExportConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutClassificationExportConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutClassificationExportConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the configuration settings for publishing findings to Security Hub.

- */ - public putFindingsPublicationConfiguration( + + /** + * @see {@link PutFindingsPublicationConfigurationCommand} + */ + putFindingsPublicationConfiguration( args: PutFindingsPublicationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putFindingsPublicationConfiguration( + putFindingsPublicationConfiguration( args: PutFindingsPublicationConfigurationCommandInput, cb: (err: any, data?: PutFindingsPublicationConfigurationCommandOutput) => void ): void; - public putFindingsPublicationConfiguration( + putFindingsPublicationConfiguration( args: PutFindingsPublicationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutFindingsPublicationConfigurationCommandOutput) => void ): void; - public putFindingsPublicationConfiguration( - args: PutFindingsPublicationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutFindingsPublicationConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutFindingsPublicationConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutFindingsPublicationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves (queries) statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes.

- */ - public searchResources( + + /** + * @see {@link SearchResourcesCommand} + */ + searchResources( args: SearchResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchResources( - args: SearchResourcesCommandInput, - cb: (err: any, data?: SearchResourcesCommandOutput) => void - ): void; - public searchResources( + searchResources(args: SearchResourcesCommandInput, cb: (err: any, data?: SearchResourcesCommandOutput) => void): void; + searchResources( args: SearchResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchResourcesCommandOutput) => void ): void; - public searchResources( - args: SearchResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchResourcesCommandOutput) => void), - cb?: (err: any, data?: SearchResourcesCommandOutput) => void - ): Promise | void { - const command = new SearchResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds or updates one or more tags (keys and values) that are associated with an Amazon Macie resource.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Tests a custom data identifier.

- */ - public testCustomDataIdentifier( + + /** + * @see {@link TestCustomDataIdentifierCommand} + */ + testCustomDataIdentifier( args: TestCustomDataIdentifierCommandInput, options?: __HttpHandlerOptions ): Promise; - public testCustomDataIdentifier( + testCustomDataIdentifier( args: TestCustomDataIdentifierCommandInput, cb: (err: any, data?: TestCustomDataIdentifierCommandOutput) => void ): void; - public testCustomDataIdentifier( + testCustomDataIdentifier( args: TestCustomDataIdentifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestCustomDataIdentifierCommandOutput) => void ): void; - public testCustomDataIdentifier( - args: TestCustomDataIdentifierCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestCustomDataIdentifierCommandOutput) => void), - cb?: (err: any, data?: TestCustomDataIdentifierCommandOutput) => void - ): Promise | void { - const command = new TestCustomDataIdentifierCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes one or more tags (keys and values) from an Amazon Macie resource.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the settings for an allow list.

- */ - public updateAllowList( + + /** + * @see {@link UpdateAllowListCommand} + */ + updateAllowList( args: UpdateAllowListCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAllowList( - args: UpdateAllowListCommandInput, - cb: (err: any, data?: UpdateAllowListCommandOutput) => void - ): void; - public updateAllowList( + updateAllowList(args: UpdateAllowListCommandInput, cb: (err: any, data?: UpdateAllowListCommandOutput) => void): void; + updateAllowList( args: UpdateAllowListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAllowListCommandOutput) => void ): void; - public updateAllowList( - args: UpdateAllowListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAllowListCommandOutput) => void), - cb?: (err: any, data?: UpdateAllowListCommandOutput) => void - ): Promise | void { - const command = new UpdateAllowListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables or disables automated sensitive data discovery for an account.

- */ - public updateAutomatedDiscoveryConfiguration( + + /** + * @see {@link UpdateAutomatedDiscoveryConfigurationCommand} + */ + updateAutomatedDiscoveryConfiguration( args: UpdateAutomatedDiscoveryConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAutomatedDiscoveryConfiguration( + updateAutomatedDiscoveryConfiguration( args: UpdateAutomatedDiscoveryConfigurationCommandInput, cb: (err: any, data?: UpdateAutomatedDiscoveryConfigurationCommandOutput) => void ): void; - public updateAutomatedDiscoveryConfiguration( + updateAutomatedDiscoveryConfiguration( args: UpdateAutomatedDiscoveryConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAutomatedDiscoveryConfigurationCommandOutput) => void ): void; - public updateAutomatedDiscoveryConfiguration( - args: UpdateAutomatedDiscoveryConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateAutomatedDiscoveryConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateAutomatedDiscoveryConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateAutomatedDiscoveryConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Changes the status of a classification job.

- */ - public updateClassificationJob( + + /** + * @see {@link UpdateClassificationJobCommand} + */ + updateClassificationJob( args: UpdateClassificationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateClassificationJob( + updateClassificationJob( args: UpdateClassificationJobCommandInput, cb: (err: any, data?: UpdateClassificationJobCommandOutput) => void ): void; - public updateClassificationJob( + updateClassificationJob( args: UpdateClassificationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateClassificationJobCommandOutput) => void ): void; - public updateClassificationJob( - args: UpdateClassificationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateClassificationJobCommandOutput) => void), - cb?: (err: any, data?: UpdateClassificationJobCommandOutput) => void - ): Promise | void { - const command = new UpdateClassificationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the classification scope settings for an account.

- */ - public updateClassificationScope( + + /** + * @see {@link UpdateClassificationScopeCommand} + */ + updateClassificationScope( args: UpdateClassificationScopeCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateClassificationScope( + updateClassificationScope( args: UpdateClassificationScopeCommandInput, cb: (err: any, data?: UpdateClassificationScopeCommandOutput) => void ): void; - public updateClassificationScope( + updateClassificationScope( args: UpdateClassificationScopeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateClassificationScopeCommandOutput) => void ): void; - public updateClassificationScope( - args: UpdateClassificationScopeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateClassificationScopeCommandOutput) => void), - cb?: (err: any, data?: UpdateClassificationScopeCommandOutput) => void - ): Promise | void { - const command = new UpdateClassificationScopeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the criteria and other settings for a findings filter.

- */ - public updateFindingsFilter( + + /** + * @see {@link UpdateFindingsFilterCommand} + */ + updateFindingsFilter( args: UpdateFindingsFilterCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFindingsFilter( + updateFindingsFilter( args: UpdateFindingsFilterCommandInput, cb: (err: any, data?: UpdateFindingsFilterCommandOutput) => void ): void; - public updateFindingsFilter( + updateFindingsFilter( args: UpdateFindingsFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFindingsFilterCommandOutput) => void ): void; - public updateFindingsFilter( - args: UpdateFindingsFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFindingsFilterCommandOutput) => void), - cb?: (err: any, data?: UpdateFindingsFilterCommandOutput) => void - ): Promise | void { - const command = new UpdateFindingsFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Suspends or re-enables Amazon Macie, or updates the configuration settings for a Macie account.

- */ - public updateMacieSession( + + /** + * @see {@link UpdateMacieSessionCommand} + */ + updateMacieSession( args: UpdateMacieSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMacieSession( + updateMacieSession( args: UpdateMacieSessionCommandInput, cb: (err: any, data?: UpdateMacieSessionCommandOutput) => void ): void; - public updateMacieSession( + updateMacieSession( args: UpdateMacieSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMacieSessionCommandOutput) => void ): void; - public updateMacieSession( - args: UpdateMacieSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMacieSessionCommandOutput) => void), - cb?: (err: any, data?: UpdateMacieSessionCommandOutput) => void - ): Promise | void { - const command = new UpdateMacieSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables an Amazon Macie administrator to suspend or re-enable Macie for a member account.

- */ - public updateMemberSession( + + /** + * @see {@link UpdateMemberSessionCommand} + */ + updateMemberSession( args: UpdateMemberSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMemberSession( + updateMemberSession( args: UpdateMemberSessionCommandInput, cb: (err: any, data?: UpdateMemberSessionCommandOutput) => void ): void; - public updateMemberSession( + updateMemberSession( args: UpdateMemberSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMemberSessionCommandOutput) => void ): void; - public updateMemberSession( - args: UpdateMemberSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMemberSessionCommandOutput) => void), - cb?: (err: any, data?: UpdateMemberSessionCommandOutput) => void - ): Promise | void { - const command = new UpdateMemberSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the Amazon Macie configuration settings for an organization in Organizations.

- */ - public updateOrganizationConfiguration( + + /** + * @see {@link UpdateOrganizationConfigurationCommand} + */ + updateOrganizationConfiguration( args: UpdateOrganizationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateOrganizationConfiguration( + updateOrganizationConfiguration( args: UpdateOrganizationConfigurationCommandInput, cb: (err: any, data?: UpdateOrganizationConfigurationCommandOutput) => void ): void; - public updateOrganizationConfiguration( + updateOrganizationConfiguration( args: UpdateOrganizationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateOrganizationConfigurationCommandOutput) => void ): void; - public updateOrganizationConfiguration( - args: UpdateOrganizationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateOrganizationConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateOrganizationConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateOrganizationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the sensitivity score for an S3 bucket.

- */ - public updateResourceProfile( + + /** + * @see {@link UpdateResourceProfileCommand} + */ + updateResourceProfile( args: UpdateResourceProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateResourceProfile( + updateResourceProfile( args: UpdateResourceProfileCommandInput, cb: (err: any, data?: UpdateResourceProfileCommandOutput) => void ): void; - public updateResourceProfile( + updateResourceProfile( args: UpdateResourceProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResourceProfileCommandOutput) => void ): void; - public updateResourceProfile( - args: UpdateResourceProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResourceProfileCommandOutput) => void), - cb?: (err: any, data?: UpdateResourceProfileCommandOutput) => void - ): Promise | void { - const command = new UpdateResourceProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the sensitivity scoring settings for an S3 bucket.

- */ - public updateResourceProfileDetections( + + /** + * @see {@link UpdateResourceProfileDetectionsCommand} + */ + updateResourceProfileDetections( args: UpdateResourceProfileDetectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateResourceProfileDetections( + updateResourceProfileDetections( args: UpdateResourceProfileDetectionsCommandInput, cb: (err: any, data?: UpdateResourceProfileDetectionsCommandOutput) => void ): void; - public updateResourceProfileDetections( + updateResourceProfileDetections( args: UpdateResourceProfileDetectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResourceProfileDetectionsCommandOutput) => void ): void; - public updateResourceProfileDetections( - args: UpdateResourceProfileDetectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResourceProfileDetectionsCommandOutput) => void), - cb?: (err: any, data?: UpdateResourceProfileDetectionsCommandOutput) => void - ): Promise | void { - const command = new UpdateResourceProfileDetectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the status and configuration settings for retrieving occurrences of sensitive data reported by findings.

- */ - public updateRevealConfiguration( + + /** + * @see {@link UpdateRevealConfigurationCommand} + */ + updateRevealConfiguration( args: UpdateRevealConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRevealConfiguration( + updateRevealConfiguration( args: UpdateRevealConfigurationCommandInput, cb: (err: any, data?: UpdateRevealConfigurationCommandOutput) => void ): void; - public updateRevealConfiguration( + updateRevealConfiguration( args: UpdateRevealConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRevealConfigurationCommandOutput) => void ): void; - public updateRevealConfiguration( - args: UpdateRevealConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRevealConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateRevealConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateRevealConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the settings for the sensitivity inspection template for an account.

- */ - public updateSensitivityInspectionTemplate( + + /** + * @see {@link UpdateSensitivityInspectionTemplateCommand} + */ + updateSensitivityInspectionTemplate( args: UpdateSensitivityInspectionTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSensitivityInspectionTemplate( + updateSensitivityInspectionTemplate( args: UpdateSensitivityInspectionTemplateCommandInput, cb: (err: any, data?: UpdateSensitivityInspectionTemplateCommandOutput) => void ): void; - public updateSensitivityInspectionTemplate( + updateSensitivityInspectionTemplate( args: UpdateSensitivityInspectionTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSensitivityInspectionTemplateCommandOutput) => void ): void; - public updateSensitivityInspectionTemplate( - args: UpdateSensitivityInspectionTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSensitivityInspectionTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateSensitivityInspectionTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateSensitivityInspectionTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Macie

+ */ +export class Macie2 extends Macie2Client implements Macie2 {} +createAggregatedClient(commands, Macie2); diff --git a/clients/client-managedblockchain/src/ManagedBlockchain.ts b/clients/client-managedblockchain/src/ManagedBlockchain.ts index 7908f1d78a00..9242f735f11f 100644 --- a/clients/client-managedblockchain/src/ManagedBlockchain.ts +++ b/clients/client-managedblockchain/src/ManagedBlockchain.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -92,860 +93,376 @@ import { VoteOnProposalCommandInput, VoteOnProposalCommandOutput, } from "./commands/VoteOnProposalCommand"; -import { ManagedBlockchainClient } from "./ManagedBlockchainClient"; +import { ManagedBlockchainClient, ManagedBlockchainClientConfig } from "./ManagedBlockchainClient"; -/** - * @public - *

- *

Amazon Managed Blockchain is a fully managed service for creating and managing blockchain networks using open-source frameworks. Blockchain allows you to build applications where multiple parties can securely and transparently run transactions and share data without the need for a trusted, central authority.

- *

Managed Blockchain supports the Hyperledger Fabric and Ethereum open-source frameworks. Because of fundamental differences between the frameworks, some API actions or data types may only apply in the context of one framework and not the other. For example, actions related to Hyperledger Fabric network members such as CreateMember and DeleteMember don't apply to Ethereum.

- *

The description for each action indicates the framework or frameworks to which it applies. Data types and properties that apply only in the context of a particular framework are similarly indicated.

- */ -export class ManagedBlockchain extends ManagedBlockchainClient { +const commands = { + CreateAccessorCommand, + CreateMemberCommand, + CreateNetworkCommand, + CreateNodeCommand, + CreateProposalCommand, + DeleteAccessorCommand, + DeleteMemberCommand, + DeleteNodeCommand, + GetAccessorCommand, + GetMemberCommand, + GetNetworkCommand, + GetNodeCommand, + GetProposalCommand, + ListAccessorsCommand, + ListInvitationsCommand, + ListMembersCommand, + ListNetworksCommand, + ListNodesCommand, + ListProposalsCommand, + ListProposalVotesCommand, + ListTagsForResourceCommand, + RejectInvitationCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateMemberCommand, + UpdateNodeCommand, + VoteOnProposalCommand, +}; + +export interface ManagedBlockchain { /** - * @public - *

Creates a new accessor for use with Managed Blockchain Ethereum nodes. An accessor contains information - * required for token based access to your Ethereum nodes.

+ * @see {@link CreateAccessorCommand} */ - public createAccessor( + createAccessor( args: CreateAccessorCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAccessor( - args: CreateAccessorCommandInput, - cb: (err: any, data?: CreateAccessorCommandOutput) => void - ): void; - public createAccessor( + createAccessor(args: CreateAccessorCommandInput, cb: (err: any, data?: CreateAccessorCommandOutput) => void): void; + createAccessor( args: CreateAccessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessorCommandOutput) => void ): void; - public createAccessor( - args: CreateAccessorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAccessorCommandOutput) => void), - cb?: (err: any, data?: CreateAccessorCommandOutput) => void - ): Promise | void { - const command = new CreateAccessorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a member within a Managed Blockchain network.

- *

Applies only to Hyperledger Fabric.

+ * @see {@link CreateMemberCommand} */ - public createMember( - args: CreateMemberCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createMember(args: CreateMemberCommandInput, cb: (err: any, data?: CreateMemberCommandOutput) => void): void; - public createMember( + createMember(args: CreateMemberCommandInput, options?: __HttpHandlerOptions): Promise; + createMember(args: CreateMemberCommandInput, cb: (err: any, data?: CreateMemberCommandOutput) => void): void; + createMember( args: CreateMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMemberCommandOutput) => void ): void; - public createMember( - args: CreateMemberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMemberCommandOutput) => void), - cb?: (err: any, data?: CreateMemberCommandOutput) => void - ): Promise | void { - const command = new CreateMemberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new blockchain network using Amazon Managed Blockchain.

- *

Applies only to Hyperledger Fabric.

+ * @see {@link CreateNetworkCommand} */ - public createNetwork( - args: CreateNetworkCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createNetwork( - args: CreateNetworkCommandInput, - cb: (err: any, data?: CreateNetworkCommandOutput) => void - ): void; - public createNetwork( + createNetwork(args: CreateNetworkCommandInput, options?: __HttpHandlerOptions): Promise; + createNetwork(args: CreateNetworkCommandInput, cb: (err: any, data?: CreateNetworkCommandOutput) => void): void; + createNetwork( args: CreateNetworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNetworkCommandOutput) => void ): void; - public createNetwork( - args: CreateNetworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNetworkCommandOutput) => void), - cb?: (err: any, data?: CreateNetworkCommandOutput) => void - ): Promise | void { - const command = new CreateNetworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a node on the specified blockchain network.

- *

Applies to Hyperledger Fabric and Ethereum.

+ * @see {@link CreateNodeCommand} */ - public createNode(args: CreateNodeCommandInput, options?: __HttpHandlerOptions): Promise; - public createNode(args: CreateNodeCommandInput, cb: (err: any, data?: CreateNodeCommandOutput) => void): void; - public createNode( + createNode(args: CreateNodeCommandInput, options?: __HttpHandlerOptions): Promise; + createNode(args: CreateNodeCommandInput, cb: (err: any, data?: CreateNodeCommandOutput) => void): void; + createNode( args: CreateNodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNodeCommandOutput) => void ): void; - public createNode( - args: CreateNodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNodeCommandOutput) => void), - cb?: (err: any, data?: CreateNodeCommandOutput) => void - ): Promise | void { - const command = new CreateNodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a proposal for a change to the network that other members of the network can vote on, for example, a proposal to add a new member to the network. Any member can create a proposal.

- *

Applies only to Hyperledger Fabric.

+ * @see {@link CreateProposalCommand} */ - public createProposal( + createProposal( args: CreateProposalCommandInput, options?: __HttpHandlerOptions ): Promise; - public createProposal( - args: CreateProposalCommandInput, - cb: (err: any, data?: CreateProposalCommandOutput) => void - ): void; - public createProposal( + createProposal(args: CreateProposalCommandInput, cb: (err: any, data?: CreateProposalCommandOutput) => void): void; + createProposal( args: CreateProposalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProposalCommandOutput) => void ): void; - public createProposal( - args: CreateProposalCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProposalCommandOutput) => void), - cb?: (err: any, data?: CreateProposalCommandOutput) => void - ): Promise | void { - const command = new CreateProposalCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an accessor that your Amazon Web Services account owns. An accessor object is a container that has the - * information required for token based access to your Ethereum nodes including, the - * BILLING_TOKEN. After an accessor is deleted, the status of the accessor changes - * from AVAILABLE to PENDING_DELETION. An accessor in the - * PENDING_DELETION state can’t be used for new WebSocket requests or - * HTTP requests. However, WebSocket connections that were initiated while the accessor was in the - * AVAILABLE state remain open until they expire (up to 2 hours).

+ * @see {@link DeleteAccessorCommand} */ - public deleteAccessor( + deleteAccessor( args: DeleteAccessorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAccessor( - args: DeleteAccessorCommandInput, - cb: (err: any, data?: DeleteAccessorCommandOutput) => void - ): void; - public deleteAccessor( + deleteAccessor(args: DeleteAccessorCommandInput, cb: (err: any, data?: DeleteAccessorCommandOutput) => void): void; + deleteAccessor( args: DeleteAccessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessorCommandOutput) => void ): void; - public deleteAccessor( - args: DeleteAccessorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAccessorCommandOutput) => void), - cb?: (err: any, data?: DeleteAccessorCommandOutput) => void - ): Promise | void { - const command = new DeleteAccessorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a member. Deleting a member removes the member and all associated resources from the network. DeleteMember can only be called for a specified MemberId if the principal performing the action is associated with the Amazon Web Services account that owns the member. In all other cases, the DeleteMember action is carried out as the result of an approved proposal to remove a member. If MemberId is the last member in a network specified by the last Amazon Web Services account, the network is deleted also.

- *

Applies only to Hyperledger Fabric.

+ * @see {@link DeleteMemberCommand} */ - public deleteMember( - args: DeleteMemberCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteMember(args: DeleteMemberCommandInput, cb: (err: any, data?: DeleteMemberCommandOutput) => void): void; - public deleteMember( + deleteMember(args: DeleteMemberCommandInput, options?: __HttpHandlerOptions): Promise; + deleteMember(args: DeleteMemberCommandInput, cb: (err: any, data?: DeleteMemberCommandOutput) => void): void; + deleteMember( args: DeleteMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMemberCommandOutput) => void ): void; - public deleteMember( - args: DeleteMemberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMemberCommandOutput) => void), - cb?: (err: any, data?: DeleteMemberCommandOutput) => void - ): Promise | void { - const command = new DeleteMemberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a node that your Amazon Web Services account owns. All data on the node is lost and cannot be recovered.

- *

Applies to Hyperledger Fabric and Ethereum.

+ * @see {@link DeleteNodeCommand} */ - public deleteNode(args: DeleteNodeCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteNode(args: DeleteNodeCommandInput, cb: (err: any, data?: DeleteNodeCommandOutput) => void): void; - public deleteNode( + deleteNode(args: DeleteNodeCommandInput, options?: __HttpHandlerOptions): Promise; + deleteNode(args: DeleteNodeCommandInput, cb: (err: any, data?: DeleteNodeCommandOutput) => void): void; + deleteNode( args: DeleteNodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNodeCommandOutput) => void ): void; - public deleteNode( - args: DeleteNodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNodeCommandOutput) => void), - cb?: (err: any, data?: DeleteNodeCommandOutput) => void - ): Promise | void { - const command = new DeleteNodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns detailed information about an accessor. An accessor object is a container that has the - * information required for token based access to your Ethereum nodes.

+ * @see {@link GetAccessorCommand} */ - public getAccessor(args: GetAccessorCommandInput, options?: __HttpHandlerOptions): Promise; - public getAccessor(args: GetAccessorCommandInput, cb: (err: any, data?: GetAccessorCommandOutput) => void): void; - public getAccessor( + getAccessor(args: GetAccessorCommandInput, options?: __HttpHandlerOptions): Promise; + getAccessor(args: GetAccessorCommandInput, cb: (err: any, data?: GetAccessorCommandOutput) => void): void; + getAccessor( args: GetAccessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessorCommandOutput) => void ): void; - public getAccessor( - args: GetAccessorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccessorCommandOutput) => void), - cb?: (err: any, data?: GetAccessorCommandOutput) => void - ): Promise | void { - const command = new GetAccessorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns detailed information about a member.

- *

Applies only to Hyperledger Fabric.

+ * @see {@link GetMemberCommand} */ - public getMember(args: GetMemberCommandInput, options?: __HttpHandlerOptions): Promise; - public getMember(args: GetMemberCommandInput, cb: (err: any, data?: GetMemberCommandOutput) => void): void; - public getMember( + getMember(args: GetMemberCommandInput, options?: __HttpHandlerOptions): Promise; + getMember(args: GetMemberCommandInput, cb: (err: any, data?: GetMemberCommandOutput) => void): void; + getMember( args: GetMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMemberCommandOutput) => void ): void; - public getMember( - args: GetMemberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMemberCommandOutput) => void), - cb?: (err: any, data?: GetMemberCommandOutput) => void - ): Promise | void { - const command = new GetMemberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns detailed information about a network.

- *

Applies to Hyperledger Fabric and Ethereum.

+ * @see {@link GetNetworkCommand} */ - public getNetwork(args: GetNetworkCommandInput, options?: __HttpHandlerOptions): Promise; - public getNetwork(args: GetNetworkCommandInput, cb: (err: any, data?: GetNetworkCommandOutput) => void): void; - public getNetwork( + getNetwork(args: GetNetworkCommandInput, options?: __HttpHandlerOptions): Promise; + getNetwork(args: GetNetworkCommandInput, cb: (err: any, data?: GetNetworkCommandOutput) => void): void; + getNetwork( args: GetNetworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNetworkCommandOutput) => void ): void; - public getNetwork( - args: GetNetworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetNetworkCommandOutput) => void), - cb?: (err: any, data?: GetNetworkCommandOutput) => void - ): Promise | void { - const command = new GetNetworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns detailed information about a node.

- *

Applies to Hyperledger Fabric and Ethereum.

+ * @see {@link GetNodeCommand} */ - public getNode(args: GetNodeCommandInput, options?: __HttpHandlerOptions): Promise; - public getNode(args: GetNodeCommandInput, cb: (err: any, data?: GetNodeCommandOutput) => void): void; - public getNode( + getNode(args: GetNodeCommandInput, options?: __HttpHandlerOptions): Promise; + getNode(args: GetNodeCommandInput, cb: (err: any, data?: GetNodeCommandOutput) => void): void; + getNode( args: GetNodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNodeCommandOutput) => void ): void; - public getNode( - args: GetNodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetNodeCommandOutput) => void), - cb?: (err: any, data?: GetNodeCommandOutput) => void - ): Promise | void { - const command = new GetNodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns detailed information about a proposal.

- *

Applies only to Hyperledger Fabric.

+ * @see {@link GetProposalCommand} */ - public getProposal(args: GetProposalCommandInput, options?: __HttpHandlerOptions): Promise; - public getProposal(args: GetProposalCommandInput, cb: (err: any, data?: GetProposalCommandOutput) => void): void; - public getProposal( + getProposal(args: GetProposalCommandInput, options?: __HttpHandlerOptions): Promise; + getProposal(args: GetProposalCommandInput, cb: (err: any, data?: GetProposalCommandOutput) => void): void; + getProposal( args: GetProposalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProposalCommandOutput) => void ): void; - public getProposal( - args: GetProposalCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetProposalCommandOutput) => void), - cb?: (err: any, data?: GetProposalCommandOutput) => void - ): Promise | void { - const command = new GetProposalCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the accessors and their properties. Accessor objects are containers that have the - * information required for token based access to your Ethereum nodes.

+ * @see {@link ListAccessorsCommand} */ - public listAccessors( - args: ListAccessorsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listAccessors( - args: ListAccessorsCommandInput, - cb: (err: any, data?: ListAccessorsCommandOutput) => void - ): void; - public listAccessors( + listAccessors(args: ListAccessorsCommandInput, options?: __HttpHandlerOptions): Promise; + listAccessors(args: ListAccessorsCommandInput, cb: (err: any, data?: ListAccessorsCommandOutput) => void): void; + listAccessors( args: ListAccessorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessorsCommandOutput) => void ): void; - public listAccessors( - args: ListAccessorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccessorsCommandOutput) => void), - cb?: (err: any, data?: ListAccessorsCommandOutput) => void - ): Promise | void { - const command = new ListAccessorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all invitations for the current Amazon Web Services account.

- *

Applies only to Hyperledger Fabric.

+ * @see {@link ListInvitationsCommand} */ - public listInvitations( + listInvitations( args: ListInvitationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInvitations( - args: ListInvitationsCommandInput, - cb: (err: any, data?: ListInvitationsCommandOutput) => void - ): void; - public listInvitations( + listInvitations(args: ListInvitationsCommandInput, cb: (err: any, data?: ListInvitationsCommandOutput) => void): void; + listInvitations( args: ListInvitationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInvitationsCommandOutput) => void ): void; - public listInvitations( - args: ListInvitationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInvitationsCommandOutput) => void), - cb?: (err: any, data?: ListInvitationsCommandOutput) => void - ): Promise | void { - const command = new ListInvitationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the members in a network and properties of their configurations.

- *

Applies only to Hyperledger Fabric.

+ * @see {@link ListMembersCommand} */ - public listMembers(args: ListMembersCommandInput, options?: __HttpHandlerOptions): Promise; - public listMembers(args: ListMembersCommandInput, cb: (err: any, data?: ListMembersCommandOutput) => void): void; - public listMembers( + listMembers(args: ListMembersCommandInput, options?: __HttpHandlerOptions): Promise; + listMembers(args: ListMembersCommandInput, cb: (err: any, data?: ListMembersCommandOutput) => void): void; + listMembers( args: ListMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMembersCommandOutput) => void ): void; - public listMembers( - args: ListMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMembersCommandOutput) => void), - cb?: (err: any, data?: ListMembersCommandOutput) => void - ): Promise | void { - const command = new ListMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the networks in which the current Amazon Web Services account participates.

- *

Applies to Hyperledger Fabric and Ethereum.

+ * @see {@link ListNetworksCommand} */ - public listNetworks( - args: ListNetworksCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listNetworks(args: ListNetworksCommandInput, cb: (err: any, data?: ListNetworksCommandOutput) => void): void; - public listNetworks( + listNetworks(args: ListNetworksCommandInput, options?: __HttpHandlerOptions): Promise; + listNetworks(args: ListNetworksCommandInput, cb: (err: any, data?: ListNetworksCommandOutput) => void): void; + listNetworks( args: ListNetworksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNetworksCommandOutput) => void ): void; - public listNetworks( - args: ListNetworksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNetworksCommandOutput) => void), - cb?: (err: any, data?: ListNetworksCommandOutput) => void - ): Promise | void { - const command = new ListNetworksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the nodes within a network.

- *

Applies to Hyperledger Fabric and Ethereum.

+ * @see {@link ListNodesCommand} */ - public listNodes(args: ListNodesCommandInput, options?: __HttpHandlerOptions): Promise; - public listNodes(args: ListNodesCommandInput, cb: (err: any, data?: ListNodesCommandOutput) => void): void; - public listNodes( + listNodes(args: ListNodesCommandInput, options?: __HttpHandlerOptions): Promise; + listNodes(args: ListNodesCommandInput, cb: (err: any, data?: ListNodesCommandOutput) => void): void; + listNodes( args: ListNodesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNodesCommandOutput) => void ): void; - public listNodes( - args: ListNodesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNodesCommandOutput) => void), - cb?: (err: any, data?: ListNodesCommandOutput) => void - ): Promise | void { - const command = new ListNodesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of proposals for the network.

- *

Applies only to Hyperledger Fabric.

+ * @see {@link ListProposalsCommand} */ - public listProposals( - args: ListProposalsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listProposals( - args: ListProposalsCommandInput, - cb: (err: any, data?: ListProposalsCommandOutput) => void - ): void; - public listProposals( + listProposals(args: ListProposalsCommandInput, options?: __HttpHandlerOptions): Promise; + listProposals(args: ListProposalsCommandInput, cb: (err: any, data?: ListProposalsCommandOutput) => void): void; + listProposals( args: ListProposalsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProposalsCommandOutput) => void ): void; - public listProposals( - args: ListProposalsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProposalsCommandOutput) => void), - cb?: (err: any, data?: ListProposalsCommandOutput) => void - ): Promise | void { - const command = new ListProposalsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the list of votes for a specified proposal, including the value of each vote and the unique identifier of the member that cast the vote.

- *

Applies only to Hyperledger Fabric.

+ * @see {@link ListProposalVotesCommand} */ - public listProposalVotes( + listProposalVotes( args: ListProposalVotesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProposalVotes( + listProposalVotes( args: ListProposalVotesCommandInput, cb: (err: any, data?: ListProposalVotesCommandOutput) => void ): void; - public listProposalVotes( + listProposalVotes( args: ListProposalVotesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProposalVotesCommandOutput) => void ): void; - public listProposalVotes( - args: ListProposalVotesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProposalVotesCommandOutput) => void), - cb?: (err: any, data?: ListProposalVotesCommandOutput) => void - ): Promise | void { - const command = new ListProposalVotesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of tags for the specified resource. Each tag consists of a key and optional value.

- *

For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Rejects an invitation to join a network. This action can be called by a principal in an Amazon Web Services account that has received an invitation to create a member and join a network.

- *

Applies only to Hyperledger Fabric.

+ * @see {@link RejectInvitationCommand} */ - public rejectInvitation( + rejectInvitation( args: RejectInvitationCommandInput, options?: __HttpHandlerOptions ): Promise; - public rejectInvitation( + rejectInvitation( args: RejectInvitationCommandInput, cb: (err: any, data?: RejectInvitationCommandOutput) => void ): void; - public rejectInvitation( + rejectInvitation( args: RejectInvitationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectInvitationCommandOutput) => void ): void; - public rejectInvitation( - args: RejectInvitationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RejectInvitationCommandOutput) => void), - cb?: (err: any, data?: RejectInvitationCommandOutput) => void - ): Promise | void { - const command = new RejectInvitationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or overwrites the specified tags for the specified Amazon Managed Blockchain resource. Each tag consists of a key and optional value.

- *

When you specify a tag key that already exists, the tag value is overwritten with the new value. Use UntagResource to remove tag keys.

- *

A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error.

- *

For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified tags from the Amazon Managed Blockchain resource.

- *

For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a member configuration with new parameters.

- *

Applies only to Hyperledger Fabric.

+ * @see {@link UpdateMemberCommand} */ - public updateMember( - args: UpdateMemberCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateMember(args: UpdateMemberCommandInput, cb: (err: any, data?: UpdateMemberCommandOutput) => void): void; - public updateMember( + updateMember(args: UpdateMemberCommandInput, options?: __HttpHandlerOptions): Promise; + updateMember(args: UpdateMemberCommandInput, cb: (err: any, data?: UpdateMemberCommandOutput) => void): void; + updateMember( args: UpdateMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMemberCommandOutput) => void ): void; - public updateMember( - args: UpdateMemberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMemberCommandOutput) => void), - cb?: (err: any, data?: UpdateMemberCommandOutput) => void - ): Promise | void { - const command = new UpdateMemberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a node configuration with new parameters.

- *

Applies only to Hyperledger Fabric.

+ * @see {@link UpdateNodeCommand} */ - public updateNode(args: UpdateNodeCommandInput, options?: __HttpHandlerOptions): Promise; - public updateNode(args: UpdateNodeCommandInput, cb: (err: any, data?: UpdateNodeCommandOutput) => void): void; - public updateNode( + updateNode(args: UpdateNodeCommandInput, options?: __HttpHandlerOptions): Promise; + updateNode(args: UpdateNodeCommandInput, cb: (err: any, data?: UpdateNodeCommandOutput) => void): void; + updateNode( args: UpdateNodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNodeCommandOutput) => void ): void; - public updateNode( - args: UpdateNodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateNodeCommandOutput) => void), - cb?: (err: any, data?: UpdateNodeCommandOutput) => void - ): Promise | void { - const command = new UpdateNodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Casts a vote for a specified ProposalId on behalf of a member. The member to vote as, specified by VoterMemberId, must be in the same Amazon Web Services account as the principal that calls the action.

- *

Applies only to Hyperledger Fabric.

+ * @see {@link VoteOnProposalCommand} */ - public voteOnProposal( + voteOnProposal( args: VoteOnProposalCommandInput, options?: __HttpHandlerOptions ): Promise; - public voteOnProposal( - args: VoteOnProposalCommandInput, - cb: (err: any, data?: VoteOnProposalCommandOutput) => void - ): void; - public voteOnProposal( + voteOnProposal(args: VoteOnProposalCommandInput, cb: (err: any, data?: VoteOnProposalCommandOutput) => void): void; + voteOnProposal( args: VoteOnProposalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VoteOnProposalCommandOutput) => void ): void; - public voteOnProposal( - args: VoteOnProposalCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: VoteOnProposalCommandOutput) => void), - cb?: (err: any, data?: VoteOnProposalCommandOutput) => void - ): Promise | void { - const command = new VoteOnProposalCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

+ *

Amazon Managed Blockchain is a fully managed service for creating and managing blockchain networks using open-source frameworks. Blockchain allows you to build applications where multiple parties can securely and transparently run transactions and share data without the need for a trusted, central authority.

+ *

Managed Blockchain supports the Hyperledger Fabric and Ethereum open-source frameworks. Because of fundamental differences between the frameworks, some API actions or data types may only apply in the context of one framework and not the other. For example, actions related to Hyperledger Fabric network members such as CreateMember and DeleteMember don't apply to Ethereum.

+ *

The description for each action indicates the framework or frameworks to which it applies. Data types and properties that apply only in the context of a particular framework are similarly indicated.

+ */ +export class ManagedBlockchain extends ManagedBlockchainClient implements ManagedBlockchain {} +createAggregatedClient(commands, ManagedBlockchain); diff --git a/clients/client-marketplace-catalog/src/MarketplaceCatalog.ts b/clients/client-marketplace-catalog/src/MarketplaceCatalog.ts index cd9dd9387956..2dbb7c8ffc32 100644 --- a/clients/client-marketplace-catalog/src/MarketplaceCatalog.ts +++ b/clients/client-marketplace-catalog/src/MarketplaceCatalog.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -57,425 +58,207 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; -import { MarketplaceCatalogClient } from "./MarketplaceCatalogClient"; +import { MarketplaceCatalogClient, MarketplaceCatalogClientConfig } from "./MarketplaceCatalogClient"; -/** - * @public - *

Catalog API actions allow you to manage your entities through list, describe, and - * update capabilities. An entity can be a product or an offer on AWS Marketplace.

- *

You can automate your entity update process by integrating the AWS Marketplace Catalog - * API with your AWS Marketplace product build or deployment pipelines. You can also create - * your own applications on top of the Catalog API to manage your products on AWS - * Marketplace.

- */ -export class MarketplaceCatalog extends MarketplaceCatalogClient { +const commands = { + CancelChangeSetCommand, + DeleteResourcePolicyCommand, + DescribeChangeSetCommand, + DescribeEntityCommand, + GetResourcePolicyCommand, + ListChangeSetsCommand, + ListEntitiesCommand, + ListTagsForResourceCommand, + PutResourcePolicyCommand, + StartChangeSetCommand, + TagResourceCommand, + UntagResourceCommand, +}; + +export interface MarketplaceCatalog { /** - * @public - *

Used to cancel an open change request. Must be sent before the status of the request - * changes to APPLYING, the final stage of completing your change request. You - * can describe a change during the 60-day request history retention period for API - * calls.

+ * @see {@link CancelChangeSetCommand} */ - public cancelChangeSet( + cancelChangeSet( args: CancelChangeSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelChangeSet( - args: CancelChangeSetCommandInput, - cb: (err: any, data?: CancelChangeSetCommandOutput) => void - ): void; - public cancelChangeSet( + cancelChangeSet(args: CancelChangeSetCommandInput, cb: (err: any, data?: CancelChangeSetCommandOutput) => void): void; + cancelChangeSet( args: CancelChangeSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelChangeSetCommandOutput) => void ): void; - public cancelChangeSet( - args: CancelChangeSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelChangeSetCommandOutput) => void), - cb?: (err: any, data?: CancelChangeSetCommandOutput) => void - ): Promise | void { - const command = new CancelChangeSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a resource-based policy on an Entity that is identified by its resource - * ARN.

+ * @see {@link DeleteResourcePolicyCommand} */ - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( - args: DeleteResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides information about a given change set.

+ * @see {@link DescribeChangeSetCommand} */ - public describeChangeSet( + describeChangeSet( args: DescribeChangeSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeChangeSet( + describeChangeSet( args: DescribeChangeSetCommandInput, cb: (err: any, data?: DescribeChangeSetCommandOutput) => void ): void; - public describeChangeSet( + describeChangeSet( args: DescribeChangeSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChangeSetCommandOutput) => void ): void; - public describeChangeSet( - args: DescribeChangeSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeChangeSetCommandOutput) => void), - cb?: (err: any, data?: DescribeChangeSetCommandOutput) => void - ): Promise | void { - const command = new DescribeChangeSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the metadata and content of the entity.

+ * @see {@link DescribeEntityCommand} */ - public describeEntity( + describeEntity( args: DescribeEntityCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEntity( - args: DescribeEntityCommandInput, - cb: (err: any, data?: DescribeEntityCommandOutput) => void - ): void; - public describeEntity( + describeEntity(args: DescribeEntityCommandInput, cb: (err: any, data?: DescribeEntityCommandOutput) => void): void; + describeEntity( args: DescribeEntityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEntityCommandOutput) => void ): void; - public describeEntity( - args: DescribeEntityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEntityCommandOutput) => void), - cb?: (err: any, data?: DescribeEntityCommandOutput) => void - ): Promise | void { - const command = new DescribeEntityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a resource-based policy of an Entity that is identified by its resource - * ARN.

+ * @see {@link GetResourcePolicyCommand} */ - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void ): void; - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void ): void; - public getResourcePolicy( - args: GetResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: GetResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new GetResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the list of change sets owned by the account being used to make the call. You - * can filter this list by providing any combination of entityId, - * ChangeSetName, and status. If you provide more than one filter, the API - * operation applies a logical AND between the filters.

- *

You can describe a change during the 60-day request history retention period for API - * calls.

+ * @see {@link ListChangeSetsCommand} */ - public listChangeSets( + listChangeSets( args: ListChangeSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listChangeSets( - args: ListChangeSetsCommandInput, - cb: (err: any, data?: ListChangeSetsCommandOutput) => void - ): void; - public listChangeSets( + listChangeSets(args: ListChangeSetsCommandInput, cb: (err: any, data?: ListChangeSetsCommandOutput) => void): void; + listChangeSets( args: ListChangeSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChangeSetsCommandOutput) => void ): void; - public listChangeSets( - args: ListChangeSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListChangeSetsCommandOutput) => void), - cb?: (err: any, data?: ListChangeSetsCommandOutput) => void - ): Promise | void { - const command = new ListChangeSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides the list of entities of a given type.

+ * @see {@link ListEntitiesCommand} */ - public listEntities( - args: ListEntitiesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listEntities(args: ListEntitiesCommandInput, cb: (err: any, data?: ListEntitiesCommandOutput) => void): void; - public listEntities( + listEntities(args: ListEntitiesCommandInput, options?: __HttpHandlerOptions): Promise; + listEntities(args: ListEntitiesCommandInput, cb: (err: any, data?: ListEntitiesCommandOutput) => void): void; + listEntities( args: ListEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEntitiesCommandOutput) => void ): void; - public listEntities( - args: ListEntitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEntitiesCommandOutput) => void), - cb?: (err: any, data?: ListEntitiesCommandOutput) => void - ): Promise | void { - const command = new ListEntitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all tags that have been added to a resource (either an entity or change set).

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Attaches a resource-based policy to an Entity. Examples of an entity include: - * AmiProduct and ContainerProduct.

+ * @see {@link PutResourcePolicyCommand} */ - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( - args: PutResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: PutResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new PutResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows you to request changes for your entities. Within a single - * ChangeSet, you can't start the same change type against the same entity - * multiple times. Additionally, when a ChangeSet is running, all the entities - * targeted by the different changes are locked until the change set has completed (either - * succeeded, cancelled, or failed). If you try to start a change set containing a change - * against an entity that is already locked, you will receive a - * ResourceInUseException error.

- *

For example, you can't start the ChangeSet described in the example later in this topic because it contains two changes to run the same - * change type (AddRevisions) against the same entity - * (entity-id@1).

- *

For more information about working with change sets, see Working with change sets. For information on change types for single-AMI - * products, see Working with single-AMI products. Als, for more information on change types - * available for container-based products, see Working with container products.

+ * @see {@link StartChangeSetCommand} */ - public startChangeSet( + startChangeSet( args: StartChangeSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public startChangeSet( - args: StartChangeSetCommandInput, - cb: (err: any, data?: StartChangeSetCommandOutput) => void - ): void; - public startChangeSet( + startChangeSet(args: StartChangeSetCommandInput, cb: (err: any, data?: StartChangeSetCommandOutput) => void): void; + startChangeSet( args: StartChangeSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartChangeSetCommandOutput) => void ): void; - public startChangeSet( - args: StartChangeSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartChangeSetCommandOutput) => void), - cb?: (err: any, data?: StartChangeSetCommandOutput) => void - ): Promise | void { - const command = new StartChangeSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Tags a resource (either an entity or change set).

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a tag or list of tags from a resource (either an entity or change set).

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Catalog API actions allow you to manage your entities through list, describe, and + * update capabilities. An entity can be a product or an offer on AWS Marketplace.

+ *

You can automate your entity update process by integrating the AWS Marketplace Catalog + * API with your AWS Marketplace product build or deployment pipelines. You can also create + * your own applications on top of the Catalog API to manage your products on AWS + * Marketplace.

+ */ +export class MarketplaceCatalog extends MarketplaceCatalogClient implements MarketplaceCatalog {} +createAggregatedClient(commands, MarketplaceCatalog); diff --git a/clients/client-marketplace-commerce-analytics/src/MarketplaceCommerceAnalytics.ts b/clients/client-marketplace-commerce-analytics/src/MarketplaceCommerceAnalytics.ts index f532b31125c0..92ff23e4f8d1 100644 --- a/clients/client-marketplace-commerce-analytics/src/MarketplaceCommerceAnalytics.ts +++ b/clients/client-marketplace-commerce-analytics/src/MarketplaceCommerceAnalytics.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -11,90 +12,54 @@ import { StartSupportDataExportCommandInput, StartSupportDataExportCommandOutput, } from "./commands/StartSupportDataExportCommand"; -import { MarketplaceCommerceAnalyticsClient } from "./MarketplaceCommerceAnalyticsClient"; +import { + MarketplaceCommerceAnalyticsClient, + MarketplaceCommerceAnalyticsClientConfig, +} from "./MarketplaceCommerceAnalyticsClient"; -/** - * @public - * Provides AWS Marketplace business intelligence data on-demand. - */ -export class MarketplaceCommerceAnalytics extends MarketplaceCommerceAnalyticsClient { +const commands = { + GenerateDataSetCommand, + StartSupportDataExportCommand, +}; + +export interface MarketplaceCommerceAnalytics { /** - * @public - * Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified - * S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that - * can be used to correlate requests with notifications from the SNS topic. - * Data sets will be published in comma-separated values (CSV) format with the file name \{data_set_type\}_YYYY-MM-DD.csv. - * If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will - * be overwritten by the new file. - * Requires a Role with an attached permissions policy providing Allow permissions for the following actions: - * s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy. + * @see {@link GenerateDataSetCommand} */ - public generateDataSet( + generateDataSet( args: GenerateDataSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public generateDataSet( - args: GenerateDataSetCommandInput, - cb: (err: any, data?: GenerateDataSetCommandOutput) => void - ): void; - public generateDataSet( + generateDataSet(args: GenerateDataSetCommandInput, cb: (err: any, data?: GenerateDataSetCommandOutput) => void): void; + generateDataSet( args: GenerateDataSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateDataSetCommandOutput) => void ): void; - public generateDataSet( - args: GenerateDataSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GenerateDataSetCommandOutput) => void), - cb?: (err: any, data?: GenerateDataSetCommandOutput) => void - ): Promise | void { - const command = new GenerateDataSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Given a data set type and a from date, asynchronously publishes the requested customer support data - * to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request - * identifier that can be used to correlate requests with notifications from the SNS topic. - * Data sets will be published in comma-separated values (CSV) format with the file name \{data_set_type\}_YYYY-MM-DD'T'HH-mm-ss'Z'.csv. - * If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will - * be overwritten by the new file. - * Requires a Role with an attached permissions policy providing Allow permissions for the following actions: - * s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy. + * @see {@link StartSupportDataExportCommand} */ - public startSupportDataExport( + startSupportDataExport( args: StartSupportDataExportCommandInput, options?: __HttpHandlerOptions ): Promise; - public startSupportDataExport( + startSupportDataExport( args: StartSupportDataExportCommandInput, cb: (err: any, data?: StartSupportDataExportCommandOutput) => void ): void; - public startSupportDataExport( + startSupportDataExport( args: StartSupportDataExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSupportDataExportCommandOutput) => void ): void; - public startSupportDataExport( - args: StartSupportDataExportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartSupportDataExportCommandOutput) => void), - cb?: (err: any, data?: StartSupportDataExportCommandOutput) => void - ): Promise | void { - const command = new StartSupportDataExportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Provides AWS Marketplace business intelligence data on-demand. + */ +export class MarketplaceCommerceAnalytics + extends MarketplaceCommerceAnalyticsClient + implements MarketplaceCommerceAnalytics {} +createAggregatedClient(commands, MarketplaceCommerceAnalytics); diff --git a/clients/client-marketplace-entitlement-service/src/MarketplaceEntitlementService.ts b/clients/client-marketplace-entitlement-service/src/MarketplaceEntitlementService.ts index c80ce534276d..43e907d1d8b1 100644 --- a/clients/client-marketplace-entitlement-service/src/MarketplaceEntitlementService.ts +++ b/clients/client-marketplace-entitlement-service/src/MarketplaceEntitlementService.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -6,7 +7,30 @@ import { GetEntitlementsCommandInput, GetEntitlementsCommandOutput, } from "./commands/GetEntitlementsCommand"; -import { MarketplaceEntitlementServiceClient } from "./MarketplaceEntitlementServiceClient"; +import { + MarketplaceEntitlementServiceClient, + MarketplaceEntitlementServiceClientConfig, +} from "./MarketplaceEntitlementServiceClient"; + +const commands = { + GetEntitlementsCommand, +}; + +export interface MarketplaceEntitlementService { + /** + * @see {@link GetEntitlementsCommand} + */ + getEntitlements( + args: GetEntitlementsCommandInput, + options?: __HttpHandlerOptions + ): Promise; + getEntitlements(args: GetEntitlementsCommandInput, cb: (err: any, data?: GetEntitlementsCommandOutput) => void): void; + getEntitlements( + args: GetEntitlementsCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: GetEntitlementsCommandOutput) => void + ): void; +} /** * @public @@ -28,38 +52,7 @@ import { MarketplaceEntitlementServiceClient } from "./MarketplaceEntitlementSer * * */ -export class MarketplaceEntitlementService extends MarketplaceEntitlementServiceClient { - /** - * @public - *

GetEntitlements retrieves entitlement values for a given product. The results can be - * filtered based on customer identifier or product dimensions.

- */ - public getEntitlements( - args: GetEntitlementsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getEntitlements( - args: GetEntitlementsCommandInput, - cb: (err: any, data?: GetEntitlementsCommandOutput) => void - ): void; - public getEntitlements( - args: GetEntitlementsCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: GetEntitlementsCommandOutput) => void - ): void; - public getEntitlements( - args: GetEntitlementsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEntitlementsCommandOutput) => void), - cb?: (err: any, data?: GetEntitlementsCommandOutput) => void - ): Promise | void { - const command = new GetEntitlementsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } -} +export class MarketplaceEntitlementService + extends MarketplaceEntitlementServiceClient + implements MarketplaceEntitlementService {} +createAggregatedClient(commands, MarketplaceEntitlementService); diff --git a/clients/client-marketplace-metering/src/MarketplaceMetering.ts b/clients/client-marketplace-metering/src/MarketplaceMetering.ts index 675c30a42712..3de6920bb105 100644 --- a/clients/client-marketplace-metering/src/MarketplaceMetering.ts +++ b/clients/client-marketplace-metering/src/MarketplaceMetering.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -17,7 +18,66 @@ import { ResolveCustomerCommandInput, ResolveCustomerCommandOutput, } from "./commands/ResolveCustomerCommand"; -import { MarketplaceMeteringClient } from "./MarketplaceMeteringClient"; +import { MarketplaceMeteringClient, MarketplaceMeteringClientConfig } from "./MarketplaceMeteringClient"; + +const commands = { + BatchMeterUsageCommand, + MeterUsageCommand, + RegisterUsageCommand, + ResolveCustomerCommand, +}; + +export interface MarketplaceMetering { + /** + * @see {@link BatchMeterUsageCommand} + */ + batchMeterUsage( + args: BatchMeterUsageCommandInput, + options?: __HttpHandlerOptions + ): Promise; + batchMeterUsage(args: BatchMeterUsageCommandInput, cb: (err: any, data?: BatchMeterUsageCommandOutput) => void): void; + batchMeterUsage( + args: BatchMeterUsageCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: BatchMeterUsageCommandOutput) => void + ): void; + + /** + * @see {@link MeterUsageCommand} + */ + meterUsage(args: MeterUsageCommandInput, options?: __HttpHandlerOptions): Promise; + meterUsage(args: MeterUsageCommandInput, cb: (err: any, data?: MeterUsageCommandOutput) => void): void; + meterUsage( + args: MeterUsageCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: MeterUsageCommandOutput) => void + ): void; + + /** + * @see {@link RegisterUsageCommand} + */ + registerUsage(args: RegisterUsageCommandInput, options?: __HttpHandlerOptions): Promise; + registerUsage(args: RegisterUsageCommandInput, cb: (err: any, data?: RegisterUsageCommandOutput) => void): void; + registerUsage( + args: RegisterUsageCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: RegisterUsageCommandOutput) => void + ): void; + + /** + * @see {@link ResolveCustomerCommand} + */ + resolveCustomer( + args: ResolveCustomerCommandInput, + options?: __HttpHandlerOptions + ): Promise; + resolveCustomer(args: ResolveCustomerCommandInput, cb: (err: any, data?: ResolveCustomerCommandOutput) => void): void; + resolveCustomer( + args: ResolveCustomerCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: ResolveCustomerCommandOutput) => void + ): void; +} /** * @public @@ -85,218 +145,5 @@ import { MarketplaceMeteringClient } from "./MarketplaceMeteringClient"; * AWS CloudTrail User Guide. *

*/ -export class MarketplaceMetering extends MarketplaceMeteringClient { - /** - * @public - *

- * BatchMeterUsage is called from a SaaS application listed on AWS - * Marketplace to post metering records for a set of customers.

- *

For identical requests, the API is idempotent; requests can be retried with the same - * records or a subset of the input records.

- *

Every request to BatchMeterUsage is for one product. If you need to meter - * usage for multiple products, you must make multiple calls to - * BatchMeterUsage.

- *

Usage records are expected to be submitted as quickly as possible after the event that - * is being recorded, and are not accepted more than 6 hours after the event.

- *

- * BatchMeterUsage can process up to 25 UsageRecords at a - * time.

- *

A UsageRecord can optionally include multiple usage allocations, to - * provide customers with usage data split into buckets by tags that you define (or allow - * the customer to define).

- *

- * BatchMeterUsage returns a list of UsageRecordResult objects, - * showing the result for each UsageRecord, as well as a list of - * UnprocessedRecords, indicating errors in the service side that you - * should retry.

- *

- * BatchMeterUsage requests must be less than 1MB in size.

- * - *

For an example of using BatchMeterUsage, see BatchMeterUsage code example in the AWS Marketplace Seller - * Guide.

- *
- */ - public batchMeterUsage( - args: BatchMeterUsageCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public batchMeterUsage( - args: BatchMeterUsageCommandInput, - cb: (err: any, data?: BatchMeterUsageCommandOutput) => void - ): void; - public batchMeterUsage( - args: BatchMeterUsageCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: BatchMeterUsageCommandOutput) => void - ): void; - public batchMeterUsage( - args: BatchMeterUsageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchMeterUsageCommandOutput) => void), - cb?: (err: any, data?: BatchMeterUsageCommandOutput) => void - ): Promise | void { - const command = new BatchMeterUsageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

API to emit metering records. For identical requests, the API is idempotent. It simply - * returns the metering record ID.

- *

- * MeterUsage is authenticated on the buyer's AWS account using credentials - * from the EC2 instance, ECS task, or EKS pod.

- *

- * MeterUsage can optionally include multiple usage allocations, to provide - * customers with usage data split into buckets by tags that you define (or allow the - * customer to define).

- *

Usage records are expected to be submitted as quickly as possible after the event that - * is being recorded, and are not accepted more than 6 hours after the event.

- */ - public meterUsage(args: MeterUsageCommandInput, options?: __HttpHandlerOptions): Promise; - public meterUsage(args: MeterUsageCommandInput, cb: (err: any, data?: MeterUsageCommandOutput) => void): void; - public meterUsage( - args: MeterUsageCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: MeterUsageCommandOutput) => void - ): void; - public meterUsage( - args: MeterUsageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MeterUsageCommandOutput) => void), - cb?: (err: any, data?: MeterUsageCommandOutput) => void - ): Promise | void { - const command = new MeterUsageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Paid container software products sold through AWS Marketplace must integrate with the - * AWS Marketplace Metering Service and call the RegisterUsage operation for - * software entitlement and metering. Free and BYOL products for Amazon ECS or Amazon EKS - * aren't required to call RegisterUsage, but you may choose to do so if you - * would like to receive usage data in your seller reports. The sections below explain the - * behavior of RegisterUsage. RegisterUsage performs two primary - * functions: metering and entitlement.

- *
    - *
  • - *

    - * Entitlement: RegisterUsage allows you to - * verify that the customer running your paid software is subscribed to your - * product on AWS Marketplace, enabling you to guard against unauthorized use. Your - * container image that integrates with RegisterUsage is only required - * to guard against unauthorized use at container startup, as such a - * CustomerNotSubscribedException or - * PlatformNotSupportedException will only be thrown on the - * initial call to RegisterUsage. Subsequent calls from the same - * Amazon ECS task instance (e.g. task-id) or Amazon EKS pod will not throw a - * CustomerNotSubscribedException, even if the customer - * unsubscribes while the Amazon ECS task or Amazon EKS pod is still - * running.

    - *
  • - *
  • - *

    - * Metering: RegisterUsage meters software use - * per ECS task, per hour, or per pod for Amazon EKS with usage prorated to the - * second. A minimum of 1 minute of usage applies to tasks that are short lived. - * For example, if a customer has a 10 node Amazon ECS or Amazon EKS cluster and a - * service configured as a Daemon Set, then Amazon ECS or Amazon EKS will launch a - * task on all 10 cluster nodes and the customer will be charged: (10 * - * hourly_rate). Metering for software use is automatically handled by the AWS - * Marketplace Metering Control Plane -- your software is not required to perform - * any metering specific actions, other than call RegisterUsage once - * for metering of software use to commence. The AWS Marketplace Metering Control - * Plane will also continue to bill customers for running ECS tasks and Amazon EKS - * pods, regardless of the customers subscription state, removing the need for your - * software to perform entitlement checks at runtime.

    - *
  • - *
- */ - public registerUsage( - args: RegisterUsageCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public registerUsage( - args: RegisterUsageCommandInput, - cb: (err: any, data?: RegisterUsageCommandOutput) => void - ): void; - public registerUsage( - args: RegisterUsageCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: RegisterUsageCommandOutput) => void - ): void; - public registerUsage( - args: RegisterUsageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterUsageCommandOutput) => void), - cb?: (err: any, data?: RegisterUsageCommandOutput) => void - ): Promise | void { - const command = new RegisterUsageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * ResolveCustomer is called by a SaaS application during the registration - * process. When a buyer visits your website during the registration process, the buyer - * submits a registration token through their browser. The registration token is resolved - * through this API to obtain a CustomerIdentifier - * along with the - * CustomerAWSAccountId and - * ProductCode.

- * - *

The API needs to called from the seller account id used to publish the SaaS - * application to successfully resolve the token.

- *

For an example of using ResolveCustomer, see ResolveCustomer code example in the AWS Marketplace Seller - * Guide.

- *
- */ - public resolveCustomer( - args: ResolveCustomerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public resolveCustomer( - args: ResolveCustomerCommandInput, - cb: (err: any, data?: ResolveCustomerCommandOutput) => void - ): void; - public resolveCustomer( - args: ResolveCustomerCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: ResolveCustomerCommandOutput) => void - ): void; - public resolveCustomer( - args: ResolveCustomerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResolveCustomerCommandOutput) => void), - cb?: (err: any, data?: ResolveCustomerCommandOutput) => void - ): Promise | void { - const command = new ResolveCustomerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } -} +export class MarketplaceMetering extends MarketplaceMeteringClient implements MarketplaceMetering {} +createAggregatedClient(commands, MarketplaceMetering); diff --git a/clients/client-mediaconnect/src/MediaConnect.ts b/clients/client-mediaconnect/src/MediaConnect.ts index 4922a057ac0d..8a8cd1616592 100644 --- a/clients/client-mediaconnect/src/MediaConnect.ts +++ b/clients/client-mediaconnect/src/MediaConnect.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -219,1597 +220,802 @@ import { UpdateGatewayInstanceCommandInput, UpdateGatewayInstanceCommandOutput, } from "./commands/UpdateGatewayInstanceCommand"; -import { MediaConnectClient } from "./MediaConnectClient"; +import { MediaConnectClient, MediaConnectClientConfig } from "./MediaConnectClient"; -/** - * @public - * API for AWS Elemental MediaConnect - */ -export class MediaConnect extends MediaConnectClient { +const commands = { + AddBridgeOutputsCommand, + AddBridgeSourcesCommand, + AddFlowMediaStreamsCommand, + AddFlowOutputsCommand, + AddFlowSourcesCommand, + AddFlowVpcInterfacesCommand, + CreateBridgeCommand, + CreateFlowCommand, + CreateGatewayCommand, + DeleteBridgeCommand, + DeleteFlowCommand, + DeleteGatewayCommand, + DeregisterGatewayInstanceCommand, + DescribeBridgeCommand, + DescribeFlowCommand, + DescribeGatewayCommand, + DescribeGatewayInstanceCommand, + DescribeOfferingCommand, + DescribeReservationCommand, + GrantFlowEntitlementsCommand, + ListBridgesCommand, + ListEntitlementsCommand, + ListFlowsCommand, + ListGatewayInstancesCommand, + ListGatewaysCommand, + ListOfferingsCommand, + ListReservationsCommand, + ListTagsForResourceCommand, + PurchaseOfferingCommand, + RemoveBridgeOutputCommand, + RemoveBridgeSourceCommand, + RemoveFlowMediaStreamCommand, + RemoveFlowOutputCommand, + RemoveFlowSourceCommand, + RemoveFlowVpcInterfaceCommand, + RevokeFlowEntitlementCommand, + StartFlowCommand, + StopFlowCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateBridgeCommand, + UpdateBridgeOutputCommand, + UpdateBridgeSourceCommand, + UpdateBridgeStateCommand, + UpdateFlowCommand, + UpdateFlowEntitlementCommand, + UpdateFlowMediaStreamCommand, + UpdateFlowOutputCommand, + UpdateFlowSourceCommand, + UpdateGatewayInstanceCommand, +}; + +export interface MediaConnect { /** - * @public - * Adds outputs to an existing bridge. + * @see {@link AddBridgeOutputsCommand} */ - public addBridgeOutputs( + addBridgeOutputs( args: AddBridgeOutputsCommandInput, options?: __HttpHandlerOptions ): Promise; - public addBridgeOutputs( + addBridgeOutputs( args: AddBridgeOutputsCommandInput, cb: (err: any, data?: AddBridgeOutputsCommandOutput) => void ): void; - public addBridgeOutputs( + addBridgeOutputs( args: AddBridgeOutputsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddBridgeOutputsCommandOutput) => void ): void; - public addBridgeOutputs( - args: AddBridgeOutputsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddBridgeOutputsCommandOutput) => void), - cb?: (err: any, data?: AddBridgeOutputsCommandOutput) => void - ): Promise | void { - const command = new AddBridgeOutputsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Adds sources to an existing bridge. + * @see {@link AddBridgeSourcesCommand} */ - public addBridgeSources( + addBridgeSources( args: AddBridgeSourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public addBridgeSources( + addBridgeSources( args: AddBridgeSourcesCommandInput, cb: (err: any, data?: AddBridgeSourcesCommandOutput) => void ): void; - public addBridgeSources( + addBridgeSources( args: AddBridgeSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddBridgeSourcesCommandOutput) => void ): void; - public addBridgeSources( - args: AddBridgeSourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddBridgeSourcesCommandOutput) => void), - cb?: (err: any, data?: AddBridgeSourcesCommandOutput) => void - ): Promise | void { - const command = new AddBridgeSourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Adds media streams to an existing flow. After you add a media stream to a flow, you can associate it with a source and/or an output that uses the ST 2110 JPEG XS or CDI protocol. + * @see {@link AddFlowMediaStreamsCommand} */ - public addFlowMediaStreams( + addFlowMediaStreams( args: AddFlowMediaStreamsCommandInput, options?: __HttpHandlerOptions ): Promise; - public addFlowMediaStreams( + addFlowMediaStreams( args: AddFlowMediaStreamsCommandInput, cb: (err: any, data?: AddFlowMediaStreamsCommandOutput) => void ): void; - public addFlowMediaStreams( + addFlowMediaStreams( args: AddFlowMediaStreamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddFlowMediaStreamsCommandOutput) => void ): void; - public addFlowMediaStreams( - args: AddFlowMediaStreamsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddFlowMediaStreamsCommandOutput) => void), - cb?: (err: any, data?: AddFlowMediaStreamsCommandOutput) => void - ): Promise | void { - const command = new AddFlowMediaStreamsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Adds outputs to an existing flow. You can create up to 50 outputs per flow. + * @see {@link AddFlowOutputsCommand} */ - public addFlowOutputs( + addFlowOutputs( args: AddFlowOutputsCommandInput, options?: __HttpHandlerOptions ): Promise; - public addFlowOutputs( - args: AddFlowOutputsCommandInput, - cb: (err: any, data?: AddFlowOutputsCommandOutput) => void - ): void; - public addFlowOutputs( + addFlowOutputs(args: AddFlowOutputsCommandInput, cb: (err: any, data?: AddFlowOutputsCommandOutput) => void): void; + addFlowOutputs( args: AddFlowOutputsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddFlowOutputsCommandOutput) => void ): void; - public addFlowOutputs( - args: AddFlowOutputsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddFlowOutputsCommandOutput) => void), - cb?: (err: any, data?: AddFlowOutputsCommandOutput) => void - ): Promise | void { - const command = new AddFlowOutputsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Adds Sources to flow + * @see {@link AddFlowSourcesCommand} */ - public addFlowSources( + addFlowSources( args: AddFlowSourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public addFlowSources( - args: AddFlowSourcesCommandInput, - cb: (err: any, data?: AddFlowSourcesCommandOutput) => void - ): void; - public addFlowSources( + addFlowSources(args: AddFlowSourcesCommandInput, cb: (err: any, data?: AddFlowSourcesCommandOutput) => void): void; + addFlowSources( args: AddFlowSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddFlowSourcesCommandOutput) => void ): void; - public addFlowSources( - args: AddFlowSourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddFlowSourcesCommandOutput) => void), - cb?: (err: any, data?: AddFlowSourcesCommandOutput) => void - ): Promise | void { - const command = new AddFlowSourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Adds VPC interfaces to flow + * @see {@link AddFlowVpcInterfacesCommand} */ - public addFlowVpcInterfaces( + addFlowVpcInterfaces( args: AddFlowVpcInterfacesCommandInput, options?: __HttpHandlerOptions ): Promise; - public addFlowVpcInterfaces( + addFlowVpcInterfaces( args: AddFlowVpcInterfacesCommandInput, cb: (err: any, data?: AddFlowVpcInterfacesCommandOutput) => void ): void; - public addFlowVpcInterfaces( + addFlowVpcInterfaces( args: AddFlowVpcInterfacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddFlowVpcInterfacesCommandOutput) => void ): void; - public addFlowVpcInterfaces( - args: AddFlowVpcInterfacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddFlowVpcInterfacesCommandOutput) => void), - cb?: (err: any, data?: AddFlowVpcInterfacesCommandOutput) => void - ): Promise | void { - const command = new AddFlowVpcInterfacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Creates a new bridge. The request must include one source. + * @see {@link CreateBridgeCommand} */ - public createBridge( - args: CreateBridgeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createBridge(args: CreateBridgeCommandInput, cb: (err: any, data?: CreateBridgeCommandOutput) => void): void; - public createBridge( + createBridge(args: CreateBridgeCommandInput, options?: __HttpHandlerOptions): Promise; + createBridge(args: CreateBridgeCommandInput, cb: (err: any, data?: CreateBridgeCommandOutput) => void): void; + createBridge( args: CreateBridgeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBridgeCommandOutput) => void ): void; - public createBridge( - args: CreateBridgeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBridgeCommandOutput) => void), - cb?: (err: any, data?: CreateBridgeCommandOutput) => void - ): Promise | void { - const command = new CreateBridgeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50). + * @see {@link CreateFlowCommand} */ - public createFlow(args: CreateFlowCommandInput, options?: __HttpHandlerOptions): Promise; - public createFlow(args: CreateFlowCommandInput, cb: (err: any, data?: CreateFlowCommandOutput) => void): void; - public createFlow( + createFlow(args: CreateFlowCommandInput, options?: __HttpHandlerOptions): Promise; + createFlow(args: CreateFlowCommandInput, cb: (err: any, data?: CreateFlowCommandOutput) => void): void; + createFlow( args: CreateFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFlowCommandOutput) => void ): void; - public createFlow( - args: CreateFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFlowCommandOutput) => void), - cb?: (err: any, data?: CreateFlowCommandOutput) => void - ): Promise | void { - const command = new CreateFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Creates a new gateway. The request must include at least one network (up to 4). + * @see {@link CreateGatewayCommand} */ - public createGateway( - args: CreateGatewayCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createGateway( - args: CreateGatewayCommandInput, - cb: (err: any, data?: CreateGatewayCommandOutput) => void - ): void; - public createGateway( + createGateway(args: CreateGatewayCommandInput, options?: __HttpHandlerOptions): Promise; + createGateway(args: CreateGatewayCommandInput, cb: (err: any, data?: CreateGatewayCommandOutput) => void): void; + createGateway( args: CreateGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGatewayCommandOutput) => void ): void; - public createGateway( - args: CreateGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGatewayCommandOutput) => void), - cb?: (err: any, data?: CreateGatewayCommandOutput) => void - ): Promise | void { - const command = new CreateGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Deletes a bridge. Before you can delete a bridge, you must stop the bridge. + * @see {@link DeleteBridgeCommand} */ - public deleteBridge( - args: DeleteBridgeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteBridge(args: DeleteBridgeCommandInput, cb: (err: any, data?: DeleteBridgeCommandOutput) => void): void; - public deleteBridge( + deleteBridge(args: DeleteBridgeCommandInput, options?: __HttpHandlerOptions): Promise; + deleteBridge(args: DeleteBridgeCommandInput, cb: (err: any, data?: DeleteBridgeCommandOutput) => void): void; + deleteBridge( args: DeleteBridgeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBridgeCommandOutput) => void ): void; - public deleteBridge( - args: DeleteBridgeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBridgeCommandOutput) => void), - cb?: (err: any, data?: DeleteBridgeCommandOutput) => void - ): Promise | void { - const command = new DeleteBridgeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Deletes a flow. Before you can delete a flow, you must stop the flow. + * @see {@link DeleteFlowCommand} */ - public deleteFlow(args: DeleteFlowCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteFlow(args: DeleteFlowCommandInput, cb: (err: any, data?: DeleteFlowCommandOutput) => void): void; - public deleteFlow( + deleteFlow(args: DeleteFlowCommandInput, options?: __HttpHandlerOptions): Promise; + deleteFlow(args: DeleteFlowCommandInput, cb: (err: any, data?: DeleteFlowCommandOutput) => void): void; + deleteFlow( args: DeleteFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFlowCommandOutput) => void ): void; - public deleteFlow( - args: DeleteFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFlowCommandOutput) => void), - cb?: (err: any, data?: DeleteFlowCommandOutput) => void - ): Promise | void { - const command = new DeleteFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Deletes a gateway. Before you can delete a gateway, you must deregister its instances and delete its bridges. + * @see {@link DeleteGatewayCommand} */ - public deleteGateway( - args: DeleteGatewayCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteGateway( - args: DeleteGatewayCommandInput, - cb: (err: any, data?: DeleteGatewayCommandOutput) => void - ): void; - public deleteGateway( + deleteGateway(args: DeleteGatewayCommandInput, options?: __HttpHandlerOptions): Promise; + deleteGateway(args: DeleteGatewayCommandInput, cb: (err: any, data?: DeleteGatewayCommandOutput) => void): void; + deleteGateway( args: DeleteGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGatewayCommandOutput) => void ): void; - public deleteGateway( - args: DeleteGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGatewayCommandOutput) => void), - cb?: (err: any, data?: DeleteGatewayCommandOutput) => void - ): Promise | void { - const command = new DeleteGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Deregisters an instance. Before you deregister an instance, all bridges running on the instance must be stopped. If you want to deregister an instance without stopping the bridges, you must use the --force option. + * @see {@link DeregisterGatewayInstanceCommand} */ - public deregisterGatewayInstance( + deregisterGatewayInstance( args: DeregisterGatewayInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterGatewayInstance( + deregisterGatewayInstance( args: DeregisterGatewayInstanceCommandInput, cb: (err: any, data?: DeregisterGatewayInstanceCommandOutput) => void ): void; - public deregisterGatewayInstance( + deregisterGatewayInstance( args: DeregisterGatewayInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterGatewayInstanceCommandOutput) => void ): void; - public deregisterGatewayInstance( - args: DeregisterGatewayInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterGatewayInstanceCommandOutput) => void), - cb?: (err: any, data?: DeregisterGatewayInstanceCommandOutput) => void - ): Promise | void { - const command = new DeregisterGatewayInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Displays the details of a bridge. + * @see {@link DescribeBridgeCommand} */ - public describeBridge( + describeBridge( args: DescribeBridgeCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBridge( - args: DescribeBridgeCommandInput, - cb: (err: any, data?: DescribeBridgeCommandOutput) => void - ): void; - public describeBridge( + describeBridge(args: DescribeBridgeCommandInput, cb: (err: any, data?: DescribeBridgeCommandOutput) => void): void; + describeBridge( args: DescribeBridgeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBridgeCommandOutput) => void ): void; - public describeBridge( - args: DescribeBridgeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBridgeCommandOutput) => void), - cb?: (err: any, data?: DescribeBridgeCommandOutput) => void - ): Promise | void { - const command = new DescribeBridgeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Displays the details of a flow. The response includes the flow ARN, name, and Availability Zone, as well as details about the source, outputs, and entitlements. + * @see {@link DescribeFlowCommand} */ - public describeFlow( - args: DescribeFlowCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeFlow(args: DescribeFlowCommandInput, cb: (err: any, data?: DescribeFlowCommandOutput) => void): void; - public describeFlow( + describeFlow(args: DescribeFlowCommandInput, options?: __HttpHandlerOptions): Promise; + describeFlow(args: DescribeFlowCommandInput, cb: (err: any, data?: DescribeFlowCommandOutput) => void): void; + describeFlow( args: DescribeFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFlowCommandOutput) => void ): void; - public describeFlow( - args: DescribeFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFlowCommandOutput) => void), - cb?: (err: any, data?: DescribeFlowCommandOutput) => void - ): Promise | void { - const command = new DescribeFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Displays the details of a gateway. The response includes the gateway ARN, name, and CIDR blocks, as well as details about the networks. + * @see {@link DescribeGatewayCommand} */ - public describeGateway( + describeGateway( args: DescribeGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGateway( - args: DescribeGatewayCommandInput, - cb: (err: any, data?: DescribeGatewayCommandOutput) => void - ): void; - public describeGateway( + describeGateway(args: DescribeGatewayCommandInput, cb: (err: any, data?: DescribeGatewayCommandOutput) => void): void; + describeGateway( args: DescribeGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGatewayCommandOutput) => void ): void; - public describeGateway( - args: DescribeGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGatewayCommandOutput) => void), - cb?: (err: any, data?: DescribeGatewayCommandOutput) => void - ): Promise | void { - const command = new DescribeGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Displays the details of an instance. + * @see {@link DescribeGatewayInstanceCommand} */ - public describeGatewayInstance( + describeGatewayInstance( args: DescribeGatewayInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGatewayInstance( + describeGatewayInstance( args: DescribeGatewayInstanceCommandInput, cb: (err: any, data?: DescribeGatewayInstanceCommandOutput) => void ): void; - public describeGatewayInstance( + describeGatewayInstance( args: DescribeGatewayInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGatewayInstanceCommandOutput) => void ): void; - public describeGatewayInstance( - args: DescribeGatewayInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGatewayInstanceCommandOutput) => void), - cb?: (err: any, data?: DescribeGatewayInstanceCommandOutput) => void - ): Promise | void { - const command = new DescribeGatewayInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Displays the details of an offering. The response includes the offering description, duration, outbound bandwidth, price, and Amazon Resource Name (ARN). + * @see {@link DescribeOfferingCommand} */ - public describeOffering( + describeOffering( args: DescribeOfferingCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOffering( + describeOffering( args: DescribeOfferingCommandInput, cb: (err: any, data?: DescribeOfferingCommandOutput) => void ): void; - public describeOffering( + describeOffering( args: DescribeOfferingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOfferingCommandOutput) => void ): void; - public describeOffering( - args: DescribeOfferingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOfferingCommandOutput) => void), - cb?: (err: any, data?: DescribeOfferingCommandOutput) => void - ): Promise | void { - const command = new DescribeOfferingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Displays the details of a reservation. The response includes the reservation name, state, start date and time, and the details of the offering that make up the rest of the reservation (such as price, duration, and outbound bandwidth). + * @see {@link DescribeReservationCommand} */ - public describeReservation( + describeReservation( args: DescribeReservationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReservation( + describeReservation( args: DescribeReservationCommandInput, cb: (err: any, data?: DescribeReservationCommandOutput) => void ): void; - public describeReservation( + describeReservation( args: DescribeReservationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReservationCommandOutput) => void ): void; - public describeReservation( - args: DescribeReservationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReservationCommandOutput) => void), - cb?: (err: any, data?: DescribeReservationCommandOutput) => void - ): Promise | void { - const command = new DescribeReservationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Grants entitlements to an existing flow. + * @see {@link GrantFlowEntitlementsCommand} */ - public grantFlowEntitlements( + grantFlowEntitlements( args: GrantFlowEntitlementsCommandInput, options?: __HttpHandlerOptions ): Promise; - public grantFlowEntitlements( + grantFlowEntitlements( args: GrantFlowEntitlementsCommandInput, cb: (err: any, data?: GrantFlowEntitlementsCommandOutput) => void ): void; - public grantFlowEntitlements( + grantFlowEntitlements( args: GrantFlowEntitlementsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GrantFlowEntitlementsCommandOutput) => void ): void; - public grantFlowEntitlements( - args: GrantFlowEntitlementsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GrantFlowEntitlementsCommandOutput) => void), - cb?: (err: any, data?: GrantFlowEntitlementsCommandOutput) => void - ): Promise | void { - const command = new GrantFlowEntitlementsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Displays a list of bridges that are associated with this account and an optionally specified Arn. This request returns a paginated result. + * @see {@link ListBridgesCommand} */ - public listBridges(args: ListBridgesCommandInput, options?: __HttpHandlerOptions): Promise; - public listBridges(args: ListBridgesCommandInput, cb: (err: any, data?: ListBridgesCommandOutput) => void): void; - public listBridges( + listBridges(args: ListBridgesCommandInput, options?: __HttpHandlerOptions): Promise; + listBridges(args: ListBridgesCommandInput, cb: (err: any, data?: ListBridgesCommandOutput) => void): void; + listBridges( args: ListBridgesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBridgesCommandOutput) => void ): void; - public listBridges( - args: ListBridgesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBridgesCommandOutput) => void), - cb?: (err: any, data?: ListBridgesCommandOutput) => void - ): Promise | void { - const command = new ListBridgesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page. + * @see {@link ListEntitlementsCommand} */ - public listEntitlements( + listEntitlements( args: ListEntitlementsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEntitlements( + listEntitlements( args: ListEntitlementsCommandInput, cb: (err: any, data?: ListEntitlementsCommandOutput) => void ): void; - public listEntitlements( + listEntitlements( args: ListEntitlementsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEntitlementsCommandOutput) => void ): void; - public listEntitlements( - args: ListEntitlementsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEntitlementsCommandOutput) => void), - cb?: (err: any, data?: ListEntitlementsCommandOutput) => void - ): Promise | void { - const command = new ListEntitlementsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Displays a list of flows that are associated with this account. This request returns a paginated result. + * @see {@link ListFlowsCommand} */ - public listFlows(args: ListFlowsCommandInput, options?: __HttpHandlerOptions): Promise; - public listFlows(args: ListFlowsCommandInput, cb: (err: any, data?: ListFlowsCommandOutput) => void): void; - public listFlows( + listFlows(args: ListFlowsCommandInput, options?: __HttpHandlerOptions): Promise; + listFlows(args: ListFlowsCommandInput, cb: (err: any, data?: ListFlowsCommandOutput) => void): void; + listFlows( args: ListFlowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFlowsCommandOutput) => void ): void; - public listFlows( - args: ListFlowsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFlowsCommandOutput) => void), - cb?: (err: any, data?: ListFlowsCommandOutput) => void - ): Promise | void { - const command = new ListFlowsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Displays a list of instances associated with the AWS account. This request returns a paginated result. You can use the filterArn property to display only the instances associated with the selected Gateway Amazon Resource Name (ARN). + * @see {@link ListGatewayInstancesCommand} */ - public listGatewayInstances( + listGatewayInstances( args: ListGatewayInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGatewayInstances( + listGatewayInstances( args: ListGatewayInstancesCommandInput, cb: (err: any, data?: ListGatewayInstancesCommandOutput) => void ): void; - public listGatewayInstances( + listGatewayInstances( args: ListGatewayInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGatewayInstancesCommandOutput) => void ): void; - public listGatewayInstances( - args: ListGatewayInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGatewayInstancesCommandOutput) => void), - cb?: (err: any, data?: ListGatewayInstancesCommandOutput) => void - ): Promise | void { - const command = new ListGatewayInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Displays a list of gateways that are associated with this account. This request returns a paginated result. + * @see {@link ListGatewaysCommand} */ - public listGateways( - args: ListGatewaysCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listGateways(args: ListGatewaysCommandInput, cb: (err: any, data?: ListGatewaysCommandOutput) => void): void; - public listGateways( + listGateways(args: ListGatewaysCommandInput, options?: __HttpHandlerOptions): Promise; + listGateways(args: ListGatewaysCommandInput, cb: (err: any, data?: ListGatewaysCommandOutput) => void): void; + listGateways( args: ListGatewaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGatewaysCommandOutput) => void ): void; - public listGateways( - args: ListGatewaysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGatewaysCommandOutput) => void), - cb?: (err: any, data?: ListGatewaysCommandOutput) => void - ): Promise | void { - const command = new ListGatewaysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Displays a list of all offerings that are available to this account in the current AWS Region. If you have an active reservation (which means you've purchased an offering that has already started and hasn't expired yet), your account isn't eligible for other offerings. + * @see {@link ListOfferingsCommand} */ - public listOfferings( - args: ListOfferingsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listOfferings( - args: ListOfferingsCommandInput, - cb: (err: any, data?: ListOfferingsCommandOutput) => void - ): void; - public listOfferings( + listOfferings(args: ListOfferingsCommandInput, options?: __HttpHandlerOptions): Promise; + listOfferings(args: ListOfferingsCommandInput, cb: (err: any, data?: ListOfferingsCommandOutput) => void): void; + listOfferings( args: ListOfferingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOfferingsCommandOutput) => void ): void; - public listOfferings( - args: ListOfferingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOfferingsCommandOutput) => void), - cb?: (err: any, data?: ListOfferingsCommandOutput) => void - ): Promise | void { - const command = new ListOfferingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Displays a list of all reservations that have been purchased by this account in the current AWS Region. This list includes all reservations in all states (such as active and expired). + * @see {@link ListReservationsCommand} */ - public listReservations( + listReservations( args: ListReservationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReservations( + listReservations( args: ListReservationsCommandInput, cb: (err: any, data?: ListReservationsCommandOutput) => void ): void; - public listReservations( + listReservations( args: ListReservationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReservationsCommandOutput) => void ): void; - public listReservations( - args: ListReservationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReservationsCommandOutput) => void), - cb?: (err: any, data?: ListReservationsCommandOutput) => void - ): Promise | void { - const command = new ListReservationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * List all tags on an AWS Elemental MediaConnect resource + * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Submits a request to purchase an offering. If you already have an active reservation, you can't purchase another offering. + * @see {@link PurchaseOfferingCommand} */ - public purchaseOffering( + purchaseOffering( args: PurchaseOfferingCommandInput, options?: __HttpHandlerOptions ): Promise; - public purchaseOffering( + purchaseOffering( args: PurchaseOfferingCommandInput, cb: (err: any, data?: PurchaseOfferingCommandOutput) => void ): void; - public purchaseOffering( + purchaseOffering( args: PurchaseOfferingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PurchaseOfferingCommandOutput) => void ): void; - public purchaseOffering( - args: PurchaseOfferingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PurchaseOfferingCommandOutput) => void), - cb?: (err: any, data?: PurchaseOfferingCommandOutput) => void - ): Promise | void { - const command = new PurchaseOfferingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Removes an output from a bridge. + * @see {@link RemoveBridgeOutputCommand} */ - public removeBridgeOutput( + removeBridgeOutput( args: RemoveBridgeOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeBridgeOutput( + removeBridgeOutput( args: RemoveBridgeOutputCommandInput, cb: (err: any, data?: RemoveBridgeOutputCommandOutput) => void ): void; - public removeBridgeOutput( + removeBridgeOutput( args: RemoveBridgeOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveBridgeOutputCommandOutput) => void ): void; - public removeBridgeOutput( - args: RemoveBridgeOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveBridgeOutputCommandOutput) => void), - cb?: (err: any, data?: RemoveBridgeOutputCommandOutput) => void - ): Promise | void { - const command = new RemoveBridgeOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Removes a source from a bridge. + * @see {@link RemoveBridgeSourceCommand} */ - public removeBridgeSource( + removeBridgeSource( args: RemoveBridgeSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeBridgeSource( + removeBridgeSource( args: RemoveBridgeSourceCommandInput, cb: (err: any, data?: RemoveBridgeSourceCommandOutput) => void ): void; - public removeBridgeSource( + removeBridgeSource( args: RemoveBridgeSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveBridgeSourceCommandOutput) => void ): void; - public removeBridgeSource( - args: RemoveBridgeSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveBridgeSourceCommandOutput) => void), - cb?: (err: any, data?: RemoveBridgeSourceCommandOutput) => void - ): Promise | void { - const command = new RemoveBridgeSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Removes a media stream from a flow. This action is only available if the media stream is not associated with a source or output. + * @see {@link RemoveFlowMediaStreamCommand} */ - public removeFlowMediaStream( + removeFlowMediaStream( args: RemoveFlowMediaStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeFlowMediaStream( + removeFlowMediaStream( args: RemoveFlowMediaStreamCommandInput, cb: (err: any, data?: RemoveFlowMediaStreamCommandOutput) => void ): void; - public removeFlowMediaStream( + removeFlowMediaStream( args: RemoveFlowMediaStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveFlowMediaStreamCommandOutput) => void ): void; - public removeFlowMediaStream( - args: RemoveFlowMediaStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveFlowMediaStreamCommandOutput) => void), - cb?: (err: any, data?: RemoveFlowMediaStreamCommandOutput) => void - ): Promise | void { - const command = new RemoveFlowMediaStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Removes an output from an existing flow. This request can be made only on an output that does not have an entitlement associated with it. If the output has an entitlement, you must revoke the entitlement instead. When an entitlement is revoked from a flow, the service automatically removes the associated output. + * @see {@link RemoveFlowOutputCommand} */ - public removeFlowOutput( + removeFlowOutput( args: RemoveFlowOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeFlowOutput( + removeFlowOutput( args: RemoveFlowOutputCommandInput, cb: (err: any, data?: RemoveFlowOutputCommandOutput) => void ): void; - public removeFlowOutput( + removeFlowOutput( args: RemoveFlowOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveFlowOutputCommandOutput) => void ): void; - public removeFlowOutput( - args: RemoveFlowOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveFlowOutputCommandOutput) => void), - cb?: (err: any, data?: RemoveFlowOutputCommandOutput) => void - ): Promise | void { - const command = new RemoveFlowOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Removes a source from an existing flow. This request can be made only if there is more than one source on the flow. + * @see {@link RemoveFlowSourceCommand} */ - public removeFlowSource( + removeFlowSource( args: RemoveFlowSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeFlowSource( + removeFlowSource( args: RemoveFlowSourceCommandInput, cb: (err: any, data?: RemoveFlowSourceCommandOutput) => void ): void; - public removeFlowSource( + removeFlowSource( args: RemoveFlowSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveFlowSourceCommandOutput) => void ): void; - public removeFlowSource( - args: RemoveFlowSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveFlowSourceCommandOutput) => void), - cb?: (err: any, data?: RemoveFlowSourceCommandOutput) => void - ): Promise | void { - const command = new RemoveFlowSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Removes a VPC Interface from an existing flow. This request can be made only on a VPC interface that does not have a Source or Output associated with it. If the VPC interface is referenced by a Source or Output, you must first delete or update the Source or Output to no longer reference the VPC interface. + * @see {@link RemoveFlowVpcInterfaceCommand} */ - public removeFlowVpcInterface( + removeFlowVpcInterface( args: RemoveFlowVpcInterfaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeFlowVpcInterface( + removeFlowVpcInterface( args: RemoveFlowVpcInterfaceCommandInput, cb: (err: any, data?: RemoveFlowVpcInterfaceCommandOutput) => void ): void; - public removeFlowVpcInterface( + removeFlowVpcInterface( args: RemoveFlowVpcInterfaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveFlowVpcInterfaceCommandOutput) => void ): void; - public removeFlowVpcInterface( - args: RemoveFlowVpcInterfaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveFlowVpcInterfaceCommandOutput) => void), - cb?: (err: any, data?: RemoveFlowVpcInterfaceCommandOutput) => void - ): Promise | void { - const command = new RemoveFlowVpcInterfaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed. + * @see {@link RevokeFlowEntitlementCommand} */ - public revokeFlowEntitlement( + revokeFlowEntitlement( args: RevokeFlowEntitlementCommandInput, options?: __HttpHandlerOptions ): Promise; - public revokeFlowEntitlement( + revokeFlowEntitlement( args: RevokeFlowEntitlementCommandInput, cb: (err: any, data?: RevokeFlowEntitlementCommandOutput) => void ): void; - public revokeFlowEntitlement( + revokeFlowEntitlement( args: RevokeFlowEntitlementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeFlowEntitlementCommandOutput) => void ): void; - public revokeFlowEntitlement( - args: RevokeFlowEntitlementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RevokeFlowEntitlementCommandOutput) => void), - cb?: (err: any, data?: RevokeFlowEntitlementCommandOutput) => void - ): Promise | void { - const command = new RevokeFlowEntitlementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Starts a flow. + * @see {@link StartFlowCommand} */ - public startFlow(args: StartFlowCommandInput, options?: __HttpHandlerOptions): Promise; - public startFlow(args: StartFlowCommandInput, cb: (err: any, data?: StartFlowCommandOutput) => void): void; - public startFlow( + startFlow(args: StartFlowCommandInput, options?: __HttpHandlerOptions): Promise; + startFlow(args: StartFlowCommandInput, cb: (err: any, data?: StartFlowCommandOutput) => void): void; + startFlow( args: StartFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFlowCommandOutput) => void ): void; - public startFlow( - args: StartFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartFlowCommandOutput) => void), - cb?: (err: any, data?: StartFlowCommandOutput) => void - ): Promise | void { - const command = new StartFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Stops a flow. + * @see {@link StopFlowCommand} */ - public stopFlow(args: StopFlowCommandInput, options?: __HttpHandlerOptions): Promise; - public stopFlow(args: StopFlowCommandInput, cb: (err: any, data?: StopFlowCommandOutput) => void): void; - public stopFlow( + stopFlow(args: StopFlowCommandInput, options?: __HttpHandlerOptions): Promise; + stopFlow(args: StopFlowCommandInput, cb: (err: any, data?: StopFlowCommandOutput) => void): void; + stopFlow( args: StopFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopFlowCommandOutput) => void ): void; - public stopFlow( - args: StopFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopFlowCommandOutput) => void), - cb?: (err: any, data?: StopFlowCommandOutput) => void - ): Promise | void { - const command = new StopFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. + * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Deletes specified tags from a resource. + * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Updates the bridge + * @see {@link UpdateBridgeCommand} */ - public updateBridge( - args: UpdateBridgeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateBridge(args: UpdateBridgeCommandInput, cb: (err: any, data?: UpdateBridgeCommandOutput) => void): void; - public updateBridge( + updateBridge(args: UpdateBridgeCommandInput, options?: __HttpHandlerOptions): Promise; + updateBridge(args: UpdateBridgeCommandInput, cb: (err: any, data?: UpdateBridgeCommandOutput) => void): void; + updateBridge( args: UpdateBridgeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBridgeCommandOutput) => void ): void; - public updateBridge( - args: UpdateBridgeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBridgeCommandOutput) => void), - cb?: (err: any, data?: UpdateBridgeCommandOutput) => void - ): Promise | void { - const command = new UpdateBridgeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Updates an existing bridge output. + * @see {@link UpdateBridgeOutputCommand} */ - public updateBridgeOutput( + updateBridgeOutput( args: UpdateBridgeOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBridgeOutput( + updateBridgeOutput( args: UpdateBridgeOutputCommandInput, cb: (err: any, data?: UpdateBridgeOutputCommandOutput) => void ): void; - public updateBridgeOutput( + updateBridgeOutput( args: UpdateBridgeOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBridgeOutputCommandOutput) => void ): void; - public updateBridgeOutput( - args: UpdateBridgeOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBridgeOutputCommandOutput) => void), - cb?: (err: any, data?: UpdateBridgeOutputCommandOutput) => void - ): Promise | void { - const command = new UpdateBridgeOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Updates an existing bridge source. + * @see {@link UpdateBridgeSourceCommand} */ - public updateBridgeSource( + updateBridgeSource( args: UpdateBridgeSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBridgeSource( + updateBridgeSource( args: UpdateBridgeSourceCommandInput, cb: (err: any, data?: UpdateBridgeSourceCommandOutput) => void ): void; - public updateBridgeSource( + updateBridgeSource( args: UpdateBridgeSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBridgeSourceCommandOutput) => void ): void; - public updateBridgeSource( - args: UpdateBridgeSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBridgeSourceCommandOutput) => void), - cb?: (err: any, data?: UpdateBridgeSourceCommandOutput) => void - ): Promise | void { - const command = new UpdateBridgeSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Updates the bridge state + * @see {@link UpdateBridgeStateCommand} */ - public updateBridgeState( + updateBridgeState( args: UpdateBridgeStateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBridgeState( + updateBridgeState( args: UpdateBridgeStateCommandInput, cb: (err: any, data?: UpdateBridgeStateCommandOutput) => void ): void; - public updateBridgeState( + updateBridgeState( args: UpdateBridgeStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBridgeStateCommandOutput) => void ): void; - public updateBridgeState( - args: UpdateBridgeStateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBridgeStateCommandOutput) => void), - cb?: (err: any, data?: UpdateBridgeStateCommandOutput) => void - ): Promise | void { - const command = new UpdateBridgeStateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Updates flow + * @see {@link UpdateFlowCommand} */ - public updateFlow(args: UpdateFlowCommandInput, options?: __HttpHandlerOptions): Promise; - public updateFlow(args: UpdateFlowCommandInput, cb: (err: any, data?: UpdateFlowCommandOutput) => void): void; - public updateFlow( + updateFlow(args: UpdateFlowCommandInput, options?: __HttpHandlerOptions): Promise; + updateFlow(args: UpdateFlowCommandInput, cb: (err: any, data?: UpdateFlowCommandOutput) => void): void; + updateFlow( args: UpdateFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFlowCommandOutput) => void ): void; - public updateFlow( - args: UpdateFlowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFlowCommandOutput) => void), - cb?: (err: any, data?: UpdateFlowCommandOutput) => void - ): Promise | void { - const command = new UpdateFlowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * You can change an entitlement's description, subscribers, and encryption. If you change the subscribers, the service will remove the outputs that are are used by the subscribers that are removed. + * @see {@link UpdateFlowEntitlementCommand} */ - public updateFlowEntitlement( + updateFlowEntitlement( args: UpdateFlowEntitlementCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFlowEntitlement( + updateFlowEntitlement( args: UpdateFlowEntitlementCommandInput, cb: (err: any, data?: UpdateFlowEntitlementCommandOutput) => void ): void; - public updateFlowEntitlement( + updateFlowEntitlement( args: UpdateFlowEntitlementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFlowEntitlementCommandOutput) => void ): void; - public updateFlowEntitlement( - args: UpdateFlowEntitlementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFlowEntitlementCommandOutput) => void), - cb?: (err: any, data?: UpdateFlowEntitlementCommandOutput) => void - ): Promise | void { - const command = new UpdateFlowEntitlementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Updates an existing media stream. + * @see {@link UpdateFlowMediaStreamCommand} */ - public updateFlowMediaStream( + updateFlowMediaStream( args: UpdateFlowMediaStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFlowMediaStream( + updateFlowMediaStream( args: UpdateFlowMediaStreamCommandInput, cb: (err: any, data?: UpdateFlowMediaStreamCommandOutput) => void ): void; - public updateFlowMediaStream( + updateFlowMediaStream( args: UpdateFlowMediaStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFlowMediaStreamCommandOutput) => void ): void; - public updateFlowMediaStream( - args: UpdateFlowMediaStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFlowMediaStreamCommandOutput) => void), - cb?: (err: any, data?: UpdateFlowMediaStreamCommandOutput) => void - ): Promise | void { - const command = new UpdateFlowMediaStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Updates an existing flow output. + * @see {@link UpdateFlowOutputCommand} */ - public updateFlowOutput( + updateFlowOutput( args: UpdateFlowOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFlowOutput( + updateFlowOutput( args: UpdateFlowOutputCommandInput, cb: (err: any, data?: UpdateFlowOutputCommandOutput) => void ): void; - public updateFlowOutput( + updateFlowOutput( args: UpdateFlowOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFlowOutputCommandOutput) => void ): void; - public updateFlowOutput( - args: UpdateFlowOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFlowOutputCommandOutput) => void), - cb?: (err: any, data?: UpdateFlowOutputCommandOutput) => void - ): Promise | void { - const command = new UpdateFlowOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Updates the source of a flow. + * @see {@link UpdateFlowSourceCommand} */ - public updateFlowSource( + updateFlowSource( args: UpdateFlowSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFlowSource( + updateFlowSource( args: UpdateFlowSourceCommandInput, cb: (err: any, data?: UpdateFlowSourceCommandOutput) => void ): void; - public updateFlowSource( + updateFlowSource( args: UpdateFlowSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFlowSourceCommandOutput) => void ): void; - public updateFlowSource( - args: UpdateFlowSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFlowSourceCommandOutput) => void), - cb?: (err: any, data?: UpdateFlowSourceCommandOutput) => void - ): Promise | void { - const command = new UpdateFlowSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Updates the configuration of an existing Gateway Instance. + * @see {@link UpdateGatewayInstanceCommand} */ - public updateGatewayInstance( + updateGatewayInstance( args: UpdateGatewayInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGatewayInstance( + updateGatewayInstance( args: UpdateGatewayInstanceCommandInput, cb: (err: any, data?: UpdateGatewayInstanceCommandOutput) => void ): void; - public updateGatewayInstance( + updateGatewayInstance( args: UpdateGatewayInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGatewayInstanceCommandOutput) => void ): void; - public updateGatewayInstance( - args: UpdateGatewayInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGatewayInstanceCommandOutput) => void), - cb?: (err: any, data?: UpdateGatewayInstanceCommandOutput) => void - ): Promise | void { - const command = new UpdateGatewayInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * API for AWS Elemental MediaConnect + */ +export class MediaConnect extends MediaConnectClient implements MediaConnect {} +createAggregatedClient(commands, MediaConnect); diff --git a/clients/client-mediaconvert/src/MediaConvert.ts b/clients/client-mediaconvert/src/MediaConvert.ts index 49316316b3c1..e65fe8ce954d 100644 --- a/clients/client-mediaconvert/src/MediaConvert.ts +++ b/clients/client-mediaconvert/src/MediaConvert.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -85,838 +86,403 @@ import { UpdatePresetCommandOutput, } from "./commands/UpdatePresetCommand"; import { UpdateQueueCommand, UpdateQueueCommandInput, UpdateQueueCommandOutput } from "./commands/UpdateQueueCommand"; -import { MediaConvertClient } from "./MediaConvertClient"; +import { MediaConvertClient, MediaConvertClientConfig } from "./MediaConvertClient"; -/** - * @public - * AWS Elemental MediaConvert - */ -export class MediaConvert extends MediaConvertClient { +const commands = { + AssociateCertificateCommand, + CancelJobCommand, + CreateJobCommand, + CreateJobTemplateCommand, + CreatePresetCommand, + CreateQueueCommand, + DeleteJobTemplateCommand, + DeletePolicyCommand, + DeletePresetCommand, + DeleteQueueCommand, + DescribeEndpointsCommand, + DisassociateCertificateCommand, + GetJobCommand, + GetJobTemplateCommand, + GetPolicyCommand, + GetPresetCommand, + GetQueueCommand, + ListJobsCommand, + ListJobTemplatesCommand, + ListPresetsCommand, + ListQueuesCommand, + ListTagsForResourceCommand, + PutPolicyCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateJobTemplateCommand, + UpdatePresetCommand, + UpdateQueueCommand, +}; + +export interface MediaConvert { /** - * @public - * Associates an AWS Certificate Manager (ACM) Amazon Resource Name (ARN) with AWS Elemental MediaConvert. + * @see {@link AssociateCertificateCommand} */ - public associateCertificate( + associateCertificate( args: AssociateCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateCertificate( + associateCertificate( args: AssociateCertificateCommandInput, cb: (err: any, data?: AssociateCertificateCommandOutput) => void ): void; - public associateCertificate( + associateCertificate( args: AssociateCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateCertificateCommandOutput) => void ): void; - public associateCertificate( - args: AssociateCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateCertificateCommandOutput) => void), - cb?: (err: any, data?: AssociateCertificateCommandOutput) => void - ): Promise | void { - const command = new AssociateCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Permanently cancel a job. Once you have canceled a job, you can't start it again. + * @see {@link CancelJobCommand} */ - public cancelJob(args: CancelJobCommandInput, options?: __HttpHandlerOptions): Promise; - public cancelJob(args: CancelJobCommandInput, cb: (err: any, data?: CancelJobCommandOutput) => void): void; - public cancelJob( + cancelJob(args: CancelJobCommandInput, options?: __HttpHandlerOptions): Promise; + cancelJob(args: CancelJobCommandInput, cb: (err: any, data?: CancelJobCommandOutput) => void): void; + cancelJob( args: CancelJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelJobCommandOutput) => void ): void; - public cancelJob( - args: CancelJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelJobCommandOutput) => void), - cb?: (err: any, data?: CancelJobCommandOutput) => void - ): Promise | void { - const command = new CancelJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Create a new transcoding job. For information about jobs and job settings, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html + * @see {@link CreateJobCommand} */ - public createJob(args: CreateJobCommandInput, options?: __HttpHandlerOptions): Promise; - public createJob(args: CreateJobCommandInput, cb: (err: any, data?: CreateJobCommandOutput) => void): void; - public createJob( + createJob(args: CreateJobCommandInput, options?: __HttpHandlerOptions): Promise; + createJob(args: CreateJobCommandInput, cb: (err: any, data?: CreateJobCommandOutput) => void): void; + createJob( args: CreateJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateJobCommandOutput) => void ): void; - public createJob( - args: CreateJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateJobCommandOutput) => void), - cb?: (err: any, data?: CreateJobCommandOutput) => void - ): Promise | void { - const command = new CreateJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Create a new job template. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html + * @see {@link CreateJobTemplateCommand} */ - public createJobTemplate( + createJobTemplate( args: CreateJobTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createJobTemplate( + createJobTemplate( args: CreateJobTemplateCommandInput, cb: (err: any, data?: CreateJobTemplateCommandOutput) => void ): void; - public createJobTemplate( + createJobTemplate( args: CreateJobTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateJobTemplateCommandOutput) => void ): void; - public createJobTemplate( - args: CreateJobTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateJobTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateJobTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateJobTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Create a new preset. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html + * @see {@link CreatePresetCommand} */ - public createPreset( - args: CreatePresetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createPreset(args: CreatePresetCommandInput, cb: (err: any, data?: CreatePresetCommandOutput) => void): void; - public createPreset( + createPreset(args: CreatePresetCommandInput, options?: __HttpHandlerOptions): Promise; + createPreset(args: CreatePresetCommandInput, cb: (err: any, data?: CreatePresetCommandOutput) => void): void; + createPreset( args: CreatePresetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePresetCommandOutput) => void ): void; - public createPreset( - args: CreatePresetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePresetCommandOutput) => void), - cb?: (err: any, data?: CreatePresetCommandOutput) => void - ): Promise | void { - const command = new CreatePresetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Create a new transcoding queue. For information about queues, see Working With Queues in the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html + * @see {@link CreateQueueCommand} */ - public createQueue(args: CreateQueueCommandInput, options?: __HttpHandlerOptions): Promise; - public createQueue(args: CreateQueueCommandInput, cb: (err: any, data?: CreateQueueCommandOutput) => void): void; - public createQueue( + createQueue(args: CreateQueueCommandInput, options?: __HttpHandlerOptions): Promise; + createQueue(args: CreateQueueCommandInput, cb: (err: any, data?: CreateQueueCommandOutput) => void): void; + createQueue( args: CreateQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateQueueCommandOutput) => void ): void; - public createQueue( - args: CreateQueueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateQueueCommandOutput) => void), - cb?: (err: any, data?: CreateQueueCommandOutput) => void - ): Promise | void { - const command = new CreateQueueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Permanently delete a job template you have created. + * @see {@link DeleteJobTemplateCommand} */ - public deleteJobTemplate( + deleteJobTemplate( args: DeleteJobTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteJobTemplate( + deleteJobTemplate( args: DeleteJobTemplateCommandInput, cb: (err: any, data?: DeleteJobTemplateCommandOutput) => void ): void; - public deleteJobTemplate( + deleteJobTemplate( args: DeleteJobTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteJobTemplateCommandOutput) => void ): void; - public deleteJobTemplate( - args: DeleteJobTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteJobTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteJobTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteJobTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Permanently delete a policy that you created. + * @see {@link DeletePolicyCommand} */ - public deletePolicy( - args: DeletePolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deletePolicy(args: DeletePolicyCommandInput, cb: (err: any, data?: DeletePolicyCommandOutput) => void): void; - public deletePolicy( + deletePolicy(args: DeletePolicyCommandInput, options?: __HttpHandlerOptions): Promise; + deletePolicy(args: DeletePolicyCommandInput, cb: (err: any, data?: DeletePolicyCommandOutput) => void): void; + deletePolicy( args: DeletePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePolicyCommandOutput) => void ): void; - public deletePolicy( - args: DeletePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePolicyCommandOutput) => void), - cb?: (err: any, data?: DeletePolicyCommandOutput) => void - ): Promise | void { - const command = new DeletePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Permanently delete a preset you have created. + * @see {@link DeletePresetCommand} */ - public deletePreset( - args: DeletePresetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deletePreset(args: DeletePresetCommandInput, cb: (err: any, data?: DeletePresetCommandOutput) => void): void; - public deletePreset( + deletePreset(args: DeletePresetCommandInput, options?: __HttpHandlerOptions): Promise; + deletePreset(args: DeletePresetCommandInput, cb: (err: any, data?: DeletePresetCommandOutput) => void): void; + deletePreset( args: DeletePresetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePresetCommandOutput) => void ): void; - public deletePreset( - args: DeletePresetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePresetCommandOutput) => void), - cb?: (err: any, data?: DeletePresetCommandOutput) => void - ): Promise | void { - const command = new DeletePresetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Permanently delete a queue you have created. + * @see {@link DeleteQueueCommand} */ - public deleteQueue(args: DeleteQueueCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteQueue(args: DeleteQueueCommandInput, cb: (err: any, data?: DeleteQueueCommandOutput) => void): void; - public deleteQueue( + deleteQueue(args: DeleteQueueCommandInput, options?: __HttpHandlerOptions): Promise; + deleteQueue(args: DeleteQueueCommandInput, cb: (err: any, data?: DeleteQueueCommandOutput) => void): void; + deleteQueue( args: DeleteQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteQueueCommandOutput) => void ): void; - public deleteQueue( - args: DeleteQueueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteQueueCommandOutput) => void), - cb?: (err: any, data?: DeleteQueueCommandOutput) => void - ): Promise | void { - const command = new DeleteQueueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Send an request with an empty body to the regional API endpoint to get your account API endpoint. + * @see {@link DescribeEndpointsCommand} */ - public describeEndpoints( + describeEndpoints( args: DescribeEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEndpoints( + describeEndpoints( args: DescribeEndpointsCommandInput, cb: (err: any, data?: DescribeEndpointsCommandOutput) => void ): void; - public describeEndpoints( + describeEndpoints( args: DescribeEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEndpointsCommandOutput) => void ): void; - public describeEndpoints( - args: DescribeEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEndpointsCommandOutput) => void), - cb?: (err: any, data?: DescribeEndpointsCommandOutput) => void - ): Promise | void { - const command = new DescribeEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Removes an association between the Amazon Resource Name (ARN) of an AWS Certificate Manager (ACM) certificate and an AWS Elemental MediaConvert resource. + * @see {@link DisassociateCertificateCommand} */ - public disassociateCertificate( + disassociateCertificate( args: DisassociateCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateCertificate( + disassociateCertificate( args: DisassociateCertificateCommandInput, cb: (err: any, data?: DisassociateCertificateCommandOutput) => void ): void; - public disassociateCertificate( + disassociateCertificate( args: DisassociateCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateCertificateCommandOutput) => void ): void; - public disassociateCertificate( - args: DisassociateCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateCertificateCommandOutput) => void), - cb?: (err: any, data?: DisassociateCertificateCommandOutput) => void - ): Promise | void { - const command = new DisassociateCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Retrieve the JSON for a specific completed transcoding job. + * @see {@link GetJobCommand} */ - public getJob(args: GetJobCommandInput, options?: __HttpHandlerOptions): Promise; - public getJob(args: GetJobCommandInput, cb: (err: any, data?: GetJobCommandOutput) => void): void; - public getJob( + getJob(args: GetJobCommandInput, options?: __HttpHandlerOptions): Promise; + getJob(args: GetJobCommandInput, cb: (err: any, data?: GetJobCommandOutput) => void): void; + getJob( args: GetJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobCommandOutput) => void ): void; - public getJob( - args: GetJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetJobCommandOutput) => void), - cb?: (err: any, data?: GetJobCommandOutput) => void - ): Promise | void { - const command = new GetJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Retrieve the JSON for a specific job template. + * @see {@link GetJobTemplateCommand} */ - public getJobTemplate( + getJobTemplate( args: GetJobTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getJobTemplate( - args: GetJobTemplateCommandInput, - cb: (err: any, data?: GetJobTemplateCommandOutput) => void - ): void; - public getJobTemplate( + getJobTemplate(args: GetJobTemplateCommandInput, cb: (err: any, data?: GetJobTemplateCommandOutput) => void): void; + getJobTemplate( args: GetJobTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobTemplateCommandOutput) => void ): void; - public getJobTemplate( - args: GetJobTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetJobTemplateCommandOutput) => void), - cb?: (err: any, data?: GetJobTemplateCommandOutput) => void - ): Promise | void { - const command = new GetJobTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Retrieve the JSON for your policy. + * @see {@link GetPolicyCommand} */ - public getPolicy(args: GetPolicyCommandInput, options?: __HttpHandlerOptions): Promise; - public getPolicy(args: GetPolicyCommandInput, cb: (err: any, data?: GetPolicyCommandOutput) => void): void; - public getPolicy( + getPolicy(args: GetPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + getPolicy(args: GetPolicyCommandInput, cb: (err: any, data?: GetPolicyCommandOutput) => void): void; + getPolicy( args: GetPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPolicyCommandOutput) => void ): void; - public getPolicy( - args: GetPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPolicyCommandOutput) => void), - cb?: (err: any, data?: GetPolicyCommandOutput) => void - ): Promise | void { - const command = new GetPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Retrieve the JSON for a specific preset. + * @see {@link GetPresetCommand} */ - public getPreset(args: GetPresetCommandInput, options?: __HttpHandlerOptions): Promise; - public getPreset(args: GetPresetCommandInput, cb: (err: any, data?: GetPresetCommandOutput) => void): void; - public getPreset( + getPreset(args: GetPresetCommandInput, options?: __HttpHandlerOptions): Promise; + getPreset(args: GetPresetCommandInput, cb: (err: any, data?: GetPresetCommandOutput) => void): void; + getPreset( args: GetPresetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPresetCommandOutput) => void ): void; - public getPreset( - args: GetPresetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPresetCommandOutput) => void), - cb?: (err: any, data?: GetPresetCommandOutput) => void - ): Promise | void { - const command = new GetPresetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Retrieve the JSON for a specific queue. + * @see {@link GetQueueCommand} */ - public getQueue(args: GetQueueCommandInput, options?: __HttpHandlerOptions): Promise; - public getQueue(args: GetQueueCommandInput, cb: (err: any, data?: GetQueueCommandOutput) => void): void; - public getQueue( + getQueue(args: GetQueueCommandInput, options?: __HttpHandlerOptions): Promise; + getQueue(args: GetQueueCommandInput, cb: (err: any, data?: GetQueueCommandOutput) => void): void; + getQueue( args: GetQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueueCommandOutput) => void ): void; - public getQueue( - args: GetQueueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetQueueCommandOutput) => void), - cb?: (err: any, data?: GetQueueCommandOutput) => void - ): Promise | void { - const command = new GetQueueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Retrieve a JSON array of up to twenty of your most recently created jobs. This array includes in-process, completed, and errored jobs. This will return the jobs themselves, not just a list of the jobs. To retrieve the twenty next most recent jobs, use the nextToken string returned with the array. + * @see {@link ListJobsCommand} */ - public listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise; - public listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void; - public listJobs( + listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise; + listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void; + listJobs( args: ListJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobsCommandOutput) => void ): void; - public listJobs( - args: ListJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJobsCommandOutput) => void), - cb?: (err: any, data?: ListJobsCommandOutput) => void - ): Promise | void { - const command = new ListJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Retrieve a JSON array of up to twenty of your job templates. This will return the templates themselves, not just a list of them. To retrieve the next twenty templates, use the nextToken string returned with the array + * @see {@link ListJobTemplatesCommand} */ - public listJobTemplates( + listJobTemplates( args: ListJobTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listJobTemplates( + listJobTemplates( args: ListJobTemplatesCommandInput, cb: (err: any, data?: ListJobTemplatesCommandOutput) => void ): void; - public listJobTemplates( + listJobTemplates( args: ListJobTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobTemplatesCommandOutput) => void ): void; - public listJobTemplates( - args: ListJobTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJobTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListJobTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListJobTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Retrieve a JSON array of up to twenty of your presets. This will return the presets themselves, not just a list of them. To retrieve the next twenty presets, use the nextToken string returned with the array. + * @see {@link ListPresetsCommand} */ - public listPresets(args: ListPresetsCommandInput, options?: __HttpHandlerOptions): Promise; - public listPresets(args: ListPresetsCommandInput, cb: (err: any, data?: ListPresetsCommandOutput) => void): void; - public listPresets( + listPresets(args: ListPresetsCommandInput, options?: __HttpHandlerOptions): Promise; + listPresets(args: ListPresetsCommandInput, cb: (err: any, data?: ListPresetsCommandOutput) => void): void; + listPresets( args: ListPresetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPresetsCommandOutput) => void ): void; - public listPresets( - args: ListPresetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPresetsCommandOutput) => void), - cb?: (err: any, data?: ListPresetsCommandOutput) => void - ): Promise | void { - const command = new ListPresetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Retrieve a JSON array of up to twenty of your queues. This will return the queues themselves, not just a list of them. To retrieve the next twenty queues, use the nextToken string returned with the array. + * @see {@link ListQueuesCommand} */ - public listQueues(args: ListQueuesCommandInput, options?: __HttpHandlerOptions): Promise; - public listQueues(args: ListQueuesCommandInput, cb: (err: any, data?: ListQueuesCommandOutput) => void): void; - public listQueues( + listQueues(args: ListQueuesCommandInput, options?: __HttpHandlerOptions): Promise; + listQueues(args: ListQueuesCommandInput, cb: (err: any, data?: ListQueuesCommandOutput) => void): void; + listQueues( args: ListQueuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQueuesCommandOutput) => void ): void; - public listQueues( - args: ListQueuesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListQueuesCommandOutput) => void), - cb?: (err: any, data?: ListQueuesCommandOutput) => void - ): Promise | void { - const command = new ListQueuesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Retrieve the tags for a MediaConvert resource. + * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Create or change your policy. For more information about policies, see the user guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html + * @see {@link PutPolicyCommand} */ - public putPolicy(args: PutPolicyCommandInput, options?: __HttpHandlerOptions): Promise; - public putPolicy(args: PutPolicyCommandInput, cb: (err: any, data?: PutPolicyCommandOutput) => void): void; - public putPolicy( + putPolicy(args: PutPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + putPolicy(args: PutPolicyCommandInput, cb: (err: any, data?: PutPolicyCommandOutput) => void): void; + putPolicy( args: PutPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPolicyCommandOutput) => void ): void; - public putPolicy( - args: PutPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutPolicyCommandOutput) => void), - cb?: (err: any, data?: PutPolicyCommandOutput) => void - ): Promise | void { - const command = new PutPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Add tags to a MediaConvert queue, preset, or job template. For information about tagging, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-resources.html + * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Remove tags from a MediaConvert queue, preset, or job template. For information about tagging, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-resources.html + * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Modify one of your existing job templates. + * @see {@link UpdateJobTemplateCommand} */ - public updateJobTemplate( + updateJobTemplate( args: UpdateJobTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateJobTemplate( + updateJobTemplate( args: UpdateJobTemplateCommandInput, cb: (err: any, data?: UpdateJobTemplateCommandOutput) => void ): void; - public updateJobTemplate( + updateJobTemplate( args: UpdateJobTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateJobTemplateCommandOutput) => void ): void; - public updateJobTemplate( - args: UpdateJobTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateJobTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateJobTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateJobTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Modify one of your existing presets. + * @see {@link UpdatePresetCommand} */ - public updatePreset( - args: UpdatePresetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updatePreset(args: UpdatePresetCommandInput, cb: (err: any, data?: UpdatePresetCommandOutput) => void): void; - public updatePreset( + updatePreset(args: UpdatePresetCommandInput, options?: __HttpHandlerOptions): Promise; + updatePreset(args: UpdatePresetCommandInput, cb: (err: any, data?: UpdatePresetCommandOutput) => void): void; + updatePreset( args: UpdatePresetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePresetCommandOutput) => void ): void; - public updatePreset( - args: UpdatePresetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePresetCommandOutput) => void), - cb?: (err: any, data?: UpdatePresetCommandOutput) => void - ): Promise | void { - const command = new UpdatePresetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Modify one of your existing queues. + * @see {@link UpdateQueueCommand} */ - public updateQueue(args: UpdateQueueCommandInput, options?: __HttpHandlerOptions): Promise; - public updateQueue(args: UpdateQueueCommandInput, cb: (err: any, data?: UpdateQueueCommandOutput) => void): void; - public updateQueue( + updateQueue(args: UpdateQueueCommandInput, options?: __HttpHandlerOptions): Promise; + updateQueue(args: UpdateQueueCommandInput, cb: (err: any, data?: UpdateQueueCommandOutput) => void): void; + updateQueue( args: UpdateQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateQueueCommandOutput) => void ): void; - public updateQueue( - args: UpdateQueueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateQueueCommandOutput) => void), - cb?: (err: any, data?: UpdateQueueCommandOutput) => void - ): Promise | void { - const command = new UpdateQueueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * AWS Elemental MediaConvert + */ +export class MediaConvert extends MediaConvertClient implements MediaConvert {} +createAggregatedClient(commands, MediaConvert); diff --git a/clients/client-medialive/src/MediaLive.ts b/clients/client-medialive/src/MediaLive.ts index 0a77dbf7fbae..b3b1cb743936 100644 --- a/clients/client-medialive/src/MediaLive.ts +++ b/clients/client-medialive/src/MediaLive.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -252,1885 +253,943 @@ import { UpdateReservationCommandInput, UpdateReservationCommandOutput, } from "./commands/UpdateReservationCommand"; -import { MediaLiveClient } from "./MediaLiveClient"; +import { MediaLiveClient, MediaLiveClientConfig } from "./MediaLiveClient"; -/** - * @public - * API for AWS Elemental MediaLive - */ -export class MediaLive extends MediaLiveClient { +const commands = { + AcceptInputDeviceTransferCommand, + BatchDeleteCommand, + BatchStartCommand, + BatchStopCommand, + BatchUpdateScheduleCommand, + CancelInputDeviceTransferCommand, + ClaimDeviceCommand, + CreateChannelCommand, + CreateInputCommand, + CreateInputSecurityGroupCommand, + CreateMultiplexCommand, + CreateMultiplexProgramCommand, + CreatePartnerInputCommand, + CreateTagsCommand, + DeleteChannelCommand, + DeleteInputCommand, + DeleteInputSecurityGroupCommand, + DeleteMultiplexCommand, + DeleteMultiplexProgramCommand, + DeleteReservationCommand, + DeleteScheduleCommand, + DeleteTagsCommand, + DescribeChannelCommand, + DescribeInputCommand, + DescribeInputDeviceCommand, + DescribeInputDeviceThumbnailCommand, + DescribeInputSecurityGroupCommand, + DescribeMultiplexCommand, + DescribeMultiplexProgramCommand, + DescribeOfferingCommand, + DescribeReservationCommand, + DescribeScheduleCommand, + ListChannelsCommand, + ListInputDevicesCommand, + ListInputDeviceTransfersCommand, + ListInputsCommand, + ListInputSecurityGroupsCommand, + ListMultiplexesCommand, + ListMultiplexProgramsCommand, + ListOfferingsCommand, + ListReservationsCommand, + ListTagsForResourceCommand, + PurchaseOfferingCommand, + RebootInputDeviceCommand, + RejectInputDeviceTransferCommand, + StartChannelCommand, + StartInputDeviceMaintenanceWindowCommand, + StartMultiplexCommand, + StopChannelCommand, + StopMultiplexCommand, + TransferInputDeviceCommand, + UpdateChannelCommand, + UpdateChannelClassCommand, + UpdateInputCommand, + UpdateInputDeviceCommand, + UpdateInputSecurityGroupCommand, + UpdateMultiplexCommand, + UpdateMultiplexProgramCommand, + UpdateReservationCommand, +}; + +export interface MediaLive { /** - * @public - * Accept an incoming input device transfer. The ownership of the device will transfer to your AWS account. + * @see {@link AcceptInputDeviceTransferCommand} */ - public acceptInputDeviceTransfer( + acceptInputDeviceTransfer( args: AcceptInputDeviceTransferCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptInputDeviceTransfer( + acceptInputDeviceTransfer( args: AcceptInputDeviceTransferCommandInput, cb: (err: any, data?: AcceptInputDeviceTransferCommandOutput) => void ): void; - public acceptInputDeviceTransfer( + acceptInputDeviceTransfer( args: AcceptInputDeviceTransferCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptInputDeviceTransferCommandOutput) => void ): void; - public acceptInputDeviceTransfer( - args: AcceptInputDeviceTransferCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptInputDeviceTransferCommandOutput) => void), - cb?: (err: any, data?: AcceptInputDeviceTransferCommandOutput) => void - ): Promise | void { - const command = new AcceptInputDeviceTransferCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Starts delete of resources. + * @see {@link BatchDeleteCommand} */ - public batchDelete(args: BatchDeleteCommandInput, options?: __HttpHandlerOptions): Promise; - public batchDelete(args: BatchDeleteCommandInput, cb: (err: any, data?: BatchDeleteCommandOutput) => void): void; - public batchDelete( + batchDelete(args: BatchDeleteCommandInput, options?: __HttpHandlerOptions): Promise; + batchDelete(args: BatchDeleteCommandInput, cb: (err: any, data?: BatchDeleteCommandOutput) => void): void; + batchDelete( args: BatchDeleteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteCommandOutput) => void ): void; - public batchDelete( - args: BatchDeleteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeleteCommandOutput) => void), - cb?: (err: any, data?: BatchDeleteCommandOutput) => void - ): Promise | void { - const command = new BatchDeleteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Starts existing resources + * @see {@link BatchStartCommand} */ - public batchStart(args: BatchStartCommandInput, options?: __HttpHandlerOptions): Promise; - public batchStart(args: BatchStartCommandInput, cb: (err: any, data?: BatchStartCommandOutput) => void): void; - public batchStart( + batchStart(args: BatchStartCommandInput, options?: __HttpHandlerOptions): Promise; + batchStart(args: BatchStartCommandInput, cb: (err: any, data?: BatchStartCommandOutput) => void): void; + batchStart( args: BatchStartCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchStartCommandOutput) => void ): void; - public batchStart( - args: BatchStartCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchStartCommandOutput) => void), - cb?: (err: any, data?: BatchStartCommandOutput) => void - ): Promise | void { - const command = new BatchStartCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Stops running resources + * @see {@link BatchStopCommand} */ - public batchStop(args: BatchStopCommandInput, options?: __HttpHandlerOptions): Promise; - public batchStop(args: BatchStopCommandInput, cb: (err: any, data?: BatchStopCommandOutput) => void): void; - public batchStop( + batchStop(args: BatchStopCommandInput, options?: __HttpHandlerOptions): Promise; + batchStop(args: BatchStopCommandInput, cb: (err: any, data?: BatchStopCommandOutput) => void): void; + batchStop( args: BatchStopCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchStopCommandOutput) => void ): void; - public batchStop( - args: BatchStopCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchStopCommandOutput) => void), - cb?: (err: any, data?: BatchStopCommandOutput) => void - ): Promise | void { - const command = new BatchStopCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Update a channel schedule + * @see {@link BatchUpdateScheduleCommand} */ - public batchUpdateSchedule( + batchUpdateSchedule( args: BatchUpdateScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchUpdateSchedule( + batchUpdateSchedule( args: BatchUpdateScheduleCommandInput, cb: (err: any, data?: BatchUpdateScheduleCommandOutput) => void ): void; - public batchUpdateSchedule( + batchUpdateSchedule( args: BatchUpdateScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchUpdateScheduleCommandOutput) => void ): void; - public batchUpdateSchedule( - args: BatchUpdateScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchUpdateScheduleCommandOutput) => void), - cb?: (err: any, data?: BatchUpdateScheduleCommandOutput) => void - ): Promise | void { - const command = new BatchUpdateScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Cancel an input device transfer that you have requested. + * @see {@link CancelInputDeviceTransferCommand} */ - public cancelInputDeviceTransfer( + cancelInputDeviceTransfer( args: CancelInputDeviceTransferCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelInputDeviceTransfer( + cancelInputDeviceTransfer( args: CancelInputDeviceTransferCommandInput, cb: (err: any, data?: CancelInputDeviceTransferCommandOutput) => void ): void; - public cancelInputDeviceTransfer( + cancelInputDeviceTransfer( args: CancelInputDeviceTransferCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelInputDeviceTransferCommandOutput) => void ): void; - public cancelInputDeviceTransfer( - args: CancelInputDeviceTransferCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelInputDeviceTransferCommandOutput) => void), - cb?: (err: any, data?: CancelInputDeviceTransferCommandOutput) => void - ): Promise | void { - const command = new CancelInputDeviceTransferCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Send a request to claim an AWS Elemental device that you have purchased from a third-party vendor. After the request succeeds, you will own the device. + * @see {@link ClaimDeviceCommand} */ - public claimDevice(args: ClaimDeviceCommandInput, options?: __HttpHandlerOptions): Promise; - public claimDevice(args: ClaimDeviceCommandInput, cb: (err: any, data?: ClaimDeviceCommandOutput) => void): void; - public claimDevice( + claimDevice(args: ClaimDeviceCommandInput, options?: __HttpHandlerOptions): Promise; + claimDevice(args: ClaimDeviceCommandInput, cb: (err: any, data?: ClaimDeviceCommandOutput) => void): void; + claimDevice( args: ClaimDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ClaimDeviceCommandOutput) => void ): void; - public claimDevice( - args: ClaimDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ClaimDeviceCommandOutput) => void), - cb?: (err: any, data?: ClaimDeviceCommandOutput) => void - ): Promise | void { - const command = new ClaimDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Creates a new channel + * @see {@link CreateChannelCommand} */ - public createChannel( - args: CreateChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createChannel( - args: CreateChannelCommandInput, - cb: (err: any, data?: CreateChannelCommandOutput) => void - ): void; - public createChannel( + createChannel(args: CreateChannelCommandInput, options?: __HttpHandlerOptions): Promise; + createChannel(args: CreateChannelCommandInput, cb: (err: any, data?: CreateChannelCommandOutput) => void): void; + createChannel( args: CreateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelCommandOutput) => void ): void; - public createChannel( - args: CreateChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateChannelCommandOutput) => void), - cb?: (err: any, data?: CreateChannelCommandOutput) => void - ): Promise | void { - const command = new CreateChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Create an input + * @see {@link CreateInputCommand} */ - public createInput(args: CreateInputCommandInput, options?: __HttpHandlerOptions): Promise; - public createInput(args: CreateInputCommandInput, cb: (err: any, data?: CreateInputCommandOutput) => void): void; - public createInput( + createInput(args: CreateInputCommandInput, options?: __HttpHandlerOptions): Promise; + createInput(args: CreateInputCommandInput, cb: (err: any, data?: CreateInputCommandOutput) => void): void; + createInput( args: CreateInputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInputCommandOutput) => void ): void; - public createInput( - args: CreateInputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateInputCommandOutput) => void), - cb?: (err: any, data?: CreateInputCommandOutput) => void - ): Promise | void { - const command = new CreateInputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Creates a Input Security Group + * @see {@link CreateInputSecurityGroupCommand} */ - public createInputSecurityGroup( + createInputSecurityGroup( args: CreateInputSecurityGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createInputSecurityGroup( + createInputSecurityGroup( args: CreateInputSecurityGroupCommandInput, cb: (err: any, data?: CreateInputSecurityGroupCommandOutput) => void ): void; - public createInputSecurityGroup( + createInputSecurityGroup( args: CreateInputSecurityGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInputSecurityGroupCommandOutput) => void ): void; - public createInputSecurityGroup( - args: CreateInputSecurityGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateInputSecurityGroupCommandOutput) => void), - cb?: (err: any, data?: CreateInputSecurityGroupCommandOutput) => void - ): Promise | void { - const command = new CreateInputSecurityGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Create a new multiplex. + * @see {@link CreateMultiplexCommand} */ - public createMultiplex( + createMultiplex( args: CreateMultiplexCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMultiplex( - args: CreateMultiplexCommandInput, - cb: (err: any, data?: CreateMultiplexCommandOutput) => void - ): void; - public createMultiplex( + createMultiplex(args: CreateMultiplexCommandInput, cb: (err: any, data?: CreateMultiplexCommandOutput) => void): void; + createMultiplex( args: CreateMultiplexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMultiplexCommandOutput) => void ): void; - public createMultiplex( - args: CreateMultiplexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMultiplexCommandOutput) => void), - cb?: (err: any, data?: CreateMultiplexCommandOutput) => void - ): Promise | void { - const command = new CreateMultiplexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Create a new program in the multiplex. + * @see {@link CreateMultiplexProgramCommand} */ - public createMultiplexProgram( + createMultiplexProgram( args: CreateMultiplexProgramCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMultiplexProgram( + createMultiplexProgram( args: CreateMultiplexProgramCommandInput, cb: (err: any, data?: CreateMultiplexProgramCommandOutput) => void ): void; - public createMultiplexProgram( + createMultiplexProgram( args: CreateMultiplexProgramCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMultiplexProgramCommandOutput) => void ): void; - public createMultiplexProgram( - args: CreateMultiplexProgramCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMultiplexProgramCommandOutput) => void), - cb?: (err: any, data?: CreateMultiplexProgramCommandOutput) => void - ): Promise | void { - const command = new CreateMultiplexProgramCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Create a partner input + * @see {@link CreatePartnerInputCommand} */ - public createPartnerInput( + createPartnerInput( args: CreatePartnerInputCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPartnerInput( + createPartnerInput( args: CreatePartnerInputCommandInput, cb: (err: any, data?: CreatePartnerInputCommandOutput) => void ): void; - public createPartnerInput( + createPartnerInput( args: CreatePartnerInputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePartnerInputCommandOutput) => void ): void; - public createPartnerInput( - args: CreatePartnerInputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePartnerInputCommandOutput) => void), - cb?: (err: any, data?: CreatePartnerInputCommandOutput) => void - ): Promise | void { - const command = new CreatePartnerInputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Create tags for a resource + * @see {@link CreateTagsCommand} */ - public createTags(args: CreateTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public createTags(args: CreateTagsCommandInput, cb: (err: any, data?: CreateTagsCommandOutput) => void): void; - public createTags( + createTags(args: CreateTagsCommandInput, options?: __HttpHandlerOptions): Promise; + createTags(args: CreateTagsCommandInput, cb: (err: any, data?: CreateTagsCommandOutput) => void): void; + createTags( args: CreateTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTagsCommandOutput) => void ): void; - public createTags( - args: CreateTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTagsCommandOutput) => void), - cb?: (err: any, data?: CreateTagsCommandOutput) => void - ): Promise | void { - const command = new CreateTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Starts deletion of channel. The associated outputs are also deleted. + * @see {@link DeleteChannelCommand} */ - public deleteChannel( - args: DeleteChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteChannel( - args: DeleteChannelCommandInput, - cb: (err: any, data?: DeleteChannelCommandOutput) => void - ): void; - public deleteChannel( + deleteChannel(args: DeleteChannelCommandInput, options?: __HttpHandlerOptions): Promise; + deleteChannel(args: DeleteChannelCommandInput, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void; + deleteChannel( args: DeleteChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelCommandOutput) => void ): void; - public deleteChannel( - args: DeleteChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteChannelCommandOutput) => void), - cb?: (err: any, data?: DeleteChannelCommandOutput) => void - ): Promise | void { - const command = new DeleteChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Deletes the input end point + * @see {@link DeleteInputCommand} */ - public deleteInput(args: DeleteInputCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteInput(args: DeleteInputCommandInput, cb: (err: any, data?: DeleteInputCommandOutput) => void): void; - public deleteInput( + deleteInput(args: DeleteInputCommandInput, options?: __HttpHandlerOptions): Promise; + deleteInput(args: DeleteInputCommandInput, cb: (err: any, data?: DeleteInputCommandOutput) => void): void; + deleteInput( args: DeleteInputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInputCommandOutput) => void ): void; - public deleteInput( - args: DeleteInputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInputCommandOutput) => void), - cb?: (err: any, data?: DeleteInputCommandOutput) => void - ): Promise | void { - const command = new DeleteInputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Deletes an Input Security Group + * @see {@link DeleteInputSecurityGroupCommand} */ - public deleteInputSecurityGroup( + deleteInputSecurityGroup( args: DeleteInputSecurityGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInputSecurityGroup( + deleteInputSecurityGroup( args: DeleteInputSecurityGroupCommandInput, cb: (err: any, data?: DeleteInputSecurityGroupCommandOutput) => void ): void; - public deleteInputSecurityGroup( + deleteInputSecurityGroup( args: DeleteInputSecurityGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInputSecurityGroupCommandOutput) => void ): void; - public deleteInputSecurityGroup( - args: DeleteInputSecurityGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInputSecurityGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteInputSecurityGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteInputSecurityGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Delete a multiplex. The multiplex must be idle. + * @see {@link DeleteMultiplexCommand} */ - public deleteMultiplex( + deleteMultiplex( args: DeleteMultiplexCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMultiplex( - args: DeleteMultiplexCommandInput, - cb: (err: any, data?: DeleteMultiplexCommandOutput) => void - ): void; - public deleteMultiplex( + deleteMultiplex(args: DeleteMultiplexCommandInput, cb: (err: any, data?: DeleteMultiplexCommandOutput) => void): void; + deleteMultiplex( args: DeleteMultiplexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMultiplexCommandOutput) => void ): void; - public deleteMultiplex( - args: DeleteMultiplexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMultiplexCommandOutput) => void), - cb?: (err: any, data?: DeleteMultiplexCommandOutput) => void - ): Promise | void { - const command = new DeleteMultiplexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Delete a program from a multiplex. + * @see {@link DeleteMultiplexProgramCommand} */ - public deleteMultiplexProgram( + deleteMultiplexProgram( args: DeleteMultiplexProgramCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMultiplexProgram( + deleteMultiplexProgram( args: DeleteMultiplexProgramCommandInput, cb: (err: any, data?: DeleteMultiplexProgramCommandOutput) => void ): void; - public deleteMultiplexProgram( + deleteMultiplexProgram( args: DeleteMultiplexProgramCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMultiplexProgramCommandOutput) => void ): void; - public deleteMultiplexProgram( - args: DeleteMultiplexProgramCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMultiplexProgramCommandOutput) => void), - cb?: (err: any, data?: DeleteMultiplexProgramCommandOutput) => void - ): Promise | void { - const command = new DeleteMultiplexProgramCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Delete an expired reservation. + * @see {@link DeleteReservationCommand} */ - public deleteReservation( + deleteReservation( args: DeleteReservationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteReservation( + deleteReservation( args: DeleteReservationCommandInput, cb: (err: any, data?: DeleteReservationCommandOutput) => void ): void; - public deleteReservation( + deleteReservation( args: DeleteReservationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReservationCommandOutput) => void ): void; - public deleteReservation( - args: DeleteReservationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteReservationCommandOutput) => void), - cb?: (err: any, data?: DeleteReservationCommandOutput) => void - ): Promise | void { - const command = new DeleteReservationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Delete all schedule actions on a channel. + * @see {@link DeleteScheduleCommand} */ - public deleteSchedule( + deleteSchedule( args: DeleteScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSchedule( - args: DeleteScheduleCommandInput, - cb: (err: any, data?: DeleteScheduleCommandOutput) => void - ): void; - public deleteSchedule( + deleteSchedule(args: DeleteScheduleCommandInput, cb: (err: any, data?: DeleteScheduleCommandOutput) => void): void; + deleteSchedule( args: DeleteScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteScheduleCommandOutput) => void ): void; - public deleteSchedule( - args: DeleteScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteScheduleCommandOutput) => void), - cb?: (err: any, data?: DeleteScheduleCommandOutput) => void - ): Promise | void { - const command = new DeleteScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Removes tags for a resource + * @see {@link DeleteTagsCommand} */ - public deleteTags(args: DeleteTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteTags(args: DeleteTagsCommandInput, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void; - public deleteTags( + deleteTags(args: DeleteTagsCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTags(args: DeleteTagsCommandInput, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void; + deleteTags( args: DeleteTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTagsCommandOutput) => void ): void; - public deleteTags( - args: DeleteTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTagsCommandOutput) => void), - cb?: (err: any, data?: DeleteTagsCommandOutput) => void - ): Promise | void { - const command = new DeleteTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Gets details about a channel + * @see {@link DescribeChannelCommand} */ - public describeChannel( + describeChannel( args: DescribeChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeChannel( - args: DescribeChannelCommandInput, - cb: (err: any, data?: DescribeChannelCommandOutput) => void - ): void; - public describeChannel( + describeChannel(args: DescribeChannelCommandInput, cb: (err: any, data?: DescribeChannelCommandOutput) => void): void; + describeChannel( args: DescribeChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelCommandOutput) => void ): void; - public describeChannel( - args: DescribeChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeChannelCommandOutput) => void), - cb?: (err: any, data?: DescribeChannelCommandOutput) => void - ): Promise | void { - const command = new DescribeChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Produces details about an input + * @see {@link DescribeInputCommand} */ - public describeInput( - args: DescribeInputCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeInput( - args: DescribeInputCommandInput, - cb: (err: any, data?: DescribeInputCommandOutput) => void - ): void; - public describeInput( + describeInput(args: DescribeInputCommandInput, options?: __HttpHandlerOptions): Promise; + describeInput(args: DescribeInputCommandInput, cb: (err: any, data?: DescribeInputCommandOutput) => void): void; + describeInput( args: DescribeInputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInputCommandOutput) => void ): void; - public describeInput( - args: DescribeInputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInputCommandOutput) => void), - cb?: (err: any, data?: DescribeInputCommandOutput) => void - ): Promise | void { - const command = new DescribeInputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Gets the details for the input device + * @see {@link DescribeInputDeviceCommand} */ - public describeInputDevice( + describeInputDevice( args: DescribeInputDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInputDevice( + describeInputDevice( args: DescribeInputDeviceCommandInput, cb: (err: any, data?: DescribeInputDeviceCommandOutput) => void ): void; - public describeInputDevice( + describeInputDevice( args: DescribeInputDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInputDeviceCommandOutput) => void ): void; - public describeInputDevice( - args: DescribeInputDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInputDeviceCommandOutput) => void), - cb?: (err: any, data?: DescribeInputDeviceCommandOutput) => void - ): Promise | void { - const command = new DescribeInputDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Get the latest thumbnail data for the input device. + * @see {@link DescribeInputDeviceThumbnailCommand} */ - public describeInputDeviceThumbnail( + describeInputDeviceThumbnail( args: DescribeInputDeviceThumbnailCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInputDeviceThumbnail( + describeInputDeviceThumbnail( args: DescribeInputDeviceThumbnailCommandInput, cb: (err: any, data?: DescribeInputDeviceThumbnailCommandOutput) => void ): void; - public describeInputDeviceThumbnail( + describeInputDeviceThumbnail( args: DescribeInputDeviceThumbnailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInputDeviceThumbnailCommandOutput) => void ): void; - public describeInputDeviceThumbnail( - args: DescribeInputDeviceThumbnailCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInputDeviceThumbnailCommandOutput) => void), - cb?: (err: any, data?: DescribeInputDeviceThumbnailCommandOutput) => void - ): Promise | void { - const command = new DescribeInputDeviceThumbnailCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Produces a summary of an Input Security Group + * @see {@link DescribeInputSecurityGroupCommand} */ - public describeInputSecurityGroup( + describeInputSecurityGroup( args: DescribeInputSecurityGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInputSecurityGroup( + describeInputSecurityGroup( args: DescribeInputSecurityGroupCommandInput, cb: (err: any, data?: DescribeInputSecurityGroupCommandOutput) => void ): void; - public describeInputSecurityGroup( + describeInputSecurityGroup( args: DescribeInputSecurityGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInputSecurityGroupCommandOutput) => void ): void; - public describeInputSecurityGroup( - args: DescribeInputSecurityGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInputSecurityGroupCommandOutput) => void), - cb?: (err: any, data?: DescribeInputSecurityGroupCommandOutput) => void - ): Promise | void { - const command = new DescribeInputSecurityGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Gets details about a multiplex. + * @see {@link DescribeMultiplexCommand} */ - public describeMultiplex( + describeMultiplex( args: DescribeMultiplexCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMultiplex( + describeMultiplex( args: DescribeMultiplexCommandInput, cb: (err: any, data?: DescribeMultiplexCommandOutput) => void ): void; - public describeMultiplex( + describeMultiplex( args: DescribeMultiplexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMultiplexCommandOutput) => void ): void; - public describeMultiplex( - args: DescribeMultiplexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMultiplexCommandOutput) => void), - cb?: (err: any, data?: DescribeMultiplexCommandOutput) => void - ): Promise | void { - const command = new DescribeMultiplexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Get the details for a program in a multiplex. + * @see {@link DescribeMultiplexProgramCommand} */ - public describeMultiplexProgram( + describeMultiplexProgram( args: DescribeMultiplexProgramCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMultiplexProgram( + describeMultiplexProgram( args: DescribeMultiplexProgramCommandInput, cb: (err: any, data?: DescribeMultiplexProgramCommandOutput) => void ): void; - public describeMultiplexProgram( + describeMultiplexProgram( args: DescribeMultiplexProgramCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMultiplexProgramCommandOutput) => void ): void; - public describeMultiplexProgram( - args: DescribeMultiplexProgramCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMultiplexProgramCommandOutput) => void), - cb?: (err: any, data?: DescribeMultiplexProgramCommandOutput) => void - ): Promise | void { - const command = new DescribeMultiplexProgramCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Get details for an offering. + * @see {@link DescribeOfferingCommand} */ - public describeOffering( + describeOffering( args: DescribeOfferingCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOffering( + describeOffering( args: DescribeOfferingCommandInput, cb: (err: any, data?: DescribeOfferingCommandOutput) => void ): void; - public describeOffering( + describeOffering( args: DescribeOfferingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOfferingCommandOutput) => void ): void; - public describeOffering( - args: DescribeOfferingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOfferingCommandOutput) => void), - cb?: (err: any, data?: DescribeOfferingCommandOutput) => void - ): Promise | void { - const command = new DescribeOfferingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Get details for a reservation. + * @see {@link DescribeReservationCommand} */ - public describeReservation( + describeReservation( args: DescribeReservationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReservation( + describeReservation( args: DescribeReservationCommandInput, cb: (err: any, data?: DescribeReservationCommandOutput) => void ): void; - public describeReservation( + describeReservation( args: DescribeReservationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReservationCommandOutput) => void ): void; - public describeReservation( - args: DescribeReservationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReservationCommandOutput) => void), - cb?: (err: any, data?: DescribeReservationCommandOutput) => void - ): Promise | void { - const command = new DescribeReservationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Get a channel schedule + * @see {@link DescribeScheduleCommand} */ - public describeSchedule( + describeSchedule( args: DescribeScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSchedule( + describeSchedule( args: DescribeScheduleCommandInput, cb: (err: any, data?: DescribeScheduleCommandOutput) => void ): void; - public describeSchedule( + describeSchedule( args: DescribeScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScheduleCommandOutput) => void ): void; - public describeSchedule( - args: DescribeScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeScheduleCommandOutput) => void), - cb?: (err: any, data?: DescribeScheduleCommandOutput) => void - ): Promise | void { - const command = new DescribeScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Produces list of channels that have been created + * @see {@link ListChannelsCommand} */ - public listChannels( - args: ListChannelsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void; - public listChannels( + listChannels(args: ListChannelsCommandInput, options?: __HttpHandlerOptions): Promise; + listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void; + listChannels( args: ListChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsCommandOutput) => void ): void; - public listChannels( - args: ListChannelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListChannelsCommandOutput) => void), - cb?: (err: any, data?: ListChannelsCommandOutput) => void - ): Promise | void { - const command = new ListChannelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * List input devices + * @see {@link ListInputDevicesCommand} */ - public listInputDevices( + listInputDevices( args: ListInputDevicesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInputDevices( + listInputDevices( args: ListInputDevicesCommandInput, cb: (err: any, data?: ListInputDevicesCommandOutput) => void ): void; - public listInputDevices( + listInputDevices( args: ListInputDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInputDevicesCommandOutput) => void ): void; - public listInputDevices( - args: ListInputDevicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInputDevicesCommandOutput) => void), - cb?: (err: any, data?: ListInputDevicesCommandOutput) => void - ): Promise | void { - const command = new ListInputDevicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * List input devices that are currently being transferred. List input devices that you are transferring from your AWS account or input devices that another AWS account is transferring to you. + * @see {@link ListInputDeviceTransfersCommand} */ - public listInputDeviceTransfers( + listInputDeviceTransfers( args: ListInputDeviceTransfersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInputDeviceTransfers( + listInputDeviceTransfers( args: ListInputDeviceTransfersCommandInput, cb: (err: any, data?: ListInputDeviceTransfersCommandOutput) => void ): void; - public listInputDeviceTransfers( + listInputDeviceTransfers( args: ListInputDeviceTransfersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInputDeviceTransfersCommandOutput) => void ): void; - public listInputDeviceTransfers( - args: ListInputDeviceTransfersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInputDeviceTransfersCommandOutput) => void), - cb?: (err: any, data?: ListInputDeviceTransfersCommandOutput) => void - ): Promise | void { - const command = new ListInputDeviceTransfersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Produces list of inputs that have been created + * @see {@link ListInputsCommand} */ - public listInputs(args: ListInputsCommandInput, options?: __HttpHandlerOptions): Promise; - public listInputs(args: ListInputsCommandInput, cb: (err: any, data?: ListInputsCommandOutput) => void): void; - public listInputs( + listInputs(args: ListInputsCommandInput, options?: __HttpHandlerOptions): Promise; + listInputs(args: ListInputsCommandInput, cb: (err: any, data?: ListInputsCommandOutput) => void): void; + listInputs( args: ListInputsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInputsCommandOutput) => void ): void; - public listInputs( - args: ListInputsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInputsCommandOutput) => void), - cb?: (err: any, data?: ListInputsCommandOutput) => void - ): Promise | void { - const command = new ListInputsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Produces a list of Input Security Groups for an account + * @see {@link ListInputSecurityGroupsCommand} */ - public listInputSecurityGroups( + listInputSecurityGroups( args: ListInputSecurityGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInputSecurityGroups( + listInputSecurityGroups( args: ListInputSecurityGroupsCommandInput, cb: (err: any, data?: ListInputSecurityGroupsCommandOutput) => void ): void; - public listInputSecurityGroups( + listInputSecurityGroups( args: ListInputSecurityGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInputSecurityGroupsCommandOutput) => void ): void; - public listInputSecurityGroups( - args: ListInputSecurityGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInputSecurityGroupsCommandOutput) => void), - cb?: (err: any, data?: ListInputSecurityGroupsCommandOutput) => void - ): Promise | void { - const command = new ListInputSecurityGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Retrieve a list of the existing multiplexes. + * @see {@link ListMultiplexesCommand} */ - public listMultiplexes( + listMultiplexes( args: ListMultiplexesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMultiplexes( - args: ListMultiplexesCommandInput, - cb: (err: any, data?: ListMultiplexesCommandOutput) => void - ): void; - public listMultiplexes( + listMultiplexes(args: ListMultiplexesCommandInput, cb: (err: any, data?: ListMultiplexesCommandOutput) => void): void; + listMultiplexes( args: ListMultiplexesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMultiplexesCommandOutput) => void ): void; - public listMultiplexes( - args: ListMultiplexesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMultiplexesCommandOutput) => void), - cb?: (err: any, data?: ListMultiplexesCommandOutput) => void - ): Promise | void { - const command = new ListMultiplexesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * List the programs that currently exist for a specific multiplex. + * @see {@link ListMultiplexProgramsCommand} */ - public listMultiplexPrograms( + listMultiplexPrograms( args: ListMultiplexProgramsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMultiplexPrograms( + listMultiplexPrograms( args: ListMultiplexProgramsCommandInput, cb: (err: any, data?: ListMultiplexProgramsCommandOutput) => void ): void; - public listMultiplexPrograms( + listMultiplexPrograms( args: ListMultiplexProgramsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMultiplexProgramsCommandOutput) => void ): void; - public listMultiplexPrograms( - args: ListMultiplexProgramsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMultiplexProgramsCommandOutput) => void), - cb?: (err: any, data?: ListMultiplexProgramsCommandOutput) => void - ): Promise | void { - const command = new ListMultiplexProgramsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * List offerings available for purchase. + * @see {@link ListOfferingsCommand} */ - public listOfferings( - args: ListOfferingsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listOfferings( - args: ListOfferingsCommandInput, - cb: (err: any, data?: ListOfferingsCommandOutput) => void - ): void; - public listOfferings( + listOfferings(args: ListOfferingsCommandInput, options?: __HttpHandlerOptions): Promise; + listOfferings(args: ListOfferingsCommandInput, cb: (err: any, data?: ListOfferingsCommandOutput) => void): void; + listOfferings( args: ListOfferingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOfferingsCommandOutput) => void ): void; - public listOfferings( - args: ListOfferingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOfferingsCommandOutput) => void), - cb?: (err: any, data?: ListOfferingsCommandOutput) => void - ): Promise | void { - const command = new ListOfferingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * List purchased reservations. + * @see {@link ListReservationsCommand} */ - public listReservations( + listReservations( args: ListReservationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReservations( + listReservations( args: ListReservationsCommandInput, cb: (err: any, data?: ListReservationsCommandOutput) => void ): void; - public listReservations( + listReservations( args: ListReservationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReservationsCommandOutput) => void ): void; - public listReservations( - args: ListReservationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReservationsCommandOutput) => void), - cb?: (err: any, data?: ListReservationsCommandOutput) => void - ): Promise | void { - const command = new ListReservationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Produces list of tags that have been created for a resource + * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Purchase an offering and create a reservation. + * @see {@link PurchaseOfferingCommand} */ - public purchaseOffering( + purchaseOffering( args: PurchaseOfferingCommandInput, options?: __HttpHandlerOptions ): Promise; - public purchaseOffering( + purchaseOffering( args: PurchaseOfferingCommandInput, cb: (err: any, data?: PurchaseOfferingCommandOutput) => void ): void; - public purchaseOffering( + purchaseOffering( args: PurchaseOfferingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PurchaseOfferingCommandOutput) => void ): void; - public purchaseOffering( - args: PurchaseOfferingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PurchaseOfferingCommandOutput) => void), - cb?: (err: any, data?: PurchaseOfferingCommandOutput) => void - ): Promise | void { - const command = new PurchaseOfferingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Send a reboot command to the specified input device. The device will begin rebooting within a few seconds of sending the command. When the reboot is complete, the device’s connection status will change to connected. + * @see {@link RebootInputDeviceCommand} */ - public rebootInputDevice( + rebootInputDevice( args: RebootInputDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public rebootInputDevice( + rebootInputDevice( args: RebootInputDeviceCommandInput, cb: (err: any, data?: RebootInputDeviceCommandOutput) => void ): void; - public rebootInputDevice( + rebootInputDevice( args: RebootInputDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebootInputDeviceCommandOutput) => void ): void; - public rebootInputDevice( - args: RebootInputDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RebootInputDeviceCommandOutput) => void), - cb?: (err: any, data?: RebootInputDeviceCommandOutput) => void - ): Promise | void { - const command = new RebootInputDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Reject the transfer of the specified input device to your AWS account. + * @see {@link RejectInputDeviceTransferCommand} */ - public rejectInputDeviceTransfer( + rejectInputDeviceTransfer( args: RejectInputDeviceTransferCommandInput, options?: __HttpHandlerOptions ): Promise; - public rejectInputDeviceTransfer( + rejectInputDeviceTransfer( args: RejectInputDeviceTransferCommandInput, cb: (err: any, data?: RejectInputDeviceTransferCommandOutput) => void ): void; - public rejectInputDeviceTransfer( + rejectInputDeviceTransfer( args: RejectInputDeviceTransferCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectInputDeviceTransferCommandOutput) => void ): void; - public rejectInputDeviceTransfer( - args: RejectInputDeviceTransferCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RejectInputDeviceTransferCommandOutput) => void), - cb?: (err: any, data?: RejectInputDeviceTransferCommandOutput) => void - ): Promise | void { - const command = new RejectInputDeviceTransferCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Starts an existing channel + * @see {@link StartChannelCommand} */ - public startChannel( - args: StartChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public startChannel(args: StartChannelCommandInput, cb: (err: any, data?: StartChannelCommandOutput) => void): void; - public startChannel( + startChannel(args: StartChannelCommandInput, options?: __HttpHandlerOptions): Promise; + startChannel(args: StartChannelCommandInput, cb: (err: any, data?: StartChannelCommandOutput) => void): void; + startChannel( args: StartChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartChannelCommandOutput) => void ): void; - public startChannel( - args: StartChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartChannelCommandOutput) => void), - cb?: (err: any, data?: StartChannelCommandOutput) => void - ): Promise | void { - const command = new StartChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Start a maintenance window for the specified input device. Starting a maintenance window will give the device up to two hours to install software. If the device was streaming prior to the maintenance, it will resume streaming when the software is fully installed. Devices automatically install updates while they are powered on and their MediaLive channels are stopped. A maintenance window allows you to update a device without having to stop MediaLive channels that use the device. The device must remain powered on and connected to the internet for the duration of the maintenance. + * @see {@link StartInputDeviceMaintenanceWindowCommand} */ - public startInputDeviceMaintenanceWindow( + startInputDeviceMaintenanceWindow( args: StartInputDeviceMaintenanceWindowCommandInput, options?: __HttpHandlerOptions ): Promise; - public startInputDeviceMaintenanceWindow( + startInputDeviceMaintenanceWindow( args: StartInputDeviceMaintenanceWindowCommandInput, cb: (err: any, data?: StartInputDeviceMaintenanceWindowCommandOutput) => void ): void; - public startInputDeviceMaintenanceWindow( + startInputDeviceMaintenanceWindow( args: StartInputDeviceMaintenanceWindowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartInputDeviceMaintenanceWindowCommandOutput) => void ): void; - public startInputDeviceMaintenanceWindow( - args: StartInputDeviceMaintenanceWindowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartInputDeviceMaintenanceWindowCommandOutput) => void), - cb?: (err: any, data?: StartInputDeviceMaintenanceWindowCommandOutput) => void - ): Promise | void { - const command = new StartInputDeviceMaintenanceWindowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Start (run) the multiplex. Starting the multiplex does not start the channels. You must explicitly start each channel. + * @see {@link StartMultiplexCommand} */ - public startMultiplex( + startMultiplex( args: StartMultiplexCommandInput, options?: __HttpHandlerOptions ): Promise; - public startMultiplex( - args: StartMultiplexCommandInput, - cb: (err: any, data?: StartMultiplexCommandOutput) => void - ): void; - public startMultiplex( + startMultiplex(args: StartMultiplexCommandInput, cb: (err: any, data?: StartMultiplexCommandOutput) => void): void; + startMultiplex( args: StartMultiplexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMultiplexCommandOutput) => void ): void; - public startMultiplex( - args: StartMultiplexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartMultiplexCommandOutput) => void), - cb?: (err: any, data?: StartMultiplexCommandOutput) => void - ): Promise | void { - const command = new StartMultiplexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Stops a running channel + * @see {@link StopChannelCommand} */ - public stopChannel(args: StopChannelCommandInput, options?: __HttpHandlerOptions): Promise; - public stopChannel(args: StopChannelCommandInput, cb: (err: any, data?: StopChannelCommandOutput) => void): void; - public stopChannel( + stopChannel(args: StopChannelCommandInput, options?: __HttpHandlerOptions): Promise; + stopChannel(args: StopChannelCommandInput, cb: (err: any, data?: StopChannelCommandOutput) => void): void; + stopChannel( args: StopChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopChannelCommandOutput) => void ): void; - public stopChannel( - args: StopChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopChannelCommandOutput) => void), - cb?: (err: any, data?: StopChannelCommandOutput) => void - ): Promise | void { - const command = new StopChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Stops a running multiplex. If the multiplex isn't running, this action has no effect. + * @see {@link StopMultiplexCommand} */ - public stopMultiplex( - args: StopMultiplexCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public stopMultiplex( - args: StopMultiplexCommandInput, - cb: (err: any, data?: StopMultiplexCommandOutput) => void - ): void; - public stopMultiplex( + stopMultiplex(args: StopMultiplexCommandInput, options?: __HttpHandlerOptions): Promise; + stopMultiplex(args: StopMultiplexCommandInput, cb: (err: any, data?: StopMultiplexCommandOutput) => void): void; + stopMultiplex( args: StopMultiplexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopMultiplexCommandOutput) => void ): void; - public stopMultiplex( - args: StopMultiplexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopMultiplexCommandOutput) => void), - cb?: (err: any, data?: StopMultiplexCommandOutput) => void - ): Promise | void { - const command = new StopMultiplexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Start an input device transfer to another AWS account. After you make the request, the other account must accept or reject the transfer. + * @see {@link TransferInputDeviceCommand} */ - public transferInputDevice( + transferInputDevice( args: TransferInputDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public transferInputDevice( + transferInputDevice( args: TransferInputDeviceCommandInput, cb: (err: any, data?: TransferInputDeviceCommandOutput) => void ): void; - public transferInputDevice( + transferInputDevice( args: TransferInputDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TransferInputDeviceCommandOutput) => void ): void; - public transferInputDevice( - args: TransferInputDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TransferInputDeviceCommandOutput) => void), - cb?: (err: any, data?: TransferInputDeviceCommandOutput) => void - ): Promise | void { - const command = new TransferInputDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Updates a channel. + * @see {@link UpdateChannelCommand} */ - public updateChannel( - args: UpdateChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateChannel( - args: UpdateChannelCommandInput, - cb: (err: any, data?: UpdateChannelCommandOutput) => void - ): void; - public updateChannel( + updateChannel(args: UpdateChannelCommandInput, options?: __HttpHandlerOptions): Promise; + updateChannel(args: UpdateChannelCommandInput, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void; + updateChannel( args: UpdateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelCommandOutput) => void ): void; - public updateChannel( - args: UpdateChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateChannelCommandOutput) => void), - cb?: (err: any, data?: UpdateChannelCommandOutput) => void - ): Promise | void { - const command = new UpdateChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Changes the class of the channel. + * @see {@link UpdateChannelClassCommand} */ - public updateChannelClass( + updateChannelClass( args: UpdateChannelClassCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateChannelClass( + updateChannelClass( args: UpdateChannelClassCommandInput, cb: (err: any, data?: UpdateChannelClassCommandOutput) => void ): void; - public updateChannelClass( + updateChannelClass( args: UpdateChannelClassCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelClassCommandOutput) => void ): void; - public updateChannelClass( - args: UpdateChannelClassCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateChannelClassCommandOutput) => void), - cb?: (err: any, data?: UpdateChannelClassCommandOutput) => void - ): Promise | void { - const command = new UpdateChannelClassCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Updates an input. + * @see {@link UpdateInputCommand} */ - public updateInput(args: UpdateInputCommandInput, options?: __HttpHandlerOptions): Promise; - public updateInput(args: UpdateInputCommandInput, cb: (err: any, data?: UpdateInputCommandOutput) => void): void; - public updateInput( + updateInput(args: UpdateInputCommandInput, options?: __HttpHandlerOptions): Promise; + updateInput(args: UpdateInputCommandInput, cb: (err: any, data?: UpdateInputCommandOutput) => void): void; + updateInput( args: UpdateInputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateInputCommandOutput) => void ): void; - public updateInput( - args: UpdateInputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateInputCommandOutput) => void), - cb?: (err: any, data?: UpdateInputCommandOutput) => void - ): Promise | void { - const command = new UpdateInputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Updates the parameters for the input device. + * @see {@link UpdateInputDeviceCommand} */ - public updateInputDevice( + updateInputDevice( args: UpdateInputDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateInputDevice( + updateInputDevice( args: UpdateInputDeviceCommandInput, cb: (err: any, data?: UpdateInputDeviceCommandOutput) => void ): void; - public updateInputDevice( + updateInputDevice( args: UpdateInputDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateInputDeviceCommandOutput) => void ): void; - public updateInputDevice( - args: UpdateInputDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateInputDeviceCommandOutput) => void), - cb?: (err: any, data?: UpdateInputDeviceCommandOutput) => void - ): Promise | void { - const command = new UpdateInputDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Update an Input Security Group's Whilelists. + * @see {@link UpdateInputSecurityGroupCommand} */ - public updateInputSecurityGroup( + updateInputSecurityGroup( args: UpdateInputSecurityGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateInputSecurityGroup( + updateInputSecurityGroup( args: UpdateInputSecurityGroupCommandInput, cb: (err: any, data?: UpdateInputSecurityGroupCommandOutput) => void ): void; - public updateInputSecurityGroup( + updateInputSecurityGroup( args: UpdateInputSecurityGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateInputSecurityGroupCommandOutput) => void ): void; - public updateInputSecurityGroup( - args: UpdateInputSecurityGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateInputSecurityGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateInputSecurityGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateInputSecurityGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Updates a multiplex. + * @see {@link UpdateMultiplexCommand} */ - public updateMultiplex( + updateMultiplex( args: UpdateMultiplexCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMultiplex( - args: UpdateMultiplexCommandInput, - cb: (err: any, data?: UpdateMultiplexCommandOutput) => void - ): void; - public updateMultiplex( + updateMultiplex(args: UpdateMultiplexCommandInput, cb: (err: any, data?: UpdateMultiplexCommandOutput) => void): void; + updateMultiplex( args: UpdateMultiplexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMultiplexCommandOutput) => void ): void; - public updateMultiplex( - args: UpdateMultiplexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMultiplexCommandOutput) => void), - cb?: (err: any, data?: UpdateMultiplexCommandOutput) => void - ): Promise | void { - const command = new UpdateMultiplexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Update a program in a multiplex. + * @see {@link UpdateMultiplexProgramCommand} */ - public updateMultiplexProgram( + updateMultiplexProgram( args: UpdateMultiplexProgramCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMultiplexProgram( + updateMultiplexProgram( args: UpdateMultiplexProgramCommandInput, cb: (err: any, data?: UpdateMultiplexProgramCommandOutput) => void ): void; - public updateMultiplexProgram( + updateMultiplexProgram( args: UpdateMultiplexProgramCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMultiplexProgramCommandOutput) => void ): void; - public updateMultiplexProgram( - args: UpdateMultiplexProgramCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMultiplexProgramCommandOutput) => void), - cb?: (err: any, data?: UpdateMultiplexProgramCommandOutput) => void - ): Promise | void { - const command = new UpdateMultiplexProgramCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Update reservation. + * @see {@link UpdateReservationCommand} */ - public updateReservation( + updateReservation( args: UpdateReservationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateReservation( + updateReservation( args: UpdateReservationCommandInput, cb: (err: any, data?: UpdateReservationCommandOutput) => void ): void; - public updateReservation( + updateReservation( args: UpdateReservationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateReservationCommandOutput) => void ): void; - public updateReservation( - args: UpdateReservationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateReservationCommandOutput) => void), - cb?: (err: any, data?: UpdateReservationCommandOutput) => void - ): Promise | void { - const command = new UpdateReservationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * API for AWS Elemental MediaLive + */ +export class MediaLive extends MediaLiveClient implements MediaLive {} +createAggregatedClient(commands, MediaLive); diff --git a/clients/client-mediapackage-vod/src/MediaPackageVod.ts b/clients/client-mediapackage-vod/src/MediaPackageVod.ts index 28df638cdb1b..1fdda24dff3e 100644 --- a/clients/client-mediapackage-vod/src/MediaPackageVod.ts +++ b/clients/client-mediapackage-vod/src/MediaPackageVod.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -70,547 +71,280 @@ import { UpdatePackagingGroupCommandInput, UpdatePackagingGroupCommandOutput, } from "./commands/UpdatePackagingGroupCommand"; -import { MediaPackageVodClient } from "./MediaPackageVodClient"; +import { MediaPackageVodClient, MediaPackageVodClientConfig } from "./MediaPackageVodClient"; -/** - * @public - * AWS Elemental MediaPackage VOD - */ -export class MediaPackageVod extends MediaPackageVodClient { +const commands = { + ConfigureLogsCommand, + CreateAssetCommand, + CreatePackagingConfigurationCommand, + CreatePackagingGroupCommand, + DeleteAssetCommand, + DeletePackagingConfigurationCommand, + DeletePackagingGroupCommand, + DescribeAssetCommand, + DescribePackagingConfigurationCommand, + DescribePackagingGroupCommand, + ListAssetsCommand, + ListPackagingConfigurationsCommand, + ListPackagingGroupsCommand, + ListTagsForResourceCommand, + TagResourceCommand, + UntagResourceCommand, + UpdatePackagingGroupCommand, +}; + +export interface MediaPackageVod { /** - * @public - * Changes the packaging group's properities to configure log subscription + * @see {@link ConfigureLogsCommand} */ - public configureLogs( - args: ConfigureLogsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public configureLogs( - args: ConfigureLogsCommandInput, - cb: (err: any, data?: ConfigureLogsCommandOutput) => void - ): void; - public configureLogs( + configureLogs(args: ConfigureLogsCommandInput, options?: __HttpHandlerOptions): Promise; + configureLogs(args: ConfigureLogsCommandInput, cb: (err: any, data?: ConfigureLogsCommandOutput) => void): void; + configureLogs( args: ConfigureLogsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfigureLogsCommandOutput) => void ): void; - public configureLogs( - args: ConfigureLogsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConfigureLogsCommandOutput) => void), - cb?: (err: any, data?: ConfigureLogsCommandOutput) => void - ): Promise | void { - const command = new ConfigureLogsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Creates a new MediaPackage VOD Asset resource. + * @see {@link CreateAssetCommand} */ - public createAsset(args: CreateAssetCommandInput, options?: __HttpHandlerOptions): Promise; - public createAsset(args: CreateAssetCommandInput, cb: (err: any, data?: CreateAssetCommandOutput) => void): void; - public createAsset( + createAsset(args: CreateAssetCommandInput, options?: __HttpHandlerOptions): Promise; + createAsset(args: CreateAssetCommandInput, cb: (err: any, data?: CreateAssetCommandOutput) => void): void; + createAsset( args: CreateAssetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAssetCommandOutput) => void ): void; - public createAsset( - args: CreateAssetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAssetCommandOutput) => void), - cb?: (err: any, data?: CreateAssetCommandOutput) => void - ): Promise | void { - const command = new CreateAssetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Creates a new MediaPackage VOD PackagingConfiguration resource. + * @see {@link CreatePackagingConfigurationCommand} */ - public createPackagingConfiguration( + createPackagingConfiguration( args: CreatePackagingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPackagingConfiguration( + createPackagingConfiguration( args: CreatePackagingConfigurationCommandInput, cb: (err: any, data?: CreatePackagingConfigurationCommandOutput) => void ): void; - public createPackagingConfiguration( + createPackagingConfiguration( args: CreatePackagingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePackagingConfigurationCommandOutput) => void ): void; - public createPackagingConfiguration( - args: CreatePackagingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePackagingConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreatePackagingConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreatePackagingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Creates a new MediaPackage VOD PackagingGroup resource. + * @see {@link CreatePackagingGroupCommand} */ - public createPackagingGroup( + createPackagingGroup( args: CreatePackagingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPackagingGroup( + createPackagingGroup( args: CreatePackagingGroupCommandInput, cb: (err: any, data?: CreatePackagingGroupCommandOutput) => void ): void; - public createPackagingGroup( + createPackagingGroup( args: CreatePackagingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePackagingGroupCommandOutput) => void ): void; - public createPackagingGroup( - args: CreatePackagingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePackagingGroupCommandOutput) => void), - cb?: (err: any, data?: CreatePackagingGroupCommandOutput) => void - ): Promise | void { - const command = new CreatePackagingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Deletes an existing MediaPackage VOD Asset resource. + * @see {@link DeleteAssetCommand} */ - public deleteAsset(args: DeleteAssetCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteAsset(args: DeleteAssetCommandInput, cb: (err: any, data?: DeleteAssetCommandOutput) => void): void; - public deleteAsset( + deleteAsset(args: DeleteAssetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteAsset(args: DeleteAssetCommandInput, cb: (err: any, data?: DeleteAssetCommandOutput) => void): void; + deleteAsset( args: DeleteAssetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAssetCommandOutput) => void ): void; - public deleteAsset( - args: DeleteAssetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAssetCommandOutput) => void), - cb?: (err: any, data?: DeleteAssetCommandOutput) => void - ): Promise | void { - const command = new DeleteAssetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Deletes a MediaPackage VOD PackagingConfiguration resource. + * @see {@link DeletePackagingConfigurationCommand} */ - public deletePackagingConfiguration( + deletePackagingConfiguration( args: DeletePackagingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePackagingConfiguration( + deletePackagingConfiguration( args: DeletePackagingConfigurationCommandInput, cb: (err: any, data?: DeletePackagingConfigurationCommandOutput) => void ): void; - public deletePackagingConfiguration( + deletePackagingConfiguration( args: DeletePackagingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePackagingConfigurationCommandOutput) => void ): void; - public deletePackagingConfiguration( - args: DeletePackagingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePackagingConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeletePackagingConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeletePackagingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Deletes a MediaPackage VOD PackagingGroup resource. + * @see {@link DeletePackagingGroupCommand} */ - public deletePackagingGroup( + deletePackagingGroup( args: DeletePackagingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePackagingGroup( + deletePackagingGroup( args: DeletePackagingGroupCommandInput, cb: (err: any, data?: DeletePackagingGroupCommandOutput) => void ): void; - public deletePackagingGroup( + deletePackagingGroup( args: DeletePackagingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePackagingGroupCommandOutput) => void ): void; - public deletePackagingGroup( - args: DeletePackagingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePackagingGroupCommandOutput) => void), - cb?: (err: any, data?: DeletePackagingGroupCommandOutput) => void - ): Promise | void { - const command = new DeletePackagingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Returns a description of a MediaPackage VOD Asset resource. + * @see {@link DescribeAssetCommand} */ - public describeAsset( - args: DescribeAssetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeAsset( - args: DescribeAssetCommandInput, - cb: (err: any, data?: DescribeAssetCommandOutput) => void - ): void; - public describeAsset( + describeAsset(args: DescribeAssetCommandInput, options?: __HttpHandlerOptions): Promise; + describeAsset(args: DescribeAssetCommandInput, cb: (err: any, data?: DescribeAssetCommandOutput) => void): void; + describeAsset( args: DescribeAssetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAssetCommandOutput) => void ): void; - public describeAsset( - args: DescribeAssetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAssetCommandOutput) => void), - cb?: (err: any, data?: DescribeAssetCommandOutput) => void - ): Promise | void { - const command = new DescribeAssetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Returns a description of a MediaPackage VOD PackagingConfiguration resource. + * @see {@link DescribePackagingConfigurationCommand} */ - public describePackagingConfiguration( + describePackagingConfiguration( args: DescribePackagingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePackagingConfiguration( + describePackagingConfiguration( args: DescribePackagingConfigurationCommandInput, cb: (err: any, data?: DescribePackagingConfigurationCommandOutput) => void ): void; - public describePackagingConfiguration( + describePackagingConfiguration( args: DescribePackagingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePackagingConfigurationCommandOutput) => void ): void; - public describePackagingConfiguration( - args: DescribePackagingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePackagingConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribePackagingConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribePackagingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Returns a description of a MediaPackage VOD PackagingGroup resource. + * @see {@link DescribePackagingGroupCommand} */ - public describePackagingGroup( + describePackagingGroup( args: DescribePackagingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePackagingGroup( + describePackagingGroup( args: DescribePackagingGroupCommandInput, cb: (err: any, data?: DescribePackagingGroupCommandOutput) => void ): void; - public describePackagingGroup( + describePackagingGroup( args: DescribePackagingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePackagingGroupCommandOutput) => void ): void; - public describePackagingGroup( - args: DescribePackagingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePackagingGroupCommandOutput) => void), - cb?: (err: any, data?: DescribePackagingGroupCommandOutput) => void - ): Promise | void { - const command = new DescribePackagingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Returns a collection of MediaPackage VOD Asset resources. + * @see {@link ListAssetsCommand} */ - public listAssets(args: ListAssetsCommandInput, options?: __HttpHandlerOptions): Promise; - public listAssets(args: ListAssetsCommandInput, cb: (err: any, data?: ListAssetsCommandOutput) => void): void; - public listAssets( + listAssets(args: ListAssetsCommandInput, options?: __HttpHandlerOptions): Promise; + listAssets(args: ListAssetsCommandInput, cb: (err: any, data?: ListAssetsCommandOutput) => void): void; + listAssets( args: ListAssetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssetsCommandOutput) => void ): void; - public listAssets( - args: ListAssetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssetsCommandOutput) => void), - cb?: (err: any, data?: ListAssetsCommandOutput) => void - ): Promise | void { - const command = new ListAssetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Returns a collection of MediaPackage VOD PackagingConfiguration resources. + * @see {@link ListPackagingConfigurationsCommand} */ - public listPackagingConfigurations( + listPackagingConfigurations( args: ListPackagingConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPackagingConfigurations( + listPackagingConfigurations( args: ListPackagingConfigurationsCommandInput, cb: (err: any, data?: ListPackagingConfigurationsCommandOutput) => void ): void; - public listPackagingConfigurations( + listPackagingConfigurations( args: ListPackagingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPackagingConfigurationsCommandOutput) => void ): void; - public listPackagingConfigurations( - args: ListPackagingConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPackagingConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListPackagingConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListPackagingConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Returns a collection of MediaPackage VOD PackagingGroup resources. + * @see {@link ListPackagingGroupsCommand} */ - public listPackagingGroups( + listPackagingGroups( args: ListPackagingGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPackagingGroups( + listPackagingGroups( args: ListPackagingGroupsCommandInput, cb: (err: any, data?: ListPackagingGroupsCommandOutput) => void ): void; - public listPackagingGroups( + listPackagingGroups( args: ListPackagingGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPackagingGroupsCommandOutput) => void ): void; - public listPackagingGroups( - args: ListPackagingGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPackagingGroupsCommandOutput) => void), - cb?: (err: any, data?: ListPackagingGroupsCommandOutput) => void - ): Promise | void { - const command = new ListPackagingGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Returns a list of the tags assigned to the specified resource. + * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Adds tags to the specified resource. You can specify one or more tags to add. + * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Removes tags from the specified resource. You can specify one or more tags to remove. + * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Updates a specific packaging group. You can't change the id attribute or any other system-generated attributes. + * @see {@link UpdatePackagingGroupCommand} */ - public updatePackagingGroup( + updatePackagingGroup( args: UpdatePackagingGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePackagingGroup( + updatePackagingGroup( args: UpdatePackagingGroupCommandInput, cb: (err: any, data?: UpdatePackagingGroupCommandOutput) => void ): void; - public updatePackagingGroup( + updatePackagingGroup( args: UpdatePackagingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePackagingGroupCommandOutput) => void ): void; - public updatePackagingGroup( - args: UpdatePackagingGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePackagingGroupCommandOutput) => void), - cb?: (err: any, data?: UpdatePackagingGroupCommandOutput) => void - ): Promise | void { - const command = new UpdatePackagingGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * AWS Elemental MediaPackage VOD + */ +export class MediaPackageVod extends MediaPackageVodClient implements MediaPackageVod {} +createAggregatedClient(commands, MediaPackageVod); diff --git a/clients/client-mediapackage/src/MediaPackage.ts b/clients/client-mediapackage/src/MediaPackage.ts index f4e01757208b..f99c9f884d4b 100644 --- a/clients/client-mediapackage/src/MediaPackage.ts +++ b/clients/client-mediapackage/src/MediaPackage.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -92,627 +93,310 @@ import { UpdateOriginEndpointCommandInput, UpdateOriginEndpointCommandOutput, } from "./commands/UpdateOriginEndpointCommand"; -import { MediaPackageClient } from "./MediaPackageClient"; +import { MediaPackageClient, MediaPackageClientConfig } from "./MediaPackageClient"; -/** - * @public - * AWS Elemental MediaPackage - */ -export class MediaPackage extends MediaPackageClient { +const commands = { + ConfigureLogsCommand, + CreateChannelCommand, + CreateHarvestJobCommand, + CreateOriginEndpointCommand, + DeleteChannelCommand, + DeleteOriginEndpointCommand, + DescribeChannelCommand, + DescribeHarvestJobCommand, + DescribeOriginEndpointCommand, + ListChannelsCommand, + ListHarvestJobsCommand, + ListOriginEndpointsCommand, + ListTagsForResourceCommand, + RotateChannelCredentialsCommand, + RotateIngestEndpointCredentialsCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateChannelCommand, + UpdateOriginEndpointCommand, +}; + +export interface MediaPackage { /** - * @public - * Changes the Channel's properities to configure log subscription + * @see {@link ConfigureLogsCommand} */ - public configureLogs( - args: ConfigureLogsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public configureLogs( - args: ConfigureLogsCommandInput, - cb: (err: any, data?: ConfigureLogsCommandOutput) => void - ): void; - public configureLogs( + configureLogs(args: ConfigureLogsCommandInput, options?: __HttpHandlerOptions): Promise; + configureLogs(args: ConfigureLogsCommandInput, cb: (err: any, data?: ConfigureLogsCommandOutput) => void): void; + configureLogs( args: ConfigureLogsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfigureLogsCommandOutput) => void ): void; - public configureLogs( - args: ConfigureLogsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConfigureLogsCommandOutput) => void), - cb?: (err: any, data?: ConfigureLogsCommandOutput) => void - ): Promise | void { - const command = new ConfigureLogsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Creates a new Channel. + * @see {@link CreateChannelCommand} */ - public createChannel( - args: CreateChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createChannel( - args: CreateChannelCommandInput, - cb: (err: any, data?: CreateChannelCommandOutput) => void - ): void; - public createChannel( + createChannel(args: CreateChannelCommandInput, options?: __HttpHandlerOptions): Promise; + createChannel(args: CreateChannelCommandInput, cb: (err: any, data?: CreateChannelCommandOutput) => void): void; + createChannel( args: CreateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelCommandOutput) => void ): void; - public createChannel( - args: CreateChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateChannelCommandOutput) => void), - cb?: (err: any, data?: CreateChannelCommandOutput) => void - ): Promise | void { - const command = new CreateChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Creates a new HarvestJob record. + * @see {@link CreateHarvestJobCommand} */ - public createHarvestJob( + createHarvestJob( args: CreateHarvestJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createHarvestJob( + createHarvestJob( args: CreateHarvestJobCommandInput, cb: (err: any, data?: CreateHarvestJobCommandOutput) => void ): void; - public createHarvestJob( + createHarvestJob( args: CreateHarvestJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHarvestJobCommandOutput) => void ): void; - public createHarvestJob( - args: CreateHarvestJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateHarvestJobCommandOutput) => void), - cb?: (err: any, data?: CreateHarvestJobCommandOutput) => void - ): Promise | void { - const command = new CreateHarvestJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Creates a new OriginEndpoint record. + * @see {@link CreateOriginEndpointCommand} */ - public createOriginEndpoint( + createOriginEndpoint( args: CreateOriginEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createOriginEndpoint( + createOriginEndpoint( args: CreateOriginEndpointCommandInput, cb: (err: any, data?: CreateOriginEndpointCommandOutput) => void ): void; - public createOriginEndpoint( + createOriginEndpoint( args: CreateOriginEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateOriginEndpointCommandOutput) => void ): void; - public createOriginEndpoint( - args: CreateOriginEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateOriginEndpointCommandOutput) => void), - cb?: (err: any, data?: CreateOriginEndpointCommandOutput) => void - ): Promise | void { - const command = new CreateOriginEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Deletes an existing Channel. + * @see {@link DeleteChannelCommand} */ - public deleteChannel( - args: DeleteChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteChannel( - args: DeleteChannelCommandInput, - cb: (err: any, data?: DeleteChannelCommandOutput) => void - ): void; - public deleteChannel( + deleteChannel(args: DeleteChannelCommandInput, options?: __HttpHandlerOptions): Promise; + deleteChannel(args: DeleteChannelCommandInput, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void; + deleteChannel( args: DeleteChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelCommandOutput) => void ): void; - public deleteChannel( - args: DeleteChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteChannelCommandOutput) => void), - cb?: (err: any, data?: DeleteChannelCommandOutput) => void - ): Promise | void { - const command = new DeleteChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Deletes an existing OriginEndpoint. + * @see {@link DeleteOriginEndpointCommand} */ - public deleteOriginEndpoint( + deleteOriginEndpoint( args: DeleteOriginEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteOriginEndpoint( + deleteOriginEndpoint( args: DeleteOriginEndpointCommandInput, cb: (err: any, data?: DeleteOriginEndpointCommandOutput) => void ): void; - public deleteOriginEndpoint( + deleteOriginEndpoint( args: DeleteOriginEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOriginEndpointCommandOutput) => void ): void; - public deleteOriginEndpoint( - args: DeleteOriginEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteOriginEndpointCommandOutput) => void), - cb?: (err: any, data?: DeleteOriginEndpointCommandOutput) => void - ): Promise | void { - const command = new DeleteOriginEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Gets details about a Channel. + * @see {@link DescribeChannelCommand} */ - public describeChannel( + describeChannel( args: DescribeChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeChannel( - args: DescribeChannelCommandInput, - cb: (err: any, data?: DescribeChannelCommandOutput) => void - ): void; - public describeChannel( + describeChannel(args: DescribeChannelCommandInput, cb: (err: any, data?: DescribeChannelCommandOutput) => void): void; + describeChannel( args: DescribeChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelCommandOutput) => void ): void; - public describeChannel( - args: DescribeChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeChannelCommandOutput) => void), - cb?: (err: any, data?: DescribeChannelCommandOutput) => void - ): Promise | void { - const command = new DescribeChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Gets details about an existing HarvestJob. + * @see {@link DescribeHarvestJobCommand} */ - public describeHarvestJob( + describeHarvestJob( args: DescribeHarvestJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeHarvestJob( + describeHarvestJob( args: DescribeHarvestJobCommandInput, cb: (err: any, data?: DescribeHarvestJobCommandOutput) => void ): void; - public describeHarvestJob( + describeHarvestJob( args: DescribeHarvestJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHarvestJobCommandOutput) => void ): void; - public describeHarvestJob( - args: DescribeHarvestJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeHarvestJobCommandOutput) => void), - cb?: (err: any, data?: DescribeHarvestJobCommandOutput) => void - ): Promise | void { - const command = new DescribeHarvestJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Gets details about an existing OriginEndpoint. + * @see {@link DescribeOriginEndpointCommand} */ - public describeOriginEndpoint( + describeOriginEndpoint( args: DescribeOriginEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOriginEndpoint( + describeOriginEndpoint( args: DescribeOriginEndpointCommandInput, cb: (err: any, data?: DescribeOriginEndpointCommandOutput) => void ): void; - public describeOriginEndpoint( + describeOriginEndpoint( args: DescribeOriginEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOriginEndpointCommandOutput) => void ): void; - public describeOriginEndpoint( - args: DescribeOriginEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOriginEndpointCommandOutput) => void), - cb?: (err: any, data?: DescribeOriginEndpointCommandOutput) => void - ): Promise | void { - const command = new DescribeOriginEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Returns a collection of Channels. + * @see {@link ListChannelsCommand} */ - public listChannels( - args: ListChannelsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void; - public listChannels( + listChannels(args: ListChannelsCommandInput, options?: __HttpHandlerOptions): Promise; + listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void; + listChannels( args: ListChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsCommandOutput) => void ): void; - public listChannels( - args: ListChannelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListChannelsCommandOutput) => void), - cb?: (err: any, data?: ListChannelsCommandOutput) => void - ): Promise | void { - const command = new ListChannelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Returns a collection of HarvestJob records. + * @see {@link ListHarvestJobsCommand} */ - public listHarvestJobs( + listHarvestJobs( args: ListHarvestJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listHarvestJobs( - args: ListHarvestJobsCommandInput, - cb: (err: any, data?: ListHarvestJobsCommandOutput) => void - ): void; - public listHarvestJobs( + listHarvestJobs(args: ListHarvestJobsCommandInput, cb: (err: any, data?: ListHarvestJobsCommandOutput) => void): void; + listHarvestJobs( args: ListHarvestJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHarvestJobsCommandOutput) => void ): void; - public listHarvestJobs( - args: ListHarvestJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListHarvestJobsCommandOutput) => void), - cb?: (err: any, data?: ListHarvestJobsCommandOutput) => void - ): Promise | void { - const command = new ListHarvestJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Returns a collection of OriginEndpoint records. + * @see {@link ListOriginEndpointsCommand} */ - public listOriginEndpoints( + listOriginEndpoints( args: ListOriginEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOriginEndpoints( + listOriginEndpoints( args: ListOriginEndpointsCommandInput, cb: (err: any, data?: ListOriginEndpointsCommandOutput) => void ): void; - public listOriginEndpoints( + listOriginEndpoints( args: ListOriginEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOriginEndpointsCommandOutput) => void ): void; - public listOriginEndpoints( - args: ListOriginEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOriginEndpointsCommandOutput) => void), - cb?: (err: any, data?: ListOriginEndpointsCommandOutput) => void - ): Promise | void { - const command = new ListOriginEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - * Changes the Channel's first IngestEndpoint's username and password. WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials instead + * @see {@link RotateChannelCredentialsCommand} */ - public rotateChannelCredentials( + rotateChannelCredentials( args: RotateChannelCredentialsCommandInput, options?: __HttpHandlerOptions ): Promise; - public rotateChannelCredentials( + rotateChannelCredentials( args: RotateChannelCredentialsCommandInput, cb: (err: any, data?: RotateChannelCredentialsCommandOutput) => void ): void; - public rotateChannelCredentials( + rotateChannelCredentials( args: RotateChannelCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RotateChannelCredentialsCommandOutput) => void ): void; - public rotateChannelCredentials( - args: RotateChannelCredentialsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RotateChannelCredentialsCommandOutput) => void), - cb?: (err: any, data?: RotateChannelCredentialsCommandOutput) => void - ): Promise | void { - const command = new RotateChannelCredentialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id. + * @see {@link RotateIngestEndpointCredentialsCommand} */ - public rotateIngestEndpointCredentials( + rotateIngestEndpointCredentials( args: RotateIngestEndpointCredentialsCommandInput, options?: __HttpHandlerOptions ): Promise; - public rotateIngestEndpointCredentials( + rotateIngestEndpointCredentials( args: RotateIngestEndpointCredentialsCommandInput, cb: (err: any, data?: RotateIngestEndpointCredentialsCommandOutput) => void ): void; - public rotateIngestEndpointCredentials( + rotateIngestEndpointCredentials( args: RotateIngestEndpointCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RotateIngestEndpointCredentialsCommandOutput) => void ): void; - public rotateIngestEndpointCredentials( - args: RotateIngestEndpointCredentialsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RotateIngestEndpointCredentialsCommandOutput) => void), - cb?: (err: any, data?: RotateIngestEndpointCredentialsCommandOutput) => void - ): Promise | void { - const command = new RotateIngestEndpointCredentialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Updates an existing Channel. + * @see {@link UpdateChannelCommand} */ - public updateChannel( - args: UpdateChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateChannel( - args: UpdateChannelCommandInput, - cb: (err: any, data?: UpdateChannelCommandOutput) => void - ): void; - public updateChannel( + updateChannel(args: UpdateChannelCommandInput, options?: __HttpHandlerOptions): Promise; + updateChannel(args: UpdateChannelCommandInput, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void; + updateChannel( args: UpdateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelCommandOutput) => void ): void; - public updateChannel( - args: UpdateChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateChannelCommandOutput) => void), - cb?: (err: any, data?: UpdateChannelCommandOutput) => void - ): Promise | void { - const command = new UpdateChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Updates an existing OriginEndpoint. + * @see {@link UpdateOriginEndpointCommand} */ - public updateOriginEndpoint( + updateOriginEndpoint( args: UpdateOriginEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateOriginEndpoint( + updateOriginEndpoint( args: UpdateOriginEndpointCommandInput, cb: (err: any, data?: UpdateOriginEndpointCommandOutput) => void ): void; - public updateOriginEndpoint( + updateOriginEndpoint( args: UpdateOriginEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateOriginEndpointCommandOutput) => void ): void; - public updateOriginEndpoint( - args: UpdateOriginEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateOriginEndpointCommandOutput) => void), - cb?: (err: any, data?: UpdateOriginEndpointCommandOutput) => void - ): Promise | void { - const command = new UpdateOriginEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * AWS Elemental MediaPackage + */ +export class MediaPackage extends MediaPackageClient implements MediaPackage {} +createAggregatedClient(commands, MediaPackage); diff --git a/clients/client-mediastore-data/src/MediaStoreData.ts b/clients/client-mediastore-data/src/MediaStoreData.ts index 684ba03df22a..92e54bb8e2c7 100644 --- a/clients/client-mediastore-data/src/MediaStoreData.ts +++ b/clients/client-mediastore-data/src/MediaStoreData.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -14,157 +15,81 @@ import { import { GetObjectCommand, GetObjectCommandInput, GetObjectCommandOutput } from "./commands/GetObjectCommand"; import { ListItemsCommand, ListItemsCommandInput, ListItemsCommandOutput } from "./commands/ListItemsCommand"; import { PutObjectCommand, PutObjectCommandInput, PutObjectCommandOutput } from "./commands/PutObjectCommand"; -import { MediaStoreDataClient } from "./MediaStoreDataClient"; +import { MediaStoreDataClient, MediaStoreDataClientConfig } from "./MediaStoreDataClient"; -/** - * @public - *

An AWS Elemental MediaStore asset is an object, similar to an object in the Amazon S3 - * service. Objects are the fundamental entities that are stored in AWS Elemental - * MediaStore.

- */ -export class MediaStoreData extends MediaStoreDataClient { +const commands = { + DeleteObjectCommand, + DescribeObjectCommand, + GetObjectCommand, + ListItemsCommand, + PutObjectCommand, +}; + +export interface MediaStoreData { /** - * @public - *

Deletes an object at the specified path.

+ * @see {@link DeleteObjectCommand} */ - public deleteObject( - args: DeleteObjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteObject(args: DeleteObjectCommandInput, cb: (err: any, data?: DeleteObjectCommandOutput) => void): void; - public deleteObject( + deleteObject(args: DeleteObjectCommandInput, options?: __HttpHandlerOptions): Promise; + deleteObject(args: DeleteObjectCommandInput, cb: (err: any, data?: DeleteObjectCommandOutput) => void): void; + deleteObject( args: DeleteObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteObjectCommandOutput) => void ): void; - public deleteObject( - args: DeleteObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteObjectCommandOutput) => void), - cb?: (err: any, data?: DeleteObjectCommandOutput) => void - ): Promise | void { - const command = new DeleteObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the headers for an object at the specified path.

+ * @see {@link DescribeObjectCommand} */ - public describeObject( + describeObject( args: DescribeObjectCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeObject( - args: DescribeObjectCommandInput, - cb: (err: any, data?: DescribeObjectCommandOutput) => void - ): void; - public describeObject( + describeObject(args: DescribeObjectCommandInput, cb: (err: any, data?: DescribeObjectCommandOutput) => void): void; + describeObject( args: DescribeObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeObjectCommandOutput) => void ): void; - public describeObject( - args: DescribeObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeObjectCommandOutput) => void), - cb?: (err: any, data?: DescribeObjectCommandOutput) => void - ): Promise | void { - const command = new DescribeObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Downloads the object at the specified path. If the object’s upload availability is set to streaming, AWS Elemental MediaStore downloads the object even if it’s still uploading the object.

+ * @see {@link GetObjectCommand} */ - public getObject(args: GetObjectCommandInput, options?: __HttpHandlerOptions): Promise; - public getObject(args: GetObjectCommandInput, cb: (err: any, data?: GetObjectCommandOutput) => void): void; - public getObject( + getObject(args: GetObjectCommandInput, options?: __HttpHandlerOptions): Promise; + getObject(args: GetObjectCommandInput, cb: (err: any, data?: GetObjectCommandOutput) => void): void; + getObject( args: GetObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetObjectCommandOutput) => void ): void; - public getObject( - args: GetObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetObjectCommandOutput) => void), - cb?: (err: any, data?: GetObjectCommandOutput) => void - ): Promise | void { - const command = new GetObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a list of metadata entries about folders and objects in the specified - * folder.

+ * @see {@link ListItemsCommand} */ - public listItems(args: ListItemsCommandInput, options?: __HttpHandlerOptions): Promise; - public listItems(args: ListItemsCommandInput, cb: (err: any, data?: ListItemsCommandOutput) => void): void; - public listItems( + listItems(args: ListItemsCommandInput, options?: __HttpHandlerOptions): Promise; + listItems(args: ListItemsCommandInput, cb: (err: any, data?: ListItemsCommandOutput) => void): void; + listItems( args: ListItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListItemsCommandOutput) => void ): void; - public listItems( - args: ListItemsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListItemsCommandOutput) => void), - cb?: (err: any, data?: ListItemsCommandOutput) => void - ): Promise | void { - const command = new ListItemsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Uploads an object to the specified path. Object sizes are limited to 25 MB for standard upload availability and 10 MB for streaming upload availability.

+ * @see {@link PutObjectCommand} */ - public putObject(args: PutObjectCommandInput, options?: __HttpHandlerOptions): Promise; - public putObject(args: PutObjectCommandInput, cb: (err: any, data?: PutObjectCommandOutput) => void): void; - public putObject( + putObject(args: PutObjectCommandInput, options?: __HttpHandlerOptions): Promise; + putObject(args: PutObjectCommandInput, cb: (err: any, data?: PutObjectCommandOutput) => void): void; + putObject( args: PutObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutObjectCommandOutput) => void ): void; - public putObject( - args: PutObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutObjectCommandOutput) => void), - cb?: (err: any, data?: PutObjectCommandOutput) => void - ): Promise | void { - const command = new PutObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

An AWS Elemental MediaStore asset is an object, similar to an object in the Amazon S3 + * service. Objects are the fundamental entities that are stored in AWS Elemental + * MediaStore.

+ */ +export class MediaStoreData extends MediaStoreDataClient implements MediaStoreData {} +createAggregatedClient(commands, MediaStoreData); diff --git a/clients/client-mediastore/src/MediaStore.ts b/clients/client-mediastore/src/MediaStore.ts index 8cf07fda151e..6d1c75d740d9 100644 --- a/clients/client-mediastore/src/MediaStore.ts +++ b/clients/client-mediastore/src/MediaStore.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -102,744 +103,356 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; -import { MediaStoreClient } from "./MediaStoreClient"; +import { MediaStoreClient, MediaStoreClientConfig } from "./MediaStoreClient"; -/** - * @public - *

An AWS Elemental MediaStore container is a namespace that holds folders and objects. - * You use a container endpoint to create, read, and delete objects.

- */ -export class MediaStore extends MediaStoreClient { +const commands = { + CreateContainerCommand, + DeleteContainerCommand, + DeleteContainerPolicyCommand, + DeleteCorsPolicyCommand, + DeleteLifecyclePolicyCommand, + DeleteMetricPolicyCommand, + DescribeContainerCommand, + GetContainerPolicyCommand, + GetCorsPolicyCommand, + GetLifecyclePolicyCommand, + GetMetricPolicyCommand, + ListContainersCommand, + ListTagsForResourceCommand, + PutContainerPolicyCommand, + PutCorsPolicyCommand, + PutLifecyclePolicyCommand, + PutMetricPolicyCommand, + StartAccessLoggingCommand, + StopAccessLoggingCommand, + TagResourceCommand, + UntagResourceCommand, +}; + +export interface MediaStore { /** - * @public - *

Creates a storage container to hold objects. A container is similar to a bucket in - * the Amazon S3 service.

+ * @see {@link CreateContainerCommand} */ - public createContainer( + createContainer( args: CreateContainerCommandInput, options?: __HttpHandlerOptions ): Promise; - public createContainer( - args: CreateContainerCommandInput, - cb: (err: any, data?: CreateContainerCommandOutput) => void - ): void; - public createContainer( + createContainer(args: CreateContainerCommandInput, cb: (err: any, data?: CreateContainerCommandOutput) => void): void; + createContainer( args: CreateContainerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateContainerCommandOutput) => void ): void; - public createContainer( - args: CreateContainerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateContainerCommandOutput) => void), - cb?: (err: any, data?: CreateContainerCommandOutput) => void - ): Promise | void { - const command = new CreateContainerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified container. Before you make a DeleteContainer - * request, delete any objects in the container or in any folders in the container. You can - * delete only empty containers.

+ * @see {@link DeleteContainerCommand} */ - public deleteContainer( + deleteContainer( args: DeleteContainerCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteContainer( - args: DeleteContainerCommandInput, - cb: (err: any, data?: DeleteContainerCommandOutput) => void - ): void; - public deleteContainer( + deleteContainer(args: DeleteContainerCommandInput, cb: (err: any, data?: DeleteContainerCommandOutput) => void): void; + deleteContainer( args: DeleteContainerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteContainerCommandOutput) => void ): void; - public deleteContainer( - args: DeleteContainerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteContainerCommandOutput) => void), - cb?: (err: any, data?: DeleteContainerCommandOutput) => void - ): Promise | void { - const command = new DeleteContainerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the access policy that is associated with the specified container.

+ * @see {@link DeleteContainerPolicyCommand} */ - public deleteContainerPolicy( + deleteContainerPolicy( args: DeleteContainerPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteContainerPolicy( + deleteContainerPolicy( args: DeleteContainerPolicyCommandInput, cb: (err: any, data?: DeleteContainerPolicyCommandOutput) => void ): void; - public deleteContainerPolicy( + deleteContainerPolicy( args: DeleteContainerPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteContainerPolicyCommandOutput) => void ): void; - public deleteContainerPolicy( - args: DeleteContainerPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteContainerPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteContainerPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteContainerPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the cross-origin resource sharing (CORS) configuration information that is - * set for the container.

- *

To use this operation, you must have permission to perform the - * MediaStore:DeleteCorsPolicy action. The container owner has this permission - * by default and can grant this permission to others.

+ * @see {@link DeleteCorsPolicyCommand} */ - public deleteCorsPolicy( + deleteCorsPolicy( args: DeleteCorsPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCorsPolicy( + deleteCorsPolicy( args: DeleteCorsPolicyCommandInput, cb: (err: any, data?: DeleteCorsPolicyCommandOutput) => void ): void; - public deleteCorsPolicy( + deleteCorsPolicy( args: DeleteCorsPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCorsPolicyCommandOutput) => void ): void; - public deleteCorsPolicy( - args: DeleteCorsPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCorsPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteCorsPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteCorsPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes an object lifecycle policy from a container. It takes up to 20 minutes for the change to take effect.

+ * @see {@link DeleteLifecyclePolicyCommand} */ - public deleteLifecyclePolicy( + deleteLifecyclePolicy( args: DeleteLifecyclePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLifecyclePolicy( + deleteLifecyclePolicy( args: DeleteLifecyclePolicyCommandInput, cb: (err: any, data?: DeleteLifecyclePolicyCommandOutput) => void ): void; - public deleteLifecyclePolicy( + deleteLifecyclePolicy( args: DeleteLifecyclePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLifecyclePolicyCommandOutput) => void ): void; - public deleteLifecyclePolicy( - args: DeleteLifecyclePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLifecyclePolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteLifecyclePolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteLifecyclePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the metric policy that is associated with the specified container. If there is no metric policy associated with the container, MediaStore doesn't send metrics to CloudWatch.

+ * @see {@link DeleteMetricPolicyCommand} */ - public deleteMetricPolicy( + deleteMetricPolicy( args: DeleteMetricPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMetricPolicy( + deleteMetricPolicy( args: DeleteMetricPolicyCommandInput, cb: (err: any, data?: DeleteMetricPolicyCommandOutput) => void ): void; - public deleteMetricPolicy( + deleteMetricPolicy( args: DeleteMetricPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMetricPolicyCommandOutput) => void ): void; - public deleteMetricPolicy( - args: DeleteMetricPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMetricPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteMetricPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteMetricPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the properties of the requested container. This request is commonly used to - * retrieve the endpoint of a container. An endpoint is a value assigned by the service when a - * new container is created. A container's endpoint does not change after it has been - * assigned. The DescribeContainer request returns a single - * Container object based on ContainerName. To return all - * Container objects that are associated with a specified AWS account, use - * ListContainers.

+ * @see {@link DescribeContainerCommand} */ - public describeContainer( + describeContainer( args: DescribeContainerCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeContainer( + describeContainer( args: DescribeContainerCommandInput, cb: (err: any, data?: DescribeContainerCommandOutput) => void ): void; - public describeContainer( + describeContainer( args: DescribeContainerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeContainerCommandOutput) => void ): void; - public describeContainer( - args: DescribeContainerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeContainerCommandOutput) => void), - cb?: (err: any, data?: DescribeContainerCommandOutput) => void - ): Promise | void { - const command = new DescribeContainerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the access policy for the specified container. For information about the - * data that is included in an access policy, see the AWS Identity and Access Management User - * Guide.

+ * @see {@link GetContainerPolicyCommand} */ - public getContainerPolicy( + getContainerPolicy( args: GetContainerPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getContainerPolicy( + getContainerPolicy( args: GetContainerPolicyCommandInput, cb: (err: any, data?: GetContainerPolicyCommandOutput) => void ): void; - public getContainerPolicy( + getContainerPolicy( args: GetContainerPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContainerPolicyCommandOutput) => void ): void; - public getContainerPolicy( - args: GetContainerPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContainerPolicyCommandOutput) => void), - cb?: (err: any, data?: GetContainerPolicyCommandOutput) => void - ): Promise | void { - const command = new GetContainerPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the cross-origin resource sharing (CORS) configuration information that is - * set for the container.

- *

To use this operation, you must have permission to perform the - * MediaStore:GetCorsPolicy action. By default, the container owner has this - * permission and can grant it to others.

+ * @see {@link GetCorsPolicyCommand} */ - public getCorsPolicy( - args: GetCorsPolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getCorsPolicy( - args: GetCorsPolicyCommandInput, - cb: (err: any, data?: GetCorsPolicyCommandOutput) => void - ): void; - public getCorsPolicy( + getCorsPolicy(args: GetCorsPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + getCorsPolicy(args: GetCorsPolicyCommandInput, cb: (err: any, data?: GetCorsPolicyCommandOutput) => void): void; + getCorsPolicy( args: GetCorsPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCorsPolicyCommandOutput) => void ): void; - public getCorsPolicy( - args: GetCorsPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCorsPolicyCommandOutput) => void), - cb?: (err: any, data?: GetCorsPolicyCommandOutput) => void - ): Promise | void { - const command = new GetCorsPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the object lifecycle policy that is assigned to a container.

+ * @see {@link GetLifecyclePolicyCommand} */ - public getLifecyclePolicy( + getLifecyclePolicy( args: GetLifecyclePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLifecyclePolicy( + getLifecyclePolicy( args: GetLifecyclePolicyCommandInput, cb: (err: any, data?: GetLifecyclePolicyCommandOutput) => void ): void; - public getLifecyclePolicy( + getLifecyclePolicy( args: GetLifecyclePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLifecyclePolicyCommandOutput) => void ): void; - public getLifecyclePolicy( - args: GetLifecyclePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLifecyclePolicyCommandOutput) => void), - cb?: (err: any, data?: GetLifecyclePolicyCommandOutput) => void - ): Promise | void { - const command = new GetLifecyclePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the metric policy for the specified container.

+ * @see {@link GetMetricPolicyCommand} */ - public getMetricPolicy( + getMetricPolicy( args: GetMetricPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMetricPolicy( - args: GetMetricPolicyCommandInput, - cb: (err: any, data?: GetMetricPolicyCommandOutput) => void - ): void; - public getMetricPolicy( + getMetricPolicy(args: GetMetricPolicyCommandInput, cb: (err: any, data?: GetMetricPolicyCommandOutput) => void): void; + getMetricPolicy( args: GetMetricPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMetricPolicyCommandOutput) => void ): void; - public getMetricPolicy( - args: GetMetricPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMetricPolicyCommandOutput) => void), - cb?: (err: any, data?: GetMetricPolicyCommandOutput) => void - ): Promise | void { - const command = new GetMetricPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the properties of all containers in AWS Elemental MediaStore.

- *

You can query to receive all the containers in one response. Or you can include the - * MaxResults parameter to receive a limited number of containers in each - * response. In this case, the response includes a token. To get the next set of containers, - * send the command again, this time with the NextToken parameter (with the - * returned token as its value). The next set of responses appears, with a token if there are - * still more containers to receive.

- *

See also DescribeContainer, which gets the properties of one - * container.

+ * @see {@link ListContainersCommand} */ - public listContainers( + listContainers( args: ListContainersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listContainers( - args: ListContainersCommandInput, - cb: (err: any, data?: ListContainersCommandOutput) => void - ): void; - public listContainers( + listContainers(args: ListContainersCommandInput, cb: (err: any, data?: ListContainersCommandOutput) => void): void; + listContainers( args: ListContainersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListContainersCommandOutput) => void ): void; - public listContainers( - args: ListContainersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListContainersCommandOutput) => void), - cb?: (err: any, data?: ListContainersCommandOutput) => void - ): Promise | void { - const command = new ListContainersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the tags assigned to the specified container.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an access policy for the specified container to restrict the users and - * clients that can access it. For information about the data that is included in an access - * policy, see the AWS Identity and - * Access Management User Guide.

- *

For this release of the REST API, you can create only one policy for a container. If - * you enter PutContainerPolicy twice, the second command modifies the existing - * policy.

+ * @see {@link PutContainerPolicyCommand} */ - public putContainerPolicy( + putContainerPolicy( args: PutContainerPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putContainerPolicy( + putContainerPolicy( args: PutContainerPolicyCommandInput, cb: (err: any, data?: PutContainerPolicyCommandOutput) => void ): void; - public putContainerPolicy( + putContainerPolicy( args: PutContainerPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutContainerPolicyCommandOutput) => void ): void; - public putContainerPolicy( - args: PutContainerPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutContainerPolicyCommandOutput) => void), - cb?: (err: any, data?: PutContainerPolicyCommandOutput) => void - ): Promise | void { - const command = new PutContainerPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the cross-origin resource sharing (CORS) configuration on a container so that - * the container can service cross-origin requests. For example, you might want to enable a - * request whose origin is http://www.example.com to access your AWS Elemental MediaStore - * container at my.example.container.com by using the browser's XMLHttpRequest - * capability.

- *

To enable CORS on a container, you attach a CORS policy to the container. In the CORS - * policy, you configure rules that identify origins and the HTTP methods that can be executed - * on your container. The policy can contain up to 398,000 characters. You can add up to 100 - * rules to a CORS policy. If more than one rule applies, the service uses the first - * applicable rule listed.

- *

To learn more about CORS, see Cross-Origin Resource Sharing (CORS) in AWS Elemental MediaStore.

+ * @see {@link PutCorsPolicyCommand} */ - public putCorsPolicy( - args: PutCorsPolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putCorsPolicy( - args: PutCorsPolicyCommandInput, - cb: (err: any, data?: PutCorsPolicyCommandOutput) => void - ): void; - public putCorsPolicy( + putCorsPolicy(args: PutCorsPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + putCorsPolicy(args: PutCorsPolicyCommandInput, cb: (err: any, data?: PutCorsPolicyCommandOutput) => void): void; + putCorsPolicy( args: PutCorsPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutCorsPolicyCommandOutput) => void ): void; - public putCorsPolicy( - args: PutCorsPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutCorsPolicyCommandOutput) => void), - cb?: (err: any, data?: PutCorsPolicyCommandOutput) => void - ): Promise | void { - const command = new PutCorsPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Writes an object lifecycle policy to a container. If the container already has an object lifecycle policy, the service replaces the existing policy with the new policy. It takes up to 20 minutes for the change to take effect.

- *

For information about how to construct an object lifecycle policy, see Components of an Object Lifecycle Policy.

+ * @see {@link PutLifecyclePolicyCommand} */ - public putLifecyclePolicy( + putLifecyclePolicy( args: PutLifecyclePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putLifecyclePolicy( + putLifecyclePolicy( args: PutLifecyclePolicyCommandInput, cb: (err: any, data?: PutLifecyclePolicyCommandOutput) => void ): void; - public putLifecyclePolicy( + putLifecyclePolicy( args: PutLifecyclePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLifecyclePolicyCommandOutput) => void ): void; - public putLifecyclePolicy( - args: PutLifecyclePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutLifecyclePolicyCommandOutput) => void), - cb?: (err: any, data?: PutLifecyclePolicyCommandOutput) => void - ): Promise | void { - const command = new PutLifecyclePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The metric policy that you want to add to the container. A metric policy allows AWS Elemental MediaStore to send metrics to Amazon CloudWatch. It takes up to 20 minutes for the new policy to take effect.

+ * @see {@link PutMetricPolicyCommand} */ - public putMetricPolicy( + putMetricPolicy( args: PutMetricPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putMetricPolicy( - args: PutMetricPolicyCommandInput, - cb: (err: any, data?: PutMetricPolicyCommandOutput) => void - ): void; - public putMetricPolicy( + putMetricPolicy(args: PutMetricPolicyCommandInput, cb: (err: any, data?: PutMetricPolicyCommandOutput) => void): void; + putMetricPolicy( args: PutMetricPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMetricPolicyCommandOutput) => void ): void; - public putMetricPolicy( - args: PutMetricPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutMetricPolicyCommandOutput) => void), - cb?: (err: any, data?: PutMetricPolicyCommandOutput) => void - ): Promise | void { - const command = new PutMetricPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts access logging on the specified container. When you enable access logging on a container, MediaStore delivers access logs for objects stored in that container to Amazon CloudWatch Logs.

+ * @see {@link StartAccessLoggingCommand} */ - public startAccessLogging( + startAccessLogging( args: StartAccessLoggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public startAccessLogging( + startAccessLogging( args: StartAccessLoggingCommandInput, cb: (err: any, data?: StartAccessLoggingCommandOutput) => void ): void; - public startAccessLogging( + startAccessLogging( args: StartAccessLoggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartAccessLoggingCommandOutput) => void ): void; - public startAccessLogging( - args: StartAccessLoggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartAccessLoggingCommandOutput) => void), - cb?: (err: any, data?: StartAccessLoggingCommandOutput) => void - ): Promise | void { - const command = new StartAccessLoggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops access logging on the specified container. When you stop access logging on a container, MediaStore stops sending access logs to Amazon CloudWatch Logs. These access logs are not saved and are not retrievable.

+ * @see {@link StopAccessLoggingCommand} */ - public stopAccessLogging( + stopAccessLogging( args: StopAccessLoggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopAccessLogging( + stopAccessLogging( args: StopAccessLoggingCommandInput, cb: (err: any, data?: StopAccessLoggingCommandOutput) => void ): void; - public stopAccessLogging( + stopAccessLogging( args: StopAccessLoggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopAccessLoggingCommandOutput) => void ): void; - public stopAccessLogging( - args: StopAccessLoggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopAccessLoggingCommandOutput) => void), - cb?: (err: any, data?: StopAccessLoggingCommandOutput) => void - ): Promise | void { - const command = new StopAccessLoggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds tags to the specified AWS Elemental MediaStore container. Tags are key:value pairs that you can associate with AWS resources. For example, the - * tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 - * tags to each container. For more information about tagging, including naming and usage conventions, see Tagging Resources in MediaStore.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from the specified container. You can specify one or more tags to remove.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

An AWS Elemental MediaStore container is a namespace that holds folders and objects. + * You use a container endpoint to create, read, and delete objects.

+ */ +export class MediaStore extends MediaStoreClient implements MediaStore {} +createAggregatedClient(commands, MediaStore); diff --git a/clients/client-mediatailor/src/MediaTailor.ts b/clients/client-mediatailor/src/MediaTailor.ts index e34e2e8fe177..3703cc815366 100644 --- a/clients/client-mediatailor/src/MediaTailor.ts +++ b/clients/client-mediatailor/src/MediaTailor.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -209,1441 +210,716 @@ import { UpdateVodSourceCommandInput, UpdateVodSourceCommandOutput, } from "./commands/UpdateVodSourceCommand"; -import { MediaTailorClient } from "./MediaTailorClient"; +import { MediaTailorClient, MediaTailorClientConfig } from "./MediaTailorClient"; -/** - * @public - *

Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad insertion and linear channels. With MediaTailor, you can assemble existing content into a linear stream and serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the AWS Elemental MediaTailor User Guide.

- *

Through the SDKs and the CLI you manage AWS Elemental MediaTailor configurations and channels the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).

- */ -export class MediaTailor extends MediaTailorClient { +const commands = { + ConfigureLogsForChannelCommand, + ConfigureLogsForPlaybackConfigurationCommand, + CreateChannelCommand, + CreateLiveSourceCommand, + CreatePrefetchScheduleCommand, + CreateProgramCommand, + CreateSourceLocationCommand, + CreateVodSourceCommand, + DeleteChannelCommand, + DeleteChannelPolicyCommand, + DeleteLiveSourceCommand, + DeletePlaybackConfigurationCommand, + DeletePrefetchScheduleCommand, + DeleteProgramCommand, + DeleteSourceLocationCommand, + DeleteVodSourceCommand, + DescribeChannelCommand, + DescribeLiveSourceCommand, + DescribeProgramCommand, + DescribeSourceLocationCommand, + DescribeVodSourceCommand, + GetChannelPolicyCommand, + GetChannelScheduleCommand, + GetPlaybackConfigurationCommand, + GetPrefetchScheduleCommand, + ListAlertsCommand, + ListChannelsCommand, + ListLiveSourcesCommand, + ListPlaybackConfigurationsCommand, + ListPrefetchSchedulesCommand, + ListSourceLocationsCommand, + ListTagsForResourceCommand, + ListVodSourcesCommand, + PutChannelPolicyCommand, + PutPlaybackConfigurationCommand, + StartChannelCommand, + StopChannelCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateChannelCommand, + UpdateLiveSourceCommand, + UpdateProgramCommand, + UpdateSourceLocationCommand, + UpdateVodSourceCommand, +}; + +export interface MediaTailor { /** - * @public - *

Configures Amazon CloudWatch log settings for a channel.

+ * @see {@link ConfigureLogsForChannelCommand} */ - public configureLogsForChannel( + configureLogsForChannel( args: ConfigureLogsForChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public configureLogsForChannel( + configureLogsForChannel( args: ConfigureLogsForChannelCommandInput, cb: (err: any, data?: ConfigureLogsForChannelCommandOutput) => void ): void; - public configureLogsForChannel( + configureLogsForChannel( args: ConfigureLogsForChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfigureLogsForChannelCommandOutput) => void ): void; - public configureLogsForChannel( - args: ConfigureLogsForChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConfigureLogsForChannelCommandOutput) => void), - cb?: (err: any, data?: ConfigureLogsForChannelCommandOutput) => void - ): Promise | void { - const command = new ConfigureLogsForChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Amazon CloudWatch log settings for a playback configuration.

+ * @see {@link ConfigureLogsForPlaybackConfigurationCommand} */ - public configureLogsForPlaybackConfiguration( + configureLogsForPlaybackConfiguration( args: ConfigureLogsForPlaybackConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public configureLogsForPlaybackConfiguration( + configureLogsForPlaybackConfiguration( args: ConfigureLogsForPlaybackConfigurationCommandInput, cb: (err: any, data?: ConfigureLogsForPlaybackConfigurationCommandOutput) => void ): void; - public configureLogsForPlaybackConfiguration( + configureLogsForPlaybackConfiguration( args: ConfigureLogsForPlaybackConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfigureLogsForPlaybackConfigurationCommandOutput) => void ): void; - public configureLogsForPlaybackConfiguration( - args: ConfigureLogsForPlaybackConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ConfigureLogsForPlaybackConfigurationCommandOutput) => void), - cb?: (err: any, data?: ConfigureLogsForPlaybackConfigurationCommandOutput) => void - ): Promise | void { - const command = new ConfigureLogsForPlaybackConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

+ * @see {@link CreateChannelCommand} */ - public createChannel( - args: CreateChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createChannel( - args: CreateChannelCommandInput, - cb: (err: any, data?: CreateChannelCommandOutput) => void - ): void; - public createChannel( + createChannel(args: CreateChannelCommandInput, options?: __HttpHandlerOptions): Promise; + createChannel(args: CreateChannelCommandInput, cb: (err: any, data?: CreateChannelCommandOutput) => void): void; + createChannel( args: CreateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelCommandOutput) => void ): void; - public createChannel( - args: CreateChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateChannelCommandOutput) => void), - cb?: (err: any, data?: CreateChannelCommandOutput) => void - ): Promise | void { - const command = new CreateChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The live source configuration.

+ * @see {@link CreateLiveSourceCommand} */ - public createLiveSource( + createLiveSource( args: CreateLiveSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLiveSource( + createLiveSource( args: CreateLiveSourceCommandInput, cb: (err: any, data?: CreateLiveSourceCommandOutput) => void ): void; - public createLiveSource( + createLiveSource( args: CreateLiveSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLiveSourceCommandOutput) => void ): void; - public createLiveSource( - args: CreateLiveSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLiveSourceCommandOutput) => void), - cb?: (err: any, data?: CreateLiveSourceCommandOutput) => void - ): Promise | void { - const command = new CreateLiveSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.

+ * @see {@link CreatePrefetchScheduleCommand} */ - public createPrefetchSchedule( + createPrefetchSchedule( args: CreatePrefetchScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPrefetchSchedule( + createPrefetchSchedule( args: CreatePrefetchScheduleCommandInput, cb: (err: any, data?: CreatePrefetchScheduleCommandOutput) => void ): void; - public createPrefetchSchedule( + createPrefetchSchedule( args: CreatePrefetchScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePrefetchScheduleCommandOutput) => void ): void; - public createPrefetchSchedule( - args: CreatePrefetchScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePrefetchScheduleCommandOutput) => void), - cb?: (err: any, data?: CreatePrefetchScheduleCommandOutput) => void - ): Promise | void { - const command = new CreatePrefetchScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.

+ * @see {@link CreateProgramCommand} */ - public createProgram( - args: CreateProgramCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createProgram( - args: CreateProgramCommandInput, - cb: (err: any, data?: CreateProgramCommandOutput) => void - ): void; - public createProgram( + createProgram(args: CreateProgramCommandInput, options?: __HttpHandlerOptions): Promise; + createProgram(args: CreateProgramCommandInput, cb: (err: any, data?: CreateProgramCommandOutput) => void): void; + createProgram( args: CreateProgramCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProgramCommandOutput) => void ): void; - public createProgram( - args: CreateProgramCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProgramCommandOutput) => void), - cb?: (err: any, data?: CreateProgramCommandOutput) => void - ): Promise | void { - const command = new CreateProgramCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.

+ * @see {@link CreateSourceLocationCommand} */ - public createSourceLocation( + createSourceLocation( args: CreateSourceLocationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSourceLocation( + createSourceLocation( args: CreateSourceLocationCommandInput, cb: (err: any, data?: CreateSourceLocationCommandOutput) => void ): void; - public createSourceLocation( + createSourceLocation( args: CreateSourceLocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSourceLocationCommandOutput) => void ): void; - public createSourceLocation( - args: CreateSourceLocationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSourceLocationCommandOutput) => void), - cb?: (err: any, data?: CreateSourceLocationCommandOutput) => void - ): Promise | void { - const command = new CreateSourceLocationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The VOD source configuration parameters.

+ * @see {@link CreateVodSourceCommand} */ - public createVodSource( + createVodSource( args: CreateVodSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVodSource( - args: CreateVodSourceCommandInput, - cb: (err: any, data?: CreateVodSourceCommandOutput) => void - ): void; - public createVodSource( + createVodSource(args: CreateVodSourceCommandInput, cb: (err: any, data?: CreateVodSourceCommandOutput) => void): void; + createVodSource( args: CreateVodSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVodSourceCommandOutput) => void ): void; - public createVodSource( - args: CreateVodSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVodSourceCommandOutput) => void), - cb?: (err: any, data?: CreateVodSourceCommandOutput) => void - ): Promise | void { - const command = new CreateVodSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

+ * @see {@link DeleteChannelCommand} */ - public deleteChannel( - args: DeleteChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteChannel( - args: DeleteChannelCommandInput, - cb: (err: any, data?: DeleteChannelCommandOutput) => void - ): void; - public deleteChannel( + deleteChannel(args: DeleteChannelCommandInput, options?: __HttpHandlerOptions): Promise; + deleteChannel(args: DeleteChannelCommandInput, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void; + deleteChannel( args: DeleteChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelCommandOutput) => void ): void; - public deleteChannel( - args: DeleteChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteChannelCommandOutput) => void), - cb?: (err: any, data?: DeleteChannelCommandOutput) => void - ): Promise | void { - const command = new DeleteChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The channel policy to delete.

+ * @see {@link DeleteChannelPolicyCommand} */ - public deleteChannelPolicy( + deleteChannelPolicy( args: DeleteChannelPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteChannelPolicy( + deleteChannelPolicy( args: DeleteChannelPolicyCommandInput, cb: (err: any, data?: DeleteChannelPolicyCommandOutput) => void ): void; - public deleteChannelPolicy( + deleteChannelPolicy( args: DeleteChannelPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelPolicyCommandOutput) => void ): void; - public deleteChannelPolicy( - args: DeleteChannelPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteChannelPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteChannelPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteChannelPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The live source to delete.

+ * @see {@link DeleteLiveSourceCommand} */ - public deleteLiveSource( + deleteLiveSource( args: DeleteLiveSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLiveSource( + deleteLiveSource( args: DeleteLiveSourceCommandInput, cb: (err: any, data?: DeleteLiveSourceCommandOutput) => void ): void; - public deleteLiveSource( + deleteLiveSource( args: DeleteLiveSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLiveSourceCommandOutput) => void ): void; - public deleteLiveSource( - args: DeleteLiveSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLiveSourceCommandOutput) => void), - cb?: (err: any, data?: DeleteLiveSourceCommandOutput) => void - ): Promise | void { - const command = new DeleteLiveSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.

+ * @see {@link DeletePlaybackConfigurationCommand} */ - public deletePlaybackConfiguration( + deletePlaybackConfiguration( args: DeletePlaybackConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePlaybackConfiguration( + deletePlaybackConfiguration( args: DeletePlaybackConfigurationCommandInput, cb: (err: any, data?: DeletePlaybackConfigurationCommandOutput) => void ): void; - public deletePlaybackConfiguration( + deletePlaybackConfiguration( args: DeletePlaybackConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePlaybackConfigurationCommandOutput) => void ): void; - public deletePlaybackConfiguration( - args: DeletePlaybackConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePlaybackConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeletePlaybackConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeletePlaybackConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a prefetch schedule for a specific playback configuration. If you call DeletePrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.

+ * @see {@link DeletePrefetchScheduleCommand} */ - public deletePrefetchSchedule( + deletePrefetchSchedule( args: DeletePrefetchScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePrefetchSchedule( + deletePrefetchSchedule( args: DeletePrefetchScheduleCommandInput, cb: (err: any, data?: DeletePrefetchScheduleCommandOutput) => void ): void; - public deletePrefetchSchedule( + deletePrefetchSchedule( args: DeletePrefetchScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePrefetchScheduleCommandOutput) => void ): void; - public deletePrefetchSchedule( - args: DeletePrefetchScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePrefetchScheduleCommandOutput) => void), - cb?: (err: any, data?: DeletePrefetchScheduleCommandOutput) => void - ): Promise | void { - const command = new DeletePrefetchScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.

+ * @see {@link DeleteProgramCommand} */ - public deleteProgram( - args: DeleteProgramCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteProgram( - args: DeleteProgramCommandInput, - cb: (err: any, data?: DeleteProgramCommandOutput) => void - ): void; - public deleteProgram( + deleteProgram(args: DeleteProgramCommandInput, options?: __HttpHandlerOptions): Promise; + deleteProgram(args: DeleteProgramCommandInput, cb: (err: any, data?: DeleteProgramCommandOutput) => void): void; + deleteProgram( args: DeleteProgramCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProgramCommandOutput) => void ): void; - public deleteProgram( - args: DeleteProgramCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProgramCommandOutput) => void), - cb?: (err: any, data?: DeleteProgramCommandOutput) => void - ): Promise | void { - const command = new DeleteProgramCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.

+ * @see {@link DeleteSourceLocationCommand} */ - public deleteSourceLocation( + deleteSourceLocation( args: DeleteSourceLocationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSourceLocation( + deleteSourceLocation( args: DeleteSourceLocationCommandInput, cb: (err: any, data?: DeleteSourceLocationCommandOutput) => void ): void; - public deleteSourceLocation( + deleteSourceLocation( args: DeleteSourceLocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSourceLocationCommandOutput) => void ): void; - public deleteSourceLocation( - args: DeleteSourceLocationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSourceLocationCommandOutput) => void), - cb?: (err: any, data?: DeleteSourceLocationCommandOutput) => void - ): Promise | void { - const command = new DeleteSourceLocationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The video on demand (VOD) source to delete.

+ * @see {@link DeleteVodSourceCommand} */ - public deleteVodSource( + deleteVodSource( args: DeleteVodSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVodSource( - args: DeleteVodSourceCommandInput, - cb: (err: any, data?: DeleteVodSourceCommandOutput) => void - ): void; - public deleteVodSource( + deleteVodSource(args: DeleteVodSourceCommandInput, cb: (err: any, data?: DeleteVodSourceCommandOutput) => void): void; + deleteVodSource( args: DeleteVodSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVodSourceCommandOutput) => void ): void; - public deleteVodSource( - args: DeleteVodSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVodSourceCommandOutput) => void), - cb?: (err: any, data?: DeleteVodSourceCommandOutput) => void - ): Promise | void { - const command = new DeleteVodSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

+ * @see {@link DescribeChannelCommand} */ - public describeChannel( + describeChannel( args: DescribeChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeChannel( - args: DescribeChannelCommandInput, - cb: (err: any, data?: DescribeChannelCommandOutput) => void - ): void; - public describeChannel( + describeChannel(args: DescribeChannelCommandInput, cb: (err: any, data?: DescribeChannelCommandOutput) => void): void; + describeChannel( args: DescribeChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelCommandOutput) => void ): void; - public describeChannel( - args: DescribeChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeChannelCommandOutput) => void), - cb?: (err: any, data?: DescribeChannelCommandOutput) => void - ): Promise | void { - const command = new DescribeChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The live source to describe.

+ * @see {@link DescribeLiveSourceCommand} */ - public describeLiveSource( + describeLiveSource( args: DescribeLiveSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLiveSource( + describeLiveSource( args: DescribeLiveSourceCommandInput, cb: (err: any, data?: DescribeLiveSourceCommandOutput) => void ): void; - public describeLiveSource( + describeLiveSource( args: DescribeLiveSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLiveSourceCommandOutput) => void ): void; - public describeLiveSource( - args: DescribeLiveSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLiveSourceCommandOutput) => void), - cb?: (err: any, data?: DescribeLiveSourceCommandOutput) => void - ): Promise | void { - const command = new DescribeLiveSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.

+ * @see {@link DescribeProgramCommand} */ - public describeProgram( + describeProgram( args: DescribeProgramCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProgram( - args: DescribeProgramCommandInput, - cb: (err: any, data?: DescribeProgramCommandOutput) => void - ): void; - public describeProgram( + describeProgram(args: DescribeProgramCommandInput, cb: (err: any, data?: DescribeProgramCommandOutput) => void): void; + describeProgram( args: DescribeProgramCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProgramCommandOutput) => void ): void; - public describeProgram( - args: DescribeProgramCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProgramCommandOutput) => void), - cb?: (err: any, data?: DescribeProgramCommandOutput) => void - ): Promise | void { - const command = new DescribeProgramCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.

+ * @see {@link DescribeSourceLocationCommand} */ - public describeSourceLocation( + describeSourceLocation( args: DescribeSourceLocationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSourceLocation( + describeSourceLocation( args: DescribeSourceLocationCommandInput, cb: (err: any, data?: DescribeSourceLocationCommandOutput) => void ): void; - public describeSourceLocation( + describeSourceLocation( args: DescribeSourceLocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSourceLocationCommandOutput) => void ): void; - public describeSourceLocation( - args: DescribeSourceLocationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSourceLocationCommandOutput) => void), - cb?: (err: any, data?: DescribeSourceLocationCommandOutput) => void - ): Promise | void { - const command = new DescribeSourceLocationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides details about a specific video on demand (VOD) source in a specific source location.

+ * @see {@link DescribeVodSourceCommand} */ - public describeVodSource( + describeVodSource( args: DescribeVodSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVodSource( + describeVodSource( args: DescribeVodSourceCommandInput, cb: (err: any, data?: DescribeVodSourceCommandOutput) => void ): void; - public describeVodSource( + describeVodSource( args: DescribeVodSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVodSourceCommandOutput) => void ): void; - public describeVodSource( - args: DescribeVodSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVodSourceCommandOutput) => void), - cb?: (err: any, data?: DescribeVodSourceCommandOutput) => void - ): Promise | void { - const command = new DescribeVodSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the channel's IAM policy. IAM policies are used to control access to your channel.

+ * @see {@link GetChannelPolicyCommand} */ - public getChannelPolicy( + getChannelPolicy( args: GetChannelPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getChannelPolicy( + getChannelPolicy( args: GetChannelPolicyCommandInput, cb: (err: any, data?: GetChannelPolicyCommandOutput) => void ): void; - public getChannelPolicy( + getChannelPolicy( args: GetChannelPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelPolicyCommandOutput) => void ): void; - public getChannelPolicy( - args: GetChannelPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetChannelPolicyCommandOutput) => void), - cb?: (err: any, data?: GetChannelPolicyCommandOutput) => void - ): Promise | void { - const command = new GetChannelPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about your channel's schedule.

+ * @see {@link GetChannelScheduleCommand} */ - public getChannelSchedule( + getChannelSchedule( args: GetChannelScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public getChannelSchedule( + getChannelSchedule( args: GetChannelScheduleCommandInput, cb: (err: any, data?: GetChannelScheduleCommandOutput) => void ): void; - public getChannelSchedule( + getChannelSchedule( args: GetChannelScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelScheduleCommandOutput) => void ): void; - public getChannelSchedule( - args: GetChannelScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetChannelScheduleCommandOutput) => void), - cb?: (err: any, data?: GetChannelScheduleCommandOutput) => void - ): Promise | void { - const command = new GetChannelScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.

+ * @see {@link GetPlaybackConfigurationCommand} */ - public getPlaybackConfiguration( + getPlaybackConfiguration( args: GetPlaybackConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPlaybackConfiguration( + getPlaybackConfiguration( args: GetPlaybackConfigurationCommandInput, cb: (err: any, data?: GetPlaybackConfigurationCommandOutput) => void ): void; - public getPlaybackConfiguration( + getPlaybackConfiguration( args: GetPlaybackConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPlaybackConfigurationCommandOutput) => void ): void; - public getPlaybackConfiguration( - args: GetPlaybackConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPlaybackConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetPlaybackConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetPlaybackConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.

+ * @see {@link GetPrefetchScheduleCommand} */ - public getPrefetchSchedule( + getPrefetchSchedule( args: GetPrefetchScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPrefetchSchedule( + getPrefetchSchedule( args: GetPrefetchScheduleCommandInput, cb: (err: any, data?: GetPrefetchScheduleCommandOutput) => void ): void; - public getPrefetchSchedule( + getPrefetchSchedule( args: GetPrefetchScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPrefetchScheduleCommandOutput) => void ): void; - public getPrefetchSchedule( - args: GetPrefetchScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPrefetchScheduleCommandOutput) => void), - cb?: (err: any, data?: GetPrefetchScheduleCommandOutput) => void - ): Promise | void { - const command = new GetPrefetchScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the alerts that are associated with a MediaTailor channel assembly resource.

+ * @see {@link ListAlertsCommand} */ - public listAlerts(args: ListAlertsCommandInput, options?: __HttpHandlerOptions): Promise; - public listAlerts(args: ListAlertsCommandInput, cb: (err: any, data?: ListAlertsCommandOutput) => void): void; - public listAlerts( + listAlerts(args: ListAlertsCommandInput, options?: __HttpHandlerOptions): Promise; + listAlerts(args: ListAlertsCommandInput, cb: (err: any, data?: ListAlertsCommandOutput) => void): void; + listAlerts( args: ListAlertsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAlertsCommandOutput) => void ): void; - public listAlerts( - args: ListAlertsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAlertsCommandOutput) => void), - cb?: (err: any, data?: ListAlertsCommandOutput) => void - ): Promise | void { - const command = new ListAlertsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the channels that are associated with the current AWS account.

+ * @see {@link ListChannelsCommand} */ - public listChannels( - args: ListChannelsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void; - public listChannels( + listChannels(args: ListChannelsCommandInput, options?: __HttpHandlerOptions): Promise; + listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void; + listChannels( args: ListChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsCommandOutput) => void ): void; - public listChannels( - args: ListChannelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListChannelsCommandOutput) => void), - cb?: (err: any, data?: ListChannelsCommandOutput) => void - ): Promise | void { - const command = new ListChannelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the live sources contained in a source location. A source represents a piece of content.

+ * @see {@link ListLiveSourcesCommand} */ - public listLiveSources( + listLiveSources( args: ListLiveSourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLiveSources( - args: ListLiveSourcesCommandInput, - cb: (err: any, data?: ListLiveSourcesCommandOutput) => void - ): void; - public listLiveSources( + listLiveSources(args: ListLiveSourcesCommandInput, cb: (err: any, data?: ListLiveSourcesCommandOutput) => void): void; + listLiveSources( args: ListLiveSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLiveSourcesCommandOutput) => void ): void; - public listLiveSources( - args: ListLiveSourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLiveSourcesCommandOutput) => void), - cb?: (err: any, data?: ListLiveSourcesCommandOutput) => void - ): Promise | void { - const command = new ListLiveSourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves existing playback configurations. For information about MediaTailor configurations, see Working with Configurations in AWS Elemental MediaTailor.

+ * @see {@link ListPlaybackConfigurationsCommand} */ - public listPlaybackConfigurations( + listPlaybackConfigurations( args: ListPlaybackConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPlaybackConfigurations( + listPlaybackConfigurations( args: ListPlaybackConfigurationsCommandInput, cb: (err: any, data?: ListPlaybackConfigurationsCommandOutput) => void ): void; - public listPlaybackConfigurations( + listPlaybackConfigurations( args: ListPlaybackConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPlaybackConfigurationsCommandOutput) => void ): void; - public listPlaybackConfigurations( - args: ListPlaybackConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPlaybackConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListPlaybackConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListPlaybackConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the prefetch schedules for a playback configuration.

+ * @see {@link ListPrefetchSchedulesCommand} */ - public listPrefetchSchedules( + listPrefetchSchedules( args: ListPrefetchSchedulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPrefetchSchedules( + listPrefetchSchedules( args: ListPrefetchSchedulesCommandInput, cb: (err: any, data?: ListPrefetchSchedulesCommandOutput) => void ): void; - public listPrefetchSchedules( + listPrefetchSchedules( args: ListPrefetchSchedulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPrefetchSchedulesCommandOutput) => void ): void; - public listPrefetchSchedules( - args: ListPrefetchSchedulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPrefetchSchedulesCommandOutput) => void), - cb?: (err: any, data?: ListPrefetchSchedulesCommandOutput) => void - ): Promise | void { - const command = new ListPrefetchSchedulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the source locations for a channel. A source location defines the host server URL, and contains a list of sources.

+ * @see {@link ListSourceLocationsCommand} */ - public listSourceLocations( + listSourceLocations( args: ListSourceLocationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSourceLocations( + listSourceLocations( args: ListSourceLocationsCommandInput, cb: (err: any, data?: ListSourceLocationsCommandOutput) => void ): void; - public listSourceLocations( + listSourceLocations( args: ListSourceLocationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSourceLocationsCommandOutput) => void ): void; - public listSourceLocations( - args: ListSourceLocationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSourceLocationsCommandOutput) => void), - cb?: (err: any, data?: ListSourceLocationsCommandOutput) => void - ): Promise | void { - const command = new ListSourceLocationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A list of tags that are associated with this resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the VOD sources contained in a source location. A source represents a piece of content.

+ * @see {@link ListVodSourcesCommand} */ - public listVodSources( + listVodSources( args: ListVodSourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVodSources( - args: ListVodSourcesCommandInput, - cb: (err: any, data?: ListVodSourcesCommandOutput) => void - ): void; - public listVodSources( + listVodSources(args: ListVodSourcesCommandInput, cb: (err: any, data?: ListVodSourcesCommandOutput) => void): void; + listVodSources( args: ListVodSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVodSourcesCommandOutput) => void ): void; - public listVodSources( - args: ListVodSourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVodSourcesCommandOutput) => void), - cb?: (err: any, data?: ListVodSourcesCommandOutput) => void - ): Promise | void { - const command = new ListVodSourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an IAM policy for the channel. IAM policies are used to control access to your channel.

+ * @see {@link PutChannelPolicyCommand} */ - public putChannelPolicy( + putChannelPolicy( args: PutChannelPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putChannelPolicy( + putChannelPolicy( args: PutChannelPolicyCommandInput, cb: (err: any, data?: PutChannelPolicyCommandOutput) => void ): void; - public putChannelPolicy( + putChannelPolicy( args: PutChannelPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutChannelPolicyCommandOutput) => void ): void; - public putChannelPolicy( - args: PutChannelPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutChannelPolicyCommandOutput) => void), - cb?: (err: any, data?: PutChannelPolicyCommandOutput) => void - ): Promise | void { - const command = new PutChannelPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.

+ * @see {@link PutPlaybackConfigurationCommand} */ - public putPlaybackConfiguration( + putPlaybackConfiguration( args: PutPlaybackConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putPlaybackConfiguration( + putPlaybackConfiguration( args: PutPlaybackConfigurationCommandInput, cb: (err: any, data?: PutPlaybackConfigurationCommandOutput) => void ): void; - public putPlaybackConfiguration( + putPlaybackConfiguration( args: PutPlaybackConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPlaybackConfigurationCommandOutput) => void ): void; - public putPlaybackConfiguration( - args: PutPlaybackConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutPlaybackConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutPlaybackConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutPlaybackConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

+ * @see {@link StartChannelCommand} */ - public startChannel( - args: StartChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public startChannel(args: StartChannelCommandInput, cb: (err: any, data?: StartChannelCommandOutput) => void): void; - public startChannel( + startChannel(args: StartChannelCommandInput, options?: __HttpHandlerOptions): Promise; + startChannel(args: StartChannelCommandInput, cb: (err: any, data?: StartChannelCommandOutput) => void): void; + startChannel( args: StartChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartChannelCommandOutput) => void ): void; - public startChannel( - args: StartChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartChannelCommandOutput) => void), - cb?: (err: any, data?: StartChannelCommandOutput) => void - ): Promise | void { - const command = new StartChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

+ * @see {@link StopChannelCommand} */ - public stopChannel(args: StopChannelCommandInput, options?: __HttpHandlerOptions): Promise; - public stopChannel(args: StopChannelCommandInput, cb: (err: any, data?: StopChannelCommandOutput) => void): void; - public stopChannel( + stopChannel(args: StopChannelCommandInput, options?: __HttpHandlerOptions): Promise; + stopChannel(args: StopChannelCommandInput, cb: (err: any, data?: StopChannelCommandOutput) => void): void; + stopChannel( args: StopChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopChannelCommandOutput) => void ): void; - public stopChannel( - args: StopChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopChannelCommandOutput) => void), - cb?: (err: any, data?: StopChannelCommandOutput) => void - ): Promise | void { - const command = new StopChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The resource to tag. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The resource to untag.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

+ * @see {@link UpdateChannelCommand} */ - public updateChannel( - args: UpdateChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateChannel( - args: UpdateChannelCommandInput, - cb: (err: any, data?: UpdateChannelCommandOutput) => void - ): void; - public updateChannel( + updateChannel(args: UpdateChannelCommandInput, options?: __HttpHandlerOptions): Promise; + updateChannel(args: UpdateChannelCommandInput, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void; + updateChannel( args: UpdateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelCommandOutput) => void ): void; - public updateChannel( - args: UpdateChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateChannelCommandOutput) => void), - cb?: (err: any, data?: UpdateChannelCommandOutput) => void - ): Promise | void { - const command = new UpdateChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a live source's configuration.

+ * @see {@link UpdateLiveSourceCommand} */ - public updateLiveSource( + updateLiveSource( args: UpdateLiveSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLiveSource( + updateLiveSource( args: UpdateLiveSourceCommandInput, cb: (err: any, data?: UpdateLiveSourceCommandOutput) => void ): void; - public updateLiveSource( + updateLiveSource( args: UpdateLiveSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLiveSourceCommandOutput) => void ): void; - public updateLiveSource( - args: UpdateLiveSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLiveSourceCommandOutput) => void), - cb?: (err: any, data?: UpdateLiveSourceCommandOutput) => void - ): Promise | void { - const command = new UpdateLiveSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a program within a channel.

+ * @see {@link UpdateProgramCommand} */ - public updateProgram( - args: UpdateProgramCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateProgram( - args: UpdateProgramCommandInput, - cb: (err: any, data?: UpdateProgramCommandOutput) => void - ): void; - public updateProgram( + updateProgram(args: UpdateProgramCommandInput, options?: __HttpHandlerOptions): Promise; + updateProgram(args: UpdateProgramCommandInput, cb: (err: any, data?: UpdateProgramCommandOutput) => void): void; + updateProgram( args: UpdateProgramCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProgramCommandOutput) => void ): void; - public updateProgram( - args: UpdateProgramCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProgramCommandOutput) => void), - cb?: (err: any, data?: UpdateProgramCommandOutput) => void - ): Promise | void { - const command = new UpdateProgramCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.

+ * @see {@link UpdateSourceLocationCommand} */ - public updateSourceLocation( + updateSourceLocation( args: UpdateSourceLocationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSourceLocation( + updateSourceLocation( args: UpdateSourceLocationCommandInput, cb: (err: any, data?: UpdateSourceLocationCommandOutput) => void ): void; - public updateSourceLocation( + updateSourceLocation( args: UpdateSourceLocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSourceLocationCommandOutput) => void ): void; - public updateSourceLocation( - args: UpdateSourceLocationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSourceLocationCommandOutput) => void), - cb?: (err: any, data?: UpdateSourceLocationCommandOutput) => void - ): Promise | void { - const command = new UpdateSourceLocationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a VOD source's configuration.

+ * @see {@link UpdateVodSourceCommand} */ - public updateVodSource( + updateVodSource( args: UpdateVodSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVodSource( - args: UpdateVodSourceCommandInput, - cb: (err: any, data?: UpdateVodSourceCommandOutput) => void - ): void; - public updateVodSource( + updateVodSource(args: UpdateVodSourceCommandInput, cb: (err: any, data?: UpdateVodSourceCommandOutput) => void): void; + updateVodSource( args: UpdateVodSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVodSourceCommandOutput) => void ): void; - public updateVodSource( - args: UpdateVodSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVodSourceCommandOutput) => void), - cb?: (err: any, data?: UpdateVodSourceCommandOutput) => void - ): Promise | void { - const command = new UpdateVodSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad insertion and linear channels. With MediaTailor, you can assemble existing content into a linear stream and serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the AWS Elemental MediaTailor User Guide.

+ *

Through the SDKs and the CLI you manage AWS Elemental MediaTailor configurations and channels the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).

+ */ +export class MediaTailor extends MediaTailorClient implements MediaTailor {} +createAggregatedClient(commands, MediaTailor); diff --git a/clients/client-memorydb/src/MemoryDB.ts b/clients/client-memorydb/src/MemoryDB.ts index 14a5cc02bf61..5592853fc41b 100644 --- a/clients/client-memorydb/src/MemoryDB.ts +++ b/clients/client-memorydb/src/MemoryDB.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -159,1239 +160,597 @@ import { UpdateSubnetGroupCommandOutput, } from "./commands/UpdateSubnetGroupCommand"; import { UpdateUserCommand, UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand"; -import { MemoryDBClient } from "./MemoryDBClient"; +import { MemoryDBClient, MemoryDBClientConfig } from "./MemoryDBClient"; -/** - * @public - *

MemoryDB for Redis is a fully managed, Redis-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures. - * - * MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis, a popular open source data store, enabling you to leverage Redis’ flexible and friendly data structures, APIs, and commands.

- */ -export class MemoryDB extends MemoryDBClient { +const commands = { + BatchUpdateClusterCommand, + CopySnapshotCommand, + CreateACLCommand, + CreateClusterCommand, + CreateParameterGroupCommand, + CreateSnapshotCommand, + CreateSubnetGroupCommand, + CreateUserCommand, + DeleteACLCommand, + DeleteClusterCommand, + DeleteParameterGroupCommand, + DeleteSnapshotCommand, + DeleteSubnetGroupCommand, + DeleteUserCommand, + DescribeACLsCommand, + DescribeClustersCommand, + DescribeEngineVersionsCommand, + DescribeEventsCommand, + DescribeParameterGroupsCommand, + DescribeParametersCommand, + DescribeReservedNodesCommand, + DescribeReservedNodesOfferingsCommand, + DescribeServiceUpdatesCommand, + DescribeSnapshotsCommand, + DescribeSubnetGroupsCommand, + DescribeUsersCommand, + FailoverShardCommand, + ListAllowedNodeTypeUpdatesCommand, + ListTagsCommand, + PurchaseReservedNodesOfferingCommand, + ResetParameterGroupCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateACLCommand, + UpdateClusterCommand, + UpdateParameterGroupCommand, + UpdateSubnetGroupCommand, + UpdateUserCommand, +}; + +export interface MemoryDB { /** - * @public - *

Apply the service update to a list of clusters supplied. For more information on service updates and applying them, see Applying the service updates.

+ * @see {@link BatchUpdateClusterCommand} */ - public batchUpdateCluster( + batchUpdateCluster( args: BatchUpdateClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchUpdateCluster( + batchUpdateCluster( args: BatchUpdateClusterCommandInput, cb: (err: any, data?: BatchUpdateClusterCommandOutput) => void ): void; - public batchUpdateCluster( + batchUpdateCluster( args: BatchUpdateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchUpdateClusterCommandOutput) => void ): void; - public batchUpdateCluster( - args: BatchUpdateClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchUpdateClusterCommandOutput) => void), - cb?: (err: any, data?: BatchUpdateClusterCommandOutput) => void - ): Promise | void { - const command = new BatchUpdateClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Makes a copy of an existing snapshot.

+ * @see {@link CopySnapshotCommand} */ - public copySnapshot( - args: CopySnapshotCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public copySnapshot(args: CopySnapshotCommandInput, cb: (err: any, data?: CopySnapshotCommandOutput) => void): void; - public copySnapshot( + copySnapshot(args: CopySnapshotCommandInput, options?: __HttpHandlerOptions): Promise; + copySnapshot(args: CopySnapshotCommandInput, cb: (err: any, data?: CopySnapshotCommandOutput) => void): void; + copySnapshot( args: CopySnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopySnapshotCommandOutput) => void ): void; - public copySnapshot( - args: CopySnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopySnapshotCommandOutput) => void), - cb?: (err: any, data?: CopySnapshotCommandOutput) => void - ): Promise | void { - const command = new CopySnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Access Control List. For more information, see Authenticating users with Access Contol Lists (ACLs).

+ * @see {@link CreateACLCommand} */ - public createACL(args: CreateACLCommandInput, options?: __HttpHandlerOptions): Promise; - public createACL(args: CreateACLCommandInput, cb: (err: any, data?: CreateACLCommandOutput) => void): void; - public createACL( + createACL(args: CreateACLCommandInput, options?: __HttpHandlerOptions): Promise; + createACL(args: CreateACLCommandInput, cb: (err: any, data?: CreateACLCommandOutput) => void): void; + createACL( args: CreateACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateACLCommandOutput) => void ): void; - public createACL( - args: CreateACLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateACLCommandOutput) => void), - cb?: (err: any, data?: CreateACLCommandOutput) => void - ): Promise | void { - const command = new CreateACLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software.

+ * @see {@link CreateClusterCommand} */ - public createCluster( - args: CreateClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createCluster( - args: CreateClusterCommandInput, - cb: (err: any, data?: CreateClusterCommandOutput) => void - ): void; - public createCluster( + createCluster(args: CreateClusterCommandInput, options?: __HttpHandlerOptions): Promise; + createCluster(args: CreateClusterCommandInput, cb: (err: any, data?: CreateClusterCommandOutput) => void): void; + createCluster( args: CreateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterCommandOutput) => void ): void; - public createCluster( - args: CreateClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateClusterCommandOutput) => void), - cb?: (err: any, data?: CreateClusterCommandOutput) => void - ): Promise | void { - const command = new CreateClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new MemoryDB parameter group. A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster. For - * more information, see Configuring engine parameters using parameter groups. - * - *

+ * @see {@link CreateParameterGroupCommand} */ - public createParameterGroup( + createParameterGroup( args: CreateParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createParameterGroup( + createParameterGroup( args: CreateParameterGroupCommandInput, cb: (err: any, data?: CreateParameterGroupCommandOutput) => void ): void; - public createParameterGroup( + createParameterGroup( args: CreateParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateParameterGroupCommandOutput) => void ): void; - public createParameterGroup( - args: CreateParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateParameterGroupCommandOutput) => void), - cb?: (err: any, data?: CreateParameterGroupCommandOutput) => void - ): Promise | void { - const command = new CreateParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a copy of an entire cluster at a specific moment in time.

+ * @see {@link CreateSnapshotCommand} */ - public createSnapshot( + createSnapshot( args: CreateSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSnapshot( - args: CreateSnapshotCommandInput, - cb: (err: any, data?: CreateSnapshotCommandOutput) => void - ): void; - public createSnapshot( + createSnapshot(args: CreateSnapshotCommandInput, cb: (err: any, data?: CreateSnapshotCommandOutput) => void): void; + createSnapshot( args: CreateSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSnapshotCommandOutput) => void ): void; - public createSnapshot( - args: CreateSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSnapshotCommandOutput) => void), - cb?: (err: any, data?: CreateSnapshotCommandOutput) => void - ): Promise | void { - const command = new CreateSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a subnet group. A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment. - * - * When you create a cluster in an Amazon VPC, you must specify a subnet group. MemoryDB uses that subnet group to choose a subnet and IP addresses within that subnet to associate with your nodes. - * For more information, see Subnets and subnet groups.

+ * @see {@link CreateSubnetGroupCommand} */ - public createSubnetGroup( + createSubnetGroup( args: CreateSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSubnetGroup( + createSubnetGroup( args: CreateSubnetGroupCommandInput, cb: (err: any, data?: CreateSubnetGroupCommandOutput) => void ): void; - public createSubnetGroup( + createSubnetGroup( args: CreateSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSubnetGroupCommandOutput) => void ): void; - public createSubnetGroup( - args: CreateSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: CreateSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new CreateSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).

+ * @see {@link CreateUserCommand} */ - public createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; - public createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; - public createUser( + createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; + createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; + createUser( args: CreateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserCommandOutput) => void ): void; - public createUser( - args: CreateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserCommandOutput) => void), - cb?: (err: any, data?: CreateUserCommandOutput) => void - ): Promise | void { - const command = new CreateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Access Control List. The ACL must first be disassociated from the cluster before it can be deleted. For more information, see Authenticating users with Access Contol Lists (ACLs).

+ * @see {@link DeleteACLCommand} */ - public deleteACL(args: DeleteACLCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteACL(args: DeleteACLCommandInput, cb: (err: any, data?: DeleteACLCommandOutput) => void): void; - public deleteACL( + deleteACL(args: DeleteACLCommandInput, options?: __HttpHandlerOptions): Promise; + deleteACL(args: DeleteACLCommandInput, cb: (err: any, data?: DeleteACLCommandOutput) => void): void; + deleteACL( args: DeleteACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteACLCommandOutput) => void ): void; - public deleteACL( - args: DeleteACLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteACLCommandOutput) => void), - cb?: (err: any, data?: DeleteACLCommandOutput) => void - ): Promise | void { - const command = new DeleteACLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a cluster. It also deletes all associated nodes and node endpoints

+ * @see {@link DeleteClusterCommand} */ - public deleteCluster( - args: DeleteClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteCluster( - args: DeleteClusterCommandInput, - cb: (err: any, data?: DeleteClusterCommandOutput) => void - ): void; - public deleteCluster( + deleteCluster(args: DeleteClusterCommandInput, options?: __HttpHandlerOptions): Promise; + deleteCluster(args: DeleteClusterCommandInput, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void; + deleteCluster( args: DeleteClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClusterCommandOutput) => void ): void; - public deleteCluster( - args: DeleteClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteClusterCommandOutput) => void), - cb?: (err: any, data?: DeleteClusterCommandOutput) => void - ): Promise | void { - const command = new DeleteClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any clusters. - * You cannot delete the default parameter groups in your account.

+ * @see {@link DeleteParameterGroupCommand} */ - public deleteParameterGroup( + deleteParameterGroup( args: DeleteParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteParameterGroup( + deleteParameterGroup( args: DeleteParameterGroupCommandInput, cb: (err: any, data?: DeleteParameterGroupCommandOutput) => void ): void; - public deleteParameterGroup( + deleteParameterGroup( args: DeleteParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteParameterGroupCommandOutput) => void ): void; - public deleteParameterGroup( - args: DeleteParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteParameterGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteParameterGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing snapshot. When you receive a successful response from this operation, MemoryDB immediately begins deleting the snapshot; you cannot cancel or revert this operation.

+ * @see {@link DeleteSnapshotCommand} */ - public deleteSnapshot( + deleteSnapshot( args: DeleteSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSnapshot( - args: DeleteSnapshotCommandInput, - cb: (err: any, data?: DeleteSnapshotCommandOutput) => void - ): void; - public deleteSnapshot( + deleteSnapshot(args: DeleteSnapshotCommandInput, cb: (err: any, data?: DeleteSnapshotCommandOutput) => void): void; + deleteSnapshot( args: DeleteSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSnapshotCommandOutput) => void ): void; - public deleteSnapshot( - args: DeleteSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSnapshotCommandOutput) => void), - cb?: (err: any, data?: DeleteSnapshotCommandOutput) => void - ): Promise | void { - const command = new DeleteSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a subnet group. You cannot delete a default subnet group or one that is associated with any clusters.

+ * @see {@link DeleteSubnetGroupCommand} */ - public deleteSubnetGroup( + deleteSubnetGroup( args: DeleteSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSubnetGroup( + deleteSubnetGroup( args: DeleteSubnetGroupCommandInput, cb: (err: any, data?: DeleteSubnetGroupCommandOutput) => void ): void; - public deleteSubnetGroup( + deleteSubnetGroup( args: DeleteSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSubnetGroupCommandOutput) => void ): void; - public deleteSubnetGroup( - args: DeleteSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.

+ * @see {@link DeleteUserCommand} */ - public deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; - public deleteUser( + deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; + deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; + deleteUser( args: DeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserCommandOutput) => void ): void; - public deleteUser( - args: DeleteUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserCommandOutput) => void), - cb?: (err: any, data?: DeleteUserCommandOutput) => void - ): Promise | void { - const command = new DeleteUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of ACLs

+ * @see {@link DescribeACLsCommand} */ - public describeACLs( - args: DescribeACLsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeACLs(args: DescribeACLsCommandInput, cb: (err: any, data?: DescribeACLsCommandOutput) => void): void; - public describeACLs( + describeACLs(args: DescribeACLsCommandInput, options?: __HttpHandlerOptions): Promise; + describeACLs(args: DescribeACLsCommandInput, cb: (err: any, data?: DescribeACLsCommandOutput) => void): void; + describeACLs( args: DescribeACLsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeACLsCommandOutput) => void ): void; - public describeACLs( - args: DescribeACLsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeACLsCommandOutput) => void), - cb?: (err: any, data?: DescribeACLsCommandOutput) => void - ): Promise | void { - const command = new DescribeACLsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.

+ * @see {@link DescribeClustersCommand} */ - public describeClusters( + describeClusters( args: DescribeClustersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClusters( + describeClusters( args: DescribeClustersCommandInput, cb: (err: any, data?: DescribeClustersCommandOutput) => void ): void; - public describeClusters( + describeClusters( args: DescribeClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClustersCommandOutput) => void ): void; - public describeClusters( - args: DescribeClustersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClustersCommandOutput) => void), - cb?: (err: any, data?: DescribeClustersCommandOutput) => void - ): Promise | void { - const command = new DescribeClustersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the available Redis engine versions.

+ * @see {@link DescribeEngineVersionsCommand} */ - public describeEngineVersions( + describeEngineVersions( args: DescribeEngineVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEngineVersions( + describeEngineVersions( args: DescribeEngineVersionsCommandInput, cb: (err: any, data?: DescribeEngineVersionsCommandOutput) => void ): void; - public describeEngineVersions( + describeEngineVersions( args: DescribeEngineVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEngineVersionsCommandOutput) => void ): void; - public describeEngineVersions( - args: DescribeEngineVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEngineVersionsCommandOutput) => void), - cb?: (err: any, data?: DescribeEngineVersionsCommandOutput) => void - ): Promise | void { - const command = new DescribeEngineVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns events related to clusters, security groups, and parameter groups. You can obtain events specific to a particular cluster, security group, or parameter group by providing the name as a parameter. - * - * By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

+ * @see {@link DescribeEventsCommand} */ - public describeEvents( + describeEvents( args: DescribeEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEvents( - args: DescribeEventsCommandInput, - cb: (err: any, data?: DescribeEventsCommandOutput) => void - ): void; - public describeEvents( + describeEvents(args: DescribeEventsCommandInput, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void; + describeEvents( args: DescribeEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsCommandOutput) => void ): void; - public describeEvents( - args: DescribeEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventsCommandOutput) => void), - cb?: (err: any, data?: DescribeEventsCommandOutput) => void - ): Promise | void { - const command = new DescribeEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of parameter group descriptions. If a parameter group name is specified, the list contains only the descriptions for that group.

+ * @see {@link DescribeParameterGroupsCommand} */ - public describeParameterGroups( + describeParameterGroups( args: DescribeParameterGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeParameterGroups( + describeParameterGroups( args: DescribeParameterGroupsCommandInput, cb: (err: any, data?: DescribeParameterGroupsCommandOutput) => void ): void; - public describeParameterGroups( + describeParameterGroups( args: DescribeParameterGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeParameterGroupsCommandOutput) => void ): void; - public describeParameterGroups( - args: DescribeParameterGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeParameterGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeParameterGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeParameterGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the detailed parameter list for a particular parameter group.

+ * @see {@link DescribeParametersCommand} */ - public describeParameters( + describeParameters( args: DescribeParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeParameters( + describeParameters( args: DescribeParametersCommandInput, cb: (err: any, data?: DescribeParametersCommandOutput) => void ): void; - public describeParameters( + describeParameters( args: DescribeParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeParametersCommandOutput) => void ): void; - public describeParameters( - args: DescribeParametersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeParametersCommandOutput) => void), - cb?: (err: any, data?: DescribeParametersCommandOutput) => void - ): Promise | void { - const command = new DescribeParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about reserved nodes for this account, or about a specified reserved node.

+ * @see {@link DescribeReservedNodesCommand} */ - public describeReservedNodes( + describeReservedNodes( args: DescribeReservedNodesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReservedNodes( + describeReservedNodes( args: DescribeReservedNodesCommandInput, cb: (err: any, data?: DescribeReservedNodesCommandOutput) => void ): void; - public describeReservedNodes( + describeReservedNodes( args: DescribeReservedNodesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReservedNodesCommandOutput) => void ): void; - public describeReservedNodes( - args: DescribeReservedNodesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReservedNodesCommandOutput) => void), - cb?: (err: any, data?: DescribeReservedNodesCommandOutput) => void - ): Promise | void { - const command = new DescribeReservedNodesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists available reserved node offerings.

+ * @see {@link DescribeReservedNodesOfferingsCommand} */ - public describeReservedNodesOfferings( + describeReservedNodesOfferings( args: DescribeReservedNodesOfferingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReservedNodesOfferings( + describeReservedNodesOfferings( args: DescribeReservedNodesOfferingsCommandInput, cb: (err: any, data?: DescribeReservedNodesOfferingsCommandOutput) => void ): void; - public describeReservedNodesOfferings( + describeReservedNodesOfferings( args: DescribeReservedNodesOfferingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReservedNodesOfferingsCommandOutput) => void ): void; - public describeReservedNodesOfferings( - args: DescribeReservedNodesOfferingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReservedNodesOfferingsCommandOutput) => void), - cb?: (err: any, data?: DescribeReservedNodesOfferingsCommandOutput) => void - ): Promise | void { - const command = new DescribeReservedNodesOfferingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns details of the service updates

+ * @see {@link DescribeServiceUpdatesCommand} */ - public describeServiceUpdates( + describeServiceUpdates( args: DescribeServiceUpdatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeServiceUpdates( + describeServiceUpdates( args: DescribeServiceUpdatesCommandInput, cb: (err: any, data?: DescribeServiceUpdatesCommandOutput) => void ): void; - public describeServiceUpdates( + describeServiceUpdates( args: DescribeServiceUpdatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeServiceUpdatesCommandOutput) => void ): void; - public describeServiceUpdates( - args: DescribeServiceUpdatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeServiceUpdatesCommandOutput) => void), - cb?: (err: any, data?: DescribeServiceUpdatesCommandOutput) => void - ): Promise | void { - const command = new DescribeServiceUpdatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, - * or just the snapshots associated with a particular cluster.

+ * @see {@link DescribeSnapshotsCommand} */ - public describeSnapshots( + describeSnapshots( args: DescribeSnapshotsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSnapshots( + describeSnapshots( args: DescribeSnapshotsCommandInput, cb: (err: any, data?: DescribeSnapshotsCommandOutput) => void ): void; - public describeSnapshots( + describeSnapshots( args: DescribeSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSnapshotsCommandOutput) => void ): void; - public describeSnapshots( - args: DescribeSnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSnapshotsCommandOutput) => void), - cb?: (err: any, data?: DescribeSnapshotsCommandOutput) => void - ): Promise | void { - const command = new DescribeSnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.

+ * @see {@link DescribeSubnetGroupsCommand} */ - public describeSubnetGroups( + describeSubnetGroups( args: DescribeSubnetGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSubnetGroups( + describeSubnetGroups( args: DescribeSubnetGroupsCommandInput, cb: (err: any, data?: DescribeSubnetGroupsCommandOutput) => void ): void; - public describeSubnetGroups( + describeSubnetGroups( args: DescribeSubnetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSubnetGroupsCommandOutput) => void ): void; - public describeSubnetGroups( - args: DescribeSubnetGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSubnetGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeSubnetGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeSubnetGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of users.

+ * @see {@link DescribeUsersCommand} */ - public describeUsers( - args: DescribeUsersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeUsers( - args: DescribeUsersCommandInput, - cb: (err: any, data?: DescribeUsersCommandOutput) => void - ): void; - public describeUsers( + describeUsers(args: DescribeUsersCommandInput, options?: __HttpHandlerOptions): Promise; + describeUsers(args: DescribeUsersCommandInput, cb: (err: any, data?: DescribeUsersCommandOutput) => void): void; + describeUsers( args: DescribeUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUsersCommandOutput) => void ): void; - public describeUsers( - args: DescribeUsersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUsersCommandOutput) => void), - cb?: (err: any, data?: DescribeUsersCommandOutput) => void - ): Promise | void { - const command = new DescribeUsersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used to failover a shard. This API is designed for testing the behavior of your application in case of MemoryDB failover. It is not designed to be used as a production-level tool for initiating - * a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large scale operational events, Amazon may block this API.

+ * @see {@link FailoverShardCommand} */ - public failoverShard( - args: FailoverShardCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public failoverShard( - args: FailoverShardCommandInput, - cb: (err: any, data?: FailoverShardCommandOutput) => void - ): void; - public failoverShard( + failoverShard(args: FailoverShardCommandInput, options?: __HttpHandlerOptions): Promise; + failoverShard(args: FailoverShardCommandInput, cb: (err: any, data?: FailoverShardCommandOutput) => void): void; + failoverShard( args: FailoverShardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FailoverShardCommandOutput) => void ): void; - public failoverShard( - args: FailoverShardCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FailoverShardCommandOutput) => void), - cb?: (err: any, data?: FailoverShardCommandOutput) => void - ): Promise | void { - const command = new FailoverShardCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all available node types that you can scale to from your cluster's current node type. - * - * When you use the UpdateCluster operation to scale your cluster, the value of the NodeType parameter must be one of the node types returned by this operation.

+ * @see {@link ListAllowedNodeTypeUpdatesCommand} */ - public listAllowedNodeTypeUpdates( + listAllowedNodeTypeUpdates( args: ListAllowedNodeTypeUpdatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAllowedNodeTypeUpdates( + listAllowedNodeTypeUpdates( args: ListAllowedNodeTypeUpdatesCommandInput, cb: (err: any, data?: ListAllowedNodeTypeUpdatesCommandOutput) => void ): void; - public listAllowedNodeTypeUpdates( + listAllowedNodeTypeUpdates( args: ListAllowedNodeTypeUpdatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAllowedNodeTypeUpdatesCommandOutput) => void ): void; - public listAllowedNodeTypeUpdates( - args: ListAllowedNodeTypeUpdatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAllowedNodeTypeUpdatesCommandOutput) => void), - cb?: (err: any, data?: ListAllowedNodeTypeUpdatesCommandOutput) => void - ): Promise | void { - const command = new ListAllowedNodeTypeUpdatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all tags currently on a named resource. - * - * A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track your MemoryDB resources. - * For more information, see Tagging your MemoryDB resources - *

+ * @see {@link ListTagsCommand} */ - public listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; - public listTags( + listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; + listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; + listTags( args: ListTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsCommandOutput) => void ): void; - public listTags( - args: ListTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsCommandOutput) => void), - cb?: (err: any, data?: ListTagsCommandOutput) => void - ): Promise | void { - const command = new ListTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows you to purchase a reserved node offering. Reserved nodes are not eligible for cancellation and are non-refundable.

+ * @see {@link PurchaseReservedNodesOfferingCommand} */ - public purchaseReservedNodesOffering( + purchaseReservedNodesOffering( args: PurchaseReservedNodesOfferingCommandInput, options?: __HttpHandlerOptions ): Promise; - public purchaseReservedNodesOffering( + purchaseReservedNodesOffering( args: PurchaseReservedNodesOfferingCommandInput, cb: (err: any, data?: PurchaseReservedNodesOfferingCommandOutput) => void ): void; - public purchaseReservedNodesOffering( + purchaseReservedNodesOffering( args: PurchaseReservedNodesOfferingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PurchaseReservedNodesOfferingCommandOutput) => void ): void; - public purchaseReservedNodesOffering( - args: PurchaseReservedNodesOfferingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PurchaseReservedNodesOfferingCommandOutput) => void), - cb?: (err: any, data?: PurchaseReservedNodesOfferingCommandOutput) => void - ): Promise | void { - const command = new PurchaseReservedNodesOfferingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the parameters of a parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire parameter group, specify the AllParameters and ParameterGroupName parameters.

+ * @see {@link ResetParameterGroupCommand} */ - public resetParameterGroup( + resetParameterGroup( args: ResetParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetParameterGroup( + resetParameterGroup( args: ResetParameterGroupCommandInput, cb: (err: any, data?: ResetParameterGroupCommandOutput) => void ): void; - public resetParameterGroup( + resetParameterGroup( args: ResetParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetParameterGroupCommandOutput) => void ): void; - public resetParameterGroup( - args: ResetParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetParameterGroupCommandOutput) => void), - cb?: (err: any, data?: ResetParameterGroupCommandOutput) => void - ): Promise | void { - const command = new ResetParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your MemoryDB resources. - * - * When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. For more information, see - * - * Resource-level permissions.

- *

For example, you can use cost-allocation tags to your MemoryDB resources, Amazon generates a cost allocation report as a comma-separated value - * (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories - * (such as cost centers, application names, or owners) to organize your costs across multiple services. - * - * For more information, see Using Cost Allocation Tags.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this operation to remove tags on a resource

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes the list of users that belong to the Access Control List.

+ * @see {@link UpdateACLCommand} */ - public updateACL(args: UpdateACLCommandInput, options?: __HttpHandlerOptions): Promise; - public updateACL(args: UpdateACLCommandInput, cb: (err: any, data?: UpdateACLCommandOutput) => void): void; - public updateACL( + updateACL(args: UpdateACLCommandInput, options?: __HttpHandlerOptions): Promise; + updateACL(args: UpdateACLCommandInput, cb: (err: any, data?: UpdateACLCommandOutput) => void): void; + updateACL( args: UpdateACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateACLCommandOutput) => void ): void; - public updateACL( - args: UpdateACLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateACLCommandOutput) => void), - cb?: (err: any, data?: UpdateACLCommandOutput) => void - ): Promise | void { - const command = new UpdateACLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration settings by specifying the settings and the new values.

+ * @see {@link UpdateClusterCommand} */ - public updateCluster( - args: UpdateClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateCluster( - args: UpdateClusterCommandInput, - cb: (err: any, data?: UpdateClusterCommandOutput) => void - ): void; - public updateCluster( + updateCluster(args: UpdateClusterCommandInput, options?: __HttpHandlerOptions): Promise; + updateCluster(args: UpdateClusterCommandInput, cb: (err: any, data?: UpdateClusterCommandOutput) => void): void; + updateCluster( args: UpdateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateClusterCommandOutput) => void ): void; - public updateCluster( - args: UpdateClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateClusterCommandOutput) => void), - cb?: (err: any, data?: UpdateClusterCommandOutput) => void - ): Promise | void { - const command = new UpdateClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.

+ * @see {@link UpdateParameterGroupCommand} */ - public updateParameterGroup( + updateParameterGroup( args: UpdateParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateParameterGroup( + updateParameterGroup( args: UpdateParameterGroupCommandInput, cb: (err: any, data?: UpdateParameterGroupCommandOutput) => void ): void; - public updateParameterGroup( + updateParameterGroup( args: UpdateParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateParameterGroupCommandOutput) => void ): void; - public updateParameterGroup( - args: UpdateParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateParameterGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateParameterGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a subnet group. For more information, see Updating a subnet group - *

+ * @see {@link UpdateSubnetGroupCommand} */ - public updateSubnetGroup( + updateSubnetGroup( args: UpdateSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSubnetGroup( + updateSubnetGroup( args: UpdateSubnetGroupCommandInput, cb: (err: any, data?: UpdateSubnetGroupCommandOutput) => void ): void; - public updateSubnetGroup( + updateSubnetGroup( args: UpdateSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSubnetGroupCommandOutput) => void ): void; - public updateSubnetGroup( - args: UpdateSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes user password(s) and/or access string.

+ * @see {@link UpdateUserCommand} */ - public updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise; - public updateUser(args: UpdateUserCommandInput, cb: (err: any, data?: UpdateUserCommandOutput) => void): void; - public updateUser( + updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise; + updateUser(args: UpdateUserCommandInput, cb: (err: any, data?: UpdateUserCommandOutput) => void): void; + updateUser( args: UpdateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserCommandOutput) => void ): void; - public updateUser( - args: UpdateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserCommandOutput) => void), - cb?: (err: any, data?: UpdateUserCommandOutput) => void - ): Promise | void { - const command = new UpdateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

MemoryDB for Redis is a fully managed, Redis-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures. + * + * MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis, a popular open source data store, enabling you to leverage Redis’ flexible and friendly data structures, APIs, and commands.

+ */ +export class MemoryDB extends MemoryDBClient implements MemoryDB {} +createAggregatedClient(commands, MemoryDB); diff --git a/clients/client-mgn/src/Mgn.ts b/clients/client-mgn/src/Mgn.ts index fa75070ca6e1..bfd02225e8c2 100644 --- a/clients/client-mgn/src/Mgn.ts +++ b/clients/client-mgn/src/Mgn.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -258,1953 +259,1012 @@ import { UpdateSourceServerReplicationTypeCommandOutput, } from "./commands/UpdateSourceServerReplicationTypeCommand"; import { UpdateWaveCommand, UpdateWaveCommandInput, UpdateWaveCommandOutput } from "./commands/UpdateWaveCommand"; -import { MgnClient } from "./MgnClient"; +import { MgnClient, MgnClientConfig } from "./MgnClient"; -/** - * @public - *

The Application Migration Service service.

- */ -export class Mgn extends MgnClient { +const commands = { + ArchiveApplicationCommand, + ArchiveWaveCommand, + AssociateApplicationsCommand, + AssociateSourceServersCommand, + ChangeServerLifeCycleStateCommand, + CreateApplicationCommand, + CreateLaunchConfigurationTemplateCommand, + CreateReplicationConfigurationTemplateCommand, + CreateWaveCommand, + DeleteApplicationCommand, + DeleteJobCommand, + DeleteLaunchConfigurationTemplateCommand, + DeleteReplicationConfigurationTemplateCommand, + DeleteSourceServerCommand, + DeleteVcenterClientCommand, + DeleteWaveCommand, + DescribeJobLogItemsCommand, + DescribeJobsCommand, + DescribeLaunchConfigurationTemplatesCommand, + DescribeReplicationConfigurationTemplatesCommand, + DescribeSourceServersCommand, + DescribeVcenterClientsCommand, + DisassociateApplicationsCommand, + DisassociateSourceServersCommand, + DisconnectFromServiceCommand, + FinalizeCutoverCommand, + GetLaunchConfigurationCommand, + GetReplicationConfigurationCommand, + InitializeServiceCommand, + ListApplicationsCommand, + ListExportErrorsCommand, + ListExportsCommand, + ListImportErrorsCommand, + ListImportsCommand, + ListSourceServerActionsCommand, + ListTagsForResourceCommand, + ListTemplateActionsCommand, + ListWavesCommand, + MarkAsArchivedCommand, + PutSourceServerActionCommand, + PutTemplateActionCommand, + RemoveSourceServerActionCommand, + RemoveTemplateActionCommand, + RetryDataReplicationCommand, + StartCutoverCommand, + StartExportCommand, + StartImportCommand, + StartReplicationCommand, + StartTestCommand, + TagResourceCommand, + TerminateTargetInstancesCommand, + UnarchiveApplicationCommand, + UnarchiveWaveCommand, + UntagResourceCommand, + UpdateApplicationCommand, + UpdateLaunchConfigurationCommand, + UpdateLaunchConfigurationTemplateCommand, + UpdateReplicationConfigurationCommand, + UpdateReplicationConfigurationTemplateCommand, + UpdateSourceServerReplicationTypeCommand, + UpdateWaveCommand, +}; + +export interface Mgn { /** - * @public - *

Archive application.

+ * @see {@link ArchiveApplicationCommand} */ - public archiveApplication( + archiveApplication( args: ArchiveApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public archiveApplication( + archiveApplication( args: ArchiveApplicationCommandInput, cb: (err: any, data?: ArchiveApplicationCommandOutput) => void ): void; - public archiveApplication( + archiveApplication( args: ArchiveApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ArchiveApplicationCommandOutput) => void ): void; - public archiveApplication( - args: ArchiveApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ArchiveApplicationCommandOutput) => void), - cb?: (err: any, data?: ArchiveApplicationCommandOutput) => void - ): Promise | void { - const command = new ArchiveApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Archive wave.

+ * @see {@link ArchiveWaveCommand} */ - public archiveWave(args: ArchiveWaveCommandInput, options?: __HttpHandlerOptions): Promise; - public archiveWave(args: ArchiveWaveCommandInput, cb: (err: any, data?: ArchiveWaveCommandOutput) => void): void; - public archiveWave( + archiveWave(args: ArchiveWaveCommandInput, options?: __HttpHandlerOptions): Promise; + archiveWave(args: ArchiveWaveCommandInput, cb: (err: any, data?: ArchiveWaveCommandOutput) => void): void; + archiveWave( args: ArchiveWaveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ArchiveWaveCommandOutput) => void ): void; - public archiveWave( - args: ArchiveWaveCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ArchiveWaveCommandOutput) => void), - cb?: (err: any, data?: ArchiveWaveCommandOutput) => void - ): Promise | void { - const command = new ArchiveWaveCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associate applications to wave.

+ * @see {@link AssociateApplicationsCommand} */ - public associateApplications( + associateApplications( args: AssociateApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateApplications( + associateApplications( args: AssociateApplicationsCommandInput, cb: (err: any, data?: AssociateApplicationsCommandOutput) => void ): void; - public associateApplications( + associateApplications( args: AssociateApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateApplicationsCommandOutput) => void ): void; - public associateApplications( - args: AssociateApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateApplicationsCommandOutput) => void), - cb?: (err: any, data?: AssociateApplicationsCommandOutput) => void - ): Promise | void { - const command = new AssociateApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associate source servers to application.

+ * @see {@link AssociateSourceServersCommand} */ - public associateSourceServers( + associateSourceServers( args: AssociateSourceServersCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateSourceServers( + associateSourceServers( args: AssociateSourceServersCommandInput, cb: (err: any, data?: AssociateSourceServersCommandOutput) => void ): void; - public associateSourceServers( + associateSourceServers( args: AssociateSourceServersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateSourceServersCommandOutput) => void ): void; - public associateSourceServers( - args: AssociateSourceServersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateSourceServersCommandOutput) => void), - cb?: (err: any, data?: AssociateSourceServersCommandOutput) => void - ): Promise | void { - const command = new AssociateSourceServersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows the user to set the SourceServer.LifeCycle.state property for specific Source Server IDs to one of the following: READY_FOR_TEST or READY_FOR_CUTOVER. This command only works if the Source Server is already launchable (dataReplicationInfo.lagDuration is not null.)

+ * @see {@link ChangeServerLifeCycleStateCommand} */ - public changeServerLifeCycleState( + changeServerLifeCycleState( args: ChangeServerLifeCycleStateCommandInput, options?: __HttpHandlerOptions ): Promise; - public changeServerLifeCycleState( + changeServerLifeCycleState( args: ChangeServerLifeCycleStateCommandInput, cb: (err: any, data?: ChangeServerLifeCycleStateCommandOutput) => void ): void; - public changeServerLifeCycleState( + changeServerLifeCycleState( args: ChangeServerLifeCycleStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChangeServerLifeCycleStateCommandOutput) => void ): void; - public changeServerLifeCycleState( - args: ChangeServerLifeCycleStateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ChangeServerLifeCycleStateCommandOutput) => void), - cb?: (err: any, data?: ChangeServerLifeCycleStateCommandOutput) => void - ): Promise | void { - const command = new ChangeServerLifeCycleStateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create application.

+ * @see {@link CreateApplicationCommand} */ - public createApplication( + createApplication( args: CreateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApplication( + createApplication( args: CreateApplicationCommandInput, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( + createApplication( args: CreateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( - args: CreateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApplicationCommandOutput) => void), - cb?: (err: any, data?: CreateApplicationCommandOutput) => void - ): Promise | void { - const command = new CreateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new Launch Configuration Template.

+ * @see {@link CreateLaunchConfigurationTemplateCommand} */ - public createLaunchConfigurationTemplate( + createLaunchConfigurationTemplate( args: CreateLaunchConfigurationTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLaunchConfigurationTemplate( + createLaunchConfigurationTemplate( args: CreateLaunchConfigurationTemplateCommandInput, cb: (err: any, data?: CreateLaunchConfigurationTemplateCommandOutput) => void ): void; - public createLaunchConfigurationTemplate( + createLaunchConfigurationTemplate( args: CreateLaunchConfigurationTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLaunchConfigurationTemplateCommandOutput) => void ): void; - public createLaunchConfigurationTemplate( - args: CreateLaunchConfigurationTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLaunchConfigurationTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateLaunchConfigurationTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateLaunchConfigurationTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new ReplicationConfigurationTemplate.

+ * @see {@link CreateReplicationConfigurationTemplateCommand} */ - public createReplicationConfigurationTemplate( + createReplicationConfigurationTemplate( args: CreateReplicationConfigurationTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createReplicationConfigurationTemplate( + createReplicationConfigurationTemplate( args: CreateReplicationConfigurationTemplateCommandInput, cb: (err: any, data?: CreateReplicationConfigurationTemplateCommandOutput) => void ): void; - public createReplicationConfigurationTemplate( + createReplicationConfigurationTemplate( args: CreateReplicationConfigurationTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReplicationConfigurationTemplateCommandOutput) => void ): void; - public createReplicationConfigurationTemplate( - args: CreateReplicationConfigurationTemplateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateReplicationConfigurationTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateReplicationConfigurationTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateReplicationConfigurationTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create wave.

+ * @see {@link CreateWaveCommand} */ - public createWave(args: CreateWaveCommandInput, options?: __HttpHandlerOptions): Promise; - public createWave(args: CreateWaveCommandInput, cb: (err: any, data?: CreateWaveCommandOutput) => void): void; - public createWave( + createWave(args: CreateWaveCommandInput, options?: __HttpHandlerOptions): Promise; + createWave(args: CreateWaveCommandInput, cb: (err: any, data?: CreateWaveCommandOutput) => void): void; + createWave( args: CreateWaveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWaveCommandOutput) => void ): void; - public createWave( - args: CreateWaveCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWaveCommandOutput) => void), - cb?: (err: any, data?: CreateWaveCommandOutput) => void - ): Promise | void { - const command = new CreateWaveCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete application.

+ * @see {@link DeleteApplicationCommand} */ - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( - args: DeleteApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApplicationCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a single Job by ID.

+ * @see {@link DeleteJobCommand} */ - public deleteJob(args: DeleteJobCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteJob(args: DeleteJobCommandInput, cb: (err: any, data?: DeleteJobCommandOutput) => void): void; - public deleteJob( + deleteJob(args: DeleteJobCommandInput, options?: __HttpHandlerOptions): Promise; + deleteJob(args: DeleteJobCommandInput, cb: (err: any, data?: DeleteJobCommandOutput) => void): void; + deleteJob( args: DeleteJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteJobCommandOutput) => void ): void; - public deleteJob( - args: DeleteJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteJobCommandOutput) => void), - cb?: (err: any, data?: DeleteJobCommandOutput) => void - ): Promise | void { - const command = new DeleteJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a single Launch Configuration Template by ID.

+ * @see {@link DeleteLaunchConfigurationTemplateCommand} */ - public deleteLaunchConfigurationTemplate( + deleteLaunchConfigurationTemplate( args: DeleteLaunchConfigurationTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLaunchConfigurationTemplate( + deleteLaunchConfigurationTemplate( args: DeleteLaunchConfigurationTemplateCommandInput, cb: (err: any, data?: DeleteLaunchConfigurationTemplateCommandOutput) => void ): void; - public deleteLaunchConfigurationTemplate( + deleteLaunchConfigurationTemplate( args: DeleteLaunchConfigurationTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLaunchConfigurationTemplateCommandOutput) => void ): void; - public deleteLaunchConfigurationTemplate( - args: DeleteLaunchConfigurationTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLaunchConfigurationTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteLaunchConfigurationTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteLaunchConfigurationTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a single Replication Configuration Template by ID

+ * @see {@link DeleteReplicationConfigurationTemplateCommand} */ - public deleteReplicationConfigurationTemplate( + deleteReplicationConfigurationTemplate( args: DeleteReplicationConfigurationTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteReplicationConfigurationTemplate( + deleteReplicationConfigurationTemplate( args: DeleteReplicationConfigurationTemplateCommandInput, cb: (err: any, data?: DeleteReplicationConfigurationTemplateCommandOutput) => void ): void; - public deleteReplicationConfigurationTemplate( + deleteReplicationConfigurationTemplate( args: DeleteReplicationConfigurationTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReplicationConfigurationTemplateCommandOutput) => void ): void; - public deleteReplicationConfigurationTemplate( - args: DeleteReplicationConfigurationTemplateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteReplicationConfigurationTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteReplicationConfigurationTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteReplicationConfigurationTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a single source server by ID.

+ * @see {@link DeleteSourceServerCommand} */ - public deleteSourceServer( + deleteSourceServer( args: DeleteSourceServerCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSourceServer( + deleteSourceServer( args: DeleteSourceServerCommandInput, cb: (err: any, data?: DeleteSourceServerCommandOutput) => void ): void; - public deleteSourceServer( + deleteSourceServer( args: DeleteSourceServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSourceServerCommandOutput) => void ): void; - public deleteSourceServer( - args: DeleteSourceServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSourceServerCommandOutput) => void), - cb?: (err: any, data?: DeleteSourceServerCommandOutput) => void - ): Promise | void { - const command = new DeleteSourceServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a given vCenter client by ID.

+ * @see {@link DeleteVcenterClientCommand} */ - public deleteVcenterClient( + deleteVcenterClient( args: DeleteVcenterClientCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVcenterClient( + deleteVcenterClient( args: DeleteVcenterClientCommandInput, cb: (err: any, data?: DeleteVcenterClientCommandOutput) => void ): void; - public deleteVcenterClient( + deleteVcenterClient( args: DeleteVcenterClientCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVcenterClientCommandOutput) => void ): void; - public deleteVcenterClient( - args: DeleteVcenterClientCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVcenterClientCommandOutput) => void), - cb?: (err: any, data?: DeleteVcenterClientCommandOutput) => void - ): Promise | void { - const command = new DeleteVcenterClientCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete wave.

+ * @see {@link DeleteWaveCommand} */ - public deleteWave(args: DeleteWaveCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteWave(args: DeleteWaveCommandInput, cb: (err: any, data?: DeleteWaveCommandOutput) => void): void; - public deleteWave( + deleteWave(args: DeleteWaveCommandInput, options?: __HttpHandlerOptions): Promise; + deleteWave(args: DeleteWaveCommandInput, cb: (err: any, data?: DeleteWaveCommandOutput) => void): void; + deleteWave( args: DeleteWaveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWaveCommandOutput) => void ): void; - public deleteWave( - args: DeleteWaveCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWaveCommandOutput) => void), - cb?: (err: any, data?: DeleteWaveCommandOutput) => void - ): Promise | void { - const command = new DeleteWaveCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves detailed job log items with paging.

+ * @see {@link DescribeJobLogItemsCommand} */ - public describeJobLogItems( + describeJobLogItems( args: DescribeJobLogItemsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeJobLogItems( + describeJobLogItems( args: DescribeJobLogItemsCommandInput, cb: (err: any, data?: DescribeJobLogItemsCommandOutput) => void ): void; - public describeJobLogItems( + describeJobLogItems( args: DescribeJobLogItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobLogItemsCommandOutput) => void ): void; - public describeJobLogItems( - args: DescribeJobLogItemsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeJobLogItemsCommandOutput) => void), - cb?: (err: any, data?: DescribeJobLogItemsCommandOutput) => void - ): Promise | void { - const command = new DescribeJobLogItemsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of Jobs. Use the JobsID and fromDate and toData filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are normally created by the StartTest, StartCutover, and TerminateTargetInstances APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets.

+ * @see {@link DescribeJobsCommand} */ - public describeJobs( - args: DescribeJobsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeJobs(args: DescribeJobsCommandInput, cb: (err: any, data?: DescribeJobsCommandOutput) => void): void; - public describeJobs( + describeJobs(args: DescribeJobsCommandInput, options?: __HttpHandlerOptions): Promise; + describeJobs(args: DescribeJobsCommandInput, cb: (err: any, data?: DescribeJobsCommandOutput) => void): void; + describeJobs( args: DescribeJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobsCommandOutput) => void ): void; - public describeJobs( - args: DescribeJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeJobsCommandOutput) => void), - cb?: (err: any, data?: DescribeJobsCommandOutput) => void - ): Promise | void { - const command = new DescribeJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs

+ * @see {@link DescribeLaunchConfigurationTemplatesCommand} */ - public describeLaunchConfigurationTemplates( + describeLaunchConfigurationTemplates( args: DescribeLaunchConfigurationTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLaunchConfigurationTemplates( + describeLaunchConfigurationTemplates( args: DescribeLaunchConfigurationTemplatesCommandInput, cb: (err: any, data?: DescribeLaunchConfigurationTemplatesCommandOutput) => void ): void; - public describeLaunchConfigurationTemplates( + describeLaunchConfigurationTemplates( args: DescribeLaunchConfigurationTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLaunchConfigurationTemplatesCommandOutput) => void ): void; - public describeLaunchConfigurationTemplates( - args: DescribeLaunchConfigurationTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLaunchConfigurationTemplatesCommandOutput) => void), - cb?: (err: any, data?: DescribeLaunchConfigurationTemplatesCommandOutput) => void - ): Promise | void { - const command = new DescribeLaunchConfigurationTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

+ * @see {@link DescribeReplicationConfigurationTemplatesCommand} */ - public describeReplicationConfigurationTemplates( + describeReplicationConfigurationTemplates( args: DescribeReplicationConfigurationTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReplicationConfigurationTemplates( + describeReplicationConfigurationTemplates( args: DescribeReplicationConfigurationTemplatesCommandInput, cb: (err: any, data?: DescribeReplicationConfigurationTemplatesCommandOutput) => void ): void; - public describeReplicationConfigurationTemplates( + describeReplicationConfigurationTemplates( args: DescribeReplicationConfigurationTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReplicationConfigurationTemplatesCommandOutput) => void ): void; - public describeReplicationConfigurationTemplates( - args: DescribeReplicationConfigurationTemplatesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeReplicationConfigurationTemplatesCommandOutput) => void), - cb?: (err: any, data?: DescribeReplicationConfigurationTemplatesCommandOutput) => void - ): Promise | void { - const command = new DescribeReplicationConfigurationTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves all SourceServers or multiple SourceServers by ID.

+ * @see {@link DescribeSourceServersCommand} */ - public describeSourceServers( + describeSourceServers( args: DescribeSourceServersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSourceServers( + describeSourceServers( args: DescribeSourceServersCommandInput, cb: (err: any, data?: DescribeSourceServersCommandOutput) => void ): void; - public describeSourceServers( + describeSourceServers( args: DescribeSourceServersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSourceServersCommandOutput) => void ): void; - public describeSourceServers( - args: DescribeSourceServersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSourceServersCommandOutput) => void), - cb?: (err: any, data?: DescribeSourceServersCommandOutput) => void - ): Promise | void { - const command = new DescribeSourceServersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the installed vCenter clients.

+ * @see {@link DescribeVcenterClientsCommand} */ - public describeVcenterClients( + describeVcenterClients( args: DescribeVcenterClientsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVcenterClients( + describeVcenterClients( args: DescribeVcenterClientsCommandInput, cb: (err: any, data?: DescribeVcenterClientsCommandOutput) => void ): void; - public describeVcenterClients( + describeVcenterClients( args: DescribeVcenterClientsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVcenterClientsCommandOutput) => void ): void; - public describeVcenterClients( - args: DescribeVcenterClientsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVcenterClientsCommandOutput) => void), - cb?: (err: any, data?: DescribeVcenterClientsCommandOutput) => void - ): Promise | void { - const command = new DescribeVcenterClientsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociate applications from wave.

+ * @see {@link DisassociateApplicationsCommand} */ - public disassociateApplications( + disassociateApplications( args: DisassociateApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateApplications( + disassociateApplications( args: DisassociateApplicationsCommandInput, cb: (err: any, data?: DisassociateApplicationsCommandOutput) => void ): void; - public disassociateApplications( + disassociateApplications( args: DisassociateApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateApplicationsCommandOutput) => void ): void; - public disassociateApplications( - args: DisassociateApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateApplicationsCommandOutput) => void), - cb?: (err: any, data?: DisassociateApplicationsCommandOutput) => void - ): Promise | void { - const command = new DisassociateApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociate source servers from application.

+ * @see {@link DisassociateSourceServersCommand} */ - public disassociateSourceServers( + disassociateSourceServers( args: DisassociateSourceServersCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateSourceServers( + disassociateSourceServers( args: DisassociateSourceServersCommandInput, cb: (err: any, data?: DisassociateSourceServersCommandOutput) => void ): void; - public disassociateSourceServers( + disassociateSourceServers( args: DisassociateSourceServersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateSourceServersCommandOutput) => void ): void; - public disassociateSourceServers( - args: DisassociateSourceServersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateSourceServersCommandOutput) => void), - cb?: (err: any, data?: DisassociateSourceServersCommandOutput) => void - ): Promise | void { - const command = new DisassociateSourceServersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disconnects specific Source Servers from Application Migration Service. Data replication is stopped immediately. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. If the agent on the source server has not been prevented from communicating with the Application Migration Service service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

+ * @see {@link DisconnectFromServiceCommand} */ - public disconnectFromService( + disconnectFromService( args: DisconnectFromServiceCommandInput, options?: __HttpHandlerOptions ): Promise; - public disconnectFromService( + disconnectFromService( args: DisconnectFromServiceCommandInput, cb: (err: any, data?: DisconnectFromServiceCommandOutput) => void ): void; - public disconnectFromService( + disconnectFromService( args: DisconnectFromServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisconnectFromServiceCommandOutput) => void ): void; - public disconnectFromService( - args: DisconnectFromServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisconnectFromServiceCommandOutput) => void), - cb?: (err: any, data?: DisconnectFromServiceCommandOutput) => void - ): Promise | void { - const command = new DisconnectFromServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Finalizes the cutover immediately for specific Source Servers. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. The AWS Replication Agent will receive a command to uninstall itself (within 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be changed to DISCONNECTED; The SourceServer.lifeCycle.state will be changed to CUTOVER; The totalStorageBytes property fo each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

+ * @see {@link FinalizeCutoverCommand} */ - public finalizeCutover( + finalizeCutover( args: FinalizeCutoverCommandInput, options?: __HttpHandlerOptions ): Promise; - public finalizeCutover( - args: FinalizeCutoverCommandInput, - cb: (err: any, data?: FinalizeCutoverCommandOutput) => void - ): void; - public finalizeCutover( + finalizeCutover(args: FinalizeCutoverCommandInput, cb: (err: any, data?: FinalizeCutoverCommandOutput) => void): void; + finalizeCutover( args: FinalizeCutoverCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FinalizeCutoverCommandOutput) => void ): void; - public finalizeCutover( - args: FinalizeCutoverCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FinalizeCutoverCommandOutput) => void), - cb?: (err: any, data?: FinalizeCutoverCommandOutput) => void - ): Promise | void { - const command = new FinalizeCutoverCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all LaunchConfigurations available, filtered by Source Server IDs.

+ * @see {@link GetLaunchConfigurationCommand} */ - public getLaunchConfiguration( + getLaunchConfiguration( args: GetLaunchConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLaunchConfiguration( + getLaunchConfiguration( args: GetLaunchConfigurationCommandInput, cb: (err: any, data?: GetLaunchConfigurationCommandOutput) => void ): void; - public getLaunchConfiguration( + getLaunchConfiguration( args: GetLaunchConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLaunchConfigurationCommandOutput) => void ): void; - public getLaunchConfiguration( - args: GetLaunchConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLaunchConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetLaunchConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetLaunchConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all ReplicationConfigurations, filtered by Source Server ID.

+ * @see {@link GetReplicationConfigurationCommand} */ - public getReplicationConfiguration( + getReplicationConfiguration( args: GetReplicationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReplicationConfiguration( + getReplicationConfiguration( args: GetReplicationConfigurationCommandInput, cb: (err: any, data?: GetReplicationConfigurationCommandOutput) => void ): void; - public getReplicationConfiguration( + getReplicationConfiguration( args: GetReplicationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReplicationConfigurationCommandOutput) => void ): void; - public getReplicationConfiguration( - args: GetReplicationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReplicationConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetReplicationConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetReplicationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Initialize Application Migration Service.

+ * @see {@link InitializeServiceCommand} */ - public initializeService( + initializeService( args: InitializeServiceCommandInput, options?: __HttpHandlerOptions ): Promise; - public initializeService( + initializeService( args: InitializeServiceCommandInput, cb: (err: any, data?: InitializeServiceCommandOutput) => void ): void; - public initializeService( + initializeService( args: InitializeServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InitializeServiceCommandOutput) => void ): void; - public initializeService( - args: InitializeServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InitializeServiceCommandOutput) => void), - cb?: (err: any, data?: InitializeServiceCommandOutput) => void - ): Promise | void { - const command = new InitializeServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves all applications or multiple applications by ID.

+ * @see {@link ListApplicationsCommand} */ - public listApplications( + listApplications( args: ListApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplications( + listApplications( args: ListApplicationsCommandInput, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( + listApplications( args: ListApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( - args: ListApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationsCommandOutput) => void), - cb?: (err: any, data?: ListApplicationsCommandOutput) => void - ): Promise | void { - const command = new ListApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List export errors.

+ * @see {@link ListExportErrorsCommand} */ - public listExportErrors( + listExportErrors( args: ListExportErrorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listExportErrors( + listExportErrors( args: ListExportErrorsCommandInput, cb: (err: any, data?: ListExportErrorsCommandOutput) => void ): void; - public listExportErrors( + listExportErrors( args: ListExportErrorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExportErrorsCommandOutput) => void ): void; - public listExportErrors( - args: ListExportErrorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListExportErrorsCommandOutput) => void), - cb?: (err: any, data?: ListExportErrorsCommandOutput) => void - ): Promise | void { - const command = new ListExportErrorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List exports.

+ * @see {@link ListExportsCommand} */ - public listExports(args: ListExportsCommandInput, options?: __HttpHandlerOptions): Promise; - public listExports(args: ListExportsCommandInput, cb: (err: any, data?: ListExportsCommandOutput) => void): void; - public listExports( + listExports(args: ListExportsCommandInput, options?: __HttpHandlerOptions): Promise; + listExports(args: ListExportsCommandInput, cb: (err: any, data?: ListExportsCommandOutput) => void): void; + listExports( args: ListExportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExportsCommandOutput) => void ): void; - public listExports( - args: ListExportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListExportsCommandOutput) => void), - cb?: (err: any, data?: ListExportsCommandOutput) => void - ): Promise | void { - const command = new ListExportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List import errors.

+ * @see {@link ListImportErrorsCommand} */ - public listImportErrors( + listImportErrors( args: ListImportErrorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listImportErrors( + listImportErrors( args: ListImportErrorsCommandInput, cb: (err: any, data?: ListImportErrorsCommandOutput) => void ): void; - public listImportErrors( + listImportErrors( args: ListImportErrorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImportErrorsCommandOutput) => void ): void; - public listImportErrors( - args: ListImportErrorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListImportErrorsCommandOutput) => void), - cb?: (err: any, data?: ListImportErrorsCommandOutput) => void - ): Promise | void { - const command = new ListImportErrorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List imports.

+ * @see {@link ListImportsCommand} */ - public listImports(args: ListImportsCommandInput, options?: __HttpHandlerOptions): Promise; - public listImports(args: ListImportsCommandInput, cb: (err: any, data?: ListImportsCommandOutput) => void): void; - public listImports( + listImports(args: ListImportsCommandInput, options?: __HttpHandlerOptions): Promise; + listImports(args: ListImportsCommandInput, cb: (err: any, data?: ListImportsCommandOutput) => void): void; + listImports( args: ListImportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImportsCommandOutput) => void ): void; - public listImports( - args: ListImportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListImportsCommandOutput) => void), - cb?: (err: any, data?: ListImportsCommandOutput) => void - ): Promise | void { - const command = new ListImportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List source server post migration custom actions.

+ * @see {@link ListSourceServerActionsCommand} */ - public listSourceServerActions( + listSourceServerActions( args: ListSourceServerActionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSourceServerActions( + listSourceServerActions( args: ListSourceServerActionsCommandInput, cb: (err: any, data?: ListSourceServerActionsCommandOutput) => void ): void; - public listSourceServerActions( + listSourceServerActions( args: ListSourceServerActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSourceServerActionsCommandOutput) => void ): void; - public listSourceServerActions( - args: ListSourceServerActionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSourceServerActionsCommandOutput) => void), - cb?: (err: any, data?: ListSourceServerActionsCommandOutput) => void - ): Promise | void { - const command = new ListSourceServerActionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all tags for your Application Migration Service resources.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List template post migration custom actions.

+ * @see {@link ListTemplateActionsCommand} */ - public listTemplateActions( + listTemplateActions( args: ListTemplateActionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTemplateActions( + listTemplateActions( args: ListTemplateActionsCommandInput, cb: (err: any, data?: ListTemplateActionsCommandOutput) => void ): void; - public listTemplateActions( + listTemplateActions( args: ListTemplateActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTemplateActionsCommandOutput) => void ): void; - public listTemplateActions( - args: ListTemplateActionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTemplateActionsCommandOutput) => void), - cb?: (err: any, data?: ListTemplateActionsCommandOutput) => void - ): Promise | void { - const command = new ListTemplateActionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves all waves or multiple waves by ID.

+ * @see {@link ListWavesCommand} */ - public listWaves(args: ListWavesCommandInput, options?: __HttpHandlerOptions): Promise; - public listWaves(args: ListWavesCommandInput, cb: (err: any, data?: ListWavesCommandOutput) => void): void; - public listWaves( + listWaves(args: ListWavesCommandInput, options?: __HttpHandlerOptions): Promise; + listWaves(args: ListWavesCommandInput, cb: (err: any, data?: ListWavesCommandOutput) => void): void; + listWaves( args: ListWavesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWavesCommandOutput) => void ): void; - public listWaves( - args: ListWavesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWavesCommandOutput) => void), - cb?: (err: any, data?: ListWavesCommandOutput) => void - ): Promise | void { - const command = new ListWavesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID. This command only works for SourceServers with a lifecycle. state which equals DISCONNECTED or CUTOVER.

+ * @see {@link MarkAsArchivedCommand} */ - public markAsArchived( + markAsArchived( args: MarkAsArchivedCommandInput, options?: __HttpHandlerOptions ): Promise; - public markAsArchived( - args: MarkAsArchivedCommandInput, - cb: (err: any, data?: MarkAsArchivedCommandOutput) => void - ): void; - public markAsArchived( + markAsArchived(args: MarkAsArchivedCommandInput, cb: (err: any, data?: MarkAsArchivedCommandOutput) => void): void; + markAsArchived( args: MarkAsArchivedCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MarkAsArchivedCommandOutput) => void ): void; - public markAsArchived( - args: MarkAsArchivedCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MarkAsArchivedCommandOutput) => void), - cb?: (err: any, data?: MarkAsArchivedCommandOutput) => void - ): Promise | void { - const command = new MarkAsArchivedCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Put source server post migration custom action.

+ * @see {@link PutSourceServerActionCommand} */ - public putSourceServerAction( + putSourceServerAction( args: PutSourceServerActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public putSourceServerAction( + putSourceServerAction( args: PutSourceServerActionCommandInput, cb: (err: any, data?: PutSourceServerActionCommandOutput) => void ): void; - public putSourceServerAction( + putSourceServerAction( args: PutSourceServerActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSourceServerActionCommandOutput) => void ): void; - public putSourceServerAction( - args: PutSourceServerActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutSourceServerActionCommandOutput) => void), - cb?: (err: any, data?: PutSourceServerActionCommandOutput) => void - ): Promise | void { - const command = new PutSourceServerActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Put template post migration custom action.

+ * @see {@link PutTemplateActionCommand} */ - public putTemplateAction( + putTemplateAction( args: PutTemplateActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public putTemplateAction( + putTemplateAction( args: PutTemplateActionCommandInput, cb: (err: any, data?: PutTemplateActionCommandOutput) => void ): void; - public putTemplateAction( + putTemplateAction( args: PutTemplateActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutTemplateActionCommandOutput) => void ): void; - public putTemplateAction( - args: PutTemplateActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutTemplateActionCommandOutput) => void), - cb?: (err: any, data?: PutTemplateActionCommandOutput) => void - ): Promise | void { - const command = new PutTemplateActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Remove source server post migration custom action.

+ * @see {@link RemoveSourceServerActionCommand} */ - public removeSourceServerAction( + removeSourceServerAction( args: RemoveSourceServerActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeSourceServerAction( + removeSourceServerAction( args: RemoveSourceServerActionCommandInput, cb: (err: any, data?: RemoveSourceServerActionCommandOutput) => void ): void; - public removeSourceServerAction( + removeSourceServerAction( args: RemoveSourceServerActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveSourceServerActionCommandOutput) => void ): void; - public removeSourceServerAction( - args: RemoveSourceServerActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveSourceServerActionCommandOutput) => void), - cb?: (err: any, data?: RemoveSourceServerActionCommandOutput) => void - ): Promise | void { - const command = new RemoveSourceServerActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Remove template post migration custom action.

+ * @see {@link RemoveTemplateActionCommand} */ - public removeTemplateAction( + removeTemplateAction( args: RemoveTemplateActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeTemplateAction( + removeTemplateAction( args: RemoveTemplateActionCommandInput, cb: (err: any, data?: RemoveTemplateActionCommandOutput) => void ): void; - public removeTemplateAction( + removeTemplateAction( args: RemoveTemplateActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTemplateActionCommandOutput) => void ): void; - public removeTemplateAction( - args: RemoveTemplateActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveTemplateActionCommandOutput) => void), - cb?: (err: any, data?: RemoveTemplateActionCommandOutput) => void - ): Promise | void { - const command = new RemoveTemplateActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Causes the data replication initiation sequence to begin immediately upon next Handshake for specified SourceServer IDs, regardless of when the previous initiation started. This command will not work if the SourceServer is not stalled or is in a DISCONNECTED or STOPPED state.

+ * @see {@link RetryDataReplicationCommand} */ - public retryDataReplication( + retryDataReplication( args: RetryDataReplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public retryDataReplication( + retryDataReplication( args: RetryDataReplicationCommandInput, cb: (err: any, data?: RetryDataReplicationCommandOutput) => void ): void; - public retryDataReplication( + retryDataReplication( args: RetryDataReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RetryDataReplicationCommandOutput) => void ): void; - public retryDataReplication( - args: RetryDataReplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RetryDataReplicationCommandOutput) => void), - cb?: (err: any, data?: RetryDataReplicationCommandOutput) => void - ): Promise | void { - const command = new RetryDataReplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Launches a Cutover Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartCutover and changes the SourceServer.lifeCycle.state property to CUTTING_OVER.

+ * @see {@link StartCutoverCommand} */ - public startCutover( - args: StartCutoverCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public startCutover(args: StartCutoverCommandInput, cb: (err: any, data?: StartCutoverCommandOutput) => void): void; - public startCutover( + startCutover(args: StartCutoverCommandInput, options?: __HttpHandlerOptions): Promise; + startCutover(args: StartCutoverCommandInput, cb: (err: any, data?: StartCutoverCommandOutput) => void): void; + startCutover( args: StartCutoverCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCutoverCommandOutput) => void ): void; - public startCutover( - args: StartCutoverCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartCutoverCommandOutput) => void), - cb?: (err: any, data?: StartCutoverCommandOutput) => void - ): Promise | void { - const command = new StartCutoverCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Start export.

+ * @see {@link StartExportCommand} */ - public startExport(args: StartExportCommandInput, options?: __HttpHandlerOptions): Promise; - public startExport(args: StartExportCommandInput, cb: (err: any, data?: StartExportCommandOutput) => void): void; - public startExport( + startExport(args: StartExportCommandInput, options?: __HttpHandlerOptions): Promise; + startExport(args: StartExportCommandInput, cb: (err: any, data?: StartExportCommandOutput) => void): void; + startExport( args: StartExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartExportCommandOutput) => void ): void; - public startExport( - args: StartExportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartExportCommandOutput) => void), - cb?: (err: any, data?: StartExportCommandOutput) => void - ): Promise | void { - const command = new StartExportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Start import.

+ * @see {@link StartImportCommand} */ - public startImport(args: StartImportCommandInput, options?: __HttpHandlerOptions): Promise; - public startImport(args: StartImportCommandInput, cb: (err: any, data?: StartImportCommandOutput) => void): void; - public startImport( + startImport(args: StartImportCommandInput, options?: __HttpHandlerOptions): Promise; + startImport(args: StartImportCommandInput, cb: (err: any, data?: StartImportCommandOutput) => void): void; + startImport( args: StartImportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartImportCommandOutput) => void ): void; - public startImport( - args: StartImportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartImportCommandOutput) => void), - cb?: (err: any, data?: StartImportCommandOutput) => void - ): Promise | void { - const command = new StartImportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts replication for SNAPSHOT_SHIPPING agents.

+ * @see {@link StartReplicationCommand} */ - public startReplication( + startReplication( args: StartReplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startReplication( + startReplication( args: StartReplicationCommandInput, cb: (err: any, data?: StartReplicationCommandOutput) => void ): void; - public startReplication( + startReplication( args: StartReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartReplicationCommandOutput) => void ): void; - public startReplication( - args: StartReplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartReplicationCommandOutput) => void), - cb?: (err: any, data?: StartReplicationCommandOutput) => void - ): Promise | void { - const command = new StartReplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Launches a Test Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartTest and changes the SourceServer.lifeCycle.state property to TESTING.

+ * @see {@link StartTestCommand} */ - public startTest(args: StartTestCommandInput, options?: __HttpHandlerOptions): Promise; - public startTest(args: StartTestCommandInput, cb: (err: any, data?: StartTestCommandOutput) => void): void; - public startTest( + startTest(args: StartTestCommandInput, options?: __HttpHandlerOptions): Promise; + startTest(args: StartTestCommandInput, cb: (err: any, data?: StartTestCommandOutput) => void): void; + startTest( args: StartTestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTestCommandOutput) => void ): void; - public startTest( - args: StartTestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartTestCommandOutput) => void), - cb?: (err: any, data?: StartTestCommandOutput) => void - ): Promise | void { - const command = new StartTestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or overwrites only the specified tags for the specified Application Migration Service resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a job that terminates specific launched EC2 Test and Cutover instances. This command will not work for any Source Server with a lifecycle.state of TESTING, CUTTING_OVER, or CUTOVER.

+ * @see {@link TerminateTargetInstancesCommand} */ - public terminateTargetInstances( + terminateTargetInstances( args: TerminateTargetInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public terminateTargetInstances( + terminateTargetInstances( args: TerminateTargetInstancesCommandInput, cb: (err: any, data?: TerminateTargetInstancesCommandOutput) => void ): void; - public terminateTargetInstances( + terminateTargetInstances( args: TerminateTargetInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TerminateTargetInstancesCommandOutput) => void ): void; - public terminateTargetInstances( - args: TerminateTargetInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TerminateTargetInstancesCommandOutput) => void), - cb?: (err: any, data?: TerminateTargetInstancesCommandOutput) => void - ): Promise | void { - const command = new TerminateTargetInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Unarchive application.

+ * @see {@link UnarchiveApplicationCommand} */ - public unarchiveApplication( + unarchiveApplication( args: UnarchiveApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public unarchiveApplication( + unarchiveApplication( args: UnarchiveApplicationCommandInput, cb: (err: any, data?: UnarchiveApplicationCommandOutput) => void ): void; - public unarchiveApplication( + unarchiveApplication( args: UnarchiveApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnarchiveApplicationCommandOutput) => void ): void; - public unarchiveApplication( - args: UnarchiveApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnarchiveApplicationCommandOutput) => void), - cb?: (err: any, data?: UnarchiveApplicationCommandOutput) => void - ): Promise | void { - const command = new UnarchiveApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Unarchive wave.

+ * @see {@link UnarchiveWaveCommand} */ - public unarchiveWave( - args: UnarchiveWaveCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public unarchiveWave( - args: UnarchiveWaveCommandInput, - cb: (err: any, data?: UnarchiveWaveCommandOutput) => void - ): void; - public unarchiveWave( + unarchiveWave(args: UnarchiveWaveCommandInput, options?: __HttpHandlerOptions): Promise; + unarchiveWave(args: UnarchiveWaveCommandInput, cb: (err: any, data?: UnarchiveWaveCommandOutput) => void): void; + unarchiveWave( args: UnarchiveWaveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnarchiveWaveCommandOutput) => void ): void; - public unarchiveWave( - args: UnarchiveWaveCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnarchiveWaveCommandOutput) => void), - cb?: (err: any, data?: UnarchiveWaveCommandOutput) => void - ): Promise | void { - const command = new UnarchiveWaveCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified set of tags from the specified set of Application Migration Service resources.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update application.

+ * @see {@link UpdateApplicationCommand} */ - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( - args: UpdateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApplicationCommandOutput) => void), - cb?: (err: any, data?: UpdateApplicationCommandOutput) => void - ): Promise | void { - const command = new UpdateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates multiple LaunchConfigurations by Source Server ID.

+ * @see {@link UpdateLaunchConfigurationCommand} */ - public updateLaunchConfiguration( + updateLaunchConfiguration( args: UpdateLaunchConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLaunchConfiguration( + updateLaunchConfiguration( args: UpdateLaunchConfigurationCommandInput, cb: (err: any, data?: UpdateLaunchConfigurationCommandOutput) => void ): void; - public updateLaunchConfiguration( + updateLaunchConfiguration( args: UpdateLaunchConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLaunchConfigurationCommandOutput) => void ): void; - public updateLaunchConfiguration( - args: UpdateLaunchConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLaunchConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateLaunchConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateLaunchConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing Launch Configuration Template by ID.

+ * @see {@link UpdateLaunchConfigurationTemplateCommand} */ - public updateLaunchConfigurationTemplate( + updateLaunchConfigurationTemplate( args: UpdateLaunchConfigurationTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLaunchConfigurationTemplate( + updateLaunchConfigurationTemplate( args: UpdateLaunchConfigurationTemplateCommandInput, cb: (err: any, data?: UpdateLaunchConfigurationTemplateCommandOutput) => void ): void; - public updateLaunchConfigurationTemplate( + updateLaunchConfigurationTemplate( args: UpdateLaunchConfigurationTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLaunchConfigurationTemplateCommandOutput) => void ): void; - public updateLaunchConfigurationTemplate( - args: UpdateLaunchConfigurationTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLaunchConfigurationTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateLaunchConfigurationTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateLaunchConfigurationTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows you to update multiple ReplicationConfigurations by Source Server ID.

+ * @see {@link UpdateReplicationConfigurationCommand} */ - public updateReplicationConfiguration( + updateReplicationConfiguration( args: UpdateReplicationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateReplicationConfiguration( + updateReplicationConfiguration( args: UpdateReplicationConfigurationCommandInput, cb: (err: any, data?: UpdateReplicationConfigurationCommandOutput) => void ): void; - public updateReplicationConfiguration( + updateReplicationConfiguration( args: UpdateReplicationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateReplicationConfigurationCommandOutput) => void ): void; - public updateReplicationConfiguration( - args: UpdateReplicationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateReplicationConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateReplicationConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateReplicationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates multiple ReplicationConfigurationTemplates by ID.

+ * @see {@link UpdateReplicationConfigurationTemplateCommand} */ - public updateReplicationConfigurationTemplate( + updateReplicationConfigurationTemplate( args: UpdateReplicationConfigurationTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateReplicationConfigurationTemplate( + updateReplicationConfigurationTemplate( args: UpdateReplicationConfigurationTemplateCommandInput, cb: (err: any, data?: UpdateReplicationConfigurationTemplateCommandOutput) => void ): void; - public updateReplicationConfigurationTemplate( + updateReplicationConfigurationTemplate( args: UpdateReplicationConfigurationTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateReplicationConfigurationTemplateCommandOutput) => void ): void; - public updateReplicationConfigurationTemplate( - args: UpdateReplicationConfigurationTemplateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateReplicationConfigurationTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateReplicationConfigurationTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateReplicationConfigurationTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.

+ * @see {@link UpdateSourceServerReplicationTypeCommand} */ - public updateSourceServerReplicationType( + updateSourceServerReplicationType( args: UpdateSourceServerReplicationTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSourceServerReplicationType( + updateSourceServerReplicationType( args: UpdateSourceServerReplicationTypeCommandInput, cb: (err: any, data?: UpdateSourceServerReplicationTypeCommandOutput) => void ): void; - public updateSourceServerReplicationType( + updateSourceServerReplicationType( args: UpdateSourceServerReplicationTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSourceServerReplicationTypeCommandOutput) => void ): void; - public updateSourceServerReplicationType( - args: UpdateSourceServerReplicationTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSourceServerReplicationTypeCommandOutput) => void), - cb?: (err: any, data?: UpdateSourceServerReplicationTypeCommandOutput) => void - ): Promise | void { - const command = new UpdateSourceServerReplicationTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update wave.

+ * @see {@link UpdateWaveCommand} */ - public updateWave(args: UpdateWaveCommandInput, options?: __HttpHandlerOptions): Promise; - public updateWave(args: UpdateWaveCommandInput, cb: (err: any, data?: UpdateWaveCommandOutput) => void): void; - public updateWave( + updateWave(args: UpdateWaveCommandInput, options?: __HttpHandlerOptions): Promise; + updateWave(args: UpdateWaveCommandInput, cb: (err: any, data?: UpdateWaveCommandOutput) => void): void; + updateWave( args: UpdateWaveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWaveCommandOutput) => void ): void; - public updateWave( - args: UpdateWaveCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWaveCommandOutput) => void), - cb?: (err: any, data?: UpdateWaveCommandOutput) => void - ): Promise | void { - const command = new UpdateWaveCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The Application Migration Service service.

+ */ +export class Mgn extends MgnClient implements Mgn {} +createAggregatedClient(commands, Mgn); diff --git a/clients/client-migration-hub-refactor-spaces/src/MigrationHubRefactorSpaces.ts b/clients/client-migration-hub-refactor-spaces/src/MigrationHubRefactorSpaces.ts index 1082c933fb32..7305ffc57ddf 100644 --- a/clients/client-migration-hub-refactor-spaces/src/MigrationHubRefactorSpaces.ts +++ b/clients/client-migration-hub-refactor-spaces/src/MigrationHubRefactorSpaces.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -93,878 +94,388 @@ import { UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; import { UpdateRouteCommand, UpdateRouteCommandInput, UpdateRouteCommandOutput } from "./commands/UpdateRouteCommand"; -import { MigrationHubRefactorSpacesClient } from "./MigrationHubRefactorSpacesClient"; +import { + MigrationHubRefactorSpacesClient, + MigrationHubRefactorSpacesClientConfig, +} from "./MigrationHubRefactorSpacesClient"; -/** - * @public - * Amazon Web Services Migration Hub Refactor Spaces - *

This API reference provides descriptions, syntax, and other details about each of the - * actions and data types for Amazon Web Services Migration Hub Refactor Spaces (Refactor Spaces). The topic for each action shows the API - * request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to - * access an API that is tailored to the programming language or platform that you're using. For - * more information, see Amazon Web Services SDKs.

- *

To share Refactor Spaces environments with other Amazon Web Services accounts or with Organizations - * and their OUs, use Resource Access Manager's CreateResourceShare API. See CreateResourceShare in the Amazon Web Services RAM API Reference.

- */ -export class MigrationHubRefactorSpaces extends MigrationHubRefactorSpacesClient { +const commands = { + CreateApplicationCommand, + CreateEnvironmentCommand, + CreateRouteCommand, + CreateServiceCommand, + DeleteApplicationCommand, + DeleteEnvironmentCommand, + DeleteResourcePolicyCommand, + DeleteRouteCommand, + DeleteServiceCommand, + GetApplicationCommand, + GetEnvironmentCommand, + GetResourcePolicyCommand, + GetRouteCommand, + GetServiceCommand, + ListApplicationsCommand, + ListEnvironmentsCommand, + ListEnvironmentVpcsCommand, + ListRoutesCommand, + ListServicesCommand, + ListTagsForResourceCommand, + PutResourcePolicyCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateRouteCommand, +}; + +export interface MigrationHubRefactorSpaces { /** - * @public - *

Creates an Amazon Web Services Migration Hub Refactor Spaces application. The account that owns the environment also owns the - * applications created inside the environment, regardless of the account that creates the - * application. Refactor Spaces provisions an Amazon API Gateway, API Gateway VPC link, and - * Network Load Balancer for the application proxy inside your account.

- *

In environments created with a CreateEnvironment:NetworkFabricType of NONE you need to configure - * VPC to VPC connectivity between your service VPC and the application proxy VPC to - * route traffic through the application proxy to a service with a private URL endpoint. For more - * information, see - * Create an application in the Refactor Spaces User Guide.

+ * @see {@link CreateApplicationCommand} */ - public createApplication( + createApplication( args: CreateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApplication( + createApplication( args: CreateApplicationCommandInput, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( + createApplication( args: CreateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( - args: CreateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApplicationCommandOutput) => void), - cb?: (err: any, data?: CreateApplicationCommandOutput) => void - ): Promise | void { - const command = new CreateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Amazon Web Services Migration Hub Refactor Spaces environment. The caller owns the environment resource, and all - * Refactor Spaces applications, services, and routes created within the environment. They are referred - * to as the environment owner. The environment owner has cross-account - * visibility and control of Refactor Spaces resources that are added to the environment by other - * accounts that the environment is shared with.

- *

When creating an environment with a CreateEnvironment:NetworkFabricType of TRANSIT_GATEWAY, Refactor Spaces - * provisions a transit gateway to enable services in VPCs to communicate directly across - * accounts. If CreateEnvironment:NetworkFabricType is NONE, Refactor Spaces does not create - * a transit gateway and you must use your network infrastructure to route traffic to services - * with private URL endpoints.

+ * @see {@link CreateEnvironmentCommand} */ - public createEnvironment( + createEnvironment( args: CreateEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEnvironment( + createEnvironment( args: CreateEnvironmentCommandInput, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void ): void; - public createEnvironment( + createEnvironment( args: CreateEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void ): void; - public createEnvironment( - args: CreateEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEnvironmentCommandOutput) => void), - cb?: (err: any, data?: CreateEnvironmentCommandOutput) => void - ): Promise | void { - const command = new CreateEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Amazon Web Services Migration Hub Refactor Spaces route. The account owner of the service resource is always the - * environment owner, regardless of which account creates the route. Routes target a service in - * the application. If an application does not have any routes, then the first route must be - * created as a DEFAULT - * RouteType.

- *

When created, the default route defaults to an active state so state is not a required - * input. However, like all other state values the state of the default route can be updated - * after creation, but only when all other routes are also inactive. Conversely, no route can be - * active without the default route also being active.

- *

When you create a route, Refactor Spaces configures the Amazon API Gateway to send traffic - * to the target service as follows:

- *
    - *
  • - *

    - * URL Endpoints - *

    - *

    If the service has a URL endpoint, and the endpoint resolves to a private IP address, - * Refactor Spaces routes traffic using the API Gateway VPC link. If a service endpoint - * resolves to a public IP address, Refactor Spaces routes traffic over the public internet. - * Services can have HTTP or HTTPS URL endpoints. For HTTPS URLs, publicly-signed - * certificates are supported. Private Certificate Authorities (CAs) are permitted only if - * the CA's domain is also publicly resolvable.

    - *

    Refactor Spaces automatically resolves the public Domain Name System (DNS) names that are - * set in CreateService:UrlEndpoint when you create a service. The DNS names - * resolve when the DNS time-to-live (TTL) expires, or every 60 seconds for TTLs less than 60 - * seconds. This periodic DNS resolution ensures that the route configuration remains - * up-to-date.

    - *

    - *

    - * One-time health check - *

    - *

    A one-time health check is performed on the service when either the route is updated - * from inactive to active, or when it is created with an active state. If the health check - * fails, the route transitions the route state to FAILED, an error code of - * SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE is provided, and no traffic is sent - * to the service.

    - *

    For private URLs, a target group is created on the Network Load Balancer and the load - * balancer target group runs default target health checks. By default, the health check is - * run against the service endpoint URL. Optionally, the health check can be performed - * against a different protocol, port, and/or path using the CreateService:UrlEndpoint parameter. All other health check settings for the - * load balancer use the default values described in the Health - * checks for your target groups in the Elastic Load Balancing - * guide. The health check is considered successful if at least one target - * within the target group transitions to a healthy state.

    - *

    - *

  • - *
  • - *

    - * Lambda function endpoints - *

    - *

    If the service has an Lambda function endpoint, then Refactor Spaces - * configures the Lambda function's resource policy to allow the application's - * API Gateway to invoke the function.

    - *

    The Lambda function state is checked. If the function is not active, the - * function configuration is updated so that Lambda resources are provisioned. If - * the Lambda state is Failed, then the route creation fails. For - * more information, see the GetFunctionConfiguration's State response parameter in the Lambda Developer Guide.

    - *

    A check is performed to determine that a Lambda function with the specified ARN - * exists. If it does not exist, the health check fails. For public URLs, a connection is - * opened to the public endpoint. If the URL is not reachable, the health check fails. - *

    - *
  • - *
- *

- * Environments without a network bridge - *

- *

When you create environments without a network bridge (CreateEnvironment:NetworkFabricType is NONE) and you use your own - * networking infrastructure, you need to configure VPC to VPC connectivity between your network and the application proxy VPC. Route - * creation from the application proxy to service endpoints will fail if your network is not - * configured to connect to the application proxy VPC. For more information, see Create - * a route in the Refactor Spaces User Guide.

- *

+ * @see {@link CreateRouteCommand} */ - public createRoute(args: CreateRouteCommandInput, options?: __HttpHandlerOptions): Promise; - public createRoute(args: CreateRouteCommandInput, cb: (err: any, data?: CreateRouteCommandOutput) => void): void; - public createRoute( + createRoute(args: CreateRouteCommandInput, options?: __HttpHandlerOptions): Promise; + createRoute(args: CreateRouteCommandInput, cb: (err: any, data?: CreateRouteCommandOutput) => void): void; + createRoute( args: CreateRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRouteCommandOutput) => void ): void; - public createRoute( - args: CreateRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRouteCommandOutput) => void), - cb?: (err: any, data?: CreateRouteCommandOutput) => void - ): Promise | void { - const command = new CreateRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Amazon Web Services Migration Hub Refactor Spaces service. The account owner of the service is always the - * environment owner, regardless of which account in the environment creates the service. - * Services have either a URL endpoint in a virtual private cloud (VPC), or a Lambda - * function endpoint.

- * - *

If an Amazon Web Services resource is launched in a service VPC, and you want it to be - * accessible to all of an environment’s services with VPCs and routes, apply the - * RefactorSpacesSecurityGroup to the resource. Alternatively, to add more - * cross-account constraints, apply your own security group.

- *
+ * @see {@link CreateServiceCommand} */ - public createService( - args: CreateServiceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createService( - args: CreateServiceCommandInput, - cb: (err: any, data?: CreateServiceCommandOutput) => void - ): void; - public createService( + createService(args: CreateServiceCommandInput, options?: __HttpHandlerOptions): Promise; + createService(args: CreateServiceCommandInput, cb: (err: any, data?: CreateServiceCommandOutput) => void): void; + createService( args: CreateServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceCommandOutput) => void ): void; - public createService( - args: CreateServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateServiceCommandOutput) => void), - cb?: (err: any, data?: CreateServiceCommandOutput) => void - ): Promise | void { - const command = new CreateServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon Web Services Migration Hub Refactor Spaces application. Before you can delete an application, you must first - * delete any services or routes within the application.

+ * @see {@link DeleteApplicationCommand} */ - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( - args: DeleteApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApplicationCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon Web Services Migration Hub Refactor Spaces environment. Before you can delete an environment, you must first - * delete any applications and services within the environment.

+ * @see {@link DeleteEnvironmentCommand} */ - public deleteEnvironment( + deleteEnvironment( args: DeleteEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEnvironment( + deleteEnvironment( args: DeleteEnvironmentCommandInput, cb: (err: any, data?: DeleteEnvironmentCommandOutput) => void ): void; - public deleteEnvironment( + deleteEnvironment( args: DeleteEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEnvironmentCommandOutput) => void ): void; - public deleteEnvironment( - args: DeleteEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEnvironmentCommandOutput) => void), - cb?: (err: any, data?: DeleteEnvironmentCommandOutput) => void - ): Promise | void { - const command = new DeleteEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the resource policy set for the environment.

+ * @see {@link DeleteResourcePolicyCommand} */ - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( - args: DeleteResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon Web Services Migration Hub Refactor Spaces route.

+ * @see {@link DeleteRouteCommand} */ - public deleteRoute(args: DeleteRouteCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteRoute(args: DeleteRouteCommandInput, cb: (err: any, data?: DeleteRouteCommandOutput) => void): void; - public deleteRoute( + deleteRoute(args: DeleteRouteCommandInput, options?: __HttpHandlerOptions): Promise; + deleteRoute(args: DeleteRouteCommandInput, cb: (err: any, data?: DeleteRouteCommandOutput) => void): void; + deleteRoute( args: DeleteRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRouteCommandOutput) => void ): void; - public deleteRoute( - args: DeleteRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRouteCommandOutput) => void), - cb?: (err: any, data?: DeleteRouteCommandOutput) => void - ): Promise | void { - const command = new DeleteRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon Web Services Migration Hub Refactor Spaces service.

+ * @see {@link DeleteServiceCommand} */ - public deleteService( - args: DeleteServiceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteService( - args: DeleteServiceCommandInput, - cb: (err: any, data?: DeleteServiceCommandOutput) => void - ): void; - public deleteService( + deleteService(args: DeleteServiceCommandInput, options?: __HttpHandlerOptions): Promise; + deleteService(args: DeleteServiceCommandInput, cb: (err: any, data?: DeleteServiceCommandOutput) => void): void; + deleteService( args: DeleteServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceCommandOutput) => void ): void; - public deleteService( - args: DeleteServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteServiceCommandOutput) => void), - cb?: (err: any, data?: DeleteServiceCommandOutput) => void - ): Promise | void { - const command = new DeleteServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets an Amazon Web Services Migration Hub Refactor Spaces application.

+ * @see {@link GetApplicationCommand} */ - public getApplication( + getApplication( args: GetApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getApplication( - args: GetApplicationCommandInput, - cb: (err: any, data?: GetApplicationCommandOutput) => void - ): void; - public getApplication( + getApplication(args: GetApplicationCommandInput, cb: (err: any, data?: GetApplicationCommandOutput) => void): void; + getApplication( args: GetApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApplicationCommandOutput) => void ): void; - public getApplication( - args: GetApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApplicationCommandOutput) => void), - cb?: (err: any, data?: GetApplicationCommandOutput) => void - ): Promise | void { - const command = new GetApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets an Amazon Web Services Migration Hub Refactor Spaces environment.

+ * @see {@link GetEnvironmentCommand} */ - public getEnvironment( + getEnvironment( args: GetEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEnvironment( - args: GetEnvironmentCommandInput, - cb: (err: any, data?: GetEnvironmentCommandOutput) => void - ): void; - public getEnvironment( + getEnvironment(args: GetEnvironmentCommandInput, cb: (err: any, data?: GetEnvironmentCommandOutput) => void): void; + getEnvironment( args: GetEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEnvironmentCommandOutput) => void ): void; - public getEnvironment( - args: GetEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEnvironmentCommandOutput) => void), - cb?: (err: any, data?: GetEnvironmentCommandOutput) => void - ): Promise | void { - const command = new GetEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the resource-based permission policy that is set for the given environment.

+ * @see {@link GetResourcePolicyCommand} */ - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void ): void; - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void ): void; - public getResourcePolicy( - args: GetResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: GetResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new GetResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets an Amazon Web Services Migration Hub Refactor Spaces route.

+ * @see {@link GetRouteCommand} */ - public getRoute(args: GetRouteCommandInput, options?: __HttpHandlerOptions): Promise; - public getRoute(args: GetRouteCommandInput, cb: (err: any, data?: GetRouteCommandOutput) => void): void; - public getRoute( + getRoute(args: GetRouteCommandInput, options?: __HttpHandlerOptions): Promise; + getRoute(args: GetRouteCommandInput, cb: (err: any, data?: GetRouteCommandOutput) => void): void; + getRoute( args: GetRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRouteCommandOutput) => void ): void; - public getRoute( - args: GetRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRouteCommandOutput) => void), - cb?: (err: any, data?: GetRouteCommandOutput) => void - ): Promise | void { - const command = new GetRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets an Amazon Web Services Migration Hub Refactor Spaces service.

+ * @see {@link GetServiceCommand} */ - public getService(args: GetServiceCommandInput, options?: __HttpHandlerOptions): Promise; - public getService(args: GetServiceCommandInput, cb: (err: any, data?: GetServiceCommandOutput) => void): void; - public getService( + getService(args: GetServiceCommandInput, options?: __HttpHandlerOptions): Promise; + getService(args: GetServiceCommandInput, cb: (err: any, data?: GetServiceCommandOutput) => void): void; + getService( args: GetServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceCommandOutput) => void ): void; - public getService( - args: GetServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceCommandOutput) => void), - cb?: (err: any, data?: GetServiceCommandOutput) => void - ): Promise | void { - const command = new GetServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.

+ * @see {@link ListApplicationsCommand} */ - public listApplications( + listApplications( args: ListApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplications( + listApplications( args: ListApplicationsCommandInput, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( + listApplications( args: ListApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( - args: ListApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationsCommandOutput) => void), - cb?: (err: any, data?: ListApplicationsCommandOutput) => void - ): Promise | void { - const command = new ListApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller - * account.

+ * @see {@link ListEnvironmentsCommand} */ - public listEnvironments( + listEnvironments( args: ListEnvironmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEnvironments( + listEnvironments( args: ListEnvironmentsCommandInput, cb: (err: any, data?: ListEnvironmentsCommandOutput) => void ): void; - public listEnvironments( + listEnvironments( args: ListEnvironmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnvironmentsCommandOutput) => void ): void; - public listEnvironments( - args: ListEnvironmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEnvironmentsCommandOutput) => void), - cb?: (err: any, data?: ListEnvironmentsCommandOutput) => void - ): Promise | void { - const command = new ListEnvironmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part of the - * environment.

+ * @see {@link ListEnvironmentVpcsCommand} */ - public listEnvironmentVpcs( + listEnvironmentVpcs( args: ListEnvironmentVpcsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEnvironmentVpcs( + listEnvironmentVpcs( args: ListEnvironmentVpcsCommandInput, cb: (err: any, data?: ListEnvironmentVpcsCommandOutput) => void ): void; - public listEnvironmentVpcs( + listEnvironmentVpcs( args: ListEnvironmentVpcsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnvironmentVpcsCommandOutput) => void ): void; - public listEnvironmentVpcs( - args: ListEnvironmentVpcsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEnvironmentVpcsCommandOutput) => void), - cb?: (err: any, data?: ListEnvironmentVpcsCommandOutput) => void - ): Promise | void { - const command = new ListEnvironmentVpcsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application.

+ * @see {@link ListRoutesCommand} */ - public listRoutes(args: ListRoutesCommandInput, options?: __HttpHandlerOptions): Promise; - public listRoutes(args: ListRoutesCommandInput, cb: (err: any, data?: ListRoutesCommandOutput) => void): void; - public listRoutes( + listRoutes(args: ListRoutesCommandInput, options?: __HttpHandlerOptions): Promise; + listRoutes(args: ListRoutesCommandInput, cb: (err: any, data?: ListRoutesCommandOutput) => void): void; + listRoutes( args: ListRoutesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRoutesCommandOutput) => void ): void; - public listRoutes( - args: ListRoutesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRoutesCommandOutput) => void), - cb?: (err: any, data?: ListRoutesCommandOutput) => void - ): Promise | void { - const command = new ListRoutesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.

+ * @see {@link ListServicesCommand} */ - public listServices( - args: ListServicesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listServices(args: ListServicesCommandInput, cb: (err: any, data?: ListServicesCommandOutput) => void): void; - public listServices( + listServices(args: ListServicesCommandInput, options?: __HttpHandlerOptions): Promise; + listServices(args: ListServicesCommandInput, cb: (err: any, data?: ListServicesCommandOutput) => void): void; + listServices( args: ListServicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServicesCommandOutput) => void ): void; - public listServices( - args: ListServicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServicesCommandOutput) => void), - cb?: (err: any, data?: ListServicesCommandOutput) => void - ): Promise | void { - const command = new ListServicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags of a resource. The caller account must be the same as the resource’s - * OwnerAccountId. Listing tags in other accounts is not supported.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Attaches a resource-based permission policy to the Amazon Web Services Migration Hub Refactor Spaces environment. The policy - * must contain the same actions and condition statements as the - * arn:aws:ram::aws:permission/AWSRAMDefaultPermissionRefactorSpacesEnvironment - * permission in Resource Access Manager. The policy must not contain new lines or blank lines. - *

+ * @see {@link PutResourcePolicyCommand} */ - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( - args: PutResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: PutResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new PutResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the tags of a given resource. Tags are metadata which can be used to manage a - * resource. To tag a resource, the caller account must be the same as the resource’s - * OwnerAccountId. Tagging resources in other accounts is not supported.

- * - *

Amazon Web Services Migration Hub Refactor Spaces does not propagate tags to orchestrated resources, such as an - * environment’s transit gateway.

- *
+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds to or modifies the tags of the given resource. Tags are metadata which can be used to - * manage a resource. To untag a resource, the caller account must be the same as the resource’s - * OwnerAccountId. Untagging resources across accounts is not supported.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an Amazon Web Services Migration Hub Refactor Spaces route.

+ * @see {@link UpdateRouteCommand} */ - public updateRoute(args: UpdateRouteCommandInput, options?: __HttpHandlerOptions): Promise; - public updateRoute(args: UpdateRouteCommandInput, cb: (err: any, data?: UpdateRouteCommandOutput) => void): void; - public updateRoute( + updateRoute(args: UpdateRouteCommandInput, options?: __HttpHandlerOptions): Promise; + updateRoute(args: UpdateRouteCommandInput, cb: (err: any, data?: UpdateRouteCommandOutput) => void): void; + updateRoute( args: UpdateRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRouteCommandOutput) => void ): void; - public updateRoute( - args: UpdateRouteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRouteCommandOutput) => void), - cb?: (err: any, data?: UpdateRouteCommandOutput) => void - ): Promise | void { - const command = new UpdateRouteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Web Services Migration Hub Refactor Spaces + *

This API reference provides descriptions, syntax, and other details about each of the + * actions and data types for Amazon Web Services Migration Hub Refactor Spaces (Refactor Spaces). The topic for each action shows the API + * request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to + * access an API that is tailored to the programming language or platform that you're using. For + * more information, see Amazon Web Services SDKs.

+ *

To share Refactor Spaces environments with other Amazon Web Services accounts or with Organizations + * and their OUs, use Resource Access Manager's CreateResourceShare API. See CreateResourceShare in the Amazon Web Services RAM API Reference.

+ */ +export class MigrationHubRefactorSpaces + extends MigrationHubRefactorSpacesClient + implements MigrationHubRefactorSpaces {} +createAggregatedClient(commands, MigrationHubRefactorSpaces); diff --git a/clients/client-migration-hub/src/MigrationHub.ts b/clients/client-migration-hub/src/MigrationHub.ts index 9d63936ad819..039060510b94 100644 --- a/clients/client-migration-hub/src/MigrationHub.ts +++ b/clients/client-migration-hub/src/MigrationHub.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -86,722 +87,327 @@ import { PutResourceAttributesCommandInput, PutResourceAttributesCommandOutput, } from "./commands/PutResourceAttributesCommand"; -import { MigrationHubClient } from "./MigrationHubClient"; +import { MigrationHubClient, MigrationHubClientConfig } from "./MigrationHubClient"; -/** - * @public - *

The AWS Migration Hub API methods help to obtain server and application migration status - * and integrate your resource-specific migration tool by providing a programmatic interface - * to Migration Hub.

- *

Remember that you must set your AWS Migration Hub home region before you call any of - * these APIs, or a HomeRegionNotSetException error will be returned. Also, you - * must make the API calls while in your home region.

- */ -export class MigrationHub extends MigrationHubClient { +const commands = { + AssociateCreatedArtifactCommand, + AssociateDiscoveredResourceCommand, + CreateProgressUpdateStreamCommand, + DeleteProgressUpdateStreamCommand, + DescribeApplicationStateCommand, + DescribeMigrationTaskCommand, + DisassociateCreatedArtifactCommand, + DisassociateDiscoveredResourceCommand, + ImportMigrationTaskCommand, + ListApplicationStatesCommand, + ListCreatedArtifactsCommand, + ListDiscoveredResourcesCommand, + ListMigrationTasksCommand, + ListProgressUpdateStreamsCommand, + NotifyApplicationStateCommand, + NotifyMigrationTaskStateCommand, + PutResourceAttributesCommand, +}; + +export interface MigrationHub { /** - * @public - *

Associates a created artifact of an AWS cloud resource, the target receiving the - * migration, with the migration task performed by a migration tool. This API has the - * following traits:

- *
    - *
  • - *

    Migration tools can call the AssociateCreatedArtifact operation to - * indicate which AWS artifact is associated with a migration task.

    - *
  • - *
  • - *

    The created artifact name must be provided in ARN (Amazon Resource Name) format - * which will contain information about type and region; for example: - * arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b.

    - *
  • - *
  • - *

    Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, - * or DMS endpoint, etc.

    - *
  • - *
+ * @see {@link AssociateCreatedArtifactCommand} */ - public associateCreatedArtifact( + associateCreatedArtifact( args: AssociateCreatedArtifactCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateCreatedArtifact( + associateCreatedArtifact( args: AssociateCreatedArtifactCommandInput, cb: (err: any, data?: AssociateCreatedArtifactCommandOutput) => void ): void; - public associateCreatedArtifact( + associateCreatedArtifact( args: AssociateCreatedArtifactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateCreatedArtifactCommandOutput) => void ): void; - public associateCreatedArtifact( - args: AssociateCreatedArtifactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateCreatedArtifactCommandOutput) => void), - cb?: (err: any, data?: AssociateCreatedArtifactCommandOutput) => void - ): Promise | void { - const command = new AssociateCreatedArtifactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a discovered resource ID from Application Discovery Service with a migration - * task.

+ * @see {@link AssociateDiscoveredResourceCommand} */ - public associateDiscoveredResource( + associateDiscoveredResource( args: AssociateDiscoveredResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateDiscoveredResource( + associateDiscoveredResource( args: AssociateDiscoveredResourceCommandInput, cb: (err: any, data?: AssociateDiscoveredResourceCommandOutput) => void ): void; - public associateDiscoveredResource( + associateDiscoveredResource( args: AssociateDiscoveredResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateDiscoveredResourceCommandOutput) => void ): void; - public associateDiscoveredResource( - args: AssociateDiscoveredResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateDiscoveredResourceCommandOutput) => void), - cb?: (err: any, data?: AssociateDiscoveredResourceCommandOutput) => void - ): Promise | void { - const command = new AssociateDiscoveredResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a progress update stream which is an AWS resource used for access control as - * well as a namespace for migration task names that is implicitly linked to your AWS account. - * It must uniquely identify the migration tool as it is used for all updates made by the - * tool; however, it does not need to be unique for each AWS account because it is scoped to - * the AWS account.

+ * @see {@link CreateProgressUpdateStreamCommand} */ - public createProgressUpdateStream( + createProgressUpdateStream( args: CreateProgressUpdateStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public createProgressUpdateStream( + createProgressUpdateStream( args: CreateProgressUpdateStreamCommandInput, cb: (err: any, data?: CreateProgressUpdateStreamCommandOutput) => void ): void; - public createProgressUpdateStream( + createProgressUpdateStream( args: CreateProgressUpdateStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProgressUpdateStreamCommandOutput) => void ): void; - public createProgressUpdateStream( - args: CreateProgressUpdateStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProgressUpdateStreamCommandOutput) => void), - cb?: (err: any, data?: CreateProgressUpdateStreamCommandOutput) => void - ): Promise | void { - const command = new CreateProgressUpdateStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a progress update stream, including all of its tasks, which was previously - * created as an AWS resource used for access control. This API has the following - * traits:

- *
    - *
  • - *

    The only parameter needed for DeleteProgressUpdateStream is the - * stream name (same as a CreateProgressUpdateStream call).

    - *
  • - *
  • - *

    The call will return, and a background process will asynchronously delete the - * stream and all of its resources (tasks, associated resources, resource attributes, - * created artifacts).

    - *
  • - *
  • - *

    If the stream takes time to be deleted, it might still show up on a - * ListProgressUpdateStreams call.

    - *
  • - *
  • - *

    - * CreateProgressUpdateStream, ImportMigrationTask, - * NotifyMigrationTaskState, and all Associate[*] APIs related to the - * tasks belonging to the stream will throw "InvalidInputException" if the stream of the - * same name is in the process of being deleted.

    - *
  • - *
  • - *

    Once the stream and all of its resources are deleted, - * CreateProgressUpdateStream for a stream of the same name will - * succeed, and that stream will be an entirely new logical resource (without any - * resources associated with the old stream).

    - *
  • - *
+ * @see {@link DeleteProgressUpdateStreamCommand} */ - public deleteProgressUpdateStream( + deleteProgressUpdateStream( args: DeleteProgressUpdateStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteProgressUpdateStream( + deleteProgressUpdateStream( args: DeleteProgressUpdateStreamCommandInput, cb: (err: any, data?: DeleteProgressUpdateStreamCommandOutput) => void ): void; - public deleteProgressUpdateStream( + deleteProgressUpdateStream( args: DeleteProgressUpdateStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProgressUpdateStreamCommandOutput) => void ): void; - public deleteProgressUpdateStream( - args: DeleteProgressUpdateStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProgressUpdateStreamCommandOutput) => void), - cb?: (err: any, data?: DeleteProgressUpdateStreamCommandOutput) => void - ): Promise | void { - const command = new DeleteProgressUpdateStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the migration status of an application.

+ * @see {@link DescribeApplicationStateCommand} */ - public describeApplicationState( + describeApplicationState( args: DescribeApplicationStateCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeApplicationState( + describeApplicationState( args: DescribeApplicationStateCommandInput, cb: (err: any, data?: DescribeApplicationStateCommandOutput) => void ): void; - public describeApplicationState( + describeApplicationState( args: DescribeApplicationStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeApplicationStateCommandOutput) => void ): void; - public describeApplicationState( - args: DescribeApplicationStateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeApplicationStateCommandOutput) => void), - cb?: (err: any, data?: DescribeApplicationStateCommandOutput) => void - ): Promise | void { - const command = new DescribeApplicationStateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of all attributes associated with a specific migration task.

+ * @see {@link DescribeMigrationTaskCommand} */ - public describeMigrationTask( + describeMigrationTask( args: DescribeMigrationTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMigrationTask( + describeMigrationTask( args: DescribeMigrationTaskCommandInput, cb: (err: any, data?: DescribeMigrationTaskCommandOutput) => void ): void; - public describeMigrationTask( + describeMigrationTask( args: DescribeMigrationTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMigrationTaskCommandOutput) => void ): void; - public describeMigrationTask( - args: DescribeMigrationTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMigrationTaskCommandOutput) => void), - cb?: (err: any, data?: DescribeMigrationTaskCommandOutput) => void - ): Promise | void { - const command = new DescribeMigrationTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates a created artifact of an AWS resource with a migration task performed by a - * migration tool that was previously associated. This API has the following traits:

- *
    - *
  • - *

    A migration user can call the DisassociateCreatedArtifacts operation - * to disassociate a created AWS Artifact from a migration task.

    - *
  • - *
  • - *

    The created artifact name must be provided in ARN (Amazon Resource Name) format - * which will contain information about type and region; for example: - * arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b.

    - *
  • - *
  • - *

    Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, - * or RDS instance, etc.

    - *
  • - *
+ * @see {@link DisassociateCreatedArtifactCommand} */ - public disassociateCreatedArtifact( + disassociateCreatedArtifact( args: DisassociateCreatedArtifactCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateCreatedArtifact( + disassociateCreatedArtifact( args: DisassociateCreatedArtifactCommandInput, cb: (err: any, data?: DisassociateCreatedArtifactCommandOutput) => void ): void; - public disassociateCreatedArtifact( + disassociateCreatedArtifact( args: DisassociateCreatedArtifactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateCreatedArtifactCommandOutput) => void ): void; - public disassociateCreatedArtifact( - args: DisassociateCreatedArtifactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateCreatedArtifactCommandOutput) => void), - cb?: (err: any, data?: DisassociateCreatedArtifactCommandOutput) => void - ): Promise | void { - const command = new DisassociateCreatedArtifactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociate an Application Discovery Service discovered resource from a migration - * task.

+ * @see {@link DisassociateDiscoveredResourceCommand} */ - public disassociateDiscoveredResource( + disassociateDiscoveredResource( args: DisassociateDiscoveredResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateDiscoveredResource( + disassociateDiscoveredResource( args: DisassociateDiscoveredResourceCommandInput, cb: (err: any, data?: DisassociateDiscoveredResourceCommandOutput) => void ): void; - public disassociateDiscoveredResource( + disassociateDiscoveredResource( args: DisassociateDiscoveredResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateDiscoveredResourceCommandOutput) => void ): void; - public disassociateDiscoveredResource( - args: DisassociateDiscoveredResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateDiscoveredResourceCommandOutput) => void), - cb?: (err: any, data?: DisassociateDiscoveredResourceCommandOutput) => void - ): Promise | void { - const command = new DisassociateDiscoveredResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers a new migration task which represents a server, database, etc., being migrated - * to AWS by a migration tool.

- *

This API is a prerequisite to calling the NotifyMigrationTaskState API as - * the migration tool must first register the migration task with Migration Hub.

+ * @see {@link ImportMigrationTaskCommand} */ - public importMigrationTask( + importMigrationTask( args: ImportMigrationTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public importMigrationTask( + importMigrationTask( args: ImportMigrationTaskCommandInput, cb: (err: any, data?: ImportMigrationTaskCommandOutput) => void ): void; - public importMigrationTask( + importMigrationTask( args: ImportMigrationTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportMigrationTaskCommandOutput) => void ): void; - public importMigrationTask( - args: ImportMigrationTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportMigrationTaskCommandOutput) => void), - cb?: (err: any, data?: ImportMigrationTaskCommandOutput) => void - ): Promise | void { - const command = new ImportMigrationTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the migration statuses for your applications. If you use the optional - * ApplicationIds parameter, only the migration statuses for those - * applications will be returned.

+ * @see {@link ListApplicationStatesCommand} */ - public listApplicationStates( + listApplicationStates( args: ListApplicationStatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplicationStates( + listApplicationStates( args: ListApplicationStatesCommandInput, cb: (err: any, data?: ListApplicationStatesCommandOutput) => void ): void; - public listApplicationStates( + listApplicationStates( args: ListApplicationStatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationStatesCommandOutput) => void ): void; - public listApplicationStates( - args: ListApplicationStatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationStatesCommandOutput) => void), - cb?: (err: any, data?: ListApplicationStatesCommandOutput) => void - ): Promise | void { - const command = new ListApplicationStatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the created artifacts attached to a given migration task in an update stream. This - * API has the following traits:

- *
    - *
  • - *

    Gets the list of the created artifacts while - * migration is taking place.

    - *
  • - *
  • - *

    Shows the artifacts created by the migration tool that was associated by the - * AssociateCreatedArtifact API.

    - *
  • - *
  • - *

    Lists created artifacts in a paginated interface.

    - *
  • - *
+ * @see {@link ListCreatedArtifactsCommand} */ - public listCreatedArtifacts( + listCreatedArtifacts( args: ListCreatedArtifactsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCreatedArtifacts( + listCreatedArtifacts( args: ListCreatedArtifactsCommandInput, cb: (err: any, data?: ListCreatedArtifactsCommandOutput) => void ): void; - public listCreatedArtifacts( + listCreatedArtifacts( args: ListCreatedArtifactsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCreatedArtifactsCommandOutput) => void ): void; - public listCreatedArtifacts( - args: ListCreatedArtifactsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCreatedArtifactsCommandOutput) => void), - cb?: (err: any, data?: ListCreatedArtifactsCommandOutput) => void - ): Promise | void { - const command = new ListCreatedArtifactsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists discovered resources associated with the given MigrationTask.

+ * @see {@link ListDiscoveredResourcesCommand} */ - public listDiscoveredResources( + listDiscoveredResources( args: ListDiscoveredResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDiscoveredResources( + listDiscoveredResources( args: ListDiscoveredResourcesCommandInput, cb: (err: any, data?: ListDiscoveredResourcesCommandOutput) => void ): void; - public listDiscoveredResources( + listDiscoveredResources( args: ListDiscoveredResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDiscoveredResourcesCommandOutput) => void ): void; - public listDiscoveredResources( - args: ListDiscoveredResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDiscoveredResourcesCommandOutput) => void), - cb?: (err: any, data?: ListDiscoveredResourcesCommandOutput) => void - ): Promise | void { - const command = new ListDiscoveredResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all, or filtered by resource name, migration tasks associated with the user - * account making this call. This API has the following traits:

- *
    - *
  • - *

    Can show a summary list of the most recent migration tasks.

    - *
  • - *
  • - *

    Can show a summary list of migration tasks associated with a given discovered - * resource.

    - *
  • - *
  • - *

    Lists migration tasks in a paginated interface.

    - *
  • - *
+ * @see {@link ListMigrationTasksCommand} */ - public listMigrationTasks( + listMigrationTasks( args: ListMigrationTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMigrationTasks( + listMigrationTasks( args: ListMigrationTasksCommandInput, cb: (err: any, data?: ListMigrationTasksCommandOutput) => void ): void; - public listMigrationTasks( + listMigrationTasks( args: ListMigrationTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMigrationTasksCommandOutput) => void ): void; - public listMigrationTasks( - args: ListMigrationTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMigrationTasksCommandOutput) => void), - cb?: (err: any, data?: ListMigrationTasksCommandOutput) => void - ): Promise | void { - const command = new ListMigrationTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists progress update streams associated with the user account making this call.

+ * @see {@link ListProgressUpdateStreamsCommand} */ - public listProgressUpdateStreams( + listProgressUpdateStreams( args: ListProgressUpdateStreamsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProgressUpdateStreams( + listProgressUpdateStreams( args: ListProgressUpdateStreamsCommandInput, cb: (err: any, data?: ListProgressUpdateStreamsCommandOutput) => void ): void; - public listProgressUpdateStreams( + listProgressUpdateStreams( args: ListProgressUpdateStreamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProgressUpdateStreamsCommandOutput) => void ): void; - public listProgressUpdateStreams( - args: ListProgressUpdateStreamsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProgressUpdateStreamsCommandOutput) => void), - cb?: (err: any, data?: ListProgressUpdateStreamsCommandOutput) => void - ): Promise | void { - const command = new ListProgressUpdateStreamsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the migration state of an application. For a given application identified by the - * value passed to ApplicationId, its status is set or updated by passing one of - * three values to Status: NOT_STARTED | IN_PROGRESS | - * COMPLETED.

+ * @see {@link NotifyApplicationStateCommand} */ - public notifyApplicationState( + notifyApplicationState( args: NotifyApplicationStateCommandInput, options?: __HttpHandlerOptions ): Promise; - public notifyApplicationState( + notifyApplicationState( args: NotifyApplicationStateCommandInput, cb: (err: any, data?: NotifyApplicationStateCommandOutput) => void ): void; - public notifyApplicationState( + notifyApplicationState( args: NotifyApplicationStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NotifyApplicationStateCommandOutput) => void ): void; - public notifyApplicationState( - args: NotifyApplicationStateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NotifyApplicationStateCommandOutput) => void), - cb?: (err: any, data?: NotifyApplicationStateCommandOutput) => void - ): Promise | void { - const command = new NotifyApplicationStateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Notifies Migration Hub of the current status, progress, or other detail regarding a - * migration task. This API has the following traits:

- *
    - *
  • - *

    Migration tools will call the NotifyMigrationTaskState API to share - * the latest progress and status.

    - *
  • - *
  • - *

    - * MigrationTaskName is used for addressing updates to the correct - * target.

    - *
  • - *
  • - *

    - * ProgressUpdateStream is used for access control and to provide a - * namespace for each migration tool.

    - *
  • - *
+ * @see {@link NotifyMigrationTaskStateCommand} */ - public notifyMigrationTaskState( + notifyMigrationTaskState( args: NotifyMigrationTaskStateCommandInput, options?: __HttpHandlerOptions ): Promise; - public notifyMigrationTaskState( + notifyMigrationTaskState( args: NotifyMigrationTaskStateCommandInput, cb: (err: any, data?: NotifyMigrationTaskStateCommandOutput) => void ): void; - public notifyMigrationTaskState( + notifyMigrationTaskState( args: NotifyMigrationTaskStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NotifyMigrationTaskStateCommandOutput) => void ): void; - public notifyMigrationTaskState( - args: NotifyMigrationTaskStateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NotifyMigrationTaskStateCommandOutput) => void), - cb?: (err: any, data?: NotifyMigrationTaskStateCommandOutput) => void - ): Promise | void { - const command = new NotifyMigrationTaskStateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides identifying details of the resource being migrated so that it can be associated - * in the Application Discovery Service repository. This association occurs asynchronously - * after PutResourceAttributes returns.

- * - *
    - *
  • - *

    Keep in mind that subsequent calls to PutResourceAttributes will override - * previously stored attributes. For example, if it is first called with a MAC - * address, but later, it is desired to add an IP address, it - * will then be required to call it with both the IP and MAC - * addresses to prevent overriding the MAC address.

    - *
  • - *
  • - *

    Note the instructions regarding the special use case of the - * ResourceAttributeList - * parameter when specifying any - * "VM" related value.

    - *
  • - *
- *
- * - * - *

Because this is an asynchronous call, it will always return 200, whether an - * association occurs or not. To confirm if an association was found based on the provided - * details, call ListDiscoveredResources.

- *
+ * @see {@link PutResourceAttributesCommand} */ - public putResourceAttributes( + putResourceAttributes( args: PutResourceAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResourceAttributes( + putResourceAttributes( args: PutResourceAttributesCommandInput, cb: (err: any, data?: PutResourceAttributesCommandOutput) => void ): void; - public putResourceAttributes( + putResourceAttributes( args: PutResourceAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourceAttributesCommandOutput) => void ): void; - public putResourceAttributes( - args: PutResourceAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourceAttributesCommandOutput) => void), - cb?: (err: any, data?: PutResourceAttributesCommandOutput) => void - ): Promise | void { - const command = new PutResourceAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The AWS Migration Hub API methods help to obtain server and application migration status + * and integrate your resource-specific migration tool by providing a programmatic interface + * to Migration Hub.

+ *

Remember that you must set your AWS Migration Hub home region before you call any of + * these APIs, or a HomeRegionNotSetException error will be returned. Also, you + * must make the API calls while in your home region.

+ */ +export class MigrationHub extends MigrationHubClient implements MigrationHub {} +createAggregatedClient(commands, MigrationHub); diff --git a/clients/client-migrationhub-config/src/MigrationHubConfig.ts b/clients/client-migrationhub-config/src/MigrationHubConfig.ts index 4a4b11ad3c0d..e3b9e3ddc3af 100644 --- a/clients/client-migrationhub-config/src/MigrationHubConfig.ts +++ b/clients/client-migrationhub-config/src/MigrationHubConfig.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -16,139 +17,89 @@ import { GetHomeRegionCommandInput, GetHomeRegionCommandOutput, } from "./commands/GetHomeRegionCommand"; -import { MigrationHubConfigClient } from "./MigrationHubConfigClient"; +import { MigrationHubConfigClient, MigrationHubConfigClientConfig } from "./MigrationHubConfigClient"; -/** - * @public - *

The AWS Migration Hub home region APIs are available specifically for working with your - * Migration Hub home region. You can use these APIs to determine a home region, as well as to - * create and work with controls that describe the home region.

- * - *
    - *
  • - *

    You must make API calls for write actions (create, notify, associate, disassociate, - * import, or put) while in your home region, or a HomeRegionNotSetException - * error is returned.

    - *
  • - *
  • - *

    API calls for read actions (list, describe, stop, and delete) are permitted outside of - * your home region.

    - *
  • - *
  • - *

    If you call a write API outside the home region, an InvalidInputException - * is returned.

    - *
  • - *
  • - *

    You can call GetHomeRegion action to obtain the account's Migration Hub - * home region.

    - *
  • - *
- * - *

For specific API usage, see the sections that follow in this AWS Migration Hub Home Region - * API reference.

- */ -export class MigrationHubConfig extends MigrationHubConfigClient { +const commands = { + CreateHomeRegionControlCommand, + DescribeHomeRegionControlsCommand, + GetHomeRegionCommand, +}; + +export interface MigrationHubConfig { /** - * @public - *

This API sets up the home region for the calling account only.

+ * @see {@link CreateHomeRegionControlCommand} */ - public createHomeRegionControl( + createHomeRegionControl( args: CreateHomeRegionControlCommandInput, options?: __HttpHandlerOptions ): Promise; - public createHomeRegionControl( + createHomeRegionControl( args: CreateHomeRegionControlCommandInput, cb: (err: any, data?: CreateHomeRegionControlCommandOutput) => void ): void; - public createHomeRegionControl( + createHomeRegionControl( args: CreateHomeRegionControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHomeRegionControlCommandOutput) => void ): void; - public createHomeRegionControl( - args: CreateHomeRegionControlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateHomeRegionControlCommandOutput) => void), - cb?: (err: any, data?: CreateHomeRegionControlCommandOutput) => void - ): Promise | void { - const command = new CreateHomeRegionControlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This API permits filtering on the ControlId and HomeRegion - * fields.

+ * @see {@link DescribeHomeRegionControlsCommand} */ - public describeHomeRegionControls( + describeHomeRegionControls( args: DescribeHomeRegionControlsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeHomeRegionControls( + describeHomeRegionControls( args: DescribeHomeRegionControlsCommandInput, cb: (err: any, data?: DescribeHomeRegionControlsCommandOutput) => void ): void; - public describeHomeRegionControls( + describeHomeRegionControls( args: DescribeHomeRegionControlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHomeRegionControlsCommandOutput) => void ): void; - public describeHomeRegionControls( - args: DescribeHomeRegionControlsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeHomeRegionControlsCommandOutput) => void), - cb?: (err: any, data?: DescribeHomeRegionControlsCommandOutput) => void - ): Promise | void { - const command = new DescribeHomeRegionControlsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the calling account’s home region, if configured. This API is used by other AWS - * services to determine the regional endpoint for calling AWS Application Discovery Service and - * Migration Hub. You must call GetHomeRegion at least once before you call any - * other AWS Application Discovery Service and AWS Migration Hub APIs, to obtain the account's - * Migration Hub home region.

+ * @see {@link GetHomeRegionCommand} */ - public getHomeRegion( - args: GetHomeRegionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getHomeRegion( - args: GetHomeRegionCommandInput, - cb: (err: any, data?: GetHomeRegionCommandOutput) => void - ): void; - public getHomeRegion( + getHomeRegion(args: GetHomeRegionCommandInput, options?: __HttpHandlerOptions): Promise; + getHomeRegion(args: GetHomeRegionCommandInput, cb: (err: any, data?: GetHomeRegionCommandOutput) => void): void; + getHomeRegion( args: GetHomeRegionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHomeRegionCommandOutput) => void ): void; - public getHomeRegion( - args: GetHomeRegionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetHomeRegionCommandOutput) => void), - cb?: (err: any, data?: GetHomeRegionCommandOutput) => void - ): Promise | void { - const command = new GetHomeRegionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The AWS Migration Hub home region APIs are available specifically for working with your + * Migration Hub home region. You can use these APIs to determine a home region, as well as to + * create and work with controls that describe the home region.

+ * + *
    + *
  • + *

    You must make API calls for write actions (create, notify, associate, disassociate, + * import, or put) while in your home region, or a HomeRegionNotSetException + * error is returned.

    + *
  • + *
  • + *

    API calls for read actions (list, describe, stop, and delete) are permitted outside of + * your home region.

    + *
  • + *
  • + *

    If you call a write API outside the home region, an InvalidInputException + * is returned.

    + *
  • + *
  • + *

    You can call GetHomeRegion action to obtain the account's Migration Hub + * home region.

    + *
  • + *
+ * + *

For specific API usage, see the sections that follow in this AWS Migration Hub Home Region + * API reference.

+ */ +export class MigrationHubConfig extends MigrationHubConfigClient implements MigrationHubConfig {} +createAggregatedClient(commands, MigrationHubConfig); diff --git a/clients/client-migrationhuborchestrator/src/MigrationHubOrchestrator.ts b/clients/client-migrationhuborchestrator/src/MigrationHubOrchestrator.ts index 75490696c1dd..ca0c65dd7c84 100644 --- a/clients/client-migrationhuborchestrator/src/MigrationHubOrchestrator.ts +++ b/clients/client-migrationhuborchestrator/src/MigrationHubOrchestrator.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -125,913 +126,455 @@ import { UpdateWorkflowStepGroupCommandInput, UpdateWorkflowStepGroupCommandOutput, } from "./commands/UpdateWorkflowStepGroupCommand"; -import { MigrationHubOrchestratorClient } from "./MigrationHubOrchestratorClient"; +import { MigrationHubOrchestratorClient, MigrationHubOrchestratorClientConfig } from "./MigrationHubOrchestratorClient"; -/** - * @public - *

This API reference provides descriptions, syntax, and other details about each of the - * actions and data types for AWS Migration Hub Orchestrator. he topic for each action shows the API - * request parameters and the response. Alternatively, you can use one of the AWS SDKs to - * access an API that is tailored to the programming language or platform that you're - * using.

- */ -export class MigrationHubOrchestrator extends MigrationHubOrchestratorClient { +const commands = { + CreateWorkflowCommand, + CreateWorkflowStepCommand, + CreateWorkflowStepGroupCommand, + DeleteWorkflowCommand, + DeleteWorkflowStepCommand, + DeleteWorkflowStepGroupCommand, + GetTemplateCommand, + GetTemplateStepCommand, + GetTemplateStepGroupCommand, + GetWorkflowCommand, + GetWorkflowStepCommand, + GetWorkflowStepGroupCommand, + ListPluginsCommand, + ListTagsForResourceCommand, + ListTemplatesCommand, + ListTemplateStepGroupsCommand, + ListTemplateStepsCommand, + ListWorkflowsCommand, + ListWorkflowStepGroupsCommand, + ListWorkflowStepsCommand, + RetryWorkflowStepCommand, + StartWorkflowCommand, + StopWorkflowCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateWorkflowCommand, + UpdateWorkflowStepCommand, + UpdateWorkflowStepGroupCommand, +}; + +export interface MigrationHubOrchestrator { /** - * @public - *

Create a workflow to orchestrate your migrations.

+ * @see {@link CreateWorkflowCommand} */ - public createWorkflow( + createWorkflow( args: CreateWorkflowCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorkflow( - args: CreateWorkflowCommandInput, - cb: (err: any, data?: CreateWorkflowCommandOutput) => void - ): void; - public createWorkflow( + createWorkflow(args: CreateWorkflowCommandInput, cb: (err: any, data?: CreateWorkflowCommandOutput) => void): void; + createWorkflow( args: CreateWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkflowCommandOutput) => void ): void; - public createWorkflow( - args: CreateWorkflowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorkflowCommandOutput) => void), - cb?: (err: any, data?: CreateWorkflowCommandOutput) => void - ): Promise | void { - const command = new CreateWorkflowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create a step in the migration workflow.

+ * @see {@link CreateWorkflowStepCommand} */ - public createWorkflowStep( + createWorkflowStep( args: CreateWorkflowStepCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorkflowStep( + createWorkflowStep( args: CreateWorkflowStepCommandInput, cb: (err: any, data?: CreateWorkflowStepCommandOutput) => void ): void; - public createWorkflowStep( + createWorkflowStep( args: CreateWorkflowStepCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkflowStepCommandOutput) => void ): void; - public createWorkflowStep( - args: CreateWorkflowStepCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorkflowStepCommandOutput) => void), - cb?: (err: any, data?: CreateWorkflowStepCommandOutput) => void - ): Promise | void { - const command = new CreateWorkflowStepCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create a step group in a migration workflow.

+ * @see {@link CreateWorkflowStepGroupCommand} */ - public createWorkflowStepGroup( + createWorkflowStepGroup( args: CreateWorkflowStepGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorkflowStepGroup( + createWorkflowStepGroup( args: CreateWorkflowStepGroupCommandInput, cb: (err: any, data?: CreateWorkflowStepGroupCommandOutput) => void ): void; - public createWorkflowStepGroup( + createWorkflowStepGroup( args: CreateWorkflowStepGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkflowStepGroupCommandOutput) => void ): void; - public createWorkflowStepGroup( - args: CreateWorkflowStepGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorkflowStepGroupCommandOutput) => void), - cb?: (err: any, data?: CreateWorkflowStepGroupCommandOutput) => void - ): Promise | void { - const command = new CreateWorkflowStepGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete a migration workflow. You must pause a running workflow in Migration Hub Orchestrator console to - * delete it.

+ * @see {@link DeleteWorkflowCommand} */ - public deleteWorkflow( + deleteWorkflow( args: DeleteWorkflowCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWorkflow( - args: DeleteWorkflowCommandInput, - cb: (err: any, data?: DeleteWorkflowCommandOutput) => void - ): void; - public deleteWorkflow( + deleteWorkflow(args: DeleteWorkflowCommandInput, cb: (err: any, data?: DeleteWorkflowCommandOutput) => void): void; + deleteWorkflow( args: DeleteWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkflowCommandOutput) => void ): void; - public deleteWorkflow( - args: DeleteWorkflowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorkflowCommandOutput) => void), - cb?: (err: any, data?: DeleteWorkflowCommandOutput) => void - ): Promise | void { - const command = new DeleteWorkflowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete a step in a migration workflow. Pause the workflow to delete a running - * step.

+ * @see {@link DeleteWorkflowStepCommand} */ - public deleteWorkflowStep( + deleteWorkflowStep( args: DeleteWorkflowStepCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWorkflowStep( + deleteWorkflowStep( args: DeleteWorkflowStepCommandInput, cb: (err: any, data?: DeleteWorkflowStepCommandOutput) => void ): void; - public deleteWorkflowStep( + deleteWorkflowStep( args: DeleteWorkflowStepCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkflowStepCommandOutput) => void ): void; - public deleteWorkflowStep( - args: DeleteWorkflowStepCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorkflowStepCommandOutput) => void), - cb?: (err: any, data?: DeleteWorkflowStepCommandOutput) => void - ): Promise | void { - const command = new DeleteWorkflowStepCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete a step group in a migration workflow.

+ * @see {@link DeleteWorkflowStepGroupCommand} */ - public deleteWorkflowStepGroup( + deleteWorkflowStepGroup( args: DeleteWorkflowStepGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWorkflowStepGroup( + deleteWorkflowStepGroup( args: DeleteWorkflowStepGroupCommandInput, cb: (err: any, data?: DeleteWorkflowStepGroupCommandOutput) => void ): void; - public deleteWorkflowStepGroup( + deleteWorkflowStepGroup( args: DeleteWorkflowStepGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkflowStepGroupCommandOutput) => void ): void; - public deleteWorkflowStepGroup( - args: DeleteWorkflowStepGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorkflowStepGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteWorkflowStepGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteWorkflowStepGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the template you want to use for creating a migration workflow.

+ * @see {@link GetTemplateCommand} */ - public getTemplate(args: GetTemplateCommandInput, options?: __HttpHandlerOptions): Promise; - public getTemplate(args: GetTemplateCommandInput, cb: (err: any, data?: GetTemplateCommandOutput) => void): void; - public getTemplate( + getTemplate(args: GetTemplateCommandInput, options?: __HttpHandlerOptions): Promise; + getTemplate(args: GetTemplateCommandInput, cb: (err: any, data?: GetTemplateCommandOutput) => void): void; + getTemplate( args: GetTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTemplateCommandOutput) => void ): void; - public getTemplate( - args: GetTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTemplateCommandOutput) => void), - cb?: (err: any, data?: GetTemplateCommandOutput) => void - ): Promise | void { - const command = new GetTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get a specific step in a template.

+ * @see {@link GetTemplateStepCommand} */ - public getTemplateStep( + getTemplateStep( args: GetTemplateStepCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTemplateStep( - args: GetTemplateStepCommandInput, - cb: (err: any, data?: GetTemplateStepCommandOutput) => void - ): void; - public getTemplateStep( + getTemplateStep(args: GetTemplateStepCommandInput, cb: (err: any, data?: GetTemplateStepCommandOutput) => void): void; + getTemplateStep( args: GetTemplateStepCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTemplateStepCommandOutput) => void ): void; - public getTemplateStep( - args: GetTemplateStepCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTemplateStepCommandOutput) => void), - cb?: (err: any, data?: GetTemplateStepCommandOutput) => void - ): Promise | void { - const command = new GetTemplateStepCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get a step group in a template.

+ * @see {@link GetTemplateStepGroupCommand} */ - public getTemplateStepGroup( + getTemplateStepGroup( args: GetTemplateStepGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTemplateStepGroup( + getTemplateStepGroup( args: GetTemplateStepGroupCommandInput, cb: (err: any, data?: GetTemplateStepGroupCommandOutput) => void ): void; - public getTemplateStepGroup( + getTemplateStepGroup( args: GetTemplateStepGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTemplateStepGroupCommandOutput) => void ): void; - public getTemplateStepGroup( - args: GetTemplateStepGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTemplateStepGroupCommandOutput) => void), - cb?: (err: any, data?: GetTemplateStepGroupCommandOutput) => void - ): Promise | void { - const command = new GetTemplateStepGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get migration workflow.

+ * @see {@link GetWorkflowCommand} */ - public getWorkflow(args: GetWorkflowCommandInput, options?: __HttpHandlerOptions): Promise; - public getWorkflow(args: GetWorkflowCommandInput, cb: (err: any, data?: GetWorkflowCommandOutput) => void): void; - public getWorkflow( + getWorkflow(args: GetWorkflowCommandInput, options?: __HttpHandlerOptions): Promise; + getWorkflow(args: GetWorkflowCommandInput, cb: (err: any, data?: GetWorkflowCommandOutput) => void): void; + getWorkflow( args: GetWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkflowCommandOutput) => void ): void; - public getWorkflow( - args: GetWorkflowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkflowCommandOutput) => void), - cb?: (err: any, data?: GetWorkflowCommandOutput) => void - ): Promise | void { - const command = new GetWorkflowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get a step in the migration workflow.

+ * @see {@link GetWorkflowStepCommand} */ - public getWorkflowStep( + getWorkflowStep( args: GetWorkflowStepCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWorkflowStep( - args: GetWorkflowStepCommandInput, - cb: (err: any, data?: GetWorkflowStepCommandOutput) => void - ): void; - public getWorkflowStep( + getWorkflowStep(args: GetWorkflowStepCommandInput, cb: (err: any, data?: GetWorkflowStepCommandOutput) => void): void; + getWorkflowStep( args: GetWorkflowStepCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkflowStepCommandOutput) => void ): void; - public getWorkflowStep( - args: GetWorkflowStepCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkflowStepCommandOutput) => void), - cb?: (err: any, data?: GetWorkflowStepCommandOutput) => void - ): Promise | void { - const command = new GetWorkflowStepCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the step group of a migration workflow.

+ * @see {@link GetWorkflowStepGroupCommand} */ - public getWorkflowStepGroup( + getWorkflowStepGroup( args: GetWorkflowStepGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWorkflowStepGroup( + getWorkflowStepGroup( args: GetWorkflowStepGroupCommandInput, cb: (err: any, data?: GetWorkflowStepGroupCommandOutput) => void ): void; - public getWorkflowStepGroup( + getWorkflowStepGroup( args: GetWorkflowStepGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkflowStepGroupCommandOutput) => void ): void; - public getWorkflowStepGroup( - args: GetWorkflowStepGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkflowStepGroupCommandOutput) => void), - cb?: (err: any, data?: GetWorkflowStepGroupCommandOutput) => void - ): Promise | void { - const command = new GetWorkflowStepGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List AWS Migration Hub Orchestrator plugins.

+ * @see {@link ListPluginsCommand} */ - public listPlugins(args: ListPluginsCommandInput, options?: __HttpHandlerOptions): Promise; - public listPlugins(args: ListPluginsCommandInput, cb: (err: any, data?: ListPluginsCommandOutput) => void): void; - public listPlugins( + listPlugins(args: ListPluginsCommandInput, options?: __HttpHandlerOptions): Promise; + listPlugins(args: ListPluginsCommandInput, cb: (err: any, data?: ListPluginsCommandOutput) => void): void; + listPlugins( args: ListPluginsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPluginsCommandOutput) => void ): void; - public listPlugins( - args: ListPluginsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPluginsCommandOutput) => void), - cb?: (err: any, data?: ListPluginsCommandOutput) => void - ): Promise | void { - const command = new ListPluginsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the tags added to a resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the templates available in Migration Hub Orchestrator to create a migration workflow.

+ * @see {@link ListTemplatesCommand} */ - public listTemplates( - args: ListTemplatesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listTemplates( - args: ListTemplatesCommandInput, - cb: (err: any, data?: ListTemplatesCommandOutput) => void - ): void; - public listTemplates( + listTemplates(args: ListTemplatesCommandInput, options?: __HttpHandlerOptions): Promise; + listTemplates(args: ListTemplatesCommandInput, cb: (err: any, data?: ListTemplatesCommandOutput) => void): void; + listTemplates( args: ListTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTemplatesCommandOutput) => void ): void; - public listTemplates( - args: ListTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the step groups in a template.

+ * @see {@link ListTemplateStepGroupsCommand} */ - public listTemplateStepGroups( + listTemplateStepGroups( args: ListTemplateStepGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTemplateStepGroups( + listTemplateStepGroups( args: ListTemplateStepGroupsCommandInput, cb: (err: any, data?: ListTemplateStepGroupsCommandOutput) => void ): void; - public listTemplateStepGroups( + listTemplateStepGroups( args: ListTemplateStepGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTemplateStepGroupsCommandOutput) => void ): void; - public listTemplateStepGroups( - args: ListTemplateStepGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTemplateStepGroupsCommandOutput) => void), - cb?: (err: any, data?: ListTemplateStepGroupsCommandOutput) => void - ): Promise | void { - const command = new ListTemplateStepGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the steps in a template.

+ * @see {@link ListTemplateStepsCommand} */ - public listTemplateSteps( + listTemplateSteps( args: ListTemplateStepsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTemplateSteps( + listTemplateSteps( args: ListTemplateStepsCommandInput, cb: (err: any, data?: ListTemplateStepsCommandOutput) => void ): void; - public listTemplateSteps( + listTemplateSteps( args: ListTemplateStepsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTemplateStepsCommandOutput) => void ): void; - public listTemplateSteps( - args: ListTemplateStepsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTemplateStepsCommandOutput) => void), - cb?: (err: any, data?: ListTemplateStepsCommandOutput) => void - ): Promise | void { - const command = new ListTemplateStepsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the migration workflows.

+ * @see {@link ListWorkflowsCommand} */ - public listWorkflows( - args: ListWorkflowsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listWorkflows( - args: ListWorkflowsCommandInput, - cb: (err: any, data?: ListWorkflowsCommandOutput) => void - ): void; - public listWorkflows( + listWorkflows(args: ListWorkflowsCommandInput, options?: __HttpHandlerOptions): Promise; + listWorkflows(args: ListWorkflowsCommandInput, cb: (err: any, data?: ListWorkflowsCommandOutput) => void): void; + listWorkflows( args: ListWorkflowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkflowsCommandOutput) => void ): void; - public listWorkflows( - args: ListWorkflowsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkflowsCommandOutput) => void), - cb?: (err: any, data?: ListWorkflowsCommandOutput) => void - ): Promise | void { - const command = new ListWorkflowsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the step groups in a migration workflow.

+ * @see {@link ListWorkflowStepGroupsCommand} */ - public listWorkflowStepGroups( + listWorkflowStepGroups( args: ListWorkflowStepGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWorkflowStepGroups( + listWorkflowStepGroups( args: ListWorkflowStepGroupsCommandInput, cb: (err: any, data?: ListWorkflowStepGroupsCommandOutput) => void ): void; - public listWorkflowStepGroups( + listWorkflowStepGroups( args: ListWorkflowStepGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkflowStepGroupsCommandOutput) => void ): void; - public listWorkflowStepGroups( - args: ListWorkflowStepGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkflowStepGroupsCommandOutput) => void), - cb?: (err: any, data?: ListWorkflowStepGroupsCommandOutput) => void - ): Promise | void { - const command = new ListWorkflowStepGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the steps in a workflow.

+ * @see {@link ListWorkflowStepsCommand} */ - public listWorkflowSteps( + listWorkflowSteps( args: ListWorkflowStepsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWorkflowSteps( + listWorkflowSteps( args: ListWorkflowStepsCommandInput, cb: (err: any, data?: ListWorkflowStepsCommandOutput) => void ): void; - public listWorkflowSteps( + listWorkflowSteps( args: ListWorkflowStepsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkflowStepsCommandOutput) => void ): void; - public listWorkflowSteps( - args: ListWorkflowStepsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkflowStepsCommandOutput) => void), - cb?: (err: any, data?: ListWorkflowStepsCommandOutput) => void - ): Promise | void { - const command = new ListWorkflowStepsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retry a failed step in a migration workflow.

+ * @see {@link RetryWorkflowStepCommand} */ - public retryWorkflowStep( + retryWorkflowStep( args: RetryWorkflowStepCommandInput, options?: __HttpHandlerOptions ): Promise; - public retryWorkflowStep( + retryWorkflowStep( args: RetryWorkflowStepCommandInput, cb: (err: any, data?: RetryWorkflowStepCommandOutput) => void ): void; - public retryWorkflowStep( + retryWorkflowStep( args: RetryWorkflowStepCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RetryWorkflowStepCommandOutput) => void ): void; - public retryWorkflowStep( - args: RetryWorkflowStepCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RetryWorkflowStepCommandOutput) => void), - cb?: (err: any, data?: RetryWorkflowStepCommandOutput) => void - ): Promise | void { - const command = new RetryWorkflowStepCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Start a migration workflow.

+ * @see {@link StartWorkflowCommand} */ - public startWorkflow( - args: StartWorkflowCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public startWorkflow( - args: StartWorkflowCommandInput, - cb: (err: any, data?: StartWorkflowCommandOutput) => void - ): void; - public startWorkflow( + startWorkflow(args: StartWorkflowCommandInput, options?: __HttpHandlerOptions): Promise; + startWorkflow(args: StartWorkflowCommandInput, cb: (err: any, data?: StartWorkflowCommandOutput) => void): void; + startWorkflow( args: StartWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartWorkflowCommandOutput) => void ): void; - public startWorkflow( - args: StartWorkflowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartWorkflowCommandOutput) => void), - cb?: (err: any, data?: StartWorkflowCommandOutput) => void - ): Promise | void { - const command = new StartWorkflowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stop an ongoing migration workflow.

+ * @see {@link StopWorkflowCommand} */ - public stopWorkflow( - args: StopWorkflowCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public stopWorkflow(args: StopWorkflowCommandInput, cb: (err: any, data?: StopWorkflowCommandOutput) => void): void; - public stopWorkflow( + stopWorkflow(args: StopWorkflowCommandInput, options?: __HttpHandlerOptions): Promise; + stopWorkflow(args: StopWorkflowCommandInput, cb: (err: any, data?: StopWorkflowCommandOutput) => void): void; + stopWorkflow( args: StopWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopWorkflowCommandOutput) => void ): void; - public stopWorkflow( - args: StopWorkflowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopWorkflowCommandOutput) => void), - cb?: (err: any, data?: StopWorkflowCommandOutput) => void - ): Promise | void { - const command = new StopWorkflowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Tag a resource by specifying its Amazon Resource Name (ARN).

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the tags for a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update a migration workflow.

+ * @see {@link UpdateWorkflowCommand} */ - public updateWorkflow( + updateWorkflow( args: UpdateWorkflowCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWorkflow( - args: UpdateWorkflowCommandInput, - cb: (err: any, data?: UpdateWorkflowCommandOutput) => void - ): void; - public updateWorkflow( + updateWorkflow(args: UpdateWorkflowCommandInput, cb: (err: any, data?: UpdateWorkflowCommandOutput) => void): void; + updateWorkflow( args: UpdateWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkflowCommandOutput) => void ): void; - public updateWorkflow( - args: UpdateWorkflowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWorkflowCommandOutput) => void), - cb?: (err: any, data?: UpdateWorkflowCommandOutput) => void - ): Promise | void { - const command = new UpdateWorkflowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update a step in a migration workflow.

+ * @see {@link UpdateWorkflowStepCommand} */ - public updateWorkflowStep( + updateWorkflowStep( args: UpdateWorkflowStepCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWorkflowStep( + updateWorkflowStep( args: UpdateWorkflowStepCommandInput, cb: (err: any, data?: UpdateWorkflowStepCommandOutput) => void ): void; - public updateWorkflowStep( + updateWorkflowStep( args: UpdateWorkflowStepCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkflowStepCommandOutput) => void ): void; - public updateWorkflowStep( - args: UpdateWorkflowStepCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWorkflowStepCommandOutput) => void), - cb?: (err: any, data?: UpdateWorkflowStepCommandOutput) => void - ): Promise | void { - const command = new UpdateWorkflowStepCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update the step group in a migration workflow.

+ * @see {@link UpdateWorkflowStepGroupCommand} */ - public updateWorkflowStepGroup( + updateWorkflowStepGroup( args: UpdateWorkflowStepGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWorkflowStepGroup( + updateWorkflowStepGroup( args: UpdateWorkflowStepGroupCommandInput, cb: (err: any, data?: UpdateWorkflowStepGroupCommandOutput) => void ): void; - public updateWorkflowStepGroup( + updateWorkflowStepGroup( args: UpdateWorkflowStepGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkflowStepGroupCommandOutput) => void ): void; - public updateWorkflowStepGroup( - args: UpdateWorkflowStepGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWorkflowStepGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateWorkflowStepGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateWorkflowStepGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

This API reference provides descriptions, syntax, and other details about each of the + * actions and data types for AWS Migration Hub Orchestrator. he topic for each action shows the API + * request parameters and the response. Alternatively, you can use one of the AWS SDKs to + * access an API that is tailored to the programming language or platform that you're + * using.

+ */ +export class MigrationHubOrchestrator extends MigrationHubOrchestratorClient implements MigrationHubOrchestrator {} +createAggregatedClient(commands, MigrationHubOrchestrator); diff --git a/clients/client-migrationhubstrategy/src/MigrationHubStrategy.ts b/clients/client-migrationhubstrategy/src/MigrationHubStrategy.ts index b68acd2de927..f03c0cd8582d 100644 --- a/clients/client-migrationhubstrategy/src/MigrationHubStrategy.ts +++ b/clients/client-migrationhubstrategy/src/MigrationHubStrategy.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -102,704 +103,378 @@ import { UpdateServerConfigCommandInput, UpdateServerConfigCommandOutput, } from "./commands/UpdateServerConfigCommand"; -import { MigrationHubStrategyClient } from "./MigrationHubStrategyClient"; +import { MigrationHubStrategyClient, MigrationHubStrategyClientConfig } from "./MigrationHubStrategyClient"; -/** - * @public - * Migration Hub Strategy Recommendations - *

This API reference provides descriptions, syntax, and other details about each of the - * actions and data types for Migration Hub Strategy Recommendations (Strategy Recommendations). The topic for each action shows the API - * request parameters and the response. Alternatively, you can use one of the AWS SDKs to - * access an API that is tailored to the programming language or platform that you're using. For - * more information, see AWS SDKs.

- */ -export class MigrationHubStrategy extends MigrationHubStrategyClient { +const commands = { + GetApplicationComponentDetailsCommand, + GetApplicationComponentStrategiesCommand, + GetAssessmentCommand, + GetImportFileTaskCommand, + GetLatestAssessmentIdCommand, + GetPortfolioPreferencesCommand, + GetPortfolioSummaryCommand, + GetRecommendationReportDetailsCommand, + GetServerDetailsCommand, + GetServerStrategiesCommand, + ListApplicationComponentsCommand, + ListCollectorsCommand, + ListImportFileTaskCommand, + ListServersCommand, + PutPortfolioPreferencesCommand, + StartAssessmentCommand, + StartImportFileTaskCommand, + StartRecommendationReportGenerationCommand, + StopAssessmentCommand, + UpdateApplicationComponentConfigCommand, + UpdateServerConfigCommand, +}; + +export interface MigrationHubStrategy { /** - * @public - *

Retrieves details about an application component.

+ * @see {@link GetApplicationComponentDetailsCommand} */ - public getApplicationComponentDetails( + getApplicationComponentDetails( args: GetApplicationComponentDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getApplicationComponentDetails( + getApplicationComponentDetails( args: GetApplicationComponentDetailsCommandInput, cb: (err: any, data?: GetApplicationComponentDetailsCommandOutput) => void ): void; - public getApplicationComponentDetails( + getApplicationComponentDetails( args: GetApplicationComponentDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApplicationComponentDetailsCommandOutput) => void ): void; - public getApplicationComponentDetails( - args: GetApplicationComponentDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApplicationComponentDetailsCommandOutput) => void), - cb?: (err: any, data?: GetApplicationComponentDetailsCommandOutput) => void - ): Promise | void { - const command = new GetApplicationComponentDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of all the recommended strategies and tools for an application component - * running on a server.

+ * @see {@link GetApplicationComponentStrategiesCommand} */ - public getApplicationComponentStrategies( + getApplicationComponentStrategies( args: GetApplicationComponentStrategiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getApplicationComponentStrategies( + getApplicationComponentStrategies( args: GetApplicationComponentStrategiesCommandInput, cb: (err: any, data?: GetApplicationComponentStrategiesCommandOutput) => void ): void; - public getApplicationComponentStrategies( + getApplicationComponentStrategies( args: GetApplicationComponentStrategiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApplicationComponentStrategiesCommandOutput) => void ): void; - public getApplicationComponentStrategies( - args: GetApplicationComponentStrategiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApplicationComponentStrategiesCommandOutput) => void), - cb?: (err: any, data?: GetApplicationComponentStrategiesCommandOutput) => void - ): Promise | void { - const command = new GetApplicationComponentStrategiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the status of an on-going assessment.

+ * @see {@link GetAssessmentCommand} */ - public getAssessment( - args: GetAssessmentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getAssessment( - args: GetAssessmentCommandInput, - cb: (err: any, data?: GetAssessmentCommandOutput) => void - ): void; - public getAssessment( + getAssessment(args: GetAssessmentCommandInput, options?: __HttpHandlerOptions): Promise; + getAssessment(args: GetAssessmentCommandInput, cb: (err: any, data?: GetAssessmentCommandOutput) => void): void; + getAssessment( args: GetAssessmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAssessmentCommandOutput) => void ): void; - public getAssessment( - args: GetAssessmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAssessmentCommandOutput) => void), - cb?: (err: any, data?: GetAssessmentCommandOutput) => void - ): Promise | void { - const command = new GetAssessmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the details about a specific import task.

+ * @see {@link GetImportFileTaskCommand} */ - public getImportFileTask( + getImportFileTask( args: GetImportFileTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public getImportFileTask( + getImportFileTask( args: GetImportFileTaskCommandInput, cb: (err: any, data?: GetImportFileTaskCommandOutput) => void ): void; - public getImportFileTask( + getImportFileTask( args: GetImportFileTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetImportFileTaskCommandOutput) => void ): void; - public getImportFileTask( - args: GetImportFileTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetImportFileTaskCommandOutput) => void), - cb?: (err: any, data?: GetImportFileTaskCommandOutput) => void - ): Promise | void { - const command = new GetImportFileTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieve the latest ID of a specific assessment task.

+ * @see {@link GetLatestAssessmentIdCommand} */ - public getLatestAssessmentId( + getLatestAssessmentId( args: GetLatestAssessmentIdCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLatestAssessmentId( + getLatestAssessmentId( args: GetLatestAssessmentIdCommandInput, cb: (err: any, data?: GetLatestAssessmentIdCommandOutput) => void ): void; - public getLatestAssessmentId( + getLatestAssessmentId( args: GetLatestAssessmentIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLatestAssessmentIdCommandOutput) => void ): void; - public getLatestAssessmentId( - args: GetLatestAssessmentIdCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLatestAssessmentIdCommandOutput) => void), - cb?: (err: any, data?: GetLatestAssessmentIdCommandOutput) => void - ): Promise | void { - const command = new GetLatestAssessmentIdCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves your migration and modernization preferences.

+ * @see {@link GetPortfolioPreferencesCommand} */ - public getPortfolioPreferences( + getPortfolioPreferences( args: GetPortfolioPreferencesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPortfolioPreferences( + getPortfolioPreferences( args: GetPortfolioPreferencesCommandInput, cb: (err: any, data?: GetPortfolioPreferencesCommandOutput) => void ): void; - public getPortfolioPreferences( + getPortfolioPreferences( args: GetPortfolioPreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPortfolioPreferencesCommandOutput) => void ): void; - public getPortfolioPreferences( - args: GetPortfolioPreferencesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPortfolioPreferencesCommandOutput) => void), - cb?: (err: any, data?: GetPortfolioPreferencesCommandOutput) => void - ): Promise | void { - const command = new GetPortfolioPreferencesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves overall summary including the number of servers to rehost and the overall - * number of anti-patterns.

+ * @see {@link GetPortfolioSummaryCommand} */ - public getPortfolioSummary( + getPortfolioSummary( args: GetPortfolioSummaryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPortfolioSummary( + getPortfolioSummary( args: GetPortfolioSummaryCommandInput, cb: (err: any, data?: GetPortfolioSummaryCommandOutput) => void ): void; - public getPortfolioSummary( + getPortfolioSummary( args: GetPortfolioSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPortfolioSummaryCommandOutput) => void ): void; - public getPortfolioSummary( - args: GetPortfolioSummaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPortfolioSummaryCommandOutput) => void), - cb?: (err: any, data?: GetPortfolioSummaryCommandOutput) => void - ): Promise | void { - const command = new GetPortfolioSummaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves detailed information about the specified recommendation report.

+ * @see {@link GetRecommendationReportDetailsCommand} */ - public getRecommendationReportDetails( + getRecommendationReportDetails( args: GetRecommendationReportDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRecommendationReportDetails( + getRecommendationReportDetails( args: GetRecommendationReportDetailsCommandInput, cb: (err: any, data?: GetRecommendationReportDetailsCommandOutput) => void ): void; - public getRecommendationReportDetails( + getRecommendationReportDetails( args: GetRecommendationReportDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRecommendationReportDetailsCommandOutput) => void ): void; - public getRecommendationReportDetails( - args: GetRecommendationReportDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRecommendationReportDetailsCommandOutput) => void), - cb?: (err: any, data?: GetRecommendationReportDetailsCommandOutput) => void - ): Promise | void { - const command = new GetRecommendationReportDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves detailed information about a specified server.

+ * @see {@link GetServerDetailsCommand} */ - public getServerDetails( + getServerDetails( args: GetServerDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServerDetails( + getServerDetails( args: GetServerDetailsCommandInput, cb: (err: any, data?: GetServerDetailsCommandOutput) => void ): void; - public getServerDetails( + getServerDetails( args: GetServerDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServerDetailsCommandOutput) => void ): void; - public getServerDetails( - args: GetServerDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServerDetailsCommandOutput) => void), - cb?: (err: any, data?: GetServerDetailsCommandOutput) => void - ): Promise | void { - const command = new GetServerDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves recommended strategies and tools for the specified server.

+ * @see {@link GetServerStrategiesCommand} */ - public getServerStrategies( + getServerStrategies( args: GetServerStrategiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServerStrategies( + getServerStrategies( args: GetServerStrategiesCommandInput, cb: (err: any, data?: GetServerStrategiesCommandOutput) => void ): void; - public getServerStrategies( + getServerStrategies( args: GetServerStrategiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServerStrategiesCommandOutput) => void ): void; - public getServerStrategies( - args: GetServerStrategiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServerStrategiesCommandOutput) => void), - cb?: (err: any, data?: GetServerStrategiesCommandOutput) => void - ): Promise | void { - const command = new GetServerStrategiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of all the application components (processes).

+ * @see {@link ListApplicationComponentsCommand} */ - public listApplicationComponents( + listApplicationComponents( args: ListApplicationComponentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplicationComponents( + listApplicationComponents( args: ListApplicationComponentsCommandInput, cb: (err: any, data?: ListApplicationComponentsCommandOutput) => void ): void; - public listApplicationComponents( + listApplicationComponents( args: ListApplicationComponentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationComponentsCommandOutput) => void ): void; - public listApplicationComponents( - args: ListApplicationComponentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationComponentsCommandOutput) => void), - cb?: (err: any, data?: ListApplicationComponentsCommandOutput) => void - ): Promise | void { - const command = new ListApplicationComponentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of all the installed collectors.

+ * @see {@link ListCollectorsCommand} */ - public listCollectors( + listCollectors( args: ListCollectorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCollectors( - args: ListCollectorsCommandInput, - cb: (err: any, data?: ListCollectorsCommandOutput) => void - ): void; - public listCollectors( + listCollectors(args: ListCollectorsCommandInput, cb: (err: any, data?: ListCollectorsCommandOutput) => void): void; + listCollectors( args: ListCollectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCollectorsCommandOutput) => void ): void; - public listCollectors( - args: ListCollectorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCollectorsCommandOutput) => void), - cb?: (err: any, data?: ListCollectorsCommandOutput) => void - ): Promise | void { - const command = new ListCollectorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of all the imports performed.

+ * @see {@link ListImportFileTaskCommand} */ - public listImportFileTask( + listImportFileTask( args: ListImportFileTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public listImportFileTask( + listImportFileTask( args: ListImportFileTaskCommandInput, cb: (err: any, data?: ListImportFileTaskCommandOutput) => void ): void; - public listImportFileTask( + listImportFileTask( args: ListImportFileTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImportFileTaskCommandOutput) => void ): void; - public listImportFileTask( - args: ListImportFileTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListImportFileTaskCommandOutput) => void), - cb?: (err: any, data?: ListImportFileTaskCommandOutput) => void - ): Promise | void { - const command = new ListImportFileTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all the servers.

+ * @see {@link ListServersCommand} */ - public listServers(args: ListServersCommandInput, options?: __HttpHandlerOptions): Promise; - public listServers(args: ListServersCommandInput, cb: (err: any, data?: ListServersCommandOutput) => void): void; - public listServers( + listServers(args: ListServersCommandInput, options?: __HttpHandlerOptions): Promise; + listServers(args: ListServersCommandInput, cb: (err: any, data?: ListServersCommandOutput) => void): void; + listServers( args: ListServersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServersCommandOutput) => void ): void; - public listServers( - args: ListServersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServersCommandOutput) => void), - cb?: (err: any, data?: ListServersCommandOutput) => void - ): Promise | void { - const command = new ListServersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Saves the specified migration and modernization preferences.

+ * @see {@link PutPortfolioPreferencesCommand} */ - public putPortfolioPreferences( + putPortfolioPreferences( args: PutPortfolioPreferencesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putPortfolioPreferences( + putPortfolioPreferences( args: PutPortfolioPreferencesCommandInput, cb: (err: any, data?: PutPortfolioPreferencesCommandOutput) => void ): void; - public putPortfolioPreferences( + putPortfolioPreferences( args: PutPortfolioPreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPortfolioPreferencesCommandOutput) => void ): void; - public putPortfolioPreferences( - args: PutPortfolioPreferencesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutPortfolioPreferencesCommandOutput) => void), - cb?: (err: any, data?: PutPortfolioPreferencesCommandOutput) => void - ): Promise | void { - const command = new PutPortfolioPreferencesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts the assessment of an on-premises environment.

+ * @see {@link StartAssessmentCommand} */ - public startAssessment( + startAssessment( args: StartAssessmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public startAssessment( - args: StartAssessmentCommandInput, - cb: (err: any, data?: StartAssessmentCommandOutput) => void - ): void; - public startAssessment( + startAssessment(args: StartAssessmentCommandInput, cb: (err: any, data?: StartAssessmentCommandOutput) => void): void; + startAssessment( args: StartAssessmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartAssessmentCommandOutput) => void ): void; - public startAssessment( - args: StartAssessmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartAssessmentCommandOutput) => void), - cb?: (err: any, data?: StartAssessmentCommandOutput) => void - ): Promise | void { - const command = new StartAssessmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a file import.

+ * @see {@link StartImportFileTaskCommand} */ - public startImportFileTask( + startImportFileTask( args: StartImportFileTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public startImportFileTask( + startImportFileTask( args: StartImportFileTaskCommandInput, cb: (err: any, data?: StartImportFileTaskCommandOutput) => void ): void; - public startImportFileTask( + startImportFileTask( args: StartImportFileTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartImportFileTaskCommandOutput) => void ): void; - public startImportFileTask( - args: StartImportFileTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartImportFileTaskCommandOutput) => void), - cb?: (err: any, data?: StartImportFileTaskCommandOutput) => void - ): Promise | void { - const command = new StartImportFileTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts generating a recommendation report.

+ * @see {@link StartRecommendationReportGenerationCommand} */ - public startRecommendationReportGeneration( + startRecommendationReportGeneration( args: StartRecommendationReportGenerationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startRecommendationReportGeneration( + startRecommendationReportGeneration( args: StartRecommendationReportGenerationCommandInput, cb: (err: any, data?: StartRecommendationReportGenerationCommandOutput) => void ): void; - public startRecommendationReportGeneration( + startRecommendationReportGeneration( args: StartRecommendationReportGenerationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartRecommendationReportGenerationCommandOutput) => void ): void; - public startRecommendationReportGeneration( - args: StartRecommendationReportGenerationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartRecommendationReportGenerationCommandOutput) => void), - cb?: (err: any, data?: StartRecommendationReportGenerationCommandOutput) => void - ): Promise | void { - const command = new StartRecommendationReportGenerationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops the assessment of an on-premises environment.

+ * @see {@link StopAssessmentCommand} */ - public stopAssessment( + stopAssessment( args: StopAssessmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopAssessment( - args: StopAssessmentCommandInput, - cb: (err: any, data?: StopAssessmentCommandOutput) => void - ): void; - public stopAssessment( + stopAssessment(args: StopAssessmentCommandInput, cb: (err: any, data?: StopAssessmentCommandOutput) => void): void; + stopAssessment( args: StopAssessmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopAssessmentCommandOutput) => void ): void; - public stopAssessment( - args: StopAssessmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopAssessmentCommandOutput) => void), - cb?: (err: any, data?: StopAssessmentCommandOutput) => void - ): Promise | void { - const command = new StopAssessmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the configuration of an application component.

+ * @see {@link UpdateApplicationComponentConfigCommand} */ - public updateApplicationComponentConfig( + updateApplicationComponentConfig( args: UpdateApplicationComponentConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApplicationComponentConfig( + updateApplicationComponentConfig( args: UpdateApplicationComponentConfigCommandInput, cb: (err: any, data?: UpdateApplicationComponentConfigCommandOutput) => void ): void; - public updateApplicationComponentConfig( + updateApplicationComponentConfig( args: UpdateApplicationComponentConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationComponentConfigCommandOutput) => void ): void; - public updateApplicationComponentConfig( - args: UpdateApplicationComponentConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApplicationComponentConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateApplicationComponentConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateApplicationComponentConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the configuration of the specified server.

+ * @see {@link UpdateServerConfigCommand} */ - public updateServerConfig( + updateServerConfig( args: UpdateServerConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateServerConfig( + updateServerConfig( args: UpdateServerConfigCommandInput, cb: (err: any, data?: UpdateServerConfigCommandOutput) => void ): void; - public updateServerConfig( + updateServerConfig( args: UpdateServerConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServerConfigCommandOutput) => void ): void; - public updateServerConfig( - args: UpdateServerConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServerConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateServerConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateServerConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Migration Hub Strategy Recommendations + *

This API reference provides descriptions, syntax, and other details about each of the + * actions and data types for Migration Hub Strategy Recommendations (Strategy Recommendations). The topic for each action shows the API + * request parameters and the response. Alternatively, you can use one of the AWS SDKs to + * access an API that is tailored to the programming language or platform that you're using. For + * more information, see AWS SDKs.

+ */ +export class MigrationHubStrategy extends MigrationHubStrategyClient implements MigrationHubStrategy {} +createAggregatedClient(commands, MigrationHubStrategy); diff --git a/clients/client-mobile/src/Mobile.ts b/clients/client-mobile/src/Mobile.ts index 0ca87d3e7864..d273a68dfc81 100644 --- a/clients/client-mobile/src/Mobile.ts +++ b/clients/client-mobile/src/Mobile.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -42,320 +43,134 @@ import { UpdateProjectCommandInput, UpdateProjectCommandOutput, } from "./commands/UpdateProjectCommand"; -import { MobileClient } from "./MobileClient"; +import { MobileClient, MobileClientConfig } from "./MobileClient"; -/** - * @public - *

- * AWS Mobile Service provides mobile app and website developers with capabilities - * required to configure AWS resources and bootstrap their developer desktop projects - * with the necessary SDKs, constants, tools and samples to make use of those resources. - *

- */ -export class Mobile extends MobileClient { +const commands = { + CreateProjectCommand, + DeleteProjectCommand, + DescribeBundleCommand, + DescribeProjectCommand, + ExportBundleCommand, + ExportProjectCommand, + ListBundlesCommand, + ListProjectsCommand, + UpdateProjectCommand, +}; + +export interface Mobile { /** - * @public - *

- * Creates an AWS Mobile Hub project. - *

+ * @see {@link CreateProjectCommand} */ - public createProject( - args: CreateProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createProject( - args: CreateProjectCommandInput, - cb: (err: any, data?: CreateProjectCommandOutput) => void - ): void; - public createProject( + createProject(args: CreateProjectCommandInput, options?: __HttpHandlerOptions): Promise; + createProject(args: CreateProjectCommandInput, cb: (err: any, data?: CreateProjectCommandOutput) => void): void; + createProject( args: CreateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectCommandOutput) => void ): void; - public createProject( - args: CreateProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProjectCommandOutput) => void), - cb?: (err: any, data?: CreateProjectCommandOutput) => void - ): Promise | void { - const command = new CreateProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Delets a project in AWS Mobile Hub. - *

+ * @see {@link DeleteProjectCommand} */ - public deleteProject( - args: DeleteProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteProject( - args: DeleteProjectCommandInput, - cb: (err: any, data?: DeleteProjectCommandOutput) => void - ): void; - public deleteProject( + deleteProject(args: DeleteProjectCommandInput, options?: __HttpHandlerOptions): Promise; + deleteProject(args: DeleteProjectCommandInput, cb: (err: any, data?: DeleteProjectCommandOutput) => void): void; + deleteProject( args: DeleteProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProjectCommandOutput) => void ): void; - public deleteProject( - args: DeleteProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProjectCommandOutput) => void), - cb?: (err: any, data?: DeleteProjectCommandOutput) => void - ): Promise | void { - const command = new DeleteProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Get the bundle details for the requested bundle id. - *

+ * @see {@link DescribeBundleCommand} */ - public describeBundle( + describeBundle( args: DescribeBundleCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBundle( - args: DescribeBundleCommandInput, - cb: (err: any, data?: DescribeBundleCommandOutput) => void - ): void; - public describeBundle( + describeBundle(args: DescribeBundleCommandInput, cb: (err: any, data?: DescribeBundleCommandOutput) => void): void; + describeBundle( args: DescribeBundleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBundleCommandOutput) => void ): void; - public describeBundle( - args: DescribeBundleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBundleCommandOutput) => void), - cb?: (err: any, data?: DescribeBundleCommandOutput) => void - ): Promise | void { - const command = new DescribeBundleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Gets details about a project in AWS Mobile Hub. - *

+ * @see {@link DescribeProjectCommand} */ - public describeProject( + describeProject( args: DescribeProjectCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProject( - args: DescribeProjectCommandInput, - cb: (err: any, data?: DescribeProjectCommandOutput) => void - ): void; - public describeProject( + describeProject(args: DescribeProjectCommandInput, cb: (err: any, data?: DescribeProjectCommandOutput) => void): void; + describeProject( args: DescribeProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProjectCommandOutput) => void ): void; - public describeProject( - args: DescribeProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProjectCommandOutput) => void), - cb?: (err: any, data?: DescribeProjectCommandOutput) => void - ): Promise | void { - const command = new DescribeProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Generates customized software development kit (SDK) and or tool packages - * used to integrate mobile web or mobile app clients with backend AWS resources. - *

+ * @see {@link ExportBundleCommand} */ - public exportBundle( - args: ExportBundleCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public exportBundle(args: ExportBundleCommandInput, cb: (err: any, data?: ExportBundleCommandOutput) => void): void; - public exportBundle( + exportBundle(args: ExportBundleCommandInput, options?: __HttpHandlerOptions): Promise; + exportBundle(args: ExportBundleCommandInput, cb: (err: any, data?: ExportBundleCommandOutput) => void): void; + exportBundle( args: ExportBundleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportBundleCommandOutput) => void ): void; - public exportBundle( - args: ExportBundleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportBundleCommandOutput) => void), - cb?: (err: any, data?: ExportBundleCommandOutput) => void - ): Promise | void { - const command = new ExportBundleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Exports project configuration to a snapshot which can be downloaded and shared. - * Note that mobile app push credentials are encrypted in exported projects, so they - * can only be shared successfully within the same AWS account. - *

+ * @see {@link ExportProjectCommand} */ - public exportProject( - args: ExportProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public exportProject( - args: ExportProjectCommandInput, - cb: (err: any, data?: ExportProjectCommandOutput) => void - ): void; - public exportProject( + exportProject(args: ExportProjectCommandInput, options?: __HttpHandlerOptions): Promise; + exportProject(args: ExportProjectCommandInput, cb: (err: any, data?: ExportProjectCommandOutput) => void): void; + exportProject( args: ExportProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportProjectCommandOutput) => void ): void; - public exportProject( - args: ExportProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportProjectCommandOutput) => void), - cb?: (err: any, data?: ExportProjectCommandOutput) => void - ): Promise | void { - const command = new ExportProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * List all available bundles. - *

+ * @see {@link ListBundlesCommand} */ - public listBundles(args: ListBundlesCommandInput, options?: __HttpHandlerOptions): Promise; - public listBundles(args: ListBundlesCommandInput, cb: (err: any, data?: ListBundlesCommandOutput) => void): void; - public listBundles( + listBundles(args: ListBundlesCommandInput, options?: __HttpHandlerOptions): Promise; + listBundles(args: ListBundlesCommandInput, cb: (err: any, data?: ListBundlesCommandOutput) => void): void; + listBundles( args: ListBundlesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBundlesCommandOutput) => void ): void; - public listBundles( - args: ListBundlesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBundlesCommandOutput) => void), - cb?: (err: any, data?: ListBundlesCommandOutput) => void - ): Promise | void { - const command = new ListBundlesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Lists projects in AWS Mobile Hub. - *

+ * @see {@link ListProjectsCommand} */ - public listProjects( - args: ListProjectsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void; - public listProjects( + listProjects(args: ListProjectsCommandInput, options?: __HttpHandlerOptions): Promise; + listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void; + listProjects( args: ListProjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProjectsCommandOutput) => void ): void; - public listProjects( - args: ListProjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProjectsCommandOutput) => void), - cb?: (err: any, data?: ListProjectsCommandOutput) => void - ): Promise | void { - const command = new ListProjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Update an existing project. - *

+ * @see {@link UpdateProjectCommand} */ - public updateProject( - args: UpdateProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateProject( - args: UpdateProjectCommandInput, - cb: (err: any, data?: UpdateProjectCommandOutput) => void - ): void; - public updateProject( + updateProject(args: UpdateProjectCommandInput, options?: __HttpHandlerOptions): Promise; + updateProject(args: UpdateProjectCommandInput, cb: (err: any, data?: UpdateProjectCommandOutput) => void): void; + updateProject( args: UpdateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProjectCommandOutput) => void ): void; - public updateProject( - args: UpdateProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProjectCommandOutput) => void), - cb?: (err: any, data?: UpdateProjectCommandOutput) => void - ): Promise | void { - const command = new UpdateProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

+ * AWS Mobile Service provides mobile app and website developers with capabilities + * required to configure AWS resources and bootstrap their developer desktop projects + * with the necessary SDKs, constants, tools and samples to make use of those resources. + *

+ */ +export class Mobile extends MobileClient implements Mobile {} +createAggregatedClient(commands, Mobile); diff --git a/clients/client-mq/src/Mq.ts b/clients/client-mq/src/Mq.ts index 2c1eb46d5d72..c20d1bc58a98 100644 --- a/clients/client-mq/src/Mq.ts +++ b/clients/client-mq/src/Mq.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -79,673 +80,331 @@ import { UpdateConfigurationCommandOutput, } from "./commands/UpdateConfigurationCommand"; import { UpdateUserCommand, UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand"; -import { MqClient } from "./MqClient"; +import { MqClient, MqClientConfig } from "./MqClient"; -/** - * @public - *

Amazon MQ is a managed message broker service for Apache ActiveMQ and RabbitMQ that makes it easy to set up and operate message brokers in the cloud. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.

- */ -export class Mq extends MqClient { +const commands = { + CreateBrokerCommand, + CreateConfigurationCommand, + CreateTagsCommand, + CreateUserCommand, + DeleteBrokerCommand, + DeleteTagsCommand, + DeleteUserCommand, + DescribeBrokerCommand, + DescribeBrokerEngineTypesCommand, + DescribeBrokerInstanceOptionsCommand, + DescribeConfigurationCommand, + DescribeConfigurationRevisionCommand, + DescribeUserCommand, + ListBrokersCommand, + ListConfigurationRevisionsCommand, + ListConfigurationsCommand, + ListTagsCommand, + ListUsersCommand, + RebootBrokerCommand, + UpdateBrokerCommand, + UpdateConfigurationCommand, + UpdateUserCommand, +}; + +export interface Mq { /** - * @public - *

Creates a broker. Note: This API is asynchronous.

To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the following EC2 permissions in your IAM policy.

  • ec2:CreateNetworkInterface

    This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf of your account.

  • ec2:CreateNetworkInterfacePermission

    This permission is required to attach the ENI to the broker instance.

  • ec2:DeleteNetworkInterface

  • ec2:DeleteNetworkInterfacePermission

  • ec2:DetachNetworkInterface

  • ec2:DescribeInternetGateways

  • ec2:DescribeNetworkInterfaces

  • ec2:DescribeNetworkInterfacePermissions

  • ec2:DescribeRouteTables

  • ec2:DescribeSecurityGroups

  • ec2:DescribeSubnets

  • ec2:DescribeVpcs

For more information, see Create an IAM User and Get Your AWS Credentials and Never Modify or Delete the Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide.

+ * @see {@link CreateBrokerCommand} */ - public createBroker( - args: CreateBrokerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createBroker(args: CreateBrokerCommandInput, cb: (err: any, data?: CreateBrokerCommandOutput) => void): void; - public createBroker( + createBroker(args: CreateBrokerCommandInput, options?: __HttpHandlerOptions): Promise; + createBroker(args: CreateBrokerCommandInput, cb: (err: any, data?: CreateBrokerCommandOutput) => void): void; + createBroker( args: CreateBrokerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBrokerCommandOutput) => void ): void; - public createBroker( - args: CreateBrokerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBrokerCommandOutput) => void), - cb?: (err: any, data?: CreateBrokerCommandOutput) => void - ): Promise | void { - const command = new CreateBrokerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).

+ * @see {@link CreateConfigurationCommand} */ - public createConfiguration( + createConfiguration( args: CreateConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConfiguration( + createConfiguration( args: CreateConfigurationCommandInput, cb: (err: any, data?: CreateConfigurationCommandOutput) => void ): void; - public createConfiguration( + createConfiguration( args: CreateConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfigurationCommandOutput) => void ): void; - public createConfiguration( - args: CreateConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Add a tag to a resource.

+ * @see {@link CreateTagsCommand} */ - public createTags(args: CreateTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public createTags(args: CreateTagsCommandInput, cb: (err: any, data?: CreateTagsCommandOutput) => void): void; - public createTags( + createTags(args: CreateTagsCommandInput, options?: __HttpHandlerOptions): Promise; + createTags(args: CreateTagsCommandInput, cb: (err: any, data?: CreateTagsCommandOutput) => void): void; + createTags( args: CreateTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTagsCommandOutput) => void ): void; - public createTags( - args: CreateTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTagsCommandOutput) => void), - cb?: (err: any, data?: CreateTagsCommandOutput) => void - ): Promise | void { - const command = new CreateTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an ActiveMQ user.

+ * @see {@link CreateUserCommand} */ - public createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; - public createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; - public createUser( + createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; + createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; + createUser( args: CreateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserCommandOutput) => void ): void; - public createUser( - args: CreateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserCommandOutput) => void), - cb?: (err: any, data?: CreateUserCommandOutput) => void - ): Promise | void { - const command = new CreateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a broker. Note: This API is asynchronous.

+ * @see {@link DeleteBrokerCommand} */ - public deleteBroker( - args: DeleteBrokerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteBroker(args: DeleteBrokerCommandInput, cb: (err: any, data?: DeleteBrokerCommandOutput) => void): void; - public deleteBroker( + deleteBroker(args: DeleteBrokerCommandInput, options?: __HttpHandlerOptions): Promise; + deleteBroker(args: DeleteBrokerCommandInput, cb: (err: any, data?: DeleteBrokerCommandOutput) => void): void; + deleteBroker( args: DeleteBrokerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBrokerCommandOutput) => void ): void; - public deleteBroker( - args: DeleteBrokerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBrokerCommandOutput) => void), - cb?: (err: any, data?: DeleteBrokerCommandOutput) => void - ): Promise | void { - const command = new DeleteBrokerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a tag from a resource.

+ * @see {@link DeleteTagsCommand} */ - public deleteTags(args: DeleteTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteTags(args: DeleteTagsCommandInput, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void; - public deleteTags( + deleteTags(args: DeleteTagsCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTags(args: DeleteTagsCommandInput, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void; + deleteTags( args: DeleteTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTagsCommandOutput) => void ): void; - public deleteTags( - args: DeleteTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTagsCommandOutput) => void), - cb?: (err: any, data?: DeleteTagsCommandOutput) => void - ): Promise | void { - const command = new DeleteTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an ActiveMQ user.

+ * @see {@link DeleteUserCommand} */ - public deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; - public deleteUser( + deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; + deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; + deleteUser( args: DeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserCommandOutput) => void ): void; - public deleteUser( - args: DeleteUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserCommandOutput) => void), - cb?: (err: any, data?: DeleteUserCommandOutput) => void - ): Promise | void { - const command = new DeleteUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the specified broker.

+ * @see {@link DescribeBrokerCommand} */ - public describeBroker( + describeBroker( args: DescribeBrokerCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBroker( - args: DescribeBrokerCommandInput, - cb: (err: any, data?: DescribeBrokerCommandOutput) => void - ): void; - public describeBroker( + describeBroker(args: DescribeBrokerCommandInput, cb: (err: any, data?: DescribeBrokerCommandOutput) => void): void; + describeBroker( args: DescribeBrokerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBrokerCommandOutput) => void ): void; - public describeBroker( - args: DescribeBrokerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBrokerCommandOutput) => void), - cb?: (err: any, data?: DescribeBrokerCommandOutput) => void - ): Promise | void { - const command = new DescribeBrokerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describe available engine types and versions.

+ * @see {@link DescribeBrokerEngineTypesCommand} */ - public describeBrokerEngineTypes( + describeBrokerEngineTypes( args: DescribeBrokerEngineTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBrokerEngineTypes( + describeBrokerEngineTypes( args: DescribeBrokerEngineTypesCommandInput, cb: (err: any, data?: DescribeBrokerEngineTypesCommandOutput) => void ): void; - public describeBrokerEngineTypes( + describeBrokerEngineTypes( args: DescribeBrokerEngineTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBrokerEngineTypesCommandOutput) => void ): void; - public describeBrokerEngineTypes( - args: DescribeBrokerEngineTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBrokerEngineTypesCommandOutput) => void), - cb?: (err: any, data?: DescribeBrokerEngineTypesCommandOutput) => void - ): Promise | void { - const command = new DescribeBrokerEngineTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describe available broker instance options.

+ * @see {@link DescribeBrokerInstanceOptionsCommand} */ - public describeBrokerInstanceOptions( + describeBrokerInstanceOptions( args: DescribeBrokerInstanceOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBrokerInstanceOptions( + describeBrokerInstanceOptions( args: DescribeBrokerInstanceOptionsCommandInput, cb: (err: any, data?: DescribeBrokerInstanceOptionsCommandOutput) => void ): void; - public describeBrokerInstanceOptions( + describeBrokerInstanceOptions( args: DescribeBrokerInstanceOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBrokerInstanceOptionsCommandOutput) => void ): void; - public describeBrokerInstanceOptions( - args: DescribeBrokerInstanceOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBrokerInstanceOptionsCommandOutput) => void), - cb?: (err: any, data?: DescribeBrokerInstanceOptionsCommandOutput) => void - ): Promise | void { - const command = new DescribeBrokerInstanceOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the specified configuration.

+ * @see {@link DescribeConfigurationCommand} */ - public describeConfiguration( + describeConfiguration( args: DescribeConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConfiguration( + describeConfiguration( args: DescribeConfigurationCommandInput, cb: (err: any, data?: DescribeConfigurationCommandOutput) => void ): void; - public describeConfiguration( + describeConfiguration( args: DescribeConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigurationCommandOutput) => void ): void; - public describeConfiguration( - args: DescribeConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the specified configuration revision for the specified configuration.

+ * @see {@link DescribeConfigurationRevisionCommand} */ - public describeConfigurationRevision( + describeConfigurationRevision( args: DescribeConfigurationRevisionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConfigurationRevision( + describeConfigurationRevision( args: DescribeConfigurationRevisionCommandInput, cb: (err: any, data?: DescribeConfigurationRevisionCommandOutput) => void ): void; - public describeConfigurationRevision( + describeConfigurationRevision( args: DescribeConfigurationRevisionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigurationRevisionCommandOutput) => void ): void; - public describeConfigurationRevision( - args: DescribeConfigurationRevisionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConfigurationRevisionCommandOutput) => void), - cb?: (err: any, data?: DescribeConfigurationRevisionCommandOutput) => void - ): Promise | void { - const command = new DescribeConfigurationRevisionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about an ActiveMQ user.

+ * @see {@link DescribeUserCommand} */ - public describeUser( - args: DescribeUserCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeUser(args: DescribeUserCommandInput, cb: (err: any, data?: DescribeUserCommandOutput) => void): void; - public describeUser( + describeUser(args: DescribeUserCommandInput, options?: __HttpHandlerOptions): Promise; + describeUser(args: DescribeUserCommandInput, cb: (err: any, data?: DescribeUserCommandOutput) => void): void; + describeUser( args: DescribeUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserCommandOutput) => void ): void; - public describeUser( - args: DescribeUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUserCommandOutput) => void), - cb?: (err: any, data?: DescribeUserCommandOutput) => void - ): Promise | void { - const command = new DescribeUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all brokers.

+ * @see {@link ListBrokersCommand} */ - public listBrokers(args: ListBrokersCommandInput, options?: __HttpHandlerOptions): Promise; - public listBrokers(args: ListBrokersCommandInput, cb: (err: any, data?: ListBrokersCommandOutput) => void): void; - public listBrokers( + listBrokers(args: ListBrokersCommandInput, options?: __HttpHandlerOptions): Promise; + listBrokers(args: ListBrokersCommandInput, cb: (err: any, data?: ListBrokersCommandOutput) => void): void; + listBrokers( args: ListBrokersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBrokersCommandOutput) => void ): void; - public listBrokers( - args: ListBrokersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBrokersCommandOutput) => void), - cb?: (err: any, data?: ListBrokersCommandOutput) => void - ): Promise | void { - const command = new ListBrokersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all revisions for the specified configuration.

+ * @see {@link ListConfigurationRevisionsCommand} */ - public listConfigurationRevisions( + listConfigurationRevisions( args: ListConfigurationRevisionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConfigurationRevisions( + listConfigurationRevisions( args: ListConfigurationRevisionsCommandInput, cb: (err: any, data?: ListConfigurationRevisionsCommandOutput) => void ): void; - public listConfigurationRevisions( + listConfigurationRevisions( args: ListConfigurationRevisionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConfigurationRevisionsCommandOutput) => void ): void; - public listConfigurationRevisions( - args: ListConfigurationRevisionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConfigurationRevisionsCommandOutput) => void), - cb?: (err: any, data?: ListConfigurationRevisionsCommandOutput) => void - ): Promise | void { - const command = new ListConfigurationRevisionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all configurations.

+ * @see {@link ListConfigurationsCommand} */ - public listConfigurations( + listConfigurations( args: ListConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConfigurations( + listConfigurations( args: ListConfigurationsCommandInput, cb: (err: any, data?: ListConfigurationsCommandOutput) => void ): void; - public listConfigurations( + listConfigurations( args: ListConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConfigurationsCommandOutput) => void ): void; - public listConfigurations( - args: ListConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists tags for a resource.

+ * @see {@link ListTagsCommand} */ - public listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; - public listTags( + listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; + listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; + listTags( args: ListTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsCommandOutput) => void ): void; - public listTags( - args: ListTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsCommandOutput) => void), - cb?: (err: any, data?: ListTagsCommandOutput) => void - ): Promise | void { - const command = new ListTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all ActiveMQ users.

+ * @see {@link ListUsersCommand} */ - public listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise; - public listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void; - public listUsers( + listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise; + listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void; + listUsers( args: ListUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersCommandOutput) => void ): void; - public listUsers( - args: ListUsersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUsersCommandOutput) => void), - cb?: (err: any, data?: ListUsersCommandOutput) => void - ): Promise | void { - const command = new ListUsersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Reboots a broker. Note: This API is asynchronous.

+ * @see {@link RebootBrokerCommand} */ - public rebootBroker( - args: RebootBrokerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public rebootBroker(args: RebootBrokerCommandInput, cb: (err: any, data?: RebootBrokerCommandOutput) => void): void; - public rebootBroker( + rebootBroker(args: RebootBrokerCommandInput, options?: __HttpHandlerOptions): Promise; + rebootBroker(args: RebootBrokerCommandInput, cb: (err: any, data?: RebootBrokerCommandOutput) => void): void; + rebootBroker( args: RebootBrokerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebootBrokerCommandOutput) => void ): void; - public rebootBroker( - args: RebootBrokerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RebootBrokerCommandOutput) => void), - cb?: (err: any, data?: RebootBrokerCommandOutput) => void - ): Promise | void { - const command = new RebootBrokerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a pending configuration change to a broker.

+ * @see {@link UpdateBrokerCommand} */ - public updateBroker( - args: UpdateBrokerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateBroker(args: UpdateBrokerCommandInput, cb: (err: any, data?: UpdateBrokerCommandOutput) => void): void; - public updateBroker( + updateBroker(args: UpdateBrokerCommandInput, options?: __HttpHandlerOptions): Promise; + updateBroker(args: UpdateBrokerCommandInput, cb: (err: any, data?: UpdateBrokerCommandOutput) => void): void; + updateBroker( args: UpdateBrokerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBrokerCommandOutput) => void ): void; - public updateBroker( - args: UpdateBrokerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBrokerCommandOutput) => void), - cb?: (err: any, data?: UpdateBrokerCommandOutput) => void - ): Promise | void { - const command = new UpdateBrokerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified configuration.

+ * @see {@link UpdateConfigurationCommand} */ - public updateConfiguration( + updateConfiguration( args: UpdateConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConfiguration( + updateConfiguration( args: UpdateConfigurationCommandInput, cb: (err: any, data?: UpdateConfigurationCommandOutput) => void ): void; - public updateConfiguration( + updateConfiguration( args: UpdateConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConfigurationCommandOutput) => void ): void; - public updateConfiguration( - args: UpdateConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the information for an ActiveMQ user.

+ * @see {@link UpdateUserCommand} */ - public updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise; - public updateUser(args: UpdateUserCommandInput, cb: (err: any, data?: UpdateUserCommandOutput) => void): void; - public updateUser( + updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise; + updateUser(args: UpdateUserCommandInput, cb: (err: any, data?: UpdateUserCommandOutput) => void): void; + updateUser( args: UpdateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserCommandOutput) => void ): void; - public updateUser( - args: UpdateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserCommandOutput) => void), - cb?: (err: any, data?: UpdateUserCommandOutput) => void - ): Promise | void { - const command = new UpdateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon MQ is a managed message broker service for Apache ActiveMQ and RabbitMQ that makes it easy to set up and operate message brokers in the cloud. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.

+ */ +export class Mq extends MqClient implements Mq {} +createAggregatedClient(commands, Mq); diff --git a/clients/client-mturk/src/MTurk.ts b/clients/client-mturk/src/MTurk.ts index 229e90644c7c..88b2d29bdb4f 100644 --- a/clients/client-mturk/src/MTurk.ts +++ b/clients/client-mturk/src/MTurk.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -176,1658 +177,670 @@ import { UpdateQualificationTypeCommandInput, UpdateQualificationTypeCommandOutput, } from "./commands/UpdateQualificationTypeCommand"; -import { MTurkClient } from "./MTurkClient"; +import { MTurkClient, MTurkClientConfig } from "./MTurkClient"; -/** - * @public - * Amazon Mechanical Turk API Reference - */ -export class MTurk extends MTurkClient { +const commands = { + AcceptQualificationRequestCommand, + ApproveAssignmentCommand, + AssociateQualificationWithWorkerCommand, + CreateAdditionalAssignmentsForHITCommand, + CreateHITCommand, + CreateHITTypeCommand, + CreateHITWithHITTypeCommand, + CreateQualificationTypeCommand, + CreateWorkerBlockCommand, + DeleteHITCommand, + DeleteQualificationTypeCommand, + DeleteWorkerBlockCommand, + DisassociateQualificationFromWorkerCommand, + GetAccountBalanceCommand, + GetAssignmentCommand, + GetFileUploadURLCommand, + GetHITCommand, + GetQualificationScoreCommand, + GetQualificationTypeCommand, + ListAssignmentsForHITCommand, + ListBonusPaymentsCommand, + ListHITsCommand, + ListHITsForQualificationTypeCommand, + ListQualificationRequestsCommand, + ListQualificationTypesCommand, + ListReviewableHITsCommand, + ListReviewPolicyResultsForHITCommand, + ListWorkerBlocksCommand, + ListWorkersWithQualificationTypeCommand, + NotifyWorkersCommand, + RejectAssignmentCommand, + RejectQualificationRequestCommand, + SendBonusCommand, + SendTestEventNotificationCommand, + UpdateExpirationForHITCommand, + UpdateHITReviewStatusCommand, + UpdateHITTypeOfHITCommand, + UpdateNotificationSettingsCommand, + UpdateQualificationTypeCommand, +}; + +export interface MTurk { /** - * @public - *

- * The AcceptQualificationRequest operation approves a Worker's request for a Qualification. - *

- *

- * Only the owner of the Qualification type can grant a Qualification request for that type. - *

- *

- * A successful request for the AcceptQualificationRequest operation - * returns with no errors and an empty body. - *

+ * @see {@link AcceptQualificationRequestCommand} */ - public acceptQualificationRequest( + acceptQualificationRequest( args: AcceptQualificationRequestCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptQualificationRequest( + acceptQualificationRequest( args: AcceptQualificationRequestCommandInput, cb: (err: any, data?: AcceptQualificationRequestCommandOutput) => void ): void; - public acceptQualificationRequest( + acceptQualificationRequest( args: AcceptQualificationRequestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptQualificationRequestCommandOutput) => void ): void; - public acceptQualificationRequest( - args: AcceptQualificationRequestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptQualificationRequestCommandOutput) => void), - cb?: (err: any, data?: AcceptQualificationRequestCommandOutput) => void - ): Promise | void { - const command = new AcceptQualificationRequestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The ApproveAssignment operation approves the results of a completed assignment. - *

- *

- * Approving an assignment initiates two payments from the Requester's Amazon.com account - *

- *
    - *
  • - *

    - * The Worker who submitted the results is paid the reward specified in the HIT. - *

    - *
  • - *
  • - *

    - * Amazon Mechanical Turk fees are debited. - *

    - *
  • - *
- *

- * If the Requester's account does not have adequate funds for these payments, - * the call to ApproveAssignment returns an exception, and the approval is not processed. - * You can include an optional feedback message with the approval, - * which the Worker can see in the Status section of the web site. - *

- *

- * You can also call this operation for assignments that were previous rejected - * and approve them by explicitly overriding the previous rejection. - * This only works on rejected assignments that were submitted within the previous 30 days - * and only if the assignment's related HIT has not been deleted. - *

+ * @see {@link ApproveAssignmentCommand} */ - public approveAssignment( + approveAssignment( args: ApproveAssignmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public approveAssignment( + approveAssignment( args: ApproveAssignmentCommandInput, cb: (err: any, data?: ApproveAssignmentCommandOutput) => void ): void; - public approveAssignment( + approveAssignment( args: ApproveAssignmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ApproveAssignmentCommandOutput) => void ): void; - public approveAssignment( - args: ApproveAssignmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ApproveAssignmentCommandOutput) => void), - cb?: (err: any, data?: ApproveAssignmentCommandOutput) => void - ): Promise | void { - const command = new ApproveAssignmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The AssociateQualificationWithWorker operation gives a Worker a - * Qualification. AssociateQualificationWithWorker does not require that the Worker - * submit a Qualification request. It gives the Qualification directly to the Worker. - *

- * - *

- * You can only assign a Qualification of a Qualification type that you created (using - * the CreateQualificationType operation). - *

- * - * - *

- * Note: AssociateQualificationWithWorker does not affect any pending Qualification - * requests for the Qualification by the Worker. If you assign a Qualification to a - * Worker, then later grant a Qualification request made by the Worker, the granting of - * the request may modify the Qualification score. To resolve a pending Qualification - * request without affecting the Qualification the Worker already has, reject the - * request with the RejectQualificationRequest operation. - *

- *
+ * @see {@link AssociateQualificationWithWorkerCommand} */ - public associateQualificationWithWorker( + associateQualificationWithWorker( args: AssociateQualificationWithWorkerCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateQualificationWithWorker( + associateQualificationWithWorker( args: AssociateQualificationWithWorkerCommandInput, cb: (err: any, data?: AssociateQualificationWithWorkerCommandOutput) => void ): void; - public associateQualificationWithWorker( + associateQualificationWithWorker( args: AssociateQualificationWithWorkerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateQualificationWithWorkerCommandOutput) => void ): void; - public associateQualificationWithWorker( - args: AssociateQualificationWithWorkerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateQualificationWithWorkerCommandOutput) => void), - cb?: (err: any, data?: AssociateQualificationWithWorkerCommandOutput) => void - ): Promise | void { - const command = new AssociateQualificationWithWorkerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The - * CreateAdditionalAssignmentsForHIT - * operation increases the maximum number of assignments of an existing HIT. - *

- *

- * To extend the maximum number of assignments, specify the number of additional assignments.

- * - *
    - *
  • - *

    HITs created with fewer than 10 assignments cannot be extended to have 10 or more assignments. Attempting to add assignments in a way that brings the total number of assignments for a HIT from fewer than 10 assignments to 10 or more - * assignments will result in an - * AWS.MechanicalTurk.InvalidMaximumAssignmentsIncrease - * exception.

    - *
  • - *
  • - *

    HITs that were created before July 22, 2015 cannot be extended. Attempting to extend HITs that were created before July 22, 2015 will result in an - * AWS.MechanicalTurk.HITTooOldForExtension - * exception. - *

    - *
  • - *
- *
+ * @see {@link CreateAdditionalAssignmentsForHITCommand} */ - public createAdditionalAssignmentsForHIT( + createAdditionalAssignmentsForHIT( args: CreateAdditionalAssignmentsForHITCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAdditionalAssignmentsForHIT( + createAdditionalAssignmentsForHIT( args: CreateAdditionalAssignmentsForHITCommandInput, cb: (err: any, data?: CreateAdditionalAssignmentsForHITCommandOutput) => void ): void; - public createAdditionalAssignmentsForHIT( + createAdditionalAssignmentsForHIT( args: CreateAdditionalAssignmentsForHITCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAdditionalAssignmentsForHITCommandOutput) => void ): void; - public createAdditionalAssignmentsForHIT( - args: CreateAdditionalAssignmentsForHITCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAdditionalAssignmentsForHITCommandOutput) => void), - cb?: (err: any, data?: CreateAdditionalAssignmentsForHITCommandOutput) => void - ): Promise | void { - const command = new CreateAdditionalAssignmentsForHITCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The CreateHIT operation creates a new Human Intelligence Task (HIT). - * The new HIT is made available for Workers to find and accept on the Amazon Mechanical - * Turk website.

- *

- * This operation allows you to specify a new HIT by passing in values for the properties of the HIT, such as its title, reward amount and number of assignments. When you pass these values to CreateHIT, a new HIT is created for you, with a new HITTypeID. The HITTypeID can be used to create additional HITs in the future without needing to specify common parameters such as the title, description and reward amount each time.

- *

An alternative way to create HITs is to first generate a HITTypeID using the CreateHITType operation and then call the CreateHITWithHITType operation. This is the recommended best practice for Requesters who are creating large numbers of HITs. - *

- * - *

CreateHIT also supports several ways to provide question data: by providing a value - * for the Question parameter that fully specifies the contents of the HIT, or by providing - * a HitLayoutId and associated HitLayoutParameters. - *

- * - * - *

If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see - * Amazon Mechanical Turk Pricing.

- *
+ * @see {@link CreateHITCommand} */ - public createHIT(args: CreateHITCommandInput, options?: __HttpHandlerOptions): Promise; - public createHIT(args: CreateHITCommandInput, cb: (err: any, data?: CreateHITCommandOutput) => void): void; - public createHIT( + createHIT(args: CreateHITCommandInput, options?: __HttpHandlerOptions): Promise; + createHIT(args: CreateHITCommandInput, cb: (err: any, data?: CreateHITCommandOutput) => void): void; + createHIT( args: CreateHITCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHITCommandOutput) => void ): void; - public createHIT( - args: CreateHITCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateHITCommandOutput) => void), - cb?: (err: any, data?: CreateHITCommandOutput) => void - ): Promise | void { - const command = new CreateHITCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The CreateHITType operation creates a new HIT type. This operation - * allows you to define a standard set of HIT properties to use when creating HITs. - * If you register a HIT type with values that match an existing HIT type, the HIT type - * ID of the existing type will be returned. - *

+ * @see {@link CreateHITTypeCommand} */ - public createHITType( - args: CreateHITTypeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createHITType( - args: CreateHITTypeCommandInput, - cb: (err: any, data?: CreateHITTypeCommandOutput) => void - ): void; - public createHITType( + createHITType(args: CreateHITTypeCommandInput, options?: __HttpHandlerOptions): Promise; + createHITType(args: CreateHITTypeCommandInput, cb: (err: any, data?: CreateHITTypeCommandOutput) => void): void; + createHITType( args: CreateHITTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHITTypeCommandOutput) => void ): void; - public createHITType( - args: CreateHITTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateHITTypeCommandOutput) => void), - cb?: (err: any, data?: CreateHITTypeCommandOutput) => void - ): Promise | void { - const command = new CreateHITTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The CreateHITWithHITType operation creates a new Human Intelligence Task (HIT) - * using an existing HITTypeID generated by the CreateHITType operation. - *

- *

- * This is an alternative way to create HITs from the CreateHIT operation. - * This is the recommended best practice for Requesters who are creating large numbers of HITs. - *

- *

CreateHITWithHITType also supports several ways to provide question data: - * by providing a value for the Question parameter that fully specifies the contents of the HIT, - * or by providing a HitLayoutId and associated HitLayoutParameters. - *

- * - *

- * If a HIT is created with 10 or more maximum assignments, there is an additional fee. - * For more information, see Amazon Mechanical Turk Pricing. - *

- *
+ * @see {@link CreateHITWithHITTypeCommand} */ - public createHITWithHITType( + createHITWithHITType( args: CreateHITWithHITTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public createHITWithHITType( + createHITWithHITType( args: CreateHITWithHITTypeCommandInput, cb: (err: any, data?: CreateHITWithHITTypeCommandOutput) => void ): void; - public createHITWithHITType( + createHITWithHITType( args: CreateHITWithHITTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHITWithHITTypeCommandOutput) => void ): void; - public createHITWithHITType( - args: CreateHITWithHITTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateHITWithHITTypeCommandOutput) => void), - cb?: (err: any, data?: CreateHITWithHITTypeCommandOutput) => void - ): Promise | void { - const command = new CreateHITWithHITTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The - * CreateQualificationType - * operation creates a new Qualification type, which is represented by a - * QualificationType - * data structure. - *

+ * @see {@link CreateQualificationTypeCommand} */ - public createQualificationType( + createQualificationType( args: CreateQualificationTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public createQualificationType( + createQualificationType( args: CreateQualificationTypeCommandInput, cb: (err: any, data?: CreateQualificationTypeCommandOutput) => void ): void; - public createQualificationType( + createQualificationType( args: CreateQualificationTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateQualificationTypeCommandOutput) => void ): void; - public createQualificationType( - args: CreateQualificationTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateQualificationTypeCommandOutput) => void), - cb?: (err: any, data?: CreateQualificationTypeCommandOutput) => void - ): Promise | void { - const command = new CreateQualificationTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The CreateWorkerBlock operation allows you to prevent a Worker from working on your HITs. For example, you can block a Worker who is producing poor quality work. You can block up to 100,000 Workers.

+ * @see {@link CreateWorkerBlockCommand} */ - public createWorkerBlock( + createWorkerBlock( args: CreateWorkerBlockCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorkerBlock( + createWorkerBlock( args: CreateWorkerBlockCommandInput, cb: (err: any, data?: CreateWorkerBlockCommandOutput) => void ): void; - public createWorkerBlock( + createWorkerBlock( args: CreateWorkerBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkerBlockCommandOutput) => void ): void; - public createWorkerBlock( - args: CreateWorkerBlockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorkerBlockCommandOutput) => void), - cb?: (err: any, data?: CreateWorkerBlockCommandOutput) => void - ): Promise | void { - const command = new CreateWorkerBlockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The DeleteHIT operation is used to delete HIT that is no longer needed. - * Only the Requester who created the HIT can delete it. - *

- *

- * You can only dispose of HITs that are in the Reviewable state, - * with all of their submitted assignments already either approved or rejected. - * If you call the DeleteHIT operation on a HIT that is not in the Reviewable state - * (for example, that has not expired, or still has active assignments), - * or on a HIT that is Reviewable but without all of its submitted assignments - * already approved or rejected, the service will return an error. - *

- * - *
    - *
  • - *

    - * HITs are automatically disposed of after 120 days. - *

    - *
  • - *
  • - *

    - * After you dispose of a HIT, you can no longer approve the HIT's rejected assignments. - *

    - *
  • - *
  • - *

    - * Disposed HITs are not returned in results for the ListHITs operation. - *

    - *
  • - *
  • - *

    - * Disposing HITs can improve the performance of operations such as ListReviewableHITs and ListHITs. - *

    - *
  • - *
- *
+ * @see {@link DeleteHITCommand} */ - public deleteHIT(args: DeleteHITCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteHIT(args: DeleteHITCommandInput, cb: (err: any, data?: DeleteHITCommandOutput) => void): void; - public deleteHIT( + deleteHIT(args: DeleteHITCommandInput, options?: __HttpHandlerOptions): Promise; + deleteHIT(args: DeleteHITCommandInput, cb: (err: any, data?: DeleteHITCommandOutput) => void): void; + deleteHIT( args: DeleteHITCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHITCommandOutput) => void ): void; - public deleteHIT( - args: DeleteHITCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteHITCommandOutput) => void), - cb?: (err: any, data?: DeleteHITCommandOutput) => void - ): Promise | void { - const command = new DeleteHITCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The - * DeleteQualificationType - * deletes a Qualification type and deletes any HIT types that are - * associated with the Qualification type. - *

- *

This operation does not revoke Qualifications already assigned - * to Workers because the Qualifications might be needed for active HITs. - * If there are any pending requests for the Qualification type, Amazon - * Mechanical Turk rejects those requests. After you delete a - * Qualification type, you can no longer use it to create HITs or HIT - * types.

- * - *

DeleteQualificationType must wait for all the HITs that use - * the deleted Qualification type to be deleted before completing. It - * may take up to 48 hours before DeleteQualificationType completes and - * the unique name of the Qualification type is available for reuse with - * CreateQualificationType.

- *
+ * @see {@link DeleteQualificationTypeCommand} */ - public deleteQualificationType( + deleteQualificationType( args: DeleteQualificationTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteQualificationType( + deleteQualificationType( args: DeleteQualificationTypeCommandInput, cb: (err: any, data?: DeleteQualificationTypeCommandOutput) => void ): void; - public deleteQualificationType( + deleteQualificationType( args: DeleteQualificationTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteQualificationTypeCommandOutput) => void ): void; - public deleteQualificationType( - args: DeleteQualificationTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteQualificationTypeCommandOutput) => void), - cb?: (err: any, data?: DeleteQualificationTypeCommandOutput) => void - ): Promise | void { - const command = new DeleteQualificationTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The DeleteWorkerBlock operation allows you to reinstate a blocked Worker to work on your HITs. This operation reverses the effects of the CreateWorkerBlock operation. You need the Worker ID to use this operation. If the Worker ID is missing or invalid, this operation fails and returns the message “WorkerId is invalid.” If the specified Worker is not blocked, this operation returns successfully.

+ * @see {@link DeleteWorkerBlockCommand} */ - public deleteWorkerBlock( + deleteWorkerBlock( args: DeleteWorkerBlockCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWorkerBlock( + deleteWorkerBlock( args: DeleteWorkerBlockCommandInput, cb: (err: any, data?: DeleteWorkerBlockCommandOutput) => void ): void; - public deleteWorkerBlock( + deleteWorkerBlock( args: DeleteWorkerBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkerBlockCommandOutput) => void ): void; - public deleteWorkerBlock( - args: DeleteWorkerBlockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorkerBlockCommandOutput) => void), - cb?: (err: any, data?: DeleteWorkerBlockCommandOutput) => void - ): Promise | void { - const command = new DeleteWorkerBlockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The DisassociateQualificationFromWorker - * revokes a previously granted Qualification from a user. - *

- *

- * You can provide a text message explaining why the Qualification was - * revoked. The user who had the Qualification can see this message. - *

+ * @see {@link DisassociateQualificationFromWorkerCommand} */ - public disassociateQualificationFromWorker( + disassociateQualificationFromWorker( args: DisassociateQualificationFromWorkerCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateQualificationFromWorker( + disassociateQualificationFromWorker( args: DisassociateQualificationFromWorkerCommandInput, cb: (err: any, data?: DisassociateQualificationFromWorkerCommandOutput) => void ): void; - public disassociateQualificationFromWorker( + disassociateQualificationFromWorker( args: DisassociateQualificationFromWorkerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateQualificationFromWorkerCommandOutput) => void ): void; - public disassociateQualificationFromWorker( - args: DisassociateQualificationFromWorkerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateQualificationFromWorkerCommandOutput) => void), - cb?: (err: any, data?: DisassociateQualificationFromWorkerCommandOutput) => void - ): Promise | void { - const command = new DisassociateQualificationFromWorkerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The GetAccountBalance operation retrieves the Prepaid HITs balance in your Amazon Mechanical Turk account if you are a Prepaid Requester. - * Alternatively, this operation will retrieve the remaining available AWS Billing usage if you have enabled AWS Billing. - * Note: If you have enabled AWS Billing and still have a remaining Prepaid HITs balance, this balance can be viewed on the My Account page in the Requester console.

+ * @see {@link GetAccountBalanceCommand} */ - public getAccountBalance( + getAccountBalance( args: GetAccountBalanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccountBalance( + getAccountBalance( args: GetAccountBalanceCommandInput, cb: (err: any, data?: GetAccountBalanceCommandOutput) => void ): void; - public getAccountBalance( + getAccountBalance( args: GetAccountBalanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountBalanceCommandOutput) => void ): void; - public getAccountBalance( - args: GetAccountBalanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccountBalanceCommandOutput) => void), - cb?: (err: any, data?: GetAccountBalanceCommandOutput) => void - ): Promise | void { - const command = new GetAccountBalanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The GetAssignment operation retrieves the details of the specified Assignment. - *

+ * @see {@link GetAssignmentCommand} */ - public getAssignment( - args: GetAssignmentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getAssignment( - args: GetAssignmentCommandInput, - cb: (err: any, data?: GetAssignmentCommandOutput) => void - ): void; - public getAssignment( + getAssignment(args: GetAssignmentCommandInput, options?: __HttpHandlerOptions): Promise; + getAssignment(args: GetAssignmentCommandInput, cb: (err: any, data?: GetAssignmentCommandOutput) => void): void; + getAssignment( args: GetAssignmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAssignmentCommandOutput) => void ): void; - public getAssignment( - args: GetAssignmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAssignmentCommandOutput) => void), - cb?: (err: any, data?: GetAssignmentCommandOutput) => void - ): Promise | void { - const command = new GetAssignmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The - * GetFileUploadURL - * operation generates and returns a temporary URL. You use the - * temporary URL to retrieve a file uploaded by a Worker as an answer to - * a FileUploadAnswer question for a HIT. The temporary URL is generated - * the instant the GetFileUploadURL operation is called, and is valid - * for 60 seconds. You can get a temporary file upload URL any time - * until the HIT is disposed. After the HIT is disposed, any uploaded - * files are deleted, and cannot be retrieved. - * - * Pending Deprecation on December 12, 2017. The Answer Specification - * structure will no longer support the FileUploadAnswer - * element to be used for the QuestionForm data structure. - * Instead, we recommend that Requesters who want to create HITs asking - * Workers to upload files to use Amazon S3. - * - *

+ * @see {@link GetFileUploadURLCommand} */ - public getFileUploadURL( + getFileUploadURL( args: GetFileUploadURLCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFileUploadURL( + getFileUploadURL( args: GetFileUploadURLCommandInput, cb: (err: any, data?: GetFileUploadURLCommandOutput) => void ): void; - public getFileUploadURL( + getFileUploadURL( args: GetFileUploadURLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFileUploadURLCommandOutput) => void ): void; - public getFileUploadURL( - args: GetFileUploadURLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFileUploadURLCommandOutput) => void), - cb?: (err: any, data?: GetFileUploadURLCommandOutput) => void - ): Promise | void { - const command = new GetFileUploadURLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The GetHIT operation retrieves the details of the specified HIT. - *

+ * @see {@link GetHITCommand} */ - public getHIT(args: GetHITCommandInput, options?: __HttpHandlerOptions): Promise; - public getHIT(args: GetHITCommandInput, cb: (err: any, data?: GetHITCommandOutput) => void): void; - public getHIT( + getHIT(args: GetHITCommandInput, options?: __HttpHandlerOptions): Promise; + getHIT(args: GetHITCommandInput, cb: (err: any, data?: GetHITCommandOutput) => void): void; + getHIT( args: GetHITCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHITCommandOutput) => void ): void; - public getHIT( - args: GetHITCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetHITCommandOutput) => void), - cb?: (err: any, data?: GetHITCommandOutput) => void - ): Promise | void { - const command = new GetHITCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The - * GetQualificationScore - * operation returns the value of a Worker's Qualification for a given - * Qualification type. - *

- *

- * To get a Worker's Qualification, you must know the Worker's ID. The - * Worker's ID is included in the assignment data returned by the - * ListAssignmentsForHIT - * operation. - *

- *

Only the owner of a Qualification type can query the value of - * a Worker's Qualification of that type.

+ * @see {@link GetQualificationScoreCommand} */ - public getQualificationScore( + getQualificationScore( args: GetQualificationScoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public getQualificationScore( + getQualificationScore( args: GetQualificationScoreCommandInput, cb: (err: any, data?: GetQualificationScoreCommandOutput) => void ): void; - public getQualificationScore( + getQualificationScore( args: GetQualificationScoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQualificationScoreCommandOutput) => void ): void; - public getQualificationScore( - args: GetQualificationScoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetQualificationScoreCommandOutput) => void), - cb?: (err: any, data?: GetQualificationScoreCommandOutput) => void - ): Promise | void { - const command = new GetQualificationScoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The GetQualificationTypeoperation retrieves information about a Qualification type using its ID. - *

+ * @see {@link GetQualificationTypeCommand} */ - public getQualificationType( + getQualificationType( args: GetQualificationTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public getQualificationType( + getQualificationType( args: GetQualificationTypeCommandInput, cb: (err: any, data?: GetQualificationTypeCommandOutput) => void ): void; - public getQualificationType( + getQualificationType( args: GetQualificationTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQualificationTypeCommandOutput) => void ): void; - public getQualificationType( - args: GetQualificationTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetQualificationTypeCommandOutput) => void), - cb?: (err: any, data?: GetQualificationTypeCommandOutput) => void - ): Promise | void { - const command = new GetQualificationTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The - * ListAssignmentsForHIT - * operation retrieves completed assignments for a HIT. You can use this - * operation to retrieve the results for a HIT. - *

- *

You can get assignments for a HIT at any time, even if the - * HIT is not yet Reviewable. If a HIT requested multiple assignments, - * and has received some results but has not yet become Reviewable, you - * can still retrieve the partial results with this operation. - *

- *

Use the AssignmentStatus parameter to control which set of - * assignments for a HIT are returned. The ListAssignmentsForHIT - * operation - * can return submitted assignments awaiting approval, or it can return - * assignments that have already been approved or rejected. You can set - * AssignmentStatus=Approved,Rejected to get assignments that have - * already been approved and rejected together in one result set. - *

- *

Only the Requester who created the HIT can retrieve the - * assignments for that HIT. - *

- *

Results are sorted and divided into numbered pages and the - * operation returns a single page of results. You can use the - * parameters - * of the operation to control sorting and pagination. - *

+ * @see {@link ListAssignmentsForHITCommand} */ - public listAssignmentsForHIT( + listAssignmentsForHIT( args: ListAssignmentsForHITCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssignmentsForHIT( + listAssignmentsForHIT( args: ListAssignmentsForHITCommandInput, cb: (err: any, data?: ListAssignmentsForHITCommandOutput) => void ): void; - public listAssignmentsForHIT( + listAssignmentsForHIT( args: ListAssignmentsForHITCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssignmentsForHITCommandOutput) => void ): void; - public listAssignmentsForHIT( - args: ListAssignmentsForHITCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssignmentsForHITCommandOutput) => void), - cb?: (err: any, data?: ListAssignmentsForHITCommandOutput) => void - ): Promise | void { - const command = new ListAssignmentsForHITCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The - * ListBonusPayments - * operation retrieves the amounts of bonuses you have paid to Workers - * for a given HIT or assignment. - *

+ * @see {@link ListBonusPaymentsCommand} */ - public listBonusPayments( + listBonusPayments( args: ListBonusPaymentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBonusPayments( + listBonusPayments( args: ListBonusPaymentsCommandInput, cb: (err: any, data?: ListBonusPaymentsCommandOutput) => void ): void; - public listBonusPayments( + listBonusPayments( args: ListBonusPaymentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBonusPaymentsCommandOutput) => void ): void; - public listBonusPayments( - args: ListBonusPaymentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBonusPaymentsCommandOutput) => void), - cb?: (err: any, data?: ListBonusPaymentsCommandOutput) => void - ): Promise | void { - const command = new ListBonusPaymentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The - * ListHITs - * operation returns all of a Requester's HITs. The operation returns - * HITs of any status, except for HITs that have been deleted of with - * the DeleteHIT operation or that have been auto-deleted. - *

+ * @see {@link ListHITsCommand} */ - public listHITs(args: ListHITsCommandInput, options?: __HttpHandlerOptions): Promise; - public listHITs(args: ListHITsCommandInput, cb: (err: any, data?: ListHITsCommandOutput) => void): void; - public listHITs( + listHITs(args: ListHITsCommandInput, options?: __HttpHandlerOptions): Promise; + listHITs(args: ListHITsCommandInput, cb: (err: any, data?: ListHITsCommandOutput) => void): void; + listHITs( args: ListHITsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHITsCommandOutput) => void ): void; - public listHITs( - args: ListHITsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListHITsCommandOutput) => void), - cb?: (err: any, data?: ListHITsCommandOutput) => void - ): Promise | void { - const command = new ListHITsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The ListHITsForQualificationType operation returns the HITs that use - * the given Qualification type for a Qualification requirement. - * The operation returns HITs of any status, except for HITs that have been deleted - * with the DeleteHIT operation or that have been auto-deleted. - *

+ * @see {@link ListHITsForQualificationTypeCommand} */ - public listHITsForQualificationType( + listHITsForQualificationType( args: ListHITsForQualificationTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public listHITsForQualificationType( + listHITsForQualificationType( args: ListHITsForQualificationTypeCommandInput, cb: (err: any, data?: ListHITsForQualificationTypeCommandOutput) => void ): void; - public listHITsForQualificationType( + listHITsForQualificationType( args: ListHITsForQualificationTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHITsForQualificationTypeCommandOutput) => void ): void; - public listHITsForQualificationType( - args: ListHITsForQualificationTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListHITsForQualificationTypeCommandOutput) => void), - cb?: (err: any, data?: ListHITsForQualificationTypeCommandOutput) => void - ): Promise | void { - const command = new ListHITsForQualificationTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The - * ListQualificationRequests - * operation retrieves requests for Qualifications of a particular - * Qualification type. The owner of the Qualification type calls this - * operation to poll for pending requests, and accepts them using the - * AcceptQualification operation. - *

+ * @see {@link ListQualificationRequestsCommand} */ - public listQualificationRequests( + listQualificationRequests( args: ListQualificationRequestsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listQualificationRequests( + listQualificationRequests( args: ListQualificationRequestsCommandInput, cb: (err: any, data?: ListQualificationRequestsCommandOutput) => void ): void; - public listQualificationRequests( + listQualificationRequests( args: ListQualificationRequestsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQualificationRequestsCommandOutput) => void ): void; - public listQualificationRequests( - args: ListQualificationRequestsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListQualificationRequestsCommandOutput) => void), - cb?: (err: any, data?: ListQualificationRequestsCommandOutput) => void - ): Promise | void { - const command = new ListQualificationRequestsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The - * ListQualificationTypes - * operation returns a list of Qualification types, filtered by - * an optional search term. - *

+ * @see {@link ListQualificationTypesCommand} */ - public listQualificationTypes( + listQualificationTypes( args: ListQualificationTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listQualificationTypes( + listQualificationTypes( args: ListQualificationTypesCommandInput, cb: (err: any, data?: ListQualificationTypesCommandOutput) => void ): void; - public listQualificationTypes( + listQualificationTypes( args: ListQualificationTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQualificationTypesCommandOutput) => void ): void; - public listQualificationTypes( - args: ListQualificationTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListQualificationTypesCommandOutput) => void), - cb?: (err: any, data?: ListQualificationTypesCommandOutput) => void - ): Promise | void { - const command = new ListQualificationTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The ListReviewableHITs operation retrieves the HITs with Status equal to - * Reviewable or Status equal to Reviewing that belong to the Requester calling the operation. - *

+ * @see {@link ListReviewableHITsCommand} */ - public listReviewableHITs( + listReviewableHITs( args: ListReviewableHITsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReviewableHITs( + listReviewableHITs( args: ListReviewableHITsCommandInput, cb: (err: any, data?: ListReviewableHITsCommandOutput) => void ): void; - public listReviewableHITs( + listReviewableHITs( args: ListReviewableHITsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReviewableHITsCommandOutput) => void ): void; - public listReviewableHITs( - args: ListReviewableHITsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReviewableHITsCommandOutput) => void), - cb?: (err: any, data?: ListReviewableHITsCommandOutput) => void - ): Promise | void { - const command = new ListReviewableHITsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The ListReviewPolicyResultsForHIT operation retrieves the computed results - * and the actions taken in the course of executing your Review Policies for a given HIT. - * For information about how to specify Review Policies when you call CreateHIT, - * see Review Policies. The ListReviewPolicyResultsForHIT operation can return results for both - * Assignment-level and HIT-level review results. - *

+ * @see {@link ListReviewPolicyResultsForHITCommand} */ - public listReviewPolicyResultsForHIT( + listReviewPolicyResultsForHIT( args: ListReviewPolicyResultsForHITCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReviewPolicyResultsForHIT( + listReviewPolicyResultsForHIT( args: ListReviewPolicyResultsForHITCommandInput, cb: (err: any, data?: ListReviewPolicyResultsForHITCommandOutput) => void ): void; - public listReviewPolicyResultsForHIT( + listReviewPolicyResultsForHIT( args: ListReviewPolicyResultsForHITCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReviewPolicyResultsForHITCommandOutput) => void ): void; - public listReviewPolicyResultsForHIT( - args: ListReviewPolicyResultsForHITCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReviewPolicyResultsForHITCommandOutput) => void), - cb?: (err: any, data?: ListReviewPolicyResultsForHITCommandOutput) => void - ): Promise | void { - const command = new ListReviewPolicyResultsForHITCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your HITs.

+ * @see {@link ListWorkerBlocksCommand} */ - public listWorkerBlocks( + listWorkerBlocks( args: ListWorkerBlocksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWorkerBlocks( + listWorkerBlocks( args: ListWorkerBlocksCommandInput, cb: (err: any, data?: ListWorkerBlocksCommandOutput) => void ): void; - public listWorkerBlocks( + listWorkerBlocks( args: ListWorkerBlocksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkerBlocksCommandOutput) => void ): void; - public listWorkerBlocks( - args: ListWorkerBlocksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkerBlocksCommandOutput) => void), - cb?: (err: any, data?: ListWorkerBlocksCommandOutput) => void - ): Promise | void { - const command = new ListWorkerBlocksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The ListWorkersWithQualificationType operation returns all of the Workers - * that have been associated with a given Qualification type. - *

+ * @see {@link ListWorkersWithQualificationTypeCommand} */ - public listWorkersWithQualificationType( + listWorkersWithQualificationType( args: ListWorkersWithQualificationTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWorkersWithQualificationType( + listWorkersWithQualificationType( args: ListWorkersWithQualificationTypeCommandInput, cb: (err: any, data?: ListWorkersWithQualificationTypeCommandOutput) => void ): void; - public listWorkersWithQualificationType( + listWorkersWithQualificationType( args: ListWorkersWithQualificationTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkersWithQualificationTypeCommandOutput) => void ): void; - public listWorkersWithQualificationType( - args: ListWorkersWithQualificationTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkersWithQualificationTypeCommandOutput) => void), - cb?: (err: any, data?: ListWorkersWithQualificationTypeCommandOutput) => void - ): Promise | void { - const command = new ListWorkersWithQualificationTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The - * NotifyWorkers - * operation sends an email to one or more Workers that you specify with - * the Worker ID. You can specify up to 100 Worker IDs to send the same - * message with a single call to the NotifyWorkers operation. The - * NotifyWorkers operation will send a notification email to a Worker - * only if you have previously approved or rejected work from the - * Worker. - *

+ * @see {@link NotifyWorkersCommand} */ - public notifyWorkers( - args: NotifyWorkersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public notifyWorkers( - args: NotifyWorkersCommandInput, - cb: (err: any, data?: NotifyWorkersCommandOutput) => void - ): void; - public notifyWorkers( + notifyWorkers(args: NotifyWorkersCommandInput, options?: __HttpHandlerOptions): Promise; + notifyWorkers(args: NotifyWorkersCommandInput, cb: (err: any, data?: NotifyWorkersCommandOutput) => void): void; + notifyWorkers( args: NotifyWorkersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NotifyWorkersCommandOutput) => void ): void; - public notifyWorkers( - args: NotifyWorkersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NotifyWorkersCommandOutput) => void), - cb?: (err: any, data?: NotifyWorkersCommandOutput) => void - ): Promise | void { - const command = new NotifyWorkersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The RejectAssignment operation rejects the results of a completed assignment. - *

- *

- * You can include an optional feedback message with the rejection, - * which the Worker can see in the Status section of the web site. - * When you include a feedback message with the rejection, - * it helps the Worker understand why the assignment was rejected, - * and can improve the quality of the results the Worker submits in the future. - *

- *

- * Only the Requester who created the HIT can reject an assignment for the HIT. - *

+ * @see {@link RejectAssignmentCommand} */ - public rejectAssignment( + rejectAssignment( args: RejectAssignmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public rejectAssignment( + rejectAssignment( args: RejectAssignmentCommandInput, cb: (err: any, data?: RejectAssignmentCommandOutput) => void ): void; - public rejectAssignment( + rejectAssignment( args: RejectAssignmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectAssignmentCommandOutput) => void ): void; - public rejectAssignment( - args: RejectAssignmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RejectAssignmentCommandOutput) => void), - cb?: (err: any, data?: RejectAssignmentCommandOutput) => void - ): Promise | void { - const command = new RejectAssignmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The - * RejectQualificationRequest - * operation rejects a user's request for a Qualification. - *

- *

You can provide a text message explaining why the request was - * rejected. The Worker who made the request can see this message.

+ * @see {@link RejectQualificationRequestCommand} */ - public rejectQualificationRequest( + rejectQualificationRequest( args: RejectQualificationRequestCommandInput, options?: __HttpHandlerOptions ): Promise; - public rejectQualificationRequest( + rejectQualificationRequest( args: RejectQualificationRequestCommandInput, cb: (err: any, data?: RejectQualificationRequestCommandOutput) => void ): void; - public rejectQualificationRequest( + rejectQualificationRequest( args: RejectQualificationRequestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectQualificationRequestCommandOutput) => void ): void; - public rejectQualificationRequest( - args: RejectQualificationRequestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RejectQualificationRequestCommandOutput) => void), - cb?: (err: any, data?: RejectQualificationRequestCommandOutput) => void - ): Promise | void { - const command = new RejectQualificationRequestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The - * SendBonus - * operation issues a payment of money from your account to a Worker. - * This payment happens separately from the reward you pay to the Worker - * when you approve the Worker's assignment. The SendBonus operation - * requires the Worker's ID and the assignment ID as parameters to - * initiate payment of the bonus. You must include a message that - * explains the reason for the bonus payment, as the Worker may not be - * expecting the payment. Amazon Mechanical Turk collects a fee for - * bonus payments, similar to the HIT listing fee. This operation fails - * if your account does not have enough funds to pay for both the bonus - * and the fees. - *

+ * @see {@link SendBonusCommand} */ - public sendBonus(args: SendBonusCommandInput, options?: __HttpHandlerOptions): Promise; - public sendBonus(args: SendBonusCommandInput, cb: (err: any, data?: SendBonusCommandOutput) => void): void; - public sendBonus( + sendBonus(args: SendBonusCommandInput, options?: __HttpHandlerOptions): Promise; + sendBonus(args: SendBonusCommandInput, cb: (err: any, data?: SendBonusCommandOutput) => void): void; + sendBonus( args: SendBonusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendBonusCommandOutput) => void ): void; - public sendBonus( - args: SendBonusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendBonusCommandOutput) => void), - cb?: (err: any, data?: SendBonusCommandOutput) => void - ): Promise | void { - const command = new SendBonusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The SendTestEventNotification operation causes Amazon Mechanical Turk to send - * a notification message as if a HIT event occurred, according to the provided - * notification specification. This allows you to test notifications without - * setting up notifications for a real HIT type and trying to trigger them using the website. - * When you call this operation, the service attempts to send the test notification immediately. - *

+ * @see {@link SendTestEventNotificationCommand} */ - public sendTestEventNotification( + sendTestEventNotification( args: SendTestEventNotificationCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendTestEventNotification( + sendTestEventNotification( args: SendTestEventNotificationCommandInput, cb: (err: any, data?: SendTestEventNotificationCommandOutput) => void ): void; - public sendTestEventNotification( + sendTestEventNotification( args: SendTestEventNotificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendTestEventNotificationCommandOutput) => void ): void; - public sendTestEventNotification( - args: SendTestEventNotificationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendTestEventNotificationCommandOutput) => void), - cb?: (err: any, data?: SendTestEventNotificationCommandOutput) => void - ): Promise | void { - const command = new SendTestEventNotificationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The UpdateExpirationForHIT operation allows you update the expiration time of a HIT. - * If you update it to a time in the past, the HIT will be immediately expired. - *

+ * @see {@link UpdateExpirationForHITCommand} */ - public updateExpirationForHIT( + updateExpirationForHIT( args: UpdateExpirationForHITCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateExpirationForHIT( + updateExpirationForHIT( args: UpdateExpirationForHITCommandInput, cb: (err: any, data?: UpdateExpirationForHITCommandOutput) => void ): void; - public updateExpirationForHIT( + updateExpirationForHIT( args: UpdateExpirationForHITCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateExpirationForHITCommandOutput) => void ): void; - public updateExpirationForHIT( - args: UpdateExpirationForHITCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateExpirationForHITCommandOutput) => void), - cb?: (err: any, data?: UpdateExpirationForHITCommandOutput) => void - ): Promise | void { - const command = new UpdateExpirationForHITCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The UpdateHITReviewStatus operation updates the status of a HIT. - * If the status is Reviewable, this operation can update the status to Reviewing, - * or it can revert a Reviewing HIT back to the Reviewable status. - *

+ * @see {@link UpdateHITReviewStatusCommand} */ - public updateHITReviewStatus( + updateHITReviewStatus( args: UpdateHITReviewStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateHITReviewStatus( + updateHITReviewStatus( args: UpdateHITReviewStatusCommandInput, cb: (err: any, data?: UpdateHITReviewStatusCommandOutput) => void ): void; - public updateHITReviewStatus( + updateHITReviewStatus( args: UpdateHITReviewStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateHITReviewStatusCommandOutput) => void ): void; - public updateHITReviewStatus( - args: UpdateHITReviewStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateHITReviewStatusCommandOutput) => void), - cb?: (err: any, data?: UpdateHITReviewStatusCommandOutput) => void - ): Promise | void { - const command = new UpdateHITReviewStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The - * UpdateHITTypeOfHIT - * operation allows you to change the HITType properties of a HIT. This - * operation disassociates the HIT from its old HITType properties and - * associates it with the new HITType properties. The HIT takes on the - * properties of the new HITType in place of the old ones. - *

+ * @see {@link UpdateHITTypeOfHITCommand} */ - public updateHITTypeOfHIT( + updateHITTypeOfHIT( args: UpdateHITTypeOfHITCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateHITTypeOfHIT( + updateHITTypeOfHIT( args: UpdateHITTypeOfHITCommandInput, cb: (err: any, data?: UpdateHITTypeOfHITCommandOutput) => void ): void; - public updateHITTypeOfHIT( + updateHITTypeOfHIT( args: UpdateHITTypeOfHITCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateHITTypeOfHITCommandOutput) => void ): void; - public updateHITTypeOfHIT( - args: UpdateHITTypeOfHITCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateHITTypeOfHITCommandOutput) => void), - cb?: (err: any, data?: UpdateHITTypeOfHITCommandOutput) => void - ): Promise | void { - const command = new UpdateHITTypeOfHITCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The UpdateNotificationSettings operation creates, updates, - * disables or re-enables notifications for a HIT type. - * If you call the UpdateNotificationSettings operation for a HIT type that already has a - * notification specification, the operation replaces the old specification with a new one. - * You can call the UpdateNotificationSettings operation to enable or disable notifications - * for the HIT type, without having to modify the notification specification itself by providing - * updates to the Active status without specifying a new notification specification. - * To change the Active status of a HIT type's notifications, - * the HIT type must already have a notification specification, - * or one must be provided in the same call to UpdateNotificationSettings. - *

+ * @see {@link UpdateNotificationSettingsCommand} */ - public updateNotificationSettings( + updateNotificationSettings( args: UpdateNotificationSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateNotificationSettings( + updateNotificationSettings( args: UpdateNotificationSettingsCommandInput, cb: (err: any, data?: UpdateNotificationSettingsCommandOutput) => void ): void; - public updateNotificationSettings( + updateNotificationSettings( args: UpdateNotificationSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNotificationSettingsCommandOutput) => void ): void; - public updateNotificationSettings( - args: UpdateNotificationSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateNotificationSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateNotificationSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateNotificationSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * The - * UpdateQualificationType - * operation modifies the attributes of an existing Qualification type, - * which is represented by a QualificationType data structure. Only the - * owner of a Qualification type can modify its attributes. - *

- *

Most attributes of a Qualification type can be changed after - * the type has been created. However, the Name and Keywords fields - * cannot be modified. The RetryDelayInSeconds parameter can be modified - * or added to change the delay or to enable retries, but - * RetryDelayInSeconds cannot be used to disable retries.

- *

You can use this operation to update the test for a - * Qualification type. The test is updated based on the values specified - * for the Test, TestDurationInSeconds and AnswerKey parameters. All - * three parameters specify the updated test. If you are updating the - * test for a type, you must specify the Test and TestDurationInSeconds - * parameters. The AnswerKey parameter is optional; omitting it specifies - * that the updated test does not have an answer key.

- *

If you omit the Test parameter, the test for the - * Qualification type is unchanged. There is no way to remove a test from - * a Qualification type that has one. If the type already has a test, you - * cannot update it to be AutoGranted. If the Qualification type does not - * have a test and one is provided by an update, the type will henceforth - * have a test.

- *

If you want to update the test duration or answer key for an - * existing test without changing the questions, you must specify a Test - * parameter with the original questions, along with the updated values.

- *

If you provide an updated Test but no AnswerKey, the new test - * will not have an answer key. Requests for such Qualifications must be - * granted manually.

- *

You can also update the AutoGranted and AutoGrantedValue - * attributes of the Qualification type.

+ * @see {@link UpdateQualificationTypeCommand} */ - public updateQualificationType( + updateQualificationType( args: UpdateQualificationTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateQualificationType( + updateQualificationType( args: UpdateQualificationTypeCommandInput, cb: (err: any, data?: UpdateQualificationTypeCommandOutput) => void ): void; - public updateQualificationType( + updateQualificationType( args: UpdateQualificationTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateQualificationTypeCommandOutput) => void ): void; - public updateQualificationType( - args: UpdateQualificationTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateQualificationTypeCommandOutput) => void), - cb?: (err: any, data?: UpdateQualificationTypeCommandOutput) => void - ): Promise | void { - const command = new UpdateQualificationTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Mechanical Turk API Reference + */ +export class MTurk extends MTurkClient implements MTurk {} +createAggregatedClient(commands, MTurk); diff --git a/clients/client-mwaa/src/MWAA.ts b/clients/client-mwaa/src/MWAA.ts index c70c3c7bf4ec..a46c365c3dba 100644 --- a/clients/client-mwaa/src/MWAA.ts +++ b/clients/client-mwaa/src/MWAA.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -52,451 +53,276 @@ import { UpdateEnvironmentCommandInput, UpdateEnvironmentCommandOutput, } from "./commands/UpdateEnvironmentCommand"; -import { MWAAClient } from "./MWAAClient"; +import { MWAAClient, MWAAClientConfig } from "./MWAAClient"; -/** - * @public - * Amazon Managed Workflows for Apache Airflow - *

This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation. For more information, see What Is Amazon MWAA?.

- *

- * Endpoints - *

- * - *

- * Regions - *

- *

For a list of regions that Amazon MWAA supports, see Region availability in the Amazon MWAA User Guide.

- */ -export class MWAA extends MWAAClient { +const commands = { + CreateCliTokenCommand, + CreateEnvironmentCommand, + CreateWebLoginTokenCommand, + DeleteEnvironmentCommand, + GetEnvironmentCommand, + ListEnvironmentsCommand, + ListTagsForResourceCommand, + PublishMetricsCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateEnvironmentCommand, +}; + +export interface MWAA { /** - * @public - *

Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI token.

+ * @see {@link CreateCliTokenCommand} */ - public createCliToken( + createCliToken( args: CreateCliTokenCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCliToken( - args: CreateCliTokenCommandInput, - cb: (err: any, data?: CreateCliTokenCommandOutput) => void - ): void; - public createCliToken( + createCliToken(args: CreateCliTokenCommandInput, cb: (err: any, data?: CreateCliTokenCommandOutput) => void): void; + createCliToken( args: CreateCliTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCliTokenCommandOutput) => void ): void; - public createCliToken( - args: CreateCliTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCliTokenCommandOutput) => void), - cb?: (err: any, data?: CreateCliTokenCommandOutput) => void - ): Promise | void { - const command = new CreateCliTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

+ * @see {@link CreateEnvironmentCommand} */ - public createEnvironment( + createEnvironment( args: CreateEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEnvironment( + createEnvironment( args: CreateEnvironmentCommandInput, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void ): void; - public createEnvironment( + createEnvironment( args: CreateEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void ): void; - public createEnvironment( - args: CreateEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEnvironmentCommandOutput) => void), - cb?: (err: any, data?: CreateEnvironmentCommandOutput) => void - ): Promise | void { - const command = new CreateEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web login token.

+ * @see {@link CreateWebLoginTokenCommand} */ - public createWebLoginToken( + createWebLoginToken( args: CreateWebLoginTokenCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWebLoginToken( + createWebLoginToken( args: CreateWebLoginTokenCommandInput, cb: (err: any, data?: CreateWebLoginTokenCommandOutput) => void ): void; - public createWebLoginToken( + createWebLoginToken( args: CreateWebLoginTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWebLoginTokenCommandOutput) => void ): void; - public createWebLoginToken( - args: CreateWebLoginTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWebLoginTokenCommandOutput) => void), - cb?: (err: any, data?: CreateWebLoginTokenCommandOutput) => void - ): Promise | void { - const command = new CreateWebLoginTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

+ * @see {@link DeleteEnvironmentCommand} */ - public deleteEnvironment( + deleteEnvironment( args: DeleteEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEnvironment( + deleteEnvironment( args: DeleteEnvironmentCommandInput, cb: (err: any, data?: DeleteEnvironmentCommandOutput) => void ): void; - public deleteEnvironment( + deleteEnvironment( args: DeleteEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEnvironmentCommandOutput) => void ): void; - public deleteEnvironment( - args: DeleteEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEnvironmentCommandOutput) => void), - cb?: (err: any, data?: DeleteEnvironmentCommandOutput) => void - ): Promise | void { - const command = new DeleteEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

+ * @see {@link GetEnvironmentCommand} */ - public getEnvironment( + getEnvironment( args: GetEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEnvironment( - args: GetEnvironmentCommandInput, - cb: (err: any, data?: GetEnvironmentCommandOutput) => void - ): void; - public getEnvironment( + getEnvironment(args: GetEnvironmentCommandInput, cb: (err: any, data?: GetEnvironmentCommandOutput) => void): void; + getEnvironment( args: GetEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEnvironmentCommandOutput) => void ): void; - public getEnvironment( - args: GetEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEnvironmentCommandOutput) => void), - cb?: (err: any, data?: GetEnvironmentCommandOutput) => void - ): Promise | void { - const command = new GetEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.

+ * @see {@link ListEnvironmentsCommand} */ - public listEnvironments( + listEnvironments( args: ListEnvironmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEnvironments( + listEnvironments( args: ListEnvironmentsCommandInput, cb: (err: any, data?: ListEnvironmentsCommandOutput) => void ): void; - public listEnvironments( + listEnvironments( args: ListEnvironmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnvironmentsCommandOutput) => void ): void; - public listEnvironments( - args: ListEnvironmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEnvironmentsCommandOutput) => void), - cb?: (err: any, data?: ListEnvironmentsCommandOutput) => void - ): Promise | void { - const command = new ListEnvironmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging".

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Internal only. Publishes environment health metrics to Amazon CloudWatch.

+ * @see {@link PublishMetricsCommand} */ - public publishMetrics( + publishMetrics( args: PublishMetricsCommandInput, options?: __HttpHandlerOptions ): Promise; - public publishMetrics( - args: PublishMetricsCommandInput, - cb: (err: any, data?: PublishMetricsCommandOutput) => void - ): void; - public publishMetrics( + publishMetrics(args: PublishMetricsCommandInput, cb: (err: any, data?: PublishMetricsCommandOutput) => void): void; + publishMetrics( args: PublishMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishMetricsCommandOutput) => void ): void; - public publishMetrics( - args: PublishMetricsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PublishMetricsCommandOutput) => void), - cb?: (err: any, data?: PublishMetricsCommandOutput) => void - ): Promise | void { - const command = new PublishMetricsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging".

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

+ * @see {@link UpdateEnvironmentCommand} */ - public updateEnvironment( + updateEnvironment( args: UpdateEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEnvironment( + updateEnvironment( args: UpdateEnvironmentCommandInput, cb: (err: any, data?: UpdateEnvironmentCommandOutput) => void ): void; - public updateEnvironment( + updateEnvironment( args: UpdateEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEnvironmentCommandOutput) => void ): void; - public updateEnvironment( - args: UpdateEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEnvironmentCommandOutput) => void), - cb?: (err: any, data?: UpdateEnvironmentCommandOutput) => void - ): Promise | void { - const command = new UpdateEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Managed Workflows for Apache Airflow + *

This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation. For more information, see What Is Amazon MWAA?.

+ *

+ * Endpoints + *

+ * + *

+ * Regions + *

+ *

For a list of regions that Amazon MWAA supports, see Region availability in the Amazon MWAA User Guide.

+ */ +export class MWAA extends MWAAClient implements MWAA {} +createAggregatedClient(commands, MWAA); diff --git a/clients/client-neptune/src/Neptune.ts b/clients/client-neptune/src/Neptune.ts index dac5af58292a..fe17f0eae77c 100644 --- a/clients/client-neptune/src/Neptune.ts +++ b/clients/client-neptune/src/Neptune.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -346,2579 +347,1253 @@ import { StopDBClusterCommandInput, StopDBClusterCommandOutput, } from "./commands/StopDBClusterCommand"; -import { NeptuneClient } from "./NeptuneClient"; +import { NeptuneClient, NeptuneClientConfig } from "./NeptuneClient"; -/** - * @public - * Amazon Neptune - *

Amazon Neptune is a fast, reliable, fully-managed graph database service that makes it - * easy to build and run applications that work with highly connected datasets. The core of - * Amazon Neptune is a purpose-built, high-performance graph database engine optimized for - * storing billions of relationships and querying the graph with milliseconds latency. Amazon - * Neptune supports popular graph models Property Graph and W3C's RDF, and their respective query - * languages Apache TinkerPop Gremlin and SPARQL, allowing you to easily build queries that - * efficiently navigate highly connected datasets. Neptune powers graph use cases such as - * recommendation engines, fraud detection, knowledge graphs, drug discovery, and network - * security.

- *

This interface reference for Amazon Neptune contains documentation for a programming or - * command line interface you can use to manage Amazon Neptune. Note that Amazon Neptune is - * asynchronous, which means that some interfaces might require techniques such as polling or - * callback functions to determine when a command has been applied. In this reference, the - * parameter descriptions indicate whether a command is applied immediately, on the next instance - * reboot, or during the maintenance window. The reference structure is as follows, and we list - * following some related topics from the user guide.

- */ -export class Neptune extends NeptuneClient { +const commands = { + AddRoleToDBClusterCommand, + AddSourceIdentifierToSubscriptionCommand, + AddTagsToResourceCommand, + ApplyPendingMaintenanceActionCommand, + CopyDBClusterParameterGroupCommand, + CopyDBClusterSnapshotCommand, + CopyDBParameterGroupCommand, + CreateDBClusterCommand, + CreateDBClusterEndpointCommand, + CreateDBClusterParameterGroupCommand, + CreateDBClusterSnapshotCommand, + CreateDBInstanceCommand, + CreateDBParameterGroupCommand, + CreateDBSubnetGroupCommand, + CreateEventSubscriptionCommand, + CreateGlobalClusterCommand, + DeleteDBClusterCommand, + DeleteDBClusterEndpointCommand, + DeleteDBClusterParameterGroupCommand, + DeleteDBClusterSnapshotCommand, + DeleteDBInstanceCommand, + DeleteDBParameterGroupCommand, + DeleteDBSubnetGroupCommand, + DeleteEventSubscriptionCommand, + DeleteGlobalClusterCommand, + DescribeDBClusterEndpointsCommand, + DescribeDBClusterParameterGroupsCommand, + DescribeDBClusterParametersCommand, + DescribeDBClustersCommand, + DescribeDBClusterSnapshotAttributesCommand, + DescribeDBClusterSnapshotsCommand, + DescribeDBEngineVersionsCommand, + DescribeDBInstancesCommand, + DescribeDBParameterGroupsCommand, + DescribeDBParametersCommand, + DescribeDBSubnetGroupsCommand, + DescribeEngineDefaultClusterParametersCommand, + DescribeEngineDefaultParametersCommand, + DescribeEventCategoriesCommand, + DescribeEventsCommand, + DescribeEventSubscriptionsCommand, + DescribeGlobalClustersCommand, + DescribeOrderableDBInstanceOptionsCommand, + DescribePendingMaintenanceActionsCommand, + DescribeValidDBInstanceModificationsCommand, + FailoverDBClusterCommand, + FailoverGlobalClusterCommand, + ListTagsForResourceCommand, + ModifyDBClusterCommand, + ModifyDBClusterEndpointCommand, + ModifyDBClusterParameterGroupCommand, + ModifyDBClusterSnapshotAttributeCommand, + ModifyDBInstanceCommand, + ModifyDBParameterGroupCommand, + ModifyDBSubnetGroupCommand, + ModifyEventSubscriptionCommand, + ModifyGlobalClusterCommand, + PromoteReadReplicaDBClusterCommand, + RebootDBInstanceCommand, + RemoveFromGlobalClusterCommand, + RemoveRoleFromDBClusterCommand, + RemoveSourceIdentifierFromSubscriptionCommand, + RemoveTagsFromResourceCommand, + ResetDBClusterParameterGroupCommand, + ResetDBParameterGroupCommand, + RestoreDBClusterFromSnapshotCommand, + RestoreDBClusterToPointInTimeCommand, + StartDBClusterCommand, + StopDBClusterCommand, +}; + +export interface Neptune { /** - * @public - *

Associates an Identity and Access Management (IAM) role with an - * Neptune DB cluster.

+ * @see {@link AddRoleToDBClusterCommand} */ - public addRoleToDBCluster( + addRoleToDBCluster( args: AddRoleToDBClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public addRoleToDBCluster( + addRoleToDBCluster( args: AddRoleToDBClusterCommandInput, cb: (err: any, data?: AddRoleToDBClusterCommandOutput) => void ): void; - public addRoleToDBCluster( + addRoleToDBCluster( args: AddRoleToDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddRoleToDBClusterCommandOutput) => void ): void; - public addRoleToDBCluster( - args: AddRoleToDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddRoleToDBClusterCommandOutput) => void), - cb?: (err: any, data?: AddRoleToDBClusterCommandOutput) => void - ): Promise | void { - const command = new AddRoleToDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds a source identifier to an existing event notification subscription.

- */ - public addSourceIdentifierToSubscription( + + /** + * @see {@link AddSourceIdentifierToSubscriptionCommand} + */ + addSourceIdentifierToSubscription( args: AddSourceIdentifierToSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public addSourceIdentifierToSubscription( + addSourceIdentifierToSubscription( args: AddSourceIdentifierToSubscriptionCommandInput, cb: (err: any, data?: AddSourceIdentifierToSubscriptionCommandOutput) => void ): void; - public addSourceIdentifierToSubscription( + addSourceIdentifierToSubscription( args: AddSourceIdentifierToSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddSourceIdentifierToSubscriptionCommandOutput) => void ): void; - public addSourceIdentifierToSubscription( - args: AddSourceIdentifierToSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddSourceIdentifierToSubscriptionCommandOutput) => void), - cb?: (err: any, data?: AddSourceIdentifierToSubscriptionCommandOutput) => void - ): Promise | void { - const command = new AddSourceIdentifierToSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds metadata tags to an Amazon Neptune resource. These tags can also be used with cost - * allocation reporting to track cost associated with Amazon Neptune resources, or used in a - * Condition statement in an IAM policy for Amazon Neptune.

- */ - public addTagsToResource( + + /** + * @see {@link AddTagsToResourceCommand} + */ + addTagsToResource( args: AddTagsToResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public addTagsToResource( + addTagsToResource( args: AddTagsToResourceCommandInput, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void ): void; - public addTagsToResource( + addTagsToResource( args: AddTagsToResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void ): void; - public addTagsToResource( - args: AddTagsToResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddTagsToResourceCommandOutput) => void), - cb?: (err: any, data?: AddTagsToResourceCommandOutput) => void - ): Promise | void { - const command = new AddTagsToResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Applies a pending maintenance action to a resource (for example, to a DB instance).

- */ - public applyPendingMaintenanceAction( + + /** + * @see {@link ApplyPendingMaintenanceActionCommand} + */ + applyPendingMaintenanceAction( args: ApplyPendingMaintenanceActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public applyPendingMaintenanceAction( + applyPendingMaintenanceAction( args: ApplyPendingMaintenanceActionCommandInput, cb: (err: any, data?: ApplyPendingMaintenanceActionCommandOutput) => void ): void; - public applyPendingMaintenanceAction( + applyPendingMaintenanceAction( args: ApplyPendingMaintenanceActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ApplyPendingMaintenanceActionCommandOutput) => void ): void; - public applyPendingMaintenanceAction( - args: ApplyPendingMaintenanceActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ApplyPendingMaintenanceActionCommandOutput) => void), - cb?: (err: any, data?: ApplyPendingMaintenanceActionCommandOutput) => void - ): Promise | void { - const command = new ApplyPendingMaintenanceActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Copies the specified DB cluster parameter group.

- */ - public copyDBClusterParameterGroup( + + /** + * @see {@link CopyDBClusterParameterGroupCommand} + */ + copyDBClusterParameterGroup( args: CopyDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public copyDBClusterParameterGroup( + copyDBClusterParameterGroup( args: CopyDBClusterParameterGroupCommandInput, cb: (err: any, data?: CopyDBClusterParameterGroupCommandOutput) => void ): void; - public copyDBClusterParameterGroup( + copyDBClusterParameterGroup( args: CopyDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyDBClusterParameterGroupCommandOutput) => void ): void; - public copyDBClusterParameterGroup( - args: CopyDBClusterParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopyDBClusterParameterGroupCommandOutput) => void), - cb?: (err: any, data?: CopyDBClusterParameterGroupCommandOutput) => void - ): Promise | void { - const command = new CopyDBClusterParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Copies a snapshot of a DB cluster.

- *

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, - * SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the - * shared DB cluster snapshot.

- */ - public copyDBClusterSnapshot( + + /** + * @see {@link CopyDBClusterSnapshotCommand} + */ + copyDBClusterSnapshot( args: CopyDBClusterSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public copyDBClusterSnapshot( + copyDBClusterSnapshot( args: CopyDBClusterSnapshotCommandInput, cb: (err: any, data?: CopyDBClusterSnapshotCommandOutput) => void ): void; - public copyDBClusterSnapshot( + copyDBClusterSnapshot( args: CopyDBClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyDBClusterSnapshotCommandOutput) => void ): void; - public copyDBClusterSnapshot( - args: CopyDBClusterSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopyDBClusterSnapshotCommandOutput) => void), - cb?: (err: any, data?: CopyDBClusterSnapshotCommandOutput) => void - ): Promise | void { - const command = new CopyDBClusterSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Copies the specified DB parameter group.

- */ - public copyDBParameterGroup( + + /** + * @see {@link CopyDBParameterGroupCommand} + */ + copyDBParameterGroup( args: CopyDBParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public copyDBParameterGroup( + copyDBParameterGroup( args: CopyDBParameterGroupCommandInput, cb: (err: any, data?: CopyDBParameterGroupCommandOutput) => void ): void; - public copyDBParameterGroup( + copyDBParameterGroup( args: CopyDBParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyDBParameterGroupCommandOutput) => void ): void; - public copyDBParameterGroup( - args: CopyDBParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopyDBParameterGroupCommandOutput) => void), - cb?: (err: any, data?: CopyDBParameterGroupCommandOutput) => void - ): Promise | void { - const command = new CopyDBParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new Amazon Neptune DB cluster.

- *

You can use the ReplicationSourceIdentifier parameter to create the DB - * cluster as a Read Replica of another DB cluster or Amazon Neptune DB instance.

- *

Note that when you create a new cluster using CreateDBCluster directly, - * deletion protection is disabled by default (when you create a new production cluster in - * the console, deletion protection is enabled by default). You can only delete a DB - * cluster if its DeletionProtection field is set to false.

- */ - public createDBCluster( + + /** + * @see {@link CreateDBClusterCommand} + */ + createDBCluster( args: CreateDBClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDBCluster( - args: CreateDBClusterCommandInput, - cb: (err: any, data?: CreateDBClusterCommandOutput) => void - ): void; - public createDBCluster( + createDBCluster(args: CreateDBClusterCommandInput, cb: (err: any, data?: CreateDBClusterCommandOutput) => void): void; + createDBCluster( args: CreateDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBClusterCommandOutput) => void ): void; - public createDBCluster( - args: CreateDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBClusterCommandOutput) => void), - cb?: (err: any, data?: CreateDBClusterCommandOutput) => void - ): Promise | void { - const command = new CreateDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.

- */ - public createDBClusterEndpoint( + + /** + * @see {@link CreateDBClusterEndpointCommand} + */ + createDBClusterEndpoint( args: CreateDBClusterEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDBClusterEndpoint( + createDBClusterEndpoint( args: CreateDBClusterEndpointCommandInput, cb: (err: any, data?: CreateDBClusterEndpointCommandOutput) => void ): void; - public createDBClusterEndpoint( + createDBClusterEndpoint( args: CreateDBClusterEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBClusterEndpointCommandOutput) => void ): void; - public createDBClusterEndpoint( - args: CreateDBClusterEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBClusterEndpointCommandOutput) => void), - cb?: (err: any, data?: CreateDBClusterEndpointCommandOutput) => void - ): Promise | void { - const command = new CreateDBClusterEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new DB cluster parameter group.

- *

Parameters in a DB cluster parameter group apply to all of the instances in a DB - * cluster.

- *

A DB cluster parameter group is initially created with the default - * parameters for the database engine used by instances in the DB cluster. - * To provide custom values for any of the parameters, you must modify the - * group after creating it using ModifyDBClusterParameterGroup. - * Once you've created a DB cluster parameter group, you need to associate it - * with your DB cluster using ModifyDBCluster. - * When you associate a new DB cluster parameter group with a running DB cluster, - * you need to reboot the DB instances in the DB cluster without failover for the - * new DB cluster parameter group and associated settings to take effect.

- * - *

After you create a DB cluster parameter group, you should wait at least - * 5 minutes before creating your first DB cluster that uses that DB cluster - * parameter group as the default parameter group. This allows Amazon Neptune - * to fully complete the create action before the DB cluster parameter group - * is used as the default for a new DB cluster. This is especially important for - * parameters that are critical when creating the default database for a DB - * cluster, such as the character set for the default database defined by the - * character_set_database parameter. You can use the Parameter - * Groups option of the Amazon Neptune - * console or the DescribeDBClusterParameters - * command to verify that your DB cluster parameter group has been created or modified.

- *
- */ - public createDBClusterParameterGroup( + + /** + * @see {@link CreateDBClusterParameterGroupCommand} + */ + createDBClusterParameterGroup( args: CreateDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDBClusterParameterGroup( + createDBClusterParameterGroup( args: CreateDBClusterParameterGroupCommandInput, cb: (err: any, data?: CreateDBClusterParameterGroupCommandOutput) => void ): void; - public createDBClusterParameterGroup( + createDBClusterParameterGroup( args: CreateDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBClusterParameterGroupCommandOutput) => void ): void; - public createDBClusterParameterGroup( - args: CreateDBClusterParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBClusterParameterGroupCommandOutput) => void), - cb?: (err: any, data?: CreateDBClusterParameterGroupCommandOutput) => void - ): Promise | void { - const command = new CreateDBClusterParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a snapshot of a DB cluster.

- */ - public createDBClusterSnapshot( + + /** + * @see {@link CreateDBClusterSnapshotCommand} + */ + createDBClusterSnapshot( args: CreateDBClusterSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDBClusterSnapshot( + createDBClusterSnapshot( args: CreateDBClusterSnapshotCommandInput, cb: (err: any, data?: CreateDBClusterSnapshotCommandOutput) => void ): void; - public createDBClusterSnapshot( + createDBClusterSnapshot( args: CreateDBClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBClusterSnapshotCommandOutput) => void ): void; - public createDBClusterSnapshot( - args: CreateDBClusterSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBClusterSnapshotCommandOutput) => void), - cb?: (err: any, data?: CreateDBClusterSnapshotCommandOutput) => void - ): Promise | void { - const command = new CreateDBClusterSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new DB instance.

- */ - public createDBInstance( + + /** + * @see {@link CreateDBInstanceCommand} + */ + createDBInstance( args: CreateDBInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDBInstance( + createDBInstance( args: CreateDBInstanceCommandInput, cb: (err: any, data?: CreateDBInstanceCommandOutput) => void ): void; - public createDBInstance( + createDBInstance( args: CreateDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBInstanceCommandOutput) => void ): void; - public createDBInstance( - args: CreateDBInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBInstanceCommandOutput) => void), - cb?: (err: any, data?: CreateDBInstanceCommandOutput) => void - ): Promise | void { - const command = new CreateDBInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new DB parameter group.

- *

A DB parameter group is initially created with the default parameters for the database - * engine used by the DB instance. To provide custom values for any of the parameters, you must - * modify the group after creating it using ModifyDBParameterGroup. Once - * you've created a DB parameter group, you need to associate it with your DB instance using - * ModifyDBInstance. When you associate a new DB parameter group with a - * running DB instance, you need to reboot the DB instance without failover for the new DB - * parameter group and associated settings to take effect.

- * - *

After you create a DB parameter group, you should wait at least 5 minutes before - * creating your first DB instance that uses that DB parameter group as the default parameter - * group. This allows Amazon Neptune to fully complete the create action before the parameter - * group is used as the default for a new DB instance. This is especially important for - * parameters that are critical when creating the default database for a DB instance, such as - * the character set for the default database defined by the - * character_set_database parameter. You can use the Parameter - * Groups option of the Amazon Neptune console or the - * DescribeDBParameters command to verify that your DB parameter group has - * been created or modified.

- *
- */ - public createDBParameterGroup( + + /** + * @see {@link CreateDBParameterGroupCommand} + */ + createDBParameterGroup( args: CreateDBParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDBParameterGroup( + createDBParameterGroup( args: CreateDBParameterGroupCommandInput, cb: (err: any, data?: CreateDBParameterGroupCommandOutput) => void ): void; - public createDBParameterGroup( + createDBParameterGroup( args: CreateDBParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBParameterGroupCommandOutput) => void ): void; - public createDBParameterGroup( - args: CreateDBParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBParameterGroupCommandOutput) => void), - cb?: (err: any, data?: CreateDBParameterGroupCommandOutput) => void - ): Promise | void { - const command = new CreateDBParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at - * least two AZs in the Amazon Region.

- */ - public createDBSubnetGroup( + + /** + * @see {@link CreateDBSubnetGroupCommand} + */ + createDBSubnetGroup( args: CreateDBSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDBSubnetGroup( + createDBSubnetGroup( args: CreateDBSubnetGroupCommandInput, cb: (err: any, data?: CreateDBSubnetGroupCommandOutput) => void ): void; - public createDBSubnetGroup( + createDBSubnetGroup( args: CreateDBSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBSubnetGroupCommandOutput) => void ): void; - public createDBSubnetGroup( - args: CreateDBSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: CreateDBSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new CreateDBSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an event notification subscription. This action requires a topic ARN (Amazon - * Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To - * obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The - * ARN is displayed in the SNS console.

- *

You can specify the type of source (SourceType) you want to be notified of, provide a list - * of Neptune sources (SourceIds) that triggers the events, and provide a list of event - * categories (EventCategories) for events you want to be notified of. For example, you can - * specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories - * = Availability, Backup.

- *

If you specify both the SourceType and SourceIds, such as SourceType = db-instance and - * SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the - * specified source. If you specify a SourceType but do not specify a SourceIdentifier, you - * receive notice of the events for that source type for all your Neptune sources. If you do not - * specify either the SourceType nor the SourceIdentifier, you are notified of events generated - * from all Neptune sources belonging to your customer account.

- */ - public createEventSubscription( + + /** + * @see {@link CreateEventSubscriptionCommand} + */ + createEventSubscription( args: CreateEventSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEventSubscription( + createEventSubscription( args: CreateEventSubscriptionCommandInput, cb: (err: any, data?: CreateEventSubscriptionCommandOutput) => void ): void; - public createEventSubscription( + createEventSubscription( args: CreateEventSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEventSubscriptionCommandOutput) => void ): void; - public createEventSubscription( - args: CreateEventSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEventSubscriptionCommandOutput) => void), - cb?: (err: any, data?: CreateEventSubscriptionCommandOutput) => void - ): Promise | void { - const command = new CreateEventSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Neptune global database spread across multiple Amazon Regions. - * The global database contains a single primary cluster with read-write - * capability, and read-only secondary clusters that receive data from the - * primary cluster through high-speed replication performed by the Neptune - * storage subsystem.

- *

You can create a global database that is initially empty, and then - * add a primary cluster and secondary clusters to it, or you can specify - * an existing Neptune cluster during the create operation to become the - * primary cluster of the global database.

- */ - public createGlobalCluster( + + /** + * @see {@link CreateGlobalClusterCommand} + */ + createGlobalCluster( args: CreateGlobalClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public createGlobalCluster( + createGlobalCluster( args: CreateGlobalClusterCommandInput, cb: (err: any, data?: CreateGlobalClusterCommandOutput) => void ): void; - public createGlobalCluster( + createGlobalCluster( args: CreateGlobalClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGlobalClusterCommandOutput) => void ): void; - public createGlobalCluster( - args: CreateGlobalClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGlobalClusterCommandOutput) => void), - cb?: (err: any, data?: CreateGlobalClusterCommandOutput) => void - ): Promise | void { - const command = new CreateGlobalClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a - * DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. - * Manual DB cluster snapshots of the specified DB cluster are not deleted.

- *

Note that the DB Cluster cannot be deleted if deletion protection is enabled. To - * delete it, you must first set its DeletionProtection field to - * False.

- */ - public deleteDBCluster( + + /** + * @see {@link DeleteDBClusterCommand} + */ + deleteDBCluster( args: DeleteDBClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDBCluster( - args: DeleteDBClusterCommandInput, - cb: (err: any, data?: DeleteDBClusterCommandOutput) => void - ): void; - public deleteDBCluster( + deleteDBCluster(args: DeleteDBClusterCommandInput, cb: (err: any, data?: DeleteDBClusterCommandOutput) => void): void; + deleteDBCluster( args: DeleteDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBClusterCommandOutput) => void ): void; - public deleteDBCluster( - args: DeleteDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBClusterCommandOutput) => void), - cb?: (err: any, data?: DeleteDBClusterCommandOutput) => void - ): Promise | void { - const command = new DeleteDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.

- */ - public deleteDBClusterEndpoint( + + /** + * @see {@link DeleteDBClusterEndpointCommand} + */ + deleteDBClusterEndpoint( args: DeleteDBClusterEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDBClusterEndpoint( + deleteDBClusterEndpoint( args: DeleteDBClusterEndpointCommandInput, cb: (err: any, data?: DeleteDBClusterEndpointCommandOutput) => void ): void; - public deleteDBClusterEndpoint( + deleteDBClusterEndpoint( args: DeleteDBClusterEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBClusterEndpointCommandOutput) => void ): void; - public deleteDBClusterEndpoint( - args: DeleteDBClusterEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBClusterEndpointCommandOutput) => void), - cb?: (err: any, data?: DeleteDBClusterEndpointCommandOutput) => void - ): Promise | void { - const command = new DeleteDBClusterEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be - * deleted can't be associated with any DB clusters.

- */ - public deleteDBClusterParameterGroup( + + /** + * @see {@link DeleteDBClusterParameterGroupCommand} + */ + deleteDBClusterParameterGroup( args: DeleteDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDBClusterParameterGroup( + deleteDBClusterParameterGroup( args: DeleteDBClusterParameterGroupCommandInput, cb: (err: any, data?: DeleteDBClusterParameterGroupCommandOutput) => void ): void; - public deleteDBClusterParameterGroup( + deleteDBClusterParameterGroup( args: DeleteDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBClusterParameterGroupCommandOutput) => void ): void; - public deleteDBClusterParameterGroup( - args: DeleteDBClusterParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBClusterParameterGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteDBClusterParameterGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteDBClusterParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is - * terminated.

- * - *

The DB cluster snapshot must be in the available state to be - * deleted.

- *
- */ - public deleteDBClusterSnapshot( + + /** + * @see {@link DeleteDBClusterSnapshotCommand} + */ + deleteDBClusterSnapshot( args: DeleteDBClusterSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDBClusterSnapshot( + deleteDBClusterSnapshot( args: DeleteDBClusterSnapshotCommandInput, cb: (err: any, data?: DeleteDBClusterSnapshotCommandOutput) => void ): void; - public deleteDBClusterSnapshot( + deleteDBClusterSnapshot( args: DeleteDBClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBClusterSnapshotCommandOutput) => void ): void; - public deleteDBClusterSnapshot( - args: DeleteDBClusterSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBClusterSnapshotCommandOutput) => void), - cb?: (err: any, data?: DeleteDBClusterSnapshotCommandOutput) => void - ): Promise | void { - const command = new DeleteDBClusterSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete - * a DB instance, all automated backups for that instance are deleted and can't be recovered. - * Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not - * deleted.

- *

If you request a final DB snapshot the status of the Amazon Neptune DB instance is - * deleting until the DB snapshot is created. The API action - * DescribeDBInstance is used to monitor the status of this operation. The action - * can't be canceled or reverted once submitted.

- *

Note that when a DB instance is in a failure state and has a status of - * failed, incompatible-restore, or incompatible-network, - * you can only delete it when the SkipFinalSnapshot parameter is set to - * true.

- *

You can't delete a DB instance if it is the only instance in the DB cluster, or - * if it has deletion protection enabled.

- */ - public deleteDBInstance( + + /** + * @see {@link DeleteDBInstanceCommand} + */ + deleteDBInstance( args: DeleteDBInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDBInstance( + deleteDBInstance( args: DeleteDBInstanceCommandInput, cb: (err: any, data?: DeleteDBInstanceCommandOutput) => void ): void; - public deleteDBInstance( + deleteDBInstance( args: DeleteDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBInstanceCommandOutput) => void ): void; - public deleteDBInstance( - args: DeleteDBInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBInstanceCommandOutput) => void), - cb?: (err: any, data?: DeleteDBInstanceCommandOutput) => void - ): Promise | void { - const command = new DeleteDBInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be - * associated with any DB instances.

- */ - public deleteDBParameterGroup( + + /** + * @see {@link DeleteDBParameterGroupCommand} + */ + deleteDBParameterGroup( args: DeleteDBParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDBParameterGroup( + deleteDBParameterGroup( args: DeleteDBParameterGroupCommandInput, cb: (err: any, data?: DeleteDBParameterGroupCommandOutput) => void ): void; - public deleteDBParameterGroup( + deleteDBParameterGroup( args: DeleteDBParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBParameterGroupCommandOutput) => void ): void; - public deleteDBParameterGroup( - args: DeleteDBParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBParameterGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteDBParameterGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteDBParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a DB subnet group.

- * - *

The specified database subnet group must not be associated with any DB instances.

- *
- */ - public deleteDBSubnetGroup( + + /** + * @see {@link DeleteDBSubnetGroupCommand} + */ + deleteDBSubnetGroup( args: DeleteDBSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDBSubnetGroup( + deleteDBSubnetGroup( args: DeleteDBSubnetGroupCommandInput, cb: (err: any, data?: DeleteDBSubnetGroupCommandOutput) => void ): void; - public deleteDBSubnetGroup( + deleteDBSubnetGroup( args: DeleteDBSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBSubnetGroupCommandOutput) => void ): void; - public deleteDBSubnetGroup( - args: DeleteDBSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteDBSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteDBSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an event notification subscription.

- */ - public deleteEventSubscription( + + /** + * @see {@link DeleteEventSubscriptionCommand} + */ + deleteEventSubscription( args: DeleteEventSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEventSubscription( + deleteEventSubscription( args: DeleteEventSubscriptionCommandInput, cb: (err: any, data?: DeleteEventSubscriptionCommandOutput) => void ): void; - public deleteEventSubscription( + deleteEventSubscription( args: DeleteEventSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventSubscriptionCommandOutput) => void ): void; - public deleteEventSubscription( - args: DeleteEventSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEventSubscriptionCommandOutput) => void), - cb?: (err: any, data?: DeleteEventSubscriptionCommandOutput) => void - ): Promise | void { - const command = new DeleteEventSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a global database. The primary and all secondary clusters must - * already be detached or deleted first.

- */ - public deleteGlobalCluster( + + /** + * @see {@link DeleteGlobalClusterCommand} + */ + deleteGlobalCluster( args: DeleteGlobalClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteGlobalCluster( + deleteGlobalCluster( args: DeleteGlobalClusterCommandInput, cb: (err: any, data?: DeleteGlobalClusterCommandOutput) => void ): void; - public deleteGlobalCluster( + deleteGlobalCluster( args: DeleteGlobalClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGlobalClusterCommandOutput) => void ): void; - public deleteGlobalCluster( - args: DeleteGlobalClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGlobalClusterCommandOutput) => void), - cb?: (err: any, data?: DeleteGlobalClusterCommandOutput) => void - ): Promise | void { - const command = new DeleteGlobalClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about endpoints for an Amazon Neptune DB cluster.

- * - *

This operation can also return information for Amazon RDS clusters - * and Amazon DocDB clusters.

- *
- */ - public describeDBClusterEndpoints( + + /** + * @see {@link DescribeDBClusterEndpointsCommand} + */ + describeDBClusterEndpoints( args: DescribeDBClusterEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBClusterEndpoints( + describeDBClusterEndpoints( args: DescribeDBClusterEndpointsCommandInput, cb: (err: any, data?: DescribeDBClusterEndpointsCommandOutput) => void ): void; - public describeDBClusterEndpoints( + describeDBClusterEndpoints( args: DescribeDBClusterEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterEndpointsCommandOutput) => void ): void; - public describeDBClusterEndpoints( - args: DescribeDBClusterEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBClusterEndpointsCommandOutput) => void), - cb?: (err: any, data?: DescribeDBClusterEndpointsCommandOutput) => void - ): Promise | void { - const command = new DescribeDBClusterEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of DBClusterParameterGroup descriptions. If a - * DBClusterParameterGroupName parameter is specified, the list will contain only - * the description of the specified DB cluster parameter group.

- */ - public describeDBClusterParameterGroups( + + /** + * @see {@link DescribeDBClusterParameterGroupsCommand} + */ + describeDBClusterParameterGroups( args: DescribeDBClusterParameterGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBClusterParameterGroups( + describeDBClusterParameterGroups( args: DescribeDBClusterParameterGroupsCommandInput, cb: (err: any, data?: DescribeDBClusterParameterGroupsCommandOutput) => void ): void; - public describeDBClusterParameterGroups( + describeDBClusterParameterGroups( args: DescribeDBClusterParameterGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterParameterGroupsCommandOutput) => void ): void; - public describeDBClusterParameterGroups( - args: DescribeDBClusterParameterGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBClusterParameterGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeDBClusterParameterGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeDBClusterParameterGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the detailed parameter list for a particular DB cluster parameter group.

- */ - public describeDBClusterParameters( + + /** + * @see {@link DescribeDBClusterParametersCommand} + */ + describeDBClusterParameters( args: DescribeDBClusterParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBClusterParameters( + describeDBClusterParameters( args: DescribeDBClusterParametersCommandInput, cb: (err: any, data?: DescribeDBClusterParametersCommandOutput) => void ): void; - public describeDBClusterParameters( + describeDBClusterParameters( args: DescribeDBClusterParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterParametersCommandOutput) => void ): void; - public describeDBClusterParameters( - args: DescribeDBClusterParametersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBClusterParametersCommandOutput) => void), - cb?: (err: any, data?: DescribeDBClusterParametersCommandOutput) => void - ): Promise | void { - const command = new DescribeDBClusterParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about provisioned DB clusters, and supports - * pagination.

- * - *

This operation can also return information for Amazon RDS clusters - * and Amazon DocDB clusters.

- *
- */ - public describeDBClusters( + + /** + * @see {@link DescribeDBClustersCommand} + */ + describeDBClusters( args: DescribeDBClustersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBClusters( + describeDBClusters( args: DescribeDBClustersCommandInput, cb: (err: any, data?: DescribeDBClustersCommandOutput) => void ): void; - public describeDBClusters( + describeDBClusters( args: DescribeDBClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClustersCommandOutput) => void ): void; - public describeDBClusters( - args: DescribeDBClustersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBClustersCommandOutput) => void), - cb?: (err: any, data?: DescribeDBClustersCommandOutput) => void - ): Promise | void { - const command = new DescribeDBClustersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster - * snapshot.

- *

When sharing snapshots with other Amazon accounts, - * DescribeDBClusterSnapshotAttributes returns the restore attribute - * and a list of IDs for the Amazon accounts that are authorized to copy or restore the manual DB - * cluster snapshot. If all is included in the list of values for the - * restore attribute, then the manual DB cluster snapshot is public and can be - * copied or restored by all Amazon accounts.

- *

To add or remove access for an Amazon account to copy or restore a manual DB cluster - * snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

- */ - public describeDBClusterSnapshotAttributes( + + /** + * @see {@link DescribeDBClusterSnapshotAttributesCommand} + */ + describeDBClusterSnapshotAttributes( args: DescribeDBClusterSnapshotAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBClusterSnapshotAttributes( + describeDBClusterSnapshotAttributes( args: DescribeDBClusterSnapshotAttributesCommandInput, cb: (err: any, data?: DescribeDBClusterSnapshotAttributesCommandOutput) => void ): void; - public describeDBClusterSnapshotAttributes( + describeDBClusterSnapshotAttributes( args: DescribeDBClusterSnapshotAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterSnapshotAttributesCommandOutput) => void ): void; - public describeDBClusterSnapshotAttributes( - args: DescribeDBClusterSnapshotAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBClusterSnapshotAttributesCommandOutput) => void), - cb?: (err: any, data?: DescribeDBClusterSnapshotAttributesCommandOutput) => void - ): Promise | void { - const command = new DescribeDBClusterSnapshotAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about DB cluster snapshots. This API action supports - * pagination.

- */ - public describeDBClusterSnapshots( + + /** + * @see {@link DescribeDBClusterSnapshotsCommand} + */ + describeDBClusterSnapshots( args: DescribeDBClusterSnapshotsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBClusterSnapshots( + describeDBClusterSnapshots( args: DescribeDBClusterSnapshotsCommandInput, cb: (err: any, data?: DescribeDBClusterSnapshotsCommandOutput) => void ): void; - public describeDBClusterSnapshots( + describeDBClusterSnapshots( args: DescribeDBClusterSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterSnapshotsCommandOutput) => void ): void; - public describeDBClusterSnapshots( - args: DescribeDBClusterSnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBClusterSnapshotsCommandOutput) => void), - cb?: (err: any, data?: DescribeDBClusterSnapshotsCommandOutput) => void - ): Promise | void { - const command = new DescribeDBClusterSnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of the available DB engines.

- */ - public describeDBEngineVersions( + + /** + * @see {@link DescribeDBEngineVersionsCommand} + */ + describeDBEngineVersions( args: DescribeDBEngineVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBEngineVersions( + describeDBEngineVersions( args: DescribeDBEngineVersionsCommandInput, cb: (err: any, data?: DescribeDBEngineVersionsCommandOutput) => void ): void; - public describeDBEngineVersions( + describeDBEngineVersions( args: DescribeDBEngineVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBEngineVersionsCommandOutput) => void ): void; - public describeDBEngineVersions( - args: DescribeDBEngineVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBEngineVersionsCommandOutput) => void), - cb?: (err: any, data?: DescribeDBEngineVersionsCommandOutput) => void - ): Promise | void { - const command = new DescribeDBEngineVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about provisioned instances, and supports pagination.

- * - *

This operation can also return information for Amazon RDS instances - * and Amazon DocDB instances.

- *
- */ - public describeDBInstances( + + /** + * @see {@link DescribeDBInstancesCommand} + */ + describeDBInstances( args: DescribeDBInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBInstances( + describeDBInstances( args: DescribeDBInstancesCommandInput, cb: (err: any, data?: DescribeDBInstancesCommandOutput) => void ): void; - public describeDBInstances( + describeDBInstances( args: DescribeDBInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBInstancesCommandOutput) => void ): void; - public describeDBInstances( - args: DescribeDBInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBInstancesCommandOutput) => void), - cb?: (err: any, data?: DescribeDBInstancesCommandOutput) => void - ): Promise | void { - const command = new DescribeDBInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of DBParameterGroup descriptions. If a - * DBParameterGroupName is specified, the list will contain only the description of - * the specified DB parameter group.

- */ - public describeDBParameterGroups( + + /** + * @see {@link DescribeDBParameterGroupsCommand} + */ + describeDBParameterGroups( args: DescribeDBParameterGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBParameterGroups( + describeDBParameterGroups( args: DescribeDBParameterGroupsCommandInput, cb: (err: any, data?: DescribeDBParameterGroupsCommandOutput) => void ): void; - public describeDBParameterGroups( + describeDBParameterGroups( args: DescribeDBParameterGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBParameterGroupsCommandOutput) => void ): void; - public describeDBParameterGroups( - args: DescribeDBParameterGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBParameterGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeDBParameterGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeDBParameterGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the detailed parameter list for a particular DB parameter group.

- */ - public describeDBParameters( + + /** + * @see {@link DescribeDBParametersCommand} + */ + describeDBParameters( args: DescribeDBParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBParameters( + describeDBParameters( args: DescribeDBParametersCommandInput, cb: (err: any, data?: DescribeDBParametersCommandOutput) => void ): void; - public describeDBParameters( + describeDBParameters( args: DescribeDBParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBParametersCommandOutput) => void ): void; - public describeDBParameters( - args: DescribeDBParametersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBParametersCommandOutput) => void), - cb?: (err: any, data?: DescribeDBParametersCommandOutput) => void - ): Promise | void { - const command = new DescribeDBParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the - * list will contain only the descriptions of the specified DBSubnetGroup.

- *

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

- */ - public describeDBSubnetGroups( + + /** + * @see {@link DescribeDBSubnetGroupsCommand} + */ + describeDBSubnetGroups( args: DescribeDBSubnetGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBSubnetGroups( + describeDBSubnetGroups( args: DescribeDBSubnetGroupsCommandInput, cb: (err: any, data?: DescribeDBSubnetGroupsCommandOutput) => void ): void; - public describeDBSubnetGroups( + describeDBSubnetGroups( args: DescribeDBSubnetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBSubnetGroupsCommandOutput) => void ): void; - public describeDBSubnetGroups( - args: DescribeDBSubnetGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBSubnetGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeDBSubnetGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeDBSubnetGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the default engine and system parameter information for the cluster database - * engine.

- */ - public describeEngineDefaultClusterParameters( + + /** + * @see {@link DescribeEngineDefaultClusterParametersCommand} + */ + describeEngineDefaultClusterParameters( args: DescribeEngineDefaultClusterParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEngineDefaultClusterParameters( + describeEngineDefaultClusterParameters( args: DescribeEngineDefaultClusterParametersCommandInput, cb: (err: any, data?: DescribeEngineDefaultClusterParametersCommandOutput) => void ): void; - public describeEngineDefaultClusterParameters( + describeEngineDefaultClusterParameters( args: DescribeEngineDefaultClusterParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEngineDefaultClusterParametersCommandOutput) => void ): void; - public describeEngineDefaultClusterParameters( - args: DescribeEngineDefaultClusterParametersCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeEngineDefaultClusterParametersCommandOutput) => void), - cb?: (err: any, data?: DescribeEngineDefaultClusterParametersCommandOutput) => void - ): Promise | void { - const command = new DescribeEngineDefaultClusterParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the default engine and system parameter information for the specified database - * engine.

- */ - public describeEngineDefaultParameters( + + /** + * @see {@link DescribeEngineDefaultParametersCommand} + */ + describeEngineDefaultParameters( args: DescribeEngineDefaultParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEngineDefaultParameters( + describeEngineDefaultParameters( args: DescribeEngineDefaultParametersCommandInput, cb: (err: any, data?: DescribeEngineDefaultParametersCommandOutput) => void ): void; - public describeEngineDefaultParameters( + describeEngineDefaultParameters( args: DescribeEngineDefaultParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEngineDefaultParametersCommandOutput) => void ): void; - public describeEngineDefaultParameters( - args: DescribeEngineDefaultParametersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEngineDefaultParametersCommandOutput) => void), - cb?: (err: any, data?: DescribeEngineDefaultParametersCommandOutput) => void - ): Promise | void { - const command = new DescribeEngineDefaultParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Displays a list of categories for all event source types, or, if specified, for a - * specified source type.

- */ - public describeEventCategories( + + /** + * @see {@link DescribeEventCategoriesCommand} + */ + describeEventCategories( args: DescribeEventCategoriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventCategories( + describeEventCategories( args: DescribeEventCategoriesCommandInput, cb: (err: any, data?: DescribeEventCategoriesCommandOutput) => void ): void; - public describeEventCategories( + describeEventCategories( args: DescribeEventCategoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventCategoriesCommandOutput) => void ): void; - public describeEventCategories( - args: DescribeEventCategoriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventCategoriesCommandOutput) => void), - cb?: (err: any, data?: DescribeEventCategoriesCommandOutput) => void - ): Promise | void { - const command = new DescribeEventCategoriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter - * groups for the past 14 days. Events specific to a particular DB instance, DB security group, - * database snapshot, or DB parameter group can be obtained by providing the name as a parameter. - * By default, the past hour of events are returned.

- */ - public describeEvents( + + /** + * @see {@link DescribeEventsCommand} + */ + describeEvents( args: DescribeEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEvents( - args: DescribeEventsCommandInput, - cb: (err: any, data?: DescribeEventsCommandOutput) => void - ): void; - public describeEvents( + describeEvents(args: DescribeEventsCommandInput, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void; + describeEvents( args: DescribeEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsCommandOutput) => void ): void; - public describeEvents( - args: DescribeEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventsCommandOutput) => void), - cb?: (err: any, data?: DescribeEventsCommandOutput) => void - ): Promise | void { - const command = new DescribeEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all the subscription descriptions for a customer account. The description for a - * subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, - * CreationTime, and Status.

- *

If you specify a SubscriptionName, lists the description for that subscription.

- */ - public describeEventSubscriptions( + + /** + * @see {@link DescribeEventSubscriptionsCommand} + */ + describeEventSubscriptions( args: DescribeEventSubscriptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventSubscriptions( + describeEventSubscriptions( args: DescribeEventSubscriptionsCommandInput, cb: (err: any, data?: DescribeEventSubscriptionsCommandOutput) => void ): void; - public describeEventSubscriptions( + describeEventSubscriptions( args: DescribeEventSubscriptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventSubscriptionsCommandOutput) => void ): void; - public describeEventSubscriptions( - args: DescribeEventSubscriptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventSubscriptionsCommandOutput) => void), - cb?: (err: any, data?: DescribeEventSubscriptionsCommandOutput) => void - ): Promise | void { - const command = new DescribeEventSubscriptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about Neptune global database clusters. This API - * supports pagination.

- */ - public describeGlobalClusters( + + /** + * @see {@link DescribeGlobalClustersCommand} + */ + describeGlobalClusters( args: DescribeGlobalClustersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGlobalClusters( + describeGlobalClusters( args: DescribeGlobalClustersCommandInput, cb: (err: any, data?: DescribeGlobalClustersCommandOutput) => void ): void; - public describeGlobalClusters( + describeGlobalClusters( args: DescribeGlobalClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGlobalClustersCommandOutput) => void ): void; - public describeGlobalClusters( - args: DescribeGlobalClustersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGlobalClustersCommandOutput) => void), - cb?: (err: any, data?: DescribeGlobalClustersCommandOutput) => void - ): Promise | void { - const command = new DescribeGlobalClustersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of orderable DB instance options for the specified engine.

- */ - public describeOrderableDBInstanceOptions( + + /** + * @see {@link DescribeOrderableDBInstanceOptionsCommand} + */ + describeOrderableDBInstanceOptions( args: DescribeOrderableDBInstanceOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOrderableDBInstanceOptions( + describeOrderableDBInstanceOptions( args: DescribeOrderableDBInstanceOptionsCommandInput, cb: (err: any, data?: DescribeOrderableDBInstanceOptionsCommandOutput) => void ): void; - public describeOrderableDBInstanceOptions( + describeOrderableDBInstanceOptions( args: DescribeOrderableDBInstanceOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrderableDBInstanceOptionsCommandOutput) => void ): void; - public describeOrderableDBInstanceOptions( - args: DescribeOrderableDBInstanceOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOrderableDBInstanceOptionsCommandOutput) => void), - cb?: (err: any, data?: DescribeOrderableDBInstanceOptionsCommandOutput) => void - ): Promise | void { - const command = new DescribeOrderableDBInstanceOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of resources (for example, DB instances) that have at least one pending - * maintenance action.

- */ - public describePendingMaintenanceActions( + + /** + * @see {@link DescribePendingMaintenanceActionsCommand} + */ + describePendingMaintenanceActions( args: DescribePendingMaintenanceActionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePendingMaintenanceActions( + describePendingMaintenanceActions( args: DescribePendingMaintenanceActionsCommandInput, cb: (err: any, data?: DescribePendingMaintenanceActionsCommandOutput) => void ): void; - public describePendingMaintenanceActions( + describePendingMaintenanceActions( args: DescribePendingMaintenanceActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePendingMaintenanceActionsCommandOutput) => void ): void; - public describePendingMaintenanceActions( - args: DescribePendingMaintenanceActionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePendingMaintenanceActionsCommandOutput) => void), - cb?: (err: any, data?: DescribePendingMaintenanceActionsCommandOutput) => void - ): Promise | void { - const command = new DescribePendingMaintenanceActionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

You can call DescribeValidDBInstanceModifications - * to learn what modifications you can make to your DB instance. You can use this - * information when you call ModifyDBInstance.

- */ - public describeValidDBInstanceModifications( + + /** + * @see {@link DescribeValidDBInstanceModificationsCommand} + */ + describeValidDBInstanceModifications( args: DescribeValidDBInstanceModificationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeValidDBInstanceModifications( + describeValidDBInstanceModifications( args: DescribeValidDBInstanceModificationsCommandInput, cb: (err: any, data?: DescribeValidDBInstanceModificationsCommandOutput) => void ): void; - public describeValidDBInstanceModifications( + describeValidDBInstanceModifications( args: DescribeValidDBInstanceModificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeValidDBInstanceModificationsCommandOutput) => void ): void; - public describeValidDBInstanceModifications( - args: DescribeValidDBInstanceModificationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeValidDBInstanceModificationsCommandOutput) => void), - cb?: (err: any, data?: DescribeValidDBInstanceModificationsCommandOutput) => void - ): Promise | void { - const command = new DescribeValidDBInstanceModificationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Forces a failover for a DB cluster.

- *

A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the - * DB cluster to be the primary instance (the cluster writer).

- *

Amazon Neptune will automatically fail over to a Read Replica, if one exists, when the - * primary instance fails. You can force a failover when you want to simulate a failure of a - * primary instance for testing. Because each instance in a DB cluster has its own endpoint - * address, you will need to clean up and re-establish any existing connections that use those - * endpoint addresses when the failover is complete.

- */ - public failoverDBCluster( + + /** + * @see {@link FailoverDBClusterCommand} + */ + failoverDBCluster( args: FailoverDBClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public failoverDBCluster( + failoverDBCluster( args: FailoverDBClusterCommandInput, cb: (err: any, data?: FailoverDBClusterCommandOutput) => void ): void; - public failoverDBCluster( + failoverDBCluster( args: FailoverDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FailoverDBClusterCommandOutput) => void ): void; - public failoverDBCluster( - args: FailoverDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FailoverDBClusterCommandOutput) => void), - cb?: (err: any, data?: FailoverDBClusterCommandOutput) => void - ): Promise | void { - const command = new FailoverDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Initiates the failover process for a Neptune global database.

- *

A failover for a Neptune global database promotes one of secondary - * read-only DB clusters to be the primary DB cluster and demotes the - * primary DB cluster to being a secondary (read-only) DB cluster. In other - * words, the role of the current primary DB cluster and the selected - * target secondary DB cluster are switched. The selected secondary DB cluster - * assumes full read/write capabilities for the Neptune global database.

- * - *

This action applies only to - * Neptune global databases. This action is only intended for use on healthy - * Neptune global databases with healthy Neptune DB clusters and no region-wide - * outages, to test disaster recovery scenarios or to reconfigure the global - * database topology.

- *
- */ - public failoverGlobalCluster( + + /** + * @see {@link FailoverGlobalClusterCommand} + */ + failoverGlobalCluster( args: FailoverGlobalClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public failoverGlobalCluster( + failoverGlobalCluster( args: FailoverGlobalClusterCommandInput, cb: (err: any, data?: FailoverGlobalClusterCommandOutput) => void ): void; - public failoverGlobalCluster( + failoverGlobalCluster( args: FailoverGlobalClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FailoverGlobalClusterCommandOutput) => void ): void; - public failoverGlobalCluster( - args: FailoverGlobalClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FailoverGlobalClusterCommandOutput) => void), - cb?: (err: any, data?: FailoverGlobalClusterCommandOutput) => void - ): Promise | void { - const command = new FailoverGlobalClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all tags on an Amazon Neptune resource.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modify a setting for a DB cluster. You can change one or more database configuration - * parameters by specifying these parameters and the new values in the request.

- */ - public modifyDBCluster( + + /** + * @see {@link ModifyDBClusterCommand} + */ + modifyDBCluster( args: ModifyDBClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDBCluster( - args: ModifyDBClusterCommandInput, - cb: (err: any, data?: ModifyDBClusterCommandOutput) => void - ): void; - public modifyDBCluster( + modifyDBCluster(args: ModifyDBClusterCommandInput, cb: (err: any, data?: ModifyDBClusterCommandOutput) => void): void; + modifyDBCluster( args: ModifyDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBClusterCommandOutput) => void ): void; - public modifyDBCluster( - args: ModifyDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBClusterCommandOutput) => void), - cb?: (err: any, data?: ModifyDBClusterCommandOutput) => void - ): Promise | void { - const command = new ModifyDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the properties of an endpoint in an Amazon Neptune DB cluster.

- */ - public modifyDBClusterEndpoint( + + /** + * @see {@link ModifyDBClusterEndpointCommand} + */ + modifyDBClusterEndpoint( args: ModifyDBClusterEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDBClusterEndpoint( + modifyDBClusterEndpoint( args: ModifyDBClusterEndpointCommandInput, cb: (err: any, data?: ModifyDBClusterEndpointCommandOutput) => void ): void; - public modifyDBClusterEndpoint( + modifyDBClusterEndpoint( args: ModifyDBClusterEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBClusterEndpointCommandOutput) => void ): void; - public modifyDBClusterEndpoint( - args: ModifyDBClusterEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBClusterEndpointCommandOutput) => void), - cb?: (err: any, data?: ModifyDBClusterEndpointCommandOutput) => void - ): Promise | void { - const command = new ModifyDBClusterEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the parameters of a DB cluster parameter group. To modify more than one - * parameter, submit a list of the following: ParameterName, - * ParameterValue, and ApplyMethod. A maximum of 20 parameters can be - * modified in a single request.

- * - *

Changes to dynamic parameters are applied immediately. Changes to static parameters - * require a reboot without failover to the DB cluster associated with the parameter group - * before the change can take effect.

- *
- * - *

After you create a DB cluster parameter group, you should wait at least 5 minutes before - * creating your first DB cluster that uses that DB cluster parameter group as the default - * parameter group. This allows Amazon Neptune to fully complete the create action before the - * parameter group is used as the default for a new DB cluster. This is especially important - * for parameters that are critical when creating the default database for a DB cluster, such - * as the character set for the default database defined by the - * character_set_database parameter. You can use the Parameter - * Groups option of the Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter - * group has been created or modified.

- *
- */ - public modifyDBClusterParameterGroup( + + /** + * @see {@link ModifyDBClusterParameterGroupCommand} + */ + modifyDBClusterParameterGroup( args: ModifyDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDBClusterParameterGroup( + modifyDBClusterParameterGroup( args: ModifyDBClusterParameterGroupCommandInput, cb: (err: any, data?: ModifyDBClusterParameterGroupCommandOutput) => void ): void; - public modifyDBClusterParameterGroup( + modifyDBClusterParameterGroup( args: ModifyDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBClusterParameterGroupCommandOutput) => void ): void; - public modifyDBClusterParameterGroup( - args: ModifyDBClusterParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBClusterParameterGroupCommandOutput) => void), - cb?: (err: any, data?: ModifyDBClusterParameterGroupCommandOutput) => void - ): Promise | void { - const command = new ModifyDBClusterParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds an attribute and values to, or removes an attribute and values from, a manual DB - * cluster snapshot.

- *

To share a manual DB cluster snapshot with other Amazon accounts, specify - * restore as the AttributeName and use the ValuesToAdd - * parameter to add a list of IDs of the Amazon accounts that are authorized to restore the manual - * DB cluster snapshot. Use the value all to make the manual DB cluster snapshot - * public, which means that it can be copied or restored by all Amazon accounts. Do not add the - * all value for any manual DB cluster snapshots that contain private information - * that you don't want available to all Amazon accounts. If a manual DB cluster snapshot is - * encrypted, it can be shared, but only by specifying a list of authorized Amazon account IDs for - * the ValuesToAdd parameter. You can't use all as a value for that - * parameter in this case.

- *

To view which Amazon accounts have access to copy or restore a manual DB cluster snapshot, or - * whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.

- */ - public modifyDBClusterSnapshotAttribute( + + /** + * @see {@link ModifyDBClusterSnapshotAttributeCommand} + */ + modifyDBClusterSnapshotAttribute( args: ModifyDBClusterSnapshotAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDBClusterSnapshotAttribute( + modifyDBClusterSnapshotAttribute( args: ModifyDBClusterSnapshotAttributeCommandInput, cb: (err: any, data?: ModifyDBClusterSnapshotAttributeCommandOutput) => void ): void; - public modifyDBClusterSnapshotAttribute( + modifyDBClusterSnapshotAttribute( args: ModifyDBClusterSnapshotAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBClusterSnapshotAttributeCommandOutput) => void ): void; - public modifyDBClusterSnapshotAttribute( - args: ModifyDBClusterSnapshotAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBClusterSnapshotAttributeCommandOutput) => void), - cb?: (err: any, data?: ModifyDBClusterSnapshotAttributeCommandOutput) => void - ): Promise | void { - const command = new ModifyDBClusterSnapshotAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies settings for a DB instance. You can change one or more database configuration - * parameters by specifying these parameters and the new values in the request. To learn what - * modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.

- */ - public modifyDBInstance( + + /** + * @see {@link ModifyDBInstanceCommand} + */ + modifyDBInstance( args: ModifyDBInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDBInstance( + modifyDBInstance( args: ModifyDBInstanceCommandInput, cb: (err: any, data?: ModifyDBInstanceCommandOutput) => void ): void; - public modifyDBInstance( + modifyDBInstance( args: ModifyDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBInstanceCommandOutput) => void ): void; - public modifyDBInstance( - args: ModifyDBInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBInstanceCommandOutput) => void), - cb?: (err: any, data?: ModifyDBInstanceCommandOutput) => void - ): Promise | void { - const command = new ModifyDBInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the parameters of a DB parameter group. To modify more than one parameter, - * submit a list of the following: ParameterName, ParameterValue, and - * ApplyMethod. A maximum of 20 parameters can be modified in a single request.

- * - *

Changes to dynamic parameters are applied immediately. Changes to static parameters - * require a reboot without failover to the DB instance associated with the parameter group - * before the change can take effect.

- *
- * - *

After you modify a DB parameter group, you should wait at least 5 minutes before - * creating your first DB instance that uses that DB parameter group as the default parameter - * group. This allows Amazon Neptune to fully complete the modify action before the parameter - * group is used as the default for a new DB instance. This is especially important for - * parameters that are critical when creating the default database for a DB instance, such as - * the character set for the default database defined by the - * character_set_database parameter. You can use the Parameter - * Groups option of the Amazon Neptune console or the - * DescribeDBParameters command to verify that your DB parameter group has - * been created or modified.

- *
- */ - public modifyDBParameterGroup( + + /** + * @see {@link ModifyDBParameterGroupCommand} + */ + modifyDBParameterGroup( args: ModifyDBParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDBParameterGroup( + modifyDBParameterGroup( args: ModifyDBParameterGroupCommandInput, cb: (err: any, data?: ModifyDBParameterGroupCommandOutput) => void ): void; - public modifyDBParameterGroup( + modifyDBParameterGroup( args: ModifyDBParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBParameterGroupCommandOutput) => void ): void; - public modifyDBParameterGroup( - args: ModifyDBParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBParameterGroupCommandOutput) => void), - cb?: (err: any, data?: ModifyDBParameterGroupCommandOutput) => void - ): Promise | void { - const command = new ModifyDBParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in - * at least two AZs in the Amazon Region.

- */ - public modifyDBSubnetGroup( + + /** + * @see {@link ModifyDBSubnetGroupCommand} + */ + modifyDBSubnetGroup( args: ModifyDBSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDBSubnetGroup( + modifyDBSubnetGroup( args: ModifyDBSubnetGroupCommandInput, cb: (err: any, data?: ModifyDBSubnetGroupCommandOutput) => void ): void; - public modifyDBSubnetGroup( + modifyDBSubnetGroup( args: ModifyDBSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBSubnetGroupCommandOutput) => void ): void; - public modifyDBSubnetGroup( - args: ModifyDBSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: ModifyDBSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new ModifyDBSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies an existing event notification subscription. Note that you can't modify the - * source identifiers using this call; to change source identifiers for a subscription, use the - * AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

- *

You can see a list of the event categories for a given SourceType - * by using the DescribeEventCategories action.

- */ - public modifyEventSubscription( + + /** + * @see {@link ModifyEventSubscriptionCommand} + */ + modifyEventSubscription( args: ModifyEventSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyEventSubscription( + modifyEventSubscription( args: ModifyEventSubscriptionCommandInput, cb: (err: any, data?: ModifyEventSubscriptionCommandOutput) => void ): void; - public modifyEventSubscription( + modifyEventSubscription( args: ModifyEventSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyEventSubscriptionCommandOutput) => void ): void; - public modifyEventSubscription( - args: ModifyEventSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyEventSubscriptionCommandOutput) => void), - cb?: (err: any, data?: ModifyEventSubscriptionCommandOutput) => void - ): Promise | void { - const command = new ModifyEventSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modify a setting for an Amazon Neptune global cluster. You can change one - * or more database configuration parameters by specifying these parameters - * and their new values in the request.

- */ - public modifyGlobalCluster( + + /** + * @see {@link ModifyGlobalClusterCommand} + */ + modifyGlobalCluster( args: ModifyGlobalClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyGlobalCluster( + modifyGlobalCluster( args: ModifyGlobalClusterCommandInput, cb: (err: any, data?: ModifyGlobalClusterCommandOutput) => void ): void; - public modifyGlobalCluster( + modifyGlobalCluster( args: ModifyGlobalClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyGlobalClusterCommandOutput) => void ): void; - public modifyGlobalCluster( - args: ModifyGlobalClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyGlobalClusterCommandOutput) => void), - cb?: (err: any, data?: ModifyGlobalClusterCommandOutput) => void - ): Promise | void { - const command = new ModifyGlobalClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Not supported.

- */ - public promoteReadReplicaDBCluster( + + /** + * @see {@link PromoteReadReplicaDBClusterCommand} + */ + promoteReadReplicaDBCluster( args: PromoteReadReplicaDBClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public promoteReadReplicaDBCluster( + promoteReadReplicaDBCluster( args: PromoteReadReplicaDBClusterCommandInput, cb: (err: any, data?: PromoteReadReplicaDBClusterCommandOutput) => void ): void; - public promoteReadReplicaDBCluster( + promoteReadReplicaDBCluster( args: PromoteReadReplicaDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PromoteReadReplicaDBClusterCommandOutput) => void ): void; - public promoteReadReplicaDBCluster( - args: PromoteReadReplicaDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PromoteReadReplicaDBClusterCommandOutput) => void), - cb?: (err: any, data?: PromoteReadReplicaDBClusterCommandOutput) => void - ): Promise | void { - const command = new PromoteReadReplicaDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

You might need to reboot your DB instance, usually for maintenance reasons. For example, - * if you make certain modifications, or if you change the DB parameter group associated with the - * DB instance, you must reboot the instance for the changes to take effect.

- *

Rebooting a DB instance restarts the database engine service. Rebooting a DB instance - * results in a momentary outage, during which the DB instance status is set to rebooting.

- */ - public rebootDBInstance( + + /** + * @see {@link RebootDBInstanceCommand} + */ + rebootDBInstance( args: RebootDBInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public rebootDBInstance( + rebootDBInstance( args: RebootDBInstanceCommandInput, cb: (err: any, data?: RebootDBInstanceCommandOutput) => void ): void; - public rebootDBInstance( + rebootDBInstance( args: RebootDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebootDBInstanceCommandOutput) => void ): void; - public rebootDBInstance( - args: RebootDBInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RebootDBInstanceCommandOutput) => void), - cb?: (err: any, data?: RebootDBInstanceCommandOutput) => void - ): Promise | void { - const command = new RebootDBInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detaches a Neptune DB cluster from a Neptune global database. A secondary - * cluster becomes a normal standalone cluster with read-write capability - * instead of being read-only, and no longer receives data from a the - * primary cluster.

- */ - public removeFromGlobalCluster( + + /** + * @see {@link RemoveFromGlobalClusterCommand} + */ + removeFromGlobalCluster( args: RemoveFromGlobalClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeFromGlobalCluster( + removeFromGlobalCluster( args: RemoveFromGlobalClusterCommandInput, cb: (err: any, data?: RemoveFromGlobalClusterCommandOutput) => void ): void; - public removeFromGlobalCluster( + removeFromGlobalCluster( args: RemoveFromGlobalClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveFromGlobalClusterCommandOutput) => void ): void; - public removeFromGlobalCluster( - args: RemoveFromGlobalClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveFromGlobalClusterCommandOutput) => void), - cb?: (err: any, data?: RemoveFromGlobalClusterCommandOutput) => void - ): Promise | void { - const command = new RemoveFromGlobalClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates an Identity and Access Management (IAM) role from a DB cluster.

- */ - public removeRoleFromDBCluster( + + /** + * @see {@link RemoveRoleFromDBClusterCommand} + */ + removeRoleFromDBCluster( args: RemoveRoleFromDBClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeRoleFromDBCluster( + removeRoleFromDBCluster( args: RemoveRoleFromDBClusterCommandInput, cb: (err: any, data?: RemoveRoleFromDBClusterCommandOutput) => void ): void; - public removeRoleFromDBCluster( + removeRoleFromDBCluster( args: RemoveRoleFromDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveRoleFromDBClusterCommandOutput) => void ): void; - public removeRoleFromDBCluster( - args: RemoveRoleFromDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveRoleFromDBClusterCommandOutput) => void), - cb?: (err: any, data?: RemoveRoleFromDBClusterCommandOutput) => void - ): Promise | void { - const command = new RemoveRoleFromDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a source identifier from an existing event notification subscription.

- */ - public removeSourceIdentifierFromSubscription( + + /** + * @see {@link RemoveSourceIdentifierFromSubscriptionCommand} + */ + removeSourceIdentifierFromSubscription( args: RemoveSourceIdentifierFromSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeSourceIdentifierFromSubscription( + removeSourceIdentifierFromSubscription( args: RemoveSourceIdentifierFromSubscriptionCommandInput, cb: (err: any, data?: RemoveSourceIdentifierFromSubscriptionCommandOutput) => void ): void; - public removeSourceIdentifierFromSubscription( + removeSourceIdentifierFromSubscription( args: RemoveSourceIdentifierFromSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveSourceIdentifierFromSubscriptionCommandOutput) => void ): void; - public removeSourceIdentifierFromSubscription( - args: RemoveSourceIdentifierFromSubscriptionCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: RemoveSourceIdentifierFromSubscriptionCommandOutput) => void), - cb?: (err: any, data?: RemoveSourceIdentifierFromSubscriptionCommandOutput) => void - ): Promise | void { - const command = new RemoveSourceIdentifierFromSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes metadata tags from an Amazon Neptune resource.

- */ - public removeTagsFromResource( + + /** + * @see {@link RemoveTagsFromResourceCommand} + */ + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeTagsFromResource( + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void ): void; - public removeTagsFromResource( + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void ): void; - public removeTagsFromResource( - args: RemoveTagsFromResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveTagsFromResourceCommandOutput) => void), - cb?: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void - ): Promise | void { - const command = new RemoveTagsFromResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the parameters of a DB cluster parameter group to the default value. To reset - * specific parameters submit a list of the following: ParameterName and - * ApplyMethod. To reset the entire DB cluster parameter group, specify the - * DBClusterParameterGroupName and ResetAllParameters parameters.

- *

When resetting the entire group, dynamic parameters are updated immediately and static - * parameters are set to pending-reboot to take effect on the next DB instance - * restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster - * that you want the updated static parameter to apply to.

- */ - public resetDBClusterParameterGroup( + + /** + * @see {@link ResetDBClusterParameterGroupCommand} + */ + resetDBClusterParameterGroup( args: ResetDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetDBClusterParameterGroup( + resetDBClusterParameterGroup( args: ResetDBClusterParameterGroupCommandInput, cb: (err: any, data?: ResetDBClusterParameterGroupCommandOutput) => void ): void; - public resetDBClusterParameterGroup( + resetDBClusterParameterGroup( args: ResetDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetDBClusterParameterGroupCommandOutput) => void ): void; - public resetDBClusterParameterGroup( - args: ResetDBClusterParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetDBClusterParameterGroupCommandOutput) => void), - cb?: (err: any, data?: ResetDBClusterParameterGroupCommandOutput) => void - ): Promise | void { - const command = new ResetDBClusterParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the parameters of a DB parameter group to the engine/system default value. To - * reset specific parameters, provide a list of the following: ParameterName and - * ApplyMethod. To reset the entire DB parameter group, specify the - * DBParameterGroup name and ResetAllParameters parameters. When - * resetting the entire group, dynamic parameters are updated immediately and static parameters - * are set to pending-reboot to take effect on the next DB instance restart or - * RebootDBInstance request.

- */ - public resetDBParameterGroup( + + /** + * @see {@link ResetDBParameterGroupCommand} + */ + resetDBParameterGroup( args: ResetDBParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetDBParameterGroup( + resetDBParameterGroup( args: ResetDBParameterGroupCommandInput, cb: (err: any, data?: ResetDBParameterGroupCommandOutput) => void ): void; - public resetDBParameterGroup( + resetDBParameterGroup( args: ResetDBParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetDBParameterGroupCommandOutput) => void ): void; - public resetDBParameterGroup( - args: ResetDBParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetDBParameterGroupCommandOutput) => void), - cb?: (err: any, data?: ResetDBParameterGroupCommandOutput) => void - ): Promise | void { - const command = new ResetDBParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

- *

If a DB snapshot is specified, the target DB cluster is created from the source DB - * snapshot with a default configuration and default security group.

- *

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB - * cluster restore point with the same configuration as the original source DB cluster, except - * that the new DB cluster is created with the default security group.

- */ - public restoreDBClusterFromSnapshot( + + /** + * @see {@link RestoreDBClusterFromSnapshotCommand} + */ + restoreDBClusterFromSnapshot( args: RestoreDBClusterFromSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreDBClusterFromSnapshot( + restoreDBClusterFromSnapshot( args: RestoreDBClusterFromSnapshotCommandInput, cb: (err: any, data?: RestoreDBClusterFromSnapshotCommandOutput) => void ): void; - public restoreDBClusterFromSnapshot( + restoreDBClusterFromSnapshot( args: RestoreDBClusterFromSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreDBClusterFromSnapshotCommandOutput) => void ): void; - public restoreDBClusterFromSnapshot( - args: RestoreDBClusterFromSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreDBClusterFromSnapshotCommandOutput) => void), - cb?: (err: any, data?: RestoreDBClusterFromSnapshotCommandOutput) => void - ): Promise | void { - const command = new RestoreDBClusterFromSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in - * time before LatestRestorableTime for up to BackupRetentionPeriod - * days. The target DB cluster is created from the source DB cluster with the same configuration - * as the original DB cluster, except that the new DB cluster is created with the default DB - * security group.

- * - *

This action only restores the DB cluster, not the DB instances for that DB cluster. You - * must invoke the CreateDBInstance action to create DB instances for the - * restored DB cluster, specifying the identifier of the restored DB cluster in - * DBClusterIdentifier. You can create DB instances only after the - * RestoreDBClusterToPointInTime action has completed and the DB cluster is - * available.

- *
- */ - public restoreDBClusterToPointInTime( + + /** + * @see {@link RestoreDBClusterToPointInTimeCommand} + */ + restoreDBClusterToPointInTime( args: RestoreDBClusterToPointInTimeCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreDBClusterToPointInTime( + restoreDBClusterToPointInTime( args: RestoreDBClusterToPointInTimeCommandInput, cb: (err: any, data?: RestoreDBClusterToPointInTimeCommandOutput) => void ): void; - public restoreDBClusterToPointInTime( + restoreDBClusterToPointInTime( args: RestoreDBClusterToPointInTimeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreDBClusterToPointInTimeCommandOutput) => void ): void; - public restoreDBClusterToPointInTime( - args: RestoreDBClusterToPointInTimeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreDBClusterToPointInTimeCommandOutput) => void), - cb?: (err: any, data?: RestoreDBClusterToPointInTimeCommandOutput) => void - ): Promise | void { - const command = new RestoreDBClusterToPointInTimeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts an Amazon Neptune DB cluster that was stopped using the Amazon - * console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API.

- */ - public startDBCluster( + + /** + * @see {@link StartDBClusterCommand} + */ + startDBCluster( args: StartDBClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDBCluster( - args: StartDBClusterCommandInput, - cb: (err: any, data?: StartDBClusterCommandOutput) => void - ): void; - public startDBCluster( + startDBCluster(args: StartDBClusterCommandInput, cb: (err: any, data?: StartDBClusterCommandOutput) => void): void; + startDBCluster( args: StartDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDBClusterCommandOutput) => void ): void; - public startDBCluster( - args: StartDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDBClusterCommandOutput) => void), - cb?: (err: any, data?: StartDBClusterCommandOutput) => void - ): Promise | void { - const command = new StartDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops an Amazon Neptune DB cluster. When you stop a DB cluster, Neptune - * retains the DB cluster's metadata, including its endpoints and DB parameter - * groups.

- *

Neptune also retains the transaction logs so you can do a point-in-time - * restore if necessary.

- */ - public stopDBCluster( - args: StopDBClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public stopDBCluster( - args: StopDBClusterCommandInput, - cb: (err: any, data?: StopDBClusterCommandOutput) => void - ): void; - public stopDBCluster( + + /** + * @see {@link StopDBClusterCommand} + */ + stopDBCluster(args: StopDBClusterCommandInput, options?: __HttpHandlerOptions): Promise; + stopDBCluster(args: StopDBClusterCommandInput, cb: (err: any, data?: StopDBClusterCommandOutput) => void): void; + stopDBCluster( args: StopDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDBClusterCommandOutput) => void ): void; - public stopDBCluster( - args: StopDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopDBClusterCommandOutput) => void), - cb?: (err: any, data?: StopDBClusterCommandOutput) => void - ): Promise | void { - const command = new StopDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Neptune + *

Amazon Neptune is a fast, reliable, fully-managed graph database service that makes it + * easy to build and run applications that work with highly connected datasets. The core of + * Amazon Neptune is a purpose-built, high-performance graph database engine optimized for + * storing billions of relationships and querying the graph with milliseconds latency. Amazon + * Neptune supports popular graph models Property Graph and W3C's RDF, and their respective query + * languages Apache TinkerPop Gremlin and SPARQL, allowing you to easily build queries that + * efficiently navigate highly connected datasets. Neptune powers graph use cases such as + * recommendation engines, fraud detection, knowledge graphs, drug discovery, and network + * security.

+ *

This interface reference for Amazon Neptune contains documentation for a programming or + * command line interface you can use to manage Amazon Neptune. Note that Amazon Neptune is + * asynchronous, which means that some interfaces might require techniques such as polling or + * callback functions to determine when a command has been applied. In this reference, the + * parameter descriptions indicate whether a command is applied immediately, on the next instance + * reboot, or during the maintenance window. The reference structure is as follows, and we list + * following some related topics from the user guide.

+ */ +export class Neptune extends NeptuneClient implements Neptune {} +createAggregatedClient(commands, Neptune); diff --git a/clients/client-network-firewall/src/NetworkFirewall.ts b/clients/client-network-firewall/src/NetworkFirewall.ts index 762ab2e27fca..981e79798e35 100644 --- a/clients/client-network-firewall/src/NetworkFirewall.ts +++ b/clients/client-network-firewall/src/NetworkFirewall.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -177,1395 +178,705 @@ import { UpdateTLSInspectionConfigurationCommandInput, UpdateTLSInspectionConfigurationCommandOutput, } from "./commands/UpdateTLSInspectionConfigurationCommand"; -import { NetworkFirewallClient } from "./NetworkFirewallClient"; +import { NetworkFirewallClient, NetworkFirewallClientConfig } from "./NetworkFirewallClient"; -/** - * @public - *

This is the API Reference for Network Firewall. This guide is for developers who need - * detailed information about the Network Firewall API actions, data types, and errors.

- *
    - *
  • - *

    The REST API requires you to handle connection details, such as calculating - * signatures, handling request retries, and error handling. For general information - * about using the Amazon Web Services REST APIs, see Amazon Web Services APIs.

    - *

    To access Network Firewall using the REST API endpoint: - * https://network-firewall..amazonaws.com - *

    - *
  • - *
  • - *

    Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to - * the programming language or platform that you're using. For more information, see - * Amazon Web Services SDKs.

    - *
  • - *
  • - *

    For descriptions of Network Firewall features, including and step-by-step - * instructions on how to use them through the Network Firewall console, see the Network Firewall Developer - * Guide.

    - *
  • - *
- *

Network Firewall is a stateful, managed, network firewall and intrusion detection and - * prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the - * perimeter of your VPC. This includes filtering traffic going to and coming from an internet - * gateway, NAT gateway, or over VPN or Direct Connect. Network Firewall uses rules that are compatible - * with Suricata, a free, open source network analysis and threat detection engine. - * Network Firewall supports Suricata version 6.0.9. For information about Suricata, - * see the Suricata website.

- *

You can use Network Firewall to monitor and protect your VPC traffic in a number of ways. - * The following are just a few examples:

- *
    - *
  • - *

    Allow domains or IP addresses for known Amazon Web Services service endpoints, such as Amazon S3, and - * block all other forms of traffic.

    - *
  • - *
  • - *

    Use custom lists of known bad domains to limit the types of domain names that your - * applications can access.

    - *
  • - *
  • - *

    Perform deep packet inspection on traffic entering or leaving your VPC.

    - *
  • - *
  • - *

    Use stateful protocol detection to filter protocols like HTTPS, regardless of the - * port used.

    - *
  • - *
- *

To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in - * Network Firewall. For information about using Amazon VPC, see Amazon VPC User Guide.

- *

To start using Network Firewall, do the following:

- *
    - *
  1. - *

    (Optional) If you don't already have a VPC that you want to protect, create it in - * Amazon VPC.

    - *
  2. - *
  3. - *

    In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a - * subnet for the sole use of Network Firewall.

    - *
  4. - *
  5. - *

    In Network Firewall, create stateless and stateful rule groups, - * to define the components of the network traffic filtering behavior that you want your firewall to have.

    - *
  6. - *
  7. - *

    In Network Firewall, create a firewall policy that uses your rule groups and - * specifies additional default traffic filtering behavior.

    - *
  8. - *
  9. - *

    In Network Firewall, create a firewall and specify your new firewall policy and - * VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you - * specify, with the behavior that's defined in the firewall policy.

    - *
  10. - *
  11. - *

    In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall - * endpoints.

    - *
  12. - *
- */ -export class NetworkFirewall extends NetworkFirewallClient { +const commands = { + AssociateFirewallPolicyCommand, + AssociateSubnetsCommand, + CreateFirewallCommand, + CreateFirewallPolicyCommand, + CreateRuleGroupCommand, + CreateTLSInspectionConfigurationCommand, + DeleteFirewallCommand, + DeleteFirewallPolicyCommand, + DeleteResourcePolicyCommand, + DeleteRuleGroupCommand, + DeleteTLSInspectionConfigurationCommand, + DescribeFirewallCommand, + DescribeFirewallPolicyCommand, + DescribeLoggingConfigurationCommand, + DescribeResourcePolicyCommand, + DescribeRuleGroupCommand, + DescribeRuleGroupMetadataCommand, + DescribeTLSInspectionConfigurationCommand, + DisassociateSubnetsCommand, + ListFirewallPoliciesCommand, + ListFirewallsCommand, + ListRuleGroupsCommand, + ListTagsForResourceCommand, + ListTLSInspectionConfigurationsCommand, + PutResourcePolicyCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateFirewallDeleteProtectionCommand, + UpdateFirewallDescriptionCommand, + UpdateFirewallEncryptionConfigurationCommand, + UpdateFirewallPolicyCommand, + UpdateFirewallPolicyChangeProtectionCommand, + UpdateLoggingConfigurationCommand, + UpdateRuleGroupCommand, + UpdateSubnetChangeProtectionCommand, + UpdateTLSInspectionConfigurationCommand, +}; + +export interface NetworkFirewall { /** - * @public - *

Associates a FirewallPolicy to a Firewall.

- *

A firewall policy defines how to monitor and manage your VPC network traffic, using a - * collection of inspection rule groups and other settings. Each firewall requires one - * firewall policy association, and you can use the same firewall policy for multiple - * firewalls.

+ * @see {@link AssociateFirewallPolicyCommand} */ - public associateFirewallPolicy( + associateFirewallPolicy( args: AssociateFirewallPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateFirewallPolicy( + associateFirewallPolicy( args: AssociateFirewallPolicyCommandInput, cb: (err: any, data?: AssociateFirewallPolicyCommandOutput) => void ): void; - public associateFirewallPolicy( + associateFirewallPolicy( args: AssociateFirewallPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateFirewallPolicyCommandOutput) => void ): void; - public associateFirewallPolicy( - args: AssociateFirewallPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateFirewallPolicyCommandOutput) => void), - cb?: (err: any, data?: AssociateFirewallPolicyCommandOutput) => void - ): Promise | void { - const command = new AssociateFirewallPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates the specified subnets in the Amazon VPC to the firewall. You can specify one - * subnet for each of the Availability Zones that the VPC spans.

- *

This request creates an Network Firewall firewall endpoint in each of the subnets. To - * enable the firewall's protections, you must also modify the VPC's route tables for each - * subnet's Availability Zone, to redirect the traffic that's coming into and going out of the - * zone through the firewall endpoint.

+ * @see {@link AssociateSubnetsCommand} */ - public associateSubnets( + associateSubnets( args: AssociateSubnetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateSubnets( + associateSubnets( args: AssociateSubnetsCommandInput, cb: (err: any, data?: AssociateSubnetsCommandOutput) => void ): void; - public associateSubnets( + associateSubnets( args: AssociateSubnetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateSubnetsCommandOutput) => void ): void; - public associateSubnets( - args: AssociateSubnetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateSubnetsCommandOutput) => void), - cb?: (err: any, data?: AssociateSubnetsCommandOutput) => void - ): Promise | void { - const command = new AssociateSubnetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC.

- *

The firewall defines the configuration settings for an Network Firewall firewall. The settings that you can define at creation include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource.

- *

After you create a firewall, you can provide additional settings, like the logging configuration.

- *

To update the settings for a firewall, you use the operations that apply to the settings - * themselves, for example UpdateLoggingConfiguration, AssociateSubnets, and UpdateFirewallDeleteProtection.

- *

To manage a firewall's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

- *

To retrieve information about firewalls, use ListFirewalls and DescribeFirewall.

+ * @see {@link CreateFirewallCommand} */ - public createFirewall( + createFirewall( args: CreateFirewallCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFirewall( - args: CreateFirewallCommandInput, - cb: (err: any, data?: CreateFirewallCommandOutput) => void - ): void; - public createFirewall( + createFirewall(args: CreateFirewallCommandInput, cb: (err: any, data?: CreateFirewallCommandOutput) => void): void; + createFirewall( args: CreateFirewallCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFirewallCommandOutput) => void ): void; - public createFirewall( - args: CreateFirewallCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFirewallCommandOutput) => void), - cb?: (err: any, data?: CreateFirewallCommandOutput) => void - ): Promise | void { - const command = new CreateFirewallCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates the firewall policy for the firewall according to the specifications.

- *

An Network Firewall firewall policy defines the behavior of a firewall, in a collection of - * stateless and stateful rule groups and other settings. You can use one firewall policy for - * multiple firewalls.

+ * @see {@link CreateFirewallPolicyCommand} */ - public createFirewallPolicy( + createFirewallPolicy( args: CreateFirewallPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFirewallPolicy( + createFirewallPolicy( args: CreateFirewallPolicyCommandInput, cb: (err: any, data?: CreateFirewallPolicyCommandOutput) => void ): void; - public createFirewallPolicy( + createFirewallPolicy( args: CreateFirewallPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFirewallPolicyCommandOutput) => void ): void; - public createFirewallPolicy( - args: CreateFirewallPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFirewallPolicyCommandOutput) => void), - cb?: (err: any, data?: CreateFirewallPolicyCommandOutput) => void - ): Promise | void { - const command = new CreateFirewallPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates the specified stateless or stateful rule group, which includes the rules for - * network traffic inspection, a capacity setting, and tags.

- *

You provide your rule group specification in your request using either - * RuleGroup or Rules.

+ * @see {@link CreateRuleGroupCommand} */ - public createRuleGroup( + createRuleGroup( args: CreateRuleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRuleGroup( - args: CreateRuleGroupCommandInput, - cb: (err: any, data?: CreateRuleGroupCommandOutput) => void - ): void; - public createRuleGroup( + createRuleGroup(args: CreateRuleGroupCommandInput, cb: (err: any, data?: CreateRuleGroupCommandOutput) => void): void; + createRuleGroup( args: CreateRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRuleGroupCommandOutput) => void ): void; - public createRuleGroup( - args: CreateRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRuleGroupCommandOutput) => void), - cb?: (err: any, data?: CreateRuleGroupCommandOutput) => void - ): Promise | void { - const command = new CreateRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Network Firewall TLS inspection configuration. A TLS inspection configuration contains the Certificate Manager certificate references that Network Firewall uses to decrypt and re-encrypt inbound traffic.

- *

After you create a TLS inspection configuration, you associate it with a firewall policy.

- *

To update the settings for a TLS inspection configuration, use UpdateTLSInspectionConfiguration.

- *

To manage a TLS inspection configuration's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

- *

To retrieve information about TLS inspection configurations, use ListTLSInspectionConfigurations and DescribeTLSInspectionConfiguration.

- *

- * For more information about TLS inspection configurations, see Decrypting SSL/TLS traffic with TLS - * inspection configurations in the Network Firewall Developer Guide. - *

+ * @see {@link CreateTLSInspectionConfigurationCommand} */ - public createTLSInspectionConfiguration( + createTLSInspectionConfiguration( args: CreateTLSInspectionConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTLSInspectionConfiguration( + createTLSInspectionConfiguration( args: CreateTLSInspectionConfigurationCommandInput, cb: (err: any, data?: CreateTLSInspectionConfigurationCommandOutput) => void ): void; - public createTLSInspectionConfiguration( + createTLSInspectionConfiguration( args: CreateTLSInspectionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTLSInspectionConfigurationCommandOutput) => void ): void; - public createTLSInspectionConfiguration( - args: CreateTLSInspectionConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTLSInspectionConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateTLSInspectionConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateTLSInspectionConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified Firewall and its FirewallStatus. - * This operation requires the firewall's DeleteProtection flag to be - * FALSE. You can't revert this operation.

- *

You can check whether a firewall is - * in use by reviewing the route tables for the Availability Zones where you have - * firewall subnet mappings. Retrieve the subnet mappings by calling DescribeFirewall. - * You define and update the route tables through Amazon VPC. As needed, update the route tables for the - * zones to remove the firewall endpoints. When the route tables no longer use the firewall endpoints, - * you can remove the firewall safely.

- *

To delete a firewall, remove the delete protection if you need to using UpdateFirewallDeleteProtection, - * then delete the firewall by calling DeleteFirewall.

+ * @see {@link DeleteFirewallCommand} */ - public deleteFirewall( + deleteFirewall( args: DeleteFirewallCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFirewall( - args: DeleteFirewallCommandInput, - cb: (err: any, data?: DeleteFirewallCommandOutput) => void - ): void; - public deleteFirewall( + deleteFirewall(args: DeleteFirewallCommandInput, cb: (err: any, data?: DeleteFirewallCommandOutput) => void): void; + deleteFirewall( args: DeleteFirewallCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFirewallCommandOutput) => void ): void; - public deleteFirewall( - args: DeleteFirewallCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFirewallCommandOutput) => void), - cb?: (err: any, data?: DeleteFirewallCommandOutput) => void - ): Promise | void { - const command = new DeleteFirewallCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified FirewallPolicy.

+ * @see {@link DeleteFirewallPolicyCommand} */ - public deleteFirewallPolicy( + deleteFirewallPolicy( args: DeleteFirewallPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFirewallPolicy( + deleteFirewallPolicy( args: DeleteFirewallPolicyCommandInput, cb: (err: any, data?: DeleteFirewallPolicyCommandOutput) => void ): void; - public deleteFirewallPolicy( + deleteFirewallPolicy( args: DeleteFirewallPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFirewallPolicyCommandOutput) => void ): void; - public deleteFirewallPolicy( - args: DeleteFirewallPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFirewallPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteFirewallPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteFirewallPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a resource policy that you created in a PutResourcePolicy request.

+ * @see {@link DeleteResourcePolicyCommand} */ - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( - args: DeleteResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified RuleGroup.

+ * @see {@link DeleteRuleGroupCommand} */ - public deleteRuleGroup( + deleteRuleGroup( args: DeleteRuleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRuleGroup( - args: DeleteRuleGroupCommandInput, - cb: (err: any, data?: DeleteRuleGroupCommandOutput) => void - ): void; - public deleteRuleGroup( + deleteRuleGroup(args: DeleteRuleGroupCommandInput, cb: (err: any, data?: DeleteRuleGroupCommandOutput) => void): void; + deleteRuleGroup( args: DeleteRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRuleGroupCommandOutput) => void ): void; - public deleteRuleGroup( - args: DeleteRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRuleGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteRuleGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified TLSInspectionConfiguration.

+ * @see {@link DeleteTLSInspectionConfigurationCommand} */ - public deleteTLSInspectionConfiguration( + deleteTLSInspectionConfiguration( args: DeleteTLSInspectionConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTLSInspectionConfiguration( + deleteTLSInspectionConfiguration( args: DeleteTLSInspectionConfigurationCommandInput, cb: (err: any, data?: DeleteTLSInspectionConfigurationCommandOutput) => void ): void; - public deleteTLSInspectionConfiguration( + deleteTLSInspectionConfiguration( args: DeleteTLSInspectionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTLSInspectionConfigurationCommandOutput) => void ): void; - public deleteTLSInspectionConfiguration( - args: DeleteTLSInspectionConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTLSInspectionConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteTLSInspectionConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteTLSInspectionConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the data objects for the specified firewall.

+ * @see {@link DescribeFirewallCommand} */ - public describeFirewall( + describeFirewall( args: DescribeFirewallCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFirewall( + describeFirewall( args: DescribeFirewallCommandInput, cb: (err: any, data?: DescribeFirewallCommandOutput) => void ): void; - public describeFirewall( + describeFirewall( args: DescribeFirewallCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFirewallCommandOutput) => void ): void; - public describeFirewall( - args: DescribeFirewallCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFirewallCommandOutput) => void), - cb?: (err: any, data?: DescribeFirewallCommandOutput) => void - ): Promise | void { - const command = new DescribeFirewallCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the data objects for the specified firewall policy.

+ * @see {@link DescribeFirewallPolicyCommand} */ - public describeFirewallPolicy( + describeFirewallPolicy( args: DescribeFirewallPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFirewallPolicy( + describeFirewallPolicy( args: DescribeFirewallPolicyCommandInput, cb: (err: any, data?: DescribeFirewallPolicyCommandOutput) => void ): void; - public describeFirewallPolicy( + describeFirewallPolicy( args: DescribeFirewallPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFirewallPolicyCommandOutput) => void ): void; - public describeFirewallPolicy( - args: DescribeFirewallPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFirewallPolicyCommandOutput) => void), - cb?: (err: any, data?: DescribeFirewallPolicyCommandOutput) => void - ): Promise | void { - const command = new DescribeFirewallPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the logging configuration for the specified firewall.

+ * @see {@link DescribeLoggingConfigurationCommand} */ - public describeLoggingConfiguration( + describeLoggingConfiguration( args: DescribeLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLoggingConfiguration( + describeLoggingConfiguration( args: DescribeLoggingConfigurationCommandInput, cb: (err: any, data?: DescribeLoggingConfigurationCommandOutput) => void ): void; - public describeLoggingConfiguration( + describeLoggingConfiguration( args: DescribeLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLoggingConfigurationCommandOutput) => void ): void; - public describeLoggingConfiguration( - args: DescribeLoggingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a resource policy that you created in a PutResourcePolicy request.

+ * @see {@link DescribeResourcePolicyCommand} */ - public describeResourcePolicy( + describeResourcePolicy( args: DescribeResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeResourcePolicy( + describeResourcePolicy( args: DescribeResourcePolicyCommandInput, cb: (err: any, data?: DescribeResourcePolicyCommandOutput) => void ): void; - public describeResourcePolicy( + describeResourcePolicy( args: DescribeResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeResourcePolicyCommandOutput) => void ): void; - public describeResourcePolicy( - args: DescribeResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: DescribeResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new DescribeResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the data objects for the specified rule group.

+ * @see {@link DescribeRuleGroupCommand} */ - public describeRuleGroup( + describeRuleGroup( args: DescribeRuleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRuleGroup( + describeRuleGroup( args: DescribeRuleGroupCommandInput, cb: (err: any, data?: DescribeRuleGroupCommandOutput) => void ): void; - public describeRuleGroup( + describeRuleGroup( args: DescribeRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRuleGroupCommandOutput) => void ): void; - public describeRuleGroup( - args: DescribeRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRuleGroupCommandOutput) => void), - cb?: (err: any, data?: DescribeRuleGroupCommandOutput) => void - ): Promise | void { - const command = new DescribeRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

High-level information about a rule group, returned by operations like create and describe. - * You can use the information provided in the metadata to retrieve and manage a rule group. - * You can retrieve all objects for a rule group by calling DescribeRuleGroup. - *

+ * @see {@link DescribeRuleGroupMetadataCommand} */ - public describeRuleGroupMetadata( + describeRuleGroupMetadata( args: DescribeRuleGroupMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRuleGroupMetadata( + describeRuleGroupMetadata( args: DescribeRuleGroupMetadataCommandInput, cb: (err: any, data?: DescribeRuleGroupMetadataCommandOutput) => void ): void; - public describeRuleGroupMetadata( + describeRuleGroupMetadata( args: DescribeRuleGroupMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRuleGroupMetadataCommandOutput) => void ): void; - public describeRuleGroupMetadata( - args: DescribeRuleGroupMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRuleGroupMetadataCommandOutput) => void), - cb?: (err: any, data?: DescribeRuleGroupMetadataCommandOutput) => void - ): Promise | void { - const command = new DescribeRuleGroupMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the data objects for the specified TLS inspection configuration.

+ * @see {@link DescribeTLSInspectionConfigurationCommand} */ - public describeTLSInspectionConfiguration( + describeTLSInspectionConfiguration( args: DescribeTLSInspectionConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTLSInspectionConfiguration( + describeTLSInspectionConfiguration( args: DescribeTLSInspectionConfigurationCommandInput, cb: (err: any, data?: DescribeTLSInspectionConfigurationCommandOutput) => void ): void; - public describeTLSInspectionConfiguration( + describeTLSInspectionConfiguration( args: DescribeTLSInspectionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTLSInspectionConfigurationCommandOutput) => void ): void; - public describeTLSInspectionConfiguration( - args: DescribeTLSInspectionConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTLSInspectionConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeTLSInspectionConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeTLSInspectionConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified subnet associations from the firewall. This removes the - * firewall endpoints from the subnets and removes any network filtering protections that the endpoints - * were providing. - *

+ * @see {@link DisassociateSubnetsCommand} */ - public disassociateSubnets( + disassociateSubnets( args: DisassociateSubnetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateSubnets( + disassociateSubnets( args: DisassociateSubnetsCommandInput, cb: (err: any, data?: DisassociateSubnetsCommandOutput) => void ): void; - public disassociateSubnets( + disassociateSubnets( args: DisassociateSubnetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateSubnetsCommandOutput) => void ): void; - public disassociateSubnets( - args: DisassociateSubnetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateSubnetsCommandOutput) => void), - cb?: (err: any, data?: DisassociateSubnetsCommandOutput) => void - ): Promise | void { - const command = new DisassociateSubnetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the metadata for the firewall policies that you have defined. Depending on - * your setting for max results and the number of firewall policies, a single call might not - * return the full list.

+ * @see {@link ListFirewallPoliciesCommand} */ - public listFirewallPolicies( + listFirewallPolicies( args: ListFirewallPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFirewallPolicies( + listFirewallPolicies( args: ListFirewallPoliciesCommandInput, cb: (err: any, data?: ListFirewallPoliciesCommandOutput) => void ): void; - public listFirewallPolicies( + listFirewallPolicies( args: ListFirewallPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFirewallPoliciesCommandOutput) => void ): void; - public listFirewallPolicies( - args: ListFirewallPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFirewallPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListFirewallPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListFirewallPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the metadata for the firewalls that you have defined. If you provide VPC - * identifiers in your request, this returns only the firewalls for those VPCs.

- *

Depending on your setting for max results and the number of firewalls, a single call - * might not return the full list.

+ * @see {@link ListFirewallsCommand} */ - public listFirewalls( - args: ListFirewallsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listFirewalls( - args: ListFirewallsCommandInput, - cb: (err: any, data?: ListFirewallsCommandOutput) => void - ): void; - public listFirewalls( + listFirewalls(args: ListFirewallsCommandInput, options?: __HttpHandlerOptions): Promise; + listFirewalls(args: ListFirewallsCommandInput, cb: (err: any, data?: ListFirewallsCommandOutput) => void): void; + listFirewalls( args: ListFirewallsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFirewallsCommandOutput) => void ): void; - public listFirewalls( - args: ListFirewallsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFirewallsCommandOutput) => void), - cb?: (err: any, data?: ListFirewallsCommandOutput) => void - ): Promise | void { - const command = new ListFirewallsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the metadata for the rule groups that you have defined. Depending on your - * setting for max results and the number of rule groups, a single call might not return the - * full list.

+ * @see {@link ListRuleGroupsCommand} */ - public listRuleGroups( + listRuleGroups( args: ListRuleGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRuleGroups( - args: ListRuleGroupsCommandInput, - cb: (err: any, data?: ListRuleGroupsCommandOutput) => void - ): void; - public listRuleGroups( + listRuleGroups(args: ListRuleGroupsCommandInput, cb: (err: any, data?: ListRuleGroupsCommandOutput) => void): void; + listRuleGroups( args: ListRuleGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRuleGroupsCommandOutput) => void ): void; - public listRuleGroups( - args: ListRuleGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRuleGroupsCommandOutput) => void), - cb?: (err: any, data?: ListRuleGroupsCommandOutput) => void - ): Promise | void { - const command = new ListRuleGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the tags associated with the specified resource. Tags are key:value pairs that - * you can use to categorize and manage your resources, for purposes like billing. For - * example, you might set the tag key to "customer" and the value to the customer name or ID. - * You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a - * resource.

- *

You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall - * policies, and rule groups.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the metadata for the TLS inspection configurations that you have defined. Depending on your setting for max results and the number of TLS inspection configurations, a single call might not return the full list.

+ * @see {@link ListTLSInspectionConfigurationsCommand} */ - public listTLSInspectionConfigurations( + listTLSInspectionConfigurations( args: ListTLSInspectionConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTLSInspectionConfigurations( + listTLSInspectionConfigurations( args: ListTLSInspectionConfigurationsCommandInput, cb: (err: any, data?: ListTLSInspectionConfigurationsCommandOutput) => void ): void; - public listTLSInspectionConfigurations( + listTLSInspectionConfigurations( args: ListTLSInspectionConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTLSInspectionConfigurationsCommandOutput) => void ): void; - public listTLSInspectionConfigurations( - args: ListTLSInspectionConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTLSInspectionConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListTLSInspectionConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListTLSInspectionConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates an IAM policy for your rule group or firewall policy. Use this to share rule groups and firewall policies between accounts. This operation works in conjunction with the Amazon Web Services Resource Access Manager (RAM) service - * to manage resource sharing for Network Firewall.

- *

Use this operation to create or update a resource policy for your rule group or firewall policy. In the policy, you specify the accounts that you want to share the resource with and the operations that you want the accounts to be able to perform.

- *

When you add an account in the resource policy, you then run the following Resource Access Manager (RAM) operations to access and accept the shared rule group or firewall policy.

- * - *

For additional information about resource sharing using RAM, see Resource Access Manager User Guide.

+ * @see {@link PutResourcePolicyCommand} */ - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( - args: PutResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: PutResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new PutResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds the specified tags to the specified resource. Tags are key:value pairs that you can - * use to categorize and manage your resources, for purposes like billing. For example, you - * might set the tag key to "customer" and the value to the customer name or ID. You can - * specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

- *

You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall - * policies, and rule groups.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the tags with the specified keys from the specified resource. Tags are key:value - * pairs that you can use to categorize and manage your resources, for purposes like billing. - * For example, you might set the tag key to "customer" and the value to the customer name or - * ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a - * resource.

- *

You can manage tags for the Amazon Web Services resources that you manage through Network Firewall: - * firewalls, firewall policies, and rule groups.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the flag, DeleteProtection, which indicates whether it is possible - * to delete the firewall. If the flag is set to TRUE, the firewall is protected - * against deletion. This setting helps protect against accidentally deleting a firewall - * that's in use.

+ * @see {@link UpdateFirewallDeleteProtectionCommand} */ - public updateFirewallDeleteProtection( + updateFirewallDeleteProtection( args: UpdateFirewallDeleteProtectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFirewallDeleteProtection( + updateFirewallDeleteProtection( args: UpdateFirewallDeleteProtectionCommandInput, cb: (err: any, data?: UpdateFirewallDeleteProtectionCommandOutput) => void ): void; - public updateFirewallDeleteProtection( + updateFirewallDeleteProtection( args: UpdateFirewallDeleteProtectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFirewallDeleteProtectionCommandOutput) => void ): void; - public updateFirewallDeleteProtection( - args: UpdateFirewallDeleteProtectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFirewallDeleteProtectionCommandOutput) => void), - cb?: (err: any, data?: UpdateFirewallDeleteProtectionCommandOutput) => void - ): Promise | void { - const command = new UpdateFirewallDeleteProtectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the description for the specified firewall. Use the description to help you - * identify the firewall when you're working with it.

+ * @see {@link UpdateFirewallDescriptionCommand} */ - public updateFirewallDescription( + updateFirewallDescription( args: UpdateFirewallDescriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFirewallDescription( + updateFirewallDescription( args: UpdateFirewallDescriptionCommandInput, cb: (err: any, data?: UpdateFirewallDescriptionCommandOutput) => void ): void; - public updateFirewallDescription( + updateFirewallDescription( args: UpdateFirewallDescriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFirewallDescriptionCommandOutput) => void ): void; - public updateFirewallDescription( - args: UpdateFirewallDescriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFirewallDescriptionCommandOutput) => void), - cb?: (err: any, data?: UpdateFirewallDescriptionCommandOutput) => void - ): Promise | void { - const command = new UpdateFirewallDescriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A complex type that contains settings for encryption of your firewall resources.

+ * @see {@link UpdateFirewallEncryptionConfigurationCommand} */ - public updateFirewallEncryptionConfiguration( + updateFirewallEncryptionConfiguration( args: UpdateFirewallEncryptionConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFirewallEncryptionConfiguration( + updateFirewallEncryptionConfiguration( args: UpdateFirewallEncryptionConfigurationCommandInput, cb: (err: any, data?: UpdateFirewallEncryptionConfigurationCommandOutput) => void ): void; - public updateFirewallEncryptionConfiguration( + updateFirewallEncryptionConfiguration( args: UpdateFirewallEncryptionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFirewallEncryptionConfigurationCommandOutput) => void ): void; - public updateFirewallEncryptionConfiguration( - args: UpdateFirewallEncryptionConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateFirewallEncryptionConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateFirewallEncryptionConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateFirewallEncryptionConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the properties of the specified firewall policy.

+ * @see {@link UpdateFirewallPolicyCommand} */ - public updateFirewallPolicy( + updateFirewallPolicy( args: UpdateFirewallPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFirewallPolicy( + updateFirewallPolicy( args: UpdateFirewallPolicyCommandInput, cb: (err: any, data?: UpdateFirewallPolicyCommandOutput) => void ): void; - public updateFirewallPolicy( + updateFirewallPolicy( args: UpdateFirewallPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFirewallPolicyCommandOutput) => void ): void; - public updateFirewallPolicy( - args: UpdateFirewallPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFirewallPolicyCommandOutput) => void), - cb?: (err: any, data?: UpdateFirewallPolicyCommandOutput) => void - ): Promise | void { - const command = new UpdateFirewallPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the flag, ChangeProtection, which indicates whether it - * is possible to change the firewall. If the flag is set to TRUE, the firewall is protected - * from changes. This setting helps protect against accidentally changing a firewall that's in use.

+ * @see {@link UpdateFirewallPolicyChangeProtectionCommand} */ - public updateFirewallPolicyChangeProtection( + updateFirewallPolicyChangeProtection( args: UpdateFirewallPolicyChangeProtectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFirewallPolicyChangeProtection( + updateFirewallPolicyChangeProtection( args: UpdateFirewallPolicyChangeProtectionCommandInput, cb: (err: any, data?: UpdateFirewallPolicyChangeProtectionCommandOutput) => void ): void; - public updateFirewallPolicyChangeProtection( + updateFirewallPolicyChangeProtection( args: UpdateFirewallPolicyChangeProtectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFirewallPolicyChangeProtectionCommandOutput) => void ): void; - public updateFirewallPolicyChangeProtection( - args: UpdateFirewallPolicyChangeProtectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFirewallPolicyChangeProtectionCommandOutput) => void), - cb?: (err: any, data?: UpdateFirewallPolicyChangeProtectionCommandOutput) => void - ): Promise | void { - const command = new UpdateFirewallPolicyChangeProtectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the logging configuration for the specified firewall.

- *

To change the logging configuration, retrieve the LoggingConfiguration by calling DescribeLoggingConfiguration, then change it and provide - * the modified object to this update call. You must change the logging configuration one - * LogDestinationConfig at a time inside the retrieved LoggingConfiguration object.

- *

You can perform only one of the following actions in any call to - * UpdateLoggingConfiguration:

- *
    - *
  • - *

    Create a new log destination object by adding a single - * LogDestinationConfig array element to - * LogDestinationConfigs.

    - *
  • - *
  • - *

    Delete a log destination object by removing a single - * LogDestinationConfig array element from - * LogDestinationConfigs.

    - *
  • - *
  • - *

    Change the LogDestination setting in a single - * LogDestinationConfig array element.

    - *
  • - *
- *

You can't change the LogDestinationType or LogType in a - * LogDestinationConfig. To change these settings, delete the existing - * LogDestinationConfig object and create a new one, using two separate calls - * to this update operation.

+ * @see {@link UpdateLoggingConfigurationCommand} */ - public updateLoggingConfiguration( + updateLoggingConfiguration( args: UpdateLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLoggingConfiguration( + updateLoggingConfiguration( args: UpdateLoggingConfigurationCommandInput, cb: (err: any, data?: UpdateLoggingConfigurationCommandOutput) => void ): void; - public updateLoggingConfiguration( + updateLoggingConfiguration( args: UpdateLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLoggingConfigurationCommandOutput) => void ): void; - public updateLoggingConfiguration( - args: UpdateLoggingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the rule settings for the specified rule group. You use a rule group by - * reference in one or more firewall policies. When you modify a rule group, you modify all - * firewall policies that use the rule group.

- *

To update a rule group, first call DescribeRuleGroup to retrieve the - * current RuleGroup object, update the object as needed, and then provide - * the updated object to this call.

+ * @see {@link UpdateRuleGroupCommand} */ - public updateRuleGroup( + updateRuleGroup( args: UpdateRuleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRuleGroup( - args: UpdateRuleGroupCommandInput, - cb: (err: any, data?: UpdateRuleGroupCommandOutput) => void - ): void; - public updateRuleGroup( + updateRuleGroup(args: UpdateRuleGroupCommandInput, cb: (err: any, data?: UpdateRuleGroupCommandOutput) => void): void; + updateRuleGroup( args: UpdateRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRuleGroupCommandOutput) => void ): void; - public updateRuleGroup( - args: UpdateRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRuleGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateRuleGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

+ * @see {@link UpdateSubnetChangeProtectionCommand} */ - public updateSubnetChangeProtection( + updateSubnetChangeProtection( args: UpdateSubnetChangeProtectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSubnetChangeProtection( + updateSubnetChangeProtection( args: UpdateSubnetChangeProtectionCommandInput, cb: (err: any, data?: UpdateSubnetChangeProtectionCommandOutput) => void ): void; - public updateSubnetChangeProtection( + updateSubnetChangeProtection( args: UpdateSubnetChangeProtectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSubnetChangeProtectionCommandOutput) => void ): void; - public updateSubnetChangeProtection( - args: UpdateSubnetChangeProtectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSubnetChangeProtectionCommandOutput) => void), - cb?: (err: any, data?: UpdateSubnetChangeProtectionCommandOutput) => void - ): Promise | void { - const command = new UpdateSubnetChangeProtectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the TLS inspection configuration settings for the specified TLS inspection configuration. You use a TLS inspection configuration by - * reference in one or more firewall policies. When you modify a TLS inspection configuration, you modify all - * firewall policies that use the TLS inspection configuration.

- *

To update a TLS inspection configuration, first call DescribeTLSInspectionConfiguration to retrieve the - * current TLSInspectionConfiguration object, update the object as needed, and then provide - * the updated object to this call.

+ * @see {@link UpdateTLSInspectionConfigurationCommand} */ - public updateTLSInspectionConfiguration( + updateTLSInspectionConfiguration( args: UpdateTLSInspectionConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTLSInspectionConfiguration( + updateTLSInspectionConfiguration( args: UpdateTLSInspectionConfigurationCommandInput, cb: (err: any, data?: UpdateTLSInspectionConfigurationCommandOutput) => void ): void; - public updateTLSInspectionConfiguration( + updateTLSInspectionConfiguration( args: UpdateTLSInspectionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTLSInspectionConfigurationCommandOutput) => void ): void; - public updateTLSInspectionConfiguration( - args: UpdateTLSInspectionConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTLSInspectionConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateTLSInspectionConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateTLSInspectionConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

This is the API Reference for Network Firewall. This guide is for developers who need + * detailed information about the Network Firewall API actions, data types, and errors.

+ *
    + *
  • + *

    The REST API requires you to handle connection details, such as calculating + * signatures, handling request retries, and error handling. For general information + * about using the Amazon Web Services REST APIs, see Amazon Web Services APIs.

    + *

    To access Network Firewall using the REST API endpoint: + * https://network-firewall..amazonaws.com + *

    + *
  • + *
  • + *

    Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to + * the programming language or platform that you're using. For more information, see + * Amazon Web Services SDKs.

    + *
  • + *
  • + *

    For descriptions of Network Firewall features, including and step-by-step + * instructions on how to use them through the Network Firewall console, see the Network Firewall Developer + * Guide.

    + *
  • + *
+ *

Network Firewall is a stateful, managed, network firewall and intrusion detection and + * prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the + * perimeter of your VPC. This includes filtering traffic going to and coming from an internet + * gateway, NAT gateway, or over VPN or Direct Connect. Network Firewall uses rules that are compatible + * with Suricata, a free, open source network analysis and threat detection engine. + * Network Firewall supports Suricata version 6.0.9. For information about Suricata, + * see the Suricata website.

+ *

You can use Network Firewall to monitor and protect your VPC traffic in a number of ways. + * The following are just a few examples:

+ *
    + *
  • + *

    Allow domains or IP addresses for known Amazon Web Services service endpoints, such as Amazon S3, and + * block all other forms of traffic.

    + *
  • + *
  • + *

    Use custom lists of known bad domains to limit the types of domain names that your + * applications can access.

    + *
  • + *
  • + *

    Perform deep packet inspection on traffic entering or leaving your VPC.

    + *
  • + *
  • + *

    Use stateful protocol detection to filter protocols like HTTPS, regardless of the + * port used.

    + *
  • + *
+ *

To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in + * Network Firewall. For information about using Amazon VPC, see Amazon VPC User Guide.

+ *

To start using Network Firewall, do the following:

+ *
    + *
  1. + *

    (Optional) If you don't already have a VPC that you want to protect, create it in + * Amazon VPC.

    + *
  2. + *
  3. + *

    In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a + * subnet for the sole use of Network Firewall.

    + *
  4. + *
  5. + *

    In Network Firewall, create stateless and stateful rule groups, + * to define the components of the network traffic filtering behavior that you want your firewall to have.

    + *
  6. + *
  7. + *

    In Network Firewall, create a firewall policy that uses your rule groups and + * specifies additional default traffic filtering behavior.

    + *
  8. + *
  9. + *

    In Network Firewall, create a firewall and specify your new firewall policy and + * VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you + * specify, with the behavior that's defined in the firewall policy.

    + *
  10. + *
  11. + *

    In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall + * endpoints.

    + *
  12. + *
+ */ +export class NetworkFirewall extends NetworkFirewallClient implements NetworkFirewall {} +createAggregatedClient(commands, NetworkFirewall); diff --git a/clients/client-networkmanager/src/NetworkManager.ts b/clients/client-networkmanager/src/NetworkManager.ts index 89cc58b2bcc4..f0de055e3c3a 100644 --- a/clients/client-networkmanager/src/NetworkManager.ts +++ b/clients/client-networkmanager/src/NetworkManager.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -386,2796 +387,1432 @@ import { UpdateVpcAttachmentCommandInput, UpdateVpcAttachmentCommandOutput, } from "./commands/UpdateVpcAttachmentCommand"; -import { NetworkManagerClient } from "./NetworkManagerClient"; +import { NetworkManagerClient, NetworkManagerClientConfig } from "./NetworkManagerClient"; -/** - * @public - *

Amazon Web Services enables you to centrally manage your Amazon Web Services Cloud WAN core network and your Transit Gateway network across Amazon Web Services accounts, Regions, and on-premises locations.

- */ -export class NetworkManager extends NetworkManagerClient { +const commands = { + AcceptAttachmentCommand, + AssociateConnectPeerCommand, + AssociateCustomerGatewayCommand, + AssociateLinkCommand, + AssociateTransitGatewayConnectPeerCommand, + CreateConnectAttachmentCommand, + CreateConnectionCommand, + CreateConnectPeerCommand, + CreateCoreNetworkCommand, + CreateDeviceCommand, + CreateGlobalNetworkCommand, + CreateLinkCommand, + CreateSiteCommand, + CreateSiteToSiteVpnAttachmentCommand, + CreateTransitGatewayPeeringCommand, + CreateTransitGatewayRouteTableAttachmentCommand, + CreateVpcAttachmentCommand, + DeleteAttachmentCommand, + DeleteConnectionCommand, + DeleteConnectPeerCommand, + DeleteCoreNetworkCommand, + DeleteCoreNetworkPolicyVersionCommand, + DeleteDeviceCommand, + DeleteGlobalNetworkCommand, + DeleteLinkCommand, + DeletePeeringCommand, + DeleteResourcePolicyCommand, + DeleteSiteCommand, + DeregisterTransitGatewayCommand, + DescribeGlobalNetworksCommand, + DisassociateConnectPeerCommand, + DisassociateCustomerGatewayCommand, + DisassociateLinkCommand, + DisassociateTransitGatewayConnectPeerCommand, + ExecuteCoreNetworkChangeSetCommand, + GetConnectAttachmentCommand, + GetConnectionsCommand, + GetConnectPeerCommand, + GetConnectPeerAssociationsCommand, + GetCoreNetworkCommand, + GetCoreNetworkChangeEventsCommand, + GetCoreNetworkChangeSetCommand, + GetCoreNetworkPolicyCommand, + GetCustomerGatewayAssociationsCommand, + GetDevicesCommand, + GetLinkAssociationsCommand, + GetLinksCommand, + GetNetworkResourceCountsCommand, + GetNetworkResourceRelationshipsCommand, + GetNetworkResourcesCommand, + GetNetworkRoutesCommand, + GetNetworkTelemetryCommand, + GetResourcePolicyCommand, + GetRouteAnalysisCommand, + GetSitesCommand, + GetSiteToSiteVpnAttachmentCommand, + GetTransitGatewayConnectPeerAssociationsCommand, + GetTransitGatewayPeeringCommand, + GetTransitGatewayRegistrationsCommand, + GetTransitGatewayRouteTableAttachmentCommand, + GetVpcAttachmentCommand, + ListAttachmentsCommand, + ListConnectPeersCommand, + ListCoreNetworkPolicyVersionsCommand, + ListCoreNetworksCommand, + ListOrganizationServiceAccessStatusCommand, + ListPeeringsCommand, + ListTagsForResourceCommand, + PutCoreNetworkPolicyCommand, + PutResourcePolicyCommand, + RegisterTransitGatewayCommand, + RejectAttachmentCommand, + RestoreCoreNetworkPolicyVersionCommand, + StartOrganizationServiceAccessUpdateCommand, + StartRouteAnalysisCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateConnectionCommand, + UpdateCoreNetworkCommand, + UpdateDeviceCommand, + UpdateGlobalNetworkCommand, + UpdateLinkCommand, + UpdateNetworkResourceMetadataCommand, + UpdateSiteCommand, + UpdateVpcAttachmentCommand, +}; + +export interface NetworkManager { /** - * @public - *

Accepts a core network attachment request.

- *

Once the attachment request is accepted by a core network owner, the attachment is - * created and connected to a core network.

+ * @see {@link AcceptAttachmentCommand} */ - public acceptAttachment( + acceptAttachment( args: AcceptAttachmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptAttachment( + acceptAttachment( args: AcceptAttachmentCommandInput, cb: (err: any, data?: AcceptAttachmentCommandOutput) => void ): void; - public acceptAttachment( + acceptAttachment( args: AcceptAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptAttachmentCommandOutput) => void ): void; - public acceptAttachment( - args: AcceptAttachmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptAttachmentCommandOutput) => void), - cb?: (err: any, data?: AcceptAttachmentCommandOutput) => void - ): Promise | void { - const command = new AcceptAttachmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a core network Connect peer with a device and optionally, with a link.

- *

If you specify a link, it must be associated with the specified device. You can only - * associate core network Connect peers that have been created on a core network Connect - * attachment on a core network.

- */ - public associateConnectPeer( + + /** + * @see {@link AssociateConnectPeerCommand} + */ + associateConnectPeer( args: AssociateConnectPeerCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateConnectPeer( + associateConnectPeer( args: AssociateConnectPeerCommandInput, cb: (err: any, data?: AssociateConnectPeerCommandOutput) => void ): void; - public associateConnectPeer( + associateConnectPeer( args: AssociateConnectPeerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateConnectPeerCommandOutput) => void ): void; - public associateConnectPeer( - args: AssociateConnectPeerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateConnectPeerCommandOutput) => void), - cb?: (err: any, data?: AssociateConnectPeerCommandOutput) => void - ): Promise | void { - const command = new AssociateConnectPeerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a customer gateway with a device and optionally, with a link. If you - * specify a link, it must be associated with the specified device.

- *

You can only associate customer gateways that are connected to a VPN attachment on a - * transit gateway or core network registered in your global network. When you register a - * transit gateway or core network, customer gateways that are connected to the transit - * gateway are automatically included in the global network. To list customer gateways - * that are connected to a transit gateway, use the DescribeVpnConnections EC2 API and filter by - * transit-gateway-id.

- *

You cannot associate a customer gateway with more than one device and link.

- */ - public associateCustomerGateway( + + /** + * @see {@link AssociateCustomerGatewayCommand} + */ + associateCustomerGateway( args: AssociateCustomerGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateCustomerGateway( + associateCustomerGateway( args: AssociateCustomerGatewayCommandInput, cb: (err: any, data?: AssociateCustomerGatewayCommandOutput) => void ): void; - public associateCustomerGateway( + associateCustomerGateway( args: AssociateCustomerGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateCustomerGatewayCommandOutput) => void ): void; - public associateCustomerGateway( - args: AssociateCustomerGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateCustomerGatewayCommandOutput) => void), - cb?: (err: any, data?: AssociateCustomerGatewayCommandOutput) => void - ): Promise | void { - const command = new AssociateCustomerGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a link to a device. A device can be associated to multiple links and a link can be associated to multiple devices. The device and link must be in the same global network and the same site.

- */ - public associateLink( - args: AssociateLinkCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public associateLink( - args: AssociateLinkCommandInput, - cb: (err: any, data?: AssociateLinkCommandOutput) => void - ): void; - public associateLink( + + /** + * @see {@link AssociateLinkCommand} + */ + associateLink(args: AssociateLinkCommandInput, options?: __HttpHandlerOptions): Promise; + associateLink(args: AssociateLinkCommandInput, cb: (err: any, data?: AssociateLinkCommandOutput) => void): void; + associateLink( args: AssociateLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateLinkCommandOutput) => void ): void; - public associateLink( - args: AssociateLinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateLinkCommandOutput) => void), - cb?: (err: any, data?: AssociateLinkCommandOutput) => void - ): Promise | void { - const command = new AssociateLinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a transit gateway Connect peer with a device, and optionally, with a link. If you - * specify a link, it must be associated with the specified device.

- *

You can only associate transit gateway Connect peers that have been created on a - * transit gateway that's registered in your global network.

- *

You cannot associate a transit gateway Connect peer with more than one device and link.

- */ - public associateTransitGatewayConnectPeer( + + /** + * @see {@link AssociateTransitGatewayConnectPeerCommand} + */ + associateTransitGatewayConnectPeer( args: AssociateTransitGatewayConnectPeerCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateTransitGatewayConnectPeer( + associateTransitGatewayConnectPeer( args: AssociateTransitGatewayConnectPeerCommandInput, cb: (err: any, data?: AssociateTransitGatewayConnectPeerCommandOutput) => void ): void; - public associateTransitGatewayConnectPeer( + associateTransitGatewayConnectPeer( args: AssociateTransitGatewayConnectPeerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateTransitGatewayConnectPeerCommandOutput) => void ): void; - public associateTransitGatewayConnectPeer( - args: AssociateTransitGatewayConnectPeerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateTransitGatewayConnectPeerCommandOutput) => void), - cb?: (err: any, data?: AssociateTransitGatewayConnectPeerCommandOutput) => void - ): Promise | void { - const command = new AssociateTransitGatewayConnectPeerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a core network Connect attachment from a specified core network attachment.

- *

A core network Connect attachment is a GRE-based tunnel attachment that you can use to - * establish a connection between a core network and an appliance. A core network Connect - * attachment uses an existing VPC attachment as the underlying transport mechanism.

- */ - public createConnectAttachment( + + /** + * @see {@link CreateConnectAttachmentCommand} + */ + createConnectAttachment( args: CreateConnectAttachmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConnectAttachment( + createConnectAttachment( args: CreateConnectAttachmentCommandInput, cb: (err: any, data?: CreateConnectAttachmentCommandOutput) => void ): void; - public createConnectAttachment( + createConnectAttachment( args: CreateConnectAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectAttachmentCommandOutput) => void ): void; - public createConnectAttachment( - args: CreateConnectAttachmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConnectAttachmentCommandOutput) => void), - cb?: (err: any, data?: CreateConnectAttachmentCommandOutput) => void - ): Promise | void { - const command = new CreateConnectAttachmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a connection between two devices. The devices can be a physical or virtual appliance that connects to a third-party appliance in a VPC, or a physical appliance that connects to another physical appliance in an on-premises network.

- */ - public createConnection( + + /** + * @see {@link CreateConnectionCommand} + */ + createConnection( args: CreateConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConnection( + createConnection( args: CreateConnectionCommandInput, cb: (err: any, data?: CreateConnectionCommandOutput) => void ): void; - public createConnection( + createConnection( args: CreateConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectionCommandOutput) => void ): void; - public createConnection( - args: CreateConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConnectionCommandOutput) => void), - cb?: (err: any, data?: CreateConnectionCommandOutput) => void - ): Promise | void { - const command = new CreateConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance. - * The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

- */ - public createConnectPeer( + + /** + * @see {@link CreateConnectPeerCommand} + */ + createConnectPeer( args: CreateConnectPeerCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConnectPeer( + createConnectPeer( args: CreateConnectPeerCommandInput, cb: (err: any, data?: CreateConnectPeerCommandOutput) => void ): void; - public createConnectPeer( + createConnectPeer( args: CreateConnectPeerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectPeerCommandOutput) => void ): void; - public createConnectPeer( - args: CreateConnectPeerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConnectPeerCommandOutput) => void), - cb?: (err: any, data?: CreateConnectPeerCommandOutput) => void - ): Promise | void { - const command = new CreateConnectPeerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a core network as part of your global network, and optionally, with a core network policy.

- */ - public createCoreNetwork( + + /** + * @see {@link CreateCoreNetworkCommand} + */ + createCoreNetwork( args: CreateCoreNetworkCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCoreNetwork( + createCoreNetwork( args: CreateCoreNetworkCommandInput, cb: (err: any, data?: CreateCoreNetworkCommandOutput) => void ): void; - public createCoreNetwork( + createCoreNetwork( args: CreateCoreNetworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCoreNetworkCommandOutput) => void ): void; - public createCoreNetwork( - args: CreateCoreNetworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCoreNetworkCommandOutput) => void), - cb?: (err: any, data?: CreateCoreNetworkCommandOutput) => void - ): Promise | void { - const command = new CreateCoreNetworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new device in a global network. If you specify both a site ID and a - * location, the location of the site is used for visualization in the Network Manager console.

- */ - public createDevice( - args: CreateDeviceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createDevice(args: CreateDeviceCommandInput, cb: (err: any, data?: CreateDeviceCommandOutput) => void): void; - public createDevice( + + /** + * @see {@link CreateDeviceCommand} + */ + createDevice(args: CreateDeviceCommandInput, options?: __HttpHandlerOptions): Promise; + createDevice(args: CreateDeviceCommandInput, cb: (err: any, data?: CreateDeviceCommandOutput) => void): void; + createDevice( args: CreateDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeviceCommandOutput) => void ): void; - public createDevice( - args: CreateDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDeviceCommandOutput) => void), - cb?: (err: any, data?: CreateDeviceCommandOutput) => void - ): Promise | void { - const command = new CreateDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new, empty global network.

- */ - public createGlobalNetwork( + + /** + * @see {@link CreateGlobalNetworkCommand} + */ + createGlobalNetwork( args: CreateGlobalNetworkCommandInput, options?: __HttpHandlerOptions ): Promise; - public createGlobalNetwork( + createGlobalNetwork( args: CreateGlobalNetworkCommandInput, cb: (err: any, data?: CreateGlobalNetworkCommandOutput) => void ): void; - public createGlobalNetwork( + createGlobalNetwork( args: CreateGlobalNetworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGlobalNetworkCommandOutput) => void ): void; - public createGlobalNetwork( - args: CreateGlobalNetworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGlobalNetworkCommandOutput) => void), - cb?: (err: any, data?: CreateGlobalNetworkCommandOutput) => void - ): Promise | void { - const command = new CreateGlobalNetworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new link for a specified site.

- */ - public createLink(args: CreateLinkCommandInput, options?: __HttpHandlerOptions): Promise; - public createLink(args: CreateLinkCommandInput, cb: (err: any, data?: CreateLinkCommandOutput) => void): void; - public createLink( + + /** + * @see {@link CreateLinkCommand} + */ + createLink(args: CreateLinkCommandInput, options?: __HttpHandlerOptions): Promise; + createLink(args: CreateLinkCommandInput, cb: (err: any, data?: CreateLinkCommandOutput) => void): void; + createLink( args: CreateLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLinkCommandOutput) => void ): void; - public createLink( - args: CreateLinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLinkCommandOutput) => void), - cb?: (err: any, data?: CreateLinkCommandOutput) => void - ): Promise | void { - const command = new CreateLinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new site in a global network.

- */ - public createSite(args: CreateSiteCommandInput, options?: __HttpHandlerOptions): Promise; - public createSite(args: CreateSiteCommandInput, cb: (err: any, data?: CreateSiteCommandOutput) => void): void; - public createSite( + + /** + * @see {@link CreateSiteCommand} + */ + createSite(args: CreateSiteCommandInput, options?: __HttpHandlerOptions): Promise; + createSite(args: CreateSiteCommandInput, cb: (err: any, data?: CreateSiteCommandOutput) => void): void; + createSite( args: CreateSiteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSiteCommandOutput) => void ): void; - public createSite( - args: CreateSiteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSiteCommandOutput) => void), - cb?: (err: any, data?: CreateSiteCommandOutput) => void - ): Promise | void { - const command = new CreateSiteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.

- */ - public createSiteToSiteVpnAttachment( + + /** + * @see {@link CreateSiteToSiteVpnAttachmentCommand} + */ + createSiteToSiteVpnAttachment( args: CreateSiteToSiteVpnAttachmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSiteToSiteVpnAttachment( + createSiteToSiteVpnAttachment( args: CreateSiteToSiteVpnAttachmentCommandInput, cb: (err: any, data?: CreateSiteToSiteVpnAttachmentCommandOutput) => void ): void; - public createSiteToSiteVpnAttachment( + createSiteToSiteVpnAttachment( args: CreateSiteToSiteVpnAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSiteToSiteVpnAttachmentCommandOutput) => void ): void; - public createSiteToSiteVpnAttachment( - args: CreateSiteToSiteVpnAttachmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSiteToSiteVpnAttachmentCommandOutput) => void), - cb?: (err: any, data?: CreateSiteToSiteVpnAttachmentCommandOutput) => void - ): Promise | void { - const command = new CreateSiteToSiteVpnAttachmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a transit gateway peering connection.

- */ - public createTransitGatewayPeering( + + /** + * @see {@link CreateTransitGatewayPeeringCommand} + */ + createTransitGatewayPeering( args: CreateTransitGatewayPeeringCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTransitGatewayPeering( + createTransitGatewayPeering( args: CreateTransitGatewayPeeringCommandInput, cb: (err: any, data?: CreateTransitGatewayPeeringCommandOutput) => void ): void; - public createTransitGatewayPeering( + createTransitGatewayPeering( args: CreateTransitGatewayPeeringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTransitGatewayPeeringCommandOutput) => void ): void; - public createTransitGatewayPeering( - args: CreateTransitGatewayPeeringCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTransitGatewayPeeringCommandOutput) => void), - cb?: (err: any, data?: CreateTransitGatewayPeeringCommandOutput) => void - ): Promise | void { - const command = new CreateTransitGatewayPeeringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a transit gateway route table attachment.

- */ - public createTransitGatewayRouteTableAttachment( + + /** + * @see {@link CreateTransitGatewayRouteTableAttachmentCommand} + */ + createTransitGatewayRouteTableAttachment( args: CreateTransitGatewayRouteTableAttachmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTransitGatewayRouteTableAttachment( + createTransitGatewayRouteTableAttachment( args: CreateTransitGatewayRouteTableAttachmentCommandInput, cb: (err: any, data?: CreateTransitGatewayRouteTableAttachmentCommandOutput) => void ): void; - public createTransitGatewayRouteTableAttachment( + createTransitGatewayRouteTableAttachment( args: CreateTransitGatewayRouteTableAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTransitGatewayRouteTableAttachmentCommandOutput) => void ): void; - public createTransitGatewayRouteTableAttachment( - args: CreateTransitGatewayRouteTableAttachmentCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateTransitGatewayRouteTableAttachmentCommandOutput) => void), - cb?: (err: any, data?: CreateTransitGatewayRouteTableAttachmentCommandOutput) => void - ): Promise | void { - const command = new CreateTransitGatewayRouteTableAttachmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a VPC attachment on an edge location of a core network.

- */ - public createVpcAttachment( + + /** + * @see {@link CreateVpcAttachmentCommand} + */ + createVpcAttachment( args: CreateVpcAttachmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVpcAttachment( + createVpcAttachment( args: CreateVpcAttachmentCommandInput, cb: (err: any, data?: CreateVpcAttachmentCommandOutput) => void ): void; - public createVpcAttachment( + createVpcAttachment( args: CreateVpcAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVpcAttachmentCommandOutput) => void ): void; - public createVpcAttachment( - args: CreateVpcAttachmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVpcAttachmentCommandOutput) => void), - cb?: (err: any, data?: CreateVpcAttachmentCommandOutput) => void - ): Promise | void { - const command = new CreateVpcAttachmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an attachment. Supports all attachment types.

- */ - public deleteAttachment( + + /** + * @see {@link DeleteAttachmentCommand} + */ + deleteAttachment( args: DeleteAttachmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAttachment( + deleteAttachment( args: DeleteAttachmentCommandInput, cb: (err: any, data?: DeleteAttachmentCommandOutput) => void ): void; - public deleteAttachment( + deleteAttachment( args: DeleteAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAttachmentCommandOutput) => void ): void; - public deleteAttachment( - args: DeleteAttachmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAttachmentCommandOutput) => void), - cb?: (err: any, data?: DeleteAttachmentCommandOutput) => void - ): Promise | void { - const command = new DeleteAttachmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified connection in your global network.

- */ - public deleteConnection( + + /** + * @see {@link DeleteConnectionCommand} + */ + deleteConnection( args: DeleteConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, cb: (err: any, data?: DeleteConnectionCommandOutput) => void ): void; - public deleteConnection( + deleteConnection( args: DeleteConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectionCommandOutput) => void ): void; - public deleteConnection( - args: DeleteConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConnectionCommandOutput) => void), - cb?: (err: any, data?: DeleteConnectionCommandOutput) => void - ): Promise | void { - const command = new DeleteConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a Connect peer.

- */ - public deleteConnectPeer( + + /** + * @see {@link DeleteConnectPeerCommand} + */ + deleteConnectPeer( args: DeleteConnectPeerCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConnectPeer( + deleteConnectPeer( args: DeleteConnectPeerCommandInput, cb: (err: any, data?: DeleteConnectPeerCommandOutput) => void ): void; - public deleteConnectPeer( + deleteConnectPeer( args: DeleteConnectPeerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectPeerCommandOutput) => void ): void; - public deleteConnectPeer( - args: DeleteConnectPeerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConnectPeerCommandOutput) => void), - cb?: (err: any, data?: DeleteConnectPeerCommandOutput) => void - ): Promise | void { - const command = new DeleteConnectPeerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a core network along with all core network policies. This can only be done if there are no attachments on a core network.

- */ - public deleteCoreNetwork( + + /** + * @see {@link DeleteCoreNetworkCommand} + */ + deleteCoreNetwork( args: DeleteCoreNetworkCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCoreNetwork( + deleteCoreNetwork( args: DeleteCoreNetworkCommandInput, cb: (err: any, data?: DeleteCoreNetworkCommandOutput) => void ): void; - public deleteCoreNetwork( + deleteCoreNetwork( args: DeleteCoreNetworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCoreNetworkCommandOutput) => void ): void; - public deleteCoreNetwork( - args: DeleteCoreNetworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCoreNetworkCommandOutput) => void), - cb?: (err: any, data?: DeleteCoreNetworkCommandOutput) => void - ): Promise | void { - const command = new DeleteCoreNetworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a policy version from a core network. You can't delete the current LIVE policy.

- */ - public deleteCoreNetworkPolicyVersion( + + /** + * @see {@link DeleteCoreNetworkPolicyVersionCommand} + */ + deleteCoreNetworkPolicyVersion( args: DeleteCoreNetworkPolicyVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCoreNetworkPolicyVersion( + deleteCoreNetworkPolicyVersion( args: DeleteCoreNetworkPolicyVersionCommandInput, cb: (err: any, data?: DeleteCoreNetworkPolicyVersionCommandOutput) => void ): void; - public deleteCoreNetworkPolicyVersion( + deleteCoreNetworkPolicyVersion( args: DeleteCoreNetworkPolicyVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCoreNetworkPolicyVersionCommandOutput) => void ): void; - public deleteCoreNetworkPolicyVersion( - args: DeleteCoreNetworkPolicyVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCoreNetworkPolicyVersionCommandOutput) => void), - cb?: (err: any, data?: DeleteCoreNetworkPolicyVersionCommandOutput) => void - ): Promise | void { - const command = new DeleteCoreNetworkPolicyVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an existing device. You must first disassociate the device from any links and - * customer gateways.

- */ - public deleteDevice( - args: DeleteDeviceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDevice(args: DeleteDeviceCommandInput, cb: (err: any, data?: DeleteDeviceCommandOutput) => void): void; - public deleteDevice( + + /** + * @see {@link DeleteDeviceCommand} + */ + deleteDevice(args: DeleteDeviceCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDevice(args: DeleteDeviceCommandInput, cb: (err: any, data?: DeleteDeviceCommandOutput) => void): void; + deleteDevice( args: DeleteDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDeviceCommandOutput) => void ): void; - public deleteDevice( - args: DeleteDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDeviceCommandOutput) => void), - cb?: (err: any, data?: DeleteDeviceCommandOutput) => void - ): Promise | void { - const command = new DeleteDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an existing global network. You must first delete all global network objects - * (devices, links, and sites), deregister all transit gateways, and delete any core networks.

- */ - public deleteGlobalNetwork( + + /** + * @see {@link DeleteGlobalNetworkCommand} + */ + deleteGlobalNetwork( args: DeleteGlobalNetworkCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteGlobalNetwork( + deleteGlobalNetwork( args: DeleteGlobalNetworkCommandInput, cb: (err: any, data?: DeleteGlobalNetworkCommandOutput) => void ): void; - public deleteGlobalNetwork( + deleteGlobalNetwork( args: DeleteGlobalNetworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGlobalNetworkCommandOutput) => void ): void; - public deleteGlobalNetwork( - args: DeleteGlobalNetworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGlobalNetworkCommandOutput) => void), - cb?: (err: any, data?: DeleteGlobalNetworkCommandOutput) => void - ): Promise | void { - const command = new DeleteGlobalNetworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an existing link. You must first disassociate the link from any devices and - * customer gateways.

- */ - public deleteLink(args: DeleteLinkCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteLink(args: DeleteLinkCommandInput, cb: (err: any, data?: DeleteLinkCommandOutput) => void): void; - public deleteLink( + + /** + * @see {@link DeleteLinkCommand} + */ + deleteLink(args: DeleteLinkCommandInput, options?: __HttpHandlerOptions): Promise; + deleteLink(args: DeleteLinkCommandInput, cb: (err: any, data?: DeleteLinkCommandOutput) => void): void; + deleteLink( args: DeleteLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLinkCommandOutput) => void ): void; - public deleteLink( - args: DeleteLinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLinkCommandOutput) => void), - cb?: (err: any, data?: DeleteLinkCommandOutput) => void - ): Promise | void { - const command = new DeleteLinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an existing peering connection.

- */ - public deletePeering( - args: DeletePeeringCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deletePeering( - args: DeletePeeringCommandInput, - cb: (err: any, data?: DeletePeeringCommandOutput) => void - ): void; - public deletePeering( + + /** + * @see {@link DeletePeeringCommand} + */ + deletePeering(args: DeletePeeringCommandInput, options?: __HttpHandlerOptions): Promise; + deletePeering(args: DeletePeeringCommandInput, cb: (err: any, data?: DeletePeeringCommandOutput) => void): void; + deletePeering( args: DeletePeeringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePeeringCommandOutput) => void ): void; - public deletePeering( - args: DeletePeeringCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePeeringCommandOutput) => void), - cb?: (err: any, data?: DeletePeeringCommandOutput) => void - ): Promise | void { - const command = new DeletePeeringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a resource policy for the specified resource. This revokes the access of the principals specified in the resource policy.

- */ - public deleteResourcePolicy( + + /** + * @see {@link DeleteResourcePolicyCommand} + */ + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( - args: DeleteResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an existing site. The site cannot be associated with any device or link.

- */ - public deleteSite(args: DeleteSiteCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteSite(args: DeleteSiteCommandInput, cb: (err: any, data?: DeleteSiteCommandOutput) => void): void; - public deleteSite( + + /** + * @see {@link DeleteSiteCommand} + */ + deleteSite(args: DeleteSiteCommandInput, options?: __HttpHandlerOptions): Promise; + deleteSite(args: DeleteSiteCommandInput, cb: (err: any, data?: DeleteSiteCommandOutput) => void): void; + deleteSite( args: DeleteSiteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSiteCommandOutput) => void ): void; - public deleteSite( - args: DeleteSiteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSiteCommandOutput) => void), - cb?: (err: any, data?: DeleteSiteCommandOutput) => void - ): Promise | void { - const command = new DeleteSiteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deregisters a transit gateway from your global network. This action does not delete - * your transit gateway, or modify any of its attachments. This action removes any customer gateway associations.

- */ - public deregisterTransitGateway( + + /** + * @see {@link DeregisterTransitGatewayCommand} + */ + deregisterTransitGateway( args: DeregisterTransitGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterTransitGateway( + deregisterTransitGateway( args: DeregisterTransitGatewayCommandInput, cb: (err: any, data?: DeregisterTransitGatewayCommandOutput) => void ): void; - public deregisterTransitGateway( + deregisterTransitGateway( args: DeregisterTransitGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterTransitGatewayCommandOutput) => void ): void; - public deregisterTransitGateway( - args: DeregisterTransitGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterTransitGatewayCommandOutput) => void), - cb?: (err: any, data?: DeregisterTransitGatewayCommandOutput) => void - ): Promise | void { - const command = new DeregisterTransitGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more global networks. By default, all global networks are - * described. To describe the objects in your global network, you must use the appropriate - * Get* action. For example, to list the transit gateways in your global - * network, use GetTransitGatewayRegistrations.

- */ - public describeGlobalNetworks( + + /** + * @see {@link DescribeGlobalNetworksCommand} + */ + describeGlobalNetworks( args: DescribeGlobalNetworksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGlobalNetworks( + describeGlobalNetworks( args: DescribeGlobalNetworksCommandInput, cb: (err: any, data?: DescribeGlobalNetworksCommandOutput) => void ): void; - public describeGlobalNetworks( + describeGlobalNetworks( args: DescribeGlobalNetworksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGlobalNetworksCommandOutput) => void ): void; - public describeGlobalNetworks( - args: DescribeGlobalNetworksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGlobalNetworksCommandOutput) => void), - cb?: (err: any, data?: DescribeGlobalNetworksCommandOutput) => void - ): Promise | void { - const command = new DescribeGlobalNetworksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a core network Connect peer from a device and a link.

- */ - public disassociateConnectPeer( + + /** + * @see {@link DisassociateConnectPeerCommand} + */ + disassociateConnectPeer( args: DisassociateConnectPeerCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateConnectPeer( + disassociateConnectPeer( args: DisassociateConnectPeerCommandInput, cb: (err: any, data?: DisassociateConnectPeerCommandOutput) => void ): void; - public disassociateConnectPeer( + disassociateConnectPeer( args: DisassociateConnectPeerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateConnectPeerCommandOutput) => void ): void; - public disassociateConnectPeer( - args: DisassociateConnectPeerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateConnectPeerCommandOutput) => void), - cb?: (err: any, data?: DisassociateConnectPeerCommandOutput) => void - ): Promise | void { - const command = new DisassociateConnectPeerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a customer gateway from a device and a link.

- */ - public disassociateCustomerGateway( + + /** + * @see {@link DisassociateCustomerGatewayCommand} + */ + disassociateCustomerGateway( args: DisassociateCustomerGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateCustomerGateway( + disassociateCustomerGateway( args: DisassociateCustomerGatewayCommandInput, cb: (err: any, data?: DisassociateCustomerGatewayCommandOutput) => void ): void; - public disassociateCustomerGateway( + disassociateCustomerGateway( args: DisassociateCustomerGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateCustomerGatewayCommandOutput) => void ): void; - public disassociateCustomerGateway( - args: DisassociateCustomerGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateCustomerGatewayCommandOutput) => void), - cb?: (err: any, data?: DisassociateCustomerGatewayCommandOutput) => void - ): Promise | void { - const command = new DisassociateCustomerGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates an existing device from a link. You must first disassociate any customer - * gateways that are associated with the link.

- */ - public disassociateLink( + + /** + * @see {@link DisassociateLinkCommand} + */ + disassociateLink( args: DisassociateLinkCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateLink( + disassociateLink( args: DisassociateLinkCommandInput, cb: (err: any, data?: DisassociateLinkCommandOutput) => void ): void; - public disassociateLink( + disassociateLink( args: DisassociateLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateLinkCommandOutput) => void ): void; - public disassociateLink( - args: DisassociateLinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateLinkCommandOutput) => void), - cb?: (err: any, data?: DisassociateLinkCommandOutput) => void - ): Promise | void { - const command = new DisassociateLinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a transit gateway Connect peer from a device and link.

- */ - public disassociateTransitGatewayConnectPeer( + + /** + * @see {@link DisassociateTransitGatewayConnectPeerCommand} + */ + disassociateTransitGatewayConnectPeer( args: DisassociateTransitGatewayConnectPeerCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateTransitGatewayConnectPeer( + disassociateTransitGatewayConnectPeer( args: DisassociateTransitGatewayConnectPeerCommandInput, cb: (err: any, data?: DisassociateTransitGatewayConnectPeerCommandOutput) => void ): void; - public disassociateTransitGatewayConnectPeer( + disassociateTransitGatewayConnectPeer( args: DisassociateTransitGatewayConnectPeerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateTransitGatewayConnectPeerCommandOutput) => void ): void; - public disassociateTransitGatewayConnectPeer( - args: DisassociateTransitGatewayConnectPeerCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociateTransitGatewayConnectPeerCommandOutput) => void), - cb?: (err: any, data?: DisassociateTransitGatewayConnectPeerCommandOutput) => void - ): Promise | void { - const command = new DisassociateTransitGatewayConnectPeerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Executes a change set on your core network. Deploys changes globally based on the policy submitted..

- */ - public executeCoreNetworkChangeSet( + + /** + * @see {@link ExecuteCoreNetworkChangeSetCommand} + */ + executeCoreNetworkChangeSet( args: ExecuteCoreNetworkChangeSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public executeCoreNetworkChangeSet( + executeCoreNetworkChangeSet( args: ExecuteCoreNetworkChangeSetCommandInput, cb: (err: any, data?: ExecuteCoreNetworkChangeSetCommandOutput) => void ): void; - public executeCoreNetworkChangeSet( + executeCoreNetworkChangeSet( args: ExecuteCoreNetworkChangeSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteCoreNetworkChangeSetCommandOutput) => void ): void; - public executeCoreNetworkChangeSet( - args: ExecuteCoreNetworkChangeSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExecuteCoreNetworkChangeSetCommandOutput) => void), - cb?: (err: any, data?: ExecuteCoreNetworkChangeSetCommandOutput) => void - ): Promise | void { - const command = new ExecuteCoreNetworkChangeSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a core network Connect attachment.

- */ - public getConnectAttachment( + + /** + * @see {@link GetConnectAttachmentCommand} + */ + getConnectAttachment( args: GetConnectAttachmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConnectAttachment( + getConnectAttachment( args: GetConnectAttachmentCommandInput, cb: (err: any, data?: GetConnectAttachmentCommandOutput) => void ): void; - public getConnectAttachment( + getConnectAttachment( args: GetConnectAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConnectAttachmentCommandOutput) => void ): void; - public getConnectAttachment( - args: GetConnectAttachmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConnectAttachmentCommandOutput) => void), - cb?: (err: any, data?: GetConnectAttachmentCommandOutput) => void - ): Promise | void { - const command = new GetConnectAttachmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about one or more of your connections in a global network.

- */ - public getConnections( + + /** + * @see {@link GetConnectionsCommand} + */ + getConnections( args: GetConnectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConnections( - args: GetConnectionsCommandInput, - cb: (err: any, data?: GetConnectionsCommandOutput) => void - ): void; - public getConnections( + getConnections(args: GetConnectionsCommandInput, cb: (err: any, data?: GetConnectionsCommandOutput) => void): void; + getConnections( args: GetConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConnectionsCommandOutput) => void ): void; - public getConnections( - args: GetConnectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConnectionsCommandOutput) => void), - cb?: (err: any, data?: GetConnectionsCommandOutput) => void - ): Promise | void { - const command = new GetConnectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a core network Connect peer.

- */ - public getConnectPeer( + + /** + * @see {@link GetConnectPeerCommand} + */ + getConnectPeer( args: GetConnectPeerCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConnectPeer( - args: GetConnectPeerCommandInput, - cb: (err: any, data?: GetConnectPeerCommandOutput) => void - ): void; - public getConnectPeer( + getConnectPeer(args: GetConnectPeerCommandInput, cb: (err: any, data?: GetConnectPeerCommandOutput) => void): void; + getConnectPeer( args: GetConnectPeerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConnectPeerCommandOutput) => void ): void; - public getConnectPeer( - args: GetConnectPeerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConnectPeerCommandOutput) => void), - cb?: (err: any, data?: GetConnectPeerCommandOutput) => void - ): Promise | void { - const command = new GetConnectPeerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a core network Connect peer associations.

- */ - public getConnectPeerAssociations( + + /** + * @see {@link GetConnectPeerAssociationsCommand} + */ + getConnectPeerAssociations( args: GetConnectPeerAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConnectPeerAssociations( + getConnectPeerAssociations( args: GetConnectPeerAssociationsCommandInput, cb: (err: any, data?: GetConnectPeerAssociationsCommandOutput) => void ): void; - public getConnectPeerAssociations( + getConnectPeerAssociations( args: GetConnectPeerAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConnectPeerAssociationsCommandOutput) => void ): void; - public getConnectPeerAssociations( - args: GetConnectPeerAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConnectPeerAssociationsCommandOutput) => void), - cb?: (err: any, data?: GetConnectPeerAssociationsCommandOutput) => void - ): Promise | void { - const command = new GetConnectPeerAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the LIVE policy for a core network.

- */ - public getCoreNetwork( + + /** + * @see {@link GetCoreNetworkCommand} + */ + getCoreNetwork( args: GetCoreNetworkCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCoreNetwork( - args: GetCoreNetworkCommandInput, - cb: (err: any, data?: GetCoreNetworkCommandOutput) => void - ): void; - public getCoreNetwork( + getCoreNetwork(args: GetCoreNetworkCommandInput, cb: (err: any, data?: GetCoreNetworkCommandOutput) => void): void; + getCoreNetwork( args: GetCoreNetworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCoreNetworkCommandOutput) => void ): void; - public getCoreNetwork( - args: GetCoreNetworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCoreNetworkCommandOutput) => void), - cb?: (err: any, data?: GetCoreNetworkCommandOutput) => void - ): Promise | void { - const command = new GetCoreNetworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a core network change event.

- */ - public getCoreNetworkChangeEvents( + + /** + * @see {@link GetCoreNetworkChangeEventsCommand} + */ + getCoreNetworkChangeEvents( args: GetCoreNetworkChangeEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCoreNetworkChangeEvents( + getCoreNetworkChangeEvents( args: GetCoreNetworkChangeEventsCommandInput, cb: (err: any, data?: GetCoreNetworkChangeEventsCommandOutput) => void ): void; - public getCoreNetworkChangeEvents( + getCoreNetworkChangeEvents( args: GetCoreNetworkChangeEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCoreNetworkChangeEventsCommandOutput) => void ): void; - public getCoreNetworkChangeEvents( - args: GetCoreNetworkChangeEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCoreNetworkChangeEventsCommandOutput) => void), - cb?: (err: any, data?: GetCoreNetworkChangeEventsCommandOutput) => void - ): Promise | void { - const command = new GetCoreNetworkChangeEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a change set between the LIVE core network policy and a submitted policy.

- */ - public getCoreNetworkChangeSet( + + /** + * @see {@link GetCoreNetworkChangeSetCommand} + */ + getCoreNetworkChangeSet( args: GetCoreNetworkChangeSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCoreNetworkChangeSet( + getCoreNetworkChangeSet( args: GetCoreNetworkChangeSetCommandInput, cb: (err: any, data?: GetCoreNetworkChangeSetCommandOutput) => void ): void; - public getCoreNetworkChangeSet( + getCoreNetworkChangeSet( args: GetCoreNetworkChangeSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCoreNetworkChangeSetCommandOutput) => void ): void; - public getCoreNetworkChangeSet( - args: GetCoreNetworkChangeSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCoreNetworkChangeSetCommandOutput) => void), - cb?: (err: any, data?: GetCoreNetworkChangeSetCommandOutput) => void - ): Promise | void { - const command = new GetCoreNetworkChangeSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns details about a core network policy. You can get details about your current live policy or any previous policy version.

- */ - public getCoreNetworkPolicy( + + /** + * @see {@link GetCoreNetworkPolicyCommand} + */ + getCoreNetworkPolicy( args: GetCoreNetworkPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCoreNetworkPolicy( + getCoreNetworkPolicy( args: GetCoreNetworkPolicyCommandInput, cb: (err: any, data?: GetCoreNetworkPolicyCommandOutput) => void ): void; - public getCoreNetworkPolicy( + getCoreNetworkPolicy( args: GetCoreNetworkPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCoreNetworkPolicyCommandOutput) => void ): void; - public getCoreNetworkPolicy( - args: GetCoreNetworkPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCoreNetworkPolicyCommandOutput) => void), - cb?: (err: any, data?: GetCoreNetworkPolicyCommandOutput) => void - ): Promise | void { - const command = new GetCoreNetworkPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the association information for customer gateways that are associated with - * devices and links in your global network.

- */ - public getCustomerGatewayAssociations( + + /** + * @see {@link GetCustomerGatewayAssociationsCommand} + */ + getCustomerGatewayAssociations( args: GetCustomerGatewayAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCustomerGatewayAssociations( + getCustomerGatewayAssociations( args: GetCustomerGatewayAssociationsCommandInput, cb: (err: any, data?: GetCustomerGatewayAssociationsCommandOutput) => void ): void; - public getCustomerGatewayAssociations( + getCustomerGatewayAssociations( args: GetCustomerGatewayAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCustomerGatewayAssociationsCommandOutput) => void ): void; - public getCustomerGatewayAssociations( - args: GetCustomerGatewayAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCustomerGatewayAssociationsCommandOutput) => void), - cb?: (err: any, data?: GetCustomerGatewayAssociationsCommandOutput) => void - ): Promise | void { - const command = new GetCustomerGatewayAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about one or more of your devices in a global network.

- */ - public getDevices(args: GetDevicesCommandInput, options?: __HttpHandlerOptions): Promise; - public getDevices(args: GetDevicesCommandInput, cb: (err: any, data?: GetDevicesCommandOutput) => void): void; - public getDevices( + + /** + * @see {@link GetDevicesCommand} + */ + getDevices(args: GetDevicesCommandInput, options?: __HttpHandlerOptions): Promise; + getDevices(args: GetDevicesCommandInput, cb: (err: any, data?: GetDevicesCommandOutput) => void): void; + getDevices( args: GetDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDevicesCommandOutput) => void ): void; - public getDevices( - args: GetDevicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDevicesCommandOutput) => void), - cb?: (err: any, data?: GetDevicesCommandOutput) => void - ): Promise | void { - const command = new GetDevicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the link associations for a device or a link. Either the device ID or the link ID - * must be specified.

- */ - public getLinkAssociations( + + /** + * @see {@link GetLinkAssociationsCommand} + */ + getLinkAssociations( args: GetLinkAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLinkAssociations( + getLinkAssociations( args: GetLinkAssociationsCommandInput, cb: (err: any, data?: GetLinkAssociationsCommandOutput) => void ): void; - public getLinkAssociations( + getLinkAssociations( args: GetLinkAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLinkAssociationsCommandOutput) => void ): void; - public getLinkAssociations( - args: GetLinkAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLinkAssociationsCommandOutput) => void), - cb?: (err: any, data?: GetLinkAssociationsCommandOutput) => void - ): Promise | void { - const command = new GetLinkAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about one or more links in a specified global network.

- *

If you specify the site ID, you cannot specify the type or provider in the same request. You can specify the type and provider in the same request.

- */ - public getLinks(args: GetLinksCommandInput, options?: __HttpHandlerOptions): Promise; - public getLinks(args: GetLinksCommandInput, cb: (err: any, data?: GetLinksCommandOutput) => void): void; - public getLinks( + + /** + * @see {@link GetLinksCommand} + */ + getLinks(args: GetLinksCommandInput, options?: __HttpHandlerOptions): Promise; + getLinks(args: GetLinksCommandInput, cb: (err: any, data?: GetLinksCommandOutput) => void): void; + getLinks( args: GetLinksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLinksCommandOutput) => void ): void; - public getLinks( - args: GetLinksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLinksCommandOutput) => void), - cb?: (err: any, data?: GetLinksCommandOutput) => void - ): Promise | void { - const command = new GetLinksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the count of network resources, by resource type, for the specified global network.

- */ - public getNetworkResourceCounts( + + /** + * @see {@link GetNetworkResourceCountsCommand} + */ + getNetworkResourceCounts( args: GetNetworkResourceCountsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getNetworkResourceCounts( + getNetworkResourceCounts( args: GetNetworkResourceCountsCommandInput, cb: (err: any, data?: GetNetworkResourceCountsCommandOutput) => void ): void; - public getNetworkResourceCounts( + getNetworkResourceCounts( args: GetNetworkResourceCountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNetworkResourceCountsCommandOutput) => void ): void; - public getNetworkResourceCounts( - args: GetNetworkResourceCountsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetNetworkResourceCountsCommandOutput) => void), - cb?: (err: any, data?: GetNetworkResourceCountsCommandOutput) => void - ): Promise | void { - const command = new GetNetworkResourceCountsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the network resource relationships for the specified global network.

- */ - public getNetworkResourceRelationships( + + /** + * @see {@link GetNetworkResourceRelationshipsCommand} + */ + getNetworkResourceRelationships( args: GetNetworkResourceRelationshipsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getNetworkResourceRelationships( + getNetworkResourceRelationships( args: GetNetworkResourceRelationshipsCommandInput, cb: (err: any, data?: GetNetworkResourceRelationshipsCommandOutput) => void ): void; - public getNetworkResourceRelationships( + getNetworkResourceRelationships( args: GetNetworkResourceRelationshipsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNetworkResourceRelationshipsCommandOutput) => void ): void; - public getNetworkResourceRelationships( - args: GetNetworkResourceRelationshipsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetNetworkResourceRelationshipsCommandOutput) => void), - cb?: (err: any, data?: GetNetworkResourceRelationshipsCommandOutput) => void - ): Promise | void { - const command = new GetNetworkResourceRelationshipsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the network resources for the specified global network.

- *

The results include information from the corresponding Describe call for the resource, minus any sensitive information such as pre-shared keys.

- */ - public getNetworkResources( + + /** + * @see {@link GetNetworkResourcesCommand} + */ + getNetworkResources( args: GetNetworkResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getNetworkResources( + getNetworkResources( args: GetNetworkResourcesCommandInput, cb: (err: any, data?: GetNetworkResourcesCommandOutput) => void ): void; - public getNetworkResources( + getNetworkResources( args: GetNetworkResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNetworkResourcesCommandOutput) => void ): void; - public getNetworkResources( - args: GetNetworkResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetNetworkResourcesCommandOutput) => void), - cb?: (err: any, data?: GetNetworkResourcesCommandOutput) => void - ): Promise | void { - const command = new GetNetworkResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the network routes of the specified global network.

- */ - public getNetworkRoutes( + + /** + * @see {@link GetNetworkRoutesCommand} + */ + getNetworkRoutes( args: GetNetworkRoutesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getNetworkRoutes( + getNetworkRoutes( args: GetNetworkRoutesCommandInput, cb: (err: any, data?: GetNetworkRoutesCommandOutput) => void ): void; - public getNetworkRoutes( + getNetworkRoutes( args: GetNetworkRoutesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNetworkRoutesCommandOutput) => void ): void; - public getNetworkRoutes( - args: GetNetworkRoutesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetNetworkRoutesCommandOutput) => void), - cb?: (err: any, data?: GetNetworkRoutesCommandOutput) => void - ): Promise | void { - const command = new GetNetworkRoutesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the network telemetry of the specified global network.

- */ - public getNetworkTelemetry( + + /** + * @see {@link GetNetworkTelemetryCommand} + */ + getNetworkTelemetry( args: GetNetworkTelemetryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getNetworkTelemetry( + getNetworkTelemetry( args: GetNetworkTelemetryCommandInput, cb: (err: any, data?: GetNetworkTelemetryCommandOutput) => void ): void; - public getNetworkTelemetry( + getNetworkTelemetry( args: GetNetworkTelemetryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNetworkTelemetryCommandOutput) => void ): void; - public getNetworkTelemetry( - args: GetNetworkTelemetryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetNetworkTelemetryCommandOutput) => void), - cb?: (err: any, data?: GetNetworkTelemetryCommandOutput) => void - ): Promise | void { - const command = new GetNetworkTelemetryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a resource policy.

- */ - public getResourcePolicy( + + /** + * @see {@link GetResourcePolicyCommand} + */ + getResourcePolicy( args: GetResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void ): void; - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void ): void; - public getResourcePolicy( - args: GetResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: GetResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new GetResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the specified route analysis.

- */ - public getRouteAnalysis( + + /** + * @see {@link GetRouteAnalysisCommand} + */ + getRouteAnalysis( args: GetRouteAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRouteAnalysis( + getRouteAnalysis( args: GetRouteAnalysisCommandInput, cb: (err: any, data?: GetRouteAnalysisCommandOutput) => void ): void; - public getRouteAnalysis( + getRouteAnalysis( args: GetRouteAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRouteAnalysisCommandOutput) => void ): void; - public getRouteAnalysis( - args: GetRouteAnalysisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRouteAnalysisCommandOutput) => void), - cb?: (err: any, data?: GetRouteAnalysisCommandOutput) => void - ): Promise | void { - const command = new GetRouteAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about one or more of your sites in a global network.

- */ - public getSites(args: GetSitesCommandInput, options?: __HttpHandlerOptions): Promise; - public getSites(args: GetSitesCommandInput, cb: (err: any, data?: GetSitesCommandOutput) => void): void; - public getSites( + + /** + * @see {@link GetSitesCommand} + */ + getSites(args: GetSitesCommandInput, options?: __HttpHandlerOptions): Promise; + getSites(args: GetSitesCommandInput, cb: (err: any, data?: GetSitesCommandOutput) => void): void; + getSites( args: GetSitesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSitesCommandOutput) => void ): void; - public getSites( - args: GetSitesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSitesCommandOutput) => void), - cb?: (err: any, data?: GetSitesCommandOutput) => void - ): Promise | void { - const command = new GetSitesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a site-to-site VPN attachment.

- */ - public getSiteToSiteVpnAttachment( + + /** + * @see {@link GetSiteToSiteVpnAttachmentCommand} + */ + getSiteToSiteVpnAttachment( args: GetSiteToSiteVpnAttachmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSiteToSiteVpnAttachment( + getSiteToSiteVpnAttachment( args: GetSiteToSiteVpnAttachmentCommandInput, cb: (err: any, data?: GetSiteToSiteVpnAttachmentCommandOutput) => void ): void; - public getSiteToSiteVpnAttachment( + getSiteToSiteVpnAttachment( args: GetSiteToSiteVpnAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSiteToSiteVpnAttachmentCommandOutput) => void ): void; - public getSiteToSiteVpnAttachment( - args: GetSiteToSiteVpnAttachmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSiteToSiteVpnAttachmentCommandOutput) => void), - cb?: (err: any, data?: GetSiteToSiteVpnAttachmentCommandOutput) => void - ): Promise | void { - const command = new GetSiteToSiteVpnAttachmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about one or more of your transit gateway Connect peer associations in a global network.

- */ - public getTransitGatewayConnectPeerAssociations( + + /** + * @see {@link GetTransitGatewayConnectPeerAssociationsCommand} + */ + getTransitGatewayConnectPeerAssociations( args: GetTransitGatewayConnectPeerAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTransitGatewayConnectPeerAssociations( + getTransitGatewayConnectPeerAssociations( args: GetTransitGatewayConnectPeerAssociationsCommandInput, cb: (err: any, data?: GetTransitGatewayConnectPeerAssociationsCommandOutput) => void ): void; - public getTransitGatewayConnectPeerAssociations( + getTransitGatewayConnectPeerAssociations( args: GetTransitGatewayConnectPeerAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTransitGatewayConnectPeerAssociationsCommandOutput) => void ): void; - public getTransitGatewayConnectPeerAssociations( - args: GetTransitGatewayConnectPeerAssociationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetTransitGatewayConnectPeerAssociationsCommandOutput) => void), - cb?: (err: any, data?: GetTransitGatewayConnectPeerAssociationsCommandOutput) => void - ): Promise | void { - const command = new GetTransitGatewayConnectPeerAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a transit gateway peer.

- */ - public getTransitGatewayPeering( + + /** + * @see {@link GetTransitGatewayPeeringCommand} + */ + getTransitGatewayPeering( args: GetTransitGatewayPeeringCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTransitGatewayPeering( + getTransitGatewayPeering( args: GetTransitGatewayPeeringCommandInput, cb: (err: any, data?: GetTransitGatewayPeeringCommandOutput) => void ): void; - public getTransitGatewayPeering( + getTransitGatewayPeering( args: GetTransitGatewayPeeringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTransitGatewayPeeringCommandOutput) => void ): void; - public getTransitGatewayPeering( - args: GetTransitGatewayPeeringCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTransitGatewayPeeringCommandOutput) => void), - cb?: (err: any, data?: GetTransitGatewayPeeringCommandOutput) => void - ): Promise | void { - const command = new GetTransitGatewayPeeringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the transit gateway registrations in a specified - * global network.

- */ - public getTransitGatewayRegistrations( + + /** + * @see {@link GetTransitGatewayRegistrationsCommand} + */ + getTransitGatewayRegistrations( args: GetTransitGatewayRegistrationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTransitGatewayRegistrations( + getTransitGatewayRegistrations( args: GetTransitGatewayRegistrationsCommandInput, cb: (err: any, data?: GetTransitGatewayRegistrationsCommandOutput) => void ): void; - public getTransitGatewayRegistrations( + getTransitGatewayRegistrations( args: GetTransitGatewayRegistrationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTransitGatewayRegistrationsCommandOutput) => void ): void; - public getTransitGatewayRegistrations( - args: GetTransitGatewayRegistrationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTransitGatewayRegistrationsCommandOutput) => void), - cb?: (err: any, data?: GetTransitGatewayRegistrationsCommandOutput) => void - ): Promise | void { - const command = new GetTransitGatewayRegistrationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a transit gateway route table attachment.

- */ - public getTransitGatewayRouteTableAttachment( + + /** + * @see {@link GetTransitGatewayRouteTableAttachmentCommand} + */ + getTransitGatewayRouteTableAttachment( args: GetTransitGatewayRouteTableAttachmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTransitGatewayRouteTableAttachment( + getTransitGatewayRouteTableAttachment( args: GetTransitGatewayRouteTableAttachmentCommandInput, cb: (err: any, data?: GetTransitGatewayRouteTableAttachmentCommandOutput) => void ): void; - public getTransitGatewayRouteTableAttachment( + getTransitGatewayRouteTableAttachment( args: GetTransitGatewayRouteTableAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTransitGatewayRouteTableAttachmentCommandOutput) => void ): void; - public getTransitGatewayRouteTableAttachment( - args: GetTransitGatewayRouteTableAttachmentCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetTransitGatewayRouteTableAttachmentCommandOutput) => void), - cb?: (err: any, data?: GetTransitGatewayRouteTableAttachmentCommandOutput) => void - ): Promise | void { - const command = new GetTransitGatewayRouteTableAttachmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a VPC attachment.

- */ - public getVpcAttachment( + + /** + * @see {@link GetVpcAttachmentCommand} + */ + getVpcAttachment( args: GetVpcAttachmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVpcAttachment( + getVpcAttachment( args: GetVpcAttachmentCommandInput, cb: (err: any, data?: GetVpcAttachmentCommandOutput) => void ): void; - public getVpcAttachment( + getVpcAttachment( args: GetVpcAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVpcAttachmentCommandOutput) => void ): void; - public getVpcAttachment( - args: GetVpcAttachmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVpcAttachmentCommandOutput) => void), - cb?: (err: any, data?: GetVpcAttachmentCommandOutput) => void - ): Promise | void { - const command = new GetVpcAttachmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of core network attachments.

- */ - public listAttachments( + + /** + * @see {@link ListAttachmentsCommand} + */ + listAttachments( args: ListAttachmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAttachments( - args: ListAttachmentsCommandInput, - cb: (err: any, data?: ListAttachmentsCommandOutput) => void - ): void; - public listAttachments( + listAttachments(args: ListAttachmentsCommandInput, cb: (err: any, data?: ListAttachmentsCommandOutput) => void): void; + listAttachments( args: ListAttachmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAttachmentsCommandOutput) => void ): void; - public listAttachments( - args: ListAttachmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAttachmentsCommandOutput) => void), - cb?: (err: any, data?: ListAttachmentsCommandOutput) => void - ): Promise | void { - const command = new ListAttachmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of core network Connect peers.

- */ - public listConnectPeers( + + /** + * @see {@link ListConnectPeersCommand} + */ + listConnectPeers( args: ListConnectPeersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConnectPeers( + listConnectPeers( args: ListConnectPeersCommandInput, cb: (err: any, data?: ListConnectPeersCommandOutput) => void ): void; - public listConnectPeers( + listConnectPeers( args: ListConnectPeersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConnectPeersCommandOutput) => void ): void; - public listConnectPeers( - args: ListConnectPeersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConnectPeersCommandOutput) => void), - cb?: (err: any, data?: ListConnectPeersCommandOutput) => void - ): Promise | void { - const command = new ListConnectPeersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of core network policy versions.

- */ - public listCoreNetworkPolicyVersions( + + /** + * @see {@link ListCoreNetworkPolicyVersionsCommand} + */ + listCoreNetworkPolicyVersions( args: ListCoreNetworkPolicyVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCoreNetworkPolicyVersions( + listCoreNetworkPolicyVersions( args: ListCoreNetworkPolicyVersionsCommandInput, cb: (err: any, data?: ListCoreNetworkPolicyVersionsCommandOutput) => void ): void; - public listCoreNetworkPolicyVersions( + listCoreNetworkPolicyVersions( args: ListCoreNetworkPolicyVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCoreNetworkPolicyVersionsCommandOutput) => void ): void; - public listCoreNetworkPolicyVersions( - args: ListCoreNetworkPolicyVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCoreNetworkPolicyVersionsCommandOutput) => void), - cb?: (err: any, data?: ListCoreNetworkPolicyVersionsCommandOutput) => void - ): Promise | void { - const command = new ListCoreNetworkPolicyVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of owned and shared core networks.

- */ - public listCoreNetworks( + + /** + * @see {@link ListCoreNetworksCommand} + */ + listCoreNetworks( args: ListCoreNetworksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCoreNetworks( + listCoreNetworks( args: ListCoreNetworksCommandInput, cb: (err: any, data?: ListCoreNetworksCommandOutput) => void ): void; - public listCoreNetworks( + listCoreNetworks( args: ListCoreNetworksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCoreNetworksCommandOutput) => void ): void; - public listCoreNetworks( - args: ListCoreNetworksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCoreNetworksCommandOutput) => void), - cb?: (err: any, data?: ListCoreNetworksCommandOutput) => void - ): Promise | void { - const command = new ListCoreNetworksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the status of the Service Linked Role (SLR) deployment for the accounts in a given Amazon Web Services Organization.

- */ - public listOrganizationServiceAccessStatus( + + /** + * @see {@link ListOrganizationServiceAccessStatusCommand} + */ + listOrganizationServiceAccessStatus( args: ListOrganizationServiceAccessStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOrganizationServiceAccessStatus( + listOrganizationServiceAccessStatus( args: ListOrganizationServiceAccessStatusCommandInput, cb: (err: any, data?: ListOrganizationServiceAccessStatusCommandOutput) => void ): void; - public listOrganizationServiceAccessStatus( + listOrganizationServiceAccessStatus( args: ListOrganizationServiceAccessStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOrganizationServiceAccessStatusCommandOutput) => void ): void; - public listOrganizationServiceAccessStatus( - args: ListOrganizationServiceAccessStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOrganizationServiceAccessStatusCommandOutput) => void), - cb?: (err: any, data?: ListOrganizationServiceAccessStatusCommandOutput) => void - ): Promise | void { - const command = new ListOrganizationServiceAccessStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the peerings for a core network.

- */ - public listPeerings( - args: ListPeeringsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listPeerings(args: ListPeeringsCommandInput, cb: (err: any, data?: ListPeeringsCommandOutput) => void): void; - public listPeerings( + + /** + * @see {@link ListPeeringsCommand} + */ + listPeerings(args: ListPeeringsCommandInput, options?: __HttpHandlerOptions): Promise; + listPeerings(args: ListPeeringsCommandInput, cb: (err: any, data?: ListPeeringsCommandOutput) => void): void; + listPeerings( args: ListPeeringsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPeeringsCommandOutput) => void ): void; - public listPeerings( - args: ListPeeringsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPeeringsCommandOutput) => void), - cb?: (err: any, data?: ListPeeringsCommandOutput) => void - ): Promise | void { - const command = new ListPeeringsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the tags for a specified resource.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and the submitted policy.

- */ - public putCoreNetworkPolicy( + + /** + * @see {@link PutCoreNetworkPolicyCommand} + */ + putCoreNetworkPolicy( args: PutCoreNetworkPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putCoreNetworkPolicy( + putCoreNetworkPolicy( args: PutCoreNetworkPolicyCommandInput, cb: (err: any, data?: PutCoreNetworkPolicyCommandOutput) => void ): void; - public putCoreNetworkPolicy( + putCoreNetworkPolicy( args: PutCoreNetworkPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutCoreNetworkPolicyCommandOutput) => void ): void; - public putCoreNetworkPolicy( - args: PutCoreNetworkPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutCoreNetworkPolicyCommandOutput) => void), - cb?: (err: any, data?: PutCoreNetworkPolicyCommandOutput) => void - ): Promise | void { - const command = new PutCoreNetworkPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or updates a resource policy.

- */ - public putResourcePolicy( + + /** + * @see {@link PutResourcePolicyCommand} + */ + putResourcePolicy( args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( - args: PutResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: PutResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new PutResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers a transit gateway in your global network. Not all Regions support transit - * gateways for global networks. For a list of the supported Regions, see Region Availability in the Amazon Web Services Transit Gateways for Global - * Networks User Guide. The transit gateway can be in any of the supported - * Amazon Web Services Regions, but it must be owned by the same Amazon Web Services account that owns the global - * network. You cannot register a transit gateway in more than one global network.

- */ - public registerTransitGateway( + + /** + * @see {@link RegisterTransitGatewayCommand} + */ + registerTransitGateway( args: RegisterTransitGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerTransitGateway( + registerTransitGateway( args: RegisterTransitGatewayCommandInput, cb: (err: any, data?: RegisterTransitGatewayCommandOutput) => void ): void; - public registerTransitGateway( + registerTransitGateway( args: RegisterTransitGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterTransitGatewayCommandOutput) => void ): void; - public registerTransitGateway( - args: RegisterTransitGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterTransitGatewayCommandOutput) => void), - cb?: (err: any, data?: RegisterTransitGatewayCommandOutput) => void - ): Promise | void { - const command = new RegisterTransitGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Rejects a core network attachment request.

- */ - public rejectAttachment( + + /** + * @see {@link RejectAttachmentCommand} + */ + rejectAttachment( args: RejectAttachmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public rejectAttachment( + rejectAttachment( args: RejectAttachmentCommandInput, cb: (err: any, data?: RejectAttachmentCommandOutput) => void ): void; - public rejectAttachment( + rejectAttachment( args: RejectAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectAttachmentCommandOutput) => void ): void; - public rejectAttachment( - args: RejectAttachmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RejectAttachmentCommandOutput) => void), - cb?: (err: any, data?: RejectAttachmentCommandOutput) => void - ): Promise | void { - const command = new RejectAttachmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Restores a previous policy version as a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and restored policy.

- */ - public restoreCoreNetworkPolicyVersion( + + /** + * @see {@link RestoreCoreNetworkPolicyVersionCommand} + */ + restoreCoreNetworkPolicyVersion( args: RestoreCoreNetworkPolicyVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreCoreNetworkPolicyVersion( + restoreCoreNetworkPolicyVersion( args: RestoreCoreNetworkPolicyVersionCommandInput, cb: (err: any, data?: RestoreCoreNetworkPolicyVersionCommandOutput) => void ): void; - public restoreCoreNetworkPolicyVersion( + restoreCoreNetworkPolicyVersion( args: RestoreCoreNetworkPolicyVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreCoreNetworkPolicyVersionCommandOutput) => void ): void; - public restoreCoreNetworkPolicyVersion( - args: RestoreCoreNetworkPolicyVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreCoreNetworkPolicyVersionCommandOutput) => void), - cb?: (err: any, data?: RestoreCoreNetworkPolicyVersionCommandOutput) => void - ): Promise | void { - const command = new RestoreCoreNetworkPolicyVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables the Network Manager service for an Amazon Web Services Organization. This can only be called by a management account within the organization.

- */ - public startOrganizationServiceAccessUpdate( + + /** + * @see {@link StartOrganizationServiceAccessUpdateCommand} + */ + startOrganizationServiceAccessUpdate( args: StartOrganizationServiceAccessUpdateCommandInput, options?: __HttpHandlerOptions ): Promise; - public startOrganizationServiceAccessUpdate( + startOrganizationServiceAccessUpdate( args: StartOrganizationServiceAccessUpdateCommandInput, cb: (err: any, data?: StartOrganizationServiceAccessUpdateCommandOutput) => void ): void; - public startOrganizationServiceAccessUpdate( + startOrganizationServiceAccessUpdate( args: StartOrganizationServiceAccessUpdateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartOrganizationServiceAccessUpdateCommandOutput) => void ): void; - public startOrganizationServiceAccessUpdate( - args: StartOrganizationServiceAccessUpdateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartOrganizationServiceAccessUpdateCommandOutput) => void), - cb?: (err: any, data?: StartOrganizationServiceAccessUpdateCommandOutput) => void - ): Promise | void { - const command = new StartOrganizationServiceAccessUpdateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts analyzing the routing path between the specified source and destination. For more information, - * see Route Analyzer.

- */ - public startRouteAnalysis( + + /** + * @see {@link StartRouteAnalysisCommand} + */ + startRouteAnalysis( args: StartRouteAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public startRouteAnalysis( + startRouteAnalysis( args: StartRouteAnalysisCommandInput, cb: (err: any, data?: StartRouteAnalysisCommandOutput) => void ): void; - public startRouteAnalysis( + startRouteAnalysis( args: StartRouteAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartRouteAnalysisCommandOutput) => void ): void; - public startRouteAnalysis( - args: StartRouteAnalysisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartRouteAnalysisCommandOutput) => void), - cb?: (err: any, data?: StartRouteAnalysisCommandOutput) => void - ): Promise | void { - const command = new StartRouteAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Tags a specified resource.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes tags from a specified resource.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the information for an existing connection. To remove information for any of the parameters, - * specify an empty string.

- */ - public updateConnection( + + /** + * @see {@link UpdateConnectionCommand} + */ + updateConnection( args: UpdateConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConnection( + updateConnection( args: UpdateConnectionCommandInput, cb: (err: any, data?: UpdateConnectionCommandOutput) => void ): void; - public updateConnection( + updateConnection( args: UpdateConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectionCommandOutput) => void ): void; - public updateConnection( - args: UpdateConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConnectionCommandOutput) => void), - cb?: (err: any, data?: UpdateConnectionCommandOutput) => void - ): Promise | void { - const command = new UpdateConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the description of a core network.

- */ - public updateCoreNetwork( + + /** + * @see {@link UpdateCoreNetworkCommand} + */ + updateCoreNetwork( args: UpdateCoreNetworkCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCoreNetwork( + updateCoreNetwork( args: UpdateCoreNetworkCommandInput, cb: (err: any, data?: UpdateCoreNetworkCommandOutput) => void ): void; - public updateCoreNetwork( + updateCoreNetwork( args: UpdateCoreNetworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCoreNetworkCommandOutput) => void ): void; - public updateCoreNetwork( - args: UpdateCoreNetworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCoreNetworkCommandOutput) => void), - cb?: (err: any, data?: UpdateCoreNetworkCommandOutput) => void - ): Promise | void { - const command = new UpdateCoreNetworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the details for an existing device. To remove information for any of the - * parameters, specify an empty string.

- */ - public updateDevice( - args: UpdateDeviceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateDevice(args: UpdateDeviceCommandInput, cb: (err: any, data?: UpdateDeviceCommandOutput) => void): void; - public updateDevice( + + /** + * @see {@link UpdateDeviceCommand} + */ + updateDevice(args: UpdateDeviceCommandInput, options?: __HttpHandlerOptions): Promise; + updateDevice(args: UpdateDeviceCommandInput, cb: (err: any, data?: UpdateDeviceCommandOutput) => void): void; + updateDevice( args: UpdateDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDeviceCommandOutput) => void ): void; - public updateDevice( - args: UpdateDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDeviceCommandOutput) => void), - cb?: (err: any, data?: UpdateDeviceCommandOutput) => void - ): Promise | void { - const command = new UpdateDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing global network. To remove information for any of the parameters, - * specify an empty string.

- */ - public updateGlobalNetwork( + + /** + * @see {@link UpdateGlobalNetworkCommand} + */ + updateGlobalNetwork( args: UpdateGlobalNetworkCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGlobalNetwork( + updateGlobalNetwork( args: UpdateGlobalNetworkCommandInput, cb: (err: any, data?: UpdateGlobalNetworkCommandOutput) => void ): void; - public updateGlobalNetwork( + updateGlobalNetwork( args: UpdateGlobalNetworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGlobalNetworkCommandOutput) => void ): void; - public updateGlobalNetwork( - args: UpdateGlobalNetworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGlobalNetworkCommandOutput) => void), - cb?: (err: any, data?: UpdateGlobalNetworkCommandOutput) => void - ): Promise | void { - const command = new UpdateGlobalNetworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the details for an existing link. To remove information for any of the - * parameters, specify an empty string.

- */ - public updateLink(args: UpdateLinkCommandInput, options?: __HttpHandlerOptions): Promise; - public updateLink(args: UpdateLinkCommandInput, cb: (err: any, data?: UpdateLinkCommandOutput) => void): void; - public updateLink( + + /** + * @see {@link UpdateLinkCommand} + */ + updateLink(args: UpdateLinkCommandInput, options?: __HttpHandlerOptions): Promise; + updateLink(args: UpdateLinkCommandInput, cb: (err: any, data?: UpdateLinkCommandOutput) => void): void; + updateLink( args: UpdateLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLinkCommandOutput) => void ): void; - public updateLink( - args: UpdateLinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLinkCommandOutput) => void), - cb?: (err: any, data?: UpdateLinkCommandOutput) => void - ): Promise | void { - const command = new UpdateLinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the resource metadata for the specified global network.

- */ - public updateNetworkResourceMetadata( + + /** + * @see {@link UpdateNetworkResourceMetadataCommand} + */ + updateNetworkResourceMetadata( args: UpdateNetworkResourceMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateNetworkResourceMetadata( + updateNetworkResourceMetadata( args: UpdateNetworkResourceMetadataCommandInput, cb: (err: any, data?: UpdateNetworkResourceMetadataCommandOutput) => void ): void; - public updateNetworkResourceMetadata( + updateNetworkResourceMetadata( args: UpdateNetworkResourceMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNetworkResourceMetadataCommandOutput) => void ): void; - public updateNetworkResourceMetadata( - args: UpdateNetworkResourceMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateNetworkResourceMetadataCommandOutput) => void), - cb?: (err: any, data?: UpdateNetworkResourceMetadataCommandOutput) => void - ): Promise | void { - const command = new UpdateNetworkResourceMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the information for an existing site. To remove information for any of the - * parameters, specify an empty string.

- */ - public updateSite(args: UpdateSiteCommandInput, options?: __HttpHandlerOptions): Promise; - public updateSite(args: UpdateSiteCommandInput, cb: (err: any, data?: UpdateSiteCommandOutput) => void): void; - public updateSite( + + /** + * @see {@link UpdateSiteCommand} + */ + updateSite(args: UpdateSiteCommandInput, options?: __HttpHandlerOptions): Promise; + updateSite(args: UpdateSiteCommandInput, cb: (err: any, data?: UpdateSiteCommandOutput) => void): void; + updateSite( args: UpdateSiteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSiteCommandOutput) => void ): void; - public updateSite( - args: UpdateSiteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSiteCommandOutput) => void), - cb?: (err: any, data?: UpdateSiteCommandOutput) => void - ): Promise | void { - const command = new UpdateSiteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a VPC attachment.

- */ - public updateVpcAttachment( + + /** + * @see {@link UpdateVpcAttachmentCommand} + */ + updateVpcAttachment( args: UpdateVpcAttachmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVpcAttachment( + updateVpcAttachment( args: UpdateVpcAttachmentCommandInput, cb: (err: any, data?: UpdateVpcAttachmentCommandOutput) => void ): void; - public updateVpcAttachment( + updateVpcAttachment( args: UpdateVpcAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVpcAttachmentCommandOutput) => void ): void; - public updateVpcAttachment( - args: UpdateVpcAttachmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVpcAttachmentCommandOutput) => void), - cb?: (err: any, data?: UpdateVpcAttachmentCommandOutput) => void - ): Promise | void { - const command = new UpdateVpcAttachmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Web Services enables you to centrally manage your Amazon Web Services Cloud WAN core network and your Transit Gateway network across Amazon Web Services accounts, Regions, and on-premises locations.

+ */ +export class NetworkManager extends NetworkManagerClient implements NetworkManager {} +createAggregatedClient(commands, NetworkManager); diff --git a/clients/client-nimble/src/Nimble.ts b/clients/client-nimble/src/Nimble.ts index 4865cd970bd0..86b5291692f6 100644 --- a/clients/client-nimble/src/Nimble.ts +++ b/clients/client-nimble/src/Nimble.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { AcceptEulasCommand, AcceptEulasCommandInput, AcceptEulasCommandOutput } from "./commands/AcceptEulasCommand"; @@ -222,1647 +223,840 @@ import { UpdateStudioComponentCommandInput, UpdateStudioComponentCommandOutput, } from "./commands/UpdateStudioComponentCommand"; -import { NimbleClient } from "./NimbleClient"; +import { NimbleClient, NimbleClientConfig } from "./NimbleClient"; -/** - * @public - *

Welcome to the Amazon Nimble Studio API reference. This API reference provides - * methods, schema, resources, parameters, and more to help you get the most out of Nimble - * Studio.

- *

Nimble Studio is a virtual studio that empowers visual effects, animation, and - * interactive content teams to create content securely within a scalable, private cloud - * service.

- */ -export class Nimble extends NimbleClient { +const commands = { + AcceptEulasCommand, + CreateLaunchProfileCommand, + CreateStreamingImageCommand, + CreateStreamingSessionCommand, + CreateStreamingSessionStreamCommand, + CreateStudioCommand, + CreateStudioComponentCommand, + DeleteLaunchProfileCommand, + DeleteLaunchProfileMemberCommand, + DeleteStreamingImageCommand, + DeleteStreamingSessionCommand, + DeleteStudioCommand, + DeleteStudioComponentCommand, + DeleteStudioMemberCommand, + GetEulaCommand, + GetLaunchProfileCommand, + GetLaunchProfileDetailsCommand, + GetLaunchProfileInitializationCommand, + GetLaunchProfileMemberCommand, + GetStreamingImageCommand, + GetStreamingSessionCommand, + GetStreamingSessionBackupCommand, + GetStreamingSessionStreamCommand, + GetStudioCommand, + GetStudioComponentCommand, + GetStudioMemberCommand, + ListEulaAcceptancesCommand, + ListEulasCommand, + ListLaunchProfileMembersCommand, + ListLaunchProfilesCommand, + ListStreamingImagesCommand, + ListStreamingSessionBackupsCommand, + ListStreamingSessionsCommand, + ListStudioComponentsCommand, + ListStudioMembersCommand, + ListStudiosCommand, + ListTagsForResourceCommand, + PutLaunchProfileMembersCommand, + PutStudioMembersCommand, + StartStreamingSessionCommand, + StartStudioSSOConfigurationRepairCommand, + StopStreamingSessionCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateLaunchProfileCommand, + UpdateLaunchProfileMemberCommand, + UpdateStreamingImageCommand, + UpdateStudioCommand, + UpdateStudioComponentCommand, +}; + +export interface Nimble { /** - * @public - *

Accept EULAs.

+ * @see {@link AcceptEulasCommand} */ - public acceptEulas(args: AcceptEulasCommandInput, options?: __HttpHandlerOptions): Promise; - public acceptEulas(args: AcceptEulasCommandInput, cb: (err: any, data?: AcceptEulasCommandOutput) => void): void; - public acceptEulas( + acceptEulas(args: AcceptEulasCommandInput, options?: __HttpHandlerOptions): Promise; + acceptEulas(args: AcceptEulasCommandInput, cb: (err: any, data?: AcceptEulasCommandOutput) => void): void; + acceptEulas( args: AcceptEulasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptEulasCommandOutput) => void ): void; - public acceptEulas( - args: AcceptEulasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptEulasCommandOutput) => void), - cb?: (err: any, data?: AcceptEulasCommandOutput) => void - ): Promise | void { - const command = new AcceptEulasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create a launch profile.

+ * @see {@link CreateLaunchProfileCommand} */ - public createLaunchProfile( + createLaunchProfile( args: CreateLaunchProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLaunchProfile( + createLaunchProfile( args: CreateLaunchProfileCommandInput, cb: (err: any, data?: CreateLaunchProfileCommandOutput) => void ): void; - public createLaunchProfile( + createLaunchProfile( args: CreateLaunchProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLaunchProfileCommandOutput) => void ): void; - public createLaunchProfile( - args: CreateLaunchProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLaunchProfileCommandOutput) => void), - cb?: (err: any, data?: CreateLaunchProfileCommandOutput) => void - ): Promise | void { - const command = new CreateLaunchProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a streaming image resource in a studio.

+ * @see {@link CreateStreamingImageCommand} */ - public createStreamingImage( + createStreamingImage( args: CreateStreamingImageCommandInput, options?: __HttpHandlerOptions ): Promise; - public createStreamingImage( + createStreamingImage( args: CreateStreamingImageCommandInput, cb: (err: any, data?: CreateStreamingImageCommandOutput) => void ): void; - public createStreamingImage( + createStreamingImage( args: CreateStreamingImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStreamingImageCommandOutput) => void ): void; - public createStreamingImage( - args: CreateStreamingImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStreamingImageCommandOutput) => void), - cb?: (err: any, data?: CreateStreamingImageCommandOutput) => void - ): Promise | void { - const command = new CreateStreamingImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a streaming session in a studio.

- *

After invoking this operation, you must poll GetStreamingSession until the streaming - * session is in the READY state.

+ * @see {@link CreateStreamingSessionCommand} */ - public createStreamingSession( + createStreamingSession( args: CreateStreamingSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createStreamingSession( + createStreamingSession( args: CreateStreamingSessionCommandInput, cb: (err: any, data?: CreateStreamingSessionCommandOutput) => void ): void; - public createStreamingSession( + createStreamingSession( args: CreateStreamingSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStreamingSessionCommandOutput) => void ): void; - public createStreamingSession( - args: CreateStreamingSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStreamingSessionCommandOutput) => void), - cb?: (err: any, data?: CreateStreamingSessionCommandOutput) => void - ): Promise | void { - const command = new CreateStreamingSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a streaming session stream for a streaming session.

- *

After invoking this API, invoke GetStreamingSessionStream with the returned streamId - * to poll the resource until it is in the READY state.

+ * @see {@link CreateStreamingSessionStreamCommand} */ - public createStreamingSessionStream( + createStreamingSessionStream( args: CreateStreamingSessionStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public createStreamingSessionStream( + createStreamingSessionStream( args: CreateStreamingSessionStreamCommandInput, cb: (err: any, data?: CreateStreamingSessionStreamCommandOutput) => void ): void; - public createStreamingSessionStream( + createStreamingSessionStream( args: CreateStreamingSessionStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStreamingSessionStreamCommandOutput) => void ): void; - public createStreamingSessionStream( - args: CreateStreamingSessionStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStreamingSessionStreamCommandOutput) => void), - cb?: (err: any, data?: CreateStreamingSessionStreamCommandOutput) => void - ): Promise | void { - const command = new CreateStreamingSessionStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create a new studio.

- *

When creating a studio, two IAM roles must be provided: the admin role - * and the user role. These roles are assumed by your users when they log in to the Nimble Studio portal.

- *

The user role must have the AmazonNimbleStudio-StudioUser managed policy - * attached for the portal to function properly.

- *

The admin role must have the AmazonNimbleStudio-StudioAdmin managed - * policy attached for the portal to function properly.

- *

You may optionally specify a KMS key in the - * StudioEncryptionConfiguration.

- *

In Nimble Studio, resource names, descriptions, initialization scripts, and other - * data you provide are always encrypted at rest using an KMS key. By default, this key is - * owned by Amazon Web Services and managed on your behalf. You may provide your own KMS key - * when calling CreateStudio to encrypt this data using a key you own and - * manage.

- *

When providing an KMS key during studio creation, Nimble Studio creates KMS - * grants in your account to provide your studio user and admin roles access to these KMS - * keys.

- *

If you delete this grant, the studio will no longer be accessible to your portal - * users.

- *

If you delete the studio KMS key, your studio will no longer be accessible.

+ * @see {@link CreateStudioCommand} */ - public createStudio( - args: CreateStudioCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createStudio(args: CreateStudioCommandInput, cb: (err: any, data?: CreateStudioCommandOutput) => void): void; - public createStudio( + createStudio(args: CreateStudioCommandInput, options?: __HttpHandlerOptions): Promise; + createStudio(args: CreateStudioCommandInput, cb: (err: any, data?: CreateStudioCommandOutput) => void): void; + createStudio( args: CreateStudioCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStudioCommandOutput) => void ): void; - public createStudio( - args: CreateStudioCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStudioCommandOutput) => void), - cb?: (err: any, data?: CreateStudioCommandOutput) => void - ): Promise | void { - const command = new CreateStudioCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a studio component resource.

+ * @see {@link CreateStudioComponentCommand} */ - public createStudioComponent( + createStudioComponent( args: CreateStudioComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createStudioComponent( + createStudioComponent( args: CreateStudioComponentCommandInput, cb: (err: any, data?: CreateStudioComponentCommandOutput) => void ): void; - public createStudioComponent( + createStudioComponent( args: CreateStudioComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStudioComponentCommandOutput) => void ): void; - public createStudioComponent( - args: CreateStudioComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStudioComponentCommandOutput) => void), - cb?: (err: any, data?: CreateStudioComponentCommandOutput) => void - ): Promise | void { - const command = new CreateStudioComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Permanently delete a launch profile.

+ * @see {@link DeleteLaunchProfileCommand} */ - public deleteLaunchProfile( + deleteLaunchProfile( args: DeleteLaunchProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLaunchProfile( + deleteLaunchProfile( args: DeleteLaunchProfileCommandInput, cb: (err: any, data?: DeleteLaunchProfileCommandOutput) => void ): void; - public deleteLaunchProfile( + deleteLaunchProfile( args: DeleteLaunchProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLaunchProfileCommandOutput) => void ): void; - public deleteLaunchProfile( - args: DeleteLaunchProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLaunchProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteLaunchProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteLaunchProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete a user from launch profile membership.

+ * @see {@link DeleteLaunchProfileMemberCommand} */ - public deleteLaunchProfileMember( + deleteLaunchProfileMember( args: DeleteLaunchProfileMemberCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLaunchProfileMember( + deleteLaunchProfileMember( args: DeleteLaunchProfileMemberCommandInput, cb: (err: any, data?: DeleteLaunchProfileMemberCommandOutput) => void ): void; - public deleteLaunchProfileMember( + deleteLaunchProfileMember( args: DeleteLaunchProfileMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLaunchProfileMemberCommandOutput) => void ): void; - public deleteLaunchProfileMember( - args: DeleteLaunchProfileMemberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLaunchProfileMemberCommandOutput) => void), - cb?: (err: any, data?: DeleteLaunchProfileMemberCommandOutput) => void - ): Promise | void { - const command = new DeleteLaunchProfileMemberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete streaming image.

+ * @see {@link DeleteStreamingImageCommand} */ - public deleteStreamingImage( + deleteStreamingImage( args: DeleteStreamingImageCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteStreamingImage( + deleteStreamingImage( args: DeleteStreamingImageCommandInput, cb: (err: any, data?: DeleteStreamingImageCommandOutput) => void ): void; - public deleteStreamingImage( + deleteStreamingImage( args: DeleteStreamingImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStreamingImageCommandOutput) => void ): void; - public deleteStreamingImage( - args: DeleteStreamingImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStreamingImageCommandOutput) => void), - cb?: (err: any, data?: DeleteStreamingImageCommandOutput) => void - ): Promise | void { - const command = new DeleteStreamingImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes streaming session resource.

- *

After invoking this operation, use GetStreamingSession to poll the resource until it - * transitions to a DELETED state.

- *

A streaming session will count against your streaming session quota until it is marked - * DELETED.

+ * @see {@link DeleteStreamingSessionCommand} */ - public deleteStreamingSession( + deleteStreamingSession( args: DeleteStreamingSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteStreamingSession( + deleteStreamingSession( args: DeleteStreamingSessionCommandInput, cb: (err: any, data?: DeleteStreamingSessionCommandOutput) => void ): void; - public deleteStreamingSession( + deleteStreamingSession( args: DeleteStreamingSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStreamingSessionCommandOutput) => void ): void; - public deleteStreamingSession( - args: DeleteStreamingSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStreamingSessionCommandOutput) => void), - cb?: (err: any, data?: DeleteStreamingSessionCommandOutput) => void - ): Promise | void { - const command = new DeleteStreamingSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete a studio resource.

+ * @see {@link DeleteStudioCommand} */ - public deleteStudio( - args: DeleteStudioCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteStudio(args: DeleteStudioCommandInput, cb: (err: any, data?: DeleteStudioCommandOutput) => void): void; - public deleteStudio( + deleteStudio(args: DeleteStudioCommandInput, options?: __HttpHandlerOptions): Promise; + deleteStudio(args: DeleteStudioCommandInput, cb: (err: any, data?: DeleteStudioCommandOutput) => void): void; + deleteStudio( args: DeleteStudioCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStudioCommandOutput) => void ): void; - public deleteStudio( - args: DeleteStudioCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStudioCommandOutput) => void), - cb?: (err: any, data?: DeleteStudioCommandOutput) => void - ): Promise | void { - const command = new DeleteStudioCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a studio component resource.

+ * @see {@link DeleteStudioComponentCommand} */ - public deleteStudioComponent( + deleteStudioComponent( args: DeleteStudioComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteStudioComponent( + deleteStudioComponent( args: DeleteStudioComponentCommandInput, cb: (err: any, data?: DeleteStudioComponentCommandOutput) => void ): void; - public deleteStudioComponent( + deleteStudioComponent( args: DeleteStudioComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStudioComponentCommandOutput) => void ): void; - public deleteStudioComponent( - args: DeleteStudioComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStudioComponentCommandOutput) => void), - cb?: (err: any, data?: DeleteStudioComponentCommandOutput) => void - ): Promise | void { - const command = new DeleteStudioComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete a user from studio membership.

+ * @see {@link DeleteStudioMemberCommand} */ - public deleteStudioMember( + deleteStudioMember( args: DeleteStudioMemberCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteStudioMember( + deleteStudioMember( args: DeleteStudioMemberCommandInput, cb: (err: any, data?: DeleteStudioMemberCommandOutput) => void ): void; - public deleteStudioMember( + deleteStudioMember( args: DeleteStudioMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStudioMemberCommandOutput) => void ): void; - public deleteStudioMember( - args: DeleteStudioMemberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStudioMemberCommandOutput) => void), - cb?: (err: any, data?: DeleteStudioMemberCommandOutput) => void - ): Promise | void { - const command = new DeleteStudioMemberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get EULA.

+ * @see {@link GetEulaCommand} */ - public getEula(args: GetEulaCommandInput, options?: __HttpHandlerOptions): Promise; - public getEula(args: GetEulaCommandInput, cb: (err: any, data?: GetEulaCommandOutput) => void): void; - public getEula( + getEula(args: GetEulaCommandInput, options?: __HttpHandlerOptions): Promise; + getEula(args: GetEulaCommandInput, cb: (err: any, data?: GetEulaCommandOutput) => void): void; + getEula( args: GetEulaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEulaCommandOutput) => void ): void; - public getEula( - args: GetEulaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEulaCommandOutput) => void), - cb?: (err: any, data?: GetEulaCommandOutput) => void - ): Promise | void { - const command = new GetEulaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get a launch profile.

+ * @see {@link GetLaunchProfileCommand} */ - public getLaunchProfile( + getLaunchProfile( args: GetLaunchProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLaunchProfile( + getLaunchProfile( args: GetLaunchProfileCommandInput, cb: (err: any, data?: GetLaunchProfileCommandOutput) => void ): void; - public getLaunchProfile( + getLaunchProfile( args: GetLaunchProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLaunchProfileCommandOutput) => void ): void; - public getLaunchProfile( - args: GetLaunchProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLaunchProfileCommandOutput) => void), - cb?: (err: any, data?: GetLaunchProfileCommandOutput) => void - ): Promise | void { - const command = new GetLaunchProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Launch profile details include the launch profile resource and summary information of - * resources that are used by, or available to, the launch profile. This includes the name - * and description of all studio components used by the launch profiles, and the name and - * description of streaming images that can be used with this launch profile.

+ * @see {@link GetLaunchProfileDetailsCommand} */ - public getLaunchProfileDetails( + getLaunchProfileDetails( args: GetLaunchProfileDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLaunchProfileDetails( + getLaunchProfileDetails( args: GetLaunchProfileDetailsCommandInput, cb: (err: any, data?: GetLaunchProfileDetailsCommandOutput) => void ): void; - public getLaunchProfileDetails( + getLaunchProfileDetails( args: GetLaunchProfileDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLaunchProfileDetailsCommandOutput) => void ): void; - public getLaunchProfileDetails( - args: GetLaunchProfileDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLaunchProfileDetailsCommandOutput) => void), - cb?: (err: any, data?: GetLaunchProfileDetailsCommandOutput) => void - ): Promise | void { - const command = new GetLaunchProfileDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get a launch profile initialization.

+ * @see {@link GetLaunchProfileInitializationCommand} */ - public getLaunchProfileInitialization( + getLaunchProfileInitialization( args: GetLaunchProfileInitializationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLaunchProfileInitialization( + getLaunchProfileInitialization( args: GetLaunchProfileInitializationCommandInput, cb: (err: any, data?: GetLaunchProfileInitializationCommandOutput) => void ): void; - public getLaunchProfileInitialization( + getLaunchProfileInitialization( args: GetLaunchProfileInitializationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLaunchProfileInitializationCommandOutput) => void ): void; - public getLaunchProfileInitialization( - args: GetLaunchProfileInitializationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLaunchProfileInitializationCommandOutput) => void), - cb?: (err: any, data?: GetLaunchProfileInitializationCommandOutput) => void - ): Promise | void { - const command = new GetLaunchProfileInitializationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get a user persona in launch profile membership.

+ * @see {@link GetLaunchProfileMemberCommand} */ - public getLaunchProfileMember( + getLaunchProfileMember( args: GetLaunchProfileMemberCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLaunchProfileMember( + getLaunchProfileMember( args: GetLaunchProfileMemberCommandInput, cb: (err: any, data?: GetLaunchProfileMemberCommandOutput) => void ): void; - public getLaunchProfileMember( + getLaunchProfileMember( args: GetLaunchProfileMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLaunchProfileMemberCommandOutput) => void ): void; - public getLaunchProfileMember( - args: GetLaunchProfileMemberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLaunchProfileMemberCommandOutput) => void), - cb?: (err: any, data?: GetLaunchProfileMemberCommandOutput) => void - ): Promise | void { - const command = new GetLaunchProfileMemberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get streaming image.

+ * @see {@link GetStreamingImageCommand} */ - public getStreamingImage( + getStreamingImage( args: GetStreamingImageCommandInput, options?: __HttpHandlerOptions ): Promise; - public getStreamingImage( + getStreamingImage( args: GetStreamingImageCommandInput, cb: (err: any, data?: GetStreamingImageCommandOutput) => void ): void; - public getStreamingImage( + getStreamingImage( args: GetStreamingImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStreamingImageCommandOutput) => void ): void; - public getStreamingImage( - args: GetStreamingImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStreamingImageCommandOutput) => void), - cb?: (err: any, data?: GetStreamingImageCommandOutput) => void - ): Promise | void { - const command = new GetStreamingImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets StreamingSession resource.

- *

Invoke this operation to poll for a streaming session state while creating or deleting - * a session.

+ * @see {@link GetStreamingSessionCommand} */ - public getStreamingSession( + getStreamingSession( args: GetStreamingSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getStreamingSession( + getStreamingSession( args: GetStreamingSessionCommandInput, cb: (err: any, data?: GetStreamingSessionCommandOutput) => void ): void; - public getStreamingSession( + getStreamingSession( args: GetStreamingSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStreamingSessionCommandOutput) => void ): void; - public getStreamingSession( - args: GetStreamingSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStreamingSessionCommandOutput) => void), - cb?: (err: any, data?: GetStreamingSessionCommandOutput) => void - ): Promise | void { - const command = new GetStreamingSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets StreamingSessionBackup resource.

- *

Invoke this operation to poll for a streaming session backup while stopping a - * streaming session.

+ * @see {@link GetStreamingSessionBackupCommand} */ - public getStreamingSessionBackup( + getStreamingSessionBackup( args: GetStreamingSessionBackupCommandInput, options?: __HttpHandlerOptions ): Promise; - public getStreamingSessionBackup( + getStreamingSessionBackup( args: GetStreamingSessionBackupCommandInput, cb: (err: any, data?: GetStreamingSessionBackupCommandOutput) => void ): void; - public getStreamingSessionBackup( + getStreamingSessionBackup( args: GetStreamingSessionBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStreamingSessionBackupCommandOutput) => void ): void; - public getStreamingSessionBackup( - args: GetStreamingSessionBackupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStreamingSessionBackupCommandOutput) => void), - cb?: (err: any, data?: GetStreamingSessionBackupCommandOutput) => void - ): Promise | void { - const command = new GetStreamingSessionBackupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a StreamingSessionStream for a streaming session.

- *

Invoke this operation to poll the resource after invoking - * CreateStreamingSessionStream.

- *

After the StreamingSessionStream changes to the READY state, - * the url property will contain a stream to be used with the DCV streaming client.

+ * @see {@link GetStreamingSessionStreamCommand} */ - public getStreamingSessionStream( + getStreamingSessionStream( args: GetStreamingSessionStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public getStreamingSessionStream( + getStreamingSessionStream( args: GetStreamingSessionStreamCommandInput, cb: (err: any, data?: GetStreamingSessionStreamCommandOutput) => void ): void; - public getStreamingSessionStream( + getStreamingSessionStream( args: GetStreamingSessionStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStreamingSessionStreamCommandOutput) => void ): void; - public getStreamingSessionStream( - args: GetStreamingSessionStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStreamingSessionStreamCommandOutput) => void), - cb?: (err: any, data?: GetStreamingSessionStreamCommandOutput) => void - ): Promise | void { - const command = new GetStreamingSessionStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get a studio resource.

+ * @see {@link GetStudioCommand} */ - public getStudio(args: GetStudioCommandInput, options?: __HttpHandlerOptions): Promise; - public getStudio(args: GetStudioCommandInput, cb: (err: any, data?: GetStudioCommandOutput) => void): void; - public getStudio( + getStudio(args: GetStudioCommandInput, options?: __HttpHandlerOptions): Promise; + getStudio(args: GetStudioCommandInput, cb: (err: any, data?: GetStudioCommandOutput) => void): void; + getStudio( args: GetStudioCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStudioCommandOutput) => void ): void; - public getStudio( - args: GetStudioCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStudioCommandOutput) => void), - cb?: (err: any, data?: GetStudioCommandOutput) => void - ): Promise | void { - const command = new GetStudioCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a studio component resource.

+ * @see {@link GetStudioComponentCommand} */ - public getStudioComponent( + getStudioComponent( args: GetStudioComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getStudioComponent( + getStudioComponent( args: GetStudioComponentCommandInput, cb: (err: any, data?: GetStudioComponentCommandOutput) => void ): void; - public getStudioComponent( + getStudioComponent( args: GetStudioComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStudioComponentCommandOutput) => void ): void; - public getStudioComponent( - args: GetStudioComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStudioComponentCommandOutput) => void), - cb?: (err: any, data?: GetStudioComponentCommandOutput) => void - ): Promise | void { - const command = new GetStudioComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get a user's membership in a studio.

+ * @see {@link GetStudioMemberCommand} */ - public getStudioMember( + getStudioMember( args: GetStudioMemberCommandInput, options?: __HttpHandlerOptions ): Promise; - public getStudioMember( - args: GetStudioMemberCommandInput, - cb: (err: any, data?: GetStudioMemberCommandOutput) => void - ): void; - public getStudioMember( + getStudioMember(args: GetStudioMemberCommandInput, cb: (err: any, data?: GetStudioMemberCommandOutput) => void): void; + getStudioMember( args: GetStudioMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStudioMemberCommandOutput) => void ): void; - public getStudioMember( - args: GetStudioMemberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStudioMemberCommandOutput) => void), - cb?: (err: any, data?: GetStudioMemberCommandOutput) => void - ): Promise | void { - const command = new GetStudioMemberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List EULA acceptances.

+ * @see {@link ListEulaAcceptancesCommand} */ - public listEulaAcceptances( + listEulaAcceptances( args: ListEulaAcceptancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEulaAcceptances( + listEulaAcceptances( args: ListEulaAcceptancesCommandInput, cb: (err: any, data?: ListEulaAcceptancesCommandOutput) => void ): void; - public listEulaAcceptances( + listEulaAcceptances( args: ListEulaAcceptancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEulaAcceptancesCommandOutput) => void ): void; - public listEulaAcceptances( - args: ListEulaAcceptancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEulaAcceptancesCommandOutput) => void), - cb?: (err: any, data?: ListEulaAcceptancesCommandOutput) => void - ): Promise | void { - const command = new ListEulaAcceptancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List EULAs.

+ * @see {@link ListEulasCommand} */ - public listEulas(args: ListEulasCommandInput, options?: __HttpHandlerOptions): Promise; - public listEulas(args: ListEulasCommandInput, cb: (err: any, data?: ListEulasCommandOutput) => void): void; - public listEulas( + listEulas(args: ListEulasCommandInput, options?: __HttpHandlerOptions): Promise; + listEulas(args: ListEulasCommandInput, cb: (err: any, data?: ListEulasCommandOutput) => void): void; + listEulas( args: ListEulasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEulasCommandOutput) => void ): void; - public listEulas( - args: ListEulasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEulasCommandOutput) => void), - cb?: (err: any, data?: ListEulasCommandOutput) => void - ): Promise | void { - const command = new ListEulasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get all users in a given launch profile membership.

+ * @see {@link ListLaunchProfileMembersCommand} */ - public listLaunchProfileMembers( + listLaunchProfileMembers( args: ListLaunchProfileMembersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLaunchProfileMembers( + listLaunchProfileMembers( args: ListLaunchProfileMembersCommandInput, cb: (err: any, data?: ListLaunchProfileMembersCommandOutput) => void ): void; - public listLaunchProfileMembers( + listLaunchProfileMembers( args: ListLaunchProfileMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLaunchProfileMembersCommandOutput) => void ): void; - public listLaunchProfileMembers( - args: ListLaunchProfileMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLaunchProfileMembersCommandOutput) => void), - cb?: (err: any, data?: ListLaunchProfileMembersCommandOutput) => void - ): Promise | void { - const command = new ListLaunchProfileMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all the launch profiles a studio.

+ * @see {@link ListLaunchProfilesCommand} */ - public listLaunchProfiles( + listLaunchProfiles( args: ListLaunchProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLaunchProfiles( + listLaunchProfiles( args: ListLaunchProfilesCommandInput, cb: (err: any, data?: ListLaunchProfilesCommandOutput) => void ): void; - public listLaunchProfiles( + listLaunchProfiles( args: ListLaunchProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLaunchProfilesCommandOutput) => void ): void; - public listLaunchProfiles( - args: ListLaunchProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLaunchProfilesCommandOutput) => void), - cb?: (err: any, data?: ListLaunchProfilesCommandOutput) => void - ): Promise | void { - const command = new ListLaunchProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the streaming image resources available to this studio.

- *

This list will contain both images provided by Amazon Web Services, as well as - * streaming images that you have created in your studio.

+ * @see {@link ListStreamingImagesCommand} */ - public listStreamingImages( + listStreamingImages( args: ListStreamingImagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStreamingImages( + listStreamingImages( args: ListStreamingImagesCommandInput, cb: (err: any, data?: ListStreamingImagesCommandOutput) => void ): void; - public listStreamingImages( + listStreamingImages( args: ListStreamingImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamingImagesCommandOutput) => void ): void; - public listStreamingImages( - args: ListStreamingImagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStreamingImagesCommandOutput) => void), - cb?: (err: any, data?: ListStreamingImagesCommandOutput) => void - ): Promise | void { - const command = new ListStreamingImagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the backups of a streaming session in a studio.

+ * @see {@link ListStreamingSessionBackupsCommand} */ - public listStreamingSessionBackups( + listStreamingSessionBackups( args: ListStreamingSessionBackupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStreamingSessionBackups( + listStreamingSessionBackups( args: ListStreamingSessionBackupsCommandInput, cb: (err: any, data?: ListStreamingSessionBackupsCommandOutput) => void ): void; - public listStreamingSessionBackups( + listStreamingSessionBackups( args: ListStreamingSessionBackupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamingSessionBackupsCommandOutput) => void ): void; - public listStreamingSessionBackups( - args: ListStreamingSessionBackupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStreamingSessionBackupsCommandOutput) => void), - cb?: (err: any, data?: ListStreamingSessionBackupsCommandOutput) => void - ): Promise | void { - const command = new ListStreamingSessionBackupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the streaming sessions in a studio.

+ * @see {@link ListStreamingSessionsCommand} */ - public listStreamingSessions( + listStreamingSessions( args: ListStreamingSessionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStreamingSessions( + listStreamingSessions( args: ListStreamingSessionsCommandInput, cb: (err: any, data?: ListStreamingSessionsCommandOutput) => void ): void; - public listStreamingSessions( + listStreamingSessions( args: ListStreamingSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamingSessionsCommandOutput) => void ): void; - public listStreamingSessions( - args: ListStreamingSessionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStreamingSessionsCommandOutput) => void), - cb?: (err: any, data?: ListStreamingSessionsCommandOutput) => void - ): Promise | void { - const command = new ListStreamingSessionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the StudioComponents in a studio.

+ * @see {@link ListStudioComponentsCommand} */ - public listStudioComponents( + listStudioComponents( args: ListStudioComponentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStudioComponents( + listStudioComponents( args: ListStudioComponentsCommandInput, cb: (err: any, data?: ListStudioComponentsCommandOutput) => void ): void; - public listStudioComponents( + listStudioComponents( args: ListStudioComponentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStudioComponentsCommandOutput) => void ): void; - public listStudioComponents( - args: ListStudioComponentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStudioComponentsCommandOutput) => void), - cb?: (err: any, data?: ListStudioComponentsCommandOutput) => void - ): Promise | void { - const command = new ListStudioComponentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get all users in a given studio membership.

- * - *

- * ListStudioMembers only returns admin members.

- *
+ * @see {@link ListStudioMembersCommand} */ - public listStudioMembers( + listStudioMembers( args: ListStudioMembersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStudioMembers( + listStudioMembers( args: ListStudioMembersCommandInput, cb: (err: any, data?: ListStudioMembersCommandOutput) => void ): void; - public listStudioMembers( + listStudioMembers( args: ListStudioMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStudioMembersCommandOutput) => void ): void; - public listStudioMembers( - args: ListStudioMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStudioMembersCommandOutput) => void), - cb?: (err: any, data?: ListStudioMembersCommandOutput) => void - ): Promise | void { - const command = new ListStudioMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.

+ * @see {@link ListStudiosCommand} */ - public listStudios(args: ListStudiosCommandInput, options?: __HttpHandlerOptions): Promise; - public listStudios(args: ListStudiosCommandInput, cb: (err: any, data?: ListStudiosCommandOutput) => void): void; - public listStudios( + listStudios(args: ListStudiosCommandInput, options?: __HttpHandlerOptions): Promise; + listStudios(args: ListStudiosCommandInput, cb: (err: any, data?: ListStudiosCommandOutput) => void): void; + listStudios( args: ListStudiosCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStudiosCommandOutput) => void ): void; - public listStudios( - args: ListStudiosCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStudiosCommandOutput) => void), - cb?: (err: any, data?: ListStudiosCommandOutput) => void - ): Promise | void { - const command = new ListStudiosCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the tags for a resource, given its Amazon Resource Names (ARN).

- *

This operation supports ARNs for all resource types in Nimble Studio that support - * tags, including studio, studio component, launch profile, streaming image, and streaming - * session. All resources that can be tagged will contain an ARN property, so you do not - * have to create this ARN yourself.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Add/update users with given persona to launch profile membership.

+ * @see {@link PutLaunchProfileMembersCommand} */ - public putLaunchProfileMembers( + putLaunchProfileMembers( args: PutLaunchProfileMembersCommandInput, options?: __HttpHandlerOptions ): Promise; - public putLaunchProfileMembers( + putLaunchProfileMembers( args: PutLaunchProfileMembersCommandInput, cb: (err: any, data?: PutLaunchProfileMembersCommandOutput) => void ): void; - public putLaunchProfileMembers( + putLaunchProfileMembers( args: PutLaunchProfileMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLaunchProfileMembersCommandOutput) => void ): void; - public putLaunchProfileMembers( - args: PutLaunchProfileMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutLaunchProfileMembersCommandOutput) => void), - cb?: (err: any, data?: PutLaunchProfileMembersCommandOutput) => void - ): Promise | void { - const command = new PutLaunchProfileMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Add/update users with given persona to studio membership.

+ * @see {@link PutStudioMembersCommand} */ - public putStudioMembers( + putStudioMembers( args: PutStudioMembersCommandInput, options?: __HttpHandlerOptions ): Promise; - public putStudioMembers( + putStudioMembers( args: PutStudioMembersCommandInput, cb: (err: any, data?: PutStudioMembersCommandOutput) => void ): void; - public putStudioMembers( + putStudioMembers( args: PutStudioMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutStudioMembersCommandOutput) => void ): void; - public putStudioMembers( - args: PutStudioMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutStudioMembersCommandOutput) => void), - cb?: (err: any, data?: PutStudioMembersCommandOutput) => void - ): Promise | void { - const command = new PutStudioMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Transitions sessions from the STOPPED state into the READY - * state. The START_IN_PROGRESS state is the intermediate state between the - * STOPPED and READY states.

+ * @see {@link StartStreamingSessionCommand} */ - public startStreamingSession( + startStreamingSession( args: StartStreamingSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startStreamingSession( + startStreamingSession( args: StartStreamingSessionCommandInput, cb: (err: any, data?: StartStreamingSessionCommandOutput) => void ): void; - public startStreamingSession( + startStreamingSession( args: StartStreamingSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartStreamingSessionCommandOutput) => void ): void; - public startStreamingSession( - args: StartStreamingSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartStreamingSessionCommandOutput) => void), - cb?: (err: any, data?: StartStreamingSessionCommandOutput) => void - ): Promise | void { - const command = new StartStreamingSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Repairs the IAM Identity Center configuration for a given studio.

- *

If the studio has a valid IAM Identity Center configuration currently associated with - * it, this operation will fail with a validation error.

- *

If the studio does not have a valid IAM Identity Center configuration currently - * associated with it, then a new IAM Identity Center application is created for the studio - * and the studio is changed to the READY state.

- *

After the IAM Identity Center application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.

+ * @see {@link StartStudioSSOConfigurationRepairCommand} */ - public startStudioSSOConfigurationRepair( + startStudioSSOConfigurationRepair( args: StartStudioSSOConfigurationRepairCommandInput, options?: __HttpHandlerOptions ): Promise; - public startStudioSSOConfigurationRepair( + startStudioSSOConfigurationRepair( args: StartStudioSSOConfigurationRepairCommandInput, cb: (err: any, data?: StartStudioSSOConfigurationRepairCommandOutput) => void ): void; - public startStudioSSOConfigurationRepair( + startStudioSSOConfigurationRepair( args: StartStudioSSOConfigurationRepairCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartStudioSSOConfigurationRepairCommandOutput) => void ): void; - public startStudioSSOConfigurationRepair( - args: StartStudioSSOConfigurationRepairCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartStudioSSOConfigurationRepairCommandOutput) => void), - cb?: (err: any, data?: StartStudioSSOConfigurationRepairCommandOutput) => void - ): Promise | void { - const command = new StartStudioSSOConfigurationRepairCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Transitions sessions from the READY state into the STOPPED - * state. The STOP_IN_PROGRESS state is the intermediate state between the - * READY and STOPPED states.

+ * @see {@link StopStreamingSessionCommand} */ - public stopStreamingSession( + stopStreamingSession( args: StopStreamingSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopStreamingSession( + stopStreamingSession( args: StopStreamingSessionCommandInput, cb: (err: any, data?: StopStreamingSessionCommandOutput) => void ): void; - public stopStreamingSession( + stopStreamingSession( args: StopStreamingSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopStreamingSessionCommandOutput) => void ): void; - public stopStreamingSession( - args: StopStreamingSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopStreamingSessionCommandOutput) => void), - cb?: (err: any, data?: StopStreamingSessionCommandOutput) => void - ): Promise | void { - const command = new StopStreamingSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates tags for a resource, given its ARN.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the tags for a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update a launch profile.

+ * @see {@link UpdateLaunchProfileCommand} */ - public updateLaunchProfile( + updateLaunchProfile( args: UpdateLaunchProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLaunchProfile( + updateLaunchProfile( args: UpdateLaunchProfileCommandInput, cb: (err: any, data?: UpdateLaunchProfileCommandOutput) => void ): void; - public updateLaunchProfile( + updateLaunchProfile( args: UpdateLaunchProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLaunchProfileCommandOutput) => void ): void; - public updateLaunchProfile( - args: UpdateLaunchProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLaunchProfileCommandOutput) => void), - cb?: (err: any, data?: UpdateLaunchProfileCommandOutput) => void - ): Promise | void { - const command = new UpdateLaunchProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update a user persona in launch profile membership.

+ * @see {@link UpdateLaunchProfileMemberCommand} */ - public updateLaunchProfileMember( + updateLaunchProfileMember( args: UpdateLaunchProfileMemberCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLaunchProfileMember( + updateLaunchProfileMember( args: UpdateLaunchProfileMemberCommandInput, cb: (err: any, data?: UpdateLaunchProfileMemberCommandOutput) => void ): void; - public updateLaunchProfileMember( + updateLaunchProfileMember( args: UpdateLaunchProfileMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLaunchProfileMemberCommandOutput) => void ): void; - public updateLaunchProfileMember( - args: UpdateLaunchProfileMemberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLaunchProfileMemberCommandOutput) => void), - cb?: (err: any, data?: UpdateLaunchProfileMemberCommandOutput) => void - ): Promise | void { - const command = new UpdateLaunchProfileMemberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update streaming image.

+ * @see {@link UpdateStreamingImageCommand} */ - public updateStreamingImage( + updateStreamingImage( args: UpdateStreamingImageCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateStreamingImage( + updateStreamingImage( args: UpdateStreamingImageCommandInput, cb: (err: any, data?: UpdateStreamingImageCommandOutput) => void ): void; - public updateStreamingImage( + updateStreamingImage( args: UpdateStreamingImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStreamingImageCommandOutput) => void ): void; - public updateStreamingImage( - args: UpdateStreamingImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStreamingImageCommandOutput) => void), - cb?: (err: any, data?: UpdateStreamingImageCommandOutput) => void - ): Promise | void { - const command = new UpdateStreamingImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update a Studio resource.

- *

Currently, this operation only supports updating the displayName of your - * studio.

+ * @see {@link UpdateStudioCommand} */ - public updateStudio( - args: UpdateStudioCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateStudio(args: UpdateStudioCommandInput, cb: (err: any, data?: UpdateStudioCommandOutput) => void): void; - public updateStudio( + updateStudio(args: UpdateStudioCommandInput, options?: __HttpHandlerOptions): Promise; + updateStudio(args: UpdateStudioCommandInput, cb: (err: any, data?: UpdateStudioCommandOutput) => void): void; + updateStudio( args: UpdateStudioCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStudioCommandOutput) => void ): void; - public updateStudio( - args: UpdateStudioCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStudioCommandOutput) => void), - cb?: (err: any, data?: UpdateStudioCommandOutput) => void - ): Promise | void { - const command = new UpdateStudioCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a studio component resource.

+ * @see {@link UpdateStudioComponentCommand} */ - public updateStudioComponent( + updateStudioComponent( args: UpdateStudioComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateStudioComponent( + updateStudioComponent( args: UpdateStudioComponentCommandInput, cb: (err: any, data?: UpdateStudioComponentCommandOutput) => void ): void; - public updateStudioComponent( + updateStudioComponent( args: UpdateStudioComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStudioComponentCommandOutput) => void ): void; - public updateStudioComponent( - args: UpdateStudioComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStudioComponentCommandOutput) => void), - cb?: (err: any, data?: UpdateStudioComponentCommandOutput) => void - ): Promise | void { - const command = new UpdateStudioComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Welcome to the Amazon Nimble Studio API reference. This API reference provides + * methods, schema, resources, parameters, and more to help you get the most out of Nimble + * Studio.

+ *

Nimble Studio is a virtual studio that empowers visual effects, animation, and + * interactive content teams to create content securely within a scalable, private cloud + * service.

+ */ +export class Nimble extends NimbleClient implements Nimble {} +createAggregatedClient(commands, Nimble); diff --git a/clients/client-oam/src/OAM.ts b/clients/client-oam/src/OAM.ts index 2ee469cd3720..c7f82b240157 100644 --- a/clients/client-oam/src/OAM.ts +++ b/clients/client-oam/src/OAM.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { CreateLinkCommand, CreateLinkCommandInput, CreateLinkCommandOutput } from "./commands/CreateLinkCommand"; @@ -36,527 +37,219 @@ import { UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; import { UpdateLinkCommand, UpdateLinkCommandInput, UpdateLinkCommandOutput } from "./commands/UpdateLinkCommand"; -import { OAMClient } from "./OAMClient"; +import { OAMClient, OAMClientConfig } from "./OAMClient"; + +const commands = { + CreateLinkCommand, + CreateSinkCommand, + DeleteLinkCommand, + DeleteSinkCommand, + GetLinkCommand, + GetSinkCommand, + GetSinkPolicyCommand, + ListAttachedLinksCommand, + ListLinksCommand, + ListSinksCommand, + ListTagsForResourceCommand, + PutSinkPolicyCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateLinkCommand, +}; -/** - * @public - *

Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and - * monitoring accounts by using CloudWatch cross-account observability. With - * CloudWatch cross-account observability, you can monitor and troubleshoot applications that span - * multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics, - * logs, and traces in any of the linked accounts without account boundaries.

- * - *

Set up one or more Amazon Web Services accounts as monitoring - * accounts and link them with multiple source accounts. A - * monitoring account is a central Amazon Web Services account that can view and interact with - * observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it. - * Source accounts share their observability data with the monitoring account. The shared - * observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, and traces in X-Ray.

- */ -export class OAM extends OAMClient { +export interface OAM { /** - * @public - *

Creates a link between a source account and a sink that you have created in a monitoring account.

- *

Before you create a link, you must create a sink in the monitoring account and create a - * sink policy in that account. The sink policy must permit the source account to link to it. You - * can grant permission to source accounts by granting permission to an entire organization or to - * individual accounts.

- *

For more information, see - * CreateSink and - * PutSinkPolicy.

- *

Each monitoring account can be linked to as many as 100,000 source accounts.

- *

Each source account can be linked to as many as five monitoring accounts.

+ * @see {@link CreateLinkCommand} */ - public createLink(args: CreateLinkCommandInput, options?: __HttpHandlerOptions): Promise; - public createLink(args: CreateLinkCommandInput, cb: (err: any, data?: CreateLinkCommandOutput) => void): void; - public createLink( + createLink(args: CreateLinkCommandInput, options?: __HttpHandlerOptions): Promise; + createLink(args: CreateLinkCommandInput, cb: (err: any, data?: CreateLinkCommandOutput) => void): void; + createLink( args: CreateLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLinkCommandOutput) => void ): void; - public createLink( - args: CreateLinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLinkCommandOutput) => void), - cb?: (err: any, data?: CreateLinkCommandOutput) => void - ): Promise | void { - const command = new CreateLinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this to create a sink in the current account, so that it can be - * used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that - * represents an attachment point in a monitoring account. Source accounts can link to the sink - * to send observability data.

- *

After you create a sink, you must create a sink policy that allows source accounts to attach to it. - * For more information, see PutSinkPolicy.

- *

Each account can contain one sink. If you delete a sink, you can then create a new one in that account.

+ * @see {@link CreateSinkCommand} */ - public createSink(args: CreateSinkCommandInput, options?: __HttpHandlerOptions): Promise; - public createSink(args: CreateSinkCommandInput, cb: (err: any, data?: CreateSinkCommandOutput) => void): void; - public createSink( + createSink(args: CreateSinkCommandInput, options?: __HttpHandlerOptions): Promise; + createSink(args: CreateSinkCommandInput, cb: (err: any, data?: CreateSinkCommandOutput) => void): void; + createSink( args: CreateSinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSinkCommandOutput) => void ): void; - public createSink( - args: CreateSinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSinkCommandOutput) => void), - cb?: (err: any, data?: CreateSinkCommandOutput) => void - ): Promise | void { - const command = new CreateSinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a link between a monitoring account sink and a source account. You must run this operation - * in the source account.

+ * @see {@link DeleteLinkCommand} */ - public deleteLink(args: DeleteLinkCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteLink(args: DeleteLinkCommandInput, cb: (err: any, data?: DeleteLinkCommandOutput) => void): void; - public deleteLink( + deleteLink(args: DeleteLinkCommandInput, options?: __HttpHandlerOptions): Promise; + deleteLink(args: DeleteLinkCommandInput, cb: (err: any, data?: DeleteLinkCommandOutput) => void): void; + deleteLink( args: DeleteLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLinkCommandOutput) => void ): void; - public deleteLink( - args: DeleteLinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLinkCommandOutput) => void), - cb?: (err: any, data?: DeleteLinkCommandOutput) => void - ): Promise | void { - const command = new DeleteLinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a sink. You must delete all links to a sink before you can delete that sink.

+ * @see {@link DeleteSinkCommand} */ - public deleteSink(args: DeleteSinkCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteSink(args: DeleteSinkCommandInput, cb: (err: any, data?: DeleteSinkCommandOutput) => void): void; - public deleteSink( + deleteSink(args: DeleteSinkCommandInput, options?: __HttpHandlerOptions): Promise; + deleteSink(args: DeleteSinkCommandInput, cb: (err: any, data?: DeleteSinkCommandOutput) => void): void; + deleteSink( args: DeleteSinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSinkCommandOutput) => void ): void; - public deleteSink( - args: DeleteSinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSinkCommandOutput) => void), - cb?: (err: any, data?: DeleteSinkCommandOutput) => void - ): Promise | void { - const command = new DeleteSinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns complete information about one link.

- *

To use this operation, provide the link ARN. To retrieve a list of link ARNs, use ListLinks.

+ * @see {@link GetLinkCommand} */ - public getLink(args: GetLinkCommandInput, options?: __HttpHandlerOptions): Promise; - public getLink(args: GetLinkCommandInput, cb: (err: any, data?: GetLinkCommandOutput) => void): void; - public getLink( + getLink(args: GetLinkCommandInput, options?: __HttpHandlerOptions): Promise; + getLink(args: GetLinkCommandInput, cb: (err: any, data?: GetLinkCommandOutput) => void): void; + getLink( args: GetLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLinkCommandOutput) => void ): void; - public getLink( - args: GetLinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLinkCommandOutput) => void), - cb?: (err: any, data?: GetLinkCommandOutput) => void - ): Promise | void { - const command = new GetLinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns complete information about one monitoring account sink.

- *

To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.

+ * @see {@link GetSinkCommand} */ - public getSink(args: GetSinkCommandInput, options?: __HttpHandlerOptions): Promise; - public getSink(args: GetSinkCommandInput, cb: (err: any, data?: GetSinkCommandOutput) => void): void; - public getSink( + getSink(args: GetSinkCommandInput, options?: __HttpHandlerOptions): Promise; + getSink(args: GetSinkCommandInput, cb: (err: any, data?: GetSinkCommandOutput) => void): void; + getSink( args: GetSinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSinkCommandOutput) => void ): void; - public getSink( - args: GetSinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSinkCommandOutput) => void), - cb?: (err: any, data?: GetSinkCommandOutput) => void - ): Promise | void { - const command = new GetSinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the current sink policy attached to this sink. The sink policy specifies what - * accounts can attach to this sink as source accounts, and what types of data they can share.

+ * @see {@link GetSinkPolicyCommand} */ - public getSinkPolicy( - args: GetSinkPolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getSinkPolicy( - args: GetSinkPolicyCommandInput, - cb: (err: any, data?: GetSinkPolicyCommandOutput) => void - ): void; - public getSinkPolicy( + getSinkPolicy(args: GetSinkPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + getSinkPolicy(args: GetSinkPolicyCommandInput, cb: (err: any, data?: GetSinkPolicyCommandOutput) => void): void; + getSinkPolicy( args: GetSinkPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSinkPolicyCommandOutput) => void ): void; - public getSinkPolicy( - args: GetSinkPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSinkPolicyCommandOutput) => void), - cb?: (err: any, data?: GetSinkPolicyCommandOutput) => void - ): Promise | void { - const command = new GetSinkPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of source account links that are linked to this monitoring account sink.

- *

To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.

- *

To find a list of links for one source account, use ListLinks.

+ * @see {@link ListAttachedLinksCommand} */ - public listAttachedLinks( + listAttachedLinks( args: ListAttachedLinksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAttachedLinks( + listAttachedLinks( args: ListAttachedLinksCommandInput, cb: (err: any, data?: ListAttachedLinksCommandOutput) => void ): void; - public listAttachedLinks( + listAttachedLinks( args: ListAttachedLinksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAttachedLinksCommandOutput) => void ): void; - public listAttachedLinks( - args: ListAttachedLinksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAttachedLinksCommandOutput) => void), - cb?: (err: any, data?: ListAttachedLinksCommandOutput) => void - ): Promise | void { - const command = new ListAttachedLinksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this operation in a source account to return a list of links to monitoring account sinks that - * this source account has.

- *

To find a list of links for one monitoring account sink, use ListAttachedLinks from within the monitoring account.

+ * @see {@link ListLinksCommand} */ - public listLinks(args: ListLinksCommandInput, options?: __HttpHandlerOptions): Promise; - public listLinks(args: ListLinksCommandInput, cb: (err: any, data?: ListLinksCommandOutput) => void): void; - public listLinks( + listLinks(args: ListLinksCommandInput, options?: __HttpHandlerOptions): Promise; + listLinks(args: ListLinksCommandInput, cb: (err: any, data?: ListLinksCommandOutput) => void): void; + listLinks( args: ListLinksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLinksCommandOutput) => void ): void; - public listLinks( - args: ListLinksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLinksCommandOutput) => void), - cb?: (err: any, data?: ListLinksCommandOutput) => void - ): Promise | void { - const command = new ListLinksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this operation in a monitoring account to return the list of sinks created in that account.

+ * @see {@link ListSinksCommand} */ - public listSinks(args: ListSinksCommandInput, options?: __HttpHandlerOptions): Promise; - public listSinks(args: ListSinksCommandInput, cb: (err: any, data?: ListSinksCommandOutput) => void): void; - public listSinks( + listSinks(args: ListSinksCommandInput, options?: __HttpHandlerOptions): Promise; + listSinks(args: ListSinksCommandInput, cb: (err: any, data?: ListSinksCommandOutput) => void): void; + listSinks( args: ListSinksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSinksCommandOutput) => void ): void; - public listSinks( - args: ListSinksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSinksCommandOutput) => void), - cb?: (err: any, data?: ListSinksCommandOutput) => void - ): Promise | void { - const command = new ListSinksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays the tags associated with a resource. Both sinks and links support tagging.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates the resource policy that grants permissions to source - * accounts to link to the monitoring account sink. When you create a sink policy, you can grant - * permissions to all accounts in an organization or to individual accounts.

- *

You can also use a sink policy to limit the types of data that is shared. The three types that - * you can allow or deny are:

- *
    - *
  • - *

    - * Metrics - Specify with - * AWS::CloudWatch::Metric - *

    - *
  • - *
  • - *

    - * Log groups - Specify with AWS::Logs::LogGroup - *

    - *
  • - *
  • - *

    - * Traces - Specify with AWS::XRay::Trace - *

    - *
  • - *
- *

See the examples in this section to see how to specify permitted source accounts and data types.

+ * @see {@link PutSinkPolicyCommand} */ - public putSinkPolicy( - args: PutSinkPolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putSinkPolicy( - args: PutSinkPolicyCommandInput, - cb: (err: any, data?: PutSinkPolicyCommandOutput) => void - ): void; - public putSinkPolicy( + putSinkPolicy(args: PutSinkPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + putSinkPolicy(args: PutSinkPolicyCommandInput, cb: (err: any, data?: PutSinkPolicyCommandOutput) => void): void; + putSinkPolicy( args: PutSinkPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSinkPolicyCommandOutput) => void ): void; - public putSinkPolicy( - args: PutSinkPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutSinkPolicyCommandOutput) => void), - cb?: (err: any, data?: PutSinkPolicyCommandOutput) => void - ): Promise | void { - const command = new PutSinkPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns one or more tags (key-value pairs) to the specified resource. - * Both sinks and links can be tagged.

- *

Tags can help you organize and categorize your resources. You can also use them to scope user - * permissions by granting a user - * permission to access or change only resources with certain tag values.

- *

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

- *

You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, - * this tag is appended to the list of tags associated - * with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces - * the previous value for that tag.

- *

You can associate as many as 50 tags with a resource.

- * - *

Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and - * sinks you must have the oam:ResourceTag permission. The - * iam:ResourceTag permission does not allow you to tag and untag links and - * sinks.

- *
+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from the specified resource.

- * - *

Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and - * sinks you must have the oam:ResourceTag permission. The - * iam:TagResource permission does not allow you to tag and untag links and - * sinks.

- *
+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this operation to change what types of data are shared from a source account to its linked - * monitoring account sink. You can't change the sink or change the monitoring account with this operation.

- *

To update the list of tags associated with the sink, use - * TagResource.

+ * @see {@link UpdateLinkCommand} */ - public updateLink(args: UpdateLinkCommandInput, options?: __HttpHandlerOptions): Promise; - public updateLink(args: UpdateLinkCommandInput, cb: (err: any, data?: UpdateLinkCommandOutput) => void): void; - public updateLink( + updateLink(args: UpdateLinkCommandInput, options?: __HttpHandlerOptions): Promise; + updateLink(args: UpdateLinkCommandInput, cb: (err: any, data?: UpdateLinkCommandOutput) => void): void; + updateLink( args: UpdateLinkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLinkCommandOutput) => void ): void; - public updateLink( - args: UpdateLinkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLinkCommandOutput) => void), - cb?: (err: any, data?: UpdateLinkCommandOutput) => void - ): Promise | void { - const command = new UpdateLinkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and + * monitoring accounts by using CloudWatch cross-account observability. With + * CloudWatch cross-account observability, you can monitor and troubleshoot applications that span + * multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics, + * logs, and traces in any of the linked accounts without account boundaries.

+ * + *

Set up one or more Amazon Web Services accounts as monitoring + * accounts and link them with multiple source accounts. A + * monitoring account is a central Amazon Web Services account that can view and interact with + * observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it. + * Source accounts share their observability data with the monitoring account. The shared + * observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, and traces in X-Ray.

+ */ +export class OAM extends OAMClient implements OAM {} +createAggregatedClient(commands, OAM); diff --git a/clients/client-omics/src/Omics.ts b/clients/client-omics/src/Omics.ts index 690f6f4457e9..c32a4181a548 100644 --- a/clients/client-omics/src/Omics.ts +++ b/clients/client-omics/src/Omics.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -291,2121 +292,1082 @@ import { UpdateWorkflowCommandInput, UpdateWorkflowCommandOutput, } from "./commands/UpdateWorkflowCommand"; -import { OmicsClient } from "./OmicsClient"; +import { OmicsClient, OmicsClientConfig } from "./OmicsClient"; -/** - * @public - *

This is the Amazon Omics API Reference. For an introduction to the service, see What is Amazon Omics? in the - * Amazon Omics Developer Guide.

- */ -export class Omics extends OmicsClient { +const commands = { + BatchDeleteReadSetCommand, + CancelAnnotationImportJobCommand, + CancelRunCommand, + CancelVariantImportJobCommand, + CreateAnnotationStoreCommand, + CreateReferenceStoreCommand, + CreateRunGroupCommand, + CreateSequenceStoreCommand, + CreateVariantStoreCommand, + CreateWorkflowCommand, + DeleteAnnotationStoreCommand, + DeleteReferenceCommand, + DeleteReferenceStoreCommand, + DeleteRunCommand, + DeleteRunGroupCommand, + DeleteSequenceStoreCommand, + DeleteVariantStoreCommand, + DeleteWorkflowCommand, + GetAnnotationImportJobCommand, + GetAnnotationStoreCommand, + GetReadSetCommand, + GetReadSetActivationJobCommand, + GetReadSetExportJobCommand, + GetReadSetImportJobCommand, + GetReadSetMetadataCommand, + GetReferenceCommand, + GetReferenceImportJobCommand, + GetReferenceMetadataCommand, + GetReferenceStoreCommand, + GetRunCommand, + GetRunGroupCommand, + GetRunTaskCommand, + GetSequenceStoreCommand, + GetVariantImportJobCommand, + GetVariantStoreCommand, + GetWorkflowCommand, + ListAnnotationImportJobsCommand, + ListAnnotationStoresCommand, + ListReadSetActivationJobsCommand, + ListReadSetExportJobsCommand, + ListReadSetImportJobsCommand, + ListReadSetsCommand, + ListReferenceImportJobsCommand, + ListReferencesCommand, + ListReferenceStoresCommand, + ListRunGroupsCommand, + ListRunsCommand, + ListRunTasksCommand, + ListSequenceStoresCommand, + ListTagsForResourceCommand, + ListVariantImportJobsCommand, + ListVariantStoresCommand, + ListWorkflowsCommand, + StartAnnotationImportJobCommand, + StartReadSetActivationJobCommand, + StartReadSetExportJobCommand, + StartReadSetImportJobCommand, + StartReferenceImportJobCommand, + StartRunCommand, + StartVariantImportJobCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAnnotationStoreCommand, + UpdateRunGroupCommand, + UpdateVariantStoreCommand, + UpdateWorkflowCommand, +}; + +export interface Omics { /** - * @public - *

Deletes one or more read sets.

+ * @see {@link BatchDeleteReadSetCommand} */ - public batchDeleteReadSet( + batchDeleteReadSet( args: BatchDeleteReadSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeleteReadSet( + batchDeleteReadSet( args: BatchDeleteReadSetCommandInput, cb: (err: any, data?: BatchDeleteReadSetCommandOutput) => void ): void; - public batchDeleteReadSet( + batchDeleteReadSet( args: BatchDeleteReadSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteReadSetCommandOutput) => void ): void; - public batchDeleteReadSet( - args: BatchDeleteReadSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeleteReadSetCommandOutput) => void), - cb?: (err: any, data?: BatchDeleteReadSetCommandOutput) => void - ): Promise | void { - const command = new BatchDeleteReadSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels an annotation import job.

- */ - public cancelAnnotationImportJob( + + /** + * @see {@link CancelAnnotationImportJobCommand} + */ + cancelAnnotationImportJob( args: CancelAnnotationImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelAnnotationImportJob( + cancelAnnotationImportJob( args: CancelAnnotationImportJobCommandInput, cb: (err: any, data?: CancelAnnotationImportJobCommandOutput) => void ): void; - public cancelAnnotationImportJob( + cancelAnnotationImportJob( args: CancelAnnotationImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelAnnotationImportJobCommandOutput) => void ): void; - public cancelAnnotationImportJob( - args: CancelAnnotationImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelAnnotationImportJobCommandOutput) => void), - cb?: (err: any, data?: CancelAnnotationImportJobCommandOutput) => void - ): Promise | void { - const command = new CancelAnnotationImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels a run.

- */ - public cancelRun(args: CancelRunCommandInput, options?: __HttpHandlerOptions): Promise; - public cancelRun(args: CancelRunCommandInput, cb: (err: any, data?: CancelRunCommandOutput) => void): void; - public cancelRun( + + /** + * @see {@link CancelRunCommand} + */ + cancelRun(args: CancelRunCommandInput, options?: __HttpHandlerOptions): Promise; + cancelRun(args: CancelRunCommandInput, cb: (err: any, data?: CancelRunCommandOutput) => void): void; + cancelRun( args: CancelRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelRunCommandOutput) => void ): void; - public cancelRun( - args: CancelRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelRunCommandOutput) => void), - cb?: (err: any, data?: CancelRunCommandOutput) => void - ): Promise | void { - const command = new CancelRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels a variant import job.

- */ - public cancelVariantImportJob( + + /** + * @see {@link CancelVariantImportJobCommand} + */ + cancelVariantImportJob( args: CancelVariantImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelVariantImportJob( + cancelVariantImportJob( args: CancelVariantImportJobCommandInput, cb: (err: any, data?: CancelVariantImportJobCommandOutput) => void ): void; - public cancelVariantImportJob( + cancelVariantImportJob( args: CancelVariantImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelVariantImportJobCommandOutput) => void ): void; - public cancelVariantImportJob( - args: CancelVariantImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelVariantImportJobCommandOutput) => void), - cb?: (err: any, data?: CancelVariantImportJobCommandOutput) => void - ): Promise | void { - const command = new CancelVariantImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an annotation store.

- */ - public createAnnotationStore( + + /** + * @see {@link CreateAnnotationStoreCommand} + */ + createAnnotationStore( args: CreateAnnotationStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAnnotationStore( + createAnnotationStore( args: CreateAnnotationStoreCommandInput, cb: (err: any, data?: CreateAnnotationStoreCommandOutput) => void ): void; - public createAnnotationStore( + createAnnotationStore( args: CreateAnnotationStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAnnotationStoreCommandOutput) => void ): void; - public createAnnotationStore( - args: CreateAnnotationStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAnnotationStoreCommandOutput) => void), - cb?: (err: any, data?: CreateAnnotationStoreCommandOutput) => void - ): Promise | void { - const command = new CreateAnnotationStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a reference store.

- */ - public createReferenceStore( + + /** + * @see {@link CreateReferenceStoreCommand} + */ + createReferenceStore( args: CreateReferenceStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public createReferenceStore( + createReferenceStore( args: CreateReferenceStoreCommandInput, cb: (err: any, data?: CreateReferenceStoreCommandOutput) => void ): void; - public createReferenceStore( + createReferenceStore( args: CreateReferenceStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReferenceStoreCommandOutput) => void ): void; - public createReferenceStore( - args: CreateReferenceStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateReferenceStoreCommandOutput) => void), - cb?: (err: any, data?: CreateReferenceStoreCommandOutput) => void - ): Promise | void { - const command = new CreateReferenceStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a run group.

- */ - public createRunGroup( + + /** + * @see {@link CreateRunGroupCommand} + */ + createRunGroup( args: CreateRunGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRunGroup( - args: CreateRunGroupCommandInput, - cb: (err: any, data?: CreateRunGroupCommandOutput) => void - ): void; - public createRunGroup( + createRunGroup(args: CreateRunGroupCommandInput, cb: (err: any, data?: CreateRunGroupCommandOutput) => void): void; + createRunGroup( args: CreateRunGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRunGroupCommandOutput) => void ): void; - public createRunGroup( - args: CreateRunGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRunGroupCommandOutput) => void), - cb?: (err: any, data?: CreateRunGroupCommandOutput) => void - ): Promise | void { - const command = new CreateRunGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a sequence store.

- */ - public createSequenceStore( + + /** + * @see {@link CreateSequenceStoreCommand} + */ + createSequenceStore( args: CreateSequenceStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSequenceStore( + createSequenceStore( args: CreateSequenceStoreCommandInput, cb: (err: any, data?: CreateSequenceStoreCommandOutput) => void ): void; - public createSequenceStore( + createSequenceStore( args: CreateSequenceStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSequenceStoreCommandOutput) => void ): void; - public createSequenceStore( - args: CreateSequenceStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSequenceStoreCommandOutput) => void), - cb?: (err: any, data?: CreateSequenceStoreCommandOutput) => void - ): Promise | void { - const command = new CreateSequenceStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a variant store.

- */ - public createVariantStore( + + /** + * @see {@link CreateVariantStoreCommand} + */ + createVariantStore( args: CreateVariantStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVariantStore( + createVariantStore( args: CreateVariantStoreCommandInput, cb: (err: any, data?: CreateVariantStoreCommandOutput) => void ): void; - public createVariantStore( + createVariantStore( args: CreateVariantStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVariantStoreCommandOutput) => void ): void; - public createVariantStore( - args: CreateVariantStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVariantStoreCommandOutput) => void), - cb?: (err: any, data?: CreateVariantStoreCommandOutput) => void - ): Promise | void { - const command = new CreateVariantStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a workflow.

- */ - public createWorkflow( + + /** + * @see {@link CreateWorkflowCommand} + */ + createWorkflow( args: CreateWorkflowCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorkflow( - args: CreateWorkflowCommandInput, - cb: (err: any, data?: CreateWorkflowCommandOutput) => void - ): void; - public createWorkflow( + createWorkflow(args: CreateWorkflowCommandInput, cb: (err: any, data?: CreateWorkflowCommandOutput) => void): void; + createWorkflow( args: CreateWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkflowCommandOutput) => void ): void; - public createWorkflow( - args: CreateWorkflowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorkflowCommandOutput) => void), - cb?: (err: any, data?: CreateWorkflowCommandOutput) => void - ): Promise | void { - const command = new CreateWorkflowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an annotation store.

- */ - public deleteAnnotationStore( + + /** + * @see {@link DeleteAnnotationStoreCommand} + */ + deleteAnnotationStore( args: DeleteAnnotationStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAnnotationStore( + deleteAnnotationStore( args: DeleteAnnotationStoreCommandInput, cb: (err: any, data?: DeleteAnnotationStoreCommandOutput) => void ): void; - public deleteAnnotationStore( + deleteAnnotationStore( args: DeleteAnnotationStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAnnotationStoreCommandOutput) => void ): void; - public deleteAnnotationStore( - args: DeleteAnnotationStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAnnotationStoreCommandOutput) => void), - cb?: (err: any, data?: DeleteAnnotationStoreCommandOutput) => void - ): Promise | void { - const command = new DeleteAnnotationStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a genome reference.

- */ - public deleteReference( + + /** + * @see {@link DeleteReferenceCommand} + */ + deleteReference( args: DeleteReferenceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteReference( - args: DeleteReferenceCommandInput, - cb: (err: any, data?: DeleteReferenceCommandOutput) => void - ): void; - public deleteReference( + deleteReference(args: DeleteReferenceCommandInput, cb: (err: any, data?: DeleteReferenceCommandOutput) => void): void; + deleteReference( args: DeleteReferenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReferenceCommandOutput) => void ): void; - public deleteReference( - args: DeleteReferenceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteReferenceCommandOutput) => void), - cb?: (err: any, data?: DeleteReferenceCommandOutput) => void - ): Promise | void { - const command = new DeleteReferenceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a genome reference store.

- */ - public deleteReferenceStore( + + /** + * @see {@link DeleteReferenceStoreCommand} + */ + deleteReferenceStore( args: DeleteReferenceStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteReferenceStore( + deleteReferenceStore( args: DeleteReferenceStoreCommandInput, cb: (err: any, data?: DeleteReferenceStoreCommandOutput) => void ): void; - public deleteReferenceStore( + deleteReferenceStore( args: DeleteReferenceStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReferenceStoreCommandOutput) => void ): void; - public deleteReferenceStore( - args: DeleteReferenceStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteReferenceStoreCommandOutput) => void), - cb?: (err: any, data?: DeleteReferenceStoreCommandOutput) => void - ): Promise | void { - const command = new DeleteReferenceStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a workflow run.

- */ - public deleteRun(args: DeleteRunCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteRun(args: DeleteRunCommandInput, cb: (err: any, data?: DeleteRunCommandOutput) => void): void; - public deleteRun( + + /** + * @see {@link DeleteRunCommand} + */ + deleteRun(args: DeleteRunCommandInput, options?: __HttpHandlerOptions): Promise; + deleteRun(args: DeleteRunCommandInput, cb: (err: any, data?: DeleteRunCommandOutput) => void): void; + deleteRun( args: DeleteRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRunCommandOutput) => void ): void; - public deleteRun( - args: DeleteRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRunCommandOutput) => void), - cb?: (err: any, data?: DeleteRunCommandOutput) => void - ): Promise | void { - const command = new DeleteRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a workflow run group.

- */ - public deleteRunGroup( + + /** + * @see {@link DeleteRunGroupCommand} + */ + deleteRunGroup( args: DeleteRunGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRunGroup( - args: DeleteRunGroupCommandInput, - cb: (err: any, data?: DeleteRunGroupCommandOutput) => void - ): void; - public deleteRunGroup( + deleteRunGroup(args: DeleteRunGroupCommandInput, cb: (err: any, data?: DeleteRunGroupCommandOutput) => void): void; + deleteRunGroup( args: DeleteRunGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRunGroupCommandOutput) => void ): void; - public deleteRunGroup( - args: DeleteRunGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRunGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteRunGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteRunGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a sequence store.

- */ - public deleteSequenceStore( + + /** + * @see {@link DeleteSequenceStoreCommand} + */ + deleteSequenceStore( args: DeleteSequenceStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSequenceStore( + deleteSequenceStore( args: DeleteSequenceStoreCommandInput, cb: (err: any, data?: DeleteSequenceStoreCommandOutput) => void ): void; - public deleteSequenceStore( + deleteSequenceStore( args: DeleteSequenceStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSequenceStoreCommandOutput) => void ): void; - public deleteSequenceStore( - args: DeleteSequenceStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSequenceStoreCommandOutput) => void), - cb?: (err: any, data?: DeleteSequenceStoreCommandOutput) => void - ): Promise | void { - const command = new DeleteSequenceStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a variant store.

- */ - public deleteVariantStore( + + /** + * @see {@link DeleteVariantStoreCommand} + */ + deleteVariantStore( args: DeleteVariantStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVariantStore( + deleteVariantStore( args: DeleteVariantStoreCommandInput, cb: (err: any, data?: DeleteVariantStoreCommandOutput) => void ): void; - public deleteVariantStore( + deleteVariantStore( args: DeleteVariantStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVariantStoreCommandOutput) => void ): void; - public deleteVariantStore( - args: DeleteVariantStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVariantStoreCommandOutput) => void), - cb?: (err: any, data?: DeleteVariantStoreCommandOutput) => void - ): Promise | void { - const command = new DeleteVariantStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a workflow.

- */ - public deleteWorkflow( + + /** + * @see {@link DeleteWorkflowCommand} + */ + deleteWorkflow( args: DeleteWorkflowCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWorkflow( - args: DeleteWorkflowCommandInput, - cb: (err: any, data?: DeleteWorkflowCommandOutput) => void - ): void; - public deleteWorkflow( + deleteWorkflow(args: DeleteWorkflowCommandInput, cb: (err: any, data?: DeleteWorkflowCommandOutput) => void): void; + deleteWorkflow( args: DeleteWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkflowCommandOutput) => void ): void; - public deleteWorkflow( - args: DeleteWorkflowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorkflowCommandOutput) => void), - cb?: (err: any, data?: DeleteWorkflowCommandOutput) => void - ): Promise | void { - const command = new DeleteWorkflowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about an annotation import job.

- */ - public getAnnotationImportJob( + + /** + * @see {@link GetAnnotationImportJobCommand} + */ + getAnnotationImportJob( args: GetAnnotationImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAnnotationImportJob( + getAnnotationImportJob( args: GetAnnotationImportJobCommandInput, cb: (err: any, data?: GetAnnotationImportJobCommandOutput) => void ): void; - public getAnnotationImportJob( + getAnnotationImportJob( args: GetAnnotationImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAnnotationImportJobCommandOutput) => void ): void; - public getAnnotationImportJob( - args: GetAnnotationImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAnnotationImportJobCommandOutput) => void), - cb?: (err: any, data?: GetAnnotationImportJobCommandOutput) => void - ): Promise | void { - const command = new GetAnnotationImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about an annotation store.

- */ - public getAnnotationStore( + + /** + * @see {@link GetAnnotationStoreCommand} + */ + getAnnotationStore( args: GetAnnotationStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAnnotationStore( + getAnnotationStore( args: GetAnnotationStoreCommandInput, cb: (err: any, data?: GetAnnotationStoreCommandOutput) => void ): void; - public getAnnotationStore( + getAnnotationStore( args: GetAnnotationStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAnnotationStoreCommandOutput) => void ): void; - public getAnnotationStore( - args: GetAnnotationStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAnnotationStoreCommandOutput) => void), - cb?: (err: any, data?: GetAnnotationStoreCommandOutput) => void - ): Promise | void { - const command = new GetAnnotationStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a file from a read set.

- */ - public getReadSet(args: GetReadSetCommandInput, options?: __HttpHandlerOptions): Promise; - public getReadSet(args: GetReadSetCommandInput, cb: (err: any, data?: GetReadSetCommandOutput) => void): void; - public getReadSet( + + /** + * @see {@link GetReadSetCommand} + */ + getReadSet(args: GetReadSetCommandInput, options?: __HttpHandlerOptions): Promise; + getReadSet(args: GetReadSetCommandInput, cb: (err: any, data?: GetReadSetCommandOutput) => void): void; + getReadSet( args: GetReadSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReadSetCommandOutput) => void ): void; - public getReadSet( - args: GetReadSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReadSetCommandOutput) => void), - cb?: (err: any, data?: GetReadSetCommandOutput) => void - ): Promise | void { - const command = new GetReadSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a read set activation job.

- */ - public getReadSetActivationJob( + + /** + * @see {@link GetReadSetActivationJobCommand} + */ + getReadSetActivationJob( args: GetReadSetActivationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReadSetActivationJob( + getReadSetActivationJob( args: GetReadSetActivationJobCommandInput, cb: (err: any, data?: GetReadSetActivationJobCommandOutput) => void ): void; - public getReadSetActivationJob( + getReadSetActivationJob( args: GetReadSetActivationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReadSetActivationJobCommandOutput) => void ): void; - public getReadSetActivationJob( - args: GetReadSetActivationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReadSetActivationJobCommandOutput) => void), - cb?: (err: any, data?: GetReadSetActivationJobCommandOutput) => void - ): Promise | void { - const command = new GetReadSetActivationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a read set export job.

- */ - public getReadSetExportJob( + + /** + * @see {@link GetReadSetExportJobCommand} + */ + getReadSetExportJob( args: GetReadSetExportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReadSetExportJob( + getReadSetExportJob( args: GetReadSetExportJobCommandInput, cb: (err: any, data?: GetReadSetExportJobCommandOutput) => void ): void; - public getReadSetExportJob( + getReadSetExportJob( args: GetReadSetExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReadSetExportJobCommandOutput) => void ): void; - public getReadSetExportJob( - args: GetReadSetExportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReadSetExportJobCommandOutput) => void), - cb?: (err: any, data?: GetReadSetExportJobCommandOutput) => void - ): Promise | void { - const command = new GetReadSetExportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a read set import job.

- */ - public getReadSetImportJob( + + /** + * @see {@link GetReadSetImportJobCommand} + */ + getReadSetImportJob( args: GetReadSetImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReadSetImportJob( + getReadSetImportJob( args: GetReadSetImportJobCommandInput, cb: (err: any, data?: GetReadSetImportJobCommandOutput) => void ): void; - public getReadSetImportJob( + getReadSetImportJob( args: GetReadSetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReadSetImportJobCommandOutput) => void ): void; - public getReadSetImportJob( - args: GetReadSetImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReadSetImportJobCommandOutput) => void), - cb?: (err: any, data?: GetReadSetImportJobCommandOutput) => void - ): Promise | void { - const command = new GetReadSetImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets details about a read set.

- */ - public getReadSetMetadata( + + /** + * @see {@link GetReadSetMetadataCommand} + */ + getReadSetMetadata( args: GetReadSetMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReadSetMetadata( + getReadSetMetadata( args: GetReadSetMetadataCommandInput, cb: (err: any, data?: GetReadSetMetadataCommandOutput) => void ): void; - public getReadSetMetadata( + getReadSetMetadata( args: GetReadSetMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReadSetMetadataCommandOutput) => void ): void; - public getReadSetMetadata( - args: GetReadSetMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReadSetMetadataCommandOutput) => void), - cb?: (err: any, data?: GetReadSetMetadataCommandOutput) => void - ): Promise | void { - const command = new GetReadSetMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a reference file.

- */ - public getReference( - args: GetReferenceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getReference(args: GetReferenceCommandInput, cb: (err: any, data?: GetReferenceCommandOutput) => void): void; - public getReference( + + /** + * @see {@link GetReferenceCommand} + */ + getReference(args: GetReferenceCommandInput, options?: __HttpHandlerOptions): Promise; + getReference(args: GetReferenceCommandInput, cb: (err: any, data?: GetReferenceCommandOutput) => void): void; + getReference( args: GetReferenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReferenceCommandOutput) => void ): void; - public getReference( - args: GetReferenceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReferenceCommandOutput) => void), - cb?: (err: any, data?: GetReferenceCommandOutput) => void - ): Promise | void { - const command = new GetReferenceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a reference import job.

- */ - public getReferenceImportJob( + + /** + * @see {@link GetReferenceImportJobCommand} + */ + getReferenceImportJob( args: GetReferenceImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReferenceImportJob( + getReferenceImportJob( args: GetReferenceImportJobCommandInput, cb: (err: any, data?: GetReferenceImportJobCommandOutput) => void ): void; - public getReferenceImportJob( + getReferenceImportJob( args: GetReferenceImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReferenceImportJobCommandOutput) => void ): void; - public getReferenceImportJob( - args: GetReferenceImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReferenceImportJobCommandOutput) => void), - cb?: (err: any, data?: GetReferenceImportJobCommandOutput) => void - ): Promise | void { - const command = new GetReferenceImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a genome reference's metadata.

- */ - public getReferenceMetadata( + + /** + * @see {@link GetReferenceMetadataCommand} + */ + getReferenceMetadata( args: GetReferenceMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReferenceMetadata( + getReferenceMetadata( args: GetReferenceMetadataCommandInput, cb: (err: any, data?: GetReferenceMetadataCommandOutput) => void ): void; - public getReferenceMetadata( + getReferenceMetadata( args: GetReferenceMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReferenceMetadataCommandOutput) => void ): void; - public getReferenceMetadata( - args: GetReferenceMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReferenceMetadataCommandOutput) => void), - cb?: (err: any, data?: GetReferenceMetadataCommandOutput) => void - ): Promise | void { - const command = new GetReferenceMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a reference store.

- */ - public getReferenceStore( + + /** + * @see {@link GetReferenceStoreCommand} + */ + getReferenceStore( args: GetReferenceStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReferenceStore( + getReferenceStore( args: GetReferenceStoreCommandInput, cb: (err: any, data?: GetReferenceStoreCommandOutput) => void ): void; - public getReferenceStore( + getReferenceStore( args: GetReferenceStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReferenceStoreCommandOutput) => void ): void; - public getReferenceStore( - args: GetReferenceStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReferenceStoreCommandOutput) => void), - cb?: (err: any, data?: GetReferenceStoreCommandOutput) => void - ): Promise | void { - const command = new GetReferenceStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a workflow run.

- */ - public getRun(args: GetRunCommandInput, options?: __HttpHandlerOptions): Promise; - public getRun(args: GetRunCommandInput, cb: (err: any, data?: GetRunCommandOutput) => void): void; - public getRun( + + /** + * @see {@link GetRunCommand} + */ + getRun(args: GetRunCommandInput, options?: __HttpHandlerOptions): Promise; + getRun(args: GetRunCommandInput, cb: (err: any, data?: GetRunCommandOutput) => void): void; + getRun( args: GetRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRunCommandOutput) => void ): void; - public getRun( - args: GetRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRunCommandOutput) => void), - cb?: (err: any, data?: GetRunCommandOutput) => void - ): Promise | void { - const command = new GetRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a workflow run group.

- */ - public getRunGroup(args: GetRunGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public getRunGroup(args: GetRunGroupCommandInput, cb: (err: any, data?: GetRunGroupCommandOutput) => void): void; - public getRunGroup( + + /** + * @see {@link GetRunGroupCommand} + */ + getRunGroup(args: GetRunGroupCommandInput, options?: __HttpHandlerOptions): Promise; + getRunGroup(args: GetRunGroupCommandInput, cb: (err: any, data?: GetRunGroupCommandOutput) => void): void; + getRunGroup( args: GetRunGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRunGroupCommandOutput) => void ): void; - public getRunGroup( - args: GetRunGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRunGroupCommandOutput) => void), - cb?: (err: any, data?: GetRunGroupCommandOutput) => void - ): Promise | void { - const command = new GetRunGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a workflow run task.

- */ - public getRunTask(args: GetRunTaskCommandInput, options?: __HttpHandlerOptions): Promise; - public getRunTask(args: GetRunTaskCommandInput, cb: (err: any, data?: GetRunTaskCommandOutput) => void): void; - public getRunTask( + + /** + * @see {@link GetRunTaskCommand} + */ + getRunTask(args: GetRunTaskCommandInput, options?: __HttpHandlerOptions): Promise; + getRunTask(args: GetRunTaskCommandInput, cb: (err: any, data?: GetRunTaskCommandOutput) => void): void; + getRunTask( args: GetRunTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRunTaskCommandOutput) => void ): void; - public getRunTask( - args: GetRunTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRunTaskCommandOutput) => void), - cb?: (err: any, data?: GetRunTaskCommandOutput) => void - ): Promise | void { - const command = new GetRunTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a sequence store.

- */ - public getSequenceStore( + + /** + * @see {@link GetSequenceStoreCommand} + */ + getSequenceStore( args: GetSequenceStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSequenceStore( + getSequenceStore( args: GetSequenceStoreCommandInput, cb: (err: any, data?: GetSequenceStoreCommandOutput) => void ): void; - public getSequenceStore( + getSequenceStore( args: GetSequenceStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSequenceStoreCommandOutput) => void ): void; - public getSequenceStore( - args: GetSequenceStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSequenceStoreCommandOutput) => void), - cb?: (err: any, data?: GetSequenceStoreCommandOutput) => void - ): Promise | void { - const command = new GetSequenceStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a variant import job.

- */ - public getVariantImportJob( + + /** + * @see {@link GetVariantImportJobCommand} + */ + getVariantImportJob( args: GetVariantImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVariantImportJob( + getVariantImportJob( args: GetVariantImportJobCommandInput, cb: (err: any, data?: GetVariantImportJobCommandOutput) => void ): void; - public getVariantImportJob( + getVariantImportJob( args: GetVariantImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVariantImportJobCommandOutput) => void ): void; - public getVariantImportJob( - args: GetVariantImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVariantImportJobCommandOutput) => void), - cb?: (err: any, data?: GetVariantImportJobCommandOutput) => void - ): Promise | void { - const command = new GetVariantImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a variant store.

- */ - public getVariantStore( + + /** + * @see {@link GetVariantStoreCommand} + */ + getVariantStore( args: GetVariantStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVariantStore( - args: GetVariantStoreCommandInput, - cb: (err: any, data?: GetVariantStoreCommandOutput) => void - ): void; - public getVariantStore( + getVariantStore(args: GetVariantStoreCommandInput, cb: (err: any, data?: GetVariantStoreCommandOutput) => void): void; + getVariantStore( args: GetVariantStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVariantStoreCommandOutput) => void ): void; - public getVariantStore( - args: GetVariantStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVariantStoreCommandOutput) => void), - cb?: (err: any, data?: GetVariantStoreCommandOutput) => void - ): Promise | void { - const command = new GetVariantStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a workflow.

- */ - public getWorkflow(args: GetWorkflowCommandInput, options?: __HttpHandlerOptions): Promise; - public getWorkflow(args: GetWorkflowCommandInput, cb: (err: any, data?: GetWorkflowCommandOutput) => void): void; - public getWorkflow( + + /** + * @see {@link GetWorkflowCommand} + */ + getWorkflow(args: GetWorkflowCommandInput, options?: __HttpHandlerOptions): Promise; + getWorkflow(args: GetWorkflowCommandInput, cb: (err: any, data?: GetWorkflowCommandOutput) => void): void; + getWorkflow( args: GetWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkflowCommandOutput) => void ): void; - public getWorkflow( - args: GetWorkflowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkflowCommandOutput) => void), - cb?: (err: any, data?: GetWorkflowCommandOutput) => void - ): Promise | void { - const command = new GetWorkflowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of annotation import jobs.

- */ - public listAnnotationImportJobs( + + /** + * @see {@link ListAnnotationImportJobsCommand} + */ + listAnnotationImportJobs( args: ListAnnotationImportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAnnotationImportJobs( + listAnnotationImportJobs( args: ListAnnotationImportJobsCommandInput, cb: (err: any, data?: ListAnnotationImportJobsCommandOutput) => void ): void; - public listAnnotationImportJobs( + listAnnotationImportJobs( args: ListAnnotationImportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAnnotationImportJobsCommandOutput) => void ): void; - public listAnnotationImportJobs( - args: ListAnnotationImportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAnnotationImportJobsCommandOutput) => void), - cb?: (err: any, data?: ListAnnotationImportJobsCommandOutput) => void - ): Promise | void { - const command = new ListAnnotationImportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of annotation stores.

- */ - public listAnnotationStores( + + /** + * @see {@link ListAnnotationStoresCommand} + */ + listAnnotationStores( args: ListAnnotationStoresCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAnnotationStores( + listAnnotationStores( args: ListAnnotationStoresCommandInput, cb: (err: any, data?: ListAnnotationStoresCommandOutput) => void ): void; - public listAnnotationStores( + listAnnotationStores( args: ListAnnotationStoresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAnnotationStoresCommandOutput) => void ): void; - public listAnnotationStores( - args: ListAnnotationStoresCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAnnotationStoresCommandOutput) => void), - cb?: (err: any, data?: ListAnnotationStoresCommandOutput) => void - ): Promise | void { - const command = new ListAnnotationStoresCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of read set activation jobs.

- */ - public listReadSetActivationJobs( + + /** + * @see {@link ListReadSetActivationJobsCommand} + */ + listReadSetActivationJobs( args: ListReadSetActivationJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReadSetActivationJobs( + listReadSetActivationJobs( args: ListReadSetActivationJobsCommandInput, cb: (err: any, data?: ListReadSetActivationJobsCommandOutput) => void ): void; - public listReadSetActivationJobs( + listReadSetActivationJobs( args: ListReadSetActivationJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReadSetActivationJobsCommandOutput) => void ): void; - public listReadSetActivationJobs( - args: ListReadSetActivationJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReadSetActivationJobsCommandOutput) => void), - cb?: (err: any, data?: ListReadSetActivationJobsCommandOutput) => void - ): Promise | void { - const command = new ListReadSetActivationJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of read set export jobs.

- */ - public listReadSetExportJobs( + + /** + * @see {@link ListReadSetExportJobsCommand} + */ + listReadSetExportJobs( args: ListReadSetExportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReadSetExportJobs( + listReadSetExportJobs( args: ListReadSetExportJobsCommandInput, cb: (err: any, data?: ListReadSetExportJobsCommandOutput) => void ): void; - public listReadSetExportJobs( + listReadSetExportJobs( args: ListReadSetExportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReadSetExportJobsCommandOutput) => void ): void; - public listReadSetExportJobs( - args: ListReadSetExportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReadSetExportJobsCommandOutput) => void), - cb?: (err: any, data?: ListReadSetExportJobsCommandOutput) => void - ): Promise | void { - const command = new ListReadSetExportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of read set import jobs.

- */ - public listReadSetImportJobs( + + /** + * @see {@link ListReadSetImportJobsCommand} + */ + listReadSetImportJobs( args: ListReadSetImportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReadSetImportJobs( + listReadSetImportJobs( args: ListReadSetImportJobsCommandInput, cb: (err: any, data?: ListReadSetImportJobsCommandOutput) => void ): void; - public listReadSetImportJobs( + listReadSetImportJobs( args: ListReadSetImportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReadSetImportJobsCommandOutput) => void ): void; - public listReadSetImportJobs( - args: ListReadSetImportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReadSetImportJobsCommandOutput) => void), - cb?: (err: any, data?: ListReadSetImportJobsCommandOutput) => void - ): Promise | void { - const command = new ListReadSetImportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of read sets.

- */ - public listReadSets( - args: ListReadSetsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listReadSets(args: ListReadSetsCommandInput, cb: (err: any, data?: ListReadSetsCommandOutput) => void): void; - public listReadSets( + + /** + * @see {@link ListReadSetsCommand} + */ + listReadSets(args: ListReadSetsCommandInput, options?: __HttpHandlerOptions): Promise; + listReadSets(args: ListReadSetsCommandInput, cb: (err: any, data?: ListReadSetsCommandOutput) => void): void; + listReadSets( args: ListReadSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReadSetsCommandOutput) => void ): void; - public listReadSets( - args: ListReadSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReadSetsCommandOutput) => void), - cb?: (err: any, data?: ListReadSetsCommandOutput) => void - ): Promise | void { - const command = new ListReadSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of reference import jobs.

- */ - public listReferenceImportJobs( + + /** + * @see {@link ListReferenceImportJobsCommand} + */ + listReferenceImportJobs( args: ListReferenceImportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReferenceImportJobs( + listReferenceImportJobs( args: ListReferenceImportJobsCommandInput, cb: (err: any, data?: ListReferenceImportJobsCommandOutput) => void ): void; - public listReferenceImportJobs( + listReferenceImportJobs( args: ListReferenceImportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReferenceImportJobsCommandOutput) => void ): void; - public listReferenceImportJobs( - args: ListReferenceImportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReferenceImportJobsCommandOutput) => void), - cb?: (err: any, data?: ListReferenceImportJobsCommandOutput) => void - ): Promise | void { - const command = new ListReferenceImportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of references.

- */ - public listReferences( + + /** + * @see {@link ListReferencesCommand} + */ + listReferences( args: ListReferencesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReferences( - args: ListReferencesCommandInput, - cb: (err: any, data?: ListReferencesCommandOutput) => void - ): void; - public listReferences( + listReferences(args: ListReferencesCommandInput, cb: (err: any, data?: ListReferencesCommandOutput) => void): void; + listReferences( args: ListReferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReferencesCommandOutput) => void ): void; - public listReferences( - args: ListReferencesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReferencesCommandOutput) => void), - cb?: (err: any, data?: ListReferencesCommandOutput) => void - ): Promise | void { - const command = new ListReferencesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of reference stores.

- */ - public listReferenceStores( + + /** + * @see {@link ListReferenceStoresCommand} + */ + listReferenceStores( args: ListReferenceStoresCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReferenceStores( + listReferenceStores( args: ListReferenceStoresCommandInput, cb: (err: any, data?: ListReferenceStoresCommandOutput) => void ): void; - public listReferenceStores( + listReferenceStores( args: ListReferenceStoresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReferenceStoresCommandOutput) => void ): void; - public listReferenceStores( - args: ListReferenceStoresCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReferenceStoresCommandOutput) => void), - cb?: (err: any, data?: ListReferenceStoresCommandOutput) => void - ): Promise | void { - const command = new ListReferenceStoresCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of run groups.

- */ - public listRunGroups( - args: ListRunGroupsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listRunGroups( - args: ListRunGroupsCommandInput, - cb: (err: any, data?: ListRunGroupsCommandOutput) => void - ): void; - public listRunGroups( + + /** + * @see {@link ListRunGroupsCommand} + */ + listRunGroups(args: ListRunGroupsCommandInput, options?: __HttpHandlerOptions): Promise; + listRunGroups(args: ListRunGroupsCommandInput, cb: (err: any, data?: ListRunGroupsCommandOutput) => void): void; + listRunGroups( args: ListRunGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRunGroupsCommandOutput) => void ): void; - public listRunGroups( - args: ListRunGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRunGroupsCommandOutput) => void), - cb?: (err: any, data?: ListRunGroupsCommandOutput) => void - ): Promise | void { - const command = new ListRunGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of runs.

- */ - public listRuns(args: ListRunsCommandInput, options?: __HttpHandlerOptions): Promise; - public listRuns(args: ListRunsCommandInput, cb: (err: any, data?: ListRunsCommandOutput) => void): void; - public listRuns( + + /** + * @see {@link ListRunsCommand} + */ + listRuns(args: ListRunsCommandInput, options?: __HttpHandlerOptions): Promise; + listRuns(args: ListRunsCommandInput, cb: (err: any, data?: ListRunsCommandOutput) => void): void; + listRuns( args: ListRunsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRunsCommandOutput) => void ): void; - public listRuns( - args: ListRunsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRunsCommandOutput) => void), - cb?: (err: any, data?: ListRunsCommandOutput) => void - ): Promise | void { - const command = new ListRunsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of tasks for a run.

- */ - public listRunTasks( - args: ListRunTasksCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listRunTasks(args: ListRunTasksCommandInput, cb: (err: any, data?: ListRunTasksCommandOutput) => void): void; - public listRunTasks( + + /** + * @see {@link ListRunTasksCommand} + */ + listRunTasks(args: ListRunTasksCommandInput, options?: __HttpHandlerOptions): Promise; + listRunTasks(args: ListRunTasksCommandInput, cb: (err: any, data?: ListRunTasksCommandOutput) => void): void; + listRunTasks( args: ListRunTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRunTasksCommandOutput) => void ): void; - public listRunTasks( - args: ListRunTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRunTasksCommandOutput) => void), - cb?: (err: any, data?: ListRunTasksCommandOutput) => void - ): Promise | void { - const command = new ListRunTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of sequence stores.

- */ - public listSequenceStores( + + /** + * @see {@link ListSequenceStoresCommand} + */ + listSequenceStores( args: ListSequenceStoresCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSequenceStores( + listSequenceStores( args: ListSequenceStoresCommandInput, cb: (err: any, data?: ListSequenceStoresCommandOutput) => void ): void; - public listSequenceStores( + listSequenceStores( args: ListSequenceStoresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSequenceStoresCommandOutput) => void ): void; - public listSequenceStores( - args: ListSequenceStoresCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSequenceStoresCommandOutput) => void), - cb?: (err: any, data?: ListSequenceStoresCommandOutput) => void - ): Promise | void { - const command = new ListSequenceStoresCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of tags for a resource.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of variant import jobs.

- */ - public listVariantImportJobs( + + /** + * @see {@link ListVariantImportJobsCommand} + */ + listVariantImportJobs( args: ListVariantImportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVariantImportJobs( + listVariantImportJobs( args: ListVariantImportJobsCommandInput, cb: (err: any, data?: ListVariantImportJobsCommandOutput) => void ): void; - public listVariantImportJobs( + listVariantImportJobs( args: ListVariantImportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVariantImportJobsCommandOutput) => void ): void; - public listVariantImportJobs( - args: ListVariantImportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVariantImportJobsCommandOutput) => void), - cb?: (err: any, data?: ListVariantImportJobsCommandOutput) => void - ): Promise | void { - const command = new ListVariantImportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of variant stores.

- */ - public listVariantStores( + + /** + * @see {@link ListVariantStoresCommand} + */ + listVariantStores( args: ListVariantStoresCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVariantStores( + listVariantStores( args: ListVariantStoresCommandInput, cb: (err: any, data?: ListVariantStoresCommandOutput) => void ): void; - public listVariantStores( + listVariantStores( args: ListVariantStoresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVariantStoresCommandOutput) => void ): void; - public listVariantStores( - args: ListVariantStoresCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVariantStoresCommandOutput) => void), - cb?: (err: any, data?: ListVariantStoresCommandOutput) => void - ): Promise | void { - const command = new ListVariantStoresCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of workflows.

- */ - public listWorkflows( - args: ListWorkflowsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listWorkflows( - args: ListWorkflowsCommandInput, - cb: (err: any, data?: ListWorkflowsCommandOutput) => void - ): void; - public listWorkflows( + + /** + * @see {@link ListWorkflowsCommand} + */ + listWorkflows(args: ListWorkflowsCommandInput, options?: __HttpHandlerOptions): Promise; + listWorkflows(args: ListWorkflowsCommandInput, cb: (err: any, data?: ListWorkflowsCommandOutput) => void): void; + listWorkflows( args: ListWorkflowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkflowsCommandOutput) => void ): void; - public listWorkflows( - args: ListWorkflowsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkflowsCommandOutput) => void), - cb?: (err: any, data?: ListWorkflowsCommandOutput) => void - ): Promise | void { - const command = new ListWorkflowsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts an annotation import job.

- */ - public startAnnotationImportJob( + + /** + * @see {@link StartAnnotationImportJobCommand} + */ + startAnnotationImportJob( args: StartAnnotationImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startAnnotationImportJob( + startAnnotationImportJob( args: StartAnnotationImportJobCommandInput, cb: (err: any, data?: StartAnnotationImportJobCommandOutput) => void ): void; - public startAnnotationImportJob( + startAnnotationImportJob( args: StartAnnotationImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartAnnotationImportJobCommandOutput) => void ): void; - public startAnnotationImportJob( - args: StartAnnotationImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartAnnotationImportJobCommandOutput) => void), - cb?: (err: any, data?: StartAnnotationImportJobCommandOutput) => void - ): Promise | void { - const command = new StartAnnotationImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Activates an archived read set. To reduce storage charges, Amazon Omics archives unused read - * sets after 30 days.

- */ - public startReadSetActivationJob( + + /** + * @see {@link StartReadSetActivationJobCommand} + */ + startReadSetActivationJob( args: StartReadSetActivationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startReadSetActivationJob( + startReadSetActivationJob( args: StartReadSetActivationJobCommandInput, cb: (err: any, data?: StartReadSetActivationJobCommandOutput) => void ): void; - public startReadSetActivationJob( + startReadSetActivationJob( args: StartReadSetActivationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartReadSetActivationJobCommandOutput) => void ): void; - public startReadSetActivationJob( - args: StartReadSetActivationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartReadSetActivationJobCommandOutput) => void), - cb?: (err: any, data?: StartReadSetActivationJobCommandOutput) => void - ): Promise | void { - const command = new StartReadSetActivationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Exports a read set to Amazon S3.

- */ - public startReadSetExportJob( + + /** + * @see {@link StartReadSetExportJobCommand} + */ + startReadSetExportJob( args: StartReadSetExportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startReadSetExportJob( + startReadSetExportJob( args: StartReadSetExportJobCommandInput, cb: (err: any, data?: StartReadSetExportJobCommandOutput) => void ): void; - public startReadSetExportJob( + startReadSetExportJob( args: StartReadSetExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartReadSetExportJobCommandOutput) => void ): void; - public startReadSetExportJob( - args: StartReadSetExportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartReadSetExportJobCommandOutput) => void), - cb?: (err: any, data?: StartReadSetExportJobCommandOutput) => void - ): Promise | void { - const command = new StartReadSetExportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a read set import job.

- */ - public startReadSetImportJob( + + /** + * @see {@link StartReadSetImportJobCommand} + */ + startReadSetImportJob( args: StartReadSetImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startReadSetImportJob( + startReadSetImportJob( args: StartReadSetImportJobCommandInput, cb: (err: any, data?: StartReadSetImportJobCommandOutput) => void ): void; - public startReadSetImportJob( + startReadSetImportJob( args: StartReadSetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartReadSetImportJobCommandOutput) => void ): void; - public startReadSetImportJob( - args: StartReadSetImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartReadSetImportJobCommandOutput) => void), - cb?: (err: any, data?: StartReadSetImportJobCommandOutput) => void - ): Promise | void { - const command = new StartReadSetImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a reference import job.

- */ - public startReferenceImportJob( + + /** + * @see {@link StartReferenceImportJobCommand} + */ + startReferenceImportJob( args: StartReferenceImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startReferenceImportJob( + startReferenceImportJob( args: StartReferenceImportJobCommandInput, cb: (err: any, data?: StartReferenceImportJobCommandOutput) => void ): void; - public startReferenceImportJob( + startReferenceImportJob( args: StartReferenceImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartReferenceImportJobCommandOutput) => void ): void; - public startReferenceImportJob( - args: StartReferenceImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartReferenceImportJobCommandOutput) => void), - cb?: (err: any, data?: StartReferenceImportJobCommandOutput) => void - ): Promise | void { - const command = new StartReferenceImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a run.

- */ - public startRun(args: StartRunCommandInput, options?: __HttpHandlerOptions): Promise; - public startRun(args: StartRunCommandInput, cb: (err: any, data?: StartRunCommandOutput) => void): void; - public startRun( + + /** + * @see {@link StartRunCommand} + */ + startRun(args: StartRunCommandInput, options?: __HttpHandlerOptions): Promise; + startRun(args: StartRunCommandInput, cb: (err: any, data?: StartRunCommandOutput) => void): void; + startRun( args: StartRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartRunCommandOutput) => void ): void; - public startRun( - args: StartRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartRunCommandOutput) => void), - cb?: (err: any, data?: StartRunCommandOutput) => void - ): Promise | void { - const command = new StartRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a variant import job.

- */ - public startVariantImportJob( + + /** + * @see {@link StartVariantImportJobCommand} + */ + startVariantImportJob( args: StartVariantImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startVariantImportJob( + startVariantImportJob( args: StartVariantImportJobCommandInput, cb: (err: any, data?: StartVariantImportJobCommandOutput) => void ): void; - public startVariantImportJob( + startVariantImportJob( args: StartVariantImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartVariantImportJobCommandOutput) => void ): void; - public startVariantImportJob( - args: StartVariantImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartVariantImportJobCommandOutput) => void), - cb?: (err: any, data?: StartVariantImportJobCommandOutput) => void - ): Promise | void { - const command = new StartVariantImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Tags a resource.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes tags from a resource.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an annotation store.

- */ - public updateAnnotationStore( + + /** + * @see {@link UpdateAnnotationStoreCommand} + */ + updateAnnotationStore( args: UpdateAnnotationStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAnnotationStore( + updateAnnotationStore( args: UpdateAnnotationStoreCommandInput, cb: (err: any, data?: UpdateAnnotationStoreCommandOutput) => void ): void; - public updateAnnotationStore( + updateAnnotationStore( args: UpdateAnnotationStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAnnotationStoreCommandOutput) => void ): void; - public updateAnnotationStore( - args: UpdateAnnotationStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAnnotationStoreCommandOutput) => void), - cb?: (err: any, data?: UpdateAnnotationStoreCommandOutput) => void - ): Promise | void { - const command = new UpdateAnnotationStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a run group.

- */ - public updateRunGroup( + + /** + * @see {@link UpdateRunGroupCommand} + */ + updateRunGroup( args: UpdateRunGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRunGroup( - args: UpdateRunGroupCommandInput, - cb: (err: any, data?: UpdateRunGroupCommandOutput) => void - ): void; - public updateRunGroup( + updateRunGroup(args: UpdateRunGroupCommandInput, cb: (err: any, data?: UpdateRunGroupCommandOutput) => void): void; + updateRunGroup( args: UpdateRunGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRunGroupCommandOutput) => void ): void; - public updateRunGroup( - args: UpdateRunGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRunGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateRunGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateRunGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a variant store.

- */ - public updateVariantStore( + + /** + * @see {@link UpdateVariantStoreCommand} + */ + updateVariantStore( args: UpdateVariantStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVariantStore( + updateVariantStore( args: UpdateVariantStoreCommandInput, cb: (err: any, data?: UpdateVariantStoreCommandOutput) => void ): void; - public updateVariantStore( + updateVariantStore( args: UpdateVariantStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVariantStoreCommandOutput) => void ): void; - public updateVariantStore( - args: UpdateVariantStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVariantStoreCommandOutput) => void), - cb?: (err: any, data?: UpdateVariantStoreCommandOutput) => void - ): Promise | void { - const command = new UpdateVariantStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a workflow.

- */ - public updateWorkflow( + + /** + * @see {@link UpdateWorkflowCommand} + */ + updateWorkflow( args: UpdateWorkflowCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWorkflow( - args: UpdateWorkflowCommandInput, - cb: (err: any, data?: UpdateWorkflowCommandOutput) => void - ): void; - public updateWorkflow( + updateWorkflow(args: UpdateWorkflowCommandInput, cb: (err: any, data?: UpdateWorkflowCommandOutput) => void): void; + updateWorkflow( args: UpdateWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkflowCommandOutput) => void ): void; - public updateWorkflow( - args: UpdateWorkflowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWorkflowCommandOutput) => void), - cb?: (err: any, data?: UpdateWorkflowCommandOutput) => void - ): Promise | void { - const command = new UpdateWorkflowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

This is the Amazon Omics API Reference. For an introduction to the service, see What is Amazon Omics? in the + * Amazon Omics Developer Guide.

+ */ +export class Omics extends OmicsClient implements Omics {} +createAggregatedClient(commands, Omics); diff --git a/clients/client-opensearch/src/OpenSearch.ts b/clients/client-opensearch/src/OpenSearch.ts index 90006e05e50e..7507c34e3428 100644 --- a/clients/client-opensearch/src/OpenSearch.ts +++ b/clients/client-opensearch/src/OpenSearch.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -249,1772 +250,892 @@ import { UpgradeDomainCommandInput, UpgradeDomainCommandOutput, } from "./commands/UpgradeDomainCommand"; -import { OpenSearchClient } from "./OpenSearchClient"; +import { OpenSearchClient, OpenSearchClientConfig } from "./OpenSearchClient"; -/** - * @public - *

Use the Amazon OpenSearch Service configuration API to create, configure, and manage - * OpenSearch Service domains.

- *

For sample code that uses the configuration API, see the - * Amazon OpenSearch Service Developer Guide - * . The guide also - * contains sample code for - * sending signed HTTP requests to the OpenSearch APIs. The endpoint for configuration service - * requests is Region specific: es.region.amazonaws.com. For example, - * es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see Amazon Web Services - * service endpoints.

- */ -export class OpenSearch extends OpenSearchClient { +const commands = { + AcceptInboundConnectionCommand, + AddTagsCommand, + AssociatePackageCommand, + AuthorizeVpcEndpointAccessCommand, + CancelServiceSoftwareUpdateCommand, + CreateDomainCommand, + CreateOutboundConnectionCommand, + CreatePackageCommand, + CreateVpcEndpointCommand, + DeleteDomainCommand, + DeleteInboundConnectionCommand, + DeleteOutboundConnectionCommand, + DeletePackageCommand, + DeleteVpcEndpointCommand, + DescribeDomainCommand, + DescribeDomainAutoTunesCommand, + DescribeDomainChangeProgressCommand, + DescribeDomainConfigCommand, + DescribeDomainsCommand, + DescribeDryRunProgressCommand, + DescribeInboundConnectionsCommand, + DescribeInstanceTypeLimitsCommand, + DescribeOutboundConnectionsCommand, + DescribePackagesCommand, + DescribeReservedInstanceOfferingsCommand, + DescribeReservedInstancesCommand, + DescribeVpcEndpointsCommand, + DissociatePackageCommand, + GetCompatibleVersionsCommand, + GetPackageVersionHistoryCommand, + GetUpgradeHistoryCommand, + GetUpgradeStatusCommand, + ListDomainNamesCommand, + ListDomainsForPackageCommand, + ListInstanceTypeDetailsCommand, + ListPackagesForDomainCommand, + ListScheduledActionsCommand, + ListTagsCommand, + ListVersionsCommand, + ListVpcEndpointAccessCommand, + ListVpcEndpointsCommand, + ListVpcEndpointsForDomainCommand, + PurchaseReservedInstanceOfferingCommand, + RejectInboundConnectionCommand, + RemoveTagsCommand, + RevokeVpcEndpointAccessCommand, + StartServiceSoftwareUpdateCommand, + UpdateDomainConfigCommand, + UpdatePackageCommand, + UpdateScheduledActionCommand, + UpdateVpcEndpointCommand, + UpgradeDomainCommand, +}; + +export interface OpenSearch { /** - * @public - *

Allows the destination Amazon OpenSearch Service domain owner to accept an inbound - * cross-cluster search connection request. For more information, see Cross-cluster search - * for Amazon OpenSearch Service.

+ * @see {@link AcceptInboundConnectionCommand} */ - public acceptInboundConnection( + acceptInboundConnection( args: AcceptInboundConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptInboundConnection( + acceptInboundConnection( args: AcceptInboundConnectionCommandInput, cb: (err: any, data?: AcceptInboundConnectionCommandOutput) => void ): void; - public acceptInboundConnection( + acceptInboundConnection( args: AcceptInboundConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptInboundConnectionCommandOutput) => void ): void; - public acceptInboundConnection( - args: AcceptInboundConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptInboundConnectionCommandOutput) => void), - cb?: (err: any, data?: AcceptInboundConnectionCommandOutput) => void - ): Promise | void { - const command = new AcceptInboundConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of - * case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see - * Tagging Amazon OpenSearch Service domains.

+ * @see {@link AddTagsCommand} */ - public addTags(args: AddTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public addTags(args: AddTagsCommandInput, cb: (err: any, data?: AddTagsCommandOutput) => void): void; - public addTags( + addTags(args: AddTagsCommandInput, options?: __HttpHandlerOptions): Promise; + addTags(args: AddTagsCommandInput, cb: (err: any, data?: AddTagsCommandOutput) => void): void; + addTags( args: AddTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsCommandOutput) => void ): void; - public addTags( - args: AddTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddTagsCommandOutput) => void), - cb?: (err: any, data?: AddTagsCommandOutput) => void - ): Promise | void { - const command = new AddTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a package with an Amazon OpenSearch Service domain. For more information, see - * Custom packages - * for Amazon OpenSearch Service.

+ * @see {@link AssociatePackageCommand} */ - public associatePackage( + associatePackage( args: AssociatePackageCommandInput, options?: __HttpHandlerOptions ): Promise; - public associatePackage( + associatePackage( args: AssociatePackageCommandInput, cb: (err: any, data?: AssociatePackageCommandOutput) => void ): void; - public associatePackage( + associatePackage( args: AssociatePackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociatePackageCommandOutput) => void ): void; - public associatePackage( - args: AssociatePackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociatePackageCommandOutput) => void), - cb?: (err: any, data?: AssociatePackageCommandOutput) => void - ): Promise | void { - const command = new AssociatePackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC - * endpoint.

+ * @see {@link AuthorizeVpcEndpointAccessCommand} */ - public authorizeVpcEndpointAccess( + authorizeVpcEndpointAccess( args: AuthorizeVpcEndpointAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public authorizeVpcEndpointAccess( + authorizeVpcEndpointAccess( args: AuthorizeVpcEndpointAccessCommandInput, cb: (err: any, data?: AuthorizeVpcEndpointAccessCommandOutput) => void ): void; - public authorizeVpcEndpointAccess( + authorizeVpcEndpointAccess( args: AuthorizeVpcEndpointAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AuthorizeVpcEndpointAccessCommandOutput) => void ): void; - public authorizeVpcEndpointAccess( - args: AuthorizeVpcEndpointAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AuthorizeVpcEndpointAccessCommandOutput) => void), - cb?: (err: any, data?: AuthorizeVpcEndpointAccessCommandOutput) => void - ): Promise | void { - const command = new AuthorizeVpcEndpointAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can - * only perform this operation before the AutomatedUpdateDate and when the domain's - * UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.

+ * @see {@link CancelServiceSoftwareUpdateCommand} */ - public cancelServiceSoftwareUpdate( + cancelServiceSoftwareUpdate( args: CancelServiceSoftwareUpdateCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelServiceSoftwareUpdate( + cancelServiceSoftwareUpdate( args: CancelServiceSoftwareUpdateCommandInput, cb: (err: any, data?: CancelServiceSoftwareUpdateCommandOutput) => void ): void; - public cancelServiceSoftwareUpdate( + cancelServiceSoftwareUpdate( args: CancelServiceSoftwareUpdateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelServiceSoftwareUpdateCommandOutput) => void ): void; - public cancelServiceSoftwareUpdate( - args: CancelServiceSoftwareUpdateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelServiceSoftwareUpdateCommandOutput) => void), - cb?: (err: any, data?: CancelServiceSoftwareUpdateCommandOutput) => void - ): Promise | void { - const command = new CancelServiceSoftwareUpdateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

+ * @see {@link CreateDomainCommand} */ - public createDomain( - args: CreateDomainCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createDomain(args: CreateDomainCommandInput, cb: (err: any, data?: CreateDomainCommandOutput) => void): void; - public createDomain( + createDomain(args: CreateDomainCommandInput, options?: __HttpHandlerOptions): Promise; + createDomain(args: CreateDomainCommandInput, cb: (err: any, data?: CreateDomainCommandOutput) => void): void; + createDomain( args: CreateDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDomainCommandOutput) => void ): void; - public createDomain( - args: CreateDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDomainCommandOutput) => void), - cb?: (err: any, data?: CreateDomainCommandOutput) => void - ): Promise | void { - const command = new CreateDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain - * to a destination domain. For more information, see Cross-cluster search - * for Amazon OpenSearch Service.

+ * @see {@link CreateOutboundConnectionCommand} */ - public createOutboundConnection( + createOutboundConnection( args: CreateOutboundConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createOutboundConnection( + createOutboundConnection( args: CreateOutboundConnectionCommandInput, cb: (err: any, data?: CreateOutboundConnectionCommandOutput) => void ): void; - public createOutboundConnection( + createOutboundConnection( args: CreateOutboundConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateOutboundConnectionCommandOutput) => void ): void; - public createOutboundConnection( - args: CreateOutboundConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateOutboundConnectionCommandOutput) => void), - cb?: (err: any, data?: CreateOutboundConnectionCommandOutput) => void - ): Promise | void { - const command = new CreateOutboundConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a package for use with Amazon OpenSearch Service domains. For more information, see - * Custom packages for Amazon OpenSearch Service.

+ * @see {@link CreatePackageCommand} */ - public createPackage( - args: CreatePackageCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createPackage( - args: CreatePackageCommandInput, - cb: (err: any, data?: CreatePackageCommandOutput) => void - ): void; - public createPackage( + createPackage(args: CreatePackageCommandInput, options?: __HttpHandlerOptions): Promise; + createPackage(args: CreatePackageCommandInput, cb: (err: any, data?: CreatePackageCommandOutput) => void): void; + createPackage( args: CreatePackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePackageCommandOutput) => void ): void; - public createPackage( - args: CreatePackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePackageCommandOutput) => void), - cb?: (err: any, data?: CreatePackageCommandOutput) => void - ): Promise | void { - const command = new CreatePackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Amazon OpenSearch Service-managed VPC endpoint.

+ * @see {@link CreateVpcEndpointCommand} */ - public createVpcEndpoint( + createVpcEndpoint( args: CreateVpcEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVpcEndpoint( + createVpcEndpoint( args: CreateVpcEndpointCommandInput, cb: (err: any, data?: CreateVpcEndpointCommandOutput) => void ): void; - public createVpcEndpoint( + createVpcEndpoint( args: CreateVpcEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVpcEndpointCommandOutput) => void ): void; - public createVpcEndpoint( - args: CreateVpcEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVpcEndpointCommandOutput) => void), - cb?: (err: any, data?: CreateVpcEndpointCommandOutput) => void - ): Promise | void { - const command = new CreateVpcEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain - * after you delete it.

+ * @see {@link DeleteDomainCommand} */ - public deleteDomain( - args: DeleteDomainCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDomain(args: DeleteDomainCommandInput, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void; - public deleteDomain( + deleteDomain(args: DeleteDomainCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDomain(args: DeleteDomainCommandInput, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void; + deleteDomain( args: DeleteDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDomainCommandOutput) => void ): void; - public deleteDomain( - args: DeleteDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDomainCommandOutput) => void), - cb?: (err: any, data?: DeleteDomainCommandOutput) => void - ): Promise | void { - const command = new DeleteDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound - * cross-cluster search connection. For more information, see Cross-cluster search - * for Amazon OpenSearch Service.

+ * @see {@link DeleteInboundConnectionCommand} */ - public deleteInboundConnection( + deleteInboundConnection( args: DeleteInboundConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInboundConnection( + deleteInboundConnection( args: DeleteInboundConnectionCommandInput, cb: (err: any, data?: DeleteInboundConnectionCommandOutput) => void ): void; - public deleteInboundConnection( + deleteInboundConnection( args: DeleteInboundConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInboundConnectionCommandOutput) => void ): void; - public deleteInboundConnection( - args: DeleteInboundConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInboundConnectionCommandOutput) => void), - cb?: (err: any, data?: DeleteInboundConnectionCommandOutput) => void - ): Promise | void { - const command = new DeleteInboundConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound - * cross-cluster search connection. For more information, see Cross-cluster search - * for Amazon OpenSearch Service.

+ * @see {@link DeleteOutboundConnectionCommand} */ - public deleteOutboundConnection( + deleteOutboundConnection( args: DeleteOutboundConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteOutboundConnection( + deleteOutboundConnection( args: DeleteOutboundConnectionCommandInput, cb: (err: any, data?: DeleteOutboundConnectionCommandOutput) => void ): void; - public deleteOutboundConnection( + deleteOutboundConnection( args: DeleteOutboundConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOutboundConnectionCommandOutput) => void ): void; - public deleteOutboundConnection( - args: DeleteOutboundConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteOutboundConnectionCommandOutput) => void), - cb?: (err: any, data?: DeleteOutboundConnectionCommandOutput) => void - ): Promise | void { - const command = new DeleteOutboundConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon OpenSearch Service package. For more information, see Custom - * packages for Amazon OpenSearch Service.

+ * @see {@link DeletePackageCommand} */ - public deletePackage( - args: DeletePackageCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deletePackage( - args: DeletePackageCommandInput, - cb: (err: any, data?: DeletePackageCommandOutput) => void - ): void; - public deletePackage( + deletePackage(args: DeletePackageCommandInput, options?: __HttpHandlerOptions): Promise; + deletePackage(args: DeletePackageCommandInput, cb: (err: any, data?: DeletePackageCommandOutput) => void): void; + deletePackage( args: DeletePackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePackageCommandOutput) => void ): void; - public deletePackage( - args: DeletePackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePackageCommandOutput) => void), - cb?: (err: any, data?: DeletePackageCommandOutput) => void - ): Promise | void { - const command = new DeletePackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

+ * @see {@link DeleteVpcEndpointCommand} */ - public deleteVpcEndpoint( + deleteVpcEndpoint( args: DeleteVpcEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVpcEndpoint( + deleteVpcEndpoint( args: DeleteVpcEndpointCommandInput, cb: (err: any, data?: DeleteVpcEndpointCommandOutput) => void ): void; - public deleteVpcEndpoint( + deleteVpcEndpoint( args: DeleteVpcEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVpcEndpointCommandOutput) => void ): void; - public deleteVpcEndpoint( - args: DeleteVpcEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVpcEndpointCommandOutput) => void), - cb?: (err: any, data?: DeleteVpcEndpointCommandOutput) => void - ): Promise | void { - const command = new DeleteVpcEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the domain configuration for the specified Amazon OpenSearch Service domain, - * including the domain ID, domain service endpoint, and domain ARN.

+ * @see {@link DescribeDomainCommand} */ - public describeDomain( + describeDomain( args: DescribeDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDomain( - args: DescribeDomainCommandInput, - cb: (err: any, data?: DescribeDomainCommandOutput) => void - ): void; - public describeDomain( + describeDomain(args: DescribeDomainCommandInput, cb: (err: any, data?: DescribeDomainCommandOutput) => void): void; + describeDomain( args: DescribeDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDomainCommandOutput) => void ): void; - public describeDomain( - args: DescribeDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDomainCommandOutput) => void), - cb?: (err: any, data?: DescribeDomainCommandOutput) => void - ): Promise | void { - const command = new DescribeDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service - * domain. For more information, see Auto-Tune for Amazon OpenSearch - * Service.

+ * @see {@link DescribeDomainAutoTunesCommand} */ - public describeDomainAutoTunes( + describeDomainAutoTunes( args: DescribeDomainAutoTunesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDomainAutoTunes( + describeDomainAutoTunes( args: DescribeDomainAutoTunesCommandInput, cb: (err: any, data?: DescribeDomainAutoTunesCommandOutput) => void ): void; - public describeDomainAutoTunes( + describeDomainAutoTunes( args: DescribeDomainAutoTunesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDomainAutoTunesCommandOutput) => void ): void; - public describeDomainAutoTunes( - args: DescribeDomainAutoTunesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDomainAutoTunesCommandOutput) => void), - cb?: (err: any, data?: DescribeDomainAutoTunesCommandOutput) => void - ): Promise | void { - const command = new DescribeDomainAutoTunesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the current blue/green deployment happening on an Amazon - * OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.

+ * @see {@link DescribeDomainChangeProgressCommand} */ - public describeDomainChangeProgress( + describeDomainChangeProgress( args: DescribeDomainChangeProgressCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDomainChangeProgress( + describeDomainChangeProgress( args: DescribeDomainChangeProgressCommandInput, cb: (err: any, data?: DescribeDomainChangeProgressCommandOutput) => void ): void; - public describeDomainChangeProgress( + describeDomainChangeProgress( args: DescribeDomainChangeProgressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDomainChangeProgressCommandOutput) => void ): void; - public describeDomainChangeProgress( - args: DescribeDomainChangeProgressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDomainChangeProgressCommandOutput) => void), - cb?: (err: any, data?: DescribeDomainChangeProgressCommandOutput) => void - ): Promise | void { - const command = new DescribeDomainChangeProgressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the configuration of an Amazon OpenSearch Service domain.

+ * @see {@link DescribeDomainConfigCommand} */ - public describeDomainConfig( + describeDomainConfig( args: DescribeDomainConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDomainConfig( + describeDomainConfig( args: DescribeDomainConfigCommandInput, cb: (err: any, data?: DescribeDomainConfigCommandOutput) => void ): void; - public describeDomainConfig( + describeDomainConfig( args: DescribeDomainConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDomainConfigCommandOutput) => void ): void; - public describeDomainConfig( - args: DescribeDomainConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDomainConfigCommandOutput) => void), - cb?: (err: any, data?: DescribeDomainConfigCommandOutput) => void - ): Promise | void { - const command = new DescribeDomainConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns domain configuration information about the specified Amazon OpenSearch Service - * domains.

+ * @see {@link DescribeDomainsCommand} */ - public describeDomains( + describeDomains( args: DescribeDomainsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDomains( - args: DescribeDomainsCommandInput, - cb: (err: any, data?: DescribeDomainsCommandOutput) => void - ): void; - public describeDomains( + describeDomains(args: DescribeDomainsCommandInput, cb: (err: any, data?: DescribeDomainsCommandOutput) => void): void; + describeDomains( args: DescribeDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDomainsCommandOutput) => void ): void; - public describeDomains( - args: DescribeDomainsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDomainsCommandOutput) => void), - cb?: (err: any, data?: DescribeDomainsCommandOutput) => void - ): Promise | void { - const command = new DescribeDomainsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch - * Service domain. For more information, see Determining whether a change will cause a blue/green deployment.

+ * @see {@link DescribeDryRunProgressCommand} */ - public describeDryRunProgress( + describeDryRunProgress( args: DescribeDryRunProgressCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDryRunProgress( + describeDryRunProgress( args: DescribeDryRunProgressCommandInput, cb: (err: any, data?: DescribeDryRunProgressCommandOutput) => void ): void; - public describeDryRunProgress( + describeDryRunProgress( args: DescribeDryRunProgressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDryRunProgressCommandOutput) => void ): void; - public describeDryRunProgress( - args: DescribeDryRunProgressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDryRunProgressCommandOutput) => void), - cb?: (err: any, data?: DescribeDryRunProgressCommandOutput) => void - ): Promise | void { - const command = new DescribeDryRunProgressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the inbound cross-cluster search connections for a destination (remote) Amazon - * OpenSearch Service domain. For more information, see Cross-cluster search - * for Amazon OpenSearch Service.

+ * @see {@link DescribeInboundConnectionsCommand} */ - public describeInboundConnections( + describeInboundConnections( args: DescribeInboundConnectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInboundConnections( + describeInboundConnections( args: DescribeInboundConnectionsCommandInput, cb: (err: any, data?: DescribeInboundConnectionsCommandOutput) => void ): void; - public describeInboundConnections( + describeInboundConnections( args: DescribeInboundConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInboundConnectionsCommandOutput) => void ): void; - public describeInboundConnections( - args: DescribeInboundConnectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInboundConnectionsCommandOutput) => void), - cb?: (err: any, data?: DescribeInboundConnectionsCommandOutput) => void - ): Promise | void { - const command = new DescribeInboundConnectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the instance count, storage, and master node limits for a given OpenSearch or - * Elasticsearch version and instance type.

+ * @see {@link DescribeInstanceTypeLimitsCommand} */ - public describeInstanceTypeLimits( + describeInstanceTypeLimits( args: DescribeInstanceTypeLimitsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInstanceTypeLimits( + describeInstanceTypeLimits( args: DescribeInstanceTypeLimitsCommandInput, cb: (err: any, data?: DescribeInstanceTypeLimitsCommandOutput) => void ): void; - public describeInstanceTypeLimits( + describeInstanceTypeLimits( args: DescribeInstanceTypeLimitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstanceTypeLimitsCommandOutput) => void ): void; - public describeInstanceTypeLimits( - args: DescribeInstanceTypeLimitsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInstanceTypeLimitsCommandOutput) => void), - cb?: (err: any, data?: DescribeInstanceTypeLimitsCommandOutput) => void - ): Promise | void { - const command = new DescribeInstanceTypeLimitsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch - * Service domain. For more information, see Cross-cluster search - * for Amazon OpenSearch Service.

+ * @see {@link DescribeOutboundConnectionsCommand} */ - public describeOutboundConnections( + describeOutboundConnections( args: DescribeOutboundConnectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOutboundConnections( + describeOutboundConnections( args: DescribeOutboundConnectionsCommandInput, cb: (err: any, data?: DescribeOutboundConnectionsCommandOutput) => void ): void; - public describeOutboundConnections( + describeOutboundConnections( args: DescribeOutboundConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOutboundConnectionsCommandOutput) => void ): void; - public describeOutboundConnections( - args: DescribeOutboundConnectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOutboundConnectionsCommandOutput) => void), - cb?: (err: any, data?: DescribeOutboundConnectionsCommandOutput) => void - ): Promise | void { - const command = new DescribeOutboundConnectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes all packages available to OpenSearch Service. For more information, see Custom - * packages for Amazon OpenSearch Service.

+ * @see {@link DescribePackagesCommand} */ - public describePackages( + describePackages( args: DescribePackagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePackages( + describePackages( args: DescribePackagesCommandInput, cb: (err: any, data?: DescribePackagesCommandOutput) => void ): void; - public describePackages( + describePackages( args: DescribePackagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePackagesCommandOutput) => void ): void; - public describePackages( - args: DescribePackagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePackagesCommandOutput) => void), - cb?: (err: any, data?: DescribePackagesCommandOutput) => void - ): Promise | void { - const command = new DescribePackagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given - * Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

+ * @see {@link DescribeReservedInstanceOfferingsCommand} */ - public describeReservedInstanceOfferings( + describeReservedInstanceOfferings( args: DescribeReservedInstanceOfferingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReservedInstanceOfferings( + describeReservedInstanceOfferings( args: DescribeReservedInstanceOfferingsCommandInput, cb: (err: any, data?: DescribeReservedInstanceOfferingsCommandOutput) => void ): void; - public describeReservedInstanceOfferings( + describeReservedInstanceOfferings( args: DescribeReservedInstanceOfferingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReservedInstanceOfferingsCommandOutput) => void ): void; - public describeReservedInstanceOfferings( - args: DescribeReservedInstanceOfferingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReservedInstanceOfferingsCommandOutput) => void), - cb?: (err: any, data?: DescribeReservedInstanceOfferingsCommandOutput) => void - ): Promise | void { - const command = new DescribeReservedInstanceOfferingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. - * For more information, see Reserved Instances in Amazon OpenSearch - * Service.

+ * @see {@link DescribeReservedInstancesCommand} */ - public describeReservedInstances( + describeReservedInstances( args: DescribeReservedInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReservedInstances( + describeReservedInstances( args: DescribeReservedInstancesCommandInput, cb: (err: any, data?: DescribeReservedInstancesCommandOutput) => void ): void; - public describeReservedInstances( + describeReservedInstances( args: DescribeReservedInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReservedInstancesCommandOutput) => void ): void; - public describeReservedInstances( - args: DescribeReservedInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReservedInstancesCommandOutput) => void), - cb?: (err: any, data?: DescribeReservedInstancesCommandOutput) => void - ): Promise | void { - const command = new DescribeReservedInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

+ * @see {@link DescribeVpcEndpointsCommand} */ - public describeVpcEndpoints( + describeVpcEndpoints( args: DescribeVpcEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVpcEndpoints( + describeVpcEndpoints( args: DescribeVpcEndpointsCommandInput, cb: (err: any, data?: DescribeVpcEndpointsCommandOutput) => void ): void; - public describeVpcEndpoints( + describeVpcEndpoints( args: DescribeVpcEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVpcEndpointsCommandOutput) => void ): void; - public describeVpcEndpoints( - args: DescribeVpcEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVpcEndpointsCommandOutput) => void), - cb?: (err: any, data?: DescribeVpcEndpointsCommandOutput) => void - ): Promise | void { - const command = new DescribeVpcEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a package from the specified Amazon OpenSearch Service domain. The package can't be - * in use with any OpenSearch index for the dissociation to succeed. The package is still available - * in OpenSearch Service for association later. For more information, see Custom - * packages for Amazon OpenSearch Service.

+ * @see {@link DissociatePackageCommand} */ - public dissociatePackage( + dissociatePackage( args: DissociatePackageCommandInput, options?: __HttpHandlerOptions ): Promise; - public dissociatePackage( + dissociatePackage( args: DissociatePackageCommandInput, cb: (err: any, data?: DissociatePackageCommandOutput) => void ): void; - public dissociatePackage( + dissociatePackage( args: DissociatePackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DissociatePackageCommandOutput) => void ): void; - public dissociatePackage( - args: DissociatePackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DissociatePackageCommandOutput) => void), - cb?: (err: any, data?: DissociatePackageCommandOutput) => void - ): Promise | void { - const command = new DissociatePackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them - * to.

+ * @see {@link GetCompatibleVersionsCommand} */ - public getCompatibleVersions( + getCompatibleVersions( args: GetCompatibleVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCompatibleVersions( + getCompatibleVersions( args: GetCompatibleVersionsCommandInput, cb: (err: any, data?: GetCompatibleVersionsCommandOutput) => void ): void; - public getCompatibleVersions( + getCompatibleVersions( args: GetCompatibleVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCompatibleVersionsCommandOutput) => void ): void; - public getCompatibleVersions( - args: GetCompatibleVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCompatibleVersionsCommandOutput) => void), - cb?: (err: any, data?: GetCompatibleVersionsCommandOutput) => void - ): Promise | void { - const command = new GetCompatibleVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of Amazon OpenSearch Service package versions, along with their creation time - * and commit message. For more information, see Custom packages for Amazon - * OpenSearch Service.

+ * @see {@link GetPackageVersionHistoryCommand} */ - public getPackageVersionHistory( + getPackageVersionHistory( args: GetPackageVersionHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPackageVersionHistory( + getPackageVersionHistory( args: GetPackageVersionHistoryCommandInput, cb: (err: any, data?: GetPackageVersionHistoryCommandOutput) => void ): void; - public getPackageVersionHistory( + getPackageVersionHistory( args: GetPackageVersionHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPackageVersionHistoryCommandOutput) => void ): void; - public getPackageVersionHistory( - args: GetPackageVersionHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPackageVersionHistoryCommandOutput) => void), - cb?: (err: any, data?: GetPackageVersionHistoryCommandOutput) => void - ): Promise | void { - const command = new GetPackageVersionHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch - * Service domain.

+ * @see {@link GetUpgradeHistoryCommand} */ - public getUpgradeHistory( + getUpgradeHistory( args: GetUpgradeHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUpgradeHistory( + getUpgradeHistory( args: GetUpgradeHistoryCommandInput, cb: (err: any, data?: GetUpgradeHistoryCommandOutput) => void ): void; - public getUpgradeHistory( + getUpgradeHistory( args: GetUpgradeHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUpgradeHistoryCommandOutput) => void ): void; - public getUpgradeHistory( - args: GetUpgradeHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUpgradeHistoryCommandOutput) => void), - cb?: (err: any, data?: GetUpgradeHistoryCommandOutput) => void - ): Promise | void { - const command = new GetUpgradeHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the most recent status of the last upgrade or upgrade eligibility check performed on - * an Amazon OpenSearch Service domain.

+ * @see {@link GetUpgradeStatusCommand} */ - public getUpgradeStatus( + getUpgradeStatus( args: GetUpgradeStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUpgradeStatus( + getUpgradeStatus( args: GetUpgradeStatusCommandInput, cb: (err: any, data?: GetUpgradeStatusCommandOutput) => void ): void; - public getUpgradeStatus( + getUpgradeStatus( args: GetUpgradeStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUpgradeStatusCommandOutput) => void ): void; - public getUpgradeStatus( - args: GetUpgradeStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUpgradeStatusCommandOutput) => void), - cb?: (err: any, data?: GetUpgradeStatusCommandOutput) => void - ): Promise | void { - const command = new GetUpgradeStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the names of all Amazon OpenSearch Service domains owned by the current user in the - * active Region.

+ * @see {@link ListDomainNamesCommand} */ - public listDomainNames( + listDomainNames( args: ListDomainNamesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDomainNames( - args: ListDomainNamesCommandInput, - cb: (err: any, data?: ListDomainNamesCommandOutput) => void - ): void; - public listDomainNames( + listDomainNames(args: ListDomainNamesCommandInput, cb: (err: any, data?: ListDomainNamesCommandOutput) => void): void; + listDomainNames( args: ListDomainNamesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainNamesCommandOutput) => void ): void; - public listDomainNames( - args: ListDomainNamesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDomainNamesCommandOutput) => void), - cb?: (err: any, data?: ListDomainNamesCommandOutput) => void - ): Promise | void { - const command = new ListDomainNamesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all Amazon OpenSearch Service domains associated with a given package. For more - * information, see Custom packages for Amazon - * OpenSearch Service.

+ * @see {@link ListDomainsForPackageCommand} */ - public listDomainsForPackage( + listDomainsForPackage( args: ListDomainsForPackageCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDomainsForPackage( + listDomainsForPackage( args: ListDomainsForPackageCommandInput, cb: (err: any, data?: ListDomainsForPackageCommandOutput) => void ): void; - public listDomainsForPackage( + listDomainsForPackage( args: ListDomainsForPackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainsForPackageCommandOutput) => void ): void; - public listDomainsForPackage( - args: ListDomainsForPackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDomainsForPackageCommandOutput) => void), - cb?: (err: any, data?: ListDomainsForPackageCommandOutput) => void - ): Promise | void { - const command = new ListDomainsForPackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all instance types and available features for a given OpenSearch or Elasticsearch - * version.

+ * @see {@link ListInstanceTypeDetailsCommand} */ - public listInstanceTypeDetails( + listInstanceTypeDetails( args: ListInstanceTypeDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInstanceTypeDetails( + listInstanceTypeDetails( args: ListInstanceTypeDetailsCommandInput, cb: (err: any, data?: ListInstanceTypeDetailsCommandOutput) => void ): void; - public listInstanceTypeDetails( + listInstanceTypeDetails( args: ListInstanceTypeDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInstanceTypeDetailsCommandOutput) => void ): void; - public listInstanceTypeDetails( - args: ListInstanceTypeDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInstanceTypeDetailsCommandOutput) => void), - cb?: (err: any, data?: ListInstanceTypeDetailsCommandOutput) => void - ): Promise | void { - const command = new ListInstanceTypeDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all packages associated with an Amazon OpenSearch Service domain. For more - * information, see Custom packages for Amazon - * OpenSearch Service.

+ * @see {@link ListPackagesForDomainCommand} */ - public listPackagesForDomain( + listPackagesForDomain( args: ListPackagesForDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPackagesForDomain( + listPackagesForDomain( args: ListPackagesForDomainCommandInput, cb: (err: any, data?: ListPackagesForDomainCommandOutput) => void ): void; - public listPackagesForDomain( + listPackagesForDomain( args: ListPackagesForDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPackagesForDomainCommandOutput) => void ): void; - public listPackagesForDomain( - args: ListPackagesForDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPackagesForDomainCommandOutput) => void), - cb?: (err: any, data?: ListPackagesForDomainCommandOutput) => void - ): Promise | void { - const command = new ListPackagesForDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of configuration changes that are scheduled for a domain. These changes can - * be service software - * updates or blue/green - * Auto-Tune enhancements.

+ * @see {@link ListScheduledActionsCommand} */ - public listScheduledActions( + listScheduledActions( args: ListScheduledActionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listScheduledActions( + listScheduledActions( args: ListScheduledActionsCommandInput, cb: (err: any, data?: ListScheduledActionsCommandOutput) => void ): void; - public listScheduledActions( + listScheduledActions( args: ListScheduledActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListScheduledActionsCommandOutput) => void ): void; - public listScheduledActions( - args: ListScheduledActionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListScheduledActionsCommandOutput) => void), - cb?: (err: any, data?: ListScheduledActionsCommandOutput) => void - ): Promise | void { - const command = new ListScheduledActionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see - * Tagging Amazon OpenSearch Service domains.

+ * @see {@link ListTagsCommand} */ - public listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; - public listTags( + listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; + listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; + listTags( args: ListTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsCommandOutput) => void ): void; - public listTags( - args: ListTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsCommandOutput) => void), - cb?: (err: any, data?: ListTagsCommandOutput) => void - ): Promise | void { - const command = new ListTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service - * supports.

+ * @see {@link ListVersionsCommand} */ - public listVersions( - args: ListVersionsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listVersions(args: ListVersionsCommandInput, cb: (err: any, data?: ListVersionsCommandOutput) => void): void; - public listVersions( + listVersions(args: ListVersionsCommandInput, options?: __HttpHandlerOptions): Promise; + listVersions(args: ListVersionsCommandInput, cb: (err: any, data?: ListVersionsCommandOutput) => void): void; + listVersions( args: ListVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVersionsCommandOutput) => void ): void; - public listVersions( - args: ListVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVersionsCommandOutput) => void), - cb?: (err: any, data?: ListVersionsCommandOutput) => void - ): Promise | void { - const command = new ListVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about each Amazon Web Services principal that is allowed to access a - * given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

+ * @see {@link ListVpcEndpointAccessCommand} */ - public listVpcEndpointAccess( + listVpcEndpointAccess( args: ListVpcEndpointAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVpcEndpointAccess( + listVpcEndpointAccess( args: ListVpcEndpointAccessCommandInput, cb: (err: any, data?: ListVpcEndpointAccessCommandOutput) => void ): void; - public listVpcEndpointAccess( + listVpcEndpointAccess( args: ListVpcEndpointAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVpcEndpointAccessCommandOutput) => void ): void; - public listVpcEndpointAccess( - args: ListVpcEndpointAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVpcEndpointAccessCommandOutput) => void), - cb?: (err: any, data?: ListVpcEndpointAccessCommandOutput) => void - ): Promise | void { - const command = new ListVpcEndpointAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.

+ * @see {@link ListVpcEndpointsCommand} */ - public listVpcEndpoints( + listVpcEndpoints( args: ListVpcEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVpcEndpoints( + listVpcEndpoints( args: ListVpcEndpointsCommandInput, cb: (err: any, data?: ListVpcEndpointsCommandOutput) => void ): void; - public listVpcEndpoints( + listVpcEndpoints( args: ListVpcEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVpcEndpointsCommandOutput) => void ): void; - public listVpcEndpoints( - args: ListVpcEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVpcEndpointsCommandOutput) => void), - cb?: (err: any, data?: ListVpcEndpointsCommandOutput) => void - ): Promise | void { - const command = new ListVpcEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular - * domain.

+ * @see {@link ListVpcEndpointsForDomainCommand} */ - public listVpcEndpointsForDomain( + listVpcEndpointsForDomain( args: ListVpcEndpointsForDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVpcEndpointsForDomain( + listVpcEndpointsForDomain( args: ListVpcEndpointsForDomainCommandInput, cb: (err: any, data?: ListVpcEndpointsForDomainCommandOutput) => void ): void; - public listVpcEndpointsForDomain( + listVpcEndpointsForDomain( args: ListVpcEndpointsForDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVpcEndpointsForDomainCommandOutput) => void ): void; - public listVpcEndpointsForDomain( - args: ListVpcEndpointsForDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVpcEndpointsForDomainCommandOutput) => void), - cb?: (err: any, data?: ListVpcEndpointsForDomainCommandOutput) => void - ): Promise | void { - const command = new ListVpcEndpointsForDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

+ * @see {@link PurchaseReservedInstanceOfferingCommand} */ - public purchaseReservedInstanceOffering( + purchaseReservedInstanceOffering( args: PurchaseReservedInstanceOfferingCommandInput, options?: __HttpHandlerOptions ): Promise; - public purchaseReservedInstanceOffering( + purchaseReservedInstanceOffering( args: PurchaseReservedInstanceOfferingCommandInput, cb: (err: any, data?: PurchaseReservedInstanceOfferingCommandOutput) => void ): void; - public purchaseReservedInstanceOffering( + purchaseReservedInstanceOffering( args: PurchaseReservedInstanceOfferingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PurchaseReservedInstanceOfferingCommandOutput) => void ): void; - public purchaseReservedInstanceOffering( - args: PurchaseReservedInstanceOfferingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PurchaseReservedInstanceOfferingCommandOutput) => void), - cb?: (err: any, data?: PurchaseReservedInstanceOfferingCommandOutput) => void - ): Promise | void { - const command = new PurchaseReservedInstanceOfferingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster - * connection request.

+ * @see {@link RejectInboundConnectionCommand} */ - public rejectInboundConnection( + rejectInboundConnection( args: RejectInboundConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public rejectInboundConnection( + rejectInboundConnection( args: RejectInboundConnectionCommandInput, cb: (err: any, data?: RejectInboundConnectionCommandOutput) => void ): void; - public rejectInboundConnection( + rejectInboundConnection( args: RejectInboundConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectInboundConnectionCommandOutput) => void ): void; - public rejectInboundConnection( - args: RejectInboundConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RejectInboundConnectionCommandOutput) => void), - cb?: (err: any, data?: RejectInboundConnectionCommandOutput) => void - ): Promise | void { - const command = new RejectInboundConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified set of tags from an Amazon OpenSearch Service domain. For more - * information, see Tagging Amazon OpenSearch Service domains.

+ * @see {@link RemoveTagsCommand} */ - public removeTags(args: RemoveTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public removeTags(args: RemoveTagsCommandInput, cb: (err: any, data?: RemoveTagsCommandOutput) => void): void; - public removeTags( + removeTags(args: RemoveTagsCommandInput, options?: __HttpHandlerOptions): Promise; + removeTags(args: RemoveTagsCommandInput, cb: (err: any, data?: RemoveTagsCommandOutput) => void): void; + removeTags( args: RemoveTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsCommandOutput) => void ): void; - public removeTags( - args: RemoveTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveTagsCommandOutput) => void), - cb?: (err: any, data?: RemoveTagsCommandOutput) => void - ): Promise | void { - const command = new RemoveTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface - * VPC endpoint.

+ * @see {@link RevokeVpcEndpointAccessCommand} */ - public revokeVpcEndpointAccess( + revokeVpcEndpointAccess( args: RevokeVpcEndpointAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public revokeVpcEndpointAccess( + revokeVpcEndpointAccess( args: RevokeVpcEndpointAccessCommandInput, cb: (err: any, data?: RevokeVpcEndpointAccessCommandOutput) => void ): void; - public revokeVpcEndpointAccess( + revokeVpcEndpointAccess( args: RevokeVpcEndpointAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeVpcEndpointAccessCommandOutput) => void ): void; - public revokeVpcEndpointAccess( - args: RevokeVpcEndpointAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RevokeVpcEndpointAccessCommandOutput) => void), - cb?: (err: any, data?: RevokeVpcEndpointAccessCommandOutput) => void - ): Promise | void { - const command = new RevokeVpcEndpointAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Schedules a service software update for an Amazon OpenSearch Service domain. For more - * information, see Service software updates in - * Amazon OpenSearch Service.

+ * @see {@link StartServiceSoftwareUpdateCommand} */ - public startServiceSoftwareUpdate( + startServiceSoftwareUpdate( args: StartServiceSoftwareUpdateCommandInput, options?: __HttpHandlerOptions ): Promise; - public startServiceSoftwareUpdate( + startServiceSoftwareUpdate( args: StartServiceSoftwareUpdateCommandInput, cb: (err: any, data?: StartServiceSoftwareUpdateCommandOutput) => void ): void; - public startServiceSoftwareUpdate( + startServiceSoftwareUpdate( args: StartServiceSoftwareUpdateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartServiceSoftwareUpdateCommandOutput) => void ): void; - public startServiceSoftwareUpdate( - args: StartServiceSoftwareUpdateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartServiceSoftwareUpdateCommandOutput) => void), - cb?: (err: any, data?: StartServiceSoftwareUpdateCommandOutput) => void - ): Promise | void { - const command = new StartServiceSoftwareUpdateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.

+ * @see {@link UpdateDomainConfigCommand} */ - public updateDomainConfig( + updateDomainConfig( args: UpdateDomainConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDomainConfig( + updateDomainConfig( args: UpdateDomainConfigCommandInput, cb: (err: any, data?: UpdateDomainConfigCommandOutput) => void ): void; - public updateDomainConfig( + updateDomainConfig( args: UpdateDomainConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDomainConfigCommandOutput) => void ): void; - public updateDomainConfig( - args: UpdateDomainConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDomainConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateDomainConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateDomainConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a package for use with Amazon OpenSearch Service domains. For more information, see - * Custom packages for Amazon OpenSearch Service.

+ * @see {@link UpdatePackageCommand} */ - public updatePackage( - args: UpdatePackageCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updatePackage( - args: UpdatePackageCommandInput, - cb: (err: any, data?: UpdatePackageCommandOutput) => void - ): void; - public updatePackage( + updatePackage(args: UpdatePackageCommandInput, options?: __HttpHandlerOptions): Promise; + updatePackage(args: UpdatePackageCommandInput, cb: (err: any, data?: UpdatePackageCommandOutput) => void): void; + updatePackage( args: UpdatePackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePackageCommandOutput) => void ): void; - public updatePackage( - args: UpdatePackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePackageCommandOutput) => void), - cb?: (err: any, data?: UpdatePackageCommandOutput) => void - ): Promise | void { - const command = new UpdatePackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Reschedules a planned domain configuration change for a later time. This change can be a - * scheduled service software - * update or a blue/green - * Auto-Tune enhancement.

+ * @see {@link UpdateScheduledActionCommand} */ - public updateScheduledAction( + updateScheduledAction( args: UpdateScheduledActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateScheduledAction( + updateScheduledAction( args: UpdateScheduledActionCommandInput, cb: (err: any, data?: UpdateScheduledActionCommandOutput) => void ): void; - public updateScheduledAction( + updateScheduledAction( args: UpdateScheduledActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateScheduledActionCommandOutput) => void ): void; - public updateScheduledAction( - args: UpdateScheduledActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateScheduledActionCommandOutput) => void), - cb?: (err: any, data?: UpdateScheduledActionCommandOutput) => void - ): Promise | void { - const command = new UpdateScheduledActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

+ * @see {@link UpdateVpcEndpointCommand} */ - public updateVpcEndpoint( + updateVpcEndpoint( args: UpdateVpcEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVpcEndpoint( + updateVpcEndpoint( args: UpdateVpcEndpointCommandInput, cb: (err: any, data?: UpdateVpcEndpointCommandOutput) => void ): void; - public updateVpcEndpoint( + updateVpcEndpoint( args: UpdateVpcEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVpcEndpointCommandOutput) => void ): void; - public updateVpcEndpoint( - args: UpdateVpcEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVpcEndpointCommandOutput) => void), - cb?: (err: any, data?: UpdateVpcEndpointCommandOutput) => void - ): Promise | void { - const command = new UpdateVpcEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade - * eligibility check to a compatible version of OpenSearch or Elasticsearch.

+ * @see {@link UpgradeDomainCommand} */ - public upgradeDomain( - args: UpgradeDomainCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public upgradeDomain( - args: UpgradeDomainCommandInput, - cb: (err: any, data?: UpgradeDomainCommandOutput) => void - ): void; - public upgradeDomain( + upgradeDomain(args: UpgradeDomainCommandInput, options?: __HttpHandlerOptions): Promise; + upgradeDomain(args: UpgradeDomainCommandInput, cb: (err: any, data?: UpgradeDomainCommandOutput) => void): void; + upgradeDomain( args: UpgradeDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpgradeDomainCommandOutput) => void ): void; - public upgradeDomain( - args: UpgradeDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpgradeDomainCommandOutput) => void), - cb?: (err: any, data?: UpgradeDomainCommandOutput) => void - ): Promise | void { - const command = new UpgradeDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Use the Amazon OpenSearch Service configuration API to create, configure, and manage + * OpenSearch Service domains.

+ *

For sample code that uses the configuration API, see the + * Amazon OpenSearch Service Developer Guide + * . The guide also + * contains sample code for + * sending signed HTTP requests to the OpenSearch APIs. The endpoint for configuration service + * requests is Region specific: es.region.amazonaws.com. For example, + * es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see Amazon Web Services + * service endpoints.

+ */ +export class OpenSearch extends OpenSearchClient implements OpenSearch {} +createAggregatedClient(commands, OpenSearch); diff --git a/clients/client-opensearchserverless/src/OpenSearchServerless.ts b/clients/client-opensearchserverless/src/OpenSearchServerless.ts index 4a6d7dfe46eb..5d8ff8df068a 100644 --- a/clients/client-opensearchserverless/src/OpenSearchServerless.ts +++ b/clients/client-opensearchserverless/src/OpenSearchServerless.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -152,1079 +153,565 @@ import { UpdateVpcEndpointCommandInput, UpdateVpcEndpointCommandOutput, } from "./commands/UpdateVpcEndpointCommand"; -import { OpenSearchServerlessClient } from "./OpenSearchServerlessClient"; +import { OpenSearchServerlessClient, OpenSearchServerlessClientConfig } from "./OpenSearchServerlessClient"; -/** - * @public - *

Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and - * security policies.

- *

OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for - * Amazon OpenSearch Service. OpenSearch Serverless removes the operational complexities of provisioning, - * configuring, and tuning your OpenSearch clusters. It enables you to easily search and - * analyze petabytes of data without having to worry about the underlying infrastructure - * and data management.

- *

To learn more about OpenSearch Serverless, see What is - * Amazon OpenSearch Serverless? - *

- */ -export class OpenSearchServerless extends OpenSearchServerlessClient { +const commands = { + BatchGetCollectionCommand, + BatchGetVpcEndpointCommand, + CreateAccessPolicyCommand, + CreateCollectionCommand, + CreateSecurityConfigCommand, + CreateSecurityPolicyCommand, + CreateVpcEndpointCommand, + DeleteAccessPolicyCommand, + DeleteCollectionCommand, + DeleteSecurityConfigCommand, + DeleteSecurityPolicyCommand, + DeleteVpcEndpointCommand, + GetAccessPolicyCommand, + GetAccountSettingsCommand, + GetPoliciesStatsCommand, + GetSecurityConfigCommand, + GetSecurityPolicyCommand, + ListAccessPoliciesCommand, + ListCollectionsCommand, + ListSecurityConfigsCommand, + ListSecurityPoliciesCommand, + ListTagsForResourceCommand, + ListVpcEndpointsCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAccessPolicyCommand, + UpdateAccountSettingsCommand, + UpdateCollectionCommand, + UpdateSecurityConfigCommand, + UpdateSecurityPolicyCommand, + UpdateVpcEndpointCommand, +}; + +export interface OpenSearchServerless { /** - * @public - *

Returns attributes for one or more collections, including the collection endpoint and - * the OpenSearch Dashboards endpoint. For more information, see Creating and - * managing Amazon OpenSearch Serverless collections.

+ * @see {@link BatchGetCollectionCommand} */ - public batchGetCollection( + batchGetCollection( args: BatchGetCollectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetCollection( + batchGetCollection( args: BatchGetCollectionCommandInput, cb: (err: any, data?: BatchGetCollectionCommandOutput) => void ): void; - public batchGetCollection( + batchGetCollection( args: BatchGetCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetCollectionCommandOutput) => void ): void; - public batchGetCollection( - args: BatchGetCollectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetCollectionCommandOutput) => void), - cb?: (err: any, data?: BatchGetCollectionCommandOutput) => void - ): Promise | void { - const command = new BatchGetCollectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns attributes for one or more VPC endpoints associated with the current account. - * For more information, see - * Access Amazon OpenSearch Serverless using an interface endpoint.

+ * @see {@link BatchGetVpcEndpointCommand} */ - public batchGetVpcEndpoint( + batchGetVpcEndpoint( args: BatchGetVpcEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetVpcEndpoint( + batchGetVpcEndpoint( args: BatchGetVpcEndpointCommandInput, cb: (err: any, data?: BatchGetVpcEndpointCommandOutput) => void ): void; - public batchGetVpcEndpoint( + batchGetVpcEndpoint( args: BatchGetVpcEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetVpcEndpointCommandOutput) => void ): void; - public batchGetVpcEndpoint( - args: BatchGetVpcEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetVpcEndpointCommandOutput) => void), - cb?: (err: any, data?: BatchGetVpcEndpointCommandOutput) => void - ): Promise | void { - const command = new BatchGetVpcEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections - * and the resources within them, and allow a user to access that data irrespective of the - * access mechanism or network source. For more information, see Data access - * control for Amazon OpenSearch Serverless.

+ * @see {@link CreateAccessPolicyCommand} */ - public createAccessPolicy( + createAccessPolicy( args: CreateAccessPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAccessPolicy( + createAccessPolicy( args: CreateAccessPolicyCommandInput, cb: (err: any, data?: CreateAccessPolicyCommandOutput) => void ): void; - public createAccessPolicy( + createAccessPolicy( args: CreateAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessPolicyCommandOutput) => void ): void; - public createAccessPolicy( - args: CreateAccessPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAccessPolicyCommandOutput) => void), - cb?: (err: any, data?: CreateAccessPolicyCommandOutput) => void - ): Promise | void { - const command = new CreateAccessPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new OpenSearch Serverless collection. For more information, see Creating and - * managing Amazon OpenSearch Serverless collections.

+ * @see {@link CreateCollectionCommand} */ - public createCollection( + createCollection( args: CreateCollectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCollection( + createCollection( args: CreateCollectionCommandInput, cb: (err: any, data?: CreateCollectionCommandOutput) => void ): void; - public createCollection( + createCollection( args: CreateCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCollectionCommandOutput) => void ): void; - public createCollection( - args: CreateCollectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCollectionCommandOutput) => void), - cb?: (err: any, data?: CreateCollectionCommandOutput) => void - ): Promise | void { - const command = new CreateCollectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Specifies a security configuration for OpenSearch Serverless. For more information, see - * SAML - * authentication for Amazon OpenSearch Serverless.

+ * @see {@link CreateSecurityConfigCommand} */ - public createSecurityConfig( + createSecurityConfig( args: CreateSecurityConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSecurityConfig( + createSecurityConfig( args: CreateSecurityConfigCommandInput, cb: (err: any, data?: CreateSecurityConfigCommandOutput) => void ): void; - public createSecurityConfig( + createSecurityConfig( args: CreateSecurityConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSecurityConfigCommandOutput) => void ): void; - public createSecurityConfig( - args: CreateSecurityConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSecurityConfigCommandOutput) => void), - cb?: (err: any, data?: CreateSecurityConfigCommandOutput) => void - ): Promise | void { - const command = new CreateSecurityConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a security policy to be used by one or more OpenSearch Serverless collections. Security - * policies provide access to a collection and its OpenSearch Dashboards endpoint from - * public networks or specific VPC endpoints. They also allow you to secure a collection - * with a KMS encryption key. For more information, see Network access - * for Amazon OpenSearch Serverless and Encryption at - * rest for Amazon OpenSearch Serverless.

+ * @see {@link CreateSecurityPolicyCommand} */ - public createSecurityPolicy( + createSecurityPolicy( args: CreateSecurityPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSecurityPolicy( + createSecurityPolicy( args: CreateSecurityPolicyCommandInput, cb: (err: any, data?: CreateSecurityPolicyCommandOutput) => void ): void; - public createSecurityPolicy( + createSecurityPolicy( args: CreateSecurityPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSecurityPolicyCommandOutput) => void ): void; - public createSecurityPolicy( - args: CreateSecurityPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSecurityPolicyCommandOutput) => void), - cb?: (err: any, data?: CreateSecurityPolicyCommandOutput) => void - ): Promise | void { - const command = new CreateSecurityPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access - * Amazon OpenSearch Serverless using an interface endpoint.

+ * @see {@link CreateVpcEndpointCommand} */ - public createVpcEndpoint( + createVpcEndpoint( args: CreateVpcEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVpcEndpoint( + createVpcEndpoint( args: CreateVpcEndpointCommandInput, cb: (err: any, data?: CreateVpcEndpointCommandOutput) => void ): void; - public createVpcEndpoint( + createVpcEndpoint( args: CreateVpcEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVpcEndpointCommandOutput) => void ): void; - public createVpcEndpoint( - args: CreateVpcEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVpcEndpointCommandOutput) => void), - cb?: (err: any, data?: CreateVpcEndpointCommandOutput) => void - ): Promise | void { - const command = new CreateVpcEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an OpenSearch Serverless access policy. For more information, see Data - * access control for Amazon OpenSearch Serverless.

+ * @see {@link DeleteAccessPolicyCommand} */ - public deleteAccessPolicy( + deleteAccessPolicy( args: DeleteAccessPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAccessPolicy( + deleteAccessPolicy( args: DeleteAccessPolicyCommandInput, cb: (err: any, data?: DeleteAccessPolicyCommandOutput) => void ): void; - public deleteAccessPolicy( + deleteAccessPolicy( args: DeleteAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessPolicyCommandOutput) => void ): void; - public deleteAccessPolicy( - args: DeleteAccessPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAccessPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteAccessPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteAccessPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an OpenSearch Serverless collection. For more information, see Creating and - * managing Amazon OpenSearch Serverless collections.

+ * @see {@link DeleteCollectionCommand} */ - public deleteCollection( + deleteCollection( args: DeleteCollectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCollection( + deleteCollection( args: DeleteCollectionCommandInput, cb: (err: any, data?: DeleteCollectionCommandOutput) => void ): void; - public deleteCollection( + deleteCollection( args: DeleteCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCollectionCommandOutput) => void ): void; - public deleteCollection( - args: DeleteCollectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCollectionCommandOutput) => void), - cb?: (err: any, data?: DeleteCollectionCommandOutput) => void - ): Promise | void { - const command = new DeleteCollectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a security configuration for OpenSearch Serverless. For more information, see - * SAML - * authentication for Amazon OpenSearch Serverless.

+ * @see {@link DeleteSecurityConfigCommand} */ - public deleteSecurityConfig( + deleteSecurityConfig( args: DeleteSecurityConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSecurityConfig( + deleteSecurityConfig( args: DeleteSecurityConfigCommandInput, cb: (err: any, data?: DeleteSecurityConfigCommandOutput) => void ): void; - public deleteSecurityConfig( + deleteSecurityConfig( args: DeleteSecurityConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSecurityConfigCommandOutput) => void ): void; - public deleteSecurityConfig( - args: DeleteSecurityConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSecurityConfigCommandOutput) => void), - cb?: (err: any, data?: DeleteSecurityConfigCommandOutput) => void - ): Promise | void { - const command = new DeleteSecurityConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an OpenSearch Serverless security policy.

+ * @see {@link DeleteSecurityPolicyCommand} */ - public deleteSecurityPolicy( + deleteSecurityPolicy( args: DeleteSecurityPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSecurityPolicy( + deleteSecurityPolicy( args: DeleteSecurityPolicyCommandInput, cb: (err: any, data?: DeleteSecurityPolicyCommandOutput) => void ): void; - public deleteSecurityPolicy( + deleteSecurityPolicy( args: DeleteSecurityPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSecurityPolicyCommandOutput) => void ): void; - public deleteSecurityPolicy( - args: DeleteSecurityPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSecurityPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteSecurityPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteSecurityPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see - * Access Amazon OpenSearch Serverless using an interface endpoint.

+ * @see {@link DeleteVpcEndpointCommand} */ - public deleteVpcEndpoint( + deleteVpcEndpoint( args: DeleteVpcEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVpcEndpoint( + deleteVpcEndpoint( args: DeleteVpcEndpointCommandInput, cb: (err: any, data?: DeleteVpcEndpointCommandOutput) => void ): void; - public deleteVpcEndpoint( + deleteVpcEndpoint( args: DeleteVpcEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVpcEndpointCommandOutput) => void ): void; - public deleteVpcEndpoint( - args: DeleteVpcEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVpcEndpointCommandOutput) => void), - cb?: (err: any, data?: DeleteVpcEndpointCommandOutput) => void - ): Promise | void { - const command = new DeleteVpcEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an OpenSearch Serverless access policy. For more information, see Data - * access control for Amazon OpenSearch Serverless.

+ * @see {@link GetAccessPolicyCommand} */ - public getAccessPolicy( + getAccessPolicy( args: GetAccessPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccessPolicy( - args: GetAccessPolicyCommandInput, - cb: (err: any, data?: GetAccessPolicyCommandOutput) => void - ): void; - public getAccessPolicy( + getAccessPolicy(args: GetAccessPolicyCommandInput, cb: (err: any, data?: GetAccessPolicyCommandOutput) => void): void; + getAccessPolicy( args: GetAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessPolicyCommandOutput) => void ): void; - public getAccessPolicy( - args: GetAccessPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccessPolicyCommandOutput) => void), - cb?: (err: any, data?: GetAccessPolicyCommandOutput) => void - ): Promise | void { - const command = new GetAccessPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns account-level settings related to OpenSearch Serverless.

+ * @see {@link GetAccountSettingsCommand} */ - public getAccountSettings( + getAccountSettings( args: GetAccountSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccountSettings( + getAccountSettings( args: GetAccountSettingsCommandInput, cb: (err: any, data?: GetAccountSettingsCommandOutput) => void ): void; - public getAccountSettings( + getAccountSettings( args: GetAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountSettingsCommandOutput) => void ): void; - public getAccountSettings( - args: GetAccountSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccountSettingsCommandOutput) => void), - cb?: (err: any, data?: GetAccountSettingsCommandOutput) => void - ): Promise | void { - const command = new GetAccountSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns statistical information about your OpenSearch Serverless access policies, security - * configurations, and security policies.

+ * @see {@link GetPoliciesStatsCommand} */ - public getPoliciesStats( + getPoliciesStats( args: GetPoliciesStatsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPoliciesStats( + getPoliciesStats( args: GetPoliciesStatsCommandInput, cb: (err: any, data?: GetPoliciesStatsCommandOutput) => void ): void; - public getPoliciesStats( + getPoliciesStats( args: GetPoliciesStatsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPoliciesStatsCommandOutput) => void ): void; - public getPoliciesStats( - args: GetPoliciesStatsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPoliciesStatsCommandOutput) => void), - cb?: (err: any, data?: GetPoliciesStatsCommandOutput) => void - ): Promise | void { - const command = new GetPoliciesStatsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about an OpenSearch Serverless security configuration. For more information, see - * SAML - * authentication for Amazon OpenSearch Serverless.

+ * @see {@link GetSecurityConfigCommand} */ - public getSecurityConfig( + getSecurityConfig( args: GetSecurityConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSecurityConfig( + getSecurityConfig( args: GetSecurityConfigCommandInput, cb: (err: any, data?: GetSecurityConfigCommandOutput) => void ): void; - public getSecurityConfig( + getSecurityConfig( args: GetSecurityConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSecurityConfigCommandOutput) => void ): void; - public getSecurityConfig( - args: GetSecurityConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSecurityConfigCommandOutput) => void), - cb?: (err: any, data?: GetSecurityConfigCommandOutput) => void - ): Promise | void { - const command = new GetSecurityConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a configured OpenSearch Serverless security policy. For more information, see Network access - * for Amazon OpenSearch Serverless and Encryption at - * rest for Amazon OpenSearch Serverless.

+ * @see {@link GetSecurityPolicyCommand} */ - public getSecurityPolicy( + getSecurityPolicy( args: GetSecurityPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSecurityPolicy( + getSecurityPolicy( args: GetSecurityPolicyCommandInput, cb: (err: any, data?: GetSecurityPolicyCommandOutput) => void ): void; - public getSecurityPolicy( + getSecurityPolicy( args: GetSecurityPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSecurityPolicyCommandOutput) => void ): void; - public getSecurityPolicy( - args: GetSecurityPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSecurityPolicyCommandOutput) => void), - cb?: (err: any, data?: GetSecurityPolicyCommandOutput) => void - ): Promise | void { - const command = new GetSecurityPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a list of OpenSearch Serverless access policies.

+ * @see {@link ListAccessPoliciesCommand} */ - public listAccessPolicies( + listAccessPolicies( args: ListAccessPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAccessPolicies( + listAccessPolicies( args: ListAccessPoliciesCommandInput, cb: (err: any, data?: ListAccessPoliciesCommandOutput) => void ): void; - public listAccessPolicies( + listAccessPolicies( args: ListAccessPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessPoliciesCommandOutput) => void ): void; - public listAccessPolicies( - args: ListAccessPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccessPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListAccessPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListAccessPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all OpenSearch Serverless collections. For more information, see Creating and - * managing Amazon OpenSearch Serverless collections.

- * - *

Make sure to include an empty request body \{\} if you don't include any collection - * filters in the request.

- *
+ * @see {@link ListCollectionsCommand} */ - public listCollections( + listCollections( args: ListCollectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCollections( - args: ListCollectionsCommandInput, - cb: (err: any, data?: ListCollectionsCommandOutput) => void - ): void; - public listCollections( + listCollections(args: ListCollectionsCommandInput, cb: (err: any, data?: ListCollectionsCommandOutput) => void): void; + listCollections( args: ListCollectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCollectionsCommandOutput) => void ): void; - public listCollections( - args: ListCollectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCollectionsCommandOutput) => void), - cb?: (err: any, data?: ListCollectionsCommandOutput) => void - ): Promise | void { - const command = new ListCollectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about configured OpenSearch Serverless security configurations. For more information, see - * SAML - * authentication for Amazon OpenSearch Serverless.

+ * @see {@link ListSecurityConfigsCommand} */ - public listSecurityConfigs( + listSecurityConfigs( args: ListSecurityConfigsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSecurityConfigs( + listSecurityConfigs( args: ListSecurityConfigsCommandInput, cb: (err: any, data?: ListSecurityConfigsCommandOutput) => void ): void; - public listSecurityConfigs( + listSecurityConfigs( args: ListSecurityConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSecurityConfigsCommandOutput) => void ): void; - public listSecurityConfigs( - args: ListSecurityConfigsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSecurityConfigsCommandOutput) => void), - cb?: (err: any, data?: ListSecurityConfigsCommandOutput) => void - ): Promise | void { - const command = new ListSecurityConfigsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about configured OpenSearch Serverless security policies.

+ * @see {@link ListSecurityPoliciesCommand} */ - public listSecurityPolicies( + listSecurityPolicies( args: ListSecurityPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSecurityPolicies( + listSecurityPolicies( args: ListSecurityPoliciesCommandInput, cb: (err: any, data?: ListSecurityPoliciesCommandOutput) => void ): void; - public listSecurityPolicies( + listSecurityPolicies( args: ListSecurityPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSecurityPoliciesCommandOutput) => void ): void; - public listSecurityPolicies( - args: ListSecurityPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSecurityPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListSecurityPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListSecurityPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current - * account. For more information, see - * Access Amazon OpenSearch Serverless using an interface endpoint.

+ * @see {@link ListVpcEndpointsCommand} */ - public listVpcEndpoints( + listVpcEndpoints( args: ListVpcEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVpcEndpoints( + listVpcEndpoints( args: ListVpcEndpointsCommandInput, cb: (err: any, data?: ListVpcEndpointsCommandOutput) => void ): void; - public listVpcEndpoints( + listVpcEndpoints( args: ListVpcEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVpcEndpointsCommandOutput) => void ): void; - public listVpcEndpoints( - args: ListVpcEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVpcEndpointsCommandOutput) => void), - cb?: (err: any, data?: ListVpcEndpointsCommandOutput) => void - ): Promise | void { - const command = new ListVpcEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an OpenSearch Serverless access policy. For more information, see Data - * access control for Amazon OpenSearch Serverless.

+ * @see {@link UpdateAccessPolicyCommand} */ - public updateAccessPolicy( + updateAccessPolicy( args: UpdateAccessPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAccessPolicy( + updateAccessPolicy( args: UpdateAccessPolicyCommandInput, cb: (err: any, data?: UpdateAccessPolicyCommandOutput) => void ): void; - public updateAccessPolicy( + updateAccessPolicy( args: UpdateAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccessPolicyCommandOutput) => void ): void; - public updateAccessPolicy( - args: UpdateAccessPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAccessPolicyCommandOutput) => void), - cb?: (err: any, data?: UpdateAccessPolicyCommandOutput) => void - ): Promise | void { - const command = new UpdateAccessPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more - * information, see Managing capacity limits for Amazon OpenSearch Serverless.

+ * @see {@link UpdateAccountSettingsCommand} */ - public updateAccountSettings( + updateAccountSettings( args: UpdateAccountSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAccountSettings( + updateAccountSettings( args: UpdateAccountSettingsCommandInput, cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void ): void; - public updateAccountSettings( + updateAccountSettings( args: UpdateAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void ): void; - public updateAccountSettings( - args: UpdateAccountSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAccountSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateAccountSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateAccountSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an OpenSearch Serverless collection.

+ * @see {@link UpdateCollectionCommand} */ - public updateCollection( + updateCollection( args: UpdateCollectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCollection( + updateCollection( args: UpdateCollectionCommandInput, cb: (err: any, data?: UpdateCollectionCommandOutput) => void ): void; - public updateCollection( + updateCollection( args: UpdateCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCollectionCommandOutput) => void ): void; - public updateCollection( - args: UpdateCollectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCollectionCommandOutput) => void), - cb?: (err: any, data?: UpdateCollectionCommandOutput) => void - ): Promise | void { - const command = new UpdateCollectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a security configuration for OpenSearch Serverless. For more information, see - * SAML - * authentication for Amazon OpenSearch Serverless.

+ * @see {@link UpdateSecurityConfigCommand} */ - public updateSecurityConfig( + updateSecurityConfig( args: UpdateSecurityConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSecurityConfig( + updateSecurityConfig( args: UpdateSecurityConfigCommandInput, cb: (err: any, data?: UpdateSecurityConfigCommandOutput) => void ): void; - public updateSecurityConfig( + updateSecurityConfig( args: UpdateSecurityConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSecurityConfigCommandOutput) => void ): void; - public updateSecurityConfig( - args: UpdateSecurityConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSecurityConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateSecurityConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateSecurityConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an OpenSearch Serverless security policy. For more information, see Network access - * for Amazon OpenSearch Serverless and Encryption at - * rest for Amazon OpenSearch Serverless.

+ * @see {@link UpdateSecurityPolicyCommand} */ - public updateSecurityPolicy( + updateSecurityPolicy( args: UpdateSecurityPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSecurityPolicy( + updateSecurityPolicy( args: UpdateSecurityPolicyCommandInput, cb: (err: any, data?: UpdateSecurityPolicyCommandOutput) => void ): void; - public updateSecurityPolicy( + updateSecurityPolicy( args: UpdateSecurityPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSecurityPolicyCommandOutput) => void ): void; - public updateSecurityPolicy( - args: UpdateSecurityPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSecurityPolicyCommandOutput) => void), - cb?: (err: any, data?: UpdateSecurityPolicyCommandOutput) => void - ): Promise | void { - const command = new UpdateSecurityPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an OpenSearch Serverless-managed interface endpoint. For more information, see - * Access Amazon OpenSearch Serverless using an interface endpoint.

+ * @see {@link UpdateVpcEndpointCommand} */ - public updateVpcEndpoint( + updateVpcEndpoint( args: UpdateVpcEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVpcEndpoint( + updateVpcEndpoint( args: UpdateVpcEndpointCommandInput, cb: (err: any, data?: UpdateVpcEndpointCommandOutput) => void ): void; - public updateVpcEndpoint( + updateVpcEndpoint( args: UpdateVpcEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVpcEndpointCommandOutput) => void ): void; - public updateVpcEndpoint( - args: UpdateVpcEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVpcEndpointCommandOutput) => void), - cb?: (err: any, data?: UpdateVpcEndpointCommandOutput) => void - ): Promise | void { - const command = new UpdateVpcEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and + * security policies.

+ *

OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for + * Amazon OpenSearch Service. OpenSearch Serverless removes the operational complexities of provisioning, + * configuring, and tuning your OpenSearch clusters. It enables you to easily search and + * analyze petabytes of data without having to worry about the underlying infrastructure + * and data management.

+ *

To learn more about OpenSearch Serverless, see What is + * Amazon OpenSearch Serverless? + *

+ */ +export class OpenSearchServerless extends OpenSearchServerlessClient implements OpenSearchServerless {} +createAggregatedClient(commands, OpenSearchServerless); diff --git a/clients/client-opsworks/src/OpsWorks.ts b/clients/client-opsworks/src/OpsWorks.ts index 0c3bd9d074fe..01d249f46c08 100644 --- a/clients/client-opsworks/src/OpsWorks.ts +++ b/clients/client-opsworks/src/OpsWorks.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -311,2937 +312,1297 @@ import { UpdateVolumeCommandInput, UpdateVolumeCommandOutput, } from "./commands/UpdateVolumeCommand"; -import { OpsWorksClient } from "./OpsWorksClient"; +import { OpsWorksClient, OpsWorksClientConfig } from "./OpsWorksClient"; -/** - * @public - * AWS OpsWorks - *

Welcome to the AWS OpsWorks Stacks API Reference. This guide provides descriptions, syntax, and - * usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error - * codes.

- *

AWS OpsWorks Stacks is an application management service that provides an integrated experience for - * overseeing the complete application lifecycle. For information about this product, go to the - * AWS OpsWorks details page.

- * - *

- * SDKs and CLI - *

- *

The most common way to use the AWS OpsWorks Stacks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:

- * - * - *

- * Endpoints - *

- *

AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks - * can only be accessed or managed within the endpoint in which they are created.

- *
    - *
  • - *

    opsworks.us-east-1.amazonaws.com

    - *
  • - *
  • - *

    opsworks.us-east-2.amazonaws.com

    - *
  • - *
  • - *

    opsworks.us-west-1.amazonaws.com

    - *
  • - *
  • - *

    opsworks.us-west-2.amazonaws.com

    - *
  • - *
  • - *

    opsworks.ca-central-1.amazonaws.com (API only; not available in the AWS console)

    - *
  • - *
  • - *

    opsworks.eu-west-1.amazonaws.com

    - *
  • - *
  • - *

    opsworks.eu-west-2.amazonaws.com

    - *
  • - *
  • - *

    opsworks.eu-west-3.amazonaws.com

    - *
  • - *
  • - *

    opsworks.eu-central-1.amazonaws.com

    - *
  • - *
  • - *

    opsworks.ap-northeast-1.amazonaws.com

    - *
  • - *
  • - *

    opsworks.ap-northeast-2.amazonaws.com

    - *
  • - *
  • - *

    opsworks.ap-south-1.amazonaws.com

    - *
  • - *
  • - *

    opsworks.ap-southeast-1.amazonaws.com

    - *
  • - *
  • - *

    opsworks.ap-southeast-2.amazonaws.com

    - *
  • - *
  • - *

    opsworks.sa-east-1.amazonaws.com

    - *
  • - *
- *

- * Chef Versions - *

- *

When you call CreateStack, CloneStack, or UpdateStack we recommend you - * use the ConfigurationManager parameter to specify the Chef version. - * The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information, - * see Chef Versions.

- * - *

You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.

- *
- */ -export class OpsWorks extends OpsWorksClient { - /** - * @public - *

Assign a registered instance to a layer.

- *
    - *
  • - *

    You can assign registered on-premises instances to any layer type.

    - *
  • - *
  • - *

    You can assign registered Amazon EC2 instances only to custom layers.

    - *
  • - *
  • - *

    You cannot use this action with instances that were created with AWS OpsWorks Stacks.

    - *
  • - *
- *

- * Required Permissions: To use this action, an AWS Identity and Access Management - * (IAM) user must have a Manage permissions - * level for the stack or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public assignInstance( +const commands = { + AssignInstanceCommand, + AssignVolumeCommand, + AssociateElasticIpCommand, + AttachElasticLoadBalancerCommand, + CloneStackCommand, + CreateAppCommand, + CreateDeploymentCommand, + CreateInstanceCommand, + CreateLayerCommand, + CreateStackCommand, + CreateUserProfileCommand, + DeleteAppCommand, + DeleteInstanceCommand, + DeleteLayerCommand, + DeleteStackCommand, + DeleteUserProfileCommand, + DeregisterEcsClusterCommand, + DeregisterElasticIpCommand, + DeregisterInstanceCommand, + DeregisterRdsDbInstanceCommand, + DeregisterVolumeCommand, + DescribeAgentVersionsCommand, + DescribeAppsCommand, + DescribeCommandsCommand, + DescribeDeploymentsCommand, + DescribeEcsClustersCommand, + DescribeElasticIpsCommand, + DescribeElasticLoadBalancersCommand, + DescribeInstancesCommand, + DescribeLayersCommand, + DescribeLoadBasedAutoScalingCommand, + DescribeMyUserProfileCommand, + DescribeOperatingSystemsCommand, + DescribePermissionsCommand, + DescribeRaidArraysCommand, + DescribeRdsDbInstancesCommand, + DescribeServiceErrorsCommand, + DescribeStackProvisioningParametersCommand, + DescribeStacksCommand, + DescribeStackSummaryCommand, + DescribeTimeBasedAutoScalingCommand, + DescribeUserProfilesCommand, + DescribeVolumesCommand, + DetachElasticLoadBalancerCommand, + DisassociateElasticIpCommand, + GetHostnameSuggestionCommand, + GrantAccessCommand, + ListTagsCommand, + RebootInstanceCommand, + RegisterEcsClusterCommand, + RegisterElasticIpCommand, + RegisterInstanceCommand, + RegisterRdsDbInstanceCommand, + RegisterVolumeCommand, + SetLoadBasedAutoScalingCommand, + SetPermissionCommand, + SetTimeBasedAutoScalingCommand, + StartInstanceCommand, + StartStackCommand, + StopInstanceCommand, + StopStackCommand, + TagResourceCommand, + UnassignInstanceCommand, + UnassignVolumeCommand, + UntagResourceCommand, + UpdateAppCommand, + UpdateElasticIpCommand, + UpdateInstanceCommand, + UpdateLayerCommand, + UpdateMyUserProfileCommand, + UpdateRdsDbInstanceCommand, + UpdateStackCommand, + UpdateUserProfileCommand, + UpdateVolumeCommand, +}; + +export interface OpsWorks { + /** + * @see {@link AssignInstanceCommand} + */ + assignInstance( args: AssignInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public assignInstance( - args: AssignInstanceCommandInput, - cb: (err: any, data?: AssignInstanceCommandOutput) => void - ): void; - public assignInstance( + assignInstance(args: AssignInstanceCommandInput, cb: (err: any, data?: AssignInstanceCommandOutput) => void): void; + assignInstance( args: AssignInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssignInstanceCommandOutput) => void ): void; - public assignInstance( - args: AssignInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssignInstanceCommandOutput) => void), - cb?: (err: any, data?: AssignInstanceCommandOutput) => void - ): Promise | void { - const command = new AssignInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must - * first be registered with the stack by calling RegisterVolume. After you register the - * volume, you must call UpdateVolume to specify a mount point before calling - * AssignVolume. For more information, see Resource Management.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public assignVolume( - args: AssignVolumeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public assignVolume(args: AssignVolumeCommandInput, cb: (err: any, data?: AssignVolumeCommandOutput) => void): void; - public assignVolume( + + /** + * @see {@link AssignVolumeCommand} + */ + assignVolume(args: AssignVolumeCommandInput, options?: __HttpHandlerOptions): Promise; + assignVolume(args: AssignVolumeCommandInput, cb: (err: any, data?: AssignVolumeCommandOutput) => void): void; + assignVolume( args: AssignVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssignVolumeCommandOutput) => void ): void; - public assignVolume( - args: AssignVolumeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssignVolumeCommandOutput) => void), - cb?: (err: any, data?: AssignVolumeCommandOutput) => void - ): Promise | void { - const command = new AssignVolumeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates one of the stack's registered Elastic IP addresses with a specified instance. The - * address must first be registered with the stack by calling RegisterElasticIp. For more - * information, see Resource - * Management.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public associateElasticIp( + + /** + * @see {@link AssociateElasticIpCommand} + */ + associateElasticIp( args: AssociateElasticIpCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateElasticIp( + associateElasticIp( args: AssociateElasticIpCommandInput, cb: (err: any, data?: AssociateElasticIpCommandOutput) => void ): void; - public associateElasticIp( + associateElasticIp( args: AssociateElasticIpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateElasticIpCommandOutput) => void ): void; - public associateElasticIp( - args: AssociateElasticIpCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateElasticIpCommandOutput) => void), - cb?: (err: any, data?: AssociateElasticIpCommandOutput) => void - ): Promise | void { - const command = new AssociateElasticIpCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attaches an Elastic Load Balancing load balancer to a specified layer. AWS OpsWorks Stacks does not support - * Application Load Balancer. You can only use Classic Load Balancer with AWS OpsWorks Stacks. - * For more information, see Elastic Load - * Balancing.

- * - *

You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For - * more information, see Elastic - * Load Balancing Developer Guide.

- *
- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public attachElasticLoadBalancer( + + /** + * @see {@link AttachElasticLoadBalancerCommand} + */ + attachElasticLoadBalancer( args: AttachElasticLoadBalancerCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachElasticLoadBalancer( + attachElasticLoadBalancer( args: AttachElasticLoadBalancerCommandInput, cb: (err: any, data?: AttachElasticLoadBalancerCommandOutput) => void ): void; - public attachElasticLoadBalancer( + attachElasticLoadBalancer( args: AttachElasticLoadBalancerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachElasticLoadBalancerCommandOutput) => void ): void; - public attachElasticLoadBalancer( - args: AttachElasticLoadBalancerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachElasticLoadBalancerCommandOutput) => void), - cb?: (err: any, data?: AttachElasticLoadBalancerCommandOutput) => void - ): Promise | void { - const command = new AttachElasticLoadBalancerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a clone of a specified stack. For more information, see Clone a - * Stack. By default, all parameters are set to the values used by the parent stack.

- *

- * Required Permissions: To use this action, an IAM user must have an attached policy - * that explicitly grants permissions. For more information about user permissions, see Managing User - * Permissions.

- */ - public cloneStack(args: CloneStackCommandInput, options?: __HttpHandlerOptions): Promise; - public cloneStack(args: CloneStackCommandInput, cb: (err: any, data?: CloneStackCommandOutput) => void): void; - public cloneStack( + + /** + * @see {@link CloneStackCommand} + */ + cloneStack(args: CloneStackCommandInput, options?: __HttpHandlerOptions): Promise; + cloneStack(args: CloneStackCommandInput, cb: (err: any, data?: CloneStackCommandOutput) => void): void; + cloneStack( args: CloneStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CloneStackCommandOutput) => void ): void; - public cloneStack( - args: CloneStackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CloneStackCommandOutput) => void), - cb?: (err: any, data?: CloneStackCommandOutput) => void - ): Promise | void { - const command = new CloneStackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an app for a specified stack. For more information, see Creating - * Apps.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public createApp(args: CreateAppCommandInput, options?: __HttpHandlerOptions): Promise; - public createApp(args: CreateAppCommandInput, cb: (err: any, data?: CreateAppCommandOutput) => void): void; - public createApp( + + /** + * @see {@link CreateAppCommand} + */ + createApp(args: CreateAppCommandInput, options?: __HttpHandlerOptions): Promise; + createApp(args: CreateAppCommandInput, cb: (err: any, data?: CreateAppCommandOutput) => void): void; + createApp( args: CreateAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppCommandOutput) => void ): void; - public createApp( - args: CreateAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAppCommandOutput) => void), - cb?: (err: any, data?: CreateAppCommandOutput) => void - ): Promise | void { - const command = new CreateAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Runs deployment or stack commands. For more information, see Deploying - * Apps and Run Stack Commands.

- *

- * Required Permissions: To use this action, an IAM user must have a Deploy or Manage - * permissions level for the stack, or an attached policy that explicitly grants permissions. For - * more information on user permissions, see Managing User - * Permissions.

- */ - public createDeployment( + + /** + * @see {@link CreateDeploymentCommand} + */ + createDeployment( args: CreateDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDeployment( + createDeployment( args: CreateDeploymentCommandInput, cb: (err: any, data?: CreateDeploymentCommandOutput) => void ): void; - public createDeployment( + createDeployment( args: CreateDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeploymentCommandOutput) => void ): void; - public createDeployment( - args: CreateDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDeploymentCommandOutput) => void), - cb?: (err: any, data?: CreateDeploymentCommandOutput) => void - ): Promise | void { - const command = new CreateDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an instance in a specified stack. For more information, see Adding an - * Instance to a Layer.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public createInstance( + + /** + * @see {@link CreateInstanceCommand} + */ + createInstance( args: CreateInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createInstance( - args: CreateInstanceCommandInput, - cb: (err: any, data?: CreateInstanceCommandOutput) => void - ): void; - public createInstance( + createInstance(args: CreateInstanceCommandInput, cb: (err: any, data?: CreateInstanceCommandOutput) => void): void; + createInstance( args: CreateInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInstanceCommandOutput) => void ): void; - public createInstance( - args: CreateInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateInstanceCommandOutput) => void), - cb?: (err: any, data?: CreateInstanceCommandOutput) => void - ): Promise | void { - const command = new CreateInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a layer. For more information, see How to - * Create a Layer.

- * - *

You should use CreateLayer for noncustom layer types such as PHP App Server only if the stack - * does not have an existing layer of that type. A stack can have at most one instance of each - * noncustom layer; if you attempt to create a second instance, CreateLayer fails. A - * stack can have an arbitrary number of custom layers, so you can call CreateLayer as - * many times as you like for that layer type.

- *
- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public createLayer(args: CreateLayerCommandInput, options?: __HttpHandlerOptions): Promise; - public createLayer(args: CreateLayerCommandInput, cb: (err: any, data?: CreateLayerCommandOutput) => void): void; - public createLayer( + + /** + * @see {@link CreateLayerCommand} + */ + createLayer(args: CreateLayerCommandInput, options?: __HttpHandlerOptions): Promise; + createLayer(args: CreateLayerCommandInput, cb: (err: any, data?: CreateLayerCommandOutput) => void): void; + createLayer( args: CreateLayerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLayerCommandOutput) => void ): void; - public createLayer( - args: CreateLayerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLayerCommandOutput) => void), - cb?: (err: any, data?: CreateLayerCommandOutput) => void - ): Promise | void { - const command = new CreateLayerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new stack. For more information, see Create a New - * Stack.

- *

- * Required Permissions: To use this action, an IAM user must have an attached policy - * that explicitly grants permissions. For more information about user permissions, see Managing User - * Permissions.

- */ - public createStack(args: CreateStackCommandInput, options?: __HttpHandlerOptions): Promise; - public createStack(args: CreateStackCommandInput, cb: (err: any, data?: CreateStackCommandOutput) => void): void; - public createStack( + + /** + * @see {@link CreateStackCommand} + */ + createStack(args: CreateStackCommandInput, options?: __HttpHandlerOptions): Promise; + createStack(args: CreateStackCommandInput, cb: (err: any, data?: CreateStackCommandOutput) => void): void; + createStack( args: CreateStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStackCommandOutput) => void ): void; - public createStack( - args: CreateStackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStackCommandOutput) => void), - cb?: (err: any, data?: CreateStackCommandOutput) => void - ): Promise | void { - const command = new CreateStackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new user profile.

- *

- * Required Permissions: To use this action, an IAM user must have an attached policy - * that explicitly grants permissions. For more information about user permissions, see Managing User - * Permissions.

- */ - public createUserProfile( + + /** + * @see {@link CreateUserProfileCommand} + */ + createUserProfile( args: CreateUserProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public createUserProfile( + createUserProfile( args: CreateUserProfileCommandInput, cb: (err: any, data?: CreateUserProfileCommandOutput) => void ): void; - public createUserProfile( + createUserProfile( args: CreateUserProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserProfileCommandOutput) => void ): void; - public createUserProfile( - args: CreateUserProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserProfileCommandOutput) => void), - cb?: (err: any, data?: CreateUserProfileCommandOutput) => void - ): Promise | void { - const command = new CreateUserProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specified app.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public deleteApp(args: DeleteAppCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteApp(args: DeleteAppCommandInput, cb: (err: any, data?: DeleteAppCommandOutput) => void): void; - public deleteApp( + + /** + * @see {@link DeleteAppCommand} + */ + deleteApp(args: DeleteAppCommandInput, options?: __HttpHandlerOptions): Promise; + deleteApp(args: DeleteAppCommandInput, cb: (err: any, data?: DeleteAppCommandOutput) => void): void; + deleteApp( args: DeleteAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppCommandOutput) => void ): void; - public deleteApp( - args: DeleteAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppCommandOutput) => void), - cb?: (err: any, data?: DeleteAppCommandOutput) => void - ): Promise | void { - const command = new DeleteAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it.

- *

For more information, see Deleting - * Instances.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public deleteInstance( + + /** + * @see {@link DeleteInstanceCommand} + */ + deleteInstance( args: DeleteInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInstance( - args: DeleteInstanceCommandInput, - cb: (err: any, data?: DeleteInstanceCommandOutput) => void - ): void; - public deleteInstance( + deleteInstance(args: DeleteInstanceCommandInput, cb: (err: any, data?: DeleteInstanceCommandOutput) => void): void; + deleteInstance( args: DeleteInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInstanceCommandOutput) => void ): void; - public deleteInstance( - args: DeleteInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInstanceCommandOutput) => void), - cb?: (err: any, data?: DeleteInstanceCommandOutput) => void - ): Promise | void { - const command = new DeleteInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specified layer. You must first stop and then delete all associated instances or - * unassign registered instances. For more information, see How to - * Delete a Layer.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public deleteLayer(args: DeleteLayerCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteLayer(args: DeleteLayerCommandInput, cb: (err: any, data?: DeleteLayerCommandOutput) => void): void; - public deleteLayer( + + /** + * @see {@link DeleteLayerCommand} + */ + deleteLayer(args: DeleteLayerCommandInput, options?: __HttpHandlerOptions): Promise; + deleteLayer(args: DeleteLayerCommandInput, cb: (err: any, data?: DeleteLayerCommandOutput) => void): void; + deleteLayer( args: DeleteLayerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLayerCommandOutput) => void ): void; - public deleteLayer( - args: DeleteLayerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLayerCommandOutput) => void), - cb?: (err: any, data?: DeleteLayerCommandOutput) => void - ): Promise | void { - const command = new DeleteLayerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specified stack. You must first delete all instances, layers, and apps or - * deregister registered instances. For more information, see Shut Down a - * Stack.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public deleteStack(args: DeleteStackCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteStack(args: DeleteStackCommandInput, cb: (err: any, data?: DeleteStackCommandOutput) => void): void; - public deleteStack( + + /** + * @see {@link DeleteStackCommand} + */ + deleteStack(args: DeleteStackCommandInput, options?: __HttpHandlerOptions): Promise; + deleteStack(args: DeleteStackCommandInput, cb: (err: any, data?: DeleteStackCommandOutput) => void): void; + deleteStack( args: DeleteStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStackCommandOutput) => void ): void; - public deleteStack( - args: DeleteStackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStackCommandOutput) => void), - cb?: (err: any, data?: DeleteStackCommandOutput) => void - ): Promise | void { - const command = new DeleteStackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a user profile.

- *

- * Required Permissions: To use this action, an IAM user must have an attached policy - * that explicitly grants permissions. For more information about user permissions, see Managing User - * Permissions.

- */ - public deleteUserProfile( + + /** + * @see {@link DeleteUserProfileCommand} + */ + deleteUserProfile( args: DeleteUserProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteUserProfile( + deleteUserProfile( args: DeleteUserProfileCommandInput, cb: (err: any, data?: DeleteUserProfileCommandOutput) => void ): void; - public deleteUserProfile( + deleteUserProfile( args: DeleteUserProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserProfileCommandOutput) => void ): void; - public deleteUserProfile( - args: DeleteUserProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteUserProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteUserProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deregisters a specified Amazon ECS cluster from a stack. - * For more information, see - * - * Resource Management.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack or an attached policy that explicitly grants permissions. For more - * information on user permissions, see - * https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.

- */ - public deregisterEcsCluster( + + /** + * @see {@link DeregisterEcsClusterCommand} + */ + deregisterEcsCluster( args: DeregisterEcsClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterEcsCluster( + deregisterEcsCluster( args: DeregisterEcsClusterCommandInput, cb: (err: any, data?: DeregisterEcsClusterCommandOutput) => void ): void; - public deregisterEcsCluster( + deregisterEcsCluster( args: DeregisterEcsClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterEcsClusterCommandOutput) => void ): void; - public deregisterEcsCluster( - args: DeregisterEcsClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterEcsClusterCommandOutput) => void), - cb?: (err: any, data?: DeregisterEcsClusterCommandOutput) => void - ): Promise | void { - const command = new DeregisterEcsClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deregisters a specified Elastic IP address. The address can then be registered by another - * stack. For more information, see Resource Management.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public deregisterElasticIp( + + /** + * @see {@link DeregisterElasticIpCommand} + */ + deregisterElasticIp( args: DeregisterElasticIpCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterElasticIp( + deregisterElasticIp( args: DeregisterElasticIpCommandInput, cb: (err: any, data?: DeregisterElasticIpCommandOutput) => void ): void; - public deregisterElasticIp( + deregisterElasticIp( args: DeregisterElasticIpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterElasticIpCommandOutput) => void ): void; - public deregisterElasticIp( - args: DeregisterElasticIpCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterElasticIpCommandOutput) => void), - cb?: (err: any, data?: DeregisterElasticIpCommandOutput) => void - ): Promise | void { - const command = new DeregisterElasticIpCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deregister a registered Amazon EC2 or on-premises instance. This action removes the - * instance from the stack and returns it to your control. This action cannot be used with - * instances that were created with AWS OpsWorks Stacks.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public deregisterInstance( + + /** + * @see {@link DeregisterInstanceCommand} + */ + deregisterInstance( args: DeregisterInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterInstance( + deregisterInstance( args: DeregisterInstanceCommandInput, cb: (err: any, data?: DeregisterInstanceCommandOutput) => void ): void; - public deregisterInstance( + deregisterInstance( args: DeregisterInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterInstanceCommandOutput) => void ): void; - public deregisterInstance( - args: DeregisterInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterInstanceCommandOutput) => void), - cb?: (err: any, data?: DeregisterInstanceCommandOutput) => void - ): Promise | void { - const command = new DeregisterInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deregisters an Amazon RDS instance.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public deregisterRdsDbInstance( + + /** + * @see {@link DeregisterRdsDbInstanceCommand} + */ + deregisterRdsDbInstance( args: DeregisterRdsDbInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterRdsDbInstance( + deregisterRdsDbInstance( args: DeregisterRdsDbInstanceCommandInput, cb: (err: any, data?: DeregisterRdsDbInstanceCommandOutput) => void ): void; - public deregisterRdsDbInstance( + deregisterRdsDbInstance( args: DeregisterRdsDbInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterRdsDbInstanceCommandOutput) => void ): void; - public deregisterRdsDbInstance( - args: DeregisterRdsDbInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterRdsDbInstanceCommandOutput) => void), - cb?: (err: any, data?: DeregisterRdsDbInstanceCommandOutput) => void - ): Promise | void { - const command = new DeregisterRdsDbInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more - * information, see Resource - * Management.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public deregisterVolume( + + /** + * @see {@link DeregisterVolumeCommand} + */ + deregisterVolume( args: DeregisterVolumeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterVolume( + deregisterVolume( args: DeregisterVolumeCommandInput, cb: (err: any, data?: DeregisterVolumeCommandOutput) => void ): void; - public deregisterVolume( + deregisterVolume( args: DeregisterVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterVolumeCommandOutput) => void ): void; - public deregisterVolume( - args: DeregisterVolumeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterVolumeCommandOutput) => void), - cb?: (err: any, data?: DeregisterVolumeCommandOutput) => void - ): Promise | void { - const command = new DeregisterVolumeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the available AWS OpsWorks Stacks agent versions. You must specify a stack ID or a - * configuration manager. DescribeAgentVersions returns a list of available - * agent versions for the specified stack or configuration manager.

- */ - public describeAgentVersions( + + /** + * @see {@link DescribeAgentVersionsCommand} + */ + describeAgentVersions( args: DescribeAgentVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAgentVersions( + describeAgentVersions( args: DescribeAgentVersionsCommandInput, cb: (err: any, data?: DescribeAgentVersionsCommandOutput) => void ): void; - public describeAgentVersions( + describeAgentVersions( args: DescribeAgentVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAgentVersionsCommandOutput) => void ): void; - public describeAgentVersions( - args: DescribeAgentVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAgentVersionsCommandOutput) => void), - cb?: (err: any, data?: DescribeAgentVersionsCommandOutput) => void - ): Promise | void { - const command = new DescribeAgentVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Requests a description of a specified set of apps.

- * - *

This call accepts only one resource-identifying parameter.

- *
- *

- * Required Permissions: To use this action, an IAM user must have a Show, Deploy, or - * Manage permissions level for the stack, or an attached policy that explicitly grants - * permissions. For more information about user permissions, see Managing User - * Permissions.

- */ - public describeApps( - args: DescribeAppsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeApps(args: DescribeAppsCommandInput, cb: (err: any, data?: DescribeAppsCommandOutput) => void): void; - public describeApps( + + /** + * @see {@link DescribeAppsCommand} + */ + describeApps(args: DescribeAppsCommandInput, options?: __HttpHandlerOptions): Promise; + describeApps(args: DescribeAppsCommandInput, cb: (err: any, data?: DescribeAppsCommandOutput) => void): void; + describeApps( args: DescribeAppsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppsCommandOutput) => void ): void; - public describeApps( - args: DescribeAppsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAppsCommandOutput) => void), - cb?: (err: any, data?: DescribeAppsCommandOutput) => void - ): Promise | void { - const command = new DescribeAppsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the results of specified commands.

- * - *

This call accepts only one resource-identifying parameter.

- *
- *

- * Required Permissions: To use this action, an IAM user must have a Show, Deploy, or - * Manage permissions level for the stack, or an attached policy that explicitly grants - * permissions. For more information about user permissions, see Managing User - * Permissions.

- */ - public describeCommands( + + /** + * @see {@link DescribeCommandsCommand} + */ + describeCommands( args: DescribeCommandsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCommands( + describeCommands( args: DescribeCommandsCommandInput, cb: (err: any, data?: DescribeCommandsCommandOutput) => void ): void; - public describeCommands( + describeCommands( args: DescribeCommandsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCommandsCommandOutput) => void ): void; - public describeCommands( - args: DescribeCommandsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCommandsCommandOutput) => void), - cb?: (err: any, data?: DescribeCommandsCommandOutput) => void - ): Promise | void { - const command = new DescribeCommandsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Requests a description of a specified set of deployments.

- * - *

This call accepts only one resource-identifying parameter.

- *
- *

- * Required Permissions: To use this action, an IAM user must have a Show, Deploy, or - * Manage permissions level for the stack, or an attached policy that explicitly grants - * permissions. For more information about user permissions, see Managing User - * Permissions.

- */ - public describeDeployments( + + /** + * @see {@link DescribeDeploymentsCommand} + */ + describeDeployments( args: DescribeDeploymentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDeployments( + describeDeployments( args: DescribeDeploymentsCommandInput, cb: (err: any, data?: DescribeDeploymentsCommandOutput) => void ): void; - public describeDeployments( + describeDeployments( args: DescribeDeploymentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDeploymentsCommandOutput) => void ): void; - public describeDeployments( - args: DescribeDeploymentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDeploymentsCommandOutput) => void), - cb?: (err: any, data?: DescribeDeploymentsCommandOutput) => void - ): Promise | void { - const command = new DescribeDeploymentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, - * you can use the MaxResults and NextToken parameters to paginate the - * response. However, AWS OpsWorks Stacks currently supports only one cluster per layer, so the result - * set has a maximum of one element.

- *

- * Required Permissions: To use this action, an IAM user must have a Show, Deploy, or - * Manage permissions level for the stack or an attached policy that explicitly grants - * permission. For more information about user permissions, see Managing User - * Permissions.

- *

This call accepts only one resource-identifying parameter.

- */ - public describeEcsClusters( + + /** + * @see {@link DescribeEcsClustersCommand} + */ + describeEcsClusters( args: DescribeEcsClustersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEcsClusters( + describeEcsClusters( args: DescribeEcsClustersCommandInput, cb: (err: any, data?: DescribeEcsClustersCommandOutput) => void ): void; - public describeEcsClusters( + describeEcsClusters( args: DescribeEcsClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEcsClustersCommandOutput) => void ): void; - public describeEcsClusters( - args: DescribeEcsClustersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEcsClustersCommandOutput) => void), - cb?: (err: any, data?: DescribeEcsClustersCommandOutput) => void - ): Promise | void { - const command = new DescribeEcsClustersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes Elastic IP addresses.

- * - *

This call accepts only one resource-identifying parameter.

- *
- *

- * Required Permissions: To use this action, an IAM user must have a Show, Deploy, or - * Manage permissions level for the stack, or an attached policy that explicitly grants - * permissions. For more information about user permissions, see Managing User - * Permissions.

- */ - public describeElasticIps( + + /** + * @see {@link DescribeElasticIpsCommand} + */ + describeElasticIps( args: DescribeElasticIpsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeElasticIps( + describeElasticIps( args: DescribeElasticIpsCommandInput, cb: (err: any, data?: DescribeElasticIpsCommandOutput) => void ): void; - public describeElasticIps( + describeElasticIps( args: DescribeElasticIpsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeElasticIpsCommandOutput) => void ): void; - public describeElasticIps( - args: DescribeElasticIpsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeElasticIpsCommandOutput) => void), - cb?: (err: any, data?: DescribeElasticIpsCommandOutput) => void - ): Promise | void { - const command = new DescribeElasticIpsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a stack's Elastic Load Balancing instances.

- * - *

This call accepts only one resource-identifying parameter.

- *
- *

- * Required Permissions: To use this action, an IAM user must have a Show, Deploy, or - * Manage permissions level for the stack, or an attached policy that explicitly grants - * permissions. For more information about user permissions, see Managing User - * Permissions.

- */ - public describeElasticLoadBalancers( + + /** + * @see {@link DescribeElasticLoadBalancersCommand} + */ + describeElasticLoadBalancers( args: DescribeElasticLoadBalancersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeElasticLoadBalancers( + describeElasticLoadBalancers( args: DescribeElasticLoadBalancersCommandInput, cb: (err: any, data?: DescribeElasticLoadBalancersCommandOutput) => void ): void; - public describeElasticLoadBalancers( + describeElasticLoadBalancers( args: DescribeElasticLoadBalancersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeElasticLoadBalancersCommandOutput) => void ): void; - public describeElasticLoadBalancers( - args: DescribeElasticLoadBalancersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeElasticLoadBalancersCommandOutput) => void), - cb?: (err: any, data?: DescribeElasticLoadBalancersCommandOutput) => void - ): Promise | void { - const command = new DescribeElasticLoadBalancersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Requests a description of a set of instances.

- * - *

This call accepts only one resource-identifying parameter.

- *
- *

- * Required Permissions: To use this action, an IAM user must have a Show, Deploy, or - * Manage permissions level for the stack, or an attached policy that explicitly grants - * permissions. For more information about user permissions, see Managing User - * Permissions.

- */ - public describeInstances( + + /** + * @see {@link DescribeInstancesCommand} + */ + describeInstances( args: DescribeInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInstances( + describeInstances( args: DescribeInstancesCommandInput, cb: (err: any, data?: DescribeInstancesCommandOutput) => void ): void; - public describeInstances( + describeInstances( args: DescribeInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstancesCommandOutput) => void ): void; - public describeInstances( - args: DescribeInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInstancesCommandOutput) => void), - cb?: (err: any, data?: DescribeInstancesCommandOutput) => void - ): Promise | void { - const command = new DescribeInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Requests a description of one or more layers in a specified stack.

- * - *

This call accepts only one resource-identifying parameter.

- *
- *

- * Required Permissions: To use this action, an IAM user must have a Show, Deploy, or - * Manage permissions level for the stack, or an attached policy that explicitly grants - * permissions. For more information about user permissions, see Managing User - * Permissions.

- */ - public describeLayers( + + /** + * @see {@link DescribeLayersCommand} + */ + describeLayers( args: DescribeLayersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLayers( - args: DescribeLayersCommandInput, - cb: (err: any, data?: DescribeLayersCommandOutput) => void - ): void; - public describeLayers( + describeLayers(args: DescribeLayersCommandInput, cb: (err: any, data?: DescribeLayersCommandOutput) => void): void; + describeLayers( args: DescribeLayersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLayersCommandOutput) => void ): void; - public describeLayers( - args: DescribeLayersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLayersCommandOutput) => void), - cb?: (err: any, data?: DescribeLayersCommandOutput) => void - ): Promise | void { - const command = new DescribeLayersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes load-based auto scaling configurations for specified layers.

- * - *

You must specify at least one of the parameters.

- *
- *

- * Required Permissions: To use this action, an IAM user must have a Show, Deploy, or - * Manage permissions level for the stack, or an attached policy that explicitly grants - * permissions. For more information about user permissions, see Managing User - * Permissions.

- */ - public describeLoadBasedAutoScaling( + + /** + * @see {@link DescribeLoadBasedAutoScalingCommand} + */ + describeLoadBasedAutoScaling( args: DescribeLoadBasedAutoScalingCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLoadBasedAutoScaling( + describeLoadBasedAutoScaling( args: DescribeLoadBasedAutoScalingCommandInput, cb: (err: any, data?: DescribeLoadBasedAutoScalingCommandOutput) => void ): void; - public describeLoadBasedAutoScaling( + describeLoadBasedAutoScaling( args: DescribeLoadBasedAutoScalingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLoadBasedAutoScalingCommandOutput) => void ): void; - public describeLoadBasedAutoScaling( - args: DescribeLoadBasedAutoScalingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLoadBasedAutoScalingCommandOutput) => void), - cb?: (err: any, data?: DescribeLoadBasedAutoScalingCommandOutput) => void - ): Promise | void { - const command = new DescribeLoadBasedAutoScalingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a user's SSH information.

- *

- * Required Permissions: To use this action, an IAM user must have self-management - * enabled or an attached policy that explicitly grants permissions. For more information about user - * permissions, see Managing User - * Permissions.

- */ - public describeMyUserProfile( + + /** + * @see {@link DescribeMyUserProfileCommand} + */ + describeMyUserProfile( args: DescribeMyUserProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMyUserProfile( + describeMyUserProfile( args: DescribeMyUserProfileCommandInput, cb: (err: any, data?: DescribeMyUserProfileCommandOutput) => void ): void; - public describeMyUserProfile( + describeMyUserProfile( args: DescribeMyUserProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMyUserProfileCommandOutput) => void ): void; - public describeMyUserProfile( - args: DescribeMyUserProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMyUserProfileCommandOutput) => void), - cb?: (err: any, data?: DescribeMyUserProfileCommandOutput) => void - ): Promise | void { - const command = new DescribeMyUserProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the operating systems that are supported by AWS OpsWorks Stacks.

- */ - public describeOperatingSystems( + + /** + * @see {@link DescribeOperatingSystemsCommand} + */ + describeOperatingSystems( args: DescribeOperatingSystemsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOperatingSystems( + describeOperatingSystems( args: DescribeOperatingSystemsCommandInput, cb: (err: any, data?: DescribeOperatingSystemsCommandOutput) => void ): void; - public describeOperatingSystems( + describeOperatingSystems( args: DescribeOperatingSystemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOperatingSystemsCommandOutput) => void ): void; - public describeOperatingSystems( - args: DescribeOperatingSystemsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOperatingSystemsCommandOutput) => void), - cb?: (err: any, data?: DescribeOperatingSystemsCommandOutput) => void - ): Promise | void { - const command = new DescribeOperatingSystemsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the permissions for a specified stack.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public describePermissions( + + /** + * @see {@link DescribePermissionsCommand} + */ + describePermissions( args: DescribePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePermissions( + describePermissions( args: DescribePermissionsCommandInput, cb: (err: any, data?: DescribePermissionsCommandOutput) => void ): void; - public describePermissions( + describePermissions( args: DescribePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePermissionsCommandOutput) => void ): void; - public describePermissions( - args: DescribePermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePermissionsCommandOutput) => void), - cb?: (err: any, data?: DescribePermissionsCommandOutput) => void - ): Promise | void { - const command = new DescribePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describe an instance's RAID arrays.

- * - *

This call accepts only one resource-identifying parameter.

- *
- *

- * Required Permissions: To use this action, an IAM user must have a Show, Deploy, or - * Manage permissions level for the stack, or an attached policy that explicitly grants - * permissions. For more information about user permissions, see Managing User - * Permissions.

- */ - public describeRaidArrays( + + /** + * @see {@link DescribeRaidArraysCommand} + */ + describeRaidArrays( args: DescribeRaidArraysCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRaidArrays( + describeRaidArrays( args: DescribeRaidArraysCommandInput, cb: (err: any, data?: DescribeRaidArraysCommandOutput) => void ): void; - public describeRaidArrays( + describeRaidArrays( args: DescribeRaidArraysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRaidArraysCommandOutput) => void ): void; - public describeRaidArrays( - args: DescribeRaidArraysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRaidArraysCommandOutput) => void), - cb?: (err: any, data?: DescribeRaidArraysCommandOutput) => void - ): Promise | void { - const command = new DescribeRaidArraysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes Amazon RDS instances.

- *

- * Required Permissions: To use this action, an IAM user must have a Show, Deploy, or - * Manage permissions level for the stack, or an attached policy that explicitly grants - * permissions. For more information about user permissions, see Managing User - * Permissions.

- *

This call accepts only one resource-identifying parameter.

- */ - public describeRdsDbInstances( + + /** + * @see {@link DescribeRdsDbInstancesCommand} + */ + describeRdsDbInstances( args: DescribeRdsDbInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRdsDbInstances( + describeRdsDbInstances( args: DescribeRdsDbInstancesCommandInput, cb: (err: any, data?: DescribeRdsDbInstancesCommandOutput) => void ): void; - public describeRdsDbInstances( + describeRdsDbInstances( args: DescribeRdsDbInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRdsDbInstancesCommandOutput) => void ): void; - public describeRdsDbInstances( - args: DescribeRdsDbInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRdsDbInstancesCommandOutput) => void), - cb?: (err: any, data?: DescribeRdsDbInstancesCommandOutput) => void - ): Promise | void { - const command = new DescribeRdsDbInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes AWS OpsWorks Stacks service errors.

- *

- * Required Permissions: To use this action, an IAM user must have a Show, Deploy, or - * Manage permissions level for the stack, or an attached policy that explicitly grants - * permissions. For more information about user permissions, see Managing User - * Permissions.

- *

This call accepts only one resource-identifying parameter.

- */ - public describeServiceErrors( + + /** + * @see {@link DescribeServiceErrorsCommand} + */ + describeServiceErrors( args: DescribeServiceErrorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeServiceErrors( + describeServiceErrors( args: DescribeServiceErrorsCommandInput, cb: (err: any, data?: DescribeServiceErrorsCommandOutput) => void ): void; - public describeServiceErrors( + describeServiceErrors( args: DescribeServiceErrorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeServiceErrorsCommandOutput) => void ): void; - public describeServiceErrors( - args: DescribeServiceErrorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeServiceErrorsCommandOutput) => void), - cb?: (err: any, data?: DescribeServiceErrorsCommandOutput) => void - ): Promise | void { - const command = new DescribeServiceErrorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Requests a description of a stack's provisioning parameters.

- *

- * Required Permissions: To use this action, an IAM user must have a Show, Deploy, or - * Manage permissions level for the stack or an attached policy that explicitly grants - * permissions. For more information about user permissions, see Managing User - * Permissions.

- */ - public describeStackProvisioningParameters( + + /** + * @see {@link DescribeStackProvisioningParametersCommand} + */ + describeStackProvisioningParameters( args: DescribeStackProvisioningParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStackProvisioningParameters( + describeStackProvisioningParameters( args: DescribeStackProvisioningParametersCommandInput, cb: (err: any, data?: DescribeStackProvisioningParametersCommandOutput) => void ): void; - public describeStackProvisioningParameters( + describeStackProvisioningParameters( args: DescribeStackProvisioningParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStackProvisioningParametersCommandOutput) => void ): void; - public describeStackProvisioningParameters( - args: DescribeStackProvisioningParametersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStackProvisioningParametersCommandOutput) => void), - cb?: (err: any, data?: DescribeStackProvisioningParametersCommandOutput) => void - ): Promise | void { - const command = new DescribeStackProvisioningParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Requests a description of one or more stacks.

- *

- * Required Permissions: To use this action, an IAM user must have a Show, Deploy, or - * Manage permissions level for the stack, or an attached policy that explicitly grants - * permissions. For more information about user permissions, see Managing User - * Permissions.

- */ - public describeStacks( + + /** + * @see {@link DescribeStacksCommand} + */ + describeStacks( args: DescribeStacksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStacks( - args: DescribeStacksCommandInput, - cb: (err: any, data?: DescribeStacksCommandOutput) => void - ): void; - public describeStacks( + describeStacks(args: DescribeStacksCommandInput, cb: (err: any, data?: DescribeStacksCommandOutput) => void): void; + describeStacks( args: DescribeStacksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStacksCommandOutput) => void ): void; - public describeStacks( - args: DescribeStacksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStacksCommandOutput) => void), - cb?: (err: any, data?: DescribeStacksCommandOutput) => void - ): Promise | void { - const command = new DescribeStacksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the number of layers and apps in a specified stack, and the number of instances in - * each state, such as running_setup or online.

- *

- * Required Permissions: To use this action, an IAM user must have a Show, Deploy, or - * Manage permissions level for the stack, or an attached policy that explicitly grants - * permissions. For more information about user permissions, see Managing User - * Permissions.

- */ - public describeStackSummary( + + /** + * @see {@link DescribeStackSummaryCommand} + */ + describeStackSummary( args: DescribeStackSummaryCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStackSummary( + describeStackSummary( args: DescribeStackSummaryCommandInput, cb: (err: any, data?: DescribeStackSummaryCommandOutput) => void ): void; - public describeStackSummary( + describeStackSummary( args: DescribeStackSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStackSummaryCommandOutput) => void ): void; - public describeStackSummary( - args: DescribeStackSummaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStackSummaryCommandOutput) => void), - cb?: (err: any, data?: DescribeStackSummaryCommandOutput) => void - ): Promise | void { - const command = new DescribeStackSummaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes time-based auto scaling configurations for specified instances.

- * - *

You must specify at least one of the parameters.

- *
- *

- * Required Permissions: To use this action, an IAM user must have a Show, Deploy, or - * Manage permissions level for the stack, or an attached policy that explicitly grants - * permissions. For more information about user permissions, see Managing User - * Permissions.

- */ - public describeTimeBasedAutoScaling( + + /** + * @see {@link DescribeTimeBasedAutoScalingCommand} + */ + describeTimeBasedAutoScaling( args: DescribeTimeBasedAutoScalingCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTimeBasedAutoScaling( + describeTimeBasedAutoScaling( args: DescribeTimeBasedAutoScalingCommandInput, cb: (err: any, data?: DescribeTimeBasedAutoScalingCommandOutput) => void ): void; - public describeTimeBasedAutoScaling( + describeTimeBasedAutoScaling( args: DescribeTimeBasedAutoScalingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTimeBasedAutoScalingCommandOutput) => void ): void; - public describeTimeBasedAutoScaling( - args: DescribeTimeBasedAutoScalingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTimeBasedAutoScalingCommandOutput) => void), - cb?: (err: any, data?: DescribeTimeBasedAutoScalingCommandOutput) => void - ): Promise | void { - const command = new DescribeTimeBasedAutoScalingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describe specified users.

- *

- * Required Permissions: To use this action, an IAM user must have an attached policy - * that explicitly grants permissions. For more information about user permissions, see Managing User - * Permissions.

- */ - public describeUserProfiles( + + /** + * @see {@link DescribeUserProfilesCommand} + */ + describeUserProfiles( args: DescribeUserProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeUserProfiles( + describeUserProfiles( args: DescribeUserProfilesCommandInput, cb: (err: any, data?: DescribeUserProfilesCommandOutput) => void ): void; - public describeUserProfiles( + describeUserProfiles( args: DescribeUserProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserProfilesCommandOutput) => void ): void; - public describeUserProfiles( - args: DescribeUserProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUserProfilesCommandOutput) => void), - cb?: (err: any, data?: DescribeUserProfilesCommandOutput) => void - ): Promise | void { - const command = new DescribeUserProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes an instance's Amazon EBS volumes.

- * - *

This call accepts only one resource-identifying parameter.

- *
- *

- * Required Permissions: To use this action, an IAM user must have a Show, Deploy, or - * Manage permissions level for the stack, or an attached policy that explicitly grants - * permissions. For more information about user permissions, see Managing User - * Permissions.

- */ - public describeVolumes( + + /** + * @see {@link DescribeVolumesCommand} + */ + describeVolumes( args: DescribeVolumesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVolumes( - args: DescribeVolumesCommandInput, - cb: (err: any, data?: DescribeVolumesCommandOutput) => void - ): void; - public describeVolumes( + describeVolumes(args: DescribeVolumesCommandInput, cb: (err: any, data?: DescribeVolumesCommandOutput) => void): void; + describeVolumes( args: DescribeVolumesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVolumesCommandOutput) => void ): void; - public describeVolumes( - args: DescribeVolumesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVolumesCommandOutput) => void), - cb?: (err: any, data?: DescribeVolumesCommandOutput) => void - ): Promise | void { - const command = new DescribeVolumesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detaches a specified Elastic Load Balancing instance from its layer.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public detachElasticLoadBalancer( + + /** + * @see {@link DetachElasticLoadBalancerCommand} + */ + detachElasticLoadBalancer( args: DetachElasticLoadBalancerCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachElasticLoadBalancer( + detachElasticLoadBalancer( args: DetachElasticLoadBalancerCommandInput, cb: (err: any, data?: DetachElasticLoadBalancerCommandOutput) => void ): void; - public detachElasticLoadBalancer( + detachElasticLoadBalancer( args: DetachElasticLoadBalancerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachElasticLoadBalancerCommandOutput) => void ): void; - public detachElasticLoadBalancer( - args: DetachElasticLoadBalancerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachElasticLoadBalancerCommandOutput) => void), - cb?: (err: any, data?: DetachElasticLoadBalancerCommandOutput) => void - ): Promise | void { - const command = new DetachElasticLoadBalancerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates an Elastic IP address from its instance. The address remains registered with - * the stack. For more information, see Resource Management.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public disassociateElasticIp( + + /** + * @see {@link DisassociateElasticIpCommand} + */ + disassociateElasticIp( args: DisassociateElasticIpCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateElasticIp( + disassociateElasticIp( args: DisassociateElasticIpCommandInput, cb: (err: any, data?: DisassociateElasticIpCommandOutput) => void ): void; - public disassociateElasticIp( + disassociateElasticIp( args: DisassociateElasticIpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateElasticIpCommandOutput) => void ): void; - public disassociateElasticIp( - args: DisassociateElasticIpCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateElasticIpCommandOutput) => void), - cb?: (err: any, data?: DisassociateElasticIpCommandOutput) => void - ): Promise | void { - const command = new DisassociateElasticIpCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a generated host name for the specified layer, based on the current host name theme.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public getHostnameSuggestion( + + /** + * @see {@link GetHostnameSuggestionCommand} + */ + getHostnameSuggestion( args: GetHostnameSuggestionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getHostnameSuggestion( + getHostnameSuggestion( args: GetHostnameSuggestionCommandInput, cb: (err: any, data?: GetHostnameSuggestionCommandOutput) => void ): void; - public getHostnameSuggestion( + getHostnameSuggestion( args: GetHostnameSuggestionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHostnameSuggestionCommandOutput) => void ): void; - public getHostnameSuggestion( - args: GetHostnameSuggestionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetHostnameSuggestionCommandOutput) => void), - cb?: (err: any, data?: GetHostnameSuggestionCommandOutput) => void - ): Promise | void { - const command = new GetHostnameSuggestionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This action can be used only with Windows stacks.

- *
- *

Grants RDP access to a Windows instance for a specified time period.

- */ - public grantAccess(args: GrantAccessCommandInput, options?: __HttpHandlerOptions): Promise; - public grantAccess(args: GrantAccessCommandInput, cb: (err: any, data?: GrantAccessCommandOutput) => void): void; - public grantAccess( + + /** + * @see {@link GrantAccessCommand} + */ + grantAccess(args: GrantAccessCommandInput, options?: __HttpHandlerOptions): Promise; + grantAccess(args: GrantAccessCommandInput, cb: (err: any, data?: GrantAccessCommandOutput) => void): void; + grantAccess( args: GrantAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GrantAccessCommandOutput) => void ): void; - public grantAccess( - args: GrantAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GrantAccessCommandOutput) => void), - cb?: (err: any, data?: GrantAccessCommandOutput) => void - ): Promise | void { - const command = new GrantAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of tags that are applied to the specified stack or layer.

- */ - public listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; - public listTags( + + /** + * @see {@link ListTagsCommand} + */ + listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; + listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; + listTags( args: ListTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsCommandOutput) => void ): void; - public listTags( - args: ListTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsCommandOutput) => void), - cb?: (err: any, data?: ListTagsCommandOutput) => void - ): Promise | void { - const command = new ListTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Reboots a specified instance. For more information, see Starting, - * Stopping, and Rebooting Instances.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public rebootInstance( + + /** + * @see {@link RebootInstanceCommand} + */ + rebootInstance( args: RebootInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public rebootInstance( - args: RebootInstanceCommandInput, - cb: (err: any, data?: RebootInstanceCommandOutput) => void - ): void; - public rebootInstance( + rebootInstance(args: RebootInstanceCommandInput, cb: (err: any, data?: RebootInstanceCommandOutput) => void): void; + rebootInstance( args: RebootInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebootInstanceCommandOutput) => void ): void; - public rebootInstance( - args: RebootInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RebootInstanceCommandOutput) => void), - cb?: (err: any, data?: RebootInstanceCommandOutput) => void - ): Promise | void { - const command = new RebootInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers a specified Amazon ECS cluster with a stack. You can register only one - * cluster with a stack. A cluster can be registered with only one stack. - * For more information, see - * - * Resource Management.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack or an attached policy that explicitly grants permissions. For more - * information on user permissions, see - * - * Managing User Permissions.

- */ - public registerEcsCluster( + + /** + * @see {@link RegisterEcsClusterCommand} + */ + registerEcsCluster( args: RegisterEcsClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerEcsCluster( + registerEcsCluster( args: RegisterEcsClusterCommandInput, cb: (err: any, data?: RegisterEcsClusterCommandOutput) => void ): void; - public registerEcsCluster( + registerEcsCluster( args: RegisterEcsClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterEcsClusterCommandOutput) => void ): void; - public registerEcsCluster( - args: RegisterEcsClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterEcsClusterCommandOutput) => void), - cb?: (err: any, data?: RegisterEcsClusterCommandOutput) => void - ): Promise | void { - const command = new RegisterEcsClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers an Elastic IP address with a specified stack. An address can be registered with - * only one stack at a time. If the address is already registered, you must first deregister it - * by calling DeregisterElasticIp. For more information, see Resource Management.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public registerElasticIp( + + /** + * @see {@link RegisterElasticIpCommand} + */ + registerElasticIp( args: RegisterElasticIpCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerElasticIp( + registerElasticIp( args: RegisterElasticIpCommandInput, cb: (err: any, data?: RegisterElasticIpCommandOutput) => void ): void; - public registerElasticIp( + registerElasticIp( args: RegisterElasticIpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterElasticIpCommandOutput) => void ): void; - public registerElasticIp( - args: RegisterElasticIpCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterElasticIpCommandOutput) => void), - cb?: (err: any, data?: RegisterElasticIpCommandOutput) => void - ): Promise | void { - const command = new RegisterElasticIpCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.

- * - *

We do not recommend using this action to register instances. The complete registration - * operation includes two tasks: installing the AWS OpsWorks Stacks agent on the instance, and registering - * the instance with the stack. RegisterInstance handles only the second step. You - * should instead use the AWS CLI register command, which performs the entire - * registration operation. For more information, - * see - * Registering an Instance with an AWS OpsWorks Stacks Stack.

- *
- *

Registered instances have the same requirements as instances that are created by using the CreateInstance API. - * For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance - * type. For more information about requirements for instances that you want to register, see - * Preparing the Instance.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public registerInstance( + + /** + * @see {@link RegisterInstanceCommand} + */ + registerInstance( args: RegisterInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerInstance( + registerInstance( args: RegisterInstanceCommandInput, cb: (err: any, data?: RegisterInstanceCommandOutput) => void ): void; - public registerInstance( + registerInstance( args: RegisterInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterInstanceCommandOutput) => void ): void; - public registerInstance( - args: RegisterInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterInstanceCommandOutput) => void), - cb?: (err: any, data?: RegisterInstanceCommandOutput) => void - ): Promise | void { - const command = new RegisterInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers an Amazon RDS instance with a stack.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public registerRdsDbInstance( + + /** + * @see {@link RegisterRdsDbInstanceCommand} + */ + registerRdsDbInstance( args: RegisterRdsDbInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerRdsDbInstance( + registerRdsDbInstance( args: RegisterRdsDbInstanceCommandInput, cb: (err: any, data?: RegisterRdsDbInstanceCommandOutput) => void ): void; - public registerRdsDbInstance( + registerRdsDbInstance( args: RegisterRdsDbInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterRdsDbInstanceCommandOutput) => void ): void; - public registerRdsDbInstance( - args: RegisterRdsDbInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterRdsDbInstanceCommandOutput) => void), - cb?: (err: any, data?: RegisterRdsDbInstanceCommandOutput) => void - ): Promise | void { - const command = new RegisterRdsDbInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one - * stack at a time. If the volume is already registered, you must first deregister it by calling - * DeregisterVolume. For more information, see Resource Management.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public registerVolume( + + /** + * @see {@link RegisterVolumeCommand} + */ + registerVolume( args: RegisterVolumeCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerVolume( - args: RegisterVolumeCommandInput, - cb: (err: any, data?: RegisterVolumeCommandOutput) => void - ): void; - public registerVolume( + registerVolume(args: RegisterVolumeCommandInput, cb: (err: any, data?: RegisterVolumeCommandOutput) => void): void; + registerVolume( args: RegisterVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterVolumeCommandOutput) => void ): void; - public registerVolume( - args: RegisterVolumeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterVolumeCommandOutput) => void), - cb?: (err: any, data?: RegisterVolumeCommandOutput) => void - ): Promise | void { - const command = new RegisterVolumeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Specify the load-based auto scaling configuration for a specified layer. For more - * information, see Managing - * Load with Time-based and Load-based Instances.

- * - *

To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load.

- *
- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public setLoadBasedAutoScaling( + + /** + * @see {@link SetLoadBasedAutoScalingCommand} + */ + setLoadBasedAutoScaling( args: SetLoadBasedAutoScalingCommandInput, options?: __HttpHandlerOptions ): Promise; - public setLoadBasedAutoScaling( + setLoadBasedAutoScaling( args: SetLoadBasedAutoScalingCommandInput, cb: (err: any, data?: SetLoadBasedAutoScalingCommandOutput) => void ): void; - public setLoadBasedAutoScaling( + setLoadBasedAutoScaling( args: SetLoadBasedAutoScalingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetLoadBasedAutoScalingCommandOutput) => void ): void; - public setLoadBasedAutoScaling( - args: SetLoadBasedAutoScalingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetLoadBasedAutoScalingCommandOutput) => void), - cb?: (err: any, data?: SetLoadBasedAutoScalingCommandOutput) => void - ): Promise | void { - const command = new SetLoadBasedAutoScalingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Specifies a user's permissions. For more information, see Security and - * Permissions.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public setPermission( - args: SetPermissionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public setPermission( - args: SetPermissionCommandInput, - cb: (err: any, data?: SetPermissionCommandOutput) => void - ): void; - public setPermission( + + /** + * @see {@link SetPermissionCommand} + */ + setPermission(args: SetPermissionCommandInput, options?: __HttpHandlerOptions): Promise; + setPermission(args: SetPermissionCommandInput, cb: (err: any, data?: SetPermissionCommandOutput) => void): void; + setPermission( args: SetPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetPermissionCommandOutput) => void ): void; - public setPermission( - args: SetPermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetPermissionCommandOutput) => void), - cb?: (err: any, data?: SetPermissionCommandOutput) => void - ): Promise | void { - const command = new SetPermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Specify the time-based auto scaling configuration for a specified instance. For more - * information, see Managing - * Load with Time-based and Load-based Instances.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public setTimeBasedAutoScaling( + + /** + * @see {@link SetTimeBasedAutoScalingCommand} + */ + setTimeBasedAutoScaling( args: SetTimeBasedAutoScalingCommandInput, options?: __HttpHandlerOptions ): Promise; - public setTimeBasedAutoScaling( + setTimeBasedAutoScaling( args: SetTimeBasedAutoScalingCommandInput, cb: (err: any, data?: SetTimeBasedAutoScalingCommandOutput) => void ): void; - public setTimeBasedAutoScaling( + setTimeBasedAutoScaling( args: SetTimeBasedAutoScalingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetTimeBasedAutoScalingCommandOutput) => void ): void; - public setTimeBasedAutoScaling( - args: SetTimeBasedAutoScalingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetTimeBasedAutoScalingCommandOutput) => void), - cb?: (err: any, data?: SetTimeBasedAutoScalingCommandOutput) => void - ): Promise | void { - const command = new SetTimeBasedAutoScalingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a specified instance. For more information, see Starting, - * Stopping, and Rebooting Instances.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public startInstance( - args: StartInstanceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public startInstance( - args: StartInstanceCommandInput, - cb: (err: any, data?: StartInstanceCommandOutput) => void - ): void; - public startInstance( + + /** + * @see {@link StartInstanceCommand} + */ + startInstance(args: StartInstanceCommandInput, options?: __HttpHandlerOptions): Promise; + startInstance(args: StartInstanceCommandInput, cb: (err: any, data?: StartInstanceCommandOutput) => void): void; + startInstance( args: StartInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartInstanceCommandOutput) => void ): void; - public startInstance( - args: StartInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartInstanceCommandOutput) => void), - cb?: (err: any, data?: StartInstanceCommandOutput) => void - ): Promise | void { - const command = new StartInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a stack's instances.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public startStack(args: StartStackCommandInput, options?: __HttpHandlerOptions): Promise; - public startStack(args: StartStackCommandInput, cb: (err: any, data?: StartStackCommandOutput) => void): void; - public startStack( + + /** + * @see {@link StartStackCommand} + */ + startStack(args: StartStackCommandInput, options?: __HttpHandlerOptions): Promise; + startStack(args: StartStackCommandInput, cb: (err: any, data?: StartStackCommandOutput) => void): void; + startStack( args: StartStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartStackCommandOutput) => void ): void; - public startStack( - args: StartStackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartStackCommandOutput) => void), - cb?: (err: any, data?: StartStackCommandOutput) => void - ): Promise | void { - const command = new StartStackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a specified instance. When you stop a standard instance, the data disappears and must - * be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without - * losing data. For more information, see Starting, - * Stopping, and Rebooting Instances.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public stopInstance( - args: StopInstanceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public stopInstance(args: StopInstanceCommandInput, cb: (err: any, data?: StopInstanceCommandOutput) => void): void; - public stopInstance( + + /** + * @see {@link StopInstanceCommand} + */ + stopInstance(args: StopInstanceCommandInput, options?: __HttpHandlerOptions): Promise; + stopInstance(args: StopInstanceCommandInput, cb: (err: any, data?: StopInstanceCommandOutput) => void): void; + stopInstance( args: StopInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopInstanceCommandOutput) => void ): void; - public stopInstance( - args: StopInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopInstanceCommandOutput) => void), - cb?: (err: any, data?: StopInstanceCommandOutput) => void - ): Promise | void { - const command = new StopInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a specified stack.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public stopStack(args: StopStackCommandInput, options?: __HttpHandlerOptions): Promise; - public stopStack(args: StopStackCommandInput, cb: (err: any, data?: StopStackCommandOutput) => void): void; - public stopStack( + + /** + * @see {@link StopStackCommand} + */ + stopStack(args: StopStackCommandInput, options?: __HttpHandlerOptions): Promise; + stopStack(args: StopStackCommandInput, cb: (err: any, data?: StopStackCommandOutput) => void): void; + stopStack( args: StopStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopStackCommandOutput) => void ): void; - public stopStack( - args: StopStackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopStackCommandOutput) => void), - cb?: (err: any, data?: StopStackCommandOutput) => void - ): Promise | void { - const command = new StopStackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks. For more information about how tagging works, see Tags in the AWS OpsWorks User Guide.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Unassigns a registered instance from all layers that are using the instance. - * The instance remains in the stack as an unassigned instance, and can be assigned to - * another layer as needed. You cannot use this action with instances that were created - * with AWS OpsWorks Stacks.

- *

- * Required Permissions: To use this action, an IAM user must - * have a Manage permissions level for the stack or an attached policy that explicitly - * grants permissions. For more information about user permissions, see Managing User - * Permissions.

- */ - public unassignInstance( + + /** + * @see {@link UnassignInstanceCommand} + */ + unassignInstance( args: UnassignInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public unassignInstance( + unassignInstance( args: UnassignInstanceCommandInput, cb: (err: any, data?: UnassignInstanceCommandOutput) => void ): void; - public unassignInstance( + unassignInstance( args: UnassignInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnassignInstanceCommandOutput) => void ): void; - public unassignInstance( - args: UnassignInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnassignInstanceCommandOutput) => void), - cb?: (err: any, data?: UnassignInstanceCommandOutput) => void - ): Promise | void { - const command = new UnassignInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more - * information, see Resource - * Management.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public unassignVolume( + + /** + * @see {@link UnassignVolumeCommand} + */ + unassignVolume( args: UnassignVolumeCommandInput, options?: __HttpHandlerOptions ): Promise; - public unassignVolume( - args: UnassignVolumeCommandInput, - cb: (err: any, data?: UnassignVolumeCommandOutput) => void - ): void; - public unassignVolume( + unassignVolume(args: UnassignVolumeCommandInput, cb: (err: any, data?: UnassignVolumeCommandOutput) => void): void; + unassignVolume( args: UnassignVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnassignVolumeCommandOutput) => void ): void; - public unassignVolume( - args: UnassignVolumeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnassignVolumeCommandOutput) => void), - cb?: (err: any, data?: UnassignVolumeCommandOutput) => void - ): Promise | void { - const command = new UnassignVolumeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes tags from a specified stack or layer.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a specified app.

- *

- * Required Permissions: To use this action, an IAM user must have a Deploy or Manage - * permissions level for the stack, or an attached policy that explicitly grants permissions. For - * more information on user permissions, see Managing User - * Permissions.

- */ - public updateApp(args: UpdateAppCommandInput, options?: __HttpHandlerOptions): Promise; - public updateApp(args: UpdateAppCommandInput, cb: (err: any, data?: UpdateAppCommandOutput) => void): void; - public updateApp( + + /** + * @see {@link UpdateAppCommand} + */ + updateApp(args: UpdateAppCommandInput, options?: __HttpHandlerOptions): Promise; + updateApp(args: UpdateAppCommandInput, cb: (err: any, data?: UpdateAppCommandOutput) => void): void; + updateApp( args: UpdateAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAppCommandOutput) => void ): void; - public updateApp( - args: UpdateAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAppCommandOutput) => void), - cb?: (err: any, data?: UpdateAppCommandOutput) => void - ): Promise | void { - const command = new UpdateAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a registered Elastic IP address's name. For more information, see Resource Management.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public updateElasticIp( + + /** + * @see {@link UpdateElasticIpCommand} + */ + updateElasticIp( args: UpdateElasticIpCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateElasticIp( - args: UpdateElasticIpCommandInput, - cb: (err: any, data?: UpdateElasticIpCommandOutput) => void - ): void; - public updateElasticIp( + updateElasticIp(args: UpdateElasticIpCommandInput, cb: (err: any, data?: UpdateElasticIpCommandOutput) => void): void; + updateElasticIp( args: UpdateElasticIpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateElasticIpCommandOutput) => void ): void; - public updateElasticIp( - args: UpdateElasticIpCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateElasticIpCommandOutput) => void), - cb?: (err: any, data?: UpdateElasticIpCommandOutput) => void - ): Promise | void { - const command = new UpdateElasticIpCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a specified instance.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public updateInstance( + + /** + * @see {@link UpdateInstanceCommand} + */ + updateInstance( args: UpdateInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateInstance( - args: UpdateInstanceCommandInput, - cb: (err: any, data?: UpdateInstanceCommandOutput) => void - ): void; - public updateInstance( + updateInstance(args: UpdateInstanceCommandInput, cb: (err: any, data?: UpdateInstanceCommandOutput) => void): void; + updateInstance( args: UpdateInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateInstanceCommandOutput) => void ): void; - public updateInstance( - args: UpdateInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateInstanceCommandOutput) => void), - cb?: (err: any, data?: UpdateInstanceCommandOutput) => void - ): Promise | void { - const command = new UpdateInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a specified layer.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public updateLayer(args: UpdateLayerCommandInput, options?: __HttpHandlerOptions): Promise; - public updateLayer(args: UpdateLayerCommandInput, cb: (err: any, data?: UpdateLayerCommandOutput) => void): void; - public updateLayer( + + /** + * @see {@link UpdateLayerCommand} + */ + updateLayer(args: UpdateLayerCommandInput, options?: __HttpHandlerOptions): Promise; + updateLayer(args: UpdateLayerCommandInput, cb: (err: any, data?: UpdateLayerCommandOutput) => void): void; + updateLayer( args: UpdateLayerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLayerCommandOutput) => void ): void; - public updateLayer( - args: UpdateLayerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLayerCommandOutput) => void), - cb?: (err: any, data?: UpdateLayerCommandOutput) => void - ): Promise | void { - const command = new UpdateLayerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a user's SSH public key.

- *

- * Required Permissions: To use this action, an IAM user must have self-management - * enabled or an attached policy that explicitly grants permissions. For more information about user - * permissions, see Managing User - * Permissions.

- */ - public updateMyUserProfile( + + /** + * @see {@link UpdateMyUserProfileCommand} + */ + updateMyUserProfile( args: UpdateMyUserProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMyUserProfile( + updateMyUserProfile( args: UpdateMyUserProfileCommandInput, cb: (err: any, data?: UpdateMyUserProfileCommandOutput) => void ): void; - public updateMyUserProfile( + updateMyUserProfile( args: UpdateMyUserProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMyUserProfileCommandOutput) => void ): void; - public updateMyUserProfile( - args: UpdateMyUserProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMyUserProfileCommandOutput) => void), - cb?: (err: any, data?: UpdateMyUserProfileCommandOutput) => void - ): Promise | void { - const command = new UpdateMyUserProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an Amazon RDS instance.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public updateRdsDbInstance( + + /** + * @see {@link UpdateRdsDbInstanceCommand} + */ + updateRdsDbInstance( args: UpdateRdsDbInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRdsDbInstance( + updateRdsDbInstance( args: UpdateRdsDbInstanceCommandInput, cb: (err: any, data?: UpdateRdsDbInstanceCommandOutput) => void ): void; - public updateRdsDbInstance( + updateRdsDbInstance( args: UpdateRdsDbInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRdsDbInstanceCommandOutput) => void ): void; - public updateRdsDbInstance( - args: UpdateRdsDbInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRdsDbInstanceCommandOutput) => void), - cb?: (err: any, data?: UpdateRdsDbInstanceCommandOutput) => void - ): Promise | void { - const command = new UpdateRdsDbInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a specified stack.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public updateStack(args: UpdateStackCommandInput, options?: __HttpHandlerOptions): Promise; - public updateStack(args: UpdateStackCommandInput, cb: (err: any, data?: UpdateStackCommandOutput) => void): void; - public updateStack( + + /** + * @see {@link UpdateStackCommand} + */ + updateStack(args: UpdateStackCommandInput, options?: __HttpHandlerOptions): Promise; + updateStack(args: UpdateStackCommandInput, cb: (err: any, data?: UpdateStackCommandOutput) => void): void; + updateStack( args: UpdateStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStackCommandOutput) => void ): void; - public updateStack( - args: UpdateStackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStackCommandOutput) => void), - cb?: (err: any, data?: UpdateStackCommandOutput) => void - ): Promise | void { - const command = new UpdateStackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a specified user profile.

- *

- * Required Permissions: To use this action, an IAM user must have an attached policy - * that explicitly grants permissions. For more information about user permissions, see Managing User - * Permissions.

- */ - public updateUserProfile( + + /** + * @see {@link UpdateUserProfileCommand} + */ + updateUserProfile( args: UpdateUserProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateUserProfile( + updateUserProfile( args: UpdateUserProfileCommandInput, cb: (err: any, data?: UpdateUserProfileCommandOutput) => void ): void; - public updateUserProfile( + updateUserProfile( args: UpdateUserProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserProfileCommandOutput) => void ): void; - public updateUserProfile( - args: UpdateUserProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserProfileCommandOutput) => void), - cb?: (err: any, data?: UpdateUserProfileCommandOutput) => void - ): Promise | void { - const command = new UpdateUserProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management.

- *

- * Required Permissions: To use this action, an IAM user must have a Manage permissions - * level for the stack, or an attached policy that explicitly grants permissions. For more - * information on user permissions, see Managing User - * Permissions.

- */ - public updateVolume( - args: UpdateVolumeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateVolume(args: UpdateVolumeCommandInput, cb: (err: any, data?: UpdateVolumeCommandOutput) => void): void; - public updateVolume( + + /** + * @see {@link UpdateVolumeCommand} + */ + updateVolume(args: UpdateVolumeCommandInput, options?: __HttpHandlerOptions): Promise; + updateVolume(args: UpdateVolumeCommandInput, cb: (err: any, data?: UpdateVolumeCommandOutput) => void): void; + updateVolume( args: UpdateVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVolumeCommandOutput) => void ): void; - public updateVolume( - args: UpdateVolumeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVolumeCommandOutput) => void), - cb?: (err: any, data?: UpdateVolumeCommandOutput) => void - ): Promise | void { - const command = new UpdateVolumeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * AWS OpsWorks + *

Welcome to the AWS OpsWorks Stacks API Reference. This guide provides descriptions, syntax, and + * usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error + * codes.

+ *

AWS OpsWorks Stacks is an application management service that provides an integrated experience for + * overseeing the complete application lifecycle. For information about this product, go to the + * AWS OpsWorks details page.

+ * + *

+ * SDKs and CLI + *

+ *

The most common way to use the AWS OpsWorks Stacks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:

+ * + * + *

+ * Endpoints + *

+ *

AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks + * can only be accessed or managed within the endpoint in which they are created.

+ *
    + *
  • + *

    opsworks.us-east-1.amazonaws.com

    + *
  • + *
  • + *

    opsworks.us-east-2.amazonaws.com

    + *
  • + *
  • + *

    opsworks.us-west-1.amazonaws.com

    + *
  • + *
  • + *

    opsworks.us-west-2.amazonaws.com

    + *
  • + *
  • + *

    opsworks.ca-central-1.amazonaws.com (API only; not available in the AWS console)

    + *
  • + *
  • + *

    opsworks.eu-west-1.amazonaws.com

    + *
  • + *
  • + *

    opsworks.eu-west-2.amazonaws.com

    + *
  • + *
  • + *

    opsworks.eu-west-3.amazonaws.com

    + *
  • + *
  • + *

    opsworks.eu-central-1.amazonaws.com

    + *
  • + *
  • + *

    opsworks.ap-northeast-1.amazonaws.com

    + *
  • + *
  • + *

    opsworks.ap-northeast-2.amazonaws.com

    + *
  • + *
  • + *

    opsworks.ap-south-1.amazonaws.com

    + *
  • + *
  • + *

    opsworks.ap-southeast-1.amazonaws.com

    + *
  • + *
  • + *

    opsworks.ap-southeast-2.amazonaws.com

    + *
  • + *
  • + *

    opsworks.sa-east-1.amazonaws.com

    + *
  • + *
+ *

+ * Chef Versions + *

+ *

When you call CreateStack, CloneStack, or UpdateStack we recommend you + * use the ConfigurationManager parameter to specify the Chef version. + * The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information, + * see Chef Versions.

+ * + *

You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.

+ *
+ */ +export class OpsWorks extends OpsWorksClient implements OpsWorks {} +createAggregatedClient(commands, OpsWorks); diff --git a/clients/client-opsworkscm/src/OpsWorksCM.ts b/clients/client-opsworkscm/src/OpsWorksCM.ts index 8a75dff4188f..00e5dc2c3344 100644 --- a/clients/client-opsworkscm/src/OpsWorksCM.ts +++ b/clients/client-opsworkscm/src/OpsWorksCM.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -92,884 +93,382 @@ import { UpdateServerEngineAttributesCommandInput, UpdateServerEngineAttributesCommandOutput, } from "./commands/UpdateServerEngineAttributesCommand"; -import { OpsWorksCMClient } from "./OpsWorksCMClient"; +import { OpsWorksCMClient, OpsWorksCMClientConfig } from "./OpsWorksCMClient"; -/** - * @public - * AWS OpsWorks CM - *

AWS OpsWorks for configuration management (CM) is a service that runs and manages - * configuration management servers. You can use AWS OpsWorks CM to create and manage AWS - * OpsWorks for Chef Automate and AWS OpsWorks for Puppet Enterprise servers, and add or remove - * nodes for the servers to manage.

- *

- * Glossary of terms - *

- *
    - *
  • - *

    - * Server: A configuration management server that can be - * highly-available. The configuration management server runs on - * an Amazon Elastic Compute Cloud (EC2) instance, and may use various other AWS services, such as Amazon Relational - * Database Service (RDS) and Elastic Load Balancing. A server is a generic abstraction over the configuration - * manager that you want to use, much like Amazon RDS. In AWS OpsWorks CM, you do not start - * or stop servers. After you create servers, they continue to run until they are deleted.

    - *
  • - *
  • - *

    - * Engine: The engine is the specific configuration manager - * that you want to use. Valid values in this release include ChefAutomate and Puppet.

    - *
  • - *
  • - *

    - * Backup: This - * is an application-level backup of the data that the configuration manager - * stores. AWS OpsWorks CM - * creates an S3 bucket for backups when you launch the first - * server. A backup maintains a snapshot of a server's configuration-related - * attributes at the time the backup starts.

    - *
  • - *
  • - *

    - * Events: - * Events are always related to a server. Events are written - * during server creation, when health checks run, when backups - * are created, when system maintenance is performed, etc. When you delete a server, the server's events are - * also deleted.

    - *
  • - *
  • - *

    - * Account attributes: - * Every account has attributes that are assigned in the AWS OpsWorks CM - * database. These attributes store information about configuration limits (servers, - * backups, etc.) and your customer account. - *

    - *
  • - *
- *

- * Endpoints - *

- *

AWS OpsWorks CM supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Your servers - * can only be accessed or managed within the endpoint in which they are created.

- *
    - *
  • - *

    opsworks-cm.us-east-1.amazonaws.com

    - *
  • - *
  • - *

    opsworks-cm.us-east-2.amazonaws.com

    - *
  • - *
  • - *

    opsworks-cm.us-west-1.amazonaws.com

    - *
  • - *
  • - *

    opsworks-cm.us-west-2.amazonaws.com

    - *
  • - *
  • - *

    opsworks-cm.ap-northeast-1.amazonaws.com

    - *
  • - *
  • - *

    opsworks-cm.ap-southeast-1.amazonaws.com

    - *
  • - *
  • - *

    opsworks-cm.ap-southeast-2.amazonaws.com

    - *
  • - *
  • - *

    opsworks-cm.eu-central-1.amazonaws.com

    - *
  • - *
  • - *

    opsworks-cm.eu-west-1.amazonaws.com

    - *
  • - *
- *

For more information, see AWS OpsWorks endpoints and quotas in the AWS General Reference.

- *

- * Throttling limits - *

- *

All API operations allow for five requests per second with a burst of 10 requests per second.

- */ -export class OpsWorksCM extends OpsWorksCMClient { +const commands = { + AssociateNodeCommand, + CreateBackupCommand, + CreateServerCommand, + DeleteBackupCommand, + DeleteServerCommand, + DescribeAccountAttributesCommand, + DescribeBackupsCommand, + DescribeEventsCommand, + DescribeNodeAssociationStatusCommand, + DescribeServersCommand, + DisassociateNodeCommand, + ExportServerEngineAttributeCommand, + ListTagsForResourceCommand, + RestoreServerCommand, + StartMaintenanceCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateServerCommand, + UpdateServerEngineAttributesCommand, +}; + +export interface OpsWorksCM { /** - * @public - *

Associates a new node with the server. For more information about how to disassociate a node, see DisassociateNode.

- *

- * On a Chef server: This command is an alternative to knife bootstrap.

- *

- * Example (Chef): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=CHEF_ORGANIZATION,Value=default" "Name=CHEF_NODE_PUBLIC_KEY,Value=public-key-pem" - *

- *

- * On a Puppet server, this command is an alternative to the puppet cert sign command that signs a Puppet node CSR. - *

- *

- * Example (Puppet): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes "Name=PUPPET_NODE_CSR,Value=csr-pem" - *

- *

- * A node can can only be associated with servers that are in a HEALTHY state. Otherwise, an InvalidStateException is thrown. - * A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. - * The AssociateNode API call can be integrated into Auto Scaling configurations, AWS Cloudformation templates, or the user data of a server's instance. - *

+ * @see {@link AssociateNodeCommand} */ - public associateNode( - args: AssociateNodeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public associateNode( - args: AssociateNodeCommandInput, - cb: (err: any, data?: AssociateNodeCommandOutput) => void - ): void; - public associateNode( + associateNode(args: AssociateNodeCommandInput, options?: __HttpHandlerOptions): Promise; + associateNode(args: AssociateNodeCommandInput, cb: (err: any, data?: AssociateNodeCommandOutput) => void): void; + associateNode( args: AssociateNodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateNodeCommandOutput) => void ): void; - public associateNode( - args: AssociateNodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateNodeCommandOutput) => void), - cb?: (err: any, data?: AssociateNodeCommandOutput) => void - ): Promise | void { - const command = new AssociateNodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Creates an application-level backup of a server. While the - * server is in the BACKING_UP state, the server cannot be - * changed, and no additional backup can be created. - *

- *

- * Backups can be created for servers in RUNNING, HEALTHY, and UNHEALTHY states. By default, you can create a maximum of 50 - * manual backups. - *

- *

- * This operation is asynchronous. - *

- *

- * A LimitExceededException is thrown when the maximum number of manual backups is reached. - * An InvalidStateException is thrown when the server is not in any of the following states: RUNNING, HEALTHY, or UNHEALTHY. - * A ResourceNotFoundException is thrown when the server is not found. - * A ValidationException is thrown when parameters of the request are not valid. - *

+ * @see {@link CreateBackupCommand} */ - public createBackup( - args: CreateBackupCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createBackup(args: CreateBackupCommandInput, cb: (err: any, data?: CreateBackupCommandOutput) => void): void; - public createBackup( + createBackup(args: CreateBackupCommandInput, options?: __HttpHandlerOptions): Promise; + createBackup(args: CreateBackupCommandInput, cb: (err: any, data?: CreateBackupCommandOutput) => void): void; + createBackup( args: CreateBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBackupCommandOutput) => void ): void; - public createBackup( - args: CreateBackupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBackupCommandOutput) => void), - cb?: (err: any, data?: CreateBackupCommandOutput) => void - ): Promise | void { - const command = new CreateBackupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Creates and immedately starts a new server. The server is ready to use when it is in the HEALTHY state. By default, you can create a maximum of 10 servers. - *

- *

- * This operation is asynchronous. - *

- *

- * A LimitExceededException is thrown when you have created the maximum number of servers (10). A ResourceAlreadyExistsException - * is thrown when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when you - * specify a backup ID that is not valid or is for a backup that does not exist. A ValidationException is thrown when parameters - * of the request are not valid. - *

- *

- * If you do not specify a security group by adding the SecurityGroupIds parameter, AWS OpsWorks creates a new security group. - *

- *

- * Chef Automate: The default security group opens the Chef server to the world on TCP port 443. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22. - *

- *

- * Puppet Enterprise: The default security group opens TCP ports 22, 443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22. - *

- *

By default, your server is accessible from any IP address. We - * recommend that you update your security group rules to allow - * access from known IP addresses and address ranges only. To edit security group rules, open Security Groups - * in the navigation pane of the EC2 management console. - *

- *

To specify your own domain for a server, and provide your own self-signed or CA-signed certificate and private key, specify values for CustomDomain, - * CustomCertificate, and CustomPrivateKey.

+ * @see {@link CreateServerCommand} */ - public createServer( - args: CreateServerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createServer(args: CreateServerCommandInput, cb: (err: any, data?: CreateServerCommandOutput) => void): void; - public createServer( + createServer(args: CreateServerCommandInput, options?: __HttpHandlerOptions): Promise; + createServer(args: CreateServerCommandInput, cb: (err: any, data?: CreateServerCommandOutput) => void): void; + createServer( args: CreateServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServerCommandOutput) => void ): void; - public createServer( - args: CreateServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateServerCommandOutput) => void), - cb?: (err: any, data?: CreateServerCommandOutput) => void - ): Promise | void { - const command = new CreateServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous. - *

- *

- * An InvalidStateException is thrown when a backup deletion is already in progress. - * A ResourceNotFoundException is thrown when the backup does not exist. - * A ValidationException is thrown when parameters of the request are not valid. - *

+ * @see {@link DeleteBackupCommand} */ - public deleteBackup( - args: DeleteBackupCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteBackup(args: DeleteBackupCommandInput, cb: (err: any, data?: DeleteBackupCommandOutput) => void): void; - public deleteBackup( + deleteBackup(args: DeleteBackupCommandInput, options?: __HttpHandlerOptions): Promise; + deleteBackup(args: DeleteBackupCommandInput, cb: (err: any, data?: DeleteBackupCommandOutput) => void): void; + deleteBackup( args: DeleteBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackupCommandOutput) => void ): void; - public deleteBackup( - args: DeleteBackupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBackupCommandOutput) => void), - cb?: (err: any, data?: DeleteBackupCommandOutput) => void - ): Promise | void { - const command = new DeleteBackupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Deletes the server and the underlying AWS CloudFormation stacks - * (including the server's EC2 instance). When you run this command, the server state is updated - * to DELETING. After the server is deleted, it is no longer returned by - * DescribeServer requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted. - *

- *

- * This operation is asynchronous. - *

- *

- * An InvalidStateException is thrown when a server deletion is already in progress. - * A ResourceNotFoundException is thrown when the server does not exist. - * A ValidationException is raised when parameters of the request are not valid. - *

- *

- *

+ * @see {@link DeleteServerCommand} */ - public deleteServer( - args: DeleteServerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteServer(args: DeleteServerCommandInput, cb: (err: any, data?: DeleteServerCommandOutput) => void): void; - public deleteServer( + deleteServer(args: DeleteServerCommandInput, options?: __HttpHandlerOptions): Promise; + deleteServer(args: DeleteServerCommandInput, cb: (err: any, data?: DeleteServerCommandOutput) => void): void; + deleteServer( args: DeleteServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServerCommandOutput) => void ): void; - public deleteServer( - args: DeleteServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteServerCommandOutput) => void), - cb?: (err: any, data?: DeleteServerCommandOutput) => void - ): Promise | void { - const command = new DeleteServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Describes your OpsWorks-CM account attributes. - *

- *

- * This operation is synchronous. - *

+ * @see {@link DescribeAccountAttributesCommand} */ - public describeAccountAttributes( + describeAccountAttributes( args: DescribeAccountAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccountAttributes( + describeAccountAttributes( args: DescribeAccountAttributesCommandInput, cb: (err: any, data?: DescribeAccountAttributesCommandOutput) => void ): void; - public describeAccountAttributes( + describeAccountAttributes( args: DescribeAccountAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountAttributesCommandOutput) => void ): void; - public describeAccountAttributes( - args: DescribeAccountAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccountAttributesCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountAttributesCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Describes backups. The results are ordered by time, with newest backups first. - * If you do not specify a BackupId or ServerName, the command returns all backups. - *

- *

- * This operation is synchronous. - *

- *

- * A ResourceNotFoundException is thrown when the backup does not exist. - * A ValidationException is raised when parameters of the request are not valid. - *

+ * @see {@link DescribeBackupsCommand} */ - public describeBackups( + describeBackups( args: DescribeBackupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBackups( - args: DescribeBackupsCommandInput, - cb: (err: any, data?: DescribeBackupsCommandOutput) => void - ): void; - public describeBackups( + describeBackups(args: DescribeBackupsCommandInput, cb: (err: any, data?: DescribeBackupsCommandOutput) => void): void; + describeBackups( args: DescribeBackupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBackupsCommandOutput) => void ): void; - public describeBackups( - args: DescribeBackupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBackupsCommandOutput) => void), - cb?: (err: any, data?: DescribeBackupsCommandOutput) => void - ): Promise | void { - const command = new DescribeBackupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Describes events for a specified server. Results are ordered by time, with newest events first. - *

- *

- * This operation is synchronous. - *

- *

- * A ResourceNotFoundException is thrown when the server does not exist. - * A ValidationException is raised when parameters of the request are not valid. - *

+ * @see {@link DescribeEventsCommand} */ - public describeEvents( + describeEvents( args: DescribeEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEvents( - args: DescribeEventsCommandInput, - cb: (err: any, data?: DescribeEventsCommandOutput) => void - ): void; - public describeEvents( + describeEvents(args: DescribeEventsCommandInput, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void; + describeEvents( args: DescribeEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsCommandOutput) => void ): void; - public describeEvents( - args: DescribeEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventsCommandOutput) => void), - cb?: (err: any, data?: DescribeEventsCommandOutput) => void - ): Promise | void { - const command = new DescribeEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Returns the current status of an existing association or disassociation request. - *

- *

- * A ResourceNotFoundException is thrown when no recent association or disassociation request with the specified token is found, - * or when the server does not exist. A ValidationException is raised when parameters of the request are not valid. - *

+ * @see {@link DescribeNodeAssociationStatusCommand} */ - public describeNodeAssociationStatus( + describeNodeAssociationStatus( args: DescribeNodeAssociationStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNodeAssociationStatus( + describeNodeAssociationStatus( args: DescribeNodeAssociationStatusCommandInput, cb: (err: any, data?: DescribeNodeAssociationStatusCommandOutput) => void ): void; - public describeNodeAssociationStatus( + describeNodeAssociationStatus( args: DescribeNodeAssociationStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNodeAssociationStatusCommandOutput) => void ): void; - public describeNodeAssociationStatus( - args: DescribeNodeAssociationStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeNodeAssociationStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeNodeAssociationStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeNodeAssociationStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Lists all configuration management servers that are identified with your account. - * Only the stored results from Amazon DynamoDB - * are returned. AWS OpsWorks CM does not query other services. - *

- *

- * This operation is synchronous. - *

- *

- * A ResourceNotFoundException is thrown when the server does not exist. - * A ValidationException is raised when parameters of the request are not valid. - *

+ * @see {@link DescribeServersCommand} */ - public describeServers( + describeServers( args: DescribeServersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeServers( - args: DescribeServersCommandInput, - cb: (err: any, data?: DescribeServersCommandOutput) => void - ): void; - public describeServers( + describeServers(args: DescribeServersCommandInput, cb: (err: any, data?: DescribeServersCommandOutput) => void): void; + describeServers( args: DescribeServersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeServersCommandOutput) => void ): void; - public describeServers( - args: DescribeServersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeServersCommandOutput) => void), - cb?: (err: any, data?: DescribeServersCommandOutput) => void - ): Promise | void { - const command = new DescribeServersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes. After a node is disassociated, - * the node key pair is no longer valid for accessing the configuration manager's API. For more information about how to associate a node, see AssociateNode. - *

- *

A node can can only be disassociated from a server that is in a HEALTHY state. Otherwise, an InvalidStateException is thrown. - * A ResourceNotFoundException is thrown when the server does not exist. - * A ValidationException is raised when parameters of the request are not valid. - *

+ * @see {@link DisassociateNodeCommand} */ - public disassociateNode( + disassociateNode( args: DisassociateNodeCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateNode( + disassociateNode( args: DisassociateNodeCommandInput, cb: (err: any, data?: DisassociateNodeCommandOutput) => void ): void; - public disassociateNode( + disassociateNode( args: DisassociateNodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateNodeCommandOutput) => void ): void; - public disassociateNode( - args: DisassociateNodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateNodeCommandOutput) => void), - cb?: (err: any, data?: DisassociateNodeCommandOutput) => void - ): Promise | void { - const command = new DisassociateNodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Exports a specified server engine attribute as a base64-encoded string. For example, you can export user data that you can use in EC2 to associate nodes with a server. - *

- *

- * This operation is synchronous. - *

- *

- * A ValidationException is raised when parameters of the request are not valid. - * A ResourceNotFoundException is thrown when the server does not exist. - * An InvalidStateException is thrown when the server is in any of the following states: CREATING, TERMINATED, - * FAILED or DELETING. - *

+ * @see {@link ExportServerEngineAttributeCommand} */ - public exportServerEngineAttribute( + exportServerEngineAttribute( args: ExportServerEngineAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public exportServerEngineAttribute( + exportServerEngineAttribute( args: ExportServerEngineAttributeCommandInput, cb: (err: any, data?: ExportServerEngineAttributeCommandOutput) => void ): void; - public exportServerEngineAttribute( + exportServerEngineAttribute( args: ExportServerEngineAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportServerEngineAttributeCommandOutput) => void ): void; - public exportServerEngineAttribute( - args: ExportServerEngineAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportServerEngineAttributeCommandOutput) => void), - cb?: (err: any, data?: ExportServerEngineAttributeCommandOutput) => void - ): Promise | void { - const command = new ExportServerEngineAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or - * AWS OpsWorks for Puppet Enterprise servers or backups.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED state. - * When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains - * the existing server endpoint, so configuration management of the server's client devices (nodes) should continue to work. - *

- *

Restoring from a backup is performed by creating a new EC2 instance. If restoration is successful, and the server is in a HEALTHY state, - * AWS OpsWorks CM switches traffic over to the new instance. After restoration is finished, the old EC2 instance is maintained in a - * Running or Stopped state, but is eventually terminated.

- *

- * This operation is asynchronous. - *

- *

- * An InvalidStateException is thrown when the server is not in a valid state. A ResourceNotFoundException is thrown - * when the server does not exist. A ValidationException is raised when parameters of the request are not valid. - *

+ * @see {@link RestoreServerCommand} */ - public restoreServer( - args: RestoreServerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public restoreServer( - args: RestoreServerCommandInput, - cb: (err: any, data?: RestoreServerCommandOutput) => void - ): void; - public restoreServer( + restoreServer(args: RestoreServerCommandInput, options?: __HttpHandlerOptions): Promise; + restoreServer(args: RestoreServerCommandInput, cb: (err: any, data?: RestoreServerCommandOutput) => void): void; + restoreServer( args: RestoreServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreServerCommandOutput) => void ): void; - public restoreServer( - args: RestoreServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreServerCommandOutput) => void), - cb?: (err: any, data?: RestoreServerCommandOutput) => void - ): Promise | void { - const command = new RestoreServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying - * cause of maintenance failure has been resolved. The server is in an UNDER_MAINTENANCE state while maintenance is in progress. - *

- *

- * Maintenance can only be started on servers in HEALTHY and UNHEALTHY states. Otherwise, an InvalidStateException is thrown. - * A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. - *

+ * @see {@link StartMaintenanceCommand} */ - public startMaintenance( + startMaintenance( args: StartMaintenanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public startMaintenance( + startMaintenance( args: StartMaintenanceCommandInput, cb: (err: any, data?: StartMaintenanceCommandOutput) => void ): void; - public startMaintenance( + startMaintenance( args: StartMaintenanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMaintenanceCommandOutput) => void ): void; - public startMaintenance( - args: StartMaintenanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartMaintenanceCommandOutput) => void), - cb?: (err: any, data?: StartMaintenanceCommandOutput) => void - ): Promise | void { - const command = new StartMaintenanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes specified tags from an AWS OpsWorks-CM server or backup.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Updates settings for a server. - *

- *

- * This operation is synchronous. - *

+ * @see {@link UpdateServerCommand} */ - public updateServer( - args: UpdateServerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateServer(args: UpdateServerCommandInput, cb: (err: any, data?: UpdateServerCommandOutput) => void): void; - public updateServer( + updateServer(args: UpdateServerCommandInput, options?: __HttpHandlerOptions): Promise; + updateServer(args: UpdateServerCommandInput, cb: (err: any, data?: UpdateServerCommandOutput) => void): void; + updateServer( args: UpdateServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServerCommandOutput) => void ): void; - public updateServer( - args: UpdateServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServerCommandOutput) => void), - cb?: (err: any, data?: UpdateServerCommandOutput) => void - ): Promise | void { - const command = new UpdateServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Updates engine-specific attributes on a specified server. The server - * enters the MODIFYING state when this operation - * is in progress. Only one update can occur at a time. - * You can use this command to reset a Chef server's public key (CHEF_PIVOTAL_KEY) or a Puppet server's - * admin password (PUPPET_ADMIN_PASSWORD). - *

- *

- * This operation is asynchronous. - *

- *

- * This operation can only be called for servers in HEALTHY or UNHEALTHY states. Otherwise, an InvalidStateException is raised. - * A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. - *

+ * @see {@link UpdateServerEngineAttributesCommand} */ - public updateServerEngineAttributes( + updateServerEngineAttributes( args: UpdateServerEngineAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateServerEngineAttributes( + updateServerEngineAttributes( args: UpdateServerEngineAttributesCommandInput, cb: (err: any, data?: UpdateServerEngineAttributesCommandOutput) => void ): void; - public updateServerEngineAttributes( + updateServerEngineAttributes( args: UpdateServerEngineAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServerEngineAttributesCommandOutput) => void ): void; - public updateServerEngineAttributes( - args: UpdateServerEngineAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServerEngineAttributesCommandOutput) => void), - cb?: (err: any, data?: UpdateServerEngineAttributesCommandOutput) => void - ): Promise | void { - const command = new UpdateServerEngineAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * AWS OpsWorks CM + *

AWS OpsWorks for configuration management (CM) is a service that runs and manages + * configuration management servers. You can use AWS OpsWorks CM to create and manage AWS + * OpsWorks for Chef Automate and AWS OpsWorks for Puppet Enterprise servers, and add or remove + * nodes for the servers to manage.

+ *

+ * Glossary of terms + *

+ *
    + *
  • + *

    + * Server: A configuration management server that can be + * highly-available. The configuration management server runs on + * an Amazon Elastic Compute Cloud (EC2) instance, and may use various other AWS services, such as Amazon Relational + * Database Service (RDS) and Elastic Load Balancing. A server is a generic abstraction over the configuration + * manager that you want to use, much like Amazon RDS. In AWS OpsWorks CM, you do not start + * or stop servers. After you create servers, they continue to run until they are deleted.

    + *
  • + *
  • + *

    + * Engine: The engine is the specific configuration manager + * that you want to use. Valid values in this release include ChefAutomate and Puppet.

    + *
  • + *
  • + *

    + * Backup: This + * is an application-level backup of the data that the configuration manager + * stores. AWS OpsWorks CM + * creates an S3 bucket for backups when you launch the first + * server. A backup maintains a snapshot of a server's configuration-related + * attributes at the time the backup starts.

    + *
  • + *
  • + *

    + * Events: + * Events are always related to a server. Events are written + * during server creation, when health checks run, when backups + * are created, when system maintenance is performed, etc. When you delete a server, the server's events are + * also deleted.

    + *
  • + *
  • + *

    + * Account attributes: + * Every account has attributes that are assigned in the AWS OpsWorks CM + * database. These attributes store information about configuration limits (servers, + * backups, etc.) and your customer account. + *

    + *
  • + *
+ *

+ * Endpoints + *

+ *

AWS OpsWorks CM supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Your servers + * can only be accessed or managed within the endpoint in which they are created.

+ *
    + *
  • + *

    opsworks-cm.us-east-1.amazonaws.com

    + *
  • + *
  • + *

    opsworks-cm.us-east-2.amazonaws.com

    + *
  • + *
  • + *

    opsworks-cm.us-west-1.amazonaws.com

    + *
  • + *
  • + *

    opsworks-cm.us-west-2.amazonaws.com

    + *
  • + *
  • + *

    opsworks-cm.ap-northeast-1.amazonaws.com

    + *
  • + *
  • + *

    opsworks-cm.ap-southeast-1.amazonaws.com

    + *
  • + *
  • + *

    opsworks-cm.ap-southeast-2.amazonaws.com

    + *
  • + *
  • + *

    opsworks-cm.eu-central-1.amazonaws.com

    + *
  • + *
  • + *

    opsworks-cm.eu-west-1.amazonaws.com

    + *
  • + *
+ *

For more information, see AWS OpsWorks endpoints and quotas in the AWS General Reference.

+ *

+ * Throttling limits + *

+ *

All API operations allow for five requests per second with a burst of 10 requests per second.

+ */ +export class OpsWorksCM extends OpsWorksCMClient implements OpsWorksCM {} +createAggregatedClient(commands, OpsWorksCM); diff --git a/clients/client-organizations/src/Organizations.ts b/clients/client-organizations/src/Organizations.ts index 3b211a66a913..957b936bddb4 100644 --- a/clients/client-organizations/src/Organizations.ts +++ b/clients/client-organizations/src/Organizations.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -260,2736 +261,975 @@ import { UpdatePolicyCommandInput, UpdatePolicyCommandOutput, } from "./commands/UpdatePolicyCommand"; -import { OrganizationsClient } from "./OrganizationsClient"; +import { OrganizationsClient, OrganizationsClientConfig } from "./OrganizationsClient"; -/** - * @public - *

Organizations is a web service that enables you to consolidate your multiple - * Amazon Web Services accounts into an organization and centrally manage your - * accounts and their resources.

- *

This guide provides descriptions of the Organizations operations. For more - * information about using this service, see the Organizations User Guide.

- *

- * Support and feedback for Organizations - *

- *

We welcome your feedback. Send your comments to feedback-awsorganizations@amazon.com or post your feedback and questions in - * the Organizations support forum. For - * more information about the Amazon Web Services support forums, see Forums Help.

- *

- * Endpoint to call When using the CLI or the Amazon Web Services - * SDK - *

- *

For the current release of Organizations, specify the us-east-1 region - * for all Amazon Web Services API and CLI calls made from the commercial Amazon Web Services Regions outside of - * China. If calling from one of the Amazon Web Services Regions in China, then specify - * cn-northwest-1. You can do this in the CLI by using these parameters - * and commands:

- *
    - *
  • - *

    Use the following parameter with each command to specify both the endpoint and - * its region:

    - *

    - * --endpoint-url https://organizations.us-east-1.amazonaws.com - * (from commercial Amazon Web Services Regions outside of China) - *

    - *

    or

    - *

    - * --endpoint-url - * https://organizations.cn-northwest-1.amazonaws.com.cn - * (from Amazon Web Services Regions in China) - *

    - *
  • - *
  • - *

    Use the default endpoint, but configure your default region with this - * command:

    - *

    - * aws configure set default.region us-east-1 - * (from commercial Amazon Web Services Regions outside of China) - *

    - *

    or

    - *

    - * aws configure set default.region cn-northwest-1 - * (from Amazon Web Services Regions in China) - *

    - *
  • - *
  • - *

    Use the following parameter with each command to specify the endpoint:

    - *

    - * --region us-east-1 - * (from commercial Amazon Web Services Regions outside of China) - *

    - *

    or

    - *

    - * --region cn-northwest-1 - * (from Amazon Web Services Regions in China) - *

    - *
  • - *
- *

- * Recording API Requests - *

- *

Organizations supports CloudTrail, a service that records Amazon Web Services API calls for your - * Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected - * by CloudTrail, you can determine which requests the Organizations service received, who made the - * request and when, and so on. For more about Organizations and its support for CloudTrail, see - * Logging - * Organizations Events with CloudTrail in the Organizations User Guide. - * To learn more about CloudTrail, including how to turn it on and find your log files, see the - * CloudTrail User Guide.

- */ -export class Organizations extends OrganizationsClient { +const commands = { + AcceptHandshakeCommand, + AttachPolicyCommand, + CancelHandshakeCommand, + CloseAccountCommand, + CreateAccountCommand, + CreateGovCloudAccountCommand, + CreateOrganizationCommand, + CreateOrganizationalUnitCommand, + CreatePolicyCommand, + DeclineHandshakeCommand, + DeleteOrganizationCommand, + DeleteOrganizationalUnitCommand, + DeletePolicyCommand, + DeleteResourcePolicyCommand, + DeregisterDelegatedAdministratorCommand, + DescribeAccountCommand, + DescribeCreateAccountStatusCommand, + DescribeEffectivePolicyCommand, + DescribeHandshakeCommand, + DescribeOrganizationCommand, + DescribeOrganizationalUnitCommand, + DescribePolicyCommand, + DescribeResourcePolicyCommand, + DetachPolicyCommand, + DisableAWSServiceAccessCommand, + DisablePolicyTypeCommand, + EnableAllFeaturesCommand, + EnableAWSServiceAccessCommand, + EnablePolicyTypeCommand, + InviteAccountToOrganizationCommand, + LeaveOrganizationCommand, + ListAccountsCommand, + ListAccountsForParentCommand, + ListAWSServiceAccessForOrganizationCommand, + ListChildrenCommand, + ListCreateAccountStatusCommand, + ListDelegatedAdministratorsCommand, + ListDelegatedServicesForAccountCommand, + ListHandshakesForAccountCommand, + ListHandshakesForOrganizationCommand, + ListOrganizationalUnitsForParentCommand, + ListParentsCommand, + ListPoliciesCommand, + ListPoliciesForTargetCommand, + ListRootsCommand, + ListTagsForResourceCommand, + ListTargetsForPolicyCommand, + MoveAccountCommand, + PutResourcePolicyCommand, + RegisterDelegatedAdministratorCommand, + RemoveAccountFromOrganizationCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateOrganizationalUnitCommand, + UpdatePolicyCommand, +}; + +export interface Organizations { /** - * @public - *

Sends a response to the originator of a handshake agreeing to the action proposed by - * the handshake request.

- *

You can only call this operation by the following principals when they also have the - * relevant IAM permissions:

- *
    - *
  • - *

    - * Invitation to join or Approve all features request handshakes: only a principal from - * the member account.

    - *

    The user who calls the API for an invitation to join must have the - * organizations:AcceptHandshake permission. If you enabled all - * features in the organization, the user must also have the - * iam:CreateServiceLinkedRole permission so that Organizations can - * create the required service-linked role named AWSServiceRoleForOrganizations. For - * more information, see Organizations and Service-Linked Roles in the - * Organizations User Guide.

    - *
  • - *
  • - *

    - * Enable all features final confirmation - * handshake: only a principal from the management account.

    - *

    For more information about invitations, see Inviting an - * Amazon Web Services account to join your organization in the - * Organizations User Guide. For more information about requests to - * enable all features in the organization, see Enabling all features in your organization in - * the Organizations User Guide. - *

    - *
  • - *
- *

After you accept a handshake, it continues to appear in the results of relevant APIs - * for only 30 days. After that, it's deleted.

+ * @see {@link AcceptHandshakeCommand} */ - public acceptHandshake( + acceptHandshake( args: AcceptHandshakeCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptHandshake( - args: AcceptHandshakeCommandInput, - cb: (err: any, data?: AcceptHandshakeCommandOutput) => void - ): void; - public acceptHandshake( + acceptHandshake(args: AcceptHandshakeCommandInput, cb: (err: any, data?: AcceptHandshakeCommandOutput) => void): void; + acceptHandshake( args: AcceptHandshakeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptHandshakeCommandOutput) => void ): void; - public acceptHandshake( - args: AcceptHandshakeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptHandshakeCommandOutput) => void), - cb?: (err: any, data?: AcceptHandshakeCommandOutput) => void - ): Promise | void { - const command = new AcceptHandshakeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Attaches a policy to a root, an organizational unit (OU), or an individual account. - * How the policy affects accounts depends on the type of policy. Refer to the - * Organizations User Guide for information about each policy type:

- * - *

This operation can be called only from the organization's management account.

+ * @see {@link AttachPolicyCommand} */ - public attachPolicy( - args: AttachPolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public attachPolicy(args: AttachPolicyCommandInput, cb: (err: any, data?: AttachPolicyCommandOutput) => void): void; - public attachPolicy( + attachPolicy(args: AttachPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + attachPolicy(args: AttachPolicyCommandInput, cb: (err: any, data?: AttachPolicyCommandOutput) => void): void; + attachPolicy( args: AttachPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachPolicyCommandOutput) => void ): void; - public attachPolicy( - args: AttachPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachPolicyCommandOutput) => void), - cb?: (err: any, data?: AttachPolicyCommandOutput) => void - ): Promise | void { - const command = new AttachPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels a handshake. Canceling a handshake sets the handshake state to - * CANCELED.

- *

This operation can be called only from the account that originated the handshake. The recipient of the handshake can't cancel it, but can use DeclineHandshake instead. After a handshake is canceled, the recipient - * can no longer respond to that handshake.

- *

After you cancel a handshake, it continues to appear in the results of relevant APIs - * for only 30 days. After that, it's deleted.

+ * @see {@link CancelHandshakeCommand} */ - public cancelHandshake( + cancelHandshake( args: CancelHandshakeCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelHandshake( - args: CancelHandshakeCommandInput, - cb: (err: any, data?: CancelHandshakeCommandOutput) => void - ): void; - public cancelHandshake( + cancelHandshake(args: CancelHandshakeCommandInput, cb: (err: any, data?: CancelHandshakeCommandOutput) => void): void; + cancelHandshake( args: CancelHandshakeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelHandshakeCommandOutput) => void ): void; - public cancelHandshake( - args: CancelHandshakeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelHandshakeCommandOutput) => void), - cb?: (err: any, data?: CancelHandshakeCommandOutput) => void - ): Promise | void { - const command = new CancelHandshakeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Closes an Amazon Web Services member account within an organization. You can close an account when - * all - * features are enabled . You can't close the management account with this API. - * This is an asynchronous request that Amazon Web Services performs in the background. Because - * CloseAccount operates asynchronously, it can return a successful - * completion message even though account closure might still be in progress. You need to - * wait a few minutes before the account is fully closed. To check the status of the - * request, do one of the following:

- *
    - *
  • - *

    Use the AccountId that you sent in the CloseAccount - * request to provide as a parameter to the DescribeAccount - * operation.

    - *

    While the close account request is in progress, Account status will indicate - * PENDING_CLOSURE. When the close account request completes, the status will - * change to SUSPENDED.

    - *
  • - *
  • - *

    Check the CloudTrail log for the CloseAccountResult event that gets - * published after the account closes successfully. For information on using CloudTrail - * with Organizations, see Logging and monitoring in Organizations in the - * Organizations User Guide. - *

    - *
  • - *
- * - *
    - *
  • - *

    You can close only 10% of member accounts, between 10 and 200, within a - * rolling 30 day period. This quota is not bound by a calendar month, but - * starts when you close an account.

    - *

    After you reach this limit, you can close additional accounts in the - * Billing console. For more information, see Closing an - * account in the Amazon Web Services Billing and Cost Management User Guide.

    - *
  • - *
  • - *

    To reinstate a closed account, contact Amazon Web Services Support within the 90-day - * grace period while the account is in SUSPENDED status.

    - *
  • - *
  • - *

    If the Amazon Web Services account you attempt to close is linked to an Amazon Web Services GovCloud - * (US) account, the CloseAccount request will close both - * accounts. To learn important pre-closure details, see - * Closing an Amazon Web Services GovCloud (US) account in the - * Amazon Web Services GovCloud User Guide.

    - *
  • - *
- *
- *

For more information about closing accounts, see Closing an - * Amazon Web Services account in the Organizations User Guide. - *

+ * @see {@link CloseAccountCommand} */ - public closeAccount( - args: CloseAccountCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public closeAccount(args: CloseAccountCommandInput, cb: (err: any, data?: CloseAccountCommandOutput) => void): void; - public closeAccount( + closeAccount(args: CloseAccountCommandInput, options?: __HttpHandlerOptions): Promise; + closeAccount(args: CloseAccountCommandInput, cb: (err: any, data?: CloseAccountCommandOutput) => void): void; + closeAccount( args: CloseAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CloseAccountCommandOutput) => void ): void; - public closeAccount( - args: CloseAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CloseAccountCommandOutput) => void), - cb?: (err: any, data?: CloseAccountCommandOutput) => void - ): Promise | void { - const command = new CloseAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Amazon Web Services account that is automatically a member of the organization whose - * credentials made the request. This is an asynchronous request that Amazon Web Services performs in the - * background. Because CreateAccount operates asynchronously, it can return a - * successful completion message even though account initialization might still be in - * progress. You might need to wait a few minutes before you can successfully access the - * account. To check the status of the request, do one of the following:

- *
    - *
  • - *

    Use the Id value of the CreateAccountStatus response - * element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.

    - *
  • - *
  • - *

    Check the CloudTrail log for the CreateAccountResult event. For - * information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the - * Organizations User Guide. - *

    - *
  • - *
- *

The user who calls the API to create an account must have the - * organizations:CreateAccount permission. If you enabled all features in - * the organization, Organizations creates the required service-linked role named - * AWSServiceRoleForOrganizations. For more information, see Organizations and Service-Linked Roles in the - * Organizations User Guide.

- *

If the request includes tags, then the requester must have the - * organizations:TagResource permission.

- *

Organizations preconfigures the new member account with a role (named - * OrganizationAccountAccessRole by default) that grants users in the - * management account administrator permissions in the new member account. Principals in - * the management account can assume the role. Organizations clones the company name and address - * information for the new account from the organization's management account.

- *

This operation can be called only from the organization's management account.

- *

For more information about creating accounts, see Creating an Amazon Web Services account in - * Your Organization in the Organizations User Guide. - *

- * - *
    - *
  • - *

    When you create an account in an organization using the Organizations console, - * API, or CLI commands, the information required for the account to operate - * as a standalone account, such as a payment method and signing the end user - * license agreement (EULA) is not automatically - * collected. If you must remove an account from your organization later, you - * can do so only after you provide the missing information. Follow the steps - * at To leave an organization as a member account in the - * Organizations User Guide.

    - *
  • - *
  • - *

    If you get an exception that indicates that you exceeded your account - * limits for the organization, contact Amazon Web Services Support.

    - *
  • - *
  • - *

    If you get an exception that indicates that the operation failed because - * your organization is still initializing, wait one hour and then try again. - * If the error persists, contact Amazon Web Services Support.

    - *
  • - *
  • - *

    Using CreateAccount to create multiple temporary accounts - * isn't recommended. You can only close an account from the Billing and Cost Management console, and - * you must be signed in as the root user. For information on the requirements - * and process for closing an account, see Closing an - * Amazon Web Services account in the - * Organizations User Guide.

    - *
  • - *
- *
- * - *

When you create a member account with this operation, you can choose whether to - * create the account with the IAM User and Role Access to - * Billing Information switch enabled. If you enable it, IAM users and - * roles that have appropriate permissions can view billing information for the - * account. If you disable it, only the account root user can access billing - * information. For information about how to disable this switch for an account, see - * Granting - * Access to Your Billing Information and Tools.

- *
+ * @see {@link CreateAccountCommand} */ - public createAccount( - args: CreateAccountCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createAccount( - args: CreateAccountCommandInput, - cb: (err: any, data?: CreateAccountCommandOutput) => void - ): void; - public createAccount( + createAccount(args: CreateAccountCommandInput, options?: __HttpHandlerOptions): Promise; + createAccount(args: CreateAccountCommandInput, cb: (err: any, data?: CreateAccountCommandOutput) => void): void; + createAccount( args: CreateAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccountCommandOutput) => void ): void; - public createAccount( - args: CreateAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAccountCommandOutput) => void), - cb?: (err: any, data?: CreateAccountCommandOutput) => void - ): Promise | void { - const command = new CreateAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This action is available if all of the following are true:

- *
    - *
  • - *

    You're authorized to create accounts in the Amazon Web Services GovCloud (US) Region. For - * more information on the Amazon Web Services GovCloud (US) Region, see the - * Amazon Web Services GovCloud User Guide. - *

    - *
  • - *
  • - *

    You already have an account in the Amazon Web Services GovCloud (US) Region that is paired - * with a management account of an organization in the commercial Region.

    - *
  • - *
  • - *

    You call this action from the management account of your organization in the - * commercial Region.

    - *
  • - *
  • - *

    You have the organizations:CreateGovCloudAccount permission. - *

    - *
  • - *
- *

Organizations automatically creates the required service-linked role named - * AWSServiceRoleForOrganizations. For more information, see Organizations and Service-Linked Roles in the - * Organizations User Guide. - *

- *

Amazon Web Services automatically enables CloudTrail for Amazon Web Services GovCloud (US) accounts, but you should also - * do the following:

- *
    - *
  • - *

    Verify that CloudTrail is enabled to store logs.

    - *
  • - *
  • - *

    Create an Amazon S3 bucket for CloudTrail log storage.

    - *

    For more information, see Verifying CloudTrail Is - * Enabled in the Amazon Web Services GovCloud User Guide. - *

    - *
  • - *
- *

If the request includes tags, then the requester must have the - * organizations:TagResource permission. The tags are attached to the - * commercial account associated with the GovCloud account, rather than the GovCloud - * account itself. To add tags to the GovCloud account, call the TagResource operation in the GovCloud Region after the new GovCloud - * account exists.

- *

You call this action from the management account of your organization in the - * commercial Region to create a standalone Amazon Web Services account in the Amazon Web Services GovCloud (US) - * Region. After the account is created, the management account of an organization in the - * Amazon Web Services GovCloud (US) Region can invite it to that organization. For more information on - * inviting standalone accounts in the Amazon Web Services GovCloud (US) to join an organization, see - * Organizations in the - * Amazon Web Services GovCloud User Guide. - *

- *

Calling CreateGovCloudAccount is an asynchronous request that Amazon Web Services - * performs in the background. Because CreateGovCloudAccount operates - * asynchronously, it can return a successful completion message even though account - * initialization might still be in progress. You might need to wait a few minutes before - * you can successfully access the account. To check the status of the request, do one of - * the following:

- *
    - *
  • - *

    Use the OperationId response element from this operation to - * provide as a parameter to the DescribeCreateAccountStatus - * operation.

    - *
  • - *
  • - *

    Check the CloudTrail log for the CreateAccountResult event. For - * information on using CloudTrail with Organizations, see Monitoring the Activity in Your - * Organization in the Organizations User Guide. - *

    - *
  • - *
- *

- *

When you call the CreateGovCloudAccount action, you create two accounts: - * a standalone account in the Amazon Web Services GovCloud (US) Region and an associated account in the - * commercial Region for billing and support purposes. The account in the commercial Region - * is automatically a member of the organization whose credentials made the request. Both - * accounts are associated with the same email address.

- *

A role is created in the new account in the commercial Region that allows the - * management account in the organization in the commercial Region to assume it. An Amazon Web Services - * GovCloud (US) account is then created and associated with the commercial account that - * you just created. A role is also created in the new Amazon Web Services GovCloud (US) account that can - * be assumed by the Amazon Web Services GovCloud (US) account that is associated with the management - * account of the commercial organization. For more information and to view a diagram that - * explains how account access works, see Organizations in the - * Amazon Web Services GovCloud User Guide. - *

- *

For more information about creating accounts, see Creating - * an Amazon Web Services account in Your Organization in the - * Organizations User Guide. - *

- * - *
    - *
  • - *

    When you create an account in an organization using the Organizations console, - * API, or CLI commands, the information required for the account to operate as - * a standalone account is not automatically collected. - * This includes a payment method and signing the end user license agreement - * (EULA). If you must remove an account from your organization later, you can - * do so only after you provide the missing information. Follow the steps at - * To leave an organization as a member account in the - * Organizations User Guide. - *

    - *
  • - *
  • - *

    If you get an exception that indicates that you exceeded your account - * limits for the organization, contact Amazon Web Services Support.

    - *
  • - *
  • - *

    If you get an exception that indicates that the operation failed because - * your organization is still initializing, wait one hour and then try again. - * If the error persists, contact Amazon Web Services Support.

    - *
  • - *
  • - *

    Using CreateGovCloudAccount to create multiple temporary - * accounts isn't recommended. You can only close an account from the Amazon Web Services - * Billing and Cost Management console, and you must be signed in as the root user. For information on - * the requirements and process for closing an account, see Closing an - * Amazon Web Services account in the - * Organizations User Guide.

    - *
  • - *
- *
- * - *

When you create a member account with this operation, you can choose whether to - * create the account with the IAM User and Role Access to - * Billing Information switch enabled. If you enable it, IAM users and - * roles that have appropriate permissions can view billing information for the - * account. If you disable it, only the account root user can access billing - * information. For information about how to disable this switch for an account, see - * Granting - * Access to Your Billing Information and Tools.

- *
+ * @see {@link CreateGovCloudAccountCommand} */ - public createGovCloudAccount( + createGovCloudAccount( args: CreateGovCloudAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public createGovCloudAccount( + createGovCloudAccount( args: CreateGovCloudAccountCommandInput, cb: (err: any, data?: CreateGovCloudAccountCommandOutput) => void ): void; - public createGovCloudAccount( + createGovCloudAccount( args: CreateGovCloudAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGovCloudAccountCommandOutput) => void ): void; - public createGovCloudAccount( - args: CreateGovCloudAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGovCloudAccountCommandOutput) => void), - cb?: (err: any, data?: CreateGovCloudAccountCommandOutput) => void - ): Promise | void { - const command = new CreateGovCloudAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Amazon Web Services organization. The account whose user is calling the - * CreateOrganization operation automatically becomes the management account of the new organization.

- *

This operation must be called using credentials from the account that is to become the - * new organization's management account. The principal must also have the relevant IAM - * permissions.

- *

By default (or if you set the FeatureSet parameter to ALL), - * the new organization is created with all features enabled and service control policies - * automatically enabled in the root. If you instead choose to create the organization - * supporting only the consolidated billing features by setting the FeatureSet - * parameter to CONSOLIDATED_BILLING", no policy types are enabled by default, - * and you can't use organization policies

+ * @see {@link CreateOrganizationCommand} */ - public createOrganization( + createOrganization( args: CreateOrganizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createOrganization( + createOrganization( args: CreateOrganizationCommandInput, cb: (err: any, data?: CreateOrganizationCommandOutput) => void ): void; - public createOrganization( + createOrganization( args: CreateOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateOrganizationCommandOutput) => void ): void; - public createOrganization( - args: CreateOrganizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateOrganizationCommandOutput) => void), - cb?: (err: any, data?: CreateOrganizationCommandOutput) => void - ): Promise | void { - const command = new CreateOrganizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an organizational unit (OU) within a root or parent OU. An OU is a container - * for accounts that enables you to organize your accounts to apply policies according to - * your business requirements. The number of levels deep that you can nest OUs is dependent - * upon the policy types enabled for that root. For service control policies, the limit is - * five.

- *

For more information about OUs, see Managing Organizational Units in the - * Organizations User Guide. - *

- *

If the request includes tags, then the requester must have the - * organizations:TagResource permission.

- *

This operation can be called only from the organization's management account.

+ * @see {@link CreateOrganizationalUnitCommand} */ - public createOrganizationalUnit( + createOrganizationalUnit( args: CreateOrganizationalUnitCommandInput, options?: __HttpHandlerOptions ): Promise; - public createOrganizationalUnit( + createOrganizationalUnit( args: CreateOrganizationalUnitCommandInput, cb: (err: any, data?: CreateOrganizationalUnitCommandOutput) => void ): void; - public createOrganizationalUnit( + createOrganizationalUnit( args: CreateOrganizationalUnitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateOrganizationalUnitCommandOutput) => void ): void; - public createOrganizationalUnit( - args: CreateOrganizationalUnitCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateOrganizationalUnitCommandOutput) => void), - cb?: (err: any, data?: CreateOrganizationalUnitCommandOutput) => void - ): Promise | void { - const command = new CreateOrganizationalUnitCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a policy of a specified type that you can attach to a root, an organizational - * unit (OU), or an individual Amazon Web Services account.

- *

For more information about policies and their use, see Managing - * Organization Policies.

- *

If the request includes tags, then the requester must have the - * organizations:TagResource permission.

- *

This operation can be called only from the organization's management account.

+ * @see {@link CreatePolicyCommand} */ - public createPolicy( - args: CreatePolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createPolicy(args: CreatePolicyCommandInput, cb: (err: any, data?: CreatePolicyCommandOutput) => void): void; - public createPolicy( + createPolicy(args: CreatePolicyCommandInput, options?: __HttpHandlerOptions): Promise; + createPolicy(args: CreatePolicyCommandInput, cb: (err: any, data?: CreatePolicyCommandOutput) => void): void; + createPolicy( args: CreatePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePolicyCommandOutput) => void ): void; - public createPolicy( - args: CreatePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePolicyCommandOutput) => void), - cb?: (err: any, data?: CreatePolicyCommandOutput) => void - ): Promise | void { - const command = new CreatePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Declines a handshake request. This sets the handshake state to DECLINED - * and effectively deactivates the request.

- *

This operation can be called only from the account that received the handshake. The originator of the handshake can use CancelHandshake - * instead. The originator can't reactivate a declined request, but can reinitiate the - * process with a new handshake request.

- *

After you decline a handshake, it continues to appear in the results of relevant APIs - * for only 30 days. After that, it's deleted.

+ * @see {@link DeclineHandshakeCommand} */ - public declineHandshake( + declineHandshake( args: DeclineHandshakeCommandInput, options?: __HttpHandlerOptions ): Promise; - public declineHandshake( + declineHandshake( args: DeclineHandshakeCommandInput, cb: (err: any, data?: DeclineHandshakeCommandOutput) => void ): void; - public declineHandshake( + declineHandshake( args: DeclineHandshakeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeclineHandshakeCommandOutput) => void ): void; - public declineHandshake( - args: DeclineHandshakeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeclineHandshakeCommandOutput) => void), - cb?: (err: any, data?: DeclineHandshakeCommandOutput) => void - ): Promise | void { - const command = new DeclineHandshakeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the organization. You can delete an organization only by using credentials - * from the management account. The organization must be empty of member accounts.

+ * @see {@link DeleteOrganizationCommand} */ - public deleteOrganization( + deleteOrganization( args: DeleteOrganizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteOrganization( + deleteOrganization( args: DeleteOrganizationCommandInput, cb: (err: any, data?: DeleteOrganizationCommandOutput) => void ): void; - public deleteOrganization( + deleteOrganization( args: DeleteOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOrganizationCommandOutput) => void ): void; - public deleteOrganization( - args: DeleteOrganizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteOrganizationCommandOutput) => void), - cb?: (err: any, data?: DeleteOrganizationCommandOutput) => void - ): Promise | void { - const command = new DeleteOrganizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an organizational unit (OU) from a root or another OU. You must first remove - * all accounts and child OUs from the OU that you want to delete.

- *

This operation can be called only from the organization's management account.

+ * @see {@link DeleteOrganizationalUnitCommand} */ - public deleteOrganizationalUnit( + deleteOrganizationalUnit( args: DeleteOrganizationalUnitCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteOrganizationalUnit( + deleteOrganizationalUnit( args: DeleteOrganizationalUnitCommandInput, cb: (err: any, data?: DeleteOrganizationalUnitCommandOutput) => void ): void; - public deleteOrganizationalUnit( + deleteOrganizationalUnit( args: DeleteOrganizationalUnitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOrganizationalUnitCommandOutput) => void ): void; - public deleteOrganizationalUnit( - args: DeleteOrganizationalUnitCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteOrganizationalUnitCommandOutput) => void), - cb?: (err: any, data?: DeleteOrganizationalUnitCommandOutput) => void - ): Promise | void { - const command = new DeleteOrganizationalUnitCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified policy from your organization. Before you perform this - * operation, you must first detach the policy from all organizational units (OUs), roots, - * and accounts.

- *

This operation can be called only from the organization's management account.

+ * @see {@link DeletePolicyCommand} */ - public deletePolicy( - args: DeletePolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deletePolicy(args: DeletePolicyCommandInput, cb: (err: any, data?: DeletePolicyCommandOutput) => void): void; - public deletePolicy( + deletePolicy(args: DeletePolicyCommandInput, options?: __HttpHandlerOptions): Promise; + deletePolicy(args: DeletePolicyCommandInput, cb: (err: any, data?: DeletePolicyCommandOutput) => void): void; + deletePolicy( args: DeletePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePolicyCommandOutput) => void ): void; - public deletePolicy( - args: DeletePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePolicyCommandOutput) => void), - cb?: (err: any, data?: DeletePolicyCommandOutput) => void - ): Promise | void { - const command = new DeletePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the resource policy from your organization.

- *

You can only call this operation from the organization's management account.

+ * @see {@link DeleteResourcePolicyCommand} */ - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( - args: DeleteResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified member Amazon Web Services account as a delegated administrator for the - * specified Amazon Web Services service.

- * - *

Deregistering a delegated administrator can have unintended impacts on the - * functionality of the enabled Amazon Web Services service. See the documentation for the enabled - * service before you deregister a delegated administrator so that you understand any - * potential impacts.

- *
- *

You can run this action only for Amazon Web Services services that support this - * feature. For a current list of services that support it, see the column Supports - * Delegated Administrator in the table at Amazon Web Services Services that you can use with - * Organizations in the Organizations User Guide. - *

- *

This operation can be called only from the organization's management account.

+ * @see {@link DeregisterDelegatedAdministratorCommand} */ - public deregisterDelegatedAdministrator( + deregisterDelegatedAdministrator( args: DeregisterDelegatedAdministratorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterDelegatedAdministrator( + deregisterDelegatedAdministrator( args: DeregisterDelegatedAdministratorCommandInput, cb: (err: any, data?: DeregisterDelegatedAdministratorCommandOutput) => void ): void; - public deregisterDelegatedAdministrator( + deregisterDelegatedAdministrator( args: DeregisterDelegatedAdministratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterDelegatedAdministratorCommandOutput) => void ): void; - public deregisterDelegatedAdministrator( - args: DeregisterDelegatedAdministratorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterDelegatedAdministratorCommandOutput) => void), - cb?: (err: any, data?: DeregisterDelegatedAdministratorCommandOutput) => void - ): Promise | void { - const command = new DeregisterDelegatedAdministratorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves Organizations-related information about the specified account.

- *

This operation can be called only from the organization's - * management account or by a member account that is a delegated administrator for an Amazon Web Services service.

+ * @see {@link DescribeAccountCommand} */ - public describeAccount( + describeAccount( args: DescribeAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccount( - args: DescribeAccountCommandInput, - cb: (err: any, data?: DescribeAccountCommandOutput) => void - ): void; - public describeAccount( + describeAccount(args: DescribeAccountCommandInput, cb: (err: any, data?: DescribeAccountCommandOutput) => void): void; + describeAccount( args: DescribeAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountCommandOutput) => void ): void; - public describeAccount( - args: DescribeAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccountCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the current status of an asynchronous request to create an account.

- *

This operation can be called only from the organization's - * management account or by a member account that is a delegated administrator for an Amazon Web Services service.

+ * @see {@link DescribeCreateAccountStatusCommand} */ - public describeCreateAccountStatus( + describeCreateAccountStatus( args: DescribeCreateAccountStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCreateAccountStatus( + describeCreateAccountStatus( args: DescribeCreateAccountStatusCommandInput, cb: (err: any, data?: DescribeCreateAccountStatusCommandOutput) => void ): void; - public describeCreateAccountStatus( + describeCreateAccountStatus( args: DescribeCreateAccountStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCreateAccountStatusCommandOutput) => void ): void; - public describeCreateAccountStatus( - args: DescribeCreateAccountStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCreateAccountStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeCreateAccountStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeCreateAccountStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the contents of the effective policy for specified policy type and account. - * The effective policy is the aggregation of any policies of the specified type that the - * account inherits, plus any policy of that type that is directly attached to the - * account.

- *

This operation applies only to policy types other than service - * control policies (SCPs).

- *

For more information about policy inheritance, see How Policy Inheritance - * Works in the Organizations User Guide.

- *

This operation can be called only from the organization's - * management account or by a member account that is a delegated administrator for an Amazon Web Services service.

+ * @see {@link DescribeEffectivePolicyCommand} */ - public describeEffectivePolicy( + describeEffectivePolicy( args: DescribeEffectivePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEffectivePolicy( + describeEffectivePolicy( args: DescribeEffectivePolicyCommandInput, cb: (err: any, data?: DescribeEffectivePolicyCommandOutput) => void ): void; - public describeEffectivePolicy( + describeEffectivePolicy( args: DescribeEffectivePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEffectivePolicyCommandOutput) => void ): void; - public describeEffectivePolicy( - args: DescribeEffectivePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEffectivePolicyCommandOutput) => void), - cb?: (err: any, data?: DescribeEffectivePolicyCommandOutput) => void - ): Promise | void { - const command = new DescribeEffectivePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a previously requested handshake. The handshake ID comes - * from the response to the original InviteAccountToOrganization - * operation that generated the handshake.

- *

You can access handshakes that are ACCEPTED, DECLINED, or - * CANCELED for only 30 days after they change to that state. They're then - * deleted and no longer accessible.

- *

This operation can be called from any account in the organization.

+ * @see {@link DescribeHandshakeCommand} */ - public describeHandshake( + describeHandshake( args: DescribeHandshakeCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeHandshake( + describeHandshake( args: DescribeHandshakeCommandInput, cb: (err: any, data?: DescribeHandshakeCommandOutput) => void ): void; - public describeHandshake( + describeHandshake( args: DescribeHandshakeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHandshakeCommandOutput) => void ): void; - public describeHandshake( - args: DescribeHandshakeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeHandshakeCommandOutput) => void), - cb?: (err: any, data?: DescribeHandshakeCommandOutput) => void - ): Promise | void { - const command = new DescribeHandshakeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the organization that the user's account belongs - * to.

- *

This operation can be called from any account in the organization.

- * - *

Even if a policy type is shown as available in the organization, you can disable - * it separately at the root level with DisablePolicyType. Use ListRoots to see the status of policy types for a specified - * root.

- *
+ * @see {@link DescribeOrganizationCommand} */ - public describeOrganization( + describeOrganization( args: DescribeOrganizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOrganization( + describeOrganization( args: DescribeOrganizationCommandInput, cb: (err: any, data?: DescribeOrganizationCommandOutput) => void ): void; - public describeOrganization( + describeOrganization( args: DescribeOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrganizationCommandOutput) => void ): void; - public describeOrganization( - args: DescribeOrganizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOrganizationCommandOutput) => void), - cb?: (err: any, data?: DescribeOrganizationCommandOutput) => void - ): Promise | void { - const command = new DescribeOrganizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about an organizational unit (OU).

- *

This operation can be called only from the organization's - * management account or by a member account that is a delegated administrator for an Amazon Web Services service.

+ * @see {@link DescribeOrganizationalUnitCommand} */ - public describeOrganizationalUnit( + describeOrganizationalUnit( args: DescribeOrganizationalUnitCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOrganizationalUnit( + describeOrganizationalUnit( args: DescribeOrganizationalUnitCommandInput, cb: (err: any, data?: DescribeOrganizationalUnitCommandOutput) => void ): void; - public describeOrganizationalUnit( + describeOrganizationalUnit( args: DescribeOrganizationalUnitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrganizationalUnitCommandOutput) => void ): void; - public describeOrganizationalUnit( - args: DescribeOrganizationalUnitCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOrganizationalUnitCommandOutput) => void), - cb?: (err: any, data?: DescribeOrganizationalUnitCommandOutput) => void - ): Promise | void { - const command = new DescribeOrganizationalUnitCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a policy.

- *

This operation can be called only from the organization's - * management account or by a member account that is a delegated administrator for an Amazon Web Services service.

+ * @see {@link DescribePolicyCommand} */ - public describePolicy( + describePolicy( args: DescribePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePolicy( - args: DescribePolicyCommandInput, - cb: (err: any, data?: DescribePolicyCommandOutput) => void - ): void; - public describePolicy( + describePolicy(args: DescribePolicyCommandInput, cb: (err: any, data?: DescribePolicyCommandOutput) => void): void; + describePolicy( args: DescribePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePolicyCommandOutput) => void ): void; - public describePolicy( - args: DescribePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePolicyCommandOutput) => void), - cb?: (err: any, data?: DescribePolicyCommandOutput) => void - ): Promise | void { - const command = new DescribePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a resource policy.

- *

You can only call this operation from the organization's management account or by a - * member account that is a delegated administrator for an Amazon Web Services service.

+ * @see {@link DescribeResourcePolicyCommand} */ - public describeResourcePolicy( + describeResourcePolicy( args: DescribeResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeResourcePolicy( + describeResourcePolicy( args: DescribeResourcePolicyCommandInput, cb: (err: any, data?: DescribeResourcePolicyCommandOutput) => void ): void; - public describeResourcePolicy( + describeResourcePolicy( args: DescribeResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeResourcePolicyCommandOutput) => void ): void; - public describeResourcePolicy( - args: DescribeResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: DescribeResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new DescribeResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Detaches a policy from a target root, organizational unit (OU), or account.

- * - *

If the policy being detached is a service control policy (SCP), the changes to - * permissions for Identity and Access Management (IAM) users and roles in affected accounts are - * immediate.

- *
- *

Every root, OU, and account must have at least one SCP attached. If you want to - * replace the default FullAWSAccess policy with an SCP that limits the - * permissions that can be delegated, you must attach the replacement SCP before you can - * remove the default SCP. This is the authorization strategy of an "allow list". If you instead attach a second SCP and - * leave the FullAWSAccess SCP still attached, and specify "Effect": - * "Deny" in the second SCP to override the "Effect": "Allow" in - * the FullAWSAccess policy (or any other attached SCP), you're using the - * authorization strategy of a "deny list".

- *

This operation can be called only from the organization's management account.

+ * @see {@link DetachPolicyCommand} */ - public detachPolicy( - args: DetachPolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public detachPolicy(args: DetachPolicyCommandInput, cb: (err: any, data?: DetachPolicyCommandOutput) => void): void; - public detachPolicy( + detachPolicy(args: DetachPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + detachPolicy(args: DetachPolicyCommandInput, cb: (err: any, data?: DetachPolicyCommandOutput) => void): void; + detachPolicy( args: DetachPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachPolicyCommandOutput) => void ): void; - public detachPolicy( - args: DetachPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachPolicyCommandOutput) => void), - cb?: (err: any, data?: DetachPolicyCommandOutput) => void - ): Promise | void { - const command = new DetachPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables the integration of an Amazon Web Services service (the service that is specified by - * ServicePrincipal) with Organizations. When you disable integration, the - * specified service no longer can create a service-linked role in - * new accounts in your organization. This means the service can't - * perform operations on your behalf on any new accounts in your organization. The service - * can still perform operations in older accounts until the service completes its clean-up - * from Organizations.

- * - *

We - * strongly recommend - * that - * you don't use this command to disable integration between Organizations and the specified - * Amazon Web Services service. Instead, use the console or commands that are provided by the - * specified service. This lets the trusted service perform any required initialization - * when enabling trusted access, such as creating any required resources and any - * required clean up of resources when disabling trusted access.

- *

For information about how to disable trusted service access to your organization - * using the trusted service, see the Learn more link - * under the Supports Trusted Access column at Amazon Web Services services that you can use with Organizations. on this page.

- *

If you disable access by using this command, it causes the following actions to - * occur:

- *
    - *
  • - *

    The service can no longer create a service-linked role in the accounts in - * your organization. This means that the service can't perform operations on - * your behalf on any new accounts in your organization. The service can still - * perform operations in older accounts until the service completes its - * clean-up from Organizations.

    - *
  • - *
  • - *

    The service can no longer perform tasks in the member accounts in the - * organization, unless those operations are explicitly permitted by the IAM - * policies that are attached to your roles. This includes any data aggregation - * from the member accounts to the management account, or to a delegated - * administrator account, where relevant.

    - *
  • - *
  • - *

    Some services detect this and clean up any remaining data or resources - * related to the integration, while other services stop accessing the - * organization but leave any historical data and configuration in place to - * support a possible re-enabling of the integration.

    - *
  • - *
- *

Using the other service's console or commands to disable the integration ensures - * that the other service is aware that it can clean up any resources that are required - * only for the integration. How the service cleans up its resources in the - * organization's accounts depends on that service. For more information, see the - * documentation for the other Amazon Web Services service.

- *
- *

After you perform the DisableAWSServiceAccess operation, the specified - * service can no longer perform operations in your organization's accounts

- *

For more information about integrating other services with Organizations, including the - * list of services that work with Organizations, see Integrating Organizations with Other - * Amazon Web Services Services in the Organizations User Guide. - *

- *

This operation can be called only from the organization's management account.

+ * @see {@link DisableAWSServiceAccessCommand} */ - public disableAWSServiceAccess( + disableAWSServiceAccess( args: DisableAWSServiceAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableAWSServiceAccess( + disableAWSServiceAccess( args: DisableAWSServiceAccessCommandInput, cb: (err: any, data?: DisableAWSServiceAccessCommandOutput) => void ): void; - public disableAWSServiceAccess( + disableAWSServiceAccess( args: DisableAWSServiceAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableAWSServiceAccessCommandOutput) => void ): void; - public disableAWSServiceAccess( - args: DisableAWSServiceAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableAWSServiceAccessCommandOutput) => void), - cb?: (err: any, data?: DisableAWSServiceAccessCommandOutput) => void - ): Promise | void { - const command = new DisableAWSServiceAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables an organizational policy type in a root. A policy of a certain type can be - * attached to entities in a root only if that type is enabled in the root. After you - * perform this operation, you no longer can attach policies of the specified type to that - * root or to any organizational unit (OU) or account in that root. You can undo this by - * using the EnablePolicyType operation.

- *

This is an asynchronous request that Amazon Web Services performs in the background. If you disable - * a policy type for a root, it still appears enabled for the organization if all features are enabled for the organization. Amazon Web Services recommends that you - * first use ListRoots to see the status of policy types for a specified - * root, and then use this operation.

- *

This operation can be called only from the organization's management account.

- *

To view the status of available policy types in the organization, use DescribeOrganization.

+ * @see {@link DisablePolicyTypeCommand} */ - public disablePolicyType( + disablePolicyType( args: DisablePolicyTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public disablePolicyType( + disablePolicyType( args: DisablePolicyTypeCommandInput, cb: (err: any, data?: DisablePolicyTypeCommandOutput) => void ): void; - public disablePolicyType( + disablePolicyType( args: DisablePolicyTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisablePolicyTypeCommandOutput) => void ): void; - public disablePolicyType( - args: DisablePolicyTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisablePolicyTypeCommandOutput) => void), - cb?: (err: any, data?: DisablePolicyTypeCommandOutput) => void - ): Promise | void { - const command = new DisablePolicyTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables all features in an organization. This enables the use of organization policies - * that can restrict the services and actions that can be called in each account. Until you - * enable all features, you have access only to consolidated billing, and you can't use any - * of the advanced account administration features that Organizations supports. For more - * information, see Enabling All Features in Your Organization in the - * Organizations User Guide. - *

- * - *

This operation is required only for organizations that were created explicitly - * with only the consolidated billing features enabled. Calling this operation sends a - * handshake to every invited account in the organization. The feature set change can - * be finalized and the additional features enabled only after all administrators in - * the invited accounts approve the change by accepting the handshake.

- *
- *

After you enable all features, you can separately enable or disable individual policy - * types in a root using EnablePolicyType and DisablePolicyType. To see the status of policy types in a root, use - * ListRoots.

- *

After all invited member accounts accept the handshake, you finalize the feature set - * change by accepting the handshake that contains "Action": - * "ENABLE_ALL_FEATURES". This completes the change.

- *

After you enable all features in your organization, the management account in the - * organization can apply policies on all member accounts. These policies can restrict what - * users and even administrators in those accounts can do. The management account can apply - * policies that prevent accounts from leaving the organization. Ensure that your account - * administrators are aware of this.

- *

This operation can be called only from the organization's management account.

+ * @see {@link EnableAllFeaturesCommand} */ - public enableAllFeatures( + enableAllFeatures( args: EnableAllFeaturesCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableAllFeatures( + enableAllFeatures( args: EnableAllFeaturesCommandInput, cb: (err: any, data?: EnableAllFeaturesCommandOutput) => void ): void; - public enableAllFeatures( + enableAllFeatures( args: EnableAllFeaturesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableAllFeaturesCommandOutput) => void ): void; - public enableAllFeatures( - args: EnableAllFeaturesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableAllFeaturesCommandOutput) => void), - cb?: (err: any, data?: EnableAllFeaturesCommandOutput) => void - ): Promise | void { - const command = new EnableAllFeaturesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the integration of an Amazon Web Services service (the service that is specified by - * ServicePrincipal) with Organizations. When you enable integration, you allow - * the specified service to create a service-linked role in - * all the accounts in your organization. This allows the service to perform operations on - * your behalf in your organization and its accounts.

- * - *

We recommend that you enable integration between Organizations and the specified Amazon Web Services - * service by using the console or commands that are provided by the specified service. - * Doing so ensures that the service is aware that it can create the resources that are - * required for the integration. How the service creates those resources in the - * organization's accounts depends on that service. For more information, see the - * documentation for the other Amazon Web Services service.

- *
- *

For more information about enabling services to integrate with Organizations, see Integrating - * Organizations with Other Amazon Web Services Services in the - * Organizations User Guide. - *

- *

You can only call this operation from the organization's management account and only - * if the organization has enabled all - * features.

+ * @see {@link EnableAWSServiceAccessCommand} */ - public enableAWSServiceAccess( + enableAWSServiceAccess( args: EnableAWSServiceAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableAWSServiceAccess( + enableAWSServiceAccess( args: EnableAWSServiceAccessCommandInput, cb: (err: any, data?: EnableAWSServiceAccessCommandOutput) => void ): void; - public enableAWSServiceAccess( + enableAWSServiceAccess( args: EnableAWSServiceAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableAWSServiceAccessCommandOutput) => void ): void; - public enableAWSServiceAccess( - args: EnableAWSServiceAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableAWSServiceAccessCommandOutput) => void), - cb?: (err: any, data?: EnableAWSServiceAccessCommandOutput) => void - ): Promise | void { - const command = new EnableAWSServiceAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables a policy type in a root. After you enable a policy type in a root, you can - * attach policies of that type to the root, any organizational unit (OU), or account in - * that root. You can undo this by using the DisablePolicyType - * operation.

- *

This is an asynchronous request that Amazon Web Services performs in the background. Amazon Web Services - * recommends that you first use ListRoots to see the status of policy - * types for a specified root, and then use this operation.

- *

This operation can be called only from the organization's management account.

- *

You can enable a policy type in a root only if that policy type is available in the - * organization. To view the status of available policy types in the organization, use - * DescribeOrganization.

+ * @see {@link EnablePolicyTypeCommand} */ - public enablePolicyType( + enablePolicyType( args: EnablePolicyTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public enablePolicyType( + enablePolicyType( args: EnablePolicyTypeCommandInput, cb: (err: any, data?: EnablePolicyTypeCommandOutput) => void ): void; - public enablePolicyType( + enablePolicyType( args: EnablePolicyTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnablePolicyTypeCommandOutput) => void ): void; - public enablePolicyType( - args: EnablePolicyTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnablePolicyTypeCommandOutput) => void), - cb?: (err: any, data?: EnablePolicyTypeCommandOutput) => void - ): Promise | void { - const command = new EnablePolicyTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sends an invitation to another account to join your organization as a member account. - * Organizations sends email on your behalf to the email address that is associated with the - * other account's owner. The invitation is implemented as a Handshake - * whose details are in the response.

- * - *
    - *
  • - *

    You can invite Amazon Web Services accounts only from the same seller as the management - * account. For example, if your organization's management account was created - * by Amazon Internet Services Pvt. Ltd (AISPL), an Amazon Web Services seller in India, you - * can invite only other AISPL accounts to your organization. You can't combine - * accounts from AISPL and Amazon Web Services or from any other Amazon Web Services seller. For more - * information, see Consolidated - * Billing in India.

    - *
  • - *
  • - *

    If you receive an exception that indicates that you exceeded your account - * limits for the organization or that the operation failed because your - * organization is still initializing, wait one hour and then try again. If the - * error persists after an hour, contact Amazon Web Services Support.

    - *
  • - *
- *
- *

If the request includes tags, then the requester must have the - * organizations:TagResource permission.

- *

This operation can be called only from the organization's management account.

+ * @see {@link InviteAccountToOrganizationCommand} */ - public inviteAccountToOrganization( + inviteAccountToOrganization( args: InviteAccountToOrganizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public inviteAccountToOrganization( + inviteAccountToOrganization( args: InviteAccountToOrganizationCommandInput, cb: (err: any, data?: InviteAccountToOrganizationCommandOutput) => void ): void; - public inviteAccountToOrganization( + inviteAccountToOrganization( args: InviteAccountToOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InviteAccountToOrganizationCommandOutput) => void ): void; - public inviteAccountToOrganization( - args: InviteAccountToOrganizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InviteAccountToOrganizationCommandOutput) => void), - cb?: (err: any, data?: InviteAccountToOrganizationCommandOutput) => void - ): Promise | void { - const command = new InviteAccountToOrganizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a member account from its parent organization. This version of the operation - * is performed by the account that wants to leave. To remove a member account as a user in - * the management account, use RemoveAccountFromOrganization - * instead.

- *

This operation can be called only from a member account in the organization.

- * - *
    - *
  • - *

    The management account in an organization with all features enabled can - * set service control policies (SCPs) that can restrict what administrators of - * member accounts can do. This includes preventing them from successfully - * calling LeaveOrganization and leaving the organization.

    - *
  • - *
  • - *

    You can leave an organization as a member account only if the account is - * configured with the information required to operate as a standalone account. - * When you create an account in an organization using the Organizations console, - * API, or CLI commands, the information required of standalone accounts is - * not automatically collected. For each account that - * you want to make standalone, you must perform the following steps. If any of - * the steps are already completed for this account, that step doesn't - * appear.

    - *
      - *
    • - *

      Choose a support plan

      - *
    • - *
    • - *

      Provide and verify the required contact information

      - *
    • - *
    • - *

      Provide a current payment method

      - *
    • - *
    - *

    Amazon Web Services uses the payment method to charge for any billable (not free tier) - * Amazon Web Services activity that occurs while the account isn't attached to an - * organization. Follow the steps at To leave an organization when all required account information has not - * yet been provided in the - * Organizations User Guide. - *

    - *
  • - *
  • - *

    The account that you want to leave must not be a delegated administrator - * account for any Amazon Web Services service enabled for your organization. If the account - * is a delegated administrator, you must first change the delegated - * administrator account to another account that is remaining in the - * organization.

    - *
  • - *
  • - *

    You can leave an organization only after you enable IAM user access to - * billing in your account. For more information, see Activating Access to the Billing and Cost Management Console in the - * Amazon Web Services Billing and Cost Management User Guide. - *

    - *
  • - *
  • - *

    After the account leaves the organization, all tags that were attached to - * the account object in the organization are deleted. Amazon Web Services accounts outside - * of an organization do not support tags.

    - *
  • - *
  • - *

    A newly created account has a waiting period before it can be removed from - * its organization. If you get an error that indicates that a wait period is - * required, then try again in a few days.

    - *
  • - *
- *
+ * @see {@link LeaveOrganizationCommand} */ - public leaveOrganization( + leaveOrganization( args: LeaveOrganizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public leaveOrganization( + leaveOrganization( args: LeaveOrganizationCommandInput, cb: (err: any, data?: LeaveOrganizationCommandOutput) => void ): void; - public leaveOrganization( + leaveOrganization( args: LeaveOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: LeaveOrganizationCommandOutput) => void ): void; - public leaveOrganization( - args: LeaveOrganizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: LeaveOrganizationCommandOutput) => void), - cb?: (err: any, data?: LeaveOrganizationCommandOutput) => void - ): Promise | void { - const command = new LeaveOrganizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the accounts in the organization. To request only the accounts in a - * specified root or organizational unit (OU), use the ListAccountsForParent operation instead.

- * - *

Always check the NextToken response parameter - * for a null value when calling a List* operation. These operations can - * occasionally return an empty set of results even when there are more results available. The - * NextToken response parameter value is null - * only - * when there are no more results to display.

- *
- *

This operation can be called only from the organization's - * management account or by a member account that is a delegated administrator for an Amazon Web Services service.

+ * @see {@link ListAccountsCommand} */ - public listAccounts( - args: ListAccountsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listAccounts(args: ListAccountsCommandInput, cb: (err: any, data?: ListAccountsCommandOutput) => void): void; - public listAccounts( + listAccounts(args: ListAccountsCommandInput, options?: __HttpHandlerOptions): Promise; + listAccounts(args: ListAccountsCommandInput, cb: (err: any, data?: ListAccountsCommandOutput) => void): void; + listAccounts( args: ListAccountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccountsCommandOutput) => void ): void; - public listAccounts( - args: ListAccountsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccountsCommandOutput) => void), - cb?: (err: any, data?: ListAccountsCommandOutput) => void - ): Promise | void { - const command = new ListAccountsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the accounts in an organization that are contained by the specified target root - * or organizational unit (OU). If you specify the root, you get a list of all the accounts - * that aren't in any OU. If you specify an OU, you get a list of all the accounts in only - * that OU and not in any child OUs. To get a list of all accounts in the organization, use - * the ListAccounts operation.

- * - *

Always check the NextToken response parameter - * for a null value when calling a List* operation. These operations can - * occasionally return an empty set of results even when there are more results available. The - * NextToken response parameter value is null - * only - * when there are no more results to display.

- *
- *

This operation can be called only from the organization's - * management account or by a member account that is a delegated administrator for an Amazon Web Services service.

+ * @see {@link ListAccountsForParentCommand} */ - public listAccountsForParent( + listAccountsForParent( args: ListAccountsForParentCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAccountsForParent( + listAccountsForParent( args: ListAccountsForParentCommandInput, cb: (err: any, data?: ListAccountsForParentCommandOutput) => void ): void; - public listAccountsForParent( + listAccountsForParent( args: ListAccountsForParentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccountsForParentCommandOutput) => void ): void; - public listAccountsForParent( - args: ListAccountsForParentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccountsForParentCommandOutput) => void), - cb?: (err: any, data?: ListAccountsForParentCommandOutput) => void - ): Promise | void { - const command = new ListAccountsForParentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the Amazon Web Services services that you enabled to integrate with your - * organization. After a service on this list creates the resources that it requires for - * the integration, it can perform operations on your organization and its accounts.

- *

For more information about integrating other services with Organizations, including the - * list of services that currently work with Organizations, see Integrating Organizations with Other - * Amazon Web Services Services in the Organizations User Guide. - *

- *

This operation can be called only from the organization's - * management account or by a member account that is a delegated administrator for an Amazon Web Services service.

+ * @see {@link ListAWSServiceAccessForOrganizationCommand} */ - public listAWSServiceAccessForOrganization( + listAWSServiceAccessForOrganization( args: ListAWSServiceAccessForOrganizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAWSServiceAccessForOrganization( + listAWSServiceAccessForOrganization( args: ListAWSServiceAccessForOrganizationCommandInput, cb: (err: any, data?: ListAWSServiceAccessForOrganizationCommandOutput) => void ): void; - public listAWSServiceAccessForOrganization( + listAWSServiceAccessForOrganization( args: ListAWSServiceAccessForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAWSServiceAccessForOrganizationCommandOutput) => void ): void; - public listAWSServiceAccessForOrganization( - args: ListAWSServiceAccessForOrganizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAWSServiceAccessForOrganizationCommandOutput) => void), - cb?: (err: any, data?: ListAWSServiceAccessForOrganizationCommandOutput) => void - ): Promise | void { - const command = new ListAWSServiceAccessForOrganizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all of the organizational units (OUs) or accounts that are contained in the - * specified parent OU or root. This operation, along with ListParents - * enables you to traverse the tree structure that makes up this root.

- * - *

Always check the NextToken response parameter - * for a null value when calling a List* operation. These operations can - * occasionally return an empty set of results even when there are more results available. The - * NextToken response parameter value is null - * only - * when there are no more results to display.

- *
- *

This operation can be called only from the organization's - * management account or by a member account that is a delegated administrator for an Amazon Web Services service.

+ * @see {@link ListChildrenCommand} */ - public listChildren( - args: ListChildrenCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listChildren(args: ListChildrenCommandInput, cb: (err: any, data?: ListChildrenCommandOutput) => void): void; - public listChildren( + listChildren(args: ListChildrenCommandInput, options?: __HttpHandlerOptions): Promise; + listChildren(args: ListChildrenCommandInput, cb: (err: any, data?: ListChildrenCommandOutput) => void): void; + listChildren( args: ListChildrenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChildrenCommandOutput) => void ): void; - public listChildren( - args: ListChildrenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListChildrenCommandOutput) => void), - cb?: (err: any, data?: ListChildrenCommandOutput) => void - ): Promise | void { - const command = new ListChildrenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the account creation requests that match the specified status that is currently - * being tracked for the organization.

- * - *

Always check the NextToken response parameter - * for a null value when calling a List* operation. These operations can - * occasionally return an empty set of results even when there are more results available. The - * NextToken response parameter value is null - * only - * when there are no more results to display.

- *
- *

This operation can be called only from the organization's - * management account or by a member account that is a delegated administrator for an Amazon Web Services service.

+ * @see {@link ListCreateAccountStatusCommand} */ - public listCreateAccountStatus( + listCreateAccountStatus( args: ListCreateAccountStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCreateAccountStatus( + listCreateAccountStatus( args: ListCreateAccountStatusCommandInput, cb: (err: any, data?: ListCreateAccountStatusCommandOutput) => void ): void; - public listCreateAccountStatus( + listCreateAccountStatus( args: ListCreateAccountStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCreateAccountStatusCommandOutput) => void ): void; - public listCreateAccountStatus( - args: ListCreateAccountStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCreateAccountStatusCommandOutput) => void), - cb?: (err: any, data?: ListCreateAccountStatusCommandOutput) => void - ): Promise | void { - const command = new ListCreateAccountStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the Amazon Web Services accounts that are designated as delegated administrators in this - * organization.

- *

This operation can be called only from the organization's - * management account or by a member account that is a delegated administrator for an Amazon Web Services service.

+ * @see {@link ListDelegatedAdministratorsCommand} */ - public listDelegatedAdministrators( + listDelegatedAdministrators( args: ListDelegatedAdministratorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDelegatedAdministrators( + listDelegatedAdministrators( args: ListDelegatedAdministratorsCommandInput, cb: (err: any, data?: ListDelegatedAdministratorsCommandOutput) => void ): void; - public listDelegatedAdministrators( + listDelegatedAdministrators( args: ListDelegatedAdministratorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDelegatedAdministratorsCommandOutput) => void ): void; - public listDelegatedAdministrators( - args: ListDelegatedAdministratorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDelegatedAdministratorsCommandOutput) => void), - cb?: (err: any, data?: ListDelegatedAdministratorsCommandOutput) => void - ): Promise | void { - const command = new ListDelegatedAdministratorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the Amazon Web Services services for which the specified account is a delegated - * administrator.

- *

This operation can be called only from the organization's - * management account or by a member account that is a delegated administrator for an Amazon Web Services service.

+ * @see {@link ListDelegatedServicesForAccountCommand} */ - public listDelegatedServicesForAccount( + listDelegatedServicesForAccount( args: ListDelegatedServicesForAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDelegatedServicesForAccount( + listDelegatedServicesForAccount( args: ListDelegatedServicesForAccountCommandInput, cb: (err: any, data?: ListDelegatedServicesForAccountCommandOutput) => void ): void; - public listDelegatedServicesForAccount( + listDelegatedServicesForAccount( args: ListDelegatedServicesForAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDelegatedServicesForAccountCommandOutput) => void ): void; - public listDelegatedServicesForAccount( - args: ListDelegatedServicesForAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDelegatedServicesForAccountCommandOutput) => void), - cb?: (err: any, data?: ListDelegatedServicesForAccountCommandOutput) => void - ): Promise | void { - const command = new ListDelegatedServicesForAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the current handshakes that are associated with the account of the requesting - * user.

- *

Handshakes that are ACCEPTED, DECLINED, - * CANCELED, or EXPIRED appear in the results of this API for - * only 30 days after changing to that state. After that, they're deleted and no longer - * accessible.

- * - *

Always check the NextToken response parameter - * for a null value when calling a List* operation. These operations can - * occasionally return an empty set of results even when there are more results available. The - * NextToken response parameter value is null - * only - * when there are no more results to display.

- *
- *

This operation can be called from any account in the organization.

+ * @see {@link ListHandshakesForAccountCommand} */ - public listHandshakesForAccount( + listHandshakesForAccount( args: ListHandshakesForAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public listHandshakesForAccount( + listHandshakesForAccount( args: ListHandshakesForAccountCommandInput, cb: (err: any, data?: ListHandshakesForAccountCommandOutput) => void ): void; - public listHandshakesForAccount( + listHandshakesForAccount( args: ListHandshakesForAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHandshakesForAccountCommandOutput) => void ): void; - public listHandshakesForAccount( - args: ListHandshakesForAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListHandshakesForAccountCommandOutput) => void), - cb?: (err: any, data?: ListHandshakesForAccountCommandOutput) => void - ): Promise | void { - const command = new ListHandshakesForAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the handshakes that are associated with the organization that the requesting - * user is part of. The ListHandshakesForOrganization operation returns a list - * of handshake structures. Each structure contains details and status about a - * handshake.

- *

Handshakes that are ACCEPTED, DECLINED, - * CANCELED, or EXPIRED appear in the results of this API for - * only 30 days after changing to that state. After that, they're deleted and no longer - * accessible.

- * - *

Always check the NextToken response parameter - * for a null value when calling a List* operation. These operations can - * occasionally return an empty set of results even when there are more results available. The - * NextToken response parameter value is null - * only - * when there are no more results to display.

- *
- *

This operation can be called only from the organization's - * management account or by a member account that is a delegated administrator for an Amazon Web Services service.

+ * @see {@link ListHandshakesForOrganizationCommand} */ - public listHandshakesForOrganization( + listHandshakesForOrganization( args: ListHandshakesForOrganizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public listHandshakesForOrganization( + listHandshakesForOrganization( args: ListHandshakesForOrganizationCommandInput, cb: (err: any, data?: ListHandshakesForOrganizationCommandOutput) => void ): void; - public listHandshakesForOrganization( + listHandshakesForOrganization( args: ListHandshakesForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHandshakesForOrganizationCommandOutput) => void ): void; - public listHandshakesForOrganization( - args: ListHandshakesForOrganizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListHandshakesForOrganizationCommandOutput) => void), - cb?: (err: any, data?: ListHandshakesForOrganizationCommandOutput) => void - ): Promise | void { - const command = new ListHandshakesForOrganizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the organizational units (OUs) in a parent organizational unit or root.

- * - *

Always check the NextToken response parameter - * for a null value when calling a List* operation. These operations can - * occasionally return an empty set of results even when there are more results available. The - * NextToken response parameter value is null - * only - * when there are no more results to display.

- *
- *

This operation can be called only from the organization's - * management account or by a member account that is a delegated administrator for an Amazon Web Services service.

+ * @see {@link ListOrganizationalUnitsForParentCommand} */ - public listOrganizationalUnitsForParent( + listOrganizationalUnitsForParent( args: ListOrganizationalUnitsForParentCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOrganizationalUnitsForParent( + listOrganizationalUnitsForParent( args: ListOrganizationalUnitsForParentCommandInput, cb: (err: any, data?: ListOrganizationalUnitsForParentCommandOutput) => void ): void; - public listOrganizationalUnitsForParent( + listOrganizationalUnitsForParent( args: ListOrganizationalUnitsForParentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOrganizationalUnitsForParentCommandOutput) => void ): void; - public listOrganizationalUnitsForParent( - args: ListOrganizationalUnitsForParentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOrganizationalUnitsForParentCommandOutput) => void), - cb?: (err: any, data?: ListOrganizationalUnitsForParentCommandOutput) => void - ): Promise | void { - const command = new ListOrganizationalUnitsForParentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the root or organizational units (OUs) that serve as the immediate parent of the - * specified child OU or account. This operation, along with ListChildren - * enables you to traverse the tree structure that makes up this root.

- * - *

Always check the NextToken response parameter - * for a null value when calling a List* operation. These operations can - * occasionally return an empty set of results even when there are more results available. The - * NextToken response parameter value is null - * only - * when there are no more results to display.

- *
- *

This operation can be called only from the organization's - * management account or by a member account that is a delegated administrator for an Amazon Web Services service.

- * - *

In the current release, a child can have only a single parent.

- *
+ * @see {@link ListParentsCommand} */ - public listParents(args: ListParentsCommandInput, options?: __HttpHandlerOptions): Promise; - public listParents(args: ListParentsCommandInput, cb: (err: any, data?: ListParentsCommandOutput) => void): void; - public listParents( + listParents(args: ListParentsCommandInput, options?: __HttpHandlerOptions): Promise; + listParents(args: ListParentsCommandInput, cb: (err: any, data?: ListParentsCommandOutput) => void): void; + listParents( args: ListParentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListParentsCommandOutput) => void ): void; - public listParents( - args: ListParentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListParentsCommandOutput) => void), - cb?: (err: any, data?: ListParentsCommandOutput) => void - ): Promise | void { - const command = new ListParentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the list of all policies in an organization of a specified type.

- * - *

Always check the NextToken response parameter - * for a null value when calling a List* operation. These operations can - * occasionally return an empty set of results even when there are more results available. The - * NextToken response parameter value is null - * only - * when there are no more results to display.

- *
- *

This operation can be called only from the organization's - * management account or by a member account that is a delegated administrator for an Amazon Web Services service.

+ * @see {@link ListPoliciesCommand} */ - public listPolicies( - args: ListPoliciesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listPolicies(args: ListPoliciesCommandInput, cb: (err: any, data?: ListPoliciesCommandOutput) => void): void; - public listPolicies( + listPolicies(args: ListPoliciesCommandInput, options?: __HttpHandlerOptions): Promise; + listPolicies(args: ListPoliciesCommandInput, cb: (err: any, data?: ListPoliciesCommandOutput) => void): void; + listPolicies( args: ListPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPoliciesCommandOutput) => void ): void; - public listPolicies( - args: ListPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the policies that are directly attached to the specified target root, - * organizational unit (OU), or account. You must specify the policy type that you want - * included in the returned list.

- * - *

Always check the NextToken response parameter - * for a null value when calling a List* operation. These operations can - * occasionally return an empty set of results even when there are more results available. The - * NextToken response parameter value is null - * only - * when there are no more results to display.

- *
- *

This operation can be called only from the organization's - * management account or by a member account that is a delegated administrator for an Amazon Web Services service.

+ * @see {@link ListPoliciesForTargetCommand} */ - public listPoliciesForTarget( + listPoliciesForTarget( args: ListPoliciesForTargetCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPoliciesForTarget( + listPoliciesForTarget( args: ListPoliciesForTargetCommandInput, cb: (err: any, data?: ListPoliciesForTargetCommandOutput) => void ): void; - public listPoliciesForTarget( + listPoliciesForTarget( args: ListPoliciesForTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPoliciesForTargetCommandOutput) => void ): void; - public listPoliciesForTarget( - args: ListPoliciesForTargetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPoliciesForTargetCommandOutput) => void), - cb?: (err: any, data?: ListPoliciesForTargetCommandOutput) => void - ): Promise | void { - const command = new ListPoliciesForTargetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the roots that are defined in the current organization.

- * - *

Always check the NextToken response parameter - * for a null value when calling a List* operation. These operations can - * occasionally return an empty set of results even when there are more results available. The - * NextToken response parameter value is null - * only - * when there are no more results to display.

- *
- *

This operation can be called only from the organization's - * management account or by a member account that is a delegated administrator for an Amazon Web Services service.

- * - *

Policy types can be enabled and disabled in roots. This is distinct from whether - * they're available in the organization. When you enable all features, you make policy - * types available for use in that organization. Individual policy types can then be - * enabled and disabled in a root. To see the availability of a policy type in an - * organization, use DescribeOrganization.

- *
+ * @see {@link ListRootsCommand} */ - public listRoots(args: ListRootsCommandInput, options?: __HttpHandlerOptions): Promise; - public listRoots(args: ListRootsCommandInput, cb: (err: any, data?: ListRootsCommandOutput) => void): void; - public listRoots( + listRoots(args: ListRootsCommandInput, options?: __HttpHandlerOptions): Promise; + listRoots(args: ListRootsCommandInput, cb: (err: any, data?: ListRootsCommandOutput) => void): void; + listRoots( args: ListRootsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRootsCommandOutput) => void ): void; - public listRoots( - args: ListRootsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRootsCommandOutput) => void), - cb?: (err: any, data?: ListRootsCommandOutput) => void - ): Promise | void { - const command = new ListRootsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists tags that are attached to the specified resource.

- *

You can attach tags to the following resources in Organizations.

- *
    - *
  • - *

    Amazon Web Services account

    - *
  • - *
  • - *

    Organization root

    - *
  • - *
  • - *

    Organizational unit (OU)

    - *
  • - *
  • - *

    Policy (any type)

    - *
  • - *
- *

This operation can be called only from the organization's - * management account or by a member account that is a delegated administrator for an Amazon Web Services service.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the roots, organizational units (OUs), and accounts that the specified - * policy is attached to.

- * - *

Always check the NextToken response parameter - * for a null value when calling a List* operation. These operations can - * occasionally return an empty set of results even when there are more results available. The - * NextToken response parameter value is null - * only - * when there are no more results to display.

- *
- *

This operation can be called only from the organization's - * management account or by a member account that is a delegated administrator for an Amazon Web Services service.

+ * @see {@link ListTargetsForPolicyCommand} */ - public listTargetsForPolicy( + listTargetsForPolicy( args: ListTargetsForPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTargetsForPolicy( + listTargetsForPolicy( args: ListTargetsForPolicyCommandInput, cb: (err: any, data?: ListTargetsForPolicyCommandOutput) => void ): void; - public listTargetsForPolicy( + listTargetsForPolicy( args: ListTargetsForPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTargetsForPolicyCommandOutput) => void ): void; - public listTargetsForPolicy( - args: ListTargetsForPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTargetsForPolicyCommandOutput) => void), - cb?: (err: any, data?: ListTargetsForPolicyCommandOutput) => void - ): Promise | void { - const command = new ListTargetsForPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Moves an account from its current source parent root or organizational unit (OU) to - * the specified destination parent root or OU.

- *

This operation can be called only from the organization's management account.

+ * @see {@link MoveAccountCommand} */ - public moveAccount(args: MoveAccountCommandInput, options?: __HttpHandlerOptions): Promise; - public moveAccount(args: MoveAccountCommandInput, cb: (err: any, data?: MoveAccountCommandOutput) => void): void; - public moveAccount( + moveAccount(args: MoveAccountCommandInput, options?: __HttpHandlerOptions): Promise; + moveAccount(args: MoveAccountCommandInput, cb: (err: any, data?: MoveAccountCommandOutput) => void): void; + moveAccount( args: MoveAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MoveAccountCommandOutput) => void ): void; - public moveAccount( - args: MoveAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MoveAccountCommandOutput) => void), - cb?: (err: any, data?: MoveAccountCommandOutput) => void - ): Promise | void { - const command = new MoveAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates a resource policy.

- *

You can only call this operation from the organization's management account.

+ * @see {@link PutResourcePolicyCommand} */ - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( - args: PutResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: PutResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new PutResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the specified member account to administer the Organizations features of the specified - * Amazon Web Services service. It grants read-only access to Organizations service data. The account still - * requires IAM permissions to access and administer the Amazon Web Services service.

- *

You can run this action only for Amazon Web Services services that support this - * feature. For a current list of services that support it, see the column Supports - * Delegated Administrator in the table at Amazon Web Services Services that you can use with - * Organizations in the Organizations User Guide. - *

- *

This operation can be called only from the organization's management account.

+ * @see {@link RegisterDelegatedAdministratorCommand} */ - public registerDelegatedAdministrator( + registerDelegatedAdministrator( args: RegisterDelegatedAdministratorCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerDelegatedAdministrator( + registerDelegatedAdministrator( args: RegisterDelegatedAdministratorCommandInput, cb: (err: any, data?: RegisterDelegatedAdministratorCommandOutput) => void ): void; - public registerDelegatedAdministrator( + registerDelegatedAdministrator( args: RegisterDelegatedAdministratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterDelegatedAdministratorCommandOutput) => void ): void; - public registerDelegatedAdministrator( - args: RegisterDelegatedAdministratorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterDelegatedAdministratorCommandOutput) => void), - cb?: (err: any, data?: RegisterDelegatedAdministratorCommandOutput) => void - ): Promise | void { - const command = new RegisterDelegatedAdministratorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified account from the organization.

- *

The removed account becomes a standalone account that isn't a member of any - * organization. It's no longer subject to any policies and is responsible for its own bill - * payments. The organization's management account is no longer charged for any expenses - * accrued by the member account after it's removed from the organization.

- *

This operation can be called only from the organization's management account. Member accounts can remove themselves with LeaveOrganization instead.

- * - *
    - *
  • - *

    You can remove an account from your organization only if the account is - * configured with the information required to operate as a standalone account. - * When you create an account in an organization using the Organizations console, - * API, or CLI commands, the information required of standalone accounts is - * not automatically collected. For an account that - * you want to make standalone, you must choose a support plan, provide and - * verify the required contact information, and provide a current payment - * method. Amazon Web Services uses the payment method to charge for any billable (not free - * tier) Amazon Web Services activity that occurs while the account isn't attached to an - * organization. To remove an account that doesn't yet have this information, - * you must sign in as the member account and follow the steps at To leave an organization when all required account information has not - * yet been provided in the - * Organizations User Guide. - *

    - *
  • - *
  • - *

    The account that you want to leave must not be a delegated administrator - * account for any Amazon Web Services service enabled for your organization. If the account - * is a delegated administrator, you must first change the delegated - * administrator account to another account that is remaining in the - * organization.

    - *
  • - *
  • - *

    After the account leaves the organization, all tags that were attached to - * the account object in the organization are deleted. Amazon Web Services accounts outside - * of an organization do not support tags.

    - *
  • - *
- *
+ * @see {@link RemoveAccountFromOrganizationCommand} */ - public removeAccountFromOrganization( + removeAccountFromOrganization( args: RemoveAccountFromOrganizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeAccountFromOrganization( + removeAccountFromOrganization( args: RemoveAccountFromOrganizationCommandInput, cb: (err: any, data?: RemoveAccountFromOrganizationCommandOutput) => void ): void; - public removeAccountFromOrganization( + removeAccountFromOrganization( args: RemoveAccountFromOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveAccountFromOrganizationCommandOutput) => void ): void; - public removeAccountFromOrganization( - args: RemoveAccountFromOrganizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveAccountFromOrganizationCommandOutput) => void), - cb?: (err: any, data?: RemoveAccountFromOrganizationCommandOutput) => void - ): Promise | void { - const command = new RemoveAccountFromOrganizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more tags to the specified resource.

- *

Currently, you can attach tags to the following resources in Organizations.

- *
    - *
  • - *

    Amazon Web Services account

    - *
  • - *
  • - *

    Organization root

    - *
  • - *
  • - *

    Organizational unit (OU)

    - *
  • - *
  • - *

    Policy (any type)

    - *
  • - *
- *

This operation can be called only from the organization's management account.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes any tags with the specified keys from the specified resource.

- *

You can attach tags to the following resources in Organizations.

- *
    - *
  • - *

    Amazon Web Services account

    - *
  • - *
  • - *

    Organization root

    - *
  • - *
  • - *

    Organizational unit (OU)

    - *
  • - *
  • - *

    Policy (any type)

    - *
  • - *
- *

This operation can be called only from the organization's management account.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Renames the specified organizational unit (OU). The ID and ARN don't change. The child - * OUs and accounts remain in place, and any attached policies of the OU remain - * attached.

- *

This operation can be called only from the organization's management account.

+ * @see {@link UpdateOrganizationalUnitCommand} */ - public updateOrganizationalUnit( + updateOrganizationalUnit( args: UpdateOrganizationalUnitCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateOrganizationalUnit( + updateOrganizationalUnit( args: UpdateOrganizationalUnitCommandInput, cb: (err: any, data?: UpdateOrganizationalUnitCommandOutput) => void ): void; - public updateOrganizationalUnit( + updateOrganizationalUnit( args: UpdateOrganizationalUnitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateOrganizationalUnitCommandOutput) => void ): void; - public updateOrganizationalUnit( - args: UpdateOrganizationalUnitCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateOrganizationalUnitCommandOutput) => void), - cb?: (err: any, data?: UpdateOrganizationalUnitCommandOutput) => void - ): Promise | void { - const command = new UpdateOrganizationalUnitCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing policy with a new name, description, or content. If you don't - * supply any parameter, that value remains unchanged. You can't change a policy's - * type.

- *

This operation can be called only from the organization's management account.

+ * @see {@link UpdatePolicyCommand} */ - public updatePolicy( - args: UpdatePolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updatePolicy(args: UpdatePolicyCommandInput, cb: (err: any, data?: UpdatePolicyCommandOutput) => void): void; - public updatePolicy( + updatePolicy(args: UpdatePolicyCommandInput, options?: __HttpHandlerOptions): Promise; + updatePolicy(args: UpdatePolicyCommandInput, cb: (err: any, data?: UpdatePolicyCommandOutput) => void): void; + updatePolicy( args: UpdatePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePolicyCommandOutput) => void ): void; - public updatePolicy( - args: UpdatePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePolicyCommandOutput) => void), - cb?: (err: any, data?: UpdatePolicyCommandOutput) => void - ): Promise | void { - const command = new UpdatePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Organizations is a web service that enables you to consolidate your multiple + * Amazon Web Services accounts into an organization and centrally manage your + * accounts and their resources.

+ *

This guide provides descriptions of the Organizations operations. For more + * information about using this service, see the Organizations User Guide.

+ *

+ * Support and feedback for Organizations + *

+ *

We welcome your feedback. Send your comments to feedback-awsorganizations@amazon.com or post your feedback and questions in + * the Organizations support forum. For + * more information about the Amazon Web Services support forums, see Forums Help.

+ *

+ * Endpoint to call When using the CLI or the Amazon Web Services + * SDK + *

+ *

For the current release of Organizations, specify the us-east-1 region + * for all Amazon Web Services API and CLI calls made from the commercial Amazon Web Services Regions outside of + * China. If calling from one of the Amazon Web Services Regions in China, then specify + * cn-northwest-1. You can do this in the CLI by using these parameters + * and commands:

+ *
    + *
  • + *

    Use the following parameter with each command to specify both the endpoint and + * its region:

    + *

    + * --endpoint-url https://organizations.us-east-1.amazonaws.com + * (from commercial Amazon Web Services Regions outside of China) + *

    + *

    or

    + *

    + * --endpoint-url + * https://organizations.cn-northwest-1.amazonaws.com.cn + * (from Amazon Web Services Regions in China) + *

    + *
  • + *
  • + *

    Use the default endpoint, but configure your default region with this + * command:

    + *

    + * aws configure set default.region us-east-1 + * (from commercial Amazon Web Services Regions outside of China) + *

    + *

    or

    + *

    + * aws configure set default.region cn-northwest-1 + * (from Amazon Web Services Regions in China) + *

    + *
  • + *
  • + *

    Use the following parameter with each command to specify the endpoint:

    + *

    + * --region us-east-1 + * (from commercial Amazon Web Services Regions outside of China) + *

    + *

    or

    + *

    + * --region cn-northwest-1 + * (from Amazon Web Services Regions in China) + *

    + *
  • + *
+ *

+ * Recording API Requests + *

+ *

Organizations supports CloudTrail, a service that records Amazon Web Services API calls for your + * Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected + * by CloudTrail, you can determine which requests the Organizations service received, who made the + * request and when, and so on. For more about Organizations and its support for CloudTrail, see + * Logging + * Organizations Events with CloudTrail in the Organizations User Guide. + * To learn more about CloudTrail, including how to turn it on and find your log files, see the + * CloudTrail User Guide.

+ */ +export class Organizations extends OrganizationsClient implements Organizations {} +createAggregatedClient(commands, Organizations); diff --git a/clients/client-outposts/src/Outposts.ts b/clients/client-outposts/src/Outposts.ts index dc9444c34c1b..3d792f83dd13 100644 --- a/clients/client-outposts/src/Outposts.ts +++ b/clients/client-outposts/src/Outposts.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { CancelOrderCommand, CancelOrderCommandInput, CancelOrderCommandOutput } from "./commands/CancelOrderCommand"; @@ -83,840 +84,371 @@ import { UpdateSiteRackPhysicalPropertiesCommandInput, UpdateSiteRackPhysicalPropertiesCommandOutput, } from "./commands/UpdateSiteRackPhysicalPropertiesCommand"; -import { OutpostsClient } from "./OutpostsClient"; +import { OutpostsClient, OutpostsClientConfig } from "./OutpostsClient"; -/** - * @public - *

Amazon Web Services Outposts is a fully managed service that extends Amazon Web Services infrastructure, APIs, and tools to - * customer premises. By providing local access to Amazon Web Services managed infrastructure, Amazon Web Services Outposts enables - * customers to build and run applications on premises using the same programming interfaces as - * in Amazon Web Services Regions, while using local compute and storage resources for lower latency and local - * data processing needs.

- */ -export class Outposts extends OutpostsClient { +const commands = { + CancelOrderCommand, + CreateOrderCommand, + CreateOutpostCommand, + CreateSiteCommand, + DeleteOutpostCommand, + DeleteSiteCommand, + GetCatalogItemCommand, + GetConnectionCommand, + GetOrderCommand, + GetOutpostCommand, + GetOutpostInstanceTypesCommand, + GetSiteCommand, + GetSiteAddressCommand, + ListAssetsCommand, + ListCatalogItemsCommand, + ListOrdersCommand, + ListOutpostsCommand, + ListSitesCommand, + ListTagsForResourceCommand, + StartConnectionCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateOutpostCommand, + UpdateSiteCommand, + UpdateSiteAddressCommand, + UpdateSiteRackPhysicalPropertiesCommand, +}; + +export interface Outposts { /** - * @public - *

Cancels the specified order for an Outpost.

+ * @see {@link CancelOrderCommand} */ - public cancelOrder(args: CancelOrderCommandInput, options?: __HttpHandlerOptions): Promise; - public cancelOrder(args: CancelOrderCommandInput, cb: (err: any, data?: CancelOrderCommandOutput) => void): void; - public cancelOrder( + cancelOrder(args: CancelOrderCommandInput, options?: __HttpHandlerOptions): Promise; + cancelOrder(args: CancelOrderCommandInput, cb: (err: any, data?: CancelOrderCommandOutput) => void): void; + cancelOrder( args: CancelOrderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelOrderCommandOutput) => void ): void; - public cancelOrder( - args: CancelOrderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelOrderCommandOutput) => void), - cb?: (err: any, data?: CancelOrderCommandOutput) => void - ): Promise | void { - const command = new CancelOrderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an order for an Outpost.

+ * @see {@link CreateOrderCommand} */ - public createOrder(args: CreateOrderCommandInput, options?: __HttpHandlerOptions): Promise; - public createOrder(args: CreateOrderCommandInput, cb: (err: any, data?: CreateOrderCommandOutput) => void): void; - public createOrder( + createOrder(args: CreateOrderCommandInput, options?: __HttpHandlerOptions): Promise; + createOrder(args: CreateOrderCommandInput, cb: (err: any, data?: CreateOrderCommandOutput) => void): void; + createOrder( args: CreateOrderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateOrderCommandOutput) => void ): void; - public createOrder( - args: CreateOrderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateOrderCommandOutput) => void), - cb?: (err: any, data?: CreateOrderCommandOutput) => void - ): Promise | void { - const command = new CreateOrderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Outpost.

- *

You can specify either an Availability one or an AZ ID.

+ * @see {@link CreateOutpostCommand} */ - public createOutpost( - args: CreateOutpostCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createOutpost( - args: CreateOutpostCommandInput, - cb: (err: any, data?: CreateOutpostCommandOutput) => void - ): void; - public createOutpost( + createOutpost(args: CreateOutpostCommandInput, options?: __HttpHandlerOptions): Promise; + createOutpost(args: CreateOutpostCommandInput, cb: (err: any, data?: CreateOutpostCommandOutput) => void): void; + createOutpost( args: CreateOutpostCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateOutpostCommandOutput) => void ): void; - public createOutpost( - args: CreateOutpostCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateOutpostCommandOutput) => void), - cb?: (err: any, data?: CreateOutpostCommandOutput) => void - ): Promise | void { - const command = new CreateOutpostCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a site for an Outpost.

+ * @see {@link CreateSiteCommand} */ - public createSite(args: CreateSiteCommandInput, options?: __HttpHandlerOptions): Promise; - public createSite(args: CreateSiteCommandInput, cb: (err: any, data?: CreateSiteCommandOutput) => void): void; - public createSite( + createSite(args: CreateSiteCommandInput, options?: __HttpHandlerOptions): Promise; + createSite(args: CreateSiteCommandInput, cb: (err: any, data?: CreateSiteCommandOutput) => void): void; + createSite( args: CreateSiteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSiteCommandOutput) => void ): void; - public createSite( - args: CreateSiteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSiteCommandOutput) => void), - cb?: (err: any, data?: CreateSiteCommandOutput) => void - ): Promise | void { - const command = new CreateSiteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified Outpost.

+ * @see {@link DeleteOutpostCommand} */ - public deleteOutpost( - args: DeleteOutpostCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteOutpost( - args: DeleteOutpostCommandInput, - cb: (err: any, data?: DeleteOutpostCommandOutput) => void - ): void; - public deleteOutpost( + deleteOutpost(args: DeleteOutpostCommandInput, options?: __HttpHandlerOptions): Promise; + deleteOutpost(args: DeleteOutpostCommandInput, cb: (err: any, data?: DeleteOutpostCommandOutput) => void): void; + deleteOutpost( args: DeleteOutpostCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOutpostCommandOutput) => void ): void; - public deleteOutpost( - args: DeleteOutpostCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteOutpostCommandOutput) => void), - cb?: (err: any, data?: DeleteOutpostCommandOutput) => void - ): Promise | void { - const command = new DeleteOutpostCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified site.

+ * @see {@link DeleteSiteCommand} */ - public deleteSite(args: DeleteSiteCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteSite(args: DeleteSiteCommandInput, cb: (err: any, data?: DeleteSiteCommandOutput) => void): void; - public deleteSite( + deleteSite(args: DeleteSiteCommandInput, options?: __HttpHandlerOptions): Promise; + deleteSite(args: DeleteSiteCommandInput, cb: (err: any, data?: DeleteSiteCommandOutput) => void): void; + deleteSite( args: DeleteSiteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSiteCommandOutput) => void ): void; - public deleteSite( - args: DeleteSiteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSiteCommandOutput) => void), - cb?: (err: any, data?: DeleteSiteCommandOutput) => void - ): Promise | void { - const command = new DeleteSiteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about the specified catalog item.

+ * @see {@link GetCatalogItemCommand} */ - public getCatalogItem( + getCatalogItem( args: GetCatalogItemCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCatalogItem( - args: GetCatalogItemCommandInput, - cb: (err: any, data?: GetCatalogItemCommandOutput) => void - ): void; - public getCatalogItem( + getCatalogItem(args: GetCatalogItemCommandInput, cb: (err: any, data?: GetCatalogItemCommandOutput) => void): void; + getCatalogItem( args: GetCatalogItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCatalogItemCommandOutput) => void ): void; - public getCatalogItem( - args: GetCatalogItemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCatalogItemCommandOutput) => void), - cb?: (err: any, data?: GetCatalogItemCommandOutput) => void - ): Promise | void { - const command = new GetCatalogItemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

- * Amazon Web Services uses this action to install Outpost servers.

- *
- *

Gets information about the specified connection.

- *

- * Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For - * more information, see - * Amazon Web Services managed policies for Amazon Web Services Outposts and - * Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide. - *

+ * @see {@link GetConnectionCommand} */ - public getConnection( - args: GetConnectionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getConnection( - args: GetConnectionCommandInput, - cb: (err: any, data?: GetConnectionCommandOutput) => void - ): void; - public getConnection( + getConnection(args: GetConnectionCommandInput, options?: __HttpHandlerOptions): Promise; + getConnection(args: GetConnectionCommandInput, cb: (err: any, data?: GetConnectionCommandOutput) => void): void; + getConnection( args: GetConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConnectionCommandOutput) => void ): void; - public getConnection( - args: GetConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConnectionCommandOutput) => void), - cb?: (err: any, data?: GetConnectionCommandOutput) => void - ): Promise | void { - const command = new GetConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about the specified order.

+ * @see {@link GetOrderCommand} */ - public getOrder(args: GetOrderCommandInput, options?: __HttpHandlerOptions): Promise; - public getOrder(args: GetOrderCommandInput, cb: (err: any, data?: GetOrderCommandOutput) => void): void; - public getOrder( + getOrder(args: GetOrderCommandInput, options?: __HttpHandlerOptions): Promise; + getOrder(args: GetOrderCommandInput, cb: (err: any, data?: GetOrderCommandOutput) => void): void; + getOrder( args: GetOrderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOrderCommandOutput) => void ): void; - public getOrder( - args: GetOrderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOrderCommandOutput) => void), - cb?: (err: any, data?: GetOrderCommandOutput) => void - ): Promise | void { - const command = new GetOrderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about the specified Outpost.

+ * @see {@link GetOutpostCommand} */ - public getOutpost(args: GetOutpostCommandInput, options?: __HttpHandlerOptions): Promise; - public getOutpost(args: GetOutpostCommandInput, cb: (err: any, data?: GetOutpostCommandOutput) => void): void; - public getOutpost( + getOutpost(args: GetOutpostCommandInput, options?: __HttpHandlerOptions): Promise; + getOutpost(args: GetOutpostCommandInput, cb: (err: any, data?: GetOutpostCommandOutput) => void): void; + getOutpost( args: GetOutpostCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOutpostCommandOutput) => void ): void; - public getOutpost( - args: GetOutpostCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOutpostCommandOutput) => void), - cb?: (err: any, data?: GetOutpostCommandOutput) => void - ): Promise | void { - const command = new GetOutpostCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the instance types for the specified Outpost.

+ * @see {@link GetOutpostInstanceTypesCommand} */ - public getOutpostInstanceTypes( + getOutpostInstanceTypes( args: GetOutpostInstanceTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getOutpostInstanceTypes( + getOutpostInstanceTypes( args: GetOutpostInstanceTypesCommandInput, cb: (err: any, data?: GetOutpostInstanceTypesCommandOutput) => void ): void; - public getOutpostInstanceTypes( + getOutpostInstanceTypes( args: GetOutpostInstanceTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOutpostInstanceTypesCommandOutput) => void ): void; - public getOutpostInstanceTypes( - args: GetOutpostInstanceTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOutpostInstanceTypesCommandOutput) => void), - cb?: (err: any, data?: GetOutpostInstanceTypesCommandOutput) => void - ): Promise | void { - const command = new GetOutpostInstanceTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about the specified Outpost site.

+ * @see {@link GetSiteCommand} */ - public getSite(args: GetSiteCommandInput, options?: __HttpHandlerOptions): Promise; - public getSite(args: GetSiteCommandInput, cb: (err: any, data?: GetSiteCommandOutput) => void): void; - public getSite( + getSite(args: GetSiteCommandInput, options?: __HttpHandlerOptions): Promise; + getSite(args: GetSiteCommandInput, cb: (err: any, data?: GetSiteCommandOutput) => void): void; + getSite( args: GetSiteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSiteCommandOutput) => void ): void; - public getSite( - args: GetSiteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSiteCommandOutput) => void), - cb?: (err: any, data?: GetSiteCommandOutput) => void - ): Promise | void { - const command = new GetSiteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the site address of the specified site.

+ * @see {@link GetSiteAddressCommand} */ - public getSiteAddress( + getSiteAddress( args: GetSiteAddressCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSiteAddress( - args: GetSiteAddressCommandInput, - cb: (err: any, data?: GetSiteAddressCommandOutput) => void - ): void; - public getSiteAddress( + getSiteAddress(args: GetSiteAddressCommandInput, cb: (err: any, data?: GetSiteAddressCommandOutput) => void): void; + getSiteAddress( args: GetSiteAddressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSiteAddressCommandOutput) => void ): void; - public getSiteAddress( - args: GetSiteAddressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSiteAddressCommandOutput) => void), - cb?: (err: any, data?: GetSiteAddressCommandOutput) => void - ): Promise | void { - const command = new GetSiteAddressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the hardware assets for the specified Outpost.

- *

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match - * all of the specified filters. For a filter where you can specify multiple values, the results include - * items that match any of the values that you specify for the filter.

+ * @see {@link ListAssetsCommand} */ - public listAssets(args: ListAssetsCommandInput, options?: __HttpHandlerOptions): Promise; - public listAssets(args: ListAssetsCommandInput, cb: (err: any, data?: ListAssetsCommandOutput) => void): void; - public listAssets( + listAssets(args: ListAssetsCommandInput, options?: __HttpHandlerOptions): Promise; + listAssets(args: ListAssetsCommandInput, cb: (err: any, data?: ListAssetsCommandOutput) => void): void; + listAssets( args: ListAssetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssetsCommandOutput) => void ): void; - public listAssets( - args: ListAssetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssetsCommandOutput) => void), - cb?: (err: any, data?: ListAssetsCommandOutput) => void - ): Promise | void { - const command = new ListAssetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the items in the catalog.

- *

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match - * all of the specified filters. For a filter where you can specify multiple values, the results include - * items that match any of the values that you specify for the filter.

+ * @see {@link ListCatalogItemsCommand} */ - public listCatalogItems( + listCatalogItems( args: ListCatalogItemsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCatalogItems( + listCatalogItems( args: ListCatalogItemsCommandInput, cb: (err: any, data?: ListCatalogItemsCommandOutput) => void ): void; - public listCatalogItems( + listCatalogItems( args: ListCatalogItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCatalogItemsCommandOutput) => void ): void; - public listCatalogItems( - args: ListCatalogItemsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCatalogItemsCommandOutput) => void), - cb?: (err: any, data?: ListCatalogItemsCommandOutput) => void - ): Promise | void { - const command = new ListCatalogItemsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the Outpost orders for your Amazon Web Services account.

+ * @see {@link ListOrdersCommand} */ - public listOrders(args: ListOrdersCommandInput, options?: __HttpHandlerOptions): Promise; - public listOrders(args: ListOrdersCommandInput, cb: (err: any, data?: ListOrdersCommandOutput) => void): void; - public listOrders( + listOrders(args: ListOrdersCommandInput, options?: __HttpHandlerOptions): Promise; + listOrders(args: ListOrdersCommandInput, cb: (err: any, data?: ListOrdersCommandOutput) => void): void; + listOrders( args: ListOrdersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOrdersCommandOutput) => void ): void; - public listOrders( - args: ListOrdersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOrdersCommandOutput) => void), - cb?: (err: any, data?: ListOrdersCommandOutput) => void - ): Promise | void { - const command = new ListOrdersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the Outposts for your Amazon Web Services account.

- *

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match - * all of the specified filters. For a filter where you can specify multiple values, the results include - * items that match any of the values that you specify for the filter.

+ * @see {@link ListOutpostsCommand} */ - public listOutposts( - args: ListOutpostsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listOutposts(args: ListOutpostsCommandInput, cb: (err: any, data?: ListOutpostsCommandOutput) => void): void; - public listOutposts( + listOutposts(args: ListOutpostsCommandInput, options?: __HttpHandlerOptions): Promise; + listOutposts(args: ListOutpostsCommandInput, cb: (err: any, data?: ListOutpostsCommandOutput) => void): void; + listOutposts( args: ListOutpostsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOutpostsCommandOutput) => void ): void; - public listOutposts( - args: ListOutpostsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOutpostsCommandOutput) => void), - cb?: (err: any, data?: ListOutpostsCommandOutput) => void - ): Promise | void { - const command = new ListOutpostsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the Outpost sites for your Amazon Web Services account. Use filters to return specific - * results.

- *

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match - * all of the specified filters. For a filter where you can specify multiple values, the results include - * items that match any of the values that you specify for the filter.

+ * @see {@link ListSitesCommand} */ - public listSites(args: ListSitesCommandInput, options?: __HttpHandlerOptions): Promise; - public listSites(args: ListSitesCommandInput, cb: (err: any, data?: ListSitesCommandOutput) => void): void; - public listSites( + listSites(args: ListSitesCommandInput, options?: __HttpHandlerOptions): Promise; + listSites(args: ListSitesCommandInput, cb: (err: any, data?: ListSitesCommandOutput) => void): void; + listSites( args: ListSitesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSitesCommandOutput) => void ): void; - public listSites( - args: ListSitesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSitesCommandOutput) => void), - cb?: (err: any, data?: ListSitesCommandOutput) => void - ): Promise | void { - const command = new ListSitesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags for the specified resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

- * Amazon Web Services uses this action to install Outpost servers.

- *
- *

Starts the connection required for Outpost server installation.

- *

- * Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For - * more information, see - * Amazon Web Services managed policies for Amazon Web Services Outposts and - * Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide. - *

+ * @see {@link StartConnectionCommand} */ - public startConnection( + startConnection( args: StartConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startConnection( - args: StartConnectionCommandInput, - cb: (err: any, data?: StartConnectionCommandOutput) => void - ): void; - public startConnection( + startConnection(args: StartConnectionCommandInput, cb: (err: any, data?: StartConnectionCommandOutput) => void): void; + startConnection( args: StartConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartConnectionCommandOutput) => void ): void; - public startConnection( - args: StartConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartConnectionCommandOutput) => void), - cb?: (err: any, data?: StartConnectionCommandOutput) => void - ): Promise | void { - const command = new StartConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds tags to the specified resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from the specified resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an Outpost.

+ * @see {@link UpdateOutpostCommand} */ - public updateOutpost( - args: UpdateOutpostCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateOutpost( - args: UpdateOutpostCommandInput, - cb: (err: any, data?: UpdateOutpostCommandOutput) => void - ): void; - public updateOutpost( + updateOutpost(args: UpdateOutpostCommandInput, options?: __HttpHandlerOptions): Promise; + updateOutpost(args: UpdateOutpostCommandInput, cb: (err: any, data?: UpdateOutpostCommandOutput) => void): void; + updateOutpost( args: UpdateOutpostCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateOutpostCommandOutput) => void ): void; - public updateOutpost( - args: UpdateOutpostCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateOutpostCommandOutput) => void), - cb?: (err: any, data?: UpdateOutpostCommandOutput) => void - ): Promise | void { - const command = new UpdateOutpostCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified site.

+ * @see {@link UpdateSiteCommand} */ - public updateSite(args: UpdateSiteCommandInput, options?: __HttpHandlerOptions): Promise; - public updateSite(args: UpdateSiteCommandInput, cb: (err: any, data?: UpdateSiteCommandOutput) => void): void; - public updateSite( + updateSite(args: UpdateSiteCommandInput, options?: __HttpHandlerOptions): Promise; + updateSite(args: UpdateSiteCommandInput, cb: (err: any, data?: UpdateSiteCommandOutput) => void): void; + updateSite( args: UpdateSiteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSiteCommandOutput) => void ): void; - public updateSite( - args: UpdateSiteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSiteCommandOutput) => void), - cb?: (err: any, data?: UpdateSiteCommandOutput) => void - ): Promise | void { - const command = new UpdateSiteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the address of the specified site.

- *

You can't update a site address if there is an order in progress. You must wait for the - * order to complete or cancel the order.

- *

You can update the operating address before you place an order at the site, or after all - * Outposts that belong to the site have been deactivated.

+ * @see {@link UpdateSiteAddressCommand} */ - public updateSiteAddress( + updateSiteAddress( args: UpdateSiteAddressCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSiteAddress( + updateSiteAddress( args: UpdateSiteAddressCommandInput, cb: (err: any, data?: UpdateSiteAddressCommandOutput) => void ): void; - public updateSiteAddress( + updateSiteAddress( args: UpdateSiteAddressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSiteAddressCommandOutput) => void ): void; - public updateSiteAddress( - args: UpdateSiteAddressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSiteAddressCommandOutput) => void), - cb?: (err: any, data?: UpdateSiteAddressCommandOutput) => void - ): Promise | void { - const command = new UpdateSiteAddressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update the physical and logistical details for a rack at a site. For more information - * about hardware requirements for racks, see Network - * readiness checklist in the Amazon Web Services Outposts User Guide. - *

- *

To update a rack at a site with an order of IN_PROGRESS, you must wait for - * the order to complete or cancel the order.

+ * @see {@link UpdateSiteRackPhysicalPropertiesCommand} */ - public updateSiteRackPhysicalProperties( + updateSiteRackPhysicalProperties( args: UpdateSiteRackPhysicalPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSiteRackPhysicalProperties( + updateSiteRackPhysicalProperties( args: UpdateSiteRackPhysicalPropertiesCommandInput, cb: (err: any, data?: UpdateSiteRackPhysicalPropertiesCommandOutput) => void ): void; - public updateSiteRackPhysicalProperties( + updateSiteRackPhysicalProperties( args: UpdateSiteRackPhysicalPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSiteRackPhysicalPropertiesCommandOutput) => void ): void; - public updateSiteRackPhysicalProperties( - args: UpdateSiteRackPhysicalPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSiteRackPhysicalPropertiesCommandOutput) => void), - cb?: (err: any, data?: UpdateSiteRackPhysicalPropertiesCommandOutput) => void - ): Promise | void { - const command = new UpdateSiteRackPhysicalPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Web Services Outposts is a fully managed service that extends Amazon Web Services infrastructure, APIs, and tools to + * customer premises. By providing local access to Amazon Web Services managed infrastructure, Amazon Web Services Outposts enables + * customers to build and run applications on premises using the same programming interfaces as + * in Amazon Web Services Regions, while using local compute and storage resources for lower latency and local + * data processing needs.

+ */ +export class Outposts extends OutpostsClient implements Outposts {} +createAggregatedClient(commands, Outposts); diff --git a/clients/client-panorama/src/Panorama.ts b/clients/client-panorama/src/Panorama.ts index 8d82dc2d64c3..3f1adfcb81c7 100644 --- a/clients/client-panorama/src/Panorama.ts +++ b/clients/client-panorama/src/Panorama.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -159,1119 +160,567 @@ import { UpdateDeviceMetadataCommandInput, UpdateDeviceMetadataCommandOutput, } from "./commands/UpdateDeviceMetadataCommand"; -import { PanoramaClient } from "./PanoramaClient"; +import { PanoramaClient, PanoramaClientConfig } from "./PanoramaClient"; -/** - * @public - * AWS Panorama - *

- * Overview - *

- *

This is the AWS Panorama API Reference. For an introduction to the service, see What is AWS Panorama? in the - * AWS Panorama Developer Guide.

- */ -export class Panorama extends PanoramaClient { +const commands = { + CreateApplicationInstanceCommand, + CreateJobForDevicesCommand, + CreateNodeFromTemplateJobCommand, + CreatePackageCommand, + CreatePackageImportJobCommand, + DeleteDeviceCommand, + DeletePackageCommand, + DeregisterPackageVersionCommand, + DescribeApplicationInstanceCommand, + DescribeApplicationInstanceDetailsCommand, + DescribeDeviceCommand, + DescribeDeviceJobCommand, + DescribeNodeCommand, + DescribeNodeFromTemplateJobCommand, + DescribePackageCommand, + DescribePackageImportJobCommand, + DescribePackageVersionCommand, + ListApplicationInstanceDependenciesCommand, + ListApplicationInstanceNodeInstancesCommand, + ListApplicationInstancesCommand, + ListDevicesCommand, + ListDevicesJobsCommand, + ListNodeFromTemplateJobsCommand, + ListNodesCommand, + ListPackageImportJobsCommand, + ListPackagesCommand, + ListTagsForResourceCommand, + ProvisionDeviceCommand, + RegisterPackageVersionCommand, + RemoveApplicationInstanceCommand, + SignalApplicationInstanceNodeInstancesCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateDeviceMetadataCommand, +}; + +export interface Panorama { /** - * @public - *

Creates an application instance and deploys it to a device.

+ * @see {@link CreateApplicationInstanceCommand} */ - public createApplicationInstance( + createApplicationInstance( args: CreateApplicationInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApplicationInstance( + createApplicationInstance( args: CreateApplicationInstanceCommandInput, cb: (err: any, data?: CreateApplicationInstanceCommandOutput) => void ): void; - public createApplicationInstance( + createApplicationInstance( args: CreateApplicationInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApplicationInstanceCommandOutput) => void ): void; - public createApplicationInstance( - args: CreateApplicationInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApplicationInstanceCommandOutput) => void), - cb?: (err: any, data?: CreateApplicationInstanceCommandOutput) => void - ): Promise | void { - const command = new CreateApplicationInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a job to run on a device. A job can update a device's software or reboot it.

+ * @see {@link CreateJobForDevicesCommand} */ - public createJobForDevices( + createJobForDevices( args: CreateJobForDevicesCommandInput, options?: __HttpHandlerOptions ): Promise; - public createJobForDevices( + createJobForDevices( args: CreateJobForDevicesCommandInput, cb: (err: any, data?: CreateJobForDevicesCommandOutput) => void ): void; - public createJobForDevices( + createJobForDevices( args: CreateJobForDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateJobForDevicesCommandOutput) => void ): void; - public createJobForDevices( - args: CreateJobForDevicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateJobForDevicesCommandOutput) => void), - cb?: (err: any, data?: CreateJobForDevicesCommandOutput) => void - ): Promise | void { - const command = new CreateJobForDevicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a camera stream node.

+ * @see {@link CreateNodeFromTemplateJobCommand} */ - public createNodeFromTemplateJob( + createNodeFromTemplateJob( args: CreateNodeFromTemplateJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNodeFromTemplateJob( + createNodeFromTemplateJob( args: CreateNodeFromTemplateJobCommandInput, cb: (err: any, data?: CreateNodeFromTemplateJobCommandOutput) => void ): void; - public createNodeFromTemplateJob( + createNodeFromTemplateJob( args: CreateNodeFromTemplateJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNodeFromTemplateJobCommandOutput) => void ): void; - public createNodeFromTemplateJob( - args: CreateNodeFromTemplateJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNodeFromTemplateJobCommandOutput) => void), - cb?: (err: any, data?: CreateNodeFromTemplateJobCommandOutput) => void - ): Promise | void { - const command = new CreateNodeFromTemplateJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a package and storage location in an Amazon S3 access point.

+ * @see {@link CreatePackageCommand} */ - public createPackage( - args: CreatePackageCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createPackage( - args: CreatePackageCommandInput, - cb: (err: any, data?: CreatePackageCommandOutput) => void - ): void; - public createPackage( + createPackage(args: CreatePackageCommandInput, options?: __HttpHandlerOptions): Promise; + createPackage(args: CreatePackageCommandInput, cb: (err: any, data?: CreatePackageCommandOutput) => void): void; + createPackage( args: CreatePackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePackageCommandOutput) => void ): void; - public createPackage( - args: CreatePackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePackageCommandOutput) => void), - cb?: (err: any, data?: CreatePackageCommandOutput) => void - ): Promise | void { - const command = new CreatePackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Imports a node package.

+ * @see {@link CreatePackageImportJobCommand} */ - public createPackageImportJob( + createPackageImportJob( args: CreatePackageImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPackageImportJob( + createPackageImportJob( args: CreatePackageImportJobCommandInput, cb: (err: any, data?: CreatePackageImportJobCommandOutput) => void ): void; - public createPackageImportJob( + createPackageImportJob( args: CreatePackageImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePackageImportJobCommandOutput) => void ): void; - public createPackageImportJob( - args: CreatePackageImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePackageImportJobCommandOutput) => void), - cb?: (err: any, data?: CreatePackageImportJobCommandOutput) => void - ): Promise | void { - const command = new CreatePackageImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a device.

+ * @see {@link DeleteDeviceCommand} */ - public deleteDevice( - args: DeleteDeviceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDevice(args: DeleteDeviceCommandInput, cb: (err: any, data?: DeleteDeviceCommandOutput) => void): void; - public deleteDevice( + deleteDevice(args: DeleteDeviceCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDevice(args: DeleteDeviceCommandInput, cb: (err: any, data?: DeleteDeviceCommandOutput) => void): void; + deleteDevice( args: DeleteDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDeviceCommandOutput) => void ): void; - public deleteDevice( - args: DeleteDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDeviceCommandOutput) => void), - cb?: (err: any, data?: DeleteDeviceCommandOutput) => void - ): Promise | void { - const command = new DeleteDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a package.

- * - *

To delete a package, you need permission to call s3:DeleteObject in addition to permissions for - * the AWS Panorama API.

- *
+ * @see {@link DeletePackageCommand} */ - public deletePackage( - args: DeletePackageCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deletePackage( - args: DeletePackageCommandInput, - cb: (err: any, data?: DeletePackageCommandOutput) => void - ): void; - public deletePackage( + deletePackage(args: DeletePackageCommandInput, options?: __HttpHandlerOptions): Promise; + deletePackage(args: DeletePackageCommandInput, cb: (err: any, data?: DeletePackageCommandOutput) => void): void; + deletePackage( args: DeletePackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePackageCommandOutput) => void ): void; - public deletePackage( - args: DeletePackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePackageCommandOutput) => void), - cb?: (err: any, data?: DeletePackageCommandOutput) => void - ): Promise | void { - const command = new DeletePackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deregisters a package version.

+ * @see {@link DeregisterPackageVersionCommand} */ - public deregisterPackageVersion( + deregisterPackageVersion( args: DeregisterPackageVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterPackageVersion( + deregisterPackageVersion( args: DeregisterPackageVersionCommandInput, cb: (err: any, data?: DeregisterPackageVersionCommandOutput) => void ): void; - public deregisterPackageVersion( + deregisterPackageVersion( args: DeregisterPackageVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterPackageVersionCommandOutput) => void ): void; - public deregisterPackageVersion( - args: DeregisterPackageVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterPackageVersionCommandOutput) => void), - cb?: (err: any, data?: DeregisterPackageVersionCommandOutput) => void - ): Promise | void { - const command = new DeregisterPackageVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about an application instance on a device.

+ * @see {@link DescribeApplicationInstanceCommand} */ - public describeApplicationInstance( + describeApplicationInstance( args: DescribeApplicationInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeApplicationInstance( + describeApplicationInstance( args: DescribeApplicationInstanceCommandInput, cb: (err: any, data?: DescribeApplicationInstanceCommandOutput) => void ): void; - public describeApplicationInstance( + describeApplicationInstance( args: DescribeApplicationInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeApplicationInstanceCommandOutput) => void ): void; - public describeApplicationInstance( - args: DescribeApplicationInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeApplicationInstanceCommandOutput) => void), - cb?: (err: any, data?: DescribeApplicationInstanceCommandOutput) => void - ): Promise | void { - const command = new DescribeApplicationInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about an application instance's configuration manifest.

+ * @see {@link DescribeApplicationInstanceDetailsCommand} */ - public describeApplicationInstanceDetails( + describeApplicationInstanceDetails( args: DescribeApplicationInstanceDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeApplicationInstanceDetails( + describeApplicationInstanceDetails( args: DescribeApplicationInstanceDetailsCommandInput, cb: (err: any, data?: DescribeApplicationInstanceDetailsCommandOutput) => void ): void; - public describeApplicationInstanceDetails( + describeApplicationInstanceDetails( args: DescribeApplicationInstanceDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeApplicationInstanceDetailsCommandOutput) => void ): void; - public describeApplicationInstanceDetails( - args: DescribeApplicationInstanceDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeApplicationInstanceDetailsCommandOutput) => void), - cb?: (err: any, data?: DescribeApplicationInstanceDetailsCommandOutput) => void - ): Promise | void { - const command = new DescribeApplicationInstanceDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a device.

+ * @see {@link DescribeDeviceCommand} */ - public describeDevice( + describeDevice( args: DescribeDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDevice( - args: DescribeDeviceCommandInput, - cb: (err: any, data?: DescribeDeviceCommandOutput) => void - ): void; - public describeDevice( + describeDevice(args: DescribeDeviceCommandInput, cb: (err: any, data?: DescribeDeviceCommandOutput) => void): void; + describeDevice( args: DescribeDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDeviceCommandOutput) => void ): void; - public describeDevice( - args: DescribeDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDeviceCommandOutput) => void), - cb?: (err: any, data?: DescribeDeviceCommandOutput) => void - ): Promise | void { - const command = new DescribeDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a device job.

+ * @see {@link DescribeDeviceJobCommand} */ - public describeDeviceJob( + describeDeviceJob( args: DescribeDeviceJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDeviceJob( + describeDeviceJob( args: DescribeDeviceJobCommandInput, cb: (err: any, data?: DescribeDeviceJobCommandOutput) => void ): void; - public describeDeviceJob( + describeDeviceJob( args: DescribeDeviceJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDeviceJobCommandOutput) => void ): void; - public describeDeviceJob( - args: DescribeDeviceJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDeviceJobCommandOutput) => void), - cb?: (err: any, data?: DescribeDeviceJobCommandOutput) => void - ): Promise | void { - const command = new DescribeDeviceJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a node.

+ * @see {@link DescribeNodeCommand} */ - public describeNode( - args: DescribeNodeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeNode(args: DescribeNodeCommandInput, cb: (err: any, data?: DescribeNodeCommandOutput) => void): void; - public describeNode( + describeNode(args: DescribeNodeCommandInput, options?: __HttpHandlerOptions): Promise; + describeNode(args: DescribeNodeCommandInput, cb: (err: any, data?: DescribeNodeCommandOutput) => void): void; + describeNode( args: DescribeNodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNodeCommandOutput) => void ): void; - public describeNode( - args: DescribeNodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeNodeCommandOutput) => void), - cb?: (err: any, data?: DescribeNodeCommandOutput) => void - ): Promise | void { - const command = new DescribeNodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a job to create a camera stream node.

+ * @see {@link DescribeNodeFromTemplateJobCommand} */ - public describeNodeFromTemplateJob( + describeNodeFromTemplateJob( args: DescribeNodeFromTemplateJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNodeFromTemplateJob( + describeNodeFromTemplateJob( args: DescribeNodeFromTemplateJobCommandInput, cb: (err: any, data?: DescribeNodeFromTemplateJobCommandOutput) => void ): void; - public describeNodeFromTemplateJob( + describeNodeFromTemplateJob( args: DescribeNodeFromTemplateJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNodeFromTemplateJobCommandOutput) => void ): void; - public describeNodeFromTemplateJob( - args: DescribeNodeFromTemplateJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeNodeFromTemplateJobCommandOutput) => void), - cb?: (err: any, data?: DescribeNodeFromTemplateJobCommandOutput) => void - ): Promise | void { - const command = new DescribeNodeFromTemplateJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a package.

+ * @see {@link DescribePackageCommand} */ - public describePackage( + describePackage( args: DescribePackageCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePackage( - args: DescribePackageCommandInput, - cb: (err: any, data?: DescribePackageCommandOutput) => void - ): void; - public describePackage( + describePackage(args: DescribePackageCommandInput, cb: (err: any, data?: DescribePackageCommandOutput) => void): void; + describePackage( args: DescribePackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePackageCommandOutput) => void ): void; - public describePackage( - args: DescribePackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePackageCommandOutput) => void), - cb?: (err: any, data?: DescribePackageCommandOutput) => void - ): Promise | void { - const command = new DescribePackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a package import job.

+ * @see {@link DescribePackageImportJobCommand} */ - public describePackageImportJob( + describePackageImportJob( args: DescribePackageImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePackageImportJob( + describePackageImportJob( args: DescribePackageImportJobCommandInput, cb: (err: any, data?: DescribePackageImportJobCommandOutput) => void ): void; - public describePackageImportJob( + describePackageImportJob( args: DescribePackageImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePackageImportJobCommandOutput) => void ): void; - public describePackageImportJob( - args: DescribePackageImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePackageImportJobCommandOutput) => void), - cb?: (err: any, data?: DescribePackageImportJobCommandOutput) => void - ): Promise | void { - const command = new DescribePackageImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a package version.

+ * @see {@link DescribePackageVersionCommand} */ - public describePackageVersion( + describePackageVersion( args: DescribePackageVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePackageVersion( + describePackageVersion( args: DescribePackageVersionCommandInput, cb: (err: any, data?: DescribePackageVersionCommandOutput) => void ): void; - public describePackageVersion( + describePackageVersion( args: DescribePackageVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePackageVersionCommandOutput) => void ): void; - public describePackageVersion( - args: DescribePackageVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePackageVersionCommandOutput) => void), - cb?: (err: any, data?: DescribePackageVersionCommandOutput) => void - ): Promise | void { - const command = new DescribePackageVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of application instance dependencies.

+ * @see {@link ListApplicationInstanceDependenciesCommand} */ - public listApplicationInstanceDependencies( + listApplicationInstanceDependencies( args: ListApplicationInstanceDependenciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplicationInstanceDependencies( + listApplicationInstanceDependencies( args: ListApplicationInstanceDependenciesCommandInput, cb: (err: any, data?: ListApplicationInstanceDependenciesCommandOutput) => void ): void; - public listApplicationInstanceDependencies( + listApplicationInstanceDependencies( args: ListApplicationInstanceDependenciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationInstanceDependenciesCommandOutput) => void ): void; - public listApplicationInstanceDependencies( - args: ListApplicationInstanceDependenciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationInstanceDependenciesCommandOutput) => void), - cb?: (err: any, data?: ListApplicationInstanceDependenciesCommandOutput) => void - ): Promise | void { - const command = new ListApplicationInstanceDependenciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of application node instances.

+ * @see {@link ListApplicationInstanceNodeInstancesCommand} */ - public listApplicationInstanceNodeInstances( + listApplicationInstanceNodeInstances( args: ListApplicationInstanceNodeInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplicationInstanceNodeInstances( + listApplicationInstanceNodeInstances( args: ListApplicationInstanceNodeInstancesCommandInput, cb: (err: any, data?: ListApplicationInstanceNodeInstancesCommandOutput) => void ): void; - public listApplicationInstanceNodeInstances( + listApplicationInstanceNodeInstances( args: ListApplicationInstanceNodeInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationInstanceNodeInstancesCommandOutput) => void ): void; - public listApplicationInstanceNodeInstances( - args: ListApplicationInstanceNodeInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationInstanceNodeInstancesCommandOutput) => void), - cb?: (err: any, data?: ListApplicationInstanceNodeInstancesCommandOutput) => void - ): Promise | void { - const command = new ListApplicationInstanceNodeInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of application instances.

+ * @see {@link ListApplicationInstancesCommand} */ - public listApplicationInstances( + listApplicationInstances( args: ListApplicationInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplicationInstances( + listApplicationInstances( args: ListApplicationInstancesCommandInput, cb: (err: any, data?: ListApplicationInstancesCommandOutput) => void ): void; - public listApplicationInstances( + listApplicationInstances( args: ListApplicationInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationInstancesCommandOutput) => void ): void; - public listApplicationInstances( - args: ListApplicationInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationInstancesCommandOutput) => void), - cb?: (err: any, data?: ListApplicationInstancesCommandOutput) => void - ): Promise | void { - const command = new ListApplicationInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of devices.

+ * @see {@link ListDevicesCommand} */ - public listDevices(args: ListDevicesCommandInput, options?: __HttpHandlerOptions): Promise; - public listDevices(args: ListDevicesCommandInput, cb: (err: any, data?: ListDevicesCommandOutput) => void): void; - public listDevices( + listDevices(args: ListDevicesCommandInput, options?: __HttpHandlerOptions): Promise; + listDevices(args: ListDevicesCommandInput, cb: (err: any, data?: ListDevicesCommandOutput) => void): void; + listDevices( args: ListDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDevicesCommandOutput) => void ): void; - public listDevices( - args: ListDevicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDevicesCommandOutput) => void), - cb?: (err: any, data?: ListDevicesCommandOutput) => void - ): Promise | void { - const command = new ListDevicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of jobs.

+ * @see {@link ListDevicesJobsCommand} */ - public listDevicesJobs( + listDevicesJobs( args: ListDevicesJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDevicesJobs( - args: ListDevicesJobsCommandInput, - cb: (err: any, data?: ListDevicesJobsCommandOutput) => void - ): void; - public listDevicesJobs( + listDevicesJobs(args: ListDevicesJobsCommandInput, cb: (err: any, data?: ListDevicesJobsCommandOutput) => void): void; + listDevicesJobs( args: ListDevicesJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDevicesJobsCommandOutput) => void ): void; - public listDevicesJobs( - args: ListDevicesJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDevicesJobsCommandOutput) => void), - cb?: (err: any, data?: ListDevicesJobsCommandOutput) => void - ): Promise | void { - const command = new ListDevicesJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of camera stream node jobs.

+ * @see {@link ListNodeFromTemplateJobsCommand} */ - public listNodeFromTemplateJobs( + listNodeFromTemplateJobs( args: ListNodeFromTemplateJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listNodeFromTemplateJobs( + listNodeFromTemplateJobs( args: ListNodeFromTemplateJobsCommandInput, cb: (err: any, data?: ListNodeFromTemplateJobsCommandOutput) => void ): void; - public listNodeFromTemplateJobs( + listNodeFromTemplateJobs( args: ListNodeFromTemplateJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNodeFromTemplateJobsCommandOutput) => void ): void; - public listNodeFromTemplateJobs( - args: ListNodeFromTemplateJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNodeFromTemplateJobsCommandOutput) => void), - cb?: (err: any, data?: ListNodeFromTemplateJobsCommandOutput) => void - ): Promise | void { - const command = new ListNodeFromTemplateJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of nodes.

+ * @see {@link ListNodesCommand} */ - public listNodes(args: ListNodesCommandInput, options?: __HttpHandlerOptions): Promise; - public listNodes(args: ListNodesCommandInput, cb: (err: any, data?: ListNodesCommandOutput) => void): void; - public listNodes( + listNodes(args: ListNodesCommandInput, options?: __HttpHandlerOptions): Promise; + listNodes(args: ListNodesCommandInput, cb: (err: any, data?: ListNodesCommandOutput) => void): void; + listNodes( args: ListNodesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNodesCommandOutput) => void ): void; - public listNodes( - args: ListNodesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNodesCommandOutput) => void), - cb?: (err: any, data?: ListNodesCommandOutput) => void - ): Promise | void { - const command = new ListNodesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of package import jobs.

+ * @see {@link ListPackageImportJobsCommand} */ - public listPackageImportJobs( + listPackageImportJobs( args: ListPackageImportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPackageImportJobs( + listPackageImportJobs( args: ListPackageImportJobsCommandInput, cb: (err: any, data?: ListPackageImportJobsCommandOutput) => void ): void; - public listPackageImportJobs( + listPackageImportJobs( args: ListPackageImportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPackageImportJobsCommandOutput) => void ): void; - public listPackageImportJobs( - args: ListPackageImportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPackageImportJobsCommandOutput) => void), - cb?: (err: any, data?: ListPackageImportJobsCommandOutput) => void - ): Promise | void { - const command = new ListPackageImportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of packages.

+ * @see {@link ListPackagesCommand} */ - public listPackages( - args: ListPackagesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listPackages(args: ListPackagesCommandInput, cb: (err: any, data?: ListPackagesCommandOutput) => void): void; - public listPackages( + listPackages(args: ListPackagesCommandInput, options?: __HttpHandlerOptions): Promise; + listPackages(args: ListPackagesCommandInput, cb: (err: any, data?: ListPackagesCommandOutput) => void): void; + listPackages( args: ListPackagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPackagesCommandOutput) => void ): void; - public listPackages( - args: ListPackagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPackagesCommandOutput) => void), - cb?: (err: any, data?: ListPackagesCommandOutput) => void - ): Promise | void { - const command = new ListPackagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of tags for a resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a - * provisioning certificate that is valid for 5 minutes. Name the configuration archive - * certificates-omni_device-name.zip and transfer it to the device within 5 - * minutes. Use the included USB storage device and connect it to the USB 3.0 port next to the HDMI output.

+ * @see {@link ProvisionDeviceCommand} */ - public provisionDevice( + provisionDevice( args: ProvisionDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public provisionDevice( - args: ProvisionDeviceCommandInput, - cb: (err: any, data?: ProvisionDeviceCommandOutput) => void - ): void; - public provisionDevice( + provisionDevice(args: ProvisionDeviceCommandInput, cb: (err: any, data?: ProvisionDeviceCommandOutput) => void): void; + provisionDevice( args: ProvisionDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ProvisionDeviceCommandOutput) => void ): void; - public provisionDevice( - args: ProvisionDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ProvisionDeviceCommandOutput) => void), - cb?: (err: any, data?: ProvisionDeviceCommandOutput) => void - ): Promise | void { - const command = new ProvisionDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers a package version.

+ * @see {@link RegisterPackageVersionCommand} */ - public registerPackageVersion( + registerPackageVersion( args: RegisterPackageVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerPackageVersion( + registerPackageVersion( args: RegisterPackageVersionCommandInput, cb: (err: any, data?: RegisterPackageVersionCommandOutput) => void ): void; - public registerPackageVersion( + registerPackageVersion( args: RegisterPackageVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterPackageVersionCommandOutput) => void ): void; - public registerPackageVersion( - args: RegisterPackageVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterPackageVersionCommandOutput) => void), - cb?: (err: any, data?: RegisterPackageVersionCommandOutput) => void - ): Promise | void { - const command = new RegisterPackageVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes an application instance.

+ * @see {@link RemoveApplicationInstanceCommand} */ - public removeApplicationInstance( + removeApplicationInstance( args: RemoveApplicationInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeApplicationInstance( + removeApplicationInstance( args: RemoveApplicationInstanceCommandInput, cb: (err: any, data?: RemoveApplicationInstanceCommandOutput) => void ): void; - public removeApplicationInstance( + removeApplicationInstance( args: RemoveApplicationInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveApplicationInstanceCommandOutput) => void ): void; - public removeApplicationInstance( - args: RemoveApplicationInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveApplicationInstanceCommandOutput) => void), - cb?: (err: any, data?: RemoveApplicationInstanceCommandOutput) => void - ): Promise | void { - const command = new RemoveApplicationInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Signal camera nodes to stop or resume.

+ * @see {@link SignalApplicationInstanceNodeInstancesCommand} */ - public signalApplicationInstanceNodeInstances( + signalApplicationInstanceNodeInstances( args: SignalApplicationInstanceNodeInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public signalApplicationInstanceNodeInstances( + signalApplicationInstanceNodeInstances( args: SignalApplicationInstanceNodeInstancesCommandInput, cb: (err: any, data?: SignalApplicationInstanceNodeInstancesCommandOutput) => void ): void; - public signalApplicationInstanceNodeInstances( + signalApplicationInstanceNodeInstances( args: SignalApplicationInstanceNodeInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SignalApplicationInstanceNodeInstancesCommandOutput) => void ): void; - public signalApplicationInstanceNodeInstances( - args: SignalApplicationInstanceNodeInstancesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: SignalApplicationInstanceNodeInstancesCommandOutput) => void), - cb?: (err: any, data?: SignalApplicationInstanceNodeInstancesCommandOutput) => void - ): Promise | void { - const command = new SignalApplicationInstanceNodeInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Tags a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a device's metadata.

+ * @see {@link UpdateDeviceMetadataCommand} */ - public updateDeviceMetadata( + updateDeviceMetadata( args: UpdateDeviceMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDeviceMetadata( + updateDeviceMetadata( args: UpdateDeviceMetadataCommandInput, cb: (err: any, data?: UpdateDeviceMetadataCommandOutput) => void ): void; - public updateDeviceMetadata( + updateDeviceMetadata( args: UpdateDeviceMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDeviceMetadataCommandOutput) => void ): void; - public updateDeviceMetadata( - args: UpdateDeviceMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDeviceMetadataCommandOutput) => void), - cb?: (err: any, data?: UpdateDeviceMetadataCommandOutput) => void - ): Promise | void { - const command = new UpdateDeviceMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * AWS Panorama + *

+ * Overview + *

+ *

This is the AWS Panorama API Reference. For an introduction to the service, see What is AWS Panorama? in the + * AWS Panorama Developer Guide.

+ */ +export class Panorama extends PanoramaClient implements Panorama {} +createAggregatedClient(commands, Panorama); diff --git a/clients/client-personalize-events/src/PersonalizeEvents.ts b/clients/client-personalize-events/src/PersonalizeEvents.ts index 6434bd978605..2a396e8f604d 100644 --- a/clients/client-personalize-events/src/PersonalizeEvents.ts +++ b/clients/client-personalize-events/src/PersonalizeEvents.ts @@ -1,100 +1,58 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { PutEventsCommand, PutEventsCommandInput, PutEventsCommandOutput } from "./commands/PutEventsCommand"; import { PutItemsCommand, PutItemsCommandInput, PutItemsCommandOutput } from "./commands/PutItemsCommand"; import { PutUsersCommand, PutUsersCommandInput, PutUsersCommandOutput } from "./commands/PutUsersCommand"; -import { PersonalizeEventsClient } from "./PersonalizeEventsClient"; +import { PersonalizeEventsClient, PersonalizeEventsClientConfig } from "./PersonalizeEventsClient"; -/** - * @public - *

Amazon Personalize can consume real-time user event data, such as stream or click data, and use - * it for model training either alone or combined with historical data. For more information see - * Recording Events.

- */ -export class PersonalizeEvents extends PersonalizeEventsClient { +const commands = { + PutEventsCommand, + PutItemsCommand, + PutUsersCommand, +}; + +export interface PersonalizeEvents { /** - * @public - *

Records user interaction event data. For more information see - * Recording Events.

+ * @see {@link PutEventsCommand} */ - public putEvents(args: PutEventsCommandInput, options?: __HttpHandlerOptions): Promise; - public putEvents(args: PutEventsCommandInput, cb: (err: any, data?: PutEventsCommandOutput) => void): void; - public putEvents( + putEvents(args: PutEventsCommandInput, options?: __HttpHandlerOptions): Promise; + putEvents(args: PutEventsCommandInput, cb: (err: any, data?: PutEventsCommandOutput) => void): void; + putEvents( args: PutEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEventsCommandOutput) => void ): void; - public putEvents( - args: PutEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutEventsCommandOutput) => void), - cb?: (err: any, data?: PutEventsCommandOutput) => void - ): Promise | void { - const command = new PutEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more items to an Items dataset. For more information see - * Importing Items Incrementally. - *

+ * @see {@link PutItemsCommand} */ - public putItems(args: PutItemsCommandInput, options?: __HttpHandlerOptions): Promise; - public putItems(args: PutItemsCommandInput, cb: (err: any, data?: PutItemsCommandOutput) => void): void; - public putItems( + putItems(args: PutItemsCommandInput, options?: __HttpHandlerOptions): Promise; + putItems(args: PutItemsCommandInput, cb: (err: any, data?: PutItemsCommandOutput) => void): void; + putItems( args: PutItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutItemsCommandOutput) => void ): void; - public putItems( - args: PutItemsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutItemsCommandOutput) => void), - cb?: (err: any, data?: PutItemsCommandOutput) => void - ): Promise | void { - const command = new PutItemsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more users to a Users dataset. For more information see - * Importing Users Incrementally.

+ * @see {@link PutUsersCommand} */ - public putUsers(args: PutUsersCommandInput, options?: __HttpHandlerOptions): Promise; - public putUsers(args: PutUsersCommandInput, cb: (err: any, data?: PutUsersCommandOutput) => void): void; - public putUsers( + putUsers(args: PutUsersCommandInput, options?: __HttpHandlerOptions): Promise; + putUsers(args: PutUsersCommandInput, cb: (err: any, data?: PutUsersCommandOutput) => void): void; + putUsers( args: PutUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutUsersCommandOutput) => void ): void; - public putUsers( - args: PutUsersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutUsersCommandOutput) => void), - cb?: (err: any, data?: PutUsersCommandOutput) => void - ): Promise | void { - const command = new PutUsersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Personalize can consume real-time user event data, such as stream or click data, and use + * it for model training either alone or combined with historical data. For more information see + * Recording Events.

+ */ +export class PersonalizeEvents extends PersonalizeEventsClient implements PersonalizeEvents {} +createAggregatedClient(commands, PersonalizeEvents); diff --git a/clients/client-personalize-runtime/src/PersonalizeRuntime.ts b/clients/client-personalize-runtime/src/PersonalizeRuntime.ts index c414d36e3590..e9f51a1168d2 100644 --- a/clients/client-personalize-runtime/src/PersonalizeRuntime.ts +++ b/clients/client-personalize-runtime/src/PersonalizeRuntime.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -11,98 +12,52 @@ import { GetRecommendationsCommandInput, GetRecommendationsCommandOutput, } from "./commands/GetRecommendationsCommand"; -import { PersonalizeRuntimeClient } from "./PersonalizeRuntimeClient"; +import { PersonalizeRuntimeClient, PersonalizeRuntimeClientConfig } from "./PersonalizeRuntimeClient"; -/** - * @public - *

- */ -export class PersonalizeRuntime extends PersonalizeRuntimeClient { +const commands = { + GetPersonalizedRankingCommand, + GetRecommendationsCommand, +}; + +export interface PersonalizeRuntime { /** - * @public - *

Re-ranks a list of recommended items for the given user. The first item in the list is - * deemed the most likely item to be of interest to the user.

- * - *

The solution backing the campaign must have been created using a recipe of type - * PERSONALIZED_RANKING.

- *
+ * @see {@link GetPersonalizedRankingCommand} */ - public getPersonalizedRanking( + getPersonalizedRanking( args: GetPersonalizedRankingCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPersonalizedRanking( + getPersonalizedRanking( args: GetPersonalizedRankingCommandInput, cb: (err: any, data?: GetPersonalizedRankingCommandOutput) => void ): void; - public getPersonalizedRanking( + getPersonalizedRanking( args: GetPersonalizedRankingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPersonalizedRankingCommandOutput) => void ): void; - public getPersonalizedRanking( - args: GetPersonalizedRankingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPersonalizedRankingCommandOutput) => void), - cb?: (err: any, data?: GetPersonalizedRankingCommandOutput) => void - ): Promise | void { - const command = new GetPersonalizedRankingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of recommended items. For campaigns, the campaign's Amazon Resource Name (ARN) is required and the required user and item input depends on the recipe type used to - * create the solution backing the campaign as follows:

- *
    - *
  • - *

    USER_PERSONALIZATION - userId required, itemId not used

    - *
  • - *
  • - *

    RELATED_ITEMS - itemId required, userId not used

    - *
  • - *
- * - *

Campaigns that are backed by a solution created using a recipe of type - * PERSONALIZED_RANKING use the API.

- *
- *

- * For recommenders, the recommender's ARN is required and the required item and user input depends on the use case (domain-based recipe) backing the recommender. - * For information on use case requirements see Choosing recommender use cases. - *

+ * @see {@link GetRecommendationsCommand} */ - public getRecommendations( + getRecommendations( args: GetRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRecommendations( + getRecommendations( args: GetRecommendationsCommandInput, cb: (err: any, data?: GetRecommendationsCommandOutput) => void ): void; - public getRecommendations( + getRecommendations( args: GetRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRecommendationsCommandOutput) => void ): void; - public getRecommendations( - args: GetRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRecommendationsCommandOutput) => void), - cb?: (err: any, data?: GetRecommendationsCommandOutput) => void - ): Promise | void { - const command = new GetRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

+ */ +export class PersonalizeRuntime extends PersonalizeRuntimeClient implements PersonalizeRuntime {} +createAggregatedClient(commands, PersonalizeRuntime); diff --git a/clients/client-personalize/src/Personalize.ts b/clients/client-personalize/src/Personalize.ts index a6fabdcaed5a..01febc508a9b 100644 --- a/clients/client-personalize/src/Personalize.ts +++ b/clients/client-personalize/src/Personalize.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -315,2856 +316,1091 @@ import { UpdateRecommenderCommandInput, UpdateRecommenderCommandOutput, } from "./commands/UpdateRecommenderCommand"; -import { PersonalizeClient } from "./PersonalizeClient"; +import { PersonalizeClient, PersonalizeClientConfig } from "./PersonalizeClient"; -/** - * @public - *

Amazon Personalize is a machine learning service that makes it easy to add individualized - * recommendations to customers.

- */ -export class Personalize extends PersonalizeClient { +const commands = { + CreateBatchInferenceJobCommand, + CreateBatchSegmentJobCommand, + CreateCampaignCommand, + CreateDatasetCommand, + CreateDatasetExportJobCommand, + CreateDatasetGroupCommand, + CreateDatasetImportJobCommand, + CreateEventTrackerCommand, + CreateFilterCommand, + CreateMetricAttributionCommand, + CreateRecommenderCommand, + CreateSchemaCommand, + CreateSolutionCommand, + CreateSolutionVersionCommand, + DeleteCampaignCommand, + DeleteDatasetCommand, + DeleteDatasetGroupCommand, + DeleteEventTrackerCommand, + DeleteFilterCommand, + DeleteMetricAttributionCommand, + DeleteRecommenderCommand, + DeleteSchemaCommand, + DeleteSolutionCommand, + DescribeAlgorithmCommand, + DescribeBatchInferenceJobCommand, + DescribeBatchSegmentJobCommand, + DescribeCampaignCommand, + DescribeDatasetCommand, + DescribeDatasetExportJobCommand, + DescribeDatasetGroupCommand, + DescribeDatasetImportJobCommand, + DescribeEventTrackerCommand, + DescribeFeatureTransformationCommand, + DescribeFilterCommand, + DescribeMetricAttributionCommand, + DescribeRecipeCommand, + DescribeRecommenderCommand, + DescribeSchemaCommand, + DescribeSolutionCommand, + DescribeSolutionVersionCommand, + GetSolutionMetricsCommand, + ListBatchInferenceJobsCommand, + ListBatchSegmentJobsCommand, + ListCampaignsCommand, + ListDatasetExportJobsCommand, + ListDatasetGroupsCommand, + ListDatasetImportJobsCommand, + ListDatasetsCommand, + ListEventTrackersCommand, + ListFiltersCommand, + ListMetricAttributionMetricsCommand, + ListMetricAttributionsCommand, + ListRecipesCommand, + ListRecommendersCommand, + ListSchemasCommand, + ListSolutionsCommand, + ListSolutionVersionsCommand, + ListTagsForResourceCommand, + StartRecommenderCommand, + StopRecommenderCommand, + StopSolutionVersionCreationCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateCampaignCommand, + UpdateMetricAttributionCommand, + UpdateRecommenderCommand, +}; + +export interface Personalize { /** - * @public - *

Creates a batch inference job. The operation can handle up to 50 million records and the - * input file must be in JSON format. For more information, see - * Creating a batch inference job. - *

+ * @see {@link CreateBatchInferenceJobCommand} */ - public createBatchInferenceJob( + createBatchInferenceJob( args: CreateBatchInferenceJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBatchInferenceJob( + createBatchInferenceJob( args: CreateBatchInferenceJobCommandInput, cb: (err: any, data?: CreateBatchInferenceJobCommandOutput) => void ): void; - public createBatchInferenceJob( + createBatchInferenceJob( args: CreateBatchInferenceJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBatchInferenceJobCommandOutput) => void ): void; - public createBatchInferenceJob( - args: CreateBatchInferenceJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBatchInferenceJobCommandOutput) => void), - cb?: (err: any, data?: CreateBatchInferenceJobCommandOutput) => void - ): Promise | void { - const command = new CreateBatchInferenceJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a batch segment job. The operation can handle up to 50 million records and the - * input file must be in JSON format. For more information, see - * Getting batch recommendations and user segments.

- */ - public createBatchSegmentJob( + + /** + * @see {@link CreateBatchSegmentJobCommand} + */ + createBatchSegmentJob( args: CreateBatchSegmentJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBatchSegmentJob( + createBatchSegmentJob( args: CreateBatchSegmentJobCommandInput, cb: (err: any, data?: CreateBatchSegmentJobCommandOutput) => void ): void; - public createBatchSegmentJob( + createBatchSegmentJob( args: CreateBatchSegmentJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBatchSegmentJobCommandOutput) => void ): void; - public createBatchSegmentJob( - args: CreateBatchSegmentJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBatchSegmentJobCommandOutput) => void), - cb?: (err: any, data?: CreateBatchSegmentJobCommandOutput) => void - ): Promise | void { - const command = new CreateBatchSegmentJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a campaign that deploys a solution version. When a client calls the - * GetRecommendations - * and - * GetPersonalizedRanking - * APIs, a campaign is specified in the request.

- * - *

- * Minimum Provisioned TPS and Auto-Scaling - *

- * - *

A transaction is a single GetRecommendations or - * GetPersonalizedRanking call. Transactions per second (TPS) is the throughput - * and unit of billing for Amazon Personalize. The minimum provisioned TPS - * (minProvisionedTPS) specifies the baseline throughput provisioned by - * Amazon Personalize, and thus, the minimum billing charge. - *

- *

- * If your TPS increases beyond - * minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, - * but never below minProvisionedTPS. - * There's a short time delay while the capacity is increased that might cause loss of - * transactions.

- *

The actual TPS used is calculated as the average requests/second within a 5-minute window. - * You pay for maximum of either the minimum provisioned TPS or the actual TPS. - * We recommend starting with a low minProvisionedTPS, track - * your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS - * as necessary.

- * - *

- * Status - *

- *

A campaign can be in one of the following states:

- *
    - *
  • - *

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    - *
  • - *
  • - *

    DELETE PENDING > DELETE IN_PROGRESS

    - *
  • - *
- *

To get the campaign status, call DescribeCampaign.

- * - *

Wait until the status of the campaign - * is ACTIVE before asking the campaign for recommendations.

- *
- *

- * Related APIs - *

- * - */ - public createCampaign( + + /** + * @see {@link CreateCampaignCommand} + */ + createCampaign( args: CreateCampaignCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCampaign( - args: CreateCampaignCommandInput, - cb: (err: any, data?: CreateCampaignCommandOutput) => void - ): void; - public createCampaign( + createCampaign(args: CreateCampaignCommandInput, cb: (err: any, data?: CreateCampaignCommandOutput) => void): void; + createCampaign( args: CreateCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCampaignCommandOutput) => void ): void; - public createCampaign( - args: CreateCampaignCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCampaignCommandOutput) => void), - cb?: (err: any, data?: CreateCampaignCommandOutput) => void - ): Promise | void { - const command = new CreateCampaignCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an empty dataset and adds it to the specified dataset group. - * Use CreateDatasetImportJob to import your training data to a - * dataset.

- * - *

There are three types of datasets:

- *
    - *
  • - *

    Interactions

    - *
  • - *
  • - *

    Items

    - *
  • - *
  • - *

    Users

    - *
  • - *
- *

Each dataset type has an associated schema with required field types. - * Only the Interactions dataset is required in order to train a - * model (also referred to as creating a solution).

- *

A dataset can be in one of the following states:

- *
    - *
  • - *

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE - * FAILED

    - *
  • - *
  • - *

    DELETE PENDING > DELETE IN_PROGRESS

    - *
  • - *
- *

To get the status of the dataset, call DescribeDataset.

- *

- * Related APIs - *

- * - */ - public createDataset( - args: CreateDatasetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createDataset( - args: CreateDatasetCommandInput, - cb: (err: any, data?: CreateDatasetCommandOutput) => void - ): void; - public createDataset( + + /** + * @see {@link CreateDatasetCommand} + */ + createDataset(args: CreateDatasetCommandInput, options?: __HttpHandlerOptions): Promise; + createDataset(args: CreateDatasetCommandInput, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void; + createDataset( args: CreateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetCommandOutput) => void ): void; - public createDataset( - args: CreateDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDatasetCommandOutput) => void), - cb?: (err: any, data?: CreateDatasetCommandOutput) => void - ): Promise | void { - const command = new CreateDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a job that exports data from your dataset to an Amazon S3 bucket. - * To allow Amazon Personalize to export the training data, you must specify an - * service-linked IAM role that gives Amazon Personalize PutObject - * permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon Personalize developer guide.

- *

- * Status - *

- *

A dataset export job can be in one of the following states:

- *
    - *
  • - *

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE - * FAILED

    - *
  • - *
- *

To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name - * (ARN) of the dataset export job. The dataset export is complete when the - * status shows as ACTIVE. If the status shows as CREATE FAILED, the response - * includes a failureReason key, which describes why the job - * failed.

- */ - public createDatasetExportJob( + + /** + * @see {@link CreateDatasetExportJobCommand} + */ + createDatasetExportJob( args: CreateDatasetExportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDatasetExportJob( + createDatasetExportJob( args: CreateDatasetExportJobCommandInput, cb: (err: any, data?: CreateDatasetExportJobCommandOutput) => void ): void; - public createDatasetExportJob( + createDatasetExportJob( args: CreateDatasetExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetExportJobCommandOutput) => void ): void; - public createDatasetExportJob( - args: CreateDatasetExportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDatasetExportJobCommandOutput) => void), - cb?: (err: any, data?: CreateDatasetExportJobCommandOutput) => void - ): Promise | void { - const command = new CreateDatasetExportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an empty dataset group. A dataset group is a container for - * Amazon Personalize resources. A dataset group can contain at most three datasets, one - * for each type of dataset:

- *
    - *
  • - *

    Interactions

    - *
  • - *
  • - *

    Items

    - *
  • - *
  • - *

    Users

    - *
  • - *
- *

A dataset group can be a Domain dataset group, where you specify a - * domain and use pre-configured resources like recommenders, or a - * Custom dataset group, where you use custom resources, such as a solution - * with a solution version, that you deploy with a campaign. If you start - * with a Domain dataset group, you can still add custom resources such as - * solutions and solution versions trained with recipes for custom use cases - * and deployed with campaigns.

- *

A dataset group can be in one of the following states:

- *
    - *
  • - *

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE - * FAILED

    - *
  • - *
  • - *

    DELETE PENDING

    - *
  • - *
- *

To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the - * response includes a failureReason key, which describes why - * the creation failed.

- * - *

You must wait until the status of the dataset group is - * ACTIVE before adding a dataset to the group.

- *
- *

You can specify an Key Management Service (KMS) key to encrypt the datasets in - * the group. If you specify a KMS key, you must also include an Identity and Access Management - * (IAM) role that has permission to access the key.

- *

- * APIs that require a dataset group ARN in the request - *

- * - *

- * Related APIs - *

- * - */ - public createDatasetGroup( + + /** + * @see {@link CreateDatasetGroupCommand} + */ + createDatasetGroup( args: CreateDatasetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDatasetGroup( + createDatasetGroup( args: CreateDatasetGroupCommandInput, cb: (err: any, data?: CreateDatasetGroupCommandOutput) => void ): void; - public createDatasetGroup( + createDatasetGroup( args: CreateDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetGroupCommandOutput) => void ): void; - public createDatasetGroup( - args: CreateDatasetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDatasetGroupCommandOutput) => void), - cb?: (err: any, data?: CreateDatasetGroupCommandOutput) => void - ): Promise | void { - const command = new CreateDatasetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a job that imports training data from your data source (an - * Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the - * training data, you must specify an IAM service role that has permission to - * read from the data source, as Amazon Personalize makes a copy of your data and - * processes it internally. For information on granting access to your Amazon S3 - * bucket, see Giving - * Amazon Personalize Access to Amazon S3 Resources.

- * - *

By default, a dataset import job replaces any existing data in the - * dataset that you imported in bulk. To add new records without replacing - * existing data, specify INCREMENTAL for the import mode in the - * CreateDatasetImportJob operation.

- *
- *

- * Status - *

- *

A dataset import job can be in one of the following states:

- *
    - *
  • - *

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE - * FAILED

    - *
  • - *
- *

To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name - * (ARN) of the dataset import job. The dataset import is complete when the - * status shows as ACTIVE. If the status shows as CREATE FAILED, the response - * includes a failureReason key, which describes why the job - * failed.

- * - *

Importing takes time. You must wait until the status shows as ACTIVE - * before training a model using the dataset.

- *
- * - *

- * Related APIs - *

- * - */ - public createDatasetImportJob( + + /** + * @see {@link CreateDatasetImportJobCommand} + */ + createDatasetImportJob( args: CreateDatasetImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDatasetImportJob( + createDatasetImportJob( args: CreateDatasetImportJobCommandInput, cb: (err: any, data?: CreateDatasetImportJobCommandOutput) => void ): void; - public createDatasetImportJob( + createDatasetImportJob( args: CreateDatasetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetImportJobCommandOutput) => void ): void; - public createDatasetImportJob( - args: CreateDatasetImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDatasetImportJobCommandOutput) => void), - cb?: (err: any, data?: CreateDatasetImportJobCommandOutput) => void - ): Promise | void { - const command = new CreateDatasetImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an event tracker that you use when adding event data to a specified dataset - * group using the - * PutEvents API.

- * - *

Only one event tracker can be associated with a dataset group. You will get - * an error if you call CreateEventTracker using the same dataset group as an - * existing event tracker.

- *
- *

When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the - * PutEvents operation. - * Amazon Personalize then appends the event data to the Interactions dataset of the dataset group you specify - * in your event tracker. - *

- *

The event tracker can be in one of the following states:

- *
    - *
  • - *

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    - *
  • - *
  • - *

    DELETE PENDING > DELETE IN_PROGRESS

    - *
  • - *
- *

To get the status of the event tracker, call DescribeEventTracker.

- * - *

The event tracker must be in the ACTIVE state before using the tracking ID.

- *
- *

- * Related APIs - *

- * - */ - public createEventTracker( + + /** + * @see {@link CreateEventTrackerCommand} + */ + createEventTracker( args: CreateEventTrackerCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEventTracker( + createEventTracker( args: CreateEventTrackerCommandInput, cb: (err: any, data?: CreateEventTrackerCommandOutput) => void ): void; - public createEventTracker( + createEventTracker( args: CreateEventTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEventTrackerCommandOutput) => void ): void; - public createEventTracker( - args: CreateEventTrackerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEventTrackerCommandOutput) => void), - cb?: (err: any, data?: CreateEventTrackerCommandOutput) => void - ): Promise | void { - const command = new CreateEventTrackerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a recommendation filter. For more information, see Filtering recommendations and user segments.

- */ - public createFilter( - args: CreateFilterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createFilter(args: CreateFilterCommandInput, cb: (err: any, data?: CreateFilterCommandOutput) => void): void; - public createFilter( + + /** + * @see {@link CreateFilterCommand} + */ + createFilter(args: CreateFilterCommandInput, options?: __HttpHandlerOptions): Promise; + createFilter(args: CreateFilterCommandInput, cb: (err: any, data?: CreateFilterCommandOutput) => void): void; + createFilter( args: CreateFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFilterCommandOutput) => void ): void; - public createFilter( - args: CreateFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFilterCommandOutput) => void), - cb?: (err: any, data?: CreateFilterCommandOutput) => void - ): Promise | void { - const command = new CreateFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a metric attribution. - * A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you imported the data, you can view reports in Amazon CloudWatch or Amazon S3. - * For more information, see Measuring impact of recommendations.

- */ - public createMetricAttribution( + + /** + * @see {@link CreateMetricAttributionCommand} + */ + createMetricAttribution( args: CreateMetricAttributionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMetricAttribution( + createMetricAttribution( args: CreateMetricAttributionCommandInput, cb: (err: any, data?: CreateMetricAttributionCommandOutput) => void ): void; - public createMetricAttribution( + createMetricAttribution( args: CreateMetricAttributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMetricAttributionCommandOutput) => void ): void; - public createMetricAttribution( - args: CreateMetricAttributionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMetricAttributionCommandOutput) => void), - cb?: (err: any, data?: CreateMetricAttributionCommandOutput) => void - ): Promise | void { - const command = new CreateMetricAttributionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a recommender with the recipe (a Domain dataset group use case) you specify. - * You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a - * GetRecommendations - * request. - *

- * - *

- * Minimum recommendation requests per second - *

- * - *

When you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second - * (minRecommendationRequestsPerSecond) specifies the baseline recommendation request throughput provisioned by - * Amazon Personalize. The default minRecommendationRequestsPerSecond is 1. A recommendation request is a single GetRecommendations operation. - * Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive - * your requests per hour and the price of your recommender usage. - *

- *

- * If your requests per second increases beyond - * minRecommendationRequestsPerSecond, Amazon Personalize auto-scales the provisioned capacity up and down, - * but never below minRecommendationRequestsPerSecond. - * There's a short time delay while the capacity is increased that might cause loss of - * requests.

- *

- * Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) - * or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window. - * - * We recommend starting with the default minRecommendationRequestsPerSecond, track - * your usage using Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond - * as necessary. - *

- * - *

- * Status - *

- *

A recommender can be in one of the following states:

- *
    - *
  • - *

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    - *
  • - *
  • - *

    STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE

    - *
  • - *
  • - *

    DELETE PENDING > DELETE IN_PROGRESS

    - *
  • - *
- *

To get the recommender status, call DescribeRecommender.

- * - *

Wait until the status of the recommender - * is ACTIVE before asking the recommender for recommendations.

- *
- *

- * Related APIs - *

- * - */ - public createRecommender( + + /** + * @see {@link CreateRecommenderCommand} + */ + createRecommender( args: CreateRecommenderCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRecommender( + createRecommender( args: CreateRecommenderCommandInput, cb: (err: any, data?: CreateRecommenderCommandOutput) => void ): void; - public createRecommender( + createRecommender( args: CreateRecommenderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRecommenderCommandOutput) => void ): void; - public createRecommender( - args: CreateRecommenderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRecommenderCommandOutput) => void), - cb?: (err: any, data?: CreateRecommenderCommandOutput) => void - ): Promise | void { - const command = new CreateRecommenderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon Personalize schema from the specified schema string. The schema you create - * must be in Avro JSON format.

- *

Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset - * type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you - * provide the domain of the Domain dataset group. - * You specify a schema when you call CreateDataset.

- * - *

- * Related APIs - *

- * - */ - public createSchema( - args: CreateSchemaCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createSchema(args: CreateSchemaCommandInput, cb: (err: any, data?: CreateSchemaCommandOutput) => void): void; - public createSchema( + + /** + * @see {@link CreateSchemaCommand} + */ + createSchema(args: CreateSchemaCommandInput, options?: __HttpHandlerOptions): Promise; + createSchema(args: CreateSchemaCommandInput, cb: (err: any, data?: CreateSchemaCommandOutput) => void): void; + createSchema( args: CreateSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSchemaCommandOutput) => void ): void; - public createSchema( - args: CreateSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSchemaCommandOutput) => void), - cb?: (err: any, data?: CreateSchemaCommandOutput) => void - ): Promise | void { - const command = new CreateSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates the configuration for training a model. A trained model is known as - * a solution. After the configuration is created, you train the model (create a solution) - * by calling the CreateSolutionVersion operation. Every time you call - * CreateSolutionVersion, a new version of the solution is created.

- *

After creating a solution version, you check its accuracy by calling - * GetSolutionMetrics. When you are satisfied with the version, you - * deploy it using CreateCampaign. The campaign provides recommendations - * to a client through the - * GetRecommendations API.

- *

To train a model, Amazon Personalize requires training data and a recipe. The training data - * comes from the dataset group that you provide in the request. A recipe specifies - * the training algorithm and a feature transformation. You can specify one of the predefined - * recipes provided by Amazon Personalize. Alternatively, you can specify - * performAutoML and Amazon Personalize will analyze your data and select the - * optimum USER_PERSONALIZATION recipe for you.

- * - *

Amazon Personalize doesn't support configuring the hpoObjective - * for solution hyperparameter optimization at this time.

- *
- *

- * Status - *

- *

A solution can be in one of the following states:

- *
    - *
  • - *

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    - *
  • - *
  • - *

    DELETE PENDING > DELETE IN_PROGRESS

    - *
  • - *
- *

To get the status of the solution, call DescribeSolution. Wait - * until the status shows as ACTIVE before calling CreateSolutionVersion.

- * - * - * - *

- * Related APIs - *

- * - * - */ - public createSolution( + + /** + * @see {@link CreateSolutionCommand} + */ + createSolution( args: CreateSolutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSolution( - args: CreateSolutionCommandInput, - cb: (err: any, data?: CreateSolutionCommandOutput) => void - ): void; - public createSolution( + createSolution(args: CreateSolutionCommandInput, cb: (err: any, data?: CreateSolutionCommandOutput) => void): void; + createSolution( args: CreateSolutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSolutionCommandOutput) => void ): void; - public createSolution( - args: CreateSolutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSolutionCommandOutput) => void), - cb?: (err: any, data?: CreateSolutionCommandOutput) => void - ): Promise | void { - const command = new CreateSolutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Trains or retrains an active solution in a Custom dataset group. A solution is created using the CreateSolution - * operation and must be in the ACTIVE state before calling - * CreateSolutionVersion. A new version of the solution is created every time you - * call this operation.

- *

- * Status - *

- *

A solution version can be in one of the following states:

- *
    - *
  • - *

    CREATE PENDING

    - *
  • - *
  • - *

    CREATE IN_PROGRESS

    - *
  • - *
  • - *

    ACTIVE

    - *
  • - *
  • - *

    CREATE FAILED

    - *
  • - *
  • - *

    CREATE STOPPING

    - *
  • - *
  • - *

    CREATE STOPPED

    - *
  • - *
- *

To get the status of the version, call DescribeSolutionVersion. Wait - * until the status shows as ACTIVE before calling CreateCampaign.

- *

If the status shows as CREATE FAILED, the response includes a failureReason - * key, which describes why the job failed.

- *

- * Related APIs - *

- * - */ - public createSolutionVersion( + + /** + * @see {@link CreateSolutionVersionCommand} + */ + createSolutionVersion( args: CreateSolutionVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSolutionVersion( + createSolutionVersion( args: CreateSolutionVersionCommandInput, cb: (err: any, data?: CreateSolutionVersionCommandOutput) => void ): void; - public createSolutionVersion( + createSolutionVersion( args: CreateSolutionVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSolutionVersionCommandOutput) => void ): void; - public createSolutionVersion( - args: CreateSolutionVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSolutionVersionCommandOutput) => void), - cb?: (err: any, data?: CreateSolutionVersionCommandOutput) => void - ): Promise | void { - const command = new CreateSolutionVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a campaign by deleting the solution deployment. The solution that - * the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no - * longer be specified in a - * GetRecommendations - * request. - * For information on creating campaigns, see CreateCampaign.

- */ - public deleteCampaign( + + /** + * @see {@link DeleteCampaignCommand} + */ + deleteCampaign( args: DeleteCampaignCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCampaign( - args: DeleteCampaignCommandInput, - cb: (err: any, data?: DeleteCampaignCommandOutput) => void - ): void; - public deleteCampaign( + deleteCampaign(args: DeleteCampaignCommandInput, cb: (err: any, data?: DeleteCampaignCommandOutput) => void): void; + deleteCampaign( args: DeleteCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCampaignCommandOutput) => void ): void; - public deleteCampaign( - args: DeleteCampaignCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCampaignCommandOutput) => void), - cb?: (err: any, data?: DeleteCampaignCommandOutput) => void - ): Promise | void { - const command = new DeleteCampaignCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a dataset. You can't delete a dataset if an associated - * DatasetImportJob or SolutionVersion is in the - * CREATE PENDING or IN PROGRESS state. For more information on datasets, see - * CreateDataset.

- */ - public deleteDataset( - args: DeleteDatasetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDataset( - args: DeleteDatasetCommandInput, - cb: (err: any, data?: DeleteDatasetCommandOutput) => void - ): void; - public deleteDataset( + + /** + * @see {@link DeleteDatasetCommand} + */ + deleteDataset(args: DeleteDatasetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDataset(args: DeleteDatasetCommandInput, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void; + deleteDataset( args: DeleteDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetCommandOutput) => void ): void; - public deleteDataset( - args: DeleteDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDatasetCommandOutput) => void), - cb?: (err: any, data?: DeleteDatasetCommandOutput) => void - ): Promise | void { - const command = new DeleteDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a dataset group. Before you delete a dataset group, you must - * delete the following:

- *
    - *
  • - *

    All associated event trackers.

    - *
  • - *
  • - *

    All associated solutions.

    - *
  • - *
  • - *

    All datasets in the dataset group.

    - *
  • - *
- */ - public deleteDatasetGroup( + + /** + * @see {@link DeleteDatasetGroupCommand} + */ + deleteDatasetGroup( args: DeleteDatasetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDatasetGroup( + deleteDatasetGroup( args: DeleteDatasetGroupCommandInput, cb: (err: any, data?: DeleteDatasetGroupCommandOutput) => void ): void; - public deleteDatasetGroup( + deleteDatasetGroup( args: DeleteDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetGroupCommandOutput) => void ): void; - public deleteDatasetGroup( - args: DeleteDatasetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDatasetGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteDatasetGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteDatasetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the event tracker. Does not delete the event-interactions dataset from - * the associated dataset group. For more - * information on event trackers, see CreateEventTracker.

- */ - public deleteEventTracker( + + /** + * @see {@link DeleteEventTrackerCommand} + */ + deleteEventTracker( args: DeleteEventTrackerCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEventTracker( + deleteEventTracker( args: DeleteEventTrackerCommandInput, cb: (err: any, data?: DeleteEventTrackerCommandOutput) => void ): void; - public deleteEventTracker( + deleteEventTracker( args: DeleteEventTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventTrackerCommandOutput) => void ): void; - public deleteEventTracker( - args: DeleteEventTrackerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEventTrackerCommandOutput) => void), - cb?: (err: any, data?: DeleteEventTrackerCommandOutput) => void - ): Promise | void { - const command = new DeleteEventTrackerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a filter.

- */ - public deleteFilter( - args: DeleteFilterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteFilter(args: DeleteFilterCommandInput, cb: (err: any, data?: DeleteFilterCommandOutput) => void): void; - public deleteFilter( + + /** + * @see {@link DeleteFilterCommand} + */ + deleteFilter(args: DeleteFilterCommandInput, options?: __HttpHandlerOptions): Promise; + deleteFilter(args: DeleteFilterCommandInput, cb: (err: any, data?: DeleteFilterCommandOutput) => void): void; + deleteFilter( args: DeleteFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFilterCommandOutput) => void ): void; - public deleteFilter( - args: DeleteFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFilterCommandOutput) => void), - cb?: (err: any, data?: DeleteFilterCommandOutput) => void - ): Promise | void { - const command = new DeleteFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a metric attribution.

- */ - public deleteMetricAttribution( + + /** + * @see {@link DeleteMetricAttributionCommand} + */ + deleteMetricAttribution( args: DeleteMetricAttributionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMetricAttribution( + deleteMetricAttribution( args: DeleteMetricAttributionCommandInput, cb: (err: any, data?: DeleteMetricAttributionCommandOutput) => void ): void; - public deleteMetricAttribution( + deleteMetricAttribution( args: DeleteMetricAttributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMetricAttributionCommandOutput) => void ): void; - public deleteMetricAttribution( - args: DeleteMetricAttributionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMetricAttributionCommandOutput) => void), - cb?: (err: any, data?: DeleteMetricAttributionCommandOutput) => void - ): Promise | void { - const command = new DeleteMetricAttributionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations - * request.

- */ - public deleteRecommender( + + /** + * @see {@link DeleteRecommenderCommand} + */ + deleteRecommender( args: DeleteRecommenderCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRecommender( + deleteRecommender( args: DeleteRecommenderCommandInput, cb: (err: any, data?: DeleteRecommenderCommandOutput) => void ): void; - public deleteRecommender( + deleteRecommender( args: DeleteRecommenderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRecommenderCommandOutput) => void ): void; - public deleteRecommender( - args: DeleteRecommenderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRecommenderCommandOutput) => void), - cb?: (err: any, data?: DeleteRecommenderCommandOutput) => void - ): Promise | void { - const command = new DeleteRecommenderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a schema. Before deleting a schema, you must delete all - * datasets referencing the schema. For more information on schemas, see - * CreateSchema.

- */ - public deleteSchema( - args: DeleteSchemaCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteSchema(args: DeleteSchemaCommandInput, cb: (err: any, data?: DeleteSchemaCommandOutput) => void): void; - public deleteSchema( + + /** + * @see {@link DeleteSchemaCommand} + */ + deleteSchema(args: DeleteSchemaCommandInput, options?: __HttpHandlerOptions): Promise; + deleteSchema(args: DeleteSchemaCommandInput, cb: (err: any, data?: DeleteSchemaCommandOutput) => void): void; + deleteSchema( args: DeleteSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSchemaCommandOutput) => void ): void; - public deleteSchema( - args: DeleteSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSchemaCommandOutput) => void), - cb?: (err: any, data?: DeleteSchemaCommandOutput) => void - ): Promise | void { - const command = new DeleteSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes all versions of a solution and the Solution object itself. - * Before deleting a solution, you must delete all campaigns based on - * the solution. To determine what campaigns are using the solution, call - * ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. - * You can't delete a solution if an associated SolutionVersion is in the - * CREATE PENDING or IN PROGRESS state. - * For more information on solutions, see CreateSolution.

- */ - public deleteSolution( + + /** + * @see {@link DeleteSolutionCommand} + */ + deleteSolution( args: DeleteSolutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSolution( - args: DeleteSolutionCommandInput, - cb: (err: any, data?: DeleteSolutionCommandOutput) => void - ): void; - public deleteSolution( + deleteSolution(args: DeleteSolutionCommandInput, cb: (err: any, data?: DeleteSolutionCommandOutput) => void): void; + deleteSolution( args: DeleteSolutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSolutionCommandOutput) => void ): void; - public deleteSolution( - args: DeleteSolutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSolutionCommandOutput) => void), - cb?: (err: any, data?: DeleteSolutionCommandOutput) => void - ): Promise | void { - const command = new DeleteSolutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the given algorithm.

- */ - public describeAlgorithm( + + /** + * @see {@link DescribeAlgorithmCommand} + */ + describeAlgorithm( args: DescribeAlgorithmCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAlgorithm( + describeAlgorithm( args: DescribeAlgorithmCommandInput, cb: (err: any, data?: DescribeAlgorithmCommandOutput) => void ): void; - public describeAlgorithm( + describeAlgorithm( args: DescribeAlgorithmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAlgorithmCommandOutput) => void ): void; - public describeAlgorithm( - args: DescribeAlgorithmCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAlgorithmCommandOutput) => void), - cb?: (err: any, data?: DescribeAlgorithmCommandOutput) => void - ): Promise | void { - const command = new DescribeAlgorithmCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), - * status, input and output configurations, and the ARN of the solution version used to generate - * the recommendations.

- */ - public describeBatchInferenceJob( + + /** + * @see {@link DescribeBatchInferenceJobCommand} + */ + describeBatchInferenceJob( args: DescribeBatchInferenceJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBatchInferenceJob( + describeBatchInferenceJob( args: DescribeBatchInferenceJobCommandInput, cb: (err: any, data?: DescribeBatchInferenceJobCommandOutput) => void ): void; - public describeBatchInferenceJob( + describeBatchInferenceJob( args: DescribeBatchInferenceJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBatchInferenceJobCommandOutput) => void ): void; - public describeBatchInferenceJob( - args: DescribeBatchInferenceJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBatchInferenceJobCommandOutput) => void), - cb?: (err: any, data?: DescribeBatchInferenceJobCommandOutput) => void - ): Promise | void { - const command = new DescribeBatchInferenceJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), - * status, input and output configurations, and the ARN of the solution version used to generate - * segments.

- */ - public describeBatchSegmentJob( + + /** + * @see {@link DescribeBatchSegmentJobCommand} + */ + describeBatchSegmentJob( args: DescribeBatchSegmentJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBatchSegmentJob( + describeBatchSegmentJob( args: DescribeBatchSegmentJobCommandInput, cb: (err: any, data?: DescribeBatchSegmentJobCommandOutput) => void ): void; - public describeBatchSegmentJob( + describeBatchSegmentJob( args: DescribeBatchSegmentJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBatchSegmentJobCommandOutput) => void ): void; - public describeBatchSegmentJob( - args: DescribeBatchSegmentJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBatchSegmentJobCommandOutput) => void), - cb?: (err: any, data?: DescribeBatchSegmentJobCommandOutput) => void - ): Promise | void { - const command = new DescribeBatchSegmentJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the given campaign, including its status.

- *

A campaign can be in one of the following states:

- *
    - *
  • - *

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    - *
  • - *
  • - *

    DELETE PENDING > DELETE IN_PROGRESS

    - *
  • - *
- *

When the status is CREATE FAILED, the response includes the - * failureReason key, which describes why.

- *

For more information on campaigns, see CreateCampaign.

- */ - public describeCampaign( + + /** + * @see {@link DescribeCampaignCommand} + */ + describeCampaign( args: DescribeCampaignCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCampaign( + describeCampaign( args: DescribeCampaignCommandInput, cb: (err: any, data?: DescribeCampaignCommandOutput) => void ): void; - public describeCampaign( + describeCampaign( args: DescribeCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCampaignCommandOutput) => void ): void; - public describeCampaign( - args: DescribeCampaignCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCampaignCommandOutput) => void), - cb?: (err: any, data?: DescribeCampaignCommandOutput) => void - ): Promise | void { - const command = new DescribeCampaignCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the given dataset. For more information on datasets, see - * CreateDataset.

- */ - public describeDataset( + + /** + * @see {@link DescribeDatasetCommand} + */ + describeDataset( args: DescribeDatasetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDataset( - args: DescribeDatasetCommandInput, - cb: (err: any, data?: DescribeDatasetCommandOutput) => void - ): void; - public describeDataset( + describeDataset(args: DescribeDatasetCommandInput, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void; + describeDataset( args: DescribeDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetCommandOutput) => void ): void; - public describeDataset( - args: DescribeDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDatasetCommandOutput) => void), - cb?: (err: any, data?: DescribeDatasetCommandOutput) => void - ): Promise | void { - const command = new DescribeDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the dataset export job created by CreateDatasetExportJob, including the export job status.

- */ - public describeDatasetExportJob( + + /** + * @see {@link DescribeDatasetExportJobCommand} + */ + describeDatasetExportJob( args: DescribeDatasetExportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDatasetExportJob( + describeDatasetExportJob( args: DescribeDatasetExportJobCommandInput, cb: (err: any, data?: DescribeDatasetExportJobCommandOutput) => void ): void; - public describeDatasetExportJob( + describeDatasetExportJob( args: DescribeDatasetExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetExportJobCommandOutput) => void ): void; - public describeDatasetExportJob( - args: DescribeDatasetExportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDatasetExportJobCommandOutput) => void), - cb?: (err: any, data?: DescribeDatasetExportJobCommandOutput) => void - ): Promise | void { - const command = new DescribeDatasetExportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the given dataset group. For more information on dataset - * groups, see CreateDatasetGroup.

- */ - public describeDatasetGroup( + + /** + * @see {@link DescribeDatasetGroupCommand} + */ + describeDatasetGroup( args: DescribeDatasetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDatasetGroup( + describeDatasetGroup( args: DescribeDatasetGroupCommandInput, cb: (err: any, data?: DescribeDatasetGroupCommandOutput) => void ): void; - public describeDatasetGroup( + describeDatasetGroup( args: DescribeDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetGroupCommandOutput) => void ): void; - public describeDatasetGroup( - args: DescribeDatasetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDatasetGroupCommandOutput) => void), - cb?: (err: any, data?: DescribeDatasetGroupCommandOutput) => void - ): Promise | void { - const command = new DescribeDatasetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the dataset import job created by CreateDatasetImportJob, including the import job status.

- */ - public describeDatasetImportJob( + + /** + * @see {@link DescribeDatasetImportJobCommand} + */ + describeDatasetImportJob( args: DescribeDatasetImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDatasetImportJob( + describeDatasetImportJob( args: DescribeDatasetImportJobCommandInput, cb: (err: any, data?: DescribeDatasetImportJobCommandOutput) => void ): void; - public describeDatasetImportJob( + describeDatasetImportJob( args: DescribeDatasetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetImportJobCommandOutput) => void ): void; - public describeDatasetImportJob( - args: DescribeDatasetImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDatasetImportJobCommandOutput) => void), - cb?: (err: any, data?: DescribeDatasetImportJobCommandOutput) => void - ): Promise | void { - const command = new DescribeDatasetImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes an event tracker. The response includes the trackingId and - * status of the event tracker. - * For more information on event trackers, see CreateEventTracker.

- */ - public describeEventTracker( + + /** + * @see {@link DescribeEventTrackerCommand} + */ + describeEventTracker( args: DescribeEventTrackerCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventTracker( + describeEventTracker( args: DescribeEventTrackerCommandInput, cb: (err: any, data?: DescribeEventTrackerCommandOutput) => void ): void; - public describeEventTracker( + describeEventTracker( args: DescribeEventTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventTrackerCommandOutput) => void ): void; - public describeEventTracker( - args: DescribeEventTrackerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventTrackerCommandOutput) => void), - cb?: (err: any, data?: DescribeEventTrackerCommandOutput) => void - ): Promise | void { - const command = new DescribeEventTrackerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the given feature transformation.

- */ - public describeFeatureTransformation( + + /** + * @see {@link DescribeFeatureTransformationCommand} + */ + describeFeatureTransformation( args: DescribeFeatureTransformationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFeatureTransformation( + describeFeatureTransformation( args: DescribeFeatureTransformationCommandInput, cb: (err: any, data?: DescribeFeatureTransformationCommandOutput) => void ): void; - public describeFeatureTransformation( + describeFeatureTransformation( args: DescribeFeatureTransformationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFeatureTransformationCommandOutput) => void ): void; - public describeFeatureTransformation( - args: DescribeFeatureTransformationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFeatureTransformationCommandOutput) => void), - cb?: (err: any, data?: DescribeFeatureTransformationCommandOutput) => void - ): Promise | void { - const command = new DescribeFeatureTransformationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a filter's properties.

- */ - public describeFilter( + + /** + * @see {@link DescribeFilterCommand} + */ + describeFilter( args: DescribeFilterCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFilter( - args: DescribeFilterCommandInput, - cb: (err: any, data?: DescribeFilterCommandOutput) => void - ): void; - public describeFilter( + describeFilter(args: DescribeFilterCommandInput, cb: (err: any, data?: DescribeFilterCommandOutput) => void): void; + describeFilter( args: DescribeFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFilterCommandOutput) => void ): void; - public describeFilter( - args: DescribeFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFilterCommandOutput) => void), - cb?: (err: any, data?: DescribeFilterCommandOutput) => void - ): Promise | void { - const command = new DescribeFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a metric attribution.

- */ - public describeMetricAttribution( + + /** + * @see {@link DescribeMetricAttributionCommand} + */ + describeMetricAttribution( args: DescribeMetricAttributionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMetricAttribution( + describeMetricAttribution( args: DescribeMetricAttributionCommandInput, cb: (err: any, data?: DescribeMetricAttributionCommandOutput) => void ): void; - public describeMetricAttribution( + describeMetricAttribution( args: DescribeMetricAttributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMetricAttributionCommandOutput) => void ): void; - public describeMetricAttribution( - args: DescribeMetricAttributionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMetricAttributionCommandOutput) => void), - cb?: (err: any, data?: DescribeMetricAttributionCommandOutput) => void - ): Promise | void { - const command = new DescribeMetricAttributionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a recipe.

- *

A recipe contains three items:

- *
    - *
  • - *

    An algorithm that trains a model.

    - *
  • - *
  • - *

    Hyperparameters that govern the training.

    - *
  • - *
  • - *

    Feature transformation information for modifying the input data before training.

    - *
  • - *
- *

Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a - * solution with the CreateSolution API. - * CreateSolution trains a model by using the algorithm - * in the specified recipe and a training dataset. The solution, when deployed as a campaign, - * can provide recommendations using the - * GetRecommendations API.

- */ - public describeRecipe( + + /** + * @see {@link DescribeRecipeCommand} + */ + describeRecipe( args: DescribeRecipeCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRecipe( - args: DescribeRecipeCommandInput, - cb: (err: any, data?: DescribeRecipeCommandOutput) => void - ): void; - public describeRecipe( + describeRecipe(args: DescribeRecipeCommandInput, cb: (err: any, data?: DescribeRecipeCommandOutput) => void): void; + describeRecipe( args: DescribeRecipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRecipeCommandOutput) => void ): void; - public describeRecipe( - args: DescribeRecipeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRecipeCommandOutput) => void), - cb?: (err: any, data?: DescribeRecipeCommandOutput) => void - ): Promise | void { - const command = new DescribeRecipeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the given recommender, including its status.

- *

A recommender can be in one of the following states:

- *
    - *
  • - *

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    - *
  • - *
  • - *

    STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE

    - *
  • - *
  • - *

    DELETE PENDING > DELETE IN_PROGRESS

    - *
  • - *
- *

When the status is CREATE FAILED, the response includes the - * failureReason key, which describes why.

- *

The modelMetrics key is null when - * the recommender is being created or deleted.

- *

For more information on recommenders, see CreateRecommender.

- */ - public describeRecommender( + + /** + * @see {@link DescribeRecommenderCommand} + */ + describeRecommender( args: DescribeRecommenderCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRecommender( + describeRecommender( args: DescribeRecommenderCommandInput, cb: (err: any, data?: DescribeRecommenderCommandOutput) => void ): void; - public describeRecommender( + describeRecommender( args: DescribeRecommenderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRecommenderCommandOutput) => void ): void; - public describeRecommender( - args: DescribeRecommenderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRecommenderCommandOutput) => void), - cb?: (err: any, data?: DescribeRecommenderCommandOutput) => void - ): Promise | void { - const command = new DescribeRecommenderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a schema. For more information on schemas, see - * CreateSchema.

- */ - public describeSchema( + + /** + * @see {@link DescribeSchemaCommand} + */ + describeSchema( args: DescribeSchemaCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSchema( - args: DescribeSchemaCommandInput, - cb: (err: any, data?: DescribeSchemaCommandOutput) => void - ): void; - public describeSchema( + describeSchema(args: DescribeSchemaCommandInput, cb: (err: any, data?: DescribeSchemaCommandOutput) => void): void; + describeSchema( args: DescribeSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSchemaCommandOutput) => void ): void; - public describeSchema( - args: DescribeSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSchemaCommandOutput) => void), - cb?: (err: any, data?: DescribeSchemaCommandOutput) => void - ): Promise | void { - const command = new DescribeSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a solution. - * For more information on solutions, see CreateSolution.

- */ - public describeSolution( + + /** + * @see {@link DescribeSolutionCommand} + */ + describeSolution( args: DescribeSolutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSolution( + describeSolution( args: DescribeSolutionCommandInput, cb: (err: any, data?: DescribeSolutionCommandOutput) => void ): void; - public describeSolution( + describeSolution( args: DescribeSolutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSolutionCommandOutput) => void ): void; - public describeSolution( - args: DescribeSolutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSolutionCommandOutput) => void), - cb?: (err: any, data?: DescribeSolutionCommandOutput) => void - ): Promise | void { - const command = new DescribeSolutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a specific version of a solution. For more information on solutions, see CreateSolution - *

- */ - public describeSolutionVersion( + + /** + * @see {@link DescribeSolutionVersionCommand} + */ + describeSolutionVersion( args: DescribeSolutionVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSolutionVersion( + describeSolutionVersion( args: DescribeSolutionVersionCommandInput, cb: (err: any, data?: DescribeSolutionVersionCommandOutput) => void ): void; - public describeSolutionVersion( + describeSolutionVersion( args: DescribeSolutionVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSolutionVersionCommandOutput) => void ): void; - public describeSolutionVersion( - args: DescribeSolutionVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSolutionVersionCommandOutput) => void), - cb?: (err: any, data?: DescribeSolutionVersionCommandOutput) => void - ): Promise | void { - const command = new DescribeSolutionVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the metrics for the specified solution version.

- */ - public getSolutionMetrics( + + /** + * @see {@link GetSolutionMetricsCommand} + */ + getSolutionMetrics( args: GetSolutionMetricsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSolutionMetrics( + getSolutionMetrics( args: GetSolutionMetricsCommandInput, cb: (err: any, data?: GetSolutionMetricsCommandOutput) => void ): void; - public getSolutionMetrics( + getSolutionMetrics( args: GetSolutionMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSolutionMetricsCommandOutput) => void ): void; - public getSolutionMetrics( - args: GetSolutionMetricsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSolutionMetricsCommandOutput) => void), - cb?: (err: any, data?: GetSolutionMetricsCommandOutput) => void - ): Promise | void { - const command = new GetSolutionMetricsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of the batch inference jobs that have been performed off of a solution - * version.

- */ - public listBatchInferenceJobs( + + /** + * @see {@link ListBatchInferenceJobsCommand} + */ + listBatchInferenceJobs( args: ListBatchInferenceJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBatchInferenceJobs( + listBatchInferenceJobs( args: ListBatchInferenceJobsCommandInput, cb: (err: any, data?: ListBatchInferenceJobsCommandOutput) => void ): void; - public listBatchInferenceJobs( + listBatchInferenceJobs( args: ListBatchInferenceJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBatchInferenceJobsCommandOutput) => void ): void; - public listBatchInferenceJobs( - args: ListBatchInferenceJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBatchInferenceJobsCommandOutput) => void), - cb?: (err: any, data?: ListBatchInferenceJobsCommandOutput) => void - ): Promise | void { - const command = new ListBatchInferenceJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of the batch segment jobs that have been performed off of a solution - * version that you specify.

- */ - public listBatchSegmentJobs( + + /** + * @see {@link ListBatchSegmentJobsCommand} + */ + listBatchSegmentJobs( args: ListBatchSegmentJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBatchSegmentJobs( + listBatchSegmentJobs( args: ListBatchSegmentJobsCommandInput, cb: (err: any, data?: ListBatchSegmentJobsCommandOutput) => void ): void; - public listBatchSegmentJobs( + listBatchSegmentJobs( args: ListBatchSegmentJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBatchSegmentJobsCommandOutput) => void ): void; - public listBatchSegmentJobs( - args: ListBatchSegmentJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBatchSegmentJobsCommandOutput) => void), - cb?: (err: any, data?: ListBatchSegmentJobsCommandOutput) => void - ): Promise | void { - const command = new ListBatchSegmentJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of campaigns that use the given solution. - * When a solution is not specified, all the campaigns associated with the account are listed. - * The response provides the properties for each campaign, including the Amazon Resource Name (ARN). - * For more information on campaigns, see CreateCampaign.

- */ - public listCampaigns( - args: ListCampaignsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listCampaigns( - args: ListCampaignsCommandInput, - cb: (err: any, data?: ListCampaignsCommandOutput) => void - ): void; - public listCampaigns( + + /** + * @see {@link ListCampaignsCommand} + */ + listCampaigns(args: ListCampaignsCommandInput, options?: __HttpHandlerOptions): Promise; + listCampaigns(args: ListCampaignsCommandInput, cb: (err: any, data?: ListCampaignsCommandOutput) => void): void; + listCampaigns( args: ListCampaignsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCampaignsCommandOutput) => void ): void; - public listCampaigns( - args: ListCampaignsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCampaignsCommandOutput) => void), - cb?: (err: any, data?: ListCampaignsCommandOutput) => void - ): Promise | void { - const command = new ListCampaignsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of dataset export jobs that use the given dataset. When - * a dataset is not specified, all the dataset export jobs associated with - * the account are listed. The response provides the properties for each - * dataset export job, including the Amazon Resource Name (ARN). For more - * information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see - * CreateDataset.

- */ - public listDatasetExportJobs( + + /** + * @see {@link ListDatasetExportJobsCommand} + */ + listDatasetExportJobs( args: ListDatasetExportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDatasetExportJobs( + listDatasetExportJobs( args: ListDatasetExportJobsCommandInput, cb: (err: any, data?: ListDatasetExportJobsCommandOutput) => void ): void; - public listDatasetExportJobs( + listDatasetExportJobs( args: ListDatasetExportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetExportJobsCommandOutput) => void ): void; - public listDatasetExportJobs( - args: ListDatasetExportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatasetExportJobsCommandOutput) => void), - cb?: (err: any, data?: ListDatasetExportJobsCommandOutput) => void - ): Promise | void { - const command = new ListDatasetExportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of dataset groups. The response provides the properties - * for each dataset group, including the Amazon Resource Name (ARN). For more - * information on dataset groups, see CreateDatasetGroup.

- */ - public listDatasetGroups( + + /** + * @see {@link ListDatasetGroupsCommand} + */ + listDatasetGroups( args: ListDatasetGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDatasetGroups( + listDatasetGroups( args: ListDatasetGroupsCommandInput, cb: (err: any, data?: ListDatasetGroupsCommandOutput) => void ): void; - public listDatasetGroups( + listDatasetGroups( args: ListDatasetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetGroupsCommandOutput) => void ): void; - public listDatasetGroups( - args: ListDatasetGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatasetGroupsCommandOutput) => void), - cb?: (err: any, data?: ListDatasetGroupsCommandOutput) => void - ): Promise | void { - const command = new ListDatasetGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of dataset import jobs that use the given dataset. When - * a dataset is not specified, all the dataset import jobs associated with - * the account are listed. The response provides the properties for each - * dataset import job, including the Amazon Resource Name (ARN). For more - * information on dataset import jobs, see CreateDatasetImportJob. For more information on datasets, see - * CreateDataset.

- */ - public listDatasetImportJobs( + + /** + * @see {@link ListDatasetImportJobsCommand} + */ + listDatasetImportJobs( args: ListDatasetImportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDatasetImportJobs( + listDatasetImportJobs( args: ListDatasetImportJobsCommandInput, cb: (err: any, data?: ListDatasetImportJobsCommandOutput) => void ): void; - public listDatasetImportJobs( + listDatasetImportJobs( args: ListDatasetImportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetImportJobsCommandOutput) => void ): void; - public listDatasetImportJobs( - args: ListDatasetImportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatasetImportJobsCommandOutput) => void), - cb?: (err: any, data?: ListDatasetImportJobsCommandOutput) => void - ): Promise | void { - const command = new ListDatasetImportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the list of datasets contained in the given dataset group. The - * response provides the properties for each dataset, including the Amazon - * Resource Name (ARN). For more information on datasets, see CreateDataset.

- */ - public listDatasets( - args: ListDatasetsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void; - public listDatasets( + + /** + * @see {@link ListDatasetsCommand} + */ + listDatasets(args: ListDatasetsCommandInput, options?: __HttpHandlerOptions): Promise; + listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void; + listDatasets( args: ListDatasetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetsCommandOutput) => void ): void; - public listDatasets( - args: ListDatasetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatasetsCommandOutput) => void), - cb?: (err: any, data?: ListDatasetsCommandOutput) => void - ): Promise | void { - const command = new ListDatasetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the list of event trackers associated with the account. - * The response provides the properties for each event tracker, including the Amazon Resource - * Name (ARN) and tracking ID. For more - * information on event trackers, see CreateEventTracker.

- */ - public listEventTrackers( + + /** + * @see {@link ListEventTrackersCommand} + */ + listEventTrackers( args: ListEventTrackersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEventTrackers( + listEventTrackers( args: ListEventTrackersCommandInput, cb: (err: any, data?: ListEventTrackersCommandOutput) => void ): void; - public listEventTrackers( + listEventTrackers( args: ListEventTrackersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventTrackersCommandOutput) => void ): void; - public listEventTrackers( - args: ListEventTrackersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEventTrackersCommandOutput) => void), - cb?: (err: any, data?: ListEventTrackersCommandOutput) => void - ): Promise | void { - const command = new ListEventTrackersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all filters that belong to a given dataset group.

- */ - public listFilters(args: ListFiltersCommandInput, options?: __HttpHandlerOptions): Promise; - public listFilters(args: ListFiltersCommandInput, cb: (err: any, data?: ListFiltersCommandOutput) => void): void; - public listFilters( + + /** + * @see {@link ListFiltersCommand} + */ + listFilters(args: ListFiltersCommandInput, options?: __HttpHandlerOptions): Promise; + listFilters(args: ListFiltersCommandInput, cb: (err: any, data?: ListFiltersCommandOutput) => void): void; + listFilters( args: ListFiltersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFiltersCommandOutput) => void ): void; - public listFilters( - args: ListFiltersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFiltersCommandOutput) => void), - cb?: (err: any, data?: ListFiltersCommandOutput) => void - ): Promise | void { - const command = new ListFiltersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the metrics for the metric attribution.

- */ - public listMetricAttributionMetrics( + + /** + * @see {@link ListMetricAttributionMetricsCommand} + */ + listMetricAttributionMetrics( args: ListMetricAttributionMetricsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMetricAttributionMetrics( + listMetricAttributionMetrics( args: ListMetricAttributionMetricsCommandInput, cb: (err: any, data?: ListMetricAttributionMetricsCommandOutput) => void ): void; - public listMetricAttributionMetrics( + listMetricAttributionMetrics( args: ListMetricAttributionMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMetricAttributionMetricsCommandOutput) => void ): void; - public listMetricAttributionMetrics( - args: ListMetricAttributionMetricsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMetricAttributionMetricsCommandOutput) => void), - cb?: (err: any, data?: ListMetricAttributionMetricsCommandOutput) => void - ): Promise | void { - const command = new ListMetricAttributionMetricsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists metric attributions.

- */ - public listMetricAttributions( + + /** + * @see {@link ListMetricAttributionsCommand} + */ + listMetricAttributions( args: ListMetricAttributionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMetricAttributions( + listMetricAttributions( args: ListMetricAttributionsCommandInput, cb: (err: any, data?: ListMetricAttributionsCommandOutput) => void ): void; - public listMetricAttributions( + listMetricAttributions( args: ListMetricAttributionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMetricAttributionsCommandOutput) => void ): void; - public listMetricAttributions( - args: ListMetricAttributionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMetricAttributionsCommandOutput) => void), - cb?: (err: any, data?: ListMetricAttributionsCommandOutput) => void - ): Promise | void { - const command = new ListMetricAttributionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of available recipes. The response provides the properties - * for each recipe, including the recipe's Amazon Resource Name (ARN).

- */ - public listRecipes(args: ListRecipesCommandInput, options?: __HttpHandlerOptions): Promise; - public listRecipes(args: ListRecipesCommandInput, cb: (err: any, data?: ListRecipesCommandOutput) => void): void; - public listRecipes( + + /** + * @see {@link ListRecipesCommand} + */ + listRecipes(args: ListRecipesCommandInput, options?: __HttpHandlerOptions): Promise; + listRecipes(args: ListRecipesCommandInput, cb: (err: any, data?: ListRecipesCommandOutput) => void): void; + listRecipes( args: ListRecipesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecipesCommandOutput) => void ): void; - public listRecipes( - args: ListRecipesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRecipesCommandOutput) => void), - cb?: (err: any, data?: ListRecipesCommandOutput) => void - ): Promise | void { - const command = new ListRecipesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of recommenders in a given Domain dataset group. - * When a Domain dataset group is not specified, all the recommenders associated with the account are listed. - * The response provides the properties for each recommender, including the Amazon Resource Name (ARN). - * For more information on recommenders, see CreateRecommender.

- */ - public listRecommenders( + + /** + * @see {@link ListRecommendersCommand} + */ + listRecommenders( args: ListRecommendersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRecommenders( + listRecommenders( args: ListRecommendersCommandInput, cb: (err: any, data?: ListRecommendersCommandOutput) => void ): void; - public listRecommenders( + listRecommenders( args: ListRecommendersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecommendersCommandOutput) => void ): void; - public listRecommenders( - args: ListRecommendersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRecommendersCommandOutput) => void), - cb?: (err: any, data?: ListRecommendersCommandOutput) => void - ): Promise | void { - const command = new ListRecommendersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the list of schemas associated with the account. The response provides the - * properties for each schema, including the Amazon Resource Name (ARN). - * For more information on schemas, see CreateSchema.

- */ - public listSchemas(args: ListSchemasCommandInput, options?: __HttpHandlerOptions): Promise; - public listSchemas(args: ListSchemasCommandInput, cb: (err: any, data?: ListSchemasCommandOutput) => void): void; - public listSchemas( + + /** + * @see {@link ListSchemasCommand} + */ + listSchemas(args: ListSchemasCommandInput, options?: __HttpHandlerOptions): Promise; + listSchemas(args: ListSchemasCommandInput, cb: (err: any, data?: ListSchemasCommandOutput) => void): void; + listSchemas( args: ListSchemasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSchemasCommandOutput) => void ): void; - public listSchemas( - args: ListSchemasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSchemasCommandOutput) => void), - cb?: (err: any, data?: ListSchemasCommandOutput) => void - ): Promise | void { - const command = new ListSchemasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of solutions that use the given dataset group. - * When a dataset group is not specified, all the solutions associated with the account are listed. - * The response provides the properties for each solution, including the Amazon Resource Name (ARN). - * For more information on solutions, see CreateSolution.

- */ - public listSolutions( - args: ListSolutionsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listSolutions( - args: ListSolutionsCommandInput, - cb: (err: any, data?: ListSolutionsCommandOutput) => void - ): void; - public listSolutions( + + /** + * @see {@link ListSolutionsCommand} + */ + listSolutions(args: ListSolutionsCommandInput, options?: __HttpHandlerOptions): Promise; + listSolutions(args: ListSolutionsCommandInput, cb: (err: any, data?: ListSolutionsCommandOutput) => void): void; + listSolutions( args: ListSolutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSolutionsCommandOutput) => void ): void; - public listSolutions( - args: ListSolutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSolutionsCommandOutput) => void), - cb?: (err: any, data?: ListSolutionsCommandOutput) => void - ): Promise | void { - const command = new ListSolutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of solution versions for the given solution. When a solution is not - * specified, all the solution versions associated with the account are listed. The response - * provides the properties for each solution version, including the Amazon Resource Name (ARN).

- */ - public listSolutionVersions( + + /** + * @see {@link ListSolutionVersionsCommand} + */ + listSolutionVersions( args: ListSolutionVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSolutionVersions( + listSolutionVersions( args: ListSolutionVersionsCommandInput, cb: (err: any, data?: ListSolutionVersionsCommandOutput) => void ): void; - public listSolutionVersions( + listSolutionVersions( args: ListSolutionVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSolutionVersionsCommandOutput) => void ): void; - public listSolutionVersions( - args: ListSolutionVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSolutionVersionsCommandOutput) => void), - cb?: (err: any, data?: ListSolutionVersionsCommandOutput) => void - ): Promise | void { - const command = new ListSolutionVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get a list of tags attached to a resource.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a recommender that is INACTIVE. Starting a recommender does not - * create any new models, but resumes billing and automatic retraining for the recommender.

- */ - public startRecommender( + + /** + * @see {@link StartRecommenderCommand} + */ + startRecommender( args: StartRecommenderCommandInput, options?: __HttpHandlerOptions ): Promise; - public startRecommender( + startRecommender( args: StartRecommenderCommandInput, cb: (err: any, data?: StartRecommenderCommandOutput) => void ): void; - public startRecommender( + startRecommender( args: StartRecommenderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartRecommenderCommandOutput) => void ): void; - public startRecommender( - args: StartRecommenderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartRecommenderCommandOutput) => void), - cb?: (err: any, data?: StartRecommenderCommandOutput) => void - ): Promise | void { - const command = new StartRecommenderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.

- */ - public stopRecommender( + + /** + * @see {@link StopRecommenderCommand} + */ + stopRecommender( args: StopRecommenderCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopRecommender( - args: StopRecommenderCommandInput, - cb: (err: any, data?: StopRecommenderCommandOutput) => void - ): void; - public stopRecommender( + stopRecommender(args: StopRecommenderCommandInput, cb: (err: any, data?: StopRecommenderCommandOutput) => void): void; + stopRecommender( args: StopRecommenderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopRecommenderCommandOutput) => void ): void; - public stopRecommender( - args: StopRecommenderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopRecommenderCommandOutput) => void), - cb?: (err: any, data?: StopRecommenderCommandOutput) => void - ): Promise | void { - const command = new StopRecommenderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS. - *

- *

Depending on the current state of the solution version, the solution version state changes as follows:

- *
    - *
  • - *

    CREATE_PENDING > CREATE_STOPPED

    - *

    or

    - *
  • - *
  • - *

    CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED

    - *
  • - *
- *

You are billed for all of the training completed up - * until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.

- */ - public stopSolutionVersionCreation( + + /** + * @see {@link StopSolutionVersionCreationCommand} + */ + stopSolutionVersionCreation( args: StopSolutionVersionCreationCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopSolutionVersionCreation( + stopSolutionVersionCreation( args: StopSolutionVersionCreationCommandInput, cb: (err: any, data?: StopSolutionVersionCreationCommandOutput) => void ): void; - public stopSolutionVersionCreation( + stopSolutionVersionCreation( args: StopSolutionVersionCreationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopSolutionVersionCreationCommandOutput) => void ): void; - public stopSolutionVersionCreation( - args: StopSolutionVersionCreationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopSolutionVersionCreationCommandOutput) => void), - cb?: (err: any, data?: StopSolutionVersionCreationCommandOutput) => void - ): Promise | void { - const command = new StopSolutionVersionCreationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Add a list of tags to a resource.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Remove tags that are attached to a resource.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a campaign by either deploying a new solution or changing the value of the - * campaign's minProvisionedTPS parameter.

- *

To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. - * Check the campaign status using the DescribeCampaign operation.

- * - * - *

You can still get recommendations from a campaign while an update is in progress. - * The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is Active. - *

- *
- * - *

For more information on campaigns, see CreateCampaign.

- */ - public updateCampaign( + + /** + * @see {@link UpdateCampaignCommand} + */ + updateCampaign( args: UpdateCampaignCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCampaign( - args: UpdateCampaignCommandInput, - cb: (err: any, data?: UpdateCampaignCommandOutput) => void - ): void; - public updateCampaign( + updateCampaign(args: UpdateCampaignCommandInput, cb: (err: any, data?: UpdateCampaignCommandOutput) => void): void; + updateCampaign( args: UpdateCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCampaignCommandOutput) => void ): void; - public updateCampaign( - args: UpdateCampaignCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCampaignCommandOutput) => void), - cb?: (err: any, data?: UpdateCampaignCommandOutput) => void - ): Promise | void { - const command = new UpdateCampaignCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a metric attribution.

- */ - public updateMetricAttribution( + + /** + * @see {@link UpdateMetricAttributionCommand} + */ + updateMetricAttribution( args: UpdateMetricAttributionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMetricAttribution( + updateMetricAttribution( args: UpdateMetricAttributionCommandInput, cb: (err: any, data?: UpdateMetricAttributionCommandOutput) => void ): void; - public updateMetricAttribution( + updateMetricAttribution( args: UpdateMetricAttributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMetricAttributionCommandOutput) => void ): void; - public updateMetricAttribution( - args: UpdateMetricAttributionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMetricAttributionCommandOutput) => void), - cb?: (err: any, data?: UpdateMetricAttributionCommandOutput) => void - ): Promise | void { - const command = new UpdateMetricAttributionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the recommender to modify the recommender configuration.

- */ - public updateRecommender( + + /** + * @see {@link UpdateRecommenderCommand} + */ + updateRecommender( args: UpdateRecommenderCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRecommender( + updateRecommender( args: UpdateRecommenderCommandInput, cb: (err: any, data?: UpdateRecommenderCommandOutput) => void ): void; - public updateRecommender( + updateRecommender( args: UpdateRecommenderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRecommenderCommandOutput) => void ): void; - public updateRecommender( - args: UpdateRecommenderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRecommenderCommandOutput) => void), - cb?: (err: any, data?: UpdateRecommenderCommandOutput) => void - ): Promise | void { - const command = new UpdateRecommenderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Personalize is a machine learning service that makes it easy to add individualized + * recommendations to customers.

+ */ +export class Personalize extends PersonalizeClient implements Personalize {} +createAggregatedClient(commands, Personalize); diff --git a/clients/client-pi/src/PI.ts b/clients/client-pi/src/PI.ts index 5746c0d1bbc3..1e1e7be585b8 100644 --- a/clients/client-pi/src/PI.ts +++ b/clients/client-pi/src/PI.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -31,249 +32,148 @@ import { ListAvailableResourceMetricsCommandInput, ListAvailableResourceMetricsCommandOutput, } from "./commands/ListAvailableResourceMetricsCommand"; -import { PIClient } from "./PIClient"; +import { PIClient, PIClientConfig } from "./PIClient"; -/** - * @public - * Amazon RDS Performance Insights - *

Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. The guide - * provides detailed information about Performance Insights data types, parameters and errors.

- *

When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the - * authoritative source for Amazon Web Services service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.

- *

DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension - * provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested - * dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.

- * - */ -export class PI extends PIClient { +const commands = { + DescribeDimensionKeysCommand, + GetDimensionKeyDetailsCommand, + GetResourceMetadataCommand, + GetResourceMetricsCommand, + ListAvailableResourceDimensionsCommand, + ListAvailableResourceMetricsCommand, +}; + +export interface PI { /** - * @public - *

For a specific time period, retrieve the top N dimension keys for a metric. - *

- * - *

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, - * only the first 500 bytes are returned.

- *
+ * @see {@link DescribeDimensionKeysCommand} */ - public describeDimensionKeys( + describeDimensionKeys( args: DescribeDimensionKeysCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDimensionKeys( + describeDimensionKeys( args: DescribeDimensionKeysCommandInput, cb: (err: any, data?: DescribeDimensionKeysCommandOutput) => void ): void; - public describeDimensionKeys( + describeDimensionKeys( args: DescribeDimensionKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDimensionKeysCommandOutput) => void ): void; - public describeDimensionKeys( - args: DescribeDimensionKeysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDimensionKeysCommandOutput) => void), - cb?: (err: any, data?: DescribeDimensionKeysCommandOutput) => void - ): Promise | void { - const command = new DescribeDimensionKeysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, - * GetDimensionKeyDetails retrieves the full text of the dimension db.sql.statement associated with this ID. - * This operation is useful because GetResourceMetrics and DescribeDimensionKeys don't support retrieval of large - * SQL statement text.

+ * @see {@link GetDimensionKeyDetailsCommand} */ - public getDimensionKeyDetails( + getDimensionKeyDetails( args: GetDimensionKeyDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDimensionKeyDetails( + getDimensionKeyDetails( args: GetDimensionKeyDetailsCommandInput, cb: (err: any, data?: GetDimensionKeyDetailsCommandOutput) => void ): void; - public getDimensionKeyDetails( + getDimensionKeyDetails( args: GetDimensionKeyDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDimensionKeyDetailsCommandOutput) => void ): void; - public getDimensionKeyDetails( - args: GetDimensionKeyDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDimensionKeyDetailsCommandOutput) => void), - cb?: (err: any, data?: GetDimensionKeyDetailsCommandOutput) => void - ): Promise | void { - const command = new GetDimensionKeyDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieve the metadata for different features. For example, the metadata might indicate - * that a feature is turned on or off on a specific DB instance. - *

+ * @see {@link GetResourceMetadataCommand} */ - public getResourceMetadata( + getResourceMetadata( args: GetResourceMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourceMetadata( + getResourceMetadata( args: GetResourceMetadataCommandInput, cb: (err: any, data?: GetResourceMetadataCommandOutput) => void ): void; - public getResourceMetadata( + getResourceMetadata( args: GetResourceMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceMetadataCommandOutput) => void ): void; - public getResourceMetadata( - args: GetResourceMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourceMetadataCommandOutput) => void), - cb?: (err: any, data?: GetResourceMetadataCommandOutput) => void - ): Promise | void { - const command = new GetResourceMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide - * specific dimension groups and dimensions, and provide aggregation and filtering criteria for - * each group.

- * - *

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, - * only the first 500 bytes are returned.

- *
+ * @see {@link GetResourceMetricsCommand} */ - public getResourceMetrics( + getResourceMetrics( args: GetResourceMetricsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourceMetrics( + getResourceMetrics( args: GetResourceMetricsCommandInput, cb: (err: any, data?: GetResourceMetricsCommandOutput) => void ): void; - public getResourceMetrics( + getResourceMetrics( args: GetResourceMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceMetricsCommandOutput) => void ): void; - public getResourceMetrics( - args: GetResourceMetricsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourceMetricsCommandOutput) => void), - cb?: (err: any, data?: GetResourceMetricsCommandOutput) => void - ): Promise | void { - const command = new GetResourceMetricsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.

+ * @see {@link ListAvailableResourceDimensionsCommand} */ - public listAvailableResourceDimensions( + listAvailableResourceDimensions( args: ListAvailableResourceDimensionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAvailableResourceDimensions( + listAvailableResourceDimensions( args: ListAvailableResourceDimensionsCommandInput, cb: (err: any, data?: ListAvailableResourceDimensionsCommandOutput) => void ): void; - public listAvailableResourceDimensions( + listAvailableResourceDimensions( args: ListAvailableResourceDimensionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAvailableResourceDimensionsCommandOutput) => void ): void; - public listAvailableResourceDimensions( - args: ListAvailableResourceDimensionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAvailableResourceDimensionsCommandOutput) => void), - cb?: (err: any, data?: ListAvailableResourceDimensionsCommandOutput) => void - ): Promise | void { - const command = new ListAvailableResourceDimensionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieve metrics of the specified types that can be queried for a specified DB instance. - *

+ * @see {@link ListAvailableResourceMetricsCommand} */ - public listAvailableResourceMetrics( + listAvailableResourceMetrics( args: ListAvailableResourceMetricsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAvailableResourceMetrics( + listAvailableResourceMetrics( args: ListAvailableResourceMetricsCommandInput, cb: (err: any, data?: ListAvailableResourceMetricsCommandOutput) => void ): void; - public listAvailableResourceMetrics( + listAvailableResourceMetrics( args: ListAvailableResourceMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAvailableResourceMetricsCommandOutput) => void ): void; - public listAvailableResourceMetrics( - args: ListAvailableResourceMetricsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAvailableResourceMetricsCommandOutput) => void), - cb?: (err: any, data?: ListAvailableResourceMetricsCommandOutput) => void - ): Promise | void { - const command = new ListAvailableResourceMetricsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon RDS Performance Insights + *

Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. The guide + * provides detailed information about Performance Insights data types, parameters and errors.

+ *

When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the + * authoritative source for Amazon Web Services service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.

+ *

DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension + * provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested + * dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.

+ * + */ +export class PI extends PIClient implements PI {} +createAggregatedClient(commands, PI); diff --git a/clients/client-pinpoint-email/src/PinpointEmail.ts b/clients/client-pinpoint-email/src/PinpointEmail.ts index bc3d66c19bc8..be654bc44b01 100644 --- a/clients/client-pinpoint-email/src/PinpointEmail.ts +++ b/clients/client-pinpoint-email/src/PinpointEmail.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -199,1565 +200,770 @@ import { UpdateConfigurationSetEventDestinationCommandInput, UpdateConfigurationSetEventDestinationCommandOutput, } from "./commands/UpdateConfigurationSetEventDestinationCommand"; -import { PinpointEmailClient } from "./PinpointEmailClient"; +import { PinpointEmailClient, PinpointEmailClientConfig } from "./PinpointEmailClient"; -/** - * @public - * Amazon Pinpoint Email Service - *

Welcome to the Amazon Pinpoint Email API Reference. This guide provides - * information about the Amazon Pinpoint Email API (version 1.0), including supported - * operations, data types, parameters, and schemas.

- *

- * Amazon Pinpoint is an AWS service that you - * can use to engage with your customers across multiple messaging channels. You can use - * Amazon Pinpoint to send email, SMS text messages, voice messages, and push notifications. The - * Amazon Pinpoint Email API provides programmatic access to options that are unique to the - * email channel and supplement the options provided by the Amazon Pinpoint API.

- *

If you're new to Amazon Pinpoint, you might find it helpful to also review the Amazon - * Pinpoint Developer Guide. The Amazon Pinpoint Developer - * Guide provides tutorials, code samples, and procedures that demonstrate - * how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into - * mobile apps and other types of applications. The guide also provides information about - * key topics such as Amazon Pinpoint integration with other AWS services and the limits that apply - * to using the service.

- *

The Amazon Pinpoint Email API is available in several AWS Regions and it provides an endpoint - * for each of these Regions. For a list of all the Regions and endpoints where the API is - * currently available, see AWS Service Endpoints in - * the Amazon Web Services General Reference. To learn more about AWS Regions, see - * Managing AWS - * Regions in the Amazon Web Services General Reference.

- *

In each Region, AWS maintains multiple Availability Zones. These Availability Zones - * are physically isolated from each other, but are united by private, low-latency, - * high-throughput, and highly redundant network connections. These Availability Zones - * enable us to provide very high levels of availability and redundancy, while also - * minimizing latency. To learn more about the number of Availability Zones that are - * available in each Region, see AWS Global Infrastructure.

- */ -export class PinpointEmail extends PinpointEmailClient { +const commands = { + CreateConfigurationSetCommand, + CreateConfigurationSetEventDestinationCommand, + CreateDedicatedIpPoolCommand, + CreateDeliverabilityTestReportCommand, + CreateEmailIdentityCommand, + DeleteConfigurationSetCommand, + DeleteConfigurationSetEventDestinationCommand, + DeleteDedicatedIpPoolCommand, + DeleteEmailIdentityCommand, + GetAccountCommand, + GetBlacklistReportsCommand, + GetConfigurationSetCommand, + GetConfigurationSetEventDestinationsCommand, + GetDedicatedIpCommand, + GetDedicatedIpsCommand, + GetDeliverabilityDashboardOptionsCommand, + GetDeliverabilityTestReportCommand, + GetDomainDeliverabilityCampaignCommand, + GetDomainStatisticsReportCommand, + GetEmailIdentityCommand, + ListConfigurationSetsCommand, + ListDedicatedIpPoolsCommand, + ListDeliverabilityTestReportsCommand, + ListDomainDeliverabilityCampaignsCommand, + ListEmailIdentitiesCommand, + ListTagsForResourceCommand, + PutAccountDedicatedIpWarmupAttributesCommand, + PutAccountSendingAttributesCommand, + PutConfigurationSetDeliveryOptionsCommand, + PutConfigurationSetReputationOptionsCommand, + PutConfigurationSetSendingOptionsCommand, + PutConfigurationSetTrackingOptionsCommand, + PutDedicatedIpInPoolCommand, + PutDedicatedIpWarmupAttributesCommand, + PutDeliverabilityDashboardOptionCommand, + PutEmailIdentityDkimAttributesCommand, + PutEmailIdentityFeedbackAttributesCommand, + PutEmailIdentityMailFromAttributesCommand, + SendEmailCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateConfigurationSetEventDestinationCommand, +}; + +export interface PinpointEmail { /** - * @public - *

Create a configuration set. Configuration sets are groups of - * rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration - * set to an email by including a reference to the configuration set in the headers of the - * email. When you apply a configuration set to an email, all of the rules in that - * configuration set are applied to the email.

+ * @see {@link CreateConfigurationSetCommand} */ - public createConfigurationSet( + createConfigurationSet( args: CreateConfigurationSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConfigurationSet( + createConfigurationSet( args: CreateConfigurationSetCommandInput, cb: (err: any, data?: CreateConfigurationSetCommandOutput) => void ): void; - public createConfigurationSet( + createConfigurationSet( args: CreateConfigurationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfigurationSetCommandOutput) => void ): void; - public createConfigurationSet( - args: CreateConfigurationSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConfigurationSetCommandOutput) => void), - cb?: (err: any, data?: CreateConfigurationSetCommandOutput) => void - ): Promise | void { - const command = new CreateConfigurationSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create an event destination. In Amazon Pinpoint, events include message - * sends, deliveries, opens, clicks, bounces, and complaints. Event - * destinations are places that you can send information about these events - * to. For example, you can send event data to Amazon SNS to receive notifications when you - * receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term - * storage.

- *

A single configuration set can include more than one event destination.

+ * @see {@link CreateConfigurationSetEventDestinationCommand} */ - public createConfigurationSetEventDestination( + createConfigurationSetEventDestination( args: CreateConfigurationSetEventDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConfigurationSetEventDestination( + createConfigurationSetEventDestination( args: CreateConfigurationSetEventDestinationCommandInput, cb: (err: any, data?: CreateConfigurationSetEventDestinationCommandOutput) => void ): void; - public createConfigurationSetEventDestination( + createConfigurationSetEventDestination( args: CreateConfigurationSetEventDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfigurationSetEventDestinationCommandOutput) => void ): void; - public createConfigurationSetEventDestination( - args: CreateConfigurationSetEventDestinationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateConfigurationSetEventDestinationCommandOutput) => void), - cb?: (err: any, data?: CreateConfigurationSetEventDestinationCommandOutput) => void - ): Promise | void { - const command = new CreateConfigurationSetEventDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create a new pool of dedicated IP addresses. A pool can include one or more dedicated - * IP addresses that are associated with your Amazon Pinpoint account. You can associate a pool with - * a configuration set. When you send an email that uses that configuration set, Amazon Pinpoint - * sends it using only the IP addresses in the associated pool.

+ * @see {@link CreateDedicatedIpPoolCommand} */ - public createDedicatedIpPool( + createDedicatedIpPool( args: CreateDedicatedIpPoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDedicatedIpPool( + createDedicatedIpPool( args: CreateDedicatedIpPoolCommandInput, cb: (err: any, data?: CreateDedicatedIpPoolCommandOutput) => void ): void; - public createDedicatedIpPool( + createDedicatedIpPool( args: CreateDedicatedIpPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDedicatedIpPoolCommandOutput) => void ): void; - public createDedicatedIpPool( - args: CreateDedicatedIpPoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDedicatedIpPoolCommandOutput) => void), - cb?: (err: any, data?: CreateDedicatedIpPoolCommandOutput) => void - ): Promise | void { - const command = new CreateDedicatedIpPoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled - * by various email providers around the world. When you perform a predictive inbox placement test, you provide a - * sample message that contains the content that you plan to send to your customers. Amazon Pinpoint - * then sends that message to special email addresses spread across several major email - * providers. After about 24 hours, the test is complete, and you can use the - * GetDeliverabilityTestReport operation to view the results of the - * test.

+ * @see {@link CreateDeliverabilityTestReportCommand} */ - public createDeliverabilityTestReport( + createDeliverabilityTestReport( args: CreateDeliverabilityTestReportCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDeliverabilityTestReport( + createDeliverabilityTestReport( args: CreateDeliverabilityTestReportCommandInput, cb: (err: any, data?: CreateDeliverabilityTestReportCommandOutput) => void ): void; - public createDeliverabilityTestReport( + createDeliverabilityTestReport( args: CreateDeliverabilityTestReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeliverabilityTestReportCommandOutput) => void ): void; - public createDeliverabilityTestReport( - args: CreateDeliverabilityTestReportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDeliverabilityTestReportCommandOutput) => void), - cb?: (err: any, data?: CreateDeliverabilityTestReportCommandOutput) => void - ): Promise | void { - const command = new CreateDeliverabilityTestReportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email - * address or domain that you use when you send email. Before you can use an identity to - * send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you - * demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint permission - * to send email from the address.

- *

When you verify an email address, Amazon Pinpoint sends an email to the address. Your email - * address is verified as soon as you follow the link in the verification email. - * - *

- *

When you verify a domain, this operation provides a set of DKIM tokens, which you can - * convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your - * domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS - * configuration for your domain. It usually takes around 72 hours to complete the domain - * verification process.

+ * @see {@link CreateEmailIdentityCommand} */ - public createEmailIdentity( + createEmailIdentity( args: CreateEmailIdentityCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEmailIdentity( + createEmailIdentity( args: CreateEmailIdentityCommandInput, cb: (err: any, data?: CreateEmailIdentityCommandOutput) => void ): void; - public createEmailIdentity( + createEmailIdentity( args: CreateEmailIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEmailIdentityCommandOutput) => void ): void; - public createEmailIdentity( - args: CreateEmailIdentityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEmailIdentityCommandOutput) => void), - cb?: (err: any, data?: CreateEmailIdentityCommandOutput) => void - ): Promise | void { - const command = new CreateEmailIdentityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete an existing configuration set.

- *

In Amazon Pinpoint, configuration sets are groups of rules that you can - * apply to the emails you send. You apply a configuration set to an email by including a - * reference to the configuration set in the headers of the email. When you apply a - * configuration set to an email, all of the rules in that configuration set are applied to - * the email.

+ * @see {@link DeleteConfigurationSetCommand} */ - public deleteConfigurationSet( + deleteConfigurationSet( args: DeleteConfigurationSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConfigurationSet( + deleteConfigurationSet( args: DeleteConfigurationSetCommandInput, cb: (err: any, data?: DeleteConfigurationSetCommandOutput) => void ): void; - public deleteConfigurationSet( + deleteConfigurationSet( args: DeleteConfigurationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationSetCommandOutput) => void ): void; - public deleteConfigurationSet( - args: DeleteConfigurationSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConfigurationSetCommandOutput) => void), - cb?: (err: any, data?: DeleteConfigurationSetCommandOutput) => void - ): Promise | void { - const command = new DeleteConfigurationSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete an event destination.

- *

In Amazon Pinpoint, events include message sends, deliveries, opens, - * clicks, bounces, and complaints. Event destinations are places that - * you can send information about these events to. For example, you can send event data to - * Amazon SNS to receive notifications when you receive bounces or complaints, or you can use - * Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

+ * @see {@link DeleteConfigurationSetEventDestinationCommand} */ - public deleteConfigurationSetEventDestination( + deleteConfigurationSetEventDestination( args: DeleteConfigurationSetEventDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConfigurationSetEventDestination( + deleteConfigurationSetEventDestination( args: DeleteConfigurationSetEventDestinationCommandInput, cb: (err: any, data?: DeleteConfigurationSetEventDestinationCommandOutput) => void ): void; - public deleteConfigurationSetEventDestination( + deleteConfigurationSetEventDestination( args: DeleteConfigurationSetEventDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationSetEventDestinationCommandOutput) => void ): void; - public deleteConfigurationSetEventDestination( - args: DeleteConfigurationSetEventDestinationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteConfigurationSetEventDestinationCommandOutput) => void), - cb?: (err: any, data?: DeleteConfigurationSetEventDestinationCommandOutput) => void - ): Promise | void { - const command = new DeleteConfigurationSetEventDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete a dedicated IP pool.

+ * @see {@link DeleteDedicatedIpPoolCommand} */ - public deleteDedicatedIpPool( + deleteDedicatedIpPool( args: DeleteDedicatedIpPoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDedicatedIpPool( + deleteDedicatedIpPool( args: DeleteDedicatedIpPoolCommandInput, cb: (err: any, data?: DeleteDedicatedIpPoolCommandOutput) => void ): void; - public deleteDedicatedIpPool( + deleteDedicatedIpPool( args: DeleteDedicatedIpPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDedicatedIpPoolCommandOutput) => void ): void; - public deleteDedicatedIpPool( - args: DeleteDedicatedIpPoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDedicatedIpPoolCommandOutput) => void), - cb?: (err: any, data?: DeleteDedicatedIpPoolCommandOutput) => void - ): Promise | void { - const command = new DeleteDedicatedIpPoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an email identity that you previously verified for use with Amazon Pinpoint. An identity - * can be either an email address or a domain name.

+ * @see {@link DeleteEmailIdentityCommand} */ - public deleteEmailIdentity( + deleteEmailIdentity( args: DeleteEmailIdentityCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEmailIdentity( + deleteEmailIdentity( args: DeleteEmailIdentityCommandInput, cb: (err: any, data?: DeleteEmailIdentityCommandOutput) => void ): void; - public deleteEmailIdentity( + deleteEmailIdentity( args: DeleteEmailIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEmailIdentityCommandOutput) => void ): void; - public deleteEmailIdentity( - args: DeleteEmailIdentityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEmailIdentityCommandOutput) => void), - cb?: (err: any, data?: DeleteEmailIdentityCommandOutput) => void - ): Promise | void { - const command = new DeleteEmailIdentityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Obtain information about the email-sending status and capabilities of your Amazon Pinpoint - * account in the current AWS Region.

+ * @see {@link GetAccountCommand} */ - public getAccount(args: GetAccountCommandInput, options?: __HttpHandlerOptions): Promise; - public getAccount(args: GetAccountCommandInput, cb: (err: any, data?: GetAccountCommandOutput) => void): void; - public getAccount( + getAccount(args: GetAccountCommandInput, options?: __HttpHandlerOptions): Promise; + getAccount(args: GetAccountCommandInput, cb: (err: any, data?: GetAccountCommandOutput) => void): void; + getAccount( args: GetAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountCommandOutput) => void ): void; - public getAccount( - args: GetAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccountCommandOutput) => void), - cb?: (err: any, data?: GetAccountCommandOutput) => void - ): Promise | void { - const command = new GetAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieve a list of the blacklists that your dedicated IP addresses appear on.

+ * @see {@link GetBlacklistReportsCommand} */ - public getBlacklistReports( + getBlacklistReports( args: GetBlacklistReportsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBlacklistReports( + getBlacklistReports( args: GetBlacklistReportsCommandInput, cb: (err: any, data?: GetBlacklistReportsCommandOutput) => void ): void; - public getBlacklistReports( + getBlacklistReports( args: GetBlacklistReportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBlacklistReportsCommandOutput) => void ): void; - public getBlacklistReports( - args: GetBlacklistReportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBlacklistReportsCommandOutput) => void), - cb?: (err: any, data?: GetBlacklistReportsCommandOutput) => void - ): Promise | void { - const command = new GetBlacklistReportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get information about an existing configuration set, including the dedicated IP pool - * that it's associated with, whether or not it's enabled for sending email, and - * more.

- *

In Amazon Pinpoint, configuration sets are groups of rules that you can - * apply to the emails you send. You apply a configuration set to an email by including a - * reference to the configuration set in the headers of the email. When you apply a - * configuration set to an email, all of the rules in that configuration set are applied to - * the email.

+ * @see {@link GetConfigurationSetCommand} */ - public getConfigurationSet( + getConfigurationSet( args: GetConfigurationSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConfigurationSet( + getConfigurationSet( args: GetConfigurationSetCommandInput, cb: (err: any, data?: GetConfigurationSetCommandOutput) => void ): void; - public getConfigurationSet( + getConfigurationSet( args: GetConfigurationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConfigurationSetCommandOutput) => void ): void; - public getConfigurationSet( - args: GetConfigurationSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConfigurationSetCommandOutput) => void), - cb?: (err: any, data?: GetConfigurationSetCommandOutput) => void - ): Promise | void { - const command = new GetConfigurationSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieve a list of event destinations that are associated with a configuration - * set.

- *

In Amazon Pinpoint, events include message sends, deliveries, opens, - * clicks, bounces, and complaints. Event destinations are places that - * you can send information about these events to. For example, you can send event data to - * Amazon SNS to receive notifications when you receive bounces or complaints, or you can use - * Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

+ * @see {@link GetConfigurationSetEventDestinationsCommand} */ - public getConfigurationSetEventDestinations( + getConfigurationSetEventDestinations( args: GetConfigurationSetEventDestinationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConfigurationSetEventDestinations( + getConfigurationSetEventDestinations( args: GetConfigurationSetEventDestinationsCommandInput, cb: (err: any, data?: GetConfigurationSetEventDestinationsCommandOutput) => void ): void; - public getConfigurationSetEventDestinations( + getConfigurationSetEventDestinations( args: GetConfigurationSetEventDestinationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConfigurationSetEventDestinationsCommandOutput) => void ): void; - public getConfigurationSetEventDestinations( - args: GetConfigurationSetEventDestinationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConfigurationSetEventDestinationsCommandOutput) => void), - cb?: (err: any, data?: GetConfigurationSetEventDestinationsCommandOutput) => void - ): Promise | void { - const command = new GetConfigurationSetEventDestinationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get information about a dedicated IP address, including the name of the dedicated IP - * pool that it's associated with, as well information about the automatic warm-up process - * for the address.

+ * @see {@link GetDedicatedIpCommand} */ - public getDedicatedIp( + getDedicatedIp( args: GetDedicatedIpCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDedicatedIp( - args: GetDedicatedIpCommandInput, - cb: (err: any, data?: GetDedicatedIpCommandOutput) => void - ): void; - public getDedicatedIp( + getDedicatedIp(args: GetDedicatedIpCommandInput, cb: (err: any, data?: GetDedicatedIpCommandOutput) => void): void; + getDedicatedIp( args: GetDedicatedIpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDedicatedIpCommandOutput) => void ): void; - public getDedicatedIp( - args: GetDedicatedIpCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDedicatedIpCommandOutput) => void), - cb?: (err: any, data?: GetDedicatedIpCommandOutput) => void - ): Promise | void { - const command = new GetDedicatedIpCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the dedicated IP addresses that are associated with your Amazon Pinpoint - * account.

+ * @see {@link GetDedicatedIpsCommand} */ - public getDedicatedIps( + getDedicatedIps( args: GetDedicatedIpsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDedicatedIps( - args: GetDedicatedIpsCommandInput, - cb: (err: any, data?: GetDedicatedIpsCommandOutput) => void - ): void; - public getDedicatedIps( + getDedicatedIps(args: GetDedicatedIpsCommandInput, cb: (err: any, data?: GetDedicatedIpsCommandOutput) => void): void; + getDedicatedIps( args: GetDedicatedIpsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDedicatedIpsCommandOutput) => void ): void; - public getDedicatedIps( - args: GetDedicatedIpsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDedicatedIpsCommandOutput) => void), - cb?: (err: any, data?: GetDedicatedIpsCommandOutput) => void - ): Promise | void { - const command = new GetDedicatedIpsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. - * When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and - * other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the - * ability to perform predictive inbox placement tests.

- *

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition - * to any other fees that you accrue by using Amazon Pinpoint. For more information about the - * features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

+ * @see {@link GetDeliverabilityDashboardOptionsCommand} */ - public getDeliverabilityDashboardOptions( + getDeliverabilityDashboardOptions( args: GetDeliverabilityDashboardOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDeliverabilityDashboardOptions( + getDeliverabilityDashboardOptions( args: GetDeliverabilityDashboardOptionsCommandInput, cb: (err: any, data?: GetDeliverabilityDashboardOptionsCommandOutput) => void ): void; - public getDeliverabilityDashboardOptions( + getDeliverabilityDashboardOptions( args: GetDeliverabilityDashboardOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeliverabilityDashboardOptionsCommandOutput) => void ): void; - public getDeliverabilityDashboardOptions( - args: GetDeliverabilityDashboardOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeliverabilityDashboardOptionsCommandOutput) => void), - cb?: (err: any, data?: GetDeliverabilityDashboardOptionsCommandOutput) => void - ): Promise | void { - const command = new GetDeliverabilityDashboardOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieve the results of a predictive inbox placement test.

+ * @see {@link GetDeliverabilityTestReportCommand} */ - public getDeliverabilityTestReport( + getDeliverabilityTestReport( args: GetDeliverabilityTestReportCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDeliverabilityTestReport( + getDeliverabilityTestReport( args: GetDeliverabilityTestReportCommandInput, cb: (err: any, data?: GetDeliverabilityTestReportCommandOutput) => void ): void; - public getDeliverabilityTestReport( + getDeliverabilityTestReport( args: GetDeliverabilityTestReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeliverabilityTestReportCommandOutput) => void ): void; - public getDeliverabilityTestReport( - args: GetDeliverabilityTestReportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeliverabilityTestReportCommandOutput) => void), - cb?: (err: any, data?: GetDeliverabilityTestReportCommandOutput) => void - ): Promise | void { - const command = new GetDeliverabilityTestReportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieve all the deliverability data for a specific campaign. This data is available - * for a campaign only if the campaign sent email by using a domain that the - * Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption - * operation).

+ * @see {@link GetDomainDeliverabilityCampaignCommand} */ - public getDomainDeliverabilityCampaign( + getDomainDeliverabilityCampaign( args: GetDomainDeliverabilityCampaignCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDomainDeliverabilityCampaign( + getDomainDeliverabilityCampaign( args: GetDomainDeliverabilityCampaignCommandInput, cb: (err: any, data?: GetDomainDeliverabilityCampaignCommandOutput) => void ): void; - public getDomainDeliverabilityCampaign( + getDomainDeliverabilityCampaign( args: GetDomainDeliverabilityCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDomainDeliverabilityCampaignCommandOutput) => void ): void; - public getDomainDeliverabilityCampaign( - args: GetDomainDeliverabilityCampaignCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDomainDeliverabilityCampaignCommandOutput) => void), - cb?: (err: any, data?: GetDomainDeliverabilityCampaignCommandOutput) => void - ): Promise | void { - const command = new GetDomainDeliverabilityCampaignCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieve inbox placement and engagement rates for the domains that you use to send - * email.

+ * @see {@link GetDomainStatisticsReportCommand} */ - public getDomainStatisticsReport( + getDomainStatisticsReport( args: GetDomainStatisticsReportCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDomainStatisticsReport( + getDomainStatisticsReport( args: GetDomainStatisticsReportCommandInput, cb: (err: any, data?: GetDomainStatisticsReportCommandOutput) => void ): void; - public getDomainStatisticsReport( + getDomainStatisticsReport( args: GetDomainStatisticsReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDomainStatisticsReportCommandOutput) => void ): void; - public getDomainStatisticsReport( - args: GetDomainStatisticsReportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDomainStatisticsReportCommandOutput) => void), - cb?: (err: any, data?: GetDomainStatisticsReportCommandOutput) => void - ): Promise | void { - const command = new GetDomainStatisticsReportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides information about a specific identity associated with your Amazon Pinpoint account, - * including the identity's verification status, its DKIM authentication status, and its - * custom Mail-From settings.

+ * @see {@link GetEmailIdentityCommand} */ - public getEmailIdentity( + getEmailIdentity( args: GetEmailIdentityCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEmailIdentity( + getEmailIdentity( args: GetEmailIdentityCommandInput, cb: (err: any, data?: GetEmailIdentityCommandOutput) => void ): void; - public getEmailIdentity( + getEmailIdentity( args: GetEmailIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEmailIdentityCommandOutput) => void ): void; - public getEmailIdentity( - args: GetEmailIdentityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEmailIdentityCommandOutput) => void), - cb?: (err: any, data?: GetEmailIdentityCommandOutput) => void - ): Promise | void { - const command = new GetEmailIdentityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all of the configuration sets associated with your Amazon Pinpoint account in the current - * region.

- *

In Amazon Pinpoint, configuration sets are groups of rules that you can - * apply to the emails you send. You apply a configuration set to an email by including a - * reference to the configuration set in the headers of the email. When you apply a - * configuration set to an email, all of the rules in that configuration set are applied to - * the email.

+ * @see {@link ListConfigurationSetsCommand} */ - public listConfigurationSets( + listConfigurationSets( args: ListConfigurationSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConfigurationSets( + listConfigurationSets( args: ListConfigurationSetsCommandInput, cb: (err: any, data?: ListConfigurationSetsCommandOutput) => void ): void; - public listConfigurationSets( + listConfigurationSets( args: ListConfigurationSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConfigurationSetsCommandOutput) => void ): void; - public listConfigurationSets( - args: ListConfigurationSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConfigurationSetsCommandOutput) => void), - cb?: (err: any, data?: ListConfigurationSetsCommandOutput) => void - ): Promise | void { - const command = new ListConfigurationSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current - * AWS Region.

+ * @see {@link ListDedicatedIpPoolsCommand} */ - public listDedicatedIpPools( + listDedicatedIpPools( args: ListDedicatedIpPoolsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDedicatedIpPools( + listDedicatedIpPools( args: ListDedicatedIpPoolsCommandInput, cb: (err: any, data?: ListDedicatedIpPoolsCommandOutput) => void ): void; - public listDedicatedIpPools( + listDedicatedIpPools( args: ListDedicatedIpPoolsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDedicatedIpPoolsCommandOutput) => void ): void; - public listDedicatedIpPools( - args: ListDedicatedIpPoolsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDedicatedIpPoolsCommandOutput) => void), - cb?: (err: any, data?: ListDedicatedIpPoolsCommandOutput) => void - ): Promise | void { - const command = new ListDedicatedIpPoolsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For - * predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport - * operation to view the results.

+ * @see {@link ListDeliverabilityTestReportsCommand} */ - public listDeliverabilityTestReports( + listDeliverabilityTestReports( args: ListDeliverabilityTestReportsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeliverabilityTestReports( + listDeliverabilityTestReports( args: ListDeliverabilityTestReportsCommandInput, cb: (err: any, data?: ListDeliverabilityTestReportsCommandOutput) => void ): void; - public listDeliverabilityTestReports( + listDeliverabilityTestReports( args: ListDeliverabilityTestReportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeliverabilityTestReportsCommandOutput) => void ): void; - public listDeliverabilityTestReports( - args: ListDeliverabilityTestReportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeliverabilityTestReportsCommandOutput) => void), - cb?: (err: any, data?: ListDeliverabilityTestReportsCommandOutput) => void - ): Promise | void { - const command = new ListDeliverabilityTestReportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieve deliverability data for all the campaigns that used a specific domain to send - * email during a specified time range. This data is available for a domain only if you - * enabled the Deliverability dashboard (PutDeliverabilityDashboardOption operation) - * for the domain.

+ * @see {@link ListDomainDeliverabilityCampaignsCommand} */ - public listDomainDeliverabilityCampaigns( + listDomainDeliverabilityCampaigns( args: ListDomainDeliverabilityCampaignsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDomainDeliverabilityCampaigns( + listDomainDeliverabilityCampaigns( args: ListDomainDeliverabilityCampaignsCommandInput, cb: (err: any, data?: ListDomainDeliverabilityCampaignsCommandOutput) => void ): void; - public listDomainDeliverabilityCampaigns( + listDomainDeliverabilityCampaigns( args: ListDomainDeliverabilityCampaignsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainDeliverabilityCampaignsCommandOutput) => void ): void; - public listDomainDeliverabilityCampaigns( - args: ListDomainDeliverabilityCampaignsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDomainDeliverabilityCampaignsCommandOutput) => void), - cb?: (err: any, data?: ListDomainDeliverabilityCampaignsCommandOutput) => void - ): Promise | void { - const command = new ListDomainDeliverabilityCampaignsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all of the email identities that are associated with your Amazon Pinpoint - * account. An identity can be either an email address or a domain. This operation returns - * identities that are verified as well as those that aren't.

+ * @see {@link ListEmailIdentitiesCommand} */ - public listEmailIdentities( + listEmailIdentities( args: ListEmailIdentitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEmailIdentities( + listEmailIdentities( args: ListEmailIdentitiesCommandInput, cb: (err: any, data?: ListEmailIdentitiesCommandOutput) => void ): void; - public listEmailIdentities( + listEmailIdentities( args: ListEmailIdentitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEmailIdentitiesCommandOutput) => void ): void; - public listEmailIdentities( - args: ListEmailIdentitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEmailIdentitiesCommandOutput) => void), - cb?: (err: any, data?: ListEmailIdentitiesCommandOutput) => void - ): Promise | void { - const command = new ListEmailIdentitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieve a list of the tags (keys and values) that are associated with a specified - * resource. A tag is a label that you optionally define and associate - * with a resource in Amazon Pinpoint. Each tag consists of a required tag - * key and an optional associated tag value. A tag key - * is a general label that acts as a category for more specific tag values. A tag value - * acts as a descriptor within a tag key.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enable or disable the automatic warm-up feature for dedicated IP addresses.

+ * @see {@link PutAccountDedicatedIpWarmupAttributesCommand} */ - public putAccountDedicatedIpWarmupAttributes( + putAccountDedicatedIpWarmupAttributes( args: PutAccountDedicatedIpWarmupAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAccountDedicatedIpWarmupAttributes( + putAccountDedicatedIpWarmupAttributes( args: PutAccountDedicatedIpWarmupAttributesCommandInput, cb: (err: any, data?: PutAccountDedicatedIpWarmupAttributesCommandOutput) => void ): void; - public putAccountDedicatedIpWarmupAttributes( + putAccountDedicatedIpWarmupAttributes( args: PutAccountDedicatedIpWarmupAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccountDedicatedIpWarmupAttributesCommandOutput) => void ): void; - public putAccountDedicatedIpWarmupAttributes( - args: PutAccountDedicatedIpWarmupAttributesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PutAccountDedicatedIpWarmupAttributesCommandOutput) => void), - cb?: (err: any, data?: PutAccountDedicatedIpWarmupAttributesCommandOutput) => void - ): Promise | void { - const command = new PutAccountDedicatedIpWarmupAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enable or disable the ability of your account to send email.

+ * @see {@link PutAccountSendingAttributesCommand} */ - public putAccountSendingAttributes( + putAccountSendingAttributes( args: PutAccountSendingAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAccountSendingAttributes( + putAccountSendingAttributes( args: PutAccountSendingAttributesCommandInput, cb: (err: any, data?: PutAccountSendingAttributesCommandOutput) => void ): void; - public putAccountSendingAttributes( + putAccountSendingAttributes( args: PutAccountSendingAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccountSendingAttributesCommandOutput) => void ): void; - public putAccountSendingAttributes( - args: PutAccountSendingAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAccountSendingAttributesCommandOutput) => void), - cb?: (err: any, data?: PutAccountSendingAttributesCommandOutput) => void - ): Promise | void { - const command = new PutAccountSendingAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools - * to create groups of dedicated IP addresses for sending specific types of email.

+ * @see {@link PutConfigurationSetDeliveryOptionsCommand} */ - public putConfigurationSetDeliveryOptions( + putConfigurationSetDeliveryOptions( args: PutConfigurationSetDeliveryOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putConfigurationSetDeliveryOptions( + putConfigurationSetDeliveryOptions( args: PutConfigurationSetDeliveryOptionsCommandInput, cb: (err: any, data?: PutConfigurationSetDeliveryOptionsCommandOutput) => void ): void; - public putConfigurationSetDeliveryOptions( + putConfigurationSetDeliveryOptions( args: PutConfigurationSetDeliveryOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConfigurationSetDeliveryOptionsCommandOutput) => void ): void; - public putConfigurationSetDeliveryOptions( - args: PutConfigurationSetDeliveryOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutConfigurationSetDeliveryOptionsCommandOutput) => void), - cb?: (err: any, data?: PutConfigurationSetDeliveryOptionsCommandOutput) => void - ): Promise | void { - const command = new PutConfigurationSetDeliveryOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enable or disable collection of reputation metrics for emails that you send using a - * particular configuration set in a specific AWS Region.

+ * @see {@link PutConfigurationSetReputationOptionsCommand} */ - public putConfigurationSetReputationOptions( + putConfigurationSetReputationOptions( args: PutConfigurationSetReputationOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putConfigurationSetReputationOptions( + putConfigurationSetReputationOptions( args: PutConfigurationSetReputationOptionsCommandInput, cb: (err: any, data?: PutConfigurationSetReputationOptionsCommandOutput) => void ): void; - public putConfigurationSetReputationOptions( + putConfigurationSetReputationOptions( args: PutConfigurationSetReputationOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConfigurationSetReputationOptionsCommandOutput) => void ): void; - public putConfigurationSetReputationOptions( - args: PutConfigurationSetReputationOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutConfigurationSetReputationOptionsCommandOutput) => void), - cb?: (err: any, data?: PutConfigurationSetReputationOptionsCommandOutput) => void - ): Promise | void { - const command = new PutConfigurationSetReputationOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enable or disable email sending for messages that use a particular configuration set - * in a specific AWS Region.

+ * @see {@link PutConfigurationSetSendingOptionsCommand} */ - public putConfigurationSetSendingOptions( + putConfigurationSetSendingOptions( args: PutConfigurationSetSendingOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putConfigurationSetSendingOptions( + putConfigurationSetSendingOptions( args: PutConfigurationSetSendingOptionsCommandInput, cb: (err: any, data?: PutConfigurationSetSendingOptionsCommandOutput) => void ): void; - public putConfigurationSetSendingOptions( + putConfigurationSetSendingOptions( args: PutConfigurationSetSendingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConfigurationSetSendingOptionsCommandOutput) => void ): void; - public putConfigurationSetSendingOptions( - args: PutConfigurationSetSendingOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutConfigurationSetSendingOptionsCommandOutput) => void), - cb?: (err: any, data?: PutConfigurationSetSendingOptionsCommandOutput) => void - ): Promise | void { - const command = new PutConfigurationSetSendingOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Specify a custom domain to use for open and click tracking elements in email that you - * send using Amazon Pinpoint.

+ * @see {@link PutConfigurationSetTrackingOptionsCommand} */ - public putConfigurationSetTrackingOptions( + putConfigurationSetTrackingOptions( args: PutConfigurationSetTrackingOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putConfigurationSetTrackingOptions( + putConfigurationSetTrackingOptions( args: PutConfigurationSetTrackingOptionsCommandInput, cb: (err: any, data?: PutConfigurationSetTrackingOptionsCommandOutput) => void ): void; - public putConfigurationSetTrackingOptions( + putConfigurationSetTrackingOptions( args: PutConfigurationSetTrackingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConfigurationSetTrackingOptionsCommandOutput) => void ): void; - public putConfigurationSetTrackingOptions( - args: PutConfigurationSetTrackingOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutConfigurationSetTrackingOptionsCommandOutput) => void), - cb?: (err: any, data?: PutConfigurationSetTrackingOptionsCommandOutput) => void - ): Promise | void { - const command = new PutConfigurationSetTrackingOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Move a dedicated IP address to an existing dedicated IP pool.

- * - *

The dedicated IP address that you specify must already exist, and must be - * associated with your Amazon Pinpoint account. - * - *

- *

The dedicated IP pool you specify must already exist. You can create a new pool by - * using the CreateDedicatedIpPool operation.

- * - *
+ * @see {@link PutDedicatedIpInPoolCommand} */ - public putDedicatedIpInPool( + putDedicatedIpInPool( args: PutDedicatedIpInPoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public putDedicatedIpInPool( + putDedicatedIpInPool( args: PutDedicatedIpInPoolCommandInput, cb: (err: any, data?: PutDedicatedIpInPoolCommandOutput) => void ): void; - public putDedicatedIpInPool( + putDedicatedIpInPool( args: PutDedicatedIpInPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDedicatedIpInPoolCommandOutput) => void ): void; - public putDedicatedIpInPool( - args: PutDedicatedIpInPoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutDedicatedIpInPoolCommandOutput) => void), - cb?: (err: any, data?: PutDedicatedIpInPoolCommandOutput) => void - ): Promise | void { - const command = new PutDedicatedIpInPoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

+ * @see {@link PutDedicatedIpWarmupAttributesCommand} */ - public putDedicatedIpWarmupAttributes( + putDedicatedIpWarmupAttributes( args: PutDedicatedIpWarmupAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putDedicatedIpWarmupAttributes( + putDedicatedIpWarmupAttributes( args: PutDedicatedIpWarmupAttributesCommandInput, cb: (err: any, data?: PutDedicatedIpWarmupAttributesCommandOutput) => void ): void; - public putDedicatedIpWarmupAttributes( + putDedicatedIpWarmupAttributes( args: PutDedicatedIpWarmupAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDedicatedIpWarmupAttributesCommandOutput) => void ): void; - public putDedicatedIpWarmupAttributes( - args: PutDedicatedIpWarmupAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutDedicatedIpWarmupAttributesCommandOutput) => void), - cb?: (err: any, data?: PutDedicatedIpWarmupAttributesCommandOutput) => void - ): Promise | void { - const command = new PutDedicatedIpWarmupAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the - * Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for - * the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform - * predictive inbox placement tests.

- *

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition - * to any other fees that you accrue by using Amazon Pinpoint. For more information about the - * features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

+ * @see {@link PutDeliverabilityDashboardOptionCommand} */ - public putDeliverabilityDashboardOption( + putDeliverabilityDashboardOption( args: PutDeliverabilityDashboardOptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public putDeliverabilityDashboardOption( + putDeliverabilityDashboardOption( args: PutDeliverabilityDashboardOptionCommandInput, cb: (err: any, data?: PutDeliverabilityDashboardOptionCommandOutput) => void ): void; - public putDeliverabilityDashboardOption( + putDeliverabilityDashboardOption( args: PutDeliverabilityDashboardOptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDeliverabilityDashboardOptionCommandOutput) => void ): void; - public putDeliverabilityDashboardOption( - args: PutDeliverabilityDashboardOptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutDeliverabilityDashboardOptionCommandOutput) => void), - cb?: (err: any, data?: PutDeliverabilityDashboardOptionCommandOutput) => void - ): Promise | void { - const command = new PutDeliverabilityDashboardOptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used to enable or disable DKIM authentication for an email identity.

+ * @see {@link PutEmailIdentityDkimAttributesCommand} */ - public putEmailIdentityDkimAttributes( + putEmailIdentityDkimAttributes( args: PutEmailIdentityDkimAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putEmailIdentityDkimAttributes( + putEmailIdentityDkimAttributes( args: PutEmailIdentityDkimAttributesCommandInput, cb: (err: any, data?: PutEmailIdentityDkimAttributesCommandOutput) => void ): void; - public putEmailIdentityDkimAttributes( + putEmailIdentityDkimAttributes( args: PutEmailIdentityDkimAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEmailIdentityDkimAttributesCommandOutput) => void ): void; - public putEmailIdentityDkimAttributes( - args: PutEmailIdentityDkimAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutEmailIdentityDkimAttributesCommandOutput) => void), - cb?: (err: any, data?: PutEmailIdentityDkimAttributesCommandOutput) => void - ): Promise | void { - const command = new PutEmailIdentityDkimAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used to enable or disable feedback forwarding for an identity. This setting determines - * what happens when an identity is used to send an email that results in a bounce or - * complaint event.

- *

When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce - * or complaint events occur. Amazon Pinpoint sends this notification to the address that you - * specified in the Return-Path header of the original email.

- *

When you disable feedback forwarding, Amazon Pinpoint sends notifications through other - * mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of - * tracking bounces and complaints. If you haven't set up another mechanism for receiving - * bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events - * occur (even if this setting is disabled).

+ * @see {@link PutEmailIdentityFeedbackAttributesCommand} */ - public putEmailIdentityFeedbackAttributes( + putEmailIdentityFeedbackAttributes( args: PutEmailIdentityFeedbackAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putEmailIdentityFeedbackAttributes( + putEmailIdentityFeedbackAttributes( args: PutEmailIdentityFeedbackAttributesCommandInput, cb: (err: any, data?: PutEmailIdentityFeedbackAttributesCommandOutput) => void ): void; - public putEmailIdentityFeedbackAttributes( + putEmailIdentityFeedbackAttributes( args: PutEmailIdentityFeedbackAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEmailIdentityFeedbackAttributesCommandOutput) => void ): void; - public putEmailIdentityFeedbackAttributes( - args: PutEmailIdentityFeedbackAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutEmailIdentityFeedbackAttributesCommandOutput) => void), - cb?: (err: any, data?: PutEmailIdentityFeedbackAttributesCommandOutput) => void - ): Promise | void { - const command = new PutEmailIdentityFeedbackAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used to enable or disable the custom Mail-From domain configuration for an email - * identity.

+ * @see {@link PutEmailIdentityMailFromAttributesCommand} */ - public putEmailIdentityMailFromAttributes( + putEmailIdentityMailFromAttributes( args: PutEmailIdentityMailFromAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putEmailIdentityMailFromAttributes( + putEmailIdentityMailFromAttributes( args: PutEmailIdentityMailFromAttributesCommandInput, cb: (err: any, data?: PutEmailIdentityMailFromAttributesCommandOutput) => void ): void; - public putEmailIdentityMailFromAttributes( + putEmailIdentityMailFromAttributes( args: PutEmailIdentityMailFromAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEmailIdentityMailFromAttributesCommandOutput) => void ): void; - public putEmailIdentityMailFromAttributes( - args: PutEmailIdentityMailFromAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutEmailIdentityMailFromAttributesCommandOutput) => void), - cb?: (err: any, data?: PutEmailIdentityMailFromAttributesCommandOutput) => void - ): Promise | void { - const command = new PutEmailIdentityMailFromAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sends an email message. You can use the Amazon Pinpoint Email API to send two types of - * messages:

- *
    - *
  • - *

    - * Simple – A standard email message. When - * you create this type of message, you specify the sender, the recipient, and the - * message body, and Amazon Pinpoint assembles the message for you.

    - *
  • - *
  • - *

    - * Raw – A raw, MIME-formatted email - * message. When you send this type of email, you have to specify all of the - * message headers, as well as the message body. You can use this message type to - * send messages that contain attachments. The message that you specify has to be a - * valid MIME message.

    - *
  • - *
+ * @see {@link SendEmailCommand} */ - public sendEmail(args: SendEmailCommandInput, options?: __HttpHandlerOptions): Promise; - public sendEmail(args: SendEmailCommandInput, cb: (err: any, data?: SendEmailCommandOutput) => void): void; - public sendEmail( + sendEmail(args: SendEmailCommandInput, options?: __HttpHandlerOptions): Promise; + sendEmail(args: SendEmailCommandInput, cb: (err: any, data?: SendEmailCommandOutput) => void): void; + sendEmail( args: SendEmailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendEmailCommandOutput) => void ): void; - public sendEmail( - args: SendEmailCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendEmailCommandOutput) => void), - cb?: (err: any, data?: SendEmailCommandOutput) => void - ): Promise | void { - const command = new SendEmailCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Add one or more tags (keys and values) to a specified resource. A - * tag is a label that you optionally define and associate with a - * resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different ways, - * such as by purpose, owner, environment, or other criteria. A resource can have as many - * as 50 tags.

- *

Each tag consists of a required tag key and an - * associated tag value, both of which you define. A tag key is a - * general label that acts as a category for more specific tag values. A tag value acts as - * a descriptor within a tag key.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Remove one or more tags (keys and values) from a specified resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update the configuration of an event destination for a configuration set.

- *

In Amazon Pinpoint, events include message sends, deliveries, opens, - * clicks, bounces, and complaints. Event destinations are places that - * you can send information about these events to. For example, you can send event data to - * Amazon SNS to receive notifications when you receive bounces or complaints, or you can use - * Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

+ * @see {@link UpdateConfigurationSetEventDestinationCommand} */ - public updateConfigurationSetEventDestination( + updateConfigurationSetEventDestination( args: UpdateConfigurationSetEventDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConfigurationSetEventDestination( + updateConfigurationSetEventDestination( args: UpdateConfigurationSetEventDestinationCommandInput, cb: (err: any, data?: UpdateConfigurationSetEventDestinationCommandOutput) => void ): void; - public updateConfigurationSetEventDestination( + updateConfigurationSetEventDestination( args: UpdateConfigurationSetEventDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConfigurationSetEventDestinationCommandOutput) => void ): void; - public updateConfigurationSetEventDestination( - args: UpdateConfigurationSetEventDestinationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateConfigurationSetEventDestinationCommandOutput) => void), - cb?: (err: any, data?: UpdateConfigurationSetEventDestinationCommandOutput) => void - ): Promise | void { - const command = new UpdateConfigurationSetEventDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Pinpoint Email Service + *

Welcome to the Amazon Pinpoint Email API Reference. This guide provides + * information about the Amazon Pinpoint Email API (version 1.0), including supported + * operations, data types, parameters, and schemas.

+ *

+ * Amazon Pinpoint is an AWS service that you + * can use to engage with your customers across multiple messaging channels. You can use + * Amazon Pinpoint to send email, SMS text messages, voice messages, and push notifications. The + * Amazon Pinpoint Email API provides programmatic access to options that are unique to the + * email channel and supplement the options provided by the Amazon Pinpoint API.

+ *

If you're new to Amazon Pinpoint, you might find it helpful to also review the Amazon + * Pinpoint Developer Guide. The Amazon Pinpoint Developer + * Guide provides tutorials, code samples, and procedures that demonstrate + * how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into + * mobile apps and other types of applications. The guide also provides information about + * key topics such as Amazon Pinpoint integration with other AWS services and the limits that apply + * to using the service.

+ *

The Amazon Pinpoint Email API is available in several AWS Regions and it provides an endpoint + * for each of these Regions. For a list of all the Regions and endpoints where the API is + * currently available, see AWS Service Endpoints in + * the Amazon Web Services General Reference. To learn more about AWS Regions, see + * Managing AWS + * Regions in the Amazon Web Services General Reference.

+ *

In each Region, AWS maintains multiple Availability Zones. These Availability Zones + * are physically isolated from each other, but are united by private, low-latency, + * high-throughput, and highly redundant network connections. These Availability Zones + * enable us to provide very high levels of availability and redundancy, while also + * minimizing latency. To learn more about the number of Availability Zones that are + * available in each Region, see AWS Global Infrastructure.

+ */ +export class PinpointEmail extends PinpointEmailClient implements PinpointEmail {} +createAggregatedClient(commands, PinpointEmail); diff --git a/clients/client-pinpoint-sms-voice-v2/src/PinpointSMSVoiceV2.ts b/clients/client-pinpoint-sms-voice-v2/src/PinpointSMSVoiceV2.ts index 82b86d2fe99e..e049cab86987 100644 --- a/clients/client-pinpoint-sms-voice-v2/src/PinpointSMSVoiceV2.ts +++ b/clients/client-pinpoint-sms-voice-v2/src/PinpointSMSVoiceV2.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -196,1608 +197,754 @@ import { UpdatePhoneNumberCommandOutput, } from "./commands/UpdatePhoneNumberCommand"; import { UpdatePoolCommand, UpdatePoolCommandInput, UpdatePoolCommandOutput } from "./commands/UpdatePoolCommand"; -import { PinpointSMSVoiceV2Client } from "./PinpointSMSVoiceV2Client"; +import { PinpointSMSVoiceV2Client, PinpointSMSVoiceV2ClientConfig } from "./PinpointSMSVoiceV2Client"; -/** - * @public - *

Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference. - * This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API - * resources, including supported HTTP methods, parameters, and schemas.

- *

Amazon Pinpoint is an Amazon Web Services service that you can use to engage with - * your recipients across multiple messaging channels. The Amazon Pinpoint SMS and - * Voice, version 2 API provides programmatic access to options that are unique to the SMS - * and voice channels and supplements the resources provided by the Amazon Pinpoint - * API.

- *

If you're new to Amazon Pinpoint, it's also helpful to review the - * Amazon Pinpoint Developer Guide. The Amazon Pinpoint - * Developer Guide provides tutorials, code samples, and procedures that - * demonstrate how to use Amazon Pinpoint features programmatically and how to integrate - * Amazon Pinpoint functionality into mobile apps and other types of applications. - * The guide also provides key information, such as Amazon Pinpoint integration with - * other Amazon Web Services services, and the quotas that apply to use of the - * service.

- */ -export class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client { +const commands = { + AssociateOriginationIdentityCommand, + CreateConfigurationSetCommand, + CreateEventDestinationCommand, + CreateOptOutListCommand, + CreatePoolCommand, + DeleteConfigurationSetCommand, + DeleteDefaultMessageTypeCommand, + DeleteDefaultSenderIdCommand, + DeleteEventDestinationCommand, + DeleteKeywordCommand, + DeleteOptedOutNumberCommand, + DeleteOptOutListCommand, + DeletePoolCommand, + DeleteTextMessageSpendLimitOverrideCommand, + DeleteVoiceMessageSpendLimitOverrideCommand, + DescribeAccountAttributesCommand, + DescribeAccountLimitsCommand, + DescribeConfigurationSetsCommand, + DescribeKeywordsCommand, + DescribeOptedOutNumbersCommand, + DescribeOptOutListsCommand, + DescribePhoneNumbersCommand, + DescribePoolsCommand, + DescribeSenderIdsCommand, + DescribeSpendLimitsCommand, + DisassociateOriginationIdentityCommand, + ListPoolOriginationIdentitiesCommand, + ListTagsForResourceCommand, + PutKeywordCommand, + PutOptedOutNumberCommand, + ReleasePhoneNumberCommand, + RequestPhoneNumberCommand, + SendTextMessageCommand, + SendVoiceMessageCommand, + SetDefaultMessageTypeCommand, + SetDefaultSenderIdCommand, + SetTextMessageSpendLimitOverrideCommand, + SetVoiceMessageSpendLimitOverrideCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateEventDestinationCommand, + UpdatePhoneNumberCommand, + UpdatePoolCommand, +}; + +export interface PinpointSMSVoiceV2 { /** - * @public - *

Associates the specified origination identity with a pool.

- *

If the origination identity is a phone number and is already associated with another - * pool, an Error is returned. A sender ID can be associated with multiple pools.

- *

If the origination identity configuration doesn't match the pool's configuration, an - * Error is returned.

+ * @see {@link AssociateOriginationIdentityCommand} */ - public associateOriginationIdentity( + associateOriginationIdentity( args: AssociateOriginationIdentityCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateOriginationIdentity( + associateOriginationIdentity( args: AssociateOriginationIdentityCommandInput, cb: (err: any, data?: AssociateOriginationIdentityCommandOutput) => void ): void; - public associateOriginationIdentity( + associateOriginationIdentity( args: AssociateOriginationIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateOriginationIdentityCommandOutput) => void ): void; - public associateOriginationIdentity( - args: AssociateOriginationIdentityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateOriginationIdentityCommandOutput) => void), - cb?: (err: any, data?: AssociateOriginationIdentityCommandOutput) => void - ): Promise | void { - const command = new AssociateOriginationIdentityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new configuration set. After you create the configuration set, you can add - * one or more event destinations to it.

- *

A configuration set is a set of rules that you apply to the SMS and voice messages - * that you send.

- *

When you send a message, you can optionally specify a single configuration set.

+ * @see {@link CreateConfigurationSetCommand} */ - public createConfigurationSet( + createConfigurationSet( args: CreateConfigurationSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConfigurationSet( + createConfigurationSet( args: CreateConfigurationSetCommandInput, cb: (err: any, data?: CreateConfigurationSetCommandOutput) => void ): void; - public createConfigurationSet( + createConfigurationSet( args: CreateConfigurationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfigurationSetCommandOutput) => void ): void; - public createConfigurationSet( - args: CreateConfigurationSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConfigurationSetCommandOutput) => void), - cb?: (err: any, data?: CreateConfigurationSetCommandOutput) => void - ): Promise | void { - const command = new CreateConfigurationSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new event destination in a configuration set.

- *

An event destination is a location where you send message events. The event options - * are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example, - * when a message is delivered successfully, you can send information about that event to - * an event destination, or send notifications to endpoints that are subscribed to an - * Amazon SNS topic.

- *

Each configuration set can contain between 0 and 5 event destinations. Each event - * destination can contain a reference to a single destination, such as a CloudWatch - * or Kinesis Data Firehose destination.

+ * @see {@link CreateEventDestinationCommand} */ - public createEventDestination( + createEventDestination( args: CreateEventDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEventDestination( + createEventDestination( args: CreateEventDestinationCommandInput, cb: (err: any, data?: CreateEventDestinationCommandOutput) => void ): void; - public createEventDestination( + createEventDestination( args: CreateEventDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEventDestinationCommandOutput) => void ): void; - public createEventDestination( - args: CreateEventDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEventDestinationCommandOutput) => void), - cb?: (err: any, data?: CreateEventDestinationCommandOutput) => void - ): Promise | void { - const command = new CreateEventDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new opt-out list.

- *

If the opt-out list name already exists, an Error is returned.

- *

An opt-out list is a list of phone numbers that are opted out, meaning you can't send - * SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for - * the phone number is added to the opt-out list. In addition to STOP, your recipients can - * use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported - * opt-out keywords, see - * SMS opt out in the Amazon Pinpoint User - * Guide.

+ * @see {@link CreateOptOutListCommand} */ - public createOptOutList( + createOptOutList( args: CreateOptOutListCommandInput, options?: __HttpHandlerOptions ): Promise; - public createOptOutList( + createOptOutList( args: CreateOptOutListCommandInput, cb: (err: any, data?: CreateOptOutListCommandOutput) => void ): void; - public createOptOutList( + createOptOutList( args: CreateOptOutListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateOptOutListCommandOutput) => void ): void; - public createOptOutList( - args: CreateOptOutListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateOptOutListCommandOutput) => void), - cb?: (err: any, data?: CreateOptOutListCommandOutput) => void - ): Promise | void { - const command = new CreateOptOutListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new pool and associates the specified origination identity to the pool. A - * pool can include one or more phone numbers and SenderIds that are associated with your - * Amazon Web Services account.

- *

The new pool inherits its configuration from the specified origination identity. This - * includes keywords, message type, opt-out list, two-way configuration, and self-managed - * opt-out configuration. Deletion protection isn't inherited from the origination identity - * and defaults to false.

- *

If the origination identity is a phone number and is already associated with another - * pool, an Error is returned. A sender ID can be associated with multiple pools.

+ * @see {@link CreatePoolCommand} */ - public createPool(args: CreatePoolCommandInput, options?: __HttpHandlerOptions): Promise; - public createPool(args: CreatePoolCommandInput, cb: (err: any, data?: CreatePoolCommandOutput) => void): void; - public createPool( + createPool(args: CreatePoolCommandInput, options?: __HttpHandlerOptions): Promise; + createPool(args: CreatePoolCommandInput, cb: (err: any, data?: CreatePoolCommandOutput) => void): void; + createPool( args: CreatePoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePoolCommandOutput) => void ): void; - public createPool( - args: CreatePoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePoolCommandOutput) => void), - cb?: (err: any, data?: CreatePoolCommandOutput) => void - ): Promise | void { - const command = new CreatePoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing configuration set.

- *

A configuration set is a set of rules that you apply to voice and SMS messages that - * you send. In a configuration set, you can specify a destination for specific types of - * events related to voice and SMS messages.

+ * @see {@link DeleteConfigurationSetCommand} */ - public deleteConfigurationSet( + deleteConfigurationSet( args: DeleteConfigurationSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConfigurationSet( + deleteConfigurationSet( args: DeleteConfigurationSetCommandInput, cb: (err: any, data?: DeleteConfigurationSetCommandOutput) => void ): void; - public deleteConfigurationSet( + deleteConfigurationSet( args: DeleteConfigurationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationSetCommandOutput) => void ): void; - public deleteConfigurationSet( - args: DeleteConfigurationSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConfigurationSetCommandOutput) => void), - cb?: (err: any, data?: DeleteConfigurationSetCommandOutput) => void - ): Promise | void { - const command = new DeleteConfigurationSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing default message type on a configuration set.

- *

A message type is a type of messages that you plan to send. If you send - * account-related messages or time-sensitive messages such as one-time passcodes, choose - * Transactional. If you plan to send messages that - * contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services - * account.

+ * @see {@link DeleteDefaultMessageTypeCommand} */ - public deleteDefaultMessageType( + deleteDefaultMessageType( args: DeleteDefaultMessageTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDefaultMessageType( + deleteDefaultMessageType( args: DeleteDefaultMessageTypeCommandInput, cb: (err: any, data?: DeleteDefaultMessageTypeCommandOutput) => void ): void; - public deleteDefaultMessageType( + deleteDefaultMessageType( args: DeleteDefaultMessageTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDefaultMessageTypeCommandOutput) => void ): void; - public deleteDefaultMessageType( - args: DeleteDefaultMessageTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDefaultMessageTypeCommandOutput) => void), - cb?: (err: any, data?: DeleteDefaultMessageTypeCommandOutput) => void - ): Promise | void { - const command = new DeleteDefaultMessageTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing default sender ID on a configuration set.

- *

A default sender ID is the identity that appears on recipients' devices when they - * receive SMS messages. Support for sender ID capabilities varies by country or - * region.

+ * @see {@link DeleteDefaultSenderIdCommand} */ - public deleteDefaultSenderId( + deleteDefaultSenderId( args: DeleteDefaultSenderIdCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDefaultSenderId( + deleteDefaultSenderId( args: DeleteDefaultSenderIdCommandInput, cb: (err: any, data?: DeleteDefaultSenderIdCommandOutput) => void ): void; - public deleteDefaultSenderId( + deleteDefaultSenderId( args: DeleteDefaultSenderIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDefaultSenderIdCommandOutput) => void ): void; - public deleteDefaultSenderId( - args: DeleteDefaultSenderIdCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDefaultSenderIdCommandOutput) => void), - cb?: (err: any, data?: DeleteDefaultSenderIdCommandOutput) => void - ): Promise | void { - const command = new DeleteDefaultSenderIdCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing event destination.

- *

An event destination is a location where you send response information about the - * messages that you send. For example, when a message is delivered successfully, you can - * send information about that event to an Amazon CloudWatch destination, or send - * notifications to endpoints that are subscribed to an Amazon SNS topic.

+ * @see {@link DeleteEventDestinationCommand} */ - public deleteEventDestination( + deleteEventDestination( args: DeleteEventDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEventDestination( + deleteEventDestination( args: DeleteEventDestinationCommandInput, cb: (err: any, data?: DeleteEventDestinationCommandOutput) => void ): void; - public deleteEventDestination( + deleteEventDestination( args: DeleteEventDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventDestinationCommandOutput) => void ): void; - public deleteEventDestination( - args: DeleteEventDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEventDestinationCommandOutput) => void), - cb?: (err: any, data?: DeleteEventDestinationCommandOutput) => void - ): Promise | void { - const command = new DeleteEventDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing keyword from an origination phone number or pool.

- *

A keyword is a word that you can search for on a particular phone number or pool. It - * is also a specific word or phrase that an end user can send to your number to elicit a - * response, such as an informational message or a special offer. When your number receives - * a message that begins with a keyword, Amazon Pinpoint responds with a customizable - * message.

- *

Keywords "HELP" and "STOP" can't be deleted or modified.

+ * @see {@link DeleteKeywordCommand} */ - public deleteKeyword( - args: DeleteKeywordCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteKeyword( - args: DeleteKeywordCommandInput, - cb: (err: any, data?: DeleteKeywordCommandOutput) => void - ): void; - public deleteKeyword( + deleteKeyword(args: DeleteKeywordCommandInput, options?: __HttpHandlerOptions): Promise; + deleteKeyword(args: DeleteKeywordCommandInput, cb: (err: any, data?: DeleteKeywordCommandOutput) => void): void; + deleteKeyword( args: DeleteKeywordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteKeywordCommandOutput) => void ): void; - public deleteKeyword( - args: DeleteKeywordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteKeywordCommandOutput) => void), - cb?: (err: any, data?: DeleteKeywordCommandOutput) => void - ): Promise | void { - const command = new DeleteKeywordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing opted out destination phone number from the specified opt-out - * list.

- *

Each destination phone number can only be deleted once every 30 days.

- *

If the specified destination phone number doesn't exist or if the opt-out list doesn't - * exist, an Error is returned.

+ * @see {@link DeleteOptedOutNumberCommand} */ - public deleteOptedOutNumber( + deleteOptedOutNumber( args: DeleteOptedOutNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteOptedOutNumber( + deleteOptedOutNumber( args: DeleteOptedOutNumberCommandInput, cb: (err: any, data?: DeleteOptedOutNumberCommandOutput) => void ): void; - public deleteOptedOutNumber( + deleteOptedOutNumber( args: DeleteOptedOutNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOptedOutNumberCommandOutput) => void ): void; - public deleteOptedOutNumber( - args: DeleteOptedOutNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteOptedOutNumberCommandOutput) => void), - cb?: (err: any, data?: DeleteOptedOutNumberCommandOutput) => void - ): Promise | void { - const command = new DeleteOptedOutNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are - * deleted.

- *

If the specified opt-out list name doesn't exist or is in-use by an origination phone - * number or pool, an Error is returned.

+ * @see {@link DeleteOptOutListCommand} */ - public deleteOptOutList( + deleteOptOutList( args: DeleteOptOutListCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteOptOutList( + deleteOptOutList( args: DeleteOptOutListCommandInput, cb: (err: any, data?: DeleteOptOutListCommandOutput) => void ): void; - public deleteOptOutList( + deleteOptOutList( args: DeleteOptOutListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOptOutListCommandOutput) => void ): void; - public deleteOptOutList( - args: DeleteOptOutListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteOptOutListCommandOutput) => void), - cb?: (err: any, data?: DeleteOptOutListCommandOutput) => void - ): Promise | void { - const command = new DeleteOptOutListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing pool. Deleting a pool disassociates all origination identities - * from that pool.

- *

If the pool status isn't active or if deletion protection is enabled, an Error is - * returned.

- *

A pool is a collection of phone numbers and SenderIds. A pool can include one or more - * phone numbers and SenderIds that are associated with your Amazon Web Services - * account.

+ * @see {@link DeletePoolCommand} */ - public deletePool(args: DeletePoolCommandInput, options?: __HttpHandlerOptions): Promise; - public deletePool(args: DeletePoolCommandInput, cb: (err: any, data?: DeletePoolCommandOutput) => void): void; - public deletePool( + deletePool(args: DeletePoolCommandInput, options?: __HttpHandlerOptions): Promise; + deletePool(args: DeletePoolCommandInput, cb: (err: any, data?: DeletePoolCommandOutput) => void): void; + deletePool( args: DeletePoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePoolCommandOutput) => void ): void; - public deletePool( - args: DeletePoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePoolCommandOutput) => void), - cb?: (err: any, data?: DeletePoolCommandOutput) => void - ): Promise | void { - const command = new DeletePoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an account-level monthly spending limit override for sending text messages. - * Deleting a spend limit override will set the EnforcedLimit to equal the - * MaxLimit, which is controlled by Amazon Web Services. For more - * information on spend limits (quotas) see Amazon Pinpoint quotas - * in the Amazon Pinpoint Developer Guide.

+ * @see {@link DeleteTextMessageSpendLimitOverrideCommand} */ - public deleteTextMessageSpendLimitOverride( + deleteTextMessageSpendLimitOverride( args: DeleteTextMessageSpendLimitOverrideCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTextMessageSpendLimitOverride( + deleteTextMessageSpendLimitOverride( args: DeleteTextMessageSpendLimitOverrideCommandInput, cb: (err: any, data?: DeleteTextMessageSpendLimitOverrideCommandOutput) => void ): void; - public deleteTextMessageSpendLimitOverride( + deleteTextMessageSpendLimitOverride( args: DeleteTextMessageSpendLimitOverrideCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTextMessageSpendLimitOverrideCommandOutput) => void ): void; - public deleteTextMessageSpendLimitOverride( - args: DeleteTextMessageSpendLimitOverrideCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTextMessageSpendLimitOverrideCommandOutput) => void), - cb?: (err: any, data?: DeleteTextMessageSpendLimitOverrideCommandOutput) => void - ): Promise | void { - const command = new DeleteTextMessageSpendLimitOverrideCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an account level monthly spend limit override for sending voice messages. - * Deleting a spend limit override sets the EnforcedLimit equal to the - * MaxLimit, which is controlled by Amazon Web Services. For more - * information on spending limits (quotas) see Amazon Pinpoint quotas - * in the Amazon Pinpoint Developer Guide.

+ * @see {@link DeleteVoiceMessageSpendLimitOverrideCommand} */ - public deleteVoiceMessageSpendLimitOverride( + deleteVoiceMessageSpendLimitOverride( args: DeleteVoiceMessageSpendLimitOverrideCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVoiceMessageSpendLimitOverride( + deleteVoiceMessageSpendLimitOverride( args: DeleteVoiceMessageSpendLimitOverrideCommandInput, cb: (err: any, data?: DeleteVoiceMessageSpendLimitOverrideCommandOutput) => void ): void; - public deleteVoiceMessageSpendLimitOverride( + deleteVoiceMessageSpendLimitOverride( args: DeleteVoiceMessageSpendLimitOverrideCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVoiceMessageSpendLimitOverrideCommandOutput) => void ): void; - public deleteVoiceMessageSpendLimitOverride( - args: DeleteVoiceMessageSpendLimitOverrideCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVoiceMessageSpendLimitOverrideCommandOutput) => void), - cb?: (err: any, data?: DeleteVoiceMessageSpendLimitOverrideCommandOutput) => void - ): Promise | void { - const command = new DeleteVoiceMessageSpendLimitOverrideCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes attributes of your Amazon Web Services account. The supported account - * attributes include account tier, which indicates whether your account is in the sandbox - * or production environment. When you're ready to move your account out of the sandbox, - * create an Amazon Web Services Support case for a service limit increase request.

- *

New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The sandbox - * protects both Amazon Web Services end recipients and SMS or voice recipients from fraud - * and abuse.

+ * @see {@link DescribeAccountAttributesCommand} */ - public describeAccountAttributes( + describeAccountAttributes( args: DescribeAccountAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccountAttributes( + describeAccountAttributes( args: DescribeAccountAttributesCommandInput, cb: (err: any, data?: DescribeAccountAttributesCommandOutput) => void ): void; - public describeAccountAttributes( + describeAccountAttributes( args: DescribeAccountAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountAttributesCommandOutput) => void ): void; - public describeAccountAttributes( - args: DescribeAccountAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccountAttributesCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountAttributesCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your - * account. The description for a quota includes the quota name, current usage toward that - * quota, and the quota's maximum value.

- *

When you establish an Amazon Web Services account, the account has initial quotas on - * the maximum number of configuration sets, opt-out lists, phone numbers, and pools that - * you can create in a given Region. For more information see - * Amazon Pinpoint quotas in the Amazon Pinpoint Developer - * Guide.

+ * @see {@link DescribeAccountLimitsCommand} */ - public describeAccountLimits( + describeAccountLimits( args: DescribeAccountLimitsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccountLimits( + describeAccountLimits( args: DescribeAccountLimitsCommandInput, cb: (err: any, data?: DescribeAccountLimitsCommandOutput) => void ): void; - public describeAccountLimits( + describeAccountLimits( args: DescribeAccountLimitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountLimitsCommandOutput) => void ): void; - public describeAccountLimits( - args: DescribeAccountLimitsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccountLimitsCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountLimitsCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountLimitsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified configuration sets or all in your account.

- *

If you specify configuration set names, the output includes information for only the - * specified configuration sets. If you specify filters, the output includes information - * for only those configuration sets that meet the filter criteria. If you don't specify - * configuration set names or filters, the output includes information for all - * configuration sets.

- *

If you specify a configuration set name that isn't valid, an error is returned.

+ * @see {@link DescribeConfigurationSetsCommand} */ - public describeConfigurationSets( + describeConfigurationSets( args: DescribeConfigurationSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConfigurationSets( + describeConfigurationSets( args: DescribeConfigurationSetsCommandInput, cb: (err: any, data?: DescribeConfigurationSetsCommandOutput) => void ): void; - public describeConfigurationSets( + describeConfigurationSets( args: DescribeConfigurationSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigurationSetsCommandOutput) => void ): void; - public describeConfigurationSets( - args: DescribeConfigurationSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConfigurationSetsCommandOutput) => void), - cb?: (err: any, data?: DescribeConfigurationSetsCommandOutput) => void - ): Promise | void { - const command = new DescribeConfigurationSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified keywords or all keywords on your origination phone number or - * pool.

- *

A keyword is a word that you can search for on a particular phone number or pool. It - * is also a specific word or phrase that an end user can send to your number to elicit a - * response, such as an informational message or a special offer. When your number receives - * a message that begins with a keyword, Amazon Pinpoint responds with a customizable - * message.

- *

If you specify a keyword that isn't valid, an Error is returned.

+ * @see {@link DescribeKeywordsCommand} */ - public describeKeywords( + describeKeywords( args: DescribeKeywordsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeKeywords( + describeKeywords( args: DescribeKeywordsCommandInput, cb: (err: any, data?: DescribeKeywordsCommandOutput) => void ): void; - public describeKeywords( + describeKeywords( args: DescribeKeywordsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeKeywordsCommandOutput) => void ): void; - public describeKeywords( - args: DescribeKeywordsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeKeywordsCommandOutput) => void), - cb?: (err: any, data?: DescribeKeywordsCommandOutput) => void - ): Promise | void { - const command = new DescribeKeywordsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified opted out destination numbers or all opted out destination - * numbers in an opt-out list.

- *

If you specify opted out numbers, the output includes information for only the - * specified opted out numbers. If you specify filters, the output includes information for - * only those opted out numbers that meet the filter criteria. If you don't specify opted - * out numbers or filters, the output includes information for all opted out destination - * numbers in your opt-out list.

- *

If you specify an opted out number that isn't valid, an Error is returned.

+ * @see {@link DescribeOptedOutNumbersCommand} */ - public describeOptedOutNumbers( + describeOptedOutNumbers( args: DescribeOptedOutNumbersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOptedOutNumbers( + describeOptedOutNumbers( args: DescribeOptedOutNumbersCommandInput, cb: (err: any, data?: DescribeOptedOutNumbersCommandOutput) => void ): void; - public describeOptedOutNumbers( + describeOptedOutNumbers( args: DescribeOptedOutNumbersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOptedOutNumbersCommandOutput) => void ): void; - public describeOptedOutNumbers( - args: DescribeOptedOutNumbersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOptedOutNumbersCommandOutput) => void), - cb?: (err: any, data?: DescribeOptedOutNumbersCommandOutput) => void - ): Promise | void { - const command = new DescribeOptedOutNumbersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified opt-out list or all opt-out lists in your account.

- *

If you specify opt-out list names, the output includes information for only the - * specified opt-out lists. Opt-out lists include only those that meet the filter criteria. - * If you don't specify opt-out list names or filters, the output includes information for - * all opt-out lists.

- *

If you specify an opt-out list name that isn't valid, an Error is returned.

+ * @see {@link DescribeOptOutListsCommand} */ - public describeOptOutLists( + describeOptOutLists( args: DescribeOptOutListsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOptOutLists( + describeOptOutLists( args: DescribeOptOutListsCommandInput, cb: (err: any, data?: DescribeOptOutListsCommandOutput) => void ): void; - public describeOptOutLists( + describeOptOutLists( args: DescribeOptOutListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOptOutListsCommandOutput) => void ): void; - public describeOptOutLists( - args: DescribeOptOutListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOptOutListsCommandOutput) => void), - cb?: (err: any, data?: DescribeOptOutListsCommandOutput) => void - ): Promise | void { - const command = new DescribeOptOutListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified origination phone number, or all the phone numbers in your - * account.

- *

If you specify phone number IDs, the output includes information for only the - * specified phone numbers. If you specify filters, the output includes information for - * only those phone numbers that meet the filter criteria. If you don't specify phone - * number IDs or filters, the output includes information for all phone numbers.

- *

If you specify a phone number ID that isn't valid, an Error is returned.

+ * @see {@link DescribePhoneNumbersCommand} */ - public describePhoneNumbers( + describePhoneNumbers( args: DescribePhoneNumbersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePhoneNumbers( + describePhoneNumbers( args: DescribePhoneNumbersCommandInput, cb: (err: any, data?: DescribePhoneNumbersCommandOutput) => void ): void; - public describePhoneNumbers( + describePhoneNumbers( args: DescribePhoneNumbersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePhoneNumbersCommandOutput) => void ): void; - public describePhoneNumbers( - args: DescribePhoneNumbersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePhoneNumbersCommandOutput) => void), - cb?: (err: any, data?: DescribePhoneNumbersCommandOutput) => void - ): Promise | void { - const command = new DescribePhoneNumbersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the specified pools or all pools associated with your Amazon Web Services - * account.

- *

If you specify pool IDs, the output includes information for only the specified pools. - * If you specify filters, the output includes information for only those pools that meet - * the filter criteria. If you don't specify pool IDs or filters, the output includes - * information for all pools.

- *

If you specify a pool ID that isn't valid, an Error is returned.

- *

A pool is a collection of phone numbers and SenderIds. A pool can include one or more - * phone numbers and SenderIds that are associated with your Amazon Web Services - * account.

+ * @see {@link DescribePoolsCommand} */ - public describePools( - args: DescribePoolsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describePools( - args: DescribePoolsCommandInput, - cb: (err: any, data?: DescribePoolsCommandOutput) => void - ): void; - public describePools( + describePools(args: DescribePoolsCommandInput, options?: __HttpHandlerOptions): Promise; + describePools(args: DescribePoolsCommandInput, cb: (err: any, data?: DescribePoolsCommandOutput) => void): void; + describePools( args: DescribePoolsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePoolsCommandOutput) => void ): void; - public describePools( - args: DescribePoolsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePoolsCommandOutput) => void), - cb?: (err: any, data?: DescribePoolsCommandOutput) => void - ): Promise | void { - const command = new DescribePoolsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.

- *

If you specify SenderIds, the output includes information for only the specified - * SenderIds. If you specify filters, the output includes information for only those - * SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the - * output includes information for all SenderIds.

- *

f you specify a sender ID that isn't valid, an Error is returned.

+ * @see {@link DescribeSenderIdsCommand} */ - public describeSenderIds( + describeSenderIds( args: DescribeSenderIdsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSenderIds( + describeSenderIds( args: DescribeSenderIdsCommandInput, cb: (err: any, data?: DescribeSenderIdsCommandOutput) => void ): void; - public describeSenderIds( + describeSenderIds( args: DescribeSenderIdsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSenderIdsCommandOutput) => void ): void; - public describeSenderIds( - args: DescribeSenderIdsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSenderIdsCommandOutput) => void), - cb?: (err: any, data?: DescribeSenderIdsCommandOutput) => void - ): Promise | void { - const command = new DescribeSenderIdsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the current Amazon Pinpoint monthly spend limits for sending voice and - * text messages.

- *

When you establish an Amazon Web Services account, the account has initial monthly - * spend limit in a given Region. For more information on increasing your monthly spend - * limit, see - * Requesting increases to your monthly SMS spending quota for Amazon Pinpoint - * in the Amazon Pinpoint User Guide.

+ * @see {@link DescribeSpendLimitsCommand} */ - public describeSpendLimits( + describeSpendLimits( args: DescribeSpendLimitsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSpendLimits( + describeSpendLimits( args: DescribeSpendLimitsCommandInput, cb: (err: any, data?: DescribeSpendLimitsCommandOutput) => void ): void; - public describeSpendLimits( + describeSpendLimits( args: DescribeSpendLimitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSpendLimitsCommandOutput) => void ): void; - public describeSpendLimits( - args: DescribeSpendLimitsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSpendLimitsCommandOutput) => void), - cb?: (err: any, data?: DescribeSpendLimitsCommandOutput) => void - ): Promise | void { - const command = new DescribeSpendLimitsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified origination identity from an existing pool.

- *

If the origination identity isn't associated with the specified pool, an Error is - * returned.

+ * @see {@link DisassociateOriginationIdentityCommand} */ - public disassociateOriginationIdentity( + disassociateOriginationIdentity( args: DisassociateOriginationIdentityCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateOriginationIdentity( + disassociateOriginationIdentity( args: DisassociateOriginationIdentityCommandInput, cb: (err: any, data?: DisassociateOriginationIdentityCommandOutput) => void ): void; - public disassociateOriginationIdentity( + disassociateOriginationIdentity( args: DisassociateOriginationIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateOriginationIdentityCommandOutput) => void ): void; - public disassociateOriginationIdentity( - args: DisassociateOriginationIdentityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateOriginationIdentityCommandOutput) => void), - cb?: (err: any, data?: DisassociateOriginationIdentityCommandOutput) => void - ): Promise | void { - const command = new DisassociateOriginationIdentityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all associated origination identities in your pool.

- *

If you specify filters, the output includes information for only those origination - * identities that meet the filter criteria.

+ * @see {@link ListPoolOriginationIdentitiesCommand} */ - public listPoolOriginationIdentities( + listPoolOriginationIdentities( args: ListPoolOriginationIdentitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPoolOriginationIdentities( + listPoolOriginationIdentities( args: ListPoolOriginationIdentitiesCommandInput, cb: (err: any, data?: ListPoolOriginationIdentitiesCommandOutput) => void ): void; - public listPoolOriginationIdentities( + listPoolOriginationIdentities( args: ListPoolOriginationIdentitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPoolOriginationIdentitiesCommandOutput) => void ): void; - public listPoolOriginationIdentities( - args: ListPoolOriginationIdentitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPoolOriginationIdentitiesCommandOutput) => void), - cb?: (err: any, data?: ListPoolOriginationIdentitiesCommandOutput) => void - ): Promise | void { - const command = new ListPoolOriginationIdentitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all tags associated with a resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates a keyword configuration on an origination phone number or - * pool.

- *

A keyword is a word that you can search for on a particular phone number or pool. It - * is also a specific word or phrase that an end user can send to your number to elicit a - * response, such as an informational message or a special offer. When your number receives - * a message that begins with a keyword, Amazon Pinpoint responds with a customizable - * message.

- *

If you specify a keyword that isn't valid, an Error is returned.

+ * @see {@link PutKeywordCommand} */ - public putKeyword(args: PutKeywordCommandInput, options?: __HttpHandlerOptions): Promise; - public putKeyword(args: PutKeywordCommandInput, cb: (err: any, data?: PutKeywordCommandOutput) => void): void; - public putKeyword( + putKeyword(args: PutKeywordCommandInput, options?: __HttpHandlerOptions): Promise; + putKeyword(args: PutKeywordCommandInput, cb: (err: any, data?: PutKeywordCommandOutput) => void): void; + putKeyword( args: PutKeywordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutKeywordCommandOutput) => void ): void; - public putKeyword( - args: PutKeywordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutKeywordCommandOutput) => void), - cb?: (err: any, data?: PutKeywordCommandOutput) => void - ): Promise | void { - const command = new PutKeywordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an opted out destination phone number in the opt-out list.

- *

If the destination phone number isn't valid or if the specified opt-out list doesn't - * exist, an Error is returned.

+ * @see {@link PutOptedOutNumberCommand} */ - public putOptedOutNumber( + putOptedOutNumber( args: PutOptedOutNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public putOptedOutNumber( + putOptedOutNumber( args: PutOptedOutNumberCommandInput, cb: (err: any, data?: PutOptedOutNumberCommandOutput) => void ): void; - public putOptedOutNumber( + putOptedOutNumber( args: PutOptedOutNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutOptedOutNumberCommandOutput) => void ): void; - public putOptedOutNumber( - args: PutOptedOutNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutOptedOutNumberCommandOutput) => void), - cb?: (err: any, data?: PutOptedOutNumberCommandOutput) => void - ): Promise | void { - const command = new PutOptedOutNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Releases an existing origination phone number in your account. Once released, a phone - * number is no longer available for sending messages.

- *

If the origination phone number has deletion protection enabled or is associated with - * a pool, an Error is returned.

+ * @see {@link ReleasePhoneNumberCommand} */ - public releasePhoneNumber( + releasePhoneNumber( args: ReleasePhoneNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public releasePhoneNumber( + releasePhoneNumber( args: ReleasePhoneNumberCommandInput, cb: (err: any, data?: ReleasePhoneNumberCommandOutput) => void ): void; - public releasePhoneNumber( + releasePhoneNumber( args: ReleasePhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReleasePhoneNumberCommandOutput) => void ): void; - public releasePhoneNumber( - args: ReleasePhoneNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReleasePhoneNumberCommandOutput) => void), - cb?: (err: any, data?: ReleasePhoneNumberCommandOutput) => void - ): Promise | void { - const command = new ReleasePhoneNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Request an origination phone number for use in your account. For more information on - * phone number request see Requesting a - * number in the Amazon Pinpoint User Guide.

+ * @see {@link RequestPhoneNumberCommand} */ - public requestPhoneNumber( + requestPhoneNumber( args: RequestPhoneNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public requestPhoneNumber( + requestPhoneNumber( args: RequestPhoneNumberCommandInput, cb: (err: any, data?: RequestPhoneNumberCommandOutput) => void ): void; - public requestPhoneNumber( + requestPhoneNumber( args: RequestPhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RequestPhoneNumberCommandOutput) => void ): void; - public requestPhoneNumber( - args: RequestPhoneNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RequestPhoneNumberCommandOutput) => void), - cb?: (err: any, data?: RequestPhoneNumberCommandOutput) => void - ): Promise | void { - const command = new RequestPhoneNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new text message and sends it to a recipient's phone number.

- *

SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit - * depends on the destination country of your messages, as well as the type of phone number - * (origination number) that you use to send the message. For more information, see Message Parts per - * Second (MPS) limits in the Amazon Pinpoint User - * Guide.

+ * @see {@link SendTextMessageCommand} */ - public sendTextMessage( + sendTextMessage( args: SendTextMessageCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendTextMessage( - args: SendTextMessageCommandInput, - cb: (err: any, data?: SendTextMessageCommandOutput) => void - ): void; - public sendTextMessage( + sendTextMessage(args: SendTextMessageCommandInput, cb: (err: any, data?: SendTextMessageCommandOutput) => void): void; + sendTextMessage( args: SendTextMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendTextMessageCommandOutput) => void ): void; - public sendTextMessage( - args: SendTextMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendTextMessageCommandOutput) => void), - cb?: (err: any, data?: SendTextMessageCommandOutput) => void - ): Promise | void { - const command = new SendTextMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows you to send a request that sends a text message through Amazon Pinpoint. - * This operation uses Amazon Polly to - * convert a text script into a voice message.

+ * @see {@link SendVoiceMessageCommand} */ - public sendVoiceMessage( + sendVoiceMessage( args: SendVoiceMessageCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendVoiceMessage( + sendVoiceMessage( args: SendVoiceMessageCommandInput, cb: (err: any, data?: SendVoiceMessageCommandOutput) => void ): void; - public sendVoiceMessage( + sendVoiceMessage( args: SendVoiceMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendVoiceMessageCommandOutput) => void ): void; - public sendVoiceMessage( - args: SendVoiceMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendVoiceMessageCommandOutput) => void), - cb?: (err: any, data?: SendVoiceMessageCommandOutput) => void - ): Promise | void { - const command = new SendVoiceMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the default message type on a configuration set.

- *

Choose the category of SMS messages that you plan to send from this account. If you - * send account-related messages or time-sensitive messages such as one-time passcodes, - * choose Transactional. If you plan to send messages that - * contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services - * account.

+ * @see {@link SetDefaultMessageTypeCommand} */ - public setDefaultMessageType( + setDefaultMessageType( args: SetDefaultMessageTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public setDefaultMessageType( + setDefaultMessageType( args: SetDefaultMessageTypeCommandInput, cb: (err: any, data?: SetDefaultMessageTypeCommandOutput) => void ): void; - public setDefaultMessageType( + setDefaultMessageType( args: SetDefaultMessageTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetDefaultMessageTypeCommandOutput) => void ): void; - public setDefaultMessageType( - args: SetDefaultMessageTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetDefaultMessageTypeCommandOutput) => void), - cb?: (err: any, data?: SetDefaultMessageTypeCommandOutput) => void - ): Promise | void { - const command = new SetDefaultMessageTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets default sender ID on a configuration set.

- *

When sending a text message to a destination country that supports sender IDs, the - * default sender ID on the configuration set specified will be used if no dedicated - * origination phone numbers or registered sender IDs are available in your account.

+ * @see {@link SetDefaultSenderIdCommand} */ - public setDefaultSenderId( + setDefaultSenderId( args: SetDefaultSenderIdCommandInput, options?: __HttpHandlerOptions ): Promise; - public setDefaultSenderId( + setDefaultSenderId( args: SetDefaultSenderIdCommandInput, cb: (err: any, data?: SetDefaultSenderIdCommandOutput) => void ): void; - public setDefaultSenderId( + setDefaultSenderId( args: SetDefaultSenderIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetDefaultSenderIdCommandOutput) => void ): void; - public setDefaultSenderId( - args: SetDefaultSenderIdCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetDefaultSenderIdCommandOutput) => void), - cb?: (err: any, data?: SetDefaultSenderIdCommandOutput) => void - ): Promise | void { - const command = new SetDefaultSenderIdCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets an account level monthly spend limit override for sending text messages. The - * requested spend limit must be less than or equal to the MaxLimit, which is - * set by Amazon Web Services.

+ * @see {@link SetTextMessageSpendLimitOverrideCommand} */ - public setTextMessageSpendLimitOverride( + setTextMessageSpendLimitOverride( args: SetTextMessageSpendLimitOverrideCommandInput, options?: __HttpHandlerOptions ): Promise; - public setTextMessageSpendLimitOverride( + setTextMessageSpendLimitOverride( args: SetTextMessageSpendLimitOverrideCommandInput, cb: (err: any, data?: SetTextMessageSpendLimitOverrideCommandOutput) => void ): void; - public setTextMessageSpendLimitOverride( + setTextMessageSpendLimitOverride( args: SetTextMessageSpendLimitOverrideCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetTextMessageSpendLimitOverrideCommandOutput) => void ): void; - public setTextMessageSpendLimitOverride( - args: SetTextMessageSpendLimitOverrideCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetTextMessageSpendLimitOverrideCommandOutput) => void), - cb?: (err: any, data?: SetTextMessageSpendLimitOverrideCommandOutput) => void - ): Promise | void { - const command = new SetTextMessageSpendLimitOverrideCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets an account level monthly spend limit override for sending voice messages. The - * requested spend limit must be less than or equal to the MaxLimit, which is - * set by Amazon Web Services.

+ * @see {@link SetVoiceMessageSpendLimitOverrideCommand} */ - public setVoiceMessageSpendLimitOverride( + setVoiceMessageSpendLimitOverride( args: SetVoiceMessageSpendLimitOverrideCommandInput, options?: __HttpHandlerOptions ): Promise; - public setVoiceMessageSpendLimitOverride( + setVoiceMessageSpendLimitOverride( args: SetVoiceMessageSpendLimitOverrideCommandInput, cb: (err: any, data?: SetVoiceMessageSpendLimitOverrideCommandOutput) => void ): void; - public setVoiceMessageSpendLimitOverride( + setVoiceMessageSpendLimitOverride( args: SetVoiceMessageSpendLimitOverrideCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetVoiceMessageSpendLimitOverrideCommandOutput) => void ): void; - public setVoiceMessageSpendLimitOverride( - args: SetVoiceMessageSpendLimitOverrideCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetVoiceMessageSpendLimitOverrideCommandOutput) => void), - cb?: (err: any, data?: SetVoiceMessageSpendLimitOverrideCommandOutput) => void - ): Promise | void { - const command = new SetVoiceMessageSpendLimitOverrideCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS - * Voice, version 2 resource. When you specify an existing tag key, the value is - * overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag - * consists of a key and an optional value. Tag keys must be unique per resource. For more - * information about tags, see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer - * Guide.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 - * resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer - * Guide.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing event destination in a configuration set. You can update the - * IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can - * also enable or disable the event destination.

- *

You may want to update an event destination to change its matching event types or - * updating the destination resource ARN. You can't change an event destination's type - * between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.

+ * @see {@link UpdateEventDestinationCommand} */ - public updateEventDestination( + updateEventDestination( args: UpdateEventDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEventDestination( + updateEventDestination( args: UpdateEventDestinationCommandInput, cb: (err: any, data?: UpdateEventDestinationCommandOutput) => void ): void; - public updateEventDestination( + updateEventDestination( args: UpdateEventDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEventDestinationCommandOutput) => void ): void; - public updateEventDestination( - args: UpdateEventDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEventDestinationCommandOutput) => void), - cb?: (err: any, data?: UpdateEventDestinationCommandOutput) => void - ): Promise | void { - const command = new UpdateEventDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the configuration of an existing origination phone number. You can update the - * opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable - * or disable self-managed opt-outs, and enable or disable deletion protection.

- *

If the origination phone number is associated with a pool, an Error is - * returned.

+ * @see {@link UpdatePhoneNumberCommand} */ - public updatePhoneNumber( + updatePhoneNumber( args: UpdatePhoneNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePhoneNumber( + updatePhoneNumber( args: UpdatePhoneNumberCommandInput, cb: (err: any, data?: UpdatePhoneNumberCommandOutput) => void ): void; - public updatePhoneNumber( + updatePhoneNumber( args: UpdatePhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePhoneNumberCommandOutput) => void ): void; - public updatePhoneNumber( - args: UpdatePhoneNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePhoneNumberCommandOutput) => void), - cb?: (err: any, data?: UpdatePhoneNumberCommandOutput) => void - ): Promise | void { - const command = new UpdatePhoneNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the configuration of an existing pool. You can update the opt-out list, enable - * or disable two-way messaging, change the TwoWayChannelArn, enable or - * disable self-managed opt-outs, enable or disable deletion protection, and enable or - * disable shared routes.

+ * @see {@link UpdatePoolCommand} */ - public updatePool(args: UpdatePoolCommandInput, options?: __HttpHandlerOptions): Promise; - public updatePool(args: UpdatePoolCommandInput, cb: (err: any, data?: UpdatePoolCommandOutput) => void): void; - public updatePool( + updatePool(args: UpdatePoolCommandInput, options?: __HttpHandlerOptions): Promise; + updatePool(args: UpdatePoolCommandInput, cb: (err: any, data?: UpdatePoolCommandOutput) => void): void; + updatePool( args: UpdatePoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePoolCommandOutput) => void ): void; - public updatePool( - args: UpdatePoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePoolCommandOutput) => void), - cb?: (err: any, data?: UpdatePoolCommandOutput) => void - ): Promise | void { - const command = new UpdatePoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference. + * This guide provides information about Amazon Pinpoint SMS and Voice, version 2 API + * resources, including supported HTTP methods, parameters, and schemas.

+ *

Amazon Pinpoint is an Amazon Web Services service that you can use to engage with + * your recipients across multiple messaging channels. The Amazon Pinpoint SMS and + * Voice, version 2 API provides programmatic access to options that are unique to the SMS + * and voice channels and supplements the resources provided by the Amazon Pinpoint + * API.

+ *

If you're new to Amazon Pinpoint, it's also helpful to review the + * Amazon Pinpoint Developer Guide. The Amazon Pinpoint + * Developer Guide provides tutorials, code samples, and procedures that + * demonstrate how to use Amazon Pinpoint features programmatically and how to integrate + * Amazon Pinpoint functionality into mobile apps and other types of applications. + * The guide also provides key information, such as Amazon Pinpoint integration with + * other Amazon Web Services services, and the quotas that apply to use of the + * service.

+ */ +export class PinpointSMSVoiceV2 extends PinpointSMSVoiceV2Client implements PinpointSMSVoiceV2 {} +createAggregatedClient(commands, PinpointSMSVoiceV2); diff --git a/clients/client-pinpoint-sms-voice/src/PinpointSMSVoice.ts b/clients/client-pinpoint-sms-voice/src/PinpointSMSVoice.ts index 8b9b07992e00..48a0611ce895 100644 --- a/clients/client-pinpoint-sms-voice/src/PinpointSMSVoice.ts +++ b/clients/client-pinpoint-sms-voice/src/PinpointSMSVoice.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -41,280 +42,160 @@ import { UpdateConfigurationSetEventDestinationCommandInput, UpdateConfigurationSetEventDestinationCommandOutput, } from "./commands/UpdateConfigurationSetEventDestinationCommand"; -import { PinpointSMSVoiceClient } from "./PinpointSMSVoiceClient"; +import { PinpointSMSVoiceClient, PinpointSMSVoiceClientConfig } from "./PinpointSMSVoiceClient"; -/** - * @public - * Pinpoint SMS and Voice Messaging public facing APIs - */ -export class PinpointSMSVoice extends PinpointSMSVoiceClient { +const commands = { + CreateConfigurationSetCommand, + CreateConfigurationSetEventDestinationCommand, + DeleteConfigurationSetCommand, + DeleteConfigurationSetEventDestinationCommand, + GetConfigurationSetEventDestinationsCommand, + ListConfigurationSetsCommand, + SendVoiceMessageCommand, + UpdateConfigurationSetEventDestinationCommand, +}; + +export interface PinpointSMSVoice { /** - * @public - * Create a new configuration set. After you create the configuration set, you can add one or more event destinations to it. + * @see {@link CreateConfigurationSetCommand} */ - public createConfigurationSet( + createConfigurationSet( args: CreateConfigurationSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConfigurationSet( + createConfigurationSet( args: CreateConfigurationSetCommandInput, cb: (err: any, data?: CreateConfigurationSetCommandOutput) => void ): void; - public createConfigurationSet( + createConfigurationSet( args: CreateConfigurationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfigurationSetCommandOutput) => void ): void; - public createConfigurationSet( - args: CreateConfigurationSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConfigurationSetCommandOutput) => void), - cb?: (err: any, data?: CreateConfigurationSetCommandOutput) => void - ): Promise | void { - const command = new CreateConfigurationSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Create a new event destination in a configuration set. + * @see {@link CreateConfigurationSetEventDestinationCommand} */ - public createConfigurationSetEventDestination( + createConfigurationSetEventDestination( args: CreateConfigurationSetEventDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConfigurationSetEventDestination( + createConfigurationSetEventDestination( args: CreateConfigurationSetEventDestinationCommandInput, cb: (err: any, data?: CreateConfigurationSetEventDestinationCommandOutput) => void ): void; - public createConfigurationSetEventDestination( + createConfigurationSetEventDestination( args: CreateConfigurationSetEventDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfigurationSetEventDestinationCommandOutput) => void ): void; - public createConfigurationSetEventDestination( - args: CreateConfigurationSetEventDestinationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateConfigurationSetEventDestinationCommandOutput) => void), - cb?: (err: any, data?: CreateConfigurationSetEventDestinationCommandOutput) => void - ): Promise | void { - const command = new CreateConfigurationSetEventDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Deletes an existing configuration set. + * @see {@link DeleteConfigurationSetCommand} */ - public deleteConfigurationSet( + deleteConfigurationSet( args: DeleteConfigurationSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConfigurationSet( + deleteConfigurationSet( args: DeleteConfigurationSetCommandInput, cb: (err: any, data?: DeleteConfigurationSetCommandOutput) => void ): void; - public deleteConfigurationSet( + deleteConfigurationSet( args: DeleteConfigurationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationSetCommandOutput) => void ): void; - public deleteConfigurationSet( - args: DeleteConfigurationSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConfigurationSetCommandOutput) => void), - cb?: (err: any, data?: DeleteConfigurationSetCommandOutput) => void - ): Promise | void { - const command = new DeleteConfigurationSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Deletes an event destination in a configuration set. + * @see {@link DeleteConfigurationSetEventDestinationCommand} */ - public deleteConfigurationSetEventDestination( + deleteConfigurationSetEventDestination( args: DeleteConfigurationSetEventDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConfigurationSetEventDestination( + deleteConfigurationSetEventDestination( args: DeleteConfigurationSetEventDestinationCommandInput, cb: (err: any, data?: DeleteConfigurationSetEventDestinationCommandOutput) => void ): void; - public deleteConfigurationSetEventDestination( + deleteConfigurationSetEventDestination( args: DeleteConfigurationSetEventDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationSetEventDestinationCommandOutput) => void ): void; - public deleteConfigurationSetEventDestination( - args: DeleteConfigurationSetEventDestinationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteConfigurationSetEventDestinationCommandOutput) => void), - cb?: (err: any, data?: DeleteConfigurationSetEventDestinationCommandOutput) => void - ): Promise | void { - const command = new DeleteConfigurationSetEventDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination. + * @see {@link GetConfigurationSetEventDestinationsCommand} */ - public getConfigurationSetEventDestinations( + getConfigurationSetEventDestinations( args: GetConfigurationSetEventDestinationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConfigurationSetEventDestinations( + getConfigurationSetEventDestinations( args: GetConfigurationSetEventDestinationsCommandInput, cb: (err: any, data?: GetConfigurationSetEventDestinationsCommandOutput) => void ): void; - public getConfigurationSetEventDestinations( + getConfigurationSetEventDestinations( args: GetConfigurationSetEventDestinationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConfigurationSetEventDestinationsCommandOutput) => void ): void; - public getConfigurationSetEventDestinations( - args: GetConfigurationSetEventDestinationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConfigurationSetEventDestinationsCommandOutput) => void), - cb?: (err: any, data?: GetConfigurationSetEventDestinationsCommandOutput) => void - ): Promise | void { - const command = new GetConfigurationSetEventDestinationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * List all of the configuration sets associated with your Amazon Pinpoint account in the current region. + * @see {@link ListConfigurationSetsCommand} */ - public listConfigurationSets( + listConfigurationSets( args: ListConfigurationSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConfigurationSets( + listConfigurationSets( args: ListConfigurationSetsCommandInput, cb: (err: any, data?: ListConfigurationSetsCommandOutput) => void ): void; - public listConfigurationSets( + listConfigurationSets( args: ListConfigurationSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConfigurationSetsCommandOutput) => void ): void; - public listConfigurationSets( - args: ListConfigurationSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConfigurationSetsCommandOutput) => void), - cb?: (err: any, data?: ListConfigurationSetsCommandOutput) => void - ): Promise | void { - const command = new ListConfigurationSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Create a new voice message and send it to a recipient's phone number. + * @see {@link SendVoiceMessageCommand} */ - public sendVoiceMessage( + sendVoiceMessage( args: SendVoiceMessageCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendVoiceMessage( + sendVoiceMessage( args: SendVoiceMessageCommandInput, cb: (err: any, data?: SendVoiceMessageCommandOutput) => void ): void; - public sendVoiceMessage( + sendVoiceMessage( args: SendVoiceMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendVoiceMessageCommandOutput) => void ): void; - public sendVoiceMessage( - args: SendVoiceMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendVoiceMessageCommandOutput) => void), - cb?: (err: any, data?: SendVoiceMessageCommandOutput) => void - ): Promise | void { - const command = new SendVoiceMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Update an event destination in a configuration set. An event destination is a location that you publish information about your voice calls to. For example, you can log an event to an Amazon CloudWatch destination when a call fails. + * @see {@link UpdateConfigurationSetEventDestinationCommand} */ - public updateConfigurationSetEventDestination( + updateConfigurationSetEventDestination( args: UpdateConfigurationSetEventDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConfigurationSetEventDestination( + updateConfigurationSetEventDestination( args: UpdateConfigurationSetEventDestinationCommandInput, cb: (err: any, data?: UpdateConfigurationSetEventDestinationCommandOutput) => void ): void; - public updateConfigurationSetEventDestination( + updateConfigurationSetEventDestination( args: UpdateConfigurationSetEventDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConfigurationSetEventDestinationCommandOutput) => void ): void; - public updateConfigurationSetEventDestination( - args: UpdateConfigurationSetEventDestinationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateConfigurationSetEventDestinationCommandOutput) => void), - cb?: (err: any, data?: UpdateConfigurationSetEventDestinationCommandOutput) => void - ): Promise | void { - const command = new UpdateConfigurationSetEventDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Pinpoint SMS and Voice Messaging public facing APIs + */ +export class PinpointSMSVoice extends PinpointSMSVoiceClient implements PinpointSMSVoice {} +createAggregatedClient(commands, PinpointSMSVoice); diff --git a/clients/client-pinpoint/src/Pinpoint.ts b/clients/client-pinpoint/src/Pinpoint.ts index fa4b17f2e617..00a642b21745 100644 --- a/clients/client-pinpoint/src/Pinpoint.ts +++ b/clients/client-pinpoint/src/Pinpoint.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { CreateAppCommand, CreateAppCommandInput, CreateAppCommandOutput } from "./commands/CreateAppCommand"; @@ -548,3850 +549,1930 @@ import { VerifyOTPMessageCommandInput, VerifyOTPMessageCommandOutput, } from "./commands/VerifyOTPMessageCommand"; -import { PinpointClient } from "./PinpointClient"; +import { PinpointClient, PinpointClientConfig } from "./PinpointClient"; -/** - * @public - *

Doc Engage API - Amazon Pinpoint API

- */ -export class Pinpoint extends PinpointClient { +const commands = { + CreateAppCommand, + CreateCampaignCommand, + CreateEmailTemplateCommand, + CreateExportJobCommand, + CreateImportJobCommand, + CreateInAppTemplateCommand, + CreateJourneyCommand, + CreatePushTemplateCommand, + CreateRecommenderConfigurationCommand, + CreateSegmentCommand, + CreateSmsTemplateCommand, + CreateVoiceTemplateCommand, + DeleteAdmChannelCommand, + DeleteApnsChannelCommand, + DeleteApnsSandboxChannelCommand, + DeleteApnsVoipChannelCommand, + DeleteApnsVoipSandboxChannelCommand, + DeleteAppCommand, + DeleteBaiduChannelCommand, + DeleteCampaignCommand, + DeleteEmailChannelCommand, + DeleteEmailTemplateCommand, + DeleteEndpointCommand, + DeleteEventStreamCommand, + DeleteGcmChannelCommand, + DeleteInAppTemplateCommand, + DeleteJourneyCommand, + DeletePushTemplateCommand, + DeleteRecommenderConfigurationCommand, + DeleteSegmentCommand, + DeleteSmsChannelCommand, + DeleteSmsTemplateCommand, + DeleteUserEndpointsCommand, + DeleteVoiceChannelCommand, + DeleteVoiceTemplateCommand, + GetAdmChannelCommand, + GetApnsChannelCommand, + GetApnsSandboxChannelCommand, + GetApnsVoipChannelCommand, + GetApnsVoipSandboxChannelCommand, + GetAppCommand, + GetApplicationDateRangeKpiCommand, + GetApplicationSettingsCommand, + GetAppsCommand, + GetBaiduChannelCommand, + GetCampaignCommand, + GetCampaignActivitiesCommand, + GetCampaignDateRangeKpiCommand, + GetCampaignsCommand, + GetCampaignVersionCommand, + GetCampaignVersionsCommand, + GetChannelsCommand, + GetEmailChannelCommand, + GetEmailTemplateCommand, + GetEndpointCommand, + GetEventStreamCommand, + GetExportJobCommand, + GetExportJobsCommand, + GetGcmChannelCommand, + GetImportJobCommand, + GetImportJobsCommand, + GetInAppMessagesCommand, + GetInAppTemplateCommand, + GetJourneyCommand, + GetJourneyDateRangeKpiCommand, + GetJourneyExecutionActivityMetricsCommand, + GetJourneyExecutionMetricsCommand, + GetPushTemplateCommand, + GetRecommenderConfigurationCommand, + GetRecommenderConfigurationsCommand, + GetSegmentCommand, + GetSegmentExportJobsCommand, + GetSegmentImportJobsCommand, + GetSegmentsCommand, + GetSegmentVersionCommand, + GetSegmentVersionsCommand, + GetSmsChannelCommand, + GetSmsTemplateCommand, + GetUserEndpointsCommand, + GetVoiceChannelCommand, + GetVoiceTemplateCommand, + ListJourneysCommand, + ListTagsForResourceCommand, + ListTemplatesCommand, + ListTemplateVersionsCommand, + PhoneNumberValidateCommand, + PutEventsCommand, + PutEventStreamCommand, + RemoveAttributesCommand, + SendMessagesCommand, + SendOTPMessageCommand, + SendUsersMessagesCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAdmChannelCommand, + UpdateApnsChannelCommand, + UpdateApnsSandboxChannelCommand, + UpdateApnsVoipChannelCommand, + UpdateApnsVoipSandboxChannelCommand, + UpdateApplicationSettingsCommand, + UpdateBaiduChannelCommand, + UpdateCampaignCommand, + UpdateEmailChannelCommand, + UpdateEmailTemplateCommand, + UpdateEndpointCommand, + UpdateEndpointsBatchCommand, + UpdateGcmChannelCommand, + UpdateInAppTemplateCommand, + UpdateJourneyCommand, + UpdateJourneyStateCommand, + UpdatePushTemplateCommand, + UpdateRecommenderConfigurationCommand, + UpdateSegmentCommand, + UpdateSmsChannelCommand, + UpdateSmsTemplateCommand, + UpdateTemplateActiveVersionCommand, + UpdateVoiceChannelCommand, + UpdateVoiceTemplateCommand, + VerifyOTPMessageCommand, +}; + +export interface Pinpoint { /** - * @public - *

Creates an application.

+ * @see {@link CreateAppCommand} */ - public createApp(args: CreateAppCommandInput, options?: __HttpHandlerOptions): Promise; - public createApp(args: CreateAppCommandInput, cb: (err: any, data?: CreateAppCommandOutput) => void): void; - public createApp( + createApp(args: CreateAppCommandInput, options?: __HttpHandlerOptions): Promise; + createApp(args: CreateAppCommandInput, cb: (err: any, data?: CreateAppCommandOutput) => void): void; + createApp( args: CreateAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppCommandOutput) => void ): void; - public createApp( - args: CreateAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAppCommandOutput) => void), - cb?: (err: any, data?: CreateAppCommandOutput) => void - ): Promise | void { - const command = new CreateAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new campaign for an application or updates the settings of an existing campaign for an application.

+ * @see {@link CreateCampaignCommand} */ - public createCampaign( + createCampaign( args: CreateCampaignCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCampaign( - args: CreateCampaignCommandInput, - cb: (err: any, data?: CreateCampaignCommandOutput) => void - ): void; - public createCampaign( + createCampaign(args: CreateCampaignCommandInput, cb: (err: any, data?: CreateCampaignCommandOutput) => void): void; + createCampaign( args: CreateCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCampaignCommandOutput) => void ): void; - public createCampaign( - args: CreateCampaignCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCampaignCommandOutput) => void), - cb?: (err: any, data?: CreateCampaignCommandOutput) => void - ): Promise | void { - const command = new CreateCampaignCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a message template for messages that are sent through the email channel.

+ * @see {@link CreateEmailTemplateCommand} */ - public createEmailTemplate( + createEmailTemplate( args: CreateEmailTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEmailTemplate( + createEmailTemplate( args: CreateEmailTemplateCommandInput, cb: (err: any, data?: CreateEmailTemplateCommandOutput) => void ): void; - public createEmailTemplate( + createEmailTemplate( args: CreateEmailTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEmailTemplateCommandOutput) => void ): void; - public createEmailTemplate( - args: CreateEmailTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEmailTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateEmailTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateEmailTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an export job for an application.

+ * @see {@link CreateExportJobCommand} */ - public createExportJob( + createExportJob( args: CreateExportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createExportJob( - args: CreateExportJobCommandInput, - cb: (err: any, data?: CreateExportJobCommandOutput) => void - ): void; - public createExportJob( + createExportJob(args: CreateExportJobCommandInput, cb: (err: any, data?: CreateExportJobCommandOutput) => void): void; + createExportJob( args: CreateExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExportJobCommandOutput) => void ): void; - public createExportJob( - args: CreateExportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateExportJobCommandOutput) => void), - cb?: (err: any, data?: CreateExportJobCommandOutput) => void - ): Promise | void { - const command = new CreateExportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an import job for an application.

+ * @see {@link CreateImportJobCommand} */ - public createImportJob( + createImportJob( args: CreateImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createImportJob( - args: CreateImportJobCommandInput, - cb: (err: any, data?: CreateImportJobCommandOutput) => void - ): void; - public createImportJob( + createImportJob(args: CreateImportJobCommandInput, cb: (err: any, data?: CreateImportJobCommandOutput) => void): void; + createImportJob( args: CreateImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateImportJobCommandOutput) => void ): void; - public createImportJob( - args: CreateImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateImportJobCommandOutput) => void), - cb?: (err: any, data?: CreateImportJobCommandOutput) => void - ): Promise | void { - const command = new CreateImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new message template for messages using the in-app message channel.

+ * @see {@link CreateInAppTemplateCommand} */ - public createInAppTemplate( + createInAppTemplate( args: CreateInAppTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createInAppTemplate( + createInAppTemplate( args: CreateInAppTemplateCommandInput, cb: (err: any, data?: CreateInAppTemplateCommandOutput) => void ): void; - public createInAppTemplate( + createInAppTemplate( args: CreateInAppTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInAppTemplateCommandOutput) => void ): void; - public createInAppTemplate( - args: CreateInAppTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateInAppTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateInAppTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateInAppTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a journey for an application.

+ * @see {@link CreateJourneyCommand} */ - public createJourney( - args: CreateJourneyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createJourney( - args: CreateJourneyCommandInput, - cb: (err: any, data?: CreateJourneyCommandOutput) => void - ): void; - public createJourney( + createJourney(args: CreateJourneyCommandInput, options?: __HttpHandlerOptions): Promise; + createJourney(args: CreateJourneyCommandInput, cb: (err: any, data?: CreateJourneyCommandOutput) => void): void; + createJourney( args: CreateJourneyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateJourneyCommandOutput) => void ): void; - public createJourney( - args: CreateJourneyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateJourneyCommandOutput) => void), - cb?: (err: any, data?: CreateJourneyCommandOutput) => void - ): Promise | void { - const command = new CreateJourneyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a message template for messages that are sent through a push notification channel.

+ * @see {@link CreatePushTemplateCommand} */ - public createPushTemplate( + createPushTemplate( args: CreatePushTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPushTemplate( + createPushTemplate( args: CreatePushTemplateCommandInput, cb: (err: any, data?: CreatePushTemplateCommandOutput) => void ): void; - public createPushTemplate( + createPushTemplate( args: CreatePushTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePushTemplateCommandOutput) => void ): void; - public createPushTemplate( - args: CreatePushTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePushTemplateCommandOutput) => void), - cb?: (err: any, data?: CreatePushTemplateCommandOutput) => void - ): Promise | void { - const command = new CreatePushTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Amazon Pinpoint configuration for a recommender model.

+ * @see {@link CreateRecommenderConfigurationCommand} */ - public createRecommenderConfiguration( + createRecommenderConfiguration( args: CreateRecommenderConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRecommenderConfiguration( + createRecommenderConfiguration( args: CreateRecommenderConfigurationCommandInput, cb: (err: any, data?: CreateRecommenderConfigurationCommandOutput) => void ): void; - public createRecommenderConfiguration( + createRecommenderConfiguration( args: CreateRecommenderConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRecommenderConfigurationCommandOutput) => void ): void; - public createRecommenderConfiguration( - args: CreateRecommenderConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRecommenderConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateRecommenderConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateRecommenderConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

+ * @see {@link CreateSegmentCommand} */ - public createSegment( - args: CreateSegmentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createSegment( - args: CreateSegmentCommandInput, - cb: (err: any, data?: CreateSegmentCommandOutput) => void - ): void; - public createSegment( + createSegment(args: CreateSegmentCommandInput, options?: __HttpHandlerOptions): Promise; + createSegment(args: CreateSegmentCommandInput, cb: (err: any, data?: CreateSegmentCommandOutput) => void): void; + createSegment( args: CreateSegmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSegmentCommandOutput) => void ): void; - public createSegment( - args: CreateSegmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSegmentCommandOutput) => void), - cb?: (err: any, data?: CreateSegmentCommandOutput) => void - ): Promise | void { - const command = new CreateSegmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a message template for messages that are sent through the SMS channel.

+ * @see {@link CreateSmsTemplateCommand} */ - public createSmsTemplate( + createSmsTemplate( args: CreateSmsTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSmsTemplate( + createSmsTemplate( args: CreateSmsTemplateCommandInput, cb: (err: any, data?: CreateSmsTemplateCommandOutput) => void ): void; - public createSmsTemplate( + createSmsTemplate( args: CreateSmsTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSmsTemplateCommandOutput) => void ): void; - public createSmsTemplate( - args: CreateSmsTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSmsTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateSmsTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateSmsTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a message template for messages that are sent through the voice channel.

+ * @see {@link CreateVoiceTemplateCommand} */ - public createVoiceTemplate( + createVoiceTemplate( args: CreateVoiceTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVoiceTemplate( + createVoiceTemplate( args: CreateVoiceTemplateCommandInput, cb: (err: any, data?: CreateVoiceTemplateCommandOutput) => void ): void; - public createVoiceTemplate( + createVoiceTemplate( args: CreateVoiceTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVoiceTemplateCommandOutput) => void ): void; - public createVoiceTemplate( - args: CreateVoiceTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVoiceTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateVoiceTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateVoiceTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables the ADM channel for an application and deletes any existing settings for the channel.

+ * @see {@link DeleteAdmChannelCommand} */ - public deleteAdmChannel( + deleteAdmChannel( args: DeleteAdmChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAdmChannel( + deleteAdmChannel( args: DeleteAdmChannelCommandInput, cb: (err: any, data?: DeleteAdmChannelCommandOutput) => void ): void; - public deleteAdmChannel( + deleteAdmChannel( args: DeleteAdmChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAdmChannelCommandOutput) => void ): void; - public deleteAdmChannel( - args: DeleteAdmChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAdmChannelCommandOutput) => void), - cb?: (err: any, data?: DeleteAdmChannelCommandOutput) => void - ): Promise | void { - const command = new DeleteAdmChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables the APNs channel for an application and deletes any existing settings for the channel.

+ * @see {@link DeleteApnsChannelCommand} */ - public deleteApnsChannel( + deleteApnsChannel( args: DeleteApnsChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApnsChannel( + deleteApnsChannel( args: DeleteApnsChannelCommandInput, cb: (err: any, data?: DeleteApnsChannelCommandOutput) => void ): void; - public deleteApnsChannel( + deleteApnsChannel( args: DeleteApnsChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApnsChannelCommandOutput) => void ): void; - public deleteApnsChannel( - args: DeleteApnsChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApnsChannelCommandOutput) => void), - cb?: (err: any, data?: DeleteApnsChannelCommandOutput) => void - ): Promise | void { - const command = new DeleteApnsChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.

+ * @see {@link DeleteApnsSandboxChannelCommand} */ - public deleteApnsSandboxChannel( + deleteApnsSandboxChannel( args: DeleteApnsSandboxChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApnsSandboxChannel( + deleteApnsSandboxChannel( args: DeleteApnsSandboxChannelCommandInput, cb: (err: any, data?: DeleteApnsSandboxChannelCommandOutput) => void ): void; - public deleteApnsSandboxChannel( + deleteApnsSandboxChannel( args: DeleteApnsSandboxChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApnsSandboxChannelCommandOutput) => void ): void; - public deleteApnsSandboxChannel( - args: DeleteApnsSandboxChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApnsSandboxChannelCommandOutput) => void), - cb?: (err: any, data?: DeleteApnsSandboxChannelCommandOutput) => void - ): Promise | void { - const command = new DeleteApnsSandboxChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.

+ * @see {@link DeleteApnsVoipChannelCommand} */ - public deleteApnsVoipChannel( + deleteApnsVoipChannel( args: DeleteApnsVoipChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApnsVoipChannel( + deleteApnsVoipChannel( args: DeleteApnsVoipChannelCommandInput, cb: (err: any, data?: DeleteApnsVoipChannelCommandOutput) => void ): void; - public deleteApnsVoipChannel( + deleteApnsVoipChannel( args: DeleteApnsVoipChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApnsVoipChannelCommandOutput) => void ): void; - public deleteApnsVoipChannel( - args: DeleteApnsVoipChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApnsVoipChannelCommandOutput) => void), - cb?: (err: any, data?: DeleteApnsVoipChannelCommandOutput) => void - ): Promise | void { - const command = new DeleteApnsVoipChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.

+ * @see {@link DeleteApnsVoipSandboxChannelCommand} */ - public deleteApnsVoipSandboxChannel( + deleteApnsVoipSandboxChannel( args: DeleteApnsVoipSandboxChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApnsVoipSandboxChannel( + deleteApnsVoipSandboxChannel( args: DeleteApnsVoipSandboxChannelCommandInput, cb: (err: any, data?: DeleteApnsVoipSandboxChannelCommandOutput) => void ): void; - public deleteApnsVoipSandboxChannel( + deleteApnsVoipSandboxChannel( args: DeleteApnsVoipSandboxChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApnsVoipSandboxChannelCommandOutput) => void ): void; - public deleteApnsVoipSandboxChannel( - args: DeleteApnsVoipSandboxChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApnsVoipSandboxChannelCommandOutput) => void), - cb?: (err: any, data?: DeleteApnsVoipSandboxChannelCommandOutput) => void - ): Promise | void { - const command = new DeleteApnsVoipSandboxChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an application.

+ * @see {@link DeleteAppCommand} */ - public deleteApp(args: DeleteAppCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteApp(args: DeleteAppCommandInput, cb: (err: any, data?: DeleteAppCommandOutput) => void): void; - public deleteApp( + deleteApp(args: DeleteAppCommandInput, options?: __HttpHandlerOptions): Promise; + deleteApp(args: DeleteAppCommandInput, cb: (err: any, data?: DeleteAppCommandOutput) => void): void; + deleteApp( args: DeleteAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppCommandOutput) => void ): void; - public deleteApp( - args: DeleteAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppCommandOutput) => void), - cb?: (err: any, data?: DeleteAppCommandOutput) => void - ): Promise | void { - const command = new DeleteAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables the Baidu channel for an application and deletes any existing settings for the channel.

+ * @see {@link DeleteBaiduChannelCommand} */ - public deleteBaiduChannel( + deleteBaiduChannel( args: DeleteBaiduChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBaiduChannel( + deleteBaiduChannel( args: DeleteBaiduChannelCommandInput, cb: (err: any, data?: DeleteBaiduChannelCommandOutput) => void ): void; - public deleteBaiduChannel( + deleteBaiduChannel( args: DeleteBaiduChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBaiduChannelCommandOutput) => void ): void; - public deleteBaiduChannel( - args: DeleteBaiduChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBaiduChannelCommandOutput) => void), - cb?: (err: any, data?: DeleteBaiduChannelCommandOutput) => void - ): Promise | void { - const command = new DeleteBaiduChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a campaign from an application.

+ * @see {@link DeleteCampaignCommand} */ - public deleteCampaign( + deleteCampaign( args: DeleteCampaignCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCampaign( - args: DeleteCampaignCommandInput, - cb: (err: any, data?: DeleteCampaignCommandOutput) => void - ): void; - public deleteCampaign( + deleteCampaign(args: DeleteCampaignCommandInput, cb: (err: any, data?: DeleteCampaignCommandOutput) => void): void; + deleteCampaign( args: DeleteCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCampaignCommandOutput) => void ): void; - public deleteCampaign( - args: DeleteCampaignCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCampaignCommandOutput) => void), - cb?: (err: any, data?: DeleteCampaignCommandOutput) => void - ): Promise | void { - const command = new DeleteCampaignCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables the email channel for an application and deletes any existing settings for the channel.

+ * @see {@link DeleteEmailChannelCommand} */ - public deleteEmailChannel( + deleteEmailChannel( args: DeleteEmailChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEmailChannel( + deleteEmailChannel( args: DeleteEmailChannelCommandInput, cb: (err: any, data?: DeleteEmailChannelCommandOutput) => void ): void; - public deleteEmailChannel( + deleteEmailChannel( args: DeleteEmailChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEmailChannelCommandOutput) => void ): void; - public deleteEmailChannel( - args: DeleteEmailChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEmailChannelCommandOutput) => void), - cb?: (err: any, data?: DeleteEmailChannelCommandOutput) => void - ): Promise | void { - const command = new DeleteEmailChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a message template for messages that were sent through the email channel.

+ * @see {@link DeleteEmailTemplateCommand} */ - public deleteEmailTemplate( + deleteEmailTemplate( args: DeleteEmailTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEmailTemplate( + deleteEmailTemplate( args: DeleteEmailTemplateCommandInput, cb: (err: any, data?: DeleteEmailTemplateCommandOutput) => void ): void; - public deleteEmailTemplate( + deleteEmailTemplate( args: DeleteEmailTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEmailTemplateCommandOutput) => void ): void; - public deleteEmailTemplate( - args: DeleteEmailTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEmailTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteEmailTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteEmailTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an endpoint from an application.

+ * @see {@link DeleteEndpointCommand} */ - public deleteEndpoint( + deleteEndpoint( args: DeleteEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEndpoint( - args: DeleteEndpointCommandInput, - cb: (err: any, data?: DeleteEndpointCommandOutput) => void - ): void; - public deleteEndpoint( + deleteEndpoint(args: DeleteEndpointCommandInput, cb: (err: any, data?: DeleteEndpointCommandOutput) => void): void; + deleteEndpoint( args: DeleteEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEndpointCommandOutput) => void ): void; - public deleteEndpoint( - args: DeleteEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEndpointCommandOutput) => void), - cb?: (err: any, data?: DeleteEndpointCommandOutput) => void - ): Promise | void { - const command = new DeleteEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the event stream for an application.

+ * @see {@link DeleteEventStreamCommand} */ - public deleteEventStream( + deleteEventStream( args: DeleteEventStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEventStream( + deleteEventStream( args: DeleteEventStreamCommandInput, cb: (err: any, data?: DeleteEventStreamCommandOutput) => void ): void; - public deleteEventStream( + deleteEventStream( args: DeleteEventStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventStreamCommandOutput) => void ): void; - public deleteEventStream( - args: DeleteEventStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEventStreamCommandOutput) => void), - cb?: (err: any, data?: DeleteEventStreamCommandOutput) => void - ): Promise | void { - const command = new DeleteEventStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables the GCM channel for an application and deletes any existing settings for the channel.

+ * @see {@link DeleteGcmChannelCommand} */ - public deleteGcmChannel( + deleteGcmChannel( args: DeleteGcmChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteGcmChannel( + deleteGcmChannel( args: DeleteGcmChannelCommandInput, cb: (err: any, data?: DeleteGcmChannelCommandOutput) => void ): void; - public deleteGcmChannel( + deleteGcmChannel( args: DeleteGcmChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGcmChannelCommandOutput) => void ): void; - public deleteGcmChannel( - args: DeleteGcmChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGcmChannelCommandOutput) => void), - cb?: (err: any, data?: DeleteGcmChannelCommandOutput) => void - ): Promise | void { - const command = new DeleteGcmChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a message template for messages sent using the in-app message channel.

+ * @see {@link DeleteInAppTemplateCommand} */ - public deleteInAppTemplate( + deleteInAppTemplate( args: DeleteInAppTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInAppTemplate( + deleteInAppTemplate( args: DeleteInAppTemplateCommandInput, cb: (err: any, data?: DeleteInAppTemplateCommandOutput) => void ): void; - public deleteInAppTemplate( + deleteInAppTemplate( args: DeleteInAppTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInAppTemplateCommandOutput) => void ): void; - public deleteInAppTemplate( - args: DeleteInAppTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInAppTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteInAppTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteInAppTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a journey from an application.

+ * @see {@link DeleteJourneyCommand} */ - public deleteJourney( - args: DeleteJourneyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteJourney( - args: DeleteJourneyCommandInput, - cb: (err: any, data?: DeleteJourneyCommandOutput) => void - ): void; - public deleteJourney( + deleteJourney(args: DeleteJourneyCommandInput, options?: __HttpHandlerOptions): Promise; + deleteJourney(args: DeleteJourneyCommandInput, cb: (err: any, data?: DeleteJourneyCommandOutput) => void): void; + deleteJourney( args: DeleteJourneyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteJourneyCommandOutput) => void ): void; - public deleteJourney( - args: DeleteJourneyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteJourneyCommandOutput) => void), - cb?: (err: any, data?: DeleteJourneyCommandOutput) => void - ): Promise | void { - const command = new DeleteJourneyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a message template for messages that were sent through a push notification channel.

+ * @see {@link DeletePushTemplateCommand} */ - public deletePushTemplate( + deletePushTemplate( args: DeletePushTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePushTemplate( + deletePushTemplate( args: DeletePushTemplateCommandInput, cb: (err: any, data?: DeletePushTemplateCommandOutput) => void ): void; - public deletePushTemplate( + deletePushTemplate( args: DeletePushTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePushTemplateCommandOutput) => void ): void; - public deletePushTemplate( - args: DeletePushTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePushTemplateCommandOutput) => void), - cb?: (err: any, data?: DeletePushTemplateCommandOutput) => void - ): Promise | void { - const command = new DeletePushTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon Pinpoint configuration for a recommender model.

+ * @see {@link DeleteRecommenderConfigurationCommand} */ - public deleteRecommenderConfiguration( + deleteRecommenderConfiguration( args: DeleteRecommenderConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRecommenderConfiguration( + deleteRecommenderConfiguration( args: DeleteRecommenderConfigurationCommandInput, cb: (err: any, data?: DeleteRecommenderConfigurationCommandOutput) => void ): void; - public deleteRecommenderConfiguration( + deleteRecommenderConfiguration( args: DeleteRecommenderConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRecommenderConfigurationCommandOutput) => void ): void; - public deleteRecommenderConfiguration( - args: DeleteRecommenderConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRecommenderConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteRecommenderConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteRecommenderConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a segment from an application.

+ * @see {@link DeleteSegmentCommand} */ - public deleteSegment( - args: DeleteSegmentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteSegment( - args: DeleteSegmentCommandInput, - cb: (err: any, data?: DeleteSegmentCommandOutput) => void - ): void; - public deleteSegment( + deleteSegment(args: DeleteSegmentCommandInput, options?: __HttpHandlerOptions): Promise; + deleteSegment(args: DeleteSegmentCommandInput, cb: (err: any, data?: DeleteSegmentCommandOutput) => void): void; + deleteSegment( args: DeleteSegmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSegmentCommandOutput) => void ): void; - public deleteSegment( - args: DeleteSegmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSegmentCommandOutput) => void), - cb?: (err: any, data?: DeleteSegmentCommandOutput) => void - ): Promise | void { - const command = new DeleteSegmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables the SMS channel for an application and deletes any existing settings for the channel.

+ * @see {@link DeleteSmsChannelCommand} */ - public deleteSmsChannel( + deleteSmsChannel( args: DeleteSmsChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSmsChannel( + deleteSmsChannel( args: DeleteSmsChannelCommandInput, cb: (err: any, data?: DeleteSmsChannelCommandOutput) => void ): void; - public deleteSmsChannel( + deleteSmsChannel( args: DeleteSmsChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSmsChannelCommandOutput) => void ): void; - public deleteSmsChannel( - args: DeleteSmsChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSmsChannelCommandOutput) => void), - cb?: (err: any, data?: DeleteSmsChannelCommandOutput) => void - ): Promise | void { - const command = new DeleteSmsChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a message template for messages that were sent through the SMS channel.

+ * @see {@link DeleteSmsTemplateCommand} */ - public deleteSmsTemplate( + deleteSmsTemplate( args: DeleteSmsTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSmsTemplate( + deleteSmsTemplate( args: DeleteSmsTemplateCommandInput, cb: (err: any, data?: DeleteSmsTemplateCommandOutput) => void ): void; - public deleteSmsTemplate( + deleteSmsTemplate( args: DeleteSmsTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSmsTemplateCommandOutput) => void ): void; - public deleteSmsTemplate( - args: DeleteSmsTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSmsTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteSmsTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteSmsTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes all the endpoints that are associated with a specific user ID.

+ * @see {@link DeleteUserEndpointsCommand} */ - public deleteUserEndpoints( + deleteUserEndpoints( args: DeleteUserEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteUserEndpoints( + deleteUserEndpoints( args: DeleteUserEndpointsCommandInput, cb: (err: any, data?: DeleteUserEndpointsCommandOutput) => void ): void; - public deleteUserEndpoints( + deleteUserEndpoints( args: DeleteUserEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserEndpointsCommandOutput) => void ): void; - public deleteUserEndpoints( - args: DeleteUserEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserEndpointsCommandOutput) => void), - cb?: (err: any, data?: DeleteUserEndpointsCommandOutput) => void - ): Promise | void { - const command = new DeleteUserEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables the voice channel for an application and deletes any existing settings for the channel.

+ * @see {@link DeleteVoiceChannelCommand} */ - public deleteVoiceChannel( + deleteVoiceChannel( args: DeleteVoiceChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVoiceChannel( + deleteVoiceChannel( args: DeleteVoiceChannelCommandInput, cb: (err: any, data?: DeleteVoiceChannelCommandOutput) => void ): void; - public deleteVoiceChannel( + deleteVoiceChannel( args: DeleteVoiceChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVoiceChannelCommandOutput) => void ): void; - public deleteVoiceChannel( - args: DeleteVoiceChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVoiceChannelCommandOutput) => void), - cb?: (err: any, data?: DeleteVoiceChannelCommandOutput) => void - ): Promise | void { - const command = new DeleteVoiceChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a message template for messages that were sent through the voice channel.

+ * @see {@link DeleteVoiceTemplateCommand} */ - public deleteVoiceTemplate( + deleteVoiceTemplate( args: DeleteVoiceTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVoiceTemplate( + deleteVoiceTemplate( args: DeleteVoiceTemplateCommandInput, cb: (err: any, data?: DeleteVoiceTemplateCommandOutput) => void ): void; - public deleteVoiceTemplate( + deleteVoiceTemplate( args: DeleteVoiceTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVoiceTemplateCommandOutput) => void ): void; - public deleteVoiceTemplate( - args: DeleteVoiceTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVoiceTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteVoiceTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteVoiceTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status and settings of the ADM channel for an application.

+ * @see {@link GetAdmChannelCommand} */ - public getAdmChannel( - args: GetAdmChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getAdmChannel( - args: GetAdmChannelCommandInput, - cb: (err: any, data?: GetAdmChannelCommandOutput) => void - ): void; - public getAdmChannel( + getAdmChannel(args: GetAdmChannelCommandInput, options?: __HttpHandlerOptions): Promise; + getAdmChannel(args: GetAdmChannelCommandInput, cb: (err: any, data?: GetAdmChannelCommandOutput) => void): void; + getAdmChannel( args: GetAdmChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAdmChannelCommandOutput) => void ): void; - public getAdmChannel( - args: GetAdmChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAdmChannelCommandOutput) => void), - cb?: (err: any, data?: GetAdmChannelCommandOutput) => void - ): Promise | void { - const command = new GetAdmChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status and settings of the APNs channel for an application.

+ * @see {@link GetApnsChannelCommand} */ - public getApnsChannel( + getApnsChannel( args: GetApnsChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public getApnsChannel( - args: GetApnsChannelCommandInput, - cb: (err: any, data?: GetApnsChannelCommandOutput) => void - ): void; - public getApnsChannel( + getApnsChannel(args: GetApnsChannelCommandInput, cb: (err: any, data?: GetApnsChannelCommandOutput) => void): void; + getApnsChannel( args: GetApnsChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApnsChannelCommandOutput) => void ): void; - public getApnsChannel( - args: GetApnsChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApnsChannelCommandOutput) => void), - cb?: (err: any, data?: GetApnsChannelCommandOutput) => void - ): Promise | void { - const command = new GetApnsChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status and settings of the APNs sandbox channel for an application.

+ * @see {@link GetApnsSandboxChannelCommand} */ - public getApnsSandboxChannel( + getApnsSandboxChannel( args: GetApnsSandboxChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public getApnsSandboxChannel( + getApnsSandboxChannel( args: GetApnsSandboxChannelCommandInput, cb: (err: any, data?: GetApnsSandboxChannelCommandOutput) => void ): void; - public getApnsSandboxChannel( + getApnsSandboxChannel( args: GetApnsSandboxChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApnsSandboxChannelCommandOutput) => void ): void; - public getApnsSandboxChannel( - args: GetApnsSandboxChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApnsSandboxChannelCommandOutput) => void), - cb?: (err: any, data?: GetApnsSandboxChannelCommandOutput) => void - ): Promise | void { - const command = new GetApnsSandboxChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status and settings of the APNs VoIP channel for an application.

+ * @see {@link GetApnsVoipChannelCommand} */ - public getApnsVoipChannel( + getApnsVoipChannel( args: GetApnsVoipChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public getApnsVoipChannel( + getApnsVoipChannel( args: GetApnsVoipChannelCommandInput, cb: (err: any, data?: GetApnsVoipChannelCommandOutput) => void ): void; - public getApnsVoipChannel( + getApnsVoipChannel( args: GetApnsVoipChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApnsVoipChannelCommandOutput) => void ): void; - public getApnsVoipChannel( - args: GetApnsVoipChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApnsVoipChannelCommandOutput) => void), - cb?: (err: any, data?: GetApnsVoipChannelCommandOutput) => void - ): Promise | void { - const command = new GetApnsVoipChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.

+ * @see {@link GetApnsVoipSandboxChannelCommand} */ - public getApnsVoipSandboxChannel( + getApnsVoipSandboxChannel( args: GetApnsVoipSandboxChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public getApnsVoipSandboxChannel( + getApnsVoipSandboxChannel( args: GetApnsVoipSandboxChannelCommandInput, cb: (err: any, data?: GetApnsVoipSandboxChannelCommandOutput) => void ): void; - public getApnsVoipSandboxChannel( + getApnsVoipSandboxChannel( args: GetApnsVoipSandboxChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApnsVoipSandboxChannelCommandOutput) => void ): void; - public getApnsVoipSandboxChannel( - args: GetApnsVoipSandboxChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApnsVoipSandboxChannelCommandOutput) => void), - cb?: (err: any, data?: GetApnsVoipSandboxChannelCommandOutput) => void - ): Promise | void { - const command = new GetApnsVoipSandboxChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about an application.

+ * @see {@link GetAppCommand} */ - public getApp(args: GetAppCommandInput, options?: __HttpHandlerOptions): Promise; - public getApp(args: GetAppCommandInput, cb: (err: any, data?: GetAppCommandOutput) => void): void; - public getApp( + getApp(args: GetAppCommandInput, options?: __HttpHandlerOptions): Promise; + getApp(args: GetAppCommandInput, cb: (err: any, data?: GetAppCommandOutput) => void): void; + getApp( args: GetAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAppCommandOutput) => void ): void; - public getApp( - args: GetAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAppCommandOutput) => void), - cb?: (err: any, data?: GetAppCommandOutput) => void - ): Promise | void { - const command = new GetAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.

+ * @see {@link GetApplicationDateRangeKpiCommand} */ - public getApplicationDateRangeKpi( + getApplicationDateRangeKpi( args: GetApplicationDateRangeKpiCommandInput, options?: __HttpHandlerOptions ): Promise; - public getApplicationDateRangeKpi( + getApplicationDateRangeKpi( args: GetApplicationDateRangeKpiCommandInput, cb: (err: any, data?: GetApplicationDateRangeKpiCommandOutput) => void ): void; - public getApplicationDateRangeKpi( + getApplicationDateRangeKpi( args: GetApplicationDateRangeKpiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApplicationDateRangeKpiCommandOutput) => void ): void; - public getApplicationDateRangeKpi( - args: GetApplicationDateRangeKpiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApplicationDateRangeKpiCommandOutput) => void), - cb?: (err: any, data?: GetApplicationDateRangeKpiCommandOutput) => void - ): Promise | void { - const command = new GetApplicationDateRangeKpiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the settings for an application.

+ * @see {@link GetApplicationSettingsCommand} */ - public getApplicationSettings( + getApplicationSettings( args: GetApplicationSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getApplicationSettings( + getApplicationSettings( args: GetApplicationSettingsCommandInput, cb: (err: any, data?: GetApplicationSettingsCommandOutput) => void ): void; - public getApplicationSettings( + getApplicationSettings( args: GetApplicationSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApplicationSettingsCommandOutput) => void ): void; - public getApplicationSettings( - args: GetApplicationSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApplicationSettingsCommandOutput) => void), - cb?: (err: any, data?: GetApplicationSettingsCommandOutput) => void - ): Promise | void { - const command = new GetApplicationSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about all the applications that are associated with your Amazon Pinpoint account.

+ * @see {@link GetAppsCommand} */ - public getApps(args: GetAppsCommandInput, options?: __HttpHandlerOptions): Promise; - public getApps(args: GetAppsCommandInput, cb: (err: any, data?: GetAppsCommandOutput) => void): void; - public getApps( + getApps(args: GetAppsCommandInput, options?: __HttpHandlerOptions): Promise; + getApps(args: GetAppsCommandInput, cb: (err: any, data?: GetAppsCommandOutput) => void): void; + getApps( args: GetAppsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAppsCommandOutput) => void ): void; - public getApps( - args: GetAppsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAppsCommandOutput) => void), - cb?: (err: any, data?: GetAppsCommandOutput) => void - ): Promise | void { - const command = new GetAppsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status and settings of the Baidu channel for an application.

+ * @see {@link GetBaiduChannelCommand} */ - public getBaiduChannel( + getBaiduChannel( args: GetBaiduChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBaiduChannel( - args: GetBaiduChannelCommandInput, - cb: (err: any, data?: GetBaiduChannelCommandOutput) => void - ): void; - public getBaiduChannel( + getBaiduChannel(args: GetBaiduChannelCommandInput, cb: (err: any, data?: GetBaiduChannelCommandOutput) => void): void; + getBaiduChannel( args: GetBaiduChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBaiduChannelCommandOutput) => void ): void; - public getBaiduChannel( - args: GetBaiduChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBaiduChannelCommandOutput) => void), - cb?: (err: any, data?: GetBaiduChannelCommandOutput) => void - ): Promise | void { - const command = new GetBaiduChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status, configuration, and other settings for a campaign.

+ * @see {@link GetCampaignCommand} */ - public getCampaign(args: GetCampaignCommandInput, options?: __HttpHandlerOptions): Promise; - public getCampaign(args: GetCampaignCommandInput, cb: (err: any, data?: GetCampaignCommandOutput) => void): void; - public getCampaign( + getCampaign(args: GetCampaignCommandInput, options?: __HttpHandlerOptions): Promise; + getCampaign(args: GetCampaignCommandInput, cb: (err: any, data?: GetCampaignCommandOutput) => void): void; + getCampaign( args: GetCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCampaignCommandOutput) => void ): void; - public getCampaign( - args: GetCampaignCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCampaignCommandOutput) => void), - cb?: (err: any, data?: GetCampaignCommandOutput) => void - ): Promise | void { - const command = new GetCampaignCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about all the activities for a campaign.

+ * @see {@link GetCampaignActivitiesCommand} */ - public getCampaignActivities( + getCampaignActivities( args: GetCampaignActivitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCampaignActivities( + getCampaignActivities( args: GetCampaignActivitiesCommandInput, cb: (err: any, data?: GetCampaignActivitiesCommandOutput) => void ): void; - public getCampaignActivities( + getCampaignActivities( args: GetCampaignActivitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCampaignActivitiesCommandOutput) => void ): void; - public getCampaignActivities( - args: GetCampaignActivitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCampaignActivitiesCommandOutput) => void), - cb?: (err: any, data?: GetCampaignActivitiesCommandOutput) => void - ): Promise | void { - const command = new GetCampaignActivitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.

+ * @see {@link GetCampaignDateRangeKpiCommand} */ - public getCampaignDateRangeKpi( + getCampaignDateRangeKpi( args: GetCampaignDateRangeKpiCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCampaignDateRangeKpi( + getCampaignDateRangeKpi( args: GetCampaignDateRangeKpiCommandInput, cb: (err: any, data?: GetCampaignDateRangeKpiCommandOutput) => void ): void; - public getCampaignDateRangeKpi( + getCampaignDateRangeKpi( args: GetCampaignDateRangeKpiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCampaignDateRangeKpiCommandOutput) => void ): void; - public getCampaignDateRangeKpi( - args: GetCampaignDateRangeKpiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCampaignDateRangeKpiCommandOutput) => void), - cb?: (err: any, data?: GetCampaignDateRangeKpiCommandOutput) => void - ): Promise | void { - const command = new GetCampaignDateRangeKpiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.

+ * @see {@link GetCampaignsCommand} */ - public getCampaigns( - args: GetCampaignsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getCampaigns(args: GetCampaignsCommandInput, cb: (err: any, data?: GetCampaignsCommandOutput) => void): void; - public getCampaigns( + getCampaigns(args: GetCampaignsCommandInput, options?: __HttpHandlerOptions): Promise; + getCampaigns(args: GetCampaignsCommandInput, cb: (err: any, data?: GetCampaignsCommandOutput) => void): void; + getCampaigns( args: GetCampaignsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCampaignsCommandOutput) => void ): void; - public getCampaigns( - args: GetCampaignsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCampaignsCommandOutput) => void), - cb?: (err: any, data?: GetCampaignsCommandOutput) => void - ): Promise | void { - const command = new GetCampaignsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status, configuration, and other settings for a specific version of a campaign.

+ * @see {@link GetCampaignVersionCommand} */ - public getCampaignVersion( + getCampaignVersion( args: GetCampaignVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCampaignVersion( + getCampaignVersion( args: GetCampaignVersionCommandInput, cb: (err: any, data?: GetCampaignVersionCommandOutput) => void ): void; - public getCampaignVersion( + getCampaignVersion( args: GetCampaignVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCampaignVersionCommandOutput) => void ): void; - public getCampaignVersion( - args: GetCampaignVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCampaignVersionCommandOutput) => void), - cb?: (err: any, data?: GetCampaignVersionCommandOutput) => void - ): Promise | void { - const command = new GetCampaignVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status, configuration, and other settings for all versions of a campaign.

+ * @see {@link GetCampaignVersionsCommand} */ - public getCampaignVersions( + getCampaignVersions( args: GetCampaignVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCampaignVersions( + getCampaignVersions( args: GetCampaignVersionsCommandInput, cb: (err: any, data?: GetCampaignVersionsCommandOutput) => void ): void; - public getCampaignVersions( + getCampaignVersions( args: GetCampaignVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCampaignVersionsCommandOutput) => void ): void; - public getCampaignVersions( - args: GetCampaignVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCampaignVersionsCommandOutput) => void), - cb?: (err: any, data?: GetCampaignVersionsCommandOutput) => void - ): Promise | void { - const command = new GetCampaignVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the history and status of each channel for an application.

+ * @see {@link GetChannelsCommand} */ - public getChannels(args: GetChannelsCommandInput, options?: __HttpHandlerOptions): Promise; - public getChannels(args: GetChannelsCommandInput, cb: (err: any, data?: GetChannelsCommandOutput) => void): void; - public getChannels( + getChannels(args: GetChannelsCommandInput, options?: __HttpHandlerOptions): Promise; + getChannels(args: GetChannelsCommandInput, cb: (err: any, data?: GetChannelsCommandOutput) => void): void; + getChannels( args: GetChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelsCommandOutput) => void ): void; - public getChannels( - args: GetChannelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetChannelsCommandOutput) => void), - cb?: (err: any, data?: GetChannelsCommandOutput) => void - ): Promise | void { - const command = new GetChannelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status and settings of the email channel for an application.

+ * @see {@link GetEmailChannelCommand} */ - public getEmailChannel( + getEmailChannel( args: GetEmailChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEmailChannel( - args: GetEmailChannelCommandInput, - cb: (err: any, data?: GetEmailChannelCommandOutput) => void - ): void; - public getEmailChannel( + getEmailChannel(args: GetEmailChannelCommandInput, cb: (err: any, data?: GetEmailChannelCommandOutput) => void): void; + getEmailChannel( args: GetEmailChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEmailChannelCommandOutput) => void ): void; - public getEmailChannel( - args: GetEmailChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEmailChannelCommandOutput) => void), - cb?: (err: any, data?: GetEmailChannelCommandOutput) => void - ): Promise | void { - const command = new GetEmailChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the content and settings of a message template for messages that are sent through the email channel.

+ * @see {@link GetEmailTemplateCommand} */ - public getEmailTemplate( + getEmailTemplate( args: GetEmailTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEmailTemplate( + getEmailTemplate( args: GetEmailTemplateCommandInput, cb: (err: any, data?: GetEmailTemplateCommandOutput) => void ): void; - public getEmailTemplate( + getEmailTemplate( args: GetEmailTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEmailTemplateCommandOutput) => void ): void; - public getEmailTemplate( - args: GetEmailTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEmailTemplateCommandOutput) => void), - cb?: (err: any, data?: GetEmailTemplateCommandOutput) => void - ): Promise | void { - const command = new GetEmailTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the settings and attributes of a specific endpoint for an application.

+ * @see {@link GetEndpointCommand} */ - public getEndpoint(args: GetEndpointCommandInput, options?: __HttpHandlerOptions): Promise; - public getEndpoint(args: GetEndpointCommandInput, cb: (err: any, data?: GetEndpointCommandOutput) => void): void; - public getEndpoint( + getEndpoint(args: GetEndpointCommandInput, options?: __HttpHandlerOptions): Promise; + getEndpoint(args: GetEndpointCommandInput, cb: (err: any, data?: GetEndpointCommandOutput) => void): void; + getEndpoint( args: GetEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEndpointCommandOutput) => void ): void; - public getEndpoint( - args: GetEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEndpointCommandOutput) => void), - cb?: (err: any, data?: GetEndpointCommandOutput) => void - ): Promise | void { - const command = new GetEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the event stream settings for an application.

+ * @see {@link GetEventStreamCommand} */ - public getEventStream( + getEventStream( args: GetEventStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEventStream( - args: GetEventStreamCommandInput, - cb: (err: any, data?: GetEventStreamCommandOutput) => void - ): void; - public getEventStream( + getEventStream(args: GetEventStreamCommandInput, cb: (err: any, data?: GetEventStreamCommandOutput) => void): void; + getEventStream( args: GetEventStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEventStreamCommandOutput) => void ): void; - public getEventStream( - args: GetEventStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEventStreamCommandOutput) => void), - cb?: (err: any, data?: GetEventStreamCommandOutput) => void - ): Promise | void { - const command = new GetEventStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status and settings of a specific export job for an application.

+ * @see {@link GetExportJobCommand} */ - public getExportJob( - args: GetExportJobCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getExportJob(args: GetExportJobCommandInput, cb: (err: any, data?: GetExportJobCommandOutput) => void): void; - public getExportJob( + getExportJob(args: GetExportJobCommandInput, options?: __HttpHandlerOptions): Promise; + getExportJob(args: GetExportJobCommandInput, cb: (err: any, data?: GetExportJobCommandOutput) => void): void; + getExportJob( args: GetExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExportJobCommandOutput) => void ): void; - public getExportJob( - args: GetExportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetExportJobCommandOutput) => void), - cb?: (err: any, data?: GetExportJobCommandOutput) => void - ): Promise | void { - const command = new GetExportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status and settings of all the export jobs for an application.

+ * @see {@link GetExportJobsCommand} */ - public getExportJobs( - args: GetExportJobsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getExportJobs( - args: GetExportJobsCommandInput, - cb: (err: any, data?: GetExportJobsCommandOutput) => void - ): void; - public getExportJobs( + getExportJobs(args: GetExportJobsCommandInput, options?: __HttpHandlerOptions): Promise; + getExportJobs(args: GetExportJobsCommandInput, cb: (err: any, data?: GetExportJobsCommandOutput) => void): void; + getExportJobs( args: GetExportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExportJobsCommandOutput) => void ): void; - public getExportJobs( - args: GetExportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetExportJobsCommandOutput) => void), - cb?: (err: any, data?: GetExportJobsCommandOutput) => void - ): Promise | void { - const command = new GetExportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status and settings of the GCM channel for an application.

+ * @see {@link GetGcmChannelCommand} */ - public getGcmChannel( - args: GetGcmChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getGcmChannel( - args: GetGcmChannelCommandInput, - cb: (err: any, data?: GetGcmChannelCommandOutput) => void - ): void; - public getGcmChannel( + getGcmChannel(args: GetGcmChannelCommandInput, options?: __HttpHandlerOptions): Promise; + getGcmChannel(args: GetGcmChannelCommandInput, cb: (err: any, data?: GetGcmChannelCommandOutput) => void): void; + getGcmChannel( args: GetGcmChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGcmChannelCommandOutput) => void ): void; - public getGcmChannel( - args: GetGcmChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGcmChannelCommandOutput) => void), - cb?: (err: any, data?: GetGcmChannelCommandOutput) => void - ): Promise | void { - const command = new GetGcmChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status and settings of a specific import job for an application.

+ * @see {@link GetImportJobCommand} */ - public getImportJob( - args: GetImportJobCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getImportJob(args: GetImportJobCommandInput, cb: (err: any, data?: GetImportJobCommandOutput) => void): void; - public getImportJob( + getImportJob(args: GetImportJobCommandInput, options?: __HttpHandlerOptions): Promise; + getImportJob(args: GetImportJobCommandInput, cb: (err: any, data?: GetImportJobCommandOutput) => void): void; + getImportJob( args: GetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetImportJobCommandOutput) => void ): void; - public getImportJob( - args: GetImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetImportJobCommandOutput) => void), - cb?: (err: any, data?: GetImportJobCommandOutput) => void - ): Promise | void { - const command = new GetImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status and settings of all the import jobs for an application.

+ * @see {@link GetImportJobsCommand} */ - public getImportJobs( - args: GetImportJobsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getImportJobs( - args: GetImportJobsCommandInput, - cb: (err: any, data?: GetImportJobsCommandOutput) => void - ): void; - public getImportJobs( + getImportJobs(args: GetImportJobsCommandInput, options?: __HttpHandlerOptions): Promise; + getImportJobs(args: GetImportJobsCommandInput, cb: (err: any, data?: GetImportJobsCommandOutput) => void): void; + getImportJobs( args: GetImportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetImportJobsCommandOutput) => void ): void; - public getImportJobs( - args: GetImportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetImportJobsCommandOutput) => void), - cb?: (err: any, data?: GetImportJobsCommandOutput) => void - ): Promise | void { - const command = new GetImportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the in-app messages targeted for the provided endpoint ID.

+ * @see {@link GetInAppMessagesCommand} */ - public getInAppMessages( + getInAppMessages( args: GetInAppMessagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInAppMessages( + getInAppMessages( args: GetInAppMessagesCommandInput, cb: (err: any, data?: GetInAppMessagesCommandOutput) => void ): void; - public getInAppMessages( + getInAppMessages( args: GetInAppMessagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInAppMessagesCommandOutput) => void ): void; - public getInAppMessages( - args: GetInAppMessagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInAppMessagesCommandOutput) => void), - cb?: (err: any, data?: GetInAppMessagesCommandOutput) => void - ): Promise | void { - const command = new GetInAppMessagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the content and settings of a message template for messages sent through the in-app channel.

+ * @see {@link GetInAppTemplateCommand} */ - public getInAppTemplate( + getInAppTemplate( args: GetInAppTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInAppTemplate( + getInAppTemplate( args: GetInAppTemplateCommandInput, cb: (err: any, data?: GetInAppTemplateCommandOutput) => void ): void; - public getInAppTemplate( + getInAppTemplate( args: GetInAppTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInAppTemplateCommandOutput) => void ): void; - public getInAppTemplate( - args: GetInAppTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInAppTemplateCommandOutput) => void), - cb?: (err: any, data?: GetInAppTemplateCommandOutput) => void - ): Promise | void { - const command = new GetInAppTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status, configuration, and other settings for a journey.

+ * @see {@link GetJourneyCommand} */ - public getJourney(args: GetJourneyCommandInput, options?: __HttpHandlerOptions): Promise; - public getJourney(args: GetJourneyCommandInput, cb: (err: any, data?: GetJourneyCommandOutput) => void): void; - public getJourney( + getJourney(args: GetJourneyCommandInput, options?: __HttpHandlerOptions): Promise; + getJourney(args: GetJourneyCommandInput, cb: (err: any, data?: GetJourneyCommandOutput) => void): void; + getJourney( args: GetJourneyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJourneyCommandOutput) => void ): void; - public getJourney( - args: GetJourneyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetJourneyCommandOutput) => void), - cb?: (err: any, data?: GetJourneyCommandOutput) => void - ): Promise | void { - const command = new GetJourneyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.

+ * @see {@link GetJourneyDateRangeKpiCommand} */ - public getJourneyDateRangeKpi( + getJourneyDateRangeKpi( args: GetJourneyDateRangeKpiCommandInput, options?: __HttpHandlerOptions ): Promise; - public getJourneyDateRangeKpi( + getJourneyDateRangeKpi( args: GetJourneyDateRangeKpiCommandInput, cb: (err: any, data?: GetJourneyDateRangeKpiCommandOutput) => void ): void; - public getJourneyDateRangeKpi( + getJourneyDateRangeKpi( args: GetJourneyDateRangeKpiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJourneyDateRangeKpiCommandOutput) => void ): void; - public getJourneyDateRangeKpi( - args: GetJourneyDateRangeKpiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetJourneyDateRangeKpiCommandOutput) => void), - cb?: (err: any, data?: GetJourneyDateRangeKpiCommandOutput) => void - ): Promise | void { - const command = new GetJourneyDateRangeKpiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.

+ * @see {@link GetJourneyExecutionActivityMetricsCommand} */ - public getJourneyExecutionActivityMetrics( + getJourneyExecutionActivityMetrics( args: GetJourneyExecutionActivityMetricsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getJourneyExecutionActivityMetrics( + getJourneyExecutionActivityMetrics( args: GetJourneyExecutionActivityMetricsCommandInput, cb: (err: any, data?: GetJourneyExecutionActivityMetricsCommandOutput) => void ): void; - public getJourneyExecutionActivityMetrics( + getJourneyExecutionActivityMetrics( args: GetJourneyExecutionActivityMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJourneyExecutionActivityMetricsCommandOutput) => void ): void; - public getJourneyExecutionActivityMetrics( - args: GetJourneyExecutionActivityMetricsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetJourneyExecutionActivityMetricsCommandOutput) => void), - cb?: (err: any, data?: GetJourneyExecutionActivityMetricsCommandOutput) => void - ): Promise | void { - const command = new GetJourneyExecutionActivityMetricsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.

+ * @see {@link GetJourneyExecutionMetricsCommand} */ - public getJourneyExecutionMetrics( + getJourneyExecutionMetrics( args: GetJourneyExecutionMetricsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getJourneyExecutionMetrics( + getJourneyExecutionMetrics( args: GetJourneyExecutionMetricsCommandInput, cb: (err: any, data?: GetJourneyExecutionMetricsCommandOutput) => void ): void; - public getJourneyExecutionMetrics( + getJourneyExecutionMetrics( args: GetJourneyExecutionMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJourneyExecutionMetricsCommandOutput) => void ): void; - public getJourneyExecutionMetrics( - args: GetJourneyExecutionMetricsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetJourneyExecutionMetricsCommandOutput) => void), - cb?: (err: any, data?: GetJourneyExecutionMetricsCommandOutput) => void - ): Promise | void { - const command = new GetJourneyExecutionMetricsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the content and settings of a message template for messages that are sent through a push notification channel.

+ * @see {@link GetPushTemplateCommand} */ - public getPushTemplate( + getPushTemplate( args: GetPushTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPushTemplate( - args: GetPushTemplateCommandInput, - cb: (err: any, data?: GetPushTemplateCommandOutput) => void - ): void; - public getPushTemplate( + getPushTemplate(args: GetPushTemplateCommandInput, cb: (err: any, data?: GetPushTemplateCommandOutput) => void): void; + getPushTemplate( args: GetPushTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPushTemplateCommandOutput) => void ): void; - public getPushTemplate( - args: GetPushTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPushTemplateCommandOutput) => void), - cb?: (err: any, data?: GetPushTemplateCommandOutput) => void - ): Promise | void { - const command = new GetPushTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about an Amazon Pinpoint configuration for a recommender model.

+ * @see {@link GetRecommenderConfigurationCommand} */ - public getRecommenderConfiguration( + getRecommenderConfiguration( args: GetRecommenderConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRecommenderConfiguration( + getRecommenderConfiguration( args: GetRecommenderConfigurationCommandInput, cb: (err: any, data?: GetRecommenderConfigurationCommandOutput) => void ): void; - public getRecommenderConfiguration( + getRecommenderConfiguration( args: GetRecommenderConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRecommenderConfigurationCommandOutput) => void ): void; - public getRecommenderConfiguration( - args: GetRecommenderConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRecommenderConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetRecommenderConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetRecommenderConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.

+ * @see {@link GetRecommenderConfigurationsCommand} */ - public getRecommenderConfigurations( + getRecommenderConfigurations( args: GetRecommenderConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRecommenderConfigurations( + getRecommenderConfigurations( args: GetRecommenderConfigurationsCommandInput, cb: (err: any, data?: GetRecommenderConfigurationsCommandOutput) => void ): void; - public getRecommenderConfigurations( + getRecommenderConfigurations( args: GetRecommenderConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRecommenderConfigurationsCommandOutput) => void ): void; - public getRecommenderConfigurations( - args: GetRecommenderConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRecommenderConfigurationsCommandOutput) => void), - cb?: (err: any, data?: GetRecommenderConfigurationsCommandOutput) => void - ): Promise | void { - const command = new GetRecommenderConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.

+ * @see {@link GetSegmentCommand} */ - public getSegment(args: GetSegmentCommandInput, options?: __HttpHandlerOptions): Promise; - public getSegment(args: GetSegmentCommandInput, cb: (err: any, data?: GetSegmentCommandOutput) => void): void; - public getSegment( + getSegment(args: GetSegmentCommandInput, options?: __HttpHandlerOptions): Promise; + getSegment(args: GetSegmentCommandInput, cb: (err: any, data?: GetSegmentCommandOutput) => void): void; + getSegment( args: GetSegmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSegmentCommandOutput) => void ): void; - public getSegment( - args: GetSegmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSegmentCommandOutput) => void), - cb?: (err: any, data?: GetSegmentCommandOutput) => void - ): Promise | void { - const command = new GetSegmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status and settings of the export jobs for a segment.

+ * @see {@link GetSegmentExportJobsCommand} */ - public getSegmentExportJobs( + getSegmentExportJobs( args: GetSegmentExportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSegmentExportJobs( + getSegmentExportJobs( args: GetSegmentExportJobsCommandInput, cb: (err: any, data?: GetSegmentExportJobsCommandOutput) => void ): void; - public getSegmentExportJobs( + getSegmentExportJobs( args: GetSegmentExportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSegmentExportJobsCommandOutput) => void ): void; - public getSegmentExportJobs( - args: GetSegmentExportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSegmentExportJobsCommandOutput) => void), - cb?: (err: any, data?: GetSegmentExportJobsCommandOutput) => void - ): Promise | void { - const command = new GetSegmentExportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status and settings of the import jobs for a segment.

+ * @see {@link GetSegmentImportJobsCommand} */ - public getSegmentImportJobs( + getSegmentImportJobs( args: GetSegmentImportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSegmentImportJobs( + getSegmentImportJobs( args: GetSegmentImportJobsCommandInput, cb: (err: any, data?: GetSegmentImportJobsCommandOutput) => void ): void; - public getSegmentImportJobs( + getSegmentImportJobs( args: GetSegmentImportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSegmentImportJobsCommandOutput) => void ): void; - public getSegmentImportJobs( - args: GetSegmentImportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSegmentImportJobsCommandOutput) => void), - cb?: (err: any, data?: GetSegmentImportJobsCommandOutput) => void - ): Promise | void { - const command = new GetSegmentImportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.

+ * @see {@link GetSegmentsCommand} */ - public getSegments(args: GetSegmentsCommandInput, options?: __HttpHandlerOptions): Promise; - public getSegments(args: GetSegmentsCommandInput, cb: (err: any, data?: GetSegmentsCommandOutput) => void): void; - public getSegments( + getSegments(args: GetSegmentsCommandInput, options?: __HttpHandlerOptions): Promise; + getSegments(args: GetSegmentsCommandInput, cb: (err: any, data?: GetSegmentsCommandOutput) => void): void; + getSegments( args: GetSegmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSegmentsCommandOutput) => void ): void; - public getSegments( - args: GetSegmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSegmentsCommandOutput) => void), - cb?: (err: any, data?: GetSegmentsCommandOutput) => void - ): Promise | void { - const command = new GetSegmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.

+ * @see {@link GetSegmentVersionCommand} */ - public getSegmentVersion( + getSegmentVersion( args: GetSegmentVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSegmentVersion( + getSegmentVersion( args: GetSegmentVersionCommandInput, cb: (err: any, data?: GetSegmentVersionCommandOutput) => void ): void; - public getSegmentVersion( + getSegmentVersion( args: GetSegmentVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSegmentVersionCommandOutput) => void ): void; - public getSegmentVersion( - args: GetSegmentVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSegmentVersionCommandOutput) => void), - cb?: (err: any, data?: GetSegmentVersionCommandOutput) => void - ): Promise | void { - const command = new GetSegmentVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.

+ * @see {@link GetSegmentVersionsCommand} */ - public getSegmentVersions( + getSegmentVersions( args: GetSegmentVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSegmentVersions( + getSegmentVersions( args: GetSegmentVersionsCommandInput, cb: (err: any, data?: GetSegmentVersionsCommandOutput) => void ): void; - public getSegmentVersions( + getSegmentVersions( args: GetSegmentVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSegmentVersionsCommandOutput) => void ): void; - public getSegmentVersions( - args: GetSegmentVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSegmentVersionsCommandOutput) => void), - cb?: (err: any, data?: GetSegmentVersionsCommandOutput) => void - ): Promise | void { - const command = new GetSegmentVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status and settings of the SMS channel for an application.

+ * @see {@link GetSmsChannelCommand} */ - public getSmsChannel( - args: GetSmsChannelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getSmsChannel( - args: GetSmsChannelCommandInput, - cb: (err: any, data?: GetSmsChannelCommandOutput) => void - ): void; - public getSmsChannel( + getSmsChannel(args: GetSmsChannelCommandInput, options?: __HttpHandlerOptions): Promise; + getSmsChannel(args: GetSmsChannelCommandInput, cb: (err: any, data?: GetSmsChannelCommandOutput) => void): void; + getSmsChannel( args: GetSmsChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSmsChannelCommandOutput) => void ): void; - public getSmsChannel( - args: GetSmsChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSmsChannelCommandOutput) => void), - cb?: (err: any, data?: GetSmsChannelCommandOutput) => void - ): Promise | void { - const command = new GetSmsChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the content and settings of a message template for messages that are sent through the SMS channel.

+ * @see {@link GetSmsTemplateCommand} */ - public getSmsTemplate( + getSmsTemplate( args: GetSmsTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSmsTemplate( - args: GetSmsTemplateCommandInput, - cb: (err: any, data?: GetSmsTemplateCommandOutput) => void - ): void; - public getSmsTemplate( + getSmsTemplate(args: GetSmsTemplateCommandInput, cb: (err: any, data?: GetSmsTemplateCommandOutput) => void): void; + getSmsTemplate( args: GetSmsTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSmsTemplateCommandOutput) => void ): void; - public getSmsTemplate( - args: GetSmsTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSmsTemplateCommandOutput) => void), - cb?: (err: any, data?: GetSmsTemplateCommandOutput) => void - ): Promise | void { - const command = new GetSmsTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about all the endpoints that are associated with a specific user ID.

+ * @see {@link GetUserEndpointsCommand} */ - public getUserEndpoints( + getUserEndpoints( args: GetUserEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUserEndpoints( + getUserEndpoints( args: GetUserEndpointsCommandInput, cb: (err: any, data?: GetUserEndpointsCommandOutput) => void ): void; - public getUserEndpoints( + getUserEndpoints( args: GetUserEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserEndpointsCommandOutput) => void ): void; - public getUserEndpoints( - args: GetUserEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUserEndpointsCommandOutput) => void), - cb?: (err: any, data?: GetUserEndpointsCommandOutput) => void - ): Promise | void { - const command = new GetUserEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status and settings of the voice channel for an application.

+ * @see {@link GetVoiceChannelCommand} */ - public getVoiceChannel( + getVoiceChannel( args: GetVoiceChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVoiceChannel( - args: GetVoiceChannelCommandInput, - cb: (err: any, data?: GetVoiceChannelCommandOutput) => void - ): void; - public getVoiceChannel( + getVoiceChannel(args: GetVoiceChannelCommandInput, cb: (err: any, data?: GetVoiceChannelCommandOutput) => void): void; + getVoiceChannel( args: GetVoiceChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceChannelCommandOutput) => void ): void; - public getVoiceChannel( - args: GetVoiceChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVoiceChannelCommandOutput) => void), - cb?: (err: any, data?: GetVoiceChannelCommandOutput) => void - ): Promise | void { - const command = new GetVoiceChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the content and settings of a message template for messages that are sent through the voice channel.

+ * @see {@link GetVoiceTemplateCommand} */ - public getVoiceTemplate( + getVoiceTemplate( args: GetVoiceTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVoiceTemplate( + getVoiceTemplate( args: GetVoiceTemplateCommandInput, cb: (err: any, data?: GetVoiceTemplateCommandOutput) => void ): void; - public getVoiceTemplate( + getVoiceTemplate( args: GetVoiceTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceTemplateCommandOutput) => void ): void; - public getVoiceTemplate( - args: GetVoiceTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVoiceTemplateCommandOutput) => void), - cb?: (err: any, data?: GetVoiceTemplateCommandOutput) => void - ): Promise | void { - const command = new GetVoiceTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.

+ * @see {@link ListJourneysCommand} */ - public listJourneys( - args: ListJourneysCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listJourneys(args: ListJourneysCommandInput, cb: (err: any, data?: ListJourneysCommandOutput) => void): void; - public listJourneys( + listJourneys(args: ListJourneysCommandInput, options?: __HttpHandlerOptions): Promise; + listJourneys(args: ListJourneysCommandInput, cb: (err: any, data?: ListJourneysCommandOutput) => void): void; + listJourneys( args: ListJourneysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJourneysCommandOutput) => void ): void; - public listJourneys( - args: ListJourneysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJourneysCommandOutput) => void), - cb?: (err: any, data?: ListJourneysCommandOutput) => void - ): Promise | void { - const command = new ListJourneysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.

+ * @see {@link ListTemplatesCommand} */ - public listTemplates( - args: ListTemplatesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listTemplates( - args: ListTemplatesCommandInput, - cb: (err: any, data?: ListTemplatesCommandOutput) => void - ): void; - public listTemplates( + listTemplates(args: ListTemplatesCommandInput, options?: __HttpHandlerOptions): Promise; + listTemplates(args: ListTemplatesCommandInput, cb: (err: any, data?: ListTemplatesCommandOutput) => void): void; + listTemplates( args: ListTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTemplatesCommandOutput) => void ): void; - public listTemplates( - args: ListTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about all the versions of a specific message template.

+ * @see {@link ListTemplateVersionsCommand} */ - public listTemplateVersions( + listTemplateVersions( args: ListTemplateVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTemplateVersions( + listTemplateVersions( args: ListTemplateVersionsCommandInput, cb: (err: any, data?: ListTemplateVersionsCommandOutput) => void ): void; - public listTemplateVersions( + listTemplateVersions( args: ListTemplateVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTemplateVersionsCommandOutput) => void ): void; - public listTemplateVersions( - args: ListTemplateVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTemplateVersionsCommandOutput) => void), - cb?: (err: any, data?: ListTemplateVersionsCommandOutput) => void - ): Promise | void { - const command = new ListTemplateVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a phone number.

+ * @see {@link PhoneNumberValidateCommand} */ - public phoneNumberValidate( + phoneNumberValidate( args: PhoneNumberValidateCommandInput, options?: __HttpHandlerOptions ): Promise; - public phoneNumberValidate( + phoneNumberValidate( args: PhoneNumberValidateCommandInput, cb: (err: any, data?: PhoneNumberValidateCommandOutput) => void ): void; - public phoneNumberValidate( + phoneNumberValidate( args: PhoneNumberValidateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PhoneNumberValidateCommandOutput) => void ): void; - public phoneNumberValidate( - args: PhoneNumberValidateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PhoneNumberValidateCommandOutput) => void), - cb?: (err: any, data?: PhoneNumberValidateCommandOutput) => void - ): Promise | void { - const command = new PhoneNumberValidateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.

+ * @see {@link PutEventsCommand} */ - public putEvents(args: PutEventsCommandInput, options?: __HttpHandlerOptions): Promise; - public putEvents(args: PutEventsCommandInput, cb: (err: any, data?: PutEventsCommandOutput) => void): void; - public putEvents( + putEvents(args: PutEventsCommandInput, options?: __HttpHandlerOptions): Promise; + putEvents(args: PutEventsCommandInput, cb: (err: any, data?: PutEventsCommandOutput) => void): void; + putEvents( args: PutEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEventsCommandOutput) => void ): void; - public putEvents( - args: PutEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutEventsCommandOutput) => void), - cb?: (err: any, data?: PutEventsCommandOutput) => void - ): Promise | void { - const command = new PutEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new event stream for an application or updates the settings of an existing event stream for an application.

+ * @see {@link PutEventStreamCommand} */ - public putEventStream( + putEventStream( args: PutEventStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public putEventStream( - args: PutEventStreamCommandInput, - cb: (err: any, data?: PutEventStreamCommandOutput) => void - ): void; - public putEventStream( + putEventStream(args: PutEventStreamCommandInput, cb: (err: any, data?: PutEventStreamCommandOutput) => void): void; + putEventStream( args: PutEventStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEventStreamCommandOutput) => void ): void; - public putEventStream( - args: PutEventStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutEventStreamCommandOutput) => void), - cb?: (err: any, data?: PutEventStreamCommandOutput) => void - ): Promise | void { - const command = new PutEventStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.

+ * @see {@link RemoveAttributesCommand} */ - public removeAttributes( + removeAttributes( args: RemoveAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeAttributes( + removeAttributes( args: RemoveAttributesCommandInput, cb: (err: any, data?: RemoveAttributesCommandOutput) => void ): void; - public removeAttributes( + removeAttributes( args: RemoveAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveAttributesCommandOutput) => void ): void; - public removeAttributes( - args: RemoveAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveAttributesCommandOutput) => void), - cb?: (err: any, data?: RemoveAttributesCommandOutput) => void - ): Promise | void { - const command = new RemoveAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates and sends a direct message.

+ * @see {@link SendMessagesCommand} */ - public sendMessages( - args: SendMessagesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public sendMessages(args: SendMessagesCommandInput, cb: (err: any, data?: SendMessagesCommandOutput) => void): void; - public sendMessages( + sendMessages(args: SendMessagesCommandInput, options?: __HttpHandlerOptions): Promise; + sendMessages(args: SendMessagesCommandInput, cb: (err: any, data?: SendMessagesCommandOutput) => void): void; + sendMessages( args: SendMessagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendMessagesCommandOutput) => void ): void; - public sendMessages( - args: SendMessagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendMessagesCommandOutput) => void), - cb?: (err: any, data?: SendMessagesCommandOutput) => void - ): Promise | void { - const command = new SendMessagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Send an OTP message

+ * @see {@link SendOTPMessageCommand} */ - public sendOTPMessage( + sendOTPMessage( args: SendOTPMessageCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendOTPMessage( - args: SendOTPMessageCommandInput, - cb: (err: any, data?: SendOTPMessageCommandOutput) => void - ): void; - public sendOTPMessage( + sendOTPMessage(args: SendOTPMessageCommandInput, cb: (err: any, data?: SendOTPMessageCommandOutput) => void): void; + sendOTPMessage( args: SendOTPMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendOTPMessageCommandOutput) => void ): void; - public sendOTPMessage( - args: SendOTPMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendOTPMessageCommandOutput) => void), - cb?: (err: any, data?: SendOTPMessageCommandOutput) => void - ): Promise | void { - const command = new SendOTPMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates and sends a message to a list of users.

+ * @see {@link SendUsersMessagesCommand} */ - public sendUsersMessages( + sendUsersMessages( args: SendUsersMessagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendUsersMessages( + sendUsersMessages( args: SendUsersMessagesCommandInput, cb: (err: any, data?: SendUsersMessagesCommandOutput) => void ): void; - public sendUsersMessages( + sendUsersMessages( args: SendUsersMessagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendUsersMessagesCommandOutput) => void ): void; - public sendUsersMessages( - args: SendUsersMessagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendUsersMessagesCommandOutput) => void), - cb?: (err: any, data?: SendUsersMessagesCommandOutput) => void - ): Promise | void { - const command = new SendUsersMessagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more tags (keys and values) to an application, campaign, message template, or segment.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags (keys and values) from an application, campaign, message template, or segment.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.

+ * @see {@link UpdateAdmChannelCommand} */ - public updateAdmChannel( + updateAdmChannel( args: UpdateAdmChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAdmChannel( + updateAdmChannel( args: UpdateAdmChannelCommandInput, cb: (err: any, data?: UpdateAdmChannelCommandOutput) => void ): void; - public updateAdmChannel( + updateAdmChannel( args: UpdateAdmChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAdmChannelCommandOutput) => void ): void; - public updateAdmChannel( - args: UpdateAdmChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAdmChannelCommandOutput) => void), - cb?: (err: any, data?: UpdateAdmChannelCommandOutput) => void - ): Promise | void { - const command = new UpdateAdmChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.

+ * @see {@link UpdateApnsChannelCommand} */ - public updateApnsChannel( + updateApnsChannel( args: UpdateApnsChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApnsChannel( + updateApnsChannel( args: UpdateApnsChannelCommandInput, cb: (err: any, data?: UpdateApnsChannelCommandOutput) => void ): void; - public updateApnsChannel( + updateApnsChannel( args: UpdateApnsChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApnsChannelCommandOutput) => void ): void; - public updateApnsChannel( - args: UpdateApnsChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApnsChannelCommandOutput) => void), - cb?: (err: any, data?: UpdateApnsChannelCommandOutput) => void - ): Promise | void { - const command = new UpdateApnsChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.

+ * @see {@link UpdateApnsSandboxChannelCommand} */ - public updateApnsSandboxChannel( + updateApnsSandboxChannel( args: UpdateApnsSandboxChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApnsSandboxChannel( + updateApnsSandboxChannel( args: UpdateApnsSandboxChannelCommandInput, cb: (err: any, data?: UpdateApnsSandboxChannelCommandOutput) => void ): void; - public updateApnsSandboxChannel( + updateApnsSandboxChannel( args: UpdateApnsSandboxChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApnsSandboxChannelCommandOutput) => void ): void; - public updateApnsSandboxChannel( - args: UpdateApnsSandboxChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApnsSandboxChannelCommandOutput) => void), - cb?: (err: any, data?: UpdateApnsSandboxChannelCommandOutput) => void - ): Promise | void { - const command = new UpdateApnsSandboxChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.

+ * @see {@link UpdateApnsVoipChannelCommand} */ - public updateApnsVoipChannel( + updateApnsVoipChannel( args: UpdateApnsVoipChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApnsVoipChannel( + updateApnsVoipChannel( args: UpdateApnsVoipChannelCommandInput, cb: (err: any, data?: UpdateApnsVoipChannelCommandOutput) => void ): void; - public updateApnsVoipChannel( + updateApnsVoipChannel( args: UpdateApnsVoipChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApnsVoipChannelCommandOutput) => void ): void; - public updateApnsVoipChannel( - args: UpdateApnsVoipChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApnsVoipChannelCommandOutput) => void), - cb?: (err: any, data?: UpdateApnsVoipChannelCommandOutput) => void - ): Promise | void { - const command = new UpdateApnsVoipChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.

+ * @see {@link UpdateApnsVoipSandboxChannelCommand} */ - public updateApnsVoipSandboxChannel( + updateApnsVoipSandboxChannel( args: UpdateApnsVoipSandboxChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApnsVoipSandboxChannel( + updateApnsVoipSandboxChannel( args: UpdateApnsVoipSandboxChannelCommandInput, cb: (err: any, data?: UpdateApnsVoipSandboxChannelCommandOutput) => void ): void; - public updateApnsVoipSandboxChannel( + updateApnsVoipSandboxChannel( args: UpdateApnsVoipSandboxChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApnsVoipSandboxChannelCommandOutput) => void ): void; - public updateApnsVoipSandboxChannel( - args: UpdateApnsVoipSandboxChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApnsVoipSandboxChannelCommandOutput) => void), - cb?: (err: any, data?: UpdateApnsVoipSandboxChannelCommandOutput) => void - ): Promise | void { - const command = new UpdateApnsVoipSandboxChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the settings for an application.

+ * @see {@link UpdateApplicationSettingsCommand} */ - public updateApplicationSettings( + updateApplicationSettings( args: UpdateApplicationSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApplicationSettings( + updateApplicationSettings( args: UpdateApplicationSettingsCommandInput, cb: (err: any, data?: UpdateApplicationSettingsCommandOutput) => void ): void; - public updateApplicationSettings( + updateApplicationSettings( args: UpdateApplicationSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationSettingsCommandOutput) => void ): void; - public updateApplicationSettings( - args: UpdateApplicationSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApplicationSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateApplicationSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateApplicationSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.

+ * @see {@link UpdateBaiduChannelCommand} */ - public updateBaiduChannel( + updateBaiduChannel( args: UpdateBaiduChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBaiduChannel( + updateBaiduChannel( args: UpdateBaiduChannelCommandInput, cb: (err: any, data?: UpdateBaiduChannelCommandOutput) => void ): void; - public updateBaiduChannel( + updateBaiduChannel( args: UpdateBaiduChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBaiduChannelCommandOutput) => void ): void; - public updateBaiduChannel( - args: UpdateBaiduChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBaiduChannelCommandOutput) => void), - cb?: (err: any, data?: UpdateBaiduChannelCommandOutput) => void - ): Promise | void { - const command = new UpdateBaiduChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the configuration and other settings for a campaign.

+ * @see {@link UpdateCampaignCommand} */ - public updateCampaign( + updateCampaign( args: UpdateCampaignCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCampaign( - args: UpdateCampaignCommandInput, - cb: (err: any, data?: UpdateCampaignCommandOutput) => void - ): void; - public updateCampaign( + updateCampaign(args: UpdateCampaignCommandInput, cb: (err: any, data?: UpdateCampaignCommandOutput) => void): void; + updateCampaign( args: UpdateCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCampaignCommandOutput) => void ): void; - public updateCampaign( - args: UpdateCampaignCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCampaignCommandOutput) => void), - cb?: (err: any, data?: UpdateCampaignCommandOutput) => void - ): Promise | void { - const command = new UpdateCampaignCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the email channel for an application or updates the status and settings of the email channel for an application.

+ * @see {@link UpdateEmailChannelCommand} */ - public updateEmailChannel( + updateEmailChannel( args: UpdateEmailChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEmailChannel( + updateEmailChannel( args: UpdateEmailChannelCommandInput, cb: (err: any, data?: UpdateEmailChannelCommandOutput) => void ): void; - public updateEmailChannel( + updateEmailChannel( args: UpdateEmailChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEmailChannelCommandOutput) => void ): void; - public updateEmailChannel( - args: UpdateEmailChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEmailChannelCommandOutput) => void), - cb?: (err: any, data?: UpdateEmailChannelCommandOutput) => void - ): Promise | void { - const command = new UpdateEmailChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing message template for messages that are sent through the email channel.

+ * @see {@link UpdateEmailTemplateCommand} */ - public updateEmailTemplate( + updateEmailTemplate( args: UpdateEmailTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEmailTemplate( + updateEmailTemplate( args: UpdateEmailTemplateCommandInput, cb: (err: any, data?: UpdateEmailTemplateCommandOutput) => void ): void; - public updateEmailTemplate( + updateEmailTemplate( args: UpdateEmailTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEmailTemplateCommandOutput) => void ): void; - public updateEmailTemplate( - args: UpdateEmailTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEmailTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateEmailTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateEmailTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.

+ * @see {@link UpdateEndpointCommand} */ - public updateEndpoint( + updateEndpoint( args: UpdateEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEndpoint( - args: UpdateEndpointCommandInput, - cb: (err: any, data?: UpdateEndpointCommandOutput) => void - ): void; - public updateEndpoint( + updateEndpoint(args: UpdateEndpointCommandInput, cb: (err: any, data?: UpdateEndpointCommandOutput) => void): void; + updateEndpoint( args: UpdateEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEndpointCommandOutput) => void ): void; - public updateEndpoint( - args: UpdateEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEndpointCommandOutput) => void), - cb?: (err: any, data?: UpdateEndpointCommandOutput) => void - ): Promise | void { - const command = new UpdateEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.

+ * @see {@link UpdateEndpointsBatchCommand} */ - public updateEndpointsBatch( + updateEndpointsBatch( args: UpdateEndpointsBatchCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEndpointsBatch( + updateEndpointsBatch( args: UpdateEndpointsBatchCommandInput, cb: (err: any, data?: UpdateEndpointsBatchCommandOutput) => void ): void; - public updateEndpointsBatch( + updateEndpointsBatch( args: UpdateEndpointsBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEndpointsBatchCommandOutput) => void ): void; - public updateEndpointsBatch( - args: UpdateEndpointsBatchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEndpointsBatchCommandOutput) => void), - cb?: (err: any, data?: UpdateEndpointsBatchCommandOutput) => void - ): Promise | void { - const command = new UpdateEndpointsBatchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.

+ * @see {@link UpdateGcmChannelCommand} */ - public updateGcmChannel( + updateGcmChannel( args: UpdateGcmChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGcmChannel( + updateGcmChannel( args: UpdateGcmChannelCommandInput, cb: (err: any, data?: UpdateGcmChannelCommandOutput) => void ): void; - public updateGcmChannel( + updateGcmChannel( args: UpdateGcmChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGcmChannelCommandOutput) => void ): void; - public updateGcmChannel( - args: UpdateGcmChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGcmChannelCommandOutput) => void), - cb?: (err: any, data?: UpdateGcmChannelCommandOutput) => void - ): Promise | void { - const command = new UpdateGcmChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing message template for messages sent through the in-app message channel.

+ * @see {@link UpdateInAppTemplateCommand} */ - public updateInAppTemplate( + updateInAppTemplate( args: UpdateInAppTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateInAppTemplate( + updateInAppTemplate( args: UpdateInAppTemplateCommandInput, cb: (err: any, data?: UpdateInAppTemplateCommandOutput) => void ): void; - public updateInAppTemplate( + updateInAppTemplate( args: UpdateInAppTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateInAppTemplateCommandOutput) => void ): void; - public updateInAppTemplate( - args: UpdateInAppTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateInAppTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateInAppTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateInAppTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the configuration and other settings for a journey.

+ * @see {@link UpdateJourneyCommand} */ - public updateJourney( - args: UpdateJourneyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateJourney( - args: UpdateJourneyCommandInput, - cb: (err: any, data?: UpdateJourneyCommandOutput) => void - ): void; - public updateJourney( + updateJourney(args: UpdateJourneyCommandInput, options?: __HttpHandlerOptions): Promise; + updateJourney(args: UpdateJourneyCommandInput, cb: (err: any, data?: UpdateJourneyCommandOutput) => void): void; + updateJourney( args: UpdateJourneyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateJourneyCommandOutput) => void ): void; - public updateJourney( - args: UpdateJourneyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateJourneyCommandOutput) => void), - cb?: (err: any, data?: UpdateJourneyCommandOutput) => void - ): Promise | void { - const command = new UpdateJourneyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels (stops) an active journey.

+ * @see {@link UpdateJourneyStateCommand} */ - public updateJourneyState( + updateJourneyState( args: UpdateJourneyStateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateJourneyState( + updateJourneyState( args: UpdateJourneyStateCommandInput, cb: (err: any, data?: UpdateJourneyStateCommandOutput) => void ): void; - public updateJourneyState( + updateJourneyState( args: UpdateJourneyStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateJourneyStateCommandOutput) => void ): void; - public updateJourneyState( - args: UpdateJourneyStateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateJourneyStateCommandOutput) => void), - cb?: (err: any, data?: UpdateJourneyStateCommandOutput) => void - ): Promise | void { - const command = new UpdateJourneyStateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing message template for messages that are sent through a push notification channel.

+ * @see {@link UpdatePushTemplateCommand} */ - public updatePushTemplate( + updatePushTemplate( args: UpdatePushTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePushTemplate( + updatePushTemplate( args: UpdatePushTemplateCommandInput, cb: (err: any, data?: UpdatePushTemplateCommandOutput) => void ): void; - public updatePushTemplate( + updatePushTemplate( args: UpdatePushTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePushTemplateCommandOutput) => void ): void; - public updatePushTemplate( - args: UpdatePushTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePushTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdatePushTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdatePushTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an Amazon Pinpoint configuration for a recommender model.

+ * @see {@link UpdateRecommenderConfigurationCommand} */ - public updateRecommenderConfiguration( + updateRecommenderConfiguration( args: UpdateRecommenderConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRecommenderConfiguration( + updateRecommenderConfiguration( args: UpdateRecommenderConfigurationCommandInput, cb: (err: any, data?: UpdateRecommenderConfigurationCommandOutput) => void ): void; - public updateRecommenderConfiguration( + updateRecommenderConfiguration( args: UpdateRecommenderConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRecommenderConfigurationCommandOutput) => void ): void; - public updateRecommenderConfiguration( - args: UpdateRecommenderConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRecommenderConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateRecommenderConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateRecommenderConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

+ * @see {@link UpdateSegmentCommand} */ - public updateSegment( - args: UpdateSegmentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateSegment( - args: UpdateSegmentCommandInput, - cb: (err: any, data?: UpdateSegmentCommandOutput) => void - ): void; - public updateSegment( + updateSegment(args: UpdateSegmentCommandInput, options?: __HttpHandlerOptions): Promise; + updateSegment(args: UpdateSegmentCommandInput, cb: (err: any, data?: UpdateSegmentCommandOutput) => void): void; + updateSegment( args: UpdateSegmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSegmentCommandOutput) => void ): void; - public updateSegment( - args: UpdateSegmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSegmentCommandOutput) => void), - cb?: (err: any, data?: UpdateSegmentCommandOutput) => void - ): Promise | void { - const command = new UpdateSegmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.

+ * @see {@link UpdateSmsChannelCommand} */ - public updateSmsChannel( + updateSmsChannel( args: UpdateSmsChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSmsChannel( + updateSmsChannel( args: UpdateSmsChannelCommandInput, cb: (err: any, data?: UpdateSmsChannelCommandOutput) => void ): void; - public updateSmsChannel( + updateSmsChannel( args: UpdateSmsChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSmsChannelCommandOutput) => void ): void; - public updateSmsChannel( - args: UpdateSmsChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSmsChannelCommandOutput) => void), - cb?: (err: any, data?: UpdateSmsChannelCommandOutput) => void - ): Promise | void { - const command = new UpdateSmsChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing message template for messages that are sent through the SMS channel.

+ * @see {@link UpdateSmsTemplateCommand} */ - public updateSmsTemplate( + updateSmsTemplate( args: UpdateSmsTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSmsTemplate( + updateSmsTemplate( args: UpdateSmsTemplateCommandInput, cb: (err: any, data?: UpdateSmsTemplateCommandOutput) => void ): void; - public updateSmsTemplate( + updateSmsTemplate( args: UpdateSmsTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSmsTemplateCommandOutput) => void ): void; - public updateSmsTemplate( - args: UpdateSmsTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSmsTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateSmsTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateSmsTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes the status of a specific version of a message template to active.

+ * @see {@link UpdateTemplateActiveVersionCommand} */ - public updateTemplateActiveVersion( + updateTemplateActiveVersion( args: UpdateTemplateActiveVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTemplateActiveVersion( + updateTemplateActiveVersion( args: UpdateTemplateActiveVersionCommandInput, cb: (err: any, data?: UpdateTemplateActiveVersionCommandOutput) => void ): void; - public updateTemplateActiveVersion( + updateTemplateActiveVersion( args: UpdateTemplateActiveVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTemplateActiveVersionCommandOutput) => void ): void; - public updateTemplateActiveVersion( - args: UpdateTemplateActiveVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTemplateActiveVersionCommandOutput) => void), - cb?: (err: any, data?: UpdateTemplateActiveVersionCommandOutput) => void - ): Promise | void { - const command = new UpdateTemplateActiveVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the voice channel for an application or updates the status and settings of the voice channel for an application.

+ * @see {@link UpdateVoiceChannelCommand} */ - public updateVoiceChannel( + updateVoiceChannel( args: UpdateVoiceChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVoiceChannel( + updateVoiceChannel( args: UpdateVoiceChannelCommandInput, cb: (err: any, data?: UpdateVoiceChannelCommandOutput) => void ): void; - public updateVoiceChannel( + updateVoiceChannel( args: UpdateVoiceChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVoiceChannelCommandOutput) => void ): void; - public updateVoiceChannel( - args: UpdateVoiceChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVoiceChannelCommandOutput) => void), - cb?: (err: any, data?: UpdateVoiceChannelCommandOutput) => void - ): Promise | void { - const command = new UpdateVoiceChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing message template for messages that are sent through the voice channel.

+ * @see {@link UpdateVoiceTemplateCommand} */ - public updateVoiceTemplate( + updateVoiceTemplate( args: UpdateVoiceTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVoiceTemplate( + updateVoiceTemplate( args: UpdateVoiceTemplateCommandInput, cb: (err: any, data?: UpdateVoiceTemplateCommandOutput) => void ): void; - public updateVoiceTemplate( + updateVoiceTemplate( args: UpdateVoiceTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVoiceTemplateCommandOutput) => void ): void; - public updateVoiceTemplate( - args: UpdateVoiceTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVoiceTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateVoiceTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateVoiceTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Verify an OTP

+ * @see {@link VerifyOTPMessageCommand} */ - public verifyOTPMessage( + verifyOTPMessage( args: VerifyOTPMessageCommandInput, options?: __HttpHandlerOptions ): Promise; - public verifyOTPMessage( + verifyOTPMessage( args: VerifyOTPMessageCommandInput, cb: (err: any, data?: VerifyOTPMessageCommandOutput) => void ): void; - public verifyOTPMessage( + verifyOTPMessage( args: VerifyOTPMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifyOTPMessageCommandOutput) => void ): void; - public verifyOTPMessage( - args: VerifyOTPMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: VerifyOTPMessageCommandOutput) => void), - cb?: (err: any, data?: VerifyOTPMessageCommandOutput) => void - ): Promise | void { - const command = new VerifyOTPMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Doc Engage API - Amazon Pinpoint API

+ */ +export class Pinpoint extends PinpointClient implements Pinpoint {} +createAggregatedClient(commands, Pinpoint); diff --git a/clients/client-pipes/src/Pipes.ts b/clients/client-pipes/src/Pipes.ts index c2418e511a94..228d5e7ce2db 100644 --- a/clients/client-pipes/src/Pipes.ts +++ b/clients/client-pipes/src/Pipes.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { CreatePipeCommand, CreatePipeCommandInput, CreatePipeCommandOutput } from "./commands/CreatePipeCommand"; @@ -23,312 +24,144 @@ import { UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; import { UpdatePipeCommand, UpdatePipeCommandInput, UpdatePipeCommandOutput } from "./commands/UpdatePipeCommand"; -import { PipesClient } from "./PipesClient"; +import { PipesClient, PipesClientConfig } from "./PipesClient"; -/** - * @public - *

Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need for specialized knowledge and integration code when developing - * event driven architectures. This helps ensures consistency across your company’s applications. With Pipes, the target can be any available EventBridge target. - * To set up a pipe, you select the event source, add optional event filtering, define optional enrichment, and select the target for the event data.

- */ -export class Pipes extends PipesClient { +const commands = { + CreatePipeCommand, + DeletePipeCommand, + DescribePipeCommand, + ListPipesCommand, + ListTagsForResourceCommand, + StartPipeCommand, + StopPipeCommand, + TagResourceCommand, + UntagResourceCommand, + UpdatePipeCommand, +}; + +export interface Pipes { /** - * @public - *

Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

+ * @see {@link CreatePipeCommand} */ - public createPipe(args: CreatePipeCommandInput, options?: __HttpHandlerOptions): Promise; - public createPipe(args: CreatePipeCommandInput, cb: (err: any, data?: CreatePipeCommandOutput) => void): void; - public createPipe( + createPipe(args: CreatePipeCommandInput, options?: __HttpHandlerOptions): Promise; + createPipe(args: CreatePipeCommandInput, cb: (err: any, data?: CreatePipeCommandOutput) => void): void; + createPipe( args: CreatePipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePipeCommandOutput) => void ): void; - public createPipe( - args: CreatePipeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePipeCommandOutput) => void), - cb?: (err: any, data?: CreatePipeCommandOutput) => void - ): Promise | void { - const command = new CreatePipeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

+ * @see {@link DeletePipeCommand} */ - public deletePipe(args: DeletePipeCommandInput, options?: __HttpHandlerOptions): Promise; - public deletePipe(args: DeletePipeCommandInput, cb: (err: any, data?: DeletePipeCommandOutput) => void): void; - public deletePipe( + deletePipe(args: DeletePipeCommandInput, options?: __HttpHandlerOptions): Promise; + deletePipe(args: DeletePipeCommandInput, cb: (err: any, data?: DeletePipeCommandOutput) => void): void; + deletePipe( args: DeletePipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePipeCommandOutput) => void ): void; - public deletePipe( - args: DeletePipeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePipeCommandOutput) => void), - cb?: (err: any, data?: DeletePipeCommandOutput) => void - ): Promise | void { - const command = new DeletePipeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

+ * @see {@link DescribePipeCommand} */ - public describePipe( - args: DescribePipeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describePipe(args: DescribePipeCommandInput, cb: (err: any, data?: DescribePipeCommandOutput) => void): void; - public describePipe( + describePipe(args: DescribePipeCommandInput, options?: __HttpHandlerOptions): Promise; + describePipe(args: DescribePipeCommandInput, cb: (err: any, data?: DescribePipeCommandOutput) => void): void; + describePipe( args: DescribePipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePipeCommandOutput) => void ): void; - public describePipe( - args: DescribePipeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePipeCommandOutput) => void), - cb?: (err: any, data?: DescribePipeCommandOutput) => void - ): Promise | void { - const command = new DescribePipeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

+ * @see {@link ListPipesCommand} */ - public listPipes(args: ListPipesCommandInput, options?: __HttpHandlerOptions): Promise; - public listPipes(args: ListPipesCommandInput, cb: (err: any, data?: ListPipesCommandOutput) => void): void; - public listPipes( + listPipes(args: ListPipesCommandInput, options?: __HttpHandlerOptions): Promise; + listPipes(args: ListPipesCommandInput, cb: (err: any, data?: ListPipesCommandOutput) => void): void; + listPipes( args: ListPipesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPipesCommandOutput) => void ): void; - public listPipes( - args: ListPipesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPipesCommandOutput) => void), - cb?: (err: any, data?: ListPipesCommandOutput) => void - ): Promise | void { - const command = new ListPipesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays the tags associated with a pipe.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Start an existing pipe.

+ * @see {@link StartPipeCommand} */ - public startPipe(args: StartPipeCommandInput, options?: __HttpHandlerOptions): Promise; - public startPipe(args: StartPipeCommandInput, cb: (err: any, data?: StartPipeCommandOutput) => void): void; - public startPipe( + startPipe(args: StartPipeCommandInput, options?: __HttpHandlerOptions): Promise; + startPipe(args: StartPipeCommandInput, cb: (err: any, data?: StartPipeCommandOutput) => void): void; + startPipe( args: StartPipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartPipeCommandOutput) => void ): void; - public startPipe( - args: StartPipeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartPipeCommandOutput) => void), - cb?: (err: any, data?: StartPipeCommandOutput) => void - ): Promise | void { - const command = new StartPipeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stop an existing pipe.

+ * @see {@link StopPipeCommand} */ - public stopPipe(args: StopPipeCommandInput, options?: __HttpHandlerOptions): Promise; - public stopPipe(args: StopPipeCommandInput, cb: (err: any, data?: StopPipeCommandOutput) => void): void; - public stopPipe( + stopPipe(args: StopPipeCommandInput, options?: __HttpHandlerOptions): Promise; + stopPipe(args: StopPipeCommandInput, cb: (err: any, data?: StopPipeCommandOutput) => void): void; + stopPipe( args: StopPipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopPipeCommandOutput) => void ): void; - public stopPipe( - args: StopPipeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopPipeCommandOutput) => void), - cb?: (err: any, data?: StopPipeCommandOutput) => void - ): Promise | void { - const command = new StopPipeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns one or more tags (key-value pairs) to the specified pipe. Tags can - * help you organize and categorize your resources. You can also use them to scope user - * permissions by granting a user permission to access or change only resources with certain tag - * values.

- *

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of - * characters.

- *

You can use the TagResource action with a pipe that already has tags. If - * you specify a new tag key, this tag is appended to the list of tags associated with the - * pipe. If you specify a tag key that is already associated with the pipe, the new tag - * value that you specify replaces the previous value for that tag.

- *

You can associate as many as 50 tags with a pipe.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from the specified pipes.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update an existing pipe. When you call UpdatePipe, only the fields that are included in the request are changed, the rest are unchanged. - * The exception to this is if you modify any Amazon Web Services-service specific fields in the SourceParameters, EnrichmentParameters, or - * TargetParameters objects. The fields in these objects are updated atomically as one and override existing values. This is by design and means that - * if you don't specify an optional field in one of these Parameters objects, that field will be set to its system-default value after the update.

- *

For more information about pipes, see - * Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

+ * @see {@link UpdatePipeCommand} */ - public updatePipe(args: UpdatePipeCommandInput, options?: __HttpHandlerOptions): Promise; - public updatePipe(args: UpdatePipeCommandInput, cb: (err: any, data?: UpdatePipeCommandOutput) => void): void; - public updatePipe( + updatePipe(args: UpdatePipeCommandInput, options?: __HttpHandlerOptions): Promise; + updatePipe(args: UpdatePipeCommandInput, cb: (err: any, data?: UpdatePipeCommandOutput) => void): void; + updatePipe( args: UpdatePipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePipeCommandOutput) => void ): void; - public updatePipe( - args: UpdatePipeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePipeCommandOutput) => void), - cb?: (err: any, data?: UpdatePipeCommandOutput) => void - ): Promise | void { - const command = new UpdatePipeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need for specialized knowledge and integration code when developing + * event driven architectures. This helps ensures consistency across your company’s applications. With Pipes, the target can be any available EventBridge target. + * To set up a pipe, you select the event source, add optional event filtering, define optional enrichment, and select the target for the event data.

+ */ +export class Pipes extends PipesClient implements Pipes {} +createAggregatedClient(commands, Pipes); diff --git a/clients/client-polly/src/Polly.ts b/clients/client-polly/src/Polly.ts index ce344d8a477f..d222ff6a1cf9 100644 --- a/clients/client-polly/src/Polly.ts +++ b/clients/client-polly/src/Polly.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -38,339 +39,156 @@ import { SynthesizeSpeechCommandInput, SynthesizeSpeechCommandOutput, } from "./commands/SynthesizeSpeechCommand"; -import { PollyClient } from "./PollyClient"; +import { PollyClient, PollyClientConfig } from "./PollyClient"; -/** - * @public - *

Amazon Polly is a web service that makes it easy to synthesize speech from - * text.

- *

The Amazon Polly service provides API operations for synthesizing - * high-quality speech from plain text and Speech Synthesis Markup Language - * (SSML), along with managing pronunciations lexicons that enable you to get - * the best results for your application domain.

- */ -export class Polly extends PollyClient { +const commands = { + DeleteLexiconCommand, + DescribeVoicesCommand, + GetLexiconCommand, + GetSpeechSynthesisTaskCommand, + ListLexiconsCommand, + ListSpeechSynthesisTasksCommand, + PutLexiconCommand, + StartSpeechSynthesisTaskCommand, + SynthesizeSpeechCommand, +}; + +export interface Polly { /** - * @public - *

Deletes the specified pronunciation lexicon stored in an Amazon Web Services Region. A lexicon which has been deleted is not available for - * speech synthesis, nor is it possible to retrieve it using either the - * GetLexicon or ListLexicon APIs.

- *

For more information, see Managing Lexicons.

+ * @see {@link DeleteLexiconCommand} */ - public deleteLexicon( - args: DeleteLexiconCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteLexicon( - args: DeleteLexiconCommandInput, - cb: (err: any, data?: DeleteLexiconCommandOutput) => void - ): void; - public deleteLexicon( + deleteLexicon(args: DeleteLexiconCommandInput, options?: __HttpHandlerOptions): Promise; + deleteLexicon(args: DeleteLexiconCommandInput, cb: (err: any, data?: DeleteLexiconCommandOutput) => void): void; + deleteLexicon( args: DeleteLexiconCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLexiconCommandOutput) => void ): void; - public deleteLexicon( - args: DeleteLexiconCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLexiconCommandOutput) => void), - cb?: (err: any, data?: DeleteLexiconCommandOutput) => void - ): Promise | void { - const command = new DeleteLexiconCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the list of voices that are available for use when - * requesting speech synthesis. Each voice speaks a specified language, is - * either male or female, and is identified by an ID, which is the ASCII - * version of the voice name.

- *

When synthesizing speech ( SynthesizeSpeech ), you - * provide the voice ID for the voice you want from the list of voices - * returned by DescribeVoices.

- *

For example, you want your news reader application to read news in - * a specific language, but giving a user the option to choose the voice. - * Using the DescribeVoices operation you can provide the user - * with a list of available voices to select from.

- *

You can optionally specify a language code to filter the available - * voices. For example, if you specify en-US, the operation - * returns a list of all available US English voices.

- *

This operation requires permissions to perform the - * polly:DescribeVoices action.

+ * @see {@link DescribeVoicesCommand} */ - public describeVoices( + describeVoices( args: DescribeVoicesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVoices( - args: DescribeVoicesCommandInput, - cb: (err: any, data?: DescribeVoicesCommandOutput) => void - ): void; - public describeVoices( + describeVoices(args: DescribeVoicesCommandInput, cb: (err: any, data?: DescribeVoicesCommandOutput) => void): void; + describeVoices( args: DescribeVoicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVoicesCommandOutput) => void ): void; - public describeVoices( - args: DescribeVoicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVoicesCommandOutput) => void), - cb?: (err: any, data?: DescribeVoicesCommandOutput) => void - ): Promise | void { - const command = new DescribeVoicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the content of the specified pronunciation lexicon stored - * in an Amazon Web Services Region. For more information, see Managing Lexicons.

+ * @see {@link GetLexiconCommand} */ - public getLexicon(args: GetLexiconCommandInput, options?: __HttpHandlerOptions): Promise; - public getLexicon(args: GetLexiconCommandInput, cb: (err: any, data?: GetLexiconCommandOutput) => void): void; - public getLexicon( + getLexicon(args: GetLexiconCommandInput, options?: __HttpHandlerOptions): Promise; + getLexicon(args: GetLexiconCommandInput, cb: (err: any, data?: GetLexiconCommandOutput) => void): void; + getLexicon( args: GetLexiconCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLexiconCommandOutput) => void ): void; - public getLexicon( - args: GetLexiconCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLexiconCommandOutput) => void), - cb?: (err: any, data?: GetLexiconCommandOutput) => void - ): Promise | void { - const command = new GetLexiconCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a specific SpeechSynthesisTask object based on its TaskID. - * This object contains information about the given speech synthesis task, - * including the status of the task, and a link to the S3 bucket containing - * the output of the task.

+ * @see {@link GetSpeechSynthesisTaskCommand} */ - public getSpeechSynthesisTask( + getSpeechSynthesisTask( args: GetSpeechSynthesisTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSpeechSynthesisTask( + getSpeechSynthesisTask( args: GetSpeechSynthesisTaskCommandInput, cb: (err: any, data?: GetSpeechSynthesisTaskCommandOutput) => void ): void; - public getSpeechSynthesisTask( + getSpeechSynthesisTask( args: GetSpeechSynthesisTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSpeechSynthesisTaskCommandOutput) => void ): void; - public getSpeechSynthesisTask( - args: GetSpeechSynthesisTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSpeechSynthesisTaskCommandOutput) => void), - cb?: (err: any, data?: GetSpeechSynthesisTaskCommandOutput) => void - ): Promise | void { - const command = new GetSpeechSynthesisTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information, see Managing Lexicons.

+ * @see {@link ListLexiconsCommand} */ - public listLexicons( - args: ListLexiconsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listLexicons(args: ListLexiconsCommandInput, cb: (err: any, data?: ListLexiconsCommandOutput) => void): void; - public listLexicons( + listLexicons(args: ListLexiconsCommandInput, options?: __HttpHandlerOptions): Promise; + listLexicons(args: ListLexiconsCommandInput, cb: (err: any, data?: ListLexiconsCommandOutput) => void): void; + listLexicons( args: ListLexiconsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLexiconsCommandOutput) => void ): void; - public listLexicons( - args: ListLexiconsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLexiconsCommandOutput) => void), - cb?: (err: any, data?: ListLexiconsCommandOutput) => void - ): Promise | void { - const command = new ListLexiconsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of SpeechSynthesisTask objects ordered by their - * creation date. This operation can filter the tasks by their status, for - * example, allowing users to list only tasks that are completed.

+ * @see {@link ListSpeechSynthesisTasksCommand} */ - public listSpeechSynthesisTasks( + listSpeechSynthesisTasks( args: ListSpeechSynthesisTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSpeechSynthesisTasks( + listSpeechSynthesisTasks( args: ListSpeechSynthesisTasksCommandInput, cb: (err: any, data?: ListSpeechSynthesisTasksCommandOutput) => void ): void; - public listSpeechSynthesisTasks( + listSpeechSynthesisTasks( args: ListSpeechSynthesisTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSpeechSynthesisTasksCommandOutput) => void ): void; - public listSpeechSynthesisTasks( - args: ListSpeechSynthesisTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSpeechSynthesisTasksCommandOutput) => void), - cb?: (err: any, data?: ListSpeechSynthesisTasksCommandOutput) => void - ): Promise | void { - const command = new ListSpeechSynthesisTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stores a pronunciation lexicon in an Amazon Web Services Region. If - * a lexicon with the same name already exists in the region, it is - * overwritten by the new lexicon. Lexicon operations have eventual - * consistency, therefore, it might take some time before the lexicon is - * available to the SynthesizeSpeech operation.

- *

For more information, see Managing Lexicons.

+ * @see {@link PutLexiconCommand} */ - public putLexicon(args: PutLexiconCommandInput, options?: __HttpHandlerOptions): Promise; - public putLexicon(args: PutLexiconCommandInput, cb: (err: any, data?: PutLexiconCommandOutput) => void): void; - public putLexicon( + putLexicon(args: PutLexiconCommandInput, options?: __HttpHandlerOptions): Promise; + putLexicon(args: PutLexiconCommandInput, cb: (err: any, data?: PutLexiconCommandOutput) => void): void; + putLexicon( args: PutLexiconCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLexiconCommandOutput) => void ): void; - public putLexicon( - args: PutLexiconCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutLexiconCommandOutput) => void), - cb?: (err: any, data?: PutLexiconCommandOutput) => void - ): Promise | void { - const command = new PutLexiconCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows the creation of an asynchronous synthesis task, by starting a - * new SpeechSynthesisTask. This operation requires all the - * standard information needed for speech synthesis, plus the name of an - * Amazon S3 bucket for the service to store the output of the synthesis task - * and two optional parameters (OutputS3KeyPrefix and - * SnsTopicArn). Once the synthesis task is created, this - * operation will return a SpeechSynthesisTask object, which - * will include an identifier of this task as well as the current status. The - * SpeechSynthesisTask object is available for 72 hours after - * starting the asynchronous synthesis task.

+ * @see {@link StartSpeechSynthesisTaskCommand} */ - public startSpeechSynthesisTask( + startSpeechSynthesisTask( args: StartSpeechSynthesisTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public startSpeechSynthesisTask( + startSpeechSynthesisTask( args: StartSpeechSynthesisTaskCommandInput, cb: (err: any, data?: StartSpeechSynthesisTaskCommandOutput) => void ): void; - public startSpeechSynthesisTask( + startSpeechSynthesisTask( args: StartSpeechSynthesisTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSpeechSynthesisTaskCommandOutput) => void ): void; - public startSpeechSynthesisTask( - args: StartSpeechSynthesisTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartSpeechSynthesisTaskCommandOutput) => void), - cb?: (err: any, data?: StartSpeechSynthesisTaskCommandOutput) => void - ): Promise | void { - const command = new StartSpeechSynthesisTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. - * SSML input must be valid, well-formed SSML. Some alphabets might not be - * available with all the voices (for example, Cyrillic might not be read at - * all by English voices) unless phoneme mapping is used. For more - * information, see How it Works.

+ * @see {@link SynthesizeSpeechCommand} */ - public synthesizeSpeech( + synthesizeSpeech( args: SynthesizeSpeechCommandInput, options?: __HttpHandlerOptions ): Promise; - public synthesizeSpeech( + synthesizeSpeech( args: SynthesizeSpeechCommandInput, cb: (err: any, data?: SynthesizeSpeechCommandOutput) => void ): void; - public synthesizeSpeech( + synthesizeSpeech( args: SynthesizeSpeechCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SynthesizeSpeechCommandOutput) => void ): void; - public synthesizeSpeech( - args: SynthesizeSpeechCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SynthesizeSpeechCommandOutput) => void), - cb?: (err: any, data?: SynthesizeSpeechCommandOutput) => void - ): Promise | void { - const command = new SynthesizeSpeechCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Polly is a web service that makes it easy to synthesize speech from + * text.

+ *

The Amazon Polly service provides API operations for synthesizing + * high-quality speech from plain text and Speech Synthesis Markup Language + * (SSML), along with managing pronunciations lexicons that enable you to get + * the best results for your application domain.

+ */ +export class Polly extends PollyClient implements Polly {} +createAggregatedClient(commands, Polly); diff --git a/clients/client-pricing/src/Pricing.ts b/clients/client-pricing/src/Pricing.ts index b8c8a722e530..7c1648816894 100644 --- a/clients/client-pricing/src/Pricing.ts +++ b/clients/client-pricing/src/Pricing.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -22,221 +23,120 @@ import { ListPriceListsCommandInput, ListPriceListsCommandOutput, } from "./commands/ListPriceListsCommand"; -import { PricingClient } from "./PricingClient"; +import { PricingClient, PricingClientConfig } from "./PricingClient"; -/** - * @public - *

Amazon Web Services Price List API is a centralized and convenient way to - * programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List - * uses standardized product attributes such as Location, Storage - * Class, and Operating System, and provides prices at the SKU - * level. You can use the Amazon Web Services Price List to build cost control and scenario planning tools, reconcile - * billing data, forecast future spend for budgeting purposes, and provide cost benefit - * analysis that compare your internal workloads with Amazon Web Services.

- *

Use GetServices without a service code to retrieve the service codes for all AWS services, then - * GetServices with a service code to retrieve the attribute names for - * that service. After you have the service code and attribute names, you can use GetAttributeValues - * to see what values are available for an attribute. With the service code and an attribute name and value, - * you can use GetProducts to find specific products that you're interested in, such as - * an AmazonEC2 instance, with a Provisioned IOPS - * volumeType.

- *

Service Endpoint

- *

Amazon Web Services Price List service API provides the following two endpoints:

- *
    - *
  • - *

    https://api.pricing.us-east-1.amazonaws.com

    - *
  • - *
  • - *

    https://api.pricing.ap-south-1.amazonaws.com

    - *
  • - *
- */ -export class Pricing extends PricingClient { +const commands = { + DescribeServicesCommand, + GetAttributeValuesCommand, + GetPriceListFileUrlCommand, + GetProductsCommand, + ListPriceListsCommand, +}; + +export interface Pricing { /** - * @public - *

Returns the metadata for one service or a list of the metadata for all services. Use - * this without a service code to get the service codes for all services. - * Use it with a service code, such as AmazonEC2, to get information specific to - * that service, such as the attribute - * names available for that service. For example, some of the attribute names available for EC2 are - * volumeType, maxIopsVolume, operation, - * locationType, and instanceCapacity10xlarge.

+ * @see {@link DescribeServicesCommand} */ - public describeServices( + describeServices( args: DescribeServicesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeServices( + describeServices( args: DescribeServicesCommandInput, cb: (err: any, data?: DescribeServicesCommandOutput) => void ): void; - public describeServices( + describeServices( args: DescribeServicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeServicesCommandOutput) => void ): void; - public describeServices( - args: DescribeServicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeServicesCommandOutput) => void), - cb?: (err: any, data?: DescribeServicesCommandOutput) => void - ): Promise | void { - const command = new DescribeServicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of attribute values. Attributes are similar to the details - * in a Price List API offer file. For a list of available attributes, see - * Offer File Definitions - * in the Billing and Cost Management User Guide.

+ * @see {@link GetAttributeValuesCommand} */ - public getAttributeValues( + getAttributeValues( args: GetAttributeValuesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAttributeValues( + getAttributeValues( args: GetAttributeValuesCommandInput, cb: (err: any, data?: GetAttributeValuesCommandOutput) => void ): void; - public getAttributeValues( + getAttributeValues( args: GetAttributeValuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAttributeValuesCommandOutput) => void ): void; - public getAttributeValues( - args: GetAttributeValuesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAttributeValuesCommandOutput) => void), - cb?: (err: any, data?: GetAttributeValuesCommandOutput) => void - ): Promise | void { - const command = new GetAttributeValuesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * - * This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10). - * - *

- *

This returns the URL that you can retrieve your Price List file from. This URL is based on - * the PriceListArn and FileFormat that you retrieve from the - * ListPriceLists - * response.

+ * @see {@link GetPriceListFileUrlCommand} */ - public getPriceListFileUrl( + getPriceListFileUrl( args: GetPriceListFileUrlCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPriceListFileUrl( + getPriceListFileUrl( args: GetPriceListFileUrlCommandInput, cb: (err: any, data?: GetPriceListFileUrlCommandOutput) => void ): void; - public getPriceListFileUrl( + getPriceListFileUrl( args: GetPriceListFileUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPriceListFileUrlCommandOutput) => void ): void; - public getPriceListFileUrl( - args: GetPriceListFileUrlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPriceListFileUrlCommandOutput) => void), - cb?: (err: any, data?: GetPriceListFileUrlCommandOutput) => void - ): Promise | void { - const command = new GetPriceListFileUrlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all products that match the filter criteria.

+ * @see {@link GetProductsCommand} */ - public getProducts(args: GetProductsCommandInput, options?: __HttpHandlerOptions): Promise; - public getProducts(args: GetProductsCommandInput, cb: (err: any, data?: GetProductsCommandOutput) => void): void; - public getProducts( + getProducts(args: GetProductsCommandInput, options?: __HttpHandlerOptions): Promise; + getProducts(args: GetProductsCommandInput, cb: (err: any, data?: GetProductsCommandOutput) => void): void; + getProducts( args: GetProductsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProductsCommandOutput) => void ): void; - public getProducts( - args: GetProductsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetProductsCommandOutput) => void), - cb?: (err: any, data?: GetProductsCommandOutput) => void - ): Promise | void { - const command = new GetProductsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * - * This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10). - * - *

- *

This returns a list of Price List references that the requester if authorized to view, given a ServiceCode, CurrencyCode, and an EffectiveDate. - * Use without a RegionCode filter to list Price List references from all - * available Amazon Web Services Regions. Use with a RegionCode filter to get the - * Price List reference that's specific to a specific Amazon Web Services Region. You can use - * the PriceListArn from the response to get your preferred Price List files - * through the - * GetPriceListFileUrl - * API.

+ * @see {@link ListPriceListsCommand} */ - public listPriceLists( + listPriceLists( args: ListPriceListsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPriceLists( - args: ListPriceListsCommandInput, - cb: (err: any, data?: ListPriceListsCommandOutput) => void - ): void; - public listPriceLists( + listPriceLists(args: ListPriceListsCommandInput, cb: (err: any, data?: ListPriceListsCommandOutput) => void): void; + listPriceLists( args: ListPriceListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPriceListsCommandOutput) => void ): void; - public listPriceLists( - args: ListPriceListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPriceListsCommandOutput) => void), - cb?: (err: any, data?: ListPriceListsCommandOutput) => void - ): Promise | void { - const command = new ListPriceListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Web Services Price List API is a centralized and convenient way to + * programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List + * uses standardized product attributes such as Location, Storage + * Class, and Operating System, and provides prices at the SKU + * level. You can use the Amazon Web Services Price List to build cost control and scenario planning tools, reconcile + * billing data, forecast future spend for budgeting purposes, and provide cost benefit + * analysis that compare your internal workloads with Amazon Web Services.

+ *

Use GetServices without a service code to retrieve the service codes for all AWS services, then + * GetServices with a service code to retrieve the attribute names for + * that service. After you have the service code and attribute names, you can use GetAttributeValues + * to see what values are available for an attribute. With the service code and an attribute name and value, + * you can use GetProducts to find specific products that you're interested in, such as + * an AmazonEC2 instance, with a Provisioned IOPS + * volumeType.

+ *

Service Endpoint

+ *

Amazon Web Services Price List service API provides the following two endpoints:

+ *
    + *
  • + *

    https://api.pricing.us-east-1.amazonaws.com

    + *
  • + *
  • + *

    https://api.pricing.ap-south-1.amazonaws.com

    + *
  • + *
+ */ +export class Pricing extends PricingClient implements Pricing {} +createAggregatedClient(commands, Pricing); diff --git a/clients/client-privatenetworks/src/PrivateNetworks.ts b/clients/client-privatenetworks/src/PrivateNetworks.ts index 2439dab15a71..65c2410b72e4 100644 --- a/clients/client-privatenetworks/src/PrivateNetworks.ts +++ b/clients/client-privatenetworks/src/PrivateNetworks.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -111,872 +112,426 @@ import { UpdateNetworkSitePlanCommandInput, UpdateNetworkSitePlanCommandOutput, } from "./commands/UpdateNetworkSitePlanCommand"; -import { PrivateNetworksClient } from "./PrivateNetworksClient"; +import { PrivateNetworksClient, PrivateNetworksClientConfig } from "./PrivateNetworksClient"; -/** - * @public - *

Amazon Web Services Private 5G is a managed service that makes it easy to deploy, operate, and scale - * your own private mobile network at your on-premises location. Private 5G provides the - * pre-configured hardware and software for mobile networks, helps automate setup, and - * scales capacity on demand to support additional devices as needed.

- */ -export class PrivateNetworks extends PrivateNetworksClient { +const commands = { + AcknowledgeOrderReceiptCommand, + ActivateDeviceIdentifierCommand, + ActivateNetworkSiteCommand, + ConfigureAccessPointCommand, + CreateNetworkCommand, + CreateNetworkSiteCommand, + DeactivateDeviceIdentifierCommand, + DeleteNetworkCommand, + DeleteNetworkSiteCommand, + GetDeviceIdentifierCommand, + GetNetworkCommand, + GetNetworkResourceCommand, + GetNetworkSiteCommand, + GetOrderCommand, + ListDeviceIdentifiersCommand, + ListNetworkResourcesCommand, + ListNetworksCommand, + ListNetworkSitesCommand, + ListOrdersCommand, + ListTagsForResourceCommand, + PingCommand, + StartNetworkResourceUpdateCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateNetworkSiteCommand, + UpdateNetworkSitePlanCommand, +}; + +export interface PrivateNetworks { /** - * @public - *

Acknowledges that the specified network order was received.

+ * @see {@link AcknowledgeOrderReceiptCommand} */ - public acknowledgeOrderReceipt( + acknowledgeOrderReceipt( args: AcknowledgeOrderReceiptCommandInput, options?: __HttpHandlerOptions ): Promise; - public acknowledgeOrderReceipt( + acknowledgeOrderReceipt( args: AcknowledgeOrderReceiptCommandInput, cb: (err: any, data?: AcknowledgeOrderReceiptCommandOutput) => void ): void; - public acknowledgeOrderReceipt( + acknowledgeOrderReceipt( args: AcknowledgeOrderReceiptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcknowledgeOrderReceiptCommandOutput) => void ): void; - public acknowledgeOrderReceipt( - args: AcknowledgeOrderReceiptCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcknowledgeOrderReceiptCommandOutput) => void), - cb?: (err: any, data?: AcknowledgeOrderReceiptCommandOutput) => void - ): Promise | void { - const command = new AcknowledgeOrderReceiptCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Activates the specified device identifier.

+ * @see {@link ActivateDeviceIdentifierCommand} */ - public activateDeviceIdentifier( + activateDeviceIdentifier( args: ActivateDeviceIdentifierCommandInput, options?: __HttpHandlerOptions ): Promise; - public activateDeviceIdentifier( + activateDeviceIdentifier( args: ActivateDeviceIdentifierCommandInput, cb: (err: any, data?: ActivateDeviceIdentifierCommandOutput) => void ): void; - public activateDeviceIdentifier( + activateDeviceIdentifier( args: ActivateDeviceIdentifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ActivateDeviceIdentifierCommandOutput) => void ): void; - public activateDeviceIdentifier( - args: ActivateDeviceIdentifierCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ActivateDeviceIdentifierCommandOutput) => void), - cb?: (err: any, data?: ActivateDeviceIdentifierCommandOutput) => void - ): Promise | void { - const command = new ActivateDeviceIdentifierCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Activates the specified network site.

+ * @see {@link ActivateNetworkSiteCommand} */ - public activateNetworkSite( + activateNetworkSite( args: ActivateNetworkSiteCommandInput, options?: __HttpHandlerOptions ): Promise; - public activateNetworkSite( + activateNetworkSite( args: ActivateNetworkSiteCommandInput, cb: (err: any, data?: ActivateNetworkSiteCommandOutput) => void ): void; - public activateNetworkSite( + activateNetworkSite( args: ActivateNetworkSiteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ActivateNetworkSiteCommandOutput) => void ): void; - public activateNetworkSite( - args: ActivateNetworkSiteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ActivateNetworkSiteCommandOutput) => void), - cb?: (err: any, data?: ActivateNetworkSiteCommandOutput) => void - ): Promise | void { - const command = new ActivateNetworkSiteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Configures the specified network resource. - *

- *

- * Use this action to specify the geographic - * position of the hardware. You must provide Certified Professional Installer (CPI) - * credentials in the request so that we can obtain spectrum grants. For more information, - * see Radio - * units in the Amazon Web Services Private 5G User Guide.

+ * @see {@link ConfigureAccessPointCommand} */ - public configureAccessPoint( + configureAccessPoint( args: ConfigureAccessPointCommandInput, options?: __HttpHandlerOptions ): Promise; - public configureAccessPoint( + configureAccessPoint( args: ConfigureAccessPointCommandInput, cb: (err: any, data?: ConfigureAccessPointCommandOutput) => void ): void; - public configureAccessPoint( + configureAccessPoint( args: ConfigureAccessPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfigureAccessPointCommandOutput) => void ): void; - public configureAccessPoint( - args: ConfigureAccessPointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConfigureAccessPointCommandOutput) => void), - cb?: (err: any, data?: ConfigureAccessPointCommandOutput) => void - ): Promise | void { - const command = new ConfigureAccessPointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a network.

+ * @see {@link CreateNetworkCommand} */ - public createNetwork( - args: CreateNetworkCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createNetwork( - args: CreateNetworkCommandInput, - cb: (err: any, data?: CreateNetworkCommandOutput) => void - ): void; - public createNetwork( + createNetwork(args: CreateNetworkCommandInput, options?: __HttpHandlerOptions): Promise; + createNetwork(args: CreateNetworkCommandInput, cb: (err: any, data?: CreateNetworkCommandOutput) => void): void; + createNetwork( args: CreateNetworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNetworkCommandOutput) => void ): void; - public createNetwork( - args: CreateNetworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNetworkCommandOutput) => void), - cb?: (err: any, data?: CreateNetworkCommandOutput) => void - ): Promise | void { - const command = new CreateNetworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a network site.

+ * @see {@link CreateNetworkSiteCommand} */ - public createNetworkSite( + createNetworkSite( args: CreateNetworkSiteCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNetworkSite( + createNetworkSite( args: CreateNetworkSiteCommandInput, cb: (err: any, data?: CreateNetworkSiteCommandOutput) => void ): void; - public createNetworkSite( + createNetworkSite( args: CreateNetworkSiteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNetworkSiteCommandOutput) => void ): void; - public createNetworkSite( - args: CreateNetworkSiteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNetworkSiteCommandOutput) => void), - cb?: (err: any, data?: CreateNetworkSiteCommandOutput) => void - ): Promise | void { - const command = new CreateNetworkSiteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deactivates the specified device identifier.

+ * @see {@link DeactivateDeviceIdentifierCommand} */ - public deactivateDeviceIdentifier( + deactivateDeviceIdentifier( args: DeactivateDeviceIdentifierCommandInput, options?: __HttpHandlerOptions ): Promise; - public deactivateDeviceIdentifier( + deactivateDeviceIdentifier( args: DeactivateDeviceIdentifierCommandInput, cb: (err: any, data?: DeactivateDeviceIdentifierCommandOutput) => void ): void; - public deactivateDeviceIdentifier( + deactivateDeviceIdentifier( args: DeactivateDeviceIdentifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeactivateDeviceIdentifierCommandOutput) => void ): void; - public deactivateDeviceIdentifier( - args: DeactivateDeviceIdentifierCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeactivateDeviceIdentifierCommandOutput) => void), - cb?: (err: any, data?: DeactivateDeviceIdentifierCommandOutput) => void - ): Promise | void { - const command = new DeactivateDeviceIdentifierCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified network. You must delete network sites before you delete the - * network. For more information, see - * DeleteNetworkSite in the - * API Reference for Amazon Web Services Private 5G.

+ * @see {@link DeleteNetworkCommand} */ - public deleteNetwork( - args: DeleteNetworkCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteNetwork( - args: DeleteNetworkCommandInput, - cb: (err: any, data?: DeleteNetworkCommandOutput) => void - ): void; - public deleteNetwork( + deleteNetwork(args: DeleteNetworkCommandInput, options?: __HttpHandlerOptions): Promise; + deleteNetwork(args: DeleteNetworkCommandInput, cb: (err: any, data?: DeleteNetworkCommandOutput) => void): void; + deleteNetwork( args: DeleteNetworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNetworkCommandOutput) => void ): void; - public deleteNetwork( - args: DeleteNetworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNetworkCommandOutput) => void), - cb?: (err: any, data?: DeleteNetworkCommandOutput) => void - ): Promise | void { - const command = new DeleteNetworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified network site. Return the hardware after you delete the network - * site. You are responsible for minimum charges. For more information, see Hardware - * returns in the Amazon Web Services Private 5G User - * Guide.

+ * @see {@link DeleteNetworkSiteCommand} */ - public deleteNetworkSite( + deleteNetworkSite( args: DeleteNetworkSiteCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNetworkSite( + deleteNetworkSite( args: DeleteNetworkSiteCommandInput, cb: (err: any, data?: DeleteNetworkSiteCommandOutput) => void ): void; - public deleteNetworkSite( + deleteNetworkSite( args: DeleteNetworkSiteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNetworkSiteCommandOutput) => void ): void; - public deleteNetworkSite( - args: DeleteNetworkSiteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNetworkSiteCommandOutput) => void), - cb?: (err: any, data?: DeleteNetworkSiteCommandOutput) => void - ): Promise | void { - const command = new DeleteNetworkSiteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the specified device identifier.

+ * @see {@link GetDeviceIdentifierCommand} */ - public getDeviceIdentifier( + getDeviceIdentifier( args: GetDeviceIdentifierCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDeviceIdentifier( + getDeviceIdentifier( args: GetDeviceIdentifierCommandInput, cb: (err: any, data?: GetDeviceIdentifierCommandOutput) => void ): void; - public getDeviceIdentifier( + getDeviceIdentifier( args: GetDeviceIdentifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeviceIdentifierCommandOutput) => void ): void; - public getDeviceIdentifier( - args: GetDeviceIdentifierCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeviceIdentifierCommandOutput) => void), - cb?: (err: any, data?: GetDeviceIdentifierCommandOutput) => void - ): Promise | void { - const command = new GetDeviceIdentifierCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the specified network.

+ * @see {@link GetNetworkCommand} */ - public getNetwork(args: GetNetworkCommandInput, options?: __HttpHandlerOptions): Promise; - public getNetwork(args: GetNetworkCommandInput, cb: (err: any, data?: GetNetworkCommandOutput) => void): void; - public getNetwork( + getNetwork(args: GetNetworkCommandInput, options?: __HttpHandlerOptions): Promise; + getNetwork(args: GetNetworkCommandInput, cb: (err: any, data?: GetNetworkCommandOutput) => void): void; + getNetwork( args: GetNetworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNetworkCommandOutput) => void ): void; - public getNetwork( - args: GetNetworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetNetworkCommandOutput) => void), - cb?: (err: any, data?: GetNetworkCommandOutput) => void - ): Promise | void { - const command = new GetNetworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the specified network resource.

+ * @see {@link GetNetworkResourceCommand} */ - public getNetworkResource( + getNetworkResource( args: GetNetworkResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public getNetworkResource( + getNetworkResource( args: GetNetworkResourceCommandInput, cb: (err: any, data?: GetNetworkResourceCommandOutput) => void ): void; - public getNetworkResource( + getNetworkResource( args: GetNetworkResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNetworkResourceCommandOutput) => void ): void; - public getNetworkResource( - args: GetNetworkResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetNetworkResourceCommandOutput) => void), - cb?: (err: any, data?: GetNetworkResourceCommandOutput) => void - ): Promise | void { - const command = new GetNetworkResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the specified network site.

+ * @see {@link GetNetworkSiteCommand} */ - public getNetworkSite( + getNetworkSite( args: GetNetworkSiteCommandInput, options?: __HttpHandlerOptions ): Promise; - public getNetworkSite( - args: GetNetworkSiteCommandInput, - cb: (err: any, data?: GetNetworkSiteCommandOutput) => void - ): void; - public getNetworkSite( + getNetworkSite(args: GetNetworkSiteCommandInput, cb: (err: any, data?: GetNetworkSiteCommandOutput) => void): void; + getNetworkSite( args: GetNetworkSiteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNetworkSiteCommandOutput) => void ): void; - public getNetworkSite( - args: GetNetworkSiteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetNetworkSiteCommandOutput) => void), - cb?: (err: any, data?: GetNetworkSiteCommandOutput) => void - ): Promise | void { - const command = new GetNetworkSiteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the specified order.

+ * @see {@link GetOrderCommand} */ - public getOrder(args: GetOrderCommandInput, options?: __HttpHandlerOptions): Promise; - public getOrder(args: GetOrderCommandInput, cb: (err: any, data?: GetOrderCommandOutput) => void): void; - public getOrder( + getOrder(args: GetOrderCommandInput, options?: __HttpHandlerOptions): Promise; + getOrder(args: GetOrderCommandInput, cb: (err: any, data?: GetOrderCommandOutput) => void): void; + getOrder( args: GetOrderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOrderCommandOutput) => void ): void; - public getOrder( - args: GetOrderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOrderCommandOutput) => void), - cb?: (err: any, data?: GetOrderCommandOutput) => void - ): Promise | void { - const command = new GetOrderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists device identifiers. Add filters to your request to return a more - * specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order, - * the status of device identifiers, or the ARN of the traffic group.

- *

If you specify multiple filters, filters are joined with an OR, and the request - * returns results that match all of the specified filters.

+ * @see {@link ListDeviceIdentifiersCommand} */ - public listDeviceIdentifiers( + listDeviceIdentifiers( args: ListDeviceIdentifiersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeviceIdentifiers( + listDeviceIdentifiers( args: ListDeviceIdentifiersCommandInput, cb: (err: any, data?: ListDeviceIdentifiersCommandOutput) => void ): void; - public listDeviceIdentifiers( + listDeviceIdentifiers( args: ListDeviceIdentifiersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeviceIdentifiersCommandOutput) => void ): void; - public listDeviceIdentifiers( - args: ListDeviceIdentifiersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeviceIdentifiersCommandOutput) => void), - cb?: (err: any, data?: ListDeviceIdentifiersCommandOutput) => void - ): Promise | void { - const command = new ListDeviceIdentifiersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists network resources. Add filters to your request to return a more - * specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order or - * the status of network resources.

- *

If you specify multiple filters, filters are joined with an OR, and the request - * returns results that match all of the specified filters.

+ * @see {@link ListNetworkResourcesCommand} */ - public listNetworkResources( + listNetworkResources( args: ListNetworkResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listNetworkResources( + listNetworkResources( args: ListNetworkResourcesCommandInput, cb: (err: any, data?: ListNetworkResourcesCommandOutput) => void ): void; - public listNetworkResources( + listNetworkResources( args: ListNetworkResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNetworkResourcesCommandOutput) => void ): void; - public listNetworkResources( - args: ListNetworkResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNetworkResourcesCommandOutput) => void), - cb?: (err: any, data?: ListNetworkResourcesCommandOutput) => void - ): Promise | void { - const command = new ListNetworkResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists networks. Add filters to your request to return a more - * specific list of results. Use filters to match the status of the network.

+ * @see {@link ListNetworksCommand} */ - public listNetworks( - args: ListNetworksCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listNetworks(args: ListNetworksCommandInput, cb: (err: any, data?: ListNetworksCommandOutput) => void): void; - public listNetworks( + listNetworks(args: ListNetworksCommandInput, options?: __HttpHandlerOptions): Promise; + listNetworks(args: ListNetworksCommandInput, cb: (err: any, data?: ListNetworksCommandOutput) => void): void; + listNetworks( args: ListNetworksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNetworksCommandOutput) => void ): void; - public listNetworks( - args: ListNetworksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNetworksCommandOutput) => void), - cb?: (err: any, data?: ListNetworksCommandOutput) => void - ): Promise | void { - const command = new ListNetworksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists network sites. Add filters to your request to return a more - * specific list of results. Use filters to match the status of the network site.

+ * @see {@link ListNetworkSitesCommand} */ - public listNetworkSites( + listNetworkSites( args: ListNetworkSitesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listNetworkSites( + listNetworkSites( args: ListNetworkSitesCommandInput, cb: (err: any, data?: ListNetworkSitesCommandOutput) => void ): void; - public listNetworkSites( + listNetworkSites( args: ListNetworkSitesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNetworkSitesCommandOutput) => void ): void; - public listNetworkSites( - args: ListNetworkSitesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNetworkSitesCommandOutput) => void), - cb?: (err: any, data?: ListNetworkSitesCommandOutput) => void - ): Promise | void { - const command = new ListNetworkSitesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists orders. Add filters to your request to return a more - * specific list of results. Use filters to match the Amazon Resource Name (ARN) of the network site or - * the status of the order.

- *

If you specify multiple filters, filters are joined with an OR, and the request - * returns results that match all of the specified filters.

+ * @see {@link ListOrdersCommand} */ - public listOrders(args: ListOrdersCommandInput, options?: __HttpHandlerOptions): Promise; - public listOrders(args: ListOrdersCommandInput, cb: (err: any, data?: ListOrdersCommandOutput) => void): void; - public listOrders( + listOrders(args: ListOrdersCommandInput, options?: __HttpHandlerOptions): Promise; + listOrders(args: ListOrdersCommandInput, cb: (err: any, data?: ListOrdersCommandOutput) => void): void; + listOrders( args: ListOrdersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOrdersCommandOutput) => void ): void; - public listOrders( - args: ListOrdersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOrdersCommandOutput) => void), - cb?: (err: any, data?: ListOrdersCommandOutput) => void - ): Promise | void { - const command = new ListOrdersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags for the specified resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Checks the health of the service.

+ * @see {@link PingCommand} */ - public ping(args: PingCommandInput, options?: __HttpHandlerOptions): Promise; - public ping(args: PingCommandInput, cb: (err: any, data?: PingCommandOutput) => void): void; - public ping( - args: PingCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: PingCommandOutput) => void - ): void; - public ping( - args: PingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PingCommandOutput) => void), - cb?: (err: any, data?: PingCommandOutput) => void - ): Promise | void { - const command = new PingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } + ping(args: PingCommandInput, options?: __HttpHandlerOptions): Promise; + ping(args: PingCommandInput, cb: (err: any, data?: PingCommandOutput) => void): void; + ping(args: PingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PingCommandOutput) => void): void; /** - * @public - *

Starts an update of the specified network resource.

- *

After you submit a request to replace or return a network resource, the status - * of the network resource is CREATING_SHIPPING_LABEL. The shipping label - * is available when the status of the network resource is PENDING_RETURN. - * After the network resource is successfully returned, its status is DELETED. - * For more information, see Return a radio unit.

+ * @see {@link StartNetworkResourceUpdateCommand} */ - public startNetworkResourceUpdate( + startNetworkResourceUpdate( args: StartNetworkResourceUpdateCommandInput, options?: __HttpHandlerOptions ): Promise; - public startNetworkResourceUpdate( + startNetworkResourceUpdate( args: StartNetworkResourceUpdateCommandInput, cb: (err: any, data?: StartNetworkResourceUpdateCommandOutput) => void ): void; - public startNetworkResourceUpdate( + startNetworkResourceUpdate( args: StartNetworkResourceUpdateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartNetworkResourceUpdateCommandOutput) => void ): void; - public startNetworkResourceUpdate( - args: StartNetworkResourceUpdateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartNetworkResourceUpdateCommandOutput) => void), - cb?: (err: any, data?: StartNetworkResourceUpdateCommandOutput) => void - ): Promise | void { - const command = new StartNetworkResourceUpdateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Adds tags to the specified resource. - *

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from the specified resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified network site.

+ * @see {@link UpdateNetworkSiteCommand} */ - public updateNetworkSite( + updateNetworkSite( args: UpdateNetworkSiteCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateNetworkSite( + updateNetworkSite( args: UpdateNetworkSiteCommandInput, cb: (err: any, data?: UpdateNetworkSiteCommandOutput) => void ): void; - public updateNetworkSite( + updateNetworkSite( args: UpdateNetworkSiteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNetworkSiteCommandOutput) => void ): void; - public updateNetworkSite( - args: UpdateNetworkSiteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateNetworkSiteCommandOutput) => void), - cb?: (err: any, data?: UpdateNetworkSiteCommandOutput) => void - ): Promise | void { - const command = new UpdateNetworkSiteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified network site plan.

+ * @see {@link UpdateNetworkSitePlanCommand} */ - public updateNetworkSitePlan( + updateNetworkSitePlan( args: UpdateNetworkSitePlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateNetworkSitePlan( + updateNetworkSitePlan( args: UpdateNetworkSitePlanCommandInput, cb: (err: any, data?: UpdateNetworkSitePlanCommandOutput) => void ): void; - public updateNetworkSitePlan( + updateNetworkSitePlan( args: UpdateNetworkSitePlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNetworkSitePlanCommandOutput) => void ): void; - public updateNetworkSitePlan( - args: UpdateNetworkSitePlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateNetworkSitePlanCommandOutput) => void), - cb?: (err: any, data?: UpdateNetworkSitePlanCommandOutput) => void - ): Promise | void { - const command = new UpdateNetworkSitePlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Web Services Private 5G is a managed service that makes it easy to deploy, operate, and scale + * your own private mobile network at your on-premises location. Private 5G provides the + * pre-configured hardware and software for mobile networks, helps automate setup, and + * scales capacity on demand to support additional devices as needed.

+ */ +export class PrivateNetworks extends PrivateNetworksClient implements PrivateNetworks {} +createAggregatedClient(commands, PrivateNetworks); diff --git a/clients/client-proton/src/Proton.ts b/clients/client-proton/src/Proton.ts index 31b0ba01d9c4..916b9d2ee2be 100644 --- a/clients/client-proton/src/Proton.ts +++ b/clients/client-proton/src/Proton.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -413,3218 +414,1587 @@ import { UpdateTemplateSyncConfigCommandInput, UpdateTemplateSyncConfigCommandOutput, } from "./commands/UpdateTemplateSyncConfigCommand"; -import { ProtonClient } from "./ProtonClient"; +import { ProtonClient, ProtonClientConfig } from "./ProtonClient"; -/** - * @public - *

This is the Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the - * actions and data types for the Proton - * service.

- *

The documentation for each action shows the Query API request parameters and the XML response.

- *

Alternatively, you can use the Amazon Web Services CLI to access an API. For more information, see the Amazon Web Services Command Line Interface User - * Guide.

- *

The Proton service is a two-pronged automation framework. Administrators create service templates to provide - * standardized infrastructure and deployment tooling for serverless and container based applications. Developers, in - * turn, select from the available service templates to automate their application or service deployments.

- *

Because administrators define the infrastructure and tooling that Proton deploys and manages, they need - * permissions to use all of the listed API operations.

- *

When developers select a specific infrastructure and tooling set, Proton deploys their applications. To - * monitor their applications that are running on Proton, developers need permissions to the service - * create, list, update and delete - * API operations and the service instance list and update API - * operations.

- *

To learn more about Proton, see the Proton User Guide.

- *

- * Ensuring Idempotency - *

- *

When you make a mutating API request, the request typically returns a result before the asynchronous workflows - * of the operation are complete. Operations might also time out or encounter other server issues before they're - * complete, even if the request already returned a result. This might make it difficult to determine whether the - * request succeeded. Moreover, you might need to retry the request multiple times to ensure that the operation - * completes successfully. However, if the original request and the subsequent retries are successful, the operation - * occurs multiple times. This means that you might create more resources than you intended.

- *

- * Idempotency ensures that an API request action completes no more than one time. With an - * idempotent request, if the original request action completes successfully, any subsequent retries complete - * successfully without performing any further actions. However, the result might contain updated information, such as - * the current creation status.

- *

The following lists of APIs are grouped according to methods that ensure idempotency.

- *

- * Idempotent create APIs with a client token - *

- *

The API actions in this list support idempotency with the use of a client token. The - * corresponding Amazon Web Services CLI commands also support idempotency using a client token. A client token is a unique, - * case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, - * specify a client token in the request. We recommend that you don't reuse the same client token - * for other API requests. If you don’t provide a client token for these APIs, a default client token is automatically - * provided by SDKs.

- *

Given a request action that has succeeded:

- *

If you retry the request using the same client token and the same parameters, the retry succeeds without - * performing any further actions other than returning the original resource detail data in the response.

- *

If you retry the request using the same client token, but one or more of the parameters are different, the retry - * throws a ValidationException with an IdempotentParameterMismatch error.

- *

Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new - * resource is created.

- *

If the original resource is deleted and you retry the request, a new resource is created.

- *

Idempotent create APIs with a client token:

- *
    - *
  • - *

    CreateEnvironmentTemplateVersion

    - *
  • - *
  • - *

    CreateServiceTemplateVersion

    - *
  • - *
  • - *

    CreateEnvironmentAccountConnection

    - *
  • - *
- *

- * Idempotent create APIs - *

- *

Given a request action that has succeeded:

- *

If you retry the request with an API from this group, and the original resource hasn't been - * modified, the retry succeeds without performing any further actions other than returning the original resource detail - * data in the response.

- *

If the original resource has been modified, the retry throws a ConflictException.

- *

If you retry with different input parameters, the retry throws a ValidationException with an - * IdempotentParameterMismatch error.

- *

Idempotent create APIs:

- *
    - *
  • - *

    CreateEnvironmentTemplate

    - *
  • - *
  • - *

    CreateServiceTemplate

    - *
  • - *
  • - *

    CreateEnvironment

    - *
  • - *
  • - *

    CreateService

    - *
  • - *
- *

- * Idempotent delete APIs - *

- *

Given a request action that has succeeded:

- *

When you retry the request with an API from this group and the resource was deleted, its metadata is returned in - * the response.

- *

If you retry and the resource doesn't exist, the response is empty.

- *

In both cases, the retry succeeds.

- *

Idempotent delete APIs:

- *
    - *
  • - *

    DeleteEnvironmentTemplate

    - *
  • - *
  • - *

    DeleteEnvironmentTemplateVersion

    - *
  • - *
  • - *

    DeleteServiceTemplate

    - *
  • - *
  • - *

    DeleteServiceTemplateVersion

    - *
  • - *
  • - *

    DeleteEnvironmentAccountConnection

    - *
  • - *
- *

- * Asynchronous idempotent delete APIs - *

- *

Given a request action that has succeeded:

- *

If you retry the request with an API from this group, if the original request delete operation status is - * DELETE_IN_PROGRESS, the retry returns the resource detail data in the response without performing any - * further actions.

- *

If the original request delete operation is complete, a retry returns an empty response.

- *

Asynchronous idempotent delete APIs:

- *
    - *
  • - *

    DeleteEnvironment

    - *
  • - *
  • - *

    DeleteService

    - *
  • - *
- */ -export class Proton extends ProtonClient { +const commands = { + AcceptEnvironmentAccountConnectionCommand, + CancelComponentDeploymentCommand, + CancelEnvironmentDeploymentCommand, + CancelServiceInstanceDeploymentCommand, + CancelServicePipelineDeploymentCommand, + CreateComponentCommand, + CreateEnvironmentCommand, + CreateEnvironmentAccountConnectionCommand, + CreateEnvironmentTemplateCommand, + CreateEnvironmentTemplateVersionCommand, + CreateRepositoryCommand, + CreateServiceCommand, + CreateServiceInstanceCommand, + CreateServiceSyncConfigCommand, + CreateServiceTemplateCommand, + CreateServiceTemplateVersionCommand, + CreateTemplateSyncConfigCommand, + DeleteComponentCommand, + DeleteEnvironmentCommand, + DeleteEnvironmentAccountConnectionCommand, + DeleteEnvironmentTemplateCommand, + DeleteEnvironmentTemplateVersionCommand, + DeleteRepositoryCommand, + DeleteServiceCommand, + DeleteServiceSyncConfigCommand, + DeleteServiceTemplateCommand, + DeleteServiceTemplateVersionCommand, + DeleteTemplateSyncConfigCommand, + GetAccountSettingsCommand, + GetComponentCommand, + GetEnvironmentCommand, + GetEnvironmentAccountConnectionCommand, + GetEnvironmentTemplateCommand, + GetEnvironmentTemplateVersionCommand, + GetRepositoryCommand, + GetRepositorySyncStatusCommand, + GetResourcesSummaryCommand, + GetServiceCommand, + GetServiceInstanceCommand, + GetServiceInstanceSyncStatusCommand, + GetServiceSyncBlockerSummaryCommand, + GetServiceSyncConfigCommand, + GetServiceTemplateCommand, + GetServiceTemplateVersionCommand, + GetTemplateSyncConfigCommand, + GetTemplateSyncStatusCommand, + ListComponentOutputsCommand, + ListComponentProvisionedResourcesCommand, + ListComponentsCommand, + ListEnvironmentAccountConnectionsCommand, + ListEnvironmentOutputsCommand, + ListEnvironmentProvisionedResourcesCommand, + ListEnvironmentsCommand, + ListEnvironmentTemplatesCommand, + ListEnvironmentTemplateVersionsCommand, + ListRepositoriesCommand, + ListRepositorySyncDefinitionsCommand, + ListServiceInstanceOutputsCommand, + ListServiceInstanceProvisionedResourcesCommand, + ListServiceInstancesCommand, + ListServicePipelineOutputsCommand, + ListServicePipelineProvisionedResourcesCommand, + ListServicesCommand, + ListServiceTemplatesCommand, + ListServiceTemplateVersionsCommand, + ListTagsForResourceCommand, + NotifyResourceDeploymentStatusChangeCommand, + RejectEnvironmentAccountConnectionCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAccountSettingsCommand, + UpdateComponentCommand, + UpdateEnvironmentCommand, + UpdateEnvironmentAccountConnectionCommand, + UpdateEnvironmentTemplateCommand, + UpdateEnvironmentTemplateVersionCommand, + UpdateServiceCommand, + UpdateServiceInstanceCommand, + UpdateServicePipelineCommand, + UpdateServiceSyncBlockerCommand, + UpdateServiceSyncConfigCommand, + UpdateServiceTemplateCommand, + UpdateServiceTemplateVersionCommand, + UpdateTemplateSyncConfigCommand, +}; + +export interface Proton { /** - * @public - *

In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, Proton - * can use the associated IAM role to provision environment infrastructure resources in the associated environment account.

- *

For more information, see Environment account - * connections in the Proton User guide.

+ * @see {@link AcceptEnvironmentAccountConnectionCommand} */ - public acceptEnvironmentAccountConnection( + acceptEnvironmentAccountConnection( args: AcceptEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptEnvironmentAccountConnection( + acceptEnvironmentAccountConnection( args: AcceptEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: AcceptEnvironmentAccountConnectionCommandOutput) => void ): void; - public acceptEnvironmentAccountConnection( + acceptEnvironmentAccountConnection( args: AcceptEnvironmentAccountConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptEnvironmentAccountConnectionCommandOutput) => void ): void; - public acceptEnvironmentAccountConnection( - args: AcceptEnvironmentAccountConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptEnvironmentAccountConnectionCommandOutput) => void), - cb?: (err: any, data?: AcceptEnvironmentAccountConnectionCommandOutput) => void - ): Promise | void { - const command = new AcceptEnvironmentAccountConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attempts to cancel a component deployment (for a component that is in the IN_PROGRESS deployment status).

- *

For more information about components, see - * Proton components in the - * Proton User Guide.

- */ - public cancelComponentDeployment( + + /** + * @see {@link CancelComponentDeploymentCommand} + */ + cancelComponentDeployment( args: CancelComponentDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelComponentDeployment( + cancelComponentDeployment( args: CancelComponentDeploymentCommandInput, cb: (err: any, data?: CancelComponentDeploymentCommandOutput) => void ): void; - public cancelComponentDeployment( + cancelComponentDeployment( args: CancelComponentDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelComponentDeploymentCommandOutput) => void ): void; - public cancelComponentDeployment( - args: CancelComponentDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelComponentDeploymentCommandOutput) => void), - cb?: (err: any, data?: CancelComponentDeploymentCommandOutput) => void - ): Promise | void { - const command = new CancelComponentDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is IN_PROGRESS. For more - * information, see Update an environment in the Proton - * User guide.

- *

The following list includes potential cancellation scenarios.

- *
    - *
  • - *

    If the cancellation attempt succeeds, the resulting deployment state is CANCELLED.

    - *
  • - *
  • - *

    If the cancellation attempt fails, the resulting deployment state is FAILED.

    - *
  • - *
  • - *

    If the current UpdateEnvironment action succeeds before the cancellation attempt starts, the resulting deployment state is - * SUCCEEDED and the cancellation attempt has no effect.

    - *
  • - *
- */ - public cancelEnvironmentDeployment( + + /** + * @see {@link CancelEnvironmentDeploymentCommand} + */ + cancelEnvironmentDeployment( args: CancelEnvironmentDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelEnvironmentDeployment( + cancelEnvironmentDeployment( args: CancelEnvironmentDeploymentCommandInput, cb: (err: any, data?: CancelEnvironmentDeploymentCommandOutput) => void ): void; - public cancelEnvironmentDeployment( + cancelEnvironmentDeployment( args: CancelEnvironmentDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelEnvironmentDeploymentCommandOutput) => void ): void; - public cancelEnvironmentDeployment( - args: CancelEnvironmentDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelEnvironmentDeploymentCommandOutput) => void), - cb?: (err: any, data?: CancelEnvironmentDeploymentCommandOutput) => void - ): Promise | void { - const command = new CancelEnvironmentDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is IN_PROGRESS. For - * more information, see Update a service instance - * in the Proton User guide.

- *

The following list includes potential cancellation scenarios.

- *
    - *
  • - *

    If the cancellation attempt succeeds, the resulting deployment state is - * CANCELLED.

    - *
  • - *
  • - *

    If the cancellation attempt fails, the resulting deployment state is - * FAILED.

    - *
  • - *
  • - *

    If the current UpdateServiceInstance action succeeds before the - * cancellation attempt starts, the resulting deployment state is SUCCEEDED and - * the cancellation attempt has no effect.

    - *
  • - *
- */ - public cancelServiceInstanceDeployment( + + /** + * @see {@link CancelServiceInstanceDeploymentCommand} + */ + cancelServiceInstanceDeployment( args: CancelServiceInstanceDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelServiceInstanceDeployment( + cancelServiceInstanceDeployment( args: CancelServiceInstanceDeploymentCommandInput, cb: (err: any, data?: CancelServiceInstanceDeploymentCommandOutput) => void ): void; - public cancelServiceInstanceDeployment( + cancelServiceInstanceDeployment( args: CancelServiceInstanceDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelServiceInstanceDeploymentCommandOutput) => void ): void; - public cancelServiceInstanceDeployment( - args: CancelServiceInstanceDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelServiceInstanceDeploymentCommandOutput) => void), - cb?: (err: any, data?: CancelServiceInstanceDeploymentCommandOutput) => void - ): Promise | void { - const command = new CancelServiceInstanceDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is IN_PROGRESS. For - * more information, see Update a service pipeline - * in the Proton User guide.

- *

The following list includes potential cancellation scenarios.

- *
    - *
  • - *

    If the cancellation attempt succeeds, the resulting deployment state is - * CANCELLED.

    - *
  • - *
  • - *

    If the cancellation attempt fails, the resulting deployment state is - * FAILED.

    - *
  • - *
  • - *

    If the current UpdateServicePipeline action succeeds before the - * cancellation attempt starts, the resulting deployment state is SUCCEEDED and - * the cancellation attempt has no effect.

    - *
  • - *
- */ - public cancelServicePipelineDeployment( + + /** + * @see {@link CancelServicePipelineDeploymentCommand} + */ + cancelServicePipelineDeployment( args: CancelServicePipelineDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelServicePipelineDeployment( + cancelServicePipelineDeployment( args: CancelServicePipelineDeploymentCommandInput, cb: (err: any, data?: CancelServicePipelineDeploymentCommandOutput) => void ): void; - public cancelServicePipelineDeployment( + cancelServicePipelineDeployment( args: CancelServicePipelineDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelServicePipelineDeploymentCommandOutput) => void ): void; - public cancelServicePipelineDeployment( - args: CancelServicePipelineDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelServicePipelineDeploymentCommandOutput) => void), - cb?: (err: any, data?: CancelServicePipelineDeploymentCommandOutput) => void - ): Promise | void { - const command = new CancelServicePipelineDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Create an Proton component. A component is an infrastructure extension for a service instance.

- *

For more information about components, see - * Proton components in the - * Proton User Guide.

- */ - public createComponent( + + /** + * @see {@link CreateComponentCommand} + */ + createComponent( args: CreateComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createComponent( - args: CreateComponentCommandInput, - cb: (err: any, data?: CreateComponentCommandOutput) => void - ): void; - public createComponent( + createComponent(args: CreateComponentCommandInput, cb: (err: any, data?: CreateComponentCommandOutput) => void): void; + createComponent( args: CreateComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateComponentCommandOutput) => void ): void; - public createComponent( - args: CreateComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateComponentCommandOutput) => void), - cb?: (err: any, data?: CreateComponentCommandOutput) => void - ): Promise | void { - const command = new CreateComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can be - * shared across services.

- *

- * You can provision environments using the following methods: - *

- *
    - *
  • - *

    Amazon Web Services-managed provisioning: Proton makes direct calls to provision your resources.

    - *
  • - *
  • - *

    Self-managed provisioning: Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your IaC - * engine uses to provision resources.

    - *
  • - *
- *

For more information, see Environments and Provisioning methods in the Proton User - * Guide.

- */ - public createEnvironment( + + /** + * @see {@link CreateEnvironmentCommand} + */ + createEnvironment( args: CreateEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEnvironment( + createEnvironment( args: CreateEnvironmentCommandInput, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void ): void; - public createEnvironment( + createEnvironment( args: CreateEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void ): void; - public createEnvironment( - args: CreateEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEnvironmentCommandOutput) => void), - cb?: (err: any, data?: CreateEnvironmentCommandOutput) => void - ): Promise | void { - const command = new CreateEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment - * account from a management account.

- *

An environment account connection is a secure bi-directional connection between a management account and an environment - * account that maintains authorization and permissions. For more information, see Environment account connections in the Proton User - * guide.

- */ - public createEnvironmentAccountConnection( + + /** + * @see {@link CreateEnvironmentAccountConnectionCommand} + */ + createEnvironmentAccountConnection( args: CreateEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEnvironmentAccountConnection( + createEnvironmentAccountConnection( args: CreateEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: CreateEnvironmentAccountConnectionCommandOutput) => void ): void; - public createEnvironmentAccountConnection( + createEnvironmentAccountConnection( args: CreateEnvironmentAccountConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentAccountConnectionCommandOutput) => void ): void; - public createEnvironmentAccountConnection( - args: CreateEnvironmentAccountConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEnvironmentAccountConnectionCommandOutput) => void), - cb?: (err: any, data?: CreateEnvironmentAccountConnectionCommandOutput) => void - ): Promise | void { - const command = new CreateEnvironmentAccountConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Create an environment template for Proton. For more information, see Environment Templates in the Proton User Guide.

- *

You can create an environment template in one of the two following ways:

- *
    - *
  • - *

    Register and publish a standard environment template that instructs Proton to deploy and manage environment - * infrastructure.

    - *
  • - *
  • - *

    Register and publish a customer managed environment template that connects Proton to your existing provisioned - * infrastructure that you manage. Proton doesn't manage your existing provisioned infrastructure. To create an environment - * template for customer provisioned and managed infrastructure, include the provisioning parameter and set the value to - * CUSTOMER_MANAGED. For more information, see Register - * and publish an environment template in the Proton User Guide.

    - *
  • - *
- */ - public createEnvironmentTemplate( + + /** + * @see {@link CreateEnvironmentTemplateCommand} + */ + createEnvironmentTemplate( args: CreateEnvironmentTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEnvironmentTemplate( + createEnvironmentTemplate( args: CreateEnvironmentTemplateCommandInput, cb: (err: any, data?: CreateEnvironmentTemplateCommandOutput) => void ): void; - public createEnvironmentTemplate( + createEnvironmentTemplate( args: CreateEnvironmentTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentTemplateCommandOutput) => void ): void; - public createEnvironmentTemplate( - args: CreateEnvironmentTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEnvironmentTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateEnvironmentTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateEnvironmentTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Create a new major or minor version of an environment template. A major version of an environment template is a version that - * isn't backwards compatible. A minor version of an environment template is a version that's backwards compatible within its major - * version.

- */ - public createEnvironmentTemplateVersion( + + /** + * @see {@link CreateEnvironmentTemplateVersionCommand} + */ + createEnvironmentTemplateVersion( args: CreateEnvironmentTemplateVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEnvironmentTemplateVersion( + createEnvironmentTemplateVersion( args: CreateEnvironmentTemplateVersionCommandInput, cb: (err: any, data?: CreateEnvironmentTemplateVersionCommandOutput) => void ): void; - public createEnvironmentTemplateVersion( + createEnvironmentTemplateVersion( args: CreateEnvironmentTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentTemplateVersionCommandOutput) => void ): void; - public createEnvironmentTemplateVersion( - args: CreateEnvironmentTemplateVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEnvironmentTemplateVersionCommandOutput) => void), - cb?: (err: any, data?: CreateEnvironmentTemplateVersionCommandOutput) => void - ): Promise | void { - const command = new CreateEnvironmentTemplateVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Create and register a link to a repository. Proton uses the link to repeatedly access the repository, to either push to it (self-managed - * provisioning) or pull from it (template sync). You can share a linked repository across multiple resources (like environments using self-managed - * provisioning, or synced templates). When you create a repository link, Proton creates a service-linked role for you.

- *

For more information, see Self-managed provisioning, Template bundles, and - * Template sync configurations in the Proton - * User Guide.

- */ - public createRepository( + + /** + * @see {@link CreateRepositoryCommand} + */ + createRepository( args: CreateRepositoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRepository( + createRepository( args: CreateRepositoryCommandInput, cb: (err: any, data?: CreateRepositoryCommandOutput) => void ): void; - public createRepository( + createRepository( args: CreateRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRepositoryCommandOutput) => void ): void; - public createRepository( - args: CreateRepositoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRepositoryCommandOutput) => void), - cb?: (err: any, data?: CreateRepositoryCommandOutput) => void - ): Promise | void { - const command = new CreateRepositoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Create an Proton service. An Proton service is an instantiation of a service - * template and often includes several service instances and pipeline. For more information, see - * Services - * in the Proton User Guide.

- */ - public createService( - args: CreateServiceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createService( - args: CreateServiceCommandInput, - cb: (err: any, data?: CreateServiceCommandOutput) => void - ): void; - public createService( + + /** + * @see {@link CreateServiceCommand} + */ + createService(args: CreateServiceCommandInput, options?: __HttpHandlerOptions): Promise; + createService(args: CreateServiceCommandInput, cb: (err: any, data?: CreateServiceCommandOutput) => void): void; + createService( args: CreateServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceCommandOutput) => void ): void; - public createService( - args: CreateServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateServiceCommandOutput) => void), - cb?: (err: any, data?: CreateServiceCommandOutput) => void - ): Promise | void { - const command = new CreateServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Create a service instance.

- */ - public createServiceInstance( + + /** + * @see {@link CreateServiceInstanceCommand} + */ + createServiceInstance( args: CreateServiceInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createServiceInstance( + createServiceInstance( args: CreateServiceInstanceCommandInput, cb: (err: any, data?: CreateServiceInstanceCommandOutput) => void ): void; - public createServiceInstance( + createServiceInstance( args: CreateServiceInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceInstanceCommandOutput) => void ): void; - public createServiceInstance( - args: CreateServiceInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateServiceInstanceCommandOutput) => void), - cb?: (err: any, data?: CreateServiceInstanceCommandOutput) => void - ): Promise | void { - const command = new CreateServiceInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Create the Proton Ops configuration file.

- */ - public createServiceSyncConfig( + + /** + * @see {@link CreateServiceSyncConfigCommand} + */ + createServiceSyncConfig( args: CreateServiceSyncConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public createServiceSyncConfig( + createServiceSyncConfig( args: CreateServiceSyncConfigCommandInput, cb: (err: any, data?: CreateServiceSyncConfigCommandOutput) => void ): void; - public createServiceSyncConfig( + createServiceSyncConfig( args: CreateServiceSyncConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceSyncConfigCommandOutput) => void ): void; - public createServiceSyncConfig( - args: CreateServiceSyncConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateServiceSyncConfigCommandOutput) => void), - cb?: (err: any, data?: CreateServiceSyncConfigCommandOutput) => void - ): Promise | void { - const command = new CreateServiceSyncConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Create a service template. The administrator creates a service template to define - * standardized infrastructure and an optional CI/CD service pipeline. Developers, in turn, - * select the service template from Proton. If the selected service template includes a - * service pipeline definition, they provide a link to their source code repository. Proton - * then deploys and manages the infrastructure defined by the selected service template. For more - * information, see Proton templates in the Proton User Guide.

- */ - public createServiceTemplate( + + /** + * @see {@link CreateServiceTemplateCommand} + */ + createServiceTemplate( args: CreateServiceTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createServiceTemplate( + createServiceTemplate( args: CreateServiceTemplateCommandInput, cb: (err: any, data?: CreateServiceTemplateCommandOutput) => void ): void; - public createServiceTemplate( + createServiceTemplate( args: CreateServiceTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceTemplateCommandOutput) => void ): void; - public createServiceTemplate( - args: CreateServiceTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateServiceTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateServiceTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateServiceTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Create a new major or minor version of a service template. A major version of a service - * template is a version that isn't backward compatible. A minor version of - * a service template is a version that's backward compatible within its major version.

- */ - public createServiceTemplateVersion( + + /** + * @see {@link CreateServiceTemplateVersionCommand} + */ + createServiceTemplateVersion( args: CreateServiceTemplateVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createServiceTemplateVersion( + createServiceTemplateVersion( args: CreateServiceTemplateVersionCommandInput, cb: (err: any, data?: CreateServiceTemplateVersionCommandOutput) => void ): void; - public createServiceTemplateVersion( + createServiceTemplateVersion( args: CreateServiceTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceTemplateVersionCommandOutput) => void ): void; - public createServiceTemplateVersion( - args: CreateServiceTemplateVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateServiceTemplateVersionCommandOutput) => void), - cb?: (err: any, data?: CreateServiceTemplateVersionCommandOutput) => void - ): Promise | void { - const command = new CreateServiceTemplateVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Set up a template to create new template versions automatically by tracking a linked - * repository. A linked repository is a repository that has been registered with Proton. For more - * information, see CreateRepository.

- *

When a commit is pushed to your linked repository, Proton checks for changes to your - * repository template bundles. If it detects a template bundle change, a new major or minor version - * of its template is created, if the version doesn’t already exist. For more information, see - * Template - * sync configurations in the Proton User Guide.

- */ - public createTemplateSyncConfig( + + /** + * @see {@link CreateTemplateSyncConfigCommand} + */ + createTemplateSyncConfig( args: CreateTemplateSyncConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTemplateSyncConfig( + createTemplateSyncConfig( args: CreateTemplateSyncConfigCommandInput, cb: (err: any, data?: CreateTemplateSyncConfigCommandOutput) => void ): void; - public createTemplateSyncConfig( + createTemplateSyncConfig( args: CreateTemplateSyncConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTemplateSyncConfigCommandOutput) => void ): void; - public createTemplateSyncConfig( - args: CreateTemplateSyncConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTemplateSyncConfigCommandOutput) => void), - cb?: (err: any, data?: CreateTemplateSyncConfigCommandOutput) => void - ): Promise | void { - const command = new CreateTemplateSyncConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete an Proton component resource.

- *

For more information about components, see - * Proton components in the - * Proton User Guide.

- */ - public deleteComponent( + + /** + * @see {@link DeleteComponentCommand} + */ + deleteComponent( args: DeleteComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteComponent( - args: DeleteComponentCommandInput, - cb: (err: any, data?: DeleteComponentCommandOutput) => void - ): void; - public deleteComponent( + deleteComponent(args: DeleteComponentCommandInput, cb: (err: any, data?: DeleteComponentCommandOutput) => void): void; + deleteComponent( args: DeleteComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteComponentCommandOutput) => void ): void; - public deleteComponent( - args: DeleteComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteComponentCommandOutput) => void), - cb?: (err: any, data?: DeleteComponentCommandOutput) => void - ): Promise | void { - const command = new DeleteComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete an environment.

- */ - public deleteEnvironment( + + /** + * @see {@link DeleteEnvironmentCommand} + */ + deleteEnvironment( args: DeleteEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEnvironment( + deleteEnvironment( args: DeleteEnvironmentCommandInput, cb: (err: any, data?: DeleteEnvironmentCommandOutput) => void ): void; - public deleteEnvironment( + deleteEnvironment( args: DeleteEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEnvironmentCommandOutput) => void ): void; - public deleteEnvironment( - args: DeleteEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEnvironmentCommandOutput) => void), - cb?: (err: any, data?: DeleteEnvironmentCommandOutput) => void - ): Promise | void { - const command = new DeleteEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

In an environment account, delete an environment account connection.

- *

After you delete an environment account connection that’s in use by an Proton environment, Proton can’t manage the - * environment infrastructure resources until a new environment account connection is accepted for the environment account and associated environment. You're - * responsible for cleaning up provisioned resources that remain without an environment connection.

- *

For more information, see Environment account - * connections in the Proton User guide.

- */ - public deleteEnvironmentAccountConnection( + + /** + * @see {@link DeleteEnvironmentAccountConnectionCommand} + */ + deleteEnvironmentAccountConnection( args: DeleteEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEnvironmentAccountConnection( + deleteEnvironmentAccountConnection( args: DeleteEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: DeleteEnvironmentAccountConnectionCommandOutput) => void ): void; - public deleteEnvironmentAccountConnection( + deleteEnvironmentAccountConnection( args: DeleteEnvironmentAccountConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEnvironmentAccountConnectionCommandOutput) => void ): void; - public deleteEnvironmentAccountConnection( - args: DeleteEnvironmentAccountConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEnvironmentAccountConnectionCommandOutput) => void), - cb?: (err: any, data?: DeleteEnvironmentAccountConnectionCommandOutput) => void - ): Promise | void { - const command = new DeleteEnvironmentAccountConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

If no other major or minor versions of an environment template exist, delete the environment template.

- */ - public deleteEnvironmentTemplate( + + /** + * @see {@link DeleteEnvironmentTemplateCommand} + */ + deleteEnvironmentTemplate( args: DeleteEnvironmentTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEnvironmentTemplate( + deleteEnvironmentTemplate( args: DeleteEnvironmentTemplateCommandInput, cb: (err: any, data?: DeleteEnvironmentTemplateCommandOutput) => void ): void; - public deleteEnvironmentTemplate( + deleteEnvironmentTemplate( args: DeleteEnvironmentTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEnvironmentTemplateCommandOutput) => void ): void; - public deleteEnvironmentTemplate( - args: DeleteEnvironmentTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEnvironmentTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteEnvironmentTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteEnvironmentTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

If no other minor versions of an environment template exist, delete a major version of the environment template if it's not the - * Recommended version. Delete the Recommended version of the environment template if no other major versions or minor versions - * of the environment template exist. A major version of an environment template is a version that's not backward compatible.

- *

Delete a minor version of an environment template if it isn't the Recommended version. Delete a - * Recommended minor version of the environment template if no other minor versions of the environment template exist. A minor version of an - * environment template is a version that's backward compatible.

- */ - public deleteEnvironmentTemplateVersion( + + /** + * @see {@link DeleteEnvironmentTemplateVersionCommand} + */ + deleteEnvironmentTemplateVersion( args: DeleteEnvironmentTemplateVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEnvironmentTemplateVersion( + deleteEnvironmentTemplateVersion( args: DeleteEnvironmentTemplateVersionCommandInput, cb: (err: any, data?: DeleteEnvironmentTemplateVersionCommandOutput) => void ): void; - public deleteEnvironmentTemplateVersion( + deleteEnvironmentTemplateVersion( args: DeleteEnvironmentTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEnvironmentTemplateVersionCommandOutput) => void ): void; - public deleteEnvironmentTemplateVersion( - args: DeleteEnvironmentTemplateVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEnvironmentTemplateVersionCommandOutput) => void), - cb?: (err: any, data?: DeleteEnvironmentTemplateVersionCommandOutput) => void - ): Promise | void { - const command = new DeleteEnvironmentTemplateVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

De-register and unlink your repository.

- */ - public deleteRepository( + + /** + * @see {@link DeleteRepositoryCommand} + */ + deleteRepository( args: DeleteRepositoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRepository( + deleteRepository( args: DeleteRepositoryCommandInput, cb: (err: any, data?: DeleteRepositoryCommandOutput) => void ): void; - public deleteRepository( + deleteRepository( args: DeleteRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRepositoryCommandOutput) => void ): void; - public deleteRepository( - args: DeleteRepositoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRepositoryCommandOutput) => void), - cb?: (err: any, data?: DeleteRepositoryCommandOutput) => void - ): Promise | void { - const command = new DeleteRepositoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete a service, with its instances and pipeline.

- * - *

You can't delete a service if it has any service instances that have components attached - * to them.

- *

For more information about components, see - * Proton components in the - * Proton User Guide.

- *
- */ - public deleteService( - args: DeleteServiceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteService( - args: DeleteServiceCommandInput, - cb: (err: any, data?: DeleteServiceCommandOutput) => void - ): void; - public deleteService( + + /** + * @see {@link DeleteServiceCommand} + */ + deleteService(args: DeleteServiceCommandInput, options?: __HttpHandlerOptions): Promise; + deleteService(args: DeleteServiceCommandInput, cb: (err: any, data?: DeleteServiceCommandOutput) => void): void; + deleteService( args: DeleteServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceCommandOutput) => void ): void; - public deleteService( - args: DeleteServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteServiceCommandOutput) => void), - cb?: (err: any, data?: DeleteServiceCommandOutput) => void - ): Promise | void { - const command = new DeleteServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete the Proton Ops file.

- */ - public deleteServiceSyncConfig( + + /** + * @see {@link DeleteServiceSyncConfigCommand} + */ + deleteServiceSyncConfig( args: DeleteServiceSyncConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteServiceSyncConfig( + deleteServiceSyncConfig( args: DeleteServiceSyncConfigCommandInput, cb: (err: any, data?: DeleteServiceSyncConfigCommandOutput) => void ): void; - public deleteServiceSyncConfig( + deleteServiceSyncConfig( args: DeleteServiceSyncConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceSyncConfigCommandOutput) => void ): void; - public deleteServiceSyncConfig( - args: DeleteServiceSyncConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteServiceSyncConfigCommandOutput) => void), - cb?: (err: any, data?: DeleteServiceSyncConfigCommandOutput) => void - ): Promise | void { - const command = new DeleteServiceSyncConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

If no other major or minor versions of the service template exist, delete the service - * template.

- */ - public deleteServiceTemplate( + + /** + * @see {@link DeleteServiceTemplateCommand} + */ + deleteServiceTemplate( args: DeleteServiceTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteServiceTemplate( + deleteServiceTemplate( args: DeleteServiceTemplateCommandInput, cb: (err: any, data?: DeleteServiceTemplateCommandOutput) => void ): void; - public deleteServiceTemplate( + deleteServiceTemplate( args: DeleteServiceTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceTemplateCommandOutput) => void ): void; - public deleteServiceTemplate( - args: DeleteServiceTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteServiceTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteServiceTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteServiceTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

If no other minor versions of a service template exist, delete a major version of the - * service template if it's not the Recommended version. Delete the - * Recommended version of the service template if no other major versions or minor - * versions of the service template exist. A major version of a service template is a version - * that isn't backwards compatible.

- *

Delete a minor version of a service template if it's not the Recommended - * version. Delete a Recommended minor version of the service template if no other - * minor versions of the service template exist. A minor version of a service template is a - * version that's backwards compatible.

- */ - public deleteServiceTemplateVersion( + + /** + * @see {@link DeleteServiceTemplateVersionCommand} + */ + deleteServiceTemplateVersion( args: DeleteServiceTemplateVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteServiceTemplateVersion( + deleteServiceTemplateVersion( args: DeleteServiceTemplateVersionCommandInput, cb: (err: any, data?: DeleteServiceTemplateVersionCommandOutput) => void ): void; - public deleteServiceTemplateVersion( + deleteServiceTemplateVersion( args: DeleteServiceTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceTemplateVersionCommandOutput) => void ): void; - public deleteServiceTemplateVersion( - args: DeleteServiceTemplateVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteServiceTemplateVersionCommandOutput) => void), - cb?: (err: any, data?: DeleteServiceTemplateVersionCommandOutput) => void - ): Promise | void { - const command = new DeleteServiceTemplateVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete a template sync configuration.

- */ - public deleteTemplateSyncConfig( + + /** + * @see {@link DeleteTemplateSyncConfigCommand} + */ + deleteTemplateSyncConfig( args: DeleteTemplateSyncConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTemplateSyncConfig( + deleteTemplateSyncConfig( args: DeleteTemplateSyncConfigCommandInput, cb: (err: any, data?: DeleteTemplateSyncConfigCommandOutput) => void ): void; - public deleteTemplateSyncConfig( + deleteTemplateSyncConfig( args: DeleteTemplateSyncConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTemplateSyncConfigCommandOutput) => void ): void; - public deleteTemplateSyncConfig( - args: DeleteTemplateSyncConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTemplateSyncConfigCommandOutput) => void), - cb?: (err: any, data?: DeleteTemplateSyncConfigCommandOutput) => void - ): Promise | void { - const command = new DeleteTemplateSyncConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get detail data for Proton account-wide settings.

- */ - public getAccountSettings( + + /** + * @see {@link GetAccountSettingsCommand} + */ + getAccountSettings( args: GetAccountSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccountSettings( + getAccountSettings( args: GetAccountSettingsCommandInput, cb: (err: any, data?: GetAccountSettingsCommandOutput) => void ): void; - public getAccountSettings( + getAccountSettings( args: GetAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountSettingsCommandOutput) => void ): void; - public getAccountSettings( - args: GetAccountSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccountSettingsCommandOutput) => void), - cb?: (err: any, data?: GetAccountSettingsCommandOutput) => void - ): Promise | void { - const command = new GetAccountSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get detailed data for a component.

- *

For more information about components, see - * Proton components in the - * Proton User Guide.

- */ - public getComponent( - args: GetComponentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getComponent(args: GetComponentCommandInput, cb: (err: any, data?: GetComponentCommandOutput) => void): void; - public getComponent( + + /** + * @see {@link GetComponentCommand} + */ + getComponent(args: GetComponentCommandInput, options?: __HttpHandlerOptions): Promise; + getComponent(args: GetComponentCommandInput, cb: (err: any, data?: GetComponentCommandOutput) => void): void; + getComponent( args: GetComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComponentCommandOutput) => void ): void; - public getComponent( - args: GetComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetComponentCommandOutput) => void), - cb?: (err: any, data?: GetComponentCommandOutput) => void - ): Promise | void { - const command = new GetComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get detailed data for an environment.

- */ - public getEnvironment( + + /** + * @see {@link GetEnvironmentCommand} + */ + getEnvironment( args: GetEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEnvironment( - args: GetEnvironmentCommandInput, - cb: (err: any, data?: GetEnvironmentCommandOutput) => void - ): void; - public getEnvironment( + getEnvironment(args: GetEnvironmentCommandInput, cb: (err: any, data?: GetEnvironmentCommandOutput) => void): void; + getEnvironment( args: GetEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEnvironmentCommandOutput) => void ): void; - public getEnvironment( - args: GetEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEnvironmentCommandOutput) => void), - cb?: (err: any, data?: GetEnvironmentCommandOutput) => void - ): Promise | void { - const command = new GetEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

In an environment account, get the detailed data for an environment account connection.

- *

For more information, see Environment account - * connections in the Proton User guide.

- */ - public getEnvironmentAccountConnection( + + /** + * @see {@link GetEnvironmentAccountConnectionCommand} + */ + getEnvironmentAccountConnection( args: GetEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEnvironmentAccountConnection( + getEnvironmentAccountConnection( args: GetEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: GetEnvironmentAccountConnectionCommandOutput) => void ): void; - public getEnvironmentAccountConnection( + getEnvironmentAccountConnection( args: GetEnvironmentAccountConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEnvironmentAccountConnectionCommandOutput) => void ): void; - public getEnvironmentAccountConnection( - args: GetEnvironmentAccountConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEnvironmentAccountConnectionCommandOutput) => void), - cb?: (err: any, data?: GetEnvironmentAccountConnectionCommandOutput) => void - ): Promise | void { - const command = new GetEnvironmentAccountConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get detailed data for an environment template.

- */ - public getEnvironmentTemplate( + + /** + * @see {@link GetEnvironmentTemplateCommand} + */ + getEnvironmentTemplate( args: GetEnvironmentTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEnvironmentTemplate( + getEnvironmentTemplate( args: GetEnvironmentTemplateCommandInput, cb: (err: any, data?: GetEnvironmentTemplateCommandOutput) => void ): void; - public getEnvironmentTemplate( + getEnvironmentTemplate( args: GetEnvironmentTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEnvironmentTemplateCommandOutput) => void ): void; - public getEnvironmentTemplate( - args: GetEnvironmentTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEnvironmentTemplateCommandOutput) => void), - cb?: (err: any, data?: GetEnvironmentTemplateCommandOutput) => void - ): Promise | void { - const command = new GetEnvironmentTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get detailed data for a major or minor version of an environment template.

- */ - public getEnvironmentTemplateVersion( + + /** + * @see {@link GetEnvironmentTemplateVersionCommand} + */ + getEnvironmentTemplateVersion( args: GetEnvironmentTemplateVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEnvironmentTemplateVersion( + getEnvironmentTemplateVersion( args: GetEnvironmentTemplateVersionCommandInput, cb: (err: any, data?: GetEnvironmentTemplateVersionCommandOutput) => void ): void; - public getEnvironmentTemplateVersion( + getEnvironmentTemplateVersion( args: GetEnvironmentTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEnvironmentTemplateVersionCommandOutput) => void ): void; - public getEnvironmentTemplateVersion( - args: GetEnvironmentTemplateVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEnvironmentTemplateVersionCommandOutput) => void), - cb?: (err: any, data?: GetEnvironmentTemplateVersionCommandOutput) => void - ): Promise | void { - const command = new GetEnvironmentTemplateVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get detail data for a linked repository.

- */ - public getRepository( - args: GetRepositoryCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getRepository( - args: GetRepositoryCommandInput, - cb: (err: any, data?: GetRepositoryCommandOutput) => void - ): void; - public getRepository( + + /** + * @see {@link GetRepositoryCommand} + */ + getRepository(args: GetRepositoryCommandInput, options?: __HttpHandlerOptions): Promise; + getRepository(args: GetRepositoryCommandInput, cb: (err: any, data?: GetRepositoryCommandOutput) => void): void; + getRepository( args: GetRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRepositoryCommandOutput) => void ): void; - public getRepository( - args: GetRepositoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRepositoryCommandOutput) => void), - cb?: (err: any, data?: GetRepositoryCommandOutput) => void - ): Promise | void { - const command = new GetRepositoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get the sync status of a repository used for Proton template sync. For more information about template sync, see .

- * - *

A repository sync status isn't tied to the Proton Repository resource (or any other Proton resource). Therefore, tags on an Proton Repository resource - * have no effect on this action. Specifically, you can't use these tags to control access to this action using Attribute-based access control - * (ABAC).

- *

For more information about ABAC, see ABAC in the Proton User - * Guide.

- *
- */ - public getRepositorySyncStatus( + + /** + * @see {@link GetRepositorySyncStatusCommand} + */ + getRepositorySyncStatus( args: GetRepositorySyncStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRepositorySyncStatus( + getRepositorySyncStatus( args: GetRepositorySyncStatusCommandInput, cb: (err: any, data?: GetRepositorySyncStatusCommandOutput) => void ): void; - public getRepositorySyncStatus( + getRepositorySyncStatus( args: GetRepositorySyncStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRepositorySyncStatusCommandOutput) => void ): void; - public getRepositorySyncStatus( - args: GetRepositorySyncStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRepositorySyncStatusCommandOutput) => void), - cb?: (err: any, data?: GetRepositorySyncStatusCommandOutput) => void - ): Promise | void { - const command = new GetRepositorySyncStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get counts of Proton resources.

- *

For infrastructure-provisioning resources (environments, services, service instances, - * pipelines), the action returns staleness counts. A resource is stale when it's behind the - * recommended version of the Proton template that it uses and it needs an update to become - * current.

- *

The action returns staleness counts (counts of resources that are up-to-date, behind a - * template major version, or behind a template minor version), the total number of resources, and - * the number of resources that are in a failed state, grouped by resource type. Components, - * environments, and service templates return less information - see the components, - * environments, and serviceTemplates field descriptions.

- *

For context, the action also returns the total number of each type of Proton template in the - * Amazon Web Services account.

- *

For more information, see Proton dashboard in the - * Proton User Guide.

- */ - public getResourcesSummary( + + /** + * @see {@link GetResourcesSummaryCommand} + */ + getResourcesSummary( args: GetResourcesSummaryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourcesSummary( + getResourcesSummary( args: GetResourcesSummaryCommandInput, cb: (err: any, data?: GetResourcesSummaryCommandOutput) => void ): void; - public getResourcesSummary( + getResourcesSummary( args: GetResourcesSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcesSummaryCommandOutput) => void ): void; - public getResourcesSummary( - args: GetResourcesSummaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourcesSummaryCommandOutput) => void), - cb?: (err: any, data?: GetResourcesSummaryCommandOutput) => void - ): Promise | void { - const command = new GetResourcesSummaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get detailed data for a service.

- */ - public getService(args: GetServiceCommandInput, options?: __HttpHandlerOptions): Promise; - public getService(args: GetServiceCommandInput, cb: (err: any, data?: GetServiceCommandOutput) => void): void; - public getService( + + /** + * @see {@link GetServiceCommand} + */ + getService(args: GetServiceCommandInput, options?: __HttpHandlerOptions): Promise; + getService(args: GetServiceCommandInput, cb: (err: any, data?: GetServiceCommandOutput) => void): void; + getService( args: GetServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceCommandOutput) => void ): void; - public getService( - args: GetServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceCommandOutput) => void), - cb?: (err: any, data?: GetServiceCommandOutput) => void - ): Promise | void { - const command = new GetServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get detailed data for a service instance. A service instance is an instantiation of - * service template and it runs in a specific environment.

- */ - public getServiceInstance( + + /** + * @see {@link GetServiceInstanceCommand} + */ + getServiceInstance( args: GetServiceInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServiceInstance( + getServiceInstance( args: GetServiceInstanceCommandInput, cb: (err: any, data?: GetServiceInstanceCommandOutput) => void ): void; - public getServiceInstance( + getServiceInstance( args: GetServiceInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceInstanceCommandOutput) => void ): void; - public getServiceInstance( - args: GetServiceInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceInstanceCommandOutput) => void), - cb?: (err: any, data?: GetServiceInstanceCommandOutput) => void - ): Promise | void { - const command = new GetServiceInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get the status of the synced service instance.

- */ - public getServiceInstanceSyncStatus( + + /** + * @see {@link GetServiceInstanceSyncStatusCommand} + */ + getServiceInstanceSyncStatus( args: GetServiceInstanceSyncStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServiceInstanceSyncStatus( + getServiceInstanceSyncStatus( args: GetServiceInstanceSyncStatusCommandInput, cb: (err: any, data?: GetServiceInstanceSyncStatusCommandOutput) => void ): void; - public getServiceInstanceSyncStatus( + getServiceInstanceSyncStatus( args: GetServiceInstanceSyncStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceInstanceSyncStatusCommandOutput) => void ): void; - public getServiceInstanceSyncStatus( - args: GetServiceInstanceSyncStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceInstanceSyncStatusCommandOutput) => void), - cb?: (err: any, data?: GetServiceInstanceSyncStatusCommandOutput) => void - ): Promise | void { - const command = new GetServiceInstanceSyncStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get detailed data for the service sync blocker summary.

- */ - public getServiceSyncBlockerSummary( + + /** + * @see {@link GetServiceSyncBlockerSummaryCommand} + */ + getServiceSyncBlockerSummary( args: GetServiceSyncBlockerSummaryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServiceSyncBlockerSummary( + getServiceSyncBlockerSummary( args: GetServiceSyncBlockerSummaryCommandInput, cb: (err: any, data?: GetServiceSyncBlockerSummaryCommandOutput) => void ): void; - public getServiceSyncBlockerSummary( + getServiceSyncBlockerSummary( args: GetServiceSyncBlockerSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceSyncBlockerSummaryCommandOutput) => void ): void; - public getServiceSyncBlockerSummary( - args: GetServiceSyncBlockerSummaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceSyncBlockerSummaryCommandOutput) => void), - cb?: (err: any, data?: GetServiceSyncBlockerSummaryCommandOutput) => void - ): Promise | void { - const command = new GetServiceSyncBlockerSummaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get detailed information for the service sync configuration.

- */ - public getServiceSyncConfig( + + /** + * @see {@link GetServiceSyncConfigCommand} + */ + getServiceSyncConfig( args: GetServiceSyncConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServiceSyncConfig( + getServiceSyncConfig( args: GetServiceSyncConfigCommandInput, cb: (err: any, data?: GetServiceSyncConfigCommandOutput) => void ): void; - public getServiceSyncConfig( + getServiceSyncConfig( args: GetServiceSyncConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceSyncConfigCommandOutput) => void ): void; - public getServiceSyncConfig( - args: GetServiceSyncConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceSyncConfigCommandOutput) => void), - cb?: (err: any, data?: GetServiceSyncConfigCommandOutput) => void - ): Promise | void { - const command = new GetServiceSyncConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get detailed data for a service template.

- */ - public getServiceTemplate( + + /** + * @see {@link GetServiceTemplateCommand} + */ + getServiceTemplate( args: GetServiceTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServiceTemplate( + getServiceTemplate( args: GetServiceTemplateCommandInput, cb: (err: any, data?: GetServiceTemplateCommandOutput) => void ): void; - public getServiceTemplate( + getServiceTemplate( args: GetServiceTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceTemplateCommandOutput) => void ): void; - public getServiceTemplate( - args: GetServiceTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceTemplateCommandOutput) => void), - cb?: (err: any, data?: GetServiceTemplateCommandOutput) => void - ): Promise | void { - const command = new GetServiceTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get detailed data for a major or minor version of a service template.

- */ - public getServiceTemplateVersion( + + /** + * @see {@link GetServiceTemplateVersionCommand} + */ + getServiceTemplateVersion( args: GetServiceTemplateVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServiceTemplateVersion( + getServiceTemplateVersion( args: GetServiceTemplateVersionCommandInput, cb: (err: any, data?: GetServiceTemplateVersionCommandOutput) => void ): void; - public getServiceTemplateVersion( + getServiceTemplateVersion( args: GetServiceTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceTemplateVersionCommandOutput) => void ): void; - public getServiceTemplateVersion( - args: GetServiceTemplateVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceTemplateVersionCommandOutput) => void), - cb?: (err: any, data?: GetServiceTemplateVersionCommandOutput) => void - ): Promise | void { - const command = new GetServiceTemplateVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get detail data for a template sync configuration.

- */ - public getTemplateSyncConfig( + + /** + * @see {@link GetTemplateSyncConfigCommand} + */ + getTemplateSyncConfig( args: GetTemplateSyncConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTemplateSyncConfig( + getTemplateSyncConfig( args: GetTemplateSyncConfigCommandInput, cb: (err: any, data?: GetTemplateSyncConfigCommandOutput) => void ): void; - public getTemplateSyncConfig( + getTemplateSyncConfig( args: GetTemplateSyncConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTemplateSyncConfigCommandOutput) => void ): void; - public getTemplateSyncConfig( - args: GetTemplateSyncConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTemplateSyncConfigCommandOutput) => void), - cb?: (err: any, data?: GetTemplateSyncConfigCommandOutput) => void - ): Promise | void { - const command = new GetTemplateSyncConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get the status of a template sync.

- */ - public getTemplateSyncStatus( + + /** + * @see {@link GetTemplateSyncStatusCommand} + */ + getTemplateSyncStatus( args: GetTemplateSyncStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTemplateSyncStatus( + getTemplateSyncStatus( args: GetTemplateSyncStatusCommandInput, cb: (err: any, data?: GetTemplateSyncStatusCommandOutput) => void ): void; - public getTemplateSyncStatus( + getTemplateSyncStatus( args: GetTemplateSyncStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTemplateSyncStatusCommandOutput) => void ): void; - public getTemplateSyncStatus( - args: GetTemplateSyncStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTemplateSyncStatusCommandOutput) => void), - cb?: (err: any, data?: GetTemplateSyncStatusCommandOutput) => void - ): Promise | void { - const command = new GetTemplateSyncStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get a list of component Infrastructure as Code (IaC) outputs.

- *

For more information about components, see - * Proton components in the - * Proton User Guide.

- */ - public listComponentOutputs( + + /** + * @see {@link ListComponentOutputsCommand} + */ + listComponentOutputs( args: ListComponentOutputsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listComponentOutputs( + listComponentOutputs( args: ListComponentOutputsCommandInput, cb: (err: any, data?: ListComponentOutputsCommandOutput) => void ): void; - public listComponentOutputs( + listComponentOutputs( args: ListComponentOutputsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComponentOutputsCommandOutput) => void ): void; - public listComponentOutputs( - args: ListComponentOutputsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListComponentOutputsCommandOutput) => void), - cb?: (err: any, data?: ListComponentOutputsCommandOutput) => void - ): Promise | void { - const command = new ListComponentOutputsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List provisioned resources for a component with details.

- *

For more information about components, see - * Proton components in the - * Proton User Guide.

- */ - public listComponentProvisionedResources( + + /** + * @see {@link ListComponentProvisionedResourcesCommand} + */ + listComponentProvisionedResources( args: ListComponentProvisionedResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listComponentProvisionedResources( + listComponentProvisionedResources( args: ListComponentProvisionedResourcesCommandInput, cb: (err: any, data?: ListComponentProvisionedResourcesCommandOutput) => void ): void; - public listComponentProvisionedResources( + listComponentProvisionedResources( args: ListComponentProvisionedResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComponentProvisionedResourcesCommandOutput) => void ): void; - public listComponentProvisionedResources( - args: ListComponentProvisionedResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListComponentProvisionedResourcesCommandOutput) => void), - cb?: (err: any, data?: ListComponentProvisionedResourcesCommandOutput) => void - ): Promise | void { - const command = new ListComponentProvisionedResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List components with summary data. You can filter the result list by environment, service, or a single service instance.

- *

For more information about components, see - * Proton components in the - * Proton User Guide.

- */ - public listComponents( + + /** + * @see {@link ListComponentsCommand} + */ + listComponents( args: ListComponentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listComponents( - args: ListComponentsCommandInput, - cb: (err: any, data?: ListComponentsCommandOutput) => void - ): void; - public listComponents( + listComponents(args: ListComponentsCommandInput, cb: (err: any, data?: ListComponentsCommandOutput) => void): void; + listComponents( args: ListComponentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComponentsCommandOutput) => void ): void; - public listComponents( - args: ListComponentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListComponentsCommandOutput) => void), - cb?: (err: any, data?: ListComponentsCommandOutput) => void - ): Promise | void { - const command = new ListComponentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

View a list of environment account connections.

- *

For more information, see Environment account - * connections in the Proton User guide.

- */ - public listEnvironmentAccountConnections( + + /** + * @see {@link ListEnvironmentAccountConnectionsCommand} + */ + listEnvironmentAccountConnections( args: ListEnvironmentAccountConnectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEnvironmentAccountConnections( + listEnvironmentAccountConnections( args: ListEnvironmentAccountConnectionsCommandInput, cb: (err: any, data?: ListEnvironmentAccountConnectionsCommandOutput) => void ): void; - public listEnvironmentAccountConnections( + listEnvironmentAccountConnections( args: ListEnvironmentAccountConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnvironmentAccountConnectionsCommandOutput) => void ): void; - public listEnvironmentAccountConnections( - args: ListEnvironmentAccountConnectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEnvironmentAccountConnectionsCommandOutput) => void), - cb?: (err: any, data?: ListEnvironmentAccountConnectionsCommandOutput) => void - ): Promise | void { - const command = new ListEnvironmentAccountConnectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List the infrastructure as code outputs for your environment.

- */ - public listEnvironmentOutputs( + + /** + * @see {@link ListEnvironmentOutputsCommand} + */ + listEnvironmentOutputs( args: ListEnvironmentOutputsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEnvironmentOutputs( + listEnvironmentOutputs( args: ListEnvironmentOutputsCommandInput, cb: (err: any, data?: ListEnvironmentOutputsCommandOutput) => void ): void; - public listEnvironmentOutputs( + listEnvironmentOutputs( args: ListEnvironmentOutputsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnvironmentOutputsCommandOutput) => void ): void; - public listEnvironmentOutputs( - args: ListEnvironmentOutputsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEnvironmentOutputsCommandOutput) => void), - cb?: (err: any, data?: ListEnvironmentOutputsCommandOutput) => void - ): Promise | void { - const command = new ListEnvironmentOutputsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List the provisioned resources for your environment.

- */ - public listEnvironmentProvisionedResources( + + /** + * @see {@link ListEnvironmentProvisionedResourcesCommand} + */ + listEnvironmentProvisionedResources( args: ListEnvironmentProvisionedResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEnvironmentProvisionedResources( + listEnvironmentProvisionedResources( args: ListEnvironmentProvisionedResourcesCommandInput, cb: (err: any, data?: ListEnvironmentProvisionedResourcesCommandOutput) => void ): void; - public listEnvironmentProvisionedResources( + listEnvironmentProvisionedResources( args: ListEnvironmentProvisionedResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnvironmentProvisionedResourcesCommandOutput) => void ): void; - public listEnvironmentProvisionedResources( - args: ListEnvironmentProvisionedResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEnvironmentProvisionedResourcesCommandOutput) => void), - cb?: (err: any, data?: ListEnvironmentProvisionedResourcesCommandOutput) => void - ): Promise | void { - const command = new ListEnvironmentProvisionedResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List environments with detail data summaries.

- */ - public listEnvironments( + + /** + * @see {@link ListEnvironmentsCommand} + */ + listEnvironments( args: ListEnvironmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEnvironments( + listEnvironments( args: ListEnvironmentsCommandInput, cb: (err: any, data?: ListEnvironmentsCommandOutput) => void ): void; - public listEnvironments( + listEnvironments( args: ListEnvironmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnvironmentsCommandOutput) => void ): void; - public listEnvironments( - args: ListEnvironmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEnvironmentsCommandOutput) => void), - cb?: (err: any, data?: ListEnvironmentsCommandOutput) => void - ): Promise | void { - const command = new ListEnvironmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List environment templates.

- */ - public listEnvironmentTemplates( + + /** + * @see {@link ListEnvironmentTemplatesCommand} + */ + listEnvironmentTemplates( args: ListEnvironmentTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEnvironmentTemplates( + listEnvironmentTemplates( args: ListEnvironmentTemplatesCommandInput, cb: (err: any, data?: ListEnvironmentTemplatesCommandOutput) => void ): void; - public listEnvironmentTemplates( + listEnvironmentTemplates( args: ListEnvironmentTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnvironmentTemplatesCommandOutput) => void ): void; - public listEnvironmentTemplates( - args: ListEnvironmentTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEnvironmentTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListEnvironmentTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListEnvironmentTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List major or minor versions of an environment template with detail data.

- */ - public listEnvironmentTemplateVersions( + + /** + * @see {@link ListEnvironmentTemplateVersionsCommand} + */ + listEnvironmentTemplateVersions( args: ListEnvironmentTemplateVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEnvironmentTemplateVersions( + listEnvironmentTemplateVersions( args: ListEnvironmentTemplateVersionsCommandInput, cb: (err: any, data?: ListEnvironmentTemplateVersionsCommandOutput) => void ): void; - public listEnvironmentTemplateVersions( + listEnvironmentTemplateVersions( args: ListEnvironmentTemplateVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnvironmentTemplateVersionsCommandOutput) => void ): void; - public listEnvironmentTemplateVersions( - args: ListEnvironmentTemplateVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEnvironmentTemplateVersionsCommandOutput) => void), - cb?: (err: any, data?: ListEnvironmentTemplateVersionsCommandOutput) => void - ): Promise | void { - const command = new ListEnvironmentTemplateVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List linked repositories with detail data.

- */ - public listRepositories( + + /** + * @see {@link ListRepositoriesCommand} + */ + listRepositories( args: ListRepositoriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRepositories( + listRepositories( args: ListRepositoriesCommandInput, cb: (err: any, data?: ListRepositoriesCommandOutput) => void ): void; - public listRepositories( + listRepositories( args: ListRepositoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRepositoriesCommandOutput) => void ): void; - public listRepositories( - args: ListRepositoriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRepositoriesCommandOutput) => void), - cb?: (err: any, data?: ListRepositoriesCommandOutput) => void - ): Promise | void { - const command = new ListRepositoriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List repository sync definitions with detail data.

- */ - public listRepositorySyncDefinitions( + + /** + * @see {@link ListRepositorySyncDefinitionsCommand} + */ + listRepositorySyncDefinitions( args: ListRepositorySyncDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRepositorySyncDefinitions( + listRepositorySyncDefinitions( args: ListRepositorySyncDefinitionsCommandInput, cb: (err: any, data?: ListRepositorySyncDefinitionsCommandOutput) => void ): void; - public listRepositorySyncDefinitions( + listRepositorySyncDefinitions( args: ListRepositorySyncDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRepositorySyncDefinitionsCommandOutput) => void ): void; - public listRepositorySyncDefinitions( - args: ListRepositorySyncDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRepositorySyncDefinitionsCommandOutput) => void), - cb?: (err: any, data?: ListRepositorySyncDefinitionsCommandOutput) => void - ): Promise | void { - const command = new ListRepositorySyncDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get a list service of instance Infrastructure as Code (IaC) outputs.

- */ - public listServiceInstanceOutputs( + + /** + * @see {@link ListServiceInstanceOutputsCommand} + */ + listServiceInstanceOutputs( args: ListServiceInstanceOutputsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listServiceInstanceOutputs( + listServiceInstanceOutputs( args: ListServiceInstanceOutputsCommandInput, cb: (err: any, data?: ListServiceInstanceOutputsCommandOutput) => void ): void; - public listServiceInstanceOutputs( + listServiceInstanceOutputs( args: ListServiceInstanceOutputsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceInstanceOutputsCommandOutput) => void ): void; - public listServiceInstanceOutputs( - args: ListServiceInstanceOutputsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServiceInstanceOutputsCommandOutput) => void), - cb?: (err: any, data?: ListServiceInstanceOutputsCommandOutput) => void - ): Promise | void { - const command = new ListServiceInstanceOutputsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List provisioned resources for a service instance with details.

- */ - public listServiceInstanceProvisionedResources( + + /** + * @see {@link ListServiceInstanceProvisionedResourcesCommand} + */ + listServiceInstanceProvisionedResources( args: ListServiceInstanceProvisionedResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listServiceInstanceProvisionedResources( + listServiceInstanceProvisionedResources( args: ListServiceInstanceProvisionedResourcesCommandInput, cb: (err: any, data?: ListServiceInstanceProvisionedResourcesCommandOutput) => void ): void; - public listServiceInstanceProvisionedResources( + listServiceInstanceProvisionedResources( args: ListServiceInstanceProvisionedResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceInstanceProvisionedResourcesCommandOutput) => void ): void; - public listServiceInstanceProvisionedResources( - args: ListServiceInstanceProvisionedResourcesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListServiceInstanceProvisionedResourcesCommandOutput) => void), - cb?: (err: any, data?: ListServiceInstanceProvisionedResourcesCommandOutput) => void - ): Promise | void { - const command = new ListServiceInstanceProvisionedResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List service instances with summary data. This action lists service instances of all - * services in the Amazon Web Services account.

- */ - public listServiceInstances( + + /** + * @see {@link ListServiceInstancesCommand} + */ + listServiceInstances( args: ListServiceInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listServiceInstances( + listServiceInstances( args: ListServiceInstancesCommandInput, cb: (err: any, data?: ListServiceInstancesCommandOutput) => void ): void; - public listServiceInstances( + listServiceInstances( args: ListServiceInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceInstancesCommandOutput) => void ): void; - public listServiceInstances( - args: ListServiceInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServiceInstancesCommandOutput) => void), - cb?: (err: any, data?: ListServiceInstancesCommandOutput) => void - ): Promise | void { - const command = new ListServiceInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get a list of service pipeline Infrastructure as Code (IaC) outputs.

- */ - public listServicePipelineOutputs( + + /** + * @see {@link ListServicePipelineOutputsCommand} + */ + listServicePipelineOutputs( args: ListServicePipelineOutputsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listServicePipelineOutputs( + listServicePipelineOutputs( args: ListServicePipelineOutputsCommandInput, cb: (err: any, data?: ListServicePipelineOutputsCommandOutput) => void ): void; - public listServicePipelineOutputs( + listServicePipelineOutputs( args: ListServicePipelineOutputsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServicePipelineOutputsCommandOutput) => void ): void; - public listServicePipelineOutputs( - args: ListServicePipelineOutputsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServicePipelineOutputsCommandOutput) => void), - cb?: (err: any, data?: ListServicePipelineOutputsCommandOutput) => void - ): Promise | void { - const command = new ListServicePipelineOutputsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List provisioned resources for a service and pipeline with details.

- */ - public listServicePipelineProvisionedResources( + + /** + * @see {@link ListServicePipelineProvisionedResourcesCommand} + */ + listServicePipelineProvisionedResources( args: ListServicePipelineProvisionedResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listServicePipelineProvisionedResources( + listServicePipelineProvisionedResources( args: ListServicePipelineProvisionedResourcesCommandInput, cb: (err: any, data?: ListServicePipelineProvisionedResourcesCommandOutput) => void ): void; - public listServicePipelineProvisionedResources( + listServicePipelineProvisionedResources( args: ListServicePipelineProvisionedResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServicePipelineProvisionedResourcesCommandOutput) => void ): void; - public listServicePipelineProvisionedResources( - args: ListServicePipelineProvisionedResourcesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListServicePipelineProvisionedResourcesCommandOutput) => void), - cb?: (err: any, data?: ListServicePipelineProvisionedResourcesCommandOutput) => void - ): Promise | void { - const command = new ListServicePipelineProvisionedResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List services with summaries of detail data.

- */ - public listServices( - args: ListServicesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listServices(args: ListServicesCommandInput, cb: (err: any, data?: ListServicesCommandOutput) => void): void; - public listServices( + + /** + * @see {@link ListServicesCommand} + */ + listServices(args: ListServicesCommandInput, options?: __HttpHandlerOptions): Promise; + listServices(args: ListServicesCommandInput, cb: (err: any, data?: ListServicesCommandOutput) => void): void; + listServices( args: ListServicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServicesCommandOutput) => void ): void; - public listServices( - args: ListServicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServicesCommandOutput) => void), - cb?: (err: any, data?: ListServicesCommandOutput) => void - ): Promise | void { - const command = new ListServicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List service templates with detail data.

- */ - public listServiceTemplates( + + /** + * @see {@link ListServiceTemplatesCommand} + */ + listServiceTemplates( args: ListServiceTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listServiceTemplates( + listServiceTemplates( args: ListServiceTemplatesCommandInput, cb: (err: any, data?: ListServiceTemplatesCommandOutput) => void ): void; - public listServiceTemplates( + listServiceTemplates( args: ListServiceTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceTemplatesCommandOutput) => void ): void; - public listServiceTemplates( - args: ListServiceTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServiceTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListServiceTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListServiceTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List major or minor versions of a service template with detail data.

- */ - public listServiceTemplateVersions( + + /** + * @see {@link ListServiceTemplateVersionsCommand} + */ + listServiceTemplateVersions( args: ListServiceTemplateVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listServiceTemplateVersions( + listServiceTemplateVersions( args: ListServiceTemplateVersionsCommandInput, cb: (err: any, data?: ListServiceTemplateVersionsCommandOutput) => void ): void; - public listServiceTemplateVersions( + listServiceTemplateVersions( args: ListServiceTemplateVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceTemplateVersionsCommandOutput) => void ): void; - public listServiceTemplateVersions( - args: ListServiceTemplateVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServiceTemplateVersionsCommandOutput) => void), - cb?: (err: any, data?: ListServiceTemplateVersionsCommandOutput) => void - ): Promise | void { - const command = new ListServiceTemplateVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List tags for a resource. For more information, see Proton resources and tagging in the - * Proton User Guide.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Notify Proton of status changes to a provisioned resource when you use self-managed - * provisioning.

- *

For more information, see Self-managed - * provisioning in the Proton User Guide.

- */ - public notifyResourceDeploymentStatusChange( + + /** + * @see {@link NotifyResourceDeploymentStatusChangeCommand} + */ + notifyResourceDeploymentStatusChange( args: NotifyResourceDeploymentStatusChangeCommandInput, options?: __HttpHandlerOptions ): Promise; - public notifyResourceDeploymentStatusChange( + notifyResourceDeploymentStatusChange( args: NotifyResourceDeploymentStatusChangeCommandInput, cb: (err: any, data?: NotifyResourceDeploymentStatusChangeCommandOutput) => void ): void; - public notifyResourceDeploymentStatusChange( + notifyResourceDeploymentStatusChange( args: NotifyResourceDeploymentStatusChangeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NotifyResourceDeploymentStatusChangeCommandOutput) => void ): void; - public notifyResourceDeploymentStatusChange( - args: NotifyResourceDeploymentStatusChangeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NotifyResourceDeploymentStatusChangeCommandOutput) => void), - cb?: (err: any, data?: NotifyResourceDeploymentStatusChangeCommandOutput) => void - ): Promise | void { - const command = new NotifyResourceDeploymentStatusChangeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

In a management account, reject an environment account connection from another environment account.

- *

After you reject an environment account connection request, you can't accept or use the rejected environment account - * connection.

- *

You can’t reject an environment account connection that's connected to an environment.

- *

For more information, see Environment account - * connections in the Proton User guide.

- */ - public rejectEnvironmentAccountConnection( + + /** + * @see {@link RejectEnvironmentAccountConnectionCommand} + */ + rejectEnvironmentAccountConnection( args: RejectEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public rejectEnvironmentAccountConnection( + rejectEnvironmentAccountConnection( args: RejectEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: RejectEnvironmentAccountConnectionCommandOutput) => void ): void; - public rejectEnvironmentAccountConnection( + rejectEnvironmentAccountConnection( args: RejectEnvironmentAccountConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectEnvironmentAccountConnectionCommandOutput) => void ): void; - public rejectEnvironmentAccountConnection( - args: RejectEnvironmentAccountConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RejectEnvironmentAccountConnectionCommandOutput) => void), - cb?: (err: any, data?: RejectEnvironmentAccountConnectionCommandOutput) => void - ): Promise | void { - const command = new RejectEnvironmentAccountConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton - * resource.

- *

For more information, see Proton resources and tagging in the - * Proton User Guide.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Remove a customer tag from a resource. A tag is a key-value pair of metadata associated with - * an Proton resource.

- *

For more information, see Proton resources and tagging in the - * Proton User Guide.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update Proton settings that are used for multiple services in the Amazon Web Services account.

- */ - public updateAccountSettings( + + /** + * @see {@link UpdateAccountSettingsCommand} + */ + updateAccountSettings( args: UpdateAccountSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAccountSettings( + updateAccountSettings( args: UpdateAccountSettingsCommandInput, cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void ): void; - public updateAccountSettings( + updateAccountSettings( args: UpdateAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void ): void; - public updateAccountSettings( - args: UpdateAccountSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAccountSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateAccountSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateAccountSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update a component.

- *

There are a few modes for updating a component. The deploymentType field defines the mode.

- * - *

You can't update a component while its deployment status, or the deployment status of a service instance attached to it, is - * IN_PROGRESS.

- *
- *

For more information about components, see - * Proton components in the - * Proton User Guide.

- */ - public updateComponent( + + /** + * @see {@link UpdateComponentCommand} + */ + updateComponent( args: UpdateComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateComponent( - args: UpdateComponentCommandInput, - cb: (err: any, data?: UpdateComponentCommandOutput) => void - ): void; - public updateComponent( + updateComponent(args: UpdateComponentCommandInput, cb: (err: any, data?: UpdateComponentCommandOutput) => void): void; + updateComponent( args: UpdateComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateComponentCommandOutput) => void ): void; - public updateComponent( - args: UpdateComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateComponentCommandOutput) => void), - cb?: (err: any, data?: UpdateComponentCommandOutput) => void - ): Promise | void { - const command = new UpdateComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update an environment.

- *

If the environment is associated with an environment account connection, don't update or include the - * protonServiceRoleArn and provisioningRepository parameter to update or connect to an environment account connection.

- *

You can only update to a new environment account connection if that connection was created in the same environment account that the current - * environment account connection was created in. The account connection must also be associated with the current environment.

- *

If the environment isn't associated with an environment account connection, don't update or include the - * environmentAccountConnectionId parameter. You can't update or connect the environment to an environment account - * connection if it isn't already associated with an environment connection.

- *

You can update either the environmentAccountConnectionId or protonServiceRoleArn parameter and value. You can’t update - * both.

- *

If the environment was configured for Amazon Web Services-managed provisioning, omit the provisioningRepository parameter.

- *

If the environment was configured for self-managed provisioning, specify the provisioningRepository parameter and omit the - * protonServiceRoleArn and environmentAccountConnectionId parameters.

- *

For more information, see Environments and Provisioning methods in the Proton User - * Guide.

- *

There are four modes for updating an environment. The deploymentType field defines the mode.

- *
- *
- *
- *

- * NONE - *

- *

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

- *
- *
- *
- *

- * CURRENT_VERSION - *

- *

In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. - * Don’t include minor or major version parameters when you use this deployment-type.

- *
- *
- *
- *

- * MINOR_VERSION - *

- *

In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in - * use, by default. You can also specify a different minor version of the current major version in use.

- *
- *
- *
- *

- * MAJOR_VERSION - *

- *

In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, - * by default. You can also specify a different major version that's higher than the major version in use and a minor version.

- *
- *
- */ - public updateEnvironment( + + /** + * @see {@link UpdateEnvironmentCommand} + */ + updateEnvironment( args: UpdateEnvironmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEnvironment( + updateEnvironment( args: UpdateEnvironmentCommandInput, cb: (err: any, data?: UpdateEnvironmentCommandOutput) => void ): void; - public updateEnvironment( + updateEnvironment( args: UpdateEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEnvironmentCommandOutput) => void ): void; - public updateEnvironment( - args: UpdateEnvironmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEnvironmentCommandOutput) => void), - cb?: (err: any, data?: UpdateEnvironmentCommandOutput) => void - ): Promise | void { - const command = new UpdateEnvironmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

In an environment account, update an environment account connection to use a new IAM role.

- *

For more information, see Environment account - * connections in the Proton User guide.

- */ - public updateEnvironmentAccountConnection( + + /** + * @see {@link UpdateEnvironmentAccountConnectionCommand} + */ + updateEnvironmentAccountConnection( args: UpdateEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEnvironmentAccountConnection( + updateEnvironmentAccountConnection( args: UpdateEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: UpdateEnvironmentAccountConnectionCommandOutput) => void ): void; - public updateEnvironmentAccountConnection( + updateEnvironmentAccountConnection( args: UpdateEnvironmentAccountConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEnvironmentAccountConnectionCommandOutput) => void ): void; - public updateEnvironmentAccountConnection( - args: UpdateEnvironmentAccountConnectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEnvironmentAccountConnectionCommandOutput) => void), - cb?: (err: any, data?: UpdateEnvironmentAccountConnectionCommandOutput) => void - ): Promise | void { - const command = new UpdateEnvironmentAccountConnectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update an environment template.

- */ - public updateEnvironmentTemplate( + + /** + * @see {@link UpdateEnvironmentTemplateCommand} + */ + updateEnvironmentTemplate( args: UpdateEnvironmentTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEnvironmentTemplate( + updateEnvironmentTemplate( args: UpdateEnvironmentTemplateCommandInput, cb: (err: any, data?: UpdateEnvironmentTemplateCommandOutput) => void ): void; - public updateEnvironmentTemplate( + updateEnvironmentTemplate( args: UpdateEnvironmentTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEnvironmentTemplateCommandOutput) => void ): void; - public updateEnvironmentTemplate( - args: UpdateEnvironmentTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEnvironmentTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateEnvironmentTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateEnvironmentTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update a major or minor version of an environment template.

- */ - public updateEnvironmentTemplateVersion( + + /** + * @see {@link UpdateEnvironmentTemplateVersionCommand} + */ + updateEnvironmentTemplateVersion( args: UpdateEnvironmentTemplateVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEnvironmentTemplateVersion( + updateEnvironmentTemplateVersion( args: UpdateEnvironmentTemplateVersionCommandInput, cb: (err: any, data?: UpdateEnvironmentTemplateVersionCommandOutput) => void ): void; - public updateEnvironmentTemplateVersion( + updateEnvironmentTemplateVersion( args: UpdateEnvironmentTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEnvironmentTemplateVersionCommandOutput) => void ): void; - public updateEnvironmentTemplateVersion( - args: UpdateEnvironmentTemplateVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEnvironmentTemplateVersionCommandOutput) => void), - cb?: (err: any, data?: UpdateEnvironmentTemplateVersionCommandOutput) => void - ): Promise | void { - const command = new UpdateEnvironmentTemplateVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Edit a service description or use a spec to add and delete service instances.

- * - *

Existing service instances and the service pipeline can't be edited - * using this API. They can only be deleted.

- *
- *

Use the description parameter to modify the description.

- *

Edit the spec parameter to add or delete instances.

- * - *

You can't delete a service instance (remove it from the spec) if it has an attached - * component.

- *

For more information about components, see - * Proton components in the - * Proton User Guide.

- *
- */ - public updateService( - args: UpdateServiceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateService( - args: UpdateServiceCommandInput, - cb: (err: any, data?: UpdateServiceCommandOutput) => void - ): void; - public updateService( + + /** + * @see {@link UpdateServiceCommand} + */ + updateService(args: UpdateServiceCommandInput, options?: __HttpHandlerOptions): Promise; + updateService(args: UpdateServiceCommandInput, cb: (err: any, data?: UpdateServiceCommandOutput) => void): void; + updateService( args: UpdateServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceCommandOutput) => void ): void; - public updateService( - args: UpdateServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServiceCommandOutput) => void), - cb?: (err: any, data?: UpdateServiceCommandOutput) => void - ): Promise | void { - const command = new UpdateServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update a service instance.

- *

There are a few modes for updating a service instance. The deploymentType - * field defines the mode.

- * - *

You can't update a service instance while its deployment status, or the deployment - * status of a component attached to it, is IN_PROGRESS.

- *

For more information about components, see - * Proton components in the - * Proton User Guide.

- *
- */ - public updateServiceInstance( + + /** + * @see {@link UpdateServiceInstanceCommand} + */ + updateServiceInstance( args: UpdateServiceInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateServiceInstance( + updateServiceInstance( args: UpdateServiceInstanceCommandInput, cb: (err: any, data?: UpdateServiceInstanceCommandOutput) => void ): void; - public updateServiceInstance( + updateServiceInstance( args: UpdateServiceInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceInstanceCommandOutput) => void ): void; - public updateServiceInstance( - args: UpdateServiceInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServiceInstanceCommandOutput) => void), - cb?: (err: any, data?: UpdateServiceInstanceCommandOutput) => void - ): Promise | void { - const command = new UpdateServiceInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update the service pipeline.

- *

There are four modes for updating a service pipeline. The deploymentType - * field defines the mode.

- *
- *
- *
- *

- * NONE - *

- *

In this mode, a deployment doesn't occur. Only the requested - * metadata parameters are updated.

- *
- *
- *
- *

- * CURRENT_VERSION - *

- *

In this mode, the service pipeline is deployed and updated with the new spec that - * you provide. Only requested parameters are updated. Don’t include - * major or minor version parameters when you use this deployment-type.

- *
- *
- *
- *

- * MINOR_VERSION - *

- *

In this mode, the service pipeline is deployed and updated with the published, - * recommended (latest) minor version of the current major version in use, by default. You - * can specify a different minor version of the current major version in use.

- *
- *
- *
- *

- * MAJOR_VERSION - *

- *

In this mode, the service pipeline is deployed and updated with the published, - * recommended (latest) major and minor version of the current template by default. You can - * specify a different major version that's higher than the major version in use and a - * minor version.

- *
- *
- */ - public updateServicePipeline( + + /** + * @see {@link UpdateServicePipelineCommand} + */ + updateServicePipeline( args: UpdateServicePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateServicePipeline( + updateServicePipeline( args: UpdateServicePipelineCommandInput, cb: (err: any, data?: UpdateServicePipelineCommandOutput) => void ): void; - public updateServicePipeline( + updateServicePipeline( args: UpdateServicePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServicePipelineCommandOutput) => void ): void; - public updateServicePipeline( - args: UpdateServicePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServicePipelineCommandOutput) => void), - cb?: (err: any, data?: UpdateServicePipelineCommandOutput) => void - ): Promise | void { - const command = new UpdateServicePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update the service sync blocker by resolving it.

- */ - public updateServiceSyncBlocker( + + /** + * @see {@link UpdateServiceSyncBlockerCommand} + */ + updateServiceSyncBlocker( args: UpdateServiceSyncBlockerCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateServiceSyncBlocker( + updateServiceSyncBlocker( args: UpdateServiceSyncBlockerCommandInput, cb: (err: any, data?: UpdateServiceSyncBlockerCommandOutput) => void ): void; - public updateServiceSyncBlocker( + updateServiceSyncBlocker( args: UpdateServiceSyncBlockerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceSyncBlockerCommandOutput) => void ): void; - public updateServiceSyncBlocker( - args: UpdateServiceSyncBlockerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServiceSyncBlockerCommandOutput) => void), - cb?: (err: any, data?: UpdateServiceSyncBlockerCommandOutput) => void - ): Promise | void { - const command = new UpdateServiceSyncBlockerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update the Proton Ops config file.

- */ - public updateServiceSyncConfig( + + /** + * @see {@link UpdateServiceSyncConfigCommand} + */ + updateServiceSyncConfig( args: UpdateServiceSyncConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateServiceSyncConfig( + updateServiceSyncConfig( args: UpdateServiceSyncConfigCommandInput, cb: (err: any, data?: UpdateServiceSyncConfigCommandOutput) => void ): void; - public updateServiceSyncConfig( + updateServiceSyncConfig( args: UpdateServiceSyncConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceSyncConfigCommandOutput) => void ): void; - public updateServiceSyncConfig( - args: UpdateServiceSyncConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServiceSyncConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateServiceSyncConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateServiceSyncConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update a service template.

- */ - public updateServiceTemplate( + + /** + * @see {@link UpdateServiceTemplateCommand} + */ + updateServiceTemplate( args: UpdateServiceTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateServiceTemplate( + updateServiceTemplate( args: UpdateServiceTemplateCommandInput, cb: (err: any, data?: UpdateServiceTemplateCommandOutput) => void ): void; - public updateServiceTemplate( + updateServiceTemplate( args: UpdateServiceTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceTemplateCommandOutput) => void ): void; - public updateServiceTemplate( - args: UpdateServiceTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServiceTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateServiceTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateServiceTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update a major or minor version of a service template.

- */ - public updateServiceTemplateVersion( + + /** + * @see {@link UpdateServiceTemplateVersionCommand} + */ + updateServiceTemplateVersion( args: UpdateServiceTemplateVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateServiceTemplateVersion( + updateServiceTemplateVersion( args: UpdateServiceTemplateVersionCommandInput, cb: (err: any, data?: UpdateServiceTemplateVersionCommandOutput) => void ): void; - public updateServiceTemplateVersion( + updateServiceTemplateVersion( args: UpdateServiceTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceTemplateVersionCommandOutput) => void ): void; - public updateServiceTemplateVersion( - args: UpdateServiceTemplateVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServiceTemplateVersionCommandOutput) => void), - cb?: (err: any, data?: UpdateServiceTemplateVersionCommandOutput) => void - ): Promise | void { - const command = new UpdateServiceTemplateVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update template sync configuration parameters, except for the templateName and - * templateType. Repository details (branch, name, and provider) should be of a linked - * repository. A linked repository is a repository that has been registered with Proton. For more - * information, see CreateRepository.

- */ - public updateTemplateSyncConfig( + + /** + * @see {@link UpdateTemplateSyncConfigCommand} + */ + updateTemplateSyncConfig( args: UpdateTemplateSyncConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTemplateSyncConfig( + updateTemplateSyncConfig( args: UpdateTemplateSyncConfigCommandInput, cb: (err: any, data?: UpdateTemplateSyncConfigCommandOutput) => void ): void; - public updateTemplateSyncConfig( + updateTemplateSyncConfig( args: UpdateTemplateSyncConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTemplateSyncConfigCommandOutput) => void ): void; - public updateTemplateSyncConfig( - args: UpdateTemplateSyncConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTemplateSyncConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateTemplateSyncConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateTemplateSyncConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

This is the Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the + * actions and data types for the Proton + * service.

+ *

The documentation for each action shows the Query API request parameters and the XML response.

+ *

Alternatively, you can use the Amazon Web Services CLI to access an API. For more information, see the Amazon Web Services Command Line Interface User + * Guide.

+ *

The Proton service is a two-pronged automation framework. Administrators create service templates to provide + * standardized infrastructure and deployment tooling for serverless and container based applications. Developers, in + * turn, select from the available service templates to automate their application or service deployments.

+ *

Because administrators define the infrastructure and tooling that Proton deploys and manages, they need + * permissions to use all of the listed API operations.

+ *

When developers select a specific infrastructure and tooling set, Proton deploys their applications. To + * monitor their applications that are running on Proton, developers need permissions to the service + * create, list, update and delete + * API operations and the service instance list and update API + * operations.

+ *

To learn more about Proton, see the Proton User Guide.

+ *

+ * Ensuring Idempotency + *

+ *

When you make a mutating API request, the request typically returns a result before the asynchronous workflows + * of the operation are complete. Operations might also time out or encounter other server issues before they're + * complete, even if the request already returned a result. This might make it difficult to determine whether the + * request succeeded. Moreover, you might need to retry the request multiple times to ensure that the operation + * completes successfully. However, if the original request and the subsequent retries are successful, the operation + * occurs multiple times. This means that you might create more resources than you intended.

+ *

+ * Idempotency ensures that an API request action completes no more than one time. With an + * idempotent request, if the original request action completes successfully, any subsequent retries complete + * successfully without performing any further actions. However, the result might contain updated information, such as + * the current creation status.

+ *

The following lists of APIs are grouped according to methods that ensure idempotency.

+ *

+ * Idempotent create APIs with a client token + *

+ *

The API actions in this list support idempotency with the use of a client token. The + * corresponding Amazon Web Services CLI commands also support idempotency using a client token. A client token is a unique, + * case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, + * specify a client token in the request. We recommend that you don't reuse the same client token + * for other API requests. If you don’t provide a client token for these APIs, a default client token is automatically + * provided by SDKs.

+ *

Given a request action that has succeeded:

+ *

If you retry the request using the same client token and the same parameters, the retry succeeds without + * performing any further actions other than returning the original resource detail data in the response.

+ *

If you retry the request using the same client token, but one or more of the parameters are different, the retry + * throws a ValidationException with an IdempotentParameterMismatch error.

+ *

Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new + * resource is created.

+ *

If the original resource is deleted and you retry the request, a new resource is created.

+ *

Idempotent create APIs with a client token:

+ *
    + *
  • + *

    CreateEnvironmentTemplateVersion

    + *
  • + *
  • + *

    CreateServiceTemplateVersion

    + *
  • + *
  • + *

    CreateEnvironmentAccountConnection

    + *
  • + *
+ *

+ * Idempotent create APIs + *

+ *

Given a request action that has succeeded:

+ *

If you retry the request with an API from this group, and the original resource hasn't been + * modified, the retry succeeds without performing any further actions other than returning the original resource detail + * data in the response.

+ *

If the original resource has been modified, the retry throws a ConflictException.

+ *

If you retry with different input parameters, the retry throws a ValidationException with an + * IdempotentParameterMismatch error.

+ *

Idempotent create APIs:

+ *
    + *
  • + *

    CreateEnvironmentTemplate

    + *
  • + *
  • + *

    CreateServiceTemplate

    + *
  • + *
  • + *

    CreateEnvironment

    + *
  • + *
  • + *

    CreateService

    + *
  • + *
+ *

+ * Idempotent delete APIs + *

+ *

Given a request action that has succeeded:

+ *

When you retry the request with an API from this group and the resource was deleted, its metadata is returned in + * the response.

+ *

If you retry and the resource doesn't exist, the response is empty.

+ *

In both cases, the retry succeeds.

+ *

Idempotent delete APIs:

+ *
    + *
  • + *

    DeleteEnvironmentTemplate

    + *
  • + *
  • + *

    DeleteEnvironmentTemplateVersion

    + *
  • + *
  • + *

    DeleteServiceTemplate

    + *
  • + *
  • + *

    DeleteServiceTemplateVersion

    + *
  • + *
  • + *

    DeleteEnvironmentAccountConnection

    + *
  • + *
+ *

+ * Asynchronous idempotent delete APIs + *

+ *

Given a request action that has succeeded:

+ *

If you retry the request with an API from this group, if the original request delete operation status is + * DELETE_IN_PROGRESS, the retry returns the resource detail data in the response without performing any + * further actions.

+ *

If the original request delete operation is complete, a retry returns an empty response.

+ *

Asynchronous idempotent delete APIs:

+ *
    + *
  • + *

    DeleteEnvironment

    + *
  • + *
  • + *

    DeleteService

    + *
  • + *
+ */ +export class Proton extends ProtonClient implements Proton {} +createAggregatedClient(commands, Proton); diff --git a/clients/client-qldb-session/src/QLDBSession.ts b/clients/client-qldb-session/src/QLDBSession.ts index 8782f21ee6e1..dbbd637e8746 100644 --- a/clients/client-qldb-session/src/QLDBSession.ts +++ b/clients/client-qldb-session/src/QLDBSession.ts @@ -1,8 +1,26 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { SendCommandCommand, SendCommandCommandInput, SendCommandCommandOutput } from "./commands/SendCommandCommand"; -import { QLDBSessionClient } from "./QLDBSessionClient"; +import { QLDBSessionClient, QLDBSessionClientConfig } from "./QLDBSessionClient"; + +const commands = { + SendCommandCommand, +}; + +export interface QLDBSession { + /** + * @see {@link SendCommandCommand} + */ + sendCommand(args: SendCommandCommandInput, options?: __HttpHandlerOptions): Promise; + sendCommand(args: SendCommandCommandInput, cb: (err: any, data?: SendCommandCommandOutput) => void): void; + sendCommand( + args: SendCommandCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: SendCommandCommandOutput) => void + ): void; +} /** * @public @@ -28,51 +46,5 @@ import { QLDBSessionClient } from "./QLDBSessionClient"; * * */ -export class QLDBSession extends QLDBSessionClient { - /** - * @public - *

Sends a command to an Amazon QLDB ledger.

- * - *

Instead of interacting directly with this API, we recommend using the QLDB driver - * or the QLDB shell to execute data transactions on a ledger.

- *
    - *
  • - *

    If you are working with an AWS SDK, use the QLDB driver. The driver provides - * a high-level abstraction layer above this QLDB Session data - * plane and manages SendCommand API calls for you. For information and - * a list of supported programming languages, see Getting started - * with the driver in the Amazon QLDB Developer - * Guide.

    - *
  • - *
  • - *

    If you are working with the AWS Command Line Interface (AWS CLI), use the - * QLDB shell. The shell is a command line interface that uses the QLDB driver to - * interact with a ledger. For information, see Accessing Amazon QLDB using the - * QLDB shell.

    - *
  • - *
- *
- */ - public sendCommand(args: SendCommandCommandInput, options?: __HttpHandlerOptions): Promise; - public sendCommand(args: SendCommandCommandInput, cb: (err: any, data?: SendCommandCommandOutput) => void): void; - public sendCommand( - args: SendCommandCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: SendCommandCommandOutput) => void - ): void; - public sendCommand( - args: SendCommandCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendCommandCommandOutput) => void), - cb?: (err: any, data?: SendCommandCommandOutput) => void - ): Promise | void { - const command = new SendCommandCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } -} +export class QLDBSession extends QLDBSessionClient implements QLDBSession {} +createAggregatedClient(commands, QLDBSession); diff --git a/clients/client-qldb/src/QLDB.ts b/clients/client-qldb/src/QLDB.ts index c7f4d589e018..8db3f89de945 100644 --- a/clients/client-qldb/src/QLDB.ts +++ b/clients/client-qldb/src/QLDB.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -81,710 +82,319 @@ import { UpdateLedgerPermissionsModeCommandInput, UpdateLedgerPermissionsModeCommandOutput, } from "./commands/UpdateLedgerPermissionsModeCommand"; -import { QLDBClient } from "./QLDBClient"; +import { QLDBClient, QLDBClientConfig } from "./QLDBClient"; -/** - * @public - *

The control plane for Amazon QLDB

- */ -export class QLDB extends QLDBClient { +const commands = { + CancelJournalKinesisStreamCommand, + CreateLedgerCommand, + DeleteLedgerCommand, + DescribeJournalKinesisStreamCommand, + DescribeJournalS3ExportCommand, + DescribeLedgerCommand, + ExportJournalToS3Command, + GetBlockCommand, + GetDigestCommand, + GetRevisionCommand, + ListJournalKinesisStreamsForLedgerCommand, + ListJournalS3ExportsCommand, + ListJournalS3ExportsForLedgerCommand, + ListLedgersCommand, + ListTagsForResourceCommand, + StreamJournalToKinesisCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateLedgerCommand, + UpdateLedgerPermissionsModeCommand, +}; + +export interface QLDB { /** - * @public - *

Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current - * status must be ACTIVE.

- *

You can't restart a stream after you cancel it. Canceled QLDB stream resources are - * subject to a 7-day retention period, so they are automatically deleted after this limit - * expires.

+ * @see {@link CancelJournalKinesisStreamCommand} */ - public cancelJournalKinesisStream( + cancelJournalKinesisStream( args: CancelJournalKinesisStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelJournalKinesisStream( + cancelJournalKinesisStream( args: CancelJournalKinesisStreamCommandInput, cb: (err: any, data?: CancelJournalKinesisStreamCommandOutput) => void ): void; - public cancelJournalKinesisStream( + cancelJournalKinesisStream( args: CancelJournalKinesisStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelJournalKinesisStreamCommandOutput) => void ): void; - public cancelJournalKinesisStream( - args: CancelJournalKinesisStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelJournalKinesisStreamCommandOutput) => void), - cb?: (err: any, data?: CancelJournalKinesisStreamCommandOutput) => void - ): Promise | void { - const command = new CancelJournalKinesisStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new ledger in your Amazon Web Services account in the current Region.

+ * @see {@link CreateLedgerCommand} */ - public createLedger( - args: CreateLedgerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createLedger(args: CreateLedgerCommandInput, cb: (err: any, data?: CreateLedgerCommandOutput) => void): void; - public createLedger( + createLedger(args: CreateLedgerCommandInput, options?: __HttpHandlerOptions): Promise; + createLedger(args: CreateLedgerCommandInput, cb: (err: any, data?: CreateLedgerCommandOutput) => void): void; + createLedger( args: CreateLedgerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLedgerCommandOutput) => void ): void; - public createLedger( - args: CreateLedgerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLedgerCommandOutput) => void), - cb?: (err: any, data?: CreateLedgerCommandOutput) => void - ): Promise | void { - const command = new CreateLedgerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a ledger and all of its contents. This action is irreversible.

- *

If deletion protection is enabled, you must first disable it before you can delete the - * ledger. You can disable it by calling the UpdateLedger operation to set the flag to false.

+ * @see {@link DeleteLedgerCommand} */ - public deleteLedger( - args: DeleteLedgerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteLedger(args: DeleteLedgerCommandInput, cb: (err: any, data?: DeleteLedgerCommandOutput) => void): void; - public deleteLedger( + deleteLedger(args: DeleteLedgerCommandInput, options?: __HttpHandlerOptions): Promise; + deleteLedger(args: DeleteLedgerCommandInput, cb: (err: any, data?: DeleteLedgerCommandOutput) => void): void; + deleteLedger( args: DeleteLedgerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLedgerCommandOutput) => void ): void; - public deleteLedger( - args: DeleteLedgerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLedgerCommandOutput) => void), - cb?: (err: any, data?: DeleteLedgerCommandOutput) => void - ): Promise | void { - const command = new DeleteLedgerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns detailed information about a given Amazon QLDB journal stream. The output - * includes the Amazon Resource Name (ARN), stream name, current status, creation time, and - * the parameters of the original stream creation request.

- *

This action does not return any expired journal streams. For more information, see - * Expiration for terminal streams in the Amazon QLDB Developer - * Guide.

+ * @see {@link DescribeJournalKinesisStreamCommand} */ - public describeJournalKinesisStream( + describeJournalKinesisStream( args: DescribeJournalKinesisStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeJournalKinesisStream( + describeJournalKinesisStream( args: DescribeJournalKinesisStreamCommandInput, cb: (err: any, data?: DescribeJournalKinesisStreamCommandOutput) => void ): void; - public describeJournalKinesisStream( + describeJournalKinesisStream( args: DescribeJournalKinesisStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJournalKinesisStreamCommandOutput) => void ): void; - public describeJournalKinesisStream( - args: DescribeJournalKinesisStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeJournalKinesisStreamCommandOutput) => void), - cb?: (err: any, data?: DescribeJournalKinesisStreamCommandOutput) => void - ): Promise | void { - const command = new DescribeJournalKinesisStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a journal export job, including the ledger name, export ID, - * creation time, current status, and the parameters of the original export creation - * request.

- *

This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer - * Guide.

- *

If the export job with the given ExportId doesn't exist, then throws - * ResourceNotFoundException.

- *

If the ledger with the given Name doesn't exist, then throws - * ResourceNotFoundException.

+ * @see {@link DescribeJournalS3ExportCommand} */ - public describeJournalS3Export( + describeJournalS3Export( args: DescribeJournalS3ExportCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeJournalS3Export( + describeJournalS3Export( args: DescribeJournalS3ExportCommandInput, cb: (err: any, data?: DescribeJournalS3ExportCommandOutput) => void ): void; - public describeJournalS3Export( + describeJournalS3Export( args: DescribeJournalS3ExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJournalS3ExportCommandOutput) => void ): void; - public describeJournalS3Export( - args: DescribeJournalS3ExportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeJournalS3ExportCommandOutput) => void), - cb?: (err: any, data?: DescribeJournalS3ExportCommandOutput) => void - ): Promise | void { - const command = new DescribeJournalS3ExportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a ledger, including its state, permissions mode, encryption at - * rest settings, and when it was created.

+ * @see {@link DescribeLedgerCommand} */ - public describeLedger( + describeLedger( args: DescribeLedgerCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLedger( - args: DescribeLedgerCommandInput, - cb: (err: any, data?: DescribeLedgerCommandOutput) => void - ): void; - public describeLedger( + describeLedger(args: DescribeLedgerCommandInput, cb: (err: any, data?: DescribeLedgerCommandOutput) => void): void; + describeLedger( args: DescribeLedgerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLedgerCommandOutput) => void ): void; - public describeLedger( - args: DescribeLedgerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLedgerCommandOutput) => void), - cb?: (err: any, data?: DescribeLedgerCommandOutput) => void - ): Promise | void { - const command = new DescribeLedgerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Exports journal contents within a date and time range from a ledger into a specified - * Amazon Simple Storage Service (Amazon S3) bucket. A journal export job can write the data objects in either the text - * or binary representation of Amazon Ion format, or in JSON Lines text - * format.

- *

In JSON Lines format, each journal block in the exported data object is a valid JSON - * object that is delimited by a newline. You can use this format to easily integrate JSON - * exports with analytics tools such as Glue and Amazon Athena - * because these services can parse newline-delimited JSON automatically. For more information - * about the format, see JSON Lines.

- *

If the ledger with the given Name doesn't exist, then throws - * ResourceNotFoundException.

- *

If the ledger with the given Name is in CREATING status, then - * throws ResourcePreconditionNotMetException.

- *

You can initiate up to two concurrent journal export requests for each ledger. Beyond - * this limit, journal export requests throw LimitExceededException.

+ * @see {@link ExportJournalToS3Command} */ - public exportJournalToS3( + exportJournalToS3( args: ExportJournalToS3CommandInput, options?: __HttpHandlerOptions ): Promise; - public exportJournalToS3( + exportJournalToS3( args: ExportJournalToS3CommandInput, cb: (err: any, data?: ExportJournalToS3CommandOutput) => void ): void; - public exportJournalToS3( + exportJournalToS3( args: ExportJournalToS3CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportJournalToS3CommandOutput) => void ): void; - public exportJournalToS3( - args: ExportJournalToS3CommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportJournalToS3CommandOutput) => void), - cb?: (err: any, data?: ExportJournalToS3CommandOutput) => void - ): Promise | void { - const command = new ExportJournalToS3Command(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a block object at a specified address in a journal. Also returns a proof of the - * specified block for verification if DigestTipAddress is provided.

- *

For information about the data contents in a block, see Journal contents in the - * Amazon QLDB Developer Guide.

- *

If the specified ledger doesn't exist or is in DELETING status, then throws - * ResourceNotFoundException.

- *

If the specified ledger is in CREATING status, then throws - * ResourcePreconditionNotMetException.

- *

If no block exists with the specified address, then throws - * InvalidParameterException.

+ * @see {@link GetBlockCommand} */ - public getBlock(args: GetBlockCommandInput, options?: __HttpHandlerOptions): Promise; - public getBlock(args: GetBlockCommandInput, cb: (err: any, data?: GetBlockCommandOutput) => void): void; - public getBlock( + getBlock(args: GetBlockCommandInput, options?: __HttpHandlerOptions): Promise; + getBlock(args: GetBlockCommandInput, cb: (err: any, data?: GetBlockCommandOutput) => void): void; + getBlock( args: GetBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBlockCommandOutput) => void ): void; - public getBlock( - args: GetBlockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBlockCommandOutput) => void), - cb?: (err: any, data?: GetBlockCommandOutput) => void - ): Promise | void { - const command = new GetBlockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the digest of a ledger at the latest committed block in the journal. The - * response includes a 256-bit hash value and a block address.

+ * @see {@link GetDigestCommand} */ - public getDigest(args: GetDigestCommandInput, options?: __HttpHandlerOptions): Promise; - public getDigest(args: GetDigestCommandInput, cb: (err: any, data?: GetDigestCommandOutput) => void): void; - public getDigest( + getDigest(args: GetDigestCommandInput, options?: __HttpHandlerOptions): Promise; + getDigest(args: GetDigestCommandInput, cb: (err: any, data?: GetDigestCommandOutput) => void): void; + getDigest( args: GetDigestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDigestCommandOutput) => void ): void; - public getDigest( - args: GetDigestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDigestCommandOutput) => void), - cb?: (err: any, data?: GetDigestCommandOutput) => void - ): Promise | void { - const command = new GetDigestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a revision data object for a specified document ID and block address. Also - * returns a proof of the specified revision for verification if DigestTipAddress - * is provided.

+ * @see {@link GetRevisionCommand} */ - public getRevision(args: GetRevisionCommandInput, options?: __HttpHandlerOptions): Promise; - public getRevision(args: GetRevisionCommandInput, cb: (err: any, data?: GetRevisionCommandOutput) => void): void; - public getRevision( + getRevision(args: GetRevisionCommandInput, options?: __HttpHandlerOptions): Promise; + getRevision(args: GetRevisionCommandInput, cb: (err: any, data?: GetRevisionCommandOutput) => void): void; + getRevision( args: GetRevisionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRevisionCommandOutput) => void ): void; - public getRevision( - args: GetRevisionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRevisionCommandOutput) => void), - cb?: (err: any, data?: GetRevisionCommandOutput) => void - ): Promise | void { - const command = new GetRevisionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of all Amazon QLDB journal stream descriptors for a given ledger. The - * output of each stream descriptor includes the same details that are returned by - * DescribeJournalKinesisStream.

- *

This action does not return any expired journal streams. For more information, see - * Expiration for terminal streams in the Amazon QLDB Developer - * Guide.

- *

This action returns a maximum of MaxResults items. It is paginated so that - * you can retrieve all the items by calling ListJournalKinesisStreamsForLedger - * multiple times.

+ * @see {@link ListJournalKinesisStreamsForLedgerCommand} */ - public listJournalKinesisStreamsForLedger( + listJournalKinesisStreamsForLedger( args: ListJournalKinesisStreamsForLedgerCommandInput, options?: __HttpHandlerOptions ): Promise; - public listJournalKinesisStreamsForLedger( + listJournalKinesisStreamsForLedger( args: ListJournalKinesisStreamsForLedgerCommandInput, cb: (err: any, data?: ListJournalKinesisStreamsForLedgerCommandOutput) => void ): void; - public listJournalKinesisStreamsForLedger( + listJournalKinesisStreamsForLedger( args: ListJournalKinesisStreamsForLedgerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJournalKinesisStreamsForLedgerCommandOutput) => void ): void; - public listJournalKinesisStreamsForLedger( - args: ListJournalKinesisStreamsForLedgerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJournalKinesisStreamsForLedgerCommandOutput) => void), - cb?: (err: any, data?: ListJournalKinesisStreamsForLedgerCommandOutput) => void - ): Promise | void { - const command = new ListJournalKinesisStreamsForLedgerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of journal export job descriptions for all ledgers that are associated - * with the current Amazon Web Services account and Region.

- *

This action returns a maximum of MaxResults items, and is paginated so that - * you can retrieve all the items by calling ListJournalS3Exports multiple - * times.

- *

This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer - * Guide.

+ * @see {@link ListJournalS3ExportsCommand} */ - public listJournalS3Exports( + listJournalS3Exports( args: ListJournalS3ExportsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listJournalS3Exports( + listJournalS3Exports( args: ListJournalS3ExportsCommandInput, cb: (err: any, data?: ListJournalS3ExportsCommandOutput) => void ): void; - public listJournalS3Exports( + listJournalS3Exports( args: ListJournalS3ExportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJournalS3ExportsCommandOutput) => void ): void; - public listJournalS3Exports( - args: ListJournalS3ExportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJournalS3ExportsCommandOutput) => void), - cb?: (err: any, data?: ListJournalS3ExportsCommandOutput) => void - ): Promise | void { - const command = new ListJournalS3ExportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of journal export job descriptions for a specified ledger.

- *

This action returns a maximum of MaxResults items, and is paginated so that - * you can retrieve all the items by calling ListJournalS3ExportsForLedger - * multiple times.

- *

This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer - * Guide.

+ * @see {@link ListJournalS3ExportsForLedgerCommand} */ - public listJournalS3ExportsForLedger( + listJournalS3ExportsForLedger( args: ListJournalS3ExportsForLedgerCommandInput, options?: __HttpHandlerOptions ): Promise; - public listJournalS3ExportsForLedger( + listJournalS3ExportsForLedger( args: ListJournalS3ExportsForLedgerCommandInput, cb: (err: any, data?: ListJournalS3ExportsForLedgerCommandOutput) => void ): void; - public listJournalS3ExportsForLedger( + listJournalS3ExportsForLedger( args: ListJournalS3ExportsForLedgerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJournalS3ExportsForLedgerCommandOutput) => void ): void; - public listJournalS3ExportsForLedger( - args: ListJournalS3ExportsForLedgerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJournalS3ExportsForLedgerCommandOutput) => void), - cb?: (err: any, data?: ListJournalS3ExportsForLedgerCommandOutput) => void - ): Promise | void { - const command = new ListJournalS3ExportsForLedgerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of ledger summaries that are associated with the current Amazon Web Services account - * and Region.

- *

This action returns a maximum of 100 items and is paginated so that you can - * retrieve all the items by calling ListLedgers multiple times.

+ * @see {@link ListLedgersCommand} */ - public listLedgers(args: ListLedgersCommandInput, options?: __HttpHandlerOptions): Promise; - public listLedgers(args: ListLedgersCommandInput, cb: (err: any, data?: ListLedgersCommandOutput) => void): void; - public listLedgers( + listLedgers(args: ListLedgersCommandInput, options?: __HttpHandlerOptions): Promise; + listLedgers(args: ListLedgersCommandInput, cb: (err: any, data?: ListLedgersCommandOutput) => void): void; + listLedgers( args: ListLedgersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLedgersCommandOutput) => void ): void; - public listLedgers( - args: ListLedgersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLedgersCommandOutput) => void), - cb?: (err: any, data?: ListLedgersCommandOutput) => void - ): Promise | void { - const command = new ListLedgersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns all tags for a specified Amazon QLDB resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a journal stream for a given Amazon QLDB ledger. The stream captures every - * document revision that is committed to the ledger's journal and delivers the data to a - * specified Amazon Kinesis Data Streams resource.

+ * @see {@link StreamJournalToKinesisCommand} */ - public streamJournalToKinesis( + streamJournalToKinesis( args: StreamJournalToKinesisCommandInput, options?: __HttpHandlerOptions ): Promise; - public streamJournalToKinesis( + streamJournalToKinesis( args: StreamJournalToKinesisCommandInput, cb: (err: any, data?: StreamJournalToKinesisCommandOutput) => void ): void; - public streamJournalToKinesis( + streamJournalToKinesis( args: StreamJournalToKinesisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StreamJournalToKinesisCommandOutput) => void ): void; - public streamJournalToKinesis( - args: StreamJournalToKinesisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StreamJournalToKinesisCommandOutput) => void), - cb?: (err: any, data?: StreamJournalToKinesisCommandOutput) => void - ): Promise | void { - const command = new StreamJournalToKinesisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more tags to a specified Amazon QLDB resource.

- *

A resource can have up to 50 tags. If you try to create more than 50 tags for a - * resource, your request fails and returns an error.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 - * tag keys to remove.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates properties on a ledger.

+ * @see {@link UpdateLedgerCommand} */ - public updateLedger( - args: UpdateLedgerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateLedger(args: UpdateLedgerCommandInput, cb: (err: any, data?: UpdateLedgerCommandOutput) => void): void; - public updateLedger( + updateLedger(args: UpdateLedgerCommandInput, options?: __HttpHandlerOptions): Promise; + updateLedger(args: UpdateLedgerCommandInput, cb: (err: any, data?: UpdateLedgerCommandOutput) => void): void; + updateLedger( args: UpdateLedgerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLedgerCommandOutput) => void ): void; - public updateLedger( - args: UpdateLedgerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLedgerCommandOutput) => void), - cb?: (err: any, data?: UpdateLedgerCommandOutput) => void - ): Promise | void { - const command = new UpdateLedgerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the permissions mode of a ledger.

- * - *

Before you switch to the STANDARD permissions mode, you must first - * create all required IAM policies and table tags to avoid disruption to your users. To - * learn more, see Migrating to the standard permissions mode in the Amazon QLDB - * Developer Guide.

- *
+ * @see {@link UpdateLedgerPermissionsModeCommand} */ - public updateLedgerPermissionsMode( + updateLedgerPermissionsMode( args: UpdateLedgerPermissionsModeCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLedgerPermissionsMode( + updateLedgerPermissionsMode( args: UpdateLedgerPermissionsModeCommandInput, cb: (err: any, data?: UpdateLedgerPermissionsModeCommandOutput) => void ): void; - public updateLedgerPermissionsMode( + updateLedgerPermissionsMode( args: UpdateLedgerPermissionsModeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLedgerPermissionsModeCommandOutput) => void ): void; - public updateLedgerPermissionsMode( - args: UpdateLedgerPermissionsModeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLedgerPermissionsModeCommandOutput) => void), - cb?: (err: any, data?: UpdateLedgerPermissionsModeCommandOutput) => void - ): Promise | void { - const command = new UpdateLedgerPermissionsModeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The control plane for Amazon QLDB

+ */ +export class QLDB extends QLDBClient implements QLDB {} +createAggregatedClient(commands, QLDB); diff --git a/clients/client-quicksight/src/QuickSight.ts b/clients/client-quicksight/src/QuickSight.ts index 3e8bdf4d7441..a9eddee467bb 100644 --- a/clients/client-quicksight/src/QuickSight.ts +++ b/clients/client-quicksight/src/QuickSight.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -619,4750 +620,2189 @@ import { UpdateThemePermissionsCommandOutput, } from "./commands/UpdateThemePermissionsCommand"; import { UpdateUserCommand, UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand"; -import { QuickSightClient } from "./QuickSightClient"; +import { QuickSightClient, QuickSightClientConfig } from "./QuickSightClient"; -/** - * @public - * Amazon QuickSight API Reference - *

Amazon QuickSight is a fully managed, serverless business intelligence service for the - * Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your - * organization. This API reference contains documentation for a programming interface that - * you can use to manage Amazon QuickSight.

- */ -export class QuickSight extends QuickSightClient { +const commands = { + CancelIngestionCommand, + CreateAccountCustomizationCommand, + CreateAccountSubscriptionCommand, + CreateAnalysisCommand, + CreateDashboardCommand, + CreateDataSetCommand, + CreateDataSourceCommand, + CreateFolderCommand, + CreateFolderMembershipCommand, + CreateGroupCommand, + CreateGroupMembershipCommand, + CreateIAMPolicyAssignmentCommand, + CreateIngestionCommand, + CreateNamespaceCommand, + CreateRefreshScheduleCommand, + CreateTemplateCommand, + CreateTemplateAliasCommand, + CreateThemeCommand, + CreateThemeAliasCommand, + DeleteAccountCustomizationCommand, + DeleteAccountSubscriptionCommand, + DeleteAnalysisCommand, + DeleteDashboardCommand, + DeleteDataSetCommand, + DeleteDataSetRefreshPropertiesCommand, + DeleteDataSourceCommand, + DeleteFolderCommand, + DeleteFolderMembershipCommand, + DeleteGroupCommand, + DeleteGroupMembershipCommand, + DeleteIAMPolicyAssignmentCommand, + DeleteNamespaceCommand, + DeleteRefreshScheduleCommand, + DeleteTemplateCommand, + DeleteTemplateAliasCommand, + DeleteThemeCommand, + DeleteThemeAliasCommand, + DeleteUserCommand, + DeleteUserByPrincipalIdCommand, + DescribeAccountCustomizationCommand, + DescribeAccountSettingsCommand, + DescribeAccountSubscriptionCommand, + DescribeAnalysisCommand, + DescribeAnalysisDefinitionCommand, + DescribeAnalysisPermissionsCommand, + DescribeDashboardCommand, + DescribeDashboardDefinitionCommand, + DescribeDashboardPermissionsCommand, + DescribeDataSetCommand, + DescribeDataSetPermissionsCommand, + DescribeDataSetRefreshPropertiesCommand, + DescribeDataSourceCommand, + DescribeDataSourcePermissionsCommand, + DescribeFolderCommand, + DescribeFolderPermissionsCommand, + DescribeFolderResolvedPermissionsCommand, + DescribeGroupCommand, + DescribeGroupMembershipCommand, + DescribeIAMPolicyAssignmentCommand, + DescribeIngestionCommand, + DescribeIpRestrictionCommand, + DescribeNamespaceCommand, + DescribeRefreshScheduleCommand, + DescribeTemplateCommand, + DescribeTemplateAliasCommand, + DescribeTemplateDefinitionCommand, + DescribeTemplatePermissionsCommand, + DescribeThemeCommand, + DescribeThemeAliasCommand, + DescribeThemePermissionsCommand, + DescribeUserCommand, + GenerateEmbedUrlForAnonymousUserCommand, + GenerateEmbedUrlForRegisteredUserCommand, + GetDashboardEmbedUrlCommand, + GetSessionEmbedUrlCommand, + ListAnalysesCommand, + ListDashboardsCommand, + ListDashboardVersionsCommand, + ListDataSetsCommand, + ListDataSourcesCommand, + ListFolderMembersCommand, + ListFoldersCommand, + ListGroupMembershipsCommand, + ListGroupsCommand, + ListIAMPolicyAssignmentsCommand, + ListIAMPolicyAssignmentsForUserCommand, + ListIngestionsCommand, + ListNamespacesCommand, + ListRefreshSchedulesCommand, + ListTagsForResourceCommand, + ListTemplateAliasesCommand, + ListTemplatesCommand, + ListTemplateVersionsCommand, + ListThemeAliasesCommand, + ListThemesCommand, + ListThemeVersionsCommand, + ListUserGroupsCommand, + ListUsersCommand, + PutDataSetRefreshPropertiesCommand, + RegisterUserCommand, + RestoreAnalysisCommand, + SearchAnalysesCommand, + SearchDashboardsCommand, + SearchDataSetsCommand, + SearchDataSourcesCommand, + SearchFoldersCommand, + SearchGroupsCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAccountCustomizationCommand, + UpdateAccountSettingsCommand, + UpdateAnalysisCommand, + UpdateAnalysisPermissionsCommand, + UpdateDashboardCommand, + UpdateDashboardPermissionsCommand, + UpdateDashboardPublishedVersionCommand, + UpdateDataSetCommand, + UpdateDataSetPermissionsCommand, + UpdateDataSourceCommand, + UpdateDataSourcePermissionsCommand, + UpdateFolderCommand, + UpdateFolderPermissionsCommand, + UpdateGroupCommand, + UpdateIAMPolicyAssignmentCommand, + UpdateIpRestrictionCommand, + UpdatePublicSharingSettingsCommand, + UpdateRefreshScheduleCommand, + UpdateTemplateCommand, + UpdateTemplateAliasCommand, + UpdateTemplatePermissionsCommand, + UpdateThemeCommand, + UpdateThemeAliasCommand, + UpdateThemePermissionsCommand, + UpdateUserCommand, +}; + +export interface QuickSight { /** - * @public - *

Cancels an ongoing ingestion of data into SPICE.

+ * @see {@link CancelIngestionCommand} */ - public cancelIngestion( + cancelIngestion( args: CancelIngestionCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelIngestion( - args: CancelIngestionCommandInput, - cb: (err: any, data?: CancelIngestionCommandOutput) => void - ): void; - public cancelIngestion( + cancelIngestion(args: CancelIngestionCommandInput, cb: (err: any, data?: CancelIngestionCommandOutput) => void): void; + cancelIngestion( args: CancelIngestionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelIngestionCommandOutput) => void ): void; - public cancelIngestion( - args: CancelIngestionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelIngestionCommandOutput) => void), - cb?: (err: any, data?: CancelIngestionCommandOutput) => void - ): Promise | void { - const command = new CancelIngestionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the - * CreateAccountCustomization or UpdateAccountCustomization - * API operation. To further customize Amazon QuickSight by removing Amazon QuickSight - * sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide. - *

- *

You can create customizations for your Amazon Web Services account or, if you specify a namespace, for - * a QuickSight namespace instead. Customizations that apply to a namespace always override - * customizations that apply to an Amazon Web Services account. To find out which customizations apply, use - * the DescribeAccountCustomization API operation.

- *

Before you use the CreateAccountCustomization API operation to add a theme - * as the namespace default, make sure that you first share the theme with the namespace. - * If you don't share it with the namespace, the theme isn't visible to your users - * even if you make it the default theme. - * To check if the theme is shared, view the current permissions by using the - * - * DescribeThemePermissions - * - * API operation. - * To share the theme, grant permissions by using the - * - * UpdateThemePermissions - * - * API operation.

- */ - public createAccountCustomization( + + /** + * @see {@link CreateAccountCustomizationCommand} + */ + createAccountCustomization( args: CreateAccountCustomizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAccountCustomization( + createAccountCustomization( args: CreateAccountCustomizationCommandInput, cb: (err: any, data?: CreateAccountCustomizationCommandOutput) => void ): void; - public createAccountCustomization( + createAccountCustomization( args: CreateAccountCustomizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccountCustomizationCommandOutput) => void ): void; - public createAccountCustomization( - args: CreateAccountCustomizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAccountCustomizationCommandOutput) => void), - cb?: (err: any, data?: CreateAccountCustomizationCommandOutput) => void - ): Promise | void { - const command = new CreateAccountCustomizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.

- *

The Amazon Web Services Region for the account is derived from what is configured in the - * CLI or SDK. This operation isn't supported in the US East (Ohio) Region, South America (Sao Paulo) Region, or Asia - * Pacific (Singapore) Region.

- *

Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign - * up for Amazon Web Services in the Amazon QuickSight User - * Guide. The person who signs up for Amazon QuickSight needs to have the - * correct Identity and Access Management (IAM) permissions. For more information, - * see IAM Policy Examples for Amazon QuickSight in the - * Amazon QuickSight User Guide.

- *

If your IAM policy includes both the Subscribe and - * CreateAccountSubscription actions, make sure that both actions are set - * to Allow. If either action is set to Deny, the - * Deny action prevails and your API call fails.

- *

You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to - * Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the - * Amazon QuickSight User Guide.

- *

You can't set default resource access on the new account from the Amazon QuickSight - * API. Instead, add default resource access from the Amazon QuickSight console. For more - * information about setting default resource access to Amazon Web Services services, see - * Setting default resource - * access to Amazon Web Services services in the Amazon QuickSight - * User Guide.

- */ - public createAccountSubscription( + + /** + * @see {@link CreateAccountSubscriptionCommand} + */ + createAccountSubscription( args: CreateAccountSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAccountSubscription( + createAccountSubscription( args: CreateAccountSubscriptionCommandInput, cb: (err: any, data?: CreateAccountSubscriptionCommandOutput) => void ): void; - public createAccountSubscription( + createAccountSubscription( args: CreateAccountSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccountSubscriptionCommandOutput) => void ): void; - public createAccountSubscription( - args: CreateAccountSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAccountSubscriptionCommandOutput) => void), - cb?: (err: any, data?: CreateAccountSubscriptionCommandOutput) => void - ): Promise | void { - const command = new CreateAccountSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an AnalysisDefinition.

- */ - public createAnalysis( + + /** + * @see {@link CreateAnalysisCommand} + */ + createAnalysis( args: CreateAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAnalysis( - args: CreateAnalysisCommandInput, - cb: (err: any, data?: CreateAnalysisCommandOutput) => void - ): void; - public createAnalysis( + createAnalysis(args: CreateAnalysisCommandInput, cb: (err: any, data?: CreateAnalysisCommandOutput) => void): void; + createAnalysis( args: CreateAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAnalysisCommandOutput) => void ): void; - public createAnalysis( - args: CreateAnalysisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAnalysisCommandOutput) => void), - cb?: (err: any, data?: CreateAnalysisCommandOutput) => void - ): Promise | void { - const command = new CreateAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the - * - * CreateTemplate - * - * API operation.

- *

A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created - * from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can - * create scheduled email reports from them. If you have the correct permissions, you can - * create a dashboard from a template that exists in a different Amazon Web Services account.

- */ - public createDashboard( + + /** + * @see {@link CreateDashboardCommand} + */ + createDashboard( args: CreateDashboardCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDashboard( - args: CreateDashboardCommandInput, - cb: (err: any, data?: CreateDashboardCommandOutput) => void - ): void; - public createDashboard( + createDashboard(args: CreateDashboardCommandInput, cb: (err: any, data?: CreateDashboardCommandOutput) => void): void; + createDashboard( args: CreateDashboardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDashboardCommandOutput) => void ): void; - public createDashboard( - args: CreateDashboardCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDashboardCommandOutput) => void), - cb?: (err: any, data?: CreateDashboardCommandOutput) => void - ): Promise | void { - const command = new CreateDashboardCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.

- */ - public createDataSet( - args: CreateDataSetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createDataSet( - args: CreateDataSetCommandInput, - cb: (err: any, data?: CreateDataSetCommandOutput) => void - ): void; - public createDataSet( + + /** + * @see {@link CreateDataSetCommand} + */ + createDataSet(args: CreateDataSetCommandInput, options?: __HttpHandlerOptions): Promise; + createDataSet(args: CreateDataSetCommandInput, cb: (err: any, data?: CreateDataSetCommandOutput) => void): void; + createDataSet( args: CreateDataSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataSetCommandOutput) => void ): void; - public createDataSet( - args: CreateDataSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDataSetCommandOutput) => void), - cb?: (err: any, data?: CreateDataSetCommandOutput) => void - ): Promise | void { - const command = new CreateDataSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a data source.

- */ - public createDataSource( + + /** + * @see {@link CreateDataSourceCommand} + */ + createDataSource( args: CreateDataSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDataSource( + createDataSource( args: CreateDataSourceCommandInput, cb: (err: any, data?: CreateDataSourceCommandOutput) => void ): void; - public createDataSource( + createDataSource( args: CreateDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataSourceCommandOutput) => void ): void; - public createDataSource( - args: CreateDataSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDataSourceCommandOutput) => void), - cb?: (err: any, data?: CreateDataSourceCommandOutput) => void - ): Promise | void { - const command = new CreateDataSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an empty shared folder.

- */ - public createFolder( - args: CreateFolderCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createFolder(args: CreateFolderCommandInput, cb: (err: any, data?: CreateFolderCommandOutput) => void): void; - public createFolder( + + /** + * @see {@link CreateFolderCommand} + */ + createFolder(args: CreateFolderCommandInput, options?: __HttpHandlerOptions): Promise; + createFolder(args: CreateFolderCommandInput, cb: (err: any, data?: CreateFolderCommandOutput) => void): void; + createFolder( args: CreateFolderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFolderCommandOutput) => void ): void; - public createFolder( - args: CreateFolderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFolderCommandOutput) => void), - cb?: (err: any, data?: CreateFolderCommandOutput) => void - ): Promise | void { - const command = new CreateFolderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds an asset, such as a dashboard, analysis, or dataset into a folder.

- */ - public createFolderMembership( + + /** + * @see {@link CreateFolderMembershipCommand} + */ + createFolderMembership( args: CreateFolderMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFolderMembership( + createFolderMembership( args: CreateFolderMembershipCommandInput, cb: (err: any, data?: CreateFolderMembershipCommandOutput) => void ): void; - public createFolderMembership( + createFolderMembership( args: CreateFolderMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFolderMembershipCommandOutput) => void ): void; - public createFolderMembership( - args: CreateFolderMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFolderMembershipCommandOutput) => void), - cb?: (err: any, data?: CreateFolderMembershipCommandOutput) => void - ): Promise | void { - const command = new CreateFolderMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Use the CreateGroup operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact AWS Support.

- *

The permissions resource is - * arn:aws:quicksight:::group/default/ - * .

- *

The response is a group object.

- */ - public createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void; - public createGroup( + + /** + * @see {@link CreateGroupCommand} + */ + createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise; + createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void; + createGroup( args: CreateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupCommandOutput) => void ): void; - public createGroup( - args: CreateGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGroupCommandOutput) => void), - cb?: (err: any, data?: CreateGroupCommandOutput) => void - ): Promise | void { - const command = new CreateGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds an Amazon QuickSight user to an Amazon QuickSight group.

- */ - public createGroupMembership( + + /** + * @see {@link CreateGroupMembershipCommand} + */ + createGroupMembership( args: CreateGroupMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public createGroupMembership( + createGroupMembership( args: CreateGroupMembershipCommandInput, cb: (err: any, data?: CreateGroupMembershipCommandOutput) => void ): void; - public createGroupMembership( + createGroupMembership( args: CreateGroupMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupMembershipCommandOutput) => void ): void; - public createGroupMembership( - args: CreateGroupMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGroupMembershipCommandOutput) => void), - cb?: (err: any, data?: CreateGroupMembershipCommandOutput) => void - ): Promise | void { - const command = new CreateGroupMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name - * (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. - * Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, - * use assignment names that are unique.

- */ - public createIAMPolicyAssignment( + + /** + * @see {@link CreateIAMPolicyAssignmentCommand} + */ + createIAMPolicyAssignment( args: CreateIAMPolicyAssignmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createIAMPolicyAssignment( + createIAMPolicyAssignment( args: CreateIAMPolicyAssignmentCommandInput, cb: (err: any, data?: CreateIAMPolicyAssignmentCommandOutput) => void ): void; - public createIAMPolicyAssignment( + createIAMPolicyAssignment( args: CreateIAMPolicyAssignmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIAMPolicyAssignmentCommandOutput) => void ): void; - public createIAMPolicyAssignment( - args: CreateIAMPolicyAssignmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIAMPolicyAssignmentCommandOutput) => void), - cb?: (err: any, data?: CreateIAMPolicyAssignmentCommandOutput) => void - ): Promise | void { - const command = new CreateIAMPolicyAssignmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in - * an Enterprise edition account 32 times in a 24-hour period. You can manually refresh - * datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period - * is measured starting 24 hours before the current date and time.

- *

Any ingestions operating on tagged datasets inherit the same tags automatically for use in - * access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using - * tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

- */ - public createIngestion( + + /** + * @see {@link CreateIngestionCommand} + */ + createIngestion( args: CreateIngestionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createIngestion( - args: CreateIngestionCommandInput, - cb: (err: any, data?: CreateIngestionCommandOutput) => void - ): void; - public createIngestion( + createIngestion(args: CreateIngestionCommandInput, cb: (err: any, data?: CreateIngestionCommandOutput) => void): void; + createIngestion( args: CreateIngestionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIngestionCommandOutput) => void ): void; - public createIngestion( - args: CreateIngestionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIngestionCommandOutput) => void), - cb?: (err: any, data?: CreateIngestionCommandOutput) => void - ): Promise | void { - const command = new CreateIngestionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.

- *

A namespace allows you to isolate the Amazon QuickSight users and groups that are registered - * for that namespace. Users that access the namespace can share assets only with other - * users or groups in the same namespace. They can't see users and groups in other - * namespaces. You can create a namespace after your Amazon Web Services account is subscribed to - * Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a - * limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with - * Amazon Web Services Support.

- */ - public createNamespace( + + /** + * @see {@link CreateNamespaceCommand} + */ + createNamespace( args: CreateNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNamespace( - args: CreateNamespaceCommandInput, - cb: (err: any, data?: CreateNamespaceCommandOutput) => void - ): void; - public createNamespace( + createNamespace(args: CreateNamespaceCommandInput, cb: (err: any, data?: CreateNamespaceCommandOutput) => void): void; + createNamespace( args: CreateNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNamespaceCommandOutput) => void ): void; - public createNamespace( - args: CreateNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNamespaceCommandOutput) => void), - cb?: (err: any, data?: CreateNamespaceCommandOutput) => void - ): Promise | void { - const command = new CreateNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.

- */ - public createRefreshSchedule( + + /** + * @see {@link CreateRefreshScheduleCommand} + */ + createRefreshSchedule( args: CreateRefreshScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRefreshSchedule( + createRefreshSchedule( args: CreateRefreshScheduleCommandInput, cb: (err: any, data?: CreateRefreshScheduleCommandOutput) => void ): void; - public createRefreshSchedule( + createRefreshSchedule( args: CreateRefreshScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRefreshScheduleCommandOutput) => void ): void; - public createRefreshSchedule( - args: CreateRefreshScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRefreshScheduleCommandOutput) => void), - cb?: (err: any, data?: CreateRefreshScheduleCommandOutput) => void - ): Promise | void { - const command = new CreateRefreshScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template. You can use the resulting - * template to create additional dashboards, templates, or analyses.

- *

A template is an entity in Amazon QuickSight that encapsulates the metadata - * required to create an analysis and that you can use to create s dashboard. A template adds - * a layer of abstraction by using placeholders to replace the dataset associated with the - * analysis. You can use templates to create dashboards by replacing dataset placeholders - * with datasets that follow the same schema that was used to create the source analysis - * and template.

- */ - public createTemplate( + + /** + * @see {@link CreateTemplateCommand} + */ + createTemplate( args: CreateTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTemplate( - args: CreateTemplateCommandInput, - cb: (err: any, data?: CreateTemplateCommandOutput) => void - ): void; - public createTemplate( + createTemplate(args: CreateTemplateCommandInput, cb: (err: any, data?: CreateTemplateCommandOutput) => void): void; + createTemplate( args: CreateTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTemplateCommandOutput) => void ): void; - public createTemplate( - args: CreateTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a template alias for a template.

- */ - public createTemplateAlias( + + /** + * @see {@link CreateTemplateAliasCommand} + */ + createTemplateAlias( args: CreateTemplateAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTemplateAlias( + createTemplateAlias( args: CreateTemplateAliasCommandInput, cb: (err: any, data?: CreateTemplateAliasCommandOutput) => void ): void; - public createTemplateAlias( + createTemplateAlias( args: CreateTemplateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTemplateAliasCommandOutput) => void ): void; - public createTemplateAlias( - args: CreateTemplateAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTemplateAliasCommandOutput) => void), - cb?: (err: any, data?: CreateTemplateAliasCommandOutput) => void - ): Promise | void { - const command = new CreateTemplateAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a theme.

- *

A theme is set of configuration options for color and layout. - * Themes apply to analyses and dashboards. For more information, see Using - * Themes in Amazon QuickSight in the Amazon QuickSight User Guide.

- */ - public createTheme(args: CreateThemeCommandInput, options?: __HttpHandlerOptions): Promise; - public createTheme(args: CreateThemeCommandInput, cb: (err: any, data?: CreateThemeCommandOutput) => void): void; - public createTheme( + + /** + * @see {@link CreateThemeCommand} + */ + createTheme(args: CreateThemeCommandInput, options?: __HttpHandlerOptions): Promise; + createTheme(args: CreateThemeCommandInput, cb: (err: any, data?: CreateThemeCommandOutput) => void): void; + createTheme( args: CreateThemeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateThemeCommandOutput) => void ): void; - public createTheme( - args: CreateThemeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateThemeCommandOutput) => void), - cb?: (err: any, data?: CreateThemeCommandOutput) => void - ): Promise | void { - const command = new CreateThemeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a theme alias for a theme.

- */ - public createThemeAlias( + + /** + * @see {@link CreateThemeAliasCommand} + */ + createThemeAlias( args: CreateThemeAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public createThemeAlias( + createThemeAlias( args: CreateThemeAliasCommandInput, cb: (err: any, data?: CreateThemeAliasCommandOutput) => void ): void; - public createThemeAlias( + createThemeAlias( args: CreateThemeAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateThemeAliasCommandOutput) => void ): void; - public createThemeAlias( - args: CreateThemeAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateThemeAliasCommandOutput) => void), - cb?: (err: any, data?: CreateThemeAliasCommandOutput) => void - ): Promise | void { - const command = new CreateThemeAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified - * Amazon Web Services account and Amazon QuickSight namespace.

- */ - public deleteAccountCustomization( + + /** + * @see {@link DeleteAccountCustomizationCommand} + */ + deleteAccountCustomization( args: DeleteAccountCustomizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAccountCustomization( + deleteAccountCustomization( args: DeleteAccountCustomizationCommandInput, cb: (err: any, data?: DeleteAccountCustomizationCommandOutput) => void ): void; - public deleteAccountCustomization( + deleteAccountCustomization( args: DeleteAccountCustomizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccountCustomizationCommandOutput) => void ): void; - public deleteAccountCustomization( - args: DeleteAccountCustomizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAccountCustomizationCommandOutput) => void), - cb?: (err: any, data?: DeleteAccountCustomizationCommandOutput) => void - ): Promise | void { - const command = new DeleteAccountCustomizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Use the DeleteAccountSubscription operation to delete an Amazon QuickSight account. This operation will result in an error message if you have configured your account termination protection settings to True. To change this setting and delete your account, call the UpdateAccountSettings API and set the value of the TerminationProtectionEnabled parameter to False, then make another call to the DeleteAccountSubscription API.

- */ - public deleteAccountSubscription( + + /** + * @see {@link DeleteAccountSubscriptionCommand} + */ + deleteAccountSubscription( args: DeleteAccountSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAccountSubscription( + deleteAccountSubscription( args: DeleteAccountSubscriptionCommandInput, cb: (err: any, data?: DeleteAccountSubscriptionCommandOutput) => void ): void; - public deleteAccountSubscription( + deleteAccountSubscription( args: DeleteAccountSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccountSubscriptionCommandOutput) => void ): void; - public deleteAccountSubscription( - args: DeleteAccountSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAccountSubscriptionCommandOutput) => void), - cb?: (err: any, data?: DeleteAccountSubscriptionCommandOutput) => void - ): Promise | void { - const command = new DeleteAccountSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during - * which you can restore the analysis. If you don't specify a recovery window value, the - * operation defaults to 30 days. Amazon QuickSight attaches a DeletionTime stamp to - * the response that specifies the end of the recovery window. At the end of the recovery - * window, Amazon QuickSight deletes the analysis permanently.

- *

At any time before recovery window ends, you can use the RestoreAnalysis - * API operation to remove the DeletionTime stamp and cancel the deletion of - * the analysis. The analysis remains visible in the API until it's deleted, so you can - * describe it but you can't make a template from it.

- *

An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console. - * To access it in the console, restore it. Deleting an analysis doesn't delete the - * dashboards that you publish from it.

- */ - public deleteAnalysis( + + /** + * @see {@link DeleteAnalysisCommand} + */ + deleteAnalysis( args: DeleteAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAnalysis( - args: DeleteAnalysisCommandInput, - cb: (err: any, data?: DeleteAnalysisCommandOutput) => void - ): void; - public deleteAnalysis( + deleteAnalysis(args: DeleteAnalysisCommandInput, cb: (err: any, data?: DeleteAnalysisCommandOutput) => void): void; + deleteAnalysis( args: DeleteAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAnalysisCommandOutput) => void ): void; - public deleteAnalysis( - args: DeleteAnalysisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAnalysisCommandOutput) => void), - cb?: (err: any, data?: DeleteAnalysisCommandOutput) => void - ): Promise | void { - const command = new DeleteAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a dashboard.

- */ - public deleteDashboard( + + /** + * @see {@link DeleteDashboardCommand} + */ + deleteDashboard( args: DeleteDashboardCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDashboard( - args: DeleteDashboardCommandInput, - cb: (err: any, data?: DeleteDashboardCommandOutput) => void - ): void; - public deleteDashboard( + deleteDashboard(args: DeleteDashboardCommandInput, cb: (err: any, data?: DeleteDashboardCommandOutput) => void): void; + deleteDashboard( args: DeleteDashboardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDashboardCommandOutput) => void ): void; - public deleteDashboard( - args: DeleteDashboardCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDashboardCommandOutput) => void), - cb?: (err: any, data?: DeleteDashboardCommandOutput) => void - ): Promise | void { - const command = new DeleteDashboardCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a dataset.

- */ - public deleteDataSet( - args: DeleteDataSetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDataSet( - args: DeleteDataSetCommandInput, - cb: (err: any, data?: DeleteDataSetCommandOutput) => void - ): void; - public deleteDataSet( + + /** + * @see {@link DeleteDataSetCommand} + */ + deleteDataSet(args: DeleteDataSetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDataSet(args: DeleteDataSetCommandInput, cb: (err: any, data?: DeleteDataSetCommandOutput) => void): void; + deleteDataSet( args: DeleteDataSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataSetCommandOutput) => void ): void; - public deleteDataSet( - args: DeleteDataSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDataSetCommandOutput) => void), - cb?: (err: any, data?: DeleteDataSetCommandOutput) => void - ): Promise | void { - const command = new DeleteDataSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the dataset refresh properties of the dataset.

- */ - public deleteDataSetRefreshProperties( + + /** + * @see {@link DeleteDataSetRefreshPropertiesCommand} + */ + deleteDataSetRefreshProperties( args: DeleteDataSetRefreshPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDataSetRefreshProperties( + deleteDataSetRefreshProperties( args: DeleteDataSetRefreshPropertiesCommandInput, cb: (err: any, data?: DeleteDataSetRefreshPropertiesCommandOutput) => void ): void; - public deleteDataSetRefreshProperties( + deleteDataSetRefreshProperties( args: DeleteDataSetRefreshPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataSetRefreshPropertiesCommandOutput) => void ): void; - public deleteDataSetRefreshProperties( - args: DeleteDataSetRefreshPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDataSetRefreshPropertiesCommandOutput) => void), - cb?: (err: any, data?: DeleteDataSetRefreshPropertiesCommandOutput) => void - ): Promise | void { - const command = new DeleteDataSetRefreshPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the data source permanently. This operation breaks - * all the datasets that reference the deleted data source.

- */ - public deleteDataSource( + + /** + * @see {@link DeleteDataSourceCommand} + */ + deleteDataSource( args: DeleteDataSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDataSource( + deleteDataSource( args: DeleteDataSourceCommandInput, cb: (err: any, data?: DeleteDataSourceCommandOutput) => void ): void; - public deleteDataSource( + deleteDataSource( args: DeleteDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataSourceCommandOutput) => void ): void; - public deleteDataSource( - args: DeleteDataSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDataSourceCommandOutput) => void), - cb?: (err: any, data?: DeleteDataSourceCommandOutput) => void - ): Promise | void { - const command = new DeleteDataSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an empty folder.

- */ - public deleteFolder( - args: DeleteFolderCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteFolder(args: DeleteFolderCommandInput, cb: (err: any, data?: DeleteFolderCommandOutput) => void): void; - public deleteFolder( + + /** + * @see {@link DeleteFolderCommand} + */ + deleteFolder(args: DeleteFolderCommandInput, options?: __HttpHandlerOptions): Promise; + deleteFolder(args: DeleteFolderCommandInput, cb: (err: any, data?: DeleteFolderCommandOutput) => void): void; + deleteFolder( args: DeleteFolderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFolderCommandOutput) => void ): void; - public deleteFolder( - args: DeleteFolderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFolderCommandOutput) => void), - cb?: (err: any, data?: DeleteFolderCommandOutput) => void - ): Promise | void { - const command = new DeleteFolderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes an asset, such as a dashboard, analysis, or dataset, from a folder.

- */ - public deleteFolderMembership( + + /** + * @see {@link DeleteFolderMembershipCommand} + */ + deleteFolderMembership( args: DeleteFolderMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFolderMembership( + deleteFolderMembership( args: DeleteFolderMembershipCommandInput, cb: (err: any, data?: DeleteFolderMembershipCommandOutput) => void ): void; - public deleteFolderMembership( + deleteFolderMembership( args: DeleteFolderMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFolderMembershipCommandOutput) => void ): void; - public deleteFolderMembership( - args: DeleteFolderMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFolderMembershipCommandOutput) => void), - cb?: (err: any, data?: DeleteFolderMembershipCommandOutput) => void - ): Promise | void { - const command = new DeleteFolderMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a user group from Amazon QuickSight.

- */ - public deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void; - public deleteGroup( + + /** + * @see {@link DeleteGroupCommand} + */ + deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise; + deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void; + deleteGroup( args: DeleteGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupCommandOutput) => void ): void; - public deleteGroup( - args: DeleteGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a user from a group so that the user is no longer a member of the group.

- */ - public deleteGroupMembership( + + /** + * @see {@link DeleteGroupMembershipCommand} + */ + deleteGroupMembership( args: DeleteGroupMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteGroupMembership( + deleteGroupMembership( args: DeleteGroupMembershipCommandInput, cb: (err: any, data?: DeleteGroupMembershipCommandOutput) => void ): void; - public deleteGroupMembership( + deleteGroupMembership( args: DeleteGroupMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupMembershipCommandOutput) => void ): void; - public deleteGroupMembership( - args: DeleteGroupMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGroupMembershipCommandOutput) => void), - cb?: (err: any, data?: DeleteGroupMembershipCommandOutput) => void - ): Promise | void { - const command = new DeleteGroupMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an existing IAM policy assignment.

- */ - public deleteIAMPolicyAssignment( + + /** + * @see {@link DeleteIAMPolicyAssignmentCommand} + */ + deleteIAMPolicyAssignment( args: DeleteIAMPolicyAssignmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteIAMPolicyAssignment( + deleteIAMPolicyAssignment( args: DeleteIAMPolicyAssignmentCommandInput, cb: (err: any, data?: DeleteIAMPolicyAssignmentCommandOutput) => void ): void; - public deleteIAMPolicyAssignment( + deleteIAMPolicyAssignment( args: DeleteIAMPolicyAssignmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIAMPolicyAssignmentCommandOutput) => void ): void; - public deleteIAMPolicyAssignment( - args: DeleteIAMPolicyAssignmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIAMPolicyAssignmentCommandOutput) => void), - cb?: (err: any, data?: DeleteIAMPolicyAssignmentCommandOutput) => void - ): Promise | void { - const command = new DeleteIAMPolicyAssignmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a namespace and the users and groups that are associated with the namespace. - * This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not - * deleted. To delete these assets, you use the API operations for the relevant asset.

- */ - public deleteNamespace( + + /** + * @see {@link DeleteNamespaceCommand} + */ + deleteNamespace( args: DeleteNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNamespace( - args: DeleteNamespaceCommandInput, - cb: (err: any, data?: DeleteNamespaceCommandOutput) => void - ): void; - public deleteNamespace( + deleteNamespace(args: DeleteNamespaceCommandInput, cb: (err: any, data?: DeleteNamespaceCommandOutput) => void): void; + deleteNamespace( args: DeleteNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNamespaceCommandOutput) => void ): void; - public deleteNamespace( - args: DeleteNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNamespaceCommandOutput) => void), - cb?: (err: any, data?: DeleteNamespaceCommandOutput) => void - ): Promise | void { - const command = new DeleteNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a refresh schedule from a dataset.

- */ - public deleteRefreshSchedule( + + /** + * @see {@link DeleteRefreshScheduleCommand} + */ + deleteRefreshSchedule( args: DeleteRefreshScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRefreshSchedule( + deleteRefreshSchedule( args: DeleteRefreshScheduleCommandInput, cb: (err: any, data?: DeleteRefreshScheduleCommandOutput) => void ): void; - public deleteRefreshSchedule( + deleteRefreshSchedule( args: DeleteRefreshScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRefreshScheduleCommandOutput) => void ): void; - public deleteRefreshSchedule( - args: DeleteRefreshScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRefreshScheduleCommandOutput) => void), - cb?: (err: any, data?: DeleteRefreshScheduleCommandOutput) => void - ): Promise | void { - const command = new DeleteRefreshScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a template.

- */ - public deleteTemplate( + + /** + * @see {@link DeleteTemplateCommand} + */ + deleteTemplate( args: DeleteTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTemplate( - args: DeleteTemplateCommandInput, - cb: (err: any, data?: DeleteTemplateCommandOutput) => void - ): void; - public deleteTemplate( + deleteTemplate(args: DeleteTemplateCommandInput, cb: (err: any, data?: DeleteTemplateCommandOutput) => void): void; + deleteTemplate( args: DeleteTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTemplateCommandOutput) => void ): void; - public deleteTemplate( - args: DeleteTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the item that the specified template alias points to. If you provide a specific - * alias, you delete the version of the template that the alias points to.

- */ - public deleteTemplateAlias( + + /** + * @see {@link DeleteTemplateAliasCommand} + */ + deleteTemplateAlias( args: DeleteTemplateAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTemplateAlias( + deleteTemplateAlias( args: DeleteTemplateAliasCommandInput, cb: (err: any, data?: DeleteTemplateAliasCommandOutput) => void ): void; - public deleteTemplateAlias( + deleteTemplateAlias( args: DeleteTemplateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTemplateAliasCommandOutput) => void ): void; - public deleteTemplateAlias( - args: DeleteTemplateAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTemplateAliasCommandOutput) => void), - cb?: (err: any, data?: DeleteTemplateAliasCommandOutput) => void - ): Promise | void { - const command = new DeleteTemplateAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a theme.

- */ - public deleteTheme(args: DeleteThemeCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteTheme(args: DeleteThemeCommandInput, cb: (err: any, data?: DeleteThemeCommandOutput) => void): void; - public deleteTheme( + + /** + * @see {@link DeleteThemeCommand} + */ + deleteTheme(args: DeleteThemeCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTheme(args: DeleteThemeCommandInput, cb: (err: any, data?: DeleteThemeCommandOutput) => void): void; + deleteTheme( args: DeleteThemeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteThemeCommandOutput) => void ): void; - public deleteTheme( - args: DeleteThemeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteThemeCommandOutput) => void), - cb?: (err: any, data?: DeleteThemeCommandOutput) => void - ): Promise | void { - const command = new DeleteThemeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the version of the theme that the specified theme alias points to. - * If you provide a specific alias, you delete the version of the theme - * that the alias points to.

- */ - public deleteThemeAlias( + + /** + * @see {@link DeleteThemeAliasCommand} + */ + deleteThemeAlias( args: DeleteThemeAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteThemeAlias( + deleteThemeAlias( args: DeleteThemeAliasCommandInput, cb: (err: any, data?: DeleteThemeAliasCommandOutput) => void ): void; - public deleteThemeAlias( + deleteThemeAlias( args: DeleteThemeAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteThemeAliasCommandOutput) => void ): void; - public deleteThemeAlias( - args: DeleteThemeAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteThemeAliasCommandOutput) => void), - cb?: (err: any, data?: DeleteThemeAliasCommandOutput) => void - ): Promise | void { - const command = new DeleteThemeAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the Amazon QuickSight user that is associated with the identity of the - * IAM user or role that's making the call. The IAM user - * isn't deleted as a result of this call.

- */ - public deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; - public deleteUser( + + /** + * @see {@link DeleteUserCommand} + */ + deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; + deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; + deleteUser( args: DeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserCommandOutput) => void ): void; - public deleteUser( - args: DeleteUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserCommandOutput) => void), - cb?: (err: any, data?: DeleteUserCommandOutput) => void - ): Promise | void { - const command = new DeleteUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a user identified by its principal ID.

- */ - public deleteUserByPrincipalId( + + /** + * @see {@link DeleteUserByPrincipalIdCommand} + */ + deleteUserByPrincipalId( args: DeleteUserByPrincipalIdCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteUserByPrincipalId( + deleteUserByPrincipalId( args: DeleteUserByPrincipalIdCommandInput, cb: (err: any, data?: DeleteUserByPrincipalIdCommandOutput) => void ): void; - public deleteUserByPrincipalId( + deleteUserByPrincipalId( args: DeleteUserByPrincipalIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserByPrincipalIdCommandOutput) => void ): void; - public deleteUserByPrincipalId( - args: DeleteUserByPrincipalIdCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserByPrincipalIdCommandOutput) => void), - cb?: (err: any, data?: DeleteUserByPrincipalIdCommandOutput) => void - ): Promise | void { - const command = new DeleteUserByPrincipalIdCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the customizations associated with the provided Amazon Web Services account and Amazon - * Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which - * customizations to apply by running this API operation with the Resolved flag - * included.

- *

To determine what customizations display when you run this command, it can help to - * visualize the relationship of the entities involved.

- *
    - *
  • - *

    - * Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy. - * It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you - * subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. - * That's where your free SPICE capacity is located. You can use Amazon QuickSight in any - * supported Amazon Web Services Region.

    - *
  • - *
  • - *

    - * Amazon Web Services Region - In each Amazon Web Services Region where you sign in to Amazon QuickSight - * at least once, Amazon QuickSight acts as a separate instance of the same service. If - * you have a user directory, it resides in us-east-1, which is the US East (N. - * Virginia). Generally speaking, these users have access to Amazon QuickSight in any - * Amazon Web Services Region, unless they are constrained to a namespace.

    - *

    To run the command in a different Amazon Web Services Region, you change your Region settings. - * If you're using the CLI, you can use one of the following options:

    - * - *
  • - *
  • - *

    - * Namespace - A QuickSight namespace is a partition that contains - * users and assets (data sources, datasets, dashboards, and so on). To access - * assets that are in a specific namespace, users and groups must also be part of - * the same namespace. People who share a namespace are completely isolated from - * users and assets in other namespaces, even if they are in the same Amazon Web Services account - * and Amazon Web Services Region.

    - *
  • - *
  • - *

    - * Applied customizations - Within an Amazon Web Services Region, a set of - * Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace. - * Settings that you apply to a namespace override settings that you apply to an - * Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in - * other Amazon Web Services Regions, run the CreateAccountCustomization command in - * each Amazon Web Services Region where you want to apply the same customizations.

    - *
  • - *
- */ - public describeAccountCustomization( + + /** + * @see {@link DescribeAccountCustomizationCommand} + */ + describeAccountCustomization( args: DescribeAccountCustomizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccountCustomization( + describeAccountCustomization( args: DescribeAccountCustomizationCommandInput, cb: (err: any, data?: DescribeAccountCustomizationCommandOutput) => void ): void; - public describeAccountCustomization( + describeAccountCustomization( args: DescribeAccountCustomizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountCustomizationCommandOutput) => void ): void; - public describeAccountCustomization( - args: DescribeAccountCustomizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccountCustomizationCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountCustomizationCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountCustomizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the settings that were used when your Amazon QuickSight subscription was first - * created in this Amazon Web Services account.

- */ - public describeAccountSettings( + + /** + * @see {@link DescribeAccountSettingsCommand} + */ + describeAccountSettings( args: DescribeAccountSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccountSettings( + describeAccountSettings( args: DescribeAccountSettingsCommandInput, cb: (err: any, data?: DescribeAccountSettingsCommandOutput) => void ): void; - public describeAccountSettings( + describeAccountSettings( args: DescribeAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountSettingsCommandOutput) => void ): void; - public describeAccountSettings( - args: DescribeAccountSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccountSettingsCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountSettingsCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.

- */ - public describeAccountSubscription( + + /** + * @see {@link DescribeAccountSubscriptionCommand} + */ + describeAccountSubscription( args: DescribeAccountSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccountSubscription( + describeAccountSubscription( args: DescribeAccountSubscriptionCommandInput, cb: (err: any, data?: DescribeAccountSubscriptionCommandOutput) => void ): void; - public describeAccountSubscription( + describeAccountSubscription( args: DescribeAccountSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountSubscriptionCommandOutput) => void ): void; - public describeAccountSubscription( - args: DescribeAccountSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccountSubscriptionCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountSubscriptionCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides a summary of the metadata for an analysis.

- */ - public describeAnalysis( + + /** + * @see {@link DescribeAnalysisCommand} + */ + describeAnalysis( args: DescribeAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAnalysis( + describeAnalysis( args: DescribeAnalysisCommandInput, cb: (err: any, data?: DescribeAnalysisCommandOutput) => void ): void; - public describeAnalysis( + describeAnalysis( args: DescribeAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAnalysisCommandOutput) => void ): void; - public describeAnalysis( - args: DescribeAnalysisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAnalysisCommandOutput) => void), - cb?: (err: any, data?: DescribeAnalysisCommandOutput) => void - ): Promise | void { - const command = new DescribeAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides a detailed description of the definition of an analysis.

- * - *

If you do not need to know details about the content of an Analysis, for instance if you - * are trying to check the status of a recently created or updated Analysis, use the - * - * DescribeAnalysis - * instead. - *

- *
- */ - public describeAnalysisDefinition( + + /** + * @see {@link DescribeAnalysisDefinitionCommand} + */ + describeAnalysisDefinition( args: DescribeAnalysisDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAnalysisDefinition( + describeAnalysisDefinition( args: DescribeAnalysisDefinitionCommandInput, cb: (err: any, data?: DescribeAnalysisDefinitionCommandOutput) => void ): void; - public describeAnalysisDefinition( + describeAnalysisDefinition( args: DescribeAnalysisDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAnalysisDefinitionCommandOutput) => void ): void; - public describeAnalysisDefinition( - args: DescribeAnalysisDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAnalysisDefinitionCommandOutput) => void), - cb?: (err: any, data?: DescribeAnalysisDefinitionCommandOutput) => void - ): Promise | void { - const command = new DescribeAnalysisDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides the read and write permissions for an analysis.

- */ - public describeAnalysisPermissions( + + /** + * @see {@link DescribeAnalysisPermissionsCommand} + */ + describeAnalysisPermissions( args: DescribeAnalysisPermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAnalysisPermissions( + describeAnalysisPermissions( args: DescribeAnalysisPermissionsCommandInput, cb: (err: any, data?: DescribeAnalysisPermissionsCommandOutput) => void ): void; - public describeAnalysisPermissions( + describeAnalysisPermissions( args: DescribeAnalysisPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAnalysisPermissionsCommandOutput) => void ): void; - public describeAnalysisPermissions( - args: DescribeAnalysisPermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAnalysisPermissionsCommandOutput) => void), - cb?: (err: any, data?: DescribeAnalysisPermissionsCommandOutput) => void - ): Promise | void { - const command = new DescribeAnalysisPermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides a summary for a dashboard.

- */ - public describeDashboard( + + /** + * @see {@link DescribeDashboardCommand} + */ + describeDashboard( args: DescribeDashboardCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDashboard( + describeDashboard( args: DescribeDashboardCommandInput, cb: (err: any, data?: DescribeDashboardCommandOutput) => void ): void; - public describeDashboard( + describeDashboard( args: DescribeDashboardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDashboardCommandOutput) => void ): void; - public describeDashboard( - args: DescribeDashboardCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDashboardCommandOutput) => void), - cb?: (err: any, data?: DescribeDashboardCommandOutput) => void - ): Promise | void { - const command = new DescribeDashboardCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides a detailed description of the definition of a dashboard.

- * - *

If you do not need to know details about the content of a dashboard, for instance if you - * are trying to check the status of a recently created or updated dashboard, use the - * - * DescribeDashboard - * instead. - *

- *
- */ - public describeDashboardDefinition( + + /** + * @see {@link DescribeDashboardDefinitionCommand} + */ + describeDashboardDefinition( args: DescribeDashboardDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDashboardDefinition( + describeDashboardDefinition( args: DescribeDashboardDefinitionCommandInput, cb: (err: any, data?: DescribeDashboardDefinitionCommandOutput) => void ): void; - public describeDashboardDefinition( + describeDashboardDefinition( args: DescribeDashboardDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDashboardDefinitionCommandOutput) => void ): void; - public describeDashboardDefinition( - args: DescribeDashboardDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDashboardDefinitionCommandOutput) => void), - cb?: (err: any, data?: DescribeDashboardDefinitionCommandOutput) => void - ): Promise | void { - const command = new DescribeDashboardDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes read and write permissions for a dashboard.

- */ - public describeDashboardPermissions( + + /** + * @see {@link DescribeDashboardPermissionsCommand} + */ + describeDashboardPermissions( args: DescribeDashboardPermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDashboardPermissions( + describeDashboardPermissions( args: DescribeDashboardPermissionsCommandInput, cb: (err: any, data?: DescribeDashboardPermissionsCommandOutput) => void ): void; - public describeDashboardPermissions( + describeDashboardPermissions( args: DescribeDashboardPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDashboardPermissionsCommandOutput) => void ): void; - public describeDashboardPermissions( - args: DescribeDashboardPermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDashboardPermissionsCommandOutput) => void), - cb?: (err: any, data?: DescribeDashboardPermissionsCommandOutput) => void - ): Promise | void { - const command = new DescribeDashboardPermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.

- */ - public describeDataSet( + + /** + * @see {@link DescribeDataSetCommand} + */ + describeDataSet( args: DescribeDataSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDataSet( - args: DescribeDataSetCommandInput, - cb: (err: any, data?: DescribeDataSetCommandOutput) => void - ): void; - public describeDataSet( + describeDataSet(args: DescribeDataSetCommandInput, cb: (err: any, data?: DescribeDataSetCommandOutput) => void): void; + describeDataSet( args: DescribeDataSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataSetCommandOutput) => void ): void; - public describeDataSet( - args: DescribeDataSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDataSetCommandOutput) => void), - cb?: (err: any, data?: DescribeDataSetCommandOutput) => void - ): Promise | void { - const command = new DescribeDataSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the permissions on a dataset.

- *

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

- */ - public describeDataSetPermissions( + + /** + * @see {@link DescribeDataSetPermissionsCommand} + */ + describeDataSetPermissions( args: DescribeDataSetPermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDataSetPermissions( + describeDataSetPermissions( args: DescribeDataSetPermissionsCommandInput, cb: (err: any, data?: DescribeDataSetPermissionsCommandOutput) => void ): void; - public describeDataSetPermissions( + describeDataSetPermissions( args: DescribeDataSetPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataSetPermissionsCommandOutput) => void ): void; - public describeDataSetPermissions( - args: DescribeDataSetPermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDataSetPermissionsCommandOutput) => void), - cb?: (err: any, data?: DescribeDataSetPermissionsCommandOutput) => void - ): Promise | void { - const command = new DescribeDataSetPermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the refresh properties of a dataset.

- */ - public describeDataSetRefreshProperties( + + /** + * @see {@link DescribeDataSetRefreshPropertiesCommand} + */ + describeDataSetRefreshProperties( args: DescribeDataSetRefreshPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDataSetRefreshProperties( + describeDataSetRefreshProperties( args: DescribeDataSetRefreshPropertiesCommandInput, cb: (err: any, data?: DescribeDataSetRefreshPropertiesCommandOutput) => void ): void; - public describeDataSetRefreshProperties( + describeDataSetRefreshProperties( args: DescribeDataSetRefreshPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataSetRefreshPropertiesCommandOutput) => void ): void; - public describeDataSetRefreshProperties( - args: DescribeDataSetRefreshPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDataSetRefreshPropertiesCommandOutput) => void), - cb?: (err: any, data?: DescribeDataSetRefreshPropertiesCommandOutput) => void - ): Promise | void { - const command = new DescribeDataSetRefreshPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a data source.

- */ - public describeDataSource( + + /** + * @see {@link DescribeDataSourceCommand} + */ + describeDataSource( args: DescribeDataSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDataSource( + describeDataSource( args: DescribeDataSourceCommandInput, cb: (err: any, data?: DescribeDataSourceCommandOutput) => void ): void; - public describeDataSource( + describeDataSource( args: DescribeDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataSourceCommandOutput) => void ): void; - public describeDataSource( - args: DescribeDataSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDataSourceCommandOutput) => void), - cb?: (err: any, data?: DescribeDataSourceCommandOutput) => void - ): Promise | void { - const command = new DescribeDataSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the resource permissions for a data source.

- */ - public describeDataSourcePermissions( + + /** + * @see {@link DescribeDataSourcePermissionsCommand} + */ + describeDataSourcePermissions( args: DescribeDataSourcePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDataSourcePermissions( + describeDataSourcePermissions( args: DescribeDataSourcePermissionsCommandInput, cb: (err: any, data?: DescribeDataSourcePermissionsCommandOutput) => void ): void; - public describeDataSourcePermissions( + describeDataSourcePermissions( args: DescribeDataSourcePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataSourcePermissionsCommandOutput) => void ): void; - public describeDataSourcePermissions( - args: DescribeDataSourcePermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDataSourcePermissionsCommandOutput) => void), - cb?: (err: any, data?: DescribeDataSourcePermissionsCommandOutput) => void - ): Promise | void { - const command = new DescribeDataSourcePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a folder.

- */ - public describeFolder( + + /** + * @see {@link DescribeFolderCommand} + */ + describeFolder( args: DescribeFolderCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFolder( - args: DescribeFolderCommandInput, - cb: (err: any, data?: DescribeFolderCommandOutput) => void - ): void; - public describeFolder( + describeFolder(args: DescribeFolderCommandInput, cb: (err: any, data?: DescribeFolderCommandOutput) => void): void; + describeFolder( args: DescribeFolderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFolderCommandOutput) => void ): void; - public describeFolder( - args: DescribeFolderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFolderCommandOutput) => void), - cb?: (err: any, data?: DescribeFolderCommandOutput) => void - ): Promise | void { - const command = new DescribeFolderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes permissions for a folder.

- */ - public describeFolderPermissions( + + /** + * @see {@link DescribeFolderPermissionsCommand} + */ + describeFolderPermissions( args: DescribeFolderPermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFolderPermissions( + describeFolderPermissions( args: DescribeFolderPermissionsCommandInput, cb: (err: any, data?: DescribeFolderPermissionsCommandOutput) => void ): void; - public describeFolderPermissions( + describeFolderPermissions( args: DescribeFolderPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFolderPermissionsCommandOutput) => void ): void; - public describeFolderPermissions( - args: DescribeFolderPermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFolderPermissionsCommandOutput) => void), - cb?: (err: any, data?: DescribeFolderPermissionsCommandOutput) => void - ): Promise | void { - const command = new DescribeFolderPermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.

- */ - public describeFolderResolvedPermissions( + + /** + * @see {@link DescribeFolderResolvedPermissionsCommand} + */ + describeFolderResolvedPermissions( args: DescribeFolderResolvedPermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFolderResolvedPermissions( + describeFolderResolvedPermissions( args: DescribeFolderResolvedPermissionsCommandInput, cb: (err: any, data?: DescribeFolderResolvedPermissionsCommandOutput) => void ): void; - public describeFolderResolvedPermissions( + describeFolderResolvedPermissions( args: DescribeFolderResolvedPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFolderResolvedPermissionsCommandOutput) => void ): void; - public describeFolderResolvedPermissions( - args: DescribeFolderResolvedPermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFolderResolvedPermissionsCommandOutput) => void), - cb?: (err: any, data?: DescribeFolderResolvedPermissionsCommandOutput) => void - ): Promise | void { - const command = new DescribeFolderResolvedPermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).

- */ - public describeGroup( - args: DescribeGroupCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeGroup( - args: DescribeGroupCommandInput, - cb: (err: any, data?: DescribeGroupCommandOutput) => void - ): void; - public describeGroup( + + /** + * @see {@link DescribeGroupCommand} + */ + describeGroup(args: DescribeGroupCommandInput, options?: __HttpHandlerOptions): Promise; + describeGroup(args: DescribeGroupCommandInput, cb: (err: any, data?: DescribeGroupCommandOutput) => void): void; + describeGroup( args: DescribeGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGroupCommandOutput) => void ): void; - public describeGroup( - args: DescribeGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGroupCommandOutput) => void), - cb?: (err: any, data?: DescribeGroupCommandOutput) => void - ): Promise | void { - const command = new DescribeGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Use the DescribeGroupMembership operation to determine if a user is a - * member of the specified group. If the user exists and is a member of the specified - * group, an associated GroupMember object is returned.

- */ - public describeGroupMembership( + + /** + * @see {@link DescribeGroupMembershipCommand} + */ + describeGroupMembership( args: DescribeGroupMembershipCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGroupMembership( + describeGroupMembership( args: DescribeGroupMembershipCommandInput, cb: (err: any, data?: DescribeGroupMembershipCommandOutput) => void ): void; - public describeGroupMembership( + describeGroupMembership( args: DescribeGroupMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGroupMembershipCommandOutput) => void ): void; - public describeGroupMembership( - args: DescribeGroupMembershipCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGroupMembershipCommandOutput) => void), - cb?: (err: any, data?: DescribeGroupMembershipCommandOutput) => void - ): Promise | void { - const command = new DescribeGroupMembershipCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes an existing IAM policy assignment, as specified by the assignment name.

- */ - public describeIAMPolicyAssignment( + + /** + * @see {@link DescribeIAMPolicyAssignmentCommand} + */ + describeIAMPolicyAssignment( args: DescribeIAMPolicyAssignmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeIAMPolicyAssignment( + describeIAMPolicyAssignment( args: DescribeIAMPolicyAssignmentCommandInput, cb: (err: any, data?: DescribeIAMPolicyAssignmentCommandOutput) => void ): void; - public describeIAMPolicyAssignment( + describeIAMPolicyAssignment( args: DescribeIAMPolicyAssignmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIAMPolicyAssignmentCommandOutput) => void ): void; - public describeIAMPolicyAssignment( - args: DescribeIAMPolicyAssignmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeIAMPolicyAssignmentCommandOutput) => void), - cb?: (err: any, data?: DescribeIAMPolicyAssignmentCommandOutput) => void - ): Promise | void { - const command = new DescribeIAMPolicyAssignmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a SPICE ingestion.

- */ - public describeIngestion( + + /** + * @see {@link DescribeIngestionCommand} + */ + describeIngestion( args: DescribeIngestionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeIngestion( + describeIngestion( args: DescribeIngestionCommandInput, cb: (err: any, data?: DescribeIngestionCommandOutput) => void ): void; - public describeIngestion( + describeIngestion( args: DescribeIngestionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIngestionCommandOutput) => void ): void; - public describeIngestion( - args: DescribeIngestionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeIngestionCommandOutput) => void), - cb?: (err: any, data?: DescribeIngestionCommandOutput) => void - ): Promise | void { - const command = new DescribeIngestionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides a summary and status of IP rules.

- */ - public describeIpRestriction( + + /** + * @see {@link DescribeIpRestrictionCommand} + */ + describeIpRestriction( args: DescribeIpRestrictionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeIpRestriction( + describeIpRestriction( args: DescribeIpRestrictionCommandInput, cb: (err: any, data?: DescribeIpRestrictionCommandOutput) => void ): void; - public describeIpRestriction( + describeIpRestriction( args: DescribeIpRestrictionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIpRestrictionCommandOutput) => void ): void; - public describeIpRestriction( - args: DescribeIpRestrictionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeIpRestrictionCommandOutput) => void), - cb?: (err: any, data?: DescribeIpRestrictionCommandOutput) => void - ): Promise | void { - const command = new DescribeIpRestrictionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the current namespace.

- */ - public describeNamespace( + + /** + * @see {@link DescribeNamespaceCommand} + */ + describeNamespace( args: DescribeNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNamespace( + describeNamespace( args: DescribeNamespaceCommandInput, cb: (err: any, data?: DescribeNamespaceCommandOutput) => void ): void; - public describeNamespace( + describeNamespace( args: DescribeNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNamespaceCommandOutput) => void ): void; - public describeNamespace( - args: DescribeNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeNamespaceCommandOutput) => void), - cb?: (err: any, data?: DescribeNamespaceCommandOutput) => void - ): Promise | void { - const command = new DescribeNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides a summary of a refresh schedule.

- */ - public describeRefreshSchedule( + + /** + * @see {@link DescribeRefreshScheduleCommand} + */ + describeRefreshSchedule( args: DescribeRefreshScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRefreshSchedule( + describeRefreshSchedule( args: DescribeRefreshScheduleCommandInput, cb: (err: any, data?: DescribeRefreshScheduleCommandOutput) => void ): void; - public describeRefreshSchedule( + describeRefreshSchedule( args: DescribeRefreshScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRefreshScheduleCommandOutput) => void ): void; - public describeRefreshSchedule( - args: DescribeRefreshScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRefreshScheduleCommandOutput) => void), - cb?: (err: any, data?: DescribeRefreshScheduleCommandOutput) => void - ): Promise | void { - const command = new DescribeRefreshScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a template's metadata.

- */ - public describeTemplate( + + /** + * @see {@link DescribeTemplateCommand} + */ + describeTemplate( args: DescribeTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTemplate( + describeTemplate( args: DescribeTemplateCommandInput, cb: (err: any, data?: DescribeTemplateCommandOutput) => void ): void; - public describeTemplate( + describeTemplate( args: DescribeTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTemplateCommandOutput) => void ): void; - public describeTemplate( - args: DescribeTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTemplateCommandOutput) => void), - cb?: (err: any, data?: DescribeTemplateCommandOutput) => void - ): Promise | void { - const command = new DescribeTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the template alias for a template.

- */ - public describeTemplateAlias( + + /** + * @see {@link DescribeTemplateAliasCommand} + */ + describeTemplateAlias( args: DescribeTemplateAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTemplateAlias( + describeTemplateAlias( args: DescribeTemplateAliasCommandInput, cb: (err: any, data?: DescribeTemplateAliasCommandOutput) => void ): void; - public describeTemplateAlias( + describeTemplateAlias( args: DescribeTemplateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTemplateAliasCommandOutput) => void ): void; - public describeTemplateAlias( - args: DescribeTemplateAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTemplateAliasCommandOutput) => void), - cb?: (err: any, data?: DescribeTemplateAliasCommandOutput) => void - ): Promise | void { - const command = new DescribeTemplateAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides a detailed description of the definition of a template.

- * - *

If you do not need to know details about the content of a template, for instance if you - * are trying to check the status of a recently created or updated template, use the - * - * DescribeTemplate - * instead. - *

- *
- */ - public describeTemplateDefinition( + + /** + * @see {@link DescribeTemplateDefinitionCommand} + */ + describeTemplateDefinition( args: DescribeTemplateDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTemplateDefinition( + describeTemplateDefinition( args: DescribeTemplateDefinitionCommandInput, cb: (err: any, data?: DescribeTemplateDefinitionCommandOutput) => void ): void; - public describeTemplateDefinition( + describeTemplateDefinition( args: DescribeTemplateDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTemplateDefinitionCommandOutput) => void ): void; - public describeTemplateDefinition( - args: DescribeTemplateDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTemplateDefinitionCommandOutput) => void), - cb?: (err: any, data?: DescribeTemplateDefinitionCommandOutput) => void - ): Promise | void { - const command = new DescribeTemplateDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes read and write permissions on a template.

- */ - public describeTemplatePermissions( + + /** + * @see {@link DescribeTemplatePermissionsCommand} + */ + describeTemplatePermissions( args: DescribeTemplatePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTemplatePermissions( + describeTemplatePermissions( args: DescribeTemplatePermissionsCommandInput, cb: (err: any, data?: DescribeTemplatePermissionsCommandOutput) => void ): void; - public describeTemplatePermissions( + describeTemplatePermissions( args: DescribeTemplatePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTemplatePermissionsCommandOutput) => void ): void; - public describeTemplatePermissions( - args: DescribeTemplatePermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTemplatePermissionsCommandOutput) => void), - cb?: (err: any, data?: DescribeTemplatePermissionsCommandOutput) => void - ): Promise | void { - const command = new DescribeTemplatePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a theme.

- */ - public describeTheme( - args: DescribeThemeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeTheme( - args: DescribeThemeCommandInput, - cb: (err: any, data?: DescribeThemeCommandOutput) => void - ): void; - public describeTheme( + + /** + * @see {@link DescribeThemeCommand} + */ + describeTheme(args: DescribeThemeCommandInput, options?: __HttpHandlerOptions): Promise; + describeTheme(args: DescribeThemeCommandInput, cb: (err: any, data?: DescribeThemeCommandOutput) => void): void; + describeTheme( args: DescribeThemeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeThemeCommandOutput) => void ): void; - public describeTheme( - args: DescribeThemeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeThemeCommandOutput) => void), - cb?: (err: any, data?: DescribeThemeCommandOutput) => void - ): Promise | void { - const command = new DescribeThemeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the alias for a theme.

- */ - public describeThemeAlias( + + /** + * @see {@link DescribeThemeAliasCommand} + */ + describeThemeAlias( args: DescribeThemeAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeThemeAlias( + describeThemeAlias( args: DescribeThemeAliasCommandInput, cb: (err: any, data?: DescribeThemeAliasCommandOutput) => void ): void; - public describeThemeAlias( + describeThemeAlias( args: DescribeThemeAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeThemeAliasCommandOutput) => void ): void; - public describeThemeAlias( - args: DescribeThemeAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeThemeAliasCommandOutput) => void), - cb?: (err: any, data?: DescribeThemeAliasCommandOutput) => void - ): Promise | void { - const command = new DescribeThemeAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the read and write permissions for a theme.

- */ - public describeThemePermissions( + + /** + * @see {@link DescribeThemePermissionsCommand} + */ + describeThemePermissions( args: DescribeThemePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeThemePermissions( + describeThemePermissions( args: DescribeThemePermissionsCommandInput, cb: (err: any, data?: DescribeThemePermissionsCommandOutput) => void ): void; - public describeThemePermissions( + describeThemePermissions( args: DescribeThemePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeThemePermissionsCommandOutput) => void ): void; - public describeThemePermissions( - args: DescribeThemePermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeThemePermissionsCommandOutput) => void), - cb?: (err: any, data?: DescribeThemePermissionsCommandOutput) => void - ): Promise | void { - const command = new DescribeThemePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a user, given the user name.

- */ - public describeUser( - args: DescribeUserCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeUser(args: DescribeUserCommandInput, cb: (err: any, data?: DescribeUserCommandOutput) => void): void; - public describeUser( + + /** + * @see {@link DescribeUserCommand} + */ + describeUser(args: DescribeUserCommandInput, options?: __HttpHandlerOptions): Promise; + describeUser(args: DescribeUserCommandInput, cb: (err: any, data?: DescribeUserCommandOutput) => void): void; + describeUser( args: DescribeUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserCommandOutput) => void ): void; - public describeUser( - args: DescribeUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUserCommandOutput) => void), - cb?: (err: any, data?: DescribeUserCommandOutput) => void - ): Promise | void { - const command = new DescribeUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.

- *

The following rules apply to the generated URL:

- *
    - *
  • - *

    It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.

    - *
  • - *
  • - *

    The URL validity period should not be confused with the actual session lifetime that can be customized using the - * SessionLifetimeInMinutes - * parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.

    - *
  • - *
  • - *

    You are charged only when the URL is used or there is interaction with Amazon QuickSight.

    - *
  • - *
- *

For more information, see Embedded Analytics in the Amazon QuickSight User - * Guide.

- *

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

- */ - public generateEmbedUrlForAnonymousUser( + + /** + * @see {@link GenerateEmbedUrlForAnonymousUserCommand} + */ + generateEmbedUrlForAnonymousUser( args: GenerateEmbedUrlForAnonymousUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public generateEmbedUrlForAnonymousUser( + generateEmbedUrlForAnonymousUser( args: GenerateEmbedUrlForAnonymousUserCommandInput, cb: (err: any, data?: GenerateEmbedUrlForAnonymousUserCommandOutput) => void ): void; - public generateEmbedUrlForAnonymousUser( + generateEmbedUrlForAnonymousUser( args: GenerateEmbedUrlForAnonymousUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateEmbedUrlForAnonymousUserCommandOutput) => void ): void; - public generateEmbedUrlForAnonymousUser( - args: GenerateEmbedUrlForAnonymousUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GenerateEmbedUrlForAnonymousUserCommandOutput) => void), - cb?: (err: any, data?: GenerateEmbedUrlForAnonymousUserCommandOutput) => void - ): Promise | void { - const command = new GenerateEmbedUrlForAnonymousUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. - * Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.

- *

The following rules apply to the generated URL:

- *
    - *
  • - *

    It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.

    - *
  • - *
  • - *

    The URL validity period should not be confused with the actual session lifetime - * that can be customized using the - * SessionLifetimeInMinutes - * parameter.

    - *

    The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.

    - *
  • - *
  • - *

    You are charged only when the URL is used or there is interaction with Amazon QuickSight.

    - *
  • - *
- *

For more information, see Embedded Analytics in the Amazon QuickSight User - * Guide.

- *

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

- */ - public generateEmbedUrlForRegisteredUser( + + /** + * @see {@link GenerateEmbedUrlForRegisteredUserCommand} + */ + generateEmbedUrlForRegisteredUser( args: GenerateEmbedUrlForRegisteredUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public generateEmbedUrlForRegisteredUser( + generateEmbedUrlForRegisteredUser( args: GenerateEmbedUrlForRegisteredUserCommandInput, cb: (err: any, data?: GenerateEmbedUrlForRegisteredUserCommandOutput) => void ): void; - public generateEmbedUrlForRegisteredUser( + generateEmbedUrlForRegisteredUser( args: GenerateEmbedUrlForRegisteredUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateEmbedUrlForRegisteredUserCommandOutput) => void ): void; - public generateEmbedUrlForRegisteredUser( - args: GenerateEmbedUrlForRegisteredUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GenerateEmbedUrlForRegisteredUserCommandOutput) => void), - cb?: (err: any, data?: GenerateEmbedUrlForRegisteredUserCommandOutput) => void - ): Promise | void { - const command = new GenerateEmbedUrlForRegisteredUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions.

- *

Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the generated URL:

- *
    - *
  • - *

    They must be used together.

    - *
  • - *
  • - *

    They can be used one time only.

    - *
  • - *
  • - *

    They are valid for 5 minutes after you run this command.

    - *
  • - *
  • - *

    You are charged only when the URL is used or there is interaction with Amazon QuickSight.

    - *
  • - *
  • - *

    The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional SessionLifetimeInMinutes parameter to customize session duration.

    - *
  • - *
- *

For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User - * Guide.

- *

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

- */ - public getDashboardEmbedUrl( + + /** + * @see {@link GetDashboardEmbedUrlCommand} + */ + getDashboardEmbedUrl( args: GetDashboardEmbedUrlCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDashboardEmbedUrl( + getDashboardEmbedUrl( args: GetDashboardEmbedUrlCommandInput, cb: (err: any, data?: GetDashboardEmbedUrlCommandOutput) => void ): void; - public getDashboardEmbedUrl( + getDashboardEmbedUrl( args: GetDashboardEmbedUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDashboardEmbedUrlCommandOutput) => void ): void; - public getDashboardEmbedUrl( - args: GetDashboardEmbedUrlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDashboardEmbedUrlCommandOutput) => void), - cb?: (err: any, data?: GetDashboardEmbedUrlCommandOutput) => void - ): Promise | void { - const command = new GetDashboardEmbedUrlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Generates a session URL and authorization code that you can use to embed the Amazon - * Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where - * you want to provide an authoring portal that allows users to create data sources, - * datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console - * need belong to the author or admin security cohort. If you want to restrict permissions - * to some of these features, add a custom permissions profile to the user with the - * - * UpdateUser - * API operation. Use - * RegisterUser - * - * API operation to add a new user with a custom permission profile attached. For more - * information, see the following sections in the Amazon QuickSight User - * Guide:

- * - */ - public getSessionEmbedUrl( + + /** + * @see {@link GetSessionEmbedUrlCommand} + */ + getSessionEmbedUrl( args: GetSessionEmbedUrlCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSessionEmbedUrl( + getSessionEmbedUrl( args: GetSessionEmbedUrlCommandInput, cb: (err: any, data?: GetSessionEmbedUrlCommandOutput) => void ): void; - public getSessionEmbedUrl( + getSessionEmbedUrl( args: GetSessionEmbedUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSessionEmbedUrlCommandOutput) => void ): void; - public getSessionEmbedUrl( - args: GetSessionEmbedUrlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSessionEmbedUrlCommandOutput) => void), - cb?: (err: any, data?: GetSessionEmbedUrlCommandOutput) => void - ): Promise | void { - const command = new GetSessionEmbedUrlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.

- */ - public listAnalyses( - args: ListAnalysesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listAnalyses(args: ListAnalysesCommandInput, cb: (err: any, data?: ListAnalysesCommandOutput) => void): void; - public listAnalyses( + + /** + * @see {@link ListAnalysesCommand} + */ + listAnalyses(args: ListAnalysesCommandInput, options?: __HttpHandlerOptions): Promise; + listAnalyses(args: ListAnalysesCommandInput, cb: (err: any, data?: ListAnalysesCommandOutput) => void): void; + listAnalyses( args: ListAnalysesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAnalysesCommandOutput) => void ): void; - public listAnalyses( - args: ListAnalysesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAnalysesCommandOutput) => void), - cb?: (err: any, data?: ListAnalysesCommandOutput) => void - ): Promise | void { - const command = new ListAnalysesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists dashboards in an Amazon Web Services account.

- */ - public listDashboards( + + /** + * @see {@link ListDashboardsCommand} + */ + listDashboards( args: ListDashboardsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDashboards( - args: ListDashboardsCommandInput, - cb: (err: any, data?: ListDashboardsCommandOutput) => void - ): void; - public listDashboards( + listDashboards(args: ListDashboardsCommandInput, cb: (err: any, data?: ListDashboardsCommandOutput) => void): void; + listDashboards( args: ListDashboardsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDashboardsCommandOutput) => void ): void; - public listDashboards( - args: ListDashboardsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDashboardsCommandOutput) => void), - cb?: (err: any, data?: ListDashboardsCommandOutput) => void - ): Promise | void { - const command = new ListDashboardsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all the versions of the dashboards in the Amazon QuickSight subscription.

- */ - public listDashboardVersions( + + /** + * @see {@link ListDashboardVersionsCommand} + */ + listDashboardVersions( args: ListDashboardVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDashboardVersions( + listDashboardVersions( args: ListDashboardVersionsCommandInput, cb: (err: any, data?: ListDashboardVersionsCommandOutput) => void ): void; - public listDashboardVersions( + listDashboardVersions( args: ListDashboardVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDashboardVersionsCommandOutput) => void ): void; - public listDashboardVersions( - args: ListDashboardVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDashboardVersionsCommandOutput) => void), - cb?: (err: any, data?: ListDashboardVersionsCommandOutput) => void - ): Promise | void { - const command = new ListDashboardVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.

- *

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.

- */ - public listDataSets( - args: ListDataSetsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listDataSets(args: ListDataSetsCommandInput, cb: (err: any, data?: ListDataSetsCommandOutput) => void): void; - public listDataSets( + + /** + * @see {@link ListDataSetsCommand} + */ + listDataSets(args: ListDataSetsCommandInput, options?: __HttpHandlerOptions): Promise; + listDataSets(args: ListDataSetsCommandInput, cb: (err: any, data?: ListDataSetsCommandOutput) => void): void; + listDataSets( args: ListDataSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataSetsCommandOutput) => void ): void; - public listDataSets( - args: ListDataSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDataSetsCommandOutput) => void), - cb?: (err: any, data?: ListDataSetsCommandOutput) => void - ): Promise | void { - const command = new ListDataSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.

- */ - public listDataSources( + + /** + * @see {@link ListDataSourcesCommand} + */ + listDataSources( args: ListDataSourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDataSources( - args: ListDataSourcesCommandInput, - cb: (err: any, data?: ListDataSourcesCommandOutput) => void - ): void; - public listDataSources( + listDataSources(args: ListDataSourcesCommandInput, cb: (err: any, data?: ListDataSourcesCommandOutput) => void): void; + listDataSources( args: ListDataSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataSourcesCommandOutput) => void ): void; - public listDataSources( - args: ListDataSourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDataSourcesCommandOutput) => void), - cb?: (err: any, data?: ListDataSourcesCommandOutput) => void - ): Promise | void { - const command = new ListDataSourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.

- */ - public listFolderMembers( + + /** + * @see {@link ListFolderMembersCommand} + */ + listFolderMembers( args: ListFolderMembersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFolderMembers( + listFolderMembers( args: ListFolderMembersCommandInput, cb: (err: any, data?: ListFolderMembersCommandOutput) => void ): void; - public listFolderMembers( + listFolderMembers( args: ListFolderMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFolderMembersCommandOutput) => void ): void; - public listFolderMembers( - args: ListFolderMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFolderMembersCommandOutput) => void), - cb?: (err: any, data?: ListFolderMembersCommandOutput) => void - ): Promise | void { - const command = new ListFolderMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all folders in an account.

- */ - public listFolders(args: ListFoldersCommandInput, options?: __HttpHandlerOptions): Promise; - public listFolders(args: ListFoldersCommandInput, cb: (err: any, data?: ListFoldersCommandOutput) => void): void; - public listFolders( + + /** + * @see {@link ListFoldersCommand} + */ + listFolders(args: ListFoldersCommandInput, options?: __HttpHandlerOptions): Promise; + listFolders(args: ListFoldersCommandInput, cb: (err: any, data?: ListFoldersCommandOutput) => void): void; + listFolders( args: ListFoldersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFoldersCommandOutput) => void ): void; - public listFolders( - args: ListFoldersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFoldersCommandOutput) => void), - cb?: (err: any, data?: ListFoldersCommandOutput) => void - ): Promise | void { - const command = new ListFoldersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists member users in a group.

- */ - public listGroupMemberships( + + /** + * @see {@link ListGroupMembershipsCommand} + */ + listGroupMemberships( args: ListGroupMembershipsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGroupMemberships( + listGroupMemberships( args: ListGroupMembershipsCommandInput, cb: (err: any, data?: ListGroupMembershipsCommandOutput) => void ): void; - public listGroupMemberships( + listGroupMemberships( args: ListGroupMembershipsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupMembershipsCommandOutput) => void ): void; - public listGroupMemberships( - args: ListGroupMembershipsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGroupMembershipsCommandOutput) => void), - cb?: (err: any, data?: ListGroupMembershipsCommandOutput) => void - ): Promise | void { - const command = new ListGroupMembershipsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all user groups in Amazon QuickSight.

- */ - public listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise; - public listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void; - public listGroups( + + /** + * @see {@link ListGroupsCommand} + */ + listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise; + listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void; + listGroups( args: ListGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsCommandOutput) => void ): void; - public listGroups( - args: ListGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGroupsCommandOutput) => void), - cb?: (err: any, data?: ListGroupsCommandOutput) => void - ): Promise | void { - const command = new ListGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists IAM policy assignments in the current Amazon QuickSight account.

- */ - public listIAMPolicyAssignments( + + /** + * @see {@link ListIAMPolicyAssignmentsCommand} + */ + listIAMPolicyAssignments( args: ListIAMPolicyAssignmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listIAMPolicyAssignments( + listIAMPolicyAssignments( args: ListIAMPolicyAssignmentsCommandInput, cb: (err: any, data?: ListIAMPolicyAssignmentsCommandOutput) => void ): void; - public listIAMPolicyAssignments( + listIAMPolicyAssignments( args: ListIAMPolicyAssignmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIAMPolicyAssignmentsCommandOutput) => void ): void; - public listIAMPolicyAssignments( - args: ListIAMPolicyAssignmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIAMPolicyAssignmentsCommandOutput) => void), - cb?: (err: any, data?: ListIAMPolicyAssignmentsCommandOutput) => void - ): Promise | void { - const command = new ListIAMPolicyAssignmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM - * policies assigned to the specified user and group or groups that the user belongs - * to.

- */ - public listIAMPolicyAssignmentsForUser( + + /** + * @see {@link ListIAMPolicyAssignmentsForUserCommand} + */ + listIAMPolicyAssignmentsForUser( args: ListIAMPolicyAssignmentsForUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public listIAMPolicyAssignmentsForUser( + listIAMPolicyAssignmentsForUser( args: ListIAMPolicyAssignmentsForUserCommandInput, cb: (err: any, data?: ListIAMPolicyAssignmentsForUserCommandOutput) => void ): void; - public listIAMPolicyAssignmentsForUser( + listIAMPolicyAssignmentsForUser( args: ListIAMPolicyAssignmentsForUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIAMPolicyAssignmentsForUserCommandOutput) => void ): void; - public listIAMPolicyAssignmentsForUser( - args: ListIAMPolicyAssignmentsForUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIAMPolicyAssignmentsForUserCommandOutput) => void), - cb?: (err: any, data?: ListIAMPolicyAssignmentsForUserCommandOutput) => void - ): Promise | void { - const command = new ListIAMPolicyAssignmentsForUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the history of SPICE ingestions for a dataset.

- */ - public listIngestions( + + /** + * @see {@link ListIngestionsCommand} + */ + listIngestions( args: ListIngestionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listIngestions( - args: ListIngestionsCommandInput, - cb: (err: any, data?: ListIngestionsCommandOutput) => void - ): void; - public listIngestions( + listIngestions(args: ListIngestionsCommandInput, cb: (err: any, data?: ListIngestionsCommandOutput) => void): void; + listIngestions( args: ListIngestionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIngestionsCommandOutput) => void ): void; - public listIngestions( - args: ListIngestionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIngestionsCommandOutput) => void), - cb?: (err: any, data?: ListIngestionsCommandOutput) => void - ): Promise | void { - const command = new ListIngestionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.

- */ - public listNamespaces( + + /** + * @see {@link ListNamespacesCommand} + */ + listNamespaces( args: ListNamespacesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listNamespaces( - args: ListNamespacesCommandInput, - cb: (err: any, data?: ListNamespacesCommandOutput) => void - ): void; - public listNamespaces( + listNamespaces(args: ListNamespacesCommandInput, cb: (err: any, data?: ListNamespacesCommandOutput) => void): void; + listNamespaces( args: ListNamespacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNamespacesCommandOutput) => void ): void; - public listNamespaces( - args: ListNamespacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNamespacesCommandOutput) => void), - cb?: (err: any, data?: ListNamespacesCommandOutput) => void - ): Promise | void { - const command = new ListNamespacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.

- */ - public listRefreshSchedules( + + /** + * @see {@link ListRefreshSchedulesCommand} + */ + listRefreshSchedules( args: ListRefreshSchedulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRefreshSchedules( + listRefreshSchedules( args: ListRefreshSchedulesCommandInput, cb: (err: any, data?: ListRefreshSchedulesCommandOutput) => void ): void; - public listRefreshSchedules( + listRefreshSchedules( args: ListRefreshSchedulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRefreshSchedulesCommandOutput) => void ): void; - public listRefreshSchedules( - args: ListRefreshSchedulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRefreshSchedulesCommandOutput) => void), - cb?: (err: any, data?: ListRefreshSchedulesCommandOutput) => void - ): Promise | void { - const command = new ListRefreshSchedulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the tags assigned to a resource.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all the aliases of a template.

- */ - public listTemplateAliases( + + /** + * @see {@link ListTemplateAliasesCommand} + */ + listTemplateAliases( args: ListTemplateAliasesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTemplateAliases( + listTemplateAliases( args: ListTemplateAliasesCommandInput, cb: (err: any, data?: ListTemplateAliasesCommandOutput) => void ): void; - public listTemplateAliases( + listTemplateAliases( args: ListTemplateAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTemplateAliasesCommandOutput) => void ): void; - public listTemplateAliases( - args: ListTemplateAliasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTemplateAliasesCommandOutput) => void), - cb?: (err: any, data?: ListTemplateAliasesCommandOutput) => void - ): Promise | void { - const command = new ListTemplateAliasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all the templates in the current Amazon QuickSight account.

- */ - public listTemplates( - args: ListTemplatesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listTemplates( - args: ListTemplatesCommandInput, - cb: (err: any, data?: ListTemplatesCommandOutput) => void - ): void; - public listTemplates( + + /** + * @see {@link ListTemplatesCommand} + */ + listTemplates(args: ListTemplatesCommandInput, options?: __HttpHandlerOptions): Promise; + listTemplates(args: ListTemplatesCommandInput, cb: (err: any, data?: ListTemplatesCommandOutput) => void): void; + listTemplates( args: ListTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTemplatesCommandOutput) => void ): void; - public listTemplates( - args: ListTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all the versions of the templates in the current Amazon QuickSight account.

- */ - public listTemplateVersions( + + /** + * @see {@link ListTemplateVersionsCommand} + */ + listTemplateVersions( args: ListTemplateVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTemplateVersions( + listTemplateVersions( args: ListTemplateVersionsCommandInput, cb: (err: any, data?: ListTemplateVersionsCommandOutput) => void ): void; - public listTemplateVersions( + listTemplateVersions( args: ListTemplateVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTemplateVersionsCommandOutput) => void ): void; - public listTemplateVersions( - args: ListTemplateVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTemplateVersionsCommandOutput) => void), - cb?: (err: any, data?: ListTemplateVersionsCommandOutput) => void - ): Promise | void { - const command = new ListTemplateVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all the aliases of a theme.

- */ - public listThemeAliases( + + /** + * @see {@link ListThemeAliasesCommand} + */ + listThemeAliases( args: ListThemeAliasesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listThemeAliases( + listThemeAliases( args: ListThemeAliasesCommandInput, cb: (err: any, data?: ListThemeAliasesCommandOutput) => void ): void; - public listThemeAliases( + listThemeAliases( args: ListThemeAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListThemeAliasesCommandOutput) => void ): void; - public listThemeAliases( - args: ListThemeAliasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListThemeAliasesCommandOutput) => void), - cb?: (err: any, data?: ListThemeAliasesCommandOutput) => void - ): Promise | void { - const command = new ListThemeAliasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all the themes in the current Amazon Web Services account.

- */ - public listThemes(args: ListThemesCommandInput, options?: __HttpHandlerOptions): Promise; - public listThemes(args: ListThemesCommandInput, cb: (err: any, data?: ListThemesCommandOutput) => void): void; - public listThemes( + + /** + * @see {@link ListThemesCommand} + */ + listThemes(args: ListThemesCommandInput, options?: __HttpHandlerOptions): Promise; + listThemes(args: ListThemesCommandInput, cb: (err: any, data?: ListThemesCommandOutput) => void): void; + listThemes( args: ListThemesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListThemesCommandOutput) => void ): void; - public listThemes( - args: ListThemesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListThemesCommandOutput) => void), - cb?: (err: any, data?: ListThemesCommandOutput) => void - ): Promise | void { - const command = new ListThemesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all the versions of the themes in the current Amazon Web Services account.

- */ - public listThemeVersions( + + /** + * @see {@link ListThemeVersionsCommand} + */ + listThemeVersions( args: ListThemeVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listThemeVersions( + listThemeVersions( args: ListThemeVersionsCommandInput, cb: (err: any, data?: ListThemeVersionsCommandOutput) => void ): void; - public listThemeVersions( + listThemeVersions( args: ListThemeVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListThemeVersionsCommandOutput) => void ): void; - public listThemeVersions( - args: ListThemeVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListThemeVersionsCommandOutput) => void), - cb?: (err: any, data?: ListThemeVersionsCommandOutput) => void - ): Promise | void { - const command = new ListThemeVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

- */ - public listUserGroups( + + /** + * @see {@link ListUserGroupsCommand} + */ + listUserGroups( args: ListUserGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listUserGroups( - args: ListUserGroupsCommandInput, - cb: (err: any, data?: ListUserGroupsCommandOutput) => void - ): void; - public listUserGroups( + listUserGroups(args: ListUserGroupsCommandInput, cb: (err: any, data?: ListUserGroupsCommandOutput) => void): void; + listUserGroups( args: ListUserGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUserGroupsCommandOutput) => void ): void; - public listUserGroups( - args: ListUserGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUserGroupsCommandOutput) => void), - cb?: (err: any, data?: ListUserGroupsCommandOutput) => void - ): Promise | void { - const command = new ListUserGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of all of the Amazon QuickSight users belonging to this account.

- */ - public listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise; - public listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void; - public listUsers( + + /** + * @see {@link ListUsersCommand} + */ + listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise; + listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void; + listUsers( args: ListUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersCommandOutput) => void ): void; - public listUsers( - args: ListUsersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUsersCommandOutput) => void), - cb?: (err: any, data?: ListUsersCommandOutput) => void - ): Promise | void { - const command = new ListUsersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or updates the dataset refresh properties for the dataset.

- */ - public putDataSetRefreshProperties( + + /** + * @see {@link PutDataSetRefreshPropertiesCommand} + */ + putDataSetRefreshProperties( args: PutDataSetRefreshPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putDataSetRefreshProperties( + putDataSetRefreshProperties( args: PutDataSetRefreshPropertiesCommandInput, cb: (err: any, data?: PutDataSetRefreshPropertiesCommandOutput) => void ): void; - public putDataSetRefreshProperties( + putDataSetRefreshProperties( args: PutDataSetRefreshPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDataSetRefreshPropertiesCommandOutput) => void ): void; - public putDataSetRefreshProperties( - args: PutDataSetRefreshPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutDataSetRefreshPropertiesCommandOutput) => void), - cb?: (err: any, data?: PutDataSetRefreshPropertiesCommandOutput) => void - ): Promise | void { - const command = new PutDataSetRefreshPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.

- */ - public registerUser( - args: RegisterUserCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public registerUser(args: RegisterUserCommandInput, cb: (err: any, data?: RegisterUserCommandOutput) => void): void; - public registerUser( + + /** + * @see {@link RegisterUserCommand} + */ + registerUser(args: RegisterUserCommandInput, options?: __HttpHandlerOptions): Promise; + registerUser(args: RegisterUserCommandInput, cb: (err: any, data?: RegisterUserCommandOutput) => void): void; + registerUser( args: RegisterUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterUserCommandOutput) => void ): void; - public registerUser( - args: RegisterUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterUserCommandOutput) => void), - cb?: (err: any, data?: RegisterUserCommandOutput) => void - ): Promise | void { - const command = new RegisterUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Restores an analysis.

- */ - public restoreAnalysis( + + /** + * @see {@link RestoreAnalysisCommand} + */ + restoreAnalysis( args: RestoreAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreAnalysis( - args: RestoreAnalysisCommandInput, - cb: (err: any, data?: RestoreAnalysisCommandOutput) => void - ): void; - public restoreAnalysis( + restoreAnalysis(args: RestoreAnalysisCommandInput, cb: (err: any, data?: RestoreAnalysisCommandOutput) => void): void; + restoreAnalysis( args: RestoreAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreAnalysisCommandOutput) => void ): void; - public restoreAnalysis( - args: RestoreAnalysisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreAnalysisCommandOutput) => void), - cb?: (err: any, data?: RestoreAnalysisCommandOutput) => void - ): Promise | void { - const command = new RestoreAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Searches for analyses that belong to the user specified in the filter.

- * - *

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

- *
- */ - public searchAnalyses( + + /** + * @see {@link SearchAnalysesCommand} + */ + searchAnalyses( args: SearchAnalysesCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchAnalyses( - args: SearchAnalysesCommandInput, - cb: (err: any, data?: SearchAnalysesCommandOutput) => void - ): void; - public searchAnalyses( + searchAnalyses(args: SearchAnalysesCommandInput, cb: (err: any, data?: SearchAnalysesCommandOutput) => void): void; + searchAnalyses( args: SearchAnalysesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchAnalysesCommandOutput) => void ): void; - public searchAnalyses( - args: SearchAnalysesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchAnalysesCommandOutput) => void), - cb?: (err: any, data?: SearchAnalysesCommandOutput) => void - ): Promise | void { - const command = new SearchAnalysesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Searches for dashboards that belong to a user.

- * - *

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

- *
- */ - public searchDashboards( + + /** + * @see {@link SearchDashboardsCommand} + */ + searchDashboards( args: SearchDashboardsCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchDashboards( + searchDashboards( args: SearchDashboardsCommandInput, cb: (err: any, data?: SearchDashboardsCommandOutput) => void ): void; - public searchDashboards( + searchDashboards( args: SearchDashboardsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchDashboardsCommandOutput) => void ): void; - public searchDashboards( - args: SearchDashboardsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchDashboardsCommandOutput) => void), - cb?: (err: any, data?: SearchDashboardsCommandOutput) => void - ): Promise | void { - const command = new SearchDashboardsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Use the SearchDataSets operation to search for datasets that belong to an account.

- */ - public searchDataSets( + + /** + * @see {@link SearchDataSetsCommand} + */ + searchDataSets( args: SearchDataSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchDataSets( - args: SearchDataSetsCommandInput, - cb: (err: any, data?: SearchDataSetsCommandOutput) => void - ): void; - public searchDataSets( + searchDataSets(args: SearchDataSetsCommandInput, cb: (err: any, data?: SearchDataSetsCommandOutput) => void): void; + searchDataSets( args: SearchDataSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchDataSetsCommandOutput) => void ): void; - public searchDataSets( - args: SearchDataSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchDataSetsCommandOutput) => void), - cb?: (err: any, data?: SearchDataSetsCommandOutput) => void - ): Promise | void { - const command = new SearchDataSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Use the SearchDataSources operation to search for data sources that belong to an account.

- */ - public searchDataSources( + + /** + * @see {@link SearchDataSourcesCommand} + */ + searchDataSources( args: SearchDataSourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchDataSources( + searchDataSources( args: SearchDataSourcesCommandInput, cb: (err: any, data?: SearchDataSourcesCommandOutput) => void ): void; - public searchDataSources( + searchDataSources( args: SearchDataSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchDataSourcesCommandOutput) => void ): void; - public searchDataSources( - args: SearchDataSourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchDataSourcesCommandOutput) => void), - cb?: (err: any, data?: SearchDataSourcesCommandOutput) => void - ): Promise | void { - const command = new SearchDataSourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Searches the subfolders in a folder.

- */ - public searchFolders( - args: SearchFoldersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public searchFolders( - args: SearchFoldersCommandInput, - cb: (err: any, data?: SearchFoldersCommandOutput) => void - ): void; - public searchFolders( + + /** + * @see {@link SearchFoldersCommand} + */ + searchFolders(args: SearchFoldersCommandInput, options?: __HttpHandlerOptions): Promise; + searchFolders(args: SearchFoldersCommandInput, cb: (err: any, data?: SearchFoldersCommandOutput) => void): void; + searchFolders( args: SearchFoldersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchFoldersCommandOutput) => void ): void; - public searchFolders( - args: SearchFoldersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchFoldersCommandOutput) => void), - cb?: (err: any, data?: SearchFoldersCommandOutput) => void - ): Promise | void { - const command = new SearchFoldersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.

- */ - public searchGroups( - args: SearchGroupsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public searchGroups(args: SearchGroupsCommandInput, cb: (err: any, data?: SearchGroupsCommandOutput) => void): void; - public searchGroups( + + /** + * @see {@link SearchGroupsCommand} + */ + searchGroups(args: SearchGroupsCommandInput, options?: __HttpHandlerOptions): Promise; + searchGroups(args: SearchGroupsCommandInput, cb: (err: any, data?: SearchGroupsCommandOutput) => void): void; + searchGroups( args: SearchGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchGroupsCommandOutput) => void ): void; - public searchGroups( - args: SearchGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchGroupsCommandOutput) => void), - cb?: (err: any, data?: SearchGroupsCommandOutput) => void - ): Promise | void { - const command = new SearchGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.

- *

Tags can help you organize and categorize your resources. You can also use them to - * scope user permissions, by granting a user permission to access or change only resources - * with certain tag values. You can use the TagResource operation with a - * resource that already has tags. If you specify a new tag key for the resource, this tag - * is appended to the list of tags associated with the resource. If you specify a tag key - * that is already associated with the resource, the new tag value that you specify - * replaces the previous value for that tag.

- *

You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data - * set, data source, dashboard, and template.

- *

Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for - * the following:

- *
    - *
  • - *

    You can't use tags to track costs for Amazon QuickSight. This isn't - * possible because you can't tag the resources that Amazon QuickSight costs are based - * on, for example Amazon QuickSight storage capacity (SPICE), number of users, type - * of users, and usage metrics.

    - *
  • - *
  • - *

    Amazon QuickSight doesn't currently support the tag editor for Resource Groups.

    - *
  • - *
- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a tag or tags from a resource.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.

- *

You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a - * Amazon QuickSight namespace instead. Customizations that apply to a namespace override - * customizations that apply to an Amazon Web Services account. To find out which customizations apply, use - * the DescribeAccountCustomization API operation.

- */ - public updateAccountCustomization( + + /** + * @see {@link UpdateAccountCustomizationCommand} + */ + updateAccountCustomization( args: UpdateAccountCustomizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAccountCustomization( + updateAccountCustomization( args: UpdateAccountCustomizationCommandInput, cb: (err: any, data?: UpdateAccountCustomizationCommandOutput) => void ): void; - public updateAccountCustomization( + updateAccountCustomization( args: UpdateAccountCustomizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccountCustomizationCommandOutput) => void ): void; - public updateAccountCustomization( - args: UpdateAccountCustomizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAccountCustomizationCommandOutput) => void), - cb?: (err: any, data?: UpdateAccountCustomizationCommandOutput) => void - ): Promise | void { - const command = new UpdateAccountCustomizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the Amazon QuickSight settings in your Amazon Web Services account.

- */ - public updateAccountSettings( + + /** + * @see {@link UpdateAccountSettingsCommand} + */ + updateAccountSettings( args: UpdateAccountSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAccountSettings( + updateAccountSettings( args: UpdateAccountSettingsCommandInput, cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void ): void; - public updateAccountSettings( + updateAccountSettings( args: UpdateAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void ): void; - public updateAccountSettings( - args: UpdateAccountSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAccountSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateAccountSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateAccountSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an analysis in Amazon QuickSight

- */ - public updateAnalysis( + + /** + * @see {@link UpdateAnalysisCommand} + */ + updateAnalysis( args: UpdateAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAnalysis( - args: UpdateAnalysisCommandInput, - cb: (err: any, data?: UpdateAnalysisCommandOutput) => void - ): void; - public updateAnalysis( + updateAnalysis(args: UpdateAnalysisCommandInput, cb: (err: any, data?: UpdateAnalysisCommandOutput) => void): void; + updateAnalysis( args: UpdateAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAnalysisCommandOutput) => void ): void; - public updateAnalysis( - args: UpdateAnalysisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAnalysisCommandOutput) => void), - cb?: (err: any, data?: UpdateAnalysisCommandOutput) => void - ): Promise | void { - const command = new UpdateAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the read and write permissions for an analysis.

- */ - public updateAnalysisPermissions( + + /** + * @see {@link UpdateAnalysisPermissionsCommand} + */ + updateAnalysisPermissions( args: UpdateAnalysisPermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAnalysisPermissions( + updateAnalysisPermissions( args: UpdateAnalysisPermissionsCommandInput, cb: (err: any, data?: UpdateAnalysisPermissionsCommandOutput) => void ): void; - public updateAnalysisPermissions( + updateAnalysisPermissions( args: UpdateAnalysisPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAnalysisPermissionsCommandOutput) => void ): void; - public updateAnalysisPermissions( - args: UpdateAnalysisPermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAnalysisPermissionsCommandOutput) => void), - cb?: (err: any, data?: UpdateAnalysisPermissionsCommandOutput) => void - ): Promise | void { - const command = new UpdateAnalysisPermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a dashboard in an Amazon Web Services account.

- * - *

Updating a Dashboard creates a new dashboard version but does not immediately publish - * the new version. You can update the published version of a dashboard by - * using the - * UpdateDashboardPublishedVersion - * API operation.

- *
- */ - public updateDashboard( + + /** + * @see {@link UpdateDashboardCommand} + */ + updateDashboard( args: UpdateDashboardCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDashboard( - args: UpdateDashboardCommandInput, - cb: (err: any, data?: UpdateDashboardCommandOutput) => void - ): void; - public updateDashboard( + updateDashboard(args: UpdateDashboardCommandInput, cb: (err: any, data?: UpdateDashboardCommandOutput) => void): void; + updateDashboard( args: UpdateDashboardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDashboardCommandOutput) => void ): void; - public updateDashboard( - args: UpdateDashboardCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDashboardCommandOutput) => void), - cb?: (err: any, data?: UpdateDashboardCommandOutput) => void - ): Promise | void { - const command = new UpdateDashboardCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates read and write permissions on a dashboard.

- */ - public updateDashboardPermissions( + + /** + * @see {@link UpdateDashboardPermissionsCommand} + */ + updateDashboardPermissions( args: UpdateDashboardPermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDashboardPermissions( + updateDashboardPermissions( args: UpdateDashboardPermissionsCommandInput, cb: (err: any, data?: UpdateDashboardPermissionsCommandOutput) => void ): void; - public updateDashboardPermissions( + updateDashboardPermissions( args: UpdateDashboardPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDashboardPermissionsCommandOutput) => void ): void; - public updateDashboardPermissions( - args: UpdateDashboardPermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDashboardPermissionsCommandOutput) => void), - cb?: (err: any, data?: UpdateDashboardPermissionsCommandOutput) => void - ): Promise | void { - const command = new UpdateDashboardPermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the published version of a dashboard.

- */ - public updateDashboardPublishedVersion( + + /** + * @see {@link UpdateDashboardPublishedVersionCommand} + */ + updateDashboardPublishedVersion( args: UpdateDashboardPublishedVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDashboardPublishedVersion( + updateDashboardPublishedVersion( args: UpdateDashboardPublishedVersionCommandInput, cb: (err: any, data?: UpdateDashboardPublishedVersionCommandOutput) => void ): void; - public updateDashboardPublishedVersion( + updateDashboardPublishedVersion( args: UpdateDashboardPublishedVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDashboardPublishedVersionCommandOutput) => void ): void; - public updateDashboardPublishedVersion( - args: UpdateDashboardPublishedVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDashboardPublishedVersionCommandOutput) => void), - cb?: (err: any, data?: UpdateDashboardPublishedVersionCommandOutput) => void - ): Promise | void { - const command = new UpdateDashboardPublishedVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.

- */ - public updateDataSet( - args: UpdateDataSetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateDataSet( - args: UpdateDataSetCommandInput, - cb: (err: any, data?: UpdateDataSetCommandOutput) => void - ): void; - public updateDataSet( + + /** + * @see {@link UpdateDataSetCommand} + */ + updateDataSet(args: UpdateDataSetCommandInput, options?: __HttpHandlerOptions): Promise; + updateDataSet(args: UpdateDataSetCommandInput, cb: (err: any, data?: UpdateDataSetCommandOutput) => void): void; + updateDataSet( args: UpdateDataSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDataSetCommandOutput) => void ): void; - public updateDataSet( - args: UpdateDataSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDataSetCommandOutput) => void), - cb?: (err: any, data?: UpdateDataSetCommandOutput) => void - ): Promise | void { - const command = new UpdateDataSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the permissions on a dataset.

- *

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

- */ - public updateDataSetPermissions( + + /** + * @see {@link UpdateDataSetPermissionsCommand} + */ + updateDataSetPermissions( args: UpdateDataSetPermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDataSetPermissions( + updateDataSetPermissions( args: UpdateDataSetPermissionsCommandInput, cb: (err: any, data?: UpdateDataSetPermissionsCommandOutput) => void ): void; - public updateDataSetPermissions( + updateDataSetPermissions( args: UpdateDataSetPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDataSetPermissionsCommandOutput) => void ): void; - public updateDataSetPermissions( - args: UpdateDataSetPermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDataSetPermissionsCommandOutput) => void), - cb?: (err: any, data?: UpdateDataSetPermissionsCommandOutput) => void - ): Promise | void { - const command = new UpdateDataSetPermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a data source.

- */ - public updateDataSource( + + /** + * @see {@link UpdateDataSourceCommand} + */ + updateDataSource( args: UpdateDataSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDataSource( + updateDataSource( args: UpdateDataSourceCommandInput, cb: (err: any, data?: UpdateDataSourceCommandOutput) => void ): void; - public updateDataSource( + updateDataSource( args: UpdateDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDataSourceCommandOutput) => void ): void; - public updateDataSource( - args: UpdateDataSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDataSourceCommandOutput) => void), - cb?: (err: any, data?: UpdateDataSourceCommandOutput) => void - ): Promise | void { - const command = new UpdateDataSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the permissions to a data source.

- */ - public updateDataSourcePermissions( + + /** + * @see {@link UpdateDataSourcePermissionsCommand} + */ + updateDataSourcePermissions( args: UpdateDataSourcePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDataSourcePermissions( + updateDataSourcePermissions( args: UpdateDataSourcePermissionsCommandInput, cb: (err: any, data?: UpdateDataSourcePermissionsCommandOutput) => void ): void; - public updateDataSourcePermissions( + updateDataSourcePermissions( args: UpdateDataSourcePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDataSourcePermissionsCommandOutput) => void ): void; - public updateDataSourcePermissions( - args: UpdateDataSourcePermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDataSourcePermissionsCommandOutput) => void), - cb?: (err: any, data?: UpdateDataSourcePermissionsCommandOutput) => void - ): Promise | void { - const command = new UpdateDataSourcePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the name of a folder.

- */ - public updateFolder( - args: UpdateFolderCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateFolder(args: UpdateFolderCommandInput, cb: (err: any, data?: UpdateFolderCommandOutput) => void): void; - public updateFolder( + + /** + * @see {@link UpdateFolderCommand} + */ + updateFolder(args: UpdateFolderCommandInput, options?: __HttpHandlerOptions): Promise; + updateFolder(args: UpdateFolderCommandInput, cb: (err: any, data?: UpdateFolderCommandOutput) => void): void; + updateFolder( args: UpdateFolderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFolderCommandOutput) => void ): void; - public updateFolder( - args: UpdateFolderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFolderCommandOutput) => void), - cb?: (err: any, data?: UpdateFolderCommandOutput) => void - ): Promise | void { - const command = new UpdateFolderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates permissions of a folder.

- */ - public updateFolderPermissions( + + /** + * @see {@link UpdateFolderPermissionsCommand} + */ + updateFolderPermissions( args: UpdateFolderPermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFolderPermissions( + updateFolderPermissions( args: UpdateFolderPermissionsCommandInput, cb: (err: any, data?: UpdateFolderPermissionsCommandOutput) => void ): void; - public updateFolderPermissions( + updateFolderPermissions( args: UpdateFolderPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFolderPermissionsCommandOutput) => void ): void; - public updateFolderPermissions( - args: UpdateFolderPermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFolderPermissionsCommandOutput) => void), - cb?: (err: any, data?: UpdateFolderPermissionsCommandOutput) => void - ): Promise | void { - const command = new UpdateFolderPermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Changes a group description.

- */ - public updateGroup(args: UpdateGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void; - public updateGroup( + + /** + * @see {@link UpdateGroupCommand} + */ + updateGroup(args: UpdateGroupCommandInput, options?: __HttpHandlerOptions): Promise; + updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void; + updateGroup( args: UpdateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGroupCommandOutput) => void ): void; - public updateGroup( - args: UpdateGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing IAM policy assignment. This operation updates only the optional - * parameter or parameters that are specified in the request. - * This overwrites all of the users included in Identities. - *

- */ - public updateIAMPolicyAssignment( + + /** + * @see {@link UpdateIAMPolicyAssignmentCommand} + */ + updateIAMPolicyAssignment( args: UpdateIAMPolicyAssignmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateIAMPolicyAssignment( + updateIAMPolicyAssignment( args: UpdateIAMPolicyAssignmentCommandInput, cb: (err: any, data?: UpdateIAMPolicyAssignmentCommandOutput) => void ): void; - public updateIAMPolicyAssignment( + updateIAMPolicyAssignment( args: UpdateIAMPolicyAssignmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIAMPolicyAssignmentCommandOutput) => void ): void; - public updateIAMPolicyAssignment( - args: UpdateIAMPolicyAssignmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateIAMPolicyAssignmentCommandOutput) => void), - cb?: (err: any, data?: UpdateIAMPolicyAssignmentCommandOutput) => void - ): Promise | void { - const command = new UpdateIAMPolicyAssignmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the content and status of IP rules. To use this operation, you need to provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.

- */ - public updateIpRestriction( + + /** + * @see {@link UpdateIpRestrictionCommand} + */ + updateIpRestriction( args: UpdateIpRestrictionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateIpRestriction( + updateIpRestriction( args: UpdateIpRestrictionCommandInput, cb: (err: any, data?: UpdateIpRestrictionCommandOutput) => void ): void; - public updateIpRestriction( + updateIpRestriction( args: UpdateIpRestrictionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIpRestrictionCommandOutput) => void ): void; - public updateIpRestriction( - args: UpdateIpRestrictionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateIpRestrictionCommandOutput) => void), - cb?: (err: any, data?: UpdateIpRestrictionCommandOutput) => void - ): Promise | void { - const command = new UpdateIpRestrictionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Use the UpdatePublicSharingSettings operation to turn on or turn off the - * public sharing settings of an Amazon QuickSight dashboard.

- *

To use this operation, turn on session capacity pricing for your Amazon QuickSight - * account.

- *

Before you can turn on public sharing on your account, make sure to give public sharing - * permissions to an administrative user in the Identity and Access Management (IAM) - * console. For more information on using IAM with Amazon QuickSight, see - * Using Amazon QuickSight with IAM in the Amazon QuickSight - * User Guide.

- */ - public updatePublicSharingSettings( + + /** + * @see {@link UpdatePublicSharingSettingsCommand} + */ + updatePublicSharingSettings( args: UpdatePublicSharingSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePublicSharingSettings( + updatePublicSharingSettings( args: UpdatePublicSharingSettingsCommandInput, cb: (err: any, data?: UpdatePublicSharingSettingsCommandOutput) => void ): void; - public updatePublicSharingSettings( + updatePublicSharingSettings( args: UpdatePublicSharingSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePublicSharingSettingsCommandOutput) => void ): void; - public updatePublicSharingSettings( - args: UpdatePublicSharingSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePublicSharingSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdatePublicSharingSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdatePublicSharingSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a refresh schedule for a dataset.

- */ - public updateRefreshSchedule( + + /** + * @see {@link UpdateRefreshScheduleCommand} + */ + updateRefreshSchedule( args: UpdateRefreshScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRefreshSchedule( + updateRefreshSchedule( args: UpdateRefreshScheduleCommandInput, cb: (err: any, data?: UpdateRefreshScheduleCommandOutput) => void ): void; - public updateRefreshSchedule( + updateRefreshSchedule( args: UpdateRefreshScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRefreshScheduleCommandOutput) => void ): void; - public updateRefreshSchedule( - args: UpdateRefreshScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRefreshScheduleCommandOutput) => void), - cb?: (err: any, data?: UpdateRefreshScheduleCommandOutput) => void - ): Promise | void { - const command = new UpdateRefreshScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a template from an existing Amazon QuickSight analysis or another template.

- */ - public updateTemplate( + + /** + * @see {@link UpdateTemplateCommand} + */ + updateTemplate( args: UpdateTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTemplate( - args: UpdateTemplateCommandInput, - cb: (err: any, data?: UpdateTemplateCommandOutput) => void - ): void; - public updateTemplate( + updateTemplate(args: UpdateTemplateCommandInput, cb: (err: any, data?: UpdateTemplateCommandOutput) => void): void; + updateTemplate( args: UpdateTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTemplateCommandOutput) => void ): void; - public updateTemplate( - args: UpdateTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the template alias of a template.

- */ - public updateTemplateAlias( + + /** + * @see {@link UpdateTemplateAliasCommand} + */ + updateTemplateAlias( args: UpdateTemplateAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTemplateAlias( + updateTemplateAlias( args: UpdateTemplateAliasCommandInput, cb: (err: any, data?: UpdateTemplateAliasCommandOutput) => void ): void; - public updateTemplateAlias( + updateTemplateAlias( args: UpdateTemplateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTemplateAliasCommandOutput) => void ): void; - public updateTemplateAlias( - args: UpdateTemplateAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTemplateAliasCommandOutput) => void), - cb?: (err: any, data?: UpdateTemplateAliasCommandOutput) => void - ): Promise | void { - const command = new UpdateTemplateAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the resource permissions for a template.

- */ - public updateTemplatePermissions( + + /** + * @see {@link UpdateTemplatePermissionsCommand} + */ + updateTemplatePermissions( args: UpdateTemplatePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTemplatePermissions( + updateTemplatePermissions( args: UpdateTemplatePermissionsCommandInput, cb: (err: any, data?: UpdateTemplatePermissionsCommandOutput) => void ): void; - public updateTemplatePermissions( + updateTemplatePermissions( args: UpdateTemplatePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTemplatePermissionsCommandOutput) => void ): void; - public updateTemplatePermissions( - args: UpdateTemplatePermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTemplatePermissionsCommandOutput) => void), - cb?: (err: any, data?: UpdateTemplatePermissionsCommandOutput) => void - ): Promise | void { - const command = new UpdateTemplatePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a theme.

- */ - public updateTheme(args: UpdateThemeCommandInput, options?: __HttpHandlerOptions): Promise; - public updateTheme(args: UpdateThemeCommandInput, cb: (err: any, data?: UpdateThemeCommandOutput) => void): void; - public updateTheme( + + /** + * @see {@link UpdateThemeCommand} + */ + updateTheme(args: UpdateThemeCommandInput, options?: __HttpHandlerOptions): Promise; + updateTheme(args: UpdateThemeCommandInput, cb: (err: any, data?: UpdateThemeCommandOutput) => void): void; + updateTheme( args: UpdateThemeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateThemeCommandOutput) => void ): void; - public updateTheme( - args: UpdateThemeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateThemeCommandOutput) => void), - cb?: (err: any, data?: UpdateThemeCommandOutput) => void - ): Promise | void { - const command = new UpdateThemeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an alias of a theme.

- */ - public updateThemeAlias( + + /** + * @see {@link UpdateThemeAliasCommand} + */ + updateThemeAlias( args: UpdateThemeAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateThemeAlias( + updateThemeAlias( args: UpdateThemeAliasCommandInput, cb: (err: any, data?: UpdateThemeAliasCommandOutput) => void ): void; - public updateThemeAlias( + updateThemeAlias( args: UpdateThemeAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateThemeAliasCommandOutput) => void ): void; - public updateThemeAlias( - args: UpdateThemeAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateThemeAliasCommandOutput) => void), - cb?: (err: any, data?: UpdateThemeAliasCommandOutput) => void - ): Promise | void { - const command = new UpdateThemeAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the resource permissions for a theme. Permissions apply to the action to grant or - * revoke permissions on, for example "quicksight:DescribeTheme".

- *

Theme permissions apply in groupings. Valid groupings include the following for the three - * levels of permissions, which are user, owner, or no permissions:

- *
    - *
  • - *

    User

    - *
      - *
    • - *

      - * "quicksight:DescribeTheme" - *

      - *
    • - *
    • - *

      - * "quicksight:DescribeThemeAlias" - *

      - *
    • - *
    • - *

      - * "quicksight:ListThemeAliases" - *

      - *
    • - *
    • - *

      - * "quicksight:ListThemeVersions" - *

      - *
    • - *
    - *
  • - *
  • - *

    Owner

    - *
      - *
    • - *

      - * "quicksight:DescribeTheme" - *

      - *
    • - *
    • - *

      - * "quicksight:DescribeThemeAlias" - *

      - *
    • - *
    • - *

      - * "quicksight:ListThemeAliases" - *

      - *
    • - *
    • - *

      - * "quicksight:ListThemeVersions" - *

      - *
    • - *
    • - *

      - * "quicksight:DeleteTheme" - *

      - *
    • - *
    • - *

      - * "quicksight:UpdateTheme" - *

      - *
    • - *
    • - *

      - * "quicksight:CreateThemeAlias" - *

      - *
    • - *
    • - *

      - * "quicksight:DeleteThemeAlias" - *

      - *
    • - *
    • - *

      - * "quicksight:UpdateThemeAlias" - *

      - *
    • - *
    • - *

      - * "quicksight:UpdateThemePermissions" - *

      - *
    • - *
    • - *

      - * "quicksight:DescribeThemePermissions" - *

      - *
    • - *
    - *
  • - *
  • - *

    To specify no permissions, omit the permissions list.

    - *
  • - *
- */ - public updateThemePermissions( + + /** + * @see {@link UpdateThemePermissionsCommand} + */ + updateThemePermissions( args: UpdateThemePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateThemePermissions( + updateThemePermissions( args: UpdateThemePermissionsCommandInput, cb: (err: any, data?: UpdateThemePermissionsCommandOutput) => void ): void; - public updateThemePermissions( + updateThemePermissions( args: UpdateThemePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateThemePermissionsCommandOutput) => void ): void; - public updateThemePermissions( - args: UpdateThemePermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateThemePermissionsCommandOutput) => void), - cb?: (err: any, data?: UpdateThemePermissionsCommandOutput) => void - ): Promise | void { - const command = new UpdateThemePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an Amazon QuickSight user.

- */ - public updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise; - public updateUser(args: UpdateUserCommandInput, cb: (err: any, data?: UpdateUserCommandOutput) => void): void; - public updateUser( + + /** + * @see {@link UpdateUserCommand} + */ + updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise; + updateUser(args: UpdateUserCommandInput, cb: (err: any, data?: UpdateUserCommandOutput) => void): void; + updateUser( args: UpdateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserCommandOutput) => void ): void; - public updateUser( - args: UpdateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserCommandOutput) => void), - cb?: (err: any, data?: UpdateUserCommandOutput) => void - ): Promise | void { - const command = new UpdateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon QuickSight API Reference + *

Amazon QuickSight is a fully managed, serverless business intelligence service for the + * Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your + * organization. This API reference contains documentation for a programming interface that + * you can use to manage Amazon QuickSight.

+ */ +export class QuickSight extends QuickSightClient implements QuickSight {} +createAggregatedClient(commands, QuickSight); diff --git a/clients/client-ram/src/RAM.ts b/clients/client-ram/src/RAM.ts index 8389e904bd96..b9a852255b20 100644 --- a/clients/client-ram/src/RAM.ts +++ b/clients/client-ram/src/RAM.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -122,889 +123,456 @@ import { UpdateResourceShareCommandInput, UpdateResourceShareCommandOutput, } from "./commands/UpdateResourceShareCommand"; -import { RAMClient } from "./RAMClient"; +import { RAMClient, RAMClientConfig } from "./RAMClient"; -/** - * @public - *

This is the Resource Access Manager API Reference. This documentation provides - * descriptions and syntax for each of the actions and data types in RAM. RAM is a - * service that helps you securely share your Amazon Web Services resources across Amazon Web Services accounts. If you - * have multiple Amazon Web Services accounts, you can use RAM to share those resources with other - * accounts. If you use Organizations to manage your accounts, then you share your resources - * with your organization or organizational units (OUs). For supported resource types, you - * can also share resources with individual Identity and Access Management (IAM) roles an users.

- *

To learn more about RAM, see the following resources:

- * - */ -export class RAM extends RAMClient { +const commands = { + AcceptResourceShareInvitationCommand, + AssociateResourceShareCommand, + AssociateResourceSharePermissionCommand, + CreateResourceShareCommand, + DeleteResourceShareCommand, + DisassociateResourceShareCommand, + DisassociateResourceSharePermissionCommand, + EnableSharingWithAwsOrganizationCommand, + GetPermissionCommand, + GetResourcePoliciesCommand, + GetResourceShareAssociationsCommand, + GetResourceShareInvitationsCommand, + GetResourceSharesCommand, + ListPendingInvitationResourcesCommand, + ListPermissionsCommand, + ListPermissionVersionsCommand, + ListPrincipalsCommand, + ListResourcesCommand, + ListResourceSharePermissionsCommand, + ListResourceTypesCommand, + PromoteResourceShareCreatedFromPolicyCommand, + RejectResourceShareInvitationCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateResourceShareCommand, +}; + +export interface RAM { /** - * @public - *

Accepts an invitation to a resource share from another Amazon Web Services account. After you accept the - * invitation, the resources included in the resource share are available to interact with in the - * relevant Amazon Web Services Management Consoles and tools.

+ * @see {@link AcceptResourceShareInvitationCommand} */ - public acceptResourceShareInvitation( + acceptResourceShareInvitation( args: AcceptResourceShareInvitationCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptResourceShareInvitation( + acceptResourceShareInvitation( args: AcceptResourceShareInvitationCommandInput, cb: (err: any, data?: AcceptResourceShareInvitationCommandOutput) => void ): void; - public acceptResourceShareInvitation( + acceptResourceShareInvitation( args: AcceptResourceShareInvitationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptResourceShareInvitationCommandOutput) => void ): void; - public acceptResourceShareInvitation( - args: AcceptResourceShareInvitationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptResourceShareInvitationCommandOutput) => void), - cb?: (err: any, data?: AcceptResourceShareInvitationCommandOutput) => void - ): Promise | void { - const command = new AcceptResourceShareInvitationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds the specified list of principals and list of resources to a resource share. Principals that - * already have access to this resource share immediately receive access to the added resources. - * Newly added principals immediately receive access to the resources shared in this resource share.

+ * @see {@link AssociateResourceShareCommand} */ - public associateResourceShare( + associateResourceShare( args: AssociateResourceShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateResourceShare( + associateResourceShare( args: AssociateResourceShareCommandInput, cb: (err: any, data?: AssociateResourceShareCommandOutput) => void ): void; - public associateResourceShare( + associateResourceShare( args: AssociateResourceShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateResourceShareCommandOutput) => void ): void; - public associateResourceShare( - args: AssociateResourceShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateResourceShareCommandOutput) => void), - cb?: (err: any, data?: AssociateResourceShareCommandOutput) => void - ): Promise | void { - const command = new AssociateResourceShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or replaces the RAM permission for a resource type included in a resource share. You can - * have exactly one permission associated with each resource type in the resource share. You can add - * a new RAM permission only if there are currently no resources of that resource type - * currently in the resource share.

+ * @see {@link AssociateResourceSharePermissionCommand} */ - public associateResourceSharePermission( + associateResourceSharePermission( args: AssociateResourceSharePermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateResourceSharePermission( + associateResourceSharePermission( args: AssociateResourceSharePermissionCommandInput, cb: (err: any, data?: AssociateResourceSharePermissionCommandOutput) => void ): void; - public associateResourceSharePermission( + associateResourceSharePermission( args: AssociateResourceSharePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateResourceSharePermissionCommandOutput) => void ): void; - public associateResourceSharePermission( - args: AssociateResourceSharePermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateResourceSharePermissionCommandOutput) => void), - cb?: (err: any, data?: AssociateResourceSharePermissionCommandOutput) => void - ): Promise | void { - const command = new AssociateResourceSharePermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a resource share. You can provide a list of the Amazon Resource Names (ARNs) for the resources that you - * want to share, a list of principals you want to share the resources with, and the - * permissions to grant those principals.

- * - *

Sharing a resource makes it available for use by principals outside of the - * Amazon Web Services account that created the resource. Sharing doesn't change any permissions or - * quotas that apply to the resource in the account that created it.

- *
+ * @see {@link CreateResourceShareCommand} */ - public createResourceShare( + createResourceShare( args: CreateResourceShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public createResourceShare( + createResourceShare( args: CreateResourceShareCommandInput, cb: (err: any, data?: CreateResourceShareCommandOutput) => void ): void; - public createResourceShare( + createResourceShare( args: CreateResourceShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResourceShareCommandOutput) => void ): void; - public createResourceShare( - args: CreateResourceShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateResourceShareCommandOutput) => void), - cb?: (err: any, data?: CreateResourceShareCommandOutput) => void - ): Promise | void { - const command = new CreateResourceShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified resource share. This doesn't delete any of the resources that were - * associated with the resource share; it only stops the sharing of those resources outside of the - * Amazon Web Services account that created them.

+ * @see {@link DeleteResourceShareCommand} */ - public deleteResourceShare( + deleteResourceShare( args: DeleteResourceShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourceShare( + deleteResourceShare( args: DeleteResourceShareCommandInput, cb: (err: any, data?: DeleteResourceShareCommandOutput) => void ): void; - public deleteResourceShare( + deleteResourceShare( args: DeleteResourceShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourceShareCommandOutput) => void ): void; - public deleteResourceShare( - args: DeleteResourceShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourceShareCommandOutput) => void), - cb?: (err: any, data?: DeleteResourceShareCommandOutput) => void - ): Promise | void { - const command = new DeleteResourceShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates the specified principals or resources from the specified resource share.

+ * @see {@link DisassociateResourceShareCommand} */ - public disassociateResourceShare( + disassociateResourceShare( args: DisassociateResourceShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateResourceShare( + disassociateResourceShare( args: DisassociateResourceShareCommandInput, cb: (err: any, data?: DisassociateResourceShareCommandOutput) => void ): void; - public disassociateResourceShare( + disassociateResourceShare( args: DisassociateResourceShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateResourceShareCommandOutput) => void ): void; - public disassociateResourceShare( - args: DisassociateResourceShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateResourceShareCommandOutput) => void), - cb?: (err: any, data?: DisassociateResourceShareCommandOutput) => void - ): Promise | void { - const command = new DisassociateResourceShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates an RAM permission from a resource share. Permission changes take effect - * immediately. You can remove a RAM permission from a resource share only if there are currently - * no resources of the relevant resource type currently attached to the resource share.

+ * @see {@link DisassociateResourceSharePermissionCommand} */ - public disassociateResourceSharePermission( + disassociateResourceSharePermission( args: DisassociateResourceSharePermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateResourceSharePermission( + disassociateResourceSharePermission( args: DisassociateResourceSharePermissionCommandInput, cb: (err: any, data?: DisassociateResourceSharePermissionCommandOutput) => void ): void; - public disassociateResourceSharePermission( + disassociateResourceSharePermission( args: DisassociateResourceSharePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateResourceSharePermissionCommandOutput) => void ): void; - public disassociateResourceSharePermission( - args: DisassociateResourceSharePermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateResourceSharePermissionCommandOutput) => void), - cb?: (err: any, data?: DisassociateResourceSharePermissionCommandOutput) => void - ): Promise | void { - const command = new DisassociateResourceSharePermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables resource sharing within your organization in Organizations. Calling this operation - * enables RAM to retrieve information about the organization and its structure. This - * lets you share resources with all of the accounts in an organization by specifying the - * organization's ID, or all of the accounts in an organizational unit (OU) by specifying - * the OU's ID. Until you enable sharing within the organization, you can specify only - * individual Amazon Web Services accounts, or for supported resource types, IAM users and - * roles.

- *

You must call this operation from an IAM user or role in the organization's - * management account.

+ * @see {@link EnableSharingWithAwsOrganizationCommand} */ - public enableSharingWithAwsOrganization( + enableSharingWithAwsOrganization( args: EnableSharingWithAwsOrganizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableSharingWithAwsOrganization( + enableSharingWithAwsOrganization( args: EnableSharingWithAwsOrganizationCommandInput, cb: (err: any, data?: EnableSharingWithAwsOrganizationCommandOutput) => void ): void; - public enableSharingWithAwsOrganization( + enableSharingWithAwsOrganization( args: EnableSharingWithAwsOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableSharingWithAwsOrganizationCommandOutput) => void ): void; - public enableSharingWithAwsOrganization( - args: EnableSharingWithAwsOrganizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableSharingWithAwsOrganizationCommandOutput) => void), - cb?: (err: any, data?: EnableSharingWithAwsOrganizationCommandOutput) => void - ): Promise | void { - const command = new EnableSharingWithAwsOrganizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the contents of an RAM permission in JSON format.

+ * @see {@link GetPermissionCommand} */ - public getPermission( - args: GetPermissionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getPermission( - args: GetPermissionCommandInput, - cb: (err: any, data?: GetPermissionCommandOutput) => void - ): void; - public getPermission( + getPermission(args: GetPermissionCommandInput, options?: __HttpHandlerOptions): Promise; + getPermission(args: GetPermissionCommandInput, cb: (err: any, data?: GetPermissionCommandOutput) => void): void; + getPermission( args: GetPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPermissionCommandOutput) => void ): void; - public getPermission( - args: GetPermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPermissionCommandOutput) => void), - cb?: (err: any, data?: GetPermissionCommandOutput) => void - ): Promise | void { - const command = new GetPermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the resource policies for the specified resources that you own and have - * shared.

+ * @see {@link GetResourcePoliciesCommand} */ - public getResourcePolicies( + getResourcePolicies( args: GetResourcePoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourcePolicies( + getResourcePolicies( args: GetResourcePoliciesCommandInput, cb: (err: any, data?: GetResourcePoliciesCommandOutput) => void ): void; - public getResourcePolicies( + getResourcePolicies( args: GetResourcePoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePoliciesCommandOutput) => void ): void; - public getResourcePolicies( - args: GetResourcePoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourcePoliciesCommandOutput) => void), - cb?: (err: any, data?: GetResourcePoliciesCommandOutput) => void - ): Promise | void { - const command = new GetResourcePoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the resource and principal associations for resource shares that you own.

+ * @see {@link GetResourceShareAssociationsCommand} */ - public getResourceShareAssociations( + getResourceShareAssociations( args: GetResourceShareAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourceShareAssociations( + getResourceShareAssociations( args: GetResourceShareAssociationsCommandInput, cb: (err: any, data?: GetResourceShareAssociationsCommandOutput) => void ): void; - public getResourceShareAssociations( + getResourceShareAssociations( args: GetResourceShareAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceShareAssociationsCommandOutput) => void ): void; - public getResourceShareAssociations( - args: GetResourceShareAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourceShareAssociationsCommandOutput) => void), - cb?: (err: any, data?: GetResourceShareAssociationsCommandOutput) => void - ): Promise | void { - const command = new GetResourceShareAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves details about invitations that you have received for resource shares.

+ * @see {@link GetResourceShareInvitationsCommand} */ - public getResourceShareInvitations( + getResourceShareInvitations( args: GetResourceShareInvitationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourceShareInvitations( + getResourceShareInvitations( args: GetResourceShareInvitationsCommandInput, cb: (err: any, data?: GetResourceShareInvitationsCommandOutput) => void ): void; - public getResourceShareInvitations( + getResourceShareInvitations( args: GetResourceShareInvitationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceShareInvitationsCommandOutput) => void ): void; - public getResourceShareInvitations( - args: GetResourceShareInvitationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourceShareInvitationsCommandOutput) => void), - cb?: (err: any, data?: GetResourceShareInvitationsCommandOutput) => void - ): Promise | void { - const command = new GetResourceShareInvitationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves details about the resource shares that you own or that are shared with you.

+ * @see {@link GetResourceSharesCommand} */ - public getResourceShares( + getResourceShares( args: GetResourceSharesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourceShares( + getResourceShares( args: GetResourceSharesCommandInput, cb: (err: any, data?: GetResourceSharesCommandOutput) => void ): void; - public getResourceShares( + getResourceShares( args: GetResourceSharesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceSharesCommandOutput) => void ): void; - public getResourceShares( - args: GetResourceSharesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourceSharesCommandOutput) => void), - cb?: (err: any, data?: GetResourceSharesCommandOutput) => void - ): Promise | void { - const command = new GetResourceSharesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the resources in a resource share that is shared with you but for which the invitation is - * still PENDING. That means that you haven't accepted or rejected the - * invitation and the invitation hasn't expired.

+ * @see {@link ListPendingInvitationResourcesCommand} */ - public listPendingInvitationResources( + listPendingInvitationResources( args: ListPendingInvitationResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPendingInvitationResources( + listPendingInvitationResources( args: ListPendingInvitationResourcesCommandInput, cb: (err: any, data?: ListPendingInvitationResourcesCommandOutput) => void ): void; - public listPendingInvitationResources( + listPendingInvitationResources( args: ListPendingInvitationResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPendingInvitationResourcesCommandOutput) => void ): void; - public listPendingInvitationResources( - args: ListPendingInvitationResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPendingInvitationResourcesCommandOutput) => void), - cb?: (err: any, data?: ListPendingInvitationResourcesCommandOutput) => void - ): Promise | void { - const command = new ListPendingInvitationResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of available RAM permissions that you can use for the supported - * resource types.

+ * @see {@link ListPermissionsCommand} */ - public listPermissions( + listPermissions( args: ListPermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPermissions( - args: ListPermissionsCommandInput, - cb: (err: any, data?: ListPermissionsCommandOutput) => void - ): void; - public listPermissions( + listPermissions(args: ListPermissionsCommandInput, cb: (err: any, data?: ListPermissionsCommandOutput) => void): void; + listPermissions( args: ListPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPermissionsCommandOutput) => void ): void; - public listPermissions( - args: ListPermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPermissionsCommandOutput) => void), - cb?: (err: any, data?: ListPermissionsCommandOutput) => void - ): Promise | void { - const command = new ListPermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the available versions of the specified RAM permission.

+ * @see {@link ListPermissionVersionsCommand} */ - public listPermissionVersions( + listPermissionVersions( args: ListPermissionVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPermissionVersions( + listPermissionVersions( args: ListPermissionVersionsCommandInput, cb: (err: any, data?: ListPermissionVersionsCommandOutput) => void ): void; - public listPermissionVersions( + listPermissionVersions( args: ListPermissionVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPermissionVersionsCommandOutput) => void ): void; - public listPermissionVersions( - args: ListPermissionVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPermissionVersionsCommandOutput) => void), - cb?: (err: any, data?: ListPermissionVersionsCommandOutput) => void - ): Promise | void { - const command = new ListPermissionVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the principals that you are sharing resources with or that are sharing resources - * with you.

+ * @see {@link ListPrincipalsCommand} */ - public listPrincipals( + listPrincipals( args: ListPrincipalsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPrincipals( - args: ListPrincipalsCommandInput, - cb: (err: any, data?: ListPrincipalsCommandOutput) => void - ): void; - public listPrincipals( + listPrincipals(args: ListPrincipalsCommandInput, cb: (err: any, data?: ListPrincipalsCommandOutput) => void): void; + listPrincipals( args: ListPrincipalsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPrincipalsCommandOutput) => void ): void; - public listPrincipals( - args: ListPrincipalsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPrincipalsCommandOutput) => void), - cb?: (err: any, data?: ListPrincipalsCommandOutput) => void - ): Promise | void { - const command = new ListPrincipalsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the resources that you added to a resource share or the resources that are shared with - * you.

+ * @see {@link ListResourcesCommand} */ - public listResources( - args: ListResourcesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listResources( - args: ListResourcesCommandInput, - cb: (err: any, data?: ListResourcesCommandOutput) => void - ): void; - public listResources( + listResources(args: ListResourcesCommandInput, options?: __HttpHandlerOptions): Promise; + listResources(args: ListResourcesCommandInput, cb: (err: any, data?: ListResourcesCommandOutput) => void): void; + listResources( args: ListResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourcesCommandOutput) => void ): void; - public listResources( - args: ListResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourcesCommandOutput) => void), - cb?: (err: any, data?: ListResourcesCommandOutput) => void - ): Promise | void { - const command = new ListResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the RAM permissions that are associated with a resource share.

+ * @see {@link ListResourceSharePermissionsCommand} */ - public listResourceSharePermissions( + listResourceSharePermissions( args: ListResourceSharePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourceSharePermissions( + listResourceSharePermissions( args: ListResourceSharePermissionsCommandInput, cb: (err: any, data?: ListResourceSharePermissionsCommandOutput) => void ): void; - public listResourceSharePermissions( + listResourceSharePermissions( args: ListResourceSharePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceSharePermissionsCommandOutput) => void ): void; - public listResourceSharePermissions( - args: ListResourceSharePermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourceSharePermissionsCommandOutput) => void), - cb?: (err: any, data?: ListResourceSharePermissionsCommandOutput) => void - ): Promise | void { - const command = new ListResourceSharePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the resource types that can be shared by RAM.

+ * @see {@link ListResourceTypesCommand} */ - public listResourceTypes( + listResourceTypes( args: ListResourceTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourceTypes( + listResourceTypes( args: ListResourceTypesCommandInput, cb: (err: any, data?: ListResourceTypesCommandOutput) => void ): void; - public listResourceTypes( + listResourceTypes( args: ListResourceTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceTypesCommandOutput) => void ): void; - public listResourceTypes( - args: ListResourceTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourceTypesCommandOutput) => void), - cb?: (err: any, data?: ListResourceTypesCommandOutput) => void - ): Promise | void { - const command = new ListResourceTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

When you attach a resource-based permission policy to a resource, it automatically - * creates a resource share. However, resource shares created this way are visible only to the resource share owner, and - * the resource share can't be modified in RAM.

- *

You can use this operation to promote the resource share to a full RAM resource share. When you promote - * a resource share, you can then manage the resource share in RAM and it becomes visible to all of the - * principals you shared it with.

+ * @see {@link PromoteResourceShareCreatedFromPolicyCommand} */ - public promoteResourceShareCreatedFromPolicy( + promoteResourceShareCreatedFromPolicy( args: PromoteResourceShareCreatedFromPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public promoteResourceShareCreatedFromPolicy( + promoteResourceShareCreatedFromPolicy( args: PromoteResourceShareCreatedFromPolicyCommandInput, cb: (err: any, data?: PromoteResourceShareCreatedFromPolicyCommandOutput) => void ): void; - public promoteResourceShareCreatedFromPolicy( + promoteResourceShareCreatedFromPolicy( args: PromoteResourceShareCreatedFromPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PromoteResourceShareCreatedFromPolicyCommandOutput) => void ): void; - public promoteResourceShareCreatedFromPolicy( - args: PromoteResourceShareCreatedFromPolicyCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PromoteResourceShareCreatedFromPolicyCommandOutput) => void), - cb?: (err: any, data?: PromoteResourceShareCreatedFromPolicyCommandOutput) => void - ): Promise | void { - const command = new PromoteResourceShareCreatedFromPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Rejects an invitation to a resource share from another Amazon Web Services account.

+ * @see {@link RejectResourceShareInvitationCommand} */ - public rejectResourceShareInvitation( + rejectResourceShareInvitation( args: RejectResourceShareInvitationCommandInput, options?: __HttpHandlerOptions ): Promise; - public rejectResourceShareInvitation( + rejectResourceShareInvitation( args: RejectResourceShareInvitationCommandInput, cb: (err: any, data?: RejectResourceShareInvitationCommandOutput) => void ): void; - public rejectResourceShareInvitation( + rejectResourceShareInvitation( args: RejectResourceShareInvitationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectResourceShareInvitationCommandOutput) => void ): void; - public rejectResourceShareInvitation( - args: RejectResourceShareInvitationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RejectResourceShareInvitationCommandOutput) => void), - cb?: (err: any, data?: RejectResourceShareInvitationCommandOutput) => void - ): Promise | void { - const command = new RejectResourceShareInvitationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds the specified tag keys and values to the specified resource share. The tags are attached - * only to the resource share, not to the resources that are in the resource share.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified tag key and value pairs from the specified resource share.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies some of the properties of the specified resource share.

+ * @see {@link UpdateResourceShareCommand} */ - public updateResourceShare( + updateResourceShare( args: UpdateResourceShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateResourceShare( + updateResourceShare( args: UpdateResourceShareCommandInput, cb: (err: any, data?: UpdateResourceShareCommandOutput) => void ): void; - public updateResourceShare( + updateResourceShare( args: UpdateResourceShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResourceShareCommandOutput) => void ): void; - public updateResourceShare( - args: UpdateResourceShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResourceShareCommandOutput) => void), - cb?: (err: any, data?: UpdateResourceShareCommandOutput) => void - ): Promise | void { - const command = new UpdateResourceShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

This is the Resource Access Manager API Reference. This documentation provides + * descriptions and syntax for each of the actions and data types in RAM. RAM is a + * service that helps you securely share your Amazon Web Services resources across Amazon Web Services accounts. If you + * have multiple Amazon Web Services accounts, you can use RAM to share those resources with other + * accounts. If you use Organizations to manage your accounts, then you share your resources + * with your organization or organizational units (OUs). For supported resource types, you + * can also share resources with individual Identity and Access Management (IAM) roles an users.

+ *

To learn more about RAM, see the following resources:

+ * + */ +export class RAM extends RAMClient implements RAM {} +createAggregatedClient(commands, RAM); diff --git a/clients/client-rbin/src/Rbin.ts b/clients/client-rbin/src/Rbin.ts index 3bd4a4ae6867..ae813f7c21c8 100644 --- a/clients/client-rbin/src/Rbin.ts +++ b/clients/client-rbin/src/Rbin.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { CreateRuleCommand, CreateRuleCommandInput, CreateRuleCommandOutput } from "./commands/CreateRuleCommand"; @@ -19,311 +20,155 @@ import { UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; import { UpdateRuleCommand, UpdateRuleCommandInput, UpdateRuleCommandOutput } from "./commands/UpdateRuleCommand"; -import { RbinClient } from "./RbinClient"; +import { RbinClient, RbinClientConfig } from "./RbinClient"; -/** - * @public - *

This is the Recycle Bin API Reference. This documentation provides - * descriptions and syntax for each of the actions and data types in Recycle Bin.

- * - *

Recycle Bin is a resource recovery feature that enables you to restore accidentally - * deleted snapshots and EBS-backed AMIs. When using Recycle Bin, if your resources are - * deleted, they are retained in the Recycle Bin for a time period that you specify.

- * - *

You can restore a resource from the Recycle Bin at any time before its retention period - * expires. After you restore a resource from the Recycle Bin, the resource is removed from the - * Recycle Bin, and you can then use it in the same way you use any other resource of that type - * in your account. If the retention period expires and the resource is not restored, the resource - * is permanently deleted from the Recycle Bin and is no longer available for recovery. For more - * information about Recycle Bin, see - * Recycle Bin in the Amazon Elastic Compute Cloud User Guide.

- */ -export class Rbin extends RbinClient { +const commands = { + CreateRuleCommand, + DeleteRuleCommand, + GetRuleCommand, + ListRulesCommand, + ListTagsForResourceCommand, + LockRuleCommand, + TagResourceCommand, + UnlockRuleCommand, + UntagResourceCommand, + UpdateRuleCommand, +}; + +export interface Rbin { /** - * @public - *

Creates a Recycle Bin retention rule. For more information, see - * Create Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

+ * @see {@link CreateRuleCommand} */ - public createRule(args: CreateRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public createRule(args: CreateRuleCommandInput, cb: (err: any, data?: CreateRuleCommandOutput) => void): void; - public createRule( + createRule(args: CreateRuleCommandInput, options?: __HttpHandlerOptions): Promise; + createRule(args: CreateRuleCommandInput, cb: (err: any, data?: CreateRuleCommandOutput) => void): void; + createRule( args: CreateRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRuleCommandOutput) => void ): void; - public createRule( - args: CreateRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRuleCommandOutput) => void), - cb?: (err: any, data?: CreateRuleCommandOutput) => void - ): Promise | void { - const command = new CreateRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Recycle Bin retention rule. For more information, see - * Delete Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

+ * @see {@link DeleteRuleCommand} */ - public deleteRule(args: DeleteRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteRule(args: DeleteRuleCommandInput, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void; - public deleteRule( + deleteRule(args: DeleteRuleCommandInput, options?: __HttpHandlerOptions): Promise; + deleteRule(args: DeleteRuleCommandInput, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void; + deleteRule( args: DeleteRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRuleCommandOutput) => void ): void; - public deleteRule( - args: DeleteRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a Recycle Bin retention rule.

+ * @see {@link GetRuleCommand} */ - public getRule(args: GetRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public getRule(args: GetRuleCommandInput, cb: (err: any, data?: GetRuleCommandOutput) => void): void; - public getRule( + getRule(args: GetRuleCommandInput, options?: __HttpHandlerOptions): Promise; + getRule(args: GetRuleCommandInput, cb: (err: any, data?: GetRuleCommandOutput) => void): void; + getRule( args: GetRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRuleCommandOutput) => void ): void; - public getRule( - args: GetRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRuleCommandOutput) => void), - cb?: (err: any, data?: GetRuleCommandOutput) => void - ): Promise | void { - const command = new GetRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the Recycle Bin retention rules in the Region.

+ * @see {@link ListRulesCommand} */ - public listRules(args: ListRulesCommandInput, options?: __HttpHandlerOptions): Promise; - public listRules(args: ListRulesCommandInput, cb: (err: any, data?: ListRulesCommandOutput) => void): void; - public listRules( + listRules(args: ListRulesCommandInput, options?: __HttpHandlerOptions): Promise; + listRules(args: ListRulesCommandInput, cb: (err: any, data?: ListRulesCommandOutput) => void): void; + listRules( args: ListRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRulesCommandOutput) => void ): void; - public listRules( - args: ListRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRulesCommandOutput) => void), - cb?: (err: any, data?: ListRulesCommandOutput) => void - ): Promise | void { - const command = new ListRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags assigned to a retention rule.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Locks a retention rule. A locked retention rule can't be modified or deleted.

+ * @see {@link LockRuleCommand} */ - public lockRule(args: LockRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public lockRule(args: LockRuleCommandInput, cb: (err: any, data?: LockRuleCommandOutput) => void): void; - public lockRule( + lockRule(args: LockRuleCommandInput, options?: __HttpHandlerOptions): Promise; + lockRule(args: LockRuleCommandInput, cb: (err: any, data?: LockRuleCommandOutput) => void): void; + lockRule( args: LockRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: LockRuleCommandOutput) => void ): void; - public lockRule( - args: LockRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: LockRuleCommandOutput) => void), - cb?: (err: any, data?: LockRuleCommandOutput) => void - ): Promise | void { - const command = new LockRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns tags to the specified retention rule.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Unlocks a retention rule. After a retention rule is unlocked, it can be modified or deleted - * only after the unlock delay period expires.

+ * @see {@link UnlockRuleCommand} */ - public unlockRule(args: UnlockRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public unlockRule(args: UnlockRuleCommandInput, cb: (err: any, data?: UnlockRuleCommandOutput) => void): void; - public unlockRule( + unlockRule(args: UnlockRuleCommandInput, options?: __HttpHandlerOptions): Promise; + unlockRule(args: UnlockRuleCommandInput, cb: (err: any, data?: UnlockRuleCommandOutput) => void): void; + unlockRule( args: UnlockRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnlockRuleCommandOutput) => void ): void; - public unlockRule( - args: UnlockRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnlockRuleCommandOutput) => void), - cb?: (err: any, data?: UnlockRuleCommandOutput) => void - ): Promise | void { - const command = new UnlockRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Unassigns a tag from a retention rule.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing Recycle Bin retention rule. You can update a retention rule's description, - * resource tags, and retention period at any time after creation. You can't update a retention rule's - * resource type after creation. For more information, see - * Update Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

+ * @see {@link UpdateRuleCommand} */ - public updateRule(args: UpdateRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public updateRule(args: UpdateRuleCommandInput, cb: (err: any, data?: UpdateRuleCommandOutput) => void): void; - public updateRule( + updateRule(args: UpdateRuleCommandInput, options?: __HttpHandlerOptions): Promise; + updateRule(args: UpdateRuleCommandInput, cb: (err: any, data?: UpdateRuleCommandOutput) => void): void; + updateRule( args: UpdateRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRuleCommandOutput) => void ): void; - public updateRule( - args: UpdateRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRuleCommandOutput) => void), - cb?: (err: any, data?: UpdateRuleCommandOutput) => void - ): Promise | void { - const command = new UpdateRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

This is the Recycle Bin API Reference. This documentation provides + * descriptions and syntax for each of the actions and data types in Recycle Bin.

+ * + *

Recycle Bin is a resource recovery feature that enables you to restore accidentally + * deleted snapshots and EBS-backed AMIs. When using Recycle Bin, if your resources are + * deleted, they are retained in the Recycle Bin for a time period that you specify.

+ * + *

You can restore a resource from the Recycle Bin at any time before its retention period + * expires. After you restore a resource from the Recycle Bin, the resource is removed from the + * Recycle Bin, and you can then use it in the same way you use any other resource of that type + * in your account. If the retention period expires and the resource is not restored, the resource + * is permanently deleted from the Recycle Bin and is no longer available for recovery. For more + * information about Recycle Bin, see + * Recycle Bin in the Amazon Elastic Compute Cloud User Guide.

+ */ +export class Rbin extends RbinClient implements Rbin {} +createAggregatedClient(commands, Rbin); diff --git a/clients/client-rds-data/src/RDSData.ts b/clients/client-rds-data/src/RDSData.ts index 6617f05b66e4..de36d65d3052 100644 --- a/clients/client-rds-data/src/RDSData.ts +++ b/clients/client-rds-data/src/RDSData.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -27,244 +28,126 @@ import { RollbackTransactionCommandInput, RollbackTransactionCommandOutput, } from "./commands/RollbackTransactionCommand"; -import { RDSDataClient } from "./RDSDataClient"; +import { RDSDataClient, RDSDataClientConfig } from "./RDSDataClient"; -/** - * @public - * Amazon RDS Data Service - *

Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless v1 DB cluster. To run these - * statements, you work with the Data Service API.

- * - *

The Data Service API isn't supported on Amazon Aurora Serverless v2 DB clusters.

- *
- *

For more information about the Data Service API, see - * Using the Data API - * in the Amazon Aurora User Guide.

- */ -export class RDSData extends RDSDataClient { +const commands = { + BatchExecuteStatementCommand, + BeginTransactionCommand, + CommitTransactionCommand, + ExecuteSqlCommand, + ExecuteStatementCommand, + RollbackTransactionCommand, +}; + +export interface RDSData { /** - * @public - *

Runs a batch SQL statement over an array of data.

- *

You can run bulk update and insert operations for multiple records using a DML - * statement with different parameter sets. Bulk operations can provide a significant - * performance improvement over individual insert and update operations.

- * - *

If a call isn't part of a transaction because it doesn't include the transactionID parameter, - * changes that result from the call are committed automatically.

- *

There isn't a fixed upper limit on the number of parameter sets. However, the maximum size of the HTTP request - * submitted through the Data API is 4 MiB. If the request exceeds this limit, the Data API returns an error and doesn't - * process the request. This 4-MiB limit includes the size of the HTTP headers and the JSON notation in the request. Thus, the - * number of parameter sets that you can include depends on a combination of factors, such as the size of the SQL statement and - * the size of each parameter set.

- *

The response size limit is 1 MiB. If the call returns more than 1 MiB of response data, the call is terminated.

- *
+ * @see {@link BatchExecuteStatementCommand} */ - public batchExecuteStatement( + batchExecuteStatement( args: BatchExecuteStatementCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchExecuteStatement( + batchExecuteStatement( args: BatchExecuteStatementCommandInput, cb: (err: any, data?: BatchExecuteStatementCommandOutput) => void ): void; - public batchExecuteStatement( + batchExecuteStatement( args: BatchExecuteStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchExecuteStatementCommandOutput) => void ): void; - public batchExecuteStatement( - args: BatchExecuteStatementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchExecuteStatementCommandOutput) => void), - cb?: (err: any, data?: BatchExecuteStatementCommandOutput) => void - ): Promise | void { - const command = new BatchExecuteStatementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a SQL transaction.

- * - *

A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 - * hours.

- *

A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's - * committed, it's rolled back automatically.

- *

DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate - * ExecuteStatement call with continueAfterTimeout enabled.

- *
+ * @see {@link BeginTransactionCommand} */ - public beginTransaction( + beginTransaction( args: BeginTransactionCommandInput, options?: __HttpHandlerOptions ): Promise; - public beginTransaction( + beginTransaction( args: BeginTransactionCommandInput, cb: (err: any, data?: BeginTransactionCommandOutput) => void ): void; - public beginTransaction( + beginTransaction( args: BeginTransactionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BeginTransactionCommandOutput) => void ): void; - public beginTransaction( - args: BeginTransactionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BeginTransactionCommandOutput) => void), - cb?: (err: any, data?: BeginTransactionCommandOutput) => void - ): Promise | void { - const command = new BeginTransactionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Ends a SQL transaction started with the BeginTransaction operation and - * commits the changes.

+ * @see {@link CommitTransactionCommand} */ - public commitTransaction( + commitTransaction( args: CommitTransactionCommandInput, options?: __HttpHandlerOptions ): Promise; - public commitTransaction( + commitTransaction( args: CommitTransactionCommandInput, cb: (err: any, data?: CommitTransactionCommandOutput) => void ): void; - public commitTransaction( + commitTransaction( args: CommitTransactionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CommitTransactionCommandOutput) => void ): void; - public commitTransaction( - args: CommitTransactionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CommitTransactionCommandOutput) => void), - cb?: (err: any, data?: CommitTransactionCommandOutput) => void - ): Promise | void { - const command = new CommitTransactionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Runs one or more SQL statements.

- * - *

This operation is deprecated. Use the BatchExecuteStatement or - * ExecuteStatement operation.

- *
+ * @see {@link ExecuteSqlCommand} */ - public executeSql(args: ExecuteSqlCommandInput, options?: __HttpHandlerOptions): Promise; - public executeSql(args: ExecuteSqlCommandInput, cb: (err: any, data?: ExecuteSqlCommandOutput) => void): void; - public executeSql( + executeSql(args: ExecuteSqlCommandInput, options?: __HttpHandlerOptions): Promise; + executeSql(args: ExecuteSqlCommandInput, cb: (err: any, data?: ExecuteSqlCommandOutput) => void): void; + executeSql( args: ExecuteSqlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteSqlCommandOutput) => void ): void; - public executeSql( - args: ExecuteSqlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExecuteSqlCommandOutput) => void), - cb?: (err: any, data?: ExecuteSqlCommandOutput) => void - ): Promise | void { - const command = new ExecuteSqlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Runs a SQL statement against a database.

- * - *

If a call isn't part of a transaction because it doesn't include the - * transactionID parameter, changes that result from the call are - * committed automatically.

- *

If the binary response data from the database is more than 1 MB, the call is terminated.

- *
+ * @see {@link ExecuteStatementCommand} */ - public executeStatement( + executeStatement( args: ExecuteStatementCommandInput, options?: __HttpHandlerOptions ): Promise; - public executeStatement( + executeStatement( args: ExecuteStatementCommandInput, cb: (err: any, data?: ExecuteStatementCommandOutput) => void ): void; - public executeStatement( + executeStatement( args: ExecuteStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteStatementCommandOutput) => void ): void; - public executeStatement( - args: ExecuteStatementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExecuteStatementCommandOutput) => void), - cb?: (err: any, data?: ExecuteStatementCommandOutput) => void - ): Promise | void { - const command = new ExecuteStatementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Performs a rollback of a transaction. Rolling back a transaction cancels its changes.

+ * @see {@link RollbackTransactionCommand} */ - public rollbackTransaction( + rollbackTransaction( args: RollbackTransactionCommandInput, options?: __HttpHandlerOptions ): Promise; - public rollbackTransaction( + rollbackTransaction( args: RollbackTransactionCommandInput, cb: (err: any, data?: RollbackTransactionCommandOutput) => void ): void; - public rollbackTransaction( + rollbackTransaction( args: RollbackTransactionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RollbackTransactionCommandOutput) => void ): void; - public rollbackTransaction( - args: RollbackTransactionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RollbackTransactionCommandOutput) => void), - cb?: (err: any, data?: RollbackTransactionCommandOutput) => void - ): Promise | void { - const command = new RollbackTransactionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon RDS Data Service + *

Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless v1 DB cluster. To run these + * statements, you work with the Data Service API.

+ * + *

The Data Service API isn't supported on Amazon Aurora Serverless v2 DB clusters.

+ *
+ *

For more information about the Data Service API, see + * Using the Data API + * in the Amazon Aurora User Guide.

+ */ +export class RDSData extends RDSDataClient implements RDSData {} +createAggregatedClient(commands, RDSData); diff --git a/clients/client-rds/src/RDS.ts b/clients/client-rds/src/RDS.ts index ad290822cfab..0ee98daa9b80 100644 --- a/clients/client-rds/src/RDS.ts +++ b/clients/client-rds/src/RDS.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -706,5590 +707,2549 @@ import { SwitchoverReadReplicaCommandInput, SwitchoverReadReplicaCommandOutput, } from "./commands/SwitchoverReadReplicaCommand"; -import { RDSClient } from "./RDSClient"; +import { RDSClient, RDSClientConfig } from "./RDSClient"; -/** - * @public - * Amazon Relational Database Service - *

- *

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and - * scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational - * database and manages common database administration tasks, freeing up developers to focus on what makes their applications - * and businesses unique.

- *

Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, - * Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools - * you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS - * automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS - * is flexible: you can scale your DB instance's compute resources and storage capacity to meet your - * application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for - * the resources you use.

- *

This interface reference for Amazon RDS contains documentation for a programming or command line interface - * you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might - * require techniques such as polling or callback functions to determine when a command has been applied. In this - * reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, - * or during the maintenance window. The reference structure is as follows, and we list following some related topics - * from the user guide.

- *

- * Amazon RDS API Reference - *

- *
    - *
  • - *

    For the alphabetical list of API actions, see - * API Actions.

    - *
  • - *
  • - *

    For the alphabetical list of data types, see - * Data Types.

    - *
  • - *
  • - *

    For a list of common query parameters, see - * Common Parameters.

    - *
  • - *
  • - *

    For descriptions of the error codes, see - * Common Errors.

    - *
  • - *
- *

- * Amazon RDS User Guide - *

- * - */ -export class RDS extends RDSClient { +const commands = { + AddRoleToDBClusterCommand, + AddRoleToDBInstanceCommand, + AddSourceIdentifierToSubscriptionCommand, + AddTagsToResourceCommand, + ApplyPendingMaintenanceActionCommand, + AuthorizeDBSecurityGroupIngressCommand, + BacktrackDBClusterCommand, + CancelExportTaskCommand, + CopyDBClusterParameterGroupCommand, + CopyDBClusterSnapshotCommand, + CopyDBParameterGroupCommand, + CopyDBSnapshotCommand, + CopyOptionGroupCommand, + CreateBlueGreenDeploymentCommand, + CreateCustomDBEngineVersionCommand, + CreateDBClusterCommand, + CreateDBClusterEndpointCommand, + CreateDBClusterParameterGroupCommand, + CreateDBClusterSnapshotCommand, + CreateDBInstanceCommand, + CreateDBInstanceReadReplicaCommand, + CreateDBParameterGroupCommand, + CreateDBProxyCommand, + CreateDBProxyEndpointCommand, + CreateDBSecurityGroupCommand, + CreateDBSnapshotCommand, + CreateDBSubnetGroupCommand, + CreateEventSubscriptionCommand, + CreateGlobalClusterCommand, + CreateOptionGroupCommand, + DeleteBlueGreenDeploymentCommand, + DeleteCustomDBEngineVersionCommand, + DeleteDBClusterCommand, + DeleteDBClusterEndpointCommand, + DeleteDBClusterParameterGroupCommand, + DeleteDBClusterSnapshotCommand, + DeleteDBInstanceCommand, + DeleteDBInstanceAutomatedBackupCommand, + DeleteDBParameterGroupCommand, + DeleteDBProxyCommand, + DeleteDBProxyEndpointCommand, + DeleteDBSecurityGroupCommand, + DeleteDBSnapshotCommand, + DeleteDBSubnetGroupCommand, + DeleteEventSubscriptionCommand, + DeleteGlobalClusterCommand, + DeleteOptionGroupCommand, + DeregisterDBProxyTargetsCommand, + DescribeAccountAttributesCommand, + DescribeBlueGreenDeploymentsCommand, + DescribeCertificatesCommand, + DescribeDBClusterBacktracksCommand, + DescribeDBClusterEndpointsCommand, + DescribeDBClusterParameterGroupsCommand, + DescribeDBClusterParametersCommand, + DescribeDBClustersCommand, + DescribeDBClusterSnapshotAttributesCommand, + DescribeDBClusterSnapshotsCommand, + DescribeDBEngineVersionsCommand, + DescribeDBInstanceAutomatedBackupsCommand, + DescribeDBInstancesCommand, + DescribeDBLogFilesCommand, + DescribeDBParameterGroupsCommand, + DescribeDBParametersCommand, + DescribeDBProxiesCommand, + DescribeDBProxyEndpointsCommand, + DescribeDBProxyTargetGroupsCommand, + DescribeDBProxyTargetsCommand, + DescribeDBSecurityGroupsCommand, + DescribeDBSnapshotAttributesCommand, + DescribeDBSnapshotsCommand, + DescribeDBSubnetGroupsCommand, + DescribeEngineDefaultClusterParametersCommand, + DescribeEngineDefaultParametersCommand, + DescribeEventCategoriesCommand, + DescribeEventsCommand, + DescribeEventSubscriptionsCommand, + DescribeExportTasksCommand, + DescribeGlobalClustersCommand, + DescribeOptionGroupOptionsCommand, + DescribeOptionGroupsCommand, + DescribeOrderableDBInstanceOptionsCommand, + DescribePendingMaintenanceActionsCommand, + DescribeReservedDBInstancesCommand, + DescribeReservedDBInstancesOfferingsCommand, + DescribeSourceRegionsCommand, + DescribeValidDBInstanceModificationsCommand, + DownloadDBLogFilePortionCommand, + FailoverDBClusterCommand, + FailoverGlobalClusterCommand, + ListTagsForResourceCommand, + ModifyActivityStreamCommand, + ModifyCertificatesCommand, + ModifyCurrentDBClusterCapacityCommand, + ModifyCustomDBEngineVersionCommand, + ModifyDBClusterCommand, + ModifyDBClusterEndpointCommand, + ModifyDBClusterParameterGroupCommand, + ModifyDBClusterSnapshotAttributeCommand, + ModifyDBInstanceCommand, + ModifyDBParameterGroupCommand, + ModifyDBProxyCommand, + ModifyDBProxyEndpointCommand, + ModifyDBProxyTargetGroupCommand, + ModifyDBSnapshotCommand, + ModifyDBSnapshotAttributeCommand, + ModifyDBSubnetGroupCommand, + ModifyEventSubscriptionCommand, + ModifyGlobalClusterCommand, + ModifyOptionGroupCommand, + PromoteReadReplicaCommand, + PromoteReadReplicaDBClusterCommand, + PurchaseReservedDBInstancesOfferingCommand, + RebootDBClusterCommand, + RebootDBInstanceCommand, + RegisterDBProxyTargetsCommand, + RemoveFromGlobalClusterCommand, + RemoveRoleFromDBClusterCommand, + RemoveRoleFromDBInstanceCommand, + RemoveSourceIdentifierFromSubscriptionCommand, + RemoveTagsFromResourceCommand, + ResetDBClusterParameterGroupCommand, + ResetDBParameterGroupCommand, + RestoreDBClusterFromS3Command, + RestoreDBClusterFromSnapshotCommand, + RestoreDBClusterToPointInTimeCommand, + RestoreDBInstanceFromDBSnapshotCommand, + RestoreDBInstanceFromS3Command, + RestoreDBInstanceToPointInTimeCommand, + RevokeDBSecurityGroupIngressCommand, + StartActivityStreamCommand, + StartDBClusterCommand, + StartDBInstanceCommand, + StartDBInstanceAutomatedBackupsReplicationCommand, + StartExportTaskCommand, + StopActivityStreamCommand, + StopDBClusterCommand, + StopDBInstanceCommand, + StopDBInstanceAutomatedBackupsReplicationCommand, + SwitchoverBlueGreenDeploymentCommand, + SwitchoverReadReplicaCommand, +}; + +export interface RDS { /** - * @public - *

Associates an Identity and Access Management (IAM) role with a DB cluster.

+ * @see {@link AddRoleToDBClusterCommand} */ - public addRoleToDBCluster( + addRoleToDBCluster( args: AddRoleToDBClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public addRoleToDBCluster( + addRoleToDBCluster( args: AddRoleToDBClusterCommandInput, cb: (err: any, data?: AddRoleToDBClusterCommandOutput) => void ): void; - public addRoleToDBCluster( + addRoleToDBCluster( args: AddRoleToDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddRoleToDBClusterCommandOutput) => void ): void; - public addRoleToDBCluster( - args: AddRoleToDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddRoleToDBClusterCommandOutput) => void), - cb?: (err: any, data?: AddRoleToDBClusterCommandOutput) => void - ): Promise | void { - const command = new AddRoleToDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.

- * - *

To add a role to a DB instance, the status of the DB instance must be available.

- *
- *

This command doesn't apply to RDS Custom.

- */ - public addRoleToDBInstance( + + /** + * @see {@link AddRoleToDBInstanceCommand} + */ + addRoleToDBInstance( args: AddRoleToDBInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public addRoleToDBInstance( + addRoleToDBInstance( args: AddRoleToDBInstanceCommandInput, cb: (err: any, data?: AddRoleToDBInstanceCommandOutput) => void ): void; - public addRoleToDBInstance( + addRoleToDBInstance( args: AddRoleToDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddRoleToDBInstanceCommandOutput) => void ): void; - public addRoleToDBInstance( - args: AddRoleToDBInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddRoleToDBInstanceCommandOutput) => void), - cb?: (err: any, data?: AddRoleToDBInstanceCommandOutput) => void - ): Promise | void { - const command = new AddRoleToDBInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds a source identifier to an existing RDS event notification subscription.

- */ - public addSourceIdentifierToSubscription( + + /** + * @see {@link AddSourceIdentifierToSubscriptionCommand} + */ + addSourceIdentifierToSubscription( args: AddSourceIdentifierToSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public addSourceIdentifierToSubscription( + addSourceIdentifierToSubscription( args: AddSourceIdentifierToSubscriptionCommandInput, cb: (err: any, data?: AddSourceIdentifierToSubscriptionCommandOutput) => void ): void; - public addSourceIdentifierToSubscription( + addSourceIdentifierToSubscription( args: AddSourceIdentifierToSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddSourceIdentifierToSubscriptionCommandOutput) => void ): void; - public addSourceIdentifierToSubscription( - args: AddSourceIdentifierToSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddSourceIdentifierToSubscriptionCommandOutput) => void), - cb?: (err: any, data?: AddSourceIdentifierToSubscriptionCommandOutput) => void - ): Promise | void { - const command = new AddSourceIdentifierToSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

- *

For an overview on tagging Amazon RDS resources, - * see Tagging Amazon RDS Resources.

- */ - public addTagsToResource( + + /** + * @see {@link AddTagsToResourceCommand} + */ + addTagsToResource( args: AddTagsToResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public addTagsToResource( + addTagsToResource( args: AddTagsToResourceCommandInput, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void ): void; - public addTagsToResource( + addTagsToResource( args: AddTagsToResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void ): void; - public addTagsToResource( - args: AddTagsToResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddTagsToResourceCommandOutput) => void), - cb?: (err: any, data?: AddTagsToResourceCommandOutput) => void - ): Promise | void { - const command = new AddTagsToResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Applies a pending maintenance action to a resource (for example, to a DB instance).

- */ - public applyPendingMaintenanceAction( + + /** + * @see {@link ApplyPendingMaintenanceActionCommand} + */ + applyPendingMaintenanceAction( args: ApplyPendingMaintenanceActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public applyPendingMaintenanceAction( + applyPendingMaintenanceAction( args: ApplyPendingMaintenanceActionCommandInput, cb: (err: any, data?: ApplyPendingMaintenanceActionCommandOutput) => void ): void; - public applyPendingMaintenanceAction( + applyPendingMaintenanceAction( args: ApplyPendingMaintenanceActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ApplyPendingMaintenanceActionCommandOutput) => void ): void; - public applyPendingMaintenanceAction( - args: ApplyPendingMaintenanceActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ApplyPendingMaintenanceActionCommandOutput) => void), - cb?: (err: any, data?: ApplyPendingMaintenanceActionCommandOutput) => void - ): Promise | void { - const command = new ApplyPendingMaintenanceActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security - * groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC - * instances. Second, IP ranges are available if the application accessing your database is running on the internet. - * Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId - * and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

- *

You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in - * another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

- *

For an overview of CIDR ranges, go to the - * Wikipedia Tutorial.

- * - *

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that - * you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the - * Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – - * Here’s How to Prepare, and Moving a DB instance not in a VPC - * into a VPC in the Amazon RDS User Guide.

- *
- */ - public authorizeDBSecurityGroupIngress( + + /** + * @see {@link AuthorizeDBSecurityGroupIngressCommand} + */ + authorizeDBSecurityGroupIngress( args: AuthorizeDBSecurityGroupIngressCommandInput, options?: __HttpHandlerOptions ): Promise; - public authorizeDBSecurityGroupIngress( + authorizeDBSecurityGroupIngress( args: AuthorizeDBSecurityGroupIngressCommandInput, cb: (err: any, data?: AuthorizeDBSecurityGroupIngressCommandOutput) => void ): void; - public authorizeDBSecurityGroupIngress( + authorizeDBSecurityGroupIngress( args: AuthorizeDBSecurityGroupIngressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AuthorizeDBSecurityGroupIngressCommandOutput) => void ): void; - public authorizeDBSecurityGroupIngress( - args: AuthorizeDBSecurityGroupIngressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AuthorizeDBSecurityGroupIngressCommandOutput) => void), - cb?: (err: any, data?: AuthorizeDBSecurityGroupIngressCommandOutput) => void - ): Promise | void { - const command = new AuthorizeDBSecurityGroupIngressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

- *

For more information on backtracking, see - * - * Backtracking an Aurora DB Cluster in the - * Amazon Aurora User Guide.

- * - *

This action applies only to Aurora MySQL DB clusters.

- *
- */ - public backtrackDBCluster( + + /** + * @see {@link BacktrackDBClusterCommand} + */ + backtrackDBCluster( args: BacktrackDBClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public backtrackDBCluster( + backtrackDBCluster( args: BacktrackDBClusterCommandInput, cb: (err: any, data?: BacktrackDBClusterCommandOutput) => void ): void; - public backtrackDBCluster( + backtrackDBCluster( args: BacktrackDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BacktrackDBClusterCommandOutput) => void ): void; - public backtrackDBCluster( - args: BacktrackDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BacktrackDBClusterCommandOutput) => void), - cb?: (err: any, data?: BacktrackDBClusterCommandOutput) => void - ): Promise | void { - const command = new BacktrackDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. - * Any data that has already been written to the S3 bucket isn't removed.

- */ - public cancelExportTask( + + /** + * @see {@link CancelExportTaskCommand} + */ + cancelExportTask( args: CancelExportTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelExportTask( + cancelExportTask( args: CancelExportTaskCommandInput, cb: (err: any, data?: CancelExportTaskCommandOutput) => void ): void; - public cancelExportTask( + cancelExportTask( args: CancelExportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelExportTaskCommandOutput) => void ): void; - public cancelExportTask( - args: CancelExportTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelExportTaskCommandOutput) => void), - cb?: (err: any, data?: CancelExportTaskCommandOutput) => void - ): Promise | void { - const command = new CancelExportTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Copies the specified DB cluster parameter group.

- */ - public copyDBClusterParameterGroup( + + /** + * @see {@link CopyDBClusterParameterGroupCommand} + */ + copyDBClusterParameterGroup( args: CopyDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public copyDBClusterParameterGroup( + copyDBClusterParameterGroup( args: CopyDBClusterParameterGroupCommandInput, cb: (err: any, data?: CopyDBClusterParameterGroupCommandOutput) => void ): void; - public copyDBClusterParameterGroup( + copyDBClusterParameterGroup( args: CopyDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyDBClusterParameterGroupCommandOutput) => void ): void; - public copyDBClusterParameterGroup( - args: CopyDBClusterParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopyDBClusterParameterGroupCommandOutput) => void), - cb?: (err: any, data?: CopyDBClusterParameterGroupCommandOutput) => void - ): Promise | void { - const command = new CopyDBClusterParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Copies a snapshot of a DB cluster.

- *

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier - * must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

- *

You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, - * the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the - * destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy - * an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the - * following values:

- *
    - *
  • - *

    - * KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to - * encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.

    - *
  • - *
  • - *

    - * TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.

    - *
  • - *
  • - *

    - * SourceDBClusterSnapshotIdentifier - The DB cluster snapshot - * identifier for the encrypted DB cluster snapshot to be copied. This identifier - * must be in the ARN format for the source Amazon Web Services Region and is the same value as - * the SourceDBClusterSnapshotIdentifier in the presigned URL.

    - *
  • - *
- *

To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified - * by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status.

- *

For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see - * - * Copying a Snapshot in the Amazon Aurora User Guide.

- *

For more information on Amazon Aurora DB clusters, see - * - * What is Amazon Aurora? in the Amazon Aurora User Guide.

- *

For more information on Multi-AZ DB clusters, see Multi-AZ DB - * cluster deployments in the Amazon RDS User - * Guide.

- */ - public copyDBClusterSnapshot( + + /** + * @see {@link CopyDBClusterSnapshotCommand} + */ + copyDBClusterSnapshot( args: CopyDBClusterSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public copyDBClusterSnapshot( + copyDBClusterSnapshot( args: CopyDBClusterSnapshotCommandInput, cb: (err: any, data?: CopyDBClusterSnapshotCommandOutput) => void ): void; - public copyDBClusterSnapshot( + copyDBClusterSnapshot( args: CopyDBClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyDBClusterSnapshotCommandOutput) => void ): void; - public copyDBClusterSnapshot( - args: CopyDBClusterSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopyDBClusterSnapshotCommandOutput) => void), - cb?: (err: any, data?: CopyDBClusterSnapshotCommandOutput) => void - ): Promise | void { - const command = new CopyDBClusterSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Copies the specified DB parameter group.

- */ - public copyDBParameterGroup( + + /** + * @see {@link CopyDBParameterGroupCommand} + */ + copyDBParameterGroup( args: CopyDBParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public copyDBParameterGroup( + copyDBParameterGroup( args: CopyDBParameterGroupCommandInput, cb: (err: any, data?: CopyDBParameterGroupCommandOutput) => void ): void; - public copyDBParameterGroup( + copyDBParameterGroup( args: CopyDBParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyDBParameterGroupCommandOutput) => void ): void; - public copyDBParameterGroup( - args: CopyDBParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopyDBParameterGroupCommandOutput) => void), - cb?: (err: any, data?: CopyDBParameterGroupCommandOutput) => void - ): Promise | void { - const command = new CopyDBParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Copies the specified DB snapshot. The source DB snapshot must be in the available state.

- *

You can copy a snapshot from one Amazon Web Services Region to another. In that case, the - * Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination - * Amazon Web Services Region for the DB snapshot copy.

- *

This command doesn't apply to RDS Custom.

- *

For more information about copying snapshots, see - * Copying a DB Snapshot in the Amazon RDS User Guide.

- */ - public copyDBSnapshot( + + /** + * @see {@link CopyDBSnapshotCommand} + */ + copyDBSnapshot( args: CopyDBSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public copyDBSnapshot( - args: CopyDBSnapshotCommandInput, - cb: (err: any, data?: CopyDBSnapshotCommandOutput) => void - ): void; - public copyDBSnapshot( + copyDBSnapshot(args: CopyDBSnapshotCommandInput, cb: (err: any, data?: CopyDBSnapshotCommandOutput) => void): void; + copyDBSnapshot( args: CopyDBSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyDBSnapshotCommandOutput) => void ): void; - public copyDBSnapshot( - args: CopyDBSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopyDBSnapshotCommandOutput) => void), - cb?: (err: any, data?: CopyDBSnapshotCommandOutput) => void - ): Promise | void { - const command = new CopyDBSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Copies the specified option group.

- */ - public copyOptionGroup( + + /** + * @see {@link CopyOptionGroupCommand} + */ + copyOptionGroup( args: CopyOptionGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public copyOptionGroup( - args: CopyOptionGroupCommandInput, - cb: (err: any, data?: CopyOptionGroupCommandOutput) => void - ): void; - public copyOptionGroup( + copyOptionGroup(args: CopyOptionGroupCommandInput, cb: (err: any, data?: CopyOptionGroupCommandOutput) => void): void; + copyOptionGroup( args: CopyOptionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyOptionGroupCommandOutput) => void ): void; - public copyOptionGroup( - args: CopyOptionGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopyOptionGroupCommandOutput) => void), - cb?: (err: any, data?: CopyOptionGroupCommandOutput) => void - ): Promise | void { - const command = new CopyOptionGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a blue/green deployment.

- *

A blue/green deployment creates a staging environment that copies the production environment. - * In a blue/green deployment, the blue environment is the current production environment. - * The green environment is the staging environment. The staging environment stays in sync - * with the current production environment using logical replication.

- *

You can make changes to the databases in the green environment without affecting - * production workloads. For example, you can upgrade the major or minor DB engine version, change - * database parameters, or make schema changes in the staging environment. You can thoroughly test - * changes in the green environment. When ready, you can switch over the environments to promote the - * green environment to be the new production environment. The switchover typically takes under a minute.

- *

For more information, see Using Amazon RDS Blue/Green Deployments - * for database updates in the Amazon RDS User Guide and - * - * Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora - * User Guide.

- */ - public createBlueGreenDeployment( + + /** + * @see {@link CreateBlueGreenDeploymentCommand} + */ + createBlueGreenDeployment( args: CreateBlueGreenDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBlueGreenDeployment( + createBlueGreenDeployment( args: CreateBlueGreenDeploymentCommandInput, cb: (err: any, data?: CreateBlueGreenDeploymentCommandOutput) => void ): void; - public createBlueGreenDeployment( + createBlueGreenDeployment( args: CreateBlueGreenDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBlueGreenDeploymentCommandOutput) => void ): void; - public createBlueGreenDeployment( - args: CreateBlueGreenDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBlueGreenDeploymentCommandOutput) => void), - cb?: (err: any, data?: CreateBlueGreenDeploymentCommandOutput) => void - ): Promise | void { - const command = new CreateBlueGreenDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a custom DB engine version (CEV).

- */ - public createCustomDBEngineVersion( + + /** + * @see {@link CreateCustomDBEngineVersionCommand} + */ + createCustomDBEngineVersion( args: CreateCustomDBEngineVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCustomDBEngineVersion( + createCustomDBEngineVersion( args: CreateCustomDBEngineVersionCommandInput, cb: (err: any, data?: CreateCustomDBEngineVersionCommandOutput) => void ): void; - public createCustomDBEngineVersion( + createCustomDBEngineVersion( args: CreateCustomDBEngineVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomDBEngineVersionCommandOutput) => void ): void; - public createCustomDBEngineVersion( - args: CreateCustomDBEngineVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCustomDBEngineVersionCommandOutput) => void), - cb?: (err: any, data?: CreateCustomDBEngineVersionCommandOutput) => void - ): Promise | void { - const command = new CreateCustomDBEngineVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.

- *

If you create an Aurora DB cluster, the request creates an empty cluster. You must - * explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the - * request creates a writer and two reader DB instances for you, each in a different - * Availability Zone.

- *

You can use the ReplicationSourceIdentifier parameter to create an Amazon - * Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or - * PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User - * Guide.

- *

You can also use the ReplicationSourceIdentifier parameter to create a - * Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the - * source. For more information about Multi-AZ DB clusters, see Multi-AZ DB - * cluster deployments in the Amazon RDS User - * Guide.

- */ - public createDBCluster( + + /** + * @see {@link CreateDBClusterCommand} + */ + createDBCluster( args: CreateDBClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDBCluster( - args: CreateDBClusterCommandInput, - cb: (err: any, data?: CreateDBClusterCommandOutput) => void - ): void; - public createDBCluster( + createDBCluster(args: CreateDBClusterCommandInput, cb: (err: any, data?: CreateDBClusterCommandOutput) => void): void; + createDBCluster( args: CreateDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBClusterCommandOutput) => void ): void; - public createDBCluster( - args: CreateDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBClusterCommandOutput) => void), - cb?: (err: any, data?: CreateDBClusterCommandOutput) => void - ): Promise | void { - const command = new CreateDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

- * - *

This action applies only to Aurora DB clusters.

- *
- */ - public createDBClusterEndpoint( + + /** + * @see {@link CreateDBClusterEndpointCommand} + */ + createDBClusterEndpoint( args: CreateDBClusterEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDBClusterEndpoint( + createDBClusterEndpoint( args: CreateDBClusterEndpointCommandInput, cb: (err: any, data?: CreateDBClusterEndpointCommandOutput) => void ): void; - public createDBClusterEndpoint( + createDBClusterEndpoint( args: CreateDBClusterEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBClusterEndpointCommandOutput) => void ): void; - public createDBClusterEndpoint( - args: CreateDBClusterEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBClusterEndpointCommandOutput) => void), - cb?: (err: any, data?: CreateDBClusterEndpointCommandOutput) => void - ): Promise | void { - const command = new CreateDBClusterEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new DB cluster parameter group.

- *

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

- *

A DB cluster parameter group is initially created with the default parameters for the - * database engine used by instances in the DB cluster. To provide custom values for any of the - * parameters, you must modify the group after creating it using - * ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to - * associate it with your DB cluster using ModifyDBCluster.

- *

When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB - * instances in the DB cluster without failover for the new DB cluster parameter group and - * associated settings to take effect.

- *

When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB - * cluster without failover for the new DB cluster parameter group and associated settings to take effect.

- * - *

After you create a DB cluster parameter group, you should wait at least 5 minutes - * before creating your first DB cluster that uses that DB cluster parameter group as - * the default parameter group. This allows Amazon RDS to fully complete the create - * action before the DB cluster parameter group is used as the default for a new DB - * cluster. This is especially important for parameters that are critical when creating - * the default database for a DB cluster, such as the character set for the default - * database defined by the character_set_database parameter. You can use - * the Parameter Groups option of the Amazon RDS console or the - * DescribeDBClusterParameters operation to verify that your DB - * cluster parameter group has been created or modified.

- *
- *

For more information on Amazon Aurora, see - * - * What is Amazon Aurora? in the Amazon Aurora User Guide.

- *

For more information on Multi-AZ DB clusters, see Multi-AZ DB - * cluster deployments in the Amazon RDS User - * Guide.

- */ - public createDBClusterParameterGroup( + + /** + * @see {@link CreateDBClusterParameterGroupCommand} + */ + createDBClusterParameterGroup( args: CreateDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDBClusterParameterGroup( + createDBClusterParameterGroup( args: CreateDBClusterParameterGroupCommandInput, cb: (err: any, data?: CreateDBClusterParameterGroupCommandOutput) => void ): void; - public createDBClusterParameterGroup( + createDBClusterParameterGroup( args: CreateDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBClusterParameterGroupCommandOutput) => void ): void; - public createDBClusterParameterGroup( - args: CreateDBClusterParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBClusterParameterGroupCommandOutput) => void), - cb?: (err: any, data?: CreateDBClusterParameterGroupCommandOutput) => void - ): Promise | void { - const command = new CreateDBClusterParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a snapshot of a DB cluster.

- *

For more information on Amazon Aurora, see What is Amazon - * Aurora? in the Amazon Aurora User Guide.

- *

For more information on Multi-AZ DB clusters, see Multi-AZ DB - * cluster deployments in the Amazon RDS User - * Guide.

- */ - public createDBClusterSnapshot( + + /** + * @see {@link CreateDBClusterSnapshotCommand} + */ + createDBClusterSnapshot( args: CreateDBClusterSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDBClusterSnapshot( + createDBClusterSnapshot( args: CreateDBClusterSnapshotCommandInput, cb: (err: any, data?: CreateDBClusterSnapshotCommandOutput) => void ): void; - public createDBClusterSnapshot( + createDBClusterSnapshot( args: CreateDBClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBClusterSnapshotCommandOutput) => void ): void; - public createDBClusterSnapshot( - args: CreateDBClusterSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBClusterSnapshotCommandOutput) => void), - cb?: (err: any, data?: CreateDBClusterSnapshotCommandOutput) => void - ): Promise | void { - const command = new CreateDBClusterSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new DB instance.

- *

The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. - * For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance - * to the cluster.

- *

For more information about creating an RDS DB instance, see - * Creating an Amazon RDS DB instance in the Amazon RDS User Guide.

- *

For more information about creating a DB instance in an Aurora DB cluster, see - * - * Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.

- */ - public createDBInstance( + + /** + * @see {@link CreateDBInstanceCommand} + */ + createDBInstance( args: CreateDBInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDBInstance( + createDBInstance( args: CreateDBInstanceCommandInput, cb: (err: any, data?: CreateDBInstanceCommandOutput) => void ): void; - public createDBInstance( + createDBInstance( args: CreateDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBInstanceCommandOutput) => void ): void; - public createDBInstance( - args: CreateDBInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBInstanceCommandOutput) => void), - cb?: (err: any, data?: CreateDBInstanceCommandOutput) => void - ): Promise | void { - const command = new CreateDBInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new DB instance that acts as a read replica for an existing source DB - * instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running - * MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a - * Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working - * with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.

- *

Amazon Aurora doesn't support this operation. Call the CreateDBInstance - * operation to create a DB instance for an Aurora DB cluster.

- *

All read replica DB instances are created with backups disabled. All other attributes - * (including DB security groups and DB parameter groups) are inherited from the source DB - * instance or cluster, except as specified.

- * - *

Your source DB instance or cluster must have backup retention enabled.

- *
- */ - public createDBInstanceReadReplica( + + /** + * @see {@link CreateDBInstanceReadReplicaCommand} + */ + createDBInstanceReadReplica( args: CreateDBInstanceReadReplicaCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDBInstanceReadReplica( + createDBInstanceReadReplica( args: CreateDBInstanceReadReplicaCommandInput, cb: (err: any, data?: CreateDBInstanceReadReplicaCommandOutput) => void ): void; - public createDBInstanceReadReplica( + createDBInstanceReadReplica( args: CreateDBInstanceReadReplicaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBInstanceReadReplicaCommandOutput) => void ): void; - public createDBInstanceReadReplica( - args: CreateDBInstanceReadReplicaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBInstanceReadReplicaCommandOutput) => void), - cb?: (err: any, data?: CreateDBInstanceReadReplicaCommandOutput) => void - ): Promise | void { - const command = new CreateDBInstanceReadReplicaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new DB parameter group.

- *

A DB parameter group is initially created with the default parameters for the - * database engine used by the DB instance. To provide custom values for any of the - * parameters, you must modify the group after creating it using - * ModifyDBParameterGroup. Once you've created a DB parameter group, you need to - * associate it with your DB instance using ModifyDBInstance. When you associate - * a new DB parameter group with a running DB instance, you need to reboot the DB - * instance without failover for the new DB parameter group and associated settings to take effect.

- *

This command doesn't apply to RDS Custom.

- * - *

After you create a DB parameter group, you should wait at least 5 minutes - * before creating your first DB instance that uses that DB parameter group as the default parameter - * group. This allows Amazon RDS to fully complete the create action before the parameter - * group is used as the default for a new DB instance. This is especially important for parameters - * that are critical when creating the default database for a DB instance, such as the character set - * for the default database defined by the character_set_database parameter. You can use the - * Parameter Groups option of the Amazon RDS console or the - * DescribeDBParameters command to verify - * that your DB parameter group has been created or modified.

- *
- */ - public createDBParameterGroup( + + /** + * @see {@link CreateDBParameterGroupCommand} + */ + createDBParameterGroup( args: CreateDBParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDBParameterGroup( + createDBParameterGroup( args: CreateDBParameterGroupCommandInput, cb: (err: any, data?: CreateDBParameterGroupCommandOutput) => void ): void; - public createDBParameterGroup( + createDBParameterGroup( args: CreateDBParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBParameterGroupCommandOutput) => void ): void; - public createDBParameterGroup( - args: CreateDBParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBParameterGroupCommandOutput) => void), - cb?: (err: any, data?: CreateDBParameterGroupCommandOutput) => void - ): Promise | void { - const command = new CreateDBParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new DB proxy.

- */ - public createDBProxy( - args: CreateDBProxyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createDBProxy( - args: CreateDBProxyCommandInput, - cb: (err: any, data?: CreateDBProxyCommandOutput) => void - ): void; - public createDBProxy( + + /** + * @see {@link CreateDBProxyCommand} + */ + createDBProxy(args: CreateDBProxyCommandInput, options?: __HttpHandlerOptions): Promise; + createDBProxy(args: CreateDBProxyCommandInput, cb: (err: any, data?: CreateDBProxyCommandOutput) => void): void; + createDBProxy( args: CreateDBProxyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBProxyCommandOutput) => void ): void; - public createDBProxy( - args: CreateDBProxyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBProxyCommandOutput) => void), - cb?: (err: any, data?: CreateDBProxyCommandOutput) => void - ): Promise | void { - const command = new CreateDBProxyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters. - * You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use - * DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.

- */ - public createDBProxyEndpoint( + + /** + * @see {@link CreateDBProxyEndpointCommand} + */ + createDBProxyEndpoint( args: CreateDBProxyEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDBProxyEndpoint( + createDBProxyEndpoint( args: CreateDBProxyEndpointCommandInput, cb: (err: any, data?: CreateDBProxyEndpointCommandOutput) => void ): void; - public createDBProxyEndpoint( + createDBProxyEndpoint( args: CreateDBProxyEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBProxyEndpointCommandOutput) => void ): void; - public createDBProxyEndpoint( - args: CreateDBProxyEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBProxyEndpointCommandOutput) => void), - cb?: (err: any, data?: CreateDBProxyEndpointCommandOutput) => void - ): Promise | void { - const command = new CreateDBProxyEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new DB security group. DB security groups control access to a DB instance.

- *

A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

- * - *

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that - * you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the - * Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – - * Here’s How to Prepare, and Moving a DB instance not in a VPC - * into a VPC in the Amazon RDS User Guide.

- *
- */ - public createDBSecurityGroup( + + /** + * @see {@link CreateDBSecurityGroupCommand} + */ + createDBSecurityGroup( args: CreateDBSecurityGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDBSecurityGroup( + createDBSecurityGroup( args: CreateDBSecurityGroupCommandInput, cb: (err: any, data?: CreateDBSecurityGroupCommandOutput) => void ): void; - public createDBSecurityGroup( + createDBSecurityGroup( args: CreateDBSecurityGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBSecurityGroupCommandOutput) => void ): void; - public createDBSecurityGroup( - args: CreateDBSecurityGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBSecurityGroupCommandOutput) => void), - cb?: (err: any, data?: CreateDBSecurityGroupCommandOutput) => void - ): Promise | void { - const command = new CreateDBSecurityGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a snapshot of a DB instance. The source DB instance must be in the available or - * storage-optimization state.

- */ - public createDBSnapshot( + + /** + * @see {@link CreateDBSnapshotCommand} + */ + createDBSnapshot( args: CreateDBSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDBSnapshot( + createDBSnapshot( args: CreateDBSnapshotCommandInput, cb: (err: any, data?: CreateDBSnapshotCommandOutput) => void ): void; - public createDBSnapshot( + createDBSnapshot( args: CreateDBSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBSnapshotCommandOutput) => void ): void; - public createDBSnapshot( - args: CreateDBSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBSnapshotCommandOutput) => void), - cb?: (err: any, data?: CreateDBSnapshotCommandOutput) => void - ): Promise | void { - const command = new CreateDBSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

- */ - public createDBSubnetGroup( + + /** + * @see {@link CreateDBSubnetGroupCommand} + */ + createDBSubnetGroup( args: CreateDBSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDBSubnetGroup( + createDBSubnetGroup( args: CreateDBSubnetGroupCommandInput, cb: (err: any, data?: CreateDBSubnetGroupCommandOutput) => void ): void; - public createDBSubnetGroup( + createDBSubnetGroup( args: CreateDBSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBSubnetGroupCommandOutput) => void ): void; - public createDBSubnetGroup( - args: CreateDBSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDBSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: CreateDBSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new CreateDBSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an RDS event notification subscription. This operation requires a topic Amazon - * Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API. - * To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the - * topic. The ARN is displayed in the SNS console.

- *

You can specify the type of source (SourceType) that you want to be - * notified of and provide a list of RDS sources (SourceIds) that triggers the - * events. You can also provide a list of event categories (EventCategories) - * for events that you want to be notified of. For example, you can specify - * SourceType = db-instance, SourceIds = - * mydbinstance1, mydbinstance2 and - * EventCategories = Availability, - * Backup.

- *

If you specify both the SourceType and SourceIds, such as SourceType = db-instance - * and SourceIds = myDBInstance1, you are notified of all the db-instance events for - * the specified source. If you specify a SourceType but do not specify SourceIds, - * you receive notice of the events for that source type for all your RDS sources. If you - * don't specify either the SourceType or the SourceIds, you are notified of events - * generated from all RDS sources belonging to your customer account.

- *

For more information about subscribing to an event for RDS DB engines, see - * - * Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.

- *

For more information about subscribing to an event for Aurora DB engines, see - * - * Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.

- */ - public createEventSubscription( + + /** + * @see {@link CreateEventSubscriptionCommand} + */ + createEventSubscription( args: CreateEventSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEventSubscription( + createEventSubscription( args: CreateEventSubscriptionCommandInput, cb: (err: any, data?: CreateEventSubscriptionCommandOutput) => void ): void; - public createEventSubscription( + createEventSubscription( args: CreateEventSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEventSubscriptionCommandOutput) => void ): void; - public createEventSubscription( - args: CreateEventSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEventSubscriptionCommandOutput) => void), - cb?: (err: any, data?: CreateEventSubscriptionCommandOutput) => void - ): Promise | void { - const command = new CreateEventSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Aurora global database - * spread across multiple Amazon Web Services Regions. The global database - * contains a single primary cluster with read-write capability, - * and a read-only secondary cluster that receives - * data from the primary cluster through high-speed replication - * performed by the Aurora storage subsystem.

- *

You can create a global database that is initially empty, and then - * add a primary cluster and a secondary cluster to it. - * Or you can specify an existing Aurora cluster during the create operation, - * and this cluster becomes the primary cluster of the global database.

- * - *

This action applies only to Aurora DB clusters.

- *
- */ - public createGlobalCluster( + + /** + * @see {@link CreateGlobalClusterCommand} + */ + createGlobalCluster( args: CreateGlobalClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public createGlobalCluster( + createGlobalCluster( args: CreateGlobalClusterCommandInput, cb: (err: any, data?: CreateGlobalClusterCommandOutput) => void ): void; - public createGlobalCluster( + createGlobalCluster( args: CreateGlobalClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGlobalClusterCommandOutput) => void ): void; - public createGlobalCluster( - args: CreateGlobalClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGlobalClusterCommandOutput) => void), - cb?: (err: any, data?: CreateGlobalClusterCommandOutput) => void - ): Promise | void { - const command = new CreateGlobalClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new option group. You can create up to 20 option groups.

- *

This command doesn't apply to RDS Custom.

- */ - public createOptionGroup( + + /** + * @see {@link CreateOptionGroupCommand} + */ + createOptionGroup( args: CreateOptionGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createOptionGroup( + createOptionGroup( args: CreateOptionGroupCommandInput, cb: (err: any, data?: CreateOptionGroupCommandOutput) => void ): void; - public createOptionGroup( + createOptionGroup( args: CreateOptionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateOptionGroupCommandOutput) => void ): void; - public createOptionGroup( - args: CreateOptionGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateOptionGroupCommandOutput) => void), - cb?: (err: any, data?: CreateOptionGroupCommandOutput) => void - ): Promise | void { - const command = new CreateOptionGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a blue/green deployment.

- *

For more information, see Using Amazon RDS Blue/Green Deployments - * for database updates in the Amazon RDS User Guide and - * - * Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora - * User Guide.

- */ - public deleteBlueGreenDeployment( + + /** + * @see {@link DeleteBlueGreenDeploymentCommand} + */ + deleteBlueGreenDeployment( args: DeleteBlueGreenDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBlueGreenDeployment( + deleteBlueGreenDeployment( args: DeleteBlueGreenDeploymentCommandInput, cb: (err: any, data?: DeleteBlueGreenDeploymentCommandOutput) => void ): void; - public deleteBlueGreenDeployment( + deleteBlueGreenDeployment( args: DeleteBlueGreenDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBlueGreenDeploymentCommandOutput) => void ): void; - public deleteBlueGreenDeployment( - args: DeleteBlueGreenDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBlueGreenDeploymentCommandOutput) => void), - cb?: (err: any, data?: DeleteBlueGreenDeploymentCommandOutput) => void - ): Promise | void { - const command = new DeleteBlueGreenDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:

- *
    - *
  • - *

    The CEV must not be the default for RDS Custom. If it is, change the default - * before running this command.

    - *
  • - *
  • - *

    The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, - * or automated backup of your RDS Custom instance.

    - *
  • - *
- *

Typically, deletion takes a few minutes.

- * - *

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with - * Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the - * DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the - * API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for - * the DeleteCustomDbEngineVersion event.

- *
- *

For more information, see Deleting a - * CEV in the Amazon RDS User Guide.

- */ - public deleteCustomDBEngineVersion( + + /** + * @see {@link DeleteCustomDBEngineVersionCommand} + */ + deleteCustomDBEngineVersion( args: DeleteCustomDBEngineVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCustomDBEngineVersion( + deleteCustomDBEngineVersion( args: DeleteCustomDBEngineVersionCommandInput, cb: (err: any, data?: DeleteCustomDBEngineVersionCommandOutput) => void ): void; - public deleteCustomDBEngineVersion( + deleteCustomDBEngineVersion( args: DeleteCustomDBEngineVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomDBEngineVersionCommandOutput) => void ): void; - public deleteCustomDBEngineVersion( - args: DeleteCustomDBEngineVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCustomDBEngineVersionCommandOutput) => void), - cb?: (err: any, data?: DeleteCustomDBEngineVersionCommandOutput) => void - ): Promise | void { - const command = new DeleteCustomDBEngineVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

The DeleteDBCluster action deletes a previously provisioned DB cluster. - * When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. - * Manual DB cluster snapshots of the specified DB cluster are not deleted.

- *

If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are - * terminated and read replicas are promoted to standalone instances.

- *

For more information on Amazon Aurora, see - * - * What is Amazon Aurora? in the Amazon Aurora User Guide.

- *

For more information on Multi-AZ DB clusters, see Multi-AZ DB - * cluster deployments in the Amazon RDS User - * Guide.

- */ - public deleteDBCluster( + + /** + * @see {@link DeleteDBClusterCommand} + */ + deleteDBCluster( args: DeleteDBClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDBCluster( - args: DeleteDBClusterCommandInput, - cb: (err: any, data?: DeleteDBClusterCommandOutput) => void - ): void; - public deleteDBCluster( + deleteDBCluster(args: DeleteDBClusterCommandInput, cb: (err: any, data?: DeleteDBClusterCommandOutput) => void): void; + deleteDBCluster( args: DeleteDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBClusterCommandOutput) => void ): void; - public deleteDBCluster( - args: DeleteDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBClusterCommandOutput) => void), - cb?: (err: any, data?: DeleteDBClusterCommandOutput) => void - ): Promise | void { - const command = new DeleteDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

- * - *

This action only applies to Aurora DB clusters.

- *
- */ - public deleteDBClusterEndpoint( + + /** + * @see {@link DeleteDBClusterEndpointCommand} + */ + deleteDBClusterEndpoint( args: DeleteDBClusterEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDBClusterEndpoint( + deleteDBClusterEndpoint( args: DeleteDBClusterEndpointCommandInput, cb: (err: any, data?: DeleteDBClusterEndpointCommandOutput) => void ): void; - public deleteDBClusterEndpoint( + deleteDBClusterEndpoint( args: DeleteDBClusterEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBClusterEndpointCommandOutput) => void ): void; - public deleteDBClusterEndpoint( - args: DeleteDBClusterEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBClusterEndpointCommandOutput) => void), - cb?: (err: any, data?: DeleteDBClusterEndpointCommandOutput) => void - ): Promise | void { - const command = new DeleteDBClusterEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

- *

For more information on Amazon Aurora, see - * - * What is Amazon Aurora? in the Amazon Aurora User Guide.

- *

For more information on Multi-AZ DB clusters, see Multi-AZ DB - * cluster deployments in the Amazon RDS User - * Guide.

- */ - public deleteDBClusterParameterGroup( + + /** + * @see {@link DeleteDBClusterParameterGroupCommand} + */ + deleteDBClusterParameterGroup( args: DeleteDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDBClusterParameterGroup( + deleteDBClusterParameterGroup( args: DeleteDBClusterParameterGroupCommandInput, cb: (err: any, data?: DeleteDBClusterParameterGroupCommandOutput) => void ): void; - public deleteDBClusterParameterGroup( + deleteDBClusterParameterGroup( args: DeleteDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBClusterParameterGroupCommandOutput) => void ): void; - public deleteDBClusterParameterGroup( - args: DeleteDBClusterParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBClusterParameterGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteDBClusterParameterGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteDBClusterParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

- * - *

The DB cluster snapshot must be in the available state to be - * deleted.

- *
- *

For more information on Amazon Aurora, see - * - * What is Amazon Aurora? in the Amazon Aurora User Guide.

- *

For more information on Multi-AZ DB clusters, see Multi-AZ DB - * cluster deployments in the Amazon RDS User - * Guide.

- */ - public deleteDBClusterSnapshot( + + /** + * @see {@link DeleteDBClusterSnapshotCommand} + */ + deleteDBClusterSnapshot( args: DeleteDBClusterSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDBClusterSnapshot( + deleteDBClusterSnapshot( args: DeleteDBClusterSnapshotCommandInput, cb: (err: any, data?: DeleteDBClusterSnapshotCommandOutput) => void ): void; - public deleteDBClusterSnapshot( + deleteDBClusterSnapshot( args: DeleteDBClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBClusterSnapshotCommandOutput) => void ): void; - public deleteDBClusterSnapshot( - args: DeleteDBClusterSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBClusterSnapshotCommandOutput) => void), - cb?: (err: any, data?: DeleteDBClusterSnapshotCommandOutput) => void - ): Promise | void { - const command = new DeleteDBClusterSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

The DeleteDBInstance action deletes a previously provisioned DB instance. - * When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. - * Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

- *

If you request a final DB snapshot - * the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance - * is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

- *

When a DB instance is in a failure state and has a status of failed, incompatible-restore, - * or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.

- *

If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following - * conditions are true:

- *
    - *
  • - *

    The DB cluster is a read replica of another Amazon Aurora DB cluster.

    - *
  • - *
  • - *

    The DB instance is the only instance in the DB cluster.

    - *
  • - *
- *

To delete a DB instance in this case, first call the - * PromoteReadReplicaDBCluster API action to promote the DB cluster so - * it's no longer a read replica. After the promotion completes, then call the - * DeleteDBInstance API action to delete the final instance in the DB - * cluster.

- */ - public deleteDBInstance( + + /** + * @see {@link DeleteDBInstanceCommand} + */ + deleteDBInstance( args: DeleteDBInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDBInstance( + deleteDBInstance( args: DeleteDBInstanceCommandInput, cb: (err: any, data?: DeleteDBInstanceCommandOutput) => void ): void; - public deleteDBInstance( + deleteDBInstance( args: DeleteDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBInstanceCommandOutput) => void ): void; - public deleteDBInstance( - args: DeleteDBInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBInstanceCommandOutput) => void), - cb?: (err: any, data?: DeleteDBInstanceCommandOutput) => void - ): Promise | void { - const command = new DeleteDBInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.

- */ - public deleteDBInstanceAutomatedBackup( + + /** + * @see {@link DeleteDBInstanceAutomatedBackupCommand} + */ + deleteDBInstanceAutomatedBackup( args: DeleteDBInstanceAutomatedBackupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDBInstanceAutomatedBackup( + deleteDBInstanceAutomatedBackup( args: DeleteDBInstanceAutomatedBackupCommandInput, cb: (err: any, data?: DeleteDBInstanceAutomatedBackupCommandOutput) => void ): void; - public deleteDBInstanceAutomatedBackup( + deleteDBInstanceAutomatedBackup( args: DeleteDBInstanceAutomatedBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBInstanceAutomatedBackupCommandOutput) => void ): void; - public deleteDBInstanceAutomatedBackup( - args: DeleteDBInstanceAutomatedBackupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBInstanceAutomatedBackupCommandOutput) => void), - cb?: (err: any, data?: DeleteDBInstanceAutomatedBackupCommandOutput) => void - ): Promise | void { - const command = new DeleteDBInstanceAutomatedBackupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.

- */ - public deleteDBParameterGroup( + + /** + * @see {@link DeleteDBParameterGroupCommand} + */ + deleteDBParameterGroup( args: DeleteDBParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDBParameterGroup( + deleteDBParameterGroup( args: DeleteDBParameterGroupCommandInput, cb: (err: any, data?: DeleteDBParameterGroupCommandOutput) => void ): void; - public deleteDBParameterGroup( + deleteDBParameterGroup( args: DeleteDBParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBParameterGroupCommandOutput) => void ): void; - public deleteDBParameterGroup( - args: DeleteDBParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBParameterGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteDBParameterGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteDBParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an existing DB proxy.

- */ - public deleteDBProxy( - args: DeleteDBProxyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDBProxy( - args: DeleteDBProxyCommandInput, - cb: (err: any, data?: DeleteDBProxyCommandOutput) => void - ): void; - public deleteDBProxy( + + /** + * @see {@link DeleteDBProxyCommand} + */ + deleteDBProxy(args: DeleteDBProxyCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDBProxy(args: DeleteDBProxyCommandInput, cb: (err: any, data?: DeleteDBProxyCommandOutput) => void): void; + deleteDBProxy( args: DeleteDBProxyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBProxyCommandOutput) => void ): void; - public deleteDBProxy( - args: DeleteDBProxyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBProxyCommandOutput) => void), - cb?: (err: any, data?: DeleteDBProxyCommandOutput) => void - ): Promise | void { - const command = new DeleteDBProxyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy using the - * endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write - * or read-only operations, or using a different VPC than the DB proxy's default VPC.

- */ - public deleteDBProxyEndpoint( + + /** + * @see {@link DeleteDBProxyEndpointCommand} + */ + deleteDBProxyEndpoint( args: DeleteDBProxyEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDBProxyEndpoint( + deleteDBProxyEndpoint( args: DeleteDBProxyEndpointCommandInput, cb: (err: any, data?: DeleteDBProxyEndpointCommandOutput) => void ): void; - public deleteDBProxyEndpoint( + deleteDBProxyEndpoint( args: DeleteDBProxyEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBProxyEndpointCommandOutput) => void ): void; - public deleteDBProxyEndpoint( - args: DeleteDBProxyEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBProxyEndpointCommandOutput) => void), - cb?: (err: any, data?: DeleteDBProxyEndpointCommandOutput) => void - ): Promise | void { - const command = new DeleteDBProxyEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a DB security group.

- *

The specified DB security group must not be associated with any DB instances.

- * - *

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that - * you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the - * Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – - * Here’s How to Prepare, and Moving a DB instance not in a VPC - * into a VPC in the Amazon RDS User Guide.

- *
- */ - public deleteDBSecurityGroup( + + /** + * @see {@link DeleteDBSecurityGroupCommand} + */ + deleteDBSecurityGroup( args: DeleteDBSecurityGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDBSecurityGroup( + deleteDBSecurityGroup( args: DeleteDBSecurityGroupCommandInput, cb: (err: any, data?: DeleteDBSecurityGroupCommandOutput) => void ): void; - public deleteDBSecurityGroup( + deleteDBSecurityGroup( args: DeleteDBSecurityGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBSecurityGroupCommandOutput) => void ): void; - public deleteDBSecurityGroup( - args: DeleteDBSecurityGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBSecurityGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteDBSecurityGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteDBSecurityGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a DB snapshot. If the snapshot is being copied, the copy operation is - * terminated.

- * - *

The DB snapshot must be in the available state to be deleted.

- *
- */ - public deleteDBSnapshot( + + /** + * @see {@link DeleteDBSnapshotCommand} + */ + deleteDBSnapshot( args: DeleteDBSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDBSnapshot( + deleteDBSnapshot( args: DeleteDBSnapshotCommandInput, cb: (err: any, data?: DeleteDBSnapshotCommandOutput) => void ): void; - public deleteDBSnapshot( + deleteDBSnapshot( args: DeleteDBSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBSnapshotCommandOutput) => void ): void; - public deleteDBSnapshot( - args: DeleteDBSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBSnapshotCommandOutput) => void), - cb?: (err: any, data?: DeleteDBSnapshotCommandOutput) => void - ): Promise | void { - const command = new DeleteDBSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a DB subnet group.

- * - *

The specified database subnet group must not be associated with any DB instances.

- *
- */ - public deleteDBSubnetGroup( + + /** + * @see {@link DeleteDBSubnetGroupCommand} + */ + deleteDBSubnetGroup( args: DeleteDBSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDBSubnetGroup( + deleteDBSubnetGroup( args: DeleteDBSubnetGroupCommandInput, cb: (err: any, data?: DeleteDBSubnetGroupCommandOutput) => void ): void; - public deleteDBSubnetGroup( + deleteDBSubnetGroup( args: DeleteDBSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBSubnetGroupCommandOutput) => void ): void; - public deleteDBSubnetGroup( - args: DeleteDBSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDBSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteDBSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteDBSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an RDS event notification subscription.

- */ - public deleteEventSubscription( + + /** + * @see {@link DeleteEventSubscriptionCommand} + */ + deleteEventSubscription( args: DeleteEventSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEventSubscription( + deleteEventSubscription( args: DeleteEventSubscriptionCommandInput, cb: (err: any, data?: DeleteEventSubscriptionCommandOutput) => void ): void; - public deleteEventSubscription( + deleteEventSubscription( args: DeleteEventSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventSubscriptionCommandOutput) => void ): void; - public deleteEventSubscription( - args: DeleteEventSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEventSubscriptionCommandOutput) => void), - cb?: (err: any, data?: DeleteEventSubscriptionCommandOutput) => void - ): Promise | void { - const command = new DeleteEventSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a global database cluster. The primary and secondary clusters must already be detached or - * destroyed first.

- * - *

This action only applies to Aurora DB clusters.

- *
- */ - public deleteGlobalCluster( + + /** + * @see {@link DeleteGlobalClusterCommand} + */ + deleteGlobalCluster( args: DeleteGlobalClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteGlobalCluster( + deleteGlobalCluster( args: DeleteGlobalClusterCommandInput, cb: (err: any, data?: DeleteGlobalClusterCommandOutput) => void ): void; - public deleteGlobalCluster( + deleteGlobalCluster( args: DeleteGlobalClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGlobalClusterCommandOutput) => void ): void; - public deleteGlobalCluster( - args: DeleteGlobalClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGlobalClusterCommandOutput) => void), - cb?: (err: any, data?: DeleteGlobalClusterCommandOutput) => void - ): Promise | void { - const command = new DeleteGlobalClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an existing option group.

- */ - public deleteOptionGroup( + + /** + * @see {@link DeleteOptionGroupCommand} + */ + deleteOptionGroup( args: DeleteOptionGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteOptionGroup( + deleteOptionGroup( args: DeleteOptionGroupCommandInput, cb: (err: any, data?: DeleteOptionGroupCommandOutput) => void ): void; - public deleteOptionGroup( + deleteOptionGroup( args: DeleteOptionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOptionGroupCommandOutput) => void ): void; - public deleteOptionGroup( - args: DeleteOptionGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteOptionGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteOptionGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteOptionGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.

- */ - public deregisterDBProxyTargets( + + /** + * @see {@link DeregisterDBProxyTargetsCommand} + */ + deregisterDBProxyTargets( args: DeregisterDBProxyTargetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterDBProxyTargets( + deregisterDBProxyTargets( args: DeregisterDBProxyTargetsCommandInput, cb: (err: any, data?: DeregisterDBProxyTargetsCommandOutput) => void ): void; - public deregisterDBProxyTargets( + deregisterDBProxyTargets( args: DeregisterDBProxyTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterDBProxyTargetsCommandOutput) => void ): void; - public deregisterDBProxyTargets( - args: DeregisterDBProxyTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterDBProxyTargetsCommandOutput) => void), - cb?: (err: any, data?: DeregisterDBProxyTargetsCommandOutput) => void - ): Promise | void { - const command = new DeregisterDBProxyTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

- *

This command doesn't take any parameters.

- */ - public describeAccountAttributes( + + /** + * @see {@link DescribeAccountAttributesCommand} + */ + describeAccountAttributes( args: DescribeAccountAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccountAttributes( + describeAccountAttributes( args: DescribeAccountAttributesCommandInput, cb: (err: any, data?: DescribeAccountAttributesCommandOutput) => void ): void; - public describeAccountAttributes( + describeAccountAttributes( args: DescribeAccountAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountAttributesCommandOutput) => void ): void; - public describeAccountAttributes( - args: DescribeAccountAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccountAttributesCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountAttributesCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about blue/green deployments.

- *

For more information, see Using Amazon RDS Blue/Green Deployments - * for database updates in the Amazon RDS User Guide and - * - * Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora - * User Guide.

- */ - public describeBlueGreenDeployments( + + /** + * @see {@link DescribeBlueGreenDeploymentsCommand} + */ + describeBlueGreenDeployments( args: DescribeBlueGreenDeploymentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBlueGreenDeployments( + describeBlueGreenDeployments( args: DescribeBlueGreenDeploymentsCommandInput, cb: (err: any, data?: DescribeBlueGreenDeploymentsCommandOutput) => void ): void; - public describeBlueGreenDeployments( + describeBlueGreenDeployments( args: DescribeBlueGreenDeploymentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBlueGreenDeploymentsCommandOutput) => void ): void; - public describeBlueGreenDeployments( - args: DescribeBlueGreenDeploymentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBlueGreenDeploymentsCommandOutput) => void), - cb?: (err: any, data?: DescribeBlueGreenDeploymentsCommandOutput) => void - ): Promise | void { - const command = new DescribeBlueGreenDeploymentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.

- *

For more information, see Using SSL/TLS to encrypt a connection to a DB - * instance in the Amazon RDS User Guide and - * - * Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora - * User Guide.

- */ - public describeCertificates( + + /** + * @see {@link DescribeCertificatesCommand} + */ + describeCertificates( args: DescribeCertificatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCertificates( + describeCertificates( args: DescribeCertificatesCommandInput, cb: (err: any, data?: DescribeCertificatesCommandOutput) => void ): void; - public describeCertificates( + describeCertificates( args: DescribeCertificatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCertificatesCommandOutput) => void ): void; - public describeCertificates( - args: DescribeCertificatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCertificatesCommandOutput) => void), - cb?: (err: any, data?: DescribeCertificatesCommandOutput) => void - ): Promise | void { - const command = new DescribeCertificatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about backtracks for a DB cluster.

- *

For more information on Amazon Aurora, see - * - * What is Amazon Aurora? in the Amazon Aurora User Guide.

- * - *

This action only applies to Aurora MySQL DB clusters.

- *
- */ - public describeDBClusterBacktracks( + + /** + * @see {@link DescribeDBClusterBacktracksCommand} + */ + describeDBClusterBacktracks( args: DescribeDBClusterBacktracksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBClusterBacktracks( + describeDBClusterBacktracks( args: DescribeDBClusterBacktracksCommandInput, cb: (err: any, data?: DescribeDBClusterBacktracksCommandOutput) => void ): void; - public describeDBClusterBacktracks( + describeDBClusterBacktracks( args: DescribeDBClusterBacktracksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterBacktracksCommandOutput) => void ): void; - public describeDBClusterBacktracks( - args: DescribeDBClusterBacktracksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBClusterBacktracksCommandOutput) => void), - cb?: (err: any, data?: DescribeDBClusterBacktracksCommandOutput) => void - ): Promise | void { - const command = new DescribeDBClusterBacktracksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about endpoints for an Amazon Aurora DB cluster.

- * - *

This action only applies to Aurora DB clusters.

- *
- */ - public describeDBClusterEndpoints( + + /** + * @see {@link DescribeDBClusterEndpointsCommand} + */ + describeDBClusterEndpoints( args: DescribeDBClusterEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBClusterEndpoints( + describeDBClusterEndpoints( args: DescribeDBClusterEndpointsCommandInput, cb: (err: any, data?: DescribeDBClusterEndpointsCommandOutput) => void ): void; - public describeDBClusterEndpoints( + describeDBClusterEndpoints( args: DescribeDBClusterEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterEndpointsCommandOutput) => void ): void; - public describeDBClusterEndpoints( - args: DescribeDBClusterEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBClusterEndpointsCommandOutput) => void), - cb?: (err: any, data?: DescribeDBClusterEndpointsCommandOutput) => void - ): Promise | void { - const command = new DescribeDBClusterEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of DBClusterParameterGroup descriptions. If a - * DBClusterParameterGroupName parameter is specified, - * the list will contain only the description of the specified DB cluster parameter group.

- *

For more information on Amazon Aurora, see - * - * What is Amazon Aurora? in the Amazon Aurora User Guide.

- *

For more information on Multi-AZ DB clusters, see Multi-AZ DB - * cluster deployments in the Amazon RDS User - * Guide.

- */ - public describeDBClusterParameterGroups( + + /** + * @see {@link DescribeDBClusterParameterGroupsCommand} + */ + describeDBClusterParameterGroups( args: DescribeDBClusterParameterGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBClusterParameterGroups( + describeDBClusterParameterGroups( args: DescribeDBClusterParameterGroupsCommandInput, cb: (err: any, data?: DescribeDBClusterParameterGroupsCommandOutput) => void ): void; - public describeDBClusterParameterGroups( + describeDBClusterParameterGroups( args: DescribeDBClusterParameterGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterParameterGroupsCommandOutput) => void ): void; - public describeDBClusterParameterGroups( - args: DescribeDBClusterParameterGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBClusterParameterGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeDBClusterParameterGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeDBClusterParameterGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the detailed parameter list for a particular DB cluster parameter group.

- *

For more information on Amazon Aurora, see - * - * What is Amazon Aurora? in the Amazon Aurora User Guide.

- *

For more information on Multi-AZ DB clusters, see Multi-AZ DB - * cluster deployments in the Amazon RDS User - * Guide.

- */ - public describeDBClusterParameters( + + /** + * @see {@link DescribeDBClusterParametersCommand} + */ + describeDBClusterParameters( args: DescribeDBClusterParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBClusterParameters( + describeDBClusterParameters( args: DescribeDBClusterParametersCommandInput, cb: (err: any, data?: DescribeDBClusterParametersCommandOutput) => void ): void; - public describeDBClusterParameters( + describeDBClusterParameters( args: DescribeDBClusterParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterParametersCommandOutput) => void ): void; - public describeDBClusterParameters( - args: DescribeDBClusterParametersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBClusterParametersCommandOutput) => void), - cb?: (err: any, data?: DescribeDBClusterParametersCommandOutput) => void - ): Promise | void { - const command = new DescribeDBClusterParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

- *

For more information on Amazon Aurora DB clusters, see - * - * What is Amazon Aurora? in the Amazon Aurora User Guide.

- *

For more information on Multi-AZ DB clusters, see Multi-AZ DB - * cluster deployments in the Amazon RDS User - * Guide.

- *

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

- */ - public describeDBClusters( + + /** + * @see {@link DescribeDBClustersCommand} + */ + describeDBClusters( args: DescribeDBClustersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBClusters( + describeDBClusters( args: DescribeDBClustersCommandInput, cb: (err: any, data?: DescribeDBClustersCommandOutput) => void ): void; - public describeDBClusters( + describeDBClusters( args: DescribeDBClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClustersCommandOutput) => void ): void; - public describeDBClusters( - args: DescribeDBClustersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBClustersCommandOutput) => void), - cb?: (err: any, data?: DescribeDBClustersCommandOutput) => void - ): Promise | void { - const command = new DescribeDBClustersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

- *

When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes - * returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are - * authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of - * values for the restore attribute, then the manual DB cluster snapshot is public and - * can be copied or restored by all Amazon Web Services accounts.

- *

To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the - * manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

- */ - public describeDBClusterSnapshotAttributes( + + /** + * @see {@link DescribeDBClusterSnapshotAttributesCommand} + */ + describeDBClusterSnapshotAttributes( args: DescribeDBClusterSnapshotAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBClusterSnapshotAttributes( + describeDBClusterSnapshotAttributes( args: DescribeDBClusterSnapshotAttributesCommandInput, cb: (err: any, data?: DescribeDBClusterSnapshotAttributesCommandOutput) => void ): void; - public describeDBClusterSnapshotAttributes( + describeDBClusterSnapshotAttributes( args: DescribeDBClusterSnapshotAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterSnapshotAttributesCommandOutput) => void ): void; - public describeDBClusterSnapshotAttributes( - args: DescribeDBClusterSnapshotAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBClusterSnapshotAttributesCommandOutput) => void), - cb?: (err: any, data?: DescribeDBClusterSnapshotAttributesCommandOutput) => void - ): Promise | void { - const command = new DescribeDBClusterSnapshotAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about DB cluster snapshots. This API action supports pagination.

- *

For more information on Amazon Aurora DB clusters, see - * - * What is Amazon Aurora? in the Amazon Aurora User Guide.

- *

For more information on Multi-AZ DB clusters, see Multi-AZ DB - * cluster deployments in the Amazon RDS User - * Guide.

- */ - public describeDBClusterSnapshots( + + /** + * @see {@link DescribeDBClusterSnapshotsCommand} + */ + describeDBClusterSnapshots( args: DescribeDBClusterSnapshotsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBClusterSnapshots( + describeDBClusterSnapshots( args: DescribeDBClusterSnapshotsCommandInput, cb: (err: any, data?: DescribeDBClusterSnapshotsCommandOutput) => void ): void; - public describeDBClusterSnapshots( + describeDBClusterSnapshots( args: DescribeDBClusterSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterSnapshotsCommandOutput) => void ): void; - public describeDBClusterSnapshots( - args: DescribeDBClusterSnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBClusterSnapshotsCommandOutput) => void), - cb?: (err: any, data?: DescribeDBClusterSnapshotsCommandOutput) => void - ): Promise | void { - const command = new DescribeDBClusterSnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of the available DB engines.

- */ - public describeDBEngineVersions( + + /** + * @see {@link DescribeDBEngineVersionsCommand} + */ + describeDBEngineVersions( args: DescribeDBEngineVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBEngineVersions( + describeDBEngineVersions( args: DescribeDBEngineVersionsCommandInput, cb: (err: any, data?: DescribeDBEngineVersionsCommandOutput) => void ): void; - public describeDBEngineVersions( + describeDBEngineVersions( args: DescribeDBEngineVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBEngineVersionsCommandOutput) => void ): void; - public describeDBEngineVersions( - args: DescribeDBEngineVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBEngineVersionsCommandOutput) => void), - cb?: (err: any, data?: DescribeDBEngineVersionsCommandOutput) => void - ): Promise | void { - const command = new DescribeDBEngineVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Displays backups for both current and deleted - * instances. For example, use this operation to - * find details about automated backups for previously deleted instances. Current instances - * with retention periods greater than zero (0) are returned for both the - * DescribeDBInstanceAutomatedBackups and - * DescribeDBInstances operations.

- *

All parameters are optional.

- */ - public describeDBInstanceAutomatedBackups( + + /** + * @see {@link DescribeDBInstanceAutomatedBackupsCommand} + */ + describeDBInstanceAutomatedBackups( args: DescribeDBInstanceAutomatedBackupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBInstanceAutomatedBackups( + describeDBInstanceAutomatedBackups( args: DescribeDBInstanceAutomatedBackupsCommandInput, cb: (err: any, data?: DescribeDBInstanceAutomatedBackupsCommandOutput) => void ): void; - public describeDBInstanceAutomatedBackups( + describeDBInstanceAutomatedBackups( args: DescribeDBInstanceAutomatedBackupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBInstanceAutomatedBackupsCommandOutput) => void ): void; - public describeDBInstanceAutomatedBackups( - args: DescribeDBInstanceAutomatedBackupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBInstanceAutomatedBackupsCommandOutput) => void), - cb?: (err: any, data?: DescribeDBInstanceAutomatedBackupsCommandOutput) => void - ): Promise | void { - const command = new DescribeDBInstanceAutomatedBackupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about provisioned RDS instances. This API supports pagination.

- * - *

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

- *
- */ - public describeDBInstances( + + /** + * @see {@link DescribeDBInstancesCommand} + */ + describeDBInstances( args: DescribeDBInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBInstances( + describeDBInstances( args: DescribeDBInstancesCommandInput, cb: (err: any, data?: DescribeDBInstancesCommandOutput) => void ): void; - public describeDBInstances( + describeDBInstances( args: DescribeDBInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBInstancesCommandOutput) => void ): void; - public describeDBInstances( - args: DescribeDBInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBInstancesCommandOutput) => void), - cb?: (err: any, data?: DescribeDBInstancesCommandOutput) => void - ): Promise | void { - const command = new DescribeDBInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of DB log files for the DB instance.

- *

This command doesn't apply to RDS Custom.

- */ - public describeDBLogFiles( + + /** + * @see {@link DescribeDBLogFilesCommand} + */ + describeDBLogFiles( args: DescribeDBLogFilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBLogFiles( + describeDBLogFiles( args: DescribeDBLogFilesCommandInput, cb: (err: any, data?: DescribeDBLogFilesCommandOutput) => void ): void; - public describeDBLogFiles( + describeDBLogFiles( args: DescribeDBLogFilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBLogFilesCommandOutput) => void ): void; - public describeDBLogFiles( - args: DescribeDBLogFilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBLogFilesCommandOutput) => void), - cb?: (err: any, data?: DescribeDBLogFilesCommandOutput) => void - ): Promise | void { - const command = new DescribeDBLogFilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, - * the list will contain only the description of the specified DB parameter group.

- */ - public describeDBParameterGroups( + + /** + * @see {@link DescribeDBParameterGroupsCommand} + */ + describeDBParameterGroups( args: DescribeDBParameterGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBParameterGroups( + describeDBParameterGroups( args: DescribeDBParameterGroupsCommandInput, cb: (err: any, data?: DescribeDBParameterGroupsCommandOutput) => void ): void; - public describeDBParameterGroups( + describeDBParameterGroups( args: DescribeDBParameterGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBParameterGroupsCommandOutput) => void ): void; - public describeDBParameterGroups( - args: DescribeDBParameterGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBParameterGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeDBParameterGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeDBParameterGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the detailed parameter list for a particular DB parameter group.

- */ - public describeDBParameters( + + /** + * @see {@link DescribeDBParametersCommand} + */ + describeDBParameters( args: DescribeDBParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBParameters( + describeDBParameters( args: DescribeDBParametersCommandInput, cb: (err: any, data?: DescribeDBParametersCommandOutput) => void ): void; - public describeDBParameters( + describeDBParameters( args: DescribeDBParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBParametersCommandOutput) => void ): void; - public describeDBParameters( - args: DescribeDBParametersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBParametersCommandOutput) => void), - cb?: (err: any, data?: DescribeDBParametersCommandOutput) => void - ): Promise | void { - const command = new DescribeDBParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about DB proxies.

- */ - public describeDBProxies( + + /** + * @see {@link DescribeDBProxiesCommand} + */ + describeDBProxies( args: DescribeDBProxiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBProxies( + describeDBProxies( args: DescribeDBProxiesCommandInput, cb: (err: any, data?: DescribeDBProxiesCommandOutput) => void ): void; - public describeDBProxies( + describeDBProxies( args: DescribeDBProxiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBProxiesCommandOutput) => void ): void; - public describeDBProxies( - args: DescribeDBProxiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBProxiesCommandOutput) => void), - cb?: (err: any, data?: DescribeDBProxiesCommandOutput) => void - ): Promise | void { - const command = new DescribeDBProxiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about DB proxy endpoints.

- */ - public describeDBProxyEndpoints( + + /** + * @see {@link DescribeDBProxyEndpointsCommand} + */ + describeDBProxyEndpoints( args: DescribeDBProxyEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBProxyEndpoints( + describeDBProxyEndpoints( args: DescribeDBProxyEndpointsCommandInput, cb: (err: any, data?: DescribeDBProxyEndpointsCommandOutput) => void ): void; - public describeDBProxyEndpoints( + describeDBProxyEndpoints( args: DescribeDBProxyEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBProxyEndpointsCommandOutput) => void ): void; - public describeDBProxyEndpoints( - args: DescribeDBProxyEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBProxyEndpointsCommandOutput) => void), - cb?: (err: any, data?: DescribeDBProxyEndpointsCommandOutput) => void - ): Promise | void { - const command = new DescribeDBProxyEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.

- */ - public describeDBProxyTargetGroups( + + /** + * @see {@link DescribeDBProxyTargetGroupsCommand} + */ + describeDBProxyTargetGroups( args: DescribeDBProxyTargetGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBProxyTargetGroups( + describeDBProxyTargetGroups( args: DescribeDBProxyTargetGroupsCommandInput, cb: (err: any, data?: DescribeDBProxyTargetGroupsCommandOutput) => void ): void; - public describeDBProxyTargetGroups( + describeDBProxyTargetGroups( args: DescribeDBProxyTargetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBProxyTargetGroupsCommandOutput) => void ): void; - public describeDBProxyTargetGroups( - args: DescribeDBProxyTargetGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBProxyTargetGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeDBProxyTargetGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeDBProxyTargetGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about DBProxyTarget objects. This API supports pagination.

- */ - public describeDBProxyTargets( + + /** + * @see {@link DescribeDBProxyTargetsCommand} + */ + describeDBProxyTargets( args: DescribeDBProxyTargetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBProxyTargets( + describeDBProxyTargets( args: DescribeDBProxyTargetsCommandInput, cb: (err: any, data?: DescribeDBProxyTargetsCommandOutput) => void ): void; - public describeDBProxyTargets( + describeDBProxyTargets( args: DescribeDBProxyTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBProxyTargetsCommandOutput) => void ): void; - public describeDBProxyTargets( - args: DescribeDBProxyTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBProxyTargetsCommandOutput) => void), - cb?: (err: any, data?: DescribeDBProxyTargetsCommandOutput) => void - ): Promise | void { - const command = new DescribeDBProxyTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, - * the list will contain only the descriptions of the specified DB security group.

- * - *

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that - * you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the - * Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – - * Here’s How to Prepare, and Moving a DB instance not in a VPC - * into a VPC in the Amazon RDS User Guide.

- *
- */ - public describeDBSecurityGroups( + + /** + * @see {@link DescribeDBSecurityGroupsCommand} + */ + describeDBSecurityGroups( args: DescribeDBSecurityGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBSecurityGroups( + describeDBSecurityGroups( args: DescribeDBSecurityGroupsCommandInput, cb: (err: any, data?: DescribeDBSecurityGroupsCommandOutput) => void ): void; - public describeDBSecurityGroups( + describeDBSecurityGroups( args: DescribeDBSecurityGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBSecurityGroupsCommandOutput) => void ): void; - public describeDBSecurityGroups( - args: DescribeDBSecurityGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBSecurityGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeDBSecurityGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeDBSecurityGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

- *

When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes - * returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are - * authorized to copy or restore the manual DB snapshot. If all is included in the list of - * values for the restore attribute, then the manual DB snapshot is public and - * can be copied or restored by all Amazon Web Services accounts.

- *

To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the - * manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

- */ - public describeDBSnapshotAttributes( + + /** + * @see {@link DescribeDBSnapshotAttributesCommand} + */ + describeDBSnapshotAttributes( args: DescribeDBSnapshotAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBSnapshotAttributes( + describeDBSnapshotAttributes( args: DescribeDBSnapshotAttributesCommandInput, cb: (err: any, data?: DescribeDBSnapshotAttributesCommandOutput) => void ): void; - public describeDBSnapshotAttributes( + describeDBSnapshotAttributes( args: DescribeDBSnapshotAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBSnapshotAttributesCommandOutput) => void ): void; - public describeDBSnapshotAttributes( - args: DescribeDBSnapshotAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBSnapshotAttributesCommandOutput) => void), - cb?: (err: any, data?: DescribeDBSnapshotAttributesCommandOutput) => void - ): Promise | void { - const command = new DescribeDBSnapshotAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about DB snapshots. This API action supports pagination.

- */ - public describeDBSnapshots( + + /** + * @see {@link DescribeDBSnapshotsCommand} + */ + describeDBSnapshots( args: DescribeDBSnapshotsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBSnapshots( + describeDBSnapshots( args: DescribeDBSnapshotsCommandInput, cb: (err: any, data?: DescribeDBSnapshotsCommandOutput) => void ): void; - public describeDBSnapshots( + describeDBSnapshots( args: DescribeDBSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBSnapshotsCommandOutput) => void ): void; - public describeDBSnapshots( - args: DescribeDBSnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBSnapshotsCommandOutput) => void), - cb?: (err: any, data?: DescribeDBSnapshotsCommandOutput) => void - ): Promise | void { - const command = new DescribeDBSnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

- *

For an overview of CIDR ranges, go to the - * Wikipedia Tutorial.

- */ - public describeDBSubnetGroups( + + /** + * @see {@link DescribeDBSubnetGroupsCommand} + */ + describeDBSubnetGroups( args: DescribeDBSubnetGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDBSubnetGroups( + describeDBSubnetGroups( args: DescribeDBSubnetGroupsCommandInput, cb: (err: any, data?: DescribeDBSubnetGroupsCommandOutput) => void ): void; - public describeDBSubnetGroups( + describeDBSubnetGroups( args: DescribeDBSubnetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBSubnetGroupsCommandOutput) => void ): void; - public describeDBSubnetGroups( - args: DescribeDBSubnetGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDBSubnetGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeDBSubnetGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeDBSubnetGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the default engine and system parameter information for the cluster database engine.

- *

For more information on Amazon Aurora, see - * - * What is Amazon Aurora? in the Amazon Aurora User Guide.

- */ - public describeEngineDefaultClusterParameters( + + /** + * @see {@link DescribeEngineDefaultClusterParametersCommand} + */ + describeEngineDefaultClusterParameters( args: DescribeEngineDefaultClusterParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEngineDefaultClusterParameters( + describeEngineDefaultClusterParameters( args: DescribeEngineDefaultClusterParametersCommandInput, cb: (err: any, data?: DescribeEngineDefaultClusterParametersCommandOutput) => void ): void; - public describeEngineDefaultClusterParameters( + describeEngineDefaultClusterParameters( args: DescribeEngineDefaultClusterParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEngineDefaultClusterParametersCommandOutput) => void ): void; - public describeEngineDefaultClusterParameters( - args: DescribeEngineDefaultClusterParametersCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeEngineDefaultClusterParametersCommandOutput) => void), - cb?: (err: any, data?: DescribeEngineDefaultClusterParametersCommandOutput) => void - ): Promise | void { - const command = new DescribeEngineDefaultClusterParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the default engine and system parameter information for the specified database engine.

- */ - public describeEngineDefaultParameters( + + /** + * @see {@link DescribeEngineDefaultParametersCommand} + */ + describeEngineDefaultParameters( args: DescribeEngineDefaultParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEngineDefaultParameters( + describeEngineDefaultParameters( args: DescribeEngineDefaultParametersCommandInput, cb: (err: any, data?: DescribeEngineDefaultParametersCommandOutput) => void ): void; - public describeEngineDefaultParameters( + describeEngineDefaultParameters( args: DescribeEngineDefaultParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEngineDefaultParametersCommandOutput) => void ): void; - public describeEngineDefaultParameters( - args: DescribeEngineDefaultParametersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEngineDefaultParametersCommandOutput) => void), - cb?: (err: any, data?: DescribeEngineDefaultParametersCommandOutput) => void - ): Promise | void { - const command = new DescribeEngineDefaultParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Displays a list of categories for all event source types, or, if specified, for a specified source type. - * You can also see this list in the "Amazon RDS event categories and event messages" section of the - * Amazon RDS User Guide - * or the - * - * Amazon Aurora User Guide - * .

- */ - public describeEventCategories( + + /** + * @see {@link DescribeEventCategoriesCommand} + */ + describeEventCategories( args: DescribeEventCategoriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventCategories( + describeEventCategories( args: DescribeEventCategoriesCommandInput, cb: (err: any, data?: DescribeEventCategoriesCommandOutput) => void ): void; - public describeEventCategories( + describeEventCategories( args: DescribeEventCategoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventCategoriesCommandOutput) => void ): void; - public describeEventCategories( - args: DescribeEventCategoriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventCategoriesCommandOutput) => void), - cb?: (err: any, data?: DescribeEventCategoriesCommandOutput) => void - ): Promise | void { - const command = new DescribeEventCategoriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. - * Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be - * obtained by providing the name as a parameter.

- *

For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora - * events in the Amazon Aurora User Guide.

- * - *

By default, RDS returns events that were generated in the past hour.

- *
- */ - public describeEvents( + + /** + * @see {@link DescribeEventsCommand} + */ + describeEvents( args: DescribeEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEvents( - args: DescribeEventsCommandInput, - cb: (err: any, data?: DescribeEventsCommandOutput) => void - ): void; - public describeEvents( + describeEvents(args: DescribeEventsCommandInput, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void; + describeEvents( args: DescribeEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsCommandOutput) => void ): void; - public describeEvents( - args: DescribeEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventsCommandOutput) => void), - cb?: (err: any, data?: DescribeEventsCommandOutput) => void - ): Promise | void { - const command = new DescribeEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all the subscription descriptions for a customer account. The description for a subscription includes - * SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

- *

If you specify a SubscriptionName, lists the description for that subscription.

- */ - public describeEventSubscriptions( + + /** + * @see {@link DescribeEventSubscriptionsCommand} + */ + describeEventSubscriptions( args: DescribeEventSubscriptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventSubscriptions( + describeEventSubscriptions( args: DescribeEventSubscriptionsCommandInput, cb: (err: any, data?: DescribeEventSubscriptionsCommandOutput) => void ): void; - public describeEventSubscriptions( + describeEventSubscriptions( args: DescribeEventSubscriptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventSubscriptionsCommandOutput) => void ): void; - public describeEventSubscriptions( - args: DescribeEventSubscriptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventSubscriptionsCommandOutput) => void), - cb?: (err: any, data?: DescribeEventSubscriptionsCommandOutput) => void - ): Promise | void { - const command = new DescribeEventSubscriptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a snapshot or cluster export to Amazon S3. This API operation supports - * pagination.

- */ - public describeExportTasks( + + /** + * @see {@link DescribeExportTasksCommand} + */ + describeExportTasks( args: DescribeExportTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeExportTasks( + describeExportTasks( args: DescribeExportTasksCommandInput, cb: (err: any, data?: DescribeExportTasksCommandOutput) => void ): void; - public describeExportTasks( + describeExportTasks( args: DescribeExportTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExportTasksCommandOutput) => void ): void; - public describeExportTasks( - args: DescribeExportTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeExportTasksCommandOutput) => void), - cb?: (err: any, data?: DescribeExportTasksCommandOutput) => void - ): Promise | void { - const command = new DescribeExportTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about Aurora global database clusters. This API supports pagination.

- *

For more information on Amazon Aurora, see What is Amazon Aurora? in the - * Amazon Aurora User Guide.

- * - *

This action only applies to Aurora DB clusters.

- *
- */ - public describeGlobalClusters( + + /** + * @see {@link DescribeGlobalClustersCommand} + */ + describeGlobalClusters( args: DescribeGlobalClustersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGlobalClusters( + describeGlobalClusters( args: DescribeGlobalClustersCommandInput, cb: (err: any, data?: DescribeGlobalClustersCommandOutput) => void ): void; - public describeGlobalClusters( + describeGlobalClusters( args: DescribeGlobalClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGlobalClustersCommandOutput) => void ): void; - public describeGlobalClusters( - args: DescribeGlobalClustersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGlobalClustersCommandOutput) => void), - cb?: (err: any, data?: DescribeGlobalClustersCommandOutput) => void - ): Promise | void { - const command = new DescribeGlobalClustersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes all available options.

- */ - public describeOptionGroupOptions( + + /** + * @see {@link DescribeOptionGroupOptionsCommand} + */ + describeOptionGroupOptions( args: DescribeOptionGroupOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOptionGroupOptions( + describeOptionGroupOptions( args: DescribeOptionGroupOptionsCommandInput, cb: (err: any, data?: DescribeOptionGroupOptionsCommandOutput) => void ): void; - public describeOptionGroupOptions( + describeOptionGroupOptions( args: DescribeOptionGroupOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOptionGroupOptionsCommandOutput) => void ): void; - public describeOptionGroupOptions( - args: DescribeOptionGroupOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOptionGroupOptionsCommandOutput) => void), - cb?: (err: any, data?: DescribeOptionGroupOptionsCommandOutput) => void - ): Promise | void { - const command = new DescribeOptionGroupOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the available option groups.

- */ - public describeOptionGroups( + + /** + * @see {@link DescribeOptionGroupsCommand} + */ + describeOptionGroups( args: DescribeOptionGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOptionGroups( + describeOptionGroups( args: DescribeOptionGroupsCommandInput, cb: (err: any, data?: DescribeOptionGroupsCommandOutput) => void ): void; - public describeOptionGroups( + describeOptionGroups( args: DescribeOptionGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOptionGroupsCommandOutput) => void ): void; - public describeOptionGroups( - args: DescribeOptionGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOptionGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeOptionGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeOptionGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.

- */ - public describeOrderableDBInstanceOptions( + + /** + * @see {@link DescribeOrderableDBInstanceOptionsCommand} + */ + describeOrderableDBInstanceOptions( args: DescribeOrderableDBInstanceOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOrderableDBInstanceOptions( + describeOrderableDBInstanceOptions( args: DescribeOrderableDBInstanceOptionsCommandInput, cb: (err: any, data?: DescribeOrderableDBInstanceOptionsCommandOutput) => void ): void; - public describeOrderableDBInstanceOptions( + describeOrderableDBInstanceOptions( args: DescribeOrderableDBInstanceOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrderableDBInstanceOptionsCommandOutput) => void ): void; - public describeOrderableDBInstanceOptions( - args: DescribeOrderableDBInstanceOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOrderableDBInstanceOptionsCommandOutput) => void), - cb?: (err: any, data?: DescribeOrderableDBInstanceOptionsCommandOutput) => void - ): Promise | void { - const command = new DescribeOrderableDBInstanceOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

- */ - public describePendingMaintenanceActions( + + /** + * @see {@link DescribePendingMaintenanceActionsCommand} + */ + describePendingMaintenanceActions( args: DescribePendingMaintenanceActionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePendingMaintenanceActions( + describePendingMaintenanceActions( args: DescribePendingMaintenanceActionsCommandInput, cb: (err: any, data?: DescribePendingMaintenanceActionsCommandOutput) => void ): void; - public describePendingMaintenanceActions( + describePendingMaintenanceActions( args: DescribePendingMaintenanceActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePendingMaintenanceActionsCommandOutput) => void ): void; - public describePendingMaintenanceActions( - args: DescribePendingMaintenanceActionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePendingMaintenanceActionsCommandOutput) => void), - cb?: (err: any, data?: DescribePendingMaintenanceActionsCommandOutput) => void - ): Promise | void { - const command = new DescribePendingMaintenanceActionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

- */ - public describeReservedDBInstances( + + /** + * @see {@link DescribeReservedDBInstancesCommand} + */ + describeReservedDBInstances( args: DescribeReservedDBInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReservedDBInstances( + describeReservedDBInstances( args: DescribeReservedDBInstancesCommandInput, cb: (err: any, data?: DescribeReservedDBInstancesCommandOutput) => void ): void; - public describeReservedDBInstances( + describeReservedDBInstances( args: DescribeReservedDBInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReservedDBInstancesCommandOutput) => void ): void; - public describeReservedDBInstances( - args: DescribeReservedDBInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReservedDBInstancesCommandOutput) => void), - cb?: (err: any, data?: DescribeReservedDBInstancesCommandOutput) => void - ): Promise | void { - const command = new DescribeReservedDBInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists available reserved DB instance offerings.

- */ - public describeReservedDBInstancesOfferings( + + /** + * @see {@link DescribeReservedDBInstancesOfferingsCommand} + */ + describeReservedDBInstancesOfferings( args: DescribeReservedDBInstancesOfferingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReservedDBInstancesOfferings( + describeReservedDBInstancesOfferings( args: DescribeReservedDBInstancesOfferingsCommandInput, cb: (err: any, data?: DescribeReservedDBInstancesOfferingsCommandOutput) => void ): void; - public describeReservedDBInstancesOfferings( + describeReservedDBInstancesOfferings( args: DescribeReservedDBInstancesOfferingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReservedDBInstancesOfferingsCommandOutput) => void ): void; - public describeReservedDBInstancesOfferings( - args: DescribeReservedDBInstancesOfferingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReservedDBInstancesOfferingsCommandOutput) => void), - cb?: (err: any, data?: DescribeReservedDBInstancesOfferingsCommandOutput) => void - ): Promise | void { - const command = new DescribeReservedDBInstancesOfferingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, - * copy a DB snapshot from, or replicate automated backups from.

- *

Use this operation to determine whether cross-Region features are supported between other Regions - * and your current Region. This operation supports pagination.

- *

To return information about the Regions that are enabled for your account, or all Regions, - * use the EC2 operation DescribeRegions. For more information, see - * - * DescribeRegions in the Amazon EC2 API Reference.

- */ - public describeSourceRegions( + + /** + * @see {@link DescribeSourceRegionsCommand} + */ + describeSourceRegions( args: DescribeSourceRegionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSourceRegions( + describeSourceRegions( args: DescribeSourceRegionsCommandInput, cb: (err: any, data?: DescribeSourceRegionsCommandOutput) => void ): void; - public describeSourceRegions( + describeSourceRegions( args: DescribeSourceRegionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSourceRegionsCommandOutput) => void ): void; - public describeSourceRegions( - args: DescribeSourceRegionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSourceRegionsCommandOutput) => void), - cb?: (err: any, data?: DescribeSourceRegionsCommandOutput) => void - ): Promise | void { - const command = new DescribeSourceRegionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to - * your DB instance. You can use this information when you call ModifyDBInstance.

- *

This command doesn't apply to RDS Custom.

- */ - public describeValidDBInstanceModifications( + + /** + * @see {@link DescribeValidDBInstanceModificationsCommand} + */ + describeValidDBInstanceModifications( args: DescribeValidDBInstanceModificationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeValidDBInstanceModifications( + describeValidDBInstanceModifications( args: DescribeValidDBInstanceModificationsCommandInput, cb: (err: any, data?: DescribeValidDBInstanceModificationsCommandOutput) => void ): void; - public describeValidDBInstanceModifications( + describeValidDBInstanceModifications( args: DescribeValidDBInstanceModificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeValidDBInstanceModificationsCommandOutput) => void ): void; - public describeValidDBInstanceModifications( - args: DescribeValidDBInstanceModificationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeValidDBInstanceModificationsCommandOutput) => void), - cb?: (err: any, data?: DescribeValidDBInstanceModificationsCommandOutput) => void - ): Promise | void { - const command = new DescribeValidDBInstanceModificationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Downloads all or a portion of the specified log file, up to 1 MB in size.

- *

This command doesn't apply to RDS Custom.

- */ - public downloadDBLogFilePortion( + + /** + * @see {@link DownloadDBLogFilePortionCommand} + */ + downloadDBLogFilePortion( args: DownloadDBLogFilePortionCommandInput, options?: __HttpHandlerOptions ): Promise; - public downloadDBLogFilePortion( + downloadDBLogFilePortion( args: DownloadDBLogFilePortionCommandInput, cb: (err: any, data?: DownloadDBLogFilePortionCommandOutput) => void ): void; - public downloadDBLogFilePortion( + downloadDBLogFilePortion( args: DownloadDBLogFilePortionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DownloadDBLogFilePortionCommandOutput) => void ): void; - public downloadDBLogFilePortion( - args: DownloadDBLogFilePortionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DownloadDBLogFilePortionCommandOutput) => void), - cb?: (err: any, data?: DownloadDBLogFilePortionCommandOutput) => void - ): Promise | void { - const command = new DownloadDBLogFilePortionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Forces a failover for a DB cluster.

- *

For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) - * in the DB cluster to be the primary DB instance (the cluster writer).

- *

For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) - * in the DB cluster to be the primary DB instance (the cluster writer).

- *

An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, - * when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby - * DB instance when the primary DB instance fails.

- *

To simulate a failure of a primary instance for testing, you can force a failover. - * Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing - * connections that use those endpoint addresses when the failover is complete.

- *

For more information on Amazon Aurora DB clusters, see - * - * What is Amazon Aurora? in the Amazon Aurora User Guide.

- *

For more information on Multi-AZ DB clusters, see Multi-AZ DB - * cluster deployments in the Amazon RDS User - * Guide.

- */ - public failoverDBCluster( + + /** + * @see {@link FailoverDBClusterCommand} + */ + failoverDBCluster( args: FailoverDBClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public failoverDBCluster( + failoverDBCluster( args: FailoverDBClusterCommandInput, cb: (err: any, data?: FailoverDBClusterCommandOutput) => void ): void; - public failoverDBCluster( + failoverDBCluster( args: FailoverDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FailoverDBClusterCommandOutput) => void ): void; - public failoverDBCluster( - args: FailoverDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FailoverDBClusterCommandOutput) => void), - cb?: (err: any, data?: FailoverDBClusterCommandOutput) => void - ): Promise | void { - const command = new FailoverDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Initiates the failover process for an Aurora global database (GlobalCluster).

- *

A failover for an Aurora global database promotes one of secondary read-only DB clusters to be - * the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, - * the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected - * secondary DB cluster assumes full read/write capabilities for the Aurora global database.

- *

For more information about failing over an Amazon Aurora global database, see - * Managed planned failover for Amazon Aurora global - * databases in the Amazon Aurora User Guide.

- * - *

This action applies to GlobalCluster (Aurora global databases) only. Use this action only on - * healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to - * reconfigure your Aurora global database topology.

- *
- */ - public failoverGlobalCluster( + + /** + * @see {@link FailoverGlobalClusterCommand} + */ + failoverGlobalCluster( args: FailoverGlobalClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public failoverGlobalCluster( + failoverGlobalCluster( args: FailoverGlobalClusterCommandInput, cb: (err: any, data?: FailoverGlobalClusterCommandOutput) => void ): void; - public failoverGlobalCluster( + failoverGlobalCluster( args: FailoverGlobalClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FailoverGlobalClusterCommandOutput) => void ): void; - public failoverGlobalCluster( - args: FailoverGlobalClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FailoverGlobalClusterCommandOutput) => void), - cb?: (err: any, data?: FailoverGlobalClusterCommandOutput) => void - ): Promise | void { - const command = new FailoverGlobalClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all tags on an Amazon RDS resource.

- *

For an overview on tagging an Amazon RDS resource, - * see Tagging Amazon RDS Resources - * in the Amazon RDS User Guide.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only, - * whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy, - * and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the - * Amazon RDS User Guide.

- *

This operation is supported for RDS for Oracle and Microsoft SQL Server.

- */ - public modifyActivityStream( + + /** + * @see {@link ModifyActivityStreamCommand} + */ + modifyActivityStream( args: ModifyActivityStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyActivityStream( + modifyActivityStream( args: ModifyActivityStreamCommandInput, cb: (err: any, data?: ModifyActivityStreamCommandOutput) => void ): void; - public modifyActivityStream( + modifyActivityStream( args: ModifyActivityStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyActivityStreamCommandOutput) => void ): void; - public modifyActivityStream( - args: ModifyActivityStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyActivityStreamCommandOutput) => void), - cb?: (err: any, data?: ModifyActivityStreamCommandOutput) => void - ): Promise | void { - const command = new ModifyActivityStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) - * certificate for Amazon RDS for new DB instances, or remove the override.

- *

By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB - * instances that is different from the default certificate provided by RDS. You can also - * use this operation to remove the override, so that new DB instances use the default - * certificate provided by RDS.

- *

You might need to override the default certificate in the following situations:

- *
    - *
  • - *

    You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet - * the RDS default CA certificate for the specified Amazon Web Services Region.

    - *
  • - *
  • - *

    RDS has already moved to a new default CA certificate for the specified Amazon Web Services - * Region, but you are still in the process of supporting the new CA certificate. - * In this case, you temporarily need additional time to finish your application - * changes.

    - *
  • - *
- *

For more information about rotating your SSL/TLS certificate for RDS DB engines, see - * - * Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.

- *

For more information about rotating your SSL/TLS certificate for Aurora DB engines, see - * - * Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.

- */ - public modifyCertificates( + + /** + * @see {@link ModifyCertificatesCommand} + */ + modifyCertificates( args: ModifyCertificatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyCertificates( + modifyCertificates( args: ModifyCertificatesCommandInput, cb: (err: any, data?: ModifyCertificatesCommandOutput) => void ): void; - public modifyCertificates( + modifyCertificates( args: ModifyCertificatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyCertificatesCommandOutput) => void ): void; - public modifyCertificates( - args: ModifyCertificatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyCertificatesCommandOutput) => void), - cb?: (err: any, data?: ModifyCertificatesCommandOutput) => void - ): Promise | void { - const command = new ModifyCertificatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.

- *

Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale - * fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity - * to set the capacity explicitly.

- *

After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale - * the DB cluster based on the cooldown period for scaling up and the cooldown period - * for scaling down.

- *

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the - * Amazon Aurora User Guide.

- * - *

If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that - * prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, - * see - * Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

- *
- * - *

This action only applies to Aurora Serverless v1 DB clusters.

- *
- */ - public modifyCurrentDBClusterCapacity( + + /** + * @see {@link ModifyCurrentDBClusterCapacityCommand} + */ + modifyCurrentDBClusterCapacity( args: ModifyCurrentDBClusterCapacityCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyCurrentDBClusterCapacity( + modifyCurrentDBClusterCapacity( args: ModifyCurrentDBClusterCapacityCommandInput, cb: (err: any, data?: ModifyCurrentDBClusterCapacityCommandOutput) => void ): void; - public modifyCurrentDBClusterCapacity( + modifyCurrentDBClusterCapacity( args: ModifyCurrentDBClusterCapacityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyCurrentDBClusterCapacityCommandOutput) => void ): void; - public modifyCurrentDBClusterCapacity( - args: ModifyCurrentDBClusterCapacityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyCurrentDBClusterCapacityCommandOutput) => void), - cb?: (err: any, data?: ModifyCurrentDBClusterCapacityCommandOutput) => void - ): Promise | void { - const command = new ModifyCurrentDBClusterCapacityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling - * DescribeDBEngineVersions.

- * - *

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with - * Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the - * ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the - * API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for - * the ModifyCustomDbEngineVersion event.

- *
- *

For more information, see Modifying CEV status - * in the Amazon RDS User Guide.

- */ - public modifyCustomDBEngineVersion( + + /** + * @see {@link ModifyCustomDBEngineVersionCommand} + */ + modifyCustomDBEngineVersion( args: ModifyCustomDBEngineVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyCustomDBEngineVersion( + modifyCustomDBEngineVersion( args: ModifyCustomDBEngineVersionCommandInput, cb: (err: any, data?: ModifyCustomDBEngineVersionCommandOutput) => void ): void; - public modifyCustomDBEngineVersion( + modifyCustomDBEngineVersion( args: ModifyCustomDBEngineVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyCustomDBEngineVersionCommandOutput) => void ): void; - public modifyCustomDBEngineVersion( - args: ModifyCustomDBEngineVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyCustomDBEngineVersionCommandOutput) => void), - cb?: (err: any, data?: ModifyCustomDBEngineVersionCommandOutput) => void - ): Promise | void { - const command = new ModifyCustomDBEngineVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. - * You can change one or more settings by specifying these parameters and the new values in the - * request.

- *

For more information on Amazon Aurora DB clusters, see - * - * What is Amazon Aurora? in the Amazon Aurora User Guide.

- *

For more information on Multi-AZ DB clusters, see Multi-AZ DB - * cluster deployments in the Amazon RDS User - * Guide.

- */ - public modifyDBCluster( + + /** + * @see {@link ModifyDBClusterCommand} + */ + modifyDBCluster( args: ModifyDBClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDBCluster( - args: ModifyDBClusterCommandInput, - cb: (err: any, data?: ModifyDBClusterCommandOutput) => void - ): void; - public modifyDBCluster( + modifyDBCluster(args: ModifyDBClusterCommandInput, cb: (err: any, data?: ModifyDBClusterCommandOutput) => void): void; + modifyDBCluster( args: ModifyDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBClusterCommandOutput) => void ): void; - public modifyDBCluster( - args: ModifyDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBClusterCommandOutput) => void), - cb?: (err: any, data?: ModifyDBClusterCommandOutput) => void - ): Promise | void { - const command = new ModifyDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

- * - *

This action only applies to Aurora DB clusters.

- *
- */ - public modifyDBClusterEndpoint( + + /** + * @see {@link ModifyDBClusterEndpointCommand} + */ + modifyDBClusterEndpoint( args: ModifyDBClusterEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDBClusterEndpoint( + modifyDBClusterEndpoint( args: ModifyDBClusterEndpointCommandInput, cb: (err: any, data?: ModifyDBClusterEndpointCommandOutput) => void ): void; - public modifyDBClusterEndpoint( + modifyDBClusterEndpoint( args: ModifyDBClusterEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBClusterEndpointCommandOutput) => void ): void; - public modifyDBClusterEndpoint( - args: ModifyDBClusterEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBClusterEndpointCommandOutput) => void), - cb?: (err: any, data?: ModifyDBClusterEndpointCommandOutput) => void - ): Promise | void { - const command = new ModifyDBClusterEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, - * submit a list of the following: ParameterName, ParameterValue, - * and ApplyMethod. A maximum of 20 - * parameters can be modified in a single request.

- * - *

After you create a DB cluster parameter group, you should wait at least 5 minutes - * before creating your first DB cluster that uses that DB cluster parameter group as the default parameter - * group. This allows Amazon RDS to fully complete the create action before the parameter - * group is used as the default for a new DB cluster. This is especially important for parameters - * that are critical when creating the default database for a DB cluster, such as the character set - * for the default database defined by the character_set_database parameter. You can use the - * Parameter Groups option of the Amazon RDS console or the - * DescribeDBClusterParameters operation to verify - * that your DB cluster parameter group has been created or modified.

- *

If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora - * applies the update immediately. The cluster restart might interrupt your workload. In that case, - * your application must reopen any connections and retry any transactions that were active - * when the parameter changes took effect.

- *
- *

For more information on Amazon Aurora DB clusters, see - * - * What is Amazon Aurora? in the Amazon Aurora User Guide.

- *

For more information on Multi-AZ DB clusters, see Multi-AZ DB - * cluster deployments in the Amazon RDS User - * Guide. - *

- */ - public modifyDBClusterParameterGroup( + + /** + * @see {@link ModifyDBClusterParameterGroupCommand} + */ + modifyDBClusterParameterGroup( args: ModifyDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDBClusterParameterGroup( + modifyDBClusterParameterGroup( args: ModifyDBClusterParameterGroupCommandInput, cb: (err: any, data?: ModifyDBClusterParameterGroupCommandOutput) => void ): void; - public modifyDBClusterParameterGroup( + modifyDBClusterParameterGroup( args: ModifyDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBClusterParameterGroupCommandOutput) => void ): void; - public modifyDBClusterParameterGroup( - args: ModifyDBClusterParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBClusterParameterGroupCommandOutput) => void), - cb?: (err: any, data?: ModifyDBClusterParameterGroupCommandOutput) => void - ): Promise | void { - const command = new ModifyDBClusterParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

- *

To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify - * restore as the AttributeName and use the - * ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are - * authorized to restore the manual DB cluster snapshot. Use the value all to - * make the manual DB cluster snapshot public, which means that it can be copied or - * restored by all Amazon Web Services accounts.

- * - *

Don't add the all value for any manual DB cluster snapshots - * that contain private information that you don't want available to all Amazon Web Services - * accounts.

- *
- *

If a manual DB cluster snapshot is encrypted, it can be shared, but only by - * specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd - * parameter. You can't use all as a value for that parameter in this - * case.

- *

To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster - * snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are - * returned as values for the restore attribute.

- */ - public modifyDBClusterSnapshotAttribute( + + /** + * @see {@link ModifyDBClusterSnapshotAttributeCommand} + */ + modifyDBClusterSnapshotAttribute( args: ModifyDBClusterSnapshotAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDBClusterSnapshotAttribute( + modifyDBClusterSnapshotAttribute( args: ModifyDBClusterSnapshotAttributeCommandInput, cb: (err: any, data?: ModifyDBClusterSnapshotAttributeCommandOutput) => void ): void; - public modifyDBClusterSnapshotAttribute( + modifyDBClusterSnapshotAttribute( args: ModifyDBClusterSnapshotAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBClusterSnapshotAttributeCommandOutput) => void ): void; - public modifyDBClusterSnapshotAttribute( - args: ModifyDBClusterSnapshotAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBClusterSnapshotAttributeCommandOutput) => void), - cb?: (err: any, data?: ModifyDBClusterSnapshotAttributeCommandOutput) => void - ): Promise | void { - const command = new ModifyDBClusterSnapshotAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies settings for a DB instance. - * You can change one or more database configuration parameters by specifying these parameters and the new values in the request. - * To learn what modifications you can make to your DB instance, - * call DescribeValidDBInstanceModifications - * before you call ModifyDBInstance.

- */ - public modifyDBInstance( + + /** + * @see {@link ModifyDBInstanceCommand} + */ + modifyDBInstance( args: ModifyDBInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDBInstance( + modifyDBInstance( args: ModifyDBInstanceCommandInput, cb: (err: any, data?: ModifyDBInstanceCommandOutput) => void ): void; - public modifyDBInstance( + modifyDBInstance( args: ModifyDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBInstanceCommandOutput) => void ): void; - public modifyDBInstance( - args: ModifyDBInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBInstanceCommandOutput) => void), - cb?: (err: any, data?: ModifyDBInstanceCommandOutput) => void - ): Promise | void { - const command = new ModifyDBInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the parameters of a DB parameter group. To modify more than one parameter, - * submit a list of the following: ParameterName, ParameterValue, and - * ApplyMethod. A maximum of 20 parameters can be modified in a single request.

- * - *

After you modify a DB parameter group, you should wait at least 5 minutes - * before creating your first DB instance that uses that DB parameter group as the default parameter - * group. This allows Amazon RDS to fully complete the modify action before the parameter - * group is used as the default for a new DB instance. This is especially important for parameters - * that are critical when creating the default database for a DB instance, such as the character set - * for the default database defined by the character_set_database parameter. You can use the - * Parameter Groups option of the Amazon RDS console or the - * DescribeDBParameters command to verify - * that your DB parameter group has been created or modified.

- *
- */ - public modifyDBParameterGroup( + + /** + * @see {@link ModifyDBParameterGroupCommand} + */ + modifyDBParameterGroup( args: ModifyDBParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDBParameterGroup( + modifyDBParameterGroup( args: ModifyDBParameterGroupCommandInput, cb: (err: any, data?: ModifyDBParameterGroupCommandOutput) => void ): void; - public modifyDBParameterGroup( + modifyDBParameterGroup( args: ModifyDBParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBParameterGroupCommandOutput) => void ): void; - public modifyDBParameterGroup( - args: ModifyDBParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBParameterGroupCommandOutput) => void), - cb?: (err: any, data?: ModifyDBParameterGroupCommandOutput) => void - ): Promise | void { - const command = new ModifyDBParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Changes the settings for an existing DB proxy.

- */ - public modifyDBProxy( - args: ModifyDBProxyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public modifyDBProxy( - args: ModifyDBProxyCommandInput, - cb: (err: any, data?: ModifyDBProxyCommandOutput) => void - ): void; - public modifyDBProxy( + + /** + * @see {@link ModifyDBProxyCommand} + */ + modifyDBProxy(args: ModifyDBProxyCommandInput, options?: __HttpHandlerOptions): Promise; + modifyDBProxy(args: ModifyDBProxyCommandInput, cb: (err: any, data?: ModifyDBProxyCommandOutput) => void): void; + modifyDBProxy( args: ModifyDBProxyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBProxyCommandOutput) => void ): void; - public modifyDBProxy( - args: ModifyDBProxyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBProxyCommandOutput) => void), - cb?: (err: any, data?: ModifyDBProxyCommandOutput) => void - ): Promise | void { - const command = new ModifyDBProxyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Changes the settings for an existing DB proxy endpoint.

- */ - public modifyDBProxyEndpoint( + + /** + * @see {@link ModifyDBProxyEndpointCommand} + */ + modifyDBProxyEndpoint( args: ModifyDBProxyEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDBProxyEndpoint( + modifyDBProxyEndpoint( args: ModifyDBProxyEndpointCommandInput, cb: (err: any, data?: ModifyDBProxyEndpointCommandOutput) => void ): void; - public modifyDBProxyEndpoint( + modifyDBProxyEndpoint( args: ModifyDBProxyEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBProxyEndpointCommandOutput) => void ): void; - public modifyDBProxyEndpoint( - args: ModifyDBProxyEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBProxyEndpointCommandOutput) => void), - cb?: (err: any, data?: ModifyDBProxyEndpointCommandOutput) => void - ): Promise | void { - const command = new ModifyDBProxyEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the properties of a DBProxyTargetGroup.

- */ - public modifyDBProxyTargetGroup( + + /** + * @see {@link ModifyDBProxyTargetGroupCommand} + */ + modifyDBProxyTargetGroup( args: ModifyDBProxyTargetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDBProxyTargetGroup( + modifyDBProxyTargetGroup( args: ModifyDBProxyTargetGroupCommandInput, cb: (err: any, data?: ModifyDBProxyTargetGroupCommandOutput) => void ): void; - public modifyDBProxyTargetGroup( + modifyDBProxyTargetGroup( args: ModifyDBProxyTargetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBProxyTargetGroupCommandOutput) => void ): void; - public modifyDBProxyTargetGroup( - args: ModifyDBProxyTargetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBProxyTargetGroupCommandOutput) => void), - cb?: (err: any, data?: ModifyDBProxyTargetGroupCommandOutput) => void - ): Promise | void { - const command = new ModifyDBProxyTargetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted - * or unencrypted, but not shared or public. - * - *

- *

Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command - * doesn't apply to RDS Custom.

- */ - public modifyDBSnapshot( + + /** + * @see {@link ModifyDBSnapshotCommand} + */ + modifyDBSnapshot( args: ModifyDBSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDBSnapshot( + modifyDBSnapshot( args: ModifyDBSnapshotCommandInput, cb: (err: any, data?: ModifyDBSnapshotCommandOutput) => void ): void; - public modifyDBSnapshot( + modifyDBSnapshot( args: ModifyDBSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBSnapshotCommandOutput) => void ): void; - public modifyDBSnapshot( - args: ModifyDBSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBSnapshotCommandOutput) => void), - cb?: (err: any, data?: ModifyDBSnapshotCommandOutput) => void - ): Promise | void { - const command = new ModifyDBSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

- *

To share a manual DB snapshot with other Amazon Web Services accounts, specify restore - * as the AttributeName and use the ValuesToAdd parameter to add - * a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot. - * Uses the value all to make the manual DB snapshot public, which means it - * can be copied or restored by all Amazon Web Services accounts.

- * - *

Don't add the all value for any manual DB snapshots that - * contain private information that you don't want available to all Amazon Web Services - * accounts.

- *
- *

If the manual DB snapshot is encrypted, it can be shared, but only by specifying a - * list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You - * can't use all as a value for that parameter in this case.

- *

To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or - * whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as - * values for the restore attribute.

- */ - public modifyDBSnapshotAttribute( + + /** + * @see {@link ModifyDBSnapshotAttributeCommand} + */ + modifyDBSnapshotAttribute( args: ModifyDBSnapshotAttributeCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDBSnapshotAttribute( + modifyDBSnapshotAttribute( args: ModifyDBSnapshotAttributeCommandInput, cb: (err: any, data?: ModifyDBSnapshotAttributeCommandOutput) => void ): void; - public modifyDBSnapshotAttribute( + modifyDBSnapshotAttribute( args: ModifyDBSnapshotAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBSnapshotAttributeCommandOutput) => void ): void; - public modifyDBSnapshotAttribute( - args: ModifyDBSnapshotAttributeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBSnapshotAttributeCommandOutput) => void), - cb?: (err: any, data?: ModifyDBSnapshotAttributeCommandOutput) => void - ): Promise | void { - const command = new ModifyDBSnapshotAttributeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

- */ - public modifyDBSubnetGroup( + + /** + * @see {@link ModifyDBSubnetGroupCommand} + */ + modifyDBSubnetGroup( args: ModifyDBSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDBSubnetGroup( + modifyDBSubnetGroup( args: ModifyDBSubnetGroupCommandInput, cb: (err: any, data?: ModifyDBSubnetGroupCommandOutput) => void ): void; - public modifyDBSubnetGroup( + modifyDBSubnetGroup( args: ModifyDBSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBSubnetGroupCommandOutput) => void ): void; - public modifyDBSubnetGroup( - args: ModifyDBSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDBSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: ModifyDBSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new ModifyDBSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change - * source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

- *

You can see a list of the event categories for a given source type (SourceType) - * in Events in the Amazon RDS User Guide - * or by using the DescribeEventCategories operation.

- */ - public modifyEventSubscription( + + /** + * @see {@link ModifyEventSubscriptionCommand} + */ + modifyEventSubscription( args: ModifyEventSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyEventSubscription( + modifyEventSubscription( args: ModifyEventSubscriptionCommandInput, cb: (err: any, data?: ModifyEventSubscriptionCommandOutput) => void ): void; - public modifyEventSubscription( + modifyEventSubscription( args: ModifyEventSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyEventSubscriptionCommandOutput) => void ): void; - public modifyEventSubscription( - args: ModifyEventSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyEventSubscriptionCommandOutput) => void), - cb?: (err: any, data?: ModifyEventSubscriptionCommandOutput) => void - ): Promise | void { - const command = new ModifyEventSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration - * parameters by specifying these parameters and the new values in the request. For more information on - * Amazon Aurora, see What is Amazon Aurora? in the - * Amazon Aurora User Guide.

- * - *

This action only applies to Aurora DB clusters.

- *
- */ - public modifyGlobalCluster( + + /** + * @see {@link ModifyGlobalClusterCommand} + */ + modifyGlobalCluster( args: ModifyGlobalClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyGlobalCluster( + modifyGlobalCluster( args: ModifyGlobalClusterCommandInput, cb: (err: any, data?: ModifyGlobalClusterCommandOutput) => void ): void; - public modifyGlobalCluster( + modifyGlobalCluster( args: ModifyGlobalClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyGlobalClusterCommandOutput) => void ): void; - public modifyGlobalCluster( - args: ModifyGlobalClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyGlobalClusterCommandOutput) => void), - cb?: (err: any, data?: ModifyGlobalClusterCommandOutput) => void - ): Promise | void { - const command = new ModifyGlobalClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies an existing option group.

- */ - public modifyOptionGroup( + + /** + * @see {@link ModifyOptionGroupCommand} + */ + modifyOptionGroup( args: ModifyOptionGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyOptionGroup( + modifyOptionGroup( args: ModifyOptionGroupCommandInput, cb: (err: any, data?: ModifyOptionGroupCommandOutput) => void ): void; - public modifyOptionGroup( + modifyOptionGroup( args: ModifyOptionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyOptionGroupCommandOutput) => void ): void; - public modifyOptionGroup( - args: ModifyOptionGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyOptionGroupCommandOutput) => void), - cb?: (err: any, data?: ModifyOptionGroupCommandOutput) => void - ): Promise | void { - const command = new ModifyOptionGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Promotes a read replica DB instance to a standalone DB instance.

- * - *
    - *
  • - *

    Backup duration is a function of the amount of changes to the database since the previous - * backup. If you plan to promote a read replica to a standalone instance, we - * recommend that you enable backups and complete at least one backup prior to - * promotion. In addition, a read replica cannot be promoted to a standalone - * instance when it is in the backing-up status. If you have - * enabled backups on your read replica, configure the automated backup window - * so that daily backups do not interfere with read replica - * promotion.

    - *
  • - *
  • - *

    This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.

    - *
  • - *
- *
- */ - public promoteReadReplica( + + /** + * @see {@link PromoteReadReplicaCommand} + */ + promoteReadReplica( args: PromoteReadReplicaCommandInput, options?: __HttpHandlerOptions ): Promise; - public promoteReadReplica( + promoteReadReplica( args: PromoteReadReplicaCommandInput, cb: (err: any, data?: PromoteReadReplicaCommandOutput) => void ): void; - public promoteReadReplica( + promoteReadReplica( args: PromoteReadReplicaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PromoteReadReplicaCommandOutput) => void ): void; - public promoteReadReplica( - args: PromoteReadReplicaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PromoteReadReplicaCommandOutput) => void), - cb?: (err: any, data?: PromoteReadReplicaCommandOutput) => void - ): Promise | void { - const command = new PromoteReadReplicaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Promotes a read replica DB cluster to a standalone DB cluster.

- */ - public promoteReadReplicaDBCluster( + + /** + * @see {@link PromoteReadReplicaDBClusterCommand} + */ + promoteReadReplicaDBCluster( args: PromoteReadReplicaDBClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public promoteReadReplicaDBCluster( + promoteReadReplicaDBCluster( args: PromoteReadReplicaDBClusterCommandInput, cb: (err: any, data?: PromoteReadReplicaDBClusterCommandOutput) => void ): void; - public promoteReadReplicaDBCluster( + promoteReadReplicaDBCluster( args: PromoteReadReplicaDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PromoteReadReplicaDBClusterCommandOutput) => void ): void; - public promoteReadReplicaDBCluster( - args: PromoteReadReplicaDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PromoteReadReplicaDBClusterCommandOutput) => void), - cb?: (err: any, data?: PromoteReadReplicaDBClusterCommandOutput) => void - ): Promise | void { - const command = new PromoteReadReplicaDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Purchases a reserved DB instance offering.

- */ - public purchaseReservedDBInstancesOffering( + + /** + * @see {@link PurchaseReservedDBInstancesOfferingCommand} + */ + purchaseReservedDBInstancesOffering( args: PurchaseReservedDBInstancesOfferingCommandInput, options?: __HttpHandlerOptions ): Promise; - public purchaseReservedDBInstancesOffering( + purchaseReservedDBInstancesOffering( args: PurchaseReservedDBInstancesOfferingCommandInput, cb: (err: any, data?: PurchaseReservedDBInstancesOfferingCommandOutput) => void ): void; - public purchaseReservedDBInstancesOffering( + purchaseReservedDBInstancesOffering( args: PurchaseReservedDBInstancesOfferingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PurchaseReservedDBInstancesOfferingCommandOutput) => void ): void; - public purchaseReservedDBInstancesOffering( - args: PurchaseReservedDBInstancesOfferingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PurchaseReservedDBInstancesOfferingCommandOutput) => void), - cb?: (err: any, data?: PurchaseReservedDBInstancesOfferingCommandOutput) => void - ): Promise | void { - const command = new PurchaseReservedDBInstancesOfferingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

You might need to reboot your DB cluster, usually for maintenance reasons. - * For example, if you make certain modifications, - * or if you change the DB cluster parameter group associated with the DB cluster, - * reboot the DB cluster for the changes to take effect.

- *

Rebooting a DB cluster restarts the database engine service. Rebooting a DB - * cluster results in a momentary outage, during which the DB cluster status is set to rebooting.

- *

Use this operation only for a non-Aurora Multi-AZ DB cluster.

- *

For more information on Multi-AZ DB clusters, see Multi-AZ DB - * cluster deployments in the Amazon RDS User - * Guide. - *

- */ - public rebootDBCluster( + + /** + * @see {@link RebootDBClusterCommand} + */ + rebootDBCluster( args: RebootDBClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public rebootDBCluster( - args: RebootDBClusterCommandInput, - cb: (err: any, data?: RebootDBClusterCommandOutput) => void - ): void; - public rebootDBCluster( + rebootDBCluster(args: RebootDBClusterCommandInput, cb: (err: any, data?: RebootDBClusterCommandOutput) => void): void; + rebootDBCluster( args: RebootDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebootDBClusterCommandOutput) => void ): void; - public rebootDBCluster( - args: RebootDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RebootDBClusterCommandOutput) => void), - cb?: (err: any, data?: RebootDBClusterCommandOutput) => void - ): Promise | void { - const command = new RebootDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

You might need to reboot your DB instance, usually for maintenance reasons. - * For example, if you make certain modifications, - * or if you change the DB parameter group associated with the DB instance, - * you must reboot the instance for the changes to take effect.

- *

Rebooting a DB instance restarts the database engine service. - * Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

- *

For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide. - *

- *

This command doesn't apply to RDS Custom.

- *

If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.

- */ - public rebootDBInstance( + + /** + * @see {@link RebootDBInstanceCommand} + */ + rebootDBInstance( args: RebootDBInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public rebootDBInstance( + rebootDBInstance( args: RebootDBInstanceCommandInput, cb: (err: any, data?: RebootDBInstanceCommandOutput) => void ): void; - public rebootDBInstance( + rebootDBInstance( args: RebootDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebootDBInstanceCommandOutput) => void ): void; - public rebootDBInstance( - args: RebootDBInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RebootDBInstanceCommandOutput) => void), - cb?: (err: any, data?: RebootDBInstanceCommandOutput) => void - ): Promise | void { - const command = new RebootDBInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

- */ - public registerDBProxyTargets( + + /** + * @see {@link RegisterDBProxyTargetsCommand} + */ + registerDBProxyTargets( args: RegisterDBProxyTargetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerDBProxyTargets( + registerDBProxyTargets( args: RegisterDBProxyTargetsCommandInput, cb: (err: any, data?: RegisterDBProxyTargetsCommandOutput) => void ): void; - public registerDBProxyTargets( + registerDBProxyTargets( args: RegisterDBProxyTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterDBProxyTargetsCommandOutput) => void ): void; - public registerDBProxyTargets( - args: RegisterDBProxyTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterDBProxyTargetsCommandOutput) => void), - cb?: (err: any, data?: RegisterDBProxyTargetsCommandOutput) => void - ): Promise | void { - const command = new RegisterDBProxyTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a - * standalone cluster with read-write capability instead of being read-only and receiving data from a - * primary cluster in a different Region.

- * - *

This action only applies to Aurora DB clusters.

- *
- */ - public removeFromGlobalCluster( + + /** + * @see {@link RemoveFromGlobalClusterCommand} + */ + removeFromGlobalCluster( args: RemoveFromGlobalClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeFromGlobalCluster( + removeFromGlobalCluster( args: RemoveFromGlobalClusterCommandInput, cb: (err: any, data?: RemoveFromGlobalClusterCommandOutput) => void ): void; - public removeFromGlobalCluster( + removeFromGlobalCluster( args: RemoveFromGlobalClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveFromGlobalClusterCommandOutput) => void ): void; - public removeFromGlobalCluster( - args: RemoveFromGlobalClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveFromGlobalClusterCommandOutput) => void), - cb?: (err: any, data?: RemoveFromGlobalClusterCommandOutput) => void - ): Promise | void { - const command = new RemoveFromGlobalClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a - * DB cluster.

- *

For more information on Amazon Aurora DB clusters, see - * - * What is Amazon Aurora? in the Amazon Aurora User Guide.

- *

For more information on Multi-AZ DB clusters, see Multi-AZ DB - * cluster deployments in the Amazon RDS User - * Guide. - *

- */ - public removeRoleFromDBCluster( + + /** + * @see {@link RemoveRoleFromDBClusterCommand} + */ + removeRoleFromDBCluster( args: RemoveRoleFromDBClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeRoleFromDBCluster( + removeRoleFromDBCluster( args: RemoveRoleFromDBClusterCommandInput, cb: (err: any, data?: RemoveRoleFromDBClusterCommandOutput) => void ): void; - public removeRoleFromDBCluster( + removeRoleFromDBCluster( args: RemoveRoleFromDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveRoleFromDBClusterCommandOutput) => void ): void; - public removeRoleFromDBCluster( - args: RemoveRoleFromDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveRoleFromDBClusterCommandOutput) => void), - cb?: (err: any, data?: RemoveRoleFromDBClusterCommandOutput) => void - ): Promise | void { - const command = new RemoveRoleFromDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.

- */ - public removeRoleFromDBInstance( + + /** + * @see {@link RemoveRoleFromDBInstanceCommand} + */ + removeRoleFromDBInstance( args: RemoveRoleFromDBInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeRoleFromDBInstance( + removeRoleFromDBInstance( args: RemoveRoleFromDBInstanceCommandInput, cb: (err: any, data?: RemoveRoleFromDBInstanceCommandOutput) => void ): void; - public removeRoleFromDBInstance( + removeRoleFromDBInstance( args: RemoveRoleFromDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveRoleFromDBInstanceCommandOutput) => void ): void; - public removeRoleFromDBInstance( - args: RemoveRoleFromDBInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveRoleFromDBInstanceCommandOutput) => void), - cb?: (err: any, data?: RemoveRoleFromDBInstanceCommandOutput) => void - ): Promise | void { - const command = new RemoveRoleFromDBInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a source identifier from an existing RDS event notification subscription.

- */ - public removeSourceIdentifierFromSubscription( + + /** + * @see {@link RemoveSourceIdentifierFromSubscriptionCommand} + */ + removeSourceIdentifierFromSubscription( args: RemoveSourceIdentifierFromSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeSourceIdentifierFromSubscription( + removeSourceIdentifierFromSubscription( args: RemoveSourceIdentifierFromSubscriptionCommandInput, cb: (err: any, data?: RemoveSourceIdentifierFromSubscriptionCommandOutput) => void ): void; - public removeSourceIdentifierFromSubscription( + removeSourceIdentifierFromSubscription( args: RemoveSourceIdentifierFromSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveSourceIdentifierFromSubscriptionCommandOutput) => void ): void; - public removeSourceIdentifierFromSubscription( - args: RemoveSourceIdentifierFromSubscriptionCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: RemoveSourceIdentifierFromSubscriptionCommandOutput) => void), - cb?: (err: any, data?: RemoveSourceIdentifierFromSubscriptionCommandOutput) => void - ): Promise | void { - const command = new RemoveSourceIdentifierFromSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes metadata tags from an Amazon RDS resource.

- *

For an overview on tagging an Amazon RDS resource, - * see Tagging Amazon RDS Resources - * in the Amazon RDS User Guide. - *

- */ - public removeTagsFromResource( + + /** + * @see {@link RemoveTagsFromResourceCommand} + */ + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeTagsFromResource( + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void ): void; - public removeTagsFromResource( + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void ): void; - public removeTagsFromResource( - args: RemoveTagsFromResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveTagsFromResourceCommandOutput) => void), - cb?: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void - ): Promise | void { - const command = new RemoveTagsFromResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the parameters of a DB cluster parameter group to the default value. To - * reset specific parameters submit a list of the following: ParameterName - * and ApplyMethod. To reset the - * entire DB cluster parameter group, specify the DBClusterParameterGroupName - * and ResetAllParameters parameters.

- *

When resetting the entire group, dynamic parameters are updated immediately and static parameters - * are set to pending-reboot to take effect on the next DB instance restart - * or RebootDBInstance request. You must call RebootDBInstance for every - * DB instance in your DB cluster that you want the updated static parameter to apply to.

- *

For more information on Amazon Aurora DB clusters, see - * - * What is Amazon Aurora? in the Amazon Aurora User Guide.

- *

For more information on Multi-AZ DB clusters, see Multi-AZ DB - * cluster deployments in the Amazon RDS User - * Guide. - *

- */ - public resetDBClusterParameterGroup( + + /** + * @see {@link ResetDBClusterParameterGroupCommand} + */ + resetDBClusterParameterGroup( args: ResetDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetDBClusterParameterGroup( + resetDBClusterParameterGroup( args: ResetDBClusterParameterGroupCommandInput, cb: (err: any, data?: ResetDBClusterParameterGroupCommandOutput) => void ): void; - public resetDBClusterParameterGroup( + resetDBClusterParameterGroup( args: ResetDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetDBClusterParameterGroupCommandOutput) => void ): void; - public resetDBClusterParameterGroup( - args: ResetDBClusterParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetDBClusterParameterGroupCommandOutput) => void), - cb?: (err: any, data?: ResetDBClusterParameterGroupCommandOutput) => void - ): Promise | void { - const command = new ResetDBClusterParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the parameters of a DB parameter group to the engine/system default value. - * To reset specific parameters, provide a list of the following: - * ParameterName and ApplyMethod. To reset the entire DB - * parameter group, specify the DBParameterGroup name and - * ResetAllParameters parameters. When resetting the entire group, dynamic - * parameters are updated immediately and static parameters are set to - * pending-reboot to take effect on the next DB instance restart or - * RebootDBInstance request.

- */ - public resetDBParameterGroup( + + /** + * @see {@link ResetDBParameterGroupCommand} + */ + resetDBParameterGroup( args: ResetDBParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetDBParameterGroup( + resetDBParameterGroup( args: ResetDBParameterGroupCommandInput, cb: (err: any, data?: ResetDBParameterGroupCommandOutput) => void ): void; - public resetDBParameterGroup( + resetDBParameterGroup( args: ResetDBParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetDBParameterGroupCommandOutput) => void ): void; - public resetDBParameterGroup( - args: ResetDBParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetDBParameterGroupCommandOutput) => void), - cb?: (err: any, data?: ResetDBParameterGroupCommandOutput) => void - ): Promise | void { - const command = new ResetDBParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. - * Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be - * created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the - * Amazon Aurora User Guide.

- * - *

This action only restores the DB cluster, not the DB instances for that DB - * cluster. You must invoke the CreateDBInstance action to create DB - * instances for the restored DB cluster, specifying the identifier of the restored DB - * cluster in DBClusterIdentifier. You can create DB instances only after - * the RestoreDBClusterFromS3 action has completed and the DB - * cluster is available.

- *
- *

For more information on Amazon Aurora, see - * - * What is Amazon Aurora? in the Amazon Aurora User Guide.

- * - *

This action only applies to Aurora DB clusters. The source DB engine must be MySQL.

- *
- */ - public restoreDBClusterFromS3( + + /** + * @see {@link RestoreDBClusterFromS3Command} + */ + restoreDBClusterFromS3( args: RestoreDBClusterFromS3CommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreDBClusterFromS3( + restoreDBClusterFromS3( args: RestoreDBClusterFromS3CommandInput, cb: (err: any, data?: RestoreDBClusterFromS3CommandOutput) => void ): void; - public restoreDBClusterFromS3( + restoreDBClusterFromS3( args: RestoreDBClusterFromS3CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreDBClusterFromS3CommandOutput) => void ): void; - public restoreDBClusterFromS3( - args: RestoreDBClusterFromS3CommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreDBClusterFromS3CommandOutput) => void), - cb?: (err: any, data?: RestoreDBClusterFromS3CommandOutput) => void - ): Promise | void { - const command = new RestoreDBClusterFromS3Command(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

- *

The target DB cluster is created from the source snapshot with a default - * configuration. If you don't specify a security group, the new DB cluster is - * associated with the default security group.

- * - *

This action only restores the DB cluster, not the DB instances for that DB - * cluster. You must invoke the CreateDBInstance action to create DB - * instances for the restored DB cluster, specifying the identifier of the restored DB - * cluster in DBClusterIdentifier. You can create DB instances only after - * the RestoreDBClusterFromSnapshot action has completed and the DB - * cluster is available.

- *
- *

For more information on Amazon Aurora DB clusters, see - * - * What is Amazon Aurora? in the Amazon Aurora User Guide.

- *

For more information on Multi-AZ DB clusters, see Multi-AZ DB - * cluster deployments in the Amazon RDS User - * Guide. - *

- */ - public restoreDBClusterFromSnapshot( + + /** + * @see {@link RestoreDBClusterFromSnapshotCommand} + */ + restoreDBClusterFromSnapshot( args: RestoreDBClusterFromSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreDBClusterFromSnapshot( + restoreDBClusterFromSnapshot( args: RestoreDBClusterFromSnapshotCommandInput, cb: (err: any, data?: RestoreDBClusterFromSnapshotCommandOutput) => void ): void; - public restoreDBClusterFromSnapshot( + restoreDBClusterFromSnapshot( args: RestoreDBClusterFromSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreDBClusterFromSnapshotCommandOutput) => void ): void; - public restoreDBClusterFromSnapshot( - args: RestoreDBClusterFromSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreDBClusterFromSnapshotCommandOutput) => void), - cb?: (err: any, data?: RestoreDBClusterFromSnapshotCommandOutput) => void - ): Promise | void { - const command = new RestoreDBClusterFromSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Restores a DB cluster to an arbitrary point in time. Users can restore to any point - * in time before LatestRestorableTime for up to - * BackupRetentionPeriod days. The target DB cluster is created from the - * source DB cluster with the same configuration as the original DB cluster, except that - * the new DB cluster is created with the default DB security group.

- * - *

For Aurora, this action only restores the DB cluster, not the DB instances for that DB - * cluster. You must invoke the CreateDBInstance action to create DB - * instances for the restored DB cluster, specifying the identifier of the restored DB - * cluster in DBClusterIdentifier. You can create DB instances only after - * the RestoreDBClusterToPointInTime action has completed and the DB - * cluster is available.

- *
- *

For more information on Amazon Aurora DB clusters, see - * - * What is Amazon Aurora? in the Amazon Aurora User Guide.

- *

For more information on Multi-AZ DB clusters, see Multi-AZ DB - * cluster deployments in the Amazon RDS User - * Guide. - *

- */ - public restoreDBClusterToPointInTime( + + /** + * @see {@link RestoreDBClusterToPointInTimeCommand} + */ + restoreDBClusterToPointInTime( args: RestoreDBClusterToPointInTimeCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreDBClusterToPointInTime( + restoreDBClusterToPointInTime( args: RestoreDBClusterToPointInTimeCommandInput, cb: (err: any, data?: RestoreDBClusterToPointInTimeCommandOutput) => void ): void; - public restoreDBClusterToPointInTime( + restoreDBClusterToPointInTime( args: RestoreDBClusterToPointInTimeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreDBClusterToPointInTimeCommandOutput) => void ): void; - public restoreDBClusterToPointInTime( - args: RestoreDBClusterToPointInTimeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreDBClusterToPointInTimeCommandOutput) => void), - cb?: (err: any, data?: RestoreDBClusterToPointInTimeCommandOutput) => void - ): Promise | void { - const command = new RestoreDBClusterToPointInTimeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most - * of the source's original configuration, including the default security group and DB parameter group. By default, the new DB - * instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group - * associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.

- *

If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance - * before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you - * have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as - * the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original - * DB instance with the DB instance created from the snapshot.

- *

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier - * must be the ARN of the shared DB snapshot.

- * - *

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

- *
- */ - public restoreDBInstanceFromDBSnapshot( + + /** + * @see {@link RestoreDBInstanceFromDBSnapshotCommand} + */ + restoreDBInstanceFromDBSnapshot( args: RestoreDBInstanceFromDBSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreDBInstanceFromDBSnapshot( + restoreDBInstanceFromDBSnapshot( args: RestoreDBInstanceFromDBSnapshotCommandInput, cb: (err: any, data?: RestoreDBInstanceFromDBSnapshotCommandOutput) => void ): void; - public restoreDBInstanceFromDBSnapshot( + restoreDBInstanceFromDBSnapshot( args: RestoreDBInstanceFromDBSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreDBInstanceFromDBSnapshotCommandOutput) => void ): void; - public restoreDBInstanceFromDBSnapshot( - args: RestoreDBInstanceFromDBSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreDBInstanceFromDBSnapshotCommandOutput) => void), - cb?: (err: any, data?: RestoreDBInstanceFromDBSnapshotCommandOutput) => void - ): Promise | void { - const command = new RestoreDBInstanceFromDBSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Amazon Relational Database Service (Amazon RDS) - * supports importing MySQL databases by using backup files. - * You can create a backup of your on-premises database, - * store it on Amazon Simple Storage Service (Amazon S3), - * and then restore the backup file onto a new Amazon RDS DB instance running MySQL. - * For more information, see Importing Data into an Amazon RDS MySQL DB Instance - * in the Amazon RDS User Guide. - *

- *

This command doesn't apply to RDS Custom.

- */ - public restoreDBInstanceFromS3( + + /** + * @see {@link RestoreDBInstanceFromS3Command} + */ + restoreDBInstanceFromS3( args: RestoreDBInstanceFromS3CommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreDBInstanceFromS3( + restoreDBInstanceFromS3( args: RestoreDBInstanceFromS3CommandInput, cb: (err: any, data?: RestoreDBInstanceFromS3CommandOutput) => void ): void; - public restoreDBInstanceFromS3( + restoreDBInstanceFromS3( args: RestoreDBInstanceFromS3CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreDBInstanceFromS3CommandOutput) => void ): void; - public restoreDBInstanceFromS3( - args: RestoreDBInstanceFromS3CommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreDBInstanceFromS3CommandOutput) => void), - cb?: (err: any, data?: RestoreDBInstanceFromS3CommandOutput) => void - ): Promise | void { - const command = new RestoreDBInstanceFromS3Command(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

- *

The target database is created with most of the original configuration, but in a - * system-selected Availability Zone, with the default security group, the default subnet - * group, and the default DB parameter group. By default, the new DB instance is created as - * a single-AZ deployment except when the instance is a SQL Server instance that has an - * option group that is associated with mirroring; in this case, the instance becomes a - * mirrored deployment and not a single-AZ deployment.

- * - *

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.

- *
- */ - public restoreDBInstanceToPointInTime( + + /** + * @see {@link RestoreDBInstanceToPointInTimeCommand} + */ + restoreDBInstanceToPointInTime( args: RestoreDBInstanceToPointInTimeCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreDBInstanceToPointInTime( + restoreDBInstanceToPointInTime( args: RestoreDBInstanceToPointInTimeCommandInput, cb: (err: any, data?: RestoreDBInstanceToPointInTimeCommandOutput) => void ): void; - public restoreDBInstanceToPointInTime( + restoreDBInstanceToPointInTime( args: RestoreDBInstanceToPointInTimeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreDBInstanceToPointInTimeCommandOutput) => void ): void; - public restoreDBInstanceToPointInTime( - args: RestoreDBInstanceToPointInTimeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreDBInstanceToPointInTimeCommandOutput) => void), - cb?: (err: any, data?: RestoreDBInstanceToPointInTimeCommandOutput) => void - ): Promise | void { - const command = new RestoreDBInstanceToPointInTimeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required - * parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either - * EC2SecurityGroupName or EC2SecurityGroupId).

- * - *

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that - * you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the - * Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – - * Here’s How to Prepare, and Moving a DB instance not in a VPC - * into a VPC in the Amazon RDS User Guide.

- *
- */ - public revokeDBSecurityGroupIngress( + + /** + * @see {@link RevokeDBSecurityGroupIngressCommand} + */ + revokeDBSecurityGroupIngress( args: RevokeDBSecurityGroupIngressCommandInput, options?: __HttpHandlerOptions ): Promise; - public revokeDBSecurityGroupIngress( + revokeDBSecurityGroupIngress( args: RevokeDBSecurityGroupIngressCommandInput, cb: (err: any, data?: RevokeDBSecurityGroupIngressCommandOutput) => void ): void; - public revokeDBSecurityGroupIngress( + revokeDBSecurityGroupIngress( args: RevokeDBSecurityGroupIngressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeDBSecurityGroupIngressCommandOutput) => void ): void; - public revokeDBSecurityGroupIngress( - args: RevokeDBSecurityGroupIngressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RevokeDBSecurityGroupIngressCommandOutput) => void), - cb?: (err: any, data?: RevokeDBSecurityGroupIngressCommandOutput) => void - ): Promise | void { - const command = new RevokeDBSecurityGroupIngressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a database activity stream to monitor activity on the database. - * For more information, see - * - * Monitoring Amazon Aurora with Database Activity Streams - * in the Amazon Aurora User Guide or - * - * Monitoring Amazon RDS with Database Activity Streams - * in the Amazon RDS User Guide.

- */ - public startActivityStream( + + /** + * @see {@link StartActivityStreamCommand} + */ + startActivityStream( args: StartActivityStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public startActivityStream( + startActivityStream( args: StartActivityStreamCommandInput, cb: (err: any, data?: StartActivityStreamCommandOutput) => void ): void; - public startActivityStream( + startActivityStream( args: StartActivityStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartActivityStreamCommandOutput) => void ): void; - public startActivityStream( - args: StartActivityStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartActivityStreamCommandOutput) => void), - cb?: (err: any, data?: StartActivityStreamCommandOutput) => void - ): Promise | void { - const command = new StartActivityStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster - * CLI command, or the StopDBCluster action.

- *

For more information, see - * - * Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

- * - *

This action only applies to Aurora DB clusters.

- *
- */ - public startDBCluster( + + /** + * @see {@link StartDBClusterCommand} + */ + startDBCluster( args: StartDBClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDBCluster( - args: StartDBClusterCommandInput, - cb: (err: any, data?: StartDBClusterCommandOutput) => void - ): void; - public startDBCluster( + startDBCluster(args: StartDBClusterCommandInput, cb: (err: any, data?: StartDBClusterCommandOutput) => void): void; + startDBCluster( args: StartDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDBClusterCommandOutput) => void ): void; - public startDBCluster( - args: StartDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDBClusterCommandOutput) => void), - cb?: (err: any, data?: StartDBClusterCommandOutput) => void - ): Promise | void { - const command = new StartDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.

- *

For more information, see - * - * Starting an Amazon RDS DB instance That Was Previously Stopped in the - * Amazon RDS User Guide. - *

- * - *

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. - * For Aurora DB clusters, use StartDBCluster instead.

- *
- */ - public startDBInstance( + + /** + * @see {@link StartDBInstanceCommand} + */ + startDBInstance( args: StartDBInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDBInstance( - args: StartDBInstanceCommandInput, - cb: (err: any, data?: StartDBInstanceCommandOutput) => void - ): void; - public startDBInstance( + startDBInstance(args: StartDBInstanceCommandInput, cb: (err: any, data?: StartDBInstanceCommandOutput) => void): void; + startDBInstance( args: StartDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDBInstanceCommandOutput) => void ): void; - public startDBInstance( - args: StartDBInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDBInstanceCommandOutput) => void), - cb?: (err: any, data?: StartDBInstanceCommandOutput) => void - ): Promise | void { - const command = new StartDBInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables replication of automated backups to a different Amazon Web Services Region.

- *

This command doesn't apply to RDS Custom.

- *

For more information, see - * Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide. - *

- */ - public startDBInstanceAutomatedBackupsReplication( + + /** + * @see {@link StartDBInstanceAutomatedBackupsReplicationCommand} + */ + startDBInstanceAutomatedBackupsReplication( args: StartDBInstanceAutomatedBackupsReplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDBInstanceAutomatedBackupsReplication( + startDBInstanceAutomatedBackupsReplication( args: StartDBInstanceAutomatedBackupsReplicationCommandInput, cb: (err: any, data?: StartDBInstanceAutomatedBackupsReplicationCommandOutput) => void ): void; - public startDBInstanceAutomatedBackupsReplication( + startDBInstanceAutomatedBackupsReplication( args: StartDBInstanceAutomatedBackupsReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDBInstanceAutomatedBackupsReplicationCommandOutput) => void ): void; - public startDBInstanceAutomatedBackupsReplication( - args: StartDBInstanceAutomatedBackupsReplicationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: StartDBInstanceAutomatedBackupsReplicationCommandOutput) => void), - cb?: (err: any, data?: StartDBInstanceAutomatedBackupsReplicationCommandOutput) => void - ): Promise | void { - const command = new StartDBInstanceAutomatedBackupsReplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts an export of DB snapshot or DB cluster data to Amazon S3. - * The provided IAM role must have access to the S3 bucket.

- *

You can't export snapshot data from RDS Custom DB instances.

- *

You can't export cluster data from Multi-AZ DB clusters.

- *

For more information on exporting DB snapshot data, see - * Exporting DB snapshot - * data to Amazon S3 in the Amazon RDS User Guide - * or Exporting DB - * cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.

- *

For more information on exporting DB cluster data, see - * Exporting DB - * cluster data to Amazon S3 in the Amazon Aurora User Guide.

- */ - public startExportTask( + + /** + * @see {@link StartExportTaskCommand} + */ + startExportTask( args: StartExportTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public startExportTask( - args: StartExportTaskCommandInput, - cb: (err: any, data?: StartExportTaskCommandOutput) => void - ): void; - public startExportTask( + startExportTask(args: StartExportTaskCommandInput, cb: (err: any, data?: StartExportTaskCommandOutput) => void): void; + startExportTask( args: StartExportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartExportTaskCommandOutput) => void ): void; - public startExportTask( - args: StartExportTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartExportTaskCommandOutput) => void), - cb?: (err: any, data?: StartExportTaskCommandOutput) => void - ): Promise | void { - const command = new StartExportTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a database activity stream that was started using the Amazon Web Services console, - * the start-activity-stream CLI command, or the StartActivityStream action.

- *

For more information, see - * - * Monitoring Amazon Aurora with Database Activity Streams - * in the Amazon Aurora User Guide - * or - * Monitoring Amazon RDS with Database Activity Streams - * in the Amazon RDS User Guide.

- */ - public stopActivityStream( + + /** + * @see {@link StopActivityStreamCommand} + */ + stopActivityStream( args: StopActivityStreamCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopActivityStream( + stopActivityStream( args: StopActivityStreamCommandInput, cb: (err: any, data?: StopActivityStreamCommandOutput) => void ): void; - public stopActivityStream( + stopActivityStream( args: StopActivityStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopActivityStreamCommandOutput) => void ): void; - public stopActivityStream( - args: StopActivityStreamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopActivityStreamCommandOutput) => void), - cb?: (err: any, data?: StopActivityStreamCommandOutput) => void - ): Promise | void { - const command = new StopActivityStreamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's - * metadata, including its endpoints and DB parameter groups. Aurora also - * retains the transaction logs so you can do a point-in-time restore if necessary.

- *

For more information, see - * - * Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

- * - *

This action only applies to Aurora DB clusters.

- *
- */ - public stopDBCluster( - args: StopDBClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public stopDBCluster( - args: StopDBClusterCommandInput, - cb: (err: any, data?: StopDBClusterCommandOutput) => void - ): void; - public stopDBCluster( + + /** + * @see {@link StopDBClusterCommand} + */ + stopDBCluster(args: StopDBClusterCommandInput, options?: __HttpHandlerOptions): Promise; + stopDBCluster(args: StopDBClusterCommandInput, cb: (err: any, data?: StopDBClusterCommandOutput) => void): void; + stopDBCluster( args: StopDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDBClusterCommandOutput) => void ): void; - public stopDBCluster( - args: StopDBClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopDBClusterCommandOutput) => void), - cb?: (err: any, data?: StopDBClusterCommandOutput) => void - ): Promise | void { - const command = new StopDBClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, - * DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if - * necessary.

- *

For more information, see - * - * Stopping an Amazon RDS DB Instance Temporarily in the - * Amazon RDS User Guide. - *

- * - *

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. - * For Aurora clusters, use StopDBCluster instead.

- *
- */ - public stopDBInstance( + + /** + * @see {@link StopDBInstanceCommand} + */ + stopDBInstance( args: StopDBInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopDBInstance( - args: StopDBInstanceCommandInput, - cb: (err: any, data?: StopDBInstanceCommandOutput) => void - ): void; - public stopDBInstance( + stopDBInstance(args: StopDBInstanceCommandInput, cb: (err: any, data?: StopDBInstanceCommandOutput) => void): void; + stopDBInstance( args: StopDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDBInstanceCommandOutput) => void ): void; - public stopDBInstance( - args: StopDBInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopDBInstanceCommandOutput) => void), - cb?: (err: any, data?: StopDBInstanceCommandOutput) => void - ): Promise | void { - const command = new StopDBInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops automated backup replication for a DB instance.

- *

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.

- *

For more information, see - * Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide. - *

- */ - public stopDBInstanceAutomatedBackupsReplication( + + /** + * @see {@link StopDBInstanceAutomatedBackupsReplicationCommand} + */ + stopDBInstanceAutomatedBackupsReplication( args: StopDBInstanceAutomatedBackupsReplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopDBInstanceAutomatedBackupsReplication( + stopDBInstanceAutomatedBackupsReplication( args: StopDBInstanceAutomatedBackupsReplicationCommandInput, cb: (err: any, data?: StopDBInstanceAutomatedBackupsReplicationCommandOutput) => void ): void; - public stopDBInstanceAutomatedBackupsReplication( + stopDBInstanceAutomatedBackupsReplication( args: StopDBInstanceAutomatedBackupsReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDBInstanceAutomatedBackupsReplicationCommandOutput) => void ): void; - public stopDBInstanceAutomatedBackupsReplication( - args: StopDBInstanceAutomatedBackupsReplicationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: StopDBInstanceAutomatedBackupsReplicationCommandOutput) => void), - cb?: (err: any, data?: StopDBInstanceAutomatedBackupsReplicationCommandOutput) => void - ): Promise | void { - const command = new StopDBInstanceAutomatedBackupsReplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Switches over a blue/green deployment.

- *

Before you switch over, production traffic is routed to the databases in the blue environment. - * After you switch over, production traffic is routed to the databases in the green environment.

- *

For more information, see Using Amazon RDS Blue/Green Deployments - * for database updates in the Amazon RDS User Guide and - * - * Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora - * User Guide.

- */ - public switchoverBlueGreenDeployment( + + /** + * @see {@link SwitchoverBlueGreenDeploymentCommand} + */ + switchoverBlueGreenDeployment( args: SwitchoverBlueGreenDeploymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public switchoverBlueGreenDeployment( + switchoverBlueGreenDeployment( args: SwitchoverBlueGreenDeploymentCommandInput, cb: (err: any, data?: SwitchoverBlueGreenDeploymentCommandOutput) => void ): void; - public switchoverBlueGreenDeployment( + switchoverBlueGreenDeployment( args: SwitchoverBlueGreenDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SwitchoverBlueGreenDeploymentCommandOutput) => void ): void; - public switchoverBlueGreenDeployment( - args: SwitchoverBlueGreenDeploymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SwitchoverBlueGreenDeploymentCommandOutput) => void), - cb?: (err: any, data?: SwitchoverBlueGreenDeploymentCommandOutput) => void - ): Promise | void { - const command = new SwitchoverBlueGreenDeploymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new - * primary database. Issue this command in the Region that hosts the current standby database.

- */ - public switchoverReadReplica( + + /** + * @see {@link SwitchoverReadReplicaCommand} + */ + switchoverReadReplica( args: SwitchoverReadReplicaCommandInput, options?: __HttpHandlerOptions ): Promise; - public switchoverReadReplica( + switchoverReadReplica( args: SwitchoverReadReplicaCommandInput, cb: (err: any, data?: SwitchoverReadReplicaCommandOutput) => void ): void; - public switchoverReadReplica( + switchoverReadReplica( args: SwitchoverReadReplicaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SwitchoverReadReplicaCommandOutput) => void ): void; - public switchoverReadReplica( - args: SwitchoverReadReplicaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SwitchoverReadReplicaCommandOutput) => void), - cb?: (err: any, data?: SwitchoverReadReplicaCommandOutput) => void - ): Promise | void { - const command = new SwitchoverReadReplicaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Relational Database Service + *

+ *

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and + * scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational + * database and manages common database administration tasks, freeing up developers to focus on what makes their applications + * and businesses unique.

+ *

Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, + * Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools + * you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS + * automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS + * is flexible: you can scale your DB instance's compute resources and storage capacity to meet your + * application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for + * the resources you use.

+ *

This interface reference for Amazon RDS contains documentation for a programming or command line interface + * you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might + * require techniques such as polling or callback functions to determine when a command has been applied. In this + * reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, + * or during the maintenance window. The reference structure is as follows, and we list following some related topics + * from the user guide.

+ *

+ * Amazon RDS API Reference + *

+ *
    + *
  • + *

    For the alphabetical list of API actions, see + * API Actions.

    + *
  • + *
  • + *

    For the alphabetical list of data types, see + * Data Types.

    + *
  • + *
  • + *

    For a list of common query parameters, see + * Common Parameters.

    + *
  • + *
  • + *

    For descriptions of the error codes, see + * Common Errors.

    + *
  • + *
+ *

+ * Amazon RDS User Guide + *

+ * + */ +export class RDS extends RDSClient implements RDS {} +createAggregatedClient(commands, RDS); diff --git a/clients/client-redshift-data/src/RedshiftData.ts b/clients/client-redshift-data/src/RedshiftData.ts index f8b1491f50d7..37b268b02f0f 100644 --- a/clients/client-redshift-data/src/RedshiftData.ts +++ b/clients/client-redshift-data/src/RedshiftData.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -43,566 +44,170 @@ import { ListStatementsCommandOutput, } from "./commands/ListStatementsCommand"; import { ListTablesCommand, ListTablesCommandInput, ListTablesCommandOutput } from "./commands/ListTablesCommand"; -import { RedshiftDataClient } from "./RedshiftDataClient"; +import { RedshiftDataClient, RedshiftDataClientConfig } from "./RedshiftDataClient"; -/** - * @public - *

You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You - * can run SQL statements, which are committed if the statement succeeds.

- *

For more information about the Amazon Redshift Data API and CLI usage examples, see - * Using the Amazon Redshift Data API in the - * Amazon Redshift Management Guide.

- */ -export class RedshiftData extends RedshiftDataClient { +const commands = { + BatchExecuteStatementCommand, + CancelStatementCommand, + DescribeStatementCommand, + DescribeTableCommand, + ExecuteStatementCommand, + GetStatementResultCommand, + ListDatabasesCommand, + ListSchemasCommand, + ListStatementsCommand, + ListTablesCommand, +}; + +export interface RedshiftData { /** - * @public - *

Runs one or more SQL statements, which can be data manipulation language (DML) or data definition - * language (DDL). - * Depending on the authorization - * method, use one of the following combinations of request parameters:

- *
    - *
  • - *

    Secrets Manager - when connecting to a cluster, provide the secret-arn of a secret - * stored in Secrets Manager which has username and password. - * The specified secret contains credentials - * to connect to the database you specify. - * When you are connecting to a cluster, you also supply the database name, - * If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. - * When you are connecting to a serverless workgroup, you also supply the database name.

    - *
  • - *
  • - *

    Temporary credentials - when connecting to your data warehouse, choose one of the following options:

    - *
      - *
    • - *

      When connecting to a serverless workgroup, specify the workgroup name and database name. - * The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. - * Also, permission to call the redshift-serverless:GetCredentials operation is required.

      - *
    • - *
    • - *

      When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. - * The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. - * Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

      - *
    • - *
    • - *

      When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. - * Also, permission to call the redshift:GetClusterCredentials operation is required.

      - *
    • - *
    - *
  • - *
- *

For more information about the Amazon Redshift Data API and CLI usage examples, see - * Using the Amazon Redshift Data API in the - * Amazon Redshift Management Guide.

+ * @see {@link BatchExecuteStatementCommand} */ - public batchExecuteStatement( + batchExecuteStatement( args: BatchExecuteStatementCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchExecuteStatement( + batchExecuteStatement( args: BatchExecuteStatementCommandInput, cb: (err: any, data?: BatchExecuteStatementCommandOutput) => void ): void; - public batchExecuteStatement( + batchExecuteStatement( args: BatchExecuteStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchExecuteStatementCommandOutput) => void ): void; - public batchExecuteStatement( - args: BatchExecuteStatementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchExecuteStatementCommandOutput) => void), - cb?: (err: any, data?: BatchExecuteStatementCommandOutput) => void - ): Promise | void { - const command = new BatchExecuteStatementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels a running query. To be canceled, a query must be running.

- *

For more information about the Amazon Redshift Data API and CLI usage examples, see - * Using the Amazon Redshift Data API in the - * Amazon Redshift Management Guide.

+ * @see {@link CancelStatementCommand} */ - public cancelStatement( + cancelStatement( args: CancelStatementCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelStatement( - args: CancelStatementCommandInput, - cb: (err: any, data?: CancelStatementCommandOutput) => void - ): void; - public cancelStatement( + cancelStatement(args: CancelStatementCommandInput, cb: (err: any, data?: CancelStatementCommandOutput) => void): void; + cancelStatement( args: CancelStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelStatementCommandOutput) => void ): void; - public cancelStatement( - args: CancelStatementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelStatementCommandOutput) => void), - cb?: (err: any, data?: CancelStatementCommandOutput) => void - ): Promise | void { - const command = new CancelStatementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information - * includes when the query started, when it finished, the query status, the number of rows returned, and the SQL - * statement.

- *

For more information about the Amazon Redshift Data API and CLI usage examples, see - * Using the Amazon Redshift Data API in the - * Amazon Redshift Management Guide.

+ * @see {@link DescribeStatementCommand} */ - public describeStatement( + describeStatement( args: DescribeStatementCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStatement( + describeStatement( args: DescribeStatementCommandInput, cb: (err: any, data?: DescribeStatementCommandOutput) => void ): void; - public describeStatement( + describeStatement( args: DescribeStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStatementCommandOutput) => void ): void; - public describeStatement( - args: DescribeStatementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStatementCommandOutput) => void), - cb?: (err: any, data?: DescribeStatementCommandOutput) => void - ): Promise | void { - const command = new DescribeStatementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the detailed information about a table from metadata in the cluster. The - * information includes its columns. - * A token is returned to page through the column list. - * Depending on the authorization method, use one of the - * following combinations of request parameters:

- *
    - *
  • - *

    Secrets Manager - when connecting to a cluster, provide the secret-arn of a secret - * stored in Secrets Manager which has username and password. - * The specified secret contains credentials - * to connect to the database you specify. - * When you are connecting to a cluster, you also supply the database name, - * If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. - * When you are connecting to a serverless workgroup, you also supply the database name.

    - *
  • - *
  • - *

    Temporary credentials - when connecting to your data warehouse, choose one of the following options:

    - *
      - *
    • - *

      When connecting to a serverless workgroup, specify the workgroup name and database name. - * The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. - * Also, permission to call the redshift-serverless:GetCredentials operation is required.

      - *
    • - *
    • - *

      When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. - * The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. - * Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

      - *
    • - *
    • - *

      When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. - * Also, permission to call the redshift:GetClusterCredentials operation is required.

      - *
    • - *
    - *
  • - *
- *

For more information about the Amazon Redshift Data API and CLI usage examples, see - * Using the Amazon Redshift Data API in the - * Amazon Redshift Management Guide.

+ * @see {@link DescribeTableCommand} */ - public describeTable( - args: DescribeTableCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeTable( - args: DescribeTableCommandInput, - cb: (err: any, data?: DescribeTableCommandOutput) => void - ): void; - public describeTable( + describeTable(args: DescribeTableCommandInput, options?: __HttpHandlerOptions): Promise; + describeTable(args: DescribeTableCommandInput, cb: (err: any, data?: DescribeTableCommandOutput) => void): void; + describeTable( args: DescribeTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTableCommandOutput) => void ): void; - public describeTable( - args: DescribeTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTableCommandOutput) => void), - cb?: (err: any, data?: DescribeTableCommandOutput) => void - ): Promise | void { - const command = new DescribeTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Runs an SQL statement, which can be data manipulation language (DML) or data definition - * language (DDL). This statement must be a single SQL statement. - * Depending on the authorization - * method, use one of the following combinations of request parameters:

- *
    - *
  • - *

    Secrets Manager - when connecting to a cluster, provide the secret-arn of a secret - * stored in Secrets Manager which has username and password. - * The specified secret contains credentials - * to connect to the database you specify. - * When you are connecting to a cluster, you also supply the database name, - * If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. - * When you are connecting to a serverless workgroup, you also supply the database name.

    - *
  • - *
  • - *

    Temporary credentials - when connecting to your data warehouse, choose one of the following options:

    - *
      - *
    • - *

      When connecting to a serverless workgroup, specify the workgroup name and database name. - * The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. - * Also, permission to call the redshift-serverless:GetCredentials operation is required.

      - *
    • - *
    • - *

      When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. - * The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. - * Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

      - *
    • - *
    • - *

      When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. - * Also, permission to call the redshift:GetClusterCredentials operation is required.

      - *
    • - *
    - *
  • - *
- *

For more information about the Amazon Redshift Data API and CLI usage examples, see - * Using the Amazon Redshift Data API in the - * Amazon Redshift Management Guide.

+ * @see {@link ExecuteStatementCommand} */ - public executeStatement( + executeStatement( args: ExecuteStatementCommandInput, options?: __HttpHandlerOptions ): Promise; - public executeStatement( + executeStatement( args: ExecuteStatementCommandInput, cb: (err: any, data?: ExecuteStatementCommandOutput) => void ): void; - public executeStatement( + executeStatement( args: ExecuteStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteStatementCommandOutput) => void ): void; - public executeStatement( - args: ExecuteStatementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExecuteStatementCommandOutput) => void), - cb?: (err: any, data?: ExecuteStatementCommandOutput) => void - ): Promise | void { - const command = new ExecuteStatementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Fetches the temporarily cached result of an SQL statement. - * A token is returned to page through the statement results.

- *

For more information about the Amazon Redshift Data API and CLI usage examples, see - * Using the Amazon Redshift Data API in the - * Amazon Redshift Management Guide.

+ * @see {@link GetStatementResultCommand} */ - public getStatementResult( + getStatementResult( args: GetStatementResultCommandInput, options?: __HttpHandlerOptions ): Promise; - public getStatementResult( + getStatementResult( args: GetStatementResultCommandInput, cb: (err: any, data?: GetStatementResultCommandOutput) => void ): void; - public getStatementResult( + getStatementResult( args: GetStatementResultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStatementResultCommandOutput) => void ): void; - public getStatementResult( - args: GetStatementResultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStatementResultCommandOutput) => void), - cb?: (err: any, data?: GetStatementResultCommandOutput) => void - ): Promise | void { - const command = new GetStatementResultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the databases in a cluster. - * A token is returned to page through the database list. - * Depending on the authorization method, use one of the - * following combinations of request parameters:

- *
    - *
  • - *

    Secrets Manager - when connecting to a cluster, provide the secret-arn of a secret - * stored in Secrets Manager which has username and password. - * The specified secret contains credentials - * to connect to the database you specify. - * When you are connecting to a cluster, you also supply the database name, - * If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. - * When you are connecting to a serverless workgroup, you also supply the database name.

    - *
  • - *
  • - *

    Temporary credentials - when connecting to your data warehouse, choose one of the following options:

    - *
      - *
    • - *

      When connecting to a serverless workgroup, specify the workgroup name and database name. - * The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. - * Also, permission to call the redshift-serverless:GetCredentials operation is required.

      - *
    • - *
    • - *

      When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. - * The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. - * Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

      - *
    • - *
    • - *

      When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. - * Also, permission to call the redshift:GetClusterCredentials operation is required.

      - *
    • - *
    - *
  • - *
- *

For more information about the Amazon Redshift Data API and CLI usage examples, see - * Using the Amazon Redshift Data API in the - * Amazon Redshift Management Guide.

+ * @see {@link ListDatabasesCommand} */ - public listDatabases( - args: ListDatabasesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listDatabases( - args: ListDatabasesCommandInput, - cb: (err: any, data?: ListDatabasesCommandOutput) => void - ): void; - public listDatabases( + listDatabases(args: ListDatabasesCommandInput, options?: __HttpHandlerOptions): Promise; + listDatabases(args: ListDatabasesCommandInput, cb: (err: any, data?: ListDatabasesCommandOutput) => void): void; + listDatabases( args: ListDatabasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatabasesCommandOutput) => void ): void; - public listDatabases( - args: ListDatabasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatabasesCommandOutput) => void), - cb?: (err: any, data?: ListDatabasesCommandOutput) => void - ): Promise | void { - const command = new ListDatabasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the schemas in a database. - * A token is returned to page through the schema list. - * Depending on the authorization method, use one of the - * following combinations of request parameters:

- *
    - *
  • - *

    Secrets Manager - when connecting to a cluster, provide the secret-arn of a secret - * stored in Secrets Manager which has username and password. - * The specified secret contains credentials - * to connect to the database you specify. - * When you are connecting to a cluster, you also supply the database name, - * If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. - * When you are connecting to a serverless workgroup, you also supply the database name.

    - *
  • - *
  • - *

    Temporary credentials - when connecting to your data warehouse, choose one of the following options:

    - *
      - *
    • - *

      When connecting to a serverless workgroup, specify the workgroup name and database name. - * The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. - * Also, permission to call the redshift-serverless:GetCredentials operation is required.

      - *
    • - *
    • - *

      When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. - * The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. - * Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

      - *
    • - *
    • - *

      When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. - * Also, permission to call the redshift:GetClusterCredentials operation is required.

      - *
    • - *
    - *
  • - *
- *

For more information about the Amazon Redshift Data API and CLI usage examples, see - * Using the Amazon Redshift Data API in the - * Amazon Redshift Management Guide.

+ * @see {@link ListSchemasCommand} */ - public listSchemas(args: ListSchemasCommandInput, options?: __HttpHandlerOptions): Promise; - public listSchemas(args: ListSchemasCommandInput, cb: (err: any, data?: ListSchemasCommandOutput) => void): void; - public listSchemas( + listSchemas(args: ListSchemasCommandInput, options?: __HttpHandlerOptions): Promise; + listSchemas(args: ListSchemasCommandInput, cb: (err: any, data?: ListSchemasCommandOutput) => void): void; + listSchemas( args: ListSchemasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSchemasCommandOutput) => void ): void; - public listSchemas( - args: ListSchemasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSchemasCommandOutput) => void), - cb?: (err: any, data?: ListSchemasCommandOutput) => void - ): Promise | void { - const command = new ListSchemasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List of SQL statements. By default, only finished statements are shown. - * A token is returned to page through the statement list.

- *

For more information about the Amazon Redshift Data API and CLI usage examples, see - * Using the Amazon Redshift Data API in the - * Amazon Redshift Management Guide.

+ * @see {@link ListStatementsCommand} */ - public listStatements( + listStatements( args: ListStatementsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStatements( - args: ListStatementsCommandInput, - cb: (err: any, data?: ListStatementsCommandOutput) => void - ): void; - public listStatements( + listStatements(args: ListStatementsCommandInput, cb: (err: any, data?: ListStatementsCommandOutput) => void): void; + listStatements( args: ListStatementsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStatementsCommandOutput) => void ): void; - public listStatements( - args: ListStatementsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStatementsCommandOutput) => void), - cb?: (err: any, data?: ListStatementsCommandOutput) => void - ): Promise | void { - const command = new ListStatementsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then - * all tables in the database are returned. - * A token is returned to page through the table list. - * Depending on the authorization method, use one of the - * following combinations of request parameters:

- *
    - *
  • - *

    Secrets Manager - when connecting to a cluster, provide the secret-arn of a secret - * stored in Secrets Manager which has username and password. - * The specified secret contains credentials - * to connect to the database you specify. - * When you are connecting to a cluster, you also supply the database name, - * If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. - * When you are connecting to a serverless workgroup, you also supply the database name.

    - *
  • - *
  • - *

    Temporary credentials - when connecting to your data warehouse, choose one of the following options:

    - *
      - *
    • - *

      When connecting to a serverless workgroup, specify the workgroup name and database name. - * The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. - * Also, permission to call the redshift-serverless:GetCredentials operation is required.

      - *
    • - *
    • - *

      When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. - * The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. - * Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

      - *
    • - *
    • - *

      When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. - * Also, permission to call the redshift:GetClusterCredentials operation is required.

      - *
    • - *
    - *
  • - *
- *

For more information about the Amazon Redshift Data API and CLI usage examples, see - * Using the Amazon Redshift Data API in the - * Amazon Redshift Management Guide.

+ * @see {@link ListTablesCommand} */ - public listTables(args: ListTablesCommandInput, options?: __HttpHandlerOptions): Promise; - public listTables(args: ListTablesCommandInput, cb: (err: any, data?: ListTablesCommandOutput) => void): void; - public listTables( + listTables(args: ListTablesCommandInput, options?: __HttpHandlerOptions): Promise; + listTables(args: ListTablesCommandInput, cb: (err: any, data?: ListTablesCommandOutput) => void): void; + listTables( args: ListTablesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTablesCommandOutput) => void ): void; - public listTables( - args: ListTablesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTablesCommandOutput) => void), - cb?: (err: any, data?: ListTablesCommandOutput) => void - ): Promise | void { - const command = new ListTablesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You + * can run SQL statements, which are committed if the statement succeeds.

+ *

For more information about the Amazon Redshift Data API and CLI usage examples, see + * Using the Amazon Redshift Data API in the + * Amazon Redshift Management Guide.

+ */ +export class RedshiftData extends RedshiftDataClient implements RedshiftData {} +createAggregatedClient(commands, RedshiftData); diff --git a/clients/client-redshift-serverless/src/RedshiftServerless.ts b/clients/client-redshift-serverless/src/RedshiftServerless.ts index c6ee019eede9..68b398552e6a 100644 --- a/clients/client-redshift-serverless/src/RedshiftServerless.ts +++ b/clients/client-redshift-serverless/src/RedshiftServerless.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -193,1343 +194,666 @@ import { UpdateWorkgroupCommandInput, UpdateWorkgroupCommandOutput, } from "./commands/UpdateWorkgroupCommand"; -import { RedshiftServerlessClient } from "./RedshiftServerlessClient"; +import { RedshiftServerlessClient, RedshiftServerlessClientConfig } from "./RedshiftServerlessClient"; -/** - * @public - *

This is an interface reference for Amazon Redshift Serverless. - * It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift Serverless. - *

- *

Amazon Redshift Serverless automatically provisions data warehouse capacity and intelligently scales the - * underlying resources based on workload demands. Amazon Redshift Serverless adjusts capacity in seconds to deliver consistently high - * performance and simplified operations for even the most demanding and volatile workloads. Amazon Redshift Serverless lets you - * focus on using your data to acquire new insights for your business and customers. - *

- *

- * To learn more about Amazon Redshift Serverless, - * see What is Amazon Redshift Serverless. - *

- */ -export class RedshiftServerless extends RedshiftServerlessClient { +const commands = { + ConvertRecoveryPointToSnapshotCommand, + CreateEndpointAccessCommand, + CreateNamespaceCommand, + CreateSnapshotCommand, + CreateUsageLimitCommand, + CreateWorkgroupCommand, + DeleteEndpointAccessCommand, + DeleteNamespaceCommand, + DeleteResourcePolicyCommand, + DeleteSnapshotCommand, + DeleteUsageLimitCommand, + DeleteWorkgroupCommand, + GetCredentialsCommand, + GetEndpointAccessCommand, + GetNamespaceCommand, + GetRecoveryPointCommand, + GetResourcePolicyCommand, + GetSnapshotCommand, + GetTableRestoreStatusCommand, + GetUsageLimitCommand, + GetWorkgroupCommand, + ListEndpointAccessCommand, + ListNamespacesCommand, + ListRecoveryPointsCommand, + ListSnapshotsCommand, + ListTableRestoreStatusCommand, + ListTagsForResourceCommand, + ListUsageLimitsCommand, + ListWorkgroupsCommand, + PutResourcePolicyCommand, + RestoreFromRecoveryPointCommand, + RestoreFromSnapshotCommand, + RestoreTableFromSnapshotCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateEndpointAccessCommand, + UpdateNamespaceCommand, + UpdateSnapshotCommand, + UpdateUsageLimitCommand, + UpdateWorkgroupCommand, +}; + +export interface RedshiftServerless { /** - * @public - *

Converts a recovery point to a snapshot. For more information about recovery points and snapshots, - * see Working with snapshots and recovery points.

+ * @see {@link ConvertRecoveryPointToSnapshotCommand} */ - public convertRecoveryPointToSnapshot( + convertRecoveryPointToSnapshot( args: ConvertRecoveryPointToSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public convertRecoveryPointToSnapshot( + convertRecoveryPointToSnapshot( args: ConvertRecoveryPointToSnapshotCommandInput, cb: (err: any, data?: ConvertRecoveryPointToSnapshotCommandOutput) => void ): void; - public convertRecoveryPointToSnapshot( + convertRecoveryPointToSnapshot( args: ConvertRecoveryPointToSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConvertRecoveryPointToSnapshotCommandOutput) => void ): void; - public convertRecoveryPointToSnapshot( - args: ConvertRecoveryPointToSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConvertRecoveryPointToSnapshotCommandOutput) => void), - cb?: (err: any, data?: ConvertRecoveryPointToSnapshotCommandOutput) => void - ): Promise | void { - const command = new ConvertRecoveryPointToSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Amazon Redshift Serverless managed VPC endpoint.

+ * @see {@link CreateEndpointAccessCommand} */ - public createEndpointAccess( + createEndpointAccess( args: CreateEndpointAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEndpointAccess( + createEndpointAccess( args: CreateEndpointAccessCommandInput, cb: (err: any, data?: CreateEndpointAccessCommandOutput) => void ): void; - public createEndpointAccess( + createEndpointAccess( args: CreateEndpointAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEndpointAccessCommandOutput) => void ): void; - public createEndpointAccess( - args: CreateEndpointAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEndpointAccessCommandOutput) => void), - cb?: (err: any, data?: CreateEndpointAccessCommandOutput) => void - ): Promise | void { - const command = new CreateEndpointAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a namespace in Amazon Redshift Serverless.

+ * @see {@link CreateNamespaceCommand} */ - public createNamespace( + createNamespace( args: CreateNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNamespace( - args: CreateNamespaceCommandInput, - cb: (err: any, data?: CreateNamespaceCommandOutput) => void - ): void; - public createNamespace( + createNamespace(args: CreateNamespaceCommandInput, cb: (err: any, data?: CreateNamespaceCommandOutput) => void): void; + createNamespace( args: CreateNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNamespaceCommandOutput) => void ): void; - public createNamespace( - args: CreateNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNamespaceCommandOutput) => void), - cb?: (err: any, data?: CreateNamespaceCommandOutput) => void - ): Promise | void { - const command = new CreateNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a snapshot of all databases in a namespace. - * For more information about snapshots, see - * - * Working with snapshots and recovery points.

+ * @see {@link CreateSnapshotCommand} */ - public createSnapshot( + createSnapshot( args: CreateSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSnapshot( - args: CreateSnapshotCommandInput, - cb: (err: any, data?: CreateSnapshotCommandOutput) => void - ): void; - public createSnapshot( + createSnapshot(args: CreateSnapshotCommandInput, cb: (err: any, data?: CreateSnapshotCommandOutput) => void): void; + createSnapshot( args: CreateSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSnapshotCommandOutput) => void ): void; - public createSnapshot( - args: CreateSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSnapshotCommandOutput) => void), - cb?: (err: any, data?: CreateSnapshotCommandOutput) => void - ): Promise | void { - const command = new CreateSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier. - *

+ * @see {@link CreateUsageLimitCommand} */ - public createUsageLimit( + createUsageLimit( args: CreateUsageLimitCommandInput, options?: __HttpHandlerOptions ): Promise; - public createUsageLimit( + createUsageLimit( args: CreateUsageLimitCommandInput, cb: (err: any, data?: CreateUsageLimitCommandOutput) => void ): void; - public createUsageLimit( + createUsageLimit( args: CreateUsageLimitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUsageLimitCommandOutput) => void ): void; - public createUsageLimit( - args: CreateUsageLimitCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUsageLimitCommandOutput) => void), - cb?: (err: any, data?: CreateUsageLimitCommandOutput) => void - ): Promise | void { - const command = new CreateUsageLimitCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an workgroup in Amazon Redshift Serverless.

+ * @see {@link CreateWorkgroupCommand} */ - public createWorkgroup( + createWorkgroup( args: CreateWorkgroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorkgroup( - args: CreateWorkgroupCommandInput, - cb: (err: any, data?: CreateWorkgroupCommandOutput) => void - ): void; - public createWorkgroup( + createWorkgroup(args: CreateWorkgroupCommandInput, cb: (err: any, data?: CreateWorkgroupCommandOutput) => void): void; + createWorkgroup( args: CreateWorkgroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkgroupCommandOutput) => void ): void; - public createWorkgroup( - args: CreateWorkgroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorkgroupCommandOutput) => void), - cb?: (err: any, data?: CreateWorkgroupCommandOutput) => void - ): Promise | void { - const command = new CreateWorkgroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon Redshift Serverless managed VPC endpoint.

+ * @see {@link DeleteEndpointAccessCommand} */ - public deleteEndpointAccess( + deleteEndpointAccess( args: DeleteEndpointAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEndpointAccess( + deleteEndpointAccess( args: DeleteEndpointAccessCommandInput, cb: (err: any, data?: DeleteEndpointAccessCommandOutput) => void ): void; - public deleteEndpointAccess( + deleteEndpointAccess( args: DeleteEndpointAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEndpointAccessCommandOutput) => void ): void; - public deleteEndpointAccess( - args: DeleteEndpointAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEndpointAccessCommandOutput) => void), - cb?: (err: any, data?: DeleteEndpointAccessCommandOutput) => void - ): Promise | void { - const command = new DeleteEndpointAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a namespace from Amazon Redshift Serverless. - * Before you delete the namespace, you can create a final snapshot that has all of the data within the namespace.

+ * @see {@link DeleteNamespaceCommand} */ - public deleteNamespace( + deleteNamespace( args: DeleteNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNamespace( - args: DeleteNamespaceCommandInput, - cb: (err: any, data?: DeleteNamespaceCommandOutput) => void - ): void; - public deleteNamespace( + deleteNamespace(args: DeleteNamespaceCommandInput, cb: (err: any, data?: DeleteNamespaceCommandOutput) => void): void; + deleteNamespace( args: DeleteNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNamespaceCommandOutput) => void ): void; - public deleteNamespace( - args: DeleteNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNamespaceCommandOutput) => void), - cb?: (err: any, data?: DeleteNamespaceCommandOutput) => void - ): Promise | void { - const command = new DeleteNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified resource policy.

+ * @see {@link DeleteResourcePolicyCommand} */ - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( - args: DeleteResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a snapshot from Amazon Redshift Serverless.

+ * @see {@link DeleteSnapshotCommand} */ - public deleteSnapshot( + deleteSnapshot( args: DeleteSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSnapshot( - args: DeleteSnapshotCommandInput, - cb: (err: any, data?: DeleteSnapshotCommandOutput) => void - ): void; - public deleteSnapshot( + deleteSnapshot(args: DeleteSnapshotCommandInput, cb: (err: any, data?: DeleteSnapshotCommandOutput) => void): void; + deleteSnapshot( args: DeleteSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSnapshotCommandOutput) => void ): void; - public deleteSnapshot( - args: DeleteSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSnapshotCommandOutput) => void), - cb?: (err: any, data?: DeleteSnapshotCommandOutput) => void - ): Promise | void { - const command = new DeleteSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a usage limit from Amazon Redshift Serverless.

+ * @see {@link DeleteUsageLimitCommand} */ - public deleteUsageLimit( + deleteUsageLimit( args: DeleteUsageLimitCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteUsageLimit( + deleteUsageLimit( args: DeleteUsageLimitCommandInput, cb: (err: any, data?: DeleteUsageLimitCommandOutput) => void ): void; - public deleteUsageLimit( + deleteUsageLimit( args: DeleteUsageLimitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUsageLimitCommandOutput) => void ): void; - public deleteUsageLimit( - args: DeleteUsageLimitCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUsageLimitCommandOutput) => void), - cb?: (err: any, data?: DeleteUsageLimitCommandOutput) => void - ): Promise | void { - const command = new DeleteUsageLimitCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a workgroup.

+ * @see {@link DeleteWorkgroupCommand} */ - public deleteWorkgroup( + deleteWorkgroup( args: DeleteWorkgroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWorkgroup( - args: DeleteWorkgroupCommandInput, - cb: (err: any, data?: DeleteWorkgroupCommandOutput) => void - ): void; - public deleteWorkgroup( + deleteWorkgroup(args: DeleteWorkgroupCommandInput, cb: (err: any, data?: DeleteWorkgroupCommandOutput) => void): void; + deleteWorkgroup( args: DeleteWorkgroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkgroupCommandOutput) => void ): void; - public deleteWorkgroup( - args: DeleteWorkgroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorkgroupCommandOutput) => void), - cb?: (err: any, data?: DeleteWorkgroupCommandOutput) => void - ): Promise | void { - const command = new DeleteWorkgroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a database user name and temporary password with - * temporary authorization to log in to Amazon Redshift Serverless.

- *

By default, the temporary credentials expire in 900 seconds. - * You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes).

- * - *

The Identity and Access Management (IAM) user or role that runs - * GetCredentials must have an IAM policy attached that allows access to all - * necessary actions and resources.

- * - *

If the DbName parameter is specified, the IAM policy must - * allow access to the resource dbname for the specified database name.

+ * @see {@link GetCredentialsCommand} */ - public getCredentials( + getCredentials( args: GetCredentialsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCredentials( - args: GetCredentialsCommandInput, - cb: (err: any, data?: GetCredentialsCommandOutput) => void - ): void; - public getCredentials( + getCredentials(args: GetCredentialsCommandInput, cb: (err: any, data?: GetCredentialsCommandOutput) => void): void; + getCredentials( args: GetCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCredentialsCommandOutput) => void ): void; - public getCredentials( - args: GetCredentialsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCredentialsCommandOutput) => void), - cb?: (err: any, data?: GetCredentialsCommandOutput) => void - ): Promise | void { - const command = new GetCredentialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information, such as the name, about a VPC endpoint.

+ * @see {@link GetEndpointAccessCommand} */ - public getEndpointAccess( + getEndpointAccess( args: GetEndpointAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEndpointAccess( + getEndpointAccess( args: GetEndpointAccessCommandInput, cb: (err: any, data?: GetEndpointAccessCommandOutput) => void ): void; - public getEndpointAccess( + getEndpointAccess( args: GetEndpointAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEndpointAccessCommandOutput) => void ): void; - public getEndpointAccess( - args: GetEndpointAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEndpointAccessCommandOutput) => void), - cb?: (err: any, data?: GetEndpointAccessCommandOutput) => void - ): Promise | void { - const command = new GetEndpointAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a namespace in Amazon Redshift Serverless.

+ * @see {@link GetNamespaceCommand} */ - public getNamespace( - args: GetNamespaceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getNamespace(args: GetNamespaceCommandInput, cb: (err: any, data?: GetNamespaceCommandOutput) => void): void; - public getNamespace( + getNamespace(args: GetNamespaceCommandInput, options?: __HttpHandlerOptions): Promise; + getNamespace(args: GetNamespaceCommandInput, cb: (err: any, data?: GetNamespaceCommandOutput) => void): void; + getNamespace( args: GetNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNamespaceCommandOutput) => void ): void; - public getNamespace( - args: GetNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetNamespaceCommandOutput) => void), - cb?: (err: any, data?: GetNamespaceCommandOutput) => void - ): Promise | void { - const command = new GetNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a recovery point.

+ * @see {@link GetRecoveryPointCommand} */ - public getRecoveryPoint( + getRecoveryPoint( args: GetRecoveryPointCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRecoveryPoint( + getRecoveryPoint( args: GetRecoveryPointCommandInput, cb: (err: any, data?: GetRecoveryPointCommandOutput) => void ): void; - public getRecoveryPoint( + getRecoveryPoint( args: GetRecoveryPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRecoveryPointCommandOutput) => void ): void; - public getRecoveryPoint( - args: GetRecoveryPointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRecoveryPointCommandOutput) => void), - cb?: (err: any, data?: GetRecoveryPointCommandOutput) => void - ): Promise | void { - const command = new GetRecoveryPointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a resource policy.

+ * @see {@link GetResourcePolicyCommand} */ - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void ): void; - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void ): void; - public getResourcePolicy( - args: GetResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: GetResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new GetResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a specific snapshot.

+ * @see {@link GetSnapshotCommand} */ - public getSnapshot(args: GetSnapshotCommandInput, options?: __HttpHandlerOptions): Promise; - public getSnapshot(args: GetSnapshotCommandInput, cb: (err: any, data?: GetSnapshotCommandOutput) => void): void; - public getSnapshot( + getSnapshot(args: GetSnapshotCommandInput, options?: __HttpHandlerOptions): Promise; + getSnapshot(args: GetSnapshotCommandInput, cb: (err: any, data?: GetSnapshotCommandOutput) => void): void; + getSnapshot( args: GetSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSnapshotCommandOutput) => void ): void; - public getSnapshot( - args: GetSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSnapshotCommandOutput) => void), - cb?: (err: any, data?: GetSnapshotCommandOutput) => void - ): Promise | void { - const command = new GetSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a TableRestoreStatus object.

+ * @see {@link GetTableRestoreStatusCommand} */ - public getTableRestoreStatus( + getTableRestoreStatus( args: GetTableRestoreStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTableRestoreStatus( + getTableRestoreStatus( args: GetTableRestoreStatusCommandInput, cb: (err: any, data?: GetTableRestoreStatusCommandOutput) => void ): void; - public getTableRestoreStatus( + getTableRestoreStatus( args: GetTableRestoreStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTableRestoreStatusCommandOutput) => void ): void; - public getTableRestoreStatus( - args: GetTableRestoreStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTableRestoreStatusCommandOutput) => void), - cb?: (err: any, data?: GetTableRestoreStatusCommandOutput) => void - ): Promise | void { - const command = new GetTableRestoreStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a usage limit.

+ * @see {@link GetUsageLimitCommand} */ - public getUsageLimit( - args: GetUsageLimitCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getUsageLimit( - args: GetUsageLimitCommandInput, - cb: (err: any, data?: GetUsageLimitCommandOutput) => void - ): void; - public getUsageLimit( + getUsageLimit(args: GetUsageLimitCommandInput, options?: __HttpHandlerOptions): Promise; + getUsageLimit(args: GetUsageLimitCommandInput, cb: (err: any, data?: GetUsageLimitCommandOutput) => void): void; + getUsageLimit( args: GetUsageLimitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUsageLimitCommandOutput) => void ): void; - public getUsageLimit( - args: GetUsageLimitCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUsageLimitCommandOutput) => void), - cb?: (err: any, data?: GetUsageLimitCommandOutput) => void - ): Promise | void { - const command = new GetUsageLimitCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a specific workgroup.

+ * @see {@link GetWorkgroupCommand} */ - public getWorkgroup( - args: GetWorkgroupCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getWorkgroup(args: GetWorkgroupCommandInput, cb: (err: any, data?: GetWorkgroupCommandOutput) => void): void; - public getWorkgroup( + getWorkgroup(args: GetWorkgroupCommandInput, options?: __HttpHandlerOptions): Promise; + getWorkgroup(args: GetWorkgroupCommandInput, cb: (err: any, data?: GetWorkgroupCommandOutput) => void): void; + getWorkgroup( args: GetWorkgroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkgroupCommandOutput) => void ): void; - public getWorkgroup( - args: GetWorkgroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkgroupCommandOutput) => void), - cb?: (err: any, data?: GetWorkgroupCommandOutput) => void - ): Promise | void { - const command = new GetWorkgroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of EndpointAccess objects and relevant information.

+ * @see {@link ListEndpointAccessCommand} */ - public listEndpointAccess( + listEndpointAccess( args: ListEndpointAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEndpointAccess( + listEndpointAccess( args: ListEndpointAccessCommandInput, cb: (err: any, data?: ListEndpointAccessCommandOutput) => void ): void; - public listEndpointAccess( + listEndpointAccess( args: ListEndpointAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEndpointAccessCommandOutput) => void ): void; - public listEndpointAccess( - args: ListEndpointAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEndpointAccessCommandOutput) => void), - cb?: (err: any, data?: ListEndpointAccessCommandOutput) => void - ): Promise | void { - const command = new ListEndpointAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a list of specified namespaces.

+ * @see {@link ListNamespacesCommand} */ - public listNamespaces( + listNamespaces( args: ListNamespacesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listNamespaces( - args: ListNamespacesCommandInput, - cb: (err: any, data?: ListNamespacesCommandOutput) => void - ): void; - public listNamespaces( + listNamespaces(args: ListNamespacesCommandInput, cb: (err: any, data?: ListNamespacesCommandOutput) => void): void; + listNamespaces( args: ListNamespacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNamespacesCommandOutput) => void ): void; - public listNamespaces( - args: ListNamespacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNamespacesCommandOutput) => void), - cb?: (err: any, data?: ListNamespacesCommandOutput) => void - ): Promise | void { - const command = new ListNamespacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of recovery points.

+ * @see {@link ListRecoveryPointsCommand} */ - public listRecoveryPoints( + listRecoveryPoints( args: ListRecoveryPointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRecoveryPoints( + listRecoveryPoints( args: ListRecoveryPointsCommandInput, cb: (err: any, data?: ListRecoveryPointsCommandOutput) => void ): void; - public listRecoveryPoints( + listRecoveryPoints( args: ListRecoveryPointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecoveryPointsCommandOutput) => void ): void; - public listRecoveryPoints( - args: ListRecoveryPointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRecoveryPointsCommandOutput) => void), - cb?: (err: any, data?: ListRecoveryPointsCommandOutput) => void - ): Promise | void { - const command = new ListRecoveryPointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of snapshots.

+ * @see {@link ListSnapshotsCommand} */ - public listSnapshots( - args: ListSnapshotsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listSnapshots( - args: ListSnapshotsCommandInput, - cb: (err: any, data?: ListSnapshotsCommandOutput) => void - ): void; - public listSnapshots( + listSnapshots(args: ListSnapshotsCommandInput, options?: __HttpHandlerOptions): Promise; + listSnapshots(args: ListSnapshotsCommandInput, cb: (err: any, data?: ListSnapshotsCommandOutput) => void): void; + listSnapshots( args: ListSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSnapshotsCommandOutput) => void ): void; - public listSnapshots( - args: ListSnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSnapshotsCommandOutput) => void), - cb?: (err: any, data?: ListSnapshotsCommandOutput) => void - ): Promise | void { - const command = new ListSnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about an array of TableRestoreStatus objects.

+ * @see {@link ListTableRestoreStatusCommand} */ - public listTableRestoreStatus( + listTableRestoreStatus( args: ListTableRestoreStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTableRestoreStatus( + listTableRestoreStatus( args: ListTableRestoreStatusCommandInput, cb: (err: any, data?: ListTableRestoreStatusCommandOutput) => void ): void; - public listTableRestoreStatus( + listTableRestoreStatus( args: ListTableRestoreStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTableRestoreStatusCommandOutput) => void ): void; - public listTableRestoreStatus( - args: ListTableRestoreStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTableRestoreStatusCommandOutput) => void), - cb?: (err: any, data?: ListTableRestoreStatusCommandOutput) => void - ): Promise | void { - const command = new ListTableRestoreStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags assigned to a resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all usage limits within Amazon Redshift Serverless.

+ * @see {@link ListUsageLimitsCommand} */ - public listUsageLimits( + listUsageLimits( args: ListUsageLimitsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listUsageLimits( - args: ListUsageLimitsCommandInput, - cb: (err: any, data?: ListUsageLimitsCommandOutput) => void - ): void; - public listUsageLimits( + listUsageLimits(args: ListUsageLimitsCommandInput, cb: (err: any, data?: ListUsageLimitsCommandOutput) => void): void; + listUsageLimits( args: ListUsageLimitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsageLimitsCommandOutput) => void ): void; - public listUsageLimits( - args: ListUsageLimitsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUsageLimitsCommandOutput) => void), - cb?: (err: any, data?: ListUsageLimitsCommandOutput) => void - ): Promise | void { - const command = new ListUsageLimitsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a list of specified workgroups.

+ * @see {@link ListWorkgroupsCommand} */ - public listWorkgroups( + listWorkgroups( args: ListWorkgroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWorkgroups( - args: ListWorkgroupsCommandInput, - cb: (err: any, data?: ListWorkgroupsCommandOutput) => void - ): void; - public listWorkgroups( + listWorkgroups(args: ListWorkgroupsCommandInput, cb: (err: any, data?: ListWorkgroupsCommandOutput) => void): void; + listWorkgroups( args: ListWorkgroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkgroupsCommandOutput) => void ): void; - public listWorkgroups( - args: ListWorkgroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkgroupsCommandOutput) => void), - cb?: (err: any, data?: ListWorkgroupsCommandOutput) => void - ): Promise | void { - const command = new ListWorkgroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates a resource policy. Currently, you can use policies to share snapshots across Amazon Web Services accounts.

+ * @see {@link PutResourcePolicyCommand} */ - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( - args: PutResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: PutResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new PutResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Restore the data from a recovery point.

+ * @see {@link RestoreFromRecoveryPointCommand} */ - public restoreFromRecoveryPoint( + restoreFromRecoveryPoint( args: RestoreFromRecoveryPointCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreFromRecoveryPoint( + restoreFromRecoveryPoint( args: RestoreFromRecoveryPointCommandInput, cb: (err: any, data?: RestoreFromRecoveryPointCommandOutput) => void ): void; - public restoreFromRecoveryPoint( + restoreFromRecoveryPoint( args: RestoreFromRecoveryPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreFromRecoveryPointCommandOutput) => void ): void; - public restoreFromRecoveryPoint( - args: RestoreFromRecoveryPointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreFromRecoveryPointCommandOutput) => void), - cb?: (err: any, data?: RestoreFromRecoveryPointCommandOutput) => void - ): Promise | void { - const command = new RestoreFromRecoveryPointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Restores a namespace from a snapshot.

+ * @see {@link RestoreFromSnapshotCommand} */ - public restoreFromSnapshot( + restoreFromSnapshot( args: RestoreFromSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreFromSnapshot( + restoreFromSnapshot( args: RestoreFromSnapshotCommandInput, cb: (err: any, data?: RestoreFromSnapshotCommandOutput) => void ): void; - public restoreFromSnapshot( + restoreFromSnapshot( args: RestoreFromSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreFromSnapshotCommandOutput) => void ): void; - public restoreFromSnapshot( - args: RestoreFromSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreFromSnapshotCommandOutput) => void), - cb?: (err: any, data?: RestoreFromSnapshotCommandOutput) => void - ): Promise | void { - const command = new RestoreFromSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Restores a table from a snapshot to your Amazon Redshift Serverless instance. You can't use this operation to - * restore tables with interleaved sort keys.

+ * @see {@link RestoreTableFromSnapshotCommand} */ - public restoreTableFromSnapshot( + restoreTableFromSnapshot( args: RestoreTableFromSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreTableFromSnapshot( + restoreTableFromSnapshot( args: RestoreTableFromSnapshotCommandInput, cb: (err: any, data?: RestoreTableFromSnapshotCommandOutput) => void ): void; - public restoreTableFromSnapshot( + restoreTableFromSnapshot( args: RestoreTableFromSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreTableFromSnapshotCommandOutput) => void ): void; - public restoreTableFromSnapshot( - args: RestoreTableFromSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreTableFromSnapshotCommandOutput) => void), - cb?: (err: any, data?: RestoreTableFromSnapshotCommandOutput) => void - ): Promise | void { - const command = new RestoreTableFromSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns one or more tags to a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a tag or set of tags from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an Amazon Redshift Serverless managed endpoint.

+ * @see {@link UpdateEndpointAccessCommand} */ - public updateEndpointAccess( + updateEndpointAccess( args: UpdateEndpointAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEndpointAccess( + updateEndpointAccess( args: UpdateEndpointAccessCommandInput, cb: (err: any, data?: UpdateEndpointAccessCommandOutput) => void ): void; - public updateEndpointAccess( + updateEndpointAccess( args: UpdateEndpointAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEndpointAccessCommandOutput) => void ): void; - public updateEndpointAccess( - args: UpdateEndpointAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEndpointAccessCommandOutput) => void), - cb?: (err: any, data?: UpdateEndpointAccessCommandOutput) => void - ): Promise | void { - const command = new UpdateEndpointAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a namespace with the specified settings. Unless required, you can't update multiple parameters in one request. For example, - * you must specify both adminUsername and adminUserPassword to update either field, but you can't update both kmsKeyId - * and logExports in a single request.

+ * @see {@link UpdateNamespaceCommand} */ - public updateNamespace( + updateNamespace( args: UpdateNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateNamespace( - args: UpdateNamespaceCommandInput, - cb: (err: any, data?: UpdateNamespaceCommandOutput) => void - ): void; - public updateNamespace( + updateNamespace(args: UpdateNamespaceCommandInput, cb: (err: any, data?: UpdateNamespaceCommandOutput) => void): void; + updateNamespace( args: UpdateNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNamespaceCommandOutput) => void ): void; - public updateNamespace( - args: UpdateNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateNamespaceCommandOutput) => void), - cb?: (err: any, data?: UpdateNamespaceCommandOutput) => void - ): Promise | void { - const command = new UpdateNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a snapshot.

+ * @see {@link UpdateSnapshotCommand} */ - public updateSnapshot( + updateSnapshot( args: UpdateSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSnapshot( - args: UpdateSnapshotCommandInput, - cb: (err: any, data?: UpdateSnapshotCommandOutput) => void - ): void; - public updateSnapshot( + updateSnapshot(args: UpdateSnapshotCommandInput, cb: (err: any, data?: UpdateSnapshotCommandOutput) => void): void; + updateSnapshot( args: UpdateSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSnapshotCommandOutput) => void ): void; - public updateSnapshot( - args: UpdateSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSnapshotCommandOutput) => void), - cb?: (err: any, data?: UpdateSnapshotCommandOutput) => void - ): Promise | void { - const command = new UpdateSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update a usage limit in Amazon Redshift Serverless. You can't update the usage type or period of a usage limit.

+ * @see {@link UpdateUsageLimitCommand} */ - public updateUsageLimit( + updateUsageLimit( args: UpdateUsageLimitCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateUsageLimit( + updateUsageLimit( args: UpdateUsageLimitCommandInput, cb: (err: any, data?: UpdateUsageLimitCommandOutput) => void ): void; - public updateUsageLimit( + updateUsageLimit( args: UpdateUsageLimitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUsageLimitCommandOutput) => void ): void; - public updateUsageLimit( - args: UpdateUsageLimitCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUsageLimitCommandOutput) => void), - cb?: (err: any, data?: UpdateUsageLimitCommandOutput) => void - ): Promise | void { - const command = new UpdateUsageLimitCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a workgroup with the specified configuration settings. You can't update multiple parameters in one request. For example, - * you can update baseCapacity or port in a single request, but you can't update both in the same request.

+ * @see {@link UpdateWorkgroupCommand} */ - public updateWorkgroup( + updateWorkgroup( args: UpdateWorkgroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWorkgroup( - args: UpdateWorkgroupCommandInput, - cb: (err: any, data?: UpdateWorkgroupCommandOutput) => void - ): void; - public updateWorkgroup( + updateWorkgroup(args: UpdateWorkgroupCommandInput, cb: (err: any, data?: UpdateWorkgroupCommandOutput) => void): void; + updateWorkgroup( args: UpdateWorkgroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkgroupCommandOutput) => void ): void; - public updateWorkgroup( - args: UpdateWorkgroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWorkgroupCommandOutput) => void), - cb?: (err: any, data?: UpdateWorkgroupCommandOutput) => void - ): Promise | void { - const command = new UpdateWorkgroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

This is an interface reference for Amazon Redshift Serverless. + * It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift Serverless. + *

+ *

Amazon Redshift Serverless automatically provisions data warehouse capacity and intelligently scales the + * underlying resources based on workload demands. Amazon Redshift Serverless adjusts capacity in seconds to deliver consistently high + * performance and simplified operations for even the most demanding and volatile workloads. Amazon Redshift Serverless lets you + * focus on using your data to acquire new insights for your business and customers. + *

+ *

+ * To learn more about Amazon Redshift Serverless, + * see What is Amazon Redshift Serverless. + *

+ */ +export class RedshiftServerless extends RedshiftServerlessClient implements RedshiftServerless {} +createAggregatedClient(commands, RedshiftServerless); diff --git a/clients/client-redshift/src/Redshift.ts b/clients/client-redshift/src/Redshift.ts index 333109af86b4..9929163e09fc 100644 --- a/clients/client-redshift/src/Redshift.ts +++ b/clients/client-redshift/src/Redshift.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -584,4441 +585,2079 @@ import { UpdatePartnerStatusCommandInput, UpdatePartnerStatusCommandOutput, } from "./commands/UpdatePartnerStatusCommand"; -import { RedshiftClient } from "./RedshiftClient"; +import { RedshiftClient, RedshiftClientConfig } from "./RedshiftClient"; -/** - * @public - * Amazon Redshift - *

- * Overview - *

- *

This is an interface reference for Amazon Redshift. It contains documentation for one of - * the programming or command line interfaces you can use to manage Amazon Redshift clusters. - * Note that Amazon Redshift is asynchronous, which means that some interfaces may require - * techniques, such as polling or asynchronous callback handlers, to determine when a - * command has been applied. In this reference, the parameter descriptions indicate whether - * a change is applied immediately, on the next instance reboot, or during the next - * maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to - * Using the - * Amazon Redshift Management Interfaces.

- *

Amazon Redshift manages all the work of setting up, operating, and scaling a data - * warehouse: provisioning capacity, monitoring and backing up the cluster, and applying - * patches and upgrades to the Amazon Redshift engine. You can focus on using your data to - * acquire new insights for your business and customers.

- *

If you are a first-time user of Amazon Redshift, we recommend that you begin by reading - * the Amazon Redshift Getting Started Guide.

- *

If you are a database developer, the Amazon Redshift Database Developer Guide explains how to design, - * build, query, and maintain the databases that make up your data warehouse.

- */ -export class Redshift extends RedshiftClient { +const commands = { + AcceptReservedNodeExchangeCommand, + AddPartnerCommand, + AssociateDataShareConsumerCommand, + AuthorizeClusterSecurityGroupIngressCommand, + AuthorizeDataShareCommand, + AuthorizeEndpointAccessCommand, + AuthorizeSnapshotAccessCommand, + BatchDeleteClusterSnapshotsCommand, + BatchModifyClusterSnapshotsCommand, + CancelResizeCommand, + CopyClusterSnapshotCommand, + CreateAuthenticationProfileCommand, + CreateClusterCommand, + CreateClusterParameterGroupCommand, + CreateClusterSecurityGroupCommand, + CreateClusterSnapshotCommand, + CreateClusterSubnetGroupCommand, + CreateEndpointAccessCommand, + CreateEventSubscriptionCommand, + CreateHsmClientCertificateCommand, + CreateHsmConfigurationCommand, + CreateScheduledActionCommand, + CreateSnapshotCopyGrantCommand, + CreateSnapshotScheduleCommand, + CreateTagsCommand, + CreateUsageLimitCommand, + DeauthorizeDataShareCommand, + DeleteAuthenticationProfileCommand, + DeleteClusterCommand, + DeleteClusterParameterGroupCommand, + DeleteClusterSecurityGroupCommand, + DeleteClusterSnapshotCommand, + DeleteClusterSubnetGroupCommand, + DeleteEndpointAccessCommand, + DeleteEventSubscriptionCommand, + DeleteHsmClientCertificateCommand, + DeleteHsmConfigurationCommand, + DeletePartnerCommand, + DeleteScheduledActionCommand, + DeleteSnapshotCopyGrantCommand, + DeleteSnapshotScheduleCommand, + DeleteTagsCommand, + DeleteUsageLimitCommand, + DescribeAccountAttributesCommand, + DescribeAuthenticationProfilesCommand, + DescribeClusterDbRevisionsCommand, + DescribeClusterParameterGroupsCommand, + DescribeClusterParametersCommand, + DescribeClustersCommand, + DescribeClusterSecurityGroupsCommand, + DescribeClusterSnapshotsCommand, + DescribeClusterSubnetGroupsCommand, + DescribeClusterTracksCommand, + DescribeClusterVersionsCommand, + DescribeDataSharesCommand, + DescribeDataSharesForConsumerCommand, + DescribeDataSharesForProducerCommand, + DescribeDefaultClusterParametersCommand, + DescribeEndpointAccessCommand, + DescribeEndpointAuthorizationCommand, + DescribeEventCategoriesCommand, + DescribeEventsCommand, + DescribeEventSubscriptionsCommand, + DescribeHsmClientCertificatesCommand, + DescribeHsmConfigurationsCommand, + DescribeLoggingStatusCommand, + DescribeNodeConfigurationOptionsCommand, + DescribeOrderableClusterOptionsCommand, + DescribePartnersCommand, + DescribeReservedNodeExchangeStatusCommand, + DescribeReservedNodeOfferingsCommand, + DescribeReservedNodesCommand, + DescribeResizeCommand, + DescribeScheduledActionsCommand, + DescribeSnapshotCopyGrantsCommand, + DescribeSnapshotSchedulesCommand, + DescribeStorageCommand, + DescribeTableRestoreStatusCommand, + DescribeTagsCommand, + DescribeUsageLimitsCommand, + DisableLoggingCommand, + DisableSnapshotCopyCommand, + DisassociateDataShareConsumerCommand, + EnableLoggingCommand, + EnableSnapshotCopyCommand, + GetClusterCredentialsCommand, + GetClusterCredentialsWithIAMCommand, + GetReservedNodeExchangeConfigurationOptionsCommand, + GetReservedNodeExchangeOfferingsCommand, + ModifyAquaConfigurationCommand, + ModifyAuthenticationProfileCommand, + ModifyClusterCommand, + ModifyClusterDbRevisionCommand, + ModifyClusterIamRolesCommand, + ModifyClusterMaintenanceCommand, + ModifyClusterParameterGroupCommand, + ModifyClusterSnapshotCommand, + ModifyClusterSnapshotScheduleCommand, + ModifyClusterSubnetGroupCommand, + ModifyEndpointAccessCommand, + ModifyEventSubscriptionCommand, + ModifyScheduledActionCommand, + ModifySnapshotCopyRetentionPeriodCommand, + ModifySnapshotScheduleCommand, + ModifyUsageLimitCommand, + PauseClusterCommand, + PurchaseReservedNodeOfferingCommand, + RebootClusterCommand, + RejectDataShareCommand, + ResetClusterParameterGroupCommand, + ResizeClusterCommand, + RestoreFromClusterSnapshotCommand, + RestoreTableFromClusterSnapshotCommand, + ResumeClusterCommand, + RevokeClusterSecurityGroupIngressCommand, + RevokeEndpointAccessCommand, + RevokeSnapshotAccessCommand, + RotateEncryptionKeyCommand, + UpdatePartnerStatusCommand, +}; + +export interface Redshift { /** - * @public - *

Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the - * configuration (term, payment type, or number of nodes) and no additional costs. - *

+ * @see {@link AcceptReservedNodeExchangeCommand} */ - public acceptReservedNodeExchange( + acceptReservedNodeExchange( args: AcceptReservedNodeExchangeCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptReservedNodeExchange( + acceptReservedNodeExchange( args: AcceptReservedNodeExchangeCommandInput, cb: (err: any, data?: AcceptReservedNodeExchangeCommandOutput) => void ): void; - public acceptReservedNodeExchange( + acceptReservedNodeExchange( args: AcceptReservedNodeExchangeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptReservedNodeExchangeCommandOutput) => void ): void; - public acceptReservedNodeExchange( - args: AcceptReservedNodeExchangeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptReservedNodeExchangeCommandOutput) => void), - cb?: (err: any, data?: AcceptReservedNodeExchangeCommandOutput) => void - ): Promise | void { - const command = new AcceptReservedNodeExchangeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a partner integration to a cluster. - * This operation authorizes a partner to push status updates for the specified database. - * To complete the integration, you also set up the integration on the partner website.

+ * @see {@link AddPartnerCommand} */ - public addPartner(args: AddPartnerCommandInput, options?: __HttpHandlerOptions): Promise; - public addPartner(args: AddPartnerCommandInput, cb: (err: any, data?: AddPartnerCommandOutput) => void): void; - public addPartner( + addPartner(args: AddPartnerCommandInput, options?: __HttpHandlerOptions): Promise; + addPartner(args: AddPartnerCommandInput, cb: (err: any, data?: AddPartnerCommandOutput) => void): void; + addPartner( args: AddPartnerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddPartnerCommandOutput) => void ): void; - public addPartner( - args: AddPartnerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddPartnerCommandOutput) => void), - cb?: (err: any, data?: AddPartnerCommandOutput) => void - ): Promise | void { - const command = new AddPartnerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

From a datashare consumer account, associates a datashare with the - * account (AssociateEntireAccount) or the specified namespace (ConsumerArn). If you make this association, the consumer - * can consume the datashare.

+ * @see {@link AssociateDataShareConsumerCommand} */ - public associateDataShareConsumer( + associateDataShareConsumer( args: AssociateDataShareConsumerCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateDataShareConsumer( + associateDataShareConsumer( args: AssociateDataShareConsumerCommandInput, cb: (err: any, data?: AssociateDataShareConsumerCommandOutput) => void ): void; - public associateDataShareConsumer( + associateDataShareConsumer( args: AssociateDataShareConsumerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateDataShareConsumerCommandOutput) => void ): void; - public associateDataShareConsumer( - args: AssociateDataShareConsumerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateDataShareConsumerCommandOutput) => void), - cb?: (err: any, data?: AssociateDataShareConsumerCommandOutput) => void - ): Promise | void { - const command = new AssociateDataShareConsumerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether - * the application accessing your cluster is running on the Internet or an Amazon EC2 - * instance, you can authorize inbound access to either a Classless Interdomain Routing - * (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as - * many as 20 ingress rules to an Amazon Redshift security group.

- *

If you authorize access to an Amazon EC2 security group, specify - * EC2SecurityGroupName and - * EC2SecurityGroupOwnerId. The Amazon EC2 security group and - * Amazon Redshift cluster must be in the same Amazon Web Services Region.

- *

If you authorize access to a CIDR/IP address range, specify - * CIDRIP. For an overview of CIDR blocks, see the Wikipedia - * article on Classless Inter-Domain Routing.

- *

You must also associate the security group with a cluster so that clients running - * on these IP addresses or the EC2 instance are authorized to connect to the cluster. For - * information about managing security groups, go to Working with Security - * Groups in the Amazon Redshift Cluster Management Guide.

+ * @see {@link AuthorizeClusterSecurityGroupIngressCommand} */ - public authorizeClusterSecurityGroupIngress( + authorizeClusterSecurityGroupIngress( args: AuthorizeClusterSecurityGroupIngressCommandInput, options?: __HttpHandlerOptions ): Promise; - public authorizeClusterSecurityGroupIngress( + authorizeClusterSecurityGroupIngress( args: AuthorizeClusterSecurityGroupIngressCommandInput, cb: (err: any, data?: AuthorizeClusterSecurityGroupIngressCommandOutput) => void ): void; - public authorizeClusterSecurityGroupIngress( + authorizeClusterSecurityGroupIngress( args: AuthorizeClusterSecurityGroupIngressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AuthorizeClusterSecurityGroupIngressCommandOutput) => void ): void; - public authorizeClusterSecurityGroupIngress( - args: AuthorizeClusterSecurityGroupIngressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AuthorizeClusterSecurityGroupIngressCommandOutput) => void), - cb?: (err: any, data?: AuthorizeClusterSecurityGroupIngressCommandOutput) => void - ): Promise | void { - const command = new AuthorizeClusterSecurityGroupIngressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

From a data producer account, authorizes the sharing of a datashare with one or more - * consumer accounts or managing entities. To authorize a datashare for a data consumer, - * the producer account must have the correct access permissions.

+ * @see {@link AuthorizeDataShareCommand} */ - public authorizeDataShare( + authorizeDataShare( args: AuthorizeDataShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public authorizeDataShare( + authorizeDataShare( args: AuthorizeDataShareCommandInput, cb: (err: any, data?: AuthorizeDataShareCommandOutput) => void ): void; - public authorizeDataShare( + authorizeDataShare( args: AuthorizeDataShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AuthorizeDataShareCommandOutput) => void ): void; - public authorizeDataShare( - args: AuthorizeDataShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AuthorizeDataShareCommandOutput) => void), - cb?: (err: any, data?: AuthorizeDataShareCommandOutput) => void - ): Promise | void { - const command = new AuthorizeDataShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Grants access to a cluster.

+ * @see {@link AuthorizeEndpointAccessCommand} */ - public authorizeEndpointAccess( + authorizeEndpointAccess( args: AuthorizeEndpointAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public authorizeEndpointAccess( + authorizeEndpointAccess( args: AuthorizeEndpointAccessCommandInput, cb: (err: any, data?: AuthorizeEndpointAccessCommandOutput) => void ): void; - public authorizeEndpointAccess( + authorizeEndpointAccess( args: AuthorizeEndpointAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AuthorizeEndpointAccessCommandOutput) => void ): void; - public authorizeEndpointAccess( - args: AuthorizeEndpointAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AuthorizeEndpointAccessCommandOutput) => void), - cb?: (err: any, data?: AuthorizeEndpointAccessCommandOutput) => void - ): Promise | void { - const command = new AuthorizeEndpointAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Authorizes the specified Amazon Web Services account to restore the specified - * snapshot.

- *

- * For more information about working with snapshots, go to - * Amazon Redshift Snapshots - * in the Amazon Redshift Cluster Management Guide.

+ * @see {@link AuthorizeSnapshotAccessCommand} */ - public authorizeSnapshotAccess( + authorizeSnapshotAccess( args: AuthorizeSnapshotAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public authorizeSnapshotAccess( + authorizeSnapshotAccess( args: AuthorizeSnapshotAccessCommandInput, cb: (err: any, data?: AuthorizeSnapshotAccessCommandOutput) => void ): void; - public authorizeSnapshotAccess( + authorizeSnapshotAccess( args: AuthorizeSnapshotAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AuthorizeSnapshotAccessCommandOutput) => void ): void; - public authorizeSnapshotAccess( - args: AuthorizeSnapshotAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AuthorizeSnapshotAccessCommandOutput) => void), - cb?: (err: any, data?: AuthorizeSnapshotAccessCommandOutput) => void - ): Promise | void { - const command = new AuthorizeSnapshotAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a set of cluster snapshots.

+ * @see {@link BatchDeleteClusterSnapshotsCommand} */ - public batchDeleteClusterSnapshots( + batchDeleteClusterSnapshots( args: BatchDeleteClusterSnapshotsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeleteClusterSnapshots( + batchDeleteClusterSnapshots( args: BatchDeleteClusterSnapshotsCommandInput, cb: (err: any, data?: BatchDeleteClusterSnapshotsCommandOutput) => void ): void; - public batchDeleteClusterSnapshots( + batchDeleteClusterSnapshots( args: BatchDeleteClusterSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteClusterSnapshotsCommandOutput) => void ): void; - public batchDeleteClusterSnapshots( - args: BatchDeleteClusterSnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeleteClusterSnapshotsCommandOutput) => void), - cb?: (err: any, data?: BatchDeleteClusterSnapshotsCommandOutput) => void - ): Promise | void { - const command = new BatchDeleteClusterSnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the settings for a set of cluster snapshots.

+ * @see {@link BatchModifyClusterSnapshotsCommand} */ - public batchModifyClusterSnapshots( + batchModifyClusterSnapshots( args: BatchModifyClusterSnapshotsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchModifyClusterSnapshots( + batchModifyClusterSnapshots( args: BatchModifyClusterSnapshotsCommandInput, cb: (err: any, data?: BatchModifyClusterSnapshotsCommandOutput) => void ): void; - public batchModifyClusterSnapshots( + batchModifyClusterSnapshots( args: BatchModifyClusterSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchModifyClusterSnapshotsCommandOutput) => void ): void; - public batchModifyClusterSnapshots( - args: BatchModifyClusterSnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchModifyClusterSnapshotsCommandOutput) => void), - cb?: (err: any, data?: BatchModifyClusterSnapshotsCommandOutput) => void - ): Promise | void { - const command = new BatchModifyClusterSnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels a resize operation for a cluster.

+ * @see {@link CancelResizeCommand} */ - public cancelResize( - args: CancelResizeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public cancelResize(args: CancelResizeCommandInput, cb: (err: any, data?: CancelResizeCommandOutput) => void): void; - public cancelResize( + cancelResize(args: CancelResizeCommandInput, options?: __HttpHandlerOptions): Promise; + cancelResize(args: CancelResizeCommandInput, cb: (err: any, data?: CancelResizeCommandOutput) => void): void; + cancelResize( args: CancelResizeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelResizeCommandOutput) => void ): void; - public cancelResize( - args: CancelResizeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelResizeCommandOutput) => void), - cb?: (err: any, data?: CancelResizeCommandOutput) => void - ): Promise | void { - const command = new CancelResizeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Copies the specified automated cluster snapshot to a new manual cluster snapshot. - * The source must be an automated snapshot and it must be in the available - * state.

- *

When you delete a cluster, Amazon Redshift deletes any automated snapshots of the - * cluster. Also, when the retention period of the snapshot expires, Amazon Redshift - * automatically deletes it. If you want to keep an automated snapshot for a longer period, - * you can make a manual copy of the snapshot. Manual snapshots are retained until you - * delete them.

- *

- * For more information about working with snapshots, go to - * Amazon Redshift Snapshots - * in the Amazon Redshift Cluster Management Guide.

+ * @see {@link CopyClusterSnapshotCommand} */ - public copyClusterSnapshot( + copyClusterSnapshot( args: CopyClusterSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public copyClusterSnapshot( + copyClusterSnapshot( args: CopyClusterSnapshotCommandInput, cb: (err: any, data?: CopyClusterSnapshotCommandOutput) => void ): void; - public copyClusterSnapshot( + copyClusterSnapshot( args: CopyClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyClusterSnapshotCommandOutput) => void ): void; - public copyClusterSnapshot( - args: CopyClusterSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopyClusterSnapshotCommandOutput) => void), - cb?: (err: any, data?: CopyClusterSnapshotCommandOutput) => void - ): Promise | void { - const command = new CopyClusterSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an authentication profile with the specified parameters.

+ * @see {@link CreateAuthenticationProfileCommand} */ - public createAuthenticationProfile( + createAuthenticationProfile( args: CreateAuthenticationProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAuthenticationProfile( + createAuthenticationProfile( args: CreateAuthenticationProfileCommandInput, cb: (err: any, data?: CreateAuthenticationProfileCommandOutput) => void ): void; - public createAuthenticationProfile( + createAuthenticationProfile( args: CreateAuthenticationProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAuthenticationProfileCommandOutput) => void ): void; - public createAuthenticationProfile( - args: CreateAuthenticationProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAuthenticationProfileCommandOutput) => void), - cb?: (err: any, data?: CreateAuthenticationProfileCommandOutput) => void - ): Promise | void { - const command = new CreateAuthenticationProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new cluster with the specified parameters.

- *

To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster - * subnet group name. The cluster subnet group identifies the subnets of your VPC that - * Amazon Redshift uses when creating the cluster. - * For more information about managing clusters, go to - * Amazon Redshift Clusters - * in the Amazon Redshift Cluster Management Guide.

+ * @see {@link CreateClusterCommand} */ - public createCluster( - args: CreateClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createCluster( - args: CreateClusterCommandInput, - cb: (err: any, data?: CreateClusterCommandOutput) => void - ): void; - public createCluster( + createCluster(args: CreateClusterCommandInput, options?: __HttpHandlerOptions): Promise; + createCluster(args: CreateClusterCommandInput, cb: (err: any, data?: CreateClusterCommandOutput) => void): void; + createCluster( args: CreateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterCommandOutput) => void ): void; - public createCluster( - args: CreateClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateClusterCommandOutput) => void), - cb?: (err: any, data?: CreateClusterCommandOutput) => void - ): Promise | void { - const command = new CreateClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Amazon Redshift parameter group.

- *

Creating parameter groups is independent of creating clusters. You can associate a - * cluster with a parameter group when you create the cluster. You can also associate an - * existing cluster with a parameter group after the cluster is created by using ModifyCluster.

- *

Parameters in the parameter group define specific behavior that applies to the - * databases you create on the cluster. - * For more information about parameters and parameter groups, go to - * Amazon Redshift Parameter Groups - * in the Amazon Redshift Cluster Management Guide.

+ * @see {@link CreateClusterParameterGroupCommand} */ - public createClusterParameterGroup( + createClusterParameterGroup( args: CreateClusterParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createClusterParameterGroup( + createClusterParameterGroup( args: CreateClusterParameterGroupCommandInput, cb: (err: any, data?: CreateClusterParameterGroupCommandOutput) => void ): void; - public createClusterParameterGroup( + createClusterParameterGroup( args: CreateClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterParameterGroupCommandOutput) => void ): void; - public createClusterParameterGroup( - args: CreateClusterParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateClusterParameterGroupCommandOutput) => void), - cb?: (err: any, data?: CreateClusterParameterGroupCommandOutput) => void - ): Promise | void { - const command = new CreateClusterParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new Amazon Redshift security group. You use security groups to control access - * to non-VPC clusters.

- *

- * For information about managing security groups, go to - * Amazon Redshift Cluster Security Groups in the - * Amazon Redshift Cluster Management Guide.

+ * @see {@link CreateClusterSecurityGroupCommand} */ - public createClusterSecurityGroup( + createClusterSecurityGroup( args: CreateClusterSecurityGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createClusterSecurityGroup( + createClusterSecurityGroup( args: CreateClusterSecurityGroupCommandInput, cb: (err: any, data?: CreateClusterSecurityGroupCommandOutput) => void ): void; - public createClusterSecurityGroup( + createClusterSecurityGroup( args: CreateClusterSecurityGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterSecurityGroupCommandOutput) => void ): void; - public createClusterSecurityGroup( - args: CreateClusterSecurityGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateClusterSecurityGroupCommandOutput) => void), - cb?: (err: any, data?: CreateClusterSecurityGroupCommandOutput) => void - ): Promise | void { - const command = new CreateClusterSecurityGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a manual snapshot of the specified cluster. The cluster must be in the - * available state.

- *

- * For more information about working with snapshots, go to - * Amazon Redshift Snapshots - * in the Amazon Redshift Cluster Management Guide.

+ * @see {@link CreateClusterSnapshotCommand} */ - public createClusterSnapshot( + createClusterSnapshot( args: CreateClusterSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public createClusterSnapshot( + createClusterSnapshot( args: CreateClusterSnapshotCommandInput, cb: (err: any, data?: CreateClusterSnapshotCommandOutput) => void ): void; - public createClusterSnapshot( + createClusterSnapshot( args: CreateClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterSnapshotCommandOutput) => void ): void; - public createClusterSnapshot( - args: CreateClusterSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateClusterSnapshotCommandOutput) => void), - cb?: (err: any, data?: CreateClusterSnapshotCommandOutput) => void - ): Promise | void { - const command = new CreateClusterSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new Amazon Redshift subnet group. You must provide a list of one or more - * subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating - * Amazon Redshift subnet group.

- *

- * For information about subnet groups, go to - * Amazon Redshift Cluster Subnet Groups in the - * Amazon Redshift Cluster Management Guide.

+ * @see {@link CreateClusterSubnetGroupCommand} */ - public createClusterSubnetGroup( + createClusterSubnetGroup( args: CreateClusterSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createClusterSubnetGroup( + createClusterSubnetGroup( args: CreateClusterSubnetGroupCommandInput, cb: (err: any, data?: CreateClusterSubnetGroupCommandOutput) => void ): void; - public createClusterSubnetGroup( + createClusterSubnetGroup( args: CreateClusterSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterSubnetGroupCommandOutput) => void ): void; - public createClusterSubnetGroup( - args: CreateClusterSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateClusterSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: CreateClusterSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new CreateClusterSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a Redshift-managed VPC endpoint.

+ * @see {@link CreateEndpointAccessCommand} */ - public createEndpointAccess( + createEndpointAccess( args: CreateEndpointAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEndpointAccess( + createEndpointAccess( args: CreateEndpointAccessCommandInput, cb: (err: any, data?: CreateEndpointAccessCommandOutput) => void ): void; - public createEndpointAccess( + createEndpointAccess( args: CreateEndpointAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEndpointAccessCommandOutput) => void ): void; - public createEndpointAccess( - args: CreateEndpointAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEndpointAccessCommandOutput) => void), - cb?: (err: any, data?: CreateEndpointAccessCommandOutput) => void - ): Promise | void { - const command = new CreateEndpointAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Amazon Redshift event notification subscription. This action requires an ARN - * (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, - * the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you - * must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in - * the SNS console.

- *

You can specify the source type, and lists of Amazon Redshift source IDs, event - * categories, and event severities. Notifications will be sent for all events you want - * that match those criteria. For example, you can specify source type = cluster, source ID - * = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = - * ERROR. The subscription will only send notifications for those ERROR events in the - * Availability and Backup categories for the specified clusters.

- *

If you specify both the source type and source IDs, such as source type = cluster - * and source identifier = my-cluster-1, notifications will be sent for all the cluster - * events for my-cluster-1. If you specify a source type but do not specify a source - * identifier, you will receive notice of the events for the objects of that type in your - * Amazon Web Services account. If you do not specify either the SourceType nor the SourceIdentifier, you - * will be notified of events generated from all Amazon Redshift sources belonging to your Amazon Web Services account. You must specify a source type if you specify a source ID.

+ * @see {@link CreateEventSubscriptionCommand} */ - public createEventSubscription( + createEventSubscription( args: CreateEventSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEventSubscription( + createEventSubscription( args: CreateEventSubscriptionCommandInput, cb: (err: any, data?: CreateEventSubscriptionCommandOutput) => void ): void; - public createEventSubscription( + createEventSubscription( args: CreateEventSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEventSubscriptionCommandOutput) => void ): void; - public createEventSubscription( - args: CreateEventSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEventSubscriptionCommandOutput) => void), - cb?: (err: any, data?: CreateEventSubscriptionCommandOutput) => void - ): Promise | void { - const command = new CreateEventSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to - * the client's HSM in order to store and retrieve the keys used to encrypt the cluster - * databases.

- *

The command returns a public key, which you must store in the HSM. In addition to - * creating the HSM certificate, you must create an Amazon Redshift HSM configuration that - * provides a cluster the information needed to store and use encryption keys in the HSM. - * For more information, go to Hardware Security Modules - * in the Amazon Redshift Cluster Management Guide.

+ * @see {@link CreateHsmClientCertificateCommand} */ - public createHsmClientCertificate( + createHsmClientCertificate( args: CreateHsmClientCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createHsmClientCertificate( + createHsmClientCertificate( args: CreateHsmClientCertificateCommandInput, cb: (err: any, data?: CreateHsmClientCertificateCommandOutput) => void ): void; - public createHsmClientCertificate( + createHsmClientCertificate( args: CreateHsmClientCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHsmClientCertificateCommandOutput) => void ): void; - public createHsmClientCertificate( - args: CreateHsmClientCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateHsmClientCertificateCommandOutput) => void), - cb?: (err: any, data?: CreateHsmClientCertificateCommandOutput) => void - ): Promise | void { - const command = new CreateHsmClientCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an HSM configuration that contains the information required by an Amazon Redshift - * cluster to store and use database encryption keys in a Hardware Security Module (HSM). - * After creating the HSM configuration, you can specify it as a parameter when creating a - * cluster. The cluster will then store its encryption keys in the HSM.

- *

In addition to creating an HSM configuration, you must also create an HSM client - * certificate. For more information, go to Hardware Security Modules - * in the Amazon Redshift Cluster Management Guide.

+ * @see {@link CreateHsmConfigurationCommand} */ - public createHsmConfiguration( + createHsmConfiguration( args: CreateHsmConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createHsmConfiguration( + createHsmConfiguration( args: CreateHsmConfigurationCommandInput, cb: (err: any, data?: CreateHsmConfigurationCommandOutput) => void ): void; - public createHsmConfiguration( + createHsmConfiguration( args: CreateHsmConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHsmConfigurationCommandOutput) => void ): void; - public createHsmConfiguration( - args: CreateHsmConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateHsmConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateHsmConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateHsmConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. - * For example, you can create a schedule of when to run the ResizeCluster API operation. - *

+ * @see {@link CreateScheduledActionCommand} */ - public createScheduledAction( + createScheduledAction( args: CreateScheduledActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createScheduledAction( + createScheduledAction( args: CreateScheduledActionCommandInput, cb: (err: any, data?: CreateScheduledActionCommandOutput) => void ): void; - public createScheduledAction( + createScheduledAction( args: CreateScheduledActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateScheduledActionCommandOutput) => void ): void; - public createScheduledAction( - args: CreateScheduledActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateScheduledActionCommandOutput) => void), - cb?: (err: any, data?: CreateScheduledActionCommandOutput) => void - ): Promise | void { - const command = new CreateScheduledActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a snapshot copy grant that permits Amazon Redshift to use an encrypted symmetric key - * from Key Management Service (KMS) to encrypt copied snapshots in a - * destination region.

- *

- * For more information about managing snapshot copy grants, go to - * Amazon Redshift Database Encryption - * in the Amazon Redshift Cluster Management Guide. - *

+ * @see {@link CreateSnapshotCopyGrantCommand} */ - public createSnapshotCopyGrant( + createSnapshotCopyGrant( args: CreateSnapshotCopyGrantCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSnapshotCopyGrant( + createSnapshotCopyGrant( args: CreateSnapshotCopyGrantCommandInput, cb: (err: any, data?: CreateSnapshotCopyGrantCommandOutput) => void ): void; - public createSnapshotCopyGrant( + createSnapshotCopyGrant( args: CreateSnapshotCopyGrantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSnapshotCopyGrantCommandOutput) => void ): void; - public createSnapshotCopyGrant( - args: CreateSnapshotCopyGrantCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSnapshotCopyGrantCommandOutput) => void), - cb?: (err: any, data?: CreateSnapshotCopyGrantCommandOutput) => void - ): Promise | void { - const command = new CreateSnapshotCopyGrantCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.

+ * @see {@link CreateSnapshotScheduleCommand} */ - public createSnapshotSchedule( + createSnapshotSchedule( args: CreateSnapshotScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSnapshotSchedule( + createSnapshotSchedule( args: CreateSnapshotScheduleCommandInput, cb: (err: any, data?: CreateSnapshotScheduleCommandOutput) => void ): void; - public createSnapshotSchedule( + createSnapshotSchedule( args: CreateSnapshotScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSnapshotScheduleCommandOutput) => void ): void; - public createSnapshotSchedule( - args: CreateSnapshotScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSnapshotScheduleCommandOutput) => void), - cb?: (err: any, data?: CreateSnapshotScheduleCommandOutput) => void - ): Promise | void { - const command = new CreateSnapshotScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds tags to a cluster.

- *

A resource can have up to 50 tags. If you try to create more than 50 tags for a - * resource, you will receive an error and the attempt will fail.

- *

If you specify a key that already exists for the resource, the value for that key - * will be updated with the new value.

+ * @see {@link CreateTagsCommand} */ - public createTags(args: CreateTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public createTags(args: CreateTagsCommandInput, cb: (err: any, data?: CreateTagsCommandOutput) => void): void; - public createTags( + createTags(args: CreateTagsCommandInput, options?: __HttpHandlerOptions): Promise; + createTags(args: CreateTagsCommandInput, cb: (err: any, data?: CreateTagsCommandOutput) => void): void; + createTags( args: CreateTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTagsCommandOutput) => void ): void; - public createTags( - args: CreateTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTagsCommandOutput) => void), - cb?: (err: any, data?: CreateTagsCommandOutput) => void - ): Promise | void { - const command = new CreateTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a usage limit for a specified Amazon Redshift feature on a cluster. - * The usage limit is identified by the returned usage limit identifier.

+ * @see {@link CreateUsageLimitCommand} */ - public createUsageLimit( + createUsageLimit( args: CreateUsageLimitCommandInput, options?: __HttpHandlerOptions ): Promise; - public createUsageLimit( + createUsageLimit( args: CreateUsageLimitCommandInput, cb: (err: any, data?: CreateUsageLimitCommandOutput) => void ): void; - public createUsageLimit( + createUsageLimit( args: CreateUsageLimitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUsageLimitCommandOutput) => void ): void; - public createUsageLimit( - args: CreateUsageLimitCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUsageLimitCommandOutput) => void), - cb?: (err: any, data?: CreateUsageLimitCommandOutput) => void - ): Promise | void { - const command = new CreateUsageLimitCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

From a datashare producer account, removes authorization from the specified datashare.

+ * @see {@link DeauthorizeDataShareCommand} */ - public deauthorizeDataShare( + deauthorizeDataShare( args: DeauthorizeDataShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public deauthorizeDataShare( + deauthorizeDataShare( args: DeauthorizeDataShareCommandInput, cb: (err: any, data?: DeauthorizeDataShareCommandOutput) => void ): void; - public deauthorizeDataShare( + deauthorizeDataShare( args: DeauthorizeDataShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeauthorizeDataShareCommandOutput) => void ): void; - public deauthorizeDataShare( - args: DeauthorizeDataShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeauthorizeDataShareCommandOutput) => void), - cb?: (err: any, data?: DeauthorizeDataShareCommandOutput) => void - ): Promise | void { - const command = new DeauthorizeDataShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an authentication profile.

+ * @see {@link DeleteAuthenticationProfileCommand} */ - public deleteAuthenticationProfile( + deleteAuthenticationProfile( args: DeleteAuthenticationProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAuthenticationProfile( + deleteAuthenticationProfile( args: DeleteAuthenticationProfileCommandInput, cb: (err: any, data?: DeleteAuthenticationProfileCommandOutput) => void ): void; - public deleteAuthenticationProfile( + deleteAuthenticationProfile( args: DeleteAuthenticationProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAuthenticationProfileCommandOutput) => void ): void; - public deleteAuthenticationProfile( - args: DeleteAuthenticationProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAuthenticationProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteAuthenticationProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteAuthenticationProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a previously provisioned cluster without its final snapshot being created. A successful response from the web - * service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete - * operation cannot be canceled or reverted once submitted. - * For more information about managing clusters, go to - * Amazon Redshift Clusters - * in the Amazon Redshift Cluster Management Guide.

- *

If you want to shut down the cluster and retain it for future use, set - * SkipFinalClusterSnapshot to false and specify a - * name for FinalClusterSnapshotIdentifier. You can later restore this - * snapshot to resume using the cluster. If a final cluster snapshot is requested, the - * status of the cluster will be "final-snapshot" while the snapshot is being taken, then - * it's "deleting" once Amazon Redshift begins deleting the cluster.

- *

- * For more information about managing clusters, go to - * Amazon Redshift Clusters - * in the Amazon Redshift Cluster Management Guide.

+ * @see {@link DeleteClusterCommand} */ - public deleteCluster( - args: DeleteClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteCluster( - args: DeleteClusterCommandInput, - cb: (err: any, data?: DeleteClusterCommandOutput) => void - ): void; - public deleteCluster( + deleteCluster(args: DeleteClusterCommandInput, options?: __HttpHandlerOptions): Promise; + deleteCluster(args: DeleteClusterCommandInput, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void; + deleteCluster( args: DeleteClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClusterCommandOutput) => void ): void; - public deleteCluster( - args: DeleteClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteClusterCommandOutput) => void), - cb?: (err: any, data?: DeleteClusterCommandOutput) => void - ): Promise | void { - const command = new DeleteClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a specified Amazon Redshift parameter group.

- * - *

You cannot delete a parameter group if it is associated with a - * cluster.

- *
+ * @see {@link DeleteClusterParameterGroupCommand} */ - public deleteClusterParameterGroup( + deleteClusterParameterGroup( args: DeleteClusterParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteClusterParameterGroup( + deleteClusterParameterGroup( args: DeleteClusterParameterGroupCommandInput, cb: (err: any, data?: DeleteClusterParameterGroupCommandOutput) => void ): void; - public deleteClusterParameterGroup( + deleteClusterParameterGroup( args: DeleteClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClusterParameterGroupCommandOutput) => void ): void; - public deleteClusterParameterGroup( - args: DeleteClusterParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteClusterParameterGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteClusterParameterGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteClusterParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon Redshift security group.

- * - *

You cannot delete a security group that is associated with any clusters. You - * cannot delete the default security group.

- *
- *

- * For information about managing security groups, go to - * Amazon Redshift Cluster Security Groups in the - * Amazon Redshift Cluster Management Guide.

+ * @see {@link DeleteClusterSecurityGroupCommand} */ - public deleteClusterSecurityGroup( + deleteClusterSecurityGroup( args: DeleteClusterSecurityGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteClusterSecurityGroup( + deleteClusterSecurityGroup( args: DeleteClusterSecurityGroupCommandInput, cb: (err: any, data?: DeleteClusterSecurityGroupCommandOutput) => void ): void; - public deleteClusterSecurityGroup( + deleteClusterSecurityGroup( args: DeleteClusterSecurityGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClusterSecurityGroupCommandOutput) => void ): void; - public deleteClusterSecurityGroup( - args: DeleteClusterSecurityGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteClusterSecurityGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteClusterSecurityGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteClusterSecurityGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified manual snapshot. The snapshot must be in the - * available state, with no other users authorized to access the snapshot.

- *

Unlike automated snapshots, manual snapshots are retained even after you delete - * your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual - * snapshot explicitly to avoid getting charged. If other accounts are authorized to access - * the snapshot, you must revoke all of the authorizations before you can delete the - * snapshot.

+ * @see {@link DeleteClusterSnapshotCommand} */ - public deleteClusterSnapshot( + deleteClusterSnapshot( args: DeleteClusterSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteClusterSnapshot( + deleteClusterSnapshot( args: DeleteClusterSnapshotCommandInput, cb: (err: any, data?: DeleteClusterSnapshotCommandOutput) => void ): void; - public deleteClusterSnapshot( + deleteClusterSnapshot( args: DeleteClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClusterSnapshotCommandOutput) => void ): void; - public deleteClusterSnapshot( - args: DeleteClusterSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteClusterSnapshotCommandOutput) => void), - cb?: (err: any, data?: DeleteClusterSnapshotCommandOutput) => void - ): Promise | void { - const command = new DeleteClusterSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified cluster subnet group.

+ * @see {@link DeleteClusterSubnetGroupCommand} */ - public deleteClusterSubnetGroup( + deleteClusterSubnetGroup( args: DeleteClusterSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteClusterSubnetGroup( + deleteClusterSubnetGroup( args: DeleteClusterSubnetGroupCommandInput, cb: (err: any, data?: DeleteClusterSubnetGroupCommandOutput) => void ): void; - public deleteClusterSubnetGroup( + deleteClusterSubnetGroup( args: DeleteClusterSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClusterSubnetGroupCommandOutput) => void ): void; - public deleteClusterSubnetGroup( - args: DeleteClusterSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteClusterSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteClusterSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteClusterSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Redshift-managed VPC endpoint.

+ * @see {@link DeleteEndpointAccessCommand} */ - public deleteEndpointAccess( + deleteEndpointAccess( args: DeleteEndpointAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEndpointAccess( + deleteEndpointAccess( args: DeleteEndpointAccessCommandInput, cb: (err: any, data?: DeleteEndpointAccessCommandOutput) => void ): void; - public deleteEndpointAccess( + deleteEndpointAccess( args: DeleteEndpointAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEndpointAccessCommandOutput) => void ): void; - public deleteEndpointAccess( - args: DeleteEndpointAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEndpointAccessCommandOutput) => void), - cb?: (err: any, data?: DeleteEndpointAccessCommandOutput) => void - ): Promise | void { - const command = new DeleteEndpointAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon Redshift event notification subscription.

+ * @see {@link DeleteEventSubscriptionCommand} */ - public deleteEventSubscription( + deleteEventSubscription( args: DeleteEventSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEventSubscription( + deleteEventSubscription( args: DeleteEventSubscriptionCommandInput, cb: (err: any, data?: DeleteEventSubscriptionCommandOutput) => void ): void; - public deleteEventSubscription( + deleteEventSubscription( args: DeleteEventSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventSubscriptionCommandOutput) => void ): void; - public deleteEventSubscription( - args: DeleteEventSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEventSubscriptionCommandOutput) => void), - cb?: (err: any, data?: DeleteEventSubscriptionCommandOutput) => void - ): Promise | void { - const command = new DeleteEventSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified HSM client certificate.

+ * @see {@link DeleteHsmClientCertificateCommand} */ - public deleteHsmClientCertificate( + deleteHsmClientCertificate( args: DeleteHsmClientCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteHsmClientCertificate( + deleteHsmClientCertificate( args: DeleteHsmClientCertificateCommandInput, cb: (err: any, data?: DeleteHsmClientCertificateCommandOutput) => void ): void; - public deleteHsmClientCertificate( + deleteHsmClientCertificate( args: DeleteHsmClientCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHsmClientCertificateCommandOutput) => void ): void; - public deleteHsmClientCertificate( - args: DeleteHsmClientCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteHsmClientCertificateCommandOutput) => void), - cb?: (err: any, data?: DeleteHsmClientCertificateCommandOutput) => void - ): Promise | void { - const command = new DeleteHsmClientCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified Amazon Redshift HSM configuration.

+ * @see {@link DeleteHsmConfigurationCommand} */ - public deleteHsmConfiguration( + deleteHsmConfiguration( args: DeleteHsmConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteHsmConfiguration( + deleteHsmConfiguration( args: DeleteHsmConfigurationCommandInput, cb: (err: any, data?: DeleteHsmConfigurationCommandOutput) => void ): void; - public deleteHsmConfiguration( + deleteHsmConfiguration( args: DeleteHsmConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHsmConfigurationCommandOutput) => void ): void; - public deleteHsmConfiguration( - args: DeleteHsmConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteHsmConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteHsmConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteHsmConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a partner integration from a cluster. Data can still flow to the cluster until the integration is deleted at the partner's website.

+ * @see {@link DeletePartnerCommand} */ - public deletePartner( - args: DeletePartnerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deletePartner( - args: DeletePartnerCommandInput, - cb: (err: any, data?: DeletePartnerCommandOutput) => void - ): void; - public deletePartner( + deletePartner(args: DeletePartnerCommandInput, options?: __HttpHandlerOptions): Promise; + deletePartner(args: DeletePartnerCommandInput, cb: (err: any, data?: DeletePartnerCommandOutput) => void): void; + deletePartner( args: DeletePartnerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePartnerCommandOutput) => void ): void; - public deletePartner( - args: DeletePartnerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePartnerCommandOutput) => void), - cb?: (err: any, data?: DeletePartnerCommandOutput) => void - ): Promise | void { - const command = new DeletePartnerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a scheduled action. - *

+ * @see {@link DeleteScheduledActionCommand} */ - public deleteScheduledAction( + deleteScheduledAction( args: DeleteScheduledActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteScheduledAction( + deleteScheduledAction( args: DeleteScheduledActionCommandInput, cb: (err: any, data?: DeleteScheduledActionCommandOutput) => void ): void; - public deleteScheduledAction( + deleteScheduledAction( args: DeleteScheduledActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteScheduledActionCommandOutput) => void ): void; - public deleteScheduledAction( - args: DeleteScheduledActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteScheduledActionCommandOutput) => void), - cb?: (err: any, data?: DeleteScheduledActionCommandOutput) => void - ): Promise | void { - const command = new DeleteScheduledActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified snapshot copy grant.

+ * @see {@link DeleteSnapshotCopyGrantCommand} */ - public deleteSnapshotCopyGrant( + deleteSnapshotCopyGrant( args: DeleteSnapshotCopyGrantCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSnapshotCopyGrant( + deleteSnapshotCopyGrant( args: DeleteSnapshotCopyGrantCommandInput, cb: (err: any, data?: DeleteSnapshotCopyGrantCommandOutput) => void ): void; - public deleteSnapshotCopyGrant( + deleteSnapshotCopyGrant( args: DeleteSnapshotCopyGrantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSnapshotCopyGrantCommandOutput) => void ): void; - public deleteSnapshotCopyGrant( - args: DeleteSnapshotCopyGrantCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSnapshotCopyGrantCommandOutput) => void), - cb?: (err: any, data?: DeleteSnapshotCopyGrantCommandOutput) => void - ): Promise | void { - const command = new DeleteSnapshotCopyGrantCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a snapshot schedule.

+ * @see {@link DeleteSnapshotScheduleCommand} */ - public deleteSnapshotSchedule( + deleteSnapshotSchedule( args: DeleteSnapshotScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSnapshotSchedule( + deleteSnapshotSchedule( args: DeleteSnapshotScheduleCommandInput, cb: (err: any, data?: DeleteSnapshotScheduleCommandOutput) => void ): void; - public deleteSnapshotSchedule( + deleteSnapshotSchedule( args: DeleteSnapshotScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSnapshotScheduleCommandOutput) => void ): void; - public deleteSnapshotSchedule( - args: DeleteSnapshotScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSnapshotScheduleCommandOutput) => void), - cb?: (err: any, data?: DeleteSnapshotScheduleCommandOutput) => void - ): Promise | void { - const command = new DeleteSnapshotScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes tags from a resource. You must provide the ARN of the resource - * from which you want to delete the tag or tags.

+ * @see {@link DeleteTagsCommand} */ - public deleteTags(args: DeleteTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteTags(args: DeleteTagsCommandInput, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void; - public deleteTags( + deleteTags(args: DeleteTagsCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTags(args: DeleteTagsCommandInput, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void; + deleteTags( args: DeleteTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTagsCommandOutput) => void ): void; - public deleteTags( - args: DeleteTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTagsCommandOutput) => void), - cb?: (err: any, data?: DeleteTagsCommandOutput) => void - ): Promise | void { - const command = new DeleteTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a usage limit from a cluster.

+ * @see {@link DeleteUsageLimitCommand} */ - public deleteUsageLimit( + deleteUsageLimit( args: DeleteUsageLimitCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteUsageLimit( + deleteUsageLimit( args: DeleteUsageLimitCommandInput, cb: (err: any, data?: DeleteUsageLimitCommandOutput) => void ): void; - public deleteUsageLimit( + deleteUsageLimit( args: DeleteUsageLimitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUsageLimitCommandOutput) => void ): void; - public deleteUsageLimit( - args: DeleteUsageLimitCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUsageLimitCommandOutput) => void), - cb?: (err: any, data?: DeleteUsageLimitCommandOutput) => void - ): Promise | void { - const command = new DeleteUsageLimitCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of attributes attached to an account

+ * @see {@link DescribeAccountAttributesCommand} */ - public describeAccountAttributes( + describeAccountAttributes( args: DescribeAccountAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccountAttributes( + describeAccountAttributes( args: DescribeAccountAttributesCommandInput, cb: (err: any, data?: DescribeAccountAttributesCommandOutput) => void ): void; - public describeAccountAttributes( + describeAccountAttributes( args: DescribeAccountAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountAttributesCommandOutput) => void ): void; - public describeAccountAttributes( - args: DescribeAccountAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccountAttributesCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountAttributesCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an authentication profile.

+ * @see {@link DescribeAuthenticationProfilesCommand} */ - public describeAuthenticationProfiles( + describeAuthenticationProfiles( args: DescribeAuthenticationProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAuthenticationProfiles( + describeAuthenticationProfiles( args: DescribeAuthenticationProfilesCommandInput, cb: (err: any, data?: DescribeAuthenticationProfilesCommandOutput) => void ): void; - public describeAuthenticationProfiles( + describeAuthenticationProfiles( args: DescribeAuthenticationProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAuthenticationProfilesCommandOutput) => void ): void; - public describeAuthenticationProfiles( - args: DescribeAuthenticationProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAuthenticationProfilesCommandOutput) => void), - cb?: (err: any, data?: DescribeAuthenticationProfilesCommandOutput) => void - ): Promise | void { - const command = new DescribeAuthenticationProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of ClusterDbRevision objects.

+ * @see {@link DescribeClusterDbRevisionsCommand} */ - public describeClusterDbRevisions( + describeClusterDbRevisions( args: DescribeClusterDbRevisionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClusterDbRevisions( + describeClusterDbRevisions( args: DescribeClusterDbRevisionsCommandInput, cb: (err: any, data?: DescribeClusterDbRevisionsCommandOutput) => void ): void; - public describeClusterDbRevisions( + describeClusterDbRevisions( args: DescribeClusterDbRevisionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClusterDbRevisionsCommandOutput) => void ): void; - public describeClusterDbRevisions( - args: DescribeClusterDbRevisionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClusterDbRevisionsCommandOutput) => void), - cb?: (err: any, data?: DescribeClusterDbRevisionsCommandOutput) => void - ): Promise | void { - const command = new DescribeClusterDbRevisionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of Amazon Redshift parameter groups, including parameter groups you - * created and the default parameter group. For each parameter group, the response includes - * the parameter group name, description, and parameter group family name. You can - * optionally specify a name to retrieve the description of a specific parameter - * group.

- *

- * For more information about parameters and parameter groups, go to - * Amazon Redshift Parameter Groups - * in the Amazon Redshift Cluster Management Guide.

- *

If you specify both tag keys and tag values in the same request, Amazon Redshift returns - * all parameter groups that match any combination of the specified keys and values. For - * example, if you have owner and environment for tag keys, and - * admin and test for tag values, all parameter groups that - * have any combination of those values are returned.

- *

If both tag keys and values are omitted from the request, parameter groups are - * returned regardless of whether they have tag keys or values associated with - * them.

+ * @see {@link DescribeClusterParameterGroupsCommand} */ - public describeClusterParameterGroups( + describeClusterParameterGroups( args: DescribeClusterParameterGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClusterParameterGroups( + describeClusterParameterGroups( args: DescribeClusterParameterGroupsCommandInput, cb: (err: any, data?: DescribeClusterParameterGroupsCommandOutput) => void ): void; - public describeClusterParameterGroups( + describeClusterParameterGroups( args: DescribeClusterParameterGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClusterParameterGroupsCommandOutput) => void ): void; - public describeClusterParameterGroups( - args: DescribeClusterParameterGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClusterParameterGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeClusterParameterGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeClusterParameterGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a detailed list of parameters contained within the specified Amazon Redshift - * parameter group. For each parameter the response includes information such as parameter - * name, description, data type, value, whether the parameter value is modifiable, and so - * on.

- *

You can specify source filter to retrieve parameters of only - * specific type. For example, to retrieve parameters that were modified by a user action - * such as from ModifyClusterParameterGroup, you can specify - * source equal to user.

- *

- * For more information about parameters and parameter groups, go to - * Amazon Redshift Parameter Groups - * in the Amazon Redshift Cluster Management Guide.

+ * @see {@link DescribeClusterParametersCommand} */ - public describeClusterParameters( + describeClusterParameters( args: DescribeClusterParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClusterParameters( + describeClusterParameters( args: DescribeClusterParametersCommandInput, cb: (err: any, data?: DescribeClusterParametersCommandOutput) => void ): void; - public describeClusterParameters( + describeClusterParameters( args: DescribeClusterParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClusterParametersCommandOutput) => void ): void; - public describeClusterParameters( - args: DescribeClusterParametersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClusterParametersCommandOutput) => void), - cb?: (err: any, data?: DescribeClusterParametersCommandOutput) => void - ): Promise | void { - const command = new DescribeClusterParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns properties of provisioned clusters including general cluster properties, - * cluster database properties, maintenance and backup properties, and security and access - * properties. This operation supports pagination. - * For more information about managing clusters, go to - * Amazon Redshift Clusters - * in the Amazon Redshift Cluster Management Guide.

- *

If you specify both tag keys and tag values in the same request, Amazon Redshift returns - * all clusters that match any combination of the specified keys and values. For example, - * if you have owner and environment for tag keys, and - * admin and test for tag values, all clusters that have any - * combination of those values are returned.

- *

If both tag keys and values are omitted from the request, clusters are returned - * regardless of whether they have tag keys or values associated with them.

+ * @see {@link DescribeClustersCommand} */ - public describeClusters( + describeClusters( args: DescribeClustersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClusters( + describeClusters( args: DescribeClustersCommandInput, cb: (err: any, data?: DescribeClustersCommandOutput) => void ): void; - public describeClusters( + describeClusters( args: DescribeClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClustersCommandOutput) => void ): void; - public describeClusters( - args: DescribeClustersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClustersCommandOutput) => void), - cb?: (err: any, data?: DescribeClustersCommandOutput) => void - ): Promise | void { - const command = new DescribeClustersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about Amazon Redshift security groups. If the name of a security - * group is specified, the response will contain only information about only that security - * group.

- *

- * For information about managing security groups, go to - * Amazon Redshift Cluster Security Groups in the - * Amazon Redshift Cluster Management Guide.

- *

If you specify both tag keys and tag values in the same request, Amazon Redshift returns - * all security groups that match any combination of the specified keys and values. For - * example, if you have owner and environment for tag keys, and - * admin and test for tag values, all security groups that - * have any combination of those values are returned.

- *

If both tag keys and values are omitted from the request, security groups are - * returned regardless of whether they have tag keys or values associated with - * them.

+ * @see {@link DescribeClusterSecurityGroupsCommand} */ - public describeClusterSecurityGroups( + describeClusterSecurityGroups( args: DescribeClusterSecurityGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClusterSecurityGroups( + describeClusterSecurityGroups( args: DescribeClusterSecurityGroupsCommandInput, cb: (err: any, data?: DescribeClusterSecurityGroupsCommandOutput) => void ): void; - public describeClusterSecurityGroups( + describeClusterSecurityGroups( args: DescribeClusterSecurityGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClusterSecurityGroupsCommandOutput) => void ): void; - public describeClusterSecurityGroups( - args: DescribeClusterSecurityGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClusterSecurityGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeClusterSecurityGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeClusterSecurityGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns one or more snapshot objects, which contain metadata about your cluster - * snapshots. By default, this operation returns information about all snapshots of all - * clusters that are owned by your Amazon Web Services account. No information is returned for - * snapshots owned by inactive Amazon Web Services accounts.

- *

If you specify both tag keys and tag values in the same request, Amazon Redshift returns - * all snapshots that match any combination of the specified keys and values. For example, - * if you have owner and environment for tag keys, and - * admin and test for tag values, all snapshots that have any - * combination of those values are returned. Only snapshots that you own are returned in - * the response; shared snapshots are not returned with the tag key and tag value request - * parameters.

- *

If both tag keys and values are omitted from the request, snapshots are returned - * regardless of whether they have tag keys or values associated with them.

+ * @see {@link DescribeClusterSnapshotsCommand} */ - public describeClusterSnapshots( + describeClusterSnapshots( args: DescribeClusterSnapshotsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClusterSnapshots( + describeClusterSnapshots( args: DescribeClusterSnapshotsCommandInput, cb: (err: any, data?: DescribeClusterSnapshotsCommandOutput) => void ): void; - public describeClusterSnapshots( + describeClusterSnapshots( args: DescribeClusterSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClusterSnapshotsCommandOutput) => void ): void; - public describeClusterSnapshots( - args: DescribeClusterSnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClusterSnapshotsCommandOutput) => void), - cb?: (err: any, data?: DescribeClusterSnapshotsCommandOutput) => void - ): Promise | void { - const command = new DescribeClusterSnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns one or more cluster subnet group objects, which contain metadata about your - * cluster subnet groups. By default, this operation returns information about all cluster - * subnet groups that are defined in your Amazon Web Services account.

- *

If you specify both tag keys and tag values in the same request, Amazon Redshift returns - * all subnet groups that match any combination of the specified keys and values. For - * example, if you have owner and environment for tag keys, and - * admin and test for tag values, all subnet groups that have - * any combination of those values are returned.

- *

If both tag keys and values are omitted from the request, subnet groups are - * returned regardless of whether they have tag keys or values associated with - * them.

+ * @see {@link DescribeClusterSubnetGroupsCommand} */ - public describeClusterSubnetGroups( + describeClusterSubnetGroups( args: DescribeClusterSubnetGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClusterSubnetGroups( + describeClusterSubnetGroups( args: DescribeClusterSubnetGroupsCommandInput, cb: (err: any, data?: DescribeClusterSubnetGroupsCommandOutput) => void ): void; - public describeClusterSubnetGroups( + describeClusterSubnetGroups( args: DescribeClusterSubnetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClusterSubnetGroupsCommandOutput) => void ): void; - public describeClusterSubnetGroups( - args: DescribeClusterSubnetGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClusterSubnetGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeClusterSubnetGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeClusterSubnetGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all the available maintenance tracks.

+ * @see {@link DescribeClusterTracksCommand} */ - public describeClusterTracks( + describeClusterTracks( args: DescribeClusterTracksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClusterTracks( + describeClusterTracks( args: DescribeClusterTracksCommandInput, cb: (err: any, data?: DescribeClusterTracksCommandOutput) => void ): void; - public describeClusterTracks( + describeClusterTracks( args: DescribeClusterTracksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClusterTracksCommandOutput) => void ): void; - public describeClusterTracks( - args: DescribeClusterTracksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClusterTracksCommandOutput) => void), - cb?: (err: any, data?: DescribeClusterTracksCommandOutput) => void - ): Promise | void { - const command = new DescribeClusterTracksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns descriptions of the available Amazon Redshift cluster versions. You can call this - * operation even before creating any clusters to learn more about the Amazon Redshift versions. - * - * For more information about managing clusters, go to - * Amazon Redshift Clusters - * in the Amazon Redshift Cluster Management Guide.

+ * @see {@link DescribeClusterVersionsCommand} */ - public describeClusterVersions( + describeClusterVersions( args: DescribeClusterVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClusterVersions( + describeClusterVersions( args: DescribeClusterVersionsCommandInput, cb: (err: any, data?: DescribeClusterVersionsCommandOutput) => void ): void; - public describeClusterVersions( + describeClusterVersions( args: DescribeClusterVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClusterVersionsCommandOutput) => void ): void; - public describeClusterVersions( - args: DescribeClusterVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClusterVersionsCommandOutput) => void), - cb?: (err: any, data?: DescribeClusterVersionsCommandOutput) => void - ): Promise | void { - const command = new DescribeClusterVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Shows the status of any inbound or outbound datashares available in the specified - * account.

+ * @see {@link DescribeDataSharesCommand} */ - public describeDataShares( + describeDataShares( args: DescribeDataSharesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDataShares( + describeDataShares( args: DescribeDataSharesCommandInput, cb: (err: any, data?: DescribeDataSharesCommandOutput) => void ): void; - public describeDataShares( + describeDataShares( args: DescribeDataSharesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataSharesCommandOutput) => void ): void; - public describeDataShares( - args: DescribeDataSharesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDataSharesCommandOutput) => void), - cb?: (err: any, data?: DescribeDataSharesCommandOutput) => void - ): Promise | void { - const command = new DescribeDataSharesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of datashares where the account identifier being called is a consumer account identifier.

+ * @see {@link DescribeDataSharesForConsumerCommand} */ - public describeDataSharesForConsumer( + describeDataSharesForConsumer( args: DescribeDataSharesForConsumerCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDataSharesForConsumer( + describeDataSharesForConsumer( args: DescribeDataSharesForConsumerCommandInput, cb: (err: any, data?: DescribeDataSharesForConsumerCommandOutput) => void ): void; - public describeDataSharesForConsumer( + describeDataSharesForConsumer( args: DescribeDataSharesForConsumerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataSharesForConsumerCommandOutput) => void ): void; - public describeDataSharesForConsumer( - args: DescribeDataSharesForConsumerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDataSharesForConsumerCommandOutput) => void), - cb?: (err: any, data?: DescribeDataSharesForConsumerCommandOutput) => void - ): Promise | void { - const command = new DescribeDataSharesForConsumerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of datashares when the account identifier being called is a producer account identifier.

+ * @see {@link DescribeDataSharesForProducerCommand} */ - public describeDataSharesForProducer( + describeDataSharesForProducer( args: DescribeDataSharesForProducerCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDataSharesForProducer( + describeDataSharesForProducer( args: DescribeDataSharesForProducerCommandInput, cb: (err: any, data?: DescribeDataSharesForProducerCommandOutput) => void ): void; - public describeDataSharesForProducer( + describeDataSharesForProducer( args: DescribeDataSharesForProducerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataSharesForProducerCommandOutput) => void ): void; - public describeDataSharesForProducer( - args: DescribeDataSharesForProducerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDataSharesForProducerCommandOutput) => void), - cb?: (err: any, data?: DescribeDataSharesForProducerCommandOutput) => void - ): Promise | void { - const command = new DescribeDataSharesForProducerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of parameter settings for the specified parameter group - * family.

- *

- * For more information about parameters and parameter groups, go to - * Amazon Redshift Parameter Groups - * in the Amazon Redshift Cluster Management Guide.

+ * @see {@link DescribeDefaultClusterParametersCommand} */ - public describeDefaultClusterParameters( + describeDefaultClusterParameters( args: DescribeDefaultClusterParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDefaultClusterParameters( + describeDefaultClusterParameters( args: DescribeDefaultClusterParametersCommandInput, cb: (err: any, data?: DescribeDefaultClusterParametersCommandOutput) => void ): void; - public describeDefaultClusterParameters( + describeDefaultClusterParameters( args: DescribeDefaultClusterParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDefaultClusterParametersCommandOutput) => void ): void; - public describeDefaultClusterParameters( - args: DescribeDefaultClusterParametersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDefaultClusterParametersCommandOutput) => void), - cb?: (err: any, data?: DescribeDefaultClusterParametersCommandOutput) => void - ): Promise | void { - const command = new DescribeDefaultClusterParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a Redshift-managed VPC endpoint.

+ * @see {@link DescribeEndpointAccessCommand} */ - public describeEndpointAccess( + describeEndpointAccess( args: DescribeEndpointAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEndpointAccess( + describeEndpointAccess( args: DescribeEndpointAccessCommandInput, cb: (err: any, data?: DescribeEndpointAccessCommandOutput) => void ): void; - public describeEndpointAccess( + describeEndpointAccess( args: DescribeEndpointAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEndpointAccessCommandOutput) => void ): void; - public describeEndpointAccess( - args: DescribeEndpointAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEndpointAccessCommandOutput) => void), - cb?: (err: any, data?: DescribeEndpointAccessCommandOutput) => void - ): Promise | void { - const command = new DescribeEndpointAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an endpoint authorization.

+ * @see {@link DescribeEndpointAuthorizationCommand} */ - public describeEndpointAuthorization( + describeEndpointAuthorization( args: DescribeEndpointAuthorizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEndpointAuthorization( + describeEndpointAuthorization( args: DescribeEndpointAuthorizationCommandInput, cb: (err: any, data?: DescribeEndpointAuthorizationCommandOutput) => void ): void; - public describeEndpointAuthorization( + describeEndpointAuthorization( args: DescribeEndpointAuthorizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEndpointAuthorizationCommandOutput) => void ): void; - public describeEndpointAuthorization( - args: DescribeEndpointAuthorizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEndpointAuthorizationCommandOutput) => void), - cb?: (err: any, data?: DescribeEndpointAuthorizationCommandOutput) => void - ): Promise | void { - const command = new DescribeEndpointAuthorizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays a list of event categories for all event source types, or for a specified - * source type. For a list of the event categories and source types, go to Amazon Redshift Event - * Notifications.

+ * @see {@link DescribeEventCategoriesCommand} */ - public describeEventCategories( + describeEventCategories( args: DescribeEventCategoriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventCategories( + describeEventCategories( args: DescribeEventCategoriesCommandInput, cb: (err: any, data?: DescribeEventCategoriesCommandOutput) => void ): void; - public describeEventCategories( + describeEventCategories( args: DescribeEventCategoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventCategoriesCommandOutput) => void ): void; - public describeEventCategories( - args: DescribeEventCategoriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventCategoriesCommandOutput) => void), - cb?: (err: any, data?: DescribeEventCategoriesCommandOutput) => void - ): Promise | void { - const command = new DescribeEventCategoriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns events related to clusters, security groups, snapshots, and parameter - * groups for the past 14 days. Events specific to a particular cluster, security group, - * snapshot or parameter group can be obtained by providing the name as a parameter. By - * default, the past hour of events are returned.

+ * @see {@link DescribeEventsCommand} */ - public describeEvents( + describeEvents( args: DescribeEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEvents( - args: DescribeEventsCommandInput, - cb: (err: any, data?: DescribeEventsCommandOutput) => void - ): void; - public describeEvents( + describeEvents(args: DescribeEventsCommandInput, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void; + describeEvents( args: DescribeEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsCommandOutput) => void ): void; - public describeEvents( - args: DescribeEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventsCommandOutput) => void), - cb?: (err: any, data?: DescribeEventsCommandOutput) => void - ): Promise | void { - const command = new DescribeEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists descriptions of all the Amazon Redshift event notification subscriptions for a - * customer account. If you specify a subscription name, lists the description for that - * subscription.

- *

If you specify both tag keys and tag values in the same request, Amazon Redshift returns - * all event notification subscriptions that match any combination of the specified keys - * and values. For example, if you have owner and environment for - * tag keys, and admin and test for tag values, all subscriptions - * that have any combination of those values are returned.

- *

If both tag keys and values are omitted from the request, subscriptions are - * returned regardless of whether they have tag keys or values associated with - * them.

+ * @see {@link DescribeEventSubscriptionsCommand} */ - public describeEventSubscriptions( + describeEventSubscriptions( args: DescribeEventSubscriptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEventSubscriptions( + describeEventSubscriptions( args: DescribeEventSubscriptionsCommandInput, cb: (err: any, data?: DescribeEventSubscriptionsCommandOutput) => void ): void; - public describeEventSubscriptions( + describeEventSubscriptions( args: DescribeEventSubscriptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventSubscriptionsCommandOutput) => void ): void; - public describeEventSubscriptions( - args: DescribeEventSubscriptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEventSubscriptionsCommandOutput) => void), - cb?: (err: any, data?: DescribeEventSubscriptionsCommandOutput) => void - ): Promise | void { - const command = new DescribeEventSubscriptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the specified HSM client certificate. If no certificate - * ID is specified, returns information about all the HSM certificates owned by your Amazon Web Services account.

- *

If you specify both tag keys and tag values in the same request, Amazon Redshift returns - * all HSM client certificates that match any combination of the specified keys and values. - * For example, if you have owner and environment for tag keys, - * and admin and test for tag values, all HSM client certificates - * that have any combination of those values are returned.

- *

If both tag keys and values are omitted from the request, HSM client certificates - * are returned regardless of whether they have tag keys or values associated with - * them.

+ * @see {@link DescribeHsmClientCertificatesCommand} */ - public describeHsmClientCertificates( + describeHsmClientCertificates( args: DescribeHsmClientCertificatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeHsmClientCertificates( + describeHsmClientCertificates( args: DescribeHsmClientCertificatesCommandInput, cb: (err: any, data?: DescribeHsmClientCertificatesCommandOutput) => void ): void; - public describeHsmClientCertificates( + describeHsmClientCertificates( args: DescribeHsmClientCertificatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHsmClientCertificatesCommandOutput) => void ): void; - public describeHsmClientCertificates( - args: DescribeHsmClientCertificatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeHsmClientCertificatesCommandOutput) => void), - cb?: (err: any, data?: DescribeHsmClientCertificatesCommandOutput) => void - ): Promise | void { - const command = new DescribeHsmClientCertificatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the specified Amazon Redshift HSM configuration. If no - * configuration ID is specified, returns information about all the HSM configurations - * owned by your Amazon Web Services account.

- *

If you specify both tag keys and tag values in the same request, Amazon Redshift returns - * all HSM connections that match any combination of the specified keys and values. For - * example, if you have owner and environment for tag keys, and - * admin and test for tag values, all HSM connections that - * have any combination of those values are returned.

- *

If both tag keys and values are omitted from the request, HSM connections are - * returned regardless of whether they have tag keys or values associated with - * them.

+ * @see {@link DescribeHsmConfigurationsCommand} */ - public describeHsmConfigurations( + describeHsmConfigurations( args: DescribeHsmConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeHsmConfigurations( + describeHsmConfigurations( args: DescribeHsmConfigurationsCommandInput, cb: (err: any, data?: DescribeHsmConfigurationsCommandOutput) => void ): void; - public describeHsmConfigurations( + describeHsmConfigurations( args: DescribeHsmConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHsmConfigurationsCommandOutput) => void ): void; - public describeHsmConfigurations( - args: DescribeHsmConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeHsmConfigurationsCommandOutput) => void), - cb?: (err: any, data?: DescribeHsmConfigurationsCommandOutput) => void - ): Promise | void { - const command = new DescribeHsmConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes whether information, such as queries and connection attempts, is being - * logged for the specified Amazon Redshift cluster.

+ * @see {@link DescribeLoggingStatusCommand} */ - public describeLoggingStatus( + describeLoggingStatus( args: DescribeLoggingStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLoggingStatus( + describeLoggingStatus( args: DescribeLoggingStatusCommandInput, cb: (err: any, data?: DescribeLoggingStatusCommandOutput) => void ): void; - public describeLoggingStatus( + describeLoggingStatus( args: DescribeLoggingStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLoggingStatusCommandOutput) => void ): void; - public describeLoggingStatus( - args: DescribeLoggingStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLoggingStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeLoggingStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeLoggingStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns properties of possible node configurations such as node type, number of nodes, and - * disk usage for the specified action type.

+ * @see {@link DescribeNodeConfigurationOptionsCommand} */ - public describeNodeConfigurationOptions( + describeNodeConfigurationOptions( args: DescribeNodeConfigurationOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNodeConfigurationOptions( + describeNodeConfigurationOptions( args: DescribeNodeConfigurationOptionsCommandInput, cb: (err: any, data?: DescribeNodeConfigurationOptionsCommandOutput) => void ): void; - public describeNodeConfigurationOptions( + describeNodeConfigurationOptions( args: DescribeNodeConfigurationOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNodeConfigurationOptionsCommandOutput) => void ): void; - public describeNodeConfigurationOptions( - args: DescribeNodeConfigurationOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeNodeConfigurationOptionsCommandOutput) => void), - cb?: (err: any, data?: DescribeNodeConfigurationOptionsCommandOutput) => void - ): Promise | void { - const command = new DescribeNodeConfigurationOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of orderable cluster options. Before you create a new cluster you - * can use this operation to find what options are available, such as the EC2 Availability - * Zones (AZ) in the specific Amazon Web Services Region that you can specify, and the node types you can - * request. The node types differ by available storage, memory, CPU and price. With the - * cost involved you might want to obtain a list of cluster options in the specific region - * and specify values when creating a cluster. - * For more information about managing clusters, go to - * Amazon Redshift Clusters - * in the Amazon Redshift Cluster Management Guide.

+ * @see {@link DescribeOrderableClusterOptionsCommand} */ - public describeOrderableClusterOptions( + describeOrderableClusterOptions( args: DescribeOrderableClusterOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOrderableClusterOptions( + describeOrderableClusterOptions( args: DescribeOrderableClusterOptionsCommandInput, cb: (err: any, data?: DescribeOrderableClusterOptionsCommandOutput) => void ): void; - public describeOrderableClusterOptions( + describeOrderableClusterOptions( args: DescribeOrderableClusterOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrderableClusterOptionsCommandOutput) => void ): void; - public describeOrderableClusterOptions( - args: DescribeOrderableClusterOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOrderableClusterOptionsCommandOutput) => void), - cb?: (err: any, data?: DescribeOrderableClusterOptionsCommandOutput) => void - ): Promise | void { - const command = new DescribeOrderableClusterOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the partner integrations defined for a cluster.

+ * @see {@link DescribePartnersCommand} */ - public describePartners( + describePartners( args: DescribePartnersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePartners( + describePartners( args: DescribePartnersCommandInput, cb: (err: any, data?: DescribePartnersCommandOutput) => void ): void; - public describePartners( + describePartners( args: DescribePartnersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePartnersCommandOutput) => void ): void; - public describePartners( - args: DescribePartnersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePartnersCommandOutput) => void), - cb?: (err: any, data?: DescribePartnersCommandOutput) => void - ): Promise | void { - const command = new DescribePartnersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns exchange status details and associated metadata for a reserved-node - * exchange. Statuses include such values as in progress and requested.

+ * @see {@link DescribeReservedNodeExchangeStatusCommand} */ - public describeReservedNodeExchangeStatus( + describeReservedNodeExchangeStatus( args: DescribeReservedNodeExchangeStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReservedNodeExchangeStatus( + describeReservedNodeExchangeStatus( args: DescribeReservedNodeExchangeStatusCommandInput, cb: (err: any, data?: DescribeReservedNodeExchangeStatusCommandOutput) => void ): void; - public describeReservedNodeExchangeStatus( + describeReservedNodeExchangeStatus( args: DescribeReservedNodeExchangeStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReservedNodeExchangeStatusCommandOutput) => void ): void; - public describeReservedNodeExchangeStatus( - args: DescribeReservedNodeExchangeStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReservedNodeExchangeStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeReservedNodeExchangeStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeReservedNodeExchangeStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the available reserved node offerings by Amazon Redshift with their - * descriptions including the node type, the fixed and recurring costs of reserving the - * node and duration the node will be reserved for you. These descriptions help you - * determine which reserve node offering you want to purchase. You then use the unique - * offering ID in you call to PurchaseReservedNodeOffering to reserve one - * or more nodes for your Amazon Redshift cluster.

- *

- * For more information about reserved node offerings, go to - * Purchasing Reserved Nodes - * in the Amazon Redshift Cluster Management Guide.

+ * @see {@link DescribeReservedNodeOfferingsCommand} */ - public describeReservedNodeOfferings( + describeReservedNodeOfferings( args: DescribeReservedNodeOfferingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReservedNodeOfferings( + describeReservedNodeOfferings( args: DescribeReservedNodeOfferingsCommandInput, cb: (err: any, data?: DescribeReservedNodeOfferingsCommandOutput) => void ): void; - public describeReservedNodeOfferings( + describeReservedNodeOfferings( args: DescribeReservedNodeOfferingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReservedNodeOfferingsCommandOutput) => void ): void; - public describeReservedNodeOfferings( - args: DescribeReservedNodeOfferingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReservedNodeOfferingsCommandOutput) => void), - cb?: (err: any, data?: DescribeReservedNodeOfferingsCommandOutput) => void - ): Promise | void { - const command = new DescribeReservedNodeOfferingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the descriptions of the reserved nodes.

+ * @see {@link DescribeReservedNodesCommand} */ - public describeReservedNodes( + describeReservedNodes( args: DescribeReservedNodesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReservedNodes( + describeReservedNodes( args: DescribeReservedNodesCommandInput, cb: (err: any, data?: DescribeReservedNodesCommandOutput) => void ): void; - public describeReservedNodes( + describeReservedNodes( args: DescribeReservedNodesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReservedNodesCommandOutput) => void ): void; - public describeReservedNodes( - args: DescribeReservedNodesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReservedNodesCommandOutput) => void), - cb?: (err: any, data?: DescribeReservedNodesCommandOutput) => void - ): Promise | void { - const command = new DescribeReservedNodesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the last resize operation for the specified cluster. If - * no resize operation has ever been initiated for the specified cluster, a HTTP - * 404 error is returned. If a resize operation was initiated and completed, the - * status of the resize remains as SUCCEEDED until the next resize.

- *

A resize operation can be requested using ModifyCluster and - * specifying a different number or type of nodes for the cluster.

+ * @see {@link DescribeResizeCommand} */ - public describeResize( + describeResize( args: DescribeResizeCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeResize( - args: DescribeResizeCommandInput, - cb: (err: any, data?: DescribeResizeCommandOutput) => void - ): void; - public describeResize( + describeResize(args: DescribeResizeCommandInput, cb: (err: any, data?: DescribeResizeCommandOutput) => void): void; + describeResize( args: DescribeResizeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeResizeCommandOutput) => void ): void; - public describeResize( - args: DescribeResizeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeResizeCommandOutput) => void), - cb?: (err: any, data?: DescribeResizeCommandOutput) => void - ): Promise | void { - const command = new DescribeResizeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes properties of scheduled actions. - *

+ * @see {@link DescribeScheduledActionsCommand} */ - public describeScheduledActions( + describeScheduledActions( args: DescribeScheduledActionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeScheduledActions( + describeScheduledActions( args: DescribeScheduledActionsCommandInput, cb: (err: any, data?: DescribeScheduledActionsCommandOutput) => void ): void; - public describeScheduledActions( + describeScheduledActions( args: DescribeScheduledActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScheduledActionsCommandOutput) => void ): void; - public describeScheduledActions( - args: DescribeScheduledActionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeScheduledActionsCommandOutput) => void), - cb?: (err: any, data?: DescribeScheduledActionsCommandOutput) => void - ): Promise | void { - const command = new DescribeScheduledActionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination - * region.

- *

- * For more information about managing snapshot copy grants, go to - * Amazon Redshift Database Encryption - * in the Amazon Redshift Cluster Management Guide. - *

+ * @see {@link DescribeSnapshotCopyGrantsCommand} */ - public describeSnapshotCopyGrants( + describeSnapshotCopyGrants( args: DescribeSnapshotCopyGrantsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSnapshotCopyGrants( + describeSnapshotCopyGrants( args: DescribeSnapshotCopyGrantsCommandInput, cb: (err: any, data?: DescribeSnapshotCopyGrantsCommandOutput) => void ): void; - public describeSnapshotCopyGrants( + describeSnapshotCopyGrants( args: DescribeSnapshotCopyGrantsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSnapshotCopyGrantsCommandOutput) => void ): void; - public describeSnapshotCopyGrants( - args: DescribeSnapshotCopyGrantsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSnapshotCopyGrantsCommandOutput) => void), - cb?: (err: any, data?: DescribeSnapshotCopyGrantsCommandOutput) => void - ): Promise | void { - const command = new DescribeSnapshotCopyGrantsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of snapshot schedules.

+ * @see {@link DescribeSnapshotSchedulesCommand} */ - public describeSnapshotSchedules( + describeSnapshotSchedules( args: DescribeSnapshotSchedulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSnapshotSchedules( + describeSnapshotSchedules( args: DescribeSnapshotSchedulesCommandInput, cb: (err: any, data?: DescribeSnapshotSchedulesCommandOutput) => void ): void; - public describeSnapshotSchedules( + describeSnapshotSchedules( args: DescribeSnapshotSchedulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSnapshotSchedulesCommandOutput) => void ): void; - public describeSnapshotSchedules( - args: DescribeSnapshotSchedulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSnapshotSchedulesCommandOutput) => void), - cb?: (err: any, data?: DescribeSnapshotSchedulesCommandOutput) => void - ): Promise | void { - const command = new DescribeSnapshotSchedulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns account level backups storage size and provisional storage.

+ * @see {@link DescribeStorageCommand} */ - public describeStorage( + describeStorage( args: DescribeStorageCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStorage( - args: DescribeStorageCommandInput, - cb: (err: any, data?: DescribeStorageCommandOutput) => void - ): void; - public describeStorage( + describeStorage(args: DescribeStorageCommandInput, cb: (err: any, data?: DescribeStorageCommandOutput) => void): void; + describeStorage( args: DescribeStorageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStorageCommandOutput) => void ): void; - public describeStorage( - args: DescribeStorageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStorageCommandOutput) => void), - cb?: (err: any, data?: DescribeStorageCommandOutput) => void - ): Promise | void { - const command = new DescribeStorageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action. If you don't specify a value - * for the TableRestoreRequestId parameter, then - * DescribeTableRestoreStatus returns the status of all table restore - * requests ordered by the date and time of the request in ascending order. Otherwise - * DescribeTableRestoreStatus returns the status of the table specified by - * TableRestoreRequestId.

+ * @see {@link DescribeTableRestoreStatusCommand} */ - public describeTableRestoreStatus( + describeTableRestoreStatus( args: DescribeTableRestoreStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTableRestoreStatus( + describeTableRestoreStatus( args: DescribeTableRestoreStatusCommandInput, cb: (err: any, data?: DescribeTableRestoreStatusCommandOutput) => void ): void; - public describeTableRestoreStatus( + describeTableRestoreStatus( args: DescribeTableRestoreStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTableRestoreStatusCommandOutput) => void ): void; - public describeTableRestoreStatus( - args: DescribeTableRestoreStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTableRestoreStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeTableRestoreStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeTableRestoreStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of tags. You can return tags from a specific resource by specifying - * an ARN, or you can return all tags for a given type of resource, such as clusters, - * snapshots, and so on.

- *

The following are limitations for DescribeTags:

- *
    - *
  • - *

    You cannot specify an ARN and a resource-type value together in the same - * request.

    - *
  • - *
  • - *

    You cannot use the MaxRecords and Marker - * parameters together with the ARN parameter.

    - *
  • - *
  • - *

    The MaxRecords parameter can be a range from 10 to 50 results - * to return in a request.

    - *
  • - *
- *

If you specify both tag keys and tag values in the same request, Amazon Redshift returns - * all resources that match any combination of the specified keys and values. For example, - * if you have owner and environment for tag keys, and - * admin and test for tag values, all resources that have any - * combination of those values are returned.

- *

If both tag keys and values are omitted from the request, resources are returned - * regardless of whether they have tag keys or values associated with them.

+ * @see {@link DescribeTagsCommand} */ - public describeTags( - args: DescribeTagsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeTags(args: DescribeTagsCommandInput, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void; - public describeTags( + describeTags(args: DescribeTagsCommandInput, options?: __HttpHandlerOptions): Promise; + describeTags(args: DescribeTagsCommandInput, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void; + describeTags( args: DescribeTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTagsCommandOutput) => void ): void; - public describeTags( - args: DescribeTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTagsCommandOutput) => void), - cb?: (err: any, data?: DescribeTagsCommandOutput) => void - ): Promise | void { - const command = new DescribeTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Shows usage limits on a cluster. - * Results are filtered based on the combination of input usage limit identifier, cluster identifier, and feature type parameters:

- *
    - *
  • - *

    If usage limit identifier, cluster identifier, and feature type are not provided, - * then all usage limit objects for the current account in the current region are returned.

    - *
  • - *
  • - *

    If usage limit identifier is provided, - * then the corresponding usage limit object is returned.

    - *
  • - *
  • - *

    If cluster identifier is provided, - * then all usage limit objects for the specified cluster are returned.

    - *
  • - *
  • - *

    If cluster identifier and feature type are provided, - * then all usage limit objects for the combination of cluster and feature are returned.

    - *
  • - *
+ * @see {@link DescribeUsageLimitsCommand} */ - public describeUsageLimits( + describeUsageLimits( args: DescribeUsageLimitsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeUsageLimits( + describeUsageLimits( args: DescribeUsageLimitsCommandInput, cb: (err: any, data?: DescribeUsageLimitsCommandOutput) => void ): void; - public describeUsageLimits( + describeUsageLimits( args: DescribeUsageLimitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUsageLimitsCommandOutput) => void ): void; - public describeUsageLimits( - args: DescribeUsageLimitsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUsageLimitsCommandOutput) => void), - cb?: (err: any, data?: DescribeUsageLimitsCommandOutput) => void - ): Promise | void { - const command = new DescribeUsageLimitsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops logging information, such as queries and connection attempts, for the - * specified Amazon Redshift cluster.

+ * @see {@link DisableLoggingCommand} */ - public disableLogging( + disableLogging( args: DisableLoggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableLogging( - args: DisableLoggingCommandInput, - cb: (err: any, data?: DisableLoggingCommandOutput) => void - ): void; - public disableLogging( + disableLogging(args: DisableLoggingCommandInput, cb: (err: any, data?: DisableLoggingCommandOutput) => void): void; + disableLogging( args: DisableLoggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableLoggingCommandOutput) => void ): void; - public disableLogging( - args: DisableLoggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableLoggingCommandOutput) => void), - cb?: (err: any, data?: DisableLoggingCommandOutput) => void - ): Promise | void { - const command = new DisableLoggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables the automatic copying of snapshots from one region to another region for a - * specified cluster.

- *

If your cluster and its snapshots are encrypted using an encrypted symmetric key - * from Key Management Service, use DeleteSnapshotCopyGrant to delete the grant that - * grants Amazon Redshift permission to the key in the destination region.

+ * @see {@link DisableSnapshotCopyCommand} */ - public disableSnapshotCopy( + disableSnapshotCopy( args: DisableSnapshotCopyCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableSnapshotCopy( + disableSnapshotCopy( args: DisableSnapshotCopyCommandInput, cb: (err: any, data?: DisableSnapshotCopyCommandOutput) => void ): void; - public disableSnapshotCopy( + disableSnapshotCopy( args: DisableSnapshotCopyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableSnapshotCopyCommandOutput) => void ): void; - public disableSnapshotCopy( - args: DisableSnapshotCopyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableSnapshotCopyCommandOutput) => void), - cb?: (err: any, data?: DisableSnapshotCopyCommandOutput) => void - ): Promise | void { - const command = new DisableSnapshotCopyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

From a datashare consumer account, remove association for the specified datashare. - *

+ * @see {@link DisassociateDataShareConsumerCommand} */ - public disassociateDataShareConsumer( + disassociateDataShareConsumer( args: DisassociateDataShareConsumerCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateDataShareConsumer( + disassociateDataShareConsumer( args: DisassociateDataShareConsumerCommandInput, cb: (err: any, data?: DisassociateDataShareConsumerCommandOutput) => void ): void; - public disassociateDataShareConsumer( + disassociateDataShareConsumer( args: DisassociateDataShareConsumerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateDataShareConsumerCommandOutput) => void ): void; - public disassociateDataShareConsumer( - args: DisassociateDataShareConsumerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateDataShareConsumerCommandOutput) => void), - cb?: (err: any, data?: DisassociateDataShareConsumerCommandOutput) => void - ): Promise | void { - const command = new DisassociateDataShareConsumerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts logging information, such as queries and connection attempts, for the - * specified Amazon Redshift cluster.

+ * @see {@link EnableLoggingCommand} */ - public enableLogging( - args: EnableLoggingCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public enableLogging( - args: EnableLoggingCommandInput, - cb: (err: any, data?: EnableLoggingCommandOutput) => void - ): void; - public enableLogging( + enableLogging(args: EnableLoggingCommandInput, options?: __HttpHandlerOptions): Promise; + enableLogging(args: EnableLoggingCommandInput, cb: (err: any, data?: EnableLoggingCommandOutput) => void): void; + enableLogging( args: EnableLoggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableLoggingCommandOutput) => void ): void; - public enableLogging( - args: EnableLoggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableLoggingCommandOutput) => void), - cb?: (err: any, data?: EnableLoggingCommandOutput) => void - ): Promise | void { - const command = new EnableLoggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the automatic copy of snapshots from one region to another region for a - * specified cluster.

+ * @see {@link EnableSnapshotCopyCommand} */ - public enableSnapshotCopy( + enableSnapshotCopy( args: EnableSnapshotCopyCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableSnapshotCopy( + enableSnapshotCopy( args: EnableSnapshotCopyCommandInput, cb: (err: any, data?: EnableSnapshotCopyCommandOutput) => void ): void; - public enableSnapshotCopy( + enableSnapshotCopy( args: EnableSnapshotCopyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableSnapshotCopyCommandOutput) => void ): void; - public enableSnapshotCopy( - args: EnableSnapshotCopyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableSnapshotCopyCommandOutput) => void), - cb?: (err: any, data?: EnableSnapshotCopyCommandOutput) => void - ): Promise | void { - const command = new EnableSnapshotCopyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a database user name and temporary password with temporary authorization to - * log on to an Amazon Redshift database. The action returns the database user name - * prefixed with IAM: if AutoCreate is False or - * IAMA: if AutoCreate is True. You can - * optionally specify one or more database user groups that the user will join at log on. - * By default, the temporary credentials expire in 900 seconds. You can optionally specify - * a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more - * information, see Using IAM Authentication - * to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.

- *

The Identity and Access Management (IAM) user or role that runs - * GetClusterCredentials must have an IAM policy attached that allows access to all - * necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the - * Amazon Redshift Cluster Management Guide.

- *

If the DbGroups parameter is specified, the IAM policy must allow the - * redshift:JoinGroup action with access to the listed - * dbgroups.

- *

In addition, if the AutoCreate parameter is set to True, - * then the policy must include the redshift:CreateClusterUser - * permission.

- *

If the DbName parameter is specified, the IAM policy must allow access - * to the resource dbname for the specified database name.

+ * @see {@link GetClusterCredentialsCommand} */ - public getClusterCredentials( + getClusterCredentials( args: GetClusterCredentialsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getClusterCredentials( + getClusterCredentials( args: GetClusterCredentialsCommandInput, cb: (err: any, data?: GetClusterCredentialsCommandOutput) => void ): void; - public getClusterCredentials( + getClusterCredentials( args: GetClusterCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetClusterCredentialsCommandOutput) => void ): void; - public getClusterCredentials( - args: GetClusterCredentialsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetClusterCredentialsCommandOutput) => void), - cb?: (err: any, data?: GetClusterCredentialsCommandOutput) => void - ): Promise | void { - const command = new GetClusterCredentialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a database user name and temporary password with temporary authorization to - * log in to an Amazon Redshift database. - * The database user is mapped 1:1 to the source Identity and Access Management (IAM) identity. - * For more information about IAM identities, see IAM Identities (users, user groups, and roles) in the - * Amazon Web Services Identity and Access Management User Guide.

- *

The Identity and Access Management (IAM) identity that runs - * this operation must have an IAM policy attached that allows access to all - * necessary actions and resources. - * For more information about permissions, see Using identity-based policies (IAM policies) in the - * Amazon Redshift Cluster Management Guide.

+ * @see {@link GetClusterCredentialsWithIAMCommand} */ - public getClusterCredentialsWithIAM( + getClusterCredentialsWithIAM( args: GetClusterCredentialsWithIAMCommandInput, options?: __HttpHandlerOptions ): Promise; - public getClusterCredentialsWithIAM( + getClusterCredentialsWithIAM( args: GetClusterCredentialsWithIAMCommandInput, cb: (err: any, data?: GetClusterCredentialsWithIAMCommandOutput) => void ): void; - public getClusterCredentialsWithIAM( + getClusterCredentialsWithIAM( args: GetClusterCredentialsWithIAMCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetClusterCredentialsWithIAMCommandOutput) => void ): void; - public getClusterCredentialsWithIAM( - args: GetClusterCredentialsWithIAMCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetClusterCredentialsWithIAMCommandOutput) => void), - cb?: (err: any, data?: GetClusterCredentialsWithIAMCommandOutput) => void - ): Promise | void { - const command = new GetClusterCredentialsWithIAMCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the configuration options for the reserved-node exchange. These options - * include information about the source reserved node and target reserved node offering. - * Details include the node type, the price, the node count, and the offering type.

+ * @see {@link GetReservedNodeExchangeConfigurationOptionsCommand} */ - public getReservedNodeExchangeConfigurationOptions( + getReservedNodeExchangeConfigurationOptions( args: GetReservedNodeExchangeConfigurationOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReservedNodeExchangeConfigurationOptions( + getReservedNodeExchangeConfigurationOptions( args: GetReservedNodeExchangeConfigurationOptionsCommandInput, cb: (err: any, data?: GetReservedNodeExchangeConfigurationOptionsCommandOutput) => void ): void; - public getReservedNodeExchangeConfigurationOptions( + getReservedNodeExchangeConfigurationOptions( args: GetReservedNodeExchangeConfigurationOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReservedNodeExchangeConfigurationOptionsCommandOutput) => void ): void; - public getReservedNodeExchangeConfigurationOptions( - args: GetReservedNodeExchangeConfigurationOptionsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetReservedNodeExchangeConfigurationOptionsCommandOutput) => void), - cb?: (err: any, data?: GetReservedNodeExchangeConfigurationOptionsCommandOutput) => void - ): Promise | void { - const command = new GetReservedNodeExchangeConfigurationOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, - * and usage price of the given DC1 reserved node.

+ * @see {@link GetReservedNodeExchangeOfferingsCommand} */ - public getReservedNodeExchangeOfferings( + getReservedNodeExchangeOfferings( args: GetReservedNodeExchangeOfferingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReservedNodeExchangeOfferings( + getReservedNodeExchangeOfferings( args: GetReservedNodeExchangeOfferingsCommandInput, cb: (err: any, data?: GetReservedNodeExchangeOfferingsCommandOutput) => void ): void; - public getReservedNodeExchangeOfferings( + getReservedNodeExchangeOfferings( args: GetReservedNodeExchangeOfferingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReservedNodeExchangeOfferingsCommandOutput) => void ): void; - public getReservedNodeExchangeOfferings( - args: GetReservedNodeExchangeOfferingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReservedNodeExchangeOfferingsCommandOutput) => void), - cb?: (err: any, data?: GetReservedNodeExchangeOfferingsCommandOutput) => void - ): Promise | void { - const command = new GetReservedNodeExchangeOfferingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation is retired. Calling this operation does not change AQUA configuration. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

+ * @see {@link ModifyAquaConfigurationCommand} */ - public modifyAquaConfiguration( + modifyAquaConfiguration( args: ModifyAquaConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyAquaConfiguration( + modifyAquaConfiguration( args: ModifyAquaConfigurationCommandInput, cb: (err: any, data?: ModifyAquaConfigurationCommandOutput) => void ): void; - public modifyAquaConfiguration( + modifyAquaConfiguration( args: ModifyAquaConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyAquaConfigurationCommandOutput) => void ): void; - public modifyAquaConfiguration( - args: ModifyAquaConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyAquaConfigurationCommandOutput) => void), - cb?: (err: any, data?: ModifyAquaConfigurationCommandOutput) => void - ): Promise | void { - const command = new ModifyAquaConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies an authentication profile.

+ * @see {@link ModifyAuthenticationProfileCommand} */ - public modifyAuthenticationProfile( + modifyAuthenticationProfile( args: ModifyAuthenticationProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyAuthenticationProfile( + modifyAuthenticationProfile( args: ModifyAuthenticationProfileCommandInput, cb: (err: any, data?: ModifyAuthenticationProfileCommandOutput) => void ): void; - public modifyAuthenticationProfile( + modifyAuthenticationProfile( args: ModifyAuthenticationProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyAuthenticationProfileCommandOutput) => void ): void; - public modifyAuthenticationProfile( - args: ModifyAuthenticationProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyAuthenticationProfileCommandOutput) => void), - cb?: (err: any, data?: ModifyAuthenticationProfileCommandOutput) => void - ): Promise | void { - const command = new ModifyAuthenticationProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the settings for a cluster.

- *

You can also change node type and the number of nodes to scale up or down the - * cluster. When resizing a cluster, you must specify both the number of nodes and the node - * type even if one of the parameters does not change.

- *

You can add another security or - * parameter group, or change the admin user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. - * For more information about managing clusters, go to - * Amazon Redshift Clusters - * in the Amazon Redshift Cluster Management Guide.

+ * @see {@link ModifyClusterCommand} */ - public modifyCluster( - args: ModifyClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public modifyCluster( - args: ModifyClusterCommandInput, - cb: (err: any, data?: ModifyClusterCommandOutput) => void - ): void; - public modifyCluster( + modifyCluster(args: ModifyClusterCommandInput, options?: __HttpHandlerOptions): Promise; + modifyCluster(args: ModifyClusterCommandInput, cb: (err: any, data?: ModifyClusterCommandOutput) => void): void; + modifyCluster( args: ModifyClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyClusterCommandOutput) => void ): void; - public modifyCluster( - args: ModifyClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyClusterCommandOutput) => void), - cb?: (err: any, data?: ModifyClusterCommandOutput) => void - ): Promise | void { - const command = new ModifyClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the database revision of a cluster. The database revision is a unique - * revision of the database running in a cluster.

+ * @see {@link ModifyClusterDbRevisionCommand} */ - public modifyClusterDbRevision( + modifyClusterDbRevision( args: ModifyClusterDbRevisionCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyClusterDbRevision( + modifyClusterDbRevision( args: ModifyClusterDbRevisionCommandInput, cb: (err: any, data?: ModifyClusterDbRevisionCommandOutput) => void ): void; - public modifyClusterDbRevision( + modifyClusterDbRevision( args: ModifyClusterDbRevisionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyClusterDbRevisionCommandOutput) => void ): void; - public modifyClusterDbRevision( - args: ModifyClusterDbRevisionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyClusterDbRevisionCommandOutput) => void), - cb?: (err: any, data?: ModifyClusterDbRevisionCommandOutput) => void - ): Promise | void { - const command = new ModifyClusterDbRevisionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the list of Identity and Access Management (IAM) roles that can be - * used by the cluster to access other Amazon Web Services services.

- *

The maximum number of IAM roles that you can associate is subject to a quota. - * For more information, go to Quotas and limits - * in the Amazon Redshift Cluster Management Guide.

+ * @see {@link ModifyClusterIamRolesCommand} */ - public modifyClusterIamRoles( + modifyClusterIamRoles( args: ModifyClusterIamRolesCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyClusterIamRoles( + modifyClusterIamRoles( args: ModifyClusterIamRolesCommandInput, cb: (err: any, data?: ModifyClusterIamRolesCommandOutput) => void ): void; - public modifyClusterIamRoles( + modifyClusterIamRoles( args: ModifyClusterIamRolesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyClusterIamRolesCommandOutput) => void ): void; - public modifyClusterIamRoles( - args: ModifyClusterIamRolesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyClusterIamRolesCommandOutput) => void), - cb?: (err: any, data?: ModifyClusterIamRolesCommandOutput) => void - ): Promise | void { - const command = new ModifyClusterIamRolesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the maintenance settings of a cluster.

+ * @see {@link ModifyClusterMaintenanceCommand} */ - public modifyClusterMaintenance( + modifyClusterMaintenance( args: ModifyClusterMaintenanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyClusterMaintenance( + modifyClusterMaintenance( args: ModifyClusterMaintenanceCommandInput, cb: (err: any, data?: ModifyClusterMaintenanceCommandOutput) => void ): void; - public modifyClusterMaintenance( + modifyClusterMaintenance( args: ModifyClusterMaintenanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyClusterMaintenanceCommandOutput) => void ): void; - public modifyClusterMaintenance( - args: ModifyClusterMaintenanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyClusterMaintenanceCommandOutput) => void), - cb?: (err: any, data?: ModifyClusterMaintenanceCommandOutput) => void - ): Promise | void { - const command = new ModifyClusterMaintenanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the parameters of a parameter group. For the parameters parameter, it can't contain ASCII characters.

- *

- * For more information about parameters and parameter groups, go to - * Amazon Redshift Parameter Groups - * in the Amazon Redshift Cluster Management Guide.

+ * @see {@link ModifyClusterParameterGroupCommand} */ - public modifyClusterParameterGroup( + modifyClusterParameterGroup( args: ModifyClusterParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyClusterParameterGroup( + modifyClusterParameterGroup( args: ModifyClusterParameterGroupCommandInput, cb: (err: any, data?: ModifyClusterParameterGroupCommandOutput) => void ): void; - public modifyClusterParameterGroup( + modifyClusterParameterGroup( args: ModifyClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyClusterParameterGroupCommandOutput) => void ): void; - public modifyClusterParameterGroup( - args: ModifyClusterParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyClusterParameterGroupCommandOutput) => void), - cb?: (err: any, data?: ModifyClusterParameterGroupCommandOutput) => void - ): Promise | void { - const command = new ModifyClusterParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the settings for a snapshot.

- *

This exanmple modifies the manual retention period setting for a cluster snapshot.

+ * @see {@link ModifyClusterSnapshotCommand} */ - public modifyClusterSnapshot( + modifyClusterSnapshot( args: ModifyClusterSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyClusterSnapshot( + modifyClusterSnapshot( args: ModifyClusterSnapshotCommandInput, cb: (err: any, data?: ModifyClusterSnapshotCommandOutput) => void ): void; - public modifyClusterSnapshot( + modifyClusterSnapshot( args: ModifyClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyClusterSnapshotCommandOutput) => void ): void; - public modifyClusterSnapshot( - args: ModifyClusterSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyClusterSnapshotCommandOutput) => void), - cb?: (err: any, data?: ModifyClusterSnapshotCommandOutput) => void - ): Promise | void { - const command = new ModifyClusterSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies a snapshot schedule for a cluster.

+ * @see {@link ModifyClusterSnapshotScheduleCommand} */ - public modifyClusterSnapshotSchedule( + modifyClusterSnapshotSchedule( args: ModifyClusterSnapshotScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyClusterSnapshotSchedule( + modifyClusterSnapshotSchedule( args: ModifyClusterSnapshotScheduleCommandInput, cb: (err: any, data?: ModifyClusterSnapshotScheduleCommandOutput) => void ): void; - public modifyClusterSnapshotSchedule( + modifyClusterSnapshotSchedule( args: ModifyClusterSnapshotScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyClusterSnapshotScheduleCommandOutput) => void ): void; - public modifyClusterSnapshotSchedule( - args: ModifyClusterSnapshotScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyClusterSnapshotScheduleCommandOutput) => void), - cb?: (err: any, data?: ModifyClusterSnapshotScheduleCommandOutput) => void - ): Promise | void { - const command = new ModifyClusterSnapshotScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies a cluster subnet group to include the specified list of VPC subnets. The - * operation replaces the existing list of subnets with the new list of subnets.

+ * @see {@link ModifyClusterSubnetGroupCommand} */ - public modifyClusterSubnetGroup( + modifyClusterSubnetGroup( args: ModifyClusterSubnetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyClusterSubnetGroup( + modifyClusterSubnetGroup( args: ModifyClusterSubnetGroupCommandInput, cb: (err: any, data?: ModifyClusterSubnetGroupCommandOutput) => void ): void; - public modifyClusterSubnetGroup( + modifyClusterSubnetGroup( args: ModifyClusterSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyClusterSubnetGroupCommandOutput) => void ): void; - public modifyClusterSubnetGroup( - args: ModifyClusterSubnetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyClusterSubnetGroupCommandOutput) => void), - cb?: (err: any, data?: ModifyClusterSubnetGroupCommandOutput) => void - ): Promise | void { - const command = new ModifyClusterSubnetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies a Redshift-managed VPC endpoint.

+ * @see {@link ModifyEndpointAccessCommand} */ - public modifyEndpointAccess( + modifyEndpointAccess( args: ModifyEndpointAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyEndpointAccess( + modifyEndpointAccess( args: ModifyEndpointAccessCommandInput, cb: (err: any, data?: ModifyEndpointAccessCommandOutput) => void ): void; - public modifyEndpointAccess( + modifyEndpointAccess( args: ModifyEndpointAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyEndpointAccessCommandOutput) => void ): void; - public modifyEndpointAccess( - args: ModifyEndpointAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyEndpointAccessCommandOutput) => void), - cb?: (err: any, data?: ModifyEndpointAccessCommandOutput) => void - ): Promise | void { - const command = new ModifyEndpointAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies an existing Amazon Redshift event notification subscription.

+ * @see {@link ModifyEventSubscriptionCommand} */ - public modifyEventSubscription( + modifyEventSubscription( args: ModifyEventSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyEventSubscription( + modifyEventSubscription( args: ModifyEventSubscriptionCommandInput, cb: (err: any, data?: ModifyEventSubscriptionCommandOutput) => void ): void; - public modifyEventSubscription( + modifyEventSubscription( args: ModifyEventSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyEventSubscriptionCommandOutput) => void ): void; - public modifyEventSubscription( - args: ModifyEventSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyEventSubscriptionCommandOutput) => void), - cb?: (err: any, data?: ModifyEventSubscriptionCommandOutput) => void - ): Promise | void { - const command = new ModifyEventSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies a scheduled action. - *

+ * @see {@link ModifyScheduledActionCommand} */ - public modifyScheduledAction( + modifyScheduledAction( args: ModifyScheduledActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyScheduledAction( + modifyScheduledAction( args: ModifyScheduledActionCommandInput, cb: (err: any, data?: ModifyScheduledActionCommandOutput) => void ): void; - public modifyScheduledAction( + modifyScheduledAction( args: ModifyScheduledActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyScheduledActionCommandOutput) => void ): void; - public modifyScheduledAction( - args: ModifyScheduledActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyScheduledActionCommandOutput) => void), - cb?: (err: any, data?: ModifyScheduledActionCommandOutput) => void - ): Promise | void { - const command = new ModifyScheduledActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the number of days to retain snapshots in the destination Amazon Web Services Region after - * they are copied from the source Amazon Web Services Region. By default, this operation only changes the - * retention period of copied automated snapshots. The retention periods for both new and - * existing copied automated snapshots are updated with the new retention period. You can - * set the manual option to change only the retention periods of copied manual snapshots. - * If you set this option, only newly copied manual snapshots have the new retention - * period.

+ * @see {@link ModifySnapshotCopyRetentionPeriodCommand} */ - public modifySnapshotCopyRetentionPeriod( + modifySnapshotCopyRetentionPeriod( args: ModifySnapshotCopyRetentionPeriodCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifySnapshotCopyRetentionPeriod( + modifySnapshotCopyRetentionPeriod( args: ModifySnapshotCopyRetentionPeriodCommandInput, cb: (err: any, data?: ModifySnapshotCopyRetentionPeriodCommandOutput) => void ): void; - public modifySnapshotCopyRetentionPeriod( + modifySnapshotCopyRetentionPeriod( args: ModifySnapshotCopyRetentionPeriodCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifySnapshotCopyRetentionPeriodCommandOutput) => void ): void; - public modifySnapshotCopyRetentionPeriod( - args: ModifySnapshotCopyRetentionPeriodCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifySnapshotCopyRetentionPeriodCommandOutput) => void), - cb?: (err: any, data?: ModifySnapshotCopyRetentionPeriodCommandOutput) => void - ): Promise | void { - const command = new ModifySnapshotCopyRetentionPeriodCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies a snapshot schedule. Any schedule associated with a cluster is modified - * asynchronously.

+ * @see {@link ModifySnapshotScheduleCommand} */ - public modifySnapshotSchedule( + modifySnapshotSchedule( args: ModifySnapshotScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifySnapshotSchedule( + modifySnapshotSchedule( args: ModifySnapshotScheduleCommandInput, cb: (err: any, data?: ModifySnapshotScheduleCommandOutput) => void ): void; - public modifySnapshotSchedule( + modifySnapshotSchedule( args: ModifySnapshotScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifySnapshotScheduleCommandOutput) => void ): void; - public modifySnapshotSchedule( - args: ModifySnapshotScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifySnapshotScheduleCommandOutput) => void), - cb?: (err: any, data?: ModifySnapshotScheduleCommandOutput) => void - ): Promise | void { - const command = new ModifySnapshotScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies a usage limit in a cluster. - * You can't modify the feature type or period of a usage limit.

+ * @see {@link ModifyUsageLimitCommand} */ - public modifyUsageLimit( + modifyUsageLimit( args: ModifyUsageLimitCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyUsageLimit( + modifyUsageLimit( args: ModifyUsageLimitCommandInput, cb: (err: any, data?: ModifyUsageLimitCommandOutput) => void ): void; - public modifyUsageLimit( + modifyUsageLimit( args: ModifyUsageLimitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyUsageLimitCommandOutput) => void ): void; - public modifyUsageLimit( - args: ModifyUsageLimitCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyUsageLimitCommandOutput) => void), - cb?: (err: any, data?: ModifyUsageLimitCommandOutput) => void - ): Promise | void { - const command = new ModifyUsageLimitCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Pauses a cluster.

+ * @see {@link PauseClusterCommand} */ - public pauseCluster( - args: PauseClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public pauseCluster(args: PauseClusterCommandInput, cb: (err: any, data?: PauseClusterCommandOutput) => void): void; - public pauseCluster( + pauseCluster(args: PauseClusterCommandInput, options?: __HttpHandlerOptions): Promise; + pauseCluster(args: PauseClusterCommandInput, cb: (err: any, data?: PauseClusterCommandOutput) => void): void; + pauseCluster( args: PauseClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PauseClusterCommandOutput) => void ): void; - public pauseCluster( - args: PauseClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PauseClusterCommandOutput) => void), - cb?: (err: any, data?: PauseClusterCommandOutput) => void - ): Promise | void { - const command = new PauseClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of - * reserved node offerings. You can purchase one or more of the offerings. You can call the - * DescribeReservedNodeOfferings API to obtain the available reserved - * node offerings. You can call this API by providing a specific reserved node offering and - * the number of nodes you want to reserve.

- *

- * For more information about reserved node offerings, go to - * Purchasing Reserved Nodes - * in the Amazon Redshift Cluster Management Guide.

+ * @see {@link PurchaseReservedNodeOfferingCommand} */ - public purchaseReservedNodeOffering( + purchaseReservedNodeOffering( args: PurchaseReservedNodeOfferingCommandInput, options?: __HttpHandlerOptions ): Promise; - public purchaseReservedNodeOffering( + purchaseReservedNodeOffering( args: PurchaseReservedNodeOfferingCommandInput, cb: (err: any, data?: PurchaseReservedNodeOfferingCommandOutput) => void ): void; - public purchaseReservedNodeOffering( + purchaseReservedNodeOffering( args: PurchaseReservedNodeOfferingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PurchaseReservedNodeOfferingCommandOutput) => void ): void; - public purchaseReservedNodeOffering( - args: PurchaseReservedNodeOfferingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PurchaseReservedNodeOfferingCommandOutput) => void), - cb?: (err: any, data?: PurchaseReservedNodeOfferingCommandOutput) => void - ): Promise | void { - const command = new PurchaseReservedNodeOfferingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Reboots a cluster. This action is taken as soon as possible. It results in a - * momentary outage to the cluster, during which the cluster status is set to - * rebooting. A cluster event is created when the reboot is completed. Any - * pending cluster modifications (see ModifyCluster) are applied at this - * reboot. - * For more information about managing clusters, go to - * Amazon Redshift Clusters - * in the Amazon Redshift Cluster Management Guide.

+ * @see {@link RebootClusterCommand} */ - public rebootCluster( - args: RebootClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public rebootCluster( - args: RebootClusterCommandInput, - cb: (err: any, data?: RebootClusterCommandOutput) => void - ): void; - public rebootCluster( + rebootCluster(args: RebootClusterCommandInput, options?: __HttpHandlerOptions): Promise; + rebootCluster(args: RebootClusterCommandInput, cb: (err: any, data?: RebootClusterCommandOutput) => void): void; + rebootCluster( args: RebootClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebootClusterCommandOutput) => void ): void; - public rebootCluster( - args: RebootClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RebootClusterCommandOutput) => void), - cb?: (err: any, data?: RebootClusterCommandOutput) => void - ): Promise | void { - const command = new RebootClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

From a datashare consumer account, rejects the specified datashare.

+ * @see {@link RejectDataShareCommand} */ - public rejectDataShare( + rejectDataShare( args: RejectDataShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public rejectDataShare( - args: RejectDataShareCommandInput, - cb: (err: any, data?: RejectDataShareCommandOutput) => void - ): void; - public rejectDataShare( + rejectDataShare(args: RejectDataShareCommandInput, cb: (err: any, data?: RejectDataShareCommandOutput) => void): void; + rejectDataShare( args: RejectDataShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectDataShareCommandOutput) => void ): void; - public rejectDataShare( - args: RejectDataShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RejectDataShareCommandOutput) => void), - cb?: (err: any, data?: RejectDataShareCommandOutput) => void - ): Promise | void { - const command = new RejectDataShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets one or more parameters of the specified parameter group to their default - * values and sets the source values of the parameters to "engine-default". To reset the - * entire parameter group specify the ResetAllParameters parameter. - * For parameter changes to take effect you must reboot any associated clusters.

+ * @see {@link ResetClusterParameterGroupCommand} */ - public resetClusterParameterGroup( + resetClusterParameterGroup( args: ResetClusterParameterGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetClusterParameterGroup( + resetClusterParameterGroup( args: ResetClusterParameterGroupCommandInput, cb: (err: any, data?: ResetClusterParameterGroupCommandOutput) => void ): void; - public resetClusterParameterGroup( + resetClusterParameterGroup( args: ResetClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetClusterParameterGroupCommandOutput) => void ): void; - public resetClusterParameterGroup( - args: ResetClusterParameterGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetClusterParameterGroupCommandOutput) => void), - cb?: (err: any, data?: ResetClusterParameterGroupCommandOutput) => void - ): Promise | void { - const command = new ResetClusterParameterGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes the size of the cluster. You can change the cluster's type, or change the - * number or type of nodes. The default behavior is to use the elastic resize method. With - * an elastic resize, your cluster is available for read and write operations more quickly - * than with the classic resize method.

- *

Elastic resize operations have the following restrictions:

- *
    - *
  • - *

    You can only resize clusters of the following types:

    - *
      - *
    • - *

      dc1.large (if your cluster is in a VPC)

      - *
    • - *
    • - *

      dc1.8xlarge (if your cluster is in a VPC)

      - *
    • - *
    • - *

      dc2.large

      - *
    • - *
    • - *

      dc2.8xlarge

      - *
    • - *
    • - *

      ds2.xlarge

      - *
    • - *
    • - *

      ds2.8xlarge

      - *
    • - *
    • - *

      ra3.xlplus

      - *
    • - *
    • - *

      ra3.4xlarge

      - *
    • - *
    • - *

      ra3.16xlarge

      - *
    • - *
    - *
  • - *
  • - *

    The type of nodes that you add must match the node type for the - * cluster.

    - *
  • - *
+ * @see {@link ResizeClusterCommand} */ - public resizeCluster( - args: ResizeClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public resizeCluster( - args: ResizeClusterCommandInput, - cb: (err: any, data?: ResizeClusterCommandOutput) => void - ): void; - public resizeCluster( + resizeCluster(args: ResizeClusterCommandInput, options?: __HttpHandlerOptions): Promise; + resizeCluster(args: ResizeClusterCommandInput, cb: (err: any, data?: ResizeClusterCommandOutput) => void): void; + resizeCluster( args: ResizeClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResizeClusterCommandOutput) => void ): void; - public resizeCluster( - args: ResizeClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResizeClusterCommandOutput) => void), - cb?: (err: any, data?: ResizeClusterCommandOutput) => void - ): Promise | void { - const command = new ResizeClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting - * cluster with the same configuration as the original cluster from which the snapshot was - * created, except that the new cluster is created with the default cluster security and - * parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different - * parameter group with the restored cluster. If you are using a DS node type, you can also - * choose to change to another DS node type of the same size during restore.

- *

If you restore a cluster into a VPC, you must provide a cluster subnet group where - * you want the cluster restored.

- *

- * For more information about working with snapshots, go to - * Amazon Redshift Snapshots - * in the Amazon Redshift Cluster Management Guide.

+ * @see {@link RestoreFromClusterSnapshotCommand} */ - public restoreFromClusterSnapshot( + restoreFromClusterSnapshot( args: RestoreFromClusterSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreFromClusterSnapshot( + restoreFromClusterSnapshot( args: RestoreFromClusterSnapshotCommandInput, cb: (err: any, data?: RestoreFromClusterSnapshotCommandOutput) => void ): void; - public restoreFromClusterSnapshot( + restoreFromClusterSnapshot( args: RestoreFromClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreFromClusterSnapshotCommandOutput) => void ): void; - public restoreFromClusterSnapshot( - args: RestoreFromClusterSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreFromClusterSnapshotCommandOutput) => void), - cb?: (err: any, data?: RestoreFromClusterSnapshotCommandOutput) => void - ): Promise | void { - const command = new RestoreFromClusterSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new table from a table in an Amazon Redshift cluster snapshot. You must - * create the new table within the Amazon Redshift cluster that the snapshot was taken - * from.

- *

You cannot use RestoreTableFromClusterSnapshot to restore a table with - * the same name as an existing table in an Amazon Redshift cluster. That is, you cannot - * overwrite an existing table in a cluster with a restored table. If you want to replace - * your original table with a new, restored table, then rename or drop your original table - * before you call RestoreTableFromClusterSnapshot. When you have renamed your - * original table, then you can pass the original name of the table as the - * NewTableName parameter value in the call to - * RestoreTableFromClusterSnapshot. This way, you can replace the original - * table with the table created from the snapshot.

- *

You can't use this operation to restore tables with - * interleaved sort keys.

+ * @see {@link RestoreTableFromClusterSnapshotCommand} */ - public restoreTableFromClusterSnapshot( + restoreTableFromClusterSnapshot( args: RestoreTableFromClusterSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreTableFromClusterSnapshot( + restoreTableFromClusterSnapshot( args: RestoreTableFromClusterSnapshotCommandInput, cb: (err: any, data?: RestoreTableFromClusterSnapshotCommandOutput) => void ): void; - public restoreTableFromClusterSnapshot( + restoreTableFromClusterSnapshot( args: RestoreTableFromClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreTableFromClusterSnapshotCommandOutput) => void ): void; - public restoreTableFromClusterSnapshot( - args: RestoreTableFromClusterSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreTableFromClusterSnapshotCommandOutput) => void), - cb?: (err: any, data?: RestoreTableFromClusterSnapshotCommandOutput) => void - ): Promise | void { - const command = new RestoreTableFromClusterSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Resumes a paused cluster.

+ * @see {@link ResumeClusterCommand} */ - public resumeCluster( - args: ResumeClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public resumeCluster( - args: ResumeClusterCommandInput, - cb: (err: any, data?: ResumeClusterCommandOutput) => void - ): void; - public resumeCluster( + resumeCluster(args: ResumeClusterCommandInput, options?: __HttpHandlerOptions): Promise; + resumeCluster(args: ResumeClusterCommandInput, cb: (err: any, data?: ResumeClusterCommandOutput) => void): void; + resumeCluster( args: ResumeClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResumeClusterCommandOutput) => void ): void; - public resumeCluster( - args: ResumeClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResumeClusterCommandOutput) => void), - cb?: (err: any, data?: ResumeClusterCommandOutput) => void - ): Promise | void { - const command = new ResumeClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Revokes an ingress rule in an Amazon Redshift security group for a previously authorized - * IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress. - * For information about managing security groups, go to - * Amazon Redshift Cluster Security Groups in the - * Amazon Redshift Cluster Management Guide.

+ * @see {@link RevokeClusterSecurityGroupIngressCommand} */ - public revokeClusterSecurityGroupIngress( + revokeClusterSecurityGroupIngress( args: RevokeClusterSecurityGroupIngressCommandInput, options?: __HttpHandlerOptions ): Promise; - public revokeClusterSecurityGroupIngress( + revokeClusterSecurityGroupIngress( args: RevokeClusterSecurityGroupIngressCommandInput, cb: (err: any, data?: RevokeClusterSecurityGroupIngressCommandOutput) => void ): void; - public revokeClusterSecurityGroupIngress( + revokeClusterSecurityGroupIngress( args: RevokeClusterSecurityGroupIngressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeClusterSecurityGroupIngressCommandOutput) => void ): void; - public revokeClusterSecurityGroupIngress( - args: RevokeClusterSecurityGroupIngressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RevokeClusterSecurityGroupIngressCommandOutput) => void), - cb?: (err: any, data?: RevokeClusterSecurityGroupIngressCommandOutput) => void - ): Promise | void { - const command = new RevokeClusterSecurityGroupIngressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Revokes access to a cluster.

+ * @see {@link RevokeEndpointAccessCommand} */ - public revokeEndpointAccess( + revokeEndpointAccess( args: RevokeEndpointAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public revokeEndpointAccess( + revokeEndpointAccess( args: RevokeEndpointAccessCommandInput, cb: (err: any, data?: RevokeEndpointAccessCommandOutput) => void ): void; - public revokeEndpointAccess( + revokeEndpointAccess( args: RevokeEndpointAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeEndpointAccessCommandOutput) => void ): void; - public revokeEndpointAccess( - args: RevokeEndpointAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RevokeEndpointAccessCommandOutput) => void), - cb?: (err: any, data?: RevokeEndpointAccessCommandOutput) => void - ): Promise | void { - const command = new RevokeEndpointAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the ability of the specified Amazon Web Services account to restore the specified - * snapshot. If the account is currently restoring the snapshot, the restore will run to - * completion.

- *

- * For more information about working with snapshots, go to - * Amazon Redshift Snapshots - * in the Amazon Redshift Cluster Management Guide.

+ * @see {@link RevokeSnapshotAccessCommand} */ - public revokeSnapshotAccess( + revokeSnapshotAccess( args: RevokeSnapshotAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public revokeSnapshotAccess( + revokeSnapshotAccess( args: RevokeSnapshotAccessCommandInput, cb: (err: any, data?: RevokeSnapshotAccessCommandOutput) => void ): void; - public revokeSnapshotAccess( + revokeSnapshotAccess( args: RevokeSnapshotAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeSnapshotAccessCommandOutput) => void ): void; - public revokeSnapshotAccess( - args: RevokeSnapshotAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RevokeSnapshotAccessCommandOutput) => void), - cb?: (err: any, data?: RevokeSnapshotAccessCommandOutput) => void - ): Promise | void { - const command = new RevokeSnapshotAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Rotates the encryption keys for a cluster.

+ * @see {@link RotateEncryptionKeyCommand} */ - public rotateEncryptionKey( + rotateEncryptionKey( args: RotateEncryptionKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public rotateEncryptionKey( + rotateEncryptionKey( args: RotateEncryptionKeyCommandInput, cb: (err: any, data?: RotateEncryptionKeyCommandOutput) => void ): void; - public rotateEncryptionKey( + rotateEncryptionKey( args: RotateEncryptionKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RotateEncryptionKeyCommandOutput) => void ): void; - public rotateEncryptionKey( - args: RotateEncryptionKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RotateEncryptionKeyCommandOutput) => void), - cb?: (err: any, data?: RotateEncryptionKeyCommandOutput) => void - ): Promise | void { - const command = new RotateEncryptionKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the status of a partner integration.

+ * @see {@link UpdatePartnerStatusCommand} */ - public updatePartnerStatus( + updatePartnerStatus( args: UpdatePartnerStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePartnerStatus( + updatePartnerStatus( args: UpdatePartnerStatusCommandInput, cb: (err: any, data?: UpdatePartnerStatusCommandOutput) => void ): void; - public updatePartnerStatus( + updatePartnerStatus( args: UpdatePartnerStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePartnerStatusCommandOutput) => void ): void; - public updatePartnerStatus( - args: UpdatePartnerStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePartnerStatusCommandOutput) => void), - cb?: (err: any, data?: UpdatePartnerStatusCommandOutput) => void - ): Promise | void { - const command = new UpdatePartnerStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Redshift + *

+ * Overview + *

+ *

This is an interface reference for Amazon Redshift. It contains documentation for one of + * the programming or command line interfaces you can use to manage Amazon Redshift clusters. + * Note that Amazon Redshift is asynchronous, which means that some interfaces may require + * techniques, such as polling or asynchronous callback handlers, to determine when a + * command has been applied. In this reference, the parameter descriptions indicate whether + * a change is applied immediately, on the next instance reboot, or during the next + * maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to + * Using the + * Amazon Redshift Management Interfaces.

+ *

Amazon Redshift manages all the work of setting up, operating, and scaling a data + * warehouse: provisioning capacity, monitoring and backing up the cluster, and applying + * patches and upgrades to the Amazon Redshift engine. You can focus on using your data to + * acquire new insights for your business and customers.

+ *

If you are a first-time user of Amazon Redshift, we recommend that you begin by reading + * the Amazon Redshift Getting Started Guide.

+ *

If you are a database developer, the Amazon Redshift Database Developer Guide explains how to design, + * build, query, and maintain the databases that make up your data warehouse.

+ */ +export class Redshift extends RedshiftClient implements Redshift {} +createAggregatedClient(commands, Redshift); diff --git a/clients/client-rekognition/src/Rekognition.ts b/clients/client-rekognition/src/Rekognition.ts index cd65f1ea530d..aba880552e00 100644 --- a/clients/client-rekognition/src/Rekognition.ts +++ b/clients/client-rekognition/src/Rekognition.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -298,3481 +299,1410 @@ import { UpdateStreamProcessorCommandInput, UpdateStreamProcessorCommandOutput, } from "./commands/UpdateStreamProcessorCommand"; -import { RekognitionClient } from "./RekognitionClient"; +import { RekognitionClient, RekognitionClientConfig } from "./RekognitionClient"; -/** - * @public - *

This is the API Reference for Amazon Rekognition Image, Amazon Rekognition Custom Labels, - * Amazon Rekognition Stored - * Video, Amazon Rekognition Streaming Video. It provides descriptions of actions, data types, common - * parameters, and common errors.

- *

- * Amazon Rekognition Image - *

- * - *

- * Amazon Rekognition Custom Labels - *

- * - *

- * Amazon Rekognition Video Stored Video - *

- * - *

- * Amazon Rekognition Video Streaming Video - *

- * - */ -export class Rekognition extends RekognitionClient { - /** - * @public - *

Compares a face in the source input image with each of the 100 - * largest faces detected in the target input image.

- *

If the source image contains multiple faces, the service detects the largest face and - * compares it with each face detected in the target image.

- * - *

CompareFaces uses machine learning algorithms, which are probabilistic. A false negative - * is an incorrect prediction that a face in the target image has a low similarity confidence - * score when compared to the face in the source image. To reduce the probability of false - * negatives, we recommend that you compare the target image against multiple source images. If - * you plan to use CompareFaces to make a decision that impacts an individual's - * rights, privacy, or access to services, we recommend that you pass the result to a human for - * review and further validation before taking action.

- *
- *

You pass the input and target images either as base64-encoded image bytes or as - * references to images in an Amazon S3 bucket. If you use the - * AWS - * CLI to call Amazon Rekognition operations, passing image bytes isn't - * supported. The image must be formatted as a PNG or JPEG file.

- *

In response, the operation returns an array of face matches ordered by similarity score - * in descending order. For each face match, the response provides a bounding box of the face, - * facial landmarks, pose details (pitch, roll, and yaw), quality (brightness and sharpness), and - * confidence value (indicating the level of confidence that the bounding box contains a face). - * The response also provides a similarity score, which indicates how closely the faces match.

- * - *

By default, only faces with a similarity score of greater than or equal to 80% are - * returned in the response. You can change this value by specifying the - * SimilarityThreshold parameter.

- *
- *

- * CompareFaces also returns an array of faces that don't match the source - * image. For each face, it returns a bounding box, confidence value, landmarks, pose details, - * and quality. The response also returns information about the face in the source image, - * including the bounding box of the face and confidence value.

- *

The QualityFilter input parameter allows you to filter out detected faces - * that don’t meet a required quality bar. The quality bar is based on a variety of common use - * cases. Use QualityFilter to set the quality bar by specifying LOW, - * MEDIUM, or HIGH. If you do not want to filter detected faces, - * specify NONE. The default value is NONE.

- *

If the image doesn't contain Exif metadata, CompareFaces returns - * orientation information for the source and target images. Use these values to display the - * images with the correct image orientation.

- *

If no faces are detected in the source or target images, CompareFaces - * returns an InvalidParameterException error.

- * - *

This is a stateless API operation. That is, data returned by this operation doesn't - * persist.

- *
- *

For an example, see Comparing Faces in Images in the Amazon Rekognition Developer - * Guide.

- *

This operation requires permissions to perform the - * rekognition:CompareFaces action.

- */ - public compareFaces( - args: CompareFacesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public compareFaces(args: CompareFacesCommandInput, cb: (err: any, data?: CompareFacesCommandOutput) => void): void; - public compareFaces( +const commands = { + CompareFacesCommand, + CopyProjectVersionCommand, + CreateCollectionCommand, + CreateDatasetCommand, + CreateFaceLivenessSessionCommand, + CreateProjectCommand, + CreateProjectVersionCommand, + CreateStreamProcessorCommand, + DeleteCollectionCommand, + DeleteDatasetCommand, + DeleteFacesCommand, + DeleteProjectCommand, + DeleteProjectPolicyCommand, + DeleteProjectVersionCommand, + DeleteStreamProcessorCommand, + DescribeCollectionCommand, + DescribeDatasetCommand, + DescribeProjectsCommand, + DescribeProjectVersionsCommand, + DescribeStreamProcessorCommand, + DetectCustomLabelsCommand, + DetectFacesCommand, + DetectLabelsCommand, + DetectModerationLabelsCommand, + DetectProtectiveEquipmentCommand, + DetectTextCommand, + DistributeDatasetEntriesCommand, + GetCelebrityInfoCommand, + GetCelebrityRecognitionCommand, + GetContentModerationCommand, + GetFaceDetectionCommand, + GetFaceLivenessSessionResultsCommand, + GetFaceSearchCommand, + GetLabelDetectionCommand, + GetPersonTrackingCommand, + GetSegmentDetectionCommand, + GetTextDetectionCommand, + IndexFacesCommand, + ListCollectionsCommand, + ListDatasetEntriesCommand, + ListDatasetLabelsCommand, + ListFacesCommand, + ListProjectPoliciesCommand, + ListStreamProcessorsCommand, + ListTagsForResourceCommand, + PutProjectPolicyCommand, + RecognizeCelebritiesCommand, + SearchFacesCommand, + SearchFacesByImageCommand, + StartCelebrityRecognitionCommand, + StartContentModerationCommand, + StartFaceDetectionCommand, + StartFaceSearchCommand, + StartLabelDetectionCommand, + StartPersonTrackingCommand, + StartProjectVersionCommand, + StartSegmentDetectionCommand, + StartStreamProcessorCommand, + StartTextDetectionCommand, + StopProjectVersionCommand, + StopStreamProcessorCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateDatasetEntriesCommand, + UpdateStreamProcessorCommand, +}; + +export interface Rekognition { + /** + * @see {@link CompareFacesCommand} + */ + compareFaces(args: CompareFacesCommandInput, options?: __HttpHandlerOptions): Promise; + compareFaces(args: CompareFacesCommandInput, cb: (err: any, data?: CompareFacesCommandOutput) => void): void; + compareFaces( args: CompareFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompareFacesCommandOutput) => void ): void; - public compareFaces( - args: CompareFacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CompareFacesCommandOutput) => void), - cb?: (err: any, data?: CompareFacesCommandOutput) => void - ): Promise | void { - const command = new CompareFacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project. The source and - * destination projects can be in different AWS accounts but must be in the same AWS Region. - * You can't copy a model to another AWS service. - * - *

- *

To copy a model version to a different AWS account, you need to create a resource-based policy known as a - * project policy. You attach the project policy to the - * source project by calling PutProjectPolicy. The project policy - * gives permission to copy the model version from a trusting AWS account to a trusted account.

- *

For more information creating and attaching a project policy, see Attaching a project policy (SDK) - * in the Amazon Rekognition Custom Labels Developer Guide. - *

- *

If you are copying a model version to a project in the same AWS account, you don't need to create a project policy.

- * - *

To copy a model, the destination project, source project, and source model version must already exist.

- *
- *

Copying a model version takes a while to complete. To get the current status, call DescribeProjectVersions and check the value of Status in the - * ProjectVersionDescription object. The copy operation has finished when - * the value of Status is COPYING_COMPLETED.

- *

This operation requires permissions to perform the rekognition:CopyProjectVersion action.

- */ - public copyProjectVersion( + + /** + * @see {@link CopyProjectVersionCommand} + */ + copyProjectVersion( args: CopyProjectVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public copyProjectVersion( + copyProjectVersion( args: CopyProjectVersionCommandInput, cb: (err: any, data?: CopyProjectVersionCommandOutput) => void ): void; - public copyProjectVersion( + copyProjectVersion( args: CopyProjectVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyProjectVersionCommandOutput) => void ): void; - public copyProjectVersion( - args: CopyProjectVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopyProjectVersionCommandOutput) => void), - cb?: (err: any, data?: CopyProjectVersionCommandOutput) => void - ): Promise | void { - const command = new CopyProjectVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a collection in an AWS Region. You can add faces to the collection using the - * IndexFaces operation.

- *

For example, you might create collections, one for each of your application users. A - * user can then index faces using the IndexFaces operation and persist results in a - * specific collection. Then, a user can search the collection for faces in the user-specific - * container.

- *

When you create a collection, it is associated with the latest version of the face model - * version.

- * - *

Collection names are case-sensitive.

- *
- *

This operation requires permissions to perform the - * rekognition:CreateCollection action. If you want to tag your collection, you - * also require permission to perform the rekognition:TagResource - * operation.

- */ - public createCollection( + + /** + * @see {@link CreateCollectionCommand} + */ + createCollection( args: CreateCollectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCollection( + createCollection( args: CreateCollectionCommandInput, cb: (err: any, data?: CreateCollectionCommandOutput) => void ): void; - public createCollection( + createCollection( args: CreateCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCollectionCommandOutput) => void ): void; - public createCollection( - args: CreateCollectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCollectionCommandOutput) => void), - cb?: (err: any, data?: CreateCollectionCommandOutput) => void - ): Promise | void { - const command = new CreateCollectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using - * an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.

- *

To create a training dataset for a project, specify train for the value of - * DatasetType. To create the test dataset for a project, - * specify test for the value of DatasetType. - *

- *

The response from CreateDataset is the Amazon Resource Name (ARN) for the dataset. - * Creating a dataset takes a while to complete. Use DescribeDataset to check the - * current status. The dataset created successfully if the value of Status is - * CREATE_COMPLETE.

- *

To check if any non-terminal errors occurred, call ListDatasetEntries - * and check for the presence of errors lists in the JSON Lines.

- *

Dataset creation fails if a terminal error occurs (Status = CREATE_FAILED). - * Currently, you can't access the terminal error information. - * - *

- *

For more information, see Creating dataset in the Amazon Rekognition Custom Labels Developer Guide.

- *

This operation requires permissions to perform the rekognition:CreateDataset action. - * If you want to copy an existing dataset, you also require permission to perform the rekognition:ListDatasetEntries action.

- */ - public createDataset( - args: CreateDatasetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createDataset( - args: CreateDatasetCommandInput, - cb: (err: any, data?: CreateDatasetCommandOutput) => void - ): void; - public createDataset( + + /** + * @see {@link CreateDatasetCommand} + */ + createDataset(args: CreateDatasetCommandInput, options?: __HttpHandlerOptions): Promise; + createDataset(args: CreateDatasetCommandInput, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void; + createDataset( args: CreateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetCommandOutput) => void ): void; - public createDataset( - args: CreateDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDatasetCommandOutput) => void), - cb?: (err: any, data?: CreateDatasetCommandOutput) => void - ): Promise | void { - const command = new CreateDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API operation initiates a Face Liveness session. It returns a SessionId, - * which you can use to start streaming Face Liveness video and get the results for a Face - * Liveness session. You can use the OutputConfig option in the Settings parameter - * to provide an Amazon S3 bucket location. The Amazon S3 bucket stores reference images and - * audit images. You can use AuditImagesLimit to limit of audit images returned. - * This number is between 0 and 4. By default, it is set to 0. The limit is best effort and based - * on the duration of the selfie-video.

- */ - public createFaceLivenessSession( + + /** + * @see {@link CreateFaceLivenessSessionCommand} + */ + createFaceLivenessSession( args: CreateFaceLivenessSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFaceLivenessSession( + createFaceLivenessSession( args: CreateFaceLivenessSessionCommandInput, cb: (err: any, data?: CreateFaceLivenessSessionCommandOutput) => void ): void; - public createFaceLivenessSession( + createFaceLivenessSession( args: CreateFaceLivenessSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFaceLivenessSessionCommandOutput) => void ): void; - public createFaceLivenessSession( - args: CreateFaceLivenessSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFaceLivenessSessionCommandOutput) => void), - cb?: (err: any, data?: CreateFaceLivenessSessionCommandOutput) => void - ): Promise | void { - const command = new CreateFaceLivenessSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new Amazon Rekognition Custom Labels project. A project is a group of resources (datasets, model versions) - * that you use to create and manage Amazon Rekognition Custom Labels models.

- *

This operation requires permissions to perform the rekognition:CreateProject action.

- */ - public createProject( - args: CreateProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createProject( - args: CreateProjectCommandInput, - cb: (err: any, data?: CreateProjectCommandOutput) => void - ): void; - public createProject( + + /** + * @see {@link CreateProjectCommand} + */ + createProject(args: CreateProjectCommandInput, options?: __HttpHandlerOptions): Promise; + createProject(args: CreateProjectCommandInput, cb: (err: any, data?: CreateProjectCommandOutput) => void): void; + createProject( args: CreateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectCommandOutput) => void ): void; - public createProject( - args: CreateProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProjectCommandOutput) => void), - cb?: (err: any, data?: CreateProjectCommandOutput) => void - ): Promise | void { - const command = new CreateProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new version of a model and begins training. - * Models are managed as part of an Amazon Rekognition Custom Labels project. - * The response from CreateProjectVersion - * is an Amazon Resource Name (ARN) for the version of the model.

- *

Training uses the training and test datasets associated with the project. - * For more information, see Creating training and test dataset in the Amazon Rekognition Custom Labels Developer Guide. - *

- * - *

You can train a model in a project that doesn't have associated datasets by specifying manifest files in the - * TrainingData and TestingData fields. - *

- *

If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates - * the datasets for you using the most recent manifest files. You can no longer train - * a model version for the project by specifying manifest files.

- *

Instead of training with a project without associated datasets, - * we recommend that you use the manifest - * files to create training and test datasets for the project.

- *
- *

Training takes a while to complete. You can get the current status by calling - * DescribeProjectVersions. Training completed successfully if - * the value of the Status field is TRAINING_COMPLETED.

- *

If training - * fails, see Debugging a failed model training in the Amazon Rekognition Custom Labels developer guide.

- *

Once training has successfully completed, call DescribeProjectVersions to - * get the training results and evaluate the model. For more information, see Improving a trained Amazon Rekognition Custom Labels model - * in the Amazon Rekognition Custom Labels developers guide. - *

- *

After evaluating the model, you start the model - * by calling StartProjectVersion.

- *

This operation requires permissions to perform the rekognition:CreateProjectVersion action.

- */ - public createProjectVersion( + + /** + * @see {@link CreateProjectVersionCommand} + */ + createProjectVersion( args: CreateProjectVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createProjectVersion( + createProjectVersion( args: CreateProjectVersionCommandInput, cb: (err: any, data?: CreateProjectVersionCommandOutput) => void ): void; - public createProjectVersion( + createProjectVersion( args: CreateProjectVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectVersionCommandOutput) => void ): void; - public createProjectVersion( - args: CreateProjectVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProjectVersionCommandOutput) => void), - cb?: (err: any, data?: CreateProjectVersionCommandOutput) => void - ): Promise | void { - const command = new CreateProjectVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces or to detect labels in a streaming video.

- *

Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting labels.

- *
    - *
  • - *

    If you are creating a stream processor for detecting faces, you provide as input a Kinesis video stream - * (Input) and a Kinesis data stream (Output) stream for receiving - * the output. You must use the FaceSearch option in - * Settings, specifying the collection that contains the faces you - * want to recognize. After you have finished analyzing a streaming video, use - * StopStreamProcessor to stop processing.

    - *
  • - *
  • - *

    If you are creating a stream processor to detect labels, you provide as input a Kinesis video stream - * (Input), Amazon S3 bucket information (Output), and an - * Amazon SNS topic ARN (NotificationChannel). You can also provide a KMS - * key ID to encrypt the data sent to your Amazon S3 bucket. You specify what you want - * to detect by using the ConnectedHome option in settings, and - * selecting one of the following: PERSON, PET, - * PACKAGE, ALL You can also specify where in the - * frame you want Amazon Rekognition to monitor with RegionsOfInterest. When - * you run the StartStreamProcessor operation on a label - * detection stream processor, you input start and stop information to determine - * the length of the processing time.

    - *
  • - *
- *

- * Use Name to assign an identifier for the stream processor. You use Name - * to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with - * the Name field.

- *

This operation requires permissions to perform the - * rekognition:CreateStreamProcessor action. If you want to tag your stream processor, you also require permission to perform the rekognition:TagResource operation.

- */ - public createStreamProcessor( + + /** + * @see {@link CreateStreamProcessorCommand} + */ + createStreamProcessor( args: CreateStreamProcessorCommandInput, options?: __HttpHandlerOptions ): Promise; - public createStreamProcessor( + createStreamProcessor( args: CreateStreamProcessorCommandInput, cb: (err: any, data?: CreateStreamProcessorCommandOutput) => void ): void; - public createStreamProcessor( + createStreamProcessor( args: CreateStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStreamProcessorCommandOutput) => void ): void; - public createStreamProcessor( - args: CreateStreamProcessorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStreamProcessorCommandOutput) => void), - cb?: (err: any, data?: CreateStreamProcessorCommandOutput) => void - ): Promise | void { - const command = new CreateStreamProcessorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified collection. Note that this operation removes all faces in the - * collection. For an example, see Deleting a - * collection.

- *

This operation requires permissions to perform the - * rekognition:DeleteCollection action.

- */ - public deleteCollection( + + /** + * @see {@link DeleteCollectionCommand} + */ + deleteCollection( args: DeleteCollectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCollection( + deleteCollection( args: DeleteCollectionCommandInput, cb: (err: any, data?: DeleteCollectionCommandOutput) => void ): void; - public deleteCollection( + deleteCollection( args: DeleteCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCollectionCommandOutput) => void ): void; - public deleteCollection( - args: DeleteCollectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCollectionCommandOutput) => void), - cb?: (err: any, data?: DeleteCollectionCommandOutput) => void - ): Promise | void { - const command = new DeleteCollectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an existing Amazon Rekognition Custom Labels dataset. - * Deleting a dataset might take while. Use DescribeDataset to check the - * current status. The dataset is still deleting if the value of Status is - * DELETE_IN_PROGRESS. If you try to access the dataset after it is deleted, you get - * a ResourceNotFoundException exception. - * - *

- *

You can't delete a dataset while it is creating (Status = CREATE_IN_PROGRESS) - * or if the dataset is updating (Status = UPDATE_IN_PROGRESS).

- *

This operation requires permissions to perform the rekognition:DeleteDataset action.

- */ - public deleteDataset( - args: DeleteDatasetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDataset( - args: DeleteDatasetCommandInput, - cb: (err: any, data?: DeleteDatasetCommandOutput) => void - ): void; - public deleteDataset( + + /** + * @see {@link DeleteDatasetCommand} + */ + deleteDataset(args: DeleteDatasetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDataset(args: DeleteDatasetCommandInput, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void; + deleteDataset( args: DeleteDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetCommandOutput) => void ): void; - public deleteDataset( - args: DeleteDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDatasetCommandOutput) => void), - cb?: (err: any, data?: DeleteDatasetCommandOutput) => void - ): Promise | void { - const command = new DeleteDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes faces from a collection. You specify a collection ID and an array of face IDs - * to remove from the collection.

- *

This operation requires permissions to perform the rekognition:DeleteFaces - * action.

- */ - public deleteFaces(args: DeleteFacesCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteFaces(args: DeleteFacesCommandInput, cb: (err: any, data?: DeleteFacesCommandOutput) => void): void; - public deleteFaces( + + /** + * @see {@link DeleteFacesCommand} + */ + deleteFaces(args: DeleteFacesCommandInput, options?: __HttpHandlerOptions): Promise; + deleteFaces(args: DeleteFacesCommandInput, cb: (err: any, data?: DeleteFacesCommandOutput) => void): void; + deleteFaces( args: DeleteFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFacesCommandOutput) => void ): void; - public deleteFaces( - args: DeleteFacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFacesCommandOutput) => void), - cb?: (err: any, data?: DeleteFacesCommandOutput) => void - ): Promise | void { - const command = new DeleteFacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models associated - * with the project. To delete a model, see DeleteProjectVersion.

- *

- * DeleteProject is an asynchronous operation. To check if the project is - * deleted, call DescribeProjects. The project is deleted when the project - * no longer appears in the response. Be aware that deleting a given project will also delete - * any ProjectPolicies associated with that project.

- *

This operation requires permissions to perform the - * rekognition:DeleteProject action.

- */ - public deleteProject( - args: DeleteProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteProject( - args: DeleteProjectCommandInput, - cb: (err: any, data?: DeleteProjectCommandOutput) => void - ): void; - public deleteProject( + + /** + * @see {@link DeleteProjectCommand} + */ + deleteProject(args: DeleteProjectCommandInput, options?: __HttpHandlerOptions): Promise; + deleteProject(args: DeleteProjectCommandInput, cb: (err: any, data?: DeleteProjectCommandOutput) => void): void; + deleteProject( args: DeleteProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProjectCommandOutput) => void ): void; - public deleteProject( - args: DeleteProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProjectCommandOutput) => void), - cb?: (err: any, data?: DeleteProjectCommandOutput) => void - ): Promise | void { - const command = new DeleteProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an existing project policy.

- *

To get a list of project policies attached to a project, call ListProjectPolicies. To attach a project policy to a project, call PutProjectPolicy.

- *

This operation requires permissions to perform the rekognition:DeleteProjectPolicy action.

- */ - public deleteProjectPolicy( + + /** + * @see {@link DeleteProjectPolicyCommand} + */ + deleteProjectPolicy( args: DeleteProjectPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteProjectPolicy( + deleteProjectPolicy( args: DeleteProjectPolicyCommandInput, cb: (err: any, data?: DeleteProjectPolicyCommandOutput) => void ): void; - public deleteProjectPolicy( + deleteProjectPolicy( args: DeleteProjectPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProjectPolicyCommandOutput) => void ): void; - public deleteProjectPolicy( - args: DeleteProjectPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProjectPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteProjectPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteProjectPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an Amazon Rekognition Custom Labels model.

- *

You can't delete a model if it is running or if it is training. - * To check the status of a model, use the Status field returned - * from DescribeProjectVersions. - * To stop a running model call StopProjectVersion. If the model - * is training, wait until it finishes.

- *

This operation requires permissions to perform the - * rekognition:DeleteProjectVersion action.

- */ - public deleteProjectVersion( + + /** + * @see {@link DeleteProjectVersionCommand} + */ + deleteProjectVersion( args: DeleteProjectVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteProjectVersion( + deleteProjectVersion( args: DeleteProjectVersionCommandInput, cb: (err: any, data?: DeleteProjectVersionCommandOutput) => void ): void; - public deleteProjectVersion( + deleteProjectVersion( args: DeleteProjectVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProjectVersionCommandOutput) => void ): void; - public deleteProjectVersion( - args: DeleteProjectVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProjectVersionCommandOutput) => void), - cb?: (err: any, data?: DeleteProjectVersionCommandOutput) => void - ): Promise | void { - const command = new DeleteProjectVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the stream processor identified by Name. You assign the value for Name when you create the stream processor with - * CreateStreamProcessor. You might not be able to use the same name for a stream processor for a few seconds after calling DeleteStreamProcessor.

- */ - public deleteStreamProcessor( + + /** + * @see {@link DeleteStreamProcessorCommand} + */ + deleteStreamProcessor( args: DeleteStreamProcessorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteStreamProcessor( + deleteStreamProcessor( args: DeleteStreamProcessorCommandInput, cb: (err: any, data?: DeleteStreamProcessorCommandOutput) => void ): void; - public deleteStreamProcessor( + deleteStreamProcessor( args: DeleteStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStreamProcessorCommandOutput) => void ): void; - public deleteStreamProcessor( - args: DeleteStreamProcessorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStreamProcessorCommandOutput) => void), - cb?: (err: any, data?: DeleteStreamProcessorCommandOutput) => void - ): Promise | void { - const command = new DeleteStreamProcessorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified collection. You can use DescribeCollection to get - * information, such as the number of faces indexed into a collection and the version of the - * model used by the collection for face detection.

- *

For more information, see Describing a Collection in the - * Amazon Rekognition Developer Guide.

- */ - public describeCollection( + + /** + * @see {@link DescribeCollectionCommand} + */ + describeCollection( args: DescribeCollectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCollection( + describeCollection( args: DescribeCollectionCommandInput, cb: (err: any, data?: DescribeCollectionCommandOutput) => void ): void; - public describeCollection( + describeCollection( args: DescribeCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCollectionCommandOutput) => void ): void; - public describeCollection( - args: DescribeCollectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCollectionCommandOutput) => void), - cb?: (err: any, data?: DescribeCollectionCommandOutput) => void - ): Promise | void { - const command = new DescribeCollectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Describes an Amazon Rekognition Custom Labels dataset. You can get information such as the current status of a dataset and - * statistics about the images and labels in a dataset. - *

- *

This operation requires permissions to perform the rekognition:DescribeDataset action.

- */ - public describeDataset( + + /** + * @see {@link DescribeDatasetCommand} + */ + describeDataset( args: DescribeDatasetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDataset( - args: DescribeDatasetCommandInput, - cb: (err: any, data?: DescribeDatasetCommandOutput) => void - ): void; - public describeDataset( + describeDataset(args: DescribeDatasetCommandInput, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void; + describeDataset( args: DescribeDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetCommandOutput) => void ): void; - public describeDataset( - args: DescribeDatasetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDatasetCommandOutput) => void), - cb?: (err: any, data?: DescribeDatasetCommandOutput) => void - ): Promise | void { - const command = new DescribeDatasetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about your Amazon Rekognition Custom Labels projects.

- *

This operation requires permissions to perform the rekognition:DescribeProjects action.

- */ - public describeProjects( + + /** + * @see {@link DescribeProjectsCommand} + */ + describeProjects( args: DescribeProjectsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProjects( + describeProjects( args: DescribeProjectsCommandInput, cb: (err: any, data?: DescribeProjectsCommandOutput) => void ): void; - public describeProjects( + describeProjects( args: DescribeProjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProjectsCommandOutput) => void ): void; - public describeProjects( - args: DescribeProjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProjectsCommandOutput) => void), - cb?: (err: any, data?: DescribeProjectsCommandOutput) => void - ): Promise | void { - const command = new DescribeProjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists and describes the versions of a model in an Amazon Rekognition Custom Labels project. You - * can specify up to 10 model versions in ProjectVersionArns. If - * you don't specify a value, descriptions for all model versions in the project are returned.

- *

This operation requires permissions to perform the rekognition:DescribeProjectVersions - * action.

- */ - public describeProjectVersions( + + /** + * @see {@link DescribeProjectVersionsCommand} + */ + describeProjectVersions( args: DescribeProjectVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProjectVersions( + describeProjectVersions( args: DescribeProjectVersionsCommandInput, cb: (err: any, data?: DescribeProjectVersionsCommandOutput) => void ): void; - public describeProjectVersions( + describeProjectVersions( args: DescribeProjectVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProjectVersionsCommandOutput) => void ): void; - public describeProjectVersions( - args: DescribeProjectVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProjectVersionsCommandOutput) => void), - cb?: (err: any, data?: DescribeProjectVersionsCommandOutput) => void - ): Promise | void { - const command = new DescribeProjectVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides information about a stream processor created by CreateStreamProcessor. You can get information about the input and output streams, the input parameters for the face recognition being performed, - * and the current status of the stream processor.

- */ - public describeStreamProcessor( + + /** + * @see {@link DescribeStreamProcessorCommand} + */ + describeStreamProcessor( args: DescribeStreamProcessorCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStreamProcessor( + describeStreamProcessor( args: DescribeStreamProcessorCommandInput, cb: (err: any, data?: DescribeStreamProcessorCommandOutput) => void ): void; - public describeStreamProcessor( + describeStreamProcessor( args: DescribeStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStreamProcessorCommandOutput) => void ): void; - public describeStreamProcessor( - args: DescribeStreamProcessorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStreamProcessorCommandOutput) => void), - cb?: (err: any, data?: DescribeStreamProcessorCommandOutput) => void - ): Promise | void { - const command = new DescribeStreamProcessorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model.

- *

You specify which version of a model version to use by using the ProjectVersionArn input - * parameter.

- *

You pass the input image as base64-encoded image bytes or as a reference to an image in - * an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing - * image bytes is not supported. The image must be either a PNG or JPEG formatted file.

- *

For each object that the model version detects on an image, the API returns a - * (CustomLabel) object in an array (CustomLabels). - * Each CustomLabel object provides the label name (Name), the level - * of confidence that the image contains the object (Confidence), and - * object location information, if it exists, for the label on the image (Geometry).

- *

To filter labels that are returned, specify a value for MinConfidence. - * DetectCustomLabelsLabels only returns labels with a confidence that's higher than - * the specified value. - * - * The value of MinConfidence maps to the assumed threshold values - * created during training. For more information, see Assumed threshold - * in the Amazon Rekognition Custom Labels Developer Guide. - * Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of - * MinConfidence normalizes the threshold value to a percentage value (0-100). Confidence - * responses from DetectCustomLabels are also returned as a percentage. - * You can use MinConfidence to change the precision and recall or your model. - * For more information, see - * Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.

- *

If you don't specify a value for MinConfidence, DetectCustomLabels - * returns labels based on the assumed threshold of each label.

- *

This is a stateless API operation. That is, the operation does not persist any - * data.

- *

This operation requires permissions to perform the - * rekognition:DetectCustomLabels action.

- *

For more information, see - * Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.

- */ - public detectCustomLabels( + + /** + * @see {@link DetectCustomLabelsCommand} + */ + detectCustomLabels( args: DetectCustomLabelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public detectCustomLabels( + detectCustomLabels( args: DetectCustomLabelsCommandInput, cb: (err: any, data?: DetectCustomLabelsCommandOutput) => void ): void; - public detectCustomLabels( + detectCustomLabels( args: DetectCustomLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectCustomLabelsCommandOutput) => void ): void; - public detectCustomLabels( - args: DetectCustomLabelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectCustomLabelsCommandOutput) => void), - cb?: (err: any, data?: DetectCustomLabelsCommandOutput) => void - ): Promise | void { - const command = new DetectCustomLabelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detects faces within an image that is provided as input.

- *

- * DetectFaces detects the 100 largest faces in the image. For each face - * detected, the operation returns face details. These details include a bounding box of the - * face, a confidence value (that the bounding box contains a face), and a fixed set of - * attributes such as facial landmarks (for example, coordinates of eye and mouth), presence of - * beard, sunglasses, and so on.

- *

The face-detection algorithm is most effective on frontal faces. For non-frontal or - * obscured faces, the algorithm might not detect the faces or might detect faces with lower - * confidence.

- *

You pass the input image either as base64-encoded image bytes or as a reference to an - * image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, - * passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

- * - *

This is a stateless API operation. That is, the operation does not persist any - * data.

- *
- *

This operation requires permissions to perform the rekognition:DetectFaces - * action.

- */ - public detectFaces(args: DetectFacesCommandInput, options?: __HttpHandlerOptions): Promise; - public detectFaces(args: DetectFacesCommandInput, cb: (err: any, data?: DetectFacesCommandOutput) => void): void; - public detectFaces( + + /** + * @see {@link DetectFacesCommand} + */ + detectFaces(args: DetectFacesCommandInput, options?: __HttpHandlerOptions): Promise; + detectFaces(args: DetectFacesCommandInput, cb: (err: any, data?: DetectFacesCommandOutput) => void): void; + detectFaces( args: DetectFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectFacesCommandOutput) => void ): void; - public detectFaces( - args: DetectFacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectFacesCommandOutput) => void), - cb?: (err: any, data?: DetectFacesCommandOutput) => void - ): Promise | void { - const command = new DetectFacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detects instances of real-world entities within an image (JPEG or PNG) provided as - * input. This includes objects like flower, tree, and table; events like wedding, graduation, - * and birthday party; and concepts like landscape, evening, and nature.

- *

For an example, see Analyzing images stored in an Amazon S3 bucket in the - * Amazon Rekognition Developer Guide.

- *

You pass the input image as base64-encoded image bytes or as a reference to an image in - * an Amazon S3 bucket. If you use the - * AWS - * CLI to call Amazon Rekognition operations, passing image bytes is not - * supported. The image must be either a PNG or JPEG formatted file.

- *

- * Optional Parameters - *

- *

You can specify one or both of the GENERAL_LABELS and - * IMAGE_PROPERTIES feature types when calling the DetectLabels API. Including - * GENERAL_LABELS will ensure the response includes the labels detected in the - * input image, while including IMAGE_PROPERTIES will ensure the response includes - * information about the image quality and color.

- *

When using GENERAL_LABELS and/or IMAGE_PROPERTIES you can - * provide filtering criteria to the Settings parameter. You can filter with sets of individual - * labels or with label categories. You can specify inclusive filters, exclusive filters, or a - * combination of inclusive and exclusive filters. For more information on filtering see Detecting - * Labels in an Image.

- *

You can specify MinConfidence to control the confidence threshold for the - * labels returned. The default is 55%. You can also add the MaxLabels parameter to - * limit the number of labels returned. The default and upper limit is 1000 labels.

- *

- * Response Elements - *

- *

For each object, scene, and concept the API returns one or more labels. The API - * returns the following types of information about labels:

- *
    - *
  • - *

    Name - The name of the detected label.

    - *
  • - *
  • - *

    Confidence - The level of confidence in the label assigned to a detected object. - *

    - *
  • - *
  • - *

    Parents - The ancestor labels for a detected label. DetectLabels returns a - * hierarchical taxonomy of detected labels. For example, a detected car might be assigned - * the label car. The label car has two parent labels: Vehicle (its parent) and - * Transportation (its grandparent). The response includes the all ancestors for a label, - * where every ancestor is a unique label. In the previous example, Car, Vehicle, and - * Transportation are returned as unique labels in the response.

    - *
  • - *
  • - *

    Aliases - Possible Aliases for the label.

    - *
  • - *
  • - *

    Categories - The label categories that the detected label belongs to.

    - *
  • - *
  • - *

    BoundingBox — Bounding boxes are described for all instances of detected common - * object labels, returned in an array of Instance objects. An Instance object contains a - * BoundingBox object, describing the location of the label on the input image. It also - * includes the confidence for the accuracy of the detected bounding box.

    - *
  • - *
- *

The API returns the following information regarding the image, as part of the - * ImageProperties structure:

- *
    - *
  • - *

    Quality - Information about the Sharpness, Brightness, and Contrast of the input - * image, scored between 0 to 100. Image quality is returned for the entire image, as well as - * the background and the foreground.

    - *
  • - *
  • - *

    Dominant Color - An array of the dominant colors in the image.

    - *
  • - *
  • - *

    Foreground - Information about the sharpness, brightness, and dominant colors of the input image’s foreground.

    - *
  • - *
  • - *

    Background - Information about the sharpness, brightness, and dominant colors of the input image’s background.

    - *
  • - *
- *

The list of returned labels will include at least one label for every detected object, - * along with information about that label. In the following example, suppose the input image has - * a lighthouse, the sea, and a rock. The response includes all three labels, one for each - * object, as well as the confidence in the label:

- *

- * \{Name: lighthouse, Confidence: 98.4629\} - *

- *

- * \{Name: rock,Confidence: 79.2097\} - *

- *

- * \{Name: sea,Confidence: 75.061\} - *

- *

The list of labels can include multiple labels for the same object. For example, if the - * input image shows a flower (for example, a tulip), the operation might return the following - * three labels.

- *

- * \{Name: flower,Confidence: 99.0562\} - *

- *

- * \{Name: plant,Confidence: 99.0562\} - *

- *

- * \{Name: tulip,Confidence: 99.0562\} - *

- *

In this example, the detection algorithm more precisely identifies the flower as a - * tulip.

- * - *

If the object detected is a person, the operation doesn't provide the same facial - * details that the DetectFaces operation provides.

- *
- *

This is a stateless API operation that doesn't return any data.

- *

This operation requires permissions to perform the - * rekognition:DetectLabels action.

- */ - public detectLabels( - args: DetectLabelsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public detectLabels(args: DetectLabelsCommandInput, cb: (err: any, data?: DetectLabelsCommandOutput) => void): void; - public detectLabels( + + /** + * @see {@link DetectLabelsCommand} + */ + detectLabels(args: DetectLabelsCommandInput, options?: __HttpHandlerOptions): Promise; + detectLabels(args: DetectLabelsCommandInput, cb: (err: any, data?: DetectLabelsCommandOutput) => void): void; + detectLabels( args: DetectLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectLabelsCommandOutput) => void ): void; - public detectLabels( - args: DetectLabelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectLabelsCommandOutput) => void), - cb?: (err: any, data?: DetectLabelsCommandOutput) => void - ): Promise | void { - const command = new DetectLabelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detects unsafe content in a specified JPEG or PNG format image. Use - * DetectModerationLabels to moderate images depending on your requirements. For - * example, you might want to filter images that contain nudity, but not images containing - * suggestive content.

- *

To filter images, use the labels returned by DetectModerationLabels to - * determine which types of content are appropriate.

- *

For information about moderation labels, see Detecting Unsafe Content in the - * Amazon Rekognition Developer Guide.

- *

You pass the input image either as base64-encoded image bytes or as a reference to an - * image in an Amazon S3 bucket. If you use the - * AWS - * CLI to call Amazon Rekognition operations, passing image bytes is not - * supported. The image must be either a PNG or JPEG formatted file.

- */ - public detectModerationLabels( + + /** + * @see {@link DetectModerationLabelsCommand} + */ + detectModerationLabels( args: DetectModerationLabelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public detectModerationLabels( + detectModerationLabels( args: DetectModerationLabelsCommandInput, cb: (err: any, data?: DetectModerationLabelsCommandOutput) => void ): void; - public detectModerationLabels( + detectModerationLabels( args: DetectModerationLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectModerationLabelsCommandOutput) => void ): void; - public detectModerationLabels( - args: DetectModerationLabelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectModerationLabelsCommandOutput) => void), - cb?: (err: any, data?: DetectModerationLabelsCommandOutput) => void - ): Promise | void { - const command = new DetectModerationLabelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon Rekognition can detect the - * following types of PPE.

- *
    - *
  • - *

    Face cover

    - *
  • - *
  • - *

    Hand cover

    - *
  • - *
  • - *

    Head cover

    - *
  • - *
- *

You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. - * The image must be either a PNG or JPG formatted file.

- *

- * DetectProtectiveEquipment detects PPE worn by up to 15 persons detected in an image.

- *

For each person detected in the image the API returns an array of body parts (face, head, left-hand, right-hand). - * For each body part, an array of detected items of PPE is returned, including an indicator of whether or not the PPE - * covers the body part. The API returns the confidence it has in each detection - * (person, PPE, body part and body part coverage). It also returns a bounding box (BoundingBox) for each detected - * person and each detected item of PPE.

- *

You can optionally request a summary of detected PPE items with the SummarizationAttributes input parameter. - * The summary provides the following information.

- *
    - *
  • - *

    The persons detected as wearing all of the types of PPE that you specify.

    - *
  • - *
  • - *

    The persons detected as not wearing all of the types PPE that you specify.

    - *
  • - *
  • - *

    The persons detected where PPE adornment could not be determined.

    - *
  • - *
- *

This is a stateless API operation. That is, the operation does not persist any data.

- *

This operation requires permissions to perform the rekognition:DetectProtectiveEquipment action.

- */ - public detectProtectiveEquipment( + + /** + * @see {@link DetectProtectiveEquipmentCommand} + */ + detectProtectiveEquipment( args: DetectProtectiveEquipmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public detectProtectiveEquipment( + detectProtectiveEquipment( args: DetectProtectiveEquipmentCommandInput, cb: (err: any, data?: DetectProtectiveEquipmentCommandOutput) => void ): void; - public detectProtectiveEquipment( + detectProtectiveEquipment( args: DetectProtectiveEquipmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectProtectiveEquipmentCommandOutput) => void ): void; - public detectProtectiveEquipment( - args: DetectProtectiveEquipmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectProtectiveEquipmentCommandOutput) => void), - cb?: (err: any, data?: DetectProtectiveEquipmentCommandOutput) => void - ): Promise | void { - const command = new DetectProtectiveEquipmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detects text in the input image and converts it into machine-readable text.

- *

Pass the input image as base64-encoded image bytes or as a reference to an image in an - * Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a - * reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not - * supported. The image must be either a .png or .jpeg formatted file.

- *

The DetectText operation returns text in an array of TextDetection elements, TextDetections. Each - * TextDetection element provides information about a single word or line of text - * that was detected in the image.

- *

A word is one or more script characters that are not separated by spaces. - * DetectText can detect up to 100 words in an image.

- *

A line is a string of equally spaced words. A line isn't necessarily a complete - * sentence. For example, a driver's license number is detected as a line. A line ends when there - * is no aligned text after it. Also, a line ends when there is a large gap between words, - * relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition - * may detect multiple lines in text aligned in the same direction. Periods don't represent the - * end of a line. If a sentence spans multiple lines, the DetectText operation - * returns multiple lines.

- *

To determine whether a TextDetection element is a line of text or a word, - * use the TextDetection object Type field.

- *

To be detected, text must be within +/- 90 degrees orientation of the horizontal - * axis.

- *

For more information, see Detecting text in the Amazon Rekognition Developer - * Guide.

- */ - public detectText(args: DetectTextCommandInput, options?: __HttpHandlerOptions): Promise; - public detectText(args: DetectTextCommandInput, cb: (err: any, data?: DetectTextCommandOutput) => void): void; - public detectText( + + /** + * @see {@link DetectTextCommand} + */ + detectText(args: DetectTextCommandInput, options?: __HttpHandlerOptions): Promise; + detectText(args: DetectTextCommandInput, cb: (err: any, data?: DetectTextCommandOutput) => void): void; + detectText( args: DetectTextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectTextCommandOutput) => void ): void; - public detectText( - args: DetectTextCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectTextCommandOutput) => void), - cb?: (err: any, data?: DetectTextCommandOutput) => void - ): Promise | void { - const command = new DetectTextCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project. - * DistributeDatasetEntries moves 20% of the training dataset images to the test dataset. - * An entry is a JSON Line that describes an image. - *

- *

You supply the Amazon Resource Names (ARN) of a project's training dataset and test dataset. - * The training dataset must contain the images that you want to split. The test dataset - * must be empty. The datasets must belong to the same project. To create training and test datasets for a project, call CreateDataset.

- *

Distributing a dataset takes a while to complete. To check the status call DescribeDataset. The operation - * is complete when the Status field for the training dataset and the test dataset is UPDATE_COMPLETE. - * If the dataset split fails, the value of Status is UPDATE_FAILED.

- *

This operation requires permissions to perform the rekognition:DistributeDatasetEntries action.

- */ - public distributeDatasetEntries( + + /** + * @see {@link DistributeDatasetEntriesCommand} + */ + distributeDatasetEntries( args: DistributeDatasetEntriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public distributeDatasetEntries( + distributeDatasetEntries( args: DistributeDatasetEntriesCommandInput, cb: (err: any, data?: DistributeDatasetEntriesCommandOutput) => void ): void; - public distributeDatasetEntries( + distributeDatasetEntries( args: DistributeDatasetEntriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DistributeDatasetEntriesCommandOutput) => void ): void; - public distributeDatasetEntries( - args: DistributeDatasetEntriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DistributeDatasetEntriesCommandOutput) => void), - cb?: (err: any, data?: DistributeDatasetEntriesCommandOutput) => void - ): Promise | void { - const command = new DistributeDatasetEntriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the name and additional information about a celebrity based on their Amazon Rekognition ID. - * The additional information is returned as an array of URLs. If there is no additional - * information about the celebrity, this list is empty.

- *

For more information, see Getting information about a celebrity in the - * Amazon Rekognition Developer Guide.

- *

This operation requires permissions to perform the - * rekognition:GetCelebrityInfo action.

- */ - public getCelebrityInfo( + + /** + * @see {@link GetCelebrityInfoCommand} + */ + getCelebrityInfo( args: GetCelebrityInfoCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCelebrityInfo( + getCelebrityInfo( args: GetCelebrityInfoCommandInput, cb: (err: any, data?: GetCelebrityInfoCommandOutput) => void ): void; - public getCelebrityInfo( + getCelebrityInfo( args: GetCelebrityInfoCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCelebrityInfoCommandOutput) => void ): void; - public getCelebrityInfo( - args: GetCelebrityInfoCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCelebrityInfoCommandOutput) => void), - cb?: (err: any, data?: GetCelebrityInfoCommandOutput) => void - ): Promise | void { - const command = new GetCelebrityInfoCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by - * StartCelebrityRecognition.

- *

Celebrity recognition in a video is an asynchronous operation. Analysis is started by a - * call to StartCelebrityRecognition which returns a job identifier - * (JobId).

- *

When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion - * status to the Amazon Simple Notification Service topic registered in the initial call to - * StartCelebrityRecognition. To get the results of the celebrity recognition - * analysis, first check that the status value published to the Amazon SNS topic is - * SUCCEEDED. If so, call GetCelebrityDetection and pass the job - * identifier (JobId) from the initial call to StartCelebrityDetection.

- *

For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.

- *

- * GetCelebrityRecognition returns detected celebrities and the time(s) they - * are detected in an array (Celebrities) of CelebrityRecognition - * objects. Each CelebrityRecognition - * contains information about the celebrity in a CelebrityDetail object and the - * time, Timestamp, the celebrity was detected. This CelebrityDetail object stores information about the detected celebrity's face - * attributes, a face bounding box, known gender, the celebrity's name, and a confidence - * estimate.

- * - *

- * GetCelebrityRecognition only returns the default facial - * attributes (BoundingBox, Confidence, Landmarks, - * Pose, and Quality). The BoundingBox field only - * applies to the detected face instance. The other facial attributes listed in the - * Face object of the following response syntax are not returned. For more - * information, see FaceDetail in the Amazon Rekognition Developer Guide.

- *
- *

By default, the Celebrities array is sorted by time (milliseconds from the start of the video). - * You can also sort the array by celebrity by specifying the value ID in the SortBy input parameter.

- *

The CelebrityDetail object includes the celebrity identifer and additional information urls. If you don't store - * the additional information urls, you can get them later by calling GetCelebrityInfo with the celebrity identifer.

- *

No information is returned for faces not recognized as celebrities.

- *

Use MaxResults parameter to limit the number of labels returned. If there are more results than - * specified in MaxResults, the value of NextToken in the operation response contains a - * pagination token for getting the next set of results. To get the next page of results, call GetCelebrityDetection - * and populate the NextToken request parameter with the token - * value returned from the previous call to GetCelebrityRecognition.

- */ - public getCelebrityRecognition( + + /** + * @see {@link GetCelebrityRecognitionCommand} + */ + getCelebrityRecognition( args: GetCelebrityRecognitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCelebrityRecognition( + getCelebrityRecognition( args: GetCelebrityRecognitionCommandInput, cb: (err: any, data?: GetCelebrityRecognitionCommandOutput) => void ): void; - public getCelebrityRecognition( + getCelebrityRecognition( args: GetCelebrityRecognitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCelebrityRecognitionCommandOutput) => void ): void; - public getCelebrityRecognition( - args: GetCelebrityRecognitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCelebrityRecognitionCommandOutput) => void), - cb?: (err: any, data?: GetCelebrityRecognitionCommandOutput) => void - ): Promise | void { - const command = new GetCelebrityRecognitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by - * StartContentModeration. For a list of moderation labels in Amazon Rekognition, see - * Using the image and video moderation APIs.

- *

Amazon Rekognition Video inappropriate or offensive content detection in a stored video is an asynchronous operation. You start analysis by calling - * StartContentModeration which returns a job identifier (JobId). - * When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service - * topic registered in the initial call to StartContentModeration. - * To get the results of the content analysis, first check that the status value published to the Amazon SNS - * topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier - * (JobId) from the initial call to StartContentModeration.

- *

For more information, see Working with Stored Videos in the - * Amazon Rekognition Devlopers Guide.

- *

- * GetContentModeration returns detected inappropriate, unwanted, or offensive content moderation labels, - * and the time they are detected, in an array, ModerationLabels, of - * ContentModerationDetection objects. - *

- *

By default, the moderated labels are returned sorted by time, in milliseconds from the start of the - * video. You can also sort them by moderated label by specifying NAME for the SortBy - * input parameter.

- *

Since video analysis can return a large number of results, use the MaxResults parameter to limit - * the number of labels returned in a single call to GetContentModeration. If there are more results than - * specified in MaxResults, the value of NextToken in the operation response contains a - * pagination token for getting the next set of results. To get the next page of results, call GetContentModeration - * and populate the NextToken request parameter with the value of NextToken - * returned from the previous call to GetContentModeration.

- *

For more information, see moderating content in the Amazon Rekognition Developer Guide.

- */ - public getContentModeration( + + /** + * @see {@link GetContentModerationCommand} + */ + getContentModeration( args: GetContentModerationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getContentModeration( + getContentModeration( args: GetContentModerationCommandInput, cb: (err: any, data?: GetContentModerationCommandOutput) => void ): void; - public getContentModeration( + getContentModeration( args: GetContentModerationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContentModerationCommandOutput) => void ): void; - public getContentModeration( - args: GetContentModerationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContentModerationCommandOutput) => void), - cb?: (err: any, data?: GetContentModerationCommandOutput) => void - ): Promise | void { - const command = new GetContentModerationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection.

- *

Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling StartFaceDetection - * which returns a job identifier (JobId). When the face detection operation finishes, Amazon Rekognition Video publishes a completion status to - * the Amazon Simple Notification Service topic registered in the initial call to StartFaceDetection. To get the results - * of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. - * If so, call GetFaceDetection and pass the job identifier - * (JobId) from the initial call to StartFaceDetection.

- *

- * GetFaceDetection returns an array of detected faces (Faces) sorted by the time the faces were detected.

- *

Use MaxResults parameter to limit the number of labels returned. If there are more results than - * specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set - * of results. To get the next page of results, call GetFaceDetection and populate the NextToken request parameter with the token - * value returned from the previous call to GetFaceDetection.

- */ - public getFaceDetection( + + /** + * @see {@link GetFaceDetectionCommand} + */ + getFaceDetection( args: GetFaceDetectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFaceDetection( + getFaceDetection( args: GetFaceDetectionCommandInput, cb: (err: any, data?: GetFaceDetectionCommandOutput) => void ): void; - public getFaceDetection( + getFaceDetection( args: GetFaceDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFaceDetectionCommandOutput) => void ): void; - public getFaceDetection( - args: GetFaceDetectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFaceDetectionCommandOutput) => void), - cb?: (err: any, data?: GetFaceDetectionCommandOutput) => void - ): Promise | void { - const command = new GetFaceDetectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the results of a specific Face Liveness session. It requires the - * sessionId as input, which was created using - * CreateFaceLivenessSession. Returns the corresponding Face Liveness confidence - * score, a reference image that includes a face bounding box, and audit images that also contain - * face bounding boxes. The Face Liveness confidence score ranges from 0 to 100. The reference - * image can optionally be returned.

- */ - public getFaceLivenessSessionResults( + + /** + * @see {@link GetFaceLivenessSessionResultsCommand} + */ + getFaceLivenessSessionResults( args: GetFaceLivenessSessionResultsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFaceLivenessSessionResults( + getFaceLivenessSessionResults( args: GetFaceLivenessSessionResultsCommandInput, cb: (err: any, data?: GetFaceLivenessSessionResultsCommandOutput) => void ): void; - public getFaceLivenessSessionResults( + getFaceLivenessSessionResults( args: GetFaceLivenessSessionResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFaceLivenessSessionResultsCommandOutput) => void ): void; - public getFaceLivenessSessionResults( - args: GetFaceLivenessSessionResultsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFaceLivenessSessionResultsCommandOutput) => void), - cb?: (err: any, data?: GetFaceLivenessSessionResultsCommandOutput) => void - ): Promise | void { - const command = new GetFaceLivenessSessionResultsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the face search results for Amazon Rekognition Video face search started by - * StartFaceSearch. The search returns faces in a collection that match the faces - * of persons detected in a video. It also includes the time(s) that faces are matched in the video.

- *

Face search in a video is an asynchronous operation. You start face search by calling - * to StartFaceSearch which returns a job identifier (JobId). - * When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service - * topic registered in the initial call to StartFaceSearch. - * To get the search results, first check that the status value published to the Amazon SNS - * topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier - * (JobId) from the initial call to StartFaceSearch.

- *

For more information, see Searching Faces in a Collection in the - * Amazon Rekognition Developer Guide.

- *

The search results are retured in an array, Persons, of - * PersonMatch objects. EachPersonMatch element contains - * details about the matching faces in the input collection, person information (facial attributes, - * bounding boxes, and person identifer) - * for the matched person, and the time the person was matched in the video.

- * - *

- * GetFaceSearch only returns the default - * facial attributes (BoundingBox, Confidence, - * Landmarks, Pose, and Quality). The other facial attributes listed - * in the Face object of the following response syntax are not returned. For more information, - * see FaceDetail in the Amazon Rekognition Developer Guide.

- *
- *

By default, the Persons array is sorted by the time, in milliseconds from the - * start of the video, persons are matched. - * You can also sort by persons by specifying INDEX for the SORTBY input - * parameter.

- */ - public getFaceSearch( - args: GetFaceSearchCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getFaceSearch( - args: GetFaceSearchCommandInput, - cb: (err: any, data?: GetFaceSearchCommandOutput) => void - ): void; - public getFaceSearch( + + /** + * @see {@link GetFaceSearchCommand} + */ + getFaceSearch(args: GetFaceSearchCommandInput, options?: __HttpHandlerOptions): Promise; + getFaceSearch(args: GetFaceSearchCommandInput, cb: (err: any, data?: GetFaceSearchCommandOutput) => void): void; + getFaceSearch( args: GetFaceSearchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFaceSearchCommandOutput) => void ): void; - public getFaceSearch( - args: GetFaceSearchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFaceSearchCommandOutput) => void), - cb?: (err: any, data?: GetFaceSearchCommandOutput) => void - ): Promise | void { - const command = new GetFaceSearchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection.

- *

The label detection operation is started by a call to StartLabelDetection which returns a job identifier (JobId). When - * the label detection operation finishes, Amazon Rekognition publishes a completion status to the - * Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection.

- *

To get the results of the label detection operation, first check that the status value - * published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the - * initial call to StartLabelDetection.

- *

- * GetLabelDetection returns an array of detected labels - * (Labels) sorted by the time the labels were detected. You can also sort by the - * label name by specifying NAME for the SortBy input parameter. If - * there is no NAME specified, the default sort is by - * timestamp.

- *

You can select how results are aggregated by using the AggregateBy input - * parameter. The default aggregation method is TIMESTAMPS. You can also aggregate - * by SEGMENTS, which aggregates all instances of labels detected in a given - * segment.

- *

The returned Labels array may include the following attributes:

- *
    - *
  • - *

    Name - The name of the detected label.

    - *
  • - *
  • - *

    Confidence - The level of confidence in the label assigned to a detected object.

    - *
  • - *
  • - *

    Parents - The ancestor labels for a detected label. GetLabelDetection returns a hierarchical - * taxonomy of detected labels. For example, a detected car might be assigned the label car. - * The label car has two parent labels: Vehicle (its parent) and Transportation (its - * grandparent). The response includes the all ancestors for a label, where every ancestor is - * a unique label. In the previous example, Car, Vehicle, and Transportation are returned as - * unique labels in the response.

    - *
  • - *
  • - *

    Aliases - Possible Aliases for the label.

    - *
  • - *
  • - *

    Categories - The label categories that the detected label belongs to.

    - *
  • - *
  • - *

    BoundingBox — Bounding boxes are described for all instances of detected common object labels, - * returned in an array of Instance objects. An Instance object contains a BoundingBox object, describing - * the location of the label on the input image. It also includes the confidence for the accuracy of the detected bounding box.

    - *
  • - *
  • - *

    Timestamp - Time, in milliseconds from the start of the video, that the label was detected. - * For aggregation by SEGMENTS, the StartTimestampMillis, - * EndTimestampMillis, and DurationMillis structures are what - * define a segment. Although the “Timestamp” structure is still returned with each label, - * its value is set to be the same as StartTimestampMillis.

    - *
  • - *
- *

Timestamp and Bounding box information are returned for detected Instances, only if - * aggregation is done by TIMESTAMPS. If aggregating by SEGMENTS, - * information about detected instances isn’t returned.

- *

The version of the label model used for the detection is also returned.

- *

- * Note DominantColors isn't returned for Instances, - * although it is shown as part of the response in the sample seen below. - *

- *

Use MaxResults parameter to limit the number of labels returned. If - * there are more results than specified in MaxResults, the value of - * NextToken in the operation response contains a pagination token for getting the - * next set of results. To get the next page of results, call GetlabelDetection and - * populate the NextToken request parameter with the token value returned from the - * previous call to GetLabelDetection.

- */ - public getLabelDetection( + + /** + * @see {@link GetLabelDetectionCommand} + */ + getLabelDetection( args: GetLabelDetectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLabelDetection( + getLabelDetection( args: GetLabelDetectionCommandInput, cb: (err: any, data?: GetLabelDetectionCommandOutput) => void ): void; - public getLabelDetection( + getLabelDetection( args: GetLabelDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLabelDetectionCommandOutput) => void ): void; - public getLabelDetection( - args: GetLabelDetectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLabelDetectionCommandOutput) => void), - cb?: (err: any, data?: GetLabelDetectionCommandOutput) => void - ): Promise | void { - const command = new GetLabelDetectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking.

- *

The person path tracking operation is started by a call to StartPersonTracking - * which returns a job identifier (JobId). When the operation finishes, Amazon Rekognition Video publishes a completion status to - * the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking.

- *

To get the results of the person path tracking operation, first check - * that the status value published to the Amazon SNS topic is SUCCEEDED. - * If so, call GetPersonTracking and pass the job identifier - * (JobId) from the initial call to StartPersonTracking.

- *

- * GetPersonTracking returns an array, Persons, of tracked persons and the time(s) their - * paths were tracked in the video.

- * - *

- * GetPersonTracking only returns the default - * facial attributes (BoundingBox, Confidence, - * Landmarks, Pose, and Quality). The other facial attributes listed - * in the Face object of the following response syntax are not returned.

- *

For more information, see FaceDetail in the Amazon Rekognition Developer Guide.

- *
- *

By default, the array is sorted by the time(s) a person's path is tracked in the video. - * You can sort by tracked persons by specifying INDEX for the SortBy input parameter.

- *

Use the MaxResults parameter to limit the number of items returned. If there are more results than - * specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set - * of results. To get the next page of results, call GetPersonTracking and populate the NextToken request parameter with the token - * value returned from the previous call to GetPersonTracking.

- */ - public getPersonTracking( + + /** + * @see {@link GetPersonTrackingCommand} + */ + getPersonTracking( args: GetPersonTrackingCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPersonTracking( + getPersonTracking( args: GetPersonTrackingCommandInput, cb: (err: any, data?: GetPersonTrackingCommandOutput) => void ): void; - public getPersonTracking( + getPersonTracking( args: GetPersonTrackingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPersonTrackingCommandOutput) => void ): void; - public getPersonTracking( - args: GetPersonTrackingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPersonTrackingCommandOutput) => void), - cb?: (err: any, data?: GetPersonTrackingCommandOutput) => void - ): Promise | void { - const command = new GetPersonTrackingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.

- *

Segment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by - * calling StartSegmentDetection which returns a job identifier (JobId). - * When the segment detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service - * topic registered in the initial call to StartSegmentDetection. To get the results - * of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. - * if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call - * of StartSegmentDetection.

- *

- * GetSegmentDetection returns detected segments in an array (Segments) - * of SegmentDetection objects. Segments is sorted by the segment types - * specified in the SegmentTypes input parameter of StartSegmentDetection. - * Each element of the array includes the detected segment, the precentage confidence in the acuracy - * of the detected segment, the type of the segment, and the frame in which the segment was detected.

- *

Use SelectedSegmentTypes to find out the type of segment detection requested in the - * call to StartSegmentDetection.

- *

Use the MaxResults parameter to limit the number of segment detections returned. If there are more results than - * specified in MaxResults, the value of NextToken in the operation response contains - * a pagination token for getting the next set of results. To get the next page of results, call GetSegmentDetection - * and populate the NextToken request parameter with the token value returned from the previous - * call to GetSegmentDetection.

- *

For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.

- */ - public getSegmentDetection( + + /** + * @see {@link GetSegmentDetectionCommand} + */ + getSegmentDetection( args: GetSegmentDetectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSegmentDetection( + getSegmentDetection( args: GetSegmentDetectionCommandInput, cb: (err: any, data?: GetSegmentDetectionCommandOutput) => void ): void; - public getSegmentDetection( + getSegmentDetection( args: GetSegmentDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSegmentDetectionCommandOutput) => void ): void; - public getSegmentDetection( - args: GetSegmentDetectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSegmentDetectionCommandOutput) => void), - cb?: (err: any, data?: GetSegmentDetectionCommandOutput) => void - ): Promise | void { - const command = new GetSegmentDetectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.

- *

Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by - * calling StartTextDetection which returns a job identifier (JobId) - * When the text detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service - * topic registered in the initial call to StartTextDetection. To get the results - * of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. - * if so, call GetTextDetection and pass the job identifier (JobId) from the initial call - * of StartLabelDetection.

- *

- * GetTextDetection returns an array of detected text (TextDetections) sorted by - * the time the text was detected, up to 50 words per frame of video.

- *

Each element of the array includes the detected text, the precentage confidence in the acuracy - * of the detected text, the time the text was detected, bounding box information for where the text - * was located, and unique identifiers for words and their lines.

- *

Use MaxResults parameter to limit the number of text detections returned. If there are more results than - * specified in MaxResults, the value of NextToken in the operation response contains - * a pagination token for getting the next set of results. To get the next page of results, call GetTextDetection - * and populate the NextToken request parameter with the token value returned from the previous - * call to GetTextDetection.

- */ - public getTextDetection( + + /** + * @see {@link GetTextDetectionCommand} + */ + getTextDetection( args: GetTextDetectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTextDetection( + getTextDetection( args: GetTextDetectionCommandInput, cb: (err: any, data?: GetTextDetectionCommandOutput) => void ): void; - public getTextDetection( + getTextDetection( args: GetTextDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTextDetectionCommandOutput) => void ): void; - public getTextDetection( - args: GetTextDetectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTextDetectionCommandOutput) => void), - cb?: (err: any, data?: GetTextDetectionCommandOutput) => void - ): Promise | void { - const command = new GetTextDetectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Detects faces in the input image and adds them to the specified collection.

- *

Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying - * detection algorithm first detects the faces in the input image. For each face, the algorithm - * extracts facial features into a feature vector, and stores it in the backend database. - * Amazon Rekognition uses feature vectors when it performs face match and search operations using the - * SearchFaces and SearchFacesByImage operations.

- *

For more information, see Adding faces to a collection in the Amazon Rekognition - * Developer Guide.

- *

To get the number of faces in a collection, call DescribeCollection.

- *

If you're using version 1.0 of the face detection model, IndexFaces - * indexes the 15 largest faces in the input image. Later versions of the face detection model - * index the 100 largest faces in the input image.

- *

If you're using version 4 or later of the face model, image orientation information is not - * returned in the OrientationCorrection field.

- *

To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model - * version from the value of FaceModelVersion in the response from - * IndexFaces - *

- *

For more information, see Model Versioning in the Amazon Rekognition Developer - * Guide.

- *

If you provide the optional ExternalImageId for the input image you - * provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this - * external image ID to create a client-side index to associate the faces with each image. You - * can then use the index to find all faces in an image.

- *

You can specify the maximum number of faces to index with the MaxFaces input - * parameter. This is useful when you want to index the largest faces in an image and don't want - * to index smaller faces, such as those belonging to people standing in the background.

- *

The QualityFilter input parameter allows you to filter out detected faces - * that don’t meet a required quality bar. The quality bar is based on a variety of common use - * cases. By default, IndexFaces chooses the quality bar that's used to filter - * faces. You can also explicitly choose the quality bar. Use QualityFilter, to set - * the quality bar by specifying LOW, MEDIUM, or HIGH. If - * you do not want to filter detected faces, specify NONE.

- * - *

To use quality filtering, you need a collection associated with version 3 of the face - * model or higher. To get the version of the face model associated with a collection, call - * DescribeCollection.

- *
- *

Information about faces detected in an image, but not indexed, is returned in an array of - * UnindexedFace objects, UnindexedFaces. Faces aren't indexed - * for reasons such as:

- *
    - *
  • - *

    The number of faces detected exceeds the value of the MaxFaces request - * parameter.

    - *
  • - *
  • - *

    The face is too small compared to the image dimensions.

    - *
  • - *
  • - *

    The face is too blurry.

    - *
  • - *
  • - *

    The image is too dark.

    - *
  • - *
  • - *

    The face has an extreme pose.

    - *
  • - *
  • - *

    The face doesn’t have enough detail to be suitable for face search.

    - *
  • - *
- *

In response, the IndexFaces operation returns an array of metadata for all - * detected faces, FaceRecords. This includes:

- *
    - *
  • - *

    The bounding box, BoundingBox, of the detected face.

    - *
  • - *
  • - *

    A confidence value, Confidence, which indicates the confidence that the - * bounding box contains a face.

    - *
  • - *
  • - *

    A face ID, FaceId, assigned by the service for each face that's detected - * and stored.

    - *
  • - *
  • - *

    An image ID, ImageId, assigned by the service for the input image.

    - *
  • - *
- *

If you request all facial attributes (by using the detectionAttributes - * parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for - * example, location of eye and mouth) and other facial attributes. If you provide the same - * image, specify the same collection, and use the same external ID in the - * IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.

- *

- *

The input image is passed either as base64-encoded image bytes, or as a reference to an - * image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, - * passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.

- *

This operation requires permissions to perform the rekognition:IndexFaces - * action.

- */ - public indexFaces(args: IndexFacesCommandInput, options?: __HttpHandlerOptions): Promise; - public indexFaces(args: IndexFacesCommandInput, cb: (err: any, data?: IndexFacesCommandOutput) => void): void; - public indexFaces( + + /** + * @see {@link IndexFacesCommand} + */ + indexFaces(args: IndexFacesCommandInput, options?: __HttpHandlerOptions): Promise; + indexFaces(args: IndexFacesCommandInput, cb: (err: any, data?: IndexFacesCommandOutput) => void): void; + indexFaces( args: IndexFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IndexFacesCommandOutput) => void ): void; - public indexFaces( - args: IndexFacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: IndexFacesCommandOutput) => void), - cb?: (err: any, data?: IndexFacesCommandOutput) => void - ): Promise | void { - const command = new IndexFacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns list of collection IDs in your account. If the result is truncated, the - * response also provides a NextToken that you can use in the subsequent request to - * fetch the next set of collection IDs.

- *

For an example, see Listing collections in the Amazon Rekognition Developer - * Guide.

- *

This operation requires permissions to perform the - * rekognition:ListCollections action.

- */ - public listCollections( + + /** + * @see {@link ListCollectionsCommand} + */ + listCollections( args: ListCollectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCollections( - args: ListCollectionsCommandInput, - cb: (err: any, data?: ListCollectionsCommandOutput) => void - ): void; - public listCollections( + listCollections(args: ListCollectionsCommandInput, cb: (err: any, data?: ListCollectionsCommandOutput) => void): void; + listCollections( args: ListCollectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCollectionsCommandOutput) => void ): void; - public listCollections( - args: ListCollectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCollectionsCommandOutput) => void), - cb?: (err: any, data?: ListCollectionsCommandOutput) => void - ): Promise | void { - const command = new ListCollectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Lists the entries (images) within a dataset. An entry is a - * JSON Line that contains the information for a single image, including - * the image location, assigned labels, and object location bounding boxes. For - * more information, see Creating a manifest file.

- *

JSON Lines in the response include information about non-terminal - * errors found in the dataset. - * Non terminal errors are reported in errors lists within each JSON Line. The - * same information is reported in the training and testing validation result manifests that - * Amazon Rekognition Custom Labels creates during model training. - *

- *

You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date. - *

- *

This operation requires permissions to perform the rekognition:ListDatasetEntries action.

- */ - public listDatasetEntries( + + /** + * @see {@link ListDatasetEntriesCommand} + */ + listDatasetEntries( args: ListDatasetEntriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDatasetEntries( + listDatasetEntries( args: ListDatasetEntriesCommandInput, cb: (err: any, data?: ListDatasetEntriesCommandOutput) => void ): void; - public listDatasetEntries( + listDatasetEntries( args: ListDatasetEntriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetEntriesCommandOutput) => void ): void; - public listDatasetEntries( - args: ListDatasetEntriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatasetEntriesCommandOutput) => void), - cb?: (err: any, data?: ListDatasetEntriesCommandOutput) => void - ): Promise | void { - const command = new ListDatasetEntriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see - * Labeling images. - *

- *

- * Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images - * in the Amazon Rekognition Custom Labels Developer Guide.

- */ - public listDatasetLabels( + + /** + * @see {@link ListDatasetLabelsCommand} + */ + listDatasetLabels( args: ListDatasetLabelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDatasetLabels( + listDatasetLabels( args: ListDatasetLabelsCommandInput, cb: (err: any, data?: ListDatasetLabelsCommandOutput) => void ): void; - public listDatasetLabels( + listDatasetLabels( args: ListDatasetLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetLabelsCommandOutput) => void ): void; - public listDatasetLabels( - args: ListDatasetLabelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatasetLabelsCommandOutput) => void), - cb?: (err: any, data?: ListDatasetLabelsCommandOutput) => void - ): Promise | void { - const command = new ListDatasetLabelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns metadata for faces in the specified collection. This metadata - * includes information such as the bounding box coordinates, the confidence (that the bounding - * box contains a face), and face ID. For an example, see Listing Faces in a Collection in the - * Amazon Rekognition Developer Guide.

- *

This operation requires permissions to perform the rekognition:ListFaces - * action.

- */ - public listFaces(args: ListFacesCommandInput, options?: __HttpHandlerOptions): Promise; - public listFaces(args: ListFacesCommandInput, cb: (err: any, data?: ListFacesCommandOutput) => void): void; - public listFaces( + + /** + * @see {@link ListFacesCommand} + */ + listFaces(args: ListFacesCommandInput, options?: __HttpHandlerOptions): Promise; + listFaces(args: ListFacesCommandInput, cb: (err: any, data?: ListFacesCommandOutput) => void): void; + listFaces( args: ListFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFacesCommandOutput) => void ): void; - public listFaces( - args: ListFacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFacesCommandOutput) => void), - cb?: (err: any, data?: ListFacesCommandOutput) => void - ): Promise | void { - const command = new ListFacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of the project policies attached to a project.

- *

To attach a project policy to a project, call PutProjectPolicy. To remove a project policy from a project, call DeleteProjectPolicy.

- *

This operation requires permissions to perform the rekognition:ListProjectPolicies action.

- */ - public listProjectPolicies( + + /** + * @see {@link ListProjectPoliciesCommand} + */ + listProjectPolicies( args: ListProjectPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProjectPolicies( + listProjectPolicies( args: ListProjectPoliciesCommandInput, cb: (err: any, data?: ListProjectPoliciesCommandOutput) => void ): void; - public listProjectPolicies( + listProjectPolicies( args: ListProjectPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProjectPoliciesCommandOutput) => void ): void; - public listProjectPolicies( - args: ListProjectPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProjectPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListProjectPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListProjectPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of stream processors that you have created with CreateStreamProcessor.

- */ - public listStreamProcessors( + + /** + * @see {@link ListStreamProcessorsCommand} + */ + listStreamProcessors( args: ListStreamProcessorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStreamProcessors( + listStreamProcessors( args: ListStreamProcessorsCommandInput, cb: (err: any, data?: ListStreamProcessorsCommandOutput) => void ): void; - public listStreamProcessors( + listStreamProcessors( args: ListStreamProcessorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamProcessorsCommandOutput) => void ): void; - public listStreamProcessors( - args: ListStreamProcessorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStreamProcessorsCommandOutput) => void), - cb?: (err: any, data?: ListStreamProcessorsCommandOutput) => void - ): Promise | void { - const command = new ListStreamProcessorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels - * model.

- *

This operation requires permissions to perform the - * rekognition:ListTagsForResource action.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A - * project policy specifies that a trusted AWS account can copy a model version from a - * trusting AWS account to a project in the trusted AWS account. To copy a model version you use - * the CopyProjectVersion operation.

- *

For more information about the format of a project policy document, see Attaching a project policy (SDK) - * in the Amazon Rekognition Custom Labels Developer Guide. - *

- *

The response from PutProjectPolicy is a revision ID for the project policy. - * You can attach multiple project policies to a project. You can also update an existing - * project policy by specifying the policy revision ID of the existing policy.

- *

To remove a project policy from a project, call DeleteProjectPolicy. - * To get a list of project policies attached to a project, call ListProjectPolicies.

- *

You copy a model version by calling CopyProjectVersion.

- *

This operation requires permissions to perform the rekognition:PutProjectPolicy action.

- */ - public putProjectPolicy( + + /** + * @see {@link PutProjectPolicyCommand} + */ + putProjectPolicy( args: PutProjectPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putProjectPolicy( + putProjectPolicy( args: PutProjectPolicyCommandInput, cb: (err: any, data?: PutProjectPolicyCommandOutput) => void ): void; - public putProjectPolicy( + putProjectPolicy( args: PutProjectPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutProjectPolicyCommandOutput) => void ): void; - public putProjectPolicy( - args: PutProjectPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutProjectPolicyCommandOutput) => void), - cb?: (err: any, data?: PutProjectPolicyCommandOutput) => void - ): Promise | void { - const command = new PutProjectPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns an array of celebrities recognized in the input image. For more - * information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.

- *

- * RecognizeCelebrities returns the 64 largest faces in the image. It lists - * the recognized celebrities in the CelebrityFaces array and any unrecognized faces - * in the UnrecognizedFaces array. RecognizeCelebrities doesn't return - * celebrities whose faces aren't among the largest 64 faces in the image.

- *

For each celebrity recognized, RecognizeCelebrities returns a - * Celebrity object. The Celebrity object contains the celebrity - * name, ID, URL links to additional information, match confidence, and a - * ComparedFace object that you can use to locate the celebrity's face on the - * image.

- *

Amazon Rekognition doesn't retain information about which images a celebrity has been recognized - * in. Your application must store this information and use the Celebrity ID - * property as a unique identifier for the celebrity. If you don't store the celebrity name or - * additional information URLs returned by RecognizeCelebrities, you will need the - * ID to identify the celebrity in a call to the GetCelebrityInfo - * operation.

- *

You pass the input image either as base64-encoded image bytes or as a reference to an - * image in an Amazon S3 bucket. If you use the - * AWS - * CLI to call Amazon Rekognition operations, passing image bytes is not - * supported. The image must be either a PNG or JPEG formatted file.

- *

For an example, see Recognizing celebrities in an image in the Amazon Rekognition - * Developer Guide.

- *

This operation requires permissions to perform the - * rekognition:RecognizeCelebrities operation.

- */ - public recognizeCelebrities( + + /** + * @see {@link RecognizeCelebritiesCommand} + */ + recognizeCelebrities( args: RecognizeCelebritiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public recognizeCelebrities( + recognizeCelebrities( args: RecognizeCelebritiesCommandInput, cb: (err: any, data?: RecognizeCelebritiesCommandOutput) => void ): void; - public recognizeCelebrities( + recognizeCelebrities( args: RecognizeCelebritiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RecognizeCelebritiesCommandOutput) => void ): void; - public recognizeCelebrities( - args: RecognizeCelebritiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RecognizeCelebritiesCommandOutput) => void), - cb?: (err: any, data?: RecognizeCelebritiesCommandOutput) => void - ): Promise | void { - const command = new RecognizeCelebritiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

For a given input face ID, searches for matching faces in the collection the face - * belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with - * faces in the specified collection.

- * - *

You can also search faces without indexing faces by using the - * SearchFacesByImage operation.

- *
- *

The operation response returns an array of faces that match, ordered by similarity - * score with the highest similarity first. More specifically, it is an array of metadata for - * each face match that is found. Along with the metadata, the response also includes a - * confidence value for each face match, indicating the confidence that the - * specific face matches the input face.

- *

For an example, see Searching for a face using its face ID in the Amazon Rekognition - * Developer Guide.

- *

This operation requires permissions to perform the rekognition:SearchFaces - * action.

- */ - public searchFaces(args: SearchFacesCommandInput, options?: __HttpHandlerOptions): Promise; - public searchFaces(args: SearchFacesCommandInput, cb: (err: any, data?: SearchFacesCommandOutput) => void): void; - public searchFaces( + + /** + * @see {@link SearchFacesCommand} + */ + searchFaces(args: SearchFacesCommandInput, options?: __HttpHandlerOptions): Promise; + searchFaces(args: SearchFacesCommandInput, cb: (err: any, data?: SearchFacesCommandOutput) => void): void; + searchFaces( args: SearchFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchFacesCommandOutput) => void ): void; - public searchFaces( - args: SearchFacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchFacesCommandOutput) => void), - cb?: (err: any, data?: SearchFacesCommandOutput) => void - ): Promise | void { - const command = new SearchFacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

For a given input image, first detects the largest face in the image, and then searches - * the specified collection for matching faces. The operation compares the features of the input - * face with faces in the specified collection.

- * - *

To search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls - * to the SearchFaces operation.

- *

You can also call the DetectFaces operation and use the bounding boxes - * in the response to make face crops, which then you can pass in to the - * SearchFacesByImage operation.

- *
- *

You pass the input image either as base64-encoded image bytes or as a reference to an - * image in an Amazon S3 bucket. If you use the - * AWS - * CLI to call Amazon Rekognition operations, passing image bytes is not - * supported. The image must be either a PNG or JPEG formatted file.

- *

The response returns an array of faces that match, ordered by similarity score with - * the highest similarity first. More specifically, it is an array of metadata for each face - * match found. Along with the metadata, the response also includes a similarity - * indicating how similar the face is to the input face. In the response, the operation also - * returns the bounding box (and a confidence level that the bounding box contains a face) of the - * face that Amazon Rekognition used for the input image.

- *

If no faces are detected in the input image, SearchFacesByImage returns an - * InvalidParameterException error.

- *

For an example, Searching for a Face Using an Image in the Amazon Rekognition - * Developer Guide.

- *

The QualityFilter input parameter allows you to filter out detected faces - * that don’t meet a required quality bar. The quality bar is based on a variety of common use - * cases. Use QualityFilter to set the quality bar for filtering by specifying - * LOW, MEDIUM, or HIGH. If you do not want to filter - * detected faces, specify NONE. The default value is NONE.

- * - *

To use quality filtering, you need a collection associated with version 3 of the face - * model or higher. To get the version of the face model associated with a collection, call - * DescribeCollection.

- *
- *

This operation requires permissions to perform the - * rekognition:SearchFacesByImage action.

- */ - public searchFacesByImage( + + /** + * @see {@link SearchFacesByImageCommand} + */ + searchFacesByImage( args: SearchFacesByImageCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchFacesByImage( + searchFacesByImage( args: SearchFacesByImageCommandInput, cb: (err: any, data?: SearchFacesByImageCommandOutput) => void ): void; - public searchFacesByImage( + searchFacesByImage( args: SearchFacesByImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchFacesByImageCommandOutput) => void ): void; - public searchFacesByImage( - args: SearchFacesByImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchFacesByImageCommandOutput) => void), - cb?: (err: any, data?: SearchFacesByImageCommandOutput) => void - ): Promise | void { - const command = new SearchFacesByImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts asynchronous recognition of celebrities in a stored video.

- *

Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name - * and the filename of the video. - * StartCelebrityRecognition - * returns a job identifier (JobId) which you use to get the results of the analysis. - * When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status - * to the Amazon Simple Notification Service topic that you specify in NotificationChannel. - * To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS - * topic is SUCCEEDED. If so, call GetCelebrityRecognition and pass the job identifier - * (JobId) from the initial call to StartCelebrityRecognition.

- *

For more information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.

- */ - public startCelebrityRecognition( + + /** + * @see {@link StartCelebrityRecognitionCommand} + */ + startCelebrityRecognition( args: StartCelebrityRecognitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startCelebrityRecognition( + startCelebrityRecognition( args: StartCelebrityRecognitionCommandInput, cb: (err: any, data?: StartCelebrityRecognitionCommandOutput) => void ): void; - public startCelebrityRecognition( + startCelebrityRecognition( args: StartCelebrityRecognitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCelebrityRecognitionCommandOutput) => void ): void; - public startCelebrityRecognition( - args: StartCelebrityRecognitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartCelebrityRecognitionCommandOutput) => void), - cb?: (err: any, data?: StartCelebrityRecognitionCommandOutput) => void - ): Promise | void { - const command = new StartCelebrityRecognitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video. For a list of moderation labels in Amazon Rekognition, see - * Using the image and video moderation APIs.

- *

Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name - * and the filename of the video. StartContentModeration - * returns a job identifier (JobId) which you use to get the results of the analysis. - * When content analysis is finished, Amazon Rekognition Video publishes a completion status - * to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

- *

To get the results of the content analysis, first check that the status value published to the Amazon SNS - * topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier - * (JobId) from the initial call to StartContentModeration.

- *

For more information, see Moderating content in the Amazon Rekognition Developer Guide.

- */ - public startContentModeration( + + /** + * @see {@link StartContentModerationCommand} + */ + startContentModeration( args: StartContentModerationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startContentModeration( + startContentModeration( args: StartContentModerationCommandInput, cb: (err: any, data?: StartContentModerationCommandOutput) => void ): void; - public startContentModeration( + startContentModeration( args: StartContentModerationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartContentModerationCommandOutput) => void ): void; - public startContentModeration( - args: StartContentModerationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartContentModerationCommandOutput) => void), - cb?: (err: any, data?: StartContentModerationCommandOutput) => void - ): Promise | void { - const command = new StartContentModerationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts asynchronous detection of faces in a stored video.

- *

Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. - * Use Video to specify the bucket name and the filename of the video. - * StartFaceDetection returns a job identifier (JobId) that you - * use to get the results of the operation. - * When face detection is finished, Amazon Rekognition Video publishes a completion status - * to the Amazon Simple Notification Service topic that you specify in NotificationChannel. - * To get the results of the face detection operation, first check that the status value published to the Amazon SNS - * topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier - * (JobId) from the initial call to StartFaceDetection.

- *

For more information, see Detecting faces in a stored video in the - * Amazon Rekognition Developer Guide.

- */ - public startFaceDetection( + + /** + * @see {@link StartFaceDetectionCommand} + */ + startFaceDetection( args: StartFaceDetectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startFaceDetection( + startFaceDetection( args: StartFaceDetectionCommandInput, cb: (err: any, data?: StartFaceDetectionCommandOutput) => void ): void; - public startFaceDetection( + startFaceDetection( args: StartFaceDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFaceDetectionCommandOutput) => void ): void; - public startFaceDetection( - args: StartFaceDetectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartFaceDetectionCommandOutput) => void), - cb?: (err: any, data?: StartFaceDetectionCommandOutput) => void - ): Promise | void { - const command = new StartFaceDetectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.

- *

The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name - * and the filename of the video. StartFaceSearch - * returns a job identifier (JobId) which you use to get the search results once the search has completed. - * When searching is finished, Amazon Rekognition Video publishes a completion status - * to the Amazon Simple Notification Service topic that you specify in NotificationChannel. - * To get the search results, first check that the status value published to the Amazon SNS - * topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier - * (JobId) from the initial call to StartFaceSearch. For more information, see - * Searching stored videos for faces. - *

- */ - public startFaceSearch( + + /** + * @see {@link StartFaceSearchCommand} + */ + startFaceSearch( args: StartFaceSearchCommandInput, options?: __HttpHandlerOptions ): Promise; - public startFaceSearch( - args: StartFaceSearchCommandInput, - cb: (err: any, data?: StartFaceSearchCommandOutput) => void - ): void; - public startFaceSearch( + startFaceSearch(args: StartFaceSearchCommandInput, cb: (err: any, data?: StartFaceSearchCommandOutput) => void): void; + startFaceSearch( args: StartFaceSearchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFaceSearchCommandOutput) => void ): void; - public startFaceSearch( - args: StartFaceSearchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartFaceSearchCommandOutput) => void), - cb?: (err: any, data?: StartFaceSearchCommandOutput) => void - ): Promise | void { - const command = new StartFaceSearchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts asynchronous detection of labels in a stored video.

- *

Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities. - * This includes objects like flower, tree, and table; events like - * wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities - * like a person getting out of a car or a person skiing.

- *

The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name - * and the filename of the video. - * StartLabelDetection returns a job identifier (JobId) which you use to get the - * results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status - * to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

- *

To get the results of the label detection operation, first check that the status value published to the Amazon SNS - * topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier - * (JobId) from the initial call to StartLabelDetection.

- *

- * Optional Parameters - *

- *

- * StartLabelDetection has the GENERAL_LABELS Feature applied by - * default. This feature allows you to provide filtering criteria to the Settings - * parameter. You can filter with sets of individual labels or with label categories. You can - * specify inclusive filters, exclusive filters, or a combination of inclusive and exclusive - * filters. For more information on filtering, see Detecting labels in a - * video.

- *

You can specify MinConfidence to control the confidence threshold for the - * labels returned. The default is 50.

- */ - public startLabelDetection( + + /** + * @see {@link StartLabelDetectionCommand} + */ + startLabelDetection( args: StartLabelDetectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startLabelDetection( + startLabelDetection( args: StartLabelDetectionCommandInput, cb: (err: any, data?: StartLabelDetectionCommandOutput) => void ): void; - public startLabelDetection( + startLabelDetection( args: StartLabelDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartLabelDetectionCommandOutput) => void ): void; - public startLabelDetection( - args: StartLabelDetectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartLabelDetectionCommandOutput) => void), - cb?: (err: any, data?: StartLabelDetectionCommandOutput) => void - ): Promise | void { - const command = new StartLabelDetectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts the asynchronous tracking of a person's path in a stored video.

- *

Amazon Rekognition Video can track the path of people in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name - * and the filename of the video. StartPersonTracking - * returns a job identifier (JobId) which you use to get the results of the operation. - * When label detection is finished, Amazon Rekognition publishes a completion status - * to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

- *

To get the results of the person detection operation, first check that the status value published to the Amazon SNS - * topic is SUCCEEDED. If so, call GetPersonTracking and pass the job identifier - * (JobId) from the initial call to StartPersonTracking.

- */ - public startPersonTracking( + + /** + * @see {@link StartPersonTrackingCommand} + */ + startPersonTracking( args: StartPersonTrackingCommandInput, options?: __HttpHandlerOptions ): Promise; - public startPersonTracking( + startPersonTracking( args: StartPersonTrackingCommandInput, cb: (err: any, data?: StartPersonTrackingCommandOutput) => void ): void; - public startPersonTracking( + startPersonTracking( args: StartPersonTrackingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartPersonTrackingCommandOutput) => void ): void; - public startPersonTracking( - args: StartPersonTrackingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartPersonTrackingCommandOutput) => void), - cb?: (err: any, data?: StartPersonTrackingCommandOutput) => void - ): Promise | void { - const command = new StartPersonTrackingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts the running of the version of a model. Starting a model takes a while - * to complete. To check the current state of the model, use DescribeProjectVersions.

- *

Once the model is running, you can detect custom labels in new images by calling - * DetectCustomLabels.

- * - *

You are charged for the amount of time that the model is running. To stop a running - * model, call StopProjectVersion.

- *
- *

For more information, see Running a trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom Labels Guide.

- *

This operation requires permissions to perform the - * rekognition:StartProjectVersion action.

- */ - public startProjectVersion( + + /** + * @see {@link StartProjectVersionCommand} + */ + startProjectVersion( args: StartProjectVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startProjectVersion( + startProjectVersion( args: StartProjectVersionCommandInput, cb: (err: any, data?: StartProjectVersionCommandOutput) => void ): void; - public startProjectVersion( + startProjectVersion( args: StartProjectVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartProjectVersionCommandOutput) => void ): void; - public startProjectVersion( - args: StartProjectVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartProjectVersionCommandOutput) => void), - cb?: (err: any, data?: StartProjectVersionCommandOutput) => void - ): Promise | void { - const command = new StartProjectVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts asynchronous detection of segment detection in a stored video.

- *

Amazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and - * the filename of the video. StartSegmentDetection returns a job identifier (JobId) which you use to get - * the results of the operation. When segment detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic - * that you specify in NotificationChannel.

- *

You can use the Filters (StartSegmentDetectionFilters) - * input parameter to specify the minimum detection confidence returned in the response. - * Within Filters, use ShotFilter (StartShotDetectionFilter) - * to filter detected shots. Use TechnicalCueFilter (StartTechnicalCueDetectionFilter) - * to filter technical cues.

- *

To get the results of the segment detection operation, first check that the status value published to the Amazon SNS - * topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) - * from the initial call to StartSegmentDetection.

- *

For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.

- */ - public startSegmentDetection( + + /** + * @see {@link StartSegmentDetectionCommand} + */ + startSegmentDetection( args: StartSegmentDetectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startSegmentDetection( + startSegmentDetection( args: StartSegmentDetectionCommandInput, cb: (err: any, data?: StartSegmentDetectionCommandOutput) => void ): void; - public startSegmentDetection( + startSegmentDetection( args: StartSegmentDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSegmentDetectionCommandOutput) => void ): void; - public startSegmentDetection( - args: StartSegmentDetectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartSegmentDetectionCommandOutput) => void), - cb?: (err: any, data?: StartSegmentDetectionCommandOutput) => void - ): Promise | void { - const command = new StartSegmentDetectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor. - * To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to - * CreateStreamProcessor.

- *

If you are using a label detection stream processor to detect labels, you need to provide a Start selector and a Stop selector to determine the length of the stream processing time.

- */ - public startStreamProcessor( + + /** + * @see {@link StartStreamProcessorCommand} + */ + startStreamProcessor( args: StartStreamProcessorCommandInput, options?: __HttpHandlerOptions ): Promise; - public startStreamProcessor( + startStreamProcessor( args: StartStreamProcessorCommandInput, cb: (err: any, data?: StartStreamProcessorCommandOutput) => void ): void; - public startStreamProcessor( + startStreamProcessor( args: StartStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartStreamProcessorCommandOutput) => void ): void; - public startStreamProcessor( - args: StartStreamProcessorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartStreamProcessorCommandOutput) => void), - cb?: (err: any, data?: StartStreamProcessorCommandOutput) => void - ): Promise | void { - const command = new StartStreamProcessorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts asynchronous detection of text in a stored video.

- *

Amazon Rekognition Video can detect text in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and - * the filename of the video. StartTextDetection returns a job identifier (JobId) which you use to get - * the results of the operation. When text detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic - * that you specify in NotificationChannel.

- *

To get the results of the text detection operation, first check that the status value published to the Amazon SNS - * topic is SUCCEEDED. if so, call GetTextDetection and pass the job identifier (JobId) - * from the initial call to StartTextDetection.

- */ - public startTextDetection( + + /** + * @see {@link StartTextDetectionCommand} + */ + startTextDetection( args: StartTextDetectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startTextDetection( + startTextDetection( args: StartTextDetectionCommandInput, cb: (err: any, data?: StartTextDetectionCommandOutput) => void ): void; - public startTextDetection( + startTextDetection( args: StartTextDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTextDetectionCommandOutput) => void ): void; - public startTextDetection( - args: StartTextDetectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartTextDetectionCommandOutput) => void), - cb?: (err: any, data?: StartTextDetectionCommandOutput) => void - ): Promise | void { - const command = new StartTextDetectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a running model. The operation might take a while to complete. To - * check the current status, call DescribeProjectVersions.

- *

This operation requires permissions to perform the rekognition:StopProjectVersion action.

- */ - public stopProjectVersion( + + /** + * @see {@link StopProjectVersionCommand} + */ + stopProjectVersion( args: StopProjectVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopProjectVersion( + stopProjectVersion( args: StopProjectVersionCommandInput, cb: (err: any, data?: StopProjectVersionCommandOutput) => void ): void; - public stopProjectVersion( + stopProjectVersion( args: StopProjectVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopProjectVersionCommandOutput) => void ): void; - public stopProjectVersion( - args: StopProjectVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopProjectVersionCommandOutput) => void), - cb?: (err: any, data?: StopProjectVersionCommandOutput) => void - ): Promise | void { - const command = new StopProjectVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a running stream processor that was created by CreateStreamProcessor.

- */ - public stopStreamProcessor( + + /** + * @see {@link StopStreamProcessorCommand} + */ + stopStreamProcessor( args: StopStreamProcessorCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopStreamProcessor( + stopStreamProcessor( args: StopStreamProcessorCommandInput, cb: (err: any, data?: StopStreamProcessorCommandOutput) => void ): void; - public stopStreamProcessor( + stopStreamProcessor( args: StopStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopStreamProcessorCommandOutput) => void ): void; - public stopStreamProcessor( - args: StopStreamProcessorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopStreamProcessorCommandOutput) => void), - cb?: (err: any, data?: StopStreamProcessorCommandOutput) => void - ): Promise | void { - const command = new StopStreamProcessorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, or Custom - * Labels model. For more information, see Tagging AWS - * Resources.

- *

This operation requires permissions to perform the rekognition:TagResource - * action.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels - * model.

- *

This operation requires permissions to perform the - * rekognition:UntagResource action.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the - * information for a single image, including - * the image location, assigned labels, and object location bounding boxes. For more information, - * see Image-Level labels in manifest files and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide. - *

- *

If the source-ref field in the JSON line references an existing image, the existing image in the dataset - * is updated. - * If source-ref field doesn't reference an existing image, the image is added as a new image to the dataset.

- *

You specify the changes that you want to make in the Changes input parameter. - * There isn't a limit to the number JSON Lines that you can change, but the size of Changes must be less - * than 5MB.

- *

- * UpdateDatasetEntries returns immediatly, but the dataset update might take a while to complete. - * Use DescribeDataset to check the - * current status. The dataset updated successfully if the value of Status is - * UPDATE_COMPLETE.

- *

To check if any non-terminal errors occured, call ListDatasetEntries - * and check for the presence of errors lists in the JSON Lines.

- *

Dataset update fails if a terminal error occurs (Status = UPDATE_FAILED). - * Currently, you can't access the terminal error information from the Amazon Rekognition Custom Labels SDK. - *

- *

This operation requires permissions to perform the rekognition:UpdateDatasetEntries action.

- */ - public updateDatasetEntries( + + /** + * @see {@link UpdateDatasetEntriesCommand} + */ + updateDatasetEntries( args: UpdateDatasetEntriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDatasetEntries( + updateDatasetEntries( args: UpdateDatasetEntriesCommandInput, cb: (err: any, data?: UpdateDatasetEntriesCommandOutput) => void ): void; - public updateDatasetEntries( + updateDatasetEntries( args: UpdateDatasetEntriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDatasetEntriesCommandOutput) => void ): void; - public updateDatasetEntries( - args: UpdateDatasetEntriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDatasetEntriesCommandOutput) => void), - cb?: (err: any, data?: UpdateDatasetEntriesCommandOutput) => void - ): Promise | void { - const command = new UpdateDatasetEntriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Allows you to update a stream processor. You can change some settings and regions of interest and delete certain parameters. - *

- */ - public updateStreamProcessor( + + /** + * @see {@link UpdateStreamProcessorCommand} + */ + updateStreamProcessor( args: UpdateStreamProcessorCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateStreamProcessor( + updateStreamProcessor( args: UpdateStreamProcessorCommandInput, cb: (err: any, data?: UpdateStreamProcessorCommandOutput) => void ): void; - public updateStreamProcessor( + updateStreamProcessor( args: UpdateStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStreamProcessorCommandOutput) => void ): void; - public updateStreamProcessor( - args: UpdateStreamProcessorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStreamProcessorCommandOutput) => void), - cb?: (err: any, data?: UpdateStreamProcessorCommandOutput) => void - ): Promise | void { - const command = new UpdateStreamProcessorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

This is the API Reference for Amazon Rekognition Image, Amazon Rekognition Custom Labels, + * Amazon Rekognition Stored + * Video, Amazon Rekognition Streaming Video. It provides descriptions of actions, data types, common + * parameters, and common errors.

+ *

+ * Amazon Rekognition Image + *

+ * + *

+ * Amazon Rekognition Custom Labels + *

+ * + *

+ * Amazon Rekognition Video Stored Video + *

+ * + *

+ * Amazon Rekognition Video Streaming Video + *

+ * + */ +export class Rekognition extends RekognitionClient implements Rekognition {} +createAggregatedClient(commands, Rekognition); diff --git a/clients/client-rekognitionstreaming/src/RekognitionStreaming.ts b/clients/client-rekognitionstreaming/src/RekognitionStreaming.ts index 4adfa908e115..7906d5d7a8ec 100644 --- a/clients/client-rekognitionstreaming/src/RekognitionStreaming.ts +++ b/clients/client-rekognitionstreaming/src/RekognitionStreaming.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -6,7 +7,30 @@ import { StartFaceLivenessSessionCommandInput, StartFaceLivenessSessionCommandOutput, } from "./commands/StartFaceLivenessSessionCommand"; -import { RekognitionStreamingClient } from "./RekognitionStreamingClient"; +import { RekognitionStreamingClient, RekognitionStreamingClientConfig } from "./RekognitionStreamingClient"; + +const commands = { + StartFaceLivenessSessionCommand, +}; + +export interface RekognitionStreaming { + /** + * @see {@link StartFaceLivenessSessionCommand} + */ + startFaceLivenessSession( + args: StartFaceLivenessSessionCommandInput, + options?: __HttpHandlerOptions + ): Promise; + startFaceLivenessSession( + args: StartFaceLivenessSessionCommandInput, + cb: (err: any, data?: StartFaceLivenessSessionCommandOutput) => void + ): void; + startFaceLivenessSession( + args: StartFaceLivenessSessionCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: StartFaceLivenessSessionCommandOutput) => void + ): void; +} /** * @public @@ -33,45 +57,5 @@ import { RekognitionStreamingClient } from "./RekognitionStreamingClient"; * * */ -export class RekognitionStreaming extends RekognitionStreamingClient { - /** - * @public - *

Starts a Face Liveness video stream and liveness detection process for a given - * session.

- *

Requires sessionId, ChallengeVersions, VideoWidth, - * VideoHeight and a RequestEventStream as input. The event stream - * contains information about different events for the session, including the challenge - * information used for verification.

- *

The maximum video size for Face Liveness is 10 MB. Face Liveness throws a - * ValidationException if the video does not match the necessary formatting and - * size parameters.

- */ - public startFaceLivenessSession( - args: StartFaceLivenessSessionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public startFaceLivenessSession( - args: StartFaceLivenessSessionCommandInput, - cb: (err: any, data?: StartFaceLivenessSessionCommandOutput) => void - ): void; - public startFaceLivenessSession( - args: StartFaceLivenessSessionCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: StartFaceLivenessSessionCommandOutput) => void - ): void; - public startFaceLivenessSession( - args: StartFaceLivenessSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartFaceLivenessSessionCommandOutput) => void), - cb?: (err: any, data?: StartFaceLivenessSessionCommandOutput) => void - ): Promise | void { - const command = new StartFaceLivenessSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } -} +export class RekognitionStreaming extends RekognitionStreamingClient implements RekognitionStreaming {} +createAggregatedClient(commands, RekognitionStreaming); diff --git a/clients/client-resiliencehub/src/Resiliencehub.ts b/clients/client-resiliencehub/src/Resiliencehub.ts index 79a84215fd54..fb106c7fb59e 100644 --- a/clients/client-resiliencehub/src/Resiliencehub.ts +++ b/clients/client-resiliencehub/src/Resiliencehub.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -237,1826 +238,911 @@ import { UpdateResiliencyPolicyCommandInput, UpdateResiliencyPolicyCommandOutput, } from "./commands/UpdateResiliencyPolicyCommand"; -import { ResiliencehubClient } from "./ResiliencehubClient"; +import { ResiliencehubClient, ResiliencehubClientConfig } from "./ResiliencehubClient"; -/** - * @public - *

Resilience Hub helps you proactively prepare and protect your Amazon Web Services applications from - * disruptions. It offers continual resiliency assessment and validation that integrates - * into your software development lifecycle. This enables you to uncover resiliency weaknesses, - * ensure recovery time objective (RTO) and recovery point objective (RPO) targets for your - * applications are met, and resolve issues before they are released into production.

- */ -export class Resiliencehub extends ResiliencehubClient { +const commands = { + AddDraftAppVersionResourceMappingsCommand, + CreateAppCommand, + CreateAppVersionAppComponentCommand, + CreateAppVersionResourceCommand, + CreateRecommendationTemplateCommand, + CreateResiliencyPolicyCommand, + DeleteAppCommand, + DeleteAppAssessmentCommand, + DeleteAppInputSourceCommand, + DeleteAppVersionAppComponentCommand, + DeleteAppVersionResourceCommand, + DeleteRecommendationTemplateCommand, + DeleteResiliencyPolicyCommand, + DescribeAppCommand, + DescribeAppAssessmentCommand, + DescribeAppVersionCommand, + DescribeAppVersionAppComponentCommand, + DescribeAppVersionResourceCommand, + DescribeAppVersionResourcesResolutionStatusCommand, + DescribeAppVersionTemplateCommand, + DescribeDraftAppVersionResourcesImportStatusCommand, + DescribeResiliencyPolicyCommand, + ImportResourcesToDraftAppVersionCommand, + ListAlarmRecommendationsCommand, + ListAppAssessmentsCommand, + ListAppComponentCompliancesCommand, + ListAppComponentRecommendationsCommand, + ListAppInputSourcesCommand, + ListAppsCommand, + ListAppVersionAppComponentsCommand, + ListAppVersionResourceMappingsCommand, + ListAppVersionResourcesCommand, + ListAppVersionsCommand, + ListRecommendationTemplatesCommand, + ListResiliencyPoliciesCommand, + ListSopRecommendationsCommand, + ListSuggestedResiliencyPoliciesCommand, + ListTagsForResourceCommand, + ListTestRecommendationsCommand, + ListUnsupportedAppVersionResourcesCommand, + PublishAppVersionCommand, + PutDraftAppVersionTemplateCommand, + RemoveDraftAppVersionResourceMappingsCommand, + ResolveAppVersionResourcesCommand, + StartAppAssessmentCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAppCommand, + UpdateAppVersionCommand, + UpdateAppVersionAppComponentCommand, + UpdateAppVersionResourceCommand, + UpdateResiliencyPolicyCommand, +}; + +export interface Resiliencehub { /** - * @public - *

Adds the resource mapping for the draft application version. You can also update an existing resource mapping to a new physical resource.

+ * @see {@link AddDraftAppVersionResourceMappingsCommand} */ - public addDraftAppVersionResourceMappings( + addDraftAppVersionResourceMappings( args: AddDraftAppVersionResourceMappingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public addDraftAppVersionResourceMappings( + addDraftAppVersionResourceMappings( args: AddDraftAppVersionResourceMappingsCommandInput, cb: (err: any, data?: AddDraftAppVersionResourceMappingsCommandOutput) => void ): void; - public addDraftAppVersionResourceMappings( + addDraftAppVersionResourceMappings( args: AddDraftAppVersionResourceMappingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddDraftAppVersionResourceMappingsCommandOutput) => void ): void; - public addDraftAppVersionResourceMappings( - args: AddDraftAppVersionResourceMappingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddDraftAppVersionResourceMappingsCommandOutput) => void), - cb?: (err: any, data?: AddDraftAppVersionResourceMappingsCommandOutput) => void - ): Promise | void { - const command = new AddDraftAppVersionResourceMappingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an Resilience Hub application. An Resilience Hub application is a - * collection of Amazon Web Services resources structured to prevent and recover Amazon Web Services application disruptions. To describe a Resilience Hub application, you provide an - * application name, resources from one or more–up to 20–CloudFormation stacks, and an appropriate - * resiliency policy.

- *

After you create an Resilience Hub application, you publish it so that you can run a resiliency - * assessment on it. You can then use recommendations from the assessment to improve resiliency - * by running another assessment, comparing results, and then iterating the process until you - * achieve your goals for recovery time objective (RTO) and recovery point objective - * (RPO).

+ * @see {@link CreateAppCommand} */ - public createApp(args: CreateAppCommandInput, options?: __HttpHandlerOptions): Promise; - public createApp(args: CreateAppCommandInput, cb: (err: any, data?: CreateAppCommandOutput) => void): void; - public createApp( + createApp(args: CreateAppCommandInput, options?: __HttpHandlerOptions): Promise; + createApp(args: CreateAppCommandInput, cb: (err: any, data?: CreateAppCommandOutput) => void): void; + createApp( args: CreateAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppCommandOutput) => void ): void; - public createApp( - args: CreateAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAppCommandOutput) => void), - cb?: (err: any, data?: CreateAppCommandOutput) => void - ): Promise | void { - const command = new CreateAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new Application Component in the Resilience Hub application.

- * - *

This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.

- *
+ * @see {@link CreateAppVersionAppComponentCommand} */ - public createAppVersionAppComponent( + createAppVersionAppComponent( args: CreateAppVersionAppComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAppVersionAppComponent( + createAppVersionAppComponent( args: CreateAppVersionAppComponentCommandInput, cb: (err: any, data?: CreateAppVersionAppComponentCommandOutput) => void ): void; - public createAppVersionAppComponent( + createAppVersionAppComponent( args: CreateAppVersionAppComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppVersionAppComponentCommandOutput) => void ): void; - public createAppVersionAppComponent( - args: CreateAppVersionAppComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAppVersionAppComponentCommandOutput) => void), - cb?: (err: any, data?: CreateAppVersionAppComponentCommandOutput) => void - ): Promise | void { - const command = new CreateAppVersionAppComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a resource to the Resilience Hub application and assigns it to the specified - * Application Components. If you specify a new Application Component, Resilience Hub will automatically - * create the Application Component.

- * - *
    - *
  • - *

    This action has no effect outside Resilience Hub.

    - *
  • - *
  • - *

    This API updates the Resilience Hub application draft version. To use this resource - * for running resiliency assessments, you must publish the Resilience Hub application using - * the PublishAppVersion API.

    - *
  • - *
  • - *

    To update application version with new physicalResourceID, you must - * call ResolveAppVersionResources API.

    - *
  • - *
- *
+ * @see {@link CreateAppVersionResourceCommand} */ - public createAppVersionResource( + createAppVersionResource( args: CreateAppVersionResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAppVersionResource( + createAppVersionResource( args: CreateAppVersionResourceCommandInput, cb: (err: any, data?: CreateAppVersionResourceCommandOutput) => void ): void; - public createAppVersionResource( + createAppVersionResource( args: CreateAppVersionResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppVersionResourceCommandOutput) => void ): void; - public createAppVersionResource( - args: CreateAppVersionResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAppVersionResourceCommandOutput) => void), - cb?: (err: any, data?: CreateAppVersionResourceCommandOutput) => void - ): Promise | void { - const command = new CreateAppVersionResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new recommendation template for the Resilience Hub application.

+ * @see {@link CreateRecommendationTemplateCommand} */ - public createRecommendationTemplate( + createRecommendationTemplate( args: CreateRecommendationTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRecommendationTemplate( + createRecommendationTemplate( args: CreateRecommendationTemplateCommandInput, cb: (err: any, data?: CreateRecommendationTemplateCommandOutput) => void ): void; - public createRecommendationTemplate( + createRecommendationTemplate( args: CreateRecommendationTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRecommendationTemplateCommandOutput) => void ): void; - public createRecommendationTemplate( - args: CreateRecommendationTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRecommendationTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateRecommendationTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateRecommendationTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a resiliency policy for an application.

+ * @see {@link CreateResiliencyPolicyCommand} */ - public createResiliencyPolicy( + createResiliencyPolicy( args: CreateResiliencyPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createResiliencyPolicy( + createResiliencyPolicy( args: CreateResiliencyPolicyCommandInput, cb: (err: any, data?: CreateResiliencyPolicyCommandOutput) => void ): void; - public createResiliencyPolicy( + createResiliencyPolicy( args: CreateResiliencyPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResiliencyPolicyCommandOutput) => void ): void; - public createResiliencyPolicy( - args: CreateResiliencyPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateResiliencyPolicyCommandOutput) => void), - cb?: (err: any, data?: CreateResiliencyPolicyCommandOutput) => void - ): Promise | void { - const command = new CreateResiliencyPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Resilience Hub application. This is a destructive action that can't be - * undone.

+ * @see {@link DeleteAppCommand} */ - public deleteApp(args: DeleteAppCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteApp(args: DeleteAppCommandInput, cb: (err: any, data?: DeleteAppCommandOutput) => void): void; - public deleteApp( + deleteApp(args: DeleteAppCommandInput, options?: __HttpHandlerOptions): Promise; + deleteApp(args: DeleteAppCommandInput, cb: (err: any, data?: DeleteAppCommandOutput) => void): void; + deleteApp( args: DeleteAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppCommandOutput) => void ): void; - public deleteApp( - args: DeleteAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppCommandOutput) => void), - cb?: (err: any, data?: DeleteAppCommandOutput) => void - ): Promise | void { - const command = new DeleteAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Resilience Hub application assessment. This is a destructive action that can't - * be undone.

+ * @see {@link DeleteAppAssessmentCommand} */ - public deleteAppAssessment( + deleteAppAssessment( args: DeleteAppAssessmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAppAssessment( + deleteAppAssessment( args: DeleteAppAssessmentCommandInput, cb: (err: any, data?: DeleteAppAssessmentCommandOutput) => void ): void; - public deleteAppAssessment( + deleteAppAssessment( args: DeleteAppAssessmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppAssessmentCommandOutput) => void ): void; - public deleteAppAssessment( - args: DeleteAppAssessmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppAssessmentCommandOutput) => void), - cb?: (err: any, data?: DeleteAppAssessmentCommandOutput) => void - ): Promise | void { - const command = new DeleteAppAssessmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the input source and all of its imported resources from the Resilience Hub application.

+ * @see {@link DeleteAppInputSourceCommand} */ - public deleteAppInputSource( + deleteAppInputSource( args: DeleteAppInputSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAppInputSource( + deleteAppInputSource( args: DeleteAppInputSourceCommandInput, cb: (err: any, data?: DeleteAppInputSourceCommandOutput) => void ): void; - public deleteAppInputSource( + deleteAppInputSource( args: DeleteAppInputSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppInputSourceCommandOutput) => void ): void; - public deleteAppInputSource( - args: DeleteAppInputSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppInputSourceCommandOutput) => void), - cb?: (err: any, data?: DeleteAppInputSourceCommandOutput) => void - ): Promise | void { - const command = new DeleteAppInputSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Application Component from the Resilience Hub application.

- * - *
    - *
  • - *

    This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.

    - *
  • - *
  • - *

    You will not be able to delete an Application Component if it has resources associated with it.

    - *
  • - *
- *
+ * @see {@link DeleteAppVersionAppComponentCommand} */ - public deleteAppVersionAppComponent( + deleteAppVersionAppComponent( args: DeleteAppVersionAppComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAppVersionAppComponent( + deleteAppVersionAppComponent( args: DeleteAppVersionAppComponentCommandInput, cb: (err: any, data?: DeleteAppVersionAppComponentCommandOutput) => void ): void; - public deleteAppVersionAppComponent( + deleteAppVersionAppComponent( args: DeleteAppVersionAppComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppVersionAppComponentCommandOutput) => void ): void; - public deleteAppVersionAppComponent( - args: DeleteAppVersionAppComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppVersionAppComponentCommandOutput) => void), - cb?: (err: any, data?: DeleteAppVersionAppComponentCommandOutput) => void - ): Promise | void { - const command = new DeleteAppVersionAppComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a resource from the Resilience Hub application.

- * - *
    - *
  • - *

    You can only delete a manually added resource. To exclude non-manually added resources, use the UpdateAppVersionResource API.

    - *
  • - *
  • - *

    This action has no effect outside Resilience Hub.

    - *
  • - *
  • - *

    This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.

    - *
  • - *
- *
+ * @see {@link DeleteAppVersionResourceCommand} */ - public deleteAppVersionResource( + deleteAppVersionResource( args: DeleteAppVersionResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAppVersionResource( + deleteAppVersionResource( args: DeleteAppVersionResourceCommandInput, cb: (err: any, data?: DeleteAppVersionResourceCommandOutput) => void ): void; - public deleteAppVersionResource( + deleteAppVersionResource( args: DeleteAppVersionResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppVersionResourceCommandOutput) => void ): void; - public deleteAppVersionResource( - args: DeleteAppVersionResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppVersionResourceCommandOutput) => void), - cb?: (err: any, data?: DeleteAppVersionResourceCommandOutput) => void - ): Promise | void { - const command = new DeleteAppVersionResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a recommendation template. This is a destructive action that can't be - * undone.

+ * @see {@link DeleteRecommendationTemplateCommand} */ - public deleteRecommendationTemplate( + deleteRecommendationTemplate( args: DeleteRecommendationTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRecommendationTemplate( + deleteRecommendationTemplate( args: DeleteRecommendationTemplateCommandInput, cb: (err: any, data?: DeleteRecommendationTemplateCommandOutput) => void ): void; - public deleteRecommendationTemplate( + deleteRecommendationTemplate( args: DeleteRecommendationTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRecommendationTemplateCommandOutput) => void ): void; - public deleteRecommendationTemplate( - args: DeleteRecommendationTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRecommendationTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteRecommendationTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteRecommendationTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a resiliency policy. This is a destructive action that can't be undone.

+ * @see {@link DeleteResiliencyPolicyCommand} */ - public deleteResiliencyPolicy( + deleteResiliencyPolicy( args: DeleteResiliencyPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResiliencyPolicy( + deleteResiliencyPolicy( args: DeleteResiliencyPolicyCommandInput, cb: (err: any, data?: DeleteResiliencyPolicyCommandOutput) => void ): void; - public deleteResiliencyPolicy( + deleteResiliencyPolicy( args: DeleteResiliencyPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResiliencyPolicyCommandOutput) => void ): void; - public deleteResiliencyPolicy( - args: DeleteResiliencyPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResiliencyPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteResiliencyPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteResiliencyPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an Resilience Hub application.

+ * @see {@link DescribeAppCommand} */ - public describeApp(args: DescribeAppCommandInput, options?: __HttpHandlerOptions): Promise; - public describeApp(args: DescribeAppCommandInput, cb: (err: any, data?: DescribeAppCommandOutput) => void): void; - public describeApp( + describeApp(args: DescribeAppCommandInput, options?: __HttpHandlerOptions): Promise; + describeApp(args: DescribeAppCommandInput, cb: (err: any, data?: DescribeAppCommandOutput) => void): void; + describeApp( args: DescribeAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppCommandOutput) => void ): void; - public describeApp( - args: DescribeAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAppCommandOutput) => void), - cb?: (err: any, data?: DescribeAppCommandOutput) => void - ): Promise | void { - const command = new DescribeAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an assessment for an Resilience Hub application.

+ * @see {@link DescribeAppAssessmentCommand} */ - public describeAppAssessment( + describeAppAssessment( args: DescribeAppAssessmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAppAssessment( + describeAppAssessment( args: DescribeAppAssessmentCommandInput, cb: (err: any, data?: DescribeAppAssessmentCommandOutput) => void ): void; - public describeAppAssessment( + describeAppAssessment( args: DescribeAppAssessmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppAssessmentCommandOutput) => void ): void; - public describeAppAssessment( - args: DescribeAppAssessmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAppAssessmentCommandOutput) => void), - cb?: (err: any, data?: DescribeAppAssessmentCommandOutput) => void - ): Promise | void { - const command = new DescribeAppAssessmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the Resilience Hub application version.

+ * @see {@link DescribeAppVersionCommand} */ - public describeAppVersion( + describeAppVersion( args: DescribeAppVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAppVersion( + describeAppVersion( args: DescribeAppVersionCommandInput, cb: (err: any, data?: DescribeAppVersionCommandOutput) => void ): void; - public describeAppVersion( + describeAppVersion( args: DescribeAppVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppVersionCommandOutput) => void ): void; - public describeAppVersion( - args: DescribeAppVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAppVersionCommandOutput) => void), - cb?: (err: any, data?: DescribeAppVersionCommandOutput) => void - ): Promise | void { - const command = new DescribeAppVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an Application Component in the Resilience Hub application.

+ * @see {@link DescribeAppVersionAppComponentCommand} */ - public describeAppVersionAppComponent( + describeAppVersionAppComponent( args: DescribeAppVersionAppComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAppVersionAppComponent( + describeAppVersionAppComponent( args: DescribeAppVersionAppComponentCommandInput, cb: (err: any, data?: DescribeAppVersionAppComponentCommandOutput) => void ): void; - public describeAppVersionAppComponent( + describeAppVersionAppComponent( args: DescribeAppVersionAppComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppVersionAppComponentCommandOutput) => void ): void; - public describeAppVersionAppComponent( - args: DescribeAppVersionAppComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAppVersionAppComponentCommandOutput) => void), - cb?: (err: any, data?: DescribeAppVersionAppComponentCommandOutput) => void - ): Promise | void { - const command = new DescribeAppVersionAppComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a resource of the Resilience Hub application.

- * - *

This API accepts only one of the following parameters to descibe the resource:

- *
    - *
  • - *

    - * resourceName - *

    - *
  • - *
  • - *

    - * logicalResourceId - *

    - *
  • - *
  • - *

    - * physicalResourceId (Along with physicalResourceId, you can also - * provide awsAccountId, and awsRegion)

    - *
  • - *
- *
+ * @see {@link DescribeAppVersionResourceCommand} */ - public describeAppVersionResource( + describeAppVersionResource( args: DescribeAppVersionResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAppVersionResource( + describeAppVersionResource( args: DescribeAppVersionResourceCommandInput, cb: (err: any, data?: DescribeAppVersionResourceCommandOutput) => void ): void; - public describeAppVersionResource( + describeAppVersionResource( args: DescribeAppVersionResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppVersionResourceCommandOutput) => void ): void; - public describeAppVersionResource( - args: DescribeAppVersionResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAppVersionResourceCommandOutput) => void), - cb?: (err: any, data?: DescribeAppVersionResourceCommandOutput) => void - ): Promise | void { - const command = new DescribeAppVersionResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the resolution status for the specified resolution identifier for an application - * version. If resolutionId is not specified, the current resolution status is - * returned.

+ * @see {@link DescribeAppVersionResourcesResolutionStatusCommand} */ - public describeAppVersionResourcesResolutionStatus( + describeAppVersionResourcesResolutionStatus( args: DescribeAppVersionResourcesResolutionStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAppVersionResourcesResolutionStatus( + describeAppVersionResourcesResolutionStatus( args: DescribeAppVersionResourcesResolutionStatusCommandInput, cb: (err: any, data?: DescribeAppVersionResourcesResolutionStatusCommandOutput) => void ): void; - public describeAppVersionResourcesResolutionStatus( + describeAppVersionResourcesResolutionStatus( args: DescribeAppVersionResourcesResolutionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppVersionResourcesResolutionStatusCommandOutput) => void ): void; - public describeAppVersionResourcesResolutionStatus( - args: DescribeAppVersionResourcesResolutionStatusCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeAppVersionResourcesResolutionStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeAppVersionResourcesResolutionStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeAppVersionResourcesResolutionStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes details about an Resilience Hub application.

+ * @see {@link DescribeAppVersionTemplateCommand} */ - public describeAppVersionTemplate( + describeAppVersionTemplate( args: DescribeAppVersionTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAppVersionTemplate( + describeAppVersionTemplate( args: DescribeAppVersionTemplateCommandInput, cb: (err: any, data?: DescribeAppVersionTemplateCommandOutput) => void ): void; - public describeAppVersionTemplate( + describeAppVersionTemplate( args: DescribeAppVersionTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppVersionTemplateCommandOutput) => void ): void; - public describeAppVersionTemplate( - args: DescribeAppVersionTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAppVersionTemplateCommandOutput) => void), - cb?: (err: any, data?: DescribeAppVersionTemplateCommandOutput) => void - ): Promise | void { - const command = new DescribeAppVersionTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the status of importing resources to an application version.

- * - *

If you get a 404 error with - * ResourceImportStatusNotFoundAppMetadataException, you must call - * importResourcesToDraftAppVersion after creating the application and before - * calling describeDraftAppVersionResourcesImportStatus to obtain the - * status.

- *
+ * @see {@link DescribeDraftAppVersionResourcesImportStatusCommand} */ - public describeDraftAppVersionResourcesImportStatus( + describeDraftAppVersionResourcesImportStatus( args: DescribeDraftAppVersionResourcesImportStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDraftAppVersionResourcesImportStatus( + describeDraftAppVersionResourcesImportStatus( args: DescribeDraftAppVersionResourcesImportStatusCommandInput, cb: (err: any, data?: DescribeDraftAppVersionResourcesImportStatusCommandOutput) => void ): void; - public describeDraftAppVersionResourcesImportStatus( + describeDraftAppVersionResourcesImportStatus( args: DescribeDraftAppVersionResourcesImportStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDraftAppVersionResourcesImportStatusCommandOutput) => void ): void; - public describeDraftAppVersionResourcesImportStatus( - args: DescribeDraftAppVersionResourcesImportStatusCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeDraftAppVersionResourcesImportStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeDraftAppVersionResourcesImportStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeDraftAppVersionResourcesImportStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a specified resiliency policy for an Resilience Hub application. The returned - * policy object includes creation time, data location constraints, the Amazon Resource Name - * (ARN) for the policy, tags, tier, and more.

+ * @see {@link DescribeResiliencyPolicyCommand} */ - public describeResiliencyPolicy( + describeResiliencyPolicy( args: DescribeResiliencyPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeResiliencyPolicy( + describeResiliencyPolicy( args: DescribeResiliencyPolicyCommandInput, cb: (err: any, data?: DescribeResiliencyPolicyCommandOutput) => void ): void; - public describeResiliencyPolicy( + describeResiliencyPolicy( args: DescribeResiliencyPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeResiliencyPolicyCommandOutput) => void ): void; - public describeResiliencyPolicy( - args: DescribeResiliencyPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeResiliencyPolicyCommandOutput) => void), - cb?: (err: any, data?: DescribeResiliencyPolicyCommandOutput) => void - ): Promise | void { - const command = new DescribeResiliencyPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Imports resources to Resilience Hub application draft version from different input sources. For more information about the input sources supported by Resilience Hub, see Discover - * the structure and describe your Resilience Hub application.

+ * @see {@link ImportResourcesToDraftAppVersionCommand} */ - public importResourcesToDraftAppVersion( + importResourcesToDraftAppVersion( args: ImportResourcesToDraftAppVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public importResourcesToDraftAppVersion( + importResourcesToDraftAppVersion( args: ImportResourcesToDraftAppVersionCommandInput, cb: (err: any, data?: ImportResourcesToDraftAppVersionCommandOutput) => void ): void; - public importResourcesToDraftAppVersion( + importResourcesToDraftAppVersion( args: ImportResourcesToDraftAppVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportResourcesToDraftAppVersionCommandOutput) => void ): void; - public importResourcesToDraftAppVersion( - args: ImportResourcesToDraftAppVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportResourcesToDraftAppVersionCommandOutput) => void), - cb?: (err: any, data?: ImportResourcesToDraftAppVersionCommandOutput) => void - ): Promise | void { - const command = new ImportResourcesToDraftAppVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the alarm recommendations for an Resilience Hub application.

+ * @see {@link ListAlarmRecommendationsCommand} */ - public listAlarmRecommendations( + listAlarmRecommendations( args: ListAlarmRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAlarmRecommendations( + listAlarmRecommendations( args: ListAlarmRecommendationsCommandInput, cb: (err: any, data?: ListAlarmRecommendationsCommandOutput) => void ): void; - public listAlarmRecommendations( + listAlarmRecommendations( args: ListAlarmRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAlarmRecommendationsCommandOutput) => void ): void; - public listAlarmRecommendations( - args: ListAlarmRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAlarmRecommendationsCommandOutput) => void), - cb?: (err: any, data?: ListAlarmRecommendationsCommandOutput) => void - ): Promise | void { - const command = new ListAlarmRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the assessments for an Resilience Hub application. You can use request parameters to - * refine the results for the response object.

+ * @see {@link ListAppAssessmentsCommand} */ - public listAppAssessments( + listAppAssessments( args: ListAppAssessmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAppAssessments( + listAppAssessments( args: ListAppAssessmentsCommandInput, cb: (err: any, data?: ListAppAssessmentsCommandOutput) => void ): void; - public listAppAssessments( + listAppAssessments( args: ListAppAssessmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppAssessmentsCommandOutput) => void ): void; - public listAppAssessments( - args: ListAppAssessmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppAssessmentsCommandOutput) => void), - cb?: (err: any, data?: ListAppAssessmentsCommandOutput) => void - ): Promise | void { - const command = new ListAppAssessmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the compliances for an Resilience Hub Application Component.

+ * @see {@link ListAppComponentCompliancesCommand} */ - public listAppComponentCompliances( + listAppComponentCompliances( args: ListAppComponentCompliancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAppComponentCompliances( + listAppComponentCompliances( args: ListAppComponentCompliancesCommandInput, cb: (err: any, data?: ListAppComponentCompliancesCommandOutput) => void ): void; - public listAppComponentCompliances( + listAppComponentCompliances( args: ListAppComponentCompliancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppComponentCompliancesCommandOutput) => void ): void; - public listAppComponentCompliances( - args: ListAppComponentCompliancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppComponentCompliancesCommandOutput) => void), - cb?: (err: any, data?: ListAppComponentCompliancesCommandOutput) => void - ): Promise | void { - const command = new ListAppComponentCompliancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the recommendations for an Resilience Hub Application Component.

+ * @see {@link ListAppComponentRecommendationsCommand} */ - public listAppComponentRecommendations( + listAppComponentRecommendations( args: ListAppComponentRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAppComponentRecommendations( + listAppComponentRecommendations( args: ListAppComponentRecommendationsCommandInput, cb: (err: any, data?: ListAppComponentRecommendationsCommandOutput) => void ): void; - public listAppComponentRecommendations( + listAppComponentRecommendations( args: ListAppComponentRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppComponentRecommendationsCommandOutput) => void ): void; - public listAppComponentRecommendations( - args: ListAppComponentRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppComponentRecommendationsCommandOutput) => void), - cb?: (err: any, data?: ListAppComponentRecommendationsCommandOutput) => void - ): Promise | void { - const command = new ListAppComponentRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the input sources of the Resilience Hub application. For more information about the - * input sources supported by Resilience Hub, see Discover - * the structure and describe your Resilience Hub application.

+ * @see {@link ListAppInputSourcesCommand} */ - public listAppInputSources( + listAppInputSources( args: ListAppInputSourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAppInputSources( + listAppInputSources( args: ListAppInputSourcesCommandInput, cb: (err: any, data?: ListAppInputSourcesCommandOutput) => void ): void; - public listAppInputSources( + listAppInputSources( args: ListAppInputSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppInputSourcesCommandOutput) => void ): void; - public listAppInputSources( - args: ListAppInputSourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppInputSourcesCommandOutput) => void), - cb?: (err: any, data?: ListAppInputSourcesCommandOutput) => void - ): Promise | void { - const command = new ListAppInputSourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists your Resilience Hub applications.

- * - *

You can filter applications using only one filter at a time or without using any filter. - * If you try to filter applications using multiple filters, you will get the following - * error:

- *

- * An error occurred (ValidationException) when calling the ListApps operation: Only - * one filter is supported for this operation. - *

- *
+ * @see {@link ListAppsCommand} */ - public listApps(args: ListAppsCommandInput, options?: __HttpHandlerOptions): Promise; - public listApps(args: ListAppsCommandInput, cb: (err: any, data?: ListAppsCommandOutput) => void): void; - public listApps( + listApps(args: ListAppsCommandInput, options?: __HttpHandlerOptions): Promise; + listApps(args: ListAppsCommandInput, cb: (err: any, data?: ListAppsCommandOutput) => void): void; + listApps( args: ListAppsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppsCommandOutput) => void ): void; - public listApps( - args: ListAppsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppsCommandOutput) => void), - cb?: (err: any, data?: ListAppsCommandOutput) => void - ): Promise | void { - const command = new ListAppsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the Application Components in the Resilience Hub application.

+ * @see {@link ListAppVersionAppComponentsCommand} */ - public listAppVersionAppComponents( + listAppVersionAppComponents( args: ListAppVersionAppComponentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAppVersionAppComponents( + listAppVersionAppComponents( args: ListAppVersionAppComponentsCommandInput, cb: (err: any, data?: ListAppVersionAppComponentsCommandOutput) => void ): void; - public listAppVersionAppComponents( + listAppVersionAppComponents( args: ListAppVersionAppComponentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppVersionAppComponentsCommandOutput) => void ): void; - public listAppVersionAppComponents( - args: ListAppVersionAppComponentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppVersionAppComponentsCommandOutput) => void), - cb?: (err: any, data?: ListAppVersionAppComponentsCommandOutput) => void - ): Promise | void { - const command = new ListAppVersionAppComponentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists how the resources in an application version are mapped/sourced from. Mappings can be - * physical resource identifiers, CloudFormation stacks, resource-groups, or an application registry - * app.

+ * @see {@link ListAppVersionResourceMappingsCommand} */ - public listAppVersionResourceMappings( + listAppVersionResourceMappings( args: ListAppVersionResourceMappingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAppVersionResourceMappings( + listAppVersionResourceMappings( args: ListAppVersionResourceMappingsCommandInput, cb: (err: any, data?: ListAppVersionResourceMappingsCommandOutput) => void ): void; - public listAppVersionResourceMappings( + listAppVersionResourceMappings( args: ListAppVersionResourceMappingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppVersionResourceMappingsCommandOutput) => void ): void; - public listAppVersionResourceMappings( - args: ListAppVersionResourceMappingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppVersionResourceMappingsCommandOutput) => void), - cb?: (err: any, data?: ListAppVersionResourceMappingsCommandOutput) => void - ): Promise | void { - const command = new ListAppVersionResourceMappingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the resources in an Resilience Hub application.

+ * @see {@link ListAppVersionResourcesCommand} */ - public listAppVersionResources( + listAppVersionResources( args: ListAppVersionResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAppVersionResources( + listAppVersionResources( args: ListAppVersionResourcesCommandInput, cb: (err: any, data?: ListAppVersionResourcesCommandOutput) => void ): void; - public listAppVersionResources( + listAppVersionResources( args: ListAppVersionResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppVersionResourcesCommandOutput) => void ): void; - public listAppVersionResources( - args: ListAppVersionResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppVersionResourcesCommandOutput) => void), - cb?: (err: any, data?: ListAppVersionResourcesCommandOutput) => void - ): Promise | void { - const command = new ListAppVersionResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the different versions for the Resilience Hub applications.

+ * @see {@link ListAppVersionsCommand} */ - public listAppVersions( + listAppVersions( args: ListAppVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAppVersions( - args: ListAppVersionsCommandInput, - cb: (err: any, data?: ListAppVersionsCommandOutput) => void - ): void; - public listAppVersions( + listAppVersions(args: ListAppVersionsCommandInput, cb: (err: any, data?: ListAppVersionsCommandOutput) => void): void; + listAppVersions( args: ListAppVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppVersionsCommandOutput) => void ): void; - public listAppVersions( - args: ListAppVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppVersionsCommandOutput) => void), - cb?: (err: any, data?: ListAppVersionsCommandOutput) => void - ): Promise | void { - const command = new ListAppVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the recommendation templates for the Resilience Hub applications.

+ * @see {@link ListRecommendationTemplatesCommand} */ - public listRecommendationTemplates( + listRecommendationTemplates( args: ListRecommendationTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRecommendationTemplates( + listRecommendationTemplates( args: ListRecommendationTemplatesCommandInput, cb: (err: any, data?: ListRecommendationTemplatesCommandOutput) => void ): void; - public listRecommendationTemplates( + listRecommendationTemplates( args: ListRecommendationTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecommendationTemplatesCommandOutput) => void ): void; - public listRecommendationTemplates( - args: ListRecommendationTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRecommendationTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListRecommendationTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListRecommendationTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the resiliency policies for the Resilience Hub applications.

+ * @see {@link ListResiliencyPoliciesCommand} */ - public listResiliencyPolicies( + listResiliencyPolicies( args: ListResiliencyPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResiliencyPolicies( + listResiliencyPolicies( args: ListResiliencyPoliciesCommandInput, cb: (err: any, data?: ListResiliencyPoliciesCommandOutput) => void ): void; - public listResiliencyPolicies( + listResiliencyPolicies( args: ListResiliencyPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResiliencyPoliciesCommandOutput) => void ): void; - public listResiliencyPolicies( - args: ListResiliencyPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResiliencyPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListResiliencyPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListResiliencyPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the standard operating procedure (SOP) recommendations for the Resilience Hub - * applications.

+ * @see {@link ListSopRecommendationsCommand} */ - public listSopRecommendations( + listSopRecommendations( args: ListSopRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSopRecommendations( + listSopRecommendations( args: ListSopRecommendationsCommandInput, cb: (err: any, data?: ListSopRecommendationsCommandOutput) => void ): void; - public listSopRecommendations( + listSopRecommendations( args: ListSopRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSopRecommendationsCommandOutput) => void ): void; - public listSopRecommendations( - args: ListSopRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSopRecommendationsCommandOutput) => void), - cb?: (err: any, data?: ListSopRecommendationsCommandOutput) => void - ): Promise | void { - const command = new ListSopRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the suggested resiliency policies for the Resilience Hub applications.

+ * @see {@link ListSuggestedResiliencyPoliciesCommand} */ - public listSuggestedResiliencyPolicies( + listSuggestedResiliencyPolicies( args: ListSuggestedResiliencyPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSuggestedResiliencyPolicies( + listSuggestedResiliencyPolicies( args: ListSuggestedResiliencyPoliciesCommandInput, cb: (err: any, data?: ListSuggestedResiliencyPoliciesCommandOutput) => void ): void; - public listSuggestedResiliencyPolicies( + listSuggestedResiliencyPolicies( args: ListSuggestedResiliencyPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSuggestedResiliencyPoliciesCommandOutput) => void ): void; - public listSuggestedResiliencyPolicies( - args: ListSuggestedResiliencyPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSuggestedResiliencyPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListSuggestedResiliencyPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListSuggestedResiliencyPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags for your resources in your Resilience Hub applications.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the test recommendations for the Resilience Hub application.

+ * @see {@link ListTestRecommendationsCommand} */ - public listTestRecommendations( + listTestRecommendations( args: ListTestRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTestRecommendations( + listTestRecommendations( args: ListTestRecommendationsCommandInput, cb: (err: any, data?: ListTestRecommendationsCommandOutput) => void ): void; - public listTestRecommendations( + listTestRecommendations( args: ListTestRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTestRecommendationsCommandOutput) => void ): void; - public listTestRecommendations( - args: ListTestRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTestRecommendationsCommandOutput) => void), - cb?: (err: any, data?: ListTestRecommendationsCommandOutput) => void - ): Promise | void { - const command = new ListTestRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the resources that are not currently supported in Resilience Hub. An unsupported - * resource is a resource that exists in the object that was used to create an app, but is not - * supported by Resilience Hub.

+ * @see {@link ListUnsupportedAppVersionResourcesCommand} */ - public listUnsupportedAppVersionResources( + listUnsupportedAppVersionResources( args: ListUnsupportedAppVersionResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listUnsupportedAppVersionResources( + listUnsupportedAppVersionResources( args: ListUnsupportedAppVersionResourcesCommandInput, cb: (err: any, data?: ListUnsupportedAppVersionResourcesCommandOutput) => void ): void; - public listUnsupportedAppVersionResources( + listUnsupportedAppVersionResources( args: ListUnsupportedAppVersionResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUnsupportedAppVersionResourcesCommandOutput) => void ): void; - public listUnsupportedAppVersionResources( - args: ListUnsupportedAppVersionResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUnsupportedAppVersionResourcesCommandOutput) => void), - cb?: (err: any, data?: ListUnsupportedAppVersionResourcesCommandOutput) => void - ): Promise | void { - const command = new ListUnsupportedAppVersionResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Publishes a new version of a specific Resilience Hub application.

+ * @see {@link PublishAppVersionCommand} */ - public publishAppVersion( + publishAppVersion( args: PublishAppVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public publishAppVersion( + publishAppVersion( args: PublishAppVersionCommandInput, cb: (err: any, data?: PublishAppVersionCommandOutput) => void ): void; - public publishAppVersion( + publishAppVersion( args: PublishAppVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishAppVersionCommandOutput) => void ): void; - public publishAppVersion( - args: PublishAppVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PublishAppVersionCommandOutput) => void), - cb?: (err: any, data?: PublishAppVersionCommandOutput) => void - ): Promise | void { - const command = new PublishAppVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or updates the app template for an Resilience Hub application draft version.

+ * @see {@link PutDraftAppVersionTemplateCommand} */ - public putDraftAppVersionTemplate( + putDraftAppVersionTemplate( args: PutDraftAppVersionTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public putDraftAppVersionTemplate( + putDraftAppVersionTemplate( args: PutDraftAppVersionTemplateCommandInput, cb: (err: any, data?: PutDraftAppVersionTemplateCommandOutput) => void ): void; - public putDraftAppVersionTemplate( + putDraftAppVersionTemplate( args: PutDraftAppVersionTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDraftAppVersionTemplateCommandOutput) => void ): void; - public putDraftAppVersionTemplate( - args: PutDraftAppVersionTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutDraftAppVersionTemplateCommandOutput) => void), - cb?: (err: any, data?: PutDraftAppVersionTemplateCommandOutput) => void - ): Promise | void { - const command = new PutDraftAppVersionTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes resource mappings from a draft application version.

+ * @see {@link RemoveDraftAppVersionResourceMappingsCommand} */ - public removeDraftAppVersionResourceMappings( + removeDraftAppVersionResourceMappings( args: RemoveDraftAppVersionResourceMappingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeDraftAppVersionResourceMappings( + removeDraftAppVersionResourceMappings( args: RemoveDraftAppVersionResourceMappingsCommandInput, cb: (err: any, data?: RemoveDraftAppVersionResourceMappingsCommandOutput) => void ): void; - public removeDraftAppVersionResourceMappings( + removeDraftAppVersionResourceMappings( args: RemoveDraftAppVersionResourceMappingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveDraftAppVersionResourceMappingsCommandOutput) => void ): void; - public removeDraftAppVersionResourceMappings( - args: RemoveDraftAppVersionResourceMappingsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: RemoveDraftAppVersionResourceMappingsCommandOutput) => void), - cb?: (err: any, data?: RemoveDraftAppVersionResourceMappingsCommandOutput) => void - ): Promise | void { - const command = new RemoveDraftAppVersionResourceMappingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Resolves the resources for an application version.

+ * @see {@link ResolveAppVersionResourcesCommand} */ - public resolveAppVersionResources( + resolveAppVersionResources( args: ResolveAppVersionResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public resolveAppVersionResources( + resolveAppVersionResources( args: ResolveAppVersionResourcesCommandInput, cb: (err: any, data?: ResolveAppVersionResourcesCommandOutput) => void ): void; - public resolveAppVersionResources( + resolveAppVersionResources( args: ResolveAppVersionResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResolveAppVersionResourcesCommandOutput) => void ): void; - public resolveAppVersionResources( - args: ResolveAppVersionResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResolveAppVersionResourcesCommandOutput) => void), - cb?: (err: any, data?: ResolveAppVersionResourcesCommandOutput) => void - ): Promise | void { - const command = new ResolveAppVersionResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new application assessment for an application.

+ * @see {@link StartAppAssessmentCommand} */ - public startAppAssessment( + startAppAssessment( args: StartAppAssessmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public startAppAssessment( + startAppAssessment( args: StartAppAssessmentCommandInput, cb: (err: any, data?: StartAppAssessmentCommandOutput) => void ): void; - public startAppAssessment( + startAppAssessment( args: StartAppAssessmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartAppAssessmentCommandOutput) => void ): void; - public startAppAssessment( - args: StartAppAssessmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartAppAssessmentCommandOutput) => void), - cb?: (err: any, data?: StartAppAssessmentCommandOutput) => void - ): Promise | void { - const command = new StartAppAssessmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Applies one or more tags to a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an application.

+ * @see {@link UpdateAppCommand} */ - public updateApp(args: UpdateAppCommandInput, options?: __HttpHandlerOptions): Promise; - public updateApp(args: UpdateAppCommandInput, cb: (err: any, data?: UpdateAppCommandOutput) => void): void; - public updateApp( + updateApp(args: UpdateAppCommandInput, options?: __HttpHandlerOptions): Promise; + updateApp(args: UpdateAppCommandInput, cb: (err: any, data?: UpdateAppCommandOutput) => void): void; + updateApp( args: UpdateAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAppCommandOutput) => void ): void; - public updateApp( - args: UpdateAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAppCommandOutput) => void), - cb?: (err: any, data?: UpdateAppCommandOutput) => void - ): Promise | void { - const command = new UpdateAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the Resilience Hub application version.

- * - *

This API updates the Resilience Hub application draft version. To use this information - * for running resiliency assessments, you must publish the Resilience Hub application using the - * PublishAppVersion API.

- *
+ * @see {@link UpdateAppVersionCommand} */ - public updateAppVersion( + updateAppVersion( args: UpdateAppVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAppVersion( + updateAppVersion( args: UpdateAppVersionCommandInput, cb: (err: any, data?: UpdateAppVersionCommandOutput) => void ): void; - public updateAppVersion( + updateAppVersion( args: UpdateAppVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAppVersionCommandOutput) => void ): void; - public updateAppVersion( - args: UpdateAppVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAppVersionCommandOutput) => void), - cb?: (err: any, data?: UpdateAppVersionCommandOutput) => void - ): Promise | void { - const command = new UpdateAppVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing Application Component in the Resilience Hub application.

- * - *

This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.

- *
+ * @see {@link UpdateAppVersionAppComponentCommand} */ - public updateAppVersionAppComponent( + updateAppVersionAppComponent( args: UpdateAppVersionAppComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAppVersionAppComponent( + updateAppVersionAppComponent( args: UpdateAppVersionAppComponentCommandInput, cb: (err: any, data?: UpdateAppVersionAppComponentCommandOutput) => void ): void; - public updateAppVersionAppComponent( + updateAppVersionAppComponent( args: UpdateAppVersionAppComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAppVersionAppComponentCommandOutput) => void ): void; - public updateAppVersionAppComponent( - args: UpdateAppVersionAppComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAppVersionAppComponentCommandOutput) => void), - cb?: (err: any, data?: UpdateAppVersionAppComponentCommandOutput) => void - ): Promise | void { - const command = new UpdateAppVersionAppComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the resource details in the Resilience Hub application.

- * - *
    - *
  • - *

    This action has no effect outside Resilience Hub.

    - *
  • - *
  • - *

    This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.

    - *
  • - *
  • - *

    To update application version with new physicalResourceID, you must call - * ResolveAppVersionResources API.

    - *
  • - *
- *
+ * @see {@link UpdateAppVersionResourceCommand} */ - public updateAppVersionResource( + updateAppVersionResource( args: UpdateAppVersionResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAppVersionResource( + updateAppVersionResource( args: UpdateAppVersionResourceCommandInput, cb: (err: any, data?: UpdateAppVersionResourceCommandOutput) => void ): void; - public updateAppVersionResource( + updateAppVersionResource( args: UpdateAppVersionResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAppVersionResourceCommandOutput) => void ): void; - public updateAppVersionResource( - args: UpdateAppVersionResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAppVersionResourceCommandOutput) => void), - cb?: (err: any, data?: UpdateAppVersionResourceCommandOutput) => void - ): Promise | void { - const command = new UpdateAppVersionResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a resiliency policy.

+ * @see {@link UpdateResiliencyPolicyCommand} */ - public updateResiliencyPolicy( + updateResiliencyPolicy( args: UpdateResiliencyPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateResiliencyPolicy( + updateResiliencyPolicy( args: UpdateResiliencyPolicyCommandInput, cb: (err: any, data?: UpdateResiliencyPolicyCommandOutput) => void ): void; - public updateResiliencyPolicy( + updateResiliencyPolicy( args: UpdateResiliencyPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResiliencyPolicyCommandOutput) => void ): void; - public updateResiliencyPolicy( - args: UpdateResiliencyPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResiliencyPolicyCommandOutput) => void), - cb?: (err: any, data?: UpdateResiliencyPolicyCommandOutput) => void - ): Promise | void { - const command = new UpdateResiliencyPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Resilience Hub helps you proactively prepare and protect your Amazon Web Services applications from + * disruptions. It offers continual resiliency assessment and validation that integrates + * into your software development lifecycle. This enables you to uncover resiliency weaknesses, + * ensure recovery time objective (RTO) and recovery point objective (RPO) targets for your + * applications are met, and resolve issues before they are released into production.

+ */ +export class Resiliencehub extends ResiliencehubClient implements Resiliencehub {} +createAggregatedClient(commands, Resiliencehub); diff --git a/clients/client-resource-explorer-2/src/ResourceExplorer2.ts b/clients/client-resource-explorer-2/src/ResourceExplorer2.ts index e517d03305c9..33b2dede7e14 100644 --- a/clients/client-resource-explorer-2/src/ResourceExplorer2.ts +++ b/clients/client-resource-explorer-2/src/ResourceExplorer2.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -52,751 +53,294 @@ import { UpdateIndexTypeCommandOutput, } from "./commands/UpdateIndexTypeCommand"; import { UpdateViewCommand, UpdateViewCommandInput, UpdateViewCommandOutput } from "./commands/UpdateViewCommand"; -import { ResourceExplorer2Client } from "./ResourceExplorer2Client"; +import { ResourceExplorer2Client, ResourceExplorer2ClientConfig } from "./ResourceExplorer2Client"; -/** - * @public - *

Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can - * explore your resources using an internet search engine-like experience. Examples of - * resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB - * tables. You can search for your resources using resource metadata like names, tags, and - * IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn - * the service on, to simplify your cross-Region workloads.

- *

Resource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which - * you turn on Resource Explorer. Resource Explorer creates - * and maintains an index in each Region, with the details of that Region's - * resources.

- *

You can search across all of the - * indexed Regions in your account by designating one of your Amazon Web Services Regions to - * contain the aggregator index for the account. When you promote a local index - * in a Region to become the aggregator index for the account, Resource Explorer automatically - * replicates the index information from all local indexes in the other Regions to the - * aggregator index. Therefore, the Region with the aggregator index has a copy of all resource - * information for all Regions in the account where you turned on Resource Explorer. As a result, - * views in the aggregator index Region include resources from all of the indexed Regions in your - * account.

- *

For more information about Amazon Web Services Resource Explorer, including how to enable and configure the - * service, see the Amazon Web Services Resource Explorer User Guide.

- */ -export class ResourceExplorer2 extends ResourceExplorer2Client { +const commands = { + AssociateDefaultViewCommand, + BatchGetViewCommand, + CreateIndexCommand, + CreateViewCommand, + DeleteIndexCommand, + DeleteViewCommand, + DisassociateDefaultViewCommand, + GetDefaultViewCommand, + GetIndexCommand, + GetViewCommand, + ListIndexesCommand, + ListSupportedResourceTypesCommand, + ListTagsForResourceCommand, + ListViewsCommand, + SearchCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateIndexTypeCommand, + UpdateViewCommand, +}; + +export interface ResourceExplorer2 { /** - * @public - *

Sets the specified view as the default for the Amazon Web Services Region in which you call this - * operation. When a user performs a Search that doesn't explicitly - * specify which view to use, then Amazon Web Services Resource Explorer automatically chooses this default view for - * searches performed in this Amazon Web Services Region.

- *

If an Amazon Web Services Region doesn't have a default view - * configured, then users must explicitly specify a view with every Search - * operation performed in that Region.

+ * @see {@link AssociateDefaultViewCommand} */ - public associateDefaultView( + associateDefaultView( args: AssociateDefaultViewCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateDefaultView( + associateDefaultView( args: AssociateDefaultViewCommandInput, cb: (err: any, data?: AssociateDefaultViewCommandOutput) => void ): void; - public associateDefaultView( + associateDefaultView( args: AssociateDefaultViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateDefaultViewCommandOutput) => void ): void; - public associateDefaultView( - args: AssociateDefaultViewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateDefaultViewCommandOutput) => void), - cb?: (err: any, data?: AssociateDefaultViewCommandOutput) => void - ): Promise | void { - const command = new AssociateDefaultViewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves details about a list of views.

+ * @see {@link BatchGetViewCommand} */ - public batchGetView( - args: BatchGetViewCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public batchGetView(args: BatchGetViewCommandInput, cb: (err: any, data?: BatchGetViewCommandOutput) => void): void; - public batchGetView( + batchGetView(args: BatchGetViewCommandInput, options?: __HttpHandlerOptions): Promise; + batchGetView(args: BatchGetViewCommandInput, cb: (err: any, data?: BatchGetViewCommandOutput) => void): void; + batchGetView( args: BatchGetViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetViewCommandOutput) => void ): void; - public batchGetView( - args: BatchGetViewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetViewCommandOutput) => void), - cb?: (err: any, data?: BatchGetViewCommandOutput) => void - ): Promise | void { - const command = new BatchGetViewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating - * an index. Resource Explorer begins discovering the resources in this Region and stores the details - * about the resources in the index so that they can be queried by using the Search operation. You can create only one index in a Region.

- * - *

This operation creates only a local index. To promote the - * local index in one Amazon Web Services Region into the aggregator index for the Amazon Web Services account, use the - * UpdateIndexType operation. For more information, see Turning on cross-Region search by creating an aggregator index in the - * Amazon Web Services Resource Explorer User Guide.

- *
- *

For more details about what happens when you turn on Resource Explorer in an Amazon Web Services Region, see - * Turn - * on Resource Explorer to index your resources in an Amazon Web Services Region in the - * Amazon Web Services Resource Explorer User Guide.

- *

If this is the first Amazon Web Services Region in which you've created an index for Resource Explorer, then - * this operation also creates a - * service-linked role in your Amazon Web Services account that allows Resource Explorer to enumerate - * your resources to populate the index.

- *
    - *
  • - *

    - * Action: - * resource-explorer-2:CreateIndex - *

    - *

    - * Resource: The ARN of the index (as it will - * exist after the operation completes) in the Amazon Web Services Region and account in which - * you're trying to create the index. Use the wildcard character (*) - * at the end of the string to match the eventual UUID. For example, the following - * Resource element restricts the role or user to creating an - * index in only the us-east-2 Region of the specified account.

    - *

    - * "Resource": - * "arn:aws:resource-explorer-2:us-west-2:<account-id>:index/*" - *

    - *

    Alternatively, you can use "Resource": "*" to allow the role or - * user to create an index in any Region.

    - *
  • - *
  • - *

    - * Action: - * iam:CreateServiceLinkedRole - *

    - *

    - * Resource: No specific resource (*).

    - *

    This permission is required only the first time you create an index to turn on - * Resource Explorer in the account. Resource Explorer uses this to create the service-linked - * role needed to index the resources in your account. Resource Explorer uses the - * same service-linked role for all additional indexes you create - * afterwards.

    - *
  • - *
+ * @see {@link CreateIndexCommand} */ - public createIndex(args: CreateIndexCommandInput, options?: __HttpHandlerOptions): Promise; - public createIndex(args: CreateIndexCommandInput, cb: (err: any, data?: CreateIndexCommandOutput) => void): void; - public createIndex( + createIndex(args: CreateIndexCommandInput, options?: __HttpHandlerOptions): Promise; + createIndex(args: CreateIndexCommandInput, cb: (err: any, data?: CreateIndexCommandOutput) => void): void; + createIndex( args: CreateIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIndexCommandOutput) => void ): void; - public createIndex( - args: CreateIndexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIndexCommandOutput) => void), - cb?: (err: any, data?: CreateIndexCommandOutput) => void - ): Promise | void { - const command = new CreateIndexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a view that users can query by using the Search operation. - * Results from queries that you make using this view include only resources that match the - * view's Filters. For more information about Amazon Web Services Resource Explorer views, see Managing views - * in the Amazon Web Services Resource Explorer User Guide.

- *

Only the principals with an IAM identity-based policy that grants Allow - * to the Search action on a Resource with the Amazon resource name (ARN) of - * this view can Search using views you create with this - * operation.

+ * @see {@link CreateViewCommand} */ - public createView(args: CreateViewCommandInput, options?: __HttpHandlerOptions): Promise; - public createView(args: CreateViewCommandInput, cb: (err: any, data?: CreateViewCommandOutput) => void): void; - public createView( + createView(args: CreateViewCommandInput, options?: __HttpHandlerOptions): Promise; + createView(args: CreateViewCommandInput, cb: (err: any, data?: CreateViewCommandOutput) => void): void; + createView( args: CreateViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateViewCommandOutput) => void ): void; - public createView( - args: CreateViewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateViewCommandOutput) => void), - cb?: (err: any, data?: CreateViewCommandOutput) => void - ): Promise | void { - const command = new CreateViewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region. - * When you delete an index, Resource Explorer stops discovering and indexing resources in that - * Region. Resource Explorer also deletes all views in that Region. These actions occur as - * asynchronous background tasks. You can check to see when the actions are complete by - * using the GetIndex operation and checking the Status - * response value.

- * - *

If the index you delete is the aggregator index for the Amazon Web Services account, you must - * wait 24 hours before you can promote another local index to be the - * aggregator index for the account. Users can't perform account-wide searches using - * Resource Explorer until another aggregator index is configured.

- *
+ * @see {@link DeleteIndexCommand} */ - public deleteIndex(args: DeleteIndexCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteIndex(args: DeleteIndexCommandInput, cb: (err: any, data?: DeleteIndexCommandOutput) => void): void; - public deleteIndex( + deleteIndex(args: DeleteIndexCommandInput, options?: __HttpHandlerOptions): Promise; + deleteIndex(args: DeleteIndexCommandInput, cb: (err: any, data?: DeleteIndexCommandOutput) => void): void; + deleteIndex( args: DeleteIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIndexCommandOutput) => void ): void; - public deleteIndex( - args: DeleteIndexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIndexCommandOutput) => void), - cb?: (err: any, data?: DeleteIndexCommandOutput) => void - ): Promise | void { - const command = new DeleteIndexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified view.

- *

If the specified view is the default view for its Amazon Web Services Region, then all Search operations in that Region must explicitly specify the view to use - * until you configure a new default by calling the AssociateDefaultView - * operation.

+ * @see {@link DeleteViewCommand} */ - public deleteView(args: DeleteViewCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteView(args: DeleteViewCommandInput, cb: (err: any, data?: DeleteViewCommandOutput) => void): void; - public deleteView( + deleteView(args: DeleteViewCommandInput, options?: __HttpHandlerOptions): Promise; + deleteView(args: DeleteViewCommandInput, cb: (err: any, data?: DeleteViewCommandOutput) => void): void; + deleteView( args: DeleteViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteViewCommandOutput) => void ): void; - public deleteView( - args: DeleteViewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteViewCommandOutput) => void), - cb?: (err: any, data?: DeleteViewCommandOutput) => void - ): Promise | void { - const command = new DeleteViewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

After you call this operation, the affected Amazon Web Services Region no longer has a default view. - * All Search operations in that Region must explicitly specify a view or - * the operation fails. You can configure a new default by calling the AssociateDefaultView operation.

- *

If an Amazon Web Services Region doesn't have a default view - * configured, then users must explicitly specify a view with every Search - * operation performed in that Region.

+ * @see {@link DisassociateDefaultViewCommand} */ - public disassociateDefaultView( + disassociateDefaultView( args: DisassociateDefaultViewCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateDefaultView( + disassociateDefaultView( args: DisassociateDefaultViewCommandInput, cb: (err: any, data?: DisassociateDefaultViewCommandOutput) => void ): void; - public disassociateDefaultView( + disassociateDefaultView( args: DisassociateDefaultViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateDefaultViewCommandOutput) => void ): void; - public disassociateDefaultView( - args: DisassociateDefaultViewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateDefaultViewCommandOutput) => void), - cb?: (err: any, data?: DisassociateDefaultViewCommandOutput) => void - ): Promise | void { - const command = new DisassociateDefaultViewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the Amazon Resource Name (ARN) of the view that is the default for the - * Amazon Web Services Region in which you call this operation. You can then call GetView to retrieve the details of that view.

+ * @see {@link GetDefaultViewCommand} */ - public getDefaultView( + getDefaultView( args: GetDefaultViewCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDefaultView( - args: GetDefaultViewCommandInput, - cb: (err: any, data?: GetDefaultViewCommandOutput) => void - ): void; - public getDefaultView( + getDefaultView(args: GetDefaultViewCommandInput, cb: (err: any, data?: GetDefaultViewCommandOutput) => void): void; + getDefaultView( args: GetDefaultViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDefaultViewCommandOutput) => void ): void; - public getDefaultView( - args: GetDefaultViewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDefaultViewCommandOutput) => void), - cb?: (err: any, data?: GetDefaultViewCommandOutput) => void - ): Promise | void { - const command = new GetDefaultViewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked - * the operation.

+ * @see {@link GetIndexCommand} */ - public getIndex(args: GetIndexCommandInput, options?: __HttpHandlerOptions): Promise; - public getIndex(args: GetIndexCommandInput, cb: (err: any, data?: GetIndexCommandOutput) => void): void; - public getIndex( + getIndex(args: GetIndexCommandInput, options?: __HttpHandlerOptions): Promise; + getIndex(args: GetIndexCommandInput, cb: (err: any, data?: GetIndexCommandOutput) => void): void; + getIndex( args: GetIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIndexCommandOutput) => void ): void; - public getIndex( - args: GetIndexCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIndexCommandOutput) => void), - cb?: (err: any, data?: GetIndexCommandOutput) => void - ): Promise | void { - const command = new GetIndexCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves details of the specified view.

+ * @see {@link GetViewCommand} */ - public getView(args: GetViewCommandInput, options?: __HttpHandlerOptions): Promise; - public getView(args: GetViewCommandInput, cb: (err: any, data?: GetViewCommandOutput) => void): void; - public getView( + getView(args: GetViewCommandInput, options?: __HttpHandlerOptions): Promise; + getView(args: GetViewCommandInput, cb: (err: any, data?: GetViewCommandOutput) => void): void; + getView( args: GetViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetViewCommandOutput) => void ): void; - public getView( - args: GetViewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetViewCommandOutput) => void), - cb?: (err: any, data?: GetViewCommandOutput) => void - ): Promise | void { - const command = new GetViewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of all of the indexes in Amazon Web Services Regions that are currently collecting - * resource information for Amazon Web Services Resource Explorer.

+ * @see {@link ListIndexesCommand} */ - public listIndexes(args: ListIndexesCommandInput, options?: __HttpHandlerOptions): Promise; - public listIndexes(args: ListIndexesCommandInput, cb: (err: any, data?: ListIndexesCommandOutput) => void): void; - public listIndexes( + listIndexes(args: ListIndexesCommandInput, options?: __HttpHandlerOptions): Promise; + listIndexes(args: ListIndexesCommandInput, cb: (err: any, data?: ListIndexesCommandOutput) => void): void; + listIndexes( args: ListIndexesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIndexesCommandOutput) => void ): void; - public listIndexes( - args: ListIndexesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIndexesCommandOutput) => void), - cb?: (err: any, data?: ListIndexesCommandOutput) => void - ): Promise | void { - const command = new ListIndexesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.

+ * @see {@link ListSupportedResourceTypesCommand} */ - public listSupportedResourceTypes( + listSupportedResourceTypes( args: ListSupportedResourceTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSupportedResourceTypes( + listSupportedResourceTypes( args: ListSupportedResourceTypesCommandInput, cb: (err: any, data?: ListSupportedResourceTypesCommandOutput) => void ): void; - public listSupportedResourceTypes( + listSupportedResourceTypes( args: ListSupportedResourceTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSupportedResourceTypesCommandOutput) => void ): void; - public listSupportedResourceTypes( - args: ListSupportedResourceTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSupportedResourceTypesCommandOutput) => void), - cb?: (err: any, data?: ListSupportedResourceTypesCommandOutput) => void - ): Promise | void { - const command = new ListSupportedResourceTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags that are attached to the specified resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the Amazon resource names (ARNs) of the views available in the Amazon Web Services Region in which you - * call this operation.

- * - *

Always check the NextToken response parameter - * for a null value when calling a paginated operation. These operations can - * occasionally return an empty set of results even when there are more results available. The - * NextToken response parameter value is null - * only - * when there are no more results to display.

- *
+ * @see {@link ListViewsCommand} */ - public listViews(args: ListViewsCommandInput, options?: __HttpHandlerOptions): Promise; - public listViews(args: ListViewsCommandInput, cb: (err: any, data?: ListViewsCommandOutput) => void): void; - public listViews( + listViews(args: ListViewsCommandInput, options?: __HttpHandlerOptions): Promise; + listViews(args: ListViewsCommandInput, cb: (err: any, data?: ListViewsCommandOutput) => void): void; + listViews( args: ListViewsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListViewsCommandOutput) => void ): void; - public listViews( - args: ListViewsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListViewsCommandOutput) => void), - cb?: (err: any, data?: ListViewsCommandOutput) => void - ): Promise | void { - const command = new ListViewsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Searches for resources and displays details about all resources that match the - * specified criteria. You must specify a query string.

- *

All search queries must use a view. If you don't explicitly specify a view, then - * Amazon Web Services Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation. - * The results are the logical intersection of the results that match both the - * QueryString parameter supplied to this operation and the - * SearchFilter parameter attached to the view.

- *

For the complete syntax supported by the QueryString parameter, see - * Search - * query syntax reference for Resource Explorer.

- *

If your search results are empty, or are missing results that you think should be - * there, see Troubleshooting Resource Explorer - * search.

+ * @see {@link SearchCommand} */ - public search(args: SearchCommandInput, options?: __HttpHandlerOptions): Promise; - public search(args: SearchCommandInput, cb: (err: any, data?: SearchCommandOutput) => void): void; - public search( + search(args: SearchCommandInput, options?: __HttpHandlerOptions): Promise; + search(args: SearchCommandInput, cb: (err: any, data?: SearchCommandOutput) => void): void; + search( args: SearchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchCommandOutput) => void ): void; - public search( - args: SearchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchCommandOutput) => void), - cb?: (err: any, data?: SearchCommandOutput) => void - ): Promise | void { - const command = new SearchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes the type of the index from one of the following types to the other. For more - * information about indexes and the role they perform in Amazon Web Services Resource Explorer, see Turning on - * cross-Region search by creating an aggregator index in the - * Amazon Web Services Resource Explorer User Guide.

- *
    - *
  • - *

    - * - * AGGREGATOR index type - *

    - *

    The index contains information about resources from all Amazon Web Services Regions in the - * Amazon Web Services account in which you've created a Resource Explorer index. Resource information from - * all other Regions is replicated to this Region's index.

    - *

    When you change the index type to AGGREGATOR, Resource Explorer turns on - * replication of all discovered resource information from the other Amazon Web Services Regions - * in your account to this index. You can then, from this Region only, perform - * resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account. - * Turning on replication from all other Regions is performed by asynchronous - * background tasks. You can check the status of the asynchronous tasks by using - * the GetIndex operation. When the asynchronous tasks complete, - * the Status response of that operation changes from - * UPDATING to ACTIVE. After that, you can start to - * see results from other Amazon Web Services Regions in query results. However, it can take - * several hours for replication from all other Regions to complete.

    - * - *

    You can have only one aggregator index per Amazon Web Services account. Before you can - * promote a different index to be the aggregator index for the account, you must - * first demote the existing aggregator index to type LOCAL.

    - *
    - *
  • - *
  • - *

    - * - * LOCAL index type - *

    - *

    The index contains information about resources in only the Amazon Web Services Region in - * which the index exists. If an aggregator index in another Region exists, then - * information in this local index is replicated to the aggregator index.

    - *

    When you change the index type to LOCAL, Resource Explorer turns off the - * replication of resource information from all other Amazon Web Services Regions in the - * Amazon Web Services account to this Region. The aggregator index remains in the - * UPDATING state until all replication with other Regions - * successfully stops. You can check the status of the asynchronous task by using - * the GetIndex operation. When Resource Explorer successfully stops all - * replication with other Regions, the Status response of that - * operation changes from UPDATING to ACTIVE. Separately, - * the resource information from other Regions that was previously stored in the - * index is deleted within 30 days by another background task. Until that - * asynchronous task completes, some results from other Regions can continue to - * appear in search results.

    - * - *

    After you demote an aggregator index to a local index, you must wait - * 24 hours before you can promote another index to be the new - * aggregator index for the account.

    - *
    - *
  • - *
+ * @see {@link UpdateIndexTypeCommand} */ - public updateIndexType( + updateIndexType( args: UpdateIndexTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateIndexType( - args: UpdateIndexTypeCommandInput, - cb: (err: any, data?: UpdateIndexTypeCommandOutput) => void - ): void; - public updateIndexType( + updateIndexType(args: UpdateIndexTypeCommandInput, cb: (err: any, data?: UpdateIndexTypeCommandOutput) => void): void; + updateIndexType( args: UpdateIndexTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIndexTypeCommandOutput) => void ): void; - public updateIndexType( - args: UpdateIndexTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateIndexTypeCommandOutput) => void), - cb?: (err: any, data?: UpdateIndexTypeCommandOutput) => void - ): Promise | void { - const command = new UpdateIndexTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies some of the details of a view. You can change the filter string and the list - * of included properties. You can't change the name of the view.

+ * @see {@link UpdateViewCommand} */ - public updateView(args: UpdateViewCommandInput, options?: __HttpHandlerOptions): Promise; - public updateView(args: UpdateViewCommandInput, cb: (err: any, data?: UpdateViewCommandOutput) => void): void; - public updateView( + updateView(args: UpdateViewCommandInput, options?: __HttpHandlerOptions): Promise; + updateView(args: UpdateViewCommandInput, cb: (err: any, data?: UpdateViewCommandOutput) => void): void; + updateView( args: UpdateViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateViewCommandOutput) => void ): void; - public updateView( - args: UpdateViewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateViewCommandOutput) => void), - cb?: (err: any, data?: UpdateViewCommandOutput) => void - ): Promise | void { - const command = new UpdateViewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can + * explore your resources using an internet search engine-like experience. Examples of + * resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB + * tables. You can search for your resources using resource metadata like names, tags, and + * IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn + * the service on, to simplify your cross-Region workloads.

+ *

Resource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which + * you turn on Resource Explorer. Resource Explorer creates + * and maintains an index in each Region, with the details of that Region's + * resources.

+ *

You can search across all of the + * indexed Regions in your account by designating one of your Amazon Web Services Regions to + * contain the aggregator index for the account. When you promote a local index + * in a Region to become the aggregator index for the account, Resource Explorer automatically + * replicates the index information from all local indexes in the other Regions to the + * aggregator index. Therefore, the Region with the aggregator index has a copy of all resource + * information for all Regions in the account where you turned on Resource Explorer. As a result, + * views in the aggregator index Region include resources from all of the indexed Regions in your + * account.

+ *

For more information about Amazon Web Services Resource Explorer, including how to enable and configure the + * service, see the Amazon Web Services Resource Explorer User Guide.

+ */ +export class ResourceExplorer2 extends ResourceExplorer2Client implements ResourceExplorer2 {} +createAggregatedClient(commands, ResourceExplorer2); diff --git a/clients/client-resource-groups-tagging-api/src/ResourceGroupsTaggingAPI.ts b/clients/client-resource-groups-tagging-api/src/ResourceGroupsTaggingAPI.ts index fe4ded3043bf..e954bb92ca30 100644 --- a/clients/client-resource-groups-tagging-api/src/ResourceGroupsTaggingAPI.ts +++ b/clients/client-resource-groups-tagging-api/src/ResourceGroupsTaggingAPI.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -37,403 +38,133 @@ import { UntagResourcesCommandInput, UntagResourcesCommandOutput, } from "./commands/UntagResourcesCommand"; -import { ResourceGroupsTaggingAPIClient } from "./ResourceGroupsTaggingAPIClient"; +import { ResourceGroupsTaggingAPIClient, ResourceGroupsTaggingAPIClientConfig } from "./ResourceGroupsTaggingAPIClient"; -/** - * @public - * Resource Groups Tagging API - */ -export class ResourceGroupsTaggingAPI extends ResourceGroupsTaggingAPIClient { +const commands = { + DescribeReportCreationCommand, + GetComplianceSummaryCommand, + GetResourcesCommand, + GetTagKeysCommand, + GetTagValuesCommand, + StartReportCreationCommand, + TagResourcesCommand, + UntagResourcesCommand, +}; + +export interface ResourceGroupsTaggingAPI { /** - * @public - *

Describes the status of the StartReportCreation operation.

- *

You can call this operation only from the organization's - * management account and from the us-east-1 Region.

+ * @see {@link DescribeReportCreationCommand} */ - public describeReportCreation( + describeReportCreation( args: DescribeReportCreationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReportCreation( + describeReportCreation( args: DescribeReportCreationCommandInput, cb: (err: any, data?: DescribeReportCreationCommandOutput) => void ): void; - public describeReportCreation( + describeReportCreation( args: DescribeReportCreationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReportCreationCommandOutput) => void ): void; - public describeReportCreation( - args: DescribeReportCreationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReportCreationCommandOutput) => void), - cb?: (err: any, data?: DescribeReportCreationCommandOutput) => void - ): Promise | void { - const command = new DescribeReportCreationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a table that shows counts of resources that are noncompliant with their tag - * policies.

- *

For more information on tag policies, see Tag Policies in - * the Organizations User Guide. - *

- *

You can call this operation only from the organization's - * management account and from the us-east-1 Region.

- *

This operation supports pagination, where the response can be sent in - * multiple pages. You should check the PaginationToken response parameter to determine - * if there are additional results available to return. Repeat the query, passing the - * PaginationToken response parameter value as an input to the next request until you - * recieve a null value. A null value for PaginationToken indicates that - * there are no more results waiting to be returned.

+ * @see {@link GetComplianceSummaryCommand} */ - public getComplianceSummary( + getComplianceSummary( args: GetComplianceSummaryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getComplianceSummary( + getComplianceSummary( args: GetComplianceSummaryCommandInput, cb: (err: any, data?: GetComplianceSummaryCommandOutput) => void ): void; - public getComplianceSummary( + getComplianceSummary( args: GetComplianceSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComplianceSummaryCommandOutput) => void ): void; - public getComplianceSummary( - args: GetComplianceSummaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetComplianceSummaryCommandOutput) => void), - cb?: (err: any, data?: GetComplianceSummaryCommandOutput) => void - ): Promise | void { - const command = new GetComplianceSummaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns all the tagged or previously tagged resources that are located in the - * specified Amazon Web Services Region for the account.

- *

Depending on what information you want returned, you can also specify the - * following:

- *
    - *
  • - *

    - * Filters that specify what tags and resource types you - * want returned. The response includes all tags that are associated with the - * requested resources.

    - *
  • - *
  • - *

    Information about compliance with the account's effective tag policy. For more - * information on tag policies, see Tag - * Policies in the Organizations User Guide. - *

    - *
  • - *
- *

This operation supports pagination, where the response can be sent in - * multiple pages. You should check the PaginationToken response parameter to determine - * if there are additional results available to return. Repeat the query, passing the - * PaginationToken response parameter value as an input to the next request until you - * recieve a null value. A null value for PaginationToken indicates that - * there are no more results waiting to be returned.

+ * @see {@link GetResourcesCommand} */ - public getResources( - args: GetResourcesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getResources(args: GetResourcesCommandInput, cb: (err: any, data?: GetResourcesCommandOutput) => void): void; - public getResources( + getResources(args: GetResourcesCommandInput, options?: __HttpHandlerOptions): Promise; + getResources(args: GetResourcesCommandInput, cb: (err: any, data?: GetResourcesCommandOutput) => void): void; + getResources( args: GetResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcesCommandOutput) => void ): void; - public getResources( - args: GetResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourcesCommandOutput) => void), - cb?: (err: any, data?: GetResourcesCommandOutput) => void - ): Promise | void { - const command = new GetResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns all tag keys currently in use in the specified Amazon Web Services Region for the calling - * account.

- *

This operation supports pagination, where the response can be sent in - * multiple pages. You should check the PaginationToken response parameter to determine - * if there are additional results available to return. Repeat the query, passing the - * PaginationToken response parameter value as an input to the next request until you - * recieve a null value. A null value for PaginationToken indicates that - * there are no more results waiting to be returned.

+ * @see {@link GetTagKeysCommand} */ - public getTagKeys(args: GetTagKeysCommandInput, options?: __HttpHandlerOptions): Promise; - public getTagKeys(args: GetTagKeysCommandInput, cb: (err: any, data?: GetTagKeysCommandOutput) => void): void; - public getTagKeys( + getTagKeys(args: GetTagKeysCommandInput, options?: __HttpHandlerOptions): Promise; + getTagKeys(args: GetTagKeysCommandInput, cb: (err: any, data?: GetTagKeysCommandOutput) => void): void; + getTagKeys( args: GetTagKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTagKeysCommandOutput) => void ): void; - public getTagKeys( - args: GetTagKeysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTagKeysCommandOutput) => void), - cb?: (err: any, data?: GetTagKeysCommandOutput) => void - ): Promise | void { - const command = new GetTagKeysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns all tag values for the specified key that are used in the specified Amazon Web Services - * Region for the calling account.

- *

This operation supports pagination, where the response can be sent in - * multiple pages. You should check the PaginationToken response parameter to determine - * if there are additional results available to return. Repeat the query, passing the - * PaginationToken response parameter value as an input to the next request until you - * recieve a null value. A null value for PaginationToken indicates that - * there are no more results waiting to be returned.

+ * @see {@link GetTagValuesCommand} */ - public getTagValues( - args: GetTagValuesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getTagValues(args: GetTagValuesCommandInput, cb: (err: any, data?: GetTagValuesCommandOutput) => void): void; - public getTagValues( + getTagValues(args: GetTagValuesCommandInput, options?: __HttpHandlerOptions): Promise; + getTagValues(args: GetTagValuesCommandInput, cb: (err: any, data?: GetTagValuesCommandOutput) => void): void; + getTagValues( args: GetTagValuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTagValuesCommandOutput) => void ): void; - public getTagValues( - args: GetTagValuesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTagValuesCommandOutput) => void), - cb?: (err: any, data?: GetTagValuesCommandOutput) => void - ): Promise | void { - const command = new GetTagValuesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Generates a report that lists all tagged resources in the accounts across your - * organization and tells whether each resource is compliant with the effective tag policy. - * Compliance data is refreshed daily. The report is generated asynchronously.

- *

The generated report is saved to the following location:

- *

- * s3://example-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv - *

- *

You can call this operation only from the organization's - * management account and from the us-east-1 Region.

+ * @see {@link StartReportCreationCommand} */ - public startReportCreation( + startReportCreation( args: StartReportCreationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startReportCreation( + startReportCreation( args: StartReportCreationCommandInput, cb: (err: any, data?: StartReportCreationCommandOutput) => void ): void; - public startReportCreation( + startReportCreation( args: StartReportCreationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartReportCreationCommandOutput) => void ): void; - public startReportCreation( - args: StartReportCreationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartReportCreationCommandOutput) => void), - cb?: (err: any, data?: StartReportCreationCommandOutput) => void - ): Promise | void { - const command = new StartReportCreationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Applies one or more tags to the specified resources. Note the following:

- *
    - *
  • - *

    Not all resources can have tags. For a list of services with resources that - * support tagging using this operation, see Services that support the - * Resource Groups Tagging API. If the resource doesn't yet support - * this operation, the resource's service might support tagging using its own API - * operations. For more information, refer to the documentation for that - * service.

    - *
  • - *
  • - *

    Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in the Amazon Web Services General - * Reference. - *

    - *
  • - *
  • - *

    You can only tag resources that are located in the specified Amazon Web Services Region for - * the Amazon Web Services account.

    - *
  • - *
  • - *

    To add tags to a resource, you need the necessary permissions for the service - * that the resource belongs to as well as permissions for adding tags. For more - * information, see the documentation for each service.

    - *
  • - *
- * - *

Do not store personally identifiable information (PII) or other confidential or - * sensitive information in tags. We use tags to provide you with billing and - * administration services. Tags are not intended to be used for private or sensitive - * data.

- *
- *

- * Minimum permissions - *

- *

In addition to the tag:TagResources permission required by this - * operation, you must also have the tagging permission defined by the service that created - * the resource. For example, to tag an Amazon EC2 instance using the TagResources - * operation, you must have both of the following permissions:

- *
    - *
  • - *

    - * tag:TagResource - *

    - *
  • - *
  • - *

    - * ec2:CreateTags - *

    - *
  • - *
+ * @see {@link TagResourcesCommand} */ - public tagResources( - args: TagResourcesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public tagResources(args: TagResourcesCommandInput, cb: (err: any, data?: TagResourcesCommandOutput) => void): void; - public tagResources( + tagResources(args: TagResourcesCommandInput, options?: __HttpHandlerOptions): Promise; + tagResources(args: TagResourcesCommandInput, cb: (err: any, data?: TagResourcesCommandOutput) => void): void; + tagResources( args: TagResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourcesCommandOutput) => void ): void; - public tagResources( - args: TagResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourcesCommandOutput) => void), - cb?: (err: any, data?: TagResourcesCommandOutput) => void - ): Promise | void { - const command = new TagResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified tags from the specified resources. When you specify a tag key, - * the action removes both that key and its associated value. The operation succeeds even - * if you attempt to remove tags from a resource that were already removed. Note the - * following:

- *
    - *
  • - *

    To remove tags from a resource, you need the necessary permissions for the - * service that the resource belongs to as well as permissions for removing tags. - * For more information, see the documentation for the service whose resource you - * want to untag.

    - *
  • - *
  • - *

    You can only tag resources that are located in the specified Amazon Web Services Region for - * the calling Amazon Web Services account.

    - *
  • - *
- * - *

- * Minimum permissions - *

- *

In addition to the tag:UntagResources permission required by this - * operation, you must also have the remove tags permission defined by the service that - * created the resource. For example, to remove the tags from an Amazon EC2 instance using the - * UntagResources operation, you must have both of the following - * permissions:

- *
    - *
  • - *

    - * tag:UntagResource - *

    - *
  • - *
  • - *

    - * ec2:DeleteTags - *

    - *
  • - *
+ * @see {@link UntagResourcesCommand} */ - public untagResources( + untagResources( args: UntagResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public untagResources( - args: UntagResourcesCommandInput, - cb: (err: any, data?: UntagResourcesCommandOutput) => void - ): void; - public untagResources( + untagResources(args: UntagResourcesCommandInput, cb: (err: any, data?: UntagResourcesCommandOutput) => void): void; + untagResources( args: UntagResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourcesCommandOutput) => void ): void; - public untagResources( - args: UntagResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourcesCommandOutput) => void), - cb?: (err: any, data?: UntagResourcesCommandOutput) => void - ): Promise | void { - const command = new UntagResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Resource Groups Tagging API + */ +export class ResourceGroupsTaggingAPI extends ResourceGroupsTaggingAPIClient implements ResourceGroupsTaggingAPI {} +createAggregatedClient(commands, ResourceGroupsTaggingAPI); diff --git a/clients/client-resource-groups/src/ResourceGroups.ts b/clients/client-resource-groups/src/ResourceGroups.ts index 9c44129b9353..6d480df3afe3 100644 --- a/clients/client-resource-groups/src/ResourceGroups.ts +++ b/clients/client-resource-groups/src/ResourceGroups.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { CreateGroupCommand, CreateGroupCommandInput, CreateGroupCommandOutput } from "./commands/CreateGroupCommand"; @@ -59,843 +60,309 @@ import { UpdateGroupQueryCommandInput, UpdateGroupQueryCommandOutput, } from "./commands/UpdateGroupQueryCommand"; -import { ResourceGroupsClient } from "./ResourceGroupsClient"; +import { ResourceGroupsClient, ResourceGroupsClientConfig } from "./ResourceGroupsClient"; -/** - * @public - *

Resource Groups lets you organize Amazon Web Services resources such as Amazon Elastic Compute Cloud instances, Amazon Relational Database Service - * databases, and Amazon Simple Storage Service buckets into groups using criteria that you define as tags. A - * resource group is a collection of resources that match the resource types specified in a - * query, and share one or more tags or portions of tags. You can create a group of - * resources based on their roles in your cloud infrastructure, lifecycle stages, regions, - * application layers, or virtually any criteria. Resource Groups enable you to automate management - * tasks, such as those in Amazon Web Services Systems Manager Automation documents, on tag-related resources in - * Amazon Web Services Systems Manager. Groups of tagged resources also let you quickly view a custom console in - * Amazon Web Services Systems Manager that shows Config compliance and other monitoring data about member - * resources.

- *

To create a resource group, build a resource query, and specify tags that identify the - * criteria that members of the group have in common. Tags are key-value pairs.

- *

For more information about Resource Groups, see the Resource Groups User Guide.

- *

Resource Groups uses a REST-compliant API that you can use to perform the following types of - * operations.

- *
    - *
  • - *

    Create, Read, Update, and Delete (CRUD) operations on resource groups and - * resource query entities

    - *
  • - *
  • - *

    Applying, editing, and removing tags from resource groups

    - *
  • - *
  • - *

    Resolving resource group member ARNs so they can be returned as search - * results

    - *
  • - *
  • - *

    Getting data about resources that are members of a group

    - *
  • - *
  • - *

    Searching Amazon Web Services resources based on a resource query

    - *
  • - *
- */ -export class ResourceGroups extends ResourceGroupsClient { +const commands = { + CreateGroupCommand, + DeleteGroupCommand, + GetAccountSettingsCommand, + GetGroupCommand, + GetGroupConfigurationCommand, + GetGroupQueryCommand, + GetTagsCommand, + GroupResourcesCommand, + ListGroupResourcesCommand, + ListGroupsCommand, + PutGroupConfigurationCommand, + SearchResourcesCommand, + TagCommand, + UngroupResourcesCommand, + UntagCommand, + UpdateAccountSettingsCommand, + UpdateGroupCommand, + UpdateGroupQueryCommand, +}; + +export interface ResourceGroups { /** - * @public - *

Creates a resource group with the specified name and description. You can optionally - * include either a resource query or a service configuration. For more information about - * constructing a resource query, see Build queries and groups in - * Resource Groups in the Resource Groups User Guide. For more information - * about service-linked groups and service configurations, see Service configurations for Resource Groups.

- *

- * Minimum permissions - *

- *

To run this command, you must have the following permissions:

- *
    - *
  • - *

    - * resource-groups:CreateGroup - *

    - *
  • - *
+ * @see {@link CreateGroupCommand} */ - public createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void; - public createGroup( + createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise; + createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void; + createGroup( args: CreateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupCommandOutput) => void ): void; - public createGroup( - args: CreateGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGroupCommandOutput) => void), - cb?: (err: any, data?: CreateGroupCommandOutput) => void - ): Promise | void { - const command = new CreateGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified resource group. Deleting a resource group does not delete any - * resources that are members of the group; it only deletes the group structure.

- *

- * Minimum permissions - *

- *

To run this command, you must have the following permissions:

- *
    - *
  • - *

    - * resource-groups:DeleteGroup - *

    - *
  • - *
+ * @see {@link DeleteGroupCommand} */ - public deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void; - public deleteGroup( + deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise; + deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void; + deleteGroup( args: DeleteGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupCommandOutput) => void ): void; - public deleteGroup( - args: DeleteGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the current status of optional features in Resource Groups.

+ * @see {@link GetAccountSettingsCommand} */ - public getAccountSettings( + getAccountSettings( args: GetAccountSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccountSettings( + getAccountSettings( args: GetAccountSettingsCommandInput, cb: (err: any, data?: GetAccountSettingsCommandOutput) => void ): void; - public getAccountSettings( + getAccountSettings( args: GetAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountSettingsCommandOutput) => void ): void; - public getAccountSettings( - args: GetAccountSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccountSettingsCommandOutput) => void), - cb?: (err: any, data?: GetAccountSettingsCommandOutput) => void - ): Promise | void { - const command = new GetAccountSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a specified resource group.

- *

- * Minimum permissions - *

- *

To run this command, you must have the following permissions:

- *
    - *
  • - *

    - * resource-groups:GetGroup - *

    - *
  • - *
+ * @see {@link GetGroupCommand} */ - public getGroup(args: GetGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public getGroup(args: GetGroupCommandInput, cb: (err: any, data?: GetGroupCommandOutput) => void): void; - public getGroup( + getGroup(args: GetGroupCommandInput, options?: __HttpHandlerOptions): Promise; + getGroup(args: GetGroupCommandInput, cb: (err: any, data?: GetGroupCommandOutput) => void): void; + getGroup( args: GetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupCommandOutput) => void ): void; - public getGroup( - args: GetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGroupCommandOutput) => void), - cb?: (err: any, data?: GetGroupCommandOutput) => void - ): Promise | void { - const command = new GetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the service configuration associated with the specified resource group. For - * details about the service configuration syntax, see Service configurations for Resource Groups.

- *

- * Minimum permissions - *

- *

To run this command, you must have the following permissions:

- *
    - *
  • - *

    - * resource-groups:GetGroupConfiguration - *

    - *
  • - *
+ * @see {@link GetGroupConfigurationCommand} */ - public getGroupConfiguration( + getGroupConfiguration( args: GetGroupConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getGroupConfiguration( + getGroupConfiguration( args: GetGroupConfigurationCommandInput, cb: (err: any, data?: GetGroupConfigurationCommandOutput) => void ): void; - public getGroupConfiguration( + getGroupConfiguration( args: GetGroupConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupConfigurationCommandOutput) => void ): void; - public getGroupConfiguration( - args: GetGroupConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGroupConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetGroupConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetGroupConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the resource query associated with the specified resource group. For more - * information about resource queries, see Create - * a tag-based group in Resource Groups.

- *

- * Minimum permissions - *

- *

To run this command, you must have the following permissions:

- *
    - *
  • - *

    - * resource-groups:GetGroupQuery - *

    - *
  • - *
+ * @see {@link GetGroupQueryCommand} */ - public getGroupQuery( - args: GetGroupQueryCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getGroupQuery( - args: GetGroupQueryCommandInput, - cb: (err: any, data?: GetGroupQueryCommandOutput) => void - ): void; - public getGroupQuery( + getGroupQuery(args: GetGroupQueryCommandInput, options?: __HttpHandlerOptions): Promise; + getGroupQuery(args: GetGroupQueryCommandInput, cb: (err: any, data?: GetGroupQueryCommandOutput) => void): void; + getGroupQuery( args: GetGroupQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupQueryCommandOutput) => void ): void; - public getGroupQuery( - args: GetGroupQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGroupQueryCommandOutput) => void), - cb?: (err: any, data?: GetGroupQueryCommandOutput) => void - ): Promise | void { - const command = new GetGroupQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of tags that are associated with a resource group, specified by an - * ARN.

- *

- * Minimum permissions - *

- *

To run this command, you must have the following permissions:

- *
    - *
  • - *

    - * resource-groups:GetTags - *

    - *
  • - *
+ * @see {@link GetTagsCommand} */ - public getTags(args: GetTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public getTags(args: GetTagsCommandInput, cb: (err: any, data?: GetTagsCommandOutput) => void): void; - public getTags( + getTags(args: GetTagsCommandInput, options?: __HttpHandlerOptions): Promise; + getTags(args: GetTagsCommandInput, cb: (err: any, data?: GetTagsCommandOutput) => void): void; + getTags( args: GetTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTagsCommandOutput) => void ): void; - public getTags( - args: GetTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTagsCommandOutput) => void), - cb?: (err: any, data?: GetTagsCommandOutput) => void - ): Promise | void { - const command = new GetTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds the specified resources to the specified group.

- * - *

You can use this operation with only resource groups that are configured with the - * following types:

- *
    - *
  • - *

    - * AWS::EC2::HostManagement - *

    - *
  • - *
  • - *

    - * AWS::EC2::CapacityReservationPool - *

    - *
  • - *
- *

Other resource group type and resource types aren't currently supported by this - * operation.

- *
- *

- * Minimum permissions - *

- *

To run this command, you must have the following permissions:

- *
    - *
  • - *

    - * resource-groups:GroupResources - *

    - *
  • - *
+ * @see {@link GroupResourcesCommand} */ - public groupResources( + groupResources( args: GroupResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public groupResources( - args: GroupResourcesCommandInput, - cb: (err: any, data?: GroupResourcesCommandOutput) => void - ): void; - public groupResources( + groupResources(args: GroupResourcesCommandInput, cb: (err: any, data?: GroupResourcesCommandOutput) => void): void; + groupResources( args: GroupResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GroupResourcesCommandOutput) => void ): void; - public groupResources( - args: GroupResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GroupResourcesCommandOutput) => void), - cb?: (err: any, data?: GroupResourcesCommandOutput) => void - ): Promise | void { - const command = new GroupResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of ARNs of the resources that are members of a specified resource - * group.

- *

- * Minimum permissions - *

- *

To run this command, you must have the following permissions:

- *
    - *
  • - *

    - * resource-groups:ListGroupResources - *

    - *
  • - *
  • - *

    - * cloudformation:DescribeStacks - *

    - *
  • - *
  • - *

    - * cloudformation:ListStackResources - *

    - *
  • - *
  • - *

    - * tag:GetResources - *

    - *
  • - *
+ * @see {@link ListGroupResourcesCommand} */ - public listGroupResources( + listGroupResources( args: ListGroupResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGroupResources( + listGroupResources( args: ListGroupResourcesCommandInput, cb: (err: any, data?: ListGroupResourcesCommandOutput) => void ): void; - public listGroupResources( + listGroupResources( args: ListGroupResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupResourcesCommandOutput) => void ): void; - public listGroupResources( - args: ListGroupResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGroupResourcesCommandOutput) => void), - cb?: (err: any, data?: ListGroupResourcesCommandOutput) => void - ): Promise | void { - const command = new ListGroupResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of existing Resource Groups in your account.

- *

- * Minimum permissions - *

- *

To run this command, you must have the following permissions:

- *
    - *
  • - *

    - * resource-groups:ListGroups - *

    - *
  • - *
+ * @see {@link ListGroupsCommand} */ - public listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise; - public listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void; - public listGroups( + listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise; + listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void; + listGroups( args: ListGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsCommandOutput) => void ): void; - public listGroups( - args: ListGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGroupsCommandOutput) => void), - cb?: (err: any, data?: ListGroupsCommandOutput) => void - ): Promise | void { - const command = new ListGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Attaches a service configuration to the specified group. This occurs asynchronously, - * and can take time to complete. You can use GetGroupConfiguration to - * check the status of the update.

- *

- * Minimum permissions - *

- *

To run this command, you must have the following permissions:

- *
    - *
  • - *

    - * resource-groups:PutGroupConfiguration - *

    - *
  • - *
+ * @see {@link PutGroupConfigurationCommand} */ - public putGroupConfiguration( + putGroupConfiguration( args: PutGroupConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putGroupConfiguration( + putGroupConfiguration( args: PutGroupConfigurationCommandInput, cb: (err: any, data?: PutGroupConfigurationCommandOutput) => void ): void; - public putGroupConfiguration( + putGroupConfiguration( args: PutGroupConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutGroupConfigurationCommandOutput) => void ): void; - public putGroupConfiguration( - args: PutGroupConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutGroupConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutGroupConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutGroupConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of Amazon Web Services resource identifiers that matches the specified query. The - * query uses the same format as a resource query in a CreateGroup or - * UpdateGroupQuery operation.

- *

- * Minimum permissions - *

- *

To run this command, you must have the following permissions:

- *
    - *
  • - *

    - * resource-groups:SearchResources - *

    - *
  • - *
  • - *

    - * cloudformation:DescribeStacks - *

    - *
  • - *
  • - *

    - * cloudformation:ListStackResources - *

    - *
  • - *
  • - *

    - * tag:GetResources - *

    - *
  • - *
+ * @see {@link SearchResourcesCommand} */ - public searchResources( + searchResources( args: SearchResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchResources( - args: SearchResourcesCommandInput, - cb: (err: any, data?: SearchResourcesCommandOutput) => void - ): void; - public searchResources( + searchResources(args: SearchResourcesCommandInput, cb: (err: any, data?: SearchResourcesCommandOutput) => void): void; + searchResources( args: SearchResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchResourcesCommandOutput) => void ): void; - public searchResources( - args: SearchResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchResourcesCommandOutput) => void), - cb?: (err: any, data?: SearchResourcesCommandOutput) => void - ): Promise | void { - const command = new SearchResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds tags to a resource group with the specified ARN. Existing tags on a resource - * group are not changed if they are not specified in the request parameters.

- * - *

Do not store personally identifiable information (PII) or other confidential or - * sensitive information in tags. We use tags to provide you with billing and - * administration services. Tags are not intended to be used for private or sensitive - * data.

- *
- *

- * Minimum permissions - *

- *

To run this command, you must have the following permissions:

- *
    - *
  • - *

    - * resource-groups:Tag - *

    - *
  • - *
+ * @see {@link TagCommand} */ - public tag(args: TagCommandInput, options?: __HttpHandlerOptions): Promise; - public tag(args: TagCommandInput, cb: (err: any, data?: TagCommandOutput) => void): void; - public tag( - args: TagCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: TagCommandOutput) => void - ): void; - public tag( - args: TagCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagCommandOutput) => void), - cb?: (err: any, data?: TagCommandOutput) => void - ): Promise | void { - const command = new TagCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } + tag(args: TagCommandInput, options?: __HttpHandlerOptions): Promise; + tag(args: TagCommandInput, cb: (err: any, data?: TagCommandOutput) => void): void; + tag(args: TagCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagCommandOutput) => void): void; /** - * @public - *

Removes the specified resources from the specified group. This operation works only - * with static groups that you populated using the GroupResources - * operation. It doesn't work with any resource groups that are automatically populated by - * tag-based or CloudFormation stack-based queries.

- *

- * Minimum permissions - *

- *

To run this command, you must have the following permissions:

- *
    - *
  • - *

    - * resource-groups:UngroupResources - *

    - *
  • - *
+ * @see {@link UngroupResourcesCommand} */ - public ungroupResources( + ungroupResources( args: UngroupResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public ungroupResources( + ungroupResources( args: UngroupResourcesCommandInput, cb: (err: any, data?: UngroupResourcesCommandOutput) => void ): void; - public ungroupResources( + ungroupResources( args: UngroupResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UngroupResourcesCommandOutput) => void ): void; - public ungroupResources( - args: UngroupResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UngroupResourcesCommandOutput) => void), - cb?: (err: any, data?: UngroupResourcesCommandOutput) => void - ): Promise | void { - const command = new UngroupResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes tags from a specified resource group.

- *

- * Minimum permissions - *

- *

To run this command, you must have the following permissions:

- *
    - *
  • - *

    - * resource-groups:Untag - *

    - *
  • - *
+ * @see {@link UntagCommand} */ - public untag(args: UntagCommandInput, options?: __HttpHandlerOptions): Promise; - public untag(args: UntagCommandInput, cb: (err: any, data?: UntagCommandOutput) => void): void; - public untag( + untag(args: UntagCommandInput, options?: __HttpHandlerOptions): Promise; + untag(args: UntagCommandInput, cb: (err: any, data?: UntagCommandOutput) => void): void; + untag( args: UntagCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagCommandOutput) => void ): void; - public untag( - args: UntagCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagCommandOutput) => void), - cb?: (err: any, data?: UntagCommandOutput) => void - ): Promise | void { - const command = new UntagCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Turns on or turns off optional features in Resource Groups.

- *

The preceding example shows that the request to turn on group lifecycle events is - * IN_PROGRESS. You can call the GetAccountSettings - * operation to check for completion by looking for GroupLifecycleEventsStatus - * to change to ACTIVE.

+ * @see {@link UpdateAccountSettingsCommand} */ - public updateAccountSettings( + updateAccountSettings( args: UpdateAccountSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAccountSettings( + updateAccountSettings( args: UpdateAccountSettingsCommandInput, cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void ): void; - public updateAccountSettings( + updateAccountSettings( args: UpdateAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void ): void; - public updateAccountSettings( - args: UpdateAccountSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAccountSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateAccountSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateAccountSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the description for an existing group. You cannot update the name of a - * resource group.

- *

- * Minimum permissions - *

- *

To run this command, you must have the following permissions:

- *
    - *
  • - *

    - * resource-groups:UpdateGroup - *

    - *
  • - *
+ * @see {@link UpdateGroupCommand} */ - public updateGroup(args: UpdateGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void; - public updateGroup( + updateGroup(args: UpdateGroupCommandInput, options?: __HttpHandlerOptions): Promise; + updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void; + updateGroup( args: UpdateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGroupCommandOutput) => void ): void; - public updateGroup( - args: UpdateGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the resource query of a group. For more information about resource queries, - * see Create a tag-based group in Resource Groups.

- *

- * Minimum permissions - *

- *

To run this command, you must have the following permissions:

- *
    - *
  • - *

    - * resource-groups:UpdateGroupQuery - *

    - *
  • - *
+ * @see {@link UpdateGroupQueryCommand} */ - public updateGroupQuery( + updateGroupQuery( args: UpdateGroupQueryCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGroupQuery( + updateGroupQuery( args: UpdateGroupQueryCommandInput, cb: (err: any, data?: UpdateGroupQueryCommandOutput) => void ): void; - public updateGroupQuery( + updateGroupQuery( args: UpdateGroupQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGroupQueryCommandOutput) => void ): void; - public updateGroupQuery( - args: UpdateGroupQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGroupQueryCommandOutput) => void), - cb?: (err: any, data?: UpdateGroupQueryCommandOutput) => void - ): Promise | void { - const command = new UpdateGroupQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Resource Groups lets you organize Amazon Web Services resources such as Amazon Elastic Compute Cloud instances, Amazon Relational Database Service + * databases, and Amazon Simple Storage Service buckets into groups using criteria that you define as tags. A + * resource group is a collection of resources that match the resource types specified in a + * query, and share one or more tags or portions of tags. You can create a group of + * resources based on their roles in your cloud infrastructure, lifecycle stages, regions, + * application layers, or virtually any criteria. Resource Groups enable you to automate management + * tasks, such as those in Amazon Web Services Systems Manager Automation documents, on tag-related resources in + * Amazon Web Services Systems Manager. Groups of tagged resources also let you quickly view a custom console in + * Amazon Web Services Systems Manager that shows Config compliance and other monitoring data about member + * resources.

+ *

To create a resource group, build a resource query, and specify tags that identify the + * criteria that members of the group have in common. Tags are key-value pairs.

+ *

For more information about Resource Groups, see the Resource Groups User Guide.

+ *

Resource Groups uses a REST-compliant API that you can use to perform the following types of + * operations.

+ *
    + *
  • + *

    Create, Read, Update, and Delete (CRUD) operations on resource groups and + * resource query entities

    + *
  • + *
  • + *

    Applying, editing, and removing tags from resource groups

    + *
  • + *
  • + *

    Resolving resource group member ARNs so they can be returned as search + * results

    + *
  • + *
  • + *

    Getting data about resources that are members of a group

    + *
  • + *
  • + *

    Searching Amazon Web Services resources based on a resource query

    + *
  • + *
+ */ +export class ResourceGroups extends ResourceGroupsClient implements ResourceGroups {} +createAggregatedClient(commands, ResourceGroups); diff --git a/clients/client-robomaker/src/RoboMaker.ts b/clients/client-robomaker/src/RoboMaker.ts index 33d463818d1b..0fee7cf7241f 100644 --- a/clients/client-robomaker/src/RoboMaker.ts +++ b/clients/client-robomaker/src/RoboMaker.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -254,1943 +255,961 @@ import { UpdateWorldTemplateCommandInput, UpdateWorldTemplateCommandOutput, } from "./commands/UpdateWorldTemplateCommand"; -import { RoboMakerClient } from "./RoboMakerClient"; +import { RoboMakerClient, RoboMakerClientConfig } from "./RoboMakerClient"; -/** - * @public - *

This section provides documentation for the AWS RoboMaker API operations.

- */ -export class RoboMaker extends RoboMakerClient { +const commands = { + BatchDeleteWorldsCommand, + BatchDescribeSimulationJobCommand, + CancelDeploymentJobCommand, + CancelSimulationJobCommand, + CancelSimulationJobBatchCommand, + CancelWorldExportJobCommand, + CancelWorldGenerationJobCommand, + CreateDeploymentJobCommand, + CreateFleetCommand, + CreateRobotCommand, + CreateRobotApplicationCommand, + CreateRobotApplicationVersionCommand, + CreateSimulationApplicationCommand, + CreateSimulationApplicationVersionCommand, + CreateSimulationJobCommand, + CreateWorldExportJobCommand, + CreateWorldGenerationJobCommand, + CreateWorldTemplateCommand, + DeleteFleetCommand, + DeleteRobotCommand, + DeleteRobotApplicationCommand, + DeleteSimulationApplicationCommand, + DeleteWorldTemplateCommand, + DeregisterRobotCommand, + DescribeDeploymentJobCommand, + DescribeFleetCommand, + DescribeRobotCommand, + DescribeRobotApplicationCommand, + DescribeSimulationApplicationCommand, + DescribeSimulationJobCommand, + DescribeSimulationJobBatchCommand, + DescribeWorldCommand, + DescribeWorldExportJobCommand, + DescribeWorldGenerationJobCommand, + DescribeWorldTemplateCommand, + GetWorldTemplateBodyCommand, + ListDeploymentJobsCommand, + ListFleetsCommand, + ListRobotApplicationsCommand, + ListRobotsCommand, + ListSimulationApplicationsCommand, + ListSimulationJobBatchesCommand, + ListSimulationJobsCommand, + ListTagsForResourceCommand, + ListWorldExportJobsCommand, + ListWorldGenerationJobsCommand, + ListWorldsCommand, + ListWorldTemplatesCommand, + RegisterRobotCommand, + RestartSimulationJobCommand, + StartSimulationJobBatchCommand, + SyncDeploymentJobCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateRobotApplicationCommand, + UpdateSimulationApplicationCommand, + UpdateWorldTemplateCommand, +}; + +export interface RoboMaker { /** - * @public - *

Deletes one or more worlds in a batch operation.

+ * @see {@link BatchDeleteWorldsCommand} */ - public batchDeleteWorlds( + batchDeleteWorlds( args: BatchDeleteWorldsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeleteWorlds( + batchDeleteWorlds( args: BatchDeleteWorldsCommandInput, cb: (err: any, data?: BatchDeleteWorldsCommandOutput) => void ): void; - public batchDeleteWorlds( + batchDeleteWorlds( args: BatchDeleteWorldsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteWorldsCommandOutput) => void ): void; - public batchDeleteWorlds( - args: BatchDeleteWorldsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeleteWorldsCommandOutput) => void), - cb?: (err: any, data?: BatchDeleteWorldsCommandOutput) => void - ): Promise | void { - const command = new BatchDeleteWorldsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes one or more simulation jobs.

+ * @see {@link BatchDescribeSimulationJobCommand} */ - public batchDescribeSimulationJob( + batchDescribeSimulationJob( args: BatchDescribeSimulationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDescribeSimulationJob( + batchDescribeSimulationJob( args: BatchDescribeSimulationJobCommandInput, cb: (err: any, data?: BatchDescribeSimulationJobCommandOutput) => void ): void; - public batchDescribeSimulationJob( + batchDescribeSimulationJob( args: BatchDescribeSimulationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDescribeSimulationJobCommandOutput) => void ): void; - public batchDescribeSimulationJob( - args: BatchDescribeSimulationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDescribeSimulationJobCommandOutput) => void), - cb?: (err: any, data?: BatchDescribeSimulationJobCommandOutput) => void - ): Promise | void { - const command = new BatchDescribeSimulationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Cancels the specified deployment job.

- * - *

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

- *
+ * @see {@link CancelDeploymentJobCommand} */ - public cancelDeploymentJob( + cancelDeploymentJob( args: CancelDeploymentJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelDeploymentJob( + cancelDeploymentJob( args: CancelDeploymentJobCommandInput, cb: (err: any, data?: CancelDeploymentJobCommandOutput) => void ): void; - public cancelDeploymentJob( + cancelDeploymentJob( args: CancelDeploymentJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelDeploymentJobCommandOutput) => void ): void; - public cancelDeploymentJob( - args: CancelDeploymentJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelDeploymentJobCommandOutput) => void), - cb?: (err: any, data?: CancelDeploymentJobCommandOutput) => void - ): Promise | void { - const command = new CancelDeploymentJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels the specified simulation job.

+ * @see {@link CancelSimulationJobCommand} */ - public cancelSimulationJob( + cancelSimulationJob( args: CancelSimulationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelSimulationJob( + cancelSimulationJob( args: CancelSimulationJobCommandInput, cb: (err: any, data?: CancelSimulationJobCommandOutput) => void ): void; - public cancelSimulationJob( + cancelSimulationJob( args: CancelSimulationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelSimulationJobCommandOutput) => void ): void; - public cancelSimulationJob( - args: CancelSimulationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelSimulationJobCommandOutput) => void), - cb?: (err: any, data?: CancelSimulationJobCommandOutput) => void - ): Promise | void { - const command = new CancelSimulationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels a simulation job batch. When you cancel a simulation job batch, you are also - * cancelling all of the active simulation jobs created as part of the batch.

+ * @see {@link CancelSimulationJobBatchCommand} */ - public cancelSimulationJobBatch( + cancelSimulationJobBatch( args: CancelSimulationJobBatchCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelSimulationJobBatch( + cancelSimulationJobBatch( args: CancelSimulationJobBatchCommandInput, cb: (err: any, data?: CancelSimulationJobBatchCommandOutput) => void ): void; - public cancelSimulationJobBatch( + cancelSimulationJobBatch( args: CancelSimulationJobBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelSimulationJobBatchCommandOutput) => void ): void; - public cancelSimulationJobBatch( - args: CancelSimulationJobBatchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelSimulationJobBatchCommandOutput) => void), - cb?: (err: any, data?: CancelSimulationJobBatchCommandOutput) => void - ): Promise | void { - const command = new CancelSimulationJobBatchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels the specified export job.

+ * @see {@link CancelWorldExportJobCommand} */ - public cancelWorldExportJob( + cancelWorldExportJob( args: CancelWorldExportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelWorldExportJob( + cancelWorldExportJob( args: CancelWorldExportJobCommandInput, cb: (err: any, data?: CancelWorldExportJobCommandOutput) => void ): void; - public cancelWorldExportJob( + cancelWorldExportJob( args: CancelWorldExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelWorldExportJobCommandOutput) => void ): void; - public cancelWorldExportJob( - args: CancelWorldExportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelWorldExportJobCommandOutput) => void), - cb?: (err: any, data?: CancelWorldExportJobCommandOutput) => void - ): Promise | void { - const command = new CancelWorldExportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels the specified world generator job.

+ * @see {@link CancelWorldGenerationJobCommand} */ - public cancelWorldGenerationJob( + cancelWorldGenerationJob( args: CancelWorldGenerationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelWorldGenerationJob( + cancelWorldGenerationJob( args: CancelWorldGenerationJobCommandInput, cb: (err: any, data?: CancelWorldGenerationJobCommandOutput) => void ): void; - public cancelWorldGenerationJob( + cancelWorldGenerationJob( args: CancelWorldGenerationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelWorldGenerationJobCommandOutput) => void ): void; - public cancelWorldGenerationJob( - args: CancelWorldGenerationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelWorldGenerationJobCommandOutput) => void), - cb?: (err: any, data?: CancelWorldGenerationJobCommandOutput) => void - ): Promise | void { - const command = new CancelWorldGenerationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Deploys a specific version of a robot application to robots in a fleet.

- * - *

This API is no longer supported and will throw an error if used.

- *
- *

The robot application must have a numbered applicationVersion for - * consistency reasons. To create a new version, use - * CreateRobotApplicationVersion or see Creating a Robot Application Version.

- * - *

After 90 days, deployment jobs expire and will be deleted. They will no longer be - * accessible.

- *
+ * @see {@link CreateDeploymentJobCommand} */ - public createDeploymentJob( + createDeploymentJob( args: CreateDeploymentJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDeploymentJob( + createDeploymentJob( args: CreateDeploymentJobCommandInput, cb: (err: any, data?: CreateDeploymentJobCommandOutput) => void ): void; - public createDeploymentJob( + createDeploymentJob( args: CreateDeploymentJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeploymentJobCommandOutput) => void ): void; - public createDeploymentJob( - args: CreateDeploymentJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDeploymentJobCommandOutput) => void), - cb?: (err: any, data?: CreateDeploymentJobCommandOutput) => void - ): Promise | void { - const command = new CreateDeploymentJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Creates a fleet, a logical group of robots running the same robot application.

- * - *

This API is no longer supported and will throw an error if used.

- *
+ * @see {@link CreateFleetCommand} */ - public createFleet(args: CreateFleetCommandInput, options?: __HttpHandlerOptions): Promise; - public createFleet(args: CreateFleetCommandInput, cb: (err: any, data?: CreateFleetCommandOutput) => void): void; - public createFleet( + createFleet(args: CreateFleetCommandInput, options?: __HttpHandlerOptions): Promise; + createFleet(args: CreateFleetCommandInput, cb: (err: any, data?: CreateFleetCommandOutput) => void): void; + createFleet( args: CreateFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFleetCommandOutput) => void ): void; - public createFleet( - args: CreateFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFleetCommandOutput) => void), - cb?: (err: any, data?: CreateFleetCommandOutput) => void - ): Promise | void { - const command = new CreateFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Creates a robot.

- * - *

This API is no longer supported and will throw an error if used.

- *
+ * @see {@link CreateRobotCommand} */ - public createRobot(args: CreateRobotCommandInput, options?: __HttpHandlerOptions): Promise; - public createRobot(args: CreateRobotCommandInput, cb: (err: any, data?: CreateRobotCommandOutput) => void): void; - public createRobot( + createRobot(args: CreateRobotCommandInput, options?: __HttpHandlerOptions): Promise; + createRobot(args: CreateRobotCommandInput, cb: (err: any, data?: CreateRobotCommandOutput) => void): void; + createRobot( args: CreateRobotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRobotCommandOutput) => void ): void; - public createRobot( - args: CreateRobotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRobotCommandOutput) => void), - cb?: (err: any, data?: CreateRobotCommandOutput) => void - ): Promise | void { - const command = new CreateRobotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a robot application.

+ * @see {@link CreateRobotApplicationCommand} */ - public createRobotApplication( + createRobotApplication( args: CreateRobotApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRobotApplication( + createRobotApplication( args: CreateRobotApplicationCommandInput, cb: (err: any, data?: CreateRobotApplicationCommandOutput) => void ): void; - public createRobotApplication( + createRobotApplication( args: CreateRobotApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRobotApplicationCommandOutput) => void ): void; - public createRobotApplication( - args: CreateRobotApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRobotApplicationCommandOutput) => void), - cb?: (err: any, data?: CreateRobotApplicationCommandOutput) => void - ): Promise | void { - const command = new CreateRobotApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a version of a robot application.

+ * @see {@link CreateRobotApplicationVersionCommand} */ - public createRobotApplicationVersion( + createRobotApplicationVersion( args: CreateRobotApplicationVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRobotApplicationVersion( + createRobotApplicationVersion( args: CreateRobotApplicationVersionCommandInput, cb: (err: any, data?: CreateRobotApplicationVersionCommandOutput) => void ): void; - public createRobotApplicationVersion( + createRobotApplicationVersion( args: CreateRobotApplicationVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRobotApplicationVersionCommandOutput) => void ): void; - public createRobotApplicationVersion( - args: CreateRobotApplicationVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRobotApplicationVersionCommandOutput) => void), - cb?: (err: any, data?: CreateRobotApplicationVersionCommandOutput) => void - ): Promise | void { - const command = new CreateRobotApplicationVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a simulation application.

+ * @see {@link CreateSimulationApplicationCommand} */ - public createSimulationApplication( + createSimulationApplication( args: CreateSimulationApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSimulationApplication( + createSimulationApplication( args: CreateSimulationApplicationCommandInput, cb: (err: any, data?: CreateSimulationApplicationCommandOutput) => void ): void; - public createSimulationApplication( + createSimulationApplication( args: CreateSimulationApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSimulationApplicationCommandOutput) => void ): void; - public createSimulationApplication( - args: CreateSimulationApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSimulationApplicationCommandOutput) => void), - cb?: (err: any, data?: CreateSimulationApplicationCommandOutput) => void - ): Promise | void { - const command = new CreateSimulationApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a simulation application with a specific revision id.

+ * @see {@link CreateSimulationApplicationVersionCommand} */ - public createSimulationApplicationVersion( + createSimulationApplicationVersion( args: CreateSimulationApplicationVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSimulationApplicationVersion( + createSimulationApplicationVersion( args: CreateSimulationApplicationVersionCommandInput, cb: (err: any, data?: CreateSimulationApplicationVersionCommandOutput) => void ): void; - public createSimulationApplicationVersion( + createSimulationApplicationVersion( args: CreateSimulationApplicationVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSimulationApplicationVersionCommandOutput) => void ): void; - public createSimulationApplicationVersion( - args: CreateSimulationApplicationVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSimulationApplicationVersionCommandOutput) => void), - cb?: (err: any, data?: CreateSimulationApplicationVersionCommandOutput) => void - ): Promise | void { - const command = new CreateSimulationApplicationVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a simulation job.

- * - *

After 90 days, simulation jobs expire and will be deleted. They will no longer be - * accessible.

- *
+ * @see {@link CreateSimulationJobCommand} */ - public createSimulationJob( + createSimulationJob( args: CreateSimulationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSimulationJob( + createSimulationJob( args: CreateSimulationJobCommandInput, cb: (err: any, data?: CreateSimulationJobCommandOutput) => void ): void; - public createSimulationJob( + createSimulationJob( args: CreateSimulationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSimulationJobCommandOutput) => void ): void; - public createSimulationJob( - args: CreateSimulationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSimulationJobCommandOutput) => void), - cb?: (err: any, data?: CreateSimulationJobCommandOutput) => void - ): Promise | void { - const command = new CreateSimulationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a world export job.

+ * @see {@link CreateWorldExportJobCommand} */ - public createWorldExportJob( + createWorldExportJob( args: CreateWorldExportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorldExportJob( + createWorldExportJob( args: CreateWorldExportJobCommandInput, cb: (err: any, data?: CreateWorldExportJobCommandOutput) => void ): void; - public createWorldExportJob( + createWorldExportJob( args: CreateWorldExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorldExportJobCommandOutput) => void ): void; - public createWorldExportJob( - args: CreateWorldExportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorldExportJobCommandOutput) => void), - cb?: (err: any, data?: CreateWorldExportJobCommandOutput) => void - ): Promise | void { - const command = new CreateWorldExportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates worlds using the specified template.

+ * @see {@link CreateWorldGenerationJobCommand} */ - public createWorldGenerationJob( + createWorldGenerationJob( args: CreateWorldGenerationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorldGenerationJob( + createWorldGenerationJob( args: CreateWorldGenerationJobCommandInput, cb: (err: any, data?: CreateWorldGenerationJobCommandOutput) => void ): void; - public createWorldGenerationJob( + createWorldGenerationJob( args: CreateWorldGenerationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorldGenerationJobCommandOutput) => void ): void; - public createWorldGenerationJob( - args: CreateWorldGenerationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorldGenerationJobCommandOutput) => void), - cb?: (err: any, data?: CreateWorldGenerationJobCommandOutput) => void - ): Promise | void { - const command = new CreateWorldGenerationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a world template.

+ * @see {@link CreateWorldTemplateCommand} */ - public createWorldTemplate( + createWorldTemplate( args: CreateWorldTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorldTemplate( + createWorldTemplate( args: CreateWorldTemplateCommandInput, cb: (err: any, data?: CreateWorldTemplateCommandOutput) => void ): void; - public createWorldTemplate( + createWorldTemplate( args: CreateWorldTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorldTemplateCommandOutput) => void ): void; - public createWorldTemplate( - args: CreateWorldTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorldTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateWorldTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateWorldTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Deletes a fleet.

- * - *

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

- *
+ * @see {@link DeleteFleetCommand} */ - public deleteFleet(args: DeleteFleetCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteFleet(args: DeleteFleetCommandInput, cb: (err: any, data?: DeleteFleetCommandOutput) => void): void; - public deleteFleet( + deleteFleet(args: DeleteFleetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteFleet(args: DeleteFleetCommandInput, cb: (err: any, data?: DeleteFleetCommandOutput) => void): void; + deleteFleet( args: DeleteFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFleetCommandOutput) => void ): void; - public deleteFleet( - args: DeleteFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFleetCommandOutput) => void), - cb?: (err: any, data?: DeleteFleetCommandOutput) => void - ): Promise | void { - const command = new DeleteFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Deletes a robot.

- * - *

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

- *
+ * @see {@link DeleteRobotCommand} */ - public deleteRobot(args: DeleteRobotCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteRobot(args: DeleteRobotCommandInput, cb: (err: any, data?: DeleteRobotCommandOutput) => void): void; - public deleteRobot( + deleteRobot(args: DeleteRobotCommandInput, options?: __HttpHandlerOptions): Promise; + deleteRobot(args: DeleteRobotCommandInput, cb: (err: any, data?: DeleteRobotCommandOutput) => void): void; + deleteRobot( args: DeleteRobotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRobotCommandOutput) => void ): void; - public deleteRobot( - args: DeleteRobotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRobotCommandOutput) => void), - cb?: (err: any, data?: DeleteRobotCommandOutput) => void - ): Promise | void { - const command = new DeleteRobotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a robot application.

+ * @see {@link DeleteRobotApplicationCommand} */ - public deleteRobotApplication( + deleteRobotApplication( args: DeleteRobotApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRobotApplication( + deleteRobotApplication( args: DeleteRobotApplicationCommandInput, cb: (err: any, data?: DeleteRobotApplicationCommandOutput) => void ): void; - public deleteRobotApplication( + deleteRobotApplication( args: DeleteRobotApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRobotApplicationCommandOutput) => void ): void; - public deleteRobotApplication( - args: DeleteRobotApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRobotApplicationCommandOutput) => void), - cb?: (err: any, data?: DeleteRobotApplicationCommandOutput) => void - ): Promise | void { - const command = new DeleteRobotApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a simulation application.

+ * @see {@link DeleteSimulationApplicationCommand} */ - public deleteSimulationApplication( + deleteSimulationApplication( args: DeleteSimulationApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSimulationApplication( + deleteSimulationApplication( args: DeleteSimulationApplicationCommandInput, cb: (err: any, data?: DeleteSimulationApplicationCommandOutput) => void ): void; - public deleteSimulationApplication( + deleteSimulationApplication( args: DeleteSimulationApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSimulationApplicationCommandOutput) => void ): void; - public deleteSimulationApplication( - args: DeleteSimulationApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSimulationApplicationCommandOutput) => void), - cb?: (err: any, data?: DeleteSimulationApplicationCommandOutput) => void - ): Promise | void { - const command = new DeleteSimulationApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a world template.

+ * @see {@link DeleteWorldTemplateCommand} */ - public deleteWorldTemplate( + deleteWorldTemplate( args: DeleteWorldTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWorldTemplate( + deleteWorldTemplate( args: DeleteWorldTemplateCommandInput, cb: (err: any, data?: DeleteWorldTemplateCommandOutput) => void ): void; - public deleteWorldTemplate( + deleteWorldTemplate( args: DeleteWorldTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorldTemplateCommandOutput) => void ): void; - public deleteWorldTemplate( - args: DeleteWorldTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorldTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteWorldTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteWorldTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Deregisters a robot.

- * - *

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

- *
+ * @see {@link DeregisterRobotCommand} */ - public deregisterRobot( + deregisterRobot( args: DeregisterRobotCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterRobot( - args: DeregisterRobotCommandInput, - cb: (err: any, data?: DeregisterRobotCommandOutput) => void - ): void; - public deregisterRobot( + deregisterRobot(args: DeregisterRobotCommandInput, cb: (err: any, data?: DeregisterRobotCommandOutput) => void): void; + deregisterRobot( args: DeregisterRobotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterRobotCommandOutput) => void ): void; - public deregisterRobot( - args: DeregisterRobotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterRobotCommandOutput) => void), - cb?: (err: any, data?: DeregisterRobotCommandOutput) => void - ): Promise | void { - const command = new DeregisterRobotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Describes a deployment job.

- * - *

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

- *
+ * @see {@link DescribeDeploymentJobCommand} */ - public describeDeploymentJob( + describeDeploymentJob( args: DescribeDeploymentJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDeploymentJob( + describeDeploymentJob( args: DescribeDeploymentJobCommandInput, cb: (err: any, data?: DescribeDeploymentJobCommandOutput) => void ): void; - public describeDeploymentJob( + describeDeploymentJob( args: DescribeDeploymentJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDeploymentJobCommandOutput) => void ): void; - public describeDeploymentJob( - args: DescribeDeploymentJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDeploymentJobCommandOutput) => void), - cb?: (err: any, data?: DescribeDeploymentJobCommandOutput) => void - ): Promise | void { - const command = new DescribeDeploymentJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Describes a fleet.

- * - *

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

- *
+ * @see {@link DescribeFleetCommand} */ - public describeFleet( - args: DescribeFleetCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeFleet( - args: DescribeFleetCommandInput, - cb: (err: any, data?: DescribeFleetCommandOutput) => void - ): void; - public describeFleet( + describeFleet(args: DescribeFleetCommandInput, options?: __HttpHandlerOptions): Promise; + describeFleet(args: DescribeFleetCommandInput, cb: (err: any, data?: DescribeFleetCommandOutput) => void): void; + describeFleet( args: DescribeFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetCommandOutput) => void ): void; - public describeFleet( - args: DescribeFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFleetCommandOutput) => void), - cb?: (err: any, data?: DescribeFleetCommandOutput) => void - ): Promise | void { - const command = new DescribeFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Describes a robot.

- * - *

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

- *
+ * @see {@link DescribeRobotCommand} */ - public describeRobot( - args: DescribeRobotCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeRobot( - args: DescribeRobotCommandInput, - cb: (err: any, data?: DescribeRobotCommandOutput) => void - ): void; - public describeRobot( + describeRobot(args: DescribeRobotCommandInput, options?: __HttpHandlerOptions): Promise; + describeRobot(args: DescribeRobotCommandInput, cb: (err: any, data?: DescribeRobotCommandOutput) => void): void; + describeRobot( args: DescribeRobotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRobotCommandOutput) => void ): void; - public describeRobot( - args: DescribeRobotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRobotCommandOutput) => void), - cb?: (err: any, data?: DescribeRobotCommandOutput) => void - ): Promise | void { - const command = new DescribeRobotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a robot application.

+ * @see {@link DescribeRobotApplicationCommand} */ - public describeRobotApplication( + describeRobotApplication( args: DescribeRobotApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRobotApplication( + describeRobotApplication( args: DescribeRobotApplicationCommandInput, cb: (err: any, data?: DescribeRobotApplicationCommandOutput) => void ): void; - public describeRobotApplication( + describeRobotApplication( args: DescribeRobotApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRobotApplicationCommandOutput) => void ): void; - public describeRobotApplication( - args: DescribeRobotApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRobotApplicationCommandOutput) => void), - cb?: (err: any, data?: DescribeRobotApplicationCommandOutput) => void - ): Promise | void { - const command = new DescribeRobotApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a simulation application.

+ * @see {@link DescribeSimulationApplicationCommand} */ - public describeSimulationApplication( + describeSimulationApplication( args: DescribeSimulationApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSimulationApplication( + describeSimulationApplication( args: DescribeSimulationApplicationCommandInput, cb: (err: any, data?: DescribeSimulationApplicationCommandOutput) => void ): void; - public describeSimulationApplication( + describeSimulationApplication( args: DescribeSimulationApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSimulationApplicationCommandOutput) => void ): void; - public describeSimulationApplication( - args: DescribeSimulationApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSimulationApplicationCommandOutput) => void), - cb?: (err: any, data?: DescribeSimulationApplicationCommandOutput) => void - ): Promise | void { - const command = new DescribeSimulationApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a simulation job.

+ * @see {@link DescribeSimulationJobCommand} */ - public describeSimulationJob( + describeSimulationJob( args: DescribeSimulationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSimulationJob( + describeSimulationJob( args: DescribeSimulationJobCommandInput, cb: (err: any, data?: DescribeSimulationJobCommandOutput) => void ): void; - public describeSimulationJob( + describeSimulationJob( args: DescribeSimulationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSimulationJobCommandOutput) => void ): void; - public describeSimulationJob( - args: DescribeSimulationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSimulationJobCommandOutput) => void), - cb?: (err: any, data?: DescribeSimulationJobCommandOutput) => void - ): Promise | void { - const command = new DescribeSimulationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a simulation job batch.

+ * @see {@link DescribeSimulationJobBatchCommand} */ - public describeSimulationJobBatch( + describeSimulationJobBatch( args: DescribeSimulationJobBatchCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSimulationJobBatch( + describeSimulationJobBatch( args: DescribeSimulationJobBatchCommandInput, cb: (err: any, data?: DescribeSimulationJobBatchCommandOutput) => void ): void; - public describeSimulationJobBatch( + describeSimulationJobBatch( args: DescribeSimulationJobBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSimulationJobBatchCommandOutput) => void ): void; - public describeSimulationJobBatch( - args: DescribeSimulationJobBatchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSimulationJobBatchCommandOutput) => void), - cb?: (err: any, data?: DescribeSimulationJobBatchCommandOutput) => void - ): Promise | void { - const command = new DescribeSimulationJobBatchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a world.

+ * @see {@link DescribeWorldCommand} */ - public describeWorld( - args: DescribeWorldCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeWorld( - args: DescribeWorldCommandInput, - cb: (err: any, data?: DescribeWorldCommandOutput) => void - ): void; - public describeWorld( + describeWorld(args: DescribeWorldCommandInput, options?: __HttpHandlerOptions): Promise; + describeWorld(args: DescribeWorldCommandInput, cb: (err: any, data?: DescribeWorldCommandOutput) => void): void; + describeWorld( args: DescribeWorldCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorldCommandOutput) => void ): void; - public describeWorld( - args: DescribeWorldCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWorldCommandOutput) => void), - cb?: (err: any, data?: DescribeWorldCommandOutput) => void - ): Promise | void { - const command = new DescribeWorldCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a world export job.

+ * @see {@link DescribeWorldExportJobCommand} */ - public describeWorldExportJob( + describeWorldExportJob( args: DescribeWorldExportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWorldExportJob( + describeWorldExportJob( args: DescribeWorldExportJobCommandInput, cb: (err: any, data?: DescribeWorldExportJobCommandOutput) => void ): void; - public describeWorldExportJob( + describeWorldExportJob( args: DescribeWorldExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorldExportJobCommandOutput) => void ): void; - public describeWorldExportJob( - args: DescribeWorldExportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWorldExportJobCommandOutput) => void), - cb?: (err: any, data?: DescribeWorldExportJobCommandOutput) => void - ): Promise | void { - const command = new DescribeWorldExportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a world generation job.

+ * @see {@link DescribeWorldGenerationJobCommand} */ - public describeWorldGenerationJob( + describeWorldGenerationJob( args: DescribeWorldGenerationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWorldGenerationJob( + describeWorldGenerationJob( args: DescribeWorldGenerationJobCommandInput, cb: (err: any, data?: DescribeWorldGenerationJobCommandOutput) => void ): void; - public describeWorldGenerationJob( + describeWorldGenerationJob( args: DescribeWorldGenerationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorldGenerationJobCommandOutput) => void ): void; - public describeWorldGenerationJob( - args: DescribeWorldGenerationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWorldGenerationJobCommandOutput) => void), - cb?: (err: any, data?: DescribeWorldGenerationJobCommandOutput) => void - ): Promise | void { - const command = new DescribeWorldGenerationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a world template.

+ * @see {@link DescribeWorldTemplateCommand} */ - public describeWorldTemplate( + describeWorldTemplate( args: DescribeWorldTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWorldTemplate( + describeWorldTemplate( args: DescribeWorldTemplateCommandInput, cb: (err: any, data?: DescribeWorldTemplateCommandOutput) => void ): void; - public describeWorldTemplate( + describeWorldTemplate( args: DescribeWorldTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorldTemplateCommandOutput) => void ): void; - public describeWorldTemplate( - args: DescribeWorldTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWorldTemplateCommandOutput) => void), - cb?: (err: any, data?: DescribeWorldTemplateCommandOutput) => void - ): Promise | void { - const command = new DescribeWorldTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the world template body.

+ * @see {@link GetWorldTemplateBodyCommand} */ - public getWorldTemplateBody( + getWorldTemplateBody( args: GetWorldTemplateBodyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWorldTemplateBody( + getWorldTemplateBody( args: GetWorldTemplateBodyCommandInput, cb: (err: any, data?: GetWorldTemplateBodyCommandOutput) => void ): void; - public getWorldTemplateBody( + getWorldTemplateBody( args: GetWorldTemplateBodyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorldTemplateBodyCommandOutput) => void ): void; - public getWorldTemplateBody( - args: GetWorldTemplateBodyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorldTemplateBodyCommandOutput) => void), - cb?: (err: any, data?: GetWorldTemplateBodyCommandOutput) => void - ): Promise | void { - const command = new GetWorldTemplateBodyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.

- * - *

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

- *
+ * @see {@link ListDeploymentJobsCommand} */ - public listDeploymentJobs( + listDeploymentJobs( args: ListDeploymentJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeploymentJobs( + listDeploymentJobs( args: ListDeploymentJobsCommandInput, cb: (err: any, data?: ListDeploymentJobsCommandOutput) => void ): void; - public listDeploymentJobs( + listDeploymentJobs( args: ListDeploymentJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeploymentJobsCommandOutput) => void ): void; - public listDeploymentJobs( - args: ListDeploymentJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeploymentJobsCommandOutput) => void), - cb?: (err: any, data?: ListDeploymentJobsCommandOutput) => void - ): Promise | void { - const command = new ListDeploymentJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.

- * - *

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

- *
+ * @see {@link ListFleetsCommand} */ - public listFleets(args: ListFleetsCommandInput, options?: __HttpHandlerOptions): Promise; - public listFleets(args: ListFleetsCommandInput, cb: (err: any, data?: ListFleetsCommandOutput) => void): void; - public listFleets( + listFleets(args: ListFleetsCommandInput, options?: __HttpHandlerOptions): Promise; + listFleets(args: ListFleetsCommandInput, cb: (err: any, data?: ListFleetsCommandOutput) => void): void; + listFleets( args: ListFleetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFleetsCommandOutput) => void ): void; - public listFleets( - args: ListFleetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFleetsCommandOutput) => void), - cb?: (err: any, data?: ListFleetsCommandOutput) => void - ): Promise | void { - const command = new ListFleetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of robot application. You can optionally provide filters to retrieve - * specific robot applications.

+ * @see {@link ListRobotApplicationsCommand} */ - public listRobotApplications( + listRobotApplications( args: ListRobotApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRobotApplications( + listRobotApplications( args: ListRobotApplicationsCommandInput, cb: (err: any, data?: ListRobotApplicationsCommandOutput) => void ): void; - public listRobotApplications( + listRobotApplications( args: ListRobotApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRobotApplicationsCommandOutput) => void ): void; - public listRobotApplications( - args: ListRobotApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRobotApplicationsCommandOutput) => void), - cb?: (err: any, data?: ListRobotApplicationsCommandOutput) => void - ): Promise | void { - const command = new ListRobotApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Returns a list of robots. You can optionally provide filters to retrieve specific robots.

- * - *

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

- *
+ * @see {@link ListRobotsCommand} */ - public listRobots(args: ListRobotsCommandInput, options?: __HttpHandlerOptions): Promise; - public listRobots(args: ListRobotsCommandInput, cb: (err: any, data?: ListRobotsCommandOutput) => void): void; - public listRobots( + listRobots(args: ListRobotsCommandInput, options?: __HttpHandlerOptions): Promise; + listRobots(args: ListRobotsCommandInput, cb: (err: any, data?: ListRobotsCommandOutput) => void): void; + listRobots( args: ListRobotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRobotsCommandOutput) => void ): void; - public listRobots( - args: ListRobotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRobotsCommandOutput) => void), - cb?: (err: any, data?: ListRobotsCommandOutput) => void - ): Promise | void { - const command = new ListRobotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of simulation applications. You can optionally provide filters to - * retrieve specific simulation applications.

+ * @see {@link ListSimulationApplicationsCommand} */ - public listSimulationApplications( + listSimulationApplications( args: ListSimulationApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSimulationApplications( + listSimulationApplications( args: ListSimulationApplicationsCommandInput, cb: (err: any, data?: ListSimulationApplicationsCommandOutput) => void ): void; - public listSimulationApplications( + listSimulationApplications( args: ListSimulationApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSimulationApplicationsCommandOutput) => void ): void; - public listSimulationApplications( - args: ListSimulationApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSimulationApplicationsCommandOutput) => void), - cb?: (err: any, data?: ListSimulationApplicationsCommandOutput) => void - ): Promise | void { - const command = new ListSimulationApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list simulation job batches. You can optionally provide filters to retrieve - * specific simulation batch jobs.

+ * @see {@link ListSimulationJobBatchesCommand} */ - public listSimulationJobBatches( + listSimulationJobBatches( args: ListSimulationJobBatchesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSimulationJobBatches( + listSimulationJobBatches( args: ListSimulationJobBatchesCommandInput, cb: (err: any, data?: ListSimulationJobBatchesCommandOutput) => void ): void; - public listSimulationJobBatches( + listSimulationJobBatches( args: ListSimulationJobBatchesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSimulationJobBatchesCommandOutput) => void ): void; - public listSimulationJobBatches( - args: ListSimulationJobBatchesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSimulationJobBatchesCommandOutput) => void), - cb?: (err: any, data?: ListSimulationJobBatchesCommandOutput) => void - ): Promise | void { - const command = new ListSimulationJobBatchesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of simulation jobs. You can optionally provide filters to retrieve - * specific simulation jobs.

+ * @see {@link ListSimulationJobsCommand} */ - public listSimulationJobs( + listSimulationJobs( args: ListSimulationJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSimulationJobs( + listSimulationJobs( args: ListSimulationJobsCommandInput, cb: (err: any, data?: ListSimulationJobsCommandOutput) => void ): void; - public listSimulationJobs( + listSimulationJobs( args: ListSimulationJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSimulationJobsCommandOutput) => void ): void; - public listSimulationJobs( - args: ListSimulationJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSimulationJobsCommandOutput) => void), - cb?: (err: any, data?: ListSimulationJobsCommandOutput) => void - ): Promise | void { - const command = new ListSimulationJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all tags on a AWS RoboMaker resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists world export jobs.

+ * @see {@link ListWorldExportJobsCommand} */ - public listWorldExportJobs( + listWorldExportJobs( args: ListWorldExportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWorldExportJobs( + listWorldExportJobs( args: ListWorldExportJobsCommandInput, cb: (err: any, data?: ListWorldExportJobsCommandOutput) => void ): void; - public listWorldExportJobs( + listWorldExportJobs( args: ListWorldExportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorldExportJobsCommandOutput) => void ): void; - public listWorldExportJobs( - args: ListWorldExportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorldExportJobsCommandOutput) => void), - cb?: (err: any, data?: ListWorldExportJobsCommandOutput) => void - ): Promise | void { - const command = new ListWorldExportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists world generator jobs.

+ * @see {@link ListWorldGenerationJobsCommand} */ - public listWorldGenerationJobs( + listWorldGenerationJobs( args: ListWorldGenerationJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWorldGenerationJobs( + listWorldGenerationJobs( args: ListWorldGenerationJobsCommandInput, cb: (err: any, data?: ListWorldGenerationJobsCommandOutput) => void ): void; - public listWorldGenerationJobs( + listWorldGenerationJobs( args: ListWorldGenerationJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorldGenerationJobsCommandOutput) => void ): void; - public listWorldGenerationJobs( - args: ListWorldGenerationJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorldGenerationJobsCommandOutput) => void), - cb?: (err: any, data?: ListWorldGenerationJobsCommandOutput) => void - ): Promise | void { - const command = new ListWorldGenerationJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists worlds.

+ * @see {@link ListWorldsCommand} */ - public listWorlds(args: ListWorldsCommandInput, options?: __HttpHandlerOptions): Promise; - public listWorlds(args: ListWorldsCommandInput, cb: (err: any, data?: ListWorldsCommandOutput) => void): void; - public listWorlds( + listWorlds(args: ListWorldsCommandInput, options?: __HttpHandlerOptions): Promise; + listWorlds(args: ListWorldsCommandInput, cb: (err: any, data?: ListWorldsCommandOutput) => void): void; + listWorlds( args: ListWorldsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorldsCommandOutput) => void ): void; - public listWorlds( - args: ListWorldsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorldsCommandOutput) => void), - cb?: (err: any, data?: ListWorldsCommandOutput) => void - ): Promise | void { - const command = new ListWorldsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists world templates.

+ * @see {@link ListWorldTemplatesCommand} */ - public listWorldTemplates( + listWorldTemplates( args: ListWorldTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWorldTemplates( + listWorldTemplates( args: ListWorldTemplatesCommandInput, cb: (err: any, data?: ListWorldTemplatesCommandOutput) => void ): void; - public listWorldTemplates( + listWorldTemplates( args: ListWorldTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorldTemplatesCommandOutput) => void ): void; - public listWorldTemplates( - args: ListWorldTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorldTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListWorldTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListWorldTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Registers a robot with a fleet.

- * - *

This API is no longer supported and will throw an error if used.

- *
+ * @see {@link RegisterRobotCommand} */ - public registerRobot( - args: RegisterRobotCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public registerRobot( - args: RegisterRobotCommandInput, - cb: (err: any, data?: RegisterRobotCommandOutput) => void - ): void; - public registerRobot( + registerRobot(args: RegisterRobotCommandInput, options?: __HttpHandlerOptions): Promise; + registerRobot(args: RegisterRobotCommandInput, cb: (err: any, data?: RegisterRobotCommandOutput) => void): void; + registerRobot( args: RegisterRobotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterRobotCommandOutput) => void ): void; - public registerRobot( - args: RegisterRobotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterRobotCommandOutput) => void), - cb?: (err: any, data?: RegisterRobotCommandOutput) => void - ): Promise | void { - const command = new RegisterRobotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Restarts a running simulation job.

+ * @see {@link RestartSimulationJobCommand} */ - public restartSimulationJob( + restartSimulationJob( args: RestartSimulationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public restartSimulationJob( + restartSimulationJob( args: RestartSimulationJobCommandInput, cb: (err: any, data?: RestartSimulationJobCommandOutput) => void ): void; - public restartSimulationJob( + restartSimulationJob( args: RestartSimulationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestartSimulationJobCommandOutput) => void ): void; - public restartSimulationJob( - args: RestartSimulationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestartSimulationJobCommandOutput) => void), - cb?: (err: any, data?: RestartSimulationJobCommandOutput) => void - ): Promise | void { - const command = new RestartSimulationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a new simulation job batch. The batch is defined using one or more - * SimulationJobRequest objects.

+ * @see {@link StartSimulationJobBatchCommand} */ - public startSimulationJobBatch( + startSimulationJobBatch( args: StartSimulationJobBatchCommandInput, options?: __HttpHandlerOptions ): Promise; - public startSimulationJobBatch( + startSimulationJobBatch( args: StartSimulationJobBatchCommandInput, cb: (err: any, data?: StartSimulationJobBatchCommandOutput) => void ): void; - public startSimulationJobBatch( + startSimulationJobBatch( args: StartSimulationJobBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSimulationJobBatchCommandOutput) => void ): void; - public startSimulationJobBatch( - args: StartSimulationJobBatchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartSimulationJobBatchCommandOutput) => void), - cb?: (err: any, data?: StartSimulationJobBatchCommandOutput) => void - ): Promise | void { - const command = new StartSimulationJobBatchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.

- * - *

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

- *
+ * @see {@link SyncDeploymentJobCommand} */ - public syncDeploymentJob( + syncDeploymentJob( args: SyncDeploymentJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public syncDeploymentJob( + syncDeploymentJob( args: SyncDeploymentJobCommandInput, cb: (err: any, data?: SyncDeploymentJobCommandOutput) => void ): void; - public syncDeploymentJob( + syncDeploymentJob( args: SyncDeploymentJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SyncDeploymentJobCommandOutput) => void ): void; - public syncDeploymentJob( - args: SyncDeploymentJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SyncDeploymentJobCommandOutput) => void), - cb?: (err: any, data?: SyncDeploymentJobCommandOutput) => void - ): Promise | void { - const command = new SyncDeploymentJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or edits tags for a AWS RoboMaker resource.

- *

Each tag consists of a tag key and a tag value. Tag keys and tag values are both - * required, but tag values can be empty strings.

- *

For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management - * User Guide.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified tags from the specified AWS RoboMaker resource.

- *

To remove a tag, specify the tag key. To change the tag value of an existing tag key, - * use - * TagResource - * .

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a robot application.

+ * @see {@link UpdateRobotApplicationCommand} */ - public updateRobotApplication( + updateRobotApplication( args: UpdateRobotApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRobotApplication( + updateRobotApplication( args: UpdateRobotApplicationCommandInput, cb: (err: any, data?: UpdateRobotApplicationCommandOutput) => void ): void; - public updateRobotApplication( + updateRobotApplication( args: UpdateRobotApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRobotApplicationCommandOutput) => void ): void; - public updateRobotApplication( - args: UpdateRobotApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRobotApplicationCommandOutput) => void), - cb?: (err: any, data?: UpdateRobotApplicationCommandOutput) => void - ): Promise | void { - const command = new UpdateRobotApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a simulation application.

+ * @see {@link UpdateSimulationApplicationCommand} */ - public updateSimulationApplication( + updateSimulationApplication( args: UpdateSimulationApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSimulationApplication( + updateSimulationApplication( args: UpdateSimulationApplicationCommandInput, cb: (err: any, data?: UpdateSimulationApplicationCommandOutput) => void ): void; - public updateSimulationApplication( + updateSimulationApplication( args: UpdateSimulationApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSimulationApplicationCommandOutput) => void ): void; - public updateSimulationApplication( - args: UpdateSimulationApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSimulationApplicationCommandOutput) => void), - cb?: (err: any, data?: UpdateSimulationApplicationCommandOutput) => void - ): Promise | void { - const command = new UpdateSimulationApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a world template.

+ * @see {@link UpdateWorldTemplateCommand} */ - public updateWorldTemplate( + updateWorldTemplate( args: UpdateWorldTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWorldTemplate( + updateWorldTemplate( args: UpdateWorldTemplateCommandInput, cb: (err: any, data?: UpdateWorldTemplateCommandOutput) => void ): void; - public updateWorldTemplate( + updateWorldTemplate( args: UpdateWorldTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorldTemplateCommandOutput) => void ): void; - public updateWorldTemplate( - args: UpdateWorldTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWorldTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateWorldTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateWorldTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

This section provides documentation for the AWS RoboMaker API operations.

+ */ +export class RoboMaker extends RoboMakerClient implements RoboMaker {} +createAggregatedClient(commands, RoboMaker); diff --git a/clients/client-rolesanywhere/src/RolesAnywhere.ts b/clients/client-rolesanywhere/src/RolesAnywhere.ts index 5d3098d88bc0..72dc312afa67 100644 --- a/clients/client-rolesanywhere/src/RolesAnywhere.ts +++ b/clients/client-rolesanywhere/src/RolesAnywhere.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -91,909 +92,379 @@ import { UpdateTrustAnchorCommandInput, UpdateTrustAnchorCommandOutput, } from "./commands/UpdateTrustAnchorCommand"; -import { RolesAnywhereClient } from "./RolesAnywhereClient"; +import { RolesAnywhereClient, RolesAnywhereClientConfig } from "./RolesAnywhereClient"; -/** - * @public - *

AWS Identity and Access Management Roles Anywhere provides a secure way for your workloads such as servers, containers, and applications running outside of AWS to obtain Temporary AWS credentials. Your workloads can use the same IAM policies and roles that you have configured with native AWS applications to access AWS resources. Using IAM Roles Anywhere will eliminate the need to manage long term credentials for workloads running outside of AWS.

- *

To use IAM Roles Anywhere customer workloads will need to use X.509 certificates issued by their Certificate Authority (CA) . The Certificate Authority (CA) needs to be registered with IAM Roles Anywhere as a trust anchor to establish trust between customer PKI and IAM Roles Anywhere. Customers who do not manage their own PKI system can use AWS Certificate Manager Private Certificate Authority (ACM PCA) to create a Certificate Authority and use that to establish trust with IAM Roles Anywhere

- *

This guide describes the IAM rolesanywhere operations that you can call programmatically. For general information about IAM Roles Anywhere see https://docs.aws.amazon.com/ - *

- */ -export class RolesAnywhere extends RolesAnywhereClient { +const commands = { + CreateProfileCommand, + CreateTrustAnchorCommand, + DeleteCrlCommand, + DeleteProfileCommand, + DeleteTrustAnchorCommand, + DisableCrlCommand, + DisableProfileCommand, + DisableTrustAnchorCommand, + EnableCrlCommand, + EnableProfileCommand, + EnableTrustAnchorCommand, + GetCrlCommand, + GetProfileCommand, + GetSubjectCommand, + GetTrustAnchorCommand, + ImportCrlCommand, + ListCrlsCommand, + ListProfilesCommand, + ListSubjectsCommand, + ListTagsForResourceCommand, + ListTrustAnchorsCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateCrlCommand, + UpdateProfileCommand, + UpdateTrustAnchorCommand, +}; + +export interface RolesAnywhere { /** - * @public - *

Creates a profile. A profile is configuration resource to list the roles that RolesAnywhere service is trusted to assume. In addition, by applying a profile you can intersect permissions with IAM managed policies.

- *

- * Required permissions: - * rolesanywhere:CreateProfile. - *

+ * @see {@link CreateProfileCommand} */ - public createProfile( - args: CreateProfileCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createProfile( - args: CreateProfileCommandInput, - cb: (err: any, data?: CreateProfileCommandOutput) => void - ): void; - public createProfile( + createProfile(args: CreateProfileCommandInput, options?: __HttpHandlerOptions): Promise; + createProfile(args: CreateProfileCommandInput, cb: (err: any, data?: CreateProfileCommandOutput) => void): void; + createProfile( args: CreateProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProfileCommandOutput) => void ): void; - public createProfile( - args: CreateProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProfileCommandOutput) => void), - cb?: (err: any, data?: CreateProfileCommandOutput) => void - ): Promise | void { - const command = new CreateProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a trust anchor. You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. A Trust Anchor is defined either as a reference to a AWS Certificate Manager Private Certificate Authority (ACM PCA), or by uploading a Certificate Authority (CA) certificate. Your AWS workloads can authenticate with the trust anchor using certificates issued by the trusted Certificate Authority (CA) in exchange for temporary AWS credentials.

- *

- * Required permissions: - * rolesanywhere:CreateTrustAnchor. - *

+ * @see {@link CreateTrustAnchorCommand} */ - public createTrustAnchor( + createTrustAnchor( args: CreateTrustAnchorCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTrustAnchor( + createTrustAnchor( args: CreateTrustAnchorCommandInput, cb: (err: any, data?: CreateTrustAnchorCommandOutput) => void ): void; - public createTrustAnchor( + createTrustAnchor( args: CreateTrustAnchorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTrustAnchorCommandOutput) => void ): void; - public createTrustAnchor( - args: CreateTrustAnchorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTrustAnchorCommandOutput) => void), - cb?: (err: any, data?: CreateTrustAnchorCommandOutput) => void - ): Promise | void { - const command = new CreateTrustAnchorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a certificate revocation list (CRL).

- *

- * Required permissions: - * rolesanywhere:DeleteCrl. - *

+ * @see {@link DeleteCrlCommand} */ - public deleteCrl(args: DeleteCrlCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteCrl(args: DeleteCrlCommandInput, cb: (err: any, data?: DeleteCrlCommandOutput) => void): void; - public deleteCrl( + deleteCrl(args: DeleteCrlCommandInput, options?: __HttpHandlerOptions): Promise; + deleteCrl(args: DeleteCrlCommandInput, cb: (err: any, data?: DeleteCrlCommandOutput) => void): void; + deleteCrl( args: DeleteCrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCrlCommandOutput) => void ): void; - public deleteCrl( - args: DeleteCrlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCrlCommandOutput) => void), - cb?: (err: any, data?: DeleteCrlCommandOutput) => void - ): Promise | void { - const command = new DeleteCrlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a profile.

- *

- * Required permissions: - * rolesanywhere:DeleteProfile. - *

+ * @see {@link DeleteProfileCommand} */ - public deleteProfile( - args: DeleteProfileCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteProfile( - args: DeleteProfileCommandInput, - cb: (err: any, data?: DeleteProfileCommandOutput) => void - ): void; - public deleteProfile( + deleteProfile(args: DeleteProfileCommandInput, options?: __HttpHandlerOptions): Promise; + deleteProfile(args: DeleteProfileCommandInput, cb: (err: any, data?: DeleteProfileCommandOutput) => void): void; + deleteProfile( args: DeleteProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProfileCommandOutput) => void ): void; - public deleteProfile( - args: DeleteProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a trust anchor.

- *

- * Required permissions: - * rolesanywhere:DeleteTrustAnchor. - *

+ * @see {@link DeleteTrustAnchorCommand} */ - public deleteTrustAnchor( + deleteTrustAnchor( args: DeleteTrustAnchorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTrustAnchor( + deleteTrustAnchor( args: DeleteTrustAnchorCommandInput, cb: (err: any, data?: DeleteTrustAnchorCommandOutput) => void ): void; - public deleteTrustAnchor( + deleteTrustAnchor( args: DeleteTrustAnchorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTrustAnchorCommandOutput) => void ): void; - public deleteTrustAnchor( - args: DeleteTrustAnchorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTrustAnchorCommandOutput) => void), - cb?: (err: any, data?: DeleteTrustAnchorCommandOutput) => void - ): Promise | void { - const command = new DeleteTrustAnchorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables a certificate revocation list (CRL).

- *

- * Required permissions: - * rolesanywhere:DisableCrl. - *

+ * @see {@link DisableCrlCommand} */ - public disableCrl(args: DisableCrlCommandInput, options?: __HttpHandlerOptions): Promise; - public disableCrl(args: DisableCrlCommandInput, cb: (err: any, data?: DisableCrlCommandOutput) => void): void; - public disableCrl( + disableCrl(args: DisableCrlCommandInput, options?: __HttpHandlerOptions): Promise; + disableCrl(args: DisableCrlCommandInput, cb: (err: any, data?: DisableCrlCommandOutput) => void): void; + disableCrl( args: DisableCrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableCrlCommandOutput) => void ): void; - public disableCrl( - args: DisableCrlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableCrlCommandOutput) => void), - cb?: (err: any, data?: DisableCrlCommandOutput) => void - ): Promise | void { - const command = new DisableCrlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables a profile. When disabled, CreateSession requests with this profile fail.

- *

- * Required permissions: - * rolesanywhere:DisableProfile. - *

+ * @see {@link DisableProfileCommand} */ - public disableProfile( + disableProfile( args: DisableProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableProfile( - args: DisableProfileCommandInput, - cb: (err: any, data?: DisableProfileCommandOutput) => void - ): void; - public disableProfile( + disableProfile(args: DisableProfileCommandInput, cb: (err: any, data?: DisableProfileCommandOutput) => void): void; + disableProfile( args: DisableProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableProfileCommandOutput) => void ): void; - public disableProfile( - args: DisableProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableProfileCommandOutput) => void), - cb?: (err: any, data?: DisableProfileCommandOutput) => void - ): Promise | void { - const command = new DisableProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables a trust anchor. When disabled, CreateSession requests specifying this trust anchor are unauthorized.

- *

- * Required permissions: - * rolesanywhere:DisableTrustAnchor. - *

+ * @see {@link DisableTrustAnchorCommand} */ - public disableTrustAnchor( + disableTrustAnchor( args: DisableTrustAnchorCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableTrustAnchor( + disableTrustAnchor( args: DisableTrustAnchorCommandInput, cb: (err: any, data?: DisableTrustAnchorCommandOutput) => void ): void; - public disableTrustAnchor( + disableTrustAnchor( args: DisableTrustAnchorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableTrustAnchorCommandOutput) => void ): void; - public disableTrustAnchor( - args: DisableTrustAnchorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableTrustAnchorCommandOutput) => void), - cb?: (err: any, data?: DisableTrustAnchorCommandOutput) => void - ): Promise | void { - const command = new DisableTrustAnchorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables a certificate revocation list (CRL). When enabled, certificates stored in the CRL are unauthorized to receive session credentials.

- *

- * Required permissions: - * rolesanywhere:EnableCrl. - *

+ * @see {@link EnableCrlCommand} */ - public enableCrl(args: EnableCrlCommandInput, options?: __HttpHandlerOptions): Promise; - public enableCrl(args: EnableCrlCommandInput, cb: (err: any, data?: EnableCrlCommandOutput) => void): void; - public enableCrl( + enableCrl(args: EnableCrlCommandInput, options?: __HttpHandlerOptions): Promise; + enableCrl(args: EnableCrlCommandInput, cb: (err: any, data?: EnableCrlCommandOutput) => void): void; + enableCrl( args: EnableCrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableCrlCommandOutput) => void ): void; - public enableCrl( - args: EnableCrlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableCrlCommandOutput) => void), - cb?: (err: any, data?: EnableCrlCommandOutput) => void - ): Promise | void { - const command = new EnableCrlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the roles in a profile to receive session credentials in CreateSession.

- *

- * Required permissions: - * rolesanywhere:EnableProfile. - *

+ * @see {@link EnableProfileCommand} */ - public enableProfile( - args: EnableProfileCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public enableProfile( - args: EnableProfileCommandInput, - cb: (err: any, data?: EnableProfileCommandOutput) => void - ): void; - public enableProfile( + enableProfile(args: EnableProfileCommandInput, options?: __HttpHandlerOptions): Promise; + enableProfile(args: EnableProfileCommandInput, cb: (err: any, data?: EnableProfileCommandOutput) => void): void; + enableProfile( args: EnableProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableProfileCommandOutput) => void ): void; - public enableProfile( - args: EnableProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableProfileCommandOutput) => void), - cb?: (err: any, data?: EnableProfileCommandOutput) => void - ): Promise | void { - const command = new EnableProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables a trust anchor. When enabled, certificates in the trust anchor chain are authorized for trust validation.

- *

- * Required permissions: - * rolesanywhere:EnableTrustAnchor. - *

+ * @see {@link EnableTrustAnchorCommand} */ - public enableTrustAnchor( + enableTrustAnchor( args: EnableTrustAnchorCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableTrustAnchor( + enableTrustAnchor( args: EnableTrustAnchorCommandInput, cb: (err: any, data?: EnableTrustAnchorCommandOutput) => void ): void; - public enableTrustAnchor( + enableTrustAnchor( args: EnableTrustAnchorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableTrustAnchorCommandOutput) => void ): void; - public enableTrustAnchor( - args: EnableTrustAnchorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableTrustAnchorCommandOutput) => void), - cb?: (err: any, data?: EnableTrustAnchorCommandOutput) => void - ): Promise | void { - const command = new EnableTrustAnchorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a certificate revocation list (CRL).

- *

- * Required permissions: - * rolesanywhere:GetCrl. - *

+ * @see {@link GetCrlCommand} */ - public getCrl(args: GetCrlCommandInput, options?: __HttpHandlerOptions): Promise; - public getCrl(args: GetCrlCommandInput, cb: (err: any, data?: GetCrlCommandOutput) => void): void; - public getCrl( + getCrl(args: GetCrlCommandInput, options?: __HttpHandlerOptions): Promise; + getCrl(args: GetCrlCommandInput, cb: (err: any, data?: GetCrlCommandOutput) => void): void; + getCrl( args: GetCrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCrlCommandOutput) => void ): void; - public getCrl( - args: GetCrlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCrlCommandOutput) => void), - cb?: (err: any, data?: GetCrlCommandOutput) => void - ): Promise | void { - const command = new GetCrlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a profile.

- *

- * Required permissions: - * rolesanywhere:GetProfile. - *

+ * @see {@link GetProfileCommand} */ - public getProfile(args: GetProfileCommandInput, options?: __HttpHandlerOptions): Promise; - public getProfile(args: GetProfileCommandInput, cb: (err: any, data?: GetProfileCommandOutput) => void): void; - public getProfile( + getProfile(args: GetProfileCommandInput, options?: __HttpHandlerOptions): Promise; + getProfile(args: GetProfileCommandInput, cb: (err: any, data?: GetProfileCommandOutput) => void): void; + getProfile( args: GetProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProfileCommandOutput) => void ): void; - public getProfile( - args: GetProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetProfileCommandOutput) => void), - cb?: (err: any, data?: GetProfileCommandOutput) => void - ): Promise | void { - const command = new GetProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a Subject. A Subject associates a certificate identity with authentication attempts by CreateSession. The Subject resources stores audit information such as status of the last authentication attempt, the certificate data used in the attempt, and the last time the associated identity attempted authentication.

- *

- * Required permissions: - * rolesanywhere:GetSubject. - *

+ * @see {@link GetSubjectCommand} */ - public getSubject(args: GetSubjectCommandInput, options?: __HttpHandlerOptions): Promise; - public getSubject(args: GetSubjectCommandInput, cb: (err: any, data?: GetSubjectCommandOutput) => void): void; - public getSubject( + getSubject(args: GetSubjectCommandInput, options?: __HttpHandlerOptions): Promise; + getSubject(args: GetSubjectCommandInput, cb: (err: any, data?: GetSubjectCommandOutput) => void): void; + getSubject( args: GetSubjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSubjectCommandOutput) => void ): void; - public getSubject( - args: GetSubjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSubjectCommandOutput) => void), - cb?: (err: any, data?: GetSubjectCommandOutput) => void - ): Promise | void { - const command = new GetSubjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a trust anchor.

- *

- * Required permissions: - * rolesanywhere:GetTrustAnchor. - *

+ * @see {@link GetTrustAnchorCommand} */ - public getTrustAnchor( + getTrustAnchor( args: GetTrustAnchorCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTrustAnchor( - args: GetTrustAnchorCommandInput, - cb: (err: any, data?: GetTrustAnchorCommandOutput) => void - ): void; - public getTrustAnchor( + getTrustAnchor(args: GetTrustAnchorCommandInput, cb: (err: any, data?: GetTrustAnchorCommandOutput) => void): void; + getTrustAnchor( args: GetTrustAnchorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTrustAnchorCommandOutput) => void ): void; - public getTrustAnchor( - args: GetTrustAnchorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTrustAnchorCommandOutput) => void), - cb?: (err: any, data?: GetTrustAnchorCommandOutput) => void - ): Promise | void { - const command = new GetTrustAnchorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Imports the certificate revocation list (CRL). CRl is a list of certificates that have been revoked by the issuing certificate Authority (CA). IAM Roles Anywhere validates against the crl list before issuing credentials.

- *

- * Required permissions: - * rolesanywhere:ImportCrl. - *

+ * @see {@link ImportCrlCommand} */ - public importCrl(args: ImportCrlCommandInput, options?: __HttpHandlerOptions): Promise; - public importCrl(args: ImportCrlCommandInput, cb: (err: any, data?: ImportCrlCommandOutput) => void): void; - public importCrl( + importCrl(args: ImportCrlCommandInput, options?: __HttpHandlerOptions): Promise; + importCrl(args: ImportCrlCommandInput, cb: (err: any, data?: ImportCrlCommandOutput) => void): void; + importCrl( args: ImportCrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportCrlCommandOutput) => void ): void; - public importCrl( - args: ImportCrlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportCrlCommandOutput) => void), - cb?: (err: any, data?: ImportCrlCommandOutput) => void - ): Promise | void { - const command = new ImportCrlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all Crls in the authenticated account and Amazon Web Services Region.

- *

- * Required permissions: - * rolesanywhere:ListCrls. - *

+ * @see {@link ListCrlsCommand} */ - public listCrls(args: ListCrlsCommandInput, options?: __HttpHandlerOptions): Promise; - public listCrls(args: ListCrlsCommandInput, cb: (err: any, data?: ListCrlsCommandOutput) => void): void; - public listCrls( + listCrls(args: ListCrlsCommandInput, options?: __HttpHandlerOptions): Promise; + listCrls(args: ListCrlsCommandInput, cb: (err: any, data?: ListCrlsCommandOutput) => void): void; + listCrls( args: ListCrlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCrlsCommandOutput) => void ): void; - public listCrls( - args: ListCrlsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCrlsCommandOutput) => void), - cb?: (err: any, data?: ListCrlsCommandOutput) => void - ): Promise | void { - const command = new ListCrlsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all profiles in the authenticated account and Amazon Web Services Region.

- *

- * Required permissions: - * rolesanywhere:ListProfiles. - *

+ * @see {@link ListProfilesCommand} */ - public listProfiles( - args: ListProfilesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listProfiles(args: ListProfilesCommandInput, cb: (err: any, data?: ListProfilesCommandOutput) => void): void; - public listProfiles( + listProfiles(args: ListProfilesCommandInput, options?: __HttpHandlerOptions): Promise; + listProfiles(args: ListProfilesCommandInput, cb: (err: any, data?: ListProfilesCommandOutput) => void): void; + listProfiles( args: ListProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProfilesCommandOutput) => void ): void; - public listProfiles( - args: ListProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProfilesCommandOutput) => void), - cb?: (err: any, data?: ListProfilesCommandOutput) => void - ): Promise | void { - const command = new ListProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the subjects in the authenticated account and Amazon Web Services Region.

- *

- * Required permissions: - * rolesanywhere:ListSubjects. - *

+ * @see {@link ListSubjectsCommand} */ - public listSubjects( - args: ListSubjectsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listSubjects(args: ListSubjectsCommandInput, cb: (err: any, data?: ListSubjectsCommandOutput) => void): void; - public listSubjects( + listSubjects(args: ListSubjectsCommandInput, options?: __HttpHandlerOptions): Promise; + listSubjects(args: ListSubjectsCommandInput, cb: (err: any, data?: ListSubjectsCommandOutput) => void): void; + listSubjects( args: ListSubjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSubjectsCommandOutput) => void ): void; - public listSubjects( - args: ListSubjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSubjectsCommandOutput) => void), - cb?: (err: any, data?: ListSubjectsCommandOutput) => void - ): Promise | void { - const command = new ListSubjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags attached to the resource.

- *

- * Required permissions: - * rolesanywhere:ListTagsForResource. - *

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the trust anchors in the authenticated account and Amazon Web Services Region.

- *

- * Required permissions: - * rolesanywhere:ListTrustAnchors. - *

+ * @see {@link ListTrustAnchorsCommand} */ - public listTrustAnchors( + listTrustAnchors( args: ListTrustAnchorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTrustAnchors( + listTrustAnchors( args: ListTrustAnchorsCommandInput, cb: (err: any, data?: ListTrustAnchorsCommandOutput) => void ): void; - public listTrustAnchors( + listTrustAnchors( args: ListTrustAnchorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTrustAnchorsCommandOutput) => void ): void; - public listTrustAnchors( - args: ListTrustAnchorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTrustAnchorsCommandOutput) => void), - cb?: (err: any, data?: ListTrustAnchorsCommandOutput) => void - ): Promise | void { - const command = new ListTrustAnchorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Attaches tags to a resource.

- *

- * Required permissions: - * rolesanywhere:TagResource. - *

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from the resource.

- *

- * Required permissions: - * rolesanywhere:UntagResource. - *

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the certificate revocation list (CRL). CRl is a list of certificates that have been revoked by the issuing certificate Authority (CA). IAM Roles Anywhere validates against the crl list before issuing credentials.

- *

- * Required permissions: - * rolesanywhere:UpdateCrl. - *

+ * @see {@link UpdateCrlCommand} */ - public updateCrl(args: UpdateCrlCommandInput, options?: __HttpHandlerOptions): Promise; - public updateCrl(args: UpdateCrlCommandInput, cb: (err: any, data?: UpdateCrlCommandOutput) => void): void; - public updateCrl( + updateCrl(args: UpdateCrlCommandInput, options?: __HttpHandlerOptions): Promise; + updateCrl(args: UpdateCrlCommandInput, cb: (err: any, data?: UpdateCrlCommandOutput) => void): void; + updateCrl( args: UpdateCrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCrlCommandOutput) => void ): void; - public updateCrl( - args: UpdateCrlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCrlCommandOutput) => void), - cb?: (err: any, data?: UpdateCrlCommandOutput) => void - ): Promise | void { - const command = new UpdateCrlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the profile. A profile is configuration resource to list the roles that RolesAnywhere service is trusted to assume. In addition, by applying a profile you can scope-down permissions with IAM managed policies.

- *

- * Required permissions: - * rolesanywhere:UpdateProfile. - *

+ * @see {@link UpdateProfileCommand} */ - public updateProfile( - args: UpdateProfileCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateProfile( - args: UpdateProfileCommandInput, - cb: (err: any, data?: UpdateProfileCommandOutput) => void - ): void; - public updateProfile( + updateProfile(args: UpdateProfileCommandInput, options?: __HttpHandlerOptions): Promise; + updateProfile(args: UpdateProfileCommandInput, cb: (err: any, data?: UpdateProfileCommandOutput) => void): void; + updateProfile( args: UpdateProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProfileCommandOutput) => void ): void; - public updateProfile( - args: UpdateProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProfileCommandOutput) => void), - cb?: (err: any, data?: UpdateProfileCommandOutput) => void - ): Promise | void { - const command = new UpdateProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the trust anchor.You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. A Trust Anchor is defined either as a reference to a AWS Certificate Manager Private Certificate Authority (ACM PCA), or by uploading a Certificate Authority (CA) certificate. Your AWS workloads can authenticate with the trust anchor using certificates issued by the trusted Certificate Authority (CA) in exchange for temporary AWS credentials.

- *

- * Required permissions: - * rolesanywhere:UpdateTrustAnchor. - *

+ * @see {@link UpdateTrustAnchorCommand} */ - public updateTrustAnchor( + updateTrustAnchor( args: UpdateTrustAnchorCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTrustAnchor( + updateTrustAnchor( args: UpdateTrustAnchorCommandInput, cb: (err: any, data?: UpdateTrustAnchorCommandOutput) => void ): void; - public updateTrustAnchor( + updateTrustAnchor( args: UpdateTrustAnchorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTrustAnchorCommandOutput) => void ): void; - public updateTrustAnchor( - args: UpdateTrustAnchorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTrustAnchorCommandOutput) => void), - cb?: (err: any, data?: UpdateTrustAnchorCommandOutput) => void - ): Promise | void { - const command = new UpdateTrustAnchorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

AWS Identity and Access Management Roles Anywhere provides a secure way for your workloads such as servers, containers, and applications running outside of AWS to obtain Temporary AWS credentials. Your workloads can use the same IAM policies and roles that you have configured with native AWS applications to access AWS resources. Using IAM Roles Anywhere will eliminate the need to manage long term credentials for workloads running outside of AWS.

+ *

To use IAM Roles Anywhere customer workloads will need to use X.509 certificates issued by their Certificate Authority (CA) . The Certificate Authority (CA) needs to be registered with IAM Roles Anywhere as a trust anchor to establish trust between customer PKI and IAM Roles Anywhere. Customers who do not manage their own PKI system can use AWS Certificate Manager Private Certificate Authority (ACM PCA) to create a Certificate Authority and use that to establish trust with IAM Roles Anywhere

+ *

This guide describes the IAM rolesanywhere operations that you can call programmatically. For general information about IAM Roles Anywhere see https://docs.aws.amazon.com/ + *

+ */ +export class RolesAnywhere extends RolesAnywhereClient implements RolesAnywhere {} +createAggregatedClient(commands, RolesAnywhere); diff --git a/clients/client-route-53-domains/src/Route53Domains.ts b/clients/client-route-53-domains/src/Route53Domains.ts index e6051611d76e..7f1ac7a385f2 100644 --- a/clients/client-route-53-domains/src/Route53Domains.ts +++ b/clients/client-route-53-domains/src/Route53Domains.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -151,1347 +152,581 @@ import { UpdateTagsForDomainCommandOutput, } from "./commands/UpdateTagsForDomainCommand"; import { ViewBillingCommand, ViewBillingCommandInput, ViewBillingCommandOutput } from "./commands/ViewBillingCommand"; -import { Route53DomainsClient } from "./Route53DomainsClient"; +import { Route53DomainsClient, Route53DomainsClientConfig } from "./Route53DomainsClient"; -/** - * @public - *

Amazon Route 53 API actions let you register domain names and perform related - * operations.

- */ -export class Route53Domains extends Route53DomainsClient { +const commands = { + AcceptDomainTransferFromAnotherAwsAccountCommand, + AssociateDelegationSignerToDomainCommand, + CancelDomainTransferToAnotherAwsAccountCommand, + CheckDomainAvailabilityCommand, + CheckDomainTransferabilityCommand, + DeleteDomainCommand, + DeleteTagsForDomainCommand, + DisableDomainAutoRenewCommand, + DisableDomainTransferLockCommand, + DisassociateDelegationSignerFromDomainCommand, + EnableDomainAutoRenewCommand, + EnableDomainTransferLockCommand, + GetContactReachabilityStatusCommand, + GetDomainDetailCommand, + GetDomainSuggestionsCommand, + GetOperationDetailCommand, + ListDomainsCommand, + ListOperationsCommand, + ListPricesCommand, + ListTagsForDomainCommand, + PushDomainCommand, + RegisterDomainCommand, + RejectDomainTransferFromAnotherAwsAccountCommand, + RenewDomainCommand, + ResendContactReachabilityEmailCommand, + ResendOperationAuthorizationCommand, + RetrieveDomainAuthCodeCommand, + TransferDomainCommand, + TransferDomainToAnotherAwsAccountCommand, + UpdateDomainContactCommand, + UpdateDomainContactPrivacyCommand, + UpdateDomainNameserversCommand, + UpdateTagsForDomainCommand, + ViewBillingCommand, +}; + +export interface Route53Domains { /** - * @public - *

Accepts the transfer of a domain from another Amazon Web Services account to the - * currentAmazon Web Services account. You initiate a transfer between Amazon Web Services accounts using TransferDomainToAnotherAwsAccount.

- *

If you use the CLI command at accept-domain-transfer-from-another-aws-account, use JSON format as input - * instead of text because otherwise CLI will throw an error from domain - * transfer input that includes single quotes.

- *

Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example, - * Domain Transfer from Aws Account 111122223333 has been cancelled.

+ * @see {@link AcceptDomainTransferFromAnotherAwsAccountCommand} */ - public acceptDomainTransferFromAnotherAwsAccount( + acceptDomainTransferFromAnotherAwsAccount( args: AcceptDomainTransferFromAnotherAwsAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptDomainTransferFromAnotherAwsAccount( + acceptDomainTransferFromAnotherAwsAccount( args: AcceptDomainTransferFromAnotherAwsAccountCommandInput, cb: (err: any, data?: AcceptDomainTransferFromAnotherAwsAccountCommandOutput) => void ): void; - public acceptDomainTransferFromAnotherAwsAccount( + acceptDomainTransferFromAnotherAwsAccount( args: AcceptDomainTransferFromAnotherAwsAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptDomainTransferFromAnotherAwsAccountCommandOutput) => void ): void; - public acceptDomainTransferFromAnotherAwsAccount( - args: AcceptDomainTransferFromAnotherAwsAccountCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AcceptDomainTransferFromAnotherAwsAccountCommandOutput) => void), - cb?: (err: any, data?: AcceptDomainTransferFromAnotherAwsAccountCommandOutput) => void - ): Promise | void { - const command = new AcceptDomainTransferFromAnotherAwsAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a delegation signer (DS) record in the registry zone for this domain - * name.

- *

Note that creating DS record at the registry impacts DNSSEC validation of your DNS - * records. This action may render your domain name unavailable on the internet if the - * steps are completed in the wrong order, or with incorrect timing. For more information - * about DNSSEC signing, see Configuring DNSSEC - * signing in the Route 53 developer - * guide.

+ * @see {@link AssociateDelegationSignerToDomainCommand} */ - public associateDelegationSignerToDomain( + associateDelegationSignerToDomain( args: AssociateDelegationSignerToDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateDelegationSignerToDomain( + associateDelegationSignerToDomain( args: AssociateDelegationSignerToDomainCommandInput, cb: (err: any, data?: AssociateDelegationSignerToDomainCommandOutput) => void ): void; - public associateDelegationSignerToDomain( + associateDelegationSignerToDomain( args: AssociateDelegationSignerToDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateDelegationSignerToDomainCommandOutput) => void ): void; - public associateDelegationSignerToDomain( - args: AssociateDelegationSignerToDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateDelegationSignerToDomainCommandOutput) => void), - cb?: (err: any, data?: AssociateDelegationSignerToDomainCommandOutput) => void - ): Promise | void { - const command = new AssociateDelegationSignerToDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels the transfer of a domain from the current Amazon Web Services account to - * another Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using TransferDomainToAnotherAwsAccount.

- * - *

You must cancel the transfer before the other Amazon Web Services account accepts - * the transfer using AcceptDomainTransferFromAnotherAwsAccount.

- *
- *

Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example, - * Domain Transfer from Aws Account 111122223333 has been cancelled.

+ * @see {@link CancelDomainTransferToAnotherAwsAccountCommand} */ - public cancelDomainTransferToAnotherAwsAccount( + cancelDomainTransferToAnotherAwsAccount( args: CancelDomainTransferToAnotherAwsAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelDomainTransferToAnotherAwsAccount( + cancelDomainTransferToAnotherAwsAccount( args: CancelDomainTransferToAnotherAwsAccountCommandInput, cb: (err: any, data?: CancelDomainTransferToAnotherAwsAccountCommandOutput) => void ): void; - public cancelDomainTransferToAnotherAwsAccount( + cancelDomainTransferToAnotherAwsAccount( args: CancelDomainTransferToAnotherAwsAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelDomainTransferToAnotherAwsAccountCommandOutput) => void ): void; - public cancelDomainTransferToAnotherAwsAccount( - args: CancelDomainTransferToAnotherAwsAccountCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CancelDomainTransferToAnotherAwsAccountCommandOutput) => void), - cb?: (err: any, data?: CancelDomainTransferToAnotherAwsAccountCommandOutput) => void - ): Promise | void { - const command = new CancelDomainTransferToAnotherAwsAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation checks the availability of one domain name. Note that if the - * availability status of a domain is pending, you must submit another request to determine - * the availability of the domain name.

+ * @see {@link CheckDomainAvailabilityCommand} */ - public checkDomainAvailability( + checkDomainAvailability( args: CheckDomainAvailabilityCommandInput, options?: __HttpHandlerOptions ): Promise; - public checkDomainAvailability( + checkDomainAvailability( args: CheckDomainAvailabilityCommandInput, cb: (err: any, data?: CheckDomainAvailabilityCommandOutput) => void ): void; - public checkDomainAvailability( + checkDomainAvailability( args: CheckDomainAvailabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CheckDomainAvailabilityCommandOutput) => void ): void; - public checkDomainAvailability( - args: CheckDomainAvailabilityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CheckDomainAvailabilityCommandOutput) => void), - cb?: (err: any, data?: CheckDomainAvailabilityCommandOutput) => void - ): Promise | void { - const command = new CheckDomainAvailabilityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Checks whether a domain name can be transferred to Amazon Route 53.

+ * @see {@link CheckDomainTransferabilityCommand} */ - public checkDomainTransferability( + checkDomainTransferability( args: CheckDomainTransferabilityCommandInput, options?: __HttpHandlerOptions ): Promise; - public checkDomainTransferability( + checkDomainTransferability( args: CheckDomainTransferabilityCommandInput, cb: (err: any, data?: CheckDomainTransferabilityCommandOutput) => void ): void; - public checkDomainTransferability( + checkDomainTransferability( args: CheckDomainTransferabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CheckDomainTransferabilityCommandOutput) => void ): void; - public checkDomainTransferability( - args: CheckDomainTransferabilityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CheckDomainTransferabilityCommandOutput) => void), - cb?: (err: any, data?: CheckDomainTransferabilityCommandOutput) => void - ): Promise | void { - const command = new CheckDomainTransferabilityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation deletes the specified domain. This action is permanent. For more - * information, see Deleting a domain name - * registration.

- *

To transfer the domain registration to another registrar, use the transfer process - * that’s provided by the registrar to which you want to transfer the registration. - * Otherwise, the following apply:

- *
    - *
  1. - *

    You can’t get a refund for the cost of a deleted domain registration.

    - *
  2. - *
  3. - *

    The registry for the top-level domain might hold the domain name for a brief - * time before releasing it for other users to register (varies by registry). - *

    - *
  4. - *
  5. - *

    When the registration has been deleted, we'll send you a confirmation to the - * registrant contact. The email will come from - * noreply@domainnameverification.net or - * noreply@registrar.amazon.com.

    - *
  6. - *
+ * @see {@link DeleteDomainCommand} */ - public deleteDomain( - args: DeleteDomainCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDomain(args: DeleteDomainCommandInput, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void; - public deleteDomain( + deleteDomain(args: DeleteDomainCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDomain(args: DeleteDomainCommandInput, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void; + deleteDomain( args: DeleteDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDomainCommandOutput) => void ): void; - public deleteDomain( - args: DeleteDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDomainCommandOutput) => void), - cb?: (err: any, data?: DeleteDomainCommandOutput) => void - ): Promise | void { - const command = new DeleteDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation deletes the specified tags for a domain.

- *

All tag operations are eventually consistent; subsequent operations might not - * immediately represent all issued operations.

+ * @see {@link DeleteTagsForDomainCommand} */ - public deleteTagsForDomain( + deleteTagsForDomain( args: DeleteTagsForDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTagsForDomain( + deleteTagsForDomain( args: DeleteTagsForDomainCommandInput, cb: (err: any, data?: DeleteTagsForDomainCommandOutput) => void ): void; - public deleteTagsForDomain( + deleteTagsForDomain( args: DeleteTagsForDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTagsForDomainCommandOutput) => void ): void; - public deleteTagsForDomain( - args: DeleteTagsForDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTagsForDomainCommandOutput) => void), - cb?: (err: any, data?: DeleteTagsForDomainCommandOutput) => void - ): Promise | void { - const command = new DeleteTagsForDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation disables automatic renewal of domain registration for the specified - * domain.

+ * @see {@link DisableDomainAutoRenewCommand} */ - public disableDomainAutoRenew( + disableDomainAutoRenew( args: DisableDomainAutoRenewCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableDomainAutoRenew( + disableDomainAutoRenew( args: DisableDomainAutoRenewCommandInput, cb: (err: any, data?: DisableDomainAutoRenewCommandOutput) => void ): void; - public disableDomainAutoRenew( + disableDomainAutoRenew( args: DisableDomainAutoRenewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableDomainAutoRenewCommandOutput) => void ): void; - public disableDomainAutoRenew( - args: DisableDomainAutoRenewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableDomainAutoRenewCommandOutput) => void), - cb?: (err: any, data?: DisableDomainAutoRenewCommandOutput) => void - ): Promise | void { - const command = new DisableDomainAutoRenewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation removes the transfer lock on the domain (specifically the - * clientTransferProhibited status) to allow domain transfers. We - * recommend you refrain from performing this action unless you intend to transfer the - * domain to a different registrar. Successful submission returns an operation ID that you - * can use to track the progress and completion of the action. If the request is not - * completed successfully, the domain registrant will be notified by email.

+ * @see {@link DisableDomainTransferLockCommand} */ - public disableDomainTransferLock( + disableDomainTransferLock( args: DisableDomainTransferLockCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableDomainTransferLock( + disableDomainTransferLock( args: DisableDomainTransferLockCommandInput, cb: (err: any, data?: DisableDomainTransferLockCommandOutput) => void ): void; - public disableDomainTransferLock( + disableDomainTransferLock( args: DisableDomainTransferLockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableDomainTransferLockCommandOutput) => void ): void; - public disableDomainTransferLock( - args: DisableDomainTransferLockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableDomainTransferLockCommandOutput) => void), - cb?: (err: any, data?: DisableDomainTransferLockCommandOutput) => void - ): Promise | void { - const command = new DisableDomainTransferLockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a delegation signer (DS) record in the registry zone for this domain - * name.

+ * @see {@link DisassociateDelegationSignerFromDomainCommand} */ - public disassociateDelegationSignerFromDomain( + disassociateDelegationSignerFromDomain( args: DisassociateDelegationSignerFromDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateDelegationSignerFromDomain( + disassociateDelegationSignerFromDomain( args: DisassociateDelegationSignerFromDomainCommandInput, cb: (err: any, data?: DisassociateDelegationSignerFromDomainCommandOutput) => void ): void; - public disassociateDelegationSignerFromDomain( + disassociateDelegationSignerFromDomain( args: DisassociateDelegationSignerFromDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateDelegationSignerFromDomainCommandOutput) => void ): void; - public disassociateDelegationSignerFromDomain( - args: DisassociateDelegationSignerFromDomainCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociateDelegationSignerFromDomainCommandOutput) => void), - cb?: (err: any, data?: DisassociateDelegationSignerFromDomainCommandOutput) => void - ): Promise | void { - const command = new DisassociateDelegationSignerFromDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation configures Amazon Route 53 to automatically renew the specified domain - * before the domain registration expires. The cost of renewing your domain registration is - * billed to your Amazon Web Services account.

- *

The period during which you can renew a domain name varies by TLD. For a list of TLDs - * and their renewal policies, see Domains That You Can - * Register with Amazon Route 53 in the Amazon Route 53 Developer - * Guide. Route 53 requires that you renew before the end of the renewal - * period so we can complete processing before the deadline.

+ * @see {@link EnableDomainAutoRenewCommand} */ - public enableDomainAutoRenew( + enableDomainAutoRenew( args: EnableDomainAutoRenewCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableDomainAutoRenew( + enableDomainAutoRenew( args: EnableDomainAutoRenewCommandInput, cb: (err: any, data?: EnableDomainAutoRenewCommandOutput) => void ): void; - public enableDomainAutoRenew( + enableDomainAutoRenew( args: EnableDomainAutoRenewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableDomainAutoRenewCommandOutput) => void ): void; - public enableDomainAutoRenew( - args: EnableDomainAutoRenewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableDomainAutoRenewCommandOutput) => void), - cb?: (err: any, data?: EnableDomainAutoRenewCommandOutput) => void - ): Promise | void { - const command = new EnableDomainAutoRenewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation sets the transfer lock on the domain (specifically the - * clientTransferProhibited status) to prevent domain transfers. - * Successful submission returns an operation ID that you can use to track the progress and - * completion of the action. If the request is not completed successfully, the domain - * registrant will be notified by email.

+ * @see {@link EnableDomainTransferLockCommand} */ - public enableDomainTransferLock( + enableDomainTransferLock( args: EnableDomainTransferLockCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableDomainTransferLock( + enableDomainTransferLock( args: EnableDomainTransferLockCommandInput, cb: (err: any, data?: EnableDomainTransferLockCommandOutput) => void ): void; - public enableDomainTransferLock( + enableDomainTransferLock( args: EnableDomainTransferLockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableDomainTransferLockCommandOutput) => void ): void; - public enableDomainTransferLock( - args: EnableDomainTransferLockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableDomainTransferLockCommandOutput) => void), - cb?: (err: any, data?: EnableDomainTransferLockCommandOutput) => void - ): Promise | void { - const command = new EnableDomainTransferLockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

For operations that require confirmation that the email address for the registrant - * contact is valid, such as registering a new domain, this operation returns information - * about whether the registrant contact has responded.

- *

If you want us to resend the email, use the - * ResendContactReachabilityEmail operation.

+ * @see {@link GetContactReachabilityStatusCommand} */ - public getContactReachabilityStatus( + getContactReachabilityStatus( args: GetContactReachabilityStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getContactReachabilityStatus( + getContactReachabilityStatus( args: GetContactReachabilityStatusCommandInput, cb: (err: any, data?: GetContactReachabilityStatusCommandOutput) => void ): void; - public getContactReachabilityStatus( + getContactReachabilityStatus( args: GetContactReachabilityStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContactReachabilityStatusCommandOutput) => void ): void; - public getContactReachabilityStatus( - args: GetContactReachabilityStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContactReachabilityStatusCommandOutput) => void), - cb?: (err: any, data?: GetContactReachabilityStatusCommandOutput) => void - ): Promise | void { - const command = new GetContactReachabilityStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation returns detailed information about a specified domain that is - * associated with the current Amazon Web Services account. Contact information for the - * domain is also returned as part of the output.

+ * @see {@link GetDomainDetailCommand} */ - public getDomainDetail( + getDomainDetail( args: GetDomainDetailCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDomainDetail( - args: GetDomainDetailCommandInput, - cb: (err: any, data?: GetDomainDetailCommandOutput) => void - ): void; - public getDomainDetail( + getDomainDetail(args: GetDomainDetailCommandInput, cb: (err: any, data?: GetDomainDetailCommandOutput) => void): void; + getDomainDetail( args: GetDomainDetailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDomainDetailCommandOutput) => void ): void; - public getDomainDetail( - args: GetDomainDetailCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDomainDetailCommandOutput) => void), - cb?: (err: any, data?: GetDomainDetailCommandOutput) => void - ): Promise | void { - const command = new GetDomainDetailCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The GetDomainSuggestions operation returns a list of suggested domain names.

+ * @see {@link GetDomainSuggestionsCommand} */ - public getDomainSuggestions( + getDomainSuggestions( args: GetDomainSuggestionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDomainSuggestions( + getDomainSuggestions( args: GetDomainSuggestionsCommandInput, cb: (err: any, data?: GetDomainSuggestionsCommandOutput) => void ): void; - public getDomainSuggestions( + getDomainSuggestions( args: GetDomainSuggestionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDomainSuggestionsCommandOutput) => void ): void; - public getDomainSuggestions( - args: GetDomainSuggestionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDomainSuggestionsCommandOutput) => void), - cb?: (err: any, data?: GetDomainSuggestionsCommandOutput) => void - ): Promise | void { - const command = new GetDomainSuggestionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation returns the current status of an operation that is not - * completed.

+ * @see {@link GetOperationDetailCommand} */ - public getOperationDetail( + getOperationDetail( args: GetOperationDetailCommandInput, options?: __HttpHandlerOptions ): Promise; - public getOperationDetail( + getOperationDetail( args: GetOperationDetailCommandInput, cb: (err: any, data?: GetOperationDetailCommandOutput) => void ): void; - public getOperationDetail( + getOperationDetail( args: GetOperationDetailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOperationDetailCommandOutput) => void ): void; - public getOperationDetail( - args: GetOperationDetailCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOperationDetailCommandOutput) => void), - cb?: (err: any, data?: GetOperationDetailCommandOutput) => void - ): Promise | void { - const command = new GetOperationDetailCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation returns all the domain names registered with Amazon Route 53 for the - * current Amazon Web Services account if no filtering conditions are used.

+ * @see {@link ListDomainsCommand} */ - public listDomains(args: ListDomainsCommandInput, options?: __HttpHandlerOptions): Promise; - public listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void; - public listDomains( + listDomains(args: ListDomainsCommandInput, options?: __HttpHandlerOptions): Promise; + listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void; + listDomains( args: ListDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainsCommandOutput) => void ): void; - public listDomains( - args: ListDomainsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDomainsCommandOutput) => void), - cb?: (err: any, data?: ListDomainsCommandOutput) => void - ): Promise | void { - const command = new ListDomainsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about all of the operations that return an operation ID and that - * have ever been performed on domains that were registered by the current account.

- *

This command runs only in the us-east-1 Region.

+ * @see {@link ListOperationsCommand} */ - public listOperations( + listOperations( args: ListOperationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOperations( - args: ListOperationsCommandInput, - cb: (err: any, data?: ListOperationsCommandOutput) => void - ): void; - public listOperations( + listOperations(args: ListOperationsCommandInput, cb: (err: any, data?: ListOperationsCommandOutput) => void): void; + listOperations( args: ListOperationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOperationsCommandOutput) => void ): void; - public listOperations( - args: ListOperationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOperationsCommandOutput) => void), - cb?: (err: any, data?: ListOperationsCommandOutput) => void - ): Promise | void { - const command = new ListOperationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the following prices for either all the TLDs supported by Route 53, or - * the specified TLD:

- *
    - *
  • - *

    Registration

    - *
  • - *
  • - *

    Transfer

    - *
  • - *
  • - *

    Owner change

    - *
  • - *
  • - *

    Domain renewal

    - *
  • - *
  • - *

    Domain restoration

    - *
  • - *
+ * @see {@link ListPricesCommand} */ - public listPrices(args: ListPricesCommandInput, options?: __HttpHandlerOptions): Promise; - public listPrices(args: ListPricesCommandInput, cb: (err: any, data?: ListPricesCommandOutput) => void): void; - public listPrices( + listPrices(args: ListPricesCommandInput, options?: __HttpHandlerOptions): Promise; + listPrices(args: ListPricesCommandInput, cb: (err: any, data?: ListPricesCommandOutput) => void): void; + listPrices( args: ListPricesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPricesCommandOutput) => void ): void; - public listPrices( - args: ListPricesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPricesCommandOutput) => void), - cb?: (err: any, data?: ListPricesCommandOutput) => void - ): Promise | void { - const command = new ListPricesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation returns all of the tags that are associated with the specified - * domain.

- *

All tag operations are eventually consistent; subsequent operations might not - * immediately represent all issued operations.

+ * @see {@link ListTagsForDomainCommand} */ - public listTagsForDomain( + listTagsForDomain( args: ListTagsForDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForDomain( + listTagsForDomain( args: ListTagsForDomainCommandInput, cb: (err: any, data?: ListTagsForDomainCommandOutput) => void ): void; - public listTagsForDomain( + listTagsForDomain( args: ListTagsForDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForDomainCommandOutput) => void ): void; - public listTagsForDomain( - args: ListTagsForDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForDomainCommandOutput) => void), - cb?: (err: any, data?: ListTagsForDomainCommandOutput) => void - ): Promise | void { - const command = new ListTagsForDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Moves a domain from Amazon Web Services to another registrar.

- *

Supported actions:

- *
    - *
  • - *

    Changes the IPS tags of a .uk domain, and pushes it to transit. Transit means - * that the domain is ready to be transferred to another registrar.

    - *
  • - *
+ * @see {@link PushDomainCommand} */ - public pushDomain(args: PushDomainCommandInput, options?: __HttpHandlerOptions): Promise; - public pushDomain(args: PushDomainCommandInput, cb: (err: any, data?: PushDomainCommandOutput) => void): void; - public pushDomain( + pushDomain(args: PushDomainCommandInput, options?: __HttpHandlerOptions): Promise; + pushDomain(args: PushDomainCommandInput, cb: (err: any, data?: PushDomainCommandOutput) => void): void; + pushDomain( args: PushDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PushDomainCommandOutput) => void ): void; - public pushDomain( - args: PushDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PushDomainCommandOutput) => void), - cb?: (err: any, data?: PushDomainCommandOutput) => void - ): Promise | void { - const command = new PushDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation registers a domain. Domains are registered either by Amazon Registrar - * (for .com, .net, and .org domains) or by our registrar associate, Gandi (for all other - * domains). For some top-level domains (TLDs), this operation requires extra - * parameters.

- *

When you register a domain, Amazon Route 53 does the following:

- *
    - *
  • - *

    Creates a Route 53 hosted zone that has the same name as the domain. Route 53 - * assigns four name servers to your hosted zone and automatically updates your - * domain registration with the names of these name servers.

    - *
  • - *
  • - *

    Enables auto renew, so your domain registration will renew automatically each - * year. We'll notify you in advance of the renewal date so you can choose whether - * to renew the registration.

    - *
  • - *
  • - *

    Optionally enables privacy protection, so WHOIS queries return contact - * information either for Amazon Registrar (for .com, .net, and .org domains) or - * for our registrar associate, Gandi (for all other TLDs). If you don't enable - * privacy protection, WHOIS queries return the information that you entered for - * the administrative, registrant, and technical contacts.

    - * - *

    You must specify the same privacy setting for the administrative, - * registrant, and technical contacts.

    - *
    - *
  • - *
  • - *

    If registration is successful, returns an operation ID that you can use to - * track the progress and completion of the action. If the request is not completed - * successfully, the domain registrant is notified by email.

    - *
  • - *
  • - *

    Charges your Amazon Web Services account an amount based on the top-level - * domain. For more information, see Amazon Route 53 Pricing.

    - *
  • - *
+ * @see {@link RegisterDomainCommand} */ - public registerDomain( + registerDomain( args: RegisterDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerDomain( - args: RegisterDomainCommandInput, - cb: (err: any, data?: RegisterDomainCommandOutput) => void - ): void; - public registerDomain( + registerDomain(args: RegisterDomainCommandInput, cb: (err: any, data?: RegisterDomainCommandOutput) => void): void; + registerDomain( args: RegisterDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterDomainCommandOutput) => void ): void; - public registerDomain( - args: RegisterDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterDomainCommandOutput) => void), - cb?: (err: any, data?: RegisterDomainCommandOutput) => void - ): Promise | void { - const command = new RegisterDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Rejects the transfer of a domain from another Amazon Web Services account to the - * current Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using TransferDomainToAnotherAwsAccount.

- *

Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example, - * Domain Transfer from Aws Account 111122223333 has been cancelled.

+ * @see {@link RejectDomainTransferFromAnotherAwsAccountCommand} */ - public rejectDomainTransferFromAnotherAwsAccount( + rejectDomainTransferFromAnotherAwsAccount( args: RejectDomainTransferFromAnotherAwsAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public rejectDomainTransferFromAnotherAwsAccount( + rejectDomainTransferFromAnotherAwsAccount( args: RejectDomainTransferFromAnotherAwsAccountCommandInput, cb: (err: any, data?: RejectDomainTransferFromAnotherAwsAccountCommandOutput) => void ): void; - public rejectDomainTransferFromAnotherAwsAccount( + rejectDomainTransferFromAnotherAwsAccount( args: RejectDomainTransferFromAnotherAwsAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectDomainTransferFromAnotherAwsAccountCommandOutput) => void ): void; - public rejectDomainTransferFromAnotherAwsAccount( - args: RejectDomainTransferFromAnotherAwsAccountCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: RejectDomainTransferFromAnotherAwsAccountCommandOutput) => void), - cb?: (err: any, data?: RejectDomainTransferFromAnotherAwsAccountCommandOutput) => void - ): Promise | void { - const command = new RejectDomainTransferFromAnotherAwsAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation renews a domain for the specified number of years. The cost of renewing - * your domain is billed to your Amazon Web Services account.

- *

We recommend that you renew your domain several weeks before the expiration date. Some - * TLD registries delete domains before the expiration date if you haven't renewed far - * enough in advance. For more information about renewing domain registration, see Renewing - * Registration for a Domain in the Amazon Route 53 Developer - * Guide.

+ * @see {@link RenewDomainCommand} */ - public renewDomain(args: RenewDomainCommandInput, options?: __HttpHandlerOptions): Promise; - public renewDomain(args: RenewDomainCommandInput, cb: (err: any, data?: RenewDomainCommandOutput) => void): void; - public renewDomain( + renewDomain(args: RenewDomainCommandInput, options?: __HttpHandlerOptions): Promise; + renewDomain(args: RenewDomainCommandInput, cb: (err: any, data?: RenewDomainCommandOutput) => void): void; + renewDomain( args: RenewDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RenewDomainCommandOutput) => void ): void; - public renewDomain( - args: RenewDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RenewDomainCommandOutput) => void), - cb?: (err: any, data?: RenewDomainCommandOutput) => void - ): Promise | void { - const command = new RenewDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

For operations that require confirmation that the email address for the registrant - * contact is valid, such as registering a new domain, this operation resends the - * confirmation email to the current email address for the registrant contact.

+ * @see {@link ResendContactReachabilityEmailCommand} */ - public resendContactReachabilityEmail( + resendContactReachabilityEmail( args: ResendContactReachabilityEmailCommandInput, options?: __HttpHandlerOptions ): Promise; - public resendContactReachabilityEmail( + resendContactReachabilityEmail( args: ResendContactReachabilityEmailCommandInput, cb: (err: any, data?: ResendContactReachabilityEmailCommandOutput) => void ): void; - public resendContactReachabilityEmail( + resendContactReachabilityEmail( args: ResendContactReachabilityEmailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResendContactReachabilityEmailCommandOutput) => void ): void; - public resendContactReachabilityEmail( - args: ResendContactReachabilityEmailCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResendContactReachabilityEmailCommandOutput) => void), - cb?: (err: any, data?: ResendContactReachabilityEmailCommandOutput) => void - ): Promise | void { - const command = new ResendContactReachabilityEmailCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Resend the form of authorization email for this operation.

+ * @see {@link ResendOperationAuthorizationCommand} */ - public resendOperationAuthorization( + resendOperationAuthorization( args: ResendOperationAuthorizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public resendOperationAuthorization( + resendOperationAuthorization( args: ResendOperationAuthorizationCommandInput, cb: (err: any, data?: ResendOperationAuthorizationCommandOutput) => void ): void; - public resendOperationAuthorization( + resendOperationAuthorization( args: ResendOperationAuthorizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResendOperationAuthorizationCommandOutput) => void ): void; - public resendOperationAuthorization( - args: ResendOperationAuthorizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResendOperationAuthorizationCommandOutput) => void), - cb?: (err: any, data?: ResendOperationAuthorizationCommandOutput) => void - ): Promise | void { - const command = new ResendOperationAuthorizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation returns the authorization code for the domain. To transfer a domain to - * another registrar, you provide this value to the new registrar.

+ * @see {@link RetrieveDomainAuthCodeCommand} */ - public retrieveDomainAuthCode( + retrieveDomainAuthCode( args: RetrieveDomainAuthCodeCommandInput, options?: __HttpHandlerOptions ): Promise; - public retrieveDomainAuthCode( + retrieveDomainAuthCode( args: RetrieveDomainAuthCodeCommandInput, cb: (err: any, data?: RetrieveDomainAuthCodeCommandOutput) => void ): void; - public retrieveDomainAuthCode( + retrieveDomainAuthCode( args: RetrieveDomainAuthCodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RetrieveDomainAuthCodeCommandOutput) => void ): void; - public retrieveDomainAuthCode( - args: RetrieveDomainAuthCodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RetrieveDomainAuthCodeCommandOutput) => void), - cb?: (err: any, data?: RetrieveDomainAuthCodeCommandOutput) => void - ): Promise | void { - const command = new RetrieveDomainAuthCodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Transfers a domain from another registrar to Amazon Route 53. When the transfer is - * complete, the domain is registered either with Amazon Registrar (for .com, .net, and - * .org domains) or with our registrar associate, Gandi (for all other TLDs).

- *

For more information about transferring domains, see the following topics:

- * - *

If the registrar for your domain is also the DNS service provider for the domain, we - * highly recommend that you transfer your DNS service to Route 53 or to another DNS - * service provider before you transfer your registration. Some registrars provide free DNS - * service when you purchase a domain registration. When you transfer the registration, the - * previous registrar will not renew your domain registration and could end your DNS - * service at any time.

- * - *

If the registrar for your domain is also the DNS service provider for the domain - * and you don't transfer DNS service to another provider, your website, email, and the - * web applications associated with the domain might become unavailable.

- *
- *

If the transfer is successful, this method returns an operation ID that you can use to - * track the progress and completion of the action. If the transfer doesn't complete - * successfully, the domain registrant will be notified by email.

+ * @see {@link TransferDomainCommand} */ - public transferDomain( + transferDomain( args: TransferDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public transferDomain( - args: TransferDomainCommandInput, - cb: (err: any, data?: TransferDomainCommandOutput) => void - ): void; - public transferDomain( + transferDomain(args: TransferDomainCommandInput, cb: (err: any, data?: TransferDomainCommandOutput) => void): void; + transferDomain( args: TransferDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TransferDomainCommandOutput) => void ): void; - public transferDomain( - args: TransferDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TransferDomainCommandOutput) => void), - cb?: (err: any, data?: TransferDomainCommandOutput) => void - ): Promise | void { - const command = new TransferDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Transfers a domain from the current Amazon Web Services account to another Amazon Web Services account. Note the following:

- * - * - *

When you transfer a domain from one Amazon Web Services account to another, Route - * 53 doesn't transfer the hosted zone that is associated with the domain. DNS - * resolution isn't affected if the domain and the hosted zone are owned by separate - * accounts, so transferring the hosted zone is optional. For information about - * transferring the hosted zone to another Amazon Web Services account, see Migrating a - * Hosted Zone to a Different Amazon Web Services Account in the - * Amazon Route 53 Developer Guide.

- *
- *

Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example, - * Domain Transfer from Aws Account 111122223333 has been cancelled.

+ * @see {@link TransferDomainToAnotherAwsAccountCommand} */ - public transferDomainToAnotherAwsAccount( + transferDomainToAnotherAwsAccount( args: TransferDomainToAnotherAwsAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public transferDomainToAnotherAwsAccount( + transferDomainToAnotherAwsAccount( args: TransferDomainToAnotherAwsAccountCommandInput, cb: (err: any, data?: TransferDomainToAnotherAwsAccountCommandOutput) => void ): void; - public transferDomainToAnotherAwsAccount( + transferDomainToAnotherAwsAccount( args: TransferDomainToAnotherAwsAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TransferDomainToAnotherAwsAccountCommandOutput) => void ): void; - public transferDomainToAnotherAwsAccount( - args: TransferDomainToAnotherAwsAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TransferDomainToAnotherAwsAccountCommandOutput) => void), - cb?: (err: any, data?: TransferDomainToAnotherAwsAccountCommandOutput) => void - ): Promise | void { - const command = new TransferDomainToAnotherAwsAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation updates the contact information for a particular domain. You must - * specify information for at least one contact: registrant, administrator, or - * technical.

- *

If the update is successful, this method returns an operation ID that you can use to - * track the progress and completion of the operation. If the request is not completed - * successfully, the domain registrant will be notified by email.

+ * @see {@link UpdateDomainContactCommand} */ - public updateDomainContact( + updateDomainContact( args: UpdateDomainContactCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDomainContact( + updateDomainContact( args: UpdateDomainContactCommandInput, cb: (err: any, data?: UpdateDomainContactCommandOutput) => void ): void; - public updateDomainContact( + updateDomainContact( args: UpdateDomainContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDomainContactCommandOutput) => void ): void; - public updateDomainContact( - args: UpdateDomainContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDomainContactCommandOutput) => void), - cb?: (err: any, data?: UpdateDomainContactCommandOutput) => void - ): Promise | void { - const command = new UpdateDomainContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation updates the specified domain contact's privacy setting. When privacy - * protection is enabled, contact information such as email address is replaced either with - * contact information for Amazon Registrar (for .com, .net, and .org domains) or with - * contact information for our registrar associate, Gandi.

- * - *

You must specify the same privacy setting for the administrative, registrant, and - * technical contacts.

- *
- *

This operation affects only the contact information for the specified contact type - * (administrative, registrant, or technical). If the request succeeds, Amazon Route 53 - * returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If - * the request doesn't complete successfully, the domain registrant will be notified by - * email.

- * - *

By disabling the privacy service via API, you consent to the publication of the - * contact information provided for this domain via the public WHOIS database. You - * certify that you are the registrant of this domain name and have the authority to - * make this decision. You may withdraw your consent at any time by enabling privacy - * protection using either UpdateDomainContactPrivacy or the Route 53 - * console. Enabling privacy protection removes the contact information provided for - * this domain from the WHOIS database. For more information on our privacy practices, - * see https://aws.amazon.com/privacy/.

- *
+ * @see {@link UpdateDomainContactPrivacyCommand} */ - public updateDomainContactPrivacy( + updateDomainContactPrivacy( args: UpdateDomainContactPrivacyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDomainContactPrivacy( + updateDomainContactPrivacy( args: UpdateDomainContactPrivacyCommandInput, cb: (err: any, data?: UpdateDomainContactPrivacyCommandOutput) => void ): void; - public updateDomainContactPrivacy( + updateDomainContactPrivacy( args: UpdateDomainContactPrivacyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDomainContactPrivacyCommandOutput) => void ): void; - public updateDomainContactPrivacy( - args: UpdateDomainContactPrivacyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDomainContactPrivacyCommandOutput) => void), - cb?: (err: any, data?: UpdateDomainContactPrivacyCommandOutput) => void - ): Promise | void { - const command = new UpdateDomainContactPrivacyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation replaces the current set of name servers for the domain with the - * specified set of name servers. If you use Amazon Route 53 as your DNS service, specify - * the four name servers in the delegation set for the hosted zone for the domain.

- *

If successful, this operation returns an operation ID that you can use to track the - * progress and completion of the action. If the request is not completed successfully, the - * domain registrant will be notified by email.

+ * @see {@link UpdateDomainNameserversCommand} */ - public updateDomainNameservers( + updateDomainNameservers( args: UpdateDomainNameserversCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDomainNameservers( + updateDomainNameservers( args: UpdateDomainNameserversCommandInput, cb: (err: any, data?: UpdateDomainNameserversCommandOutput) => void ): void; - public updateDomainNameservers( + updateDomainNameservers( args: UpdateDomainNameserversCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDomainNameserversCommandOutput) => void ): void; - public updateDomainNameservers( - args: UpdateDomainNameserversCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDomainNameserversCommandOutput) => void), - cb?: (err: any, data?: UpdateDomainNameserversCommandOutput) => void - ): Promise | void { - const command = new UpdateDomainNameserversCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation adds or updates tags for a specified domain.

- *

All tag operations are eventually consistent; subsequent operations might not - * immediately represent all issued operations.

+ * @see {@link UpdateTagsForDomainCommand} */ - public updateTagsForDomain( + updateTagsForDomain( args: UpdateTagsForDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTagsForDomain( + updateTagsForDomain( args: UpdateTagsForDomainCommandInput, cb: (err: any, data?: UpdateTagsForDomainCommandOutput) => void ): void; - public updateTagsForDomain( + updateTagsForDomain( args: UpdateTagsForDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTagsForDomainCommandOutput) => void ): void; - public updateTagsForDomain( - args: UpdateTagsForDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTagsForDomainCommandOutput) => void), - cb?: (err: any, data?: UpdateTagsForDomainCommandOutput) => void - ): Promise | void { - const command = new UpdateTagsForDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns all the domain-related billing records for the current Amazon Web Services account for a specified period

+ * @see {@link ViewBillingCommand} */ - public viewBilling(args: ViewBillingCommandInput, options?: __HttpHandlerOptions): Promise; - public viewBilling(args: ViewBillingCommandInput, cb: (err: any, data?: ViewBillingCommandOutput) => void): void; - public viewBilling( + viewBilling(args: ViewBillingCommandInput, options?: __HttpHandlerOptions): Promise; + viewBilling(args: ViewBillingCommandInput, cb: (err: any, data?: ViewBillingCommandOutput) => void): void; + viewBilling( args: ViewBillingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ViewBillingCommandOutput) => void ): void; - public viewBilling( - args: ViewBillingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ViewBillingCommandOutput) => void), - cb?: (err: any, data?: ViewBillingCommandOutput) => void - ): Promise | void { - const command = new ViewBillingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Route 53 API actions let you register domain names and perform related + * operations.

+ */ +export class Route53Domains extends Route53DomainsClient implements Route53Domains {} +createAggregatedClient(commands, Route53Domains); diff --git a/clients/client-route-53/src/Route53.ts b/clients/client-route-53/src/Route53.ts index 471d5903006f..829ea56100db 100644 --- a/clients/client-route-53/src/Route53.ts +++ b/clients/client-route-53/src/Route53.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -343,3318 +344,1253 @@ import { UpdateTrafficPolicyInstanceCommandInput, UpdateTrafficPolicyInstanceCommandOutput, } from "./commands/UpdateTrafficPolicyInstanceCommand"; -import { Route53Client } from "./Route53Client"; +import { Route53Client, Route53ClientConfig } from "./Route53Client"; -/** - * @public - *

Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web - * service.

- *

You can use Route 53 to:

- * - */ -export class Route53 extends Route53Client { +const commands = { + ActivateKeySigningKeyCommand, + AssociateVPCWithHostedZoneCommand, + ChangeCidrCollectionCommand, + ChangeResourceRecordSetsCommand, + ChangeTagsForResourceCommand, + CreateCidrCollectionCommand, + CreateHealthCheckCommand, + CreateHostedZoneCommand, + CreateKeySigningKeyCommand, + CreateQueryLoggingConfigCommand, + CreateReusableDelegationSetCommand, + CreateTrafficPolicyCommand, + CreateTrafficPolicyInstanceCommand, + CreateTrafficPolicyVersionCommand, + CreateVPCAssociationAuthorizationCommand, + DeactivateKeySigningKeyCommand, + DeleteCidrCollectionCommand, + DeleteHealthCheckCommand, + DeleteHostedZoneCommand, + DeleteKeySigningKeyCommand, + DeleteQueryLoggingConfigCommand, + DeleteReusableDelegationSetCommand, + DeleteTrafficPolicyCommand, + DeleteTrafficPolicyInstanceCommand, + DeleteVPCAssociationAuthorizationCommand, + DisableHostedZoneDNSSECCommand, + DisassociateVPCFromHostedZoneCommand, + EnableHostedZoneDNSSECCommand, + GetAccountLimitCommand, + GetChangeCommand, + GetCheckerIpRangesCommand, + GetDNSSECCommand, + GetGeoLocationCommand, + GetHealthCheckCommand, + GetHealthCheckCountCommand, + GetHealthCheckLastFailureReasonCommand, + GetHealthCheckStatusCommand, + GetHostedZoneCommand, + GetHostedZoneCountCommand, + GetHostedZoneLimitCommand, + GetQueryLoggingConfigCommand, + GetReusableDelegationSetCommand, + GetReusableDelegationSetLimitCommand, + GetTrafficPolicyCommand, + GetTrafficPolicyInstanceCommand, + GetTrafficPolicyInstanceCountCommand, + ListCidrBlocksCommand, + ListCidrCollectionsCommand, + ListCidrLocationsCommand, + ListGeoLocationsCommand, + ListHealthChecksCommand, + ListHostedZonesCommand, + ListHostedZonesByNameCommand, + ListHostedZonesByVPCCommand, + ListQueryLoggingConfigsCommand, + ListResourceRecordSetsCommand, + ListReusableDelegationSetsCommand, + ListTagsForResourceCommand, + ListTagsForResourcesCommand, + ListTrafficPoliciesCommand, + ListTrafficPolicyInstancesCommand, + ListTrafficPolicyInstancesByHostedZoneCommand, + ListTrafficPolicyInstancesByPolicyCommand, + ListTrafficPolicyVersionsCommand, + ListVPCAssociationAuthorizationsCommand, + TestDNSAnswerCommand, + UpdateHealthCheckCommand, + UpdateHostedZoneCommentCommand, + UpdateTrafficPolicyCommentCommand, + UpdateTrafficPolicyInstanceCommand, +}; + +export interface Route53 { /** - * @public - *

Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This - * operation changes the KSK status to ACTIVE.

+ * @see {@link ActivateKeySigningKeyCommand} */ - public activateKeySigningKey( + activateKeySigningKey( args: ActivateKeySigningKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public activateKeySigningKey( + activateKeySigningKey( args: ActivateKeySigningKeyCommandInput, cb: (err: any, data?: ActivateKeySigningKeyCommandOutput) => void ): void; - public activateKeySigningKey( + activateKeySigningKey( args: ActivateKeySigningKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ActivateKeySigningKeyCommandOutput) => void ): void; - public activateKeySigningKey( - args: ActivateKeySigningKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ActivateKeySigningKeyCommandOutput) => void), - cb?: (err: any, data?: ActivateKeySigningKeyCommandOutput) => void - ): Promise | void { - const command = new ActivateKeySigningKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates an Amazon VPC with a private hosted zone.

- * - *

To perform the association, the VPC and the private hosted zone must already - * exist. You can't convert a public hosted zone into a private hosted zone.

- *
- * - *

If you want to associate a VPC that was created by using one Amazon Web Services account with a private hosted zone that was created by using a - * different account, the Amazon Web Services account that created the private hosted - * zone must first submit a CreateVPCAssociationAuthorization request. - * Then the account that created the VPC must submit an - * AssociateVPCWithHostedZone request.

- *
- * - *

When granting access, the hosted zone and the Amazon VPC must belong to - * the same partition. A partition is a group of Amazon Web Services Regions. Each - * Amazon Web Services account is scoped to one partition.

- *

The following are the supported partitions:

- *
    - *
  • - *

    - * aws - Amazon Web Services Regions

    - *
  • - *
  • - *

    - * aws-cn - China Regions

    - *
  • - *
  • - *

    - * aws-us-gov - Amazon Web Services GovCloud (US) Region

    - *
  • - *
- *

For more information, see Access Management - * in the Amazon Web Services General Reference.

- *
- */ - public associateVPCWithHostedZone( + + /** + * @see {@link AssociateVPCWithHostedZoneCommand} + */ + associateVPCWithHostedZone( args: AssociateVPCWithHostedZoneCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateVPCWithHostedZone( + associateVPCWithHostedZone( args: AssociateVPCWithHostedZoneCommandInput, cb: (err: any, data?: AssociateVPCWithHostedZoneCommandOutput) => void ): void; - public associateVPCWithHostedZone( + associateVPCWithHostedZone( args: AssociateVPCWithHostedZoneCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateVPCWithHostedZoneCommandOutput) => void ): void; - public associateVPCWithHostedZone( - args: AssociateVPCWithHostedZoneCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateVPCWithHostedZoneCommandOutput) => void), - cb?: (err: any, data?: AssociateVPCWithHostedZoneCommandOutput) => void - ): Promise | void { - const command = new AssociateVPCWithHostedZoneCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates, changes, or deletes CIDR blocks within a collection. Contains authoritative - * IP information mapping blocks to one or multiple locations.

- *

A change request can update multiple locations in a collection at a time, which is - * helpful if you want to move one or more CIDR blocks from one location to another in one - * transaction, without downtime.

- *

- * Limits - *

- *

The max number of CIDR blocks included in the request is 1000. As a result, big updates - * require multiple API calls.

- *

- * PUT and DELETE_IF_EXISTS - *

- *

Use ChangeCidrCollection to perform the following actions:

- *
    - *
  • - *

    - * PUT: Create a CIDR block within the specified collection.

    - *
  • - *
  • - *

    - * DELETE_IF_EXISTS: Delete an existing CIDR block from the - * collection.

    - *
  • - *
- */ - public changeCidrCollection( + + /** + * @see {@link ChangeCidrCollectionCommand} + */ + changeCidrCollection( args: ChangeCidrCollectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public changeCidrCollection( + changeCidrCollection( args: ChangeCidrCollectionCommandInput, cb: (err: any, data?: ChangeCidrCollectionCommandOutput) => void ): void; - public changeCidrCollection( + changeCidrCollection( args: ChangeCidrCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChangeCidrCollectionCommandOutput) => void ): void; - public changeCidrCollection( - args: ChangeCidrCollectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ChangeCidrCollectionCommandOutput) => void), - cb?: (err: any, data?: ChangeCidrCollectionCommandOutput) => void - ): Promise | void { - const command = new ChangeCidrCollectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates, changes, or deletes a resource record set, which contains authoritative DNS - * information for a specified domain name or subdomain name. For example, you can use - * ChangeResourceRecordSets to create a resource record set that routes - * traffic for test.example.com to a web server that has an IP address of - * 192.0.2.44.

- *

- * Deleting Resource Record Sets - *

- *

To delete a resource record set, you must specify all the same values that you - * specified when you created it.

- *

- * Change Batches and Transactional Changes - *

- *

The request body must include a document with a - * ChangeResourceRecordSetsRequest element. The request body contains a - * list of change items, known as a change batch. Change batches are considered - * transactional changes. Route 53 validates the changes in the request and then either - * makes all or none of the changes in the change batch request. This ensures that DNS - * routing isn't adversely affected by partial changes to the resource record sets in a - * hosted zone.

- *

For example, suppose a change batch request contains two changes: it deletes the - * CNAME resource record set for www.example.com and creates an alias - * resource record set for www.example.com. If validation for both records succeeds, Route - * 53 deletes the first resource record set and creates the second resource record set in a - * single operation. If validation for either the DELETE or the - * CREATE action fails, then the request is canceled, and the original - * CNAME record continues to exist.

- * - *

If you try to delete the same resource record set more than once in a single - * change batch, Route 53 returns an InvalidChangeBatch error.

- *
- *

- * Traffic Flow - *

- *

To create resource record sets for complex routing configurations, use either the - * traffic flow visual editor in the Route 53 console or the API actions for traffic - * policies and traffic policy instances. Save the configuration as a traffic policy, then - * associate the traffic policy with one or more domain names (such as example.com) or - * subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted - * zones. You can roll back the updates if the new configuration isn't performing as - * expected. For more information, see Using Traffic Flow to Route - * DNS Traffic in the Amazon Route 53 Developer - * Guide.

- *

- * Create, Delete, and Upsert - *

- *

Use ChangeResourceRecordsSetsRequest to perform the following - * actions:

- *
    - *
  • - *

    - * CREATE: Creates a resource record set that has the specified - * values.

    - *
  • - *
  • - *

    - * DELETE: Deletes an existing resource record set that has the - * specified values.

    - *
  • - *
  • - *

    - * UPSERT: If a resource set exists Route 53 updates it with the - * values in the request.

    - *
  • - *
- *

- * Syntaxes for Creating, Updating, and Deleting Resource Record - * Sets - *

- *

The syntax for a request depends on the type of resource record set that you want to - * create, delete, or update, such as weighted, alias, or failover. The XML elements in - * your request must appear in the order listed in the syntax.

- *

For an example for each type of resource record set, see "Examples."

- *

Don't refer to the syntax in the "Parameter Syntax" section, which includes - * all of the elements for every kind of resource record set that you can create, delete, - * or update by using ChangeResourceRecordSets.

- *

- * Change Propagation to Route 53 DNS Servers - *

- *

When you submit a ChangeResourceRecordSets request, Route 53 propagates - * your changes to all of the Route 53 authoritative DNS servers. While your changes are - * propagating, GetChange returns a status of PENDING. When - * propagation is complete, GetChange returns a status of INSYNC. - * Changes generally propagate to all Route 53 name servers within 60 seconds. For more - * information, see GetChange.

- *

- * Limits on ChangeResourceRecordSets Requests - *

- *

For information about the limits on a ChangeResourceRecordSets request, - * see Limits in the Amazon Route 53 Developer Guide.

- */ - public changeResourceRecordSets( + + /** + * @see {@link ChangeResourceRecordSetsCommand} + */ + changeResourceRecordSets( args: ChangeResourceRecordSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public changeResourceRecordSets( + changeResourceRecordSets( args: ChangeResourceRecordSetsCommandInput, cb: (err: any, data?: ChangeResourceRecordSetsCommandOutput) => void ): void; - public changeResourceRecordSets( + changeResourceRecordSets( args: ChangeResourceRecordSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChangeResourceRecordSetsCommandOutput) => void ): void; - public changeResourceRecordSets( - args: ChangeResourceRecordSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ChangeResourceRecordSetsCommandOutput) => void), - cb?: (err: any, data?: ChangeResourceRecordSetsCommandOutput) => void - ): Promise | void { - const command = new ChangeResourceRecordSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds, edits, or deletes tags for a health check or a hosted zone.

- *

For information about using tags for cost allocation, see Using Cost Allocation - * Tags in the Billing and Cost Management User Guide.

- */ - public changeTagsForResource( + + /** + * @see {@link ChangeTagsForResourceCommand} + */ + changeTagsForResource( args: ChangeTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public changeTagsForResource( + changeTagsForResource( args: ChangeTagsForResourceCommandInput, cb: (err: any, data?: ChangeTagsForResourceCommandOutput) => void ): void; - public changeTagsForResource( + changeTagsForResource( args: ChangeTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChangeTagsForResourceCommandOutput) => void ): void; - public changeTagsForResource( - args: ChangeTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ChangeTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ChangeTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ChangeTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a CIDR collection in the current Amazon Web Services account.

- */ - public createCidrCollection( + + /** + * @see {@link CreateCidrCollectionCommand} + */ + createCidrCollection( args: CreateCidrCollectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCidrCollection( + createCidrCollection( args: CreateCidrCollectionCommandInput, cb: (err: any, data?: CreateCidrCollectionCommandOutput) => void ): void; - public createCidrCollection( + createCidrCollection( args: CreateCidrCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCidrCollectionCommandOutput) => void ): void; - public createCidrCollection( - args: CreateCidrCollectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCidrCollectionCommandOutput) => void), - cb?: (err: any, data?: CreateCidrCollectionCommandOutput) => void - ): Promise | void { - const command = new CreateCidrCollectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new health check.

- *

For information about adding health checks to resource record sets, see HealthCheckId in ChangeResourceRecordSets.

- *

- * ELB Load Balancers - *

- *

If you're registering EC2 instances with an Elastic Load Balancing (ELB) load - * balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you - * register an EC2 instance with a load balancer, you configure settings for an ELB health - * check, which performs a similar function to a Route 53 health check.

- *

- * Private Hosted Zones - *

- *

You can associate health checks with failover resource record sets in a private hosted - * zone. Note the following:

- *
    - *
  • - *

    Route 53 health checkers are outside the VPC. To check the health of an - * endpoint within a VPC by IP address, you must assign a public IP address to the - * instance in the VPC.

    - *
  • - *
  • - *

    You can configure a health checker to check the health of an external resource - * that the instance relies on, such as a database server.

    - *
  • - *
  • - *

    You can create a CloudWatch metric, associate an alarm with the metric, and - * then create a health check that is based on the state of the alarm. For example, - * you might create a CloudWatch metric that checks the status of the Amazon EC2 - * StatusCheckFailed metric, add an alarm to the metric, and then - * create a health check that is based on the state of the alarm. For information - * about creating CloudWatch metrics and alarms by using the CloudWatch console, - * see the Amazon - * CloudWatch User Guide.

    - *
  • - *
- */ - public createHealthCheck( + + /** + * @see {@link CreateHealthCheckCommand} + */ + createHealthCheck( args: CreateHealthCheckCommandInput, options?: __HttpHandlerOptions ): Promise; - public createHealthCheck( + createHealthCheck( args: CreateHealthCheckCommandInput, cb: (err: any, data?: CreateHealthCheckCommandOutput) => void ): void; - public createHealthCheck( + createHealthCheck( args: CreateHealthCheckCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHealthCheckCommandOutput) => void ): void; - public createHealthCheck( - args: CreateHealthCheckCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateHealthCheckCommandOutput) => void), - cb?: (err: any, data?: CreateHealthCheckCommandOutput) => void - ): Promise | void { - const command = new CreateHealthCheckCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new public or private hosted zone. You create records in a public hosted - * zone to define how you want to route traffic on the internet for a domain, such as - * example.com, and its subdomains (apex.example.com, acme.example.com). You create records - * in a private hosted zone to define how you want to route traffic for a domain and its - * subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).

- * - *

You can't convert a public hosted zone to a private hosted zone or vice versa. - * Instead, you must create a new hosted zone with the same name and create new - * resource record sets.

- *
- *

For more information about charges for hosted zones, see Amazon Route 53 Pricing.

- *

Note the following:

- *
    - *
  • - *

    You can't create a hosted zone for a top-level domain (TLD) such as - * .com.

    - *
  • - *
  • - *

    For public hosted zones, Route 53 automatically creates a default SOA record - * and four NS records for the zone. For more information about SOA and NS records, - * see NS and SOA Records - * that Route 53 Creates for a Hosted Zone in the - * Amazon Route 53 Developer Guide.

    - *

    If you want to use the same name servers for multiple public hosted zones, you - * can optionally associate a reusable delegation set with the hosted zone. See the - * DelegationSetId element.

    - *
  • - *
  • - *

    If your domain is registered with a registrar other than Route 53, - * you must update the name servers with your registrar to make Route 53 the DNS - * service for the domain. For more information, see Migrating DNS Service - * for an Existing Domain to Amazon Route 53 in the - * Amazon Route 53 Developer Guide.

    - *
  • - *
- *

When you submit a CreateHostedZone request, the initial status of the - * hosted zone is PENDING. For public hosted zones, this means that the NS and - * SOA records are not yet available on all Route 53 DNS servers. When the NS and - * SOA records are available, the status of the zone changes to INSYNC.

- *

The CreateHostedZone request requires the caller to have an - * ec2:DescribeVpcs permission.

- * - *

When creating private hosted zones, the Amazon VPC must belong to the same - * partition where the hosted zone is created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one - * partition.

- *

The following are the supported partitions:

- *
    - *
  • - *

    - * aws - Amazon Web Services Regions

    - *
  • - *
  • - *

    - * aws-cn - China Regions

    - *
  • - *
  • - *

    - * aws-us-gov - Amazon Web Services GovCloud (US) Region

    - *
  • - *
- *

For more information, see Access Management - * in the Amazon Web Services General Reference.

- *
- */ - public createHostedZone( + + /** + * @see {@link CreateHostedZoneCommand} + */ + createHostedZone( args: CreateHostedZoneCommandInput, options?: __HttpHandlerOptions ): Promise; - public createHostedZone( + createHostedZone( args: CreateHostedZoneCommandInput, cb: (err: any, data?: CreateHostedZoneCommandOutput) => void ): void; - public createHostedZone( + createHostedZone( args: CreateHostedZoneCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHostedZoneCommandOutput) => void ): void; - public createHostedZone( - args: CreateHostedZoneCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateHostedZoneCommandOutput) => void), - cb?: (err: any, data?: CreateHostedZoneCommandOutput) => void - ): Promise | void { - const command = new CreateHostedZoneCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new key-signing key (KSK) associated with a hosted zone. You can only have - * two KSKs per hosted zone.

- */ - public createKeySigningKey( + + /** + * @see {@link CreateKeySigningKeyCommand} + */ + createKeySigningKey( args: CreateKeySigningKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createKeySigningKey( + createKeySigningKey( args: CreateKeySigningKeyCommandInput, cb: (err: any, data?: CreateKeySigningKeyCommandOutput) => void ): void; - public createKeySigningKey( + createKeySigningKey( args: CreateKeySigningKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateKeySigningKeyCommandOutput) => void ): void; - public createKeySigningKey( - args: CreateKeySigningKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateKeySigningKeyCommandOutput) => void), - cb?: (err: any, data?: CreateKeySigningKeyCommandOutput) => void - ): Promise | void { - const command = new CreateKeySigningKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a configuration for DNS query logging. After you create a query logging - * configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs - * log group.

- *

DNS query logs contain information about the queries that Route 53 receives for a - * specified public hosted zone, such as the following:

- *
    - *
  • - *

    Route 53 edge location that responded to the DNS query

    - *
  • - *
  • - *

    Domain or subdomain that was requested

    - *
  • - *
  • - *

    DNS record type, such as A or AAAA

    - *
  • - *
  • - *

    DNS response code, such as NoError or - * ServFail - *

    - *
  • - *
- *
- *
Log Group and Resource Policy
- *
- *

Before you create a query logging configuration, perform the following - * operations.

- * - *

If you create a query logging configuration using the Route 53 - * console, Route 53 performs these operations automatically.

- *
- *
    - *
  1. - *

    Create a CloudWatch Logs log group, and make note of the ARN, - * which you specify when you create a query logging configuration. - * Note the following:

    - *
      - *
    • - *

      You must create the log group in the us-east-1 - * region.

      - *
    • - *
    • - *

      You must use the same Amazon Web Services account to create - * the log group and the hosted zone that you want to configure - * query logging for.

      - *
    • - *
    • - *

      When you create log groups for query logging, we recommend - * that you use a consistent prefix, for example:

      - *

      - * /aws/route53/hosted zone - * name - * - *

      - *

      In the next step, you'll create a resource policy, which - * controls access to one or more log groups and the associated - * Amazon Web Services resources, such as Route 53 hosted - * zones. There's a limit on the number of resource policies - * that you can create, so we recommend that you use a - * consistent prefix so you can use the same resource policy - * for all the log groups that you create for query - * logging.

      - *
    • - *
    - *
  2. - *
  3. - *

    Create a CloudWatch Logs resource policy, and give it the - * permissions that Route 53 needs to create log streams and to send - * query logs to log streams. For the value of Resource, - * specify the ARN for the log group that you created in the previous - * step. To use the same resource policy for all the CloudWatch Logs - * log groups that you created for query logging configurations, - * replace the hosted zone name with *, for - * example:

    - *

    - * arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* - *

    - *

    To avoid the confused deputy problem, a security issue where an - * entity without a permission for an action can coerce a - * more-privileged entity to perform it, you can optionally limit the - * permissions that a service has to a resource in a resource-based - * policy by supplying the following values:

    - *
      - *
    • - *

      For aws:SourceArn, supply the hosted zone ARN - * used in creating the query logging configuration. For - * example, aws:SourceArn: - * arn:aws:route53:::hostedzone/hosted zone - * ID.

      - *
    • - *
    • - *

      For aws:SourceAccount, supply the account ID - * for the account that creates the query logging - * configuration. For example, - * aws:SourceAccount:111111111111.

      - *
    • - *
    - *

    For more information, see The confused - * deputy problem in the Amazon Web Services - * IAM User Guide.

    - * - *

    You can't use the CloudWatch console to create or edit a - * resource policy. You must use the CloudWatch API, one of the - * Amazon Web Services SDKs, or the CLI.

    - *
    - *
  4. - *
- *
- *
Log Streams and Edge Locations
- *
- *

When Route 53 finishes creating the configuration for DNS query logging, - * it does the following:

- *
    - *
  • - *

    Creates a log stream for an edge location the first time that the - * edge location responds to DNS queries for the specified hosted zone. - * That log stream is used to log all queries that Route 53 responds to - * for that edge location.

    - *
  • - *
  • - *

    Begins to send query logs to the applicable log stream.

    - *
  • - *
- *

The name of each log stream is in the following format:

- *

- * - * hosted zone ID/edge location - * code - * - *

- *

The edge location code is a three-letter code and an arbitrarily assigned - * number, for example, DFW3. The three-letter code typically corresponds with - * the International Air Transport Association airport code for an airport near - * the edge location. (These abbreviations might change in the future.) For a - * list of edge locations, see "The Route 53 Global Network" on the Route 53 Product Details - * page.

- *
- *
Queries That Are Logged
- *
- *

Query logs contain only the queries that DNS resolvers forward to Route - * 53. If a DNS resolver has already cached the response to a query (such as - * the IP address for a load balancer for example.com), the resolver will - * continue to return the cached response. It doesn't forward another query to - * Route 53 until the TTL for the corresponding resource record set expires. - * Depending on how many DNS queries are submitted for a resource record set, - * and depending on the TTL for that resource record set, query logs might - * contain information about only one query out of every several thousand - * queries that are submitted to DNS. For more information about how DNS works, - * see Routing - * Internet Traffic to Your Website or Web Application in the - * Amazon Route 53 Developer Guide.

- *
- *
Log File Format
- *
- *

For a list of the values in each query log and the format of each value, - * see Logging DNS - * Queries in the Amazon Route 53 Developer - * Guide.

- *
- *
Pricing
- *
- *

For information about charges for query logs, see Amazon CloudWatch Pricing.

- *
- *
How to Stop Logging
- *
- *

If you want Route 53 to stop sending query logs to CloudWatch Logs, delete - * the query logging configuration. For more information, see DeleteQueryLoggingConfig.

- *
- *
- */ - public createQueryLoggingConfig( + + /** + * @see {@link CreateQueryLoggingConfigCommand} + */ + createQueryLoggingConfig( args: CreateQueryLoggingConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public createQueryLoggingConfig( + createQueryLoggingConfig( args: CreateQueryLoggingConfigCommandInput, cb: (err: any, data?: CreateQueryLoggingConfigCommandOutput) => void ): void; - public createQueryLoggingConfig( + createQueryLoggingConfig( args: CreateQueryLoggingConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateQueryLoggingConfigCommandOutput) => void ): void; - public createQueryLoggingConfig( - args: CreateQueryLoggingConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateQueryLoggingConfigCommandOutput) => void), - cb?: (err: any, data?: CreateQueryLoggingConfigCommandOutput) => void - ): Promise | void { - const command = new CreateQueryLoggingConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a delegation set (a group of four name servers) that can be reused by multiple - * hosted zones that were created by the same Amazon Web Services account.

- *

You can also create a reusable delegation set that uses the four name servers that are - * associated with an existing hosted zone. Specify the hosted zone ID in the - * CreateReusableDelegationSet request.

- * - *

You can't associate a reusable delegation set with a private hosted zone.

- *
- *

For information about using a reusable delegation set to configure white label name - * servers, see Configuring White - * Label Name Servers.

- *

The process for migrating existing hosted zones to use a reusable delegation set is - * comparable to the process for configuring white label name servers. You need to perform - * the following steps:

- *
    - *
  1. - *

    Create a reusable delegation set.

    - *
  2. - *
  3. - *

    Recreate hosted zones, and reduce the TTL to 60 seconds or less.

    - *
  4. - *
  5. - *

    Recreate resource record sets in the new hosted zones.

    - *
  6. - *
  7. - *

    Change the registrar's name servers to use the name servers for the new hosted - * zones.

    - *
  8. - *
  9. - *

    Monitor traffic for the website or application.

    - *
  10. - *
  11. - *

    Change TTLs back to their original values.

    - *
  12. - *
- *

If you want to migrate existing hosted zones to use a reusable delegation set, the - * existing hosted zones can't use any of the name servers that are assigned to the - * reusable delegation set. If one or more hosted zones do use one or more name servers - * that are assigned to the reusable delegation set, you can do one of the - * following:

- *
    - *
  • - *

    For small numbers of hosted zones—up to a few hundred—it's - * relatively easy to create reusable delegation sets until you get one that has - * four name servers that don't overlap with any of the name servers in your hosted - * zones.

    - *
  • - *
  • - *

    For larger numbers of hosted zones, the easiest solution is to use more than - * one reusable delegation set.

    - *
  • - *
  • - *

    For larger numbers of hosted zones, you can also migrate hosted zones that - * have overlapping name servers to hosted zones that don't have overlapping name - * servers, then migrate the hosted zones again to use the reusable delegation - * set.

    - *
  • - *
- */ - public createReusableDelegationSet( + + /** + * @see {@link CreateReusableDelegationSetCommand} + */ + createReusableDelegationSet( args: CreateReusableDelegationSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createReusableDelegationSet( + createReusableDelegationSet( args: CreateReusableDelegationSetCommandInput, cb: (err: any, data?: CreateReusableDelegationSetCommandOutput) => void ): void; - public createReusableDelegationSet( + createReusableDelegationSet( args: CreateReusableDelegationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReusableDelegationSetCommandOutput) => void ): void; - public createReusableDelegationSet( - args: CreateReusableDelegationSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateReusableDelegationSetCommandOutput) => void), - cb?: (err: any, data?: CreateReusableDelegationSetCommandOutput) => void - ): Promise | void { - const command = new CreateReusableDelegationSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a traffic policy, which you use to create multiple DNS resource record sets - * for one domain name (such as example.com) or one subdomain name (such as - * www.example.com).

- */ - public createTrafficPolicy( + + /** + * @see {@link CreateTrafficPolicyCommand} + */ + createTrafficPolicy( args: CreateTrafficPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTrafficPolicy( + createTrafficPolicy( args: CreateTrafficPolicyCommandInput, cb: (err: any, data?: CreateTrafficPolicyCommandOutput) => void ): void; - public createTrafficPolicy( + createTrafficPolicy( args: CreateTrafficPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTrafficPolicyCommandOutput) => void ): void; - public createTrafficPolicy( - args: CreateTrafficPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTrafficPolicyCommandOutput) => void), - cb?: (err: any, data?: CreateTrafficPolicyCommandOutput) => void - ): Promise | void { - const command = new CreateTrafficPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates resource record sets in a specified hosted zone based on the settings in a - * specified traffic policy version. In addition, CreateTrafficPolicyInstance - * associates the resource record sets with a specified domain name (such as example.com) - * or subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for - * the domain or subdomain name by using the resource record sets that - * CreateTrafficPolicyInstance created.

- */ - public createTrafficPolicyInstance( + + /** + * @see {@link CreateTrafficPolicyInstanceCommand} + */ + createTrafficPolicyInstance( args: CreateTrafficPolicyInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTrafficPolicyInstance( + createTrafficPolicyInstance( args: CreateTrafficPolicyInstanceCommandInput, cb: (err: any, data?: CreateTrafficPolicyInstanceCommandOutput) => void ): void; - public createTrafficPolicyInstance( + createTrafficPolicyInstance( args: CreateTrafficPolicyInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTrafficPolicyInstanceCommandOutput) => void ): void; - public createTrafficPolicyInstance( - args: CreateTrafficPolicyInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTrafficPolicyInstanceCommandOutput) => void), - cb?: (err: any, data?: CreateTrafficPolicyInstanceCommandOutput) => void - ): Promise | void { - const command = new CreateTrafficPolicyInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new version of an existing traffic policy. When you create a new version of - * a traffic policy, you specify the ID of the traffic policy that you want to update and a - * JSON-formatted document that describes the new version. You use traffic policies to - * create multiple DNS resource record sets for one domain name (such as example.com) or - * one subdomain name (such as www.example.com). You can create a maximum of 1000 versions - * of a traffic policy. If you reach the limit and need to create another version, you'll - * need to start a new traffic policy.

- */ - public createTrafficPolicyVersion( + + /** + * @see {@link CreateTrafficPolicyVersionCommand} + */ + createTrafficPolicyVersion( args: CreateTrafficPolicyVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTrafficPolicyVersion( + createTrafficPolicyVersion( args: CreateTrafficPolicyVersionCommandInput, cb: (err: any, data?: CreateTrafficPolicyVersionCommandOutput) => void ): void; - public createTrafficPolicyVersion( + createTrafficPolicyVersion( args: CreateTrafficPolicyVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTrafficPolicyVersionCommandOutput) => void ): void; - public createTrafficPolicyVersion( - args: CreateTrafficPolicyVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTrafficPolicyVersionCommandOutput) => void), - cb?: (err: any, data?: CreateTrafficPolicyVersionCommandOutput) => void - ): Promise | void { - const command = new CreateTrafficPolicyVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Authorizes the Amazon Web Services account that created a specified VPC to submit an - * AssociateVPCWithHostedZone request to associate the VPC with a - * specified hosted zone that was created by a different account. To submit a - * CreateVPCAssociationAuthorization request, you must use the account - * that created the hosted zone. After you authorize the association, use the account that - * created the VPC to submit an AssociateVPCWithHostedZone request.

- * - *

If you want to associate multiple VPCs that you created by using one account with - * a hosted zone that you created by using a different account, you must submit one - * authorization request for each VPC.

- *
- */ - public createVPCAssociationAuthorization( + + /** + * @see {@link CreateVPCAssociationAuthorizationCommand} + */ + createVPCAssociationAuthorization( args: CreateVPCAssociationAuthorizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVPCAssociationAuthorization( + createVPCAssociationAuthorization( args: CreateVPCAssociationAuthorizationCommandInput, cb: (err: any, data?: CreateVPCAssociationAuthorizationCommandOutput) => void ): void; - public createVPCAssociationAuthorization( + createVPCAssociationAuthorization( args: CreateVPCAssociationAuthorizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVPCAssociationAuthorizationCommandOutput) => void ): void; - public createVPCAssociationAuthorization( - args: CreateVPCAssociationAuthorizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVPCAssociationAuthorizationCommandOutput) => void), - cb?: (err: any, data?: CreateVPCAssociationAuthorizationCommandOutput) => void - ): Promise | void { - const command = new CreateVPCAssociationAuthorizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC. - * This operation changes the KSK status to INACTIVE.

- */ - public deactivateKeySigningKey( + + /** + * @see {@link DeactivateKeySigningKeyCommand} + */ + deactivateKeySigningKey( args: DeactivateKeySigningKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deactivateKeySigningKey( + deactivateKeySigningKey( args: DeactivateKeySigningKeyCommandInput, cb: (err: any, data?: DeactivateKeySigningKeyCommandOutput) => void ): void; - public deactivateKeySigningKey( + deactivateKeySigningKey( args: DeactivateKeySigningKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeactivateKeySigningKeyCommandOutput) => void ): void; - public deactivateKeySigningKey( - args: DeactivateKeySigningKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeactivateKeySigningKeyCommandOutput) => void), - cb?: (err: any, data?: DeactivateKeySigningKeyCommandOutput) => void - ): Promise | void { - const command = new DeactivateKeySigningKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a CIDR collection in the current Amazon Web Services account. The collection - * must be empty before it can be deleted.

- */ - public deleteCidrCollection( + + /** + * @see {@link DeleteCidrCollectionCommand} + */ + deleteCidrCollection( args: DeleteCidrCollectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCidrCollection( + deleteCidrCollection( args: DeleteCidrCollectionCommandInput, cb: (err: any, data?: DeleteCidrCollectionCommandOutput) => void ): void; - public deleteCidrCollection( + deleteCidrCollection( args: DeleteCidrCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCidrCollectionCommandOutput) => void ): void; - public deleteCidrCollection( - args: DeleteCidrCollectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCidrCollectionCommandOutput) => void), - cb?: (err: any, data?: DeleteCidrCollectionCommandOutput) => void - ): Promise | void { - const command = new DeleteCidrCollectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a health check.

- * - *

Amazon Route 53 does not prevent you from deleting a health check even if the - * health check is associated with one or more resource record sets. If you delete a - * health check and you don't update the associated resource record sets, the future - * status of the health check can't be predicted and may change. This will affect the - * routing of DNS queries for your DNS failover configuration. For more information, - * see Replacing and Deleting Health Checks in the Amazon Route 53 - * Developer Guide.

- *
- *

If you're using Cloud Map and you configured Cloud Map to create a Route 53 - * health check when you register an instance, you can't use the Route 53 - * DeleteHealthCheck command to delete the health check. The health check - * is deleted automatically when you deregister the instance; there can be a delay of - * several hours before the health check is deleted from Route 53.

- */ - public deleteHealthCheck( + + /** + * @see {@link DeleteHealthCheckCommand} + */ + deleteHealthCheck( args: DeleteHealthCheckCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteHealthCheck( + deleteHealthCheck( args: DeleteHealthCheckCommandInput, cb: (err: any, data?: DeleteHealthCheckCommandOutput) => void ): void; - public deleteHealthCheck( + deleteHealthCheck( args: DeleteHealthCheckCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHealthCheckCommandOutput) => void ): void; - public deleteHealthCheck( - args: DeleteHealthCheckCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteHealthCheckCommandOutput) => void), - cb?: (err: any, data?: DeleteHealthCheckCommandOutput) => void - ): Promise | void { - const command = new DeleteHealthCheckCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a hosted zone.

- *

If the hosted zone was created by another service, such as Cloud Map, see - * Deleting Public Hosted Zones That Were Created by Another Service in the - * Amazon Route 53 Developer Guide for information - * about how to delete it. (The process is the same for public and private hosted zones - * that were created by another service.)

- *

If you want to keep your domain registration but you want to stop routing internet - * traffic to your website or web application, we recommend that you delete resource record - * sets in the hosted zone instead of deleting the hosted zone.

- * - *

If you delete a hosted zone, you can't undelete it. You must create a new hosted - * zone and update the name servers for your domain registration, which can require up - * to 48 hours to take effect. (If you delegated responsibility for a subdomain to a - * hosted zone and you delete the child hosted zone, you must update the name servers - * in the parent hosted zone.) In addition, if you delete a hosted zone, someone could - * hijack the domain and route traffic to their own resources using your domain - * name.

- *
- *

If you want to avoid the monthly charge for the hosted zone, you can transfer DNS - * service for the domain to a free DNS service. When you transfer DNS service, you have to - * update the name servers for the domain registration. If the domain is registered with - * Route 53, see UpdateDomainNameservers for information about how to replace Route 53 name servers with name servers for the new DNS service. If the domain is - * registered with another registrar, use the method provided by the registrar to update - * name servers for the domain registration. For more information, perform an internet - * search on "free DNS service."

- *

You can delete a hosted zone only if it contains only the default SOA record and NS - * resource record sets. If the hosted zone contains other resource record sets, you must - * delete them before you can delete the hosted zone. If you try to delete a hosted zone - * that contains other resource record sets, the request fails, and Route 53 - * returns a HostedZoneNotEmpty error. For information about deleting records - * from your hosted zone, see ChangeResourceRecordSets.

- *

To verify that the hosted zone has been deleted, do one of the following:

- *
    - *
  • - *

    Use the GetHostedZone action to request information about the - * hosted zone.

    - *
  • - *
  • - *

    Use the ListHostedZones action to get a list of the hosted zones - * associated with the current Amazon Web Services account.

    - *
  • - *
- */ - public deleteHostedZone( + + /** + * @see {@link DeleteHostedZoneCommand} + */ + deleteHostedZone( args: DeleteHostedZoneCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteHostedZone( + deleteHostedZone( args: DeleteHostedZoneCommandInput, cb: (err: any, data?: DeleteHostedZoneCommandOutput) => void ): void; - public deleteHostedZone( + deleteHostedZone( args: DeleteHostedZoneCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHostedZoneCommandOutput) => void ): void; - public deleteHostedZone( - args: DeleteHostedZoneCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteHostedZoneCommandOutput) => void), - cb?: (err: any, data?: DeleteHostedZoneCommandOutput) => void - ): Promise | void { - const command = new DeleteHostedZoneCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a key-signing key (KSK). Before you can delete a KSK, you must deactivate it. - * The KSK must be deactivated before you can delete it regardless of whether the hosted - * zone is enabled for DNSSEC signing.

- *

You can use DeactivateKeySigningKey to deactivate the key before you delete it.

- *

Use GetDNSSEC to verify that the KSK is in an INACTIVE - * status.

- */ - public deleteKeySigningKey( + + /** + * @see {@link DeleteKeySigningKeyCommand} + */ + deleteKeySigningKey( args: DeleteKeySigningKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteKeySigningKey( + deleteKeySigningKey( args: DeleteKeySigningKeyCommandInput, cb: (err: any, data?: DeleteKeySigningKeyCommandOutput) => void ): void; - public deleteKeySigningKey( + deleteKeySigningKey( args: DeleteKeySigningKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteKeySigningKeyCommandOutput) => void ): void; - public deleteKeySigningKey( - args: DeleteKeySigningKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteKeySigningKeyCommandOutput) => void), - cb?: (err: any, data?: DeleteKeySigningKeyCommandOutput) => void - ): Promise | void { - const command = new DeleteKeySigningKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a configuration for DNS query logging. If you delete a configuration, Amazon - * Route 53 stops sending query logs to CloudWatch Logs. Route 53 doesn't delete any logs - * that are already in CloudWatch Logs.

- *

For more information about DNS query logs, see CreateQueryLoggingConfig.

- */ - public deleteQueryLoggingConfig( + + /** + * @see {@link DeleteQueryLoggingConfigCommand} + */ + deleteQueryLoggingConfig( args: DeleteQueryLoggingConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteQueryLoggingConfig( + deleteQueryLoggingConfig( args: DeleteQueryLoggingConfigCommandInput, cb: (err: any, data?: DeleteQueryLoggingConfigCommandOutput) => void ): void; - public deleteQueryLoggingConfig( + deleteQueryLoggingConfig( args: DeleteQueryLoggingConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteQueryLoggingConfigCommandOutput) => void ): void; - public deleteQueryLoggingConfig( - args: DeleteQueryLoggingConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteQueryLoggingConfigCommandOutput) => void), - cb?: (err: any, data?: DeleteQueryLoggingConfigCommandOutput) => void - ): Promise | void { - const command = new DeleteQueryLoggingConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a reusable delegation set.

- * - *

You can delete a reusable delegation set only if it isn't associated with any - * hosted zones.

- *
- *

To verify that the reusable delegation set is not associated with any hosted zones, - * submit a GetReusableDelegationSet request and specify the ID of the reusable - * delegation set that you want to delete.

- */ - public deleteReusableDelegationSet( + + /** + * @see {@link DeleteReusableDelegationSetCommand} + */ + deleteReusableDelegationSet( args: DeleteReusableDelegationSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteReusableDelegationSet( + deleteReusableDelegationSet( args: DeleteReusableDelegationSetCommandInput, cb: (err: any, data?: DeleteReusableDelegationSetCommandOutput) => void ): void; - public deleteReusableDelegationSet( + deleteReusableDelegationSet( args: DeleteReusableDelegationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReusableDelegationSetCommandOutput) => void ): void; - public deleteReusableDelegationSet( - args: DeleteReusableDelegationSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteReusableDelegationSetCommandOutput) => void), - cb?: (err: any, data?: DeleteReusableDelegationSetCommandOutput) => void - ): Promise | void { - const command = new DeleteReusableDelegationSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a traffic policy.

- *

When you delete a traffic policy, Route 53 sets a flag on the policy to indicate that - * it has been deleted. However, Route 53 never fully deletes the traffic policy. Note the - * following:

- *
    - *
  • - *

    Deleted traffic policies aren't listed if you run ListTrafficPolicies.

    - *
  • - *
  • - *

    There's no way to get a list of deleted policies.

    - *
  • - *
  • - *

    If you retain the ID of the policy, you can get information about the policy, - * including the traffic policy document, by running GetTrafficPolicy.

    - *
  • - *
- */ - public deleteTrafficPolicy( + + /** + * @see {@link DeleteTrafficPolicyCommand} + */ + deleteTrafficPolicy( args: DeleteTrafficPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTrafficPolicy( + deleteTrafficPolicy( args: DeleteTrafficPolicyCommandInput, cb: (err: any, data?: DeleteTrafficPolicyCommandOutput) => void ): void; - public deleteTrafficPolicy( + deleteTrafficPolicy( args: DeleteTrafficPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTrafficPolicyCommandOutput) => void ): void; - public deleteTrafficPolicy( - args: DeleteTrafficPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTrafficPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteTrafficPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteTrafficPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a traffic policy instance and all of the resource record sets that Amazon - * Route 53 created when you created the instance.

- * - *

In the Route 53 console, traffic policy instances are known as policy - * records.

- *
- */ - public deleteTrafficPolicyInstance( + + /** + * @see {@link DeleteTrafficPolicyInstanceCommand} + */ + deleteTrafficPolicyInstance( args: DeleteTrafficPolicyInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTrafficPolicyInstance( + deleteTrafficPolicyInstance( args: DeleteTrafficPolicyInstanceCommandInput, cb: (err: any, data?: DeleteTrafficPolicyInstanceCommandOutput) => void ): void; - public deleteTrafficPolicyInstance( + deleteTrafficPolicyInstance( args: DeleteTrafficPolicyInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTrafficPolicyInstanceCommandOutput) => void ): void; - public deleteTrafficPolicyInstance( - args: DeleteTrafficPolicyInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTrafficPolicyInstanceCommandOutput) => void), - cb?: (err: any, data?: DeleteTrafficPolicyInstanceCommandOutput) => void - ): Promise | void { - const command = new DeleteTrafficPolicyInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes authorization to submit an AssociateVPCWithHostedZone request to - * associate a specified VPC with a hosted zone that was created by a different account. - * You must use the account that created the hosted zone to submit a - * DeleteVPCAssociationAuthorization request.

- * - *

Sending this request only prevents the Amazon Web Services account that created the - * VPC from associating the VPC with the Amazon Route 53 hosted zone in the future. If - * the VPC is already associated with the hosted zone, - * DeleteVPCAssociationAuthorization won't disassociate the VPC from - * the hosted zone. If you want to delete an existing association, use - * DisassociateVPCFromHostedZone.

- *
- */ - public deleteVPCAssociationAuthorization( + + /** + * @see {@link DeleteVPCAssociationAuthorizationCommand} + */ + deleteVPCAssociationAuthorization( args: DeleteVPCAssociationAuthorizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVPCAssociationAuthorization( + deleteVPCAssociationAuthorization( args: DeleteVPCAssociationAuthorizationCommandInput, cb: (err: any, data?: DeleteVPCAssociationAuthorizationCommandOutput) => void ): void; - public deleteVPCAssociationAuthorization( + deleteVPCAssociationAuthorization( args: DeleteVPCAssociationAuthorizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVPCAssociationAuthorizationCommandOutput) => void ): void; - public deleteVPCAssociationAuthorization( - args: DeleteVPCAssociationAuthorizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVPCAssociationAuthorizationCommandOutput) => void), - cb?: (err: any, data?: DeleteVPCAssociationAuthorizationCommandOutput) => void - ): Promise | void { - const command = new DeleteVPCAssociationAuthorizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables DNSSEC signing in a specific hosted zone. This action does not deactivate any - * key-signing keys (KSKs) that are active in the hosted zone.

- */ - public disableHostedZoneDNSSEC( + + /** + * @see {@link DisableHostedZoneDNSSECCommand} + */ + disableHostedZoneDNSSEC( args: DisableHostedZoneDNSSECCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableHostedZoneDNSSEC( + disableHostedZoneDNSSEC( args: DisableHostedZoneDNSSECCommandInput, cb: (err: any, data?: DisableHostedZoneDNSSECCommandOutput) => void ): void; - public disableHostedZoneDNSSEC( + disableHostedZoneDNSSEC( args: DisableHostedZoneDNSSECCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableHostedZoneDNSSECCommandOutput) => void ): void; - public disableHostedZoneDNSSEC( - args: DisableHostedZoneDNSSECCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableHostedZoneDNSSECCommandOutput) => void), - cb?: (err: any, data?: DisableHostedZoneDNSSECCommandOutput) => void - ): Promise | void { - const command = new DisableHostedZoneDNSSECCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 - * private hosted zone. Note the following:

- *
    - *
  • - *

    You can't disassociate the last Amazon VPC from a private hosted zone.

    - *
  • - *
  • - *

    You can't convert a private hosted zone into a public hosted zone.

    - *
  • - *
  • - *

    You can submit a DisassociateVPCFromHostedZone request using - * either the account that created the hosted zone or the account that created the - * Amazon VPC.

    - *
  • - *
  • - *

    Some services, such as Cloud Map and Amazon Elastic File System - * (Amazon EFS) automatically create hosted zones and associate VPCs with the - * hosted zones. A service can create a hosted zone using your account or using its - * own account. You can disassociate a VPC from a hosted zone only if the service - * created the hosted zone using your account.

    - *

    When you run DisassociateVPCFromHostedZone, if the hosted zone has a value for - * OwningAccount, you can use - * DisassociateVPCFromHostedZone. If the hosted zone has a value - * for OwningService, you can't use - * DisassociateVPCFromHostedZone.

    - *
  • - *
- * - *

When revoking access, the hosted zone and the Amazon VPC must belong to - * the same partition. A partition is a group of Amazon Web Services Regions. Each - * Amazon Web Services account is scoped to one partition.

- *

The following are the supported partitions:

- *
    - *
  • - *

    - * aws - Amazon Web Services Regions

    - *
  • - *
  • - *

    - * aws-cn - China Regions

    - *
  • - *
  • - *

    - * aws-us-gov - Amazon Web Services GovCloud (US) Region

    - *
  • - *
- *

For more information, see Access Management - * in the Amazon Web Services General Reference.

- *
- */ - public disassociateVPCFromHostedZone( + + /** + * @see {@link DisassociateVPCFromHostedZoneCommand} + */ + disassociateVPCFromHostedZone( args: DisassociateVPCFromHostedZoneCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateVPCFromHostedZone( + disassociateVPCFromHostedZone( args: DisassociateVPCFromHostedZoneCommandInput, cb: (err: any, data?: DisassociateVPCFromHostedZoneCommandOutput) => void ): void; - public disassociateVPCFromHostedZone( + disassociateVPCFromHostedZone( args: DisassociateVPCFromHostedZoneCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateVPCFromHostedZoneCommandOutput) => void ): void; - public disassociateVPCFromHostedZone( - args: DisassociateVPCFromHostedZoneCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateVPCFromHostedZoneCommandOutput) => void), - cb?: (err: any, data?: DisassociateVPCFromHostedZoneCommandOutput) => void - ): Promise | void { - const command = new DisassociateVPCFromHostedZoneCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables DNSSEC signing in a specific hosted zone.

- */ - public enableHostedZoneDNSSEC( + + /** + * @see {@link EnableHostedZoneDNSSECCommand} + */ + enableHostedZoneDNSSEC( args: EnableHostedZoneDNSSECCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableHostedZoneDNSSEC( + enableHostedZoneDNSSEC( args: EnableHostedZoneDNSSECCommandInput, cb: (err: any, data?: EnableHostedZoneDNSSECCommandOutput) => void ): void; - public enableHostedZoneDNSSEC( + enableHostedZoneDNSSEC( args: EnableHostedZoneDNSSECCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableHostedZoneDNSSECCommandOutput) => void ): void; - public enableHostedZoneDNSSEC( - args: EnableHostedZoneDNSSECCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableHostedZoneDNSSECCommandOutput) => void), - cb?: (err: any, data?: EnableHostedZoneDNSSECCommandOutput) => void - ): Promise | void { - const command = new EnableHostedZoneDNSSECCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the specified limit for the current account, for example, the maximum number of - * health checks that you can create using the account.

- *

For the default limit, see Limits in the - * Amazon Route 53 Developer Guide. To request a higher limit, - * open a case.

- * - *

You can also view account limits in Amazon Web Services Trusted Advisor. Sign in to - * the Amazon Web Services Management Console and open the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/. Then choose Service limits in the navigation pane.

- *
- */ - public getAccountLimit( + + /** + * @see {@link GetAccountLimitCommand} + */ + getAccountLimit( args: GetAccountLimitCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccountLimit( - args: GetAccountLimitCommandInput, - cb: (err: any, data?: GetAccountLimitCommandOutput) => void - ): void; - public getAccountLimit( + getAccountLimit(args: GetAccountLimitCommandInput, cb: (err: any, data?: GetAccountLimitCommandOutput) => void): void; + getAccountLimit( args: GetAccountLimitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountLimitCommandOutput) => void ): void; - public getAccountLimit( - args: GetAccountLimitCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccountLimitCommandOutput) => void), - cb?: (err: any, data?: GetAccountLimitCommandOutput) => void - ): Promise | void { - const command = new GetAccountLimitCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the current status of a change batch request. The status is one of the - * following values:

- *
    - *
  • - *

    - * PENDING indicates that the changes in this request have not - * propagated to all Amazon Route 53 DNS servers. This is the initial status of all - * change batch requests.

    - *
  • - *
  • - *

    - * INSYNC indicates that the changes have propagated to all Route 53 - * DNS servers.

    - *
  • - *
- */ - public getChange(args: GetChangeCommandInput, options?: __HttpHandlerOptions): Promise; - public getChange(args: GetChangeCommandInput, cb: (err: any, data?: GetChangeCommandOutput) => void): void; - public getChange( + + /** + * @see {@link GetChangeCommand} + */ + getChange(args: GetChangeCommandInput, options?: __HttpHandlerOptions): Promise; + getChange(args: GetChangeCommandInput, cb: (err: any, data?: GetChangeCommandOutput) => void): void; + getChange( args: GetChangeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChangeCommandOutput) => void ): void; - public getChange( - args: GetChangeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetChangeCommandOutput) => void), - cb?: (err: any, data?: GetChangeCommandOutput) => void - ): Promise | void { - const command = new GetChangeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Route 53 does not perform authorization for this API because it retrieves information - * that is already available to the public.

- * - *

- * GetCheckerIpRanges still works, but we recommend that you download - * ip-ranges.json, which includes IP address ranges for all Amazon Web Services - * services. For more information, see IP Address Ranges - * of Amazon Route 53 Servers in the Amazon Route 53 Developer - * Guide.

- *
- */ - public getCheckerIpRanges( + + /** + * @see {@link GetCheckerIpRangesCommand} + */ + getCheckerIpRanges( args: GetCheckerIpRangesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCheckerIpRanges( + getCheckerIpRanges( args: GetCheckerIpRangesCommandInput, cb: (err: any, data?: GetCheckerIpRangesCommandOutput) => void ): void; - public getCheckerIpRanges( + getCheckerIpRanges( args: GetCheckerIpRangesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCheckerIpRangesCommandOutput) => void ): void; - public getCheckerIpRanges( - args: GetCheckerIpRangesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCheckerIpRangesCommandOutput) => void), - cb?: (err: any, data?: GetCheckerIpRangesCommandOutput) => void - ): Promise | void { - const command = new GetCheckerIpRangesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about DNSSEC for a specific hosted zone, including the key-signing - * keys (KSKs) in the hosted zone.

- */ - public getDNSSEC(args: GetDNSSECCommandInput, options?: __HttpHandlerOptions): Promise; - public getDNSSEC(args: GetDNSSECCommandInput, cb: (err: any, data?: GetDNSSECCommandOutput) => void): void; - public getDNSSEC( + + /** + * @see {@link GetDNSSECCommand} + */ + getDNSSEC(args: GetDNSSECCommandInput, options?: __HttpHandlerOptions): Promise; + getDNSSEC(args: GetDNSSECCommandInput, cb: (err: any, data?: GetDNSSECCommandOutput) => void): void; + getDNSSEC( args: GetDNSSECCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDNSSECCommandOutput) => void ): void; - public getDNSSEC( - args: GetDNSSECCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDNSSECCommandOutput) => void), - cb?: (err: any, data?: GetDNSSECCommandOutput) => void - ): Promise | void { - const command = new GetDNSSECCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about whether a specified geographic location is supported for Amazon - * Route 53 geolocation resource record sets.

- *

Route 53 does not perform authorization for this API because it retrieves information - * that is already available to the public.

- *

Use the following syntax to determine whether a continent is supported for - * geolocation:

- *

- * GET /2013-04-01/geolocation?continentcode=two-letter abbreviation for - * a continent - * - *

- *

Use the following syntax to determine whether a country is supported for - * geolocation:

- *

- * GET /2013-04-01/geolocation?countrycode=two-character country - * code - * - *

- *

Use the following syntax to determine whether a subdivision of a country is supported - * for geolocation:

- *

- * GET /2013-04-01/geolocation?countrycode=two-character country - * code&subdivisioncode=subdivision - * code - * - *

- */ - public getGeoLocation( + + /** + * @see {@link GetGeoLocationCommand} + */ + getGeoLocation( args: GetGeoLocationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getGeoLocation( - args: GetGeoLocationCommandInput, - cb: (err: any, data?: GetGeoLocationCommandOutput) => void - ): void; - public getGeoLocation( + getGeoLocation(args: GetGeoLocationCommandInput, cb: (err: any, data?: GetGeoLocationCommandOutput) => void): void; + getGeoLocation( args: GetGeoLocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGeoLocationCommandOutput) => void ): void; - public getGeoLocation( - args: GetGeoLocationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGeoLocationCommandOutput) => void), - cb?: (err: any, data?: GetGeoLocationCommandOutput) => void - ): Promise | void { - const command = new GetGeoLocationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a specified health check.

- */ - public getHealthCheck( + + /** + * @see {@link GetHealthCheckCommand} + */ + getHealthCheck( args: GetHealthCheckCommandInput, options?: __HttpHandlerOptions ): Promise; - public getHealthCheck( - args: GetHealthCheckCommandInput, - cb: (err: any, data?: GetHealthCheckCommandOutput) => void - ): void; - public getHealthCheck( + getHealthCheck(args: GetHealthCheckCommandInput, cb: (err: any, data?: GetHealthCheckCommandOutput) => void): void; + getHealthCheck( args: GetHealthCheckCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHealthCheckCommandOutput) => void ): void; - public getHealthCheck( - args: GetHealthCheckCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetHealthCheckCommandOutput) => void), - cb?: (err: any, data?: GetHealthCheckCommandOutput) => void - ): Promise | void { - const command = new GetHealthCheckCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the number of health checks that are associated with the current Amazon Web Services account.

- */ - public getHealthCheckCount( + + /** + * @see {@link GetHealthCheckCountCommand} + */ + getHealthCheckCount( args: GetHealthCheckCountCommandInput, options?: __HttpHandlerOptions ): Promise; - public getHealthCheckCount( + getHealthCheckCount( args: GetHealthCheckCountCommandInput, cb: (err: any, data?: GetHealthCheckCountCommandOutput) => void ): void; - public getHealthCheckCount( + getHealthCheckCount( args: GetHealthCheckCountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHealthCheckCountCommandOutput) => void ): void; - public getHealthCheckCount( - args: GetHealthCheckCountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetHealthCheckCountCommandOutput) => void), - cb?: (err: any, data?: GetHealthCheckCountCommandOutput) => void - ): Promise | void { - const command = new GetHealthCheckCountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the reason that a specified health check failed most recently.

- */ - public getHealthCheckLastFailureReason( + + /** + * @see {@link GetHealthCheckLastFailureReasonCommand} + */ + getHealthCheckLastFailureReason( args: GetHealthCheckLastFailureReasonCommandInput, options?: __HttpHandlerOptions ): Promise; - public getHealthCheckLastFailureReason( + getHealthCheckLastFailureReason( args: GetHealthCheckLastFailureReasonCommandInput, cb: (err: any, data?: GetHealthCheckLastFailureReasonCommandOutput) => void ): void; - public getHealthCheckLastFailureReason( + getHealthCheckLastFailureReason( args: GetHealthCheckLastFailureReasonCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHealthCheckLastFailureReasonCommandOutput) => void ): void; - public getHealthCheckLastFailureReason( - args: GetHealthCheckLastFailureReasonCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetHealthCheckLastFailureReasonCommandOutput) => void), - cb?: (err: any, data?: GetHealthCheckLastFailureReasonCommandOutput) => void - ): Promise | void { - const command = new GetHealthCheckLastFailureReasonCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets status of a specified health check.

- * - *

This API is intended for use during development to diagnose behavior. It doesn’t - * support production use-cases with high query rates that require immediate and - * actionable responses.

- *
- */ - public getHealthCheckStatus( + + /** + * @see {@link GetHealthCheckStatusCommand} + */ + getHealthCheckStatus( args: GetHealthCheckStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getHealthCheckStatus( + getHealthCheckStatus( args: GetHealthCheckStatusCommandInput, cb: (err: any, data?: GetHealthCheckStatusCommandOutput) => void ): void; - public getHealthCheckStatus( + getHealthCheckStatus( args: GetHealthCheckStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHealthCheckStatusCommandOutput) => void ): void; - public getHealthCheckStatus( - args: GetHealthCheckStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetHealthCheckStatusCommandOutput) => void), - cb?: (err: any, data?: GetHealthCheckStatusCommandOutput) => void - ): Promise | void { - const command = new GetHealthCheckStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a specified hosted zone including the four name servers - * assigned to the hosted zone.

- */ - public getHostedZone( - args: GetHostedZoneCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getHostedZone( - args: GetHostedZoneCommandInput, - cb: (err: any, data?: GetHostedZoneCommandOutput) => void - ): void; - public getHostedZone( + + /** + * @see {@link GetHostedZoneCommand} + */ + getHostedZone(args: GetHostedZoneCommandInput, options?: __HttpHandlerOptions): Promise; + getHostedZone(args: GetHostedZoneCommandInput, cb: (err: any, data?: GetHostedZoneCommandOutput) => void): void; + getHostedZone( args: GetHostedZoneCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHostedZoneCommandOutput) => void ): void; - public getHostedZone( - args: GetHostedZoneCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetHostedZoneCommandOutput) => void), - cb?: (err: any, data?: GetHostedZoneCommandOutput) => void - ): Promise | void { - const command = new GetHostedZoneCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the number of hosted zones that are associated with the current Amazon Web Services account.

- */ - public getHostedZoneCount( + + /** + * @see {@link GetHostedZoneCountCommand} + */ + getHostedZoneCount( args: GetHostedZoneCountCommandInput, options?: __HttpHandlerOptions ): Promise; - public getHostedZoneCount( + getHostedZoneCount( args: GetHostedZoneCountCommandInput, cb: (err: any, data?: GetHostedZoneCountCommandOutput) => void ): void; - public getHostedZoneCount( + getHostedZoneCount( args: GetHostedZoneCountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHostedZoneCountCommandOutput) => void ): void; - public getHostedZoneCount( - args: GetHostedZoneCountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetHostedZoneCountCommandOutput) => void), - cb?: (err: any, data?: GetHostedZoneCountCommandOutput) => void - ): Promise | void { - const command = new GetHostedZoneCountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the specified limit for a specified hosted zone, for example, the maximum number - * of records that you can create in the hosted zone.

- *

For the default limit, see Limits in the - * Amazon Route 53 Developer Guide. To request a higher limit, - * open a case.

- */ - public getHostedZoneLimit( + + /** + * @see {@link GetHostedZoneLimitCommand} + */ + getHostedZoneLimit( args: GetHostedZoneLimitCommandInput, options?: __HttpHandlerOptions ): Promise; - public getHostedZoneLimit( + getHostedZoneLimit( args: GetHostedZoneLimitCommandInput, cb: (err: any, data?: GetHostedZoneLimitCommandOutput) => void ): void; - public getHostedZoneLimit( + getHostedZoneLimit( args: GetHostedZoneLimitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHostedZoneLimitCommandOutput) => void ): void; - public getHostedZoneLimit( - args: GetHostedZoneLimitCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetHostedZoneLimitCommandOutput) => void), - cb?: (err: any, data?: GetHostedZoneLimitCommandOutput) => void - ): Promise | void { - const command = new GetHostedZoneLimitCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a specified configuration for DNS query logging.

- *

For more information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS - * Queries.

- */ - public getQueryLoggingConfig( + + /** + * @see {@link GetQueryLoggingConfigCommand} + */ + getQueryLoggingConfig( args: GetQueryLoggingConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getQueryLoggingConfig( + getQueryLoggingConfig( args: GetQueryLoggingConfigCommandInput, cb: (err: any, data?: GetQueryLoggingConfigCommandOutput) => void ): void; - public getQueryLoggingConfig( + getQueryLoggingConfig( args: GetQueryLoggingConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueryLoggingConfigCommandOutput) => void ): void; - public getQueryLoggingConfig( - args: GetQueryLoggingConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetQueryLoggingConfigCommandOutput) => void), - cb?: (err: any, data?: GetQueryLoggingConfigCommandOutput) => void - ): Promise | void { - const command = new GetQueryLoggingConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about a specified reusable delegation set, including the four - * name servers that are assigned to the delegation set.

- */ - public getReusableDelegationSet( + + /** + * @see {@link GetReusableDelegationSetCommand} + */ + getReusableDelegationSet( args: GetReusableDelegationSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReusableDelegationSet( + getReusableDelegationSet( args: GetReusableDelegationSetCommandInput, cb: (err: any, data?: GetReusableDelegationSetCommandOutput) => void ): void; - public getReusableDelegationSet( + getReusableDelegationSet( args: GetReusableDelegationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReusableDelegationSetCommandOutput) => void ): void; - public getReusableDelegationSet( - args: GetReusableDelegationSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReusableDelegationSetCommandOutput) => void), - cb?: (err: any, data?: GetReusableDelegationSetCommandOutput) => void - ): Promise | void { - const command = new GetReusableDelegationSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the maximum number of hosted zones that you can associate with the specified - * reusable delegation set.

- *

For the default limit, see Limits in the - * Amazon Route 53 Developer Guide. To request a higher limit, - * open a case.

- */ - public getReusableDelegationSetLimit( + + /** + * @see {@link GetReusableDelegationSetLimitCommand} + */ + getReusableDelegationSetLimit( args: GetReusableDelegationSetLimitCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReusableDelegationSetLimit( + getReusableDelegationSetLimit( args: GetReusableDelegationSetLimitCommandInput, cb: (err: any, data?: GetReusableDelegationSetLimitCommandOutput) => void ): void; - public getReusableDelegationSetLimit( + getReusableDelegationSetLimit( args: GetReusableDelegationSetLimitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReusableDelegationSetLimitCommandOutput) => void ): void; - public getReusableDelegationSetLimit( - args: GetReusableDelegationSetLimitCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReusableDelegationSetLimitCommandOutput) => void), - cb?: (err: any, data?: GetReusableDelegationSetLimitCommandOutput) => void - ): Promise | void { - const command = new GetReusableDelegationSetLimitCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a specific traffic policy version.

- *

For information about how of deleting a traffic policy affects the response from - * GetTrafficPolicy, see DeleteTrafficPolicy.

- */ - public getTrafficPolicy( + + /** + * @see {@link GetTrafficPolicyCommand} + */ + getTrafficPolicy( args: GetTrafficPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTrafficPolicy( + getTrafficPolicy( args: GetTrafficPolicyCommandInput, cb: (err: any, data?: GetTrafficPolicyCommandOutput) => void ): void; - public getTrafficPolicy( + getTrafficPolicy( args: GetTrafficPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTrafficPolicyCommandOutput) => void ): void; - public getTrafficPolicy( - args: GetTrafficPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTrafficPolicyCommandOutput) => void), - cb?: (err: any, data?: GetTrafficPolicyCommandOutput) => void - ): Promise | void { - const command = new GetTrafficPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a specified traffic policy instance.

- * - *

After you submit a CreateTrafficPolicyInstance or an - * UpdateTrafficPolicyInstance request, there's a brief delay while - * Amazon Route 53 creates the resource record sets that are specified in the traffic - * policy definition. For more information, see the State response - * element.

- *
- * - *

In the Route 53 console, traffic policy instances are known as policy - * records.

- *
- */ - public getTrafficPolicyInstance( + + /** + * @see {@link GetTrafficPolicyInstanceCommand} + */ + getTrafficPolicyInstance( args: GetTrafficPolicyInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTrafficPolicyInstance( + getTrafficPolicyInstance( args: GetTrafficPolicyInstanceCommandInput, cb: (err: any, data?: GetTrafficPolicyInstanceCommandOutput) => void ): void; - public getTrafficPolicyInstance( + getTrafficPolicyInstance( args: GetTrafficPolicyInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTrafficPolicyInstanceCommandOutput) => void ): void; - public getTrafficPolicyInstance( - args: GetTrafficPolicyInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTrafficPolicyInstanceCommandOutput) => void), - cb?: (err: any, data?: GetTrafficPolicyInstanceCommandOutput) => void - ): Promise | void { - const command = new GetTrafficPolicyInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the number of traffic policy instances that are associated with the current - * Amazon Web Services account.

- */ - public getTrafficPolicyInstanceCount( + + /** + * @see {@link GetTrafficPolicyInstanceCountCommand} + */ + getTrafficPolicyInstanceCount( args: GetTrafficPolicyInstanceCountCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTrafficPolicyInstanceCount( + getTrafficPolicyInstanceCount( args: GetTrafficPolicyInstanceCountCommandInput, cb: (err: any, data?: GetTrafficPolicyInstanceCountCommandOutput) => void ): void; - public getTrafficPolicyInstanceCount( + getTrafficPolicyInstanceCount( args: GetTrafficPolicyInstanceCountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTrafficPolicyInstanceCountCommandOutput) => void ): void; - public getTrafficPolicyInstanceCount( - args: GetTrafficPolicyInstanceCountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTrafficPolicyInstanceCountCommandOutput) => void), - cb?: (err: any, data?: GetTrafficPolicyInstanceCountCommandOutput) => void - ): Promise | void { - const command = new GetTrafficPolicyInstanceCountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a paginated list of location objects and their CIDR blocks.

- */ - public listCidrBlocks( + + /** + * @see {@link ListCidrBlocksCommand} + */ + listCidrBlocks( args: ListCidrBlocksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCidrBlocks( - args: ListCidrBlocksCommandInput, - cb: (err: any, data?: ListCidrBlocksCommandOutput) => void - ): void; - public listCidrBlocks( + listCidrBlocks(args: ListCidrBlocksCommandInput, cb: (err: any, data?: ListCidrBlocksCommandOutput) => void): void; + listCidrBlocks( args: ListCidrBlocksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCidrBlocksCommandOutput) => void ): void; - public listCidrBlocks( - args: ListCidrBlocksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCidrBlocksCommandOutput) => void), - cb?: (err: any, data?: ListCidrBlocksCommandOutput) => void - ): Promise | void { - const command = new ListCidrBlocksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a paginated list of CIDR collections in the Amazon Web Services account - * (metadata only).

- */ - public listCidrCollections( + + /** + * @see {@link ListCidrCollectionsCommand} + */ + listCidrCollections( args: ListCidrCollectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCidrCollections( + listCidrCollections( args: ListCidrCollectionsCommandInput, cb: (err: any, data?: ListCidrCollectionsCommandOutput) => void ): void; - public listCidrCollections( + listCidrCollections( args: ListCidrCollectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCidrCollectionsCommandOutput) => void ): void; - public listCidrCollections( - args: ListCidrCollectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCidrCollectionsCommandOutput) => void), - cb?: (err: any, data?: ListCidrCollectionsCommandOutput) => void - ): Promise | void { - const command = new ListCidrCollectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a paginated list of CIDR locations for the given collection (metadata only, - * does not include CIDR blocks).

- */ - public listCidrLocations( + + /** + * @see {@link ListCidrLocationsCommand} + */ + listCidrLocations( args: ListCidrLocationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCidrLocations( + listCidrLocations( args: ListCidrLocationsCommandInput, cb: (err: any, data?: ListCidrLocationsCommandOutput) => void ): void; - public listCidrLocations( + listCidrLocations( args: ListCidrLocationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCidrLocationsCommandOutput) => void ): void; - public listCidrLocations( - args: ListCidrLocationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCidrLocationsCommandOutput) => void), - cb?: (err: any, data?: ListCidrLocationsCommandOutput) => void - ): Promise | void { - const command = new ListCidrLocationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of supported geographic locations.

- *

Countries are listed first, and continents are listed last. If Amazon Route 53 - * supports subdivisions for a country (for example, states or provinces), the subdivisions - * for that country are listed in alphabetical order immediately after the corresponding - * country.

- *

Route 53 does not perform authorization for this API because it retrieves information - * that is already available to the public.

- *

For a list of supported geolocation codes, see the GeoLocation data - * type.

- */ - public listGeoLocations( + + /** + * @see {@link ListGeoLocationsCommand} + */ + listGeoLocations( args: ListGeoLocationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGeoLocations( + listGeoLocations( args: ListGeoLocationsCommandInput, cb: (err: any, data?: ListGeoLocationsCommandOutput) => void ): void; - public listGeoLocations( + listGeoLocations( args: ListGeoLocationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGeoLocationsCommandOutput) => void ): void; - public listGeoLocations( - args: ListGeoLocationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGeoLocationsCommandOutput) => void), - cb?: (err: any, data?: ListGeoLocationsCommandOutput) => void - ): Promise | void { - const command = new ListGeoLocationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieve a list of the health checks that are associated with the current Amazon Web Services account.

- */ - public listHealthChecks( + + /** + * @see {@link ListHealthChecksCommand} + */ + listHealthChecks( args: ListHealthChecksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listHealthChecks( + listHealthChecks( args: ListHealthChecksCommandInput, cb: (err: any, data?: ListHealthChecksCommandOutput) => void ): void; - public listHealthChecks( + listHealthChecks( args: ListHealthChecksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHealthChecksCommandOutput) => void ): void; - public listHealthChecks( - args: ListHealthChecksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListHealthChecksCommandOutput) => void), - cb?: (err: any, data?: ListHealthChecksCommandOutput) => void - ): Promise | void { - const command = new ListHealthChecksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of the public and private hosted zones that are associated with the - * current Amazon Web Services account. The response includes a HostedZones - * child element for each hosted zone.

- *

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of - * hosted zones, you can use the maxitems parameter to list them in groups of - * up to 100.

- */ - public listHostedZones( + + /** + * @see {@link ListHostedZonesCommand} + */ + listHostedZones( args: ListHostedZonesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listHostedZones( - args: ListHostedZonesCommandInput, - cb: (err: any, data?: ListHostedZonesCommandOutput) => void - ): void; - public listHostedZones( + listHostedZones(args: ListHostedZonesCommandInput, cb: (err: any, data?: ListHostedZonesCommandOutput) => void): void; + listHostedZones( args: ListHostedZonesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHostedZonesCommandOutput) => void ): void; - public listHostedZones( - args: ListHostedZonesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListHostedZonesCommandOutput) => void), - cb?: (err: any, data?: ListHostedZonesCommandOutput) => void - ): Promise | void { - const command = new ListHostedZonesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of your hosted zones in lexicographic order. The response includes a - * HostedZones child element for each hosted zone created by the current - * Amazon Web Services account.

- *

- * ListHostedZonesByName sorts hosted zones by name with the labels - * reversed. For example:

- *

- * com.example.www. - *

- *

Note the trailing dot, which can change the sort order in some circumstances.

- *

If the domain name includes escape characters or Punycode, - * ListHostedZonesByName alphabetizes the domain name using the escaped or - * Punycoded value, which is the format that Amazon Route 53 saves in its database. For - * example, to create a hosted zone for exämple.com, you specify ex\344mple.com for - * the domain name. ListHostedZonesByName alphabetizes it as:

- *

- * com.ex\344mple. - *

- *

The labels are reversed and alphabetized using the escaped value. For more information - * about valid domain name formats, including internationalized domain names, see DNS - * Domain Name Format in the Amazon Route 53 Developer - * Guide.

- *

Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, - * use the MaxItems parameter to list them in groups of up to 100. The - * response includes values that help navigate from one group of MaxItems - * hosted zones to the next:

- *
    - *
  • - *

    The DNSName and HostedZoneId elements in the - * response contain the values, if any, specified for the dnsname and - * hostedzoneid parameters in the request that produced the - * current response.

    - *
  • - *
  • - *

    The MaxItems element in the response contains the value, if any, - * that you specified for the maxitems parameter in the request that - * produced the current response.

    - *
  • - *
  • - *

    If the value of IsTruncated in the response is true, there are - * more hosted zones associated with the current Amazon Web Services account.

    - *

    If IsTruncated is false, this response includes the last hosted - * zone that is associated with the current account. The NextDNSName - * element and NextHostedZoneId elements are omitted from the - * response.

    - *
  • - *
  • - *

    The NextDNSName and NextHostedZoneId elements in the - * response contain the domain name and the hosted zone ID of the next hosted zone - * that is associated with the current Amazon Web Services account. If you want to - * list more hosted zones, make another call to ListHostedZonesByName, - * and specify the value of NextDNSName and - * NextHostedZoneId in the dnsname and - * hostedzoneid parameters, respectively.

    - *
  • - *
- */ - public listHostedZonesByName( + + /** + * @see {@link ListHostedZonesByNameCommand} + */ + listHostedZonesByName( args: ListHostedZonesByNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public listHostedZonesByName( + listHostedZonesByName( args: ListHostedZonesByNameCommandInput, cb: (err: any, data?: ListHostedZonesByNameCommandOutput) => void ): void; - public listHostedZonesByName( + listHostedZonesByName( args: ListHostedZonesByNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHostedZonesByNameCommandOutput) => void ): void; - public listHostedZonesByName( - args: ListHostedZonesByNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListHostedZonesByNameCommandOutput) => void), - cb?: (err: any, data?: ListHostedZonesByNameCommandOutput) => void - ): Promise | void { - const command = new ListHostedZonesByNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all the private hosted zones that a specified VPC is associated with, regardless - * of which Amazon Web Services account or Amazon Web Services service owns the hosted zones. - * The HostedZoneOwner structure in the response contains one of the following - * values:

- *
    - *
  • - *

    An OwningAccount element, which contains the account number of - * either the current Amazon Web Services account or another Amazon Web Services account. Some services, such as Cloud Map, create - * hosted zones using the current account.

    - *
  • - *
  • - *

    An OwningService element, which identifies the Amazon Web Services - * service that created and owns the hosted zone. For example, if a hosted zone was - * created by Amazon Elastic File System (Amazon EFS), the value of - * Owner is efs.amazonaws.com.

    - *
  • - *
- * - *

When listing private hosted zones, the hosted zone and the Amazon VPC must - * belong to the same partition where the hosted zones were created. A partition is a - * group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to - * one partition.

- *

The following are the supported partitions:

- *
    - *
  • - *

    - * aws - Amazon Web Services Regions

    - *
  • - *
  • - *

    - * aws-cn - China Regions

    - *
  • - *
  • - *

    - * aws-us-gov - Amazon Web Services GovCloud (US) Region

    - *
  • - *
- *

For more information, see Access Management - * in the Amazon Web Services General Reference.

- *
- */ - public listHostedZonesByVPC( + + /** + * @see {@link ListHostedZonesByVPCCommand} + */ + listHostedZonesByVPC( args: ListHostedZonesByVPCCommandInput, options?: __HttpHandlerOptions ): Promise; - public listHostedZonesByVPC( + listHostedZonesByVPC( args: ListHostedZonesByVPCCommandInput, cb: (err: any, data?: ListHostedZonesByVPCCommandOutput) => void ): void; - public listHostedZonesByVPC( + listHostedZonesByVPC( args: ListHostedZonesByVPCCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHostedZonesByVPCCommandOutput) => void ): void; - public listHostedZonesByVPC( - args: ListHostedZonesByVPCCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListHostedZonesByVPCCommandOutput) => void), - cb?: (err: any, data?: ListHostedZonesByVPCCommandOutput) => void - ): Promise | void { - const command = new ListHostedZonesByVPCCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the configurations for DNS query logging that are associated with the current - * Amazon Web Services account or the configuration that is associated with a specified - * hosted zone.

- *

For more information about DNS query logs, see CreateQueryLoggingConfig. Additional information, including the format of - * DNS query logs, appears in Logging DNS Queries in - * the Amazon Route 53 Developer Guide.

- */ - public listQueryLoggingConfigs( + + /** + * @see {@link ListQueryLoggingConfigsCommand} + */ + listQueryLoggingConfigs( args: ListQueryLoggingConfigsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listQueryLoggingConfigs( + listQueryLoggingConfigs( args: ListQueryLoggingConfigsCommandInput, cb: (err: any, data?: ListQueryLoggingConfigsCommandOutput) => void ): void; - public listQueryLoggingConfigs( + listQueryLoggingConfigs( args: ListQueryLoggingConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQueryLoggingConfigsCommandOutput) => void ): void; - public listQueryLoggingConfigs( - args: ListQueryLoggingConfigsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListQueryLoggingConfigsCommandOutput) => void), - cb?: (err: any, data?: ListQueryLoggingConfigsCommandOutput) => void - ): Promise | void { - const command = new ListQueryLoggingConfigsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the resource record sets in a specified hosted zone.

- *

- * ListResourceRecordSets returns up to 300 resource record sets at a time - * in ASCII order, beginning at a position specified by the name and - * type elements.

- *

- * Sort order - *

- *

- * ListResourceRecordSets sorts results first by DNS name with the labels - * reversed, for example:

- *

- * com.example.www. - *

- *

Note the trailing dot, which can change the sort order when the record name contains - * characters that appear before . (decimal 46) in the ASCII table. These - * characters include the following: ! " # $ % & ' ( ) * + , - - *

- *

When multiple records have the same DNS name, ListResourceRecordSets - * sorts results by the record type.

- *

- * Specifying where to start listing records - *

- *

You can use the name and type elements to specify the resource record set that the - * list begins with:

- *
- *
If you do not specify Name or Type
- *
- *

The results begin with the first resource record set that the hosted zone - * contains.

- *
- *
If you specify Name but not Type
- *
- *

The results begin with the first resource record set in the list whose - * name is greater than or equal to Name.

- *
- *
If you specify Type but not Name
- *
- *

Amazon Route 53 returns the InvalidInput error.

- *
- *
If you specify both Name and Type
- *
- *

The results begin with the first resource record set in the list whose - * name is greater than or equal to Name, and whose type is - * greater than or equal to Type.

- *
- *
- *

- * Resource record sets that are PENDING - *

- *

This action returns the most current version of the records. This includes records - * that are PENDING, and that are not yet available on all Route 53 DNS - * servers.

- *

- * Changing resource record sets - *

- *

To ensure that you get an accurate listing of the resource record sets for a hosted - * zone at a point in time, do not submit a ChangeResourceRecordSets request - * while you're paging through the results of a ListResourceRecordSets - * request. If you do, some pages may display results without the latest changes while - * other pages display results with the latest changes.

- *

- * Displaying the next page of results - *

- *

If a ListResourceRecordSets command returns more than one page of - * results, the value of IsTruncated is true. To display the next - * page of results, get the values of NextRecordName, - * NextRecordType, and NextRecordIdentifier (if any) from the - * response. Then submit another ListResourceRecordSets request, and specify - * those values for StartRecordName, StartRecordType, and - * StartRecordIdentifier.

- */ - public listResourceRecordSets( + + /** + * @see {@link ListResourceRecordSetsCommand} + */ + listResourceRecordSets( args: ListResourceRecordSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourceRecordSets( + listResourceRecordSets( args: ListResourceRecordSetsCommandInput, cb: (err: any, data?: ListResourceRecordSetsCommandOutput) => void ): void; - public listResourceRecordSets( + listResourceRecordSets( args: ListResourceRecordSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceRecordSetsCommandOutput) => void ): void; - public listResourceRecordSets( - args: ListResourceRecordSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourceRecordSetsCommandOutput) => void), - cb?: (err: any, data?: ListResourceRecordSetsCommandOutput) => void - ): Promise | void { - const command = new ListResourceRecordSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of the reusable delegation sets that are associated with the current - * Amazon Web Services account.

- */ - public listReusableDelegationSets( + + /** + * @see {@link ListReusableDelegationSetsCommand} + */ + listReusableDelegationSets( args: ListReusableDelegationSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReusableDelegationSets( + listReusableDelegationSets( args: ListReusableDelegationSetsCommandInput, cb: (err: any, data?: ListReusableDelegationSetsCommandOutput) => void ): void; - public listReusableDelegationSets( + listReusableDelegationSets( args: ListReusableDelegationSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReusableDelegationSetsCommandOutput) => void ): void; - public listReusableDelegationSets( - args: ListReusableDelegationSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReusableDelegationSetsCommandOutput) => void), - cb?: (err: any, data?: ListReusableDelegationSetsCommandOutput) => void - ): Promise | void { - const command = new ListReusableDelegationSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists tags for one health check or hosted zone.

- *

For information about using tags for cost allocation, see Using Cost Allocation - * Tags in the Billing and Cost Management User Guide.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists tags for up to 10 health checks or hosted zones.

- *

For information about using tags for cost allocation, see Using Cost Allocation - * Tags in the Billing and Cost Management User Guide.

- */ - public listTagsForResources( + + /** + * @see {@link ListTagsForResourcesCommand} + */ + listTagsForResources( args: ListTagsForResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResources( + listTagsForResources( args: ListTagsForResourcesCommandInput, cb: (err: any, data?: ListTagsForResourcesCommandOutput) => void ): void; - public listTagsForResources( + listTagsForResources( args: ListTagsForResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourcesCommandOutput) => void ): void; - public listTagsForResources( - args: ListTagsForResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourcesCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourcesCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the latest version for every traffic policy that is associated - * with the current Amazon Web Services account. Policies are listed in the order that they - * were created in.

- *

For information about how of deleting a traffic policy affects the response from - * ListTrafficPolicies, see DeleteTrafficPolicy.

- */ - public listTrafficPolicies( + + /** + * @see {@link ListTrafficPoliciesCommand} + */ + listTrafficPolicies( args: ListTrafficPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTrafficPolicies( + listTrafficPolicies( args: ListTrafficPoliciesCommandInput, cb: (err: any, data?: ListTrafficPoliciesCommandOutput) => void ): void; - public listTrafficPolicies( + listTrafficPolicies( args: ListTrafficPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTrafficPoliciesCommandOutput) => void ): void; - public listTrafficPolicies( - args: ListTrafficPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTrafficPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListTrafficPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListTrafficPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the traffic policy instances that you created by using the - * current Amazon Web Services account.

- * - *

After you submit an UpdateTrafficPolicyInstance request, there's a - * brief delay while Amazon Route 53 creates the resource record sets that are - * specified in the traffic policy definition. For more information, see the - * State response element.

- *
- *

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic - * policy instances, you can use the MaxItems parameter to list them in groups - * of up to 100.

- */ - public listTrafficPolicyInstances( + + /** + * @see {@link ListTrafficPolicyInstancesCommand} + */ + listTrafficPolicyInstances( args: ListTrafficPolicyInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTrafficPolicyInstances( + listTrafficPolicyInstances( args: ListTrafficPolicyInstancesCommandInput, cb: (err: any, data?: ListTrafficPolicyInstancesCommandOutput) => void ): void; - public listTrafficPolicyInstances( + listTrafficPolicyInstances( args: ListTrafficPolicyInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTrafficPolicyInstancesCommandOutput) => void ): void; - public listTrafficPolicyInstances( - args: ListTrafficPolicyInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTrafficPolicyInstancesCommandOutput) => void), - cb?: (err: any, data?: ListTrafficPolicyInstancesCommandOutput) => void - ): Promise | void { - const command = new ListTrafficPolicyInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the traffic policy instances that you created in a specified - * hosted zone.

- * - *

After you submit a CreateTrafficPolicyInstance or an - * UpdateTrafficPolicyInstance request, there's a brief delay while - * Amazon Route 53 creates the resource record sets that are specified in the traffic - * policy definition. For more information, see the State response - * element.

- *
- *

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic - * policy instances, you can use the MaxItems parameter to list them in groups - * of up to 100.

- */ - public listTrafficPolicyInstancesByHostedZone( + + /** + * @see {@link ListTrafficPolicyInstancesByHostedZoneCommand} + */ + listTrafficPolicyInstancesByHostedZone( args: ListTrafficPolicyInstancesByHostedZoneCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTrafficPolicyInstancesByHostedZone( + listTrafficPolicyInstancesByHostedZone( args: ListTrafficPolicyInstancesByHostedZoneCommandInput, cb: (err: any, data?: ListTrafficPolicyInstancesByHostedZoneCommandOutput) => void ): void; - public listTrafficPolicyInstancesByHostedZone( + listTrafficPolicyInstancesByHostedZone( args: ListTrafficPolicyInstancesByHostedZoneCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTrafficPolicyInstancesByHostedZoneCommandOutput) => void ): void; - public listTrafficPolicyInstancesByHostedZone( - args: ListTrafficPolicyInstancesByHostedZoneCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListTrafficPolicyInstancesByHostedZoneCommandOutput) => void), - cb?: (err: any, data?: ListTrafficPolicyInstancesByHostedZoneCommandOutput) => void - ): Promise | void { - const command = new ListTrafficPolicyInstancesByHostedZoneCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the traffic policy instances that you created by using a - * specify traffic policy version.

- * - *

After you submit a CreateTrafficPolicyInstance or an - * UpdateTrafficPolicyInstance request, there's a brief delay while - * Amazon Route 53 creates the resource record sets that are specified in the traffic - * policy definition. For more information, see the State response - * element.

- *
- *

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic - * policy instances, you can use the MaxItems parameter to list them in groups - * of up to 100.

- */ - public listTrafficPolicyInstancesByPolicy( + + /** + * @see {@link ListTrafficPolicyInstancesByPolicyCommand} + */ + listTrafficPolicyInstancesByPolicy( args: ListTrafficPolicyInstancesByPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTrafficPolicyInstancesByPolicy( + listTrafficPolicyInstancesByPolicy( args: ListTrafficPolicyInstancesByPolicyCommandInput, cb: (err: any, data?: ListTrafficPolicyInstancesByPolicyCommandOutput) => void ): void; - public listTrafficPolicyInstancesByPolicy( + listTrafficPolicyInstancesByPolicy( args: ListTrafficPolicyInstancesByPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTrafficPolicyInstancesByPolicyCommandOutput) => void ): void; - public listTrafficPolicyInstancesByPolicy( - args: ListTrafficPolicyInstancesByPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTrafficPolicyInstancesByPolicyCommandOutput) => void), - cb?: (err: any, data?: ListTrafficPolicyInstancesByPolicyCommandOutput) => void - ): Promise | void { - const command = new ListTrafficPolicyInstancesByPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about all of the versions for a specified traffic policy.

- *

Traffic policy versions are listed in numerical order by - * VersionNumber.

- */ - public listTrafficPolicyVersions( + + /** + * @see {@link ListTrafficPolicyVersionsCommand} + */ + listTrafficPolicyVersions( args: ListTrafficPolicyVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTrafficPolicyVersions( + listTrafficPolicyVersions( args: ListTrafficPolicyVersionsCommandInput, cb: (err: any, data?: ListTrafficPolicyVersionsCommandOutput) => void ): void; - public listTrafficPolicyVersions( + listTrafficPolicyVersions( args: ListTrafficPolicyVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTrafficPolicyVersionsCommandOutput) => void ): void; - public listTrafficPolicyVersions( - args: ListTrafficPolicyVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTrafficPolicyVersionsCommandOutput) => void), - cb?: (err: any, data?: ListTrafficPolicyVersionsCommandOutput) => void - ): Promise | void { - const command = new ListTrafficPolicyVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of the VPCs that were created by other accounts and that can be associated - * with a specified hosted zone because you've submitted one or more - * CreateVPCAssociationAuthorization requests.

- *

The response includes a VPCs element with a VPC child - * element for each VPC that can be associated with the hosted zone.

- */ - public listVPCAssociationAuthorizations( + + /** + * @see {@link ListVPCAssociationAuthorizationsCommand} + */ + listVPCAssociationAuthorizations( args: ListVPCAssociationAuthorizationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVPCAssociationAuthorizations( + listVPCAssociationAuthorizations( args: ListVPCAssociationAuthorizationsCommandInput, cb: (err: any, data?: ListVPCAssociationAuthorizationsCommandOutput) => void ): void; - public listVPCAssociationAuthorizations( + listVPCAssociationAuthorizations( args: ListVPCAssociationAuthorizationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVPCAssociationAuthorizationsCommandOutput) => void ): void; - public listVPCAssociationAuthorizations( - args: ListVPCAssociationAuthorizationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVPCAssociationAuthorizationsCommandOutput) => void), - cb?: (err: any, data?: ListVPCAssociationAuthorizationsCommandOutput) => void - ): Promise | void { - const command = new ListVPCAssociationAuthorizationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the value that Amazon Route 53 returns in response to a DNS request for a - * specified record name and type. You can optionally specify the IP address of a DNS - * resolver, an EDNS0 client subnet IP address, and a subnet mask.

- *

This call only supports querying public hosted zones.

- */ - public testDNSAnswer( - args: TestDNSAnswerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public testDNSAnswer( - args: TestDNSAnswerCommandInput, - cb: (err: any, data?: TestDNSAnswerCommandOutput) => void - ): void; - public testDNSAnswer( + + /** + * @see {@link TestDNSAnswerCommand} + */ + testDNSAnswer(args: TestDNSAnswerCommandInput, options?: __HttpHandlerOptions): Promise; + testDNSAnswer(args: TestDNSAnswerCommandInput, cb: (err: any, data?: TestDNSAnswerCommandOutput) => void): void; + testDNSAnswer( args: TestDNSAnswerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestDNSAnswerCommandOutput) => void ): void; - public testDNSAnswer( - args: TestDNSAnswerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestDNSAnswerCommandOutput) => void), - cb?: (err: any, data?: TestDNSAnswerCommandOutput) => void - ): Promise | void { - const command = new TestDNSAnswerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing health check. Note that some values can't be updated.

- *

For more information about updating health checks, see Creating, - * Updating, and Deleting Health Checks in the Amazon Route 53 - * Developer Guide.

- */ - public updateHealthCheck( + + /** + * @see {@link UpdateHealthCheckCommand} + */ + updateHealthCheck( args: UpdateHealthCheckCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateHealthCheck( + updateHealthCheck( args: UpdateHealthCheckCommandInput, cb: (err: any, data?: UpdateHealthCheckCommandOutput) => void ): void; - public updateHealthCheck( + updateHealthCheck( args: UpdateHealthCheckCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateHealthCheckCommandOutput) => void ): void; - public updateHealthCheck( - args: UpdateHealthCheckCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateHealthCheckCommandOutput) => void), - cb?: (err: any, data?: UpdateHealthCheckCommandOutput) => void - ): Promise | void { - const command = new UpdateHealthCheckCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the comment for a specified hosted zone.

- */ - public updateHostedZoneComment( + + /** + * @see {@link UpdateHostedZoneCommentCommand} + */ + updateHostedZoneComment( args: UpdateHostedZoneCommentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateHostedZoneComment( + updateHostedZoneComment( args: UpdateHostedZoneCommentCommandInput, cb: (err: any, data?: UpdateHostedZoneCommentCommandOutput) => void ): void; - public updateHostedZoneComment( + updateHostedZoneComment( args: UpdateHostedZoneCommentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateHostedZoneCommentCommandOutput) => void ): void; - public updateHostedZoneComment( - args: UpdateHostedZoneCommentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateHostedZoneCommentCommandOutput) => void), - cb?: (err: any, data?: UpdateHostedZoneCommentCommandOutput) => void - ): Promise | void { - const command = new UpdateHostedZoneCommentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the comment for a specified traffic policy version.

- */ - public updateTrafficPolicyComment( + + /** + * @see {@link UpdateTrafficPolicyCommentCommand} + */ + updateTrafficPolicyComment( args: UpdateTrafficPolicyCommentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTrafficPolicyComment( + updateTrafficPolicyComment( args: UpdateTrafficPolicyCommentCommandInput, cb: (err: any, data?: UpdateTrafficPolicyCommentCommandOutput) => void ): void; - public updateTrafficPolicyComment( + updateTrafficPolicyComment( args: UpdateTrafficPolicyCommentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTrafficPolicyCommentCommandOutput) => void ): void; - public updateTrafficPolicyComment( - args: UpdateTrafficPolicyCommentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTrafficPolicyCommentCommandOutput) => void), - cb?: (err: any, data?: UpdateTrafficPolicyCommentCommandOutput) => void - ): Promise | void { - const command = new UpdateTrafficPolicyCommentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the resource record sets in a specified hosted zone that were created based on - * the settings in a specified traffic policy version.

- *

When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS - * queries for the root resource record set name (such as example.com) while it replaces - * one group of resource record sets with another. Route 53 performs the following - * operations:

- *
    - *
  1. - *

    Route 53 creates a new group of resource record sets based on the specified - * traffic policy. This is true regardless of how significant the differences are - * between the existing resource record sets and the new resource record sets. - *

    - *
  2. - *
  3. - *

    When all of the new resource record sets have been created, Route 53 starts to - * respond to DNS queries for the root resource record set name (such as - * example.com) by using the new resource record sets.

    - *
  4. - *
  5. - *

    Route 53 deletes the old group of resource record sets that are associated - * with the root resource record set name.

    - *
  6. - *
- */ - public updateTrafficPolicyInstance( + + /** + * @see {@link UpdateTrafficPolicyInstanceCommand} + */ + updateTrafficPolicyInstance( args: UpdateTrafficPolicyInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTrafficPolicyInstance( + updateTrafficPolicyInstance( args: UpdateTrafficPolicyInstanceCommandInput, cb: (err: any, data?: UpdateTrafficPolicyInstanceCommandOutput) => void ): void; - public updateTrafficPolicyInstance( + updateTrafficPolicyInstance( args: UpdateTrafficPolicyInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTrafficPolicyInstanceCommandOutput) => void ): void; - public updateTrafficPolicyInstance( - args: UpdateTrafficPolicyInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTrafficPolicyInstanceCommandOutput) => void), - cb?: (err: any, data?: UpdateTrafficPolicyInstanceCommandOutput) => void - ): Promise | void { - const command = new UpdateTrafficPolicyInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web + * service.

+ *

You can use Route 53 to:

+ * + */ +export class Route53 extends Route53Client implements Route53 {} +createAggregatedClient(commands, Route53); diff --git a/clients/client-route53-recovery-cluster/src/Route53RecoveryCluster.ts b/clients/client-route53-recovery-cluster/src/Route53RecoveryCluster.ts index 38d461eb81d9..69cb757163d3 100644 --- a/clients/client-route53-recovery-cluster/src/Route53RecoveryCluster.ts +++ b/clients/client-route53-recovery-cluster/src/Route53RecoveryCluster.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -21,308 +22,127 @@ import { UpdateRoutingControlStatesCommandInput, UpdateRoutingControlStatesCommandOutput, } from "./commands/UpdateRoutingControlStatesCommand"; -import { Route53RecoveryClusterClient } from "./Route53RecoveryClusterClient"; +import { Route53RecoveryClusterClient, Route53RecoveryClusterClientConfig } from "./Route53RecoveryClusterClient"; -/** - * @public - *

Welcome to the Routing Control (Recovery Cluster) API Reference Guide for Amazon Route 53 Application Recovery Controller.

- *

With Route 53 ARC, you can use routing control with extreme reliability to - * recover applications by rerouting traffic across - * Availability Zones or Amazon Web Services Regions. Routing controls are simple on/off switches hosted - * on a highly available cluster in Route 53 ARC. A cluster provides a set of five redundant Regional endpoints against which you - * can run API calls to get or update the state of routing controls. To implement failover, you set - * one routing control On and another one Off, to reroute traffic from one Availability Zone or Amazon Web Services Region - * to another.

- *

- * Be aware that you must specify a Regional endpoint for a cluster when you work with API cluster operations - * to get or update routing control states in Route 53 ARC. In addition, you must specify the US West (Oregon) Region - * for Route 53 ARC API calls. For example, use the parameter --region us-west-2 with AWS CLI commands. - * For more information, see - * - * Get and update routing control states using the API in the Amazon Route 53 Application Recovery Controller Developer Guide.

- *

This API guide includes information about the API operations for how to get and update routing control states - * in Route 53 ARC. To work with routing control in Route 53 ARC, you must first create the required components (clusters, control - * panels, and routing controls) using the recovery cluster configuration API.

- *

For more information about working with routing control in Route 53 ARC, see the following:

- * - */ -export class Route53RecoveryCluster extends Route53RecoveryClusterClient { +const commands = { + GetRoutingControlStateCommand, + ListRoutingControlsCommand, + UpdateRoutingControlStateCommand, + UpdateRoutingControlStatesCommand, +}; + +export interface Route53RecoveryCluster { /** - * @public - *

Get the state for a routing control. A routing control is a simple on/off switch that you - * can use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When - * the state is Off, traffic does not flow.

- *

Before you can create a routing control, you must first create a cluster, and then host the control - * in a control panel on the cluster. For more information, see - * Create routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. - * You access one of the endpoints for the cluster to get or update the routing control state to - * redirect traffic for your application.

- *

- * You must specify Regional endpoints when you work with API cluster operations - * to get or update routing control states in Route 53 ARC. - *

- *

To see a code example for getting a routing control state, including accessing Regional cluster endpoints - * in sequence, see API examples - * in the Amazon Route 53 Application Recovery Controller Developer Guide.

- *

Learn more about working with routing controls in the following topics in the - * Amazon Route 53 Application Recovery Controller Developer Guide:

- * + * @see {@link GetRoutingControlStateCommand} */ - public getRoutingControlState( + getRoutingControlState( args: GetRoutingControlStateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRoutingControlState( + getRoutingControlState( args: GetRoutingControlStateCommandInput, cb: (err: any, data?: GetRoutingControlStateCommandOutput) => void ): void; - public getRoutingControlState( + getRoutingControlState( args: GetRoutingControlStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRoutingControlStateCommandOutput) => void ): void; - public getRoutingControlState( - args: GetRoutingControlStateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRoutingControlStateCommandOutput) => void), - cb?: (err: any, data?: GetRoutingControlStateCommandOutput) => void - ): Promise | void { - const command = new GetRoutingControlStateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List routing control names and Amazon Resource Names (ARNs), as well as the routing control - * state for each routing control, along with the control panel name and control panel ARN for the routing controls. - * If you specify a control panel ARN, this call lists the routing controls in the control panel. Otherwise, it lists - * all the routing controls in the cluster.

- *

A routing control is a simple on/off switch in Route 53 ARC that you - * can use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When - * the state is Off, traffic does not flow.

- *

Before you can create a routing control, you must first create a cluster, and then host the control - * in a control panel on the cluster. For more information, see - * Create routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. - * You access one of the endpoints for the cluster to get or update the routing control state to - * redirect traffic for your application.

- *

- * You must specify Regional endpoints when you work with API cluster operations - * to use this API operation to list routing controls in Route 53 ARC. - *

- *

Learn more about working with routing controls in the following topics in the - * Amazon Route 53 Application Recovery Controller Developer Guide:

- * + * @see {@link ListRoutingControlsCommand} */ - public listRoutingControls( + listRoutingControls( args: ListRoutingControlsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRoutingControls( + listRoutingControls( args: ListRoutingControlsCommandInput, cb: (err: any, data?: ListRoutingControlsCommandOutput) => void ): void; - public listRoutingControls( + listRoutingControls( args: ListRoutingControlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRoutingControlsCommandOutput) => void ): void; - public listRoutingControls( - args: ListRoutingControlsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRoutingControlsCommandOutput) => void), - cb?: (err: any, data?: ListRoutingControlsCommandOutput) => void - ): Promise | void { - const command = new ListRoutingControlsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Set the state of the routing control to reroute traffic. You can set the value to be On or - * Off. When the state is On, traffic flows to a cell. When the state is Off, traffic does not - * flow.

- *

With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing - * control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, - * there are scenarios when you might want to bypass the routing control safeguards that are enforced with - * safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, - * and one or more safety rules might be unexpectedly preventing you from updating a routing control state to - * reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change - * a routing control state and fail over your application.

- *

The SafetyRulesToOverride property enables you override one or more safety rules and - * update routing control states. For more information, see - * - * Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.

- *

- * You must specify Regional endpoints when you work with API cluster operations - * to get or update routing control states in Route 53 ARC. - *

- *

To see a code example for getting a routing control state, including accessing Regional cluster endpoints - * in sequence, see API examples - * in the Amazon Route 53 Application Recovery Controller Developer Guide.

- * + * @see {@link UpdateRoutingControlStateCommand} */ - public updateRoutingControlState( + updateRoutingControlState( args: UpdateRoutingControlStateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRoutingControlState( + updateRoutingControlState( args: UpdateRoutingControlStateCommandInput, cb: (err: any, data?: UpdateRoutingControlStateCommandOutput) => void ): void; - public updateRoutingControlState( + updateRoutingControlState( args: UpdateRoutingControlStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRoutingControlStateCommandOutput) => void ): void; - public updateRoutingControlState( - args: UpdateRoutingControlStateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRoutingControlStateCommandOutput) => void), - cb?: (err: any, data?: UpdateRoutingControlStateCommandOutput) => void - ): Promise | void { - const command = new UpdateRoutingControlStateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Set multiple routing control states. You can set the value for each state to be On or Off. - * When the state is On, traffic flows to a cell. When it's Off, traffic does not - * flow.

- *

With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing - * control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, - * there are scenarios when you might want to bypass the routing control safeguards that are enforced with - * safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, - * and one or more safety rules might be unexpectedly preventing you from updating a routing control state to - * reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change - * a routing control state and fail over your application.

- *

The SafetyRulesToOverride property enables you override one or more safety rules and - * update routing control states. For more information, see - * - * Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.

- *

- * You must specify Regional endpoints when you work with API cluster operations - * to get or update routing control states in Route 53 ARC. - *

- *

To see a code example for getting a routing control state, including accessing Regional cluster endpoints - * in sequence, see API examples - * in the Amazon Route 53 Application Recovery Controller Developer Guide.

- * + * @see {@link UpdateRoutingControlStatesCommand} */ - public updateRoutingControlStates( + updateRoutingControlStates( args: UpdateRoutingControlStatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRoutingControlStates( + updateRoutingControlStates( args: UpdateRoutingControlStatesCommandInput, cb: (err: any, data?: UpdateRoutingControlStatesCommandOutput) => void ): void; - public updateRoutingControlStates( + updateRoutingControlStates( args: UpdateRoutingControlStatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRoutingControlStatesCommandOutput) => void ): void; - public updateRoutingControlStates( - args: UpdateRoutingControlStatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRoutingControlStatesCommandOutput) => void), - cb?: (err: any, data?: UpdateRoutingControlStatesCommandOutput) => void - ): Promise | void { - const command = new UpdateRoutingControlStatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Welcome to the Routing Control (Recovery Cluster) API Reference Guide for Amazon Route 53 Application Recovery Controller.

+ *

With Route 53 ARC, you can use routing control with extreme reliability to + * recover applications by rerouting traffic across + * Availability Zones or Amazon Web Services Regions. Routing controls are simple on/off switches hosted + * on a highly available cluster in Route 53 ARC. A cluster provides a set of five redundant Regional endpoints against which you + * can run API calls to get or update the state of routing controls. To implement failover, you set + * one routing control On and another one Off, to reroute traffic from one Availability Zone or Amazon Web Services Region + * to another.

+ *

+ * Be aware that you must specify a Regional endpoint for a cluster when you work with API cluster operations + * to get or update routing control states in Route 53 ARC. In addition, you must specify the US West (Oregon) Region + * for Route 53 ARC API calls. For example, use the parameter --region us-west-2 with AWS CLI commands. + * For more information, see + * + * Get and update routing control states using the API in the Amazon Route 53 Application Recovery Controller Developer Guide.

+ *

This API guide includes information about the API operations for how to get and update routing control states + * in Route 53 ARC. To work with routing control in Route 53 ARC, you must first create the required components (clusters, control + * panels, and routing controls) using the recovery cluster configuration API.

+ *

For more information about working with routing control in Route 53 ARC, see the following:

+ * + */ +export class Route53RecoveryCluster extends Route53RecoveryClusterClient implements Route53RecoveryCluster {} +createAggregatedClient(commands, Route53RecoveryCluster); diff --git a/clients/client-route53-recovery-control-config/src/Route53RecoveryControlConfig.ts b/clients/client-route53-recovery-control-config/src/Route53RecoveryControlConfig.ts index ecd9422ea3a9..42e4c22213bc 100644 --- a/clients/client-route53-recovery-control-config/src/Route53RecoveryControlConfig.ts +++ b/clients/client-route53-recovery-control-config/src/Route53RecoveryControlConfig.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -112,760 +113,399 @@ import { UpdateSafetyRuleCommandInput, UpdateSafetyRuleCommandOutput, } from "./commands/UpdateSafetyRuleCommand"; -import { Route53RecoveryControlConfigClient } from "./Route53RecoveryControlConfigClient"; +import { + Route53RecoveryControlConfigClient, + Route53RecoveryControlConfigClientConfig, +} from "./Route53RecoveryControlConfigClient"; -/** - * @public - *

Recovery Control Configuration API Reference for Amazon Route 53 Application Recovery Controller

- */ -export class Route53RecoveryControlConfig extends Route53RecoveryControlConfigClient { +const commands = { + CreateClusterCommand, + CreateControlPanelCommand, + CreateRoutingControlCommand, + CreateSafetyRuleCommand, + DeleteClusterCommand, + DeleteControlPanelCommand, + DeleteRoutingControlCommand, + DeleteSafetyRuleCommand, + DescribeClusterCommand, + DescribeControlPanelCommand, + DescribeRoutingControlCommand, + DescribeSafetyRuleCommand, + ListAssociatedRoute53HealthChecksCommand, + ListClustersCommand, + ListControlPanelsCommand, + ListRoutingControlsCommand, + ListSafetyRulesCommand, + ListTagsForResourceCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateControlPanelCommand, + UpdateRoutingControlCommand, + UpdateSafetyRuleCommand, +}; + +export interface Route53RecoveryControlConfig { /** - * @public - *

Create a new cluster. A cluster is a set of redundant Regional endpoints against which you can run API calls to update or get the state of one or more routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints (one for each supported Amazon Web Services Region) that you can use with API calls to the cluster data plane.

+ * @see {@link CreateClusterCommand} */ - public createCluster( - args: CreateClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createCluster( - args: CreateClusterCommandInput, - cb: (err: any, data?: CreateClusterCommandOutput) => void - ): void; - public createCluster( + createCluster(args: CreateClusterCommandInput, options?: __HttpHandlerOptions): Promise; + createCluster(args: CreateClusterCommandInput, cb: (err: any, data?: CreateClusterCommandOutput) => void): void; + createCluster( args: CreateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterCommandOutput) => void ): void; - public createCluster( - args: CreateClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateClusterCommandOutput) => void), - cb?: (err: any, data?: CreateClusterCommandOutput) => void - ): Promise | void { - const command = new CreateClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or Amazon Web Services Region.

+ * @see {@link CreateControlPanelCommand} */ - public createControlPanel( + createControlPanel( args: CreateControlPanelCommandInput, options?: __HttpHandlerOptions ): Promise; - public createControlPanel( + createControlPanel( args: CreateControlPanelCommandInput, cb: (err: any, data?: CreateControlPanelCommandOutput) => void ): void; - public createControlPanel( + createControlPanel( args: CreateControlPanelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateControlPanelCommandOutput) => void ): void; - public createControlPanel( - args: CreateControlPanelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateControlPanelCommandOutput) => void), - cb?: (err: any, data?: CreateControlPanelCommandOutput) => void - ): Promise | void { - const command = new CreateControlPanelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new routing control.

A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control traffic routing.

To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

+ * @see {@link CreateRoutingControlCommand} */ - public createRoutingControl( + createRoutingControl( args: CreateRoutingControlCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRoutingControl( + createRoutingControl( args: CreateRoutingControlCommandInput, cb: (err: any, data?: CreateRoutingControlCommandOutput) => void ): void; - public createRoutingControl( + createRoutingControl( args: CreateRoutingControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRoutingControlCommandOutput) => void ): void; - public createRoutingControl( - args: CreateRoutingControlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRoutingControlCommandOutput) => void), - cb?: (err: any, data?: CreateRoutingControlCommandOutput) => void - ): Promise | void { - const command = new CreateRoutingControlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a safety rule in a control panel. Safety rules let you add safeguards around changing routing control states, and for enabling and disabling routing controls, to help prevent unexpected outcomes.

There are two types of safety rules: assertion rules and gating rules.

Assertion rule: An assertion rule enforces that, when you change a routing control state, that a certain criteria is met. For example, the criteria might be that at least one routing control state is On after the transaction so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.

Gating rule: A gating rule lets you configure a gating routing control as an overall "on/off" switch for a group of routing controls. Or, you can configure more complex gating scenarios, for example by configuring multiple gating routing controls.

For more information, see Safety rules in the Amazon Route 53 Application Recovery Controller Developer Guide.

+ * @see {@link CreateSafetyRuleCommand} */ - public createSafetyRule( + createSafetyRule( args: CreateSafetyRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSafetyRule( + createSafetyRule( args: CreateSafetyRuleCommandInput, cb: (err: any, data?: CreateSafetyRuleCommandOutput) => void ): void; - public createSafetyRule( + createSafetyRule( args: CreateSafetyRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSafetyRuleCommandOutput) => void ): void; - public createSafetyRule( - args: CreateSafetyRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSafetyRuleCommandOutput) => void), - cb?: (err: any, data?: CreateSafetyRuleCommandOutput) => void - ): Promise | void { - const command = new CreateSafetyRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete a cluster.

+ * @see {@link DeleteClusterCommand} */ - public deleteCluster( - args: DeleteClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteCluster( - args: DeleteClusterCommandInput, - cb: (err: any, data?: DeleteClusterCommandOutput) => void - ): void; - public deleteCluster( + deleteCluster(args: DeleteClusterCommandInput, options?: __HttpHandlerOptions): Promise; + deleteCluster(args: DeleteClusterCommandInput, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void; + deleteCluster( args: DeleteClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClusterCommandOutput) => void ): void; - public deleteCluster( - args: DeleteClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteClusterCommandOutput) => void), - cb?: (err: any, data?: DeleteClusterCommandOutput) => void - ): Promise | void { - const command = new DeleteClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a control panel.

+ * @see {@link DeleteControlPanelCommand} */ - public deleteControlPanel( + deleteControlPanel( args: DeleteControlPanelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteControlPanel( + deleteControlPanel( args: DeleteControlPanelCommandInput, cb: (err: any, data?: DeleteControlPanelCommandOutput) => void ): void; - public deleteControlPanel( + deleteControlPanel( args: DeleteControlPanelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteControlPanelCommandOutput) => void ): void; - public deleteControlPanel( - args: DeleteControlPanelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteControlPanelCommandOutput) => void), - cb?: (err: any, data?: DeleteControlPanelCommandOutput) => void - ): Promise | void { - const command = new DeleteControlPanelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a routing control.

+ * @see {@link DeleteRoutingControlCommand} */ - public deleteRoutingControl( + deleteRoutingControl( args: DeleteRoutingControlCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRoutingControl( + deleteRoutingControl( args: DeleteRoutingControlCommandInput, cb: (err: any, data?: DeleteRoutingControlCommandOutput) => void ): void; - public deleteRoutingControl( + deleteRoutingControl( args: DeleteRoutingControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRoutingControlCommandOutput) => void ): void; - public deleteRoutingControl( - args: DeleteRoutingControlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRoutingControlCommandOutput) => void), - cb?: (err: any, data?: DeleteRoutingControlCommandOutput) => void - ): Promise | void { - const command = new DeleteRoutingControlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a safety rule.

/> + * @see {@link DeleteSafetyRuleCommand} */ - public deleteSafetyRule( + deleteSafetyRule( args: DeleteSafetyRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSafetyRule( + deleteSafetyRule( args: DeleteSafetyRuleCommandInput, cb: (err: any, data?: DeleteSafetyRuleCommandOutput) => void ): void; - public deleteSafetyRule( + deleteSafetyRule( args: DeleteSafetyRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSafetyRuleCommandOutput) => void ): void; - public deleteSafetyRule( - args: DeleteSafetyRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSafetyRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteSafetyRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteSafetyRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).

+ * @see {@link DescribeClusterCommand} */ - public describeCluster( + describeCluster( args: DescribeClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCluster( - args: DescribeClusterCommandInput, - cb: (err: any, data?: DescribeClusterCommandOutput) => void - ): void; - public describeCluster( + describeCluster(args: DescribeClusterCommandInput, cb: (err: any, data?: DescribeClusterCommandOutput) => void): void; + describeCluster( args: DescribeClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClusterCommandOutput) => void ): void; - public describeCluster( - args: DescribeClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClusterCommandOutput) => void), - cb?: (err: any, data?: DescribeClusterCommandOutput) => void - ): Promise | void { - const command = new DescribeClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays details about a control panel.

+ * @see {@link DescribeControlPanelCommand} */ - public describeControlPanel( + describeControlPanel( args: DescribeControlPanelCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeControlPanel( + describeControlPanel( args: DescribeControlPanelCommandInput, cb: (err: any, data?: DescribeControlPanelCommandOutput) => void ): void; - public describeControlPanel( + describeControlPanel( args: DescribeControlPanelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeControlPanelCommandOutput) => void ): void; - public describeControlPanel( - args: DescribeControlPanelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeControlPanelCommandOutput) => void), - cb?: (err: any, data?: DescribeControlPanelCommandOutput) => void - ): Promise | void { - const command = new DescribeControlPanelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays details about a routing control. A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.

To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

+ * @see {@link DescribeRoutingControlCommand} */ - public describeRoutingControl( + describeRoutingControl( args: DescribeRoutingControlCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRoutingControl( + describeRoutingControl( args: DescribeRoutingControlCommandInput, cb: (err: any, data?: DescribeRoutingControlCommandOutput) => void ): void; - public describeRoutingControl( + describeRoutingControl( args: DescribeRoutingControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRoutingControlCommandOutput) => void ): void; - public describeRoutingControl( - args: DescribeRoutingControlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRoutingControlCommandOutput) => void), - cb?: (err: any, data?: DescribeRoutingControlCommandOutput) => void - ): Promise | void { - const command = new DescribeRoutingControlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a safety rule.

+ * @see {@link DescribeSafetyRuleCommand} */ - public describeSafetyRule( + describeSafetyRule( args: DescribeSafetyRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSafetyRule( + describeSafetyRule( args: DescribeSafetyRuleCommandInput, cb: (err: any, data?: DescribeSafetyRuleCommandOutput) => void ): void; - public describeSafetyRule( + describeSafetyRule( args: DescribeSafetyRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSafetyRuleCommandOutput) => void ): void; - public describeSafetyRule( - args: DescribeSafetyRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSafetyRuleCommandOutput) => void), - cb?: (err: any, data?: DescribeSafetyRuleCommandOutput) => void - ): Promise | void { - const command = new DescribeSafetyRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of all Amazon Route 53 health checks associated with a specific routing control.

+ * @see {@link ListAssociatedRoute53HealthChecksCommand} */ - public listAssociatedRoute53HealthChecks( + listAssociatedRoute53HealthChecks( args: ListAssociatedRoute53HealthChecksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssociatedRoute53HealthChecks( + listAssociatedRoute53HealthChecks( args: ListAssociatedRoute53HealthChecksCommandInput, cb: (err: any, data?: ListAssociatedRoute53HealthChecksCommandOutput) => void ): void; - public listAssociatedRoute53HealthChecks( + listAssociatedRoute53HealthChecks( args: ListAssociatedRoute53HealthChecksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssociatedRoute53HealthChecksCommandOutput) => void ): void; - public listAssociatedRoute53HealthChecks( - args: ListAssociatedRoute53HealthChecksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssociatedRoute53HealthChecksCommandOutput) => void), - cb?: (err: any, data?: ListAssociatedRoute53HealthChecksCommandOutput) => void - ): Promise | void { - const command = new ListAssociatedRoute53HealthChecksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of all the clusters in an account.

+ * @see {@link ListClustersCommand} */ - public listClusters( - args: ListClustersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listClusters(args: ListClustersCommandInput, cb: (err: any, data?: ListClustersCommandOutput) => void): void; - public listClusters( + listClusters(args: ListClustersCommandInput, options?: __HttpHandlerOptions): Promise; + listClusters(args: ListClustersCommandInput, cb: (err: any, data?: ListClustersCommandOutput) => void): void; + listClusters( args: ListClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListClustersCommandOutput) => void ): void; - public listClusters( - args: ListClustersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListClustersCommandOutput) => void), - cb?: (err: any, data?: ListClustersCommandOutput) => void - ): Promise | void { - const command = new ListClustersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of control panels in an account or in a cluster.

+ * @see {@link ListControlPanelsCommand} */ - public listControlPanels( + listControlPanels( args: ListControlPanelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listControlPanels( + listControlPanels( args: ListControlPanelsCommandInput, cb: (err: any, data?: ListControlPanelsCommandOutput) => void ): void; - public listControlPanels( + listControlPanels( args: ListControlPanelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListControlPanelsCommandOutput) => void ): void; - public listControlPanels( - args: ListControlPanelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListControlPanelsCommandOutput) => void), - cb?: (err: any, data?: ListControlPanelsCommandOutput) => void - ): Promise | void { - const command = new ListControlPanelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of routing controls for a control panel. A routing control is an Amazon Route 53 Application Recovery Controller construct that has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.

+ * @see {@link ListRoutingControlsCommand} */ - public listRoutingControls( + listRoutingControls( args: ListRoutingControlsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRoutingControls( + listRoutingControls( args: ListRoutingControlsCommandInput, cb: (err: any, data?: ListRoutingControlsCommandOutput) => void ): void; - public listRoutingControls( + listRoutingControls( args: ListRoutingControlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRoutingControlsCommandOutput) => void ): void; - public listRoutingControls( - args: ListRoutingControlsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRoutingControlsCommandOutput) => void), - cb?: (err: any, data?: ListRoutingControlsCommandOutput) => void - ): Promise | void { - const command = new ListRoutingControlsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.

+ * @see {@link ListSafetyRulesCommand} */ - public listSafetyRules( + listSafetyRules( args: ListSafetyRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSafetyRules( - args: ListSafetyRulesCommandInput, - cb: (err: any, data?: ListSafetyRulesCommandOutput) => void - ): void; - public listSafetyRules( + listSafetyRules(args: ListSafetyRulesCommandInput, cb: (err: any, data?: ListSafetyRulesCommandOutput) => void): void; + listSafetyRules( args: ListSafetyRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSafetyRulesCommandOutput) => void ): void; - public listSafetyRules( - args: ListSafetyRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSafetyRulesCommandOutput) => void), - cb?: (err: any, data?: ListSafetyRulesCommandOutput) => void - ): Promise | void { - const command = new ListSafetyRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags for a resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a tag to a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a tag from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a control panel. The only update you can make to a control panel is to change the name of the control panel.

+ * @see {@link UpdateControlPanelCommand} */ - public updateControlPanel( + updateControlPanel( args: UpdateControlPanelCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateControlPanel( + updateControlPanel( args: UpdateControlPanelCommandInput, cb: (err: any, data?: UpdateControlPanelCommandOutput) => void ): void; - public updateControlPanel( + updateControlPanel( args: UpdateControlPanelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateControlPanelCommandOutput) => void ): void; - public updateControlPanel( - args: UpdateControlPanelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateControlPanelCommandOutput) => void), - cb?: (err: any, data?: UpdateControlPanelCommandOutput) => void - ): Promise | void { - const command = new UpdateControlPanelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a routing control. You can only update the name of the routing control. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

+ * @see {@link UpdateRoutingControlCommand} */ - public updateRoutingControl( + updateRoutingControl( args: UpdateRoutingControlCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRoutingControl( + updateRoutingControl( args: UpdateRoutingControlCommandInput, cb: (err: any, data?: UpdateRoutingControlCommandOutput) => void ): void; - public updateRoutingControl( + updateRoutingControl( args: UpdateRoutingControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRoutingControlCommandOutput) => void ): void; - public updateRoutingControl( - args: UpdateRoutingControlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRoutingControlCommandOutput) => void), - cb?: (err: any, data?: UpdateRoutingControlCommandOutput) => void - ): Promise | void { - const command = new UpdateRoutingControlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update a safety rule (an assertion rule or gating rule). You can only update the name and the waiting period for a safety rule. To make other updates, delete the safety rule and create a new one.

+ * @see {@link UpdateSafetyRuleCommand} */ - public updateSafetyRule( + updateSafetyRule( args: UpdateSafetyRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSafetyRule( + updateSafetyRule( args: UpdateSafetyRuleCommandInput, cb: (err: any, data?: UpdateSafetyRuleCommandOutput) => void ): void; - public updateSafetyRule( + updateSafetyRule( args: UpdateSafetyRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSafetyRuleCommandOutput) => void ): void; - public updateSafetyRule( - args: UpdateSafetyRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSafetyRuleCommandOutput) => void), - cb?: (err: any, data?: UpdateSafetyRuleCommandOutput) => void - ): Promise | void { - const command = new UpdateSafetyRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Recovery Control Configuration API Reference for Amazon Route 53 Application Recovery Controller

+ */ +export class Route53RecoveryControlConfig + extends Route53RecoveryControlConfigClient + implements Route53RecoveryControlConfig {} +createAggregatedClient(commands, Route53RecoveryControlConfig); diff --git a/clients/client-route53-recovery-readiness/src/Route53RecoveryReadiness.ts b/clients/client-route53-recovery-readiness/src/Route53RecoveryReadiness.ts index c742a74b7146..bdfd63fc8640 100644 --- a/clients/client-route53-recovery-readiness/src/Route53RecoveryReadiness.ts +++ b/clients/client-route53-recovery-readiness/src/Route53RecoveryReadiness.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { CreateCellCommand, CreateCellCommandInput, CreateCellCommandOutput } from "./commands/CreateCellCommand"; @@ -133,1024 +134,541 @@ import { UpdateResourceSetCommandInput, UpdateResourceSetCommandOutput, } from "./commands/UpdateResourceSetCommand"; -import { Route53RecoveryReadinessClient } from "./Route53RecoveryReadinessClient"; +import { Route53RecoveryReadinessClient, Route53RecoveryReadinessClientConfig } from "./Route53RecoveryReadinessClient"; -/** - * @public - *

Recovery readiness

- */ -export class Route53RecoveryReadiness extends Route53RecoveryReadinessClient { +const commands = { + CreateCellCommand, + CreateCrossAccountAuthorizationCommand, + CreateReadinessCheckCommand, + CreateRecoveryGroupCommand, + CreateResourceSetCommand, + DeleteCellCommand, + DeleteCrossAccountAuthorizationCommand, + DeleteReadinessCheckCommand, + DeleteRecoveryGroupCommand, + DeleteResourceSetCommand, + GetArchitectureRecommendationsCommand, + GetCellCommand, + GetCellReadinessSummaryCommand, + GetReadinessCheckCommand, + GetReadinessCheckResourceStatusCommand, + GetReadinessCheckStatusCommand, + GetRecoveryGroupCommand, + GetRecoveryGroupReadinessSummaryCommand, + GetResourceSetCommand, + ListCellsCommand, + ListCrossAccountAuthorizationsCommand, + ListReadinessChecksCommand, + ListRecoveryGroupsCommand, + ListResourceSetsCommand, + ListRulesCommand, + ListTagsForResourcesCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateCellCommand, + UpdateReadinessCheckCommand, + UpdateRecoveryGroupCommand, + UpdateResourceSetCommand, +}; + +export interface Route53RecoveryReadiness { /** - * @public - *

Creates a cell in an account.

+ * @see {@link CreateCellCommand} */ - public createCell(args: CreateCellCommandInput, options?: __HttpHandlerOptions): Promise; - public createCell(args: CreateCellCommandInput, cb: (err: any, data?: CreateCellCommandOutput) => void): void; - public createCell( + createCell(args: CreateCellCommandInput, options?: __HttpHandlerOptions): Promise; + createCell(args: CreateCellCommandInput, cb: (err: any, data?: CreateCellCommandOutput) => void): void; + createCell( args: CreateCellCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCellCommandOutput) => void ): void; - public createCell( - args: CreateCellCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCellCommandOutput) => void), - cb?: (err: any, data?: CreateCellCommandOutput) => void - ): Promise | void { - const command = new CreateCellCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a cross-account readiness authorization. This lets you authorize another account to work with Route 53 Application Recovery Controller, for example, to check the readiness status of resources in a separate account.

+ * @see {@link CreateCrossAccountAuthorizationCommand} */ - public createCrossAccountAuthorization( + createCrossAccountAuthorization( args: CreateCrossAccountAuthorizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCrossAccountAuthorization( + createCrossAccountAuthorization( args: CreateCrossAccountAuthorizationCommandInput, cb: (err: any, data?: CreateCrossAccountAuthorizationCommandOutput) => void ): void; - public createCrossAccountAuthorization( + createCrossAccountAuthorization( args: CreateCrossAccountAuthorizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCrossAccountAuthorizationCommandOutput) => void ): void; - public createCrossAccountAuthorization( - args: CreateCrossAccountAuthorizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCrossAccountAuthorizationCommandOutput) => void), - cb?: (err: any, data?: CreateCrossAccountAuthorizationCommandOutput) => void - ): Promise | void { - const command = new CreateCrossAccountAuthorizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a readiness check in an account. A readiness check monitors a resource set in your application, such as a set of Amazon Aurora instances, that Application Recovery Controller is auditing recovery readiness for. The audits run once every minute on every resource that's associated with a readiness check.

+ * @see {@link CreateReadinessCheckCommand} */ - public createReadinessCheck( + createReadinessCheck( args: CreateReadinessCheckCommandInput, options?: __HttpHandlerOptions ): Promise; - public createReadinessCheck( + createReadinessCheck( args: CreateReadinessCheckCommandInput, cb: (err: any, data?: CreateReadinessCheckCommandOutput) => void ): void; - public createReadinessCheck( + createReadinessCheck( args: CreateReadinessCheckCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReadinessCheckCommandOutput) => void ): void; - public createReadinessCheck( - args: CreateReadinessCheckCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateReadinessCheckCommandOutput) => void), - cb?: (err: any, data?: CreateReadinessCheckCommandOutput) => void - ): Promise | void { - const command = new CreateReadinessCheckCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a recovery group in an account. A recovery group corresponds to an application and includes a list of the cells that make up the application.

+ * @see {@link CreateRecoveryGroupCommand} */ - public createRecoveryGroup( + createRecoveryGroup( args: CreateRecoveryGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRecoveryGroup( + createRecoveryGroup( args: CreateRecoveryGroupCommandInput, cb: (err: any, data?: CreateRecoveryGroupCommandOutput) => void ): void; - public createRecoveryGroup( + createRecoveryGroup( args: CreateRecoveryGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRecoveryGroupCommandOutput) => void ): void; - public createRecoveryGroup( - args: CreateRecoveryGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRecoveryGroupCommandOutput) => void), - cb?: (err: any, data?: CreateRecoveryGroupCommandOutput) => void - ): Promise | void { - const command = new CreateRecoveryGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a resource set. A resource set is a set of resources of one type that span multiple cells. You can associate a resource set with a readiness check to monitor the resources for failover readiness.

+ * @see {@link CreateResourceSetCommand} */ - public createResourceSet( + createResourceSet( args: CreateResourceSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createResourceSet( + createResourceSet( args: CreateResourceSetCommandInput, cb: (err: any, data?: CreateResourceSetCommandOutput) => void ): void; - public createResourceSet( + createResourceSet( args: CreateResourceSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResourceSetCommandOutput) => void ): void; - public createResourceSet( - args: CreateResourceSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateResourceSetCommandOutput) => void), - cb?: (err: any, data?: CreateResourceSetCommandOutput) => void - ): Promise | void { - const command = new CreateResourceSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete a cell. When successful, the response code is 204, with no response body.

+ * @see {@link DeleteCellCommand} */ - public deleteCell(args: DeleteCellCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteCell(args: DeleteCellCommandInput, cb: (err: any, data?: DeleteCellCommandOutput) => void): void; - public deleteCell( + deleteCell(args: DeleteCellCommandInput, options?: __HttpHandlerOptions): Promise; + deleteCell(args: DeleteCellCommandInput, cb: (err: any, data?: DeleteCellCommandOutput) => void): void; + deleteCell( args: DeleteCellCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCellCommandOutput) => void ): void; - public deleteCell( - args: DeleteCellCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCellCommandOutput) => void), - cb?: (err: any, data?: DeleteCellCommandOutput) => void - ): Promise | void { - const command = new DeleteCellCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes cross account readiness authorization.

+ * @see {@link DeleteCrossAccountAuthorizationCommand} */ - public deleteCrossAccountAuthorization( + deleteCrossAccountAuthorization( args: DeleteCrossAccountAuthorizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCrossAccountAuthorization( + deleteCrossAccountAuthorization( args: DeleteCrossAccountAuthorizationCommandInput, cb: (err: any, data?: DeleteCrossAccountAuthorizationCommandOutput) => void ): void; - public deleteCrossAccountAuthorization( + deleteCrossAccountAuthorization( args: DeleteCrossAccountAuthorizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCrossAccountAuthorizationCommandOutput) => void ): void; - public deleteCrossAccountAuthorization( - args: DeleteCrossAccountAuthorizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCrossAccountAuthorizationCommandOutput) => void), - cb?: (err: any, data?: DeleteCrossAccountAuthorizationCommandOutput) => void - ): Promise | void { - const command = new DeleteCrossAccountAuthorizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a readiness check.

+ * @see {@link DeleteReadinessCheckCommand} */ - public deleteReadinessCheck( + deleteReadinessCheck( args: DeleteReadinessCheckCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteReadinessCheck( + deleteReadinessCheck( args: DeleteReadinessCheckCommandInput, cb: (err: any, data?: DeleteReadinessCheckCommandOutput) => void ): void; - public deleteReadinessCheck( + deleteReadinessCheck( args: DeleteReadinessCheckCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReadinessCheckCommandOutput) => void ): void; - public deleteReadinessCheck( - args: DeleteReadinessCheckCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteReadinessCheckCommandOutput) => void), - cb?: (err: any, data?: DeleteReadinessCheckCommandOutput) => void - ): Promise | void { - const command = new DeleteReadinessCheckCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a recovery group.

+ * @see {@link DeleteRecoveryGroupCommand} */ - public deleteRecoveryGroup( + deleteRecoveryGroup( args: DeleteRecoveryGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRecoveryGroup( + deleteRecoveryGroup( args: DeleteRecoveryGroupCommandInput, cb: (err: any, data?: DeleteRecoveryGroupCommandOutput) => void ): void; - public deleteRecoveryGroup( + deleteRecoveryGroup( args: DeleteRecoveryGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRecoveryGroupCommandOutput) => void ): void; - public deleteRecoveryGroup( - args: DeleteRecoveryGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRecoveryGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteRecoveryGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteRecoveryGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a resource set.

+ * @see {@link DeleteResourceSetCommand} */ - public deleteResourceSet( + deleteResourceSet( args: DeleteResourceSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourceSet( + deleteResourceSet( args: DeleteResourceSetCommandInput, cb: (err: any, data?: DeleteResourceSetCommandOutput) => void ): void; - public deleteResourceSet( + deleteResourceSet( args: DeleteResourceSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourceSetCommandOutput) => void ): void; - public deleteResourceSet( - args: DeleteResourceSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourceSetCommandOutput) => void), - cb?: (err: any, data?: DeleteResourceSetCommandOutput) => void - ): Promise | void { - const command = new DeleteResourceSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets recommendations about architecture designs for improving resiliency for an application, based on a recovery group.

+ * @see {@link GetArchitectureRecommendationsCommand} */ - public getArchitectureRecommendations( + getArchitectureRecommendations( args: GetArchitectureRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getArchitectureRecommendations( + getArchitectureRecommendations( args: GetArchitectureRecommendationsCommandInput, cb: (err: any, data?: GetArchitectureRecommendationsCommandOutput) => void ): void; - public getArchitectureRecommendations( + getArchitectureRecommendations( args: GetArchitectureRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetArchitectureRecommendationsCommandOutput) => void ): void; - public getArchitectureRecommendations( - args: GetArchitectureRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetArchitectureRecommendationsCommandOutput) => void), - cb?: (err: any, data?: GetArchitectureRecommendationsCommandOutput) => void - ): Promise | void { - const command = new GetArchitectureRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a cell including cell name, cell Amazon Resource Name (ARN), ARNs of nested cells for this cell, and a list of those cell ARNs with their associated recovery group ARNs.

+ * @see {@link GetCellCommand} */ - public getCell(args: GetCellCommandInput, options?: __HttpHandlerOptions): Promise; - public getCell(args: GetCellCommandInput, cb: (err: any, data?: GetCellCommandOutput) => void): void; - public getCell( + getCell(args: GetCellCommandInput, options?: __HttpHandlerOptions): Promise; + getCell(args: GetCellCommandInput, cb: (err: any, data?: GetCellCommandOutput) => void): void; + getCell( args: GetCellCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCellCommandOutput) => void ): void; - public getCell( - args: GetCellCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCellCommandOutput) => void), - cb?: (err: any, data?: GetCellCommandOutput) => void - ): Promise | void { - const command = new GetCellCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets readiness for a cell. Aggregates the readiness of all the resources that are associated with the cell into a single value.

+ * @see {@link GetCellReadinessSummaryCommand} */ - public getCellReadinessSummary( + getCellReadinessSummary( args: GetCellReadinessSummaryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCellReadinessSummary( + getCellReadinessSummary( args: GetCellReadinessSummaryCommandInput, cb: (err: any, data?: GetCellReadinessSummaryCommandOutput) => void ): void; - public getCellReadinessSummary( + getCellReadinessSummary( args: GetCellReadinessSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCellReadinessSummaryCommandOutput) => void ): void; - public getCellReadinessSummary( - args: GetCellReadinessSummaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCellReadinessSummaryCommandOutput) => void), - cb?: (err: any, data?: GetCellReadinessSummaryCommandOutput) => void - ): Promise | void { - const command = new GetCellReadinessSummaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets details about a readiness check.

+ * @see {@link GetReadinessCheckCommand} */ - public getReadinessCheck( + getReadinessCheck( args: GetReadinessCheckCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReadinessCheck( + getReadinessCheck( args: GetReadinessCheckCommandInput, cb: (err: any, data?: GetReadinessCheckCommandOutput) => void ): void; - public getReadinessCheck( + getReadinessCheck( args: GetReadinessCheckCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReadinessCheckCommandOutput) => void ): void; - public getReadinessCheck( - args: GetReadinessCheckCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReadinessCheckCommandOutput) => void), - cb?: (err: any, data?: GetReadinessCheckCommandOutput) => void - ): Promise | void { - const command = new GetReadinessCheckCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets individual readiness status for a readiness check. To see the overall readiness status for a recovery group, that considers the readiness status for all the readiness checks in the recovery group, use GetRecoveryGroupReadinessSummary.

+ * @see {@link GetReadinessCheckResourceStatusCommand} */ - public getReadinessCheckResourceStatus( + getReadinessCheckResourceStatus( args: GetReadinessCheckResourceStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReadinessCheckResourceStatus( + getReadinessCheckResourceStatus( args: GetReadinessCheckResourceStatusCommandInput, cb: (err: any, data?: GetReadinessCheckResourceStatusCommandOutput) => void ): void; - public getReadinessCheckResourceStatus( + getReadinessCheckResourceStatus( args: GetReadinessCheckResourceStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReadinessCheckResourceStatusCommandOutput) => void ): void; - public getReadinessCheckResourceStatus( - args: GetReadinessCheckResourceStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReadinessCheckResourceStatusCommandOutput) => void), - cb?: (err: any, data?: GetReadinessCheckResourceStatusCommandOutput) => void - ): Promise | void { - const command = new GetReadinessCheckResourceStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the readiness status for an individual readiness check. To see the overall readiness status for a recovery group, that considers the readiness status for all the readiness checks in a recovery group, use GetRecoveryGroupReadinessSummary.

+ * @see {@link GetReadinessCheckStatusCommand} */ - public getReadinessCheckStatus( + getReadinessCheckStatus( args: GetReadinessCheckStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReadinessCheckStatus( + getReadinessCheckStatus( args: GetReadinessCheckStatusCommandInput, cb: (err: any, data?: GetReadinessCheckStatusCommandOutput) => void ): void; - public getReadinessCheckStatus( + getReadinessCheckStatus( args: GetReadinessCheckStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReadinessCheckStatusCommandOutput) => void ): void; - public getReadinessCheckStatus( - args: GetReadinessCheckStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReadinessCheckStatusCommandOutput) => void), - cb?: (err: any, data?: GetReadinessCheckStatusCommandOutput) => void - ): Promise | void { - const command = new GetReadinessCheckStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets details about a recovery group, including a list of the cells that are included in it.

+ * @see {@link GetRecoveryGroupCommand} */ - public getRecoveryGroup( + getRecoveryGroup( args: GetRecoveryGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRecoveryGroup( + getRecoveryGroup( args: GetRecoveryGroupCommandInput, cb: (err: any, data?: GetRecoveryGroupCommandOutput) => void ): void; - public getRecoveryGroup( + getRecoveryGroup( args: GetRecoveryGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRecoveryGroupCommandOutput) => void ): void; - public getRecoveryGroup( - args: GetRecoveryGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRecoveryGroupCommandOutput) => void), - cb?: (err: any, data?: GetRecoveryGroupCommandOutput) => void - ): Promise | void { - const command = new GetRecoveryGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays a summary of information about a recovery group's readiness status. Includes the readiness checks for resources in the recovery group and the readiness status of each one.

+ * @see {@link GetRecoveryGroupReadinessSummaryCommand} */ - public getRecoveryGroupReadinessSummary( + getRecoveryGroupReadinessSummary( args: GetRecoveryGroupReadinessSummaryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRecoveryGroupReadinessSummary( + getRecoveryGroupReadinessSummary( args: GetRecoveryGroupReadinessSummaryCommandInput, cb: (err: any, data?: GetRecoveryGroupReadinessSummaryCommandOutput) => void ): void; - public getRecoveryGroupReadinessSummary( + getRecoveryGroupReadinessSummary( args: GetRecoveryGroupReadinessSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRecoveryGroupReadinessSummaryCommandOutput) => void ): void; - public getRecoveryGroupReadinessSummary( - args: GetRecoveryGroupReadinessSummaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRecoveryGroupReadinessSummaryCommandOutput) => void), - cb?: (err: any, data?: GetRecoveryGroupReadinessSummaryCommandOutput) => void - ): Promise | void { - const command = new GetRecoveryGroupReadinessSummaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays the details about a resource set, including a list of the resources in the set.

+ * @see {@link GetResourceSetCommand} */ - public getResourceSet( + getResourceSet( args: GetResourceSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourceSet( - args: GetResourceSetCommandInput, - cb: (err: any, data?: GetResourceSetCommandOutput) => void - ): void; - public getResourceSet( + getResourceSet(args: GetResourceSetCommandInput, cb: (err: any, data?: GetResourceSetCommandOutput) => void): void; + getResourceSet( args: GetResourceSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceSetCommandOutput) => void ): void; - public getResourceSet( - args: GetResourceSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourceSetCommandOutput) => void), - cb?: (err: any, data?: GetResourceSetCommandOutput) => void - ): Promise | void { - const command = new GetResourceSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the cells for an account.

+ * @see {@link ListCellsCommand} */ - public listCells(args: ListCellsCommandInput, options?: __HttpHandlerOptions): Promise; - public listCells(args: ListCellsCommandInput, cb: (err: any, data?: ListCellsCommandOutput) => void): void; - public listCells( + listCells(args: ListCellsCommandInput, options?: __HttpHandlerOptions): Promise; + listCells(args: ListCellsCommandInput, cb: (err: any, data?: ListCellsCommandOutput) => void): void; + listCells( args: ListCellsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCellsCommandOutput) => void ): void; - public listCells( - args: ListCellsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCellsCommandOutput) => void), - cb?: (err: any, data?: ListCellsCommandOutput) => void - ): Promise | void { - const command = new ListCellsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the cross-account readiness authorizations that are in place for an account.

+ * @see {@link ListCrossAccountAuthorizationsCommand} */ - public listCrossAccountAuthorizations( + listCrossAccountAuthorizations( args: ListCrossAccountAuthorizationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCrossAccountAuthorizations( + listCrossAccountAuthorizations( args: ListCrossAccountAuthorizationsCommandInput, cb: (err: any, data?: ListCrossAccountAuthorizationsCommandOutput) => void ): void; - public listCrossAccountAuthorizations( + listCrossAccountAuthorizations( args: ListCrossAccountAuthorizationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCrossAccountAuthorizationsCommandOutput) => void ): void; - public listCrossAccountAuthorizations( - args: ListCrossAccountAuthorizationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCrossAccountAuthorizationsCommandOutput) => void), - cb?: (err: any, data?: ListCrossAccountAuthorizationsCommandOutput) => void - ): Promise | void { - const command = new ListCrossAccountAuthorizationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the readiness checks for an account.

+ * @see {@link ListReadinessChecksCommand} */ - public listReadinessChecks( + listReadinessChecks( args: ListReadinessChecksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReadinessChecks( + listReadinessChecks( args: ListReadinessChecksCommandInput, cb: (err: any, data?: ListReadinessChecksCommandOutput) => void ): void; - public listReadinessChecks( + listReadinessChecks( args: ListReadinessChecksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReadinessChecksCommandOutput) => void ): void; - public listReadinessChecks( - args: ListReadinessChecksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReadinessChecksCommandOutput) => void), - cb?: (err: any, data?: ListReadinessChecksCommandOutput) => void - ): Promise | void { - const command = new ListReadinessChecksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the recovery groups in an account.

+ * @see {@link ListRecoveryGroupsCommand} */ - public listRecoveryGroups( + listRecoveryGroups( args: ListRecoveryGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRecoveryGroups( + listRecoveryGroups( args: ListRecoveryGroupsCommandInput, cb: (err: any, data?: ListRecoveryGroupsCommandOutput) => void ): void; - public listRecoveryGroups( + listRecoveryGroups( args: ListRecoveryGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecoveryGroupsCommandOutput) => void ): void; - public listRecoveryGroups( - args: ListRecoveryGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRecoveryGroupsCommandOutput) => void), - cb?: (err: any, data?: ListRecoveryGroupsCommandOutput) => void - ): Promise | void { - const command = new ListRecoveryGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the resource sets in an account.

+ * @see {@link ListResourceSetsCommand} */ - public listResourceSets( + listResourceSets( args: ListResourceSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourceSets( + listResourceSets( args: ListResourceSetsCommandInput, cb: (err: any, data?: ListResourceSetsCommandOutput) => void ): void; - public listResourceSets( + listResourceSets( args: ListResourceSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceSetsCommandOutput) => void ): void; - public listResourceSets( - args: ListResourceSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourceSetsCommandOutput) => void), - cb?: (err: any, data?: ListResourceSetsCommandOutput) => void - ): Promise | void { - const command = new ListResourceSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all readiness rules, or lists the readiness rules for a specific resource type.

+ * @see {@link ListRulesCommand} */ - public listRules(args: ListRulesCommandInput, options?: __HttpHandlerOptions): Promise; - public listRules(args: ListRulesCommandInput, cb: (err: any, data?: ListRulesCommandOutput) => void): void; - public listRules( + listRules(args: ListRulesCommandInput, options?: __HttpHandlerOptions): Promise; + listRules(args: ListRulesCommandInput, cb: (err: any, data?: ListRulesCommandOutput) => void): void; + listRules( args: ListRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRulesCommandOutput) => void ): void; - public listRules( - args: ListRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRulesCommandOutput) => void), - cb?: (err: any, data?: ListRulesCommandOutput) => void - ): Promise | void { - const command = new ListRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags for a resource.

+ * @see {@link ListTagsForResourcesCommand} */ - public listTagsForResources( + listTagsForResources( args: ListTagsForResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResources( + listTagsForResources( args: ListTagsForResourcesCommandInput, cb: (err: any, data?: ListTagsForResourcesCommandOutput) => void ): void; - public listTagsForResources( + listTagsForResources( args: ListTagsForResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourcesCommandOutput) => void ): void; - public listTagsForResources( - args: ListTagsForResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourcesCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourcesCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a tag to a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a tag from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a cell to replace the list of nested cells with a new list of nested cells.

+ * @see {@link UpdateCellCommand} */ - public updateCell(args: UpdateCellCommandInput, options?: __HttpHandlerOptions): Promise; - public updateCell(args: UpdateCellCommandInput, cb: (err: any, data?: UpdateCellCommandOutput) => void): void; - public updateCell( + updateCell(args: UpdateCellCommandInput, options?: __HttpHandlerOptions): Promise; + updateCell(args: UpdateCellCommandInput, cb: (err: any, data?: UpdateCellCommandOutput) => void): void; + updateCell( args: UpdateCellCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCellCommandOutput) => void ): void; - public updateCell( - args: UpdateCellCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCellCommandOutput) => void), - cb?: (err: any, data?: UpdateCellCommandOutput) => void - ): Promise | void { - const command = new UpdateCellCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a readiness check.

+ * @see {@link UpdateReadinessCheckCommand} */ - public updateReadinessCheck( + updateReadinessCheck( args: UpdateReadinessCheckCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateReadinessCheck( + updateReadinessCheck( args: UpdateReadinessCheckCommandInput, cb: (err: any, data?: UpdateReadinessCheckCommandOutput) => void ): void; - public updateReadinessCheck( + updateReadinessCheck( args: UpdateReadinessCheckCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateReadinessCheckCommandOutput) => void ): void; - public updateReadinessCheck( - args: UpdateReadinessCheckCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateReadinessCheckCommandOutput) => void), - cb?: (err: any, data?: UpdateReadinessCheckCommandOutput) => void - ): Promise | void { - const command = new UpdateReadinessCheckCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a recovery group.

+ * @see {@link UpdateRecoveryGroupCommand} */ - public updateRecoveryGroup( + updateRecoveryGroup( args: UpdateRecoveryGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRecoveryGroup( + updateRecoveryGroup( args: UpdateRecoveryGroupCommandInput, cb: (err: any, data?: UpdateRecoveryGroupCommandOutput) => void ): void; - public updateRecoveryGroup( + updateRecoveryGroup( args: UpdateRecoveryGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRecoveryGroupCommandOutput) => void ): void; - public updateRecoveryGroup( - args: UpdateRecoveryGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRecoveryGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateRecoveryGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateRecoveryGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a resource set.

+ * @see {@link UpdateResourceSetCommand} */ - public updateResourceSet( + updateResourceSet( args: UpdateResourceSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateResourceSet( + updateResourceSet( args: UpdateResourceSetCommandInput, cb: (err: any, data?: UpdateResourceSetCommandOutput) => void ): void; - public updateResourceSet( + updateResourceSet( args: UpdateResourceSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResourceSetCommandOutput) => void ): void; - public updateResourceSet( - args: UpdateResourceSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResourceSetCommandOutput) => void), - cb?: (err: any, data?: UpdateResourceSetCommandOutput) => void - ): Promise | void { - const command = new UpdateResourceSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Recovery readiness

+ */ +export class Route53RecoveryReadiness extends Route53RecoveryReadinessClient implements Route53RecoveryReadiness {} +createAggregatedClient(commands, Route53RecoveryReadiness); diff --git a/clients/client-route53resolver/src/Route53Resolver.ts b/clients/client-route53resolver/src/Route53Resolver.ts index 0248d2bad57e..289559a1d319 100644 --- a/clients/client-route53resolver/src/Route53Resolver.ts +++ b/clients/client-route53resolver/src/Route53Resolver.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -312,2231 +313,1161 @@ import { UpdateResolverRuleCommandInput, UpdateResolverRuleCommandOutput, } from "./commands/UpdateResolverRuleCommand"; -import { Route53ResolverClient } from "./Route53ResolverClient"; +import { Route53ResolverClient, Route53ResolverClientConfig } from "./Route53ResolverClient"; -/** - * @public - *

When you create a VPC using Amazon VPC, you automatically get DNS resolution within the VPC - * from Route 53 Resolver. By default, Resolver answers DNS queries for VPC domain names - * such as domain names for EC2 instances or Elastic Load Balancing load balancers. - * Resolver performs recursive lookups against public name servers for all other domain - * names.

- *

You can also configure DNS resolution between your VPC and your network over a Direct Connect or VPN connection:

- *

- * Forward DNS queries from resolvers on your network to Route 53 Resolver - *

- *

DNS resolvers on your network can forward DNS queries to Resolver in a specified VPC. This allows your DNS resolvers - * to easily resolve domain names for Amazon Web Services resources such as EC2 instances or records in a Route 53 private hosted zone. - * For more information, see - * How DNS Resolvers - * on Your Network Forward DNS Queries to Route 53 Resolver in the Amazon Route 53 Developer Guide.

- *

- * Conditionally forward queries from a VPC to resolvers on your network - *

- *

You can configure Resolver to forward queries that it receives from EC2 instances in your VPCs to DNS resolvers on your network. - * To forward selected queries, you create Resolver rules that specify the domain names for the DNS queries that you want to forward - * (such as example.com), and the IP addresses of the DNS resolvers on your network that you want to forward the queries to. - * If a query matches multiple rules (example.com, acme.example.com), Resolver chooses the rule with the most specific match - * (acme.example.com) and forwards the query to the IP addresses that you specified in that rule. For more information, see - * How Route 53 Resolver - * Forwards DNS Queries from Your VPCs to Your Network in the Amazon Route 53 Developer Guide.

- *

Like Amazon VPC, Resolver is Regional. In each Region where you have VPCs, you can choose - * whether to forward queries from your VPCs to your network (outbound queries), from your - * network to your VPCs (inbound queries), or both.

- */ -export class Route53Resolver extends Route53ResolverClient { +const commands = { + AssociateFirewallRuleGroupCommand, + AssociateResolverEndpointIpAddressCommand, + AssociateResolverQueryLogConfigCommand, + AssociateResolverRuleCommand, + CreateFirewallDomainListCommand, + CreateFirewallRuleCommand, + CreateFirewallRuleGroupCommand, + CreateResolverEndpointCommand, + CreateResolverQueryLogConfigCommand, + CreateResolverRuleCommand, + DeleteFirewallDomainListCommand, + DeleteFirewallRuleCommand, + DeleteFirewallRuleGroupCommand, + DeleteResolverEndpointCommand, + DeleteResolverQueryLogConfigCommand, + DeleteResolverRuleCommand, + DisassociateFirewallRuleGroupCommand, + DisassociateResolverEndpointIpAddressCommand, + DisassociateResolverQueryLogConfigCommand, + DisassociateResolverRuleCommand, + GetFirewallConfigCommand, + GetFirewallDomainListCommand, + GetFirewallRuleGroupCommand, + GetFirewallRuleGroupAssociationCommand, + GetFirewallRuleGroupPolicyCommand, + GetResolverConfigCommand, + GetResolverDnssecConfigCommand, + GetResolverEndpointCommand, + GetResolverQueryLogConfigCommand, + GetResolverQueryLogConfigAssociationCommand, + GetResolverQueryLogConfigPolicyCommand, + GetResolverRuleCommand, + GetResolverRuleAssociationCommand, + GetResolverRulePolicyCommand, + ImportFirewallDomainsCommand, + ListFirewallConfigsCommand, + ListFirewallDomainListsCommand, + ListFirewallDomainsCommand, + ListFirewallRuleGroupAssociationsCommand, + ListFirewallRuleGroupsCommand, + ListFirewallRulesCommand, + ListResolverConfigsCommand, + ListResolverDnssecConfigsCommand, + ListResolverEndpointIpAddressesCommand, + ListResolverEndpointsCommand, + ListResolverQueryLogConfigAssociationsCommand, + ListResolverQueryLogConfigsCommand, + ListResolverRuleAssociationsCommand, + ListResolverRulesCommand, + ListTagsForResourceCommand, + PutFirewallRuleGroupPolicyCommand, + PutResolverQueryLogConfigPolicyCommand, + PutResolverRulePolicyCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateFirewallConfigCommand, + UpdateFirewallDomainsCommand, + UpdateFirewallRuleCommand, + UpdateFirewallRuleGroupAssociationCommand, + UpdateResolverConfigCommand, + UpdateResolverDnssecConfigCommand, + UpdateResolverEndpointCommand, + UpdateResolverRuleCommand, +}; + +export interface Route53Resolver { /** - * @public - *

Associates a FirewallRuleGroup with a VPC, to provide DNS filtering for the VPC.

+ * @see {@link AssociateFirewallRuleGroupCommand} */ - public associateFirewallRuleGroup( + associateFirewallRuleGroup( args: AssociateFirewallRuleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateFirewallRuleGroup( + associateFirewallRuleGroup( args: AssociateFirewallRuleGroupCommandInput, cb: (err: any, data?: AssociateFirewallRuleGroupCommandOutput) => void ): void; - public associateFirewallRuleGroup( + associateFirewallRuleGroup( args: AssociateFirewallRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateFirewallRuleGroupCommandOutput) => void ): void; - public associateFirewallRuleGroup( - args: AssociateFirewallRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateFirewallRuleGroupCommandOutput) => void), - cb?: (err: any, data?: AssociateFirewallRuleGroupCommandOutput) => void - ): Promise | void { - const command = new AssociateFirewallRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds IP addresses to an inbound or an outbound Resolver endpoint. If you want to add more than one IP address, - * submit one AssociateResolverEndpointIpAddress request for each IP address.

- *

To remove an IP address from an endpoint, see - * DisassociateResolverEndpointIpAddress. - *

+ * @see {@link AssociateResolverEndpointIpAddressCommand} */ - public associateResolverEndpointIpAddress( + associateResolverEndpointIpAddress( args: AssociateResolverEndpointIpAddressCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateResolverEndpointIpAddress( + associateResolverEndpointIpAddress( args: AssociateResolverEndpointIpAddressCommandInput, cb: (err: any, data?: AssociateResolverEndpointIpAddressCommandOutput) => void ): void; - public associateResolverEndpointIpAddress( + associateResolverEndpointIpAddress( args: AssociateResolverEndpointIpAddressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateResolverEndpointIpAddressCommandOutput) => void ): void; - public associateResolverEndpointIpAddress( - args: AssociateResolverEndpointIpAddressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateResolverEndpointIpAddressCommandOutput) => void), - cb?: (err: any, data?: AssociateResolverEndpointIpAddressCommandOutput) => void - ): Promise | void { - const command = new AssociateResolverEndpointIpAddressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates an Amazon VPC with a specified query logging configuration. Route 53 Resolver logs DNS queries that originate in all of the Amazon VPCs - * that are associated with a specified query logging configuration. To associate more than one VPC with a configuration, submit one AssociateResolverQueryLogConfig - * request for each VPC.

- * - *

The VPCs that you associate with a query logging configuration must be in the same Region as the configuration.

- *
- *

To remove a VPC from a query logging configuration, see - * DisassociateResolverQueryLogConfig. - *

+ * @see {@link AssociateResolverQueryLogConfigCommand} */ - public associateResolverQueryLogConfig( + associateResolverQueryLogConfig( args: AssociateResolverQueryLogConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateResolverQueryLogConfig( + associateResolverQueryLogConfig( args: AssociateResolverQueryLogConfigCommandInput, cb: (err: any, data?: AssociateResolverQueryLogConfigCommandOutput) => void ): void; - public associateResolverQueryLogConfig( + associateResolverQueryLogConfig( args: AssociateResolverQueryLogConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateResolverQueryLogConfigCommandOutput) => void ): void; - public associateResolverQueryLogConfig( - args: AssociateResolverQueryLogConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateResolverQueryLogConfigCommandOutput) => void), - cb?: (err: any, data?: AssociateResolverQueryLogConfigCommandOutput) => void - ): Promise | void { - const command = new AssociateResolverQueryLogConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a Resolver rule with a VPC. When you associate a rule with a VPC, Resolver forwards all DNS queries - * for the domain name that is specified in the rule and that originate in the VPC. The queries are forwarded to the - * IP addresses for the DNS resolvers that are specified in the rule. For more information about rules, see - * CreateResolverRule.

+ * @see {@link AssociateResolverRuleCommand} */ - public associateResolverRule( + associateResolverRule( args: AssociateResolverRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateResolverRule( + associateResolverRule( args: AssociateResolverRuleCommandInput, cb: (err: any, data?: AssociateResolverRuleCommandOutput) => void ): void; - public associateResolverRule( + associateResolverRule( args: AssociateResolverRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateResolverRuleCommandOutput) => void ): void; - public associateResolverRule( - args: AssociateResolverRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateResolverRuleCommandOutput) => void), - cb?: (err: any, data?: AssociateResolverRuleCommandOutput) => void - ): Promise | void { - const command = new AssociateResolverRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an empty firewall domain list for use in DNS Firewall rules. You can populate the domains for the new list with a file, using ImportFirewallDomains, or with domain strings, using UpdateFirewallDomains.

+ * @see {@link CreateFirewallDomainListCommand} */ - public createFirewallDomainList( + createFirewallDomainList( args: CreateFirewallDomainListCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFirewallDomainList( + createFirewallDomainList( args: CreateFirewallDomainListCommandInput, cb: (err: any, data?: CreateFirewallDomainListCommandOutput) => void ): void; - public createFirewallDomainList( + createFirewallDomainList( args: CreateFirewallDomainListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFirewallDomainListCommandOutput) => void ): void; - public createFirewallDomainList( - args: CreateFirewallDomainListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFirewallDomainListCommandOutput) => void), - cb?: (err: any, data?: CreateFirewallDomainListCommandOutput) => void - ): Promise | void { - const command = new CreateFirewallDomainListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a single DNS Firewall rule in the specified rule group, using the specified domain list.

+ * @see {@link CreateFirewallRuleCommand} */ - public createFirewallRule( + createFirewallRule( args: CreateFirewallRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFirewallRule( + createFirewallRule( args: CreateFirewallRuleCommandInput, cb: (err: any, data?: CreateFirewallRuleCommandOutput) => void ): void; - public createFirewallRule( + createFirewallRule( args: CreateFirewallRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFirewallRuleCommandOutput) => void ): void; - public createFirewallRule( - args: CreateFirewallRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFirewallRuleCommandOutput) => void), - cb?: (err: any, data?: CreateFirewallRuleCommandOutput) => void - ): Promise | void { - const command = new CreateFirewallRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an empty DNS Firewall rule group for filtering DNS network traffic in a VPC. You can add rules to the new rule group - * by calling CreateFirewallRule.

+ * @see {@link CreateFirewallRuleGroupCommand} */ - public createFirewallRuleGroup( + createFirewallRuleGroup( args: CreateFirewallRuleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFirewallRuleGroup( + createFirewallRuleGroup( args: CreateFirewallRuleGroupCommandInput, cb: (err: any, data?: CreateFirewallRuleGroupCommandOutput) => void ): void; - public createFirewallRuleGroup( + createFirewallRuleGroup( args: CreateFirewallRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFirewallRuleGroupCommandOutput) => void ): void; - public createFirewallRuleGroup( - args: CreateFirewallRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFirewallRuleGroupCommandOutput) => void), - cb?: (err: any, data?: CreateFirewallRuleGroupCommandOutput) => void - ): Promise | void { - const command = new CreateFirewallRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a Resolver endpoint. There are two types of Resolver endpoints, inbound and outbound:

- *
    - *
  • - *

    An inbound Resolver endpoint forwards DNS queries to the DNS service for a VPC - * from your network.

    - *
  • - *
  • - *

    An outbound Resolver endpoint forwards DNS queries from the DNS service for a VPC - * to your network.

    - *
  • - *
+ * @see {@link CreateResolverEndpointCommand} */ - public createResolverEndpoint( + createResolverEndpoint( args: CreateResolverEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createResolverEndpoint( + createResolverEndpoint( args: CreateResolverEndpointCommandInput, cb: (err: any, data?: CreateResolverEndpointCommandOutput) => void ): void; - public createResolverEndpoint( + createResolverEndpoint( args: CreateResolverEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResolverEndpointCommandOutput) => void ): void; - public createResolverEndpoint( - args: CreateResolverEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateResolverEndpointCommandOutput) => void), - cb?: (err: any, data?: CreateResolverEndpointCommandOutput) => void - ): Promise | void { - const command = new CreateResolverEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a Resolver query logging configuration, which defines where you want Resolver to save DNS query logs that originate in your VPCs. - * Resolver can log queries only for VPCs that are in the same Region as the query logging configuration.

- *

To specify which VPCs you want to log queries for, you use AssociateResolverQueryLogConfig. For more information, see - * AssociateResolverQueryLogConfig.

- *

You can optionally use Resource Access Manager (RAM) to share a query logging configuration with other Amazon Web Services accounts. The other accounts - * can then associate VPCs with the configuration. The query logs that Resolver creates for a configuration include all DNS queries that originate in all - * VPCs that are associated with the configuration.

+ * @see {@link CreateResolverQueryLogConfigCommand} */ - public createResolverQueryLogConfig( + createResolverQueryLogConfig( args: CreateResolverQueryLogConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public createResolverQueryLogConfig( + createResolverQueryLogConfig( args: CreateResolverQueryLogConfigCommandInput, cb: (err: any, data?: CreateResolverQueryLogConfigCommandOutput) => void ): void; - public createResolverQueryLogConfig( + createResolverQueryLogConfig( args: CreateResolverQueryLogConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResolverQueryLogConfigCommandOutput) => void ): void; - public createResolverQueryLogConfig( - args: CreateResolverQueryLogConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateResolverQueryLogConfigCommandOutput) => void), - cb?: (err: any, data?: CreateResolverQueryLogConfigCommandOutput) => void - ): Promise | void { - const command = new CreateResolverQueryLogConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

For DNS queries that originate in your VPCs, specifies which Resolver endpoint the queries pass through, - * one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network.

+ * @see {@link CreateResolverRuleCommand} */ - public createResolverRule( + createResolverRule( args: CreateResolverRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createResolverRule( + createResolverRule( args: CreateResolverRuleCommandInput, cb: (err: any, data?: CreateResolverRuleCommandOutput) => void ): void; - public createResolverRule( + createResolverRule( args: CreateResolverRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResolverRuleCommandOutput) => void ): void; - public createResolverRule( - args: CreateResolverRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateResolverRuleCommandOutput) => void), - cb?: (err: any, data?: CreateResolverRuleCommandOutput) => void - ): Promise | void { - const command = new CreateResolverRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified domain list.

+ * @see {@link DeleteFirewallDomainListCommand} */ - public deleteFirewallDomainList( + deleteFirewallDomainList( args: DeleteFirewallDomainListCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFirewallDomainList( + deleteFirewallDomainList( args: DeleteFirewallDomainListCommandInput, cb: (err: any, data?: DeleteFirewallDomainListCommandOutput) => void ): void; - public deleteFirewallDomainList( + deleteFirewallDomainList( args: DeleteFirewallDomainListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFirewallDomainListCommandOutput) => void ): void; - public deleteFirewallDomainList( - args: DeleteFirewallDomainListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFirewallDomainListCommandOutput) => void), - cb?: (err: any, data?: DeleteFirewallDomainListCommandOutput) => void - ): Promise | void { - const command = new DeleteFirewallDomainListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified firewall rule.

+ * @see {@link DeleteFirewallRuleCommand} */ - public deleteFirewallRule( + deleteFirewallRule( args: DeleteFirewallRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFirewallRule( + deleteFirewallRule( args: DeleteFirewallRuleCommandInput, cb: (err: any, data?: DeleteFirewallRuleCommandOutput) => void ): void; - public deleteFirewallRule( + deleteFirewallRule( args: DeleteFirewallRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFirewallRuleCommandOutput) => void ): void; - public deleteFirewallRule( - args: DeleteFirewallRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFirewallRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteFirewallRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteFirewallRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified firewall rule group.

+ * @see {@link DeleteFirewallRuleGroupCommand} */ - public deleteFirewallRuleGroup( + deleteFirewallRuleGroup( args: DeleteFirewallRuleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFirewallRuleGroup( + deleteFirewallRuleGroup( args: DeleteFirewallRuleGroupCommandInput, cb: (err: any, data?: DeleteFirewallRuleGroupCommandOutput) => void ): void; - public deleteFirewallRuleGroup( + deleteFirewallRuleGroup( args: DeleteFirewallRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFirewallRuleGroupCommandOutput) => void ): void; - public deleteFirewallRuleGroup( - args: DeleteFirewallRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFirewallRuleGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteFirewallRuleGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteFirewallRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Resolver endpoint. The effect of deleting a Resolver endpoint depends on whether it's an inbound or an outbound - * Resolver endpoint:

- *
    - *
  • - *

    - * Inbound: DNS queries from your network are no longer routed - * to the DNS service for the specified VPC.

    - *
  • - *
  • - *

    - * Outbound: DNS queries from a VPC are no longer routed to your network.

    - *
  • - *
+ * @see {@link DeleteResolverEndpointCommand} */ - public deleteResolverEndpoint( + deleteResolverEndpoint( args: DeleteResolverEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResolverEndpoint( + deleteResolverEndpoint( args: DeleteResolverEndpointCommandInput, cb: (err: any, data?: DeleteResolverEndpointCommandOutput) => void ): void; - public deleteResolverEndpoint( + deleteResolverEndpoint( args: DeleteResolverEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResolverEndpointCommandOutput) => void ): void; - public deleteResolverEndpoint( - args: DeleteResolverEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResolverEndpointCommandOutput) => void), - cb?: (err: any, data?: DeleteResolverEndpointCommandOutput) => void - ): Promise | void { - const command = new DeleteResolverEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a query logging configuration. When you delete a configuration, Resolver stops logging DNS queries for all of the Amazon VPCs that are - * associated with the configuration. This also applies if the query logging configuration is shared with other Amazon Web Services accounts, and - * the other accounts have associated VPCs with the shared configuration.

- *

Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. See - * DisassociateResolverQueryLogConfig.

- *

If you used Resource Access Manager (RAM) to share a query logging configuration with other accounts, you must stop sharing - * the configuration before you can delete a configuration. The accounts that you shared the configuration with can first disassociate VPCs - * that they associated with the configuration, but that's not necessary. If you stop sharing the configuration, those VPCs are automatically - * disassociated from the configuration.

+ * @see {@link DeleteResolverQueryLogConfigCommand} */ - public deleteResolverQueryLogConfig( + deleteResolverQueryLogConfig( args: DeleteResolverQueryLogConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResolverQueryLogConfig( + deleteResolverQueryLogConfig( args: DeleteResolverQueryLogConfigCommandInput, cb: (err: any, data?: DeleteResolverQueryLogConfigCommandOutput) => void ): void; - public deleteResolverQueryLogConfig( + deleteResolverQueryLogConfig( args: DeleteResolverQueryLogConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResolverQueryLogConfigCommandOutput) => void ): void; - public deleteResolverQueryLogConfig( - args: DeleteResolverQueryLogConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResolverQueryLogConfigCommandOutput) => void), - cb?: (err: any, data?: DeleteResolverQueryLogConfigCommandOutput) => void - ): Promise | void { - const command = new DeleteResolverQueryLogConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Resolver rule. Before you can delete a Resolver rule, you must disassociate it from all the VPCs that you - * associated the Resolver rule with. For more information, see - * DisassociateResolverRule.

+ * @see {@link DeleteResolverRuleCommand} */ - public deleteResolverRule( + deleteResolverRule( args: DeleteResolverRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResolverRule( + deleteResolverRule( args: DeleteResolverRuleCommandInput, cb: (err: any, data?: DeleteResolverRuleCommandOutput) => void ): void; - public deleteResolverRule( + deleteResolverRule( args: DeleteResolverRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResolverRuleCommandOutput) => void ): void; - public deleteResolverRule( - args: DeleteResolverRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResolverRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteResolverRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteResolverRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates a FirewallRuleGroup from a VPC, to remove DNS filtering from the VPC.

+ * @see {@link DisassociateFirewallRuleGroupCommand} */ - public disassociateFirewallRuleGroup( + disassociateFirewallRuleGroup( args: DisassociateFirewallRuleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateFirewallRuleGroup( + disassociateFirewallRuleGroup( args: DisassociateFirewallRuleGroupCommandInput, cb: (err: any, data?: DisassociateFirewallRuleGroupCommandOutput) => void ): void; - public disassociateFirewallRuleGroup( + disassociateFirewallRuleGroup( args: DisassociateFirewallRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateFirewallRuleGroupCommandOutput) => void ): void; - public disassociateFirewallRuleGroup( - args: DisassociateFirewallRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateFirewallRuleGroupCommandOutput) => void), - cb?: (err: any, data?: DisassociateFirewallRuleGroupCommandOutput) => void - ): Promise | void { - const command = new DisassociateFirewallRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes IP addresses from an inbound or an outbound Resolver endpoint. If you want to remove more than one IP address, - * submit one DisassociateResolverEndpointIpAddress request for each IP address.

- *

To add an IP address to an endpoint, see - * AssociateResolverEndpointIpAddress. - *

+ * @see {@link DisassociateResolverEndpointIpAddressCommand} */ - public disassociateResolverEndpointIpAddress( + disassociateResolverEndpointIpAddress( args: DisassociateResolverEndpointIpAddressCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateResolverEndpointIpAddress( + disassociateResolverEndpointIpAddress( args: DisassociateResolverEndpointIpAddressCommandInput, cb: (err: any, data?: DisassociateResolverEndpointIpAddressCommandOutput) => void ): void; - public disassociateResolverEndpointIpAddress( + disassociateResolverEndpointIpAddress( args: DisassociateResolverEndpointIpAddressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateResolverEndpointIpAddressCommandOutput) => void ): void; - public disassociateResolverEndpointIpAddress( - args: DisassociateResolverEndpointIpAddressCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociateResolverEndpointIpAddressCommandOutput) => void), - cb?: (err: any, data?: DisassociateResolverEndpointIpAddressCommandOutput) => void - ): Promise | void { - const command = new DisassociateResolverEndpointIpAddressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates a VPC from a query logging configuration.

- * - *

Before you can delete a query logging configuration, you must first disassociate all VPCs - * from the configuration. If you used Resource Access Manager (RAM) to share a - * query logging configuration with other accounts, VPCs can be disassociated from the - * configuration in the following ways:

- *
    - *
  • - *

    The accounts that you shared the configuration with can disassociate VPCs from the configuration.

    - *
  • - *
  • - *

    You can stop sharing the configuration.

    - *
  • - *
- *
+ * @see {@link DisassociateResolverQueryLogConfigCommand} */ - public disassociateResolverQueryLogConfig( + disassociateResolverQueryLogConfig( args: DisassociateResolverQueryLogConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateResolverQueryLogConfig( + disassociateResolverQueryLogConfig( args: DisassociateResolverQueryLogConfigCommandInput, cb: (err: any, data?: DisassociateResolverQueryLogConfigCommandOutput) => void ): void; - public disassociateResolverQueryLogConfig( + disassociateResolverQueryLogConfig( args: DisassociateResolverQueryLogConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateResolverQueryLogConfigCommandOutput) => void ): void; - public disassociateResolverQueryLogConfig( - args: DisassociateResolverQueryLogConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateResolverQueryLogConfigCommandOutput) => void), - cb?: (err: any, data?: DisassociateResolverQueryLogConfigCommandOutput) => void - ): Promise | void { - const command = new DisassociateResolverQueryLogConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the association between a specified Resolver rule and a specified VPC.

- * - *

If you disassociate a Resolver rule from a VPC, Resolver stops forwarding DNS queries for the - * domain name that you specified in the Resolver rule.

- *
+ * @see {@link DisassociateResolverRuleCommand} */ - public disassociateResolverRule( + disassociateResolverRule( args: DisassociateResolverRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateResolverRule( + disassociateResolverRule( args: DisassociateResolverRuleCommandInput, cb: (err: any, data?: DisassociateResolverRuleCommandOutput) => void ): void; - public disassociateResolverRule( + disassociateResolverRule( args: DisassociateResolverRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateResolverRuleCommandOutput) => void ): void; - public disassociateResolverRule( - args: DisassociateResolverRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateResolverRuleCommandOutput) => void), - cb?: (err: any, data?: DisassociateResolverRuleCommandOutput) => void - ): Promise | void { - const command = new DisassociateResolverRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the configuration of the firewall behavior provided by DNS Firewall for a - * single VPC from Amazon Virtual Private Cloud (Amazon VPC).

+ * @see {@link GetFirewallConfigCommand} */ - public getFirewallConfig( + getFirewallConfig( args: GetFirewallConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFirewallConfig( + getFirewallConfig( args: GetFirewallConfigCommandInput, cb: (err: any, data?: GetFirewallConfigCommandOutput) => void ): void; - public getFirewallConfig( + getFirewallConfig( args: GetFirewallConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFirewallConfigCommandOutput) => void ): void; - public getFirewallConfig( - args: GetFirewallConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFirewallConfigCommandOutput) => void), - cb?: (err: any, data?: GetFirewallConfigCommandOutput) => void - ): Promise | void { - const command = new GetFirewallConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the specified firewall domain list.

+ * @see {@link GetFirewallDomainListCommand} */ - public getFirewallDomainList( + getFirewallDomainList( args: GetFirewallDomainListCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFirewallDomainList( + getFirewallDomainList( args: GetFirewallDomainListCommandInput, cb: (err: any, data?: GetFirewallDomainListCommandOutput) => void ): void; - public getFirewallDomainList( + getFirewallDomainList( args: GetFirewallDomainListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFirewallDomainListCommandOutput) => void ): void; - public getFirewallDomainList( - args: GetFirewallDomainListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFirewallDomainListCommandOutput) => void), - cb?: (err: any, data?: GetFirewallDomainListCommandOutput) => void - ): Promise | void { - const command = new GetFirewallDomainListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the specified firewall rule group.

+ * @see {@link GetFirewallRuleGroupCommand} */ - public getFirewallRuleGroup( + getFirewallRuleGroup( args: GetFirewallRuleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFirewallRuleGroup( + getFirewallRuleGroup( args: GetFirewallRuleGroupCommandInput, cb: (err: any, data?: GetFirewallRuleGroupCommandOutput) => void ): void; - public getFirewallRuleGroup( + getFirewallRuleGroup( args: GetFirewallRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFirewallRuleGroupCommandOutput) => void ): void; - public getFirewallRuleGroup( - args: GetFirewallRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFirewallRuleGroupCommandOutput) => void), - cb?: (err: any, data?: GetFirewallRuleGroupCommandOutput) => void - ): Promise | void { - const command = new GetFirewallRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a firewall rule group association, which enables DNS filtering for a VPC with one rule group. A VPC can have more than one firewall rule group association, and a rule group can be associated with more than one VPC.

+ * @see {@link GetFirewallRuleGroupAssociationCommand} */ - public getFirewallRuleGroupAssociation( + getFirewallRuleGroupAssociation( args: GetFirewallRuleGroupAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFirewallRuleGroupAssociation( + getFirewallRuleGroupAssociation( args: GetFirewallRuleGroupAssociationCommandInput, cb: (err: any, data?: GetFirewallRuleGroupAssociationCommandOutput) => void ): void; - public getFirewallRuleGroupAssociation( + getFirewallRuleGroupAssociation( args: GetFirewallRuleGroupAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFirewallRuleGroupAssociationCommandOutput) => void ): void; - public getFirewallRuleGroupAssociation( - args: GetFirewallRuleGroupAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFirewallRuleGroupAssociationCommandOutput) => void), - cb?: (err: any, data?: GetFirewallRuleGroupAssociationCommandOutput) => void - ): Promise | void { - const command = new GetFirewallRuleGroupAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the Identity and Access Management (Amazon Web Services IAM) policy for sharing the - * specified rule group. You can use the policy to share the rule group using Resource Access Manager (RAM).

+ * @see {@link GetFirewallRuleGroupPolicyCommand} */ - public getFirewallRuleGroupPolicy( + getFirewallRuleGroupPolicy( args: GetFirewallRuleGroupPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFirewallRuleGroupPolicy( + getFirewallRuleGroupPolicy( args: GetFirewallRuleGroupPolicyCommandInput, cb: (err: any, data?: GetFirewallRuleGroupPolicyCommandOutput) => void ): void; - public getFirewallRuleGroupPolicy( + getFirewallRuleGroupPolicy( args: GetFirewallRuleGroupPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFirewallRuleGroupPolicyCommandOutput) => void ): void; - public getFirewallRuleGroupPolicy( - args: GetFirewallRuleGroupPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFirewallRuleGroupPolicyCommandOutput) => void), - cb?: (err: any, data?: GetFirewallRuleGroupPolicyCommandOutput) => void - ): Promise | void { - const command = new GetFirewallRuleGroupPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the behavior configuration of Route 53 Resolver behavior for a single VPC from - * Amazon Virtual Private Cloud.

+ * @see {@link GetResolverConfigCommand} */ - public getResolverConfig( + getResolverConfig( args: GetResolverConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResolverConfig( + getResolverConfig( args: GetResolverConfigCommandInput, cb: (err: any, data?: GetResolverConfigCommandOutput) => void ): void; - public getResolverConfig( + getResolverConfig( args: GetResolverConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResolverConfigCommandOutput) => void ): void; - public getResolverConfig( - args: GetResolverConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResolverConfigCommandOutput) => void), - cb?: (err: any, data?: GetResolverConfigCommandOutput) => void - ): Promise | void { - const command = new GetResolverConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets DNSSEC validation information for a specified resource.

+ * @see {@link GetResolverDnssecConfigCommand} */ - public getResolverDnssecConfig( + getResolverDnssecConfig( args: GetResolverDnssecConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResolverDnssecConfig( + getResolverDnssecConfig( args: GetResolverDnssecConfigCommandInput, cb: (err: any, data?: GetResolverDnssecConfigCommandOutput) => void ): void; - public getResolverDnssecConfig( + getResolverDnssecConfig( args: GetResolverDnssecConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResolverDnssecConfigCommandOutput) => void ): void; - public getResolverDnssecConfig( - args: GetResolverDnssecConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResolverDnssecConfigCommandOutput) => void), - cb?: (err: any, data?: GetResolverDnssecConfigCommandOutput) => void - ): Promise | void { - const command = new GetResolverDnssecConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a specified Resolver endpoint, such as whether it's an inbound or an outbound Resolver endpoint, and the - * current status of the endpoint.

+ * @see {@link GetResolverEndpointCommand} */ - public getResolverEndpoint( + getResolverEndpoint( args: GetResolverEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResolverEndpoint( + getResolverEndpoint( args: GetResolverEndpointCommandInput, cb: (err: any, data?: GetResolverEndpointCommandOutput) => void ): void; - public getResolverEndpoint( + getResolverEndpoint( args: GetResolverEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResolverEndpointCommandOutput) => void ): void; - public getResolverEndpoint( - args: GetResolverEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResolverEndpointCommandOutput) => void), - cb?: (err: any, data?: GetResolverEndpointCommandOutput) => void - ): Promise | void { - const command = new GetResolverEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a specified Resolver query logging configuration, such as the number of VPCs that the configuration - * is logging queries for and the location that logs are sent to.

+ * @see {@link GetResolverQueryLogConfigCommand} */ - public getResolverQueryLogConfig( + getResolverQueryLogConfig( args: GetResolverQueryLogConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResolverQueryLogConfig( + getResolverQueryLogConfig( args: GetResolverQueryLogConfigCommandInput, cb: (err: any, data?: GetResolverQueryLogConfigCommandOutput) => void ): void; - public getResolverQueryLogConfig( + getResolverQueryLogConfig( args: GetResolverQueryLogConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResolverQueryLogConfigCommandOutput) => void ): void; - public getResolverQueryLogConfig( - args: GetResolverQueryLogConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResolverQueryLogConfigCommandOutput) => void), - cb?: (err: any, data?: GetResolverQueryLogConfigCommandOutput) => void - ): Promise | void { - const command = new GetResolverQueryLogConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a specified association between a Resolver query logging configuration and an Amazon VPC. When you associate a VPC - * with a query logging configuration, Resolver logs DNS queries that originate in that VPC.

+ * @see {@link GetResolverQueryLogConfigAssociationCommand} */ - public getResolverQueryLogConfigAssociation( + getResolverQueryLogConfigAssociation( args: GetResolverQueryLogConfigAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResolverQueryLogConfigAssociation( + getResolverQueryLogConfigAssociation( args: GetResolverQueryLogConfigAssociationCommandInput, cb: (err: any, data?: GetResolverQueryLogConfigAssociationCommandOutput) => void ): void; - public getResolverQueryLogConfigAssociation( + getResolverQueryLogConfigAssociation( args: GetResolverQueryLogConfigAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResolverQueryLogConfigAssociationCommandOutput) => void ): void; - public getResolverQueryLogConfigAssociation( - args: GetResolverQueryLogConfigAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResolverQueryLogConfigAssociationCommandOutput) => void), - cb?: (err: any, data?: GetResolverQueryLogConfigAssociationCommandOutput) => void - ): Promise | void { - const command = new GetResolverQueryLogConfigAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a query logging policy. A query logging policy specifies the Resolver query logging - * operations and resources that you want to allow another Amazon Web Services account to be able to use.

+ * @see {@link GetResolverQueryLogConfigPolicyCommand} */ - public getResolverQueryLogConfigPolicy( + getResolverQueryLogConfigPolicy( args: GetResolverQueryLogConfigPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResolverQueryLogConfigPolicy( + getResolverQueryLogConfigPolicy( args: GetResolverQueryLogConfigPolicyCommandInput, cb: (err: any, data?: GetResolverQueryLogConfigPolicyCommandOutput) => void ): void; - public getResolverQueryLogConfigPolicy( + getResolverQueryLogConfigPolicy( args: GetResolverQueryLogConfigPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResolverQueryLogConfigPolicyCommandOutput) => void ): void; - public getResolverQueryLogConfigPolicy( - args: GetResolverQueryLogConfigPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResolverQueryLogConfigPolicyCommandOutput) => void), - cb?: (err: any, data?: GetResolverQueryLogConfigPolicyCommandOutput) => void - ): Promise | void { - const command = new GetResolverQueryLogConfigPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a specified Resolver rule, such as the domain name that the rule forwards DNS queries for and the ID of the - * outbound Resolver endpoint that the rule is associated with.

+ * @see {@link GetResolverRuleCommand} */ - public getResolverRule( + getResolverRule( args: GetResolverRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResolverRule( - args: GetResolverRuleCommandInput, - cb: (err: any, data?: GetResolverRuleCommandOutput) => void - ): void; - public getResolverRule( + getResolverRule(args: GetResolverRuleCommandInput, cb: (err: any, data?: GetResolverRuleCommandOutput) => void): void; + getResolverRule( args: GetResolverRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResolverRuleCommandOutput) => void ): void; - public getResolverRule( - args: GetResolverRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResolverRuleCommandOutput) => void), - cb?: (err: any, data?: GetResolverRuleCommandOutput) => void - ): Promise | void { - const command = new GetResolverRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about an association between a specified Resolver rule and a VPC. You associate a Resolver rule and a VPC using - * AssociateResolverRule.

+ * @see {@link GetResolverRuleAssociationCommand} */ - public getResolverRuleAssociation( + getResolverRuleAssociation( args: GetResolverRuleAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResolverRuleAssociation( + getResolverRuleAssociation( args: GetResolverRuleAssociationCommandInput, cb: (err: any, data?: GetResolverRuleAssociationCommandOutput) => void ): void; - public getResolverRuleAssociation( + getResolverRuleAssociation( args: GetResolverRuleAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResolverRuleAssociationCommandOutput) => void ): void; - public getResolverRuleAssociation( - args: GetResolverRuleAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResolverRuleAssociationCommandOutput) => void), - cb?: (err: any, data?: GetResolverRuleAssociationCommandOutput) => void - ): Promise | void { - const command = new GetResolverRuleAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about the Resolver rule policy for a specified rule. A Resolver rule policy includes the rule that you want to share - * with another account, the account that you want to share the rule with, and the Resolver operations that you want to allow the account to use.

+ * @see {@link GetResolverRulePolicyCommand} */ - public getResolverRulePolicy( + getResolverRulePolicy( args: GetResolverRulePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResolverRulePolicy( + getResolverRulePolicy( args: GetResolverRulePolicyCommandInput, cb: (err: any, data?: GetResolverRulePolicyCommandOutput) => void ): void; - public getResolverRulePolicy( + getResolverRulePolicy( args: GetResolverRulePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResolverRulePolicyCommandOutput) => void ): void; - public getResolverRulePolicy( - args: GetResolverRulePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResolverRulePolicyCommandOutput) => void), - cb?: (err: any, data?: GetResolverRulePolicyCommandOutput) => void - ): Promise | void { - const command = new GetResolverRulePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Imports domain names from a file into a domain list, for use in a DNS firewall rule group.

- *

Each domain specification in your domain list must satisfy the following - * requirements:

- *
    - *
  • - *

    It can optionally start with * (asterisk).

    - *
  • - *
  • - *

    With the exception of the optional starting asterisk, it must only contain - * the following characters: A-Z, a-z, - * 0-9, - (hyphen).

    - *
  • - *
  • - *

    It must be from 1-255 characters in length.

    - *
  • - *
+ * @see {@link ImportFirewallDomainsCommand} */ - public importFirewallDomains( + importFirewallDomains( args: ImportFirewallDomainsCommandInput, options?: __HttpHandlerOptions ): Promise; - public importFirewallDomains( + importFirewallDomains( args: ImportFirewallDomainsCommandInput, cb: (err: any, data?: ImportFirewallDomainsCommandOutput) => void ): void; - public importFirewallDomains( + importFirewallDomains( args: ImportFirewallDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportFirewallDomainsCommandOutput) => void ): void; - public importFirewallDomains( - args: ImportFirewallDomainsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportFirewallDomainsCommandOutput) => void), - cb?: (err: any, data?: ImportFirewallDomainsCommandOutput) => void - ): Promise | void { - const command = new ImportFirewallDomainsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the firewall configurations that you have defined. DNS Firewall uses the configurations to manage firewall behavior for your VPCs.

- *

A single call might return only a partial list of the configurations. For information, see MaxResults.

+ * @see {@link ListFirewallConfigsCommand} */ - public listFirewallConfigs( + listFirewallConfigs( args: ListFirewallConfigsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFirewallConfigs( + listFirewallConfigs( args: ListFirewallConfigsCommandInput, cb: (err: any, data?: ListFirewallConfigsCommandOutput) => void ): void; - public listFirewallConfigs( + listFirewallConfigs( args: ListFirewallConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFirewallConfigsCommandOutput) => void ): void; - public listFirewallConfigs( - args: ListFirewallConfigsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFirewallConfigsCommandOutput) => void), - cb?: (err: any, data?: ListFirewallConfigsCommandOutput) => void - ): Promise | void { - const command = new ListFirewallConfigsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the firewall domain lists that you have defined. For each firewall domain list, you can retrieve the domains that are defined for a list by calling ListFirewallDomains.

- *

A single call to this list operation might return only a partial list of the domain lists. For information, see MaxResults.

+ * @see {@link ListFirewallDomainListsCommand} */ - public listFirewallDomainLists( + listFirewallDomainLists( args: ListFirewallDomainListsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFirewallDomainLists( + listFirewallDomainLists( args: ListFirewallDomainListsCommandInput, cb: (err: any, data?: ListFirewallDomainListsCommandOutput) => void ): void; - public listFirewallDomainLists( + listFirewallDomainLists( args: ListFirewallDomainListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFirewallDomainListsCommandOutput) => void ): void; - public listFirewallDomainLists( - args: ListFirewallDomainListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFirewallDomainListsCommandOutput) => void), - cb?: (err: any, data?: ListFirewallDomainListsCommandOutput) => void - ): Promise | void { - const command = new ListFirewallDomainListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the domains that you have defined for the specified firewall domain list.

- *

A single call might return only a partial list of the domains. For information, see MaxResults.

+ * @see {@link ListFirewallDomainsCommand} */ - public listFirewallDomains( + listFirewallDomains( args: ListFirewallDomainsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFirewallDomains( + listFirewallDomains( args: ListFirewallDomainsCommandInput, cb: (err: any, data?: ListFirewallDomainsCommandOutput) => void ): void; - public listFirewallDomains( + listFirewallDomains( args: ListFirewallDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFirewallDomainsCommandOutput) => void ): void; - public listFirewallDomains( - args: ListFirewallDomainsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFirewallDomainsCommandOutput) => void), - cb?: (err: any, data?: ListFirewallDomainsCommandOutput) => void - ): Promise | void { - const command = new ListFirewallDomainsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the firewall rule group associations that you have defined. Each association enables DNS filtering for a VPC with one rule group.

- *

A single call might return only a partial list of the associations. For information, see MaxResults.

+ * @see {@link ListFirewallRuleGroupAssociationsCommand} */ - public listFirewallRuleGroupAssociations( + listFirewallRuleGroupAssociations( args: ListFirewallRuleGroupAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFirewallRuleGroupAssociations( + listFirewallRuleGroupAssociations( args: ListFirewallRuleGroupAssociationsCommandInput, cb: (err: any, data?: ListFirewallRuleGroupAssociationsCommandOutput) => void ): void; - public listFirewallRuleGroupAssociations( + listFirewallRuleGroupAssociations( args: ListFirewallRuleGroupAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFirewallRuleGroupAssociationsCommandOutput) => void ): void; - public listFirewallRuleGroupAssociations( - args: ListFirewallRuleGroupAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFirewallRuleGroupAssociationsCommandOutput) => void), - cb?: (err: any, data?: ListFirewallRuleGroupAssociationsCommandOutput) => void - ): Promise | void { - const command = new ListFirewallRuleGroupAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the minimal high-level information for the rule groups that you have defined.

- *

A single call might return only a partial list of the rule groups. For information, see MaxResults.

+ * @see {@link ListFirewallRuleGroupsCommand} */ - public listFirewallRuleGroups( + listFirewallRuleGroups( args: ListFirewallRuleGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFirewallRuleGroups( + listFirewallRuleGroups( args: ListFirewallRuleGroupsCommandInput, cb: (err: any, data?: ListFirewallRuleGroupsCommandOutput) => void ): void; - public listFirewallRuleGroups( + listFirewallRuleGroups( args: ListFirewallRuleGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFirewallRuleGroupsCommandOutput) => void ): void; - public listFirewallRuleGroups( - args: ListFirewallRuleGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFirewallRuleGroupsCommandOutput) => void), - cb?: (err: any, data?: ListFirewallRuleGroupsCommandOutput) => void - ): Promise | void { - const command = new ListFirewallRuleGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the firewall rules that you have defined for the specified firewall rule group. DNS Firewall uses the rules in a rule group to filter DNS network traffic for a VPC.

- *

A single call might return only a partial list of the rules. For information, see MaxResults.

+ * @see {@link ListFirewallRulesCommand} */ - public listFirewallRules( + listFirewallRules( args: ListFirewallRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFirewallRules( + listFirewallRules( args: ListFirewallRulesCommandInput, cb: (err: any, data?: ListFirewallRulesCommandOutput) => void ): void; - public listFirewallRules( + listFirewallRules( args: ListFirewallRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFirewallRulesCommandOutput) => void ): void; - public listFirewallRules( - args: ListFirewallRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFirewallRulesCommandOutput) => void), - cb?: (err: any, data?: ListFirewallRulesCommandOutput) => void - ): Promise | void { - const command = new ListFirewallRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the Resolver configurations that you have defined. - * Route 53 Resolver uses the configurations to manage DNS resolution behavior for your VPCs.

+ * @see {@link ListResolverConfigsCommand} */ - public listResolverConfigs( + listResolverConfigs( args: ListResolverConfigsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResolverConfigs( + listResolverConfigs( args: ListResolverConfigsCommandInput, cb: (err: any, data?: ListResolverConfigsCommandOutput) => void ): void; - public listResolverConfigs( + listResolverConfigs( args: ListResolverConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResolverConfigsCommandOutput) => void ): void; - public listResolverConfigs( - args: ListResolverConfigsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResolverConfigsCommandOutput) => void), - cb?: (err: any, data?: ListResolverConfigsCommandOutput) => void - ): Promise | void { - const command = new ListResolverConfigsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the configurations for DNSSEC validation that are associated with the current Amazon Web Services account.

+ * @see {@link ListResolverDnssecConfigsCommand} */ - public listResolverDnssecConfigs( + listResolverDnssecConfigs( args: ListResolverDnssecConfigsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResolverDnssecConfigs( + listResolverDnssecConfigs( args: ListResolverDnssecConfigsCommandInput, cb: (err: any, data?: ListResolverDnssecConfigsCommandOutput) => void ): void; - public listResolverDnssecConfigs( + listResolverDnssecConfigs( args: ListResolverDnssecConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResolverDnssecConfigsCommandOutput) => void ): void; - public listResolverDnssecConfigs( - args: ListResolverDnssecConfigsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResolverDnssecConfigsCommandOutput) => void), - cb?: (err: any, data?: ListResolverDnssecConfigsCommandOutput) => void - ): Promise | void { - const command = new ListResolverDnssecConfigsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the IP addresses for a specified Resolver endpoint.

+ * @see {@link ListResolverEndpointIpAddressesCommand} */ - public listResolverEndpointIpAddresses( + listResolverEndpointIpAddresses( args: ListResolverEndpointIpAddressesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResolverEndpointIpAddresses( + listResolverEndpointIpAddresses( args: ListResolverEndpointIpAddressesCommandInput, cb: (err: any, data?: ListResolverEndpointIpAddressesCommandOutput) => void ): void; - public listResolverEndpointIpAddresses( + listResolverEndpointIpAddresses( args: ListResolverEndpointIpAddressesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResolverEndpointIpAddressesCommandOutput) => void ): void; - public listResolverEndpointIpAddresses( - args: ListResolverEndpointIpAddressesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResolverEndpointIpAddressesCommandOutput) => void), - cb?: (err: any, data?: ListResolverEndpointIpAddressesCommandOutput) => void - ): Promise | void { - const command = new ListResolverEndpointIpAddressesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the Resolver endpoints that were created using the current Amazon Web Services account.

+ * @see {@link ListResolverEndpointsCommand} */ - public listResolverEndpoints( + listResolverEndpoints( args: ListResolverEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResolverEndpoints( + listResolverEndpoints( args: ListResolverEndpointsCommandInput, cb: (err: any, data?: ListResolverEndpointsCommandOutput) => void ): void; - public listResolverEndpoints( + listResolverEndpoints( args: ListResolverEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResolverEndpointsCommandOutput) => void ): void; - public listResolverEndpoints( - args: ListResolverEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResolverEndpointsCommandOutput) => void), - cb?: (err: any, data?: ListResolverEndpointsCommandOutput) => void - ): Promise | void { - const command = new ListResolverEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists information about associations between Amazon VPCs and query logging configurations.

+ * @see {@link ListResolverQueryLogConfigAssociationsCommand} */ - public listResolverQueryLogConfigAssociations( + listResolverQueryLogConfigAssociations( args: ListResolverQueryLogConfigAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResolverQueryLogConfigAssociations( + listResolverQueryLogConfigAssociations( args: ListResolverQueryLogConfigAssociationsCommandInput, cb: (err: any, data?: ListResolverQueryLogConfigAssociationsCommandOutput) => void ): void; - public listResolverQueryLogConfigAssociations( + listResolverQueryLogConfigAssociations( args: ListResolverQueryLogConfigAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResolverQueryLogConfigAssociationsCommandOutput) => void ): void; - public listResolverQueryLogConfigAssociations( - args: ListResolverQueryLogConfigAssociationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListResolverQueryLogConfigAssociationsCommandOutput) => void), - cb?: (err: any, data?: ListResolverQueryLogConfigAssociationsCommandOutput) => void - ): Promise | void { - const command = new ListResolverQueryLogConfigAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists information about the specified query logging configurations. Each configuration defines where you want Resolver to save - * DNS query logs and specifies the VPCs that you want to log queries for.

+ * @see {@link ListResolverQueryLogConfigsCommand} */ - public listResolverQueryLogConfigs( + listResolverQueryLogConfigs( args: ListResolverQueryLogConfigsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResolverQueryLogConfigs( + listResolverQueryLogConfigs( args: ListResolverQueryLogConfigsCommandInput, cb: (err: any, data?: ListResolverQueryLogConfigsCommandOutput) => void ): void; - public listResolverQueryLogConfigs( + listResolverQueryLogConfigs( args: ListResolverQueryLogConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResolverQueryLogConfigsCommandOutput) => void ): void; - public listResolverQueryLogConfigs( - args: ListResolverQueryLogConfigsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResolverQueryLogConfigsCommandOutput) => void), - cb?: (err: any, data?: ListResolverQueryLogConfigsCommandOutput) => void - ): Promise | void { - const command = new ListResolverQueryLogConfigsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the associations that were created between Resolver rules and VPCs using the current Amazon Web Services account.

+ * @see {@link ListResolverRuleAssociationsCommand} */ - public listResolverRuleAssociations( + listResolverRuleAssociations( args: ListResolverRuleAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResolverRuleAssociations( + listResolverRuleAssociations( args: ListResolverRuleAssociationsCommandInput, cb: (err: any, data?: ListResolverRuleAssociationsCommandOutput) => void ): void; - public listResolverRuleAssociations( + listResolverRuleAssociations( args: ListResolverRuleAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResolverRuleAssociationsCommandOutput) => void ): void; - public listResolverRuleAssociations( - args: ListResolverRuleAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResolverRuleAssociationsCommandOutput) => void), - cb?: (err: any, data?: ListResolverRuleAssociationsCommandOutput) => void - ): Promise | void { - const command = new ListResolverRuleAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the Resolver rules that were created using the current Amazon Web Services account.

+ * @see {@link ListResolverRulesCommand} */ - public listResolverRules( + listResolverRules( args: ListResolverRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResolverRules( + listResolverRules( args: ListResolverRulesCommandInput, cb: (err: any, data?: ListResolverRulesCommandOutput) => void ): void; - public listResolverRules( + listResolverRules( args: ListResolverRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResolverRulesCommandOutput) => void ): void; - public listResolverRules( - args: ListResolverRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResolverRulesCommandOutput) => void), - cb?: (err: any, data?: ListResolverRulesCommandOutput) => void - ): Promise | void { - const command = new ListResolverRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags that you associated with the specified resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Attaches an Identity and Access Management (Amazon Web Services IAM) policy for sharing the rule - * group. You can use the policy to share the rule group using Resource Access Manager - * (RAM).

+ * @see {@link PutFirewallRuleGroupPolicyCommand} */ - public putFirewallRuleGroupPolicy( + putFirewallRuleGroupPolicy( args: PutFirewallRuleGroupPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putFirewallRuleGroupPolicy( + putFirewallRuleGroupPolicy( args: PutFirewallRuleGroupPolicyCommandInput, cb: (err: any, data?: PutFirewallRuleGroupPolicyCommandOutput) => void ): void; - public putFirewallRuleGroupPolicy( + putFirewallRuleGroupPolicy( args: PutFirewallRuleGroupPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutFirewallRuleGroupPolicyCommandOutput) => void ): void; - public putFirewallRuleGroupPolicy( - args: PutFirewallRuleGroupPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutFirewallRuleGroupPolicyCommandOutput) => void), - cb?: (err: any, data?: PutFirewallRuleGroupPolicyCommandOutput) => void - ): Promise | void { - const command = new PutFirewallRuleGroupPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Specifies an Amazon Web Services account that you want to share a query logging configuration with, the query logging configuration that you want to share, - * and the operations that you want the account to be able to perform on the configuration.

+ * @see {@link PutResolverQueryLogConfigPolicyCommand} */ - public putResolverQueryLogConfigPolicy( + putResolverQueryLogConfigPolicy( args: PutResolverQueryLogConfigPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResolverQueryLogConfigPolicy( + putResolverQueryLogConfigPolicy( args: PutResolverQueryLogConfigPolicyCommandInput, cb: (err: any, data?: PutResolverQueryLogConfigPolicyCommandOutput) => void ): void; - public putResolverQueryLogConfigPolicy( + putResolverQueryLogConfigPolicy( args: PutResolverQueryLogConfigPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResolverQueryLogConfigPolicyCommandOutput) => void ): void; - public putResolverQueryLogConfigPolicy( - args: PutResolverQueryLogConfigPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResolverQueryLogConfigPolicyCommandOutput) => void), - cb?: (err: any, data?: PutResolverQueryLogConfigPolicyCommandOutput) => void - ): Promise | void { - const command = new PutResolverQueryLogConfigPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Specifies an Amazon Web Services rule that you want to share with another account, the account that you want to share the rule with, - * and the operations that you want the account to be able to perform on the rule.

+ * @see {@link PutResolverRulePolicyCommand} */ - public putResolverRulePolicy( + putResolverRulePolicy( args: PutResolverRulePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResolverRulePolicy( + putResolverRulePolicy( args: PutResolverRulePolicyCommandInput, cb: (err: any, data?: PutResolverRulePolicyCommandOutput) => void ): void; - public putResolverRulePolicy( + putResolverRulePolicy( args: PutResolverRulePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResolverRulePolicyCommandOutput) => void ): void; - public putResolverRulePolicy( - args: PutResolverRulePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResolverRulePolicyCommandOutput) => void), - cb?: (err: any, data?: PutResolverRulePolicyCommandOutput) => void - ): Promise | void { - const command = new PutResolverRulePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more tags to a specified resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from a specified resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the configuration of the firewall behavior provided by DNS Firewall for a single - * VPC from Amazon Virtual Private Cloud (Amazon VPC).

+ * @see {@link UpdateFirewallConfigCommand} */ - public updateFirewallConfig( + updateFirewallConfig( args: UpdateFirewallConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFirewallConfig( + updateFirewallConfig( args: UpdateFirewallConfigCommandInput, cb: (err: any, data?: UpdateFirewallConfigCommandOutput) => void ): void; - public updateFirewallConfig( + updateFirewallConfig( args: UpdateFirewallConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFirewallConfigCommandOutput) => void ): void; - public updateFirewallConfig( - args: UpdateFirewallConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFirewallConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateFirewallConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateFirewallConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the firewall domain list from an array of domain specifications.

+ * @see {@link UpdateFirewallDomainsCommand} */ - public updateFirewallDomains( + updateFirewallDomains( args: UpdateFirewallDomainsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFirewallDomains( + updateFirewallDomains( args: UpdateFirewallDomainsCommandInput, cb: (err: any, data?: UpdateFirewallDomainsCommandOutput) => void ): void; - public updateFirewallDomains( + updateFirewallDomains( args: UpdateFirewallDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFirewallDomainsCommandOutput) => void ): void; - public updateFirewallDomains( - args: UpdateFirewallDomainsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFirewallDomainsCommandOutput) => void), - cb?: (err: any, data?: UpdateFirewallDomainsCommandOutput) => void - ): Promise | void { - const command = new UpdateFirewallDomainsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified firewall rule.

+ * @see {@link UpdateFirewallRuleCommand} */ - public updateFirewallRule( + updateFirewallRule( args: UpdateFirewallRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFirewallRule( + updateFirewallRule( args: UpdateFirewallRuleCommandInput, cb: (err: any, data?: UpdateFirewallRuleCommandOutput) => void ): void; - public updateFirewallRule( + updateFirewallRule( args: UpdateFirewallRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFirewallRuleCommandOutput) => void ): void; - public updateFirewallRule( - args: UpdateFirewallRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFirewallRuleCommandOutput) => void), - cb?: (err: any, data?: UpdateFirewallRuleCommandOutput) => void - ): Promise | void { - const command = new UpdateFirewallRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes the association of a FirewallRuleGroup with a VPC. The association enables DNS filtering for the VPC.

+ * @see {@link UpdateFirewallRuleGroupAssociationCommand} */ - public updateFirewallRuleGroupAssociation( + updateFirewallRuleGroupAssociation( args: UpdateFirewallRuleGroupAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFirewallRuleGroupAssociation( + updateFirewallRuleGroupAssociation( args: UpdateFirewallRuleGroupAssociationCommandInput, cb: (err: any, data?: UpdateFirewallRuleGroupAssociationCommandOutput) => void ): void; - public updateFirewallRuleGroupAssociation( + updateFirewallRuleGroupAssociation( args: UpdateFirewallRuleGroupAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFirewallRuleGroupAssociationCommandOutput) => void ): void; - public updateFirewallRuleGroupAssociation( - args: UpdateFirewallRuleGroupAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFirewallRuleGroupAssociationCommandOutput) => void), - cb?: (err: any, data?: UpdateFirewallRuleGroupAssociationCommandOutput) => void - ): Promise | void { - const command = new UpdateFirewallRuleGroupAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the behavior configuration of Route 53 Resolver behavior for a single VPC from - * Amazon Virtual Private Cloud.

+ * @see {@link UpdateResolverConfigCommand} */ - public updateResolverConfig( + updateResolverConfig( args: UpdateResolverConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateResolverConfig( + updateResolverConfig( args: UpdateResolverConfigCommandInput, cb: (err: any, data?: UpdateResolverConfigCommandOutput) => void ): void; - public updateResolverConfig( + updateResolverConfig( args: UpdateResolverConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResolverConfigCommandOutput) => void ): void; - public updateResolverConfig( - args: UpdateResolverConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResolverConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateResolverConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateResolverConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing DNSSEC validation configuration. If there is no existing DNSSEC validation configuration, one is created.

+ * @see {@link UpdateResolverDnssecConfigCommand} */ - public updateResolverDnssecConfig( + updateResolverDnssecConfig( args: UpdateResolverDnssecConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateResolverDnssecConfig( + updateResolverDnssecConfig( args: UpdateResolverDnssecConfigCommandInput, cb: (err: any, data?: UpdateResolverDnssecConfigCommandOutput) => void ): void; - public updateResolverDnssecConfig( + updateResolverDnssecConfig( args: UpdateResolverDnssecConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResolverDnssecConfigCommandOutput) => void ): void; - public updateResolverDnssecConfig( - args: UpdateResolverDnssecConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResolverDnssecConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateResolverDnssecConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateResolverDnssecConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the name, or enpoint type for an inbound or an outbound Resolver endpoint. - * You can only update between IPV4 and DUALSTACK, IPV6 endpoint type can't be updated to other type.

+ * @see {@link UpdateResolverEndpointCommand} */ - public updateResolverEndpoint( + updateResolverEndpoint( args: UpdateResolverEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateResolverEndpoint( + updateResolverEndpoint( args: UpdateResolverEndpointCommandInput, cb: (err: any, data?: UpdateResolverEndpointCommandOutput) => void ): void; - public updateResolverEndpoint( + updateResolverEndpoint( args: UpdateResolverEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResolverEndpointCommandOutput) => void ): void; - public updateResolverEndpoint( - args: UpdateResolverEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResolverEndpointCommandOutput) => void), - cb?: (err: any, data?: UpdateResolverEndpointCommandOutput) => void - ): Promise | void { - const command = new UpdateResolverEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates settings for a specified Resolver rule. ResolverRuleId is required, and all other parameters are optional. - * If you don't specify a parameter, it retains its current value.

+ * @see {@link UpdateResolverRuleCommand} */ - public updateResolverRule( + updateResolverRule( args: UpdateResolverRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateResolverRule( + updateResolverRule( args: UpdateResolverRuleCommandInput, cb: (err: any, data?: UpdateResolverRuleCommandOutput) => void ): void; - public updateResolverRule( + updateResolverRule( args: UpdateResolverRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResolverRuleCommandOutput) => void ): void; - public updateResolverRule( - args: UpdateResolverRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResolverRuleCommandOutput) => void), - cb?: (err: any, data?: UpdateResolverRuleCommandOutput) => void - ): Promise | void { - const command = new UpdateResolverRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

When you create a VPC using Amazon VPC, you automatically get DNS resolution within the VPC + * from Route 53 Resolver. By default, Resolver answers DNS queries for VPC domain names + * such as domain names for EC2 instances or Elastic Load Balancing load balancers. + * Resolver performs recursive lookups against public name servers for all other domain + * names.

+ *

You can also configure DNS resolution between your VPC and your network over a Direct Connect or VPN connection:

+ *

+ * Forward DNS queries from resolvers on your network to Route 53 Resolver + *

+ *

DNS resolvers on your network can forward DNS queries to Resolver in a specified VPC. This allows your DNS resolvers + * to easily resolve domain names for Amazon Web Services resources such as EC2 instances or records in a Route 53 private hosted zone. + * For more information, see + * How DNS Resolvers + * on Your Network Forward DNS Queries to Route 53 Resolver in the Amazon Route 53 Developer Guide.

+ *

+ * Conditionally forward queries from a VPC to resolvers on your network + *

+ *

You can configure Resolver to forward queries that it receives from EC2 instances in your VPCs to DNS resolvers on your network. + * To forward selected queries, you create Resolver rules that specify the domain names for the DNS queries that you want to forward + * (such as example.com), and the IP addresses of the DNS resolvers on your network that you want to forward the queries to. + * If a query matches multiple rules (example.com, acme.example.com), Resolver chooses the rule with the most specific match + * (acme.example.com) and forwards the query to the IP addresses that you specified in that rule. For more information, see + * How Route 53 Resolver + * Forwards DNS Queries from Your VPCs to Your Network in the Amazon Route 53 Developer Guide.

+ *

Like Amazon VPC, Resolver is Regional. In each Region where you have VPCs, you can choose + * whether to forward queries from your VPCs to your network (outbound queries), from your + * network to your VPCs (inbound queries), or both.

+ */ +export class Route53Resolver extends Route53ResolverClient implements Route53Resolver {} +createAggregatedClient(commands, Route53Resolver); diff --git a/clients/client-rum/src/RUM.ts b/clients/client-rum/src/RUM.ts index 16fc930c8048..eec4f1f4a97e 100644 --- a/clients/client-rum/src/RUM.ts +++ b/clients/client-rum/src/RUM.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -82,654 +83,302 @@ import { UpdateRumMetricDefinitionCommandInput, UpdateRumMetricDefinitionCommandOutput, } from "./commands/UpdateRumMetricDefinitionCommand"; -import { RUMClient } from "./RUMClient"; +import { RUMClient, RUMClientConfig } from "./RUMClient"; -/** - * @public - *

With Amazon CloudWatch RUM, you can perform real-user monitoring to collect client-side data about - * your web application performance from actual user sessions in real time. The data collected includes page load - * times, client-side errors, and user behavior. When you view this data, you can see it all aggregated together and - * also see breakdowns by the browsers and devices that your customers use.

- *

You can use the collected data to quickly identify and debug client-side performance issues. CloudWatch - * RUM helps you visualize anomalies in your application performance and find relevant debugging data such as error - * messages, stack traces, and user sessions. You can also use RUM to - * understand the range of end-user impact including the number of users, geolocations, and browsers used.

- */ -export class RUM extends RUMClient { +const commands = { + BatchCreateRumMetricDefinitionsCommand, + BatchDeleteRumMetricDefinitionsCommand, + BatchGetRumMetricDefinitionsCommand, + CreateAppMonitorCommand, + DeleteAppMonitorCommand, + DeleteRumMetricsDestinationCommand, + GetAppMonitorCommand, + GetAppMonitorDataCommand, + ListAppMonitorsCommand, + ListRumMetricsDestinationsCommand, + ListTagsForResourceCommand, + PutRumEventsCommand, + PutRumMetricsDestinationCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAppMonitorCommand, + UpdateRumMetricDefinitionCommand, +}; + +export interface RUM { /** - * @public - *

Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid - * destinations include CloudWatch and Evidently.

- *

By default, RUM app monitors send some metrics to CloudWatch. These default metrics - * are listed in CloudWatch metrics that you can collect - * with CloudWatch RUM.

- *

In addition to these default metrics, you can choose to send extended metrics or custom metrics or both.

- *
    - *
  • - *

    Extended metrics enable you to send metrics with additional dimensions not included - * in the default metrics. You can also send extended metrics to Evidently as well as CloudWatch. - * The valid dimension names for the additional dimensions for extended metrics are - * BrowserName, CountryCode, DeviceType, - * FileType, OSName, and PageId. For more information, see - * - * Extended metrics that you can send to CloudWatch and CloudWatch Evidently.

    - *
  • - *
  • - *

    Custom metrics are metrics that you define. You can send custom metrics to CloudWatch or - * to CloudWatch Evidently or to both. With custom metrics, - * you can use any metric name and namespace, and to derive the metrics you can use any custom events, built-in events, - * custom attributes, or default attributes.

    - *

    You can't send custom metrics to the AWS/RUM namespace. You must send custom metrics to a - * custom namespace that you define. The namespace that you use can't start with AWS/. - * CloudWatch RUM prepends RUM/CustomMetrics/ to the custom namespace that you define, - * so the final namespace for your metrics in CloudWatch is - * RUM/CustomMetrics/your-custom-namespace - * .

    - *
  • - *
- *

The maximum number of metric definitions that you can specify in one - * BatchCreateRumMetricDefinitions operation is 200.

- *

The maximum number of metric definitions that one destination can contain is 2000.

- *

Extended metrics sent to CloudWatch and RUM custom metrics are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension - * value counts as a custom metric. For more information, see - * Amazon CloudWatch Pricing.

- *

You must have - * already created a destination for the metrics before you send them. For more information, see - * PutRumMetricsDestination.

- *

If some metric definitions specified in a BatchCreateRumMetricDefinitions operations are not valid, - * those metric definitions fail and return errors, but all valid metric definitions in the same operation still succeed.

+ * @see {@link BatchCreateRumMetricDefinitionsCommand} */ - public batchCreateRumMetricDefinitions( + batchCreateRumMetricDefinitions( args: BatchCreateRumMetricDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchCreateRumMetricDefinitions( + batchCreateRumMetricDefinitions( args: BatchCreateRumMetricDefinitionsCommandInput, cb: (err: any, data?: BatchCreateRumMetricDefinitionsCommandOutput) => void ): void; - public batchCreateRumMetricDefinitions( + batchCreateRumMetricDefinitions( args: BatchCreateRumMetricDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCreateRumMetricDefinitionsCommandOutput) => void ): void; - public batchCreateRumMetricDefinitions( - args: BatchCreateRumMetricDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchCreateRumMetricDefinitionsCommandOutput) => void), - cb?: (err: any, data?: BatchCreateRumMetricDefinitionsCommandOutput) => void - ): Promise | void { - const command = new BatchCreateRumMetricDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified metrics from being sent to an extended metrics destination.

- *

If some metric definition IDs specified in a BatchDeleteRumMetricDefinitions operations are not valid, - * those metric definitions fail and return errors, but all valid metric definition IDs in the same operation are still - * deleted.

- *

The maximum number of metric definitions that you can specify in one - * BatchDeleteRumMetricDefinitions operation is 200.

+ * @see {@link BatchDeleteRumMetricDefinitionsCommand} */ - public batchDeleteRumMetricDefinitions( + batchDeleteRumMetricDefinitions( args: BatchDeleteRumMetricDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDeleteRumMetricDefinitions( + batchDeleteRumMetricDefinitions( args: BatchDeleteRumMetricDefinitionsCommandInput, cb: (err: any, data?: BatchDeleteRumMetricDefinitionsCommandOutput) => void ): void; - public batchDeleteRumMetricDefinitions( + batchDeleteRumMetricDefinitions( args: BatchDeleteRumMetricDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteRumMetricDefinitionsCommandOutput) => void ): void; - public batchDeleteRumMetricDefinitions( - args: BatchDeleteRumMetricDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDeleteRumMetricDefinitionsCommandOutput) => void), - cb?: (err: any, data?: BatchDeleteRumMetricDefinitionsCommandOutput) => void - ): Promise | void { - const command = new BatchDeleteRumMetricDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.

+ * @see {@link BatchGetRumMetricDefinitionsCommand} */ - public batchGetRumMetricDefinitions( + batchGetRumMetricDefinitions( args: BatchGetRumMetricDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetRumMetricDefinitions( + batchGetRumMetricDefinitions( args: BatchGetRumMetricDefinitionsCommandInput, cb: (err: any, data?: BatchGetRumMetricDefinitionsCommandOutput) => void ): void; - public batchGetRumMetricDefinitions( + batchGetRumMetricDefinitions( args: BatchGetRumMetricDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetRumMetricDefinitionsCommandOutput) => void ): void; - public batchGetRumMetricDefinitions( - args: BatchGetRumMetricDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetRumMetricDefinitionsCommandOutput) => void), - cb?: (err: any, data?: BatchGetRumMetricDefinitionsCommandOutput) => void - ): Promise | void { - const command = new BatchGetRumMetricDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that - * data to RUM. The data includes performance and reliability information such as page load time, client-side errors, - * and user behavior.

- *

You use this operation only to create a new app monitor. To update an existing app monitor, use UpdateAppMonitor instead.

- *

After you create an app monitor, sign in to the CloudWatch RUM console to get - * the JavaScript code snippet to add to your web application. For more information, see - * How do I find a code snippet - * that I've already generated? - *

+ * @see {@link CreateAppMonitorCommand} */ - public createAppMonitor( + createAppMonitor( args: CreateAppMonitorCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAppMonitor( + createAppMonitor( args: CreateAppMonitorCommandInput, cb: (err: any, data?: CreateAppMonitorCommandOutput) => void ): void; - public createAppMonitor( + createAppMonitor( args: CreateAppMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppMonitorCommandOutput) => void ): void; - public createAppMonitor( - args: CreateAppMonitorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAppMonitorCommandOutput) => void), - cb?: (err: any, data?: CreateAppMonitorCommandOutput) => void - ): Promise | void { - const command = new CreateAppMonitorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing app monitor. This immediately stops the collection of data.

+ * @see {@link DeleteAppMonitorCommand} */ - public deleteAppMonitor( + deleteAppMonitor( args: DeleteAppMonitorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAppMonitor( + deleteAppMonitor( args: DeleteAppMonitorCommandInput, cb: (err: any, data?: DeleteAppMonitorCommandOutput) => void ): void; - public deleteAppMonitor( + deleteAppMonitor( args: DeleteAppMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppMonitorCommandOutput) => void ): void; - public deleteAppMonitor( - args: DeleteAppMonitorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppMonitorCommandOutput) => void), - cb?: (err: any, data?: DeleteAppMonitorCommandOutput) => void - ): Promise | void { - const command = new DeleteAppMonitorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops - * sending extended metrics to that destination.

+ * @see {@link DeleteRumMetricsDestinationCommand} */ - public deleteRumMetricsDestination( + deleteRumMetricsDestination( args: DeleteRumMetricsDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRumMetricsDestination( + deleteRumMetricsDestination( args: DeleteRumMetricsDestinationCommandInput, cb: (err: any, data?: DeleteRumMetricsDestinationCommandOutput) => void ): void; - public deleteRumMetricsDestination( + deleteRumMetricsDestination( args: DeleteRumMetricsDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRumMetricsDestinationCommandOutput) => void ): void; - public deleteRumMetricsDestination( - args: DeleteRumMetricsDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRumMetricsDestinationCommandOutput) => void), - cb?: (err: any, data?: DeleteRumMetricsDestinationCommandOutput) => void - ): Promise | void { - const command = new DeleteRumMetricsDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the complete configuration information for one app monitor.

+ * @see {@link GetAppMonitorCommand} */ - public getAppMonitor( - args: GetAppMonitorCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getAppMonitor( - args: GetAppMonitorCommandInput, - cb: (err: any, data?: GetAppMonitorCommandOutput) => void - ): void; - public getAppMonitor( + getAppMonitor(args: GetAppMonitorCommandInput, options?: __HttpHandlerOptions): Promise; + getAppMonitor(args: GetAppMonitorCommandInput, cb: (err: any, data?: GetAppMonitorCommandOutput) => void): void; + getAppMonitor( args: GetAppMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAppMonitorCommandOutput) => void ): void; - public getAppMonitor( - args: GetAppMonitorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAppMonitorCommandOutput) => void), - cb?: (err: any, data?: GetAppMonitorCommandOutput) => void - ): Promise | void { - const command = new GetAppMonitorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the raw performance events that RUM has collected from your web application, - * so that you can do your own processing or analysis of this data.

+ * @see {@link GetAppMonitorDataCommand} */ - public getAppMonitorData( + getAppMonitorData( args: GetAppMonitorDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAppMonitorData( + getAppMonitorData( args: GetAppMonitorDataCommandInput, cb: (err: any, data?: GetAppMonitorDataCommandOutput) => void ): void; - public getAppMonitorData( + getAppMonitorData( args: GetAppMonitorDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAppMonitorDataCommandOutput) => void ): void; - public getAppMonitorData( - args: GetAppMonitorDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAppMonitorDataCommandOutput) => void), - cb?: (err: any, data?: GetAppMonitorDataCommandOutput) => void - ): Promise | void { - const command = new GetAppMonitorDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the Amazon CloudWatch RUM app monitors in the account.

+ * @see {@link ListAppMonitorsCommand} */ - public listAppMonitors( + listAppMonitors( args: ListAppMonitorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAppMonitors( - args: ListAppMonitorsCommandInput, - cb: (err: any, data?: ListAppMonitorsCommandOutput) => void - ): void; - public listAppMonitors( + listAppMonitors(args: ListAppMonitorsCommandInput, cb: (err: any, data?: ListAppMonitorsCommandOutput) => void): void; + listAppMonitors( args: ListAppMonitorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppMonitorsCommandOutput) => void ): void; - public listAppMonitors( - args: ListAppMonitorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppMonitorsCommandOutput) => void), - cb?: (err: any, data?: ListAppMonitorsCommandOutput) => void - ): Promise | void { - const command = new ListAppMonitorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of destinations that you have created to receive RUM extended metrics, - * for the specified app monitor.

- *

For more information about extended metrics, see AddRumMetrics.

+ * @see {@link ListRumMetricsDestinationsCommand} */ - public listRumMetricsDestinations( + listRumMetricsDestinations( args: ListRumMetricsDestinationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRumMetricsDestinations( + listRumMetricsDestinations( args: ListRumMetricsDestinationsCommandInput, cb: (err: any, data?: ListRumMetricsDestinationsCommandOutput) => void ): void; - public listRumMetricsDestinations( + listRumMetricsDestinations( args: ListRumMetricsDestinationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRumMetricsDestinationsCommandOutput) => void ): void; - public listRumMetricsDestinations( - args: ListRumMetricsDestinationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRumMetricsDestinationsCommandOutput) => void), - cb?: (err: any, data?: ListRumMetricsDestinationsCommandOutput) => void - ): Promise | void { - const command = new ListRumMetricsDestinationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays the tags associated with a CloudWatch RUM resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sends telemetry events about your application performance and user behavior to CloudWatch RUM. The code - * snippet that RUM generates for you to add to your application includes PutRumEvents operations to - * send this data to RUM.

- *

Each PutRumEvents operation can send a batch of events from one user session.

+ * @see {@link PutRumEventsCommand} */ - public putRumEvents( - args: PutRumEventsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putRumEvents(args: PutRumEventsCommandInput, cb: (err: any, data?: PutRumEventsCommandOutput) => void): void; - public putRumEvents( + putRumEvents(args: PutRumEventsCommandInput, options?: __HttpHandlerOptions): Promise; + putRumEvents(args: PutRumEventsCommandInput, cb: (err: any, data?: PutRumEventsCommandOutput) => void): void; + putRumEvents( args: PutRumEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRumEventsCommandOutput) => void ): void; - public putRumEvents( - args: PutRumEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRumEventsCommandOutput) => void), - cb?: (err: any, data?: PutRumEventsCommandOutput) => void - ): Promise | void { - const command = new PutRumEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates a destination to receive extended metrics from CloudWatch RUM. You can send - * extended metrics to CloudWatch or to a CloudWatch Evidently experiment.

- *

For more information about extended metrics, see BatchCreateRumMetricDefinitions.

+ * @see {@link PutRumMetricsDestinationCommand} */ - public putRumMetricsDestination( + putRumMetricsDestination( args: PutRumMetricsDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putRumMetricsDestination( + putRumMetricsDestination( args: PutRumMetricsDestinationCommandInput, cb: (err: any, data?: PutRumMetricsDestinationCommandOutput) => void ): void; - public putRumMetricsDestination( + putRumMetricsDestination( args: PutRumMetricsDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRumMetricsDestinationCommandOutput) => void ): void; - public putRumMetricsDestination( - args: PutRumMetricsDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRumMetricsDestinationCommandOutput) => void), - cb?: (err: any, data?: PutRumMetricsDestinationCommandOutput) => void - ): Promise | void { - const command = new PutRumMetricsDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource. Currently, - * the only resources that - * can be tagged app monitors.

- *

Tags can help you organize and categorize your resources. You can also use them to scope user - * permissions by granting a user - * permission to access or change only resources with certain tag values.

- *

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

- *

You can use the TagResource action with a resource that already has tags. - * If you specify a new tag key for the resource, - * this tag is appended to the list of tags associated - * with the alarm. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces - * the previous value for that tag.

- *

You can associate as many as 50 tags with a resource.

- *

For more information, see Tagging Amazon Web Services resources.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from the specified resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the configuration of an existing app monitor. When you use this operation, only the parts of the app monitor - * configuration that you specify in this operation are changed. For any parameters that you omit, the existing - * values are kept.

- *

You can't use this operation to change the tags of an existing app monitor. To change the tags of an existing app monitor, use - * TagResource.

- *

To create a new app monitor, use CreateAppMonitor.

- *

After you update an app monitor, sign in to the CloudWatch RUM console to get - * the updated JavaScript code snippet to add to your web application. For more information, see - * How do I find a code snippet - * that I've already generated? - *

+ * @see {@link UpdateAppMonitorCommand} */ - public updateAppMonitor( + updateAppMonitor( args: UpdateAppMonitorCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAppMonitor( + updateAppMonitor( args: UpdateAppMonitorCommandInput, cb: (err: any, data?: UpdateAppMonitorCommandOutput) => void ): void; - public updateAppMonitor( + updateAppMonitor( args: UpdateAppMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAppMonitorCommandOutput) => void ): void; - public updateAppMonitor( - args: UpdateAppMonitorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAppMonitorCommandOutput) => void), - cb?: (err: any, data?: UpdateAppMonitorCommandOutput) => void - ): Promise | void { - const command = new UpdateAppMonitorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies one existing metric definition for CloudWatch RUM extended metrics. For - * more information about extended metrics, see BatchCreateRumMetricsDefinitions.

+ * @see {@link UpdateRumMetricDefinitionCommand} */ - public updateRumMetricDefinition( + updateRumMetricDefinition( args: UpdateRumMetricDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRumMetricDefinition( + updateRumMetricDefinition( args: UpdateRumMetricDefinitionCommandInput, cb: (err: any, data?: UpdateRumMetricDefinitionCommandOutput) => void ): void; - public updateRumMetricDefinition( + updateRumMetricDefinition( args: UpdateRumMetricDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRumMetricDefinitionCommandOutput) => void ): void; - public updateRumMetricDefinition( - args: UpdateRumMetricDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRumMetricDefinitionCommandOutput) => void), - cb?: (err: any, data?: UpdateRumMetricDefinitionCommandOutput) => void - ): Promise | void { - const command = new UpdateRumMetricDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

With Amazon CloudWatch RUM, you can perform real-user monitoring to collect client-side data about + * your web application performance from actual user sessions in real time. The data collected includes page load + * times, client-side errors, and user behavior. When you view this data, you can see it all aggregated together and + * also see breakdowns by the browsers and devices that your customers use.

+ *

You can use the collected data to quickly identify and debug client-side performance issues. CloudWatch + * RUM helps you visualize anomalies in your application performance and find relevant debugging data such as error + * messages, stack traces, and user sessions. You can also use RUM to + * understand the range of end-user impact including the number of users, geolocations, and browsers used.

+ */ +export class RUM extends RUMClient implements RUM {} +createAggregatedClient(commands, RUM); diff --git a/clients/client-s3-control/src/S3Control.ts b/clients/client-s3-control/src/S3Control.ts index 4642211e55e7..4502a1824a08 100644 --- a/clients/client-s3-control/src/S3Control.ts +++ b/clients/client-s3-control/src/S3Control.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -305,3721 +306,1108 @@ import { UpdateJobStatusCommandInput, UpdateJobStatusCommandOutput, } from "./commands/UpdateJobStatusCommand"; -import { S3ControlClient } from "./S3ControlClient"; +import { S3ControlClient, S3ControlClientConfig } from "./S3ControlClient"; -/** - * @public - *

Amazon Web Services S3 Control provides access to Amazon S3 control plane actions.

- */ -export class S3Control extends S3ControlClient { - /** - * @public - *

Creates an access point and associates it with the specified bucket. For more information, see - * Managing - * Data Access with Amazon S3 Access Points in the - * Amazon S3 User Guide.

- *

- * - *

S3 on Outposts only supports VPC-style access points.

- *

For more information, see Accessing Amazon S3 on Outposts using - * virtual private cloud (VPC) only access points in the - * Amazon S3 User Guide.

- *
- *

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

- *

- *

The following actions are related to CreateAccessPoint:

- * - */ - public createAccessPoint( +const commands = { + CreateAccessPointCommand, + CreateAccessPointForObjectLambdaCommand, + CreateBucketCommand, + CreateJobCommand, + CreateMultiRegionAccessPointCommand, + DeleteAccessPointCommand, + DeleteAccessPointForObjectLambdaCommand, + DeleteAccessPointPolicyCommand, + DeleteAccessPointPolicyForObjectLambdaCommand, + DeleteBucketCommand, + DeleteBucketLifecycleConfigurationCommand, + DeleteBucketPolicyCommand, + DeleteBucketReplicationCommand, + DeleteBucketTaggingCommand, + DeleteJobTaggingCommand, + DeleteMultiRegionAccessPointCommand, + DeletePublicAccessBlockCommand, + DeleteStorageLensConfigurationCommand, + DeleteStorageLensConfigurationTaggingCommand, + DescribeJobCommand, + DescribeMultiRegionAccessPointOperationCommand, + GetAccessPointCommand, + GetAccessPointConfigurationForObjectLambdaCommand, + GetAccessPointForObjectLambdaCommand, + GetAccessPointPolicyCommand, + GetAccessPointPolicyForObjectLambdaCommand, + GetAccessPointPolicyStatusCommand, + GetAccessPointPolicyStatusForObjectLambdaCommand, + GetBucketCommand, + GetBucketLifecycleConfigurationCommand, + GetBucketPolicyCommand, + GetBucketReplicationCommand, + GetBucketTaggingCommand, + GetBucketVersioningCommand, + GetJobTaggingCommand, + GetMultiRegionAccessPointCommand, + GetMultiRegionAccessPointPolicyCommand, + GetMultiRegionAccessPointPolicyStatusCommand, + GetMultiRegionAccessPointRoutesCommand, + GetPublicAccessBlockCommand, + GetStorageLensConfigurationCommand, + GetStorageLensConfigurationTaggingCommand, + ListAccessPointsCommand, + ListAccessPointsForObjectLambdaCommand, + ListJobsCommand, + ListMultiRegionAccessPointsCommand, + ListRegionalBucketsCommand, + ListStorageLensConfigurationsCommand, + PutAccessPointConfigurationForObjectLambdaCommand, + PutAccessPointPolicyCommand, + PutAccessPointPolicyForObjectLambdaCommand, + PutBucketLifecycleConfigurationCommand, + PutBucketPolicyCommand, + PutBucketReplicationCommand, + PutBucketTaggingCommand, + PutBucketVersioningCommand, + PutJobTaggingCommand, + PutMultiRegionAccessPointPolicyCommand, + PutPublicAccessBlockCommand, + PutStorageLensConfigurationCommand, + PutStorageLensConfigurationTaggingCommand, + SubmitMultiRegionAccessPointRoutesCommand, + UpdateJobPriorityCommand, + UpdateJobStatusCommand, +}; + +export interface S3Control { + /** + * @see {@link CreateAccessPointCommand} + */ + createAccessPoint( args: CreateAccessPointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAccessPoint( + createAccessPoint( args: CreateAccessPointCommandInput, cb: (err: any, data?: CreateAccessPointCommandOutput) => void ): void; - public createAccessPoint( + createAccessPoint( args: CreateAccessPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessPointCommandOutput) => void ): void; - public createAccessPoint( - args: CreateAccessPointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAccessPointCommandOutput) => void), - cb?: (err: any, data?: CreateAccessPointCommandOutput) => void - ): Promise | void { - const command = new CreateAccessPointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Object Lambda Access Point. For more information, see Transforming objects with - * Object Lambda Access Points in the Amazon S3 User Guide.

- *

The following actions are related to - * CreateAccessPointForObjectLambda:

- * - */ - public createAccessPointForObjectLambda( + + /** + * @see {@link CreateAccessPointForObjectLambdaCommand} + */ + createAccessPointForObjectLambda( args: CreateAccessPointForObjectLambdaCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAccessPointForObjectLambda( + createAccessPointForObjectLambda( args: CreateAccessPointForObjectLambdaCommandInput, cb: (err: any, data?: CreateAccessPointForObjectLambdaCommandOutput) => void ): void; - public createAccessPointForObjectLambda( + createAccessPointForObjectLambda( args: CreateAccessPointForObjectLambdaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessPointForObjectLambdaCommandOutput) => void ): void; - public createAccessPointForObjectLambda( - args: CreateAccessPointForObjectLambdaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAccessPointForObjectLambdaCommandOutput) => void), - cb?: (err: any, data?: CreateAccessPointForObjectLambdaCommandOutput) => void - ): Promise | void { - const command = new CreateAccessPointForObjectLambdaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create - * Bucket in the Amazon S3 API Reference.

- *
- *

Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To - * create an Outposts bucket, you must have S3 on Outposts. For more information, see Using - * Amazon S3 on Outposts in Amazon S3 User Guide.

- *

Not every string is an acceptable bucket name. For information on bucket naming - * restrictions, see Working with - * Amazon S3 Buckets.

- *

S3 on Outposts buckets support:

- *
    - *
  • - *

    Tags

    - *
  • - *
  • - *

    LifecycleConfigurations for deleting expired objects

    - *
  • - *
- *

For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see - * - * Amazon S3 on Outposts Restrictions and Limitations.

- *

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts - * endpoint hostname prefix and x-amz-outpost-id in your API request, see the - * Examples section.

- *

The following actions are related to CreateBucket for - * Amazon S3 on Outposts:

- * - */ - public createBucket( - args: CreateBucketCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createBucket(args: CreateBucketCommandInput, cb: (err: any, data?: CreateBucketCommandOutput) => void): void; - public createBucket( + + /** + * @see {@link CreateBucketCommand} + */ + createBucket(args: CreateBucketCommandInput, options?: __HttpHandlerOptions): Promise; + createBucket(args: CreateBucketCommandInput, cb: (err: any, data?: CreateBucketCommandOutput) => void): void; + createBucket( args: CreateBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBucketCommandOutput) => void ): void; - public createBucket( - args: CreateBucketCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBucketCommandOutput) => void), - cb?: (err: any, data?: CreateBucketCommandOutput) => void - ): Promise | void { - const command = new CreateBucketCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects. - * Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more - * information, see S3 Batch Operations in the Amazon S3 User Guide.

- *

This action creates a S3 Batch Operations job.

- *

- *

Related actions include:

- * - */ - public createJob(args: CreateJobCommandInput, options?: __HttpHandlerOptions): Promise; - public createJob(args: CreateJobCommandInput, cb: (err: any, data?: CreateJobCommandOutput) => void): void; - public createJob( + + /** + * @see {@link CreateJobCommand} + */ + createJob(args: CreateJobCommandInput, options?: __HttpHandlerOptions): Promise; + createJob(args: CreateJobCommandInput, cb: (err: any, data?: CreateJobCommandOutput) => void): void; + createJob( args: CreateJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateJobCommandOutput) => void ): void; - public createJob( - args: CreateJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateJobCommandOutput) => void), - cb?: (err: any, data?: CreateJobCommandOutput) => void - ): Promise | void { - const command = new CreateJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Multi-Region Access Point and associates it with the specified buckets. For more information - * about creating Multi-Region Access Points, see Creating - * Multi-Region Access Points in the Amazon S3 User Guide.

- *

This action will always be routed to the US West (Oregon) Region. For more information - * about the restrictions around managing Multi-Region Access Points, see Managing - * Multi-Region Access Points in the Amazon S3 User Guide.

- *

This request is asynchronous, meaning that you might receive a response before the - * command has completed. When this request provides a response, it provides a token that you - * can use to monitor the status of the request with - * DescribeMultiRegionAccessPointOperation.

- *

The following actions are related to CreateMultiRegionAccessPoint:

- * - */ - public createMultiRegionAccessPoint( + + /** + * @see {@link CreateMultiRegionAccessPointCommand} + */ + createMultiRegionAccessPoint( args: CreateMultiRegionAccessPointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMultiRegionAccessPoint( + createMultiRegionAccessPoint( args: CreateMultiRegionAccessPointCommandInput, cb: (err: any, data?: CreateMultiRegionAccessPointCommandOutput) => void ): void; - public createMultiRegionAccessPoint( + createMultiRegionAccessPoint( args: CreateMultiRegionAccessPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMultiRegionAccessPointCommandOutput) => void ): void; - public createMultiRegionAccessPoint( - args: CreateMultiRegionAccessPointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMultiRegionAccessPointCommandOutput) => void), - cb?: (err: any, data?: CreateMultiRegionAccessPointCommandOutput) => void - ): Promise | void { - const command = new CreateMultiRegionAccessPointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified access point.

- *

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

- *

The following actions are related to DeleteAccessPoint:

- * - */ - public deleteAccessPoint( + + /** + * @see {@link DeleteAccessPointCommand} + */ + deleteAccessPoint( args: DeleteAccessPointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAccessPoint( + deleteAccessPoint( args: DeleteAccessPointCommandInput, cb: (err: any, data?: DeleteAccessPointCommandOutput) => void ): void; - public deleteAccessPoint( + deleteAccessPoint( args: DeleteAccessPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessPointCommandOutput) => void ): void; - public deleteAccessPoint( - args: DeleteAccessPointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAccessPointCommandOutput) => void), - cb?: (err: any, data?: DeleteAccessPointCommandOutput) => void - ): Promise | void { - const command = new DeleteAccessPointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified Object Lambda Access Point.

- *

The following actions are related to - * DeleteAccessPointForObjectLambda:

- * - */ - public deleteAccessPointForObjectLambda( + + /** + * @see {@link DeleteAccessPointForObjectLambdaCommand} + */ + deleteAccessPointForObjectLambda( args: DeleteAccessPointForObjectLambdaCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAccessPointForObjectLambda( + deleteAccessPointForObjectLambda( args: DeleteAccessPointForObjectLambdaCommandInput, cb: (err: any, data?: DeleteAccessPointForObjectLambdaCommandOutput) => void ): void; - public deleteAccessPointForObjectLambda( + deleteAccessPointForObjectLambda( args: DeleteAccessPointForObjectLambdaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessPointForObjectLambdaCommandOutput) => void ): void; - public deleteAccessPointForObjectLambda( - args: DeleteAccessPointForObjectLambdaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAccessPointForObjectLambdaCommandOutput) => void), - cb?: (err: any, data?: DeleteAccessPointForObjectLambdaCommandOutput) => void - ): Promise | void { - const command = new DeleteAccessPointForObjectLambdaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the access point policy for the specified access point.

- *

- *

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

- *

The following actions are related to DeleteAccessPointPolicy:

- * - */ - public deleteAccessPointPolicy( + + /** + * @see {@link DeleteAccessPointPolicyCommand} + */ + deleteAccessPointPolicy( args: DeleteAccessPointPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAccessPointPolicy( + deleteAccessPointPolicy( args: DeleteAccessPointPolicyCommandInput, cb: (err: any, data?: DeleteAccessPointPolicyCommandOutput) => void ): void; - public deleteAccessPointPolicy( + deleteAccessPointPolicy( args: DeleteAccessPointPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessPointPolicyCommandOutput) => void ): void; - public deleteAccessPointPolicy( - args: DeleteAccessPointPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAccessPointPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteAccessPointPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteAccessPointPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the resource policy for an Object Lambda Access Point.

- *

The following actions are related to - * DeleteAccessPointPolicyForObjectLambda:

- * - */ - public deleteAccessPointPolicyForObjectLambda( + + /** + * @see {@link DeleteAccessPointPolicyForObjectLambdaCommand} + */ + deleteAccessPointPolicyForObjectLambda( args: DeleteAccessPointPolicyForObjectLambdaCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAccessPointPolicyForObjectLambda( + deleteAccessPointPolicyForObjectLambda( args: DeleteAccessPointPolicyForObjectLambdaCommandInput, cb: (err: any, data?: DeleteAccessPointPolicyForObjectLambdaCommandOutput) => void ): void; - public deleteAccessPointPolicyForObjectLambda( + deleteAccessPointPolicyForObjectLambda( args: DeleteAccessPointPolicyForObjectLambdaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessPointPolicyForObjectLambdaCommandOutput) => void ): void; - public deleteAccessPointPolicyForObjectLambda( - args: DeleteAccessPointPolicyForObjectLambdaCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteAccessPointPolicyForObjectLambdaCommandOutput) => void), - cb?: (err: any, data?: DeleteAccessPointPolicyForObjectLambdaCommandOutput) => void - ): Promise | void { - const command = new DeleteAccessPointPolicyForObjectLambdaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon S3 API Reference.

- *
- *

Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and - * delete markers) in the bucket must be deleted before the bucket itself can be deleted. For - * more information, see Using Amazon S3 on Outposts in - * Amazon S3 User Guide.

- *

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

- *

- * Related Resources - *

- * - */ - public deleteBucket( - args: DeleteBucketCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteBucket(args: DeleteBucketCommandInput, cb: (err: any, data?: DeleteBucketCommandOutput) => void): void; - public deleteBucket( + + /** + * @see {@link DeleteBucketCommand} + */ + deleteBucket(args: DeleteBucketCommandInput, options?: __HttpHandlerOptions): Promise; + deleteBucket(args: DeleteBucketCommandInput, cb: (err: any, data?: DeleteBucketCommandOutput) => void): void; + deleteBucket( args: DeleteBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketCommandOutput) => void ): void; - public deleteBucket( - args: DeleteBucketCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete - * an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon S3 API Reference.

- *
- *

Deletes the lifecycle configuration from the specified Outposts bucket. - * Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource - * associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer - * automatically deletes any objects on the basis of rules contained in the deleted lifecycle - * configuration. For more information, see Using Amazon S3 on Outposts in - * Amazon S3 User Guide.

- *

To use this action, you must have permission to perform the - * s3-outposts:DeleteLifecycleConfiguration action. By default, the bucket - * owner has this permission and the Outposts bucket owner can grant this permission to - * others.

- *

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

- *

For more information about object expiration, see Elements to Describe Lifecycle Actions.

- *

Related actions include:

- * - */ - public deleteBucketLifecycleConfiguration( + + /** + * @see {@link DeleteBucketLifecycleConfigurationCommand} + */ + deleteBucketLifecycleConfiguration( args: DeleteBucketLifecycleConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketLifecycleConfiguration( + deleteBucketLifecycleConfiguration( args: DeleteBucketLifecycleConfigurationCommandInput, cb: (err: any, data?: DeleteBucketLifecycleConfigurationCommandOutput) => void ): void; - public deleteBucketLifecycleConfiguration( + deleteBucketLifecycleConfiguration( args: DeleteBucketLifecycleConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketLifecycleConfigurationCommandOutput) => void ): void; - public deleteBucketLifecycleConfiguration( - args: DeleteBucketLifecycleConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketLifecycleConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketLifecycleConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketLifecycleConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, - * see DeleteBucketPolicy in the Amazon S3 API Reference.

- *
- *

This implementation of the DELETE action uses the policy subresource to delete the - * policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the - * root user of the Amazon Web Services account that owns the bucket, the calling identity must have the - * s3-outposts:DeleteBucketPolicy permissions on the specified Outposts bucket - * and belong to the bucket owner's account to use this action. For more information, see - * Using - * Amazon S3 on Outposts in Amazon S3 User Guide.

- *

If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 - * Access Denied error. If you have the correct permissions, but you're not using an - * identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not - * Allowed error.

- * - *

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can - * always use this action, even if the policy explicitly denies the root user the ability - * to perform this action.

- *
- *

For more information about bucket policies, see Using Bucket Policies and User - * Policies.

- *

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

- *

The following actions are related to DeleteBucketPolicy:

- * - */ - public deleteBucketPolicy( + + /** + * @see {@link DeleteBucketPolicyCommand} + */ + deleteBucketPolicy( args: DeleteBucketPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketPolicy( + deleteBucketPolicy( args: DeleteBucketPolicyCommandInput, cb: (err: any, data?: DeleteBucketPolicyCommandOutput) => void ): void; - public deleteBucketPolicy( + deleteBucketPolicy( args: DeleteBucketPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketPolicyCommandOutput) => void ): void; - public deleteBucketPolicy( - args: DeleteBucketPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This operation deletes an Amazon S3 on Outposts bucket's replication configuration. To - * delete an S3 bucket's replication configuration, see DeleteBucketReplication in the Amazon S3 API Reference.

- *
- *

Deletes the replication configuration from the specified S3 on Outposts bucket.

- *

To use this operation, you must have permissions to perform the - * s3-outposts:PutReplicationConfiguration action. The Outposts bucket owner - * has this permission by default and can grant it to others. For more information about - * permissions, see Setting up IAM with - * S3 on Outposts and Managing access to - * S3 on Outposts buckets in the Amazon S3 User Guide.

- * - *

It can take a while to propagate PUT or DELETE requests for - * a replication configuration to all S3 on Outposts systems. Therefore, the replication - * configuration that's returned by a GET request soon after a - * PUT or DELETE request might return a more recent result - * than what's on the Outpost. If an Outpost is offline, the delay in updating the - * replication configuration on that Outpost can be significant.

- *
- *

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

- *

For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the - * Amazon S3 User Guide.

- *

The following operations are related to DeleteBucketReplication:

- * - */ - public deleteBucketReplication( + + /** + * @see {@link DeleteBucketReplicationCommand} + */ + deleteBucketReplication( args: DeleteBucketReplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketReplication( + deleteBucketReplication( args: DeleteBucketReplicationCommandInput, cb: (err: any, data?: DeleteBucketReplicationCommandOutput) => void ): void; - public deleteBucketReplication( + deleteBucketReplication( args: DeleteBucketReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketReplicationCommandOutput) => void ): void; - public deleteBucketReplication( - args: DeleteBucketReplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketReplicationCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketReplicationCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketReplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, - * see DeleteBucketTagging in the Amazon S3 API Reference.

- *
- *

Deletes the tags from the Outposts bucket. For more information, see Using - * Amazon S3 on Outposts in Amazon S3 User Guide.

- *

To use this action, you must have permission to perform the - * PutBucketTagging action. By default, the bucket owner has this permission - * and can grant this permission to others.

- *

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

- *

The following actions are related to DeleteBucketTagging:

- * - */ - public deleteBucketTagging( + + /** + * @see {@link DeleteBucketTaggingCommand} + */ + deleteBucketTagging( args: DeleteBucketTaggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketTagging( + deleteBucketTagging( args: DeleteBucketTaggingCommandInput, cb: (err: any, data?: DeleteBucketTaggingCommandOutput) => void ): void; - public deleteBucketTagging( + deleteBucketTagging( args: DeleteBucketTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketTaggingCommandOutput) => void ): void; - public deleteBucketTagging( - args: DeleteBucketTaggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketTaggingCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketTaggingCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketTaggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the entire tag set from the specified S3 Batch Operations job. To use - * the - * DeleteJobTagging operation, you must have permission to - * perform the s3:DeleteJobTagging action. For more information, see Controlling - * access and labeling jobs using tags in the - * Amazon S3 User Guide.

- *

- *

Related actions include:

- * - */ - public deleteJobTagging( + + /** + * @see {@link DeleteJobTaggingCommand} + */ + deleteJobTagging( args: DeleteJobTaggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteJobTagging( + deleteJobTagging( args: DeleteJobTaggingCommandInput, cb: (err: any, data?: DeleteJobTaggingCommandOutput) => void ): void; - public deleteJobTagging( + deleteJobTagging( args: DeleteJobTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteJobTaggingCommandOutput) => void ): void; - public deleteJobTagging( - args: DeleteJobTaggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteJobTaggingCommandOutput) => void), - cb?: (err: any, data?: DeleteJobTaggingCommandOutput) => void - ): Promise | void { - const command = new DeleteJobTaggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a Multi-Region Access Point. This action does not delete the buckets associated with the Multi-Region Access Point, - * only the Multi-Region Access Point itself.

- *

This action will always be routed to the US West (Oregon) Region. For more information - * about the restrictions around managing Multi-Region Access Points, see Managing - * Multi-Region Access Points in the Amazon S3 User Guide.

- *

This request is asynchronous, meaning that you might receive a response before the - * command has completed. When this request provides a response, it provides a token that you - * can use to monitor the status of the request with - * DescribeMultiRegionAccessPointOperation.

- *

The following actions are related to DeleteMultiRegionAccessPoint:

- * - */ - public deleteMultiRegionAccessPoint( + + /** + * @see {@link DeleteMultiRegionAccessPointCommand} + */ + deleteMultiRegionAccessPoint( args: DeleteMultiRegionAccessPointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMultiRegionAccessPoint( + deleteMultiRegionAccessPoint( args: DeleteMultiRegionAccessPointCommandInput, cb: (err: any, data?: DeleteMultiRegionAccessPointCommandOutput) => void ): void; - public deleteMultiRegionAccessPoint( + deleteMultiRegionAccessPoint( args: DeleteMultiRegionAccessPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMultiRegionAccessPointCommandOutput) => void ): void; - public deleteMultiRegionAccessPoint( - args: DeleteMultiRegionAccessPointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMultiRegionAccessPointCommandOutput) => void), - cb?: (err: any, data?: DeleteMultiRegionAccessPointCommandOutput) => void - ): Promise | void { - const command = new DeleteMultiRegionAccessPointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the PublicAccessBlock configuration for an Amazon Web Services account. For more - * information, see Using Amazon S3 block - * public access.

- *

Related actions include:

- * - */ - public deletePublicAccessBlock( + + /** + * @see {@link DeletePublicAccessBlockCommand} + */ + deletePublicAccessBlock( args: DeletePublicAccessBlockCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePublicAccessBlock( + deletePublicAccessBlock( args: DeletePublicAccessBlockCommandInput, cb: (err: any, data?: DeletePublicAccessBlockCommandOutput) => void ): void; - public deletePublicAccessBlock( + deletePublicAccessBlock( args: DeletePublicAccessBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePublicAccessBlockCommandOutput) => void ): void; - public deletePublicAccessBlock( - args: DeletePublicAccessBlockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePublicAccessBlockCommandOutput) => void), - cb?: (err: any, data?: DeletePublicAccessBlockCommandOutput) => void - ): Promise | void { - const command = new DeletePublicAccessBlockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage - * activity and usage with Amazon S3 Storage Lens in the - * Amazon S3 User Guide.

- * - *

To use this action, you must have permission to perform the - * s3:DeleteStorageLensConfiguration action. For more information, see - * Setting permissions to - * use Amazon S3 Storage Lens in the Amazon S3 User Guide.

- *
- */ - public deleteStorageLensConfiguration( + + /** + * @see {@link DeleteStorageLensConfigurationCommand} + */ + deleteStorageLensConfiguration( args: DeleteStorageLensConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteStorageLensConfiguration( + deleteStorageLensConfiguration( args: DeleteStorageLensConfigurationCommandInput, cb: (err: any, data?: DeleteStorageLensConfigurationCommandOutput) => void ): void; - public deleteStorageLensConfiguration( + deleteStorageLensConfiguration( args: DeleteStorageLensConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStorageLensConfigurationCommandOutput) => void ): void; - public deleteStorageLensConfiguration( - args: DeleteStorageLensConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStorageLensConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteStorageLensConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteStorageLensConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see - * Assessing your - * storage activity and usage with Amazon S3 Storage Lens in the - * Amazon S3 User Guide.

- * - *

To use this action, you must have permission to perform the - * s3:DeleteStorageLensConfigurationTagging action. For more information, - * see Setting permissions to - * use Amazon S3 Storage Lens in the Amazon S3 User Guide.

- *
- */ - public deleteStorageLensConfigurationTagging( + + /** + * @see {@link DeleteStorageLensConfigurationTaggingCommand} + */ + deleteStorageLensConfigurationTagging( args: DeleteStorageLensConfigurationTaggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteStorageLensConfigurationTagging( + deleteStorageLensConfigurationTagging( args: DeleteStorageLensConfigurationTaggingCommandInput, cb: (err: any, data?: DeleteStorageLensConfigurationTaggingCommandOutput) => void ): void; - public deleteStorageLensConfigurationTagging( + deleteStorageLensConfigurationTagging( args: DeleteStorageLensConfigurationTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStorageLensConfigurationTaggingCommandOutput) => void ): void; - public deleteStorageLensConfigurationTagging( - args: DeleteStorageLensConfigurationTaggingCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteStorageLensConfigurationTaggingCommandOutput) => void), - cb?: (err: any, data?: DeleteStorageLensConfigurationTaggingCommandOutput) => void - ): Promise | void { - const command = new DeleteStorageLensConfigurationTaggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the configuration parameters and status for a Batch Operations job. For more - * information, see S3 Batch Operations in the Amazon S3 User Guide.

- *

- *

Related actions include:

- * - */ - public describeJob(args: DescribeJobCommandInput, options?: __HttpHandlerOptions): Promise; - public describeJob(args: DescribeJobCommandInput, cb: (err: any, data?: DescribeJobCommandOutput) => void): void; - public describeJob( + + /** + * @see {@link DescribeJobCommand} + */ + describeJob(args: DescribeJobCommandInput, options?: __HttpHandlerOptions): Promise; + describeJob(args: DescribeJobCommandInput, cb: (err: any, data?: DescribeJobCommandOutput) => void): void; + describeJob( args: DescribeJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobCommandOutput) => void ): void; - public describeJob( - args: DescribeJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeJobCommandOutput) => void), - cb?: (err: any, data?: DescribeJobCommandOutput) => void - ): Promise | void { - const command = new DescribeJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information - * about managing Multi-Region Access Points and how asynchronous requests work, see Managing - * Multi-Region Access Points in the Amazon S3 User Guide.

- *

The following actions are related to GetMultiRegionAccessPoint:

- * - */ - public describeMultiRegionAccessPointOperation( + + /** + * @see {@link DescribeMultiRegionAccessPointOperationCommand} + */ + describeMultiRegionAccessPointOperation( args: DescribeMultiRegionAccessPointOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMultiRegionAccessPointOperation( + describeMultiRegionAccessPointOperation( args: DescribeMultiRegionAccessPointOperationCommandInput, cb: (err: any, data?: DescribeMultiRegionAccessPointOperationCommandOutput) => void ): void; - public describeMultiRegionAccessPointOperation( + describeMultiRegionAccessPointOperation( args: DescribeMultiRegionAccessPointOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMultiRegionAccessPointOperationCommandOutput) => void ): void; - public describeMultiRegionAccessPointOperation( - args: DescribeMultiRegionAccessPointOperationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeMultiRegionAccessPointOperationCommandOutput) => void), - cb?: (err: any, data?: DescribeMultiRegionAccessPointOperationCommandOutput) => void - ): Promise | void { - const command = new DescribeMultiRegionAccessPointOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns configuration information about the specified access point.

- *

- *

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

- *

The following actions are related to GetAccessPoint:

- * - */ - public getAccessPoint( + + /** + * @see {@link GetAccessPointCommand} + */ + getAccessPoint( args: GetAccessPointCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccessPoint( - args: GetAccessPointCommandInput, - cb: (err: any, data?: GetAccessPointCommandOutput) => void - ): void; - public getAccessPoint( + getAccessPoint(args: GetAccessPointCommandInput, cb: (err: any, data?: GetAccessPointCommandOutput) => void): void; + getAccessPoint( args: GetAccessPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessPointCommandOutput) => void ): void; - public getAccessPoint( - args: GetAccessPointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccessPointCommandOutput) => void), - cb?: (err: any, data?: GetAccessPointCommandOutput) => void - ): Promise | void { - const command = new GetAccessPointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns configuration for an Object Lambda Access Point.

- *

The following actions are related to - * GetAccessPointConfigurationForObjectLambda:

- * - */ - public getAccessPointConfigurationForObjectLambda( + + /** + * @see {@link GetAccessPointConfigurationForObjectLambdaCommand} + */ + getAccessPointConfigurationForObjectLambda( args: GetAccessPointConfigurationForObjectLambdaCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccessPointConfigurationForObjectLambda( + getAccessPointConfigurationForObjectLambda( args: GetAccessPointConfigurationForObjectLambdaCommandInput, cb: (err: any, data?: GetAccessPointConfigurationForObjectLambdaCommandOutput) => void ): void; - public getAccessPointConfigurationForObjectLambda( + getAccessPointConfigurationForObjectLambda( args: GetAccessPointConfigurationForObjectLambdaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessPointConfigurationForObjectLambdaCommandOutput) => void ): void; - public getAccessPointConfigurationForObjectLambda( - args: GetAccessPointConfigurationForObjectLambdaCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetAccessPointConfigurationForObjectLambdaCommandOutput) => void), - cb?: (err: any, data?: GetAccessPointConfigurationForObjectLambdaCommandOutput) => void - ): Promise | void { - const command = new GetAccessPointConfigurationForObjectLambdaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns configuration information about the specified Object Lambda Access Point

- *

The following actions are related to GetAccessPointForObjectLambda:

- * - */ - public getAccessPointForObjectLambda( + + /** + * @see {@link GetAccessPointForObjectLambdaCommand} + */ + getAccessPointForObjectLambda( args: GetAccessPointForObjectLambdaCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccessPointForObjectLambda( + getAccessPointForObjectLambda( args: GetAccessPointForObjectLambdaCommandInput, cb: (err: any, data?: GetAccessPointForObjectLambdaCommandOutput) => void ): void; - public getAccessPointForObjectLambda( + getAccessPointForObjectLambda( args: GetAccessPointForObjectLambdaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessPointForObjectLambdaCommandOutput) => void ): void; - public getAccessPointForObjectLambda( - args: GetAccessPointForObjectLambdaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccessPointForObjectLambdaCommandOutput) => void), - cb?: (err: any, data?: GetAccessPointForObjectLambdaCommandOutput) => void - ): Promise | void { - const command = new GetAccessPointForObjectLambdaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the access point policy associated with the specified access point.

- *

The following actions are related to GetAccessPointPolicy:

- * - */ - public getAccessPointPolicy( + + /** + * @see {@link GetAccessPointPolicyCommand} + */ + getAccessPointPolicy( args: GetAccessPointPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccessPointPolicy( + getAccessPointPolicy( args: GetAccessPointPolicyCommandInput, cb: (err: any, data?: GetAccessPointPolicyCommandOutput) => void ): void; - public getAccessPointPolicy( + getAccessPointPolicy( args: GetAccessPointPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessPointPolicyCommandOutput) => void ): void; - public getAccessPointPolicy( - args: GetAccessPointPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccessPointPolicyCommandOutput) => void), - cb?: (err: any, data?: GetAccessPointPolicyCommandOutput) => void - ): Promise | void { - const command = new GetAccessPointPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the resource policy for an Object Lambda Access Point.

- *

The following actions are related to - * GetAccessPointPolicyForObjectLambda:

- * - */ - public getAccessPointPolicyForObjectLambda( + + /** + * @see {@link GetAccessPointPolicyForObjectLambdaCommand} + */ + getAccessPointPolicyForObjectLambda( args: GetAccessPointPolicyForObjectLambdaCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccessPointPolicyForObjectLambda( + getAccessPointPolicyForObjectLambda( args: GetAccessPointPolicyForObjectLambdaCommandInput, cb: (err: any, data?: GetAccessPointPolicyForObjectLambdaCommandOutput) => void ): void; - public getAccessPointPolicyForObjectLambda( + getAccessPointPolicyForObjectLambda( args: GetAccessPointPolicyForObjectLambdaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessPointPolicyForObjectLambdaCommandOutput) => void ): void; - public getAccessPointPolicyForObjectLambda( - args: GetAccessPointPolicyForObjectLambdaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccessPointPolicyForObjectLambdaCommandOutput) => void), - cb?: (err: any, data?: GetAccessPointPolicyForObjectLambdaCommandOutput) => void - ): Promise | void { - const command = new GetAccessPointPolicyForObjectLambdaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Indicates whether the specified access point currently has a policy that allows public access. - * For more information about public access through access points, see Managing Data Access with Amazon S3 - * access points in the Amazon S3 User Guide.

- */ - public getAccessPointPolicyStatus( + + /** + * @see {@link GetAccessPointPolicyStatusCommand} + */ + getAccessPointPolicyStatus( args: GetAccessPointPolicyStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccessPointPolicyStatus( + getAccessPointPolicyStatus( args: GetAccessPointPolicyStatusCommandInput, cb: (err: any, data?: GetAccessPointPolicyStatusCommandOutput) => void ): void; - public getAccessPointPolicyStatus( + getAccessPointPolicyStatus( args: GetAccessPointPolicyStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessPointPolicyStatusCommandOutput) => void ): void; - public getAccessPointPolicyStatus( - args: GetAccessPointPolicyStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccessPointPolicyStatusCommandOutput) => void), - cb?: (err: any, data?: GetAccessPointPolicyStatusCommandOutput) => void - ): Promise | void { - const command = new GetAccessPointPolicyStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the status of the resource policy associated with an Object Lambda Access Point.

- */ - public getAccessPointPolicyStatusForObjectLambda( + + /** + * @see {@link GetAccessPointPolicyStatusForObjectLambdaCommand} + */ + getAccessPointPolicyStatusForObjectLambda( args: GetAccessPointPolicyStatusForObjectLambdaCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccessPointPolicyStatusForObjectLambda( + getAccessPointPolicyStatusForObjectLambda( args: GetAccessPointPolicyStatusForObjectLambdaCommandInput, cb: (err: any, data?: GetAccessPointPolicyStatusForObjectLambdaCommandOutput) => void ): void; - public getAccessPointPolicyStatusForObjectLambda( + getAccessPointPolicyStatusForObjectLambda( args: GetAccessPointPolicyStatusForObjectLambdaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessPointPolicyStatusForObjectLambdaCommandOutput) => void ): void; - public getAccessPointPolicyStatusForObjectLambda( - args: GetAccessPointPolicyStatusForObjectLambdaCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetAccessPointPolicyStatusForObjectLambdaCommandOutput) => void), - cb?: (err: any, data?: GetAccessPointPolicyStatusForObjectLambdaCommandOutput) => void - ): Promise | void { - const command = new GetAccessPointPolicyStatusForObjectLambdaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the - * Amazon S3 User Guide.

- *

If you are using an identity other than the root user of the Amazon Web Services account that owns the - * Outposts bucket, the calling identity must have the s3-outposts:GetBucket - * permissions on the specified Outposts bucket and belong to the Outposts bucket owner's - * account in order to use this action. Only users from Outposts bucket owner account with - * the right permissions can perform actions on an Outposts bucket.

- *

If you don't have s3-outposts:GetBucket permissions or you're not using an - * identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access - * Denied error.

- *

The following actions are related to GetBucket for Amazon S3 on Outposts:

- *

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

- * - */ - public getBucket(args: GetBucketCommandInput, options?: __HttpHandlerOptions): Promise; - public getBucket(args: GetBucketCommandInput, cb: (err: any, data?: GetBucketCommandOutput) => void): void; - public getBucket( + + /** + * @see {@link GetBucketCommand} + */ + getBucket(args: GetBucketCommandInput, options?: __HttpHandlerOptions): Promise; + getBucket(args: GetBucketCommandInput, cb: (err: any, data?: GetBucketCommandOutput) => void): void; + getBucket( args: GetBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketCommandOutput) => void ): void; - public getBucket( - args: GetBucketCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketCommandOutput) => void), - cb?: (err: any, data?: GetBucketCommandOutput) => void - ): Promise | void { - const command = new GetBucketCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 - * bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon S3 API Reference. - *

- *
- *

Returns the lifecycle configuration information set on the Outposts bucket. For more - * information, see Using Amazon S3 on Outposts and for - * information about lifecycle configuration, see Object Lifecycle - * Management in Amazon S3 User Guide.

- *

To use this action, you must have permission to perform the - * s3-outposts:GetLifecycleConfiguration action. The Outposts bucket owner - * has this permission, by default. The bucket owner can grant this permission to others. For - * more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

- *

- * GetBucketLifecycleConfiguration has the following special error:

- *
    - *
  • - *

    Error code: NoSuchLifecycleConfiguration - *

    - *
      - *
    • - *

      Description: The lifecycle configuration does not exist.

      - *
    • - *
    • - *

      HTTP Status Code: 404 Not Found

      - *
    • - *
    • - *

      SOAP Fault Code Prefix: Client

      - *
    • - *
    - *
  • - *
- *

The following actions are related to - * GetBucketLifecycleConfiguration:

- * - */ - public getBucketLifecycleConfiguration( + + /** + * @see {@link GetBucketLifecycleConfigurationCommand} + */ + getBucketLifecycleConfiguration( args: GetBucketLifecycleConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketLifecycleConfiguration( + getBucketLifecycleConfiguration( args: GetBucketLifecycleConfigurationCommandInput, cb: (err: any, data?: GetBucketLifecycleConfigurationCommandOutput) => void ): void; - public getBucketLifecycleConfiguration( + getBucketLifecycleConfiguration( args: GetBucketLifecycleConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketLifecycleConfigurationCommandOutput) => void ): void; - public getBucketLifecycleConfiguration( - args: GetBucketLifecycleConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketLifecycleConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetBucketLifecycleConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetBucketLifecycleConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for - * an S3 bucket, see GetBucketPolicy in the - * Amazon S3 API Reference.

- *
- *

Returns the policy of a specified Outposts bucket. For more information, see Using - * Amazon S3 on Outposts in the Amazon S3 User Guide.

- *

If you are using an identity other than the root user of the Amazon Web Services account that owns the - * bucket, the calling identity must have the GetBucketPolicy permissions on the - * specified bucket and belong to the bucket owner's account in order to use this - * action.

- *

Only users from Outposts bucket owner account with the right permissions can perform - * actions on an Outposts bucket. If you don't have s3-outposts:GetBucketPolicy - * permissions or you're not using an identity that belongs to the bucket owner's account, - * Amazon S3 returns a 403 Access Denied error.

- * - *

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can - * always use this action, even if the policy explicitly denies the root user the ability - * to perform this action.

- *
- *

For more information about bucket policies, see Using Bucket Policies and User - * Policies.

- *

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

- *

The following actions are related to GetBucketPolicy:

- * - */ - public getBucketPolicy( + + /** + * @see {@link GetBucketPolicyCommand} + */ + getBucketPolicy( args: GetBucketPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketPolicy( - args: GetBucketPolicyCommandInput, - cb: (err: any, data?: GetBucketPolicyCommandOutput) => void - ): void; - public getBucketPolicy( + getBucketPolicy(args: GetBucketPolicyCommandInput, cb: (err: any, data?: GetBucketPolicyCommandOutput) => void): void; + getBucketPolicy( args: GetBucketPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketPolicyCommandOutput) => void ): void; - public getBucketPolicy( - args: GetBucketPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketPolicyCommandOutput) => void), - cb?: (err: any, data?: GetBucketPolicyCommandOutput) => void - ): Promise | void { - const command = new GetBucketPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This operation gets an Amazon S3 on Outposts bucket's replication configuration. To get an - * S3 bucket's replication configuration, see GetBucketReplication - * in the Amazon S3 API Reference.

- *
- *

Returns the replication configuration of an S3 on Outposts bucket. For more information - * about S3 on Outposts, see Using Amazon S3 on Outposts in the - * Amazon S3 User Guide. For information about S3 replication on Outposts - * configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide.

- * - *

It can take a while to propagate PUT or DELETE requests for - * a replication configuration to all S3 on Outposts systems. Therefore, the replication - * configuration that's returned by a GET request soon after a - * PUT or DELETE request might return a more recent result - * than what's on the Outpost. If an Outpost is offline, the delay in updating the - * replication configuration on that Outpost can be significant.

- *
- *

This action requires permissions for the - * s3-outposts:GetReplicationConfiguration action. The Outposts bucket owner - * has this permission by default and can grant it to others. For more information about - * permissions, see Setting up IAM with - * S3 on Outposts and Managing access to - * S3 on Outposts bucket in the Amazon S3 User Guide.

- *

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

- *

If you include the Filter element in a replication configuration, you must - * also include the DeleteMarkerReplication, Status, and - * Priority elements. The response also returns those elements.

- *

For information about S3 on Outposts replication failure reasons, see Replication failure reasons in the Amazon S3 User Guide.

- *

The following operations are related to GetBucketReplication:

- * - */ - public getBucketReplication( + + /** + * @see {@link GetBucketReplicationCommand} + */ + getBucketReplication( args: GetBucketReplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketReplication( + getBucketReplication( args: GetBucketReplicationCommandInput, cb: (err: any, data?: GetBucketReplicationCommandOutput) => void ): void; - public getBucketReplication( + getBucketReplication( args: GetBucketReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketReplicationCommandOutput) => void ): void; - public getBucketReplication( - args: GetBucketReplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketReplicationCommandOutput) => void), - cb?: (err: any, data?: GetBucketReplicationCommandOutput) => void - ): Promise | void { - const command = new GetBucketReplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see - * GetBucketTagging in the Amazon S3 API Reference.

- *
- *

Returns the tag set associated with the Outposts bucket. For more information, see - * Using - * Amazon S3 on Outposts in the Amazon S3 User Guide.

- *

To use this action, you must have permission to perform the - * GetBucketTagging action. By default, the bucket owner has this permission - * and can grant this permission to others.

- *

- * GetBucketTagging has the following special error:

- *
    - *
  • - *

    Error code: NoSuchTagSetError - *

    - *
      - *
    • - *

      Description: There is no tag set associated with the bucket.

      - *
    • - *
    - *
  • - *
- *

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

- *

The following actions are related to GetBucketTagging:

- * - */ - public getBucketTagging( + + /** + * @see {@link GetBucketTaggingCommand} + */ + getBucketTagging( args: GetBucketTaggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketTagging( + getBucketTagging( args: GetBucketTaggingCommandInput, cb: (err: any, data?: GetBucketTaggingCommandOutput) => void ): void; - public getBucketTagging( + getBucketTagging( args: GetBucketTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketTaggingCommandOutput) => void ): void; - public getBucketTagging( - args: GetBucketTaggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketTaggingCommandOutput) => void), - cb?: (err: any, data?: GetBucketTaggingCommandOutput) => void - ): Promise | void { - const command = new GetBucketTaggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This operation returns the versioning state - * for - * S3 on Outposts - * buckets - * only. To return the versioning state for an S3 bucket, see GetBucketVersioning in the Amazon S3 API Reference.

- *
- *

Returns the versioning state for an S3 on Outposts bucket. With - * S3 - * Versioning, - * you can save multiple distinct copies of your - * objects - * and recover from unintended user actions and application failures.

- *

If you've never set versioning on your bucket, it has no versioning state. In that case, - * the GetBucketVersioning request does not return a versioning state - * value.

- *

For more information about versioning, see Versioning in the Amazon S3 - * User Guide.

- *

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

- *

The following operations are related to GetBucketVersioning for - * S3 on Outposts.

- * - */ - public getBucketVersioning( + + /** + * @see {@link GetBucketVersioningCommand} + */ + getBucketVersioning( args: GetBucketVersioningCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketVersioning( + getBucketVersioning( args: GetBucketVersioningCommandInput, cb: (err: any, data?: GetBucketVersioningCommandOutput) => void ): void; - public getBucketVersioning( + getBucketVersioning( args: GetBucketVersioningCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketVersioningCommandOutput) => void ): void; - public getBucketVersioning( - args: GetBucketVersioningCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketVersioningCommandOutput) => void), - cb?: (err: any, data?: GetBucketVersioningCommandOutput) => void - ): Promise | void { - const command = new GetBucketVersioningCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the tags on an S3 Batch Operations job. To use - * the - * GetJobTagging operation, you must have permission to - * perform the s3:GetJobTagging action. For more information, see Controlling - * access and labeling jobs using tags in the - * Amazon S3 User Guide.

- *

- *

Related actions include:

- * - */ - public getJobTagging( - args: GetJobTaggingCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getJobTagging( - args: GetJobTaggingCommandInput, - cb: (err: any, data?: GetJobTaggingCommandOutput) => void - ): void; - public getJobTagging( + + /** + * @see {@link GetJobTaggingCommand} + */ + getJobTagging(args: GetJobTaggingCommandInput, options?: __HttpHandlerOptions): Promise; + getJobTagging(args: GetJobTaggingCommandInput, cb: (err: any, data?: GetJobTaggingCommandOutput) => void): void; + getJobTagging( args: GetJobTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobTaggingCommandOutput) => void ): void; - public getJobTagging( - args: GetJobTaggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetJobTaggingCommandOutput) => void), - cb?: (err: any, data?: GetJobTaggingCommandOutput) => void - ): Promise | void { - const command = new GetJobTaggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns configuration information about the specified Multi-Region Access Point.

- *

This action will always be routed to the US West (Oregon) Region. For more information - * about the restrictions around managing Multi-Region Access Points, see Managing - * Multi-Region Access Points in the Amazon S3 User Guide.

- *

The following actions are related to GetMultiRegionAccessPoint:

- * - */ - public getMultiRegionAccessPoint( + + /** + * @see {@link GetMultiRegionAccessPointCommand} + */ + getMultiRegionAccessPoint( args: GetMultiRegionAccessPointCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMultiRegionAccessPoint( + getMultiRegionAccessPoint( args: GetMultiRegionAccessPointCommandInput, cb: (err: any, data?: GetMultiRegionAccessPointCommandOutput) => void ): void; - public getMultiRegionAccessPoint( + getMultiRegionAccessPoint( args: GetMultiRegionAccessPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMultiRegionAccessPointCommandOutput) => void ): void; - public getMultiRegionAccessPoint( - args: GetMultiRegionAccessPointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMultiRegionAccessPointCommandOutput) => void), - cb?: (err: any, data?: GetMultiRegionAccessPointCommandOutput) => void - ): Promise | void { - const command = new GetMultiRegionAccessPointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the access control policy of the specified Multi-Region Access Point.

- *

This action will always be routed to the US West (Oregon) Region. For more information - * about the restrictions around managing Multi-Region Access Points, see Managing - * Multi-Region Access Points in the Amazon S3 User Guide.

- *

The following actions are related to - * GetMultiRegionAccessPointPolicy:

- * - */ - public getMultiRegionAccessPointPolicy( + + /** + * @see {@link GetMultiRegionAccessPointPolicyCommand} + */ + getMultiRegionAccessPointPolicy( args: GetMultiRegionAccessPointPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMultiRegionAccessPointPolicy( + getMultiRegionAccessPointPolicy( args: GetMultiRegionAccessPointPolicyCommandInput, cb: (err: any, data?: GetMultiRegionAccessPointPolicyCommandOutput) => void ): void; - public getMultiRegionAccessPointPolicy( + getMultiRegionAccessPointPolicy( args: GetMultiRegionAccessPointPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMultiRegionAccessPointPolicyCommandOutput) => void ): void; - public getMultiRegionAccessPointPolicy( - args: GetMultiRegionAccessPointPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMultiRegionAccessPointPolicyCommandOutput) => void), - cb?: (err: any, data?: GetMultiRegionAccessPointPolicyCommandOutput) => void - ): Promise | void { - const command = new GetMultiRegionAccessPointPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Indicates whether the specified Multi-Region Access Point has an access control policy that allows public - * access.

- *

This action will always be routed to the US West (Oregon) Region. For more information - * about the restrictions around managing Multi-Region Access Points, see Managing - * Multi-Region Access Points in the Amazon S3 User Guide.

- *

The following actions are related to - * GetMultiRegionAccessPointPolicyStatus:

- * - */ - public getMultiRegionAccessPointPolicyStatus( + + /** + * @see {@link GetMultiRegionAccessPointPolicyStatusCommand} + */ + getMultiRegionAccessPointPolicyStatus( args: GetMultiRegionAccessPointPolicyStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMultiRegionAccessPointPolicyStatus( + getMultiRegionAccessPointPolicyStatus( args: GetMultiRegionAccessPointPolicyStatusCommandInput, cb: (err: any, data?: GetMultiRegionAccessPointPolicyStatusCommandOutput) => void ): void; - public getMultiRegionAccessPointPolicyStatus( + getMultiRegionAccessPointPolicyStatus( args: GetMultiRegionAccessPointPolicyStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMultiRegionAccessPointPolicyStatusCommandOutput) => void ): void; - public getMultiRegionAccessPointPolicyStatus( - args: GetMultiRegionAccessPointPolicyStatusCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetMultiRegionAccessPointPolicyStatusCommandOutput) => void), - cb?: (err: any, data?: GetMultiRegionAccessPointPolicyStatusCommandOutput) => void - ): Promise | void { - const command = new GetMultiRegionAccessPointPolicyStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or - * passive.

- *

To obtain routing control changes and failover requests, use the Amazon S3 failover control - * infrastructure endpoints in these five Amazon Web Services Regions:

- *
    - *
  • - *

    - * us-east-1 - *

    - *
  • - *
  • - *

    - * us-west-2 - *

    - *
  • - *
  • - *

    - * ap-southeast-2 - *

    - *
  • - *
  • - *

    - * ap-northeast-1 - *

    - *
  • - *
  • - *

    - * eu-west-1 - *

    - *
  • - *
- * - *

Your Amazon S3 bucket does not need to be in these five Regions.

- *
- */ - public getMultiRegionAccessPointRoutes( + + /** + * @see {@link GetMultiRegionAccessPointRoutesCommand} + */ + getMultiRegionAccessPointRoutes( args: GetMultiRegionAccessPointRoutesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMultiRegionAccessPointRoutes( + getMultiRegionAccessPointRoutes( args: GetMultiRegionAccessPointRoutesCommandInput, cb: (err: any, data?: GetMultiRegionAccessPointRoutesCommandOutput) => void ): void; - public getMultiRegionAccessPointRoutes( + getMultiRegionAccessPointRoutes( args: GetMultiRegionAccessPointRoutesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMultiRegionAccessPointRoutesCommandOutput) => void ): void; - public getMultiRegionAccessPointRoutes( - args: GetMultiRegionAccessPointRoutesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMultiRegionAccessPointRoutesCommandOutput) => void), - cb?: (err: any, data?: GetMultiRegionAccessPointRoutesCommandOutput) => void - ): Promise | void { - const command = new GetMultiRegionAccessPointRoutesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the PublicAccessBlock configuration for an Amazon Web Services account. For - * more information, see Using Amazon S3 block - * public access.

- *

Related actions include:

- * - */ - public getPublicAccessBlock( + + /** + * @see {@link GetPublicAccessBlockCommand} + */ + getPublicAccessBlock( args: GetPublicAccessBlockCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPublicAccessBlock( + getPublicAccessBlock( args: GetPublicAccessBlockCommandInput, cb: (err: any, data?: GetPublicAccessBlockCommandOutput) => void ): void; - public getPublicAccessBlock( + getPublicAccessBlock( args: GetPublicAccessBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPublicAccessBlockCommandOutput) => void ): void; - public getPublicAccessBlock( - args: GetPublicAccessBlockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPublicAccessBlockCommandOutput) => void), - cb?: (err: any, data?: GetPublicAccessBlockCommandOutput) => void - ): Promise | void { - const command = new GetPublicAccessBlockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage - * activity and usage with Amazon S3 Storage Lens in the - * Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.

- * - *

To use this action, you must have permission to perform the - * s3:GetStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the - * Amazon S3 User Guide.

- *
- */ - public getStorageLensConfiguration( + + /** + * @see {@link GetStorageLensConfigurationCommand} + */ + getStorageLensConfiguration( args: GetStorageLensConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getStorageLensConfiguration( + getStorageLensConfiguration( args: GetStorageLensConfigurationCommandInput, cb: (err: any, data?: GetStorageLensConfigurationCommandOutput) => void ): void; - public getStorageLensConfiguration( + getStorageLensConfiguration( args: GetStorageLensConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStorageLensConfigurationCommandOutput) => void ): void; - public getStorageLensConfiguration( - args: GetStorageLensConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStorageLensConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetStorageLensConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetStorageLensConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see - * Assessing your - * storage activity and usage with Amazon S3 Storage Lens in the - * Amazon S3 User Guide.

- * - *

To use this action, you must have permission to perform the - * s3:GetStorageLensConfigurationTagging action. For more information, see - * Setting permissions to - * use Amazon S3 Storage Lens in the Amazon S3 User Guide.

- *
- */ - public getStorageLensConfigurationTagging( + + /** + * @see {@link GetStorageLensConfigurationTaggingCommand} + */ + getStorageLensConfigurationTagging( args: GetStorageLensConfigurationTaggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public getStorageLensConfigurationTagging( + getStorageLensConfigurationTagging( args: GetStorageLensConfigurationTaggingCommandInput, cb: (err: any, data?: GetStorageLensConfigurationTaggingCommandOutput) => void ): void; - public getStorageLensConfigurationTagging( + getStorageLensConfigurationTagging( args: GetStorageLensConfigurationTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStorageLensConfigurationTaggingCommandOutput) => void ): void; - public getStorageLensConfigurationTagging( - args: GetStorageLensConfigurationTaggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetStorageLensConfigurationTaggingCommandOutput) => void), - cb?: (err: any, data?: GetStorageLensConfigurationTaggingCommandOutput) => void - ): Promise | void { - const command = new GetStorageLensConfigurationTaggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of the access points - * that are - * owned by the current account - * that's - * associated with the specified bucket. You can retrieve up to 1000 access points - * per call. If the specified bucket has more than 1,000 access points (or the number specified in - * maxResults, whichever is less), the response will include a continuation - * token that you can use to list the additional access points.

- *

- *

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

- *

The following actions are related to ListAccessPoints:

- * - */ - public listAccessPoints( + + /** + * @see {@link ListAccessPointsCommand} + */ + listAccessPoints( args: ListAccessPointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAccessPoints( + listAccessPoints( args: ListAccessPointsCommandInput, cb: (err: any, data?: ListAccessPointsCommandOutput) => void ): void; - public listAccessPoints( + listAccessPoints( args: ListAccessPointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessPointsCommandOutput) => void ): void; - public listAccessPoints( - args: ListAccessPointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccessPointsCommandOutput) => void), - cb?: (err: any, data?: ListAccessPointsCommandOutput) => void - ): Promise | void { - const command = new ListAccessPointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call. If there - * are more access points than what can be returned in one call, the response will include a - * continuation token that you can use to list the additional access points.

- *

The following actions are related to - * ListAccessPointsForObjectLambda:

- * - */ - public listAccessPointsForObjectLambda( + + /** + * @see {@link ListAccessPointsForObjectLambdaCommand} + */ + listAccessPointsForObjectLambda( args: ListAccessPointsForObjectLambdaCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAccessPointsForObjectLambda( + listAccessPointsForObjectLambda( args: ListAccessPointsForObjectLambdaCommandInput, cb: (err: any, data?: ListAccessPointsForObjectLambdaCommandOutput) => void ): void; - public listAccessPointsForObjectLambda( + listAccessPointsForObjectLambda( args: ListAccessPointsForObjectLambdaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessPointsForObjectLambdaCommandOutput) => void ): void; - public listAccessPointsForObjectLambda( - args: ListAccessPointsForObjectLambdaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccessPointsForObjectLambdaCommandOutput) => void), - cb?: (err: any, data?: ListAccessPointsForObjectLambdaCommandOutput) => void - ): Promise | void { - const command = new ListAccessPointsForObjectLambdaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for - * the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the - * Amazon S3 User Guide.

- *

Related actions include:

- *

- * - */ - public listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise; - public listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void; - public listJobs( + + /** + * @see {@link ListJobsCommand} + */ + listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise; + listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void; + listJobs( args: ListJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobsCommandOutput) => void ): void; - public listJobs( - args: ListJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJobsCommandOutput) => void), - cb?: (err: any, data?: ListJobsCommandOutput) => void - ): Promise | void { - const command = new ListJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account. - * Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be - * associated with a single account.

- *

This action will always be routed to the US West (Oregon) Region. For more information - * about the restrictions around managing Multi-Region Access Points, see Managing - * Multi-Region Access Points in the Amazon S3 User Guide.

- *

The following actions are related to ListMultiRegionAccessPoint:

- * - */ - public listMultiRegionAccessPoints( + + /** + * @see {@link ListMultiRegionAccessPointsCommand} + */ + listMultiRegionAccessPoints( args: ListMultiRegionAccessPointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMultiRegionAccessPoints( + listMultiRegionAccessPoints( args: ListMultiRegionAccessPointsCommandInput, cb: (err: any, data?: ListMultiRegionAccessPointsCommandOutput) => void ): void; - public listMultiRegionAccessPoints( + listMultiRegionAccessPoints( args: ListMultiRegionAccessPointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMultiRegionAccessPointsCommandOutput) => void ): void; - public listMultiRegionAccessPoints( - args: ListMultiRegionAccessPointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMultiRegionAccessPointsCommandOutput) => void), - cb?: (err: any, data?: ListMultiRegionAccessPointsCommandOutput) => void - ): Promise | void { - const command = new ListMultiRegionAccessPointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated - * sender of the request. For more information, see Using Amazon S3 on Outposts in the - * Amazon S3 User Guide.

- *

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts - * endpoint hostname prefix and x-amz-outpost-id in your request, see the Examples section.

- */ - public listRegionalBuckets( + + /** + * @see {@link ListRegionalBucketsCommand} + */ + listRegionalBuckets( args: ListRegionalBucketsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRegionalBuckets( + listRegionalBuckets( args: ListRegionalBucketsCommandInput, cb: (err: any, data?: ListRegionalBucketsCommandOutput) => void ): void; - public listRegionalBuckets( + listRegionalBuckets( args: ListRegionalBucketsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRegionalBucketsCommandOutput) => void ): void; - public listRegionalBuckets( - args: ListRegionalBucketsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRegionalBucketsCommandOutput) => void), - cb?: (err: any, data?: ListRegionalBucketsCommandOutput) => void - ): Promise | void { - const command = new ListRegionalBucketsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see - * Assessing your - * storage activity and usage with Amazon S3 Storage Lens in the - * Amazon S3 User Guide.

- * - *

To use this action, you must have permission to perform the - * s3:ListStorageLensConfigurations action. For more information, see - * Setting permissions to - * use Amazon S3 Storage Lens in the Amazon S3 User Guide.

- *
- */ - public listStorageLensConfigurations( + + /** + * @see {@link ListStorageLensConfigurationsCommand} + */ + listStorageLensConfigurations( args: ListStorageLensConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStorageLensConfigurations( + listStorageLensConfigurations( args: ListStorageLensConfigurationsCommandInput, cb: (err: any, data?: ListStorageLensConfigurationsCommandOutput) => void ): void; - public listStorageLensConfigurations( + listStorageLensConfigurations( args: ListStorageLensConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStorageLensConfigurationsCommandOutput) => void ): void; - public listStorageLensConfigurations( - args: ListStorageLensConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStorageLensConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListStorageLensConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListStorageLensConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Replaces configuration for an Object Lambda Access Point.

- *

The following actions are related to - * PutAccessPointConfigurationForObjectLambda:

- * - */ - public putAccessPointConfigurationForObjectLambda( + + /** + * @see {@link PutAccessPointConfigurationForObjectLambdaCommand} + */ + putAccessPointConfigurationForObjectLambda( args: PutAccessPointConfigurationForObjectLambdaCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAccessPointConfigurationForObjectLambda( + putAccessPointConfigurationForObjectLambda( args: PutAccessPointConfigurationForObjectLambdaCommandInput, cb: (err: any, data?: PutAccessPointConfigurationForObjectLambdaCommandOutput) => void ): void; - public putAccessPointConfigurationForObjectLambda( + putAccessPointConfigurationForObjectLambda( args: PutAccessPointConfigurationForObjectLambdaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccessPointConfigurationForObjectLambdaCommandOutput) => void ): void; - public putAccessPointConfigurationForObjectLambda( - args: PutAccessPointConfigurationForObjectLambdaCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PutAccessPointConfigurationForObjectLambdaCommandOutput) => void), - cb?: (err: any, data?: PutAccessPointConfigurationForObjectLambdaCommandOutput) => void - ): Promise | void { - const command = new PutAccessPointConfigurationForObjectLambdaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates an access policy with the specified access point. Each access point can have only one policy, - * so a request made to this API replaces any existing policy associated with the specified - * access point.

- *

- *

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

- *

The following actions are related to PutAccessPointPolicy:

- * - */ - public putAccessPointPolicy( + + /** + * @see {@link PutAccessPointPolicyCommand} + */ + putAccessPointPolicy( args: PutAccessPointPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAccessPointPolicy( + putAccessPointPolicy( args: PutAccessPointPolicyCommandInput, cb: (err: any, data?: PutAccessPointPolicyCommandOutput) => void ): void; - public putAccessPointPolicy( + putAccessPointPolicy( args: PutAccessPointPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccessPointPolicyCommandOutput) => void ): void; - public putAccessPointPolicy( - args: PutAccessPointPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAccessPointPolicyCommandOutput) => void), - cb?: (err: any, data?: PutAccessPointPolicyCommandOutput) => void - ): Promise | void { - const command = new PutAccessPointPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see Creating Object Lambda Access Points in the Amazon S3 User Guide.

- *

The following actions are related to - * PutAccessPointPolicyForObjectLambda:

- * - */ - public putAccessPointPolicyForObjectLambda( + + /** + * @see {@link PutAccessPointPolicyForObjectLambdaCommand} + */ + putAccessPointPolicyForObjectLambda( args: PutAccessPointPolicyForObjectLambdaCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAccessPointPolicyForObjectLambda( + putAccessPointPolicyForObjectLambda( args: PutAccessPointPolicyForObjectLambdaCommandInput, cb: (err: any, data?: PutAccessPointPolicyForObjectLambdaCommandOutput) => void ): void; - public putAccessPointPolicyForObjectLambda( + putAccessPointPolicyForObjectLambda( args: PutAccessPointPolicyForObjectLambdaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccessPointPolicyForObjectLambdaCommandOutput) => void ): void; - public putAccessPointPolicyForObjectLambda( - args: PutAccessPointPolicyForObjectLambdaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAccessPointPolicyForObjectLambdaCommandOutput) => void), - cb?: (err: any, data?: PutAccessPointPolicyForObjectLambdaCommandOutput) => void - ): Promise | void { - const command = new PutAccessPointPolicyForObjectLambdaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a - * lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration in the Amazon S3 API Reference. - *

- *
- *

Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an - * existing lifecycle configuration. Outposts buckets only support lifecycle configurations - * that delete/expire objects after a certain period of time and abort incomplete multipart - * uploads.

- *

- *

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

- *

The following actions are related to - * PutBucketLifecycleConfiguration:

- * - */ - public putBucketLifecycleConfiguration( + + /** + * @see {@link PutBucketLifecycleConfigurationCommand} + */ + putBucketLifecycleConfiguration( args: PutBucketLifecycleConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketLifecycleConfiguration( + putBucketLifecycleConfiguration( args: PutBucketLifecycleConfigurationCommandInput, cb: (err: any, data?: PutBucketLifecycleConfigurationCommandOutput) => void ): void; - public putBucketLifecycleConfiguration( + putBucketLifecycleConfiguration( args: PutBucketLifecycleConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketLifecycleConfigurationCommandOutput) => void ): void; - public putBucketLifecycleConfiguration( - args: PutBucketLifecycleConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketLifecycleConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutBucketLifecycleConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutBucketLifecycleConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an - * S3 bucket, see PutBucketPolicy in the - * Amazon S3 API Reference.

- *
- *

Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using - * Amazon S3 on Outposts in the Amazon S3 User Guide.

- *

If you are using an identity other than the root user of the Amazon Web Services account that owns the - * Outposts bucket, the calling identity must have the PutBucketPolicy - * permissions on the specified Outposts bucket and belong to the bucket owner's account in - * order to use this action.

- *

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - * Access Denied error. If you have the correct permissions, but you're not using an - * identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not - * Allowed error.

- * - *

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can - * always use this action, even if the policy explicitly denies the root user the ability - * to perform this action.

- *
- *

For more information about bucket policies, see Using Bucket Policies and User - * Policies.

- *

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

- *

The following actions are related to PutBucketPolicy:

- * - */ - public putBucketPolicy( + + /** + * @see {@link PutBucketPolicyCommand} + */ + putBucketPolicy( args: PutBucketPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketPolicy( - args: PutBucketPolicyCommandInput, - cb: (err: any, data?: PutBucketPolicyCommandOutput) => void - ): void; - public putBucketPolicy( + putBucketPolicy(args: PutBucketPolicyCommandInput, cb: (err: any, data?: PutBucketPolicyCommandOutput) => void): void; + putBucketPolicy( args: PutBucketPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketPolicyCommandOutput) => void ): void; - public putBucketPolicy( - args: PutBucketPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketPolicyCommandOutput) => void), - cb?: (err: any, data?: PutBucketPolicyCommandOutput) => void - ): Promise | void { - const command = new PutBucketPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This action creates an Amazon S3 on Outposts bucket's replication configuration. To create - * an S3 bucket's replication configuration, see PutBucketReplication - * in the Amazon S3 API Reference.

- *
- *

Creates a replication configuration or replaces an existing one. For information about - * S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the - * Amazon S3 User Guide.

- * - *

It can take a while to propagate PUT or DELETE requests for - * a replication configuration to all S3 on Outposts systems. Therefore, the replication - * configuration that's returned by a GET request soon after a - * PUT or DELETE request might return a more recent result - * than what's on the Outpost. If an Outpost is offline, the delay in updating the - * replication configuration on that Outpost can be significant.

- *
- *

Specify the replication configuration in the request body. In the replication - * configuration, you provide the following information:

- *
    - *
  • - *

    The name of the destination bucket or buckets where you want S3 on Outposts to - * replicate objects

    - *
  • - *
  • - *

    The Identity and Access Management (IAM) role that S3 on Outposts can assume to replicate objects on - * your behalf

    - *
  • - *
  • - *

    Other relevant information, such as replication rules

    - *
  • - *
- *

A replication configuration must include at least one rule and can contain a maximum of - * 100. Each rule identifies a subset of objects to replicate by filtering the objects in - * the source Outposts bucket. To choose additional subsets of objects to replicate, add a - * rule for each subset.

- *

To specify a subset of the objects in the source Outposts bucket to apply a replication - * rule to, add the Filter element as a child of the Rule element. - * You can filter objects based on an object key prefix, one or more object tags, or both. - * When you add the Filter element in the configuration, you must also add the - * following elements: DeleteMarkerReplication, Status, and - * Priority.

- *

Using PutBucketReplication on Outposts requires that both the source and - * destination buckets must have versioning enabled. For information about enabling versioning - * on a bucket, see Managing S3 Versioning - * for your S3 on Outposts bucket.

- *

For information about S3 on Outposts replication failure reasons, see Replication failure reasons in the Amazon S3 User Guide.

- *

- * Handling Replication of Encrypted Objects - *

- *

Outposts buckets are encrypted at all times. All the objects in the source Outposts - * bucket are encrypted and can be replicated. Also, all the replicas in the destination - * Outposts bucket are encrypted with the same encryption key as the objects in the source - * Outposts bucket.

- *

- * Permissions - *

- *

To create a PutBucketReplication request, you must have - * s3-outposts:PutReplicationConfiguration permissions for the bucket. The - * Outposts bucket owner has this permission by default and can grant it to others. For more - * information about permissions, see Setting up IAM with - * S3 on Outposts and Managing access to - * S3 on Outposts buckets.

- * - *

To perform this operation, the user or role must also have the iam:CreateRole and iam:PassRole permissions. - * For more information, see Granting a user - * permissions to pass a role to an Amazon Web Services service.

- *
- *

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

- *

The following operations are related to PutBucketReplication:

- * - */ - public putBucketReplication( + + /** + * @see {@link PutBucketReplicationCommand} + */ + putBucketReplication( args: PutBucketReplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketReplication( + putBucketReplication( args: PutBucketReplicationCommandInput, cb: (err: any, data?: PutBucketReplicationCommandOutput) => void ): void; - public putBucketReplication( + putBucketReplication( args: PutBucketReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketReplicationCommandOutput) => void ): void; - public putBucketReplication( - args: PutBucketReplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketReplicationCommandOutput) => void), - cb?: (err: any, data?: PutBucketReplicationCommandOutput) => void - ): Promise | void { - const command = new PutBucketReplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see - * PutBucketTagging in the Amazon S3 API Reference.

- *
- *

Sets the tags for an S3 on Outposts bucket. For more information, see Using - * Amazon S3 on Outposts in the Amazon S3 User Guide.

- *

Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, - * sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost - * of combined resources, organize your billing information according to resources with the - * same tag key values. For example, you can tag several resources with a specific application - * name, and then organize your billing information to see the total cost of that application - * across several services. For more information, see Cost allocation and - * tagging.

- * - *

Within a bucket, if you add a tag that has the same key as an existing tag, the new - * value overwrites the old value. For more information, see Using cost allocation in Amazon S3 - * bucket tags.

- *
- *

To use this action, you must have permissions to perform the - * s3-outposts:PutBucketTagging action. The Outposts bucket owner has this - * permission by default and can grant this permission to others. For more information about - * permissions, see Permissions Related to Bucket Subresource Operations and Managing - * access permissions to your Amazon S3 resources.

- *

- * PutBucketTagging has the following special errors:

- *
    - *
  • - *

    Error code: InvalidTagError - *

    - * - *
  • - *
  • - *

    Error code: MalformedXMLError - *

    - *
      - *
    • - *

      Description: The XML provided does not match the schema.

      - *
    • - *
    - *
  • - *
  • - *

    Error code: OperationAbortedError - *

    - *
      - *
    • - *

      Description: A conflicting conditional action is currently in progress - * against this resource. Try again.

      - *
    • - *
    - *
  • - *
  • - *

    Error code: InternalError - *

    - *
      - *
    • - *

      Description: The service was unable to apply the provided tag to the - * bucket.

      - *
    • - *
    - *
  • - *
- *

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

- *

The following actions are related to PutBucketTagging:

- * - */ - public putBucketTagging( + + /** + * @see {@link PutBucketTaggingCommand} + */ + putBucketTagging( args: PutBucketTaggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketTagging( + putBucketTagging( args: PutBucketTaggingCommandInput, cb: (err: any, data?: PutBucketTaggingCommandOutput) => void ): void; - public putBucketTagging( + putBucketTagging( args: PutBucketTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketTaggingCommandOutput) => void ): void; - public putBucketTagging( - args: PutBucketTaggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketTaggingCommandOutput) => void), - cb?: (err: any, data?: PutBucketTaggingCommandOutput) => void - ): Promise | void { - const command = new PutBucketTaggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * - *

This operation sets the versioning state - * for - * S3 on Outposts - * buckets - * only. To set the versioning state for an S3 bucket, see PutBucketVersioning in the Amazon S3 API Reference.

- *
- *

Sets the versioning state for an S3 on Outposts bucket. With - * S3 - * Versioning, - * you can save multiple distinct copies of your - * objects - * and recover from unintended user actions and application failures.

- *

You can set the versioning state to one of the following:

- *
    - *
  • - *

    - * Enabled - Enables versioning for the objects in - * the bucket. All objects added to the bucket receive a unique version ID.

    - *
  • - *
  • - *

    - * Suspended - Suspends versioning for the objects - * in the bucket. All objects added to the bucket receive the version ID - * null.

    - *
  • - *
- *

If you've never set versioning on your bucket, it has no versioning state. In that case, - * a - * GetBucketVersioning request does not return a versioning state value.

- *

When you enable S3 Versioning, for each object in your bucket, you have a current - * version and zero or more noncurrent versions. You can configure your bucket S3 Lifecycle - * rules to expire noncurrent versions after a specified time period. For more information, - * see Creating and managing - * a lifecycle configuration for your S3 on Outposts bucket in the Amazon S3 - * User Guide.

- *

If you have an object expiration lifecycle configuration in your non-versioned bucket and you - * want to maintain the same permanent delete behavior when you enable versioning, you must - * add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration will manage - * the deletes of the noncurrent object versions in the version-enabled bucket. For more - * information, see Versioning in the Amazon S3 - * User Guide.

- *

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

- *

The following operations are related to PutBucketVersioning for - * S3 on Outposts.

- * - */ - public putBucketVersioning( + + /** + * @see {@link PutBucketVersioningCommand} + */ + putBucketVersioning( args: PutBucketVersioningCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketVersioning( + putBucketVersioning( args: PutBucketVersioningCommandInput, cb: (err: any, data?: PutBucketVersioningCommandOutput) => void ): void; - public putBucketVersioning( + putBucketVersioning( args: PutBucketVersioningCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketVersioningCommandOutput) => void ): void; - public putBucketVersioning( - args: PutBucketVersioningCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketVersioningCommandOutput) => void), - cb?: (err: any, data?: PutBucketVersioningCommandOutput) => void - ): Promise | void { - const command = new PutBucketVersioningCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the supplied tag-set on an S3 Batch Operations job.

- *

A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending - * a PUT request against the tagging subresource that is associated with the job. To modify - * the existing tag set, you can either replace the existing tag set entirely, or make changes - * within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this action to replace the tag set - * with the one you modified. For more information, see Controlling - * access and labeling jobs using tags in the Amazon S3 User Guide.

- *

- * - *
    - *
  • - *

    If you send this request with an empty tag set, Amazon S3 deletes the existing - * tag set on the Batch Operations job. If you use this method, you are charged for a Tier - * 1 Request (PUT). For more information, see Amazon S3 pricing.

    - *
  • - *
  • - *

    For deleting existing tags for your Batch Operations job, a DeleteJobTagging request is preferred because it achieves the same - * result without incurring charges.

    - *
  • - *
  • - *

    A few things to consider about using tags:

    - *
      - *
    • - *

      Amazon S3 limits the maximum number of tags to 50 tags per job.

      - *
    • - *
    • - *

      You can associate up to 50 tags with a job as long as they have unique - * tag keys.

      - *
    • - *
    • - *

      A tag key can be up to 128 Unicode characters in length, and tag values - * can be up to 256 Unicode characters in length.

      - *
    • - *
    • - *

      The key and values are case sensitive.

      - *
    • - *
    • - *

      For tagging-related restrictions related to characters and encodings, see - * User-Defined Tag Restrictions in the Billing and Cost Management User Guide.

      - *
    • - *
    - *
  • - *
- *
- *

- *

To use the - * PutJobTagging - * operation, - * you must have permission to perform the s3:PutJobTagging action.

- *

Related actions include:

- * - */ - public putJobTagging( - args: PutJobTaggingCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putJobTagging( - args: PutJobTaggingCommandInput, - cb: (err: any, data?: PutJobTaggingCommandOutput) => void - ): void; - public putJobTagging( + + /** + * @see {@link PutJobTaggingCommand} + */ + putJobTagging(args: PutJobTaggingCommandInput, options?: __HttpHandlerOptions): Promise; + putJobTagging(args: PutJobTaggingCommandInput, cb: (err: any, data?: PutJobTaggingCommandOutput) => void): void; + putJobTagging( args: PutJobTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutJobTaggingCommandOutput) => void ): void; - public putJobTagging( - args: PutJobTaggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutJobTaggingCommandOutput) => void), - cb?: (err: any, data?: PutJobTaggingCommandOutput) => void - ): Promise | void { - const command = new PutJobTaggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only - * one policy, so a request made to this action replaces any existing policy that is - * associated with the specified Multi-Region Access Point.

- *

This action will always be routed to the US West (Oregon) Region. For more information - * about the restrictions around managing Multi-Region Access Points, see Managing - * Multi-Region Access Points in the Amazon S3 User Guide.

- *

The following actions are related to - * PutMultiRegionAccessPointPolicy:

- * - */ - public putMultiRegionAccessPointPolicy( + + /** + * @see {@link PutMultiRegionAccessPointPolicyCommand} + */ + putMultiRegionAccessPointPolicy( args: PutMultiRegionAccessPointPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putMultiRegionAccessPointPolicy( + putMultiRegionAccessPointPolicy( args: PutMultiRegionAccessPointPolicyCommandInput, cb: (err: any, data?: PutMultiRegionAccessPointPolicyCommandOutput) => void ): void; - public putMultiRegionAccessPointPolicy( + putMultiRegionAccessPointPolicy( args: PutMultiRegionAccessPointPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMultiRegionAccessPointPolicyCommandOutput) => void ): void; - public putMultiRegionAccessPointPolicy( - args: PutMultiRegionAccessPointPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutMultiRegionAccessPointPolicyCommandOutput) => void), - cb?: (err: any, data?: PutMultiRegionAccessPointPolicyCommandOutput) => void - ): Promise | void { - const command = new PutMultiRegionAccessPointPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or modifies the PublicAccessBlock configuration for an - * Amazon Web Services account. For this operation, users must have the - * s3:PutAccountPublicAccessBlock permission. For more information, see - * Using Amazon S3 block public access.

- *

Related actions include:

- * - */ - public putPublicAccessBlock( + + /** + * @see {@link PutPublicAccessBlockCommand} + */ + putPublicAccessBlock( args: PutPublicAccessBlockCommandInput, options?: __HttpHandlerOptions ): Promise; - public putPublicAccessBlock( + putPublicAccessBlock( args: PutPublicAccessBlockCommandInput, cb: (err: any, data?: PutPublicAccessBlockCommandOutput) => void ): void; - public putPublicAccessBlock( + putPublicAccessBlock( args: PutPublicAccessBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPublicAccessBlockCommandOutput) => void ): void; - public putPublicAccessBlock( - args: PutPublicAccessBlockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutPublicAccessBlockCommandOutput) => void), - cb?: (err: any, data?: PutPublicAccessBlockCommandOutput) => void - ): Promise | void { - const command = new PutPublicAccessBlockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with - * Amazon S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.

- * - *

To use this action, you must have permission to perform the - * s3:PutStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the - * Amazon S3 User Guide.

- *
- */ - public putStorageLensConfiguration( + + /** + * @see {@link PutStorageLensConfigurationCommand} + */ + putStorageLensConfiguration( args: PutStorageLensConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putStorageLensConfiguration( + putStorageLensConfiguration( args: PutStorageLensConfigurationCommandInput, cb: (err: any, data?: PutStorageLensConfigurationCommandOutput) => void ): void; - public putStorageLensConfiguration( + putStorageLensConfiguration( args: PutStorageLensConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutStorageLensConfigurationCommandOutput) => void ): void; - public putStorageLensConfiguration( - args: PutStorageLensConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutStorageLensConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutStorageLensConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutStorageLensConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information - * about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the - * Amazon S3 User Guide.

- * - *

To use this action, you must have permission to perform the - * s3:PutStorageLensConfigurationTagging action. For more information, see - * Setting permissions to - * use Amazon S3 Storage Lens in the Amazon S3 User Guide.

- *
- */ - public putStorageLensConfigurationTagging( + + /** + * @see {@link PutStorageLensConfigurationTaggingCommand} + */ + putStorageLensConfigurationTagging( args: PutStorageLensConfigurationTaggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public putStorageLensConfigurationTagging( + putStorageLensConfigurationTagging( args: PutStorageLensConfigurationTaggingCommandInput, cb: (err: any, data?: PutStorageLensConfigurationTaggingCommandOutput) => void ): void; - public putStorageLensConfigurationTagging( + putStorageLensConfigurationTagging( args: PutStorageLensConfigurationTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutStorageLensConfigurationTaggingCommandOutput) => void ): void; - public putStorageLensConfigurationTagging( - args: PutStorageLensConfigurationTaggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutStorageLensConfigurationTaggingCommandOutput) => void), - cb?: (err: any, data?: PutStorageLensConfigurationTaggingCommandOutput) => void - ): Promise | void { - const command = new PutStorageLensConfigurationTaggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Submits an updated route configuration for a Multi-Region Access Point. This API operation updates the - * routing status for the specified Regions from active to passive, or from passive to active. - * A value of 0 indicates a passive status, which means that traffic won't be - * routed to the specified Region. A value of 100 indicates an active status, - * which means that traffic will be routed to the specified Region. At least one Region must be active at all times.

- *

When the routing configuration is changed, any in-progress operations (uploads, copies, - * deletes, and so on) to formerly active Regions will continue to run to their final - * completion state (success or failure). The routing configurations of any Regions that - * aren’t specified remain unchanged.

- * - *

Updated routing configurations might not be immediately applied. It can take up to 2 - * minutes for your changes to take effect.

- *
- *

To submit routing control changes and failover requests, use the Amazon S3 failover control - * infrastructure endpoints in these five Amazon Web Services Regions:

- *
    - *
  • - *

    - * us-east-1 - *

    - *
  • - *
  • - *

    - * us-west-2 - *

    - *
  • - *
  • - *

    - * ap-southeast-2 - *

    - *
  • - *
  • - *

    - * ap-northeast-1 - *

    - *
  • - *
  • - *

    - * eu-west-1 - *

    - *
  • - *
- * - *

Your Amazon S3 bucket does not need to be in these five Regions.

- *
- */ - public submitMultiRegionAccessPointRoutes( + + /** + * @see {@link SubmitMultiRegionAccessPointRoutesCommand} + */ + submitMultiRegionAccessPointRoutes( args: SubmitMultiRegionAccessPointRoutesCommandInput, options?: __HttpHandlerOptions ): Promise; - public submitMultiRegionAccessPointRoutes( + submitMultiRegionAccessPointRoutes( args: SubmitMultiRegionAccessPointRoutesCommandInput, cb: (err: any, data?: SubmitMultiRegionAccessPointRoutesCommandOutput) => void ): void; - public submitMultiRegionAccessPointRoutes( + submitMultiRegionAccessPointRoutes( args: SubmitMultiRegionAccessPointRoutesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubmitMultiRegionAccessPointRoutesCommandOutput) => void ): void; - public submitMultiRegionAccessPointRoutes( - args: SubmitMultiRegionAccessPointRoutesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SubmitMultiRegionAccessPointRoutesCommandOutput) => void), - cb?: (err: any, data?: SubmitMultiRegionAccessPointRoutesCommandOutput) => void - ): Promise | void { - const command = new SubmitMultiRegionAccessPointRoutesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

- *

- *

Related actions include:

- * - */ - public updateJobPriority( + + /** + * @see {@link UpdateJobPriorityCommand} + */ + updateJobPriority( args: UpdateJobPriorityCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateJobPriority( + updateJobPriority( args: UpdateJobPriorityCommandInput, cb: (err: any, data?: UpdateJobPriorityCommandOutput) => void ): void; - public updateJobPriority( + updateJobPriority( args: UpdateJobPriorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateJobPriorityCommandOutput) => void ): void; - public updateJobPriority( - args: UpdateJobPriorityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateJobPriorityCommandOutput) => void), - cb?: (err: any, data?: UpdateJobPriorityCommandOutput) => void - ): Promise | void { - const command = new UpdateJobPriorityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the status for the specified job. Use this action to confirm that you want to - * run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

- *

- *

Related actions include:

- * - */ - public updateJobStatus( + + /** + * @see {@link UpdateJobStatusCommand} + */ + updateJobStatus( args: UpdateJobStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateJobStatus( - args: UpdateJobStatusCommandInput, - cb: (err: any, data?: UpdateJobStatusCommandOutput) => void - ): void; - public updateJobStatus( + updateJobStatus(args: UpdateJobStatusCommandInput, cb: (err: any, data?: UpdateJobStatusCommandOutput) => void): void; + updateJobStatus( args: UpdateJobStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateJobStatusCommandOutput) => void ): void; - public updateJobStatus( - args: UpdateJobStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateJobStatusCommandOutput) => void), - cb?: (err: any, data?: UpdateJobStatusCommandOutput) => void - ): Promise | void { - const command = new UpdateJobStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Web Services S3 Control provides access to Amazon S3 control plane actions.

+ */ +export class S3Control extends S3ControlClient implements S3Control {} +createAggregatedClient(commands, S3Control); diff --git a/clients/client-s3/src/S3.ts b/clients/client-s3/src/S3.ts index 52af7133d17c..1b1bf992c37a 100644 --- a/clients/client-s3/src/S3.ts +++ b/clients/client-s3/src/S3.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -430,8000 +431,1555 @@ import { WriteGetObjectResponseCommandInput, WriteGetObjectResponseCommandOutput, } from "./commands/WriteGetObjectResponseCommand"; -import { S3Client } from "./S3Client"; +import { S3Client, S3ClientConfig } from "./S3Client"; -/** - * @public - *

- */ -export class S3 extends S3Client { +const commands = { + AbortMultipartUploadCommand, + CompleteMultipartUploadCommand, + CopyObjectCommand, + CreateBucketCommand, + CreateMultipartUploadCommand, + DeleteBucketCommand, + DeleteBucketAnalyticsConfigurationCommand, + DeleteBucketCorsCommand, + DeleteBucketEncryptionCommand, + DeleteBucketIntelligentTieringConfigurationCommand, + DeleteBucketInventoryConfigurationCommand, + DeleteBucketLifecycleCommand, + DeleteBucketMetricsConfigurationCommand, + DeleteBucketOwnershipControlsCommand, + DeleteBucketPolicyCommand, + DeleteBucketReplicationCommand, + DeleteBucketTaggingCommand, + DeleteBucketWebsiteCommand, + DeleteObjectCommand, + DeleteObjectsCommand, + DeleteObjectTaggingCommand, + DeletePublicAccessBlockCommand, + GetBucketAccelerateConfigurationCommand, + GetBucketAclCommand, + GetBucketAnalyticsConfigurationCommand, + GetBucketCorsCommand, + GetBucketEncryptionCommand, + GetBucketIntelligentTieringConfigurationCommand, + GetBucketInventoryConfigurationCommand, + GetBucketLifecycleConfigurationCommand, + GetBucketLocationCommand, + GetBucketLoggingCommand, + GetBucketMetricsConfigurationCommand, + GetBucketNotificationConfigurationCommand, + GetBucketOwnershipControlsCommand, + GetBucketPolicyCommand, + GetBucketPolicyStatusCommand, + GetBucketReplicationCommand, + GetBucketRequestPaymentCommand, + GetBucketTaggingCommand, + GetBucketVersioningCommand, + GetBucketWebsiteCommand, + GetObjectCommand, + GetObjectAclCommand, + GetObjectAttributesCommand, + GetObjectLegalHoldCommand, + GetObjectLockConfigurationCommand, + GetObjectRetentionCommand, + GetObjectTaggingCommand, + GetObjectTorrentCommand, + GetPublicAccessBlockCommand, + HeadBucketCommand, + HeadObjectCommand, + ListBucketAnalyticsConfigurationsCommand, + ListBucketIntelligentTieringConfigurationsCommand, + ListBucketInventoryConfigurationsCommand, + ListBucketMetricsConfigurationsCommand, + ListBucketsCommand, + ListMultipartUploadsCommand, + ListObjectsCommand, + ListObjectsV2Command, + ListObjectVersionsCommand, + ListPartsCommand, + PutBucketAccelerateConfigurationCommand, + PutBucketAclCommand, + PutBucketAnalyticsConfigurationCommand, + PutBucketCorsCommand, + PutBucketEncryptionCommand, + PutBucketIntelligentTieringConfigurationCommand, + PutBucketInventoryConfigurationCommand, + PutBucketLifecycleConfigurationCommand, + PutBucketLoggingCommand, + PutBucketMetricsConfigurationCommand, + PutBucketNotificationConfigurationCommand, + PutBucketOwnershipControlsCommand, + PutBucketPolicyCommand, + PutBucketReplicationCommand, + PutBucketRequestPaymentCommand, + PutBucketTaggingCommand, + PutBucketVersioningCommand, + PutBucketWebsiteCommand, + PutObjectCommand, + PutObjectAclCommand, + PutObjectLegalHoldCommand, + PutObjectLockConfigurationCommand, + PutObjectRetentionCommand, + PutObjectTaggingCommand, + PutPublicAccessBlockCommand, + RestoreObjectCommand, + SelectObjectContentCommand, + UploadPartCommand, + UploadPartCopyCommand, + WriteGetObjectResponseCommand, +}; + +export interface S3 { /** - * @public - *

This action aborts a multipart upload. After a multipart upload is aborted, no - * additional parts can be uploaded using that upload ID. The storage consumed by any - * previously uploaded parts will be freed. However, if any part uploads are currently in - * progress, those part uploads might or might not succeed. As a result, it might be necessary - * to abort a given multipart upload multiple times in order to completely free all storage - * consumed by all parts.

- *

To verify that all parts have been removed, so you don't get charged for the part - * storage, you should call the ListParts action and ensure that - * the parts list is empty.

- *

For information about permissions required to use the multipart upload, see Multipart Upload - * and Permissions.

- *

The following operations are related to AbortMultipartUpload:

- * + * @see {@link AbortMultipartUploadCommand} */ - public abortMultipartUpload( + abortMultipartUpload( args: AbortMultipartUploadCommandInput, options?: __HttpHandlerOptions ): Promise; - public abortMultipartUpload( + abortMultipartUpload( args: AbortMultipartUploadCommandInput, cb: (err: any, data?: AbortMultipartUploadCommandOutput) => void ): void; - public abortMultipartUpload( + abortMultipartUpload( args: AbortMultipartUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AbortMultipartUploadCommandOutput) => void ): void; - public abortMultipartUpload( - args: AbortMultipartUploadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AbortMultipartUploadCommandOutput) => void), - cb?: (err: any, data?: AbortMultipartUploadCommandOutput) => void - ): Promise | void { - const command = new AbortMultipartUploadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Completes a multipart upload by assembling previously uploaded parts.

- *

You first initiate the multipart upload and then upload all parts using the UploadPart - * operation. After successfully uploading all relevant parts of an upload, you call this - * action to complete the upload. Upon receiving this request, Amazon S3 concatenates all the - * parts in ascending order by part number to create a new object. In the Complete Multipart - * Upload request, you must provide the parts list. You must ensure that the parts list is - * complete. This action concatenates the parts that you provide in the list. For each part in - * the list, you must provide the part number and the ETag value, returned after - * that part was uploaded.

- *

Processing of a Complete Multipart Upload request could take several minutes to - * complete. After Amazon S3 begins processing the request, it sends an HTTP response header that - * specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white - * space characters to keep the connection from timing out. A request could fail after the - * initial 200 OK response has been sent. This means that a 200 OK response can - * contain either a success or an error. If you call the S3 API directly, make sure to design - * your application to parse the contents of the response and handle it appropriately. If you - * use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply - * error handling per your configuration settings (including automatically retrying the - * request as appropriate). If the condition persists, the SDKs throws an exception (or, for - * the SDKs that don't use exceptions, they return the error).

- *

Note that if CompleteMultipartUpload fails, applications should be prepared - * to retry the failed requests. For more information, see Amazon S3 Error Best - * Practices.

- * - *

You cannot use Content-Type: application/x-www-form-urlencoded with - * Complete Multipart Upload requests. Also, if you do not provide a - * Content-Type header, CompleteMultipartUpload returns a 200 - * OK response.

- *
- *

For more information about multipart uploads, see Uploading Objects Using Multipart - * Upload.

- *

For information about permissions required to use the multipart upload API, see Multipart Upload - * and Permissions.

- *

- * CompleteMultipartUpload has the following special errors:

- *
    - *
  • - *

    Error code: EntityTooSmall - *

    - *
      - *
    • - *

      Description: Your proposed upload is smaller than the minimum allowed object - * size. Each part must be at least 5 MB in size, except the last part.

      - *
    • - *
    • - *

      400 Bad Request

      - *
    • - *
    - *
  • - *
  • - *

    Error code: InvalidPart - *

    - *
      - *
    • - *

      Description: One or more of the specified parts could not be found. The part - * might not have been uploaded, or the specified entity tag might not have - * matched the part's entity tag.

      - *
    • - *
    • - *

      400 Bad Request

      - *
    • - *
    - *
  • - *
  • - *

    Error code: InvalidPartOrder - *

    - *
      - *
    • - *

      Description: The list of parts was not in ascending order. The parts list - * must be specified in order by part number.

      - *
    • - *
    • - *

      400 Bad Request

      - *
    • - *
    - *
  • - *
  • - *

    Error code: NoSuchUpload - *

    - *
      - *
    • - *

      Description: The specified multipart upload does not exist. The upload ID - * might be invalid, or the multipart upload might have been aborted or - * completed.

      - *
    • - *
    • - *

      404 Not Found

      - *
    • - *
    - *
  • - *
- *

The following operations are related to CompleteMultipartUpload:

- * + * @see {@link CompleteMultipartUploadCommand} */ - public completeMultipartUpload( + completeMultipartUpload( args: CompleteMultipartUploadCommandInput, options?: __HttpHandlerOptions ): Promise; - public completeMultipartUpload( + completeMultipartUpload( args: CompleteMultipartUploadCommandInput, cb: (err: any, data?: CompleteMultipartUploadCommandOutput) => void ): void; - public completeMultipartUpload( + completeMultipartUpload( args: CompleteMultipartUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteMultipartUploadCommandOutput) => void ): void; - public completeMultipartUpload( - args: CompleteMultipartUploadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CompleteMultipartUploadCommandOutput) => void), - cb?: (err: any, data?: CompleteMultipartUploadCommandOutput) => void - ): Promise | void { - const command = new CompleteMultipartUploadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a copy of an object that is already stored in Amazon S3.

- * - *

You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your - * object up to 5 GB in size in a single atomic action using this API. However, to copy an - * object greater than 5 GB, you must use the multipart upload Upload Part - Copy - * (UploadPartCopy) API. For more information, see Copy Object Using the - * REST Multipart Upload API.

- *
- *

All copy requests must be authenticated. Additionally, you must have - * read access to the source object and write - * access to the destination bucket. For more information, see REST Authentication. Both the - * Region that you want to copy the object from and the Region that you want to copy the - * object to must be enabled for your account.

- *

A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 - * is copying the files. If the error occurs before the copy action starts, you receive a - * standard Amazon S3 error. If the error occurs during the copy operation, the error response is - * embedded in the 200 OK response. This means that a 200 OK - * response can contain either a success or an error. If you call the S3 API directly, make - * sure to design your application to parse the contents of the response and handle it - * appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the - * embedded error and apply error handling per your configuration settings (including - * automatically retrying the request as appropriate). If the condition persists, the SDKs - * throws an exception (or, for the SDKs that don't use exceptions, they return the - * error).

- *

If the copy is successful, you receive a response with information about the copied - * object.

- * - *

If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, - * it would not contain the content-length, and you would need to read the entire - * body.

- *
- *

The copy request charge is based on the storage class and Region that you specify for - * the destination object. For pricing information, see Amazon S3 pricing.

- * - *

Amazon S3 transfer acceleration does not support cross-Region copies. If you request a - * cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad - * Request error. For more information, see Transfer - * Acceleration.

- *
- *

- * Metadata - *

- *

When copying an object, you can preserve all metadata (default) or specify new metadata. - * However, the ACL is not preserved and is set to private for the user making the request. To - * override the default ACL setting, specify a new ACL when generating a copy request. For - * more information, see Using ACLs.

- *

To specify whether you want the object metadata copied from the source object or - * replaced with metadata provided in the request, you can optionally add the - * x-amz-metadata-directive header. When you grant permissions, you can use - * the s3:x-amz-metadata-directive condition key to enforce certain metadata - * behavior when objects are uploaded. For more information, see Specifying Conditions in a - * Policy in the Amazon S3 User Guide. For a complete list of - * Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for - * Amazon S3.

- * - *

- * x-amz-website-redirect-location is unique to each object and must be - * specified in the request headers to copy the value.

- *
- *

- * x-amz-copy-source-if Headers - *

- *

To only copy an object under certain conditions, such as whether the Etag - * matches or whether the object was modified before or after a specified date, use the - * following request parameters:

- *
    - *
  • - *

    - * x-amz-copy-source-if-match - *

    - *
  • - *
  • - *

    - * x-amz-copy-source-if-none-match - *

    - *
  • - *
  • - *

    - * x-amz-copy-source-if-unmodified-since - *

    - *
  • - *
  • - *

    - * x-amz-copy-source-if-modified-since - *

    - *
  • - *
- *

If both the x-amz-copy-source-if-match and - * x-amz-copy-source-if-unmodified-since headers are present in the request - * and evaluate as follows, Amazon S3 returns 200 OK and copies the data:

- *
    - *
  • - *

    - * x-amz-copy-source-if-match condition evaluates to true

    - *
  • - *
  • - *

    - * x-amz-copy-source-if-unmodified-since condition evaluates to - * false

    - *
  • - *
- *

If both the x-amz-copy-source-if-none-match and - * x-amz-copy-source-if-modified-since headers are present in the request and - * evaluate as follows, Amazon S3 returns the 412 Precondition Failed response - * code:

- *
    - *
  • - *

    - * x-amz-copy-source-if-none-match condition evaluates to false

    - *
  • - *
  • - *

    - * x-amz-copy-source-if-modified-since condition evaluates to - * true

    - *
  • - *
- * - *

All headers with the x-amz- prefix, including - * x-amz-copy-source, must be signed.

- *
- *

- * Server-side encryption - *

- *

Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When - * copying an object, if you don't specify encryption information in your copy request, the - * encryption setting of the target object is set to the default encryption configuration of - * the destination bucket. By default, all buckets have a base level of encryption - * configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the - * destination bucket has a default encryption configuration that uses server-side encryption - * with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C), - * Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the target - * object copy. When you perform a CopyObject operation, if you want to use a different type - * of encryption setting for the target object, you can use other appropriate - * encryption-related headers to encrypt the target object with a KMS key, an Amazon S3 managed - * key, or a customer-provided key. With server-side encryption, Amazon S3 encrypts your data as it - * writes it to disks in its data centers and decrypts the data when you access it. If the - * encryption setting in your request is different from the default encryption configuration - * of the destination bucket, the encryption setting in your request takes precedence. If the - * source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary - * encryption information in your request so that Amazon S3 can decrypt the object for copying. For - * more information about server-side encryption, see Using Server-Side - * Encryption.

- *

If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For - * more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

- *

- * Access Control List (ACL)-Specific Request - * Headers - *

- *

When copying an object, you can optionally use headers to grant ACL-based permissions. - * By default, all objects are private. Only the owner has full access control. When adding a - * new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups - * defined by Amazon S3. These permissions are then added to the ACL on the object. For more - * information, see Access Control List (ACL) Overview and Managing ACLs Using the REST - * API.

- *

If the bucket that you're copying objects to uses the bucket owner enforced setting for - * S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use - * this setting only accept PUT requests that don't specify an ACL or PUT requests that - * specify bucket owner full control ACLs, such as the bucket-owner-full-control - * canned ACL or an equivalent form of this ACL expressed in the XML format.

- *

For more information, see Controlling ownership of - * objects and disabling ACLs in the Amazon S3 User Guide.

- * - *

If your bucket uses the bucket owner enforced setting for Object Ownership, all - * objects written to the bucket by any account will be owned by the bucket owner.

- *
- *

- * Checksums - *

- *

When copying an object, if it has a checksum, that checksum will be copied to the new - * object by default. When you copy the object over, you may optionally specify a different - * checksum algorithm to use with the x-amz-checksum-algorithm header.

- *

- * Storage Class Options - *

- *

You can use the CopyObject action to change the storage class of an object - * that is already stored in Amazon S3 using the StorageClass parameter. For more - * information, see Storage Classes in the - * Amazon S3 User Guide.

- *

- * Versioning - *

- *

By default, x-amz-copy-source identifies the current version of an object - * to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was - * deleted. To copy a different version, use the versionId subresource.

- *

If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for - * the object being copied. This version ID is different from the version ID of the source - * object. Amazon S3 returns the version ID of the copied object in the - * x-amz-version-id response header in the response.

- *

If you do not enable versioning or suspend it on the target bucket, the version ID that - * Amazon S3 generates is always null.

- *

If the source object's storage class is GLACIER, you must restore a copy of this object - * before you can use it as a source object for the copy operation. For more information, see - * RestoreObject.

- *

The following operations are related to CopyObject:

- * - *

For more information, see Copying Objects.

+ * @see {@link CopyObjectCommand} */ - public copyObject(args: CopyObjectCommandInput, options?: __HttpHandlerOptions): Promise; - public copyObject(args: CopyObjectCommandInput, cb: (err: any, data?: CopyObjectCommandOutput) => void): void; - public copyObject( + copyObject(args: CopyObjectCommandInput, options?: __HttpHandlerOptions): Promise; + copyObject(args: CopyObjectCommandInput, cb: (err: any, data?: CopyObjectCommandOutput) => void): void; + copyObject( args: CopyObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyObjectCommandOutput) => void ): void; - public copyObject( - args: CopyObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopyObjectCommandOutput) => void), - cb?: (err: any, data?: CopyObjectCommandOutput) => void - ): Promise | void { - const command = new CopyObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a - * valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to - * create buckets. By creating the bucket, you become the bucket owner.

- *

Not every string is an acceptable bucket name. For information about bucket naming - * restrictions, see Bucket naming - * rules.

- *

If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.

- *

By default, the bucket is created in the US East (N. Virginia) Region. You can - * optionally specify a Region in the request body. You might choose a Region to optimize - * latency, minimize costs, or address regulatory requirements. For example, if you reside in - * Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) - * Region. For more information, see Accessing a - * bucket.

- * - *

If you send your create bucket request to the s3.amazonaws.com endpoint, - * the request goes to the us-east-1 Region. Accordingly, the signature calculations in - * Signature Version 4 must use us-east-1 as the Region, even if the location constraint in - * the request specifies another Region where the bucket is to be created. If you create a - * bucket in a Region other than US East (N. Virginia), your application must be able to - * handle 307 redirect. For more information, see Virtual hosting of - * buckets.

- *
- *

- * Access control lists (ACLs) - *

- *

When creating a bucket using this operation, you can optionally configure the bucket ACL - * to specify the accounts or groups that should be granted specific permissions on the - * bucket.

- * - *

If your CreateBucket request sets bucket owner enforced for S3 Object Ownership and - * specifies a bucket ACL that provides access to an external Amazon Web Services account, your request - * fails with a 400 error and returns the - * InvalidBucketAclWithObjectOwnership error code. For more information, - * see Controlling object - * ownership in the Amazon S3 User Guide.

- *
- *

There are two ways to grant the appropriate permissions using the request - * headers.

- *
    - *
  • - *

    Specify a canned ACL using the x-amz-acl request header. Amazon S3 - * supports a set of predefined ACLs, known as canned ACLs. Each - * canned ACL has a predefined set of grantees and permissions. For more information, - * see Canned ACL.

    - *
  • - *
  • - *

    Specify access permissions explicitly using the x-amz-grant-read, - * x-amz-grant-write, x-amz-grant-read-acp, - * x-amz-grant-write-acp, and x-amz-grant-full-control - * headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For - * more information, see Access control list (ACL) - * overview.

    - *

    You specify each grantee as a type=value pair, where the type is one of the - * following:

    - *
      - *
    • - *

      - * id – if the value specified is the canonical user ID of an - * Amazon Web Services account

      - *
    • - *
    • - *

      - * uri – if you are granting permissions to a predefined - * group

      - *
    • - *
    • - *

      - * emailAddress – if the value specified is the email address of - * an Amazon Web Services account

      - * - *

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      - *
        - *
      • - *

        US East (N. Virginia)

        - *
      • - *
      • - *

        US West (N. California)

        - *
      • - *
      • - *

        US West (Oregon)

        - *
      • - *
      • - *

        Asia Pacific (Singapore)

        - *
      • - *
      • - *

        Asia Pacific (Sydney)

        - *
      • - *
      • - *

        Asia Pacific (Tokyo)

        - *
      • - *
      • - *

        Europe (Ireland)

        - *
      • - *
      • - *

        South America (São Paulo)

        - *
      • - *
      - *

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      - *
      - *
    • - *
    - *

    For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

    - *

    - * x-amz-grant-read: id="11112222333", id="444455556666" - *

    - *
  • - *
- * - *

You can use either a canned ACL or specify access permissions explicitly. You cannot - * do both.

- *
- *

- * Permissions - *

- *

In addition to s3:CreateBucket, the following permissions are required when - * your CreateBucket includes specific headers:

- *
    - *
  • - *

    - * ACLs - If your CreateBucket request - * specifies ACL permissions and the ACL is public-read, public-read-write, - * authenticated-read, or if you specify access permissions explicitly through any other - * ACL, both s3:CreateBucket and s3:PutBucketAcl permissions - * are needed. If the ACL the CreateBucket request is private or doesn't - * specify any ACLs, only s3:CreateBucket permission is needed.

    - *
  • - *
  • - *

    - * Object Lock - If - * ObjectLockEnabledForBucket is set to true in your - * CreateBucket request, - * s3:PutBucketObjectLockConfiguration and - * s3:PutBucketVersioning permissions are required.

    - *
  • - *
  • - *

    - * S3 Object Ownership - If your CreateBucket - * request includes the the x-amz-object-ownership header, - * s3:PutBucketOwnershipControls permission is required.

    - *
  • - *
- *

The following operations are related to CreateBucket:

- * + * @see {@link CreateBucketCommand} */ - public createBucket( - args: CreateBucketCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createBucket(args: CreateBucketCommandInput, cb: (err: any, data?: CreateBucketCommandOutput) => void): void; - public createBucket( + createBucket(args: CreateBucketCommandInput, options?: __HttpHandlerOptions): Promise; + createBucket(args: CreateBucketCommandInput, cb: (err: any, data?: CreateBucketCommandOutput) => void): void; + createBucket( args: CreateBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBucketCommandOutput) => void ): void; - public createBucket( - args: CreateBucketCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBucketCommandOutput) => void), - cb?: (err: any, data?: CreateBucketCommandOutput) => void - ): Promise | void { - const command = new CreateBucketCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This action initiates a multipart upload and returns an upload ID. This upload ID is - * used to associate all of the parts in the specific multipart upload. You specify this - * upload ID in each of your subsequent upload part requests (see UploadPart). You also include this - * upload ID in the final request to either complete or abort the multipart upload - * request.

- *

For more information about multipart uploads, see Multipart Upload Overview.

- *

If you have configured a lifecycle rule to abort incomplete multipart uploads, the - * upload must complete within the number of days specified in the bucket lifecycle - * configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort - * action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

- *

For information about the permissions required to use the multipart upload API, see - * Multipart - * Upload and Permissions.

- *

For request signing, multipart upload is just a series of regular requests. You initiate - * a multipart upload, send one or more requests to upload parts, and then complete the - * multipart upload process. You sign each request individually. There is nothing special - * about signing multipart upload requests. For more information about signing, see Authenticating Requests (Amazon Web Services Signature Version 4).

- * - *

After you initiate a multipart upload and upload one or more parts, to stop being - * charged for storing the uploaded parts, you must either complete or abort the multipart - * upload. Amazon S3 frees up the space used to store the parts and stop charging you for - * storing them only after you either complete or abort a multipart upload.

- *
- *

Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it - * writes it to disks in its data centers and decrypts it when you access it. Amazon S3 - * automatically encrypts all new objects that are uploaded to an S3 bucket. When doing a - * multipart upload, if you don't specify encryption information in your request, the - * encryption setting of the uploaded parts is set to the default encryption configuration of - * the destination bucket. By default, all buckets have a base level of encryption - * configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the - * destination bucket has a default encryption configuration that uses server-side encryption - * with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C), - * Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the uploaded - * parts. When you perform a CreateMultipartUpload operation, if you want to use a different - * type of encryption setting for the uploaded parts, you can request that Amazon S3 encrypts the - * object with a KMS key, an Amazon S3 managed key, or a customer-provided key. If the encryption - * setting in your request is different from the default encryption configuration of the - * destination bucket, the encryption setting in your request takes precedence. If you choose - * to provide your own encryption key, the request headers you provide in UploadPart - * and UploadPartCopy requests must - * match the headers you used in the request to initiate the upload by using - * CreateMultipartUpload. you can request that Amazon S3 - * save the uploaded parts encrypted with server-side encryption with an Amazon S3 managed key - * (SSE-S3), an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key - * (SSE-C).

- *

To perform a multipart upload with encryption by using an Amazon Web Services KMS key, the requester - * must have permission to the kms:Decrypt and kms:GenerateDataKey* - * actions on the key. These permissions are required because Amazon S3 must decrypt and read data - * from the encrypted file parts before it completes the multipart upload. For more - * information, see Multipart upload API - * and permissions and Protecting data using - * server-side encryption with Amazon Web Services KMS in the - * Amazon S3 User Guide.

- *

If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, - * then you must have these permissions on the key policy. If your IAM user or role belongs - * to a different account than the key, then you must have the permissions on both the key - * policy and your IAM user or role.

- *

For more information, see Protecting Data Using Server-Side - * Encryption.

- *
- *
Access Permissions
- *
- *

When copying an object, you can optionally specify the accounts or groups that - * should be granted specific permissions on the new object. There are two ways to - * grant the permissions using the request headers:

- *
    - *
  • - *

    Specify a canned ACL with the x-amz-acl request header. For - * more information, see Canned - * ACL.

    - *
  • - *
  • - *

    Specify access permissions explicitly with the - * x-amz-grant-read, x-amz-grant-read-acp, - * x-amz-grant-write-acp, and - * x-amz-grant-full-control headers. These parameters map to - * the set of permissions that Amazon S3 supports in an ACL. For more information, - * see Access Control List (ACL) Overview.

    - *
  • - *
- *

You can use either a canned ACL or specify access permissions explicitly. You - * cannot do both.

- *
- *
Server-Side- Encryption-Specific Request Headers
- *
- *

Amazon S3 encrypts data - * by using server-side encryption with an Amazon S3 managed key (SSE-S3) by default. Server-side encryption is for data encryption at rest. Amazon S3 encrypts - * your data as it writes it to disks in its data centers and decrypts it when you - * access it. You can request that Amazon S3 encrypts - * data at rest by using server-side encryption with other key options. The option you use depends on - * whether you want to use KMS keys (SSE-KMS) or provide your own encryption keys - * (SSE-C).

- *
    - *
  • - *

    Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key - * (aws/s3) and KMS customer managed keys stored in Key Management Service (KMS) – If you - * want Amazon Web Services to manage the keys used to encrypt data, specify the following - * headers in the request.

    - *
      - *
    • - *

      - * x-amz-server-side-encryption - *

      - *
    • - *
    • - *

      - * x-amz-server-side-encryption-aws-kms-key-id - *

      - *
    • - *
    • - *

      - * x-amz-server-side-encryption-context - *

      - *
    • - *
    - * - *

    If you specify x-amz-server-side-encryption:aws:kms, but - * don't provide x-amz-server-side-encryption-aws-kms-key-id, - * Amazon S3 uses the Amazon Web Services managed key (aws/s3 key) in KMS to - * protect the data.

    - *
    - * - *

    All GET and PUT requests for an object protected - * by KMS fail if you don't make them by using Secure Sockets Layer (SSL), - * Transport Layer Security (TLS), or Signature Version 4.

    - *
    - *

    For more information about server-side encryption with KMS keys - * (SSE-KMS), see Protecting Data - * Using Server-Side Encryption with KMS keys.

    - *
  • - *
  • - *

    Use customer-provided encryption keys (SSE-C) – If you want to manage - * your own encryption keys, provide all the following headers in the - * request.

    - *
      - *
    • - *

      - * x-amz-server-side-encryption-customer-algorithm - *

      - *
    • - *
    • - *

      - * x-amz-server-side-encryption-customer-key - *

      - *
    • - *
    • - *

      - * x-amz-server-side-encryption-customer-key-MD5 - *

      - *
    • - *
    - *

    For more information about server-side encryption with customer-provided - * encryption keys (SSE-C), see - * Protecting data using server-side encryption with customer-provided - * encryption keys (SSE-C).

    - *
  • - *
- *
- *
Access-Control-List (ACL)-Specific Request Headers
- *
- *

You also can use the following access control–related headers with this - * operation. By default, all objects are private. Only the owner has full access - * control. When adding a new object, you can grant permissions to individual - * Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then - * added to the access control list (ACL) on the object. For more information, see - * Using ACLs. With this operation, you can grant access permissions - * using one of the following two methods:

- *
    - *
  • - *

    Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of - * predefined ACLs, known as canned ACLs. Each canned ACL - * has a predefined set of grantees and permissions. For more information, see - * Canned - * ACL.

    - *
  • - *
  • - *

    Specify access permissions explicitly — To explicitly grant access - * permissions to specific Amazon Web Services accounts or groups, use the following headers. - * Each header maps to specific permissions that Amazon S3 supports in an ACL. For - * more information, see Access Control List (ACL) - * Overview. In the header, you specify a list of grantees who get - * the specific permission. To grant permissions explicitly, use:

    - *
      - *
    • - *

      - * x-amz-grant-read - *

      - *
    • - *
    • - *

      - * x-amz-grant-write - *

      - *
    • - *
    • - *

      - * x-amz-grant-read-acp - *

      - *
    • - *
    • - *

      - * x-amz-grant-write-acp - *

      - *
    • - *
    • - *

      - * x-amz-grant-full-control - *

      - *
    • - *
    - *

    You specify each grantee as a type=value pair, where the type is one of - * the following:

    - *
      - *
    • - *

      - * id – if the value specified is the canonical user ID - * of an Amazon Web Services account

      - *
    • - *
    • - *

      - * uri – if you are granting permissions to a predefined - * group

      - *
    • - *
    • - *

      - * emailAddress – if the value specified is the email - * address of an Amazon Web Services account

      - * - *

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      - *
        - *
      • - *

        US East (N. Virginia)

        - *
      • - *
      • - *

        US West (N. California)

        - *
      • - *
      • - *

        US West (Oregon)

        - *
      • - *
      • - *

        Asia Pacific (Singapore)

        - *
      • - *
      • - *

        Asia Pacific (Sydney)

        - *
      • - *
      • - *

        Asia Pacific (Tokyo)

        - *
      • - *
      • - *

        Europe (Ireland)

        - *
      • - *
      • - *

        South America (São Paulo)

        - *
      • - *
      - *

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      - *
      - *
    • - *
    - *

    For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

    - *

    - * x-amz-grant-read: id="11112222333", id="444455556666" - *

    - *
  • - *
- *
- *
- *

The following operations are related to CreateMultipartUpload:

- * + * @see {@link CreateMultipartUploadCommand} */ - public createMultipartUpload( + createMultipartUpload( args: CreateMultipartUploadCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMultipartUpload( + createMultipartUpload( args: CreateMultipartUploadCommandInput, cb: (err: any, data?: CreateMultipartUploadCommandOutput) => void ): void; - public createMultipartUpload( + createMultipartUpload( args: CreateMultipartUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMultipartUploadCommandOutput) => void ): void; - public createMultipartUpload( - args: CreateMultipartUploadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMultipartUploadCommandOutput) => void), - cb?: (err: any, data?: CreateMultipartUploadCommandOutput) => void - ): Promise | void { - const command = new CreateMultipartUploadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the S3 bucket. All objects (including all object versions and delete markers) in - * the bucket must be deleted before the bucket itself can be deleted.

- *

- * Related Resources - *

- * + * @see {@link DeleteBucketCommand} */ - public deleteBucket( - args: DeleteBucketCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteBucket(args: DeleteBucketCommandInput, cb: (err: any, data?: DeleteBucketCommandOutput) => void): void; - public deleteBucket( + deleteBucket(args: DeleteBucketCommandInput, options?: __HttpHandlerOptions): Promise; + deleteBucket(args: DeleteBucketCommandInput, cb: (err: any, data?: DeleteBucketCommandOutput) => void): void; + deleteBucket( args: DeleteBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketCommandOutput) => void ): void; - public deleteBucket( - args: DeleteBucketCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an analytics configuration for the bucket (specified by the analytics - * configuration ID).

- *

To use this operation, you must have permissions to perform the - * s3:PutAnalyticsConfiguration action. The bucket owner has this permission - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class - * Analysis.

- *

The following operations are related to - * DeleteBucketAnalyticsConfiguration:

- * + * @see {@link DeleteBucketAnalyticsConfigurationCommand} */ - public deleteBucketAnalyticsConfiguration( + deleteBucketAnalyticsConfiguration( args: DeleteBucketAnalyticsConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketAnalyticsConfiguration( + deleteBucketAnalyticsConfiguration( args: DeleteBucketAnalyticsConfigurationCommandInput, cb: (err: any, data?: DeleteBucketAnalyticsConfigurationCommandOutput) => void ): void; - public deleteBucketAnalyticsConfiguration( + deleteBucketAnalyticsConfiguration( args: DeleteBucketAnalyticsConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketAnalyticsConfigurationCommandOutput) => void ): void; - public deleteBucketAnalyticsConfiguration( - args: DeleteBucketAnalyticsConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketAnalyticsConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketAnalyticsConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketAnalyticsConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the cors configuration information set for the bucket.

- *

To use this operation, you must have permission to perform the - * s3:PutBucketCORS action. The bucket owner has this permission by default - * and can grant this permission to others.

- *

For information about cors, see Enabling Cross-Origin Resource Sharing in - * the Amazon S3 User Guide.

- *

- * Related Resources: - *

- * + * @see {@link DeleteBucketCorsCommand} */ - public deleteBucketCors( + deleteBucketCors( args: DeleteBucketCorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketCors( + deleteBucketCors( args: DeleteBucketCorsCommandInput, cb: (err: any, data?: DeleteBucketCorsCommandOutput) => void ): void; - public deleteBucketCors( + deleteBucketCors( args: DeleteBucketCorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketCorsCommandOutput) => void ): void; - public deleteBucketCors( - args: DeleteBucketCorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketCorsCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketCorsCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketCorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This implementation of the DELETE action resets the default encryption for the - * bucket as server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the - * bucket default encryption feature, see Amazon S3 Bucket Default Encryption - * in the Amazon S3 User Guide.

- *

To use this operation, you must have permissions to perform the - * s3:PutEncryptionConfiguration action. The bucket owner has this permission - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to your Amazon S3 Resources in the - * Amazon S3 User Guide.

- *

- * Related Resources - *

- * + * @see {@link DeleteBucketEncryptionCommand} */ - public deleteBucketEncryption( + deleteBucketEncryption( args: DeleteBucketEncryptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketEncryption( + deleteBucketEncryption( args: DeleteBucketEncryptionCommandInput, cb: (err: any, data?: DeleteBucketEncryptionCommandOutput) => void ): void; - public deleteBucketEncryption( + deleteBucketEncryption( args: DeleteBucketEncryptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketEncryptionCommandOutput) => void ): void; - public deleteBucketEncryption( - args: DeleteBucketEncryptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketEncryptionCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketEncryptionCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketEncryptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the S3 Intelligent-Tiering configuration from the specified bucket.

- *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

- *

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

- *

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

- *

Operations related to DeleteBucketIntelligentTieringConfiguration include:

- * + * @see {@link DeleteBucketIntelligentTieringConfigurationCommand} */ - public deleteBucketIntelligentTieringConfiguration( + deleteBucketIntelligentTieringConfiguration( args: DeleteBucketIntelligentTieringConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketIntelligentTieringConfiguration( + deleteBucketIntelligentTieringConfiguration( args: DeleteBucketIntelligentTieringConfigurationCommandInput, cb: (err: any, data?: DeleteBucketIntelligentTieringConfigurationCommandOutput) => void ): void; - public deleteBucketIntelligentTieringConfiguration( + deleteBucketIntelligentTieringConfiguration( args: DeleteBucketIntelligentTieringConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketIntelligentTieringConfigurationCommandOutput) => void ): void; - public deleteBucketIntelligentTieringConfiguration( - args: DeleteBucketIntelligentTieringConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteBucketIntelligentTieringConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketIntelligentTieringConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketIntelligentTieringConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an inventory configuration (identified by the inventory ID) from the - * bucket.

- *

To use this operation, you must have permissions to perform the - * s3:PutInventoryConfiguration action. The bucket owner has this permission - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

- *

Operations related to DeleteBucketInventoryConfiguration include:

- * + * @see {@link DeleteBucketInventoryConfigurationCommand} */ - public deleteBucketInventoryConfiguration( + deleteBucketInventoryConfiguration( args: DeleteBucketInventoryConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketInventoryConfiguration( + deleteBucketInventoryConfiguration( args: DeleteBucketInventoryConfigurationCommandInput, cb: (err: any, data?: DeleteBucketInventoryConfigurationCommandOutput) => void ): void; - public deleteBucketInventoryConfiguration( + deleteBucketInventoryConfiguration( args: DeleteBucketInventoryConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketInventoryConfigurationCommandOutput) => void ): void; - public deleteBucketInventoryConfiguration( - args: DeleteBucketInventoryConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketInventoryConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketInventoryConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketInventoryConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the - * lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your - * objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of - * rules contained in the deleted lifecycle configuration.

- *

To use this operation, you must have permission to perform the - * s3:PutLifecycleConfiguration action. By default, the bucket owner has this - * permission and the bucket owner can grant this permission to others.

- *

There is usually some time lag before lifecycle configuration deletion is fully - * propagated to all the Amazon S3 systems.

- *

For more information about the object expiration, see Elements to Describe Lifecycle Actions.

- *

Related actions include:

- * + * @see {@link DeleteBucketLifecycleCommand} */ - public deleteBucketLifecycle( + deleteBucketLifecycle( args: DeleteBucketLifecycleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketLifecycle( + deleteBucketLifecycle( args: DeleteBucketLifecycleCommandInput, cb: (err: any, data?: DeleteBucketLifecycleCommandOutput) => void ): void; - public deleteBucketLifecycle( + deleteBucketLifecycle( args: DeleteBucketLifecycleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketLifecycleCommandOutput) => void ): void; - public deleteBucketLifecycle( - args: DeleteBucketLifecycleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketLifecycleCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketLifecycleCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketLifecycleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the - * metrics configuration ID) from the bucket. Note that this doesn't include the daily storage - * metrics.

- *

To use this operation, you must have permissions to perform the - * s3:PutMetricsConfiguration action. The bucket owner has this permission by - * default. The bucket owner can grant this permission to others. For more information about - * permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with - * Amazon CloudWatch.

- *

The following operations are related to - * DeleteBucketMetricsConfiguration:

- * + * @see {@link DeleteBucketMetricsConfigurationCommand} */ - public deleteBucketMetricsConfiguration( + deleteBucketMetricsConfiguration( args: DeleteBucketMetricsConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketMetricsConfiguration( + deleteBucketMetricsConfiguration( args: DeleteBucketMetricsConfigurationCommandInput, cb: (err: any, data?: DeleteBucketMetricsConfigurationCommandOutput) => void ): void; - public deleteBucketMetricsConfiguration( + deleteBucketMetricsConfiguration( args: DeleteBucketMetricsConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketMetricsConfigurationCommandOutput) => void ): void; - public deleteBucketMetricsConfiguration( - args: DeleteBucketMetricsConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketMetricsConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketMetricsConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketMetricsConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes OwnershipControls for an Amazon S3 bucket. To use this operation, you - * must have the s3:PutBucketOwnershipControls permission. For more information - * about Amazon S3 permissions, see Specifying Permissions in a - * Policy.

- *

For information about Amazon S3 Object Ownership, see Using Object Ownership.

- *

The following operations are related to - * DeleteBucketOwnershipControls:

- * + * @see {@link DeleteBucketOwnershipControlsCommand} */ - public deleteBucketOwnershipControls( + deleteBucketOwnershipControls( args: DeleteBucketOwnershipControlsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketOwnershipControls( + deleteBucketOwnershipControls( args: DeleteBucketOwnershipControlsCommandInput, cb: (err: any, data?: DeleteBucketOwnershipControlsCommandOutput) => void ): void; - public deleteBucketOwnershipControls( + deleteBucketOwnershipControls( args: DeleteBucketOwnershipControlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketOwnershipControlsCommandOutput) => void ): void; - public deleteBucketOwnershipControls( - args: DeleteBucketOwnershipControlsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketOwnershipControlsCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketOwnershipControlsCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketOwnershipControlsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This implementation of the DELETE action uses the policy subresource to delete the - * policy of a specified bucket. If you are using an identity other than the root user of the - * Amazon Web Services account that owns the bucket, the calling identity must have the - * DeleteBucketPolicy permissions on the specified bucket and belong to the - * bucket owner's account to use this operation.

- *

If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 - * Access Denied error. If you have the correct permissions, but you're not using an - * identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not - * Allowed error.

- * - *

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can - * always use this operation, even if the policy explicitly denies the root user the - * ability to perform this action.

- *
- *

For more information about bucket policies, see Using Bucket Policies and - * UserPolicies.

- *

The following operations are related to DeleteBucketPolicy - *

- * + * @see {@link DeleteBucketPolicyCommand} */ - public deleteBucketPolicy( + deleteBucketPolicy( args: DeleteBucketPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketPolicy( + deleteBucketPolicy( args: DeleteBucketPolicyCommandInput, cb: (err: any, data?: DeleteBucketPolicyCommandOutput) => void ): void; - public deleteBucketPolicy( + deleteBucketPolicy( args: DeleteBucketPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketPolicyCommandOutput) => void ): void; - public deleteBucketPolicy( - args: DeleteBucketPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the replication configuration from the bucket.

- *

To use this operation, you must have permissions to perform the - * s3:PutReplicationConfiguration action. The bucket owner has these - * permissions by default and can grant it to others. For more information about permissions, - * see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- * - *

It can take a while for the deletion of a replication configuration to fully - * propagate.

- *
- *

For information about replication configuration, see Replication in the - * Amazon S3 User Guide.

- *

The following operations are related to DeleteBucketReplication:

- * + * @see {@link DeleteBucketReplicationCommand} */ - public deleteBucketReplication( + deleteBucketReplication( args: DeleteBucketReplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketReplication( + deleteBucketReplication( args: DeleteBucketReplicationCommandInput, cb: (err: any, data?: DeleteBucketReplicationCommandOutput) => void ): void; - public deleteBucketReplication( + deleteBucketReplication( args: DeleteBucketReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketReplicationCommandOutput) => void ): void; - public deleteBucketReplication( - args: DeleteBucketReplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketReplicationCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketReplicationCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketReplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the tags from the bucket.

- *

To use this operation, you must have permission to perform the - * s3:PutBucketTagging action. By default, the bucket owner has this - * permission and can grant this permission to others.

- *

The following operations are related to DeleteBucketTagging:

- * + * @see {@link DeleteBucketTaggingCommand} */ - public deleteBucketTagging( + deleteBucketTagging( args: DeleteBucketTaggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketTagging( + deleteBucketTagging( args: DeleteBucketTaggingCommandInput, cb: (err: any, data?: DeleteBucketTaggingCommandOutput) => void ): void; - public deleteBucketTagging( + deleteBucketTagging( args: DeleteBucketTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketTaggingCommandOutput) => void ): void; - public deleteBucketTagging( - args: DeleteBucketTaggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketTaggingCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketTaggingCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketTaggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This action removes the website configuration for a bucket. Amazon S3 returns a 200 - * OK response upon successfully deleting a website configuration on the specified - * bucket. You will get a 200 OK response if the website configuration you are - * trying to delete does not exist on the bucket. Amazon S3 returns a 404 response if - * the bucket specified in the request does not exist.

- *

This DELETE action requires the S3:DeleteBucketWebsite permission. By - * default, only the bucket owner can delete the website configuration attached to a bucket. - * However, bucket owners can grant other users permission to delete the website configuration - * by writing a bucket policy granting them the S3:DeleteBucketWebsite - * permission.

- *

For more information about hosting websites, see Hosting Websites on Amazon S3.

- *

The following operations are related to DeleteBucketWebsite:

- * + * @see {@link DeleteBucketWebsiteCommand} */ - public deleteBucketWebsite( + deleteBucketWebsite( args: DeleteBucketWebsiteCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBucketWebsite( + deleteBucketWebsite( args: DeleteBucketWebsiteCommandInput, cb: (err: any, data?: DeleteBucketWebsiteCommandOutput) => void ): void; - public deleteBucketWebsite( + deleteBucketWebsite( args: DeleteBucketWebsiteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketWebsiteCommandOutput) => void ): void; - public deleteBucketWebsite( - args: DeleteBucketWebsiteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBucketWebsiteCommandOutput) => void), - cb?: (err: any, data?: DeleteBucketWebsiteCommandOutput) => void - ): Promise | void { - const command = new DeleteBucketWebsiteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the null version (if there is one) of an object and inserts a delete marker, - * which becomes the latest version of the object. If there isn't a null version, Amazon S3 does - * not remove any objects but will still respond that the command was successful.

- *

To remove a specific version, you must use the version Id subresource. Using this - * subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3 - * sets the response header, x-amz-delete-marker, to true.

- *

If the object you want to delete is in a bucket where the bucket versioning - * configuration is MFA Delete enabled, you must include the x-amz-mfa request - * header in the DELETE versionId request. Requests that include - * x-amz-mfa must use HTTPS.

- *

For more information about MFA Delete, see Using MFA Delete. To see sample - * requests that use versioning, see Sample - * Request.

- *

You can delete objects by explicitly calling DELETE Object or configure its lifecycle - * (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block - * users or accounts from removing or deleting objects from your bucket, you must deny them - * the s3:DeleteObject, s3:DeleteObjectVersion, and - * s3:PutLifeCycleConfiguration actions.

- *

The following action is related to DeleteObject:

- * + * @see {@link DeleteObjectCommand} */ - public deleteObject( - args: DeleteObjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteObject(args: DeleteObjectCommandInput, cb: (err: any, data?: DeleteObjectCommandOutput) => void): void; - public deleteObject( + deleteObject(args: DeleteObjectCommandInput, options?: __HttpHandlerOptions): Promise; + deleteObject(args: DeleteObjectCommandInput, cb: (err: any, data?: DeleteObjectCommandOutput) => void): void; + deleteObject( args: DeleteObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteObjectCommandOutput) => void ): void; - public deleteObject( - args: DeleteObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteObjectCommandOutput) => void), - cb?: (err: any, data?: DeleteObjectCommandOutput) => void - ): Promise | void { - const command = new DeleteObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This action enables you to delete multiple objects from a bucket using a single HTTP - * request. If you know the object keys that you want to delete, then this action provides a - * suitable alternative to sending individual delete requests, reducing per-request - * overhead.

- *

The request contains a list of up to 1000 keys that you want to delete. In the XML, you - * provide the object key names, and optionally, version IDs if you want to delete a specific - * version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a - * delete action and returns the result of that delete, success, or failure, in the response. - * Note that if the object specified in the request is not found, Amazon S3 returns the result as - * deleted.

- *

The action supports two modes for the response: verbose and quiet. By default, the - * action uses verbose mode in which the response includes the result of deletion of each key - * in your request. In quiet mode the response includes only keys where the delete action - * encountered an error. For a successful deletion, the action does not return any information - * about the delete in the response body.

- *

When performing this action on an MFA Delete enabled bucket, that attempts to delete any - * versioned objects, you must include an MFA token. If you do not provide one, the entire - * request will fail, even if there are non-versioned objects you are trying to delete. If you - * provide an invalid token, whether there are versioned keys in the request or not, the - * entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA - * Delete.

- *

Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in - * transit.

- *

The following operations are related to DeleteObjects:

- * + * @see {@link DeleteObjectsCommand} */ - public deleteObjects( - args: DeleteObjectsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteObjects( - args: DeleteObjectsCommandInput, - cb: (err: any, data?: DeleteObjectsCommandOutput) => void - ): void; - public deleteObjects( + deleteObjects(args: DeleteObjectsCommandInput, options?: __HttpHandlerOptions): Promise; + deleteObjects(args: DeleteObjectsCommandInput, cb: (err: any, data?: DeleteObjectsCommandOutput) => void): void; + deleteObjects( args: DeleteObjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteObjectsCommandOutput) => void ): void; - public deleteObjects( - args: DeleteObjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteObjectsCommandOutput) => void), - cb?: (err: any, data?: DeleteObjectsCommandOutput) => void - ): Promise | void { - const command = new DeleteObjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the entire tag set from the specified object. For more information about - * managing object tags, see Object Tagging.

- *

To use this operation, you must have permission to perform the - * s3:DeleteObjectTagging action.

- *

To delete tags of a specific object version, add the versionId query - * parameter in the request. You will need permission for the - * s3:DeleteObjectVersionTagging action.

- *

The following operations are related to DeleteObjectTagging:

- * + * @see {@link DeleteObjectTaggingCommand} */ - public deleteObjectTagging( + deleteObjectTagging( args: DeleteObjectTaggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteObjectTagging( + deleteObjectTagging( args: DeleteObjectTaggingCommandInput, cb: (err: any, data?: DeleteObjectTaggingCommandOutput) => void ): void; - public deleteObjectTagging( + deleteObjectTagging( args: DeleteObjectTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteObjectTaggingCommandOutput) => void ): void; - public deleteObjectTagging( - args: DeleteObjectTaggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteObjectTaggingCommandOutput) => void), - cb?: (err: any, data?: DeleteObjectTaggingCommandOutput) => void - ): Promise | void { - const command = new DeleteObjectTaggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the PublicAccessBlock configuration for an Amazon S3 bucket. To use this - * operation, you must have the s3:PutBucketPublicAccessBlock permission. For - * more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

The following operations are related to DeletePublicAccessBlock:

- * + * @see {@link DeletePublicAccessBlockCommand} */ - public deletePublicAccessBlock( + deletePublicAccessBlock( args: DeletePublicAccessBlockCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePublicAccessBlock( + deletePublicAccessBlock( args: DeletePublicAccessBlockCommandInput, cb: (err: any, data?: DeletePublicAccessBlockCommandOutput) => void ): void; - public deletePublicAccessBlock( + deletePublicAccessBlock( args: DeletePublicAccessBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePublicAccessBlockCommandOutput) => void ): void; - public deletePublicAccessBlock( - args: DeletePublicAccessBlockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePublicAccessBlockCommandOutput) => void), - cb?: (err: any, data?: DeletePublicAccessBlockCommandOutput) => void - ): Promise | void { - const command = new DeletePublicAccessBlockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This implementation of the GET action uses the accelerate subresource to - * return the Transfer Acceleration state of a bucket, which is either Enabled or - * Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature that - * enables you to perform faster data transfers to and from Amazon S3.

- *

To use this operation, you must have permission to perform the - * s3:GetAccelerateConfiguration action. The bucket owner has this permission - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to your Amazon S3 Resources in the - * Amazon S3 User Guide.

- *

You set the Transfer Acceleration state of an existing bucket to Enabled or - * Suspended by using the PutBucketAccelerateConfiguration operation.

- *

A GET accelerate request does not return a state value for a bucket that - * has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state - * has never been set on the bucket.

- *

For more information about transfer acceleration, see Transfer Acceleration in - * the Amazon S3 User Guide.

- *

- * Related Resources - *

- * + * @see {@link GetBucketAccelerateConfigurationCommand} */ - public getBucketAccelerateConfiguration( + getBucketAccelerateConfiguration( args: GetBucketAccelerateConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketAccelerateConfiguration( + getBucketAccelerateConfiguration( args: GetBucketAccelerateConfigurationCommandInput, cb: (err: any, data?: GetBucketAccelerateConfigurationCommandOutput) => void ): void; - public getBucketAccelerateConfiguration( + getBucketAccelerateConfiguration( args: GetBucketAccelerateConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketAccelerateConfigurationCommandOutput) => void ): void; - public getBucketAccelerateConfiguration( - args: GetBucketAccelerateConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketAccelerateConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetBucketAccelerateConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetBucketAccelerateConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This implementation of the GET action uses the acl subresource - * to return the access control list (ACL) of a bucket. To use GET to return the - * ACL of the bucket, you must have READ_ACP access to the bucket. If - * READ_ACP permission is granted to the anonymous user, you can return the - * ACL of the bucket without using an authorization header.

- *

To use this API against an access point, provide the alias of the access point in place of the bucket name.

- * - *

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, - * requests to read ACLs are still supported and return the - * bucket-owner-full-control ACL with the owner being the account that - * created the bucket. For more information, see Controlling object - * ownership and disabling ACLs in the - * Amazon S3 User Guide.

- *
- *

- * Related Resources - *

- * + * @see {@link GetBucketAclCommand} */ - public getBucketAcl( - args: GetBucketAclCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getBucketAcl(args: GetBucketAclCommandInput, cb: (err: any, data?: GetBucketAclCommandOutput) => void): void; - public getBucketAcl( + getBucketAcl(args: GetBucketAclCommandInput, options?: __HttpHandlerOptions): Promise; + getBucketAcl(args: GetBucketAclCommandInput, cb: (err: any, data?: GetBucketAclCommandOutput) => void): void; + getBucketAcl( args: GetBucketAclCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketAclCommandOutput) => void ): void; - public getBucketAcl( - args: GetBucketAclCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketAclCommandOutput) => void), - cb?: (err: any, data?: GetBucketAclCommandOutput) => void - ): Promise | void { - const command = new GetBucketAclCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This implementation of the GET action returns an analytics configuration (identified by - * the analytics configuration ID) from the bucket.

- *

To use this operation, you must have permissions to perform the - * s3:GetAnalyticsConfiguration action. The bucket owner has this permission - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources in the - * Amazon S3 User Guide.

- *

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class - * Analysis in the Amazon S3 User Guide.

- *

- * Related Resources - *

- * + * @see {@link GetBucketAnalyticsConfigurationCommand} */ - public getBucketAnalyticsConfiguration( + getBucketAnalyticsConfiguration( args: GetBucketAnalyticsConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketAnalyticsConfiguration( + getBucketAnalyticsConfiguration( args: GetBucketAnalyticsConfigurationCommandInput, cb: (err: any, data?: GetBucketAnalyticsConfigurationCommandOutput) => void ): void; - public getBucketAnalyticsConfiguration( + getBucketAnalyticsConfiguration( args: GetBucketAnalyticsConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketAnalyticsConfigurationCommandOutput) => void ): void; - public getBucketAnalyticsConfiguration( - args: GetBucketAnalyticsConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketAnalyticsConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetBucketAnalyticsConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetBucketAnalyticsConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the - * bucket.

- *

To use this operation, you must have permission to perform the - * s3:GetBucketCORS action. By default, the bucket owner has this permission - * and can grant it to others.

- *

To use this API against an access point, provide the alias of the access point in place of the bucket name.

- *

For more information about CORS, see Enabling Cross-Origin Resource - * Sharing.

- *

The following operations are related to GetBucketCors:

- * + * @see {@link GetBucketCorsCommand} */ - public getBucketCors( - args: GetBucketCorsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getBucketCors( - args: GetBucketCorsCommandInput, - cb: (err: any, data?: GetBucketCorsCommandOutput) => void - ): void; - public getBucketCors( + getBucketCors(args: GetBucketCorsCommandInput, options?: __HttpHandlerOptions): Promise; + getBucketCors(args: GetBucketCorsCommandInput, cb: (err: any, data?: GetBucketCorsCommandOutput) => void): void; + getBucketCors( args: GetBucketCorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketCorsCommandOutput) => void ): void; - public getBucketCors( - args: GetBucketCorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketCorsCommandOutput) => void), - cb?: (err: any, data?: GetBucketCorsCommandOutput) => void - ): Promise | void { - const command = new GetBucketCorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the default encryption configuration for an Amazon S3 bucket. By default, all buckets have a default encryption configuration that - * uses server-side encryption with Amazon S3 managed keys (SSE-S3). For information - * about the bucket default encryption feature, see Amazon S3 Bucket - * Default Encryption in the Amazon S3 User Guide.

- *

To use this operation, you must have permission to perform the - * s3:GetEncryptionConfiguration action. The bucket owner has this permission - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

The following operations are related to GetBucketEncryption:

- * + * @see {@link GetBucketEncryptionCommand} */ - public getBucketEncryption( + getBucketEncryption( args: GetBucketEncryptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketEncryption( + getBucketEncryption( args: GetBucketEncryptionCommandInput, cb: (err: any, data?: GetBucketEncryptionCommandOutput) => void ): void; - public getBucketEncryption( + getBucketEncryption( args: GetBucketEncryptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketEncryptionCommandOutput) => void ): void; - public getBucketEncryption( - args: GetBucketEncryptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketEncryptionCommandOutput) => void), - cb?: (err: any, data?: GetBucketEncryptionCommandOutput) => void - ): Promise | void { - const command = new GetBucketEncryptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the S3 Intelligent-Tiering configuration from the specified bucket.

- *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

- *

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

- *

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

- *

Operations related to GetBucketIntelligentTieringConfiguration include:

- * + * @see {@link GetBucketIntelligentTieringConfigurationCommand} */ - public getBucketIntelligentTieringConfiguration( + getBucketIntelligentTieringConfiguration( args: GetBucketIntelligentTieringConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketIntelligentTieringConfiguration( + getBucketIntelligentTieringConfiguration( args: GetBucketIntelligentTieringConfigurationCommandInput, cb: (err: any, data?: GetBucketIntelligentTieringConfigurationCommandOutput) => void ): void; - public getBucketIntelligentTieringConfiguration( + getBucketIntelligentTieringConfiguration( args: GetBucketIntelligentTieringConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketIntelligentTieringConfigurationCommandOutput) => void ): void; - public getBucketIntelligentTieringConfiguration( - args: GetBucketIntelligentTieringConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetBucketIntelligentTieringConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetBucketIntelligentTieringConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetBucketIntelligentTieringConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an inventory configuration (identified by the inventory configuration ID) from - * the bucket.

- *

To use this operation, you must have permissions to perform the - * s3:GetInventoryConfiguration action. The bucket owner has this permission - * by default and can grant this permission to others. For more information about permissions, - * see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

- *

The following operations are related to - * GetBucketInventoryConfiguration:

- * + * @see {@link GetBucketInventoryConfigurationCommand} */ - public getBucketInventoryConfiguration( + getBucketInventoryConfiguration( args: GetBucketInventoryConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketInventoryConfiguration( + getBucketInventoryConfiguration( args: GetBucketInventoryConfigurationCommandInput, cb: (err: any, data?: GetBucketInventoryConfigurationCommandOutput) => void ): void; - public getBucketInventoryConfiguration( + getBucketInventoryConfiguration( args: GetBucketInventoryConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketInventoryConfigurationCommandOutput) => void ): void; - public getBucketInventoryConfiguration( - args: GetBucketInventoryConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketInventoryConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetBucketInventoryConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetBucketInventoryConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

Bucket lifecycle configuration now supports specifying a lifecycle rule using an - * object key name prefix, one or more object tags, or a combination of both. Accordingly, - * this section describes the latest API. The response describes the new filter element - * that you can use to specify a filter to select a subset of objects to which the rule - * applies. If you are using a previous version of the lifecycle configuration, it still - * works. For the earlier action, see GetBucketLifecycle.

- *
- *

Returns the lifecycle configuration information set on the bucket. For information about - * lifecycle configuration, see Object Lifecycle - * Management.

- *

To use this operation, you must have permission to perform the - * s3:GetLifecycleConfiguration action. The bucket owner has this permission, - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

- * GetBucketLifecycleConfiguration has the following special error:

- *
    - *
  • - *

    Error code: NoSuchLifecycleConfiguration - *

    - *
      - *
    • - *

      Description: The lifecycle configuration does not exist.

      - *
    • - *
    • - *

      HTTP Status Code: 404 Not Found

      - *
    • - *
    • - *

      SOAP Fault Code Prefix: Client

      - *
    • - *
    - *
  • - *
- *

The following operations are related to - * GetBucketLifecycleConfiguration:

- * + * @see {@link GetBucketLifecycleConfigurationCommand} */ - public getBucketLifecycleConfiguration( + getBucketLifecycleConfiguration( args: GetBucketLifecycleConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketLifecycleConfiguration( + getBucketLifecycleConfiguration( args: GetBucketLifecycleConfigurationCommandInput, cb: (err: any, data?: GetBucketLifecycleConfigurationCommandOutput) => void ): void; - public getBucketLifecycleConfiguration( + getBucketLifecycleConfiguration( args: GetBucketLifecycleConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketLifecycleConfigurationCommandOutput) => void ): void; - public getBucketLifecycleConfiguration( - args: GetBucketLifecycleConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketLifecycleConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetBucketLifecycleConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetBucketLifecycleConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the Region the bucket resides in. You set the bucket's Region using the - * LocationConstraint request parameter in a CreateBucket - * request. For more information, see CreateBucket.

- *

To use this implementation of the operation, you must be the bucket owner.

- *

To use this API against an access point, provide the alias of the access point in place of the bucket name.

- * - *

For requests made using Amazon Web Services Signature Version 4 (SigV4), we recommend that you use - * HeadBucket to return the bucket Region instead of GetBucketLocation.

- *
- *

The following operations are related to GetBucketLocation:

- * + * @see {@link GetBucketLocationCommand} */ - public getBucketLocation( + getBucketLocation( args: GetBucketLocationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketLocation( + getBucketLocation( args: GetBucketLocationCommandInput, cb: (err: any, data?: GetBucketLocationCommandOutput) => void ): void; - public getBucketLocation( + getBucketLocation( args: GetBucketLocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketLocationCommandOutput) => void ): void; - public getBucketLocation( - args: GetBucketLocationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketLocationCommandOutput) => void), - cb?: (err: any, data?: GetBucketLocationCommandOutput) => void - ): Promise | void { - const command = new GetBucketLocationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the logging status of a bucket and the permissions users have to view and modify - * that status.

- *

The following operations are related to GetBucketLogging:

- * + * @see {@link GetBucketLoggingCommand} */ - public getBucketLogging( + getBucketLogging( args: GetBucketLoggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketLogging( + getBucketLogging( args: GetBucketLoggingCommandInput, cb: (err: any, data?: GetBucketLoggingCommandOutput) => void ): void; - public getBucketLogging( + getBucketLogging( args: GetBucketLoggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketLoggingCommandOutput) => void ): void; - public getBucketLogging( - args: GetBucketLoggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketLoggingCommandOutput) => void), - cb?: (err: any, data?: GetBucketLoggingCommandOutput) => void - ): Promise | void { - const command = new GetBucketLoggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a metrics configuration (specified by the metrics configuration ID) from the - * bucket. Note that this doesn't include the daily storage metrics.

- *

To use this operation, you must have permissions to perform the - * s3:GetMetricsConfiguration action. The bucket owner has this permission by - * default. The bucket owner can grant this permission to others. For more information about - * permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

For information about CloudWatch request metrics for Amazon S3, see Monitoring - * Metrics with Amazon CloudWatch.

- *

The following operations are related to - * GetBucketMetricsConfiguration:

- * + * @see {@link GetBucketMetricsConfigurationCommand} */ - public getBucketMetricsConfiguration( + getBucketMetricsConfiguration( args: GetBucketMetricsConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketMetricsConfiguration( + getBucketMetricsConfiguration( args: GetBucketMetricsConfigurationCommandInput, cb: (err: any, data?: GetBucketMetricsConfigurationCommandOutput) => void ): void; - public getBucketMetricsConfiguration( + getBucketMetricsConfiguration( args: GetBucketMetricsConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketMetricsConfigurationCommandOutput) => void ): void; - public getBucketMetricsConfiguration( - args: GetBucketMetricsConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketMetricsConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetBucketMetricsConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetBucketMetricsConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the notification configuration of a bucket.

- *

If notifications are not enabled on the bucket, the action returns an empty - * NotificationConfiguration element.

- *

By default, you must be the bucket owner to read the notification configuration of a - * bucket. However, the bucket owner can use a bucket policy to grant permission to other - * users to read this configuration with the s3:GetBucketNotification - * permission.

- *

To use this API against an access point, provide the alias of the access point in place of the bucket name.

- *

For more information about setting and reading the notification configuration on a - * bucket, see Setting Up Notification of Bucket Events. For more information about bucket - * policies, see Using Bucket Policies.

- *

The following action is related to GetBucketNotification:

- * + * @see {@link GetBucketNotificationConfigurationCommand} */ - public getBucketNotificationConfiguration( + getBucketNotificationConfiguration( args: GetBucketNotificationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketNotificationConfiguration( + getBucketNotificationConfiguration( args: GetBucketNotificationConfigurationCommandInput, cb: (err: any, data?: GetBucketNotificationConfigurationCommandOutput) => void ): void; - public getBucketNotificationConfiguration( + getBucketNotificationConfiguration( args: GetBucketNotificationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketNotificationConfigurationCommandOutput) => void ): void; - public getBucketNotificationConfiguration( - args: GetBucketNotificationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketNotificationConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetBucketNotificationConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetBucketNotificationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you - * must have the s3:GetBucketOwnershipControls permission. For more information - * about Amazon S3 permissions, see Specifying permissions in a - * policy.

- *

For information about Amazon S3 Object Ownership, see Using Object - * Ownership.

- *

The following operations are related to GetBucketOwnershipControls:

- * + * @see {@link GetBucketOwnershipControlsCommand} */ - public getBucketOwnershipControls( + getBucketOwnershipControls( args: GetBucketOwnershipControlsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketOwnershipControls( + getBucketOwnershipControls( args: GetBucketOwnershipControlsCommandInput, cb: (err: any, data?: GetBucketOwnershipControlsCommandOutput) => void ): void; - public getBucketOwnershipControls( + getBucketOwnershipControls( args: GetBucketOwnershipControlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketOwnershipControlsCommandOutput) => void ): void; - public getBucketOwnershipControls( - args: GetBucketOwnershipControlsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketOwnershipControlsCommandOutput) => void), - cb?: (err: any, data?: GetBucketOwnershipControlsCommandOutput) => void - ): Promise | void { - const command = new GetBucketOwnershipControlsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the policy of a specified bucket. If you are using an identity other than the - * root user of the Amazon Web Services account that owns the bucket, the calling identity must have the - * GetBucketPolicy permissions on the specified bucket and belong to the - * bucket owner's account in order to use this operation.

- *

If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 - * Access Denied error. If you have the correct permissions, but you're not using an - * identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not - * Allowed error.

- * - *

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can - * always use this operation, even if the policy explicitly denies the root user the - * ability to perform this action.

- *
- *

To use this API against an access point, provide the alias of the access point in place of the bucket name.

- *

For more information about bucket policies, see Using Bucket Policies and User - * Policies.

- *

The following action is related to GetBucketPolicy:

- * + * @see {@link GetBucketPolicyCommand} */ - public getBucketPolicy( + getBucketPolicy( args: GetBucketPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketPolicy( - args: GetBucketPolicyCommandInput, - cb: (err: any, data?: GetBucketPolicyCommandOutput) => void - ): void; - public getBucketPolicy( + getBucketPolicy(args: GetBucketPolicyCommandInput, cb: (err: any, data?: GetBucketPolicyCommandOutput) => void): void; + getBucketPolicy( args: GetBucketPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketPolicyCommandOutput) => void ): void; - public getBucketPolicy( - args: GetBucketPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketPolicyCommandOutput) => void), - cb?: (err: any, data?: GetBucketPolicyCommandOutput) => void - ): Promise | void { - const command = new GetBucketPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. - * In order to use this operation, you must have the s3:GetBucketPolicyStatus - * permission. For more information about Amazon S3 permissions, see Specifying Permissions in a - * Policy.

- *

For more information about when Amazon S3 considers a bucket public, see The Meaning of "Public".

- *

The following operations are related to GetBucketPolicyStatus:

- * + * @see {@link GetBucketPolicyStatusCommand} */ - public getBucketPolicyStatus( + getBucketPolicyStatus( args: GetBucketPolicyStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketPolicyStatus( + getBucketPolicyStatus( args: GetBucketPolicyStatusCommandInput, cb: (err: any, data?: GetBucketPolicyStatusCommandOutput) => void ): void; - public getBucketPolicyStatus( + getBucketPolicyStatus( args: GetBucketPolicyStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketPolicyStatusCommandOutput) => void ): void; - public getBucketPolicyStatus( - args: GetBucketPolicyStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketPolicyStatusCommandOutput) => void), - cb?: (err: any, data?: GetBucketPolicyStatusCommandOutput) => void - ): Promise | void { - const command = new GetBucketPolicyStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the replication configuration of a bucket.

- * - *

It can take a while to propagate the put or delete a replication configuration to - * all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong - * result.

- *
- *

For information about replication configuration, see Replication in the - * Amazon S3 User Guide.

- *

This action requires permissions for the s3:GetReplicationConfiguration - * action. For more information about permissions, see Using Bucket Policies and User - * Policies.

- *

If you include the Filter element in a replication configuration, you must - * also include the DeleteMarkerReplication and Priority elements. - * The response also returns those elements.

- *

For information about GetBucketReplication errors, see List of - * replication-related error codes - *

- *

The following operations are related to GetBucketReplication:

- * + * @see {@link GetBucketReplicationCommand} */ - public getBucketReplication( + getBucketReplication( args: GetBucketReplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketReplication( + getBucketReplication( args: GetBucketReplicationCommandInput, cb: (err: any, data?: GetBucketReplicationCommandOutput) => void ): void; - public getBucketReplication( + getBucketReplication( args: GetBucketReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketReplicationCommandOutput) => void ): void; - public getBucketReplication( - args: GetBucketReplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketReplicationCommandOutput) => void), - cb?: (err: any, data?: GetBucketReplicationCommandOutput) => void - ): Promise | void { - const command = new GetBucketReplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the request payment configuration of a bucket. To use this version of the - * operation, you must be the bucket owner. For more information, see Requester Pays - * Buckets.

- *

The following operations are related to GetBucketRequestPayment:

- * + * @see {@link GetBucketRequestPaymentCommand} */ - public getBucketRequestPayment( + getBucketRequestPayment( args: GetBucketRequestPaymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketRequestPayment( + getBucketRequestPayment( args: GetBucketRequestPaymentCommandInput, cb: (err: any, data?: GetBucketRequestPaymentCommandOutput) => void ): void; - public getBucketRequestPayment( + getBucketRequestPayment( args: GetBucketRequestPaymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketRequestPaymentCommandOutput) => void ): void; - public getBucketRequestPayment( - args: GetBucketRequestPaymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketRequestPaymentCommandOutput) => void), - cb?: (err: any, data?: GetBucketRequestPaymentCommandOutput) => void - ): Promise | void { - const command = new GetBucketRequestPaymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the tag set associated with the bucket.

- *

To use this operation, you must have permission to perform the - * s3:GetBucketTagging action. By default, the bucket owner has this - * permission and can grant this permission to others.

- *

- * GetBucketTagging has the following special error:

- *
    - *
  • - *

    Error code: NoSuchTagSet - *

    - *
      - *
    • - *

      Description: There is no tag set associated with the bucket.

      - *
    • - *
    - *
  • - *
- *

The following operations are related to GetBucketTagging:

- * + * @see {@link GetBucketTaggingCommand} */ - public getBucketTagging( + getBucketTagging( args: GetBucketTaggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketTagging( + getBucketTagging( args: GetBucketTaggingCommandInput, cb: (err: any, data?: GetBucketTaggingCommandOutput) => void ): void; - public getBucketTagging( + getBucketTagging( args: GetBucketTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketTaggingCommandOutput) => void ): void; - public getBucketTagging( - args: GetBucketTaggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketTaggingCommandOutput) => void), - cb?: (err: any, data?: GetBucketTaggingCommandOutput) => void - ): Promise | void { - const command = new GetBucketTaggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the versioning state of a bucket.

- *

To retrieve the versioning state of a bucket, you must be the bucket owner.

- *

This implementation also returns the MFA Delete status of the versioning state. If the - * MFA Delete status is enabled, the bucket owner must use an authentication - * device to change the versioning state of the bucket.

- *

The following operations are related to GetBucketVersioning:

- * + * @see {@link GetBucketVersioningCommand} */ - public getBucketVersioning( + getBucketVersioning( args: GetBucketVersioningCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketVersioning( + getBucketVersioning( args: GetBucketVersioningCommandInput, cb: (err: any, data?: GetBucketVersioningCommandOutput) => void ): void; - public getBucketVersioning( + getBucketVersioning( args: GetBucketVersioningCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketVersioningCommandOutput) => void ): void; - public getBucketVersioning( - args: GetBucketVersioningCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketVersioningCommandOutput) => void), - cb?: (err: any, data?: GetBucketVersioningCommandOutput) => void - ): Promise | void { - const command = new GetBucketVersioningCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the website configuration for a bucket. To host website on Amazon S3, you can - * configure a bucket as website by adding a website configuration. For more information about - * hosting websites, see Hosting Websites on Amazon S3.

- *

This GET action requires the S3:GetBucketWebsite permission. By default, - * only the bucket owner can read the bucket website configuration. However, bucket owners can - * allow other users to read the website configuration by writing a bucket policy granting - * them the S3:GetBucketWebsite permission.

- *

The following operations are related to DeleteBucketWebsite:

- * + * @see {@link GetBucketWebsiteCommand} */ - public getBucketWebsite( + getBucketWebsite( args: GetBucketWebsiteCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBucketWebsite( + getBucketWebsite( args: GetBucketWebsiteCommandInput, cb: (err: any, data?: GetBucketWebsiteCommandOutput) => void ): void; - public getBucketWebsite( + getBucketWebsite( args: GetBucketWebsiteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketWebsiteCommandOutput) => void ): void; - public getBucketWebsite( - args: GetBucketWebsiteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBucketWebsiteCommandOutput) => void), - cb?: (err: any, data?: GetBucketWebsiteCommandOutput) => void - ): Promise | void { - const command = new GetBucketWebsiteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves objects from Amazon S3. To use GET, you must have READ - * access to the object. If you grant READ access to the anonymous user, you can - * return the object without using an authorization header.

- *

An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer - * file system. You can, however, create a logical hierarchy by using object key names that - * imply a folder structure. For example, instead of naming an object sample.jpg, - * you can name it photos/2006/February/sample.jpg.

- *

To get an object from such a logical hierarchy, specify the full key name for the object - * in the GET operation. For a virtual hosted-style request example, if you have - * the object photos/2006/February/sample.jpg, specify the resource as - * /photos/2006/February/sample.jpg. For a path-style request example, if you - * have the object photos/2006/February/sample.jpg in the bucket named - * examplebucket, specify the resource as - * /examplebucket/photos/2006/February/sample.jpg. For more information about - * request types, see HTTP Host - * Header Bucket Specification.

- *

For more information about returning the ACL of an object, see GetObjectAcl.

- *

If the object you are retrieving is stored in the S3 Glacier or - * S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or - * S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a - * copy using RestoreObject. Otherwise, this action returns an - * InvalidObjectState error. For information about restoring archived objects, - * see Restoring - * Archived Objects.

- *

Encryption request headers, like x-amz-server-side-encryption, should not - * be sent for GET requests if your object uses server-side encryption with KMS keys - * (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your - * object does use these types of keys, you’ll get an HTTP 400 BadRequest error.

- *

If you encrypt an object by using server-side encryption with customer-provided - * encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, - * you must use the following headers:

- *
    - *
  • - *

    x-amz-server-side-encryption-customer-algorithm

    - *
  • - *
  • - *

    x-amz-server-side-encryption-customer-key

    - *
  • - *
  • - *

    x-amz-server-side-encryption-customer-key-MD5

    - *
  • - *
- *

For more information about SSE-C, see Server-Side Encryption - * (Using Customer-Provided Encryption Keys).

- *

Assuming you have the relevant permission to read object tags, the response also returns - * the x-amz-tagging-count header that provides the count of number of tags - * associated with the object. You can use GetObjectTagging to retrieve - * the tag set associated with an object.

- *

- * Permissions - *

- *

You need the relevant read object (or version) permission for this operation. For more - * information, see Specifying Permissions in a - * Policy. If the object you request does not exist, the error Amazon S3 returns depends - * on whether you also have the s3:ListBucket permission.

- *
    - *
  • - *

    If you have the s3:ListBucket permission on the bucket, Amazon S3 will - * return an HTTP status code 404 ("no such key") error.

    - *
  • - *
  • - *

    If you don’t have the s3:ListBucket permission, Amazon S3 will return an - * HTTP status code 403 ("access denied") error.

    - *
  • - *
- *

- * Versioning - *

- *

By default, the GET action returns the current version of an object. To return a - * different version, use the versionId subresource.

- * - *
    - *
  • - *

    If you supply a versionId, you need the - * s3:GetObjectVersion permission to access a specific version of an - * object. If you request a specific version, you do not need to have the - * s3:GetObject permission. If you request the current version - * without a specific version ID, only s3:GetObject permission is - * required. s3:GetObjectVersion permission won't be required.

    - *
  • - *
  • - *

    If the current version of the object is a delete marker, Amazon S3 behaves as if the - * object was deleted and includes x-amz-delete-marker: true in the - * response.

    - *
  • - *
- *
- *

For more information about versioning, see PutBucketVersioning.

- *

- * Overriding Response Header Values - *

- *

There are times when you want to override certain response header values in a GET - * response. For example, you might override the Content-Disposition response - * header value in your GET request.

- *

You can override values for a set of response headers using the following query - * parameters. These response header values are sent only on a successful request, that is, - * when status code 200 OK is returned. The set of headers you can override using these - * parameters is a subset of the headers that Amazon S3 accepts when you create an object. The - * response headers that you can override for the GET response are Content-Type, - * Content-Language, Expires, Cache-Control, - * Content-Disposition, and Content-Encoding. To override these - * header values in the GET response, you use the following request parameters.

- * - *

You must sign the request, either using an Authorization header or a presigned URL, - * when using these parameters. They cannot be used with an unsigned (anonymous) - * request.

- *
- *
    - *
  • - *

    - * response-content-type - *

    - *
  • - *
  • - *

    - * response-content-language - *

    - *
  • - *
  • - *

    - * response-expires - *

    - *
  • - *
  • - *

    - * response-cache-control - *

    - *
  • - *
  • - *

    - * response-content-disposition - *

    - *
  • - *
  • - *

    - * response-content-encoding - *

    - *
  • - *
- *

- * Additional Considerations about Request Headers - *

- *

If both of the If-Match and If-Unmodified-Since headers are - * present in the request as follows: If-Match condition evaluates to - * true, and; If-Unmodified-Since condition evaluates to - * false; then, S3 returns 200 OK and the data requested.

- *

If both of the If-None-Match and If-Modified-Since headers are - * present in the request as follows: If-None-Match condition evaluates to - * false, and; If-Modified-Since condition evaluates to - * true; then, S3 returns 304 Not Modified response code.

- *

For more information about conditional requests, see RFC 7232.

- *

The following operations are related to GetObject:

- * + * @see {@link GetObjectCommand} */ - public getObject(args: GetObjectCommandInput, options?: __HttpHandlerOptions): Promise; - public getObject(args: GetObjectCommandInput, cb: (err: any, data?: GetObjectCommandOutput) => void): void; - public getObject( + getObject(args: GetObjectCommandInput, options?: __HttpHandlerOptions): Promise; + getObject(args: GetObjectCommandInput, cb: (err: any, data?: GetObjectCommandOutput) => void): void; + getObject( args: GetObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetObjectCommandOutput) => void ): void; - public getObject( - args: GetObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetObjectCommandOutput) => void), - cb?: (err: any, data?: GetObjectCommandOutput) => void - ): Promise | void { - const command = new GetObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the access control list (ACL) of an object. To use this operation, you must have - * s3:GetObjectAcl permissions or READ_ACP access to the object. - * For more information, see Mapping of ACL permissions and access policy permissions in the Amazon S3 - * User Guide - *

- *

This action is not supported by Amazon S3 on Outposts.

- *

- * Versioning - *

- *

By default, GET returns ACL information about the current version of an object. To - * return ACL information about a different version, use the versionId subresource.

- * - *

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, - * requests to read ACLs are still supported and return the - * bucket-owner-full-control ACL with the owner being the account that - * created the bucket. For more information, see Controlling object - * ownership and disabling ACLs in the - * Amazon S3 User Guide.

- *
- *

The following operations are related to GetObjectAcl:

- * + * @see {@link GetObjectAclCommand} */ - public getObjectAcl( - args: GetObjectAclCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getObjectAcl(args: GetObjectAclCommandInput, cb: (err: any, data?: GetObjectAclCommandOutput) => void): void; - public getObjectAcl( + getObjectAcl(args: GetObjectAclCommandInput, options?: __HttpHandlerOptions): Promise; + getObjectAcl(args: GetObjectAclCommandInput, cb: (err: any, data?: GetObjectAclCommandOutput) => void): void; + getObjectAcl( args: GetObjectAclCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetObjectAclCommandOutput) => void ): void; - public getObjectAcl( - args: GetObjectAclCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetObjectAclCommandOutput) => void), - cb?: (err: any, data?: GetObjectAclCommandOutput) => void - ): Promise | void { - const command = new GetObjectAclCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves all the metadata from an object without returning the object itself. This - * action is useful if you're interested only in an object's metadata. To use - * GetObjectAttributes, you must have READ access to the object.

- *

- * GetObjectAttributes combines the functionality of HeadObject - * and ListParts. All of the data returned with each of those individual calls - * can be returned with a single call to GetObjectAttributes.

- *

If you encrypt an object by using server-side encryption with customer-provided - * encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the - * metadata from the object, you must use the following headers:

- *
    - *
  • - *

    - * x-amz-server-side-encryption-customer-algorithm - *

    - *
  • - *
  • - *

    - * x-amz-server-side-encryption-customer-key - *

    - *
  • - *
  • - *

    - * x-amz-server-side-encryption-customer-key-MD5 - *

    - *
  • - *
- *

For more information about SSE-C, see Server-Side Encryption - * (Using Customer-Provided Encryption Keys) in the - * Amazon S3 User Guide.

- * - *
    - *
  • - *

    Encryption request headers, such as x-amz-server-side-encryption, - * should not be sent for GET requests if your object uses server-side encryption - * with Amazon Web Services KMS keys stored in Amazon Web Services Key Management Service (SSE-KMS) or - * server-side encryption with Amazon S3 managed keys (SSE-S3). If your object does use - * these types of keys, you'll get an HTTP 400 Bad Request error.

    - *
  • - *
  • - *

    The last modified property in this case is the creation date of the - * object.

    - *
  • - *
- *
- *

Consider the following when using request headers:

- *
    - *
  • - *

    If both of the If-Match and If-Unmodified-Since headers - * are present in the request as follows, then Amazon S3 returns the HTTP status code - * 200 OK and the data requested:

    - *
      - *
    • - *

      - * If-Match condition evaluates to true.

      - *
    • - *
    • - *

      - * If-Unmodified-Since condition evaluates to - * false.

      - *
    • - *
    - *
  • - *
  • - *

    If both of the If-None-Match and If-Modified-Since - * headers are present in the request as follows, then Amazon S3 returns the HTTP status code - * 304 Not Modified:

    - *
      - *
    • - *

      - * If-None-Match condition evaluates to false.

      - *
    • - *
    • - *

      - * If-Modified-Since condition evaluates to - * true.

      - *
    • - *
    - *
  • - *
- *

For more information about conditional requests, see RFC 7232.

- *

- * Permissions - *

- *

The permissions that you need to use this operation depend on whether the bucket is - * versioned. If the bucket is versioned, you need both the s3:GetObjectVersion - * and s3:GetObjectVersionAttributes permissions for this operation. If the - * bucket is not versioned, you need the s3:GetObject and - * s3:GetObjectAttributes permissions. For more information, see Specifying - * Permissions in a Policy in the Amazon S3 User Guide. If the - * object that you request does not exist, the error Amazon S3 returns depends on whether you also - * have the s3:ListBucket permission.

- *
    - *
  • - *

    If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - * an HTTP status code 404 Not Found ("no such key") error.

    - *
  • - *
  • - *

    If you don't have the s3:ListBucket permission, Amazon S3 returns an HTTP - * status code 403 Forbidden ("access denied") error.

    - *
  • - *
- *

The following actions are related to GetObjectAttributes:

- * + * @see {@link GetObjectAttributesCommand} */ - public getObjectAttributes( + getObjectAttributes( args: GetObjectAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getObjectAttributes( + getObjectAttributes( args: GetObjectAttributesCommandInput, cb: (err: any, data?: GetObjectAttributesCommandOutput) => void ): void; - public getObjectAttributes( + getObjectAttributes( args: GetObjectAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetObjectAttributesCommandOutput) => void ): void; - public getObjectAttributes( - args: GetObjectAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetObjectAttributesCommandOutput) => void), - cb?: (err: any, data?: GetObjectAttributesCommandOutput) => void - ): Promise | void { - const command = new GetObjectAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets an object's current legal hold status. For more information, see Locking - * Objects.

- *

This action is not supported by Amazon S3 on Outposts.

- *

The following action is related to GetObjectLegalHold:

- * + * @see {@link GetObjectLegalHoldCommand} */ - public getObjectLegalHold( + getObjectLegalHold( args: GetObjectLegalHoldCommandInput, options?: __HttpHandlerOptions ): Promise; - public getObjectLegalHold( + getObjectLegalHold( args: GetObjectLegalHoldCommandInput, cb: (err: any, data?: GetObjectLegalHoldCommandOutput) => void ): void; - public getObjectLegalHold( + getObjectLegalHold( args: GetObjectLegalHoldCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetObjectLegalHoldCommandOutput) => void ): void; - public getObjectLegalHold( - args: GetObjectLegalHoldCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetObjectLegalHoldCommandOutput) => void), - cb?: (err: any, data?: GetObjectLegalHoldCommandOutput) => void - ): Promise | void { - const command = new GetObjectLegalHoldCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock - * configuration will be applied by default to every new object placed in the specified - * bucket. For more information, see Locking Objects.

- *

The following action is related to GetObjectLockConfiguration:

- * + * @see {@link GetObjectLockConfigurationCommand} */ - public getObjectLockConfiguration( + getObjectLockConfiguration( args: GetObjectLockConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getObjectLockConfiguration( + getObjectLockConfiguration( args: GetObjectLockConfigurationCommandInput, cb: (err: any, data?: GetObjectLockConfigurationCommandOutput) => void ): void; - public getObjectLockConfiguration( + getObjectLockConfiguration( args: GetObjectLockConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetObjectLockConfigurationCommandOutput) => void ): void; - public getObjectLockConfiguration( - args: GetObjectLockConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetObjectLockConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetObjectLockConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetObjectLockConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves an object's retention settings. For more information, see Locking - * Objects.

- *

This action is not supported by Amazon S3 on Outposts.

- *

The following action is related to GetObjectRetention:

- * + * @see {@link GetObjectRetentionCommand} */ - public getObjectRetention( + getObjectRetention( args: GetObjectRetentionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getObjectRetention( + getObjectRetention( args: GetObjectRetentionCommandInput, cb: (err: any, data?: GetObjectRetentionCommandOutput) => void ): void; - public getObjectRetention( + getObjectRetention( args: GetObjectRetentionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetObjectRetentionCommandOutput) => void ): void; - public getObjectRetention( - args: GetObjectRetentionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetObjectRetentionCommandOutput) => void), - cb?: (err: any, data?: GetObjectRetentionCommandOutput) => void - ): Promise | void { - const command = new GetObjectRetentionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the tag-set of an object. You send the GET request against the tagging - * subresource associated with the object.

- *

To use this operation, you must have permission to perform the - * s3:GetObjectTagging action. By default, the GET action returns information - * about current version of an object. For a versioned bucket, you can have multiple versions - * of an object in your bucket. To retrieve tags of any other version, use the versionId query - * parameter. You also need permission for the s3:GetObjectVersionTagging - * action.

- *

By default, the bucket owner has this permission and can grant this permission to - * others.

- *

For information about the Amazon S3 object tagging feature, see Object Tagging.

- *

The following actions are related to GetObjectTagging:

- * + * @see {@link GetObjectTaggingCommand} */ - public getObjectTagging( + getObjectTagging( args: GetObjectTaggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public getObjectTagging( + getObjectTagging( args: GetObjectTaggingCommandInput, cb: (err: any, data?: GetObjectTaggingCommandOutput) => void ): void; - public getObjectTagging( + getObjectTagging( args: GetObjectTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetObjectTaggingCommandOutput) => void ): void; - public getObjectTagging( - args: GetObjectTaggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetObjectTaggingCommandOutput) => void), - cb?: (err: any, data?: GetObjectTaggingCommandOutput) => void - ): Promise | void { - const command = new GetObjectTaggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're - * distributing large files.

- * - *

You can get torrent only for objects that are less than 5 GB in size, and that are - * not encrypted using server-side encryption with a customer-provided encryption - * key.

- *
- *

To use GET, you must have READ access to the object.

- *

This action is not supported by Amazon S3 on Outposts.

- *

The following action is related to GetObjectTorrent:

- * + * @see {@link GetObjectTorrentCommand} */ - public getObjectTorrent( + getObjectTorrent( args: GetObjectTorrentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getObjectTorrent( + getObjectTorrent( args: GetObjectTorrentCommandInput, cb: (err: any, data?: GetObjectTorrentCommandOutput) => void ): void; - public getObjectTorrent( + getObjectTorrent( args: GetObjectTorrentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetObjectTorrentCommandOutput) => void ): void; - public getObjectTorrent( - args: GetObjectTorrentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetObjectTorrentCommandOutput) => void), - cb?: (err: any, data?: GetObjectTorrentCommandOutput) => void - ): Promise | void { - const command = new GetObjectTorrentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use - * this operation, you must have the s3:GetBucketPublicAccessBlock permission. - * For more information about Amazon S3 permissions, see Specifying Permissions in a - * Policy.

- * - *

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or - * an object, it checks the PublicAccessBlock configuration for both the - * bucket (or the bucket that contains the object) and the bucket owner's account. If the - * PublicAccessBlock settings are different between the bucket and the - * account, Amazon S3 uses the most restrictive combination of the bucket-level and - * account-level settings.

- *
- *

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public".

- *

The following operations are related to GetPublicAccessBlock:

- * + * @see {@link GetPublicAccessBlockCommand} */ - public getPublicAccessBlock( + getPublicAccessBlock( args: GetPublicAccessBlockCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPublicAccessBlock( + getPublicAccessBlock( args: GetPublicAccessBlockCommandInput, cb: (err: any, data?: GetPublicAccessBlockCommandOutput) => void ): void; - public getPublicAccessBlock( + getPublicAccessBlock( args: GetPublicAccessBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPublicAccessBlockCommandOutput) => void ): void; - public getPublicAccessBlock( - args: GetPublicAccessBlockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPublicAccessBlockCommandOutput) => void), - cb?: (err: any, data?: GetPublicAccessBlockCommandOutput) => void - ): Promise | void { - const command = new GetPublicAccessBlockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This action is useful to determine if a bucket exists and you have permission to access - * it. The action returns a 200 OK if the bucket exists and you have permission - * to access it.

- *

If the bucket does not exist or you do not have permission to access it, the - * HEAD request returns a generic 400 Bad Request, 403 - * Forbidden or 404 Not Found code. A message body is not included, so - * you cannot determine the exception beyond these error codes.

- *

To use this operation, you must have permissions to perform the - * s3:ListBucket action. The bucket owner has this permission by default and - * can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

To use this API against an access point, you must provide the alias of the access point in place of the - * bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to - * the access point hostname. The access point hostname takes the form - * AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using the Amazon Web Services SDKs, - * you provide the ARN in place of the bucket name. For more information see, Using - * access points.

+ * @see {@link HeadBucketCommand} */ - public headBucket(args: HeadBucketCommandInput, options?: __HttpHandlerOptions): Promise; - public headBucket(args: HeadBucketCommandInput, cb: (err: any, data?: HeadBucketCommandOutput) => void): void; - public headBucket( + headBucket(args: HeadBucketCommandInput, options?: __HttpHandlerOptions): Promise; + headBucket(args: HeadBucketCommandInput, cb: (err: any, data?: HeadBucketCommandOutput) => void): void; + headBucket( args: HeadBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HeadBucketCommandOutput) => void ): void; - public headBucket( - args: HeadBucketCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HeadBucketCommandOutput) => void), - cb?: (err: any, data?: HeadBucketCommandOutput) => void - ): Promise | void { - const command = new HeadBucketCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The HEAD action retrieves metadata from an object without returning the object itself. - * This action is useful if you're only interested in an object's metadata. To use HEAD, you - * must have READ access to the object.

- *

A HEAD request has the same options as a GET action on an - * object. The response is identical to the GET response except that there is no - * response body. Because of this, if the HEAD request generates an error, it - * returns a generic 400 Bad Request, 403 Forbidden or 404 Not - * Found code. It is not possible to retrieve the exact exception beyond these error - * codes.

- *

If you encrypt an object by using server-side encryption with customer-provided - * encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the - * metadata from the object, you must use the following headers:

- *
    - *
  • - *

    x-amz-server-side-encryption-customer-algorithm

    - *
  • - *
  • - *

    x-amz-server-side-encryption-customer-key

    - *
  • - *
  • - *

    x-amz-server-side-encryption-customer-key-MD5

    - *
  • - *
- *

For more information about SSE-C, see Server-Side Encryption - * (Using Customer-Provided Encryption Keys).

- * - *
    - *
  • - *

    Encryption request headers, like x-amz-server-side-encryption, - * should not be sent for GET requests if your object uses server-side encryption - * with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption - * keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 - * BadRequest error.

    - *
  • - *
  • - *

    The last modified property in this case is the creation date of the - * object.

    - *
  • - *
- *
- *

Request headers are limited to 8 KB in size. For more information, see Common - * Request Headers.

- *

Consider the following when using request headers:

- *
    - *
  • - *

    Consideration 1 – If both of the If-Match and - * If-Unmodified-Since headers are present in the request as - * follows:

    - *
      - *
    • - *

      - * If-Match condition evaluates to true, and;

      - *
    • - *
    • - *

      - * If-Unmodified-Since condition evaluates to - * false;

      - *
    • - *
    - *

    Then Amazon S3 returns 200 OK and the data requested.

    - *
  • - *
  • - *

    Consideration 2 – If both of the If-None-Match and - * If-Modified-Since headers are present in the request as - * follows:

    - *
      - *
    • - *

      - * If-None-Match condition evaluates to false, - * and;

      - *
    • - *
    • - *

      - * If-Modified-Since condition evaluates to - * true;

      - *
    • - *
    - *

    Then Amazon S3 returns the 304 Not Modified response code.

    - *
  • - *
- *

For more information about conditional requests, see RFC 7232.

- *

- * Permissions - *

- *

You need the relevant read object (or version) permission for this operation. For more - * information, see Specifying Permissions in a - * Policy. If the object you request does not exist, the error Amazon S3 returns depends - * on whether you also have the s3:ListBucket permission.

- *
    - *
  • - *

    If you have the s3:ListBucket permission on the bucket, Amazon S3 returns - * an HTTP status code 404 ("no such key") error.

    - *
  • - *
  • - *

    If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP - * status code 403 ("access denied") error.

    - *
  • - *
- *

The following actions are related to HeadObject:

- * + * @see {@link HeadObjectCommand} */ - public headObject(args: HeadObjectCommandInput, options?: __HttpHandlerOptions): Promise; - public headObject(args: HeadObjectCommandInput, cb: (err: any, data?: HeadObjectCommandOutput) => void): void; - public headObject( + headObject(args: HeadObjectCommandInput, options?: __HttpHandlerOptions): Promise; + headObject(args: HeadObjectCommandInput, cb: (err: any, data?: HeadObjectCommandOutput) => void): void; + headObject( args: HeadObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HeadObjectCommandOutput) => void ): void; - public headObject( - args: HeadObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HeadObjectCommandOutput) => void), - cb?: (err: any, data?: HeadObjectCommandOutput) => void - ): Promise | void { - const command = new HeadObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the analytics configurations for the bucket. You can have up to 1,000 analytics - * configurations per bucket.

- *

This action supports list pagination and does not return more than 100 configurations at - * a time. You should always check the IsTruncated element in the response. If - * there are no more configurations to list, IsTruncated is set to false. If - * there are more configurations to list, IsTruncated is set to true, and there - * will be a value in NextContinuationToken. You use the - * NextContinuationToken value to continue the pagination of the list by - * passing the value in continuation-token in the request to GET the next - * page.

- *

To use this operation, you must have permissions to perform the - * s3:GetAnalyticsConfiguration action. The bucket owner has this permission - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class - * Analysis.

- *

The following operations are related to - * ListBucketAnalyticsConfigurations:

- * + * @see {@link ListBucketAnalyticsConfigurationsCommand} */ - public listBucketAnalyticsConfigurations( + listBucketAnalyticsConfigurations( args: ListBucketAnalyticsConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBucketAnalyticsConfigurations( + listBucketAnalyticsConfigurations( args: ListBucketAnalyticsConfigurationsCommandInput, cb: (err: any, data?: ListBucketAnalyticsConfigurationsCommandOutput) => void ): void; - public listBucketAnalyticsConfigurations( + listBucketAnalyticsConfigurations( args: ListBucketAnalyticsConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBucketAnalyticsConfigurationsCommandOutput) => void ): void; - public listBucketAnalyticsConfigurations( - args: ListBucketAnalyticsConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBucketAnalyticsConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListBucketAnalyticsConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListBucketAnalyticsConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the S3 Intelligent-Tiering configuration from the specified bucket.

- *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

- *

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

- *

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

- *

Operations related to ListBucketIntelligentTieringConfigurations include:

- * + * @see {@link ListBucketIntelligentTieringConfigurationsCommand} */ - public listBucketIntelligentTieringConfigurations( + listBucketIntelligentTieringConfigurations( args: ListBucketIntelligentTieringConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBucketIntelligentTieringConfigurations( + listBucketIntelligentTieringConfigurations( args: ListBucketIntelligentTieringConfigurationsCommandInput, cb: (err: any, data?: ListBucketIntelligentTieringConfigurationsCommandOutput) => void ): void; - public listBucketIntelligentTieringConfigurations( + listBucketIntelligentTieringConfigurations( args: ListBucketIntelligentTieringConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBucketIntelligentTieringConfigurationsCommandOutput) => void ): void; - public listBucketIntelligentTieringConfigurations( - args: ListBucketIntelligentTieringConfigurationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListBucketIntelligentTieringConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListBucketIntelligentTieringConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListBucketIntelligentTieringConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of inventory configurations for the bucket. You can have up to 1,000 - * analytics configurations per bucket.

- *

This action supports list pagination and does not return more than 100 configurations at - * a time. Always check the IsTruncated element in the response. If there are no - * more configurations to list, IsTruncated is set to false. If there are more - * configurations to list, IsTruncated is set to true, and there is a value in - * NextContinuationToken. You use the NextContinuationToken value - * to continue the pagination of the list by passing the value in continuation-token in the - * request to GET the next page.

- *

To use this operation, you must have permissions to perform the - * s3:GetInventoryConfiguration action. The bucket owner has this permission - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory - *

- *

The following operations are related to - * ListBucketInventoryConfigurations:

- * + * @see {@link ListBucketInventoryConfigurationsCommand} */ - public listBucketInventoryConfigurations( + listBucketInventoryConfigurations( args: ListBucketInventoryConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBucketInventoryConfigurations( + listBucketInventoryConfigurations( args: ListBucketInventoryConfigurationsCommandInput, cb: (err: any, data?: ListBucketInventoryConfigurationsCommandOutput) => void ): void; - public listBucketInventoryConfigurations( + listBucketInventoryConfigurations( args: ListBucketInventoryConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBucketInventoryConfigurationsCommandOutput) => void ): void; - public listBucketInventoryConfigurations( - args: ListBucketInventoryConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBucketInventoryConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListBucketInventoryConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListBucketInventoryConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the metrics configurations for the bucket. The metrics configurations are only for - * the request metrics of the bucket and do not provide information on daily storage metrics. - * You can have up to 1,000 configurations per bucket.

- *

This action supports list pagination and does not return more than 100 configurations at - * a time. Always check the IsTruncated element in the response. If there are no - * more configurations to list, IsTruncated is set to false. If there are more - * configurations to list, IsTruncated is set to true, and there is a value in - * NextContinuationToken. You use the NextContinuationToken value - * to continue the pagination of the list by passing the value in - * continuation-token in the request to GET the next page.

- *

To use this operation, you must have permissions to perform the - * s3:GetMetricsConfiguration action. The bucket owner has this permission by - * default. The bucket owner can grant this permission to others. For more information about - * permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

For more information about metrics configurations and CloudWatch request metrics, see - * Monitoring Metrics with Amazon CloudWatch.

- *

The following operations are related to - * ListBucketMetricsConfigurations:

- * + * @see {@link ListBucketMetricsConfigurationsCommand} */ - public listBucketMetricsConfigurations( + listBucketMetricsConfigurations( args: ListBucketMetricsConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBucketMetricsConfigurations( + listBucketMetricsConfigurations( args: ListBucketMetricsConfigurationsCommandInput, cb: (err: any, data?: ListBucketMetricsConfigurationsCommandOutput) => void ): void; - public listBucketMetricsConfigurations( + listBucketMetricsConfigurations( args: ListBucketMetricsConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBucketMetricsConfigurationsCommandOutput) => void ): void; - public listBucketMetricsConfigurations( - args: ListBucketMetricsConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBucketMetricsConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListBucketMetricsConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListBucketMetricsConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all buckets owned by the authenticated sender of the request. To use - * this operation, you must have the s3:ListAllMyBuckets permission.

- *

For information about Amazon S3 buckets, see Creating, configuring, and - * working with Amazon S3 buckets.

+ * @see {@link ListBucketsCommand} */ - public listBuckets(args: ListBucketsCommandInput, options?: __HttpHandlerOptions): Promise; - public listBuckets(args: ListBucketsCommandInput, cb: (err: any, data?: ListBucketsCommandOutput) => void): void; - public listBuckets( + listBuckets(args: ListBucketsCommandInput, options?: __HttpHandlerOptions): Promise; + listBuckets(args: ListBucketsCommandInput, cb: (err: any, data?: ListBucketsCommandOutput) => void): void; + listBuckets( args: ListBucketsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBucketsCommandOutput) => void ): void; - public listBuckets( - args: ListBucketsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBucketsCommandOutput) => void), - cb?: (err: any, data?: ListBucketsCommandOutput) => void - ): Promise | void { - const command = new ListBucketsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This action lists in-progress multipart uploads. An in-progress multipart upload is a - * multipart upload that has been initiated using the Initiate Multipart Upload request, but - * has not yet been completed or aborted.

- *

This action returns at most 1,000 multipart uploads in the response. 1,000 multipart - * uploads is the maximum number of uploads a response can include, which is also the default - * value. You can further limit the number of uploads in a response by specifying the - * max-uploads parameter in the response. If additional multipart uploads - * satisfy the list criteria, the response will contain an IsTruncated element - * with the value true. To list the additional multipart uploads, use the - * key-marker and upload-id-marker request parameters.

- *

In the response, the uploads are sorted by key. If your application has initiated more - * than one multipart upload using the same object key, then uploads in the response are first - * sorted by key. Additionally, uploads are sorted in ascending order within each key by the - * upload initiation time.

- *

For more information on multipart uploads, see Uploading Objects Using Multipart - * Upload.

- *

For information on permissions required to use the multipart upload API, see Multipart Upload - * and Permissions.

- *

The following operations are related to ListMultipartUploads:

- * + * @see {@link ListMultipartUploadsCommand} */ - public listMultipartUploads( + listMultipartUploads( args: ListMultipartUploadsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMultipartUploads( + listMultipartUploads( args: ListMultipartUploadsCommandInput, cb: (err: any, data?: ListMultipartUploadsCommandOutput) => void ): void; - public listMultipartUploads( + listMultipartUploads( args: ListMultipartUploadsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMultipartUploadsCommandOutput) => void ): void; - public listMultipartUploads( - args: ListMultipartUploadsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMultipartUploadsCommandOutput) => void), - cb?: (err: any, data?: ListMultipartUploadsCommandOutput) => void - ): Promise | void { - const command = new ListMultipartUploadsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns some or all (up to 1,000) of the objects in a bucket. You can use the request - * parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK - * response can contain valid or invalid XML. Be sure to design your application to parse the - * contents of the response and handle it appropriately.

- * - *

This action has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, - * Amazon S3 continues to support ListObjects.

- *
- *

The following operations are related to ListObjects:

- * + * @see {@link ListObjectsCommand} */ - public listObjects(args: ListObjectsCommandInput, options?: __HttpHandlerOptions): Promise; - public listObjects(args: ListObjectsCommandInput, cb: (err: any, data?: ListObjectsCommandOutput) => void): void; - public listObjects( + listObjects(args: ListObjectsCommandInput, options?: __HttpHandlerOptions): Promise; + listObjects(args: ListObjectsCommandInput, cb: (err: any, data?: ListObjectsCommandOutput) => void): void; + listObjects( args: ListObjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListObjectsCommandOutput) => void ): void; - public listObjects( - args: ListObjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListObjectsCommandOutput) => void), - cb?: (err: any, data?: ListObjectsCommandOutput) => void - ): Promise | void { - const command = new ListObjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns some or all (up to 1,000) of the objects in a bucket with each request. You can - * use the request parameters as selection criteria to return a subset of the objects in a - * bucket. A 200 OK response can contain valid or invalid XML. Make sure to - * design your application to parse the contents of the response and handle it appropriately. - * Objects are returned sorted in an ascending order of the respective key names in the list. - * For more information about listing objects, see Listing object keys - * programmatically - *

- *

To use this operation, you must have READ access to the bucket.

- *

To use this action in an Identity and Access Management (IAM) policy, you must have permissions to perform - * the s3:ListBucket action. The bucket owner has this permission by default and - * can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- * - *

This section describes the latest revision of this action. We recommend that you use - * this revised API for application development. For backward compatibility, Amazon S3 continues - * to support the prior version of this API, ListObjects.

- *
- *

To get a list of your buckets, see ListBuckets.

- *

The following operations are related to ListObjectsV2:

- * + * @see {@link ListObjectsV2Command} */ - public listObjectsV2( - args: ListObjectsV2CommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listObjectsV2( - args: ListObjectsV2CommandInput, - cb: (err: any, data?: ListObjectsV2CommandOutput) => void - ): void; - public listObjectsV2( + listObjectsV2(args: ListObjectsV2CommandInput, options?: __HttpHandlerOptions): Promise; + listObjectsV2(args: ListObjectsV2CommandInput, cb: (err: any, data?: ListObjectsV2CommandOutput) => void): void; + listObjectsV2( args: ListObjectsV2CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListObjectsV2CommandOutput) => void ): void; - public listObjectsV2( - args: ListObjectsV2CommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListObjectsV2CommandOutput) => void), - cb?: (err: any, data?: ListObjectsV2CommandOutput) => void - ): Promise | void { - const command = new ListObjectsV2Command(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns metadata about all versions of the objects in a bucket. You can also use request - * parameters as selection criteria to return metadata about a subset of all the object - * versions.

- * - *

To use this operation, you must have permissions to perform the - * s3:ListBucketVersions action. Be aware of the name difference.

- *
- * - *

A 200 OK response can contain valid or invalid XML. Make sure to design your - * application to parse the contents of the response and handle it appropriately.

- *
- *

To use this operation, you must have READ access to the bucket.

- *

This action is not supported by Amazon S3 on Outposts.

- *

The following operations are related to ListObjectVersions:

- * + * @see {@link ListObjectVersionsCommand} */ - public listObjectVersions( + listObjectVersions( args: ListObjectVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listObjectVersions( + listObjectVersions( args: ListObjectVersionsCommandInput, cb: (err: any, data?: ListObjectVersionsCommandOutput) => void ): void; - public listObjectVersions( + listObjectVersions( args: ListObjectVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListObjectVersionsCommandOutput) => void ): void; - public listObjectVersions( - args: ListObjectVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListObjectVersionsCommandOutput) => void), - cb?: (err: any, data?: ListObjectVersionsCommandOutput) => void - ): Promise | void { - const command = new ListObjectVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the parts that have been uploaded for a specific multipart upload. This operation - * must include the upload ID, which you obtain by sending the initiate multipart upload - * request (see CreateMultipartUpload). - * This request returns a maximum of 1,000 uploaded parts. The default number of parts - * returned is 1,000 parts. You can restrict the number of parts returned by specifying the - * max-parts request parameter. If your multipart upload consists of more than - * 1,000 parts, the response returns an IsTruncated field with the value of true, - * and a NextPartNumberMarker element. In subsequent ListParts - * requests you can include the part-number-marker query string parameter and set its value to - * the NextPartNumberMarker field value from the previous response.

- *

If the upload was created using a checksum algorithm, you will need to have permission - * to the kms:Decrypt action for the request to succeed.

- *

For more information on multipart uploads, see Uploading Objects Using Multipart - * Upload.

- *

For information on permissions required to use the multipart upload API, see Multipart Upload - * and Permissions.

- *

The following operations are related to ListParts:

- * + * @see {@link ListPartsCommand} */ - public listParts(args: ListPartsCommandInput, options?: __HttpHandlerOptions): Promise; - public listParts(args: ListPartsCommandInput, cb: (err: any, data?: ListPartsCommandOutput) => void): void; - public listParts( + listParts(args: ListPartsCommandInput, options?: __HttpHandlerOptions): Promise; + listParts(args: ListPartsCommandInput, cb: (err: any, data?: ListPartsCommandOutput) => void): void; + listParts( args: ListPartsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPartsCommandOutput) => void ): void; - public listParts( - args: ListPartsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPartsCommandOutput) => void), - cb?: (err: any, data?: ListPartsCommandOutput) => void - ): Promise | void { - const command = new ListPartsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a - * bucket-level feature that enables you to perform faster data transfers to Amazon S3.

- *

To use this operation, you must have permission to perform the - * s3:PutAccelerateConfiguration action. The bucket owner has this permission - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

The Transfer Acceleration state of a bucket can be set to one of the following two - * values:

- *
    - *
  • - *

    Enabled – Enables accelerated data transfers to the bucket.

    - *
  • - *
  • - *

    Suspended – Disables accelerated data transfers to the bucket.

    - *
  • - *
- *

The GetBucketAccelerateConfiguration action returns the transfer acceleration state - * of a bucket.

- *

After setting the Transfer Acceleration state of a bucket to Enabled, it might take up - * to thirty minutes before the data transfer rates to the bucket increase.

- *

The name of the bucket used for Transfer Acceleration must be DNS-compliant and must - * not contain periods (".").

- *

For more information about transfer acceleration, see Transfer - * Acceleration.

- *

The following operations are related to - * PutBucketAccelerateConfiguration:

- * + * @see {@link PutBucketAccelerateConfigurationCommand} */ - public putBucketAccelerateConfiguration( + putBucketAccelerateConfiguration( args: PutBucketAccelerateConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketAccelerateConfiguration( + putBucketAccelerateConfiguration( args: PutBucketAccelerateConfigurationCommandInput, cb: (err: any, data?: PutBucketAccelerateConfigurationCommandOutput) => void ): void; - public putBucketAccelerateConfiguration( + putBucketAccelerateConfiguration( args: PutBucketAccelerateConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketAccelerateConfigurationCommandOutput) => void ): void; - public putBucketAccelerateConfiguration( - args: PutBucketAccelerateConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketAccelerateConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutBucketAccelerateConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutBucketAccelerateConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the permissions on an existing bucket using access control lists (ACL). For more - * information, see Using ACLs. To set the ACL of a - * bucket, you must have WRITE_ACP permission.

- *

You can use one of the following two ways to set a bucket's permissions:

- *
    - *
  • - *

    Specify the ACL in the request body

    - *
  • - *
  • - *

    Specify permissions using request headers

    - *
  • - *
- * - *

You cannot specify access permission using both the body and the request - * headers.

- *
- *

Depending on your application needs, you may choose to set the ACL on a bucket using - * either the request body or the headers. For example, if you have an existing application - * that updates a bucket ACL using the request body, then you can continue to use that - * approach.

- * - *

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs - * are disabled and no longer affect permissions. You must use policies to grant access to - * your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return - * the AccessControlListNotSupported error code. Requests to read ACLs are - * still supported. For more information, see Controlling object - * ownership in the Amazon S3 User Guide.

- *
- *

- * Access Permissions - *

- *

You can set access permissions using one of the following methods:

- *
    - *
  • - *

    Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports - * a set of predefined ACLs, known as canned ACLs. Each canned ACL - * has a predefined set of grantees and permissions. Specify the canned ACL name as the - * value of x-amz-acl. If you use this header, you cannot use other access - * control-specific headers in your request. For more information, see Canned - * ACL.

    - *
  • - *
  • - *

    Specify access permissions explicitly with the x-amz-grant-read, - * x-amz-grant-read-acp, x-amz-grant-write-acp, and - * x-amz-grant-full-control headers. When using these headers, you - * specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who - * will receive the permission. If you use these ACL-specific headers, you cannot use - * the x-amz-acl header to set a canned ACL. These parameters map to the - * set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control - * List (ACL) Overview.

    - *

    You specify each grantee as a type=value pair, where the type is one of the - * following:

    - *
      - *
    • - *

      - * id – if the value specified is the canonical user ID of an - * Amazon Web Services account

      - *
    • - *
    • - *

      - * uri – if you are granting permissions to a predefined - * group

      - *
    • - *
    • - *

      - * emailAddress – if the value specified is the email address of - * an Amazon Web Services account

      - * - *

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      - *
        - *
      • - *

        US East (N. Virginia)

        - *
      • - *
      • - *

        US West (N. California)

        - *
      • - *
      • - *

        US West (Oregon)

        - *
      • - *
      • - *

        Asia Pacific (Singapore)

        - *
      • - *
      • - *

        Asia Pacific (Sydney)

        - *
      • - *
      • - *

        Asia Pacific (Tokyo)

        - *
      • - *
      • - *

        Europe (Ireland)

        - *
      • - *
      • - *

        South America (São Paulo)

        - *
      • - *
      - *

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      - *
      - *
    • - *
    - *

    For example, the following x-amz-grant-write header grants create, - * overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and - * two Amazon Web Services accounts identified by their email addresses.

    - *

    - * x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", - * id="111122223333", id="555566667777" - *

    - *
  • - *
- *

You can use either a canned ACL or specify access permissions explicitly. You cannot do - * both.

- *

- * Grantee Values - *

- *

You can specify the person (grantee) to whom you're assigning access rights (using - * request elements) in the following ways:

- *
    - *
  • - *

    By the person's ID:

    - *

    - * <>ID<><>GranteesEmail<> - * - *

    - *

    DisplayName is optional and ignored in the request

    - *
  • - *
  • - *

    By URI:

    - *

    - * <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> - *

    - *
  • - *
  • - *

    By Email address:

    - *

    - * <>Grantees@email.com<>& - *

    - *

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object - * acl request, appears as the CanonicalUser.

    - * - *

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    - *
      - *
    • - *

      US East (N. Virginia)

      - *
    • - *
    • - *

      US West (N. California)

      - *
    • - *
    • - *

      US West (Oregon)

      - *
    • - *
    • - *

      Asia Pacific (Singapore)

      - *
    • - *
    • - *

      Asia Pacific (Sydney)

      - *
    • - *
    • - *

      Asia Pacific (Tokyo)

      - *
    • - *
    • - *

      Europe (Ireland)

      - *
    • - *
    • - *

      South America (São Paulo)

      - *
    • - *
    - *

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    - *
    - *
  • - *
- *

- * Related Resources - *

- * + * @see {@link PutBucketAclCommand} */ - public putBucketAcl( - args: PutBucketAclCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putBucketAcl(args: PutBucketAclCommandInput, cb: (err: any, data?: PutBucketAclCommandOutput) => void): void; - public putBucketAcl( + putBucketAcl(args: PutBucketAclCommandInput, options?: __HttpHandlerOptions): Promise; + putBucketAcl(args: PutBucketAclCommandInput, cb: (err: any, data?: PutBucketAclCommandOutput) => void): void; + putBucketAcl( args: PutBucketAclCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketAclCommandOutput) => void ): void; - public putBucketAcl( - args: PutBucketAclCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketAclCommandOutput) => void), - cb?: (err: any, data?: PutBucketAclCommandOutput) => void - ): Promise | void { - const command = new PutBucketAclCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets an analytics configuration for the bucket (specified by the analytics configuration - * ID). You can have up to 1,000 analytics configurations per bucket.

- *

You can choose to have storage class analysis export analysis reports sent to a - * comma-separated values (CSV) flat file. See the DataExport request element. - * Reports are updated daily and are based on the object filters that you configure. When - * selecting data export, you specify a destination bucket and an optional destination prefix - * where the file is written. You can export the data to a destination bucket in a different - * account. However, the destination bucket must be in the same Region as the bucket that you - * are making the PUT analytics configuration to. For more information, see Amazon S3 - * Analytics – Storage Class Analysis.

- * - *

You must create a bucket policy on the destination bucket where the exported file is - * written to grant permissions to Amazon S3 to write objects to the bucket. For an example - * policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

- *
- *

To use this operation, you must have permissions to perform the - * s3:PutAnalyticsConfiguration action. The bucket owner has this permission - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

- * Special Errors - *

- *
    - *
  • - *
      - *
    • - *

      - * HTTP Error: HTTP 400 Bad Request - *

      - *
    • - *
    • - *

      - * Code: InvalidArgument - *

      - *
    • - *
    • - *

      - * Cause: Invalid argument. - *

      - *
    • - *
    - *
  • - *
  • - *
      - *
    • - *

      - * HTTP Error: HTTP 400 Bad Request - *

      - *
    • - *
    • - *

      - * Code: TooManyConfigurations - *

      - *
    • - *
    • - *

      - * Cause: You are attempting to create a new configuration but have - * already reached the 1,000-configuration limit. - *

      - *
    • - *
    - *
  • - *
  • - *
      - *
    • - *

      - * HTTP Error: HTTP 403 Forbidden - *

      - *
    • - *
    • - *

      - * Code: AccessDenied - *

      - *
    • - *
    • - *

      - * Cause: You are not the owner of the specified bucket, or you do - * not have the s3:PutAnalyticsConfiguration bucket permission to set the - * configuration on the bucket. - *

      - *
    • - *
    - *
  • - *
- *

- * Related Resources - *

- * + * @see {@link PutBucketAnalyticsConfigurationCommand} */ - public putBucketAnalyticsConfiguration( + putBucketAnalyticsConfiguration( args: PutBucketAnalyticsConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketAnalyticsConfiguration( + putBucketAnalyticsConfiguration( args: PutBucketAnalyticsConfigurationCommandInput, cb: (err: any, data?: PutBucketAnalyticsConfigurationCommandOutput) => void ): void; - public putBucketAnalyticsConfiguration( + putBucketAnalyticsConfiguration( args: PutBucketAnalyticsConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketAnalyticsConfigurationCommandOutput) => void ): void; - public putBucketAnalyticsConfiguration( - args: PutBucketAnalyticsConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketAnalyticsConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutBucketAnalyticsConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutBucketAnalyticsConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the cors configuration for your bucket. If the configuration exists, - * Amazon S3 replaces it.

- *

To use this operation, you must be allowed to perform the s3:PutBucketCORS - * action. By default, the bucket owner has this permission and can grant it to others.

- *

You set this configuration on a bucket so that the bucket can service cross-origin - * requests. For example, you might want to enable a request whose origin is - * http://www.example.com to access your Amazon S3 bucket at - * my.example.bucket.com by using the browser's XMLHttpRequest - * capability.

- *

To enable cross-origin resource sharing (CORS) on a bucket, you add the - * cors subresource to the bucket. The cors subresource is an XML - * document in which you configure rules that identify origins and the HTTP methods that can - * be executed on your bucket. The document is limited to 64 KB in size.

- *

When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a - * bucket, it evaluates the cors configuration on the bucket and uses the first - * CORSRule rule that matches the incoming browser request to enable a - * cross-origin request. For a rule to match, the following conditions must be met:

- *
    - *
  • - *

    The request's Origin header must match AllowedOrigin - * elements.

    - *
  • - *
  • - *

    The request method (for example, GET, PUT, HEAD, and so on) or the - * Access-Control-Request-Method header in case of a pre-flight - * OPTIONS request must be one of the AllowedMethod - * elements.

    - *
  • - *
  • - *

    Every header specified in the Access-Control-Request-Headers request - * header of a pre-flight request must match an AllowedHeader element. - *

    - *
  • - *
- *

For more information about CORS, go to Enabling Cross-Origin Resource Sharing in - * the Amazon S3 User Guide.

- *

- * Related Resources - *

- * + * @see {@link PutBucketCorsCommand} */ - public putBucketCors( - args: PutBucketCorsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putBucketCors( - args: PutBucketCorsCommandInput, - cb: (err: any, data?: PutBucketCorsCommandOutput) => void - ): void; - public putBucketCors( + putBucketCors(args: PutBucketCorsCommandInput, options?: __HttpHandlerOptions): Promise; + putBucketCors(args: PutBucketCorsCommandInput, cb: (err: any, data?: PutBucketCorsCommandOutput) => void): void; + putBucketCors( args: PutBucketCorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketCorsCommandOutput) => void ): void; - public putBucketCors( - args: PutBucketCorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketCorsCommandOutput) => void), - cb?: (err: any, data?: PutBucketCorsCommandOutput) => void - ): Promise | void { - const command = new PutBucketCorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This action uses the encryption subresource to configure default encryption - * and Amazon S3 Bucket Keys for an existing bucket.

- *

By default, all buckets have a default encryption configuration that - * uses server-side encryption with Amazon S3 managed keys (SSE-S3). - * You can optionally configure default encryption for a bucket by using server-side - * encryption with an Amazon Web Services KMS key (SSE-KMS) or a customer-provided key (SSE-C). If you specify default encryption by using - * SSE-KMS, you can also configure Amazon S3 Bucket Keys. For information about bucket default encryption, - * see Amazon S3 - * bucket default encryption in the Amazon S3 User Guide. For more - * information about S3 Bucket Keys, see Amazon S3 Bucket Keys in the - * Amazon S3 User Guide.

- * - *

This action requires Amazon Web Services Signature Version 4. For more information, see - * Authenticating Requests (Amazon Web Services Signature Version 4).

- *
- *

To use this operation, you must have permissions to perform the - * s3:PutEncryptionConfiguration action. The bucket owner has this permission - * by default. The bucket owner can grant this permission to others. For more information - * about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources in the - * Amazon S3 User Guide.

- *

- * Related Resources - *

- * + * @see {@link PutBucketEncryptionCommand} */ - public putBucketEncryption( + putBucketEncryption( args: PutBucketEncryptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketEncryption( + putBucketEncryption( args: PutBucketEncryptionCommandInput, cb: (err: any, data?: PutBucketEncryptionCommandOutput) => void ): void; - public putBucketEncryption( + putBucketEncryption( args: PutBucketEncryptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketEncryptionCommandOutput) => void ): void; - public putBucketEncryption( - args: PutBucketEncryptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketEncryptionCommandOutput) => void), - cb?: (err: any, data?: PutBucketEncryptionCommandOutput) => void - ): Promise | void { - const command = new PutBucketEncryptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to - * 1,000 S3 Intelligent-Tiering configurations per bucket.

- *

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

- *

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

- *

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

- *

Operations related to PutBucketIntelligentTieringConfiguration include:

- * - * - *

You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically - * move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access - * or Deep Archive Access tier.

- *
- *

- * Special Errors - *

- *
    - *
  • - *

    - * HTTP 400 Bad Request Error - *

    - *
      - *
    • - *

      - * Code: InvalidArgument

      - *
    • - *
    • - *

      - * Cause: Invalid Argument

      - *
    • - *
    - *
  • - *
  • - *

    - * HTTP 400 Bad Request Error - *

    - *
      - *
    • - *

      - * Code: TooManyConfigurations

      - *
    • - *
    • - *

      - * Cause: You are attempting to create a new configuration - * but have already reached the 1,000-configuration limit.

      - *
    • - *
    - *
  • - *
  • - *

    - * HTTP 403 Forbidden Error - *

    - *
      - *
    • - *

      - * Code: AccessDenied

      - *
    • - *
    • - *

      - * Cause: You are not the owner of the specified bucket, - * or you do not have the s3:PutIntelligentTieringConfiguration - * bucket permission to set the configuration on the bucket.

      - *
    • - *
    - *
  • - *
+ * @see {@link PutBucketIntelligentTieringConfigurationCommand} */ - public putBucketIntelligentTieringConfiguration( + putBucketIntelligentTieringConfiguration( args: PutBucketIntelligentTieringConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketIntelligentTieringConfiguration( + putBucketIntelligentTieringConfiguration( args: PutBucketIntelligentTieringConfigurationCommandInput, cb: (err: any, data?: PutBucketIntelligentTieringConfigurationCommandOutput) => void ): void; - public putBucketIntelligentTieringConfiguration( + putBucketIntelligentTieringConfiguration( args: PutBucketIntelligentTieringConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketIntelligentTieringConfigurationCommandOutput) => void ): void; - public putBucketIntelligentTieringConfiguration( - args: PutBucketIntelligentTieringConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PutBucketIntelligentTieringConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutBucketIntelligentTieringConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutBucketIntelligentTieringConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This implementation of the PUT action adds an inventory configuration - * (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory - * configurations per bucket.

- *

Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly - * basis, and the results are published to a flat file. The bucket that is inventoried is - * called the source bucket, and the bucket where the inventory flat file - * is stored is called the destination bucket. The - * destination bucket must be in the same Amazon Web Services Region as the - * source bucket.

- *

When you configure an inventory for a source bucket, you specify - * the destination bucket where you want the inventory to be stored, and - * whether to generate the inventory daily or weekly. You can also configure what object - * metadata to include and whether to inventory all object versions or only current versions. - * For more information, see Amazon S3 Inventory in the - * Amazon S3 User Guide.

- * - *

You must create a bucket policy on the destination bucket to - * grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an - * example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

- *
- *

- * Permissions - *

- *

To use this operation, you must have permission to perform the - * s3:PutInventoryConfiguration action. The bucket owner has this permission - * by default and can grant this permission to others.

- *

The s3:PutInventoryConfiguration permission allows a user to create an - * S3 - * Inventory report that includes all object metadata fields available and to - * specify the destination bucket to store the inventory. A user with read access to objects - * in the destination bucket can also access all object metadata fields that are available in - * the inventory report.

- *

To restrict access to an inventory report, see Restricting access to an Amazon S3 Inventory report in the - * Amazon S3 User Guide. For more information about the metadata fields - * available in S3 Inventory, see Amazon S3 - * Inventory lists in the Amazon S3 User Guide. For more - * information about permissions, see Permissions related to bucket subresource operations and Identity and - * access management in Amazon S3 in the Amazon S3 User Guide.

- *

- * Special Errors - *

- *
    - *
  • - *

    - * HTTP 400 Bad Request Error - *

    - *
      - *
    • - *

      - * Code: InvalidArgument

      - *
    • - *
    • - *

      - * Cause: Invalid Argument

      - *
    • - *
    - *
  • - *
  • - *

    - * HTTP 400 Bad Request Error - *

    - *
      - *
    • - *

      - * Code: TooManyConfigurations

      - *
    • - *
    • - *

      - * Cause: You are attempting to create a new configuration - * but have already reached the 1,000-configuration limit.

      - *
    • - *
    - *
  • - *
  • - *

    - * HTTP 403 Forbidden Error - *

    - *
      - *
    • - *

      - * Code: AccessDenied

      - *
    • - *
    • - *

      - * Cause: You are not the owner of the specified bucket, - * or you do not have the s3:PutInventoryConfiguration bucket - * permission to set the configuration on the bucket.

      - *
    • - *
    - *
  • - *
- *

- * Related Resources - *

- * + * @see {@link PutBucketInventoryConfigurationCommand} */ - public putBucketInventoryConfiguration( + putBucketInventoryConfiguration( args: PutBucketInventoryConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketInventoryConfiguration( + putBucketInventoryConfiguration( args: PutBucketInventoryConfigurationCommandInput, cb: (err: any, data?: PutBucketInventoryConfigurationCommandOutput) => void ): void; - public putBucketInventoryConfiguration( + putBucketInventoryConfiguration( args: PutBucketInventoryConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketInventoryConfigurationCommandOutput) => void ): void; - public putBucketInventoryConfiguration( - args: PutBucketInventoryConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketInventoryConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutBucketInventoryConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutBucketInventoryConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle - * configuration. Keep in mind that this will overwrite an existing lifecycle configuration, - * so if you want to retain any configuration details, they must be included in the new - * lifecycle configuration. For information about lifecycle configuration, see Managing - * your storage lifecycle.

- * - *

Bucket lifecycle configuration now supports specifying a lifecycle rule using an - * object key name prefix, one or more object tags, or a combination of both. Accordingly, - * this section describes the latest API. The previous version of the API supported - * filtering based only on an object key name prefix, which is supported for backward - * compatibility. For the related API description, see PutBucketLifecycle.

- *
- *

- * Rules - *

- *

You specify the lifecycle configuration in your request body. The lifecycle - * configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle - * configuration can have up to 1,000 rules. This limit is not adjustable. Each rule consists - * of the following:

- *
    - *
  • - *

    Filter identifying a subset of objects to which the rule applies. The filter can - * be based on a key name prefix, object tags, or a combination of both.

    - *
  • - *
  • - *

    Status whether the rule is in effect.

    - *
  • - *
  • - *

    One or more lifecycle transition and expiration actions that you want Amazon S3 to - * perform on the objects identified by the filter. If the state of your bucket is - * versioning-enabled or versioning-suspended, you can have many versions of the same - * object (one current version and zero or more noncurrent versions). Amazon S3 provides - * predefined actions that you can specify for current and noncurrent object - * versions.

    - *
  • - *
- *

For more information, see Object Lifecycle Management - * and Lifecycle Configuration Elements.

- *

- * Permissions - *

- *

By default, all Amazon S3 resources are private, including buckets, objects, and related - * subresources (for example, lifecycle configuration and website configuration). Only the - * resource owner (that is, the Amazon Web Services account that created it) can access the resource. The - * resource owner can optionally grant access permissions to others by writing an access - * policy. For this operation, a user must get the s3:PutLifecycleConfiguration - * permission.

- *

You can also explicitly deny permissions. Explicit deny also supersedes any other - * permissions. If you want to block users or accounts from removing or deleting objects from - * your bucket, you must deny them permissions for the following actions:

- *
    - *
  • - *

    - * s3:DeleteObject - *

    - *
  • - *
  • - *

    - * s3:DeleteObjectVersion - *

    - *
  • - *
  • - *

    - * s3:PutLifecycleConfiguration - *

    - *
  • - *
- *

For more information about permissions, see Managing Access Permissions to - * Your Amazon S3 Resources.

- *

The following are related to PutBucketLifecycleConfiguration:

- * + * @see {@link PutBucketLifecycleConfigurationCommand} */ - public putBucketLifecycleConfiguration( + putBucketLifecycleConfiguration( args: PutBucketLifecycleConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketLifecycleConfiguration( + putBucketLifecycleConfiguration( args: PutBucketLifecycleConfigurationCommandInput, cb: (err: any, data?: PutBucketLifecycleConfigurationCommandOutput) => void ): void; - public putBucketLifecycleConfiguration( + putBucketLifecycleConfiguration( args: PutBucketLifecycleConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketLifecycleConfigurationCommandOutput) => void ): void; - public putBucketLifecycleConfiguration( - args: PutBucketLifecycleConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketLifecycleConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutBucketLifecycleConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutBucketLifecycleConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Set the logging parameters for a bucket and to specify permissions for who can view and - * modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as - * the source bucket. To set the logging status of a bucket, you must be the bucket - * owner.

- *

The bucket owner is automatically granted FULL_CONTROL to all logs. You use the - * Grantee request element to grant access to other people. The - * Permissions request element specifies the kind of access the grantee has to - * the logs.

- * - *

If the target bucket for log delivery uses the bucket owner enforced setting for S3 - * Object Ownership, you can't use the Grantee request element to grant access - * to others. Permissions can only be granted using policies. For more information, see - * Permissions for server access log delivery in the - * Amazon S3 User Guide.

- *
- *

- * Grantee Values - *

- *

You can specify the person (grantee) to whom you're assigning access rights (using - * request elements) in the following ways:

- *
    - *
  • - *

    By the person's ID:

    - *

    - * <>ID<><>GranteesEmail<> - * - *

    - *

    DisplayName is optional and ignored in the request.

    - *
  • - *
  • - *

    By Email address:

    - *

    - * <>Grantees@email.com<> - *

    - *

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object - * acl request, appears as the CanonicalUser.

    - *
  • - *
  • - *

    By URI:

    - *

    - * <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> - *

    - *
  • - *
- *

To enable logging, you use LoggingEnabled and its children request elements. To disable - * logging, you use an empty BucketLoggingStatus request element:

- *

- * - *

- *

For more information about server access logging, see Server Access Logging in the - * Amazon S3 User Guide.

- *

For more information about creating a bucket, see CreateBucket. For more - * information about returning the logging status of a bucket, see GetBucketLogging.

- *

The following operations are related to PutBucketLogging:

- * + * @see {@link PutBucketLoggingCommand} */ - public putBucketLogging( + putBucketLogging( args: PutBucketLoggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketLogging( + putBucketLogging( args: PutBucketLoggingCommandInput, cb: (err: any, data?: PutBucketLoggingCommandOutput) => void ): void; - public putBucketLogging( + putBucketLogging( args: PutBucketLoggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketLoggingCommandOutput) => void ): void; - public putBucketLogging( - args: PutBucketLoggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketLoggingCommandOutput) => void), - cb?: (err: any, data?: PutBucketLoggingCommandOutput) => void - ): Promise | void { - const command = new PutBucketLoggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. - * You can have up to 1,000 metrics configurations per bucket. If you're updating an existing - * metrics configuration, note that this is a full replacement of the existing metrics - * configuration. If you don't include the elements you want to keep, they are erased.

- *

To use this operation, you must have permissions to perform the - * s3:PutMetricsConfiguration action. The bucket owner has this permission by - * default. The bucket owner can grant this permission to others. For more information about - * permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

For information about CloudWatch request metrics for Amazon S3, see Monitoring - * Metrics with Amazon CloudWatch.

- *

The following operations are related to - * PutBucketMetricsConfiguration:

- * - *

- * GetBucketLifecycle has the following special error:

- *
    - *
  • - *

    Error code: TooManyConfigurations - *

    - *
      - *
    • - *

      Description: You are attempting to create a new configuration but have - * already reached the 1,000-configuration limit.

      - *
    • - *
    • - *

      HTTP Status Code: HTTP 400 Bad Request

      - *
    • - *
    - *
  • - *
+ * @see {@link PutBucketMetricsConfigurationCommand} */ - public putBucketMetricsConfiguration( + putBucketMetricsConfiguration( args: PutBucketMetricsConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketMetricsConfiguration( + putBucketMetricsConfiguration( args: PutBucketMetricsConfigurationCommandInput, cb: (err: any, data?: PutBucketMetricsConfigurationCommandOutput) => void ): void; - public putBucketMetricsConfiguration( + putBucketMetricsConfiguration( args: PutBucketMetricsConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketMetricsConfigurationCommandOutput) => void ): void; - public putBucketMetricsConfiguration( - args: PutBucketMetricsConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketMetricsConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutBucketMetricsConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutBucketMetricsConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables notifications of specified events for a bucket. For more information about event - * notifications, see Configuring Event - * Notifications.

- *

Using this API, you can replace an existing notification configuration. The - * configuration is an XML file that defines the event types that you want Amazon S3 to publish and - * the destination where you want Amazon S3 to publish an event notification when it detects an - * event of the specified type.

- *

By default, your bucket has no event notifications configured. That is, the notification - * configuration will be an empty NotificationConfiguration.

- *

- * - *

- *

- * - *

- *

This action replaces the existing notification configuration with the configuration you - * include in the request body.

- *

After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification - * Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and - * that the bucket owner has permission to publish to it by sending a test notification. In - * the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions - * grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, - * see Configuring Notifications for Amazon S3 Events.

- *

You can disable notifications by adding the empty NotificationConfiguration - * element.

- *

For more information about the number of event notification configurations that you can - * create per bucket, see Amazon S3 service quotas in Amazon Web Services - * General Reference.

- *

By default, only the bucket owner can configure notifications on a bucket. However, - * bucket owners can use a bucket policy to grant permission to other users to set this - * configuration with s3:PutBucketNotification permission.

- * - *

The PUT notification is an atomic operation. For example, suppose your notification - * configuration includes SNS topic, SQS queue, and Lambda function configurations. When - * you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS - * topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the - * configuration to your bucket.

- *
- *

- * Responses - *

- *

If the configuration in the request body includes only one - * TopicConfiguration specifying only the - * s3:ReducedRedundancyLostObject event type, the response will also include - * the x-amz-sns-test-message-id header containing the message ID of the test - * notification sent to the topic.

- *

The following action is related to - * PutBucketNotificationConfiguration:

- * + * @see {@link PutBucketNotificationConfigurationCommand} */ - public putBucketNotificationConfiguration( + putBucketNotificationConfiguration( args: PutBucketNotificationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketNotificationConfiguration( + putBucketNotificationConfiguration( args: PutBucketNotificationConfigurationCommandInput, cb: (err: any, data?: PutBucketNotificationConfigurationCommandOutput) => void ): void; - public putBucketNotificationConfiguration( + putBucketNotificationConfiguration( args: PutBucketNotificationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketNotificationConfigurationCommandOutput) => void ): void; - public putBucketNotificationConfiguration( - args: PutBucketNotificationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketNotificationConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutBucketNotificationConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutBucketNotificationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this - * operation, you must have the s3:PutBucketOwnershipControls permission. For - * more information about Amazon S3 permissions, see Specifying permissions in a - * policy.

- *

For information about Amazon S3 Object Ownership, see Using object - * ownership.

- *

The following operations are related to PutBucketOwnershipControls:

- * + * @see {@link PutBucketOwnershipControlsCommand} */ - public putBucketOwnershipControls( + putBucketOwnershipControls( args: PutBucketOwnershipControlsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketOwnershipControls( + putBucketOwnershipControls( args: PutBucketOwnershipControlsCommandInput, cb: (err: any, data?: PutBucketOwnershipControlsCommandOutput) => void ): void; - public putBucketOwnershipControls( + putBucketOwnershipControls( args: PutBucketOwnershipControlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketOwnershipControlsCommandOutput) => void ): void; - public putBucketOwnershipControls( - args: PutBucketOwnershipControlsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketOwnershipControlsCommandOutput) => void), - cb?: (err: any, data?: PutBucketOwnershipControlsCommandOutput) => void - ): Promise | void { - const command = new PutBucketOwnershipControlsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than - * the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the - * PutBucketPolicy permissions on the specified bucket and belong to the - * bucket owner's account in order to use this operation.

- *

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 - * Access Denied error. If you have the correct permissions, but you're not using an - * identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not - * Allowed error.

- * - *

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can - * always use this operation, even if the policy explicitly denies the root user the - * ability to perform this action.

- *
- *

For more information, see Bucket policy - * examples.

- *

The following operations are related to PutBucketPolicy:

- * + * @see {@link PutBucketPolicyCommand} */ - public putBucketPolicy( + putBucketPolicy( args: PutBucketPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketPolicy( - args: PutBucketPolicyCommandInput, - cb: (err: any, data?: PutBucketPolicyCommandOutput) => void - ): void; - public putBucketPolicy( + putBucketPolicy(args: PutBucketPolicyCommandInput, cb: (err: any, data?: PutBucketPolicyCommandOutput) => void): void; + putBucketPolicy( args: PutBucketPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketPolicyCommandOutput) => void ): void; - public putBucketPolicy( - args: PutBucketPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketPolicyCommandOutput) => void), - cb?: (err: any, data?: PutBucketPolicyCommandOutput) => void - ): Promise | void { - const command = new PutBucketPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a replication configuration or replaces an existing one. For more information, - * see Replication in the Amazon S3 User Guide.

- *

Specify the replication configuration in the request body. In the replication - * configuration, you provide the name of the destination bucket or buckets where you want - * Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your - * behalf, and other relevant information.

- *

A replication configuration must include at least one rule, and can contain a maximum of - * 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in - * the source bucket. To choose additional subsets of objects to replicate, add a rule for - * each subset.

- *

To specify a subset of the objects in the source bucket to apply a replication rule to, - * add the Filter element as a child of the Rule element. You can filter objects based on an - * object key prefix, one or more object tags, or both. When you add the Filter element in the - * configuration, you must also add the following elements: - * DeleteMarkerReplication, Status, and - * Priority.

- * - *

If you are using an earlier version of the replication configuration, Amazon S3 handles - * replication of delete markers differently. For more information, see Backward Compatibility.

- *
- *

For information about enabling versioning on a bucket, see Using Versioning.

- *

- * Handling Replication of Encrypted Objects - *

- *

By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side - * encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following: - * SourceSelectionCriteria, SseKmsEncryptedObjects, - * Status, EncryptionConfiguration, and - * ReplicaKmsKeyID. For information about replication configuration, see - * Replicating Objects - * Created with SSE Using KMS keys.

- *

For information on PutBucketReplication errors, see List of - * replication-related error codes - *

- *

- * Permissions - *

- *

To create a PutBucketReplication request, you must have - * s3:PutReplicationConfiguration permissions for the bucket. - * - *

- *

By default, a resource owner, in this case the Amazon Web Services account that created the bucket, - * can perform this operation. The resource owner can also grant others permissions to perform - * the operation. For more information about permissions, see Specifying Permissions in a - * Policy and Managing Access Permissions to - * Your Amazon S3 Resources.

- * - *

To perform this operation, the user or role performing the action must have the - * iam:PassRole permission.

- *
- *

The following operations are related to PutBucketReplication:

- * + * @see {@link PutBucketReplicationCommand} */ - public putBucketReplication( + putBucketReplication( args: PutBucketReplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketReplication( + putBucketReplication( args: PutBucketReplicationCommandInput, cb: (err: any, data?: PutBucketReplicationCommandOutput) => void ): void; - public putBucketReplication( + putBucketReplication( args: PutBucketReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketReplicationCommandOutput) => void ): void; - public putBucketReplication( - args: PutBucketReplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketReplicationCommandOutput) => void), - cb?: (err: any, data?: PutBucketReplicationCommandOutput) => void - ): Promise | void { - const command = new PutBucketReplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the request payment configuration for a bucket. By default, the bucket owner pays - * for downloads from the bucket. This configuration parameter enables the bucket owner (only) - * to specify that the person requesting the download will be charged for the download. For - * more information, see Requester Pays - * Buckets.

- *

The following operations are related to PutBucketRequestPayment:

- * + * @see {@link PutBucketRequestPaymentCommand} */ - public putBucketRequestPayment( + putBucketRequestPayment( args: PutBucketRequestPaymentCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketRequestPayment( + putBucketRequestPayment( args: PutBucketRequestPaymentCommandInput, cb: (err: any, data?: PutBucketRequestPaymentCommandOutput) => void ): void; - public putBucketRequestPayment( + putBucketRequestPayment( args: PutBucketRequestPaymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketRequestPaymentCommandOutput) => void ): void; - public putBucketRequestPayment( - args: PutBucketRequestPaymentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketRequestPaymentCommandOutput) => void), - cb?: (err: any, data?: PutBucketRequestPaymentCommandOutput) => void - ): Promise | void { - const command = new PutBucketRequestPaymentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the tags for a bucket.

- *

Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, - * sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost - * of combined resources, organize your billing information according to resources with the - * same tag key values. For example, you can tag several resources with a specific application - * name, and then organize your billing information to see the total cost of that application - * across several services. For more information, see Cost Allocation and - * Tagging and Using Cost Allocation in Amazon S3 Bucket - * Tags.

- * - *

When this operation sets the tags for a bucket, it will overwrite any current tags - * the bucket already has. You cannot use this operation to add tags to an existing list of - * tags.

- *
- *

To use this operation, you must have permissions to perform the - * s3:PutBucketTagging action. The bucket owner has this permission by default - * and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources.

- *

- * PutBucketTagging has the following special errors:

- *
    - *
  • - *

    Error code: InvalidTagError - *

    - * - *
  • - *
  • - *

    Error code: MalformedXMLError - *

    - *
      - *
    • - *

      Description: The XML provided does not match the schema.

      - *
    • - *
    - *
  • - *
  • - *

    Error code: OperationAbortedError - *

    - *
      - *
    • - *

      Description: A conflicting conditional action is currently in progress - * against this resource. Please try again.

      - *
    • - *
    - *
  • - *
  • - *

    Error code: InternalError - *

    - *
      - *
    • - *

      Description: The service was unable to apply the provided tag to the - * bucket.

      - *
    • - *
    - *
  • - *
- *

The following operations are related to PutBucketTagging:

- * + * @see {@link PutBucketTaggingCommand} */ - public putBucketTagging( + putBucketTagging( args: PutBucketTaggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketTagging( + putBucketTagging( args: PutBucketTaggingCommandInput, cb: (err: any, data?: PutBucketTaggingCommandOutput) => void ): void; - public putBucketTagging( + putBucketTagging( args: PutBucketTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketTaggingCommandOutput) => void ): void; - public putBucketTagging( - args: PutBucketTaggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketTaggingCommandOutput) => void), - cb?: (err: any, data?: PutBucketTaggingCommandOutput) => void - ): Promise | void { - const command = new PutBucketTaggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the versioning state of an existing bucket.

- *

You can set the versioning state with one of the following values:

- *

- * Enabled—Enables versioning for the objects in the - * bucket. All objects added to the bucket receive a unique version ID.

- *

- * Suspended—Disables versioning for the objects in the - * bucket. All objects added to the bucket receive the version ID null.

- *

If the versioning state has never been set on a bucket, it has no versioning state; a - * GetBucketVersioning request does not return a versioning state value.

- *

In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner - * and want to enable MFA Delete in the bucket versioning configuration, you must include the - * x-amz-mfa request header and the Status and the - * MfaDelete request elements in a request to set the versioning state of the - * bucket.

- * - *

If you have an object expiration lifecycle policy in your non-versioned bucket and - * you want to maintain the same permanent delete behavior when you enable versioning, you - * must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will - * manage the deletes of the noncurrent object versions in the version-enabled bucket. (A - * version-enabled bucket maintains one current and zero or more noncurrent object - * versions.) For more information, see Lifecycle and Versioning.

- *
- *

- * Related Resources - *

- * + * @see {@link PutBucketVersioningCommand} */ - public putBucketVersioning( + putBucketVersioning( args: PutBucketVersioningCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketVersioning( + putBucketVersioning( args: PutBucketVersioningCommandInput, cb: (err: any, data?: PutBucketVersioningCommandOutput) => void ): void; - public putBucketVersioning( + putBucketVersioning( args: PutBucketVersioningCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketVersioningCommandOutput) => void ): void; - public putBucketVersioning( - args: PutBucketVersioningCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketVersioningCommandOutput) => void), - cb?: (err: any, data?: PutBucketVersioningCommandOutput) => void - ): Promise | void { - const command = new PutBucketVersioningCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the configuration of the website that is specified in the website - * subresource. To configure a bucket as a website, you can add this subresource on the bucket - * with website configuration information such as the file name of the index document and any - * redirect rules. For more information, see Hosting Websites on Amazon S3.

- *

This PUT action requires the S3:PutBucketWebsite permission. By default, - * only the bucket owner can configure the website attached to a bucket; however, bucket - * owners can allow other users to set the website configuration by writing a bucket policy - * that grants them the S3:PutBucketWebsite permission.

- *

To redirect all website requests sent to the bucket's website endpoint, you add a - * website configuration with the following elements. Because all requests are sent to another - * website, you don't need to provide index document name for the bucket.

- *
    - *
  • - *

    - * WebsiteConfiguration - *

    - *
  • - *
  • - *

    - * RedirectAllRequestsTo - *

    - *
  • - *
  • - *

    - * HostName - *

    - *
  • - *
  • - *

    - * Protocol - *

    - *
  • - *
- *

If you want granular control over redirects, you can use the following elements to add - * routing rules that describe conditions for redirecting requests and information about the - * redirect destination. In this case, the website configuration must provide an index - * document for the bucket, because some requests might not be redirected.

- *
    - *
  • - *

    - * WebsiteConfiguration - *

    - *
  • - *
  • - *

    - * IndexDocument - *

    - *
  • - *
  • - *

    - * Suffix - *

    - *
  • - *
  • - *

    - * ErrorDocument - *

    - *
  • - *
  • - *

    - * Key - *

    - *
  • - *
  • - *

    - * RoutingRules - *

    - *
  • - *
  • - *

    - * RoutingRule - *

    - *
  • - *
  • - *

    - * Condition - *

    - *
  • - *
  • - *

    - * HttpErrorCodeReturnedEquals - *

    - *
  • - *
  • - *

    - * KeyPrefixEquals - *

    - *
  • - *
  • - *

    - * Redirect - *

    - *
  • - *
  • - *

    - * Protocol - *

    - *
  • - *
  • - *

    - * HostName - *

    - *
  • - *
  • - *

    - * ReplaceKeyPrefixWith - *

    - *
  • - *
  • - *

    - * ReplaceKeyWith - *

    - *
  • - *
  • - *

    - * HttpRedirectCode - *

    - *
  • - *
- *

Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more - * than 50 routing rules, you can use object redirect. For more information, see Configuring an - * Object Redirect in the Amazon S3 User Guide.

+ * @see {@link PutBucketWebsiteCommand} */ - public putBucketWebsite( + putBucketWebsite( args: PutBucketWebsiteCommandInput, options?: __HttpHandlerOptions ): Promise; - public putBucketWebsite( + putBucketWebsite( args: PutBucketWebsiteCommandInput, cb: (err: any, data?: PutBucketWebsiteCommandOutput) => void ): void; - public putBucketWebsite( + putBucketWebsite( args: PutBucketWebsiteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketWebsiteCommandOutput) => void ): void; - public putBucketWebsite( - args: PutBucketWebsiteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutBucketWebsiteCommandOutput) => void), - cb?: (err: any, data?: PutBucketWebsiteCommandOutput) => void - ): Promise | void { - const command = new PutBucketWebsiteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object - * to it.

- * - *

Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the - * entire object to the bucket. You cannot use PutObject to only update a - * single piece of metadata for an existing object. You must put the entire object with - * updated metadata if you want to update some values.

- *
- *

Amazon S3 is a distributed system. If it receives multiple write requests for the same object - * simultaneously, it overwrites all but the last object written. To prevent objects from - * being deleted or overwritten, you can use Amazon S3 Object - * Lock.

- *

To ensure that data is not corrupted traversing the network, use the - * Content-MD5 header. When you use this header, Amazon S3 checks the object - * against the provided MD5 value and, if they do not match, returns an error. Additionally, - * you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to - * the calculated MD5 value.

- * - *
    - *
  • - *

    To successfully complete the PutObject request, you must have the - * s3:PutObject in your IAM permissions.

    - *
  • - *
  • - *

    To successfully change the objects acl of your PutObject request, - * you must have the s3:PutObjectAcl in your IAM permissions.

    - *
  • - *
  • - *

    To successfully set the tag-set with your PutObject request, you - * must have the s3:PutObjectTagging in your IAM permissions.

    - *
  • - *
  • - *

    The Content-MD5 header is required for any request to upload an - * object with a retention period configured using Amazon S3 Object Lock. For more - * information about Amazon S3 Object Lock, see Amazon S3 Object Lock - * Overview in the Amazon S3 User Guide.

    - *
  • - *
- *
- *

You have three mutually exclusive options to protect data using server-side encryption - * in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the - * encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and - * customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using - * Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at by - * rest using server-side encryption with other key options. For more information, see Using - * Server-Side Encryption.

- *

When adding a new object, you can use headers to grant ACL-based permissions to - * individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are - * then added to the ACL on the object. By default, all objects are private. Only the owner - * has full access control. For more information, see Access Control List (ACL) Overview - * and Managing - * ACLs Using the REST API.

- *

If the bucket that you're uploading objects to uses the bucket owner enforced setting - * for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that - * use this setting only accept PUT requests that don't specify an ACL or PUT requests that - * specify bucket owner full control ACLs, such as the bucket-owner-full-control - * canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that - * contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a - * 400 error with the error code AccessControlListNotSupported. - * For more information, see Controlling ownership of - * objects and disabling ACLs in the Amazon S3 User Guide.

- * - *

If your bucket uses the bucket owner enforced setting for Object Ownership, all - * objects written to the bucket by any account will be owned by the bucket owner.

- *
- *

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The - * STANDARD storage class provides high durability and high availability. Depending on - * performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses - * the OUTPOSTS Storage Class. For more information, see Storage Classes in the - * Amazon S3 User Guide.

- *

If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID - * for the object being stored. Amazon S3 returns this ID in the response. When you enable - * versioning for a bucket, if Amazon S3 receives multiple write requests for the same object - * simultaneously, it stores all of the objects. For more information about versioning, see - * Adding Objects to - * Versioning Enabled Buckets. For information about returning the versioning state - * of a bucket, see GetBucketVersioning.

- *

For more information about related Amazon S3 APIs, see the following:

- * + * @see {@link PutObjectCommand} */ - public putObject(args: PutObjectCommandInput, options?: __HttpHandlerOptions): Promise; - public putObject(args: PutObjectCommandInput, cb: (err: any, data?: PutObjectCommandOutput) => void): void; - public putObject( + putObject(args: PutObjectCommandInput, options?: __HttpHandlerOptions): Promise; + putObject(args: PutObjectCommandInput, cb: (err: any, data?: PutObjectCommandOutput) => void): void; + putObject( args: PutObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutObjectCommandOutput) => void ): void; - public putObject( - args: PutObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutObjectCommandOutput) => void), - cb?: (err: any, data?: PutObjectCommandOutput) => void - ): Promise | void { - const command = new PutObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Uses the acl subresource to set the access control list (ACL) permissions - * for a new or existing object in an S3 bucket. You must have WRITE_ACP - * permission to set the ACL of an object. For more information, see What - * permissions can I grant? in the Amazon S3 User Guide.

- *

This action is not supported by Amazon S3 on Outposts.

- *

Depending on your application needs, you can choose to set the ACL on an object using - * either the request body or the headers. For example, if you have an existing application - * that updates a bucket ACL using the request body, you can continue to use that approach. - * For more information, see Access Control List (ACL) Overview - * in the Amazon S3 User Guide.

- * - *

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs - * are disabled and no longer affect permissions. You must use policies to grant access to - * your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return - * the AccessControlListNotSupported error code. Requests to read ACLs are - * still supported. For more information, see Controlling object - * ownership in the Amazon S3 User Guide.

- *
- *

- * Access Permissions - *

- *

You can set access permissions using one of the following methods:

- *
    - *
  • - *

    Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports - * a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set - * of grantees and permissions. Specify the canned ACL name as the value of - * x-amz-acl. If you use this header, you cannot use other access - * control-specific headers in your request. For more information, see Canned - * ACL.

    - *
  • - *
  • - *

    Specify access permissions explicitly with the x-amz-grant-read, - * x-amz-grant-read-acp, x-amz-grant-write-acp, and - * x-amz-grant-full-control headers. When using these headers, you - * specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who - * will receive the permission. If you use these ACL-specific headers, you cannot use - * x-amz-acl header to set a canned ACL. These parameters map to the set - * of permissions that Amazon S3 supports in an ACL. For more information, see Access Control - * List (ACL) Overview.

    - *

    You specify each grantee as a type=value pair, where the type is one of the - * following:

    - *
      - *
    • - *

      - * id – if the value specified is the canonical user ID of an - * Amazon Web Services account

      - *
    • - *
    • - *

      - * uri – if you are granting permissions to a predefined - * group

      - *
    • - *
    • - *

      - * emailAddress – if the value specified is the email address of - * an Amazon Web Services account

      - * - *

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      - *
        - *
      • - *

        US East (N. Virginia)

        - *
      • - *
      • - *

        US West (N. California)

        - *
      • - *
      • - *

        US West (Oregon)

        - *
      • - *
      • - *

        Asia Pacific (Singapore)

        - *
      • - *
      • - *

        Asia Pacific (Sydney)

        - *
      • - *
      • - *

        Asia Pacific (Tokyo)

        - *
      • - *
      • - *

        Europe (Ireland)

        - *
      • - *
      • - *

        South America (São Paulo)

        - *
      • - *
      - *

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      - *
      - *
    • - *
    - *

    For example, the following x-amz-grant-read header grants list - * objects permission to the two Amazon Web Services accounts identified by their email - * addresses.

    - *

    - * x-amz-grant-read: emailAddress="xyz@amazon.com", - * emailAddress="abc@amazon.com" - *

    - *
  • - *
- *

You can use either a canned ACL or specify access permissions explicitly. You cannot do - * both.

- *

- * Grantee Values - *

- *

You can specify the person (grantee) to whom you're assigning access rights (using - * request elements) in the following ways:

- *
    - *
  • - *

    By the person's ID:

    - *

    - * <>ID<><>GranteesEmail<> - * - *

    - *

    DisplayName is optional and ignored in the request.

    - *
  • - *
  • - *

    By URI:

    - *

    - * <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> - *

    - *
  • - *
  • - *

    By Email address:

    - *

    - * <>Grantees@email.com<>lt;/Grantee> - *

    - *

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object - * acl request, appears as the CanonicalUser.

    - * - *

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    - *
      - *
    • - *

      US East (N. Virginia)

      - *
    • - *
    • - *

      US West (N. California)

      - *
    • - *
    • - *

      US West (Oregon)

      - *
    • - *
    • - *

      Asia Pacific (Singapore)

      - *
    • - *
    • - *

      Asia Pacific (Sydney)

      - *
    • - *
    • - *

      Asia Pacific (Tokyo)

      - *
    • - *
    • - *

      Europe (Ireland)

      - *
    • - *
    • - *

      South America (São Paulo)

      - *
    • - *
    - *

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    - *
    - *
  • - *
- *

- * Versioning - *

- *

The ACL of an object is set at the object version level. By default, PUT sets the ACL of - * the current version of an object. To set the ACL of a different version, use the - * versionId subresource.

- *

- * Related Resources - *

- * + * @see {@link PutObjectAclCommand} */ - public putObjectAcl( - args: PutObjectAclCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putObjectAcl(args: PutObjectAclCommandInput, cb: (err: any, data?: PutObjectAclCommandOutput) => void): void; - public putObjectAcl( + putObjectAcl(args: PutObjectAclCommandInput, options?: __HttpHandlerOptions): Promise; + putObjectAcl(args: PutObjectAclCommandInput, cb: (err: any, data?: PutObjectAclCommandOutput) => void): void; + putObjectAcl( args: PutObjectAclCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutObjectAclCommandOutput) => void ): void; - public putObjectAcl( - args: PutObjectAclCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutObjectAclCommandOutput) => void), - cb?: (err: any, data?: PutObjectAclCommandOutput) => void - ): Promise | void { - const command = new PutObjectAclCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Applies a legal hold configuration to the specified object. For more information, see - * Locking - * Objects.

- *

This action is not supported by Amazon S3 on Outposts.

+ * @see {@link PutObjectLegalHoldCommand} */ - public putObjectLegalHold( + putObjectLegalHold( args: PutObjectLegalHoldCommandInput, options?: __HttpHandlerOptions ): Promise; - public putObjectLegalHold( + putObjectLegalHold( args: PutObjectLegalHoldCommandInput, cb: (err: any, data?: PutObjectLegalHoldCommandOutput) => void ): void; - public putObjectLegalHold( + putObjectLegalHold( args: PutObjectLegalHoldCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutObjectLegalHoldCommandOutput) => void ): void; - public putObjectLegalHold( - args: PutObjectLegalHoldCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutObjectLegalHoldCommandOutput) => void), - cb?: (err: any, data?: PutObjectLegalHoldCommandOutput) => void - ): Promise | void { - const command = new PutObjectLegalHoldCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Places an Object Lock configuration on the specified bucket. The rule specified in the - * Object Lock configuration will be applied by default to every new object placed in the - * specified bucket. For more information, see Locking Objects.

- * - *
    - *
  • - *

    The DefaultRetention settings require both a mode and a - * period.

    - *
  • - *
  • - *

    The DefaultRetention period can be either Days or - * Years but you must select one. You cannot specify - * Days and Years at the same time.

    - *
  • - *
  • - *

    You can only enable Object Lock for new buckets. If you want to turn on Object - * Lock for an existing bucket, contact Amazon Web Services Support.

    - *
  • - *
- *
+ * @see {@link PutObjectLockConfigurationCommand} */ - public putObjectLockConfiguration( + putObjectLockConfiguration( args: PutObjectLockConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putObjectLockConfiguration( + putObjectLockConfiguration( args: PutObjectLockConfigurationCommandInput, cb: (err: any, data?: PutObjectLockConfigurationCommandOutput) => void ): void; - public putObjectLockConfiguration( + putObjectLockConfiguration( args: PutObjectLockConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutObjectLockConfigurationCommandOutput) => void ): void; - public putObjectLockConfiguration( - args: PutObjectLockConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutObjectLockConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutObjectLockConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutObjectLockConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Places an Object Retention configuration on an object. For more information, see Locking Objects. - * Users or accounts require the s3:PutObjectRetention permission in order to - * place an Object Retention configuration on objects. Bypassing a Governance Retention - * configuration requires the s3:BypassGovernanceRetention permission.

- *

This action is not supported by Amazon S3 on Outposts.

+ * @see {@link PutObjectRetentionCommand} */ - public putObjectRetention( + putObjectRetention( args: PutObjectRetentionCommandInput, options?: __HttpHandlerOptions ): Promise; - public putObjectRetention( + putObjectRetention( args: PutObjectRetentionCommandInput, cb: (err: any, data?: PutObjectRetentionCommandOutput) => void ): void; - public putObjectRetention( + putObjectRetention( args: PutObjectRetentionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutObjectRetentionCommandOutput) => void ): void; - public putObjectRetention( - args: PutObjectRetentionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutObjectRetentionCommandOutput) => void), - cb?: (err: any, data?: PutObjectRetentionCommandOutput) => void - ): Promise | void { - const command = new PutObjectRetentionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the supplied tag-set to an object that already exists in a bucket.

- *

A tag is a key-value pair. You can associate tags with an object by sending a PUT - * request against the tagging subresource that is associated with the object. You can - * retrieve tags by sending a GET request. For more information, see GetObjectTagging.

- *

For tagging-related restrictions related to characters and encodings, see Tag - * Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per - * object.

- *

To use this operation, you must have permission to perform the - * s3:PutObjectTagging action. By default, the bucket owner has this - * permission and can grant this permission to others.

- *

To put tags of any other version, use the versionId query parameter. You - * also need permission for the s3:PutObjectVersionTagging action.

- *

For information about the Amazon S3 object tagging feature, see Object Tagging.

- *

- * Special Errors - *

- *
    - *
  • - *
      - *
    • - *

      - * Code: InvalidTagError - *

      - *
    • - *
    • - *

      - * Cause: The tag provided was not a valid tag. This error can occur - * if the tag did not pass input validation. For more information, see Object - * Tagging. - *

      - *
    • - *
    - *
  • - *
  • - *
      - *
    • - *

      - * Code: MalformedXMLError - *

      - *
    • - *
    • - *

      - * Cause: The XML provided does not match the schema. - *

      - *
    • - *
    - *
  • - *
  • - *
      - *
    • - *

      - * Code: OperationAbortedError - *

      - *
    • - *
    • - *

      - * Cause: A conflicting conditional action is currently in progress - * against this resource. Please try again. - *

      - *
    • - *
    - *
  • - *
  • - *
      - *
    • - *

      - * Code: InternalError - *

      - *
    • - *
    • - *

      - * Cause: The service was unable to apply the provided tag to the - * object. - *

      - *
    • - *
    - *
  • - *
- *

- * Related Resources - *

- * + * @see {@link PutObjectTaggingCommand} */ - public putObjectTagging( + putObjectTagging( args: PutObjectTaggingCommandInput, options?: __HttpHandlerOptions ): Promise; - public putObjectTagging( + putObjectTagging( args: PutObjectTaggingCommandInput, cb: (err: any, data?: PutObjectTaggingCommandOutput) => void ): void; - public putObjectTagging( + putObjectTagging( args: PutObjectTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutObjectTaggingCommandOutput) => void ): void; - public putObjectTagging( - args: PutObjectTaggingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutObjectTaggingCommandOutput) => void), - cb?: (err: any, data?: PutObjectTaggingCommandOutput) => void - ): Promise | void { - const command = new PutObjectTaggingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket. - * To use this operation, you must have the s3:PutBucketPublicAccessBlock - * permission. For more information about Amazon S3 permissions, see Specifying Permissions in a - * Policy.

- * - *

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or - * an object, it checks the PublicAccessBlock configuration for both the - * bucket (or the bucket that contains the object) and the bucket owner's account. If the - * PublicAccessBlock configurations are different between the bucket and - * the account, Amazon S3 uses the most restrictive combination of the bucket-level and - * account-level settings.

- *
- *

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public".

- *

- * Related Resources - *

- * + * @see {@link PutPublicAccessBlockCommand} */ - public putPublicAccessBlock( + putPublicAccessBlock( args: PutPublicAccessBlockCommandInput, options?: __HttpHandlerOptions ): Promise; - public putPublicAccessBlock( + putPublicAccessBlock( args: PutPublicAccessBlockCommandInput, cb: (err: any, data?: PutPublicAccessBlockCommandOutput) => void ): void; - public putPublicAccessBlock( + putPublicAccessBlock( args: PutPublicAccessBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPublicAccessBlockCommandOutput) => void ): void; - public putPublicAccessBlock( - args: PutPublicAccessBlockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutPublicAccessBlockCommandOutput) => void), - cb?: (err: any, data?: PutPublicAccessBlockCommandOutput) => void - ): Promise | void { - const command = new PutPublicAccessBlockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Restores an archived copy of an object back into Amazon S3

- *

This action is not supported by Amazon S3 on Outposts.

- *

This action performs the following types of requests:

- *
    - *
  • - *

    - * select - Perform a select query on an archived object

    - *
  • - *
  • - *

    - * restore an archive - Restore an archived object

    - *
  • - *
- *

To use this operation, you must have permissions to perform the - * s3:RestoreObject action. The bucket owner has this permission by default - * and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing - * Access Permissions to Your Amazon S3 Resources in the - * Amazon S3 User Guide.

- *

For more information about the S3 structure in the request body, see the - * following:

- *
    - *
  • - * - *
  • - *
  • - *

    Define the SQL expression for the SELECT type of restoration for your - * query in the request body's SelectParameters structure. You can use - * expressions like the following examples.

    - *
      - *
    • - *

      The following expression returns all records from the specified - * object.

      - *

      - * SELECT * FROM Object - *

      - *
    • - *
    • - *

      Assuming that you are not using any headers for data stored in the object, - * you can specify columns with positional headers.

      - *

      - * SELECT s._1, s._2 FROM Object s WHERE s._3 > 100 - *

      - *
    • - *
    • - *

      If you have headers and you set the fileHeaderInfo in the - * CSV structure in the request body to USE, you can - * specify headers in the query. (If you set the fileHeaderInfo field - * to IGNORE, the first row is skipped for the query.) You cannot mix - * ordinal positions with header column names.

      - *

      - * SELECT s.Id, s.FirstName, s.SSN FROM S3Object s - *

      - *
    • - *
    - *
  • - *
- *

When making a select request, you can also do the following:

- *
    - *
  • - *

    To expedite your queries, specify the Expedited tier. For more - * information about tiers, see "Restoring Archives," later in this topic.

    - *
  • - *
  • - *

    Specify details about the data serialization format of both the input object that - * is being queried and the serialization of the CSV-encoded query results.

    - *
  • - *
- *

The following are additional important facts about the select feature:

- *
    - *
  • - *

    The output results are new Amazon S3 objects. Unlike archive retrievals, they are - * stored until explicitly deleted-manually or through a lifecycle policy.

    - *
  • - *
  • - *

    You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't - * duplicate requests, so avoid issuing duplicate requests.

    - *
  • - *
  • - *

    Amazon S3 accepts a select request even if the object has already been restored. A - * select request doesn’t return error response 409.

    - *
  • - *
- *

- * Restoring objects - *

- *

Objects that you archive to the S3 Glacier Flexible Retrieval or - * S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or - * S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the - * S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage - * classes, you must first initiate a restore request, and then wait until a temporary copy of - * the object is available. If you want a permanent copy of the object, create a copy of it in - * the Amazon S3 Standard storage class in your S3 bucket. To access an archived object, you must - * restore the object for the duration (number of days) that you specify. For objects in the - * Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering, you must first - * initiate a restore request, and then wait until the object is moved into the Frequent - * Access tier.

- *

To restore a specific object version, you can provide a version ID. If you don't provide - * a version ID, Amazon S3 restores the current version.

- *

When restoring an archived object, you can specify one of the following data access tier - * options in the Tier element of the request body:

- *
    - *
  • - *

    - * Expedited - Expedited retrievals allow you to quickly access your - * data stored in the S3 Glacier Flexible Retrieval storage class or - * S3 Intelligent-Tiering Archive tier when occasional urgent requests for a subset of archives - * are required. For all but the largest archived objects (250 MB+), data accessed using - * Expedited retrievals is typically made available within 1–5 minutes. Provisioned - * capacity ensures that retrieval capacity for Expedited retrievals is available when - * you need it. Expedited retrievals and provisioned capacity are not available for - * objects stored in the S3 Glacier Deep Archive storage class or - * S3 Intelligent-Tiering Deep Archive tier.

    - *
  • - *
  • - *

    - * Standard - Standard retrievals allow you to access any of your - * archived objects within several hours. This is the default option for retrieval - * requests that do not specify the retrieval option. Standard retrievals typically - * finish within 3–5 hours for objects stored in the S3 Glacier Flexible - * Retrieval storage class or S3 Intelligent-Tiering Archive tier. They typically finish within - * 12 hours for objects stored in the S3 Glacier Deep Archive storage class or - * S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in - * S3 Intelligent-Tiering.

    - *
  • - *
  • - *

    - * Bulk - Bulk retrievals free for objects stored in the S3 Glacier - * Flexible Retrieval and S3 Intelligent-Tiering storage classes, enabling you to - * retrieve large amounts, even petabytes, of data at no cost. Bulk retrievals typically - * finish within 5–12 hours for objects stored in the S3 Glacier - * Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are - * also the lowest-cost retrieval option when restoring objects from - * S3 Glacier Deep Archive. They typically finish within 48 hours for objects - * stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive - * tier.

    - *
  • - *
- *

For more information about archive retrieval options and provisioned capacity for - * Expedited data access, see Restoring Archived Objects in - * the Amazon S3 User Guide.

- *

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed - * while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the - * Amazon S3 User Guide.

- *

To get the status of object restoration, you can send a HEAD request. - * Operations return the x-amz-restore header, which provides information about - * the restoration status, in the response. You can use Amazon S3 event notifications to notify you - * when a restore is initiated or completed. For more information, see Configuring Amazon S3 - * Event Notifications in the Amazon S3 User Guide.

- *

After restoring an archived object, you can update the restoration period by reissuing - * the request with a new period. Amazon S3 updates the restoration period relative to the current - * time and charges only for the request-there are no data transfer charges. You cannot - * update the restoration period when Amazon S3 is actively processing your current restore request - * for the object.

- *

If your bucket has a lifecycle configuration with a rule that includes an expiration - * action, the object expiration overrides the life span that you specify in a restore - * request. For example, if you restore an object copy for 10 days, but the object is - * scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information - * about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management - * in Amazon S3 User Guide.

- *

- * Responses - *

- *

A successful action returns either the 200 OK or 202 Accepted - * status code.

- *
    - *
  • - *

    If the object is not previously restored, then Amazon S3 returns 202 - * Accepted in the response.

    - *
  • - *
  • - *

    If the object is previously restored, Amazon S3 returns 200 OK in the - * response.

    - *
  • - *
- *

- * Special Errors - *

- *
    - *
  • - *
      - *
    • - *

      - * Code: RestoreAlreadyInProgress - *

      - *
    • - *
    • - *

      - * Cause: Object restore is already in progress. (This error does not - * apply to SELECT type requests.) - *

      - *
    • - *
    • - *

      - * HTTP Status Code: 409 Conflict - *

      - *
    • - *
    • - *

      - * SOAP Fault Code Prefix: Client - *

      - *
    • - *
    - *
  • - *
  • - *
      - *
    • - *

      - * Code: GlacierExpeditedRetrievalNotAvailable - *

      - *
    • - *
    • - *

      - * Cause: expedited retrievals are currently not available. Try again - * later. (Returned if there is insufficient capacity to process the Expedited - * request. This error applies only to Expedited retrievals and not to - * S3 Standard or Bulk retrievals.) - *

      - *
    • - *
    • - *

      - * HTTP Status Code: 503 - *

      - *
    • - *
    • - *

      - * SOAP Fault Code Prefix: N/A - *

      - *
    • - *
    - *
  • - *
- *

- * Related Resources - *

- * + * @see {@link RestoreObjectCommand} */ - public restoreObject( - args: RestoreObjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public restoreObject( - args: RestoreObjectCommandInput, - cb: (err: any, data?: RestoreObjectCommandOutput) => void - ): void; - public restoreObject( + restoreObject(args: RestoreObjectCommandInput, options?: __HttpHandlerOptions): Promise; + restoreObject(args: RestoreObjectCommandInput, cb: (err: any, data?: RestoreObjectCommandOutput) => void): void; + restoreObject( args: RestoreObjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreObjectCommandOutput) => void ): void; - public restoreObject( - args: RestoreObjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreObjectCommandOutput) => void), - cb?: (err: any, data?: RestoreObjectCommandOutput) => void - ): Promise | void { - const command = new RestoreObjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This action filters the contents of an Amazon S3 object based on a simple structured query - * language (SQL) statement. In the request, along with the SQL expression, you must also - * specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses - * this format to parse object data into records, and returns only records that match the - * specified SQL expression. You must also specify the data serialization format for the - * response.

- *

This action is not supported by Amazon S3 on Outposts.

- *

For more information about Amazon S3 Select, see Selecting Content from - * Objects and SELECT - * Command in the Amazon S3 User Guide.

- *

- *

- * Permissions - *

- *

You must have s3:GetObject permission for this operation. Amazon S3 Select does - * not support anonymous access. For more information about permissions, see Specifying - * Permissions in a Policy in the Amazon S3 User Guide.

- *

- *

- * Object Data Formats - *

- *

You can use Amazon S3 Select to query objects that have the following format - * properties:

- *
    - *
  • - *

    - * CSV, JSON, and Parquet - Objects must be in CSV, JSON, or - * Parquet format.

    - *
  • - *
  • - *

    - * UTF-8 - UTF-8 is the only encoding type Amazon S3 Select - * supports.

    - *
  • - *
  • - *

    - * GZIP or BZIP2 - CSV and JSON files can be compressed using - * GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select - * supports for CSV and JSON files. Amazon S3 Select supports columnar compression for - * Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression - * for Parquet objects.

    - *
  • - *
  • - *

    - * Server-side encryption - Amazon S3 Select supports querying - * objects that are protected with server-side encryption.

    - *

    For objects that are encrypted with customer-provided encryption keys (SSE-C), you - * must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side - * Encryption (Using Customer-Provided Encryption Keys) in the - * Amazon S3 User Guide.

    - *

    For objects that are encrypted with Amazon S3 managed keys (SSE-S3) and Amazon Web Services KMS keys - * (SSE-KMS), server-side encryption is handled transparently, so you don't need to - * specify anything. For more information about server-side encryption, including SSE-S3 - * and SSE-KMS, see Protecting Data Using - * Server-Side Encryption in the Amazon S3 User Guide.

    - *
  • - *
- *

- * Working with the Response Body - *

- *

Given the response size is unknown, Amazon S3 Select streams the response as a series of - * messages and includes a Transfer-Encoding header with chunked as - * its value in the response. For more information, see Appendix: SelectObjectContent - * Response.

- *

- *

- * GetObject Support - *

- *

The SelectObjectContent action does not support the following - * GetObject functionality. For more information, see GetObject.

- *
    - *
  • - *

    - * Range: Although you can specify a scan range for an Amazon S3 Select request - * (see SelectObjectContentRequest - ScanRange in the request parameters), - * you cannot specify the range of bytes of an object to return.

    - *
  • - *
  • - *

    GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify - * the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes. For - * more information, about storage classes see Storage - * Classes in the Amazon S3 User Guide.

    - *
  • - *
- *

- *

- * Special Errors - *

- *

For a list of special errors for this operation, see List of - * SELECT Object Content Error Codes - *

- *

- * Related Resources - *

- * + * @see {@link SelectObjectContentCommand} */ - public selectObjectContent( + selectObjectContent( args: SelectObjectContentCommandInput, options?: __HttpHandlerOptions ): Promise; - public selectObjectContent( + selectObjectContent( args: SelectObjectContentCommandInput, cb: (err: any, data?: SelectObjectContentCommandOutput) => void ): void; - public selectObjectContent( + selectObjectContent( args: SelectObjectContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SelectObjectContentCommandOutput) => void ): void; - public selectObjectContent( - args: SelectObjectContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SelectObjectContentCommandOutput) => void), - cb?: (err: any, data?: SelectObjectContentCommandOutput) => void - ): Promise | void { - const command = new SelectObjectContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Uploads a part in a multipart upload.

- * - *

In this operation, you provide part data in your request. However, you have an option - * to specify your existing Amazon S3 object as a data source for the part you are uploading. To - * upload a part from an existing object, you use the UploadPartCopy operation. - *

- *
- *

You must initiate a multipart upload (see CreateMultipartUpload) - * before you can upload any part. In response to your initiate request, Amazon S3 returns an - * upload ID, a unique identifier, that you must include in your upload part request.

- *

Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely - * identifies a part and also defines its position within the object being created. If you - * upload a new part using the same part number that was used with a previous part, the - * previously uploaded part is overwritten.

- *

For information about maximum and minimum part sizes and other multipart upload - * specifications, see Multipart upload limits in the Amazon S3 User Guide.

- *

To ensure that data is not corrupted when traversing the network, specify the - * Content-MD5 header in the upload part request. Amazon S3 checks the part data - * against the provided MD5 value. If they do not match, Amazon S3 returns an error.

- *

If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the - * x-amz-content-sha256 header as a checksum instead of - * Content-MD5. For more information see Authenticating - * Requests: Using the Authorization Header (Amazon Web Services Signature Version 4).

- *

- * Note: After you initiate multipart upload and upload - * one or more parts, you must either complete or abort multipart upload in order to stop - * getting charged for storage of the uploaded parts. Only after you either complete or abort - * multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts - * storage.

- *

For more information on multipart uploads, go to Multipart Upload Overview in the - * Amazon S3 User Guide .

- *

For information on the permissions required to use the multipart upload API, go to - * Multipart - * Upload and Permissions in the Amazon S3 User Guide.

- *

Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it - * writes it to disks in its data centers and decrypts it when you access it. You have three - * mutually exclusive options to protect data using server-side encryption in Amazon S3, depending - * on how you choose to manage the encryption keys. Specifically, the encryption key options - * are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and Customer-Provided Keys - * (SSE-C). Amazon S3 encrypts data with server-side encryption using Amazon S3 managed keys (SSE-S3) by - * default. You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption - * with other key options. The option you use depends on whether you want to use KMS keys - * (SSE-KMS) or provide your own encryption key (SSE-C). If you choose to provide your own - * encryption key, the request headers you provide in the request must match the headers you - * used in the request to initiate the upload by using CreateMultipartUpload. - * For more information, go to Using Server-Side - * Encryption in the Amazon S3 User Guide.

- *

Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are - * using a customer-provided encryption key (SSE-C), you don't need to specify the encryption - * parameters in each UploadPart request. Instead, you only need to specify the server-side - * encryption parameters in the initial Initiate Multipart request. For more information, see - * CreateMultipartUpload.

- *

If you requested server-side encryption using a customer-provided encryption key (SSE-C) - * in your initiate multipart upload request, you must provide identical encryption - * information in each part upload using the following headers.

- *
    - *
  • - *

    x-amz-server-side-encryption-customer-algorithm

    - *
  • - *
  • - *

    x-amz-server-side-encryption-customer-key

    - *
  • - *
  • - *

    x-amz-server-side-encryption-customer-key-MD5

    - *
  • - *
- *

- * Special Errors - *

- *
    - *
  • - *
      - *
    • - *

      - * Code: NoSuchUpload - *

      - *
    • - *
    • - *

      - * Cause: The specified multipart upload does not exist. The upload - * ID might be invalid, or the multipart upload might have been aborted or - * completed. - *

      - *
    • - *
    • - *

      - * HTTP Status Code: 404 Not Found - *

      - *
    • - *
    • - *

      - * SOAP Fault Code Prefix: Client - *

      - *
    • - *
    - *
  • - *
- *

- * Related Resources - *

- * + * @see {@link UploadPartCommand} */ - public uploadPart(args: UploadPartCommandInput, options?: __HttpHandlerOptions): Promise; - public uploadPart(args: UploadPartCommandInput, cb: (err: any, data?: UploadPartCommandOutput) => void): void; - public uploadPart( + uploadPart(args: UploadPartCommandInput, options?: __HttpHandlerOptions): Promise; + uploadPart(args: UploadPartCommandInput, cb: (err: any, data?: UploadPartCommandOutput) => void): void; + uploadPart( args: UploadPartCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UploadPartCommandOutput) => void ): void; - public uploadPart( - args: UploadPartCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UploadPartCommandOutput) => void), - cb?: (err: any, data?: UploadPartCommandOutput) => void - ): Promise | void { - const command = new UploadPartCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Uploads a part by copying data from an existing object as data source. You specify the - * data source by adding the request header x-amz-copy-source in your request and - * a byte range by adding the request header x-amz-copy-source-range in your - * request.

- *

For information about maximum and minimum part sizes and other multipart upload - * specifications, see Multipart upload limits in the Amazon S3 User Guide.

- * - *

Instead of using an existing object as part data, you might use the UploadPart - * action and provide data in your request.

- *
- *

You must initiate a multipart upload before you can upload any part. In response to your - * initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in - * your upload part request.

- *

For more information about using the UploadPartCopy operation, see the - * following:

- *
    - *
  • - *

    For conceptual information about multipart uploads, see Uploading - * Objects Using Multipart Upload in the - * Amazon S3 User Guide.

    - *
  • - *
  • - *

    For information about permissions required to use the multipart upload API, see - * Multipart Upload and Permissions in the - * Amazon S3 User Guide.

    - *
  • - *
  • - *

    For information about copying objects using a single atomic action vs. a multipart - * upload, see Operations on Objects in - * the Amazon S3 User Guide.

    - *
  • - *
  • - *

    For information about using server-side encryption with customer-provided - * encryption keys with the UploadPartCopy operation, see CopyObject and UploadPart.

    - *
  • - *
- *

Note the following additional considerations about the request headers - * x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - * x-amz-copy-source-if-unmodified-since, and - * x-amz-copy-source-if-modified-since:

- *

- *
    - *
  • - *

    - * Consideration 1 - If both of the - * x-amz-copy-source-if-match and - * x-amz-copy-source-if-unmodified-since headers are present in the - * request as follows:

    - *

    - * x-amz-copy-source-if-match condition evaluates to true, - * and;

    - *

    - * x-amz-copy-source-if-unmodified-since condition evaluates to - * false;

    - *

    Amazon S3 returns 200 OK and copies the data. - *

    - *
  • - *
  • - *

    - * Consideration 2 - If both of the - * x-amz-copy-source-if-none-match and - * x-amz-copy-source-if-modified-since headers are present in the - * request as follows:

    - *

    - * x-amz-copy-source-if-none-match condition evaluates to - * false, and;

    - *

    - * x-amz-copy-source-if-modified-since condition evaluates to - * true;

    - *

    Amazon S3 returns 412 Precondition Failed response code. - *

    - *
  • - *
- *

- * Versioning - *

- *

If your bucket has versioning enabled, you could have multiple versions of the same - * object. By default, x-amz-copy-source identifies the current version of the - * object to copy. If the current version is a delete marker and you don't specify a versionId - * in the x-amz-copy-source, Amazon S3 returns a 404 error, because the object does - * not exist. If you specify versionId in the x-amz-copy-source and the versionId - * is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify - * a delete marker as a version for the x-amz-copy-source.

- *

You can optionally specify a specific version of the source object to copy by adding the - * versionId subresource as shown in the following example:

- *

- * x-amz-copy-source: /bucket/object?versionId=version id - *

- *

- * Special Errors - *

- *
    - *
  • - *
      - *
    • - *

      - * Code: NoSuchUpload - *

      - *
    • - *
    • - *

      - * Cause: The specified multipart upload does not exist. The upload - * ID might be invalid, or the multipart upload might have been aborted or - * completed. - *

      - *
    • - *
    • - *

      - * HTTP Status Code: 404 Not Found - *

      - *
    • - *
    - *
  • - *
  • - *
      - *
    • - *

      - * Code: InvalidRequest - *

      - *
    • - *
    • - *

      - * Cause: The specified copy source is not supported as a byte-range - * copy source. - *

      - *
    • - *
    • - *

      - * HTTP Status Code: 400 Bad Request - *

      - *
    • - *
    - *
  • - *
- *

- * Related Resources - *

- * + * @see {@link UploadPartCopyCommand} */ - public uploadPartCopy( + uploadPartCopy( args: UploadPartCopyCommandInput, options?: __HttpHandlerOptions ): Promise; - public uploadPartCopy( - args: UploadPartCopyCommandInput, - cb: (err: any, data?: UploadPartCopyCommandOutput) => void - ): void; - public uploadPartCopy( + uploadPartCopy(args: UploadPartCopyCommandInput, cb: (err: any, data?: UploadPartCopyCommandOutput) => void): void; + uploadPartCopy( args: UploadPartCopyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UploadPartCopyCommandOutput) => void ): void; - public uploadPartCopy( - args: UploadPartCopyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UploadPartCopyCommandOutput) => void), - cb?: (err: any, data?: UploadPartCopyCommandOutput) => void - ): Promise | void { - const command = new UploadPartCopyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Passes transformed objects to a GetObject operation when using Object Lambda access points. For - * information about Object Lambda access points, see Transforming objects with - * Object Lambda access points in the Amazon S3 User Guide.

- *

This operation supports metadata that can be returned by GetObject, in addition to - * RequestRoute, RequestToken, StatusCode, - * ErrorCode, and ErrorMessage. The GetObject - * response metadata is supported so that the WriteGetObjectResponse caller, - * typically an Lambda function, can provide the same metadata when it internally invokes - * GetObject. When WriteGetObjectResponse is called by a - * customer-owned Lambda function, the metadata returned to the end user - * GetObject call might differ from what Amazon S3 would normally return.

- *

You can include any number of metadata headers. When including a metadata header, it - * should be prefaced with x-amz-meta. For example, - * x-amz-meta-my-custom-header: MyCustomValue. The primary use case for this - * is to forward GetObject metadata.

- *

Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to - * detect and redact personally identifiable information (PII) and decompress S3 objects. - * These Lambda functions are available in the Amazon Web Services Serverless Application Repository, and - * can be selected through the Amazon Web Services Management Console when you create your Object Lambda access point.

- *

Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a - * natural language processing (NLP) service using machine learning to find insights and - * relationships in text. It automatically detects personally identifiable information (PII) - * such as names, addresses, dates, credit card numbers, and social security numbers from - * documents in your Amazon S3 bucket.

- *

Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural - * language processing (NLP) service using machine learning to find insights and relationships - * in text. It automatically redacts personally identifiable information (PII) such as names, - * addresses, dates, credit card numbers, and social security numbers from documents in your - * Amazon S3 bucket.

- *

Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is - * equipped to decompress objects stored in S3 in one of six compressed file formats including - * bzip2, gzip, snappy, zlib, zstandard and ZIP.

- *

For information on how to view and use these functions, see Using Amazon Web Services built Lambda - * functions in the Amazon S3 User Guide.

+ * @see {@link WriteGetObjectResponseCommand} */ - public writeGetObjectResponse( + writeGetObjectResponse( args: WriteGetObjectResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public writeGetObjectResponse( + writeGetObjectResponse( args: WriteGetObjectResponseCommandInput, cb: (err: any, data?: WriteGetObjectResponseCommandOutput) => void ): void; - public writeGetObjectResponse( + writeGetObjectResponse( args: WriteGetObjectResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: WriteGetObjectResponseCommandOutput) => void ): void; - public writeGetObjectResponse( - args: WriteGetObjectResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: WriteGetObjectResponseCommandOutput) => void), - cb?: (err: any, data?: WriteGetObjectResponseCommandOutput) => void - ): Promise | void { - const command = new WriteGetObjectResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

+ */ +export class S3 extends S3Client implements S3 {} +createAggregatedClient(commands, S3); diff --git a/clients/client-s3outposts/src/S3Outposts.ts b/clients/client-s3outposts/src/S3Outposts.ts index 3aadcf240916..a1f79bd98887 100644 --- a/clients/client-s3outposts/src/S3Outposts.ts +++ b/clients/client-s3outposts/src/S3Outposts.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -26,237 +27,94 @@ import { ListSharedEndpointsCommandInput, ListSharedEndpointsCommandOutput, } from "./commands/ListSharedEndpointsCommand"; -import { S3OutpostsClient } from "./S3OutpostsClient"; +import { S3OutpostsClient, S3OutpostsClientConfig } from "./S3OutpostsClient"; -/** - * @public - *

Amazon S3 on Outposts provides access to S3 on Outposts operations.

- */ -export class S3Outposts extends S3OutpostsClient { +const commands = { + CreateEndpointCommand, + DeleteEndpointCommand, + ListEndpointsCommand, + ListOutpostsWithS3Command, + ListSharedEndpointsCommand, +}; + +export interface S3Outposts { /** - * @public - *

Creates an endpoint and associates it with the specified Outpost.

- * - *

It can take up to 5 minutes for this action to finish.

- *
- *

- *

Related actions include:

- * + * @see {@link CreateEndpointCommand} */ - public createEndpoint( + createEndpoint( args: CreateEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEndpoint( - args: CreateEndpointCommandInput, - cb: (err: any, data?: CreateEndpointCommandOutput) => void - ): void; - public createEndpoint( + createEndpoint(args: CreateEndpointCommandInput, cb: (err: any, data?: CreateEndpointCommandOutput) => void): void; + createEndpoint( args: CreateEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEndpointCommandOutput) => void ): void; - public createEndpoint( - args: CreateEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEndpointCommandOutput) => void), - cb?: (err: any, data?: CreateEndpointCommandOutput) => void - ): Promise | void { - const command = new CreateEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an endpoint.

- * - *

It can take up to 5 minutes for this action to finish.

- *
- *

- *

Related actions include:

- * + * @see {@link DeleteEndpointCommand} */ - public deleteEndpoint( + deleteEndpoint( args: DeleteEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEndpoint( - args: DeleteEndpointCommandInput, - cb: (err: any, data?: DeleteEndpointCommandOutput) => void - ): void; - public deleteEndpoint( + deleteEndpoint(args: DeleteEndpointCommandInput, cb: (err: any, data?: DeleteEndpointCommandOutput) => void): void; + deleteEndpoint( args: DeleteEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEndpointCommandOutput) => void ): void; - public deleteEndpoint( - args: DeleteEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEndpointCommandOutput) => void), - cb?: (err: any, data?: DeleteEndpointCommandOutput) => void - ): Promise | void { - const command = new DeleteEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists endpoints associated with the specified Outpost.

- *

Related actions include:

- * + * @see {@link ListEndpointsCommand} */ - public listEndpoints( - args: ListEndpointsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listEndpoints( - args: ListEndpointsCommandInput, - cb: (err: any, data?: ListEndpointsCommandOutput) => void - ): void; - public listEndpoints( + listEndpoints(args: ListEndpointsCommandInput, options?: __HttpHandlerOptions): Promise; + listEndpoints(args: ListEndpointsCommandInput, cb: (err: any, data?: ListEndpointsCommandOutput) => void): void; + listEndpoints( args: ListEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEndpointsCommandOutput) => void ): void; - public listEndpoints( - args: ListEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEndpointsCommandOutput) => void), - cb?: (err: any, data?: ListEndpointsCommandOutput) => void - ): Promise | void { - const command = new ListEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account. - * Includes S3 on Outposts that you have access to as the Outposts owner, or as a shared user - * from Resource Access Manager (RAM).

+ * @see {@link ListOutpostsWithS3Command} */ - public listOutpostsWithS3( + listOutpostsWithS3( args: ListOutpostsWithS3CommandInput, options?: __HttpHandlerOptions ): Promise; - public listOutpostsWithS3( + listOutpostsWithS3( args: ListOutpostsWithS3CommandInput, cb: (err: any, data?: ListOutpostsWithS3CommandOutput) => void ): void; - public listOutpostsWithS3( + listOutpostsWithS3( args: ListOutpostsWithS3CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOutpostsWithS3CommandOutput) => void ): void; - public listOutpostsWithS3( - args: ListOutpostsWithS3CommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOutpostsWithS3CommandOutput) => void), - cb?: (err: any, data?: ListOutpostsWithS3CommandOutput) => void - ): Promise | void { - const command = new ListOutpostsWithS3Command(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).

- *

Related actions include:

- * + * @see {@link ListSharedEndpointsCommand} */ - public listSharedEndpoints( + listSharedEndpoints( args: ListSharedEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSharedEndpoints( + listSharedEndpoints( args: ListSharedEndpointsCommandInput, cb: (err: any, data?: ListSharedEndpointsCommandOutput) => void ): void; - public listSharedEndpoints( + listSharedEndpoints( args: ListSharedEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSharedEndpointsCommandOutput) => void ): void; - public listSharedEndpoints( - args: ListSharedEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSharedEndpointsCommandOutput) => void), - cb?: (err: any, data?: ListSharedEndpointsCommandOutput) => void - ): Promise | void { - const command = new ListSharedEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon S3 on Outposts provides access to S3 on Outposts operations.

+ */ +export class S3Outposts extends S3OutpostsClient implements S3Outposts {} +createAggregatedClient(commands, S3Outposts); diff --git a/clients/client-sagemaker-a2i-runtime/src/SageMakerA2IRuntime.ts b/clients/client-sagemaker-a2i-runtime/src/SageMakerA2IRuntime.ts index a493762a249c..6b412cacad92 100644 --- a/clients/client-sagemaker-a2i-runtime/src/SageMakerA2IRuntime.ts +++ b/clients/client-sagemaker-a2i-runtime/src/SageMakerA2IRuntime.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -26,203 +27,116 @@ import { StopHumanLoopCommandInput, StopHumanLoopCommandOutput, } from "./commands/StopHumanLoopCommand"; -import { SageMakerA2IRuntimeClient } from "./SageMakerA2IRuntimeClient"; +import { SageMakerA2IRuntimeClient, SageMakerA2IRuntimeClientConfig } from "./SageMakerA2IRuntimeClient"; -/** - * @public - *

Amazon Augmented AI (Amazon A2I) adds the benefit of human judgment to any machine learning - * application. When an AI application can't evaluate data with a high degree of confidence, - * human reviewers can take over. This human review is called a human review workflow. To create - * and start a human review workflow, you need three resources: a worker task - * template, a flow definition, and a human - * loop.

- *

For information about these resources and prerequisites for using Amazon A2I, see Get Started with - * Amazon Augmented AI in the Amazon SageMaker Developer Guide.

- *

This API reference includes information about API actions and data types that you can use - * to interact with Amazon A2I programmatically. Use this guide to:

- *
    - *
  • - *

    Start a human loop with the StartHumanLoop operation when using - * Amazon A2I with a custom task type. To learn more about the - * difference between custom and built-in task types, see Use Task Types . To learn - * how to start a human loop using this API, see Create and Start a Human Loop for a Custom Task Type in the - * Amazon SageMaker Developer Guide.

    - *
  • - *
  • - *

    Manage your human loops. You can list all human loops that you have created, describe - * individual human loops, and stop and delete human loops. To learn more, see Monitor and Manage Your Human Loop in the Amazon SageMaker Developer Guide.

    - *
  • - *
- *

Amazon A2I integrates APIs from various AWS services to create and start human review - * workflows for those services. To learn how Amazon A2I uses these APIs, see Use APIs in - * Amazon A2I in the Amazon SageMaker Developer Guide.

- */ -export class SageMakerA2IRuntime extends SageMakerA2IRuntimeClient { +const commands = { + DeleteHumanLoopCommand, + DescribeHumanLoopCommand, + ListHumanLoopsCommand, + StartHumanLoopCommand, + StopHumanLoopCommand, +}; + +export interface SageMakerA2IRuntime { /** - * @public - *

Deletes the specified human loop for a flow definition.

- *

If the human loop was deleted, this operation will return a - * ResourceNotFoundException.

+ * @see {@link DeleteHumanLoopCommand} */ - public deleteHumanLoop( + deleteHumanLoop( args: DeleteHumanLoopCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteHumanLoop( - args: DeleteHumanLoopCommandInput, - cb: (err: any, data?: DeleteHumanLoopCommandOutput) => void - ): void; - public deleteHumanLoop( + deleteHumanLoop(args: DeleteHumanLoopCommandInput, cb: (err: any, data?: DeleteHumanLoopCommandOutput) => void): void; + deleteHumanLoop( args: DeleteHumanLoopCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHumanLoopCommandOutput) => void ): void; - public deleteHumanLoop( - args: DeleteHumanLoopCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteHumanLoopCommandOutput) => void), - cb?: (err: any, data?: DeleteHumanLoopCommandOutput) => void - ): Promise | void { - const command = new DeleteHumanLoopCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the specified human loop. If the human loop was deleted, this - * operation will return a ResourceNotFoundException error.

+ * @see {@link DescribeHumanLoopCommand} */ - public describeHumanLoop( + describeHumanLoop( args: DescribeHumanLoopCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeHumanLoop( + describeHumanLoop( args: DescribeHumanLoopCommandInput, cb: (err: any, data?: DescribeHumanLoopCommandOutput) => void ): void; - public describeHumanLoop( + describeHumanLoop( args: DescribeHumanLoopCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHumanLoopCommandOutput) => void ): void; - public describeHumanLoop( - args: DescribeHumanLoopCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeHumanLoopCommandOutput) => void), - cb?: (err: any, data?: DescribeHumanLoopCommandOutput) => void - ): Promise | void { - const command = new DescribeHumanLoopCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about human loops, given the specified parameters. If a human loop was deleted, it will not be included.

+ * @see {@link ListHumanLoopsCommand} */ - public listHumanLoops( + listHumanLoops( args: ListHumanLoopsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listHumanLoops( - args: ListHumanLoopsCommandInput, - cb: (err: any, data?: ListHumanLoopsCommandOutput) => void - ): void; - public listHumanLoops( + listHumanLoops(args: ListHumanLoopsCommandInput, cb: (err: any, data?: ListHumanLoopsCommandOutput) => void): void; + listHumanLoops( args: ListHumanLoopsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHumanLoopsCommandOutput) => void ): void; - public listHumanLoops( - args: ListHumanLoopsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListHumanLoopsCommandOutput) => void), - cb?: (err: any, data?: ListHumanLoopsCommandOutput) => void - ): Promise | void { - const command = new ListHumanLoopsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a human loop, provided that at least one activation condition is met.

+ * @see {@link StartHumanLoopCommand} */ - public startHumanLoop( + startHumanLoop( args: StartHumanLoopCommandInput, options?: __HttpHandlerOptions ): Promise; - public startHumanLoop( - args: StartHumanLoopCommandInput, - cb: (err: any, data?: StartHumanLoopCommandOutput) => void - ): void; - public startHumanLoop( + startHumanLoop(args: StartHumanLoopCommandInput, cb: (err: any, data?: StartHumanLoopCommandOutput) => void): void; + startHumanLoop( args: StartHumanLoopCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartHumanLoopCommandOutput) => void ): void; - public startHumanLoop( - args: StartHumanLoopCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartHumanLoopCommandOutput) => void), - cb?: (err: any, data?: StartHumanLoopCommandOutput) => void - ): Promise | void { - const command = new StartHumanLoopCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops the specified human loop.

+ * @see {@link StopHumanLoopCommand} */ - public stopHumanLoop( - args: StopHumanLoopCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public stopHumanLoop( - args: StopHumanLoopCommandInput, - cb: (err: any, data?: StopHumanLoopCommandOutput) => void - ): void; - public stopHumanLoop( + stopHumanLoop(args: StopHumanLoopCommandInput, options?: __HttpHandlerOptions): Promise; + stopHumanLoop(args: StopHumanLoopCommandInput, cb: (err: any, data?: StopHumanLoopCommandOutput) => void): void; + stopHumanLoop( args: StopHumanLoopCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopHumanLoopCommandOutput) => void ): void; - public stopHumanLoop( - args: StopHumanLoopCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopHumanLoopCommandOutput) => void), - cb?: (err: any, data?: StopHumanLoopCommandOutput) => void - ): Promise | void { - const command = new StopHumanLoopCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Augmented AI (Amazon A2I) adds the benefit of human judgment to any machine learning + * application. When an AI application can't evaluate data with a high degree of confidence, + * human reviewers can take over. This human review is called a human review workflow. To create + * and start a human review workflow, you need three resources: a worker task + * template, a flow definition, and a human + * loop.

+ *

For information about these resources and prerequisites for using Amazon A2I, see Get Started with + * Amazon Augmented AI in the Amazon SageMaker Developer Guide.

+ *

This API reference includes information about API actions and data types that you can use + * to interact with Amazon A2I programmatically. Use this guide to:

+ *
    + *
  • + *

    Start a human loop with the StartHumanLoop operation when using + * Amazon A2I with a custom task type. To learn more about the + * difference between custom and built-in task types, see Use Task Types . To learn + * how to start a human loop using this API, see Create and Start a Human Loop for a Custom Task Type in the + * Amazon SageMaker Developer Guide.

    + *
  • + *
  • + *

    Manage your human loops. You can list all human loops that you have created, describe + * individual human loops, and stop and delete human loops. To learn more, see Monitor and Manage Your Human Loop in the Amazon SageMaker Developer Guide.

    + *
  • + *
+ *

Amazon A2I integrates APIs from various AWS services to create and start human review + * workflows for those services. To learn how Amazon A2I uses these APIs, see Use APIs in + * Amazon A2I in the Amazon SageMaker Developer Guide.

+ */ +export class SageMakerA2IRuntime extends SageMakerA2IRuntimeClient implements SageMakerA2IRuntime {} +createAggregatedClient(commands, SageMakerA2IRuntime); diff --git a/clients/client-sagemaker-edge/src/SagemakerEdge.ts b/clients/client-sagemaker-edge/src/SagemakerEdge.ts index 7b15032f7aeb..e049c32e19e4 100644 --- a/clients/client-sagemaker-edge/src/SagemakerEdge.ts +++ b/clients/client-sagemaker-edge/src/SagemakerEdge.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -16,109 +17,61 @@ import { SendHeartbeatCommandInput, SendHeartbeatCommandOutput, } from "./commands/SendHeartbeatCommand"; -import { SagemakerEdgeClient } from "./SagemakerEdgeClient"; +import { SagemakerEdgeClient, SagemakerEdgeClientConfig } from "./SagemakerEdgeClient"; -/** - * @public - *

SageMaker Edge Manager dataplane service for communicating with active agents.

- */ -export class SagemakerEdge extends SagemakerEdgeClient { +const commands = { + GetDeploymentsCommand, + GetDeviceRegistrationCommand, + SendHeartbeatCommand, +}; + +export interface SagemakerEdge { /** - * @public - *

Use to get the active deployments from a device.

+ * @see {@link GetDeploymentsCommand} */ - public getDeployments( + getDeployments( args: GetDeploymentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDeployments( - args: GetDeploymentsCommandInput, - cb: (err: any, data?: GetDeploymentsCommandOutput) => void - ): void; - public getDeployments( + getDeployments(args: GetDeploymentsCommandInput, cb: (err: any, data?: GetDeploymentsCommandOutput) => void): void; + getDeployments( args: GetDeploymentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeploymentsCommandOutput) => void ): void; - public getDeployments( - args: GetDeploymentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeploymentsCommandOutput) => void), - cb?: (err: any, data?: GetDeploymentsCommandOutput) => void - ): Promise | void { - const command = new GetDeploymentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use to check if a device is registered with SageMaker Edge Manager.

+ * @see {@link GetDeviceRegistrationCommand} */ - public getDeviceRegistration( + getDeviceRegistration( args: GetDeviceRegistrationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDeviceRegistration( + getDeviceRegistration( args: GetDeviceRegistrationCommandInput, cb: (err: any, data?: GetDeviceRegistrationCommandOutput) => void ): void; - public getDeviceRegistration( + getDeviceRegistration( args: GetDeviceRegistrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeviceRegistrationCommandOutput) => void ): void; - public getDeviceRegistration( - args: GetDeviceRegistrationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeviceRegistrationCommandOutput) => void), - cb?: (err: any, data?: GetDeviceRegistrationCommandOutput) => void - ): Promise | void { - const command = new GetDeviceRegistrationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use to get the current status of devices registered on SageMaker Edge Manager.

+ * @see {@link SendHeartbeatCommand} */ - public sendHeartbeat( - args: SendHeartbeatCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public sendHeartbeat( - args: SendHeartbeatCommandInput, - cb: (err: any, data?: SendHeartbeatCommandOutput) => void - ): void; - public sendHeartbeat( + sendHeartbeat(args: SendHeartbeatCommandInput, options?: __HttpHandlerOptions): Promise; + sendHeartbeat(args: SendHeartbeatCommandInput, cb: (err: any, data?: SendHeartbeatCommandOutput) => void): void; + sendHeartbeat( args: SendHeartbeatCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendHeartbeatCommandOutput) => void ): void; - public sendHeartbeat( - args: SendHeartbeatCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendHeartbeatCommandOutput) => void), - cb?: (err: any, data?: SendHeartbeatCommandOutput) => void - ): Promise | void { - const command = new SendHeartbeatCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

SageMaker Edge Manager dataplane service for communicating with active agents.

+ */ +export class SagemakerEdge extends SagemakerEdgeClient implements SagemakerEdge {} +createAggregatedClient(commands, SagemakerEdge); diff --git a/clients/client-sagemaker-featurestore-runtime/src/SageMakerFeatureStoreRuntime.ts b/clients/client-sagemaker-featurestore-runtime/src/SageMakerFeatureStoreRuntime.ts index 9f4eba455e86..a812b1104cf8 100644 --- a/clients/client-sagemaker-featurestore-runtime/src/SageMakerFeatureStoreRuntime.ts +++ b/clients/client-sagemaker-featurestore-runtime/src/SageMakerFeatureStoreRuntime.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -13,184 +14,98 @@ import { } from "./commands/DeleteRecordCommand"; import { GetRecordCommand, GetRecordCommandInput, GetRecordCommandOutput } from "./commands/GetRecordCommand"; import { PutRecordCommand, PutRecordCommandInput, PutRecordCommandOutput } from "./commands/PutRecordCommand"; -import { SageMakerFeatureStoreRuntimeClient } from "./SageMakerFeatureStoreRuntimeClient"; +import { + SageMakerFeatureStoreRuntimeClient, + SageMakerFeatureStoreRuntimeClientConfig, +} from "./SageMakerFeatureStoreRuntimeClient"; -/** - * @public - *

Contains all data plane API operations and data types for the Amazon SageMaker Feature - * Store. Use this API to put, delete, and retrieve (get) features from a feature - * store.

- *

Use the following operations to configure your OnlineStore and - * OfflineStore features, and to create and manage feature groups:

- * - */ -export class SageMakerFeatureStoreRuntime extends SageMakerFeatureStoreRuntimeClient { +const commands = { + BatchGetRecordCommand, + DeleteRecordCommand, + GetRecordCommand, + PutRecordCommand, +}; + +export interface SageMakerFeatureStoreRuntime { /** - * @public - *

Retrieves a batch of Records from a FeatureGroup.

+ * @see {@link BatchGetRecordCommand} */ - public batchGetRecord( + batchGetRecord( args: BatchGetRecordCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetRecord( - args: BatchGetRecordCommandInput, - cb: (err: any, data?: BatchGetRecordCommandOutput) => void - ): void; - public batchGetRecord( + batchGetRecord(args: BatchGetRecordCommandInput, cb: (err: any, data?: BatchGetRecordCommandOutput) => void): void; + batchGetRecord( args: BatchGetRecordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetRecordCommandOutput) => void ): void; - public batchGetRecord( - args: BatchGetRecordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetRecordCommandOutput) => void), - cb?: (err: any, data?: BatchGetRecordCommandOutput) => void - ): Promise | void { - const command = new BatchGetRecordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Record from a FeatureGroup in the - * OnlineStore. Feature Store supports both SOFT_DELETE and - * HARD_DELETE. For SOFT_DELETE (default), feature columns are - * set to null and the record is no longer retrievable by GetRecord - * or BatchGetRecord. For HARD_DELETE, the complete - * Record is removed from the OnlineStore. In both cases, Feature - * Store appends the deleted record marker to the OfflineStore with feature - * values set to null, is_deleted value set to True, - * and EventTime set to the delete input EventTime.

- *

Note that the EventTime specified in DeleteRecord should be - * set later than the EventTime of the existing record in the - * OnlineStore for that RecordIdentifer. If it is not, the - * deletion does not occur:

- *
    - *
  • - *

    For SOFT_DELETE, the existing (undeleted) record remains in the - * OnlineStore, though the delete record marker is still written to the - * OfflineStore.

    - *
  • - *
  • - *

    - * HARD_DELETE returns EventTime: 400 - * ValidationException to indicate that the delete operation failed. No delete - * record marker is written to the OfflineStore.

    - *
  • - *
+ * @see {@link DeleteRecordCommand} */ - public deleteRecord( - args: DeleteRecordCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteRecord(args: DeleteRecordCommandInput, cb: (err: any, data?: DeleteRecordCommandOutput) => void): void; - public deleteRecord( + deleteRecord(args: DeleteRecordCommandInput, options?: __HttpHandlerOptions): Promise; + deleteRecord(args: DeleteRecordCommandInput, cb: (err: any, data?: DeleteRecordCommandOutput) => void): void; + deleteRecord( args: DeleteRecordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRecordCommandOutput) => void ): void; - public deleteRecord( - args: DeleteRecordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRecordCommandOutput) => void), - cb?: (err: any, data?: DeleteRecordCommandOutput) => void - ): Promise | void { - const command = new DeleteRecordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use for OnlineStore serving from a FeatureStore. Only the - * latest records stored in the OnlineStore can be retrieved. If no Record with - * RecordIdentifierValue is found, then an empty result is returned.

+ * @see {@link GetRecordCommand} */ - public getRecord(args: GetRecordCommandInput, options?: __HttpHandlerOptions): Promise; - public getRecord(args: GetRecordCommandInput, cb: (err: any, data?: GetRecordCommandOutput) => void): void; - public getRecord( + getRecord(args: GetRecordCommandInput, options?: __HttpHandlerOptions): Promise; + getRecord(args: GetRecordCommandInput, cb: (err: any, data?: GetRecordCommandOutput) => void): void; + getRecord( args: GetRecordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRecordCommandOutput) => void ): void; - public getRecord( - args: GetRecordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRecordCommandOutput) => void), - cb?: (err: any, data?: GetRecordCommandOutput) => void - ): Promise | void { - const command = new GetRecordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used for data ingestion into the FeatureStore. The PutRecord - * API writes to both the OnlineStore and OfflineStore. If the - * record is the latest record for the recordIdentifier, the record is written to - * both the OnlineStore and OfflineStore. If the record is a - * historic record, it is written only to the OfflineStore.

+ * @see {@link PutRecordCommand} */ - public putRecord(args: PutRecordCommandInput, options?: __HttpHandlerOptions): Promise; - public putRecord(args: PutRecordCommandInput, cb: (err: any, data?: PutRecordCommandOutput) => void): void; - public putRecord( + putRecord(args: PutRecordCommandInput, options?: __HttpHandlerOptions): Promise; + putRecord(args: PutRecordCommandInput, cb: (err: any, data?: PutRecordCommandOutput) => void): void; + putRecord( args: PutRecordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRecordCommandOutput) => void ): void; - public putRecord( - args: PutRecordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRecordCommandOutput) => void), - cb?: (err: any, data?: PutRecordCommandOutput) => void - ): Promise | void { - const command = new PutRecordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Contains all data plane API operations and data types for the Amazon SageMaker Feature + * Store. Use this API to put, delete, and retrieve (get) features from a feature + * store.

+ *

Use the following operations to configure your OnlineStore and + * OfflineStore features, and to create and manage feature groups:

+ * + */ +export class SageMakerFeatureStoreRuntime + extends SageMakerFeatureStoreRuntimeClient + implements SageMakerFeatureStoreRuntime {} +createAggregatedClient(commands, SageMakerFeatureStoreRuntime); diff --git a/clients/client-sagemaker-geospatial/src/SageMakerGeospatial.ts b/clients/client-sagemaker-geospatial/src/SageMakerGeospatial.ts index 7551427fc24a..0c58443c2721 100644 --- a/clients/client-sagemaker-geospatial/src/SageMakerGeospatial.ts +++ b/clients/client-sagemaker-geospatial/src/SageMakerGeospatial.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -88,625 +89,340 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; -import { SageMakerGeospatialClient } from "./SageMakerGeospatialClient"; +import { SageMakerGeospatialClient, SageMakerGeospatialClientConfig } from "./SageMakerGeospatialClient"; -/** - * @public - *

Provides APIs for creating and managing SageMaker geospatial resources.

- */ -export class SageMakerGeospatial extends SageMakerGeospatialClient { +const commands = { + DeleteEarthObservationJobCommand, + DeleteVectorEnrichmentJobCommand, + ExportEarthObservationJobCommand, + ExportVectorEnrichmentJobCommand, + GetEarthObservationJobCommand, + GetRasterDataCollectionCommand, + GetTileCommand, + GetVectorEnrichmentJobCommand, + ListEarthObservationJobsCommand, + ListRasterDataCollectionsCommand, + ListTagsForResourceCommand, + ListVectorEnrichmentJobsCommand, + SearchRasterDataCollectionCommand, + StartEarthObservationJobCommand, + StartVectorEnrichmentJobCommand, + StopEarthObservationJobCommand, + StopVectorEnrichmentJobCommand, + TagResourceCommand, + UntagResourceCommand, +}; + +export interface SageMakerGeospatial { /** - * @public - *

Use this operation to delete an Earth Observation job.

+ * @see {@link DeleteEarthObservationJobCommand} */ - public deleteEarthObservationJob( + deleteEarthObservationJob( args: DeleteEarthObservationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEarthObservationJob( + deleteEarthObservationJob( args: DeleteEarthObservationJobCommandInput, cb: (err: any, data?: DeleteEarthObservationJobCommandOutput) => void ): void; - public deleteEarthObservationJob( + deleteEarthObservationJob( args: DeleteEarthObservationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEarthObservationJobCommandOutput) => void ): void; - public deleteEarthObservationJob( - args: DeleteEarthObservationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEarthObservationJobCommandOutput) => void), - cb?: (err: any, data?: DeleteEarthObservationJobCommandOutput) => void - ): Promise | void { - const command = new DeleteEarthObservationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this operation to delete a Vector Enrichment job.

+ * @see {@link DeleteVectorEnrichmentJobCommand} */ - public deleteVectorEnrichmentJob( + deleteVectorEnrichmentJob( args: DeleteVectorEnrichmentJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVectorEnrichmentJob( + deleteVectorEnrichmentJob( args: DeleteVectorEnrichmentJobCommandInput, cb: (err: any, data?: DeleteVectorEnrichmentJobCommandOutput) => void ): void; - public deleteVectorEnrichmentJob( + deleteVectorEnrichmentJob( args: DeleteVectorEnrichmentJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVectorEnrichmentJobCommandOutput) => void ): void; - public deleteVectorEnrichmentJob( - args: DeleteVectorEnrichmentJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVectorEnrichmentJobCommandOutput) => void), - cb?: (err: any, data?: DeleteVectorEnrichmentJobCommandOutput) => void - ): Promise | void { - const command = new DeleteVectorEnrichmentJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this operation to export results of an Earth Observation job and optionally source images used as input to the EOJ to an Amazon S3 location.

+ * @see {@link ExportEarthObservationJobCommand} */ - public exportEarthObservationJob( + exportEarthObservationJob( args: ExportEarthObservationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public exportEarthObservationJob( + exportEarthObservationJob( args: ExportEarthObservationJobCommandInput, cb: (err: any, data?: ExportEarthObservationJobCommandOutput) => void ): void; - public exportEarthObservationJob( + exportEarthObservationJob( args: ExportEarthObservationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportEarthObservationJobCommandOutput) => void ): void; - public exportEarthObservationJob( - args: ExportEarthObservationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportEarthObservationJobCommandOutput) => void), - cb?: (err: any, data?: ExportEarthObservationJobCommandOutput) => void - ): Promise | void { - const command = new ExportEarthObservationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.

+ * @see {@link ExportVectorEnrichmentJobCommand} */ - public exportVectorEnrichmentJob( + exportVectorEnrichmentJob( args: ExportVectorEnrichmentJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public exportVectorEnrichmentJob( + exportVectorEnrichmentJob( args: ExportVectorEnrichmentJobCommandInput, cb: (err: any, data?: ExportVectorEnrichmentJobCommandOutput) => void ): void; - public exportVectorEnrichmentJob( + exportVectorEnrichmentJob( args: ExportVectorEnrichmentJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportVectorEnrichmentJobCommandOutput) => void ): void; - public exportVectorEnrichmentJob( - args: ExportVectorEnrichmentJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportVectorEnrichmentJobCommandOutput) => void), - cb?: (err: any, data?: ExportVectorEnrichmentJobCommandOutput) => void - ): Promise | void { - const command = new ExportVectorEnrichmentJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the details for a previously initiated Earth Observation job.

+ * @see {@link GetEarthObservationJobCommand} */ - public getEarthObservationJob( + getEarthObservationJob( args: GetEarthObservationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEarthObservationJob( + getEarthObservationJob( args: GetEarthObservationJobCommandInput, cb: (err: any, data?: GetEarthObservationJobCommandOutput) => void ): void; - public getEarthObservationJob( + getEarthObservationJob( args: GetEarthObservationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEarthObservationJobCommandOutput) => void ): void; - public getEarthObservationJob( - args: GetEarthObservationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEarthObservationJobCommandOutput) => void), - cb?: (err: any, data?: GetEarthObservationJobCommandOutput) => void - ): Promise | void { - const command = new GetEarthObservationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this operation to get details of a specific raster data collection.

+ * @see {@link GetRasterDataCollectionCommand} */ - public getRasterDataCollection( + getRasterDataCollection( args: GetRasterDataCollectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRasterDataCollection( + getRasterDataCollection( args: GetRasterDataCollectionCommandInput, cb: (err: any, data?: GetRasterDataCollectionCommandOutput) => void ): void; - public getRasterDataCollection( + getRasterDataCollection( args: GetRasterDataCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRasterDataCollectionCommandOutput) => void ): void; - public getRasterDataCollection( - args: GetRasterDataCollectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRasterDataCollectionCommandOutput) => void), - cb?: (err: any, data?: GetRasterDataCollectionCommandOutput) => void - ): Promise | void { - const command = new GetRasterDataCollectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a web mercator tile for the given Earth Observation job.

+ * @see {@link GetTileCommand} */ - public getTile(args: GetTileCommandInput, options?: __HttpHandlerOptions): Promise; - public getTile(args: GetTileCommandInput, cb: (err: any, data?: GetTileCommandOutput) => void): void; - public getTile( + getTile(args: GetTileCommandInput, options?: __HttpHandlerOptions): Promise; + getTile(args: GetTileCommandInput, cb: (err: any, data?: GetTileCommandOutput) => void): void; + getTile( args: GetTileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTileCommandOutput) => void ): void; - public getTile( - args: GetTileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTileCommandOutput) => void), - cb?: (err: any, data?: GetTileCommandOutput) => void - ): Promise | void { - const command = new GetTileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).

+ * @see {@link GetVectorEnrichmentJobCommand} */ - public getVectorEnrichmentJob( + getVectorEnrichmentJob( args: GetVectorEnrichmentJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVectorEnrichmentJob( + getVectorEnrichmentJob( args: GetVectorEnrichmentJobCommandInput, cb: (err: any, data?: GetVectorEnrichmentJobCommandOutput) => void ): void; - public getVectorEnrichmentJob( + getVectorEnrichmentJob( args: GetVectorEnrichmentJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVectorEnrichmentJobCommandOutput) => void ): void; - public getVectorEnrichmentJob( - args: GetVectorEnrichmentJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVectorEnrichmentJobCommandOutput) => void), - cb?: (err: any, data?: GetVectorEnrichmentJobCommandOutput) => void - ): Promise | void { - const command = new GetVectorEnrichmentJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.

+ * @see {@link ListEarthObservationJobsCommand} */ - public listEarthObservationJobs( + listEarthObservationJobs( args: ListEarthObservationJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEarthObservationJobs( + listEarthObservationJobs( args: ListEarthObservationJobsCommandInput, cb: (err: any, data?: ListEarthObservationJobsCommandOutput) => void ): void; - public listEarthObservationJobs( + listEarthObservationJobs( args: ListEarthObservationJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEarthObservationJobsCommandOutput) => void ): void; - public listEarthObservationJobs( - args: ListEarthObservationJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEarthObservationJobsCommandOutput) => void), - cb?: (err: any, data?: ListEarthObservationJobsCommandOutput) => void - ): Promise | void { - const command = new ListEarthObservationJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this operation to get raster data collections.

+ * @see {@link ListRasterDataCollectionsCommand} */ - public listRasterDataCollections( + listRasterDataCollections( args: ListRasterDataCollectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRasterDataCollections( + listRasterDataCollections( args: ListRasterDataCollectionsCommandInput, cb: (err: any, data?: ListRasterDataCollectionsCommandOutput) => void ): void; - public listRasterDataCollections( + listRasterDataCollections( args: ListRasterDataCollectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRasterDataCollectionsCommandOutput) => void ): void; - public listRasterDataCollections( - args: ListRasterDataCollectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRasterDataCollectionsCommandOutput) => void), - cb?: (err: any, data?: ListRasterDataCollectionsCommandOutput) => void - ): Promise | void { - const command = new ListRasterDataCollectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags attached to the resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of vector enrichment jobs.

+ * @see {@link ListVectorEnrichmentJobsCommand} */ - public listVectorEnrichmentJobs( + listVectorEnrichmentJobs( args: ListVectorEnrichmentJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVectorEnrichmentJobs( + listVectorEnrichmentJobs( args: ListVectorEnrichmentJobsCommandInput, cb: (err: any, data?: ListVectorEnrichmentJobsCommandOutput) => void ): void; - public listVectorEnrichmentJobs( + listVectorEnrichmentJobs( args: ListVectorEnrichmentJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVectorEnrichmentJobsCommandOutput) => void ): void; - public listVectorEnrichmentJobs( - args: ListVectorEnrichmentJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVectorEnrichmentJobsCommandOutput) => void), - cb?: (err: any, data?: ListVectorEnrichmentJobsCommandOutput) => void - ): Promise | void { - const command = new ListVectorEnrichmentJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.

+ * @see {@link SearchRasterDataCollectionCommand} */ - public searchRasterDataCollection( + searchRasterDataCollection( args: SearchRasterDataCollectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchRasterDataCollection( + searchRasterDataCollection( args: SearchRasterDataCollectionCommandInput, cb: (err: any, data?: SearchRasterDataCollectionCommandOutput) => void ): void; - public searchRasterDataCollection( + searchRasterDataCollection( args: SearchRasterDataCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchRasterDataCollectionCommandOutput) => void ): void; - public searchRasterDataCollection( - args: SearchRasterDataCollectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchRasterDataCollectionCommandOutput) => void), - cb?: (err: any, data?: SearchRasterDataCollectionCommandOutput) => void - ): Promise | void { - const command = new SearchRasterDataCollectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this operation to create an Earth observation job.

+ * @see {@link StartEarthObservationJobCommand} */ - public startEarthObservationJob( + startEarthObservationJob( args: StartEarthObservationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startEarthObservationJob( + startEarthObservationJob( args: StartEarthObservationJobCommandInput, cb: (err: any, data?: StartEarthObservationJobCommandOutput) => void ): void; - public startEarthObservationJob( + startEarthObservationJob( args: StartEarthObservationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartEarthObservationJobCommandOutput) => void ): void; - public startEarthObservationJob( - args: StartEarthObservationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartEarthObservationJobCommandOutput) => void), - cb?: (err: any, data?: StartEarthObservationJobCommandOutput) => void - ): Promise | void { - const command = new StartEarthObservationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse geocoding and map matching.

+ * @see {@link StartVectorEnrichmentJobCommand} */ - public startVectorEnrichmentJob( + startVectorEnrichmentJob( args: StartVectorEnrichmentJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startVectorEnrichmentJob( + startVectorEnrichmentJob( args: StartVectorEnrichmentJobCommandInput, cb: (err: any, data?: StartVectorEnrichmentJobCommandOutput) => void ): void; - public startVectorEnrichmentJob( + startVectorEnrichmentJob( args: StartVectorEnrichmentJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartVectorEnrichmentJobCommandOutput) => void ): void; - public startVectorEnrichmentJob( - args: StartVectorEnrichmentJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartVectorEnrichmentJobCommandOutput) => void), - cb?: (err: any, data?: StartVectorEnrichmentJobCommandOutput) => void - ): Promise | void { - const command = new StartVectorEnrichmentJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this operation to stop an existing earth observation job.

+ * @see {@link StopEarthObservationJobCommand} */ - public stopEarthObservationJob( + stopEarthObservationJob( args: StopEarthObservationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopEarthObservationJob( + stopEarthObservationJob( args: StopEarthObservationJobCommandInput, cb: (err: any, data?: StopEarthObservationJobCommandOutput) => void ): void; - public stopEarthObservationJob( + stopEarthObservationJob( args: StopEarthObservationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopEarthObservationJobCommandOutput) => void ): void; - public stopEarthObservationJob( - args: StopEarthObservationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopEarthObservationJobCommandOutput) => void), - cb?: (err: any, data?: StopEarthObservationJobCommandOutput) => void - ): Promise | void { - const command = new StopEarthObservationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops the Vector Enrichment job for a given job ARN.

+ * @see {@link StopVectorEnrichmentJobCommand} */ - public stopVectorEnrichmentJob( + stopVectorEnrichmentJob( args: StopVectorEnrichmentJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopVectorEnrichmentJob( + stopVectorEnrichmentJob( args: StopVectorEnrichmentJobCommandInput, cb: (err: any, data?: StopVectorEnrichmentJobCommandOutput) => void ): void; - public stopVectorEnrichmentJob( + stopVectorEnrichmentJob( args: StopVectorEnrichmentJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopVectorEnrichmentJobCommandOutput) => void ): void; - public stopVectorEnrichmentJob( - args: StopVectorEnrichmentJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopVectorEnrichmentJobCommandOutput) => void), - cb?: (err: any, data?: StopVectorEnrichmentJobCommandOutput) => void - ): Promise | void { - const command = new StopVectorEnrichmentJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The resource you want to tag.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The resource you want to untag.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Provides APIs for creating and managing SageMaker geospatial resources.

+ */ +export class SageMakerGeospatial extends SageMakerGeospatialClient implements SageMakerGeospatial {} +createAggregatedClient(commands, SageMakerGeospatial); diff --git a/clients/client-sagemaker-metrics/src/SageMakerMetrics.ts b/clients/client-sagemaker-metrics/src/SageMakerMetrics.ts index 13ffd54e0bbe..e99cf0ebcf61 100644 --- a/clients/client-sagemaker-metrics/src/SageMakerMetrics.ts +++ b/clients/client-sagemaker-metrics/src/SageMakerMetrics.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -6,7 +7,27 @@ import { BatchPutMetricsCommandInput, BatchPutMetricsCommandOutput, } from "./commands/BatchPutMetricsCommand"; -import { SageMakerMetricsClient } from "./SageMakerMetricsClient"; +import { SageMakerMetricsClient, SageMakerMetricsClientConfig } from "./SageMakerMetricsClient"; + +const commands = { + BatchPutMetricsCommand, +}; + +export interface SageMakerMetrics { + /** + * @see {@link BatchPutMetricsCommand} + */ + batchPutMetrics( + args: BatchPutMetricsCommandInput, + options?: __HttpHandlerOptions + ): Promise; + batchPutMetrics(args: BatchPutMetricsCommandInput, cb: (err: any, data?: BatchPutMetricsCommandOutput) => void): void; + batchPutMetrics( + args: BatchPutMetricsCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: BatchPutMetricsCommandOutput) => void + ): void; +} /** * @public @@ -20,39 +41,5 @@ import { SageMakerMetricsClient } from "./SageMakerMetricsClient"; * * */ -export class SageMakerMetrics extends SageMakerMetricsClient { - /** - * @public - *

Used to ingest training metrics into SageMaker. These metrics can be visualized in SageMaker Studio and - * retrieved with the GetMetrics API. - *

- */ - public batchPutMetrics( - args: BatchPutMetricsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public batchPutMetrics( - args: BatchPutMetricsCommandInput, - cb: (err: any, data?: BatchPutMetricsCommandOutput) => void - ): void; - public batchPutMetrics( - args: BatchPutMetricsCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: BatchPutMetricsCommandOutput) => void - ): void; - public batchPutMetrics( - args: BatchPutMetricsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchPutMetricsCommandOutput) => void), - cb?: (err: any, data?: BatchPutMetricsCommandOutput) => void - ): Promise | void { - const command = new BatchPutMetricsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } -} +export class SageMakerMetrics extends SageMakerMetricsClient implements SageMakerMetrics {} +createAggregatedClient(commands, SageMakerMetrics); diff --git a/clients/client-sagemaker-runtime/src/SageMakerRuntime.ts b/clients/client-sagemaker-runtime/src/SageMakerRuntime.ts index 7a67ecf9cdb4..2b8c18dca7c7 100644 --- a/clients/client-sagemaker-runtime/src/SageMakerRuntime.ts +++ b/clients/client-sagemaker-runtime/src/SageMakerRuntime.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -11,106 +12,49 @@ import { InvokeEndpointCommandInput, InvokeEndpointCommandOutput, } from "./commands/InvokeEndpointCommand"; -import { SageMakerRuntimeClient } from "./SageMakerRuntimeClient"; +import { SageMakerRuntimeClient, SageMakerRuntimeClientConfig } from "./SageMakerRuntimeClient"; -/** - * @public - *

The Amazon SageMaker runtime API.

- */ -export class SageMakerRuntime extends SageMakerRuntimeClient { +const commands = { + InvokeEndpointCommand, + InvokeEndpointAsyncCommand, +}; + +export interface SageMakerRuntime { /** - * @public - *

After you deploy a model into production using Amazon SageMaker hosting services, your - * client applications use this API to get inferences from the model hosted at the - * specified endpoint.

- *

For an overview of Amazon SageMaker, see How It Works.

- *

Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add - * additional headers. You should not rely on the behavior of headers outside those - * enumerated in the request syntax.

- *

Calls to InvokeEndpoint are authenticated by using Amazon Web Services - * Signature Version 4. For information, see Authenticating - * Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API - * Reference.

- *

A customer's model containers must respond to requests within 60 seconds. The model - * itself can have a maximum processing time of 60 seconds before responding to - * invocations. If your model is going to take 50-60 seconds of processing time, the SDK - * socket timeout should be set to be 70 seconds.

- * - *

Endpoints are scoped to an individual account, and are not public. The URL does - * not contain the account ID, but Amazon SageMaker determines the account ID from the - * authentication token that is supplied by the caller.

- *
+ * @see {@link InvokeEndpointCommand} */ - public invokeEndpoint( + invokeEndpoint( args: InvokeEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public invokeEndpoint( - args: InvokeEndpointCommandInput, - cb: (err: any, data?: InvokeEndpointCommandOutput) => void - ): void; - public invokeEndpoint( + invokeEndpoint(args: InvokeEndpointCommandInput, cb: (err: any, data?: InvokeEndpointCommandOutput) => void): void; + invokeEndpoint( args: InvokeEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InvokeEndpointCommandOutput) => void ): void; - public invokeEndpoint( - args: InvokeEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InvokeEndpointCommandOutput) => void), - cb?: (err: any, data?: InvokeEndpointCommandOutput) => void - ): Promise | void { - const command = new InvokeEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

After you deploy a model into production using Amazon SageMaker hosting services, your client - * applications use this API to get inferences from the model hosted at the specified - * endpoint in an asynchronous manner.

- *

Inference requests sent to this API are enqueued for asynchronous processing. The - * processing of the inference request may or may not complete before you receive a - * response from this API. The response from this API will not contain the result of the - * inference request but contain information about where you can locate it.

- *

Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker - * might add additional headers. You should not rely on the behavior of headers outside - * those enumerated in the request syntax.

- *

Calls to InvokeEndpointAsync are authenticated by using Amazon Web Services Signature Version 4. For information, see Authenticating Requests (Amazon Web Services Signature Version 4) in the - * Amazon S3 API Reference.

+ * @see {@link InvokeEndpointAsyncCommand} */ - public invokeEndpointAsync( + invokeEndpointAsync( args: InvokeEndpointAsyncCommandInput, options?: __HttpHandlerOptions ): Promise; - public invokeEndpointAsync( + invokeEndpointAsync( args: InvokeEndpointAsyncCommandInput, cb: (err: any, data?: InvokeEndpointAsyncCommandOutput) => void ): void; - public invokeEndpointAsync( + invokeEndpointAsync( args: InvokeEndpointAsyncCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InvokeEndpointAsyncCommandOutput) => void ): void; - public invokeEndpointAsync( - args: InvokeEndpointAsyncCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InvokeEndpointAsyncCommandOutput) => void), - cb?: (err: any, data?: InvokeEndpointAsyncCommandOutput) => void - ): Promise | void { - const command = new InvokeEndpointAsyncCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The Amazon SageMaker runtime API.

+ */ +export class SageMakerRuntime extends SageMakerRuntimeClient implements SageMakerRuntime {} +createAggregatedClient(commands, SageMakerRuntime); diff --git a/clients/client-sagemaker/src/SageMaker.ts b/clients/client-sagemaker/src/SageMaker.ts index e5535533caf3..c51a7b5f4df3 100644 --- a/clients/client-sagemaker/src/SageMaker.ts +++ b/clients/client-sagemaker/src/SageMaker.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -1383,10786 +1384,5017 @@ import { UpdateWorkteamCommandInput, UpdateWorkteamCommandOutput, } from "./commands/UpdateWorkteamCommand"; -import { SageMakerClient } from "./SageMakerClient"; +import { SageMakerClient, SageMakerClientConfig } from "./SageMakerClient"; -/** - * @public - *

Provides APIs for creating and managing SageMaker resources.

- *

Other Resources:

- * - */ -export class SageMaker extends SageMakerClient { +const commands = { + AddAssociationCommand, + AddTagsCommand, + AssociateTrialComponentCommand, + BatchDescribeModelPackageCommand, + CreateActionCommand, + CreateAlgorithmCommand, + CreateAppCommand, + CreateAppImageConfigCommand, + CreateArtifactCommand, + CreateAutoMLJobCommand, + CreateAutoMLJobV2Command, + CreateCodeRepositoryCommand, + CreateCompilationJobCommand, + CreateContextCommand, + CreateDataQualityJobDefinitionCommand, + CreateDeviceFleetCommand, + CreateDomainCommand, + CreateEdgeDeploymentPlanCommand, + CreateEdgeDeploymentStageCommand, + CreateEdgePackagingJobCommand, + CreateEndpointCommand, + CreateEndpointConfigCommand, + CreateExperimentCommand, + CreateFeatureGroupCommand, + CreateFlowDefinitionCommand, + CreateHubCommand, + CreateHumanTaskUiCommand, + CreateHyperParameterTuningJobCommand, + CreateImageCommand, + CreateImageVersionCommand, + CreateInferenceExperimentCommand, + CreateInferenceRecommendationsJobCommand, + CreateLabelingJobCommand, + CreateModelCommand, + CreateModelBiasJobDefinitionCommand, + CreateModelCardCommand, + CreateModelCardExportJobCommand, + CreateModelExplainabilityJobDefinitionCommand, + CreateModelPackageCommand, + CreateModelPackageGroupCommand, + CreateModelQualityJobDefinitionCommand, + CreateMonitoringScheduleCommand, + CreateNotebookInstanceCommand, + CreateNotebookInstanceLifecycleConfigCommand, + CreatePipelineCommand, + CreatePresignedDomainUrlCommand, + CreatePresignedNotebookInstanceUrlCommand, + CreateProcessingJobCommand, + CreateProjectCommand, + CreateSpaceCommand, + CreateStudioLifecycleConfigCommand, + CreateTrainingJobCommand, + CreateTransformJobCommand, + CreateTrialCommand, + CreateTrialComponentCommand, + CreateUserProfileCommand, + CreateWorkforceCommand, + CreateWorkteamCommand, + DeleteActionCommand, + DeleteAlgorithmCommand, + DeleteAppCommand, + DeleteAppImageConfigCommand, + DeleteArtifactCommand, + DeleteAssociationCommand, + DeleteCodeRepositoryCommand, + DeleteContextCommand, + DeleteDataQualityJobDefinitionCommand, + DeleteDeviceFleetCommand, + DeleteDomainCommand, + DeleteEdgeDeploymentPlanCommand, + DeleteEdgeDeploymentStageCommand, + DeleteEndpointCommand, + DeleteEndpointConfigCommand, + DeleteExperimentCommand, + DeleteFeatureGroupCommand, + DeleteFlowDefinitionCommand, + DeleteHubCommand, + DeleteHubContentCommand, + DeleteHumanTaskUiCommand, + DeleteImageCommand, + DeleteImageVersionCommand, + DeleteInferenceExperimentCommand, + DeleteModelCommand, + DeleteModelBiasJobDefinitionCommand, + DeleteModelCardCommand, + DeleteModelExplainabilityJobDefinitionCommand, + DeleteModelPackageCommand, + DeleteModelPackageGroupCommand, + DeleteModelPackageGroupPolicyCommand, + DeleteModelQualityJobDefinitionCommand, + DeleteMonitoringScheduleCommand, + DeleteNotebookInstanceCommand, + DeleteNotebookInstanceLifecycleConfigCommand, + DeletePipelineCommand, + DeleteProjectCommand, + DeleteSpaceCommand, + DeleteStudioLifecycleConfigCommand, + DeleteTagsCommand, + DeleteTrialCommand, + DeleteTrialComponentCommand, + DeleteUserProfileCommand, + DeleteWorkforceCommand, + DeleteWorkteamCommand, + DeregisterDevicesCommand, + DescribeActionCommand, + DescribeAlgorithmCommand, + DescribeAppCommand, + DescribeAppImageConfigCommand, + DescribeArtifactCommand, + DescribeAutoMLJobCommand, + DescribeAutoMLJobV2Command, + DescribeCodeRepositoryCommand, + DescribeCompilationJobCommand, + DescribeContextCommand, + DescribeDataQualityJobDefinitionCommand, + DescribeDeviceCommand, + DescribeDeviceFleetCommand, + DescribeDomainCommand, + DescribeEdgeDeploymentPlanCommand, + DescribeEdgePackagingJobCommand, + DescribeEndpointCommand, + DescribeEndpointConfigCommand, + DescribeExperimentCommand, + DescribeFeatureGroupCommand, + DescribeFeatureMetadataCommand, + DescribeFlowDefinitionCommand, + DescribeHubCommand, + DescribeHubContentCommand, + DescribeHumanTaskUiCommand, + DescribeHyperParameterTuningJobCommand, + DescribeImageCommand, + DescribeImageVersionCommand, + DescribeInferenceExperimentCommand, + DescribeInferenceRecommendationsJobCommand, + DescribeLabelingJobCommand, + DescribeLineageGroupCommand, + DescribeModelCommand, + DescribeModelBiasJobDefinitionCommand, + DescribeModelCardCommand, + DescribeModelCardExportJobCommand, + DescribeModelExplainabilityJobDefinitionCommand, + DescribeModelPackageCommand, + DescribeModelPackageGroupCommand, + DescribeModelQualityJobDefinitionCommand, + DescribeMonitoringScheduleCommand, + DescribeNotebookInstanceCommand, + DescribeNotebookInstanceLifecycleConfigCommand, + DescribePipelineCommand, + DescribePipelineDefinitionForExecutionCommand, + DescribePipelineExecutionCommand, + DescribeProcessingJobCommand, + DescribeProjectCommand, + DescribeSpaceCommand, + DescribeStudioLifecycleConfigCommand, + DescribeSubscribedWorkteamCommand, + DescribeTrainingJobCommand, + DescribeTransformJobCommand, + DescribeTrialCommand, + DescribeTrialComponentCommand, + DescribeUserProfileCommand, + DescribeWorkforceCommand, + DescribeWorkteamCommand, + DisableSagemakerServicecatalogPortfolioCommand, + DisassociateTrialComponentCommand, + EnableSagemakerServicecatalogPortfolioCommand, + GetDeviceFleetReportCommand, + GetLineageGroupPolicyCommand, + GetModelPackageGroupPolicyCommand, + GetSagemakerServicecatalogPortfolioStatusCommand, + GetSearchSuggestionsCommand, + ImportHubContentCommand, + ListActionsCommand, + ListAlgorithmsCommand, + ListAliasesCommand, + ListAppImageConfigsCommand, + ListAppsCommand, + ListArtifactsCommand, + ListAssociationsCommand, + ListAutoMLJobsCommand, + ListCandidatesForAutoMLJobCommand, + ListCodeRepositoriesCommand, + ListCompilationJobsCommand, + ListContextsCommand, + ListDataQualityJobDefinitionsCommand, + ListDeviceFleetsCommand, + ListDevicesCommand, + ListDomainsCommand, + ListEdgeDeploymentPlansCommand, + ListEdgePackagingJobsCommand, + ListEndpointConfigsCommand, + ListEndpointsCommand, + ListExperimentsCommand, + ListFeatureGroupsCommand, + ListFlowDefinitionsCommand, + ListHubContentsCommand, + ListHubContentVersionsCommand, + ListHubsCommand, + ListHumanTaskUisCommand, + ListHyperParameterTuningJobsCommand, + ListImagesCommand, + ListImageVersionsCommand, + ListInferenceExperimentsCommand, + ListInferenceRecommendationsJobsCommand, + ListInferenceRecommendationsJobStepsCommand, + ListLabelingJobsCommand, + ListLabelingJobsForWorkteamCommand, + ListLineageGroupsCommand, + ListModelBiasJobDefinitionsCommand, + ListModelCardExportJobsCommand, + ListModelCardsCommand, + ListModelCardVersionsCommand, + ListModelExplainabilityJobDefinitionsCommand, + ListModelMetadataCommand, + ListModelPackageGroupsCommand, + ListModelPackagesCommand, + ListModelQualityJobDefinitionsCommand, + ListModelsCommand, + ListMonitoringAlertHistoryCommand, + ListMonitoringAlertsCommand, + ListMonitoringExecutionsCommand, + ListMonitoringSchedulesCommand, + ListNotebookInstanceLifecycleConfigsCommand, + ListNotebookInstancesCommand, + ListPipelineExecutionsCommand, + ListPipelineExecutionStepsCommand, + ListPipelineParametersForExecutionCommand, + ListPipelinesCommand, + ListProcessingJobsCommand, + ListProjectsCommand, + ListSpacesCommand, + ListStageDevicesCommand, + ListStudioLifecycleConfigsCommand, + ListSubscribedWorkteamsCommand, + ListTagsCommand, + ListTrainingJobsCommand, + ListTrainingJobsForHyperParameterTuningJobCommand, + ListTransformJobsCommand, + ListTrialComponentsCommand, + ListTrialsCommand, + ListUserProfilesCommand, + ListWorkforcesCommand, + ListWorkteamsCommand, + PutModelPackageGroupPolicyCommand, + QueryLineageCommand, + RegisterDevicesCommand, + RenderUiTemplateCommand, + RetryPipelineExecutionCommand, + SearchCommand, + SendPipelineExecutionStepFailureCommand, + SendPipelineExecutionStepSuccessCommand, + StartEdgeDeploymentStageCommand, + StartInferenceExperimentCommand, + StartMonitoringScheduleCommand, + StartNotebookInstanceCommand, + StartPipelineExecutionCommand, + StopAutoMLJobCommand, + StopCompilationJobCommand, + StopEdgeDeploymentStageCommand, + StopEdgePackagingJobCommand, + StopHyperParameterTuningJobCommand, + StopInferenceExperimentCommand, + StopInferenceRecommendationsJobCommand, + StopLabelingJobCommand, + StopMonitoringScheduleCommand, + StopNotebookInstanceCommand, + StopPipelineExecutionCommand, + StopProcessingJobCommand, + StopTrainingJobCommand, + StopTransformJobCommand, + UpdateActionCommand, + UpdateAppImageConfigCommand, + UpdateArtifactCommand, + UpdateCodeRepositoryCommand, + UpdateContextCommand, + UpdateDeviceFleetCommand, + UpdateDevicesCommand, + UpdateDomainCommand, + UpdateEndpointCommand, + UpdateEndpointWeightsAndCapacitiesCommand, + UpdateExperimentCommand, + UpdateFeatureGroupCommand, + UpdateFeatureMetadataCommand, + UpdateHubCommand, + UpdateImageCommand, + UpdateImageVersionCommand, + UpdateInferenceExperimentCommand, + UpdateModelCardCommand, + UpdateModelPackageCommand, + UpdateMonitoringAlertCommand, + UpdateMonitoringScheduleCommand, + UpdateNotebookInstanceCommand, + UpdateNotebookInstanceLifecycleConfigCommand, + UpdatePipelineCommand, + UpdatePipelineExecutionCommand, + UpdateProjectCommand, + UpdateSpaceCommand, + UpdateTrainingJobCommand, + UpdateTrialCommand, + UpdateTrialComponentCommand, + UpdateUserProfileCommand, + UpdateWorkforceCommand, + UpdateWorkteamCommand, +}; + +export interface SageMaker { /** - * @public - *

Creates an association between the source and the destination. A - * source can be associated with multiple destinations, and a destination can be associated - * with multiple sources. An association is a lineage tracking entity. For more information, see - * Amazon SageMaker - * ML Lineage Tracking.

+ * @see {@link AddAssociationCommand} */ - public addAssociation( + addAssociation( args: AddAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public addAssociation( - args: AddAssociationCommandInput, - cb: (err: any, data?: AddAssociationCommandOutput) => void - ): void; - public addAssociation( + addAssociation(args: AddAssociationCommandInput, cb: (err: any, data?: AddAssociationCommandOutput) => void): void; + addAssociation( args: AddAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddAssociationCommandOutput) => void ): void; - public addAssociation( - args: AddAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddAssociationCommandOutput) => void), - cb?: (err: any, data?: AddAssociationCommandOutput) => void - ): Promise | void { - const command = new AddAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds or overwrites one or more tags for the specified SageMaker resource. You can add - * tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform - * jobs, models, labeling jobs, work teams, endpoint configurations, and - * endpoints.

- *

Each tag consists of a key and an optional value. Tag keys must be unique per - * resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

- * - *

Tags that you add to a hyperparameter tuning job by calling this API are also - * added to any training jobs that the hyperparameter tuning job launches after you - * call this API, but not to training jobs that the hyperparameter tuning job launched - * before you called this API. To make sure that the tags associated with a - * hyperparameter tuning job are also added to all training jobs that the - * hyperparameter tuning job launches, add the tags when you first create the tuning - * job by specifying them in the Tags parameter of CreateHyperParameterTuningJob - *

- *
- * - *

Tags that you add to a SageMaker Studio Domain or User Profile by calling this API - * are also added to any Apps that the Domain or User Profile launches after you call - * this API, but not to Apps that the Domain or User Profile launched before you called - * this API. To make sure that the tags associated with a Domain or User Profile are - * also added to all Apps that the Domain or User Profile launches, add the tags when - * you first create the Domain or User Profile by specifying them in the - * Tags parameter of CreateDomain or CreateUserProfile.

- *
- */ - public addTags(args: AddTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public addTags(args: AddTagsCommandInput, cb: (err: any, data?: AddTagsCommandOutput) => void): void; - public addTags( + + /** + * @see {@link AddTagsCommand} + */ + addTags(args: AddTagsCommandInput, options?: __HttpHandlerOptions): Promise; + addTags(args: AddTagsCommandInput, cb: (err: any, data?: AddTagsCommandOutput) => void): void; + addTags( args: AddTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsCommandOutput) => void ): void; - public addTags( - args: AddTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddTagsCommandOutput) => void), - cb?: (err: any, data?: AddTagsCommandOutput) => void - ): Promise | void { - const command = new AddTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a trial component with a trial. A trial component can be associated with - * multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

- */ - public associateTrialComponent( + + /** + * @see {@link AssociateTrialComponentCommand} + */ + associateTrialComponent( args: AssociateTrialComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateTrialComponent( + associateTrialComponent( args: AssociateTrialComponentCommandInput, cb: (err: any, data?: AssociateTrialComponentCommandOutput) => void ): void; - public associateTrialComponent( + associateTrialComponent( args: AssociateTrialComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateTrialComponentCommandOutput) => void ): void; - public associateTrialComponent( - args: AssociateTrialComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateTrialComponentCommandOutput) => void), - cb?: (err: any, data?: AssociateTrialComponentCommandOutput) => void - ): Promise | void { - const command = new AssociateTrialComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This action batch describes a list of versioned model packages

- */ - public batchDescribeModelPackage( + + /** + * @see {@link BatchDescribeModelPackageCommand} + */ + batchDescribeModelPackage( args: BatchDescribeModelPackageCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDescribeModelPackage( + batchDescribeModelPackage( args: BatchDescribeModelPackageCommandInput, cb: (err: any, data?: BatchDescribeModelPackageCommandOutput) => void ): void; - public batchDescribeModelPackage( + batchDescribeModelPackage( args: BatchDescribeModelPackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDescribeModelPackageCommandOutput) => void ): void; - public batchDescribeModelPackage( - args: BatchDescribeModelPackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDescribeModelPackageCommandOutput) => void), - cb?: (err: any, data?: BatchDescribeModelPackageCommandOutput) => void - ): Promise | void { - const command = new BatchDescribeModelPackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an action. An action is a lineage tracking entity that - * represents an action or activity. For example, a model deployment or an HPO job. - * Generally, an action involves at least one input or output artifact. For more information, see - * Amazon SageMaker - * ML Lineage Tracking.

- */ - public createAction( - args: CreateActionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createAction(args: CreateActionCommandInput, cb: (err: any, data?: CreateActionCommandOutput) => void): void; - public createAction( + + /** + * @see {@link CreateActionCommand} + */ + createAction(args: CreateActionCommandInput, options?: __HttpHandlerOptions): Promise; + createAction(args: CreateActionCommandInput, cb: (err: any, data?: CreateActionCommandOutput) => void): void; + createAction( args: CreateActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateActionCommandOutput) => void ): void; - public createAction( - args: CreateActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateActionCommandOutput) => void), - cb?: (err: any, data?: CreateActionCommandOutput) => void - ): Promise | void { - const command = new CreateActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.

- */ - public createAlgorithm( + + /** + * @see {@link CreateAlgorithmCommand} + */ + createAlgorithm( args: CreateAlgorithmCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAlgorithm( - args: CreateAlgorithmCommandInput, - cb: (err: any, data?: CreateAlgorithmCommandOutput) => void - ): void; - public createAlgorithm( + createAlgorithm(args: CreateAlgorithmCommandInput, cb: (err: any, data?: CreateAlgorithmCommandOutput) => void): void; + createAlgorithm( args: CreateAlgorithmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAlgorithmCommandOutput) => void ): void; - public createAlgorithm( - args: CreateAlgorithmCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAlgorithmCommandOutput) => void), - cb?: (err: any, data?: CreateAlgorithmCommandOutput) => void - ): Promise | void { - const command = new CreateAlgorithmCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a running app for the specified UserProfile. This operation is automatically - * invoked by Amazon SageMaker Studio upon access to the associated Domain, and when new kernel - * configurations are selected by the user. A user may have multiple Apps active simultaneously.

- */ - public createApp(args: CreateAppCommandInput, options?: __HttpHandlerOptions): Promise; - public createApp(args: CreateAppCommandInput, cb: (err: any, data?: CreateAppCommandOutput) => void): void; - public createApp( + + /** + * @see {@link CreateAppCommand} + */ + createApp(args: CreateAppCommandInput, options?: __HttpHandlerOptions): Promise; + createApp(args: CreateAppCommandInput, cb: (err: any, data?: CreateAppCommandOutput) => void): void; + createApp( args: CreateAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppCommandOutput) => void ): void; - public createApp( - args: CreateAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAppCommandOutput) => void), - cb?: (err: any, data?: CreateAppCommandOutput) => void - ): Promise | void { - const command = new CreateAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a configuration for running a SageMaker image as a KernelGateway app. The - * configuration specifies the Amazon Elastic File System (EFS) storage volume on the image, and a list of the - * kernels in the image.

- */ - public createAppImageConfig( + + /** + * @see {@link CreateAppImageConfigCommand} + */ + createAppImageConfig( args: CreateAppImageConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAppImageConfig( + createAppImageConfig( args: CreateAppImageConfigCommandInput, cb: (err: any, data?: CreateAppImageConfigCommandOutput) => void ): void; - public createAppImageConfig( + createAppImageConfig( args: CreateAppImageConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppImageConfigCommandOutput) => void ): void; - public createAppImageConfig( - args: CreateAppImageConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAppImageConfigCommandOutput) => void), - cb?: (err: any, data?: CreateAppImageConfigCommandOutput) => void - ): Promise | void { - const command = new CreateAppImageConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an artifact. An artifact is a lineage tracking entity that - * represents a URI addressable object or data. Some examples are the S3 URI of a dataset and - * the ECR registry path of an image. For more information, see - * Amazon SageMaker - * ML Lineage Tracking.

- */ - public createArtifact( + + /** + * @see {@link CreateArtifactCommand} + */ + createArtifact( args: CreateArtifactCommandInput, options?: __HttpHandlerOptions ): Promise; - public createArtifact( - args: CreateArtifactCommandInput, - cb: (err: any, data?: CreateArtifactCommandOutput) => void - ): void; - public createArtifact( + createArtifact(args: CreateArtifactCommandInput, cb: (err: any, data?: CreateArtifactCommandOutput) => void): void; + createArtifact( args: CreateArtifactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateArtifactCommandOutput) => void ): void; - public createArtifact( - args: CreateArtifactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateArtifactCommandOutput) => void), - cb?: (err: any, data?: CreateArtifactCommandOutput) => void - ): Promise | void { - const command = new CreateArtifactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Autopilot job.

- *

Find the best-performing model after you run an Autopilot job by calling DescribeAutoMLJob.

- *

For information about how to use Autopilot, see Automate Model - * Development with Amazon SageMaker Autopilot.

- */ - public createAutoMLJob( + + /** + * @see {@link CreateAutoMLJobCommand} + */ + createAutoMLJob( args: CreateAutoMLJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAutoMLJob( - args: CreateAutoMLJobCommandInput, - cb: (err: any, data?: CreateAutoMLJobCommandOutput) => void - ): void; - public createAutoMLJob( + createAutoMLJob(args: CreateAutoMLJobCommandInput, cb: (err: any, data?: CreateAutoMLJobCommandOutput) => void): void; + createAutoMLJob( args: CreateAutoMLJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAutoMLJobCommandOutput) => void ): void; - public createAutoMLJob( - args: CreateAutoMLJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAutoMLJobCommandOutput) => void), - cb?: (err: any, data?: CreateAutoMLJobCommandOutput) => void - ): Promise | void { - const command = new CreateAutoMLJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon SageMaker AutoML job that uses non-tabular data such as images or text for - * Computer Vision or Natural Language Processing problems.

- *

Find the resulting model after you run an AutoML job V2 by calling DescribeAutoMLJobV2.

- *

To create an AutoMLJob using tabular data, see CreateAutoMLJob.

- * - *

This API action is callable through SageMaker Canvas only. Calling it directly from the CLI - * or an SDK results in an error.

- *
- */ - public createAutoMLJobV2( + + /** + * @see {@link CreateAutoMLJobV2Command} + */ + createAutoMLJobV2( args: CreateAutoMLJobV2CommandInput, options?: __HttpHandlerOptions ): Promise; - public createAutoMLJobV2( + createAutoMLJobV2( args: CreateAutoMLJobV2CommandInput, cb: (err: any, data?: CreateAutoMLJobV2CommandOutput) => void ): void; - public createAutoMLJobV2( + createAutoMLJobV2( args: CreateAutoMLJobV2CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAutoMLJobV2CommandOutput) => void ): void; - public createAutoMLJobV2( - args: CreateAutoMLJobV2CommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAutoMLJobV2CommandOutput) => void), - cb?: (err: any, data?: CreateAutoMLJobV2CommandOutput) => void - ): Promise | void { - const command = new CreateAutoMLJobV2Command(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Git repository as a resource in your SageMaker account. You can associate the - * repository with notebook instances so that you can use Git source control for the - * notebooks you create. The Git repository is a resource in your SageMaker account, so it can - * be associated with more than one notebook instance, and it persists independently from - * the lifecycle of any notebook instances it is associated with.

- *

The repository can be hosted either in Amazon Web Services CodeCommit - * or in any other Git repository.

- */ - public createCodeRepository( + + /** + * @see {@link CreateCodeRepositoryCommand} + */ + createCodeRepository( args: CreateCodeRepositoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCodeRepository( + createCodeRepository( args: CreateCodeRepositoryCommandInput, cb: (err: any, data?: CreateCodeRepositoryCommandOutput) => void ): void; - public createCodeRepository( + createCodeRepository( args: CreateCodeRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCodeRepositoryCommandOutput) => void ): void; - public createCodeRepository( - args: CreateCodeRepositoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCodeRepositoryCommandOutput) => void), - cb?: (err: any, data?: CreateCodeRepositoryCommandOutput) => void - ): Promise | void { - const command = new CreateCodeRepositoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the - * resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

- *

If - * you choose to host your model using Amazon SageMaker hosting services, you can use the resulting - * model artifacts as part of the model. You can also use the artifacts with - * Amazon Web Services - * IoT Greengrass. In that case, deploy them as an ML - * resource.

- *

In the request body, you provide the following:

- *
    - *
  • - *

    A name for the compilation job

    - *
  • - *
  • - *

    Information about the input model artifacts

    - *
  • - *
  • - *

    The output location for the compiled model and the device (target) that the - * model runs on

    - *
  • - *
  • - *

    The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform - * the model compilation job.

    - *
  • - *
- *

You can also provide a Tag to track the model compilation job's resource - * use and costs. The response body contains the - * CompilationJobArn - * for the compiled job.

- *

To stop a model compilation job, use StopCompilationJob. To get - * information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model - * compilation jobs, use ListCompilationJobs.

- */ - public createCompilationJob( + + /** + * @see {@link CreateCompilationJobCommand} + */ + createCompilationJob( args: CreateCompilationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCompilationJob( + createCompilationJob( args: CreateCompilationJobCommandInput, cb: (err: any, data?: CreateCompilationJobCommandOutput) => void ): void; - public createCompilationJob( + createCompilationJob( args: CreateCompilationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCompilationJobCommandOutput) => void ): void; - public createCompilationJob( - args: CreateCompilationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCompilationJobCommandOutput) => void), - cb?: (err: any, data?: CreateCompilationJobCommandOutput) => void - ): Promise | void { - const command = new CreateCompilationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a context. A context is a lineage tracking entity that - * represents a logical grouping of other tracking or experiment entities. Some examples are - * an endpoint and a model package. For more information, see - * Amazon SageMaker - * ML Lineage Tracking.

- */ - public createContext( - args: CreateContextCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createContext( - args: CreateContextCommandInput, - cb: (err: any, data?: CreateContextCommandOutput) => void - ): void; - public createContext( + + /** + * @see {@link CreateContextCommand} + */ + createContext(args: CreateContextCommandInput, options?: __HttpHandlerOptions): Promise; + createContext(args: CreateContextCommandInput, cb: (err: any, data?: CreateContextCommandOutput) => void): void; + createContext( args: CreateContextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateContextCommandOutput) => void ): void; - public createContext( - args: CreateContextCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateContextCommandOutput) => void), - cb?: (err: any, data?: CreateContextCommandOutput) => void - ): Promise | void { - const command = new CreateContextCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a definition for a job that monitors data quality and drift. For information - * about model monitor, see Amazon SageMaker Model Monitor.

- */ - public createDataQualityJobDefinition( + + /** + * @see {@link CreateDataQualityJobDefinitionCommand} + */ + createDataQualityJobDefinition( args: CreateDataQualityJobDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDataQualityJobDefinition( + createDataQualityJobDefinition( args: CreateDataQualityJobDefinitionCommandInput, cb: (err: any, data?: CreateDataQualityJobDefinitionCommandOutput) => void ): void; - public createDataQualityJobDefinition( + createDataQualityJobDefinition( args: CreateDataQualityJobDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataQualityJobDefinitionCommandOutput) => void ): void; - public createDataQualityJobDefinition( - args: CreateDataQualityJobDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDataQualityJobDefinitionCommandOutput) => void), - cb?: (err: any, data?: CreateDataQualityJobDefinitionCommandOutput) => void - ): Promise | void { - const command = new CreateDataQualityJobDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a device fleet.

- */ - public createDeviceFleet( + + /** + * @see {@link CreateDeviceFleetCommand} + */ + createDeviceFleet( args: CreateDeviceFleetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDeviceFleet( + createDeviceFleet( args: CreateDeviceFleetCommandInput, cb: (err: any, data?: CreateDeviceFleetCommandOutput) => void ): void; - public createDeviceFleet( + createDeviceFleet( args: CreateDeviceFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeviceFleetCommandOutput) => void ): void; - public createDeviceFleet( - args: CreateDeviceFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDeviceFleetCommandOutput) => void), - cb?: (err: any, data?: CreateDeviceFleetCommandOutput) => void - ): Promise | void { - const command = new CreateDeviceFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated - * Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, - * policy, and Amazon Virtual Private Cloud (VPC) configurations. - * Users within a domain can share notebook files and other artifacts with each other.

- *

- * EFS storage - *

- *

When a domain is created, an EFS volume is created for use by all of the users within the - * domain. Each user receives a private home directory within the EFS volume for notebooks, - * Git repositories, and data files.

- *

SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with - * an Amazon Web Services managed key by default. For more control, you can specify a - * customer managed key. For more information, see - * Protect Data at - * Rest Using Encryption.

- *

- * VPC configuration - *

- *

All SageMaker Studio traffic between the domain and the EFS volume is through the specified - * VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType - * parameter. AppNetworkAccessType corresponds to the network access type that you - * choose when you onboard to Studio. The following options are available:

- *
    - *
  • - *

    - * PublicInternetOnly - Non-EFS traffic goes through a VPC managed by - * Amazon SageMaker, which allows internet access. This is the default value.

    - *
  • - *
  • - *

    - * VpcOnly - All Studio traffic is through the specified VPC and subnets. - * Internet access is disabled by default. To allow internet access, you must specify a - * NAT gateway.

    - *

    When internet access is disabled, you won't be able to run a Studio notebook or to - * train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime - * or a NAT gateway and your security groups allow outbound connections.

    - *
  • - *
- * - *

NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules - * in order to launch a SageMaker Studio app successfully.

- *
- *

For more information, see - * Connect - * SageMaker Studio Notebooks to Resources in a VPC.

- */ - public createDomain( - args: CreateDomainCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createDomain(args: CreateDomainCommandInput, cb: (err: any, data?: CreateDomainCommandOutput) => void): void; - public createDomain( + + /** + * @see {@link CreateDomainCommand} + */ + createDomain(args: CreateDomainCommandInput, options?: __HttpHandlerOptions): Promise; + createDomain(args: CreateDomainCommandInput, cb: (err: any, data?: CreateDomainCommandOutput) => void): void; + createDomain( args: CreateDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDomainCommandOutput) => void ): void; - public createDomain( - args: CreateDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDomainCommandOutput) => void), - cb?: (err: any, data?: CreateDomainCommandOutput) => void - ): Promise | void { - const command = new CreateDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.

- */ - public createEdgeDeploymentPlan( + + /** + * @see {@link CreateEdgeDeploymentPlanCommand} + */ + createEdgeDeploymentPlan( args: CreateEdgeDeploymentPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEdgeDeploymentPlan( + createEdgeDeploymentPlan( args: CreateEdgeDeploymentPlanCommandInput, cb: (err: any, data?: CreateEdgeDeploymentPlanCommandOutput) => void ): void; - public createEdgeDeploymentPlan( + createEdgeDeploymentPlan( args: CreateEdgeDeploymentPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEdgeDeploymentPlanCommandOutput) => void ): void; - public createEdgeDeploymentPlan( - args: CreateEdgeDeploymentPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEdgeDeploymentPlanCommandOutput) => void), - cb?: (err: any, data?: CreateEdgeDeploymentPlanCommandOutput) => void - ): Promise | void { - const command = new CreateEdgeDeploymentPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new stage in an existing edge deployment plan.

- */ - public createEdgeDeploymentStage( + + /** + * @see {@link CreateEdgeDeploymentStageCommand} + */ + createEdgeDeploymentStage( args: CreateEdgeDeploymentStageCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEdgeDeploymentStage( + createEdgeDeploymentStage( args: CreateEdgeDeploymentStageCommandInput, cb: (err: any, data?: CreateEdgeDeploymentStageCommandOutput) => void ): void; - public createEdgeDeploymentStage( + createEdgeDeploymentStage( args: CreateEdgeDeploymentStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEdgeDeploymentStageCommandOutput) => void ): void; - public createEdgeDeploymentStage( - args: CreateEdgeDeploymentStageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEdgeDeploymentStageCommandOutput) => void), - cb?: (err: any, data?: CreateEdgeDeploymentStageCommandOutput) => void - ): Promise | void { - const command = new CreateEdgeDeploymentStageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.

- */ - public createEdgePackagingJob( + + /** + * @see {@link CreateEdgePackagingJobCommand} + */ + createEdgePackagingJob( args: CreateEdgePackagingJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEdgePackagingJob( + createEdgePackagingJob( args: CreateEdgePackagingJobCommandInput, cb: (err: any, data?: CreateEdgePackagingJobCommandOutput) => void ): void; - public createEdgePackagingJob( + createEdgePackagingJob( args: CreateEdgePackagingJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEdgePackagingJobCommandOutput) => void ): void; - public createEdgePackagingJob( - args: CreateEdgePackagingJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEdgePackagingJobCommandOutput) => void), - cb?: (err: any, data?: CreateEdgePackagingJobCommandOutput) => void - ): Promise | void { - const command = new CreateEdgePackagingJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an endpoint using the endpoint configuration specified in the request. SageMaker - * uses the endpoint to provision resources and deploy models. You create the endpoint - * configuration with the CreateEndpointConfig API.

- *

Use this API to deploy models using SageMaker hosting services.

- *

For an example that calls this method when deploying a model to SageMaker hosting services, - * see the Create Endpoint example notebook. - *

- * - *

You must not delete an EndpointConfig that is in use by an endpoint - * that is live or while the UpdateEndpoint or CreateEndpoint - * operations are being performed on the endpoint. To update an endpoint, you must - * create a new EndpointConfig.

- *
- *

The endpoint name must be unique within an Amazon Web Services Region in your - * Amazon Web Services account.

- *

When it receives the request, SageMaker creates the endpoint, launches the resources (ML - * compute instances), and deploys the model(s) on them.

- * - *

When you call CreateEndpoint, a load call is made to DynamoDB to - * verify that your endpoint configuration exists. When you read data from a DynamoDB - * table supporting - * Eventually Consistent Reads - * , the response might not - * reflect the results of a recently completed write operation. The response might - * include some stale data. If the dependent entities are not yet in DynamoDB, this - * causes a validation error. If you repeat your read request after a short time, the - * response should return the latest data. So retry logic is recommended to handle - * these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

- *
- *

When SageMaker receives the request, it sets the endpoint status to - * Creating. After it creates the endpoint, it sets the status to - * InService. SageMaker can then process incoming requests for inferences. To - * check the status of an endpoint, use the DescribeEndpoint - * API.

- *

If any of the models hosted at this endpoint get model data from an Amazon S3 location, - * SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the - * S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services - * account by default. If you previously deactivated Amazon Web Services STS for a region, - * you need to reactivate Amazon Web Services STS for that region. For more information, see - * Activating and - * Deactivating Amazon Web Services STS in an Amazon Web Services Region in the - * Amazon Web Services Identity and Access Management User - * Guide.

- * - *

To add the IAM role policies for using this API operation, go to the IAM console, and choose - * Roles in the left navigation pane. Search the IAM role that you want to grant - * access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to - * the role.

- *
    - *
  • - *

    Option 1: For a full SageMaker access, search and attach the - * AmazonSageMakerFullAccess policy.

    - *
  • - *
  • - *

    Option 2: For granting a limited access to an IAM role, paste the - * following Action elements manually into the JSON file of the IAM role:

    - *

    - * "Action": ["sagemaker:CreateEndpoint", - * "sagemaker:CreateEndpointConfig"] - *

    - *

    - * "Resource": [ - *

    - *

    - * "arn:aws:sagemaker:region:account-id:endpoint/endpointName" - *

    - *

    - * "arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName" - *

    - *

    - * ] - *

    - *

    For more information, see SageMaker API - * Permissions: Actions, Permissions, and Resources - * Reference.

    - *
  • - *
- *
- */ - public createEndpoint( + + /** + * @see {@link CreateEndpointCommand} + */ + createEndpoint( args: CreateEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEndpoint( - args: CreateEndpointCommandInput, - cb: (err: any, data?: CreateEndpointCommandOutput) => void - ): void; - public createEndpoint( + createEndpoint(args: CreateEndpointCommandInput, cb: (err: any, data?: CreateEndpointCommandOutput) => void): void; + createEndpoint( args: CreateEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEndpointCommandOutput) => void ): void; - public createEndpoint( - args: CreateEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEndpointCommandOutput) => void), - cb?: (err: any, data?: CreateEndpointCommandOutput) => void - ): Promise | void { - const command = new CreateEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In - * the configuration, you identify one or more models, created using the - * CreateModel API, to deploy and the resources that you want SageMaker to - * provision. Then you call the CreateEndpoint API.

- * - *

Use this API if you want to use SageMaker hosting services to deploy models into - * production.

- *
- *

In the request, you define a ProductionVariant, for each model that you - * want to deploy. Each ProductionVariant parameter also describes the - * resources that you want SageMaker to provision. This includes the number and type of ML - * compute instances to deploy.

- *

If you are hosting multiple models, you also assign a VariantWeight to - * specify how much traffic you want to allocate to each model. For example, suppose that - * you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 - * for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to - * model B.

- * - *

When you call CreateEndpoint, a load call is made to DynamoDB to - * verify that your endpoint configuration exists. When you read data from a DynamoDB - * table supporting - * Eventually Consistent Reads - * , the response might not - * reflect the results of a recently completed write operation. The response might - * include some stale data. If the dependent entities are not yet in DynamoDB, this - * causes a validation error. If you repeat your read request after a short time, the - * response should return the latest data. So retry logic is recommended to handle - * these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

- *
- */ - public createEndpointConfig( + + /** + * @see {@link CreateEndpointConfigCommand} + */ + createEndpointConfig( args: CreateEndpointConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEndpointConfig( + createEndpointConfig( args: CreateEndpointConfigCommandInput, cb: (err: any, data?: CreateEndpointConfigCommandOutput) => void ): void; - public createEndpointConfig( + createEndpointConfig( args: CreateEndpointConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEndpointConfigCommandOutput) => void ): void; - public createEndpointConfig( - args: CreateEndpointConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEndpointConfigCommandOutput) => void), - cb?: (err: any, data?: CreateEndpointConfigCommandOutput) => void - ): Promise | void { - const command = new CreateEndpointConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a SageMaker experiment. An experiment is a collection of - * trials that are observed, compared and evaluated as a group. A trial is - * a set of steps, called trial components, that produce a machine learning - * model.

- * - *

In the Studio UI, trials are referred to as run groups and trial - * components are referred to as runs.

- *
- *

The goal of an experiment is to determine the components that produce the best model. - * Multiple trials are performed, each one isolating and measuring the impact of a change to one - * or more inputs, while keeping the remaining inputs constant.

- *

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial - * components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you - * must use the logging APIs provided by the SDK.

- *

You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.

- *

To add a description to an experiment, specify the optional Description - * parameter. To add a description later, or to change the description, call the UpdateExperiment API.

- *

To get a list of all your experiments, call the ListExperiments API. To - * view an experiment's properties, call the DescribeExperiment API. To get a - * list of all the trials associated with an experiment, call the ListTrials - * API. To create a trial call the CreateTrial API.

- */ - public createExperiment( + + /** + * @see {@link CreateExperimentCommand} + */ + createExperiment( args: CreateExperimentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createExperiment( + createExperiment( args: CreateExperimentCommandInput, cb: (err: any, data?: CreateExperimentCommandOutput) => void ): void; - public createExperiment( + createExperiment( args: CreateExperimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExperimentCommandOutput) => void ): void; - public createExperiment( - args: CreateExperimentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateExperimentCommandOutput) => void), - cb?: (err: any, data?: CreateExperimentCommandOutput) => void - ): Promise | void { - const command = new CreateExperimentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Create a new FeatureGroup. A FeatureGroup is a group of - * Features defined in the FeatureStore to describe a - * Record.

- *

The FeatureGroup defines the schema and features contained in the - * FeatureGroup. A FeatureGroup definition is composed of a list of - * Features, a RecordIdentifierFeatureName, an - * EventTimeFeatureName and configurations for its OnlineStore - * and OfflineStore. Check Amazon Web Services service quotas to see - * the FeatureGroups quota for your Amazon Web Services account.

- * - *

You must include at least one of OnlineStoreConfig and - * OfflineStoreConfig to create a FeatureGroup.

- *
- */ - public createFeatureGroup( + + /** + * @see {@link CreateFeatureGroupCommand} + */ + createFeatureGroup( args: CreateFeatureGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFeatureGroup( + createFeatureGroup( args: CreateFeatureGroupCommandInput, cb: (err: any, data?: CreateFeatureGroupCommandOutput) => void ): void; - public createFeatureGroup( + createFeatureGroup( args: CreateFeatureGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFeatureGroupCommandOutput) => void ): void; - public createFeatureGroup( - args: CreateFeatureGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFeatureGroupCommandOutput) => void), - cb?: (err: any, data?: CreateFeatureGroupCommandOutput) => void - ): Promise | void { - const command = new CreateFeatureGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a flow definition.

- */ - public createFlowDefinition( + + /** + * @see {@link CreateFlowDefinitionCommand} + */ + createFlowDefinition( args: CreateFlowDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFlowDefinition( + createFlowDefinition( args: CreateFlowDefinitionCommandInput, cb: (err: any, data?: CreateFlowDefinitionCommandOutput) => void ): void; - public createFlowDefinition( + createFlowDefinition( args: CreateFlowDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFlowDefinitionCommandOutput) => void ): void; - public createFlowDefinition( - args: CreateFlowDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFlowDefinitionCommandOutput) => void), - cb?: (err: any, data?: CreateFlowDefinitionCommandOutput) => void - ): Promise | void { - const command = new CreateFlowDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Create a hub.

- * - *

Hub APIs are only callable through SageMaker Studio.

- *
- */ - public createHub(args: CreateHubCommandInput, options?: __HttpHandlerOptions): Promise; - public createHub(args: CreateHubCommandInput, cb: (err: any, data?: CreateHubCommandOutput) => void): void; - public createHub( + + /** + * @see {@link CreateHubCommand} + */ + createHub(args: CreateHubCommandInput, options?: __HttpHandlerOptions): Promise; + createHub(args: CreateHubCommandInput, cb: (err: any, data?: CreateHubCommandOutput) => void): void; + createHub( args: CreateHubCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHubCommandOutput) => void ): void; - public createHub( - args: CreateHubCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateHubCommandOutput) => void), - cb?: (err: any, data?: CreateHubCommandOutput) => void - ): Promise | void { - const command = new CreateHubCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.

- */ - public createHumanTaskUi( + + /** + * @see {@link CreateHumanTaskUiCommand} + */ + createHumanTaskUi( args: CreateHumanTaskUiCommandInput, options?: __HttpHandlerOptions ): Promise; - public createHumanTaskUi( + createHumanTaskUi( args: CreateHumanTaskUiCommandInput, cb: (err: any, data?: CreateHumanTaskUiCommandOutput) => void ): void; - public createHumanTaskUi( + createHumanTaskUi( args: CreateHumanTaskUiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHumanTaskUiCommandOutput) => void ): void; - public createHumanTaskUi( - args: CreateHumanTaskUiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateHumanTaskUiCommandOutput) => void), - cb?: (err: any, data?: CreateHumanTaskUiCommandOutput) => void - ): Promise | void { - const command = new CreateHumanTaskUiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version - * of a model by running many training jobs on your dataset using the algorithm you choose - * and values for hyperparameters within ranges that you specify. It then chooses the - * hyperparameter values that result in a model that performs the best, as measured by an - * objective metric that you choose.

- *

A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and - * trial components for each training job that it runs. You can view these entities in - * Amazon SageMaker Studio. For more information, see View - * Experiments, Trials, and Trial Components.

- * - *

Do not include any security-sensitive information including account access IDs, - * secrets or tokens in any hyperparameter field. If the use of security-sensitive - * credentials are detected, SageMaker will reject your training job request and return an - * exception error.

- *
- */ - public createHyperParameterTuningJob( + + /** + * @see {@link CreateHyperParameterTuningJobCommand} + */ + createHyperParameterTuningJob( args: CreateHyperParameterTuningJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createHyperParameterTuningJob( + createHyperParameterTuningJob( args: CreateHyperParameterTuningJobCommandInput, cb: (err: any, data?: CreateHyperParameterTuningJobCommandOutput) => void ): void; - public createHyperParameterTuningJob( + createHyperParameterTuningJob( args: CreateHyperParameterTuningJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHyperParameterTuningJobCommandOutput) => void ): void; - public createHyperParameterTuningJob( - args: CreateHyperParameterTuningJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateHyperParameterTuningJobCommandOutput) => void), - cb?: (err: any, data?: CreateHyperParameterTuningJobCommandOutput) => void - ): Promise | void { - const command = new CreateHyperParameterTuningJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image - * version represents a container image stored in Amazon Elastic Container Registry (ECR). For more information, see - * Bring your own SageMaker image.

- */ - public createImage(args: CreateImageCommandInput, options?: __HttpHandlerOptions): Promise; - public createImage(args: CreateImageCommandInput, cb: (err: any, data?: CreateImageCommandOutput) => void): void; - public createImage( + + /** + * @see {@link CreateImageCommand} + */ + createImage(args: CreateImageCommandInput, options?: __HttpHandlerOptions): Promise; + createImage(args: CreateImageCommandInput, cb: (err: any, data?: CreateImageCommandOutput) => void): void; + createImage( args: CreateImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateImageCommandOutput) => void ): void; - public createImage( - args: CreateImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateImageCommandOutput) => void), - cb?: (err: any, data?: CreateImageCommandOutput) => void - ): Promise | void { - const command = new CreateImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a version of the SageMaker image specified by ImageName. The version - * represents the Amazon Elastic Container Registry (ECR) container image specified by BaseImage.

- */ - public createImageVersion( + + /** + * @see {@link CreateImageVersionCommand} + */ + createImageVersion( args: CreateImageVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createImageVersion( + createImageVersion( args: CreateImageVersionCommandInput, cb: (err: any, data?: CreateImageVersionCommandOutput) => void ): void; - public createImageVersion( + createImageVersion( args: CreateImageVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateImageVersionCommandOutput) => void ): void; - public createImageVersion( - args: CreateImageVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateImageVersionCommandOutput) => void), - cb?: (err: any, data?: CreateImageVersionCommandOutput) => void - ): Promise | void { - const command = new CreateImageVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Creates an inference experiment using the configurations specified in the request. - *

- *

- * Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For - * more information about inference experiments, see Shadow tests. - *

- *

- * Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based - * on your specified configuration. - *

- *

- * While the experiment is in progress or after it has concluded, you can view metrics that compare your model - * variants. For more information, see View, monitor, and edit shadow tests. - *

- */ - public createInferenceExperiment( + + /** + * @see {@link CreateInferenceExperimentCommand} + */ + createInferenceExperiment( args: CreateInferenceExperimentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createInferenceExperiment( + createInferenceExperiment( args: CreateInferenceExperimentCommandInput, cb: (err: any, data?: CreateInferenceExperimentCommandOutput) => void ): void; - public createInferenceExperiment( + createInferenceExperiment( args: CreateInferenceExperimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInferenceExperimentCommandOutput) => void ): void; - public createInferenceExperiment( - args: CreateInferenceExperimentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateInferenceExperimentCommandOutput) => void), - cb?: (err: any, data?: CreateInferenceExperimentCommandOutput) => void - ): Promise | void { - const command = new CreateInferenceExperimentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a recommendation job. You can create either an instance - * recommendation or load test job.

- */ - public createInferenceRecommendationsJob( + + /** + * @see {@link CreateInferenceRecommendationsJobCommand} + */ + createInferenceRecommendationsJob( args: CreateInferenceRecommendationsJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createInferenceRecommendationsJob( + createInferenceRecommendationsJob( args: CreateInferenceRecommendationsJobCommandInput, cb: (err: any, data?: CreateInferenceRecommendationsJobCommandOutput) => void ): void; - public createInferenceRecommendationsJob( + createInferenceRecommendationsJob( args: CreateInferenceRecommendationsJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInferenceRecommendationsJobCommandOutput) => void ): void; - public createInferenceRecommendationsJob( - args: CreateInferenceRecommendationsJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateInferenceRecommendationsJobCommandOutput) => void), - cb?: (err: any, data?: CreateInferenceRecommendationsJobCommandOutput) => void - ): Promise | void { - const command = new CreateInferenceRecommendationsJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a job that uses workers to label the data objects in your input dataset. You - * can use the labeled data to train machine learning models.

- *

You can select your workforce from one of three providers:

- *
    - *
  • - *

    A private workforce that you create. It can include employees, contractors, - * and outside experts. Use a private workforce when want the data to stay within - * your organization or when a specific set of skills is required.

    - *
  • - *
  • - *

    One or more vendors that you select from the Amazon Web Services Marketplace. Vendors provide - * expertise in specific areas.

    - *
  • - *
  • - *

    The Amazon Mechanical Turk workforce. This is the largest workforce, but it - * should only be used for public data or data that has been stripped of any - * personally identifiable information.

    - *
  • - *
- *

You can also use automated data labeling to reduce the number of - * data objects that need to be labeled by a human. Automated data labeling uses - * active learning to determine if a data object can be labeled by - * machine or if it needs to be sent to a human worker. For more information, see Using - * Automated Data Labeling.

- *

The data objects to be labeled are contained in an Amazon S3 bucket. You create a - * manifest file that describes the location of each object. For - * more information, see Using Input and Output Data.

- *

The output can be used as the manifest file for another labeling job or as training - * data for your machine learning models.

- *

You can use this operation to create a static labeling job or a streaming labeling - * job. A static labeling job stops if all data objects in the input manifest file - * identified in ManifestS3Uri have been labeled. A streaming labeling job - * runs perpetually until it is manually stopped, or remains idle for 10 days. You can send - * new data objects to an active (InProgress) streaming labeling job in real - * time. To learn how to create a static labeling job, see Create a Labeling Job - * (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming - * labeling job, see Create a Streaming Labeling - * Job.

- */ - public createLabelingJob( + + /** + * @see {@link CreateLabelingJobCommand} + */ + createLabelingJob( args: CreateLabelingJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLabelingJob( + createLabelingJob( args: CreateLabelingJobCommandInput, cb: (err: any, data?: CreateLabelingJobCommandOutput) => void ): void; - public createLabelingJob( + createLabelingJob( args: CreateLabelingJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLabelingJobCommandOutput) => void ): void; - public createLabelingJob( - args: CreateLabelingJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLabelingJobCommandOutput) => void), - cb?: (err: any, data?: CreateLabelingJobCommandOutput) => void - ): Promise | void { - const command = new CreateLabelingJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a model in SageMaker. In the request, you name the model and describe a primary - * container. For the primary container, you specify the Docker image that - * contains inference code, artifacts (from prior training), and a custom environment map - * that the inference code uses when you deploy the model for predictions.

- *

Use this API to create a model if you want to use SageMaker hosting services or run a batch - * transform job.

- *

To host your model, you create an endpoint configuration with the - * CreateEndpointConfig API, and then create an endpoint with the - * CreateEndpoint API. SageMaker then deploys all of the containers that you - * defined for the model in the hosting environment.

- *

For an example that calls this method when deploying a model to SageMaker hosting services, - * see Create a Model (Amazon Web Services SDK for Python (Boto 3)). - *

- *

To run a batch transform using your model, you start a job with the - * CreateTransformJob API. SageMaker uses your model and your dataset to get - * inferences which are then saved to a specified S3 location.

- *

In the request, you also provide an IAM role that SageMaker can assume to access model - * artifacts and docker image for deployment on ML compute hosting instances or for batch - * transform jobs. In addition, you also use the IAM role to manage permissions the - * inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.

- */ - public createModel(args: CreateModelCommandInput, options?: __HttpHandlerOptions): Promise; - public createModel(args: CreateModelCommandInput, cb: (err: any, data?: CreateModelCommandOutput) => void): void; - public createModel( + + /** + * @see {@link CreateModelCommand} + */ + createModel(args: CreateModelCommandInput, options?: __HttpHandlerOptions): Promise; + createModel(args: CreateModelCommandInput, cb: (err: any, data?: CreateModelCommandOutput) => void): void; + createModel( args: CreateModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateModelCommandOutput) => void ): void; - public createModel( - args: CreateModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateModelCommandOutput) => void), - cb?: (err: any, data?: CreateModelCommandOutput) => void - ): Promise | void { - const command = new CreateModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates the definition for a model bias job.

- */ - public createModelBiasJobDefinition( + + /** + * @see {@link CreateModelBiasJobDefinitionCommand} + */ + createModelBiasJobDefinition( args: CreateModelBiasJobDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createModelBiasJobDefinition( + createModelBiasJobDefinition( args: CreateModelBiasJobDefinitionCommandInput, cb: (err: any, data?: CreateModelBiasJobDefinitionCommandOutput) => void ): void; - public createModelBiasJobDefinition( + createModelBiasJobDefinition( args: CreateModelBiasJobDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateModelBiasJobDefinitionCommandOutput) => void ): void; - public createModelBiasJobDefinition( - args: CreateModelBiasJobDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateModelBiasJobDefinitionCommandOutput) => void), - cb?: (err: any, data?: CreateModelBiasJobDefinitionCommandOutput) => void - ): Promise | void { - const command = new CreateModelBiasJobDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon SageMaker Model Card.

- *

For information about how to use model cards, see Amazon SageMaker Model Card.

- */ - public createModelCard( + + /** + * @see {@link CreateModelCardCommand} + */ + createModelCard( args: CreateModelCardCommandInput, options?: __HttpHandlerOptions ): Promise; - public createModelCard( - args: CreateModelCardCommandInput, - cb: (err: any, data?: CreateModelCardCommandOutput) => void - ): void; - public createModelCard( + createModelCard(args: CreateModelCardCommandInput, cb: (err: any, data?: CreateModelCardCommandOutput) => void): void; + createModelCard( args: CreateModelCardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateModelCardCommandOutput) => void ): void; - public createModelCard( - args: CreateModelCardCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateModelCardCommandOutput) => void), - cb?: (err: any, data?: CreateModelCardCommandOutput) => void - ): Promise | void { - const command = new CreateModelCardCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an Amazon SageMaker Model Card export job.

- */ - public createModelCardExportJob( + + /** + * @see {@link CreateModelCardExportJobCommand} + */ + createModelCardExportJob( args: CreateModelCardExportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createModelCardExportJob( + createModelCardExportJob( args: CreateModelCardExportJobCommandInput, cb: (err: any, data?: CreateModelCardExportJobCommandOutput) => void ): void; - public createModelCardExportJob( + createModelCardExportJob( args: CreateModelCardExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateModelCardExportJobCommandOutput) => void ): void; - public createModelCardExportJob( - args: CreateModelCardExportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateModelCardExportJobCommandOutput) => void), - cb?: (err: any, data?: CreateModelCardExportJobCommandOutput) => void - ): Promise | void { - const command = new CreateModelCardExportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates the definition for a model explainability job.

- */ - public createModelExplainabilityJobDefinition( + + /** + * @see {@link CreateModelExplainabilityJobDefinitionCommand} + */ + createModelExplainabilityJobDefinition( args: CreateModelExplainabilityJobDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createModelExplainabilityJobDefinition( + createModelExplainabilityJobDefinition( args: CreateModelExplainabilityJobDefinitionCommandInput, cb: (err: any, data?: CreateModelExplainabilityJobDefinitionCommandOutput) => void ): void; - public createModelExplainabilityJobDefinition( + createModelExplainabilityJobDefinition( args: CreateModelExplainabilityJobDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateModelExplainabilityJobDefinitionCommandOutput) => void ): void; - public createModelExplainabilityJobDefinition( - args: CreateModelExplainabilityJobDefinitionCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateModelExplainabilityJobDefinitionCommandOutput) => void), - cb?: (err: any, data?: CreateModelExplainabilityJobDefinitionCommandOutput) => void - ): Promise | void { - const command = new CreateModelExplainabilityJobDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a model package that you can use to create SageMaker models or list on Amazon Web Services - * Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to - * model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

- *

To create a model package by specifying a Docker container that contains your - * inference code and the Amazon S3 location of your model artifacts, provide values for - * InferenceSpecification. To create a model from an algorithm resource - * that you created or subscribed to in Amazon Web Services Marketplace, provide a value for - * SourceAlgorithmSpecification.

- * - *

There are two types of model packages:

- *
    - *
  • - *

    Versioned - a model that is part of a model group in the model - * registry.

    - *
  • - *
  • - *

    Unversioned - a model package that is not part of a model group.

    - *
  • - *
- *
- */ - public createModelPackage( + + /** + * @see {@link CreateModelPackageCommand} + */ + createModelPackage( args: CreateModelPackageCommandInput, options?: __HttpHandlerOptions ): Promise; - public createModelPackage( + createModelPackage( args: CreateModelPackageCommandInput, cb: (err: any, data?: CreateModelPackageCommandOutput) => void ): void; - public createModelPackage( + createModelPackage( args: CreateModelPackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateModelPackageCommandOutput) => void ): void; - public createModelPackage( - args: CreateModelPackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateModelPackageCommandOutput) => void), - cb?: (err: any, data?: CreateModelPackageCommandOutput) => void - ): Promise | void { - const command = new CreateModelPackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a model group. A model group contains a group of model versions.

- */ - public createModelPackageGroup( + + /** + * @see {@link CreateModelPackageGroupCommand} + */ + createModelPackageGroup( args: CreateModelPackageGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createModelPackageGroup( + createModelPackageGroup( args: CreateModelPackageGroupCommandInput, cb: (err: any, data?: CreateModelPackageGroupCommandOutput) => void ): void; - public createModelPackageGroup( + createModelPackageGroup( args: CreateModelPackageGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateModelPackageGroupCommandOutput) => void ): void; - public createModelPackageGroup( - args: CreateModelPackageGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateModelPackageGroupCommandOutput) => void), - cb?: (err: any, data?: CreateModelPackageGroupCommandOutput) => void - ): Promise | void { - const command = new CreateModelPackageGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a definition for a job that monitors model quality and drift. For information - * about model monitor, see Amazon SageMaker Model Monitor.

- */ - public createModelQualityJobDefinition( + + /** + * @see {@link CreateModelQualityJobDefinitionCommand} + */ + createModelQualityJobDefinition( args: CreateModelQualityJobDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createModelQualityJobDefinition( + createModelQualityJobDefinition( args: CreateModelQualityJobDefinitionCommandInput, cb: (err: any, data?: CreateModelQualityJobDefinitionCommandOutput) => void ): void; - public createModelQualityJobDefinition( + createModelQualityJobDefinition( args: CreateModelQualityJobDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateModelQualityJobDefinitionCommandOutput) => void ): void; - public createModelQualityJobDefinition( - args: CreateModelQualityJobDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateModelQualityJobDefinitionCommandOutput) => void), - cb?: (err: any, data?: CreateModelQualityJobDefinitionCommandOutput) => void - ): Promise | void { - const command = new CreateModelQualityJobDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data - * captured for an Amazon SageMaker Endpoint.

- */ - public createMonitoringSchedule( + + /** + * @see {@link CreateMonitoringScheduleCommand} + */ + createMonitoringSchedule( args: CreateMonitoringScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMonitoringSchedule( + createMonitoringSchedule( args: CreateMonitoringScheduleCommandInput, cb: (err: any, data?: CreateMonitoringScheduleCommandOutput) => void ): void; - public createMonitoringSchedule( + createMonitoringSchedule( args: CreateMonitoringScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMonitoringScheduleCommandOutput) => void ): void; - public createMonitoringSchedule( - args: CreateMonitoringScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMonitoringScheduleCommandOutput) => void), - cb?: (err: any, data?: CreateMonitoringScheduleCommandOutput) => void - ): Promise | void { - const command = new CreateMonitoringScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an SageMaker notebook instance. A notebook instance is a machine learning (ML) - * compute instance running on a Jupyter notebook.

- *

In a CreateNotebookInstance request, specify the type of ML compute - * instance that you want to run. SageMaker launches the instance, installs common libraries - * that you can use to explore datasets for model training, and attaches an ML storage - * volume to the notebook instance.

- *

SageMaker also provides a set of example notebooks. Each notebook demonstrates how to - * use SageMaker with a specific algorithm or with a machine learning framework.

- *

After receiving the request, SageMaker does the following:

- *
    - *
  1. - *

    Creates a network interface in the SageMaker VPC.

    - *
  2. - *
  3. - *

    (Option) If you specified SubnetId, SageMaker creates a network - * interface in your own VPC, which is inferred from the subnet ID that you provide - * in the input. When creating this network interface, SageMaker attaches the security - * group that you specified in the request to the network interface that it creates - * in your VPC.

    - *
  4. - *
  5. - *

    Launches an EC2 instance of the type specified in the request in the SageMaker - * VPC. If you specified SubnetId of your VPC, SageMaker specifies both - * network interfaces when launching this instance. This enables inbound traffic - * from your own VPC to the notebook instance, assuming that the security groups - * allow it.

    - *
  6. - *
- *

After creating the notebook instance, SageMaker returns its Amazon Resource Name (ARN). - * You can't change the name of a notebook instance after you create it.

- *

After SageMaker creates the notebook instance, you can connect to the Jupyter server and - * work in Jupyter notebooks. For example, you can write code to explore a dataset that you - * can use for model training, train a model, host models by creating SageMaker endpoints, and - * validate hosted models.

- *

For more information, see How It Works.

- */ - public createNotebookInstance( + + /** + * @see {@link CreateNotebookInstanceCommand} + */ + createNotebookInstance( args: CreateNotebookInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNotebookInstance( + createNotebookInstance( args: CreateNotebookInstanceCommandInput, cb: (err: any, data?: CreateNotebookInstanceCommandOutput) => void ): void; - public createNotebookInstance( + createNotebookInstance( args: CreateNotebookInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNotebookInstanceCommandOutput) => void ): void; - public createNotebookInstance( - args: CreateNotebookInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNotebookInstanceCommandOutput) => void), - cb?: (err: any, data?: CreateNotebookInstanceCommandOutput) => void - ): Promise | void { - const command = new CreateNotebookInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a lifecycle configuration that you can associate with a notebook instance. A - * lifecycle configuration is a collection of shell scripts that - * run when you create or start a notebook instance.

- *

Each lifecycle configuration script has a limit of 16384 characters.

- *

The value of the $PATH environment variable that is available to both - * scripts is /sbin:bin:/usr/sbin:/usr/bin.

- *

View CloudWatch Logs for notebook instance lifecycle configurations in log group - * /aws/sagemaker/NotebookInstances in log stream - * [notebook-instance-name]/[LifecycleConfigHook].

- *

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs - * for longer than 5 minutes, it fails and the notebook instance is not created or - * started.

- *

For information about notebook instance lifestyle configurations, see Step - * 2.1: (Optional) Customize a Notebook Instance.

- */ - public createNotebookInstanceLifecycleConfig( + + /** + * @see {@link CreateNotebookInstanceLifecycleConfigCommand} + */ + createNotebookInstanceLifecycleConfig( args: CreateNotebookInstanceLifecycleConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNotebookInstanceLifecycleConfig( + createNotebookInstanceLifecycleConfig( args: CreateNotebookInstanceLifecycleConfigCommandInput, cb: (err: any, data?: CreateNotebookInstanceLifecycleConfigCommandOutput) => void ): void; - public createNotebookInstanceLifecycleConfig( + createNotebookInstanceLifecycleConfig( args: CreateNotebookInstanceLifecycleConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNotebookInstanceLifecycleConfigCommandOutput) => void ): void; - public createNotebookInstanceLifecycleConfig( - args: CreateNotebookInstanceLifecycleConfigCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateNotebookInstanceLifecycleConfigCommandOutput) => void), - cb?: (err: any, data?: CreateNotebookInstanceLifecycleConfigCommandOutput) => void - ): Promise | void { - const command = new CreateNotebookInstanceLifecycleConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a pipeline using a JSON pipeline definition.

- */ - public createPipeline( + + /** + * @see {@link CreatePipelineCommand} + */ + createPipeline( args: CreatePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPipeline( - args: CreatePipelineCommandInput, - cb: (err: any, data?: CreatePipelineCommandOutput) => void - ): void; - public createPipeline( + createPipeline(args: CreatePipelineCommandInput, cb: (err: any, data?: CreatePipelineCommandOutput) => void): void; + createPipeline( args: CreatePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePipelineCommandOutput) => void ): void; - public createPipeline( - args: CreatePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePipelineCommandOutput) => void), - cb?: (err: any, data?: CreatePipelineCommandOutput) => void - ): Promise | void { - const command = new CreatePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, - * the user will be automatically signed in to Amazon SageMaker Studio, and granted access to all of - * the Apps and files associated with the Domain's Amazon Elastic File System (EFS) volume. - * This operation can only be called when the authentication mode equals IAM. - *

- *

The IAM role or user passed to this API defines the permissions to access the app. Once - * the presigned URL is created, no additional permission is required to access this URL. IAM - * authorization policies for this API are also enforced for every HTTP request and WebSocket - * frame that attempts to connect to the app.

- *

You can restrict access to this API and to the - * URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more - * information, see Connect to SageMaker Studio Through an Interface VPC Endpoint - * .

- * - *

The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you - * are directed to the Amazon Web Services console sign-in page.

- *
- */ - public createPresignedDomainUrl( + + /** + * @see {@link CreatePresignedDomainUrlCommand} + */ + createPresignedDomainUrl( args: CreatePresignedDomainUrlCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPresignedDomainUrl( + createPresignedDomainUrl( args: CreatePresignedDomainUrlCommandInput, cb: (err: any, data?: CreatePresignedDomainUrlCommandOutput) => void ): void; - public createPresignedDomainUrl( + createPresignedDomainUrl( args: CreatePresignedDomainUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePresignedDomainUrlCommandOutput) => void ): void; - public createPresignedDomainUrl( - args: CreatePresignedDomainUrlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePresignedDomainUrlCommandOutput) => void), - cb?: (err: any, data?: CreatePresignedDomainUrlCommandOutput) => void - ): Promise | void { - const command = new CreatePresignedDomainUrlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a URL that you can use to connect to the Jupyter server from a notebook - * instance. In the SageMaker console, when you choose Open next to a notebook - * instance, SageMaker opens a new tab showing the Jupyter server home page from the notebook - * instance. The console uses this API to get the URL and show the page.

- *

The IAM role or user used to call this API defines the permissions to access the - * notebook instance. Once the presigned URL is created, no additional permission is - * required to access this URL. IAM authorization policies for this API are also enforced - * for every HTTP request and WebSocket frame that attempts to connect to the notebook - * instance.

- *

You can restrict access to this API and to the URL that it returns to a list of IP - * addresses that you specify. Use the NotIpAddress condition operator and the - * aws:SourceIP condition context key to specify the list of IP addresses - * that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

- * - *

The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If - * you try to use the URL after the 5-minute limit expires, you are directed to the - * Amazon Web Services console sign-in page.

- *
- */ - public createPresignedNotebookInstanceUrl( + + /** + * @see {@link CreatePresignedNotebookInstanceUrlCommand} + */ + createPresignedNotebookInstanceUrl( args: CreatePresignedNotebookInstanceUrlCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPresignedNotebookInstanceUrl( + createPresignedNotebookInstanceUrl( args: CreatePresignedNotebookInstanceUrlCommandInput, cb: (err: any, data?: CreatePresignedNotebookInstanceUrlCommandOutput) => void ): void; - public createPresignedNotebookInstanceUrl( + createPresignedNotebookInstanceUrl( args: CreatePresignedNotebookInstanceUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePresignedNotebookInstanceUrlCommandOutput) => void ): void; - public createPresignedNotebookInstanceUrl( - args: CreatePresignedNotebookInstanceUrlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePresignedNotebookInstanceUrlCommandOutput) => void), - cb?: (err: any, data?: CreatePresignedNotebookInstanceUrlCommandOutput) => void - ): Promise | void { - const command = new CreatePresignedNotebookInstanceUrlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a processing job.

- */ - public createProcessingJob( + + /** + * @see {@link CreateProcessingJobCommand} + */ + createProcessingJob( args: CreateProcessingJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createProcessingJob( + createProcessingJob( args: CreateProcessingJobCommandInput, cb: (err: any, data?: CreateProcessingJobCommandOutput) => void ): void; - public createProcessingJob( + createProcessingJob( args: CreateProcessingJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProcessingJobCommandOutput) => void ): void; - public createProcessingJob( - args: CreateProcessingJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProcessingJobCommandOutput) => void), - cb?: (err: any, data?: CreateProcessingJobCommandOutput) => void - ): Promise | void { - const command = new CreateProcessingJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a machine learning (ML) project that can contain one or more templates that set - * up an ML pipeline from training to deploying an approved model.

- */ - public createProject( - args: CreateProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createProject( - args: CreateProjectCommandInput, - cb: (err: any, data?: CreateProjectCommandOutput) => void - ): void; - public createProject( + + /** + * @see {@link CreateProjectCommand} + */ + createProject(args: CreateProjectCommandInput, options?: __HttpHandlerOptions): Promise; + createProject(args: CreateProjectCommandInput, cb: (err: any, data?: CreateProjectCommandOutput) => void): void; + createProject( args: CreateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectCommandOutput) => void ): void; - public createProject( - args: CreateProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProjectCommandOutput) => void), - cb?: (err: any, data?: CreateProjectCommandOutput) => void - ): Promise | void { - const command = new CreateProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a space used for real time collaboration in a Domain.

- */ - public createSpace(args: CreateSpaceCommandInput, options?: __HttpHandlerOptions): Promise; - public createSpace(args: CreateSpaceCommandInput, cb: (err: any, data?: CreateSpaceCommandOutput) => void): void; - public createSpace( + + /** + * @see {@link CreateSpaceCommand} + */ + createSpace(args: CreateSpaceCommandInput, options?: __HttpHandlerOptions): Promise; + createSpace(args: CreateSpaceCommandInput, cb: (err: any, data?: CreateSpaceCommandOutput) => void): void; + createSpace( args: CreateSpaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSpaceCommandOutput) => void ): void; - public createSpace( - args: CreateSpaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSpaceCommandOutput) => void), - cb?: (err: any, data?: CreateSpaceCommandOutput) => void - ): Promise | void { - const command = new CreateSpaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new Studio Lifecycle Configuration.

- */ - public createStudioLifecycleConfig( + + /** + * @see {@link CreateStudioLifecycleConfigCommand} + */ + createStudioLifecycleConfig( args: CreateStudioLifecycleConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public createStudioLifecycleConfig( + createStudioLifecycleConfig( args: CreateStudioLifecycleConfigCommandInput, cb: (err: any, data?: CreateStudioLifecycleConfigCommandOutput) => void ): void; - public createStudioLifecycleConfig( + createStudioLifecycleConfig( args: CreateStudioLifecycleConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStudioLifecycleConfigCommandOutput) => void ): void; - public createStudioLifecycleConfig( - args: CreateStudioLifecycleConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStudioLifecycleConfigCommandOutput) => void), - cb?: (err: any, data?: CreateStudioLifecycleConfigCommandOutput) => void - ): Promise | void { - const command = new CreateStudioLifecycleConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a model training job. After training completes, SageMaker saves the resulting - * model artifacts to an Amazon S3 location that you specify.

- *

If you choose to host your model using SageMaker hosting services, you can use the - * resulting model artifacts as part of the model. You can also use the artifacts in a - * machine learning service other than SageMaker, provided that you know how to use them for - * inference. - *

- *

In the request body, you provide the following:

- *
    - *
  • - *

    - * AlgorithmSpecification - Identifies the training algorithm to - * use. - *

    - *
  • - *
  • - *

    - * HyperParameters - Specify these algorithm-specific parameters to - * enable the estimation of model parameters during training. Hyperparameters can - * be tuned to optimize this learning process. For a list of hyperparameters for - * each training algorithm provided by SageMaker, see Algorithms.

    - * - *

    Do not include any security-sensitive information including account access - * IDs, secrets or tokens in any hyperparameter field. If the use of - * security-sensitive credentials are detected, SageMaker will reject your training - * job request and return an exception error.

    - *
    - *
  • - *
  • - *

    - * InputDataConfig - Describes the input required by the training - * job and the Amazon S3, EFS, or FSx location where it is stored.

    - *
  • - *
  • - *

    - * OutputDataConfig - Identifies the Amazon S3 bucket where you want - * SageMaker to save the results of model training.

    - *
  • - *
  • - *

    - * ResourceConfig - Identifies the resources, ML compute - * instances, and ML storage volumes to deploy for model training. In distributed - * training, you specify more than one instance.

    - *
  • - *
  • - *

    - * EnableManagedSpotTraining - Optimize the cost of training machine - * learning models by up to 80% by using Amazon EC2 Spot instances. For more - * information, see Managed Spot - * Training.

    - *
  • - *
  • - *

    - * RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on - * your behalf during model training. - * - * You must grant this role the necessary permissions so that SageMaker can successfully - * complete model training.

    - *
  • - *
  • - *

    - * StoppingCondition - To help cap training costs, use - * MaxRuntimeInSeconds to set a time limit for training. Use - * MaxWaitTimeInSeconds to specify how long a managed spot - * training job has to complete.

    - *
  • - *
  • - *

    - * Environment - The environment variables to set in the Docker - * container.

    - *
  • - *
  • - *

    - * RetryStrategy - The number of times to retry the job when the job - * fails due to an InternalServerError.

    - *
  • - *
- *

For more information about SageMaker, see How It Works.

- */ - public createTrainingJob( + + /** + * @see {@link CreateTrainingJobCommand} + */ + createTrainingJob( args: CreateTrainingJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTrainingJob( + createTrainingJob( args: CreateTrainingJobCommandInput, cb: (err: any, data?: CreateTrainingJobCommandOutput) => void ): void; - public createTrainingJob( + createTrainingJob( args: CreateTrainingJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTrainingJobCommandOutput) => void ): void; - public createTrainingJob( - args: CreateTrainingJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTrainingJobCommandOutput) => void), - cb?: (err: any, data?: CreateTrainingJobCommandOutput) => void - ): Promise | void { - const command = new CreateTrainingJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a transform job. A transform job uses a trained model to get inferences on a - * dataset and saves these results to an Amazon S3 location that you specify.

- *

To perform batch transformations, you create a transform job and use the data that you - * have readily available.

- *

In the request body, you provide the following:

- *
    - *
  • - *

    - * TransformJobName - Identifies the transform job. The name must be - * unique within an Amazon Web Services Region in an Amazon Web Services account.

    - *
  • - *
  • - *

    - * ModelName - Identifies the model to use. ModelName - * must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services - * account. For information on creating a model, see CreateModel.

    - *
  • - *
  • - *

    - * TransformInput - Describes the dataset to be transformed and the - * Amazon S3 location where it is stored.

    - *
  • - *
  • - *

    - * TransformOutput - Identifies the Amazon S3 location where you want - * Amazon SageMaker to save the results from the transform job.

    - *
  • - *
  • - *

    - * TransformResources - Identifies the ML compute instances for the - * transform job.

    - *
  • - *
- *

For more information about how batch transformation works, see Batch - * Transform.

- */ - public createTransformJob( + + /** + * @see {@link CreateTransformJobCommand} + */ + createTransformJob( args: CreateTransformJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTransformJob( + createTransformJob( args: CreateTransformJobCommandInput, cb: (err: any, data?: CreateTransformJobCommandOutput) => void ): void; - public createTransformJob( + createTransformJob( args: CreateTransformJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTransformJobCommandOutput) => void ): void; - public createTransformJob( - args: CreateTransformJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTransformJobCommandOutput) => void), - cb?: (err: any, data?: CreateTransformJobCommandOutput) => void - ): Promise | void { - const command = new CreateTransformJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an SageMaker trial. A trial is a set of steps called - * trial components that produce a machine learning model. A trial is part - * of a single SageMaker experiment.

- *

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial - * components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you - * must use the logging APIs provided by the SDK.

- *

You can add tags to a trial and then use the Search API to search for - * the tags.

- *

To get a list of all your trials, call the ListTrials API. To view a - * trial's properties, call the DescribeTrial API. To create a trial component, - * call the CreateTrialComponent API.

- */ - public createTrial(args: CreateTrialCommandInput, options?: __HttpHandlerOptions): Promise; - public createTrial(args: CreateTrialCommandInput, cb: (err: any, data?: CreateTrialCommandOutput) => void): void; - public createTrial( + + /** + * @see {@link CreateTrialCommand} + */ + createTrial(args: CreateTrialCommandInput, options?: __HttpHandlerOptions): Promise; + createTrial(args: CreateTrialCommandInput, cb: (err: any, data?: CreateTrialCommandOutput) => void): void; + createTrial( args: CreateTrialCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTrialCommandOutput) => void ): void; - public createTrial( - args: CreateTrialCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTrialCommandOutput) => void), - cb?: (err: any, data?: CreateTrialCommandOutput) => void - ): Promise | void { - const command = new CreateTrialCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a trial component, which is a stage of a machine learning - * trial. A trial is composed of one or more trial components. A trial - * component can be used in multiple trials.

- *

Trial components include pre-processing jobs, training jobs, and batch transform - * jobs.

- *

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial - * components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you - * must use the logging APIs provided by the SDK.

- *

You can add tags to a trial component and then use the Search API to - * search for the tags.

- */ - public createTrialComponent( + + /** + * @see {@link CreateTrialComponentCommand} + */ + createTrialComponent( args: CreateTrialComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTrialComponent( + createTrialComponent( args: CreateTrialComponentCommandInput, cb: (err: any, data?: CreateTrialComponentCommandOutput) => void ): void; - public createTrialComponent( + createTrialComponent( args: CreateTrialComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTrialComponentCommandOutput) => void ): void; - public createTrialComponent( - args: CreateTrialComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTrialComponentCommandOutput) => void), - cb?: (err: any, data?: CreateTrialComponentCommandOutput) => void - ): Promise | void { - const command = new CreateTrialComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a user profile. A user profile represents a single user within a domain, and is - * the main way to reference a "person" for the purposes of sharing, reporting, and other - * user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an - * administrator invites a person by email or imports them from IAM Identity Center, a user profile is - * automatically created. A user profile is the primary holder of settings for an individual - * user and has a reference to the user's private Amazon Elastic File System (EFS) home directory. - *

- */ - public createUserProfile( + + /** + * @see {@link CreateUserProfileCommand} + */ + createUserProfile( args: CreateUserProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public createUserProfile( + createUserProfile( args: CreateUserProfileCommandInput, cb: (err: any, data?: CreateUserProfileCommandOutput) => void ): void; - public createUserProfile( + createUserProfile( args: CreateUserProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserProfileCommandOutput) => void ): void; - public createUserProfile( - args: CreateUserProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserProfileCommandOutput) => void), - cb?: (err: any, data?: CreateUserProfileCommandOutput) => void - ): Promise | void { - const command = new CreateUserProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Use this operation to create a workforce. This operation will return an error - * if a workforce already exists in the Amazon Web Services Region that you specify. You can only - * create one workforce in each Amazon Web Services Region per Amazon Web Services account.

- *

If you want to create a new workforce in an Amazon Web Services Region where - * a workforce already exists, use the API - * operation to delete the existing workforce and then use CreateWorkforce - * to create a new workforce.

- *

To create a private workforce using Amazon Cognito, you must specify a Cognito user pool - * in CognitoConfig. - * You can also create an Amazon Cognito workforce using the Amazon SageMaker console. - * For more information, see - * - * Create a Private Workforce (Amazon Cognito).

- *

To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP - * configuration in OidcConfig. Your OIDC IdP must support groups - * because groups are used by Ground Truth and Amazon A2I to create work teams. - * For more information, see - * Create a Private Workforce (OIDC IdP).

- */ - public createWorkforce( + + /** + * @see {@link CreateWorkforceCommand} + */ + createWorkforce( args: CreateWorkforceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorkforce( - args: CreateWorkforceCommandInput, - cb: (err: any, data?: CreateWorkforceCommandOutput) => void - ): void; - public createWorkforce( + createWorkforce(args: CreateWorkforceCommandInput, cb: (err: any, data?: CreateWorkforceCommandOutput) => void): void; + createWorkforce( args: CreateWorkforceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkforceCommandOutput) => void ): void; - public createWorkforce( - args: CreateWorkforceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorkforceCommandOutput) => void), - cb?: (err: any, data?: CreateWorkforceCommandOutput) => void - ): Promise | void { - const command = new CreateWorkforceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new work team for labeling your data. A work team is defined by one or more - * Amazon Cognito user pools. You must first create the user pools before you can create a work - * team.

- *

You cannot create more than 25 work teams in an account and region.

- */ - public createWorkteam( + + /** + * @see {@link CreateWorkteamCommand} + */ + createWorkteam( args: CreateWorkteamCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorkteam( - args: CreateWorkteamCommandInput, - cb: (err: any, data?: CreateWorkteamCommandOutput) => void - ): void; - public createWorkteam( + createWorkteam(args: CreateWorkteamCommandInput, cb: (err: any, data?: CreateWorkteamCommandOutput) => void): void; + createWorkteam( args: CreateWorkteamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkteamCommandOutput) => void ): void; - public createWorkteam( - args: CreateWorkteamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorkteamCommandOutput) => void), - cb?: (err: any, data?: CreateWorkteamCommandOutput) => void - ): Promise | void { - const command = new CreateWorkteamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an action.

- */ - public deleteAction( - args: DeleteActionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteAction(args: DeleteActionCommandInput, cb: (err: any, data?: DeleteActionCommandOutput) => void): void; - public deleteAction( + + /** + * @see {@link DeleteActionCommand} + */ + deleteAction(args: DeleteActionCommandInput, options?: __HttpHandlerOptions): Promise; + deleteAction(args: DeleteActionCommandInput, cb: (err: any, data?: DeleteActionCommandOutput) => void): void; + deleteAction( args: DeleteActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteActionCommandOutput) => void ): void; - public deleteAction( - args: DeleteActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteActionCommandOutput) => void), - cb?: (err: any, data?: DeleteActionCommandOutput) => void - ): Promise | void { - const command = new DeleteActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the specified algorithm from your account.

- */ - public deleteAlgorithm( + + /** + * @see {@link DeleteAlgorithmCommand} + */ + deleteAlgorithm( args: DeleteAlgorithmCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAlgorithm( - args: DeleteAlgorithmCommandInput, - cb: (err: any, data?: DeleteAlgorithmCommandOutput) => void - ): void; - public deleteAlgorithm( + deleteAlgorithm(args: DeleteAlgorithmCommandInput, cb: (err: any, data?: DeleteAlgorithmCommandOutput) => void): void; + deleteAlgorithm( args: DeleteAlgorithmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAlgorithmCommandOutput) => void ): void; - public deleteAlgorithm( - args: DeleteAlgorithmCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAlgorithmCommandOutput) => void), - cb?: (err: any, data?: DeleteAlgorithmCommandOutput) => void - ): Promise | void { - const command = new DeleteAlgorithmCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Used to stop and delete an app.

- */ - public deleteApp(args: DeleteAppCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteApp(args: DeleteAppCommandInput, cb: (err: any, data?: DeleteAppCommandOutput) => void): void; - public deleteApp( + + /** + * @see {@link DeleteAppCommand} + */ + deleteApp(args: DeleteAppCommandInput, options?: __HttpHandlerOptions): Promise; + deleteApp(args: DeleteAppCommandInput, cb: (err: any, data?: DeleteAppCommandOutput) => void): void; + deleteApp( args: DeleteAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppCommandOutput) => void ): void; - public deleteApp( - args: DeleteAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppCommandOutput) => void), - cb?: (err: any, data?: DeleteAppCommandOutput) => void - ): Promise | void { - const command = new DeleteAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an AppImageConfig.

- */ - public deleteAppImageConfig( + + /** + * @see {@link DeleteAppImageConfigCommand} + */ + deleteAppImageConfig( args: DeleteAppImageConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAppImageConfig( + deleteAppImageConfig( args: DeleteAppImageConfigCommandInput, cb: (err: any, data?: DeleteAppImageConfigCommandOutput) => void ): void; - public deleteAppImageConfig( + deleteAppImageConfig( args: DeleteAppImageConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppImageConfigCommandOutput) => void ): void; - public deleteAppImageConfig( - args: DeleteAppImageConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppImageConfigCommandOutput) => void), - cb?: (err: any, data?: DeleteAppImageConfigCommandOutput) => void - ): Promise | void { - const command = new DeleteAppImageConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an artifact. Either ArtifactArn or Source must be - * specified.

- */ - public deleteArtifact( + + /** + * @see {@link DeleteArtifactCommand} + */ + deleteArtifact( args: DeleteArtifactCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteArtifact( - args: DeleteArtifactCommandInput, - cb: (err: any, data?: DeleteArtifactCommandOutput) => void - ): void; - public deleteArtifact( + deleteArtifact(args: DeleteArtifactCommandInput, cb: (err: any, data?: DeleteArtifactCommandOutput) => void): void; + deleteArtifact( args: DeleteArtifactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteArtifactCommandOutput) => void ): void; - public deleteArtifact( - args: DeleteArtifactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteArtifactCommandOutput) => void), - cb?: (err: any, data?: DeleteArtifactCommandOutput) => void - ): Promise | void { - const command = new DeleteArtifactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an association.

- */ - public deleteAssociation( + + /** + * @see {@link DeleteAssociationCommand} + */ + deleteAssociation( args: DeleteAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAssociation( + deleteAssociation( args: DeleteAssociationCommandInput, cb: (err: any, data?: DeleteAssociationCommandOutput) => void ): void; - public deleteAssociation( + deleteAssociation( args: DeleteAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAssociationCommandOutput) => void ): void; - public deleteAssociation( - args: DeleteAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAssociationCommandOutput) => void), - cb?: (err: any, data?: DeleteAssociationCommandOutput) => void - ): Promise | void { - const command = new DeleteAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified Git repository from your account.

- */ - public deleteCodeRepository( + + /** + * @see {@link DeleteCodeRepositoryCommand} + */ + deleteCodeRepository( args: DeleteCodeRepositoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCodeRepository( + deleteCodeRepository( args: DeleteCodeRepositoryCommandInput, cb: (err: any, data?: DeleteCodeRepositoryCommandOutput) => void ): void; - public deleteCodeRepository( + deleteCodeRepository( args: DeleteCodeRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCodeRepositoryCommandOutput) => void ): void; - public deleteCodeRepository( - args: DeleteCodeRepositoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCodeRepositoryCommandOutput) => void), - cb?: (err: any, data?: DeleteCodeRepositoryCommandOutput) => void - ): Promise | void { - const command = new DeleteCodeRepositoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an context.

- */ - public deleteContext( - args: DeleteContextCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteContext( - args: DeleteContextCommandInput, - cb: (err: any, data?: DeleteContextCommandOutput) => void - ): void; - public deleteContext( + + /** + * @see {@link DeleteContextCommand} + */ + deleteContext(args: DeleteContextCommandInput, options?: __HttpHandlerOptions): Promise; + deleteContext(args: DeleteContextCommandInput, cb: (err: any, data?: DeleteContextCommandOutput) => void): void; + deleteContext( args: DeleteContextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteContextCommandOutput) => void ): void; - public deleteContext( - args: DeleteContextCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteContextCommandOutput) => void), - cb?: (err: any, data?: DeleteContextCommandOutput) => void - ): Promise | void { - const command = new DeleteContextCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a data quality monitoring job definition.

- */ - public deleteDataQualityJobDefinition( + + /** + * @see {@link DeleteDataQualityJobDefinitionCommand} + */ + deleteDataQualityJobDefinition( args: DeleteDataQualityJobDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDataQualityJobDefinition( + deleteDataQualityJobDefinition( args: DeleteDataQualityJobDefinitionCommandInput, cb: (err: any, data?: DeleteDataQualityJobDefinitionCommandOutput) => void ): void; - public deleteDataQualityJobDefinition( + deleteDataQualityJobDefinition( args: DeleteDataQualityJobDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataQualityJobDefinitionCommandOutput) => void ): void; - public deleteDataQualityJobDefinition( - args: DeleteDataQualityJobDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDataQualityJobDefinitionCommandOutput) => void), - cb?: (err: any, data?: DeleteDataQualityJobDefinitionCommandOutput) => void - ): Promise | void { - const command = new DeleteDataQualityJobDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a fleet.

- */ - public deleteDeviceFleet( + + /** + * @see {@link DeleteDeviceFleetCommand} + */ + deleteDeviceFleet( args: DeleteDeviceFleetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDeviceFleet( + deleteDeviceFleet( args: DeleteDeviceFleetCommandInput, cb: (err: any, data?: DeleteDeviceFleetCommandOutput) => void ): void; - public deleteDeviceFleet( + deleteDeviceFleet( args: DeleteDeviceFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDeviceFleetCommandOutput) => void ): void; - public deleteDeviceFleet( - args: DeleteDeviceFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDeviceFleetCommandOutput) => void), - cb?: (err: any, data?: DeleteDeviceFleetCommandOutput) => void - ): Promise | void { - const command = new DeleteDeviceFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Used to delete a domain. - * If you onboarded with IAM mode, you will need to delete your domain to onboard again using IAM Identity Center. - * Use with caution. All of the members of the domain will lose access to their EFS volume, - * including data, notebooks, and other artifacts. - *

- */ - public deleteDomain( - args: DeleteDomainCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDomain(args: DeleteDomainCommandInput, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void; - public deleteDomain( + + /** + * @see {@link DeleteDomainCommand} + */ + deleteDomain(args: DeleteDomainCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDomain(args: DeleteDomainCommandInput, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void; + deleteDomain( args: DeleteDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDomainCommandOutput) => void ): void; - public deleteDomain( - args: DeleteDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDomainCommandOutput) => void), - cb?: (err: any, data?: DeleteDomainCommandOutput) => void - ): Promise | void { - const command = new DeleteDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an edge deployment plan if (and only if) all the stages in the plan are inactive or there are no stages in the plan.

- */ - public deleteEdgeDeploymentPlan( + + /** + * @see {@link DeleteEdgeDeploymentPlanCommand} + */ + deleteEdgeDeploymentPlan( args: DeleteEdgeDeploymentPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEdgeDeploymentPlan( + deleteEdgeDeploymentPlan( args: DeleteEdgeDeploymentPlanCommandInput, cb: (err: any, data?: DeleteEdgeDeploymentPlanCommandOutput) => void ): void; - public deleteEdgeDeploymentPlan( + deleteEdgeDeploymentPlan( args: DeleteEdgeDeploymentPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEdgeDeploymentPlanCommandOutput) => void ): void; - public deleteEdgeDeploymentPlan( - args: DeleteEdgeDeploymentPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEdgeDeploymentPlanCommandOutput) => void), - cb?: (err: any, data?: DeleteEdgeDeploymentPlanCommandOutput) => void - ): Promise | void { - const command = new DeleteEdgeDeploymentPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete a stage in an edge deployment plan if (and only if) the stage is inactive.

- */ - public deleteEdgeDeploymentStage( + + /** + * @see {@link DeleteEdgeDeploymentStageCommand} + */ + deleteEdgeDeploymentStage( args: DeleteEdgeDeploymentStageCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEdgeDeploymentStage( + deleteEdgeDeploymentStage( args: DeleteEdgeDeploymentStageCommandInput, cb: (err: any, data?: DeleteEdgeDeploymentStageCommandOutput) => void ): void; - public deleteEdgeDeploymentStage( + deleteEdgeDeploymentStage( args: DeleteEdgeDeploymentStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEdgeDeploymentStageCommandOutput) => void ): void; - public deleteEdgeDeploymentStage( - args: DeleteEdgeDeploymentStageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEdgeDeploymentStageCommandOutput) => void), - cb?: (err: any, data?: DeleteEdgeDeploymentStageCommandOutput) => void - ): Promise | void { - const command = new DeleteEdgeDeploymentStageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the - * endpoint was created.

- *

SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't - * need to use the RevokeGrant API call.

- *

When you delete your endpoint, SageMaker asynchronously deletes associated endpoint - * resources such as KMS key grants. You might still see these resources in your account - * for a few minutes after deleting your endpoint. Do not delete or revoke the permissions - * for your - * ExecutionRoleArn - * , otherwise SageMaker cannot delete these - * resources.

- */ - public deleteEndpoint( + + /** + * @see {@link DeleteEndpointCommand} + */ + deleteEndpoint( args: DeleteEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEndpoint( - args: DeleteEndpointCommandInput, - cb: (err: any, data?: DeleteEndpointCommandOutput) => void - ): void; - public deleteEndpoint( + deleteEndpoint(args: DeleteEndpointCommandInput, cb: (err: any, data?: DeleteEndpointCommandOutput) => void): void; + deleteEndpoint( args: DeleteEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEndpointCommandOutput) => void ): void; - public deleteEndpoint( - args: DeleteEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEndpointCommandOutput) => void), - cb?: (err: any, data?: DeleteEndpointCommandOutput) => void - ): Promise | void { - const command = new DeleteEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an endpoint configuration. The DeleteEndpointConfig API - * deletes only the specified configuration. It does not delete endpoints created using the - * configuration.

- *

You must not delete an EndpointConfig in use by an endpoint that is - * live or while the UpdateEndpoint or CreateEndpoint operations - * are being performed on the endpoint. If you delete the EndpointConfig of an - * endpoint that is active or being created or updated you may lose visibility into the - * instance type the endpoint is using. The endpoint must be deleted in order to stop - * incurring charges.

- */ - public deleteEndpointConfig( + + /** + * @see {@link DeleteEndpointConfigCommand} + */ + deleteEndpointConfig( args: DeleteEndpointConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEndpointConfig( + deleteEndpointConfig( args: DeleteEndpointConfigCommandInput, cb: (err: any, data?: DeleteEndpointConfigCommandOutput) => void ): void; - public deleteEndpointConfig( + deleteEndpointConfig( args: DeleteEndpointConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEndpointConfigCommandOutput) => void ): void; - public deleteEndpointConfig( - args: DeleteEndpointConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEndpointConfigCommandOutput) => void), - cb?: (err: any, data?: DeleteEndpointConfigCommandOutput) => void - ): Promise | void { - const command = new DeleteEndpointConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an SageMaker experiment. All trials associated with the experiment must be deleted - * first. Use the ListTrials API to get a list of the trials associated with - * the experiment.

- */ - public deleteExperiment( + + /** + * @see {@link DeleteExperimentCommand} + */ + deleteExperiment( args: DeleteExperimentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteExperiment( + deleteExperiment( args: DeleteExperimentCommandInput, cb: (err: any, data?: DeleteExperimentCommandOutput) => void ): void; - public deleteExperiment( + deleteExperiment( args: DeleteExperimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteExperimentCommandOutput) => void ): void; - public deleteExperiment( - args: DeleteExperimentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteExperimentCommandOutput) => void), - cb?: (err: any, data?: DeleteExperimentCommandOutput) => void - ): Promise | void { - const command = new DeleteExperimentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete the FeatureGroup and any data that was written to the - * OnlineStore of the FeatureGroup. Data cannot be accessed from - * the OnlineStore immediately after DeleteFeatureGroup is called.

- *

Data written into the OfflineStore will not be deleted. The Amazon Web Services Glue - * database and tables that are automatically created for your OfflineStore are - * not deleted.

- */ - public deleteFeatureGroup( + + /** + * @see {@link DeleteFeatureGroupCommand} + */ + deleteFeatureGroup( args: DeleteFeatureGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFeatureGroup( + deleteFeatureGroup( args: DeleteFeatureGroupCommandInput, cb: (err: any, data?: DeleteFeatureGroupCommandOutput) => void ): void; - public deleteFeatureGroup( + deleteFeatureGroup( args: DeleteFeatureGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFeatureGroupCommandOutput) => void ): void; - public deleteFeatureGroup( - args: DeleteFeatureGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFeatureGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteFeatureGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteFeatureGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified flow definition.

- */ - public deleteFlowDefinition( + + /** + * @see {@link DeleteFlowDefinitionCommand} + */ + deleteFlowDefinition( args: DeleteFlowDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFlowDefinition( + deleteFlowDefinition( args: DeleteFlowDefinitionCommandInput, cb: (err: any, data?: DeleteFlowDefinitionCommandOutput) => void ): void; - public deleteFlowDefinition( + deleteFlowDefinition( args: DeleteFlowDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFlowDefinitionCommandOutput) => void ): void; - public deleteFlowDefinition( - args: DeleteFlowDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFlowDefinitionCommandOutput) => void), - cb?: (err: any, data?: DeleteFlowDefinitionCommandOutput) => void - ): Promise | void { - const command = new DeleteFlowDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete a hub.

- * - *

Hub APIs are only callable through SageMaker Studio.

- *
- */ - public deleteHub(args: DeleteHubCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteHub(args: DeleteHubCommandInput, cb: (err: any, data?: DeleteHubCommandOutput) => void): void; - public deleteHub( + + /** + * @see {@link DeleteHubCommand} + */ + deleteHub(args: DeleteHubCommandInput, options?: __HttpHandlerOptions): Promise; + deleteHub(args: DeleteHubCommandInput, cb: (err: any, data?: DeleteHubCommandOutput) => void): void; + deleteHub( args: DeleteHubCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHubCommandOutput) => void ): void; - public deleteHub( - args: DeleteHubCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteHubCommandOutput) => void), - cb?: (err: any, data?: DeleteHubCommandOutput) => void - ): Promise | void { - const command = new DeleteHubCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete the contents of a hub.

- * - *

Hub APIs are only callable through SageMaker Studio.

- *
- */ - public deleteHubContent( + + /** + * @see {@link DeleteHubContentCommand} + */ + deleteHubContent( args: DeleteHubContentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteHubContent( + deleteHubContent( args: DeleteHubContentCommandInput, cb: (err: any, data?: DeleteHubContentCommandOutput) => void ): void; - public deleteHubContent( + deleteHubContent( args: DeleteHubContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHubContentCommandOutput) => void ): void; - public deleteHubContent( - args: DeleteHubContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteHubContentCommandOutput) => void), - cb?: (err: any, data?: DeleteHubContentCommandOutput) => void - ): Promise | void { - const command = new DeleteHubContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Use this operation to delete a human task user interface (worker task template).

- *

- * To see a list of human task user interfaces - * (work task templates) in your account, use . - * When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.

- */ - public deleteHumanTaskUi( + + /** + * @see {@link DeleteHumanTaskUiCommand} + */ + deleteHumanTaskUi( args: DeleteHumanTaskUiCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteHumanTaskUi( + deleteHumanTaskUi( args: DeleteHumanTaskUiCommandInput, cb: (err: any, data?: DeleteHumanTaskUiCommandOutput) => void ): void; - public deleteHumanTaskUi( + deleteHumanTaskUi( args: DeleteHumanTaskUiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHumanTaskUiCommandOutput) => void ): void; - public deleteHumanTaskUi( - args: DeleteHumanTaskUiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteHumanTaskUiCommandOutput) => void), - cb?: (err: any, data?: DeleteHumanTaskUiCommandOutput) => void - ): Promise | void { - const command = new DeleteHumanTaskUiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a SageMaker image and all versions of the image. The container images aren't - * deleted.

- */ - public deleteImage(args: DeleteImageCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteImage(args: DeleteImageCommandInput, cb: (err: any, data?: DeleteImageCommandOutput) => void): void; - public deleteImage( + + /** + * @see {@link DeleteImageCommand} + */ + deleteImage(args: DeleteImageCommandInput, options?: __HttpHandlerOptions): Promise; + deleteImage(args: DeleteImageCommandInput, cb: (err: any, data?: DeleteImageCommandOutput) => void): void; + deleteImage( args: DeleteImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteImageCommandOutput) => void ): void; - public deleteImage( - args: DeleteImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteImageCommandOutput) => void), - cb?: (err: any, data?: DeleteImageCommandOutput) => void - ): Promise | void { - const command = new DeleteImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a version of a SageMaker image. The container image the version represents isn't - * deleted.

- */ - public deleteImageVersion( + + /** + * @see {@link DeleteImageVersionCommand} + */ + deleteImageVersion( args: DeleteImageVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteImageVersion( + deleteImageVersion( args: DeleteImageVersionCommandInput, cb: (err: any, data?: DeleteImageVersionCommandOutput) => void ): void; - public deleteImageVersion( + deleteImageVersion( args: DeleteImageVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteImageVersionCommandOutput) => void ): void; - public deleteImageVersion( - args: DeleteImageVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteImageVersionCommandOutput) => void), - cb?: (err: any, data?: DeleteImageVersionCommandOutput) => void - ): Promise | void { - const command = new DeleteImageVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an inference experiment.

- * - *

- * This operation does not delete your endpoint, variants, or any underlying resources. This operation only - * deletes the metadata of your experiment. - *

- *
- */ - public deleteInferenceExperiment( + + /** + * @see {@link DeleteInferenceExperimentCommand} + */ + deleteInferenceExperiment( args: DeleteInferenceExperimentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInferenceExperiment( + deleteInferenceExperiment( args: DeleteInferenceExperimentCommandInput, cb: (err: any, data?: DeleteInferenceExperimentCommandOutput) => void ): void; - public deleteInferenceExperiment( + deleteInferenceExperiment( args: DeleteInferenceExperimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInferenceExperimentCommandOutput) => void ): void; - public deleteInferenceExperiment( - args: DeleteInferenceExperimentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInferenceExperimentCommandOutput) => void), - cb?: (err: any, data?: DeleteInferenceExperimentCommandOutput) => void - ): Promise | void { - const command = new DeleteInferenceExperimentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a model. The DeleteModel API deletes only the model entry that - * was created in SageMaker when you called the CreateModel API. It does not delete - * model artifacts, inference code, or the IAM role that you specified when creating the - * model.

- */ - public deleteModel(args: DeleteModelCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteModel(args: DeleteModelCommandInput, cb: (err: any, data?: DeleteModelCommandOutput) => void): void; - public deleteModel( + + /** + * @see {@link DeleteModelCommand} + */ + deleteModel(args: DeleteModelCommandInput, options?: __HttpHandlerOptions): Promise; + deleteModel(args: DeleteModelCommandInput, cb: (err: any, data?: DeleteModelCommandOutput) => void): void; + deleteModel( args: DeleteModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteModelCommandOutput) => void ): void; - public deleteModel( - args: DeleteModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteModelCommandOutput) => void), - cb?: (err: any, data?: DeleteModelCommandOutput) => void - ): Promise | void { - const command = new DeleteModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an Amazon SageMaker model bias job definition.

- */ - public deleteModelBiasJobDefinition( + + /** + * @see {@link DeleteModelBiasJobDefinitionCommand} + */ + deleteModelBiasJobDefinition( args: DeleteModelBiasJobDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteModelBiasJobDefinition( + deleteModelBiasJobDefinition( args: DeleteModelBiasJobDefinitionCommandInput, cb: (err: any, data?: DeleteModelBiasJobDefinitionCommandOutput) => void ): void; - public deleteModelBiasJobDefinition( + deleteModelBiasJobDefinition( args: DeleteModelBiasJobDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteModelBiasJobDefinitionCommandOutput) => void ): void; - public deleteModelBiasJobDefinition( - args: DeleteModelBiasJobDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteModelBiasJobDefinitionCommandOutput) => void), - cb?: (err: any, data?: DeleteModelBiasJobDefinitionCommandOutput) => void - ): Promise | void { - const command = new DeleteModelBiasJobDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an Amazon SageMaker Model Card.

- */ - public deleteModelCard( + + /** + * @see {@link DeleteModelCardCommand} + */ + deleteModelCard( args: DeleteModelCardCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteModelCard( - args: DeleteModelCardCommandInput, - cb: (err: any, data?: DeleteModelCardCommandOutput) => void - ): void; - public deleteModelCard( + deleteModelCard(args: DeleteModelCardCommandInput, cb: (err: any, data?: DeleteModelCardCommandOutput) => void): void; + deleteModelCard( args: DeleteModelCardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteModelCardCommandOutput) => void ): void; - public deleteModelCard( - args: DeleteModelCardCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteModelCardCommandOutput) => void), - cb?: (err: any, data?: DeleteModelCardCommandOutput) => void - ): Promise | void { - const command = new DeleteModelCardCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an Amazon SageMaker model explainability job definition.

- */ - public deleteModelExplainabilityJobDefinition( + + /** + * @see {@link DeleteModelExplainabilityJobDefinitionCommand} + */ + deleteModelExplainabilityJobDefinition( args: DeleteModelExplainabilityJobDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteModelExplainabilityJobDefinition( + deleteModelExplainabilityJobDefinition( args: DeleteModelExplainabilityJobDefinitionCommandInput, cb: (err: any, data?: DeleteModelExplainabilityJobDefinitionCommandOutput) => void ): void; - public deleteModelExplainabilityJobDefinition( + deleteModelExplainabilityJobDefinition( args: DeleteModelExplainabilityJobDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteModelExplainabilityJobDefinitionCommandOutput) => void ): void; - public deleteModelExplainabilityJobDefinition( - args: DeleteModelExplainabilityJobDefinitionCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteModelExplainabilityJobDefinitionCommandOutput) => void), - cb?: (err: any, data?: DeleteModelExplainabilityJobDefinitionCommandOutput) => void - ): Promise | void { - const command = new DeleteModelExplainabilityJobDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a model package.

- *

A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can - * subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

- */ - public deleteModelPackage( + + /** + * @see {@link DeleteModelPackageCommand} + */ + deleteModelPackage( args: DeleteModelPackageCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteModelPackage( + deleteModelPackage( args: DeleteModelPackageCommandInput, cb: (err: any, data?: DeleteModelPackageCommandOutput) => void ): void; - public deleteModelPackage( + deleteModelPackage( args: DeleteModelPackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteModelPackageCommandOutput) => void ): void; - public deleteModelPackage( - args: DeleteModelPackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteModelPackageCommandOutput) => void), - cb?: (err: any, data?: DeleteModelPackageCommandOutput) => void - ): Promise | void { - const command = new DeleteModelPackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified model group.

- */ - public deleteModelPackageGroup( + + /** + * @see {@link DeleteModelPackageGroupCommand} + */ + deleteModelPackageGroup( args: DeleteModelPackageGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteModelPackageGroup( + deleteModelPackageGroup( args: DeleteModelPackageGroupCommandInput, cb: (err: any, data?: DeleteModelPackageGroupCommandOutput) => void ): void; - public deleteModelPackageGroup( + deleteModelPackageGroup( args: DeleteModelPackageGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteModelPackageGroupCommandOutput) => void ): void; - public deleteModelPackageGroup( - args: DeleteModelPackageGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteModelPackageGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteModelPackageGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteModelPackageGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a model group resource policy.

- */ - public deleteModelPackageGroupPolicy( + + /** + * @see {@link DeleteModelPackageGroupPolicyCommand} + */ + deleteModelPackageGroupPolicy( args: DeleteModelPackageGroupPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteModelPackageGroupPolicy( + deleteModelPackageGroupPolicy( args: DeleteModelPackageGroupPolicyCommandInput, cb: (err: any, data?: DeleteModelPackageGroupPolicyCommandOutput) => void ): void; - public deleteModelPackageGroupPolicy( + deleteModelPackageGroupPolicy( args: DeleteModelPackageGroupPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteModelPackageGroupPolicyCommandOutput) => void ): void; - public deleteModelPackageGroupPolicy( - args: DeleteModelPackageGroupPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteModelPackageGroupPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteModelPackageGroupPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteModelPackageGroupPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the secified model quality monitoring job definition.

- */ - public deleteModelQualityJobDefinition( + + /** + * @see {@link DeleteModelQualityJobDefinitionCommand} + */ + deleteModelQualityJobDefinition( args: DeleteModelQualityJobDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteModelQualityJobDefinition( + deleteModelQualityJobDefinition( args: DeleteModelQualityJobDefinitionCommandInput, cb: (err: any, data?: DeleteModelQualityJobDefinitionCommandOutput) => void ): void; - public deleteModelQualityJobDefinition( + deleteModelQualityJobDefinition( args: DeleteModelQualityJobDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteModelQualityJobDefinitionCommandOutput) => void ): void; - public deleteModelQualityJobDefinition( - args: DeleteModelQualityJobDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteModelQualityJobDefinitionCommandOutput) => void), - cb?: (err: any, data?: DeleteModelQualityJobDefinitionCommandOutput) => void - ): Promise | void { - const command = new DeleteModelQualityJobDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a monitoring schedule. Also stops the schedule had not already been stopped. - * This does not delete the job execution history of the monitoring schedule.

- */ - public deleteMonitoringSchedule( + + /** + * @see {@link DeleteMonitoringScheduleCommand} + */ + deleteMonitoringSchedule( args: DeleteMonitoringScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMonitoringSchedule( + deleteMonitoringSchedule( args: DeleteMonitoringScheduleCommandInput, cb: (err: any, data?: DeleteMonitoringScheduleCommandOutput) => void ): void; - public deleteMonitoringSchedule( + deleteMonitoringSchedule( args: DeleteMonitoringScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMonitoringScheduleCommandOutput) => void ): void; - public deleteMonitoringSchedule( - args: DeleteMonitoringScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMonitoringScheduleCommandOutput) => void), - cb?: (err: any, data?: DeleteMonitoringScheduleCommandOutput) => void - ): Promise | void { - const command = new DeleteMonitoringScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an SageMaker notebook instance. Before you can delete a notebook instance, you - * must call the StopNotebookInstance API.

- * - *

When you delete a notebook instance, you lose all of your data. SageMaker removes - * the ML compute instance, and deletes the ML storage volume and the network interface - * associated with the notebook instance.

- *
- */ - public deleteNotebookInstance( + + /** + * @see {@link DeleteNotebookInstanceCommand} + */ + deleteNotebookInstance( args: DeleteNotebookInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNotebookInstance( + deleteNotebookInstance( args: DeleteNotebookInstanceCommandInput, cb: (err: any, data?: DeleteNotebookInstanceCommandOutput) => void ): void; - public deleteNotebookInstance( + deleteNotebookInstance( args: DeleteNotebookInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNotebookInstanceCommandOutput) => void ): void; - public deleteNotebookInstance( - args: DeleteNotebookInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNotebookInstanceCommandOutput) => void), - cb?: (err: any, data?: DeleteNotebookInstanceCommandOutput) => void - ): Promise | void { - const command = new DeleteNotebookInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a notebook instance lifecycle configuration.

- */ - public deleteNotebookInstanceLifecycleConfig( + + /** + * @see {@link DeleteNotebookInstanceLifecycleConfigCommand} + */ + deleteNotebookInstanceLifecycleConfig( args: DeleteNotebookInstanceLifecycleConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNotebookInstanceLifecycleConfig( + deleteNotebookInstanceLifecycleConfig( args: DeleteNotebookInstanceLifecycleConfigCommandInput, cb: (err: any, data?: DeleteNotebookInstanceLifecycleConfigCommandOutput) => void ): void; - public deleteNotebookInstanceLifecycleConfig( + deleteNotebookInstanceLifecycleConfig( args: DeleteNotebookInstanceLifecycleConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNotebookInstanceLifecycleConfigCommandOutput) => void ): void; - public deleteNotebookInstanceLifecycleConfig( - args: DeleteNotebookInstanceLifecycleConfigCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteNotebookInstanceLifecycleConfigCommandOutput) => void), - cb?: (err: any, data?: DeleteNotebookInstanceLifecycleConfigCommandOutput) => void - ): Promise | void { - const command = new DeleteNotebookInstanceLifecycleConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a pipeline if there are no running instances of the pipeline. To delete a - * pipeline, you must stop all running instances of the pipeline using the - * StopPipelineExecution API. When you delete a pipeline, all instances of the - * pipeline are deleted.

- */ - public deletePipeline( + + /** + * @see {@link DeletePipelineCommand} + */ + deletePipeline( args: DeletePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePipeline( - args: DeletePipelineCommandInput, - cb: (err: any, data?: DeletePipelineCommandOutput) => void - ): void; - public deletePipeline( + deletePipeline(args: DeletePipelineCommandInput, cb: (err: any, data?: DeletePipelineCommandOutput) => void): void; + deletePipeline( args: DeletePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePipelineCommandOutput) => void ): void; - public deletePipeline( - args: DeletePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePipelineCommandOutput) => void), - cb?: (err: any, data?: DeletePipelineCommandOutput) => void - ): Promise | void { - const command = new DeletePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete the specified project.

- */ - public deleteProject( - args: DeleteProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteProject( - args: DeleteProjectCommandInput, - cb: (err: any, data?: DeleteProjectCommandOutput) => void - ): void; - public deleteProject( + + /** + * @see {@link DeleteProjectCommand} + */ + deleteProject(args: DeleteProjectCommandInput, options?: __HttpHandlerOptions): Promise; + deleteProject(args: DeleteProjectCommandInput, cb: (err: any, data?: DeleteProjectCommandOutput) => void): void; + deleteProject( args: DeleteProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProjectCommandOutput) => void ): void; - public deleteProject( - args: DeleteProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProjectCommandOutput) => void), - cb?: (err: any, data?: DeleteProjectCommandOutput) => void - ): Promise | void { - const command = new DeleteProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Used to delete a space.

- */ - public deleteSpace(args: DeleteSpaceCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteSpace(args: DeleteSpaceCommandInput, cb: (err: any, data?: DeleteSpaceCommandOutput) => void): void; - public deleteSpace( + + /** + * @see {@link DeleteSpaceCommand} + */ + deleteSpace(args: DeleteSpaceCommandInput, options?: __HttpHandlerOptions): Promise; + deleteSpace(args: DeleteSpaceCommandInput, cb: (err: any, data?: DeleteSpaceCommandOutput) => void): void; + deleteSpace( args: DeleteSpaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSpaceCommandOutput) => void ): void; - public deleteSpace( - args: DeleteSpaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSpaceCommandOutput) => void), - cb?: (err: any, data?: DeleteSpaceCommandOutput) => void - ): Promise | void { - const command = new DeleteSpaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.

- */ - public deleteStudioLifecycleConfig( + + /** + * @see {@link DeleteStudioLifecycleConfigCommand} + */ + deleteStudioLifecycleConfig( args: DeleteStudioLifecycleConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteStudioLifecycleConfig( + deleteStudioLifecycleConfig( args: DeleteStudioLifecycleConfigCommandInput, cb: (err: any, data?: DeleteStudioLifecycleConfigCommandOutput) => void ): void; - public deleteStudioLifecycleConfig( + deleteStudioLifecycleConfig( args: DeleteStudioLifecycleConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStudioLifecycleConfigCommandOutput) => void ): void; - public deleteStudioLifecycleConfig( - args: DeleteStudioLifecycleConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStudioLifecycleConfigCommandOutput) => void), - cb?: (err: any, data?: DeleteStudioLifecycleConfigCommandOutput) => void - ): Promise | void { - const command = new DeleteStudioLifecycleConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified tags from an SageMaker resource.

- *

To list a resource's tags, use the ListTags API.

- * - *

When you call this API to delete tags from a hyperparameter tuning job, the - * deleted tags are not removed from training jobs that the hyperparameter tuning job - * launched before you called this API.

- *
- * - *

When you call this API to delete tags from a SageMaker Studio Domain or User - * Profile, the deleted tags are not removed from Apps that the SageMaker Studio Domain - * or User Profile launched before you called this API.

- *
- */ - public deleteTags(args: DeleteTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteTags(args: DeleteTagsCommandInput, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void; - public deleteTags( + + /** + * @see {@link DeleteTagsCommand} + */ + deleteTags(args: DeleteTagsCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTags(args: DeleteTagsCommandInput, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void; + deleteTags( args: DeleteTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTagsCommandOutput) => void ): void; - public deleteTags( - args: DeleteTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTagsCommandOutput) => void), - cb?: (err: any, data?: DeleteTagsCommandOutput) => void - ): Promise | void { - const command = new DeleteTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified trial. All trial components that make up the trial must be deleted - * first. Use the DescribeTrialComponent API to get the list of trial - * components.

- */ - public deleteTrial(args: DeleteTrialCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteTrial(args: DeleteTrialCommandInput, cb: (err: any, data?: DeleteTrialCommandOutput) => void): void; - public deleteTrial( + + /** + * @see {@link DeleteTrialCommand} + */ + deleteTrial(args: DeleteTrialCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTrial(args: DeleteTrialCommandInput, cb: (err: any, data?: DeleteTrialCommandOutput) => void): void; + deleteTrial( args: DeleteTrialCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTrialCommandOutput) => void ): void; - public deleteTrial( - args: DeleteTrialCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTrialCommandOutput) => void), - cb?: (err: any, data?: DeleteTrialCommandOutput) => void - ): Promise | void { - const command = new DeleteTrialCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified trial component. A trial component must be disassociated from all - * trials before the trial component can be deleted. To disassociate a trial component from a - * trial, call the DisassociateTrialComponent API.

- */ - public deleteTrialComponent( + + /** + * @see {@link DeleteTrialComponentCommand} + */ + deleteTrialComponent( args: DeleteTrialComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTrialComponent( + deleteTrialComponent( args: DeleteTrialComponentCommandInput, cb: (err: any, data?: DeleteTrialComponentCommandOutput) => void ): void; - public deleteTrialComponent( + deleteTrialComponent( args: DeleteTrialComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTrialComponentCommandOutput) => void ): void; - public deleteTrialComponent( - args: DeleteTrialComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTrialComponentCommandOutput) => void), - cb?: (err: any, data?: DeleteTrialComponentCommandOutput) => void - ): Promise | void { - const command = new DeleteTrialComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a user profile. When a user profile is deleted, the user loses access to their EFS - * volume, including data, notebooks, and other artifacts.

- */ - public deleteUserProfile( + + /** + * @see {@link DeleteUserProfileCommand} + */ + deleteUserProfile( args: DeleteUserProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteUserProfile( + deleteUserProfile( args: DeleteUserProfileCommandInput, cb: (err: any, data?: DeleteUserProfileCommandOutput) => void ): void; - public deleteUserProfile( + deleteUserProfile( args: DeleteUserProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserProfileCommandOutput) => void ): void; - public deleteUserProfile( - args: DeleteUserProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteUserProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteUserProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Use this operation to delete a workforce.

- *

If you want to create a new workforce in an Amazon Web Services Region where - * a workforce already exists, use this operation to delete the - * existing workforce and then use - * to create a new workforce.

- * - *

If a private workforce contains one or more work teams, you must use - * the - * operation to delete all work teams before you delete the workforce. - * If you try to delete a workforce that contains one or more work teams, - * you will recieve a ResourceInUse error.

- *
- */ - public deleteWorkforce( + + /** + * @see {@link DeleteWorkforceCommand} + */ + deleteWorkforce( args: DeleteWorkforceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWorkforce( - args: DeleteWorkforceCommandInput, - cb: (err: any, data?: DeleteWorkforceCommandOutput) => void - ): void; - public deleteWorkforce( + deleteWorkforce(args: DeleteWorkforceCommandInput, cb: (err: any, data?: DeleteWorkforceCommandOutput) => void): void; + deleteWorkforce( args: DeleteWorkforceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkforceCommandOutput) => void ): void; - public deleteWorkforce( - args: DeleteWorkforceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorkforceCommandOutput) => void), - cb?: (err: any, data?: DeleteWorkforceCommandOutput) => void - ): Promise | void { - const command = new DeleteWorkforceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an existing work team. This operation can't be undone.

- */ - public deleteWorkteam( + + /** + * @see {@link DeleteWorkteamCommand} + */ + deleteWorkteam( args: DeleteWorkteamCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWorkteam( - args: DeleteWorkteamCommandInput, - cb: (err: any, data?: DeleteWorkteamCommandOutput) => void - ): void; - public deleteWorkteam( + deleteWorkteam(args: DeleteWorkteamCommandInput, cb: (err: any, data?: DeleteWorkteamCommandOutput) => void): void; + deleteWorkteam( args: DeleteWorkteamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkteamCommandOutput) => void ): void; - public deleteWorkteam( - args: DeleteWorkteamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorkteamCommandOutput) => void), - cb?: (err: any, data?: DeleteWorkteamCommandOutput) => void - ): Promise | void { - const command = new DeleteWorkteamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.

- */ - public deregisterDevices( + + /** + * @see {@link DeregisterDevicesCommand} + */ + deregisterDevices( args: DeregisterDevicesCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterDevices( + deregisterDevices( args: DeregisterDevicesCommandInput, cb: (err: any, data?: DeregisterDevicesCommandOutput) => void ): void; - public deregisterDevices( + deregisterDevices( args: DeregisterDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterDevicesCommandOutput) => void ): void; - public deregisterDevices( - args: DeregisterDevicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterDevicesCommandOutput) => void), - cb?: (err: any, data?: DeregisterDevicesCommandOutput) => void - ): Promise | void { - const command = new DeregisterDevicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes an action.

- */ - public describeAction( + + /** + * @see {@link DescribeActionCommand} + */ + describeAction( args: DescribeActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAction( - args: DescribeActionCommandInput, - cb: (err: any, data?: DescribeActionCommandOutput) => void - ): void; - public describeAction( + describeAction(args: DescribeActionCommandInput, cb: (err: any, data?: DescribeActionCommandOutput) => void): void; + describeAction( args: DescribeActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeActionCommandOutput) => void ): void; - public describeAction( - args: DescribeActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeActionCommandOutput) => void), - cb?: (err: any, data?: DescribeActionCommandOutput) => void - ): Promise | void { - const command = new DescribeActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a description of the specified algorithm that is in your account.

- */ - public describeAlgorithm( + + /** + * @see {@link DescribeAlgorithmCommand} + */ + describeAlgorithm( args: DescribeAlgorithmCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAlgorithm( + describeAlgorithm( args: DescribeAlgorithmCommandInput, cb: (err: any, data?: DescribeAlgorithmCommandOutput) => void ): void; - public describeAlgorithm( + describeAlgorithm( args: DescribeAlgorithmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAlgorithmCommandOutput) => void ): void; - public describeAlgorithm( - args: DescribeAlgorithmCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAlgorithmCommandOutput) => void), - cb?: (err: any, data?: DescribeAlgorithmCommandOutput) => void - ): Promise | void { - const command = new DescribeAlgorithmCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the app.

- */ - public describeApp(args: DescribeAppCommandInput, options?: __HttpHandlerOptions): Promise; - public describeApp(args: DescribeAppCommandInput, cb: (err: any, data?: DescribeAppCommandOutput) => void): void; - public describeApp( + + /** + * @see {@link DescribeAppCommand} + */ + describeApp(args: DescribeAppCommandInput, options?: __HttpHandlerOptions): Promise; + describeApp(args: DescribeAppCommandInput, cb: (err: any, data?: DescribeAppCommandOutput) => void): void; + describeApp( args: DescribeAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppCommandOutput) => void ): void; - public describeApp( - args: DescribeAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAppCommandOutput) => void), - cb?: (err: any, data?: DescribeAppCommandOutput) => void - ): Promise | void { - const command = new DescribeAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes an AppImageConfig.

- */ - public describeAppImageConfig( + + /** + * @see {@link DescribeAppImageConfigCommand} + */ + describeAppImageConfig( args: DescribeAppImageConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAppImageConfig( + describeAppImageConfig( args: DescribeAppImageConfigCommandInput, cb: (err: any, data?: DescribeAppImageConfigCommandOutput) => void ): void; - public describeAppImageConfig( + describeAppImageConfig( args: DescribeAppImageConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppImageConfigCommandOutput) => void ): void; - public describeAppImageConfig( - args: DescribeAppImageConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAppImageConfigCommandOutput) => void), - cb?: (err: any, data?: DescribeAppImageConfigCommandOutput) => void - ): Promise | void { - const command = new DescribeAppImageConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes an artifact.

- */ - public describeArtifact( + + /** + * @see {@link DescribeArtifactCommand} + */ + describeArtifact( args: DescribeArtifactCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeArtifact( + describeArtifact( args: DescribeArtifactCommandInput, cb: (err: any, data?: DescribeArtifactCommandOutput) => void ): void; - public describeArtifact( + describeArtifact( args: DescribeArtifactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeArtifactCommandOutput) => void ): void; - public describeArtifact( - args: DescribeArtifactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeArtifactCommandOutput) => void), - cb?: (err: any, data?: DescribeArtifactCommandOutput) => void - ): Promise | void { - const command = new DescribeArtifactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about an Amazon SageMaker AutoML job.

- */ - public describeAutoMLJob( + + /** + * @see {@link DescribeAutoMLJobCommand} + */ + describeAutoMLJob( args: DescribeAutoMLJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAutoMLJob( + describeAutoMLJob( args: DescribeAutoMLJobCommandInput, cb: (err: any, data?: DescribeAutoMLJobCommandOutput) => void ): void; - public describeAutoMLJob( + describeAutoMLJob( args: DescribeAutoMLJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAutoMLJobCommandOutput) => void ): void; - public describeAutoMLJob( - args: DescribeAutoMLJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAutoMLJobCommandOutput) => void), - cb?: (err: any, data?: DescribeAutoMLJobCommandOutput) => void - ): Promise | void { - const command = new DescribeAutoMLJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about an Amazon SageMaker AutoML V2 job.

- * - *

This API action is callable through SageMaker Canvas only. Calling it directly from the CLI - * or an SDK results in an error.

- *
- */ - public describeAutoMLJobV2( + + /** + * @see {@link DescribeAutoMLJobV2Command} + */ + describeAutoMLJobV2( args: DescribeAutoMLJobV2CommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAutoMLJobV2( + describeAutoMLJobV2( args: DescribeAutoMLJobV2CommandInput, cb: (err: any, data?: DescribeAutoMLJobV2CommandOutput) => void ): void; - public describeAutoMLJobV2( + describeAutoMLJobV2( args: DescribeAutoMLJobV2CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAutoMLJobV2CommandOutput) => void ): void; - public describeAutoMLJobV2( - args: DescribeAutoMLJobV2CommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAutoMLJobV2CommandOutput) => void), - cb?: (err: any, data?: DescribeAutoMLJobV2CommandOutput) => void - ): Promise | void { - const command = new DescribeAutoMLJobV2Command(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets details about the specified Git repository.

- */ - public describeCodeRepository( + + /** + * @see {@link DescribeCodeRepositoryCommand} + */ + describeCodeRepository( args: DescribeCodeRepositoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCodeRepository( + describeCodeRepository( args: DescribeCodeRepositoryCommandInput, cb: (err: any, data?: DescribeCodeRepositoryCommandOutput) => void ): void; - public describeCodeRepository( + describeCodeRepository( args: DescribeCodeRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCodeRepositoryCommandOutput) => void ): void; - public describeCodeRepository( - args: DescribeCodeRepositoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCodeRepositoryCommandOutput) => void), - cb?: (err: any, data?: DescribeCodeRepositoryCommandOutput) => void - ): Promise | void { - const command = new DescribeCodeRepositoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a model compilation job.

- *

To create a model compilation job, use CreateCompilationJob. To get - * information about multiple model compilation jobs, use ListCompilationJobs.

- */ - public describeCompilationJob( + + /** + * @see {@link DescribeCompilationJobCommand} + */ + describeCompilationJob( args: DescribeCompilationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCompilationJob( + describeCompilationJob( args: DescribeCompilationJobCommandInput, cb: (err: any, data?: DescribeCompilationJobCommandOutput) => void ): void; - public describeCompilationJob( + describeCompilationJob( args: DescribeCompilationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCompilationJobCommandOutput) => void ): void; - public describeCompilationJob( - args: DescribeCompilationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCompilationJobCommandOutput) => void), - cb?: (err: any, data?: DescribeCompilationJobCommandOutput) => void - ): Promise | void { - const command = new DescribeCompilationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a context.

- */ - public describeContext( + + /** + * @see {@link DescribeContextCommand} + */ + describeContext( args: DescribeContextCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeContext( - args: DescribeContextCommandInput, - cb: (err: any, data?: DescribeContextCommandOutput) => void - ): void; - public describeContext( + describeContext(args: DescribeContextCommandInput, cb: (err: any, data?: DescribeContextCommandOutput) => void): void; + describeContext( args: DescribeContextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeContextCommandOutput) => void ): void; - public describeContext( - args: DescribeContextCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeContextCommandOutput) => void), - cb?: (err: any, data?: DescribeContextCommandOutput) => void - ): Promise | void { - const command = new DescribeContextCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the details of a data quality monitoring job definition.

- */ - public describeDataQualityJobDefinition( + + /** + * @see {@link DescribeDataQualityJobDefinitionCommand} + */ + describeDataQualityJobDefinition( args: DescribeDataQualityJobDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDataQualityJobDefinition( + describeDataQualityJobDefinition( args: DescribeDataQualityJobDefinitionCommandInput, cb: (err: any, data?: DescribeDataQualityJobDefinitionCommandOutput) => void ): void; - public describeDataQualityJobDefinition( + describeDataQualityJobDefinition( args: DescribeDataQualityJobDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataQualityJobDefinitionCommandOutput) => void ): void; - public describeDataQualityJobDefinition( - args: DescribeDataQualityJobDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDataQualityJobDefinitionCommandOutput) => void), - cb?: (err: any, data?: DescribeDataQualityJobDefinitionCommandOutput) => void - ): Promise | void { - const command = new DescribeDataQualityJobDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the device.

- */ - public describeDevice( + + /** + * @see {@link DescribeDeviceCommand} + */ + describeDevice( args: DescribeDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDevice( - args: DescribeDeviceCommandInput, - cb: (err: any, data?: DescribeDeviceCommandOutput) => void - ): void; - public describeDevice( + describeDevice(args: DescribeDeviceCommandInput, cb: (err: any, data?: DescribeDeviceCommandOutput) => void): void; + describeDevice( args: DescribeDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDeviceCommandOutput) => void ): void; - public describeDevice( - args: DescribeDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDeviceCommandOutput) => void), - cb?: (err: any, data?: DescribeDeviceCommandOutput) => void - ): Promise | void { - const command = new DescribeDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

A description of the fleet the device belongs to.

- */ - public describeDeviceFleet( + + /** + * @see {@link DescribeDeviceFleetCommand} + */ + describeDeviceFleet( args: DescribeDeviceFleetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDeviceFleet( + describeDeviceFleet( args: DescribeDeviceFleetCommandInput, cb: (err: any, data?: DescribeDeviceFleetCommandOutput) => void ): void; - public describeDeviceFleet( + describeDeviceFleet( args: DescribeDeviceFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDeviceFleetCommandOutput) => void ): void; - public describeDeviceFleet( - args: DescribeDeviceFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDeviceFleetCommandOutput) => void), - cb?: (err: any, data?: DescribeDeviceFleetCommandOutput) => void - ): Promise | void { - const command = new DescribeDeviceFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

The description of the domain.

- */ - public describeDomain( + + /** + * @see {@link DescribeDomainCommand} + */ + describeDomain( args: DescribeDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDomain( - args: DescribeDomainCommandInput, - cb: (err: any, data?: DescribeDomainCommandOutput) => void - ): void; - public describeDomain( + describeDomain(args: DescribeDomainCommandInput, cb: (err: any, data?: DescribeDomainCommandOutput) => void): void; + describeDomain( args: DescribeDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDomainCommandOutput) => void ): void; - public describeDomain( - args: DescribeDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDomainCommandOutput) => void), - cb?: (err: any, data?: DescribeDomainCommandOutput) => void - ): Promise | void { - const command = new DescribeDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes an edge deployment plan with deployment status per stage.

- */ - public describeEdgeDeploymentPlan( + + /** + * @see {@link DescribeEdgeDeploymentPlanCommand} + */ + describeEdgeDeploymentPlan( args: DescribeEdgeDeploymentPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEdgeDeploymentPlan( + describeEdgeDeploymentPlan( args: DescribeEdgeDeploymentPlanCommandInput, cb: (err: any, data?: DescribeEdgeDeploymentPlanCommandOutput) => void ): void; - public describeEdgeDeploymentPlan( + describeEdgeDeploymentPlan( args: DescribeEdgeDeploymentPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEdgeDeploymentPlanCommandOutput) => void ): void; - public describeEdgeDeploymentPlan( - args: DescribeEdgeDeploymentPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEdgeDeploymentPlanCommandOutput) => void), - cb?: (err: any, data?: DescribeEdgeDeploymentPlanCommandOutput) => void - ): Promise | void { - const command = new DescribeEdgeDeploymentPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

A description of edge packaging jobs.

- */ - public describeEdgePackagingJob( + + /** + * @see {@link DescribeEdgePackagingJobCommand} + */ + describeEdgePackagingJob( args: DescribeEdgePackagingJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEdgePackagingJob( + describeEdgePackagingJob( args: DescribeEdgePackagingJobCommandInput, cb: (err: any, data?: DescribeEdgePackagingJobCommandOutput) => void ): void; - public describeEdgePackagingJob( + describeEdgePackagingJob( args: DescribeEdgePackagingJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEdgePackagingJobCommandOutput) => void ): void; - public describeEdgePackagingJob( - args: DescribeEdgePackagingJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEdgePackagingJobCommandOutput) => void), - cb?: (err: any, data?: DescribeEdgePackagingJobCommandOutput) => void - ): Promise | void { - const command = new DescribeEdgePackagingJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the description of an endpoint.

- */ - public describeEndpoint( + + /** + * @see {@link DescribeEndpointCommand} + */ + describeEndpoint( args: DescribeEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEndpoint( + describeEndpoint( args: DescribeEndpointCommandInput, cb: (err: any, data?: DescribeEndpointCommandOutput) => void ): void; - public describeEndpoint( + describeEndpoint( args: DescribeEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEndpointCommandOutput) => void ): void; - public describeEndpoint( - args: DescribeEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEndpointCommandOutput) => void), - cb?: (err: any, data?: DescribeEndpointCommandOutput) => void - ): Promise | void { - const command = new DescribeEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the description of an endpoint configuration created using the - * CreateEndpointConfig API.

- */ - public describeEndpointConfig( + + /** + * @see {@link DescribeEndpointConfigCommand} + */ + describeEndpointConfig( args: DescribeEndpointConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEndpointConfig( + describeEndpointConfig( args: DescribeEndpointConfigCommandInput, cb: (err: any, data?: DescribeEndpointConfigCommandOutput) => void ): void; - public describeEndpointConfig( + describeEndpointConfig( args: DescribeEndpointConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEndpointConfigCommandOutput) => void ): void; - public describeEndpointConfig( - args: DescribeEndpointConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEndpointConfigCommandOutput) => void), - cb?: (err: any, data?: DescribeEndpointConfigCommandOutput) => void - ): Promise | void { - const command = new DescribeEndpointConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides a list of an experiment's properties.

- */ - public describeExperiment( + + /** + * @see {@link DescribeExperimentCommand} + */ + describeExperiment( args: DescribeExperimentCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeExperiment( + describeExperiment( args: DescribeExperimentCommandInput, cb: (err: any, data?: DescribeExperimentCommandOutput) => void ): void; - public describeExperiment( + describeExperiment( args: DescribeExperimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExperimentCommandOutput) => void ): void; - public describeExperiment( - args: DescribeExperimentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeExperimentCommandOutput) => void), - cb?: (err: any, data?: DescribeExperimentCommandOutput) => void - ): Promise | void { - const command = new DescribeExperimentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Use this operation to describe a FeatureGroup. The response includes - * information on the creation time, FeatureGroup name, the unique identifier for - * each FeatureGroup, and more.

- */ - public describeFeatureGroup( + + /** + * @see {@link DescribeFeatureGroupCommand} + */ + describeFeatureGroup( args: DescribeFeatureGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFeatureGroup( + describeFeatureGroup( args: DescribeFeatureGroupCommandInput, cb: (err: any, data?: DescribeFeatureGroupCommandOutput) => void ): void; - public describeFeatureGroup( + describeFeatureGroup( args: DescribeFeatureGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFeatureGroupCommandOutput) => void ): void; - public describeFeatureGroup( - args: DescribeFeatureGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFeatureGroupCommandOutput) => void), - cb?: (err: any, data?: DescribeFeatureGroupCommandOutput) => void - ): Promise | void { - const command = new DescribeFeatureGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Shows the metadata for a feature within a feature group.

- */ - public describeFeatureMetadata( + + /** + * @see {@link DescribeFeatureMetadataCommand} + */ + describeFeatureMetadata( args: DescribeFeatureMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFeatureMetadata( + describeFeatureMetadata( args: DescribeFeatureMetadataCommandInput, cb: (err: any, data?: DescribeFeatureMetadataCommandOutput) => void ): void; - public describeFeatureMetadata( + describeFeatureMetadata( args: DescribeFeatureMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFeatureMetadataCommandOutput) => void ): void; - public describeFeatureMetadata( - args: DescribeFeatureMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFeatureMetadataCommandOutput) => void), - cb?: (err: any, data?: DescribeFeatureMetadataCommandOutput) => void - ): Promise | void { - const command = new DescribeFeatureMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the specified flow definition.

- */ - public describeFlowDefinition( + + /** + * @see {@link DescribeFlowDefinitionCommand} + */ + describeFlowDefinition( args: DescribeFlowDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFlowDefinition( + describeFlowDefinition( args: DescribeFlowDefinitionCommandInput, cb: (err: any, data?: DescribeFlowDefinitionCommandOutput) => void ): void; - public describeFlowDefinition( + describeFlowDefinition( args: DescribeFlowDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFlowDefinitionCommandOutput) => void ): void; - public describeFlowDefinition( - args: DescribeFlowDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFlowDefinitionCommandOutput) => void), - cb?: (err: any, data?: DescribeFlowDefinitionCommandOutput) => void - ): Promise | void { - const command = new DescribeFlowDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describe a hub.

- * - *

Hub APIs are only callable through SageMaker Studio.

- *
- */ - public describeHub(args: DescribeHubCommandInput, options?: __HttpHandlerOptions): Promise; - public describeHub(args: DescribeHubCommandInput, cb: (err: any, data?: DescribeHubCommandOutput) => void): void; - public describeHub( + + /** + * @see {@link DescribeHubCommand} + */ + describeHub(args: DescribeHubCommandInput, options?: __HttpHandlerOptions): Promise; + describeHub(args: DescribeHubCommandInput, cb: (err: any, data?: DescribeHubCommandOutput) => void): void; + describeHub( args: DescribeHubCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHubCommandOutput) => void ): void; - public describeHub( - args: DescribeHubCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeHubCommandOutput) => void), - cb?: (err: any, data?: DescribeHubCommandOutput) => void - ): Promise | void { - const command = new DescribeHubCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describe the content of a hub.

- * - *

Hub APIs are only callable through SageMaker Studio.

- *
- */ - public describeHubContent( + + /** + * @see {@link DescribeHubContentCommand} + */ + describeHubContent( args: DescribeHubContentCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeHubContent( + describeHubContent( args: DescribeHubContentCommandInput, cb: (err: any, data?: DescribeHubContentCommandOutput) => void ): void; - public describeHubContent( + describeHubContent( args: DescribeHubContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHubContentCommandOutput) => void ): void; - public describeHubContent( - args: DescribeHubContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeHubContentCommandOutput) => void), - cb?: (err: any, data?: DescribeHubContentCommandOutput) => void - ): Promise | void { - const command = new DescribeHubContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the requested human task user interface (worker task template).

- */ - public describeHumanTaskUi( + + /** + * @see {@link DescribeHumanTaskUiCommand} + */ + describeHumanTaskUi( args: DescribeHumanTaskUiCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeHumanTaskUi( + describeHumanTaskUi( args: DescribeHumanTaskUiCommandInput, cb: (err: any, data?: DescribeHumanTaskUiCommandOutput) => void ): void; - public describeHumanTaskUi( + describeHumanTaskUi( args: DescribeHumanTaskUiCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHumanTaskUiCommandOutput) => void ): void; - public describeHumanTaskUi( - args: DescribeHumanTaskUiCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeHumanTaskUiCommandOutput) => void), - cb?: (err: any, data?: DescribeHumanTaskUiCommandOutput) => void - ): Promise | void { - const command = new DescribeHumanTaskUiCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets - * a description of a hyperparameter tuning job.

- */ - public describeHyperParameterTuningJob( + + /** + * @see {@link DescribeHyperParameterTuningJobCommand} + */ + describeHyperParameterTuningJob( args: DescribeHyperParameterTuningJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeHyperParameterTuningJob( + describeHyperParameterTuningJob( args: DescribeHyperParameterTuningJobCommandInput, cb: (err: any, data?: DescribeHyperParameterTuningJobCommandOutput) => void ): void; - public describeHyperParameterTuningJob( + describeHyperParameterTuningJob( args: DescribeHyperParameterTuningJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHyperParameterTuningJobCommandOutput) => void ): void; - public describeHyperParameterTuningJob( - args: DescribeHyperParameterTuningJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeHyperParameterTuningJobCommandOutput) => void), - cb?: (err: any, data?: DescribeHyperParameterTuningJobCommandOutput) => void - ): Promise | void { - const command = new DescribeHyperParameterTuningJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a SageMaker image.

- */ - public describeImage( - args: DescribeImageCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeImage( - args: DescribeImageCommandInput, - cb: (err: any, data?: DescribeImageCommandOutput) => void - ): void; - public describeImage( + + /** + * @see {@link DescribeImageCommand} + */ + describeImage(args: DescribeImageCommandInput, options?: __HttpHandlerOptions): Promise; + describeImage(args: DescribeImageCommandInput, cb: (err: any, data?: DescribeImageCommandOutput) => void): void; + describeImage( args: DescribeImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImageCommandOutput) => void ): void; - public describeImage( - args: DescribeImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeImageCommandOutput) => void), - cb?: (err: any, data?: DescribeImageCommandOutput) => void - ): Promise | void { - const command = new DescribeImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a version of a SageMaker image.

- */ - public describeImageVersion( + + /** + * @see {@link DescribeImageVersionCommand} + */ + describeImageVersion( args: DescribeImageVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeImageVersion( + describeImageVersion( args: DescribeImageVersionCommandInput, cb: (err: any, data?: DescribeImageVersionCommandOutput) => void ): void; - public describeImageVersion( + describeImageVersion( args: DescribeImageVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImageVersionCommandOutput) => void ): void; - public describeImageVersion( - args: DescribeImageVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeImageVersionCommandOutput) => void), - cb?: (err: any, data?: DescribeImageVersionCommandOutput) => void - ): Promise | void { - const command = new DescribeImageVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns details about an inference experiment.

- */ - public describeInferenceExperiment( + + /** + * @see {@link DescribeInferenceExperimentCommand} + */ + describeInferenceExperiment( args: DescribeInferenceExperimentCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInferenceExperiment( + describeInferenceExperiment( args: DescribeInferenceExperimentCommandInput, cb: (err: any, data?: DescribeInferenceExperimentCommandOutput) => void ): void; - public describeInferenceExperiment( + describeInferenceExperiment( args: DescribeInferenceExperimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInferenceExperimentCommandOutput) => void ): void; - public describeInferenceExperiment( - args: DescribeInferenceExperimentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInferenceExperimentCommandOutput) => void), - cb?: (err: any, data?: DescribeInferenceExperimentCommandOutput) => void - ): Promise | void { - const command = new DescribeInferenceExperimentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides the results of the Inference Recommender job. - * One or more recommendation jobs are returned.

- */ - public describeInferenceRecommendationsJob( + + /** + * @see {@link DescribeInferenceRecommendationsJobCommand} + */ + describeInferenceRecommendationsJob( args: DescribeInferenceRecommendationsJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInferenceRecommendationsJob( + describeInferenceRecommendationsJob( args: DescribeInferenceRecommendationsJobCommandInput, cb: (err: any, data?: DescribeInferenceRecommendationsJobCommandOutput) => void ): void; - public describeInferenceRecommendationsJob( + describeInferenceRecommendationsJob( args: DescribeInferenceRecommendationsJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInferenceRecommendationsJobCommandOutput) => void ): void; - public describeInferenceRecommendationsJob( - args: DescribeInferenceRecommendationsJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInferenceRecommendationsJobCommandOutput) => void), - cb?: (err: any, data?: DescribeInferenceRecommendationsJobCommandOutput) => void - ): Promise | void { - const command = new DescribeInferenceRecommendationsJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a labeling job.

- */ - public describeLabelingJob( + + /** + * @see {@link DescribeLabelingJobCommand} + */ + describeLabelingJob( args: DescribeLabelingJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLabelingJob( + describeLabelingJob( args: DescribeLabelingJobCommandInput, cb: (err: any, data?: DescribeLabelingJobCommandOutput) => void ): void; - public describeLabelingJob( + describeLabelingJob( args: DescribeLabelingJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLabelingJobCommandOutput) => void ): void; - public describeLabelingJob( - args: DescribeLabelingJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLabelingJobCommandOutput) => void), - cb?: (err: any, data?: DescribeLabelingJobCommandOutput) => void - ): Promise | void { - const command = new DescribeLabelingJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides a list of properties for the requested lineage group. - * For more information, see - * Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.

- */ - public describeLineageGroup( + + /** + * @see {@link DescribeLineageGroupCommand} + */ + describeLineageGroup( args: DescribeLineageGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLineageGroup( + describeLineageGroup( args: DescribeLineageGroupCommandInput, cb: (err: any, data?: DescribeLineageGroupCommandOutput) => void ): void; - public describeLineageGroup( + describeLineageGroup( args: DescribeLineageGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLineageGroupCommandOutput) => void ): void; - public describeLineageGroup( - args: DescribeLineageGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLineageGroupCommandOutput) => void), - cb?: (err: any, data?: DescribeLineageGroupCommandOutput) => void - ): Promise | void { - const command = new DescribeLineageGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a model that you created using the CreateModel - * API.

- */ - public describeModel( - args: DescribeModelCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeModel( - args: DescribeModelCommandInput, - cb: (err: any, data?: DescribeModelCommandOutput) => void - ): void; - public describeModel( + + /** + * @see {@link DescribeModelCommand} + */ + describeModel(args: DescribeModelCommandInput, options?: __HttpHandlerOptions): Promise; + describeModel(args: DescribeModelCommandInput, cb: (err: any, data?: DescribeModelCommandOutput) => void): void; + describeModel( args: DescribeModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeModelCommandOutput) => void ): void; - public describeModel( - args: DescribeModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeModelCommandOutput) => void), - cb?: (err: any, data?: DescribeModelCommandOutput) => void - ): Promise | void { - const command = new DescribeModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a description of a model bias job definition.

- */ - public describeModelBiasJobDefinition( + + /** + * @see {@link DescribeModelBiasJobDefinitionCommand} + */ + describeModelBiasJobDefinition( args: DescribeModelBiasJobDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeModelBiasJobDefinition( + describeModelBiasJobDefinition( args: DescribeModelBiasJobDefinitionCommandInput, cb: (err: any, data?: DescribeModelBiasJobDefinitionCommandOutput) => void ): void; - public describeModelBiasJobDefinition( + describeModelBiasJobDefinition( args: DescribeModelBiasJobDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeModelBiasJobDefinitionCommandOutput) => void ): void; - public describeModelBiasJobDefinition( - args: DescribeModelBiasJobDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeModelBiasJobDefinitionCommandOutput) => void), - cb?: (err: any, data?: DescribeModelBiasJobDefinitionCommandOutput) => void - ): Promise | void { - const command = new DescribeModelBiasJobDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.

- */ - public describeModelCard( + + /** + * @see {@link DescribeModelCardCommand} + */ + describeModelCard( args: DescribeModelCardCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeModelCard( + describeModelCard( args: DescribeModelCardCommandInput, cb: (err: any, data?: DescribeModelCardCommandOutput) => void ): void; - public describeModelCard( + describeModelCard( args: DescribeModelCardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeModelCardCommandOutput) => void ): void; - public describeModelCard( - args: DescribeModelCardCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeModelCardCommandOutput) => void), - cb?: (err: any, data?: DescribeModelCardCommandOutput) => void - ): Promise | void { - const command = new DescribeModelCardCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes an Amazon SageMaker Model Card export job.

- */ - public describeModelCardExportJob( + + /** + * @see {@link DescribeModelCardExportJobCommand} + */ + describeModelCardExportJob( args: DescribeModelCardExportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeModelCardExportJob( + describeModelCardExportJob( args: DescribeModelCardExportJobCommandInput, cb: (err: any, data?: DescribeModelCardExportJobCommandOutput) => void ): void; - public describeModelCardExportJob( + describeModelCardExportJob( args: DescribeModelCardExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeModelCardExportJobCommandOutput) => void ): void; - public describeModelCardExportJob( - args: DescribeModelCardExportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeModelCardExportJobCommandOutput) => void), - cb?: (err: any, data?: DescribeModelCardExportJobCommandOutput) => void - ): Promise | void { - const command = new DescribeModelCardExportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a description of a model explainability job definition.

- */ - public describeModelExplainabilityJobDefinition( + + /** + * @see {@link DescribeModelExplainabilityJobDefinitionCommand} + */ + describeModelExplainabilityJobDefinition( args: DescribeModelExplainabilityJobDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeModelExplainabilityJobDefinition( + describeModelExplainabilityJobDefinition( args: DescribeModelExplainabilityJobDefinitionCommandInput, cb: (err: any, data?: DescribeModelExplainabilityJobDefinitionCommandOutput) => void ): void; - public describeModelExplainabilityJobDefinition( + describeModelExplainabilityJobDefinition( args: DescribeModelExplainabilityJobDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeModelExplainabilityJobDefinitionCommandOutput) => void ): void; - public describeModelExplainabilityJobDefinition( - args: DescribeModelExplainabilityJobDefinitionCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeModelExplainabilityJobDefinitionCommandOutput) => void), - cb?: (err: any, data?: DescribeModelExplainabilityJobDefinitionCommandOutput) => void - ): Promise | void { - const command = new DescribeModelExplainabilityJobDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a description of the specified model package, which is used to create SageMaker - * models or list them on Amazon Web Services Marketplace.

- *

To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services - * Marketplace.

- */ - public describeModelPackage( + + /** + * @see {@link DescribeModelPackageCommand} + */ + describeModelPackage( args: DescribeModelPackageCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeModelPackage( + describeModelPackage( args: DescribeModelPackageCommandInput, cb: (err: any, data?: DescribeModelPackageCommandOutput) => void ): void; - public describeModelPackage( + describeModelPackage( args: DescribeModelPackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeModelPackageCommandOutput) => void ): void; - public describeModelPackage( - args: DescribeModelPackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeModelPackageCommandOutput) => void), - cb?: (err: any, data?: DescribeModelPackageCommandOutput) => void - ): Promise | void { - const command = new DescribeModelPackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a description for the specified model group.

- */ - public describeModelPackageGroup( + + /** + * @see {@link DescribeModelPackageGroupCommand} + */ + describeModelPackageGroup( args: DescribeModelPackageGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeModelPackageGroup( + describeModelPackageGroup( args: DescribeModelPackageGroupCommandInput, cb: (err: any, data?: DescribeModelPackageGroupCommandOutput) => void ): void; - public describeModelPackageGroup( + describeModelPackageGroup( args: DescribeModelPackageGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeModelPackageGroupCommandOutput) => void ): void; - public describeModelPackageGroup( - args: DescribeModelPackageGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeModelPackageGroupCommandOutput) => void), - cb?: (err: any, data?: DescribeModelPackageGroupCommandOutput) => void - ): Promise | void { - const command = new DescribeModelPackageGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a description of a model quality job definition.

- */ - public describeModelQualityJobDefinition( + + /** + * @see {@link DescribeModelQualityJobDefinitionCommand} + */ + describeModelQualityJobDefinition( args: DescribeModelQualityJobDefinitionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeModelQualityJobDefinition( + describeModelQualityJobDefinition( args: DescribeModelQualityJobDefinitionCommandInput, cb: (err: any, data?: DescribeModelQualityJobDefinitionCommandOutput) => void ): void; - public describeModelQualityJobDefinition( + describeModelQualityJobDefinition( args: DescribeModelQualityJobDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeModelQualityJobDefinitionCommandOutput) => void ): void; - public describeModelQualityJobDefinition( - args: DescribeModelQualityJobDefinitionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeModelQualityJobDefinitionCommandOutput) => void), - cb?: (err: any, data?: DescribeModelQualityJobDefinitionCommandOutput) => void - ): Promise | void { - const command = new DescribeModelQualityJobDefinitionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the schedule for a monitoring job.

- */ - public describeMonitoringSchedule( + + /** + * @see {@link DescribeMonitoringScheduleCommand} + */ + describeMonitoringSchedule( args: DescribeMonitoringScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMonitoringSchedule( + describeMonitoringSchedule( args: DescribeMonitoringScheduleCommandInput, cb: (err: any, data?: DescribeMonitoringScheduleCommandOutput) => void ): void; - public describeMonitoringSchedule( + describeMonitoringSchedule( args: DescribeMonitoringScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMonitoringScheduleCommandOutput) => void ): void; - public describeMonitoringSchedule( - args: DescribeMonitoringScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMonitoringScheduleCommandOutput) => void), - cb?: (err: any, data?: DescribeMonitoringScheduleCommandOutput) => void - ): Promise | void { - const command = new DescribeMonitoringScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a notebook instance.

- */ - public describeNotebookInstance( + + /** + * @see {@link DescribeNotebookInstanceCommand} + */ + describeNotebookInstance( args: DescribeNotebookInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNotebookInstance( + describeNotebookInstance( args: DescribeNotebookInstanceCommandInput, cb: (err: any, data?: DescribeNotebookInstanceCommandOutput) => void ): void; - public describeNotebookInstance( + describeNotebookInstance( args: DescribeNotebookInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNotebookInstanceCommandOutput) => void ): void; - public describeNotebookInstance( - args: DescribeNotebookInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeNotebookInstanceCommandOutput) => void), - cb?: (err: any, data?: DescribeNotebookInstanceCommandOutput) => void - ): Promise | void { - const command = new DescribeNotebookInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a description of a notebook instance lifecycle configuration.

- *

For information about notebook instance lifestyle configurations, see Step - * 2.1: (Optional) Customize a Notebook Instance.

- */ - public describeNotebookInstanceLifecycleConfig( + + /** + * @see {@link DescribeNotebookInstanceLifecycleConfigCommand} + */ + describeNotebookInstanceLifecycleConfig( args: DescribeNotebookInstanceLifecycleConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNotebookInstanceLifecycleConfig( + describeNotebookInstanceLifecycleConfig( args: DescribeNotebookInstanceLifecycleConfigCommandInput, cb: (err: any, data?: DescribeNotebookInstanceLifecycleConfigCommandOutput) => void ): void; - public describeNotebookInstanceLifecycleConfig( + describeNotebookInstanceLifecycleConfig( args: DescribeNotebookInstanceLifecycleConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNotebookInstanceLifecycleConfigCommandOutput) => void ): void; - public describeNotebookInstanceLifecycleConfig( - args: DescribeNotebookInstanceLifecycleConfigCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeNotebookInstanceLifecycleConfigCommandOutput) => void), - cb?: (err: any, data?: DescribeNotebookInstanceLifecycleConfigCommandOutput) => void - ): Promise | void { - const command = new DescribeNotebookInstanceLifecycleConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the details of a pipeline.

- */ - public describePipeline( + + /** + * @see {@link DescribePipelineCommand} + */ + describePipeline( args: DescribePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePipeline( + describePipeline( args: DescribePipelineCommandInput, cb: (err: any, data?: DescribePipelineCommandOutput) => void ): void; - public describePipeline( + describePipeline( args: DescribePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePipelineCommandOutput) => void ): void; - public describePipeline( - args: DescribePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePipelineCommandOutput) => void), - cb?: (err: any, data?: DescribePipelineCommandOutput) => void - ): Promise | void { - const command = new DescribePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the details of an execution's pipeline definition.

- */ - public describePipelineDefinitionForExecution( + + /** + * @see {@link DescribePipelineDefinitionForExecutionCommand} + */ + describePipelineDefinitionForExecution( args: DescribePipelineDefinitionForExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePipelineDefinitionForExecution( + describePipelineDefinitionForExecution( args: DescribePipelineDefinitionForExecutionCommandInput, cb: (err: any, data?: DescribePipelineDefinitionForExecutionCommandOutput) => void ): void; - public describePipelineDefinitionForExecution( + describePipelineDefinitionForExecution( args: DescribePipelineDefinitionForExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePipelineDefinitionForExecutionCommandOutput) => void ): void; - public describePipelineDefinitionForExecution( - args: DescribePipelineDefinitionForExecutionCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribePipelineDefinitionForExecutionCommandOutput) => void), - cb?: (err: any, data?: DescribePipelineDefinitionForExecutionCommandOutput) => void - ): Promise | void { - const command = new DescribePipelineDefinitionForExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the details of a pipeline execution.

- */ - public describePipelineExecution( + + /** + * @see {@link DescribePipelineExecutionCommand} + */ + describePipelineExecution( args: DescribePipelineExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePipelineExecution( + describePipelineExecution( args: DescribePipelineExecutionCommandInput, cb: (err: any, data?: DescribePipelineExecutionCommandOutput) => void ): void; - public describePipelineExecution( + describePipelineExecution( args: DescribePipelineExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePipelineExecutionCommandOutput) => void ): void; - public describePipelineExecution( - args: DescribePipelineExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePipelineExecutionCommandOutput) => void), - cb?: (err: any, data?: DescribePipelineExecutionCommandOutput) => void - ): Promise | void { - const command = new DescribePipelineExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a description of a processing job.

- */ - public describeProcessingJob( + + /** + * @see {@link DescribeProcessingJobCommand} + */ + describeProcessingJob( args: DescribeProcessingJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProcessingJob( + describeProcessingJob( args: DescribeProcessingJobCommandInput, cb: (err: any, data?: DescribeProcessingJobCommandOutput) => void ): void; - public describeProcessingJob( + describeProcessingJob( args: DescribeProcessingJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProcessingJobCommandOutput) => void ): void; - public describeProcessingJob( - args: DescribeProcessingJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProcessingJobCommandOutput) => void), - cb?: (err: any, data?: DescribeProcessingJobCommandOutput) => void - ): Promise | void { - const command = new DescribeProcessingJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the details of a project.

- */ - public describeProject( + + /** + * @see {@link DescribeProjectCommand} + */ + describeProject( args: DescribeProjectCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProject( - args: DescribeProjectCommandInput, - cb: (err: any, data?: DescribeProjectCommandOutput) => void - ): void; - public describeProject( + describeProject(args: DescribeProjectCommandInput, cb: (err: any, data?: DescribeProjectCommandOutput) => void): void; + describeProject( args: DescribeProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProjectCommandOutput) => void ): void; - public describeProject( - args: DescribeProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProjectCommandOutput) => void), - cb?: (err: any, data?: DescribeProjectCommandOutput) => void - ): Promise | void { - const command = new DescribeProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the space.

- */ - public describeSpace( - args: DescribeSpaceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeSpace( - args: DescribeSpaceCommandInput, - cb: (err: any, data?: DescribeSpaceCommandOutput) => void - ): void; - public describeSpace( + + /** + * @see {@link DescribeSpaceCommand} + */ + describeSpace(args: DescribeSpaceCommandInput, options?: __HttpHandlerOptions): Promise; + describeSpace(args: DescribeSpaceCommandInput, cb: (err: any, data?: DescribeSpaceCommandOutput) => void): void; + describeSpace( args: DescribeSpaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSpaceCommandOutput) => void ): void; - public describeSpace( - args: DescribeSpaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSpaceCommandOutput) => void), - cb?: (err: any, data?: DescribeSpaceCommandOutput) => void - ): Promise | void { - const command = new DescribeSpaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the Studio Lifecycle Configuration.

- */ - public describeStudioLifecycleConfig( + + /** + * @see {@link DescribeStudioLifecycleConfigCommand} + */ + describeStudioLifecycleConfig( args: DescribeStudioLifecycleConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStudioLifecycleConfig( + describeStudioLifecycleConfig( args: DescribeStudioLifecycleConfigCommandInput, cb: (err: any, data?: DescribeStudioLifecycleConfigCommandOutput) => void ): void; - public describeStudioLifecycleConfig( + describeStudioLifecycleConfig( args: DescribeStudioLifecycleConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStudioLifecycleConfigCommandOutput) => void ): void; - public describeStudioLifecycleConfig( - args: DescribeStudioLifecycleConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStudioLifecycleConfigCommandOutput) => void), - cb?: (err: any, data?: DescribeStudioLifecycleConfigCommandOutput) => void - ): Promise | void { - const command = new DescribeStudioLifecycleConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a work team provided by a vendor. It returns details about the - * subscription with a vendor in the Amazon Web Services Marketplace.

- */ - public describeSubscribedWorkteam( + + /** + * @see {@link DescribeSubscribedWorkteamCommand} + */ + describeSubscribedWorkteam( args: DescribeSubscribedWorkteamCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSubscribedWorkteam( + describeSubscribedWorkteam( args: DescribeSubscribedWorkteamCommandInput, cb: (err: any, data?: DescribeSubscribedWorkteamCommandOutput) => void ): void; - public describeSubscribedWorkteam( + describeSubscribedWorkteam( args: DescribeSubscribedWorkteamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSubscribedWorkteamCommandOutput) => void ): void; - public describeSubscribedWorkteam( - args: DescribeSubscribedWorkteamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSubscribedWorkteamCommandOutput) => void), - cb?: (err: any, data?: DescribeSubscribedWorkteamCommandOutput) => void - ): Promise | void { - const command = new DescribeSubscribedWorkteamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a training job.

- *

Some of the attributes below only appear if the training job successfully starts. - * If the training job fails, TrainingJobStatus is Failed and, - * depending on the FailureReason, attributes like - * TrainingStartTime, TrainingTimeInSeconds, - * TrainingEndTime, and BillableTimeInSeconds may not be - * present in the response.

- */ - public describeTrainingJob( + + /** + * @see {@link DescribeTrainingJobCommand} + */ + describeTrainingJob( args: DescribeTrainingJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTrainingJob( + describeTrainingJob( args: DescribeTrainingJobCommandInput, cb: (err: any, data?: DescribeTrainingJobCommandOutput) => void ): void; - public describeTrainingJob( + describeTrainingJob( args: DescribeTrainingJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrainingJobCommandOutput) => void ): void; - public describeTrainingJob( - args: DescribeTrainingJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTrainingJobCommandOutput) => void), - cb?: (err: any, data?: DescribeTrainingJobCommandOutput) => void - ): Promise | void { - const command = new DescribeTrainingJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about a transform job.

- */ - public describeTransformJob( + + /** + * @see {@link DescribeTransformJobCommand} + */ + describeTransformJob( args: DescribeTransformJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTransformJob( + describeTransformJob( args: DescribeTransformJobCommandInput, cb: (err: any, data?: DescribeTransformJobCommandOutput) => void ): void; - public describeTransformJob( + describeTransformJob( args: DescribeTransformJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTransformJobCommandOutput) => void ): void; - public describeTransformJob( - args: DescribeTransformJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTransformJobCommandOutput) => void), - cb?: (err: any, data?: DescribeTransformJobCommandOutput) => void - ): Promise | void { - const command = new DescribeTransformJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides a list of a trial's properties.

- */ - public describeTrial( - args: DescribeTrialCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeTrial( - args: DescribeTrialCommandInput, - cb: (err: any, data?: DescribeTrialCommandOutput) => void - ): void; - public describeTrial( + + /** + * @see {@link DescribeTrialCommand} + */ + describeTrial(args: DescribeTrialCommandInput, options?: __HttpHandlerOptions): Promise; + describeTrial(args: DescribeTrialCommandInput, cb: (err: any, data?: DescribeTrialCommandOutput) => void): void; + describeTrial( args: DescribeTrialCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrialCommandOutput) => void ): void; - public describeTrial( - args: DescribeTrialCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTrialCommandOutput) => void), - cb?: (err: any, data?: DescribeTrialCommandOutput) => void - ): Promise | void { - const command = new DescribeTrialCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides a list of a trials component's properties.

- */ - public describeTrialComponent( + + /** + * @see {@link DescribeTrialComponentCommand} + */ + describeTrialComponent( args: DescribeTrialComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTrialComponent( + describeTrialComponent( args: DescribeTrialComponentCommandInput, cb: (err: any, data?: DescribeTrialComponentCommandOutput) => void ): void; - public describeTrialComponent( + describeTrialComponent( args: DescribeTrialComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrialComponentCommandOutput) => void ): void; - public describeTrialComponent( - args: DescribeTrialComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTrialComponentCommandOutput) => void), - cb?: (err: any, data?: DescribeTrialComponentCommandOutput) => void - ): Promise | void { - const command = new DescribeTrialComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a user profile. For more information, see CreateUserProfile.

- */ - public describeUserProfile( + + /** + * @see {@link DescribeUserProfileCommand} + */ + describeUserProfile( args: DescribeUserProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeUserProfile( + describeUserProfile( args: DescribeUserProfileCommandInput, cb: (err: any, data?: DescribeUserProfileCommandOutput) => void ): void; - public describeUserProfile( + describeUserProfile( args: DescribeUserProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserProfileCommandOutput) => void ): void; - public describeUserProfile( - args: DescribeUserProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUserProfileCommandOutput) => void), - cb?: (err: any, data?: DescribeUserProfileCommandOutput) => void - ): Promise | void { - const command = new DescribeUserProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists private workforce information, including workforce name, Amazon Resource Name - * (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address - * ranges are the IP addresses that workers can use to access tasks.

- * - *

This operation applies only to private workforces.

- *
- */ - public describeWorkforce( + + /** + * @see {@link DescribeWorkforceCommand} + */ + describeWorkforce( args: DescribeWorkforceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWorkforce( + describeWorkforce( args: DescribeWorkforceCommandInput, cb: (err: any, data?: DescribeWorkforceCommandOutput) => void ): void; - public describeWorkforce( + describeWorkforce( args: DescribeWorkforceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkforceCommandOutput) => void ): void; - public describeWorkforce( - args: DescribeWorkforceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWorkforceCommandOutput) => void), - cb?: (err: any, data?: DescribeWorkforceCommandOutput) => void - ): Promise | void { - const command = new DescribeWorkforceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about a specific work team. You can see information such as the - * create date, the last updated date, membership information, and the work team's Amazon - * Resource Name (ARN).

- */ - public describeWorkteam( + + /** + * @see {@link DescribeWorkteamCommand} + */ + describeWorkteam( args: DescribeWorkteamCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWorkteam( + describeWorkteam( args: DescribeWorkteamCommandInput, cb: (err: any, data?: DescribeWorkteamCommandOutput) => void ): void; - public describeWorkteam( + describeWorkteam( args: DescribeWorkteamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkteamCommandOutput) => void ): void; - public describeWorkteam( - args: DescribeWorkteamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWorkteamCommandOutput) => void), - cb?: (err: any, data?: DescribeWorkteamCommandOutput) => void - ): Promise | void { - const command = new DescribeWorkteamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables using Service Catalog in SageMaker. Service Catalog is used to create - * SageMaker projects.

- */ - public disableSagemakerServicecatalogPortfolio( + + /** + * @see {@link DisableSagemakerServicecatalogPortfolioCommand} + */ + disableSagemakerServicecatalogPortfolio( args: DisableSagemakerServicecatalogPortfolioCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableSagemakerServicecatalogPortfolio( + disableSagemakerServicecatalogPortfolio( args: DisableSagemakerServicecatalogPortfolioCommandInput, cb: (err: any, data?: DisableSagemakerServicecatalogPortfolioCommandOutput) => void ): void; - public disableSagemakerServicecatalogPortfolio( + disableSagemakerServicecatalogPortfolio( args: DisableSagemakerServicecatalogPortfolioCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableSagemakerServicecatalogPortfolioCommandOutput) => void ): void; - public disableSagemakerServicecatalogPortfolio( - args: DisableSagemakerServicecatalogPortfolioCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisableSagemakerServicecatalogPortfolioCommandOutput) => void), - cb?: (err: any, data?: DisableSagemakerServicecatalogPortfolioCommandOutput) => void - ): Promise | void { - const command = new DisableSagemakerServicecatalogPortfolioCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a trial component from a trial. This doesn't effect other trials the - * component is associated with. Before you can delete a component, you must disassociate the - * component from all trials it is associated with. To associate a trial component with a trial, - * call the AssociateTrialComponent API.

- *

To get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter. - * The list appears in the response under Results.TrialComponent.Parents.

- */ - public disassociateTrialComponent( + + /** + * @see {@link DisassociateTrialComponentCommand} + */ + disassociateTrialComponent( args: DisassociateTrialComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateTrialComponent( + disassociateTrialComponent( args: DisassociateTrialComponentCommandInput, cb: (err: any, data?: DisassociateTrialComponentCommandOutput) => void ): void; - public disassociateTrialComponent( + disassociateTrialComponent( args: DisassociateTrialComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateTrialComponentCommandOutput) => void ): void; - public disassociateTrialComponent( - args: DisassociateTrialComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateTrialComponentCommandOutput) => void), - cb?: (err: any, data?: DisassociateTrialComponentCommandOutput) => void - ): Promise | void { - const command = new DisassociateTrialComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables using Service Catalog in SageMaker. Service Catalog is used to create - * SageMaker projects.

- */ - public enableSagemakerServicecatalogPortfolio( + + /** + * @see {@link EnableSagemakerServicecatalogPortfolioCommand} + */ + enableSagemakerServicecatalogPortfolio( args: EnableSagemakerServicecatalogPortfolioCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableSagemakerServicecatalogPortfolio( + enableSagemakerServicecatalogPortfolio( args: EnableSagemakerServicecatalogPortfolioCommandInput, cb: (err: any, data?: EnableSagemakerServicecatalogPortfolioCommandOutput) => void ): void; - public enableSagemakerServicecatalogPortfolio( + enableSagemakerServicecatalogPortfolio( args: EnableSagemakerServicecatalogPortfolioCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableSagemakerServicecatalogPortfolioCommandOutput) => void ): void; - public enableSagemakerServicecatalogPortfolio( - args: EnableSagemakerServicecatalogPortfolioCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: EnableSagemakerServicecatalogPortfolioCommandOutput) => void), - cb?: (err: any, data?: EnableSagemakerServicecatalogPortfolioCommandOutput) => void - ): Promise | void { - const command = new EnableSagemakerServicecatalogPortfolioCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a fleet.

- */ - public getDeviceFleetReport( + + /** + * @see {@link GetDeviceFleetReportCommand} + */ + getDeviceFleetReport( args: GetDeviceFleetReportCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDeviceFleetReport( + getDeviceFleetReport( args: GetDeviceFleetReportCommandInput, cb: (err: any, data?: GetDeviceFleetReportCommandOutput) => void ): void; - public getDeviceFleetReport( + getDeviceFleetReport( args: GetDeviceFleetReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeviceFleetReportCommandOutput) => void ): void; - public getDeviceFleetReport( - args: GetDeviceFleetReportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeviceFleetReportCommandOutput) => void), - cb?: (err: any, data?: GetDeviceFleetReportCommandOutput) => void - ): Promise | void { - const command = new GetDeviceFleetReportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

The resource policy for the lineage group.

- */ - public getLineageGroupPolicy( + + /** + * @see {@link GetLineageGroupPolicyCommand} + */ + getLineageGroupPolicy( args: GetLineageGroupPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLineageGroupPolicy( + getLineageGroupPolicy( args: GetLineageGroupPolicyCommandInput, cb: (err: any, data?: GetLineageGroupPolicyCommandOutput) => void ): void; - public getLineageGroupPolicy( + getLineageGroupPolicy( args: GetLineageGroupPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLineageGroupPolicyCommandOutput) => void ): void; - public getLineageGroupPolicy( - args: GetLineageGroupPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLineageGroupPolicyCommandOutput) => void), - cb?: (err: any, data?: GetLineageGroupPolicyCommandOutput) => void - ): Promise | void { - const command = new GetLineageGroupPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a resource policy that manages access for a model group. For information about - * resource policies, see Identity-based - * policies and resource-based policies in the Amazon Web Services Identity and - * Access Management User Guide..

- */ - public getModelPackageGroupPolicy( + + /** + * @see {@link GetModelPackageGroupPolicyCommand} + */ + getModelPackageGroupPolicy( args: GetModelPackageGroupPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getModelPackageGroupPolicy( + getModelPackageGroupPolicy( args: GetModelPackageGroupPolicyCommandInput, cb: (err: any, data?: GetModelPackageGroupPolicyCommandOutput) => void ): void; - public getModelPackageGroupPolicy( + getModelPackageGroupPolicy( args: GetModelPackageGroupPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetModelPackageGroupPolicyCommandOutput) => void ): void; - public getModelPackageGroupPolicy( - args: GetModelPackageGroupPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetModelPackageGroupPolicyCommandOutput) => void), - cb?: (err: any, data?: GetModelPackageGroupPolicyCommandOutput) => void - ): Promise | void { - const command = new GetModelPackageGroupPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the status of Service Catalog in SageMaker. Service Catalog is used to create - * SageMaker projects.

- */ - public getSagemakerServicecatalogPortfolioStatus( + + /** + * @see {@link GetSagemakerServicecatalogPortfolioStatusCommand} + */ + getSagemakerServicecatalogPortfolioStatus( args: GetSagemakerServicecatalogPortfolioStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSagemakerServicecatalogPortfolioStatus( + getSagemakerServicecatalogPortfolioStatus( args: GetSagemakerServicecatalogPortfolioStatusCommandInput, cb: (err: any, data?: GetSagemakerServicecatalogPortfolioStatusCommandOutput) => void ): void; - public getSagemakerServicecatalogPortfolioStatus( + getSagemakerServicecatalogPortfolioStatus( args: GetSagemakerServicecatalogPortfolioStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSagemakerServicecatalogPortfolioStatusCommandOutput) => void ): void; - public getSagemakerServicecatalogPortfolioStatus( - args: GetSagemakerServicecatalogPortfolioStatusCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetSagemakerServicecatalogPortfolioStatusCommandOutput) => void), - cb?: (err: any, data?: GetSagemakerServicecatalogPortfolioStatusCommandOutput) => void - ): Promise | void { - const command = new GetSagemakerServicecatalogPortfolioStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

An auto-complete API for the search functionality in the SageMaker console. It returns - * suggestions of possible matches for the property name to use in Search - * queries. Provides suggestions for HyperParameters, Tags, and - * Metrics.

- */ - public getSearchSuggestions( + + /** + * @see {@link GetSearchSuggestionsCommand} + */ + getSearchSuggestions( args: GetSearchSuggestionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSearchSuggestions( + getSearchSuggestions( args: GetSearchSuggestionsCommandInput, cb: (err: any, data?: GetSearchSuggestionsCommandOutput) => void ): void; - public getSearchSuggestions( + getSearchSuggestions( args: GetSearchSuggestionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSearchSuggestionsCommandOutput) => void ): void; - public getSearchSuggestions( - args: GetSearchSuggestionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSearchSuggestionsCommandOutput) => void), - cb?: (err: any, data?: GetSearchSuggestionsCommandOutput) => void - ): Promise | void { - const command = new GetSearchSuggestionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Import hub content.

- * - *

Hub APIs are only callable through SageMaker Studio.

- *
- */ - public importHubContent( + + /** + * @see {@link ImportHubContentCommand} + */ + importHubContent( args: ImportHubContentCommandInput, options?: __HttpHandlerOptions ): Promise; - public importHubContent( + importHubContent( args: ImportHubContentCommandInput, cb: (err: any, data?: ImportHubContentCommandOutput) => void ): void; - public importHubContent( + importHubContent( args: ImportHubContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportHubContentCommandOutput) => void ): void; - public importHubContent( - args: ImportHubContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportHubContentCommandOutput) => void), - cb?: (err: any, data?: ImportHubContentCommandOutput) => void - ): Promise | void { - const command = new ImportHubContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the actions in your account and their properties.

- */ - public listActions(args: ListActionsCommandInput, options?: __HttpHandlerOptions): Promise; - public listActions(args: ListActionsCommandInput, cb: (err: any, data?: ListActionsCommandOutput) => void): void; - public listActions( + + /** + * @see {@link ListActionsCommand} + */ + listActions(args: ListActionsCommandInput, options?: __HttpHandlerOptions): Promise; + listActions(args: ListActionsCommandInput, cb: (err: any, data?: ListActionsCommandOutput) => void): void; + listActions( args: ListActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListActionsCommandOutput) => void ): void; - public listActions( - args: ListActionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListActionsCommandOutput) => void), - cb?: (err: any, data?: ListActionsCommandOutput) => void - ): Promise | void { - const command = new ListActionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the machine learning algorithms that have been created.

- */ - public listAlgorithms( + + /** + * @see {@link ListAlgorithmsCommand} + */ + listAlgorithms( args: ListAlgorithmsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAlgorithms( - args: ListAlgorithmsCommandInput, - cb: (err: any, data?: ListAlgorithmsCommandOutput) => void - ): void; - public listAlgorithms( + listAlgorithms(args: ListAlgorithmsCommandInput, cb: (err: any, data?: ListAlgorithmsCommandOutput) => void): void; + listAlgorithms( args: ListAlgorithmsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAlgorithmsCommandOutput) => void ): void; - public listAlgorithms( - args: ListAlgorithmsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAlgorithmsCommandOutput) => void), - cb?: (err: any, data?: ListAlgorithmsCommandOutput) => void - ): Promise | void { - const command = new ListAlgorithmsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the aliases of a specified image or image version.

- */ - public listAliases(args: ListAliasesCommandInput, options?: __HttpHandlerOptions): Promise; - public listAliases(args: ListAliasesCommandInput, cb: (err: any, data?: ListAliasesCommandOutput) => void): void; - public listAliases( + + /** + * @see {@link ListAliasesCommand} + */ + listAliases(args: ListAliasesCommandInput, options?: __HttpHandlerOptions): Promise; + listAliases(args: ListAliasesCommandInput, cb: (err: any, data?: ListAliasesCommandOutput) => void): void; + listAliases( args: ListAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAliasesCommandOutput) => void ): void; - public listAliases( - args: ListAliasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAliasesCommandOutput) => void), - cb?: (err: any, data?: ListAliasesCommandOutput) => void - ): Promise | void { - const command = new ListAliasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the AppImageConfigs in your account and their properties. The list can be - * filtered by creation time or modified time, and whether the AppImageConfig name contains - * a specified string.

- */ - public listAppImageConfigs( + + /** + * @see {@link ListAppImageConfigsCommand} + */ + listAppImageConfigs( args: ListAppImageConfigsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAppImageConfigs( + listAppImageConfigs( args: ListAppImageConfigsCommandInput, cb: (err: any, data?: ListAppImageConfigsCommandOutput) => void ): void; - public listAppImageConfigs( + listAppImageConfigs( args: ListAppImageConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppImageConfigsCommandOutput) => void ): void; - public listAppImageConfigs( - args: ListAppImageConfigsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppImageConfigsCommandOutput) => void), - cb?: (err: any, data?: ListAppImageConfigsCommandOutput) => void - ): Promise | void { - const command = new ListAppImageConfigsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists apps.

- */ - public listApps(args: ListAppsCommandInput, options?: __HttpHandlerOptions): Promise; - public listApps(args: ListAppsCommandInput, cb: (err: any, data?: ListAppsCommandOutput) => void): void; - public listApps( + + /** + * @see {@link ListAppsCommand} + */ + listApps(args: ListAppsCommandInput, options?: __HttpHandlerOptions): Promise; + listApps(args: ListAppsCommandInput, cb: (err: any, data?: ListAppsCommandOutput) => void): void; + listApps( args: ListAppsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppsCommandOutput) => void ): void; - public listApps( - args: ListAppsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppsCommandOutput) => void), - cb?: (err: any, data?: ListAppsCommandOutput) => void - ): Promise | void { - const command = new ListAppsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the artifacts in your account and their properties.

- */ - public listArtifacts( - args: ListArtifactsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listArtifacts( - args: ListArtifactsCommandInput, - cb: (err: any, data?: ListArtifactsCommandOutput) => void - ): void; - public listArtifacts( + + /** + * @see {@link ListArtifactsCommand} + */ + listArtifacts(args: ListArtifactsCommandInput, options?: __HttpHandlerOptions): Promise; + listArtifacts(args: ListArtifactsCommandInput, cb: (err: any, data?: ListArtifactsCommandOutput) => void): void; + listArtifacts( args: ListArtifactsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListArtifactsCommandOutput) => void ): void; - public listArtifacts( - args: ListArtifactsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListArtifactsCommandOutput) => void), - cb?: (err: any, data?: ListArtifactsCommandOutput) => void - ): Promise | void { - const command = new ListArtifactsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the associations in your account and their properties.

- */ - public listAssociations( + + /** + * @see {@link ListAssociationsCommand} + */ + listAssociations( args: ListAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssociations( + listAssociations( args: ListAssociationsCommandInput, cb: (err: any, data?: ListAssociationsCommandOutput) => void ): void; - public listAssociations( + listAssociations( args: ListAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssociationsCommandOutput) => void ): void; - public listAssociations( - args: ListAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssociationsCommandOutput) => void), - cb?: (err: any, data?: ListAssociationsCommandOutput) => void - ): Promise | void { - const command = new ListAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Request a list of jobs.

- */ - public listAutoMLJobs( + + /** + * @see {@link ListAutoMLJobsCommand} + */ + listAutoMLJobs( args: ListAutoMLJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAutoMLJobs( - args: ListAutoMLJobsCommandInput, - cb: (err: any, data?: ListAutoMLJobsCommandOutput) => void - ): void; - public listAutoMLJobs( + listAutoMLJobs(args: ListAutoMLJobsCommandInput, cb: (err: any, data?: ListAutoMLJobsCommandOutput) => void): void; + listAutoMLJobs( args: ListAutoMLJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAutoMLJobsCommandOutput) => void ): void; - public listAutoMLJobs( - args: ListAutoMLJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAutoMLJobsCommandOutput) => void), - cb?: (err: any, data?: ListAutoMLJobsCommandOutput) => void - ): Promise | void { - const command = new ListAutoMLJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List the candidates created for the job.

- */ - public listCandidatesForAutoMLJob( + + /** + * @see {@link ListCandidatesForAutoMLJobCommand} + */ + listCandidatesForAutoMLJob( args: ListCandidatesForAutoMLJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCandidatesForAutoMLJob( + listCandidatesForAutoMLJob( args: ListCandidatesForAutoMLJobCommandInput, cb: (err: any, data?: ListCandidatesForAutoMLJobCommandOutput) => void ): void; - public listCandidatesForAutoMLJob( + listCandidatesForAutoMLJob( args: ListCandidatesForAutoMLJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCandidatesForAutoMLJobCommandOutput) => void ): void; - public listCandidatesForAutoMLJob( - args: ListCandidatesForAutoMLJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCandidatesForAutoMLJobCommandOutput) => void), - cb?: (err: any, data?: ListCandidatesForAutoMLJobCommandOutput) => void - ): Promise | void { - const command = new ListCandidatesForAutoMLJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of the Git repositories in your account.

- */ - public listCodeRepositories( + + /** + * @see {@link ListCodeRepositoriesCommand} + */ + listCodeRepositories( args: ListCodeRepositoriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCodeRepositories( + listCodeRepositories( args: ListCodeRepositoriesCommandInput, cb: (err: any, data?: ListCodeRepositoriesCommandOutput) => void ): void; - public listCodeRepositories( + listCodeRepositories( args: ListCodeRepositoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCodeRepositoriesCommandOutput) => void ): void; - public listCodeRepositories( - args: ListCodeRepositoriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCodeRepositoriesCommandOutput) => void), - cb?: (err: any, data?: ListCodeRepositoriesCommandOutput) => void - ): Promise | void { - const command = new ListCodeRepositoriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists model compilation jobs that satisfy various filters.

- *

To create a model compilation job, use CreateCompilationJob. To get - * information about a particular model compilation job you have created, use DescribeCompilationJob.

- */ - public listCompilationJobs( + + /** + * @see {@link ListCompilationJobsCommand} + */ + listCompilationJobs( args: ListCompilationJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCompilationJobs( + listCompilationJobs( args: ListCompilationJobsCommandInput, cb: (err: any, data?: ListCompilationJobsCommandOutput) => void ): void; - public listCompilationJobs( + listCompilationJobs( args: ListCompilationJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCompilationJobsCommandOutput) => void ): void; - public listCompilationJobs( - args: ListCompilationJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCompilationJobsCommandOutput) => void), - cb?: (err: any, data?: ListCompilationJobsCommandOutput) => void - ): Promise | void { - const command = new ListCompilationJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the contexts in your account and their properties.

- */ - public listContexts( - args: ListContextsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listContexts(args: ListContextsCommandInput, cb: (err: any, data?: ListContextsCommandOutput) => void): void; - public listContexts( + + /** + * @see {@link ListContextsCommand} + */ + listContexts(args: ListContextsCommandInput, options?: __HttpHandlerOptions): Promise; + listContexts(args: ListContextsCommandInput, cb: (err: any, data?: ListContextsCommandOutput) => void): void; + listContexts( args: ListContextsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListContextsCommandOutput) => void ): void; - public listContexts( - args: ListContextsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListContextsCommandOutput) => void), - cb?: (err: any, data?: ListContextsCommandOutput) => void - ): Promise | void { - const command = new ListContextsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the data quality job definitions in your account.

- */ - public listDataQualityJobDefinitions( + + /** + * @see {@link ListDataQualityJobDefinitionsCommand} + */ + listDataQualityJobDefinitions( args: ListDataQualityJobDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDataQualityJobDefinitions( + listDataQualityJobDefinitions( args: ListDataQualityJobDefinitionsCommandInput, cb: (err: any, data?: ListDataQualityJobDefinitionsCommandOutput) => void ): void; - public listDataQualityJobDefinitions( + listDataQualityJobDefinitions( args: ListDataQualityJobDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataQualityJobDefinitionsCommandOutput) => void ): void; - public listDataQualityJobDefinitions( - args: ListDataQualityJobDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDataQualityJobDefinitionsCommandOutput) => void), - cb?: (err: any, data?: ListDataQualityJobDefinitionsCommandOutput) => void - ): Promise | void { - const command = new ListDataQualityJobDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of devices in the fleet.

- */ - public listDeviceFleets( + + /** + * @see {@link ListDeviceFleetsCommand} + */ + listDeviceFleets( args: ListDeviceFleetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeviceFleets( + listDeviceFleets( args: ListDeviceFleetsCommandInput, cb: (err: any, data?: ListDeviceFleetsCommandOutput) => void ): void; - public listDeviceFleets( + listDeviceFleets( args: ListDeviceFleetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeviceFleetsCommandOutput) => void ): void; - public listDeviceFleets( - args: ListDeviceFleetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeviceFleetsCommandOutput) => void), - cb?: (err: any, data?: ListDeviceFleetsCommandOutput) => void - ): Promise | void { - const command = new ListDeviceFleetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

A list of devices.

- */ - public listDevices(args: ListDevicesCommandInput, options?: __HttpHandlerOptions): Promise; - public listDevices(args: ListDevicesCommandInput, cb: (err: any, data?: ListDevicesCommandOutput) => void): void; - public listDevices( + + /** + * @see {@link ListDevicesCommand} + */ + listDevices(args: ListDevicesCommandInput, options?: __HttpHandlerOptions): Promise; + listDevices(args: ListDevicesCommandInput, cb: (err: any, data?: ListDevicesCommandOutput) => void): void; + listDevices( args: ListDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDevicesCommandOutput) => void ): void; - public listDevices( - args: ListDevicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDevicesCommandOutput) => void), - cb?: (err: any, data?: ListDevicesCommandOutput) => void - ): Promise | void { - const command = new ListDevicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the domains.

- */ - public listDomains(args: ListDomainsCommandInput, options?: __HttpHandlerOptions): Promise; - public listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void; - public listDomains( + + /** + * @see {@link ListDomainsCommand} + */ + listDomains(args: ListDomainsCommandInput, options?: __HttpHandlerOptions): Promise; + listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void; + listDomains( args: ListDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainsCommandOutput) => void ): void; - public listDomains( - args: ListDomainsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDomainsCommandOutput) => void), - cb?: (err: any, data?: ListDomainsCommandOutput) => void - ): Promise | void { - const command = new ListDomainsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all edge deployment plans.

- */ - public listEdgeDeploymentPlans( + + /** + * @see {@link ListEdgeDeploymentPlansCommand} + */ + listEdgeDeploymentPlans( args: ListEdgeDeploymentPlansCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEdgeDeploymentPlans( + listEdgeDeploymentPlans( args: ListEdgeDeploymentPlansCommandInput, cb: (err: any, data?: ListEdgeDeploymentPlansCommandOutput) => void ): void; - public listEdgeDeploymentPlans( + listEdgeDeploymentPlans( args: ListEdgeDeploymentPlansCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEdgeDeploymentPlansCommandOutput) => void ): void; - public listEdgeDeploymentPlans( - args: ListEdgeDeploymentPlansCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEdgeDeploymentPlansCommandOutput) => void), - cb?: (err: any, data?: ListEdgeDeploymentPlansCommandOutput) => void - ): Promise | void { - const command = new ListEdgeDeploymentPlansCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of edge packaging jobs.

- */ - public listEdgePackagingJobs( + + /** + * @see {@link ListEdgePackagingJobsCommand} + */ + listEdgePackagingJobs( args: ListEdgePackagingJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEdgePackagingJobs( + listEdgePackagingJobs( args: ListEdgePackagingJobsCommandInput, cb: (err: any, data?: ListEdgePackagingJobsCommandOutput) => void ): void; - public listEdgePackagingJobs( + listEdgePackagingJobs( args: ListEdgePackagingJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEdgePackagingJobsCommandOutput) => void ): void; - public listEdgePackagingJobs( - args: ListEdgePackagingJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEdgePackagingJobsCommandOutput) => void), - cb?: (err: any, data?: ListEdgePackagingJobsCommandOutput) => void - ): Promise | void { - const command = new ListEdgePackagingJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists endpoint configurations.

- */ - public listEndpointConfigs( + + /** + * @see {@link ListEndpointConfigsCommand} + */ + listEndpointConfigs( args: ListEndpointConfigsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEndpointConfigs( + listEndpointConfigs( args: ListEndpointConfigsCommandInput, cb: (err: any, data?: ListEndpointConfigsCommandOutput) => void ): void; - public listEndpointConfigs( + listEndpointConfigs( args: ListEndpointConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEndpointConfigsCommandOutput) => void ): void; - public listEndpointConfigs( - args: ListEndpointConfigsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEndpointConfigsCommandOutput) => void), - cb?: (err: any, data?: ListEndpointConfigsCommandOutput) => void - ): Promise | void { - const command = new ListEndpointConfigsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists endpoints.

- */ - public listEndpoints( - args: ListEndpointsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listEndpoints( - args: ListEndpointsCommandInput, - cb: (err: any, data?: ListEndpointsCommandOutput) => void - ): void; - public listEndpoints( + + /** + * @see {@link ListEndpointsCommand} + */ + listEndpoints(args: ListEndpointsCommandInput, options?: __HttpHandlerOptions): Promise; + listEndpoints(args: ListEndpointsCommandInput, cb: (err: any, data?: ListEndpointsCommandOutput) => void): void; + listEndpoints( args: ListEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEndpointsCommandOutput) => void ): void; - public listEndpoints( - args: ListEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEndpointsCommandOutput) => void), - cb?: (err: any, data?: ListEndpointsCommandOutput) => void - ): Promise | void { - const command = new ListEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all the experiments in your account. The list can be filtered to show only - * experiments that were created in a specific time range. The list can be sorted by experiment - * name or creation time.

- */ - public listExperiments( + + /** + * @see {@link ListExperimentsCommand} + */ + listExperiments( args: ListExperimentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listExperiments( - args: ListExperimentsCommandInput, - cb: (err: any, data?: ListExperimentsCommandOutput) => void - ): void; - public listExperiments( + listExperiments(args: ListExperimentsCommandInput, cb: (err: any, data?: ListExperimentsCommandOutput) => void): void; + listExperiments( args: ListExperimentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExperimentsCommandOutput) => void ): void; - public listExperiments( - args: ListExperimentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListExperimentsCommandOutput) => void), - cb?: (err: any, data?: ListExperimentsCommandOutput) => void - ): Promise | void { - const command = new ListExperimentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List FeatureGroups based on given filter and order.

- */ - public listFeatureGroups( + + /** + * @see {@link ListFeatureGroupsCommand} + */ + listFeatureGroups( args: ListFeatureGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFeatureGroups( + listFeatureGroups( args: ListFeatureGroupsCommandInput, cb: (err: any, data?: ListFeatureGroupsCommandOutput) => void ): void; - public listFeatureGroups( + listFeatureGroups( args: ListFeatureGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFeatureGroupsCommandOutput) => void ): void; - public listFeatureGroups( - args: ListFeatureGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFeatureGroupsCommandOutput) => void), - cb?: (err: any, data?: ListFeatureGroupsCommandOutput) => void - ): Promise | void { - const command = new ListFeatureGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the flow definitions in your account.

- */ - public listFlowDefinitions( + + /** + * @see {@link ListFlowDefinitionsCommand} + */ + listFlowDefinitions( args: ListFlowDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFlowDefinitions( + listFlowDefinitions( args: ListFlowDefinitionsCommandInput, cb: (err: any, data?: ListFlowDefinitionsCommandOutput) => void ): void; - public listFlowDefinitions( + listFlowDefinitions( args: ListFlowDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFlowDefinitionsCommandOutput) => void ): void; - public listFlowDefinitions( - args: ListFlowDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFlowDefinitionsCommandOutput) => void), - cb?: (err: any, data?: ListFlowDefinitionsCommandOutput) => void - ): Promise | void { - const command = new ListFlowDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List the contents of a hub.

- * - *

Hub APIs are only callable through SageMaker Studio.

- *
- */ - public listHubContents( + + /** + * @see {@link ListHubContentsCommand} + */ + listHubContents( args: ListHubContentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listHubContents( - args: ListHubContentsCommandInput, - cb: (err: any, data?: ListHubContentsCommandOutput) => void - ): void; - public listHubContents( + listHubContents(args: ListHubContentsCommandInput, cb: (err: any, data?: ListHubContentsCommandOutput) => void): void; + listHubContents( args: ListHubContentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHubContentsCommandOutput) => void ): void; - public listHubContents( - args: ListHubContentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListHubContentsCommandOutput) => void), - cb?: (err: any, data?: ListHubContentsCommandOutput) => void - ): Promise | void { - const command = new ListHubContentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List hub content versions.

- * - *

Hub APIs are only callable through SageMaker Studio.

- *
- */ - public listHubContentVersions( + + /** + * @see {@link ListHubContentVersionsCommand} + */ + listHubContentVersions( args: ListHubContentVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listHubContentVersions( + listHubContentVersions( args: ListHubContentVersionsCommandInput, cb: (err: any, data?: ListHubContentVersionsCommandOutput) => void ): void; - public listHubContentVersions( + listHubContentVersions( args: ListHubContentVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHubContentVersionsCommandOutput) => void ): void; - public listHubContentVersions( - args: ListHubContentVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListHubContentVersionsCommandOutput) => void), - cb?: (err: any, data?: ListHubContentVersionsCommandOutput) => void - ): Promise | void { - const command = new ListHubContentVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List all existing hubs.

- * - *

Hub APIs are only callable through SageMaker Studio.

- *
- */ - public listHubs(args: ListHubsCommandInput, options?: __HttpHandlerOptions): Promise; - public listHubs(args: ListHubsCommandInput, cb: (err: any, data?: ListHubsCommandOutput) => void): void; - public listHubs( + + /** + * @see {@link ListHubsCommand} + */ + listHubs(args: ListHubsCommandInput, options?: __HttpHandlerOptions): Promise; + listHubs(args: ListHubsCommandInput, cb: (err: any, data?: ListHubsCommandOutput) => void): void; + listHubs( args: ListHubsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHubsCommandOutput) => void ): void; - public listHubs( - args: ListHubsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListHubsCommandOutput) => void), - cb?: (err: any, data?: ListHubsCommandOutput) => void - ): Promise | void { - const command = new ListHubsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the human task user interfaces in your account.

- */ - public listHumanTaskUis( + + /** + * @see {@link ListHumanTaskUisCommand} + */ + listHumanTaskUis( args: ListHumanTaskUisCommandInput, options?: __HttpHandlerOptions ): Promise; - public listHumanTaskUis( + listHumanTaskUis( args: ListHumanTaskUisCommandInput, cb: (err: any, data?: ListHumanTaskUisCommandOutput) => void ): void; - public listHumanTaskUis( + listHumanTaskUis( args: ListHumanTaskUisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHumanTaskUisCommandOutput) => void ): void; - public listHumanTaskUis( - args: ListHumanTaskUisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListHumanTaskUisCommandOutput) => void), - cb?: (err: any, data?: ListHumanTaskUisCommandOutput) => void - ): Promise | void { - const command = new ListHumanTaskUisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of HyperParameterTuningJobSummary objects that - * describe - * the hyperparameter tuning jobs launched in your account.

- */ - public listHyperParameterTuningJobs( + + /** + * @see {@link ListHyperParameterTuningJobsCommand} + */ + listHyperParameterTuningJobs( args: ListHyperParameterTuningJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listHyperParameterTuningJobs( + listHyperParameterTuningJobs( args: ListHyperParameterTuningJobsCommandInput, cb: (err: any, data?: ListHyperParameterTuningJobsCommandOutput) => void ): void; - public listHyperParameterTuningJobs( + listHyperParameterTuningJobs( args: ListHyperParameterTuningJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHyperParameterTuningJobsCommandOutput) => void ): void; - public listHyperParameterTuningJobs( - args: ListHyperParameterTuningJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListHyperParameterTuningJobsCommandOutput) => void), - cb?: (err: any, data?: ListHyperParameterTuningJobsCommandOutput) => void - ): Promise | void { - const command = new ListHyperParameterTuningJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the images in your account and their properties. The list can be filtered by - * creation time or modified time, and whether the image name contains a specified string.

- */ - public listImages(args: ListImagesCommandInput, options?: __HttpHandlerOptions): Promise; - public listImages(args: ListImagesCommandInput, cb: (err: any, data?: ListImagesCommandOutput) => void): void; - public listImages( + + /** + * @see {@link ListImagesCommand} + */ + listImages(args: ListImagesCommandInput, options?: __HttpHandlerOptions): Promise; + listImages(args: ListImagesCommandInput, cb: (err: any, data?: ListImagesCommandOutput) => void): void; + listImages( args: ListImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImagesCommandOutput) => void ): void; - public listImages( - args: ListImagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListImagesCommandOutput) => void), - cb?: (err: any, data?: ListImagesCommandOutput) => void - ): Promise | void { - const command = new ListImagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the versions of a specified image and their properties. The list can be filtered - * by creation time or modified time.

- */ - public listImageVersions( + + /** + * @see {@link ListImageVersionsCommand} + */ + listImageVersions( args: ListImageVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listImageVersions( + listImageVersions( args: ListImageVersionsCommandInput, cb: (err: any, data?: ListImageVersionsCommandOutput) => void ): void; - public listImageVersions( + listImageVersions( args: ListImageVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImageVersionsCommandOutput) => void ): void; - public listImageVersions( - args: ListImageVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListImageVersionsCommandOutput) => void), - cb?: (err: any, data?: ListImageVersionsCommandOutput) => void - ): Promise | void { - const command = new ListImageVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the list of all inference experiments.

- */ - public listInferenceExperiments( + + /** + * @see {@link ListInferenceExperimentsCommand} + */ + listInferenceExperiments( args: ListInferenceExperimentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInferenceExperiments( + listInferenceExperiments( args: ListInferenceExperimentsCommandInput, cb: (err: any, data?: ListInferenceExperimentsCommandOutput) => void ): void; - public listInferenceExperiments( + listInferenceExperiments( args: ListInferenceExperimentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInferenceExperimentsCommandOutput) => void ): void; - public listInferenceExperiments( - args: ListInferenceExperimentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInferenceExperimentsCommandOutput) => void), - cb?: (err: any, data?: ListInferenceExperimentsCommandOutput) => void - ): Promise | void { - const command = new ListInferenceExperimentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists recommendation jobs that satisfy various filters.

- */ - public listInferenceRecommendationsJobs( + + /** + * @see {@link ListInferenceRecommendationsJobsCommand} + */ + listInferenceRecommendationsJobs( args: ListInferenceRecommendationsJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInferenceRecommendationsJobs( + listInferenceRecommendationsJobs( args: ListInferenceRecommendationsJobsCommandInput, cb: (err: any, data?: ListInferenceRecommendationsJobsCommandOutput) => void ): void; - public listInferenceRecommendationsJobs( + listInferenceRecommendationsJobs( args: ListInferenceRecommendationsJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInferenceRecommendationsJobsCommandOutput) => void ): void; - public listInferenceRecommendationsJobs( - args: ListInferenceRecommendationsJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInferenceRecommendationsJobsCommandOutput) => void), - cb?: (err: any, data?: ListInferenceRecommendationsJobsCommandOutput) => void - ): Promise | void { - const command = new ListInferenceRecommendationsJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of the subtasks for an Inference Recommender job.

- *

The supported subtasks are benchmarks, which evaluate the performance of your model on different instance types.

- */ - public listInferenceRecommendationsJobSteps( + + /** + * @see {@link ListInferenceRecommendationsJobStepsCommand} + */ + listInferenceRecommendationsJobSteps( args: ListInferenceRecommendationsJobStepsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInferenceRecommendationsJobSteps( + listInferenceRecommendationsJobSteps( args: ListInferenceRecommendationsJobStepsCommandInput, cb: (err: any, data?: ListInferenceRecommendationsJobStepsCommandOutput) => void ): void; - public listInferenceRecommendationsJobSteps( + listInferenceRecommendationsJobSteps( args: ListInferenceRecommendationsJobStepsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInferenceRecommendationsJobStepsCommandOutput) => void ): void; - public listInferenceRecommendationsJobSteps( - args: ListInferenceRecommendationsJobStepsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInferenceRecommendationsJobStepsCommandOutput) => void), - cb?: (err: any, data?: ListInferenceRecommendationsJobStepsCommandOutput) => void - ): Promise | void { - const command = new ListInferenceRecommendationsJobStepsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of labeling jobs.

- */ - public listLabelingJobs( + + /** + * @see {@link ListLabelingJobsCommand} + */ + listLabelingJobs( args: ListLabelingJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLabelingJobs( + listLabelingJobs( args: ListLabelingJobsCommandInput, cb: (err: any, data?: ListLabelingJobsCommandOutput) => void ): void; - public listLabelingJobs( + listLabelingJobs( args: ListLabelingJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLabelingJobsCommandOutput) => void ): void; - public listLabelingJobs( - args: ListLabelingJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLabelingJobsCommandOutput) => void), - cb?: (err: any, data?: ListLabelingJobsCommandOutput) => void - ): Promise | void { - const command = new ListLabelingJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of labeling jobs assigned to a specified work team.

- */ - public listLabelingJobsForWorkteam( + + /** + * @see {@link ListLabelingJobsForWorkteamCommand} + */ + listLabelingJobsForWorkteam( args: ListLabelingJobsForWorkteamCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLabelingJobsForWorkteam( + listLabelingJobsForWorkteam( args: ListLabelingJobsForWorkteamCommandInput, cb: (err: any, data?: ListLabelingJobsForWorkteamCommandOutput) => void ): void; - public listLabelingJobsForWorkteam( + listLabelingJobsForWorkteam( args: ListLabelingJobsForWorkteamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLabelingJobsForWorkteamCommandOutput) => void ): void; - public listLabelingJobsForWorkteam( - args: ListLabelingJobsForWorkteamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLabelingJobsForWorkteamCommandOutput) => void), - cb?: (err: any, data?: ListLabelingJobsForWorkteamCommandOutput) => void - ): Promise | void { - const command = new ListLabelingJobsForWorkteamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

A list of lineage groups shared with your Amazon Web Services account. - * For more information, see - * Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.

- */ - public listLineageGroups( + + /** + * @see {@link ListLineageGroupsCommand} + */ + listLineageGroups( args: ListLineageGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLineageGroups( + listLineageGroups( args: ListLineageGroupsCommandInput, cb: (err: any, data?: ListLineageGroupsCommandOutput) => void ): void; - public listLineageGroups( + listLineageGroups( args: ListLineageGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLineageGroupsCommandOutput) => void ): void; - public listLineageGroups( - args: ListLineageGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLineageGroupsCommandOutput) => void), - cb?: (err: any, data?: ListLineageGroupsCommandOutput) => void - ): Promise | void { - const command = new ListLineageGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists model bias jobs definitions that satisfy various filters.

- */ - public listModelBiasJobDefinitions( + + /** + * @see {@link ListModelBiasJobDefinitionsCommand} + */ + listModelBiasJobDefinitions( args: ListModelBiasJobDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listModelBiasJobDefinitions( + listModelBiasJobDefinitions( args: ListModelBiasJobDefinitionsCommandInput, cb: (err: any, data?: ListModelBiasJobDefinitionsCommandOutput) => void ): void; - public listModelBiasJobDefinitions( + listModelBiasJobDefinitions( args: ListModelBiasJobDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListModelBiasJobDefinitionsCommandOutput) => void ): void; - public listModelBiasJobDefinitions( - args: ListModelBiasJobDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListModelBiasJobDefinitionsCommandOutput) => void), - cb?: (err: any, data?: ListModelBiasJobDefinitionsCommandOutput) => void - ): Promise | void { - const command = new ListModelBiasJobDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List the export jobs for the Amazon SageMaker Model Card.

- */ - public listModelCardExportJobs( + + /** + * @see {@link ListModelCardExportJobsCommand} + */ + listModelCardExportJobs( args: ListModelCardExportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listModelCardExportJobs( + listModelCardExportJobs( args: ListModelCardExportJobsCommandInput, cb: (err: any, data?: ListModelCardExportJobsCommandOutput) => void ): void; - public listModelCardExportJobs( + listModelCardExportJobs( args: ListModelCardExportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListModelCardExportJobsCommandOutput) => void ): void; - public listModelCardExportJobs( - args: ListModelCardExportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListModelCardExportJobsCommandOutput) => void), - cb?: (err: any, data?: ListModelCardExportJobsCommandOutput) => void - ): Promise | void { - const command = new ListModelCardExportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List existing model cards.

- */ - public listModelCards( + + /** + * @see {@link ListModelCardsCommand} + */ + listModelCards( args: ListModelCardsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listModelCards( - args: ListModelCardsCommandInput, - cb: (err: any, data?: ListModelCardsCommandOutput) => void - ): void; - public listModelCards( + listModelCards(args: ListModelCardsCommandInput, cb: (err: any, data?: ListModelCardsCommandOutput) => void): void; + listModelCards( args: ListModelCardsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListModelCardsCommandOutput) => void ): void; - public listModelCards( - args: ListModelCardsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListModelCardsCommandOutput) => void), - cb?: (err: any, data?: ListModelCardsCommandOutput) => void - ): Promise | void { - const command = new ListModelCardsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List existing versions of an Amazon SageMaker Model Card.

- */ - public listModelCardVersions( + + /** + * @see {@link ListModelCardVersionsCommand} + */ + listModelCardVersions( args: ListModelCardVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listModelCardVersions( + listModelCardVersions( args: ListModelCardVersionsCommandInput, cb: (err: any, data?: ListModelCardVersionsCommandOutput) => void ): void; - public listModelCardVersions( + listModelCardVersions( args: ListModelCardVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListModelCardVersionsCommandOutput) => void ): void; - public listModelCardVersions( - args: ListModelCardVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListModelCardVersionsCommandOutput) => void), - cb?: (err: any, data?: ListModelCardVersionsCommandOutput) => void - ): Promise | void { - const command = new ListModelCardVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists model explainability job definitions that satisfy various filters.

- */ - public listModelExplainabilityJobDefinitions( + + /** + * @see {@link ListModelExplainabilityJobDefinitionsCommand} + */ + listModelExplainabilityJobDefinitions( args: ListModelExplainabilityJobDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listModelExplainabilityJobDefinitions( + listModelExplainabilityJobDefinitions( args: ListModelExplainabilityJobDefinitionsCommandInput, cb: (err: any, data?: ListModelExplainabilityJobDefinitionsCommandOutput) => void ): void; - public listModelExplainabilityJobDefinitions( + listModelExplainabilityJobDefinitions( args: ListModelExplainabilityJobDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListModelExplainabilityJobDefinitionsCommandOutput) => void ): void; - public listModelExplainabilityJobDefinitions( - args: ListModelExplainabilityJobDefinitionsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListModelExplainabilityJobDefinitionsCommandOutput) => void), - cb?: (err: any, data?: ListModelExplainabilityJobDefinitionsCommandOutput) => void - ): Promise | void { - const command = new ListModelExplainabilityJobDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the domain, framework, task, and model name of standard - * machine learning models found in common model zoos.

- */ - public listModelMetadata( + + /** + * @see {@link ListModelMetadataCommand} + */ + listModelMetadata( args: ListModelMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public listModelMetadata( + listModelMetadata( args: ListModelMetadataCommandInput, cb: (err: any, data?: ListModelMetadataCommandOutput) => void ): void; - public listModelMetadata( + listModelMetadata( args: ListModelMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListModelMetadataCommandOutput) => void ): void; - public listModelMetadata( - args: ListModelMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListModelMetadataCommandOutput) => void), - cb?: (err: any, data?: ListModelMetadataCommandOutput) => void - ): Promise | void { - const command = new ListModelMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of the model groups in your Amazon Web Services account.

- */ - public listModelPackageGroups( + + /** + * @see {@link ListModelPackageGroupsCommand} + */ + listModelPackageGroups( args: ListModelPackageGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listModelPackageGroups( + listModelPackageGroups( args: ListModelPackageGroupsCommandInput, cb: (err: any, data?: ListModelPackageGroupsCommandOutput) => void ): void; - public listModelPackageGroups( + listModelPackageGroups( args: ListModelPackageGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListModelPackageGroupsCommandOutput) => void ): void; - public listModelPackageGroups( - args: ListModelPackageGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListModelPackageGroupsCommandOutput) => void), - cb?: (err: any, data?: ListModelPackageGroupsCommandOutput) => void - ): Promise | void { - const command = new ListModelPackageGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the model packages that have been created.

- */ - public listModelPackages( + + /** + * @see {@link ListModelPackagesCommand} + */ + listModelPackages( args: ListModelPackagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listModelPackages( + listModelPackages( args: ListModelPackagesCommandInput, cb: (err: any, data?: ListModelPackagesCommandOutput) => void ): void; - public listModelPackages( + listModelPackages( args: ListModelPackagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListModelPackagesCommandOutput) => void ): void; - public listModelPackages( - args: ListModelPackagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListModelPackagesCommandOutput) => void), - cb?: (err: any, data?: ListModelPackagesCommandOutput) => void - ): Promise | void { - const command = new ListModelPackagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of model quality monitoring job definitions in your account.

- */ - public listModelQualityJobDefinitions( + + /** + * @see {@link ListModelQualityJobDefinitionsCommand} + */ + listModelQualityJobDefinitions( args: ListModelQualityJobDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listModelQualityJobDefinitions( + listModelQualityJobDefinitions( args: ListModelQualityJobDefinitionsCommandInput, cb: (err: any, data?: ListModelQualityJobDefinitionsCommandOutput) => void ): void; - public listModelQualityJobDefinitions( + listModelQualityJobDefinitions( args: ListModelQualityJobDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListModelQualityJobDefinitionsCommandOutput) => void ): void; - public listModelQualityJobDefinitions( - args: ListModelQualityJobDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListModelQualityJobDefinitionsCommandOutput) => void), - cb?: (err: any, data?: ListModelQualityJobDefinitionsCommandOutput) => void - ): Promise | void { - const command = new ListModelQualityJobDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists models created with the CreateModel API.

- */ - public listModels(args: ListModelsCommandInput, options?: __HttpHandlerOptions): Promise; - public listModels(args: ListModelsCommandInput, cb: (err: any, data?: ListModelsCommandOutput) => void): void; - public listModels( + + /** + * @see {@link ListModelsCommand} + */ + listModels(args: ListModelsCommandInput, options?: __HttpHandlerOptions): Promise; + listModels(args: ListModelsCommandInput, cb: (err: any, data?: ListModelsCommandOutput) => void): void; + listModels( args: ListModelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListModelsCommandOutput) => void ): void; - public listModels( - args: ListModelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListModelsCommandOutput) => void), - cb?: (err: any, data?: ListModelsCommandOutput) => void - ): Promise | void { - const command = new ListModelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of past alerts in a model monitoring schedule.

- */ - public listMonitoringAlertHistory( + + /** + * @see {@link ListMonitoringAlertHistoryCommand} + */ + listMonitoringAlertHistory( args: ListMonitoringAlertHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMonitoringAlertHistory( + listMonitoringAlertHistory( args: ListMonitoringAlertHistoryCommandInput, cb: (err: any, data?: ListMonitoringAlertHistoryCommandOutput) => void ): void; - public listMonitoringAlertHistory( + listMonitoringAlertHistory( args: ListMonitoringAlertHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMonitoringAlertHistoryCommandOutput) => void ): void; - public listMonitoringAlertHistory( - args: ListMonitoringAlertHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMonitoringAlertHistoryCommandOutput) => void), - cb?: (err: any, data?: ListMonitoringAlertHistoryCommandOutput) => void - ): Promise | void { - const command = new ListMonitoringAlertHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the alerts for a single monitoring schedule.

- */ - public listMonitoringAlerts( + + /** + * @see {@link ListMonitoringAlertsCommand} + */ + listMonitoringAlerts( args: ListMonitoringAlertsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMonitoringAlerts( + listMonitoringAlerts( args: ListMonitoringAlertsCommandInput, cb: (err: any, data?: ListMonitoringAlertsCommandOutput) => void ): void; - public listMonitoringAlerts( + listMonitoringAlerts( args: ListMonitoringAlertsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMonitoringAlertsCommandOutput) => void ): void; - public listMonitoringAlerts( - args: ListMonitoringAlertsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMonitoringAlertsCommandOutput) => void), - cb?: (err: any, data?: ListMonitoringAlertsCommandOutput) => void - ): Promise | void { - const command = new ListMonitoringAlertsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns list of all monitoring job executions.

- */ - public listMonitoringExecutions( + + /** + * @see {@link ListMonitoringExecutionsCommand} + */ + listMonitoringExecutions( args: ListMonitoringExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMonitoringExecutions( + listMonitoringExecutions( args: ListMonitoringExecutionsCommandInput, cb: (err: any, data?: ListMonitoringExecutionsCommandOutput) => void ): void; - public listMonitoringExecutions( + listMonitoringExecutions( args: ListMonitoringExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMonitoringExecutionsCommandOutput) => void ): void; - public listMonitoringExecutions( - args: ListMonitoringExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMonitoringExecutionsCommandOutput) => void), - cb?: (err: any, data?: ListMonitoringExecutionsCommandOutput) => void - ): Promise | void { - const command = new ListMonitoringExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns list of all monitoring schedules.

- */ - public listMonitoringSchedules( + + /** + * @see {@link ListMonitoringSchedulesCommand} + */ + listMonitoringSchedules( args: ListMonitoringSchedulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMonitoringSchedules( + listMonitoringSchedules( args: ListMonitoringSchedulesCommandInput, cb: (err: any, data?: ListMonitoringSchedulesCommandOutput) => void ): void; - public listMonitoringSchedules( + listMonitoringSchedules( args: ListMonitoringSchedulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMonitoringSchedulesCommandOutput) => void ): void; - public listMonitoringSchedules( - args: ListMonitoringSchedulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMonitoringSchedulesCommandOutput) => void), - cb?: (err: any, data?: ListMonitoringSchedulesCommandOutput) => void - ): Promise | void { - const command = new ListMonitoringSchedulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.

- */ - public listNotebookInstanceLifecycleConfigs( + + /** + * @see {@link ListNotebookInstanceLifecycleConfigsCommand} + */ + listNotebookInstanceLifecycleConfigs( args: ListNotebookInstanceLifecycleConfigsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listNotebookInstanceLifecycleConfigs( + listNotebookInstanceLifecycleConfigs( args: ListNotebookInstanceLifecycleConfigsCommandInput, cb: (err: any, data?: ListNotebookInstanceLifecycleConfigsCommandOutput) => void ): void; - public listNotebookInstanceLifecycleConfigs( + listNotebookInstanceLifecycleConfigs( args: ListNotebookInstanceLifecycleConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNotebookInstanceLifecycleConfigsCommandOutput) => void ): void; - public listNotebookInstanceLifecycleConfigs( - args: ListNotebookInstanceLifecycleConfigsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNotebookInstanceLifecycleConfigsCommandOutput) => void), - cb?: (err: any, data?: ListNotebookInstanceLifecycleConfigsCommandOutput) => void - ): Promise | void { - const command = new ListNotebookInstanceLifecycleConfigsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of the SageMaker notebook instances in the requester's account in an - * Amazon Web Services Region.

- */ - public listNotebookInstances( + + /** + * @see {@link ListNotebookInstancesCommand} + */ + listNotebookInstances( args: ListNotebookInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listNotebookInstances( + listNotebookInstances( args: ListNotebookInstancesCommandInput, cb: (err: any, data?: ListNotebookInstancesCommandOutput) => void ): void; - public listNotebookInstances( + listNotebookInstances( args: ListNotebookInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNotebookInstancesCommandOutput) => void ): void; - public listNotebookInstances( - args: ListNotebookInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNotebookInstancesCommandOutput) => void), - cb?: (err: any, data?: ListNotebookInstancesCommandOutput) => void - ): Promise | void { - const command = new ListNotebookInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of the pipeline executions.

- */ - public listPipelineExecutions( + + /** + * @see {@link ListPipelineExecutionsCommand} + */ + listPipelineExecutions( args: ListPipelineExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPipelineExecutions( + listPipelineExecutions( args: ListPipelineExecutionsCommandInput, cb: (err: any, data?: ListPipelineExecutionsCommandOutput) => void ): void; - public listPipelineExecutions( + listPipelineExecutions( args: ListPipelineExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPipelineExecutionsCommandOutput) => void ): void; - public listPipelineExecutions( - args: ListPipelineExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPipelineExecutionsCommandOutput) => void), - cb?: (err: any, data?: ListPipelineExecutionsCommandOutput) => void - ): Promise | void { - const command = new ListPipelineExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of PipeLineExecutionStep objects.

- */ - public listPipelineExecutionSteps( + + /** + * @see {@link ListPipelineExecutionStepsCommand} + */ + listPipelineExecutionSteps( args: ListPipelineExecutionStepsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPipelineExecutionSteps( + listPipelineExecutionSteps( args: ListPipelineExecutionStepsCommandInput, cb: (err: any, data?: ListPipelineExecutionStepsCommandOutput) => void ): void; - public listPipelineExecutionSteps( + listPipelineExecutionSteps( args: ListPipelineExecutionStepsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPipelineExecutionStepsCommandOutput) => void ): void; - public listPipelineExecutionSteps( - args: ListPipelineExecutionStepsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPipelineExecutionStepsCommandOutput) => void), - cb?: (err: any, data?: ListPipelineExecutionStepsCommandOutput) => void - ): Promise | void { - const command = new ListPipelineExecutionStepsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of parameters for a pipeline execution.

- */ - public listPipelineParametersForExecution( + + /** + * @see {@link ListPipelineParametersForExecutionCommand} + */ + listPipelineParametersForExecution( args: ListPipelineParametersForExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPipelineParametersForExecution( + listPipelineParametersForExecution( args: ListPipelineParametersForExecutionCommandInput, cb: (err: any, data?: ListPipelineParametersForExecutionCommandOutput) => void ): void; - public listPipelineParametersForExecution( + listPipelineParametersForExecution( args: ListPipelineParametersForExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPipelineParametersForExecutionCommandOutput) => void ): void; - public listPipelineParametersForExecution( - args: ListPipelineParametersForExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPipelineParametersForExecutionCommandOutput) => void), - cb?: (err: any, data?: ListPipelineParametersForExecutionCommandOutput) => void - ): Promise | void { - const command = new ListPipelineParametersForExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of pipelines.

- */ - public listPipelines( - args: ListPipelinesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listPipelines( - args: ListPipelinesCommandInput, - cb: (err: any, data?: ListPipelinesCommandOutput) => void - ): void; - public listPipelines( + + /** + * @see {@link ListPipelinesCommand} + */ + listPipelines(args: ListPipelinesCommandInput, options?: __HttpHandlerOptions): Promise; + listPipelines(args: ListPipelinesCommandInput, cb: (err: any, data?: ListPipelinesCommandOutput) => void): void; + listPipelines( args: ListPipelinesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPipelinesCommandOutput) => void ): void; - public listPipelines( - args: ListPipelinesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPipelinesCommandOutput) => void), - cb?: (err: any, data?: ListPipelinesCommandOutput) => void - ): Promise | void { - const command = new ListPipelinesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists processing jobs that satisfy various filters.

- */ - public listProcessingJobs( + + /** + * @see {@link ListProcessingJobsCommand} + */ + listProcessingJobs( args: ListProcessingJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProcessingJobs( + listProcessingJobs( args: ListProcessingJobsCommandInput, cb: (err: any, data?: ListProcessingJobsCommandOutput) => void ): void; - public listProcessingJobs( + listProcessingJobs( args: ListProcessingJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProcessingJobsCommandOutput) => void ): void; - public listProcessingJobs( - args: ListProcessingJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProcessingJobsCommandOutput) => void), - cb?: (err: any, data?: ListProcessingJobsCommandOutput) => void - ): Promise | void { - const command = new ListProcessingJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of the projects in an Amazon Web Services account.

- */ - public listProjects( - args: ListProjectsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void; - public listProjects( + + /** + * @see {@link ListProjectsCommand} + */ + listProjects(args: ListProjectsCommandInput, options?: __HttpHandlerOptions): Promise; + listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void; + listProjects( args: ListProjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProjectsCommandOutput) => void ): void; - public listProjects( - args: ListProjectsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProjectsCommandOutput) => void), - cb?: (err: any, data?: ListProjectsCommandOutput) => void - ): Promise | void { - const command = new ListProjectsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists spaces.

- */ - public listSpaces(args: ListSpacesCommandInput, options?: __HttpHandlerOptions): Promise; - public listSpaces(args: ListSpacesCommandInput, cb: (err: any, data?: ListSpacesCommandOutput) => void): void; - public listSpaces( + + /** + * @see {@link ListSpacesCommand} + */ + listSpaces(args: ListSpacesCommandInput, options?: __HttpHandlerOptions): Promise; + listSpaces(args: ListSpacesCommandInput, cb: (err: any, data?: ListSpacesCommandOutput) => void): void; + listSpaces( args: ListSpacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSpacesCommandOutput) => void ): void; - public listSpaces( - args: ListSpacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSpacesCommandOutput) => void), - cb?: (err: any, data?: ListSpacesCommandOutput) => void - ): Promise | void { - const command = new ListSpacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists devices allocated to the stage, containing detailed device information and deployment status.

- */ - public listStageDevices( + + /** + * @see {@link ListStageDevicesCommand} + */ + listStageDevices( args: ListStageDevicesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStageDevices( + listStageDevices( args: ListStageDevicesCommandInput, cb: (err: any, data?: ListStageDevicesCommandOutput) => void ): void; - public listStageDevices( + listStageDevices( args: ListStageDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStageDevicesCommandOutput) => void ): void; - public listStageDevices( - args: ListStageDevicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStageDevicesCommandOutput) => void), - cb?: (err: any, data?: ListStageDevicesCommandOutput) => void - ): Promise | void { - const command = new ListStageDevicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the Studio Lifecycle Configurations in your Amazon Web Services Account.

- */ - public listStudioLifecycleConfigs( + + /** + * @see {@link ListStudioLifecycleConfigsCommand} + */ + listStudioLifecycleConfigs( args: ListStudioLifecycleConfigsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStudioLifecycleConfigs( + listStudioLifecycleConfigs( args: ListStudioLifecycleConfigsCommandInput, cb: (err: any, data?: ListStudioLifecycleConfigsCommandOutput) => void ): void; - public listStudioLifecycleConfigs( + listStudioLifecycleConfigs( args: ListStudioLifecycleConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStudioLifecycleConfigsCommandOutput) => void ): void; - public listStudioLifecycleConfigs( - args: ListStudioLifecycleConfigsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStudioLifecycleConfigsCommandOutput) => void), - cb?: (err: any, data?: ListStudioLifecycleConfigsCommandOutput) => void - ): Promise | void { - const command = new ListStudioLifecycleConfigsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace. The - * list may be empty if no work team satisfies the filter specified in the - * NameContains parameter.

- */ - public listSubscribedWorkteams( + + /** + * @see {@link ListSubscribedWorkteamsCommand} + */ + listSubscribedWorkteams( args: ListSubscribedWorkteamsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSubscribedWorkteams( + listSubscribedWorkteams( args: ListSubscribedWorkteamsCommandInput, cb: (err: any, data?: ListSubscribedWorkteamsCommandOutput) => void ): void; - public listSubscribedWorkteams( + listSubscribedWorkteams( args: ListSubscribedWorkteamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSubscribedWorkteamsCommandOutput) => void ): void; - public listSubscribedWorkteams( - args: ListSubscribedWorkteamsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSubscribedWorkteamsCommandOutput) => void), - cb?: (err: any, data?: ListSubscribedWorkteamsCommandOutput) => void - ): Promise | void { - const command = new ListSubscribedWorkteamsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the tags for the specified SageMaker resource.

- */ - public listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; - public listTags( + + /** + * @see {@link ListTagsCommand} + */ + listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise; + listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void; + listTags( args: ListTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsCommandOutput) => void ): void; - public listTags( - args: ListTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsCommandOutput) => void), - cb?: (err: any, data?: ListTagsCommandOutput) => void - ): Promise | void { - const command = new ListTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists training jobs.

- * - *

When StatusEquals and MaxResults are set at the same - * time, the MaxResults number of training jobs are first retrieved - * ignoring the StatusEquals parameter and then they are filtered by the - * StatusEquals parameter, which is returned as a response.

- *

For example, if ListTrainingJobs is invoked with the following - * parameters:

- *

- * \{ ... MaxResults: 100, StatusEquals: InProgress ... \} - *

- *

First, 100 trainings jobs with any status, including those other than - * InProgress, are selected (sorted according to the creation time, - * from the most current to the oldest). Next, those with a status of - * InProgress are returned.

- *

You can quickly test the API using the following Amazon Web Services CLI - * code.

- *

- * aws sagemaker list-training-jobs --max-results 100 --status-equals - * InProgress - *

- *
- */ - public listTrainingJobs( + + /** + * @see {@link ListTrainingJobsCommand} + */ + listTrainingJobs( args: ListTrainingJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTrainingJobs( + listTrainingJobs( args: ListTrainingJobsCommandInput, cb: (err: any, data?: ListTrainingJobsCommandOutput) => void ): void; - public listTrainingJobs( + listTrainingJobs( args: ListTrainingJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTrainingJobsCommandOutput) => void ): void; - public listTrainingJobs( - args: ListTrainingJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTrainingJobsCommandOutput) => void), - cb?: (err: any, data?: ListTrainingJobsCommandOutput) => void - ): Promise | void { - const command = new ListTrainingJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of TrainingJobSummary objects that describe the training - * jobs that a hyperparameter tuning job launched.

- */ - public listTrainingJobsForHyperParameterTuningJob( + + /** + * @see {@link ListTrainingJobsForHyperParameterTuningJobCommand} + */ + listTrainingJobsForHyperParameterTuningJob( args: ListTrainingJobsForHyperParameterTuningJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTrainingJobsForHyperParameterTuningJob( + listTrainingJobsForHyperParameterTuningJob( args: ListTrainingJobsForHyperParameterTuningJobCommandInput, cb: (err: any, data?: ListTrainingJobsForHyperParameterTuningJobCommandOutput) => void ): void; - public listTrainingJobsForHyperParameterTuningJob( + listTrainingJobsForHyperParameterTuningJob( args: ListTrainingJobsForHyperParameterTuningJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTrainingJobsForHyperParameterTuningJobCommandOutput) => void ): void; - public listTrainingJobsForHyperParameterTuningJob( - args: ListTrainingJobsForHyperParameterTuningJobCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListTrainingJobsForHyperParameterTuningJobCommandOutput) => void), - cb?: (err: any, data?: ListTrainingJobsForHyperParameterTuningJobCommandOutput) => void - ): Promise | void { - const command = new ListTrainingJobsForHyperParameterTuningJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists transform jobs.

- */ - public listTransformJobs( + + /** + * @see {@link ListTransformJobsCommand} + */ + listTransformJobs( args: ListTransformJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTransformJobs( + listTransformJobs( args: ListTransformJobsCommandInput, cb: (err: any, data?: ListTransformJobsCommandOutput) => void ): void; - public listTransformJobs( + listTransformJobs( args: ListTransformJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTransformJobsCommandOutput) => void ): void; - public listTransformJobs( - args: ListTransformJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTransformJobsCommandOutput) => void), - cb?: (err: any, data?: ListTransformJobsCommandOutput) => void - ): Promise | void { - const command = new ListTransformJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the trial components in your account. You can sort the list by trial component name - * or creation time. You can filter the list to show only components that were created in a - * specific time range. You can also filter on one of the following:

- *
    - *
  • - *

    - * ExperimentName - *

    - *
  • - *
  • - *

    - * SourceArn - *

    - *
  • - *
  • - *

    - * TrialName - *

    - *
  • - *
- */ - public listTrialComponents( + + /** + * @see {@link ListTrialComponentsCommand} + */ + listTrialComponents( args: ListTrialComponentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTrialComponents( + listTrialComponents( args: ListTrialComponentsCommandInput, cb: (err: any, data?: ListTrialComponentsCommandOutput) => void ): void; - public listTrialComponents( + listTrialComponents( args: ListTrialComponentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTrialComponentsCommandOutput) => void ): void; - public listTrialComponents( - args: ListTrialComponentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTrialComponentsCommandOutput) => void), - cb?: (err: any, data?: ListTrialComponentsCommandOutput) => void - ): Promise | void { - const command = new ListTrialComponentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the trials in your account. Specify an experiment name to limit the list to the - * trials that are part of that experiment. Specify a trial component name to limit the list to - * the trials that associated with that trial component. The list can be filtered to show only - * trials that were created in a specific time range. The list can be sorted by trial name or - * creation time.

- */ - public listTrials(args: ListTrialsCommandInput, options?: __HttpHandlerOptions): Promise; - public listTrials(args: ListTrialsCommandInput, cb: (err: any, data?: ListTrialsCommandOutput) => void): void; - public listTrials( + + /** + * @see {@link ListTrialsCommand} + */ + listTrials(args: ListTrialsCommandInput, options?: __HttpHandlerOptions): Promise; + listTrials(args: ListTrialsCommandInput, cb: (err: any, data?: ListTrialsCommandOutput) => void): void; + listTrials( args: ListTrialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTrialsCommandOutput) => void ): void; - public listTrials( - args: ListTrialsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTrialsCommandOutput) => void), - cb?: (err: any, data?: ListTrialsCommandOutput) => void - ): Promise | void { - const command = new ListTrialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists user profiles.

- */ - public listUserProfiles( + + /** + * @see {@link ListUserProfilesCommand} + */ + listUserProfiles( args: ListUserProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listUserProfiles( + listUserProfiles( args: ListUserProfilesCommandInput, cb: (err: any, data?: ListUserProfilesCommandOutput) => void ): void; - public listUserProfiles( + listUserProfiles( args: ListUserProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUserProfilesCommandOutput) => void ): void; - public listUserProfiles( - args: ListUserProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUserProfilesCommandOutput) => void), - cb?: (err: any, data?: ListUserProfilesCommandOutput) => void - ): Promise | void { - const command = new ListUserProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only - * have one private workforce per Amazon Web Services Region.

- */ - public listWorkforces( + + /** + * @see {@link ListWorkforcesCommand} + */ + listWorkforces( args: ListWorkforcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWorkforces( - args: ListWorkforcesCommandInput, - cb: (err: any, data?: ListWorkforcesCommandOutput) => void - ): void; - public listWorkforces( + listWorkforces(args: ListWorkforcesCommandInput, cb: (err: any, data?: ListWorkforcesCommandOutput) => void): void; + listWorkforces( args: ListWorkforcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkforcesCommandOutput) => void ): void; - public listWorkforces( - args: ListWorkforcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkforcesCommandOutput) => void), - cb?: (err: any, data?: ListWorkforcesCommandOutput) => void - ): Promise | void { - const command = new ListWorkforcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of private work teams that you have defined in a region. The list may be empty if - * no work team satisfies the filter specified in the NameContains - * parameter.

- */ - public listWorkteams( - args: ListWorkteamsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listWorkteams( - args: ListWorkteamsCommandInput, - cb: (err: any, data?: ListWorkteamsCommandOutput) => void - ): void; - public listWorkteams( + + /** + * @see {@link ListWorkteamsCommand} + */ + listWorkteams(args: ListWorkteamsCommandInput, options?: __HttpHandlerOptions): Promise; + listWorkteams(args: ListWorkteamsCommandInput, cb: (err: any, data?: ListWorkteamsCommandOutput) => void): void; + listWorkteams( args: ListWorkteamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkteamsCommandOutput) => void ): void; - public listWorkteams( - args: ListWorkteamsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkteamsCommandOutput) => void), - cb?: (err: any, data?: ListWorkteamsCommandOutput) => void - ): Promise | void { - const command = new ListWorkteamsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds a resouce policy to control access to a model group. For information about - * resoure policies, see Identity-based - * policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..

- */ - public putModelPackageGroupPolicy( + + /** + * @see {@link PutModelPackageGroupPolicyCommand} + */ + putModelPackageGroupPolicy( args: PutModelPackageGroupPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putModelPackageGroupPolicy( + putModelPackageGroupPolicy( args: PutModelPackageGroupPolicyCommandInput, cb: (err: any, data?: PutModelPackageGroupPolicyCommandOutput) => void ): void; - public putModelPackageGroupPolicy( + putModelPackageGroupPolicy( args: PutModelPackageGroupPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutModelPackageGroupPolicyCommandOutput) => void ): void; - public putModelPackageGroupPolicy( - args: PutModelPackageGroupPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutModelPackageGroupPolicyCommandOutput) => void), - cb?: (err: any, data?: PutModelPackageGroupPolicyCommandOutput) => void - ): Promise | void { - const command = new PutModelPackageGroupPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Use this action to inspect your lineage and discover relationships between entities. - * For more information, see - * Querying Lineage Entities in the Amazon SageMaker Developer Guide.

- */ - public queryLineage( - args: QueryLineageCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public queryLineage(args: QueryLineageCommandInput, cb: (err: any, data?: QueryLineageCommandOutput) => void): void; - public queryLineage( + + /** + * @see {@link QueryLineageCommand} + */ + queryLineage(args: QueryLineageCommandInput, options?: __HttpHandlerOptions): Promise; + queryLineage(args: QueryLineageCommandInput, cb: (err: any, data?: QueryLineageCommandOutput) => void): void; + queryLineage( args: QueryLineageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryLineageCommandOutput) => void ): void; - public queryLineage( - args: QueryLineageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryLineageCommandOutput) => void), - cb?: (err: any, data?: QueryLineageCommandOutput) => void - ): Promise | void { - const command = new QueryLineageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Register devices.

- */ - public registerDevices( + + /** + * @see {@link RegisterDevicesCommand} + */ + registerDevices( args: RegisterDevicesCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerDevices( - args: RegisterDevicesCommandInput, - cb: (err: any, data?: RegisterDevicesCommandOutput) => void - ): void; - public registerDevices( + registerDevices(args: RegisterDevicesCommandInput, cb: (err: any, data?: RegisterDevicesCommandOutput) => void): void; + registerDevices( args: RegisterDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterDevicesCommandOutput) => void ): void; - public registerDevices( - args: RegisterDevicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterDevicesCommandOutput) => void), - cb?: (err: any, data?: RegisterDevicesCommandOutput) => void - ): Promise | void { - const command = new RegisterDevicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Renders the UI template so that you can preview the worker's experience.

- */ - public renderUiTemplate( + + /** + * @see {@link RenderUiTemplateCommand} + */ + renderUiTemplate( args: RenderUiTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public renderUiTemplate( + renderUiTemplate( args: RenderUiTemplateCommandInput, cb: (err: any, data?: RenderUiTemplateCommandOutput) => void ): void; - public renderUiTemplate( + renderUiTemplate( args: RenderUiTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RenderUiTemplateCommandOutput) => void ): void; - public renderUiTemplate( - args: RenderUiTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RenderUiTemplateCommandOutput) => void), - cb?: (err: any, data?: RenderUiTemplateCommandOutput) => void - ): Promise | void { - const command = new RenderUiTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retry the execution of the pipeline.

- */ - public retryPipelineExecution( + + /** + * @see {@link RetryPipelineExecutionCommand} + */ + retryPipelineExecution( args: RetryPipelineExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public retryPipelineExecution( + retryPipelineExecution( args: RetryPipelineExecutionCommandInput, cb: (err: any, data?: RetryPipelineExecutionCommandOutput) => void ): void; - public retryPipelineExecution( + retryPipelineExecution( args: RetryPipelineExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RetryPipelineExecutionCommandOutput) => void ): void; - public retryPipelineExecution( - args: RetryPipelineExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RetryPipelineExecutionCommandOutput) => void), - cb?: (err: any, data?: RetryPipelineExecutionCommandOutput) => void - ): Promise | void { - const command = new RetryPipelineExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Finds SageMaker resources that match a search query. Matching resources are returned - * as a list of SearchRecord objects in the response. You can sort the search - * results by any resource property in a ascending or descending order.

- *

You can query against the following value types: numeric, text, Boolean, and - * timestamp.

- * - *

The Search API may provide access to otherwise restricted data. See Amazon SageMaker - * API Permissions: Actions, Permissions, and Resources Reference for more - * information.

- *
- */ - public search(args: SearchCommandInput, options?: __HttpHandlerOptions): Promise; - public search(args: SearchCommandInput, cb: (err: any, data?: SearchCommandOutput) => void): void; - public search( + + /** + * @see {@link SearchCommand} + */ + search(args: SearchCommandInput, options?: __HttpHandlerOptions): Promise; + search(args: SearchCommandInput, cb: (err: any, data?: SearchCommandOutput) => void): void; + search( args: SearchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchCommandOutput) => void ): void; - public search( - args: SearchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchCommandOutput) => void), - cb?: (err: any, data?: SearchCommandOutput) => void - ): Promise | void { - const command = new SearchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Notifies the pipeline that the execution of a callback step failed, along with a - * message describing why. When a callback step is run, the pipeline generates a callback - * token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

- */ - public sendPipelineExecutionStepFailure( + + /** + * @see {@link SendPipelineExecutionStepFailureCommand} + */ + sendPipelineExecutionStepFailure( args: SendPipelineExecutionStepFailureCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendPipelineExecutionStepFailure( + sendPipelineExecutionStepFailure( args: SendPipelineExecutionStepFailureCommandInput, cb: (err: any, data?: SendPipelineExecutionStepFailureCommandOutput) => void ): void; - public sendPipelineExecutionStepFailure( + sendPipelineExecutionStepFailure( args: SendPipelineExecutionStepFailureCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendPipelineExecutionStepFailureCommandOutput) => void ): void; - public sendPipelineExecutionStepFailure( - args: SendPipelineExecutionStepFailureCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendPipelineExecutionStepFailureCommandOutput) => void), - cb?: (err: any, data?: SendPipelineExecutionStepFailureCommandOutput) => void - ): Promise | void { - const command = new SendPipelineExecutionStepFailureCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Notifies the pipeline that the execution of a callback step succeeded and provides a - * list of the step's output parameters. When a callback step is run, the pipeline generates - * a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

- */ - public sendPipelineExecutionStepSuccess( + + /** + * @see {@link SendPipelineExecutionStepSuccessCommand} + */ + sendPipelineExecutionStepSuccess( args: SendPipelineExecutionStepSuccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendPipelineExecutionStepSuccess( + sendPipelineExecutionStepSuccess( args: SendPipelineExecutionStepSuccessCommandInput, cb: (err: any, data?: SendPipelineExecutionStepSuccessCommandOutput) => void ): void; - public sendPipelineExecutionStepSuccess( + sendPipelineExecutionStepSuccess( args: SendPipelineExecutionStepSuccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendPipelineExecutionStepSuccessCommandOutput) => void ): void; - public sendPipelineExecutionStepSuccess( - args: SendPipelineExecutionStepSuccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendPipelineExecutionStepSuccessCommandOutput) => void), - cb?: (err: any, data?: SendPipelineExecutionStepSuccessCommandOutput) => void - ): Promise | void { - const command = new SendPipelineExecutionStepSuccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a stage in an edge deployment plan.

- */ - public startEdgeDeploymentStage( + + /** + * @see {@link StartEdgeDeploymentStageCommand} + */ + startEdgeDeploymentStage( args: StartEdgeDeploymentStageCommandInput, options?: __HttpHandlerOptions ): Promise; - public startEdgeDeploymentStage( + startEdgeDeploymentStage( args: StartEdgeDeploymentStageCommandInput, cb: (err: any, data?: StartEdgeDeploymentStageCommandOutput) => void ): void; - public startEdgeDeploymentStage( + startEdgeDeploymentStage( args: StartEdgeDeploymentStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartEdgeDeploymentStageCommandOutput) => void ): void; - public startEdgeDeploymentStage( - args: StartEdgeDeploymentStageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartEdgeDeploymentStageCommandOutput) => void), - cb?: (err: any, data?: StartEdgeDeploymentStageCommandOutput) => void - ): Promise | void { - const command = new StartEdgeDeploymentStageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts an inference experiment.

- */ - public startInferenceExperiment( + + /** + * @see {@link StartInferenceExperimentCommand} + */ + startInferenceExperiment( args: StartInferenceExperimentCommandInput, options?: __HttpHandlerOptions ): Promise; - public startInferenceExperiment( + startInferenceExperiment( args: StartInferenceExperimentCommandInput, cb: (err: any, data?: StartInferenceExperimentCommandOutput) => void ): void; - public startInferenceExperiment( + startInferenceExperiment( args: StartInferenceExperimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartInferenceExperimentCommandOutput) => void ): void; - public startInferenceExperiment( - args: StartInferenceExperimentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartInferenceExperimentCommandOutput) => void), - cb?: (err: any, data?: StartInferenceExperimentCommandOutput) => void - ): Promise | void { - const command = new StartInferenceExperimentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a previously stopped monitoring schedule.

- * - *

By default, when you successfully create a new schedule, the status of a monitoring - * schedule is scheduled.

- *
- */ - public startMonitoringSchedule( + + /** + * @see {@link StartMonitoringScheduleCommand} + */ + startMonitoringSchedule( args: StartMonitoringScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public startMonitoringSchedule( + startMonitoringSchedule( args: StartMonitoringScheduleCommandInput, cb: (err: any, data?: StartMonitoringScheduleCommandOutput) => void ): void; - public startMonitoringSchedule( + startMonitoringSchedule( args: StartMonitoringScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMonitoringScheduleCommandOutput) => void ): void; - public startMonitoringSchedule( - args: StartMonitoringScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartMonitoringScheduleCommandOutput) => void), - cb?: (err: any, data?: StartMonitoringScheduleCommandOutput) => void - ): Promise | void { - const command = new StartMonitoringScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Launches an ML compute instance with the latest version of the libraries and - * attaches your ML storage volume. After configuring the notebook instance, SageMaker sets the - * notebook instance status to InService. A notebook instance's status must be - * InService before you can connect to your Jupyter notebook.

- */ - public startNotebookInstance( + + /** + * @see {@link StartNotebookInstanceCommand} + */ + startNotebookInstance( args: StartNotebookInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public startNotebookInstance( + startNotebookInstance( args: StartNotebookInstanceCommandInput, cb: (err: any, data?: StartNotebookInstanceCommandOutput) => void ): void; - public startNotebookInstance( + startNotebookInstance( args: StartNotebookInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartNotebookInstanceCommandOutput) => void ): void; - public startNotebookInstance( - args: StartNotebookInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartNotebookInstanceCommandOutput) => void), - cb?: (err: any, data?: StartNotebookInstanceCommandOutput) => void - ): Promise | void { - const command = new StartNotebookInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a pipeline execution.

- */ - public startPipelineExecution( + + /** + * @see {@link StartPipelineExecutionCommand} + */ + startPipelineExecution( args: StartPipelineExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startPipelineExecution( - args: StartPipelineExecutionCommandInput, - cb: (err: any, data?: StartPipelineExecutionCommandOutput) => void - ): void; - public startPipelineExecution( + startPipelineExecution( args: StartPipelineExecutionCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: StartPipelineExecutionCommandOutput) => void - ): void; - public startPipelineExecution( - args: StartPipelineExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartPipelineExecutionCommandOutput) => void), - cb?: (err: any, data?: StartPipelineExecutionCommandOutput) => void - ): Promise | void { - const command = new StartPipelineExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

A method for forcing a running job to shut down.

- */ - public stopAutoMLJob( - args: StopAutoMLJobCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public stopAutoMLJob( - args: StopAutoMLJobCommandInput, - cb: (err: any, data?: StopAutoMLJobCommandOutput) => void + cb: (err: any, data?: StartPipelineExecutionCommandOutput) => void + ): void; + startPipelineExecution( + args: StartPipelineExecutionCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: StartPipelineExecutionCommandOutput) => void ): void; - public stopAutoMLJob( + + /** + * @see {@link StopAutoMLJobCommand} + */ + stopAutoMLJob(args: StopAutoMLJobCommandInput, options?: __HttpHandlerOptions): Promise; + stopAutoMLJob(args: StopAutoMLJobCommandInput, cb: (err: any, data?: StopAutoMLJobCommandOutput) => void): void; + stopAutoMLJob( args: StopAutoMLJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopAutoMLJobCommandOutput) => void ): void; - public stopAutoMLJob( - args: StopAutoMLJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopAutoMLJobCommandOutput) => void), - cb?: (err: any, data?: StopAutoMLJobCommandOutput) => void - ): Promise | void { - const command = new StopAutoMLJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a model compilation job.

- *

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the - * job down. If the job hasn't stopped, it sends the SIGKILL signal.

- *

When it receives a StopCompilationJob request, Amazon SageMaker changes the CompilationJobSummary$CompilationJobStatus of the job to - * Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobSummary$CompilationJobStatus to Stopped. - *

- */ - public stopCompilationJob( + + /** + * @see {@link StopCompilationJobCommand} + */ + stopCompilationJob( args: StopCompilationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopCompilationJob( + stopCompilationJob( args: StopCompilationJobCommandInput, cb: (err: any, data?: StopCompilationJobCommandOutput) => void ): void; - public stopCompilationJob( + stopCompilationJob( args: StopCompilationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopCompilationJobCommandOutput) => void ): void; - public stopCompilationJob( - args: StopCompilationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopCompilationJobCommandOutput) => void), - cb?: (err: any, data?: StopCompilationJobCommandOutput) => void - ): Promise | void { - const command = new StopCompilationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a stage in an edge deployment plan.

- */ - public stopEdgeDeploymentStage( + + /** + * @see {@link StopEdgeDeploymentStageCommand} + */ + stopEdgeDeploymentStage( args: StopEdgeDeploymentStageCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopEdgeDeploymentStage( + stopEdgeDeploymentStage( args: StopEdgeDeploymentStageCommandInput, cb: (err: any, data?: StopEdgeDeploymentStageCommandOutput) => void ): void; - public stopEdgeDeploymentStage( + stopEdgeDeploymentStage( args: StopEdgeDeploymentStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopEdgeDeploymentStageCommandOutput) => void ): void; - public stopEdgeDeploymentStage( - args: StopEdgeDeploymentStageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopEdgeDeploymentStageCommandOutput) => void), - cb?: (err: any, data?: StopEdgeDeploymentStageCommandOutput) => void - ): Promise | void { - const command = new StopEdgeDeploymentStageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Request to stop an edge packaging job.

- */ - public stopEdgePackagingJob( + + /** + * @see {@link StopEdgePackagingJobCommand} + */ + stopEdgePackagingJob( args: StopEdgePackagingJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopEdgePackagingJob( + stopEdgePackagingJob( args: StopEdgePackagingJobCommandInput, cb: (err: any, data?: StopEdgePackagingJobCommandOutput) => void ): void; - public stopEdgePackagingJob( + stopEdgePackagingJob( args: StopEdgePackagingJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopEdgePackagingJobCommandOutput) => void ): void; - public stopEdgePackagingJob( - args: StopEdgePackagingJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopEdgePackagingJobCommandOutput) => void), - cb?: (err: any, data?: StopEdgePackagingJobCommandOutput) => void - ): Promise | void { - const command = new StopEdgePackagingJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a running hyperparameter tuning job and all running training jobs that the - * tuning job launched.

- *

All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All - * data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the - * tuning job moves to the Stopped state, it releases all - * reserved - * resources for the tuning job.

- */ - public stopHyperParameterTuningJob( + + /** + * @see {@link StopHyperParameterTuningJobCommand} + */ + stopHyperParameterTuningJob( args: StopHyperParameterTuningJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopHyperParameterTuningJob( + stopHyperParameterTuningJob( args: StopHyperParameterTuningJobCommandInput, cb: (err: any, data?: StopHyperParameterTuningJobCommandOutput) => void ): void; - public stopHyperParameterTuningJob( + stopHyperParameterTuningJob( args: StopHyperParameterTuningJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopHyperParameterTuningJobCommandOutput) => void ): void; - public stopHyperParameterTuningJob( - args: StopHyperParameterTuningJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopHyperParameterTuningJobCommandOutput) => void), - cb?: (err: any, data?: StopHyperParameterTuningJobCommandOutput) => void - ): Promise | void { - const command = new StopHyperParameterTuningJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops an inference experiment.

- */ - public stopInferenceExperiment( + + /** + * @see {@link StopInferenceExperimentCommand} + */ + stopInferenceExperiment( args: StopInferenceExperimentCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopInferenceExperiment( + stopInferenceExperiment( args: StopInferenceExperimentCommandInput, cb: (err: any, data?: StopInferenceExperimentCommandOutput) => void ): void; - public stopInferenceExperiment( + stopInferenceExperiment( args: StopInferenceExperimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopInferenceExperimentCommandOutput) => void ): void; - public stopInferenceExperiment( - args: StopInferenceExperimentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopInferenceExperimentCommandOutput) => void), - cb?: (err: any, data?: StopInferenceExperimentCommandOutput) => void - ): Promise | void { - const command = new StopInferenceExperimentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops an Inference Recommender job.

- */ - public stopInferenceRecommendationsJob( + + /** + * @see {@link StopInferenceRecommendationsJobCommand} + */ + stopInferenceRecommendationsJob( args: StopInferenceRecommendationsJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopInferenceRecommendationsJob( + stopInferenceRecommendationsJob( args: StopInferenceRecommendationsJobCommandInput, cb: (err: any, data?: StopInferenceRecommendationsJobCommandOutput) => void ): void; - public stopInferenceRecommendationsJob( + stopInferenceRecommendationsJob( args: StopInferenceRecommendationsJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopInferenceRecommendationsJobCommandOutput) => void ): void; - public stopInferenceRecommendationsJob( - args: StopInferenceRecommendationsJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopInferenceRecommendationsJobCommandOutput) => void), - cb?: (err: any, data?: StopInferenceRecommendationsJobCommandOutput) => void - ): Promise | void { - const command = new StopInferenceRecommendationsJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a running labeling job. A job that is stopped cannot be restarted. Any results - * obtained before the job is stopped are placed in the Amazon S3 output bucket.

- */ - public stopLabelingJob( + + /** + * @see {@link StopLabelingJobCommand} + */ + stopLabelingJob( args: StopLabelingJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopLabelingJob( - args: StopLabelingJobCommandInput, - cb: (err: any, data?: StopLabelingJobCommandOutput) => void - ): void; - public stopLabelingJob( + stopLabelingJob(args: StopLabelingJobCommandInput, cb: (err: any, data?: StopLabelingJobCommandOutput) => void): void; + stopLabelingJob( args: StopLabelingJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopLabelingJobCommandOutput) => void ): void; - public stopLabelingJob( - args: StopLabelingJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopLabelingJobCommandOutput) => void), - cb?: (err: any, data?: StopLabelingJobCommandOutput) => void - ): Promise | void { - const command = new StopLabelingJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a previously started monitoring schedule.

- */ - public stopMonitoringSchedule( + + /** + * @see {@link StopMonitoringScheduleCommand} + */ + stopMonitoringSchedule( args: StopMonitoringScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopMonitoringSchedule( + stopMonitoringSchedule( args: StopMonitoringScheduleCommandInput, cb: (err: any, data?: StopMonitoringScheduleCommandOutput) => void ): void; - public stopMonitoringSchedule( + stopMonitoringSchedule( args: StopMonitoringScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopMonitoringScheduleCommandOutput) => void ): void; - public stopMonitoringSchedule( - args: StopMonitoringScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopMonitoringScheduleCommandOutput) => void), - cb?: (err: any, data?: StopMonitoringScheduleCommandOutput) => void - ): Promise | void { - const command = new StopMonitoringScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Terminates the ML compute instance. Before terminating the instance, SageMaker - * disconnects the ML storage volume from it. SageMaker preserves the ML storage volume. SageMaker - * stops charging you for the ML compute instance when you call - * StopNotebookInstance.

- *

To access data on the ML storage volume for a notebook instance that has been - * terminated, call the StartNotebookInstance API. - * StartNotebookInstance launches another ML compute instance, configures - * it, and attaches the preserved ML storage volume so you can continue your work. - *

- */ - public stopNotebookInstance( + + /** + * @see {@link StopNotebookInstanceCommand} + */ + stopNotebookInstance( args: StopNotebookInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopNotebookInstance( + stopNotebookInstance( args: StopNotebookInstanceCommandInput, cb: (err: any, data?: StopNotebookInstanceCommandOutput) => void ): void; - public stopNotebookInstance( + stopNotebookInstance( args: StopNotebookInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopNotebookInstanceCommandOutput) => void ): void; - public stopNotebookInstance( - args: StopNotebookInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopNotebookInstanceCommandOutput) => void), - cb?: (err: any, data?: StopNotebookInstanceCommandOutput) => void - ): Promise | void { - const command = new StopNotebookInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a pipeline execution.

- *

- * Callback Step - *

- *

A pipeline execution won't stop while a callback step is running. - * When you call StopPipelineExecution - * on a pipeline execution with a running callback step, SageMaker Pipelines sends an - * additional Amazon SQS message to the specified SQS queue. The body of the SQS message - * contains a "Status" field which is set to "Stopping".

- *

You should add logic to your Amazon SQS message consumer to take any needed action (for - * example, resource cleanup) upon receipt of the message followed by a call to - * SendPipelineExecutionStepSuccess or - * SendPipelineExecutionStepFailure.

- *

Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.

- *

- * Lambda Step - *

- *

A pipeline execution can't be stopped while a lambda step is running because the Lambda - * function invoked by the lambda step can't be stopped. If you attempt to stop the execution - * while the Lambda function is running, the pipeline waits for the Lambda function to finish - * or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function - * finishes, the pipeline execution status is Stopped. If the timeout is hit - * the pipeline execution status is Failed.

- */ - public stopPipelineExecution( + + /** + * @see {@link StopPipelineExecutionCommand} + */ + stopPipelineExecution( args: StopPipelineExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopPipelineExecution( + stopPipelineExecution( args: StopPipelineExecutionCommandInput, cb: (err: any, data?: StopPipelineExecutionCommandOutput) => void ): void; - public stopPipelineExecution( + stopPipelineExecution( args: StopPipelineExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopPipelineExecutionCommandOutput) => void ): void; - public stopPipelineExecution( - args: StopPipelineExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopPipelineExecutionCommandOutput) => void), - cb?: (err: any, data?: StopPipelineExecutionCommandOutput) => void - ): Promise | void { - const command = new StopPipelineExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a processing job.

- */ - public stopProcessingJob( + + /** + * @see {@link StopProcessingJobCommand} + */ + stopProcessingJob( args: StopProcessingJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopProcessingJob( + stopProcessingJob( args: StopProcessingJobCommandInput, cb: (err: any, data?: StopProcessingJobCommandOutput) => void ): void; - public stopProcessingJob( + stopProcessingJob( args: StopProcessingJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopProcessingJobCommandOutput) => void ): void; - public stopProcessingJob( - args: StopProcessingJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopProcessingJobCommandOutput) => void), - cb?: (err: any, data?: StopProcessingJobCommandOutput) => void - ): Promise | void { - const command = new StopProcessingJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a training job. To stop a job, SageMaker sends the algorithm the - * SIGTERM signal, which delays job termination for 120 seconds. - * Algorithms might use this 120-second window to save the model artifacts, so the results - * of the training is not lost.

- *

When it receives a StopTrainingJob request, SageMaker changes the status of - * the job to Stopping. After SageMaker stops the job, it sets the status to - * Stopped.

- */ - public stopTrainingJob( + + /** + * @see {@link StopTrainingJobCommand} + */ + stopTrainingJob( args: StopTrainingJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopTrainingJob( - args: StopTrainingJobCommandInput, - cb: (err: any, data?: StopTrainingJobCommandOutput) => void - ): void; - public stopTrainingJob( + stopTrainingJob(args: StopTrainingJobCommandInput, cb: (err: any, data?: StopTrainingJobCommandOutput) => void): void; + stopTrainingJob( args: StopTrainingJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopTrainingJobCommandOutput) => void ): void; - public stopTrainingJob( - args: StopTrainingJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopTrainingJobCommandOutput) => void), - cb?: (err: any, data?: StopTrainingJobCommandOutput) => void - ): Promise | void { - const command = new StopTrainingJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a batch transform job.

- *

When Amazon SageMaker receives a StopTransformJob request, the status of the job - * changes to Stopping. After Amazon SageMaker - * stops - * the job, the status is set to Stopped. When you stop a batch transform job before - * it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.

- */ - public stopTransformJob( + + /** + * @see {@link StopTransformJobCommand} + */ + stopTransformJob( args: StopTransformJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopTransformJob( + stopTransformJob( args: StopTransformJobCommandInput, cb: (err: any, data?: StopTransformJobCommandOutput) => void ): void; - public stopTransformJob( + stopTransformJob( args: StopTransformJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopTransformJobCommandOutput) => void ): void; - public stopTransformJob( - args: StopTransformJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopTransformJobCommandOutput) => void), - cb?: (err: any, data?: StopTransformJobCommandOutput) => void - ): Promise | void { - const command = new StopTransformJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an action.

- */ - public updateAction( - args: UpdateActionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateAction(args: UpdateActionCommandInput, cb: (err: any, data?: UpdateActionCommandOutput) => void): void; - public updateAction( + + /** + * @see {@link UpdateActionCommand} + */ + updateAction(args: UpdateActionCommandInput, options?: __HttpHandlerOptions): Promise; + updateAction(args: UpdateActionCommandInput, cb: (err: any, data?: UpdateActionCommandOutput) => void): void; + updateAction( args: UpdateActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateActionCommandOutput) => void ): void; - public updateAction( - args: UpdateActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateActionCommandOutput) => void), - cb?: (err: any, data?: UpdateActionCommandOutput) => void - ): Promise | void { - const command = new UpdateActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the properties of an AppImageConfig.

- */ - public updateAppImageConfig( + + /** + * @see {@link UpdateAppImageConfigCommand} + */ + updateAppImageConfig( args: UpdateAppImageConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAppImageConfig( + updateAppImageConfig( args: UpdateAppImageConfigCommandInput, cb: (err: any, data?: UpdateAppImageConfigCommandOutput) => void ): void; - public updateAppImageConfig( + updateAppImageConfig( args: UpdateAppImageConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAppImageConfigCommandOutput) => void ): void; - public updateAppImageConfig( - args: UpdateAppImageConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAppImageConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateAppImageConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateAppImageConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an artifact.

- */ - public updateArtifact( + + /** + * @see {@link UpdateArtifactCommand} + */ + updateArtifact( args: UpdateArtifactCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateArtifact( - args: UpdateArtifactCommandInput, - cb: (err: any, data?: UpdateArtifactCommandOutput) => void - ): void; - public updateArtifact( + updateArtifact(args: UpdateArtifactCommandInput, cb: (err: any, data?: UpdateArtifactCommandOutput) => void): void; + updateArtifact( args: UpdateArtifactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateArtifactCommandOutput) => void ): void; - public updateArtifact( - args: UpdateArtifactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateArtifactCommandOutput) => void), - cb?: (err: any, data?: UpdateArtifactCommandOutput) => void - ): Promise | void { - const command = new UpdateArtifactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the specified Git repository with the specified values.

- */ - public updateCodeRepository( + + /** + * @see {@link UpdateCodeRepositoryCommand} + */ + updateCodeRepository( args: UpdateCodeRepositoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCodeRepository( + updateCodeRepository( args: UpdateCodeRepositoryCommandInput, cb: (err: any, data?: UpdateCodeRepositoryCommandOutput) => void ): void; - public updateCodeRepository( + updateCodeRepository( args: UpdateCodeRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCodeRepositoryCommandOutput) => void ): void; - public updateCodeRepository( - args: UpdateCodeRepositoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCodeRepositoryCommandOutput) => void), - cb?: (err: any, data?: UpdateCodeRepositoryCommandOutput) => void - ): Promise | void { - const command = new UpdateCodeRepositoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a context.

- */ - public updateContext( - args: UpdateContextCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateContext( - args: UpdateContextCommandInput, - cb: (err: any, data?: UpdateContextCommandOutput) => void - ): void; - public updateContext( + + /** + * @see {@link UpdateContextCommand} + */ + updateContext(args: UpdateContextCommandInput, options?: __HttpHandlerOptions): Promise; + updateContext(args: UpdateContextCommandInput, cb: (err: any, data?: UpdateContextCommandOutput) => void): void; + updateContext( args: UpdateContextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContextCommandOutput) => void ): void; - public updateContext( - args: UpdateContextCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateContextCommandOutput) => void), - cb?: (err: any, data?: UpdateContextCommandOutput) => void - ): Promise | void { - const command = new UpdateContextCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a fleet of devices.

- */ - public updateDeviceFleet( + + /** + * @see {@link UpdateDeviceFleetCommand} + */ + updateDeviceFleet( args: UpdateDeviceFleetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDeviceFleet( + updateDeviceFleet( args: UpdateDeviceFleetCommandInput, cb: (err: any, data?: UpdateDeviceFleetCommandOutput) => void ): void; - public updateDeviceFleet( + updateDeviceFleet( args: UpdateDeviceFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDeviceFleetCommandOutput) => void ): void; - public updateDeviceFleet( - args: UpdateDeviceFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDeviceFleetCommandOutput) => void), - cb?: (err: any, data?: UpdateDeviceFleetCommandOutput) => void - ): Promise | void { - const command = new UpdateDeviceFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates one or more devices in a fleet.

- */ - public updateDevices( - args: UpdateDevicesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateDevices( - args: UpdateDevicesCommandInput, - cb: (err: any, data?: UpdateDevicesCommandOutput) => void - ): void; - public updateDevices( + + /** + * @see {@link UpdateDevicesCommand} + */ + updateDevices(args: UpdateDevicesCommandInput, options?: __HttpHandlerOptions): Promise; + updateDevices(args: UpdateDevicesCommandInput, cb: (err: any, data?: UpdateDevicesCommandOutput) => void): void; + updateDevices( args: UpdateDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDevicesCommandOutput) => void ): void; - public updateDevices( - args: UpdateDevicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDevicesCommandOutput) => void), - cb?: (err: any, data?: UpdateDevicesCommandOutput) => void - ): Promise | void { - const command = new UpdateDevicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the default settings for new user profiles in the domain.

- */ - public updateDomain( - args: UpdateDomainCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateDomain(args: UpdateDomainCommandInput, cb: (err: any, data?: UpdateDomainCommandOutput) => void): void; - public updateDomain( + + /** + * @see {@link UpdateDomainCommand} + */ + updateDomain(args: UpdateDomainCommandInput, options?: __HttpHandlerOptions): Promise; + updateDomain(args: UpdateDomainCommandInput, cb: (err: any, data?: UpdateDomainCommandOutput) => void): void; + updateDomain( args: UpdateDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDomainCommandOutput) => void ): void; - public updateDomain( - args: UpdateDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDomainCommandOutput) => void), - cb?: (err: any, data?: UpdateDomainCommandOutput) => void - ): Promise | void { - const command = new UpdateDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deploys the new EndpointConfig specified in the request, switches to - * using newly created endpoint, and then deletes resources provisioned for the endpoint - * using the previous EndpointConfig (there is no availability loss).

- *

When SageMaker receives the request, it sets the endpoint status to - * Updating. After updating the endpoint, it sets the status to - * InService. To check the status of an endpoint, use the DescribeEndpoint API. - * - *

- * - *

You must not delete an EndpointConfig in use by an endpoint that is - * live or while the UpdateEndpoint or CreateEndpoint - * operations are being performed on the endpoint. To update an endpoint, you must - * create a new EndpointConfig.

- *

If you delete the EndpointConfig of an endpoint that is active or - * being created or updated you may lose visibility into the instance type the endpoint - * is using. The endpoint must be deleted in order to stop incurring charges.

- *
- */ - public updateEndpoint( + + /** + * @see {@link UpdateEndpointCommand} + */ + updateEndpoint( args: UpdateEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEndpoint( - args: UpdateEndpointCommandInput, - cb: (err: any, data?: UpdateEndpointCommandOutput) => void - ): void; - public updateEndpoint( + updateEndpoint(args: UpdateEndpointCommandInput, cb: (err: any, data?: UpdateEndpointCommandOutput) => void): void; + updateEndpoint( args: UpdateEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEndpointCommandOutput) => void ): void; - public updateEndpoint( - args: UpdateEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEndpointCommandOutput) => void), - cb?: (err: any, data?: UpdateEndpointCommandOutput) => void - ): Promise | void { - const command = new UpdateEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates variant weight of one or more variants associated with an existing - * endpoint, or capacity of one variant associated with an existing endpoint. When it - * receives the request, SageMaker sets the endpoint status to Updating. After - * updating the endpoint, it sets the status to InService. To check the status - * of an endpoint, use the DescribeEndpoint API.

- */ - public updateEndpointWeightsAndCapacities( + + /** + * @see {@link UpdateEndpointWeightsAndCapacitiesCommand} + */ + updateEndpointWeightsAndCapacities( args: UpdateEndpointWeightsAndCapacitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEndpointWeightsAndCapacities( + updateEndpointWeightsAndCapacities( args: UpdateEndpointWeightsAndCapacitiesCommandInput, cb: (err: any, data?: UpdateEndpointWeightsAndCapacitiesCommandOutput) => void ): void; - public updateEndpointWeightsAndCapacities( + updateEndpointWeightsAndCapacities( args: UpdateEndpointWeightsAndCapacitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEndpointWeightsAndCapacitiesCommandOutput) => void ): void; - public updateEndpointWeightsAndCapacities( - args: UpdateEndpointWeightsAndCapacitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEndpointWeightsAndCapacitiesCommandOutput) => void), - cb?: (err: any, data?: UpdateEndpointWeightsAndCapacitiesCommandOutput) => void - ): Promise | void { - const command = new UpdateEndpointWeightsAndCapacitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds, updates, or removes the description of an experiment. Updates the display name of an - * experiment.

- */ - public updateExperiment( + + /** + * @see {@link UpdateExperimentCommand} + */ + updateExperiment( args: UpdateExperimentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateExperiment( + updateExperiment( args: UpdateExperimentCommandInput, cb: (err: any, data?: UpdateExperimentCommandOutput) => void ): void; - public updateExperiment( + updateExperiment( args: UpdateExperimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateExperimentCommandOutput) => void ): void; - public updateExperiment( - args: UpdateExperimentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateExperimentCommandOutput) => void), - cb?: (err: any, data?: UpdateExperimentCommandOutput) => void - ): Promise | void { - const command = new UpdateExperimentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the feature group.

- */ - public updateFeatureGroup( + + /** + * @see {@link UpdateFeatureGroupCommand} + */ + updateFeatureGroup( args: UpdateFeatureGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFeatureGroup( + updateFeatureGroup( args: UpdateFeatureGroupCommandInput, cb: (err: any, data?: UpdateFeatureGroupCommandOutput) => void ): void; - public updateFeatureGroup( + updateFeatureGroup( args: UpdateFeatureGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFeatureGroupCommandOutput) => void ): void; - public updateFeatureGroup( - args: UpdateFeatureGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFeatureGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateFeatureGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateFeatureGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the description and parameters of the feature group.

- */ - public updateFeatureMetadata( + + /** + * @see {@link UpdateFeatureMetadataCommand} + */ + updateFeatureMetadata( args: UpdateFeatureMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFeatureMetadata( + updateFeatureMetadata( args: UpdateFeatureMetadataCommandInput, cb: (err: any, data?: UpdateFeatureMetadataCommandOutput) => void ): void; - public updateFeatureMetadata( + updateFeatureMetadata( args: UpdateFeatureMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFeatureMetadataCommandOutput) => void ): void; - public updateFeatureMetadata( - args: UpdateFeatureMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFeatureMetadataCommandOutput) => void), - cb?: (err: any, data?: UpdateFeatureMetadataCommandOutput) => void - ): Promise | void { - const command = new UpdateFeatureMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update a hub.

- * - *

Hub APIs are only callable through SageMaker Studio.

- *
- */ - public updateHub(args: UpdateHubCommandInput, options?: __HttpHandlerOptions): Promise; - public updateHub(args: UpdateHubCommandInput, cb: (err: any, data?: UpdateHubCommandOutput) => void): void; - public updateHub( + + /** + * @see {@link UpdateHubCommand} + */ + updateHub(args: UpdateHubCommandInput, options?: __HttpHandlerOptions): Promise; + updateHub(args: UpdateHubCommandInput, cb: (err: any, data?: UpdateHubCommandOutput) => void): void; + updateHub( args: UpdateHubCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateHubCommandOutput) => void ): void; - public updateHub( - args: UpdateHubCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateHubCommandOutput) => void), - cb?: (err: any, data?: UpdateHubCommandOutput) => void - ): Promise | void { - const command = new UpdateHubCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the properties of a SageMaker image. To change the image's tags, use the - * AddTags and DeleteTags APIs.

- */ - public updateImage(args: UpdateImageCommandInput, options?: __HttpHandlerOptions): Promise; - public updateImage(args: UpdateImageCommandInput, cb: (err: any, data?: UpdateImageCommandOutput) => void): void; - public updateImage( + + /** + * @see {@link UpdateImageCommand} + */ + updateImage(args: UpdateImageCommandInput, options?: __HttpHandlerOptions): Promise; + updateImage(args: UpdateImageCommandInput, cb: (err: any, data?: UpdateImageCommandOutput) => void): void; + updateImage( args: UpdateImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateImageCommandOutput) => void ): void; - public updateImage( - args: UpdateImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateImageCommandOutput) => void), - cb?: (err: any, data?: UpdateImageCommandOutput) => void - ): Promise | void { - const command = new UpdateImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the properties of a SageMaker image version.

- */ - public updateImageVersion( + + /** + * @see {@link UpdateImageVersionCommand} + */ + updateImageVersion( args: UpdateImageVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateImageVersion( + updateImageVersion( args: UpdateImageVersionCommandInput, cb: (err: any, data?: UpdateImageVersionCommandOutput) => void ): void; - public updateImageVersion( + updateImageVersion( args: UpdateImageVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateImageVersionCommandOutput) => void ): void; - public updateImageVersion( - args: UpdateImageVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateImageVersionCommandOutput) => void), - cb?: (err: any, data?: UpdateImageVersionCommandOutput) => void - ): Promise | void { - const command = new UpdateImageVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Updates an inference experiment that you created. The status of the inference experiment has to be either - * Created, Running. For more information on the status of an inference experiment, - * see DescribeInferenceExperimentResponse$Status. - *

- */ - public updateInferenceExperiment( + + /** + * @see {@link UpdateInferenceExperimentCommand} + */ + updateInferenceExperiment( args: UpdateInferenceExperimentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateInferenceExperiment( + updateInferenceExperiment( args: UpdateInferenceExperimentCommandInput, cb: (err: any, data?: UpdateInferenceExperimentCommandOutput) => void ): void; - public updateInferenceExperiment( + updateInferenceExperiment( args: UpdateInferenceExperimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateInferenceExperimentCommandOutput) => void ): void; - public updateInferenceExperiment( - args: UpdateInferenceExperimentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateInferenceExperimentCommandOutput) => void), - cb?: (err: any, data?: UpdateInferenceExperimentCommandOutput) => void - ): Promise | void { - const command = new UpdateInferenceExperimentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update an Amazon SageMaker Model Card.

- * - *

You cannot update both model card content and model card status in a single call.

- *
- */ - public updateModelCard( + + /** + * @see {@link UpdateModelCardCommand} + */ + updateModelCard( args: UpdateModelCardCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateModelCard( - args: UpdateModelCardCommandInput, - cb: (err: any, data?: UpdateModelCardCommandOutput) => void - ): void; - public updateModelCard( + updateModelCard(args: UpdateModelCardCommandInput, cb: (err: any, data?: UpdateModelCardCommandOutput) => void): void; + updateModelCard( args: UpdateModelCardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateModelCardCommandOutput) => void ): void; - public updateModelCard( - args: UpdateModelCardCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateModelCardCommandOutput) => void), - cb?: (err: any, data?: UpdateModelCardCommandOutput) => void - ): Promise | void { - const command = new UpdateModelCardCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a versioned model.

- */ - public updateModelPackage( + + /** + * @see {@link UpdateModelPackageCommand} + */ + updateModelPackage( args: UpdateModelPackageCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateModelPackage( + updateModelPackage( args: UpdateModelPackageCommandInput, cb: (err: any, data?: UpdateModelPackageCommandOutput) => void ): void; - public updateModelPackage( + updateModelPackage( args: UpdateModelPackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateModelPackageCommandOutput) => void ): void; - public updateModelPackage( - args: UpdateModelPackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateModelPackageCommandOutput) => void), - cb?: (err: any, data?: UpdateModelPackageCommandOutput) => void - ): Promise | void { - const command = new UpdateModelPackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update the parameters of a model monitor alert.

- */ - public updateMonitoringAlert( + + /** + * @see {@link UpdateMonitoringAlertCommand} + */ + updateMonitoringAlert( args: UpdateMonitoringAlertCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMonitoringAlert( + updateMonitoringAlert( args: UpdateMonitoringAlertCommandInput, cb: (err: any, data?: UpdateMonitoringAlertCommandOutput) => void ): void; - public updateMonitoringAlert( + updateMonitoringAlert( args: UpdateMonitoringAlertCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMonitoringAlertCommandOutput) => void ): void; - public updateMonitoringAlert( - args: UpdateMonitoringAlertCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMonitoringAlertCommandOutput) => void), - cb?: (err: any, data?: UpdateMonitoringAlertCommandOutput) => void - ): Promise | void { - const command = new UpdateMonitoringAlertCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a previously created schedule.

- */ - public updateMonitoringSchedule( + + /** + * @see {@link UpdateMonitoringScheduleCommand} + */ + updateMonitoringSchedule( args: UpdateMonitoringScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMonitoringSchedule( + updateMonitoringSchedule( args: UpdateMonitoringScheduleCommandInput, cb: (err: any, data?: UpdateMonitoringScheduleCommandOutput) => void ): void; - public updateMonitoringSchedule( + updateMonitoringSchedule( args: UpdateMonitoringScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMonitoringScheduleCommandOutput) => void ): void; - public updateMonitoringSchedule( - args: UpdateMonitoringScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMonitoringScheduleCommandOutput) => void), - cb?: (err: any, data?: UpdateMonitoringScheduleCommandOutput) => void - ): Promise | void { - const command = new UpdateMonitoringScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a notebook instance. NotebookInstance updates include upgrading or - * downgrading the ML compute instance used for your notebook instance to accommodate - * changes in your workload requirements.

- */ - public updateNotebookInstance( + + /** + * @see {@link UpdateNotebookInstanceCommand} + */ + updateNotebookInstance( args: UpdateNotebookInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateNotebookInstance( + updateNotebookInstance( args: UpdateNotebookInstanceCommandInput, cb: (err: any, data?: UpdateNotebookInstanceCommandOutput) => void ): void; - public updateNotebookInstance( + updateNotebookInstance( args: UpdateNotebookInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNotebookInstanceCommandOutput) => void ): void; - public updateNotebookInstance( - args: UpdateNotebookInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateNotebookInstanceCommandOutput) => void), - cb?: (err: any, data?: UpdateNotebookInstanceCommandOutput) => void - ): Promise | void { - const command = new UpdateNotebookInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.

- */ - public updateNotebookInstanceLifecycleConfig( + + /** + * @see {@link UpdateNotebookInstanceLifecycleConfigCommand} + */ + updateNotebookInstanceLifecycleConfig( args: UpdateNotebookInstanceLifecycleConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateNotebookInstanceLifecycleConfig( + updateNotebookInstanceLifecycleConfig( args: UpdateNotebookInstanceLifecycleConfigCommandInput, cb: (err: any, data?: UpdateNotebookInstanceLifecycleConfigCommandOutput) => void ): void; - public updateNotebookInstanceLifecycleConfig( + updateNotebookInstanceLifecycleConfig( args: UpdateNotebookInstanceLifecycleConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNotebookInstanceLifecycleConfigCommandOutput) => void ): void; - public updateNotebookInstanceLifecycleConfig( - args: UpdateNotebookInstanceLifecycleConfigCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateNotebookInstanceLifecycleConfigCommandOutput) => void), - cb?: (err: any, data?: UpdateNotebookInstanceLifecycleConfigCommandOutput) => void - ): Promise | void { - const command = new UpdateNotebookInstanceLifecycleConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a pipeline.

- */ - public updatePipeline( + + /** + * @see {@link UpdatePipelineCommand} + */ + updatePipeline( args: UpdatePipelineCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePipeline( - args: UpdatePipelineCommandInput, - cb: (err: any, data?: UpdatePipelineCommandOutput) => void - ): void; - public updatePipeline( + updatePipeline(args: UpdatePipelineCommandInput, cb: (err: any, data?: UpdatePipelineCommandOutput) => void): void; + updatePipeline( args: UpdatePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePipelineCommandOutput) => void ): void; - public updatePipeline( - args: UpdatePipelineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePipelineCommandOutput) => void), - cb?: (err: any, data?: UpdatePipelineCommandOutput) => void - ): Promise | void { - const command = new UpdatePipelineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a pipeline execution.

- */ - public updatePipelineExecution( + + /** + * @see {@link UpdatePipelineExecutionCommand} + */ + updatePipelineExecution( args: UpdatePipelineExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePipelineExecution( + updatePipelineExecution( args: UpdatePipelineExecutionCommandInput, cb: (err: any, data?: UpdatePipelineExecutionCommandOutput) => void ): void; - public updatePipelineExecution( + updatePipelineExecution( args: UpdatePipelineExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePipelineExecutionCommandOutput) => void ): void; - public updatePipelineExecution( - args: UpdatePipelineExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePipelineExecutionCommandOutput) => void), - cb?: (err: any, data?: UpdatePipelineExecutionCommandOutput) => void - ): Promise | void { - const command = new UpdatePipelineExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a machine learning (ML) project that is created from a template that - * sets up an ML pipeline from training to deploying an approved model.

- * - *

You must not update a project that is in use. If you update the - * ServiceCatalogProvisioningUpdateDetails of a project that is active - * or being created, or updated, you may lose resources already created by the - * project.

- *
- */ - public updateProject( - args: UpdateProjectCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateProject( - args: UpdateProjectCommandInput, - cb: (err: any, data?: UpdateProjectCommandOutput) => void - ): void; - public updateProject( + + /** + * @see {@link UpdateProjectCommand} + */ + updateProject(args: UpdateProjectCommandInput, options?: __HttpHandlerOptions): Promise; + updateProject(args: UpdateProjectCommandInput, cb: (err: any, data?: UpdateProjectCommandOutput) => void): void; + updateProject( args: UpdateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProjectCommandOutput) => void ): void; - public updateProject( - args: UpdateProjectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProjectCommandOutput) => void), - cb?: (err: any, data?: UpdateProjectCommandOutput) => void - ): Promise | void { - const command = new UpdateProjectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the settings of a space.

- */ - public updateSpace(args: UpdateSpaceCommandInput, options?: __HttpHandlerOptions): Promise; - public updateSpace(args: UpdateSpaceCommandInput, cb: (err: any, data?: UpdateSpaceCommandOutput) => void): void; - public updateSpace( + + /** + * @see {@link UpdateSpaceCommand} + */ + updateSpace(args: UpdateSpaceCommandInput, options?: __HttpHandlerOptions): Promise; + updateSpace(args: UpdateSpaceCommandInput, cb: (err: any, data?: UpdateSpaceCommandOutput) => void): void; + updateSpace( args: UpdateSpaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSpaceCommandOutput) => void ): void; - public updateSpace( - args: UpdateSpaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSpaceCommandOutput) => void), - cb?: (err: any, data?: UpdateSpaceCommandOutput) => void - ): Promise | void { - const command = new UpdateSpaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update a model training job to request a new Debugger profiling configuration or to - * change warm pool retention length.

- */ - public updateTrainingJob( + + /** + * @see {@link UpdateTrainingJobCommand} + */ + updateTrainingJob( args: UpdateTrainingJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTrainingJob( + updateTrainingJob( args: UpdateTrainingJobCommandInput, cb: (err: any, data?: UpdateTrainingJobCommandOutput) => void ): void; - public updateTrainingJob( + updateTrainingJob( args: UpdateTrainingJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTrainingJobCommandOutput) => void ): void; - public updateTrainingJob( - args: UpdateTrainingJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTrainingJobCommandOutput) => void), - cb?: (err: any, data?: UpdateTrainingJobCommandOutput) => void - ): Promise | void { - const command = new UpdateTrainingJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the display name of a trial.

- */ - public updateTrial(args: UpdateTrialCommandInput, options?: __HttpHandlerOptions): Promise; - public updateTrial(args: UpdateTrialCommandInput, cb: (err: any, data?: UpdateTrialCommandOutput) => void): void; - public updateTrial( + + /** + * @see {@link UpdateTrialCommand} + */ + updateTrial(args: UpdateTrialCommandInput, options?: __HttpHandlerOptions): Promise; + updateTrial(args: UpdateTrialCommandInput, cb: (err: any, data?: UpdateTrialCommandOutput) => void): void; + updateTrial( args: UpdateTrialCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTrialCommandOutput) => void ): void; - public updateTrial( - args: UpdateTrialCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTrialCommandOutput) => void), - cb?: (err: any, data?: UpdateTrialCommandOutput) => void - ): Promise | void { - const command = new UpdateTrialCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates one or more properties of a trial component.

- */ - public updateTrialComponent( + + /** + * @see {@link UpdateTrialComponentCommand} + */ + updateTrialComponent( args: UpdateTrialComponentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTrialComponent( + updateTrialComponent( args: UpdateTrialComponentCommandInput, cb: (err: any, data?: UpdateTrialComponentCommandOutput) => void ): void; - public updateTrialComponent( + updateTrialComponent( args: UpdateTrialComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTrialComponentCommandOutput) => void ): void; - public updateTrialComponent( - args: UpdateTrialComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTrialComponentCommandOutput) => void), - cb?: (err: any, data?: UpdateTrialComponentCommandOutput) => void - ): Promise | void { - const command = new UpdateTrialComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a user profile.

- */ - public updateUserProfile( + + /** + * @see {@link UpdateUserProfileCommand} + */ + updateUserProfile( args: UpdateUserProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateUserProfile( + updateUserProfile( args: UpdateUserProfileCommandInput, cb: (err: any, data?: UpdateUserProfileCommandOutput) => void ): void; - public updateUserProfile( + updateUserProfile( args: UpdateUserProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserProfileCommandOutput) => void ): void; - public updateUserProfile( - args: UpdateUserProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserProfileCommandOutput) => void), - cb?: (err: any, data?: UpdateUserProfileCommandOutput) => void - ): Promise | void { - const command = new UpdateUserProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Use this operation to update your workforce. You can use this operation to - * require that workers use specific IP addresses to work on tasks - * and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.

- *

The worker portal is now supported in VPC and public internet.

- *

Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. - * You specify allowed IP addresses by creating a list of up to ten CIDRs. - * By default, a workforce isn't restricted to specific IP addresses. If you specify a - * range of IP addresses, workers who attempt to access tasks using any IP address outside - * the specified range are denied and get a Not Found error message on - * the worker portal.

- *

To restrict access to all the workers in public internet, add the SourceIpConfig CIDR value as "10.0.0.0/16".

- * - *

Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.

- *
- *

Use OidcConfig to update the configuration of a workforce created using - * your own OIDC IdP.

- * - *

You can only update your OIDC IdP configuration when there are no work teams - * associated with your workforce. You can delete work teams using the operation.

- *
- *

After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you - * can view details about your update workforce using the - * operation.

- * - *

This operation only applies to private workforces.

- *
- */ - public updateWorkforce( + + /** + * @see {@link UpdateWorkforceCommand} + */ + updateWorkforce( args: UpdateWorkforceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWorkforce( - args: UpdateWorkforceCommandInput, - cb: (err: any, data?: UpdateWorkforceCommandOutput) => void - ): void; - public updateWorkforce( + updateWorkforce(args: UpdateWorkforceCommandInput, cb: (err: any, data?: UpdateWorkforceCommandOutput) => void): void; + updateWorkforce( args: UpdateWorkforceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkforceCommandOutput) => void ): void; - public updateWorkforce( - args: UpdateWorkforceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWorkforceCommandOutput) => void), - cb?: (err: any, data?: UpdateWorkforceCommandOutput) => void - ): Promise | void { - const command = new UpdateWorkforceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing work team with new member definitions or description.

- */ - public updateWorkteam( + + /** + * @see {@link UpdateWorkteamCommand} + */ + updateWorkteam( args: UpdateWorkteamCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWorkteam( - args: UpdateWorkteamCommandInput, - cb: (err: any, data?: UpdateWorkteamCommandOutput) => void - ): void; - public updateWorkteam( + updateWorkteam(args: UpdateWorkteamCommandInput, cb: (err: any, data?: UpdateWorkteamCommandOutput) => void): void; + updateWorkteam( args: UpdateWorkteamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkteamCommandOutput) => void ): void; - public updateWorkteam( - args: UpdateWorkteamCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWorkteamCommandOutput) => void), - cb?: (err: any, data?: UpdateWorkteamCommandOutput) => void - ): Promise | void { - const command = new UpdateWorkteamCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Provides APIs for creating and managing SageMaker resources.

+ *

Other Resources:

+ * + */ +export class SageMaker extends SageMakerClient implements SageMaker {} +createAggregatedClient(commands, SageMaker); diff --git a/clients/client-savingsplans/src/Savingsplans.ts b/clients/client-savingsplans/src/Savingsplans.ts index 21d18548f056..2c60b4f5f7d3 100644 --- a/clients/client-savingsplans/src/Savingsplans.ts +++ b/clients/client-savingsplans/src/Savingsplans.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -42,304 +43,169 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; -import { SavingsplansClient } from "./SavingsplansClient"; +import { SavingsplansClient, SavingsplansClientConfig } from "./SavingsplansClient"; -/** - * @public - *

Savings Plans are a pricing model that offer significant savings on AWS usage (for - * example, on Amazon EC2 instances). You commit to a consistent amount of usage, in USD - * per hour, for a term of 1 or 3 years, and receive a lower price for that usage. For - * more information, see the AWS Savings Plans User Guide.

- */ -export class Savingsplans extends SavingsplansClient { +const commands = { + CreateSavingsPlanCommand, + DeleteQueuedSavingsPlanCommand, + DescribeSavingsPlanRatesCommand, + DescribeSavingsPlansCommand, + DescribeSavingsPlansOfferingRatesCommand, + DescribeSavingsPlansOfferingsCommand, + ListTagsForResourceCommand, + TagResourceCommand, + UntagResourceCommand, +}; + +export interface Savingsplans { /** - * @public - *

Creates a Savings Plan.

+ * @see {@link CreateSavingsPlanCommand} */ - public createSavingsPlan( + createSavingsPlan( args: CreateSavingsPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSavingsPlan( + createSavingsPlan( args: CreateSavingsPlanCommandInput, cb: (err: any, data?: CreateSavingsPlanCommandOutput) => void ): void; - public createSavingsPlan( + createSavingsPlan( args: CreateSavingsPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSavingsPlanCommandOutput) => void ): void; - public createSavingsPlan( - args: CreateSavingsPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSavingsPlanCommandOutput) => void), - cb?: (err: any, data?: CreateSavingsPlanCommandOutput) => void - ): Promise | void { - const command = new CreateSavingsPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the queued purchase for the specified Savings Plan.

+ * @see {@link DeleteQueuedSavingsPlanCommand} */ - public deleteQueuedSavingsPlan( + deleteQueuedSavingsPlan( args: DeleteQueuedSavingsPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteQueuedSavingsPlan( + deleteQueuedSavingsPlan( args: DeleteQueuedSavingsPlanCommandInput, cb: (err: any, data?: DeleteQueuedSavingsPlanCommandOutput) => void ): void; - public deleteQueuedSavingsPlan( + deleteQueuedSavingsPlan( args: DeleteQueuedSavingsPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteQueuedSavingsPlanCommandOutput) => void ): void; - public deleteQueuedSavingsPlan( - args: DeleteQueuedSavingsPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteQueuedSavingsPlanCommandOutput) => void), - cb?: (err: any, data?: DeleteQueuedSavingsPlanCommandOutput) => void - ): Promise | void { - const command = new DeleteQueuedSavingsPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified Savings Plans rates.

+ * @see {@link DescribeSavingsPlanRatesCommand} */ - public describeSavingsPlanRates( + describeSavingsPlanRates( args: DescribeSavingsPlanRatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSavingsPlanRates( + describeSavingsPlanRates( args: DescribeSavingsPlanRatesCommandInput, cb: (err: any, data?: DescribeSavingsPlanRatesCommandOutput) => void ): void; - public describeSavingsPlanRates( + describeSavingsPlanRates( args: DescribeSavingsPlanRatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSavingsPlanRatesCommandOutput) => void ): void; - public describeSavingsPlanRates( - args: DescribeSavingsPlanRatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSavingsPlanRatesCommandOutput) => void), - cb?: (err: any, data?: DescribeSavingsPlanRatesCommandOutput) => void - ): Promise | void { - const command = new DescribeSavingsPlanRatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified Savings Plans.

+ * @see {@link DescribeSavingsPlansCommand} */ - public describeSavingsPlans( + describeSavingsPlans( args: DescribeSavingsPlansCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSavingsPlans( + describeSavingsPlans( args: DescribeSavingsPlansCommandInput, cb: (err: any, data?: DescribeSavingsPlansCommandOutput) => void ): void; - public describeSavingsPlans( + describeSavingsPlans( args: DescribeSavingsPlansCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSavingsPlansCommandOutput) => void ): void; - public describeSavingsPlans( - args: DescribeSavingsPlansCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSavingsPlansCommandOutput) => void), - cb?: (err: any, data?: DescribeSavingsPlansCommandOutput) => void - ): Promise | void { - const command = new DescribeSavingsPlansCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified Savings Plans offering rates.

+ * @see {@link DescribeSavingsPlansOfferingRatesCommand} */ - public describeSavingsPlansOfferingRates( + describeSavingsPlansOfferingRates( args: DescribeSavingsPlansOfferingRatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSavingsPlansOfferingRates( + describeSavingsPlansOfferingRates( args: DescribeSavingsPlansOfferingRatesCommandInput, cb: (err: any, data?: DescribeSavingsPlansOfferingRatesCommandOutput) => void ): void; - public describeSavingsPlansOfferingRates( + describeSavingsPlansOfferingRates( args: DescribeSavingsPlansOfferingRatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSavingsPlansOfferingRatesCommandOutput) => void ): void; - public describeSavingsPlansOfferingRates( - args: DescribeSavingsPlansOfferingRatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSavingsPlansOfferingRatesCommandOutput) => void), - cb?: (err: any, data?: DescribeSavingsPlansOfferingRatesCommandOutput) => void - ): Promise | void { - const command = new DescribeSavingsPlansOfferingRatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified Savings Plans offerings.

+ * @see {@link DescribeSavingsPlansOfferingsCommand} */ - public describeSavingsPlansOfferings( + describeSavingsPlansOfferings( args: DescribeSavingsPlansOfferingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSavingsPlansOfferings( + describeSavingsPlansOfferings( args: DescribeSavingsPlansOfferingsCommandInput, cb: (err: any, data?: DescribeSavingsPlansOfferingsCommandOutput) => void ): void; - public describeSavingsPlansOfferings( + describeSavingsPlansOfferings( args: DescribeSavingsPlansOfferingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSavingsPlansOfferingsCommandOutput) => void ): void; - public describeSavingsPlansOfferings( - args: DescribeSavingsPlansOfferingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSavingsPlansOfferingsCommandOutput) => void), - cb?: (err: any, data?: DescribeSavingsPlansOfferingsCommandOutput) => void - ): Promise | void { - const command = new DescribeSavingsPlansOfferingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags for the specified resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds the specified tags to the specified resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified tags from the specified resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Savings Plans are a pricing model that offer significant savings on AWS usage (for + * example, on Amazon EC2 instances). You commit to a consistent amount of usage, in USD + * per hour, for a term of 1 or 3 years, and receive a lower price for that usage. For + * more information, see the AWS Savings Plans User Guide.

+ */ +export class Savingsplans extends SavingsplansClient implements Savingsplans {} +createAggregatedClient(commands, Savingsplans); diff --git a/clients/client-scheduler/src/Scheduler.ts b/clients/client-scheduler/src/Scheduler.ts index f61004fe463a..1852f2c13f3e 100644 --- a/clients/client-scheduler/src/Scheduler.ts +++ b/clients/client-scheduler/src/Scheduler.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -53,414 +54,203 @@ import { UpdateScheduleCommandInput, UpdateScheduleCommandOutput, } from "./commands/UpdateScheduleCommand"; -import { SchedulerClient } from "./SchedulerClient"; +import { SchedulerClient, SchedulerClientConfig } from "./SchedulerClient"; -/** - * @public - *

- * Amazon EventBridge Scheduler is a serverless scheduler that allows you to create, run, and manage tasks from one central, managed service. - * EventBridge Scheduler delivers your tasks reliably, with built-in mechanisms that adjust your schedules based on the availability of downstream targets. - * The following reference lists the available API actions, and data types for EventBridge Scheduler. - *

- */ -export class Scheduler extends SchedulerClient { +const commands = { + CreateScheduleCommand, + CreateScheduleGroupCommand, + DeleteScheduleCommand, + DeleteScheduleGroupCommand, + GetScheduleCommand, + GetScheduleGroupCommand, + ListScheduleGroupsCommand, + ListSchedulesCommand, + ListTagsForResourceCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateScheduleCommand, +}; + +export interface Scheduler { /** - * @public - *

Creates the specified schedule.

+ * @see {@link CreateScheduleCommand} */ - public createSchedule( + createSchedule( args: CreateScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSchedule( - args: CreateScheduleCommandInput, - cb: (err: any, data?: CreateScheduleCommandOutput) => void - ): void; - public createSchedule( + createSchedule(args: CreateScheduleCommandInput, cb: (err: any, data?: CreateScheduleCommandOutput) => void): void; + createSchedule( args: CreateScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateScheduleCommandOutput) => void ): void; - public createSchedule( - args: CreateScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateScheduleCommandOutput) => void), - cb?: (err: any, data?: CreateScheduleCommandOutput) => void - ): Promise | void { - const command = new CreateScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates the specified schedule group.

+ * @see {@link CreateScheduleGroupCommand} */ - public createScheduleGroup( + createScheduleGroup( args: CreateScheduleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createScheduleGroup( + createScheduleGroup( args: CreateScheduleGroupCommandInput, cb: (err: any, data?: CreateScheduleGroupCommandOutput) => void ): void; - public createScheduleGroup( + createScheduleGroup( args: CreateScheduleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateScheduleGroupCommandOutput) => void ): void; - public createScheduleGroup( - args: CreateScheduleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateScheduleGroupCommandOutput) => void), - cb?: (err: any, data?: CreateScheduleGroupCommandOutput) => void - ): Promise | void { - const command = new CreateScheduleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified schedule.

+ * @see {@link DeleteScheduleCommand} */ - public deleteSchedule( + deleteSchedule( args: DeleteScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSchedule( - args: DeleteScheduleCommandInput, - cb: (err: any, data?: DeleteScheduleCommandOutput) => void - ): void; - public deleteSchedule( + deleteSchedule(args: DeleteScheduleCommandInput, cb: (err: any, data?: DeleteScheduleCommandOutput) => void): void; + deleteSchedule( args: DeleteScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteScheduleCommandOutput) => void ): void; - public deleteSchedule( - args: DeleteScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteScheduleCommandOutput) => void), - cb?: (err: any, data?: DeleteScheduleCommandOutput) => void - ): Promise | void { - const command = new DeleteScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified schedule group. Deleting a schedule group results in EventBridge Scheduler deleting all schedules associated with the group. - * When you delete a group, it remains in a DELETING state until all of its associated schedules are deleted. - * Schedules associated with the group that are set to run while the schedule group is in the process of being deleted might continue to invoke their targets - * until the schedule group and its associated schedules are deleted.

- * - *

- * This operation is eventually consistent. - *

- *
+ * @see {@link DeleteScheduleGroupCommand} */ - public deleteScheduleGroup( + deleteScheduleGroup( args: DeleteScheduleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteScheduleGroup( + deleteScheduleGroup( args: DeleteScheduleGroupCommandInput, cb: (err: any, data?: DeleteScheduleGroupCommandOutput) => void ): void; - public deleteScheduleGroup( + deleteScheduleGroup( args: DeleteScheduleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteScheduleGroupCommandOutput) => void ): void; - public deleteScheduleGroup( - args: DeleteScheduleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteScheduleGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteScheduleGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteScheduleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the specified schedule.

+ * @see {@link GetScheduleCommand} */ - public getSchedule(args: GetScheduleCommandInput, options?: __HttpHandlerOptions): Promise; - public getSchedule(args: GetScheduleCommandInput, cb: (err: any, data?: GetScheduleCommandOutput) => void): void; - public getSchedule( + getSchedule(args: GetScheduleCommandInput, options?: __HttpHandlerOptions): Promise; + getSchedule(args: GetScheduleCommandInput, cb: (err: any, data?: GetScheduleCommandOutput) => void): void; + getSchedule( args: GetScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetScheduleCommandOutput) => void ): void; - public getSchedule( - args: GetScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetScheduleCommandOutput) => void), - cb?: (err: any, data?: GetScheduleCommandOutput) => void - ): Promise | void { - const command = new GetScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the specified schedule group.

+ * @see {@link GetScheduleGroupCommand} */ - public getScheduleGroup( + getScheduleGroup( args: GetScheduleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public getScheduleGroup( + getScheduleGroup( args: GetScheduleGroupCommandInput, cb: (err: any, data?: GetScheduleGroupCommandOutput) => void ): void; - public getScheduleGroup( + getScheduleGroup( args: GetScheduleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetScheduleGroupCommandOutput) => void ): void; - public getScheduleGroup( - args: GetScheduleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetScheduleGroupCommandOutput) => void), - cb?: (err: any, data?: GetScheduleGroupCommandOutput) => void - ): Promise | void { - const command = new GetScheduleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a paginated list of your schedule groups.

+ * @see {@link ListScheduleGroupsCommand} */ - public listScheduleGroups( + listScheduleGroups( args: ListScheduleGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listScheduleGroups( + listScheduleGroups( args: ListScheduleGroupsCommandInput, cb: (err: any, data?: ListScheduleGroupsCommandOutput) => void ): void; - public listScheduleGroups( + listScheduleGroups( args: ListScheduleGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListScheduleGroupsCommandOutput) => void ): void; - public listScheduleGroups( - args: ListScheduleGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListScheduleGroupsCommandOutput) => void), - cb?: (err: any, data?: ListScheduleGroupsCommandOutput) => void - ): Promise | void { - const command = new ListScheduleGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a paginated list of your EventBridge Scheduler schedules.

+ * @see {@link ListSchedulesCommand} */ - public listSchedules( - args: ListSchedulesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listSchedules( - args: ListSchedulesCommandInput, - cb: (err: any, data?: ListSchedulesCommandOutput) => void - ): void; - public listSchedules( + listSchedules(args: ListSchedulesCommandInput, options?: __HttpHandlerOptions): Promise; + listSchedules(args: ListSchedulesCommandInput, cb: (err: any, data?: ListSchedulesCommandOutput) => void): void; + listSchedules( args: ListSchedulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSchedulesCommandOutput) => void ): void; - public listSchedules( - args: ListSchedulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSchedulesCommandOutput) => void), - cb?: (err: any, data?: ListSchedulesCommandOutput) => void - ): Promise | void { - const command = new ListSchedulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags associated with the Scheduler resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from the specified EventBridge Scheduler schedule group.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Updates the specified schedule. When you call UpdateSchedule, EventBridge Scheduler uses all values, including empty values, specified in the request and - * overrides the existing schedule. This is by design. This means that if you do not set an optional field in your request, that field will be set to - * its system-default value after the update. - *

- *

- * Before calling this operation, we recommend that you call the GetSchedule API operation and make a note of all optional parameters - * for your UpdateSchedule call. - *

+ * @see {@link UpdateScheduleCommand} */ - public updateSchedule( + updateSchedule( args: UpdateScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSchedule( - args: UpdateScheduleCommandInput, - cb: (err: any, data?: UpdateScheduleCommandOutput) => void - ): void; - public updateSchedule( + updateSchedule(args: UpdateScheduleCommandInput, cb: (err: any, data?: UpdateScheduleCommandOutput) => void): void; + updateSchedule( args: UpdateScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateScheduleCommandOutput) => void ): void; - public updateSchedule( - args: UpdateScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateScheduleCommandOutput) => void), - cb?: (err: any, data?: UpdateScheduleCommandOutput) => void - ): Promise | void { - const command = new UpdateScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

+ * Amazon EventBridge Scheduler is a serverless scheduler that allows you to create, run, and manage tasks from one central, managed service. + * EventBridge Scheduler delivers your tasks reliably, with built-in mechanisms that adjust your schedules based on the availability of downstream targets. + * The following reference lists the available API actions, and data types for EventBridge Scheduler. + *

+ */ +export class Scheduler extends SchedulerClient implements Scheduler {} +createAggregatedClient(commands, Scheduler); diff --git a/clients/client-schemas/src/Schemas.ts b/clients/client-schemas/src/Schemas.ts index 0e5ce8aa11bf..9f870f882607 100644 --- a/clients/client-schemas/src/Schemas.ts +++ b/clients/client-schemas/src/Schemas.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -148,1008 +149,499 @@ import { UpdateSchemaCommandInput, UpdateSchemaCommandOutput, } from "./commands/UpdateSchemaCommand"; -import { SchemasClient } from "./SchemasClient"; +import { SchemasClient, SchemasClientConfig } from "./SchemasClient"; -/** - * @public - *

Amazon EventBridge Schema Registry

- */ -export class Schemas extends SchemasClient { +const commands = { + CreateDiscovererCommand, + CreateRegistryCommand, + CreateSchemaCommand, + DeleteDiscovererCommand, + DeleteRegistryCommand, + DeleteResourcePolicyCommand, + DeleteSchemaCommand, + DeleteSchemaVersionCommand, + DescribeCodeBindingCommand, + DescribeDiscovererCommand, + DescribeRegistryCommand, + DescribeSchemaCommand, + ExportSchemaCommand, + GetCodeBindingSourceCommand, + GetDiscoveredSchemaCommand, + GetResourcePolicyCommand, + ListDiscoverersCommand, + ListRegistriesCommand, + ListSchemasCommand, + ListSchemaVersionsCommand, + ListTagsForResourceCommand, + PutCodeBindingCommand, + PutResourcePolicyCommand, + SearchSchemasCommand, + StartDiscovererCommand, + StopDiscovererCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateDiscovererCommand, + UpdateRegistryCommand, + UpdateSchemaCommand, +}; + +export interface Schemas { /** - * @public - *

Creates a discoverer.

+ * @see {@link CreateDiscovererCommand} */ - public createDiscoverer( + createDiscoverer( args: CreateDiscovererCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDiscoverer( + createDiscoverer( args: CreateDiscovererCommandInput, cb: (err: any, data?: CreateDiscovererCommandOutput) => void ): void; - public createDiscoverer( + createDiscoverer( args: CreateDiscovererCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDiscovererCommandOutput) => void ): void; - public createDiscoverer( - args: CreateDiscovererCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDiscovererCommandOutput) => void), - cb?: (err: any, data?: CreateDiscovererCommandOutput) => void - ): Promise | void { - const command = new CreateDiscovererCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a registry.

+ * @see {@link CreateRegistryCommand} */ - public createRegistry( + createRegistry( args: CreateRegistryCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRegistry( - args: CreateRegistryCommandInput, - cb: (err: any, data?: CreateRegistryCommandOutput) => void - ): void; - public createRegistry( + createRegistry(args: CreateRegistryCommandInput, cb: (err: any, data?: CreateRegistryCommandOutput) => void): void; + createRegistry( args: CreateRegistryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRegistryCommandOutput) => void ): void; - public createRegistry( - args: CreateRegistryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRegistryCommandOutput) => void), - cb?: (err: any, data?: CreateRegistryCommandOutput) => void - ): Promise | void { - const command = new CreateRegistryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a schema definition.

Inactive schemas will be deleted after two years.

+ * @see {@link CreateSchemaCommand} */ - public createSchema( - args: CreateSchemaCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createSchema(args: CreateSchemaCommandInput, cb: (err: any, data?: CreateSchemaCommandOutput) => void): void; - public createSchema( + createSchema(args: CreateSchemaCommandInput, options?: __HttpHandlerOptions): Promise; + createSchema(args: CreateSchemaCommandInput, cb: (err: any, data?: CreateSchemaCommandOutput) => void): void; + createSchema( args: CreateSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSchemaCommandOutput) => void ): void; - public createSchema( - args: CreateSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSchemaCommandOutput) => void), - cb?: (err: any, data?: CreateSchemaCommandOutput) => void - ): Promise | void { - const command = new CreateSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a discoverer.

+ * @see {@link DeleteDiscovererCommand} */ - public deleteDiscoverer( + deleteDiscoverer( args: DeleteDiscovererCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDiscoverer( + deleteDiscoverer( args: DeleteDiscovererCommandInput, cb: (err: any, data?: DeleteDiscovererCommandOutput) => void ): void; - public deleteDiscoverer( + deleteDiscoverer( args: DeleteDiscovererCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDiscovererCommandOutput) => void ): void; - public deleteDiscoverer( - args: DeleteDiscovererCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDiscovererCommandOutput) => void), - cb?: (err: any, data?: DeleteDiscovererCommandOutput) => void - ): Promise | void { - const command = new DeleteDiscovererCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Registry.

+ * @see {@link DeleteRegistryCommand} */ - public deleteRegistry( + deleteRegistry( args: DeleteRegistryCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRegistry( - args: DeleteRegistryCommandInput, - cb: (err: any, data?: DeleteRegistryCommandOutput) => void - ): void; - public deleteRegistry( + deleteRegistry(args: DeleteRegistryCommandInput, cb: (err: any, data?: DeleteRegistryCommandOutput) => void): void; + deleteRegistry( args: DeleteRegistryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRegistryCommandOutput) => void ): void; - public deleteRegistry( - args: DeleteRegistryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRegistryCommandOutput) => void), - cb?: (err: any, data?: DeleteRegistryCommandOutput) => void - ): Promise | void { - const command = new DeleteRegistryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete the resource-based policy attached to the specified registry.

+ * @see {@link DeleteResourcePolicyCommand} */ - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( - args: DeleteResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete a schema definition.

+ * @see {@link DeleteSchemaCommand} */ - public deleteSchema( - args: DeleteSchemaCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteSchema(args: DeleteSchemaCommandInput, cb: (err: any, data?: DeleteSchemaCommandOutput) => void): void; - public deleteSchema( + deleteSchema(args: DeleteSchemaCommandInput, options?: __HttpHandlerOptions): Promise; + deleteSchema(args: DeleteSchemaCommandInput, cb: (err: any, data?: DeleteSchemaCommandOutput) => void): void; + deleteSchema( args: DeleteSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSchemaCommandOutput) => void ): void; - public deleteSchema( - args: DeleteSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSchemaCommandOutput) => void), - cb?: (err: any, data?: DeleteSchemaCommandOutput) => void - ): Promise | void { - const command = new DeleteSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete the schema version definition

+ * @see {@link DeleteSchemaVersionCommand} */ - public deleteSchemaVersion( + deleteSchemaVersion( args: DeleteSchemaVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSchemaVersion( + deleteSchemaVersion( args: DeleteSchemaVersionCommandInput, cb: (err: any, data?: DeleteSchemaVersionCommandOutput) => void ): void; - public deleteSchemaVersion( + deleteSchemaVersion( args: DeleteSchemaVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSchemaVersionCommandOutput) => void ): void; - public deleteSchemaVersion( - args: DeleteSchemaVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSchemaVersionCommandOutput) => void), - cb?: (err: any, data?: DeleteSchemaVersionCommandOutput) => void - ): Promise | void { - const command = new DeleteSchemaVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describe the code binding URI.

+ * @see {@link DescribeCodeBindingCommand} */ - public describeCodeBinding( + describeCodeBinding( args: DescribeCodeBindingCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCodeBinding( + describeCodeBinding( args: DescribeCodeBindingCommandInput, cb: (err: any, data?: DescribeCodeBindingCommandOutput) => void ): void; - public describeCodeBinding( + describeCodeBinding( args: DescribeCodeBindingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCodeBindingCommandOutput) => void ): void; - public describeCodeBinding( - args: DescribeCodeBindingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCodeBindingCommandOutput) => void), - cb?: (err: any, data?: DescribeCodeBindingCommandOutput) => void - ): Promise | void { - const command = new DescribeCodeBindingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the discoverer.

+ * @see {@link DescribeDiscovererCommand} */ - public describeDiscoverer( + describeDiscoverer( args: DescribeDiscovererCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDiscoverer( + describeDiscoverer( args: DescribeDiscovererCommandInput, cb: (err: any, data?: DescribeDiscovererCommandOutput) => void ): void; - public describeDiscoverer( + describeDiscoverer( args: DescribeDiscovererCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDiscovererCommandOutput) => void ): void; - public describeDiscoverer( - args: DescribeDiscovererCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDiscovererCommandOutput) => void), - cb?: (err: any, data?: DescribeDiscovererCommandOutput) => void - ): Promise | void { - const command = new DescribeDiscovererCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the registry.

+ * @see {@link DescribeRegistryCommand} */ - public describeRegistry( + describeRegistry( args: DescribeRegistryCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRegistry( + describeRegistry( args: DescribeRegistryCommandInput, cb: (err: any, data?: DescribeRegistryCommandOutput) => void ): void; - public describeRegistry( + describeRegistry( args: DescribeRegistryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRegistryCommandOutput) => void ): void; - public describeRegistry( - args: DescribeRegistryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRegistryCommandOutput) => void), - cb?: (err: any, data?: DescribeRegistryCommandOutput) => void - ): Promise | void { - const command = new DescribeRegistryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieve the schema definition.

+ * @see {@link DescribeSchemaCommand} */ - public describeSchema( + describeSchema( args: DescribeSchemaCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSchema( - args: DescribeSchemaCommandInput, - cb: (err: any, data?: DescribeSchemaCommandOutput) => void - ): void; - public describeSchema( + describeSchema(args: DescribeSchemaCommandInput, cb: (err: any, data?: DescribeSchemaCommandOutput) => void): void; + describeSchema( args: DescribeSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSchemaCommandOutput) => void ): void; - public describeSchema( - args: DescribeSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSchemaCommandOutput) => void), - cb?: (err: any, data?: DescribeSchemaCommandOutput) => void - ): Promise | void { - const command = new DescribeSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link ExportSchemaCommand} */ - public exportSchema( - args: ExportSchemaCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public exportSchema(args: ExportSchemaCommandInput, cb: (err: any, data?: ExportSchemaCommandOutput) => void): void; - public exportSchema( + exportSchema(args: ExportSchemaCommandInput, options?: __HttpHandlerOptions): Promise; + exportSchema(args: ExportSchemaCommandInput, cb: (err: any, data?: ExportSchemaCommandOutput) => void): void; + exportSchema( args: ExportSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportSchemaCommandOutput) => void ): void; - public exportSchema( - args: ExportSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportSchemaCommandOutput) => void), - cb?: (err: any, data?: ExportSchemaCommandOutput) => void - ): Promise | void { - const command = new ExportSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the code binding source URI.

+ * @see {@link GetCodeBindingSourceCommand} */ - public getCodeBindingSource( + getCodeBindingSource( args: GetCodeBindingSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCodeBindingSource( + getCodeBindingSource( args: GetCodeBindingSourceCommandInput, cb: (err: any, data?: GetCodeBindingSourceCommandOutput) => void ): void; - public getCodeBindingSource( + getCodeBindingSource( args: GetCodeBindingSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCodeBindingSourceCommandOutput) => void ): void; - public getCodeBindingSource( - args: GetCodeBindingSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCodeBindingSourceCommandOutput) => void), - cb?: (err: any, data?: GetCodeBindingSourceCommandOutput) => void - ): Promise | void { - const command = new GetCodeBindingSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the discovered schema that was generated based on sampled events.

+ * @see {@link GetDiscoveredSchemaCommand} */ - public getDiscoveredSchema( + getDiscoveredSchema( args: GetDiscoveredSchemaCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDiscoveredSchema( + getDiscoveredSchema( args: GetDiscoveredSchemaCommandInput, cb: (err: any, data?: GetDiscoveredSchemaCommandOutput) => void ): void; - public getDiscoveredSchema( + getDiscoveredSchema( args: GetDiscoveredSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDiscoveredSchemaCommandOutput) => void ): void; - public getDiscoveredSchema( - args: GetDiscoveredSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDiscoveredSchemaCommandOutput) => void), - cb?: (err: any, data?: GetDiscoveredSchemaCommandOutput) => void - ): Promise | void { - const command = new GetDiscoveredSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the resource-based policy attached to a given registry.

+ * @see {@link GetResourcePolicyCommand} */ - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void ): void; - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void ): void; - public getResourcePolicy( - args: GetResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: GetResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new GetResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the discoverers.

+ * @see {@link ListDiscoverersCommand} */ - public listDiscoverers( + listDiscoverers( args: ListDiscoverersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDiscoverers( - args: ListDiscoverersCommandInput, - cb: (err: any, data?: ListDiscoverersCommandOutput) => void - ): void; - public listDiscoverers( + listDiscoverers(args: ListDiscoverersCommandInput, cb: (err: any, data?: ListDiscoverersCommandOutput) => void): void; + listDiscoverers( args: ListDiscoverersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDiscoverersCommandOutput) => void ): void; - public listDiscoverers( - args: ListDiscoverersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDiscoverersCommandOutput) => void), - cb?: (err: any, data?: ListDiscoverersCommandOutput) => void - ): Promise | void { - const command = new ListDiscoverersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the registries.

+ * @see {@link ListRegistriesCommand} */ - public listRegistries( + listRegistries( args: ListRegistriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRegistries( - args: ListRegistriesCommandInput, - cb: (err: any, data?: ListRegistriesCommandOutput) => void - ): void; - public listRegistries( + listRegistries(args: ListRegistriesCommandInput, cb: (err: any, data?: ListRegistriesCommandOutput) => void): void; + listRegistries( args: ListRegistriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRegistriesCommandOutput) => void ): void; - public listRegistries( - args: ListRegistriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRegistriesCommandOutput) => void), - cb?: (err: any, data?: ListRegistriesCommandOutput) => void - ): Promise | void { - const command = new ListRegistriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the schemas.

+ * @see {@link ListSchemasCommand} */ - public listSchemas(args: ListSchemasCommandInput, options?: __HttpHandlerOptions): Promise; - public listSchemas(args: ListSchemasCommandInput, cb: (err: any, data?: ListSchemasCommandOutput) => void): void; - public listSchemas( + listSchemas(args: ListSchemasCommandInput, options?: __HttpHandlerOptions): Promise; + listSchemas(args: ListSchemasCommandInput, cb: (err: any, data?: ListSchemasCommandOutput) => void): void; + listSchemas( args: ListSchemasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSchemasCommandOutput) => void ): void; - public listSchemas( - args: ListSchemasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSchemasCommandOutput) => void), - cb?: (err: any, data?: ListSchemasCommandOutput) => void - ): Promise | void { - const command = new ListSchemasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a list of the schema versions and related information.

+ * @see {@link ListSchemaVersionsCommand} */ - public listSchemaVersions( + listSchemaVersions( args: ListSchemaVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSchemaVersions( + listSchemaVersions( args: ListSchemaVersionsCommandInput, cb: (err: any, data?: ListSchemaVersionsCommandOutput) => void ): void; - public listSchemaVersions( + listSchemaVersions( args: ListSchemaVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSchemaVersionsCommandOutput) => void ): void; - public listSchemaVersions( - args: ListSchemaVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSchemaVersionsCommandOutput) => void), - cb?: (err: any, data?: ListSchemaVersionsCommandOutput) => void - ): Promise | void { - const command = new ListSchemaVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get tags for resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Put code binding URI

+ * @see {@link PutCodeBindingCommand} */ - public putCodeBinding( + putCodeBinding( args: PutCodeBindingCommandInput, options?: __HttpHandlerOptions ): Promise; - public putCodeBinding( - args: PutCodeBindingCommandInput, - cb: (err: any, data?: PutCodeBindingCommandOutput) => void - ): void; - public putCodeBinding( + putCodeBinding(args: PutCodeBindingCommandInput, cb: (err: any, data?: PutCodeBindingCommandOutput) => void): void; + putCodeBinding( args: PutCodeBindingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutCodeBindingCommandOutput) => void ): void; - public putCodeBinding( - args: PutCodeBindingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutCodeBindingCommandOutput) => void), - cb?: (err: any, data?: PutCodeBindingCommandOutput) => void - ): Promise | void { - const command = new PutCodeBindingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The name of the policy.

+ * @see {@link PutResourcePolicyCommand} */ - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( - args: PutResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: PutResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new PutResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Search the schemas

+ * @see {@link SearchSchemasCommand} */ - public searchSchemas( - args: SearchSchemasCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public searchSchemas( - args: SearchSchemasCommandInput, - cb: (err: any, data?: SearchSchemasCommandOutput) => void - ): void; - public searchSchemas( + searchSchemas(args: SearchSchemasCommandInput, options?: __HttpHandlerOptions): Promise; + searchSchemas(args: SearchSchemasCommandInput, cb: (err: any, data?: SearchSchemasCommandOutput) => void): void; + searchSchemas( args: SearchSchemasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchSchemasCommandOutput) => void ): void; - public searchSchemas( - args: SearchSchemasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchSchemasCommandOutput) => void), - cb?: (err: any, data?: SearchSchemasCommandOutput) => void - ): Promise | void { - const command = new SearchSchemasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts the discoverer

+ * @see {@link StartDiscovererCommand} */ - public startDiscoverer( + startDiscoverer( args: StartDiscovererCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDiscoverer( - args: StartDiscovererCommandInput, - cb: (err: any, data?: StartDiscovererCommandOutput) => void - ): void; - public startDiscoverer( + startDiscoverer(args: StartDiscovererCommandInput, cb: (err: any, data?: StartDiscovererCommandOutput) => void): void; + startDiscoverer( args: StartDiscovererCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDiscovererCommandOutput) => void ): void; - public startDiscoverer( - args: StartDiscovererCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDiscovererCommandOutput) => void), - cb?: (err: any, data?: StartDiscovererCommandOutput) => void - ): Promise | void { - const command = new StartDiscovererCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops the discoverer

+ * @see {@link StopDiscovererCommand} */ - public stopDiscoverer( + stopDiscoverer( args: StopDiscovererCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopDiscoverer( - args: StopDiscovererCommandInput, - cb: (err: any, data?: StopDiscovererCommandOutput) => void - ): void; - public stopDiscoverer( + stopDiscoverer(args: StopDiscovererCommandInput, cb: (err: any, data?: StopDiscovererCommandOutput) => void): void; + stopDiscoverer( args: StopDiscovererCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDiscovererCommandOutput) => void ): void; - public stopDiscoverer( - args: StopDiscovererCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopDiscovererCommandOutput) => void), - cb?: (err: any, data?: StopDiscovererCommandOutput) => void - ): Promise | void { - const command = new StopDiscovererCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Add tags to a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the discoverer

+ * @see {@link UpdateDiscovererCommand} */ - public updateDiscoverer( + updateDiscoverer( args: UpdateDiscovererCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDiscoverer( + updateDiscoverer( args: UpdateDiscovererCommandInput, cb: (err: any, data?: UpdateDiscovererCommandOutput) => void ): void; - public updateDiscoverer( + updateDiscoverer( args: UpdateDiscovererCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDiscovererCommandOutput) => void ): void; - public updateDiscoverer( - args: UpdateDiscovererCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDiscovererCommandOutput) => void), - cb?: (err: any, data?: UpdateDiscovererCommandOutput) => void - ): Promise | void { - const command = new UpdateDiscovererCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a registry.

+ * @see {@link UpdateRegistryCommand} */ - public updateRegistry( + updateRegistry( args: UpdateRegistryCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRegistry( - args: UpdateRegistryCommandInput, - cb: (err: any, data?: UpdateRegistryCommandOutput) => void - ): void; - public updateRegistry( + updateRegistry(args: UpdateRegistryCommandInput, cb: (err: any, data?: UpdateRegistryCommandOutput) => void): void; + updateRegistry( args: UpdateRegistryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRegistryCommandOutput) => void ): void; - public updateRegistry( - args: UpdateRegistryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRegistryCommandOutput) => void), - cb?: (err: any, data?: UpdateRegistryCommandOutput) => void - ): Promise | void { - const command = new UpdateRegistryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the schema definition

Inactive schemas will be deleted after two years.

+ * @see {@link UpdateSchemaCommand} */ - public updateSchema( - args: UpdateSchemaCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateSchema(args: UpdateSchemaCommandInput, cb: (err: any, data?: UpdateSchemaCommandOutput) => void): void; - public updateSchema( + updateSchema(args: UpdateSchemaCommandInput, options?: __HttpHandlerOptions): Promise; + updateSchema(args: UpdateSchemaCommandInput, cb: (err: any, data?: UpdateSchemaCommandOutput) => void): void; + updateSchema( args: UpdateSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSchemaCommandOutput) => void ): void; - public updateSchema( - args: UpdateSchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSchemaCommandOutput) => void), - cb?: (err: any, data?: UpdateSchemaCommandOutput) => void - ): Promise | void { - const command = new UpdateSchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon EventBridge Schema Registry

+ */ +export class Schemas extends SchemasClient implements Schemas {} +createAggregatedClient(commands, Schemas); diff --git a/clients/client-secrets-manager/src/SecretsManager.ts b/clients/client-secrets-manager/src/SecretsManager.ts index dba03187af54..f81d0c6914ac 100644 --- a/clients/client-secrets-manager/src/SecretsManager.ts +++ b/clients/client-secrets-manager/src/SecretsManager.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -103,1099 +104,380 @@ import { ValidateResourcePolicyCommandInput, ValidateResourcePolicyCommandOutput, } from "./commands/ValidateResourcePolicyCommand"; -import { SecretsManagerClient } from "./SecretsManagerClient"; +import { SecretsManagerClient, SecretsManagerClientConfig } from "./SecretsManagerClient"; -/** - * @public - * Amazon Web Services Secrets Manager - *

Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.

- *

This guide provides descriptions of the Secrets Manager API. For more information about using this - * service, see the Amazon Web Services Secrets Manager User Guide.

- *

- * API Version - *

- *

This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.

- *

For a list of endpoints, see Amazon Web Services Secrets Manager - * endpoints.

- *

- * Support and Feedback for Amazon Web Services Secrets Manager - *

- *

We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more - * information about the Amazon Web Services Discussion Forums, see Forums - * Help.

- *

- * Logging API Requests - *

- *

Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services - * account and delivers log files to an Amazon S3 bucket. By using information that's collected - * by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the - * request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services - * CloudTrail, see Logging - * Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide. - * To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.

- */ -export class SecretsManager extends SecretsManagerClient { +const commands = { + CancelRotateSecretCommand, + CreateSecretCommand, + DeleteResourcePolicyCommand, + DeleteSecretCommand, + DescribeSecretCommand, + GetRandomPasswordCommand, + GetResourcePolicyCommand, + GetSecretValueCommand, + ListSecretsCommand, + ListSecretVersionIdsCommand, + PutResourcePolicyCommand, + PutSecretValueCommand, + RemoveRegionsFromReplicationCommand, + ReplicateSecretToRegionsCommand, + RestoreSecretCommand, + RotateSecretCommand, + StopReplicationToReplicaCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateSecretCommand, + UpdateSecretVersionStageCommand, + ValidateResourcePolicyCommand, +}; + +export interface SecretsManager { /** - * @public - *

Turns off automatic rotation, and if a rotation is currently in - * progress, cancels the rotation.

- *

If you cancel a rotation in progress, it can leave the VersionStage - * labels in an unexpected state. You might - * need to remove the staging label AWSPENDING from the partially created version. - * You also need to determine whether to roll back to the previous version of the secret - * by moving the staging label AWSCURRENT to the version that has AWSPENDING. - * To determine - * which version has a specific staging label, call ListSecretVersionIds. Then use - * UpdateSecretVersionStage to change staging labels. - * For more information, see How rotation works.

- *

To turn on automatic rotation again, call RotateSecret.

- *

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

- *

- * Required permissions: - * secretsmanager:CancelRotateSecret. - * For more information, see - * IAM policy actions for Secrets Manager and Authentication - * and access control in Secrets Manager.

+ * @see {@link CancelRotateSecretCommand} */ - public cancelRotateSecret( + cancelRotateSecret( args: CancelRotateSecretCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelRotateSecret( + cancelRotateSecret( args: CancelRotateSecretCommandInput, cb: (err: any, data?: CancelRotateSecretCommandOutput) => void ): void; - public cancelRotateSecret( + cancelRotateSecret( args: CancelRotateSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelRotateSecretCommandOutput) => void ): void; - public cancelRotateSecret( - args: CancelRotateSecretCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelRotateSecretCommandOutput) => void), - cb?: (err: any, data?: CancelRotateSecretCommandOutput) => void - ): Promise | void { - const command = new CancelRotateSecretCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new secret. A secret can be a password, a set of - * credentials such as a user name and password, an OAuth token, or other secret information - * that you store in an encrypted form in Secrets Manager. The secret also - * includes the connection information to access a database or other service, which Secrets Manager - * doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the - * important information needed to manage the secret.

- *

For secrets that use managed rotation, you need to create the secret through the managing service. For more information, see Secrets Manager secrets managed by other Amazon Web Services services. - * - *

- *

For information about creating a secret in the console, see Create a secret.

- *

To create a secret, you can provide the secret value to be encrypted in either the - * SecretString parameter or the SecretBinary parameter, but not both. - * If you include SecretString or SecretBinary - * then Secrets Manager creates an initial secret version and automatically attaches the staging - * label AWSCURRENT to it.

- *

For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, - * you must make sure the JSON you store in the SecretString matches the JSON structure of - * a database secret.

- *

If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key - * aws/secretsmanager. If this key - * doesn't already exist in your account, then Secrets Manager creates it for you automatically. All - * users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager. - * Creating aws/secretsmanager can result in a one-time significant delay in returning the - * result.

- *

If the secret is in a different Amazon Web Services account from the credentials calling the API, then - * you can't use aws/secretsmanager to encrypt the secret, and you must create - * and use a customer managed KMS key.

- *

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

- *

- * Required permissions: - * secretsmanager:CreateSecret. If you - * include tags in the secret, you also need secretsmanager:TagResource. - * For more information, see - * IAM policy actions for Secrets Manager and Authentication - * and access control in Secrets Manager.

- *

To encrypt the secret with a KMS key other than aws/secretsmanager, you need kms:GenerateDataKey and kms:Decrypt permission to the key.

+ * @see {@link CreateSecretCommand} */ - public createSecret( - args: CreateSecretCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createSecret(args: CreateSecretCommandInput, cb: (err: any, data?: CreateSecretCommandOutput) => void): void; - public createSecret( + createSecret(args: CreateSecretCommandInput, options?: __HttpHandlerOptions): Promise; + createSecret(args: CreateSecretCommandInput, cb: (err: any, data?: CreateSecretCommandOutput) => void): void; + createSecret( args: CreateSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSecretCommandOutput) => void ): void; - public createSecret( - args: CreateSecretCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSecretCommandOutput) => void), - cb?: (err: any, data?: CreateSecretCommandOutput) => void - ): Promise | void { - const command = new CreateSecretCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the resource-based permission policy attached to the secret. To attach a policy to - * a secret, use PutResourcePolicy.

- *

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

- *

- * Required permissions: - * secretsmanager:DeleteResourcePolicy. - * For more information, see - * IAM policy actions for Secrets Manager and Authentication - * and access control in Secrets Manager.

+ * @see {@link DeleteResourcePolicyCommand} */ - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( - args: DeleteResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a secret and all of its versions. You can specify a recovery - * window during which you can restore the secret. The minimum recovery window is 7 days. - * The default recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to - * the secret that specifies the end of the recovery window. At the end of the recovery window, - * Secrets Manager deletes the secret permanently.

- *

You can't delete a primary secret that is replicated to other Regions. You must first delete the - * replicas using RemoveRegionsFromReplication, and then delete the primary secret. - * When you delete a replica, it is deleted immediately.

- *

You can't directly delete a version of a secret. Instead, you remove all staging labels - * from the version using UpdateSecretVersionStage. This marks the version as deprecated, - * and then Secrets Manager can automatically delete the version in the background.

- *

To determine whether an application still uses a secret, you can create an Amazon CloudWatch alarm - * to alert you to any attempts to access a secret during the recovery window. For more information, - * see - * Monitor secrets scheduled for deletion.

- *

Secrets Manager performs the permanent secret deletion at the end of the waiting period as a - * background task with low priority. There is no guarantee of a specific time after the - * recovery window for the permanent delete to occur.

- *

At any time before recovery window ends, you can use RestoreSecret to - * remove the DeletionDate and cancel the deletion of the secret.

- *

When a secret is scheduled for deletion, you cannot retrieve the secret value. - * You must first cancel the deletion with RestoreSecret and then you can retrieve the secret.

- *

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

- *

- * Required permissions: - * secretsmanager:DeleteSecret. - * For more information, see - * IAM policy actions for Secrets Manager and Authentication - * and access control in Secrets Manager.

+ * @see {@link DeleteSecretCommand} */ - public deleteSecret( - args: DeleteSecretCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteSecret(args: DeleteSecretCommandInput, cb: (err: any, data?: DeleteSecretCommandOutput) => void): void; - public deleteSecret( + deleteSecret(args: DeleteSecretCommandInput, options?: __HttpHandlerOptions): Promise; + deleteSecret(args: DeleteSecretCommandInput, cb: (err: any, data?: DeleteSecretCommandOutput) => void): void; + deleteSecret( args: DeleteSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSecretCommandOutput) => void ): void; - public deleteSecret( - args: DeleteSecretCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSecretCommandOutput) => void), - cb?: (err: any, data?: DeleteSecretCommandOutput) => void - ): Promise | void { - const command = new DeleteSecretCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager - * only returns fields that have a value in the response.

- *

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

- *

- * Required permissions: - * secretsmanager:DescribeSecret. - * For more information, see - * IAM policy actions for Secrets Manager and Authentication - * and access control in Secrets Manager.

+ * @see {@link DescribeSecretCommand} */ - public describeSecret( + describeSecret( args: DescribeSecretCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSecret( - args: DescribeSecretCommandInput, - cb: (err: any, data?: DescribeSecretCommandOutput) => void - ): void; - public describeSecret( + describeSecret(args: DescribeSecretCommandInput, cb: (err: any, data?: DescribeSecretCommandOutput) => void): void; + describeSecret( args: DescribeSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSecretCommandOutput) => void ): void; - public describeSecret( - args: DescribeSecretCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSecretCommandOutput) => void), - cb?: (err: any, data?: DescribeSecretCommandOutput) => void - ): Promise | void { - const command = new DescribeSecretCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Generates a random password. We recommend that you specify the - * maximum length and include every character type that the system you are generating a password - * for can support.

- *

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

- *

- * Required permissions: - * secretsmanager:GetRandomPassword. - * For more information, see - * IAM policy actions for Secrets Manager and Authentication - * and access control in Secrets Manager.

+ * @see {@link GetRandomPasswordCommand} */ - public getRandomPassword( + getRandomPassword( args: GetRandomPasswordCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRandomPassword( + getRandomPassword( args: GetRandomPasswordCommandInput, cb: (err: any, data?: GetRandomPasswordCommandOutput) => void ): void; - public getRandomPassword( + getRandomPassword( args: GetRandomPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRandomPasswordCommandOutput) => void ): void; - public getRandomPassword( - args: GetRandomPasswordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRandomPasswordCommandOutput) => void), - cb?: (err: any, data?: GetRandomPasswordCommandOutput) => void - ): Promise | void { - const command = new GetRandomPasswordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the JSON text of the resource-based policy document attached to the - * secret. For more information about permissions policies attached to a secret, see - * Permissions - * policies attached to a secret.

- *

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

- *

- * Required permissions: - * secretsmanager:GetResourcePolicy. - * For more information, see - * IAM policy actions for Secrets Manager and Authentication - * and access control in Secrets Manager.

+ * @see {@link GetResourcePolicyCommand} */ - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void ): void; - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void ): void; - public getResourcePolicy( - args: GetResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: GetResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new GetResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the contents of the encrypted fields SecretString or - * SecretBinary from the specified version of a secret, whichever contains - * content.

- *

We recommend that you cache your secret values by using client-side caching. - * Caching secrets improves speed and reduces your costs. For more information, see Cache secrets for - * your applications.

- *

To retrieve the previous version of a secret, use VersionStage and specify - * AWSPREVIOUS. To revert to the previous version of a secret, call UpdateSecretVersionStage.

- *

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

- *

- * Required permissions: - * secretsmanager:GetSecretValue. - * If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key - * aws/secretsmanager, then you also need kms:Decrypt permissions for that key. - * For more information, see - * IAM policy actions for Secrets Manager and Authentication - * and access control in Secrets Manager.

+ * @see {@link GetSecretValueCommand} */ - public getSecretValue( + getSecretValue( args: GetSecretValueCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSecretValue( - args: GetSecretValueCommandInput, - cb: (err: any, data?: GetSecretValueCommandOutput) => void - ): void; - public getSecretValue( + getSecretValue(args: GetSecretValueCommandInput, cb: (err: any, data?: GetSecretValueCommandOutput) => void): void; + getSecretValue( args: GetSecretValueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSecretValueCommandOutput) => void ): void; - public getSecretValue( - args: GetSecretValueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSecretValueCommandOutput) => void), - cb?: (err: any, data?: GetSecretValueCommandOutput) => void - ): Promise | void { - const command = new GetSecretValueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets - * that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.

- *

ListSecrets is eventually consistent, however it might not reflect changes from the last five minutes. - * To get the latest information for a specific secret, use DescribeSecret.

- *

To list the versions of a secret, use ListSecretVersionIds.

- *

To get the secret value from SecretString or SecretBinary, - * call GetSecretValue.

- *

For information about finding secrets in the console, see Find secrets in Secrets Manager.

- *

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

- *

- * Required permissions: - * secretsmanager:ListSecrets. - * For more information, see - * IAM policy actions for Secrets Manager and Authentication - * and access control in Secrets Manager.

+ * @see {@link ListSecretsCommand} */ - public listSecrets(args: ListSecretsCommandInput, options?: __HttpHandlerOptions): Promise; - public listSecrets(args: ListSecretsCommandInput, cb: (err: any, data?: ListSecretsCommandOutput) => void): void; - public listSecrets( + listSecrets(args: ListSecretsCommandInput, options?: __HttpHandlerOptions): Promise; + listSecrets(args: ListSecretsCommandInput, cb: (err: any, data?: ListSecretsCommandOutput) => void): void; + listSecrets( args: ListSecretsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSecretsCommandOutput) => void ): void; - public listSecrets( - args: ListSecretsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSecretsCommandOutput) => void), - cb?: (err: any, data?: ListSecretsCommandOutput) => void - ): Promise | void { - const command = new ListSecretsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different versions - * of a secret. For more information, see - * Secrets Manager concepts: Versions.

- *

To list the secrets in the account, use ListSecrets.

- *

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

- *

- * Required permissions: - * secretsmanager:ListSecretVersionIds. - * For more information, see - * IAM policy actions for Secrets Manager and Authentication - * and access control in Secrets Manager.

+ * @see {@link ListSecretVersionIdsCommand} */ - public listSecretVersionIds( + listSecretVersionIds( args: ListSecretVersionIdsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSecretVersionIds( + listSecretVersionIds( args: ListSecretVersionIdsCommandInput, cb: (err: any, data?: ListSecretVersionIdsCommandOutput) => void ): void; - public listSecretVersionIds( + listSecretVersionIds( args: ListSecretVersionIdsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSecretVersionIdsCommandOutput) => void ): void; - public listSecretVersionIds( - args: ListSecretVersionIdsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSecretVersionIdsCommandOutput) => void), - cb?: (err: any, data?: ListSecretVersionIdsCommandOutput) => void - ): Promise | void { - const command = new ListSecretVersionIdsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Attaches a resource-based permission policy to a secret. A resource-based policy is - * optional. For more information, see Authentication and access control for Secrets Manager - *

- *

For information about attaching a policy in the console, see Attach a - * permissions policy to a secret.

- *

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

- *

- * Required permissions: - * secretsmanager:PutResourcePolicy. - * For more information, see - * IAM policy actions for Secrets Manager and Authentication - * and access control in Secrets Manager.

+ * @see {@link PutResourcePolicyCommand} */ - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( - args: PutResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: PutResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new PutResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new version with a new encrypted secret value and attaches it to the secret. The - * version can contain a new SecretString value or a new SecretBinary value.

- *

We recommend you avoid calling PutSecretValue at a sustained rate of more than - * once every 10 minutes. When you update the secret value, Secrets Manager creates a new version - * of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not - * remove versions created less than 24 hours ago. If you call PutSecretValue more - * than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach - * the quota for secret versions.

- *

You can specify the staging labels to attach to the new version in VersionStages. - * If you don't include VersionStages, then Secrets Manager automatically - * moves the staging label AWSCURRENT to this version. If this operation creates - * the first version for the secret, then Secrets Manager - * automatically attaches the staging label AWSCURRENT to it. - * If this operation moves the staging label AWSCURRENT from another version to this - * version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS to - * the version that AWSCURRENT was removed from.

- *

This operation is idempotent. If you call this operation with a ClientRequestToken - * that matches an existing version's VersionId, and you specify the - * same secret data, the operation succeeds but does nothing. However, if the secret data is - * different, then the operation fails because you can't modify an existing version; you can - * only create new ones.

- *

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

- *

- * Required permissions: - * secretsmanager:PutSecretValue. - * For more information, see - * IAM policy actions for Secrets Manager and Authentication - * and access control in Secrets Manager.

+ * @see {@link PutSecretValueCommand} */ - public putSecretValue( + putSecretValue( args: PutSecretValueCommandInput, options?: __HttpHandlerOptions ): Promise; - public putSecretValue( - args: PutSecretValueCommandInput, - cb: (err: any, data?: PutSecretValueCommandOutput) => void - ): void; - public putSecretValue( + putSecretValue(args: PutSecretValueCommandInput, cb: (err: any, data?: PutSecretValueCommandOutput) => void): void; + putSecretValue( args: PutSecretValueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSecretValueCommandOutput) => void ): void; - public putSecretValue( - args: PutSecretValueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutSecretValueCommandOutput) => void), - cb?: (err: any, data?: PutSecretValueCommandOutput) => void - ): Promise | void { - const command = new PutSecretValueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.

- *

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

- *

- * Required permissions: - * secretsmanager:RemoveRegionsFromReplication. - * For more information, see - * IAM policy actions for Secrets Manager and Authentication - * and access control in Secrets Manager.

+ * @see {@link RemoveRegionsFromReplicationCommand} */ - public removeRegionsFromReplication( + removeRegionsFromReplication( args: RemoveRegionsFromReplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeRegionsFromReplication( + removeRegionsFromReplication( args: RemoveRegionsFromReplicationCommandInput, cb: (err: any, data?: RemoveRegionsFromReplicationCommandOutput) => void ): void; - public removeRegionsFromReplication( + removeRegionsFromReplication( args: RemoveRegionsFromReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveRegionsFromReplicationCommandOutput) => void ): void; - public removeRegionsFromReplication( - args: RemoveRegionsFromReplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveRegionsFromReplicationCommandOutput) => void), - cb?: (err: any, data?: RemoveRegionsFromReplicationCommandOutput) => void - ): Promise | void { - const command = new RemoveRegionsFromReplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Replicates the secret to a new Regions. See Multi-Region secrets.

- *

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

- *

- * Required permissions: - * secretsmanager:ReplicateSecretToRegions. - * For more information, see - * IAM policy actions for Secrets Manager and Authentication - * and access control in Secrets Manager.

+ * @see {@link ReplicateSecretToRegionsCommand} */ - public replicateSecretToRegions( + replicateSecretToRegions( args: ReplicateSecretToRegionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public replicateSecretToRegions( + replicateSecretToRegions( args: ReplicateSecretToRegionsCommandInput, cb: (err: any, data?: ReplicateSecretToRegionsCommandOutput) => void ): void; - public replicateSecretToRegions( + replicateSecretToRegions( args: ReplicateSecretToRegionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReplicateSecretToRegionsCommandOutput) => void ): void; - public replicateSecretToRegions( - args: ReplicateSecretToRegionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReplicateSecretToRegionsCommandOutput) => void), - cb?: (err: any, data?: ReplicateSecretToRegionsCommandOutput) => void - ): Promise | void { - const command = new ReplicateSecretToRegionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels the scheduled deletion of a secret by removing the DeletedDate time - * stamp. You can access a secret again after it has been restored.

- *

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

- *

- * Required permissions: - * secretsmanager:RestoreSecret. - * For more information, see - * IAM policy actions for Secrets Manager and Authentication - * and access control in Secrets Manager.

+ * @see {@link RestoreSecretCommand} */ - public restoreSecret( - args: RestoreSecretCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public restoreSecret( - args: RestoreSecretCommandInput, - cb: (err: any, data?: RestoreSecretCommandOutput) => void - ): void; - public restoreSecret( + restoreSecret(args: RestoreSecretCommandInput, options?: __HttpHandlerOptions): Promise; + restoreSecret(args: RestoreSecretCommandInput, cb: (err: any, data?: RestoreSecretCommandOutput) => void): void; + restoreSecret( args: RestoreSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreSecretCommandOutput) => void ): void; - public restoreSecret( - args: RestoreSecretCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreSecretCommandOutput) => void), - cb?: (err: any, data?: RestoreSecretCommandOutput) => void - ): Promise | void { - const command = new RestoreSecretCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Configures and starts the asynchronous process of rotating the secret. For information about rotation, - * see Rotate secrets in the Secrets Manager User Guide. If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the values already stored in the secret.

- *

When rotation is successful, the AWSPENDING staging label might be attached - * to the same version as the AWSCURRENT version, or it might not be attached to any - * version. If the AWSPENDING staging label is present but not attached to the same - * version as AWSCURRENT, then any later invocation of RotateSecret - * assumes that a previous rotation request is still in progress and returns an error. When rotation is unsuccessful, the AWSPENDING staging label might be attached to an empty secret version. For more information, see Troubleshoot rotation in the Secrets Manager User Guide.

- *

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

- *

- * Required permissions: - * secretsmanager:RotateSecret. - * For more information, see - * IAM policy actions for Secrets Manager and Authentication - * and access control in Secrets Manager. You also need lambda:InvokeFunction permissions on the rotation function. - * For more information, see - * Permissions for rotation.

+ * @see {@link RotateSecretCommand} */ - public rotateSecret( - args: RotateSecretCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public rotateSecret(args: RotateSecretCommandInput, cb: (err: any, data?: RotateSecretCommandOutput) => void): void; - public rotateSecret( + rotateSecret(args: RotateSecretCommandInput, options?: __HttpHandlerOptions): Promise; + rotateSecret(args: RotateSecretCommandInput, cb: (err: any, data?: RotateSecretCommandOutput) => void): void; + rotateSecret( args: RotateSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RotateSecretCommandOutput) => void ): void; - public rotateSecret( - args: RotateSecretCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RotateSecretCommandOutput) => void), - cb?: (err: any, data?: RotateSecretCommandOutput) => void - ): Promise | void { - const command = new RotateSecretCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.

- *

You must call this operation from the Region in which you want to promote the replica to a primary secret.

- *

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

- *

- * Required permissions: - * secretsmanager:StopReplicationToReplica. - * For more information, see - * IAM policy actions for Secrets Manager and Authentication - * and access control in Secrets Manager.

+ * @see {@link StopReplicationToReplicaCommand} */ - public stopReplicationToReplica( + stopReplicationToReplica( args: StopReplicationToReplicaCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopReplicationToReplica( + stopReplicationToReplica( args: StopReplicationToReplicaCommandInput, cb: (err: any, data?: StopReplicationToReplicaCommandOutput) => void ): void; - public stopReplicationToReplica( + stopReplicationToReplica( args: StopReplicationToReplicaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopReplicationToReplicaCommandOutput) => void ): void; - public stopReplicationToReplica( - args: StopReplicationToReplicaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopReplicationToReplicaCommandOutput) => void), - cb?: (err: any, data?: StopReplicationToReplicaCommandOutput) => void - ): Promise | void { - const command = new StopReplicationToReplicaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the - * secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.

- *

The following restrictions apply to tags:

- *
    - *
  • - *

    Maximum number of tags per secret: 50

    - *
  • - *
  • - *

    Maximum key length: 127 Unicode characters in UTF-8

    - *
  • - *
  • - *

    Maximum value length: 255 Unicode characters in UTF-8

    - *
  • - *
  • - *

    Tag keys and values are case sensitive.

    - *
  • - *
  • - *

    Do not use the aws: prefix in your tag names or values because Amazon Web Services reserves it - * for Amazon Web Services use. You can't edit or delete tag names or values with this - * prefix. Tags with this prefix do not count against your tags per secret limit.

    - *
  • - *
  • - *

    If you use your tagging schema across multiple services and resources, - * other services might have restrictions on allowed characters. Generally - * allowed characters: letters, spaces, and numbers representable in UTF-8, plus the - * following special characters: + - = . _ : / @.

    - *
  • - *
- * - *

If you use tags as part of your security strategy, then adding or removing a tag can - * change permissions. If successfully completing this operation would result in you losing - * your permissions for this secret, then the operation is blocked and returns an Access Denied - * error.

- *
- *

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

- *

- * Required permissions: - * secretsmanager:TagResource. - * For more information, see - * IAM policy actions for Secrets Manager and Authentication - * and access control in Secrets Manager.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes specific tags from a secret.

- *

This operation is idempotent. If a requested tag is not attached to the secret, no error - * is returned and the secret metadata is unchanged.

- * - *

If you use tags as part of your security strategy, then removing a tag can change - * permissions. If successfully completing this operation would result in you losing your - * permissions for this secret, then the operation is blocked and returns an Access Denied - * error.

- *
- *

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

- *

- * Required permissions: - * secretsmanager:UntagResource. - * For more information, see - * IAM policy actions for Secrets Manager and Authentication - * and access control in Secrets Manager.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.

- *

To change the rotation configuration of a secret, use RotateSecret instead.

- *

To change a secret so that it is managed by another service, you need to recreate the secret in that service. See Secrets Manager secrets managed by other Amazon Web Services services.

- *

We recommend you avoid calling UpdateSecret at a sustained rate of more than - * once every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager creates a new version - * of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not - * remove versions created less than 24 hours ago. If you update the secret value more - * than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach - * the quota for secret versions.

- *

If you include SecretString or SecretBinary to create a new - * secret version, Secrets Manager automatically moves the staging label AWSCURRENT to the new - * version. Then it attaches the label AWSPREVIOUS - * to the version that AWSCURRENT was removed from.

- *

If you call this operation with a ClientRequestToken that matches an existing version's - * VersionId, the operation results in an error. You can't modify an existing - * version, you can only create a new version. To remove a version, remove all staging labels from it. See - * UpdateSecretVersionStage.

- *

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

- *

- * Required permissions: - * secretsmanager:UpdateSecret. - * For more information, see - * IAM policy actions for Secrets Manager and Authentication - * and access control in Secrets Manager. - * If you use a customer managed key, you must also have kms:GenerateDataKey and - * kms:Decrypt permissions on the key. For more information, see - * Secret encryption and decryption.

+ * @see {@link UpdateSecretCommand} */ - public updateSecret( - args: UpdateSecretCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateSecret(args: UpdateSecretCommandInput, cb: (err: any, data?: UpdateSecretCommandOutput) => void): void; - public updateSecret( + updateSecret(args: UpdateSecretCommandInput, options?: __HttpHandlerOptions): Promise; + updateSecret(args: UpdateSecretCommandInput, cb: (err: any, data?: UpdateSecretCommandOutput) => void): void; + updateSecret( args: UpdateSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSecretCommandOutput) => void ): void; - public updateSecret( - args: UpdateSecretCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSecretCommandOutput) => void), - cb?: (err: any, data?: UpdateSecretCommandOutput) => void - ): Promise | void { - const command = new UpdateSecretCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to - * track a version as it progresses through the secret rotation process. Each staging label can be - * attached to only one version at a time. To add a staging label to a version when it is already - * attached to another version, Secrets Manager first removes it from the other version first and - * then attaches it to this one. For more information about versions and staging labels, see Concepts: Version.

- *

The staging labels that you specify in the VersionStage parameter are added - * to the existing list of staging labels for the version.

- *

You can move the AWSCURRENT staging label to this version by including it in this - * call.

- * - *

Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS - * to the version that AWSCURRENT was removed from.

- *
- *

If this action results in the last label being removed from a version, then the version is - * considered to be 'deprecated' and can be deleted by Secrets Manager.

- *

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

- *

- * Required permissions: - * secretsmanager:UpdateSecretVersionStage. - * For more information, see - * IAM policy actions for Secrets Manager and Authentication - * and access control in Secrets Manager.

+ * @see {@link UpdateSecretVersionStageCommand} */ - public updateSecretVersionStage( + updateSecretVersionStage( args: UpdateSecretVersionStageCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSecretVersionStage( + updateSecretVersionStage( args: UpdateSecretVersionStageCommandInput, cb: (err: any, data?: UpdateSecretVersionStageCommandOutput) => void ): void; - public updateSecretVersionStage( + updateSecretVersionStage( args: UpdateSecretVersionStageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSecretVersionStageCommandOutput) => void ): void; - public updateSecretVersionStage( - args: UpdateSecretVersionStageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSecretVersionStageCommandOutput) => void), - cb?: (err: any, data?: UpdateSecretVersionStageCommandOutput) => void - ): Promise | void { - const command = new UpdateSecretVersionStageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Validates that a resource policy does not grant a wide range of principals access to - * your secret. A resource-based policy is optional for secrets.

- *

The API performs three checks when validating the policy:

- *
    - *
  • - *

    Sends a call to Zelkova, an automated reasoning engine, to ensure your resource policy does not - * allow broad access to your secret, for example policies that use a wildcard for the principal.

    - *
  • - *
  • - *

    Checks for correct syntax in a policy.

    - *
  • - *
  • - *

    Verifies the policy does not lock out a caller.

    - *
  • - *
- *

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

- *

- * Required permissions: - * secretsmanager:ValidateResourcePolicy. - * For more information, see - * IAM policy actions for Secrets Manager and Authentication - * and access control in Secrets Manager.

+ * @see {@link ValidateResourcePolicyCommand} */ - public validateResourcePolicy( + validateResourcePolicy( args: ValidateResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public validateResourcePolicy( + validateResourcePolicy( args: ValidateResourcePolicyCommandInput, cb: (err: any, data?: ValidateResourcePolicyCommandOutput) => void ): void; - public validateResourcePolicy( + validateResourcePolicy( args: ValidateResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidateResourcePolicyCommandOutput) => void ): void; - public validateResourcePolicy( - args: ValidateResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ValidateResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: ValidateResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new ValidateResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Web Services Secrets Manager + *

Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.

+ *

This guide provides descriptions of the Secrets Manager API. For more information about using this + * service, see the Amazon Web Services Secrets Manager User Guide.

+ *

+ * API Version + *

+ *

This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.

+ *

For a list of endpoints, see Amazon Web Services Secrets Manager + * endpoints.

+ *

+ * Support and Feedback for Amazon Web Services Secrets Manager + *

+ *

We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more + * information about the Amazon Web Services Discussion Forums, see Forums + * Help.

+ *

+ * Logging API Requests + *

+ *

Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services + * account and delivers log files to an Amazon S3 bucket. By using information that's collected + * by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the + * request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services + * CloudTrail, see Logging + * Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide. + * To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.

+ */ +export class SecretsManager extends SecretsManagerClient implements SecretsManager {} +createAggregatedClient(commands, SecretsManager); diff --git a/clients/client-securityhub/src/SecurityHub.ts b/clients/client-securityhub/src/SecurityHub.ts index ed45325318d0..61ba198a9868 100644 --- a/clients/client-securityhub/src/SecurityHub.ts +++ b/clients/client-securityhub/src/SecurityHub.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -282,2342 +283,1075 @@ import { UpdateStandardsControlCommandInput, UpdateStandardsControlCommandOutput, } from "./commands/UpdateStandardsControlCommand"; -import { SecurityHubClient } from "./SecurityHubClient"; +import { SecurityHubClient, SecurityHubClientConfig } from "./SecurityHubClient"; -/** - * @public - *

Security Hub provides you with a comprehensive view of the security state of - * your Amazon Web Services environment and resources. It also provides you with the readiness - * status of your environment based on controls from supported security standards. Security Hub collects security data from Amazon Web Services accounts, services, and - * integrated third-party products and helps you analyze security trends in your environment - * to identify the highest priority security issues. For more information about Security Hub, see the Security HubUser - * Guide.

- *

When you use operations in the Security Hub API, the requests are executed only in - * the Amazon Web Services Region that is currently active or in the specific Amazon Web Services Region that you specify in your request. Any configuration or settings change - * that results from the operation is applied only to that Region. To make the same change in - * other Regions, run the same command for each Region in which you want to apply the change.

- *

For example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of - * the member account with the administrator account is created only in the us-west-2 - * Region. Security Hub must be enabled for the member account in the same Region that the invitation - * was sent from.

- *

The following throttling limits apply to using Security Hub API operations.

- *
    - *
  • - *

    - * BatchEnableStandards - RateLimit of 1 request per - * second. BurstLimit of 1 request per second.

    - *
  • - *
  • - *

    - * GetFindings - RateLimit of 3 requests per second. - * BurstLimit of 6 requests per second.

    - *
  • - *
  • - *

    - * BatchImportFindings - RateLimit of 10 requests per second. - * BurstLimit of 30 requests per second.

    - *
  • - *
  • - *

    - * BatchUpdateFindings - RateLimit of 10 requests per second. - * BurstLimit of 30 requests per second.

    - *
  • - *
  • - *

    - * UpdateStandardsControl - RateLimit of 1 request per - * second. BurstLimit of 5 requests per second.

    - *
  • - *
  • - *

    All other operations - RateLimit of 10 requests per second. - * BurstLimit of 30 requests per second.

    - *
  • - *
- */ -export class SecurityHub extends SecurityHubClient { +const commands = { + AcceptAdministratorInvitationCommand, + AcceptInvitationCommand, + BatchDisableStandardsCommand, + BatchEnableStandardsCommand, + BatchGetSecurityControlsCommand, + BatchGetStandardsControlAssociationsCommand, + BatchImportFindingsCommand, + BatchUpdateFindingsCommand, + BatchUpdateStandardsControlAssociationsCommand, + CreateActionTargetCommand, + CreateFindingAggregatorCommand, + CreateInsightCommand, + CreateMembersCommand, + DeclineInvitationsCommand, + DeleteActionTargetCommand, + DeleteFindingAggregatorCommand, + DeleteInsightCommand, + DeleteInvitationsCommand, + DeleteMembersCommand, + DescribeActionTargetsCommand, + DescribeHubCommand, + DescribeOrganizationConfigurationCommand, + DescribeProductsCommand, + DescribeStandardsCommand, + DescribeStandardsControlsCommand, + DisableImportFindingsForProductCommand, + DisableOrganizationAdminAccountCommand, + DisableSecurityHubCommand, + DisassociateFromAdministratorAccountCommand, + DisassociateFromMasterAccountCommand, + DisassociateMembersCommand, + EnableImportFindingsForProductCommand, + EnableOrganizationAdminAccountCommand, + EnableSecurityHubCommand, + GetAdministratorAccountCommand, + GetEnabledStandardsCommand, + GetFindingAggregatorCommand, + GetFindingsCommand, + GetInsightResultsCommand, + GetInsightsCommand, + GetInvitationsCountCommand, + GetMasterAccountCommand, + GetMembersCommand, + InviteMembersCommand, + ListEnabledProductsForImportCommand, + ListFindingAggregatorsCommand, + ListInvitationsCommand, + ListMembersCommand, + ListOrganizationAdminAccountsCommand, + ListSecurityControlDefinitionsCommand, + ListStandardsControlAssociationsCommand, + ListTagsForResourceCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateActionTargetCommand, + UpdateFindingAggregatorCommand, + UpdateFindingsCommand, + UpdateInsightCommand, + UpdateOrganizationConfigurationCommand, + UpdateSecurityHubConfigurationCommand, + UpdateStandardsControlCommand, +}; + +export interface SecurityHub { /** - * @public - *

Accepts the invitation to be a member account and be monitored by the Security Hub administrator - * account that the invitation was sent from.

- *

This operation is only used by member accounts that are not added through - * Organizations.

- *

When the member account accepts the invitation, permission is granted to the administrator - * account to view findings generated in the member account.

+ * @see {@link AcceptAdministratorInvitationCommand} */ - public acceptAdministratorInvitation( + acceptAdministratorInvitation( args: AcceptAdministratorInvitationCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptAdministratorInvitation( + acceptAdministratorInvitation( args: AcceptAdministratorInvitationCommandInput, cb: (err: any, data?: AcceptAdministratorInvitationCommandOutput) => void ): void; - public acceptAdministratorInvitation( + acceptAdministratorInvitation( args: AcceptAdministratorInvitationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptAdministratorInvitationCommandOutput) => void ): void; - public acceptAdministratorInvitation( - args: AcceptAdministratorInvitationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptAdministratorInvitationCommandOutput) => void), - cb?: (err: any, data?: AcceptAdministratorInvitationCommandOutput) => void - ): Promise | void { - const command = new AcceptAdministratorInvitationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

This method is deprecated. Instead, use AcceptAdministratorInvitation.

- *

The Security Hub console continues to use AcceptInvitation. It will eventually change to use AcceptAdministratorInvitation. Any IAM policies that specifically control access to this function must continue to use AcceptInvitation. You should also add AcceptAdministratorInvitation to your policies to ensure that the correct permissions are in place after the console begins to use AcceptAdministratorInvitation.

- *

Accepts the invitation to be a member account and be monitored by the Security Hub administrator - * account that the invitation was sent from.

- *

This operation is only used by member accounts that are not added through - * Organizations.

- *

When the member account accepts the invitation, permission is granted to the administrator - * account to view findings generated in the member account.

+ * @see {@link AcceptInvitationCommand} */ - public acceptInvitation( + acceptInvitation( args: AcceptInvitationCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptInvitation( + acceptInvitation( args: AcceptInvitationCommandInput, cb: (err: any, data?: AcceptInvitationCommandOutput) => void ): void; - public acceptInvitation( + acceptInvitation( args: AcceptInvitationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptInvitationCommandOutput) => void ): void; - public acceptInvitation( - args: AcceptInvitationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptInvitationCommandOutput) => void), - cb?: (err: any, data?: AcceptInvitationCommandOutput) => void - ): Promise | void { - const command = new AcceptInvitationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables the standards specified by the provided - * StandardsSubscriptionArns.

- *

For more information, see Security Standards section of the Security Hub User - * Guide.

+ * @see {@link BatchDisableStandardsCommand} */ - public batchDisableStandards( + batchDisableStandards( args: BatchDisableStandardsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDisableStandards( + batchDisableStandards( args: BatchDisableStandardsCommandInput, cb: (err: any, data?: BatchDisableStandardsCommandOutput) => void ): void; - public batchDisableStandards( + batchDisableStandards( args: BatchDisableStandardsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDisableStandardsCommandOutput) => void ): void; - public batchDisableStandards( - args: BatchDisableStandardsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchDisableStandardsCommandOutput) => void), - cb?: (err: any, data?: BatchDisableStandardsCommandOutput) => void - ): Promise | void { - const command = new BatchDisableStandardsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the standards specified by the provided StandardsArn. To obtain the - * ARN for a standard, use the DescribeStandards - * operation.

- *

For more information, see the Security Standards - * section of the Security Hub User Guide.

+ * @see {@link BatchEnableStandardsCommand} */ - public batchEnableStandards( + batchEnableStandards( args: BatchEnableStandardsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchEnableStandards( + batchEnableStandards( args: BatchEnableStandardsCommandInput, cb: (err: any, data?: BatchEnableStandardsCommandOutput) => void ): void; - public batchEnableStandards( + batchEnableStandards( args: BatchEnableStandardsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchEnableStandardsCommandOutput) => void ): void; - public batchEnableStandards( - args: BatchEnableStandardsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchEnableStandardsCommandOutput) => void), - cb?: (err: any, data?: BatchEnableStandardsCommandOutput) => void - ): Promise | void { - const command = new BatchEnableStandardsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Provides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region. - *

+ * @see {@link BatchGetSecurityControlsCommand} */ - public batchGetSecurityControls( + batchGetSecurityControls( args: BatchGetSecurityControlsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetSecurityControls( + batchGetSecurityControls( args: BatchGetSecurityControlsCommandInput, cb: (err: any, data?: BatchGetSecurityControlsCommandOutput) => void ): void; - public batchGetSecurityControls( + batchGetSecurityControls( args: BatchGetSecurityControlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetSecurityControlsCommandOutput) => void ): void; - public batchGetSecurityControls( - args: BatchGetSecurityControlsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetSecurityControlsCommandOutput) => void), - cb?: (err: any, data?: BatchGetSecurityControlsCommandOutput) => void - ): Promise | void { - const command = new BatchGetSecurityControlsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard. - *

+ * @see {@link BatchGetStandardsControlAssociationsCommand} */ - public batchGetStandardsControlAssociations( + batchGetStandardsControlAssociations( args: BatchGetStandardsControlAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetStandardsControlAssociations( + batchGetStandardsControlAssociations( args: BatchGetStandardsControlAssociationsCommandInput, cb: (err: any, data?: BatchGetStandardsControlAssociationsCommandOutput) => void ): void; - public batchGetStandardsControlAssociations( + batchGetStandardsControlAssociations( args: BatchGetStandardsControlAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetStandardsControlAssociationsCommandOutput) => void ): void; - public batchGetStandardsControlAssociations( - args: BatchGetStandardsControlAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetStandardsControlAssociationsCommandOutput) => void), - cb?: (err: any, data?: BatchGetStandardsControlAssociationsCommandOutput) => void - ): Promise | void { - const command = new BatchGetStandardsControlAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Imports security findings generated by a finding provider into Security Hub. - * This action is requested by the finding provider to import its findings into - * Security Hub.

- *

- * BatchImportFindings must be called by one of the following:

- *
    - *
  • - *

    The Amazon Web Services account that is associated with a finding if you are using - * the default product ARN - * or are a partner sending findings from within a customer's Amazon Web Services account. - * In these cases, the identifier of the account that you are calling BatchImportFindings - * from needs to be the same as the AwsAccountId attribute for the finding.

    - *
  • - *
  • - *

    An Amazon Web Services account that Security Hub has allow-listed for an official partner - * integration. In this case, you can call BatchImportFindings from the allow-listed - * account and send findings from different customer accounts in the same batch.

    - *
  • - *
- *

The maximum allowed size for a finding is 240 Kb. An error is returned for any finding - * larger than 240 Kb.

- *

After a finding is created, BatchImportFindings cannot be used to update - * the following finding fields and objects, which Security Hub customers use to manage their - * investigation workflow.

- *
    - *
  • - *

    - * Note - *

    - *
  • - *
  • - *

    - * UserDefinedFields - *

    - *
  • - *
  • - *

    - * VerificationState - *

    - *
  • - *
  • - *

    - * Workflow - *

    - *
  • - *
- *

Finding providers also should not use BatchImportFindings to update the following attributes.

- *
    - *
  • - *

    - * Confidence - *

    - *
  • - *
  • - *

    - * Criticality - *

    - *
  • - *
  • - *

    - * RelatedFindings - *

    - *
  • - *
  • - *

    - * Severity - *

    - *
  • - *
  • - *

    - * Types - *

    - *
  • - *
- *

Instead, finding providers use FindingProviderFields to provide values for these attributes.

+ * @see {@link BatchImportFindingsCommand} */ - public batchImportFindings( + batchImportFindings( args: BatchImportFindingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchImportFindings( + batchImportFindings( args: BatchImportFindingsCommandInput, cb: (err: any, data?: BatchImportFindingsCommandOutput) => void ): void; - public batchImportFindings( + batchImportFindings( args: BatchImportFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchImportFindingsCommandOutput) => void ): void; - public batchImportFindings( - args: BatchImportFindingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchImportFindingsCommandOutput) => void), - cb?: (err: any, data?: BatchImportFindingsCommandOutput) => void - ): Promise | void { - const command = new BatchImportFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used by Security Hub customers to update information about their investigation into a finding. - * Requested by administrator accounts or member accounts. Administrator accounts can update findings for - * their account and their member accounts. Member accounts can update findings for their - * account.

- *

Updates from BatchUpdateFindings do not affect the value of - * UpdatedAt for a finding.

- *

Administrator and member accounts can use BatchUpdateFindings to update the - * following finding fields and objects.

- *
    - *
  • - *

    - * Confidence - *

    - *
  • - *
  • - *

    - * Criticality - *

    - *
  • - *
  • - *

    - * Note - *

    - *
  • - *
  • - *

    - * RelatedFindings - *

    - *
  • - *
  • - *

    - * Severity - *

    - *
  • - *
  • - *

    - * Types - *

    - *
  • - *
  • - *

    - * UserDefinedFields - *

    - *
  • - *
  • - *

    - * VerificationState - *

    - *
  • - *
  • - *

    - * Workflow - *

    - *
  • - *
- *

You can configure IAM policies to restrict access to fields and field values. For - * example, you might not want member accounts to be able to suppress findings or change the - * finding severity. See Configuring access to BatchUpdateFindings in the - * Security Hub User Guide.

+ * @see {@link BatchUpdateFindingsCommand} */ - public batchUpdateFindings( + batchUpdateFindings( args: BatchUpdateFindingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchUpdateFindings( + batchUpdateFindings( args: BatchUpdateFindingsCommandInput, cb: (err: any, data?: BatchUpdateFindingsCommandOutput) => void ): void; - public batchUpdateFindings( + batchUpdateFindings( args: BatchUpdateFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchUpdateFindingsCommandOutput) => void ): void; - public batchUpdateFindings( - args: BatchUpdateFindingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchUpdateFindingsCommandOutput) => void), - cb?: (err: any, data?: BatchUpdateFindingsCommandOutput) => void - ): Promise | void { - const command = new BatchUpdateFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * For a batch of security controls and standards, this operation updates the enablement status of a control in a standard. - *

+ * @see {@link BatchUpdateStandardsControlAssociationsCommand} */ - public batchUpdateStandardsControlAssociations( + batchUpdateStandardsControlAssociations( args: BatchUpdateStandardsControlAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchUpdateStandardsControlAssociations( + batchUpdateStandardsControlAssociations( args: BatchUpdateStandardsControlAssociationsCommandInput, cb: (err: any, data?: BatchUpdateStandardsControlAssociationsCommandOutput) => void ): void; - public batchUpdateStandardsControlAssociations( + batchUpdateStandardsControlAssociations( args: BatchUpdateStandardsControlAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchUpdateStandardsControlAssociationsCommandOutput) => void ): void; - public batchUpdateStandardsControlAssociations( - args: BatchUpdateStandardsControlAssociationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: BatchUpdateStandardsControlAssociationsCommandOutput) => void), - cb?: (err: any, data?: BatchUpdateStandardsControlAssociationsCommandOutput) => void - ): Promise | void { - const command = new BatchUpdateStandardsControlAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a custom action target in Security Hub.

- *

You can use custom actions on findings and insights in Security Hub to trigger target actions - * in Amazon CloudWatch Events.

+ * @see {@link CreateActionTargetCommand} */ - public createActionTarget( + createActionTarget( args: CreateActionTargetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createActionTarget( + createActionTarget( args: CreateActionTargetCommandInput, cb: (err: any, data?: CreateActionTargetCommandOutput) => void ): void; - public createActionTarget( + createActionTarget( args: CreateActionTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateActionTargetCommandOutput) => void ): void; - public createActionTarget( - args: CreateActionTargetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateActionTargetCommandOutput) => void), - cb?: (err: any, data?: CreateActionTargetCommandOutput) => void - ): Promise | void { - const command = new CreateActionTargetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used to enable finding aggregation. Must be called from the aggregation Region.

- *

For more details about cross-Region replication, see Configuring finding aggregation in the Security Hub User Guide. - *

+ * @see {@link CreateFindingAggregatorCommand} */ - public createFindingAggregator( + createFindingAggregator( args: CreateFindingAggregatorCommandInput, options?: __HttpHandlerOptions ): Promise; - public createFindingAggregator( + createFindingAggregator( args: CreateFindingAggregatorCommandInput, cb: (err: any, data?: CreateFindingAggregatorCommandOutput) => void ): void; - public createFindingAggregator( + createFindingAggregator( args: CreateFindingAggregatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFindingAggregatorCommandOutput) => void ): void; - public createFindingAggregator( - args: CreateFindingAggregatorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFindingAggregatorCommandOutput) => void), - cb?: (err: any, data?: CreateFindingAggregatorCommandOutput) => void - ): Promise | void { - const command = new CreateFindingAggregatorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate - * to a security issue that requires attention or remediation.

- *

To group the related findings in the insight, use the - * GroupByAttribute.

+ * @see {@link CreateInsightCommand} */ - public createInsight( - args: CreateInsightCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createInsight( - args: CreateInsightCommandInput, - cb: (err: any, data?: CreateInsightCommandOutput) => void - ): void; - public createInsight( + createInsight(args: CreateInsightCommandInput, options?: __HttpHandlerOptions): Promise; + createInsight(args: CreateInsightCommandInput, cb: (err: any, data?: CreateInsightCommandOutput) => void): void; + createInsight( args: CreateInsightCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInsightCommandOutput) => void ): void; - public createInsight( - args: CreateInsightCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateInsightCommandOutput) => void), - cb?: (err: any, data?: CreateInsightCommandOutput) => void - ): Promise | void { - const command = new CreateInsightCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a member association in Security Hub between the specified accounts and the account - * used to make the request, which is the administrator account. If you are integrated with - * Organizations, then the administrator account is designated by the organization management account.

- *

- * CreateMembers is always used to add accounts that are not organization - * members.

- *

For accounts that are managed using Organizations, CreateMembers is only used - * in the following cases:

- *
    - *
  • - *

    Security Hub is not configured to automatically add new organization accounts.

    - *
  • - *
  • - *

    The account was disassociated or deleted in Security Hub.

    - *
  • - *
- *

This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you - * can use the EnableSecurityHub operation.

- *

For accounts that are not organization members, you create the account association and - * then send an invitation to the member account. To send the invitation, you use the - * InviteMembers operation. If the account owner accepts - * the invitation, the account becomes a member account in Security Hub.

- *

Accounts that are managed using Organizations do not receive an invitation. They - * automatically become a member account in Security Hub.

- *
    - *
  • - *

    If the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account.

    - *
  • - *
  • - *

    For organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls.

    - *
  • - *
- *

A permissions policy is added that permits the administrator account to view the findings - * generated in the member account.

- *

To remove the association between the administrator and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.

+ * @see {@link CreateMembersCommand} */ - public createMembers( - args: CreateMembersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createMembers( - args: CreateMembersCommandInput, - cb: (err: any, data?: CreateMembersCommandOutput) => void - ): void; - public createMembers( + createMembers(args: CreateMembersCommandInput, options?: __HttpHandlerOptions): Promise; + createMembers(args: CreateMembersCommandInput, cb: (err: any, data?: CreateMembersCommandOutput) => void): void; + createMembers( args: CreateMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMembersCommandOutput) => void ): void; - public createMembers( - args: CreateMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMembersCommandOutput) => void), - cb?: (err: any, data?: CreateMembersCommandOutput) => void - ): Promise | void { - const command = new CreateMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Declines invitations to become a member account.

- *

A prospective member account uses this operation to decline an invitation to become a member.

- *

This operation is only called by member accounts that aren't part of an organization. - * Organization accounts don't receive invitations.

+ * @see {@link DeclineInvitationsCommand} */ - public declineInvitations( + declineInvitations( args: DeclineInvitationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public declineInvitations( + declineInvitations( args: DeclineInvitationsCommandInput, cb: (err: any, data?: DeclineInvitationsCommandOutput) => void ): void; - public declineInvitations( + declineInvitations( args: DeclineInvitationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeclineInvitationsCommandOutput) => void ): void; - public declineInvitations( - args: DeclineInvitationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeclineInvitationsCommandOutput) => void), - cb?: (err: any, data?: DeclineInvitationsCommandOutput) => void - ): Promise | void { - const command = new DeclineInvitationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a custom action target from Security Hub.

- *

Deleting a custom action target does not affect any findings or insights that were - * already sent to Amazon CloudWatch Events using the custom action.

+ * @see {@link DeleteActionTargetCommand} */ - public deleteActionTarget( + deleteActionTarget( args: DeleteActionTargetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteActionTarget( + deleteActionTarget( args: DeleteActionTargetCommandInput, cb: (err: any, data?: DeleteActionTargetCommandOutput) => void ): void; - public deleteActionTarget( + deleteActionTarget( args: DeleteActionTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteActionTargetCommandOutput) => void ): void; - public deleteActionTarget( - args: DeleteActionTargetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteActionTargetCommandOutput) => void), - cb?: (err: any, data?: DeleteActionTargetCommandOutput) => void - ): Promise | void { - const command = new DeleteActionTargetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a finding aggregator. When you delete the finding aggregator, you stop finding aggregation.

- *

When you stop finding aggregation, findings that were already aggregated to the aggregation Region are still visible from the aggregation Region. New findings and finding updates are not aggregated. - *

+ * @see {@link DeleteFindingAggregatorCommand} */ - public deleteFindingAggregator( + deleteFindingAggregator( args: DeleteFindingAggregatorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFindingAggregator( + deleteFindingAggregator( args: DeleteFindingAggregatorCommandInput, cb: (err: any, data?: DeleteFindingAggregatorCommandOutput) => void ): void; - public deleteFindingAggregator( + deleteFindingAggregator( args: DeleteFindingAggregatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFindingAggregatorCommandOutput) => void ): void; - public deleteFindingAggregator( - args: DeleteFindingAggregatorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFindingAggregatorCommandOutput) => void), - cb?: (err: any, data?: DeleteFindingAggregatorCommandOutput) => void - ): Promise | void { - const command = new DeleteFindingAggregatorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the insight specified by the InsightArn.

+ * @see {@link DeleteInsightCommand} */ - public deleteInsight( - args: DeleteInsightCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteInsight( - args: DeleteInsightCommandInput, - cb: (err: any, data?: DeleteInsightCommandOutput) => void - ): void; - public deleteInsight( + deleteInsight(args: DeleteInsightCommandInput, options?: __HttpHandlerOptions): Promise; + deleteInsight(args: DeleteInsightCommandInput, cb: (err: any, data?: DeleteInsightCommandOutput) => void): void; + deleteInsight( args: DeleteInsightCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInsightCommandOutput) => void ): void; - public deleteInsight( - args: DeleteInsightCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInsightCommandOutput) => void), - cb?: (err: any, data?: DeleteInsightCommandOutput) => void - ): Promise | void { - const command = new DeleteInsightCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes invitations received by the Amazon Web Services account to become a member account.

- *

A Security Hub administrator account can use this operation to delete invitations sent to one or more member accounts.

- *

This operation is only used to delete invitations that are sent to member accounts that aren't part of an organization. - * Organization accounts don't receive invitations.

+ * @see {@link DeleteInvitationsCommand} */ - public deleteInvitations( + deleteInvitations( args: DeleteInvitationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInvitations( + deleteInvitations( args: DeleteInvitationsCommandInput, cb: (err: any, data?: DeleteInvitationsCommandOutput) => void ): void; - public deleteInvitations( + deleteInvitations( args: DeleteInvitationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInvitationsCommandOutput) => void ): void; - public deleteInvitations( - args: DeleteInvitationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInvitationsCommandOutput) => void), - cb?: (err: any, data?: DeleteInvitationsCommandOutput) => void - ): Promise | void { - const command = new DeleteInvitationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified member accounts from Security Hub.

- *

Can be used to delete member accounts that belong to an organization as well as member - * accounts that were invited manually.

+ * @see {@link DeleteMembersCommand} */ - public deleteMembers( - args: DeleteMembersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteMembers( - args: DeleteMembersCommandInput, - cb: (err: any, data?: DeleteMembersCommandOutput) => void - ): void; - public deleteMembers( + deleteMembers(args: DeleteMembersCommandInput, options?: __HttpHandlerOptions): Promise; + deleteMembers(args: DeleteMembersCommandInput, cb: (err: any, data?: DeleteMembersCommandOutput) => void): void; + deleteMembers( args: DeleteMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMembersCommandOutput) => void ): void; - public deleteMembers( - args: DeleteMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMembersCommandOutput) => void), - cb?: (err: any, data?: DeleteMembersCommandOutput) => void - ): Promise | void { - const command = new DeleteMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the custom action targets in Security Hub in your account.

+ * @see {@link DescribeActionTargetsCommand} */ - public describeActionTargets( + describeActionTargets( args: DescribeActionTargetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeActionTargets( + describeActionTargets( args: DescribeActionTargetsCommandInput, cb: (err: any, data?: DescribeActionTargetsCommandOutput) => void ): void; - public describeActionTargets( + describeActionTargets( args: DescribeActionTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeActionTargetsCommandOutput) => void ): void; - public describeActionTargets( - args: DescribeActionTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeActionTargetsCommandOutput) => void), - cb?: (err: any, data?: DescribeActionTargetsCommandOutput) => void - ): Promise | void { - const command = new DescribeActionTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns details about the Hub resource in your account, including the - * HubArn and the time when you enabled Security Hub.

+ * @see {@link DescribeHubCommand} */ - public describeHub(args: DescribeHubCommandInput, options?: __HttpHandlerOptions): Promise; - public describeHub(args: DescribeHubCommandInput, cb: (err: any, data?: DescribeHubCommandOutput) => void): void; - public describeHub( + describeHub(args: DescribeHubCommandInput, options?: __HttpHandlerOptions): Promise; + describeHub(args: DescribeHubCommandInput, cb: (err: any, data?: DescribeHubCommandOutput) => void): void; + describeHub( args: DescribeHubCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHubCommandOutput) => void ): void; - public describeHub( - args: DescribeHubCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeHubCommandOutput) => void), - cb?: (err: any, data?: DescribeHubCommandOutput) => void - ): Promise | void { - const command = new DescribeHubCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the Organizations configuration for Security Hub. Can only be - * called from a Security Hub administrator account.

+ * @see {@link DescribeOrganizationConfigurationCommand} */ - public describeOrganizationConfiguration( + describeOrganizationConfiguration( args: DescribeOrganizationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOrganizationConfiguration( + describeOrganizationConfiguration( args: DescribeOrganizationConfigurationCommandInput, cb: (err: any, data?: DescribeOrganizationConfigurationCommandOutput) => void ): void; - public describeOrganizationConfiguration( + describeOrganizationConfiguration( args: DescribeOrganizationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrganizationConfigurationCommandOutput) => void ): void; - public describeOrganizationConfiguration( - args: DescribeOrganizationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOrganizationConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeOrganizationConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeOrganizationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about product integrations in Security Hub.

- *

You can optionally provide an integration ARN. If you provide an integration ARN, then - * the results only include that integration.

- *

If you do not provide an integration ARN, then the results include all of the available - * product integrations.

+ * @see {@link DescribeProductsCommand} */ - public describeProducts( + describeProducts( args: DescribeProductsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProducts( + describeProducts( args: DescribeProductsCommandInput, cb: (err: any, data?: DescribeProductsCommandOutput) => void ): void; - public describeProducts( + describeProducts( args: DescribeProductsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProductsCommandOutput) => void ): void; - public describeProducts( - args: DescribeProductsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProductsCommandOutput) => void), - cb?: (err: any, data?: DescribeProductsCommandOutput) => void - ): Promise | void { - const command = new DescribeProductsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the available standards in Security Hub.

- *

For each standard, the results include the standard ARN, the name, and a description.

+ * @see {@link DescribeStandardsCommand} */ - public describeStandards( + describeStandards( args: DescribeStandardsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStandards( + describeStandards( args: DescribeStandardsCommandInput, cb: (err: any, data?: DescribeStandardsCommandOutput) => void ): void; - public describeStandards( + describeStandards( args: DescribeStandardsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStandardsCommandOutput) => void ): void; - public describeStandards( - args: DescribeStandardsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStandardsCommandOutput) => void), - cb?: (err: any, data?: DescribeStandardsCommandOutput) => void - ): Promise | void { - const command = new DescribeStandardsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of security standards controls.

- *

For each control, the results include information about whether it is currently enabled, - * the severity, and a link to remediation information.

+ * @see {@link DescribeStandardsControlsCommand} */ - public describeStandardsControls( + describeStandardsControls( args: DescribeStandardsControlsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStandardsControls( + describeStandardsControls( args: DescribeStandardsControlsCommandInput, cb: (err: any, data?: DescribeStandardsControlsCommandOutput) => void ): void; - public describeStandardsControls( + describeStandardsControls( args: DescribeStandardsControlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStandardsControlsCommandOutput) => void ): void; - public describeStandardsControls( - args: DescribeStandardsControlsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStandardsControlsCommandOutput) => void), - cb?: (err: any, data?: DescribeStandardsControlsCommandOutput) => void - ): Promise | void { - const command = new DescribeStandardsControlsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables the integration of the specified product with Security Hub. After the integration is - * disabled, findings from that product are no longer sent to Security Hub.

+ * @see {@link DisableImportFindingsForProductCommand} */ - public disableImportFindingsForProduct( + disableImportFindingsForProduct( args: DisableImportFindingsForProductCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableImportFindingsForProduct( + disableImportFindingsForProduct( args: DisableImportFindingsForProductCommandInput, cb: (err: any, data?: DisableImportFindingsForProductCommandOutput) => void ): void; - public disableImportFindingsForProduct( + disableImportFindingsForProduct( args: DisableImportFindingsForProductCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableImportFindingsForProductCommandOutput) => void ): void; - public disableImportFindingsForProduct( - args: DisableImportFindingsForProductCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableImportFindingsForProductCommandOutput) => void), - cb?: (err: any, data?: DisableImportFindingsForProductCommandOutput) => void - ): Promise | void { - const command = new DisableImportFindingsForProductCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables a Security Hub administrator account. Can only be called by the organization - * management account.

+ * @see {@link DisableOrganizationAdminAccountCommand} */ - public disableOrganizationAdminAccount( + disableOrganizationAdminAccount( args: DisableOrganizationAdminAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableOrganizationAdminAccount( + disableOrganizationAdminAccount( args: DisableOrganizationAdminAccountCommandInput, cb: (err: any, data?: DisableOrganizationAdminAccountCommandOutput) => void ): void; - public disableOrganizationAdminAccount( + disableOrganizationAdminAccount( args: DisableOrganizationAdminAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableOrganizationAdminAccountCommandOutput) => void ): void; - public disableOrganizationAdminAccount( - args: DisableOrganizationAdminAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableOrganizationAdminAccountCommandOutput) => void), - cb?: (err: any, data?: DisableOrganizationAdminAccountCommandOutput) => void - ): Promise | void { - const command = new DisableOrganizationAdminAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables Security Hub in your account only in the current Region. To disable Security Hub in all - * Regions, you must submit one request per Region where you have enabled Security Hub.

- *

When you disable Security Hub for an administrator account, it doesn't disable Security Hub for any associated - * member accounts.

- *

When you disable Security Hub, your existing findings and insights and any Security Hub configuration - * settings are deleted after 90 days and cannot be recovered. Any standards that were enabled - * are disabled, and your administrator and member account associations are removed.

- *

If you want to save your existing findings, you must export them before you disable - * Security Hub.

+ * @see {@link DisableSecurityHubCommand} */ - public disableSecurityHub( + disableSecurityHub( args: DisableSecurityHubCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableSecurityHub( + disableSecurityHub( args: DisableSecurityHubCommandInput, cb: (err: any, data?: DisableSecurityHubCommandOutput) => void ): void; - public disableSecurityHub( + disableSecurityHub( args: DisableSecurityHubCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableSecurityHubCommandOutput) => void ): void; - public disableSecurityHub( - args: DisableSecurityHubCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableSecurityHubCommandOutput) => void), - cb?: (err: any, data?: DisableSecurityHubCommandOutput) => void - ): Promise | void { - const command = new DisableSecurityHubCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates the current Security Hub member account from the associated administrator - * account.

- *

This operation is only used by accounts that are not part of an organization. For - * organization accounts, only the administrator account can - * disassociate a member account.

+ * @see {@link DisassociateFromAdministratorAccountCommand} */ - public disassociateFromAdministratorAccount( + disassociateFromAdministratorAccount( args: DisassociateFromAdministratorAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateFromAdministratorAccount( + disassociateFromAdministratorAccount( args: DisassociateFromAdministratorAccountCommandInput, cb: (err: any, data?: DisassociateFromAdministratorAccountCommandOutput) => void ): void; - public disassociateFromAdministratorAccount( + disassociateFromAdministratorAccount( args: DisassociateFromAdministratorAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateFromAdministratorAccountCommandOutput) => void ): void; - public disassociateFromAdministratorAccount( - args: DisassociateFromAdministratorAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateFromAdministratorAccountCommandOutput) => void), - cb?: (err: any, data?: DisassociateFromAdministratorAccountCommandOutput) => void - ): Promise | void { - const command = new DisassociateFromAdministratorAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

This method is deprecated. Instead, use DisassociateFromAdministratorAccount.

- *

The Security Hub console continues to use DisassociateFromMasterAccount. It will eventually change to use DisassociateFromAdministratorAccount. Any IAM policies that specifically control access to this function must continue to use DisassociateFromMasterAccount. You should also add DisassociateFromAdministratorAccount to your policies to ensure that the correct permissions are in place after the console begins to use DisassociateFromAdministratorAccount.

- *

Disassociates the current Security Hub member account from the associated administrator - * account.

- *

This operation is only used by accounts that are not part of an organization. For - * organization accounts, only the administrator account can - * disassociate a member account.

+ * @see {@link DisassociateFromMasterAccountCommand} */ - public disassociateFromMasterAccount( + disassociateFromMasterAccount( args: DisassociateFromMasterAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateFromMasterAccount( + disassociateFromMasterAccount( args: DisassociateFromMasterAccountCommandInput, cb: (err: any, data?: DisassociateFromMasterAccountCommandOutput) => void ): void; - public disassociateFromMasterAccount( + disassociateFromMasterAccount( args: DisassociateFromMasterAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateFromMasterAccountCommandOutput) => void ): void; - public disassociateFromMasterAccount( - args: DisassociateFromMasterAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateFromMasterAccountCommandOutput) => void), - cb?: (err: any, data?: DisassociateFromMasterAccountCommandOutput) => void - ): Promise | void { - const command = new DisassociateFromMasterAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates the specified member accounts from the associated administrator account.

- *

Can be used to disassociate both accounts that are managed using Organizations and accounts that - * were invited manually.

+ * @see {@link DisassociateMembersCommand} */ - public disassociateMembers( + disassociateMembers( args: DisassociateMembersCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateMembers( + disassociateMembers( args: DisassociateMembersCommandInput, cb: (err: any, data?: DisassociateMembersCommandOutput) => void ): void; - public disassociateMembers( + disassociateMembers( args: DisassociateMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateMembersCommandOutput) => void ): void; - public disassociateMembers( - args: DisassociateMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateMembersCommandOutput) => void), - cb?: (err: any, data?: DisassociateMembersCommandOutput) => void - ): Promise | void { - const command = new DisassociateMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the integration of a partner product with Security Hub. Integrated products send - * findings to Security Hub.

- *

When you enable a product integration, a permissions policy that grants permission for - * the product to send findings to Security Hub is applied.

+ * @see {@link EnableImportFindingsForProductCommand} */ - public enableImportFindingsForProduct( + enableImportFindingsForProduct( args: EnableImportFindingsForProductCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableImportFindingsForProduct( + enableImportFindingsForProduct( args: EnableImportFindingsForProductCommandInput, cb: (err: any, data?: EnableImportFindingsForProductCommandOutput) => void ): void; - public enableImportFindingsForProduct( + enableImportFindingsForProduct( args: EnableImportFindingsForProductCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableImportFindingsForProductCommandOutput) => void ): void; - public enableImportFindingsForProduct( - args: EnableImportFindingsForProductCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableImportFindingsForProductCommandOutput) => void), - cb?: (err: any, data?: EnableImportFindingsForProductCommandOutput) => void - ): Promise | void { - const command = new EnableImportFindingsForProductCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Designates the Security Hub administrator account for an organization. Can only be called by - * the organization management account.

+ * @see {@link EnableOrganizationAdminAccountCommand} */ - public enableOrganizationAdminAccount( + enableOrganizationAdminAccount( args: EnableOrganizationAdminAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableOrganizationAdminAccount( + enableOrganizationAdminAccount( args: EnableOrganizationAdminAccountCommandInput, cb: (err: any, data?: EnableOrganizationAdminAccountCommandOutput) => void ): void; - public enableOrganizationAdminAccount( + enableOrganizationAdminAccount( args: EnableOrganizationAdminAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableOrganizationAdminAccountCommandOutput) => void ): void; - public enableOrganizationAdminAccount( - args: EnableOrganizationAdminAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableOrganizationAdminAccountCommandOutput) => void), - cb?: (err: any, data?: EnableOrganizationAdminAccountCommandOutput) => void - ): Promise | void { - const command = new EnableOrganizationAdminAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables Security Hub for your account in the current Region or the Region you specify in the - * request.

- *

When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings - * from other services that are integrated with Security Hub.

- *

When you use the EnableSecurityHub operation to enable Security Hub, you also - * automatically enable the following standards:

- *
    - *
  • - *

    Center for Internet Security (CIS) Amazon Web Services Foundations Benchmark v1.2.0

    - *
  • - *
  • - *

    Amazon Web Services Foundational Security Best Practices

    - *
  • - *
- *

Other standards are not automatically enabled.

- *

To opt out of automatically enabled standards, set - * EnableDefaultStandards to false.

- *

After you enable Security Hub, to enable a standard, use the BatchEnableStandards operation. To disable a standard, use the - * BatchDisableStandards operation.

- *

To learn more, see the setup information in the Security Hub User Guide.

+ * @see {@link EnableSecurityHubCommand} */ - public enableSecurityHub( + enableSecurityHub( args: EnableSecurityHubCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableSecurityHub( + enableSecurityHub( args: EnableSecurityHubCommandInput, cb: (err: any, data?: EnableSecurityHubCommandOutput) => void ): void; - public enableSecurityHub( + enableSecurityHub( args: EnableSecurityHubCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableSecurityHubCommandOutput) => void ): void; - public enableSecurityHub( - args: EnableSecurityHubCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableSecurityHubCommandOutput) => void), - cb?: (err: any, data?: EnableSecurityHubCommandOutput) => void - ): Promise | void { - const command = new EnableSecurityHubCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides the details for the Security Hub administrator account for the current member account.

- *

Can be used by both member accounts that are managed using Organizations and accounts that were - * invited manually.

+ * @see {@link GetAdministratorAccountCommand} */ - public getAdministratorAccount( + getAdministratorAccount( args: GetAdministratorAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAdministratorAccount( + getAdministratorAccount( args: GetAdministratorAccountCommandInput, cb: (err: any, data?: GetAdministratorAccountCommandOutput) => void ): void; - public getAdministratorAccount( + getAdministratorAccount( args: GetAdministratorAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAdministratorAccountCommandOutput) => void ): void; - public getAdministratorAccount( - args: GetAdministratorAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAdministratorAccountCommandOutput) => void), - cb?: (err: any, data?: GetAdministratorAccountCommandOutput) => void - ): Promise | void { - const command = new GetAdministratorAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the standards that are currently enabled.

+ * @see {@link GetEnabledStandardsCommand} */ - public getEnabledStandards( + getEnabledStandards( args: GetEnabledStandardsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEnabledStandards( + getEnabledStandards( args: GetEnabledStandardsCommandInput, cb: (err: any, data?: GetEnabledStandardsCommandOutput) => void ): void; - public getEnabledStandards( + getEnabledStandards( args: GetEnabledStandardsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEnabledStandardsCommandOutput) => void ): void; - public getEnabledStandards( - args: GetEnabledStandardsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEnabledStandardsCommandOutput) => void), - cb?: (err: any, data?: GetEnabledStandardsCommandOutput) => void - ): Promise | void { - const command = new GetEnabledStandardsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the current finding aggregation configuration.

+ * @see {@link GetFindingAggregatorCommand} */ - public getFindingAggregator( + getFindingAggregator( args: GetFindingAggregatorCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFindingAggregator( + getFindingAggregator( args: GetFindingAggregatorCommandInput, cb: (err: any, data?: GetFindingAggregatorCommandOutput) => void ): void; - public getFindingAggregator( + getFindingAggregator( args: GetFindingAggregatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFindingAggregatorCommandOutput) => void ): void; - public getFindingAggregator( - args: GetFindingAggregatorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFindingAggregatorCommandOutput) => void), - cb?: (err: any, data?: GetFindingAggregatorCommandOutput) => void - ): Promise | void { - const command = new GetFindingAggregatorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of findings that match the specified criteria.

- *

If finding aggregation is enabled, then when you call GetFindings from the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.

+ * @see {@link GetFindingsCommand} */ - public getFindings(args: GetFindingsCommandInput, options?: __HttpHandlerOptions): Promise; - public getFindings(args: GetFindingsCommandInput, cb: (err: any, data?: GetFindingsCommandOutput) => void): void; - public getFindings( + getFindings(args: GetFindingsCommandInput, options?: __HttpHandlerOptions): Promise; + getFindings(args: GetFindingsCommandInput, cb: (err: any, data?: GetFindingsCommandOutput) => void): void; + getFindings( args: GetFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFindingsCommandOutput) => void ): void; - public getFindings( - args: GetFindingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFindingsCommandOutput) => void), - cb?: (err: any, data?: GetFindingsCommandOutput) => void - ): Promise | void { - const command = new GetFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the results of the Security Hub insight specified by the insight ARN.

+ * @see {@link GetInsightResultsCommand} */ - public getInsightResults( + getInsightResults( args: GetInsightResultsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInsightResults( + getInsightResults( args: GetInsightResultsCommandInput, cb: (err: any, data?: GetInsightResultsCommandOutput) => void ): void; - public getInsightResults( + getInsightResults( args: GetInsightResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInsightResultsCommandOutput) => void ): void; - public getInsightResults( - args: GetInsightResultsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInsightResultsCommandOutput) => void), - cb?: (err: any, data?: GetInsightResultsCommandOutput) => void - ): Promise | void { - const command = new GetInsightResultsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists and describes insights for the specified insight ARNs.

+ * @see {@link GetInsightsCommand} */ - public getInsights(args: GetInsightsCommandInput, options?: __HttpHandlerOptions): Promise; - public getInsights(args: GetInsightsCommandInput, cb: (err: any, data?: GetInsightsCommandOutput) => void): void; - public getInsights( + getInsights(args: GetInsightsCommandInput, options?: __HttpHandlerOptions): Promise; + getInsights(args: GetInsightsCommandInput, cb: (err: any, data?: GetInsightsCommandOutput) => void): void; + getInsights( args: GetInsightsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInsightsCommandOutput) => void ): void; - public getInsights( - args: GetInsightsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInsightsCommandOutput) => void), - cb?: (err: any, data?: GetInsightsCommandOutput) => void - ): Promise | void { - const command = new GetInsightsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the count of all Security Hub membership invitations that were sent to the - * current member account, not including the currently accepted invitation.

+ * @see {@link GetInvitationsCountCommand} */ - public getInvitationsCount( + getInvitationsCount( args: GetInvitationsCountCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInvitationsCount( + getInvitationsCount( args: GetInvitationsCountCommandInput, cb: (err: any, data?: GetInvitationsCountCommandOutput) => void ): void; - public getInvitationsCount( + getInvitationsCount( args: GetInvitationsCountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInvitationsCountCommandOutput) => void ): void; - public getInvitationsCount( - args: GetInvitationsCountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInvitationsCountCommandOutput) => void), - cb?: (err: any, data?: GetInvitationsCountCommandOutput) => void - ): Promise | void { - const command = new GetInvitationsCountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

This method is deprecated. Instead, use GetAdministratorAccount.

- *

The Security Hub console continues to use GetMasterAccount. It will eventually change to use GetAdministratorAccount. Any IAM policies that specifically control access to this function must continue to use GetMasterAccount. You should also add GetAdministratorAccount to your policies to ensure that the correct permissions are in place after the console begins to use GetAdministratorAccount.

- *

Provides the details for the Security Hub administrator account for the current member account.

- *

Can be used by both member accounts that are managed using Organizations and accounts that were - * invited manually.

+ * @see {@link GetMasterAccountCommand} */ - public getMasterAccount( + getMasterAccount( args: GetMasterAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMasterAccount( + getMasterAccount( args: GetMasterAccountCommandInput, cb: (err: any, data?: GetMasterAccountCommandOutput) => void ): void; - public getMasterAccount( + getMasterAccount( args: GetMasterAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMasterAccountCommandOutput) => void ): void; - public getMasterAccount( - args: GetMasterAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMasterAccountCommandOutput) => void), - cb?: (err: any, data?: GetMasterAccountCommandOutput) => void - ): Promise | void { - const command = new GetMasterAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the details for the Security Hub member accounts for the specified account IDs.

- *

An administrator account can be either the delegated Security Hub administrator account for an - * organization or an administrator account that enabled Security Hub manually.

- *

The results include both member accounts that are managed using Organizations and accounts that - * were invited manually.

+ * @see {@link GetMembersCommand} */ - public getMembers(args: GetMembersCommandInput, options?: __HttpHandlerOptions): Promise; - public getMembers(args: GetMembersCommandInput, cb: (err: any, data?: GetMembersCommandOutput) => void): void; - public getMembers( + getMembers(args: GetMembersCommandInput, options?: __HttpHandlerOptions): Promise; + getMembers(args: GetMembersCommandInput, cb: (err: any, data?: GetMembersCommandOutput) => void): void; + getMembers( args: GetMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMembersCommandOutput) => void ): void; - public getMembers( - args: GetMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMembersCommandOutput) => void), - cb?: (err: any, data?: GetMembersCommandOutput) => void - ): Promise | void { - const command = new GetMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that - * the invitation is sent from.

- *

This operation is only used to invite accounts that do not belong to an organization. - * Organization accounts do not receive invitations.

- *

Before you can use this action to invite a member, you must first use the CreateMembers action to create the member account in Security Hub.

- *

When the account owner enables Security Hub and accepts the invitation to become a member - * account, the administrator account can view the findings generated from the member account.

+ * @see {@link InviteMembersCommand} */ - public inviteMembers( - args: InviteMembersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public inviteMembers( - args: InviteMembersCommandInput, - cb: (err: any, data?: InviteMembersCommandOutput) => void - ): void; - public inviteMembers( + inviteMembers(args: InviteMembersCommandInput, options?: __HttpHandlerOptions): Promise; + inviteMembers(args: InviteMembersCommandInput, cb: (err: any, data?: InviteMembersCommandOutput) => void): void; + inviteMembers( args: InviteMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InviteMembersCommandOutput) => void ): void; - public inviteMembers( - args: InviteMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InviteMembersCommandOutput) => void), - cb?: (err: any, data?: InviteMembersCommandOutput) => void - ): Promise | void { - const command = new InviteMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all findings-generating solutions (products) that you are subscribed to receive - * findings from in Security Hub.

+ * @see {@link ListEnabledProductsForImportCommand} */ - public listEnabledProductsForImport( + listEnabledProductsForImport( args: ListEnabledProductsForImportCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEnabledProductsForImport( + listEnabledProductsForImport( args: ListEnabledProductsForImportCommandInput, cb: (err: any, data?: ListEnabledProductsForImportCommandOutput) => void ): void; - public listEnabledProductsForImport( + listEnabledProductsForImport( args: ListEnabledProductsForImportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnabledProductsForImportCommandOutput) => void ): void; - public listEnabledProductsForImport( - args: ListEnabledProductsForImportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEnabledProductsForImportCommandOutput) => void), - cb?: (err: any, data?: ListEnabledProductsForImportCommandOutput) => void - ): Promise | void { - const command = new ListEnabledProductsForImportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

If finding aggregation is enabled, then ListFindingAggregators returns the ARN of the finding aggregator. You can run this operation from any Region.

+ * @see {@link ListFindingAggregatorsCommand} */ - public listFindingAggregators( + listFindingAggregators( args: ListFindingAggregatorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFindingAggregators( + listFindingAggregators( args: ListFindingAggregatorsCommandInput, cb: (err: any, data?: ListFindingAggregatorsCommandOutput) => void ): void; - public listFindingAggregators( + listFindingAggregators( args: ListFindingAggregatorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFindingAggregatorsCommandOutput) => void ): void; - public listFindingAggregators( - args: ListFindingAggregatorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFindingAggregatorsCommandOutput) => void), - cb?: (err: any, data?: ListFindingAggregatorsCommandOutput) => void - ): Promise | void { - const command = new ListFindingAggregatorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.

- *

This operation is only used by accounts that are managed by invitation. - * Accounts that are managed using the integration with Organizations do not receive invitations.

+ * @see {@link ListInvitationsCommand} */ - public listInvitations( + listInvitations( args: ListInvitationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInvitations( - args: ListInvitationsCommandInput, - cb: (err: any, data?: ListInvitationsCommandOutput) => void - ): void; - public listInvitations( + listInvitations(args: ListInvitationsCommandInput, cb: (err: any, data?: ListInvitationsCommandOutput) => void): void; + listInvitations( args: ListInvitationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInvitationsCommandOutput) => void ): void; - public listInvitations( - args: ListInvitationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInvitationsCommandOutput) => void), - cb?: (err: any, data?: ListInvitationsCommandOutput) => void - ): Promise | void { - const command = new ListInvitationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists details about all member accounts for the current Security Hub administrator - * account.

- *

The results include both member accounts that belong to an organization and member - * accounts that were invited manually.

+ * @see {@link ListMembersCommand} */ - public listMembers(args: ListMembersCommandInput, options?: __HttpHandlerOptions): Promise; - public listMembers(args: ListMembersCommandInput, cb: (err: any, data?: ListMembersCommandOutput) => void): void; - public listMembers( + listMembers(args: ListMembersCommandInput, options?: __HttpHandlerOptions): Promise; + listMembers(args: ListMembersCommandInput, cb: (err: any, data?: ListMembersCommandOutput) => void): void; + listMembers( args: ListMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMembersCommandOutput) => void ): void; - public listMembers( - args: ListMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMembersCommandOutput) => void), - cb?: (err: any, data?: ListMembersCommandOutput) => void - ): Promise | void { - const command = new ListMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the Security Hub administrator accounts. Can only be called by the organization - * management account.

+ * @see {@link ListOrganizationAdminAccountsCommand} */ - public listOrganizationAdminAccounts( + listOrganizationAdminAccounts( args: ListOrganizationAdminAccountsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOrganizationAdminAccounts( + listOrganizationAdminAccounts( args: ListOrganizationAdminAccountsCommandInput, cb: (err: any, data?: ListOrganizationAdminAccountsCommandOutput) => void ): void; - public listOrganizationAdminAccounts( + listOrganizationAdminAccounts( args: ListOrganizationAdminAccountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOrganizationAdminAccountsCommandOutput) => void ): void; - public listOrganizationAdminAccounts( - args: ListOrganizationAdminAccountsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOrganizationAdminAccountsCommandOutput) => void), - cb?: (err: any, data?: ListOrganizationAdminAccountsCommandOutput) => void - ): Promise | void { - const command = new ListOrganizationAdminAccountsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Lists all of the security controls that apply to a specified standard. - *

+ * @see {@link ListSecurityControlDefinitionsCommand} */ - public listSecurityControlDefinitions( + listSecurityControlDefinitions( args: ListSecurityControlDefinitionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSecurityControlDefinitions( + listSecurityControlDefinitions( args: ListSecurityControlDefinitionsCommandInput, cb: (err: any, data?: ListSecurityControlDefinitionsCommandOutput) => void ): void; - public listSecurityControlDefinitions( + listSecurityControlDefinitions( args: ListSecurityControlDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSecurityControlDefinitionsCommandOutput) => void ): void; - public listSecurityControlDefinitions( - args: ListSecurityControlDefinitionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSecurityControlDefinitionsCommandOutput) => void), - cb?: (err: any, data?: ListSecurityControlDefinitionsCommandOutput) => void - ): Promise | void { - const command = new ListSecurityControlDefinitionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account. - *

+ * @see {@link ListStandardsControlAssociationsCommand} */ - public listStandardsControlAssociations( + listStandardsControlAssociations( args: ListStandardsControlAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStandardsControlAssociations( + listStandardsControlAssociations( args: ListStandardsControlAssociationsCommandInput, cb: (err: any, data?: ListStandardsControlAssociationsCommandOutput) => void ): void; - public listStandardsControlAssociations( + listStandardsControlAssociations( args: ListStandardsControlAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStandardsControlAssociationsCommandOutput) => void ): void; - public listStandardsControlAssociations( - args: ListStandardsControlAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStandardsControlAssociationsCommandOutput) => void), - cb?: (err: any, data?: ListStandardsControlAssociationsCommandOutput) => void - ): Promise | void { - const command = new ListStandardsControlAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of tags associated with a resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more tags to a resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the name and description of a custom action target in Security Hub.

+ * @see {@link UpdateActionTargetCommand} */ - public updateActionTarget( + updateActionTarget( args: UpdateActionTargetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateActionTarget( + updateActionTarget( args: UpdateActionTargetCommandInput, cb: (err: any, data?: UpdateActionTargetCommandOutput) => void ): void; - public updateActionTarget( + updateActionTarget( args: UpdateActionTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateActionTargetCommandOutput) => void ): void; - public updateActionTarget( - args: UpdateActionTargetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateActionTargetCommandOutput) => void), - cb?: (err: any, data?: UpdateActionTargetCommandOutput) => void - ): Promise | void { - const command = new UpdateActionTargetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the finding aggregation configuration. Used to update the Region linking mode and the list of included or excluded Regions. You cannot use UpdateFindingAggregator to change the aggregation Region.

- *

You must run UpdateFindingAggregator from the current aggregation Region. - *

+ * @see {@link UpdateFindingAggregatorCommand} */ - public updateFindingAggregator( + updateFindingAggregator( args: UpdateFindingAggregatorCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFindingAggregator( + updateFindingAggregator( args: UpdateFindingAggregatorCommandInput, cb: (err: any, data?: UpdateFindingAggregatorCommandOutput) => void ): void; - public updateFindingAggregator( + updateFindingAggregator( args: UpdateFindingAggregatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFindingAggregatorCommandOutput) => void ): void; - public updateFindingAggregator( - args: UpdateFindingAggregatorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFindingAggregatorCommandOutput) => void), - cb?: (err: any, data?: UpdateFindingAggregatorCommandOutput) => void - ): Promise | void { - const command = new UpdateFindingAggregatorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * UpdateFindings is deprecated. Instead of UpdateFindings, use - * BatchUpdateFindings.

- *

Updates the Note and RecordState of the Security Hub-aggregated - * findings that the filter attributes specify. Any member account that can view the finding - * also sees the update to the finding.

+ * @see {@link UpdateFindingsCommand} */ - public updateFindings( + updateFindings( args: UpdateFindingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFindings( - args: UpdateFindingsCommandInput, - cb: (err: any, data?: UpdateFindingsCommandOutput) => void - ): void; - public updateFindings( + updateFindings(args: UpdateFindingsCommandInput, cb: (err: any, data?: UpdateFindingsCommandOutput) => void): void; + updateFindings( args: UpdateFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFindingsCommandOutput) => void ): void; - public updateFindings( - args: UpdateFindingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFindingsCommandOutput) => void), - cb?: (err: any, data?: UpdateFindingsCommandOutput) => void - ): Promise | void { - const command = new UpdateFindingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the Security Hub insight identified by the specified insight ARN.

+ * @see {@link UpdateInsightCommand} */ - public updateInsight( - args: UpdateInsightCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateInsight( - args: UpdateInsightCommandInput, - cb: (err: any, data?: UpdateInsightCommandOutput) => void - ): void; - public updateInsight( + updateInsight(args: UpdateInsightCommandInput, options?: __HttpHandlerOptions): Promise; + updateInsight(args: UpdateInsightCommandInput, cb: (err: any, data?: UpdateInsightCommandOutput) => void): void; + updateInsight( args: UpdateInsightCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateInsightCommandOutput) => void ): void; - public updateInsight( - args: UpdateInsightCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateInsightCommandOutput) => void), - cb?: (err: any, data?: UpdateInsightCommandOutput) => void - ): Promise | void { - const command = new UpdateInsightCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used to update the configuration related to Organizations. Can only be called from a - * Security Hub administrator account.

+ * @see {@link UpdateOrganizationConfigurationCommand} */ - public updateOrganizationConfiguration( + updateOrganizationConfiguration( args: UpdateOrganizationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateOrganizationConfiguration( + updateOrganizationConfiguration( args: UpdateOrganizationConfigurationCommandInput, cb: (err: any, data?: UpdateOrganizationConfigurationCommandOutput) => void ): void; - public updateOrganizationConfiguration( + updateOrganizationConfiguration( args: UpdateOrganizationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateOrganizationConfigurationCommandOutput) => void ): void; - public updateOrganizationConfiguration( - args: UpdateOrganizationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateOrganizationConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateOrganizationConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateOrganizationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates configuration options for Security Hub.

+ * @see {@link UpdateSecurityHubConfigurationCommand} */ - public updateSecurityHubConfiguration( + updateSecurityHubConfiguration( args: UpdateSecurityHubConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSecurityHubConfiguration( + updateSecurityHubConfiguration( args: UpdateSecurityHubConfigurationCommandInput, cb: (err: any, data?: UpdateSecurityHubConfigurationCommandOutput) => void ): void; - public updateSecurityHubConfiguration( + updateSecurityHubConfiguration( args: UpdateSecurityHubConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSecurityHubConfigurationCommandOutput) => void ): void; - public updateSecurityHubConfiguration( - args: UpdateSecurityHubConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSecurityHubConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateSecurityHubConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateSecurityHubConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used to control whether an individual security standard control is enabled or - * disabled.

+ * @see {@link UpdateStandardsControlCommand} */ - public updateStandardsControl( + updateStandardsControl( args: UpdateStandardsControlCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateStandardsControl( + updateStandardsControl( args: UpdateStandardsControlCommandInput, cb: (err: any, data?: UpdateStandardsControlCommandOutput) => void ): void; - public updateStandardsControl( + updateStandardsControl( args: UpdateStandardsControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStandardsControlCommandOutput) => void ): void; - public updateStandardsControl( - args: UpdateStandardsControlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStandardsControlCommandOutput) => void), - cb?: (err: any, data?: UpdateStandardsControlCommandOutput) => void - ): Promise | void { - const command = new UpdateStandardsControlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Security Hub provides you with a comprehensive view of the security state of + * your Amazon Web Services environment and resources. It also provides you with the readiness + * status of your environment based on controls from supported security standards. Security Hub collects security data from Amazon Web Services accounts, services, and + * integrated third-party products and helps you analyze security trends in your environment + * to identify the highest priority security issues. For more information about Security Hub, see the Security HubUser + * Guide.

+ *

When you use operations in the Security Hub API, the requests are executed only in + * the Amazon Web Services Region that is currently active or in the specific Amazon Web Services Region that you specify in your request. Any configuration or settings change + * that results from the operation is applied only to that Region. To make the same change in + * other Regions, run the same command for each Region in which you want to apply the change.

+ *

For example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of + * the member account with the administrator account is created only in the us-west-2 + * Region. Security Hub must be enabled for the member account in the same Region that the invitation + * was sent from.

+ *

The following throttling limits apply to using Security Hub API operations.

+ *
    + *
  • + *

    + * BatchEnableStandards - RateLimit of 1 request per + * second. BurstLimit of 1 request per second.

    + *
  • + *
  • + *

    + * GetFindings - RateLimit of 3 requests per second. + * BurstLimit of 6 requests per second.

    + *
  • + *
  • + *

    + * BatchImportFindings - RateLimit of 10 requests per second. + * BurstLimit of 30 requests per second.

    + *
  • + *
  • + *

    + * BatchUpdateFindings - RateLimit of 10 requests per second. + * BurstLimit of 30 requests per second.

    + *
  • + *
  • + *

    + * UpdateStandardsControl - RateLimit of 1 request per + * second. BurstLimit of 5 requests per second.

    + *
  • + *
  • + *

    All other operations - RateLimit of 10 requests per second. + * BurstLimit of 30 requests per second.

    + *
  • + *
+ */ +export class SecurityHub extends SecurityHubClient implements SecurityHub {} +createAggregatedClient(commands, SecurityHub); diff --git a/clients/client-securitylake/src/SecurityLake.ts b/clients/client-securitylake/src/SecurityLake.ts index dcb30c6263e4..69d30a9a9924 100644 --- a/clients/client-securitylake/src/SecurityLake.ts +++ b/clients/client-securitylake/src/SecurityLake.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -147,1119 +148,559 @@ import { UpdateSubscriptionNotificationConfigurationCommandInput, UpdateSubscriptionNotificationConfigurationCommandOutput, } from "./commands/UpdateSubscriptionNotificationConfigurationCommand"; -import { SecurityLakeClient } from "./SecurityLakeClient"; +import { SecurityLakeClient, SecurityLakeClientConfig } from "./SecurityLakeClient"; -/** - * @public - * - *

Amazon Security Lake is in preview release. Your use of the Security Lake preview is subject to - * Section 2 of the Amazon Web Services Service - * Terms("Betas and Previews").

- *
- *

Amazon Security Lake is a fully managed security data lake service. You can use Security Lake to - * automatically centralize security data from cloud, on-premises, and custom sources into a - * data lake that's stored in your Amazon Web Servicesaccount. Amazon Web Services Organizations - * is an account management service that lets you consolidate multiple Amazon Web Services - * accounts into an organization that you create and centrally manage. With Organizations, you - * can create member accounts and invite existing accounts to join your organization. - * Security Lake helps you analyze security data for a more complete understanding of your - * security posture across the entire organization. It can also help you improve the - * protection of your workloads, applications, and data.

- *

The data lake is backed by Amazon Simple Storage Service (Amazon S3) buckets, and you - * retain ownership over your data.

- *

Amazon Security Lake integrates with CloudTrail, a service that provides a record of - * actions taken by a user, role, or an Amazon Web Services service in Security Lake CloudTrail captures API calls for Security Lake as events. The calls captured include calls - * from the Security Lake console and code calls to the Security Lake API operations. If you create a - * trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Security Lake. If you don't configure a trail, you can still - * view the most recent events in the CloudTrail console in Event history. Using the - * information collected by CloudTrail you can determine the request that was made to - * Security Lake, the IP address from which the request was made, who made the request, when it - * was made, and additional details. To learn more about Security Lake information in CloudTrail, see the Amazon Security Lake User Guide.

- *

Security Lake automates the collection of security-related log and event data from - * integrated Amazon Web Services and third-party services. It also helps you manage - * the lifecycle of data with customizable retention and replication settings. Security Lake - * converts ingested data into Apache Parquet format and a standard open-source schema called - * the Open Cybersecurity Schema Framework (OCSF).

- *

Other Amazon Web Services and third-party services can subscribe to the data that's stored in Security Lake for - * incident response and security data analytics.

- */ -export class SecurityLake extends SecurityLakeClient { +const commands = { + CreateAwsLogSourceCommand, + CreateCustomLogSourceCommand, + CreateDatalakeCommand, + CreateDatalakeAutoEnableCommand, + CreateDatalakeDelegatedAdminCommand, + CreateDatalakeExceptionsSubscriptionCommand, + CreateSubscriberCommand, + CreateSubscriptionNotificationConfigurationCommand, + DeleteAwsLogSourceCommand, + DeleteCustomLogSourceCommand, + DeleteDatalakeCommand, + DeleteDatalakeAutoEnableCommand, + DeleteDatalakeDelegatedAdminCommand, + DeleteDatalakeExceptionsSubscriptionCommand, + DeleteSubscriberCommand, + DeleteSubscriptionNotificationConfigurationCommand, + GetDatalakeCommand, + GetDatalakeAutoEnableCommand, + GetDatalakeExceptionsExpiryCommand, + GetDatalakeExceptionsSubscriptionCommand, + GetDatalakeStatusCommand, + GetSubscriberCommand, + ListDatalakeExceptionsCommand, + ListLogSourcesCommand, + ListSubscribersCommand, + UpdateDatalakeCommand, + UpdateDatalakeExceptionsExpiryCommand, + UpdateDatalakeExceptionsSubscriptionCommand, + UpdateSubscriberCommand, + UpdateSubscriptionNotificationConfigurationCommand, +}; + +export interface SecurityLake { /** - * @public - *

Adds a natively supported Amazon Web Service as an Amazon Security Lake source. Enables - * source types for member accounts in required Amazon Web Services Regions, based on the - * parameters you specify. You can choose any source type in any Region for either accounts - * that are part of a trusted organization or standalone accounts. At least one of the three - * dimensions is a mandatory input to this API. However, you can supply any combination of the - * three dimensions to this API.

- *

By default, a dimension refers to the entire set. When you don't provide a dimension, - * Security Lake assumes that the missing dimension refers to the entire set. This is overridden - * when you supply any one of the inputs. For instance, when you do not specify members, the - * API enables all Security Lake member accounts for all sources. Similarly, when you do not - * specify Regions, Security Lake is enabled for all the Regions where Security Lake is available as a - * service.

- *

You can use this API only to enable natively supported Amazon Web Services as a - * source. Use CreateCustomLogSource to enable data collection from a custom - * source.

+ * @see {@link CreateAwsLogSourceCommand} */ - public createAwsLogSource( + createAwsLogSource( args: CreateAwsLogSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAwsLogSource( + createAwsLogSource( args: CreateAwsLogSourceCommandInput, cb: (err: any, data?: CreateAwsLogSourceCommandOutput) => void ): void; - public createAwsLogSource( + createAwsLogSource( args: CreateAwsLogSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAwsLogSourceCommandOutput) => void ): void; - public createAwsLogSource( - args: CreateAwsLogSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAwsLogSourceCommandOutput) => void), - cb?: (err: any, data?: CreateAwsLogSourceCommandOutput) => void - ): Promise | void { - const command = new CreateAwsLogSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region - * where you want to create a custom source. Security Lake can collect logs and events from - * third-party custom sources. After creating the appropriate IAM role to - * invoke Glue crawler, use this API to add a custom source name in Security Lake. This - * operation creates a partition in the Amazon S3 bucket for Security Lake as the target - * location for log files from the custom source in addition to an associated Glue table and an Glue crawler.

+ * @see {@link CreateCustomLogSourceCommand} */ - public createCustomLogSource( + createCustomLogSource( args: CreateCustomLogSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCustomLogSource( + createCustomLogSource( args: CreateCustomLogSourceCommandInput, cb: (err: any, data?: CreateCustomLogSourceCommandOutput) => void ): void; - public createCustomLogSource( + createCustomLogSource( args: CreateCustomLogSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomLogSourceCommandOutput) => void ): void; - public createCustomLogSource( - args: CreateCustomLogSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCustomLogSourceCommandOutput) => void), - cb?: (err: any, data?: CreateCustomLogSourceCommandOutput) => void - ): Promise | void { - const command = new CreateCustomLogSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Initializes an Amazon Security Lake instance with the provided (or default) configuration. You - * can enable Security Lake in Amazon Web Services Regions with customized settings before enabling - * log collection in Regions. You can either use the enableAll parameter to - * specify all Regions or specify the Regions where you want to enable Security Lake. To specify - * particular Regions, use the Regions parameter and then configure these Regions - * using the configurations parameter. If you have already enabled Security Lake in a - * Region when you call this command, the command will update the Region if you provide new - * configuration parameters. If you have not already enabled Security Lake in the Region when you - * call this API, it will set up the data lake in the Region with the specified - * configurations.

- *

When you enable Security Lake, it starts ingesting security data after the - * CreateAwsLogSource call. This includes ingesting security data from - * sources, storing data, and making data accessible to subscribers. Security Lake also enables - * all the existing settings and resources that it stores or maintains for your Amazon Web Services account in the current Region, including security log and event data. For - * more information, see the Amazon Security Lake User - * Guide.

+ * @see {@link CreateDatalakeCommand} */ - public createDatalake( + createDatalake( args: CreateDatalakeCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDatalake( - args: CreateDatalakeCommandInput, - cb: (err: any, data?: CreateDatalakeCommandOutput) => void - ): void; - public createDatalake( + createDatalake(args: CreateDatalakeCommandInput, cb: (err: any, data?: CreateDatalakeCommandOutput) => void): void; + createDatalake( args: CreateDatalakeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatalakeCommandOutput) => void ): void; - public createDatalake( - args: CreateDatalakeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDatalakeCommandOutput) => void), - cb?: (err: any, data?: CreateDatalakeCommandOutput) => void - ): Promise | void { - const command = new CreateDatalakeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Automatically enables Amazon Security Lake for new member accounts in your organization. - * Security Lake is not automatically enabled for any existing member accounts in your - * organization.

+ * @see {@link CreateDatalakeAutoEnableCommand} */ - public createDatalakeAutoEnable( + createDatalakeAutoEnable( args: CreateDatalakeAutoEnableCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDatalakeAutoEnable( + createDatalakeAutoEnable( args: CreateDatalakeAutoEnableCommandInput, cb: (err: any, data?: CreateDatalakeAutoEnableCommandOutput) => void ): void; - public createDatalakeAutoEnable( + createDatalakeAutoEnable( args: CreateDatalakeAutoEnableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatalakeAutoEnableCommandOutput) => void ): void; - public createDatalakeAutoEnable( - args: CreateDatalakeAutoEnableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDatalakeAutoEnableCommandOutput) => void), - cb?: (err: any, data?: CreateDatalakeAutoEnableCommandOutput) => void - ): Promise | void { - const command = new CreateDatalakeAutoEnableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Designates the Amazon Security Lake delegated administrator account for the organization. This - * API can only be called by the organization management account. The organization management - * account cannot be the delegated administrator account.

+ * @see {@link CreateDatalakeDelegatedAdminCommand} */ - public createDatalakeDelegatedAdmin( + createDatalakeDelegatedAdmin( args: CreateDatalakeDelegatedAdminCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDatalakeDelegatedAdmin( + createDatalakeDelegatedAdmin( args: CreateDatalakeDelegatedAdminCommandInput, cb: (err: any, data?: CreateDatalakeDelegatedAdminCommandOutput) => void ): void; - public createDatalakeDelegatedAdmin( + createDatalakeDelegatedAdmin( args: CreateDatalakeDelegatedAdminCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatalakeDelegatedAdminCommandOutput) => void ): void; - public createDatalakeDelegatedAdmin( - args: CreateDatalakeDelegatedAdminCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDatalakeDelegatedAdminCommandOutput) => void), - cb?: (err: any, data?: CreateDatalakeDelegatedAdminCommandOutput) => void - ): Promise | void { - const command = new CreateDatalakeDelegatedAdminCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates the specified notification subscription in Amazon Security Lake for the organization - * you specify.

+ * @see {@link CreateDatalakeExceptionsSubscriptionCommand} */ - public createDatalakeExceptionsSubscription( + createDatalakeExceptionsSubscription( args: CreateDatalakeExceptionsSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDatalakeExceptionsSubscription( + createDatalakeExceptionsSubscription( args: CreateDatalakeExceptionsSubscriptionCommandInput, cb: (err: any, data?: CreateDatalakeExceptionsSubscriptionCommandOutput) => void ): void; - public createDatalakeExceptionsSubscription( + createDatalakeExceptionsSubscription( args: CreateDatalakeExceptionsSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatalakeExceptionsSubscriptionCommandOutput) => void ): void; - public createDatalakeExceptionsSubscription( - args: CreateDatalakeExceptionsSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDatalakeExceptionsSubscriptionCommandOutput) => void), - cb?: (err: any, data?: CreateDatalakeExceptionsSubscriptionCommandOutput) => void - ): Promise | void { - const command = new CreateDatalakeExceptionsSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a subscription permission for accounts that are already enabled in - * Amazon Security Lake. You can create a subscriber with access to data in the current Amazon Web Services Region.

+ * @see {@link CreateSubscriberCommand} */ - public createSubscriber( + createSubscriber( args: CreateSubscriberCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSubscriber( + createSubscriber( args: CreateSubscriberCommandInput, cb: (err: any, data?: CreateSubscriberCommandOutput) => void ): void; - public createSubscriber( + createSubscriber( args: CreateSubscriberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSubscriberCommandOutput) => void ): void; - public createSubscriber( - args: CreateSubscriberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSubscriberCommandOutput) => void), - cb?: (err: any, data?: CreateSubscriberCommandOutput) => void - ): Promise | void { - const command = new CreateSubscriberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Notifies the subscriber when new data is written to the data lake for the sources that - * the subscriber consumes in Security Lake. You can create only one subscriber notification per - * subscriber.

+ * @see {@link CreateSubscriptionNotificationConfigurationCommand} */ - public createSubscriptionNotificationConfiguration( + createSubscriptionNotificationConfiguration( args: CreateSubscriptionNotificationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSubscriptionNotificationConfiguration( + createSubscriptionNotificationConfiguration( args: CreateSubscriptionNotificationConfigurationCommandInput, cb: (err: any, data?: CreateSubscriptionNotificationConfigurationCommandOutput) => void ): void; - public createSubscriptionNotificationConfiguration( + createSubscriptionNotificationConfiguration( args: CreateSubscriptionNotificationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSubscriptionNotificationConfigurationCommandOutput) => void ): void; - public createSubscriptionNotificationConfiguration( - args: CreateSubscriptionNotificationConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateSubscriptionNotificationConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateSubscriptionNotificationConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateSubscriptionNotificationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a natively supported Amazon Web Service as an Amazon Security Lake source. When - * you remove the source, Security Lake stops collecting data from that source, and subscribers - * can no longer consume new data from the source. Subscribers can still consume data that - * Security Lake collected from the source before disablement.

- *

You can choose any source type in any Amazon Web Services Region for either accounts that - * are part of a trusted organization or standalone accounts. At least one of the three - * dimensions is a mandatory input to this API. However, you can supply any combination of the - * three dimensions to this API.

- *

By default, a dimension refers to the entire set. This is overridden when you supply any - * one of the inputs. For instance, when you do not specify members, the API disables all - * Security Lake member accounts for sources. Similarly, when you do not specify Regions, - * Security Lake is disabled for all the Regions where Security Lake is available as a service.

- *

When you don't provide a dimension, Security Lake assumes that the missing dimension refers - * to the entire set. For example, if you don't provide specific accounts, the API applies to - * the entire set of accounts in your organization.

+ * @see {@link DeleteAwsLogSourceCommand} */ - public deleteAwsLogSource( + deleteAwsLogSource( args: DeleteAwsLogSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAwsLogSource( + deleteAwsLogSource( args: DeleteAwsLogSourceCommandInput, cb: (err: any, data?: DeleteAwsLogSourceCommandOutput) => void ): void; - public deleteAwsLogSource( + deleteAwsLogSource( args: DeleteAwsLogSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAwsLogSourceCommandOutput) => void ): void; - public deleteAwsLogSource( - args: DeleteAwsLogSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAwsLogSourceCommandOutput) => void), - cb?: (err: any, data?: DeleteAwsLogSourceCommandOutput) => void - ): Promise | void { - const command = new DeleteAwsLogSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a custom log source from Amazon Security Lake.

+ * @see {@link DeleteCustomLogSourceCommand} */ - public deleteCustomLogSource( + deleteCustomLogSource( args: DeleteCustomLogSourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCustomLogSource( + deleteCustomLogSource( args: DeleteCustomLogSourceCommandInput, cb: (err: any, data?: DeleteCustomLogSourceCommandOutput) => void ): void; - public deleteCustomLogSource( + deleteCustomLogSource( args: DeleteCustomLogSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomLogSourceCommandOutput) => void ): void; - public deleteCustomLogSource( - args: DeleteCustomLogSourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCustomLogSourceCommandOutput) => void), - cb?: (err: any, data?: DeleteCustomLogSourceCommandOutput) => void - ): Promise | void { - const command = new DeleteCustomLogSourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

When you delete Amazon Security Lake from your account, Security Lake is disabled in all Amazon Web Services Regions. Also, this API automatically takes steps to remove the account from - * Security Lake .

- *

This operation disables security data collection from sources, deletes data stored, and - * stops making data accessible to subscribers. Security Lake also deletes all the existing - * settings and resources that it stores or maintains for your Amazon Web Services account in - * the current Region, including security log and event data. The DeleteDatalake - * operation does not delete the Amazon S3 bucket, which is owned by your Amazon Web Services account. For more information, see the Amazon Security Lake User - * Guide.

+ * @see {@link DeleteDatalakeCommand} */ - public deleteDatalake( + deleteDatalake( args: DeleteDatalakeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDatalake( - args: DeleteDatalakeCommandInput, - cb: (err: any, data?: DeleteDatalakeCommandOutput) => void - ): void; - public deleteDatalake( + deleteDatalake(args: DeleteDatalakeCommandInput, cb: (err: any, data?: DeleteDatalakeCommandOutput) => void): void; + deleteDatalake( args: DeleteDatalakeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatalakeCommandOutput) => void ): void; - public deleteDatalake( - args: DeleteDatalakeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDatalakeCommandOutput) => void), - cb?: (err: any, data?: DeleteDatalakeCommandOutput) => void - ): Promise | void { - const command = new DeleteDatalakeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * DeleteDatalakeAutoEnable removes automatic enablement of configuration - * settings for new member accounts (but keeps settings for the delegated administrator) from - * Amazon Security Lake. You must run this API using credentials of the delegated administrator. - * When you run this API, new member accounts that are added after the organization enables - * Security Lake won't contribute to the data lake.

+ * @see {@link DeleteDatalakeAutoEnableCommand} */ - public deleteDatalakeAutoEnable( + deleteDatalakeAutoEnable( args: DeleteDatalakeAutoEnableCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDatalakeAutoEnable( + deleteDatalakeAutoEnable( args: DeleteDatalakeAutoEnableCommandInput, cb: (err: any, data?: DeleteDatalakeAutoEnableCommandOutput) => void ): void; - public deleteDatalakeAutoEnable( + deleteDatalakeAutoEnable( args: DeleteDatalakeAutoEnableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatalakeAutoEnableCommandOutput) => void ): void; - public deleteDatalakeAutoEnable( - args: DeleteDatalakeAutoEnableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDatalakeAutoEnableCommandOutput) => void), - cb?: (err: any, data?: DeleteDatalakeAutoEnableCommandOutput) => void - ): Promise | void { - const command = new DeleteDatalakeAutoEnableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the Amazon Security Lake delegated administrator account for the organization. This API - * can only be called by the organization management account. The organization management - * account cannot be the delegated administrator account.

+ * @see {@link DeleteDatalakeDelegatedAdminCommand} */ - public deleteDatalakeDelegatedAdmin( + deleteDatalakeDelegatedAdmin( args: DeleteDatalakeDelegatedAdminCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDatalakeDelegatedAdmin( + deleteDatalakeDelegatedAdmin( args: DeleteDatalakeDelegatedAdminCommandInput, cb: (err: any, data?: DeleteDatalakeDelegatedAdminCommandOutput) => void ): void; - public deleteDatalakeDelegatedAdmin( + deleteDatalakeDelegatedAdmin( args: DeleteDatalakeDelegatedAdminCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatalakeDelegatedAdminCommandOutput) => void ): void; - public deleteDatalakeDelegatedAdmin( - args: DeleteDatalakeDelegatedAdminCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDatalakeDelegatedAdminCommandOutput) => void), - cb?: (err: any, data?: DeleteDatalakeDelegatedAdminCommandOutput) => void - ): Promise | void { - const command = new DeleteDatalakeDelegatedAdminCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified notification subscription in Amazon Security Lake for the organization - * you specify.

+ * @see {@link DeleteDatalakeExceptionsSubscriptionCommand} */ - public deleteDatalakeExceptionsSubscription( + deleteDatalakeExceptionsSubscription( args: DeleteDatalakeExceptionsSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDatalakeExceptionsSubscription( + deleteDatalakeExceptionsSubscription( args: DeleteDatalakeExceptionsSubscriptionCommandInput, cb: (err: any, data?: DeleteDatalakeExceptionsSubscriptionCommandOutput) => void ): void; - public deleteDatalakeExceptionsSubscription( + deleteDatalakeExceptionsSubscription( args: DeleteDatalakeExceptionsSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatalakeExceptionsSubscriptionCommandOutput) => void ): void; - public deleteDatalakeExceptionsSubscription( - args: DeleteDatalakeExceptionsSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDatalakeExceptionsSubscriptionCommandOutput) => void), - cb?: (err: any, data?: DeleteDatalakeExceptionsSubscriptionCommandOutput) => void - ): Promise | void { - const command = new DeleteDatalakeExceptionsSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the subscription permission for accounts that are already enabled in - * Amazon Security Lake. You can delete a subscriber and remove access to data in the current Amazon Web Services - * Region.

+ * @see {@link DeleteSubscriberCommand} */ - public deleteSubscriber( + deleteSubscriber( args: DeleteSubscriberCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSubscriber( + deleteSubscriber( args: DeleteSubscriberCommandInput, cb: (err: any, data?: DeleteSubscriberCommandOutput) => void ): void; - public deleteSubscriber( + deleteSubscriber( args: DeleteSubscriberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSubscriberCommandOutput) => void ): void; - public deleteSubscriber( - args: DeleteSubscriberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSubscriberCommandOutput) => void), - cb?: (err: any, data?: DeleteSubscriberCommandOutput) => void - ): Promise | void { - const command = new DeleteSubscriberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified notification subscription in Amazon Security Lake for the organization - * you specify.

+ * @see {@link DeleteSubscriptionNotificationConfigurationCommand} */ - public deleteSubscriptionNotificationConfiguration( + deleteSubscriptionNotificationConfiguration( args: DeleteSubscriptionNotificationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSubscriptionNotificationConfiguration( + deleteSubscriptionNotificationConfiguration( args: DeleteSubscriptionNotificationConfigurationCommandInput, cb: (err: any, data?: DeleteSubscriptionNotificationConfigurationCommandOutput) => void ): void; - public deleteSubscriptionNotificationConfiguration( + deleteSubscriptionNotificationConfiguration( args: DeleteSubscriptionNotificationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSubscriptionNotificationConfigurationCommandOutput) => void ): void; - public deleteSubscriptionNotificationConfiguration( - args: DeleteSubscriptionNotificationConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteSubscriptionNotificationConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteSubscriptionNotificationConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteSubscriptionNotificationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services account ID. You can use the GetDatalake API to know whether - * Security Lake is enabled for the current Region. This API does not take input parameters.

+ * @see {@link GetDatalakeCommand} */ - public getDatalake(args: GetDatalakeCommandInput, options?: __HttpHandlerOptions): Promise; - public getDatalake(args: GetDatalakeCommandInput, cb: (err: any, data?: GetDatalakeCommandOutput) => void): void; - public getDatalake( + getDatalake(args: GetDatalakeCommandInput, options?: __HttpHandlerOptions): Promise; + getDatalake(args: GetDatalakeCommandInput, cb: (err: any, data?: GetDatalakeCommandOutput) => void): void; + getDatalake( args: GetDatalakeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDatalakeCommandOutput) => void ): void; - public getDatalake( - args: GetDatalakeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDatalakeCommandOutput) => void), - cb?: (err: any, data?: GetDatalakeCommandOutput) => void - ): Promise | void { - const command = new GetDatalakeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the configuration that will be automatically set up for accounts added to the - * organization after the organization has onboarded to Amazon Security Lake. This API does not take - * input parameters.

+ * @see {@link GetDatalakeAutoEnableCommand} */ - public getDatalakeAutoEnable( + getDatalakeAutoEnable( args: GetDatalakeAutoEnableCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDatalakeAutoEnable( + getDatalakeAutoEnable( args: GetDatalakeAutoEnableCommandInput, cb: (err: any, data?: GetDatalakeAutoEnableCommandOutput) => void ): void; - public getDatalakeAutoEnable( + getDatalakeAutoEnable( args: GetDatalakeAutoEnableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDatalakeAutoEnableCommandOutput) => void ): void; - public getDatalakeAutoEnable( - args: GetDatalakeAutoEnableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDatalakeAutoEnableCommandOutput) => void), - cb?: (err: any, data?: GetDatalakeAutoEnableCommandOutput) => void - ): Promise | void { - const command = new GetDatalakeAutoEnableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the expiration period and time-to-live (TTL) for which the exception message - * will remain. Exceptions are stored by default, for 2 weeks from when a record was created - * in Amazon Security Lake. This API does not take input parameters.

+ * @see {@link GetDatalakeExceptionsExpiryCommand} */ - public getDatalakeExceptionsExpiry( + getDatalakeExceptionsExpiry( args: GetDatalakeExceptionsExpiryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDatalakeExceptionsExpiry( + getDatalakeExceptionsExpiry( args: GetDatalakeExceptionsExpiryCommandInput, cb: (err: any, data?: GetDatalakeExceptionsExpiryCommandOutput) => void ): void; - public getDatalakeExceptionsExpiry( + getDatalakeExceptionsExpiry( args: GetDatalakeExceptionsExpiryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDatalakeExceptionsExpiryCommandOutput) => void ): void; - public getDatalakeExceptionsExpiry( - args: GetDatalakeExceptionsExpiryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDatalakeExceptionsExpiryCommandOutput) => void), - cb?: (err: any, data?: GetDatalakeExceptionsExpiryCommandOutput) => void - ): Promise | void { - const command = new GetDatalakeExceptionsExpiryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the details of exception notifications for the account in Amazon Security Lake.

+ * @see {@link GetDatalakeExceptionsSubscriptionCommand} */ - public getDatalakeExceptionsSubscription( + getDatalakeExceptionsSubscription( args: GetDatalakeExceptionsSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDatalakeExceptionsSubscription( + getDatalakeExceptionsSubscription( args: GetDatalakeExceptionsSubscriptionCommandInput, cb: (err: any, data?: GetDatalakeExceptionsSubscriptionCommandOutput) => void ): void; - public getDatalakeExceptionsSubscription( + getDatalakeExceptionsSubscription( args: GetDatalakeExceptionsSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDatalakeExceptionsSubscriptionCommandOutput) => void ): void; - public getDatalakeExceptionsSubscription( - args: GetDatalakeExceptionsSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDatalakeExceptionsSubscriptionCommandOutput) => void), - cb?: (err: any, data?: GetDatalakeExceptionsSubscriptionCommandOutput) => void - ): Promise | void { - const command = new GetDatalakeExceptionsSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a snapshot of the current Region, including whether Amazon Security Lake is enabled - * for those accounts and which sources Security Lake is collecting data from.

+ * @see {@link GetDatalakeStatusCommand} */ - public getDatalakeStatus( + getDatalakeStatus( args: GetDatalakeStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDatalakeStatus( + getDatalakeStatus( args: GetDatalakeStatusCommandInput, cb: (err: any, data?: GetDatalakeStatusCommandOutput) => void ): void; - public getDatalakeStatus( + getDatalakeStatus( args: GetDatalakeStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDatalakeStatusCommandOutput) => void ): void; - public getDatalakeStatus( - args: GetDatalakeStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDatalakeStatusCommandOutput) => void), - cb?: (err: any, data?: GetDatalakeStatusCommandOutput) => void - ): Promise | void { - const command = new GetDatalakeStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the subscription information for the specified subscription ID. You can get - * information about a specific subscriber.

+ * @see {@link GetSubscriberCommand} */ - public getSubscriber( - args: GetSubscriberCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getSubscriber( - args: GetSubscriberCommandInput, - cb: (err: any, data?: GetSubscriberCommandOutput) => void - ): void; - public getSubscriber( + getSubscriber(args: GetSubscriberCommandInput, options?: __HttpHandlerOptions): Promise; + getSubscriber(args: GetSubscriberCommandInput, cb: (err: any, data?: GetSubscriberCommandOutput) => void): void; + getSubscriber( args: GetSubscriberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSubscriberCommandOutput) => void ): void; - public getSubscriber( - args: GetSubscriberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSubscriberCommandOutput) => void), - cb?: (err: any, data?: GetSubscriberCommandOutput) => void - ): Promise | void { - const command = new GetSubscriberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the Amazon Security Lake exceptions that you can use to find the source of problems and - * fix them.

+ * @see {@link ListDatalakeExceptionsCommand} */ - public listDatalakeExceptions( + listDatalakeExceptions( args: ListDatalakeExceptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDatalakeExceptions( + listDatalakeExceptions( args: ListDatalakeExceptionsCommandInput, cb: (err: any, data?: ListDatalakeExceptionsCommandOutput) => void ): void; - public listDatalakeExceptions( + listDatalakeExceptions( args: ListDatalakeExceptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatalakeExceptionsCommandOutput) => void ): void; - public listDatalakeExceptions( - args: ListDatalakeExceptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatalakeExceptionsCommandOutput) => void), - cb?: (err: any, data?: ListDatalakeExceptionsCommandOutput) => void - ): Promise | void { - const command = new ListDatalakeExceptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the log sources in the current Amazon Web Services Region.

+ * @see {@link ListLogSourcesCommand} */ - public listLogSources( + listLogSources( args: ListLogSourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLogSources( - args: ListLogSourcesCommandInput, - cb: (err: any, data?: ListLogSourcesCommandOutput) => void - ): void; - public listLogSources( + listLogSources(args: ListLogSourcesCommandInput, cb: (err: any, data?: ListLogSourcesCommandOutput) => void): void; + listLogSources( args: ListLogSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLogSourcesCommandOutput) => void ): void; - public listLogSources( - args: ListLogSourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLogSourcesCommandOutput) => void), - cb?: (err: any, data?: ListLogSourcesCommandOutput) => void - ): Promise | void { - const command = new ListLogSourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list - * of subscriptions associated with a specific organization or Amazon Web Services account.

+ * @see {@link ListSubscribersCommand} */ - public listSubscribers( + listSubscribers( args: ListSubscribersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSubscribers( - args: ListSubscribersCommandInput, - cb: (err: any, data?: ListSubscribersCommandOutput) => void - ): void; - public listSubscribers( + listSubscribers(args: ListSubscribersCommandInput, cb: (err: any, data?: ListSubscribersCommandOutput) => void): void; + listSubscribers( args: ListSubscribersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSubscribersCommandOutput) => void ): void; - public listSubscribers( - args: ListSubscribersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSubscribersCommandOutput) => void), - cb?: (err: any, data?: ListSubscribersCommandOutput) => void - ): Promise | void { - const command = new ListSubscribersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Specifies where to store your security data and for how long. You can add a rollup - * Region to consolidate data from multiple Amazon Web Services Regions.

+ * @see {@link UpdateDatalakeCommand} */ - public updateDatalake( + updateDatalake( args: UpdateDatalakeCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDatalake( - args: UpdateDatalakeCommandInput, - cb: (err: any, data?: UpdateDatalakeCommandOutput) => void - ): void; - public updateDatalake( + updateDatalake(args: UpdateDatalakeCommandInput, cb: (err: any, data?: UpdateDatalakeCommandOutput) => void): void; + updateDatalake( args: UpdateDatalakeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDatalakeCommandOutput) => void ): void; - public updateDatalake( - args: UpdateDatalakeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDatalakeCommandOutput) => void), - cb?: (err: any, data?: UpdateDatalakeCommandOutput) => void - ): Promise | void { - const command = new UpdateDatalakeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update the expiration period for the exception message to your preferred time, and - * control the time-to-live (TTL) for the exception message to remain. Exceptions are stored - * by default for 2 weeks from when a record was created in Amazon Security Lake.

+ * @see {@link UpdateDatalakeExceptionsExpiryCommand} */ - public updateDatalakeExceptionsExpiry( + updateDatalakeExceptionsExpiry( args: UpdateDatalakeExceptionsExpiryCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDatalakeExceptionsExpiry( + updateDatalakeExceptionsExpiry( args: UpdateDatalakeExceptionsExpiryCommandInput, cb: (err: any, data?: UpdateDatalakeExceptionsExpiryCommandOutput) => void ): void; - public updateDatalakeExceptionsExpiry( + updateDatalakeExceptionsExpiry( args: UpdateDatalakeExceptionsExpiryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDatalakeExceptionsExpiryCommandOutput) => void ): void; - public updateDatalakeExceptionsExpiry( - args: UpdateDatalakeExceptionsExpiryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDatalakeExceptionsExpiryCommandOutput) => void), - cb?: (err: any, data?: UpdateDatalakeExceptionsExpiryCommandOutput) => void - ): Promise | void { - const command = new UpdateDatalakeExceptionsExpiryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified notification subscription in Amazon Security Lake for the organization - * you specify.

+ * @see {@link UpdateDatalakeExceptionsSubscriptionCommand} */ - public updateDatalakeExceptionsSubscription( + updateDatalakeExceptionsSubscription( args: UpdateDatalakeExceptionsSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDatalakeExceptionsSubscription( + updateDatalakeExceptionsSubscription( args: UpdateDatalakeExceptionsSubscriptionCommandInput, cb: (err: any, data?: UpdateDatalakeExceptionsSubscriptionCommandOutput) => void ): void; - public updateDatalakeExceptionsSubscription( + updateDatalakeExceptionsSubscription( args: UpdateDatalakeExceptionsSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDatalakeExceptionsSubscriptionCommandOutput) => void ): void; - public updateDatalakeExceptionsSubscription( - args: UpdateDatalakeExceptionsSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDatalakeExceptionsSubscriptionCommandOutput) => void), - cb?: (err: any, data?: UpdateDatalakeExceptionsSubscriptionCommandOutput) => void - ): Promise | void { - const command = new UpdateDatalakeExceptionsSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing subscription for the given Amazon Security Lake account ID. You can update - * a subscriber by changing the sources that the subscriber consumes data from.

+ * @see {@link UpdateSubscriberCommand} */ - public updateSubscriber( + updateSubscriber( args: UpdateSubscriberCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSubscriber( + updateSubscriber( args: UpdateSubscriberCommandInput, cb: (err: any, data?: UpdateSubscriberCommandOutput) => void ): void; - public updateSubscriber( + updateSubscriber( args: UpdateSubscriberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSubscriberCommandOutput) => void ): void; - public updateSubscriber( - args: UpdateSubscriberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSubscriberCommandOutput) => void), - cb?: (err: any, data?: UpdateSubscriberCommandOutput) => void - ): Promise | void { - const command = new UpdateSubscriberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or - * switches the notification subscription endpoint for a subscriber.

+ * @see {@link UpdateSubscriptionNotificationConfigurationCommand} */ - public updateSubscriptionNotificationConfiguration( + updateSubscriptionNotificationConfiguration( args: UpdateSubscriptionNotificationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSubscriptionNotificationConfiguration( + updateSubscriptionNotificationConfiguration( args: UpdateSubscriptionNotificationConfigurationCommandInput, cb: (err: any, data?: UpdateSubscriptionNotificationConfigurationCommandOutput) => void ): void; - public updateSubscriptionNotificationConfiguration( + updateSubscriptionNotificationConfiguration( args: UpdateSubscriptionNotificationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSubscriptionNotificationConfigurationCommandOutput) => void ): void; - public updateSubscriptionNotificationConfiguration( - args: UpdateSubscriptionNotificationConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateSubscriptionNotificationConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateSubscriptionNotificationConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateSubscriptionNotificationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * + *

Amazon Security Lake is in preview release. Your use of the Security Lake preview is subject to + * Section 2 of the Amazon Web Services Service + * Terms("Betas and Previews").

+ *
+ *

Amazon Security Lake is a fully managed security data lake service. You can use Security Lake to + * automatically centralize security data from cloud, on-premises, and custom sources into a + * data lake that's stored in your Amazon Web Servicesaccount. Amazon Web Services Organizations + * is an account management service that lets you consolidate multiple Amazon Web Services + * accounts into an organization that you create and centrally manage. With Organizations, you + * can create member accounts and invite existing accounts to join your organization. + * Security Lake helps you analyze security data for a more complete understanding of your + * security posture across the entire organization. It can also help you improve the + * protection of your workloads, applications, and data.

+ *

The data lake is backed by Amazon Simple Storage Service (Amazon S3) buckets, and you + * retain ownership over your data.

+ *

Amazon Security Lake integrates with CloudTrail, a service that provides a record of + * actions taken by a user, role, or an Amazon Web Services service in Security Lake CloudTrail captures API calls for Security Lake as events. The calls captured include calls + * from the Security Lake console and code calls to the Security Lake API operations. If you create a + * trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Security Lake. If you don't configure a trail, you can still + * view the most recent events in the CloudTrail console in Event history. Using the + * information collected by CloudTrail you can determine the request that was made to + * Security Lake, the IP address from which the request was made, who made the request, when it + * was made, and additional details. To learn more about Security Lake information in CloudTrail, see the Amazon Security Lake User Guide.

+ *

Security Lake automates the collection of security-related log and event data from + * integrated Amazon Web Services and third-party services. It also helps you manage + * the lifecycle of data with customizable retention and replication settings. Security Lake + * converts ingested data into Apache Parquet format and a standard open-source schema called + * the Open Cybersecurity Schema Framework (OCSF).

+ *

Other Amazon Web Services and third-party services can subscribe to the data that's stored in Security Lake for + * incident response and security data analytics.

+ */ +export class SecurityLake extends SecurityLakeClient implements SecurityLake {} +createAggregatedClient(commands, SecurityLake); diff --git a/clients/client-serverlessapplicationrepository/src/ServerlessApplicationRepository.ts b/clients/client-serverlessapplicationrepository/src/ServerlessApplicationRepository.ts index 0d3e572d134d..e1908ae0c123 100644 --- a/clients/client-serverlessapplicationrepository/src/ServerlessApplicationRepository.ts +++ b/clients/client-serverlessapplicationrepository/src/ServerlessApplicationRepository.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -71,494 +72,289 @@ import { UpdateApplicationCommandInput, UpdateApplicationCommandOutput, } from "./commands/UpdateApplicationCommand"; -import { ServerlessApplicationRepositoryClient } from "./ServerlessApplicationRepositoryClient"; +import { + ServerlessApplicationRepositoryClient, + ServerlessApplicationRepositoryClientConfig, +} from "./ServerlessApplicationRepositoryClient"; -/** - * @public - *

The AWS Serverless Application Repository makes it easy for developers and enterprises to quickly find - * and deploy serverless applications in the AWS Cloud. For more information about serverless applications, - * see Serverless Computing and Applications on the AWS website.

The AWS Serverless Application Repository is deeply integrated with the AWS Lambda console, so that developers of - * all levels can get started with serverless computing without needing to learn anything new. You can use category - * keywords to browse for applications such as web and mobile backends, data processing applications, or chatbots. - * You can also search for applications by name, publisher, or event source. To use an application, you simply choose it, - * configure any required fields, and deploy it with a few clicks.

You can also easily publish applications, sharing them publicly with the community at large, or privately - * within your team or across your organization. To publish a serverless application (or app), you can use the - * AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS SDKs to upload the code. Along with the - * code, you upload a simple manifest file, also known as the AWS Serverless Application Model (AWS SAM) template. - * For more information about AWS SAM, see AWS Serverless Application Model (AWS SAM) on the AWS Labs - * GitHub repository.

The AWS Serverless Application Repository Developer Guide contains more information about the two developer - * experiences available:

    - *
  • - *

    Consuming Applications – Browse for applications and view information about them, including - * source code and readme files. Also install, configure, and deploy applications of your choosing.

    - *

    Publishing Applications – Configure and upload applications to make them available to other - * developers, and publish new versions of applications.

    - *
  • - *
- */ -export class ServerlessApplicationRepository extends ServerlessApplicationRepositoryClient { +const commands = { + CreateApplicationCommand, + CreateApplicationVersionCommand, + CreateCloudFormationChangeSetCommand, + CreateCloudFormationTemplateCommand, + DeleteApplicationCommand, + GetApplicationCommand, + GetApplicationPolicyCommand, + GetCloudFormationTemplateCommand, + ListApplicationDependenciesCommand, + ListApplicationsCommand, + ListApplicationVersionsCommand, + PutApplicationPolicyCommand, + UnshareApplicationCommand, + UpdateApplicationCommand, +}; + +export interface ServerlessApplicationRepository { /** - * @public - *

Creates an application, optionally including an AWS SAM file to create the first application version in the same call.

+ * @see {@link CreateApplicationCommand} */ - public createApplication( + createApplication( args: CreateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApplication( + createApplication( args: CreateApplicationCommandInput, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( + createApplication( args: CreateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( - args: CreateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApplicationCommandOutput) => void), - cb?: (err: any, data?: CreateApplicationCommandOutput) => void - ): Promise | void { - const command = new CreateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an application version.

+ * @see {@link CreateApplicationVersionCommand} */ - public createApplicationVersion( + createApplicationVersion( args: CreateApplicationVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApplicationVersion( + createApplicationVersion( args: CreateApplicationVersionCommandInput, cb: (err: any, data?: CreateApplicationVersionCommandOutput) => void ): void; - public createApplicationVersion( + createApplicationVersion( args: CreateApplicationVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApplicationVersionCommandOutput) => void ): void; - public createApplicationVersion( - args: CreateApplicationVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApplicationVersionCommandOutput) => void), - cb?: (err: any, data?: CreateApplicationVersionCommandOutput) => void - ): Promise | void { - const command = new CreateApplicationVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an AWS CloudFormation change set for the given application.

+ * @see {@link CreateCloudFormationChangeSetCommand} */ - public createCloudFormationChangeSet( + createCloudFormationChangeSet( args: CreateCloudFormationChangeSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCloudFormationChangeSet( + createCloudFormationChangeSet( args: CreateCloudFormationChangeSetCommandInput, cb: (err: any, data?: CreateCloudFormationChangeSetCommandOutput) => void ): void; - public createCloudFormationChangeSet( + createCloudFormationChangeSet( args: CreateCloudFormationChangeSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCloudFormationChangeSetCommandOutput) => void ): void; - public createCloudFormationChangeSet( - args: CreateCloudFormationChangeSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCloudFormationChangeSetCommandOutput) => void), - cb?: (err: any, data?: CreateCloudFormationChangeSetCommandOutput) => void - ): Promise | void { - const command = new CreateCloudFormationChangeSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an AWS CloudFormation template.

+ * @see {@link CreateCloudFormationTemplateCommand} */ - public createCloudFormationTemplate( + createCloudFormationTemplate( args: CreateCloudFormationTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCloudFormationTemplate( + createCloudFormationTemplate( args: CreateCloudFormationTemplateCommandInput, cb: (err: any, data?: CreateCloudFormationTemplateCommandOutput) => void ): void; - public createCloudFormationTemplate( + createCloudFormationTemplate( args: CreateCloudFormationTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCloudFormationTemplateCommandOutput) => void ): void; - public createCloudFormationTemplate( - args: CreateCloudFormationTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCloudFormationTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateCloudFormationTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateCloudFormationTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified application.

+ * @see {@link DeleteApplicationCommand} */ - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( - args: DeleteApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApplicationCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the specified application.

+ * @see {@link GetApplicationCommand} */ - public getApplication( + getApplication( args: GetApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getApplication( - args: GetApplicationCommandInput, - cb: (err: any, data?: GetApplicationCommandOutput) => void - ): void; - public getApplication( + getApplication(args: GetApplicationCommandInput, cb: (err: any, data?: GetApplicationCommandOutput) => void): void; + getApplication( args: GetApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApplicationCommandOutput) => void ): void; - public getApplication( - args: GetApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApplicationCommandOutput) => void), - cb?: (err: any, data?: GetApplicationCommandOutput) => void - ): Promise | void { - const command = new GetApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the policy for the application.

+ * @see {@link GetApplicationPolicyCommand} */ - public getApplicationPolicy( + getApplicationPolicy( args: GetApplicationPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getApplicationPolicy( + getApplicationPolicy( args: GetApplicationPolicyCommandInput, cb: (err: any, data?: GetApplicationPolicyCommandOutput) => void ): void; - public getApplicationPolicy( + getApplicationPolicy( args: GetApplicationPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApplicationPolicyCommandOutput) => void ): void; - public getApplicationPolicy( - args: GetApplicationPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApplicationPolicyCommandOutput) => void), - cb?: (err: any, data?: GetApplicationPolicyCommandOutput) => void - ): Promise | void { - const command = new GetApplicationPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the specified AWS CloudFormation template.

+ * @see {@link GetCloudFormationTemplateCommand} */ - public getCloudFormationTemplate( + getCloudFormationTemplate( args: GetCloudFormationTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCloudFormationTemplate( + getCloudFormationTemplate( args: GetCloudFormationTemplateCommandInput, cb: (err: any, data?: GetCloudFormationTemplateCommandOutput) => void ): void; - public getCloudFormationTemplate( + getCloudFormationTemplate( args: GetCloudFormationTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCloudFormationTemplateCommandOutput) => void ): void; - public getCloudFormationTemplate( - args: GetCloudFormationTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCloudFormationTemplateCommandOutput) => void), - cb?: (err: any, data?: GetCloudFormationTemplateCommandOutput) => void - ): Promise | void { - const command = new GetCloudFormationTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the list of applications nested in the containing application.

+ * @see {@link ListApplicationDependenciesCommand} */ - public listApplicationDependencies( + listApplicationDependencies( args: ListApplicationDependenciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplicationDependencies( + listApplicationDependencies( args: ListApplicationDependenciesCommandInput, cb: (err: any, data?: ListApplicationDependenciesCommandOutput) => void ): void; - public listApplicationDependencies( + listApplicationDependencies( args: ListApplicationDependenciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationDependenciesCommandOutput) => void ): void; - public listApplicationDependencies( - args: ListApplicationDependenciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationDependenciesCommandOutput) => void), - cb?: (err: any, data?: ListApplicationDependenciesCommandOutput) => void - ): Promise | void { - const command = new ListApplicationDependenciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists applications owned by the requester.

+ * @see {@link ListApplicationsCommand} */ - public listApplications( + listApplications( args: ListApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplications( + listApplications( args: ListApplicationsCommandInput, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( + listApplications( args: ListApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( - args: ListApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationsCommandOutput) => void), - cb?: (err: any, data?: ListApplicationsCommandOutput) => void - ): Promise | void { - const command = new ListApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists versions for the specified application.

+ * @see {@link ListApplicationVersionsCommand} */ - public listApplicationVersions( + listApplicationVersions( args: ListApplicationVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplicationVersions( + listApplicationVersions( args: ListApplicationVersionsCommandInput, cb: (err: any, data?: ListApplicationVersionsCommandOutput) => void ): void; - public listApplicationVersions( + listApplicationVersions( args: ListApplicationVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationVersionsCommandOutput) => void ): void; - public listApplicationVersions( - args: ListApplicationVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationVersionsCommandOutput) => void), - cb?: (err: any, data?: ListApplicationVersionsCommandOutput) => void - ): Promise | void { - const command = new ListApplicationVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the permission policy for an application. For the list of actions supported for this operation, see - * Application - * Permissions - * .

+ * @see {@link PutApplicationPolicyCommand} */ - public putApplicationPolicy( + putApplicationPolicy( args: PutApplicationPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putApplicationPolicy( + putApplicationPolicy( args: PutApplicationPolicyCommandInput, cb: (err: any, data?: PutApplicationPolicyCommandOutput) => void ): void; - public putApplicationPolicy( + putApplicationPolicy( args: PutApplicationPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutApplicationPolicyCommandOutput) => void ): void; - public putApplicationPolicy( - args: PutApplicationPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutApplicationPolicyCommandOutput) => void), - cb?: (err: any, data?: PutApplicationPolicyCommandOutput) => void - ): Promise | void { - const command = new PutApplicationPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Unshares an application from an AWS Organization.

This operation can be called only from the organization's master account.

+ * @see {@link UnshareApplicationCommand} */ - public unshareApplication( + unshareApplication( args: UnshareApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public unshareApplication( + unshareApplication( args: UnshareApplicationCommandInput, cb: (err: any, data?: UnshareApplicationCommandOutput) => void ): void; - public unshareApplication( + unshareApplication( args: UnshareApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnshareApplicationCommandOutput) => void ): void; - public unshareApplication( - args: UnshareApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnshareApplicationCommandOutput) => void), - cb?: (err: any, data?: UnshareApplicationCommandOutput) => void - ): Promise | void { - const command = new UnshareApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified application.

+ * @see {@link UpdateApplicationCommand} */ - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( - args: UpdateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApplicationCommandOutput) => void), - cb?: (err: any, data?: UpdateApplicationCommandOutput) => void - ): Promise | void { - const command = new UpdateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The AWS Serverless Application Repository makes it easy for developers and enterprises to quickly find + * and deploy serverless applications in the AWS Cloud. For more information about serverless applications, + * see Serverless Computing and Applications on the AWS website.

The AWS Serverless Application Repository is deeply integrated with the AWS Lambda console, so that developers of + * all levels can get started with serverless computing without needing to learn anything new. You can use category + * keywords to browse for applications such as web and mobile backends, data processing applications, or chatbots. + * You can also search for applications by name, publisher, or event source. To use an application, you simply choose it, + * configure any required fields, and deploy it with a few clicks.

You can also easily publish applications, sharing them publicly with the community at large, or privately + * within your team or across your organization. To publish a serverless application (or app), you can use the + * AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS SDKs to upload the code. Along with the + * code, you upload a simple manifest file, also known as the AWS Serverless Application Model (AWS SAM) template. + * For more information about AWS SAM, see AWS Serverless Application Model (AWS SAM) on the AWS Labs + * GitHub repository.

The AWS Serverless Application Repository Developer Guide contains more information about the two developer + * experiences available:

    + *
  • + *

    Consuming Applications – Browse for applications and view information about them, including + * source code and readme files. Also install, configure, and deploy applications of your choosing.

    + *

    Publishing Applications – Configure and upload applications to make them available to other + * developers, and publish new versions of applications.

    + *
  • + *
+ */ +export class ServerlessApplicationRepository + extends ServerlessApplicationRepositoryClient + implements ServerlessApplicationRepository {} +createAggregatedClient(commands, ServerlessApplicationRepository); diff --git a/clients/client-service-catalog-appregistry/src/ServiceCatalogAppRegistry.ts b/clients/client-service-catalog-appregistry/src/ServiceCatalogAppRegistry.ts index 0203660e4aa4..5cd1cafc77a4 100644 --- a/clients/client-service-catalog-appregistry/src/ServiceCatalogAppRegistry.ts +++ b/clients/client-service-catalog-appregistry/src/ServiceCatalogAppRegistry.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -117,858 +118,430 @@ import { UpdateAttributeGroupCommandInput, UpdateAttributeGroupCommandOutput, } from "./commands/UpdateAttributeGroupCommand"; -import { ServiceCatalogAppRegistryClient } from "./ServiceCatalogAppRegistryClient"; +import { + ServiceCatalogAppRegistryClient, + ServiceCatalogAppRegistryClientConfig, +} from "./ServiceCatalogAppRegistryClient"; -/** - * @public - *

Amazon Web Services Service Catalog AppRegistry enables organizations to understand the application context of their Amazon Web Services resources. AppRegistry provides a repository of your applications, their resources, and the application metadata that you use within your enterprise.

- */ -export class ServiceCatalogAppRegistry extends ServiceCatalogAppRegistryClient { +const commands = { + AssociateAttributeGroupCommand, + AssociateResourceCommand, + CreateApplicationCommand, + CreateAttributeGroupCommand, + DeleteApplicationCommand, + DeleteAttributeGroupCommand, + DisassociateAttributeGroupCommand, + DisassociateResourceCommand, + GetApplicationCommand, + GetAssociatedResourceCommand, + GetAttributeGroupCommand, + GetConfigurationCommand, + ListApplicationsCommand, + ListAssociatedAttributeGroupsCommand, + ListAssociatedResourcesCommand, + ListAttributeGroupsCommand, + ListAttributeGroupsForApplicationCommand, + ListTagsForResourceCommand, + PutConfigurationCommand, + SyncResourceCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateApplicationCommand, + UpdateAttributeGroupCommand, +}; + +export interface ServiceCatalogAppRegistry { /** - * @public - *

Associates an attribute group with an application to augment the application's metadata - * with the group's attributes. This feature enables applications to be described with - * user-defined details that are machine-readable, such as third-party integrations.

+ * @see {@link AssociateAttributeGroupCommand} */ - public associateAttributeGroup( + associateAttributeGroup( args: AssociateAttributeGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateAttributeGroup( + associateAttributeGroup( args: AssociateAttributeGroupCommandInput, cb: (err: any, data?: AssociateAttributeGroupCommandOutput) => void ): void; - public associateAttributeGroup( + associateAttributeGroup( args: AssociateAttributeGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateAttributeGroupCommandOutput) => void ): void; - public associateAttributeGroup( - args: AssociateAttributeGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateAttributeGroupCommandOutput) => void), - cb?: (err: any, data?: AssociateAttributeGroupCommandOutput) => void - ): Promise | void { - const command = new AssociateAttributeGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Associates a resource - * with an application. - * The resource can be specified - * by its ARN or name. - * The application can be specified - * by ARN, ID, or name. - *

+ * @see {@link AssociateResourceCommand} */ - public associateResource( + associateResource( args: AssociateResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateResource( + associateResource( args: AssociateResourceCommandInput, cb: (err: any, data?: AssociateResourceCommandOutput) => void ): void; - public associateResource( + associateResource( args: AssociateResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateResourceCommandOutput) => void ): void; - public associateResource( - args: AssociateResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateResourceCommandOutput) => void), - cb?: (err: any, data?: AssociateResourceCommandOutput) => void - ): Promise | void { - const command = new AssociateResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.

+ * @see {@link CreateApplicationCommand} */ - public createApplication( + createApplication( args: CreateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createApplication( + createApplication( args: CreateApplicationCommandInput, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( + createApplication( args: CreateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateApplicationCommandOutput) => void ): void; - public createApplication( - args: CreateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateApplicationCommandOutput) => void), - cb?: (err: any, data?: CreateApplicationCommandOutput) => void - ): Promise | void { - const command = new CreateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new attribute group as a container for user-defined attributes. This feature - * enables users to have full control over their cloud application's metadata in a rich - * machine-readable format to facilitate integration with automated workflows and third-party - * tools.

+ * @see {@link CreateAttributeGroupCommand} */ - public createAttributeGroup( + createAttributeGroup( args: CreateAttributeGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAttributeGroup( + createAttributeGroup( args: CreateAttributeGroupCommandInput, cb: (err: any, data?: CreateAttributeGroupCommandOutput) => void ): void; - public createAttributeGroup( + createAttributeGroup( args: CreateAttributeGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAttributeGroupCommandOutput) => void ): void; - public createAttributeGroup( - args: CreateAttributeGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAttributeGroupCommandOutput) => void), - cb?: (err: any, data?: CreateAttributeGroupCommandOutput) => void - ): Promise | void { - const command = new CreateAttributeGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an application that is specified either by its application ID, name, or ARN. All associated attribute groups and resources must be disassociated from it before deleting an application.

+ * @see {@link DeleteApplicationCommand} */ - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( + deleteApplication( args: DeleteApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteApplicationCommandOutput) => void ): void; - public deleteApplication( - args: DeleteApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteApplicationCommandOutput) => void), - cb?: (err: any, data?: DeleteApplicationCommandOutput) => void - ): Promise | void { - const command = new DeleteApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an attribute group, specified either by its attribute group ID, name, or ARN.

+ * @see {@link DeleteAttributeGroupCommand} */ - public deleteAttributeGroup( + deleteAttributeGroup( args: DeleteAttributeGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAttributeGroup( + deleteAttributeGroup( args: DeleteAttributeGroupCommandInput, cb: (err: any, data?: DeleteAttributeGroupCommandOutput) => void ): void; - public deleteAttributeGroup( + deleteAttributeGroup( args: DeleteAttributeGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAttributeGroupCommandOutput) => void ): void; - public deleteAttributeGroup( - args: DeleteAttributeGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAttributeGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteAttributeGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteAttributeGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates an attribute group from an application to remove the extra attributes contained in the attribute group from the application's metadata. This operation reverts AssociateAttributeGroup.

+ * @see {@link DisassociateAttributeGroupCommand} */ - public disassociateAttributeGroup( + disassociateAttributeGroup( args: DisassociateAttributeGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateAttributeGroup( + disassociateAttributeGroup( args: DisassociateAttributeGroupCommandInput, cb: (err: any, data?: DisassociateAttributeGroupCommandOutput) => void ): void; - public disassociateAttributeGroup( + disassociateAttributeGroup( args: DisassociateAttributeGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateAttributeGroupCommandOutput) => void ): void; - public disassociateAttributeGroup( - args: DisassociateAttributeGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateAttributeGroupCommandOutput) => void), - cb?: (err: any, data?: DisassociateAttributeGroupCommandOutput) => void - ): Promise | void { - const command = new DisassociateAttributeGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates a resource from application. Both the resource and the application can be specified either by ID or name.

+ * @see {@link DisassociateResourceCommand} */ - public disassociateResource( + disassociateResource( args: DisassociateResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateResource( + disassociateResource( args: DisassociateResourceCommandInput, cb: (err: any, data?: DisassociateResourceCommandOutput) => void ): void; - public disassociateResource( + disassociateResource( args: DisassociateResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateResourceCommandOutput) => void ): void; - public disassociateResource( - args: DisassociateResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateResourceCommandOutput) => void), - cb?: (err: any, data?: DisassociateResourceCommandOutput) => void - ): Promise | void { - const command = new DisassociateResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Retrieves metadata information - * about one - * of your applications. - * The application can be specified - * by its ARN, ID, or name - * (which is unique - * within one account - * in one region - * at a given point - * in time). - * Specify - * by ARN or ID - * in automated workflows - * if you want - * to make sure - * that the exact same application is returned or a ResourceNotFoundException is thrown, - * avoiding the ABA addressing problem. - *

+ * @see {@link GetApplicationCommand} */ - public getApplication( + getApplication( args: GetApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getApplication( - args: GetApplicationCommandInput, - cb: (err: any, data?: GetApplicationCommandOutput) => void - ): void; - public getApplication( + getApplication(args: GetApplicationCommandInput, cb: (err: any, data?: GetApplicationCommandOutput) => void): void; + getApplication( args: GetApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApplicationCommandOutput) => void ): void; - public getApplication( - args: GetApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApplicationCommandOutput) => void), - cb?: (err: any, data?: GetApplicationCommandOutput) => void - ): Promise | void { - const command = new GetApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the resource associated with the application.

+ * @see {@link GetAssociatedResourceCommand} */ - public getAssociatedResource( + getAssociatedResource( args: GetAssociatedResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAssociatedResource( + getAssociatedResource( args: GetAssociatedResourceCommandInput, cb: (err: any, data?: GetAssociatedResourceCommandOutput) => void ): void; - public getAssociatedResource( + getAssociatedResource( args: GetAssociatedResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAssociatedResourceCommandOutput) => void ): void; - public getAssociatedResource( - args: GetAssociatedResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAssociatedResourceCommandOutput) => void), - cb?: (err: any, data?: GetAssociatedResourceCommandOutput) => void - ): Promise | void { - const command = new GetAssociatedResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Retrieves an attribute group - * by its ARN, ID, or name. - * The attribute group can be specified - * by its ARN, ID, or name. - *

+ * @see {@link GetAttributeGroupCommand} */ - public getAttributeGroup( + getAttributeGroup( args: GetAttributeGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAttributeGroup( + getAttributeGroup( args: GetAttributeGroupCommandInput, cb: (err: any, data?: GetAttributeGroupCommandOutput) => void ): void; - public getAttributeGroup( + getAttributeGroup( args: GetAttributeGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAttributeGroupCommandOutput) => void ): void; - public getAttributeGroup( - args: GetAttributeGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAttributeGroupCommandOutput) => void), - cb?: (err: any, data?: GetAttributeGroupCommandOutput) => void - ): Promise | void { - const command = new GetAttributeGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Retrieves a TagKey configuration - * from an account. - *

+ * @see {@link GetConfigurationCommand} */ - public getConfiguration( + getConfiguration( args: GetConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConfiguration( + getConfiguration( args: GetConfigurationCommandInput, cb: (err: any, data?: GetConfigurationCommandOutput) => void ): void; - public getConfiguration( + getConfiguration( args: GetConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConfigurationCommandOutput) => void ): void; - public getConfiguration( - args: GetConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of all of your applications. Results are paginated.

+ * @see {@link ListApplicationsCommand} */ - public listApplications( + listApplications( args: ListApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplications( + listApplications( args: ListApplicationsCommandInput, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( + listApplications( args: ListApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( - args: ListApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationsCommandOutput) => void), - cb?: (err: any, data?: ListApplicationsCommandOutput) => void - ): Promise | void { - const command = new ListApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all attribute groups that are associated with specified application. Results are paginated.

+ * @see {@link ListAssociatedAttributeGroupsCommand} */ - public listAssociatedAttributeGroups( + listAssociatedAttributeGroups( args: ListAssociatedAttributeGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssociatedAttributeGroups( + listAssociatedAttributeGroups( args: ListAssociatedAttributeGroupsCommandInput, cb: (err: any, data?: ListAssociatedAttributeGroupsCommandOutput) => void ): void; - public listAssociatedAttributeGroups( + listAssociatedAttributeGroups( args: ListAssociatedAttributeGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssociatedAttributeGroupsCommandOutput) => void ): void; - public listAssociatedAttributeGroups( - args: ListAssociatedAttributeGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssociatedAttributeGroupsCommandOutput) => void), - cb?: (err: any, data?: ListAssociatedAttributeGroupsCommandOutput) => void - ): Promise | void { - const command = new ListAssociatedAttributeGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Lists all - * of the resources - * that are associated - * with the specified application. - * Results are paginated. - *

- * - *

- * If you share an application, - * and a consumer account associates a tag query - * to the application, - * all of the users - * who can access the application - * can also view the tag values - * in all accounts - * that are associated - * with it - * using this API. - *

- *
+ * @see {@link ListAssociatedResourcesCommand} */ - public listAssociatedResources( + listAssociatedResources( args: ListAssociatedResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssociatedResources( + listAssociatedResources( args: ListAssociatedResourcesCommandInput, cb: (err: any, data?: ListAssociatedResourcesCommandOutput) => void ): void; - public listAssociatedResources( + listAssociatedResources( args: ListAssociatedResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssociatedResourcesCommandOutput) => void ): void; - public listAssociatedResources( - args: ListAssociatedResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssociatedResourcesCommandOutput) => void), - cb?: (err: any, data?: ListAssociatedResourcesCommandOutput) => void - ): Promise | void { - const command = new ListAssociatedResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all attribute groups which you have access to. Results are paginated.

+ * @see {@link ListAttributeGroupsCommand} */ - public listAttributeGroups( + listAttributeGroups( args: ListAttributeGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAttributeGroups( + listAttributeGroups( args: ListAttributeGroupsCommandInput, cb: (err: any, data?: ListAttributeGroupsCommandOutput) => void ): void; - public listAttributeGroups( + listAttributeGroups( args: ListAttributeGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAttributeGroupsCommandOutput) => void ): void; - public listAttributeGroups( - args: ListAttributeGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAttributeGroupsCommandOutput) => void), - cb?: (err: any, data?: ListAttributeGroupsCommandOutput) => void - ): Promise | void { - const command = new ListAttributeGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the details of all attribute groups associated with a specific application. The results display in pages.

+ * @see {@link ListAttributeGroupsForApplicationCommand} */ - public listAttributeGroupsForApplication( + listAttributeGroupsForApplication( args: ListAttributeGroupsForApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAttributeGroupsForApplication( + listAttributeGroupsForApplication( args: ListAttributeGroupsForApplicationCommandInput, cb: (err: any, data?: ListAttributeGroupsForApplicationCommandOutput) => void ): void; - public listAttributeGroupsForApplication( + listAttributeGroupsForApplication( args: ListAttributeGroupsForApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAttributeGroupsForApplicationCommandOutput) => void ): void; - public listAttributeGroupsForApplication( - args: ListAttributeGroupsForApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAttributeGroupsForApplicationCommandOutput) => void), - cb?: (err: any, data?: ListAttributeGroupsForApplicationCommandOutput) => void - ): Promise | void { - const command = new ListAttributeGroupsForApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all of the tags on the resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Associates a TagKey configuration - * to an account. - *

+ * @see {@link PutConfigurationCommand} */ - public putConfiguration( + putConfiguration( args: PutConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putConfiguration( + putConfiguration( args: PutConfigurationCommandInput, cb: (err: any, data?: PutConfigurationCommandOutput) => void ): void; - public putConfiguration( + putConfiguration( args: PutConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConfigurationCommandOutput) => void ): void; - public putConfiguration( - args: PutConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Syncs the resource with current AppRegistry records.

- *

Specifically, the resource’s AppRegistry system tags sync with its associated application. We remove the resource's AppRegistry system tags if it does not associate with the application. The caller must have permissions to read and update the resource.

+ * @see {@link SyncResourceCommand} */ - public syncResource( - args: SyncResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public syncResource(args: SyncResourceCommandInput, cb: (err: any, data?: SyncResourceCommandOutput) => void): void; - public syncResource( + syncResource(args: SyncResourceCommandInput, options?: __HttpHandlerOptions): Promise; + syncResource(args: SyncResourceCommandInput, cb: (err: any, data?: SyncResourceCommandOutput) => void): void; + syncResource( args: SyncResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SyncResourceCommandOutput) => void ): void; - public syncResource( - args: SyncResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SyncResourceCommandOutput) => void), - cb?: (err: any, data?: SyncResourceCommandOutput) => void - ): Promise | void { - const command = new SyncResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns one or more tags (key-value pairs) to the specified resource.

- *

Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.

- *

This operation returns an empty response if the call was successful.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from a resource.

- *

This operation returns an empty response if the call was successful.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing application with new attributes.

+ * @see {@link UpdateApplicationCommand} */ - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( + updateApplication( args: UpdateApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationCommandOutput) => void ): void; - public updateApplication( - args: UpdateApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApplicationCommandOutput) => void), - cb?: (err: any, data?: UpdateApplicationCommandOutput) => void - ): Promise | void { - const command = new UpdateApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing attribute group with new details.

+ * @see {@link UpdateAttributeGroupCommand} */ - public updateAttributeGroup( + updateAttributeGroup( args: UpdateAttributeGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAttributeGroup( + updateAttributeGroup( args: UpdateAttributeGroupCommandInput, cb: (err: any, data?: UpdateAttributeGroupCommandOutput) => void ): void; - public updateAttributeGroup( + updateAttributeGroup( args: UpdateAttributeGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAttributeGroupCommandOutput) => void ): void; - public updateAttributeGroup( - args: UpdateAttributeGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAttributeGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateAttributeGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateAttributeGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Web Services Service Catalog AppRegistry enables organizations to understand the application context of their Amazon Web Services resources. AppRegistry provides a repository of your applications, their resources, and the application metadata that you use within your enterprise.

+ */ +export class ServiceCatalogAppRegistry extends ServiceCatalogAppRegistryClient implements ServiceCatalogAppRegistry {} +createAggregatedClient(commands, ServiceCatalogAppRegistry); diff --git a/clients/client-service-catalog/src/ServiceCatalog.ts b/clients/client-service-catalog/src/ServiceCatalog.ts index dcdd0d5a3523..2accb708002d 100644 --- a/clients/client-service-catalog/src/ServiceCatalog.ts +++ b/clients/client-service-catalog/src/ServiceCatalog.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -447,3279 +448,1582 @@ import { UpdateTagOptionCommandInput, UpdateTagOptionCommandOutput, } from "./commands/UpdateTagOptionCommand"; -import { ServiceCatalogClient } from "./ServiceCatalogClient"; +import { ServiceCatalogClient, ServiceCatalogClientConfig } from "./ServiceCatalogClient"; -/** - * @public - * Service Catalog - *

- * Service Catalog enables - * organizations to create and manage catalogs of IT services that are approved for Amazon Web Services. To - * get the most out of this documentation, you should be familiar with the terminology - * discussed in Service Catalog - * Concepts.

- */ -export class ServiceCatalog extends ServiceCatalogClient { +const commands = { + AcceptPortfolioShareCommand, + AssociateBudgetWithResourceCommand, + AssociatePrincipalWithPortfolioCommand, + AssociateProductWithPortfolioCommand, + AssociateServiceActionWithProvisioningArtifactCommand, + AssociateTagOptionWithResourceCommand, + BatchAssociateServiceActionWithProvisioningArtifactCommand, + BatchDisassociateServiceActionFromProvisioningArtifactCommand, + CopyProductCommand, + CreateConstraintCommand, + CreatePortfolioCommand, + CreatePortfolioShareCommand, + CreateProductCommand, + CreateProvisionedProductPlanCommand, + CreateProvisioningArtifactCommand, + CreateServiceActionCommand, + CreateTagOptionCommand, + DeleteConstraintCommand, + DeletePortfolioCommand, + DeletePortfolioShareCommand, + DeleteProductCommand, + DeleteProvisionedProductPlanCommand, + DeleteProvisioningArtifactCommand, + DeleteServiceActionCommand, + DeleteTagOptionCommand, + DescribeConstraintCommand, + DescribeCopyProductStatusCommand, + DescribePortfolioCommand, + DescribePortfolioSharesCommand, + DescribePortfolioShareStatusCommand, + DescribeProductCommand, + DescribeProductAsAdminCommand, + DescribeProductViewCommand, + DescribeProvisionedProductCommand, + DescribeProvisionedProductPlanCommand, + DescribeProvisioningArtifactCommand, + DescribeProvisioningParametersCommand, + DescribeRecordCommand, + DescribeServiceActionCommand, + DescribeServiceActionExecutionParametersCommand, + DescribeTagOptionCommand, + DisableAWSOrganizationsAccessCommand, + DisassociateBudgetFromResourceCommand, + DisassociatePrincipalFromPortfolioCommand, + DisassociateProductFromPortfolioCommand, + DisassociateServiceActionFromProvisioningArtifactCommand, + DisassociateTagOptionFromResourceCommand, + EnableAWSOrganizationsAccessCommand, + ExecuteProvisionedProductPlanCommand, + ExecuteProvisionedProductServiceActionCommand, + GetAWSOrganizationsAccessStatusCommand, + GetProvisionedProductOutputsCommand, + ImportAsProvisionedProductCommand, + ListAcceptedPortfolioSharesCommand, + ListBudgetsForResourceCommand, + ListConstraintsForPortfolioCommand, + ListLaunchPathsCommand, + ListOrganizationPortfolioAccessCommand, + ListPortfolioAccessCommand, + ListPortfoliosCommand, + ListPortfoliosForProductCommand, + ListPrincipalsForPortfolioCommand, + ListProvisionedProductPlansCommand, + ListProvisioningArtifactsCommand, + ListProvisioningArtifactsForServiceActionCommand, + ListRecordHistoryCommand, + ListResourcesForTagOptionCommand, + ListServiceActionsCommand, + ListServiceActionsForProvisioningArtifactCommand, + ListStackInstancesForProvisionedProductCommand, + ListTagOptionsCommand, + NotifyProvisionProductEngineWorkflowResultCommand, + NotifyTerminateProvisionedProductEngineWorkflowResultCommand, + NotifyUpdateProvisionedProductEngineWorkflowResultCommand, + ProvisionProductCommand, + RejectPortfolioShareCommand, + ScanProvisionedProductsCommand, + SearchProductsCommand, + SearchProductsAsAdminCommand, + SearchProvisionedProductsCommand, + TerminateProvisionedProductCommand, + UpdateConstraintCommand, + UpdatePortfolioCommand, + UpdatePortfolioShareCommand, + UpdateProductCommand, + UpdateProvisionedProductCommand, + UpdateProvisionedProductPropertiesCommand, + UpdateProvisioningArtifactCommand, + UpdateServiceActionCommand, + UpdateTagOptionCommand, +}; + +export interface ServiceCatalog { /** - * @public - *

Accepts an offer to share the specified portfolio.

+ * @see {@link AcceptPortfolioShareCommand} */ - public acceptPortfolioShare( + acceptPortfolioShare( args: AcceptPortfolioShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public acceptPortfolioShare( + acceptPortfolioShare( args: AcceptPortfolioShareCommandInput, cb: (err: any, data?: AcceptPortfolioShareCommandOutput) => void ): void; - public acceptPortfolioShare( + acceptPortfolioShare( args: AcceptPortfolioShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptPortfolioShareCommandOutput) => void ): void; - public acceptPortfolioShare( - args: AcceptPortfolioShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptPortfolioShareCommandOutput) => void), - cb?: (err: any, data?: AcceptPortfolioShareCommandOutput) => void - ): Promise | void { - const command = new AcceptPortfolioShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates the specified budget with the specified resource.

- */ - public associateBudgetWithResource( + + /** + * @see {@link AssociateBudgetWithResourceCommand} + */ + associateBudgetWithResource( args: AssociateBudgetWithResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateBudgetWithResource( + associateBudgetWithResource( args: AssociateBudgetWithResourceCommandInput, cb: (err: any, data?: AssociateBudgetWithResourceCommandOutput) => void ): void; - public associateBudgetWithResource( + associateBudgetWithResource( args: AssociateBudgetWithResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateBudgetWithResourceCommandOutput) => void ): void; - public associateBudgetWithResource( - args: AssociateBudgetWithResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateBudgetWithResourceCommandOutput) => void), - cb?: (err: any, data?: AssociateBudgetWithResourceCommandOutput) => void - ): Promise | void { - const command = new AssociateBudgetWithResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates the specified principal ARN with the specified portfolio.

- *

If you share the portfolio with principal name sharing enabled, the PrincipalARN association is - * included in the share.

- *

The PortfolioID, PrincipalARN, and PrincipalType parameters are - * required.

- *

You can associate a maximum of 10 Principals with a portfolio using PrincipalType as IAM_PATTERN - *

- * - *

When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is - * then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, - * but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal - * name association for the portfolio. Although this user may not know which principal names are associated through - * Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then - * Service Catalog recommends using PrincipalType as IAM. With this configuration, - * the PrincipalARN must already exist in the recipient account before it can be associated.

- *
- */ - public associatePrincipalWithPortfolio( + + /** + * @see {@link AssociatePrincipalWithPortfolioCommand} + */ + associatePrincipalWithPortfolio( args: AssociatePrincipalWithPortfolioCommandInput, options?: __HttpHandlerOptions ): Promise; - public associatePrincipalWithPortfolio( + associatePrincipalWithPortfolio( args: AssociatePrincipalWithPortfolioCommandInput, cb: (err: any, data?: AssociatePrincipalWithPortfolioCommandOutput) => void ): void; - public associatePrincipalWithPortfolio( + associatePrincipalWithPortfolio( args: AssociatePrincipalWithPortfolioCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociatePrincipalWithPortfolioCommandOutput) => void ): void; - public associatePrincipalWithPortfolio( - args: AssociatePrincipalWithPortfolioCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociatePrincipalWithPortfolioCommandOutput) => void), - cb?: (err: any, data?: AssociatePrincipalWithPortfolioCommandOutput) => void - ): Promise | void { - const command = new AssociatePrincipalWithPortfolioCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates the specified product with the specified portfolio.

- *

A delegated admin is authorized to invoke this command.

- */ - public associateProductWithPortfolio( + + /** + * @see {@link AssociateProductWithPortfolioCommand} + */ + associateProductWithPortfolio( args: AssociateProductWithPortfolioCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateProductWithPortfolio( + associateProductWithPortfolio( args: AssociateProductWithPortfolioCommandInput, cb: (err: any, data?: AssociateProductWithPortfolioCommandOutput) => void ): void; - public associateProductWithPortfolio( + associateProductWithPortfolio( args: AssociateProductWithPortfolioCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateProductWithPortfolioCommandOutput) => void ): void; - public associateProductWithPortfolio( - args: AssociateProductWithPortfolioCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateProductWithPortfolioCommandOutput) => void), - cb?: (err: any, data?: AssociateProductWithPortfolioCommandOutput) => void - ): Promise | void { - const command = new AssociateProductWithPortfolioCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a self-service action with a provisioning artifact.

- */ - public associateServiceActionWithProvisioningArtifact( + + /** + * @see {@link AssociateServiceActionWithProvisioningArtifactCommand} + */ + associateServiceActionWithProvisioningArtifact( args: AssociateServiceActionWithProvisioningArtifactCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateServiceActionWithProvisioningArtifact( + associateServiceActionWithProvisioningArtifact( args: AssociateServiceActionWithProvisioningArtifactCommandInput, cb: (err: any, data?: AssociateServiceActionWithProvisioningArtifactCommandOutput) => void ): void; - public associateServiceActionWithProvisioningArtifact( + associateServiceActionWithProvisioningArtifact( args: AssociateServiceActionWithProvisioningArtifactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateServiceActionWithProvisioningArtifactCommandOutput) => void ): void; - public associateServiceActionWithProvisioningArtifact( - args: AssociateServiceActionWithProvisioningArtifactCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AssociateServiceActionWithProvisioningArtifactCommandOutput) => void), - cb?: (err: any, data?: AssociateServiceActionWithProvisioningArtifactCommandOutput) => void - ): Promise | void { - const command = new AssociateServiceActionWithProvisioningArtifactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associate the specified TagOption with the specified portfolio or product.

- */ - public associateTagOptionWithResource( + + /** + * @see {@link AssociateTagOptionWithResourceCommand} + */ + associateTagOptionWithResource( args: AssociateTagOptionWithResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateTagOptionWithResource( + associateTagOptionWithResource( args: AssociateTagOptionWithResourceCommandInput, cb: (err: any, data?: AssociateTagOptionWithResourceCommandOutput) => void ): void; - public associateTagOptionWithResource( + associateTagOptionWithResource( args: AssociateTagOptionWithResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateTagOptionWithResourceCommandOutput) => void ): void; - public associateTagOptionWithResource( - args: AssociateTagOptionWithResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateTagOptionWithResourceCommandOutput) => void), - cb?: (err: any, data?: AssociateTagOptionWithResourceCommandOutput) => void - ): Promise | void { - const command = new AssociateTagOptionWithResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates multiple self-service actions with provisioning artifacts.

- */ - public batchAssociateServiceActionWithProvisioningArtifact( + + /** + * @see {@link BatchAssociateServiceActionWithProvisioningArtifactCommand} + */ + batchAssociateServiceActionWithProvisioningArtifact( args: BatchAssociateServiceActionWithProvisioningArtifactCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchAssociateServiceActionWithProvisioningArtifact( + batchAssociateServiceActionWithProvisioningArtifact( args: BatchAssociateServiceActionWithProvisioningArtifactCommandInput, cb: (err: any, data?: BatchAssociateServiceActionWithProvisioningArtifactCommandOutput) => void ): void; - public batchAssociateServiceActionWithProvisioningArtifact( + batchAssociateServiceActionWithProvisioningArtifact( args: BatchAssociateServiceActionWithProvisioningArtifactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchAssociateServiceActionWithProvisioningArtifactCommandOutput) => void ): void; - public batchAssociateServiceActionWithProvisioningArtifact( - args: BatchAssociateServiceActionWithProvisioningArtifactCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: BatchAssociateServiceActionWithProvisioningArtifactCommandOutput) => void), - cb?: (err: any, data?: BatchAssociateServiceActionWithProvisioningArtifactCommandOutput) => void - ): Promise | void { - const command = new BatchAssociateServiceActionWithProvisioningArtifactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a batch of self-service actions from the specified provisioning artifact.

- */ - public batchDisassociateServiceActionFromProvisioningArtifact( + + /** + * @see {@link BatchDisassociateServiceActionFromProvisioningArtifactCommand} + */ + batchDisassociateServiceActionFromProvisioningArtifact( args: BatchDisassociateServiceActionFromProvisioningArtifactCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchDisassociateServiceActionFromProvisioningArtifact( + batchDisassociateServiceActionFromProvisioningArtifact( args: BatchDisassociateServiceActionFromProvisioningArtifactCommandInput, cb: (err: any, data?: BatchDisassociateServiceActionFromProvisioningArtifactCommandOutput) => void ): void; - public batchDisassociateServiceActionFromProvisioningArtifact( + batchDisassociateServiceActionFromProvisioningArtifact( args: BatchDisassociateServiceActionFromProvisioningArtifactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDisassociateServiceActionFromProvisioningArtifactCommandOutput) => void ): void; - public batchDisassociateServiceActionFromProvisioningArtifact( - args: BatchDisassociateServiceActionFromProvisioningArtifactCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: BatchDisassociateServiceActionFromProvisioningArtifactCommandOutput) => void), - cb?: (err: any, data?: BatchDisassociateServiceActionFromProvisioningArtifactCommandOutput) => void - ): Promise | void { - const command = new BatchDisassociateServiceActionFromProvisioningArtifactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Copies the specified source product to the specified target product or a new - * product.

- *

You can copy a product to the same account or another account. You can copy a product - * to the same Region or another Region. If you copy a product to another account, you must - * first share the product in a portfolio using CreatePortfolioShare.

- *

This operation is performed asynchronously. To track the progress of the - * operation, use DescribeCopyProductStatus.

- */ - public copyProduct(args: CopyProductCommandInput, options?: __HttpHandlerOptions): Promise; - public copyProduct(args: CopyProductCommandInput, cb: (err: any, data?: CopyProductCommandOutput) => void): void; - public copyProduct( + + /** + * @see {@link CopyProductCommand} + */ + copyProduct(args: CopyProductCommandInput, options?: __HttpHandlerOptions): Promise; + copyProduct(args: CopyProductCommandInput, cb: (err: any, data?: CopyProductCommandOutput) => void): void; + copyProduct( args: CopyProductCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyProductCommandOutput) => void ): void; - public copyProduct( - args: CopyProductCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopyProductCommandOutput) => void), - cb?: (err: any, data?: CopyProductCommandOutput) => void - ): Promise | void { - const command = new CopyProductCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a constraint.

- *

A delegated admin is authorized to invoke this command.

- */ - public createConstraint( + + /** + * @see {@link CreateConstraintCommand} + */ + createConstraint( args: CreateConstraintCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConstraint( + createConstraint( args: CreateConstraintCommandInput, cb: (err: any, data?: CreateConstraintCommandOutput) => void ): void; - public createConstraint( + createConstraint( args: CreateConstraintCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConstraintCommandOutput) => void ): void; - public createConstraint( - args: CreateConstraintCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConstraintCommandOutput) => void), - cb?: (err: any, data?: CreateConstraintCommandOutput) => void - ): Promise | void { - const command = new CreateConstraintCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a portfolio.

- *

A delegated admin is authorized to invoke this command.

- */ - public createPortfolio( + + /** + * @see {@link CreatePortfolioCommand} + */ + createPortfolio( args: CreatePortfolioCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPortfolio( - args: CreatePortfolioCommandInput, - cb: (err: any, data?: CreatePortfolioCommandOutput) => void - ): void; - public createPortfolio( + createPortfolio(args: CreatePortfolioCommandInput, cb: (err: any, data?: CreatePortfolioCommandOutput) => void): void; + createPortfolio( args: CreatePortfolioCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePortfolioCommandOutput) => void ): void; - public createPortfolio( - args: CreatePortfolioCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePortfolioCommandOutput) => void), - cb?: (err: any, data?: CreatePortfolioCommandOutput) => void - ): Promise | void { - const command = new CreatePortfolioCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Shares the specified portfolio with the specified account or organization node. - * Shares to an organization node can only be created by the management account of an - * organization or by a delegated administrator. You can share portfolios to an organization, - * an organizational unit, or a specific account.

- *

Note that if a delegated admin is de-registered, they can no longer create portfolio shares.

- *

- * AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node.

- *

You can't share a shared resource, including portfolios that contain a shared product.

- *

If the portfolio share with the specified account or organization node already exists, this action will have no effect - * and will not return an error. To update an existing share, you must use the UpdatePortfolioShare API instead.

- * - *

When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is - * then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, - * but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal - * name association for the portfolio. Although this user may not know which principal names are associated through - * Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then - * Service Catalog recommends using PrincipalType as IAM. With this configuration, - * the PrincipalARN must already exist in the recipient account before it can be associated.

- *
- */ - public createPortfolioShare( + + /** + * @see {@link CreatePortfolioShareCommand} + */ + createPortfolioShare( args: CreatePortfolioShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPortfolioShare( + createPortfolioShare( args: CreatePortfolioShareCommandInput, cb: (err: any, data?: CreatePortfolioShareCommandOutput) => void ): void; - public createPortfolioShare( + createPortfolioShare( args: CreatePortfolioShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePortfolioShareCommandOutput) => void ): void; - public createPortfolioShare( - args: CreatePortfolioShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePortfolioShareCommandOutput) => void), - cb?: (err: any, data?: CreatePortfolioShareCommandOutput) => void - ): Promise | void { - const command = new CreatePortfolioShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a product.

- *

A delegated admin is authorized to invoke this command.

- *

The user or role that performs this operation must have the - * cloudformation:GetTemplate IAM policy permission. This policy permission is - * required when using the ImportFromPhysicalId template source in the - * information data section.

- */ - public createProduct( - args: CreateProductCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createProduct( - args: CreateProductCommandInput, - cb: (err: any, data?: CreateProductCommandOutput) => void - ): void; - public createProduct( + + /** + * @see {@link CreateProductCommand} + */ + createProduct(args: CreateProductCommandInput, options?: __HttpHandlerOptions): Promise; + createProduct(args: CreateProductCommandInput, cb: (err: any, data?: CreateProductCommandOutput) => void): void; + createProduct( args: CreateProductCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProductCommandOutput) => void ): void; - public createProduct( - args: CreateProductCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProductCommandOutput) => void), - cb?: (err: any, data?: CreateProductCommandOutput) => void - ): Promise | void { - const command = new CreateProductCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a plan.

- *

A plan includes the list of resources to be - * created (when provisioning a new product) or modified (when updating a provisioned product) - * when the plan is executed.

- *

You can create one plan for each provisioned product. To create a plan for an existing - * provisioned product, the product status must be AVAILABLE or TAINTED.

- *

To view the resource changes in the change set, use DescribeProvisionedProductPlan. - * To create or modify the provisioned product, use ExecuteProvisionedProductPlan.

- */ - public createProvisionedProductPlan( + + /** + * @see {@link CreateProvisionedProductPlanCommand} + */ + createProvisionedProductPlan( args: CreateProvisionedProductPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public createProvisionedProductPlan( + createProvisionedProductPlan( args: CreateProvisionedProductPlanCommandInput, cb: (err: any, data?: CreateProvisionedProductPlanCommandOutput) => void ): void; - public createProvisionedProductPlan( + createProvisionedProductPlan( args: CreateProvisionedProductPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProvisionedProductPlanCommandOutput) => void ): void; - public createProvisionedProductPlan( - args: CreateProvisionedProductPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProvisionedProductPlanCommandOutput) => void), - cb?: (err: any, data?: CreateProvisionedProductPlanCommandOutput) => void - ): Promise | void { - const command = new CreateProvisionedProductPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a provisioning artifact (also known as a version) for the specified product.

- *

You cannot create a provisioning artifact for a product that was shared with you.

- *

The user or role that performs this operation must have the cloudformation:GetTemplate - * IAM policy permission. This policy permission is required when using the - * ImportFromPhysicalId template source in the information data section.

- */ - public createProvisioningArtifact( + + /** + * @see {@link CreateProvisioningArtifactCommand} + */ + createProvisioningArtifact( args: CreateProvisioningArtifactCommandInput, options?: __HttpHandlerOptions ): Promise; - public createProvisioningArtifact( + createProvisioningArtifact( args: CreateProvisioningArtifactCommandInput, cb: (err: any, data?: CreateProvisioningArtifactCommandOutput) => void ): void; - public createProvisioningArtifact( + createProvisioningArtifact( args: CreateProvisioningArtifactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProvisioningArtifactCommandOutput) => void ): void; - public createProvisioningArtifact( - args: CreateProvisioningArtifactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProvisioningArtifactCommandOutput) => void), - cb?: (err: any, data?: CreateProvisioningArtifactCommandOutput) => void - ): Promise | void { - const command = new CreateProvisioningArtifactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a self-service action.

- */ - public createServiceAction( + + /** + * @see {@link CreateServiceActionCommand} + */ + createServiceAction( args: CreateServiceActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createServiceAction( + createServiceAction( args: CreateServiceActionCommandInput, cb: (err: any, data?: CreateServiceActionCommandOutput) => void ): void; - public createServiceAction( + createServiceAction( args: CreateServiceActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceActionCommandOutput) => void ): void; - public createServiceAction( - args: CreateServiceActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateServiceActionCommandOutput) => void), - cb?: (err: any, data?: CreateServiceActionCommandOutput) => void - ): Promise | void { - const command = new CreateServiceActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a TagOption.

- */ - public createTagOption( + + /** + * @see {@link CreateTagOptionCommand} + */ + createTagOption( args: CreateTagOptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTagOption( - args: CreateTagOptionCommandInput, - cb: (err: any, data?: CreateTagOptionCommandOutput) => void - ): void; - public createTagOption( + createTagOption(args: CreateTagOptionCommandInput, cb: (err: any, data?: CreateTagOptionCommandOutput) => void): void; + createTagOption( args: CreateTagOptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTagOptionCommandOutput) => void ): void; - public createTagOption( - args: CreateTagOptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTagOptionCommandOutput) => void), - cb?: (err: any, data?: CreateTagOptionCommandOutput) => void - ): Promise | void { - const command = new CreateTagOptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified constraint.

- *

A delegated admin is authorized to invoke this command.

- */ - public deleteConstraint( + + /** + * @see {@link DeleteConstraintCommand} + */ + deleteConstraint( args: DeleteConstraintCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConstraint( + deleteConstraint( args: DeleteConstraintCommandInput, cb: (err: any, data?: DeleteConstraintCommandOutput) => void ): void; - public deleteConstraint( + deleteConstraint( args: DeleteConstraintCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConstraintCommandOutput) => void ): void; - public deleteConstraint( - args: DeleteConstraintCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConstraintCommandOutput) => void), - cb?: (err: any, data?: DeleteConstraintCommandOutput) => void - ): Promise | void { - const command = new DeleteConstraintCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified portfolio.

- *

You cannot delete a portfolio if it was shared with you or if it has associated - * products, users, constraints, or shared accounts.

- *

A delegated admin is authorized to invoke this command.

- */ - public deletePortfolio( + + /** + * @see {@link DeletePortfolioCommand} + */ + deletePortfolio( args: DeletePortfolioCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePortfolio( - args: DeletePortfolioCommandInput, - cb: (err: any, data?: DeletePortfolioCommandOutput) => void - ): void; - public deletePortfolio( + deletePortfolio(args: DeletePortfolioCommandInput, cb: (err: any, data?: DeletePortfolioCommandOutput) => void): void; + deletePortfolio( args: DeletePortfolioCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePortfolioCommandOutput) => void ): void; - public deletePortfolio( - args: DeletePortfolioCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePortfolioCommandOutput) => void), - cb?: (err: any, data?: DeletePortfolioCommandOutput) => void - ): Promise | void { - const command = new DeletePortfolioCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops sharing the specified portfolio with the specified account or organization - * node. Shares to an organization node can only be deleted by the management account of an - * organization or by a delegated administrator.

- *

Note that if a delegated admin is de-registered, portfolio shares created from that account are removed.

- */ - public deletePortfolioShare( + + /** + * @see {@link DeletePortfolioShareCommand} + */ + deletePortfolioShare( args: DeletePortfolioShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePortfolioShare( + deletePortfolioShare( args: DeletePortfolioShareCommandInput, cb: (err: any, data?: DeletePortfolioShareCommandOutput) => void ): void; - public deletePortfolioShare( + deletePortfolioShare( args: DeletePortfolioShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePortfolioShareCommandOutput) => void ): void; - public deletePortfolioShare( - args: DeletePortfolioShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePortfolioShareCommandOutput) => void), - cb?: (err: any, data?: DeletePortfolioShareCommandOutput) => void - ): Promise | void { - const command = new DeletePortfolioShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified product.

- *

You cannot delete a product if it was shared with you or is associated with a portfolio.

- *

A delegated admin is authorized to invoke this command.

- */ - public deleteProduct( - args: DeleteProductCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteProduct( - args: DeleteProductCommandInput, - cb: (err: any, data?: DeleteProductCommandOutput) => void - ): void; - public deleteProduct( + + /** + * @see {@link DeleteProductCommand} + */ + deleteProduct(args: DeleteProductCommandInput, options?: __HttpHandlerOptions): Promise; + deleteProduct(args: DeleteProductCommandInput, cb: (err: any, data?: DeleteProductCommandOutput) => void): void; + deleteProduct( args: DeleteProductCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProductCommandOutput) => void ): void; - public deleteProduct( - args: DeleteProductCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProductCommandOutput) => void), - cb?: (err: any, data?: DeleteProductCommandOutput) => void - ): Promise | void { - const command = new DeleteProductCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified plan.

- */ - public deleteProvisionedProductPlan( + + /** + * @see {@link DeleteProvisionedProductPlanCommand} + */ + deleteProvisionedProductPlan( args: DeleteProvisionedProductPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteProvisionedProductPlan( + deleteProvisionedProductPlan( args: DeleteProvisionedProductPlanCommandInput, cb: (err: any, data?: DeleteProvisionedProductPlanCommandOutput) => void ): void; - public deleteProvisionedProductPlan( + deleteProvisionedProductPlan( args: DeleteProvisionedProductPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProvisionedProductPlanCommandOutput) => void ): void; - public deleteProvisionedProductPlan( - args: DeleteProvisionedProductPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProvisionedProductPlanCommandOutput) => void), - cb?: (err: any, data?: DeleteProvisionedProductPlanCommandOutput) => void - ): Promise | void { - const command = new DeleteProvisionedProductPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified provisioning artifact (also known as a version) for the specified product.

- *

You cannot delete a provisioning artifact associated with a product that was shared with you. - * You cannot delete the last provisioning artifact for a product, because a product must have at - * least one provisioning artifact.

- */ - public deleteProvisioningArtifact( + + /** + * @see {@link DeleteProvisioningArtifactCommand} + */ + deleteProvisioningArtifact( args: DeleteProvisioningArtifactCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteProvisioningArtifact( + deleteProvisioningArtifact( args: DeleteProvisioningArtifactCommandInput, cb: (err: any, data?: DeleteProvisioningArtifactCommandOutput) => void ): void; - public deleteProvisioningArtifact( + deleteProvisioningArtifact( args: DeleteProvisioningArtifactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProvisioningArtifactCommandOutput) => void ): void; - public deleteProvisioningArtifact( - args: DeleteProvisioningArtifactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProvisioningArtifactCommandOutput) => void), - cb?: (err: any, data?: DeleteProvisioningArtifactCommandOutput) => void - ): Promise | void { - const command = new DeleteProvisioningArtifactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a self-service action.

- */ - public deleteServiceAction( + + /** + * @see {@link DeleteServiceActionCommand} + */ + deleteServiceAction( args: DeleteServiceActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteServiceAction( + deleteServiceAction( args: DeleteServiceActionCommandInput, cb: (err: any, data?: DeleteServiceActionCommandOutput) => void ): void; - public deleteServiceAction( + deleteServiceAction( args: DeleteServiceActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceActionCommandOutput) => void ): void; - public deleteServiceAction( - args: DeleteServiceActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteServiceActionCommandOutput) => void), - cb?: (err: any, data?: DeleteServiceActionCommandOutput) => void - ): Promise | void { - const command = new DeleteServiceActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified TagOption.

- *

You cannot delete a TagOption if it is associated with a product or portfolio.

- */ - public deleteTagOption( + + /** + * @see {@link DeleteTagOptionCommand} + */ + deleteTagOption( args: DeleteTagOptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTagOption( - args: DeleteTagOptionCommandInput, - cb: (err: any, data?: DeleteTagOptionCommandOutput) => void - ): void; - public deleteTagOption( + deleteTagOption(args: DeleteTagOptionCommandInput, cb: (err: any, data?: DeleteTagOptionCommandOutput) => void): void; + deleteTagOption( args: DeleteTagOptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTagOptionCommandOutput) => void ): void; - public deleteTagOption( - args: DeleteTagOptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTagOptionCommandOutput) => void), - cb?: (err: any, data?: DeleteTagOptionCommandOutput) => void - ): Promise | void { - const command = new DeleteTagOptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the specified constraint.

- */ - public describeConstraint( + + /** + * @see {@link DescribeConstraintCommand} + */ + describeConstraint( args: DescribeConstraintCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConstraint( + describeConstraint( args: DescribeConstraintCommandInput, cb: (err: any, data?: DescribeConstraintCommandOutput) => void ): void; - public describeConstraint( + describeConstraint( args: DescribeConstraintCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConstraintCommandOutput) => void ): void; - public describeConstraint( - args: DescribeConstraintCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConstraintCommandOutput) => void), - cb?: (err: any, data?: DescribeConstraintCommandOutput) => void - ): Promise | void { - const command = new DescribeConstraintCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the status of the specified copy product operation.

- */ - public describeCopyProductStatus( + + /** + * @see {@link DescribeCopyProductStatusCommand} + */ + describeCopyProductStatus( args: DescribeCopyProductStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCopyProductStatus( + describeCopyProductStatus( args: DescribeCopyProductStatusCommandInput, cb: (err: any, data?: DescribeCopyProductStatusCommandOutput) => void ): void; - public describeCopyProductStatus( + describeCopyProductStatus( args: DescribeCopyProductStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCopyProductStatusCommandOutput) => void ): void; - public describeCopyProductStatus( - args: DescribeCopyProductStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCopyProductStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeCopyProductStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeCopyProductStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the specified portfolio.

- *

A delegated admin is authorized to invoke this command.

- */ - public describePortfolio( + + /** + * @see {@link DescribePortfolioCommand} + */ + describePortfolio( args: DescribePortfolioCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePortfolio( + describePortfolio( args: DescribePortfolioCommandInput, cb: (err: any, data?: DescribePortfolioCommandOutput) => void ): void; - public describePortfolio( + describePortfolio( args: DescribePortfolioCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePortfolioCommandOutput) => void ): void; - public describePortfolio( - args: DescribePortfolioCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePortfolioCommandOutput) => void), - cb?: (err: any, data?: DescribePortfolioCommandOutput) => void - ): Promise | void { - const command = new DescribePortfolioCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a summary of each of the portfolio shares that were created for the specified portfolio.

- *

You can use this API to determine which accounts or organizational nodes this - * portfolio have been shared, whether the recipient entity has imported the share, and - * whether TagOptions are included with the share.

- *

The PortfolioId and Type parameters are both required.

- */ - public describePortfolioShares( + + /** + * @see {@link DescribePortfolioSharesCommand} + */ + describePortfolioShares( args: DescribePortfolioSharesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePortfolioShares( + describePortfolioShares( args: DescribePortfolioSharesCommandInput, cb: (err: any, data?: DescribePortfolioSharesCommandOutput) => void ): void; - public describePortfolioShares( + describePortfolioShares( args: DescribePortfolioSharesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePortfolioSharesCommandOutput) => void ): void; - public describePortfolioShares( - args: DescribePortfolioSharesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePortfolioSharesCommandOutput) => void), - cb?: (err: any, data?: DescribePortfolioSharesCommandOutput) => void - ): Promise | void { - const command = new DescribePortfolioSharesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the status of the specified portfolio share operation. This API can only be called - * by the management account in the organization or by a delegated admin.

- */ - public describePortfolioShareStatus( + + /** + * @see {@link DescribePortfolioShareStatusCommand} + */ + describePortfolioShareStatus( args: DescribePortfolioShareStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePortfolioShareStatus( + describePortfolioShareStatus( args: DescribePortfolioShareStatusCommandInput, cb: (err: any, data?: DescribePortfolioShareStatusCommandOutput) => void ): void; - public describePortfolioShareStatus( + describePortfolioShareStatus( args: DescribePortfolioShareStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePortfolioShareStatusCommandOutput) => void ): void; - public describePortfolioShareStatus( - args: DescribePortfolioShareStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePortfolioShareStatusCommandOutput) => void), - cb?: (err: any, data?: DescribePortfolioShareStatusCommandOutput) => void - ): Promise | void { - const command = new DescribePortfolioShareStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the specified product.

- * - *

- * Running this operation - * with administrator access - * results - * in a failure. - * DescribeProductAsAdmin should be used instead. - *

- *
- */ - public describeProduct( + + /** + * @see {@link DescribeProductCommand} + */ + describeProduct( args: DescribeProductCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProduct( - args: DescribeProductCommandInput, - cb: (err: any, data?: DescribeProductCommandOutput) => void - ): void; - public describeProduct( + describeProduct(args: DescribeProductCommandInput, cb: (err: any, data?: DescribeProductCommandOutput) => void): void; + describeProduct( args: DescribeProductCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProductCommandOutput) => void ): void; - public describeProduct( - args: DescribeProductCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProductCommandOutput) => void), - cb?: (err: any, data?: DescribeProductCommandOutput) => void - ): Promise | void { - const command = new DescribeProductCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the specified product. This operation is run with administrator access.

- */ - public describeProductAsAdmin( + + /** + * @see {@link DescribeProductAsAdminCommand} + */ + describeProductAsAdmin( args: DescribeProductAsAdminCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProductAsAdmin( + describeProductAsAdmin( args: DescribeProductAsAdminCommandInput, cb: (err: any, data?: DescribeProductAsAdminCommandOutput) => void ): void; - public describeProductAsAdmin( + describeProductAsAdmin( args: DescribeProductAsAdminCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProductAsAdminCommandOutput) => void ): void; - public describeProductAsAdmin( - args: DescribeProductAsAdminCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProductAsAdminCommandOutput) => void), - cb?: (err: any, data?: DescribeProductAsAdminCommandOutput) => void - ): Promise | void { - const command = new DescribeProductAsAdminCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the specified product.

- */ - public describeProductView( + + /** + * @see {@link DescribeProductViewCommand} + */ + describeProductView( args: DescribeProductViewCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProductView( + describeProductView( args: DescribeProductViewCommandInput, cb: (err: any, data?: DescribeProductViewCommandOutput) => void ): void; - public describeProductView( + describeProductView( args: DescribeProductViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProductViewCommandOutput) => void ): void; - public describeProductView( - args: DescribeProductViewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProductViewCommandOutput) => void), - cb?: (err: any, data?: DescribeProductViewCommandOutput) => void - ): Promise | void { - const command = new DescribeProductViewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the specified provisioned product.

- */ - public describeProvisionedProduct( + + /** + * @see {@link DescribeProvisionedProductCommand} + */ + describeProvisionedProduct( args: DescribeProvisionedProductCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProvisionedProduct( + describeProvisionedProduct( args: DescribeProvisionedProductCommandInput, cb: (err: any, data?: DescribeProvisionedProductCommandOutput) => void ): void; - public describeProvisionedProduct( + describeProvisionedProduct( args: DescribeProvisionedProductCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProvisionedProductCommandOutput) => void ): void; - public describeProvisionedProduct( - args: DescribeProvisionedProductCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProvisionedProductCommandOutput) => void), - cb?: (err: any, data?: DescribeProvisionedProductCommandOutput) => void - ): Promise | void { - const command = new DescribeProvisionedProductCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the resource changes for the specified plan.

- */ - public describeProvisionedProductPlan( + + /** + * @see {@link DescribeProvisionedProductPlanCommand} + */ + describeProvisionedProductPlan( args: DescribeProvisionedProductPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProvisionedProductPlan( + describeProvisionedProductPlan( args: DescribeProvisionedProductPlanCommandInput, cb: (err: any, data?: DescribeProvisionedProductPlanCommandOutput) => void ): void; - public describeProvisionedProductPlan( + describeProvisionedProductPlan( args: DescribeProvisionedProductPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProvisionedProductPlanCommandOutput) => void ): void; - public describeProvisionedProductPlan( - args: DescribeProvisionedProductPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProvisionedProductPlanCommandOutput) => void), - cb?: (err: any, data?: DescribeProvisionedProductPlanCommandOutput) => void - ): Promise | void { - const command = new DescribeProvisionedProductPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the specified provisioning artifact (also known as a version) for the specified product.

- */ - public describeProvisioningArtifact( + + /** + * @see {@link DescribeProvisioningArtifactCommand} + */ + describeProvisioningArtifact( args: DescribeProvisioningArtifactCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProvisioningArtifact( + describeProvisioningArtifact( args: DescribeProvisioningArtifactCommandInput, cb: (err: any, data?: DescribeProvisioningArtifactCommandOutput) => void ): void; - public describeProvisioningArtifact( + describeProvisioningArtifact( args: DescribeProvisioningArtifactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProvisioningArtifactCommandOutput) => void ): void; - public describeProvisioningArtifact( - args: DescribeProvisioningArtifactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProvisioningArtifactCommandOutput) => void), - cb?: (err: any, data?: DescribeProvisioningArtifactCommandOutput) => void - ): Promise | void { - const command = new DescribeProvisioningArtifactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the configuration required to provision the specified product using - * the specified provisioning artifact.

- *

If the output contains a TagOption key with an empty list of values, there is a - * TagOption conflict for that key. The end user cannot take action to fix the conflict, and - * launch is not blocked. In subsequent calls to ProvisionProduct, - * do not include conflicted TagOption keys as tags, or this causes the error - * "Parameter validation failed: Missing required parameter in Tags[N]:Value". - * Tag the provisioned product with the value sc-tagoption-conflict-portfolioId-productId.

- */ - public describeProvisioningParameters( + + /** + * @see {@link DescribeProvisioningParametersCommand} + */ + describeProvisioningParameters( args: DescribeProvisioningParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProvisioningParameters( + describeProvisioningParameters( args: DescribeProvisioningParametersCommandInput, cb: (err: any, data?: DescribeProvisioningParametersCommandOutput) => void ): void; - public describeProvisioningParameters( + describeProvisioningParameters( args: DescribeProvisioningParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProvisioningParametersCommandOutput) => void ): void; - public describeProvisioningParameters( - args: DescribeProvisioningParametersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProvisioningParametersCommandOutput) => void), - cb?: (err: any, data?: DescribeProvisioningParametersCommandOutput) => void - ): Promise | void { - const command = new DescribeProvisioningParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the specified request operation.

- *

Use this operation after calling a request operation (for example, ProvisionProduct, - * TerminateProvisionedProduct, or UpdateProvisionedProduct). - *

- * - *

If a provisioned product was transferred to a new owner using UpdateProvisionedProductProperties, the new owner - * will be able to describe all past records for that product. The previous owner will no longer be able to describe the records, but will be able to - * use ListRecordHistory to see the product's history from when he was the owner.

- *
- */ - public describeRecord( + + /** + * @see {@link DescribeRecordCommand} + */ + describeRecord( args: DescribeRecordCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRecord( - args: DescribeRecordCommandInput, - cb: (err: any, data?: DescribeRecordCommandOutput) => void - ): void; - public describeRecord( + describeRecord(args: DescribeRecordCommandInput, cb: (err: any, data?: DescribeRecordCommandOutput) => void): void; + describeRecord( args: DescribeRecordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRecordCommandOutput) => void ): void; - public describeRecord( - args: DescribeRecordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRecordCommandOutput) => void), - cb?: (err: any, data?: DescribeRecordCommandOutput) => void - ): Promise | void { - const command = new DescribeRecordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a self-service action.

- */ - public describeServiceAction( + + /** + * @see {@link DescribeServiceActionCommand} + */ + describeServiceAction( args: DescribeServiceActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeServiceAction( + describeServiceAction( args: DescribeServiceActionCommandInput, cb: (err: any, data?: DescribeServiceActionCommandOutput) => void ): void; - public describeServiceAction( + describeServiceAction( args: DescribeServiceActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeServiceActionCommandOutput) => void ): void; - public describeServiceAction( - args: DescribeServiceActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeServiceActionCommandOutput) => void), - cb?: (err: any, data?: DescribeServiceActionCommandOutput) => void - ): Promise | void { - const command = new DescribeServiceActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.

- */ - public describeServiceActionExecutionParameters( + + /** + * @see {@link DescribeServiceActionExecutionParametersCommand} + */ + describeServiceActionExecutionParameters( args: DescribeServiceActionExecutionParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeServiceActionExecutionParameters( + describeServiceActionExecutionParameters( args: DescribeServiceActionExecutionParametersCommandInput, cb: (err: any, data?: DescribeServiceActionExecutionParametersCommandOutput) => void ): void; - public describeServiceActionExecutionParameters( + describeServiceActionExecutionParameters( args: DescribeServiceActionExecutionParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeServiceActionExecutionParametersCommandOutput) => void ): void; - public describeServiceActionExecutionParameters( - args: DescribeServiceActionExecutionParametersCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeServiceActionExecutionParametersCommandOutput) => void), - cb?: (err: any, data?: DescribeServiceActionExecutionParametersCommandOutput) => void - ): Promise | void { - const command = new DescribeServiceActionExecutionParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the specified TagOption.

- */ - public describeTagOption( + + /** + * @see {@link DescribeTagOptionCommand} + */ + describeTagOption( args: DescribeTagOptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTagOption( + describeTagOption( args: DescribeTagOptionCommandInput, cb: (err: any, data?: DescribeTagOptionCommandOutput) => void ): void; - public describeTagOption( + describeTagOption( args: DescribeTagOptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTagOptionCommandOutput) => void ): void; - public describeTagOption( - args: DescribeTagOptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTagOptionCommandOutput) => void), - cb?: (err: any, data?: DescribeTagOptionCommandOutput) => void - ): Promise | void { - const command = new DescribeTagOptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disable portfolio sharing through the Organizations service. This command will not - * delete your current shares, but prevents you from creating new shares throughout your - * organization. Current shares are not kept in sync with your organization structure if the structure - * changes after calling this API. Only the management account in the organization can call this API.

- *

You cannot call this API if there are active delegated administrators in the organization.

- *

Note that a delegated administrator is not authorized to invoke DisableAWSOrganizationsAccess.

- * - *

If you share an Service Catalog portfolio in an organization within - * Organizations, and then disable Organizations access for Service Catalog, - * the portfolio access permissions will not sync with the latest changes to the organization - * structure. Specifically, accounts that you removed from the organization after - * disabling Service Catalog access will retain access to the previously shared portfolio.

- *
- */ - public disableAWSOrganizationsAccess( + + /** + * @see {@link DisableAWSOrganizationsAccessCommand} + */ + disableAWSOrganizationsAccess( args: DisableAWSOrganizationsAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableAWSOrganizationsAccess( + disableAWSOrganizationsAccess( args: DisableAWSOrganizationsAccessCommandInput, cb: (err: any, data?: DisableAWSOrganizationsAccessCommandOutput) => void ): void; - public disableAWSOrganizationsAccess( + disableAWSOrganizationsAccess( args: DisableAWSOrganizationsAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableAWSOrganizationsAccessCommandOutput) => void ): void; - public disableAWSOrganizationsAccess( - args: DisableAWSOrganizationsAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableAWSOrganizationsAccessCommandOutput) => void), - cb?: (err: any, data?: DisableAWSOrganizationsAccessCommandOutput) => void - ): Promise | void { - const command = new DisableAWSOrganizationsAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates the specified budget from the specified resource.

- */ - public disassociateBudgetFromResource( + + /** + * @see {@link DisassociateBudgetFromResourceCommand} + */ + disassociateBudgetFromResource( args: DisassociateBudgetFromResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateBudgetFromResource( + disassociateBudgetFromResource( args: DisassociateBudgetFromResourceCommandInput, cb: (err: any, data?: DisassociateBudgetFromResourceCommandOutput) => void ): void; - public disassociateBudgetFromResource( + disassociateBudgetFromResource( args: DisassociateBudgetFromResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateBudgetFromResourceCommandOutput) => void ): void; - public disassociateBudgetFromResource( - args: DisassociateBudgetFromResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateBudgetFromResourceCommandOutput) => void), - cb?: (err: any, data?: DisassociateBudgetFromResourceCommandOutput) => void - ): Promise | void { - const command = new DisassociateBudgetFromResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a previously associated principal ARN from a specified - * portfolio.

- *

The PrincipalType and PrincipalARN must match the - * AssociatePrincipalWithPortfolio call request details. For example, - * to disassociate an association created with a PrincipalARN of PrincipalType - * IAM you must use the PrincipalType IAM when calling DisassociatePrincipalFromPortfolio.

- *

For portfolios that have been shared with principal name sharing enabled: after disassociating a principal, - * share recipient accounts will no longer be able to provision products in this portfolio using a role matching the name - * of the associated principal.

- */ - public disassociatePrincipalFromPortfolio( + + /** + * @see {@link DisassociatePrincipalFromPortfolioCommand} + */ + disassociatePrincipalFromPortfolio( args: DisassociatePrincipalFromPortfolioCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociatePrincipalFromPortfolio( + disassociatePrincipalFromPortfolio( args: DisassociatePrincipalFromPortfolioCommandInput, cb: (err: any, data?: DisassociatePrincipalFromPortfolioCommandOutput) => void ): void; - public disassociatePrincipalFromPortfolio( + disassociatePrincipalFromPortfolio( args: DisassociatePrincipalFromPortfolioCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociatePrincipalFromPortfolioCommandOutput) => void ): void; - public disassociatePrincipalFromPortfolio( - args: DisassociatePrincipalFromPortfolioCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociatePrincipalFromPortfolioCommandOutput) => void), - cb?: (err: any, data?: DisassociatePrincipalFromPortfolioCommandOutput) => void - ): Promise | void { - const command = new DisassociatePrincipalFromPortfolioCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates the specified product from the specified portfolio.

- *

A delegated admin is authorized to invoke this command.

- */ - public disassociateProductFromPortfolio( + + /** + * @see {@link DisassociateProductFromPortfolioCommand} + */ + disassociateProductFromPortfolio( args: DisassociateProductFromPortfolioCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateProductFromPortfolio( + disassociateProductFromPortfolio( args: DisassociateProductFromPortfolioCommandInput, cb: (err: any, data?: DisassociateProductFromPortfolioCommandOutput) => void ): void; - public disassociateProductFromPortfolio( + disassociateProductFromPortfolio( args: DisassociateProductFromPortfolioCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateProductFromPortfolioCommandOutput) => void ): void; - public disassociateProductFromPortfolio( - args: DisassociateProductFromPortfolioCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateProductFromPortfolioCommandOutput) => void), - cb?: (err: any, data?: DisassociateProductFromPortfolioCommandOutput) => void - ): Promise | void { - const command = new DisassociateProductFromPortfolioCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates the specified self-service action association from the specified provisioning artifact.

- */ - public disassociateServiceActionFromProvisioningArtifact( + + /** + * @see {@link DisassociateServiceActionFromProvisioningArtifactCommand} + */ + disassociateServiceActionFromProvisioningArtifact( args: DisassociateServiceActionFromProvisioningArtifactCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateServiceActionFromProvisioningArtifact( + disassociateServiceActionFromProvisioningArtifact( args: DisassociateServiceActionFromProvisioningArtifactCommandInput, cb: (err: any, data?: DisassociateServiceActionFromProvisioningArtifactCommandOutput) => void ): void; - public disassociateServiceActionFromProvisioningArtifact( + disassociateServiceActionFromProvisioningArtifact( args: DisassociateServiceActionFromProvisioningArtifactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateServiceActionFromProvisioningArtifactCommandOutput) => void ): void; - public disassociateServiceActionFromProvisioningArtifact( - args: DisassociateServiceActionFromProvisioningArtifactCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociateServiceActionFromProvisioningArtifactCommandOutput) => void), - cb?: (err: any, data?: DisassociateServiceActionFromProvisioningArtifactCommandOutput) => void - ): Promise | void { - const command = new DisassociateServiceActionFromProvisioningArtifactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates the specified TagOption from the specified resource.

- */ - public disassociateTagOptionFromResource( + + /** + * @see {@link DisassociateTagOptionFromResourceCommand} + */ + disassociateTagOptionFromResource( args: DisassociateTagOptionFromResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateTagOptionFromResource( + disassociateTagOptionFromResource( args: DisassociateTagOptionFromResourceCommandInput, cb: (err: any, data?: DisassociateTagOptionFromResourceCommandOutput) => void ): void; - public disassociateTagOptionFromResource( + disassociateTagOptionFromResource( args: DisassociateTagOptionFromResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateTagOptionFromResourceCommandOutput) => void ): void; - public disassociateTagOptionFromResource( - args: DisassociateTagOptionFromResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateTagOptionFromResourceCommandOutput) => void), - cb?: (err: any, data?: DisassociateTagOptionFromResourceCommandOutput) => void - ): Promise | void { - const command = new DisassociateTagOptionFromResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enable portfolio sharing feature through Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your shares with the - * current structure. This API can only be called by the management account in the organization.

- *

When you call this API, Service Catalog calls organizations:EnableAWSServiceAccess on your behalf so that your shares stay in sync with any changes in your Organizations structure.

- *

Note that a delegated administrator is not authorized to invoke EnableAWSOrganizationsAccess.

- * - *

If you have previously disabled Organizations access for Service Catalog, and then - * enable access again, the portfolio access permissions might not sync with the latest changes to - * the organization structure. Specifically, accounts that you removed from the organization after - * disabling Service Catalog access, and before you enabled access again, can retain access to the - * previously shared portfolio. As a result, an account that has been removed from the organization - * might still be able to create or manage Amazon Web Services resources when it is no longer - * authorized to do so. Amazon Web Services is working to resolve this issue.

- *
- */ - public enableAWSOrganizationsAccess( + + /** + * @see {@link EnableAWSOrganizationsAccessCommand} + */ + enableAWSOrganizationsAccess( args: EnableAWSOrganizationsAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableAWSOrganizationsAccess( + enableAWSOrganizationsAccess( args: EnableAWSOrganizationsAccessCommandInput, cb: (err: any, data?: EnableAWSOrganizationsAccessCommandOutput) => void ): void; - public enableAWSOrganizationsAccess( + enableAWSOrganizationsAccess( args: EnableAWSOrganizationsAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableAWSOrganizationsAccessCommandOutput) => void ): void; - public enableAWSOrganizationsAccess( - args: EnableAWSOrganizationsAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableAWSOrganizationsAccessCommandOutput) => void), - cb?: (err: any, data?: EnableAWSOrganizationsAccessCommandOutput) => void - ): Promise | void { - const command = new EnableAWSOrganizationsAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provisions or modifies a product based on the resource changes for the specified plan.

- */ - public executeProvisionedProductPlan( + + /** + * @see {@link ExecuteProvisionedProductPlanCommand} + */ + executeProvisionedProductPlan( args: ExecuteProvisionedProductPlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public executeProvisionedProductPlan( + executeProvisionedProductPlan( args: ExecuteProvisionedProductPlanCommandInput, cb: (err: any, data?: ExecuteProvisionedProductPlanCommandOutput) => void ): void; - public executeProvisionedProductPlan( + executeProvisionedProductPlan( args: ExecuteProvisionedProductPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteProvisionedProductPlanCommandOutput) => void ): void; - public executeProvisionedProductPlan( - args: ExecuteProvisionedProductPlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExecuteProvisionedProductPlanCommandOutput) => void), - cb?: (err: any, data?: ExecuteProvisionedProductPlanCommandOutput) => void - ): Promise | void { - const command = new ExecuteProvisionedProductPlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Executes a self-service action against a provisioned product.

- */ - public executeProvisionedProductServiceAction( + + /** + * @see {@link ExecuteProvisionedProductServiceActionCommand} + */ + executeProvisionedProductServiceAction( args: ExecuteProvisionedProductServiceActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public executeProvisionedProductServiceAction( + executeProvisionedProductServiceAction( args: ExecuteProvisionedProductServiceActionCommandInput, cb: (err: any, data?: ExecuteProvisionedProductServiceActionCommandOutput) => void ): void; - public executeProvisionedProductServiceAction( + executeProvisionedProductServiceAction( args: ExecuteProvisionedProductServiceActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteProvisionedProductServiceActionCommandOutput) => void ): void; - public executeProvisionedProductServiceAction( - args: ExecuteProvisionedProductServiceActionCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ExecuteProvisionedProductServiceActionCommandOutput) => void), - cb?: (err: any, data?: ExecuteProvisionedProductServiceActionCommandOutput) => void - ): Promise | void { - const command = new ExecuteProvisionedProductServiceActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get the Access Status for Organizations portfolio share feature. This API can only be - * called by the management account in the organization or by a delegated admin.

- */ - public getAWSOrganizationsAccessStatus( + + /** + * @see {@link GetAWSOrganizationsAccessStatusCommand} + */ + getAWSOrganizationsAccessStatus( args: GetAWSOrganizationsAccessStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAWSOrganizationsAccessStatus( + getAWSOrganizationsAccessStatus( args: GetAWSOrganizationsAccessStatusCommandInput, cb: (err: any, data?: GetAWSOrganizationsAccessStatusCommandOutput) => void ): void; - public getAWSOrganizationsAccessStatus( + getAWSOrganizationsAccessStatus( args: GetAWSOrganizationsAccessStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAWSOrganizationsAccessStatusCommandOutput) => void ): void; - public getAWSOrganizationsAccessStatus( - args: GetAWSOrganizationsAccessStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAWSOrganizationsAccessStatusCommandOutput) => void), - cb?: (err: any, data?: GetAWSOrganizationsAccessStatusCommandOutput) => void - ): Promise | void { - const command = new GetAWSOrganizationsAccessStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

This API takes either a ProvisonedProductId or a ProvisionedProductName, along with a list of one or more output keys, and responds with the key/value pairs of those outputs.

- */ - public getProvisionedProductOutputs( + + /** + * @see {@link GetProvisionedProductOutputsCommand} + */ + getProvisionedProductOutputs( args: GetProvisionedProductOutputsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getProvisionedProductOutputs( + getProvisionedProductOutputs( args: GetProvisionedProductOutputsCommandInput, cb: (err: any, data?: GetProvisionedProductOutputsCommandOutput) => void ): void; - public getProvisionedProductOutputs( + getProvisionedProductOutputs( args: GetProvisionedProductOutputsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProvisionedProductOutputsCommandOutput) => void ): void; - public getProvisionedProductOutputs( - args: GetProvisionedProductOutputsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetProvisionedProductOutputsCommandOutput) => void), - cb?: (err: any, data?: GetProvisionedProductOutputsCommandOutput) => void - ): Promise | void { - const command = new GetProvisionedProductOutputsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Requests the import - * of a resource - * as an Service Catalog provisioned product - * that is associated - * to an Service Catalog product and provisioning artifact. - * Once imported, - * all supported governance actions are supported - * on the provisioned product. - *

- *

- * Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets, and non-root nested stacks are not supported. - *

- *

- * The CloudFormation stack must have one - * of the following statuses - * to be imported: CREATE_COMPLETE, UPDATE_COMPLETE, UPDATE_ROLLBACK_COMPLETE, IMPORT_COMPLETE, and IMPORT_ROLLBACK_COMPLETE. - *

- *

- * Import - * of the resource requires - * that the CloudFormation stack template matches the associated Service Catalog product provisioning artifact. - *

- * - *

- * When you import an existing CloudFormation stack - * into a portfolio, - * constraints - * that are associated - * with the product - * aren't applied - * during the import process. - * The constraints are applied - * after you call UpdateProvisionedProduct - * for the provisioned product. - *

- *
- *

- * The user or role - * that performs this operation - * must have the cloudformation:GetTemplate and cloudformation:DescribeStacks IAM policy permissions. - *

- */ - public importAsProvisionedProduct( + + /** + * @see {@link ImportAsProvisionedProductCommand} + */ + importAsProvisionedProduct( args: ImportAsProvisionedProductCommandInput, options?: __HttpHandlerOptions ): Promise; - public importAsProvisionedProduct( + importAsProvisionedProduct( args: ImportAsProvisionedProductCommandInput, cb: (err: any, data?: ImportAsProvisionedProductCommandOutput) => void ): void; - public importAsProvisionedProduct( + importAsProvisionedProduct( args: ImportAsProvisionedProductCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportAsProvisionedProductCommandOutput) => void ): void; - public importAsProvisionedProduct( - args: ImportAsProvisionedProductCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportAsProvisionedProductCommandOutput) => void), - cb?: (err: any, data?: ImportAsProvisionedProductCommandOutput) => void - ): Promise | void { - const command = new ImportAsProvisionedProductCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all imported portfolios for which account-to-account shares were accepted by - * this account. By specifying the PortfolioShareType, you can list portfolios for which - * organizational shares were accepted by this account.

- */ - public listAcceptedPortfolioShares( + + /** + * @see {@link ListAcceptedPortfolioSharesCommand} + */ + listAcceptedPortfolioShares( args: ListAcceptedPortfolioSharesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAcceptedPortfolioShares( + listAcceptedPortfolioShares( args: ListAcceptedPortfolioSharesCommandInput, cb: (err: any, data?: ListAcceptedPortfolioSharesCommandOutput) => void ): void; - public listAcceptedPortfolioShares( + listAcceptedPortfolioShares( args: ListAcceptedPortfolioSharesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAcceptedPortfolioSharesCommandOutput) => void ): void; - public listAcceptedPortfolioShares( - args: ListAcceptedPortfolioSharesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAcceptedPortfolioSharesCommandOutput) => void), - cb?: (err: any, data?: ListAcceptedPortfolioSharesCommandOutput) => void - ): Promise | void { - const command = new ListAcceptedPortfolioSharesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all the budgets associated to the specified resource.

- */ - public listBudgetsForResource( + + /** + * @see {@link ListBudgetsForResourceCommand} + */ + listBudgetsForResource( args: ListBudgetsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBudgetsForResource( + listBudgetsForResource( args: ListBudgetsForResourceCommandInput, cb: (err: any, data?: ListBudgetsForResourceCommandOutput) => void ): void; - public listBudgetsForResource( + listBudgetsForResource( args: ListBudgetsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBudgetsForResourceCommandOutput) => void ): void; - public listBudgetsForResource( - args: ListBudgetsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBudgetsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListBudgetsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListBudgetsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the constraints for the specified portfolio and product.

- */ - public listConstraintsForPortfolio( + + /** + * @see {@link ListConstraintsForPortfolioCommand} + */ + listConstraintsForPortfolio( args: ListConstraintsForPortfolioCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConstraintsForPortfolio( + listConstraintsForPortfolio( args: ListConstraintsForPortfolioCommandInput, cb: (err: any, data?: ListConstraintsForPortfolioCommandOutput) => void ): void; - public listConstraintsForPortfolio( + listConstraintsForPortfolio( args: ListConstraintsForPortfolioCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConstraintsForPortfolioCommandOutput) => void ): void; - public listConstraintsForPortfolio( - args: ListConstraintsForPortfolioCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConstraintsForPortfolioCommandOutput) => void), - cb?: (err: any, data?: ListConstraintsForPortfolioCommandOutput) => void - ): Promise | void { - const command = new ListConstraintsForPortfolioCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Lists the paths - * to the specified product. - * A path describes - * how the user - * gets access - * to a specified product - * and is necessary - * when provisioning a product. - * A path also determines the constraints - * that are put on a product. - * A path is dependent - * on a specific product, porfolio, and principal. - *

- * - *

- * When provisioning a product - * that's been added - * to a portfolio, - * you must grant your user, group, or role access - * to the portfolio. - * For more information, - * see Granting users access - * in the Service Catalog User Guide. - *

- *
- */ - public listLaunchPaths( + + /** + * @see {@link ListLaunchPathsCommand} + */ + listLaunchPaths( args: ListLaunchPathsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLaunchPaths( - args: ListLaunchPathsCommandInput, - cb: (err: any, data?: ListLaunchPathsCommandOutput) => void - ): void; - public listLaunchPaths( + listLaunchPaths(args: ListLaunchPathsCommandInput, cb: (err: any, data?: ListLaunchPathsCommandOutput) => void): void; + listLaunchPaths( args: ListLaunchPathsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLaunchPathsCommandOutput) => void ): void; - public listLaunchPaths( - args: ListLaunchPathsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLaunchPathsCommandOutput) => void), - cb?: (err: any, data?: ListLaunchPathsCommandOutput) => void - ): Promise | void { - const command = new ListLaunchPathsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the organization nodes that have access to the specified portfolio. This API can - * only be called by the management account in the organization or by a delegated - * admin.

- *

If a delegated admin is de-registered, they can no longer perform this operation.

- */ - public listOrganizationPortfolioAccess( + + /** + * @see {@link ListOrganizationPortfolioAccessCommand} + */ + listOrganizationPortfolioAccess( args: ListOrganizationPortfolioAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOrganizationPortfolioAccess( + listOrganizationPortfolioAccess( args: ListOrganizationPortfolioAccessCommandInput, cb: (err: any, data?: ListOrganizationPortfolioAccessCommandOutput) => void ): void; - public listOrganizationPortfolioAccess( + listOrganizationPortfolioAccess( args: ListOrganizationPortfolioAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOrganizationPortfolioAccessCommandOutput) => void ): void; - public listOrganizationPortfolioAccess( - args: ListOrganizationPortfolioAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOrganizationPortfolioAccessCommandOutput) => void), - cb?: (err: any, data?: ListOrganizationPortfolioAccessCommandOutput) => void - ): Promise | void { - const command = new ListOrganizationPortfolioAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the account IDs that have access to the specified portfolio.

- *

A delegated admin can list the accounts that have access to the shared portfolio. Note that if a delegated admin is de-registered, they can no longer perform this operation.

- */ - public listPortfolioAccess( + + /** + * @see {@link ListPortfolioAccessCommand} + */ + listPortfolioAccess( args: ListPortfolioAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPortfolioAccess( + listPortfolioAccess( args: ListPortfolioAccessCommandInput, cb: (err: any, data?: ListPortfolioAccessCommandOutput) => void ): void; - public listPortfolioAccess( + listPortfolioAccess( args: ListPortfolioAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPortfolioAccessCommandOutput) => void ): void; - public listPortfolioAccess( - args: ListPortfolioAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPortfolioAccessCommandOutput) => void), - cb?: (err: any, data?: ListPortfolioAccessCommandOutput) => void - ): Promise | void { - const command = new ListPortfolioAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all portfolios in the catalog.

- */ - public listPortfolios( + + /** + * @see {@link ListPortfoliosCommand} + */ + listPortfolios( args: ListPortfoliosCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPortfolios( - args: ListPortfoliosCommandInput, - cb: (err: any, data?: ListPortfoliosCommandOutput) => void - ): void; - public listPortfolios( + listPortfolios(args: ListPortfoliosCommandInput, cb: (err: any, data?: ListPortfoliosCommandOutput) => void): void; + listPortfolios( args: ListPortfoliosCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPortfoliosCommandOutput) => void ): void; - public listPortfolios( - args: ListPortfoliosCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPortfoliosCommandOutput) => void), - cb?: (err: any, data?: ListPortfoliosCommandOutput) => void - ): Promise | void { - const command = new ListPortfoliosCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all portfolios that the specified product is associated with.

- */ - public listPortfoliosForProduct( + + /** + * @see {@link ListPortfoliosForProductCommand} + */ + listPortfoliosForProduct( args: ListPortfoliosForProductCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPortfoliosForProduct( + listPortfoliosForProduct( args: ListPortfoliosForProductCommandInput, cb: (err: any, data?: ListPortfoliosForProductCommandOutput) => void ): void; - public listPortfoliosForProduct( + listPortfoliosForProduct( args: ListPortfoliosForProductCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPortfoliosForProductCommandOutput) => void ): void; - public listPortfoliosForProduct( - args: ListPortfoliosForProductCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPortfoliosForProductCommandOutput) => void), - cb?: (err: any, data?: ListPortfoliosForProductCommandOutput) => void - ): Promise | void { - const command = new ListPortfoliosForProductCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all PrincipalARNs and corresponding PrincipalTypes associated with the specified portfolio.

- */ - public listPrincipalsForPortfolio( + + /** + * @see {@link ListPrincipalsForPortfolioCommand} + */ + listPrincipalsForPortfolio( args: ListPrincipalsForPortfolioCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPrincipalsForPortfolio( + listPrincipalsForPortfolio( args: ListPrincipalsForPortfolioCommandInput, cb: (err: any, data?: ListPrincipalsForPortfolioCommandOutput) => void ): void; - public listPrincipalsForPortfolio( + listPrincipalsForPortfolio( args: ListPrincipalsForPortfolioCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPrincipalsForPortfolioCommandOutput) => void ): void; - public listPrincipalsForPortfolio( - args: ListPrincipalsForPortfolioCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPrincipalsForPortfolioCommandOutput) => void), - cb?: (err: any, data?: ListPrincipalsForPortfolioCommandOutput) => void - ): Promise | void { - const command = new ListPrincipalsForPortfolioCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the plans for the specified provisioned product or all plans to which the user has access.

- */ - public listProvisionedProductPlans( + + /** + * @see {@link ListProvisionedProductPlansCommand} + */ + listProvisionedProductPlans( args: ListProvisionedProductPlansCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProvisionedProductPlans( + listProvisionedProductPlans( args: ListProvisionedProductPlansCommandInput, cb: (err: any, data?: ListProvisionedProductPlansCommandOutput) => void ): void; - public listProvisionedProductPlans( + listProvisionedProductPlans( args: ListProvisionedProductPlansCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProvisionedProductPlansCommandOutput) => void ): void; - public listProvisionedProductPlans( - args: ListProvisionedProductPlansCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProvisionedProductPlansCommandOutput) => void), - cb?: (err: any, data?: ListProvisionedProductPlansCommandOutput) => void - ): Promise | void { - const command = new ListProvisionedProductPlansCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all provisioning artifacts (also known as versions) for the specified product.

- */ - public listProvisioningArtifacts( + + /** + * @see {@link ListProvisioningArtifactsCommand} + */ + listProvisioningArtifacts( args: ListProvisioningArtifactsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProvisioningArtifacts( + listProvisioningArtifacts( args: ListProvisioningArtifactsCommandInput, cb: (err: any, data?: ListProvisioningArtifactsCommandOutput) => void ): void; - public listProvisioningArtifacts( + listProvisioningArtifacts( args: ListProvisioningArtifactsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProvisioningArtifactsCommandOutput) => void ): void; - public listProvisioningArtifacts( - args: ListProvisioningArtifactsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProvisioningArtifactsCommandOutput) => void), - cb?: (err: any, data?: ListProvisioningArtifactsCommandOutput) => void - ): Promise | void { - const command = new ListProvisioningArtifactsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all provisioning artifacts (also known as versions) for the specified self-service action.

- */ - public listProvisioningArtifactsForServiceAction( + + /** + * @see {@link ListProvisioningArtifactsForServiceActionCommand} + */ + listProvisioningArtifactsForServiceAction( args: ListProvisioningArtifactsForServiceActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProvisioningArtifactsForServiceAction( + listProvisioningArtifactsForServiceAction( args: ListProvisioningArtifactsForServiceActionCommandInput, cb: (err: any, data?: ListProvisioningArtifactsForServiceActionCommandOutput) => void ): void; - public listProvisioningArtifactsForServiceAction( + listProvisioningArtifactsForServiceAction( args: ListProvisioningArtifactsForServiceActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProvisioningArtifactsForServiceActionCommandOutput) => void ): void; - public listProvisioningArtifactsForServiceAction( - args: ListProvisioningArtifactsForServiceActionCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListProvisioningArtifactsForServiceActionCommandOutput) => void), - cb?: (err: any, data?: ListProvisioningArtifactsForServiceActionCommandOutput) => void - ): Promise | void { - const command = new ListProvisioningArtifactsForServiceActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the specified requests or all performed requests.

- */ - public listRecordHistory( + + /** + * @see {@link ListRecordHistoryCommand} + */ + listRecordHistory( args: ListRecordHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRecordHistory( + listRecordHistory( args: ListRecordHistoryCommandInput, cb: (err: any, data?: ListRecordHistoryCommandOutput) => void ): void; - public listRecordHistory( + listRecordHistory( args: ListRecordHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecordHistoryCommandOutput) => void ): void; - public listRecordHistory( - args: ListRecordHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRecordHistoryCommandOutput) => void), - cb?: (err: any, data?: ListRecordHistoryCommandOutput) => void - ): Promise | void { - const command = new ListRecordHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the resources associated with the specified TagOption.

- */ - public listResourcesForTagOption( + + /** + * @see {@link ListResourcesForTagOptionCommand} + */ + listResourcesForTagOption( args: ListResourcesForTagOptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourcesForTagOption( + listResourcesForTagOption( args: ListResourcesForTagOptionCommandInput, cb: (err: any, data?: ListResourcesForTagOptionCommandOutput) => void ): void; - public listResourcesForTagOption( + listResourcesForTagOption( args: ListResourcesForTagOptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourcesForTagOptionCommandOutput) => void ): void; - public listResourcesForTagOption( - args: ListResourcesForTagOptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourcesForTagOptionCommandOutput) => void), - cb?: (err: any, data?: ListResourcesForTagOptionCommandOutput) => void - ): Promise | void { - const command = new ListResourcesForTagOptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all self-service actions.

- */ - public listServiceActions( + + /** + * @see {@link ListServiceActionsCommand} + */ + listServiceActions( args: ListServiceActionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listServiceActions( + listServiceActions( args: ListServiceActionsCommandInput, cb: (err: any, data?: ListServiceActionsCommandOutput) => void ): void; - public listServiceActions( + listServiceActions( args: ListServiceActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceActionsCommandOutput) => void ): void; - public listServiceActions( - args: ListServiceActionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServiceActionsCommandOutput) => void), - cb?: (err: any, data?: ListServiceActionsCommandOutput) => void - ): Promise | void { - const command = new ListServiceActionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.

- */ - public listServiceActionsForProvisioningArtifact( + + /** + * @see {@link ListServiceActionsForProvisioningArtifactCommand} + */ + listServiceActionsForProvisioningArtifact( args: ListServiceActionsForProvisioningArtifactCommandInput, options?: __HttpHandlerOptions ): Promise; - public listServiceActionsForProvisioningArtifact( + listServiceActionsForProvisioningArtifact( args: ListServiceActionsForProvisioningArtifactCommandInput, cb: (err: any, data?: ListServiceActionsForProvisioningArtifactCommandOutput) => void ): void; - public listServiceActionsForProvisioningArtifact( + listServiceActionsForProvisioningArtifact( args: ListServiceActionsForProvisioningArtifactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceActionsForProvisioningArtifactCommandOutput) => void ): void; - public listServiceActionsForProvisioningArtifact( - args: ListServiceActionsForProvisioningArtifactCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListServiceActionsForProvisioningArtifactCommandOutput) => void), - cb?: (err: any, data?: ListServiceActionsForProvisioningArtifactCommandOutput) => void - ): Promise | void { - const command = new ListServiceActionsForProvisioningArtifactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region.

- */ - public listStackInstancesForProvisionedProduct( + + /** + * @see {@link ListStackInstancesForProvisionedProductCommand} + */ + listStackInstancesForProvisionedProduct( args: ListStackInstancesForProvisionedProductCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStackInstancesForProvisionedProduct( + listStackInstancesForProvisionedProduct( args: ListStackInstancesForProvisionedProductCommandInput, cb: (err: any, data?: ListStackInstancesForProvisionedProductCommandOutput) => void ): void; - public listStackInstancesForProvisionedProduct( + listStackInstancesForProvisionedProduct( args: ListStackInstancesForProvisionedProductCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStackInstancesForProvisionedProductCommandOutput) => void ): void; - public listStackInstancesForProvisionedProduct( - args: ListStackInstancesForProvisionedProductCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListStackInstancesForProvisionedProductCommandOutput) => void), - cb?: (err: any, data?: ListStackInstancesForProvisionedProductCommandOutput) => void - ): Promise | void { - const command = new ListStackInstancesForProvisionedProductCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the specified TagOptions or all TagOptions.

- */ - public listTagOptions( + + /** + * @see {@link ListTagOptionsCommand} + */ + listTagOptions( args: ListTagOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagOptions( - args: ListTagOptionsCommandInput, - cb: (err: any, data?: ListTagOptionsCommandOutput) => void - ): void; - public listTagOptions( + listTagOptions(args: ListTagOptionsCommandInput, cb: (err: any, data?: ListTagOptionsCommandOutput) => void): void; + listTagOptions( args: ListTagOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagOptionsCommandOutput) => void ): void; - public listTagOptions( - args: ListTagOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagOptionsCommandOutput) => void), - cb?: (err: any, data?: ListTagOptionsCommandOutput) => void - ): Promise | void { - const command = new ListTagOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Notifies the result - * of the provisioning engine execution. - *

- */ - public notifyProvisionProductEngineWorkflowResult( + + /** + * @see {@link NotifyProvisionProductEngineWorkflowResultCommand} + */ + notifyProvisionProductEngineWorkflowResult( args: NotifyProvisionProductEngineWorkflowResultCommandInput, options?: __HttpHandlerOptions ): Promise; - public notifyProvisionProductEngineWorkflowResult( + notifyProvisionProductEngineWorkflowResult( args: NotifyProvisionProductEngineWorkflowResultCommandInput, cb: (err: any, data?: NotifyProvisionProductEngineWorkflowResultCommandOutput) => void ): void; - public notifyProvisionProductEngineWorkflowResult( + notifyProvisionProductEngineWorkflowResult( args: NotifyProvisionProductEngineWorkflowResultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NotifyProvisionProductEngineWorkflowResultCommandOutput) => void ): void; - public notifyProvisionProductEngineWorkflowResult( - args: NotifyProvisionProductEngineWorkflowResultCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: NotifyProvisionProductEngineWorkflowResultCommandOutput) => void), - cb?: (err: any, data?: NotifyProvisionProductEngineWorkflowResultCommandOutput) => void - ): Promise | void { - const command = new NotifyProvisionProductEngineWorkflowResultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Notifies the result - * of the terminate engine execution. - *

- */ - public notifyTerminateProvisionedProductEngineWorkflowResult( + + /** + * @see {@link NotifyTerminateProvisionedProductEngineWorkflowResultCommand} + */ + notifyTerminateProvisionedProductEngineWorkflowResult( args: NotifyTerminateProvisionedProductEngineWorkflowResultCommandInput, options?: __HttpHandlerOptions ): Promise; - public notifyTerminateProvisionedProductEngineWorkflowResult( + notifyTerminateProvisionedProductEngineWorkflowResult( args: NotifyTerminateProvisionedProductEngineWorkflowResultCommandInput, cb: (err: any, data?: NotifyTerminateProvisionedProductEngineWorkflowResultCommandOutput) => void ): void; - public notifyTerminateProvisionedProductEngineWorkflowResult( + notifyTerminateProvisionedProductEngineWorkflowResult( args: NotifyTerminateProvisionedProductEngineWorkflowResultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NotifyTerminateProvisionedProductEngineWorkflowResultCommandOutput) => void ): void; - public notifyTerminateProvisionedProductEngineWorkflowResult( - args: NotifyTerminateProvisionedProductEngineWorkflowResultCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: NotifyTerminateProvisionedProductEngineWorkflowResultCommandOutput) => void), - cb?: (err: any, data?: NotifyTerminateProvisionedProductEngineWorkflowResultCommandOutput) => void - ): Promise | void { - const command = new NotifyTerminateProvisionedProductEngineWorkflowResultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Notifies the result - * of the update engine execution. - *

- */ - public notifyUpdateProvisionedProductEngineWorkflowResult( + + /** + * @see {@link NotifyUpdateProvisionedProductEngineWorkflowResultCommand} + */ + notifyUpdateProvisionedProductEngineWorkflowResult( args: NotifyUpdateProvisionedProductEngineWorkflowResultCommandInput, options?: __HttpHandlerOptions ): Promise; - public notifyUpdateProvisionedProductEngineWorkflowResult( + notifyUpdateProvisionedProductEngineWorkflowResult( args: NotifyUpdateProvisionedProductEngineWorkflowResultCommandInput, cb: (err: any, data?: NotifyUpdateProvisionedProductEngineWorkflowResultCommandOutput) => void ): void; - public notifyUpdateProvisionedProductEngineWorkflowResult( + notifyUpdateProvisionedProductEngineWorkflowResult( args: NotifyUpdateProvisionedProductEngineWorkflowResultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NotifyUpdateProvisionedProductEngineWorkflowResultCommandOutput) => void ): void; - public notifyUpdateProvisionedProductEngineWorkflowResult( - args: NotifyUpdateProvisionedProductEngineWorkflowResultCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: NotifyUpdateProvisionedProductEngineWorkflowResultCommandOutput) => void), - cb?: (err: any, data?: NotifyUpdateProvisionedProductEngineWorkflowResultCommandOutput) => void - ): Promise | void { - const command = new NotifyUpdateProvisionedProductEngineWorkflowResultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * Provisions the specified product. - *

- *

- * A provisioned product is a resourced instance - * of a product. - * For example, - * provisioning a product - * that's based - * on an CloudFormation template - * launches an CloudFormation stack and its underlying resources. - * You can check the status - * of this request - * using DescribeRecord. - *

- *

- * If the request contains a tag key - * with an empty list - * of values, - * there's a tag conflict - * for that key. - * Don't include conflicted keys - * as tags, - * or this will cause the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". - *

- * - *

- * When provisioning a product - * that's been added - * to a portfolio, - * you must grant your user, group, or role access - * to the portfolio. - * For more information, - * see Granting users access - * in the Service Catalog User Guide. - *

- *
- */ - public provisionProduct( + + /** + * @see {@link ProvisionProductCommand} + */ + provisionProduct( args: ProvisionProductCommandInput, options?: __HttpHandlerOptions ): Promise; - public provisionProduct( + provisionProduct( args: ProvisionProductCommandInput, cb: (err: any, data?: ProvisionProductCommandOutput) => void ): void; - public provisionProduct( + provisionProduct( args: ProvisionProductCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ProvisionProductCommandOutput) => void ): void; - public provisionProduct( - args: ProvisionProductCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ProvisionProductCommandOutput) => void), - cb?: (err: any, data?: ProvisionProductCommandOutput) => void - ): Promise | void { - const command = new ProvisionProductCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Rejects an offer to share the specified portfolio.

- */ - public rejectPortfolioShare( + + /** + * @see {@link RejectPortfolioShareCommand} + */ + rejectPortfolioShare( args: RejectPortfolioShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public rejectPortfolioShare( + rejectPortfolioShare( args: RejectPortfolioShareCommandInput, cb: (err: any, data?: RejectPortfolioShareCommandOutput) => void ): void; - public rejectPortfolioShare( + rejectPortfolioShare( args: RejectPortfolioShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectPortfolioShareCommandOutput) => void ): void; - public rejectPortfolioShare( - args: RejectPortfolioShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RejectPortfolioShareCommandOutput) => void), - cb?: (err: any, data?: RejectPortfolioShareCommandOutput) => void - ): Promise | void { - const command = new RejectPortfolioShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the provisioned products that are available (not terminated).

- *

To use additional filtering, see SearchProvisionedProducts.

- */ - public scanProvisionedProducts( + + /** + * @see {@link ScanProvisionedProductsCommand} + */ + scanProvisionedProducts( args: ScanProvisionedProductsCommandInput, options?: __HttpHandlerOptions ): Promise; - public scanProvisionedProducts( + scanProvisionedProducts( args: ScanProvisionedProductsCommandInput, cb: (err: any, data?: ScanProvisionedProductsCommandOutput) => void ): void; - public scanProvisionedProducts( + scanProvisionedProducts( args: ScanProvisionedProductsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ScanProvisionedProductsCommandOutput) => void ): void; - public scanProvisionedProducts( - args: ScanProvisionedProductsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ScanProvisionedProductsCommandOutput) => void), - cb?: (err: any, data?: ScanProvisionedProductsCommandOutput) => void - ): Promise | void { - const command = new ScanProvisionedProductsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the products to which the caller has access.

- */ - public searchProducts( + + /** + * @see {@link SearchProductsCommand} + */ + searchProducts( args: SearchProductsCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchProducts( - args: SearchProductsCommandInput, - cb: (err: any, data?: SearchProductsCommandOutput) => void - ): void; - public searchProducts( + searchProducts(args: SearchProductsCommandInput, cb: (err: any, data?: SearchProductsCommandOutput) => void): void; + searchProducts( args: SearchProductsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchProductsCommandOutput) => void ): void; - public searchProducts( - args: SearchProductsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchProductsCommandOutput) => void), - cb?: (err: any, data?: SearchProductsCommandOutput) => void - ): Promise | void { - const command = new SearchProductsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the products for the specified portfolio or all products.

- */ - public searchProductsAsAdmin( + + /** + * @see {@link SearchProductsAsAdminCommand} + */ + searchProductsAsAdmin( args: SearchProductsAsAdminCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchProductsAsAdmin( + searchProductsAsAdmin( args: SearchProductsAsAdminCommandInput, cb: (err: any, data?: SearchProductsAsAdminCommandOutput) => void ): void; - public searchProductsAsAdmin( + searchProductsAsAdmin( args: SearchProductsAsAdminCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchProductsAsAdminCommandOutput) => void ): void; - public searchProductsAsAdmin( - args: SearchProductsAsAdminCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchProductsAsAdminCommandOutput) => void), - cb?: (err: any, data?: SearchProductsAsAdminCommandOutput) => void - ): Promise | void { - const command = new SearchProductsAsAdminCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets information about the provisioned products that meet the specified criteria.

- */ - public searchProvisionedProducts( + + /** + * @see {@link SearchProvisionedProductsCommand} + */ + searchProvisionedProducts( args: SearchProvisionedProductsCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchProvisionedProducts( + searchProvisionedProducts( args: SearchProvisionedProductsCommandInput, cb: (err: any, data?: SearchProvisionedProductsCommandOutput) => void ): void; - public searchProvisionedProducts( + searchProvisionedProducts( args: SearchProvisionedProductsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchProvisionedProductsCommandOutput) => void ): void; - public searchProvisionedProducts( - args: SearchProvisionedProductsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchProvisionedProductsCommandOutput) => void), - cb?: (err: any, data?: SearchProvisionedProductsCommandOutput) => void - ): Promise | void { - const command = new SearchProvisionedProductsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Terminates the specified provisioned product.

- *

This operation does not delete any records associated with the provisioned product.

- *

You can check the status of this request using DescribeRecord.

- */ - public terminateProvisionedProduct( + + /** + * @see {@link TerminateProvisionedProductCommand} + */ + terminateProvisionedProduct( args: TerminateProvisionedProductCommandInput, options?: __HttpHandlerOptions ): Promise; - public terminateProvisionedProduct( + terminateProvisionedProduct( args: TerminateProvisionedProductCommandInput, cb: (err: any, data?: TerminateProvisionedProductCommandOutput) => void ): void; - public terminateProvisionedProduct( + terminateProvisionedProduct( args: TerminateProvisionedProductCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TerminateProvisionedProductCommandOutput) => void ): void; - public terminateProvisionedProduct( - args: TerminateProvisionedProductCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TerminateProvisionedProductCommandOutput) => void), - cb?: (err: any, data?: TerminateProvisionedProductCommandOutput) => void - ): Promise | void { - const command = new TerminateProvisionedProductCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the specified constraint.

- */ - public updateConstraint( + + /** + * @see {@link UpdateConstraintCommand} + */ + updateConstraint( args: UpdateConstraintCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConstraint( + updateConstraint( args: UpdateConstraintCommandInput, cb: (err: any, data?: UpdateConstraintCommandOutput) => void ): void; - public updateConstraint( + updateConstraint( args: UpdateConstraintCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConstraintCommandOutput) => void ): void; - public updateConstraint( - args: UpdateConstraintCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConstraintCommandOutput) => void), - cb?: (err: any, data?: UpdateConstraintCommandOutput) => void - ): Promise | void { - const command = new UpdateConstraintCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the specified portfolio.

- *

You cannot update a product that was shared with you.

- */ - public updatePortfolio( + + /** + * @see {@link UpdatePortfolioCommand} + */ + updatePortfolio( args: UpdatePortfolioCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePortfolio( - args: UpdatePortfolioCommandInput, - cb: (err: any, data?: UpdatePortfolioCommandOutput) => void - ): void; - public updatePortfolio( + updatePortfolio(args: UpdatePortfolioCommandInput, cb: (err: any, data?: UpdatePortfolioCommandOutput) => void): void; + updatePortfolio( args: UpdatePortfolioCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePortfolioCommandOutput) => void ): void; - public updatePortfolio( - args: UpdatePortfolioCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePortfolioCommandOutput) => void), - cb?: (err: any, data?: UpdatePortfolioCommandOutput) => void - ): Promise | void { - const command = new UpdatePortfolioCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the specified portfolio share. You can use this API to enable or disable TagOptions sharing - * or Principal sharing for an existing portfolio share.

- *

The portfolio share cannot be updated if the CreatePortfolioShare operation is IN_PROGRESS, as the share is not available to recipient entities. In this case, you must wait for the portfolio share to be COMPLETED.

- *

You must provide the accountId or organization node in the input, but not both.

- *

If the portfolio is shared to both an external account and an organization node, and both shares need to be updated, you must invoke UpdatePortfolioShare separately for each share type.

- *

This API cannot be used for removing the portfolio share. You must use DeletePortfolioShare API for that action.

- * - *

When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is - * then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, - * but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal - * name association for the portfolio. Although this user may not know which principal names are associated through - * Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then - * Service Catalog recommends using PrincipalType as IAM. With this configuration, - * the PrincipalARN must already exist in the recipient account before it can be associated.

- *
- */ - public updatePortfolioShare( + + /** + * @see {@link UpdatePortfolioShareCommand} + */ + updatePortfolioShare( args: UpdatePortfolioShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePortfolioShare( + updatePortfolioShare( args: UpdatePortfolioShareCommandInput, cb: (err: any, data?: UpdatePortfolioShareCommandOutput) => void ): void; - public updatePortfolioShare( + updatePortfolioShare( args: UpdatePortfolioShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePortfolioShareCommandOutput) => void ): void; - public updatePortfolioShare( - args: UpdatePortfolioShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePortfolioShareCommandOutput) => void), - cb?: (err: any, data?: UpdatePortfolioShareCommandOutput) => void - ): Promise | void { - const command = new UpdatePortfolioShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the specified product.

- */ - public updateProduct( - args: UpdateProductCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateProduct( - args: UpdateProductCommandInput, - cb: (err: any, data?: UpdateProductCommandOutput) => void - ): void; - public updateProduct( + + /** + * @see {@link UpdateProductCommand} + */ + updateProduct(args: UpdateProductCommandInput, options?: __HttpHandlerOptions): Promise; + updateProduct(args: UpdateProductCommandInput, cb: (err: any, data?: UpdateProductCommandOutput) => void): void; + updateProduct( args: UpdateProductCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProductCommandOutput) => void ): void; - public updateProduct( - args: UpdateProductCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProductCommandOutput) => void), - cb?: (err: any, data?: UpdateProductCommandOutput) => void - ): Promise | void { - const command = new UpdateProductCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Requests updates to the configuration of the specified provisioned product.

- *

If there are tags associated with the object, they cannot be updated or added. - * Depending on the specific updates requested, this operation can update with no - * interruption, with some interruption, or replace the provisioned product entirely.

- *

You can check the status of this request using DescribeRecord.

- */ - public updateProvisionedProduct( + + /** + * @see {@link UpdateProvisionedProductCommand} + */ + updateProvisionedProduct( args: UpdateProvisionedProductCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateProvisionedProduct( + updateProvisionedProduct( args: UpdateProvisionedProductCommandInput, cb: (err: any, data?: UpdateProvisionedProductCommandOutput) => void ): void; - public updateProvisionedProduct( + updateProvisionedProduct( args: UpdateProvisionedProductCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProvisionedProductCommandOutput) => void ): void; - public updateProvisionedProduct( - args: UpdateProvisionedProductCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProvisionedProductCommandOutput) => void), - cb?: (err: any, data?: UpdateProvisionedProductCommandOutput) => void - ): Promise | void { - const command = new UpdateProvisionedProductCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Requests updates to the properties of the specified provisioned product.

- */ - public updateProvisionedProductProperties( + + /** + * @see {@link UpdateProvisionedProductPropertiesCommand} + */ + updateProvisionedProductProperties( args: UpdateProvisionedProductPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateProvisionedProductProperties( + updateProvisionedProductProperties( args: UpdateProvisionedProductPropertiesCommandInput, cb: (err: any, data?: UpdateProvisionedProductPropertiesCommandOutput) => void ): void; - public updateProvisionedProductProperties( + updateProvisionedProductProperties( args: UpdateProvisionedProductPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProvisionedProductPropertiesCommandOutput) => void ): void; - public updateProvisionedProductProperties( - args: UpdateProvisionedProductPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProvisionedProductPropertiesCommandOutput) => void), - cb?: (err: any, data?: UpdateProvisionedProductPropertiesCommandOutput) => void - ): Promise | void { - const command = new UpdateProvisionedProductPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the specified provisioning artifact (also known as a version) for the specified product.

- *

You cannot update a provisioning artifact for a product that was shared with you.

- */ - public updateProvisioningArtifact( + + /** + * @see {@link UpdateProvisioningArtifactCommand} + */ + updateProvisioningArtifact( args: UpdateProvisioningArtifactCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateProvisioningArtifact( + updateProvisioningArtifact( args: UpdateProvisioningArtifactCommandInput, cb: (err: any, data?: UpdateProvisioningArtifactCommandOutput) => void ): void; - public updateProvisioningArtifact( + updateProvisioningArtifact( args: UpdateProvisioningArtifactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProvisioningArtifactCommandOutput) => void ): void; - public updateProvisioningArtifact( - args: UpdateProvisioningArtifactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProvisioningArtifactCommandOutput) => void), - cb?: (err: any, data?: UpdateProvisioningArtifactCommandOutput) => void - ): Promise | void { - const command = new UpdateProvisioningArtifactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a self-service action.

- */ - public updateServiceAction( + + /** + * @see {@link UpdateServiceActionCommand} + */ + updateServiceAction( args: UpdateServiceActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateServiceAction( + updateServiceAction( args: UpdateServiceActionCommandInput, cb: (err: any, data?: UpdateServiceActionCommandOutput) => void ): void; - public updateServiceAction( + updateServiceAction( args: UpdateServiceActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceActionCommandOutput) => void ): void; - public updateServiceAction( - args: UpdateServiceActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServiceActionCommandOutput) => void), - cb?: (err: any, data?: UpdateServiceActionCommandOutput) => void - ): Promise | void { - const command = new UpdateServiceActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the specified TagOption.

- */ - public updateTagOption( + + /** + * @see {@link UpdateTagOptionCommand} + */ + updateTagOption( args: UpdateTagOptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTagOption( - args: UpdateTagOptionCommandInput, - cb: (err: any, data?: UpdateTagOptionCommandOutput) => void - ): void; - public updateTagOption( + updateTagOption(args: UpdateTagOptionCommandInput, cb: (err: any, data?: UpdateTagOptionCommandOutput) => void): void; + updateTagOption( args: UpdateTagOptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTagOptionCommandOutput) => void ): void; - public updateTagOption( - args: UpdateTagOptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTagOptionCommandOutput) => void), - cb?: (err: any, data?: UpdateTagOptionCommandOutput) => void - ): Promise | void { - const command = new UpdateTagOptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Service Catalog + *

+ * Service Catalog enables + * organizations to create and manage catalogs of IT services that are approved for Amazon Web Services. To + * get the most out of this documentation, you should be familiar with the terminology + * discussed in Service Catalog + * Concepts.

+ */ +export class ServiceCatalog extends ServiceCatalogClient implements ServiceCatalog {} +createAggregatedClient(commands, ServiceCatalog); diff --git a/clients/client-service-quotas/src/ServiceQuotas.ts b/clients/client-service-quotas/src/ServiceQuotas.ts index 7ca039534bb6..a94c782c0729 100644 --- a/clients/client-service-quotas/src/ServiceQuotas.ts +++ b/clients/client-service-quotas/src/ServiceQuotas.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -92,659 +93,339 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; -import { ServiceQuotasClient } from "./ServiceQuotasClient"; +import { ServiceQuotasClient, ServiceQuotasClientConfig } from "./ServiceQuotasClient"; -/** - * @public - *

With Service Quotas, you can view and manage your quotas easily as your AWS workloads - * grow. Quotas, also referred to as limits, are the maximum number of resources that you can - * create in your AWS account. For more information, see the Service Quotas User Guide.

- */ -export class ServiceQuotas extends ServiceQuotasClient { +const commands = { + AssociateServiceQuotaTemplateCommand, + DeleteServiceQuotaIncreaseRequestFromTemplateCommand, + DisassociateServiceQuotaTemplateCommand, + GetAssociationForServiceQuotaTemplateCommand, + GetAWSDefaultServiceQuotaCommand, + GetRequestedServiceQuotaChangeCommand, + GetServiceQuotaCommand, + GetServiceQuotaIncreaseRequestFromTemplateCommand, + ListAWSDefaultServiceQuotasCommand, + ListRequestedServiceQuotaChangeHistoryCommand, + ListRequestedServiceQuotaChangeHistoryByQuotaCommand, + ListServiceQuotaIncreaseRequestsInTemplateCommand, + ListServiceQuotasCommand, + ListServicesCommand, + ListTagsForResourceCommand, + PutServiceQuotaIncreaseRequestIntoTemplateCommand, + RequestServiceQuotaIncreaseCommand, + TagResourceCommand, + UntagResourceCommand, +}; + +export interface ServiceQuotas { /** - * @public - *

Associates your quota request template with your organization. When a new account is - * created in your organization, the quota increase requests in the template are automatically - * applied to the account. You can add a quota increase request for any adjustable quota to your - * template.

+ * @see {@link AssociateServiceQuotaTemplateCommand} */ - public associateServiceQuotaTemplate( + associateServiceQuotaTemplate( args: AssociateServiceQuotaTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateServiceQuotaTemplate( + associateServiceQuotaTemplate( args: AssociateServiceQuotaTemplateCommandInput, cb: (err: any, data?: AssociateServiceQuotaTemplateCommandOutput) => void ): void; - public associateServiceQuotaTemplate( + associateServiceQuotaTemplate( args: AssociateServiceQuotaTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateServiceQuotaTemplateCommandOutput) => void ): void; - public associateServiceQuotaTemplate( - args: AssociateServiceQuotaTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateServiceQuotaTemplateCommandOutput) => void), - cb?: (err: any, data?: AssociateServiceQuotaTemplateCommandOutput) => void - ): Promise | void { - const command = new AssociateServiceQuotaTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the quota increase request for the specified quota from your quota request - * template.

+ * @see {@link DeleteServiceQuotaIncreaseRequestFromTemplateCommand} */ - public deleteServiceQuotaIncreaseRequestFromTemplate( + deleteServiceQuotaIncreaseRequestFromTemplate( args: DeleteServiceQuotaIncreaseRequestFromTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteServiceQuotaIncreaseRequestFromTemplate( + deleteServiceQuotaIncreaseRequestFromTemplate( args: DeleteServiceQuotaIncreaseRequestFromTemplateCommandInput, cb: (err: any, data?: DeleteServiceQuotaIncreaseRequestFromTemplateCommandOutput) => void ): void; - public deleteServiceQuotaIncreaseRequestFromTemplate( + deleteServiceQuotaIncreaseRequestFromTemplate( args: DeleteServiceQuotaIncreaseRequestFromTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceQuotaIncreaseRequestFromTemplateCommandOutput) => void ): void; - public deleteServiceQuotaIncreaseRequestFromTemplate( - args: DeleteServiceQuotaIncreaseRequestFromTemplateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteServiceQuotaIncreaseRequestFromTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteServiceQuotaIncreaseRequestFromTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteServiceQuotaIncreaseRequestFromTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables your quota request template. After a template is disabled, the quota increase - * requests in the template are not applied to new accounts in your organization. Disabling a - * quota request template does not apply its quota increase requests.

+ * @see {@link DisassociateServiceQuotaTemplateCommand} */ - public disassociateServiceQuotaTemplate( + disassociateServiceQuotaTemplate( args: DisassociateServiceQuotaTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateServiceQuotaTemplate( + disassociateServiceQuotaTemplate( args: DisassociateServiceQuotaTemplateCommandInput, cb: (err: any, data?: DisassociateServiceQuotaTemplateCommandOutput) => void ): void; - public disassociateServiceQuotaTemplate( + disassociateServiceQuotaTemplate( args: DisassociateServiceQuotaTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateServiceQuotaTemplateCommandOutput) => void ): void; - public disassociateServiceQuotaTemplate( - args: DisassociateServiceQuotaTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateServiceQuotaTemplateCommandOutput) => void), - cb?: (err: any, data?: DisassociateServiceQuotaTemplateCommandOutput) => void - ): Promise | void { - const command = new DisassociateServiceQuotaTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the status of the association for the quota request template.

+ * @see {@link GetAssociationForServiceQuotaTemplateCommand} */ - public getAssociationForServiceQuotaTemplate( + getAssociationForServiceQuotaTemplate( args: GetAssociationForServiceQuotaTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAssociationForServiceQuotaTemplate( + getAssociationForServiceQuotaTemplate( args: GetAssociationForServiceQuotaTemplateCommandInput, cb: (err: any, data?: GetAssociationForServiceQuotaTemplateCommandOutput) => void ): void; - public getAssociationForServiceQuotaTemplate( + getAssociationForServiceQuotaTemplate( args: GetAssociationForServiceQuotaTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAssociationForServiceQuotaTemplateCommandOutput) => void ): void; - public getAssociationForServiceQuotaTemplate( - args: GetAssociationForServiceQuotaTemplateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetAssociationForServiceQuotaTemplateCommandOutput) => void), - cb?: (err: any, data?: GetAssociationForServiceQuotaTemplateCommandOutput) => void - ): Promise | void { - const command = new GetAssociationForServiceQuotaTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the default value for the specified quota. The default value does not reflect - * any quota increases.

+ * @see {@link GetAWSDefaultServiceQuotaCommand} */ - public getAWSDefaultServiceQuota( + getAWSDefaultServiceQuota( args: GetAWSDefaultServiceQuotaCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAWSDefaultServiceQuota( + getAWSDefaultServiceQuota( args: GetAWSDefaultServiceQuotaCommandInput, cb: (err: any, data?: GetAWSDefaultServiceQuotaCommandOutput) => void ): void; - public getAWSDefaultServiceQuota( + getAWSDefaultServiceQuota( args: GetAWSDefaultServiceQuotaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAWSDefaultServiceQuotaCommandOutput) => void ): void; - public getAWSDefaultServiceQuota( - args: GetAWSDefaultServiceQuotaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAWSDefaultServiceQuotaCommandOutput) => void), - cb?: (err: any, data?: GetAWSDefaultServiceQuotaCommandOutput) => void - ): Promise | void { - const command = new GetAWSDefaultServiceQuotaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the specified quota increase request.

+ * @see {@link GetRequestedServiceQuotaChangeCommand} */ - public getRequestedServiceQuotaChange( + getRequestedServiceQuotaChange( args: GetRequestedServiceQuotaChangeCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRequestedServiceQuotaChange( + getRequestedServiceQuotaChange( args: GetRequestedServiceQuotaChangeCommandInput, cb: (err: any, data?: GetRequestedServiceQuotaChangeCommandOutput) => void ): void; - public getRequestedServiceQuotaChange( + getRequestedServiceQuotaChange( args: GetRequestedServiceQuotaChangeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRequestedServiceQuotaChangeCommandOutput) => void ): void; - public getRequestedServiceQuotaChange( - args: GetRequestedServiceQuotaChangeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRequestedServiceQuotaChangeCommandOutput) => void), - cb?: (err: any, data?: GetRequestedServiceQuotaChangeCommandOutput) => void - ): Promise | void { - const command = new GetRequestedServiceQuotaChangeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the applied quota value for the specified quota. For some quotas, only the - * default values are available. If the applied quota value is not available for a quota, the - * quota is not retrieved.

+ * @see {@link GetServiceQuotaCommand} */ - public getServiceQuota( + getServiceQuota( args: GetServiceQuotaCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServiceQuota( - args: GetServiceQuotaCommandInput, - cb: (err: any, data?: GetServiceQuotaCommandOutput) => void - ): void; - public getServiceQuota( + getServiceQuota(args: GetServiceQuotaCommandInput, cb: (err: any, data?: GetServiceQuotaCommandOutput) => void): void; + getServiceQuota( args: GetServiceQuotaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceQuotaCommandOutput) => void ): void; - public getServiceQuota( - args: GetServiceQuotaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceQuotaCommandOutput) => void), - cb?: (err: any, data?: GetServiceQuotaCommandOutput) => void - ): Promise | void { - const command = new GetServiceQuotaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the specified quota increase request in your quota request - * template.

+ * @see {@link GetServiceQuotaIncreaseRequestFromTemplateCommand} */ - public getServiceQuotaIncreaseRequestFromTemplate( + getServiceQuotaIncreaseRequestFromTemplate( args: GetServiceQuotaIncreaseRequestFromTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServiceQuotaIncreaseRequestFromTemplate( + getServiceQuotaIncreaseRequestFromTemplate( args: GetServiceQuotaIncreaseRequestFromTemplateCommandInput, cb: (err: any, data?: GetServiceQuotaIncreaseRequestFromTemplateCommandOutput) => void ): void; - public getServiceQuotaIncreaseRequestFromTemplate( + getServiceQuotaIncreaseRequestFromTemplate( args: GetServiceQuotaIncreaseRequestFromTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceQuotaIncreaseRequestFromTemplateCommandOutput) => void ): void; - public getServiceQuotaIncreaseRequestFromTemplate( - args: GetServiceQuotaIncreaseRequestFromTemplateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetServiceQuotaIncreaseRequestFromTemplateCommandOutput) => void), - cb?: (err: any, data?: GetServiceQuotaIncreaseRequestFromTemplateCommandOutput) => void - ): Promise | void { - const command = new GetServiceQuotaIncreaseRequestFromTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the default values for the quotas for the specified AWS service. A default value - * does not reflect any quota increases.

+ * @see {@link ListAWSDefaultServiceQuotasCommand} */ - public listAWSDefaultServiceQuotas( + listAWSDefaultServiceQuotas( args: ListAWSDefaultServiceQuotasCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAWSDefaultServiceQuotas( + listAWSDefaultServiceQuotas( args: ListAWSDefaultServiceQuotasCommandInput, cb: (err: any, data?: ListAWSDefaultServiceQuotasCommandOutput) => void ): void; - public listAWSDefaultServiceQuotas( + listAWSDefaultServiceQuotas( args: ListAWSDefaultServiceQuotasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAWSDefaultServiceQuotasCommandOutput) => void ): void; - public listAWSDefaultServiceQuotas( - args: ListAWSDefaultServiceQuotasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAWSDefaultServiceQuotasCommandOutput) => void), - cb?: (err: any, data?: ListAWSDefaultServiceQuotasCommandOutput) => void - ): Promise | void { - const command = new ListAWSDefaultServiceQuotasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the quota increase requests for the specified service.

+ * @see {@link ListRequestedServiceQuotaChangeHistoryCommand} */ - public listRequestedServiceQuotaChangeHistory( + listRequestedServiceQuotaChangeHistory( args: ListRequestedServiceQuotaChangeHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRequestedServiceQuotaChangeHistory( + listRequestedServiceQuotaChangeHistory( args: ListRequestedServiceQuotaChangeHistoryCommandInput, cb: (err: any, data?: ListRequestedServiceQuotaChangeHistoryCommandOutput) => void ): void; - public listRequestedServiceQuotaChangeHistory( + listRequestedServiceQuotaChangeHistory( args: ListRequestedServiceQuotaChangeHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRequestedServiceQuotaChangeHistoryCommandOutput) => void ): void; - public listRequestedServiceQuotaChangeHistory( - args: ListRequestedServiceQuotaChangeHistoryCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListRequestedServiceQuotaChangeHistoryCommandOutput) => void), - cb?: (err: any, data?: ListRequestedServiceQuotaChangeHistoryCommandOutput) => void - ): Promise | void { - const command = new ListRequestedServiceQuotaChangeHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the quota increase requests for the specified quota.

+ * @see {@link ListRequestedServiceQuotaChangeHistoryByQuotaCommand} */ - public listRequestedServiceQuotaChangeHistoryByQuota( + listRequestedServiceQuotaChangeHistoryByQuota( args: ListRequestedServiceQuotaChangeHistoryByQuotaCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRequestedServiceQuotaChangeHistoryByQuota( + listRequestedServiceQuotaChangeHistoryByQuota( args: ListRequestedServiceQuotaChangeHistoryByQuotaCommandInput, cb: (err: any, data?: ListRequestedServiceQuotaChangeHistoryByQuotaCommandOutput) => void ): void; - public listRequestedServiceQuotaChangeHistoryByQuota( + listRequestedServiceQuotaChangeHistoryByQuota( args: ListRequestedServiceQuotaChangeHistoryByQuotaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRequestedServiceQuotaChangeHistoryByQuotaCommandOutput) => void ): void; - public listRequestedServiceQuotaChangeHistoryByQuota( - args: ListRequestedServiceQuotaChangeHistoryByQuotaCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListRequestedServiceQuotaChangeHistoryByQuotaCommandOutput) => void), - cb?: (err: any, data?: ListRequestedServiceQuotaChangeHistoryByQuotaCommandOutput) => void - ): Promise | void { - const command = new ListRequestedServiceQuotaChangeHistoryByQuotaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the quota increase requests in the specified quota request template.

+ * @see {@link ListServiceQuotaIncreaseRequestsInTemplateCommand} */ - public listServiceQuotaIncreaseRequestsInTemplate( + listServiceQuotaIncreaseRequestsInTemplate( args: ListServiceQuotaIncreaseRequestsInTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public listServiceQuotaIncreaseRequestsInTemplate( + listServiceQuotaIncreaseRequestsInTemplate( args: ListServiceQuotaIncreaseRequestsInTemplateCommandInput, cb: (err: any, data?: ListServiceQuotaIncreaseRequestsInTemplateCommandOutput) => void ): void; - public listServiceQuotaIncreaseRequestsInTemplate( + listServiceQuotaIncreaseRequestsInTemplate( args: ListServiceQuotaIncreaseRequestsInTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceQuotaIncreaseRequestsInTemplateCommandOutput) => void ): void; - public listServiceQuotaIncreaseRequestsInTemplate( - args: ListServiceQuotaIncreaseRequestsInTemplateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListServiceQuotaIncreaseRequestsInTemplateCommandOutput) => void), - cb?: (err: any, data?: ListServiceQuotaIncreaseRequestsInTemplateCommandOutput) => void - ): Promise | void { - const command = new ListServiceQuotaIncreaseRequestsInTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the applied quota values for the specified AWS service. For some quotas, only the - * default values are available. If the applied quota value is not available for a quota, the - * quota is not retrieved.

+ * @see {@link ListServiceQuotasCommand} */ - public listServiceQuotas( + listServiceQuotas( args: ListServiceQuotasCommandInput, options?: __HttpHandlerOptions ): Promise; - public listServiceQuotas( + listServiceQuotas( args: ListServiceQuotasCommandInput, cb: (err: any, data?: ListServiceQuotasCommandOutput) => void ): void; - public listServiceQuotas( + listServiceQuotas( args: ListServiceQuotasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceQuotasCommandOutput) => void ): void; - public listServiceQuotas( - args: ListServiceQuotasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServiceQuotasCommandOutput) => void), - cb?: (err: any, data?: ListServiceQuotasCommandOutput) => void - ): Promise | void { - const command = new ListServiceQuotasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the names and codes for the services integrated with Service Quotas.

+ * @see {@link ListServicesCommand} */ - public listServices( - args: ListServicesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listServices(args: ListServicesCommandInput, cb: (err: any, data?: ListServicesCommandOutput) => void): void; - public listServices( + listServices(args: ListServicesCommandInput, options?: __HttpHandlerOptions): Promise; + listServices(args: ListServicesCommandInput, cb: (err: any, data?: ListServicesCommandOutput) => void): void; + listServices( args: ListServicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServicesCommandOutput) => void ): void; - public listServices( - args: ListServicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServicesCommandOutput) => void), - cb?: (err: any, data?: ListServicesCommandOutput) => void - ): Promise | void { - const command = new ListServicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the tags assigned to the specified applied quota.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a quota increase request to your quota request template.

+ * @see {@link PutServiceQuotaIncreaseRequestIntoTemplateCommand} */ - public putServiceQuotaIncreaseRequestIntoTemplate( + putServiceQuotaIncreaseRequestIntoTemplate( args: PutServiceQuotaIncreaseRequestIntoTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public putServiceQuotaIncreaseRequestIntoTemplate( + putServiceQuotaIncreaseRequestIntoTemplate( args: PutServiceQuotaIncreaseRequestIntoTemplateCommandInput, cb: (err: any, data?: PutServiceQuotaIncreaseRequestIntoTemplateCommandOutput) => void ): void; - public putServiceQuotaIncreaseRequestIntoTemplate( + putServiceQuotaIncreaseRequestIntoTemplate( args: PutServiceQuotaIncreaseRequestIntoTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutServiceQuotaIncreaseRequestIntoTemplateCommandOutput) => void ): void; - public putServiceQuotaIncreaseRequestIntoTemplate( - args: PutServiceQuotaIncreaseRequestIntoTemplateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PutServiceQuotaIncreaseRequestIntoTemplateCommandOutput) => void), - cb?: (err: any, data?: PutServiceQuotaIncreaseRequestIntoTemplateCommandOutput) => void - ): Promise | void { - const command = new PutServiceQuotaIncreaseRequestIntoTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Submits a quota increase request for the specified quota.

+ * @see {@link RequestServiceQuotaIncreaseCommand} */ - public requestServiceQuotaIncrease( + requestServiceQuotaIncrease( args: RequestServiceQuotaIncreaseCommandInput, options?: __HttpHandlerOptions ): Promise; - public requestServiceQuotaIncrease( + requestServiceQuotaIncrease( args: RequestServiceQuotaIncreaseCommandInput, cb: (err: any, data?: RequestServiceQuotaIncreaseCommandOutput) => void ): void; - public requestServiceQuotaIncrease( + requestServiceQuotaIncrease( args: RequestServiceQuotaIncreaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RequestServiceQuotaIncreaseCommandOutput) => void ): void; - public requestServiceQuotaIncrease( - args: RequestServiceQuotaIncreaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RequestServiceQuotaIncreaseCommandOutput) => void), - cb?: (err: any, data?: RequestServiceQuotaIncreaseCommandOutput) => void - ): Promise | void { - const command = new RequestServiceQuotaIncreaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds tags to the specified applied quota. You can include one or more tags to add to the - * quota.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from the specified applied quota. You can specify one or more tags to - * remove.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

With Service Quotas, you can view and manage your quotas easily as your AWS workloads + * grow. Quotas, also referred to as limits, are the maximum number of resources that you can + * create in your AWS account. For more information, see the Service Quotas User Guide.

+ */ +export class ServiceQuotas extends ServiceQuotasClient implements ServiceQuotas {} +createAggregatedClient(commands, ServiceQuotas); diff --git a/clients/client-servicediscovery/src/ServiceDiscovery.ts b/clients/client-servicediscovery/src/ServiceDiscovery.ts index 442395549f09..9712ae90382b 100644 --- a/clients/client-servicediscovery/src/ServiceDiscovery.ts +++ b/clients/client-servicediscovery/src/ServiceDiscovery.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -119,1003 +120,415 @@ import { UpdateServiceCommandInput, UpdateServiceCommandOutput, } from "./commands/UpdateServiceCommand"; -import { ServiceDiscoveryClient } from "./ServiceDiscoveryClient"; +import { ServiceDiscoveryClient, ServiceDiscoveryClientConfig } from "./ServiceDiscoveryClient"; -/** - * @public - * Cloud Map - *

With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your - * microservice applications run in. When an instance becomes available, you can call the Cloud Map - * API to register the instance with Cloud Map. For public or private DNS namespaces, Cloud Map - * automatically creates DNS records and an optional health check. Clients that submit public or - * private DNS queries, or HTTP requests, for the service receive an answer that contains up to - * eight healthy records.

- */ -export class ServiceDiscovery extends ServiceDiscoveryClient { +const commands = { + CreateHttpNamespaceCommand, + CreatePrivateDnsNamespaceCommand, + CreatePublicDnsNamespaceCommand, + CreateServiceCommand, + DeleteNamespaceCommand, + DeleteServiceCommand, + DeregisterInstanceCommand, + DiscoverInstancesCommand, + GetInstanceCommand, + GetInstancesHealthStatusCommand, + GetNamespaceCommand, + GetOperationCommand, + GetServiceCommand, + ListInstancesCommand, + ListNamespacesCommand, + ListOperationsCommand, + ListServicesCommand, + ListTagsForResourceCommand, + RegisterInstanceCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateHttpNamespaceCommand, + UpdateInstanceCustomHealthStatusCommand, + UpdatePrivateDnsNamespaceCommand, + UpdatePublicDnsNamespaceCommand, + UpdateServiceCommand, +}; + +export interface ServiceDiscovery { /** - * @public - *

Creates an HTTP namespace. Service instances registered using an HTTP namespace can be - * discovered using a DiscoverInstances request but can't be discovered using - * DNS.

- *

For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the - * Cloud Map Developer Guide.

+ * @see {@link CreateHttpNamespaceCommand} */ - public createHttpNamespace( + createHttpNamespace( args: CreateHttpNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createHttpNamespace( + createHttpNamespace( args: CreateHttpNamespaceCommandInput, cb: (err: any, data?: CreateHttpNamespaceCommandOutput) => void ): void; - public createHttpNamespace( + createHttpNamespace( args: CreateHttpNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHttpNamespaceCommandOutput) => void ): void; - public createHttpNamespace( - args: CreateHttpNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateHttpNamespaceCommandOutput) => void), - cb?: (err: any, data?: CreateHttpNamespaceCommandOutput) => void - ): Promise | void { - const command = new CreateHttpNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a private namespace based on DNS, which is visible only inside a specified Amazon - * VPC. The namespace defines your service naming scheme. For example, if you name your namespace - * example.com and name your service backend, the resulting DNS name for - * the service is backend.example.com. Service instances that are registered using a - * private DNS namespace can be discovered using either a DiscoverInstances request or - * using DNS. For the current quota on the number of namespaces that you can create using the same - * Amazon Web Services account, see Cloud Map quotas in the - * Cloud Map Developer Guide.

+ * @see {@link CreatePrivateDnsNamespaceCommand} */ - public createPrivateDnsNamespace( + createPrivateDnsNamespace( args: CreatePrivateDnsNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPrivateDnsNamespace( + createPrivateDnsNamespace( args: CreatePrivateDnsNamespaceCommandInput, cb: (err: any, data?: CreatePrivateDnsNamespaceCommandOutput) => void ): void; - public createPrivateDnsNamespace( + createPrivateDnsNamespace( args: CreatePrivateDnsNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePrivateDnsNamespaceCommandOutput) => void ): void; - public createPrivateDnsNamespace( - args: CreatePrivateDnsNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePrivateDnsNamespaceCommandOutput) => void), - cb?: (err: any, data?: CreatePrivateDnsNamespaceCommandOutput) => void - ): Promise | void { - const command = new CreatePrivateDnsNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a public namespace based on DNS, which is visible on the internet. The namespace - * defines your service naming scheme. For example, if you name your namespace - * example.com and name your service backend, the resulting DNS name for - * the service is backend.example.com. You can discover instances that were registered - * with a public DNS namespace by using either a DiscoverInstances request or using - * DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the - * Cloud Map Developer Guide.

- * - *

The CreatePublicDnsNamespace API operation is not supported in the Amazon Web Services GovCloud (US) Regions.

- *
+ * @see {@link CreatePublicDnsNamespaceCommand} */ - public createPublicDnsNamespace( + createPublicDnsNamespace( args: CreatePublicDnsNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPublicDnsNamespace( + createPublicDnsNamespace( args: CreatePublicDnsNamespaceCommandInput, cb: (err: any, data?: CreatePublicDnsNamespaceCommandOutput) => void ): void; - public createPublicDnsNamespace( + createPublicDnsNamespace( args: CreatePublicDnsNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePublicDnsNamespaceCommandOutput) => void ): void; - public createPublicDnsNamespace( - args: CreatePublicDnsNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePublicDnsNamespaceCommandOutput) => void), - cb?: (err: any, data?: CreatePublicDnsNamespaceCommandOutput) => void - ): Promise | void { - const command = new CreatePublicDnsNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a service. This action defines the configuration for the following entities:

- *
    - *
  • - *

    For public and private DNS namespaces, one of the following combinations of DNS records in - * Amazon Route 53:

    - *
      - *
    • - *

      - * A - *

      - *
    • - *
    • - *

      - * AAAA - *

      - *
    • - *
    • - *

      - * A and AAAA - *

      - *
    • - *
    • - *

      - * SRV - *

      - *
    • - *
    • - *

      - * CNAME - *

      - *
    • - *
    - *
  • - *
  • - *

    Optionally, a health check

    - *
  • - *
- *

After you create the service, you can submit a RegisterInstance request, and - * Cloud Map uses the values in the configuration to create the specified entities.

- *

For the current quota on the number of instances that you can register using the same - * namespace and using the same service, see Cloud Map quotas in the - * Cloud Map Developer Guide.

+ * @see {@link CreateServiceCommand} */ - public createService( - args: CreateServiceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createService( - args: CreateServiceCommandInput, - cb: (err: any, data?: CreateServiceCommandOutput) => void - ): void; - public createService( + createService(args: CreateServiceCommandInput, options?: __HttpHandlerOptions): Promise; + createService(args: CreateServiceCommandInput, cb: (err: any, data?: CreateServiceCommandOutput) => void): void; + createService( args: CreateServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceCommandOutput) => void ): void; - public createService( - args: CreateServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateServiceCommandOutput) => void), - cb?: (err: any, data?: CreateServiceCommandOutput) => void - ): Promise | void { - const command = new CreateServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a namespace from the current account. If the namespace still contains one or more - * services, the request fails.

+ * @see {@link DeleteNamespaceCommand} */ - public deleteNamespace( + deleteNamespace( args: DeleteNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNamespace( - args: DeleteNamespaceCommandInput, - cb: (err: any, data?: DeleteNamespaceCommandOutput) => void - ): void; - public deleteNamespace( + deleteNamespace(args: DeleteNamespaceCommandInput, cb: (err: any, data?: DeleteNamespaceCommandOutput) => void): void; + deleteNamespace( args: DeleteNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNamespaceCommandOutput) => void ): void; - public deleteNamespace( - args: DeleteNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNamespaceCommandOutput) => void), - cb?: (err: any, data?: DeleteNamespaceCommandOutput) => void - ): Promise | void { - const command = new DeleteNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a specified service. If the service still contains one or more registered instances, - * the request fails.

+ * @see {@link DeleteServiceCommand} */ - public deleteService( - args: DeleteServiceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteService( - args: DeleteServiceCommandInput, - cb: (err: any, data?: DeleteServiceCommandOutput) => void - ): void; - public deleteService( + deleteService(args: DeleteServiceCommandInput, options?: __HttpHandlerOptions): Promise; + deleteService(args: DeleteServiceCommandInput, cb: (err: any, data?: DeleteServiceCommandOutput) => void): void; + deleteService( args: DeleteServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceCommandOutput) => void ): void; - public deleteService( - args: DeleteServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteServiceCommandOutput) => void), - cb?: (err: any, data?: DeleteServiceCommandOutput) => void - ): Promise | void { - const command = new DeleteServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the - * specified instance.

+ * @see {@link DeregisterInstanceCommand} */ - public deregisterInstance( + deregisterInstance( args: DeregisterInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterInstance( + deregisterInstance( args: DeregisterInstanceCommandInput, cb: (err: any, data?: DeregisterInstanceCommandOutput) => void ): void; - public deregisterInstance( + deregisterInstance( args: DeregisterInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterInstanceCommandOutput) => void ): void; - public deregisterInstance( - args: DeregisterInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterInstanceCommandOutput) => void), - cb?: (err: any, data?: DeregisterInstanceCommandOutput) => void - ): Promise | void { - const command = new DeregisterInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Discovers registered instances for a specified namespace and service. You can use - * DiscoverInstances to discover instances for any type of namespace. For public and - * private DNS namespaces, you can also use DNS queries to discover instances.

+ * @see {@link DiscoverInstancesCommand} */ - public discoverInstances( + discoverInstances( args: DiscoverInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public discoverInstances( + discoverInstances( args: DiscoverInstancesCommandInput, cb: (err: any, data?: DiscoverInstancesCommandOutput) => void ): void; - public discoverInstances( + discoverInstances( args: DiscoverInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DiscoverInstancesCommandOutput) => void ): void; - public discoverInstances( - args: DiscoverInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DiscoverInstancesCommandOutput) => void), - cb?: (err: any, data?: DiscoverInstancesCommandOutput) => void - ): Promise | void { - const command = new DiscoverInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a specified instance.

+ * @see {@link GetInstanceCommand} */ - public getInstance(args: GetInstanceCommandInput, options?: __HttpHandlerOptions): Promise; - public getInstance(args: GetInstanceCommandInput, cb: (err: any, data?: GetInstanceCommandOutput) => void): void; - public getInstance( + getInstance(args: GetInstanceCommandInput, options?: __HttpHandlerOptions): Promise; + getInstance(args: GetInstanceCommandInput, cb: (err: any, data?: GetInstanceCommandOutput) => void): void; + getInstance( args: GetInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInstanceCommandOutput) => void ): void; - public getInstance( - args: GetInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInstanceCommandOutput) => void), - cb?: (err: any, data?: GetInstanceCommandOutput) => void - ): Promise | void { - const command = new GetInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the current health status (Healthy, Unhealthy, or - * Unknown) of one or more instances that are associated with a specified - * service.

- * - *

There's a brief delay between when you register an instance and when the health status for - * the instance is available.

- *
+ * @see {@link GetInstancesHealthStatusCommand} */ - public getInstancesHealthStatus( + getInstancesHealthStatus( args: GetInstancesHealthStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInstancesHealthStatus( + getInstancesHealthStatus( args: GetInstancesHealthStatusCommandInput, cb: (err: any, data?: GetInstancesHealthStatusCommandOutput) => void ): void; - public getInstancesHealthStatus( + getInstancesHealthStatus( args: GetInstancesHealthStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInstancesHealthStatusCommandOutput) => void ): void; - public getInstancesHealthStatus( - args: GetInstancesHealthStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInstancesHealthStatusCommandOutput) => void), - cb?: (err: any, data?: GetInstancesHealthStatusCommandOutput) => void - ): Promise | void { - const command = new GetInstancesHealthStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about a namespace.

+ * @see {@link GetNamespaceCommand} */ - public getNamespace( - args: GetNamespaceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getNamespace(args: GetNamespaceCommandInput, cb: (err: any, data?: GetNamespaceCommandOutput) => void): void; - public getNamespace( + getNamespace(args: GetNamespaceCommandInput, options?: __HttpHandlerOptions): Promise; + getNamespace(args: GetNamespaceCommandInput, cb: (err: any, data?: GetNamespaceCommandOutput) => void): void; + getNamespace( args: GetNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNamespaceCommandOutput) => void ): void; - public getNamespace( - args: GetNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetNamespaceCommandOutput) => void), - cb?: (err: any, data?: GetNamespaceCommandOutput) => void - ): Promise | void { - const command = new GetNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about any operation that returns an operation ID in the response, such as a - * CreateService request.

- * - *

To get a list of operations that match specified criteria, see ListOperations.

- *
+ * @see {@link GetOperationCommand} */ - public getOperation( - args: GetOperationCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getOperation(args: GetOperationCommandInput, cb: (err: any, data?: GetOperationCommandOutput) => void): void; - public getOperation( + getOperation(args: GetOperationCommandInput, options?: __HttpHandlerOptions): Promise; + getOperation(args: GetOperationCommandInput, cb: (err: any, data?: GetOperationCommandOutput) => void): void; + getOperation( args: GetOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOperationCommandOutput) => void ): void; - public getOperation( - args: GetOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOperationCommandOutput) => void), - cb?: (err: any, data?: GetOperationCommandOutput) => void - ): Promise | void { - const command = new GetOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the settings for a specified service.

+ * @see {@link GetServiceCommand} */ - public getService(args: GetServiceCommandInput, options?: __HttpHandlerOptions): Promise; - public getService(args: GetServiceCommandInput, cb: (err: any, data?: GetServiceCommandOutput) => void): void; - public getService( + getService(args: GetServiceCommandInput, options?: __HttpHandlerOptions): Promise; + getService(args: GetServiceCommandInput, cb: (err: any, data?: GetServiceCommandOutput) => void): void; + getService( args: GetServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceCommandOutput) => void ): void; - public getService( - args: GetServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceCommandOutput) => void), - cb?: (err: any, data?: GetServiceCommandOutput) => void - ): Promise | void { - const command = new GetServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists summary information about the instances that you registered by using a specified - * service.

+ * @see {@link ListInstancesCommand} */ - public listInstances( - args: ListInstancesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listInstances( - args: ListInstancesCommandInput, - cb: (err: any, data?: ListInstancesCommandOutput) => void - ): void; - public listInstances( + listInstances(args: ListInstancesCommandInput, options?: __HttpHandlerOptions): Promise; + listInstances(args: ListInstancesCommandInput, cb: (err: any, data?: ListInstancesCommandOutput) => void): void; + listInstances( args: ListInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInstancesCommandOutput) => void ): void; - public listInstances( - args: ListInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInstancesCommandOutput) => void), - cb?: (err: any, data?: ListInstancesCommandOutput) => void - ): Promise | void { - const command = new ListInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists summary information about the namespaces that were created by the current Amazon Web Services account.

+ * @see {@link ListNamespacesCommand} */ - public listNamespaces( + listNamespaces( args: ListNamespacesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listNamespaces( - args: ListNamespacesCommandInput, - cb: (err: any, data?: ListNamespacesCommandOutput) => void - ): void; - public listNamespaces( + listNamespaces(args: ListNamespacesCommandInput, cb: (err: any, data?: ListNamespacesCommandOutput) => void): void; + listNamespaces( args: ListNamespacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNamespacesCommandOutput) => void ): void; - public listNamespaces( - args: ListNamespacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNamespacesCommandOutput) => void), - cb?: (err: any, data?: ListNamespacesCommandOutput) => void - ): Promise | void { - const command = new ListNamespacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists operations that match the criteria that you specify.

+ * @see {@link ListOperationsCommand} */ - public listOperations( + listOperations( args: ListOperationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOperations( - args: ListOperationsCommandInput, - cb: (err: any, data?: ListOperationsCommandOutput) => void - ): void; - public listOperations( + listOperations(args: ListOperationsCommandInput, cb: (err: any, data?: ListOperationsCommandOutput) => void): void; + listOperations( args: ListOperationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOperationsCommandOutput) => void ): void; - public listOperations( - args: ListOperationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOperationsCommandOutput) => void), - cb?: (err: any, data?: ListOperationsCommandOutput) => void - ): Promise | void { - const command = new ListOperationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists summary information for all the services that are associated with one or more - * specified namespaces.

+ * @see {@link ListServicesCommand} */ - public listServices( - args: ListServicesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listServices(args: ListServicesCommandInput, cb: (err: any, data?: ListServicesCommandOutput) => void): void; - public listServices( + listServices(args: ListServicesCommandInput, options?: __HttpHandlerOptions): Promise; + listServices(args: ListServicesCommandInput, cb: (err: any, data?: ListServicesCommandOutput) => void): void; + listServices( args: ListServicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServicesCommandOutput) => void ): void; - public listServices( - args: ListServicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServicesCommandOutput) => void), - cb?: (err: any, data?: ListServicesCommandOutput) => void - ): Promise | void { - const command = new ListServicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists tags for the specified resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates one or more records and, optionally, creates a health check based on the - * settings in a specified service. When you submit a RegisterInstance request, the - * following occurs:

- *
    - *
  • - *

    For each DNS record that you define in the service that's specified by - * ServiceId, a record is created or updated in the hosted zone that's associated - * with the corresponding namespace.

    - *
  • - *
  • - *

    If the service includes HealthCheckConfig, a health check is created based on - * the settings in the health check configuration.

    - *
  • - *
  • - *

    The health check, if any, is associated with each of the new or updated records.

    - *
  • - *
- * - *

One RegisterInstance request must complete before you can submit another - * request and specify the same service ID and instance ID.

- *
- *

For more information, see CreateService.

- *

When Cloud Map receives a DNS query for the specified DNS name, it returns the applicable - * value:

- *
    - *
  • - *

    - * If the health check is healthy: returns all the - * records

    - *
  • - *
  • - *

    - * If the health check is unhealthy: returns the applicable - * value for the last healthy instance

    - *
  • - *
  • - *

    - * If you didn't specify a health check configuration: - * returns all the records

    - *
  • - *
- *

For the current quota on the number of instances that you can register using the same - * namespace and using the same service, see Cloud Map quotas in the - * Cloud Map Developer Guide.

+ * @see {@link RegisterInstanceCommand} */ - public registerInstance( + registerInstance( args: RegisterInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerInstance( + registerInstance( args: RegisterInstanceCommandInput, cb: (err: any, data?: RegisterInstanceCommandOutput) => void ): void; - public registerInstance( + registerInstance( args: RegisterInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterInstanceCommandOutput) => void ): void; - public registerInstance( - args: RegisterInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterInstanceCommandOutput) => void), - cb?: (err: any, data?: RegisterInstanceCommandOutput) => void - ): Promise | void { - const command = new RegisterInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more tags to the specified resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from the specified resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an HTTP - * namespace.

+ * @see {@link UpdateHttpNamespaceCommand} */ - public updateHttpNamespace( + updateHttpNamespace( args: UpdateHttpNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateHttpNamespace( + updateHttpNamespace( args: UpdateHttpNamespaceCommandInput, cb: (err: any, data?: UpdateHttpNamespaceCommandOutput) => void ): void; - public updateHttpNamespace( + updateHttpNamespace( args: UpdateHttpNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateHttpNamespaceCommandOutput) => void ): void; - public updateHttpNamespace( - args: UpdateHttpNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateHttpNamespaceCommandOutput) => void), - cb?: (err: any, data?: UpdateHttpNamespaceCommandOutput) => void - ): Promise | void { - const command = new UpdateHttpNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Submits a request to change the health status of a custom health check to healthy or - * unhealthy.

- *

You can use UpdateInstanceCustomHealthStatus to change the status only for - * custom health checks, which you define using HealthCheckCustomConfig when you create - * a service. You can't use it to change the status for Route 53 health checks, which you define using - * HealthCheckConfig.

- *

For more information, see HealthCheckCustomConfig.

+ * @see {@link UpdateInstanceCustomHealthStatusCommand} */ - public updateInstanceCustomHealthStatus( + updateInstanceCustomHealthStatus( args: UpdateInstanceCustomHealthStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateInstanceCustomHealthStatus( + updateInstanceCustomHealthStatus( args: UpdateInstanceCustomHealthStatusCommandInput, cb: (err: any, data?: UpdateInstanceCustomHealthStatusCommandOutput) => void ): void; - public updateInstanceCustomHealthStatus( + updateInstanceCustomHealthStatus( args: UpdateInstanceCustomHealthStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateInstanceCustomHealthStatusCommandOutput) => void ): void; - public updateInstanceCustomHealthStatus( - args: UpdateInstanceCustomHealthStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateInstanceCustomHealthStatusCommandOutput) => void), - cb?: (err: any, data?: UpdateInstanceCustomHealthStatusCommandOutput) => void - ): Promise | void { - const command = new UpdateInstanceCustomHealthStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a private DNS - * namespace.

+ * @see {@link UpdatePrivateDnsNamespaceCommand} */ - public updatePrivateDnsNamespace( + updatePrivateDnsNamespace( args: UpdatePrivateDnsNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePrivateDnsNamespace( + updatePrivateDnsNamespace( args: UpdatePrivateDnsNamespaceCommandInput, cb: (err: any, data?: UpdatePrivateDnsNamespaceCommandOutput) => void ): void; - public updatePrivateDnsNamespace( + updatePrivateDnsNamespace( args: UpdatePrivateDnsNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePrivateDnsNamespaceCommandOutput) => void ): void; - public updatePrivateDnsNamespace( - args: UpdatePrivateDnsNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePrivateDnsNamespaceCommandOutput) => void), - cb?: (err: any, data?: UpdatePrivateDnsNamespaceCommandOutput) => void - ): Promise | void { - const command = new UpdatePrivateDnsNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a public DNS - * namespace.

+ * @see {@link UpdatePublicDnsNamespaceCommand} */ - public updatePublicDnsNamespace( + updatePublicDnsNamespace( args: UpdatePublicDnsNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePublicDnsNamespace( + updatePublicDnsNamespace( args: UpdatePublicDnsNamespaceCommandInput, cb: (err: any, data?: UpdatePublicDnsNamespaceCommandOutput) => void ): void; - public updatePublicDnsNamespace( + updatePublicDnsNamespace( args: UpdatePublicDnsNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePublicDnsNamespaceCommandOutput) => void ): void; - public updatePublicDnsNamespace( - args: UpdatePublicDnsNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePublicDnsNamespaceCommandOutput) => void), - cb?: (err: any, data?: UpdatePublicDnsNamespaceCommandOutput) => void - ): Promise | void { - const command = new UpdatePublicDnsNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Submits a request to perform the following operations:

- *
    - *
  • - *

    Update the TTL setting for existing DnsRecords configurations

    - *
  • - *
  • - *

    Add, update, or delete HealthCheckConfig for a specified service

    - * - *

    You can't add, update, or delete a HealthCheckCustomConfig - * configuration.

    - *
    - *
  • - *
- *

For public and private DNS namespaces, note the following:

- *
    - *
  • - *

    If you omit any existing DnsRecords or HealthCheckConfig - * configurations from an UpdateService request, the configurations are deleted from - * the service.

    - *
  • - *
  • - *

    If you omit an existing HealthCheckCustomConfig configuration from an - * UpdateService request, the configuration isn't deleted from the service.

    - *
  • - *
- *

When you update settings for a service, Cloud Map also updates the corresponding settings - * in all the records and health checks that were created by using the specified service.

+ * @see {@link UpdateServiceCommand} */ - public updateService( - args: UpdateServiceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateService( - args: UpdateServiceCommandInput, - cb: (err: any, data?: UpdateServiceCommandOutput) => void - ): void; - public updateService( + updateService(args: UpdateServiceCommandInput, options?: __HttpHandlerOptions): Promise; + updateService(args: UpdateServiceCommandInput, cb: (err: any, data?: UpdateServiceCommandOutput) => void): void; + updateService( args: UpdateServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceCommandOutput) => void ): void; - public updateService( - args: UpdateServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServiceCommandOutput) => void), - cb?: (err: any, data?: UpdateServiceCommandOutput) => void - ): Promise | void { - const command = new UpdateServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Cloud Map + *

With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your + * microservice applications run in. When an instance becomes available, you can call the Cloud Map + * API to register the instance with Cloud Map. For public or private DNS namespaces, Cloud Map + * automatically creates DNS records and an optional health check. Clients that submit public or + * private DNS queries, or HTTP requests, for the service receive an answer that contains up to + * eight healthy records.

+ */ +export class ServiceDiscovery extends ServiceDiscoveryClient implements ServiceDiscovery {} +createAggregatedClient(commands, ServiceDiscovery); diff --git a/clients/client-ses/src/SES.ts b/clients/client-ses/src/SES.ts index 822b37dc0719..63222a2913d9 100644 --- a/clients/client-ses/src/SES.ts +++ b/clients/client-ses/src/SES.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -344,2973 +345,1251 @@ import { VerifyEmailIdentityCommandInput, VerifyEmailIdentityCommandOutput, } from "./commands/VerifyEmailIdentityCommand"; -import { SESClient } from "./SESClient"; +import { SESClient, SESClientConfig } from "./SESClient"; -/** - * @public - * Amazon Simple Email Service - *

This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version - * 2010-12-01. This document is best used in conjunction with the Amazon SES Developer - * Guide.

- * - *

For a list of Amazon SES endpoints to use in service requests, see Regions and - * Amazon SES in the Amazon SES Developer - * Guide.

- *
- */ -export class SES extends SESClient { +const commands = { + CloneReceiptRuleSetCommand, + CreateConfigurationSetCommand, + CreateConfigurationSetEventDestinationCommand, + CreateConfigurationSetTrackingOptionsCommand, + CreateCustomVerificationEmailTemplateCommand, + CreateReceiptFilterCommand, + CreateReceiptRuleCommand, + CreateReceiptRuleSetCommand, + CreateTemplateCommand, + DeleteConfigurationSetCommand, + DeleteConfigurationSetEventDestinationCommand, + DeleteConfigurationSetTrackingOptionsCommand, + DeleteCustomVerificationEmailTemplateCommand, + DeleteIdentityCommand, + DeleteIdentityPolicyCommand, + DeleteReceiptFilterCommand, + DeleteReceiptRuleCommand, + DeleteReceiptRuleSetCommand, + DeleteTemplateCommand, + DeleteVerifiedEmailAddressCommand, + DescribeActiveReceiptRuleSetCommand, + DescribeConfigurationSetCommand, + DescribeReceiptRuleCommand, + DescribeReceiptRuleSetCommand, + GetAccountSendingEnabledCommand, + GetCustomVerificationEmailTemplateCommand, + GetIdentityDkimAttributesCommand, + GetIdentityMailFromDomainAttributesCommand, + GetIdentityNotificationAttributesCommand, + GetIdentityPoliciesCommand, + GetIdentityVerificationAttributesCommand, + GetSendQuotaCommand, + GetSendStatisticsCommand, + GetTemplateCommand, + ListConfigurationSetsCommand, + ListCustomVerificationEmailTemplatesCommand, + ListIdentitiesCommand, + ListIdentityPoliciesCommand, + ListReceiptFiltersCommand, + ListReceiptRuleSetsCommand, + ListTemplatesCommand, + ListVerifiedEmailAddressesCommand, + PutConfigurationSetDeliveryOptionsCommand, + PutIdentityPolicyCommand, + ReorderReceiptRuleSetCommand, + SendBounceCommand, + SendBulkTemplatedEmailCommand, + SendCustomVerificationEmailCommand, + SendEmailCommand, + SendRawEmailCommand, + SendTemplatedEmailCommand, + SetActiveReceiptRuleSetCommand, + SetIdentityDkimEnabledCommand, + SetIdentityFeedbackForwardingEnabledCommand, + SetIdentityHeadersInNotificationsEnabledCommand, + SetIdentityMailFromDomainCommand, + SetIdentityNotificationTopicCommand, + SetReceiptRulePositionCommand, + TestRenderTemplateCommand, + UpdateAccountSendingEnabledCommand, + UpdateConfigurationSetEventDestinationCommand, + UpdateConfigurationSetReputationMetricsEnabledCommand, + UpdateConfigurationSetSendingEnabledCommand, + UpdateConfigurationSetTrackingOptionsCommand, + UpdateCustomVerificationEmailTemplateCommand, + UpdateReceiptRuleCommand, + UpdateTemplateCommand, + VerifyDomainDkimCommand, + VerifyDomainIdentityCommand, + VerifyEmailAddressCommand, + VerifyEmailIdentityCommand, +}; + +export interface SES { /** - * @public - *

Creates a receipt rule set by cloning an existing one. All receipt rules and - * configurations are copied to the new receipt rule set and are completely independent of - * the source rule set.

- *

For information about setting up rule sets, see the Amazon SES - * Developer Guide.

- *

You can execute this operation no more than once per second.

+ * @see {@link CloneReceiptRuleSetCommand} */ - public cloneReceiptRuleSet( + cloneReceiptRuleSet( args: CloneReceiptRuleSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public cloneReceiptRuleSet( + cloneReceiptRuleSet( args: CloneReceiptRuleSetCommandInput, cb: (err: any, data?: CloneReceiptRuleSetCommandOutput) => void ): void; - public cloneReceiptRuleSet( + cloneReceiptRuleSet( args: CloneReceiptRuleSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CloneReceiptRuleSetCommandOutput) => void ): void; - public cloneReceiptRuleSet( - args: CloneReceiptRuleSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CloneReceiptRuleSetCommandOutput) => void), - cb?: (err: any, data?: CloneReceiptRuleSetCommandOutput) => void - ): Promise | void { - const command = new CloneReceiptRuleSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a configuration set.

- *

Configuration sets enable you to publish email sending events. For information about - * using configuration sets, see the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public createConfigurationSet( + + /** + * @see {@link CreateConfigurationSetCommand} + */ + createConfigurationSet( args: CreateConfigurationSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConfigurationSet( + createConfigurationSet( args: CreateConfigurationSetCommandInput, cb: (err: any, data?: CreateConfigurationSetCommandOutput) => void ): void; - public createConfigurationSet( + createConfigurationSet( args: CreateConfigurationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfigurationSetCommandOutput) => void ): void; - public createConfigurationSet( - args: CreateConfigurationSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConfigurationSetCommandOutput) => void), - cb?: (err: any, data?: CreateConfigurationSetCommandOutput) => void - ): Promise | void { - const command = new CreateConfigurationSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a configuration set event destination.

- * - *

When you create or update an event destination, you must provide one, and only - * one, destination. The destination can be CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).

- *
- *

An event destination is the AWS service to which Amazon SES publishes the email sending - * events associated with a configuration set. For information about using configuration - * sets, see the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public createConfigurationSetEventDestination( + + /** + * @see {@link CreateConfigurationSetEventDestinationCommand} + */ + createConfigurationSetEventDestination( args: CreateConfigurationSetEventDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConfigurationSetEventDestination( + createConfigurationSetEventDestination( args: CreateConfigurationSetEventDestinationCommandInput, cb: (err: any, data?: CreateConfigurationSetEventDestinationCommandOutput) => void ): void; - public createConfigurationSetEventDestination( + createConfigurationSetEventDestination( args: CreateConfigurationSetEventDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfigurationSetEventDestinationCommandOutput) => void ): void; - public createConfigurationSetEventDestination( - args: CreateConfigurationSetEventDestinationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateConfigurationSetEventDestinationCommandOutput) => void), - cb?: (err: any, data?: CreateConfigurationSetEventDestinationCommandOutput) => void - ): Promise | void { - const command = new CreateConfigurationSetEventDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an association between a configuration set and a custom domain for open and - * click event tracking.

- *

By default, images and links used for tracking open and click events are hosted on - * domains operated by Amazon SES. You can configure a subdomain of your own to handle these - * events. For information about using custom domains, see the Amazon SES Developer Guide.

- */ - public createConfigurationSetTrackingOptions( + + /** + * @see {@link CreateConfigurationSetTrackingOptionsCommand} + */ + createConfigurationSetTrackingOptions( args: CreateConfigurationSetTrackingOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConfigurationSetTrackingOptions( + createConfigurationSetTrackingOptions( args: CreateConfigurationSetTrackingOptionsCommandInput, cb: (err: any, data?: CreateConfigurationSetTrackingOptionsCommandOutput) => void ): void; - public createConfigurationSetTrackingOptions( + createConfigurationSetTrackingOptions( args: CreateConfigurationSetTrackingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfigurationSetTrackingOptionsCommandOutput) => void ): void; - public createConfigurationSetTrackingOptions( - args: CreateConfigurationSetTrackingOptionsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateConfigurationSetTrackingOptionsCommandOutput) => void), - cb?: (err: any, data?: CreateConfigurationSetTrackingOptionsCommandOutput) => void - ): Promise | void { - const command = new CreateConfigurationSetTrackingOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new custom verification email template.

- *

For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public createCustomVerificationEmailTemplate( + + /** + * @see {@link CreateCustomVerificationEmailTemplateCommand} + */ + createCustomVerificationEmailTemplate( args: CreateCustomVerificationEmailTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCustomVerificationEmailTemplate( + createCustomVerificationEmailTemplate( args: CreateCustomVerificationEmailTemplateCommandInput, cb: (err: any, data?: CreateCustomVerificationEmailTemplateCommandOutput) => void ): void; - public createCustomVerificationEmailTemplate( + createCustomVerificationEmailTemplate( args: CreateCustomVerificationEmailTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomVerificationEmailTemplateCommandOutput) => void ): void; - public createCustomVerificationEmailTemplate( - args: CreateCustomVerificationEmailTemplateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateCustomVerificationEmailTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateCustomVerificationEmailTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateCustomVerificationEmailTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new IP address filter.

- *

For information about setting up IP address filters, see the Amazon SES Developer Guide.

- *

You can execute this operation no more than once per second.

- */ - public createReceiptFilter( + + /** + * @see {@link CreateReceiptFilterCommand} + */ + createReceiptFilter( args: CreateReceiptFilterCommandInput, options?: __HttpHandlerOptions ): Promise; - public createReceiptFilter( + createReceiptFilter( args: CreateReceiptFilterCommandInput, cb: (err: any, data?: CreateReceiptFilterCommandOutput) => void ): void; - public createReceiptFilter( + createReceiptFilter( args: CreateReceiptFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReceiptFilterCommandOutput) => void ): void; - public createReceiptFilter( - args: CreateReceiptFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateReceiptFilterCommandOutput) => void), - cb?: (err: any, data?: CreateReceiptFilterCommandOutput) => void - ): Promise | void { - const command = new CreateReceiptFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a receipt rule.

- *

For information about setting up receipt rules, see the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public createReceiptRule( + + /** + * @see {@link CreateReceiptRuleCommand} + */ + createReceiptRule( args: CreateReceiptRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createReceiptRule( + createReceiptRule( args: CreateReceiptRuleCommandInput, cb: (err: any, data?: CreateReceiptRuleCommandOutput) => void ): void; - public createReceiptRule( + createReceiptRule( args: CreateReceiptRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReceiptRuleCommandOutput) => void ): void; - public createReceiptRule( - args: CreateReceiptRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateReceiptRuleCommandOutput) => void), - cb?: (err: any, data?: CreateReceiptRuleCommandOutput) => void - ): Promise | void { - const command = new CreateReceiptRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an empty receipt rule set.

- *

For information about setting up receipt rule sets, see the Amazon SES - * Developer Guide.

- *

You can execute this operation no more than once per second.

- */ - public createReceiptRuleSet( + + /** + * @see {@link CreateReceiptRuleSetCommand} + */ + createReceiptRuleSet( args: CreateReceiptRuleSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createReceiptRuleSet( + createReceiptRuleSet( args: CreateReceiptRuleSetCommandInput, cb: (err: any, data?: CreateReceiptRuleSetCommandOutput) => void ): void; - public createReceiptRuleSet( + createReceiptRuleSet( args: CreateReceiptRuleSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReceiptRuleSetCommandOutput) => void ): void; - public createReceiptRuleSet( - args: CreateReceiptRuleSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateReceiptRuleSetCommandOutput) => void), - cb?: (err: any, data?: CreateReceiptRuleSetCommandOutput) => void - ): Promise | void { - const command = new CreateReceiptRuleSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an email template. Email templates enable you to send personalized email to - * one or more destinations in a single API operation. For more information, see the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public createTemplate( + + /** + * @see {@link CreateTemplateCommand} + */ + createTemplate( args: CreateTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTemplate( - args: CreateTemplateCommandInput, - cb: (err: any, data?: CreateTemplateCommandOutput) => void - ): void; - public createTemplate( + createTemplate(args: CreateTemplateCommandInput, cb: (err: any, data?: CreateTemplateCommandOutput) => void): void; + createTemplate( args: CreateTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTemplateCommandOutput) => void ): void; - public createTemplate( - args: CreateTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a configuration set. Configuration sets enable you to publish email sending - * events. For information about using configuration sets, see the Amazon SES Developer Guide.

- *

You can execute this operation no more than once per second.

- */ - public deleteConfigurationSet( + + /** + * @see {@link DeleteConfigurationSetCommand} + */ + deleteConfigurationSet( args: DeleteConfigurationSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConfigurationSet( + deleteConfigurationSet( args: DeleteConfigurationSetCommandInput, cb: (err: any, data?: DeleteConfigurationSetCommandOutput) => void ): void; - public deleteConfigurationSet( + deleteConfigurationSet( args: DeleteConfigurationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationSetCommandOutput) => void ): void; - public deleteConfigurationSet( - args: DeleteConfigurationSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConfigurationSetCommandOutput) => void), - cb?: (err: any, data?: DeleteConfigurationSetCommandOutput) => void - ): Promise | void { - const command = new DeleteConfigurationSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a configuration set event destination. Configuration set event destinations - * are associated with configuration sets, which enable you to publish email sending - * events. For information about using configuration sets, see the Amazon SES Developer Guide.

- *

You can execute this operation no more than once per second.

- */ - public deleteConfigurationSetEventDestination( + + /** + * @see {@link DeleteConfigurationSetEventDestinationCommand} + */ + deleteConfigurationSetEventDestination( args: DeleteConfigurationSetEventDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConfigurationSetEventDestination( + deleteConfigurationSetEventDestination( args: DeleteConfigurationSetEventDestinationCommandInput, cb: (err: any, data?: DeleteConfigurationSetEventDestinationCommandOutput) => void ): void; - public deleteConfigurationSetEventDestination( + deleteConfigurationSetEventDestination( args: DeleteConfigurationSetEventDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationSetEventDestinationCommandOutput) => void ): void; - public deleteConfigurationSetEventDestination( - args: DeleteConfigurationSetEventDestinationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteConfigurationSetEventDestinationCommandOutput) => void), - cb?: (err: any, data?: DeleteConfigurationSetEventDestinationCommandOutput) => void - ): Promise | void { - const command = new DeleteConfigurationSetEventDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an association between a configuration set and a custom domain for open and - * click event tracking.

- *

By default, images and links used for tracking open and click events are hosted on - * domains operated by Amazon SES. You can configure a subdomain of your own to handle these - * events. For information about using custom domains, see the Amazon SES Developer Guide.

- * - *

Deleting this kind of association will result in emails sent using the specified - * configuration set to capture open and click events using the standard, - * Amazon SES-operated domains.

- *
- */ - public deleteConfigurationSetTrackingOptions( + + /** + * @see {@link DeleteConfigurationSetTrackingOptionsCommand} + */ + deleteConfigurationSetTrackingOptions( args: DeleteConfigurationSetTrackingOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConfigurationSetTrackingOptions( + deleteConfigurationSetTrackingOptions( args: DeleteConfigurationSetTrackingOptionsCommandInput, cb: (err: any, data?: DeleteConfigurationSetTrackingOptionsCommandOutput) => void ): void; - public deleteConfigurationSetTrackingOptions( + deleteConfigurationSetTrackingOptions( args: DeleteConfigurationSetTrackingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationSetTrackingOptionsCommandOutput) => void ): void; - public deleteConfigurationSetTrackingOptions( - args: DeleteConfigurationSetTrackingOptionsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteConfigurationSetTrackingOptionsCommandOutput) => void), - cb?: (err: any, data?: DeleteConfigurationSetTrackingOptionsCommandOutput) => void - ): Promise | void { - const command = new DeleteConfigurationSetTrackingOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an existing custom verification email template.

- *

For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public deleteCustomVerificationEmailTemplate( + + /** + * @see {@link DeleteCustomVerificationEmailTemplateCommand} + */ + deleteCustomVerificationEmailTemplate( args: DeleteCustomVerificationEmailTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCustomVerificationEmailTemplate( + deleteCustomVerificationEmailTemplate( args: DeleteCustomVerificationEmailTemplateCommandInput, cb: (err: any, data?: DeleteCustomVerificationEmailTemplateCommandOutput) => void ): void; - public deleteCustomVerificationEmailTemplate( + deleteCustomVerificationEmailTemplate( args: DeleteCustomVerificationEmailTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomVerificationEmailTemplateCommandOutput) => void ): void; - public deleteCustomVerificationEmailTemplate( - args: DeleteCustomVerificationEmailTemplateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteCustomVerificationEmailTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteCustomVerificationEmailTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteCustomVerificationEmailTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified identity (an email address or a domain) from the list of - * verified identities.

- *

You can execute this operation no more than once per second.

- */ - public deleteIdentity( + + /** + * @see {@link DeleteIdentityCommand} + */ + deleteIdentity( args: DeleteIdentityCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteIdentity( - args: DeleteIdentityCommandInput, - cb: (err: any, data?: DeleteIdentityCommandOutput) => void - ): void; - public deleteIdentity( + deleteIdentity(args: DeleteIdentityCommandInput, cb: (err: any, data?: DeleteIdentityCommandOutput) => void): void; + deleteIdentity( args: DeleteIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIdentityCommandOutput) => void ): void; - public deleteIdentity( - args: DeleteIdentityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIdentityCommandOutput) => void), - cb?: (err: any, data?: DeleteIdentityCommandOutput) => void - ): Promise | void { - const command = new DeleteIdentityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified sending authorization policy for the given identity (an email - * address or a domain). This API returns successfully even if a policy with the specified - * name does not exist.

- * - *

This API is for the identity owner only. If you have not verified the identity, - * this API will return an error.

- *
- *

Sending authorization is a feature that enables an identity owner to authorize other - * senders to use its identities. For information about using sending authorization, see - * the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public deleteIdentityPolicy( + + /** + * @see {@link DeleteIdentityPolicyCommand} + */ + deleteIdentityPolicy( args: DeleteIdentityPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteIdentityPolicy( + deleteIdentityPolicy( args: DeleteIdentityPolicyCommandInput, cb: (err: any, data?: DeleteIdentityPolicyCommandOutput) => void ): void; - public deleteIdentityPolicy( + deleteIdentityPolicy( args: DeleteIdentityPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIdentityPolicyCommandOutput) => void ): void; - public deleteIdentityPolicy( - args: DeleteIdentityPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIdentityPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteIdentityPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteIdentityPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified IP address filter.

- *

For information about managing IP address filters, see the Amazon SES - * Developer Guide.

- *

You can execute this operation no more than once per second.

- */ - public deleteReceiptFilter( + + /** + * @see {@link DeleteReceiptFilterCommand} + */ + deleteReceiptFilter( args: DeleteReceiptFilterCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteReceiptFilter( + deleteReceiptFilter( args: DeleteReceiptFilterCommandInput, cb: (err: any, data?: DeleteReceiptFilterCommandOutput) => void ): void; - public deleteReceiptFilter( + deleteReceiptFilter( args: DeleteReceiptFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReceiptFilterCommandOutput) => void ): void; - public deleteReceiptFilter( - args: DeleteReceiptFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteReceiptFilterCommandOutput) => void), - cb?: (err: any, data?: DeleteReceiptFilterCommandOutput) => void - ): Promise | void { - const command = new DeleteReceiptFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified receipt rule.

- *

For information about managing receipt rules, see the Amazon SES - * Developer Guide.

- *

You can execute this operation no more than once per second.

- */ - public deleteReceiptRule( + + /** + * @see {@link DeleteReceiptRuleCommand} + */ + deleteReceiptRule( args: DeleteReceiptRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteReceiptRule( + deleteReceiptRule( args: DeleteReceiptRuleCommandInput, cb: (err: any, data?: DeleteReceiptRuleCommandOutput) => void ): void; - public deleteReceiptRule( + deleteReceiptRule( args: DeleteReceiptRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReceiptRuleCommandOutput) => void ): void; - public deleteReceiptRule( - args: DeleteReceiptRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteReceiptRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteReceiptRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteReceiptRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified receipt rule set and all of the receipt rules it - * contains.

- * - *

The currently active rule set cannot be deleted.

- *
- *

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

- *

You can execute this operation no more than once per second.

- */ - public deleteReceiptRuleSet( + + /** + * @see {@link DeleteReceiptRuleSetCommand} + */ + deleteReceiptRuleSet( args: DeleteReceiptRuleSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteReceiptRuleSet( + deleteReceiptRuleSet( args: DeleteReceiptRuleSetCommandInput, cb: (err: any, data?: DeleteReceiptRuleSetCommandOutput) => void ): void; - public deleteReceiptRuleSet( + deleteReceiptRuleSet( args: DeleteReceiptRuleSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReceiptRuleSetCommandOutput) => void ): void; - public deleteReceiptRuleSet( - args: DeleteReceiptRuleSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteReceiptRuleSetCommandOutput) => void), - cb?: (err: any, data?: DeleteReceiptRuleSetCommandOutput) => void - ): Promise | void { - const command = new DeleteReceiptRuleSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an email template.

- *

You can execute this operation no more than once per second.

- */ - public deleteTemplate( + + /** + * @see {@link DeleteTemplateCommand} + */ + deleteTemplate( args: DeleteTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTemplate( - args: DeleteTemplateCommandInput, - cb: (err: any, data?: DeleteTemplateCommandOutput) => void - ): void; - public deleteTemplate( + deleteTemplate(args: DeleteTemplateCommandInput, cb: (err: any, data?: DeleteTemplateCommandOutput) => void): void; + deleteTemplate( args: DeleteTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTemplateCommandOutput) => void ): void; - public deleteTemplate( - args: DeleteTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deprecated. Use the DeleteIdentity operation to delete email addresses - * and domains.

- */ - public deleteVerifiedEmailAddress( + + /** + * @see {@link DeleteVerifiedEmailAddressCommand} + */ + deleteVerifiedEmailAddress( args: DeleteVerifiedEmailAddressCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVerifiedEmailAddress( + deleteVerifiedEmailAddress( args: DeleteVerifiedEmailAddressCommandInput, cb: (err: any, data?: DeleteVerifiedEmailAddressCommandOutput) => void ): void; - public deleteVerifiedEmailAddress( + deleteVerifiedEmailAddress( args: DeleteVerifiedEmailAddressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVerifiedEmailAddressCommandOutput) => void ): void; - public deleteVerifiedEmailAddress( - args: DeleteVerifiedEmailAddressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVerifiedEmailAddressCommandOutput) => void), - cb?: (err: any, data?: DeleteVerifiedEmailAddressCommandOutput) => void - ): Promise | void { - const command = new DeleteVerifiedEmailAddressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the metadata and receipt rules for the receipt rule set that is currently - * active.

- *

For information about setting up receipt rule sets, see the Amazon SES - * Developer Guide.

- *

You can execute this operation no more than once per second.

- */ - public describeActiveReceiptRuleSet( + + /** + * @see {@link DescribeActiveReceiptRuleSetCommand} + */ + describeActiveReceiptRuleSet( args: DescribeActiveReceiptRuleSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeActiveReceiptRuleSet( + describeActiveReceiptRuleSet( args: DescribeActiveReceiptRuleSetCommandInput, cb: (err: any, data?: DescribeActiveReceiptRuleSetCommandOutput) => void ): void; - public describeActiveReceiptRuleSet( + describeActiveReceiptRuleSet( args: DescribeActiveReceiptRuleSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeActiveReceiptRuleSetCommandOutput) => void ): void; - public describeActiveReceiptRuleSet( - args: DescribeActiveReceiptRuleSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeActiveReceiptRuleSetCommandOutput) => void), - cb?: (err: any, data?: DescribeActiveReceiptRuleSetCommandOutput) => void - ): Promise | void { - const command = new DescribeActiveReceiptRuleSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the details of the specified configuration set. For information about using - * configuration sets, see the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public describeConfigurationSet( + + /** + * @see {@link DescribeConfigurationSetCommand} + */ + describeConfigurationSet( args: DescribeConfigurationSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConfigurationSet( + describeConfigurationSet( args: DescribeConfigurationSetCommandInput, cb: (err: any, data?: DescribeConfigurationSetCommandOutput) => void ): void; - public describeConfigurationSet( + describeConfigurationSet( args: DescribeConfigurationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigurationSetCommandOutput) => void ): void; - public describeConfigurationSet( - args: DescribeConfigurationSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConfigurationSetCommandOutput) => void), - cb?: (err: any, data?: DescribeConfigurationSetCommandOutput) => void - ): Promise | void { - const command = new DescribeConfigurationSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the details of the specified receipt rule.

- *

For information about setting up receipt rules, see the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public describeReceiptRule( + + /** + * @see {@link DescribeReceiptRuleCommand} + */ + describeReceiptRule( args: DescribeReceiptRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReceiptRule( + describeReceiptRule( args: DescribeReceiptRuleCommandInput, cb: (err: any, data?: DescribeReceiptRuleCommandOutput) => void ): void; - public describeReceiptRule( + describeReceiptRule( args: DescribeReceiptRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReceiptRuleCommandOutput) => void ): void; - public describeReceiptRule( - args: DescribeReceiptRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReceiptRuleCommandOutput) => void), - cb?: (err: any, data?: DescribeReceiptRuleCommandOutput) => void - ): Promise | void { - const command = new DescribeReceiptRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the details of the specified receipt rule set.

- *

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

- *

You can execute this operation no more than once per second.

- */ - public describeReceiptRuleSet( + + /** + * @see {@link DescribeReceiptRuleSetCommand} + */ + describeReceiptRuleSet( args: DescribeReceiptRuleSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReceiptRuleSet( + describeReceiptRuleSet( args: DescribeReceiptRuleSetCommandInput, cb: (err: any, data?: DescribeReceiptRuleSetCommandOutput) => void ): void; - public describeReceiptRuleSet( + describeReceiptRuleSet( args: DescribeReceiptRuleSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReceiptRuleSetCommandOutput) => void ): void; - public describeReceiptRuleSet( - args: DescribeReceiptRuleSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReceiptRuleSetCommandOutput) => void), - cb?: (err: any, data?: DescribeReceiptRuleSetCommandOutput) => void - ): Promise | void { - const command = new DescribeReceiptRuleSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the email sending status of the Amazon SES account for the current region.

- *

You can execute this operation no more than once per second.

- */ - public getAccountSendingEnabled( + + /** + * @see {@link GetAccountSendingEnabledCommand} + */ + getAccountSendingEnabled( args: GetAccountSendingEnabledCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccountSendingEnabled( + getAccountSendingEnabled( args: GetAccountSendingEnabledCommandInput, cb: (err: any, data?: GetAccountSendingEnabledCommandOutput) => void ): void; - public getAccountSendingEnabled( + getAccountSendingEnabled( args: GetAccountSendingEnabledCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountSendingEnabledCommandOutput) => void ): void; - public getAccountSendingEnabled( - args: GetAccountSendingEnabledCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccountSendingEnabledCommandOutput) => void), - cb?: (err: any, data?: GetAccountSendingEnabledCommandOutput) => void - ): Promise | void { - const command = new GetAccountSendingEnabledCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the custom email verification template for the template name you - * specify.

- *

For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public getCustomVerificationEmailTemplate( + + /** + * @see {@link GetCustomVerificationEmailTemplateCommand} + */ + getCustomVerificationEmailTemplate( args: GetCustomVerificationEmailTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCustomVerificationEmailTemplate( + getCustomVerificationEmailTemplate( args: GetCustomVerificationEmailTemplateCommandInput, cb: (err: any, data?: GetCustomVerificationEmailTemplateCommandOutput) => void ): void; - public getCustomVerificationEmailTemplate( + getCustomVerificationEmailTemplate( args: GetCustomVerificationEmailTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCustomVerificationEmailTemplateCommandOutput) => void ): void; - public getCustomVerificationEmailTemplate( - args: GetCustomVerificationEmailTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCustomVerificationEmailTemplateCommandOutput) => void), - cb?: (err: any, data?: GetCustomVerificationEmailTemplateCommandOutput) => void - ): Promise | void { - const command = new GetCustomVerificationEmailTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the current status of Easy DKIM signing for an entity. For domain name - * identities, this operation also returns the DKIM tokens that are required for Easy DKIM - * signing, and whether Amazon SES has successfully verified that these tokens have been - * published.

- *

This operation takes a list of identities as input and returns the following - * information for each:

- *
    - *
  • - *

    Whether Easy DKIM signing is enabled or disabled.

    - *
  • - *
  • - *

    A set of DKIM tokens that represent the identity. If the identity is an email - * address, the tokens represent the domain of that address.

    - *
  • - *
  • - *

    Whether Amazon SES has successfully verified the DKIM tokens published in the - * domain's DNS. This information is only returned for domain name identities, not - * for email addresses.

    - *
  • - *
- *

This operation is throttled at one request per second and can only get DKIM attributes - * for up to 100 identities at a time.

- *

For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.

- */ - public getIdentityDkimAttributes( + + /** + * @see {@link GetIdentityDkimAttributesCommand} + */ + getIdentityDkimAttributes( args: GetIdentityDkimAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIdentityDkimAttributes( + getIdentityDkimAttributes( args: GetIdentityDkimAttributesCommandInput, cb: (err: any, data?: GetIdentityDkimAttributesCommandOutput) => void ): void; - public getIdentityDkimAttributes( + getIdentityDkimAttributes( args: GetIdentityDkimAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIdentityDkimAttributesCommandOutput) => void ): void; - public getIdentityDkimAttributes( - args: GetIdentityDkimAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIdentityDkimAttributesCommandOutput) => void), - cb?: (err: any, data?: GetIdentityDkimAttributesCommandOutput) => void - ): Promise | void { - const command = new GetIdentityDkimAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the custom MAIL FROM attributes for a list of identities (email addresses : - * domains).

- *

This operation is throttled at one request per second and can only get custom MAIL - * FROM attributes for up to 100 identities at a time.

- */ - public getIdentityMailFromDomainAttributes( + + /** + * @see {@link GetIdentityMailFromDomainAttributesCommand} + */ + getIdentityMailFromDomainAttributes( args: GetIdentityMailFromDomainAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIdentityMailFromDomainAttributes( + getIdentityMailFromDomainAttributes( args: GetIdentityMailFromDomainAttributesCommandInput, cb: (err: any, data?: GetIdentityMailFromDomainAttributesCommandOutput) => void ): void; - public getIdentityMailFromDomainAttributes( + getIdentityMailFromDomainAttributes( args: GetIdentityMailFromDomainAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIdentityMailFromDomainAttributesCommandOutput) => void ): void; - public getIdentityMailFromDomainAttributes( - args: GetIdentityMailFromDomainAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIdentityMailFromDomainAttributesCommandOutput) => void), - cb?: (err: any, data?: GetIdentityMailFromDomainAttributesCommandOutput) => void - ): Promise | void { - const command = new GetIdentityMailFromDomainAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Given a list of verified identities (email addresses and/or domains), returns a - * structure describing identity notification attributes.

- *

This operation is throttled at one request per second and can only get notification - * attributes for up to 100 identities at a time.

- *

For more information about using notifications with Amazon SES, see the Amazon SES - * Developer Guide.

- */ - public getIdentityNotificationAttributes( + + /** + * @see {@link GetIdentityNotificationAttributesCommand} + */ + getIdentityNotificationAttributes( args: GetIdentityNotificationAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIdentityNotificationAttributes( + getIdentityNotificationAttributes( args: GetIdentityNotificationAttributesCommandInput, cb: (err: any, data?: GetIdentityNotificationAttributesCommandOutput) => void ): void; - public getIdentityNotificationAttributes( + getIdentityNotificationAttributes( args: GetIdentityNotificationAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIdentityNotificationAttributesCommandOutput) => void ): void; - public getIdentityNotificationAttributes( - args: GetIdentityNotificationAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIdentityNotificationAttributesCommandOutput) => void), - cb?: (err: any, data?: GetIdentityNotificationAttributesCommandOutput) => void - ): Promise | void { - const command = new GetIdentityNotificationAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the requested sending authorization policies for the given identity (an email - * address or a domain). The policies are returned as a map of policy names to policy - * contents. You can retrieve a maximum of 20 policies at a time.

- * - *

This API is for the identity owner only. If you have not verified the identity, - * this API will return an error.

- *
- *

Sending authorization is a feature that enables an identity owner to authorize other - * senders to use its identities. For information about using sending authorization, see - * the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public getIdentityPolicies( + + /** + * @see {@link GetIdentityPoliciesCommand} + */ + getIdentityPolicies( args: GetIdentityPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIdentityPolicies( + getIdentityPolicies( args: GetIdentityPoliciesCommandInput, cb: (err: any, data?: GetIdentityPoliciesCommandOutput) => void ): void; - public getIdentityPolicies( + getIdentityPolicies( args: GetIdentityPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIdentityPoliciesCommandOutput) => void ): void; - public getIdentityPolicies( - args: GetIdentityPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIdentityPoliciesCommandOutput) => void), - cb?: (err: any, data?: GetIdentityPoliciesCommandOutput) => void - ): Promise | void { - const command = new GetIdentityPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Given a list of identities (email addresses and/or domains), returns the verification - * status and (for domain identities) the verification token for each identity.

- *

The verification status of an email address is "Pending" until the email address owner - * clicks the link within the verification email that Amazon SES sent to that address. If the - * email address owner clicks the link within 24 hours, the verification status of the - * email address changes to "Success". If the link is not clicked within 24 hours, the - * verification status changes to "Failed." In that case, if you still want to verify the - * email address, you must restart the verification process from the beginning.

- *

For domain identities, the domain's verification status is "Pending" as Amazon SES searches - * for the required TXT record in the DNS settings of the domain. When Amazon SES detects the - * record, the domain's verification status changes to "Success". If Amazon SES is unable to - * detect the record within 72 hours, the domain's verification status changes to "Failed." - * In that case, if you still want to verify the domain, you must restart the verification - * process from the beginning.

- *

This operation is throttled at one request per second and can only get verification - * attributes for up to 100 identities at a time.

- */ - public getIdentityVerificationAttributes( + + /** + * @see {@link GetIdentityVerificationAttributesCommand} + */ + getIdentityVerificationAttributes( args: GetIdentityVerificationAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIdentityVerificationAttributes( + getIdentityVerificationAttributes( args: GetIdentityVerificationAttributesCommandInput, cb: (err: any, data?: GetIdentityVerificationAttributesCommandOutput) => void ): void; - public getIdentityVerificationAttributes( + getIdentityVerificationAttributes( args: GetIdentityVerificationAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIdentityVerificationAttributesCommandOutput) => void ): void; - public getIdentityVerificationAttributes( - args: GetIdentityVerificationAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIdentityVerificationAttributesCommandOutput) => void), - cb?: (err: any, data?: GetIdentityVerificationAttributesCommandOutput) => void - ): Promise | void { - const command = new GetIdentityVerificationAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides the sending limits for the Amazon SES account.

- *

You can execute this operation no more than once per second.

- */ - public getSendQuota( - args: GetSendQuotaCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getSendQuota(args: GetSendQuotaCommandInput, cb: (err: any, data?: GetSendQuotaCommandOutput) => void): void; - public getSendQuota( + + /** + * @see {@link GetSendQuotaCommand} + */ + getSendQuota(args: GetSendQuotaCommandInput, options?: __HttpHandlerOptions): Promise; + getSendQuota(args: GetSendQuotaCommandInput, cb: (err: any, data?: GetSendQuotaCommandOutput) => void): void; + getSendQuota( args: GetSendQuotaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSendQuotaCommandOutput) => void ): void; - public getSendQuota( - args: GetSendQuotaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSendQuotaCommandOutput) => void), - cb?: (err: any, data?: GetSendQuotaCommandOutput) => void - ): Promise | void { - const command = new GetSendQuotaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides sending statistics for the current AWS Region. The result is a list of data - * points, representing the last two weeks of sending activity. Each data point in the list - * contains statistics for a 15-minute period of time.

- *

You can execute this operation no more than once per second.

- */ - public getSendStatistics( + + /** + * @see {@link GetSendStatisticsCommand} + */ + getSendStatistics( args: GetSendStatisticsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSendStatistics( + getSendStatistics( args: GetSendStatisticsCommandInput, cb: (err: any, data?: GetSendStatisticsCommandOutput) => void ): void; - public getSendStatistics( + getSendStatistics( args: GetSendStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSendStatisticsCommandOutput) => void ): void; - public getSendStatistics( - args: GetSendStatisticsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSendStatisticsCommandOutput) => void), - cb?: (err: any, data?: GetSendStatisticsCommandOutput) => void - ): Promise | void { - const command = new GetSendStatisticsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Displays the template object (which includes the Subject line, HTML part and text - * part) for the template you specify.

- *

You can execute this operation no more than once per second.

- */ - public getTemplate(args: GetTemplateCommandInput, options?: __HttpHandlerOptions): Promise; - public getTemplate(args: GetTemplateCommandInput, cb: (err: any, data?: GetTemplateCommandOutput) => void): void; - public getTemplate( + + /** + * @see {@link GetTemplateCommand} + */ + getTemplate(args: GetTemplateCommandInput, options?: __HttpHandlerOptions): Promise; + getTemplate(args: GetTemplateCommandInput, cb: (err: any, data?: GetTemplateCommandOutput) => void): void; + getTemplate( args: GetTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTemplateCommandOutput) => void ): void; - public getTemplate( - args: GetTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTemplateCommandOutput) => void), - cb?: (err: any, data?: GetTemplateCommandOutput) => void - ): Promise | void { - const command = new GetTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides a list of the configuration sets associated with your Amazon SES account in the - * current AWS Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer - * Guide. - *

- *

You can execute this operation no more than once per second. This operation will - * return up to 1,000 configuration sets each time it is run. If your Amazon SES account has - * more than 1,000 configuration sets, this operation will also return a NextToken element. - * You can then execute the ListConfigurationSets operation again, passing the - * NextToken parameter and the value of the NextToken element to retrieve - * additional results.

- */ - public listConfigurationSets( + + /** + * @see {@link ListConfigurationSetsCommand} + */ + listConfigurationSets( args: ListConfigurationSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConfigurationSets( + listConfigurationSets( args: ListConfigurationSetsCommandInput, cb: (err: any, data?: ListConfigurationSetsCommandOutput) => void ): void; - public listConfigurationSets( + listConfigurationSets( args: ListConfigurationSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConfigurationSetsCommandOutput) => void ): void; - public listConfigurationSets( - args: ListConfigurationSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConfigurationSetsCommandOutput) => void), - cb?: (err: any, data?: ListConfigurationSetsCommandOutput) => void - ): Promise | void { - const command = new ListConfigurationSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the existing custom verification email templates for your account in the current - * AWS Region.

- *

For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public listCustomVerificationEmailTemplates( + + /** + * @see {@link ListCustomVerificationEmailTemplatesCommand} + */ + listCustomVerificationEmailTemplates( args: ListCustomVerificationEmailTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCustomVerificationEmailTemplates( + listCustomVerificationEmailTemplates( args: ListCustomVerificationEmailTemplatesCommandInput, cb: (err: any, data?: ListCustomVerificationEmailTemplatesCommandOutput) => void ): void; - public listCustomVerificationEmailTemplates( + listCustomVerificationEmailTemplates( args: ListCustomVerificationEmailTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCustomVerificationEmailTemplatesCommandOutput) => void ): void; - public listCustomVerificationEmailTemplates( - args: ListCustomVerificationEmailTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCustomVerificationEmailTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListCustomVerificationEmailTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListCustomVerificationEmailTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list containing all of the identities (email addresses and domains) for your - * AWS account in the current AWS Region, regardless of verification status.

- *

You can execute this operation no more than once per second.

- */ - public listIdentities( + + /** + * @see {@link ListIdentitiesCommand} + */ + listIdentities( args: ListIdentitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listIdentities( - args: ListIdentitiesCommandInput, - cb: (err: any, data?: ListIdentitiesCommandOutput) => void - ): void; - public listIdentities( + listIdentities(args: ListIdentitiesCommandInput, cb: (err: any, data?: ListIdentitiesCommandOutput) => void): void; + listIdentities( args: ListIdentitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIdentitiesCommandOutput) => void ): void; - public listIdentities( - args: ListIdentitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIdentitiesCommandOutput) => void), - cb?: (err: any, data?: ListIdentitiesCommandOutput) => void - ): Promise | void { - const command = new ListIdentitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of sending authorization policies that are attached to the given - * identity (an email address or a domain). This API returns only a list. If you want the - * actual policy content, you can use GetIdentityPolicies.

- * - *

This API is for the identity owner only. If you have not verified the identity, - * this API will return an error.

- *
- *

Sending authorization is a feature that enables an identity owner to authorize other - * senders to use its identities. For information about using sending authorization, see - * the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public listIdentityPolicies( + + /** + * @see {@link ListIdentityPoliciesCommand} + */ + listIdentityPolicies( args: ListIdentityPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listIdentityPolicies( + listIdentityPolicies( args: ListIdentityPoliciesCommandInput, cb: (err: any, data?: ListIdentityPoliciesCommandOutput) => void ): void; - public listIdentityPolicies( + listIdentityPolicies( args: ListIdentityPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIdentityPoliciesCommandOutput) => void ): void; - public listIdentityPolicies( - args: ListIdentityPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIdentityPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListIdentityPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListIdentityPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the IP address filters associated with your AWS account in the current AWS - * Region.

- *

For information about managing IP address filters, see the Amazon SES - * Developer Guide.

- *

You can execute this operation no more than once per second.

- */ - public listReceiptFilters( + + /** + * @see {@link ListReceiptFiltersCommand} + */ + listReceiptFilters( args: ListReceiptFiltersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReceiptFilters( + listReceiptFilters( args: ListReceiptFiltersCommandInput, cb: (err: any, data?: ListReceiptFiltersCommandOutput) => void ): void; - public listReceiptFilters( + listReceiptFilters( args: ListReceiptFiltersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReceiptFiltersCommandOutput) => void ): void; - public listReceiptFilters( - args: ListReceiptFiltersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReceiptFiltersCommandOutput) => void), - cb?: (err: any, data?: ListReceiptFiltersCommandOutput) => void - ): Promise | void { - const command = new ListReceiptFiltersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the receipt rule sets that exist under your AWS account in the current AWS - * Region. If there are additional receipt rule sets to be retrieved, you will receive a - * NextToken that you can provide to the next call to - * ListReceiptRuleSets to retrieve the additional entries.

- *

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

- *

You can execute this operation no more than once per second.

- */ - public listReceiptRuleSets( + + /** + * @see {@link ListReceiptRuleSetsCommand} + */ + listReceiptRuleSets( args: ListReceiptRuleSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReceiptRuleSets( + listReceiptRuleSets( args: ListReceiptRuleSetsCommandInput, cb: (err: any, data?: ListReceiptRuleSetsCommandOutput) => void ): void; - public listReceiptRuleSets( + listReceiptRuleSets( args: ListReceiptRuleSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReceiptRuleSetsCommandOutput) => void ): void; - public listReceiptRuleSets( - args: ListReceiptRuleSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReceiptRuleSetsCommandOutput) => void), - cb?: (err: any, data?: ListReceiptRuleSetsCommandOutput) => void - ): Promise | void { - const command = new ListReceiptRuleSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the email templates present in your Amazon SES account in the current AWS - * Region.

- *

You can execute this operation no more than once per second.

- */ - public listTemplates( - args: ListTemplatesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listTemplates( - args: ListTemplatesCommandInput, - cb: (err: any, data?: ListTemplatesCommandOutput) => void - ): void; - public listTemplates( + + /** + * @see {@link ListTemplatesCommand} + */ + listTemplates(args: ListTemplatesCommandInput, options?: __HttpHandlerOptions): Promise; + listTemplates(args: ListTemplatesCommandInput, cb: (err: any, data?: ListTemplatesCommandOutput) => void): void; + listTemplates( args: ListTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTemplatesCommandOutput) => void ): void; - public listTemplates( - args: ListTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deprecated. Use the ListIdentities operation to list the email addresses - * and domains associated with your account.

- */ - public listVerifiedEmailAddresses( + + /** + * @see {@link ListVerifiedEmailAddressesCommand} + */ + listVerifiedEmailAddresses( args: ListVerifiedEmailAddressesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVerifiedEmailAddresses( + listVerifiedEmailAddresses( args: ListVerifiedEmailAddressesCommandInput, cb: (err: any, data?: ListVerifiedEmailAddressesCommandOutput) => void ): void; - public listVerifiedEmailAddresses( + listVerifiedEmailAddresses( args: ListVerifiedEmailAddressesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVerifiedEmailAddressesCommandOutput) => void ): void; - public listVerifiedEmailAddresses( - args: ListVerifiedEmailAddressesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVerifiedEmailAddressesCommandOutput) => void), - cb?: (err: any, data?: ListVerifiedEmailAddressesCommandOutput) => void - ): Promise | void { - const command = new ListVerifiedEmailAddressesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds or updates the delivery options for a configuration set.

- */ - public putConfigurationSetDeliveryOptions( + + /** + * @see {@link PutConfigurationSetDeliveryOptionsCommand} + */ + putConfigurationSetDeliveryOptions( args: PutConfigurationSetDeliveryOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putConfigurationSetDeliveryOptions( + putConfigurationSetDeliveryOptions( args: PutConfigurationSetDeliveryOptionsCommandInput, cb: (err: any, data?: PutConfigurationSetDeliveryOptionsCommandOutput) => void ): void; - public putConfigurationSetDeliveryOptions( + putConfigurationSetDeliveryOptions( args: PutConfigurationSetDeliveryOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConfigurationSetDeliveryOptionsCommandOutput) => void ): void; - public putConfigurationSetDeliveryOptions( - args: PutConfigurationSetDeliveryOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutConfigurationSetDeliveryOptionsCommandOutput) => void), - cb?: (err: any, data?: PutConfigurationSetDeliveryOptionsCommandOutput) => void - ): Promise | void { - const command = new PutConfigurationSetDeliveryOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds or updates a sending authorization policy for the specified identity (an email - * address or a domain).

- * - *

This API is for the identity owner only. If you have not verified the identity, - * this API will return an error.

- *
- *

Sending authorization is a feature that enables an identity owner to authorize other - * senders to use its identities. For information about using sending authorization, see - * the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public putIdentityPolicy( + + /** + * @see {@link PutIdentityPolicyCommand} + */ + putIdentityPolicy( args: PutIdentityPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putIdentityPolicy( + putIdentityPolicy( args: PutIdentityPolicyCommandInput, cb: (err: any, data?: PutIdentityPolicyCommandOutput) => void ): void; - public putIdentityPolicy( + putIdentityPolicy( args: PutIdentityPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutIdentityPolicyCommandOutput) => void ): void; - public putIdentityPolicy( - args: PutIdentityPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutIdentityPolicyCommandOutput) => void), - cb?: (err: any, data?: PutIdentityPolicyCommandOutput) => void - ): Promise | void { - const command = new PutIdentityPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Reorders the receipt rules within a receipt rule set.

- * - *

All of the rules in the rule set must be represented in this request. That is, - * this API will return an error if the reorder request doesn't explicitly position all - * of the rules.

- *
- *

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

- *

You can execute this operation no more than once per second.

- */ - public reorderReceiptRuleSet( + + /** + * @see {@link ReorderReceiptRuleSetCommand} + */ + reorderReceiptRuleSet( args: ReorderReceiptRuleSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public reorderReceiptRuleSet( + reorderReceiptRuleSet( args: ReorderReceiptRuleSetCommandInput, cb: (err: any, data?: ReorderReceiptRuleSetCommandOutput) => void ): void; - public reorderReceiptRuleSet( + reorderReceiptRuleSet( args: ReorderReceiptRuleSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReorderReceiptRuleSetCommandOutput) => void ): void; - public reorderReceiptRuleSet( - args: ReorderReceiptRuleSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReorderReceiptRuleSetCommandOutput) => void), - cb?: (err: any, data?: ReorderReceiptRuleSetCommandOutput) => void - ): Promise | void { - const command = new ReorderReceiptRuleSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Generates and sends a bounce message to the sender of an email you received through - * Amazon SES. You can only use this API on an email up to 24 hours after you receive it.

- * - *

You cannot use this API to send generic bounces for mail that was not received by - * Amazon SES.

- *
- *

For information about receiving email through Amazon SES, see the Amazon SES - * Developer Guide.

- *

You can execute this operation no more than once per second.

- */ - public sendBounce(args: SendBounceCommandInput, options?: __HttpHandlerOptions): Promise; - public sendBounce(args: SendBounceCommandInput, cb: (err: any, data?: SendBounceCommandOutput) => void): void; - public sendBounce( + + /** + * @see {@link SendBounceCommand} + */ + sendBounce(args: SendBounceCommandInput, options?: __HttpHandlerOptions): Promise; + sendBounce(args: SendBounceCommandInput, cb: (err: any, data?: SendBounceCommandOutput) => void): void; + sendBounce( args: SendBounceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendBounceCommandOutput) => void ): void; - public sendBounce( - args: SendBounceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendBounceCommandOutput) => void), - cb?: (err: any, data?: SendBounceCommandOutput) => void - ): Promise | void { - const command = new SendBounceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Composes an email message to multiple destinations. The message body is created using - * an email template.

- *

In order to send email using the SendBulkTemplatedEmail operation, your - * call to the API must meet the following requirements:

- *
    - *
  • - *

    The call must refer to an existing email template. You can create email - * templates using the CreateTemplate operation.

    - *
  • - *
  • - *

    The message must be sent from a verified email address or domain.

    - *
  • - *
  • - *

    If your account is still in the Amazon SES sandbox, you may only send to verified - * addresses or domains, or to email addresses associated with the Amazon SES Mailbox - * Simulator. For more information, see Verifying - * Email Addresses and Domains in the Amazon SES Developer - * Guide. - *

    - *
  • - *
  • - *

    The maximum message size is 10 MB.

    - *
  • - *
  • - *

    Each Destination parameter must include at least one recipient - * email address. The recipient address can be a To: address, a CC: address, or a - * BCC: address. If a recipient email address is invalid (that is, it is not in the - * format UserName@[SubDomain.]Domain.TopLevelDomain), the - * entire message will be rejected, even if the message contains other recipients - * that are valid.

    - *
  • - *
  • - *

    The message may not include more than 50 recipients, across the To:, CC: and - * BCC: fields. If you need to send an email message to a larger audience, you can - * divide your recipient list into groups of 50 or fewer, and then call the - * SendBulkTemplatedEmail operation several times to send the - * message to each group.

    - *
  • - *
  • - *

    The number of destinations you can contact in a single call to the API may be - * limited by your account's maximum sending rate.

    - *
  • - *
- */ - public sendBulkTemplatedEmail( + + /** + * @see {@link SendBulkTemplatedEmailCommand} + */ + sendBulkTemplatedEmail( args: SendBulkTemplatedEmailCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendBulkTemplatedEmail( + sendBulkTemplatedEmail( args: SendBulkTemplatedEmailCommandInput, cb: (err: any, data?: SendBulkTemplatedEmailCommandOutput) => void ): void; - public sendBulkTemplatedEmail( + sendBulkTemplatedEmail( args: SendBulkTemplatedEmailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendBulkTemplatedEmailCommandOutput) => void ): void; - public sendBulkTemplatedEmail( - args: SendBulkTemplatedEmailCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendBulkTemplatedEmailCommandOutput) => void), - cb?: (err: any, data?: SendBulkTemplatedEmailCommandOutput) => void - ): Promise | void { - const command = new SendBulkTemplatedEmailCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds an email address to the list of identities for your Amazon SES account in the current - * AWS Region and attempts to verify it. As a result of executing this operation, a - * customized verification email is sent to the specified address.

- *

To use this operation, you must first create a custom verification email template. For - * more information about creating and using custom verification email templates, see - * Using Custom - * Verification Email Templates in the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public sendCustomVerificationEmail( + + /** + * @see {@link SendCustomVerificationEmailCommand} + */ + sendCustomVerificationEmail( args: SendCustomVerificationEmailCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendCustomVerificationEmail( + sendCustomVerificationEmail( args: SendCustomVerificationEmailCommandInput, cb: (err: any, data?: SendCustomVerificationEmailCommandOutput) => void ): void; - public sendCustomVerificationEmail( + sendCustomVerificationEmail( args: SendCustomVerificationEmailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendCustomVerificationEmailCommandOutput) => void ): void; - public sendCustomVerificationEmail( - args: SendCustomVerificationEmailCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendCustomVerificationEmailCommandOutput) => void), - cb?: (err: any, data?: SendCustomVerificationEmailCommandOutput) => void - ): Promise | void { - const command = new SendCustomVerificationEmailCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Composes an email message and immediately queues it for sending. In order to send - * email using the SendEmail operation, your message must meet the following - * requirements:

- * - *
    - *
  • - *

    The message must be sent from a verified email address or domain. If you - * attempt to send email using a non-verified address or domain, the operation will - * result in an "Email address not verified" error.

    - *
  • - *
  • - *

    If your account is still in the Amazon SES sandbox, you may only send to verified - * addresses or domains, or to email addresses associated with the Amazon SES Mailbox - * Simulator. For more information, see Verifying - * Email Addresses and Domains in the Amazon SES Developer - * Guide. - *

    - *
  • - *
  • - *

    The maximum message size is 10 MB.

    - *
  • - *
  • - *

    The message must include at least one recipient email address. The recipient - * address can be a To: address, a CC: address, or a BCC: address. If a recipient - * email address is invalid (that is, it is not in the format - * UserName@[SubDomain.]Domain.TopLevelDomain), the entire - * message will be rejected, even if the message contains other recipients that are - * valid.

    - *
  • - *
  • - *

    The message may not include more than 50 recipients, across the To:, CC: and - * BCC: fields. If you need to send an email message to a larger audience, you can - * divide your recipient list into groups of 50 or fewer, and then call the - * SendEmail operation several times to send the message to each - * group.

    - *
  • - *
- * - *

For every message that you send, the total number of recipients (including each - * recipient in the To:, CC: and BCC: fields) is counted against the maximum number of - * emails you can send in a 24-hour period (your sending quota). - * For more information about sending quotas in Amazon SES, see Managing Your Amazon SES - * Sending Limits in the Amazon SES Developer Guide. - *

- *
- */ - public sendEmail(args: SendEmailCommandInput, options?: __HttpHandlerOptions): Promise; - public sendEmail(args: SendEmailCommandInput, cb: (err: any, data?: SendEmailCommandOutput) => void): void; - public sendEmail( + + /** + * @see {@link SendEmailCommand} + */ + sendEmail(args: SendEmailCommandInput, options?: __HttpHandlerOptions): Promise; + sendEmail(args: SendEmailCommandInput, cb: (err: any, data?: SendEmailCommandOutput) => void): void; + sendEmail( args: SendEmailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendEmailCommandOutput) => void ): void; - public sendEmail( - args: SendEmailCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendEmailCommandOutput) => void), - cb?: (err: any, data?: SendEmailCommandOutput) => void - ): Promise | void { - const command = new SendEmailCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Composes an email message and immediately queues it for sending.

- * - *

This operation is more flexible than the SendEmail API operation. When - * you use the SendRawEmail operation, you can specify the headers of the - * message as well as its content. This flexibility is useful, for example, when you want - * to send a multipart MIME email (such a message that contains both a text and an HTML - * version). You can also use this operation to send messages that include - * attachments.

- *

The SendRawEmail operation has the following requirements:

- *
    - *
  • - *

    You can only send email from verified email addresses or domains. If you try - * to send email from an address that isn't verified, the operation results in an - * "Email address not verified" error.

    - *
  • - *
  • - *

    If your account is still in the Amazon SES sandbox, you can only send email to other - * verified addresses in your account, or to addresses that are associated with the - * Amazon SES mailbox simulator.

    - *
  • - *
  • - *

    The maximum message size, including attachments, is 10 MB.

    - *
  • - *
  • - *

    Each message has to include at least one recipient address. A recipient - * address includes any address on the To:, CC:, or BCC: lines.

    - *
  • - *
  • - *

    If you send a single message to more than one recipient address, and one of - * the recipient addresses isn't in a valid format (that is, it's not in the format - * UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES - * rejects the entire message, even if the other addresses are valid.

    - *
  • - *
  • - *

    Each message can include up to 50 recipient addresses across the To:, CC:, or - * BCC: lines. If you need to send a single message to more than 50 recipients, you - * have to split the list of recipient addresses into groups of less than 50 - * recipients, and send separate messages to each group.

    - *
  • - *
  • - *

    Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message - * parts. However, if Amazon SES has to modify the contents of your message (for - * example, if you use open and click tracking), 8-bit content isn't preserved. For - * this reason, we highly recommend that you encode all content that isn't 7-bit - * ASCII. For more information, see MIME Encoding in the Amazon SES Developer - * Guide.

    - *
  • - *
- * - * - * - *

Additionally, keep the following considerations in mind when using the - * SendRawEmail operation:

- * - *
    - *
  • - *

    Although you can customize the message headers when using the - * SendRawEmail operation, Amazon SES will automatically apply its own - * Message-ID and Date headers; if you passed these - * headers when creating the message, they will be overwritten by the values that - * Amazon SES provides.

    - *
  • - *
  • - *

    If you are using sending authorization to send on behalf of another user, - * SendRawEmail enables you to specify the cross-account identity - * for the email's Source, From, and Return-Path parameters in one of two ways: you - * can pass optional parameters SourceArn, FromArn, - * and/or ReturnPathArn to the API, or you can include the following - * X-headers in the header of your raw email:

    - *
      - *
    • - *

      - * X-SES-SOURCE-ARN - *

      - *
    • - *
    • - *

      - * X-SES-FROM-ARN - *

      - *
    • - *
    • - *

      - * X-SES-RETURN-PATH-ARN - *

      - *
    • - *
    - * - *

    Don't include these X-headers in the DKIM signature. Amazon SES removes these - * before it sends the email.

    - *
    - *

    If you only specify the SourceIdentityArn parameter, Amazon SES sets - * the From and Return-Path addresses to the same identity that you - * specified.

    - *

    For more information about sending authorization, see the Using Sending - * Authorization with Amazon SES in the Amazon SES Developer - * Guide. - *

    - *
  • - *
  • - *

    For every message that you send, the total number of recipients (including - * each recipient in the To:, CC: and BCC: fields) is counted against the maximum - * number of emails you can send in a 24-hour period (your sending - * quota). For more information about sending quotas in Amazon SES, see - * Managing Your - * Amazon SES Sending Limits in the Amazon SES Developer - * Guide. - *

    - *
  • - *
- */ - public sendRawEmail( - args: SendRawEmailCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public sendRawEmail(args: SendRawEmailCommandInput, cb: (err: any, data?: SendRawEmailCommandOutput) => void): void; - public sendRawEmail( + + /** + * @see {@link SendRawEmailCommand} + */ + sendRawEmail(args: SendRawEmailCommandInput, options?: __HttpHandlerOptions): Promise; + sendRawEmail(args: SendRawEmailCommandInput, cb: (err: any, data?: SendRawEmailCommandOutput) => void): void; + sendRawEmail( args: SendRawEmailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendRawEmailCommandOutput) => void ): void; - public sendRawEmail( - args: SendRawEmailCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendRawEmailCommandOutput) => void), - cb?: (err: any, data?: SendRawEmailCommandOutput) => void - ): Promise | void { - const command = new SendRawEmailCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Composes an email message using an email template and immediately queues it for - * sending.

- *

In order to send email using the SendTemplatedEmail operation, your call - * to the API must meet the following requirements:

- *
    - *
  • - *

    The call must refer to an existing email template. You can create email - * templates using the CreateTemplate operation.

    - *
  • - *
  • - *

    The message must be sent from a verified email address or domain.

    - *
  • - *
  • - *

    If your account is still in the Amazon SES sandbox, you may only send to verified - * addresses or domains, or to email addresses associated with the Amazon SES Mailbox - * Simulator. For more information, see Verifying - * Email Addresses and Domains in the Amazon SES Developer - * Guide. - *

    - *
  • - *
  • - *

    The maximum message size is 10 MB.

    - *
  • - *
  • - *

    Calls to the SendTemplatedEmail operation may only include one - * Destination parameter. A destination is a set of recipients who - * will receive the same version of the email. The Destination - * parameter can include up to 50 recipients, across the To:, CC: and BCC: - * fields.

    - *
  • - *
  • - *

    The Destination parameter must include at least one recipient - * email address. The recipient address can be a To: address, a CC: address, or a - * BCC: address. If a recipient email address is invalid (that is, it is not in the - * format UserName@[SubDomain.]Domain.TopLevelDomain), the - * entire message will be rejected, even if the message contains other recipients - * that are valid.

    - *
  • - *
- * - *

If your call to the SendTemplatedEmail operation includes all of the - * required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES - * can't render the email because the template contains errors, it doesn't send the - * email. Additionally, because it already accepted the message, Amazon SES doesn't return a - * message stating that it was unable to send the email.

- *

For these reasons, we highly recommend that you set up Amazon SES to send you - * notifications when Rendering Failure events occur. For more information, see Sending - * Personalized Email Using the Amazon SES API in the Amazon Simple Email Service - * Developer Guide.

- *
- */ - public sendTemplatedEmail( + + /** + * @see {@link SendTemplatedEmailCommand} + */ + sendTemplatedEmail( args: SendTemplatedEmailCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendTemplatedEmail( + sendTemplatedEmail( args: SendTemplatedEmailCommandInput, cb: (err: any, data?: SendTemplatedEmailCommandOutput) => void ): void; - public sendTemplatedEmail( + sendTemplatedEmail( args: SendTemplatedEmailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendTemplatedEmailCommandOutput) => void ): void; - public sendTemplatedEmail( - args: SendTemplatedEmailCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendTemplatedEmailCommandOutput) => void), - cb?: (err: any, data?: SendTemplatedEmailCommandOutput) => void - ): Promise | void { - const command = new SendTemplatedEmailCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the specified receipt rule set as the active receipt rule set.

- * - *

To disable your email-receiving through Amazon SES completely, you can call this API - * with RuleSetName set to null.

- *
- *

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

- *

You can execute this operation no more than once per second.

- */ - public setActiveReceiptRuleSet( + + /** + * @see {@link SetActiveReceiptRuleSetCommand} + */ + setActiveReceiptRuleSet( args: SetActiveReceiptRuleSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public setActiveReceiptRuleSet( + setActiveReceiptRuleSet( args: SetActiveReceiptRuleSetCommandInput, cb: (err: any, data?: SetActiveReceiptRuleSetCommandOutput) => void ): void; - public setActiveReceiptRuleSet( + setActiveReceiptRuleSet( args: SetActiveReceiptRuleSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetActiveReceiptRuleSetCommandOutput) => void ): void; - public setActiveReceiptRuleSet( - args: SetActiveReceiptRuleSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetActiveReceiptRuleSetCommandOutput) => void), - cb?: (err: any, data?: SetActiveReceiptRuleSetCommandOutput) => void - ): Promise | void { - const command = new SetActiveReceiptRuleSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables or disables Easy DKIM signing of email sent from an identity. If Easy DKIM - * signing is enabled for a domain, then Amazon SES uses DKIM to sign all email that it sends - * from addresses on that domain. If Easy DKIM signing is enabled for an email address, - * then Amazon SES uses DKIM to sign all email it sends from that address.

- * - *

For email addresses (for example, user@example.com), you can only - * enable DKIM signing if the corresponding domain (in this case, - * example.com) has been set up to use Easy DKIM.

- *
- *

You can enable DKIM signing for an identity at any time after you start the - * verification process for the identity, even if the verification process isn't complete.

- *

You can execute this operation no more than once per second.

- *

For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.

- */ - public setIdentityDkimEnabled( + + /** + * @see {@link SetIdentityDkimEnabledCommand} + */ + setIdentityDkimEnabled( args: SetIdentityDkimEnabledCommandInput, options?: __HttpHandlerOptions ): Promise; - public setIdentityDkimEnabled( + setIdentityDkimEnabled( args: SetIdentityDkimEnabledCommandInput, cb: (err: any, data?: SetIdentityDkimEnabledCommandOutput) => void ): void; - public setIdentityDkimEnabled( + setIdentityDkimEnabled( args: SetIdentityDkimEnabledCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetIdentityDkimEnabledCommandOutput) => void ): void; - public setIdentityDkimEnabled( - args: SetIdentityDkimEnabledCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetIdentityDkimEnabledCommandOutput) => void), - cb?: (err: any, data?: SetIdentityDkimEnabledCommandOutput) => void - ): Promise | void { - const command = new SetIdentityDkimEnabledCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Given an identity (an email address or a domain), enables or disables whether Amazon SES - * forwards bounce and complaint notifications as email. Feedback forwarding can only be - * disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and - * complaints.

- * - *

Feedback forwarding does not apply to delivery notifications. Delivery - * notifications are only available through Amazon SNS.

- *
- *

You can execute this operation no more than once per second.

- *

For more information about using notifications with Amazon SES, see the Amazon SES - * Developer Guide.

- */ - public setIdentityFeedbackForwardingEnabled( + + /** + * @see {@link SetIdentityFeedbackForwardingEnabledCommand} + */ + setIdentityFeedbackForwardingEnabled( args: SetIdentityFeedbackForwardingEnabledCommandInput, options?: __HttpHandlerOptions ): Promise; - public setIdentityFeedbackForwardingEnabled( + setIdentityFeedbackForwardingEnabled( args: SetIdentityFeedbackForwardingEnabledCommandInput, cb: (err: any, data?: SetIdentityFeedbackForwardingEnabledCommandOutput) => void ): void; - public setIdentityFeedbackForwardingEnabled( + setIdentityFeedbackForwardingEnabled( args: SetIdentityFeedbackForwardingEnabledCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetIdentityFeedbackForwardingEnabledCommandOutput) => void ): void; - public setIdentityFeedbackForwardingEnabled( - args: SetIdentityFeedbackForwardingEnabledCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetIdentityFeedbackForwardingEnabledCommandOutput) => void), - cb?: (err: any, data?: SetIdentityFeedbackForwardingEnabledCommandOutput) => void - ): Promise | void { - const command = new SetIdentityFeedbackForwardingEnabledCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Given an identity (an email address or a domain), sets whether Amazon SES includes the - * original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified - * type.

- *

You can execute this operation no more than once per second.

- *

For more information about using notifications with Amazon SES, see the Amazon SES - * Developer Guide.

- */ - public setIdentityHeadersInNotificationsEnabled( + + /** + * @see {@link SetIdentityHeadersInNotificationsEnabledCommand} + */ + setIdentityHeadersInNotificationsEnabled( args: SetIdentityHeadersInNotificationsEnabledCommandInput, options?: __HttpHandlerOptions ): Promise; - public setIdentityHeadersInNotificationsEnabled( + setIdentityHeadersInNotificationsEnabled( args: SetIdentityHeadersInNotificationsEnabledCommandInput, cb: (err: any, data?: SetIdentityHeadersInNotificationsEnabledCommandOutput) => void ): void; - public setIdentityHeadersInNotificationsEnabled( + setIdentityHeadersInNotificationsEnabled( args: SetIdentityHeadersInNotificationsEnabledCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetIdentityHeadersInNotificationsEnabledCommandOutput) => void ): void; - public setIdentityHeadersInNotificationsEnabled( - args: SetIdentityHeadersInNotificationsEnabledCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: SetIdentityHeadersInNotificationsEnabledCommandOutput) => void), - cb?: (err: any, data?: SetIdentityHeadersInNotificationsEnabledCommandOutput) => void - ): Promise | void { - const command = new SetIdentityHeadersInNotificationsEnabledCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables or disables the custom MAIL FROM domain setup for a verified identity (an - * email address or a domain).

- * - *

To send emails using the specified MAIL FROM domain, you must add an MX record to - * your MAIL FROM domain's DNS settings. If you want your emails to pass Sender Policy - * Framework (SPF) checks, you must also add or update an SPF record. For more - * information, see the Amazon SES Developer - * Guide.

- *
- *

You can execute this operation no more than once per second.

- */ - public setIdentityMailFromDomain( + + /** + * @see {@link SetIdentityMailFromDomainCommand} + */ + setIdentityMailFromDomain( args: SetIdentityMailFromDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public setIdentityMailFromDomain( + setIdentityMailFromDomain( args: SetIdentityMailFromDomainCommandInput, cb: (err: any, data?: SetIdentityMailFromDomainCommandOutput) => void ): void; - public setIdentityMailFromDomain( + setIdentityMailFromDomain( args: SetIdentityMailFromDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetIdentityMailFromDomainCommandOutput) => void ): void; - public setIdentityMailFromDomain( - args: SetIdentityMailFromDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetIdentityMailFromDomainCommandOutput) => void), - cb?: (err: any, data?: SetIdentityMailFromDomainCommandOutput) => void - ): Promise | void { - const command = new SetIdentityMailFromDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use - * this operation, you specify a verified identity, such as an email address or domain. - * When you send an email that uses the chosen identity in the Source field, Amazon SES sends - * notifications to the topic you specified. You can send bounce, complaint, or delivery - * notifications (or any combination of the three) to the Amazon SNS topic that you - * specify.

- *

You can execute this operation no more than once per second.

- *

For more information about feedback notification, see the Amazon SES Developer - * Guide.

- */ - public setIdentityNotificationTopic( + + /** + * @see {@link SetIdentityNotificationTopicCommand} + */ + setIdentityNotificationTopic( args: SetIdentityNotificationTopicCommandInput, options?: __HttpHandlerOptions ): Promise; - public setIdentityNotificationTopic( + setIdentityNotificationTopic( args: SetIdentityNotificationTopicCommandInput, cb: (err: any, data?: SetIdentityNotificationTopicCommandOutput) => void ): void; - public setIdentityNotificationTopic( + setIdentityNotificationTopic( args: SetIdentityNotificationTopicCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetIdentityNotificationTopicCommandOutput) => void ): void; - public setIdentityNotificationTopic( - args: SetIdentityNotificationTopicCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetIdentityNotificationTopicCommandOutput) => void), - cb?: (err: any, data?: SetIdentityNotificationTopicCommandOutput) => void - ): Promise | void { - const command = new SetIdentityNotificationTopicCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the position of the specified receipt rule in the receipt rule set.

- *

For information about managing receipt rules, see the Amazon SES - * Developer Guide.

- *

You can execute this operation no more than once per second.

- */ - public setReceiptRulePosition( + + /** + * @see {@link SetReceiptRulePositionCommand} + */ + setReceiptRulePosition( args: SetReceiptRulePositionCommandInput, options?: __HttpHandlerOptions ): Promise; - public setReceiptRulePosition( + setReceiptRulePosition( args: SetReceiptRulePositionCommandInput, cb: (err: any, data?: SetReceiptRulePositionCommandOutput) => void ): void; - public setReceiptRulePosition( + setReceiptRulePosition( args: SetReceiptRulePositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetReceiptRulePositionCommandOutput) => void ): void; - public setReceiptRulePosition( - args: SetReceiptRulePositionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetReceiptRulePositionCommandOutput) => void), - cb?: (err: any, data?: SetReceiptRulePositionCommandOutput) => void - ): Promise | void { - const command = new SetReceiptRulePositionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a preview of the MIME content of an email when provided with a template and a - * set of replacement data.

- *

You can execute this operation no more than once per second.

- */ - public testRenderTemplate( + + /** + * @see {@link TestRenderTemplateCommand} + */ + testRenderTemplate( args: TestRenderTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public testRenderTemplate( + testRenderTemplate( args: TestRenderTemplateCommandInput, cb: (err: any, data?: TestRenderTemplateCommandOutput) => void ): void; - public testRenderTemplate( + testRenderTemplate( args: TestRenderTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestRenderTemplateCommandOutput) => void ): void; - public testRenderTemplate( - args: TestRenderTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestRenderTemplateCommandOutput) => void), - cb?: (err: any, data?: TestRenderTemplateCommandOutput) => void - ): Promise | void { - const command = new TestRenderTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables or disables email sending across your entire Amazon SES account in the current - * AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to - * temporarily pause email sending across your Amazon SES account in a given AWS Region when - * reputation metrics (such as your bounce or complaint rates) reach certain - * thresholds.

- *

You can execute this operation no more than once per second.

- */ - public updateAccountSendingEnabled( + + /** + * @see {@link UpdateAccountSendingEnabledCommand} + */ + updateAccountSendingEnabled( args: UpdateAccountSendingEnabledCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAccountSendingEnabled( + updateAccountSendingEnabled( args: UpdateAccountSendingEnabledCommandInput, cb: (err: any, data?: UpdateAccountSendingEnabledCommandOutput) => void ): void; - public updateAccountSendingEnabled( + updateAccountSendingEnabled( args: UpdateAccountSendingEnabledCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccountSendingEnabledCommandOutput) => void ): void; - public updateAccountSendingEnabled( - args: UpdateAccountSendingEnabledCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAccountSendingEnabledCommandOutput) => void), - cb?: (err: any, data?: UpdateAccountSendingEnabledCommandOutput) => void - ): Promise | void { - const command = new UpdateAccountSendingEnabledCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the event destination of a configuration set. Event destinations are - * associated with configuration sets, which enable you to publish email sending events to - * Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, - * see Monitoring Your Amazon SES - * Sending Activity in the Amazon SES Developer Guide. - *

- * - *

When you create or update an event destination, you must provide one, and only - * one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service - * (Amazon SNS).

- *
- *

You can execute this operation no more than once per second.

- */ - public updateConfigurationSetEventDestination( + + /** + * @see {@link UpdateConfigurationSetEventDestinationCommand} + */ + updateConfigurationSetEventDestination( args: UpdateConfigurationSetEventDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConfigurationSetEventDestination( + updateConfigurationSetEventDestination( args: UpdateConfigurationSetEventDestinationCommandInput, cb: (err: any, data?: UpdateConfigurationSetEventDestinationCommandOutput) => void ): void; - public updateConfigurationSetEventDestination( + updateConfigurationSetEventDestination( args: UpdateConfigurationSetEventDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConfigurationSetEventDestinationCommandOutput) => void ): void; - public updateConfigurationSetEventDestination( - args: UpdateConfigurationSetEventDestinationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateConfigurationSetEventDestinationCommandOutput) => void), - cb?: (err: any, data?: UpdateConfigurationSetEventDestinationCommandOutput) => void - ): Promise | void { - const command = new UpdateConfigurationSetEventDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables or disables the publishing of reputation metrics for emails sent using a - * specific configuration set in a given AWS Region. Reputation metrics include bounce - * and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can - * create alarms when bounce or complaint rates exceed certain thresholds.

- *

You can execute this operation no more than once per second.

- */ - public updateConfigurationSetReputationMetricsEnabled( + + /** + * @see {@link UpdateConfigurationSetReputationMetricsEnabledCommand} + */ + updateConfigurationSetReputationMetricsEnabled( args: UpdateConfigurationSetReputationMetricsEnabledCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConfigurationSetReputationMetricsEnabled( + updateConfigurationSetReputationMetricsEnabled( args: UpdateConfigurationSetReputationMetricsEnabledCommandInput, cb: (err: any, data?: UpdateConfigurationSetReputationMetricsEnabledCommandOutput) => void ): void; - public updateConfigurationSetReputationMetricsEnabled( + updateConfigurationSetReputationMetricsEnabled( args: UpdateConfigurationSetReputationMetricsEnabledCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConfigurationSetReputationMetricsEnabledCommandOutput) => void ): void; - public updateConfigurationSetReputationMetricsEnabled( - args: UpdateConfigurationSetReputationMetricsEnabledCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateConfigurationSetReputationMetricsEnabledCommandOutput) => void), - cb?: (err: any, data?: UpdateConfigurationSetReputationMetricsEnabledCommandOutput) => void - ): Promise | void { - const command = new UpdateConfigurationSetReputationMetricsEnabledCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables or disables email sending for messages sent using a specific configuration set - * in a given AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms - * to temporarily pause email sending for a configuration set when the reputation metrics - * for that configuration set (such as your bounce on complaint rate) exceed certain - * thresholds.

- *

You can execute this operation no more than once per second.

- */ - public updateConfigurationSetSendingEnabled( + + /** + * @see {@link UpdateConfigurationSetSendingEnabledCommand} + */ + updateConfigurationSetSendingEnabled( args: UpdateConfigurationSetSendingEnabledCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConfigurationSetSendingEnabled( + updateConfigurationSetSendingEnabled( args: UpdateConfigurationSetSendingEnabledCommandInput, cb: (err: any, data?: UpdateConfigurationSetSendingEnabledCommandOutput) => void ): void; - public updateConfigurationSetSendingEnabled( + updateConfigurationSetSendingEnabled( args: UpdateConfigurationSetSendingEnabledCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConfigurationSetSendingEnabledCommandOutput) => void ): void; - public updateConfigurationSetSendingEnabled( - args: UpdateConfigurationSetSendingEnabledCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConfigurationSetSendingEnabledCommandOutput) => void), - cb?: (err: any, data?: UpdateConfigurationSetSendingEnabledCommandOutput) => void - ): Promise | void { - const command = new UpdateConfigurationSetSendingEnabledCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies an association between a configuration set and a custom domain for open and - * click event tracking.

- *

By default, images and links used for tracking open and click events are hosted on - * domains operated by Amazon SES. You can configure a subdomain of your own to handle these - * events. For information about using custom domains, see the Amazon SES Developer Guide.

- */ - public updateConfigurationSetTrackingOptions( + + /** + * @see {@link UpdateConfigurationSetTrackingOptionsCommand} + */ + updateConfigurationSetTrackingOptions( args: UpdateConfigurationSetTrackingOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConfigurationSetTrackingOptions( + updateConfigurationSetTrackingOptions( args: UpdateConfigurationSetTrackingOptionsCommandInput, cb: (err: any, data?: UpdateConfigurationSetTrackingOptionsCommandOutput) => void ): void; - public updateConfigurationSetTrackingOptions( + updateConfigurationSetTrackingOptions( args: UpdateConfigurationSetTrackingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConfigurationSetTrackingOptionsCommandOutput) => void ): void; - public updateConfigurationSetTrackingOptions( - args: UpdateConfigurationSetTrackingOptionsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateConfigurationSetTrackingOptionsCommandOutput) => void), - cb?: (err: any, data?: UpdateConfigurationSetTrackingOptionsCommandOutput) => void - ): Promise | void { - const command = new UpdateConfigurationSetTrackingOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing custom verification email template.

- *

For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public updateCustomVerificationEmailTemplate( + + /** + * @see {@link UpdateCustomVerificationEmailTemplateCommand} + */ + updateCustomVerificationEmailTemplate( args: UpdateCustomVerificationEmailTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCustomVerificationEmailTemplate( + updateCustomVerificationEmailTemplate( args: UpdateCustomVerificationEmailTemplateCommandInput, cb: (err: any, data?: UpdateCustomVerificationEmailTemplateCommandOutput) => void ): void; - public updateCustomVerificationEmailTemplate( + updateCustomVerificationEmailTemplate( args: UpdateCustomVerificationEmailTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCustomVerificationEmailTemplateCommandOutput) => void ): void; - public updateCustomVerificationEmailTemplate( - args: UpdateCustomVerificationEmailTemplateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateCustomVerificationEmailTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateCustomVerificationEmailTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateCustomVerificationEmailTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a receipt rule.

- *

For information about managing receipt rules, see the Amazon SES - * Developer Guide.

- *

You can execute this operation no more than once per second.

- */ - public updateReceiptRule( + + /** + * @see {@link UpdateReceiptRuleCommand} + */ + updateReceiptRule( args: UpdateReceiptRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateReceiptRule( + updateReceiptRule( args: UpdateReceiptRuleCommandInput, cb: (err: any, data?: UpdateReceiptRuleCommandOutput) => void ): void; - public updateReceiptRule( + updateReceiptRule( args: UpdateReceiptRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateReceiptRuleCommandOutput) => void ): void; - public updateReceiptRule( - args: UpdateReceiptRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateReceiptRuleCommandOutput) => void), - cb?: (err: any, data?: UpdateReceiptRuleCommandOutput) => void - ): Promise | void { - const command = new UpdateReceiptRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an email template. Email templates enable you to send personalized email to - * one or more destinations in a single API operation. For more information, see the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public updateTemplate( + + /** + * @see {@link UpdateTemplateCommand} + */ + updateTemplate( args: UpdateTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTemplate( - args: UpdateTemplateCommandInput, - cb: (err: any, data?: UpdateTemplateCommandOutput) => void - ): void; - public updateTemplate( + updateTemplate(args: UpdateTemplateCommandInput, cb: (err: any, data?: UpdateTemplateCommandOutput) => void): void; + updateTemplate( args: UpdateTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTemplateCommandOutput) => void ): void; - public updateTemplate( - args: UpdateTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a set of DKIM tokens for a domain identity.

- * - *

When you execute the VerifyDomainDkim operation, the domain that you - * specify is added to the list of identities that are associated with your account. - * This is true even if you haven't already associated the domain with your account by - * using the VerifyDomainIdentity operation. However, you can't send email - * from the domain until you either successfully verify it or you - * successfully set up DKIM for - * it.

- *
- *

You use the tokens that are generated by this operation to create CNAME records. When - * Amazon SES detects that you've added these records to the DNS configuration for a domain, you - * can start sending email from that domain. You can start sending email even if you - * haven't added the TXT record provided by the VerifyDomainIdentity operation to the DNS - * configuration for your domain. All email that you send from the domain is authenticated - * using DKIM.

- *

To create the CNAME records for DKIM authentication, use the following values:

- *
    - *
  • - *

    - * Name: - * token._domainkey.example.com - *

    - *
  • - *
  • - *

    - * Type: CNAME

    - *
  • - *
  • - *

    - * Value: - * token.dkim.amazonses.com

    - *
  • - *
- *

In the preceding example, replace token with one of the tokens - * that are generated when you execute this operation. Replace - * example.com with your domain. Repeat this process for each - * token that's generated by this operation.

- *

You can execute this operation no more than once per second.

- */ - public verifyDomainDkim( + + /** + * @see {@link VerifyDomainDkimCommand} + */ + verifyDomainDkim( args: VerifyDomainDkimCommandInput, options?: __HttpHandlerOptions ): Promise; - public verifyDomainDkim( + verifyDomainDkim( args: VerifyDomainDkimCommandInput, cb: (err: any, data?: VerifyDomainDkimCommandOutput) => void ): void; - public verifyDomainDkim( + verifyDomainDkim( args: VerifyDomainDkimCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifyDomainDkimCommandOutput) => void ): void; - public verifyDomainDkim( - args: VerifyDomainDkimCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: VerifyDomainDkimCommandOutput) => void), - cb?: (err: any, data?: VerifyDomainDkimCommandOutput) => void - ): Promise | void { - const command = new VerifyDomainDkimCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds a domain to the list of identities for your Amazon SES account in the current AWS - * Region and attempts to verify it. For more information about verifying domains, see - * Verifying Email - * Addresses and Domains in the Amazon SES Developer - * Guide. - *

- *

You can execute this operation no more than once per second.

- */ - public verifyDomainIdentity( + + /** + * @see {@link VerifyDomainIdentityCommand} + */ + verifyDomainIdentity( args: VerifyDomainIdentityCommandInput, options?: __HttpHandlerOptions ): Promise; - public verifyDomainIdentity( + verifyDomainIdentity( args: VerifyDomainIdentityCommandInput, cb: (err: any, data?: VerifyDomainIdentityCommandOutput) => void ): void; - public verifyDomainIdentity( + verifyDomainIdentity( args: VerifyDomainIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifyDomainIdentityCommandOutput) => void ): void; - public verifyDomainIdentity( - args: VerifyDomainIdentityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: VerifyDomainIdentityCommandOutput) => void), - cb?: (err: any, data?: VerifyDomainIdentityCommandOutput) => void - ): Promise | void { - const command = new VerifyDomainIdentityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deprecated. Use the VerifyEmailIdentity operation to verify a new email - * address.

- */ - public verifyEmailAddress( + + /** + * @see {@link VerifyEmailAddressCommand} + */ + verifyEmailAddress( args: VerifyEmailAddressCommandInput, options?: __HttpHandlerOptions ): Promise; - public verifyEmailAddress( + verifyEmailAddress( args: VerifyEmailAddressCommandInput, cb: (err: any, data?: VerifyEmailAddressCommandOutput) => void ): void; - public verifyEmailAddress( + verifyEmailAddress( args: VerifyEmailAddressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifyEmailAddressCommandOutput) => void ): void; - public verifyEmailAddress( - args: VerifyEmailAddressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: VerifyEmailAddressCommandOutput) => void), - cb?: (err: any, data?: VerifyEmailAddressCommandOutput) => void - ): Promise | void { - const command = new VerifyEmailAddressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds an email address to the list of identities for your Amazon SES account in the current - * AWS region and attempts to verify it. As a result of executing this operation, a - * verification email is sent to the specified address.

- *

You can execute this operation no more than once per second.

- */ - public verifyEmailIdentity( + + /** + * @see {@link VerifyEmailIdentityCommand} + */ + verifyEmailIdentity( args: VerifyEmailIdentityCommandInput, options?: __HttpHandlerOptions ): Promise; - public verifyEmailIdentity( + verifyEmailIdentity( args: VerifyEmailIdentityCommandInput, cb: (err: any, data?: VerifyEmailIdentityCommandOutput) => void ): void; - public verifyEmailIdentity( + verifyEmailIdentity( args: VerifyEmailIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifyEmailIdentityCommandOutput) => void ): void; - public verifyEmailIdentity( - args: VerifyEmailIdentityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: VerifyEmailIdentityCommandOutput) => void), - cb?: (err: any, data?: VerifyEmailIdentityCommandOutput) => void - ): Promise | void { - const command = new VerifyEmailIdentityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Simple Email Service + *

This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version + * 2010-12-01. This document is best used in conjunction with the Amazon SES Developer + * Guide.

+ * + *

For a list of Amazon SES endpoints to use in service requests, see Regions and + * Amazon SES in the Amazon SES Developer + * Guide.

+ *
+ */ +export class SES extends SESClient implements SES {} +createAggregatedClient(commands, SES); diff --git a/clients/client-sesv2/src/SESv2.ts b/clients/client-sesv2/src/SESv2.ts index e63a2855de85..732f64d64344 100644 --- a/clients/client-sesv2/src/SESv2.ts +++ b/clients/client-sesv2/src/SESv2.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -415,3131 +416,1489 @@ import { UpdateEmailTemplateCommandInput, UpdateEmailTemplateCommandOutput, } from "./commands/UpdateEmailTemplateCommand"; -import { SESv2Client } from "./SESv2Client"; +import { SESv2Client, SESv2ClientConfig } from "./SESv2Client"; -/** - * @public - * Amazon SES API v2 - *

- * Amazon SES is an Amazon Web Services service that - * you can use to send email messages to your customers.

- *

If you're new to Amazon SES API v2, you might find it helpful to review the Amazon Simple Email Service Developer - * Guide. The Amazon SES Developer Guide provides information - * and code samples that demonstrate how to use Amazon SES API v2 features programmatically.

- */ -export class SESv2 extends SESv2Client { +const commands = { + BatchGetMetricDataCommand, + CreateConfigurationSetCommand, + CreateConfigurationSetEventDestinationCommand, + CreateContactCommand, + CreateContactListCommand, + CreateCustomVerificationEmailTemplateCommand, + CreateDedicatedIpPoolCommand, + CreateDeliverabilityTestReportCommand, + CreateEmailIdentityCommand, + CreateEmailIdentityPolicyCommand, + CreateEmailTemplateCommand, + CreateImportJobCommand, + DeleteConfigurationSetCommand, + DeleteConfigurationSetEventDestinationCommand, + DeleteContactCommand, + DeleteContactListCommand, + DeleteCustomVerificationEmailTemplateCommand, + DeleteDedicatedIpPoolCommand, + DeleteEmailIdentityCommand, + DeleteEmailIdentityPolicyCommand, + DeleteEmailTemplateCommand, + DeleteSuppressedDestinationCommand, + GetAccountCommand, + GetBlacklistReportsCommand, + GetConfigurationSetCommand, + GetConfigurationSetEventDestinationsCommand, + GetContactCommand, + GetContactListCommand, + GetCustomVerificationEmailTemplateCommand, + GetDedicatedIpCommand, + GetDedicatedIpPoolCommand, + GetDedicatedIpsCommand, + GetDeliverabilityDashboardOptionsCommand, + GetDeliverabilityTestReportCommand, + GetDomainDeliverabilityCampaignCommand, + GetDomainStatisticsReportCommand, + GetEmailIdentityCommand, + GetEmailIdentityPoliciesCommand, + GetEmailTemplateCommand, + GetImportJobCommand, + GetSuppressedDestinationCommand, + ListConfigurationSetsCommand, + ListContactListsCommand, + ListContactsCommand, + ListCustomVerificationEmailTemplatesCommand, + ListDedicatedIpPoolsCommand, + ListDeliverabilityTestReportsCommand, + ListDomainDeliverabilityCampaignsCommand, + ListEmailIdentitiesCommand, + ListEmailTemplatesCommand, + ListImportJobsCommand, + ListRecommendationsCommand, + ListSuppressedDestinationsCommand, + ListTagsForResourceCommand, + PutAccountDedicatedIpWarmupAttributesCommand, + PutAccountDetailsCommand, + PutAccountSendingAttributesCommand, + PutAccountSuppressionAttributesCommand, + PutAccountVdmAttributesCommand, + PutConfigurationSetDeliveryOptionsCommand, + PutConfigurationSetReputationOptionsCommand, + PutConfigurationSetSendingOptionsCommand, + PutConfigurationSetSuppressionOptionsCommand, + PutConfigurationSetTrackingOptionsCommand, + PutConfigurationSetVdmOptionsCommand, + PutDedicatedIpInPoolCommand, + PutDedicatedIpWarmupAttributesCommand, + PutDeliverabilityDashboardOptionCommand, + PutEmailIdentityConfigurationSetAttributesCommand, + PutEmailIdentityDkimAttributesCommand, + PutEmailIdentityDkimSigningAttributesCommand, + PutEmailIdentityFeedbackAttributesCommand, + PutEmailIdentityMailFromAttributesCommand, + PutSuppressedDestinationCommand, + SendBulkEmailCommand, + SendCustomVerificationEmailCommand, + SendEmailCommand, + TagResourceCommand, + TestRenderEmailTemplateCommand, + UntagResourceCommand, + UpdateConfigurationSetEventDestinationCommand, + UpdateContactCommand, + UpdateContactListCommand, + UpdateCustomVerificationEmailTemplateCommand, + UpdateEmailIdentityPolicyCommand, + UpdateEmailTemplateCommand, +}; + +export interface SESv2 { /** - * @public - *

Retrieves batches of metric data collected based on your sending activity.

- *

You can execute this operation no more than 16 times per second, - * and with at most 160 queries from the batches per second (cumulative).

+ * @see {@link BatchGetMetricDataCommand} */ - public batchGetMetricData( + batchGetMetricData( args: BatchGetMetricDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetMetricData( + batchGetMetricData( args: BatchGetMetricDataCommandInput, cb: (err: any, data?: BatchGetMetricDataCommandOutput) => void ): void; - public batchGetMetricData( + batchGetMetricData( args: BatchGetMetricDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetMetricDataCommandOutput) => void ): void; - public batchGetMetricData( - args: BatchGetMetricDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetMetricDataCommandOutput) => void), - cb?: (err: any, data?: BatchGetMetricDataCommandOutput) => void - ): Promise | void { - const command = new BatchGetMetricDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Create a configuration set. Configuration sets are groups of - * rules that you can apply to the emails that you send. You apply a configuration set to - * an email by specifying the name of the configuration set when you call the Amazon SES API v2. When - * you apply a configuration set to an email, all of the rules in that configuration set - * are applied to the email.

- */ - public createConfigurationSet( + + /** + * @see {@link CreateConfigurationSetCommand} + */ + createConfigurationSet( args: CreateConfigurationSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConfigurationSet( + createConfigurationSet( args: CreateConfigurationSetCommandInput, cb: (err: any, data?: CreateConfigurationSetCommandOutput) => void ): void; - public createConfigurationSet( + createConfigurationSet( args: CreateConfigurationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfigurationSetCommandOutput) => void ): void; - public createConfigurationSet( - args: CreateConfigurationSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConfigurationSetCommandOutput) => void), - cb?: (err: any, data?: CreateConfigurationSetCommandOutput) => void - ): Promise | void { - const command = new CreateConfigurationSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Create an event destination. Events include message sends, - * deliveries, opens, clicks, bounces, and complaints. Event - * destinations are places that you can send information about these events - * to. For example, you can send event data to Amazon SNS to receive notifications when you - * receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term - * storage.

- *

A single configuration set can include more than one event destination.

- */ - public createConfigurationSetEventDestination( + + /** + * @see {@link CreateConfigurationSetEventDestinationCommand} + */ + createConfigurationSetEventDestination( args: CreateConfigurationSetEventDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConfigurationSetEventDestination( + createConfigurationSetEventDestination( args: CreateConfigurationSetEventDestinationCommandInput, cb: (err: any, data?: CreateConfigurationSetEventDestinationCommandOutput) => void ): void; - public createConfigurationSetEventDestination( + createConfigurationSetEventDestination( args: CreateConfigurationSetEventDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfigurationSetEventDestinationCommandOutput) => void ): void; - public createConfigurationSetEventDestination( - args: CreateConfigurationSetEventDestinationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateConfigurationSetEventDestinationCommandOutput) => void), - cb?: (err: any, data?: CreateConfigurationSetEventDestinationCommandOutput) => void - ): Promise | void { - const command = new CreateConfigurationSetEventDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a contact, which is an end-user who is receiving the email, and adds them to a - * contact list.

- */ - public createContact( - args: CreateContactCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createContact( - args: CreateContactCommandInput, - cb: (err: any, data?: CreateContactCommandOutput) => void - ): void; - public createContact( + + /** + * @see {@link CreateContactCommand} + */ + createContact(args: CreateContactCommandInput, options?: __HttpHandlerOptions): Promise; + createContact(args: CreateContactCommandInput, cb: (err: any, data?: CreateContactCommandOutput) => void): void; + createContact( args: CreateContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateContactCommandOutput) => void ): void; - public createContact( - args: CreateContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateContactCommandOutput) => void), - cb?: (err: any, data?: CreateContactCommandOutput) => void - ): Promise | void { - const command = new CreateContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a contact list.

- */ - public createContactList( + + /** + * @see {@link CreateContactListCommand} + */ + createContactList( args: CreateContactListCommandInput, options?: __HttpHandlerOptions ): Promise; - public createContactList( + createContactList( args: CreateContactListCommandInput, cb: (err: any, data?: CreateContactListCommandOutput) => void ): void; - public createContactList( + createContactList( args: CreateContactListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateContactListCommandOutput) => void ): void; - public createContactList( - args: CreateContactListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateContactListCommandOutput) => void), - cb?: (err: any, data?: CreateContactListCommandOutput) => void - ): Promise | void { - const command = new CreateContactListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new custom verification email template.

- *

For more information about custom verification email templates, see Using - * custom verification email templates in the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public createCustomVerificationEmailTemplate( + + /** + * @see {@link CreateCustomVerificationEmailTemplateCommand} + */ + createCustomVerificationEmailTemplate( args: CreateCustomVerificationEmailTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCustomVerificationEmailTemplate( + createCustomVerificationEmailTemplate( args: CreateCustomVerificationEmailTemplateCommandInput, cb: (err: any, data?: CreateCustomVerificationEmailTemplateCommandOutput) => void ): void; - public createCustomVerificationEmailTemplate( + createCustomVerificationEmailTemplate( args: CreateCustomVerificationEmailTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomVerificationEmailTemplateCommandOutput) => void ): void; - public createCustomVerificationEmailTemplate( - args: CreateCustomVerificationEmailTemplateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateCustomVerificationEmailTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateCustomVerificationEmailTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateCustomVerificationEmailTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Create a new pool of dedicated IP addresses. A pool can include one or more dedicated - * IP addresses that are associated with your Amazon Web Services account. You can associate a pool with - * a configuration set. When you send an email that uses that configuration set, the - * message is sent from one of the addresses in the associated pool.

- */ - public createDedicatedIpPool( + + /** + * @see {@link CreateDedicatedIpPoolCommand} + */ + createDedicatedIpPool( args: CreateDedicatedIpPoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDedicatedIpPool( + createDedicatedIpPool( args: CreateDedicatedIpPoolCommandInput, cb: (err: any, data?: CreateDedicatedIpPoolCommandOutput) => void ): void; - public createDedicatedIpPool( + createDedicatedIpPool( args: CreateDedicatedIpPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDedicatedIpPoolCommandOutput) => void ): void; - public createDedicatedIpPool( - args: CreateDedicatedIpPoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDedicatedIpPoolCommandOutput) => void), - cb?: (err: any, data?: CreateDedicatedIpPoolCommandOutput) => void - ): Promise | void { - const command = new CreateDedicatedIpPoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled - * by various email providers around the world. When you perform a predictive inbox placement test, you provide a - * sample message that contains the content that you plan to send to your customers. Amazon SES - * then sends that message to special email addresses spread across several major email - * providers. After about 24 hours, the test is complete, and you can use the - * GetDeliverabilityTestReport operation to view the results of the - * test.

- */ - public createDeliverabilityTestReport( + + /** + * @see {@link CreateDeliverabilityTestReportCommand} + */ + createDeliverabilityTestReport( args: CreateDeliverabilityTestReportCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDeliverabilityTestReport( + createDeliverabilityTestReport( args: CreateDeliverabilityTestReportCommandInput, cb: (err: any, data?: CreateDeliverabilityTestReportCommandOutput) => void ): void; - public createDeliverabilityTestReport( + createDeliverabilityTestReport( args: CreateDeliverabilityTestReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDeliverabilityTestReportCommandOutput) => void ): void; - public createDeliverabilityTestReport( - args: CreateDeliverabilityTestReportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDeliverabilityTestReportCommandOutput) => void), - cb?: (err: any, data?: CreateDeliverabilityTestReportCommandOutput) => void - ): Promise | void { - const command = new CreateDeliverabilityTestReportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts the process of verifying an email identity. An identity is - * an email address or domain that you use when you send email. Before you can use an - * identity to send email, you first have to verify it. By verifying an identity, you - * demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2 - * permission to send email from the identity.

- *

When you verify an email address, Amazon SES sends an email to the address. Your email - * address is verified as soon as you follow the link in the verification email. - * - *

- *

When you verify a domain without specifying the DkimSigningAttributes - * object, this operation provides a set of DKIM tokens. You can convert these tokens into - * CNAME records, which you then add to the DNS configuration for your domain. Your domain - * is verified when Amazon SES detects these records in the DNS configuration for your domain. - * This verification method is known as Easy DKIM.

- *

Alternatively, you can perform the verification process by providing your own - * public-private key pair. This verification method is known as Bring Your Own DKIM - * (BYODKIM). To use BYODKIM, your call to the CreateEmailIdentity operation - * has to include the DkimSigningAttributes object. When you specify this - * object, you provide a selector (a component of the DNS record name that identifies the - * public key to use for DKIM authentication) and a private key.

- *

When you verify a domain, this operation provides a set of DKIM tokens, which you can - * convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your - * domain. Your domain is verified when Amazon SES detects these records in the DNS - * configuration for your domain. For some DNS providers, it can take 72 hours or more to - * complete the domain verification process.

- *

Additionally, you can associate an existing configuration set with the email identity that you're verifying.

- */ - public createEmailIdentity( + + /** + * @see {@link CreateEmailIdentityCommand} + */ + createEmailIdentity( args: CreateEmailIdentityCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEmailIdentity( + createEmailIdentity( args: CreateEmailIdentityCommandInput, cb: (err: any, data?: CreateEmailIdentityCommandOutput) => void ): void; - public createEmailIdentity( + createEmailIdentity( args: CreateEmailIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEmailIdentityCommandOutput) => void ): void; - public createEmailIdentity( - args: CreateEmailIdentityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEmailIdentityCommandOutput) => void), - cb?: (err: any, data?: CreateEmailIdentityCommandOutput) => void - ): Promise | void { - const command = new CreateEmailIdentityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates the specified sending authorization policy for the given identity (an email - * address or a domain).

- * - *

This API is for the identity owner only. If you have not verified the identity, - * this API will return an error.

- *
- *

Sending authorization is a feature that enables an identity owner to authorize other - * senders to use its identities. For information about using sending authorization, see - * the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public createEmailIdentityPolicy( + + /** + * @see {@link CreateEmailIdentityPolicyCommand} + */ + createEmailIdentityPolicy( args: CreateEmailIdentityPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEmailIdentityPolicy( + createEmailIdentityPolicy( args: CreateEmailIdentityPolicyCommandInput, cb: (err: any, data?: CreateEmailIdentityPolicyCommandOutput) => void ): void; - public createEmailIdentityPolicy( + createEmailIdentityPolicy( args: CreateEmailIdentityPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEmailIdentityPolicyCommandOutput) => void ): void; - public createEmailIdentityPolicy( - args: CreateEmailIdentityPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEmailIdentityPolicyCommandOutput) => void), - cb?: (err: any, data?: CreateEmailIdentityPolicyCommandOutput) => void - ): Promise | void { - const command = new CreateEmailIdentityPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an email template. Email templates enable you to send personalized email to - * one or more destinations in a single API operation. For more information, see the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public createEmailTemplate( + + /** + * @see {@link CreateEmailTemplateCommand} + */ + createEmailTemplate( args: CreateEmailTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public createEmailTemplate( + createEmailTemplate( args: CreateEmailTemplateCommandInput, cb: (err: any, data?: CreateEmailTemplateCommandOutput) => void ): void; - public createEmailTemplate( + createEmailTemplate( args: CreateEmailTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEmailTemplateCommandOutput) => void ): void; - public createEmailTemplate( - args: CreateEmailTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateEmailTemplateCommandOutput) => void), - cb?: (err: any, data?: CreateEmailTemplateCommandOutput) => void - ): Promise | void { - const command = new CreateEmailTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an import job for a data destination.

- */ - public createImportJob( + + /** + * @see {@link CreateImportJobCommand} + */ + createImportJob( args: CreateImportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createImportJob( - args: CreateImportJobCommandInput, - cb: (err: any, data?: CreateImportJobCommandOutput) => void - ): void; - public createImportJob( + createImportJob(args: CreateImportJobCommandInput, cb: (err: any, data?: CreateImportJobCommandOutput) => void): void; + createImportJob( args: CreateImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateImportJobCommandOutput) => void ): void; - public createImportJob( - args: CreateImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateImportJobCommandOutput) => void), - cb?: (err: any, data?: CreateImportJobCommandOutput) => void - ): Promise | void { - const command = new CreateImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete an existing configuration set.

- *

- * Configuration sets are groups of rules that you can apply to the - * emails you send. You apply a configuration set to an email by including a reference to - * the configuration set in the headers of the email. When you apply a configuration set to - * an email, all of the rules in that configuration set are applied to the email.

- */ - public deleteConfigurationSet( + + /** + * @see {@link DeleteConfigurationSetCommand} + */ + deleteConfigurationSet( args: DeleteConfigurationSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConfigurationSet( + deleteConfigurationSet( args: DeleteConfigurationSetCommandInput, cb: (err: any, data?: DeleteConfigurationSetCommandOutput) => void ): void; - public deleteConfigurationSet( + deleteConfigurationSet( args: DeleteConfigurationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationSetCommandOutput) => void ): void; - public deleteConfigurationSet( - args: DeleteConfigurationSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConfigurationSetCommandOutput) => void), - cb?: (err: any, data?: DeleteConfigurationSetCommandOutput) => void - ): Promise | void { - const command = new DeleteConfigurationSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete an event destination.

- *

- * Events include message sends, deliveries, opens, clicks, bounces, - * and complaints. Event destinations are places that you can send - * information about these events to. For example, you can send event data to Amazon SNS to - * receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to - * stream data to Amazon S3 for long-term storage.

- */ - public deleteConfigurationSetEventDestination( + + /** + * @see {@link DeleteConfigurationSetEventDestinationCommand} + */ + deleteConfigurationSetEventDestination( args: DeleteConfigurationSetEventDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConfigurationSetEventDestination( + deleteConfigurationSetEventDestination( args: DeleteConfigurationSetEventDestinationCommandInput, cb: (err: any, data?: DeleteConfigurationSetEventDestinationCommandOutput) => void ): void; - public deleteConfigurationSetEventDestination( + deleteConfigurationSetEventDestination( args: DeleteConfigurationSetEventDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationSetEventDestinationCommandOutput) => void ): void; - public deleteConfigurationSetEventDestination( - args: DeleteConfigurationSetEventDestinationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteConfigurationSetEventDestinationCommandOutput) => void), - cb?: (err: any, data?: DeleteConfigurationSetEventDestinationCommandOutput) => void - ): Promise | void { - const command = new DeleteConfigurationSetEventDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a contact from a contact list.

- */ - public deleteContact( - args: DeleteContactCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteContact( - args: DeleteContactCommandInput, - cb: (err: any, data?: DeleteContactCommandOutput) => void - ): void; - public deleteContact( + + /** + * @see {@link DeleteContactCommand} + */ + deleteContact(args: DeleteContactCommandInput, options?: __HttpHandlerOptions): Promise; + deleteContact(args: DeleteContactCommandInput, cb: (err: any, data?: DeleteContactCommandOutput) => void): void; + deleteContact( args: DeleteContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteContactCommandOutput) => void ): void; - public deleteContact( - args: DeleteContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteContactCommandOutput) => void), - cb?: (err: any, data?: DeleteContactCommandOutput) => void - ): Promise | void { - const command = new DeleteContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a contact list and all of the contacts on that list.

- */ - public deleteContactList( + + /** + * @see {@link DeleteContactListCommand} + */ + deleteContactList( args: DeleteContactListCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteContactList( + deleteContactList( args: DeleteContactListCommandInput, cb: (err: any, data?: DeleteContactListCommandOutput) => void ): void; - public deleteContactList( + deleteContactList( args: DeleteContactListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteContactListCommandOutput) => void ): void; - public deleteContactList( - args: DeleteContactListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteContactListCommandOutput) => void), - cb?: (err: any, data?: DeleteContactListCommandOutput) => void - ): Promise | void { - const command = new DeleteContactListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an existing custom verification email template.

- *

For more information about custom verification email templates, see Using - * custom verification email templates in the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public deleteCustomVerificationEmailTemplate( + + /** + * @see {@link DeleteCustomVerificationEmailTemplateCommand} + */ + deleteCustomVerificationEmailTemplate( args: DeleteCustomVerificationEmailTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCustomVerificationEmailTemplate( + deleteCustomVerificationEmailTemplate( args: DeleteCustomVerificationEmailTemplateCommandInput, cb: (err: any, data?: DeleteCustomVerificationEmailTemplateCommandOutput) => void ): void; - public deleteCustomVerificationEmailTemplate( + deleteCustomVerificationEmailTemplate( args: DeleteCustomVerificationEmailTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomVerificationEmailTemplateCommandOutput) => void ): void; - public deleteCustomVerificationEmailTemplate( - args: DeleteCustomVerificationEmailTemplateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteCustomVerificationEmailTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteCustomVerificationEmailTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteCustomVerificationEmailTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete a dedicated IP pool.

- */ - public deleteDedicatedIpPool( + + /** + * @see {@link DeleteDedicatedIpPoolCommand} + */ + deleteDedicatedIpPool( args: DeleteDedicatedIpPoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDedicatedIpPool( + deleteDedicatedIpPool( args: DeleteDedicatedIpPoolCommandInput, cb: (err: any, data?: DeleteDedicatedIpPoolCommandOutput) => void ): void; - public deleteDedicatedIpPool( + deleteDedicatedIpPool( args: DeleteDedicatedIpPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDedicatedIpPoolCommandOutput) => void ): void; - public deleteDedicatedIpPool( - args: DeleteDedicatedIpPoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDedicatedIpPoolCommandOutput) => void), - cb?: (err: any, data?: DeleteDedicatedIpPoolCommandOutput) => void - ): Promise | void { - const command = new DeleteDedicatedIpPoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an email identity. An identity can be either an email address or a domain - * name.

- */ - public deleteEmailIdentity( + + /** + * @see {@link DeleteEmailIdentityCommand} + */ + deleteEmailIdentity( args: DeleteEmailIdentityCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEmailIdentity( + deleteEmailIdentity( args: DeleteEmailIdentityCommandInput, cb: (err: any, data?: DeleteEmailIdentityCommandOutput) => void ): void; - public deleteEmailIdentity( + deleteEmailIdentity( args: DeleteEmailIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEmailIdentityCommandOutput) => void ): void; - public deleteEmailIdentity( - args: DeleteEmailIdentityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEmailIdentityCommandOutput) => void), - cb?: (err: any, data?: DeleteEmailIdentityCommandOutput) => void - ): Promise | void { - const command = new DeleteEmailIdentityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified sending authorization policy for the given identity (an email - * address or a domain). This API returns successfully even if a policy with the specified - * name does not exist.

- * - *

This API is for the identity owner only. If you have not verified the identity, - * this API will return an error.

- *
- *

Sending authorization is a feature that enables an identity owner to authorize other - * senders to use its identities. For information about using sending authorization, see - * the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public deleteEmailIdentityPolicy( + + /** + * @see {@link DeleteEmailIdentityPolicyCommand} + */ + deleteEmailIdentityPolicy( args: DeleteEmailIdentityPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEmailIdentityPolicy( + deleteEmailIdentityPolicy( args: DeleteEmailIdentityPolicyCommandInput, cb: (err: any, data?: DeleteEmailIdentityPolicyCommandOutput) => void ): void; - public deleteEmailIdentityPolicy( + deleteEmailIdentityPolicy( args: DeleteEmailIdentityPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEmailIdentityPolicyCommandOutput) => void ): void; - public deleteEmailIdentityPolicy( - args: DeleteEmailIdentityPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEmailIdentityPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteEmailIdentityPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteEmailIdentityPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an email template.

- *

You can execute this operation no more than once per second.

- */ - public deleteEmailTemplate( + + /** + * @see {@link DeleteEmailTemplateCommand} + */ + deleteEmailTemplate( args: DeleteEmailTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEmailTemplate( + deleteEmailTemplate( args: DeleteEmailTemplateCommandInput, cb: (err: any, data?: DeleteEmailTemplateCommandOutput) => void ): void; - public deleteEmailTemplate( + deleteEmailTemplate( args: DeleteEmailTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEmailTemplateCommandOutput) => void ): void; - public deleteEmailTemplate( - args: DeleteEmailTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEmailTemplateCommandOutput) => void), - cb?: (err: any, data?: DeleteEmailTemplateCommandOutput) => void - ): Promise | void { - const command = new DeleteEmailTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes an email address from the suppression list for your account.

- */ - public deleteSuppressedDestination( + + /** + * @see {@link DeleteSuppressedDestinationCommand} + */ + deleteSuppressedDestination( args: DeleteSuppressedDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSuppressedDestination( + deleteSuppressedDestination( args: DeleteSuppressedDestinationCommandInput, cb: (err: any, data?: DeleteSuppressedDestinationCommandOutput) => void ): void; - public deleteSuppressedDestination( + deleteSuppressedDestination( args: DeleteSuppressedDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSuppressedDestinationCommandOutput) => void ): void; - public deleteSuppressedDestination( - args: DeleteSuppressedDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSuppressedDestinationCommandOutput) => void), - cb?: (err: any, data?: DeleteSuppressedDestinationCommandOutput) => void - ): Promise | void { - const command = new DeleteSuppressedDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Obtain information about the email-sending status and capabilities of your Amazon SES - * account in the current Amazon Web Services Region.

- */ - public getAccount(args: GetAccountCommandInput, options?: __HttpHandlerOptions): Promise; - public getAccount(args: GetAccountCommandInput, cb: (err: any, data?: GetAccountCommandOutput) => void): void; - public getAccount( + + /** + * @see {@link GetAccountCommand} + */ + getAccount(args: GetAccountCommandInput, options?: __HttpHandlerOptions): Promise; + getAccount(args: GetAccountCommandInput, cb: (err: any, data?: GetAccountCommandOutput) => void): void; + getAccount( args: GetAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountCommandOutput) => void ): void; - public getAccount( - args: GetAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccountCommandOutput) => void), - cb?: (err: any, data?: GetAccountCommandOutput) => void - ): Promise | void { - const command = new GetAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieve a list of the blacklists that your dedicated IP addresses appear on.

- */ - public getBlacklistReports( + + /** + * @see {@link GetBlacklistReportsCommand} + */ + getBlacklistReports( args: GetBlacklistReportsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBlacklistReports( + getBlacklistReports( args: GetBlacklistReportsCommandInput, cb: (err: any, data?: GetBlacklistReportsCommandOutput) => void ): void; - public getBlacklistReports( + getBlacklistReports( args: GetBlacklistReportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBlacklistReportsCommandOutput) => void ): void; - public getBlacklistReports( - args: GetBlacklistReportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBlacklistReportsCommandOutput) => void), - cb?: (err: any, data?: GetBlacklistReportsCommandOutput) => void - ): Promise | void { - const command = new GetBlacklistReportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get information about an existing configuration set, including the dedicated IP pool - * that it's associated with, whether or not it's enabled for sending email, and - * more.

- *

- * Configuration sets are groups of rules that you can apply to the - * emails you send. You apply a configuration set to an email by including a reference to - * the configuration set in the headers of the email. When you apply a configuration set to - * an email, all of the rules in that configuration set are applied to the email.

- */ - public getConfigurationSet( + + /** + * @see {@link GetConfigurationSetCommand} + */ + getConfigurationSet( args: GetConfigurationSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConfigurationSet( + getConfigurationSet( args: GetConfigurationSetCommandInput, cb: (err: any, data?: GetConfigurationSetCommandOutput) => void ): void; - public getConfigurationSet( + getConfigurationSet( args: GetConfigurationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConfigurationSetCommandOutput) => void ): void; - public getConfigurationSet( - args: GetConfigurationSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConfigurationSetCommandOutput) => void), - cb?: (err: any, data?: GetConfigurationSetCommandOutput) => void - ): Promise | void { - const command = new GetConfigurationSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieve a list of event destinations that are associated with a configuration - * set.

- *

- * Events include message sends, deliveries, opens, clicks, bounces, - * and complaints. Event destinations are places that you can send - * information about these events to. For example, you can send event data to Amazon SNS to - * receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to - * stream data to Amazon S3 for long-term storage.

- */ - public getConfigurationSetEventDestinations( + + /** + * @see {@link GetConfigurationSetEventDestinationsCommand} + */ + getConfigurationSetEventDestinations( args: GetConfigurationSetEventDestinationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConfigurationSetEventDestinations( + getConfigurationSetEventDestinations( args: GetConfigurationSetEventDestinationsCommandInput, cb: (err: any, data?: GetConfigurationSetEventDestinationsCommandOutput) => void ): void; - public getConfigurationSetEventDestinations( + getConfigurationSetEventDestinations( args: GetConfigurationSetEventDestinationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConfigurationSetEventDestinationsCommandOutput) => void ): void; - public getConfigurationSetEventDestinations( - args: GetConfigurationSetEventDestinationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConfigurationSetEventDestinationsCommandOutput) => void), - cb?: (err: any, data?: GetConfigurationSetEventDestinationsCommandOutput) => void - ): Promise | void { - const command = new GetConfigurationSetEventDestinationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a contact from a contact list.

- */ - public getContact(args: GetContactCommandInput, options?: __HttpHandlerOptions): Promise; - public getContact(args: GetContactCommandInput, cb: (err: any, data?: GetContactCommandOutput) => void): void; - public getContact( + + /** + * @see {@link GetContactCommand} + */ + getContact(args: GetContactCommandInput, options?: __HttpHandlerOptions): Promise; + getContact(args: GetContactCommandInput, cb: (err: any, data?: GetContactCommandOutput) => void): void; + getContact( args: GetContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContactCommandOutput) => void ): void; - public getContact( - args: GetContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContactCommandOutput) => void), - cb?: (err: any, data?: GetContactCommandOutput) => void - ): Promise | void { - const command = new GetContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns contact list metadata. It does not return any information about the contacts - * present in the list.

- */ - public getContactList( + + /** + * @see {@link GetContactListCommand} + */ + getContactList( args: GetContactListCommandInput, options?: __HttpHandlerOptions ): Promise; - public getContactList( - args: GetContactListCommandInput, - cb: (err: any, data?: GetContactListCommandOutput) => void - ): void; - public getContactList( + getContactList(args: GetContactListCommandInput, cb: (err: any, data?: GetContactListCommandOutput) => void): void; + getContactList( args: GetContactListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContactListCommandOutput) => void ): void; - public getContactList( - args: GetContactListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContactListCommandOutput) => void), - cb?: (err: any, data?: GetContactListCommandOutput) => void - ): Promise | void { - const command = new GetContactListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the custom email verification template for the template name you - * specify.

- *

For more information about custom verification email templates, see Using - * custom verification email templates in the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public getCustomVerificationEmailTemplate( + + /** + * @see {@link GetCustomVerificationEmailTemplateCommand} + */ + getCustomVerificationEmailTemplate( args: GetCustomVerificationEmailTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCustomVerificationEmailTemplate( + getCustomVerificationEmailTemplate( args: GetCustomVerificationEmailTemplateCommandInput, cb: (err: any, data?: GetCustomVerificationEmailTemplateCommandOutput) => void ): void; - public getCustomVerificationEmailTemplate( + getCustomVerificationEmailTemplate( args: GetCustomVerificationEmailTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCustomVerificationEmailTemplateCommandOutput) => void ): void; - public getCustomVerificationEmailTemplate( - args: GetCustomVerificationEmailTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCustomVerificationEmailTemplateCommandOutput) => void), - cb?: (err: any, data?: GetCustomVerificationEmailTemplateCommandOutput) => void - ): Promise | void { - const command = new GetCustomVerificationEmailTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get information about a dedicated IP address, including the name of the dedicated IP - * pool that it's associated with, as well information about the automatic warm-up process - * for the address.

- */ - public getDedicatedIp( + + /** + * @see {@link GetDedicatedIpCommand} + */ + getDedicatedIp( args: GetDedicatedIpCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDedicatedIp( - args: GetDedicatedIpCommandInput, - cb: (err: any, data?: GetDedicatedIpCommandOutput) => void - ): void; - public getDedicatedIp( + getDedicatedIp(args: GetDedicatedIpCommandInput, cb: (err: any, data?: GetDedicatedIpCommandOutput) => void): void; + getDedicatedIp( args: GetDedicatedIpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDedicatedIpCommandOutput) => void ): void; - public getDedicatedIp( - args: GetDedicatedIpCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDedicatedIpCommandOutput) => void), - cb?: (err: any, data?: GetDedicatedIpCommandOutput) => void - ): Promise | void { - const command = new GetDedicatedIpCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieve information about the dedicated pool.

- */ - public getDedicatedIpPool( + + /** + * @see {@link GetDedicatedIpPoolCommand} + */ + getDedicatedIpPool( args: GetDedicatedIpPoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDedicatedIpPool( + getDedicatedIpPool( args: GetDedicatedIpPoolCommandInput, cb: (err: any, data?: GetDedicatedIpPoolCommandOutput) => void ): void; - public getDedicatedIpPool( + getDedicatedIpPool( args: GetDedicatedIpPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDedicatedIpPoolCommandOutput) => void ): void; - public getDedicatedIpPool( - args: GetDedicatedIpPoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDedicatedIpPoolCommandOutput) => void), - cb?: (err: any, data?: GetDedicatedIpPoolCommandOutput) => void - ): Promise | void { - const command = new GetDedicatedIpPoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List the dedicated IP addresses that are associated with your Amazon Web Services - * account.

- */ - public getDedicatedIps( + + /** + * @see {@link GetDedicatedIpsCommand} + */ + getDedicatedIps( args: GetDedicatedIpsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDedicatedIps( - args: GetDedicatedIpsCommandInput, - cb: (err: any, data?: GetDedicatedIpsCommandOutput) => void - ): void; - public getDedicatedIps( + getDedicatedIps(args: GetDedicatedIpsCommandInput, cb: (err: any, data?: GetDedicatedIpsCommandOutput) => void): void; + getDedicatedIps( args: GetDedicatedIpsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDedicatedIpsCommandOutput) => void ): void; - public getDedicatedIps( - args: GetDedicatedIpsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDedicatedIpsCommandOutput) => void), - cb?: (err: any, data?: GetDedicatedIpsCommandOutput) => void - ): Promise | void { - const command = new GetDedicatedIpsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieve information about the status of the Deliverability dashboard for your account. When - * the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other - * metrics for the domains that you use to send email. You also gain the ability to perform - * predictive inbox placement tests.

- *

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition - * to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more - * information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing.

- */ - public getDeliverabilityDashboardOptions( + + /** + * @see {@link GetDeliverabilityDashboardOptionsCommand} + */ + getDeliverabilityDashboardOptions( args: GetDeliverabilityDashboardOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDeliverabilityDashboardOptions( + getDeliverabilityDashboardOptions( args: GetDeliverabilityDashboardOptionsCommandInput, cb: (err: any, data?: GetDeliverabilityDashboardOptionsCommandOutput) => void ): void; - public getDeliverabilityDashboardOptions( + getDeliverabilityDashboardOptions( args: GetDeliverabilityDashboardOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeliverabilityDashboardOptionsCommandOutput) => void ): void; - public getDeliverabilityDashboardOptions( - args: GetDeliverabilityDashboardOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeliverabilityDashboardOptionsCommandOutput) => void), - cb?: (err: any, data?: GetDeliverabilityDashboardOptionsCommandOutput) => void - ): Promise | void { - const command = new GetDeliverabilityDashboardOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieve the results of a predictive inbox placement test.

- */ - public getDeliverabilityTestReport( + + /** + * @see {@link GetDeliverabilityTestReportCommand} + */ + getDeliverabilityTestReport( args: GetDeliverabilityTestReportCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDeliverabilityTestReport( + getDeliverabilityTestReport( args: GetDeliverabilityTestReportCommandInput, cb: (err: any, data?: GetDeliverabilityTestReportCommandOutput) => void ): void; - public getDeliverabilityTestReport( + getDeliverabilityTestReport( args: GetDeliverabilityTestReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeliverabilityTestReportCommandOutput) => void ): void; - public getDeliverabilityTestReport( - args: GetDeliverabilityTestReportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDeliverabilityTestReportCommandOutput) => void), - cb?: (err: any, data?: GetDeliverabilityTestReportCommandOutput) => void - ): Promise | void { - const command = new GetDeliverabilityTestReportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieve all the deliverability data for a specific campaign. This data is available - * for a campaign only if the campaign sent email by using a domain that the - * Deliverability dashboard is enabled for.

- */ - public getDomainDeliverabilityCampaign( + + /** + * @see {@link GetDomainDeliverabilityCampaignCommand} + */ + getDomainDeliverabilityCampaign( args: GetDomainDeliverabilityCampaignCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDomainDeliverabilityCampaign( + getDomainDeliverabilityCampaign( args: GetDomainDeliverabilityCampaignCommandInput, cb: (err: any, data?: GetDomainDeliverabilityCampaignCommandOutput) => void ): void; - public getDomainDeliverabilityCampaign( + getDomainDeliverabilityCampaign( args: GetDomainDeliverabilityCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDomainDeliverabilityCampaignCommandOutput) => void ): void; - public getDomainDeliverabilityCampaign( - args: GetDomainDeliverabilityCampaignCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDomainDeliverabilityCampaignCommandOutput) => void), - cb?: (err: any, data?: GetDomainDeliverabilityCampaignCommandOutput) => void - ): Promise | void { - const command = new GetDomainDeliverabilityCampaignCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieve inbox placement and engagement rates for the domains that you use to send - * email.

- */ - public getDomainStatisticsReport( + + /** + * @see {@link GetDomainStatisticsReportCommand} + */ + getDomainStatisticsReport( args: GetDomainStatisticsReportCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDomainStatisticsReport( + getDomainStatisticsReport( args: GetDomainStatisticsReportCommandInput, cb: (err: any, data?: GetDomainStatisticsReportCommandOutput) => void ): void; - public getDomainStatisticsReport( + getDomainStatisticsReport( args: GetDomainStatisticsReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDomainStatisticsReportCommandOutput) => void ): void; - public getDomainStatisticsReport( - args: GetDomainStatisticsReportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDomainStatisticsReportCommandOutput) => void), - cb?: (err: any, data?: GetDomainStatisticsReportCommandOutput) => void - ): Promise | void { - const command = new GetDomainStatisticsReportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides information about a specific identity, including the identity's verification - * status, sending authorization policies, its DKIM authentication status, and its custom - * Mail-From settings.

- */ - public getEmailIdentity( + + /** + * @see {@link GetEmailIdentityCommand} + */ + getEmailIdentity( args: GetEmailIdentityCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEmailIdentity( + getEmailIdentity( args: GetEmailIdentityCommandInput, cb: (err: any, data?: GetEmailIdentityCommandOutput) => void ): void; - public getEmailIdentity( + getEmailIdentity( args: GetEmailIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEmailIdentityCommandOutput) => void ): void; - public getEmailIdentity( - args: GetEmailIdentityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEmailIdentityCommandOutput) => void), - cb?: (err: any, data?: GetEmailIdentityCommandOutput) => void - ): Promise | void { - const command = new GetEmailIdentityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the requested sending authorization policies for the given identity (an email - * address or a domain). The policies are returned as a map of policy names to policy - * contents. You can retrieve a maximum of 20 policies at a time.

- * - *

This API is for the identity owner only. If you have not verified the identity, - * this API will return an error.

- *
- *

Sending authorization is a feature that enables an identity owner to authorize other - * senders to use its identities. For information about using sending authorization, see - * the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public getEmailIdentityPolicies( + + /** + * @see {@link GetEmailIdentityPoliciesCommand} + */ + getEmailIdentityPolicies( args: GetEmailIdentityPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEmailIdentityPolicies( + getEmailIdentityPolicies( args: GetEmailIdentityPoliciesCommandInput, cb: (err: any, data?: GetEmailIdentityPoliciesCommandOutput) => void ): void; - public getEmailIdentityPolicies( + getEmailIdentityPolicies( args: GetEmailIdentityPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEmailIdentityPoliciesCommandOutput) => void ): void; - public getEmailIdentityPolicies( - args: GetEmailIdentityPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEmailIdentityPoliciesCommandOutput) => void), - cb?: (err: any, data?: GetEmailIdentityPoliciesCommandOutput) => void - ): Promise | void { - const command = new GetEmailIdentityPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Displays the template object (which includes the subject line, HTML part and text - * part) for the template you specify.

- *

You can execute this operation no more than once per second.

- */ - public getEmailTemplate( + + /** + * @see {@link GetEmailTemplateCommand} + */ + getEmailTemplate( args: GetEmailTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEmailTemplate( + getEmailTemplate( args: GetEmailTemplateCommandInput, cb: (err: any, data?: GetEmailTemplateCommandOutput) => void ): void; - public getEmailTemplate( + getEmailTemplate( args: GetEmailTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEmailTemplateCommandOutput) => void ): void; - public getEmailTemplate( - args: GetEmailTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEmailTemplateCommandOutput) => void), - cb?: (err: any, data?: GetEmailTemplateCommandOutput) => void - ): Promise | void { - const command = new GetEmailTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides information about an import job.

- */ - public getImportJob( - args: GetImportJobCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getImportJob(args: GetImportJobCommandInput, cb: (err: any, data?: GetImportJobCommandOutput) => void): void; - public getImportJob( + + /** + * @see {@link GetImportJobCommand} + */ + getImportJob(args: GetImportJobCommandInput, options?: __HttpHandlerOptions): Promise; + getImportJob(args: GetImportJobCommandInput, cb: (err: any, data?: GetImportJobCommandOutput) => void): void; + getImportJob( args: GetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetImportJobCommandOutput) => void ): void; - public getImportJob( - args: GetImportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetImportJobCommandOutput) => void), - cb?: (err: any, data?: GetImportJobCommandOutput) => void - ): Promise | void { - const command = new GetImportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about a specific email address that's on the suppression list - * for your account.

- */ - public getSuppressedDestination( + + /** + * @see {@link GetSuppressedDestinationCommand} + */ + getSuppressedDestination( args: GetSuppressedDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSuppressedDestination( + getSuppressedDestination( args: GetSuppressedDestinationCommandInput, cb: (err: any, data?: GetSuppressedDestinationCommandOutput) => void ): void; - public getSuppressedDestination( + getSuppressedDestination( args: GetSuppressedDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSuppressedDestinationCommandOutput) => void ): void; - public getSuppressedDestination( - args: GetSuppressedDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSuppressedDestinationCommandOutput) => void), - cb?: (err: any, data?: GetSuppressedDestinationCommandOutput) => void - ): Promise | void { - const command = new GetSuppressedDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List all of the configuration sets associated with your account in the current - * region.

- *

- * Configuration sets are groups of rules that you can apply to the - * emails you send. You apply a configuration set to an email by including a reference to - * the configuration set in the headers of the email. When you apply a configuration set to - * an email, all of the rules in that configuration set are applied to the email.

- */ - public listConfigurationSets( + + /** + * @see {@link ListConfigurationSetsCommand} + */ + listConfigurationSets( args: ListConfigurationSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConfigurationSets( + listConfigurationSets( args: ListConfigurationSetsCommandInput, cb: (err: any, data?: ListConfigurationSetsCommandOutput) => void ): void; - public listConfigurationSets( + listConfigurationSets( args: ListConfigurationSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConfigurationSetsCommandOutput) => void ): void; - public listConfigurationSets( - args: ListConfigurationSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConfigurationSetsCommandOutput) => void), - cb?: (err: any, data?: ListConfigurationSetsCommandOutput) => void - ): Promise | void { - const command = new ListConfigurationSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all of the contact lists available.

- */ - public listContactLists( + + /** + * @see {@link ListContactListsCommand} + */ + listContactLists( args: ListContactListsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listContactLists( + listContactLists( args: ListContactListsCommandInput, cb: (err: any, data?: ListContactListsCommandOutput) => void ): void; - public listContactLists( + listContactLists( args: ListContactListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListContactListsCommandOutput) => void ): void; - public listContactLists( - args: ListContactListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListContactListsCommandOutput) => void), - cb?: (err: any, data?: ListContactListsCommandOutput) => void - ): Promise | void { - const command = new ListContactListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the contacts present in a specific contact list.

- */ - public listContacts( - args: ListContactsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listContacts(args: ListContactsCommandInput, cb: (err: any, data?: ListContactsCommandOutput) => void): void; - public listContacts( + + /** + * @see {@link ListContactsCommand} + */ + listContacts(args: ListContactsCommandInput, options?: __HttpHandlerOptions): Promise; + listContacts(args: ListContactsCommandInput, cb: (err: any, data?: ListContactsCommandOutput) => void): void; + listContacts( args: ListContactsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListContactsCommandOutput) => void ): void; - public listContacts( - args: ListContactsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListContactsCommandOutput) => void), - cb?: (err: any, data?: ListContactsCommandOutput) => void - ): Promise | void { - const command = new ListContactsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the existing custom verification email templates for your account in the current - * Amazon Web Services Region.

- *

For more information about custom verification email templates, see Using - * custom verification email templates in the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public listCustomVerificationEmailTemplates( + + /** + * @see {@link ListCustomVerificationEmailTemplatesCommand} + */ + listCustomVerificationEmailTemplates( args: ListCustomVerificationEmailTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCustomVerificationEmailTemplates( + listCustomVerificationEmailTemplates( args: ListCustomVerificationEmailTemplatesCommandInput, cb: (err: any, data?: ListCustomVerificationEmailTemplatesCommandOutput) => void ): void; - public listCustomVerificationEmailTemplates( + listCustomVerificationEmailTemplates( args: ListCustomVerificationEmailTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCustomVerificationEmailTemplatesCommandOutput) => void ): void; - public listCustomVerificationEmailTemplates( - args: ListCustomVerificationEmailTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCustomVerificationEmailTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListCustomVerificationEmailTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListCustomVerificationEmailTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List all of the dedicated IP pools that exist in your Amazon Web Services account in the current - * Region.

- */ - public listDedicatedIpPools( + + /** + * @see {@link ListDedicatedIpPoolsCommand} + */ + listDedicatedIpPools( args: ListDedicatedIpPoolsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDedicatedIpPools( + listDedicatedIpPools( args: ListDedicatedIpPoolsCommandInput, cb: (err: any, data?: ListDedicatedIpPoolsCommandOutput) => void ): void; - public listDedicatedIpPools( + listDedicatedIpPools( args: ListDedicatedIpPoolsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDedicatedIpPoolsCommandOutput) => void ): void; - public listDedicatedIpPools( - args: ListDedicatedIpPoolsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDedicatedIpPoolsCommandOutput) => void), - cb?: (err: any, data?: ListDedicatedIpPoolsCommandOutput) => void - ): Promise | void { - const command = new ListDedicatedIpPoolsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For - * predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport - * operation to view the results.

- */ - public listDeliverabilityTestReports( + + /** + * @see {@link ListDeliverabilityTestReportsCommand} + */ + listDeliverabilityTestReports( args: ListDeliverabilityTestReportsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeliverabilityTestReports( + listDeliverabilityTestReports( args: ListDeliverabilityTestReportsCommandInput, cb: (err: any, data?: ListDeliverabilityTestReportsCommandOutput) => void ): void; - public listDeliverabilityTestReports( + listDeliverabilityTestReports( args: ListDeliverabilityTestReportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeliverabilityTestReportsCommandOutput) => void ): void; - public listDeliverabilityTestReports( - args: ListDeliverabilityTestReportsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeliverabilityTestReportsCommandOutput) => void), - cb?: (err: any, data?: ListDeliverabilityTestReportsCommandOutput) => void - ): Promise | void { - const command = new ListDeliverabilityTestReportsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieve deliverability data for all the campaigns that used a specific domain to send - * email during a specified time range. This data is available for a domain only if you - * enabled the Deliverability dashboard for the domain.

- */ - public listDomainDeliverabilityCampaigns( + + /** + * @see {@link ListDomainDeliverabilityCampaignsCommand} + */ + listDomainDeliverabilityCampaigns( args: ListDomainDeliverabilityCampaignsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDomainDeliverabilityCampaigns( + listDomainDeliverabilityCampaigns( args: ListDomainDeliverabilityCampaignsCommandInput, cb: (err: any, data?: ListDomainDeliverabilityCampaignsCommandOutput) => void ): void; - public listDomainDeliverabilityCampaigns( + listDomainDeliverabilityCampaigns( args: ListDomainDeliverabilityCampaignsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainDeliverabilityCampaignsCommandOutput) => void ): void; - public listDomainDeliverabilityCampaigns( - args: ListDomainDeliverabilityCampaignsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDomainDeliverabilityCampaignsCommandOutput) => void), - cb?: (err: any, data?: ListDomainDeliverabilityCampaignsCommandOutput) => void - ): Promise | void { - const command = new ListDomainDeliverabilityCampaignsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of all of the email identities that are associated with your Amazon Web Services - * account. An identity can be either an email address or a domain. This operation returns - * identities that are verified as well as those that aren't. This operation returns - * identities that are associated with Amazon SES and Amazon Pinpoint.

- */ - public listEmailIdentities( + + /** + * @see {@link ListEmailIdentitiesCommand} + */ + listEmailIdentities( args: ListEmailIdentitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEmailIdentities( + listEmailIdentities( args: ListEmailIdentitiesCommandInput, cb: (err: any, data?: ListEmailIdentitiesCommandOutput) => void ): void; - public listEmailIdentities( + listEmailIdentities( args: ListEmailIdentitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEmailIdentitiesCommandOutput) => void ): void; - public listEmailIdentities( - args: ListEmailIdentitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEmailIdentitiesCommandOutput) => void), - cb?: (err: any, data?: ListEmailIdentitiesCommandOutput) => void - ): Promise | void { - const command = new ListEmailIdentitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the email templates present in your Amazon SES account in the current Amazon Web Services - * Region.

- *

You can execute this operation no more than once per second.

- */ - public listEmailTemplates( + + /** + * @see {@link ListEmailTemplatesCommand} + */ + listEmailTemplates( args: ListEmailTemplatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEmailTemplates( + listEmailTemplates( args: ListEmailTemplatesCommandInput, cb: (err: any, data?: ListEmailTemplatesCommandOutput) => void ): void; - public listEmailTemplates( + listEmailTemplates( args: ListEmailTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEmailTemplatesCommandOutput) => void ): void; - public listEmailTemplates( - args: ListEmailTemplatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEmailTemplatesCommandOutput) => void), - cb?: (err: any, data?: ListEmailTemplatesCommandOutput) => void - ): Promise | void { - const command = new ListEmailTemplatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all of the import jobs.

- */ - public listImportJobs( + + /** + * @see {@link ListImportJobsCommand} + */ + listImportJobs( args: ListImportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listImportJobs( - args: ListImportJobsCommandInput, - cb: (err: any, data?: ListImportJobsCommandOutput) => void - ): void; - public listImportJobs( + listImportJobs(args: ListImportJobsCommandInput, cb: (err: any, data?: ListImportJobsCommandOutput) => void): void; + listImportJobs( args: ListImportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImportJobsCommandOutput) => void ): void; - public listImportJobs( - args: ListImportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListImportJobsCommandOutput) => void), - cb?: (err: any, data?: ListImportJobsCommandOutput) => void - ): Promise | void { - const command = new ListImportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the recommendations present in your Amazon SES account in the current Amazon Web Services Region.

- *

You can execute this operation no more than once per second.

- */ - public listRecommendations( + + /** + * @see {@link ListRecommendationsCommand} + */ + listRecommendations( args: ListRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRecommendations( + listRecommendations( args: ListRecommendationsCommandInput, cb: (err: any, data?: ListRecommendationsCommandOutput) => void ): void; - public listRecommendations( + listRecommendations( args: ListRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecommendationsCommandOutput) => void ): void; - public listRecommendations( - args: ListRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRecommendationsCommandOutput) => void), - cb?: (err: any, data?: ListRecommendationsCommandOutput) => void - ): Promise | void { - const command = new ListRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of email addresses that are on the suppression list for your - * account.

- */ - public listSuppressedDestinations( + + /** + * @see {@link ListSuppressedDestinationsCommand} + */ + listSuppressedDestinations( args: ListSuppressedDestinationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSuppressedDestinations( + listSuppressedDestinations( args: ListSuppressedDestinationsCommandInput, cb: (err: any, data?: ListSuppressedDestinationsCommandOutput) => void ): void; - public listSuppressedDestinations( + listSuppressedDestinations( args: ListSuppressedDestinationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSuppressedDestinationsCommandOutput) => void ): void; - public listSuppressedDestinations( - args: ListSuppressedDestinationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSuppressedDestinationsCommandOutput) => void), - cb?: (err: any, data?: ListSuppressedDestinationsCommandOutput) => void - ): Promise | void { - const command = new ListSuppressedDestinationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieve a list of the tags (keys and values) that are associated with a specified - * resource. A tag is a label that you optionally define and associate - * with a resource. Each tag consists of a required tag key and an - * optional associated tag value. A tag key is a general label that - * acts as a category for more specific tag values. A tag value acts as a descriptor within - * a tag key.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enable or disable the automatic warm-up feature for dedicated IP addresses.

- */ - public putAccountDedicatedIpWarmupAttributes( + + /** + * @see {@link PutAccountDedicatedIpWarmupAttributesCommand} + */ + putAccountDedicatedIpWarmupAttributes( args: PutAccountDedicatedIpWarmupAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAccountDedicatedIpWarmupAttributes( + putAccountDedicatedIpWarmupAttributes( args: PutAccountDedicatedIpWarmupAttributesCommandInput, cb: (err: any, data?: PutAccountDedicatedIpWarmupAttributesCommandOutput) => void ): void; - public putAccountDedicatedIpWarmupAttributes( + putAccountDedicatedIpWarmupAttributes( args: PutAccountDedicatedIpWarmupAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccountDedicatedIpWarmupAttributesCommandOutput) => void ): void; - public putAccountDedicatedIpWarmupAttributes( - args: PutAccountDedicatedIpWarmupAttributesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PutAccountDedicatedIpWarmupAttributesCommandOutput) => void), - cb?: (err: any, data?: PutAccountDedicatedIpWarmupAttributesCommandOutput) => void - ): Promise | void { - const command = new PutAccountDedicatedIpWarmupAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update your Amazon SES account details.

- */ - public putAccountDetails( + + /** + * @see {@link PutAccountDetailsCommand} + */ + putAccountDetails( args: PutAccountDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAccountDetails( + putAccountDetails( args: PutAccountDetailsCommandInput, cb: (err: any, data?: PutAccountDetailsCommandOutput) => void ): void; - public putAccountDetails( + putAccountDetails( args: PutAccountDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccountDetailsCommandOutput) => void ): void; - public putAccountDetails( - args: PutAccountDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAccountDetailsCommandOutput) => void), - cb?: (err: any, data?: PutAccountDetailsCommandOutput) => void - ): Promise | void { - const command = new PutAccountDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enable or disable the ability of your account to send email.

- */ - public putAccountSendingAttributes( + + /** + * @see {@link PutAccountSendingAttributesCommand} + */ + putAccountSendingAttributes( args: PutAccountSendingAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAccountSendingAttributes( + putAccountSendingAttributes( args: PutAccountSendingAttributesCommandInput, cb: (err: any, data?: PutAccountSendingAttributesCommandOutput) => void ): void; - public putAccountSendingAttributes( + putAccountSendingAttributes( args: PutAccountSendingAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccountSendingAttributesCommandOutput) => void ): void; - public putAccountSendingAttributes( - args: PutAccountSendingAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAccountSendingAttributesCommandOutput) => void), - cb?: (err: any, data?: PutAccountSendingAttributesCommandOutput) => void - ): Promise | void { - const command = new PutAccountSendingAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Change the settings for the account-level suppression list.

- */ - public putAccountSuppressionAttributes( + + /** + * @see {@link PutAccountSuppressionAttributesCommand} + */ + putAccountSuppressionAttributes( args: PutAccountSuppressionAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAccountSuppressionAttributes( + putAccountSuppressionAttributes( args: PutAccountSuppressionAttributesCommandInput, cb: (err: any, data?: PutAccountSuppressionAttributesCommandOutput) => void ): void; - public putAccountSuppressionAttributes( + putAccountSuppressionAttributes( args: PutAccountSuppressionAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccountSuppressionAttributesCommandOutput) => void ): void; - public putAccountSuppressionAttributes( - args: PutAccountSuppressionAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAccountSuppressionAttributesCommandOutput) => void), - cb?: (err: any, data?: PutAccountSuppressionAttributesCommandOutput) => void - ): Promise | void { - const command = new PutAccountSuppressionAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update your Amazon SES account VDM attributes.

- *

You can execute this operation no more than once per second.

- */ - public putAccountVdmAttributes( + + /** + * @see {@link PutAccountVdmAttributesCommand} + */ + putAccountVdmAttributes( args: PutAccountVdmAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAccountVdmAttributes( + putAccountVdmAttributes( args: PutAccountVdmAttributesCommandInput, cb: (err: any, data?: PutAccountVdmAttributesCommandOutput) => void ): void; - public putAccountVdmAttributes( + putAccountVdmAttributes( args: PutAccountVdmAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccountVdmAttributesCommandOutput) => void ): void; - public putAccountVdmAttributes( - args: PutAccountVdmAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAccountVdmAttributesCommandOutput) => void), - cb?: (err: any, data?: PutAccountVdmAttributesCommandOutput) => void - ): Promise | void { - const command = new PutAccountVdmAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools - * to create groups of dedicated IP addresses for sending specific types of email.

- */ - public putConfigurationSetDeliveryOptions( + + /** + * @see {@link PutConfigurationSetDeliveryOptionsCommand} + */ + putConfigurationSetDeliveryOptions( args: PutConfigurationSetDeliveryOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putConfigurationSetDeliveryOptions( + putConfigurationSetDeliveryOptions( args: PutConfigurationSetDeliveryOptionsCommandInput, cb: (err: any, data?: PutConfigurationSetDeliveryOptionsCommandOutput) => void ): void; - public putConfigurationSetDeliveryOptions( + putConfigurationSetDeliveryOptions( args: PutConfigurationSetDeliveryOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConfigurationSetDeliveryOptionsCommandOutput) => void ): void; - public putConfigurationSetDeliveryOptions( - args: PutConfigurationSetDeliveryOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutConfigurationSetDeliveryOptionsCommandOutput) => void), - cb?: (err: any, data?: PutConfigurationSetDeliveryOptionsCommandOutput) => void - ): Promise | void { - const command = new PutConfigurationSetDeliveryOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enable or disable collection of reputation metrics for emails that you send using a - * particular configuration set in a specific Amazon Web Services Region.

- */ - public putConfigurationSetReputationOptions( + + /** + * @see {@link PutConfigurationSetReputationOptionsCommand} + */ + putConfigurationSetReputationOptions( args: PutConfigurationSetReputationOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putConfigurationSetReputationOptions( + putConfigurationSetReputationOptions( args: PutConfigurationSetReputationOptionsCommandInput, cb: (err: any, data?: PutConfigurationSetReputationOptionsCommandOutput) => void ): void; - public putConfigurationSetReputationOptions( + putConfigurationSetReputationOptions( args: PutConfigurationSetReputationOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConfigurationSetReputationOptionsCommandOutput) => void ): void; - public putConfigurationSetReputationOptions( - args: PutConfigurationSetReputationOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutConfigurationSetReputationOptionsCommandOutput) => void), - cb?: (err: any, data?: PutConfigurationSetReputationOptionsCommandOutput) => void - ): Promise | void { - const command = new PutConfigurationSetReputationOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enable or disable email sending for messages that use a particular configuration set - * in a specific Amazon Web Services Region.

- */ - public putConfigurationSetSendingOptions( + + /** + * @see {@link PutConfigurationSetSendingOptionsCommand} + */ + putConfigurationSetSendingOptions( args: PutConfigurationSetSendingOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putConfigurationSetSendingOptions( + putConfigurationSetSendingOptions( args: PutConfigurationSetSendingOptionsCommandInput, cb: (err: any, data?: PutConfigurationSetSendingOptionsCommandOutput) => void ): void; - public putConfigurationSetSendingOptions( + putConfigurationSetSendingOptions( args: PutConfigurationSetSendingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConfigurationSetSendingOptionsCommandOutput) => void ): void; - public putConfigurationSetSendingOptions( - args: PutConfigurationSetSendingOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutConfigurationSetSendingOptionsCommandOutput) => void), - cb?: (err: any, data?: PutConfigurationSetSendingOptionsCommandOutput) => void - ): Promise | void { - const command = new PutConfigurationSetSendingOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Specify the account suppression list preferences for a configuration set.

- */ - public putConfigurationSetSuppressionOptions( + + /** + * @see {@link PutConfigurationSetSuppressionOptionsCommand} + */ + putConfigurationSetSuppressionOptions( args: PutConfigurationSetSuppressionOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putConfigurationSetSuppressionOptions( + putConfigurationSetSuppressionOptions( args: PutConfigurationSetSuppressionOptionsCommandInput, cb: (err: any, data?: PutConfigurationSetSuppressionOptionsCommandOutput) => void ): void; - public putConfigurationSetSuppressionOptions( + putConfigurationSetSuppressionOptions( args: PutConfigurationSetSuppressionOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConfigurationSetSuppressionOptionsCommandOutput) => void ): void; - public putConfigurationSetSuppressionOptions( - args: PutConfigurationSetSuppressionOptionsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PutConfigurationSetSuppressionOptionsCommandOutput) => void), - cb?: (err: any, data?: PutConfigurationSetSuppressionOptionsCommandOutput) => void - ): Promise | void { - const command = new PutConfigurationSetSuppressionOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Specify a custom domain to use for open and click tracking elements in email that you - * send.

- */ - public putConfigurationSetTrackingOptions( + + /** + * @see {@link PutConfigurationSetTrackingOptionsCommand} + */ + putConfigurationSetTrackingOptions( args: PutConfigurationSetTrackingOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putConfigurationSetTrackingOptions( + putConfigurationSetTrackingOptions( args: PutConfigurationSetTrackingOptionsCommandInput, cb: (err: any, data?: PutConfigurationSetTrackingOptionsCommandOutput) => void ): void; - public putConfigurationSetTrackingOptions( + putConfigurationSetTrackingOptions( args: PutConfigurationSetTrackingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConfigurationSetTrackingOptionsCommandOutput) => void ): void; - public putConfigurationSetTrackingOptions( - args: PutConfigurationSetTrackingOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutConfigurationSetTrackingOptionsCommandOutput) => void), - cb?: (err: any, data?: PutConfigurationSetTrackingOptionsCommandOutput) => void - ): Promise | void { - const command = new PutConfigurationSetTrackingOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Specify VDM preferences for email that you send using the configuration set.

- *

You can execute this operation no more than once per second.

- */ - public putConfigurationSetVdmOptions( + + /** + * @see {@link PutConfigurationSetVdmOptionsCommand} + */ + putConfigurationSetVdmOptions( args: PutConfigurationSetVdmOptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putConfigurationSetVdmOptions( + putConfigurationSetVdmOptions( args: PutConfigurationSetVdmOptionsCommandInput, cb: (err: any, data?: PutConfigurationSetVdmOptionsCommandOutput) => void ): void; - public putConfigurationSetVdmOptions( + putConfigurationSetVdmOptions( args: PutConfigurationSetVdmOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConfigurationSetVdmOptionsCommandOutput) => void ): void; - public putConfigurationSetVdmOptions( - args: PutConfigurationSetVdmOptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutConfigurationSetVdmOptionsCommandOutput) => void), - cb?: (err: any, data?: PutConfigurationSetVdmOptionsCommandOutput) => void - ): Promise | void { - const command = new PutConfigurationSetVdmOptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Move a dedicated IP address to an existing dedicated IP pool.

- * - *

The dedicated IP address that you specify must already exist, and must be - * associated with your Amazon Web Services account. - * - *

- *

The dedicated IP pool you specify must already exist. You can create a new pool by - * using the CreateDedicatedIpPool operation.

- *
- */ - public putDedicatedIpInPool( + + /** + * @see {@link PutDedicatedIpInPoolCommand} + */ + putDedicatedIpInPool( args: PutDedicatedIpInPoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public putDedicatedIpInPool( + putDedicatedIpInPool( args: PutDedicatedIpInPoolCommandInput, cb: (err: any, data?: PutDedicatedIpInPoolCommandOutput) => void ): void; - public putDedicatedIpInPool( + putDedicatedIpInPool( args: PutDedicatedIpInPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDedicatedIpInPoolCommandOutput) => void ): void; - public putDedicatedIpInPool( - args: PutDedicatedIpInPoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutDedicatedIpInPoolCommandOutput) => void), - cb?: (err: any, data?: PutDedicatedIpInPoolCommandOutput) => void - ): Promise | void { - const command = new PutDedicatedIpInPoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- */ - public putDedicatedIpWarmupAttributes( + + /** + * @see {@link PutDedicatedIpWarmupAttributesCommand} + */ + putDedicatedIpWarmupAttributes( args: PutDedicatedIpWarmupAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putDedicatedIpWarmupAttributes( + putDedicatedIpWarmupAttributes( args: PutDedicatedIpWarmupAttributesCommandInput, cb: (err: any, data?: PutDedicatedIpWarmupAttributesCommandOutput) => void ): void; - public putDedicatedIpWarmupAttributes( + putDedicatedIpWarmupAttributes( args: PutDedicatedIpWarmupAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDedicatedIpWarmupAttributesCommandOutput) => void ): void; - public putDedicatedIpWarmupAttributes( - args: PutDedicatedIpWarmupAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutDedicatedIpWarmupAttributesCommandOutput) => void), - cb?: (err: any, data?: PutDedicatedIpWarmupAttributesCommandOutput) => void - ): Promise | void { - const command = new PutDedicatedIpWarmupAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain - * access to reputation, deliverability, and other metrics for the domains that you use to - * send email. You also gain the ability to perform predictive inbox placement tests.

- *

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition - * to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more - * information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing.

- */ - public putDeliverabilityDashboardOption( + + /** + * @see {@link PutDeliverabilityDashboardOptionCommand} + */ + putDeliverabilityDashboardOption( args: PutDeliverabilityDashboardOptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public putDeliverabilityDashboardOption( + putDeliverabilityDashboardOption( args: PutDeliverabilityDashboardOptionCommandInput, cb: (err: any, data?: PutDeliverabilityDashboardOptionCommandOutput) => void ): void; - public putDeliverabilityDashboardOption( + putDeliverabilityDashboardOption( args: PutDeliverabilityDashboardOptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDeliverabilityDashboardOptionCommandOutput) => void ): void; - public putDeliverabilityDashboardOption( - args: PutDeliverabilityDashboardOptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutDeliverabilityDashboardOptionCommandOutput) => void), - cb?: (err: any, data?: PutDeliverabilityDashboardOptionCommandOutput) => void - ): Promise | void { - const command = new PutDeliverabilityDashboardOptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Used to associate a configuration set with an email identity.

- */ - public putEmailIdentityConfigurationSetAttributes( + + /** + * @see {@link PutEmailIdentityConfigurationSetAttributesCommand} + */ + putEmailIdentityConfigurationSetAttributes( args: PutEmailIdentityConfigurationSetAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putEmailIdentityConfigurationSetAttributes( + putEmailIdentityConfigurationSetAttributes( args: PutEmailIdentityConfigurationSetAttributesCommandInput, cb: (err: any, data?: PutEmailIdentityConfigurationSetAttributesCommandOutput) => void ): void; - public putEmailIdentityConfigurationSetAttributes( + putEmailIdentityConfigurationSetAttributes( args: PutEmailIdentityConfigurationSetAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEmailIdentityConfigurationSetAttributesCommandOutput) => void ): void; - public putEmailIdentityConfigurationSetAttributes( - args: PutEmailIdentityConfigurationSetAttributesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PutEmailIdentityConfigurationSetAttributesCommandOutput) => void), - cb?: (err: any, data?: PutEmailIdentityConfigurationSetAttributesCommandOutput) => void - ): Promise | void { - const command = new PutEmailIdentityConfigurationSetAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Used to enable or disable DKIM authentication for an email identity.

- */ - public putEmailIdentityDkimAttributes( + + /** + * @see {@link PutEmailIdentityDkimAttributesCommand} + */ + putEmailIdentityDkimAttributes( args: PutEmailIdentityDkimAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putEmailIdentityDkimAttributes( + putEmailIdentityDkimAttributes( args: PutEmailIdentityDkimAttributesCommandInput, cb: (err: any, data?: PutEmailIdentityDkimAttributesCommandOutput) => void ): void; - public putEmailIdentityDkimAttributes( + putEmailIdentityDkimAttributes( args: PutEmailIdentityDkimAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEmailIdentityDkimAttributesCommandOutput) => void ): void; - public putEmailIdentityDkimAttributes( - args: PutEmailIdentityDkimAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutEmailIdentityDkimAttributesCommandOutput) => void), - cb?: (err: any, data?: PutEmailIdentityDkimAttributesCommandOutput) => void - ): Promise | void { - const command = new PutEmailIdentityDkimAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Used to configure or change the DKIM authentication settings for an email domain - * identity. You can use this operation to do any of the following:

- *
    - *
  • - *

    Update the signing attributes for an identity that uses Bring Your Own DKIM - * (BYODKIM).

    - *
  • - *
  • - *

    Update the key length that should be used for Easy DKIM.

    - *
  • - *
  • - *

    Change from using no DKIM authentication to using Easy DKIM.

    - *
  • - *
  • - *

    Change from using no DKIM authentication to using BYODKIM.

    - *
  • - *
  • - *

    Change from using Easy DKIM to using BYODKIM.

    - *
  • - *
  • - *

    Change from using BYODKIM to using Easy DKIM.

    - *
  • - *
- */ - public putEmailIdentityDkimSigningAttributes( + + /** + * @see {@link PutEmailIdentityDkimSigningAttributesCommand} + */ + putEmailIdentityDkimSigningAttributes( args: PutEmailIdentityDkimSigningAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putEmailIdentityDkimSigningAttributes( + putEmailIdentityDkimSigningAttributes( args: PutEmailIdentityDkimSigningAttributesCommandInput, cb: (err: any, data?: PutEmailIdentityDkimSigningAttributesCommandOutput) => void ): void; - public putEmailIdentityDkimSigningAttributes( + putEmailIdentityDkimSigningAttributes( args: PutEmailIdentityDkimSigningAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEmailIdentityDkimSigningAttributesCommandOutput) => void ): void; - public putEmailIdentityDkimSigningAttributes( - args: PutEmailIdentityDkimSigningAttributesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PutEmailIdentityDkimSigningAttributesCommandOutput) => void), - cb?: (err: any, data?: PutEmailIdentityDkimSigningAttributesCommandOutput) => void - ): Promise | void { - const command = new PutEmailIdentityDkimSigningAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Used to enable or disable feedback forwarding for an identity. This setting determines - * what happens when an identity is used to send an email that results in a bounce or - * complaint event.

- *

If the value is true, you receive email notifications when bounce or - * complaint events occur. These notifications are sent to the address that you specified - * in the Return-Path header of the original email.

- *

You're required to have a method of tracking bounces and complaints. If you haven't - * set up another mechanism for receiving bounce or complaint notifications (for example, - * by setting up an event destination), you receive an email notification when these events - * occur (even if this setting is disabled).

- */ - public putEmailIdentityFeedbackAttributes( + + /** + * @see {@link PutEmailIdentityFeedbackAttributesCommand} + */ + putEmailIdentityFeedbackAttributes( args: PutEmailIdentityFeedbackAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putEmailIdentityFeedbackAttributes( + putEmailIdentityFeedbackAttributes( args: PutEmailIdentityFeedbackAttributesCommandInput, cb: (err: any, data?: PutEmailIdentityFeedbackAttributesCommandOutput) => void ): void; - public putEmailIdentityFeedbackAttributes( + putEmailIdentityFeedbackAttributes( args: PutEmailIdentityFeedbackAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEmailIdentityFeedbackAttributesCommandOutput) => void ): void; - public putEmailIdentityFeedbackAttributes( - args: PutEmailIdentityFeedbackAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutEmailIdentityFeedbackAttributesCommandOutput) => void), - cb?: (err: any, data?: PutEmailIdentityFeedbackAttributesCommandOutput) => void - ): Promise | void { - const command = new PutEmailIdentityFeedbackAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Used to enable or disable the custom Mail-From domain configuration for an email - * identity.

- */ - public putEmailIdentityMailFromAttributes( + + /** + * @see {@link PutEmailIdentityMailFromAttributesCommand} + */ + putEmailIdentityMailFromAttributes( args: PutEmailIdentityMailFromAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public putEmailIdentityMailFromAttributes( + putEmailIdentityMailFromAttributes( args: PutEmailIdentityMailFromAttributesCommandInput, cb: (err: any, data?: PutEmailIdentityMailFromAttributesCommandOutput) => void ): void; - public putEmailIdentityMailFromAttributes( + putEmailIdentityMailFromAttributes( args: PutEmailIdentityMailFromAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEmailIdentityMailFromAttributesCommandOutput) => void ): void; - public putEmailIdentityMailFromAttributes( - args: PutEmailIdentityMailFromAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutEmailIdentityMailFromAttributesCommandOutput) => void), - cb?: (err: any, data?: PutEmailIdentityMailFromAttributesCommandOutput) => void - ): Promise | void { - const command = new PutEmailIdentityMailFromAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds an email address to the suppression list for your account.

- */ - public putSuppressedDestination( + + /** + * @see {@link PutSuppressedDestinationCommand} + */ + putSuppressedDestination( args: PutSuppressedDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putSuppressedDestination( + putSuppressedDestination( args: PutSuppressedDestinationCommandInput, cb: (err: any, data?: PutSuppressedDestinationCommandOutput) => void ): void; - public putSuppressedDestination( + putSuppressedDestination( args: PutSuppressedDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSuppressedDestinationCommandOutput) => void ): void; - public putSuppressedDestination( - args: PutSuppressedDestinationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutSuppressedDestinationCommandOutput) => void), - cb?: (err: any, data?: PutSuppressedDestinationCommandOutput) => void - ): Promise | void { - const command = new PutSuppressedDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Composes an email message to multiple destinations.

- */ - public sendBulkEmail( - args: SendBulkEmailCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public sendBulkEmail( - args: SendBulkEmailCommandInput, - cb: (err: any, data?: SendBulkEmailCommandOutput) => void - ): void; - public sendBulkEmail( + + /** + * @see {@link SendBulkEmailCommand} + */ + sendBulkEmail(args: SendBulkEmailCommandInput, options?: __HttpHandlerOptions): Promise; + sendBulkEmail(args: SendBulkEmailCommandInput, cb: (err: any, data?: SendBulkEmailCommandOutput) => void): void; + sendBulkEmail( args: SendBulkEmailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendBulkEmailCommandOutput) => void ): void; - public sendBulkEmail( - args: SendBulkEmailCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendBulkEmailCommandOutput) => void), - cb?: (err: any, data?: SendBulkEmailCommandOutput) => void - ): Promise | void { - const command = new SendBulkEmailCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds an email address to the list of identities for your Amazon SES account in the current - * Amazon Web Services Region and attempts to verify it. As a result of executing this - * operation, a customized verification email is sent to the specified address.

- *

To use this operation, you must first create a custom verification email template. For - * more information about creating and using custom verification email templates, see - * Using - * custom verification email templates in the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public sendCustomVerificationEmail( + + /** + * @see {@link SendCustomVerificationEmailCommand} + */ + sendCustomVerificationEmail( args: SendCustomVerificationEmailCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendCustomVerificationEmail( + sendCustomVerificationEmail( args: SendCustomVerificationEmailCommandInput, cb: (err: any, data?: SendCustomVerificationEmailCommandOutput) => void ): void; - public sendCustomVerificationEmail( + sendCustomVerificationEmail( args: SendCustomVerificationEmailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendCustomVerificationEmailCommandOutput) => void ): void; - public sendCustomVerificationEmail( - args: SendCustomVerificationEmailCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendCustomVerificationEmailCommandOutput) => void), - cb?: (err: any, data?: SendCustomVerificationEmailCommandOutput) => void - ): Promise | void { - const command = new SendCustomVerificationEmailCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sends an email message. You can use the Amazon SES API v2 to send the following types of - * messages:

- *
    - *
  • - *

    - * Simple – A standard email message. When - * you create this type of message, you specify the sender, the recipient, and the - * message body, and Amazon SES assembles the message for you.

    - *
  • - *
  • - *

    - * Raw – A raw, MIME-formatted email - * message. When you send this type of email, you have to specify all of the - * message headers, as well as the message body. You can use this message type to - * send messages that contain attachments. The message that you specify has to be a - * valid MIME message.

    - *
  • - *
  • - *

    - * Templated – A message that contains - * personalization tags. When you send this type of email, Amazon SES API v2 automatically - * replaces the tags with values that you specify.

    - *
  • - *
- */ - public sendEmail(args: SendEmailCommandInput, options?: __HttpHandlerOptions): Promise; - public sendEmail(args: SendEmailCommandInput, cb: (err: any, data?: SendEmailCommandOutput) => void): void; - public sendEmail( + + /** + * @see {@link SendEmailCommand} + */ + sendEmail(args: SendEmailCommandInput, options?: __HttpHandlerOptions): Promise; + sendEmail(args: SendEmailCommandInput, cb: (err: any, data?: SendEmailCommandOutput) => void): void; + sendEmail( args: SendEmailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendEmailCommandOutput) => void ): void; - public sendEmail( - args: SendEmailCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendEmailCommandOutput) => void), - cb?: (err: any, data?: SendEmailCommandOutput) => void - ): Promise | void { - const command = new SendEmailCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Add one or more tags (keys and values) to a specified resource. A - * tag is a label that you optionally define and associate with a - * resource. Tags can help you categorize and manage resources in different ways, such as - * by purpose, owner, environment, or other criteria. A resource can have as many as 50 - * tags.

- *

Each tag consists of a required tag key and an - * associated tag value, both of which you define. A tag key is a - * general label that acts as a category for more specific tag values. A tag value acts as - * a descriptor within a tag key.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a preview of the MIME content of an email when provided with a template and a - * set of replacement data.

- *

You can execute this operation no more than once per second.

- */ - public testRenderEmailTemplate( + + /** + * @see {@link TestRenderEmailTemplateCommand} + */ + testRenderEmailTemplate( args: TestRenderEmailTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public testRenderEmailTemplate( + testRenderEmailTemplate( args: TestRenderEmailTemplateCommandInput, cb: (err: any, data?: TestRenderEmailTemplateCommandOutput) => void ): void; - public testRenderEmailTemplate( + testRenderEmailTemplate( args: TestRenderEmailTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestRenderEmailTemplateCommandOutput) => void ): void; - public testRenderEmailTemplate( - args: TestRenderEmailTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestRenderEmailTemplateCommandOutput) => void), - cb?: (err: any, data?: TestRenderEmailTemplateCommandOutput) => void - ): Promise | void { - const command = new TestRenderEmailTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Remove one or more tags (keys and values) from a specified resource.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update the configuration of an event destination for a configuration set.

- *

- * Events include message sends, deliveries, opens, clicks, bounces, - * and complaints. Event destinations are places that you can send - * information about these events to. For example, you can send event data to Amazon SNS to - * receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to - * stream data to Amazon S3 for long-term storage.

- */ - public updateConfigurationSetEventDestination( + + /** + * @see {@link UpdateConfigurationSetEventDestinationCommand} + */ + updateConfigurationSetEventDestination( args: UpdateConfigurationSetEventDestinationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConfigurationSetEventDestination( + updateConfigurationSetEventDestination( args: UpdateConfigurationSetEventDestinationCommandInput, cb: (err: any, data?: UpdateConfigurationSetEventDestinationCommandOutput) => void ): void; - public updateConfigurationSetEventDestination( + updateConfigurationSetEventDestination( args: UpdateConfigurationSetEventDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConfigurationSetEventDestinationCommandOutput) => void ): void; - public updateConfigurationSetEventDestination( - args: UpdateConfigurationSetEventDestinationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateConfigurationSetEventDestinationCommandOutput) => void), - cb?: (err: any, data?: UpdateConfigurationSetEventDestinationCommandOutput) => void - ): Promise | void { - const command = new UpdateConfigurationSetEventDestinationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a contact's preferences for a list. It is not necessary to specify all - * existing topic preferences in the TopicPreferences object, just the ones that need - * updating.

- */ - public updateContact( - args: UpdateContactCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateContact( - args: UpdateContactCommandInput, - cb: (err: any, data?: UpdateContactCommandOutput) => void - ): void; - public updateContact( + + /** + * @see {@link UpdateContactCommand} + */ + updateContact(args: UpdateContactCommandInput, options?: __HttpHandlerOptions): Promise; + updateContact(args: UpdateContactCommandInput, cb: (err: any, data?: UpdateContactCommandOutput) => void): void; + updateContact( args: UpdateContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContactCommandOutput) => void ): void; - public updateContact( - args: UpdateContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateContactCommandOutput) => void), - cb?: (err: any, data?: UpdateContactCommandOutput) => void - ): Promise | void { - const command = new UpdateContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates contact list metadata. This operation does a complete replacement.

- */ - public updateContactList( + + /** + * @see {@link UpdateContactListCommand} + */ + updateContactList( args: UpdateContactListCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateContactList( + updateContactList( args: UpdateContactListCommandInput, cb: (err: any, data?: UpdateContactListCommandOutput) => void ): void; - public updateContactList( + updateContactList( args: UpdateContactListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContactListCommandOutput) => void ): void; - public updateContactList( - args: UpdateContactListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateContactListCommandOutput) => void), - cb?: (err: any, data?: UpdateContactListCommandOutput) => void - ): Promise | void { - const command = new UpdateContactListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing custom verification email template.

- *

For more information about custom verification email templates, see Using - * custom verification email templates in the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public updateCustomVerificationEmailTemplate( + + /** + * @see {@link UpdateCustomVerificationEmailTemplateCommand} + */ + updateCustomVerificationEmailTemplate( args: UpdateCustomVerificationEmailTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCustomVerificationEmailTemplate( + updateCustomVerificationEmailTemplate( args: UpdateCustomVerificationEmailTemplateCommandInput, cb: (err: any, data?: UpdateCustomVerificationEmailTemplateCommandOutput) => void ): void; - public updateCustomVerificationEmailTemplate( + updateCustomVerificationEmailTemplate( args: UpdateCustomVerificationEmailTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCustomVerificationEmailTemplateCommandOutput) => void ): void; - public updateCustomVerificationEmailTemplate( - args: UpdateCustomVerificationEmailTemplateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateCustomVerificationEmailTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateCustomVerificationEmailTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateCustomVerificationEmailTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the specified sending authorization policy for the given identity (an email - * address or a domain). This API returns successfully even if a policy with the specified - * name does not exist.

- * - *

This API is for the identity owner only. If you have not verified the identity, - * this API will return an error.

- *
- *

Sending authorization is a feature that enables an identity owner to authorize other - * senders to use its identities. For information about using sending authorization, see - * the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public updateEmailIdentityPolicy( + + /** + * @see {@link UpdateEmailIdentityPolicyCommand} + */ + updateEmailIdentityPolicy( args: UpdateEmailIdentityPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEmailIdentityPolicy( + updateEmailIdentityPolicy( args: UpdateEmailIdentityPolicyCommandInput, cb: (err: any, data?: UpdateEmailIdentityPolicyCommandOutput) => void ): void; - public updateEmailIdentityPolicy( + updateEmailIdentityPolicy( args: UpdateEmailIdentityPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEmailIdentityPolicyCommandOutput) => void ): void; - public updateEmailIdentityPolicy( - args: UpdateEmailIdentityPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEmailIdentityPolicyCommandOutput) => void), - cb?: (err: any, data?: UpdateEmailIdentityPolicyCommandOutput) => void - ): Promise | void { - const command = new UpdateEmailIdentityPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an email template. Email templates enable you to send personalized email to - * one or more destinations in a single API operation. For more information, see the Amazon SES Developer - * Guide.

- *

You can execute this operation no more than once per second.

- */ - public updateEmailTemplate( + + /** + * @see {@link UpdateEmailTemplateCommand} + */ + updateEmailTemplate( args: UpdateEmailTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEmailTemplate( + updateEmailTemplate( args: UpdateEmailTemplateCommandInput, cb: (err: any, data?: UpdateEmailTemplateCommandOutput) => void ): void; - public updateEmailTemplate( + updateEmailTemplate( args: UpdateEmailTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEmailTemplateCommandOutput) => void ): void; - public updateEmailTemplate( - args: UpdateEmailTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEmailTemplateCommandOutput) => void), - cb?: (err: any, data?: UpdateEmailTemplateCommandOutput) => void - ): Promise | void { - const command = new UpdateEmailTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon SES API v2 + *

+ * Amazon SES is an Amazon Web Services service that + * you can use to send email messages to your customers.

+ *

If you're new to Amazon SES API v2, you might find it helpful to review the Amazon Simple Email Service Developer + * Guide. The Amazon SES Developer Guide provides information + * and code samples that demonstrate how to use Amazon SES API v2 features programmatically.

+ */ +export class SESv2 extends SESv2Client implements SESv2 {} +createAggregatedClient(commands, SESv2); diff --git a/clients/client-sfn/src/SFN.ts b/clients/client-sfn/src/SFN.ts index 174a68ebd95c..65b8c95bba38 100644 --- a/clients/client-sfn/src/SFN.ts +++ b/clients/client-sfn/src/SFN.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -123,1035 +124,442 @@ import { UpdateStateMachineCommandInput, UpdateStateMachineCommandOutput, } from "./commands/UpdateStateMachineCommand"; -import { SFNClient } from "./SFNClient"; +import { SFNClient, SFNClientConfig } from "./SFNClient"; -/** - * @public - * Step Functions - *

Step Functions is a service that lets you coordinate the components of distributed applications - * and microservices using visual workflows.

- *

You can use Step Functions to build applications from individual components, each of which performs - * a discrete function, or task, allowing you to scale and change - * applications quickly. Step Functions provides a console that helps visualize the components of your - * application as a series of steps. Step Functions automatically triggers and tracks each step, and - * retries steps when there are errors, so your application executes predictably and in the right - * order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any - * issues.

- *

Step Functions manages operations and underlying infrastructure to ensure your application is - * available at any scale. You can run tasks on Amazon Web Services, your own servers, or any system that has - * access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API. - * For more information about Step Functions, see the - * Step Functions Developer Guide - * .

- */ -export class SFN extends SFNClient { +const commands = { + CreateActivityCommand, + CreateStateMachineCommand, + DeleteActivityCommand, + DeleteStateMachineCommand, + DescribeActivityCommand, + DescribeExecutionCommand, + DescribeMapRunCommand, + DescribeStateMachineCommand, + DescribeStateMachineForExecutionCommand, + GetActivityTaskCommand, + GetExecutionHistoryCommand, + ListActivitiesCommand, + ListExecutionsCommand, + ListMapRunsCommand, + ListStateMachinesCommand, + ListTagsForResourceCommand, + SendTaskFailureCommand, + SendTaskHeartbeatCommand, + SendTaskSuccessCommand, + StartExecutionCommand, + StartSyncExecutionCommand, + StopExecutionCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateMapRunCommand, + UpdateStateMachineCommand, +}; + +export interface SFN { /** - * @public - *

Creates an activity. An activity is a task that you write in any programming language and - * host on any machine that has access to Step Functions. Activities must poll Step Functions using the - * GetActivityTask API action and respond using SendTask* API - * actions. This function lets Step Functions know the existence of your activity and returns an - * identifier for use in a state machine and when polling from the activity.

- * - *

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

- *
- * - *

- * CreateActivity is an idempotent API. Subsequent requests won’t create a - * duplicate resource if it was already created. CreateActivity's idempotency - * check is based on the activity name. If a following request has different - * tags values, Step Functions will ignore these differences and treat it as an - * idempotent request of the previous. In this case, tags will not be updated, - * even if they are different.

- *
+ * @see {@link CreateActivityCommand} */ - public createActivity( + createActivity( args: CreateActivityCommandInput, options?: __HttpHandlerOptions ): Promise; - public createActivity( - args: CreateActivityCommandInput, - cb: (err: any, data?: CreateActivityCommandOutput) => void - ): void; - public createActivity( + createActivity(args: CreateActivityCommandInput, cb: (err: any, data?: CreateActivityCommandOutput) => void): void; + createActivity( args: CreateActivityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateActivityCommandOutput) => void ): void; - public createActivity( - args: CreateActivityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateActivityCommandOutput) => void), - cb?: (err: any, data?: CreateActivityCommandOutput) => void - ): Promise | void { - const command = new CreateActivityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a state machine. A state machine consists of a collection of states that can do - * work (Task states), determine to which states to transition next - * (Choice states), stop an execution with an error (Fail states), - * and so on. State machines are specified using a JSON-based, structured language. For more - * information, see Amazon States - * Language in the Step Functions User Guide.

- * - *

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

- *
- * - *

- * CreateStateMachine is an idempotent API. Subsequent requests won’t create a - * duplicate resource if it was already created. CreateStateMachine's idempotency - * check is based on the state machine name, definition, - * type, LoggingConfiguration and - * TracingConfiguration. If a following request has a different - * roleArn or tags, Step Functions will ignore these differences and treat - * it as an idempotent request of the previous. In this case, roleArn and - * tags will not be updated, even if they are different.

- *
+ * @see {@link CreateStateMachineCommand} */ - public createStateMachine( + createStateMachine( args: CreateStateMachineCommandInput, options?: __HttpHandlerOptions ): Promise; - public createStateMachine( + createStateMachine( args: CreateStateMachineCommandInput, cb: (err: any, data?: CreateStateMachineCommandOutput) => void ): void; - public createStateMachine( + createStateMachine( args: CreateStateMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStateMachineCommandOutput) => void ): void; - public createStateMachine( - args: CreateStateMachineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStateMachineCommandOutput) => void), - cb?: (err: any, data?: CreateStateMachineCommandOutput) => void - ): Promise | void { - const command = new CreateStateMachineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an activity.

+ * @see {@link DeleteActivityCommand} */ - public deleteActivity( + deleteActivity( args: DeleteActivityCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteActivity( - args: DeleteActivityCommandInput, - cb: (err: any, data?: DeleteActivityCommandOutput) => void - ): void; - public deleteActivity( + deleteActivity(args: DeleteActivityCommandInput, cb: (err: any, data?: DeleteActivityCommandOutput) => void): void; + deleteActivity( args: DeleteActivityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteActivityCommandOutput) => void ): void; - public deleteActivity( - args: DeleteActivityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteActivityCommandOutput) => void), - cb?: (err: any, data?: DeleteActivityCommandOutput) => void - ): Promise | void { - const command = new DeleteActivityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a state machine. This is an asynchronous operation: It sets the state machine's - * status to DELETING and begins the deletion process.

- * - *

If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.

- * - *

A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

- * - * - *

For EXPRESS state machines, the deletion will happen eventually (usually - * less than a minute). Running executions may emit logs after DeleteStateMachine - * API is called.

- *
+ * @see {@link DeleteStateMachineCommand} */ - public deleteStateMachine( + deleteStateMachine( args: DeleteStateMachineCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteStateMachine( + deleteStateMachine( args: DeleteStateMachineCommandInput, cb: (err: any, data?: DeleteStateMachineCommandOutput) => void ): void; - public deleteStateMachine( + deleteStateMachine( args: DeleteStateMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStateMachineCommandOutput) => void ): void; - public deleteStateMachine( - args: DeleteStateMachineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteStateMachineCommandOutput) => void), - cb?: (err: any, data?: DeleteStateMachineCommandOutput) => void - ): Promise | void { - const command = new DeleteStateMachineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes an activity.

- * - *

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

- *
+ * @see {@link DescribeActivityCommand} */ - public describeActivity( + describeActivity( args: DescribeActivityCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeActivity( + describeActivity( args: DescribeActivityCommandInput, cb: (err: any, data?: DescribeActivityCommandOutput) => void ): void; - public describeActivity( + describeActivity( args: DescribeActivityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeActivityCommandOutput) => void ): void; - public describeActivity( - args: DescribeActivityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeActivityCommandOutput) => void), - cb?: (err: any, data?: DescribeActivityCommandOutput) => void - ): Promise | void { - const command = new DescribeActivityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides all information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. Use this API action to return the Map Run ARN if the execution was dispatched by a Map Run.

- * - *

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

- *
- *

This API action is not supported by EXPRESS state machine executions unless they were dispatched by a Map Run.

+ * @see {@link DescribeExecutionCommand} */ - public describeExecution( + describeExecution( args: DescribeExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeExecution( + describeExecution( args: DescribeExecutionCommandInput, cb: (err: any, data?: DescribeExecutionCommandOutput) => void ): void; - public describeExecution( + describeExecution( args: DescribeExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExecutionCommandOutput) => void ): void; - public describeExecution( - args: DescribeExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeExecutionCommandOutput) => void), - cb?: (err: any, data?: DescribeExecutionCommandOutput) => void - ): Promise | void { - const command = new DescribeExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides information about a Map Run's configuration, progress, and results. For more information, see Examining Map Run in the Step Functions Developer Guide.

+ * @see {@link DescribeMapRunCommand} */ - public describeMapRun( + describeMapRun( args: DescribeMapRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMapRun( - args: DescribeMapRunCommandInput, - cb: (err: any, data?: DescribeMapRunCommandOutput) => void - ): void; - public describeMapRun( + describeMapRun(args: DescribeMapRunCommandInput, cb: (err: any, data?: DescribeMapRunCommandOutput) => void): void; + describeMapRun( args: DescribeMapRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMapRunCommandOutput) => void ): void; - public describeMapRun( - args: DescribeMapRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMapRunCommandOutput) => void), - cb?: (err: any, data?: DescribeMapRunCommandOutput) => void - ): Promise | void { - const command = new DescribeMapRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration. If the state machine ARN is a qualified state machine ARN, the response returned includes the Map state's label.

- * - *

A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

- * - * - *

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

- *
+ * @see {@link DescribeStateMachineCommand} */ - public describeStateMachine( + describeStateMachine( args: DescribeStateMachineCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStateMachine( + describeStateMachine( args: DescribeStateMachineCommandInput, cb: (err: any, data?: DescribeStateMachineCommandOutput) => void ): void; - public describeStateMachine( + describeStateMachine( args: DescribeStateMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStateMachineCommandOutput) => void ): void; - public describeStateMachine( - args: DescribeStateMachineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStateMachineCommandOutput) => void), - cb?: (err: any, data?: DescribeStateMachineCommandOutput) => void - ): Promise | void { - const command = new DescribeStateMachineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides information about a state machine's definition, its execution role ARN, and configuration. If an execution was dispatched by a Map Run, the Map Run is returned in the response. Additionally, the state machine returned will be the state machine associated with the Map Run.

- * - *

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

- *
- *

This API action is not supported by EXPRESS state machines.

+ * @see {@link DescribeStateMachineForExecutionCommand} */ - public describeStateMachineForExecution( + describeStateMachineForExecution( args: DescribeStateMachineForExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStateMachineForExecution( + describeStateMachineForExecution( args: DescribeStateMachineForExecutionCommandInput, cb: (err: any, data?: DescribeStateMachineForExecutionCommandOutput) => void ): void; - public describeStateMachineForExecution( + describeStateMachineForExecution( args: DescribeStateMachineForExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStateMachineForExecutionCommandOutput) => void ): void; - public describeStateMachineForExecution( - args: DescribeStateMachineForExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStateMachineForExecutionCommandOutput) => void), - cb?: (err: any, data?: DescribeStateMachineForExecutionCommandOutput) => void - ): Promise | void { - const command = new DescribeStateMachineForExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used by workers to retrieve a task (with the specified activity ARN) which has been - * scheduled for execution by a running state machine. This initiates a long poll, where the - * service holds the HTTP connection open and responds as soon as a task becomes available (i.e. - * an execution of a task of this type is needed.) The maximum time the service holds on to the - * request before responding is 60 seconds. If no task is available within 60 seconds, the poll - * returns a taskToken with a null string.

- * - * - *

This API action isn't logged in CloudTrail.

- *
- * - * - *

Workers should set their client side socket timeout to at least 65 seconds (5 seconds - * higher than the maximum time the service may hold the poll request).

- *

Polling with GetActivityTask can cause latency in some implementations. See - * Avoid - * Latency When Polling for Activity Tasks in the Step Functions Developer Guide.

- *
+ * @see {@link GetActivityTaskCommand} */ - public getActivityTask( + getActivityTask( args: GetActivityTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public getActivityTask( - args: GetActivityTaskCommandInput, - cb: (err: any, data?: GetActivityTaskCommandOutput) => void - ): void; - public getActivityTask( + getActivityTask(args: GetActivityTaskCommandInput, cb: (err: any, data?: GetActivityTaskCommandOutput) => void): void; + getActivityTask( args: GetActivityTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetActivityTaskCommandOutput) => void ): void; - public getActivityTask( - args: GetActivityTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetActivityTaskCommandOutput) => void), - cb?: (err: any, data?: GetActivityTaskCommandOutput) => void - ): Promise | void { - const command = new GetActivityTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the history of the specified execution as a list of events. By default, the - * results are returned in ascending order of the timeStamp of the events. Use the - * reverseOrder parameter to get the latest events first.

- *

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. - * Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

- *

This API action is not supported by EXPRESS state machines.

+ * @see {@link GetExecutionHistoryCommand} */ - public getExecutionHistory( + getExecutionHistory( args: GetExecutionHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getExecutionHistory( + getExecutionHistory( args: GetExecutionHistoryCommandInput, cb: (err: any, data?: GetExecutionHistoryCommandOutput) => void ): void; - public getExecutionHistory( + getExecutionHistory( args: GetExecutionHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExecutionHistoryCommandOutput) => void ): void; - public getExecutionHistory( - args: GetExecutionHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetExecutionHistoryCommandOutput) => void), - cb?: (err: any, data?: GetExecutionHistoryCommandOutput) => void - ): Promise | void { - const command = new GetExecutionHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the existing activities.

- *

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. - * Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

- * - *

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

- *
+ * @see {@link ListActivitiesCommand} */ - public listActivities( + listActivities( args: ListActivitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listActivities( - args: ListActivitiesCommandInput, - cb: (err: any, data?: ListActivitiesCommandOutput) => void - ): void; - public listActivities( + listActivities(args: ListActivitiesCommandInput, cb: (err: any, data?: ListActivitiesCommandOutput) => void): void; + listActivities( args: ListActivitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListActivitiesCommandOutput) => void ): void; - public listActivities( - args: ListActivitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListActivitiesCommandOutput) => void), - cb?: (err: any, data?: ListActivitiesCommandOutput) => void - ): Promise | void { - const command = new ListActivitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN.

- *

Results are - * sorted by time, with the most recent execution first.

- *

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. - * Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

- * - *

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

- *
- *

This API action is not supported by EXPRESS state machines.

+ * @see {@link ListExecutionsCommand} */ - public listExecutions( + listExecutions( args: ListExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listExecutions( - args: ListExecutionsCommandInput, - cb: (err: any, data?: ListExecutionsCommandOutput) => void - ): void; - public listExecutions( + listExecutions(args: ListExecutionsCommandInput, cb: (err: any, data?: ListExecutionsCommandOutput) => void): void; + listExecutions( args: ListExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExecutionsCommandOutput) => void ): void; - public listExecutions( - args: ListExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListExecutionsCommandOutput) => void), - cb?: (err: any, data?: ListExecutionsCommandOutput) => void - ): Promise | void { - const command = new ListExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call DescribeMapRun to obtain more information, if needed.

+ * @see {@link ListMapRunsCommand} */ - public listMapRuns(args: ListMapRunsCommandInput, options?: __HttpHandlerOptions): Promise; - public listMapRuns(args: ListMapRunsCommandInput, cb: (err: any, data?: ListMapRunsCommandOutput) => void): void; - public listMapRuns( + listMapRuns(args: ListMapRunsCommandInput, options?: __HttpHandlerOptions): Promise; + listMapRuns(args: ListMapRunsCommandInput, cb: (err: any, data?: ListMapRunsCommandOutput) => void): void; + listMapRuns( args: ListMapRunsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMapRunsCommandOutput) => void ): void; - public listMapRuns( - args: ListMapRunsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMapRunsCommandOutput) => void), - cb?: (err: any, data?: ListMapRunsCommandOutput) => void - ): Promise | void { - const command = new ListMapRunsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the existing state machines.

- *

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. - * Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

- * - *

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

- *
+ * @see {@link ListStateMachinesCommand} */ - public listStateMachines( + listStateMachines( args: ListStateMachinesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listStateMachines( + listStateMachines( args: ListStateMachinesCommandInput, cb: (err: any, data?: ListStateMachinesCommandOutput) => void ): void; - public listStateMachines( + listStateMachines( args: ListStateMachinesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStateMachinesCommandOutput) => void ): void; - public listStateMachines( - args: ListStateMachinesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListStateMachinesCommandOutput) => void), - cb?: (err: any, data?: ListStateMachinesCommandOutput) => void - ): Promise | void { - const command = new ListStateMachinesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List tags for a given resource.

- *

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used by activity workers and task states using the callback - * pattern to report that the task identified by the taskToken failed.

+ * @see {@link SendTaskFailureCommand} */ - public sendTaskFailure( + sendTaskFailure( args: SendTaskFailureCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendTaskFailure( - args: SendTaskFailureCommandInput, - cb: (err: any, data?: SendTaskFailureCommandOutput) => void - ): void; - public sendTaskFailure( + sendTaskFailure(args: SendTaskFailureCommandInput, cb: (err: any, data?: SendTaskFailureCommandOutput) => void): void; + sendTaskFailure( args: SendTaskFailureCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendTaskFailureCommandOutput) => void ): void; - public sendTaskFailure( - args: SendTaskFailureCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendTaskFailureCommandOutput) => void), - cb?: (err: any, data?: SendTaskFailureCommandOutput) => void - ): Promise | void { - const command = new SendTaskFailureCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used by activity workers and task states using the callback - * pattern to report to Step Functions that the task represented by the specified - * taskToken is still making progress. This action resets the - * Heartbeat clock. The Heartbeat threshold is specified in the state - * machine's Amazon States Language definition (HeartbeatSeconds). This action does not in itself - * create an event in the execution history. However, if the task times out, the execution - * history contains an ActivityTimedOut entry for activities, or a - * TaskTimedOut entry for for tasks using the job run or - * callback - * pattern.

- * - *

The Timeout of a task, defined in the state machine's Amazon States Language definition, is - * its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval - * for heartbeats.

- *
+ * @see {@link SendTaskHeartbeatCommand} */ - public sendTaskHeartbeat( + sendTaskHeartbeat( args: SendTaskHeartbeatCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendTaskHeartbeat( + sendTaskHeartbeat( args: SendTaskHeartbeatCommandInput, cb: (err: any, data?: SendTaskHeartbeatCommandOutput) => void ): void; - public sendTaskHeartbeat( + sendTaskHeartbeat( args: SendTaskHeartbeatCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendTaskHeartbeatCommandOutput) => void ): void; - public sendTaskHeartbeat( - args: SendTaskHeartbeatCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendTaskHeartbeatCommandOutput) => void), - cb?: (err: any, data?: SendTaskHeartbeatCommandOutput) => void - ): Promise | void { - const command = new SendTaskHeartbeatCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used by activity workers and task states using the callback - * pattern to report that the task identified by the taskToken completed - * successfully.

+ * @see {@link SendTaskSuccessCommand} */ - public sendTaskSuccess( + sendTaskSuccess( args: SendTaskSuccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendTaskSuccess( - args: SendTaskSuccessCommandInput, - cb: (err: any, data?: SendTaskSuccessCommandOutput) => void - ): void; - public sendTaskSuccess( + sendTaskSuccess(args: SendTaskSuccessCommandInput, cb: (err: any, data?: SendTaskSuccessCommandOutput) => void): void; + sendTaskSuccess( args: SendTaskSuccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendTaskSuccessCommandOutput) => void ): void; - public sendTaskSuccess( - args: SendTaskSuccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendTaskSuccessCommandOutput) => void), - cb?: (err: any, data?: SendTaskSuccessCommandOutput) => void - ): Promise | void { - const command = new SendTaskSuccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a state machine execution. If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.

- * - *

A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

- * - * - *

- * StartExecution is idempotent for STANDARD workflows. For a - * STANDARD workflow, if StartExecution is called with the same - * name and input as a running execution, the call will succeed and return the same response as - * the original request. If the execution is closed or if the input is different, it will - * return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days.

- *

- * StartExecution is not idempotent for EXPRESS workflows.

- *
+ * @see {@link StartExecutionCommand} */ - public startExecution( + startExecution( args: StartExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startExecution( - args: StartExecutionCommandInput, - cb: (err: any, data?: StartExecutionCommandOutput) => void - ): void; - public startExecution( + startExecution(args: StartExecutionCommandInput, cb: (err: any, data?: StartExecutionCommandOutput) => void): void; + startExecution( args: StartExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartExecutionCommandOutput) => void ): void; - public startExecution( - args: StartExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartExecutionCommandOutput) => void), - cb?: (err: any, data?: StartExecutionCommandOutput) => void - ): Promise | void { - const command = new StartExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a Synchronous Express state machine execution. StartSyncExecution - * is not available for STANDARD workflows.

- * - *

- * StartSyncExecution will return a 200 OK response, even if your - * execution fails, because the status code in the API response doesn't reflect function - * errors. Error codes are reserved for errors that prevent your execution from running, such - * as permissions errors, limit errors, or issues with your state machine code and - * configuration.

- *
- * - *

This API action isn't logged in CloudTrail.

- *
+ * @see {@link StartSyncExecutionCommand} */ - public startSyncExecution( + startSyncExecution( args: StartSyncExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startSyncExecution( + startSyncExecution( args: StartSyncExecutionCommandInput, cb: (err: any, data?: StartSyncExecutionCommandOutput) => void ): void; - public startSyncExecution( + startSyncExecution( args: StartSyncExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSyncExecutionCommandOutput) => void ): void; - public startSyncExecution( - args: StartSyncExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartSyncExecutionCommandOutput) => void), - cb?: (err: any, data?: StartSyncExecutionCommandOutput) => void - ): Promise | void { - const command = new StartSyncExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops an execution.

- *

This API action is not supported by EXPRESS state machines.

+ * @see {@link StopExecutionCommand} */ - public stopExecution( - args: StopExecutionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public stopExecution( - args: StopExecutionCommandInput, - cb: (err: any, data?: StopExecutionCommandOutput) => void - ): void; - public stopExecution( + stopExecution(args: StopExecutionCommandInput, options?: __HttpHandlerOptions): Promise; + stopExecution(args: StopExecutionCommandInput, cb: (err: any, data?: StopExecutionCommandOutput) => void): void; + stopExecution( args: StopExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopExecutionCommandOutput) => void ): void; - public stopExecution( - args: StopExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopExecutionCommandOutput) => void), - cb?: (err: any, data?: StopExecutionCommandOutput) => void - ): Promise | void { - const command = new StopExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Add a tag to a Step Functions resource.

- *

An array of key-value pairs. For more information, see Using - * Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User - * Guide, and Controlling Access Using IAM - * Tags.

- *

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Remove a tag from a Step Functions resource

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.

+ * @see {@link UpdateMapRunCommand} */ - public updateMapRun( - args: UpdateMapRunCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateMapRun(args: UpdateMapRunCommandInput, cb: (err: any, data?: UpdateMapRunCommandOutput) => void): void; - public updateMapRun( + updateMapRun(args: UpdateMapRunCommandInput, options?: __HttpHandlerOptions): Promise; + updateMapRun(args: UpdateMapRunCommandInput, cb: (err: any, data?: UpdateMapRunCommandOutput) => void): void; + updateMapRun( args: UpdateMapRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMapRunCommandOutput) => void ): void; - public updateMapRun( - args: UpdateMapRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMapRunCommandOutput) => void), - cb?: (err: any, data?: UpdateMapRunCommandOutput) => void - ): Promise | void { - const command = new UpdateMapRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing state machine by modifying its definition, - * roleArn, or loggingConfiguration. Running executions will continue - * to use the previous definition and roleArn. You must include at - * least one of definition or roleArn or you will receive a - * MissingRequiredParameter error.

- * - *

If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.

- * - *

A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

- * - * - *

All StartExecution calls within a few seconds will use the updated - * definition and roleArn. Executions started immediately after - * calling UpdateStateMachine may use the previous state machine - * definition and roleArn.

- *
+ * @see {@link UpdateStateMachineCommand} */ - public updateStateMachine( + updateStateMachine( args: UpdateStateMachineCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateStateMachine( + updateStateMachine( args: UpdateStateMachineCommandInput, cb: (err: any, data?: UpdateStateMachineCommandOutput) => void ): void; - public updateStateMachine( + updateStateMachine( args: UpdateStateMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStateMachineCommandOutput) => void ): void; - public updateStateMachine( - args: UpdateStateMachineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStateMachineCommandOutput) => void), - cb?: (err: any, data?: UpdateStateMachineCommandOutput) => void - ): Promise | void { - const command = new UpdateStateMachineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Step Functions + *

Step Functions is a service that lets you coordinate the components of distributed applications + * and microservices using visual workflows.

+ *

You can use Step Functions to build applications from individual components, each of which performs + * a discrete function, or task, allowing you to scale and change + * applications quickly. Step Functions provides a console that helps visualize the components of your + * application as a series of steps. Step Functions automatically triggers and tracks each step, and + * retries steps when there are errors, so your application executes predictably and in the right + * order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any + * issues.

+ *

Step Functions manages operations and underlying infrastructure to ensure your application is + * available at any scale. You can run tasks on Amazon Web Services, your own servers, or any system that has + * access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API. + * For more information about Step Functions, see the + * Step Functions Developer Guide + * .

+ */ +export class SFN extends SFNClient implements SFN {} +createAggregatedClient(commands, SFN); diff --git a/clients/client-shield/src/Shield.ts b/clients/client-shield/src/Shield.ts index 67476b313254..71016d0d9fa7 100644 --- a/clients/client-shield/src/Shield.ts +++ b/clients/client-shield/src/Shield.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -173,1246 +174,643 @@ import { UpdateSubscriptionCommandInput, UpdateSubscriptionCommandOutput, } from "./commands/UpdateSubscriptionCommand"; -import { ShieldClient } from "./ShieldClient"; +import { ShieldClient, ShieldClientConfig } from "./ShieldClient"; -/** - * @public - * Shield Advanced - *

This is the Shield Advanced API Reference. This guide is for developers who need detailed information about the Shield Advanced API actions, - * data types, and errors. For detailed information about WAF and Shield Advanced features and an overview of how to use the WAF and Shield Advanced APIs, see the - * WAF and Shield Developer Guide.

- */ -export class Shield extends ShieldClient { +const commands = { + AssociateDRTLogBucketCommand, + AssociateDRTRoleCommand, + AssociateHealthCheckCommand, + AssociateProactiveEngagementDetailsCommand, + CreateProtectionCommand, + CreateProtectionGroupCommand, + CreateSubscriptionCommand, + DeleteProtectionCommand, + DeleteProtectionGroupCommand, + DeleteSubscriptionCommand, + DescribeAttackCommand, + DescribeAttackStatisticsCommand, + DescribeDRTAccessCommand, + DescribeEmergencyContactSettingsCommand, + DescribeProtectionCommand, + DescribeProtectionGroupCommand, + DescribeSubscriptionCommand, + DisableApplicationLayerAutomaticResponseCommand, + DisableProactiveEngagementCommand, + DisassociateDRTLogBucketCommand, + DisassociateDRTRoleCommand, + DisassociateHealthCheckCommand, + EnableApplicationLayerAutomaticResponseCommand, + EnableProactiveEngagementCommand, + GetSubscriptionStateCommand, + ListAttacksCommand, + ListProtectionGroupsCommand, + ListProtectionsCommand, + ListResourcesInProtectionGroupCommand, + ListTagsForResourceCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateApplicationLayerAutomaticResponseCommand, + UpdateEmergencyContactSettingsCommand, + UpdateProtectionGroupCommand, + UpdateSubscriptionCommand, +}; + +export interface Shield { /** - * @public - *

Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.

- *

To use the services of the SRT and make an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan.

+ * @see {@link AssociateDRTLogBucketCommand} */ - public associateDRTLogBucket( + associateDRTLogBucket( args: AssociateDRTLogBucketCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateDRTLogBucket( + associateDRTLogBucket( args: AssociateDRTLogBucketCommandInput, cb: (err: any, data?: AssociateDRTLogBucketCommandOutput) => void ): void; - public associateDRTLogBucket( + associateDRTLogBucket( args: AssociateDRTLogBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateDRTLogBucketCommandOutput) => void ): void; - public associateDRTLogBucket( - args: AssociateDRTLogBucketCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateDRTLogBucketCommandOutput) => void), - cb?: (err: any, data?: AssociateDRTLogBucketCommandOutput) => void - ): Promise | void { - const command = new AssociateDRTLogBucketCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your WAF configuration and create or update WAF rules and web ACLs.

- *

You can associate only one RoleArn with your subscription. If you submit an AssociateDRTRole request for an account that already has an associated role, the new RoleArn will replace the existing RoleArn.

- *

Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to the role that you'll specify in the request. You can access this policy in the IAM console at AWSShieldDRTAccessPolicy. For more information see Adding and removing IAM identity permissions. The role must also trust the service principal - * drt.shield.amazonaws.com. For more information, see IAM JSON policy elements: Principal.

- * - *

The SRT will have access only to your WAF and Shield resources. By submitting this request, you authorize the SRT to inspect your WAF and Shield configuration and create and update WAF rules and web ACLs on your behalf. The SRT takes these actions only if explicitly authorized by you.

- *

You must have the iam:PassRole permission to make an AssociateDRTRole request. For more information, see Granting a user permissions to pass a role to an Amazon Web Services service.

- *

To use the services of the SRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan.

+ * @see {@link AssociateDRTRoleCommand} */ - public associateDRTRole( + associateDRTRole( args: AssociateDRTRoleCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateDRTRole( + associateDRTRole( args: AssociateDRTRoleCommandInput, cb: (err: any, data?: AssociateDRTRoleCommandOutput) => void ): void; - public associateDRTRole( + associateDRTRole( args: AssociateDRTRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateDRTRoleCommandOutput) => void ): void; - public associateDRTRole( - args: AssociateDRTRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateDRTRoleCommandOutput) => void), - cb?: (err: any, data?: AssociateDRTRoleCommandOutput) => void - ): Promise | void { - const command = new AssociateDRTRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.

- *

You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.

+ * @see {@link AssociateHealthCheckCommand} */ - public associateHealthCheck( + associateHealthCheck( args: AssociateHealthCheckCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateHealthCheck( + associateHealthCheck( args: AssociateHealthCheckCommandInput, cb: (err: any, data?: AssociateHealthCheckCommandOutput) => void ): void; - public associateHealthCheck( + associateHealthCheck( args: AssociateHealthCheckCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateHealthCheckCommandOutput) => void ): void; - public associateHealthCheck( - args: AssociateHealthCheckCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateHealthCheckCommandOutput) => void), - cb?: (err: any, data?: AssociateHealthCheckCommandOutput) => void - ): Promise | void { - const command = new AssociateHealthCheckCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use. You must provide at least one phone number in the emergency contact list.

- *

After you have initialized proactive engagement using this call, to disable or enable proactive engagement, use the calls DisableProactiveEngagement and EnableProactiveEngagement.

- * - *

This call defines the list of email addresses and phone numbers that the SRT can use to contact you for escalations to the SRT and to initiate proactive customer support.

- *

The contacts that you provide in the request replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using DescribeEmergencyContactSettings and then provide it to this call.

- *
+ * @see {@link AssociateProactiveEngagementDetailsCommand} */ - public associateProactiveEngagementDetails( + associateProactiveEngagementDetails( args: AssociateProactiveEngagementDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateProactiveEngagementDetails( + associateProactiveEngagementDetails( args: AssociateProactiveEngagementDetailsCommandInput, cb: (err: any, data?: AssociateProactiveEngagementDetailsCommandOutput) => void ): void; - public associateProactiveEngagementDetails( + associateProactiveEngagementDetails( args: AssociateProactiveEngagementDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateProactiveEngagementDetailsCommandOutput) => void ): void; - public associateProactiveEngagementDetails( - args: AssociateProactiveEngagementDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateProactiveEngagementDetailsCommandOutput) => void), - cb?: (err: any, data?: AssociateProactiveEngagementDetailsCommandOutput) => void - ): Promise | void { - const command = new AssociateProactiveEngagementDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables Shield Advanced for a specific Amazon Web Services resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses.

- *

You can add protection to only a single resource with each CreateProtection request. You can add protection to multiple resources - * at once through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. - * For more information see - * Getting Started with Shield Advanced - * and Adding Shield Advanced protection to Amazon Web Services resources.

+ * @see {@link CreateProtectionCommand} */ - public createProtection( + createProtection( args: CreateProtectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createProtection( + createProtection( args: CreateProtectionCommandInput, cb: (err: any, data?: CreateProtectionCommandOutput) => void ): void; - public createProtection( + createProtection( args: CreateProtectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProtectionCommandOutput) => void ): void; - public createProtection( - args: CreateProtectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProtectionCommandOutput) => void), - cb?: (err: any, data?: CreateProtectionCommandOutput) => void - ): Promise | void { - const command = new CreateProtectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.

+ * @see {@link CreateProtectionGroupCommand} */ - public createProtectionGroup( + createProtectionGroup( args: CreateProtectionGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createProtectionGroup( + createProtectionGroup( args: CreateProtectionGroupCommandInput, cb: (err: any, data?: CreateProtectionGroupCommandOutput) => void ): void; - public createProtectionGroup( + createProtectionGroup( args: CreateProtectionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProtectionGroupCommandOutput) => void ): void; - public createProtectionGroup( - args: CreateProtectionGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProtectionGroupCommandOutput) => void), - cb?: (err: any, data?: CreateProtectionGroupCommandOutput) => void - ): Promise | void { - const command = new CreateProtectionGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Activates Shield Advanced for an account.

- * - *

For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, - * regardless of whether the payer account itself is subscribed.

- *
- *

When you initially create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request.

+ * @see {@link CreateSubscriptionCommand} */ - public createSubscription( + createSubscription( args: CreateSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSubscription( + createSubscription( args: CreateSubscriptionCommandInput, cb: (err: any, data?: CreateSubscriptionCommandOutput) => void ): void; - public createSubscription( + createSubscription( args: CreateSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSubscriptionCommandOutput) => void ): void; - public createSubscription( - args: CreateSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSubscriptionCommandOutput) => void), - cb?: (err: any, data?: CreateSubscriptionCommandOutput) => void - ): Promise | void { - const command = new CreateSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Shield Advanced Protection.

+ * @see {@link DeleteProtectionCommand} */ - public deleteProtection( + deleteProtection( args: DeleteProtectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteProtection( + deleteProtection( args: DeleteProtectionCommandInput, cb: (err: any, data?: DeleteProtectionCommandOutput) => void ): void; - public deleteProtection( + deleteProtection( args: DeleteProtectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProtectionCommandOutput) => void ): void; - public deleteProtection( - args: DeleteProtectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProtectionCommandOutput) => void), - cb?: (err: any, data?: DeleteProtectionCommandOutput) => void - ): Promise | void { - const command = new DeleteProtectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified protection group.

+ * @see {@link DeleteProtectionGroupCommand} */ - public deleteProtectionGroup( + deleteProtectionGroup( args: DeleteProtectionGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteProtectionGroup( + deleteProtectionGroup( args: DeleteProtectionGroupCommandInput, cb: (err: any, data?: DeleteProtectionGroupCommandOutput) => void ): void; - public deleteProtectionGroup( + deleteProtectionGroup( args: DeleteProtectionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProtectionGroupCommandOutput) => void ): void; - public deleteProtectionGroup( - args: DeleteProtectionGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProtectionGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteProtectionGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteProtectionGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Removes Shield Advanced from an account. Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment.

+ * @see {@link DeleteSubscriptionCommand} */ - public deleteSubscription( + deleteSubscription( args: DeleteSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSubscription( + deleteSubscription( args: DeleteSubscriptionCommandInput, cb: (err: any, data?: DeleteSubscriptionCommandOutput) => void ): void; - public deleteSubscription( + deleteSubscription( args: DeleteSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSubscriptionCommandOutput) => void ): void; - public deleteSubscription( - args: DeleteSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSubscriptionCommandOutput) => void), - cb?: (err: any, data?: DeleteSubscriptionCommandOutput) => void - ): Promise | void { - const command = new DeleteSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the details of a DDoS attack.

+ * @see {@link DescribeAttackCommand} */ - public describeAttack( + describeAttack( args: DescribeAttackCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAttack( - args: DescribeAttackCommandInput, - cb: (err: any, data?: DescribeAttackCommandOutput) => void - ): void; - public describeAttack( + describeAttack(args: DescribeAttackCommandInput, cb: (err: any, data?: DescribeAttackCommandOutput) => void): void; + describeAttack( args: DescribeAttackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAttackCommandOutput) => void ): void; - public describeAttack( - args: DescribeAttackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAttackCommandOutput) => void), - cb?: (err: any, data?: DescribeAttackCommandOutput) => void - ): Promise | void { - const command = new DescribeAttackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides information about the number and type of attacks Shield has detected in the last year for all resources that belong to your account, regardless of whether you've defined Shield protections for them. This operation is available to Shield customers as well as to Shield Advanced customers.

- *

The operation returns data for the time range of midnight UTC, one year ago, to midnight UTC, today. For example, if the current time is 2020-10-26 15:39:32 PDT, equal to 2020-10-26 22:39:32 UTC, then the time range for the attack data returned is from 2019-10-26 00:00:00 UTC to 2020-10-26 00:00:00 UTC.

- *

The time range indicates the period covered by the attack statistics data items.

+ * @see {@link DescribeAttackStatisticsCommand} */ - public describeAttackStatistics( + describeAttackStatistics( args: DescribeAttackStatisticsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAttackStatistics( + describeAttackStatistics( args: DescribeAttackStatisticsCommandInput, cb: (err: any, data?: DescribeAttackStatisticsCommandOutput) => void ): void; - public describeAttackStatistics( + describeAttackStatistics( args: DescribeAttackStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAttackStatisticsCommandOutput) => void ): void; - public describeAttackStatistics( - args: DescribeAttackStatisticsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAttackStatisticsCommandOutput) => void), - cb?: (err: any, data?: DescribeAttackStatisticsCommandOutput) => void - ): Promise | void { - const command = new DescribeAttackStatisticsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the current role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your Amazon Web Services account while assisting with attack mitigation.

+ * @see {@link DescribeDRTAccessCommand} */ - public describeDRTAccess( + describeDRTAccess( args: DescribeDRTAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDRTAccess( + describeDRTAccess( args: DescribeDRTAccessCommandInput, cb: (err: any, data?: DescribeDRTAccessCommandOutput) => void ): void; - public describeDRTAccess( + describeDRTAccess( args: DescribeDRTAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDRTAccessCommandOutput) => void ): void; - public describeDRTAccess( - args: DescribeDRTAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDRTAccessCommandOutput) => void), - cb?: (err: any, data?: DescribeDRTAccessCommandOutput) => void - ): Promise | void { - const command = new DescribeDRTAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.

+ * @see {@link DescribeEmergencyContactSettingsCommand} */ - public describeEmergencyContactSettings( + describeEmergencyContactSettings( args: DescribeEmergencyContactSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEmergencyContactSettings( + describeEmergencyContactSettings( args: DescribeEmergencyContactSettingsCommandInput, cb: (err: any, data?: DescribeEmergencyContactSettingsCommandOutput) => void ): void; - public describeEmergencyContactSettings( + describeEmergencyContactSettings( args: DescribeEmergencyContactSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEmergencyContactSettingsCommandOutput) => void ): void; - public describeEmergencyContactSettings( - args: DescribeEmergencyContactSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEmergencyContactSettingsCommandOutput) => void), - cb?: (err: any, data?: DescribeEmergencyContactSettingsCommandOutput) => void - ): Promise | void { - const command = new DescribeEmergencyContactSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the details of a Protection object.

+ * @see {@link DescribeProtectionCommand} */ - public describeProtection( + describeProtection( args: DescribeProtectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProtection( + describeProtection( args: DescribeProtectionCommandInput, cb: (err: any, data?: DescribeProtectionCommandOutput) => void ): void; - public describeProtection( + describeProtection( args: DescribeProtectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProtectionCommandOutput) => void ): void; - public describeProtection( - args: DescribeProtectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProtectionCommandOutput) => void), - cb?: (err: any, data?: DescribeProtectionCommandOutput) => void - ): Promise | void { - const command = new DescribeProtectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the specification for the specified protection group.

+ * @see {@link DescribeProtectionGroupCommand} */ - public describeProtectionGroup( + describeProtectionGroup( args: DescribeProtectionGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProtectionGroup( + describeProtectionGroup( args: DescribeProtectionGroupCommandInput, cb: (err: any, data?: DescribeProtectionGroupCommandOutput) => void ): void; - public describeProtectionGroup( + describeProtectionGroup( args: DescribeProtectionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProtectionGroupCommandOutput) => void ): void; - public describeProtectionGroup( - args: DescribeProtectionGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProtectionGroupCommandOutput) => void), - cb?: (err: any, data?: DescribeProtectionGroupCommandOutput) => void - ): Promise | void { - const command = new DescribeProtectionGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides details about the Shield Advanced subscription for an account.

+ * @see {@link DescribeSubscriptionCommand} */ - public describeSubscription( + describeSubscription( args: DescribeSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSubscription( + describeSubscription( args: DescribeSubscriptionCommandInput, cb: (err: any, data?: DescribeSubscriptionCommandOutput) => void ): void; - public describeSubscription( + describeSubscription( args: DescribeSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSubscriptionCommandOutput) => void ): void; - public describeSubscription( - args: DescribeSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSubscriptionCommandOutput) => void), - cb?: (err: any, data?: DescribeSubscriptionCommandOutput) => void - ): Promise | void { - const command = new DescribeSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource. This - * stops Shield Advanced from creating, verifying, and applying WAF rules for attacks that it detects for the resource.

+ * @see {@link DisableApplicationLayerAutomaticResponseCommand} */ - public disableApplicationLayerAutomaticResponse( + disableApplicationLayerAutomaticResponse( args: DisableApplicationLayerAutomaticResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableApplicationLayerAutomaticResponse( + disableApplicationLayerAutomaticResponse( args: DisableApplicationLayerAutomaticResponseCommandInput, cb: (err: any, data?: DisableApplicationLayerAutomaticResponseCommandOutput) => void ): void; - public disableApplicationLayerAutomaticResponse( + disableApplicationLayerAutomaticResponse( args: DisableApplicationLayerAutomaticResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableApplicationLayerAutomaticResponseCommandOutput) => void ): void; - public disableApplicationLayerAutomaticResponse( - args: DisableApplicationLayerAutomaticResponseCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisableApplicationLayerAutomaticResponseCommandOutput) => void), - cb?: (err: any, data?: DisableApplicationLayerAutomaticResponseCommandOutput) => void - ): Promise | void { - const command = new DisableApplicationLayerAutomaticResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.

+ * @see {@link DisableProactiveEngagementCommand} */ - public disableProactiveEngagement( + disableProactiveEngagement( args: DisableProactiveEngagementCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableProactiveEngagement( + disableProactiveEngagement( args: DisableProactiveEngagementCommandInput, cb: (err: any, data?: DisableProactiveEngagementCommandOutput) => void ): void; - public disableProactiveEngagement( + disableProactiveEngagement( args: DisableProactiveEngagementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableProactiveEngagementCommandOutput) => void ): void; - public disableProactiveEngagement( - args: DisableProactiveEngagementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableProactiveEngagementCommandOutput) => void), - cb?: (err: any, data?: DisableProactiveEngagementCommandOutput) => void - ): Promise | void { - const command = new DisableProactiveEngagementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.

+ * @see {@link DisassociateDRTLogBucketCommand} */ - public disassociateDRTLogBucket( + disassociateDRTLogBucket( args: DisassociateDRTLogBucketCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateDRTLogBucket( + disassociateDRTLogBucket( args: DisassociateDRTLogBucketCommandInput, cb: (err: any, data?: DisassociateDRTLogBucketCommandOutput) => void ): void; - public disassociateDRTLogBucket( + disassociateDRTLogBucket( args: DisassociateDRTLogBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateDRTLogBucketCommandOutput) => void ): void; - public disassociateDRTLogBucket( - args: DisassociateDRTLogBucketCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateDRTLogBucketCommandOutput) => void), - cb?: (err: any, data?: DisassociateDRTLogBucketCommandOutput) => void - ): Promise | void { - const command = new DisassociateDRTLogBucketCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.

+ * @see {@link DisassociateDRTRoleCommand} */ - public disassociateDRTRole( + disassociateDRTRole( args: DisassociateDRTRoleCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateDRTRole( + disassociateDRTRole( args: DisassociateDRTRoleCommandInput, cb: (err: any, data?: DisassociateDRTRoleCommandOutput) => void ): void; - public disassociateDRTRole( + disassociateDRTRole( args: DisassociateDRTRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateDRTRoleCommandOutput) => void ): void; - public disassociateDRTRole( - args: DisassociateDRTRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateDRTRoleCommandOutput) => void), - cb?: (err: any, data?: DisassociateDRTRoleCommandOutput) => void - ): Promise | void { - const command = new DisassociateDRTRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.

- *

You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.

+ * @see {@link DisassociateHealthCheckCommand} */ - public disassociateHealthCheck( + disassociateHealthCheck( args: DisassociateHealthCheckCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateHealthCheck( + disassociateHealthCheck( args: DisassociateHealthCheckCommandInput, cb: (err: any, data?: DisassociateHealthCheckCommandOutput) => void ): void; - public disassociateHealthCheck( + disassociateHealthCheck( args: DisassociateHealthCheckCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateHealthCheckCommandOutput) => void ): void; - public disassociateHealthCheck( - args: DisassociateHealthCheckCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateHealthCheckCommandOutput) => void), - cb?: (err: any, data?: DisassociateHealthCheckCommandOutput) => void - ): Promise | void { - const command = new DisassociateHealthCheckCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource.

- * - *

This feature is available for Amazon CloudFront distributions and Application Load Balancers only.

- *
- *

This causes Shield Advanced to create, verify, and apply WAF rules for DDoS attacks that it detects for the - * resource. Shield Advanced applies the rules in a Shield rule group inside the web ACL that you've associated - * with the resource. For information about how automatic mitigation works and the requirements for using it, see - * Shield Advanced automatic application layer DDoS mitigation.

- * - *

Don't use this action to make changes to automatic mitigation settings when it's already enabled for a resource. Instead, use UpdateApplicationLayerAutomaticResponse.

- *
- *

To use this feature, you must associate a web ACL with the protected resource. The web ACL must be created using the latest version of WAF (v2). You can associate the web ACL through the Shield Advanced console - * at https://console.aws.amazon.com/wafv2/shieldv2#/. For more information, - * see Getting Started with Shield Advanced. You can also associate the web ACL to the resource through the WAF console or the WAF API, but you must manage Shield Advanced automatic mitigation through Shield Advanced. For information about WAF, see - * WAF Developer Guide.

+ * @see {@link EnableApplicationLayerAutomaticResponseCommand} */ - public enableApplicationLayerAutomaticResponse( + enableApplicationLayerAutomaticResponse( args: EnableApplicationLayerAutomaticResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableApplicationLayerAutomaticResponse( + enableApplicationLayerAutomaticResponse( args: EnableApplicationLayerAutomaticResponseCommandInput, cb: (err: any, data?: EnableApplicationLayerAutomaticResponseCommandOutput) => void ): void; - public enableApplicationLayerAutomaticResponse( + enableApplicationLayerAutomaticResponse( args: EnableApplicationLayerAutomaticResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableApplicationLayerAutomaticResponseCommandOutput) => void ): void; - public enableApplicationLayerAutomaticResponse( - args: EnableApplicationLayerAutomaticResponseCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: EnableApplicationLayerAutomaticResponseCommandOutput) => void), - cb?: (err: any, data?: EnableApplicationLayerAutomaticResponseCommandOutput) => void - ): Promise | void { - const command = new EnableApplicationLayerAutomaticResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.

+ * @see {@link EnableProactiveEngagementCommand} */ - public enableProactiveEngagement( + enableProactiveEngagement( args: EnableProactiveEngagementCommandInput, options?: __HttpHandlerOptions ): Promise; - public enableProactiveEngagement( + enableProactiveEngagement( args: EnableProactiveEngagementCommandInput, cb: (err: any, data?: EnableProactiveEngagementCommandOutput) => void ): void; - public enableProactiveEngagement( + enableProactiveEngagement( args: EnableProactiveEngagementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableProactiveEngagementCommandOutput) => void ): void; - public enableProactiveEngagement( - args: EnableProactiveEngagementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EnableProactiveEngagementCommandOutput) => void), - cb?: (err: any, data?: EnableProactiveEngagementCommandOutput) => void - ): Promise | void { - const command = new EnableProactiveEngagementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the SubscriptionState, either Active or Inactive.

+ * @see {@link GetSubscriptionStateCommand} */ - public getSubscriptionState( + getSubscriptionState( args: GetSubscriptionStateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSubscriptionState( + getSubscriptionState( args: GetSubscriptionStateCommandInput, cb: (err: any, data?: GetSubscriptionStateCommandOutput) => void ): void; - public getSubscriptionState( + getSubscriptionState( args: GetSubscriptionStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSubscriptionStateCommandOutput) => void ): void; - public getSubscriptionState( - args: GetSubscriptionStateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSubscriptionStateCommandOutput) => void), - cb?: (err: any, data?: GetSubscriptionStateCommandOutput) => void - ): Promise | void { - const command = new GetSubscriptionStateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns all ongoing DDoS attacks or all DDoS attacks during a specified time - * period.

+ * @see {@link ListAttacksCommand} */ - public listAttacks(args: ListAttacksCommandInput, options?: __HttpHandlerOptions): Promise; - public listAttacks(args: ListAttacksCommandInput, cb: (err: any, data?: ListAttacksCommandOutput) => void): void; - public listAttacks( + listAttacks(args: ListAttacksCommandInput, options?: __HttpHandlerOptions): Promise; + listAttacks(args: ListAttacksCommandInput, cb: (err: any, data?: ListAttacksCommandOutput) => void): void; + listAttacks( args: ListAttacksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAttacksCommandOutput) => void ): void; - public listAttacks( - args: ListAttacksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAttacksCommandOutput) => void), - cb?: (err: any, data?: ListAttacksCommandOutput) => void - ): Promise | void { - const command = new ListAttacksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide - * filtering criteria and retrieve just the subset of protection groups that match the criteria.

+ * @see {@link ListProtectionGroupsCommand} */ - public listProtectionGroups( + listProtectionGroups( args: ListProtectionGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProtectionGroups( + listProtectionGroups( args: ListProtectionGroupsCommandInput, cb: (err: any, data?: ListProtectionGroupsCommandOutput) => void ): void; - public listProtectionGroups( + listProtectionGroups( args: ListProtectionGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProtectionGroupsCommandOutput) => void ): void; - public listProtectionGroups( - args: ListProtectionGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProtectionGroupsCommandOutput) => void), - cb?: (err: any, data?: ListProtectionGroupsCommandOutput) => void - ): Promise | void { - const command = new ListProtectionGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves Protection objects for the account. You can retrieve all protections or you can provide - * filtering criteria and retrieve just the subset of protections that match the criteria.

+ * @see {@link ListProtectionsCommand} */ - public listProtections( + listProtections( args: ListProtectionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProtections( - args: ListProtectionsCommandInput, - cb: (err: any, data?: ListProtectionsCommandOutput) => void - ): void; - public listProtections( + listProtections(args: ListProtectionsCommandInput, cb: (err: any, data?: ListProtectionsCommandOutput) => void): void; + listProtections( args: ListProtectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProtectionsCommandOutput) => void ): void; - public listProtections( - args: ListProtectionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProtectionsCommandOutput) => void), - cb?: (err: any, data?: ListProtectionsCommandOutput) => void - ): Promise | void { - const command = new ListProtectionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the resources that are included in the protection group.

+ * @see {@link ListResourcesInProtectionGroupCommand} */ - public listResourcesInProtectionGroup( + listResourcesInProtectionGroup( args: ListResourcesInProtectionGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourcesInProtectionGroup( + listResourcesInProtectionGroup( args: ListResourcesInProtectionGroupCommandInput, cb: (err: any, data?: ListResourcesInProtectionGroupCommandOutput) => void ): void; - public listResourcesInProtectionGroup( + listResourcesInProtectionGroup( args: ListResourcesInProtectionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourcesInProtectionGroupCommandOutput) => void ): void; - public listResourcesInProtectionGroup( - args: ListResourcesInProtectionGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourcesInProtectionGroupCommandOutput) => void), - cb?: (err: any, data?: ListResourcesInProtectionGroupCommandOutput) => void - ): Promise | void { - const command = new ListResourcesInProtectionGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or updates tags for a resource in Shield.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from a resource in Shield.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.

+ * @see {@link UpdateApplicationLayerAutomaticResponseCommand} */ - public updateApplicationLayerAutomaticResponse( + updateApplicationLayerAutomaticResponse( args: UpdateApplicationLayerAutomaticResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApplicationLayerAutomaticResponse( + updateApplicationLayerAutomaticResponse( args: UpdateApplicationLayerAutomaticResponseCommandInput, cb: (err: any, data?: UpdateApplicationLayerAutomaticResponseCommandOutput) => void ): void; - public updateApplicationLayerAutomaticResponse( + updateApplicationLayerAutomaticResponse( args: UpdateApplicationLayerAutomaticResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationLayerAutomaticResponseCommandOutput) => void ): void; - public updateApplicationLayerAutomaticResponse( - args: UpdateApplicationLayerAutomaticResponseCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateApplicationLayerAutomaticResponseCommandOutput) => void), - cb?: (err: any, data?: UpdateApplicationLayerAutomaticResponseCommandOutput) => void - ): Promise | void { - const command = new UpdateApplicationLayerAutomaticResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the details of the list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.

+ * @see {@link UpdateEmergencyContactSettingsCommand} */ - public updateEmergencyContactSettings( + updateEmergencyContactSettings( args: UpdateEmergencyContactSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateEmergencyContactSettings( + updateEmergencyContactSettings( args: UpdateEmergencyContactSettingsCommandInput, cb: (err: any, data?: UpdateEmergencyContactSettingsCommandOutput) => void ): void; - public updateEmergencyContactSettings( + updateEmergencyContactSettings( args: UpdateEmergencyContactSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEmergencyContactSettingsCommandOutput) => void ): void; - public updateEmergencyContactSettings( - args: UpdateEmergencyContactSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateEmergencyContactSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateEmergencyContactSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateEmergencyContactSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing protection group. A protection group is a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.

+ * @see {@link UpdateProtectionGroupCommand} */ - public updateProtectionGroup( + updateProtectionGroup( args: UpdateProtectionGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateProtectionGroup( + updateProtectionGroup( args: UpdateProtectionGroupCommandInput, cb: (err: any, data?: UpdateProtectionGroupCommandOutput) => void ): void; - public updateProtectionGroup( + updateProtectionGroup( args: UpdateProtectionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProtectionGroupCommandOutput) => void ): void; - public updateProtectionGroup( - args: UpdateProtectionGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProtectionGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateProtectionGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateProtectionGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.

- * - *

For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, - * regardless of whether the payer account itself is subscribed.

- *
+ * @see {@link UpdateSubscriptionCommand} */ - public updateSubscription( + updateSubscription( args: UpdateSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSubscription( + updateSubscription( args: UpdateSubscriptionCommandInput, cb: (err: any, data?: UpdateSubscriptionCommandOutput) => void ): void; - public updateSubscription( + updateSubscription( args: UpdateSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSubscriptionCommandOutput) => void ): void; - public updateSubscription( - args: UpdateSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSubscriptionCommandOutput) => void), - cb?: (err: any, data?: UpdateSubscriptionCommandOutput) => void - ): Promise | void { - const command = new UpdateSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Shield Advanced + *

This is the Shield Advanced API Reference. This guide is for developers who need detailed information about the Shield Advanced API actions, + * data types, and errors. For detailed information about WAF and Shield Advanced features and an overview of how to use the WAF and Shield Advanced APIs, see the + * WAF and Shield Developer Guide.

+ */ +export class Shield extends ShieldClient implements Shield {} +createAggregatedClient(commands, Shield); diff --git a/clients/client-signer/src/Signer.ts b/clients/client-signer/src/Signer.ts index 6d08189ca77f..df01a2116116 100644 --- a/clients/client-signer/src/Signer.ts +++ b/clients/client-signer/src/Signer.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -82,641 +83,317 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; -import { SignerClient } from "./SignerClient"; +import { SignerClient, SignerClientConfig } from "./SignerClient"; -/** - * @public - *

AWS Signer is a fully managed code signing service to help you ensure the trust and - * integrity of your code.

- *

AWS Signer supports the following applications:

- * - *

With code signing for AWS Lambda, you can sign AWS Lambda - * deployment packages. Integrated support is provided for Amazon S3, Amazon CloudWatch, - * and AWS CloudTrail. In order to sign code, you create a signing profile and then use - * Signer to sign Lambda zip files in S3.

- * - *

With code signing for IoT, you can sign code for any IoT device that is - * supported by AWS. IoT code signing is available for Amazon FreeRTOS and AWS IoT Device Management, and is - * integrated with AWS Certificate Manager (ACM). In order to sign - * code, you import a third-party code signing certificate using ACM, and use that to - * sign updates in Amazon FreeRTOS and AWS IoT Device Management.

- *

For more information about AWS Signer, see the AWS Signer Developer Guide.

- * - *

- */ -export class Signer extends SignerClient { +const commands = { + AddProfilePermissionCommand, + CancelSigningProfileCommand, + DescribeSigningJobCommand, + GetSigningPlatformCommand, + GetSigningProfileCommand, + ListProfilePermissionsCommand, + ListSigningJobsCommand, + ListSigningPlatformsCommand, + ListSigningProfilesCommand, + ListTagsForResourceCommand, + PutSigningProfileCommand, + RemoveProfilePermissionCommand, + RevokeSignatureCommand, + RevokeSigningProfileCommand, + StartSigningJobCommand, + TagResourceCommand, + UntagResourceCommand, +}; + +export interface Signer { /** - * @public - *

Adds cross-account permissions to a signing profile.

+ * @see {@link AddProfilePermissionCommand} */ - public addProfilePermission( + addProfilePermission( args: AddProfilePermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public addProfilePermission( + addProfilePermission( args: AddProfilePermissionCommandInput, cb: (err: any, data?: AddProfilePermissionCommandOutput) => void ): void; - public addProfilePermission( + addProfilePermission( args: AddProfilePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddProfilePermissionCommandOutput) => void ): void; - public addProfilePermission( - args: AddProfilePermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddProfilePermissionCommandOutput) => void), - cb?: (err: any, data?: AddProfilePermissionCommandOutput) => void - ): Promise | void { - const command = new AddProfilePermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes the state of an ACTIVE signing profile to CANCELED. - * A canceled profile is still viewable with the ListSigningProfiles - * operation, but it cannot perform new signing jobs, and is deleted two years after - * cancelation.

+ * @see {@link CancelSigningProfileCommand} */ - public cancelSigningProfile( + cancelSigningProfile( args: CancelSigningProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelSigningProfile( + cancelSigningProfile( args: CancelSigningProfileCommandInput, cb: (err: any, data?: CancelSigningProfileCommandOutput) => void ): void; - public cancelSigningProfile( + cancelSigningProfile( args: CancelSigningProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelSigningProfileCommandOutput) => void ): void; - public cancelSigningProfile( - args: CancelSigningProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelSigningProfileCommandOutput) => void), - cb?: (err: any, data?: CancelSigningProfileCommandOutput) => void - ): Promise | void { - const command = new CancelSigningProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a specific code signing job. You specify the job by using - * the jobId value that is returned by the StartSigningJob - * operation.

+ * @see {@link DescribeSigningJobCommand} */ - public describeSigningJob( + describeSigningJob( args: DescribeSigningJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSigningJob( + describeSigningJob( args: DescribeSigningJobCommandInput, cb: (err: any, data?: DescribeSigningJobCommandOutput) => void ): void; - public describeSigningJob( + describeSigningJob( args: DescribeSigningJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSigningJobCommandOutput) => void ): void; - public describeSigningJob( - args: DescribeSigningJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSigningJobCommandOutput) => void), - cb?: (err: any, data?: DescribeSigningJobCommandOutput) => void - ): Promise | void { - const command = new DescribeSigningJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information on a specific signing platform.

+ * @see {@link GetSigningPlatformCommand} */ - public getSigningPlatform( + getSigningPlatform( args: GetSigningPlatformCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSigningPlatform( + getSigningPlatform( args: GetSigningPlatformCommandInput, cb: (err: any, data?: GetSigningPlatformCommandOutput) => void ): void; - public getSigningPlatform( + getSigningPlatform( args: GetSigningPlatformCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSigningPlatformCommandOutput) => void ): void; - public getSigningPlatform( - args: GetSigningPlatformCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSigningPlatformCommandOutput) => void), - cb?: (err: any, data?: GetSigningPlatformCommandOutput) => void - ): Promise | void { - const command = new GetSigningPlatformCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information on a specific signing profile.

+ * @see {@link GetSigningProfileCommand} */ - public getSigningProfile( + getSigningProfile( args: GetSigningProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSigningProfile( + getSigningProfile( args: GetSigningProfileCommandInput, cb: (err: any, data?: GetSigningProfileCommandOutput) => void ): void; - public getSigningProfile( + getSigningProfile( args: GetSigningProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSigningProfileCommandOutput) => void ): void; - public getSigningProfile( - args: GetSigningProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSigningProfileCommandOutput) => void), - cb?: (err: any, data?: GetSigningProfileCommandOutput) => void - ): Promise | void { - const command = new GetSigningProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the cross-account permissions associated with a signing profile.

+ * @see {@link ListProfilePermissionsCommand} */ - public listProfilePermissions( + listProfilePermissions( args: ListProfilePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listProfilePermissions( + listProfilePermissions( args: ListProfilePermissionsCommandInput, cb: (err: any, data?: ListProfilePermissionsCommandOutput) => void ): void; - public listProfilePermissions( + listProfilePermissions( args: ListProfilePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProfilePermissionsCommandOutput) => void ): void; - public listProfilePermissions( - args: ListProfilePermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProfilePermissionsCommandOutput) => void), - cb?: (err: any, data?: ListProfilePermissionsCommandOutput) => void - ): Promise | void { - const command = new ListProfilePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all your signing jobs. You can use the maxResults parameter to - * limit the number of signing jobs that are returned in the response. If additional jobs - * remain to be listed, code signing returns a nextToken value. Use this value in - * subsequent calls to ListSigningJobs to fetch the remaining values. You can - * continue calling ListSigningJobs with your maxResults - * parameter and with new values that code signing returns in the nextToken - * parameter until all of your signing jobs have been returned.

+ * @see {@link ListSigningJobsCommand} */ - public listSigningJobs( + listSigningJobs( args: ListSigningJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSigningJobs( - args: ListSigningJobsCommandInput, - cb: (err: any, data?: ListSigningJobsCommandOutput) => void - ): void; - public listSigningJobs( + listSigningJobs(args: ListSigningJobsCommandInput, cb: (err: any, data?: ListSigningJobsCommandOutput) => void): void; + listSigningJobs( args: ListSigningJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSigningJobsCommandOutput) => void ): void; - public listSigningJobs( - args: ListSigningJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSigningJobsCommandOutput) => void), - cb?: (err: any, data?: ListSigningJobsCommandOutput) => void - ): Promise | void { - const command = new ListSigningJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all signing platforms available in code signing that match the request parameters. If - * additional jobs remain to be listed, code signing returns a nextToken value. Use - * this value in subsequent calls to ListSigningJobs to fetch the remaining - * values. You can continue calling ListSigningJobs with your - * maxResults parameter and with new values that code signing returns in the - * nextToken parameter until all of your signing jobs have been - * returned.

+ * @see {@link ListSigningPlatformsCommand} */ - public listSigningPlatforms( + listSigningPlatforms( args: ListSigningPlatformsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSigningPlatforms( + listSigningPlatforms( args: ListSigningPlatformsCommandInput, cb: (err: any, data?: ListSigningPlatformsCommandOutput) => void ): void; - public listSigningPlatforms( + listSigningPlatforms( args: ListSigningPlatformsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSigningPlatformsCommandOutput) => void ): void; - public listSigningPlatforms( - args: ListSigningPlatformsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSigningPlatformsCommandOutput) => void), - cb?: (err: any, data?: ListSigningPlatformsCommandOutput) => void - ): Promise | void { - const command = new ListSigningPlatformsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all available signing profiles in your AWS account. Returns only profiles with - * an ACTIVE status unless the includeCanceled request field is - * set to true. If additional jobs remain to be listed, code signing returns a - * nextToken value. Use this value in subsequent calls to - * ListSigningJobs to fetch the remaining values. You can continue calling - * ListSigningJobs with your maxResults parameter and with - * new values that code signing returns in the nextToken parameter until all of your - * signing jobs have been returned.

+ * @see {@link ListSigningProfilesCommand} */ - public listSigningProfiles( + listSigningProfiles( args: ListSigningProfilesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSigningProfiles( + listSigningProfiles( args: ListSigningProfilesCommandInput, cb: (err: any, data?: ListSigningProfilesCommandOutput) => void ): void; - public listSigningProfiles( + listSigningProfiles( args: ListSigningProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSigningProfilesCommandOutput) => void ): void; - public listSigningProfiles( - args: ListSigningProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSigningProfilesCommandOutput) => void), - cb?: (err: any, data?: ListSigningProfilesCommandOutput) => void - ): Promise | void { - const command = new ListSigningProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the tags associated with a signing profile resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a signing profile. A signing profile is a code signing template that can be used to - * carry out a pre-defined signing job. For more information, see http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html - *

+ * @see {@link PutSigningProfileCommand} */ - public putSigningProfile( + putSigningProfile( args: PutSigningProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public putSigningProfile( + putSigningProfile( args: PutSigningProfileCommandInput, cb: (err: any, data?: PutSigningProfileCommandOutput) => void ): void; - public putSigningProfile( + putSigningProfile( args: PutSigningProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSigningProfileCommandOutput) => void ): void; - public putSigningProfile( - args: PutSigningProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutSigningProfileCommandOutput) => void), - cb?: (err: any, data?: PutSigningProfileCommandOutput) => void - ): Promise | void { - const command = new PutSigningProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes cross-account permissions from a signing profile.

+ * @see {@link RemoveProfilePermissionCommand} */ - public removeProfilePermission( + removeProfilePermission( args: RemoveProfilePermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeProfilePermission( + removeProfilePermission( args: RemoveProfilePermissionCommandInput, cb: (err: any, data?: RemoveProfilePermissionCommandOutput) => void ): void; - public removeProfilePermission( + removeProfilePermission( args: RemoveProfilePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveProfilePermissionCommandOutput) => void ): void; - public removeProfilePermission( - args: RemoveProfilePermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveProfilePermissionCommandOutput) => void), - cb?: (err: any, data?: RemoveProfilePermissionCommandOutput) => void - ): Promise | void { - const command = new RemoveProfilePermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes the state of a signing job to REVOKED. This indicates that the signature is no - * longer valid.

+ * @see {@link RevokeSignatureCommand} */ - public revokeSignature( + revokeSignature( args: RevokeSignatureCommandInput, options?: __HttpHandlerOptions ): Promise; - public revokeSignature( - args: RevokeSignatureCommandInput, - cb: (err: any, data?: RevokeSignatureCommandOutput) => void - ): void; - public revokeSignature( + revokeSignature(args: RevokeSignatureCommandInput, cb: (err: any, data?: RevokeSignatureCommandOutput) => void): void; + revokeSignature( args: RevokeSignatureCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeSignatureCommandOutput) => void ): void; - public revokeSignature( - args: RevokeSignatureCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RevokeSignatureCommandOutput) => void), - cb?: (err: any, data?: RevokeSignatureCommandOutput) => void - ): Promise | void { - const command = new RevokeSignatureCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes the state of a signing profile to REVOKED. This indicates that signatures - * generated using the signing profile after an effective start date are no longer - * valid.

+ * @see {@link RevokeSigningProfileCommand} */ - public revokeSigningProfile( + revokeSigningProfile( args: RevokeSigningProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public revokeSigningProfile( + revokeSigningProfile( args: RevokeSigningProfileCommandInput, cb: (err: any, data?: RevokeSigningProfileCommandOutput) => void ): void; - public revokeSigningProfile( + revokeSigningProfile( args: RevokeSigningProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeSigningProfileCommandOutput) => void ): void; - public revokeSigningProfile( - args: RevokeSigningProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RevokeSigningProfileCommandOutput) => void), - cb?: (err: any, data?: RevokeSigningProfileCommandOutput) => void - ): Promise | void { - const command = new RevokeSigningProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Initiates a signing job to be performed on the code provided. Signing jobs are - * viewable by the ListSigningJobs operation for two years after they are - * performed. Note the following requirements:

- *
    - *
  • - *

    You must create an Amazon S3 source bucket. For more information, see Create a Bucket in the - * Amazon S3 Getting Started Guide.

    - *
  • - *
  • - *

    Your S3 source bucket must be version enabled.

    - *
  • - *
  • - *

    You must create an S3 destination bucket. Code signing uses your S3 destination - * bucket to write your signed code.

    - *
  • - *
  • - *

    You specify the name of the source and destination buckets when calling the - * StartSigningJob operation.

    - *
  • - *
  • - *

    You must also specify a request token that identifies your request to - * code signing.

    - *
  • - *
- *

You can call the DescribeSigningJob and the ListSigningJobs actions after you call - * StartSigningJob.

- *

For a Java example that shows how to use this action, see http://docs.aws.amazon.com/acm/latest/userguide/ - *

+ * @see {@link StartSigningJobCommand} */ - public startSigningJob( + startSigningJob( args: StartSigningJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startSigningJob( - args: StartSigningJobCommandInput, - cb: (err: any, data?: StartSigningJobCommandOutput) => void - ): void; - public startSigningJob( + startSigningJob(args: StartSigningJobCommandInput, cb: (err: any, data?: StartSigningJobCommandOutput) => void): void; + startSigningJob( args: StartSigningJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSigningJobCommandOutput) => void ): void; - public startSigningJob( - args: StartSigningJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartSigningJobCommandOutput) => void), - cb?: (err: any, data?: StartSigningJobCommandOutput) => void - ): Promise | void { - const command = new StartSigningJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more tags to a signing profile. Tags are labels that you can use to - * identify and organize your AWS resources. Each tag consists of a key and an optional - * value. To specify the signing profile, use its Amazon Resource Name (ARN). To specify - * the tag, use a key-value pair.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from a signing profile. To remove the tags, specify a list of - * tag keys.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

AWS Signer is a fully managed code signing service to help you ensure the trust and + * integrity of your code.

+ *

AWS Signer supports the following applications:

+ * + *

With code signing for AWS Lambda, you can sign AWS Lambda + * deployment packages. Integrated support is provided for Amazon S3, Amazon CloudWatch, + * and AWS CloudTrail. In order to sign code, you create a signing profile and then use + * Signer to sign Lambda zip files in S3.

+ * + *

With code signing for IoT, you can sign code for any IoT device that is + * supported by AWS. IoT code signing is available for Amazon FreeRTOS and AWS IoT Device Management, and is + * integrated with AWS Certificate Manager (ACM). In order to sign + * code, you import a third-party code signing certificate using ACM, and use that to + * sign updates in Amazon FreeRTOS and AWS IoT Device Management.

+ *

For more information about AWS Signer, see the AWS Signer Developer Guide.

+ * + *

+ */ +export class Signer extends SignerClient implements Signer {} +createAggregatedClient(commands, Signer); diff --git a/clients/client-simspaceweaver/src/SimSpaceWeaver.ts b/clients/client-simspaceweaver/src/SimSpaceWeaver.ts index b4b27d29a839..bc68af00e922 100644 --- a/clients/client-simspaceweaver/src/SimSpaceWeaver.ts +++ b/clients/client-simspaceweaver/src/SimSpaceWeaver.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { DeleteAppCommand, DeleteAppCommandInput, DeleteAppCommandOutput } from "./commands/DeleteAppCommand"; @@ -44,479 +45,234 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; -import { SimSpaceWeaverClient } from "./SimSpaceWeaverClient"; +import { SimSpaceWeaverClient, SimSpaceWeaverClientConfig } from "./SimSpaceWeaverClient"; -/** - * @public - *

Amazon Web Services SimSpace Weaver (SimSpace Weaver) is a managed service that you can use to build and operate large-scale - * spatial simulations in the Amazon Web Services Cloud. For example, you can create a digital twin of a city, - * crowd simulations with millions of people and objects, and massilvely-multiplayer games with - * hundreds of thousands of connected players. - * For more information about SimSpace Weaver, see the - * Amazon Web Services SimSpace Weaver User Guide - * .

- *

This API reference describes the API operations and data types that you can use to - * communicate directly with SimSpace Weaver.

- *

SimSpace Weaver also provides the SimSpace Weaver app SDK, which you use for app development. The SimSpace Weaver - * app SDK API reference is included in the SimSpace Weaver app SDK documentation, which is part of the - * SimSpace Weaver app SDK distributable package.

- */ -export class SimSpaceWeaver extends SimSpaceWeaverClient { +const commands = { + DeleteAppCommand, + DeleteSimulationCommand, + DescribeAppCommand, + DescribeSimulationCommand, + ListAppsCommand, + ListSimulationsCommand, + ListTagsForResourceCommand, + StartAppCommand, + StartClockCommand, + StartSimulationCommand, + StopAppCommand, + StopClockCommand, + StopSimulationCommand, + TagResourceCommand, + UntagResourceCommand, +}; + +export interface SimSpaceWeaver { /** - * @public - *

Deletes the instance of the given custom app.

+ * @see {@link DeleteAppCommand} */ - public deleteApp(args: DeleteAppCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteApp(args: DeleteAppCommandInput, cb: (err: any, data?: DeleteAppCommandOutput) => void): void; - public deleteApp( + deleteApp(args: DeleteAppCommandInput, options?: __HttpHandlerOptions): Promise; + deleteApp(args: DeleteAppCommandInput, cb: (err: any, data?: DeleteAppCommandOutput) => void): void; + deleteApp( args: DeleteAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppCommandOutput) => void ): void; - public deleteApp( - args: DeleteAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppCommandOutput) => void), - cb?: (err: any, data?: DeleteAppCommandOutput) => void - ): Promise | void { - const command = new DeleteAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes all SimSpace Weaver resources assigned to the given simulation.

- * - *

Your simulation uses resources in other Amazon Web Services services. This API operation doesn't delete - * resources in other Amazon Web Services services.

- *
+ * @see {@link DeleteSimulationCommand} */ - public deleteSimulation( + deleteSimulation( args: DeleteSimulationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSimulation( + deleteSimulation( args: DeleteSimulationCommandInput, cb: (err: any, data?: DeleteSimulationCommandOutput) => void ): void; - public deleteSimulation( + deleteSimulation( args: DeleteSimulationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSimulationCommandOutput) => void ): void; - public deleteSimulation( - args: DeleteSimulationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSimulationCommandOutput) => void), - cb?: (err: any, data?: DeleteSimulationCommandOutput) => void - ): Promise | void { - const command = new DeleteSimulationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the state of the given custom app.

+ * @see {@link DescribeAppCommand} */ - public describeApp(args: DescribeAppCommandInput, options?: __HttpHandlerOptions): Promise; - public describeApp(args: DescribeAppCommandInput, cb: (err: any, data?: DescribeAppCommandOutput) => void): void; - public describeApp( + describeApp(args: DescribeAppCommandInput, options?: __HttpHandlerOptions): Promise; + describeApp(args: DescribeAppCommandInput, cb: (err: any, data?: DescribeAppCommandOutput) => void): void; + describeApp( args: DescribeAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppCommandOutput) => void ): void; - public describeApp( - args: DescribeAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAppCommandOutput) => void), - cb?: (err: any, data?: DescribeAppCommandOutput) => void - ): Promise | void { - const command = new DescribeAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the current state of the given simulation.

+ * @see {@link DescribeSimulationCommand} */ - public describeSimulation( + describeSimulation( args: DescribeSimulationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSimulation( + describeSimulation( args: DescribeSimulationCommandInput, cb: (err: any, data?: DescribeSimulationCommandOutput) => void ): void; - public describeSimulation( + describeSimulation( args: DescribeSimulationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSimulationCommandOutput) => void ): void; - public describeSimulation( - args: DescribeSimulationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSimulationCommandOutput) => void), - cb?: (err: any, data?: DescribeSimulationCommandOutput) => void - ): Promise | void { - const command = new DescribeSimulationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all custom apps or service apps for the given simulation and domain.

+ * @see {@link ListAppsCommand} */ - public listApps(args: ListAppsCommandInput, options?: __HttpHandlerOptions): Promise; - public listApps(args: ListAppsCommandInput, cb: (err: any, data?: ListAppsCommandOutput) => void): void; - public listApps( + listApps(args: ListAppsCommandInput, options?: __HttpHandlerOptions): Promise; + listApps(args: ListAppsCommandInput, cb: (err: any, data?: ListAppsCommandOutput) => void): void; + listApps( args: ListAppsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppsCommandOutput) => void ): void; - public listApps( - args: ListAppsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppsCommandOutput) => void), - cb?: (err: any, data?: ListAppsCommandOutput) => void - ): Promise | void { - const command = new ListAppsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.

+ * @see {@link ListSimulationsCommand} */ - public listSimulations( + listSimulations( args: ListSimulationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSimulations( - args: ListSimulationsCommandInput, - cb: (err: any, data?: ListSimulationsCommandOutput) => void - ): void; - public listSimulations( + listSimulations(args: ListSimulationsCommandInput, cb: (err: any, data?: ListSimulationsCommandOutput) => void): void; + listSimulations( args: ListSimulationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSimulationsCommandOutput) => void ): void; - public listSimulations( - args: ListSimulationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSimulationsCommandOutput) => void), - cb?: (err: any, data?: ListSimulationsCommandOutput) => void - ): Promise | void { - const command = new ListSimulationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all tags on a SimSpace Weaver resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a custom app with the configuration specified in the simulation schema.

+ * @see {@link StartAppCommand} */ - public startApp(args: StartAppCommandInput, options?: __HttpHandlerOptions): Promise; - public startApp(args: StartAppCommandInput, cb: (err: any, data?: StartAppCommandOutput) => void): void; - public startApp( + startApp(args: StartAppCommandInput, options?: __HttpHandlerOptions): Promise; + startApp(args: StartAppCommandInput, cb: (err: any, data?: StartAppCommandOutput) => void): void; + startApp( args: StartAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartAppCommandOutput) => void ): void; - public startApp( - args: StartAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartAppCommandOutput) => void), - cb?: (err: any, data?: StartAppCommandOutput) => void - ): Promise | void { - const command = new StartAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts the simulation clock.

+ * @see {@link StartClockCommand} */ - public startClock(args: StartClockCommandInput, options?: __HttpHandlerOptions): Promise; - public startClock(args: StartClockCommandInput, cb: (err: any, data?: StartClockCommandOutput) => void): void; - public startClock( + startClock(args: StartClockCommandInput, options?: __HttpHandlerOptions): Promise; + startClock(args: StartClockCommandInput, cb: (err: any, data?: StartClockCommandOutput) => void): void; + startClock( args: StartClockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartClockCommandOutput) => void ): void; - public startClock( - args: StartClockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartClockCommandOutput) => void), - cb?: (err: any, data?: StartClockCommandOutput) => void - ): Promise | void { - const command = new StartClockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a simulation with the given name and schema.

+ * @see {@link StartSimulationCommand} */ - public startSimulation( + startSimulation( args: StartSimulationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startSimulation( - args: StartSimulationCommandInput, - cb: (err: any, data?: StartSimulationCommandOutput) => void - ): void; - public startSimulation( + startSimulation(args: StartSimulationCommandInput, cb: (err: any, data?: StartSimulationCommandOutput) => void): void; + startSimulation( args: StartSimulationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSimulationCommandOutput) => void ): void; - public startSimulation( - args: StartSimulationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartSimulationCommandOutput) => void), - cb?: (err: any, data?: StartSimulationCommandOutput) => void - ): Promise | void { - const command = new StartSimulationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops the given custom app and shuts down all of its allocated compute resources.

+ * @see {@link StopAppCommand} */ - public stopApp(args: StopAppCommandInput, options?: __HttpHandlerOptions): Promise; - public stopApp(args: StopAppCommandInput, cb: (err: any, data?: StopAppCommandOutput) => void): void; - public stopApp( + stopApp(args: StopAppCommandInput, options?: __HttpHandlerOptions): Promise; + stopApp(args: StopAppCommandInput, cb: (err: any, data?: StopAppCommandOutput) => void): void; + stopApp( args: StopAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopAppCommandOutput) => void ): void; - public stopApp( - args: StopAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopAppCommandOutput) => void), - cb?: (err: any, data?: StopAppCommandOutput) => void - ): Promise | void { - const command = new StopAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops the simulation clock.

+ * @see {@link StopClockCommand} */ - public stopClock(args: StopClockCommandInput, options?: __HttpHandlerOptions): Promise; - public stopClock(args: StopClockCommandInput, cb: (err: any, data?: StopClockCommandOutput) => void): void; - public stopClock( + stopClock(args: StopClockCommandInput, options?: __HttpHandlerOptions): Promise; + stopClock(args: StopClockCommandInput, cb: (err: any, data?: StopClockCommandOutput) => void): void; + stopClock( args: StopClockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopClockCommandOutput) => void ): void; - public stopClock( - args: StopClockCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopClockCommandOutput) => void), - cb?: (err: any, data?: StopClockCommandOutput) => void - ): Promise | void { - const command = new StopClockCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops the given simulation.

- * - *

You can't restart a simulation after you stop it. - * If you need to restart a simulation, you must stop it, delete it, - * and start a new instance of it.

- *
+ * @see {@link StopSimulationCommand} */ - public stopSimulation( + stopSimulation( args: StopSimulationCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopSimulation( - args: StopSimulationCommandInput, - cb: (err: any, data?: StopSimulationCommandOutput) => void - ): void; - public stopSimulation( + stopSimulation(args: StopSimulationCommandInput, cb: (err: any, data?: StopSimulationCommandOutput) => void): void; + stopSimulation( args: StopSimulationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopSimulationCommandOutput) => void ): void; - public stopSimulation( - args: StopSimulationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopSimulationCommandOutput) => void), - cb?: (err: any, data?: StopSimulationCommandOutput) => void - ): Promise | void { - const command = new StopSimulationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds tags to a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources in the - * Amazon Web Services General Reference.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources in the - * Amazon Web Services General Reference.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Web Services SimSpace Weaver (SimSpace Weaver) is a managed service that you can use to build and operate large-scale + * spatial simulations in the Amazon Web Services Cloud. For example, you can create a digital twin of a city, + * crowd simulations with millions of people and objects, and massilvely-multiplayer games with + * hundreds of thousands of connected players. + * For more information about SimSpace Weaver, see the + * Amazon Web Services SimSpace Weaver User Guide + * .

+ *

This API reference describes the API operations and data types that you can use to + * communicate directly with SimSpace Weaver.

+ *

SimSpace Weaver also provides the SimSpace Weaver app SDK, which you use for app development. The SimSpace Weaver + * app SDK API reference is included in the SimSpace Weaver app SDK documentation, which is part of the + * SimSpace Weaver app SDK distributable package.

+ */ +export class SimSpaceWeaver extends SimSpaceWeaverClient implements SimSpaceWeaver {} +createAggregatedClient(commands, SimSpaceWeaver); diff --git a/clients/client-sms/src/SMS.ts b/clients/client-sms/src/SMS.ts index 308e5a39a925..3a8cea068365 100644 --- a/clients/client-sms/src/SMS.ts +++ b/clients/client-sms/src/SMS.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { CreateAppCommand, CreateAppCommandInput, CreateAppCommandOutput } from "./commands/CreateAppCommand"; @@ -148,1168 +149,618 @@ import { UpdateReplicationJobCommandInput, UpdateReplicationJobCommandOutput, } from "./commands/UpdateReplicationJobCommand"; -import { SMSClient } from "./SMSClient"; +import { SMSClient, SMSClientConfig } from "./SMSClient"; -/** - * @public - * @deprecated - * - * - *

- * Product update - *

- *

We recommend Amazon Web Services Application Migration Service (Amazon Web Services - * MGN) as the primary migration service for lift-and-shift migrations. If Amazon Web Services MGN is - * unavailable in a specific Amazon Web Services Region, you can use the Server Migration Service APIs through March - * 2023.

- *
- *

Server Migration Service (Server Migration Service) makes it easier and faster for you to migrate your - * on-premises workloads to Amazon Web Services. To learn more about Server Migration Service, see the following - * resources:

- * - */ -export class SMS extends SMSClient { +const commands = { + CreateAppCommand, + CreateReplicationJobCommand, + DeleteAppCommand, + DeleteAppLaunchConfigurationCommand, + DeleteAppReplicationConfigurationCommand, + DeleteAppValidationConfigurationCommand, + DeleteReplicationJobCommand, + DeleteServerCatalogCommand, + DisassociateConnectorCommand, + GenerateChangeSetCommand, + GenerateTemplateCommand, + GetAppCommand, + GetAppLaunchConfigurationCommand, + GetAppReplicationConfigurationCommand, + GetAppValidationConfigurationCommand, + GetAppValidationOutputCommand, + GetConnectorsCommand, + GetReplicationJobsCommand, + GetReplicationRunsCommand, + GetServersCommand, + ImportAppCatalogCommand, + ImportServerCatalogCommand, + LaunchAppCommand, + ListAppsCommand, + NotifyAppValidationOutputCommand, + PutAppLaunchConfigurationCommand, + PutAppReplicationConfigurationCommand, + PutAppValidationConfigurationCommand, + StartAppReplicationCommand, + StartOnDemandAppReplicationCommand, + StartOnDemandReplicationRunCommand, + StopAppReplicationCommand, + TerminateAppCommand, + UpdateAppCommand, + UpdateReplicationJobCommand, +}; + +export interface SMS { /** - * @public - *

Creates an application. An application consists of one or more server groups. Each - * server group contain one or more servers.

+ * @see {@link CreateAppCommand} */ - public createApp(args: CreateAppCommandInput, options?: __HttpHandlerOptions): Promise; - public createApp(args: CreateAppCommandInput, cb: (err: any, data?: CreateAppCommandOutput) => void): void; - public createApp( + createApp(args: CreateAppCommandInput, options?: __HttpHandlerOptions): Promise; + createApp(args: CreateAppCommandInput, cb: (err: any, data?: CreateAppCommandOutput) => void): void; + createApp( args: CreateAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppCommandOutput) => void ): void; - public createApp( - args: CreateAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAppCommandOutput) => void), - cb?: (err: any, data?: CreateAppCommandOutput) => void - ): Promise | void { - const command = new CreateAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a replication job. The replication job schedules periodic replication runs - * to replicate your server to Amazon Web Services. Each replication run creates an Amazon Machine Image - * (AMI).

+ * @see {@link CreateReplicationJobCommand} */ - public createReplicationJob( + createReplicationJob( args: CreateReplicationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public createReplicationJob( + createReplicationJob( args: CreateReplicationJobCommandInput, cb: (err: any, data?: CreateReplicationJobCommandOutput) => void ): void; - public createReplicationJob( + createReplicationJob( args: CreateReplicationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReplicationJobCommandOutput) => void ): void; - public createReplicationJob( - args: CreateReplicationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateReplicationJobCommandOutput) => void), - cb?: (err: any, data?: CreateReplicationJobCommandOutput) => void - ): Promise | void { - const command = new CreateReplicationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified application. Optionally deletes the launched stack associated with - * the application and all Server Migration Service replication jobs for servers in the application.

+ * @see {@link DeleteAppCommand} */ - public deleteApp(args: DeleteAppCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteApp(args: DeleteAppCommandInput, cb: (err: any, data?: DeleteAppCommandOutput) => void): void; - public deleteApp( + deleteApp(args: DeleteAppCommandInput, options?: __HttpHandlerOptions): Promise; + deleteApp(args: DeleteAppCommandInput, cb: (err: any, data?: DeleteAppCommandOutput) => void): void; + deleteApp( args: DeleteAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppCommandOutput) => void ): void; - public deleteApp( - args: DeleteAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppCommandOutput) => void), - cb?: (err: any, data?: DeleteAppCommandOutput) => void - ): Promise | void { - const command = new DeleteAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the launch configuration for the specified application.

+ * @see {@link DeleteAppLaunchConfigurationCommand} */ - public deleteAppLaunchConfiguration( + deleteAppLaunchConfiguration( args: DeleteAppLaunchConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAppLaunchConfiguration( + deleteAppLaunchConfiguration( args: DeleteAppLaunchConfigurationCommandInput, cb: (err: any, data?: DeleteAppLaunchConfigurationCommandOutput) => void ): void; - public deleteAppLaunchConfiguration( + deleteAppLaunchConfiguration( args: DeleteAppLaunchConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppLaunchConfigurationCommandOutput) => void ): void; - public deleteAppLaunchConfiguration( - args: DeleteAppLaunchConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppLaunchConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteAppLaunchConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteAppLaunchConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the replication configuration for the specified application.

+ * @see {@link DeleteAppReplicationConfigurationCommand} */ - public deleteAppReplicationConfiguration( + deleteAppReplicationConfiguration( args: DeleteAppReplicationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAppReplicationConfiguration( + deleteAppReplicationConfiguration( args: DeleteAppReplicationConfigurationCommandInput, cb: (err: any, data?: DeleteAppReplicationConfigurationCommandOutput) => void ): void; - public deleteAppReplicationConfiguration( + deleteAppReplicationConfiguration( args: DeleteAppReplicationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppReplicationConfigurationCommandOutput) => void ): void; - public deleteAppReplicationConfiguration( - args: DeleteAppReplicationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppReplicationConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteAppReplicationConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteAppReplicationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the validation configuration for the specified application.

+ * @see {@link DeleteAppValidationConfigurationCommand} */ - public deleteAppValidationConfiguration( + deleteAppValidationConfiguration( args: DeleteAppValidationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAppValidationConfiguration( + deleteAppValidationConfiguration( args: DeleteAppValidationConfigurationCommandInput, cb: (err: any, data?: DeleteAppValidationConfigurationCommandOutput) => void ): void; - public deleteAppValidationConfiguration( + deleteAppValidationConfiguration( args: DeleteAppValidationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppValidationConfigurationCommandOutput) => void ): void; - public deleteAppValidationConfiguration( - args: DeleteAppValidationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAppValidationConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteAppValidationConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteAppValidationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified replication job.

- *

After you delete a replication job, there are no further replication runs. Amazon Web Services - * deletes the contents of the Amazon S3 bucket used to store Server Migration Service artifacts. The AMIs created - * by the replication runs are not deleted.

+ * @see {@link DeleteReplicationJobCommand} */ - public deleteReplicationJob( + deleteReplicationJob( args: DeleteReplicationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteReplicationJob( + deleteReplicationJob( args: DeleteReplicationJobCommandInput, cb: (err: any, data?: DeleteReplicationJobCommandOutput) => void ): void; - public deleteReplicationJob( + deleteReplicationJob( args: DeleteReplicationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReplicationJobCommandOutput) => void ): void; - public deleteReplicationJob( - args: DeleteReplicationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteReplicationJobCommandOutput) => void), - cb?: (err: any, data?: DeleteReplicationJobCommandOutput) => void - ): Promise | void { - const command = new DeleteReplicationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes all servers from your server catalog.

+ * @see {@link DeleteServerCatalogCommand} */ - public deleteServerCatalog( + deleteServerCatalog( args: DeleteServerCatalogCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteServerCatalog( + deleteServerCatalog( args: DeleteServerCatalogCommandInput, cb: (err: any, data?: DeleteServerCatalogCommandOutput) => void ): void; - public deleteServerCatalog( + deleteServerCatalog( args: DeleteServerCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServerCatalogCommandOutput) => void ): void; - public deleteServerCatalog( - args: DeleteServerCatalogCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteServerCatalogCommandOutput) => void), - cb?: (err: any, data?: DeleteServerCatalogCommandOutput) => void - ): Promise | void { - const command = new DeleteServerCatalogCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates the specified connector from Server Migration Service.

- *

After you disassociate a connector, it is no longer available to support - * replication jobs.

+ * @see {@link DisassociateConnectorCommand} */ - public disassociateConnector( + disassociateConnector( args: DisassociateConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateConnector( + disassociateConnector( args: DisassociateConnectorCommandInput, cb: (err: any, data?: DisassociateConnectorCommandOutput) => void ): void; - public disassociateConnector( + disassociateConnector( args: DisassociateConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateConnectorCommandOutput) => void ): void; - public disassociateConnector( - args: DisassociateConnectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateConnectorCommandOutput) => void), - cb?: (err: any, data?: DisassociateConnectorCommandOutput) => void - ): Promise | void { - const command = new DisassociateConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Generates a target change set for a currently launched stack and writes it to an Amazon S3 - * object in the customer’s Amazon S3 bucket.

+ * @see {@link GenerateChangeSetCommand} */ - public generateChangeSet( + generateChangeSet( args: GenerateChangeSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public generateChangeSet( + generateChangeSet( args: GenerateChangeSetCommandInput, cb: (err: any, data?: GenerateChangeSetCommandOutput) => void ): void; - public generateChangeSet( + generateChangeSet( args: GenerateChangeSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateChangeSetCommandOutput) => void ): void; - public generateChangeSet( - args: GenerateChangeSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GenerateChangeSetCommandOutput) => void), - cb?: (err: any, data?: GenerateChangeSetCommandOutput) => void - ): Promise | void { - const command = new GenerateChangeSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Generates an CloudFormation template based on the current launch configuration and writes it to - * an Amazon S3 object in the customer’s Amazon S3 bucket.

+ * @see {@link GenerateTemplateCommand} */ - public generateTemplate( + generateTemplate( args: GenerateTemplateCommandInput, options?: __HttpHandlerOptions ): Promise; - public generateTemplate( + generateTemplate( args: GenerateTemplateCommandInput, cb: (err: any, data?: GenerateTemplateCommandOutput) => void ): void; - public generateTemplate( + generateTemplate( args: GenerateTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateTemplateCommandOutput) => void ): void; - public generateTemplate( - args: GenerateTemplateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GenerateTemplateCommandOutput) => void), - cb?: (err: any, data?: GenerateTemplateCommandOutput) => void - ): Promise | void { - const command = new GenerateTemplateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieve information about the specified application.

+ * @see {@link GetAppCommand} */ - public getApp(args: GetAppCommandInput, options?: __HttpHandlerOptions): Promise; - public getApp(args: GetAppCommandInput, cb: (err: any, data?: GetAppCommandOutput) => void): void; - public getApp( + getApp(args: GetAppCommandInput, options?: __HttpHandlerOptions): Promise; + getApp(args: GetAppCommandInput, cb: (err: any, data?: GetAppCommandOutput) => void): void; + getApp( args: GetAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAppCommandOutput) => void ): void; - public getApp( - args: GetAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAppCommandOutput) => void), - cb?: (err: any, data?: GetAppCommandOutput) => void - ): Promise | void { - const command = new GetAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the application launch configuration associated with the specified application.

+ * @see {@link GetAppLaunchConfigurationCommand} */ - public getAppLaunchConfiguration( + getAppLaunchConfiguration( args: GetAppLaunchConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAppLaunchConfiguration( + getAppLaunchConfiguration( args: GetAppLaunchConfigurationCommandInput, cb: (err: any, data?: GetAppLaunchConfigurationCommandOutput) => void ): void; - public getAppLaunchConfiguration( + getAppLaunchConfiguration( args: GetAppLaunchConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAppLaunchConfigurationCommandOutput) => void ): void; - public getAppLaunchConfiguration( - args: GetAppLaunchConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAppLaunchConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetAppLaunchConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetAppLaunchConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the application replication configuration associated with the specified - * application.

+ * @see {@link GetAppReplicationConfigurationCommand} */ - public getAppReplicationConfiguration( + getAppReplicationConfiguration( args: GetAppReplicationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAppReplicationConfiguration( + getAppReplicationConfiguration( args: GetAppReplicationConfigurationCommandInput, cb: (err: any, data?: GetAppReplicationConfigurationCommandOutput) => void ): void; - public getAppReplicationConfiguration( + getAppReplicationConfiguration( args: GetAppReplicationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAppReplicationConfigurationCommandOutput) => void ): void; - public getAppReplicationConfiguration( - args: GetAppReplicationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAppReplicationConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetAppReplicationConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetAppReplicationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about a configuration for validating an application.

+ * @see {@link GetAppValidationConfigurationCommand} */ - public getAppValidationConfiguration( + getAppValidationConfiguration( args: GetAppValidationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAppValidationConfiguration( + getAppValidationConfiguration( args: GetAppValidationConfigurationCommandInput, cb: (err: any, data?: GetAppValidationConfigurationCommandOutput) => void ): void; - public getAppValidationConfiguration( + getAppValidationConfiguration( args: GetAppValidationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAppValidationConfigurationCommandOutput) => void ): void; - public getAppValidationConfiguration( - args: GetAppValidationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAppValidationConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetAppValidationConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetAppValidationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves output from validating an application.

+ * @see {@link GetAppValidationOutputCommand} */ - public getAppValidationOutput( + getAppValidationOutput( args: GetAppValidationOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAppValidationOutput( + getAppValidationOutput( args: GetAppValidationOutputCommandInput, cb: (err: any, data?: GetAppValidationOutputCommandOutput) => void ): void; - public getAppValidationOutput( + getAppValidationOutput( args: GetAppValidationOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAppValidationOutputCommandOutput) => void ): void; - public getAppValidationOutput( - args: GetAppValidationOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAppValidationOutputCommandOutput) => void), - cb?: (err: any, data?: GetAppValidationOutputCommandOutput) => void - ): Promise | void { - const command = new GetAppValidationOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the connectors registered with the Server Migration Service.

+ * @see {@link GetConnectorsCommand} */ - public getConnectors( - args: GetConnectorsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getConnectors( - args: GetConnectorsCommandInput, - cb: (err: any, data?: GetConnectorsCommandOutput) => void - ): void; - public getConnectors( + getConnectors(args: GetConnectorsCommandInput, options?: __HttpHandlerOptions): Promise; + getConnectors(args: GetConnectorsCommandInput, cb: (err: any, data?: GetConnectorsCommandOutput) => void): void; + getConnectors( args: GetConnectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConnectorsCommandOutput) => void ): void; - public getConnectors( - args: GetConnectorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConnectorsCommandOutput) => void), - cb?: (err: any, data?: GetConnectorsCommandOutput) => void - ): Promise | void { - const command = new GetConnectorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified replication job or all of your replication jobs.

+ * @see {@link GetReplicationJobsCommand} */ - public getReplicationJobs( + getReplicationJobs( args: GetReplicationJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReplicationJobs( + getReplicationJobs( args: GetReplicationJobsCommandInput, cb: (err: any, data?: GetReplicationJobsCommandOutput) => void ): void; - public getReplicationJobs( + getReplicationJobs( args: GetReplicationJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReplicationJobsCommandOutput) => void ): void; - public getReplicationJobs( - args: GetReplicationJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReplicationJobsCommandOutput) => void), - cb?: (err: any, data?: GetReplicationJobsCommandOutput) => void - ): Promise | void { - const command = new GetReplicationJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the replication runs for the specified replication job.

+ * @see {@link GetReplicationRunsCommand} */ - public getReplicationRuns( + getReplicationRuns( args: GetReplicationRunsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReplicationRuns( + getReplicationRuns( args: GetReplicationRunsCommandInput, cb: (err: any, data?: GetReplicationRunsCommandOutput) => void ): void; - public getReplicationRuns( + getReplicationRuns( args: GetReplicationRunsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReplicationRunsCommandOutput) => void ): void; - public getReplicationRuns( - args: GetReplicationRunsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReplicationRunsCommandOutput) => void), - cb?: (err: any, data?: GetReplicationRunsCommandOutput) => void - ): Promise | void { - const command = new GetReplicationRunsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the servers in your server catalog.

- *

Before you can describe your servers, you must import them using ImportServerCatalog.

+ * @see {@link GetServersCommand} */ - public getServers(args: GetServersCommandInput, options?: __HttpHandlerOptions): Promise; - public getServers(args: GetServersCommandInput, cb: (err: any, data?: GetServersCommandOutput) => void): void; - public getServers( + getServers(args: GetServersCommandInput, options?: __HttpHandlerOptions): Promise; + getServers(args: GetServersCommandInput, cb: (err: any, data?: GetServersCommandOutput) => void): void; + getServers( args: GetServersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServersCommandOutput) => void ): void; - public getServers( - args: GetServersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServersCommandOutput) => void), - cb?: (err: any, data?: GetServersCommandOutput) => void - ): Promise | void { - const command = new GetServersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows application import from Migration Hub.

+ * @see {@link ImportAppCatalogCommand} */ - public importAppCatalog( + importAppCatalog( args: ImportAppCatalogCommandInput, options?: __HttpHandlerOptions ): Promise; - public importAppCatalog( + importAppCatalog( args: ImportAppCatalogCommandInput, cb: (err: any, data?: ImportAppCatalogCommandOutput) => void ): void; - public importAppCatalog( + importAppCatalog( args: ImportAppCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportAppCatalogCommandOutput) => void ): void; - public importAppCatalog( - args: ImportAppCatalogCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportAppCatalogCommandOutput) => void), - cb?: (err: any, data?: ImportAppCatalogCommandOutput) => void - ): Promise | void { - const command = new ImportAppCatalogCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gathers a complete list of on-premises servers. Connectors must be installed and - * monitoring all servers to import.

- *

This call returns immediately, but might take additional time to retrieve all the - * servers.

+ * @see {@link ImportServerCatalogCommand} */ - public importServerCatalog( + importServerCatalog( args: ImportServerCatalogCommandInput, options?: __HttpHandlerOptions ): Promise; - public importServerCatalog( + importServerCatalog( args: ImportServerCatalogCommandInput, cb: (err: any, data?: ImportServerCatalogCommandOutput) => void ): void; - public importServerCatalog( + importServerCatalog( args: ImportServerCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportServerCatalogCommandOutput) => void ): void; - public importServerCatalog( - args: ImportServerCatalogCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportServerCatalogCommandOutput) => void), - cb?: (err: any, data?: ImportServerCatalogCommandOutput) => void - ): Promise | void { - const command = new ImportServerCatalogCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Launches the specified application as a stack in CloudFormation.

+ * @see {@link LaunchAppCommand} */ - public launchApp(args: LaunchAppCommandInput, options?: __HttpHandlerOptions): Promise; - public launchApp(args: LaunchAppCommandInput, cb: (err: any, data?: LaunchAppCommandOutput) => void): void; - public launchApp( + launchApp(args: LaunchAppCommandInput, options?: __HttpHandlerOptions): Promise; + launchApp(args: LaunchAppCommandInput, cb: (err: any, data?: LaunchAppCommandOutput) => void): void; + launchApp( args: LaunchAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: LaunchAppCommandOutput) => void ): void; - public launchApp( - args: LaunchAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: LaunchAppCommandOutput) => void), - cb?: (err: any, data?: LaunchAppCommandOutput) => void - ): Promise | void { - const command = new LaunchAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves summaries for all applications.

+ * @see {@link ListAppsCommand} */ - public listApps(args: ListAppsCommandInput, options?: __HttpHandlerOptions): Promise; - public listApps(args: ListAppsCommandInput, cb: (err: any, data?: ListAppsCommandOutput) => void): void; - public listApps( + listApps(args: ListAppsCommandInput, options?: __HttpHandlerOptions): Promise; + listApps(args: ListAppsCommandInput, cb: (err: any, data?: ListAppsCommandOutput) => void): void; + listApps( args: ListAppsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppsCommandOutput) => void ): void; - public listApps( - args: ListAppsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAppsCommandOutput) => void), - cb?: (err: any, data?: ListAppsCommandOutput) => void - ): Promise | void { - const command = new ListAppsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides information to Server Migration Service about whether application validation is successful.

+ * @see {@link NotifyAppValidationOutputCommand} */ - public notifyAppValidationOutput( + notifyAppValidationOutput( args: NotifyAppValidationOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public notifyAppValidationOutput( + notifyAppValidationOutput( args: NotifyAppValidationOutputCommandInput, cb: (err: any, data?: NotifyAppValidationOutputCommandOutput) => void ): void; - public notifyAppValidationOutput( + notifyAppValidationOutput( args: NotifyAppValidationOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NotifyAppValidationOutputCommandOutput) => void ): void; - public notifyAppValidationOutput( - args: NotifyAppValidationOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NotifyAppValidationOutputCommandOutput) => void), - cb?: (err: any, data?: NotifyAppValidationOutputCommandOutput) => void - ): Promise | void { - const command = new NotifyAppValidationOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates the launch configuration for the specified application.

+ * @see {@link PutAppLaunchConfigurationCommand} */ - public putAppLaunchConfiguration( + putAppLaunchConfiguration( args: PutAppLaunchConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAppLaunchConfiguration( + putAppLaunchConfiguration( args: PutAppLaunchConfigurationCommandInput, cb: (err: any, data?: PutAppLaunchConfigurationCommandOutput) => void ): void; - public putAppLaunchConfiguration( + putAppLaunchConfiguration( args: PutAppLaunchConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAppLaunchConfigurationCommandOutput) => void ): void; - public putAppLaunchConfiguration( - args: PutAppLaunchConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAppLaunchConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutAppLaunchConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutAppLaunchConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates the replication configuration for the specified application.

+ * @see {@link PutAppReplicationConfigurationCommand} */ - public putAppReplicationConfiguration( + putAppReplicationConfiguration( args: PutAppReplicationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAppReplicationConfiguration( + putAppReplicationConfiguration( args: PutAppReplicationConfigurationCommandInput, cb: (err: any, data?: PutAppReplicationConfigurationCommandOutput) => void ): void; - public putAppReplicationConfiguration( + putAppReplicationConfiguration( args: PutAppReplicationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAppReplicationConfigurationCommandOutput) => void ): void; - public putAppReplicationConfiguration( - args: PutAppReplicationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAppReplicationConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutAppReplicationConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutAppReplicationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates a validation configuration for the specified application.

+ * @see {@link PutAppValidationConfigurationCommand} */ - public putAppValidationConfiguration( + putAppValidationConfiguration( args: PutAppValidationConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAppValidationConfiguration( + putAppValidationConfiguration( args: PutAppValidationConfigurationCommandInput, cb: (err: any, data?: PutAppValidationConfigurationCommandOutput) => void ): void; - public putAppValidationConfiguration( + putAppValidationConfiguration( args: PutAppValidationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAppValidationConfigurationCommandOutput) => void ): void; - public putAppValidationConfiguration( - args: PutAppValidationConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAppValidationConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutAppValidationConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutAppValidationConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts replicating the specified application by creating replication jobs for each server in the - * application.

+ * @see {@link StartAppReplicationCommand} */ - public startAppReplication( + startAppReplication( args: StartAppReplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startAppReplication( + startAppReplication( args: StartAppReplicationCommandInput, cb: (err: any, data?: StartAppReplicationCommandOutput) => void ): void; - public startAppReplication( + startAppReplication( args: StartAppReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartAppReplicationCommandOutput) => void ): void; - public startAppReplication( - args: StartAppReplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartAppReplicationCommandOutput) => void), - cb?: (err: any, data?: StartAppReplicationCommandOutput) => void - ): Promise | void { - const command = new StartAppReplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts an on-demand replication run for the specified application.

+ * @see {@link StartOnDemandAppReplicationCommand} */ - public startOnDemandAppReplication( + startOnDemandAppReplication( args: StartOnDemandAppReplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public startOnDemandAppReplication( + startOnDemandAppReplication( args: StartOnDemandAppReplicationCommandInput, cb: (err: any, data?: StartOnDemandAppReplicationCommandOutput) => void ): void; - public startOnDemandAppReplication( + startOnDemandAppReplication( args: StartOnDemandAppReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartOnDemandAppReplicationCommandOutput) => void ): void; - public startOnDemandAppReplication( - args: StartOnDemandAppReplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartOnDemandAppReplicationCommandOutput) => void), - cb?: (err: any, data?: StartOnDemandAppReplicationCommandOutput) => void - ): Promise | void { - const command = new StartOnDemandAppReplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts an on-demand replication run for the specified replication job. This - * replication run starts immediately. This replication run is in addition to the ones - * already scheduled.

- *

There is a limit on the number of on-demand replications runs that you can request - * in a 24-hour period.

+ * @see {@link StartOnDemandReplicationRunCommand} */ - public startOnDemandReplicationRun( + startOnDemandReplicationRun( args: StartOnDemandReplicationRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public startOnDemandReplicationRun( + startOnDemandReplicationRun( args: StartOnDemandReplicationRunCommandInput, cb: (err: any, data?: StartOnDemandReplicationRunCommandOutput) => void ): void; - public startOnDemandReplicationRun( + startOnDemandReplicationRun( args: StartOnDemandReplicationRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartOnDemandReplicationRunCommandOutput) => void ): void; - public startOnDemandReplicationRun( - args: StartOnDemandReplicationRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartOnDemandReplicationRunCommandOutput) => void), - cb?: (err: any, data?: StartOnDemandReplicationRunCommandOutput) => void - ): Promise | void { - const command = new StartOnDemandReplicationRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops replicating the specified application by deleting the replication job for each server in - * the application.

+ * @see {@link StopAppReplicationCommand} */ - public stopAppReplication( + stopAppReplication( args: StopAppReplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopAppReplication( + stopAppReplication( args: StopAppReplicationCommandInput, cb: (err: any, data?: StopAppReplicationCommandOutput) => void ): void; - public stopAppReplication( + stopAppReplication( args: StopAppReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopAppReplicationCommandOutput) => void ): void; - public stopAppReplication( - args: StopAppReplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopAppReplicationCommandOutput) => void), - cb?: (err: any, data?: StopAppReplicationCommandOutput) => void - ): Promise | void { - const command = new StopAppReplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Terminates the stack for the specified application.

+ * @see {@link TerminateAppCommand} */ - public terminateApp( - args: TerminateAppCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public terminateApp(args: TerminateAppCommandInput, cb: (err: any, data?: TerminateAppCommandOutput) => void): void; - public terminateApp( + terminateApp(args: TerminateAppCommandInput, options?: __HttpHandlerOptions): Promise; + terminateApp(args: TerminateAppCommandInput, cb: (err: any, data?: TerminateAppCommandOutput) => void): void; + terminateApp( args: TerminateAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TerminateAppCommandOutput) => void ): void; - public terminateApp( - args: TerminateAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TerminateAppCommandOutput) => void), - cb?: (err: any, data?: TerminateAppCommandOutput) => void - ): Promise | void { - const command = new TerminateAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified application.

+ * @see {@link UpdateAppCommand} */ - public updateApp(args: UpdateAppCommandInput, options?: __HttpHandlerOptions): Promise; - public updateApp(args: UpdateAppCommandInput, cb: (err: any, data?: UpdateAppCommandOutput) => void): void; - public updateApp( + updateApp(args: UpdateAppCommandInput, options?: __HttpHandlerOptions): Promise; + updateApp(args: UpdateAppCommandInput, cb: (err: any, data?: UpdateAppCommandOutput) => void): void; + updateApp( args: UpdateAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAppCommandOutput) => void ): void; - public updateApp( - args: UpdateAppCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAppCommandOutput) => void), - cb?: (err: any, data?: UpdateAppCommandOutput) => void - ): Promise | void { - const command = new UpdateAppCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified settings for the specified replication job.

+ * @see {@link UpdateReplicationJobCommand} */ - public updateReplicationJob( + updateReplicationJob( args: UpdateReplicationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateReplicationJob( + updateReplicationJob( args: UpdateReplicationJobCommandInput, cb: (err: any, data?: UpdateReplicationJobCommandOutput) => void ): void; - public updateReplicationJob( + updateReplicationJob( args: UpdateReplicationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateReplicationJobCommandOutput) => void ): void; - public updateReplicationJob( - args: UpdateReplicationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateReplicationJobCommandOutput) => void), - cb?: (err: any, data?: UpdateReplicationJobCommandOutput) => void - ): Promise | void { - const command = new UpdateReplicationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * @deprecated + * + * + *

+ * Product update + *

+ *

We recommend Amazon Web Services Application Migration Service (Amazon Web Services + * MGN) as the primary migration service for lift-and-shift migrations. If Amazon Web Services MGN is + * unavailable in a specific Amazon Web Services Region, you can use the Server Migration Service APIs through March + * 2023.

+ *
+ *

Server Migration Service (Server Migration Service) makes it easier and faster for you to migrate your + * on-premises workloads to Amazon Web Services. To learn more about Server Migration Service, see the following + * resources:

+ * + */ +export class SMS extends SMSClient implements SMS {} +createAggregatedClient(commands, SMS); diff --git a/clients/client-snow-device-management/src/SnowDeviceManagement.ts b/clients/client-snow-device-management/src/SnowDeviceManagement.ts index 5b29b3bdd3e9..3b09e03ba0cb 100644 --- a/clients/client-snow-device-management/src/SnowDeviceManagement.ts +++ b/clients/client-snow-device-management/src/SnowDeviceManagement.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { CancelTaskCommand, CancelTaskCommandInput, CancelTaskCommandOutput } from "./commands/CancelTaskCommand"; @@ -46,415 +47,202 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; -import { SnowDeviceManagementClient } from "./SnowDeviceManagementClient"; +import { SnowDeviceManagementClient, SnowDeviceManagementClientConfig } from "./SnowDeviceManagementClient"; -/** - * @public - *

Amazon Web Services Snow Device Management documentation.

- */ -export class SnowDeviceManagement extends SnowDeviceManagementClient { +const commands = { + CancelTaskCommand, + CreateTaskCommand, + DescribeDeviceCommand, + DescribeDeviceEc2InstancesCommand, + DescribeExecutionCommand, + DescribeTaskCommand, + ListDeviceResourcesCommand, + ListDevicesCommand, + ListExecutionsCommand, + ListTagsForResourceCommand, + ListTasksCommand, + TagResourceCommand, + UntagResourceCommand, +}; + +export interface SnowDeviceManagement { /** - * @public - *

Sends a cancel request for a specified task. You can cancel a task only if it's still in a - * QUEUED state. Tasks that are already running can't be cancelled.

- * - *

A task might still run if it's processed from the queue before the - * CancelTask operation changes the task's state.

- *
+ * @see {@link CancelTaskCommand} */ - public cancelTask(args: CancelTaskCommandInput, options?: __HttpHandlerOptions): Promise; - public cancelTask(args: CancelTaskCommandInput, cb: (err: any, data?: CancelTaskCommandOutput) => void): void; - public cancelTask( + cancelTask(args: CancelTaskCommandInput, options?: __HttpHandlerOptions): Promise; + cancelTask(args: CancelTaskCommandInput, cb: (err: any, data?: CancelTaskCommandOutput) => void): void; + cancelTask( args: CancelTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelTaskCommandOutput) => void ): void; - public cancelTask( - args: CancelTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelTaskCommandOutput) => void), - cb?: (err: any, data?: CancelTaskCommandOutput) => void - ): Promise | void { - const command = new CancelTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Instructs one or more devices to start a task, such as unlocking or rebooting.

+ * @see {@link CreateTaskCommand} */ - public createTask(args: CreateTaskCommandInput, options?: __HttpHandlerOptions): Promise; - public createTask(args: CreateTaskCommandInput, cb: (err: any, data?: CreateTaskCommandOutput) => void): void; - public createTask( + createTask(args: CreateTaskCommandInput, options?: __HttpHandlerOptions): Promise; + createTask(args: CreateTaskCommandInput, cb: (err: any, data?: CreateTaskCommandOutput) => void): void; + createTask( args: CreateTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTaskCommandOutput) => void ): void; - public createTask( - args: CreateTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTaskCommandOutput) => void), - cb?: (err: any, data?: CreateTaskCommandOutput) => void - ): Promise | void { - const command = new CreateTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Checks device-specific information, such as the device type, software version, IP - * addresses, and lock status.

+ * @see {@link DescribeDeviceCommand} */ - public describeDevice( + describeDevice( args: DescribeDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDevice( - args: DescribeDeviceCommandInput, - cb: (err: any, data?: DescribeDeviceCommandOutput) => void - ): void; - public describeDevice( + describeDevice(args: DescribeDeviceCommandInput, cb: (err: any, data?: DescribeDeviceCommandOutput) => void): void; + describeDevice( args: DescribeDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDeviceCommandOutput) => void ): void; - public describeDevice( - args: DescribeDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDeviceCommandOutput) => void), - cb?: (err: any, data?: DescribeDeviceCommandOutput) => void - ): Promise | void { - const command = new DescribeDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Checks the current state of the Amazon EC2 instances. The output is similar to - * describeDevice, but the results are sourced from the device cache in the - * Amazon Web Services Cloud and include a subset of the available fields.

+ * @see {@link DescribeDeviceEc2InstancesCommand} */ - public describeDeviceEc2Instances( + describeDeviceEc2Instances( args: DescribeDeviceEc2InstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDeviceEc2Instances( + describeDeviceEc2Instances( args: DescribeDeviceEc2InstancesCommandInput, cb: (err: any, data?: DescribeDeviceEc2InstancesCommandOutput) => void ): void; - public describeDeviceEc2Instances( + describeDeviceEc2Instances( args: DescribeDeviceEc2InstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDeviceEc2InstancesCommandOutput) => void ): void; - public describeDeviceEc2Instances( - args: DescribeDeviceEc2InstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDeviceEc2InstancesCommandOutput) => void), - cb?: (err: any, data?: DescribeDeviceEc2InstancesCommandOutput) => void - ): Promise | void { - const command = new DescribeDeviceEc2InstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Checks the status of a remote task running on one or more target devices.

+ * @see {@link DescribeExecutionCommand} */ - public describeExecution( + describeExecution( args: DescribeExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeExecution( + describeExecution( args: DescribeExecutionCommandInput, cb: (err: any, data?: DescribeExecutionCommandOutput) => void ): void; - public describeExecution( + describeExecution( args: DescribeExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExecutionCommandOutput) => void ): void; - public describeExecution( - args: DescribeExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeExecutionCommandOutput) => void), - cb?: (err: any, data?: DescribeExecutionCommandOutput) => void - ): Promise | void { - const command = new DescribeExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Checks the metadata for a given task on a device.

+ * @see {@link DescribeTaskCommand} */ - public describeTask( - args: DescribeTaskCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeTask(args: DescribeTaskCommandInput, cb: (err: any, data?: DescribeTaskCommandOutput) => void): void; - public describeTask( + describeTask(args: DescribeTaskCommandInput, options?: __HttpHandlerOptions): Promise; + describeTask(args: DescribeTaskCommandInput, cb: (err: any, data?: DescribeTaskCommandOutput) => void): void; + describeTask( args: DescribeTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTaskCommandOutput) => void ): void; - public describeTask( - args: DescribeTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTaskCommandOutput) => void), - cb?: (err: any, data?: DescribeTaskCommandOutput) => void - ): Promise | void { - const command = new DescribeTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are the only supported resource type.

+ * @see {@link ListDeviceResourcesCommand} */ - public listDeviceResources( + listDeviceResources( args: ListDeviceResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeviceResources( + listDeviceResources( args: ListDeviceResourcesCommandInput, cb: (err: any, data?: ListDeviceResourcesCommandOutput) => void ): void; - public listDeviceResources( + listDeviceResources( args: ListDeviceResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeviceResourcesCommandOutput) => void ): void; - public listDeviceResources( - args: ListDeviceResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeviceResourcesCommandOutput) => void), - cb?: (err: any, data?: ListDeviceResourcesCommandOutput) => void - ): Promise | void { - const command = new ListDeviceResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device Management - * enabled in the Amazon Web Services Region where the command is run.

+ * @see {@link ListDevicesCommand} */ - public listDevices(args: ListDevicesCommandInput, options?: __HttpHandlerOptions): Promise; - public listDevices(args: ListDevicesCommandInput, cb: (err: any, data?: ListDevicesCommandOutput) => void): void; - public listDevices( + listDevices(args: ListDevicesCommandInput, options?: __HttpHandlerOptions): Promise; + listDevices(args: ListDevicesCommandInput, cb: (err: any, data?: ListDevicesCommandOutput) => void): void; + listDevices( args: ListDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDevicesCommandOutput) => void ): void; - public listDevices( - args: ListDevicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDevicesCommandOutput) => void), - cb?: (err: any, data?: ListDevicesCommandOutput) => void - ): Promise | void { - const command = new ListDevicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the status of tasks for one or more target devices.

+ * @see {@link ListExecutionsCommand} */ - public listExecutions( + listExecutions( args: ListExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listExecutions( - args: ListExecutionsCommandInput, - cb: (err: any, data?: ListExecutionsCommandOutput) => void - ): void; - public listExecutions( + listExecutions(args: ListExecutionsCommandInput, cb: (err: any, data?: ListExecutionsCommandOutput) => void): void; + listExecutions( args: ListExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExecutionsCommandOutput) => void ): void; - public listExecutions( - args: ListExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListExecutionsCommandOutput) => void), - cb?: (err: any, data?: ListExecutionsCommandOutput) => void - ): Promise | void { - const command = new ListExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of tags for a managed device or task.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of tasks that can be filtered by state.

+ * @see {@link ListTasksCommand} */ - public listTasks(args: ListTasksCommandInput, options?: __HttpHandlerOptions): Promise; - public listTasks(args: ListTasksCommandInput, cb: (err: any, data?: ListTasksCommandOutput) => void): void; - public listTasks( + listTasks(args: ListTasksCommandInput, options?: __HttpHandlerOptions): Promise; + listTasks(args: ListTasksCommandInput, cb: (err: any, data?: ListTasksCommandOutput) => void): void; + listTasks( args: ListTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTasksCommandOutput) => void ): void; - public listTasks( - args: ListTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTasksCommandOutput) => void), - cb?: (err: any, data?: ListTasksCommandOutput) => void - ): Promise | void { - const command = new ListTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or replaces tags on a device or task.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a tag from a device or task.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Web Services Snow Device Management documentation.

+ */ +export class SnowDeviceManagement extends SnowDeviceManagementClient implements SnowDeviceManagement {} +createAggregatedClient(commands, SnowDeviceManagement); diff --git a/clients/client-snowball/src/Snowball.ts b/clients/client-snowball/src/Snowball.ts index c075bd89b67f..e4907e71f4f0 100644 --- a/clients/client-snowball/src/Snowball.ts +++ b/clients/client-snowball/src/Snowball.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -111,1032 +112,417 @@ import { UpdateLongTermPricingCommandInput, UpdateLongTermPricingCommandOutput, } from "./commands/UpdateLongTermPricingCommand"; -import { SnowballClient } from "./SnowballClient"; +import { SnowballClient, SnowballClientConfig } from "./SnowballClient"; -/** - * @public - *

The Amazon Web Services Snow Family provides a petabyte-scale data transport solution that uses - * secure devices to transfer large amounts of data between your on-premises data centers and - * Amazon Simple Storage Service (Amazon S3). The Snow Family commands described here provide access to the same - * functionality that is available in the Amazon Web Services Snow Family Management Console, which enables you to create - * and manage jobs for a Snow Family device. To transfer data locally with a Snow Family device, - * you'll need to use the Snowball Edge client or the Amazon S3 API Interface for Snowball or OpsHub for Snow Family. For more information, see the User Guide.

- */ -export class Snowball extends SnowballClient { +const commands = { + CancelClusterCommand, + CancelJobCommand, + CreateAddressCommand, + CreateClusterCommand, + CreateJobCommand, + CreateLongTermPricingCommand, + CreateReturnShippingLabelCommand, + DescribeAddressCommand, + DescribeAddressesCommand, + DescribeClusterCommand, + DescribeJobCommand, + DescribeReturnShippingLabelCommand, + GetJobManifestCommand, + GetJobUnlockCodeCommand, + GetSnowballUsageCommand, + GetSoftwareUpdatesCommand, + ListClusterJobsCommand, + ListClustersCommand, + ListCompatibleImagesCommand, + ListJobsCommand, + ListLongTermPricingCommand, + ListServiceVersionsCommand, + UpdateClusterCommand, + UpdateJobCommand, + UpdateJobShipmentStateCommand, + UpdateLongTermPricingCommand, +}; + +export interface Snowball { /** - * @public - *

Cancels a cluster job. You can only cancel a cluster job while it's in the - * AwaitingQuorum status. You'll have at least an hour after creating a cluster - * job to cancel it.

+ * @see {@link CancelClusterCommand} */ - public cancelCluster( - args: CancelClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public cancelCluster( - args: CancelClusterCommandInput, - cb: (err: any, data?: CancelClusterCommandOutput) => void - ): void; - public cancelCluster( + cancelCluster(args: CancelClusterCommandInput, options?: __HttpHandlerOptions): Promise; + cancelCluster(args: CancelClusterCommandInput, cb: (err: any, data?: CancelClusterCommandOutput) => void): void; + cancelCluster( args: CancelClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelClusterCommandOutput) => void ): void; - public cancelCluster( - args: CancelClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelClusterCommandOutput) => void), - cb?: (err: any, data?: CancelClusterCommandOutput) => void - ): Promise | void { - const command = new CancelClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Cancels the specified job. You can only cancel a job before its JobState - * value changes to PreparingAppliance. Requesting the ListJobs or - * DescribeJob action returns a job's JobState as part of the - * response element data returned.

+ * @see {@link CancelJobCommand} */ - public cancelJob(args: CancelJobCommandInput, options?: __HttpHandlerOptions): Promise; - public cancelJob(args: CancelJobCommandInput, cb: (err: any, data?: CancelJobCommandOutput) => void): void; - public cancelJob( + cancelJob(args: CancelJobCommandInput, options?: __HttpHandlerOptions): Promise; + cancelJob(args: CancelJobCommandInput, cb: (err: any, data?: CancelJobCommandOutput) => void): void; + cancelJob( args: CancelJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelJobCommandOutput) => void ): void; - public cancelJob( - args: CancelJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelJobCommandOutput) => void), - cb?: (err: any, data?: CancelJobCommandOutput) => void - ): Promise | void { - const command = new CancelJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an address for a Snow device to be shipped to. In most regions, - * addresses are validated at the time of creation. The address you provide must be located - * within the serviceable area of your region. If the address is invalid or unsupported, then an - * exception is thrown.

+ * @see {@link CreateAddressCommand} */ - public createAddress( - args: CreateAddressCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createAddress( - args: CreateAddressCommandInput, - cb: (err: any, data?: CreateAddressCommandOutput) => void - ): void; - public createAddress( + createAddress(args: CreateAddressCommandInput, options?: __HttpHandlerOptions): Promise; + createAddress(args: CreateAddressCommandInput, cb: (err: any, data?: CreateAddressCommandOutput) => void): void; + createAddress( args: CreateAddressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAddressCommandOutput) => void ): void; - public createAddress( - args: CreateAddressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAddressCommandOutput) => void), - cb?: (err: any, data?: CreateAddressCommandOutput) => void - ): Promise | void { - const command = new CreateAddressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The - * cluster does not ship until these five node jobs have been created.

+ * @see {@link CreateClusterCommand} */ - public createCluster( - args: CreateClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createCluster( - args: CreateClusterCommandInput, - cb: (err: any, data?: CreateClusterCommandOutput) => void - ): void; - public createCluster( + createCluster(args: CreateClusterCommandInput, options?: __HttpHandlerOptions): Promise; + createCluster(args: CreateClusterCommandInput, cb: (err: any, data?: CreateClusterCommandOutput) => void): void; + createCluster( args: CreateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterCommandOutput) => void ): void; - public createCluster( - args: CreateClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateClusterCommandOutput) => void), - cb?: (err: any, data?: CreateClusterCommandOutput) => void - ): Promise | void { - const command = new CreateClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a job to import or export data between Amazon S3 and your on-premises data - * center. Your Amazon Web Services account must have the right trust policies and permissions in - * place to create a job for a Snow device. If you're creating a job for a node in a cluster, you - * only need to provide the clusterId value; the other job attributes are inherited - * from the cluster.

- * - *

Only the Snowball; Edge device type is supported when ordering clustered jobs.

- *

The device capacity is optional.

- *

Availability of device types differ by Amazon Web Services Region. For more information - * about Region availability, see Amazon Web Services Regional Services.

- *
- *

- *

- * Snow Family devices and their capacities. - *

- *
    - *
  • - *

    Snow Family device type: SNC1_SSD - *

    - *
      - *
    • - *

      Capacity: T14

      - *
    • - *
    • - *

      Description: Snowcone

      - *
    • - *
    - *

    - *
  • - *
  • - *

    Snow Family device type: SNC1_HDD - *

    - *
      - *
    • - *

      Capacity: T8

      - *
    • - *
    • - *

      Description: Snowcone

      - *
    • - *
    - *

    - *
  • - *
  • - *

    Device type: EDGE_S - *

    - *
      - *
    • - *

      Capacity: T98

      - *
    • - *
    • - *

      Description: Snowball Edge Storage Optimized for data transfer only

      - *
    • - *
    - *

    - *
  • - *
  • - *

    Device type: EDGE_CG - *

    - *
      - *
    • - *

      Capacity: T42

      - *
    • - *
    • - *

      Description: Snowball Edge Compute Optimized with GPU

      - *
    • - *
    - *

    - *
  • - *
  • - *

    Device type: EDGE_C - *

    - *
      - *
    • - *

      Capacity: T42

      - *
    • - *
    • - *

      Description: Snowball Edge Compute Optimized without GPU

      - *
    • - *
    - *

    - *
  • - *
  • - *

    Device type: EDGE - *

    - *
      - *
    • - *

      Capacity: T100

      - *
    • - *
    • - *

      Description: Snowball Edge Storage Optimized with EC2 Compute

      - *
    • - *
    - *

    - *
  • - *
  • - *

    Device type: STANDARD - *

    - *
      - *
    • - *

      Capacity: T50

      - *
    • - *
    • - *

      Description: Original Snowball device

      - * - *

      This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region - *

      - *
      - *
    • - *
    - *

    - *
  • - *
  • - *

    Device type: STANDARD - *

    - *
      - *
    • - *

      Capacity: T80

      - *
    • - *
    • - *

      Description: Original Snowball device

      - * - *

      This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region.

      - *
      - *
    • - *
    - *

    - *
  • - *
+ * @see {@link CreateJobCommand} */ - public createJob(args: CreateJobCommandInput, options?: __HttpHandlerOptions): Promise; - public createJob(args: CreateJobCommandInput, cb: (err: any, data?: CreateJobCommandOutput) => void): void; - public createJob( + createJob(args: CreateJobCommandInput, options?: __HttpHandlerOptions): Promise; + createJob(args: CreateJobCommandInput, cb: (err: any, data?: CreateJobCommandOutput) => void): void; + createJob( args: CreateJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateJobCommandOutput) => void ): void; - public createJob( - args: CreateJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateJobCommandOutput) => void), - cb?: (err: any, data?: CreateJobCommandOutput) => void - ): Promise | void { - const command = new CreateJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a job with the long-term usage option for a device. The long-term usage is a - * 1-year or 3-year long-term pricing type for the device. You are billed upfront, and Amazon Web Services provides discounts for long-term pricing. - *

+ * @see {@link CreateLongTermPricingCommand} */ - public createLongTermPricing( + createLongTermPricing( args: CreateLongTermPricingCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLongTermPricing( + createLongTermPricing( args: CreateLongTermPricingCommandInput, cb: (err: any, data?: CreateLongTermPricingCommandOutput) => void ): void; - public createLongTermPricing( + createLongTermPricing( args: CreateLongTermPricingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLongTermPricingCommandOutput) => void ): void; - public createLongTermPricing( - args: CreateLongTermPricingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLongTermPricingCommandOutput) => void), - cb?: (err: any, data?: CreateLongTermPricingCommandOutput) => void - ): Promise | void { - const command = new CreateLongTermPricingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a shipping label that will be used to return the Snow device to Amazon Web Services.

+ * @see {@link CreateReturnShippingLabelCommand} */ - public createReturnShippingLabel( + createReturnShippingLabel( args: CreateReturnShippingLabelCommandInput, options?: __HttpHandlerOptions ): Promise; - public createReturnShippingLabel( + createReturnShippingLabel( args: CreateReturnShippingLabelCommandInput, cb: (err: any, data?: CreateReturnShippingLabelCommandOutput) => void ): void; - public createReturnShippingLabel( + createReturnShippingLabel( args: CreateReturnShippingLabelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReturnShippingLabelCommandOutput) => void ): void; - public createReturnShippingLabel( - args: CreateReturnShippingLabelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateReturnShippingLabelCommandOutput) => void), - cb?: (err: any, data?: CreateReturnShippingLabelCommandOutput) => void - ): Promise | void { - const command = new CreateReturnShippingLabelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Takes an AddressId and returns specific details about that address in the - * form of an Address object.

+ * @see {@link DescribeAddressCommand} */ - public describeAddress( + describeAddress( args: DescribeAddressCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAddress( - args: DescribeAddressCommandInput, - cb: (err: any, data?: DescribeAddressCommandOutput) => void - ): void; - public describeAddress( + describeAddress(args: DescribeAddressCommandInput, cb: (err: any, data?: DescribeAddressCommandOutput) => void): void; + describeAddress( args: DescribeAddressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAddressCommandOutput) => void ): void; - public describeAddress( - args: DescribeAddressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAddressCommandOutput) => void), - cb?: (err: any, data?: DescribeAddressCommandOutput) => void - ): Promise | void { - const command = new DescribeAddressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a specified number of ADDRESS objects. Calling this API in one of - * the US regions will return addresses from the list of all addresses associated with this - * account in all US regions.

+ * @see {@link DescribeAddressesCommand} */ - public describeAddresses( + describeAddresses( args: DescribeAddressesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAddresses( + describeAddresses( args: DescribeAddressesCommandInput, cb: (err: any, data?: DescribeAddressesCommandOutput) => void ): void; - public describeAddresses( + describeAddresses( args: DescribeAddressesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAddressesCommandOutput) => void ): void; - public describeAddresses( - args: DescribeAddressesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAddressesCommandOutput) => void), - cb?: (err: any, data?: DescribeAddressesCommandOutput) => void - ): Promise | void { - const command = new DescribeAddressesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a specific cluster including shipping information, cluster - * status, and other important metadata.

+ * @see {@link DescribeClusterCommand} */ - public describeCluster( + describeCluster( args: DescribeClusterCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCluster( - args: DescribeClusterCommandInput, - cb: (err: any, data?: DescribeClusterCommandOutput) => void - ): void; - public describeCluster( + describeCluster(args: DescribeClusterCommandInput, cb: (err: any, data?: DescribeClusterCommandOutput) => void): void; + describeCluster( args: DescribeClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClusterCommandOutput) => void ): void; - public describeCluster( - args: DescribeClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClusterCommandOutput) => void), - cb?: (err: any, data?: DescribeClusterCommandOutput) => void - ): Promise | void { - const command = new DescribeClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about a specific job including shipping information, job status, - * and other important metadata.

+ * @see {@link DescribeJobCommand} */ - public describeJob(args: DescribeJobCommandInput, options?: __HttpHandlerOptions): Promise; - public describeJob(args: DescribeJobCommandInput, cb: (err: any, data?: DescribeJobCommandOutput) => void): void; - public describeJob( + describeJob(args: DescribeJobCommandInput, options?: __HttpHandlerOptions): Promise; + describeJob(args: DescribeJobCommandInput, cb: (err: any, data?: DescribeJobCommandOutput) => void): void; + describeJob( args: DescribeJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobCommandOutput) => void ): void; - public describeJob( - args: DescribeJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeJobCommandOutput) => void), - cb?: (err: any, data?: DescribeJobCommandOutput) => void - ): Promise | void { - const command = new DescribeJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Information on the shipping label of a Snow device that is being returned to Amazon Web Services.

+ * @see {@link DescribeReturnShippingLabelCommand} */ - public describeReturnShippingLabel( + describeReturnShippingLabel( args: DescribeReturnShippingLabelCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeReturnShippingLabel( + describeReturnShippingLabel( args: DescribeReturnShippingLabelCommandInput, cb: (err: any, data?: DescribeReturnShippingLabelCommandOutput) => void ): void; - public describeReturnShippingLabel( + describeReturnShippingLabel( args: DescribeReturnShippingLabelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReturnShippingLabelCommandOutput) => void ): void; - public describeReturnShippingLabel( - args: DescribeReturnShippingLabelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeReturnShippingLabelCommandOutput) => void), - cb?: (err: any, data?: DescribeReturnShippingLabelCommandOutput) => void - ): Promise | void { - const command = new DescribeReturnShippingLabelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a link to an Amazon S3 presigned URL for the manifest file associated with the - * specified JobId value. You can access the manifest file for up to 60 minutes - * after this request has been made. To access the manifest file after 60 minutes have passed, - * you'll have to make another call to the GetJobManifest action.

- *

The manifest is an encrypted file that you can download after your job enters the - * WithCustomer status. This is the only valid status for calling this API as the - * manifest and UnlockCode code value are used for securing your device and should - * only be used when you have the device. The manifest is decrypted by using the - * UnlockCode code value, when you pass both values to the Snow device through the - * Snowball client when the client is started for the first time.

- *

As a best practice, we recommend that you don't save a copy of an - * UnlockCode value in the same location as the manifest file for that job. Saving - * these separately helps prevent unauthorized parties from gaining access to the Snow device - * associated with that job.

- *

The credentials of a given job, including its manifest file and unlock code, expire 360 - * days after the job is created.

+ * @see {@link GetJobManifestCommand} */ - public getJobManifest( + getJobManifest( args: GetJobManifestCommandInput, options?: __HttpHandlerOptions ): Promise; - public getJobManifest( - args: GetJobManifestCommandInput, - cb: (err: any, data?: GetJobManifestCommandOutput) => void - ): void; - public getJobManifest( + getJobManifest(args: GetJobManifestCommandInput, cb: (err: any, data?: GetJobManifestCommandOutput) => void): void; + getJobManifest( args: GetJobManifestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobManifestCommandOutput) => void ): void; - public getJobManifest( - args: GetJobManifestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetJobManifestCommandOutput) => void), - cb?: (err: any, data?: GetJobManifestCommandOutput) => void - ): Promise | void { - const command = new GetJobManifestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the UnlockCode code value for the specified job. A particular - * UnlockCode value can be accessed for up to 360 days after the associated job - * has been created.

- *

The UnlockCode value is a 29-character code with 25 alphanumeric - * characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed - * along with the manifest to the Snow device through the Snowball client when the client is - * started for the first time. The only valid status for calling this API is - * WithCustomer as the manifest and Unlock code values are used for - * securing your device and should only be used when you have the device.

- *

As a best practice, we recommend that you don't save a copy of the - * UnlockCode in the same location as the manifest file for that job. Saving these - * separately helps prevent unauthorized parties from gaining access to the Snow device - * associated with that job.

+ * @see {@link GetJobUnlockCodeCommand} */ - public getJobUnlockCode( + getJobUnlockCode( args: GetJobUnlockCodeCommandInput, options?: __HttpHandlerOptions ): Promise; - public getJobUnlockCode( + getJobUnlockCode( args: GetJobUnlockCodeCommandInput, cb: (err: any, data?: GetJobUnlockCodeCommandOutput) => void ): void; - public getJobUnlockCode( + getJobUnlockCode( args: GetJobUnlockCodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobUnlockCodeCommandOutput) => void ): void; - public getJobUnlockCode( - args: GetJobUnlockCodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetJobUnlockCodeCommandOutput) => void), - cb?: (err: any, data?: GetJobUnlockCodeCommandOutput) => void - ): Promise | void { - const command = new GetJobUnlockCodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the Snow Family service limit for your account, and also the - * number of Snow devices your account has in use.

- *

The default service limit for the number of Snow devices that you can have at one time - * is 1. If you want to increase your service limit, contact Amazon Web Services Support.

+ * @see {@link GetSnowballUsageCommand} */ - public getSnowballUsage( + getSnowballUsage( args: GetSnowballUsageCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSnowballUsage( + getSnowballUsage( args: GetSnowballUsageCommandInput, cb: (err: any, data?: GetSnowballUsageCommandOutput) => void ): void; - public getSnowballUsage( + getSnowballUsage( args: GetSnowballUsageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSnowballUsageCommandOutput) => void ): void; - public getSnowballUsage( - args: GetSnowballUsageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSnowballUsageCommandOutput) => void), - cb?: (err: any, data?: GetSnowballUsageCommandOutput) => void - ): Promise | void { - const command = new GetSnowballUsageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an Amazon S3 presigned URL for an update file associated with a specified - * JobId.

+ * @see {@link GetSoftwareUpdatesCommand} */ - public getSoftwareUpdates( + getSoftwareUpdates( args: GetSoftwareUpdatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSoftwareUpdates( + getSoftwareUpdates( args: GetSoftwareUpdatesCommandInput, cb: (err: any, data?: GetSoftwareUpdatesCommandOutput) => void ): void; - public getSoftwareUpdates( + getSoftwareUpdates( args: GetSoftwareUpdatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSoftwareUpdatesCommandOutput) => void ): void; - public getSoftwareUpdates( - args: GetSoftwareUpdatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSoftwareUpdatesCommandOutput) => void), - cb?: (err: any, data?: GetSoftwareUpdatesCommandOutput) => void - ): Promise | void { - const command = new GetSoftwareUpdatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of JobListEntry objects of the specified length. Each - * JobListEntry object is for a job in the specified cluster and contains a job's - * state, a job's ID, and other information.

+ * @see {@link ListClusterJobsCommand} */ - public listClusterJobs( + listClusterJobs( args: ListClusterJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listClusterJobs( - args: ListClusterJobsCommandInput, - cb: (err: any, data?: ListClusterJobsCommandOutput) => void - ): void; - public listClusterJobs( + listClusterJobs(args: ListClusterJobsCommandInput, cb: (err: any, data?: ListClusterJobsCommandOutput) => void): void; + listClusterJobs( args: ListClusterJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListClusterJobsCommandOutput) => void ): void; - public listClusterJobs( - args: ListClusterJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListClusterJobsCommandOutput) => void), - cb?: (err: any, data?: ListClusterJobsCommandOutput) => void - ): Promise | void { - const command = new ListClusterJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of ClusterListEntry objects of the specified length. Each - * ClusterListEntry object contains a cluster's state, a cluster's ID, and other - * important status information.

+ * @see {@link ListClustersCommand} */ - public listClusters( - args: ListClustersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listClusters(args: ListClustersCommandInput, cb: (err: any, data?: ListClustersCommandOutput) => void): void; - public listClusters( + listClusters(args: ListClustersCommandInput, options?: __HttpHandlerOptions): Promise; + listClusters(args: ListClustersCommandInput, cb: (err: any, data?: ListClustersCommandOutput) => void): void; + listClusters( args: ListClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListClustersCommandOutput) => void ): void; - public listClusters( - args: ListClustersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListClustersCommandOutput) => void), - cb?: (err: any, data?: ListClustersCommandOutput) => void - ): Promise | void { - const command = new ListClustersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) - * that are owned by your Amazon Web Services accountthat would be supported for use on a Snow - * device. Currently, supported AMIs are based on the CentOS 7 (x86_64) - with Updates HVM, - * Ubuntu Server 14.04 LTS (HVM), and Ubuntu 16.04 LTS - Xenial (HVM) images, available on the - * Amazon Web Services Marketplace.

+ * @see {@link ListCompatibleImagesCommand} */ - public listCompatibleImages( + listCompatibleImages( args: ListCompatibleImagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCompatibleImages( + listCompatibleImages( args: ListCompatibleImagesCommandInput, cb: (err: any, data?: ListCompatibleImagesCommandOutput) => void ): void; - public listCompatibleImages( + listCompatibleImages( args: ListCompatibleImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCompatibleImagesCommandOutput) => void ): void; - public listCompatibleImages( - args: ListCompatibleImagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCompatibleImagesCommandOutput) => void), - cb?: (err: any, data?: ListCompatibleImagesCommandOutput) => void - ): Promise | void { - const command = new ListCompatibleImagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns an array of JobListEntry objects of the specified length. Each - * JobListEntry object contains a job's state, a job's ID, and a value that - * indicates whether the job is a job part, in the case of export jobs. Calling this API action - * in one of the US regions will return jobs from the list of all jobs associated with this - * account in all US regions.

+ * @see {@link ListJobsCommand} */ - public listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise; - public listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void; - public listJobs( + listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise; + listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void; + listJobs( args: ListJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobsCommandOutput) => void ): void; - public listJobs( - args: ListJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListJobsCommandOutput) => void), - cb?: (err: any, data?: ListJobsCommandOutput) => void - ): Promise | void { - const command = new ListJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all long-term pricing types.

+ * @see {@link ListLongTermPricingCommand} */ - public listLongTermPricing( + listLongTermPricing( args: ListLongTermPricingCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLongTermPricing( + listLongTermPricing( args: ListLongTermPricingCommandInput, cb: (err: any, data?: ListLongTermPricingCommandOutput) => void ): void; - public listLongTermPricing( + listLongTermPricing( args: ListLongTermPricingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLongTermPricingCommandOutput) => void ): void; - public listLongTermPricing( - args: ListLongTermPricingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLongTermPricingCommandOutput) => void), - cb?: (err: any, data?: ListLongTermPricingCommandOutput) => void - ): Promise | void { - const command = new ListLongTermPricingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all supported versions for Snow on-device services. Returns an - * array of ServiceVersion object containing the supported versions for a particular service.

+ * @see {@link ListServiceVersionsCommand} */ - public listServiceVersions( + listServiceVersions( args: ListServiceVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listServiceVersions( + listServiceVersions( args: ListServiceVersionsCommandInput, cb: (err: any, data?: ListServiceVersionsCommandOutput) => void ): void; - public listServiceVersions( + listServiceVersions( args: ListServiceVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceVersionsCommandOutput) => void ): void; - public listServiceVersions( - args: ListServiceVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServiceVersionsCommandOutput) => void), - cb?: (err: any, data?: ListServiceVersionsCommandOutput) => void - ): Promise | void { - const command = new ListServiceVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

While a cluster's ClusterState value is in the AwaitingQuorum - * state, you can update some of the information associated with a cluster. Once the cluster - * changes to a different job state, usually 60 minutes after the cluster being created, this - * action is no longer available.

+ * @see {@link UpdateClusterCommand} */ - public updateCluster( - args: UpdateClusterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateCluster( - args: UpdateClusterCommandInput, - cb: (err: any, data?: UpdateClusterCommandOutput) => void - ): void; - public updateCluster( + updateCluster(args: UpdateClusterCommandInput, options?: __HttpHandlerOptions): Promise; + updateCluster(args: UpdateClusterCommandInput, cb: (err: any, data?: UpdateClusterCommandOutput) => void): void; + updateCluster( args: UpdateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateClusterCommandOutput) => void ): void; - public updateCluster( - args: UpdateClusterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateClusterCommandOutput) => void), - cb?: (err: any, data?: UpdateClusterCommandOutput) => void - ): Promise | void { - const command = new UpdateClusterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

While a job's JobState value is New, you can update some of - * the information associated with a job. Once the job changes to a different job state, usually - * within 60 minutes of the job being created, this action is no longer available.

+ * @see {@link UpdateJobCommand} */ - public updateJob(args: UpdateJobCommandInput, options?: __HttpHandlerOptions): Promise; - public updateJob(args: UpdateJobCommandInput, cb: (err: any, data?: UpdateJobCommandOutput) => void): void; - public updateJob( + updateJob(args: UpdateJobCommandInput, options?: __HttpHandlerOptions): Promise; + updateJob(args: UpdateJobCommandInput, cb: (err: any, data?: UpdateJobCommandOutput) => void): void; + updateJob( args: UpdateJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateJobCommandOutput) => void ): void; - public updateJob( - args: UpdateJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateJobCommandOutput) => void), - cb?: (err: any, data?: UpdateJobCommandOutput) => void - ): Promise | void { - const command = new UpdateJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the state when a shipment state changes to a different state.

+ * @see {@link UpdateJobShipmentStateCommand} */ - public updateJobShipmentState( + updateJobShipmentState( args: UpdateJobShipmentStateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateJobShipmentState( + updateJobShipmentState( args: UpdateJobShipmentStateCommandInput, cb: (err: any, data?: UpdateJobShipmentStateCommandOutput) => void ): void; - public updateJobShipmentState( + updateJobShipmentState( args: UpdateJobShipmentStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateJobShipmentStateCommandOutput) => void ): void; - public updateJobShipmentState( - args: UpdateJobShipmentStateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateJobShipmentStateCommandOutput) => void), - cb?: (err: any, data?: UpdateJobShipmentStateCommandOutput) => void - ): Promise | void { - const command = new UpdateJobShipmentStateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the long-term pricing type.

+ * @see {@link UpdateLongTermPricingCommand} */ - public updateLongTermPricing( + updateLongTermPricing( args: UpdateLongTermPricingCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLongTermPricing( + updateLongTermPricing( args: UpdateLongTermPricingCommandInput, cb: (err: any, data?: UpdateLongTermPricingCommandOutput) => void ): void; - public updateLongTermPricing( + updateLongTermPricing( args: UpdateLongTermPricingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLongTermPricingCommandOutput) => void ): void; - public updateLongTermPricing( - args: UpdateLongTermPricingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLongTermPricingCommandOutput) => void), - cb?: (err: any, data?: UpdateLongTermPricingCommandOutput) => void - ): Promise | void { - const command = new UpdateLongTermPricingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The Amazon Web Services Snow Family provides a petabyte-scale data transport solution that uses + * secure devices to transfer large amounts of data between your on-premises data centers and + * Amazon Simple Storage Service (Amazon S3). The Snow Family commands described here provide access to the same + * functionality that is available in the Amazon Web Services Snow Family Management Console, which enables you to create + * and manage jobs for a Snow Family device. To transfer data locally with a Snow Family device, + * you'll need to use the Snowball Edge client or the Amazon S3 API Interface for Snowball or OpsHub for Snow Family. For more information, see the User Guide.

+ */ +export class Snowball extends SnowballClient implements Snowball {} +createAggregatedClient(commands, Snowball); diff --git a/clients/client-sns/src/SNS.ts b/clients/client-sns/src/SNS.ts index e077cb7c3f57..37d789d7d19c 100644 --- a/clients/client-sns/src/SNS.ts +++ b/clients/client-sns/src/SNS.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -183,1646 +184,721 @@ import { VerifySMSSandboxPhoneNumberCommandInput, VerifySMSSandboxPhoneNumberCommandOutput, } from "./commands/VerifySMSSandboxPhoneNumberCommand"; -import { SNSClient } from "./SNSClient"; +import { SNSClient, SNSClientConfig } from "./SNSClient"; -/** - * @public - * Amazon Simple Notification Service - *

Amazon Simple Notification Service (Amazon SNS) is a web service that enables you - * to build distributed web-enabled applications. Applications can use Amazon SNS to easily push - * real-time notification messages to interested subscribers over multiple delivery - * protocols. For more information about this product see the Amazon SNS product page. For detailed information about Amazon SNS features - * and their associated API calls, see the Amazon SNS Developer Guide.

- *

For information on the permissions you need to use this API, see Identity and access management in Amazon SNS in the Amazon SNS Developer - * Guide. - *

- *

We also provide SDKs that enable you to access Amazon SNS from your preferred programming - * language. The SDKs contain functionality that automatically takes care of tasks such as: - * cryptographically signing your service requests, retrying requests, and handling error - * responses. For a list of available SDKs, go to Tools for Amazon Web Services.

- */ -export class SNS extends SNSClient { +const commands = { + AddPermissionCommand, + CheckIfPhoneNumberIsOptedOutCommand, + ConfirmSubscriptionCommand, + CreatePlatformApplicationCommand, + CreatePlatformEndpointCommand, + CreateSMSSandboxPhoneNumberCommand, + CreateTopicCommand, + DeleteEndpointCommand, + DeletePlatformApplicationCommand, + DeleteSMSSandboxPhoneNumberCommand, + DeleteTopicCommand, + GetDataProtectionPolicyCommand, + GetEndpointAttributesCommand, + GetPlatformApplicationAttributesCommand, + GetSMSAttributesCommand, + GetSMSSandboxAccountStatusCommand, + GetSubscriptionAttributesCommand, + GetTopicAttributesCommand, + ListEndpointsByPlatformApplicationCommand, + ListOriginationNumbersCommand, + ListPhoneNumbersOptedOutCommand, + ListPlatformApplicationsCommand, + ListSMSSandboxPhoneNumbersCommand, + ListSubscriptionsCommand, + ListSubscriptionsByTopicCommand, + ListTagsForResourceCommand, + ListTopicsCommand, + OptInPhoneNumberCommand, + PublishCommand, + PublishBatchCommand, + PutDataProtectionPolicyCommand, + RemovePermissionCommand, + SetEndpointAttributesCommand, + SetPlatformApplicationAttributesCommand, + SetSMSAttributesCommand, + SetSubscriptionAttributesCommand, + SetTopicAttributesCommand, + SubscribeCommand, + TagResourceCommand, + UnsubscribeCommand, + UntagResourceCommand, + VerifySMSSandboxPhoneNumberCommand, +}; + +export interface SNS { /** - * @public - *

Adds a statement to a topic's access control policy, granting access for the specified - * Amazon Web Services accounts to the specified actions.

- * - *

To remove the ability to change topic permissions, you must deny permissions to - * the AddPermission, RemovePermission, and - * SetTopicAttributes actions in your IAM policy.

- *
+ * @see {@link AddPermissionCommand} */ - public addPermission( - args: AddPermissionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public addPermission( - args: AddPermissionCommandInput, - cb: (err: any, data?: AddPermissionCommandOutput) => void - ): void; - public addPermission( + addPermission(args: AddPermissionCommandInput, options?: __HttpHandlerOptions): Promise; + addPermission(args: AddPermissionCommandInput, cb: (err: any, data?: AddPermissionCommandOutput) => void): void; + addPermission( args: AddPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddPermissionCommandOutput) => void ): void; - public addPermission( - args: AddPermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddPermissionCommandOutput) => void), - cb?: (err: any, data?: AddPermissionCommandOutput) => void - ): Promise | void { - const command = new AddPermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Accepts a phone number and indicates whether the phone holder has opted out of - * receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number - * that is opted out.

- *

To resume sending messages, you can opt in the number by using the - * OptInPhoneNumber action.

+ * @see {@link CheckIfPhoneNumberIsOptedOutCommand} */ - public checkIfPhoneNumberIsOptedOut( + checkIfPhoneNumberIsOptedOut( args: CheckIfPhoneNumberIsOptedOutCommandInput, options?: __HttpHandlerOptions ): Promise; - public checkIfPhoneNumberIsOptedOut( + checkIfPhoneNumberIsOptedOut( args: CheckIfPhoneNumberIsOptedOutCommandInput, cb: (err: any, data?: CheckIfPhoneNumberIsOptedOutCommandOutput) => void ): void; - public checkIfPhoneNumberIsOptedOut( + checkIfPhoneNumberIsOptedOut( args: CheckIfPhoneNumberIsOptedOutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CheckIfPhoneNumberIsOptedOutCommandOutput) => void ): void; - public checkIfPhoneNumberIsOptedOut( - args: CheckIfPhoneNumberIsOptedOutCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CheckIfPhoneNumberIsOptedOutCommandOutput) => void), - cb?: (err: any, data?: CheckIfPhoneNumberIsOptedOutCommandOutput) => void - ): Promise | void { - const command = new CheckIfPhoneNumberIsOptedOutCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Verifies an endpoint owner's intent to receive messages by validating the token sent - * to the endpoint by an earlier Subscribe action. If the token is valid, the - * action creates a new subscription and returns its Amazon Resource Name (ARN). This call - * requires an AWS signature only when the AuthenticateOnUnsubscribe flag is - * set to "true".

+ * @see {@link ConfirmSubscriptionCommand} */ - public confirmSubscription( + confirmSubscription( args: ConfirmSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public confirmSubscription( + confirmSubscription( args: ConfirmSubscriptionCommandInput, cb: (err: any, data?: ConfirmSubscriptionCommandOutput) => void ): void; - public confirmSubscription( + confirmSubscription( args: ConfirmSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfirmSubscriptionCommandOutput) => void ): void; - public confirmSubscription( - args: ConfirmSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConfirmSubscriptionCommandOutput) => void), - cb?: (err: any, data?: ConfirmSubscriptionCommandOutput) => void - ): Promise | void { - const command = new ConfirmSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a platform application object for one of the supported push notification - * services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile - * apps may register. You must specify PlatformPrincipal and - * PlatformCredential attributes when using the - * CreatePlatformApplication action.

- *

- * PlatformPrincipal and PlatformCredential are received from - * the notification service.

- *
    - *
  • - *

    For ADM, PlatformPrincipal is client id - * and PlatformCredential is client secret.

    - *
  • - *
  • - *

    For Baidu, PlatformPrincipal is API key - * and PlatformCredential is secret key.

    - *
  • - *
  • - *

    For APNS and APNS_SANDBOX using certificate - * credentials, PlatformPrincipal is SSL certificate and - * PlatformCredential is private key.

    - *
  • - *
  • - *

    For APNS and APNS_SANDBOX using token credentials, - * PlatformPrincipal is signing key ID and - * PlatformCredential is signing key.

    - *
  • - *
  • - *

    For GCM (Firebase Cloud Messaging), there is no - * PlatformPrincipal and the PlatformCredential is - * API key.

    - *
  • - *
  • - *

    For MPNS, PlatformPrincipal is TLS - * certificate and PlatformCredential is private - * key.

    - *
  • - *
  • - *

    For WNS, PlatformPrincipal is Package Security - * Identifier and PlatformCredential is secret - * key.

    - *
  • - *
- *

You can use the returned PlatformApplicationArn as an attribute for the - * CreatePlatformEndpoint action.

+ * @see {@link CreatePlatformApplicationCommand} */ - public createPlatformApplication( + createPlatformApplication( args: CreatePlatformApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPlatformApplication( + createPlatformApplication( args: CreatePlatformApplicationCommandInput, cb: (err: any, data?: CreatePlatformApplicationCommandOutput) => void ): void; - public createPlatformApplication( + createPlatformApplication( args: CreatePlatformApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePlatformApplicationCommandOutput) => void ): void; - public createPlatformApplication( - args: CreatePlatformApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePlatformApplicationCommandOutput) => void), - cb?: (err: any, data?: CreatePlatformApplicationCommandOutput) => void - ): Promise | void { - const command = new CreatePlatformApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an endpoint for a device and mobile app on one of the supported push - * notification services, such as GCM (Firebase Cloud Messaging) and APNS. - * CreatePlatformEndpoint requires the PlatformApplicationArn - * that is returned from CreatePlatformApplication. You can use the returned - * EndpointArn to send a message to a mobile app or by the - * Subscribe action for subscription to a topic. The - * CreatePlatformEndpoint action is idempotent, so if the requester - * already owns an endpoint with the same device token and attributes, that endpoint's ARN - * is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push - * Notifications.

- *

When using CreatePlatformEndpoint with Baidu, two attributes must be - * provided: ChannelId and UserId. The token field must also contain the ChannelId. For - * more information, see Creating an Amazon SNS Endpoint for - * Baidu.

+ * @see {@link CreatePlatformEndpointCommand} */ - public createPlatformEndpoint( + createPlatformEndpoint( args: CreatePlatformEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPlatformEndpoint( + createPlatformEndpoint( args: CreatePlatformEndpointCommandInput, cb: (err: any, data?: CreatePlatformEndpointCommandOutput) => void ): void; - public createPlatformEndpoint( + createPlatformEndpoint( args: CreatePlatformEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePlatformEndpointCommandOutput) => void ): void; - public createPlatformEndpoint( - args: CreatePlatformEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePlatformEndpointCommandOutput) => void), - cb?: (err: any, data?: CreatePlatformEndpointCommandOutput) => void - ): Promise | void { - const command = new CreatePlatformEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a - * one-time password (OTP) to that phone number.

- *

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the - * SMS sandbox. The SMS sandbox provides a safe environment for - * you to try Amazon SNS features without risking your reputation as an SMS sender. While your - * Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send - * SMS messages only to verified destination phone numbers. For more information, including how to - * move out of the sandbox to send messages without restrictions, - * see SMS sandbox in - * the Amazon SNS Developer Guide.

+ * @see {@link CreateSMSSandboxPhoneNumberCommand} */ - public createSMSSandboxPhoneNumber( + createSMSSandboxPhoneNumber( args: CreateSMSSandboxPhoneNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSMSSandboxPhoneNumber( + createSMSSandboxPhoneNumber( args: CreateSMSSandboxPhoneNumberCommandInput, cb: (err: any, data?: CreateSMSSandboxPhoneNumberCommandOutput) => void ): void; - public createSMSSandboxPhoneNumber( + createSMSSandboxPhoneNumber( args: CreateSMSSandboxPhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSMSSandboxPhoneNumberCommandOutput) => void ): void; - public createSMSSandboxPhoneNumber( - args: CreateSMSSandboxPhoneNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSMSSandboxPhoneNumberCommandOutput) => void), - cb?: (err: any, data?: CreateSMSSandboxPhoneNumberCommandOutput) => void - ): Promise | void { - const command = new CreateSMSSandboxPhoneNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a topic to which notifications can be published. Users can create at most - * 100,000 standard topics (at most 1,000 FIFO topics). For more information, see Creating an Amazon SNS - * topic in the Amazon SNS Developer Guide. This action is - * idempotent, so if the requester already owns a topic with the specified name, that - * topic's ARN is returned without creating a new topic.

+ * @see {@link CreateTopicCommand} */ - public createTopic(args: CreateTopicCommandInput, options?: __HttpHandlerOptions): Promise; - public createTopic(args: CreateTopicCommandInput, cb: (err: any, data?: CreateTopicCommandOutput) => void): void; - public createTopic( + createTopic(args: CreateTopicCommandInput, options?: __HttpHandlerOptions): Promise; + createTopic(args: CreateTopicCommandInput, cb: (err: any, data?: CreateTopicCommandOutput) => void): void; + createTopic( args: CreateTopicCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTopicCommandOutput) => void ): void; - public createTopic( - args: CreateTopicCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTopicCommandOutput) => void), - cb?: (err: any, data?: CreateTopicCommandOutput) => void - ): Promise | void { - const command = new CreateTopicCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the endpoint for a device and mobile app from Amazon SNS. This action is - * idempotent. For more information, see Using Amazon SNS Mobile Push - * Notifications.

- *

When you delete an endpoint that is also subscribed to a topic, then you must also - * unsubscribe the endpoint from the topic.

+ * @see {@link DeleteEndpointCommand} */ - public deleteEndpoint( + deleteEndpoint( args: DeleteEndpointCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEndpoint( - args: DeleteEndpointCommandInput, - cb: (err: any, data?: DeleteEndpointCommandOutput) => void - ): void; - public deleteEndpoint( + deleteEndpoint(args: DeleteEndpointCommandInput, cb: (err: any, data?: DeleteEndpointCommandOutput) => void): void; + deleteEndpoint( args: DeleteEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEndpointCommandOutput) => void ): void; - public deleteEndpoint( - args: DeleteEndpointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEndpointCommandOutput) => void), - cb?: (err: any, data?: DeleteEndpointCommandOutput) => void - ): Promise | void { - const command = new DeleteEndpointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a platform application object for one of the supported push notification - * services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see - * Using Amazon SNS - * Mobile Push Notifications.

+ * @see {@link DeletePlatformApplicationCommand} */ - public deletePlatformApplication( + deletePlatformApplication( args: DeletePlatformApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePlatformApplication( + deletePlatformApplication( args: DeletePlatformApplicationCommandInput, cb: (err: any, data?: DeletePlatformApplicationCommandOutput) => void ): void; - public deletePlatformApplication( + deletePlatformApplication( args: DeletePlatformApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePlatformApplicationCommandOutput) => void ): void; - public deletePlatformApplication( - args: DeletePlatformApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePlatformApplicationCommandOutput) => void), - cb?: (err: any, data?: DeletePlatformApplicationCommandOutput) => void - ): Promise | void { - const command = new DeletePlatformApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an Amazon Web Services account's verified or pending phone number from the SMS - * sandbox.

- *

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the - * SMS sandbox. The SMS sandbox provides a safe environment for - * you to try Amazon SNS features without risking your reputation as an SMS sender. While your - * Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send - * SMS messages only to verified destination phone numbers. For more information, including how to - * move out of the sandbox to send messages without restrictions, - * see SMS sandbox in - * the Amazon SNS Developer Guide.

+ * @see {@link DeleteSMSSandboxPhoneNumberCommand} */ - public deleteSMSSandboxPhoneNumber( + deleteSMSSandboxPhoneNumber( args: DeleteSMSSandboxPhoneNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSMSSandboxPhoneNumber( + deleteSMSSandboxPhoneNumber( args: DeleteSMSSandboxPhoneNumberCommandInput, cb: (err: any, data?: DeleteSMSSandboxPhoneNumberCommandOutput) => void ): void; - public deleteSMSSandboxPhoneNumber( + deleteSMSSandboxPhoneNumber( args: DeleteSMSSandboxPhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSMSSandboxPhoneNumberCommandOutput) => void ): void; - public deleteSMSSandboxPhoneNumber( - args: DeleteSMSSandboxPhoneNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSMSSandboxPhoneNumberCommandOutput) => void), - cb?: (err: any, data?: DeleteSMSSandboxPhoneNumberCommandOutput) => void - ): Promise | void { - const command = new DeleteSMSSandboxPhoneNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a topic and all its subscriptions. Deleting a topic might prevent some - * messages previously sent to the topic from being delivered to subscribers. This action - * is idempotent, so deleting a topic that does not exist does not result in an - * error.

+ * @see {@link DeleteTopicCommand} */ - public deleteTopic(args: DeleteTopicCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteTopic(args: DeleteTopicCommandInput, cb: (err: any, data?: DeleteTopicCommandOutput) => void): void; - public deleteTopic( + deleteTopic(args: DeleteTopicCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTopic(args: DeleteTopicCommandInput, cb: (err: any, data?: DeleteTopicCommandOutput) => void): void; + deleteTopic( args: DeleteTopicCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTopicCommandOutput) => void ): void; - public deleteTopic( - args: DeleteTopicCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTopicCommandOutput) => void), - cb?: (err: any, data?: DeleteTopicCommandOutput) => void - ): Promise | void { - const command = new DeleteTopicCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the specified inline DataProtectionPolicy document that is - * stored in the specified Amazon SNS topic.

+ * @see {@link GetDataProtectionPolicyCommand} */ - public getDataProtectionPolicy( + getDataProtectionPolicy( args: GetDataProtectionPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDataProtectionPolicy( + getDataProtectionPolicy( args: GetDataProtectionPolicyCommandInput, cb: (err: any, data?: GetDataProtectionPolicyCommandOutput) => void ): void; - public getDataProtectionPolicy( + getDataProtectionPolicy( args: GetDataProtectionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataProtectionPolicyCommandOutput) => void ): void; - public getDataProtectionPolicy( - args: GetDataProtectionPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDataProtectionPolicyCommandOutput) => void), - cb?: (err: any, data?: GetDataProtectionPolicyCommandOutput) => void - ): Promise | void { - const command = new GetDataProtectionPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the endpoint attributes for a device on one of the supported push - * notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more - * information, see Using Amazon SNS Mobile Push Notifications.

+ * @see {@link GetEndpointAttributesCommand} */ - public getEndpointAttributes( + getEndpointAttributes( args: GetEndpointAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEndpointAttributes( + getEndpointAttributes( args: GetEndpointAttributesCommandInput, cb: (err: any, data?: GetEndpointAttributesCommandOutput) => void ): void; - public getEndpointAttributes( + getEndpointAttributes( args: GetEndpointAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEndpointAttributesCommandOutput) => void ): void; - public getEndpointAttributes( - args: GetEndpointAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEndpointAttributesCommandOutput) => void), - cb?: (err: any, data?: GetEndpointAttributesCommandOutput) => void - ): Promise | void { - const command = new GetEndpointAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the attributes of the platform application object for the supported push - * notification services, such as APNS and GCM (Firebase Cloud Messaging). For more - * information, see Using Amazon SNS Mobile Push Notifications.

+ * @see {@link GetPlatformApplicationAttributesCommand} */ - public getPlatformApplicationAttributes( + getPlatformApplicationAttributes( args: GetPlatformApplicationAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPlatformApplicationAttributes( + getPlatformApplicationAttributes( args: GetPlatformApplicationAttributesCommandInput, cb: (err: any, data?: GetPlatformApplicationAttributesCommandOutput) => void ): void; - public getPlatformApplicationAttributes( + getPlatformApplicationAttributes( args: GetPlatformApplicationAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPlatformApplicationAttributesCommandOutput) => void ): void; - public getPlatformApplicationAttributes( - args: GetPlatformApplicationAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPlatformApplicationAttributesCommandOutput) => void), - cb?: (err: any, data?: GetPlatformApplicationAttributesCommandOutput) => void - ): Promise | void { - const command = new GetPlatformApplicationAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the settings for sending SMS messages from your Amazon Web Services account.

- *

These settings are set with the SetSMSAttributes action.

+ * @see {@link GetSMSAttributesCommand} */ - public getSMSAttributes( + getSMSAttributes( args: GetSMSAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSMSAttributes( + getSMSAttributes( args: GetSMSAttributesCommandInput, cb: (err: any, data?: GetSMSAttributesCommandOutput) => void ): void; - public getSMSAttributes( + getSMSAttributes( args: GetSMSAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSMSAttributesCommandOutput) => void ): void; - public getSMSAttributes( - args: GetSMSAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSMSAttributesCommandOutput) => void), - cb?: (err: any, data?: GetSMSAttributesCommandOutput) => void - ): Promise | void { - const command = new GetSMSAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target - * Amazon Web Services Region.

- *

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the - * SMS sandbox. The SMS sandbox provides a safe environment for - * you to try Amazon SNS features without risking your reputation as an SMS sender. While your - * Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send - * SMS messages only to verified destination phone numbers. For more information, including how to - * move out of the sandbox to send messages without restrictions, - * see SMS sandbox in - * the Amazon SNS Developer Guide.

+ * @see {@link GetSMSSandboxAccountStatusCommand} */ - public getSMSSandboxAccountStatus( + getSMSSandboxAccountStatus( args: GetSMSSandboxAccountStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSMSSandboxAccountStatus( + getSMSSandboxAccountStatus( args: GetSMSSandboxAccountStatusCommandInput, cb: (err: any, data?: GetSMSSandboxAccountStatusCommandOutput) => void ): void; - public getSMSSandboxAccountStatus( + getSMSSandboxAccountStatus( args: GetSMSSandboxAccountStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSMSSandboxAccountStatusCommandOutput) => void ): void; - public getSMSSandboxAccountStatus( - args: GetSMSSandboxAccountStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSMSSandboxAccountStatusCommandOutput) => void), - cb?: (err: any, data?: GetSMSSandboxAccountStatusCommandOutput) => void - ): Promise | void { - const command = new GetSMSSandboxAccountStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns all of the properties of a subscription.

+ * @see {@link GetSubscriptionAttributesCommand} */ - public getSubscriptionAttributes( + getSubscriptionAttributes( args: GetSubscriptionAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSubscriptionAttributes( + getSubscriptionAttributes( args: GetSubscriptionAttributesCommandInput, cb: (err: any, data?: GetSubscriptionAttributesCommandOutput) => void ): void; - public getSubscriptionAttributes( + getSubscriptionAttributes( args: GetSubscriptionAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSubscriptionAttributesCommandOutput) => void ): void; - public getSubscriptionAttributes( - args: GetSubscriptionAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSubscriptionAttributesCommandOutput) => void), - cb?: (err: any, data?: GetSubscriptionAttributesCommandOutput) => void - ): Promise | void { - const command = new GetSubscriptionAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns all of the properties of a topic. Topic properties returned might differ based - * on the authorization of the user.

+ * @see {@link GetTopicAttributesCommand} */ - public getTopicAttributes( + getTopicAttributes( args: GetTopicAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTopicAttributes( + getTopicAttributes( args: GetTopicAttributesCommandInput, cb: (err: any, data?: GetTopicAttributesCommandOutput) => void ): void; - public getTopicAttributes( + getTopicAttributes( args: GetTopicAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTopicAttributesCommandOutput) => void ): void; - public getTopicAttributes( - args: GetTopicAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTopicAttributesCommandOutput) => void), - cb?: (err: any, data?: GetTopicAttributesCommandOutput) => void - ): Promise | void { - const command = new GetTopicAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the endpoints and endpoint attributes for devices in a supported push - * notification service, such as GCM (Firebase Cloud Messaging) and APNS. The results for - * ListEndpointsByPlatformApplication are paginated and return a limited - * list of endpoints, up to 100. If additional records are available after the first page - * results, then a NextToken string will be returned. To receive the next page, you call - * ListEndpointsByPlatformApplication again using the NextToken string - * received from the previous call. When there are no more records to return, NextToken - * will be null. For more information, see Using Amazon SNS Mobile Push - * Notifications.

- *

This action is throttled at 30 transactions per second (TPS).

+ * @see {@link ListEndpointsByPlatformApplicationCommand} */ - public listEndpointsByPlatformApplication( + listEndpointsByPlatformApplication( args: ListEndpointsByPlatformApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEndpointsByPlatformApplication( + listEndpointsByPlatformApplication( args: ListEndpointsByPlatformApplicationCommandInput, cb: (err: any, data?: ListEndpointsByPlatformApplicationCommandOutput) => void ): void; - public listEndpointsByPlatformApplication( + listEndpointsByPlatformApplication( args: ListEndpointsByPlatformApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEndpointsByPlatformApplicationCommandOutput) => void ): void; - public listEndpointsByPlatformApplication( - args: ListEndpointsByPlatformApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEndpointsByPlatformApplicationCommandOutput) => void), - cb?: (err: any, data?: ListEndpointsByPlatformApplicationCommandOutput) => void - ): Promise | void { - const command = new ListEndpointsByPlatformApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. - * For more information about origination numbers, see Origination numbers in the Amazon SNS Developer - * Guide.

+ * @see {@link ListOriginationNumbersCommand} */ - public listOriginationNumbers( + listOriginationNumbers( args: ListOriginationNumbersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOriginationNumbers( + listOriginationNumbers( args: ListOriginationNumbersCommandInput, cb: (err: any, data?: ListOriginationNumbersCommandOutput) => void ): void; - public listOriginationNumbers( + listOriginationNumbers( args: ListOriginationNumbersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOriginationNumbersCommandOutput) => void ): void; - public listOriginationNumbers( - args: ListOriginationNumbersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOriginationNumbersCommandOutput) => void), - cb?: (err: any, data?: ListOriginationNumbersCommandOutput) => void - ): Promise | void { - const command = new ListOriginationNumbersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of phone numbers that are opted out, meaning you cannot send SMS - * messages to them.

- *

The results for ListPhoneNumbersOptedOut are paginated, and each page - * returns up to 100 phone numbers. If additional phone numbers are available after the - * first page of results, then a NextToken string will be returned. To receive - * the next page, you call ListPhoneNumbersOptedOut again using the - * NextToken string received from the previous call. When there are no - * more records to return, NextToken will be null.

+ * @see {@link ListPhoneNumbersOptedOutCommand} */ - public listPhoneNumbersOptedOut( + listPhoneNumbersOptedOut( args: ListPhoneNumbersOptedOutCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPhoneNumbersOptedOut( + listPhoneNumbersOptedOut( args: ListPhoneNumbersOptedOutCommandInput, cb: (err: any, data?: ListPhoneNumbersOptedOutCommandOutput) => void ): void; - public listPhoneNumbersOptedOut( + listPhoneNumbersOptedOut( args: ListPhoneNumbersOptedOutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPhoneNumbersOptedOutCommandOutput) => void ): void; - public listPhoneNumbersOptedOut( - args: ListPhoneNumbersOptedOutCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPhoneNumbersOptedOutCommandOutput) => void), - cb?: (err: any, data?: ListPhoneNumbersOptedOutCommandOutput) => void - ): Promise | void { - const command = new ListPhoneNumbersOptedOutCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the platform application objects for the supported push notification services, - * such as APNS and GCM (Firebase Cloud Messaging). The results for - * ListPlatformApplications are paginated and return a limited list of - * applications, up to 100. If additional records are available after the first page - * results, then a NextToken string will be returned. To receive the next page, you call - * ListPlatformApplications using the NextToken string received from the - * previous call. When there are no more records to return, NextToken will be - * null. For more information, see Using Amazon SNS Mobile Push - * Notifications.

- *

This action is throttled at 15 transactions per second (TPS).

+ * @see {@link ListPlatformApplicationsCommand} */ - public listPlatformApplications( + listPlatformApplications( args: ListPlatformApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPlatformApplications( + listPlatformApplications( args: ListPlatformApplicationsCommandInput, cb: (err: any, data?: ListPlatformApplicationsCommandOutput) => void ): void; - public listPlatformApplications( + listPlatformApplications( args: ListPlatformApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPlatformApplicationsCommandOutput) => void ): void; - public listPlatformApplications( - args: ListPlatformApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPlatformApplicationsCommandOutput) => void), - cb?: (err: any, data?: ListPlatformApplicationsCommandOutput) => void - ): Promise | void { - const command = new ListPlatformApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the calling Amazon Web Services account's current verified and pending destination phone - * numbers in the SMS sandbox.

- *

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the - * SMS sandbox. The SMS sandbox provides a safe environment for - * you to try Amazon SNS features without risking your reputation as an SMS sender. While your - * Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send - * SMS messages only to verified destination phone numbers. For more information, including how to - * move out of the sandbox to send messages without restrictions, - * see SMS sandbox in - * the Amazon SNS Developer Guide.

+ * @see {@link ListSMSSandboxPhoneNumbersCommand} */ - public listSMSSandboxPhoneNumbers( + listSMSSandboxPhoneNumbers( args: ListSMSSandboxPhoneNumbersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSMSSandboxPhoneNumbers( + listSMSSandboxPhoneNumbers( args: ListSMSSandboxPhoneNumbersCommandInput, cb: (err: any, data?: ListSMSSandboxPhoneNumbersCommandOutput) => void ): void; - public listSMSSandboxPhoneNumbers( + listSMSSandboxPhoneNumbers( args: ListSMSSandboxPhoneNumbersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSMSSandboxPhoneNumbersCommandOutput) => void ): void; - public listSMSSandboxPhoneNumbers( - args: ListSMSSandboxPhoneNumbersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSMSSandboxPhoneNumbersCommandOutput) => void), - cb?: (err: any, data?: ListSMSSandboxPhoneNumbersCommandOutput) => void - ): Promise | void { - const command = new ListSMSSandboxPhoneNumbersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the requester's subscriptions. Each call returns a limited list of - * subscriptions, up to 100. If there are more subscriptions, a NextToken is - * also returned. Use the NextToken parameter in a new - * ListSubscriptions call to get further results.

- *

This action is throttled at 30 transactions per second (TPS).

+ * @see {@link ListSubscriptionsCommand} */ - public listSubscriptions( + listSubscriptions( args: ListSubscriptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSubscriptions( + listSubscriptions( args: ListSubscriptionsCommandInput, cb: (err: any, data?: ListSubscriptionsCommandOutput) => void ): void; - public listSubscriptions( + listSubscriptions( args: ListSubscriptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSubscriptionsCommandOutput) => void ): void; - public listSubscriptions( - args: ListSubscriptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSubscriptionsCommandOutput) => void), - cb?: (err: any, data?: ListSubscriptionsCommandOutput) => void - ): Promise | void { - const command = new ListSubscriptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the subscriptions to a specific topic. Each call returns a limited - * list of subscriptions, up to 100. If there are more subscriptions, a - * NextToken is also returned. Use the NextToken parameter in - * a new ListSubscriptionsByTopic call to get further results.

- *

This action is throttled at 30 transactions per second (TPS).

+ * @see {@link ListSubscriptionsByTopicCommand} */ - public listSubscriptionsByTopic( + listSubscriptionsByTopic( args: ListSubscriptionsByTopicCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSubscriptionsByTopic( + listSubscriptionsByTopic( args: ListSubscriptionsByTopicCommandInput, cb: (err: any, data?: ListSubscriptionsByTopicCommandOutput) => void ): void; - public listSubscriptionsByTopic( + listSubscriptionsByTopic( args: ListSubscriptionsByTopicCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSubscriptionsByTopicCommandOutput) => void ): void; - public listSubscriptionsByTopic( - args: ListSubscriptionsByTopicCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSubscriptionsByTopicCommandOutput) => void), - cb?: (err: any, data?: ListSubscriptionsByTopicCommandOutput) => void - ): Promise | void { - const command = new ListSubscriptionsByTopicCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the - * Amazon Simple Notification Service Developer Guide.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the requester's topics. Each call returns a limited list of topics, - * up to 100. If there are more topics, a NextToken is also returned. Use the - * NextToken parameter in a new ListTopics call to get - * further results.

- *

This action is throttled at 30 transactions per second (TPS).

+ * @see {@link ListTopicsCommand} */ - public listTopics(args: ListTopicsCommandInput, options?: __HttpHandlerOptions): Promise; - public listTopics(args: ListTopicsCommandInput, cb: (err: any, data?: ListTopicsCommandOutput) => void): void; - public listTopics( + listTopics(args: ListTopicsCommandInput, options?: __HttpHandlerOptions): Promise; + listTopics(args: ListTopicsCommandInput, cb: (err: any, data?: ListTopicsCommandOutput) => void): void; + listTopics( args: ListTopicsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTopicsCommandOutput) => void ): void; - public listTopics( - args: ListTopicsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTopicsCommandOutput) => void), - cb?: (err: any, data?: ListTopicsCommandOutput) => void - ): Promise | void { - const command = new ListTopicsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this request to opt in a phone number that is opted out, which enables you to - * resume sending SMS messages to the number.

- *

You can opt in a phone number only once every 30 days.

+ * @see {@link OptInPhoneNumberCommand} */ - public optInPhoneNumber( + optInPhoneNumber( args: OptInPhoneNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public optInPhoneNumber( + optInPhoneNumber( args: OptInPhoneNumberCommandInput, cb: (err: any, data?: OptInPhoneNumberCommandOutput) => void ): void; - public optInPhoneNumber( + optInPhoneNumber( args: OptInPhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: OptInPhoneNumberCommandOutput) => void ): void; - public optInPhoneNumber( - args: OptInPhoneNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: OptInPhoneNumberCommandOutput) => void), - cb?: (err: any, data?: OptInPhoneNumberCommandOutput) => void - ): Promise | void { - const command = new OptInPhoneNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone - * number, or a message to a mobile platform endpoint (when you specify the - * TargetArn).

- *

If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is - * subscribed to the topic. The format of the message depends on the notification protocol - * for each subscribed endpoint.

- *

When a messageId is returned, the message is saved and Amazon SNS immediately - * delivers it to subscribers.

- *

To use the Publish action for publishing a message to a mobile endpoint, - * such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for - * the TargetArn parameter. The EndpointArn is returned when making a call with the - * CreatePlatformEndpoint action.

- *

For more information about formatting messages, see Send Custom - * Platform-Specific Payloads in Messages to Mobile Devices.

- * - *

You can publish messages only to topics and endpoints in the same - * Amazon Web Services Region.

- *
+ * @see {@link PublishCommand} */ - public publish(args: PublishCommandInput, options?: __HttpHandlerOptions): Promise; - public publish(args: PublishCommandInput, cb: (err: any, data?: PublishCommandOutput) => void): void; - public publish( + publish(args: PublishCommandInput, options?: __HttpHandlerOptions): Promise; + publish(args: PublishCommandInput, cb: (err: any, data?: PublishCommandOutput) => void): void; + publish( args: PublishCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishCommandOutput) => void ): void; - public publish( - args: PublishCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PublishCommandOutput) => void), - cb?: (err: any, data?: PublishCommandOutput) => void - ): Promise | void { - const command = new PublishCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Publishes up to ten messages to the specified topic. This is a batch version of - * Publish. For FIFO topics, multiple messages within a single batch are - * published in the order they are sent, and messages are deduplicated within the batch and - * across batches for 5 minutes.

- *

The result of publishing each message is reported individually in the response. - * Because the batch request can result in a combination of successful and unsuccessful - * actions, you should check for batch errors even when the call returns an HTTP status - * code of 200.

- *

The maximum allowed individual message size and the maximum total payload size (the - * sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 - * bytes).

- *

Some actions take lists of parameters. These lists are specified using the - * param.n notation. Values of n are integers starting from - * 1. For example, a parameter list with two elements looks like this:

- *

&AttributeName.1=first

- *

&AttributeName.2=second

- *

If you send a batch message to a topic, Amazon SNS publishes the batch message to each - * endpoint that is subscribed to the topic. The format of the batch message depends on the - * notification protocol for each subscribed endpoint.

- *

When a messageId is returned, the batch message is saved and Amazon SNS - * immediately delivers the message to subscribers.

+ * @see {@link PublishBatchCommand} */ - public publishBatch( - args: PublishBatchCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public publishBatch(args: PublishBatchCommandInput, cb: (err: any, data?: PublishBatchCommandOutput) => void): void; - public publishBatch( + publishBatch(args: PublishBatchCommandInput, options?: __HttpHandlerOptions): Promise; + publishBatch(args: PublishBatchCommandInput, cb: (err: any, data?: PublishBatchCommandOutput) => void): void; + publishBatch( args: PublishBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishBatchCommandOutput) => void ): void; - public publishBatch( - args: PublishBatchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PublishBatchCommandOutput) => void), - cb?: (err: any, data?: PublishBatchCommandOutput) => void - ): Promise | void { - const command = new PublishBatchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or updates an inline policy document that is stored in the specified Amazon SNS - * topic.

+ * @see {@link PutDataProtectionPolicyCommand} */ - public putDataProtectionPolicy( + putDataProtectionPolicy( args: PutDataProtectionPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putDataProtectionPolicy( + putDataProtectionPolicy( args: PutDataProtectionPolicyCommandInput, cb: (err: any, data?: PutDataProtectionPolicyCommandOutput) => void ): void; - public putDataProtectionPolicy( + putDataProtectionPolicy( args: PutDataProtectionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDataProtectionPolicyCommandOutput) => void ): void; - public putDataProtectionPolicy( - args: PutDataProtectionPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutDataProtectionPolicyCommandOutput) => void), - cb?: (err: any, data?: PutDataProtectionPolicyCommandOutput) => void - ): Promise | void { - const command = new PutDataProtectionPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a statement from a topic's access control policy.

- * - *

To remove the ability to change topic permissions, you must deny permissions to - * the AddPermission, RemovePermission, and - * SetTopicAttributes actions in your IAM policy.

- *
+ * @see {@link RemovePermissionCommand} */ - public removePermission( + removePermission( args: RemovePermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public removePermission( + removePermission( args: RemovePermissionCommandInput, cb: (err: any, data?: RemovePermissionCommandOutput) => void ): void; - public removePermission( + removePermission( args: RemovePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemovePermissionCommandOutput) => void ): void; - public removePermission( - args: RemovePermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemovePermissionCommandOutput) => void), - cb?: (err: any, data?: RemovePermissionCommandOutput) => void - ): Promise | void { - const command = new RemovePermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the attributes for an endpoint for a device on one of the supported push - * notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more - * information, see Using Amazon SNS Mobile Push Notifications.

+ * @see {@link SetEndpointAttributesCommand} */ - public setEndpointAttributes( + setEndpointAttributes( args: SetEndpointAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public setEndpointAttributes( + setEndpointAttributes( args: SetEndpointAttributesCommandInput, cb: (err: any, data?: SetEndpointAttributesCommandOutput) => void ): void; - public setEndpointAttributes( + setEndpointAttributes( args: SetEndpointAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetEndpointAttributesCommandOutput) => void ): void; - public setEndpointAttributes( - args: SetEndpointAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetEndpointAttributesCommandOutput) => void), - cb?: (err: any, data?: SetEndpointAttributesCommandOutput) => void - ): Promise | void { - const command = new SetEndpointAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the attributes of the platform application object for the supported push - * notification services, such as APNS and GCM (Firebase Cloud Messaging). For more - * information, see Using Amazon SNS Mobile Push Notifications. For information on configuring - * attributes for message delivery status, see Using Amazon SNS Application Attributes for - * Message Delivery Status.

+ * @see {@link SetPlatformApplicationAttributesCommand} */ - public setPlatformApplicationAttributes( + setPlatformApplicationAttributes( args: SetPlatformApplicationAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public setPlatformApplicationAttributes( + setPlatformApplicationAttributes( args: SetPlatformApplicationAttributesCommandInput, cb: (err: any, data?: SetPlatformApplicationAttributesCommandOutput) => void ): void; - public setPlatformApplicationAttributes( + setPlatformApplicationAttributes( args: SetPlatformApplicationAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetPlatformApplicationAttributesCommandOutput) => void ): void; - public setPlatformApplicationAttributes( - args: SetPlatformApplicationAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetPlatformApplicationAttributesCommandOutput) => void), - cb?: (err: any, data?: SetPlatformApplicationAttributesCommandOutput) => void - ): Promise | void { - const command = new SetPlatformApplicationAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this request to set the default settings for sending SMS messages and receiving - * daily SMS usage reports.

- *

You can override some of these settings for a single message when you use the - * Publish action with the MessageAttributes.entry.N - * parameter. For more information, see Publishing to a mobile phone - * in the Amazon SNS Developer Guide.

- * - *

To use this operation, you must grant the Amazon SNS service principal - * (sns.amazonaws.com) permission to perform the - * s3:ListBucket action.

- *
+ * @see {@link SetSMSAttributesCommand} */ - public setSMSAttributes( + setSMSAttributes( args: SetSMSAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public setSMSAttributes( + setSMSAttributes( args: SetSMSAttributesCommandInput, cb: (err: any, data?: SetSMSAttributesCommandOutput) => void ): void; - public setSMSAttributes( + setSMSAttributes( args: SetSMSAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetSMSAttributesCommandOutput) => void ): void; - public setSMSAttributes( - args: SetSMSAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetSMSAttributesCommandOutput) => void), - cb?: (err: any, data?: SetSMSAttributesCommandOutput) => void - ): Promise | void { - const command = new SetSMSAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows a subscription owner to set an attribute of the subscription to a new - * value.

+ * @see {@link SetSubscriptionAttributesCommand} */ - public setSubscriptionAttributes( + setSubscriptionAttributes( args: SetSubscriptionAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public setSubscriptionAttributes( + setSubscriptionAttributes( args: SetSubscriptionAttributesCommandInput, cb: (err: any, data?: SetSubscriptionAttributesCommandOutput) => void ): void; - public setSubscriptionAttributes( + setSubscriptionAttributes( args: SetSubscriptionAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetSubscriptionAttributesCommandOutput) => void ): void; - public setSubscriptionAttributes( - args: SetSubscriptionAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetSubscriptionAttributesCommandOutput) => void), - cb?: (err: any, data?: SetSubscriptionAttributesCommandOutput) => void - ): Promise | void { - const command = new SetSubscriptionAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows a topic owner to set an attribute of the topic to a new value.

- * - *

To remove the ability to change topic permissions, you must deny permissions to - * the AddPermission, RemovePermission, and - * SetTopicAttributes actions in your IAM policy.

- *
+ * @see {@link SetTopicAttributesCommand} */ - public setTopicAttributes( + setTopicAttributes( args: SetTopicAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public setTopicAttributes( + setTopicAttributes( args: SetTopicAttributesCommandInput, cb: (err: any, data?: SetTopicAttributesCommandOutput) => void ): void; - public setTopicAttributes( + setTopicAttributes( args: SetTopicAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetTopicAttributesCommandOutput) => void ): void; - public setTopicAttributes( - args: SetTopicAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetTopicAttributesCommandOutput) => void), - cb?: (err: any, data?: SetTopicAttributesCommandOutput) => void - ): Promise | void { - const command = new SetTopicAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or - * if the endpoint and the topic are not in the same Amazon Web Services account, the endpoint owner must - * run the ConfirmSubscription action to confirm the subscription.

- *

You call the ConfirmSubscription action with the token from the - * subscription response. Confirmation tokens are valid for three days.

- *

This action is throttled at 100 transactions per second (TPS).

+ * @see {@link SubscribeCommand} */ - public subscribe(args: SubscribeCommandInput, options?: __HttpHandlerOptions): Promise; - public subscribe(args: SubscribeCommandInput, cb: (err: any, data?: SubscribeCommandOutput) => void): void; - public subscribe( + subscribe(args: SubscribeCommandInput, options?: __HttpHandlerOptions): Promise; + subscribe(args: SubscribeCommandInput, cb: (err: any, data?: SubscribeCommandOutput) => void): void; + subscribe( args: SubscribeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubscribeCommandOutput) => void ): void; - public subscribe( - args: SubscribeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SubscribeCommandOutput) => void), - cb?: (err: any, data?: SubscribeCommandOutput) => void - ): Promise | void { - const command = new SubscribeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the - * Amazon SNS Developer Guide.

- *

When you use topic tags, keep the following guidelines in mind:

- *
    - *
  • - *

    Adding more than 50 tags to a topic isn't recommended.

    - *
  • - *
  • - *

    Tags don't have any semantic meaning. Amazon SNS interprets tags as character - * strings.

    - *
  • - *
  • - *

    Tags are case-sensitive.

    - *
  • - *
  • - *

    A new tag with a key identical to that of an existing tag overwrites the - * existing tag.

    - *
  • - *
  • - *

    Tagging actions are limited to 10 TPS per Amazon Web Services account, per Amazon Web Services Region. If - * your application requires a higher throughput, file a technical support request.

    - *
  • - *
+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a subscription. If the subscription requires authentication for deletion, only - * the owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services - * signature is required. If the Unsubscribe call does not require - * authentication and the requester is not the subscription owner, a final cancellation - * message is delivered to the endpoint, so that the endpoint owner can easily resubscribe - * to the topic if the Unsubscribe request was unintended.

- * - *

Amazon SQS queue subscriptions require authentication for deletion. Only the owner of - * the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services - * signature.

- *
- *

This action is throttled at 100 transactions per second (TPS).

+ * @see {@link UnsubscribeCommand} */ - public unsubscribe(args: UnsubscribeCommandInput, options?: __HttpHandlerOptions): Promise; - public unsubscribe(args: UnsubscribeCommandInput, cb: (err: any, data?: UnsubscribeCommandOutput) => void): void; - public unsubscribe( + unsubscribe(args: UnsubscribeCommandInput, options?: __HttpHandlerOptions): Promise; + unsubscribe(args: UnsubscribeCommandInput, cb: (err: any, data?: UnsubscribeCommandOutput) => void): void; + unsubscribe( args: UnsubscribeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnsubscribeCommandOutput) => void ): void; - public unsubscribe( - args: UnsubscribeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnsubscribeCommandOutput) => void), - cb?: (err: any, data?: UnsubscribeCommandOutput) => void - ): Promise | void { - const command = new UnsubscribeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the - * Amazon SNS Developer Guide.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Verifies a destination phone number with a one-time password (OTP) for the calling - * Amazon Web Services account.

- *

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the - * SMS sandbox. The SMS sandbox provides a safe environment for - * you to try Amazon SNS features without risking your reputation as an SMS sender. While your - * Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send - * SMS messages only to verified destination phone numbers. For more information, including how to - * move out of the sandbox to send messages without restrictions, - * see SMS sandbox in - * the Amazon SNS Developer Guide.

+ * @see {@link VerifySMSSandboxPhoneNumberCommand} */ - public verifySMSSandboxPhoneNumber( + verifySMSSandboxPhoneNumber( args: VerifySMSSandboxPhoneNumberCommandInput, options?: __HttpHandlerOptions ): Promise; - public verifySMSSandboxPhoneNumber( + verifySMSSandboxPhoneNumber( args: VerifySMSSandboxPhoneNumberCommandInput, cb: (err: any, data?: VerifySMSSandboxPhoneNumberCommandOutput) => void ): void; - public verifySMSSandboxPhoneNumber( + verifySMSSandboxPhoneNumber( args: VerifySMSSandboxPhoneNumberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifySMSSandboxPhoneNumberCommandOutput) => void ): void; - public verifySMSSandboxPhoneNumber( - args: VerifySMSSandboxPhoneNumberCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: VerifySMSSandboxPhoneNumberCommandOutput) => void), - cb?: (err: any, data?: VerifySMSSandboxPhoneNumberCommandOutput) => void - ): Promise | void { - const command = new VerifySMSSandboxPhoneNumberCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Simple Notification Service + *

Amazon Simple Notification Service (Amazon SNS) is a web service that enables you + * to build distributed web-enabled applications. Applications can use Amazon SNS to easily push + * real-time notification messages to interested subscribers over multiple delivery + * protocols. For more information about this product see the Amazon SNS product page. For detailed information about Amazon SNS features + * and their associated API calls, see the Amazon SNS Developer Guide.

+ *

For information on the permissions you need to use this API, see Identity and access management in Amazon SNS in the Amazon SNS Developer + * Guide. + *

+ *

We also provide SDKs that enable you to access Amazon SNS from your preferred programming + * language. The SDKs contain functionality that automatically takes care of tasks such as: + * cryptographically signing your service requests, retrying requests, and handling error + * responses. For a list of available SDKs, go to Tools for Amazon Web Services.

+ */ +export class SNS extends SNSClient implements SNS {} +createAggregatedClient(commands, SNS); diff --git a/clients/client-sqs/src/SQS.ts b/clients/client-sqs/src/SQS.ts index 603f282d9423..e00930d4afc9 100644 --- a/clients/client-sqs/src/SQS.ts +++ b/clients/client-sqs/src/SQS.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -69,1043 +70,375 @@ import { } from "./commands/SetQueueAttributesCommand"; import { TagQueueCommand, TagQueueCommandInput, TagQueueCommandOutput } from "./commands/TagQueueCommand"; import { UntagQueueCommand, UntagQueueCommandInput, UntagQueueCommandOutput } from "./commands/UntagQueueCommand"; -import { SQSClient } from "./SQSClient"; +import { SQSClient, SQSClientConfig } from "./SQSClient"; -/** - * @public - *

Welcome to the Amazon SQS API Reference.

- *

Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.

- *

For information on the permissions you need to use this API, see - * Identity and - * access management in the Amazon SQS Developer Guide. - *

- *

You can use Amazon Web Services SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:

- *
    - *
  • - *

    Cryptographically sign your service requests

    - *
  • - *
  • - *

    Retry requests

    - *
  • - *
  • - *

    Handle error responses

    - *
  • - *
- * - *

- * Additional information - *

- * - */ -export class SQS extends SQSClient { +const commands = { + AddPermissionCommand, + ChangeMessageVisibilityCommand, + ChangeMessageVisibilityBatchCommand, + CreateQueueCommand, + DeleteMessageCommand, + DeleteMessageBatchCommand, + DeleteQueueCommand, + GetQueueAttributesCommand, + GetQueueUrlCommand, + ListDeadLetterSourceQueuesCommand, + ListQueuesCommand, + ListQueueTagsCommand, + PurgeQueueCommand, + ReceiveMessageCommand, + RemovePermissionCommand, + SendMessageCommand, + SendMessageBatchCommand, + SetQueueAttributesCommand, + TagQueueCommand, + UntagQueueCommand, +}; + +export interface SQS { /** - * @public - *

Adds a permission to a queue for a specific - * principal. - * This allows sharing access to the queue.

- *

When you create a queue, you have full control access rights for the queue. - * Only you, the owner of the queue, can grant or deny permissions to the queue. - * For more information about these permissions, see - * Allow - * Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.

- * - *
    - *
  • - *

    - * AddPermission generates a policy for you. You can use - * - * SetQueueAttributes - * to - * upload your policy. For more information, see - * Using Custom Policies with the Amazon SQS Access Policy Language in - * the Amazon SQS Developer Guide.

    - *
  • - *
  • - *

    An Amazon SQS policy can have a maximum of 7 actions.

    - *
  • - *
  • - *

    To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

    - *
  • - *
- *
- *

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

- *

- * &AttributeName.1=first - *

- *

- * &AttributeName.2=second - *

- * - *

Cross-account permissions don't apply to this action. For more information, - * see Grant - * cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

- *
+ * @see {@link AddPermissionCommand} */ - public addPermission( - args: AddPermissionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public addPermission( - args: AddPermissionCommandInput, - cb: (err: any, data?: AddPermissionCommandOutput) => void - ): void; - public addPermission( + addPermission(args: AddPermissionCommandInput, options?: __HttpHandlerOptions): Promise; + addPermission(args: AddPermissionCommandInput, cb: (err: any, data?: AddPermissionCommandOutput) => void): void; + addPermission( args: AddPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddPermissionCommandOutput) => void ): void; - public addPermission( - args: AddPermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddPermissionCommandOutput) => void), - cb?: (err: any, data?: AddPermissionCommandOutput) => void - ): Promise | void { - const command = new AddPermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes the visibility timeout of a specified message in a queue to a new value. The - * default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The - * maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.

- *

For example, you have a message with a visibility timeout of 5 minutes. After 3 - * minutes, you call ChangeMessageVisibility with a timeout of 10 minutes. You - * can continue to call ChangeMessageVisibility to extend the visibility - * timeout to the maximum allowed time. If you try to extend the visibility timeout beyond - * the maximum, your request is rejected.

- *

An Amazon SQS message has three basic states:

- *
    - *
  1. - *

    Sent to a queue by a producer.

    - *
  2. - *
  3. - *

    Received from the queue by a consumer.

    - *
  4. - *
  5. - *

    Deleted from the queue.

    - *
  6. - *
- *

A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. - * A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of inflight messages.

- *

Limits that apply to inflight messages are unrelated to the unlimited number of stored messages.

- *

For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). - * If you reach this limit, Amazon SQS returns the OverLimit error message. - * To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages. - * To request a limit increase, file a support request.

- *

For FIFO queues, there can be a maximum of 20,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.

- * - * - *

If you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time.

- *

Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout - * for the message reverts to the original timeout value (not to the value you set using the ChangeMessageVisibility action) the next time the message is received.

- *
+ * @see {@link ChangeMessageVisibilityCommand} */ - public changeMessageVisibility( + changeMessageVisibility( args: ChangeMessageVisibilityCommandInput, options?: __HttpHandlerOptions ): Promise; - public changeMessageVisibility( + changeMessageVisibility( args: ChangeMessageVisibilityCommandInput, cb: (err: any, data?: ChangeMessageVisibilityCommandOutput) => void ): void; - public changeMessageVisibility( + changeMessageVisibility( args: ChangeMessageVisibilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChangeMessageVisibilityCommandOutput) => void ): void; - public changeMessageVisibility( - args: ChangeMessageVisibilityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ChangeMessageVisibilityCommandOutput) => void), - cb?: (err: any, data?: ChangeMessageVisibilityCommandOutput) => void - ): Promise | void { - const command = new ChangeMessageVisibilityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes the visibility timeout of multiple messages. This is a batch version of - * ChangeMessageVisibility. The result of the action on each message is reported individually in the response. - * You can send up to 10 - * ChangeMessageVisibility - * requests with each ChangeMessageVisibilityBatch action.

- * - *

Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

- *
- *

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

- *

- * &AttributeName.1=first - *

- *

- * &AttributeName.2=second - *

+ * @see {@link ChangeMessageVisibilityBatchCommand} */ - public changeMessageVisibilityBatch( + changeMessageVisibilityBatch( args: ChangeMessageVisibilityBatchCommandInput, options?: __HttpHandlerOptions ): Promise; - public changeMessageVisibilityBatch( + changeMessageVisibilityBatch( args: ChangeMessageVisibilityBatchCommandInput, cb: (err: any, data?: ChangeMessageVisibilityBatchCommandOutput) => void ): void; - public changeMessageVisibilityBatch( + changeMessageVisibilityBatch( args: ChangeMessageVisibilityBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChangeMessageVisibilityBatchCommandOutput) => void ): void; - public changeMessageVisibilityBatch( - args: ChangeMessageVisibilityBatchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ChangeMessageVisibilityBatchCommandOutput) => void), - cb?: (err: any, data?: ChangeMessageVisibilityBatchCommandOutput) => void - ): Promise | void { - const command = new ChangeMessageVisibilityBatchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new standard or FIFO queue. You can pass one or more attributes in - * the request. Keep the following in mind:

- *
    - *
  • - *

    If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.

    - * - *

    You can't change the queue type after you create it and you can't convert - * an existing standard queue into a FIFO queue. You must either create a new - * FIFO queue for your application or delete your existing standard queue and - * recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the - * Amazon SQS Developer Guide.

    - *
    - *
  • - *
  • - *

    If you don't provide a value for an attribute, the queue is created with the default value for the attribute.

    - *
  • - *
  • - *

    If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

    - *
  • - *
- * - *

To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.

- * - *

After you create a queue, you must wait at least one second after the queue is - * created to be able to use the queue.

- *
- *

To get the queue URL, use the - * GetQueueUrl - * action. - * GetQueueUrl - * requires only the QueueName parameter. - * be aware of existing queue names:

- *
    - *
  • - *

    If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, CreateQueue returns the queue URL for the existing queue.

    - *
  • - *
  • - *

    If the queue name, attribute names, or attribute values don't match an existing queue, CreateQueue returns an error.

    - *
  • - *
- *

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

- *

- * &AttributeName.1=first - *

- *

- * &AttributeName.2=second - *

- * - *

Cross-account permissions don't apply to this action. For more information, - * see Grant - * cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

- *
+ * @see {@link CreateQueueCommand} */ - public createQueue(args: CreateQueueCommandInput, options?: __HttpHandlerOptions): Promise; - public createQueue(args: CreateQueueCommandInput, cb: (err: any, data?: CreateQueueCommandOutput) => void): void; - public createQueue( + createQueue(args: CreateQueueCommandInput, options?: __HttpHandlerOptions): Promise; + createQueue(args: CreateQueueCommandInput, cb: (err: any, data?: CreateQueueCommandOutput) => void): void; + createQueue( args: CreateQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateQueueCommandOutput) => void ): void; - public createQueue( - args: CreateQueueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateQueueCommandOutput) => void), - cb?: (err: any, data?: CreateQueueCommandOutput) => void - ): Promise | void { - const command = new CreateQueueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified message from the specified queue. To select the message to - * delete, use the ReceiptHandle of the message (not the - * MessageId which you receive when you send the message). Amazon SQS can - * delete a message from a queue even if a visibility timeout setting causes the message to - * be locked by another consumer. Amazon SQS automatically deletes messages left in a queue - * longer than the retention period configured for the queue.

- * - *

The ReceiptHandle is associated with a specific - * instance of receiving a message. If you receive a message more than - * once, the ReceiptHandle is different each time you receive a message. - * When you use the DeleteMessage action, you must provide the most - * recently received ReceiptHandle for the message (otherwise, the request - * succeeds, but the message might not be deleted).

- *

For standard queues, it is possible to receive a message even after you - * delete it. This might happen on rare occasions if one of the servers which stores a - * copy of the message is unavailable when you send the request to delete the message. - * The copy remains on the server and might be returned to you during a subsequent - * receive request. You should ensure that your application is idempotent, so that - * receiving a message more than once does not cause issues.

- *
+ * @see {@link DeleteMessageCommand} */ - public deleteMessage( - args: DeleteMessageCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteMessage( - args: DeleteMessageCommandInput, - cb: (err: any, data?: DeleteMessageCommandOutput) => void - ): void; - public deleteMessage( + deleteMessage(args: DeleteMessageCommandInput, options?: __HttpHandlerOptions): Promise; + deleteMessage(args: DeleteMessageCommandInput, cb: (err: any, data?: DeleteMessageCommandOutput) => void): void; + deleteMessage( args: DeleteMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMessageCommandOutput) => void ): void; - public deleteMessage( - args: DeleteMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMessageCommandOutput) => void), - cb?: (err: any, data?: DeleteMessageCommandOutput) => void - ): Promise | void { - const command = new DeleteMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes up to ten messages from the specified queue. This is a batch version of - * DeleteMessage. The result of the action on each message is reported individually in the response.

- * - *

Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

- *
- *

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

- *

- * &AttributeName.1=first - *

- *

- * &AttributeName.2=second - *

+ * @see {@link DeleteMessageBatchCommand} */ - public deleteMessageBatch( + deleteMessageBatch( args: DeleteMessageBatchCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMessageBatch( + deleteMessageBatch( args: DeleteMessageBatchCommandInput, cb: (err: any, data?: DeleteMessageBatchCommandOutput) => void ): void; - public deleteMessageBatch( + deleteMessageBatch( args: DeleteMessageBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMessageBatchCommandOutput) => void ): void; - public deleteMessageBatch( - args: DeleteMessageBatchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMessageBatchCommandOutput) => void), - cb?: (err: any, data?: DeleteMessageBatchCommandOutput) => void - ): Promise | void { - const command = new DeleteMessageBatchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the queue specified by the QueueUrl, regardless of the queue's contents.

- * - *

Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available. - *

- *
- *

When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a - * - * SendMessage - * request might succeed, but after 60 seconds the queue and the message you sent no longer exist.

- *

When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

- * - *

Cross-account permissions don't apply to this action. For more information, - * see Grant - * cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

- *
+ * @see {@link DeleteQueueCommand} */ - public deleteQueue(args: DeleteQueueCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteQueue(args: DeleteQueueCommandInput, cb: (err: any, data?: DeleteQueueCommandOutput) => void): void; - public deleteQueue( + deleteQueue(args: DeleteQueueCommandInput, options?: __HttpHandlerOptions): Promise; + deleteQueue(args: DeleteQueueCommandInput, cb: (err: any, data?: DeleteQueueCommandOutput) => void): void; + deleteQueue( args: DeleteQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteQueueCommandOutput) => void ): void; - public deleteQueue( - args: DeleteQueueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteQueueCommandOutput) => void), - cb?: (err: any, data?: DeleteQueueCommandOutput) => void - ): Promise | void { - const command = new DeleteQueueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets attributes for the specified queue.

- * - *

To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

- *
+ * @see {@link GetQueueAttributesCommand} */ - public getQueueAttributes( + getQueueAttributes( args: GetQueueAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getQueueAttributes( + getQueueAttributes( args: GetQueueAttributesCommandInput, cb: (err: any, data?: GetQueueAttributesCommandOutput) => void ): void; - public getQueueAttributes( + getQueueAttributes( args: GetQueueAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueueAttributesCommandOutput) => void ): void; - public getQueueAttributes( - args: GetQueueAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetQueueAttributesCommandOutput) => void), - cb?: (err: any, data?: GetQueueAttributesCommandOutput) => void - ): Promise | void { - const command = new GetQueueAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the URL of an existing Amazon SQS queue.

- *

To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. - * For more information about shared queue access, see - * AddPermission - * or see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide. - *

+ * @see {@link GetQueueUrlCommand} */ - public getQueueUrl(args: GetQueueUrlCommandInput, options?: __HttpHandlerOptions): Promise; - public getQueueUrl(args: GetQueueUrlCommandInput, cb: (err: any, data?: GetQueueUrlCommandOutput) => void): void; - public getQueueUrl( + getQueueUrl(args: GetQueueUrlCommandInput, options?: __HttpHandlerOptions): Promise; + getQueueUrl(args: GetQueueUrlCommandInput, cb: (err: any, data?: GetQueueUrlCommandOutput) => void): void; + getQueueUrl( args: GetQueueUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueueUrlCommandOutput) => void ): void; - public getQueueUrl( - args: GetQueueUrlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetQueueUrlCommandOutput) => void), - cb?: (err: any, data?: GetQueueUrlCommandOutput) => void - ): Promise | void { - const command = new GetQueueUrlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue.

- *

The ListDeadLetterSourceQueues methods supports - * pagination. Set parameter MaxResults in the request to specify the maximum number of - * results to be returned in the response. If you do not set MaxResults, - * the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to - * display, the response includes a value for NextToken. Use - * NextToken as a parameter in your next request to - * ListDeadLetterSourceQueues to receive the next page of results.

- * - *

For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues - * in the Amazon SQS Developer Guide.

+ * @see {@link ListDeadLetterSourceQueuesCommand} */ - public listDeadLetterSourceQueues( + listDeadLetterSourceQueues( args: ListDeadLetterSourceQueuesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDeadLetterSourceQueues( + listDeadLetterSourceQueues( args: ListDeadLetterSourceQueuesCommandInput, cb: (err: any, data?: ListDeadLetterSourceQueuesCommandOutput) => void ): void; - public listDeadLetterSourceQueues( + listDeadLetterSourceQueues( args: ListDeadLetterSourceQueuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeadLetterSourceQueuesCommandOutput) => void ): void; - public listDeadLetterSourceQueues( - args: ListDeadLetterSourceQueuesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDeadLetterSourceQueuesCommandOutput) => void), - cb?: (err: any, data?: ListDeadLetterSourceQueuesCommandOutput) => void - ): Promise | void { - const command = new ListDeadLetterSourceQueuesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you specify a value for the optional - * QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.

- *

The listQueues methods supports - * pagination. Set parameter MaxResults in the request to specify the maximum number of - * results to be returned in the response. If you do not set MaxResults, - * the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to - * display, the response includes a value for NextToken. Use - * NextToken as a parameter in your next request to - * listQueues to receive the next page of results.

- * - *

Cross-account permissions don't apply to this action. For more information, - * see Grant - * cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

- *
+ * @see {@link ListQueuesCommand} */ - public listQueues(args: ListQueuesCommandInput, options?: __HttpHandlerOptions): Promise; - public listQueues(args: ListQueuesCommandInput, cb: (err: any, data?: ListQueuesCommandOutput) => void): void; - public listQueues( + listQueues(args: ListQueuesCommandInput, options?: __HttpHandlerOptions): Promise; + listQueues(args: ListQueuesCommandInput, cb: (err: any, data?: ListQueuesCommandOutput) => void): void; + listQueues( args: ListQueuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQueuesCommandOutput) => void ): void; - public listQueues( - args: ListQueuesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListQueuesCommandOutput) => void), - cb?: (err: any, data?: ListQueuesCommandOutput) => void - ): Promise | void { - const command = new ListQueuesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging - * Your Amazon SQS Queues in the Amazon SQS Developer Guide.

- * - *

Cross-account permissions don't apply to this action. For more information, - * see Grant - * cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

- *
+ * @see {@link ListQueueTagsCommand} */ - public listQueueTags( - args: ListQueueTagsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listQueueTags( - args: ListQueueTagsCommandInput, - cb: (err: any, data?: ListQueueTagsCommandOutput) => void - ): void; - public listQueueTags( + listQueueTags(args: ListQueueTagsCommandInput, options?: __HttpHandlerOptions): Promise; + listQueueTags(args: ListQueueTagsCommandInput, cb: (err: any, data?: ListQueueTagsCommandOutput) => void): void; + listQueueTags( args: ListQueueTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQueueTagsCommandOutput) => void ): void; - public listQueueTags( - args: ListQueueTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListQueueTagsCommandOutput) => void), - cb?: (err: any, data?: ListQueueTagsCommandOutput) => void - ): Promise | void { - const command = new ListQueueTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the messages in a queue specified by the QueueURL - * parameter.

- * - * - *

When you use the PurgeQueue action, you can't retrieve any messages - * deleted from a queue.

- *

The message deletion process takes up to 60 seconds. We recommend waiting for - * 60 seconds regardless of your queue's size.

- *
- *

Messages sent to the queue before you call - * PurgeQueue might be received but are deleted within the next - * minute.

- *

Messages sent to the queue after you call - * PurgeQueue might be deleted while the queue is being purged.

+ * @see {@link PurgeQueueCommand} */ - public purgeQueue(args: PurgeQueueCommandInput, options?: __HttpHandlerOptions): Promise; - public purgeQueue(args: PurgeQueueCommandInput, cb: (err: any, data?: PurgeQueueCommandOutput) => void): void; - public purgeQueue( + purgeQueue(args: PurgeQueueCommandInput, options?: __HttpHandlerOptions): Promise; + purgeQueue(args: PurgeQueueCommandInput, cb: (err: any, data?: PurgeQueueCommandOutput) => void): void; + purgeQueue( args: PurgeQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PurgeQueueCommandOutput) => void ): void; - public purgeQueue( - args: PurgeQueueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PurgeQueueCommandOutput) => void), - cb?: (err: any, data?: PurgeQueueCommandOutput) => void - ): Promise | void { - const command = new PurgeQueueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support. - * For more information, see Amazon SQS Long Polling in the Amazon SQS Developer Guide. - *

- *

Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. Thus, only the messages on the sampled machines are returned. - * If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, - * you might not receive any messages in a particular ReceiveMessage response. If this happens, repeat the request. - *

- *

For each message returned, the response includes the following:

- *
    - *
  • - *

    The message body.

    - *
  • - *
  • - *

    An MD5 digest of the message body. For information about MD5, see RFC1321.

    - *
  • - *
  • - *

    The MessageId you received when you sent the message to the queue.

    - *
  • - *
  • - *

    The receipt handle.

    - *
  • - *
  • - *

    The message attributes.

    - *
  • - *
  • - *

    An MD5 digest of the message attributes.

    - *
  • - *
- *

The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue - * and Message Identifiers in the Amazon SQS Developer Guide.

- *

You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue - * is used for the returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.

- *

A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.

- * - *

In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

- *
+ * @see {@link ReceiveMessageCommand} */ - public receiveMessage( + receiveMessage( args: ReceiveMessageCommandInput, options?: __HttpHandlerOptions ): Promise; - public receiveMessage( - args: ReceiveMessageCommandInput, - cb: (err: any, data?: ReceiveMessageCommandOutput) => void - ): void; - public receiveMessage( + receiveMessage(args: ReceiveMessageCommandInput, cb: (err: any, data?: ReceiveMessageCommandOutput) => void): void; + receiveMessage( args: ReceiveMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReceiveMessageCommandOutput) => void ): void; - public receiveMessage( - args: ReceiveMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ReceiveMessageCommandOutput) => void), - cb?: (err: any, data?: ReceiveMessageCommandOutput) => void - ): Promise | void { - const command = new ReceiveMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Revokes any permissions in the queue policy that matches the specified Label parameter.

- * - *
    - *
  • - *

    Only the owner of a queue can remove permissions from it.

    - *
  • - *
  • - *

    Cross-account permissions don't apply to this action. For more information, - * see Grant - * cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

    - *
  • - *
  • - *

    To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

    - *
  • - *
- *
+ * @see {@link RemovePermissionCommand} */ - public removePermission( + removePermission( args: RemovePermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public removePermission( + removePermission( args: RemovePermissionCommandInput, cb: (err: any, data?: RemovePermissionCommandOutput) => void ): void; - public removePermission( + removePermission( args: RemovePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemovePermissionCommandOutput) => void ): void; - public removePermission( - args: RemovePermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemovePermissionCommandOutput) => void), - cb?: (err: any, data?: RemovePermissionCommandOutput) => void - ): Promise | void { - const command = new RemovePermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delivers a message to the specified queue.

- * - *

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:

- *

- * #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF - *

- *

Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.

- *
+ * @see {@link SendMessageCommand} */ - public sendMessage(args: SendMessageCommandInput, options?: __HttpHandlerOptions): Promise; - public sendMessage(args: SendMessageCommandInput, cb: (err: any, data?: SendMessageCommandOutput) => void): void; - public sendMessage( + sendMessage(args: SendMessageCommandInput, options?: __HttpHandlerOptions): Promise; + sendMessage(args: SendMessageCommandInput, cb: (err: any, data?: SendMessageCommandOutput) => void): void; + sendMessage( args: SendMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendMessageCommandOutput) => void ): void; - public sendMessage( - args: SendMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendMessageCommandOutput) => void), - cb?: (err: any, data?: SendMessageCommandOutput) => void - ): Promise | void { - const command = new SendMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delivers up to ten messages to the specified queue. This is a batch version of - * SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.

- *

The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

- *

The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).

- * - *

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:

- *

- * #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF - *

- *

Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.

- *
- *

If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue.

- *

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

- *

- * &AttributeName.1=first - *

- *

- * &AttributeName.2=second - *

+ * @see {@link SendMessageBatchCommand} */ - public sendMessageBatch( + sendMessageBatch( args: SendMessageBatchCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendMessageBatch( + sendMessageBatch( args: SendMessageBatchCommandInput, cb: (err: any, data?: SendMessageBatchCommandOutput) => void ): void; - public sendMessageBatch( + sendMessageBatch( args: SendMessageBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendMessageBatchCommandOutput) => void ): void; - public sendMessageBatch( - args: SendMessageBatchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendMessageBatchCommandOutput) => void), - cb?: (err: any, data?: SendMessageBatchCommandOutput) => void - ): Promise | void { - const command = new SendMessageBatchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. - * Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes.

- * - *
    - *
  • - *

    In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

    - *
  • - *
  • - *

    Cross-account permissions don't apply to this action. For more information, - * see Grant - * cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

    - *
  • - *
  • - *

    To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

    - *
  • - *
- *
+ * @see {@link SetQueueAttributesCommand} */ - public setQueueAttributes( + setQueueAttributes( args: SetQueueAttributesCommandInput, options?: __HttpHandlerOptions ): Promise; - public setQueueAttributes( + setQueueAttributes( args: SetQueueAttributesCommandInput, cb: (err: any, data?: SetQueueAttributesCommandOutput) => void ): void; - public setQueueAttributes( + setQueueAttributes( args: SetQueueAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetQueueAttributesCommandOutput) => void ): void; - public setQueueAttributes( - args: SetQueueAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetQueueAttributesCommandOutput) => void), - cb?: (err: any, data?: SetQueueAttributesCommandOutput) => void - ): Promise | void { - const command = new SetQueueAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging - * Your Amazon SQS Queues in the Amazon SQS Developer Guide.

- * - *

When you use queue tags, keep the following guidelines in mind:

- *
    - *
  • - *

    Adding more than 50 tags to a queue isn't recommended.

    - *
  • - *
  • - *

    Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.

    - *
  • - *
  • - *

    Tags are case-sensitive.

    - *
  • - *
  • - *

    A new tag with a key identical to that of an existing tag overwrites the existing tag.

    - *
  • - *
- *

For a full list of tag restrictions, see - * Quotas related to queues - * in the Amazon SQS Developer Guide.

- * - *

Cross-account permissions don't apply to this action. For more information, - * see Grant - * cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

- *
+ * @see {@link TagQueueCommand} */ - public tagQueue(args: TagQueueCommandInput, options?: __HttpHandlerOptions): Promise; - public tagQueue(args: TagQueueCommandInput, cb: (err: any, data?: TagQueueCommandOutput) => void): void; - public tagQueue( + tagQueue(args: TagQueueCommandInput, options?: __HttpHandlerOptions): Promise; + tagQueue(args: TagQueueCommandInput, cb: (err: any, data?: TagQueueCommandOutput) => void): void; + tagQueue( args: TagQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagQueueCommandOutput) => void ): void; - public tagQueue( - args: TagQueueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagQueueCommandOutput) => void), - cb?: (err: any, data?: TagQueueCommandOutput) => void - ): Promise | void { - const command = new TagQueueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging - * Your Amazon SQS Queues in the Amazon SQS Developer Guide.

- * - *

Cross-account permissions don't apply to this action. For more information, - * see Grant - * cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

- *
+ * @see {@link UntagQueueCommand} */ - public untagQueue(args: UntagQueueCommandInput, options?: __HttpHandlerOptions): Promise; - public untagQueue(args: UntagQueueCommandInput, cb: (err: any, data?: UntagQueueCommandOutput) => void): void; - public untagQueue( + untagQueue(args: UntagQueueCommandInput, options?: __HttpHandlerOptions): Promise; + untagQueue(args: UntagQueueCommandInput, cb: (err: any, data?: UntagQueueCommandOutput) => void): void; + untagQueue( args: UntagQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagQueueCommandOutput) => void ): void; - public untagQueue( - args: UntagQueueCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagQueueCommandOutput) => void), - cb?: (err: any, data?: UntagQueueCommandOutput) => void - ): Promise | void { - const command = new UntagQueueCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Welcome to the Amazon SQS API Reference.

+ *

Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.

+ *

For information on the permissions you need to use this API, see + * Identity and + * access management in the Amazon SQS Developer Guide. + *

+ *

You can use Amazon Web Services SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:

+ *
    + *
  • + *

    Cryptographically sign your service requests

    + *
  • + *
  • + *

    Retry requests

    + *
  • + *
  • + *

    Handle error responses

    + *
  • + *
+ * + *

+ * Additional information + *

+ * + */ +export class SQS extends SQSClient implements SQS {} +createAggregatedClient(commands, SQS); diff --git a/clients/client-ssm-contacts/src/SSMContacts.ts b/clients/client-ssm-contacts/src/SSMContacts.ts index 767c1ea24a86..6b23c3d271b2 100644 --- a/clients/client-ssm-contacts/src/SSMContacts.ts +++ b/clients/client-ssm-contacts/src/SSMContacts.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { AcceptPageCommand, AcceptPageCommandInput, AcceptPageCommandOutput } from "./commands/AcceptPageCommand"; @@ -180,1301 +181,641 @@ import { UpdateRotationCommandInput, UpdateRotationCommandOutput, } from "./commands/UpdateRotationCommand"; -import { SSMContactsClient } from "./SSMContactsClient"; +import { SSMContactsClient, SSMContactsClientConfig } from "./SSMContactsClient"; -/** - * @public - *

Systems Manager Incident Manager is an incident management console designed to help users - * mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. - * An incident is any unplanned interruption or reduction in quality of services.

- *

Incident Manager increases incident resolution by notifying responders of - * impact, highlighting relevant troubleshooting data, and providing collaboration tools to - * get services back up and running. To achieve the primary goal of reducing the - * time-to-resolution of critical incidents, Incident Manager automates response plans - * and enables responder team escalation.

- */ -export class SSMContacts extends SSMContactsClient { +const commands = { + AcceptPageCommand, + ActivateContactChannelCommand, + CreateContactCommand, + CreateContactChannelCommand, + CreateRotationCommand, + CreateRotationOverrideCommand, + DeactivateContactChannelCommand, + DeleteContactCommand, + DeleteContactChannelCommand, + DeleteRotationCommand, + DeleteRotationOverrideCommand, + DescribeEngagementCommand, + DescribePageCommand, + GetContactCommand, + GetContactChannelCommand, + GetContactPolicyCommand, + GetRotationCommand, + GetRotationOverrideCommand, + ListContactChannelsCommand, + ListContactsCommand, + ListEngagementsCommand, + ListPageReceiptsCommand, + ListPageResolutionsCommand, + ListPagesByContactCommand, + ListPagesByEngagementCommand, + ListPreviewRotationShiftsCommand, + ListRotationOverridesCommand, + ListRotationsCommand, + ListRotationShiftsCommand, + ListTagsForResourceCommand, + PutContactPolicyCommand, + SendActivationCodeCommand, + StartEngagementCommand, + StopEngagementCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateContactCommand, + UpdateContactChannelCommand, + UpdateRotationCommand, +}; + +export interface SSMContacts { /** - * @public - *

Used to acknowledge an engagement to a contact channel during an incident.

+ * @see {@link AcceptPageCommand} */ - public acceptPage(args: AcceptPageCommandInput, options?: __HttpHandlerOptions): Promise; - public acceptPage(args: AcceptPageCommandInput, cb: (err: any, data?: AcceptPageCommandOutput) => void): void; - public acceptPage( + acceptPage(args: AcceptPageCommandInput, options?: __HttpHandlerOptions): Promise; + acceptPage(args: AcceptPageCommandInput, cb: (err: any, data?: AcceptPageCommandOutput) => void): void; + acceptPage( args: AcceptPageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptPageCommandOutput) => void ): void; - public acceptPage( - args: AcceptPageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AcceptPageCommandOutput) => void), - cb?: (err: any, data?: AcceptPageCommandOutput) => void - ): Promise | void { - const command = new AcceptPageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Activates a contact's contact channel. Incident Manager can't engage a contact until the - * contact channel has been activated.

+ * @see {@link ActivateContactChannelCommand} */ - public activateContactChannel( + activateContactChannel( args: ActivateContactChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public activateContactChannel( + activateContactChannel( args: ActivateContactChannelCommandInput, cb: (err: any, data?: ActivateContactChannelCommandOutput) => void ): void; - public activateContactChannel( + activateContactChannel( args: ActivateContactChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ActivateContactChannelCommandOutput) => void ): void; - public activateContactChannel( - args: ActivateContactChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ActivateContactChannelCommandOutput) => void), - cb?: (err: any, data?: ActivateContactChannelCommandOutput) => void - ): Promise | void { - const command = new ActivateContactChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Contacts are either the contacts that Incident Manager engages during an incident or the - * escalation plans that Incident Manager uses to engage contacts in phases during an - * incident.

+ * @see {@link CreateContactCommand} */ - public createContact( - args: CreateContactCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createContact( - args: CreateContactCommandInput, - cb: (err: any, data?: CreateContactCommandOutput) => void - ): void; - public createContact( + createContact(args: CreateContactCommandInput, options?: __HttpHandlerOptions): Promise; + createContact(args: CreateContactCommandInput, cb: (err: any, data?: CreateContactCommandOutput) => void): void; + createContact( args: CreateContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateContactCommandOutput) => void ): void; - public createContact( - args: CreateContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateContactCommandOutput) => void), - cb?: (err: any, data?: CreateContactCommandOutput) => void - ): Promise | void { - const command = new CreateContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A contact channel is the method that Incident Manager uses to engage your contact.

+ * @see {@link CreateContactChannelCommand} */ - public createContactChannel( + createContactChannel( args: CreateContactChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public createContactChannel( + createContactChannel( args: CreateContactChannelCommandInput, cb: (err: any, data?: CreateContactChannelCommandOutput) => void ): void; - public createContactChannel( + createContactChannel( args: CreateContactChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateContactChannelCommandOutput) => void ): void; - public createContactChannel( - args: CreateContactChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateContactChannelCommandOutput) => void), - cb?: (err: any, data?: CreateContactChannelCommandOutput) => void - ): Promise | void { - const command = new CreateContactChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a rotation in an on-call schedule.

+ * @see {@link CreateRotationCommand} */ - public createRotation( + createRotation( args: CreateRotationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRotation( - args: CreateRotationCommandInput, - cb: (err: any, data?: CreateRotationCommandOutput) => void - ): void; - public createRotation( + createRotation(args: CreateRotationCommandInput, cb: (err: any, data?: CreateRotationCommandOutput) => void): void; + createRotation( args: CreateRotationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRotationCommandOutput) => void ): void; - public createRotation( - args: CreateRotationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRotationCommandOutput) => void), - cb?: (err: any, data?: CreateRotationCommandOutput) => void - ): Promise | void { - const command = new CreateRotationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an override for a rotation in an on-call schedule.

+ * @see {@link CreateRotationOverrideCommand} */ - public createRotationOverride( + createRotationOverride( args: CreateRotationOverrideCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRotationOverride( + createRotationOverride( args: CreateRotationOverrideCommandInput, cb: (err: any, data?: CreateRotationOverrideCommandOutput) => void ): void; - public createRotationOverride( + createRotationOverride( args: CreateRotationOverrideCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRotationOverrideCommandOutput) => void ): void; - public createRotationOverride( - args: CreateRotationOverrideCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRotationOverrideCommandOutput) => void), - cb?: (err: any, data?: CreateRotationOverrideCommandOutput) => void - ): Promise | void { - const command = new CreateRotationOverrideCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

To no longer receive Incident Manager engagements to a contact channel, you can deactivate - * the channel.

+ * @see {@link DeactivateContactChannelCommand} */ - public deactivateContactChannel( + deactivateContactChannel( args: DeactivateContactChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deactivateContactChannel( + deactivateContactChannel( args: DeactivateContactChannelCommandInput, cb: (err: any, data?: DeactivateContactChannelCommandOutput) => void ): void; - public deactivateContactChannel( + deactivateContactChannel( args: DeactivateContactChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeactivateContactChannelCommandOutput) => void ): void; - public deactivateContactChannel( - args: DeactivateContactChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeactivateContactChannelCommandOutput) => void), - cb?: (err: any, data?: DeactivateContactChannelCommandOutput) => void - ): Promise | void { - const command = new DeactivateContactChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

To remove a contact from Incident Manager, you can delete the contact. Deleting a contact - * removes them from all escalation plans and related response plans. Deleting an escalation - * plan removes it from all related response plans. You will have to recreate the contact and - * its contact channels before you can use it again.

+ * @see {@link DeleteContactCommand} */ - public deleteContact( - args: DeleteContactCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteContact( - args: DeleteContactCommandInput, - cb: (err: any, data?: DeleteContactCommandOutput) => void - ): void; - public deleteContact( + deleteContact(args: DeleteContactCommandInput, options?: __HttpHandlerOptions): Promise; + deleteContact(args: DeleteContactCommandInput, cb: (err: any, data?: DeleteContactCommandOutput) => void): void; + deleteContact( args: DeleteContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteContactCommandOutput) => void ): void; - public deleteContact( - args: DeleteContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteContactCommandOutput) => void), - cb?: (err: any, data?: DeleteContactCommandOutput) => void - ): Promise | void { - const command = new DeleteContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

To no longer receive engagements on a contact channel, you can delete the channel from a - * contact. Deleting the contact channel removes it from the contact's engagement plan. If you - * delete the only contact channel for a contact, you won't be able to engage that contact - * during an incident.

+ * @see {@link DeleteContactChannelCommand} */ - public deleteContactChannel( + deleteContactChannel( args: DeleteContactChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteContactChannel( + deleteContactChannel( args: DeleteContactChannelCommandInput, cb: (err: any, data?: DeleteContactChannelCommandOutput) => void ): void; - public deleteContactChannel( + deleteContactChannel( args: DeleteContactChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteContactChannelCommandOutput) => void ): void; - public deleteContactChannel( - args: DeleteContactChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteContactChannelCommandOutput) => void), - cb?: (err: any, data?: DeleteContactChannelCommandOutput) => void - ): Promise | void { - const command = new DeleteContactChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a rotation from the system. If a rotation belongs to more than one on-call - * schedule, this operation deletes it from all of them.

+ * @see {@link DeleteRotationCommand} */ - public deleteRotation( + deleteRotation( args: DeleteRotationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRotation( - args: DeleteRotationCommandInput, - cb: (err: any, data?: DeleteRotationCommandOutput) => void - ): void; - public deleteRotation( + deleteRotation(args: DeleteRotationCommandInput, cb: (err: any, data?: DeleteRotationCommandOutput) => void): void; + deleteRotation( args: DeleteRotationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRotationCommandOutput) => void ): void; - public deleteRotation( - args: DeleteRotationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRotationCommandOutput) => void), - cb?: (err: any, data?: DeleteRotationCommandOutput) => void - ): Promise | void { - const command = new DeleteRotationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an existing override for an on-call rotation.

+ * @see {@link DeleteRotationOverrideCommand} */ - public deleteRotationOverride( + deleteRotationOverride( args: DeleteRotationOverrideCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRotationOverride( + deleteRotationOverride( args: DeleteRotationOverrideCommandInput, cb: (err: any, data?: DeleteRotationOverrideCommandOutput) => void ): void; - public deleteRotationOverride( + deleteRotationOverride( args: DeleteRotationOverrideCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRotationOverrideCommandOutput) => void ): void; - public deleteRotationOverride( - args: DeleteRotationOverrideCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRotationOverrideCommandOutput) => void), - cb?: (err: any, data?: DeleteRotationOverrideCommandOutput) => void - ): Promise | void { - const command = new DeleteRotationOverrideCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Incident Manager uses engagements to engage contacts and escalation plans during an incident. - * Use this command to describe the engagement that occurred during an incident.

+ * @see {@link DescribeEngagementCommand} */ - public describeEngagement( + describeEngagement( args: DescribeEngagementCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEngagement( + describeEngagement( args: DescribeEngagementCommandInput, cb: (err: any, data?: DescribeEngagementCommandOutput) => void ): void; - public describeEngagement( + describeEngagement( args: DescribeEngagementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEngagementCommandOutput) => void ): void; - public describeEngagement( - args: DescribeEngagementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEngagementCommandOutput) => void), - cb?: (err: any, data?: DescribeEngagementCommandOutput) => void - ): Promise | void { - const command = new DescribeEngagementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists details of the engagement to a contact channel.

+ * @see {@link DescribePageCommand} */ - public describePage( - args: DescribePageCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describePage(args: DescribePageCommandInput, cb: (err: any, data?: DescribePageCommandOutput) => void): void; - public describePage( + describePage(args: DescribePageCommandInput, options?: __HttpHandlerOptions): Promise; + describePage(args: DescribePageCommandInput, cb: (err: any, data?: DescribePageCommandOutput) => void): void; + describePage( args: DescribePageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePageCommandOutput) => void ): void; - public describePage( - args: DescribePageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePageCommandOutput) => void), - cb?: (err: any, data?: DescribePageCommandOutput) => void - ): Promise | void { - const command = new DescribePageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the specified contact or escalation plan.

+ * @see {@link GetContactCommand} */ - public getContact(args: GetContactCommandInput, options?: __HttpHandlerOptions): Promise; - public getContact(args: GetContactCommandInput, cb: (err: any, data?: GetContactCommandOutput) => void): void; - public getContact( + getContact(args: GetContactCommandInput, options?: __HttpHandlerOptions): Promise; + getContact(args: GetContactCommandInput, cb: (err: any, data?: GetContactCommandOutput) => void): void; + getContact( args: GetContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContactCommandOutput) => void ): void; - public getContact( - args: GetContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContactCommandOutput) => void), - cb?: (err: any, data?: GetContactCommandOutput) => void - ): Promise | void { - const command = new GetContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List details about a specific contact channel.

+ * @see {@link GetContactChannelCommand} */ - public getContactChannel( + getContactChannel( args: GetContactChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public getContactChannel( + getContactChannel( args: GetContactChannelCommandInput, cb: (err: any, data?: GetContactChannelCommandOutput) => void ): void; - public getContactChannel( + getContactChannel( args: GetContactChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContactChannelCommandOutput) => void ): void; - public getContactChannel( - args: GetContactChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContactChannelCommandOutput) => void), - cb?: (err: any, data?: GetContactChannelCommandOutput) => void - ): Promise | void { - const command = new GetContactChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the resource policies attached to the specified contact or escalation - * plan.

+ * @see {@link GetContactPolicyCommand} */ - public getContactPolicy( + getContactPolicy( args: GetContactPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getContactPolicy( + getContactPolicy( args: GetContactPolicyCommandInput, cb: (err: any, data?: GetContactPolicyCommandOutput) => void ): void; - public getContactPolicy( + getContactPolicy( args: GetContactPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContactPolicyCommandOutput) => void ): void; - public getContactPolicy( - args: GetContactPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContactPolicyCommandOutput) => void), - cb?: (err: any, data?: GetContactPolicyCommandOutput) => void - ): Promise | void { - const command = new GetContactPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about an on-call rotation.

+ * @see {@link GetRotationCommand} */ - public getRotation(args: GetRotationCommandInput, options?: __HttpHandlerOptions): Promise; - public getRotation(args: GetRotationCommandInput, cb: (err: any, data?: GetRotationCommandOutput) => void): void; - public getRotation( + getRotation(args: GetRotationCommandInput, options?: __HttpHandlerOptions): Promise; + getRotation(args: GetRotationCommandInput, cb: (err: any, data?: GetRotationCommandOutput) => void): void; + getRotation( args: GetRotationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRotationCommandOutput) => void ): void; - public getRotation( - args: GetRotationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRotationCommandOutput) => void), - cb?: (err: any, data?: GetRotationCommandOutput) => void - ): Promise | void { - const command = new GetRotationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about an override to an on-call rotation.

+ * @see {@link GetRotationOverrideCommand} */ - public getRotationOverride( + getRotationOverride( args: GetRotationOverrideCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRotationOverride( + getRotationOverride( args: GetRotationOverrideCommandInput, cb: (err: any, data?: GetRotationOverrideCommandOutput) => void ): void; - public getRotationOverride( + getRotationOverride( args: GetRotationOverrideCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRotationOverrideCommandOutput) => void ): void; - public getRotationOverride( - args: GetRotationOverrideCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRotationOverrideCommandOutput) => void), - cb?: (err: any, data?: GetRotationOverrideCommandOutput) => void - ): Promise | void { - const command = new GetRotationOverrideCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all contact channels for the specified contact.

+ * @see {@link ListContactChannelsCommand} */ - public listContactChannels( + listContactChannels( args: ListContactChannelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listContactChannels( + listContactChannels( args: ListContactChannelsCommandInput, cb: (err: any, data?: ListContactChannelsCommandOutput) => void ): void; - public listContactChannels( + listContactChannels( args: ListContactChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListContactChannelsCommandOutput) => void ): void; - public listContactChannels( - args: ListContactChannelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListContactChannelsCommandOutput) => void), - cb?: (err: any, data?: ListContactChannelsCommandOutput) => void - ): Promise | void { - const command = new ListContactChannelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all contacts and escalation plans in Incident Manager.

+ * @see {@link ListContactsCommand} */ - public listContacts( - args: ListContactsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listContacts(args: ListContactsCommandInput, cb: (err: any, data?: ListContactsCommandOutput) => void): void; - public listContacts( + listContacts(args: ListContactsCommandInput, options?: __HttpHandlerOptions): Promise; + listContacts(args: ListContactsCommandInput, cb: (err: any, data?: ListContactsCommandOutput) => void): void; + listContacts( args: ListContactsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListContactsCommandOutput) => void ): void; - public listContacts( - args: ListContactsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListContactsCommandOutput) => void), - cb?: (err: any, data?: ListContactsCommandOutput) => void - ): Promise | void { - const command = new ListContactsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all engagements that have happened in an incident.

+ * @see {@link ListEngagementsCommand} */ - public listEngagements( + listEngagements( args: ListEngagementsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listEngagements( - args: ListEngagementsCommandInput, - cb: (err: any, data?: ListEngagementsCommandOutput) => void - ): void; - public listEngagements( + listEngagements(args: ListEngagementsCommandInput, cb: (err: any, data?: ListEngagementsCommandOutput) => void): void; + listEngagements( args: ListEngagementsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEngagementsCommandOutput) => void ): void; - public listEngagements( - args: ListEngagementsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListEngagementsCommandOutput) => void), - cb?: (err: any, data?: ListEngagementsCommandOutput) => void - ): Promise | void { - const command = new ListEngagementsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all of the engagements to contact channels that have been acknowledged.

+ * @see {@link ListPageReceiptsCommand} */ - public listPageReceipts( + listPageReceipts( args: ListPageReceiptsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPageReceipts( + listPageReceipts( args: ListPageReceiptsCommandInput, cb: (err: any, data?: ListPageReceiptsCommandOutput) => void ): void; - public listPageReceipts( + listPageReceipts( args: ListPageReceiptsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPageReceiptsCommandOutput) => void ): void; - public listPageReceipts( - args: ListPageReceiptsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPageReceiptsCommandOutput) => void), - cb?: (err: any, data?: ListPageReceiptsCommandOutput) => void - ): Promise | void { - const command = new ListPageReceiptsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the resolution path of an engagement. For example, the escalation plan engaged - * in an incident might target an on-call schedule that includes several contacts in a - * rotation, but just one contact on-call when the incident starts. The resolution path - * indicates the hierarchy of escalation plan > on-call schedule > - * contact.

+ * @see {@link ListPageResolutionsCommand} */ - public listPageResolutions( + listPageResolutions( args: ListPageResolutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPageResolutions( + listPageResolutions( args: ListPageResolutionsCommandInput, cb: (err: any, data?: ListPageResolutionsCommandOutput) => void ): void; - public listPageResolutions( + listPageResolutions( args: ListPageResolutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPageResolutionsCommandOutput) => void ): void; - public listPageResolutions( - args: ListPageResolutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPageResolutionsCommandOutput) => void), - cb?: (err: any, data?: ListPageResolutionsCommandOutput) => void - ): Promise | void { - const command = new ListPageResolutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the engagements to a contact's contact channels.

+ * @see {@link ListPagesByContactCommand} */ - public listPagesByContact( + listPagesByContact( args: ListPagesByContactCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPagesByContact( + listPagesByContact( args: ListPagesByContactCommandInput, cb: (err: any, data?: ListPagesByContactCommandOutput) => void ): void; - public listPagesByContact( + listPagesByContact( args: ListPagesByContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPagesByContactCommandOutput) => void ): void; - public listPagesByContact( - args: ListPagesByContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPagesByContactCommandOutput) => void), - cb?: (err: any, data?: ListPagesByContactCommandOutput) => void - ): Promise | void { - const command = new ListPagesByContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the engagements to contact channels that occurred by engaging a contact.

+ * @see {@link ListPagesByEngagementCommand} */ - public listPagesByEngagement( + listPagesByEngagement( args: ListPagesByEngagementCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPagesByEngagement( + listPagesByEngagement( args: ListPagesByEngagementCommandInput, cb: (err: any, data?: ListPagesByEngagementCommandOutput) => void ): void; - public listPagesByEngagement( + listPagesByEngagement( args: ListPagesByEngagementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPagesByEngagementCommandOutput) => void ): void; - public listPagesByEngagement( - args: ListPagesByEngagementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPagesByEngagementCommandOutput) => void), - cb?: (err: any, data?: ListPagesByEngagementCommandOutput) => void - ): Promise | void { - const command = new ListPagesByEngagementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of shifts based on rotation configuration parameters.

- * - *

The Incident Manager primarily uses this operation to populate the Preview calendar. It is not typically run by end users.

- *
+ * @see {@link ListPreviewRotationShiftsCommand} */ - public listPreviewRotationShifts( + listPreviewRotationShifts( args: ListPreviewRotationShiftsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPreviewRotationShifts( + listPreviewRotationShifts( args: ListPreviewRotationShiftsCommandInput, cb: (err: any, data?: ListPreviewRotationShiftsCommandOutput) => void ): void; - public listPreviewRotationShifts( + listPreviewRotationShifts( args: ListPreviewRotationShiftsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPreviewRotationShiftsCommandOutput) => void ): void; - public listPreviewRotationShifts( - args: ListPreviewRotationShiftsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPreviewRotationShiftsCommandOutput) => void), - cb?: (err: any, data?: ListPreviewRotationShiftsCommandOutput) => void - ): Promise | void { - const command = new ListPreviewRotationShiftsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of overrides currently specified for an on-call rotation.

+ * @see {@link ListRotationOverridesCommand} */ - public listRotationOverrides( + listRotationOverrides( args: ListRotationOverridesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRotationOverrides( + listRotationOverrides( args: ListRotationOverridesCommandInput, cb: (err: any, data?: ListRotationOverridesCommandOutput) => void ): void; - public listRotationOverrides( + listRotationOverrides( args: ListRotationOverridesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRotationOverridesCommandOutput) => void ): void; - public listRotationOverrides( - args: ListRotationOverridesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRotationOverridesCommandOutput) => void), - cb?: (err: any, data?: ListRotationOverridesCommandOutput) => void - ): Promise | void { - const command = new ListRotationOverridesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of on-call rotations.

+ * @see {@link ListRotationsCommand} */ - public listRotations( - args: ListRotationsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listRotations( - args: ListRotationsCommandInput, - cb: (err: any, data?: ListRotationsCommandOutput) => void - ): void; - public listRotations( + listRotations(args: ListRotationsCommandInput, options?: __HttpHandlerOptions): Promise; + listRotations(args: ListRotationsCommandInput, cb: (err: any, data?: ListRotationsCommandOutput) => void): void; + listRotations( args: ListRotationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRotationsCommandOutput) => void ): void; - public listRotations( - args: ListRotationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRotationsCommandOutput) => void), - cb?: (err: any, data?: ListRotationsCommandOutput) => void - ): Promise | void { - const command = new ListRotationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of shifts generated by an existing rotation in the system.

+ * @see {@link ListRotationShiftsCommand} */ - public listRotationShifts( + listRotationShifts( args: ListRotationShiftsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRotationShifts( + listRotationShifts( args: ListRotationShiftsCommandInput, cb: (err: any, data?: ListRotationShiftsCommandOutput) => void ): void; - public listRotationShifts( + listRotationShifts( args: ListRotationShiftsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRotationShiftsCommandOutput) => void ): void; - public listRotationShifts( - args: ListRotationShiftsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRotationShiftsCommandOutput) => void), - cb?: (err: any, data?: ListRotationShiftsCommandOutput) => void - ): Promise | void { - const command = new ListRotationShiftsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags of an escalation plan or contact.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a resource policy to the specified contact or escalation plan. The resource policy - * is used to share the contact or escalation plan using Resource Access Manager (RAM). For more information about cross-account sharing, see Setting up - * cross-account functionality.

+ * @see {@link PutContactPolicyCommand} */ - public putContactPolicy( + putContactPolicy( args: PutContactPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putContactPolicy( + putContactPolicy( args: PutContactPolicyCommandInput, cb: (err: any, data?: PutContactPolicyCommandOutput) => void ): void; - public putContactPolicy( + putContactPolicy( args: PutContactPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutContactPolicyCommandOutput) => void ): void; - public putContactPolicy( - args: PutContactPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutContactPolicyCommandOutput) => void), - cb?: (err: any, data?: PutContactPolicyCommandOutput) => void - ): Promise | void { - const command = new PutContactPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sends an activation code to a contact channel. The contact can use this code to activate - * the contact channel in the console or with the ActivateChannel operation. - * Incident Manager can't engage a contact channel until it has been activated.

+ * @see {@link SendActivationCodeCommand} */ - public sendActivationCode( + sendActivationCode( args: SendActivationCodeCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendActivationCode( + sendActivationCode( args: SendActivationCodeCommandInput, cb: (err: any, data?: SendActivationCodeCommandOutput) => void ): void; - public sendActivationCode( + sendActivationCode( args: SendActivationCodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendActivationCodeCommandOutput) => void ): void; - public sendActivationCode( - args: SendActivationCodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendActivationCodeCommandOutput) => void), - cb?: (err: any, data?: SendActivationCodeCommandOutput) => void - ): Promise | void { - const command = new SendActivationCodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts an engagement to a contact or escalation plan. The engagement engages each - * contact specified in the incident.

+ * @see {@link StartEngagementCommand} */ - public startEngagement( + startEngagement( args: StartEngagementCommandInput, options?: __HttpHandlerOptions ): Promise; - public startEngagement( - args: StartEngagementCommandInput, - cb: (err: any, data?: StartEngagementCommandOutput) => void - ): void; - public startEngagement( + startEngagement(args: StartEngagementCommandInput, cb: (err: any, data?: StartEngagementCommandOutput) => void): void; + startEngagement( args: StartEngagementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartEngagementCommandOutput) => void ): void; - public startEngagement( - args: StartEngagementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartEngagementCommandOutput) => void), - cb?: (err: any, data?: StartEngagementCommandOutput) => void - ): Promise | void { - const command = new StartEngagementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops an engagement before it finishes the final stage of the escalation plan or - * engagement plan. Further contacts aren't engaged.

+ * @see {@link StopEngagementCommand} */ - public stopEngagement( + stopEngagement( args: StopEngagementCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopEngagement( - args: StopEngagementCommandInput, - cb: (err: any, data?: StopEngagementCommandOutput) => void - ): void; - public stopEngagement( + stopEngagement(args: StopEngagementCommandInput, cb: (err: any, data?: StopEngagementCommandOutput) => void): void; + stopEngagement( args: StopEngagementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopEngagementCommandOutput) => void ): void; - public stopEngagement( - args: StopEngagementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopEngagementCommandOutput) => void), - cb?: (err: any, data?: StopEngagementCommandOutput) => void - ): Promise | void { - const command = new StopEngagementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Tags a contact or escalation plan. You can tag only contacts and escalation plans in the - * first region of your replication set.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from the specified resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the contact or escalation plan specified.

+ * @see {@link UpdateContactCommand} */ - public updateContact( - args: UpdateContactCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateContact( - args: UpdateContactCommandInput, - cb: (err: any, data?: UpdateContactCommandOutput) => void - ): void; - public updateContact( + updateContact(args: UpdateContactCommandInput, options?: __HttpHandlerOptions): Promise; + updateContact(args: UpdateContactCommandInput, cb: (err: any, data?: UpdateContactCommandOutput) => void): void; + updateContact( args: UpdateContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContactCommandOutput) => void ): void; - public updateContact( - args: UpdateContactCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateContactCommandOutput) => void), - cb?: (err: any, data?: UpdateContactCommandOutput) => void - ): Promise | void { - const command = new UpdateContactCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a contact's contact channel.

+ * @see {@link UpdateContactChannelCommand} */ - public updateContactChannel( + updateContactChannel( args: UpdateContactChannelCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateContactChannel( + updateContactChannel( args: UpdateContactChannelCommandInput, cb: (err: any, data?: UpdateContactChannelCommandOutput) => void ): void; - public updateContactChannel( + updateContactChannel( args: UpdateContactChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContactChannelCommandOutput) => void ): void; - public updateContactChannel( - args: UpdateContactChannelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateContactChannelCommandOutput) => void), - cb?: (err: any, data?: UpdateContactChannelCommandOutput) => void - ): Promise | void { - const command = new UpdateContactChannelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the information specified for an on-call rotation.

+ * @see {@link UpdateRotationCommand} */ - public updateRotation( + updateRotation( args: UpdateRotationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRotation( - args: UpdateRotationCommandInput, - cb: (err: any, data?: UpdateRotationCommandOutput) => void - ): void; - public updateRotation( + updateRotation(args: UpdateRotationCommandInput, cb: (err: any, data?: UpdateRotationCommandOutput) => void): void; + updateRotation( args: UpdateRotationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRotationCommandOutput) => void ): void; - public updateRotation( - args: UpdateRotationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRotationCommandOutput) => void), - cb?: (err: any, data?: UpdateRotationCommandOutput) => void - ): Promise | void { - const command = new UpdateRotationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Systems Manager Incident Manager is an incident management console designed to help users + * mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. + * An incident is any unplanned interruption or reduction in quality of services.

+ *

Incident Manager increases incident resolution by notifying responders of + * impact, highlighting relevant troubleshooting data, and providing collaboration tools to + * get services back up and running. To achieve the primary goal of reducing the + * time-to-resolution of critical incidents, Incident Manager automates response plans + * and enables responder team escalation.

+ */ +export class SSMContacts extends SSMContactsClient implements SSMContacts {} +createAggregatedClient(commands, SSMContacts); diff --git a/clients/client-ssm-incidents/src/SSMIncidents.ts b/clients/client-ssm-incidents/src/SSMIncidents.ts index c0ebe2fff51d..fa20cd0c961a 100644 --- a/clients/client-ssm-incidents/src/SSMIncidents.ts +++ b/clients/client-ssm-incidents/src/SSMIncidents.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -142,984 +143,524 @@ import { UpdateTimelineEventCommandInput, UpdateTimelineEventCommandOutput, } from "./commands/UpdateTimelineEventCommand"; -import { SSMIncidentsClient } from "./SSMIncidentsClient"; +import { SSMIncidentsClient, SSMIncidentsClientConfig } from "./SSMIncidentsClient"; -/** - * @public - *

Systems Manager Incident Manager is an incident management console designed to help users - * mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. An - * incident is any unplanned interruption or reduction in quality of services.

- *

Incident Manager increases incident resolution by notifying responders of impact, - * highlighting relevant troubleshooting data, and providing collaboration tools to get services - * back up and running. To achieve the primary goal of reducing the time-to-resolution of - * critical incidents, Incident Manager automates response plans and enables responder - * team escalation.

- */ -export class SSMIncidents extends SSMIncidentsClient { +const commands = { + CreateReplicationSetCommand, + CreateResponsePlanCommand, + CreateTimelineEventCommand, + DeleteIncidentRecordCommand, + DeleteReplicationSetCommand, + DeleteResourcePolicyCommand, + DeleteResponsePlanCommand, + DeleteTimelineEventCommand, + GetIncidentRecordCommand, + GetReplicationSetCommand, + GetResourcePoliciesCommand, + GetResponsePlanCommand, + GetTimelineEventCommand, + ListIncidentRecordsCommand, + ListRelatedItemsCommand, + ListReplicationSetsCommand, + ListResponsePlansCommand, + ListTagsForResourceCommand, + ListTimelineEventsCommand, + PutResourcePolicyCommand, + StartIncidentCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateDeletionProtectionCommand, + UpdateIncidentRecordCommand, + UpdateRelatedItemsCommand, + UpdateReplicationSetCommand, + UpdateResponsePlanCommand, + UpdateTimelineEventCommand, +}; + +export interface SSMIncidents { /** - * @public - *

A replication set replicates and encrypts your data to the provided Regions with the - * provided KMS key.

+ * @see {@link CreateReplicationSetCommand} */ - public createReplicationSet( + createReplicationSet( args: CreateReplicationSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createReplicationSet( + createReplicationSet( args: CreateReplicationSetCommandInput, cb: (err: any, data?: CreateReplicationSetCommandOutput) => void ): void; - public createReplicationSet( + createReplicationSet( args: CreateReplicationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReplicationSetCommandOutput) => void ): void; - public createReplicationSet( - args: CreateReplicationSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateReplicationSetCommandOutput) => void), - cb?: (err: any, data?: CreateReplicationSetCommandOutput) => void - ): Promise | void { - const command = new CreateReplicationSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a response plan that automates the initial response to incidents. A response plan - * engages contacts, starts chat channel collaboration, and initiates runbooks at the beginning - * of an incident.

+ * @see {@link CreateResponsePlanCommand} */ - public createResponsePlan( + createResponsePlan( args: CreateResponsePlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public createResponsePlan( + createResponsePlan( args: CreateResponsePlanCommandInput, cb: (err: any, data?: CreateResponsePlanCommandOutput) => void ): void; - public createResponsePlan( + createResponsePlan( args: CreateResponsePlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResponsePlanCommandOutput) => void ): void; - public createResponsePlan( - args: CreateResponsePlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateResponsePlanCommandOutput) => void), - cb?: (err: any, data?: CreateResponsePlanCommandOutput) => void - ): Promise | void { - const command = new CreateResponsePlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a custom timeline event on the incident details page of an incident record. - * Incident Manager automatically creates timeline events that mark key moments during an incident. - * You can create custom timeline events to mark important events that Incident Manager can detect - * automatically.

+ * @see {@link CreateTimelineEventCommand} */ - public createTimelineEvent( + createTimelineEvent( args: CreateTimelineEventCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTimelineEvent( + createTimelineEvent( args: CreateTimelineEventCommandInput, cb: (err: any, data?: CreateTimelineEventCommandOutput) => void ): void; - public createTimelineEvent( + createTimelineEvent( args: CreateTimelineEventCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTimelineEventCommandOutput) => void ): void; - public createTimelineEvent( - args: CreateTimelineEventCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTimelineEventCommandOutput) => void), - cb?: (err: any, data?: CreateTimelineEventCommandOutput) => void - ): Promise | void { - const command = new CreateTimelineEventCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete an incident record from Incident Manager.

+ * @see {@link DeleteIncidentRecordCommand} */ - public deleteIncidentRecord( + deleteIncidentRecord( args: DeleteIncidentRecordCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteIncidentRecord( + deleteIncidentRecord( args: DeleteIncidentRecordCommandInput, cb: (err: any, data?: DeleteIncidentRecordCommandOutput) => void ): void; - public deleteIncidentRecord( + deleteIncidentRecord( args: DeleteIncidentRecordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIncidentRecordCommandOutput) => void ): void; - public deleteIncidentRecord( - args: DeleteIncidentRecordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIncidentRecordCommandOutput) => void), - cb?: (err: any, data?: DeleteIncidentRecordCommandOutput) => void - ): Promise | void { - const command = new DeleteIncidentRecordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes all Regions in your replication set. Deleting the replication set deletes all - * Incident Manager data.

+ * @see {@link DeleteReplicationSetCommand} */ - public deleteReplicationSet( + deleteReplicationSet( args: DeleteReplicationSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteReplicationSet( + deleteReplicationSet( args: DeleteReplicationSetCommandInput, cb: (err: any, data?: DeleteReplicationSetCommandOutput) => void ): void; - public deleteReplicationSet( + deleteReplicationSet( args: DeleteReplicationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReplicationSetCommandOutput) => void ): void; - public deleteReplicationSet( - args: DeleteReplicationSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteReplicationSetCommandOutput) => void), - cb?: (err: any, data?: DeleteReplicationSetCommandOutput) => void - ): Promise | void { - const command = new DeleteReplicationSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the resource policy that Resource Access Manager uses to share your Incident Manager - * resource.

+ * @see {@link DeleteResourcePolicyCommand} */ - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( - args: DeleteResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified response plan. Deleting a response plan stops all linked CloudWatch alarms and EventBridge events from creating an incident with this response - * plan.

+ * @see {@link DeleteResponsePlanCommand} */ - public deleteResponsePlan( + deleteResponsePlan( args: DeleteResponsePlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResponsePlan( + deleteResponsePlan( args: DeleteResponsePlanCommandInput, cb: (err: any, data?: DeleteResponsePlanCommandOutput) => void ): void; - public deleteResponsePlan( + deleteResponsePlan( args: DeleteResponsePlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResponsePlanCommandOutput) => void ): void; - public deleteResponsePlan( - args: DeleteResponsePlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResponsePlanCommandOutput) => void), - cb?: (err: any, data?: DeleteResponsePlanCommandOutput) => void - ): Promise | void { - const command = new DeleteResponsePlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a timeline event from an incident.

+ * @see {@link DeleteTimelineEventCommand} */ - public deleteTimelineEvent( + deleteTimelineEvent( args: DeleteTimelineEventCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTimelineEvent( + deleteTimelineEvent( args: DeleteTimelineEventCommandInput, cb: (err: any, data?: DeleteTimelineEventCommandOutput) => void ): void; - public deleteTimelineEvent( + deleteTimelineEvent( args: DeleteTimelineEventCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTimelineEventCommandOutput) => void ): void; - public deleteTimelineEvent( - args: DeleteTimelineEventCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTimelineEventCommandOutput) => void), - cb?: (err: any, data?: DeleteTimelineEventCommandOutput) => void - ): Promise | void { - const command = new DeleteTimelineEventCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the details for the specified incident record.

+ * @see {@link GetIncidentRecordCommand} */ - public getIncidentRecord( + getIncidentRecord( args: GetIncidentRecordCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIncidentRecord( + getIncidentRecord( args: GetIncidentRecordCommandInput, cb: (err: any, data?: GetIncidentRecordCommandOutput) => void ): void; - public getIncidentRecord( + getIncidentRecord( args: GetIncidentRecordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIncidentRecordCommandOutput) => void ): void; - public getIncidentRecord( - args: GetIncidentRecordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIncidentRecordCommandOutput) => void), - cb?: (err: any, data?: GetIncidentRecordCommandOutput) => void - ): Promise | void { - const command = new GetIncidentRecordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieve your Incident Manager replication set.

+ * @see {@link GetReplicationSetCommand} */ - public getReplicationSet( + getReplicationSet( args: GetReplicationSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getReplicationSet( + getReplicationSet( args: GetReplicationSetCommandInput, cb: (err: any, data?: GetReplicationSetCommandOutput) => void ): void; - public getReplicationSet( + getReplicationSet( args: GetReplicationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReplicationSetCommandOutput) => void ): void; - public getReplicationSet( - args: GetReplicationSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetReplicationSetCommandOutput) => void), - cb?: (err: any, data?: GetReplicationSetCommandOutput) => void - ): Promise | void { - const command = new GetReplicationSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the resource policies attached to the specified response plan.

+ * @see {@link GetResourcePoliciesCommand} */ - public getResourcePolicies( + getResourcePolicies( args: GetResourcePoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourcePolicies( + getResourcePolicies( args: GetResourcePoliciesCommandInput, cb: (err: any, data?: GetResourcePoliciesCommandOutput) => void ): void; - public getResourcePolicies( + getResourcePolicies( args: GetResourcePoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePoliciesCommandOutput) => void ): void; - public getResourcePolicies( - args: GetResourcePoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourcePoliciesCommandOutput) => void), - cb?: (err: any, data?: GetResourcePoliciesCommandOutput) => void - ): Promise | void { - const command = new GetResourcePoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the details of the specified response plan.

+ * @see {@link GetResponsePlanCommand} */ - public getResponsePlan( + getResponsePlan( args: GetResponsePlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResponsePlan( - args: GetResponsePlanCommandInput, - cb: (err: any, data?: GetResponsePlanCommandOutput) => void - ): void; - public getResponsePlan( + getResponsePlan(args: GetResponsePlanCommandInput, cb: (err: any, data?: GetResponsePlanCommandOutput) => void): void; + getResponsePlan( args: GetResponsePlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResponsePlanCommandOutput) => void ): void; - public getResponsePlan( - args: GetResponsePlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResponsePlanCommandOutput) => void), - cb?: (err: any, data?: GetResponsePlanCommandOutput) => void - ): Promise | void { - const command = new GetResponsePlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a timeline event based on its ID and incident record.

+ * @see {@link GetTimelineEventCommand} */ - public getTimelineEvent( + getTimelineEvent( args: GetTimelineEventCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTimelineEvent( + getTimelineEvent( args: GetTimelineEventCommandInput, cb: (err: any, data?: GetTimelineEventCommandOutput) => void ): void; - public getTimelineEvent( + getTimelineEvent( args: GetTimelineEventCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTimelineEventCommandOutput) => void ): void; - public getTimelineEvent( - args: GetTimelineEventCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTimelineEventCommandOutput) => void), - cb?: (err: any, data?: GetTimelineEventCommandOutput) => void - ): Promise | void { - const command = new GetTimelineEventCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all incident records in your account. Use this command to retrieve the Amazon - * Resource Name (ARN) of the incident record you want to update.

+ * @see {@link ListIncidentRecordsCommand} */ - public listIncidentRecords( + listIncidentRecords( args: ListIncidentRecordsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listIncidentRecords( + listIncidentRecords( args: ListIncidentRecordsCommandInput, cb: (err: any, data?: ListIncidentRecordsCommandOutput) => void ): void; - public listIncidentRecords( + listIncidentRecords( args: ListIncidentRecordsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIncidentRecordsCommandOutput) => void ): void; - public listIncidentRecords( - args: ListIncidentRecordsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIncidentRecordsCommandOutput) => void), - cb?: (err: any, data?: ListIncidentRecordsCommandOutput) => void - ): Promise | void { - const command = new ListIncidentRecordsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all related items for an incident record.

+ * @see {@link ListRelatedItemsCommand} */ - public listRelatedItems( + listRelatedItems( args: ListRelatedItemsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRelatedItems( + listRelatedItems( args: ListRelatedItemsCommandInput, cb: (err: any, data?: ListRelatedItemsCommandOutput) => void ): void; - public listRelatedItems( + listRelatedItems( args: ListRelatedItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRelatedItemsCommandOutput) => void ): void; - public listRelatedItems( - args: ListRelatedItemsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRelatedItemsCommandOutput) => void), - cb?: (err: any, data?: ListRelatedItemsCommandOutput) => void - ): Promise | void { - const command = new ListRelatedItemsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists details about the replication set configured in your account.

+ * @see {@link ListReplicationSetsCommand} */ - public listReplicationSets( + listReplicationSets( args: ListReplicationSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listReplicationSets( + listReplicationSets( args: ListReplicationSetsCommandInput, cb: (err: any, data?: ListReplicationSetsCommandOutput) => void ): void; - public listReplicationSets( + listReplicationSets( args: ListReplicationSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReplicationSetsCommandOutput) => void ): void; - public listReplicationSets( - args: ListReplicationSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListReplicationSetsCommandOutput) => void), - cb?: (err: any, data?: ListReplicationSetsCommandOutput) => void - ): Promise | void { - const command = new ListReplicationSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all response plans in your account.

+ * @see {@link ListResponsePlansCommand} */ - public listResponsePlans( + listResponsePlans( args: ListResponsePlansCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResponsePlans( + listResponsePlans( args: ListResponsePlansCommandInput, cb: (err: any, data?: ListResponsePlansCommandOutput) => void ): void; - public listResponsePlans( + listResponsePlans( args: ListResponsePlansCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResponsePlansCommandOutput) => void ): void; - public listResponsePlans( - args: ListResponsePlansCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResponsePlansCommandOutput) => void), - cb?: (err: any, data?: ListResponsePlansCommandOutput) => void - ): Promise | void { - const command = new ListResponsePlansCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags that are attached to the specified response plan.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists timeline events for the specified incident record.

+ * @see {@link ListTimelineEventsCommand} */ - public listTimelineEvents( + listTimelineEvents( args: ListTimelineEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTimelineEvents( + listTimelineEvents( args: ListTimelineEventsCommandInput, cb: (err: any, data?: ListTimelineEventsCommandOutput) => void ): void; - public listTimelineEvents( + listTimelineEvents( args: ListTimelineEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTimelineEventsCommandOutput) => void ): void; - public listTimelineEvents( - args: ListTimelineEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTimelineEventsCommandOutput) => void), - cb?: (err: any, data?: ListTimelineEventsCommandOutput) => void - ): Promise | void { - const command = new ListTimelineEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a resource policy to the specified response plan. The resource policy is used to - * share the response plan using Resource Access Manager (RAM). For more - * information about cross-account sharing, see Cross-Region and cross-account incident management.

+ * @see {@link PutResourcePolicyCommand} */ - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( - args: PutResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: PutResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new PutResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used to start an incident from CloudWatch alarms, EventBridge events, or - * manually.

+ * @see {@link StartIncidentCommand} */ - public startIncident( - args: StartIncidentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public startIncident( - args: StartIncidentCommandInput, - cb: (err: any, data?: StartIncidentCommandOutput) => void - ): void; - public startIncident( + startIncident(args: StartIncidentCommandInput, options?: __HttpHandlerOptions): Promise; + startIncident(args: StartIncidentCommandInput, cb: (err: any, data?: StartIncidentCommandOutput) => void): void; + startIncident( args: StartIncidentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartIncidentCommandOutput) => void ): void; - public startIncident( - args: StartIncidentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartIncidentCommandOutput) => void), - cb?: (err: any, data?: StartIncidentCommandOutput) => void - ): Promise | void { - const command = new StartIncidentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a tag to a response plan.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a tag from a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update deletion protection to either allow or deny deletion of the final Region in a - * replication set.

+ * @see {@link UpdateDeletionProtectionCommand} */ - public updateDeletionProtection( + updateDeletionProtection( args: UpdateDeletionProtectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDeletionProtection( + updateDeletionProtection( args: UpdateDeletionProtectionCommandInput, cb: (err: any, data?: UpdateDeletionProtectionCommandOutput) => void ): void; - public updateDeletionProtection( + updateDeletionProtection( args: UpdateDeletionProtectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDeletionProtectionCommandOutput) => void ): void; - public updateDeletionProtection( - args: UpdateDeletionProtectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDeletionProtectionCommandOutput) => void), - cb?: (err: any, data?: UpdateDeletionProtectionCommandOutput) => void - ): Promise | void { - const command = new UpdateDeletionProtectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update the details of an incident record. You can use this operation to update an incident - * record from the defined chat channel. For more information about using actions in chat - * channels, see Interacting through chat.

+ * @see {@link UpdateIncidentRecordCommand} */ - public updateIncidentRecord( + updateIncidentRecord( args: UpdateIncidentRecordCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateIncidentRecord( + updateIncidentRecord( args: UpdateIncidentRecordCommandInput, cb: (err: any, data?: UpdateIncidentRecordCommandOutput) => void ): void; - public updateIncidentRecord( + updateIncidentRecord( args: UpdateIncidentRecordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIncidentRecordCommandOutput) => void ): void; - public updateIncidentRecord( - args: UpdateIncidentRecordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateIncidentRecordCommandOutput) => void), - cb?: (err: any, data?: UpdateIncidentRecordCommandOutput) => void - ): Promise | void { - const command = new UpdateIncidentRecordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Add or remove related items from the related items tab of an incident record.

+ * @see {@link UpdateRelatedItemsCommand} */ - public updateRelatedItems( + updateRelatedItems( args: UpdateRelatedItemsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRelatedItems( + updateRelatedItems( args: UpdateRelatedItemsCommandInput, cb: (err: any, data?: UpdateRelatedItemsCommandOutput) => void ): void; - public updateRelatedItems( + updateRelatedItems( args: UpdateRelatedItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRelatedItemsCommandOutput) => void ): void; - public updateRelatedItems( - args: UpdateRelatedItemsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRelatedItemsCommandOutput) => void), - cb?: (err: any, data?: UpdateRelatedItemsCommandOutput) => void - ): Promise | void { - const command = new UpdateRelatedItemsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Add or delete Regions from your replication set.

+ * @see {@link UpdateReplicationSetCommand} */ - public updateReplicationSet( + updateReplicationSet( args: UpdateReplicationSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateReplicationSet( + updateReplicationSet( args: UpdateReplicationSetCommandInput, cb: (err: any, data?: UpdateReplicationSetCommandOutput) => void ): void; - public updateReplicationSet( + updateReplicationSet( args: UpdateReplicationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateReplicationSetCommandOutput) => void ): void; - public updateReplicationSet( - args: UpdateReplicationSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateReplicationSetCommandOutput) => void), - cb?: (err: any, data?: UpdateReplicationSetCommandOutput) => void - ): Promise | void { - const command = new UpdateReplicationSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified response plan.

+ * @see {@link UpdateResponsePlanCommand} */ - public updateResponsePlan( + updateResponsePlan( args: UpdateResponsePlanCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateResponsePlan( + updateResponsePlan( args: UpdateResponsePlanCommandInput, cb: (err: any, data?: UpdateResponsePlanCommandOutput) => void ): void; - public updateResponsePlan( + updateResponsePlan( args: UpdateResponsePlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResponsePlanCommandOutput) => void ): void; - public updateResponsePlan( - args: UpdateResponsePlanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResponsePlanCommandOutput) => void), - cb?: (err: any, data?: UpdateResponsePlanCommandOutput) => void - ): Promise | void { - const command = new UpdateResponsePlanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a timeline event. You can update events of type Custom Event.

+ * @see {@link UpdateTimelineEventCommand} */ - public updateTimelineEvent( + updateTimelineEvent( args: UpdateTimelineEventCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTimelineEvent( + updateTimelineEvent( args: UpdateTimelineEventCommandInput, cb: (err: any, data?: UpdateTimelineEventCommandOutput) => void ): void; - public updateTimelineEvent( + updateTimelineEvent( args: UpdateTimelineEventCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTimelineEventCommandOutput) => void ): void; - public updateTimelineEvent( - args: UpdateTimelineEventCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTimelineEventCommandOutput) => void), - cb?: (err: any, data?: UpdateTimelineEventCommandOutput) => void - ): Promise | void { - const command = new UpdateTimelineEventCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Systems Manager Incident Manager is an incident management console designed to help users + * mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. An + * incident is any unplanned interruption or reduction in quality of services.

+ *

Incident Manager increases incident resolution by notifying responders of impact, + * highlighting relevant troubleshooting data, and providing collaboration tools to get services + * back up and running. To achieve the primary goal of reducing the time-to-resolution of + * critical incidents, Incident Manager automates response plans and enables responder + * team escalation.

+ */ +export class SSMIncidents extends SSMIncidentsClient implements SSMIncidents {} +createAggregatedClient(commands, SSMIncidents); diff --git a/clients/client-ssm-sap/src/SsmSap.ts b/clients/client-ssm-sap/src/SsmSap.ts index 9718e134b502..e7941d77f4fa 100644 --- a/clients/client-ssm-sap/src/SsmSap.ts +++ b/clients/client-ssm-sap/src/SsmSap.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -78,569 +79,279 @@ import { UpdateApplicationSettingsCommandInput, UpdateApplicationSettingsCommandOutput, } from "./commands/UpdateApplicationSettingsCommand"; -import { SsmSapClient } from "./SsmSapClient"; +import { SsmSapClient, SsmSapClientConfig } from "./SsmSapClient"; -/** - * @public - *

This API reference provides descriptions, syntax, and other details about each of the - * actions and data types for AWS Systems Manager for SAP. The topic for each action shows - * the API request parameters and responses.

- */ -export class SsmSap extends SsmSapClient { +const commands = { + DeleteResourcePermissionCommand, + DeregisterApplicationCommand, + GetApplicationCommand, + GetComponentCommand, + GetDatabaseCommand, + GetOperationCommand, + GetResourcePermissionCommand, + ListApplicationsCommand, + ListComponentsCommand, + ListDatabasesCommand, + ListOperationsCommand, + ListTagsForResourceCommand, + PutResourcePermissionCommand, + RegisterApplicationCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateApplicationSettingsCommand, +}; + +export interface SsmSap { /** - * @public - *

Removes permissions associated with the target database.

+ * @see {@link DeleteResourcePermissionCommand} */ - public deleteResourcePermission( + deleteResourcePermission( args: DeleteResourcePermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourcePermission( + deleteResourcePermission( args: DeleteResourcePermissionCommandInput, cb: (err: any, data?: DeleteResourcePermissionCommandOutput) => void ): void; - public deleteResourcePermission( + deleteResourcePermission( args: DeleteResourcePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePermissionCommandOutput) => void ): void; - public deleteResourcePermission( - args: DeleteResourcePermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourcePermissionCommandOutput) => void), - cb?: (err: any, data?: DeleteResourcePermissionCommandOutput) => void - ): Promise | void { - const command = new DeleteResourcePermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deregister an SAP application with AWS Systems Manager for SAP. This action does not - * affect the existing setup of your SAP workloads on Amazon EC2.

+ * @see {@link DeregisterApplicationCommand} */ - public deregisterApplication( + deregisterApplication( args: DeregisterApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterApplication( + deregisterApplication( args: DeregisterApplicationCommandInput, cb: (err: any, data?: DeregisterApplicationCommandOutput) => void ): void; - public deregisterApplication( + deregisterApplication( args: DeregisterApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterApplicationCommandOutput) => void ): void; - public deregisterApplication( - args: DeregisterApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterApplicationCommandOutput) => void), - cb?: (err: any, data?: DeregisterApplicationCommandOutput) => void - ): Promise | void { - const command = new DeregisterApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets an application registered with AWS Systems Manager for SAP. It also returns the - * components of the application.

+ * @see {@link GetApplicationCommand} */ - public getApplication( + getApplication( args: GetApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getApplication( - args: GetApplicationCommandInput, - cb: (err: any, data?: GetApplicationCommandOutput) => void - ): void; - public getApplication( + getApplication(args: GetApplicationCommandInput, cb: (err: any, data?: GetApplicationCommandOutput) => void): void; + getApplication( args: GetApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetApplicationCommandOutput) => void ): void; - public getApplication( - args: GetApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetApplicationCommandOutput) => void), - cb?: (err: any, data?: GetApplicationCommandOutput) => void - ): Promise | void { - const command = new GetApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the component of an application registered with AWS Systems Manager for - * SAP.

+ * @see {@link GetComponentCommand} */ - public getComponent( - args: GetComponentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getComponent(args: GetComponentCommandInput, cb: (err: any, data?: GetComponentCommandOutput) => void): void; - public getComponent( + getComponent(args: GetComponentCommandInput, options?: __HttpHandlerOptions): Promise; + getComponent(args: GetComponentCommandInput, cb: (err: any, data?: GetComponentCommandOutput) => void): void; + getComponent( args: GetComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComponentCommandOutput) => void ): void; - public getComponent( - args: GetComponentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetComponentCommandOutput) => void), - cb?: (err: any, data?: GetComponentCommandOutput) => void - ): Promise | void { - const command = new GetComponentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the SAP HANA database of an application registered with AWS Systems Manager for - * SAP.

+ * @see {@link GetDatabaseCommand} */ - public getDatabase(args: GetDatabaseCommandInput, options?: __HttpHandlerOptions): Promise; - public getDatabase(args: GetDatabaseCommandInput, cb: (err: any, data?: GetDatabaseCommandOutput) => void): void; - public getDatabase( + getDatabase(args: GetDatabaseCommandInput, options?: __HttpHandlerOptions): Promise; + getDatabase(args: GetDatabaseCommandInput, cb: (err: any, data?: GetDatabaseCommandOutput) => void): void; + getDatabase( args: GetDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDatabaseCommandOutput) => void ): void; - public getDatabase( - args: GetDatabaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDatabaseCommandOutput) => void), - cb?: (err: any, data?: GetDatabaseCommandOutput) => void - ): Promise | void { - const command = new GetDatabaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the details of an operation by specifying the operation ID.

+ * @see {@link GetOperationCommand} */ - public getOperation( - args: GetOperationCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getOperation(args: GetOperationCommandInput, cb: (err: any, data?: GetOperationCommandOutput) => void): void; - public getOperation( + getOperation(args: GetOperationCommandInput, options?: __HttpHandlerOptions): Promise; + getOperation(args: GetOperationCommandInput, cb: (err: any, data?: GetOperationCommandOutput) => void): void; + getOperation( args: GetOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOperationCommandOutput) => void ): void; - public getOperation( - args: GetOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOperationCommandOutput) => void), - cb?: (err: any, data?: GetOperationCommandOutput) => void - ): Promise | void { - const command = new GetOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets permissions associated with the target database.

+ * @see {@link GetResourcePermissionCommand} */ - public getResourcePermission( + getResourcePermission( args: GetResourcePermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourcePermission( + getResourcePermission( args: GetResourcePermissionCommandInput, cb: (err: any, data?: GetResourcePermissionCommandOutput) => void ): void; - public getResourcePermission( + getResourcePermission( args: GetResourcePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePermissionCommandOutput) => void ): void; - public getResourcePermission( - args: GetResourcePermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourcePermissionCommandOutput) => void), - cb?: (err: any, data?: GetResourcePermissionCommandOutput) => void - ): Promise | void { - const command = new GetResourcePermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the applications registered with AWS Systems Manager for SAP.

+ * @see {@link ListApplicationsCommand} */ - public listApplications( + listApplications( args: ListApplicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listApplications( + listApplications( args: ListApplicationsCommandInput, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( + listApplications( args: ListApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationsCommandOutput) => void ): void; - public listApplications( - args: ListApplicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListApplicationsCommandOutput) => void), - cb?: (err: any, data?: ListApplicationsCommandOutput) => void - ): Promise | void { - const command = new ListApplicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the components registered with AWS Systems Manager for SAP.

+ * @see {@link ListComponentsCommand} */ - public listComponents( + listComponents( args: ListComponentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listComponents( - args: ListComponentsCommandInput, - cb: (err: any, data?: ListComponentsCommandOutput) => void - ): void; - public listComponents( + listComponents(args: ListComponentsCommandInput, cb: (err: any, data?: ListComponentsCommandOutput) => void): void; + listComponents( args: ListComponentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComponentsCommandOutput) => void ): void; - public listComponents( - args: ListComponentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListComponentsCommandOutput) => void), - cb?: (err: any, data?: ListComponentsCommandOutput) => void - ): Promise | void { - const command = new ListComponentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the SAP HANA databases of an application registered with AWS Systems Manager for - * SAP.

+ * @see {@link ListDatabasesCommand} */ - public listDatabases( - args: ListDatabasesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listDatabases( - args: ListDatabasesCommandInput, - cb: (err: any, data?: ListDatabasesCommandOutput) => void - ): void; - public listDatabases( + listDatabases(args: ListDatabasesCommandInput, options?: __HttpHandlerOptions): Promise; + listDatabases(args: ListDatabasesCommandInput, cb: (err: any, data?: ListDatabasesCommandOutput) => void): void; + listDatabases( args: ListDatabasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatabasesCommandOutput) => void ): void; - public listDatabases( - args: ListDatabasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatabasesCommandOutput) => void), - cb?: (err: any, data?: ListDatabasesCommandOutput) => void - ): Promise | void { - const command = new ListDatabasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the operations performed by AWS Systems Manager for SAP.

+ * @see {@link ListOperationsCommand} */ - public listOperations( + listOperations( args: ListOperationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOperations( - args: ListOperationsCommandInput, - cb: (err: any, data?: ListOperationsCommandOutput) => void - ): void; - public listOperations( + listOperations(args: ListOperationsCommandInput, cb: (err: any, data?: ListOperationsCommandOutput) => void): void; + listOperations( args: ListOperationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOperationsCommandOutput) => void ): void; - public listOperations( - args: ListOperationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOperationsCommandOutput) => void), - cb?: (err: any, data?: ListOperationsCommandOutput) => void - ): Promise | void { - const command = new ListOperationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all tags on an SAP HANA application and/or database registered with AWS Systems - * Manager for SAP.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds permissions to the target database.

+ * @see {@link PutResourcePermissionCommand} */ - public putResourcePermission( + putResourcePermission( args: PutResourcePermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResourcePermission( + putResourcePermission( args: PutResourcePermissionCommandInput, cb: (err: any, data?: PutResourcePermissionCommandOutput) => void ): void; - public putResourcePermission( + putResourcePermission( args: PutResourcePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePermissionCommandOutput) => void ): void; - public putResourcePermission( - args: PutResourcePermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourcePermissionCommandOutput) => void), - cb?: (err: any, data?: PutResourcePermissionCommandOutput) => void - ): Promise | void { - const command = new PutResourcePermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Register an SAP application with AWS Systems Manager for SAP. You must meet the - * following requirements before registering.

- *

The SAP application you want to register with AWS Systems Manager for SAP is running - * on Amazon EC2.

- *

AWS Systems Manager Agent must be setup on an Amazon EC2 instance along with the required - * IAM permissions.

- *

Amazon EC2 instance(s) must have access to the secrets created in AWS Secrets Manager to - * manage SAP applications and components.

+ * @see {@link RegisterApplicationCommand} */ - public registerApplication( + registerApplication( args: RegisterApplicationCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerApplication( + registerApplication( args: RegisterApplicationCommandInput, cb: (err: any, data?: RegisterApplicationCommandOutput) => void ): void; - public registerApplication( + registerApplication( args: RegisterApplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterApplicationCommandOutput) => void ): void; - public registerApplication( - args: RegisterApplicationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterApplicationCommandOutput) => void), - cb?: (err: any, data?: RegisterApplicationCommandOutput) => void - ): Promise | void { - const command = new RegisterApplicationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates tag for a resource by specifying the ARN.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete the tags for a resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the settings of an application registered with AWS Systems Manager for - * SAP.

+ * @see {@link UpdateApplicationSettingsCommand} */ - public updateApplicationSettings( + updateApplicationSettings( args: UpdateApplicationSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateApplicationSettings( + updateApplicationSettings( args: UpdateApplicationSettingsCommandInput, cb: (err: any, data?: UpdateApplicationSettingsCommandOutput) => void ): void; - public updateApplicationSettings( + updateApplicationSettings( args: UpdateApplicationSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateApplicationSettingsCommandOutput) => void ): void; - public updateApplicationSettings( - args: UpdateApplicationSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateApplicationSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateApplicationSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateApplicationSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

This API reference provides descriptions, syntax, and other details about each of the + * actions and data types for AWS Systems Manager for SAP. The topic for each action shows + * the API request parameters and responses.

+ */ +export class SsmSap extends SsmSapClient implements SsmSap {} +createAggregatedClient(commands, SsmSap); diff --git a/clients/client-ssm/src/SSM.ts b/clients/client-ssm/src/SSM.ts index 52bf28023b1b..63289db0fc5a 100644 --- a/clients/client-ssm/src/SSM.ts +++ b/clients/client-ssm/src/SSM.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -679,5218 +680,2418 @@ import { UpdateServiceSettingCommandInput, UpdateServiceSettingCommandOutput, } from "./commands/UpdateServiceSettingCommand"; -import { SSMClient } from "./SSMClient"; +import { SSMClient, SSMClientConfig } from "./SSMClient"; -/** - * @public - *

Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure - * end-to-end management solution for hybrid cloud environments that enables safe and secure - * operations at scale.

- *

This reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up Amazon Web Services Systems Manager.

- *

- * Related resources - *

- * - */ -export class SSM extends SSMClient { - /** - * @public - *

Adds or overwrites one or more tags for the specified resource. Tags - * are metadata that you can assign to your automations, documents, managed nodes, maintenance - * windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your - * resources in different ways, for example, by purpose, owner, or environment. Each tag consists of - * a key and an optional value, both of which you define. For example, you could define a set of - * tags for your account's managed nodes that helps you track each node's owner and stack level. For - * example:

- *
    - *
  • - *

    - * Key=Owner,Value=DbAdmin - *

    - *
  • - *
  • - *

    - * Key=Owner,Value=SysAdmin - *

    - *
  • - *
  • - *

    - * Key=Owner,Value=Dev - *

    - *
  • - *
  • - *

    - * Key=Stack,Value=Production - *

    - *
  • - *
  • - *

    - * Key=Stack,Value=Pre-Production - *

    - *
  • - *
  • - *

    - * Key=Stack,Value=Test - *

    - *
  • - *
- *

Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 - * tags.

- *

We recommend that you devise a set of tag keys that meets your needs for each resource type. - * Using a consistent set of tag keys makes it easier for you to manage your resources. You can - * search and filter the resources based on the tags you add. Tags don't have any semantic meaning - * to and are interpreted strictly as a string of characters.

- *

For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon EC2 - * resources in the Amazon EC2 User Guide.

- */ - public addTagsToResource( +const commands = { + AddTagsToResourceCommand, + AssociateOpsItemRelatedItemCommand, + CancelCommandCommand, + CancelMaintenanceWindowExecutionCommand, + CreateActivationCommand, + CreateAssociationCommand, + CreateAssociationBatchCommand, + CreateDocumentCommand, + CreateMaintenanceWindowCommand, + CreateOpsItemCommand, + CreateOpsMetadataCommand, + CreatePatchBaselineCommand, + CreateResourceDataSyncCommand, + DeleteActivationCommand, + DeleteAssociationCommand, + DeleteDocumentCommand, + DeleteInventoryCommand, + DeleteMaintenanceWindowCommand, + DeleteOpsMetadataCommand, + DeleteParameterCommand, + DeleteParametersCommand, + DeletePatchBaselineCommand, + DeleteResourceDataSyncCommand, + DeleteResourcePolicyCommand, + DeregisterManagedInstanceCommand, + DeregisterPatchBaselineForPatchGroupCommand, + DeregisterTargetFromMaintenanceWindowCommand, + DeregisterTaskFromMaintenanceWindowCommand, + DescribeActivationsCommand, + DescribeAssociationCommand, + DescribeAssociationExecutionsCommand, + DescribeAssociationExecutionTargetsCommand, + DescribeAutomationExecutionsCommand, + DescribeAutomationStepExecutionsCommand, + DescribeAvailablePatchesCommand, + DescribeDocumentCommand, + DescribeDocumentPermissionCommand, + DescribeEffectiveInstanceAssociationsCommand, + DescribeEffectivePatchesForPatchBaselineCommand, + DescribeInstanceAssociationsStatusCommand, + DescribeInstanceInformationCommand, + DescribeInstancePatchesCommand, + DescribeInstancePatchStatesCommand, + DescribeInstancePatchStatesForPatchGroupCommand, + DescribeInventoryDeletionsCommand, + DescribeMaintenanceWindowExecutionsCommand, + DescribeMaintenanceWindowExecutionTaskInvocationsCommand, + DescribeMaintenanceWindowExecutionTasksCommand, + DescribeMaintenanceWindowsCommand, + DescribeMaintenanceWindowScheduleCommand, + DescribeMaintenanceWindowsForTargetCommand, + DescribeMaintenanceWindowTargetsCommand, + DescribeMaintenanceWindowTasksCommand, + DescribeOpsItemsCommand, + DescribeParametersCommand, + DescribePatchBaselinesCommand, + DescribePatchGroupsCommand, + DescribePatchGroupStateCommand, + DescribePatchPropertiesCommand, + DescribeSessionsCommand, + DisassociateOpsItemRelatedItemCommand, + GetAutomationExecutionCommand, + GetCalendarStateCommand, + GetCommandInvocationCommand, + GetConnectionStatusCommand, + GetDefaultPatchBaselineCommand, + GetDeployablePatchSnapshotForInstanceCommand, + GetDocumentCommand, + GetInventoryCommand, + GetInventorySchemaCommand, + GetMaintenanceWindowCommand, + GetMaintenanceWindowExecutionCommand, + GetMaintenanceWindowExecutionTaskCommand, + GetMaintenanceWindowExecutionTaskInvocationCommand, + GetMaintenanceWindowTaskCommand, + GetOpsItemCommand, + GetOpsMetadataCommand, + GetOpsSummaryCommand, + GetParameterCommand, + GetParameterHistoryCommand, + GetParametersCommand, + GetParametersByPathCommand, + GetPatchBaselineCommand, + GetPatchBaselineForPatchGroupCommand, + GetResourcePoliciesCommand, + GetServiceSettingCommand, + LabelParameterVersionCommand, + ListAssociationsCommand, + ListAssociationVersionsCommand, + ListCommandInvocationsCommand, + ListCommandsCommand, + ListComplianceItemsCommand, + ListComplianceSummariesCommand, + ListDocumentMetadataHistoryCommand, + ListDocumentsCommand, + ListDocumentVersionsCommand, + ListInventoryEntriesCommand, + ListOpsItemEventsCommand, + ListOpsItemRelatedItemsCommand, + ListOpsMetadataCommand, + ListResourceComplianceSummariesCommand, + ListResourceDataSyncCommand, + ListTagsForResourceCommand, + ModifyDocumentPermissionCommand, + PutComplianceItemsCommand, + PutInventoryCommand, + PutParameterCommand, + PutResourcePolicyCommand, + RegisterDefaultPatchBaselineCommand, + RegisterPatchBaselineForPatchGroupCommand, + RegisterTargetWithMaintenanceWindowCommand, + RegisterTaskWithMaintenanceWindowCommand, + RemoveTagsFromResourceCommand, + ResetServiceSettingCommand, + ResumeSessionCommand, + SendAutomationSignalCommand, + SendCommandCommand, + StartAssociationsOnceCommand, + StartAutomationExecutionCommand, + StartChangeRequestExecutionCommand, + StartSessionCommand, + StopAutomationExecutionCommand, + TerminateSessionCommand, + UnlabelParameterVersionCommand, + UpdateAssociationCommand, + UpdateAssociationStatusCommand, + UpdateDocumentCommand, + UpdateDocumentDefaultVersionCommand, + UpdateDocumentMetadataCommand, + UpdateMaintenanceWindowCommand, + UpdateMaintenanceWindowTargetCommand, + UpdateMaintenanceWindowTaskCommand, + UpdateManagedInstanceRoleCommand, + UpdateOpsItemCommand, + UpdateOpsMetadataCommand, + UpdatePatchBaselineCommand, + UpdateResourceDataSyncCommand, + UpdateServiceSettingCommand, +}; + +export interface SSM { + /** + * @see {@link AddTagsToResourceCommand} + */ + addTagsToResource( args: AddTagsToResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public addTagsToResource( + addTagsToResource( args: AddTagsToResourceCommandInput, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void ): void; - public addTagsToResource( + addTagsToResource( args: AddTagsToResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void ): void; - public addTagsToResource( - args: AddTagsToResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddTagsToResourceCommandOutput) => void), - cb?: (err: any, data?: AddTagsToResourceCommandOutput) => void - ): Promise | void { - const command = new AddTagsToResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an - * Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are capabilities of - * Amazon Web Services Systems Manager.

- */ - public associateOpsItemRelatedItem( + + /** + * @see {@link AssociateOpsItemRelatedItemCommand} + */ + associateOpsItemRelatedItem( args: AssociateOpsItemRelatedItemCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateOpsItemRelatedItem( + associateOpsItemRelatedItem( args: AssociateOpsItemRelatedItemCommandInput, cb: (err: any, data?: AssociateOpsItemRelatedItemCommandOutput) => void ): void; - public associateOpsItemRelatedItem( + associateOpsItemRelatedItem( args: AssociateOpsItemRelatedItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateOpsItemRelatedItemCommandOutput) => void ): void; - public associateOpsItemRelatedItem( - args: AssociateOpsItemRelatedItemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateOpsItemRelatedItemCommandOutput) => void), - cb?: (err: any, data?: AssociateOpsItemRelatedItemCommandOutput) => void - ): Promise | void { - const command = new AssociateOpsItemRelatedItemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Attempts to cancel the command specified by the Command ID. There is no guarantee that the - * command will be terminated and the underlying process stopped.

- */ - public cancelCommand( - args: CancelCommandCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public cancelCommand( - args: CancelCommandCommandInput, - cb: (err: any, data?: CancelCommandCommandOutput) => void - ): void; - public cancelCommand( + + /** + * @see {@link CancelCommandCommand} + */ + cancelCommand(args: CancelCommandCommandInput, options?: __HttpHandlerOptions): Promise; + cancelCommand(args: CancelCommandCommandInput, cb: (err: any, data?: CancelCommandCommandOutput) => void): void; + cancelCommand( args: CancelCommandCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelCommandCommandOutput) => void ): void; - public cancelCommand( - args: CancelCommandCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelCommandCommandOutput) => void), - cb?: (err: any, data?: CancelCommandCommandOutput) => void - ): Promise | void { - const command = new CancelCommandCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops a maintenance window execution that is already in progress and cancels any tasks in - * the window that haven't already starting running. Tasks already in progress will continue to - * completion.

- */ - public cancelMaintenanceWindowExecution( + + /** + * @see {@link CancelMaintenanceWindowExecutionCommand} + */ + cancelMaintenanceWindowExecution( args: CancelMaintenanceWindowExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelMaintenanceWindowExecution( + cancelMaintenanceWindowExecution( args: CancelMaintenanceWindowExecutionCommandInput, cb: (err: any, data?: CancelMaintenanceWindowExecutionCommandOutput) => void ): void; - public cancelMaintenanceWindowExecution( + cancelMaintenanceWindowExecution( args: CancelMaintenanceWindowExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelMaintenanceWindowExecutionCommandOutput) => void ): void; - public cancelMaintenanceWindowExecution( - args: CancelMaintenanceWindowExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelMaintenanceWindowExecutionCommandOutput) => void), - cb?: (err: any, data?: CancelMaintenanceWindowExecutionCommandOutput) => void - ): Promise | void { - const command = new CancelMaintenanceWindowExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Generates an activation code and activation ID you can use to register your on-premises - * servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with - * Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and - * ID when installing SSM Agent on machines in your hybrid environment. For more information about - * requirements for managing on-premises machines using Systems Manager, see Setting up - * Amazon Web Services Systems Manager for hybrid environments in the Amazon Web Services Systems Manager User Guide.

- * - *

Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are - * configured for Systems Manager are all called managed nodes.

- *
- */ - public createActivation( + + /** + * @see {@link CreateActivationCommand} + */ + createActivation( args: CreateActivationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createActivation( + createActivation( args: CreateActivationCommandInput, cb: (err: any, data?: CreateActivationCommandOutput) => void ): void; - public createActivation( + createActivation( args: CreateActivationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateActivationCommandOutput) => void ): void; - public createActivation( - args: CreateActivationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateActivationCommandOutput) => void), - cb?: (err: any, data?: CreateActivationCommandOutput) => void - ): Promise | void { - const command = new CreateActivationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

A State Manager association defines the state that you want to maintain on your managed - * nodes. For example, an association can specify that anti-virus software must be installed and - * running on your managed nodes, or that certain ports must be closed. For static targets, the - * association specifies a schedule for when the configuration is reapplied. For dynamic targets, - * such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of - * Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The - * association also specifies actions to take when applying the configuration. For example, an - * association for anti-virus software might run once a day. If the software isn't installed, then - * State Manager installs it. If the software is installed, but the service isn't running, then the - * association might instruct State Manager to start the service.

- */ - public createAssociation( + + /** + * @see {@link CreateAssociationCommand} + */ + createAssociation( args: CreateAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAssociation( + createAssociation( args: CreateAssociationCommandInput, cb: (err: any, data?: CreateAssociationCommandOutput) => void ): void; - public createAssociation( + createAssociation( args: CreateAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAssociationCommandOutput) => void ): void; - public createAssociation( - args: CreateAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAssociationCommandOutput) => void), - cb?: (err: any, data?: CreateAssociationCommandOutput) => void - ): Promise | void { - const command = new CreateAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes - * or targets.

- *

When you associate a document with one or more managed nodes using IDs or tags, Amazon Web Services Systems Manager - * Agent (SSM Agent) running on the managed node processes the document and configures the node as - * specified.

- *

If you associate a document with a managed node that already has an associated document, the - * system returns the AssociationAlreadyExists exception.

- */ - public createAssociationBatch( + + /** + * @see {@link CreateAssociationBatchCommand} + */ + createAssociationBatch( args: CreateAssociationBatchCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAssociationBatch( + createAssociationBatch( args: CreateAssociationBatchCommandInput, cb: (err: any, data?: CreateAssociationBatchCommandOutput) => void ): void; - public createAssociationBatch( + createAssociationBatch( args: CreateAssociationBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAssociationBatchCommandOutput) => void ): void; - public createAssociationBatch( - args: CreateAssociationBatchCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAssociationBatchCommandOutput) => void), - cb?: (err: any, data?: CreateAssociationBatchCommandOutput) => void - ): Promise | void { - const command = new CreateAssociationBatchCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs - * on your managed nodes. For more information about SSM documents, including information about - * supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents in the - * Amazon Web Services Systems Manager User Guide.

- */ - public createDocument( + + /** + * @see {@link CreateDocumentCommand} + */ + createDocument( args: CreateDocumentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDocument( - args: CreateDocumentCommandInput, - cb: (err: any, data?: CreateDocumentCommandOutput) => void - ): void; - public createDocument( + createDocument(args: CreateDocumentCommandInput, cb: (err: any, data?: CreateDocumentCommandOutput) => void): void; + createDocument( args: CreateDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDocumentCommandOutput) => void ): void; - public createDocument( - args: CreateDocumentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDocumentCommandOutput) => void), - cb?: (err: any, data?: CreateDocumentCommandOutput) => void - ): Promise | void { - const command = new CreateDocumentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new maintenance window.

- * - *

The value you specify for Duration determines the specific end time for the - * maintenance window based on the time it begins. No maintenance window tasks are permitted to - * start after the resulting endtime minus the number of hours you specify for Cutoff. - * For example, if the maintenance window starts at 3 PM, the duration is three hours, and the - * value you specify for Cutoff is one hour, no maintenance window tasks can start - * after 5 PM.

- *
- */ - public createMaintenanceWindow( + + /** + * @see {@link CreateMaintenanceWindowCommand} + */ + createMaintenanceWindow( args: CreateMaintenanceWindowCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMaintenanceWindow( + createMaintenanceWindow( args: CreateMaintenanceWindowCommandInput, cb: (err: any, data?: CreateMaintenanceWindowCommandOutput) => void ): void; - public createMaintenanceWindow( + createMaintenanceWindow( args: CreateMaintenanceWindowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMaintenanceWindowCommandOutput) => void ): void; - public createMaintenanceWindow( - args: CreateMaintenanceWindowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMaintenanceWindowCommandOutput) => void), - cb?: (err: any, data?: CreateMaintenanceWindowCommandOutput) => void - ): Promise | void { - const command = new CreateMaintenanceWindowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting started with - * OpsCenter in the Amazon Web Services Systems Manager User Guide.

- *

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and - * remediate operational issues impacting the performance and health of their Amazon Web Services resources. For - * more information, see Amazon Web Services Systems Manager OpsCenter in the - * Amazon Web Services Systems Manager User Guide.

- */ - public createOpsItem( - args: CreateOpsItemCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createOpsItem( - args: CreateOpsItemCommandInput, - cb: (err: any, data?: CreateOpsItemCommandOutput) => void - ): void; - public createOpsItem( + + /** + * @see {@link CreateOpsItemCommand} + */ + createOpsItem(args: CreateOpsItemCommandInput, options?: __HttpHandlerOptions): Promise; + createOpsItem(args: CreateOpsItemCommandInput, cb: (err: any, data?: CreateOpsItemCommandOutput) => void): void; + createOpsItem( args: CreateOpsItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateOpsItemCommandOutput) => void ): void; - public createOpsItem( - args: CreateOpsItemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateOpsItemCommandOutput) => void), - cb?: (err: any, data?: CreateOpsItemCommandOutput) => void - ): Promise | void { - const command = new CreateOpsItemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify - * information about the new application, including the application type.

- */ - public createOpsMetadata( + + /** + * @see {@link CreateOpsMetadataCommand} + */ + createOpsMetadata( args: CreateOpsMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public createOpsMetadata( + createOpsMetadata( args: CreateOpsMetadataCommandInput, cb: (err: any, data?: CreateOpsMetadataCommandOutput) => void ): void; - public createOpsMetadata( + createOpsMetadata( args: CreateOpsMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateOpsMetadataCommandOutput) => void ): void; - public createOpsMetadata( - args: CreateOpsMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateOpsMetadataCommandOutput) => void), - cb?: (err: any, data?: CreateOpsMetadataCommandOutput) => void - ): Promise | void { - const command = new CreateOpsMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a patch baseline.

- * - *

For information about valid key-value pairs in PatchFilters for each supported - * operating system type, see PatchFilter.

- *
- */ - public createPatchBaseline( + + /** + * @see {@link CreatePatchBaselineCommand} + */ + createPatchBaseline( args: CreatePatchBaselineCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPatchBaseline( + createPatchBaseline( args: CreatePatchBaselineCommandInput, cb: (err: any, data?: CreatePatchBaselineCommandOutput) => void ): void; - public createPatchBaseline( + createPatchBaseline( args: CreatePatchBaselineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePatchBaselineCommandOutput) => void ): void; - public createPatchBaseline( - args: CreatePatchBaselineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePatchBaselineCommandOutput) => void), - cb?: (err: any, data?: CreatePatchBaselineCommandOutput) => void - ): Promise | void { - const command = new CreatePatchBaselineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

A resource data sync helps you view data from multiple sources in a single location. - * Amazon Web Services Systems Manager offers two types of resource data sync: SyncToDestination and - * SyncFromSource.

- *

You can configure Systems Manager Inventory to use the SyncToDestination type to - * synchronize Inventory data from multiple Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Configuring resource data - * sync for Inventory in the Amazon Web Services Systems Manager User Guide.

- *

You can configure Systems Manager Explorer to use the SyncFromSource type to synchronize - * operational work items (OpsItems) and operational data (OpsData) from multiple Amazon Web Services Regions to a - * single Amazon S3 bucket. This type can synchronize OpsItems and OpsData from multiple - * Amazon Web Services accounts and Amazon Web Services Regions or EntireOrganization by using Organizations. For more - * information, see Setting up Systems Manager - * Explorer to display data from multiple accounts and Regions in the - * Amazon Web Services Systems Manager User Guide.

- *

A resource data sync is an asynchronous operation that returns immediately. After a - * successful initial sync is completed, the system continuously syncs data. To check the status of - * a sync, use the ListResourceDataSync.

- * - *

By default, data isn't encrypted in Amazon S3. We strongly recommend that you - * enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you - * secure access to the Amazon S3 bucket by creating a restrictive bucket policy.

- *
- */ - public createResourceDataSync( + + /** + * @see {@link CreateResourceDataSyncCommand} + */ + createResourceDataSync( args: CreateResourceDataSyncCommandInput, options?: __HttpHandlerOptions ): Promise; - public createResourceDataSync( + createResourceDataSync( args: CreateResourceDataSyncCommandInput, cb: (err: any, data?: CreateResourceDataSyncCommandOutput) => void ): void; - public createResourceDataSync( + createResourceDataSync( args: CreateResourceDataSyncCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResourceDataSyncCommandOutput) => void ): void; - public createResourceDataSync( - args: CreateResourceDataSyncCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateResourceDataSyncCommandOutput) => void), - cb?: (err: any, data?: CreateResourceDataSyncCommandOutput) => void - ): Promise | void { - const command = new CreateResourceDataSyncCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an activation. You aren't required to delete an activation. If you delete an - * activation, you can no longer use it to register additional managed nodes. Deleting an activation - * doesn't de-register managed nodes. You must manually de-register managed nodes.

- */ - public deleteActivation( + + /** + * @see {@link DeleteActivationCommand} + */ + deleteActivation( args: DeleteActivationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteActivation( + deleteActivation( args: DeleteActivationCommandInput, cb: (err: any, data?: DeleteActivationCommandOutput) => void ): void; - public deleteActivation( + deleteActivation( args: DeleteActivationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteActivationCommandOutput) => void ): void; - public deleteActivation( - args: DeleteActivationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteActivationCommandOutput) => void), - cb?: (err: any, data?: DeleteActivationCommandOutput) => void - ): Promise | void { - const command = new DeleteActivationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed - * node. If you created the association by using the Targets parameter, then you must - * delete the association by using the association ID.

- *

When you disassociate a document from a managed node, it doesn't change the configuration of - * the node. To change the configuration state of a managed node after you disassociate a document, - * you must create a new document with the desired configuration and associate it with the - * node.

- */ - public deleteAssociation( + + /** + * @see {@link DeleteAssociationCommand} + */ + deleteAssociation( args: DeleteAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAssociation( + deleteAssociation( args: DeleteAssociationCommandInput, cb: (err: any, data?: DeleteAssociationCommandOutput) => void ): void; - public deleteAssociation( + deleteAssociation( args: DeleteAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAssociationCommandOutput) => void ): void; - public deleteAssociation( - args: DeleteAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAssociationCommandOutput) => void), - cb?: (err: any, data?: DeleteAssociationCommandOutput) => void - ): Promise | void { - const command = new DeleteAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the - * document.

- *

Before you delete the document, we recommend that you use DeleteAssociation to disassociate all managed nodes that are associated with the document.

- */ - public deleteDocument( + + /** + * @see {@link DeleteDocumentCommand} + */ + deleteDocument( args: DeleteDocumentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDocument( - args: DeleteDocumentCommandInput, - cb: (err: any, data?: DeleteDocumentCommandOutput) => void - ): void; - public deleteDocument( + deleteDocument(args: DeleteDocumentCommandInput, cb: (err: any, data?: DeleteDocumentCommandOutput) => void): void; + deleteDocument( args: DeleteDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDocumentCommandOutput) => void ): void; - public deleteDocument( - args: DeleteDocumentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDocumentCommandOutput) => void), - cb?: (err: any, data?: DeleteDocumentCommandOutput) => void - ): Promise | void { - const command = new DeleteDocumentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete a custom inventory type or the data associated with a custom Inventory type. Deleting - * a custom inventory type is also referred to as deleting a custom inventory schema.

- */ - public deleteInventory( + + /** + * @see {@link DeleteInventoryCommand} + */ + deleteInventory( args: DeleteInventoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInventory( - args: DeleteInventoryCommandInput, - cb: (err: any, data?: DeleteInventoryCommandOutput) => void - ): void; - public deleteInventory( + deleteInventory(args: DeleteInventoryCommandInput, cb: (err: any, data?: DeleteInventoryCommandOutput) => void): void; + deleteInventory( args: DeleteInventoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInventoryCommandOutput) => void ): void; - public deleteInventory( - args: DeleteInventoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInventoryCommandOutput) => void), - cb?: (err: any, data?: DeleteInventoryCommandOutput) => void - ): Promise | void { - const command = new DeleteInventoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a maintenance window.

- */ - public deleteMaintenanceWindow( + + /** + * @see {@link DeleteMaintenanceWindowCommand} + */ + deleteMaintenanceWindow( args: DeleteMaintenanceWindowCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMaintenanceWindow( + deleteMaintenanceWindow( args: DeleteMaintenanceWindowCommandInput, cb: (err: any, data?: DeleteMaintenanceWindowCommandOutput) => void ): void; - public deleteMaintenanceWindow( + deleteMaintenanceWindow( args: DeleteMaintenanceWindowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMaintenanceWindowCommandOutput) => void ): void; - public deleteMaintenanceWindow( - args: DeleteMaintenanceWindowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMaintenanceWindowCommandOutput) => void), - cb?: (err: any, data?: DeleteMaintenanceWindowCommandOutput) => void - ): Promise | void { - const command = new DeleteMaintenanceWindowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete OpsMetadata related to an application.

- */ - public deleteOpsMetadata( + + /** + * @see {@link DeleteOpsMetadataCommand} + */ + deleteOpsMetadata( args: DeleteOpsMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteOpsMetadata( + deleteOpsMetadata( args: DeleteOpsMetadataCommandInput, cb: (err: any, data?: DeleteOpsMetadataCommandOutput) => void ): void; - public deleteOpsMetadata( + deleteOpsMetadata( args: DeleteOpsMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOpsMetadataCommandOutput) => void ): void; - public deleteOpsMetadata( - args: DeleteOpsMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteOpsMetadataCommandOutput) => void), - cb?: (err: any, data?: DeleteOpsMetadataCommandOutput) => void - ): Promise | void { - const command = new DeleteOpsMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds - * to create a parameter with the same name.

- */ - public deleteParameter( + + /** + * @see {@link DeleteParameterCommand} + */ + deleteParameter( args: DeleteParameterCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteParameter( - args: DeleteParameterCommandInput, - cb: (err: any, data?: DeleteParameterCommandOutput) => void - ): void; - public deleteParameter( + deleteParameter(args: DeleteParameterCommandInput, cb: (err: any, data?: DeleteParameterCommandOutput) => void): void; + deleteParameter( args: DeleteParameterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteParameterCommandOutput) => void ): void; - public deleteParameter( - args: DeleteParameterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteParameterCommandOutput) => void), - cb?: (err: any, data?: DeleteParameterCommandOutput) => void - ): Promise | void { - const command = new DeleteParameterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to - * create a parameter with the same name.

- */ - public deleteParameters( + + /** + * @see {@link DeleteParametersCommand} + */ + deleteParameters( args: DeleteParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteParameters( + deleteParameters( args: DeleteParametersCommandInput, cb: (err: any, data?: DeleteParametersCommandOutput) => void ): void; - public deleteParameters( + deleteParameters( args: DeleteParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteParametersCommandOutput) => void ): void; - public deleteParameters( - args: DeleteParametersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteParametersCommandOutput) => void), - cb?: (err: any, data?: DeleteParametersCommandOutput) => void - ): Promise | void { - const command = new DeleteParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a patch baseline.

- */ - public deletePatchBaseline( + + /** + * @see {@link DeletePatchBaselineCommand} + */ + deletePatchBaseline( args: DeletePatchBaselineCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePatchBaseline( + deletePatchBaseline( args: DeletePatchBaselineCommandInput, cb: (err: any, data?: DeletePatchBaselineCommandOutput) => void ): void; - public deletePatchBaseline( + deletePatchBaseline( args: DeletePatchBaselineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePatchBaselineCommandOutput) => void ): void; - public deletePatchBaseline( - args: DeletePatchBaselineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePatchBaselineCommandOutput) => void), - cb?: (err: any, data?: DeletePatchBaselineCommandOutput) => void - ): Promise | void { - const command = new DeletePatchBaselineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a resource data sync configuration. After the configuration is deleted, changes to - * data on managed nodes are no longer synced to or from the target. Deleting a sync configuration - * doesn't delete data.

- */ - public deleteResourceDataSync( + + /** + * @see {@link DeleteResourceDataSyncCommand} + */ + deleteResourceDataSync( args: DeleteResourceDataSyncCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourceDataSync( + deleteResourceDataSync( args: DeleteResourceDataSyncCommandInput, cb: (err: any, data?: DeleteResourceDataSyncCommandOutput) => void ): void; - public deleteResourceDataSync( + deleteResourceDataSync( args: DeleteResourceDataSyncCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourceDataSyncCommandOutput) => void ): void; - public deleteResourceDataSync( - args: DeleteResourceDataSyncCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourceDataSyncCommandOutput) => void), - cb?: (err: any, data?: DeleteResourceDataSyncCommandOutput) => void - ): Promise | void { - const command = new DeleteResourceDataSyncCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. Currently, - * OpsItemGroup is the only resource that supports Systems Manager resource policies. The - * resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with - * OpsCenter operational work items (OpsItems).

- */ - public deleteResourcePolicy( + + /** + * @see {@link DeleteResourcePolicyCommand} + */ + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( - args: DeleteResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes the server or virtual machine from the list of registered servers. You can - * reregister the node again at any time. If you don't plan to use Run Command on the server, we - * suggest uninstalling SSM Agent first.

- */ - public deregisterManagedInstance( + + /** + * @see {@link DeregisterManagedInstanceCommand} + */ + deregisterManagedInstance( args: DeregisterManagedInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterManagedInstance( + deregisterManagedInstance( args: DeregisterManagedInstanceCommandInput, cb: (err: any, data?: DeregisterManagedInstanceCommandOutput) => void ): void; - public deregisterManagedInstance( + deregisterManagedInstance( args: DeregisterManagedInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterManagedInstanceCommandOutput) => void ): void; - public deregisterManagedInstance( - args: DeregisterManagedInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterManagedInstanceCommandOutput) => void), - cb?: (err: any, data?: DeregisterManagedInstanceCommandOutput) => void - ): Promise | void { - const command = new DeregisterManagedInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a patch group from a patch baseline.

- */ - public deregisterPatchBaselineForPatchGroup( + + /** + * @see {@link DeregisterPatchBaselineForPatchGroupCommand} + */ + deregisterPatchBaselineForPatchGroup( args: DeregisterPatchBaselineForPatchGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterPatchBaselineForPatchGroup( + deregisterPatchBaselineForPatchGroup( args: DeregisterPatchBaselineForPatchGroupCommandInput, cb: (err: any, data?: DeregisterPatchBaselineForPatchGroupCommandOutput) => void ): void; - public deregisterPatchBaselineForPatchGroup( + deregisterPatchBaselineForPatchGroup( args: DeregisterPatchBaselineForPatchGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterPatchBaselineForPatchGroupCommandOutput) => void ): void; - public deregisterPatchBaselineForPatchGroup( - args: DeregisterPatchBaselineForPatchGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterPatchBaselineForPatchGroupCommandOutput) => void), - cb?: (err: any, data?: DeregisterPatchBaselineForPatchGroupCommandOutput) => void - ): Promise | void { - const command = new DeregisterPatchBaselineForPatchGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a target from a maintenance window.

- */ - public deregisterTargetFromMaintenanceWindow( + + /** + * @see {@link DeregisterTargetFromMaintenanceWindowCommand} + */ + deregisterTargetFromMaintenanceWindow( args: DeregisterTargetFromMaintenanceWindowCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterTargetFromMaintenanceWindow( + deregisterTargetFromMaintenanceWindow( args: DeregisterTargetFromMaintenanceWindowCommandInput, cb: (err: any, data?: DeregisterTargetFromMaintenanceWindowCommandOutput) => void ): void; - public deregisterTargetFromMaintenanceWindow( + deregisterTargetFromMaintenanceWindow( args: DeregisterTargetFromMaintenanceWindowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterTargetFromMaintenanceWindowCommandOutput) => void ): void; - public deregisterTargetFromMaintenanceWindow( - args: DeregisterTargetFromMaintenanceWindowCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeregisterTargetFromMaintenanceWindowCommandOutput) => void), - cb?: (err: any, data?: DeregisterTargetFromMaintenanceWindowCommandOutput) => void - ): Promise | void { - const command = new DeregisterTargetFromMaintenanceWindowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a task from a maintenance window.

- */ - public deregisterTaskFromMaintenanceWindow( + + /** + * @see {@link DeregisterTaskFromMaintenanceWindowCommand} + */ + deregisterTaskFromMaintenanceWindow( args: DeregisterTaskFromMaintenanceWindowCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterTaskFromMaintenanceWindow( + deregisterTaskFromMaintenanceWindow( args: DeregisterTaskFromMaintenanceWindowCommandInput, cb: (err: any, data?: DeregisterTaskFromMaintenanceWindowCommandOutput) => void ): void; - public deregisterTaskFromMaintenanceWindow( + deregisterTaskFromMaintenanceWindow( args: DeregisterTaskFromMaintenanceWindowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterTaskFromMaintenanceWindowCommandOutput) => void ): void; - public deregisterTaskFromMaintenanceWindow( - args: DeregisterTaskFromMaintenanceWindowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterTaskFromMaintenanceWindowCommandOutput) => void), - cb?: (err: any, data?: DeregisterTaskFromMaintenanceWindowCommandOutput) => void - ): Promise | void { - const command = new DeregisterTaskFromMaintenanceWindowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes details about the activation, such as the date and time the activation was - * created, its expiration date, the Identity and Access Management (IAM) role assigned to - * the managed nodes in the activation, and the number of nodes registered by using this - * activation.

- */ - public describeActivations( + + /** + * @see {@link DescribeActivationsCommand} + */ + describeActivations( args: DescribeActivationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeActivations( + describeActivations( args: DescribeActivationsCommandInput, cb: (err: any, data?: DescribeActivationsCommandOutput) => void ): void; - public describeActivations( + describeActivations( args: DescribeActivationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeActivationsCommandOutput) => void ): void; - public describeActivations( - args: DescribeActivationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeActivationsCommandOutput) => void), - cb?: (err: any, data?: DescribeActivationsCommandOutput) => void - ): Promise | void { - const command = new DescribeActivationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the association for the specified target or managed node. If you created the - * association by using the Targets parameter, then you must retrieve the association - * by using the association ID.

- */ - public describeAssociation( + + /** + * @see {@link DescribeAssociationCommand} + */ + describeAssociation( args: DescribeAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAssociation( + describeAssociation( args: DescribeAssociationCommandInput, cb: (err: any, data?: DescribeAssociationCommandOutput) => void ): void; - public describeAssociation( + describeAssociation( args: DescribeAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAssociationCommandOutput) => void ): void; - public describeAssociation( - args: DescribeAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAssociationCommandOutput) => void), - cb?: (err: any, data?: DescribeAssociationCommandOutput) => void - ): Promise | void { - const command = new DescribeAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Views all executions for a specific association ID.

- */ - public describeAssociationExecutions( + + /** + * @see {@link DescribeAssociationExecutionsCommand} + */ + describeAssociationExecutions( args: DescribeAssociationExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAssociationExecutions( + describeAssociationExecutions( args: DescribeAssociationExecutionsCommandInput, cb: (err: any, data?: DescribeAssociationExecutionsCommandOutput) => void ): void; - public describeAssociationExecutions( + describeAssociationExecutions( args: DescribeAssociationExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAssociationExecutionsCommandOutput) => void ): void; - public describeAssociationExecutions( - args: DescribeAssociationExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAssociationExecutionsCommandOutput) => void), - cb?: (err: any, data?: DescribeAssociationExecutionsCommandOutput) => void - ): Promise | void { - const command = new DescribeAssociationExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Views information about a specific execution of a specific association.

- */ - public describeAssociationExecutionTargets( + + /** + * @see {@link DescribeAssociationExecutionTargetsCommand} + */ + describeAssociationExecutionTargets( args: DescribeAssociationExecutionTargetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAssociationExecutionTargets( + describeAssociationExecutionTargets( args: DescribeAssociationExecutionTargetsCommandInput, cb: (err: any, data?: DescribeAssociationExecutionTargetsCommandOutput) => void ): void; - public describeAssociationExecutionTargets( + describeAssociationExecutionTargets( args: DescribeAssociationExecutionTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAssociationExecutionTargetsCommandOutput) => void ): void; - public describeAssociationExecutionTargets( - args: DescribeAssociationExecutionTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAssociationExecutionTargetsCommandOutput) => void), - cb?: (err: any, data?: DescribeAssociationExecutionTargetsCommandOutput) => void - ): Promise | void { - const command = new DescribeAssociationExecutionTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides details about all active and terminated Automation executions.

- */ - public describeAutomationExecutions( + + /** + * @see {@link DescribeAutomationExecutionsCommand} + */ + describeAutomationExecutions( args: DescribeAutomationExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAutomationExecutions( + describeAutomationExecutions( args: DescribeAutomationExecutionsCommandInput, cb: (err: any, data?: DescribeAutomationExecutionsCommandOutput) => void ): void; - public describeAutomationExecutions( + describeAutomationExecutions( args: DescribeAutomationExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAutomationExecutionsCommandOutput) => void ): void; - public describeAutomationExecutions( - args: DescribeAutomationExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAutomationExecutionsCommandOutput) => void), - cb?: (err: any, data?: DescribeAutomationExecutionsCommandOutput) => void - ): Promise | void { - const command = new DescribeAutomationExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Information about all active and terminated step executions in an Automation - * workflow.

- */ - public describeAutomationStepExecutions( + + /** + * @see {@link DescribeAutomationStepExecutionsCommand} + */ + describeAutomationStepExecutions( args: DescribeAutomationStepExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAutomationStepExecutions( + describeAutomationStepExecutions( args: DescribeAutomationStepExecutionsCommandInput, cb: (err: any, data?: DescribeAutomationStepExecutionsCommandOutput) => void ): void; - public describeAutomationStepExecutions( + describeAutomationStepExecutions( args: DescribeAutomationStepExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAutomationStepExecutionsCommandOutput) => void ): void; - public describeAutomationStepExecutions( - args: DescribeAutomationStepExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAutomationStepExecutionsCommandOutput) => void), - cb?: (err: any, data?: DescribeAutomationStepExecutionsCommandOutput) => void - ): Promise | void { - const command = new DescribeAutomationStepExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all patches eligible to be included in a patch baseline.

- */ - public describeAvailablePatches( + + /** + * @see {@link DescribeAvailablePatchesCommand} + */ + describeAvailablePatches( args: DescribeAvailablePatchesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAvailablePatches( + describeAvailablePatches( args: DescribeAvailablePatchesCommandInput, cb: (err: any, data?: DescribeAvailablePatchesCommandOutput) => void ): void; - public describeAvailablePatches( + describeAvailablePatches( args: DescribeAvailablePatchesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAvailablePatchesCommandOutput) => void ): void; - public describeAvailablePatches( - args: DescribeAvailablePatchesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAvailablePatchesCommandOutput) => void), - cb?: (err: any, data?: DescribeAvailablePatchesCommandOutput) => void - ): Promise | void { - const command = new DescribeAvailablePatchesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified Amazon Web Services Systems Manager document (SSM document).

- */ - public describeDocument( + + /** + * @see {@link DescribeDocumentCommand} + */ + describeDocument( args: DescribeDocumentCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDocument( + describeDocument( args: DescribeDocumentCommandInput, cb: (err: any, data?: DescribeDocumentCommandOutput) => void ): void; - public describeDocument( + describeDocument( args: DescribeDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDocumentCommandOutput) => void ): void; - public describeDocument( - args: DescribeDocumentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDocumentCommandOutput) => void), - cb?: (err: any, data?: DescribeDocumentCommandOutput) => void - ): Promise | void { - const command = new DescribeDocumentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the permissions for a Amazon Web Services Systems Manager document (SSM document). If you created the - * document, you are the owner. If a document is shared, it can either be shared privately (by - * specifying a user's Amazon Web Services account ID) or publicly (All).

- */ - public describeDocumentPermission( + + /** + * @see {@link DescribeDocumentPermissionCommand} + */ + describeDocumentPermission( args: DescribeDocumentPermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDocumentPermission( + describeDocumentPermission( args: DescribeDocumentPermissionCommandInput, cb: (err: any, data?: DescribeDocumentPermissionCommandOutput) => void ): void; - public describeDocumentPermission( + describeDocumentPermission( args: DescribeDocumentPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDocumentPermissionCommandOutput) => void ): void; - public describeDocumentPermission( - args: DescribeDocumentPermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDocumentPermissionCommandOutput) => void), - cb?: (err: any, data?: DescribeDocumentPermissionCommandOutput) => void - ): Promise | void { - const command = new DescribeDocumentPermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

All associations for the managed node(s).

- */ - public describeEffectiveInstanceAssociations( + + /** + * @see {@link DescribeEffectiveInstanceAssociationsCommand} + */ + describeEffectiveInstanceAssociations( args: DescribeEffectiveInstanceAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEffectiveInstanceAssociations( + describeEffectiveInstanceAssociations( args: DescribeEffectiveInstanceAssociationsCommandInput, cb: (err: any, data?: DescribeEffectiveInstanceAssociationsCommandOutput) => void ): void; - public describeEffectiveInstanceAssociations( + describeEffectiveInstanceAssociations( args: DescribeEffectiveInstanceAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEffectiveInstanceAssociationsCommandOutput) => void ): void; - public describeEffectiveInstanceAssociations( - args: DescribeEffectiveInstanceAssociationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeEffectiveInstanceAssociationsCommandOutput) => void), - cb?: (err: any, data?: DescribeEffectiveInstanceAssociationsCommandOutput) => void - ): Promise | void { - const command = new DescribeEffectiveInstanceAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the current effective patches (the patch and the approval state) for the specified - * patch baseline. Applies to patch baselines for Windows only.

- */ - public describeEffectivePatchesForPatchBaseline( + + /** + * @see {@link DescribeEffectivePatchesForPatchBaselineCommand} + */ + describeEffectivePatchesForPatchBaseline( args: DescribeEffectivePatchesForPatchBaselineCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEffectivePatchesForPatchBaseline( + describeEffectivePatchesForPatchBaseline( args: DescribeEffectivePatchesForPatchBaselineCommandInput, cb: (err: any, data?: DescribeEffectivePatchesForPatchBaselineCommandOutput) => void ): void; - public describeEffectivePatchesForPatchBaseline( + describeEffectivePatchesForPatchBaseline( args: DescribeEffectivePatchesForPatchBaselineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEffectivePatchesForPatchBaselineCommandOutput) => void ): void; - public describeEffectivePatchesForPatchBaseline( - args: DescribeEffectivePatchesForPatchBaselineCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeEffectivePatchesForPatchBaselineCommandOutput) => void), - cb?: (err: any, data?: DescribeEffectivePatchesForPatchBaselineCommandOutput) => void - ): Promise | void { - const command = new DescribeEffectivePatchesForPatchBaselineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

The status of the associations for the managed node(s).

- */ - public describeInstanceAssociationsStatus( + + /** + * @see {@link DescribeInstanceAssociationsStatusCommand} + */ + describeInstanceAssociationsStatus( args: DescribeInstanceAssociationsStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInstanceAssociationsStatus( + describeInstanceAssociationsStatus( args: DescribeInstanceAssociationsStatusCommandInput, cb: (err: any, data?: DescribeInstanceAssociationsStatusCommandOutput) => void ): void; - public describeInstanceAssociationsStatus( + describeInstanceAssociationsStatus( args: DescribeInstanceAssociationsStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstanceAssociationsStatusCommandOutput) => void ): void; - public describeInstanceAssociationsStatus( - args: DescribeInstanceAssociationsStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInstanceAssociationsStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeInstanceAssociationsStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeInstanceAssociationsStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more of your managed nodes, including information about the operating - * system platform, the version of SSM Agent installed on the managed node, node status, and so - * on.

- *

If you specify one or more managed node IDs, it returns information for those managed nodes. - * If you don't specify node IDs, it returns information for all your managed nodes. If you specify - * a node ID that isn't valid or a node that you don't own, you receive an error.

- * - *

The IamRole field for this API operation is the Identity and Access Management - * (IAM) role assigned to on-premises managed nodes. This call doesn't return the - * IAM role for EC2 instances.

- *
- */ - public describeInstanceInformation( + + /** + * @see {@link DescribeInstanceInformationCommand} + */ + describeInstanceInformation( args: DescribeInstanceInformationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInstanceInformation( + describeInstanceInformation( args: DescribeInstanceInformationCommandInput, cb: (err: any, data?: DescribeInstanceInformationCommandOutput) => void ): void; - public describeInstanceInformation( + describeInstanceInformation( args: DescribeInstanceInformationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstanceInformationCommandOutput) => void ): void; - public describeInstanceInformation( - args: DescribeInstanceInformationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInstanceInformationCommandOutput) => void), - cb?: (err: any, data?: DescribeInstanceInformationCommandOutput) => void - ): Promise | void { - const command = new DescribeInstanceInformationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about the patches on the specified managed node and their state - * relative to the patch baseline being used for the node.

- */ - public describeInstancePatches( + + /** + * @see {@link DescribeInstancePatchesCommand} + */ + describeInstancePatches( args: DescribeInstancePatchesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInstancePatches( + describeInstancePatches( args: DescribeInstancePatchesCommandInput, cb: (err: any, data?: DescribeInstancePatchesCommandOutput) => void ): void; - public describeInstancePatches( + describeInstancePatches( args: DescribeInstancePatchesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstancePatchesCommandOutput) => void ): void; - public describeInstancePatches( - args: DescribeInstancePatchesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInstancePatchesCommandOutput) => void), - cb?: (err: any, data?: DescribeInstancePatchesCommandOutput) => void - ): Promise | void { - const command = new DescribeInstancePatchesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the high-level patch state of one or more managed nodes.

- */ - public describeInstancePatchStates( + + /** + * @see {@link DescribeInstancePatchStatesCommand} + */ + describeInstancePatchStates( args: DescribeInstancePatchStatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInstancePatchStates( + describeInstancePatchStates( args: DescribeInstancePatchStatesCommandInput, cb: (err: any, data?: DescribeInstancePatchStatesCommandOutput) => void ): void; - public describeInstancePatchStates( + describeInstancePatchStates( args: DescribeInstancePatchStatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstancePatchStatesCommandOutput) => void ): void; - public describeInstancePatchStates( - args: DescribeInstancePatchStatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInstancePatchStatesCommandOutput) => void), - cb?: (err: any, data?: DescribeInstancePatchStatesCommandOutput) => void - ): Promise | void { - const command = new DescribeInstancePatchStatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the high-level patch state for the managed nodes in the specified patch - * group.

- */ - public describeInstancePatchStatesForPatchGroup( + + /** + * @see {@link DescribeInstancePatchStatesForPatchGroupCommand} + */ + describeInstancePatchStatesForPatchGroup( args: DescribeInstancePatchStatesForPatchGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInstancePatchStatesForPatchGroup( + describeInstancePatchStatesForPatchGroup( args: DescribeInstancePatchStatesForPatchGroupCommandInput, cb: (err: any, data?: DescribeInstancePatchStatesForPatchGroupCommandOutput) => void ): void; - public describeInstancePatchStatesForPatchGroup( + describeInstancePatchStatesForPatchGroup( args: DescribeInstancePatchStatesForPatchGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstancePatchStatesForPatchGroupCommandOutput) => void ): void; - public describeInstancePatchStatesForPatchGroup( - args: DescribeInstancePatchStatesForPatchGroupCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeInstancePatchStatesForPatchGroupCommandOutput) => void), - cb?: (err: any, data?: DescribeInstancePatchStatesForPatchGroupCommandOutput) => void - ): Promise | void { - const command = new DescribeInstancePatchStatesForPatchGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes a specific delete inventory operation.

- */ - public describeInventoryDeletions( + + /** + * @see {@link DescribeInventoryDeletionsCommand} + */ + describeInventoryDeletions( args: DescribeInventoryDeletionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInventoryDeletions( + describeInventoryDeletions( args: DescribeInventoryDeletionsCommandInput, cb: (err: any, data?: DescribeInventoryDeletionsCommandOutput) => void ): void; - public describeInventoryDeletions( + describeInventoryDeletions( args: DescribeInventoryDeletionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInventoryDeletionsCommandOutput) => void ): void; - public describeInventoryDeletions( - args: DescribeInventoryDeletionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInventoryDeletionsCommandOutput) => void), - cb?: (err: any, data?: DescribeInventoryDeletionsCommandOutput) => void - ): Promise | void { - const command = new DescribeInventoryDeletionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the executions of a maintenance window. This includes information about when the - * maintenance window was scheduled to be active, and information about tasks registered and run - * with the maintenance window.

- */ - public describeMaintenanceWindowExecutions( + + /** + * @see {@link DescribeMaintenanceWindowExecutionsCommand} + */ + describeMaintenanceWindowExecutions( args: DescribeMaintenanceWindowExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMaintenanceWindowExecutions( + describeMaintenanceWindowExecutions( args: DescribeMaintenanceWindowExecutionsCommandInput, cb: (err: any, data?: DescribeMaintenanceWindowExecutionsCommandOutput) => void ): void; - public describeMaintenanceWindowExecutions( + describeMaintenanceWindowExecutions( args: DescribeMaintenanceWindowExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMaintenanceWindowExecutionsCommandOutput) => void ): void; - public describeMaintenanceWindowExecutions( - args: DescribeMaintenanceWindowExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMaintenanceWindowExecutionsCommandOutput) => void), - cb?: (err: any, data?: DescribeMaintenanceWindowExecutionsCommandOutput) => void - ): Promise | void { - const command = new DescribeMaintenanceWindowExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the individual task executions (one per target) for a particular task run as part - * of a maintenance window execution.

- */ - public describeMaintenanceWindowExecutionTaskInvocations( + + /** + * @see {@link DescribeMaintenanceWindowExecutionTaskInvocationsCommand} + */ + describeMaintenanceWindowExecutionTaskInvocations( args: DescribeMaintenanceWindowExecutionTaskInvocationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMaintenanceWindowExecutionTaskInvocations( + describeMaintenanceWindowExecutionTaskInvocations( args: DescribeMaintenanceWindowExecutionTaskInvocationsCommandInput, cb: (err: any, data?: DescribeMaintenanceWindowExecutionTaskInvocationsCommandOutput) => void ): void; - public describeMaintenanceWindowExecutionTaskInvocations( + describeMaintenanceWindowExecutionTaskInvocations( args: DescribeMaintenanceWindowExecutionTaskInvocationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMaintenanceWindowExecutionTaskInvocationsCommandOutput) => void ): void; - public describeMaintenanceWindowExecutionTaskInvocations( - args: DescribeMaintenanceWindowExecutionTaskInvocationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeMaintenanceWindowExecutionTaskInvocationsCommandOutput) => void), - cb?: (err: any, data?: DescribeMaintenanceWindowExecutionTaskInvocationsCommandOutput) => void - ): Promise | void { - const command = new DescribeMaintenanceWindowExecutionTaskInvocationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

For a given maintenance window execution, lists the tasks that were run.

- */ - public describeMaintenanceWindowExecutionTasks( + + /** + * @see {@link DescribeMaintenanceWindowExecutionTasksCommand} + */ + describeMaintenanceWindowExecutionTasks( args: DescribeMaintenanceWindowExecutionTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMaintenanceWindowExecutionTasks( + describeMaintenanceWindowExecutionTasks( args: DescribeMaintenanceWindowExecutionTasksCommandInput, cb: (err: any, data?: DescribeMaintenanceWindowExecutionTasksCommandOutput) => void ): void; - public describeMaintenanceWindowExecutionTasks( + describeMaintenanceWindowExecutionTasks( args: DescribeMaintenanceWindowExecutionTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMaintenanceWindowExecutionTasksCommandOutput) => void ): void; - public describeMaintenanceWindowExecutionTasks( - args: DescribeMaintenanceWindowExecutionTasksCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeMaintenanceWindowExecutionTasksCommandOutput) => void), - cb?: (err: any, data?: DescribeMaintenanceWindowExecutionTasksCommandOutput) => void - ): Promise | void { - const command = new DescribeMaintenanceWindowExecutionTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the maintenance windows in an Amazon Web Services account.

- */ - public describeMaintenanceWindows( + + /** + * @see {@link DescribeMaintenanceWindowsCommand} + */ + describeMaintenanceWindows( args: DescribeMaintenanceWindowsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMaintenanceWindows( + describeMaintenanceWindows( args: DescribeMaintenanceWindowsCommandInput, cb: (err: any, data?: DescribeMaintenanceWindowsCommandOutput) => void ): void; - public describeMaintenanceWindows( + describeMaintenanceWindows( args: DescribeMaintenanceWindowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMaintenanceWindowsCommandOutput) => void ): void; - public describeMaintenanceWindows( - args: DescribeMaintenanceWindowsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMaintenanceWindowsCommandOutput) => void), - cb?: (err: any, data?: DescribeMaintenanceWindowsCommandOutput) => void - ): Promise | void { - const command = new DescribeMaintenanceWindowsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about upcoming executions of a maintenance window.

- */ - public describeMaintenanceWindowSchedule( + + /** + * @see {@link DescribeMaintenanceWindowScheduleCommand} + */ + describeMaintenanceWindowSchedule( args: DescribeMaintenanceWindowScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMaintenanceWindowSchedule( + describeMaintenanceWindowSchedule( args: DescribeMaintenanceWindowScheduleCommandInput, cb: (err: any, data?: DescribeMaintenanceWindowScheduleCommandOutput) => void ): void; - public describeMaintenanceWindowSchedule( + describeMaintenanceWindowSchedule( args: DescribeMaintenanceWindowScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMaintenanceWindowScheduleCommandOutput) => void ): void; - public describeMaintenanceWindowSchedule( - args: DescribeMaintenanceWindowScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMaintenanceWindowScheduleCommandOutput) => void), - cb?: (err: any, data?: DescribeMaintenanceWindowScheduleCommandOutput) => void - ): Promise | void { - const command = new DescribeMaintenanceWindowScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about the maintenance window targets or tasks that a managed node is - * associated with.

- */ - public describeMaintenanceWindowsForTarget( + + /** + * @see {@link DescribeMaintenanceWindowsForTargetCommand} + */ + describeMaintenanceWindowsForTarget( args: DescribeMaintenanceWindowsForTargetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMaintenanceWindowsForTarget( + describeMaintenanceWindowsForTarget( args: DescribeMaintenanceWindowsForTargetCommandInput, cb: (err: any, data?: DescribeMaintenanceWindowsForTargetCommandOutput) => void ): void; - public describeMaintenanceWindowsForTarget( + describeMaintenanceWindowsForTarget( args: DescribeMaintenanceWindowsForTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMaintenanceWindowsForTargetCommandOutput) => void ): void; - public describeMaintenanceWindowsForTarget( - args: DescribeMaintenanceWindowsForTargetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMaintenanceWindowsForTargetCommandOutput) => void), - cb?: (err: any, data?: DescribeMaintenanceWindowsForTargetCommandOutput) => void - ): Promise | void { - const command = new DescribeMaintenanceWindowsForTargetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the targets registered with the maintenance window.

- */ - public describeMaintenanceWindowTargets( + + /** + * @see {@link DescribeMaintenanceWindowTargetsCommand} + */ + describeMaintenanceWindowTargets( args: DescribeMaintenanceWindowTargetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMaintenanceWindowTargets( + describeMaintenanceWindowTargets( args: DescribeMaintenanceWindowTargetsCommandInput, cb: (err: any, data?: DescribeMaintenanceWindowTargetsCommandOutput) => void ): void; - public describeMaintenanceWindowTargets( + describeMaintenanceWindowTargets( args: DescribeMaintenanceWindowTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMaintenanceWindowTargetsCommandOutput) => void ): void; - public describeMaintenanceWindowTargets( - args: DescribeMaintenanceWindowTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMaintenanceWindowTargetsCommandOutput) => void), - cb?: (err: any, data?: DescribeMaintenanceWindowTargetsCommandOutput) => void - ): Promise | void { - const command = new DescribeMaintenanceWindowTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the tasks in a maintenance window.

- * - *

For maintenance window tasks without a specified target, you can't supply values for - * --max-errors and --max-concurrency. Instead, the system inserts a - * placeholder value of 1, which may be reported in the response to this command. - * These values don't affect the running of your task and can be ignored.

- *
- */ - public describeMaintenanceWindowTasks( + + /** + * @see {@link DescribeMaintenanceWindowTasksCommand} + */ + describeMaintenanceWindowTasks( args: DescribeMaintenanceWindowTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMaintenanceWindowTasks( + describeMaintenanceWindowTasks( args: DescribeMaintenanceWindowTasksCommandInput, cb: (err: any, data?: DescribeMaintenanceWindowTasksCommandOutput) => void ): void; - public describeMaintenanceWindowTasks( + describeMaintenanceWindowTasks( args: DescribeMaintenanceWindowTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMaintenanceWindowTasksCommandOutput) => void ): void; - public describeMaintenanceWindowTasks( - args: DescribeMaintenanceWindowTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMaintenanceWindowTasksCommandOutput) => void), - cb?: (err: any, data?: DescribeMaintenanceWindowTasksCommandOutput) => void - ): Promise | void { - const command = new DescribeMaintenanceWindowTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting started with - * OpsCenter in the Amazon Web Services Systems Manager User Guide.

- *

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and - * remediate operational issues impacting the performance and health of their Amazon Web Services resources. For - * more information, see OpsCenter in the - * Amazon Web Services Systems Manager User Guide.

- */ - public describeOpsItems( + + /** + * @see {@link DescribeOpsItemsCommand} + */ + describeOpsItems( args: DescribeOpsItemsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOpsItems( + describeOpsItems( args: DescribeOpsItemsCommandInput, cb: (err: any, data?: DescribeOpsItemsCommandOutput) => void ): void; - public describeOpsItems( + describeOpsItems( args: DescribeOpsItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOpsItemsCommandOutput) => void ): void; - public describeOpsItems( - args: DescribeOpsItemsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOpsItemsCommandOutput) => void), - cb?: (err: any, data?: DescribeOpsItemsCommandOutput) => void - ): Promise | void { - const command = new DescribeOpsItemsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get information about a parameter.

- *

Request results are returned on a best-effort basis. If you specify MaxResults - * in the request, the response includes information up to the limit specified. The number of items - * returned, however, can be between zero and the value of MaxResults. If the service - * reaches an internal limit while processing the results, it stops the operation and returns the - * matching values up to that point and a NextToken. You can specify the - * NextToken in a subsequent call to get the next set of results.

- * - *

If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must - * also update the key alias the parameter uses to reference KMS. Otherwise, - * DescribeParameters retrieves whatever the original key alias was - * referencing.

- *
- */ - public describeParameters( + + /** + * @see {@link DescribeParametersCommand} + */ + describeParameters( args: DescribeParametersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeParameters( + describeParameters( args: DescribeParametersCommandInput, cb: (err: any, data?: DescribeParametersCommandOutput) => void ): void; - public describeParameters( + describeParameters( args: DescribeParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeParametersCommandOutput) => void ): void; - public describeParameters( - args: DescribeParametersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeParametersCommandOutput) => void), - cb?: (err: any, data?: DescribeParametersCommandOutput) => void - ): Promise | void { - const command = new DescribeParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the patch baselines in your Amazon Web Services account.

- */ - public describePatchBaselines( + + /** + * @see {@link DescribePatchBaselinesCommand} + */ + describePatchBaselines( args: DescribePatchBaselinesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePatchBaselines( + describePatchBaselines( args: DescribePatchBaselinesCommandInput, cb: (err: any, data?: DescribePatchBaselinesCommandOutput) => void ): void; - public describePatchBaselines( + describePatchBaselines( args: DescribePatchBaselinesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePatchBaselinesCommandOutput) => void ): void; - public describePatchBaselines( - args: DescribePatchBaselinesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePatchBaselinesCommandOutput) => void), - cb?: (err: any, data?: DescribePatchBaselinesCommandOutput) => void - ): Promise | void { - const command = new DescribePatchBaselinesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all patch groups that have been registered with patch baselines.

- */ - public describePatchGroups( + + /** + * @see {@link DescribePatchGroupsCommand} + */ + describePatchGroups( args: DescribePatchGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePatchGroups( + describePatchGroups( args: DescribePatchGroupsCommandInput, cb: (err: any, data?: DescribePatchGroupsCommandOutput) => void ): void; - public describePatchGroups( + describePatchGroups( args: DescribePatchGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePatchGroupsCommandOutput) => void ): void; - public describePatchGroups( - args: DescribePatchGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePatchGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribePatchGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribePatchGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns high-level aggregated patch compliance state information for a patch group.

- */ - public describePatchGroupState( + + /** + * @see {@link DescribePatchGroupStateCommand} + */ + describePatchGroupState( args: DescribePatchGroupStateCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePatchGroupState( + describePatchGroupState( args: DescribePatchGroupStateCommandInput, cb: (err: any, data?: DescribePatchGroupStateCommandOutput) => void ): void; - public describePatchGroupState( + describePatchGroupState( args: DescribePatchGroupStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePatchGroupStateCommandOutput) => void ): void; - public describePatchGroupState( - args: DescribePatchGroupStateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePatchGroupStateCommandOutput) => void), - cb?: (err: any, data?: DescribePatchGroupStateCommandOutput) => void - ): Promise | void { - const command = new DescribePatchGroupStateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the properties of available patches organized by product, product family, - * classification, severity, and other properties of available patches. You can use the reported - * properties in the filters you specify in requests for operations such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.

- *

The following section lists the properties that can be used in filters for each major - * operating system type:

- *
- *
AMAZON_LINUX
- *
- *

Valid properties: PRODUCT | CLASSIFICATION | - * SEVERITY - *

- *
- *
AMAZON_LINUX_2
- *
- *

Valid properties: PRODUCT | CLASSIFICATION | - * SEVERITY - *

- *
- *
CENTOS
- *
- *

Valid properties: PRODUCT | CLASSIFICATION | - * SEVERITY - *

- *
- *
DEBIAN
- *
- *

Valid properties: PRODUCT | PRIORITY - *

- *
- *
MACOS
- *
- *

Valid properties: PRODUCT | CLASSIFICATION - *

- *
- *
ORACLE_LINUX
- *
- *

Valid properties: PRODUCT | CLASSIFICATION | - * SEVERITY - *

- *
- *
REDHAT_ENTERPRISE_LINUX
- *
- *

Valid properties: PRODUCT | CLASSIFICATION | - * SEVERITY - *

- *
- *
SUSE
- *
- *

Valid properties: PRODUCT | CLASSIFICATION | - * SEVERITY - *

- *
- *
UBUNTU
- *
- *

Valid properties: PRODUCT | PRIORITY - *

- *
- *
WINDOWS
- *
- *

Valid properties: PRODUCT | PRODUCT_FAMILY | - * CLASSIFICATION | MSRC_SEVERITY - *

- *
- *
- */ - public describePatchProperties( + + /** + * @see {@link DescribePatchPropertiesCommand} + */ + describePatchProperties( args: DescribePatchPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePatchProperties( + describePatchProperties( args: DescribePatchPropertiesCommandInput, cb: (err: any, data?: DescribePatchPropertiesCommandOutput) => void ): void; - public describePatchProperties( + describePatchProperties( args: DescribePatchPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePatchPropertiesCommandOutput) => void ): void; - public describePatchProperties( - args: DescribePatchPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePatchPropertiesCommandOutput) => void), - cb?: (err: any, data?: DescribePatchPropertiesCommandOutput) => void - ): Promise | void { - const command = new DescribePatchPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of all active sessions (both connected and disconnected) or terminated - * sessions from the past 30 days.

- */ - public describeSessions( + + /** + * @see {@link DescribeSessionsCommand} + */ + describeSessions( args: DescribeSessionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSessions( + describeSessions( args: DescribeSessionsCommandInput, cb: (err: any, data?: DescribeSessionsCommandOutput) => void ): void; - public describeSessions( + describeSessions( args: DescribeSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSessionsCommandOutput) => void ): void; - public describeSessions( - args: DescribeSessionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSessionsCommandOutput) => void), - cb?: (err: any, data?: DescribeSessionsCommandOutput) => void - ): Promise | void { - const command = new DescribeSessionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the association between an OpsItem and a related item. For example, this API - * operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a capability of - * Amazon Web Services Systems Manager.

- */ - public disassociateOpsItemRelatedItem( + + /** + * @see {@link DisassociateOpsItemRelatedItemCommand} + */ + disassociateOpsItemRelatedItem( args: DisassociateOpsItemRelatedItemCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateOpsItemRelatedItem( + disassociateOpsItemRelatedItem( args: DisassociateOpsItemRelatedItemCommandInput, cb: (err: any, data?: DisassociateOpsItemRelatedItemCommandOutput) => void ): void; - public disassociateOpsItemRelatedItem( + disassociateOpsItemRelatedItem( args: DisassociateOpsItemRelatedItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateOpsItemRelatedItemCommandOutput) => void ): void; - public disassociateOpsItemRelatedItem( - args: DisassociateOpsItemRelatedItemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateOpsItemRelatedItemCommandOutput) => void), - cb?: (err: any, data?: DisassociateOpsItemRelatedItemCommandOutput) => void - ): Promise | void { - const command = new DisassociateOpsItemRelatedItemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get detailed information about a particular Automation execution.

- */ - public getAutomationExecution( + + /** + * @see {@link GetAutomationExecutionCommand} + */ + getAutomationExecution( args: GetAutomationExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAutomationExecution( + getAutomationExecution( args: GetAutomationExecutionCommandInput, cb: (err: any, data?: GetAutomationExecutionCommandOutput) => void ): void; - public getAutomationExecution( + getAutomationExecution( args: GetAutomationExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAutomationExecutionCommandOutput) => void ): void; - public getAutomationExecution( - args: GetAutomationExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAutomationExecutionCommandOutput) => void), - cb?: (err: any, data?: GetAutomationExecutionCommandOutput) => void - ): Promise | void { - const command = new GetAutomationExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If - * you specify a time, GetCalendarState returns the state of the calendar at that - * specific time, and returns the next time that the change calendar state will transition. If you - * don't specify a time, GetCalendarState uses the current time. Change Calendar - * entries have two possible states: OPEN or CLOSED.

- *

If you specify more than one calendar in a request, the command returns the status of - * OPEN only if all calendars in the request are open. If one or more calendars in the - * request are closed, the status returned is CLOSED.

- *

For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.

- */ - public getCalendarState( + + /** + * @see {@link GetCalendarStateCommand} + */ + getCalendarState( args: GetCalendarStateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCalendarState( + getCalendarState( args: GetCalendarStateCommandInput, cb: (err: any, data?: GetCalendarStateCommandOutput) => void ): void; - public getCalendarState( + getCalendarState( args: GetCalendarStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCalendarStateCommandOutput) => void ): void; - public getCalendarState( - args: GetCalendarStateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCalendarStateCommandOutput) => void), - cb?: (err: any, data?: GetCalendarStateCommandOutput) => void - ): Promise | void { - const command = new GetCalendarStateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns detailed information about command execution for an invocation or plugin.

- *

- * GetCommandInvocation only gives the execution status of a plugin in a document. - * To get the command execution status on a specific managed node, use ListCommandInvocations. To get the command execution status across managed nodes, - * use ListCommands.

- */ - public getCommandInvocation( + + /** + * @see {@link GetCommandInvocationCommand} + */ + getCommandInvocation( args: GetCommandInvocationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCommandInvocation( + getCommandInvocation( args: GetCommandInvocationCommandInput, cb: (err: any, data?: GetCommandInvocationCommandOutput) => void ): void; - public getCommandInvocation( + getCommandInvocation( args: GetCommandInvocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCommandInvocationCommandOutput) => void ): void; - public getCommandInvocation( - args: GetCommandInvocationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCommandInvocationCommandOutput) => void), - cb?: (err: any, data?: GetCommandInvocationCommandOutput) => void - ): Promise | void { - const command = new GetCommandInvocationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the Session Manager connection status for a managed node to determine whether it is running - * and ready to receive Session Manager connections.

- */ - public getConnectionStatus( + + /** + * @see {@link GetConnectionStatusCommand} + */ + getConnectionStatus( args: GetConnectionStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConnectionStatus( + getConnectionStatus( args: GetConnectionStatusCommandInput, cb: (err: any, data?: GetConnectionStatusCommandOutput) => void ): void; - public getConnectionStatus( + getConnectionStatus( args: GetConnectionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConnectionStatusCommandOutput) => void ): void; - public getConnectionStatus( - args: GetConnectionStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConnectionStatusCommandOutput) => void), - cb?: (err: any, data?: GetConnectionStatusCommandOutput) => void - ): Promise | void { - const command = new GetConnectionStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the default patch baseline. Amazon Web Services Systems Manager supports creating multiple default patch - * baselines. For example, you can create a default patch baseline for each operating system.

- *

If you don't specify an operating system value, the default patch baseline for Windows is - * returned.

- */ - public getDefaultPatchBaseline( + + /** + * @see {@link GetDefaultPatchBaselineCommand} + */ + getDefaultPatchBaseline( args: GetDefaultPatchBaselineCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDefaultPatchBaseline( + getDefaultPatchBaseline( args: GetDefaultPatchBaselineCommandInput, cb: (err: any, data?: GetDefaultPatchBaselineCommandOutput) => void ): void; - public getDefaultPatchBaseline( + getDefaultPatchBaseline( args: GetDefaultPatchBaselineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDefaultPatchBaselineCommandOutput) => void ): void; - public getDefaultPatchBaseline( - args: GetDefaultPatchBaselineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDefaultPatchBaselineCommandOutput) => void), - cb?: (err: any, data?: GetDefaultPatchBaselineCommandOutput) => void - ): Promise | void { - const command = new GetDefaultPatchBaselineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the current snapshot for the patch baseline the managed node uses. This API is - * primarily used by the AWS-RunPatchBaseline Systems Manager document (SSM document).

- * - *

If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid - * this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of - * Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or - * command. For example, run the command using the AWS-RunShellScript document or the - * AWS-RunPowerShellScript document.

- *
- */ - public getDeployablePatchSnapshotForInstance( + + /** + * @see {@link GetDeployablePatchSnapshotForInstanceCommand} + */ + getDeployablePatchSnapshotForInstance( args: GetDeployablePatchSnapshotForInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDeployablePatchSnapshotForInstance( + getDeployablePatchSnapshotForInstance( args: GetDeployablePatchSnapshotForInstanceCommandInput, cb: (err: any, data?: GetDeployablePatchSnapshotForInstanceCommandOutput) => void ): void; - public getDeployablePatchSnapshotForInstance( + getDeployablePatchSnapshotForInstance( args: GetDeployablePatchSnapshotForInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeployablePatchSnapshotForInstanceCommandOutput) => void ): void; - public getDeployablePatchSnapshotForInstance( - args: GetDeployablePatchSnapshotForInstanceCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetDeployablePatchSnapshotForInstanceCommandOutput) => void), - cb?: (err: any, data?: GetDeployablePatchSnapshotForInstanceCommandOutput) => void - ): Promise | void { - const command = new GetDeployablePatchSnapshotForInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).

- */ - public getDocument(args: GetDocumentCommandInput, options?: __HttpHandlerOptions): Promise; - public getDocument(args: GetDocumentCommandInput, cb: (err: any, data?: GetDocumentCommandOutput) => void): void; - public getDocument( + + /** + * @see {@link GetDocumentCommand} + */ + getDocument(args: GetDocumentCommandInput, options?: __HttpHandlerOptions): Promise; + getDocument(args: GetDocumentCommandInput, cb: (err: any, data?: GetDocumentCommandOutput) => void): void; + getDocument( args: GetDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentCommandOutput) => void ): void; - public getDocument( - args: GetDocumentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDocumentCommandOutput) => void), - cb?: (err: any, data?: GetDocumentCommandOutput) => void - ): Promise | void { - const command = new GetDocumentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Query inventory information. This includes managed node status, such as Stopped - * or Terminated.

- */ - public getInventory( - args: GetInventoryCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getInventory(args: GetInventoryCommandInput, cb: (err: any, data?: GetInventoryCommandOutput) => void): void; - public getInventory( + + /** + * @see {@link GetInventoryCommand} + */ + getInventory(args: GetInventoryCommandInput, options?: __HttpHandlerOptions): Promise; + getInventory(args: GetInventoryCommandInput, cb: (err: any, data?: GetInventoryCommandOutput) => void): void; + getInventory( args: GetInventoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInventoryCommandOutput) => void ): void; - public getInventory( - args: GetInventoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInventoryCommandOutput) => void), - cb?: (err: any, data?: GetInventoryCommandOutput) => void - ): Promise | void { - const command = new GetInventoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Return a list of inventory type names for the account, or return a list of attribute names - * for a specific Inventory item type.

- */ - public getInventorySchema( + + /** + * @see {@link GetInventorySchemaCommand} + */ + getInventorySchema( args: GetInventorySchemaCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInventorySchema( + getInventorySchema( args: GetInventorySchemaCommandInput, cb: (err: any, data?: GetInventorySchemaCommandOutput) => void ): void; - public getInventorySchema( + getInventorySchema( args: GetInventorySchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInventorySchemaCommandOutput) => void ): void; - public getInventorySchema( - args: GetInventorySchemaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInventorySchemaCommandOutput) => void), - cb?: (err: any, data?: GetInventorySchemaCommandOutput) => void - ): Promise | void { - const command = new GetInventorySchemaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a maintenance window.

- */ - public getMaintenanceWindow( + + /** + * @see {@link GetMaintenanceWindowCommand} + */ + getMaintenanceWindow( args: GetMaintenanceWindowCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMaintenanceWindow( + getMaintenanceWindow( args: GetMaintenanceWindowCommandInput, cb: (err: any, data?: GetMaintenanceWindowCommandOutput) => void ): void; - public getMaintenanceWindow( + getMaintenanceWindow( args: GetMaintenanceWindowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMaintenanceWindowCommandOutput) => void ): void; - public getMaintenanceWindow( - args: GetMaintenanceWindowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMaintenanceWindowCommandOutput) => void), - cb?: (err: any, data?: GetMaintenanceWindowCommandOutput) => void - ): Promise | void { - const command = new GetMaintenanceWindowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves details about a specific a maintenance window execution.

- */ - public getMaintenanceWindowExecution( + + /** + * @see {@link GetMaintenanceWindowExecutionCommand} + */ + getMaintenanceWindowExecution( args: GetMaintenanceWindowExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMaintenanceWindowExecution( + getMaintenanceWindowExecution( args: GetMaintenanceWindowExecutionCommandInput, cb: (err: any, data?: GetMaintenanceWindowExecutionCommandOutput) => void ): void; - public getMaintenanceWindowExecution( + getMaintenanceWindowExecution( args: GetMaintenanceWindowExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMaintenanceWindowExecutionCommandOutput) => void ): void; - public getMaintenanceWindowExecution( - args: GetMaintenanceWindowExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMaintenanceWindowExecutionCommandOutput) => void), - cb?: (err: any, data?: GetMaintenanceWindowExecutionCommandOutput) => void - ): Promise | void { - const command = new GetMaintenanceWindowExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the details about a specific task run as part of a maintenance window - * execution.

- */ - public getMaintenanceWindowExecutionTask( + + /** + * @see {@link GetMaintenanceWindowExecutionTaskCommand} + */ + getMaintenanceWindowExecutionTask( args: GetMaintenanceWindowExecutionTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMaintenanceWindowExecutionTask( + getMaintenanceWindowExecutionTask( args: GetMaintenanceWindowExecutionTaskCommandInput, cb: (err: any, data?: GetMaintenanceWindowExecutionTaskCommandOutput) => void ): void; - public getMaintenanceWindowExecutionTask( + getMaintenanceWindowExecutionTask( args: GetMaintenanceWindowExecutionTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMaintenanceWindowExecutionTaskCommandOutput) => void ): void; - public getMaintenanceWindowExecutionTask( - args: GetMaintenanceWindowExecutionTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMaintenanceWindowExecutionTaskCommandOutput) => void), - cb?: (err: any, data?: GetMaintenanceWindowExecutionTaskCommandOutput) => void - ): Promise | void { - const command = new GetMaintenanceWindowExecutionTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about a specific task running on a specific target.

- */ - public getMaintenanceWindowExecutionTaskInvocation( + + /** + * @see {@link GetMaintenanceWindowExecutionTaskInvocationCommand} + */ + getMaintenanceWindowExecutionTaskInvocation( args: GetMaintenanceWindowExecutionTaskInvocationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMaintenanceWindowExecutionTaskInvocation( + getMaintenanceWindowExecutionTaskInvocation( args: GetMaintenanceWindowExecutionTaskInvocationCommandInput, cb: (err: any, data?: GetMaintenanceWindowExecutionTaskInvocationCommandOutput) => void ): void; - public getMaintenanceWindowExecutionTaskInvocation( + getMaintenanceWindowExecutionTaskInvocation( args: GetMaintenanceWindowExecutionTaskInvocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMaintenanceWindowExecutionTaskInvocationCommandOutput) => void ): void; - public getMaintenanceWindowExecutionTaskInvocation( - args: GetMaintenanceWindowExecutionTaskInvocationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetMaintenanceWindowExecutionTaskInvocationCommandOutput) => void), - cb?: (err: any, data?: GetMaintenanceWindowExecutionTaskInvocationCommandOutput) => void - ): Promise | void { - const command = new GetMaintenanceWindowExecutionTaskInvocationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the details of a maintenance window task.

- * - *

For maintenance window tasks without a specified target, you can't supply values for - * --max-errors and --max-concurrency. Instead, the system inserts a - * placeholder value of 1, which may be reported in the response to this command. - * These values don't affect the running of your task and can be ignored.

- *
- *

To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command.

- */ - public getMaintenanceWindowTask( + + /** + * @see {@link GetMaintenanceWindowTaskCommand} + */ + getMaintenanceWindowTask( args: GetMaintenanceWindowTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMaintenanceWindowTask( + getMaintenanceWindowTask( args: GetMaintenanceWindowTaskCommandInput, cb: (err: any, data?: GetMaintenanceWindowTaskCommandOutput) => void ): void; - public getMaintenanceWindowTask( + getMaintenanceWindowTask( args: GetMaintenanceWindowTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMaintenanceWindowTaskCommandOutput) => void ): void; - public getMaintenanceWindowTask( - args: GetMaintenanceWindowTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMaintenanceWindowTaskCommandOutput) => void), - cb?: (err: any, data?: GetMaintenanceWindowTaskCommandOutput) => void - ): Promise | void { - const command = new GetMaintenanceWindowTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. For more information, - * see Getting started with - * OpsCenter in the Amazon Web Services Systems Manager User Guide.

- *

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and - * remediate operational issues impacting the performance and health of their Amazon Web Services resources. For - * more information, see OpsCenter in the - * Amazon Web Services Systems Manager User Guide.

- */ - public getOpsItem(args: GetOpsItemCommandInput, options?: __HttpHandlerOptions): Promise; - public getOpsItem(args: GetOpsItemCommandInput, cb: (err: any, data?: GetOpsItemCommandOutput) => void): void; - public getOpsItem( + + /** + * @see {@link GetOpsItemCommand} + */ + getOpsItem(args: GetOpsItemCommandInput, options?: __HttpHandlerOptions): Promise; + getOpsItem(args: GetOpsItemCommandInput, cb: (err: any, data?: GetOpsItemCommandOutput) => void): void; + getOpsItem( args: GetOpsItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOpsItemCommandOutput) => void ): void; - public getOpsItem( - args: GetOpsItemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOpsItemCommandOutput) => void), - cb?: (err: any, data?: GetOpsItemCommandOutput) => void - ): Promise | void { - const command = new GetOpsItemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

View operational metadata related to an application in Application Manager.

- */ - public getOpsMetadata( + + /** + * @see {@link GetOpsMetadataCommand} + */ + getOpsMetadata( args: GetOpsMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getOpsMetadata( - args: GetOpsMetadataCommandInput, - cb: (err: any, data?: GetOpsMetadataCommandOutput) => void - ): void; - public getOpsMetadata( + getOpsMetadata(args: GetOpsMetadataCommandInput, cb: (err: any, data?: GetOpsMetadataCommandOutput) => void): void; + getOpsMetadata( args: GetOpsMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOpsMetadataCommandOutput) => void ): void; - public getOpsMetadata( - args: GetOpsMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOpsMetadataCommandOutput) => void), - cb?: (err: any, data?: GetOpsMetadataCommandOutput) => void - ): Promise | void { - const command = new GetOpsMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

View a summary of operations metadata (OpsData) based on specified filters and aggregators. - * OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as - * well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager - * Explorer.

- */ - public getOpsSummary( - args: GetOpsSummaryCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getOpsSummary( - args: GetOpsSummaryCommandInput, - cb: (err: any, data?: GetOpsSummaryCommandOutput) => void - ): void; - public getOpsSummary( + + /** + * @see {@link GetOpsSummaryCommand} + */ + getOpsSummary(args: GetOpsSummaryCommandInput, options?: __HttpHandlerOptions): Promise; + getOpsSummary(args: GetOpsSummaryCommandInput, cb: (err: any, data?: GetOpsSummaryCommandOutput) => void): void; + getOpsSummary( args: GetOpsSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOpsSummaryCommandOutput) => void ): void; - public getOpsSummary( - args: GetOpsSummaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetOpsSummaryCommandOutput) => void), - cb?: (err: any, data?: GetOpsSummaryCommandOutput) => void - ): Promise | void { - const command = new GetOpsSummaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get information about a single parameter by specifying the parameter name.

- * - *

To get information about more than one parameter at a time, use the GetParameters operation.

- *
- */ - public getParameter( - args: GetParameterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getParameter(args: GetParameterCommandInput, cb: (err: any, data?: GetParameterCommandOutput) => void): void; - public getParameter( + + /** + * @see {@link GetParameterCommand} + */ + getParameter(args: GetParameterCommandInput, options?: __HttpHandlerOptions): Promise; + getParameter(args: GetParameterCommandInput, cb: (err: any, data?: GetParameterCommandOutput) => void): void; + getParameter( args: GetParameterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetParameterCommandOutput) => void ): void; - public getParameter( - args: GetParameterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetParameterCommandOutput) => void), - cb?: (err: any, data?: GetParameterCommandOutput) => void - ): Promise | void { - const command = new GetParameterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the history of all changes to a parameter.

- * - *

If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must - * also update the key alias the parameter uses to reference KMS. Otherwise, - * GetParameterHistory retrieves whatever the original key alias was - * referencing.

- *
- */ - public getParameterHistory( + + /** + * @see {@link GetParameterHistoryCommand} + */ + getParameterHistory( args: GetParameterHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getParameterHistory( + getParameterHistory( args: GetParameterHistoryCommandInput, cb: (err: any, data?: GetParameterHistoryCommandOutput) => void ): void; - public getParameterHistory( + getParameterHistory( args: GetParameterHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetParameterHistoryCommandOutput) => void ): void; - public getParameterHistory( - args: GetParameterHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetParameterHistoryCommandOutput) => void), - cb?: (err: any, data?: GetParameterHistoryCommandOutput) => void - ): Promise | void { - const command = new GetParameterHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Get information about one or more parameters by specifying multiple parameter names.

- * - *

To get information about a single parameter, you can use the GetParameter - * operation instead.

- *
- */ - public getParameters( - args: GetParametersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getParameters( - args: GetParametersCommandInput, - cb: (err: any, data?: GetParametersCommandOutput) => void - ): void; - public getParameters( + + /** + * @see {@link GetParametersCommand} + */ + getParameters(args: GetParametersCommandInput, options?: __HttpHandlerOptions): Promise; + getParameters(args: GetParametersCommandInput, cb: (err: any, data?: GetParametersCommandOutput) => void): void; + getParameters( args: GetParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetParametersCommandOutput) => void ): void; - public getParameters( - args: GetParametersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetParametersCommandOutput) => void), - cb?: (err: any, data?: GetParametersCommandOutput) => void - ): Promise | void { - const command = new GetParametersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieve information about one or more parameters in a specific hierarchy.

- *

Request results are returned on a best-effort basis. If you specify MaxResults - * in the request, the response includes information up to the limit specified. The number of items - * returned, however, can be between zero and the value of MaxResults. If the service - * reaches an internal limit while processing the results, it stops the operation and returns the - * matching values up to that point and a NextToken. You can specify the - * NextToken in a subsequent call to get the next set of results.

- */ - public getParametersByPath( + + /** + * @see {@link GetParametersByPathCommand} + */ + getParametersByPath( args: GetParametersByPathCommandInput, options?: __HttpHandlerOptions ): Promise; - public getParametersByPath( + getParametersByPath( args: GetParametersByPathCommandInput, cb: (err: any, data?: GetParametersByPathCommandOutput) => void ): void; - public getParametersByPath( + getParametersByPath( args: GetParametersByPathCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetParametersByPathCommandOutput) => void ): void; - public getParametersByPath( - args: GetParametersByPathCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetParametersByPathCommandOutput) => void), - cb?: (err: any, data?: GetParametersByPathCommandOutput) => void - ): Promise | void { - const command = new GetParametersByPathCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves information about a patch baseline.

- */ - public getPatchBaseline( + + /** + * @see {@link GetPatchBaselineCommand} + */ + getPatchBaseline( args: GetPatchBaselineCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPatchBaseline( + getPatchBaseline( args: GetPatchBaselineCommandInput, cb: (err: any, data?: GetPatchBaselineCommandOutput) => void ): void; - public getPatchBaseline( + getPatchBaseline( args: GetPatchBaselineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPatchBaselineCommandOutput) => void ): void; - public getPatchBaseline( - args: GetPatchBaselineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPatchBaselineCommandOutput) => void), - cb?: (err: any, data?: GetPatchBaselineCommandOutput) => void - ): Promise | void { - const command = new GetPatchBaselineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the patch baseline that should be used for the specified patch group.

- */ - public getPatchBaselineForPatchGroup( + + /** + * @see {@link GetPatchBaselineForPatchGroupCommand} + */ + getPatchBaselineForPatchGroup( args: GetPatchBaselineForPatchGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPatchBaselineForPatchGroup( + getPatchBaselineForPatchGroup( args: GetPatchBaselineForPatchGroupCommandInput, cb: (err: any, data?: GetPatchBaselineForPatchGroupCommandOutput) => void ): void; - public getPatchBaselineForPatchGroup( + getPatchBaselineForPatchGroup( args: GetPatchBaselineForPatchGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPatchBaselineForPatchGroupCommandOutput) => void ): void; - public getPatchBaselineForPatchGroup( - args: GetPatchBaselineForPatchGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPatchBaselineForPatchGroupCommandOutput) => void), - cb?: (err: any, data?: GetPatchBaselineForPatchGroupCommandOutput) => void - ): Promise | void { - const command = new GetPatchBaselineForPatchGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns an array of the Policy object.

- */ - public getResourcePolicies( + + /** + * @see {@link GetResourcePoliciesCommand} + */ + getResourcePolicies( args: GetResourcePoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourcePolicies( + getResourcePolicies( args: GetResourcePoliciesCommandInput, cb: (err: any, data?: GetResourcePoliciesCommandOutput) => void ): void; - public getResourcePolicies( + getResourcePolicies( args: GetResourcePoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePoliciesCommandOutput) => void ): void; - public getResourcePolicies( - args: GetResourcePoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourcePoliciesCommandOutput) => void), - cb?: (err: any, data?: GetResourcePoliciesCommandOutput) => void - ): Promise | void { - const command = new GetResourcePoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * ServiceSetting is an account-level setting for an Amazon Web Services service. This setting - * defines how a user interacts with or uses a service or a feature of a service. For example, if an - * Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services - * service team might create a default setting of false. This means the user can't use - * this feature unless they change the setting to true and intentionally opt in for a - * paid feature.

- *

Services map a SettingId object to a setting value. Amazon Web Services services teams define - * the default value for a SettingId. You can't create a new SettingId, - * but you can overwrite the default value if you have the ssm:UpdateServiceSetting - * permission for the setting. Use the UpdateServiceSetting API operation to - * change the default setting. Or use the ResetServiceSetting to change the value - * back to the original value defined by the Amazon Web Services service team.

- *

Query the current service setting for the Amazon Web Services account.

- */ - public getServiceSetting( + + /** + * @see {@link GetServiceSettingCommand} + */ + getServiceSetting( args: GetServiceSettingCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServiceSetting( + getServiceSetting( args: GetServiceSettingCommandInput, cb: (err: any, data?: GetServiceSettingCommandOutput) => void ): void; - public getServiceSetting( + getServiceSetting( args: GetServiceSettingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceSettingCommandOutput) => void ): void; - public getServiceSetting( - args: GetServiceSettingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceSettingCommandOutput) => void), - cb?: (err: any, data?: GetServiceSettingCommandOutput) => void - ): Promise | void { - const command = new GetServiceSettingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

A parameter label is a user-defined alias to help you manage different versions of a - * parameter. When you modify a parameter, Amazon Web Services Systems Manager automatically saves a new version and - * increments the version number by one. A label can help you remember the purpose of a parameter - * when there are multiple versions.

- *

Parameter labels have the following requirements and restrictions.

- *
    - *
  • - *

    A version of a parameter can have a maximum of 10 labels.

    - *
  • - *
  • - *

    You can't attach the same label to different versions of the same parameter. For example, - * if version 1 has the label Production, then you can't attach Production to version 2.

    - *
  • - *
  • - *

    You can move a label from one version of a parameter to another.

    - *
  • - *
  • - *

    You can't create a label when you create a new parameter. You must attach a label to a - * specific version of a parameter.

    - *
  • - *
  • - *

    If you no longer want to use a parameter label, then you can either delete it or move it - * to a different version of a parameter.

    - *
  • - *
  • - *

    A label can have a maximum of 100 characters.

    - *
  • - *
  • - *

    Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or - * underscores (_).

    - *
  • - *
  • - *

    Labels can't begin with a number, "aws" or "ssm" (not case - * sensitive). If a label fails to meet these requirements, then the label isn't associated with a - * parameter and the system displays it in the list of InvalidLabels.

    - *
  • - *
- */ - public labelParameterVersion( + + /** + * @see {@link LabelParameterVersionCommand} + */ + labelParameterVersion( args: LabelParameterVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public labelParameterVersion( + labelParameterVersion( args: LabelParameterVersionCommandInput, cb: (err: any, data?: LabelParameterVersionCommandOutput) => void ): void; - public labelParameterVersion( + labelParameterVersion( args: LabelParameterVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: LabelParameterVersionCommandOutput) => void ): void; - public labelParameterVersion( - args: LabelParameterVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: LabelParameterVersionCommandOutput) => void), - cb?: (err: any, data?: LabelParameterVersionCommandOutput) => void - ): Promise | void { - const command = new LabelParameterVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You - * can limit the results to a specific State Manager association document or managed node by - * specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.

- */ - public listAssociations( + + /** + * @see {@link ListAssociationsCommand} + */ + listAssociations( args: ListAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssociations( + listAssociations( args: ListAssociationsCommandInput, cb: (err: any, data?: ListAssociationsCommandOutput) => void ): void; - public listAssociations( + listAssociations( args: ListAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssociationsCommandOutput) => void ): void; - public listAssociations( - args: ListAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssociationsCommandOutput) => void), - cb?: (err: any, data?: ListAssociationsCommandOutput) => void - ): Promise | void { - const command = new ListAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves all versions of an association for a specific association ID.

- */ - public listAssociationVersions( + + /** + * @see {@link ListAssociationVersionsCommand} + */ + listAssociationVersions( args: ListAssociationVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssociationVersions( + listAssociationVersions( args: ListAssociationVersionsCommandInput, cb: (err: any, data?: ListAssociationVersionsCommandOutput) => void ): void; - public listAssociationVersions( + listAssociationVersions( args: ListAssociationVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssociationVersionsCommandOutput) => void ): void; - public listAssociationVersions( - args: ListAssociationVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssociationVersionsCommandOutput) => void), - cb?: (err: any, data?: ListAssociationVersionsCommandOutput) => void - ): Promise | void { - const command = new ListAssociationVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

An invocation is copy of a command sent to a specific managed node. A command can apply to - * one or more managed nodes. A command invocation applies to one managed node. For example, if a - * user runs SendCommand against three managed nodes, then a command invocation is - * created for each requested managed node ID. ListCommandInvocations provide status - * about command execution.

- */ - public listCommandInvocations( + + /** + * @see {@link ListCommandInvocationsCommand} + */ + listCommandInvocations( args: ListCommandInvocationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCommandInvocations( + listCommandInvocations( args: ListCommandInvocationsCommandInput, cb: (err: any, data?: ListCommandInvocationsCommandOutput) => void ): void; - public listCommandInvocations( + listCommandInvocations( args: ListCommandInvocationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCommandInvocationsCommandOutput) => void ): void; - public listCommandInvocations( - args: ListCommandInvocationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCommandInvocationsCommandOutput) => void), - cb?: (err: any, data?: ListCommandInvocationsCommandOutput) => void - ): Promise | void { - const command = new ListCommandInvocationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the commands requested by users of the Amazon Web Services account.

- */ - public listCommands( - args: ListCommandsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listCommands(args: ListCommandsCommandInput, cb: (err: any, data?: ListCommandsCommandOutput) => void): void; - public listCommands( + + /** + * @see {@link ListCommandsCommand} + */ + listCommands(args: ListCommandsCommandInput, options?: __HttpHandlerOptions): Promise; + listCommands(args: ListCommandsCommandInput, cb: (err: any, data?: ListCommandsCommandOutput) => void): void; + listCommands( args: ListCommandsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCommandsCommandOutput) => void ): void; - public listCommands( - args: ListCommandsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCommandsCommandOutput) => void), - cb?: (err: any, data?: ListCommandsCommandOutput) => void - ): Promise | void { - const command = new ListCommandsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

For a specified resource ID, this API operation returns a list of compliance statuses for - * different resource types. Currently, you can only specify one resource ID per call. List results - * depend on the criteria specified in the filter.

- */ - public listComplianceItems( + + /** + * @see {@link ListComplianceItemsCommand} + */ + listComplianceItems( args: ListComplianceItemsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listComplianceItems( + listComplianceItems( args: ListComplianceItemsCommandInput, cb: (err: any, data?: ListComplianceItemsCommandOutput) => void ): void; - public listComplianceItems( + listComplianceItems( args: ListComplianceItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComplianceItemsCommandOutput) => void ): void; - public listComplianceItems( - args: ListComplianceItemsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListComplianceItemsCommandOutput) => void), - cb?: (err: any, data?: ListComplianceItemsCommandOutput) => void - ): Promise | void { - const command = new ListComplianceItemsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a summary count of compliant and non-compliant resources for a compliance type. For - * example, this call can return State Manager associations, patches, or custom compliance types - * according to the filter criteria that you specify.

- */ - public listComplianceSummaries( + + /** + * @see {@link ListComplianceSummariesCommand} + */ + listComplianceSummaries( args: ListComplianceSummariesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listComplianceSummaries( + listComplianceSummaries( args: ListComplianceSummariesCommandInput, cb: (err: any, data?: ListComplianceSummariesCommandOutput) => void ): void; - public listComplianceSummaries( + listComplianceSummaries( args: ListComplianceSummariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComplianceSummariesCommandOutput) => void ): void; - public listComplianceSummaries( - args: ListComplianceSummariesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListComplianceSummariesCommandOutput) => void), - cb?: (err: any, data?: ListComplianceSummariesCommandOutput) => void - ): Promise | void { - const command = new ListComplianceSummariesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Information about approval reviews for a version of a change template in Change Manager.

- */ - public listDocumentMetadataHistory( + + /** + * @see {@link ListDocumentMetadataHistoryCommand} + */ + listDocumentMetadataHistory( args: ListDocumentMetadataHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDocumentMetadataHistory( + listDocumentMetadataHistory( args: ListDocumentMetadataHistoryCommandInput, cb: (err: any, data?: ListDocumentMetadataHistoryCommandOutput) => void ): void; - public listDocumentMetadataHistory( + listDocumentMetadataHistory( args: ListDocumentMetadataHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDocumentMetadataHistoryCommandOutput) => void ): void; - public listDocumentMetadataHistory( - args: ListDocumentMetadataHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDocumentMetadataHistoryCommandOutput) => void), - cb?: (err: any, data?: ListDocumentMetadataHistoryCommandOutput) => void - ): Promise | void { - const command = new ListDocumentMetadataHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can - * limit the results of this request by using a filter.

- */ - public listDocuments( - args: ListDocumentsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listDocuments( - args: ListDocumentsCommandInput, - cb: (err: any, data?: ListDocumentsCommandOutput) => void - ): void; - public listDocuments( + + /** + * @see {@link ListDocumentsCommand} + */ + listDocuments(args: ListDocumentsCommandInput, options?: __HttpHandlerOptions): Promise; + listDocuments(args: ListDocumentsCommandInput, cb: (err: any, data?: ListDocumentsCommandOutput) => void): void; + listDocuments( args: ListDocumentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDocumentsCommandOutput) => void ): void; - public listDocuments( - args: ListDocumentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDocumentsCommandOutput) => void), - cb?: (err: any, data?: ListDocumentsCommandOutput) => void - ): Promise | void { - const command = new ListDocumentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List all versions for a document.

- */ - public listDocumentVersions( + + /** + * @see {@link ListDocumentVersionsCommand} + */ + listDocumentVersions( args: ListDocumentVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listDocumentVersions( + listDocumentVersions( args: ListDocumentVersionsCommandInput, cb: (err: any, data?: ListDocumentVersionsCommandOutput) => void ): void; - public listDocumentVersions( + listDocumentVersions( args: ListDocumentVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDocumentVersionsCommandOutput) => void ): void; - public listDocumentVersions( - args: ListDocumentVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDocumentVersionsCommandOutput) => void), - cb?: (err: any, data?: ListDocumentVersionsCommandOutput) => void - ): Promise | void { - const command = new ListDocumentVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

A list of inventory items returned by the request.

- */ - public listInventoryEntries( + + /** + * @see {@link ListInventoryEntriesCommand} + */ + listInventoryEntries( args: ListInventoryEntriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listInventoryEntries( + listInventoryEntries( args: ListInventoryEntriesCommandInput, cb: (err: any, data?: ListInventoryEntriesCommandOutput) => void ): void; - public listInventoryEntries( + listInventoryEntries( args: ListInventoryEntriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInventoryEntriesCommandOutput) => void ): void; - public listInventoryEntries( - args: ListInventoryEntriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInventoryEntriesCommandOutput) => void), - cb?: (err: any, data?: ListInventoryEntriesCommandOutput) => void - ): Promise | void { - const command = new ListInventoryEntriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account. You can - * limit the results to events associated with specific OpsItems by specifying a filter.

- */ - public listOpsItemEvents( + + /** + * @see {@link ListOpsItemEventsCommand} + */ + listOpsItemEvents( args: ListOpsItemEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOpsItemEvents( + listOpsItemEvents( args: ListOpsItemEventsCommandInput, cb: (err: any, data?: ListOpsItemEventsCommandOutput) => void ): void; - public listOpsItemEvents( + listOpsItemEvents( args: ListOpsItemEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOpsItemEventsCommandOutput) => void ): void; - public listOpsItemEvents( - args: ListOpsItemEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOpsItemEventsCommandOutput) => void), - cb?: (err: any, data?: ListOpsItemEventsCommandOutput) => void - ): Promise | void { - const command = new ListOpsItemEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a - * capability of Amazon Web Services Systems Manager.

- */ - public listOpsItemRelatedItems( + + /** + * @see {@link ListOpsItemRelatedItemsCommand} + */ + listOpsItemRelatedItems( args: ListOpsItemRelatedItemsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOpsItemRelatedItems( + listOpsItemRelatedItems( args: ListOpsItemRelatedItemsCommandInput, cb: (err: any, data?: ListOpsItemRelatedItemsCommandOutput) => void ): void; - public listOpsItemRelatedItems( + listOpsItemRelatedItems( args: ListOpsItemRelatedItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOpsItemRelatedItemsCommandOutput) => void ): void; - public listOpsItemRelatedItems( - args: ListOpsItemRelatedItemsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOpsItemRelatedItemsCommandOutput) => void), - cb?: (err: any, data?: ListOpsItemRelatedItemsCommandOutput) => void - ): Promise | void { - const command = new ListOpsItemRelatedItemsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or - * blobs.

- */ - public listOpsMetadata( + + /** + * @see {@link ListOpsMetadataCommand} + */ + listOpsMetadata( args: ListOpsMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOpsMetadata( - args: ListOpsMetadataCommandInput, - cb: (err: any, data?: ListOpsMetadataCommandOutput) => void - ): void; - public listOpsMetadata( + listOpsMetadata(args: ListOpsMetadataCommandInput, cb: (err: any, data?: ListOpsMetadataCommandOutput) => void): void; + listOpsMetadata( args: ListOpsMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOpsMetadataCommandOutput) => void ): void; - public listOpsMetadata( - args: ListOpsMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOpsMetadataCommandOutput) => void), - cb?: (err: any, data?: ListOpsMetadataCommandOutput) => void - ): Promise | void { - const command = new ListOpsMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a resource-level summary count. The summary includes information about compliant and - * non-compliant statuses and detailed compliance-item severity counts, according to the filter - * criteria you specify.

- */ - public listResourceComplianceSummaries( + + /** + * @see {@link ListResourceComplianceSummariesCommand} + */ + listResourceComplianceSummaries( args: ListResourceComplianceSummariesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourceComplianceSummaries( + listResourceComplianceSummaries( args: ListResourceComplianceSummariesCommandInput, cb: (err: any, data?: ListResourceComplianceSummariesCommandOutput) => void ): void; - public listResourceComplianceSummaries( + listResourceComplianceSummaries( args: ListResourceComplianceSummariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceComplianceSummariesCommandOutput) => void ): void; - public listResourceComplianceSummaries( - args: ListResourceComplianceSummariesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourceComplianceSummariesCommandOutput) => void), - cb?: (err: any, data?: ListResourceComplianceSummariesCommandOutput) => void - ): Promise | void { - const command = new ListResourceComplianceSummariesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists your resource data sync configurations. Includes information about the last time a - * sync attempted to start, the last sync status, and the last time a sync successfully - * completed.

- *

The number of sync configurations might be too large to return using a single call to - * ListResourceDataSync. You can limit the number of sync configurations returned by - * using the MaxResults parameter. To determine whether there are more sync - * configurations to list, check the value of NextToken in the output. If there are - * more sync configurations to list, you can request them by specifying the NextToken - * returned in the call to the parameter of a subsequent call.

- */ - public listResourceDataSync( + + /** + * @see {@link ListResourceDataSyncCommand} + */ + listResourceDataSync( args: ListResourceDataSyncCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourceDataSync( + listResourceDataSync( args: ListResourceDataSyncCommandInput, cb: (err: any, data?: ListResourceDataSyncCommandOutput) => void ): void; - public listResourceDataSync( + listResourceDataSync( args: ListResourceDataSyncCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceDataSyncCommandOutput) => void ): void; - public listResourceDataSync( - args: ListResourceDataSyncCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourceDataSyncCommandOutput) => void), - cb?: (err: any, data?: ListResourceDataSyncCommandOutput) => void - ): Promise | void { - const command = new ListResourceDataSyncCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of the tags assigned to the specified resource.

- *

For information about the ID format for each supported resource type, see AddTagsToResource.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document - * privately, you must specify the Amazon Web Services user IDs for those people who can use the document. If - * you share a document publicly, you must specify All as the account - * ID.

- */ - public modifyDocumentPermission( + + /** + * @see {@link ModifyDocumentPermissionCommand} + */ + modifyDocumentPermission( args: ModifyDocumentPermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyDocumentPermission( + modifyDocumentPermission( args: ModifyDocumentPermissionCommandInput, cb: (err: any, data?: ModifyDocumentPermissionCommandOutput) => void ): void; - public modifyDocumentPermission( + modifyDocumentPermission( args: ModifyDocumentPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDocumentPermissionCommandOutput) => void ): void; - public modifyDocumentPermission( - args: ModifyDocumentPermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyDocumentPermissionCommandOutput) => void), - cb?: (err: any, data?: ModifyDocumentPermissionCommandOutput) => void - ): Promise | void { - const command = new ModifyDocumentPermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers a compliance type and other compliance details on a designated resource. This - * operation lets you register custom compliance details with a resource. This call overwrites - * existing compliance information on the resource, so you must provide a full list of compliance - * items each time that you send the request.

- *

ComplianceType can be one of the following:

- *
    - *
  • - *

    ExecutionId: The execution ID when the patch, association, or custom compliance item was - * applied.

    - *
  • - *
  • - *

    ExecutionType: Specify patch, association, or Custom:string.

    - *
  • - *
  • - *

    ExecutionTime. The time the patch, association, or custom compliance item was applied to - * the managed node.

    - *
  • - *
  • - *

    Id: The patch, association, or custom compliance ID.

    - *
  • - *
  • - *

    Title: A title.

    - *
  • - *
  • - *

    Status: The status of the compliance item. For example, approved for patches, - * or Failed for associations.

    - *
  • - *
  • - *

    Severity: A patch severity. For example, Critical.

    - *
  • - *
  • - *

    DocumentName: An SSM document name. For example, AWS-RunPatchBaseline.

    - *
  • - *
  • - *

    DocumentVersion: An SSM document version number. For example, 4.

    - *
  • - *
  • - *

    Classification: A patch classification. For example, security updates.

    - *
  • - *
  • - *

    PatchBaselineId: A patch baseline ID.

    - *
  • - *
  • - *

    PatchSeverity: A patch severity. For example, Critical.

    - *
  • - *
  • - *

    PatchState: A patch state. For example, InstancesWithFailedPatches.

    - *
  • - *
  • - *

    PatchGroup: The name of a patch group.

    - *
  • - *
  • - *

    InstalledTime: The time the association, patch, or custom compliance item was applied to - * the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'

    - *
  • - *
- */ - public putComplianceItems( + + /** + * @see {@link PutComplianceItemsCommand} + */ + putComplianceItems( args: PutComplianceItemsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putComplianceItems( + putComplianceItems( args: PutComplianceItemsCommandInput, cb: (err: any, data?: PutComplianceItemsCommandOutput) => void ): void; - public putComplianceItems( + putComplianceItems( args: PutComplianceItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutComplianceItemsCommandOutput) => void ): void; - public putComplianceItems( - args: PutComplianceItemsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutComplianceItemsCommandOutput) => void), - cb?: (err: any, data?: PutComplianceItemsCommandOutput) => void - ): Promise | void { - const command = new PutComplianceItemsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Bulk update custom inventory items on one or more managed nodes. The request adds an - * inventory item, if it doesn't already exist, or updates an inventory item, if it does - * exist.

- */ - public putInventory( - args: PutInventoryCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putInventory(args: PutInventoryCommandInput, cb: (err: any, data?: PutInventoryCommandOutput) => void): void; - public putInventory( + + /** + * @see {@link PutInventoryCommand} + */ + putInventory(args: PutInventoryCommandInput, options?: __HttpHandlerOptions): Promise; + putInventory(args: PutInventoryCommandInput, cb: (err: any, data?: PutInventoryCommandOutput) => void): void; + putInventory( args: PutInventoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutInventoryCommandOutput) => void ): void; - public putInventory( - args: PutInventoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutInventoryCommandOutput) => void), - cb?: (err: any, data?: PutInventoryCommandOutput) => void - ): Promise | void { - const command = new PutInventoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Add a parameter to the system.

- */ - public putParameter( - args: PutParameterCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putParameter(args: PutParameterCommandInput, cb: (err: any, data?: PutParameterCommandOutput) => void): void; - public putParameter( + + /** + * @see {@link PutParameterCommand} + */ + putParameter(args: PutParameterCommandInput, options?: __HttpHandlerOptions): Promise; + putParameter(args: PutParameterCommandInput, cb: (err: any, data?: PutParameterCommandOutput) => void): void; + putParameter( args: PutParameterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutParameterCommandOutput) => void ): void; - public putParameter( - args: PutParameterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutParameterCommandOutput) => void), - cb?: (err: any, data?: PutParameterCommandOutput) => void - ): Promise | void { - const command = new PutParameterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or updates a Systems Manager resource policy. A resource policy helps you to define the - * IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. - * Currently, OpsItemGroup is the only resource that supports Systems Manager resource policies. - * The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact - * with OpsCenter operational work items (OpsItems).

- */ - public putResourcePolicy( + + /** + * @see {@link PutResourcePolicyCommand} + */ + putResourcePolicy( args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( - args: PutResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: PutResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new PutResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Defines the default patch baseline for the relevant operating system.

- *

To reset the Amazon Web Services-predefined patch baseline as the default, specify the full patch baseline - * Amazon Resource Name (ARN) as the baseline ID value. For example, for CentOS, specify - * arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead of - * pb-0574b43a65ea646ed.

- */ - public registerDefaultPatchBaseline( + + /** + * @see {@link RegisterDefaultPatchBaselineCommand} + */ + registerDefaultPatchBaseline( args: RegisterDefaultPatchBaselineCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerDefaultPatchBaseline( + registerDefaultPatchBaseline( args: RegisterDefaultPatchBaselineCommandInput, cb: (err: any, data?: RegisterDefaultPatchBaselineCommandOutput) => void ): void; - public registerDefaultPatchBaseline( + registerDefaultPatchBaseline( args: RegisterDefaultPatchBaselineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterDefaultPatchBaselineCommandOutput) => void ): void; - public registerDefaultPatchBaseline( - args: RegisterDefaultPatchBaselineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterDefaultPatchBaselineCommandOutput) => void), - cb?: (err: any, data?: RegisterDefaultPatchBaselineCommandOutput) => void - ): Promise | void { - const command = new RegisterDefaultPatchBaselineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers a patch baseline for a patch group.

- */ - public registerPatchBaselineForPatchGroup( + + /** + * @see {@link RegisterPatchBaselineForPatchGroupCommand} + */ + registerPatchBaselineForPatchGroup( args: RegisterPatchBaselineForPatchGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerPatchBaselineForPatchGroup( + registerPatchBaselineForPatchGroup( args: RegisterPatchBaselineForPatchGroupCommandInput, cb: (err: any, data?: RegisterPatchBaselineForPatchGroupCommandOutput) => void ): void; - public registerPatchBaselineForPatchGroup( + registerPatchBaselineForPatchGroup( args: RegisterPatchBaselineForPatchGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterPatchBaselineForPatchGroupCommandOutput) => void ): void; - public registerPatchBaselineForPatchGroup( - args: RegisterPatchBaselineForPatchGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterPatchBaselineForPatchGroupCommandOutput) => void), - cb?: (err: any, data?: RegisterPatchBaselineForPatchGroupCommandOutput) => void - ): Promise | void { - const command = new RegisterPatchBaselineForPatchGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers a target with a maintenance window.

- */ - public registerTargetWithMaintenanceWindow( + + /** + * @see {@link RegisterTargetWithMaintenanceWindowCommand} + */ + registerTargetWithMaintenanceWindow( args: RegisterTargetWithMaintenanceWindowCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerTargetWithMaintenanceWindow( + registerTargetWithMaintenanceWindow( args: RegisterTargetWithMaintenanceWindowCommandInput, cb: (err: any, data?: RegisterTargetWithMaintenanceWindowCommandOutput) => void ): void; - public registerTargetWithMaintenanceWindow( + registerTargetWithMaintenanceWindow( args: RegisterTargetWithMaintenanceWindowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterTargetWithMaintenanceWindowCommandOutput) => void ): void; - public registerTargetWithMaintenanceWindow( - args: RegisterTargetWithMaintenanceWindowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterTargetWithMaintenanceWindowCommandOutput) => void), - cb?: (err: any, data?: RegisterTargetWithMaintenanceWindowCommandOutput) => void - ): Promise | void { - const command = new RegisterTargetWithMaintenanceWindowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds a new task to a maintenance window.

- */ - public registerTaskWithMaintenanceWindow( + + /** + * @see {@link RegisterTaskWithMaintenanceWindowCommand} + */ + registerTaskWithMaintenanceWindow( args: RegisterTaskWithMaintenanceWindowCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerTaskWithMaintenanceWindow( + registerTaskWithMaintenanceWindow( args: RegisterTaskWithMaintenanceWindowCommandInput, cb: (err: any, data?: RegisterTaskWithMaintenanceWindowCommandOutput) => void ): void; - public registerTaskWithMaintenanceWindow( + registerTaskWithMaintenanceWindow( args: RegisterTaskWithMaintenanceWindowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterTaskWithMaintenanceWindowCommandOutput) => void ): void; - public registerTaskWithMaintenanceWindow( - args: RegisterTaskWithMaintenanceWindowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterTaskWithMaintenanceWindowCommandOutput) => void), - cb?: (err: any, data?: RegisterTaskWithMaintenanceWindowCommandOutput) => void - ): Promise | void { - const command = new RegisterTaskWithMaintenanceWindowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes tag keys from the specified resource.

- */ - public removeTagsFromResource( + + /** + * @see {@link RemoveTagsFromResourceCommand} + */ + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeTagsFromResource( + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void ): void; - public removeTagsFromResource( + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void ): void; - public removeTagsFromResource( - args: RemoveTagsFromResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveTagsFromResourceCommandOutput) => void), - cb?: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void - ): Promise | void { - const command = new RemoveTagsFromResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * ServiceSetting is an account-level setting for an Amazon Web Services service. This setting - * defines how a user interacts with or uses a service or a feature of a service. For example, if an - * Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services - * service team might create a default setting of "false". This means the user can't use this - * feature unless they change the setting to "true" and intentionally opt in for a paid - * feature.

- *

Services map a SettingId object to a setting value. Amazon Web Services services teams define - * the default value for a SettingId. You can't create a new SettingId, - * but you can overwrite the default value if you have the ssm:UpdateServiceSetting - * permission for the setting. Use the GetServiceSetting API operation to view the - * current value. Use the UpdateServiceSetting API operation to change the default - * setting.

- *

Reset the service setting for the account to the default value as provisioned by the Amazon Web Services - * service team.

- */ - public resetServiceSetting( + + /** + * @see {@link ResetServiceSettingCommand} + */ + resetServiceSetting( args: ResetServiceSettingCommandInput, options?: __HttpHandlerOptions ): Promise; - public resetServiceSetting( + resetServiceSetting( args: ResetServiceSettingCommandInput, cb: (err: any, data?: ResetServiceSettingCommandOutput) => void ): void; - public resetServiceSetting( + resetServiceSetting( args: ResetServiceSettingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetServiceSettingCommandOutput) => void ): void; - public resetServiceSetting( - args: ResetServiceSettingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetServiceSettingCommandOutput) => void), - cb?: (err: any, data?: ResetServiceSettingCommandOutput) => void - ): Promise | void { - const command = new ResetServiceSettingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Reconnects a session to a managed node after it has been disconnected. Connections can be - * resumed for disconnected sessions, but not terminated sessions.

- * - *

This command is primarily for use by client machines to automatically reconnect during - * intermittent network issues. It isn't intended for any other use.

- *
- */ - public resumeSession( - args: ResumeSessionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public resumeSession( - args: ResumeSessionCommandInput, - cb: (err: any, data?: ResumeSessionCommandOutput) => void - ): void; - public resumeSession( + + /** + * @see {@link ResumeSessionCommand} + */ + resumeSession(args: ResumeSessionCommandInput, options?: __HttpHandlerOptions): Promise; + resumeSession(args: ResumeSessionCommandInput, cb: (err: any, data?: ResumeSessionCommandOutput) => void): void; + resumeSession( args: ResumeSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResumeSessionCommandOutput) => void ): void; - public resumeSession( - args: ResumeSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResumeSessionCommandOutput) => void), - cb?: (err: any, data?: ResumeSessionCommandOutput) => void - ): Promise | void { - const command = new ResumeSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sends a signal to an Automation execution to change the current behavior or status of the - * execution.

- */ - public sendAutomationSignal( + + /** + * @see {@link SendAutomationSignalCommand} + */ + sendAutomationSignal( args: SendAutomationSignalCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendAutomationSignal( + sendAutomationSignal( args: SendAutomationSignalCommandInput, cb: (err: any, data?: SendAutomationSignalCommandOutput) => void ): void; - public sendAutomationSignal( + sendAutomationSignal( args: SendAutomationSignalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendAutomationSignalCommandOutput) => void ): void; - public sendAutomationSignal( - args: SendAutomationSignalCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendAutomationSignalCommandOutput) => void), - cb?: (err: any, data?: SendAutomationSignalCommandOutput) => void - ): Promise | void { - const command = new SendAutomationSignalCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Runs commands on one or more managed nodes.

- */ - public sendCommand(args: SendCommandCommandInput, options?: __HttpHandlerOptions): Promise; - public sendCommand(args: SendCommandCommandInput, cb: (err: any, data?: SendCommandCommandOutput) => void): void; - public sendCommand( + + /** + * @see {@link SendCommandCommand} + */ + sendCommand(args: SendCommandCommandInput, options?: __HttpHandlerOptions): Promise; + sendCommand(args: SendCommandCommandInput, cb: (err: any, data?: SendCommandCommandOutput) => void): void; + sendCommand( args: SendCommandCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendCommandCommandOutput) => void ): void; - public sendCommand( - args: SendCommandCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendCommandCommandOutput) => void), - cb?: (err: any, data?: SendCommandCommandOutput) => void - ): Promise | void { - const command = new SendCommandCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Runs an association immediately and only one time. This operation can be helpful when - * troubleshooting associations.

- */ - public startAssociationsOnce( + + /** + * @see {@link StartAssociationsOnceCommand} + */ + startAssociationsOnce( args: StartAssociationsOnceCommandInput, options?: __HttpHandlerOptions ): Promise; - public startAssociationsOnce( + startAssociationsOnce( args: StartAssociationsOnceCommandInput, cb: (err: any, data?: StartAssociationsOnceCommandOutput) => void ): void; - public startAssociationsOnce( + startAssociationsOnce( args: StartAssociationsOnceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartAssociationsOnceCommandOutput) => void ): void; - public startAssociationsOnce( - args: StartAssociationsOnceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartAssociationsOnceCommandOutput) => void), - cb?: (err: any, data?: StartAssociationsOnceCommandOutput) => void - ): Promise | void { - const command = new StartAssociationsOnceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Initiates execution of an Automation runbook.

- */ - public startAutomationExecution( + + /** + * @see {@link StartAutomationExecutionCommand} + */ + startAutomationExecution( args: StartAutomationExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startAutomationExecution( + startAutomationExecution( args: StartAutomationExecutionCommandInput, cb: (err: any, data?: StartAutomationExecutionCommandOutput) => void ): void; - public startAutomationExecution( + startAutomationExecution( args: StartAutomationExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartAutomationExecutionCommandOutput) => void ): void; - public startAutomationExecution( - args: StartAutomationExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartAutomationExecutionCommandOutput) => void), - cb?: (err: any, data?: StartAutomationExecutionCommandOutput) => void - ): Promise | void { - const command = new StartAutomationExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a change request for Change Manager. The Automation runbooks specified in the - * change request run only after all required approvals for the change request have been - * received.

- */ - public startChangeRequestExecution( + + /** + * @see {@link StartChangeRequestExecutionCommand} + */ + startChangeRequestExecution( args: StartChangeRequestExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startChangeRequestExecution( + startChangeRequestExecution( args: StartChangeRequestExecutionCommandInput, cb: (err: any, data?: StartChangeRequestExecutionCommandOutput) => void ): void; - public startChangeRequestExecution( + startChangeRequestExecution( args: StartChangeRequestExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartChangeRequestExecutionCommandOutput) => void ): void; - public startChangeRequestExecution( - args: StartChangeRequestExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartChangeRequestExecutionCommandOutput) => void), - cb?: (err: any, data?: StartChangeRequestExecutionCommandOutput) => void - ): Promise | void { - const command = new StartChangeRequestExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Initiates a connection to a target (for example, a managed node) for a Session Manager session. - * Returns a URL and token that can be used to open a WebSocket connection for sending input and - * receiving outputs.

- * - *

Amazon Web Services CLI usage: start-session is an interactive command that requires the Session Manager - * plugin to be installed on the client machine making the call. For information, see Install - * the Session Manager plugin for the Amazon Web Services CLI in the Amazon Web Services Systems Manager User Guide.

- *

Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools - * for PowerShell on Windows local machines.

- *
- */ - public startSession( - args: StartSessionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public startSession(args: StartSessionCommandInput, cb: (err: any, data?: StartSessionCommandOutput) => void): void; - public startSession( + + /** + * @see {@link StartSessionCommand} + */ + startSession(args: StartSessionCommandInput, options?: __HttpHandlerOptions): Promise; + startSession(args: StartSessionCommandInput, cb: (err: any, data?: StartSessionCommandOutput) => void): void; + startSession( args: StartSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSessionCommandOutput) => void ): void; - public startSession( - args: StartSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartSessionCommandOutput) => void), - cb?: (err: any, data?: StartSessionCommandOutput) => void - ): Promise | void { - const command = new StartSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stop an Automation that is currently running.

- */ - public stopAutomationExecution( + + /** + * @see {@link StopAutomationExecutionCommand} + */ + stopAutomationExecution( args: StopAutomationExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopAutomationExecution( + stopAutomationExecution( args: StopAutomationExecutionCommandInput, cb: (err: any, data?: StopAutomationExecutionCommandOutput) => void ): void; - public stopAutomationExecution( + stopAutomationExecution( args: StopAutomationExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopAutomationExecutionCommandOutput) => void ): void; - public stopAutomationExecution( - args: StopAutomationExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopAutomationExecutionCommandOutput) => void), - cb?: (err: any, data?: StopAutomationExecutionCommandOutput) => void - ): Promise | void { - const command = new StopAutomationExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Permanently ends a session and closes the data connection between the Session Manager client and - * SSM Agent on the managed node. A terminated session can't be resumed.

- */ - public terminateSession( + + /** + * @see {@link TerminateSessionCommand} + */ + terminateSession( args: TerminateSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public terminateSession( + terminateSession( args: TerminateSessionCommandInput, cb: (err: any, data?: TerminateSessionCommandOutput) => void ): void; - public terminateSession( + terminateSession( args: TerminateSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TerminateSessionCommandOutput) => void ): void; - public terminateSession( - args: TerminateSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TerminateSessionCommandOutput) => void), - cb?: (err: any, data?: TerminateSessionCommandOutput) => void - ): Promise | void { - const command = new TerminateSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Remove a label or labels from a parameter.

- */ - public unlabelParameterVersion( + + /** + * @see {@link UnlabelParameterVersionCommand} + */ + unlabelParameterVersion( args: UnlabelParameterVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public unlabelParameterVersion( + unlabelParameterVersion( args: UnlabelParameterVersionCommandInput, cb: (err: any, data?: UnlabelParameterVersionCommandOutput) => void ): void; - public unlabelParameterVersion( + unlabelParameterVersion( args: UnlabelParameterVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnlabelParameterVersionCommandOutput) => void ): void; - public unlabelParameterVersion( - args: UnlabelParameterVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnlabelParameterVersionCommandOutput) => void), - cb?: (err: any, data?: UnlabelParameterVersionCommandOutput) => void - ): Promise | void { - const command = new UnlabelParameterVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an association. You can update the association name and version, the document - * version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you - * call UpdateAssociation, the system removes all optional parameters from the request - * and overwrites the association with null values for those parameters. This is by design. You must - * specify all optional parameters in the call, even if you are not changing the parameters. This - * includes the Name parameter. Before calling this API action, we recommend that you - * call the DescribeAssociation API operation and make a note of all optional - * parameters required for your UpdateAssociation call.

- *

In order to call this API operation, a user, group, or role must be granted permission to - * call the DescribeAssociation API operation. If you don't have permission to - * call DescribeAssociation, then you receive the following error: An error - * occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: - * isn't authorized to perform: ssm:DescribeAssociation on resource: - * - *

- * - *

When you update an association, the association immediately runs against the specified - * targets. You can add the ApplyOnlyAtCronInterval parameter to run the association - * during the next schedule run.

- *
- */ - public updateAssociation( + + /** + * @see {@link UpdateAssociationCommand} + */ + updateAssociation( args: UpdateAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAssociation( + updateAssociation( args: UpdateAssociationCommandInput, cb: (err: any, data?: UpdateAssociationCommandOutput) => void ): void; - public updateAssociation( + updateAssociation( args: UpdateAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAssociationCommandOutput) => void ): void; - public updateAssociation( - args: UpdateAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAssociationCommandOutput) => void), - cb?: (err: any, data?: UpdateAssociationCommandOutput) => void - ): Promise | void { - const command = new UpdateAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified - * managed node.

- *

- * UpdateAssociationStatus is primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) to - * report status updates about your associations and is only used for associations created with the - * InstanceId legacy parameter.

- */ - public updateAssociationStatus( + + /** + * @see {@link UpdateAssociationStatusCommand} + */ + updateAssociationStatus( args: UpdateAssociationStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAssociationStatus( + updateAssociationStatus( args: UpdateAssociationStatusCommandInput, cb: (err: any, data?: UpdateAssociationStatusCommandOutput) => void ): void; - public updateAssociationStatus( + updateAssociationStatus( args: UpdateAssociationStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAssociationStatusCommandOutput) => void ): void; - public updateAssociationStatus( - args: UpdateAssociationStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAssociationStatusCommandOutput) => void), - cb?: (err: any, data?: UpdateAssociationStatusCommandOutput) => void - ): Promise | void { - const command = new UpdateAssociationStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates one or more values for an SSM document.

- */ - public updateDocument( + + /** + * @see {@link UpdateDocumentCommand} + */ + updateDocument( args: UpdateDocumentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDocument( - args: UpdateDocumentCommandInput, - cb: (err: any, data?: UpdateDocumentCommandOutput) => void - ): void; - public updateDocument( + updateDocument(args: UpdateDocumentCommandInput, cb: (err: any, data?: UpdateDocumentCommandOutput) => void): void; + updateDocument( args: UpdateDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDocumentCommandOutput) => void ): void; - public updateDocument( - args: UpdateDocumentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDocumentCommandOutput) => void), - cb?: (err: any, data?: UpdateDocumentCommandOutput) => void - ): Promise | void { - const command = new UpdateDocumentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Set the default version of a document.

- * - *

If you change a document version for a State Manager association, Systems Manager immediately runs - * the association unless you previously specifed the apply-only-at-cron-interval - * parameter.

- *
- */ - public updateDocumentDefaultVersion( + + /** + * @see {@link UpdateDocumentDefaultVersionCommand} + */ + updateDocumentDefaultVersion( args: UpdateDocumentDefaultVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDocumentDefaultVersion( + updateDocumentDefaultVersion( args: UpdateDocumentDefaultVersionCommandInput, cb: (err: any, data?: UpdateDocumentDefaultVersionCommandOutput) => void ): void; - public updateDocumentDefaultVersion( + updateDocumentDefaultVersion( args: UpdateDocumentDefaultVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDocumentDefaultVersionCommandOutput) => void ): void; - public updateDocumentDefaultVersion( - args: UpdateDocumentDefaultVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDocumentDefaultVersionCommandOutput) => void), - cb?: (err: any, data?: UpdateDocumentDefaultVersionCommandOutput) => void - ): Promise | void { - const command = new UpdateDocumentDefaultVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates information related to approval reviews for a specific version of a change template - * in Change Manager.

- */ - public updateDocumentMetadata( + + /** + * @see {@link UpdateDocumentMetadataCommand} + */ + updateDocumentMetadata( args: UpdateDocumentMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDocumentMetadata( + updateDocumentMetadata( args: UpdateDocumentMetadataCommandInput, cb: (err: any, data?: UpdateDocumentMetadataCommandOutput) => void ): void; - public updateDocumentMetadata( + updateDocumentMetadata( args: UpdateDocumentMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDocumentMetadataCommandOutput) => void ): void; - public updateDocumentMetadata( - args: UpdateDocumentMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDocumentMetadataCommandOutput) => void), - cb?: (err: any, data?: UpdateDocumentMetadataCommandOutput) => void - ): Promise | void { - const command = new UpdateDocumentMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing maintenance window. Only specified parameters are modified.

- * - *

The value you specify for Duration determines the specific end time for the - * maintenance window based on the time it begins. No maintenance window tasks are permitted to - * start after the resulting endtime minus the number of hours you specify for Cutoff. - * For example, if the maintenance window starts at 3 PM, the duration is three hours, and the - * value you specify for Cutoff is one hour, no maintenance window tasks can start - * after 5 PM.

- *
- */ - public updateMaintenanceWindow( + + /** + * @see {@link UpdateMaintenanceWindowCommand} + */ + updateMaintenanceWindow( args: UpdateMaintenanceWindowCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMaintenanceWindow( + updateMaintenanceWindow( args: UpdateMaintenanceWindowCommandInput, cb: (err: any, data?: UpdateMaintenanceWindowCommandOutput) => void ): void; - public updateMaintenanceWindow( + updateMaintenanceWindow( args: UpdateMaintenanceWindowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMaintenanceWindowCommandOutput) => void ): void; - public updateMaintenanceWindow( - args: UpdateMaintenanceWindowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMaintenanceWindowCommandOutput) => void), - cb?: (err: any, data?: UpdateMaintenanceWindowCommandOutput) => void - ): Promise | void { - const command = new UpdateMaintenanceWindowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the target of an existing maintenance window. You - * can change the following:

- *
    - *
  • - *

    Name

    - *
  • - *
  • - *

    Description

    - *
  • - *
  • - *

    Owner

    - *
  • - *
  • - *

    IDs for an ID target

    - *
  • - *
  • - *

    Tags for a Tag target

    - *
  • - *
  • - *

    From any supported tag type to another. The three supported tag types are ID target, Tag - * target, and resource group. For more information, see Target.

    - *
  • - *
- * - *

If a parameter is null, then the corresponding field isn't modified.

- *
- */ - public updateMaintenanceWindowTarget( + + /** + * @see {@link UpdateMaintenanceWindowTargetCommand} + */ + updateMaintenanceWindowTarget( args: UpdateMaintenanceWindowTargetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMaintenanceWindowTarget( + updateMaintenanceWindowTarget( args: UpdateMaintenanceWindowTargetCommandInput, cb: (err: any, data?: UpdateMaintenanceWindowTargetCommandOutput) => void ): void; - public updateMaintenanceWindowTarget( + updateMaintenanceWindowTarget( args: UpdateMaintenanceWindowTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMaintenanceWindowTargetCommandOutput) => void ): void; - public updateMaintenanceWindowTarget( - args: UpdateMaintenanceWindowTargetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMaintenanceWindowTargetCommandOutput) => void), - cb?: (err: any, data?: UpdateMaintenanceWindowTargetCommandOutput) => void - ): Promise | void { - const command = new UpdateMaintenanceWindowTargetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies a task assigned to a maintenance window. You can't change the task type, but you - * can change the following values:

- *
    - *
  • - *

    - * TaskARN. For example, you can change a RUN_COMMAND task from - * AWS-RunPowerShellScript to AWS-RunShellScript.

    - *
  • - *
  • - *

    - * ServiceRoleArn - *

    - *
  • - *
  • - *

    - * TaskInvocationParameters - *

    - *
  • - *
  • - *

    - * Priority - *

    - *
  • - *
  • - *

    - * MaxConcurrency - *

    - *
  • - *
  • - *

    - * MaxErrors - *

    - *
  • - *
- * - *

One or more targets must be specified for maintenance window Run Command-type tasks. - * Depending on the task, targets are optional for other maintenance window task types (Automation, - * Lambda, and Step Functions). For more information about running tasks - * that don't specify targets, see Registering - * maintenance window tasks without targets in the - * Amazon Web Services Systems Manager User Guide.

- *
- *

If the value for a parameter in UpdateMaintenanceWindowTask is null, then the - * corresponding field isn't modified. If you set Replace to true, then all fields - * required by the RegisterTaskWithMaintenanceWindow operation are required for - * this request. Optional fields that aren't specified are set to null.

- * - *

When you update a maintenance window task that has options specified in - * TaskInvocationParameters, you must provide again all the - * TaskInvocationParameters values that you want to retain. The values you don't - * specify again are removed. For example, suppose that when you registered a Run Command task, you - * specified TaskInvocationParameters values for Comment, - * NotificationConfig, and OutputS3BucketName. If you update the - * maintenance window task and specify only a different OutputS3BucketName value, the - * values for Comment and NotificationConfig are removed.

- *
- */ - public updateMaintenanceWindowTask( + + /** + * @see {@link UpdateMaintenanceWindowTaskCommand} + */ + updateMaintenanceWindowTask( args: UpdateMaintenanceWindowTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMaintenanceWindowTask( + updateMaintenanceWindowTask( args: UpdateMaintenanceWindowTaskCommandInput, cb: (err: any, data?: UpdateMaintenanceWindowTaskCommandOutput) => void ): void; - public updateMaintenanceWindowTask( + updateMaintenanceWindowTask( args: UpdateMaintenanceWindowTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMaintenanceWindowTaskCommandOutput) => void ): void; - public updateMaintenanceWindowTask( - args: UpdateMaintenanceWindowTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMaintenanceWindowTaskCommandOutput) => void), - cb?: (err: any, data?: UpdateMaintenanceWindowTaskCommandOutput) => void - ): Promise | void { - const command = new UpdateMaintenanceWindowTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Changes the Identity and Access Management (IAM) role that is assigned to the - * on-premises server, edge device, or virtual machines (VM). IAM roles are first - * assigned to these hybrid nodes during the activation process. For more information, see CreateActivation.

- */ - public updateManagedInstanceRole( + + /** + * @see {@link UpdateManagedInstanceRoleCommand} + */ + updateManagedInstanceRole( args: UpdateManagedInstanceRoleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateManagedInstanceRole( + updateManagedInstanceRole( args: UpdateManagedInstanceRoleCommandInput, cb: (err: any, data?: UpdateManagedInstanceRoleCommandOutput) => void ): void; - public updateManagedInstanceRole( + updateManagedInstanceRole( args: UpdateManagedInstanceRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateManagedInstanceRoleCommandOutput) => void ): void; - public updateManagedInstanceRole( - args: UpdateManagedInstanceRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateManagedInstanceRoleCommandOutput) => void), - cb?: (err: any, data?: UpdateManagedInstanceRoleCommandOutput) => void - ): Promise | void { - const command = new UpdateManagedInstanceRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see Getting started with - * OpsCenter in the Amazon Web Services Systems Manager User Guide.

- *

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and - * remediate operational issues impacting the performance and health of their Amazon Web Services resources. For - * more information, see OpsCenter in the - * Amazon Web Services Systems Manager User Guide.

- */ - public updateOpsItem( - args: UpdateOpsItemCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateOpsItem( - args: UpdateOpsItemCommandInput, - cb: (err: any, data?: UpdateOpsItemCommandOutput) => void - ): void; - public updateOpsItem( + + /** + * @see {@link UpdateOpsItemCommand} + */ + updateOpsItem(args: UpdateOpsItemCommandInput, options?: __HttpHandlerOptions): Promise; + updateOpsItem(args: UpdateOpsItemCommandInput, cb: (err: any, data?: UpdateOpsItemCommandOutput) => void): void; + updateOpsItem( args: UpdateOpsItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateOpsItemCommandOutput) => void ): void; - public updateOpsItem( - args: UpdateOpsItemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateOpsItemCommandOutput) => void), - cb?: (err: any, data?: UpdateOpsItemCommandOutput) => void - ): Promise | void { - const command = new UpdateOpsItemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.

- */ - public updateOpsMetadata( + + /** + * @see {@link UpdateOpsMetadataCommand} + */ + updateOpsMetadata( args: UpdateOpsMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateOpsMetadata( + updateOpsMetadata( args: UpdateOpsMetadataCommandInput, cb: (err: any, data?: UpdateOpsMetadataCommandOutput) => void ): void; - public updateOpsMetadata( + updateOpsMetadata( args: UpdateOpsMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateOpsMetadataCommandOutput) => void ): void; - public updateOpsMetadata( - args: UpdateOpsMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateOpsMetadataCommandOutput) => void), - cb?: (err: any, data?: UpdateOpsMetadataCommandOutput) => void - ): Promise | void { - const command = new UpdateOpsMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies an existing patch baseline. Fields not specified in the request are left - * unchanged.

- * - *

For information about valid key-value pairs in PatchFilters for each supported - * operating system type, see PatchFilter.

- *
- */ - public updatePatchBaseline( + + /** + * @see {@link UpdatePatchBaselineCommand} + */ + updatePatchBaseline( args: UpdatePatchBaselineCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePatchBaseline( + updatePatchBaseline( args: UpdatePatchBaselineCommandInput, cb: (err: any, data?: UpdatePatchBaselineCommandOutput) => void ): void; - public updatePatchBaseline( + updatePatchBaseline( args: UpdatePatchBaselineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePatchBaselineCommandOutput) => void ): void; - public updatePatchBaseline( - args: UpdatePatchBaselineCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePatchBaselineCommandOutput) => void), - cb?: (err: any, data?: UpdatePatchBaselineCommandOutput) => void - ): Promise | void { - const command = new UpdatePatchBaselineCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Update a resource data sync. After you create a resource data sync for a Region, you can't - * change the account options for that sync. For example, if you create a sync in the us-east-2 - * (Ohio) Region and you choose the Include only the current account option, you can't - * edit that sync later and choose the Include all accounts from my Organizations - * configuration option. Instead, you must delete the first resource data sync, and create a - * new one.

- * - *

This API operation only supports a resource data sync that was created with a - * SyncFromSource SyncType.

- *
- */ - public updateResourceDataSync( + + /** + * @see {@link UpdateResourceDataSyncCommand} + */ + updateResourceDataSync( args: UpdateResourceDataSyncCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateResourceDataSync( + updateResourceDataSync( args: UpdateResourceDataSyncCommandInput, cb: (err: any, data?: UpdateResourceDataSyncCommandOutput) => void ): void; - public updateResourceDataSync( + updateResourceDataSync( args: UpdateResourceDataSyncCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResourceDataSyncCommandOutput) => void ): void; - public updateResourceDataSync( - args: UpdateResourceDataSyncCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResourceDataSyncCommandOutput) => void), - cb?: (err: any, data?: UpdateResourceDataSyncCommandOutput) => void - ): Promise | void { - const command = new UpdateResourceDataSyncCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

- * ServiceSetting is an account-level setting for an Amazon Web Services service. This setting - * defines how a user interacts with or uses a service or a feature of a service. For example, if an - * Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services - * service team might create a default setting of "false". This means the user can't use this - * feature unless they change the setting to "true" and intentionally opt in for a paid - * feature.

- *

Services map a SettingId object to a setting value. Amazon Web Services services teams define - * the default value for a SettingId. You can't create a new SettingId, - * but you can overwrite the default value if you have the ssm:UpdateServiceSetting - * permission for the setting. Use the GetServiceSetting API operation to view the - * current value. Or, use the ResetServiceSetting to change the value back to the - * original value defined by the Amazon Web Services service team.

- *

Update the service setting for the account.

- */ - public updateServiceSetting( + + /** + * @see {@link UpdateServiceSettingCommand} + */ + updateServiceSetting( args: UpdateServiceSettingCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateServiceSetting( + updateServiceSetting( args: UpdateServiceSettingCommandInput, cb: (err: any, data?: UpdateServiceSettingCommandOutput) => void ): void; - public updateServiceSetting( + updateServiceSetting( args: UpdateServiceSettingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceSettingCommandOutput) => void ): void; - public updateServiceSetting( - args: UpdateServiceSettingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServiceSettingCommandOutput) => void), - cb?: (err: any, data?: UpdateServiceSettingCommandOutput) => void - ): Promise | void { - const command = new UpdateServiceSettingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure + * end-to-end management solution for hybrid cloud environments that enables safe and secure + * operations at scale.

+ *

This reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up Amazon Web Services Systems Manager.

+ *

+ * Related resources + *

+ * + */ +export class SSM extends SSMClient implements SSM {} +createAggregatedClient(commands, SSM); diff --git a/clients/client-sso-admin/src/SSOAdmin.ts b/clients/client-sso-admin/src/SSOAdmin.ts index a82c3c624e1a..a0132e4e6eee 100644 --- a/clients/client-sso-admin/src/SSOAdmin.ts +++ b/clients/client-sso-admin/src/SSOAdmin.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -182,1339 +183,685 @@ import { UpdatePermissionSetCommandInput, UpdatePermissionSetCommandOutput, } from "./commands/UpdatePermissionSetCommand"; -import { SSOAdminClient } from "./SSOAdminClient"; +import { SSOAdminClient, SSOAdminClientConfig } from "./SSOAdminClient"; -/** - * @public - *

AWS IAM Identity Center (successor to AWS Single Sign-On) helps you securely create, or connect, your workforce identities and manage their - * access centrally across AWS accounts and applications. IAM Identity Center is the recommended - * approach for workforce authentication and authorization in AWS, for organizations of any size - * and type.

- * - *

Although AWS Single Sign-On was renamed, the sso and - * identitystore API namespaces will continue to retain their original name for - * backward compatibility purposes. For more information, see IAM Identity Center rename.

- *
- *

This reference guide provides information on single sign-on operations which could be used for - * access management of AWS accounts. For information about IAM Identity Center features, see the IAM Identity Center User - * Guide.

- *

Many operations in the IAM Identity Center APIs rely on identifiers for users and groups, known as - * principals. For more information about how to work with principals and principal IDs in IAM Identity Center, - * see the Identity Store API - * Reference.

- * - *

AWS provides SDKs that consist of libraries and sample code for various programming - * languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The SDKs provide a - * convenient way to create programmatic access to IAM Identity Center and other AWS services. For more - * information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

- *
- */ -export class SSOAdmin extends SSOAdminClient { +const commands = { + AttachCustomerManagedPolicyReferenceToPermissionSetCommand, + AttachManagedPolicyToPermissionSetCommand, + CreateAccountAssignmentCommand, + CreateInstanceAccessControlAttributeConfigurationCommand, + CreatePermissionSetCommand, + DeleteAccountAssignmentCommand, + DeleteInlinePolicyFromPermissionSetCommand, + DeleteInstanceAccessControlAttributeConfigurationCommand, + DeletePermissionsBoundaryFromPermissionSetCommand, + DeletePermissionSetCommand, + DescribeAccountAssignmentCreationStatusCommand, + DescribeAccountAssignmentDeletionStatusCommand, + DescribeInstanceAccessControlAttributeConfigurationCommand, + DescribePermissionSetCommand, + DescribePermissionSetProvisioningStatusCommand, + DetachCustomerManagedPolicyReferenceFromPermissionSetCommand, + DetachManagedPolicyFromPermissionSetCommand, + GetInlinePolicyForPermissionSetCommand, + GetPermissionsBoundaryForPermissionSetCommand, + ListAccountAssignmentCreationStatusCommand, + ListAccountAssignmentDeletionStatusCommand, + ListAccountAssignmentsCommand, + ListAccountsForProvisionedPermissionSetCommand, + ListCustomerManagedPolicyReferencesInPermissionSetCommand, + ListInstancesCommand, + ListManagedPoliciesInPermissionSetCommand, + ListPermissionSetProvisioningStatusCommand, + ListPermissionSetsCommand, + ListPermissionSetsProvisionedToAccountCommand, + ListTagsForResourceCommand, + ProvisionPermissionSetCommand, + PutInlinePolicyToPermissionSetCommand, + PutPermissionsBoundaryToPermissionSetCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateInstanceAccessControlAttributeConfigurationCommand, + UpdatePermissionSetCommand, +}; + +export interface SSOAdmin { /** - * @public - *

Attaches the specified customer managed policy to the specified PermissionSet.

+ * @see {@link AttachCustomerManagedPolicyReferenceToPermissionSetCommand} */ - public attachCustomerManagedPolicyReferenceToPermissionSet( + attachCustomerManagedPolicyReferenceToPermissionSet( args: AttachCustomerManagedPolicyReferenceToPermissionSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachCustomerManagedPolicyReferenceToPermissionSet( + attachCustomerManagedPolicyReferenceToPermissionSet( args: AttachCustomerManagedPolicyReferenceToPermissionSetCommandInput, cb: (err: any, data?: AttachCustomerManagedPolicyReferenceToPermissionSetCommandOutput) => void ): void; - public attachCustomerManagedPolicyReferenceToPermissionSet( + attachCustomerManagedPolicyReferenceToPermissionSet( args: AttachCustomerManagedPolicyReferenceToPermissionSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachCustomerManagedPolicyReferenceToPermissionSetCommandOutput) => void ): void; - public attachCustomerManagedPolicyReferenceToPermissionSet( - args: AttachCustomerManagedPolicyReferenceToPermissionSetCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AttachCustomerManagedPolicyReferenceToPermissionSetCommandOutput) => void), - cb?: (err: any, data?: AttachCustomerManagedPolicyReferenceToPermissionSetCommandOutput) => void - ): Promise | void { - const command = new AttachCustomerManagedPolicyReferenceToPermissionSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Attaches an AWS managed policy ARN to a permission set.

- * - *

If the permission set is already referenced by one or more account assignments, you will - * need to call - * ProvisionPermissionSet - * after this operation. - * Calling ProvisionPermissionSet applies the corresponding IAM policy updates - * to all assigned accounts.

- *
+ * @see {@link AttachManagedPolicyToPermissionSetCommand} */ - public attachManagedPolicyToPermissionSet( + attachManagedPolicyToPermissionSet( args: AttachManagedPolicyToPermissionSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public attachManagedPolicyToPermissionSet( + attachManagedPolicyToPermissionSet( args: AttachManagedPolicyToPermissionSetCommandInput, cb: (err: any, data?: AttachManagedPolicyToPermissionSetCommandOutput) => void ): void; - public attachManagedPolicyToPermissionSet( + attachManagedPolicyToPermissionSet( args: AttachManagedPolicyToPermissionSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachManagedPolicyToPermissionSetCommandOutput) => void ): void; - public attachManagedPolicyToPermissionSet( - args: AttachManagedPolicyToPermissionSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachManagedPolicyToPermissionSetCommandOutput) => void), - cb?: (err: any, data?: AttachManagedPolicyToPermissionSetCommandOutput) => void - ): Promise | void { - const command = new AttachManagedPolicyToPermissionSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns access to a principal for a specified AWS account using a specified - * permission set.

- * - *

The term principal here refers to a user or group that is defined - * in IAM Identity Center.

- *
- * - *

As part of a successful CreateAccountAssignment call, the specified - * permission set will automatically be provisioned to the account in the form of an IAM - * policy. That policy is attached to the IAM role created in IAM Identity Center. If the permission set - * is subsequently updated, the corresponding IAM policies attached to roles in your accounts - * will not be updated automatically. In this case, you must call - * ProvisionPermissionSet - * to make these updates.

- *
- * - *

- * After a successful response, call DescribeAccountAssignmentCreationStatus to describe the status of an assignment creation request. - *

- *
+ * @see {@link CreateAccountAssignmentCommand} */ - public createAccountAssignment( + createAccountAssignment( args: CreateAccountAssignmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAccountAssignment( + createAccountAssignment( args: CreateAccountAssignmentCommandInput, cb: (err: any, data?: CreateAccountAssignmentCommandOutput) => void ): void; - public createAccountAssignment( + createAccountAssignment( args: CreateAccountAssignmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccountAssignmentCommandOutput) => void ): void; - public createAccountAssignment( - args: CreateAccountAssignmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAccountAssignmentCommandOutput) => void), - cb?: (err: any, data?: CreateAccountAssignmentCommandOutput) => void - ): Promise | void { - const command = new CreateAccountAssignmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center - * instance. You can also specify new attributes to add to your ABAC configuration during the - * enabling process. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.

- * - *

After a successful response, call DescribeInstanceAccessControlAttributeConfiguration to validate that - * InstanceAccessControlAttributeConfiguration was created.

- *
+ * @see {@link CreateInstanceAccessControlAttributeConfigurationCommand} */ - public createInstanceAccessControlAttributeConfiguration( + createInstanceAccessControlAttributeConfiguration( args: CreateInstanceAccessControlAttributeConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createInstanceAccessControlAttributeConfiguration( + createInstanceAccessControlAttributeConfiguration( args: CreateInstanceAccessControlAttributeConfigurationCommandInput, cb: (err: any, data?: CreateInstanceAccessControlAttributeConfigurationCommandOutput) => void ): void; - public createInstanceAccessControlAttributeConfiguration( + createInstanceAccessControlAttributeConfiguration( args: CreateInstanceAccessControlAttributeConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInstanceAccessControlAttributeConfigurationCommandOutput) => void ): void; - public createInstanceAccessControlAttributeConfiguration( - args: CreateInstanceAccessControlAttributeConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateInstanceAccessControlAttributeConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateInstanceAccessControlAttributeConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateInstanceAccessControlAttributeConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a permission set within a specified IAM Identity Center instance.

- * - *

To grant users and groups access to AWS account resources, use - * CreateAccountAssignment - * .

- *
+ * @see {@link CreatePermissionSetCommand} */ - public createPermissionSet( + createPermissionSet( args: CreatePermissionSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createPermissionSet( + createPermissionSet( args: CreatePermissionSetCommandInput, cb: (err: any, data?: CreatePermissionSetCommandOutput) => void ): void; - public createPermissionSet( + createPermissionSet( args: CreatePermissionSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePermissionSetCommandOutput) => void ): void; - public createPermissionSet( - args: CreatePermissionSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePermissionSetCommandOutput) => void), - cb?: (err: any, data?: CreatePermissionSetCommandOutput) => void - ): Promise | void { - const command = new CreatePermissionSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a principal's access from a specified AWS account using a specified permission - * set.

- * - *

After a successful response, call DescribeAccountAssignmentCreationStatus to describe the status of an assignment deletion request.

- *
+ * @see {@link DeleteAccountAssignmentCommand} */ - public deleteAccountAssignment( + deleteAccountAssignment( args: DeleteAccountAssignmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAccountAssignment( + deleteAccountAssignment( args: DeleteAccountAssignmentCommandInput, cb: (err: any, data?: DeleteAccountAssignmentCommandOutput) => void ): void; - public deleteAccountAssignment( + deleteAccountAssignment( args: DeleteAccountAssignmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccountAssignmentCommandOutput) => void ): void; - public deleteAccountAssignment( - args: DeleteAccountAssignmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAccountAssignmentCommandOutput) => void), - cb?: (err: any, data?: DeleteAccountAssignmentCommandOutput) => void - ): Promise | void { - const command = new DeleteAccountAssignmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the inline policy from a specified permission set.

+ * @see {@link DeleteInlinePolicyFromPermissionSetCommand} */ - public deleteInlinePolicyFromPermissionSet( + deleteInlinePolicyFromPermissionSet( args: DeleteInlinePolicyFromPermissionSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInlinePolicyFromPermissionSet( + deleteInlinePolicyFromPermissionSet( args: DeleteInlinePolicyFromPermissionSetCommandInput, cb: (err: any, data?: DeleteInlinePolicyFromPermissionSetCommandOutput) => void ): void; - public deleteInlinePolicyFromPermissionSet( + deleteInlinePolicyFromPermissionSet( args: DeleteInlinePolicyFromPermissionSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInlinePolicyFromPermissionSetCommandOutput) => void ): void; - public deleteInlinePolicyFromPermissionSet( - args: DeleteInlinePolicyFromPermissionSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteInlinePolicyFromPermissionSetCommandOutput) => void), - cb?: (err: any, data?: DeleteInlinePolicyFromPermissionSetCommandOutput) => void - ): Promise | void { - const command = new DeleteInlinePolicyFromPermissionSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disables the attributes-based access control (ABAC) feature for the specified IAM Identity Center - * instance and deletes all of the attribute mappings that have been configured. Once deleted, - * any attributes that are received from an identity source and any custom attributes you have - * previously configured will not be passed. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.

+ * @see {@link DeleteInstanceAccessControlAttributeConfigurationCommand} */ - public deleteInstanceAccessControlAttributeConfiguration( + deleteInstanceAccessControlAttributeConfiguration( args: DeleteInstanceAccessControlAttributeConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteInstanceAccessControlAttributeConfiguration( + deleteInstanceAccessControlAttributeConfiguration( args: DeleteInstanceAccessControlAttributeConfigurationCommandInput, cb: (err: any, data?: DeleteInstanceAccessControlAttributeConfigurationCommandOutput) => void ): void; - public deleteInstanceAccessControlAttributeConfiguration( + deleteInstanceAccessControlAttributeConfiguration( args: DeleteInstanceAccessControlAttributeConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInstanceAccessControlAttributeConfigurationCommandOutput) => void ): void; - public deleteInstanceAccessControlAttributeConfiguration( - args: DeleteInstanceAccessControlAttributeConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteInstanceAccessControlAttributeConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteInstanceAccessControlAttributeConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteInstanceAccessControlAttributeConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the permissions boundary from a specified PermissionSet.

+ * @see {@link DeletePermissionsBoundaryFromPermissionSetCommand} */ - public deletePermissionsBoundaryFromPermissionSet( + deletePermissionsBoundaryFromPermissionSet( args: DeletePermissionsBoundaryFromPermissionSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePermissionsBoundaryFromPermissionSet( + deletePermissionsBoundaryFromPermissionSet( args: DeletePermissionsBoundaryFromPermissionSetCommandInput, cb: (err: any, data?: DeletePermissionsBoundaryFromPermissionSetCommandOutput) => void ): void; - public deletePermissionsBoundaryFromPermissionSet( + deletePermissionsBoundaryFromPermissionSet( args: DeletePermissionsBoundaryFromPermissionSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePermissionsBoundaryFromPermissionSetCommandOutput) => void ): void; - public deletePermissionsBoundaryFromPermissionSet( - args: DeletePermissionsBoundaryFromPermissionSetCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeletePermissionsBoundaryFromPermissionSetCommandOutput) => void), - cb?: (err: any, data?: DeletePermissionsBoundaryFromPermissionSetCommandOutput) => void - ): Promise | void { - const command = new DeletePermissionsBoundaryFromPermissionSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified permission set.

+ * @see {@link DeletePermissionSetCommand} */ - public deletePermissionSet( + deletePermissionSet( args: DeletePermissionSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePermissionSet( + deletePermissionSet( args: DeletePermissionSetCommandInput, cb: (err: any, data?: DeletePermissionSetCommandOutput) => void ): void; - public deletePermissionSet( + deletePermissionSet( args: DeletePermissionSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePermissionSetCommandOutput) => void ): void; - public deletePermissionSet( - args: DeletePermissionSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePermissionSetCommandOutput) => void), - cb?: (err: any, data?: DeletePermissionSetCommandOutput) => void - ): Promise | void { - const command = new DeletePermissionSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the status of the assignment creation request.

+ * @see {@link DescribeAccountAssignmentCreationStatusCommand} */ - public describeAccountAssignmentCreationStatus( + describeAccountAssignmentCreationStatus( args: DescribeAccountAssignmentCreationStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccountAssignmentCreationStatus( + describeAccountAssignmentCreationStatus( args: DescribeAccountAssignmentCreationStatusCommandInput, cb: (err: any, data?: DescribeAccountAssignmentCreationStatusCommandOutput) => void ): void; - public describeAccountAssignmentCreationStatus( + describeAccountAssignmentCreationStatus( args: DescribeAccountAssignmentCreationStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountAssignmentCreationStatusCommandOutput) => void ): void; - public describeAccountAssignmentCreationStatus( - args: DescribeAccountAssignmentCreationStatusCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeAccountAssignmentCreationStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountAssignmentCreationStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountAssignmentCreationStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the status of the assignment deletion request.

+ * @see {@link DescribeAccountAssignmentDeletionStatusCommand} */ - public describeAccountAssignmentDeletionStatus( + describeAccountAssignmentDeletionStatus( args: DescribeAccountAssignmentDeletionStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccountAssignmentDeletionStatus( + describeAccountAssignmentDeletionStatus( args: DescribeAccountAssignmentDeletionStatusCommandInput, cb: (err: any, data?: DescribeAccountAssignmentDeletionStatusCommandOutput) => void ): void; - public describeAccountAssignmentDeletionStatus( + describeAccountAssignmentDeletionStatus( args: DescribeAccountAssignmentDeletionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountAssignmentDeletionStatusCommandOutput) => void ): void; - public describeAccountAssignmentDeletionStatus( - args: DescribeAccountAssignmentDeletionStatusCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeAccountAssignmentDeletionStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountAssignmentDeletionStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountAssignmentDeletionStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the list of IAM Identity Center identity store attributes that have been configured to work - * with attributes-based access control (ABAC) for the specified IAM Identity Center instance. This will not - * return attributes configured and sent by an external identity provider. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.

+ * @see {@link DescribeInstanceAccessControlAttributeConfigurationCommand} */ - public describeInstanceAccessControlAttributeConfiguration( + describeInstanceAccessControlAttributeConfiguration( args: DescribeInstanceAccessControlAttributeConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInstanceAccessControlAttributeConfiguration( + describeInstanceAccessControlAttributeConfiguration( args: DescribeInstanceAccessControlAttributeConfigurationCommandInput, cb: (err: any, data?: DescribeInstanceAccessControlAttributeConfigurationCommandOutput) => void ): void; - public describeInstanceAccessControlAttributeConfiguration( + describeInstanceAccessControlAttributeConfiguration( args: DescribeInstanceAccessControlAttributeConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstanceAccessControlAttributeConfigurationCommandOutput) => void ): void; - public describeInstanceAccessControlAttributeConfiguration( - args: DescribeInstanceAccessControlAttributeConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeInstanceAccessControlAttributeConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeInstanceAccessControlAttributeConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeInstanceAccessControlAttributeConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the details of the permission set.

+ * @see {@link DescribePermissionSetCommand} */ - public describePermissionSet( + describePermissionSet( args: DescribePermissionSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePermissionSet( + describePermissionSet( args: DescribePermissionSetCommandInput, cb: (err: any, data?: DescribePermissionSetCommandOutput) => void ): void; - public describePermissionSet( + describePermissionSet( args: DescribePermissionSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePermissionSetCommandOutput) => void ): void; - public describePermissionSet( - args: DescribePermissionSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribePermissionSetCommandOutput) => void), - cb?: (err: any, data?: DescribePermissionSetCommandOutput) => void - ): Promise | void { - const command = new DescribePermissionSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the status for the given permission set provisioning request.

+ * @see {@link DescribePermissionSetProvisioningStatusCommand} */ - public describePermissionSetProvisioningStatus( + describePermissionSetProvisioningStatus( args: DescribePermissionSetProvisioningStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describePermissionSetProvisioningStatus( + describePermissionSetProvisioningStatus( args: DescribePermissionSetProvisioningStatusCommandInput, cb: (err: any, data?: DescribePermissionSetProvisioningStatusCommandOutput) => void ): void; - public describePermissionSetProvisioningStatus( + describePermissionSetProvisioningStatus( args: DescribePermissionSetProvisioningStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePermissionSetProvisioningStatusCommandOutput) => void ): void; - public describePermissionSetProvisioningStatus( - args: DescribePermissionSetProvisioningStatusCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribePermissionSetProvisioningStatusCommandOutput) => void), - cb?: (err: any, data?: DescribePermissionSetProvisioningStatusCommandOutput) => void - ): Promise | void { - const command = new DescribePermissionSetProvisioningStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Detaches the specified customer managed policy from the specified PermissionSet.

+ * @see {@link DetachCustomerManagedPolicyReferenceFromPermissionSetCommand} */ - public detachCustomerManagedPolicyReferenceFromPermissionSet( + detachCustomerManagedPolicyReferenceFromPermissionSet( args: DetachCustomerManagedPolicyReferenceFromPermissionSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachCustomerManagedPolicyReferenceFromPermissionSet( + detachCustomerManagedPolicyReferenceFromPermissionSet( args: DetachCustomerManagedPolicyReferenceFromPermissionSetCommandInput, cb: (err: any, data?: DetachCustomerManagedPolicyReferenceFromPermissionSetCommandOutput) => void ): void; - public detachCustomerManagedPolicyReferenceFromPermissionSet( + detachCustomerManagedPolicyReferenceFromPermissionSet( args: DetachCustomerManagedPolicyReferenceFromPermissionSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachCustomerManagedPolicyReferenceFromPermissionSetCommandOutput) => void ): void; - public detachCustomerManagedPolicyReferenceFromPermissionSet( - args: DetachCustomerManagedPolicyReferenceFromPermissionSetCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DetachCustomerManagedPolicyReferenceFromPermissionSetCommandOutput) => void), - cb?: (err: any, data?: DetachCustomerManagedPolicyReferenceFromPermissionSetCommandOutput) => void - ): Promise | void { - const command = new DetachCustomerManagedPolicyReferenceFromPermissionSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Detaches the attached AWS managed policy ARN from the specified permission set.

+ * @see {@link DetachManagedPolicyFromPermissionSetCommand} */ - public detachManagedPolicyFromPermissionSet( + detachManagedPolicyFromPermissionSet( args: DetachManagedPolicyFromPermissionSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public detachManagedPolicyFromPermissionSet( + detachManagedPolicyFromPermissionSet( args: DetachManagedPolicyFromPermissionSetCommandInput, cb: (err: any, data?: DetachManagedPolicyFromPermissionSetCommandOutput) => void ): void; - public detachManagedPolicyFromPermissionSet( + detachManagedPolicyFromPermissionSet( args: DetachManagedPolicyFromPermissionSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachManagedPolicyFromPermissionSetCommandOutput) => void ): void; - public detachManagedPolicyFromPermissionSet( - args: DetachManagedPolicyFromPermissionSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachManagedPolicyFromPermissionSetCommandOutput) => void), - cb?: (err: any, data?: DetachManagedPolicyFromPermissionSetCommandOutput) => void - ): Promise | void { - const command = new DetachManagedPolicyFromPermissionSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Obtains the inline policy assigned to the permission set.

+ * @see {@link GetInlinePolicyForPermissionSetCommand} */ - public getInlinePolicyForPermissionSet( + getInlinePolicyForPermissionSet( args: GetInlinePolicyForPermissionSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInlinePolicyForPermissionSet( + getInlinePolicyForPermissionSet( args: GetInlinePolicyForPermissionSetCommandInput, cb: (err: any, data?: GetInlinePolicyForPermissionSetCommandOutput) => void ): void; - public getInlinePolicyForPermissionSet( + getInlinePolicyForPermissionSet( args: GetInlinePolicyForPermissionSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInlinePolicyForPermissionSetCommandOutput) => void ): void; - public getInlinePolicyForPermissionSet( - args: GetInlinePolicyForPermissionSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInlinePolicyForPermissionSetCommandOutput) => void), - cb?: (err: any, data?: GetInlinePolicyForPermissionSetCommandOutput) => void - ): Promise | void { - const command = new GetInlinePolicyForPermissionSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Obtains the permissions boundary for a specified PermissionSet.

+ * @see {@link GetPermissionsBoundaryForPermissionSetCommand} */ - public getPermissionsBoundaryForPermissionSet( + getPermissionsBoundaryForPermissionSet( args: GetPermissionsBoundaryForPermissionSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPermissionsBoundaryForPermissionSet( + getPermissionsBoundaryForPermissionSet( args: GetPermissionsBoundaryForPermissionSetCommandInput, cb: (err: any, data?: GetPermissionsBoundaryForPermissionSetCommandOutput) => void ): void; - public getPermissionsBoundaryForPermissionSet( + getPermissionsBoundaryForPermissionSet( args: GetPermissionsBoundaryForPermissionSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPermissionsBoundaryForPermissionSetCommandOutput) => void ): void; - public getPermissionsBoundaryForPermissionSet( - args: GetPermissionsBoundaryForPermissionSetCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: GetPermissionsBoundaryForPermissionSetCommandOutput) => void), - cb?: (err: any, data?: GetPermissionsBoundaryForPermissionSetCommandOutput) => void - ): Promise | void { - const command = new GetPermissionsBoundaryForPermissionSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the status of the AWS account assignment creation requests for a specified IAM Identity Center - * instance.

+ * @see {@link ListAccountAssignmentCreationStatusCommand} */ - public listAccountAssignmentCreationStatus( + listAccountAssignmentCreationStatus( args: ListAccountAssignmentCreationStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAccountAssignmentCreationStatus( + listAccountAssignmentCreationStatus( args: ListAccountAssignmentCreationStatusCommandInput, cb: (err: any, data?: ListAccountAssignmentCreationStatusCommandOutput) => void ): void; - public listAccountAssignmentCreationStatus( + listAccountAssignmentCreationStatus( args: ListAccountAssignmentCreationStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccountAssignmentCreationStatusCommandOutput) => void ): void; - public listAccountAssignmentCreationStatus( - args: ListAccountAssignmentCreationStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccountAssignmentCreationStatusCommandOutput) => void), - cb?: (err: any, data?: ListAccountAssignmentCreationStatusCommandOutput) => void - ): Promise | void { - const command = new ListAccountAssignmentCreationStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the status of the AWS account assignment deletion requests for a specified IAM Identity Center - * instance.

+ * @see {@link ListAccountAssignmentDeletionStatusCommand} */ - public listAccountAssignmentDeletionStatus( + listAccountAssignmentDeletionStatus( args: ListAccountAssignmentDeletionStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAccountAssignmentDeletionStatus( + listAccountAssignmentDeletionStatus( args: ListAccountAssignmentDeletionStatusCommandInput, cb: (err: any, data?: ListAccountAssignmentDeletionStatusCommandOutput) => void ): void; - public listAccountAssignmentDeletionStatus( + listAccountAssignmentDeletionStatus( args: ListAccountAssignmentDeletionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccountAssignmentDeletionStatusCommandOutput) => void ): void; - public listAccountAssignmentDeletionStatus( - args: ListAccountAssignmentDeletionStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccountAssignmentDeletionStatusCommandOutput) => void), - cb?: (err: any, data?: ListAccountAssignmentDeletionStatusCommandOutput) => void - ): Promise | void { - const command = new ListAccountAssignmentDeletionStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the assignee of the specified AWS account with the specified permission set.

+ * @see {@link ListAccountAssignmentsCommand} */ - public listAccountAssignments( + listAccountAssignments( args: ListAccountAssignmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAccountAssignments( + listAccountAssignments( args: ListAccountAssignmentsCommandInput, cb: (err: any, data?: ListAccountAssignmentsCommandOutput) => void ): void; - public listAccountAssignments( + listAccountAssignments( args: ListAccountAssignmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccountAssignmentsCommandOutput) => void ): void; - public listAccountAssignments( - args: ListAccountAssignmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccountAssignmentsCommandOutput) => void), - cb?: (err: any, data?: ListAccountAssignmentsCommandOutput) => void - ): Promise | void { - const command = new ListAccountAssignmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the AWS accounts where the specified permission set is provisioned.

+ * @see {@link ListAccountsForProvisionedPermissionSetCommand} */ - public listAccountsForProvisionedPermissionSet( + listAccountsForProvisionedPermissionSet( args: ListAccountsForProvisionedPermissionSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAccountsForProvisionedPermissionSet( + listAccountsForProvisionedPermissionSet( args: ListAccountsForProvisionedPermissionSetCommandInput, cb: (err: any, data?: ListAccountsForProvisionedPermissionSetCommandOutput) => void ): void; - public listAccountsForProvisionedPermissionSet( + listAccountsForProvisionedPermissionSet( args: ListAccountsForProvisionedPermissionSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccountsForProvisionedPermissionSetCommandOutput) => void ): void; - public listAccountsForProvisionedPermissionSet( - args: ListAccountsForProvisionedPermissionSetCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListAccountsForProvisionedPermissionSetCommandOutput) => void), - cb?: (err: any, data?: ListAccountsForProvisionedPermissionSetCommandOutput) => void - ): Promise | void { - const command = new ListAccountsForProvisionedPermissionSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all customer managed policies attached to a specified PermissionSet.

+ * @see {@link ListCustomerManagedPolicyReferencesInPermissionSetCommand} */ - public listCustomerManagedPolicyReferencesInPermissionSet( + listCustomerManagedPolicyReferencesInPermissionSet( args: ListCustomerManagedPolicyReferencesInPermissionSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCustomerManagedPolicyReferencesInPermissionSet( + listCustomerManagedPolicyReferencesInPermissionSet( args: ListCustomerManagedPolicyReferencesInPermissionSetCommandInput, cb: (err: any, data?: ListCustomerManagedPolicyReferencesInPermissionSetCommandOutput) => void ): void; - public listCustomerManagedPolicyReferencesInPermissionSet( + listCustomerManagedPolicyReferencesInPermissionSet( args: ListCustomerManagedPolicyReferencesInPermissionSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCustomerManagedPolicyReferencesInPermissionSetCommandOutput) => void ): void; - public listCustomerManagedPolicyReferencesInPermissionSet( - args: ListCustomerManagedPolicyReferencesInPermissionSetCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListCustomerManagedPolicyReferencesInPermissionSetCommandOutput) => void), - cb?: (err: any, data?: ListCustomerManagedPolicyReferencesInPermissionSetCommandOutput) => void - ): Promise | void { - const command = new ListCustomerManagedPolicyReferencesInPermissionSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the IAM Identity Center instances that the caller has access to.

+ * @see {@link ListInstancesCommand} */ - public listInstances( - args: ListInstancesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listInstances( - args: ListInstancesCommandInput, - cb: (err: any, data?: ListInstancesCommandOutput) => void - ): void; - public listInstances( + listInstances(args: ListInstancesCommandInput, options?: __HttpHandlerOptions): Promise; + listInstances(args: ListInstancesCommandInput, cb: (err: any, data?: ListInstancesCommandOutput) => void): void; + listInstances( args: ListInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInstancesCommandOutput) => void ): void; - public listInstances( - args: ListInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListInstancesCommandOutput) => void), - cb?: (err: any, data?: ListInstancesCommandOutput) => void - ): Promise | void { - const command = new ListInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the AWS managed policy that is attached to a specified permission set.

+ * @see {@link ListManagedPoliciesInPermissionSetCommand} */ - public listManagedPoliciesInPermissionSet( + listManagedPoliciesInPermissionSet( args: ListManagedPoliciesInPermissionSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public listManagedPoliciesInPermissionSet( + listManagedPoliciesInPermissionSet( args: ListManagedPoliciesInPermissionSetCommandInput, cb: (err: any, data?: ListManagedPoliciesInPermissionSetCommandOutput) => void ): void; - public listManagedPoliciesInPermissionSet( + listManagedPoliciesInPermissionSet( args: ListManagedPoliciesInPermissionSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListManagedPoliciesInPermissionSetCommandOutput) => void ): void; - public listManagedPoliciesInPermissionSet( - args: ListManagedPoliciesInPermissionSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListManagedPoliciesInPermissionSetCommandOutput) => void), - cb?: (err: any, data?: ListManagedPoliciesInPermissionSetCommandOutput) => void - ): Promise | void { - const command = new ListManagedPoliciesInPermissionSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the status of the permission set provisioning requests for a specified IAM Identity Center - * instance.

+ * @see {@link ListPermissionSetProvisioningStatusCommand} */ - public listPermissionSetProvisioningStatus( + listPermissionSetProvisioningStatus( args: ListPermissionSetProvisioningStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPermissionSetProvisioningStatus( + listPermissionSetProvisioningStatus( args: ListPermissionSetProvisioningStatusCommandInput, cb: (err: any, data?: ListPermissionSetProvisioningStatusCommandOutput) => void ): void; - public listPermissionSetProvisioningStatus( + listPermissionSetProvisioningStatus( args: ListPermissionSetProvisioningStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPermissionSetProvisioningStatusCommandOutput) => void ): void; - public listPermissionSetProvisioningStatus( - args: ListPermissionSetProvisioningStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPermissionSetProvisioningStatusCommandOutput) => void), - cb?: (err: any, data?: ListPermissionSetProvisioningStatusCommandOutput) => void - ): Promise | void { - const command = new ListPermissionSetProvisioningStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the PermissionSets in an IAM Identity Center instance.

+ * @see {@link ListPermissionSetsCommand} */ - public listPermissionSets( + listPermissionSets( args: ListPermissionSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPermissionSets( + listPermissionSets( args: ListPermissionSetsCommandInput, cb: (err: any, data?: ListPermissionSetsCommandOutput) => void ): void; - public listPermissionSets( + listPermissionSets( args: ListPermissionSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPermissionSetsCommandOutput) => void ): void; - public listPermissionSets( - args: ListPermissionSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPermissionSetsCommandOutput) => void), - cb?: (err: any, data?: ListPermissionSetsCommandOutput) => void - ): Promise | void { - const command = new ListPermissionSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the permission sets that are provisioned to a specified AWS account.

+ * @see {@link ListPermissionSetsProvisionedToAccountCommand} */ - public listPermissionSetsProvisionedToAccount( + listPermissionSetsProvisionedToAccount( args: ListPermissionSetsProvisionedToAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public listPermissionSetsProvisionedToAccount( + listPermissionSetsProvisionedToAccount( args: ListPermissionSetsProvisionedToAccountCommandInput, cb: (err: any, data?: ListPermissionSetsProvisionedToAccountCommandOutput) => void ): void; - public listPermissionSetsProvisionedToAccount( + listPermissionSetsProvisionedToAccount( args: ListPermissionSetsProvisionedToAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPermissionSetsProvisionedToAccountCommandOutput) => void ): void; - public listPermissionSetsProvisionedToAccount( - args: ListPermissionSetsProvisionedToAccountCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListPermissionSetsProvisionedToAccountCommandOutput) => void), - cb?: (err: any, data?: ListPermissionSetsProvisionedToAccountCommandOutput) => void - ): Promise | void { - const command = new ListPermissionSetsProvisionedToAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags that are attached to a specified resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

The process by which a specified permission set is provisioned to the specified - * target.

+ * @see {@link ProvisionPermissionSetCommand} */ - public provisionPermissionSet( + provisionPermissionSet( args: ProvisionPermissionSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public provisionPermissionSet( + provisionPermissionSet( args: ProvisionPermissionSetCommandInput, cb: (err: any, data?: ProvisionPermissionSetCommandOutput) => void ): void; - public provisionPermissionSet( + provisionPermissionSet( args: ProvisionPermissionSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ProvisionPermissionSetCommandOutput) => void ): void; - public provisionPermissionSet( - args: ProvisionPermissionSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ProvisionPermissionSetCommandOutput) => void), - cb?: (err: any, data?: ProvisionPermissionSetCommandOutput) => void - ): Promise | void { - const command = new ProvisionPermissionSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Attaches an inline policy to a permission set.

- * - *

If the permission set is already referenced by one or more account assignments, you will - * need to call - * ProvisionPermissionSet - * after this action to - * apply the corresponding IAM policy updates to all assigned accounts.

- *
+ * @see {@link PutInlinePolicyToPermissionSetCommand} */ - public putInlinePolicyToPermissionSet( + putInlinePolicyToPermissionSet( args: PutInlinePolicyToPermissionSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public putInlinePolicyToPermissionSet( + putInlinePolicyToPermissionSet( args: PutInlinePolicyToPermissionSetCommandInput, cb: (err: any, data?: PutInlinePolicyToPermissionSetCommandOutput) => void ): void; - public putInlinePolicyToPermissionSet( + putInlinePolicyToPermissionSet( args: PutInlinePolicyToPermissionSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutInlinePolicyToPermissionSetCommandOutput) => void ): void; - public putInlinePolicyToPermissionSet( - args: PutInlinePolicyToPermissionSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutInlinePolicyToPermissionSetCommandOutput) => void), - cb?: (err: any, data?: PutInlinePolicyToPermissionSetCommandOutput) => void - ): Promise | void { - const command = new PutInlinePolicyToPermissionSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Attaches an AWS managed or customer managed policy to the specified PermissionSet as a permissions boundary.

+ * @see {@link PutPermissionsBoundaryToPermissionSetCommand} */ - public putPermissionsBoundaryToPermissionSet( + putPermissionsBoundaryToPermissionSet( args: PutPermissionsBoundaryToPermissionSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public putPermissionsBoundaryToPermissionSet( + putPermissionsBoundaryToPermissionSet( args: PutPermissionsBoundaryToPermissionSetCommandInput, cb: (err: any, data?: PutPermissionsBoundaryToPermissionSetCommandOutput) => void ): void; - public putPermissionsBoundaryToPermissionSet( + putPermissionsBoundaryToPermissionSet( args: PutPermissionsBoundaryToPermissionSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPermissionsBoundaryToPermissionSetCommandOutput) => void ): void; - public putPermissionsBoundaryToPermissionSet( - args: PutPermissionsBoundaryToPermissionSetCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: PutPermissionsBoundaryToPermissionSetCommandOutput) => void), - cb?: (err: any, data?: PutPermissionsBoundaryToPermissionSetCommandOutput) => void - ): Promise | void { - const command = new PutPermissionsBoundaryToPermissionSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a set of tags with a specified resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates a set of tags from a specified resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance - * for attributes-based access control (ABAC). When using an external identity provider as an - * identity source, you can pass attributes through the SAML assertion as an alternative to - * configuring attributes from the IAM Identity Center identity store. If a SAML assertion passes any of - * these attributes, IAM Identity Center replaces the attribute value with the value from the IAM Identity Center - * identity store. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.

+ * @see {@link UpdateInstanceAccessControlAttributeConfigurationCommand} */ - public updateInstanceAccessControlAttributeConfiguration( + updateInstanceAccessControlAttributeConfiguration( args: UpdateInstanceAccessControlAttributeConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateInstanceAccessControlAttributeConfiguration( + updateInstanceAccessControlAttributeConfiguration( args: UpdateInstanceAccessControlAttributeConfigurationCommandInput, cb: (err: any, data?: UpdateInstanceAccessControlAttributeConfigurationCommandOutput) => void ): void; - public updateInstanceAccessControlAttributeConfiguration( + updateInstanceAccessControlAttributeConfiguration( args: UpdateInstanceAccessControlAttributeConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateInstanceAccessControlAttributeConfigurationCommandOutput) => void ): void; - public updateInstanceAccessControlAttributeConfiguration( - args: UpdateInstanceAccessControlAttributeConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateInstanceAccessControlAttributeConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateInstanceAccessControlAttributeConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateInstanceAccessControlAttributeConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing permission set.

+ * @see {@link UpdatePermissionSetCommand} */ - public updatePermissionSet( + updatePermissionSet( args: UpdatePermissionSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePermissionSet( + updatePermissionSet( args: UpdatePermissionSetCommandInput, cb: (err: any, data?: UpdatePermissionSetCommandOutput) => void ): void; - public updatePermissionSet( + updatePermissionSet( args: UpdatePermissionSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePermissionSetCommandOutput) => void ): void; - public updatePermissionSet( - args: UpdatePermissionSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePermissionSetCommandOutput) => void), - cb?: (err: any, data?: UpdatePermissionSetCommandOutput) => void - ): Promise | void { - const command = new UpdatePermissionSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

AWS IAM Identity Center (successor to AWS Single Sign-On) helps you securely create, or connect, your workforce identities and manage their + * access centrally across AWS accounts and applications. IAM Identity Center is the recommended + * approach for workforce authentication and authorization in AWS, for organizations of any size + * and type.

+ * + *

Although AWS Single Sign-On was renamed, the sso and + * identitystore API namespaces will continue to retain their original name for + * backward compatibility purposes. For more information, see IAM Identity Center rename.

+ *
+ *

This reference guide provides information on single sign-on operations which could be used for + * access management of AWS accounts. For information about IAM Identity Center features, see the IAM Identity Center User + * Guide.

+ *

Many operations in the IAM Identity Center APIs rely on identifiers for users and groups, known as + * principals. For more information about how to work with principals and principal IDs in IAM Identity Center, + * see the Identity Store API + * Reference.

+ * + *

AWS provides SDKs that consist of libraries and sample code for various programming + * languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The SDKs provide a + * convenient way to create programmatic access to IAM Identity Center and other AWS services. For more + * information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

+ *
+ */ +export class SSOAdmin extends SSOAdminClient implements SSOAdmin {} +createAggregatedClient(commands, SSOAdmin); diff --git a/clients/client-sso-oidc/src/SSOOIDC.ts b/clients/client-sso-oidc/src/SSOOIDC.ts index 204fdaa0a126..08d8a42b6b51 100644 --- a/clients/client-sso-oidc/src/SSOOIDC.ts +++ b/clients/client-sso-oidc/src/SSOOIDC.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { CreateTokenCommand, CreateTokenCommandInput, CreateTokenCommandOutput } from "./commands/CreateTokenCommand"; @@ -12,7 +13,57 @@ import { StartDeviceAuthorizationCommandInput, StartDeviceAuthorizationCommandOutput, } from "./commands/StartDeviceAuthorizationCommand"; -import { SSOOIDCClient } from "./SSOOIDCClient"; +import { SSOOIDCClient, SSOOIDCClientConfig } from "./SSOOIDCClient"; + +const commands = { + CreateTokenCommand, + RegisterClientCommand, + StartDeviceAuthorizationCommand, +}; + +export interface SSOOIDC { + /** + * @see {@link CreateTokenCommand} + */ + createToken(args: CreateTokenCommandInput, options?: __HttpHandlerOptions): Promise; + createToken(args: CreateTokenCommandInput, cb: (err: any, data?: CreateTokenCommandOutput) => void): void; + createToken( + args: CreateTokenCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: CreateTokenCommandOutput) => void + ): void; + + /** + * @see {@link RegisterClientCommand} + */ + registerClient( + args: RegisterClientCommandInput, + options?: __HttpHandlerOptions + ): Promise; + registerClient(args: RegisterClientCommandInput, cb: (err: any, data?: RegisterClientCommandOutput) => void): void; + registerClient( + args: RegisterClientCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: RegisterClientCommandOutput) => void + ): void; + + /** + * @see {@link StartDeviceAuthorizationCommand} + */ + startDeviceAuthorization( + args: StartDeviceAuthorizationCommandInput, + options?: __HttpHandlerOptions + ): Promise; + startDeviceAuthorization( + args: StartDeviceAuthorizationCommandInput, + cb: (err: any, data?: StartDeviceAuthorizationCommandOutput) => void + ): void; + startDeviceAuthorization( + args: StartDeviceAuthorizationCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: StartDeviceAuthorizationCommandOutput) => void + ): void; +} /** * @public @@ -57,101 +108,5 @@ import { SSOOIDCClient } from "./SSOOIDCClient"; *

For general information about IAM Identity Center, see What is * IAM Identity Center? in the IAM Identity Center User Guide.

*/ -export class SSOOIDC extends SSOOIDCClient { - /** - * @public - *

Creates and returns an access token for the authorized client. The access token issued - * will be used to fetch short-term credentials for the assigned roles in the AWS - * account.

- */ - public createToken(args: CreateTokenCommandInput, options?: __HttpHandlerOptions): Promise; - public createToken(args: CreateTokenCommandInput, cb: (err: any, data?: CreateTokenCommandOutput) => void): void; - public createToken( - args: CreateTokenCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: CreateTokenCommandOutput) => void - ): void; - public createToken( - args: CreateTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTokenCommandOutput) => void), - cb?: (err: any, data?: CreateTokenCommandOutput) => void - ): Promise | void { - const command = new CreateTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers a client with IAM Identity Center. This allows clients to initiate device authorization. - * The output should be persisted for reuse through many authentication requests.

- */ - public registerClient( - args: RegisterClientCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public registerClient( - args: RegisterClientCommandInput, - cb: (err: any, data?: RegisterClientCommandOutput) => void - ): void; - public registerClient( - args: RegisterClientCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: RegisterClientCommandOutput) => void - ): void; - public registerClient( - args: RegisterClientCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterClientCommandOutput) => void), - cb?: (err: any, data?: RegisterClientCommandOutput) => void - ): Promise | void { - const command = new RegisterClientCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Initiates device authorization by requesting a pair of verification codes from the - * authorization service.

- */ - public startDeviceAuthorization( - args: StartDeviceAuthorizationCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public startDeviceAuthorization( - args: StartDeviceAuthorizationCommandInput, - cb: (err: any, data?: StartDeviceAuthorizationCommandOutput) => void - ): void; - public startDeviceAuthorization( - args: StartDeviceAuthorizationCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: StartDeviceAuthorizationCommandOutput) => void - ): void; - public startDeviceAuthorization( - args: StartDeviceAuthorizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDeviceAuthorizationCommandOutput) => void), - cb?: (err: any, data?: StartDeviceAuthorizationCommandOutput) => void - ): Promise | void { - const command = new StartDeviceAuthorizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } -} +export class SSOOIDC extends SSOOIDCClient implements SSOOIDC {} +createAggregatedClient(commands, SSOOIDC); diff --git a/clients/client-sso/src/SSO.ts b/clients/client-sso/src/SSO.ts index 2bae1122e375..82fcfad8d502 100644 --- a/clients/client-sso/src/SSO.ts +++ b/clients/client-sso/src/SSO.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -17,169 +18,94 @@ import { ListAccountsCommandOutput, } from "./commands/ListAccountsCommand"; import { LogoutCommand, LogoutCommandInput, LogoutCommandOutput } from "./commands/LogoutCommand"; -import { SSOClient } from "./SSOClient"; +import { SSOClient, SSOClientConfig } from "./SSOClient"; -/** - * @public - *

AWS IAM Identity Center (successor to AWS Single Sign-On) Portal is a web service that makes it easy for you to assign user access to - * IAM Identity Center resources such as the AWS access portal. Users can get AWS account applications and roles - * assigned to them and get federated into the application.

- * - * - *

Although AWS Single Sign-On was renamed, the sso and - * identitystore API namespaces will continue to retain their original name for - * backward compatibility purposes. For more information, see IAM Identity Center rename.

- *
- * - *

This reference guide describes the IAM Identity Center Portal operations that you can call - * programatically and includes detailed information on data types and errors.

- * - * - *

AWS provides SDKs that consist of libraries and sample code for various programming - * languages and platforms, such as Java, Ruby, .Net, iOS, or Android. The SDKs provide a - * convenient way to create programmatic access to IAM Identity Center and other AWS services. For more - * information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

- *
- */ -export class SSO extends SSOClient { +const commands = { + GetRoleCredentialsCommand, + ListAccountRolesCommand, + ListAccountsCommand, + LogoutCommand, +}; + +export interface SSO { /** - * @public - *

Returns the STS short-term credentials for a given role name that is assigned to the - * user.

+ * @see {@link GetRoleCredentialsCommand} */ - public getRoleCredentials( + getRoleCredentials( args: GetRoleCredentialsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRoleCredentials( + getRoleCredentials( args: GetRoleCredentialsCommandInput, cb: (err: any, data?: GetRoleCredentialsCommandOutput) => void ): void; - public getRoleCredentials( + getRoleCredentials( args: GetRoleCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRoleCredentialsCommandOutput) => void ): void; - public getRoleCredentials( - args: GetRoleCredentialsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRoleCredentialsCommandOutput) => void), - cb?: (err: any, data?: GetRoleCredentialsCommandOutput) => void - ): Promise | void { - const command = new GetRoleCredentialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all roles that are assigned to the user for a given AWS account.

+ * @see {@link ListAccountRolesCommand} */ - public listAccountRoles( + listAccountRoles( args: ListAccountRolesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAccountRoles( + listAccountRoles( args: ListAccountRolesCommandInput, cb: (err: any, data?: ListAccountRolesCommandOutput) => void ): void; - public listAccountRoles( + listAccountRoles( args: ListAccountRolesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccountRolesCommandOutput) => void ): void; - public listAccountRoles( - args: ListAccountRolesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccountRolesCommandOutput) => void), - cb?: (err: any, data?: ListAccountRolesCommandOutput) => void - ): Promise | void { - const command = new ListAccountRolesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all AWS accounts assigned to the user. These AWS accounts are assigned by the - * administrator of the account. For more information, see Assign User Access in the IAM Identity Center User Guide. This operation - * returns a paginated response.

+ * @see {@link ListAccountsCommand} */ - public listAccounts( - args: ListAccountsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listAccounts(args: ListAccountsCommandInput, cb: (err: any, data?: ListAccountsCommandOutput) => void): void; - public listAccounts( + listAccounts(args: ListAccountsCommandInput, options?: __HttpHandlerOptions): Promise; + listAccounts(args: ListAccountsCommandInput, cb: (err: any, data?: ListAccountsCommandOutput) => void): void; + listAccounts( args: ListAccountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccountsCommandOutput) => void ): void; - public listAccounts( - args: ListAccountsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccountsCommandOutput) => void), - cb?: (err: any, data?: ListAccountsCommandOutput) => void - ): Promise | void { - const command = new ListAccountsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the locally stored SSO tokens from the client-side cache and sends an API call to - * the IAM Identity Center service to invalidate the corresponding server-side IAM Identity Center sign in - * session.

- * - * - *

If a user uses IAM Identity Center to access the AWS CLI, the user’s IAM Identity Center sign in session is - * used to obtain an IAM session, as specified in the corresponding IAM Identity Center permission set. - * More specifically, IAM Identity Center assumes an IAM role in the target account on behalf of the user, - * and the corresponding temporary AWS credentials are returned to the client.

- * - *

After user logout, any existing IAM role sessions that were created by using IAM Identity Center - * permission sets continue based on the duration configured in the permission set. - * For more information, see User - * authentications in the IAM Identity Center User - * Guide.

- *
+ * @see {@link LogoutCommand} */ - public logout(args: LogoutCommandInput, options?: __HttpHandlerOptions): Promise; - public logout(args: LogoutCommandInput, cb: (err: any, data?: LogoutCommandOutput) => void): void; - public logout( + logout(args: LogoutCommandInput, options?: __HttpHandlerOptions): Promise; + logout(args: LogoutCommandInput, cb: (err: any, data?: LogoutCommandOutput) => void): void; + logout( args: LogoutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: LogoutCommandOutput) => void ): void; - public logout( - args: LogoutCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: LogoutCommandOutput) => void), - cb?: (err: any, data?: LogoutCommandOutput) => void - ): Promise | void { - const command = new LogoutCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

AWS IAM Identity Center (successor to AWS Single Sign-On) Portal is a web service that makes it easy for you to assign user access to + * IAM Identity Center resources such as the AWS access portal. Users can get AWS account applications and roles + * assigned to them and get federated into the application.

+ * + * + *

Although AWS Single Sign-On was renamed, the sso and + * identitystore API namespaces will continue to retain their original name for + * backward compatibility purposes. For more information, see IAM Identity Center rename.

+ *
+ * + *

This reference guide describes the IAM Identity Center Portal operations that you can call + * programatically and includes detailed information on data types and errors.

+ * + * + *

AWS provides SDKs that consist of libraries and sample code for various programming + * languages and platforms, such as Java, Ruby, .Net, iOS, or Android. The SDKs provide a + * convenient way to create programmatic access to IAM Identity Center and other AWS services. For more + * information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

+ *
+ */ +export class SSO extends SSOClient implements SSO {} +createAggregatedClient(commands, SSO); diff --git a/clients/client-storage-gateway/src/StorageGateway.ts b/clients/client-storage-gateway/src/StorageGateway.ts index 3a3400204ee2..89c5321d6e14 100644 --- a/clients/client-storage-gateway/src/StorageGateway.ts +++ b/clients/client-storage-gateway/src/StorageGateway.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -423,3648 +424,1562 @@ import { UpdateVTLDeviceTypeCommandInput, UpdateVTLDeviceTypeCommandOutput, } from "./commands/UpdateVTLDeviceTypeCommand"; -import { StorageGatewayClient } from "./StorageGatewayClient"; +import { StorageGatewayClient, StorageGatewayClientConfig } from "./StorageGatewayClient"; -/** - * @public - * Storage Gateway Service - * - *

Storage Gateway is the service that connects an on-premises software appliance - * with cloud-based storage to provide seamless and secure integration between an - * organization's on-premises IT environment and the Amazon Web Services storage - * infrastructure. The service enables you to securely upload data to the Amazon Web Services Cloud for cost effective backup and rapid disaster recovery.

- * - *

Use the following links to get started using the Storage Gateway - * Service API Reference:

- * - *
    - *
  • - *

    - * Storage Gateway required request headers: Describes the required - * headers that you must send with every POST request to Storage Gateway.

    - *
  • - *
  • - *

    - * Signing requests: Storage Gateway requires that you authenticate - * every request you send; this topic describes how sign such a request.

    - *
  • - *
  • - *

    - * Error responses: Provides reference information about Storage Gateway errors.

    - *
  • - *
  • - *

    - * Operations in Storage Gateway: Contains detailed descriptions of all Storage Gateway operations, their request parameters, response elements, possible errors, and - * examples of requests and responses.

    - *
  • - *
  • - *

    - * Storage Gateway - * endpoints and quotas: Provides a list of each Amazon Web Services Region - * and the endpoints available for use with Storage Gateway.

    - *
  • - *
- * - * - *

Storage Gateway resource IDs are in uppercase. When you use these resource IDs - * with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change - * your resource ID to lowercase to use it with the EC2 API. For example, in Storage - * Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use - * this ID with the EC2 API, you must change it to vol-aa22bb012345daf670. - * Otherwise, the EC2 API might not behave as expected.

- *
- * - * - *

IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway - * volumes are changing to a longer format. Starting in December 2016, all new volumes and - * snapshots will be created with a 17-character string. Starting in April 2016, you will - * be able to use these longer IDs so you can test your systems with the new format. For - * more information, see Longer EC2 and - * EBS resource IDs.

- * - *

For example, a volume Amazon Resource Name (ARN) with the longer volume ID format - * looks like the following:

- * - *

- * arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.

- * - *

A snapshot ID with the longer ID format looks like the following: - * snap-78e226633445566ee.

- * - *

For more information, see Announcement: - * Heads-up – Longer Storage Gateway volume and snapshot IDs coming in - * 2016.

- *
- */ -export class StorageGateway extends StorageGatewayClient { - /** - * @public - *

Activates the gateway you previously deployed on your host. In the activation process, - * you specify information such as the Amazon Web Services Region that you want to use for - * storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot - * schedule window, an activation key, and a name for your gateway. The activation process - * also associates your gateway with your account. For more information, see UpdateGatewayInformation.

- * - *

You must turn on the gateway VM before you can activate your gateway.

- *
- */ - public activateGateway( +const commands = { + ActivateGatewayCommand, + AddCacheCommand, + AddTagsToResourceCommand, + AddUploadBufferCommand, + AddWorkingStorageCommand, + AssignTapePoolCommand, + AssociateFileSystemCommand, + AttachVolumeCommand, + CancelArchivalCommand, + CancelRetrievalCommand, + CreateCachediSCSIVolumeCommand, + CreateNFSFileShareCommand, + CreateSMBFileShareCommand, + CreateSnapshotCommand, + CreateSnapshotFromVolumeRecoveryPointCommand, + CreateStorediSCSIVolumeCommand, + CreateTapePoolCommand, + CreateTapesCommand, + CreateTapeWithBarcodeCommand, + DeleteAutomaticTapeCreationPolicyCommand, + DeleteBandwidthRateLimitCommand, + DeleteChapCredentialsCommand, + DeleteFileShareCommand, + DeleteGatewayCommand, + DeleteSnapshotScheduleCommand, + DeleteTapeCommand, + DeleteTapeArchiveCommand, + DeleteTapePoolCommand, + DeleteVolumeCommand, + DescribeAvailabilityMonitorTestCommand, + DescribeBandwidthRateLimitCommand, + DescribeBandwidthRateLimitScheduleCommand, + DescribeCacheCommand, + DescribeCachediSCSIVolumesCommand, + DescribeChapCredentialsCommand, + DescribeFileSystemAssociationsCommand, + DescribeGatewayInformationCommand, + DescribeMaintenanceStartTimeCommand, + DescribeNFSFileSharesCommand, + DescribeSMBFileSharesCommand, + DescribeSMBSettingsCommand, + DescribeSnapshotScheduleCommand, + DescribeStorediSCSIVolumesCommand, + DescribeTapeArchivesCommand, + DescribeTapeRecoveryPointsCommand, + DescribeTapesCommand, + DescribeUploadBufferCommand, + DescribeVTLDevicesCommand, + DescribeWorkingStorageCommand, + DetachVolumeCommand, + DisableGatewayCommand, + DisassociateFileSystemCommand, + JoinDomainCommand, + ListAutomaticTapeCreationPoliciesCommand, + ListFileSharesCommand, + ListFileSystemAssociationsCommand, + ListGatewaysCommand, + ListLocalDisksCommand, + ListTagsForResourceCommand, + ListTapePoolsCommand, + ListTapesCommand, + ListVolumeInitiatorsCommand, + ListVolumeRecoveryPointsCommand, + ListVolumesCommand, + NotifyWhenUploadedCommand, + RefreshCacheCommand, + RemoveTagsFromResourceCommand, + ResetCacheCommand, + RetrieveTapeArchiveCommand, + RetrieveTapeRecoveryPointCommand, + SetLocalConsolePasswordCommand, + SetSMBGuestPasswordCommand, + ShutdownGatewayCommand, + StartAvailabilityMonitorTestCommand, + StartGatewayCommand, + UpdateAutomaticTapeCreationPolicyCommand, + UpdateBandwidthRateLimitCommand, + UpdateBandwidthRateLimitScheduleCommand, + UpdateChapCredentialsCommand, + UpdateFileSystemAssociationCommand, + UpdateGatewayInformationCommand, + UpdateGatewaySoftwareNowCommand, + UpdateMaintenanceStartTimeCommand, + UpdateNFSFileShareCommand, + UpdateSMBFileShareCommand, + UpdateSMBFileShareVisibilityCommand, + UpdateSMBLocalGroupsCommand, + UpdateSMBSecurityStrategyCommand, + UpdateSnapshotScheduleCommand, + UpdateVTLDeviceTypeCommand, +}; + +export interface StorageGateway { + /** + * @see {@link ActivateGatewayCommand} + */ + activateGateway( args: ActivateGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public activateGateway( - args: ActivateGatewayCommandInput, - cb: (err: any, data?: ActivateGatewayCommandOutput) => void - ): void; - public activateGateway( + activateGateway(args: ActivateGatewayCommandInput, cb: (err: any, data?: ActivateGatewayCommandOutput) => void): void; + activateGateway( args: ActivateGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ActivateGatewayCommandOutput) => void ): void; - public activateGateway( - args: ActivateGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ActivateGatewayCommandOutput) => void), - cb?: (err: any, data?: ActivateGatewayCommandOutput) => void - ): Promise | void { - const command = new ActivateGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Configures one or more gateway local disks as cache for a gateway. This operation is - * only supported in the cached volume, tape, and file gateway type (see How Storage Gateway works (architecture).

- * - *

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to - * add cache, and one or more disk IDs that you want to configure as cache.

- */ - public addCache(args: AddCacheCommandInput, options?: __HttpHandlerOptions): Promise; - public addCache(args: AddCacheCommandInput, cb: (err: any, data?: AddCacheCommandOutput) => void): void; - public addCache( + + /** + * @see {@link AddCacheCommand} + */ + addCache(args: AddCacheCommandInput, options?: __HttpHandlerOptions): Promise; + addCache(args: AddCacheCommandInput, cb: (err: any, data?: AddCacheCommandOutput) => void): void; + addCache( args: AddCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddCacheCommandOutput) => void ): void; - public addCache( - args: AddCacheCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddCacheCommandOutput) => void), - cb?: (err: any, data?: AddCacheCommandOutput) => void - ): Promise | void { - const command = new AddCacheCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds one or more tags to the specified resource. You use tags to add metadata to - * resources, which you can use to categorize these resources. For example, you can categorize - * resources by purpose, owner, environment, or team. Each tag consists of a key and a value, - * which you define. You can add tags to the following Storage Gateway resources:

- * - *
    - *
  • - *

    Storage gateways of all types

    - *
  • - *
  • - *

    Storage volumes

    - *
  • - *
  • - *

    Virtual tapes

    - *
  • - *
  • - *

    NFS and SMB file shares

    - *
  • - *
  • - *

    File System associations

    - *
  • - *
- * - *

You can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes - * that are recovered to a new gateway maintain their tags.

- */ - public addTagsToResource( + + /** + * @see {@link AddTagsToResourceCommand} + */ + addTagsToResource( args: AddTagsToResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public addTagsToResource( + addTagsToResource( args: AddTagsToResourceCommandInput, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void ): void; - public addTagsToResource( + addTagsToResource( args: AddTagsToResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void ): void; - public addTagsToResource( - args: AddTagsToResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddTagsToResourceCommandOutput) => void), - cb?: (err: any, data?: AddTagsToResourceCommandOutput) => void - ): Promise | void { - const command = new AddTagsToResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Configures one or more gateway local disks as upload buffer for a specified gateway. - * This operation is supported for the stored volume, cached volume, and tape gateway - * types.

- * - *

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to - * add upload buffer, and one or more disk IDs that you want to configure as upload - * buffer.

- */ - public addUploadBuffer( + + /** + * @see {@link AddUploadBufferCommand} + */ + addUploadBuffer( args: AddUploadBufferCommandInput, options?: __HttpHandlerOptions ): Promise; - public addUploadBuffer( - args: AddUploadBufferCommandInput, - cb: (err: any, data?: AddUploadBufferCommandOutput) => void - ): void; - public addUploadBuffer( + addUploadBuffer(args: AddUploadBufferCommandInput, cb: (err: any, data?: AddUploadBufferCommandOutput) => void): void; + addUploadBuffer( args: AddUploadBufferCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddUploadBufferCommandOutput) => void ): void; - public addUploadBuffer( - args: AddUploadBufferCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddUploadBufferCommandOutput) => void), - cb?: (err: any, data?: AddUploadBufferCommandOutput) => void - ): Promise | void { - const command = new AddUploadBufferCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Configures one or more gateway local disks as working storage for a gateway. This - * operation is only supported in the stored volume gateway type. This operation is deprecated - * in cached volume API version 20120630. Use AddUploadBuffer - * instead.

- * - * - *

Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored volume - * gateway.

- *
- * - *

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to - * add working storage, and one or more disk IDs that you want to configure as working - * storage.

- */ - public addWorkingStorage( + + /** + * @see {@link AddWorkingStorageCommand} + */ + addWorkingStorage( args: AddWorkingStorageCommandInput, options?: __HttpHandlerOptions ): Promise; - public addWorkingStorage( + addWorkingStorage( args: AddWorkingStorageCommandInput, cb: (err: any, data?: AddWorkingStorageCommandOutput) => void ): void; - public addWorkingStorage( + addWorkingStorage( args: AddWorkingStorageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddWorkingStorageCommandOutput) => void ): void; - public addWorkingStorage( - args: AddWorkingStorageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddWorkingStorageCommandOutput) => void), - cb?: (err: any, data?: AddWorkingStorageCommandOutput) => void - ): Promise | void { - const command = new AddWorkingStorageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in - * the S3 storage class that is associated with the pool. When you use your backup application - * to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or - * S3 Glacier Deep Archive) that corresponds to the pool.

- */ - public assignTapePool( + + /** + * @see {@link AssignTapePoolCommand} + */ + assignTapePool( args: AssignTapePoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public assignTapePool( - args: AssignTapePoolCommandInput, - cb: (err: any, data?: AssignTapePoolCommandOutput) => void - ): void; - public assignTapePool( + assignTapePool(args: AssignTapePoolCommandInput, cb: (err: any, data?: AssignTapePoolCommandOutput) => void): void; + assignTapePool( args: AssignTapePoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssignTapePoolCommandOutput) => void ): void; - public assignTapePool( - args: AssignTapePoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssignTapePoolCommandOutput) => void), - cb?: (err: any, data?: AssignTapePoolCommandOutput) => void - ): Promise | void { - const command = new AssignTapePoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associate an Amazon FSx file system with the FSx File Gateway. After the - * association process is complete, the file shares on the Amazon FSx file system are - * available for access through the gateway. This operation only supports the FSx File Gateway - * type.

- */ - public associateFileSystem( + + /** + * @see {@link AssociateFileSystemCommand} + */ + associateFileSystem( args: AssociateFileSystemCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateFileSystem( + associateFileSystem( args: AssociateFileSystemCommandInput, cb: (err: any, data?: AssociateFileSystemCommandOutput) => void ): void; - public associateFileSystem( + associateFileSystem( args: AssociateFileSystemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateFileSystemCommandOutput) => void ): void; - public associateFileSystem( - args: AssociateFileSystemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateFileSystemCommandOutput) => void), - cb?: (err: any, data?: AssociateFileSystemCommandOutput) => void - ): Promise | void { - const command = new AssociateFileSystemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Connects a volume to an iSCSI connection and then attaches the volume to the specified - * gateway. Detaching and attaching a volume enables you to recover your data from one gateway - * to a different gateway without creating a snapshot. It also makes it easier to move your - * volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.

- */ - public attachVolume( - args: AttachVolumeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public attachVolume(args: AttachVolumeCommandInput, cb: (err: any, data?: AttachVolumeCommandOutput) => void): void; - public attachVolume( + + /** + * @see {@link AttachVolumeCommand} + */ + attachVolume(args: AttachVolumeCommandInput, options?: __HttpHandlerOptions): Promise; + attachVolume(args: AttachVolumeCommandInput, cb: (err: any, data?: AttachVolumeCommandOutput) => void): void; + attachVolume( args: AttachVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachVolumeCommandOutput) => void ): void; - public attachVolume( - args: AttachVolumeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AttachVolumeCommandOutput) => void), - cb?: (err: any, data?: AttachVolumeCommandOutput) => void - ): Promise | void { - const command = new AttachVolumeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving - * process is initiated. This operation is only supported in the tape gateway type.

- */ - public cancelArchival( + + /** + * @see {@link CancelArchivalCommand} + */ + cancelArchival( args: CancelArchivalCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelArchival( - args: CancelArchivalCommandInput, - cb: (err: any, data?: CancelArchivalCommandOutput) => void - ): void; - public cancelArchival( + cancelArchival(args: CancelArchivalCommandInput, cb: (err: any, data?: CancelArchivalCommandOutput) => void): void; + cancelArchival( args: CancelArchivalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelArchivalCommandOutput) => void ): void; - public cancelArchival( - args: CancelArchivalCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelArchivalCommandOutput) => void), - cb?: (err: any, data?: CancelArchivalCommandOutput) => void - ): Promise | void { - const command = new CancelArchivalCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after - * the retrieval process is initiated. The virtual tape is returned to the VTS. This operation - * is only supported in the tape gateway type.

- */ - public cancelRetrieval( + + /** + * @see {@link CancelRetrievalCommand} + */ + cancelRetrieval( args: CancelRetrievalCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelRetrieval( - args: CancelRetrievalCommandInput, - cb: (err: any, data?: CancelRetrievalCommandOutput) => void - ): void; - public cancelRetrieval( + cancelRetrieval(args: CancelRetrievalCommandInput, cb: (err: any, data?: CancelRetrievalCommandOutput) => void): void; + cancelRetrieval( args: CancelRetrievalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelRetrievalCommandOutput) => void ): void; - public cancelRetrieval( - args: CancelRetrievalCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelRetrievalCommandOutput) => void), - cb?: (err: any, data?: CancelRetrievalCommandOutput) => void - ): Promise | void { - const command = new CancelRetrievalCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a cached volume on a specified cached volume gateway. This operation is only - * supported in the cached volume gateway type.

- * - * - *

Cache storage must be allocated to the gateway before you can create a cached volume. - * Use the AddCache operation to add cache storage to a gateway.

- *
- * - *

In the request, you must specify the gateway, size of the volume in bytes, the iSCSI - * target name, an IP address on which to expose the target, and a unique client token. In - * response, the gateway creates the volume and returns information about it. This information - * includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that - * initiators can use to connect to the volume target.

- * - *

Optionally, you can provide the ARN for an existing volume as the - * SourceVolumeARN for this cached volume, which creates an exact copy of the - * existing volume’s latest recovery point. The VolumeSizeInBytes value must be - * equal to or larger than the size of the copied volume, in bytes.

- */ - public createCachediSCSIVolume( + + /** + * @see {@link CreateCachediSCSIVolumeCommand} + */ + createCachediSCSIVolume( args: CreateCachediSCSIVolumeCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCachediSCSIVolume( + createCachediSCSIVolume( args: CreateCachediSCSIVolumeCommandInput, cb: (err: any, data?: CreateCachediSCSIVolumeCommandOutput) => void ): void; - public createCachediSCSIVolume( + createCachediSCSIVolume( args: CreateCachediSCSIVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCachediSCSIVolumeCommandOutput) => void ): void; - public createCachediSCSIVolume( - args: CreateCachediSCSIVolumeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCachediSCSIVolumeCommandOutput) => void), - cb?: (err: any, data?: CreateCachediSCSIVolumeCommandOutput) => void - ): Promise | void { - const command = new CreateCachediSCSIVolumeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Network File System (NFS) file share on an existing S3 File Gateway. In - * Storage Gateway, a file share is a file system mount point backed by Amazon S3 - * cloud storage. Storage Gateway exposes file shares using an NFS interface. This operation - * is only supported for S3 File Gateways.

- * - * - *

S3 File gateway requires Security Token Service (Amazon Web Services STS) to be - * activated to enable you to create a file share. Make sure Amazon Web Services STS is - * activated in the Amazon Web Services Region you are creating your S3 File Gateway in. If - * Amazon Web Services STS is not activated in the Amazon Web Services Region, activate - * it. For information about how to activate Amazon Web Services STS, see Activating and - * deactivating Amazon Web Services STS in an Amazon Web Services Region in the - * Identity and Access Management User Guide.

- * - *

S3 File Gateways do not support creating hard or symbolic links on a file - * share.

- *
- */ - public createNFSFileShare( + + /** + * @see {@link CreateNFSFileShareCommand} + */ + createNFSFileShare( args: CreateNFSFileShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNFSFileShare( + createNFSFileShare( args: CreateNFSFileShareCommandInput, cb: (err: any, data?: CreateNFSFileShareCommandOutput) => void ): void; - public createNFSFileShare( + createNFSFileShare( args: CreateNFSFileShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNFSFileShareCommandOutput) => void ): void; - public createNFSFileShare( - args: CreateNFSFileShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNFSFileShareCommandOutput) => void), - cb?: (err: any, data?: CreateNFSFileShareCommandOutput) => void - ): Promise | void { - const command = new CreateNFSFileShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a Server Message Block (SMB) file share on an existing S3 File Gateway. In - * Storage Gateway, a file share is a file system mount point backed by Amazon S3 - * cloud storage. Storage Gateway exposes file shares using an SMB interface. This operation - * is only supported for S3 File Gateways.

- * - * - *

S3 File Gateways require Security Token Service (Amazon Web Services STS) to be - * activated to enable you to create a file share. Make sure that Amazon Web Services STS - * is activated in the Amazon Web Services Region you are creating your S3 File Gateway in. - * If Amazon Web Services STS is not activated in this Amazon Web Services Region, activate - * it. For information about how to activate Amazon Web Services STS, see Activating and - * deactivating Amazon Web Services STS in an Amazon Web Services Region in the - * Identity and Access Management User Guide.

- * - *

File gateways don't support creating hard or symbolic links on a file - * share.

- *
- */ - public createSMBFileShare( + + /** + * @see {@link CreateSMBFileShareCommand} + */ + createSMBFileShare( args: CreateSMBFileShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSMBFileShare( + createSMBFileShare( args: CreateSMBFileShareCommandInput, cb: (err: any, data?: CreateSMBFileShareCommandOutput) => void ): void; - public createSMBFileShare( + createSMBFileShare( args: CreateSMBFileShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSMBFileShareCommandOutput) => void ): void; - public createSMBFileShare( - args: CreateSMBFileShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSMBFileShareCommandOutput) => void), - cb?: (err: any, data?: CreateSMBFileShareCommandOutput) => void - ): Promise | void { - const command = new CreateSMBFileShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Initiates a snapshot of a volume.

- * - *

Storage Gateway provides the ability to back up point-in-time snapshots of your - * data to Amazon Simple Storage (Amazon S3) for durable off-site recovery, and also - * import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute - * Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. - * This API enables you to take an ad hoc snapshot. For more information, see Editing a - * snapshot schedule.

- * - *

In the CreateSnapshot request, you identify the volume by providing its - * Amazon Resource Name (ARN). You must also provide description for the snapshot. When - * Storage Gateway takes the snapshot of specified volume, the snapshot and - * description appears in the Storage Gateway console. In response, Storage Gateway - * returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or - * later use it when you want to create a volume from a snapshot. This operation is only - * supported in stored and cached volume gateway type.

- * - * - *

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, - * see DescribeSnapshots - * or DeleteSnapshot in the Amazon Elastic Compute Cloud API - * Reference.

- *
- * - * - *

Volume and snapshot IDs are changing to a longer length ID format. For more - * information, see the important note on the Welcome page.

- *
- */ - public createSnapshot( + + /** + * @see {@link CreateSnapshotCommand} + */ + createSnapshot( args: CreateSnapshotCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSnapshot( - args: CreateSnapshotCommandInput, - cb: (err: any, data?: CreateSnapshotCommandOutput) => void - ): void; - public createSnapshot( + createSnapshot(args: CreateSnapshotCommandInput, cb: (err: any, data?: CreateSnapshotCommandOutput) => void): void; + createSnapshot( args: CreateSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSnapshotCommandOutput) => void ): void; - public createSnapshot( - args: CreateSnapshotCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSnapshotCommandOutput) => void), - cb?: (err: any, data?: CreateSnapshotCommandOutput) => void - ): Promise | void { - const command = new CreateSnapshotCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Initiates a snapshot of a gateway from a volume recovery point. This operation is only - * supported in the cached volume gateway type.

- * - *

A volume recovery point is a point in time at which all data of the volume is consistent - * and from which you can create a snapshot. To get a list of volume recovery point for cached - * volume gateway, use ListVolumeRecoveryPoints.

- * - *

In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the - * volume by providing its Amazon Resource Name (ARN). You must also provide a description for - * the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and - * its description appear in the Storage Gateway console. - * In response, the gateway returns - * you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use - * it when you want to create a volume from a snapshot.

- * - * - *

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, - * see DescribeSnapshots - * or DeleteSnapshot in the Amazon Elastic Compute Cloud API - * Reference.

- *
- */ - public createSnapshotFromVolumeRecoveryPoint( + + /** + * @see {@link CreateSnapshotFromVolumeRecoveryPointCommand} + */ + createSnapshotFromVolumeRecoveryPoint( args: CreateSnapshotFromVolumeRecoveryPointCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSnapshotFromVolumeRecoveryPoint( + createSnapshotFromVolumeRecoveryPoint( args: CreateSnapshotFromVolumeRecoveryPointCommandInput, cb: (err: any, data?: CreateSnapshotFromVolumeRecoveryPointCommandOutput) => void ): void; - public createSnapshotFromVolumeRecoveryPoint( + createSnapshotFromVolumeRecoveryPoint( args: CreateSnapshotFromVolumeRecoveryPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSnapshotFromVolumeRecoveryPointCommandOutput) => void ): void; - public createSnapshotFromVolumeRecoveryPoint( - args: CreateSnapshotFromVolumeRecoveryPointCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateSnapshotFromVolumeRecoveryPointCommandOutput) => void), - cb?: (err: any, data?: CreateSnapshotFromVolumeRecoveryPointCommandOutput) => void - ): Promise | void { - const command = new CreateSnapshotFromVolumeRecoveryPointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a volume on a specified gateway. This operation is only supported in the stored - * volume gateway type.

- * - *

The size of the volume to create is inferred from the disk size. You can choose to - * preserve existing data on the disk, create volume from an existing snapshot, or create an - * empty volume. If you choose to create an empty gateway volume, then any existing data on - * the disk is erased.

- * - *

In the request, you must specify the gateway and the disk information on which you are - * creating the volume. In response, the gateway creates the volume and returns volume - * information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target - * ARN that initiators can use to connect to the volume target.

- */ - public createStorediSCSIVolume( + + /** + * @see {@link CreateStorediSCSIVolumeCommand} + */ + createStorediSCSIVolume( args: CreateStorediSCSIVolumeCommandInput, options?: __HttpHandlerOptions ): Promise; - public createStorediSCSIVolume( + createStorediSCSIVolume( args: CreateStorediSCSIVolumeCommandInput, cb: (err: any, data?: CreateStorediSCSIVolumeCommandOutput) => void ): void; - public createStorediSCSIVolume( + createStorediSCSIVolume( args: CreateStorediSCSIVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStorediSCSIVolumeCommandOutput) => void ): void; - public createStorediSCSIVolume( - args: CreateStorediSCSIVolumeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStorediSCSIVolumeCommandOutput) => void), - cb?: (err: any, data?: CreateStorediSCSIVolumeCommandOutput) => void - ): Promise | void { - const command = new CreateStorediSCSIVolumeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new custom tape pool. You can use custom tape pool to enable tape retention - * lock on tapes that are archived in the custom pool.

- */ - public createTapePool( + + /** + * @see {@link CreateTapePoolCommand} + */ + createTapePool( args: CreateTapePoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTapePool( - args: CreateTapePoolCommandInput, - cb: (err: any, data?: CreateTapePoolCommandOutput) => void - ): void; - public createTapePool( + createTapePool(args: CreateTapePoolCommandInput, cb: (err: any, data?: CreateTapePoolCommandOutput) => void): void; + createTapePool( args: CreateTapePoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTapePoolCommandOutput) => void ): void; - public createTapePool( - args: CreateTapePoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTapePoolCommandOutput) => void), - cb?: (err: any, data?: CreateTapePoolCommandOutput) => void - ): Promise | void { - const command = new CreateTapePoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates one or more virtual tapes. You write data to the virtual tapes and then archive - * the tapes. This operation is only supported in the tape gateway type.

- * - * - *

Cache storage must be allocated to the gateway before you can create virtual tapes. - * Use the AddCache operation to add cache storage to a gateway.

- *
- */ - public createTapes(args: CreateTapesCommandInput, options?: __HttpHandlerOptions): Promise; - public createTapes(args: CreateTapesCommandInput, cb: (err: any, data?: CreateTapesCommandOutput) => void): void; - public createTapes( + + /** + * @see {@link CreateTapesCommand} + */ + createTapes(args: CreateTapesCommandInput, options?: __HttpHandlerOptions): Promise; + createTapes(args: CreateTapesCommandInput, cb: (err: any, data?: CreateTapesCommandOutput) => void): void; + createTapes( args: CreateTapesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTapesCommandOutput) => void ): void; - public createTapes( - args: CreateTapesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTapesCommandOutput) => void), - cb?: (err: any, data?: CreateTapesCommandOutput) => void - ): Promise | void { - const command = new CreateTapesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a virtual tape by using your own barcode. You write data to the virtual tape and - * then archive the tape. A barcode is unique and cannot be reused if it has already been used - * on a tape. This applies to barcodes used on deleted tapes. This operation is only supported - * in the tape gateway type.

- * - * - *

Cache storage must be allocated to the gateway before you can create a virtual tape. - * Use the AddCache operation to add cache storage to a gateway.

- *
- */ - public createTapeWithBarcode( + + /** + * @see {@link CreateTapeWithBarcodeCommand} + */ + createTapeWithBarcode( args: CreateTapeWithBarcodeCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTapeWithBarcode( + createTapeWithBarcode( args: CreateTapeWithBarcodeCommandInput, cb: (err: any, data?: CreateTapeWithBarcodeCommandOutput) => void ): void; - public createTapeWithBarcode( + createTapeWithBarcode( args: CreateTapeWithBarcodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTapeWithBarcodeCommandOutput) => void ): void; - public createTapeWithBarcode( - args: CreateTapeWithBarcodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTapeWithBarcodeCommandOutput) => void), - cb?: (err: any, data?: CreateTapeWithBarcodeCommandOutput) => void - ): Promise | void { - const command = new CreateTapeWithBarcodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the automatic tape creation policy of a gateway. If you delete this policy, new - * virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway - * in your request to remove the policy.

- */ - public deleteAutomaticTapeCreationPolicy( + + /** + * @see {@link DeleteAutomaticTapeCreationPolicyCommand} + */ + deleteAutomaticTapeCreationPolicy( args: DeleteAutomaticTapeCreationPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAutomaticTapeCreationPolicy( + deleteAutomaticTapeCreationPolicy( args: DeleteAutomaticTapeCreationPolicyCommandInput, cb: (err: any, data?: DeleteAutomaticTapeCreationPolicyCommandOutput) => void ): void; - public deleteAutomaticTapeCreationPolicy( + deleteAutomaticTapeCreationPolicy( args: DeleteAutomaticTapeCreationPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAutomaticTapeCreationPolicyCommandOutput) => void ): void; - public deleteAutomaticTapeCreationPolicy( - args: DeleteAutomaticTapeCreationPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAutomaticTapeCreationPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteAutomaticTapeCreationPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteAutomaticTapeCreationPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the bandwidth rate limits of a gateway. You can delete either the upload and - * download bandwidth rate limit, or you can delete both. If you delete only one of the - * limits, the other limit remains unchanged. To specify which gateway to work with, use the - * Amazon Resource Name (ARN) of the gateway in your request. This operation is supported only - * for the stored volume, cached volume, and tape gateway types.

- */ - public deleteBandwidthRateLimit( + + /** + * @see {@link DeleteBandwidthRateLimitCommand} + */ + deleteBandwidthRateLimit( args: DeleteBandwidthRateLimitCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBandwidthRateLimit( + deleteBandwidthRateLimit( args: DeleteBandwidthRateLimitCommandInput, cb: (err: any, data?: DeleteBandwidthRateLimitCommandOutput) => void ): void; - public deleteBandwidthRateLimit( + deleteBandwidthRateLimit( args: DeleteBandwidthRateLimitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBandwidthRateLimitCommandOutput) => void ): void; - public deleteBandwidthRateLimit( - args: DeleteBandwidthRateLimitCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBandwidthRateLimitCommandOutput) => void), - cb?: (err: any, data?: DeleteBandwidthRateLimitCommandOutput) => void - ): Promise | void { - const command = new DeleteBandwidthRateLimitCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified - * iSCSI target and initiator pair. This operation is supported in volume and tape gateway - * types.

- */ - public deleteChapCredentials( + + /** + * @see {@link DeleteChapCredentialsCommand} + */ + deleteChapCredentials( args: DeleteChapCredentialsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteChapCredentials( + deleteChapCredentials( args: DeleteChapCredentialsCommandInput, cb: (err: any, data?: DeleteChapCredentialsCommandOutput) => void ): void; - public deleteChapCredentials( + deleteChapCredentials( args: DeleteChapCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChapCredentialsCommandOutput) => void ): void; - public deleteChapCredentials( - args: DeleteChapCredentialsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteChapCredentialsCommandOutput) => void), - cb?: (err: any, data?: DeleteChapCredentialsCommandOutput) => void - ): Promise | void { - const command = new DeleteChapCredentialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a file share from an S3 File Gateway. This operation is only supported for S3 - * File Gateways.

- */ - public deleteFileShare( + + /** + * @see {@link DeleteFileShareCommand} + */ + deleteFileShare( args: DeleteFileShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFileShare( - args: DeleteFileShareCommandInput, - cb: (err: any, data?: DeleteFileShareCommandOutput) => void - ): void; - public deleteFileShare( + deleteFileShare(args: DeleteFileShareCommandInput, cb: (err: any, data?: DeleteFileShareCommandOutput) => void): void; + deleteFileShare( args: DeleteFileShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFileShareCommandOutput) => void ): void; - public deleteFileShare( - args: DeleteFileShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFileShareCommandOutput) => void), - cb?: (err: any, data?: DeleteFileShareCommandOutput) => void - ): Promise | void { - const command = new DeleteFileShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name - * (ARN) of the gateway in your request. The operation deletes the gateway; however, it does - * not delete the gateway virtual machine (VM) from your host computer.

- * - *

After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway - * volumes are not deleted upon deleting the gateway, however, pending snapshots will not - * complete. After you delete a gateway, your next step is to remove it from your - * environment.

- * - * - *

You no longer pay software charges after the gateway is deleted; however, your - * existing Amazon EBS snapshots persist and you will continue to be billed for these - * snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your - * Amazon EC2 subscription.  If you prefer not to cancel your Amazon EC2 subscription, you - * can delete your snapshots using the Amazon EC2 console. For more information, see the - * Storage Gateway detail - * page.

- *
- */ - public deleteGateway( - args: DeleteGatewayCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteGateway( - args: DeleteGatewayCommandInput, - cb: (err: any, data?: DeleteGatewayCommandOutput) => void - ): void; - public deleteGateway( + + /** + * @see {@link DeleteGatewayCommand} + */ + deleteGateway(args: DeleteGatewayCommandInput, options?: __HttpHandlerOptions): Promise; + deleteGateway(args: DeleteGatewayCommandInput, cb: (err: any, data?: DeleteGatewayCommandOutput) => void): void; + deleteGateway( args: DeleteGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGatewayCommandOutput) => void ): void; - public deleteGateway( - args: DeleteGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGatewayCommandOutput) => void), - cb?: (err: any, data?: DeleteGatewayCommandOutput) => void - ): Promise | void { - const command = new DeleteGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a snapshot of a volume.

- * - *

You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API - * action enables you to delete a snapshot schedule for a volume. For more information, see - * Backing up your - * volumes. In the DeleteSnapshotSchedule request, you identify the - * volume by providing its Amazon Resource Name (ARN). This operation is only supported for - * cached volume gateway types.

- * - * - * - *

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, - * go to DescribeSnapshots - * in the Amazon Elastic Compute Cloud API Reference.

- *
- */ - public deleteSnapshotSchedule( + + /** + * @see {@link DeleteSnapshotScheduleCommand} + */ + deleteSnapshotSchedule( args: DeleteSnapshotScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSnapshotSchedule( + deleteSnapshotSchedule( args: DeleteSnapshotScheduleCommandInput, cb: (err: any, data?: DeleteSnapshotScheduleCommandOutput) => void ): void; - public deleteSnapshotSchedule( + deleteSnapshotSchedule( args: DeleteSnapshotScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSnapshotScheduleCommandOutput) => void ): void; - public deleteSnapshotSchedule( - args: DeleteSnapshotScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSnapshotScheduleCommandOutput) => void), - cb?: (err: any, data?: DeleteSnapshotScheduleCommandOutput) => void - ): Promise | void { - const command = new DeleteSnapshotScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified virtual tape. This operation is only supported in the tape gateway - * type.

- */ - public deleteTape(args: DeleteTapeCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteTape(args: DeleteTapeCommandInput, cb: (err: any, data?: DeleteTapeCommandOutput) => void): void; - public deleteTape( + + /** + * @see {@link DeleteTapeCommand} + */ + deleteTape(args: DeleteTapeCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTape(args: DeleteTapeCommandInput, cb: (err: any, data?: DeleteTapeCommandOutput) => void): void; + deleteTape( args: DeleteTapeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTapeCommandOutput) => void ): void; - public deleteTape( - args: DeleteTapeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTapeCommandOutput) => void), - cb?: (err: any, data?: DeleteTapeCommandOutput) => void - ): Promise | void { - const command = new DeleteTapeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is - * only supported in the tape gateway type.

- */ - public deleteTapeArchive( + + /** + * @see {@link DeleteTapeArchiveCommand} + */ + deleteTapeArchive( args: DeleteTapeArchiveCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTapeArchive( + deleteTapeArchive( args: DeleteTapeArchiveCommandInput, cb: (err: any, data?: DeleteTapeArchiveCommandOutput) => void ): void; - public deleteTapeArchive( + deleteTapeArchive( args: DeleteTapeArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTapeArchiveCommandOutput) => void ): void; - public deleteTapeArchive( - args: DeleteTapeArchiveCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTapeArchiveCommandOutput) => void), - cb?: (err: any, data?: DeleteTapeArchiveCommandOutput) => void - ): Promise | void { - const command = new DeleteTapeArchiveCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Delete a custom tape pool. A custom tape pool can only be deleted if there are no tapes - * in the pool and if there are no automatic tape creation policies that reference the custom - * tape pool.

- */ - public deleteTapePool( + + /** + * @see {@link DeleteTapePoolCommand} + */ + deleteTapePool( args: DeleteTapePoolCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTapePool( - args: DeleteTapePoolCommandInput, - cb: (err: any, data?: DeleteTapePoolCommandOutput) => void - ): void; - public deleteTapePool( + deleteTapePool(args: DeleteTapePoolCommandInput, cb: (err: any, data?: DeleteTapePoolCommandOutput) => void): void; + deleteTapePool( args: DeleteTapePoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTapePoolCommandOutput) => void ): void; - public deleteTapePool( - args: DeleteTapePoolCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTapePoolCommandOutput) => void), - cb?: (err: any, data?: DeleteTapePoolCommandOutput) => void - ): Promise | void { - const command = new DeleteTapePoolCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. - * This operation is only supported in the cached volume and stored volume types. For stored - * volume gateways, the local disk that was configured as the storage volume is not deleted. - * You can reuse the local disk to create another storage volume.

- * - *

Before you delete a volume, make sure there are no iSCSI connections to the volume you - * are deleting. You should also make sure there is no snapshot in progress. You can use the - * Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are - * deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API - * Reference.

- * - *

In the request, you must provide the Amazon Resource Name (ARN) of the storage volume - * you want to delete.

- */ - public deleteVolume( - args: DeleteVolumeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteVolume(args: DeleteVolumeCommandInput, cb: (err: any, data?: DeleteVolumeCommandOutput) => void): void; - public deleteVolume( + + /** + * @see {@link DeleteVolumeCommand} + */ + deleteVolume(args: DeleteVolumeCommandInput, options?: __HttpHandlerOptions): Promise; + deleteVolume(args: DeleteVolumeCommandInput, cb: (err: any, data?: DeleteVolumeCommandOutput) => void): void; + deleteVolume( args: DeleteVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVolumeCommandOutput) => void ): void; - public deleteVolume( - args: DeleteVolumeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVolumeCommandOutput) => void), - cb?: (err: any, data?: DeleteVolumeCommandOutput) => void - ): Promise | void { - const command = new DeleteVolumeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the most recent high availability monitoring test that was - * performed on the host in a cluster. If a test isn't performed, the status and start - * time in the response would be null.

- */ - public describeAvailabilityMonitorTest( + + /** + * @see {@link DescribeAvailabilityMonitorTestCommand} + */ + describeAvailabilityMonitorTest( args: DescribeAvailabilityMonitorTestCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAvailabilityMonitorTest( + describeAvailabilityMonitorTest( args: DescribeAvailabilityMonitorTestCommandInput, cb: (err: any, data?: DescribeAvailabilityMonitorTestCommandOutput) => void ): void; - public describeAvailabilityMonitorTest( + describeAvailabilityMonitorTest( args: DescribeAvailabilityMonitorTestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAvailabilityMonitorTestCommandOutput) => void ): void; - public describeAvailabilityMonitorTest( - args: DescribeAvailabilityMonitorTestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAvailabilityMonitorTestCommandOutput) => void), - cb?: (err: any, data?: DescribeAvailabilityMonitorTestCommandOutput) => void - ): Promise | void { - const command = new DescribeAvailabilityMonitorTestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the bandwidth rate limits of a gateway. By default, these limits are not set, - * which means no bandwidth rate limiting is in effect. This operation is supported only for - * the stored volume, cached volume, and tape gateway types. To describe bandwidth rate limits - * for S3 file gateways, use DescribeBandwidthRateLimitSchedule.

- * - *

This operation returns a value for a bandwidth rate limit only if the limit is set. If - * no limits are set for the gateway, then this operation returns only the gateway ARN in the - * response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of - * the gateway in your request.

- */ - public describeBandwidthRateLimit( + + /** + * @see {@link DescribeBandwidthRateLimitCommand} + */ + describeBandwidthRateLimit( args: DescribeBandwidthRateLimitCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBandwidthRateLimit( + describeBandwidthRateLimit( args: DescribeBandwidthRateLimitCommandInput, cb: (err: any, data?: DescribeBandwidthRateLimitCommandOutput) => void ): void; - public describeBandwidthRateLimit( + describeBandwidthRateLimit( args: DescribeBandwidthRateLimitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBandwidthRateLimitCommandOutput) => void ): void; - public describeBandwidthRateLimit( - args: DescribeBandwidthRateLimitCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBandwidthRateLimitCommandOutput) => void), - cb?: (err: any, data?: DescribeBandwidthRateLimitCommandOutput) => void - ): Promise | void { - const command = new DescribeBandwidthRateLimitCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the bandwidth rate limit schedule of a gateway. By default, - * gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting - * is in effect. This operation is supported only for volume, tape and S3 file gateways. FSx - * file gateways do not support bandwidth rate limits.

- * - *

This operation returns information about a gateway's bandwidth rate limit schedule. A - * bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A - * bandwidth rate limit interval defines a period of time on one or more days of the week, - * during which bandwidth rate limits are specified for uploading, downloading, or both.

- * - *

A bandwidth rate limit interval consists of one or more days of the week, a start hour - * and minute, an ending hour and minute, and bandwidth rate limits for uploading and - * downloading

- * - *

If no bandwidth rate limit schedule intervals are set for the gateway, this operation - * returns an empty response. To specify which gateway to describe, use the Amazon Resource - * Name (ARN) of the gateway in your request.

- */ - public describeBandwidthRateLimitSchedule( + + /** + * @see {@link DescribeBandwidthRateLimitScheduleCommand} + */ + describeBandwidthRateLimitSchedule( args: DescribeBandwidthRateLimitScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBandwidthRateLimitSchedule( + describeBandwidthRateLimitSchedule( args: DescribeBandwidthRateLimitScheduleCommandInput, cb: (err: any, data?: DescribeBandwidthRateLimitScheduleCommandOutput) => void ): void; - public describeBandwidthRateLimitSchedule( + describeBandwidthRateLimitSchedule( args: DescribeBandwidthRateLimitScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBandwidthRateLimitScheduleCommandOutput) => void ): void; - public describeBandwidthRateLimitSchedule( - args: DescribeBandwidthRateLimitScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBandwidthRateLimitScheduleCommandOutput) => void), - cb?: (err: any, data?: DescribeBandwidthRateLimitScheduleCommandOutput) => void - ): Promise | void { - const command = new DescribeBandwidthRateLimitScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the cache of a gateway. This operation is only supported in - * the cached volume, tape, and file gateway types.

- * - *

The response includes disk IDs that are configured as cache, and it includes the amount - * of cache allocated and used.

- */ - public describeCache( - args: DescribeCacheCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeCache( - args: DescribeCacheCommandInput, - cb: (err: any, data?: DescribeCacheCommandOutput) => void - ): void; - public describeCache( + + /** + * @see {@link DescribeCacheCommand} + */ + describeCache(args: DescribeCacheCommandInput, options?: __HttpHandlerOptions): Promise; + describeCache(args: DescribeCacheCommandInput, cb: (err: any, data?: DescribeCacheCommandOutput) => void): void; + describeCache( args: DescribeCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCacheCommandOutput) => void ): void; - public describeCache( - args: DescribeCacheCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCacheCommandOutput) => void), - cb?: (err: any, data?: DescribeCacheCommandOutput) => void - ): Promise | void { - const command = new DescribeCacheCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a description of the gateway volumes specified in the request. This operation is - * only supported in the cached volume gateway types.

- * - *

The list of gateway volumes in the request must be from one gateway. In the response, - * Storage Gateway returns volume information sorted by volume Amazon Resource Name - * (ARN).

- */ - public describeCachediSCSIVolumes( + + /** + * @see {@link DescribeCachediSCSIVolumesCommand} + */ + describeCachediSCSIVolumes( args: DescribeCachediSCSIVolumesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCachediSCSIVolumes( + describeCachediSCSIVolumes( args: DescribeCachediSCSIVolumesCommandInput, cb: (err: any, data?: DescribeCachediSCSIVolumesCommandOutput) => void ): void; - public describeCachediSCSIVolumes( + describeCachediSCSIVolumes( args: DescribeCachediSCSIVolumesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCachediSCSIVolumesCommandOutput) => void ): void; - public describeCachediSCSIVolumes( - args: DescribeCachediSCSIVolumesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCachediSCSIVolumesCommandOutput) => void), - cb?: (err: any, data?: DescribeCachediSCSIVolumesCommandOutput) => void - ): Promise | void { - const command = new DescribeCachediSCSIVolumesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials - * information for a specified iSCSI target, one for each target-initiator pair. This - * operation is supported in the volume and tape gateway types.

- */ - public describeChapCredentials( + + /** + * @see {@link DescribeChapCredentialsCommand} + */ + describeChapCredentials( args: DescribeChapCredentialsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeChapCredentials( + describeChapCredentials( args: DescribeChapCredentialsCommandInput, cb: (err: any, data?: DescribeChapCredentialsCommandOutput) => void ): void; - public describeChapCredentials( + describeChapCredentials( args: DescribeChapCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChapCredentialsCommandOutput) => void ): void; - public describeChapCredentials( - args: DescribeChapCredentialsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeChapCredentialsCommandOutput) => void), - cb?: (err: any, data?: DescribeChapCredentialsCommandOutput) => void - ): Promise | void { - const command = new DescribeChapCredentialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the file system association information. This operation is only supported for FSx - * File Gateways.

- */ - public describeFileSystemAssociations( + + /** + * @see {@link DescribeFileSystemAssociationsCommand} + */ + describeFileSystemAssociations( args: DescribeFileSystemAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFileSystemAssociations( + describeFileSystemAssociations( args: DescribeFileSystemAssociationsCommandInput, cb: (err: any, data?: DescribeFileSystemAssociationsCommandOutput) => void ): void; - public describeFileSystemAssociations( + describeFileSystemAssociations( args: DescribeFileSystemAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFileSystemAssociationsCommandOutput) => void ): void; - public describeFileSystemAssociations( - args: DescribeFileSystemAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFileSystemAssociationsCommandOutput) => void), - cb?: (err: any, data?: DescribeFileSystemAssociationsCommandOutput) => void - ): Promise | void { - const command = new DescribeFileSystemAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns metadata about a gateway such as its name, network interfaces, configured time - * zone, and the state (whether the gateway is running or not). To specify which gateway to - * describe, use the Amazon Resource Name (ARN) of the gateway in your request.

- */ - public describeGatewayInformation( + + /** + * @see {@link DescribeGatewayInformationCommand} + */ + describeGatewayInformation( args: DescribeGatewayInformationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGatewayInformation( + describeGatewayInformation( args: DescribeGatewayInformationCommandInput, cb: (err: any, data?: DescribeGatewayInformationCommandOutput) => void ): void; - public describeGatewayInformation( + describeGatewayInformation( args: DescribeGatewayInformationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGatewayInformationCommandOutput) => void ): void; - public describeGatewayInformation( - args: DescribeGatewayInformationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGatewayInformationCommandOutput) => void), - cb?: (err: any, data?: DescribeGatewayInformationCommandOutput) => void - ): Promise | void { - const command = new DescribeGatewayInformationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns your gateway's weekly maintenance start time including the day and time of - * the week. Note that values are in terms of the gateway's time zone.

- */ - public describeMaintenanceStartTime( + + /** + * @see {@link DescribeMaintenanceStartTimeCommand} + */ + describeMaintenanceStartTime( args: DescribeMaintenanceStartTimeCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMaintenanceStartTime( + describeMaintenanceStartTime( args: DescribeMaintenanceStartTimeCommandInput, cb: (err: any, data?: DescribeMaintenanceStartTimeCommandOutput) => void ): void; - public describeMaintenanceStartTime( + describeMaintenanceStartTime( args: DescribeMaintenanceStartTimeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMaintenanceStartTimeCommandOutput) => void ): void; - public describeMaintenanceStartTime( - args: DescribeMaintenanceStartTimeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMaintenanceStartTimeCommandOutput) => void), - cb?: (err: any, data?: DescribeMaintenanceStartTimeCommandOutput) => void - ): Promise | void { - const command = new DescribeMaintenanceStartTimeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a description for one or more Network File System (NFS) file shares from an S3 File - * Gateway. This operation is only supported for S3 File Gateways.

- */ - public describeNFSFileShares( + + /** + * @see {@link DescribeNFSFileSharesCommand} + */ + describeNFSFileShares( args: DescribeNFSFileSharesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNFSFileShares( + describeNFSFileShares( args: DescribeNFSFileSharesCommandInput, cb: (err: any, data?: DescribeNFSFileSharesCommandOutput) => void ): void; - public describeNFSFileShares( + describeNFSFileShares( args: DescribeNFSFileSharesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNFSFileSharesCommandOutput) => void ): void; - public describeNFSFileShares( - args: DescribeNFSFileSharesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeNFSFileSharesCommandOutput) => void), - cb?: (err: any, data?: DescribeNFSFileSharesCommandOutput) => void - ): Promise | void { - const command = new DescribeNFSFileSharesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a description for one or more Server Message Block (SMB) file shares from a S3 File - * Gateway. This operation is only supported for S3 File Gateways.

- */ - public describeSMBFileShares( + + /** + * @see {@link DescribeSMBFileSharesCommand} + */ + describeSMBFileShares( args: DescribeSMBFileSharesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSMBFileShares( + describeSMBFileShares( args: DescribeSMBFileSharesCommandInput, cb: (err: any, data?: DescribeSMBFileSharesCommandOutput) => void ): void; - public describeSMBFileShares( + describeSMBFileShares( args: DescribeSMBFileSharesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSMBFileSharesCommandOutput) => void ): void; - public describeSMBFileShares( - args: DescribeSMBFileSharesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSMBFileSharesCommandOutput) => void), - cb?: (err: any, data?: DescribeSMBFileSharesCommandOutput) => void - ): Promise | void { - const command = new DescribeSMBFileSharesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a description of a Server Message Block (SMB) file share settings from a file - * gateway. This operation is only supported for file gateways.

- */ - public describeSMBSettings( + + /** + * @see {@link DescribeSMBSettingsCommand} + */ + describeSMBSettings( args: DescribeSMBSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSMBSettings( + describeSMBSettings( args: DescribeSMBSettingsCommandInput, cb: (err: any, data?: DescribeSMBSettingsCommandOutput) => void ): void; - public describeSMBSettings( + describeSMBSettings( args: DescribeSMBSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSMBSettingsCommandOutput) => void ): void; - public describeSMBSettings( - args: DescribeSMBSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSMBSettingsCommandOutput) => void), - cb?: (err: any, data?: DescribeSMBSettingsCommandOutput) => void - ): Promise | void { - const command = new DescribeSMBSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the snapshot schedule for the specified gateway volume. The snapshot schedule - * information includes intervals at which snapshots are automatically initiated on the - * volume. This operation is only supported in the cached volume and stored volume - * types.

- */ - public describeSnapshotSchedule( + + /** + * @see {@link DescribeSnapshotScheduleCommand} + */ + describeSnapshotSchedule( args: DescribeSnapshotScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSnapshotSchedule( + describeSnapshotSchedule( args: DescribeSnapshotScheduleCommandInput, cb: (err: any, data?: DescribeSnapshotScheduleCommandOutput) => void ): void; - public describeSnapshotSchedule( + describeSnapshotSchedule( args: DescribeSnapshotScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSnapshotScheduleCommandOutput) => void ): void; - public describeSnapshotSchedule( - args: DescribeSnapshotScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSnapshotScheduleCommandOutput) => void), - cb?: (err: any, data?: DescribeSnapshotScheduleCommandOutput) => void - ): Promise | void { - const command = new DescribeSnapshotScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the description of the gateway volumes specified in the request. The list of - * gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume ARNs. This operation is only - * supported in stored volume gateway type.

- */ - public describeStorediSCSIVolumes( + + /** + * @see {@link DescribeStorediSCSIVolumesCommand} + */ + describeStorediSCSIVolumes( args: DescribeStorediSCSIVolumesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeStorediSCSIVolumes( + describeStorediSCSIVolumes( args: DescribeStorediSCSIVolumesCommandInput, cb: (err: any, data?: DescribeStorediSCSIVolumesCommandOutput) => void ): void; - public describeStorediSCSIVolumes( + describeStorediSCSIVolumes( args: DescribeStorediSCSIVolumesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStorediSCSIVolumesCommandOutput) => void ): void; - public describeStorediSCSIVolumes( - args: DescribeStorediSCSIVolumesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeStorediSCSIVolumesCommandOutput) => void), - cb?: (err: any, data?: DescribeStorediSCSIVolumesCommandOutput) => void - ): Promise | void { - const command = new DescribeStorediSCSIVolumesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This - * operation is only supported in the tape gateway type.

- * - *

If a specific TapeARN is not specified, Storage Gateway returns a - * description of all virtual tapes found in the VTS associated with your account.

- */ - public describeTapeArchives( + + /** + * @see {@link DescribeTapeArchivesCommand} + */ + describeTapeArchives( args: DescribeTapeArchivesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTapeArchives( + describeTapeArchives( args: DescribeTapeArchivesCommandInput, cb: (err: any, data?: DescribeTapeArchivesCommandOutput) => void ): void; - public describeTapeArchives( + describeTapeArchives( args: DescribeTapeArchivesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTapeArchivesCommandOutput) => void ): void; - public describeTapeArchives( - args: DescribeTapeArchivesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTapeArchivesCommandOutput) => void), - cb?: (err: any, data?: DescribeTapeArchivesCommandOutput) => void - ): Promise | void { - const command = new DescribeTapeArchivesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of virtual tape recovery points that are available for the specified tape - * gateway.

- * - *

A recovery point is a point-in-time view of a virtual tape at which all the data on the - * virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery - * points can be recovered to a new gateway. This operation is only supported in the tape - * gateway type.

- */ - public describeTapeRecoveryPoints( + + /** + * @see {@link DescribeTapeRecoveryPointsCommand} + */ + describeTapeRecoveryPoints( args: DescribeTapeRecoveryPointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTapeRecoveryPoints( + describeTapeRecoveryPoints( args: DescribeTapeRecoveryPointsCommandInput, cb: (err: any, data?: DescribeTapeRecoveryPointsCommandOutput) => void ): void; - public describeTapeRecoveryPoints( + describeTapeRecoveryPoints( args: DescribeTapeRecoveryPointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTapeRecoveryPointsCommandOutput) => void ): void; - public describeTapeRecoveryPoints( - args: DescribeTapeRecoveryPointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTapeRecoveryPointsCommandOutput) => void), - cb?: (err: any, data?: DescribeTapeRecoveryPointsCommandOutput) => void - ): Promise | void { - const command = new DescribeTapeRecoveryPointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a - * TapeARN is not specified, returns a description of all virtual tapes - * associated with the specified gateway. This operation is only supported in the tape gateway - * type.

- */ - public describeTapes( - args: DescribeTapesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeTapes( - args: DescribeTapesCommandInput, - cb: (err: any, data?: DescribeTapesCommandOutput) => void - ): void; - public describeTapes( + + /** + * @see {@link DescribeTapesCommand} + */ + describeTapes(args: DescribeTapesCommandInput, options?: __HttpHandlerOptions): Promise; + describeTapes(args: DescribeTapesCommandInput, cb: (err: any, data?: DescribeTapesCommandOutput) => void): void; + describeTapes( args: DescribeTapesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTapesCommandOutput) => void ): void; - public describeTapes( - args: DescribeTapesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTapesCommandOutput) => void), - cb?: (err: any, data?: DescribeTapesCommandOutput) => void - ): Promise | void { - const command = new DescribeTapesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the upload buffer of a gateway. This operation is supported - * for the stored volume, cached volume, and tape gateway types.

- * - *

The response includes disk IDs that are configured as upload buffer space, and it - * includes the amount of upload buffer space allocated and used.

- */ - public describeUploadBuffer( + + /** + * @see {@link DescribeUploadBufferCommand} + */ + describeUploadBuffer( args: DescribeUploadBufferCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeUploadBuffer( + describeUploadBuffer( args: DescribeUploadBufferCommandInput, cb: (err: any, data?: DescribeUploadBufferCommandOutput) => void ): void; - public describeUploadBuffer( + describeUploadBuffer( args: DescribeUploadBufferCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUploadBufferCommandOutput) => void ): void; - public describeUploadBuffer( - args: DescribeUploadBufferCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUploadBufferCommandOutput) => void), - cb?: (err: any, data?: DescribeUploadBufferCommandOutput) => void - ): Promise | void { - const command = new DescribeUploadBufferCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a description of virtual tape library (VTL) devices for the specified tape - * gateway. In the response, Storage Gateway returns VTL device information.

- * - *

This operation is only supported in the tape gateway type.

- */ - public describeVTLDevices( + + /** + * @see {@link DescribeVTLDevicesCommand} + */ + describeVTLDevices( args: DescribeVTLDevicesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeVTLDevices( + describeVTLDevices( args: DescribeVTLDevicesCommandInput, cb: (err: any, data?: DescribeVTLDevicesCommandOutput) => void ): void; - public describeVTLDevices( + describeVTLDevices( args: DescribeVTLDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVTLDevicesCommandOutput) => void ): void; - public describeVTLDevices( - args: DescribeVTLDevicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeVTLDevicesCommandOutput) => void), - cb?: (err: any, data?: DescribeVTLDevicesCommandOutput) => void - ): Promise | void { - const command = new DescribeVTLDevicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns information about the working storage of a gateway. This operation is only - * supported in the stored volumes gateway type. This operation is deprecated in cached - * volumes API version (20120630). Use DescribeUploadBuffer instead.

- * - * - *

Working storage is also referred to as upload buffer. You can also use the - * DescribeUploadBuffer operation to add upload buffer to a stored volume gateway.

- *
- * - *

The response includes disk IDs that are configured as working storage, and it includes - * the amount of working storage allocated and used.

- */ - public describeWorkingStorage( + + /** + * @see {@link DescribeWorkingStorageCommand} + */ + describeWorkingStorage( args: DescribeWorkingStorageCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWorkingStorage( + describeWorkingStorage( args: DescribeWorkingStorageCommandInput, cb: (err: any, data?: DescribeWorkingStorageCommandOutput) => void ): void; - public describeWorkingStorage( + describeWorkingStorage( args: DescribeWorkingStorageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkingStorageCommandOutput) => void ): void; - public describeWorkingStorage( - args: DescribeWorkingStorageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWorkingStorageCommandOutput) => void), - cb?: (err: any, data?: DescribeWorkingStorageCommandOutput) => void - ): Promise | void { - const command = new DescribeWorkingStorageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disconnects a volume from an iSCSI connection and then detaches the volume from the - * specified gateway. Detaching and attaching a volume enables you to recover your data from - * one gateway to a different gateway without creating a snapshot. It also makes it easier to - * move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 - * instance. This operation is only supported in the volume gateway type.

- */ - public detachVolume( - args: DetachVolumeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public detachVolume(args: DetachVolumeCommandInput, cb: (err: any, data?: DetachVolumeCommandOutput) => void): void; - public detachVolume( + + /** + * @see {@link DetachVolumeCommand} + */ + detachVolume(args: DetachVolumeCommandInput, options?: __HttpHandlerOptions): Promise; + detachVolume(args: DetachVolumeCommandInput, cb: (err: any, data?: DetachVolumeCommandOutput) => void): void; + detachVolume( args: DetachVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachVolumeCommandOutput) => void ): void; - public detachVolume( - args: DetachVolumeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetachVolumeCommandOutput) => void), - cb?: (err: any, data?: DetachVolumeCommandOutput) => void - ): Promise | void { - const command = new DetachVolumeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disables a tape gateway when the gateway is no longer functioning. For example, if your - * gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.

- * - *

Use this operation for a tape gateway that is not reachable or not functioning. This - * operation is only supported in the tape gateway type.

- * - * - *

After a gateway is disabled, it cannot be enabled.

- *
- */ - public disableGateway( + + /** + * @see {@link DisableGatewayCommand} + */ + disableGateway( args: DisableGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public disableGateway( - args: DisableGatewayCommandInput, - cb: (err: any, data?: DisableGatewayCommandOutput) => void - ): void; - public disableGateway( + disableGateway(args: DisableGatewayCommandInput, cb: (err: any, data?: DisableGatewayCommandOutput) => void): void; + disableGateway( args: DisableGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableGatewayCommandOutput) => void ): void; - public disableGateway( - args: DisableGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisableGatewayCommandOutput) => void), - cb?: (err: any, data?: DisableGatewayCommandOutput) => void - ): Promise | void { - const command = new DisableGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates an Amazon FSx file system from the specified gateway. After the - * disassociation process finishes, the gateway can no longer access the Amazon FSx - * file system. This operation is only supported in the FSx File Gateway type.

- */ - public disassociateFileSystem( + + /** + * @see {@link DisassociateFileSystemCommand} + */ + disassociateFileSystem( args: DisassociateFileSystemCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateFileSystem( + disassociateFileSystem( args: DisassociateFileSystemCommandInput, cb: (err: any, data?: DisassociateFileSystemCommandOutput) => void ): void; - public disassociateFileSystem( + disassociateFileSystem( args: DisassociateFileSystemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateFileSystemCommandOutput) => void ): void; - public disassociateFileSystem( - args: DisassociateFileSystemCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateFileSystemCommandOutput) => void), - cb?: (err: any, data?: DisassociateFileSystemCommandOutput) => void - ): Promise | void { - const command = new DisassociateFileSystemCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds a file gateway to an Active Directory domain. This operation is only supported for - * file gateways that support the SMB file protocol.

- */ - public joinDomain(args: JoinDomainCommandInput, options?: __HttpHandlerOptions): Promise; - public joinDomain(args: JoinDomainCommandInput, cb: (err: any, data?: JoinDomainCommandOutput) => void): void; - public joinDomain( + + /** + * @see {@link JoinDomainCommand} + */ + joinDomain(args: JoinDomainCommandInput, options?: __HttpHandlerOptions): Promise; + joinDomain(args: JoinDomainCommandInput, cb: (err: any, data?: JoinDomainCommandOutput) => void): void; + joinDomain( args: JoinDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JoinDomainCommandOutput) => void ): void; - public joinDomain( - args: JoinDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: JoinDomainCommandOutput) => void), - cb?: (err: any, data?: JoinDomainCommandOutput) => void - ): Promise | void { - const command = new JoinDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the automatic tape creation policies for a gateway. If there are no automatic tape - * creation policies for the gateway, it returns an empty list.

- * - *

This operation is only supported for tape gateways.

- */ - public listAutomaticTapeCreationPolicies( + + /** + * @see {@link ListAutomaticTapeCreationPoliciesCommand} + */ + listAutomaticTapeCreationPolicies( args: ListAutomaticTapeCreationPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAutomaticTapeCreationPolicies( + listAutomaticTapeCreationPolicies( args: ListAutomaticTapeCreationPoliciesCommandInput, cb: (err: any, data?: ListAutomaticTapeCreationPoliciesCommandOutput) => void ): void; - public listAutomaticTapeCreationPolicies( + listAutomaticTapeCreationPolicies( args: ListAutomaticTapeCreationPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAutomaticTapeCreationPoliciesCommandOutput) => void ): void; - public listAutomaticTapeCreationPolicies( - args: ListAutomaticTapeCreationPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAutomaticTapeCreationPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListAutomaticTapeCreationPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListAutomaticTapeCreationPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of the file shares for a specific S3 File Gateway, or the list of file - * shares that belong to the calling user account. This operation is only supported for S3 - * File Gateways.

- */ - public listFileShares( + + /** + * @see {@link ListFileSharesCommand} + */ + listFileShares( args: ListFileSharesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFileShares( - args: ListFileSharesCommandInput, - cb: (err: any, data?: ListFileSharesCommandOutput) => void - ): void; - public listFileShares( + listFileShares(args: ListFileSharesCommandInput, cb: (err: any, data?: ListFileSharesCommandOutput) => void): void; + listFileShares( args: ListFileSharesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFileSharesCommandOutput) => void ): void; - public listFileShares( - args: ListFileSharesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFileSharesCommandOutput) => void), - cb?: (err: any, data?: ListFileSharesCommandOutput) => void - ): Promise | void { - const command = new ListFileSharesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets a list of FileSystemAssociationSummary objects. Each object contains a - * summary of a file system association. This operation is only supported for FSx File - * Gateways.

- */ - public listFileSystemAssociations( + + /** + * @see {@link ListFileSystemAssociationsCommand} + */ + listFileSystemAssociations( args: ListFileSystemAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFileSystemAssociations( + listFileSystemAssociations( args: ListFileSystemAssociationsCommandInput, cb: (err: any, data?: ListFileSystemAssociationsCommandOutput) => void ): void; - public listFileSystemAssociations( + listFileSystemAssociations( args: ListFileSystemAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFileSystemAssociationsCommandOutput) => void ): void; - public listFileSystemAssociations( - args: ListFileSystemAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFileSystemAssociationsCommandOutput) => void), - cb?: (err: any, data?: ListFileSystemAssociationsCommandOutput) => void - ): Promise | void { - const command = new ListFileSystemAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region - * specified in the request. The returned list is ordered by gateway Amazon Resource Name - * (ARN).

- * - *

By default, the operation returns a maximum of 100 gateways. This operation supports - * pagination that allows you to optionally reduce the number of gateways returned in a - * response.

- * - *

If you have more gateways than are returned in a response (that is, the response returns - * only a truncated list of your gateways), the response contains a marker that you can - * specify in your next request to fetch the next page of gateways.

- */ - public listGateways( - args: ListGatewaysCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listGateways(args: ListGatewaysCommandInput, cb: (err: any, data?: ListGatewaysCommandOutput) => void): void; - public listGateways( + + /** + * @see {@link ListGatewaysCommand} + */ + listGateways(args: ListGatewaysCommandInput, options?: __HttpHandlerOptions): Promise; + listGateways(args: ListGatewaysCommandInput, cb: (err: any, data?: ListGatewaysCommandOutput) => void): void; + listGateways( args: ListGatewaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGatewaysCommandOutput) => void ): void; - public listGateways( - args: ListGatewaysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGatewaysCommandOutput) => void), - cb?: (err: any, data?: ListGatewaysCommandOutput) => void - ): Promise | void { - const command = new ListGatewaysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns a list of the gateway's local disks. To specify which gateway to describe, - * you use the Amazon Resource Name (ARN) of the gateway in the body of the request.

- * - *

The request returns a list of all disks, specifying which are configured as working - * storage, cache storage, or stored volume or not configured at all. The response includes a - * DiskStatus field. This field can have a value of present (the disk is - * available to use), missing (the disk is no longer connected to the gateway), or mismatch - * (the disk node is occupied by a disk that has incorrect metadata or the disk content is - * corrupted).

- */ - public listLocalDisks( + + /** + * @see {@link ListLocalDisksCommand} + */ + listLocalDisks( args: ListLocalDisksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLocalDisks( - args: ListLocalDisksCommandInput, - cb: (err: any, data?: ListLocalDisksCommandOutput) => void - ): void; - public listLocalDisks( + listLocalDisks(args: ListLocalDisksCommandInput, cb: (err: any, data?: ListLocalDisksCommandOutput) => void): void; + listLocalDisks( args: ListLocalDisksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLocalDisksCommandOutput) => void ): void; - public listLocalDisks( - args: ListLocalDisksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLocalDisksCommandOutput) => void), - cb?: (err: any, data?: ListLocalDisksCommandOutput) => void - ): Promise | void { - const command = new ListLocalDisksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the tags that have been added to the specified resource. This operation is - * supported in storage gateways of all types.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists custom tape pools. You specify custom tape pools to list by specifying one or more - * custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN, - * the operation lists all custom tape pools.

- * - *

This operation supports pagination. You can optionally specify the Limit - * parameter in the body to limit the number of tape pools in the response. If the number of - * tape pools returned in the response is truncated, the response includes a - * Marker element that you can use in your subsequent request to retrieve the - * next set of tape pools.

- */ - public listTapePools( - args: ListTapePoolsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listTapePools( - args: ListTapePoolsCommandInput, - cb: (err: any, data?: ListTapePoolsCommandOutput) => void - ): void; - public listTapePools( + + /** + * @see {@link ListTapePoolsCommand} + */ + listTapePools(args: ListTapePoolsCommandInput, options?: __HttpHandlerOptions): Promise; + listTapePools(args: ListTapePoolsCommandInput, cb: (err: any, data?: ListTapePoolsCommandOutput) => void): void; + listTapePools( args: ListTapePoolsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTapePoolsCommandOutput) => void ): void; - public listTapePools( - args: ListTapePoolsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTapePoolsCommandOutput) => void), - cb?: (err: any, data?: ListTapePoolsCommandOutput) => void - ): Promise | void { - const command = new ListTapePoolsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf - * (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names - * (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both - * your VTL and VTS.

- * - *

This operation supports pagination. By default, the operation returns a maximum of up to - * 100 tapes. You can optionally specify the Limit parameter in the body to limit - * the number of tapes in the response. If the number of tapes returned in the response is - * truncated, the response includes a Marker element that you can use in your - * subsequent request to retrieve the next set of tapes. This operation is only supported in - * the tape gateway type.

- */ - public listTapes(args: ListTapesCommandInput, options?: __HttpHandlerOptions): Promise; - public listTapes(args: ListTapesCommandInput, cb: (err: any, data?: ListTapesCommandOutput) => void): void; - public listTapes( + + /** + * @see {@link ListTapesCommand} + */ + listTapes(args: ListTapesCommandInput, options?: __HttpHandlerOptions): Promise; + listTapes(args: ListTapesCommandInput, cb: (err: any, data?: ListTapesCommandOutput) => void): void; + listTapes( args: ListTapesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTapesCommandOutput) => void ): void; - public listTapes( - args: ListTapesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTapesCommandOutput) => void), - cb?: (err: any, data?: ListTapesCommandOutput) => void - ): Promise | void { - const command = new ListTapesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists iSCSI initiators that are connected to a volume. You can use this operation to - * determine whether a volume is being used or not. This operation is only supported in the - * cached volume and stored volume gateway types.

- */ - public listVolumeInitiators( + + /** + * @see {@link ListVolumeInitiatorsCommand} + */ + listVolumeInitiators( args: ListVolumeInitiatorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVolumeInitiators( + listVolumeInitiators( args: ListVolumeInitiatorsCommandInput, cb: (err: any, data?: ListVolumeInitiatorsCommandOutput) => void ): void; - public listVolumeInitiators( + listVolumeInitiators( args: ListVolumeInitiatorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVolumeInitiatorsCommandOutput) => void ): void; - public listVolumeInitiators( - args: ListVolumeInitiatorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVolumeInitiatorsCommandOutput) => void), - cb?: (err: any, data?: ListVolumeInitiatorsCommandOutput) => void - ): Promise | void { - const command = new ListVolumeInitiatorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the recovery points for a specified gateway. This operation is only supported in - * the cached volume gateway type.

- * - *

Each cache volume has one recovery point. A volume recovery point is a point in time at - * which all data of the volume is consistent and from which you can create a snapshot or - * clone a new cached volume from a source volume. To create a snapshot from a volume recovery - * point use the CreateSnapshotFromVolumeRecoveryPoint operation.

- */ - public listVolumeRecoveryPoints( + + /** + * @see {@link ListVolumeRecoveryPointsCommand} + */ + listVolumeRecoveryPoints( args: ListVolumeRecoveryPointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVolumeRecoveryPoints( + listVolumeRecoveryPoints( args: ListVolumeRecoveryPointsCommandInput, cb: (err: any, data?: ListVolumeRecoveryPointsCommandOutput) => void ): void; - public listVolumeRecoveryPoints( + listVolumeRecoveryPoints( args: ListVolumeRecoveryPointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVolumeRecoveryPointsCommandOutput) => void ): void; - public listVolumeRecoveryPoints( - args: ListVolumeRecoveryPointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVolumeRecoveryPointsCommandOutput) => void), - cb?: (err: any, data?: ListVolumeRecoveryPointsCommandOutput) => void - ): Promise | void { - const command = new ListVolumeRecoveryPointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The - * response includes only the volume ARNs. If you want additional volume information, use the - * DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API.

- * - *

The operation supports pagination. By default, the operation returns a maximum of up to - * 100 volumes. You can optionally specify the Limit field in the body to limit - * the number of volumes in the response. If the number of volumes returned in the response is - * truncated, the response includes a Marker field. You can use this Marker value in your - * subsequent request to retrieve the next set of volumes. This operation is only supported in - * the cached volume and stored volume gateway types.

- */ - public listVolumes(args: ListVolumesCommandInput, options?: __HttpHandlerOptions): Promise; - public listVolumes(args: ListVolumesCommandInput, cb: (err: any, data?: ListVolumesCommandOutput) => void): void; - public listVolumes( + + /** + * @see {@link ListVolumesCommand} + */ + listVolumes(args: ListVolumesCommandInput, options?: __HttpHandlerOptions): Promise; + listVolumes(args: ListVolumesCommandInput, cb: (err: any, data?: ListVolumesCommandOutput) => void): void; + listVolumes( args: ListVolumesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVolumesCommandOutput) => void ): void; - public listVolumes( - args: ListVolumesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVolumesCommandOutput) => void), - cb?: (err: any, data?: ListVolumesCommandOutput) => void - ): Promise | void { - const command = new ListVolumesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sends you notification through CloudWatch Events when all files written to your file - * share have been uploaded to S3. Amazon S3.

- * - *

Storage Gateway can send a notification through Amazon CloudWatch Events when all - * files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you - * make a request for notification. When the upload is done, Storage Gateway sends you - * notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to - * send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.

- * - * - * - *

For more information, see Getting file upload notification in the Storage Gateway User - * Guide.

- */ - public notifyWhenUploaded( + + /** + * @see {@link NotifyWhenUploadedCommand} + */ + notifyWhenUploaded( args: NotifyWhenUploadedCommandInput, options?: __HttpHandlerOptions ): Promise; - public notifyWhenUploaded( + notifyWhenUploaded( args: NotifyWhenUploadedCommandInput, cb: (err: any, data?: NotifyWhenUploadedCommandOutput) => void ): void; - public notifyWhenUploaded( + notifyWhenUploaded( args: NotifyWhenUploadedCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NotifyWhenUploadedCommandOutput) => void ): void; - public notifyWhenUploaded( - args: NotifyWhenUploadedCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NotifyWhenUploadedCommandOutput) => void), - cb?: (err: any, data?: NotifyWhenUploadedCommandOutput) => void - ): Promise | void { - const command = new NotifyWhenUploadedCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Refreshes the cached inventory of objects for the specified file share. This operation - * finds objects in the Amazon S3 bucket that were added, removed, or replaced since - * the gateway last listed the bucket's contents and cached the results. This operation - * does not import files into the S3 File Gateway cache storage. It only updates the cached - * inventory to reflect changes in the inventory of the objects in the S3 bucket. This - * operation is only supported in the S3 File Gateway types.

- * - *

You can subscribe to be notified through an Amazon CloudWatch event when your - * RefreshCache operation completes. For more information, see Getting notified about file operations in the Storage Gateway - * User Guide. This operation is Only supported for S3 File Gateways.

- * - *

When this API is called, it only initiates the refresh operation. When the API call - * completes and returns a success code, it doesn't necessarily mean that the file - * refresh has completed. You should use the refresh-complete notification to determine that - * the operation has completed before you check for new files on the gateway file share. You - * can subscribe to be notified through a CloudWatch event when your RefreshCache - * operation completes.

- * - *

Throttle limit: This API is asynchronous, so the gateway will accept no more than two - * refreshes at any time. We recommend using the refresh-complete CloudWatch event - * notification before issuing additional requests. For more information, see Getting notified about file operations in the Storage Gateway - * User Guide.

- * - * - *
    - *
  • - *

    Wait at least 60 seconds between consecutive RefreshCache API requests.

    - *
  • - *
  • - *

    RefreshCache does not evict cache entries if invoked consecutively within 60 - * seconds of a previous RefreshCache request.

    - *
  • - *
  • - *

    If you invoke the RefreshCache API when two requests are already being - * processed, any new request will cause an - * InvalidGatewayRequestException error because too many requests - * were sent to the server.

    - *
  • - *
- *
- * - * - *

The S3 bucket name does not need to be included when entering the list of folders in - * the FolderList parameter.

- *
- * - * - * - *

For more information, see Getting notified about file operations in the Storage Gateway - * User Guide.

- */ - public refreshCache( - args: RefreshCacheCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public refreshCache(args: RefreshCacheCommandInput, cb: (err: any, data?: RefreshCacheCommandOutput) => void): void; - public refreshCache( + + /** + * @see {@link RefreshCacheCommand} + */ + refreshCache(args: RefreshCacheCommandInput, options?: __HttpHandlerOptions): Promise; + refreshCache(args: RefreshCacheCommandInput, cb: (err: any, data?: RefreshCacheCommandOutput) => void): void; + refreshCache( args: RefreshCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RefreshCacheCommandOutput) => void ): void; - public refreshCache( - args: RefreshCacheCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RefreshCacheCommandOutput) => void), - cb?: (err: any, data?: RefreshCacheCommandOutput) => void - ): Promise | void { - const command = new RefreshCacheCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes one or more tags from the specified resource. This operation is supported in - * storage gateways of all types.

- */ - public removeTagsFromResource( + + /** + * @see {@link RemoveTagsFromResourceCommand} + */ + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeTagsFromResource( + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void ): void; - public removeTagsFromResource( + removeTagsFromResource( args: RemoveTagsFromResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void ): void; - public removeTagsFromResource( - args: RemoveTagsFromResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveTagsFromResourceCommandOutput) => void), - cb?: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void - ): Promise | void { - const command = new RemoveTagsFromResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Resets all cache disks that have encountered an error and makes the disks available for - * reconfiguration as cache storage. If your cache disk encounters an error, the gateway - * prevents read and write operations on virtual tapes in the gateway. For example, an error - * can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the - * gateway loses its cache storage. At this point, you can reconfigure the disks as cache - * disks. This operation is only supported in the cached volume and tape types.

- * - * - *

If the cache disk you are resetting contains data that has not been uploaded to - * Amazon S3 yet, that data can be lost. After you reset cache disks, there will - * be no configured cache disks left in the gateway, so you must configure at least one new - * cache disk for your gateway to function properly.

- *
- */ - public resetCache(args: ResetCacheCommandInput, options?: __HttpHandlerOptions): Promise; - public resetCache(args: ResetCacheCommandInput, cb: (err: any, data?: ResetCacheCommandOutput) => void): void; - public resetCache( + + /** + * @see {@link ResetCacheCommand} + */ + resetCache(args: ResetCacheCommandInput, options?: __HttpHandlerOptions): Promise; + resetCache(args: ResetCacheCommandInput, cb: (err: any, data?: ResetCacheCommandOutput) => void): void; + resetCache( args: ResetCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetCacheCommandOutput) => void ): void; - public resetCache( - args: ResetCacheCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetCacheCommandOutput) => void), - cb?: (err: any, data?: ResetCacheCommandOutput) => void - ): Promise | void { - const command = new ResetCacheCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. - * Virtual tapes archived in the VTS are not associated with any gateway. However after a tape - * is retrieved, it is associated with a gateway, even though it is also listed in the VTS, - * that is, archive. This operation is only supported in the tape gateway type.

- * - *

Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to - * another gateway. You must archive the tape again before you can retrieve it to another - * gateway. This operation is only supported in the tape gateway type.

- */ - public retrieveTapeArchive( + + /** + * @see {@link RetrieveTapeArchiveCommand} + */ + retrieveTapeArchive( args: RetrieveTapeArchiveCommandInput, options?: __HttpHandlerOptions ): Promise; - public retrieveTapeArchive( + retrieveTapeArchive( args: RetrieveTapeArchiveCommandInput, cb: (err: any, data?: RetrieveTapeArchiveCommandOutput) => void ): void; - public retrieveTapeArchive( + retrieveTapeArchive( args: RetrieveTapeArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RetrieveTapeArchiveCommandOutput) => void ): void; - public retrieveTapeArchive( - args: RetrieveTapeArchiveCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RetrieveTapeArchiveCommandOutput) => void), - cb?: (err: any, data?: RetrieveTapeArchiveCommandOutput) => void - ): Promise | void { - const command = new RetrieveTapeArchiveCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves the recovery point for the specified virtual tape. This operation is only - * supported in the tape gateway type.

- * - *

A recovery point is a point in time view of a virtual tape at which all the data on the - * tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be - * recovered to a new gateway.

- * - * - *

The virtual tape can be retrieved to only one gateway. The retrieved tape is - * read-only. The virtual tape can be retrieved to only a tape gateway. There is no charge - * for retrieving recovery points.

- *
- */ - public retrieveTapeRecoveryPoint( + + /** + * @see {@link RetrieveTapeRecoveryPointCommand} + */ + retrieveTapeRecoveryPoint( args: RetrieveTapeRecoveryPointCommandInput, options?: __HttpHandlerOptions ): Promise; - public retrieveTapeRecoveryPoint( + retrieveTapeRecoveryPoint( args: RetrieveTapeRecoveryPointCommandInput, cb: (err: any, data?: RetrieveTapeRecoveryPointCommandOutput) => void ): void; - public retrieveTapeRecoveryPoint( + retrieveTapeRecoveryPoint( args: RetrieveTapeRecoveryPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RetrieveTapeRecoveryPointCommandOutput) => void ): void; - public retrieveTapeRecoveryPoint( - args: RetrieveTapeRecoveryPointCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RetrieveTapeRecoveryPointCommandOutput) => void), - cb?: (err: any, data?: RetrieveTapeRecoveryPointCommandOutput) => void - ): Promise | void { - const command = new RetrieveTapeRecoveryPointCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the password for your VM local console. When you log in to the local console for - * the first time, you log in to the VM with the default credentials. We recommend that you - * set a new password. You don't need to know the default password to set a new - * password.

- */ - public setLocalConsolePassword( + + /** + * @see {@link SetLocalConsolePasswordCommand} + */ + setLocalConsolePassword( args: SetLocalConsolePasswordCommandInput, options?: __HttpHandlerOptions ): Promise; - public setLocalConsolePassword( + setLocalConsolePassword( args: SetLocalConsolePasswordCommandInput, cb: (err: any, data?: SetLocalConsolePasswordCommandOutput) => void ): void; - public setLocalConsolePassword( + setLocalConsolePassword( args: SetLocalConsolePasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetLocalConsolePasswordCommandOutput) => void ): void; - public setLocalConsolePassword( - args: SetLocalConsolePasswordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetLocalConsolePasswordCommandOutput) => void), - cb?: (err: any, data?: SetLocalConsolePasswordCommandOutput) => void - ): Promise | void { - const command = new SetLocalConsolePasswordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the password for the guest user smbguest. The smbguest - * user is the user when the authentication method for the file share is set to - * GuestAccess. This operation only supported for S3 File Gateways

- */ - public setSMBGuestPassword( + + /** + * @see {@link SetSMBGuestPasswordCommand} + */ + setSMBGuestPassword( args: SetSMBGuestPasswordCommandInput, options?: __HttpHandlerOptions ): Promise; - public setSMBGuestPassword( + setSMBGuestPassword( args: SetSMBGuestPasswordCommandInput, cb: (err: any, data?: SetSMBGuestPasswordCommandOutput) => void ): void; - public setSMBGuestPassword( + setSMBGuestPassword( args: SetSMBGuestPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetSMBGuestPasswordCommandOutput) => void ): void; - public setSMBGuestPassword( - args: SetSMBGuestPasswordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SetSMBGuestPasswordCommandOutput) => void), - cb?: (err: any, data?: SetSMBGuestPasswordCommandOutput) => void - ): Promise | void { - const command = new SetSMBGuestPasswordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource - * Name (ARN) of the gateway in the body of your request.

- * - *

The operation shuts down the gateway service component running in the gateway's - * virtual machine (VM) and not the host VM.

- * - * - *

If you want to shut down the VM, it is recommended that you first shut down the - * gateway component in the VM to avoid unpredictable conditions.

- *
- * - *

After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. - * Your applications cannot read from or write to the gateway's storage volumes, and - * there are no snapshots taken.

- * - * - *

When you make a shutdown request, you will get a 200 OK success response - * immediately. However, it might take some time for the gateway to shut down. You can call - * the DescribeGatewayInformation API to check the status. For more - * information, see ActivateGateway.

- *
- * - *

If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the - * gateway.

- */ - public shutdownGateway( + + /** + * @see {@link ShutdownGatewayCommand} + */ + shutdownGateway( args: ShutdownGatewayCommandInput, options?: __HttpHandlerOptions ): Promise; - public shutdownGateway( - args: ShutdownGatewayCommandInput, - cb: (err: any, data?: ShutdownGatewayCommandOutput) => void - ): void; - public shutdownGateway( + shutdownGateway(args: ShutdownGatewayCommandInput, cb: (err: any, data?: ShutdownGatewayCommandOutput) => void): void; + shutdownGateway( args: ShutdownGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ShutdownGatewayCommandOutput) => void ): void; - public shutdownGateway( - args: ShutdownGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ShutdownGatewayCommandOutput) => void), - cb?: (err: any, data?: ShutdownGatewayCommandOutput) => void - ): Promise | void { - const command = new ShutdownGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Start a test that verifies that the specified gateway is configured for High - * Availability monitoring in your host environment. This request only initiates the test and - * that a successful response only indicates that the test was started. It doesn't - * indicate that the test passed. For the status of the test, invoke the - * DescribeAvailabilityMonitorTest API.

- * - *

Starting this test will cause your gateway to go offline for a brief period.

- *
- */ - public startAvailabilityMonitorTest( + + /** + * @see {@link StartAvailabilityMonitorTestCommand} + */ + startAvailabilityMonitorTest( args: StartAvailabilityMonitorTestCommandInput, options?: __HttpHandlerOptions ): Promise; - public startAvailabilityMonitorTest( + startAvailabilityMonitorTest( args: StartAvailabilityMonitorTestCommandInput, cb: (err: any, data?: StartAvailabilityMonitorTestCommandOutput) => void ): void; - public startAvailabilityMonitorTest( + startAvailabilityMonitorTest( args: StartAvailabilityMonitorTestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartAvailabilityMonitorTestCommandOutput) => void ): void; - public startAvailabilityMonitorTest( - args: StartAvailabilityMonitorTestCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartAvailabilityMonitorTestCommandOutput) => void), - cb?: (err: any, data?: StartAvailabilityMonitorTestCommandOutput) => void - ): Promise | void { - const command = new StartAvailabilityMonitorTestCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a gateway that you previously shut down (see ShutdownGateway). - * After the gateway starts, you can then make other API calls, your applications can read - * from or write to the gateway's storage volumes and you will be able to take snapshot - * backups.

- * - * - *

When you make a request, you will get a 200 OK success response immediately. However, - * it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any - * additional API calls. For more information, see ActivateGateway.

- *
- * - *

To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in - * your request.

- */ - public startGateway( - args: StartGatewayCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public startGateway(args: StartGatewayCommandInput, cb: (err: any, data?: StartGatewayCommandOutput) => void): void; - public startGateway( + + /** + * @see {@link StartGatewayCommand} + */ + startGateway(args: StartGatewayCommandInput, options?: __HttpHandlerOptions): Promise; + startGateway(args: StartGatewayCommandInput, cb: (err: any, data?: StartGatewayCommandOutput) => void): void; + startGateway( args: StartGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartGatewayCommandOutput) => void ): void; - public startGateway( - args: StartGatewayCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartGatewayCommandOutput) => void), - cb?: (err: any, data?: StartGatewayCommandOutput) => void - ): Promise | void { - const command = new StartGatewayCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the automatic tape creation policy of a gateway. Use this to update the policy - * with a new set of automatic tape creation rules. This is only supported for tape - * gateways.

- * - *

By default, there is no automatic tape creation policy.

- * - * - *

A gateway can have only one automatic tape creation policy.

- *
- */ - public updateAutomaticTapeCreationPolicy( + + /** + * @see {@link UpdateAutomaticTapeCreationPolicyCommand} + */ + updateAutomaticTapeCreationPolicy( args: UpdateAutomaticTapeCreationPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAutomaticTapeCreationPolicy( + updateAutomaticTapeCreationPolicy( args: UpdateAutomaticTapeCreationPolicyCommandInput, cb: (err: any, data?: UpdateAutomaticTapeCreationPolicyCommandOutput) => void ): void; - public updateAutomaticTapeCreationPolicy( + updateAutomaticTapeCreationPolicy( args: UpdateAutomaticTapeCreationPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAutomaticTapeCreationPolicyCommandOutput) => void ): void; - public updateAutomaticTapeCreationPolicy( - args: UpdateAutomaticTapeCreationPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAutomaticTapeCreationPolicyCommandOutput) => void), - cb?: (err: any, data?: UpdateAutomaticTapeCreationPolicyCommandOutput) => void - ): Promise | void { - const command = new UpdateAutomaticTapeCreationPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the bandwidth rate limits of a gateway. You can update both the upload and - * download bandwidth rate limit or specify only one of the two. If you don't set a - * bandwidth rate limit, the existing rate limit remains. This operation is supported only for - * the stored volume, cached volume, and tape gateway types. To update bandwidth rate limits - * for S3 file gateways, use UpdateBandwidthRateLimitSchedule.

- * - *

By default, a gateway's bandwidth rate limits are not set. If you don't set - * any limit, the gateway does not have any limitations on its bandwidth usage and could - * potentially use the maximum available bandwidth.

- * - *

To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in - * your request.

- */ - public updateBandwidthRateLimit( + + /** + * @see {@link UpdateBandwidthRateLimitCommand} + */ + updateBandwidthRateLimit( args: UpdateBandwidthRateLimitCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBandwidthRateLimit( + updateBandwidthRateLimit( args: UpdateBandwidthRateLimitCommandInput, cb: (err: any, data?: UpdateBandwidthRateLimitCommandOutput) => void ): void; - public updateBandwidthRateLimit( + updateBandwidthRateLimit( args: UpdateBandwidthRateLimitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBandwidthRateLimitCommandOutput) => void ): void; - public updateBandwidthRateLimit( - args: UpdateBandwidthRateLimitCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBandwidthRateLimitCommandOutput) => void), - cb?: (err: any, data?: UpdateBandwidthRateLimitCommandOutput) => void - ): Promise | void { - const command = new UpdateBandwidthRateLimitCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways - * do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in - * effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This - * operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not - * support bandwidth rate limits.

- */ - public updateBandwidthRateLimitSchedule( + + /** + * @see {@link UpdateBandwidthRateLimitScheduleCommand} + */ + updateBandwidthRateLimitSchedule( args: UpdateBandwidthRateLimitScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBandwidthRateLimitSchedule( + updateBandwidthRateLimitSchedule( args: UpdateBandwidthRateLimitScheduleCommandInput, cb: (err: any, data?: UpdateBandwidthRateLimitScheduleCommandOutput) => void ): void; - public updateBandwidthRateLimitSchedule( + updateBandwidthRateLimitSchedule( args: UpdateBandwidthRateLimitScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBandwidthRateLimitScheduleCommandOutput) => void ): void; - public updateBandwidthRateLimitSchedule( - args: UpdateBandwidthRateLimitScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBandwidthRateLimitScheduleCommandOutput) => void), - cb?: (err: any, data?: UpdateBandwidthRateLimitScheduleCommandOutput) => void - ): Promise | void { - const command = new UpdateBandwidthRateLimitScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a - * specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for - * added security, you might use it. This operation is supported in the volume and tape - * gateway types.

- * - * - *

When you update CHAP credentials, all existing connections on the target are closed - * and initiators must reconnect with the new credentials.

- *
- */ - public updateChapCredentials( + + /** + * @see {@link UpdateChapCredentialsCommand} + */ + updateChapCredentials( args: UpdateChapCredentialsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateChapCredentials( + updateChapCredentials( args: UpdateChapCredentialsCommandInput, cb: (err: any, data?: UpdateChapCredentialsCommandOutput) => void ): void; - public updateChapCredentials( + updateChapCredentials( args: UpdateChapCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChapCredentialsCommandOutput) => void ): void; - public updateChapCredentials( - args: UpdateChapCredentialsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateChapCredentialsCommandOutput) => void), - cb?: (err: any, data?: UpdateChapCredentialsCommandOutput) => void - ): Promise | void { - const command = new UpdateChapCredentialsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a file system association. This operation is only supported in the FSx File - * Gateways.

- */ - public updateFileSystemAssociation( + + /** + * @see {@link UpdateFileSystemAssociationCommand} + */ + updateFileSystemAssociation( args: UpdateFileSystemAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFileSystemAssociation( + updateFileSystemAssociation( args: UpdateFileSystemAssociationCommandInput, cb: (err: any, data?: UpdateFileSystemAssociationCommandOutput) => void ): void; - public updateFileSystemAssociation( + updateFileSystemAssociation( args: UpdateFileSystemAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFileSystemAssociationCommandOutput) => void ): void; - public updateFileSystemAssociation( - args: UpdateFileSystemAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFileSystemAssociationCommandOutput) => void), - cb?: (err: any, data?: UpdateFileSystemAssociationCommandOutput) => void - ): Promise | void { - const command = new UpdateFileSystemAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a gateway's metadata, which includes the gateway's name and time zone. - * To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in - * your request.

- * - * - *

For gateways activated after September 2, 2015, the gateway's ARN contains the - * gateway ID rather than the gateway name. However, changing the name of the gateway has - * no effect on the gateway's ARN.

- *
- */ - public updateGatewayInformation( + + /** + * @see {@link UpdateGatewayInformationCommand} + */ + updateGatewayInformation( args: UpdateGatewayInformationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGatewayInformation( + updateGatewayInformation( args: UpdateGatewayInformationCommandInput, cb: (err: any, data?: UpdateGatewayInformationCommandOutput) => void ): void; - public updateGatewayInformation( + updateGatewayInformation( args: UpdateGatewayInformationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGatewayInformationCommandOutput) => void ): void; - public updateGatewayInformation( - args: UpdateGatewayInformationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGatewayInformationCommandOutput) => void), - cb?: (err: any, data?: UpdateGatewayInformationCommandOutput) => void - ): Promise | void { - const command = new UpdateGatewayInformationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the gateway virtual machine (VM) software. The request immediately triggers the - * software update.

- * - * - *

When you make this request, you get a 200 OK success response - * immediately. However, it might take some time for the update to complete. You can call - * DescribeGatewayInformation to verify the gateway is in the - * STATE_RUNNING state.

- *
- * - * - *

A software update forces a system restart of your gateway. You can minimize the - * chance of any disruption to your applications by increasing your iSCSI Initiators' - * timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and - * Linux, see Customizing your Windows iSCSI settings and Customizing your Linux iSCSI settings, respectively.

- *
- */ - public updateGatewaySoftwareNow( + + /** + * @see {@link UpdateGatewaySoftwareNowCommand} + */ + updateGatewaySoftwareNow( args: UpdateGatewaySoftwareNowCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGatewaySoftwareNow( + updateGatewaySoftwareNow( args: UpdateGatewaySoftwareNowCommandInput, cb: (err: any, data?: UpdateGatewaySoftwareNowCommandOutput) => void ): void; - public updateGatewaySoftwareNow( + updateGatewaySoftwareNow( args: UpdateGatewaySoftwareNowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGatewaySoftwareNowCommandOutput) => void ): void; - public updateGatewaySoftwareNow( - args: UpdateGatewaySoftwareNowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGatewaySoftwareNowCommandOutput) => void), - cb?: (err: any, data?: UpdateGatewaySoftwareNowCommandOutput) => void - ): Promise | void { - const command = new UpdateGatewaySoftwareNowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a gateway's weekly maintenance start time information, including day and - * time of the week. The maintenance time is the time in your gateway's time zone.

- */ - public updateMaintenanceStartTime( + + /** + * @see {@link UpdateMaintenanceStartTimeCommand} + */ + updateMaintenanceStartTime( args: UpdateMaintenanceStartTimeCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMaintenanceStartTime( + updateMaintenanceStartTime( args: UpdateMaintenanceStartTimeCommandInput, cb: (err: any, data?: UpdateMaintenanceStartTimeCommandOutput) => void ): void; - public updateMaintenanceStartTime( + updateMaintenanceStartTime( args: UpdateMaintenanceStartTimeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMaintenanceStartTimeCommandOutput) => void ): void; - public updateMaintenanceStartTime( - args: UpdateMaintenanceStartTimeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMaintenanceStartTimeCommandOutput) => void), - cb?: (err: any, data?: UpdateMaintenanceStartTimeCommandOutput) => void - ): Promise | void { - const command = new UpdateMaintenanceStartTimeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a Network File System (NFS) file share. This operation is only supported in S3 - * File Gateways.

- * - * - *

To leave a file share field unchanged, set the corresponding input field to - * null.

- *
- * - *

Updates the following file share settings:

- * - *
    - *
  • - *

    Default storage class for your S3 bucket

    - *
  • - *
  • - *

    Metadata defaults for your S3 bucket

    - *
  • - *
  • - *

    Allowed NFS clients for your file share

    - *
  • - *
  • - *

    Squash settings

    - *
  • - *
  • - *

    Write status of your file share

    - *
  • - *
- */ - public updateNFSFileShare( + + /** + * @see {@link UpdateNFSFileShareCommand} + */ + updateNFSFileShare( args: UpdateNFSFileShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateNFSFileShare( + updateNFSFileShare( args: UpdateNFSFileShareCommandInput, cb: (err: any, data?: UpdateNFSFileShareCommandOutput) => void ): void; - public updateNFSFileShare( + updateNFSFileShare( args: UpdateNFSFileShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNFSFileShareCommandOutput) => void ): void; - public updateNFSFileShare( - args: UpdateNFSFileShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateNFSFileShareCommandOutput) => void), - cb?: (err: any, data?: UpdateNFSFileShareCommandOutput) => void - ): Promise | void { - const command = new UpdateNFSFileShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a Server Message Block (SMB) file share. This operation is only supported for S3 - * File Gateways.

- * - * - *

To leave a file share field unchanged, set the corresponding input field to - * null.

- *
- * - * - *

File gateways require Security Token Service (Amazon Web Services STS) to be - * activated to enable you to create a file share. Make sure that Amazon Web Services STS - * is activated in the Amazon Web Services Region you are creating your file gateway in. If - * Amazon Web Services STS is not activated in this Amazon Web Services Region, activate - * it. For information about how to activate Amazon Web Services STS, see Activating and - * deactivating Amazon Web Services STS in an Amazon Web Services Region in the - * Identity and Access Management User Guide.

- * - *

File gateways don't support creating hard or symbolic links on a file - * share.

- *
- */ - public updateSMBFileShare( + + /** + * @see {@link UpdateSMBFileShareCommand} + */ + updateSMBFileShare( args: UpdateSMBFileShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSMBFileShare( + updateSMBFileShare( args: UpdateSMBFileShareCommandInput, cb: (err: any, data?: UpdateSMBFileShareCommandOutput) => void ): void; - public updateSMBFileShare( + updateSMBFileShare( args: UpdateSMBFileShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSMBFileShareCommandOutput) => void ): void; - public updateSMBFileShare( - args: UpdateSMBFileShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSMBFileShareCommandOutput) => void), - cb?: (err: any, data?: UpdateSMBFileShareCommandOutput) => void - ): Promise | void { - const command = new UpdateSMBFileShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Controls whether the shares on an S3 File Gateway are visible in a net view or browse - * list. The operation is only supported for S3 File Gateways.

- */ - public updateSMBFileShareVisibility( + + /** + * @see {@link UpdateSMBFileShareVisibilityCommand} + */ + updateSMBFileShareVisibility( args: UpdateSMBFileShareVisibilityCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSMBFileShareVisibility( + updateSMBFileShareVisibility( args: UpdateSMBFileShareVisibilityCommandInput, cb: (err: any, data?: UpdateSMBFileShareVisibilityCommandOutput) => void ): void; - public updateSMBFileShareVisibility( + updateSMBFileShareVisibility( args: UpdateSMBFileShareVisibilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSMBFileShareVisibilityCommandOutput) => void ): void; - public updateSMBFileShareVisibility( - args: UpdateSMBFileShareVisibilityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSMBFileShareVisibilityCommandOutput) => void), - cb?: (err: any, data?: UpdateSMBFileShareVisibilityCommandOutput) => void - ): Promise | void { - const command = new UpdateSMBFileShareVisibilityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the list of Active Directory users and groups that have special permissions for - * SMB file shares on the gateway.

- */ - public updateSMBLocalGroups( + + /** + * @see {@link UpdateSMBLocalGroupsCommand} + */ + updateSMBLocalGroups( args: UpdateSMBLocalGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSMBLocalGroups( + updateSMBLocalGroups( args: UpdateSMBLocalGroupsCommandInput, cb: (err: any, data?: UpdateSMBLocalGroupsCommandOutput) => void ): void; - public updateSMBLocalGroups( + updateSMBLocalGroups( args: UpdateSMBLocalGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSMBLocalGroupsCommandOutput) => void ): void; - public updateSMBLocalGroups( - args: UpdateSMBLocalGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSMBLocalGroupsCommandOutput) => void), - cb?: (err: any, data?: UpdateSMBLocalGroupsCommandOutput) => void - ): Promise | void { - const command = new UpdateSMBLocalGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the SMB security strategy on a file gateway. This action is only supported in - * file gateways.

- * - * - *

This API is called Security level in the User Guide.

- * - *

A higher security level can affect performance of the gateway.

- *
- */ - public updateSMBSecurityStrategy( + + /** + * @see {@link UpdateSMBSecurityStrategyCommand} + */ + updateSMBSecurityStrategy( args: UpdateSMBSecurityStrategyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSMBSecurityStrategy( + updateSMBSecurityStrategy( args: UpdateSMBSecurityStrategyCommandInput, cb: (err: any, data?: UpdateSMBSecurityStrategyCommandOutput) => void ): void; - public updateSMBSecurityStrategy( + updateSMBSecurityStrategy( args: UpdateSMBSecurityStrategyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSMBSecurityStrategyCommandOutput) => void ): void; - public updateSMBSecurityStrategy( - args: UpdateSMBSecurityStrategyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSMBSecurityStrategyCommandOutput) => void), - cb?: (err: any, data?: UpdateSMBSecurityStrategyCommandOutput) => void - ): Promise | void { - const command = new UpdateSMBSecurityStrategyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a snapshot schedule configured for a gateway volume. This operation is only - * supported in the cached volume and stored volume gateway types.

- * - *

The default snapshot schedule for volume is once every 24 hours, starting at the - * creation time of the volume. You can use this API to change the snapshot schedule - * configured for the volume.

- * - *

In the request you must identify the gateway volume whose snapshot schedule you want to - * update, and the schedule information, including when you want the snapshot to begin on a - * day and the frequency (in hours) of snapshots.

- */ - public updateSnapshotSchedule( + + /** + * @see {@link UpdateSnapshotScheduleCommand} + */ + updateSnapshotSchedule( args: UpdateSnapshotScheduleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSnapshotSchedule( + updateSnapshotSchedule( args: UpdateSnapshotScheduleCommandInput, cb: (err: any, data?: UpdateSnapshotScheduleCommandOutput) => void ): void; - public updateSnapshotSchedule( + updateSnapshotSchedule( args: UpdateSnapshotScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSnapshotScheduleCommandOutput) => void ): void; - public updateSnapshotSchedule( - args: UpdateSnapshotScheduleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSnapshotScheduleCommandOutput) => void), - cb?: (err: any, data?: UpdateSnapshotScheduleCommandOutput) => void - ): Promise | void { - const command = new UpdateSnapshotScheduleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the type of medium changer in a tape gateway. When you activate a tape gateway, - * you select a medium changer type for the tape gateway. This operation enables you to select - * a different type of medium changer after a tape gateway is activated. This operation is - * only supported in the tape gateway type.

- */ - public updateVTLDeviceType( + + /** + * @see {@link UpdateVTLDeviceTypeCommand} + */ + updateVTLDeviceType( args: UpdateVTLDeviceTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVTLDeviceType( + updateVTLDeviceType( args: UpdateVTLDeviceTypeCommandInput, cb: (err: any, data?: UpdateVTLDeviceTypeCommandOutput) => void ): void; - public updateVTLDeviceType( + updateVTLDeviceType( args: UpdateVTLDeviceTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVTLDeviceTypeCommandOutput) => void ): void; - public updateVTLDeviceType( - args: UpdateVTLDeviceTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVTLDeviceTypeCommandOutput) => void), - cb?: (err: any, data?: UpdateVTLDeviceTypeCommandOutput) => void - ): Promise | void { - const command = new UpdateVTLDeviceTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Storage Gateway Service + * + *

Storage Gateway is the service that connects an on-premises software appliance + * with cloud-based storage to provide seamless and secure integration between an + * organization's on-premises IT environment and the Amazon Web Services storage + * infrastructure. The service enables you to securely upload data to the Amazon Web Services Cloud for cost effective backup and rapid disaster recovery.

+ * + *

Use the following links to get started using the Storage Gateway + * Service API Reference:

+ * + *
    + *
  • + *

    + * Storage Gateway required request headers: Describes the required + * headers that you must send with every POST request to Storage Gateway.

    + *
  • + *
  • + *

    + * Signing requests: Storage Gateway requires that you authenticate + * every request you send; this topic describes how sign such a request.

    + *
  • + *
  • + *

    + * Error responses: Provides reference information about Storage Gateway errors.

    + *
  • + *
  • + *

    + * Operations in Storage Gateway: Contains detailed descriptions of all Storage Gateway operations, their request parameters, response elements, possible errors, and + * examples of requests and responses.

    + *
  • + *
  • + *

    + * Storage Gateway + * endpoints and quotas: Provides a list of each Amazon Web Services Region + * and the endpoints available for use with Storage Gateway.

    + *
  • + *
+ * + * + *

Storage Gateway resource IDs are in uppercase. When you use these resource IDs + * with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change + * your resource ID to lowercase to use it with the EC2 API. For example, in Storage + * Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use + * this ID with the EC2 API, you must change it to vol-aa22bb012345daf670. + * Otherwise, the EC2 API might not behave as expected.

+ *
+ * + * + *

IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway + * volumes are changing to a longer format. Starting in December 2016, all new volumes and + * snapshots will be created with a 17-character string. Starting in April 2016, you will + * be able to use these longer IDs so you can test your systems with the new format. For + * more information, see Longer EC2 and + * EBS resource IDs.

+ * + *

For example, a volume Amazon Resource Name (ARN) with the longer volume ID format + * looks like the following:

+ * + *

+ * arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.

+ * + *

A snapshot ID with the longer ID format looks like the following: + * snap-78e226633445566ee.

+ * + *

For more information, see Announcement: + * Heads-up – Longer Storage Gateway volume and snapshot IDs coming in + * 2016.

+ *
+ */ +export class StorageGateway extends StorageGatewayClient implements StorageGateway {} +createAggregatedClient(commands, StorageGateway); diff --git a/clients/client-sts/src/STS.ts b/clients/client-sts/src/STS.ts index ab5bb1dbc9a8..20fcd95e7822 100644 --- a/clients/client-sts/src/STS.ts +++ b/clients/client-sts/src/STS.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { AssumeRoleCommand, AssumeRoleCommandInput, AssumeRoleCommandOutput } from "./commands/AssumeRoleCommand"; @@ -37,824 +38,155 @@ import { GetSessionTokenCommandInput, GetSessionTokenCommandOutput, } from "./commands/GetSessionTokenCommand"; -import { STSClient } from "./STSClient"; +import { STSClient, STSClientConfig } from "./STSClient"; -/** - * @public - * Security Token Service - *

Security Token Service (STS) enables you to request temporary, limited-privilege - * credentials for Identity and Access Management (IAM) users or for users that you - * authenticate (federated users). This guide provides descriptions of the STS API. For - * more information about using this service, see Temporary Security Credentials.

- */ -export class STS extends STSClient { +const commands = { + AssumeRoleCommand, + AssumeRoleWithSAMLCommand, + AssumeRoleWithWebIdentityCommand, + DecodeAuthorizationMessageCommand, + GetAccessKeyInfoCommand, + GetCallerIdentityCommand, + GetFederationTokenCommand, + GetSessionTokenCommand, +}; + +export interface STS { /** - * @public - *

Returns a set of temporary security credentials that you can use to access Amazon Web Services - * resources. These temporary credentials consist of an access key ID, a secret access key, - * and a security token. Typically, you use AssumeRole within your account or for - * cross-account access. For a comparison of AssumeRole with other API operations - * that produce temporary credentials, see Requesting Temporary Security - * Credentials and Comparing the - * Amazon Web Services STS API operations in the IAM User Guide.

- *

- * Permissions - *

- *

The temporary security credentials created by AssumeRole can be used to - * make API calls to any Amazon Web Services service with the following exception: You cannot call the - * Amazon Web Services STS GetFederationToken or GetSessionToken API - * operations.

- *

(Optional) You can pass inline or managed session policies to - * this operation. You can pass a single JSON policy document to use as an inline session - * policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as - * managed session policies. The plaintext that you use for both inline and managed session - * policies can't exceed 2,048 characters. Passing policies to this operation returns new - * temporary credentials. The resulting session's permissions are the intersection of the - * role's identity-based policy and the session policies. You can use the role's temporary - * credentials in subsequent Amazon Web Services API calls to access resources in the account that owns - * the role. You cannot use session policies to grant more permissions than those allowed - * by the identity-based policy of the role that is being assumed. For more information, see - * Session - * Policies in the IAM User Guide.

- *

When you create a role, you create two policies: A role trust policy that specifies - * who can assume the role and a permissions policy that specifies - * what can be done with the role. You specify the trusted principal - * who is allowed to assume the role in the role trust policy.

- *

To assume a role from a different account, your Amazon Web Services account must be trusted by the - * role. The trust relationship is defined in the role's trust policy when the role is - * created. That trust policy states which accounts are allowed to delegate that access to - * users in the account.

- *

A user who wants to access a role in a different account must also have permissions that - * are delegated from the user account administrator. The administrator must attach a policy - * that allows the user to call AssumeRole for the ARN of the role in the other - * account.

- *

To allow a user to assume a role in the same account, you can do either of the - * following:

- *
    - *
  • - *

    Attach a policy to the user that allows the user to call AssumeRole - * (as long as the role's trust policy trusts the account).

    - *
  • - *
  • - *

    Add the user as a principal directly in the role's trust policy.

    - *
  • - *
- *

You can do either because the role’s trust policy acts as an IAM resource-based - * policy. When a resource-based policy grants access to a principal in the same account, no - * additional identity-based policy is required. For more information about trust policies and - * resource-based policies, see IAM Policies in the - * IAM User Guide.

- *

- * Tags - *

- *

(Optional) You can pass tag key-value pairs to your session. These tags are called - * session tags. For more information about session tags, see Passing Session Tags in STS in the - * IAM User Guide.

- *

An administrator must grant you the permissions necessary to pass session tags. The - * administrator can also create granular permissions to allow you to pass only specific - * session tags. For more information, see Tutorial: Using Tags - * for Attribute-Based Access Control in the - * IAM User Guide.

- *

You can set the session tags as transitive. Transitive tags persist during role - * chaining. For more information, see Chaining Roles - * with Session Tags in the IAM User Guide.

- *

- * Using MFA with AssumeRole - *

- *

(Optional) You can include multi-factor authentication (MFA) information when you call - * AssumeRole. This is useful for cross-account scenarios to ensure that the - * user that assumes the role has been authenticated with an Amazon Web Services MFA device. In that - * scenario, the trust policy of the role being assumed includes a condition that tests for - * MFA authentication. If the caller does not include valid MFA information, the request to - * assume the role is denied. The condition in a trust policy that tests for MFA - * authentication might look like the following example.

- *

- * "Condition": \{"Bool": \{"aws:MultiFactorAuthPresent": true\}\} - *

- *

For more information, see Configuring MFA-Protected API Access - * in the IAM User Guide guide.

- *

To use MFA with AssumeRole, you pass values for the - * SerialNumber and TokenCode parameters. The - * SerialNumber value identifies the user's hardware or virtual MFA device. - * The TokenCode is the time-based one-time password (TOTP) that the MFA device - * produces.

+ * @see {@link AssumeRoleCommand} */ - public assumeRole(args: AssumeRoleCommandInput, options?: __HttpHandlerOptions): Promise; - public assumeRole(args: AssumeRoleCommandInput, cb: (err: any, data?: AssumeRoleCommandOutput) => void): void; - public assumeRole( + assumeRole(args: AssumeRoleCommandInput, options?: __HttpHandlerOptions): Promise; + assumeRole(args: AssumeRoleCommandInput, cb: (err: any, data?: AssumeRoleCommandOutput) => void): void; + assumeRole( args: AssumeRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssumeRoleCommandOutput) => void ): void; - public assumeRole( - args: AssumeRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssumeRoleCommandOutput) => void), - cb?: (err: any, data?: AssumeRoleCommandOutput) => void - ): Promise | void { - const command = new AssumeRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a set of temporary security credentials for users who have been authenticated - * via a SAML authentication response. This operation provides a mechanism for tying an - * enterprise identity store or directory to role-based Amazon Web Services access without user-specific - * credentials or configuration. For a comparison of AssumeRoleWithSAML with the - * other API operations that produce temporary credentials, see Requesting Temporary Security - * Credentials and Comparing the - * Amazon Web Services STS API operations in the IAM User Guide.

- *

The temporary security credentials returned by this operation consist of an access key - * ID, a secret access key, and a security token. Applications can use these temporary - * security credentials to sign calls to Amazon Web Services services.

- *

- * Session Duration - *

- *

By default, the temporary security credentials created by - * AssumeRoleWithSAML last for one hour. However, you can use the optional - * DurationSeconds parameter to specify the duration of your session. Your - * role session lasts for the duration that you specify, or until the time specified in the - * SAML authentication response's SessionNotOnOrAfter value, whichever is - * shorter. You can provide a DurationSeconds value from 900 seconds (15 minutes) - * up to the maximum session duration setting for the role. This setting can have a value from - * 1 hour to 12 hours. To learn how to view the maximum value for your role, see View the - * Maximum Session Duration Setting for a Role in the - * IAM User Guide. The maximum session duration limit applies when - * you use the AssumeRole* API operations or the assume-role* CLI - * commands. However the limit does not apply when you use those operations to create a - * console URL. For more information, see Using IAM Roles in the - * IAM User Guide.

- * - *

- * Role chaining limits your CLI or Amazon Web Services API role - * session to a maximum of one hour. When you use the AssumeRole API operation - * to assume a role, you can specify the duration of your role session with the - * DurationSeconds parameter. You can specify a parameter value of up to - * 43200 seconds (12 hours), depending on the maximum session duration setting for your - * role. However, if you assume a role using role chaining and provide a - * DurationSeconds parameter value greater than one hour, the operation - * fails.

- *
- *

- * Permissions - *

- *

The temporary security credentials created by AssumeRoleWithSAML can be - * used to make API calls to any Amazon Web Services service with the following exception: you cannot call - * the STS GetFederationToken or GetSessionToken API - * operations.

- *

(Optional) You can pass inline or managed session policies to - * this operation. You can pass a single JSON policy document to use as an inline session - * policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as - * managed session policies. The plaintext that you use for both inline and managed session - * policies can't exceed 2,048 characters. Passing policies to this operation returns new - * temporary credentials. The resulting session's permissions are the intersection of the - * role's identity-based policy and the session policies. You can use the role's temporary - * credentials in subsequent Amazon Web Services API calls to access resources in the account that owns - * the role. You cannot use session policies to grant more permissions than those allowed - * by the identity-based policy of the role that is being assumed. For more information, see - * Session - * Policies in the IAM User Guide.

- *

Calling AssumeRoleWithSAML does not require the use of Amazon Web Services security - * credentials. The identity of the caller is validated by using keys in the metadata document - * that is uploaded for the SAML provider entity for your identity provider.

- * - *

Calling AssumeRoleWithSAML can result in an entry in your CloudTrail logs. - * The entry includes the value in the NameID element of the SAML assertion. - * We recommend that you use a NameIDType that is not associated with any - * personally identifiable information (PII). For example, you could instead use the - * persistent identifier - * (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent).

- *
- *

- * Tags - *

- *

(Optional) You can configure your IdP to pass attributes into your SAML assertion as - * session tags. Each session tag consists of a key name and an associated value. For more - * information about session tags, see Passing Session Tags in STS in the - * IAM User Guide.

- *

You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 - * characters and the values can’t exceed 256 characters. For these and additional limits, see - * IAM - * and STS Character Limits in the IAM User Guide.

- * - *

An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, - * and session tags into a packed binary format that has a separate limit. Your request can - * fail for this limit even if your plaintext meets the other requirements. The - * PackedPolicySize response element indicates by percentage how close the - * policies and tags for your request are to the upper size limit.

- *
- *

You can pass a session tag with the same key as a tag that is attached to the role. When - * you do, session tags override the role's tags with the same key.

- *

An administrator must grant you the permissions necessary to pass session tags. The - * administrator can also create granular permissions to allow you to pass only specific - * session tags. For more information, see Tutorial: Using Tags - * for Attribute-Based Access Control in the - * IAM User Guide.

- *

You can set the session tags as transitive. Transitive tags persist during role - * chaining. For more information, see Chaining Roles - * with Session Tags in the IAM User Guide.

- *

- * SAML Configuration - *

- *

Before your application can call AssumeRoleWithSAML, you must configure - * your SAML identity provider (IdP) to issue the claims required by Amazon Web Services. Additionally, you - * must use Identity and Access Management (IAM) to create a SAML provider entity in your Amazon Web Services account that - * represents your identity provider. You must also create an IAM role that specifies this - * SAML provider in its trust policy.

- *

For more information, see the following resources:

- * + * @see {@link AssumeRoleWithSAMLCommand} */ - public assumeRoleWithSAML( + assumeRoleWithSAML( args: AssumeRoleWithSAMLCommandInput, options?: __HttpHandlerOptions ): Promise; - public assumeRoleWithSAML( + assumeRoleWithSAML( args: AssumeRoleWithSAMLCommandInput, cb: (err: any, data?: AssumeRoleWithSAMLCommandOutput) => void ): void; - public assumeRoleWithSAML( + assumeRoleWithSAML( args: AssumeRoleWithSAMLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssumeRoleWithSAMLCommandOutput) => void ): void; - public assumeRoleWithSAML( - args: AssumeRoleWithSAMLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssumeRoleWithSAMLCommandOutput) => void), - cb?: (err: any, data?: AssumeRoleWithSAMLCommandOutput) => void - ): Promise | void { - const command = new AssumeRoleWithSAMLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a set of temporary security credentials for users who have been authenticated in - * a mobile or web application with a web identity provider. Example providers include the - * OAuth 2.0 providers Login with Amazon and Facebook, or any OpenID Connect-compatible - * identity provider such as Google or Amazon Cognito federated identities.

- * - *

For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the - * Amazon Web Services SDK for iOS Developer Guide and the Amazon Web Services SDK for Android Developer Guide to uniquely - * identify a user. You can also supply the user with a consistent identity throughout the - * lifetime of an application.

- *

To learn more about Amazon Cognito, see Amazon Cognito Overview in - * Amazon Web Services SDK for Android Developer Guide and Amazon Cognito Overview in the - * Amazon Web Services SDK for iOS Developer Guide.

- *
- *

Calling AssumeRoleWithWebIdentity does not require the use of Amazon Web Services - * security credentials. Therefore, you can distribute an application (for example, on mobile - * devices) that requests temporary security credentials without including long-term Amazon Web Services - * credentials in the application. You also don't need to deploy server-based proxy services - * that use long-term Amazon Web Services credentials. Instead, the identity of the caller is validated by - * using a token from the web identity provider. For a comparison of - * AssumeRoleWithWebIdentity with the other API operations that produce - * temporary credentials, see Requesting Temporary Security - * Credentials and Comparing the - * Amazon Web Services STS API operations in the IAM User Guide.

- *

The temporary security credentials returned by this API consist of an access key ID, a - * secret access key, and a security token. Applications can use these temporary security - * credentials to sign calls to Amazon Web Services service API operations.

- *

- * Session Duration - *

- *

By default, the temporary security credentials created by - * AssumeRoleWithWebIdentity last for one hour. However, you can use the - * optional DurationSeconds parameter to specify the duration of your session. - * You can provide a value from 900 seconds (15 minutes) up to the maximum session duration - * setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how - * to view the maximum value for your role, see View the - * Maximum Session Duration Setting for a Role in the - * IAM User Guide. The maximum session duration limit applies when - * you use the AssumeRole* API operations or the assume-role* CLI - * commands. However the limit does not apply when you use those operations to create a - * console URL. For more information, see Using IAM Roles in the - * IAM User Guide.

- *

- * Permissions - *

- *

The temporary security credentials created by AssumeRoleWithWebIdentity can - * be used to make API calls to any Amazon Web Services service with the following exception: you cannot - * call the STS GetFederationToken or GetSessionToken API - * operations.

- *

(Optional) You can pass inline or managed session policies to - * this operation. You can pass a single JSON policy document to use as an inline session - * policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as - * managed session policies. The plaintext that you use for both inline and managed session - * policies can't exceed 2,048 characters. Passing policies to this operation returns new - * temporary credentials. The resulting session's permissions are the intersection of the - * role's identity-based policy and the session policies. You can use the role's temporary - * credentials in subsequent Amazon Web Services API calls to access resources in the account that owns - * the role. You cannot use session policies to grant more permissions than those allowed - * by the identity-based policy of the role that is being assumed. For more information, see - * Session - * Policies in the IAM User Guide.

- *

- * Tags - *

- *

(Optional) You can configure your IdP to pass attributes into your web identity token as - * session tags. Each session tag consists of a key name and an associated value. For more - * information about session tags, see Passing Session Tags in STS in the - * IAM User Guide.

- *

You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 - * characters and the values can’t exceed 256 characters. For these and additional limits, see - * IAM - * and STS Character Limits in the IAM User Guide.

- * - *

An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, - * and session tags into a packed binary format that has a separate limit. Your request can - * fail for this limit even if your plaintext meets the other requirements. The - * PackedPolicySize response element indicates by percentage how close the - * policies and tags for your request are to the upper size limit.

- *
- *

You can pass a session tag with the same key as a tag that is attached to the role. When - * you do, the session tag overrides the role tag with the same key.

- *

An administrator must grant you the permissions necessary to pass session tags. The - * administrator can also create granular permissions to allow you to pass only specific - * session tags. For more information, see Tutorial: Using Tags - * for Attribute-Based Access Control in the - * IAM User Guide.

- *

You can set the session tags as transitive. Transitive tags persist during role - * chaining. For more information, see Chaining Roles - * with Session Tags in the IAM User Guide.

- *

- * Identities - *

- *

Before your application can call AssumeRoleWithWebIdentity, you must have - * an identity token from a supported identity provider and create a role that the application - * can assume. The role that your application assumes must trust the identity provider that is - * associated with the identity token. In other words, the identity provider must be specified - * in the role's trust policy.

- * - *

Calling AssumeRoleWithWebIdentity can result in an entry in your - * CloudTrail logs. The entry includes the Subject of - * the provided web identity token. We recommend that you avoid using any personally - * identifiable information (PII) in this field. For example, you could instead use a GUID - * or a pairwise identifier, as suggested - * in the OIDC specification.

- *
- *

For more information about how to use web identity federation and the - * AssumeRoleWithWebIdentity API, see the following resources:

- * + * @see {@link AssumeRoleWithWebIdentityCommand} */ - public assumeRoleWithWebIdentity( + assumeRoleWithWebIdentity( args: AssumeRoleWithWebIdentityCommandInput, options?: __HttpHandlerOptions ): Promise; - public assumeRoleWithWebIdentity( + assumeRoleWithWebIdentity( args: AssumeRoleWithWebIdentityCommandInput, cb: (err: any, data?: AssumeRoleWithWebIdentityCommandOutput) => void ): void; - public assumeRoleWithWebIdentity( + assumeRoleWithWebIdentity( args: AssumeRoleWithWebIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssumeRoleWithWebIdentityCommandOutput) => void ): void; - public assumeRoleWithWebIdentity( - args: AssumeRoleWithWebIdentityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssumeRoleWithWebIdentityCommandOutput) => void), - cb?: (err: any, data?: AssumeRoleWithWebIdentityCommandOutput) => void - ): Promise | void { - const command = new AssumeRoleWithWebIdentityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Decodes additional information about the authorization status of a request from an - * encoded message returned in response to an Amazon Web Services request.

- *

For example, if a user is not authorized to perform an operation that he or she has - * requested, the request returns a Client.UnauthorizedOperation response (an - * HTTP 403 response). Some Amazon Web Services operations additionally return an encoded message that can - * provide details about this authorization failure.

- * - *

Only certain Amazon Web Services operations return an encoded authorization message. The - * documentation for an individual operation indicates whether that operation returns an - * encoded message in addition to returning an HTTP code.

- *
- *

The message is encoded because the details of the authorization status can contain - * privileged information that the user who requested the operation should not see. To decode - * an authorization status message, a user must be granted permissions through an IAM policy to - * request the DecodeAuthorizationMessage - * (sts:DecodeAuthorizationMessage) action.

- *

The decoded message includes the following type of information:

- *
    - *
  • - *

    Whether the request was denied due to an explicit deny or due to the absence of an - * explicit allow. For more information, see Determining Whether a Request is Allowed or Denied in the - * IAM User Guide.

    - *
  • - *
  • - *

    The principal who made the request.

    - *
  • - *
  • - *

    The requested action.

    - *
  • - *
  • - *

    The requested resource.

    - *
  • - *
  • - *

    The values of condition keys in the context of the user's request.

    - *
  • - *
+ * @see {@link DecodeAuthorizationMessageCommand} */ - public decodeAuthorizationMessage( + decodeAuthorizationMessage( args: DecodeAuthorizationMessageCommandInput, options?: __HttpHandlerOptions ): Promise; - public decodeAuthorizationMessage( + decodeAuthorizationMessage( args: DecodeAuthorizationMessageCommandInput, cb: (err: any, data?: DecodeAuthorizationMessageCommandOutput) => void ): void; - public decodeAuthorizationMessage( + decodeAuthorizationMessage( args: DecodeAuthorizationMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DecodeAuthorizationMessageCommandOutput) => void ): void; - public decodeAuthorizationMessage( - args: DecodeAuthorizationMessageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DecodeAuthorizationMessageCommandOutput) => void), - cb?: (err: any, data?: DecodeAuthorizationMessageCommandOutput) => void - ): Promise | void { - const command = new DecodeAuthorizationMessageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the account identifier for the specified access key ID.

- *

Access keys consist of two parts: an access key ID (for example, - * AKIAIOSFODNN7EXAMPLE) and a secret access key (for example, - * wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). For more information about - * access keys, see Managing Access Keys for IAM - * Users in the IAM User Guide.

- *

When you pass an access key ID to this operation, it returns the ID of the Amazon Web Services account - * to which the keys belong. Access key IDs beginning with AKIA are long-term - * credentials for an IAM user or the Amazon Web Services account root user. Access key IDs beginning with - * ASIA are temporary credentials that are created using STS operations. If - * the account in the response belongs to you, you can sign in as the root user and review - * your root user access keys. Then, you can pull a credentials report to - * learn which IAM user owns the keys. To learn who requested the temporary credentials for - * an ASIA access key, view the STS events in your CloudTrail logs in the - * IAM User Guide.

- *

This operation does not indicate the state of the access key. The key might be active, - * inactive, or deleted. Active keys might not have permissions to perform an operation. - * Providing a deleted access key might return an error that the key doesn't exist.

+ * @see {@link GetAccessKeyInfoCommand} */ - public getAccessKeyInfo( + getAccessKeyInfo( args: GetAccessKeyInfoCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccessKeyInfo( + getAccessKeyInfo( args: GetAccessKeyInfoCommandInput, cb: (err: any, data?: GetAccessKeyInfoCommandOutput) => void ): void; - public getAccessKeyInfo( + getAccessKeyInfo( args: GetAccessKeyInfoCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessKeyInfoCommandOutput) => void ): void; - public getAccessKeyInfo( - args: GetAccessKeyInfoCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccessKeyInfoCommandOutput) => void), - cb?: (err: any, data?: GetAccessKeyInfoCommandOutput) => void - ): Promise | void { - const command = new GetAccessKeyInfoCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns details about the IAM user or role whose credentials are used to call the - * operation.

- * - *

No permissions are required to perform this operation. If an administrator adds a - * policy to your IAM user or role that explicitly denies access to the - * sts:GetCallerIdentity action, you can still perform this operation. - * Permissions are not required because the same information is returned when an IAM user - * or role is denied access. To view an example response, see I Am Not Authorized to Perform: iam:DeleteVirtualMFADevice in the - * IAM User Guide.

- *
+ * @see {@link GetCallerIdentityCommand} */ - public getCallerIdentity( + getCallerIdentity( args: GetCallerIdentityCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCallerIdentity( + getCallerIdentity( args: GetCallerIdentityCommandInput, cb: (err: any, data?: GetCallerIdentityCommandOutput) => void ): void; - public getCallerIdentity( + getCallerIdentity( args: GetCallerIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCallerIdentityCommandOutput) => void ): void; - public getCallerIdentity( - args: GetCallerIdentityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCallerIdentityCommandOutput) => void), - cb?: (err: any, data?: GetCallerIdentityCommandOutput) => void - ): Promise | void { - const command = new GetCallerIdentityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a set of temporary security credentials (consisting of an access key ID, a - * secret access key, and a security token) for a federated user. A typical use is in a proxy - * application that gets temporary security credentials on behalf of distributed applications - * inside a corporate network. You must call the GetFederationToken operation - * using the long-term security credentials of an IAM user. As a result, this call is - * appropriate in contexts where those credentials can be safely stored, usually in a - * server-based application. For a comparison of GetFederationToken with the - * other API operations that produce temporary credentials, see Requesting Temporary Security - * Credentials and Comparing the - * Amazon Web Services STS API operations in the IAM User Guide.

- * - *

You can create a mobile-based or browser-based app that can authenticate users using - * a web identity provider like Login with Amazon, Facebook, Google, or an OpenID - * Connect-compatible identity provider. In this case, we recommend that you use Amazon Cognito or - * AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider in the - * IAM User Guide.

- *
- *

You can also call GetFederationToken using the security credentials of an - * Amazon Web Services account root user, but we do not recommend it. Instead, we recommend that you create - * an IAM user for the purpose of the proxy application. Then attach a policy to the IAM - * user that limits federated users to only the actions and resources that they need to - * access. For more information, see IAM Best Practices in the - * IAM User Guide.

- *

- * Session duration - *

- *

The temporary credentials are valid for the specified duration, from 900 seconds (15 - * minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration is - * 43,200 seconds (12 hours). Temporary credentials obtained by using the Amazon Web Services account root - * user credentials have a maximum duration of 3,600 seconds (1 hour).

- *

- * Permissions - *

- *

You can use the temporary credentials created by GetFederationToken in any - * Amazon Web Services service with the following exceptions:

- *
    - *
  • - *

    You cannot call any IAM operations using the CLI or the Amazon Web Services API. This limitation does not apply to console sessions.

    - *
  • - *
  • - *

    You cannot call any STS operations except GetCallerIdentity.

    - *
  • - *
- *

You can use temporary credentials for single sign-on (SSO) to the console.

- *

You must pass an inline or managed session policy to - * this operation. You can pass a single JSON policy document to use as an inline session - * policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as - * managed session policies. The plaintext that you use for both inline and managed session - * policies can't exceed 2,048 characters.

- *

Though the session policy parameters are optional, if you do not pass a policy, then the - * resulting federated user session has no permissions. When you pass session policies, the - * session permissions are the intersection of the IAM user policies and the session - * policies that you pass. This gives you a way to further restrict the permissions for a - * federated user. You cannot use session policies to grant more permissions than those that - * are defined in the permissions policy of the IAM user. For more information, see Session - * Policies in the IAM User Guide. For information about - * using GetFederationToken to create temporary security credentials, see GetFederationToken—Federation Through a Custom Identity Broker.

- *

You can use the credentials to access a resource that has a resource-based policy. If - * that policy specifically references the federated user session in the - * Principal element of the policy, the session has the permissions allowed by - * the policy. These permissions are granted in addition to the permissions granted by the - * session policies.

- *

- * Tags - *

- *

(Optional) You can pass tag key-value pairs to your session. These are called session - * tags. For more information about session tags, see Passing Session Tags in STS in the - * IAM User Guide.

- * - *

You can create a mobile-based or browser-based app that can authenticate users using - * a web identity provider like Login with Amazon, Facebook, Google, or an OpenID - * Connect-compatible identity provider. In this case, we recommend that you use Amazon Cognito or - * AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider in the - * IAM User Guide.

- *
- *

An administrator must grant you the permissions necessary to pass session tags. The - * administrator can also create granular permissions to allow you to pass only specific - * session tags. For more information, see Tutorial: Using Tags - * for Attribute-Based Access Control in the - * IAM User Guide.

- *

Tag key–value pairs are not case sensitive, but case is preserved. This means that you - * cannot have separate Department and department tag keys. Assume - * that the user that you are federating has the - * Department=Marketing tag and you pass the - * department=engineering session tag. Department - * and department are not saved as separate tags, and the session tag passed in - * the request takes precedence over the user tag.

+ * @see {@link GetFederationTokenCommand} */ - public getFederationToken( + getFederationToken( args: GetFederationTokenCommandInput, options?: __HttpHandlerOptions ): Promise; - public getFederationToken( + getFederationToken( args: GetFederationTokenCommandInput, cb: (err: any, data?: GetFederationTokenCommandOutput) => void ): void; - public getFederationToken( + getFederationToken( args: GetFederationTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFederationTokenCommandOutput) => void ): void; - public getFederationToken( - args: GetFederationTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFederationTokenCommandOutput) => void), - cb?: (err: any, data?: GetFederationTokenCommandOutput) => void - ): Promise | void { - const command = new GetFederationTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a set of temporary credentials for an Amazon Web Services account or IAM user. The - * credentials consist of an access key ID, a secret access key, and a security token. - * Typically, you use GetSessionToken if you want to use MFA to protect - * programmatic calls to specific Amazon Web Services API operations like Amazon EC2 StopInstances. - * MFA-enabled IAM users would need to call GetSessionToken and submit an MFA - * code that is associated with their MFA device. Using the temporary security credentials - * that are returned from the call, IAM users can then make programmatic calls to API - * operations that require MFA authentication. If you do not supply a correct MFA code, then - * the API returns an access denied error. For a comparison of GetSessionToken - * with the other API operations that produce temporary credentials, see Requesting - * Temporary Security Credentials and Comparing the - * Amazon Web Services STS API operations in the IAM User Guide.

- * - *

No permissions are required for users to perform this operation. The purpose of the - * sts:GetSessionToken operation is to authenticate the user using MFA. You - * cannot use policies to control authentication operations. For more information, see - * Permissions for GetSessionToken in the - * IAM User Guide.

- *
- *

- * Session Duration - *

- *

The GetSessionToken operation must be called by using the long-term Amazon Web Services - * security credentials of the Amazon Web Services account root user or an IAM user. Credentials that are - * created by IAM users are valid for the duration that you specify. This duration can range - * from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), with a default - * of 43,200 seconds (12 hours). Credentials based on account credentials can range from 900 - * seconds (15 minutes) up to 3,600 seconds (1 hour), with a default of 1 hour.

- *

- * Permissions - *

- *

The temporary security credentials created by GetSessionToken can be used - * to make API calls to any Amazon Web Services service with the following exceptions:

- *
    - *
  • - *

    You cannot call any IAM API operations unless MFA authentication information is - * included in the request.

    - *
  • - *
  • - *

    You cannot call any STS API except - * AssumeRole or GetCallerIdentity.

    - *
  • - *
- * - *

We recommend that you do not call GetSessionToken with Amazon Web Services account - * root user credentials. Instead, follow our best practices by - * creating one or more IAM users, giving them the necessary permissions, and using IAM - * users for everyday interaction with Amazon Web Services.

- *
- *

The credentials that are returned by GetSessionToken are based on - * permissions associated with the user whose credentials were used to call the operation. If - * GetSessionToken is called using Amazon Web Services account root user credentials, the - * temporary credentials have root user permissions. Similarly, if - * GetSessionToken is called using the credentials of an IAM user, the - * temporary credentials have the same permissions as the IAM user.

- *

For more information about using GetSessionToken to create temporary - * credentials, go to Temporary - * Credentials for Users in Untrusted Environments in the - * IAM User Guide.

+ * @see {@link GetSessionTokenCommand} */ - public getSessionToken( + getSessionToken( args: GetSessionTokenCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSessionToken( - args: GetSessionTokenCommandInput, - cb: (err: any, data?: GetSessionTokenCommandOutput) => void - ): void; - public getSessionToken( + getSessionToken(args: GetSessionTokenCommandInput, cb: (err: any, data?: GetSessionTokenCommandOutput) => void): void; + getSessionToken( args: GetSessionTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSessionTokenCommandOutput) => void ): void; - public getSessionToken( - args: GetSessionTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSessionTokenCommandOutput) => void), - cb?: (err: any, data?: GetSessionTokenCommandOutput) => void - ): Promise | void { - const command = new GetSessionTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Security Token Service + *

Security Token Service (STS) enables you to request temporary, limited-privilege + * credentials for Identity and Access Management (IAM) users or for users that you + * authenticate (federated users). This guide provides descriptions of the STS API. For + * more information about using this service, see Temporary Security Credentials.

+ */ +export class STS extends STSClient implements STS {} +createAggregatedClient(commands, STS); diff --git a/clients/client-support-app/src/SupportApp.ts b/clients/client-support-app/src/SupportApp.ts index 86127ec056d0..7323d1ada9c8 100644 --- a/clients/client-support-app/src/SupportApp.ts +++ b/clients/client-support-app/src/SupportApp.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -51,450 +52,243 @@ import { UpdateSlackChannelConfigurationCommandInput, UpdateSlackChannelConfigurationCommandOutput, } from "./commands/UpdateSlackChannelConfigurationCommand"; -import { SupportAppClient } from "./SupportAppClient"; +import { SupportAppClient, SupportAppClientConfig } from "./SupportAppClient"; -/** - * @public - * Amazon Web Services Support App in Slack - *

You can use the Amazon Web Services Support App in Slack API to manage your support cases in Slack for your - * Amazon Web Services account. After you configure your Slack workspace and channel with the Amazon Web Services Support App, you can - * perform the following tasks directly in your Slack channel:

- *
    - *
  • - *

    Create, search, update, and resolve your support cases

    - *
  • - *
  • - *

    Request service quota increases for your account

    - *
  • - *
  • - *

    Invite Amazon Web Services Support agents to your channel so that you can chat directly about your - * support cases

    - *
  • - *
- *

For more information about how to perform these actions in Slack, see the following - * documentation in the Amazon Web Services Support User Guide:

- * - *

You can also use the Amazon Web Services Management Console instead of the Amazon Web Services Support App API to manage your Slack - * configurations. For more information, see Authorize a - * Slack workspace to enable the Amazon Web Services Support App.

- * - *
    - *
  • - *

    You must have a Business or Enterprise Support plan to use the Amazon Web Services Support App API.

    - *
  • - *
  • - *

    For more information about the Amazon Web Services Support App endpoints, see the Amazon Web Services Support App in Slack endpoints in the Amazon Web Services General - * Reference.

    - *
  • - *
- *
- */ -export class SupportApp extends SupportAppClient { +const commands = { + CreateSlackChannelConfigurationCommand, + DeleteAccountAliasCommand, + DeleteSlackChannelConfigurationCommand, + DeleteSlackWorkspaceConfigurationCommand, + GetAccountAliasCommand, + ListSlackChannelConfigurationsCommand, + ListSlackWorkspaceConfigurationsCommand, + PutAccountAliasCommand, + RegisterSlackWorkspaceForOrganizationCommand, + UpdateSlackChannelConfigurationCommand, +}; + +export interface SupportApp { /** - * @public - *

Creates a Slack channel configuration for your Amazon Web Services account.

- * - *
    - *
  • - *

    You can add up to 5 Slack workspaces for your account.

    - *
  • - *
  • - *

    You can add up to 20 Slack channels for your account.

    - *
  • - *
- *
- *

A Slack channel can have up to 100 Amazon Web Services accounts. This means that only 100 accounts can - * add the same Slack channel to the Amazon Web Services Support App. We recommend that you only add the accounts that - * you need to manage support cases for your organization. This can reduce the notifications - * about case updates that you receive in the Slack channel.

- * - *

We recommend that you choose a private Slack channel so that only members in that - * channel have read and write access to your support cases. Anyone in your Slack channel can - * create, update, or resolve support cases for your account. Users require an invitation to - * join private channels.

- *
+ * @see {@link CreateSlackChannelConfigurationCommand} */ - public createSlackChannelConfiguration( + createSlackChannelConfiguration( args: CreateSlackChannelConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSlackChannelConfiguration( + createSlackChannelConfiguration( args: CreateSlackChannelConfigurationCommandInput, cb: (err: any, data?: CreateSlackChannelConfigurationCommandOutput) => void ): void; - public createSlackChannelConfiguration( + createSlackChannelConfiguration( args: CreateSlackChannelConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSlackChannelConfigurationCommandOutput) => void ): void; - public createSlackChannelConfiguration( - args: CreateSlackChannelConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSlackChannelConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateSlackChannelConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateSlackChannelConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an alias for an Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the - * Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.

+ * @see {@link DeleteAccountAliasCommand} */ - public deleteAccountAlias( + deleteAccountAlias( args: DeleteAccountAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAccountAlias( + deleteAccountAlias( args: DeleteAccountAliasCommandInput, cb: (err: any, data?: DeleteAccountAliasCommandOutput) => void ): void; - public deleteAccountAlias( + deleteAccountAlias( args: DeleteAccountAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccountAliasCommandOutput) => void ): void; - public deleteAccountAlias( - args: DeleteAccountAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAccountAliasCommandOutput) => void), - cb?: (err: any, data?: DeleteAccountAliasCommandOutput) => void - ): Promise | void { - const command = new DeleteAccountAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Slack channel configuration from your Amazon Web Services account. This operation doesn't - * delete your Slack channel.

+ * @see {@link DeleteSlackChannelConfigurationCommand} */ - public deleteSlackChannelConfiguration( + deleteSlackChannelConfiguration( args: DeleteSlackChannelConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSlackChannelConfiguration( + deleteSlackChannelConfiguration( args: DeleteSlackChannelConfigurationCommandInput, cb: (err: any, data?: DeleteSlackChannelConfigurationCommandOutput) => void ): void; - public deleteSlackChannelConfiguration( + deleteSlackChannelConfiguration( args: DeleteSlackChannelConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSlackChannelConfigurationCommandOutput) => void ): void; - public deleteSlackChannelConfiguration( - args: DeleteSlackChannelConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSlackChannelConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteSlackChannelConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteSlackChannelConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Slack workspace configuration from your Amazon Web Services account. This operation doesn't - * delete your Slack workspace.

+ * @see {@link DeleteSlackWorkspaceConfigurationCommand} */ - public deleteSlackWorkspaceConfiguration( + deleteSlackWorkspaceConfiguration( args: DeleteSlackWorkspaceConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSlackWorkspaceConfiguration( + deleteSlackWorkspaceConfiguration( args: DeleteSlackWorkspaceConfigurationCommandInput, cb: (err: any, data?: DeleteSlackWorkspaceConfigurationCommandOutput) => void ): void; - public deleteSlackWorkspaceConfiguration( + deleteSlackWorkspaceConfiguration( args: DeleteSlackWorkspaceConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSlackWorkspaceConfigurationCommandOutput) => void ): void; - public deleteSlackWorkspaceConfiguration( - args: DeleteSlackWorkspaceConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSlackWorkspaceConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteSlackWorkspaceConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteSlackWorkspaceConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the alias from an Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of - * the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.

+ * @see {@link GetAccountAliasCommand} */ - public getAccountAlias( + getAccountAlias( args: GetAccountAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccountAlias( - args: GetAccountAliasCommandInput, - cb: (err: any, data?: GetAccountAliasCommandOutput) => void - ): void; - public getAccountAlias( + getAccountAlias(args: GetAccountAliasCommandInput, cb: (err: any, data?: GetAccountAliasCommandOutput) => void): void; + getAccountAlias( args: GetAccountAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountAliasCommandOutput) => void ): void; - public getAccountAlias( - args: GetAccountAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccountAliasCommandOutput) => void), - cb?: (err: any, data?: GetAccountAliasCommandOutput) => void - ): Promise | void { - const command = new GetAccountAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the Slack channel configurations for an Amazon Web Services account.

+ * @see {@link ListSlackChannelConfigurationsCommand} */ - public listSlackChannelConfigurations( + listSlackChannelConfigurations( args: ListSlackChannelConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSlackChannelConfigurations( + listSlackChannelConfigurations( args: ListSlackChannelConfigurationsCommandInput, cb: (err: any, data?: ListSlackChannelConfigurationsCommandOutput) => void ): void; - public listSlackChannelConfigurations( + listSlackChannelConfigurations( args: ListSlackChannelConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSlackChannelConfigurationsCommandOutput) => void ): void; - public listSlackChannelConfigurations( - args: ListSlackChannelConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSlackChannelConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListSlackChannelConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListSlackChannelConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the Slack workspace configurations for an Amazon Web Services account.

+ * @see {@link ListSlackWorkspaceConfigurationsCommand} */ - public listSlackWorkspaceConfigurations( + listSlackWorkspaceConfigurations( args: ListSlackWorkspaceConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSlackWorkspaceConfigurations( + listSlackWorkspaceConfigurations( args: ListSlackWorkspaceConfigurationsCommandInput, cb: (err: any, data?: ListSlackWorkspaceConfigurationsCommandOutput) => void ): void; - public listSlackWorkspaceConfigurations( + listSlackWorkspaceConfigurations( args: ListSlackWorkspaceConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSlackWorkspaceConfigurationsCommandOutput) => void ): void; - public listSlackWorkspaceConfigurations( - args: ListSlackWorkspaceConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSlackWorkspaceConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListSlackWorkspaceConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListSlackWorkspaceConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates an individual alias for each Amazon Web Services account ID. The alias appears in the - * Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the - * Amazon Web Services Support App.

+ * @see {@link PutAccountAliasCommand} */ - public putAccountAlias( + putAccountAlias( args: PutAccountAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAccountAlias( - args: PutAccountAliasCommandInput, - cb: (err: any, data?: PutAccountAliasCommandOutput) => void - ): void; - public putAccountAlias( + putAccountAlias(args: PutAccountAliasCommandInput, cb: (err: any, data?: PutAccountAliasCommandOutput) => void): void; + putAccountAlias( args: PutAccountAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccountAliasCommandOutput) => void ): void; - public putAccountAlias( - args: PutAccountAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAccountAliasCommandOutput) => void), - cb?: (err: any, data?: PutAccountAliasCommandOutput) => void - ): Promise | void { - const command = new PutAccountAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers a Slack workspace for your Amazon Web Services account. To call this API, your account must be - * part of an organization in Organizations.

- *

If you're the management account and you want to register Slack - * workspaces for your organization, you must complete the following tasks:

- *
    - *
  1. - *

    Sign in to the Amazon Web Services Support Center and - * authorize the Slack workspaces where you want your organization to have access to. See - * Authorize a Slack workspace in the Amazon Web Services Support User - * Guide.

    - *
  2. - *
  3. - *

    Call the RegisterSlackWorkspaceForOrganization API to authorize each - * Slack workspace for the organization.

    - *
  4. - *
- *

After the management account authorizes the Slack workspace, member accounts can call this - * API to authorize the same Slack workspace for their individual accounts. Member accounts don't - * need to authorize the Slack workspace manually through the Amazon Web Services Support Center.

- *

To use the Amazon Web Services Support App, each account must then complete the following tasks:

- * + * @see {@link RegisterSlackWorkspaceForOrganizationCommand} */ - public registerSlackWorkspaceForOrganization( + registerSlackWorkspaceForOrganization( args: RegisterSlackWorkspaceForOrganizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerSlackWorkspaceForOrganization( + registerSlackWorkspaceForOrganization( args: RegisterSlackWorkspaceForOrganizationCommandInput, cb: (err: any, data?: RegisterSlackWorkspaceForOrganizationCommandOutput) => void ): void; - public registerSlackWorkspaceForOrganization( + registerSlackWorkspaceForOrganization( args: RegisterSlackWorkspaceForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterSlackWorkspaceForOrganizationCommandOutput) => void ): void; - public registerSlackWorkspaceForOrganization( - args: RegisterSlackWorkspaceForOrganizationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: RegisterSlackWorkspaceForOrganizationCommandOutput) => void), - cb?: (err: any, data?: RegisterSlackWorkspaceForOrganizationCommandOutput) => void - ): Promise | void { - const command = new RegisterSlackWorkspaceForOrganizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the configuration for a Slack channel, such as case update notifications.

+ * @see {@link UpdateSlackChannelConfigurationCommand} */ - public updateSlackChannelConfiguration( + updateSlackChannelConfiguration( args: UpdateSlackChannelConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSlackChannelConfiguration( + updateSlackChannelConfiguration( args: UpdateSlackChannelConfigurationCommandInput, cb: (err: any, data?: UpdateSlackChannelConfigurationCommandOutput) => void ): void; - public updateSlackChannelConfiguration( + updateSlackChannelConfiguration( args: UpdateSlackChannelConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSlackChannelConfigurationCommandOutput) => void ): void; - public updateSlackChannelConfiguration( - args: UpdateSlackChannelConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSlackChannelConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateSlackChannelConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateSlackChannelConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Web Services Support App in Slack + *

You can use the Amazon Web Services Support App in Slack API to manage your support cases in Slack for your + * Amazon Web Services account. After you configure your Slack workspace and channel with the Amazon Web Services Support App, you can + * perform the following tasks directly in your Slack channel:

+ *
    + *
  • + *

    Create, search, update, and resolve your support cases

    + *
  • + *
  • + *

    Request service quota increases for your account

    + *
  • + *
  • + *

    Invite Amazon Web Services Support agents to your channel so that you can chat directly about your + * support cases

    + *
  • + *
+ *

For more information about how to perform these actions in Slack, see the following + * documentation in the Amazon Web Services Support User Guide:

+ * + *

You can also use the Amazon Web Services Management Console instead of the Amazon Web Services Support App API to manage your Slack + * configurations. For more information, see Authorize a + * Slack workspace to enable the Amazon Web Services Support App.

+ * + *
    + *
  • + *

    You must have a Business or Enterprise Support plan to use the Amazon Web Services Support App API.

    + *
  • + *
  • + *

    For more information about the Amazon Web Services Support App endpoints, see the Amazon Web Services Support App in Slack endpoints in the Amazon Web Services General + * Reference.

    + *
  • + *
+ *
+ */ +export class SupportApp extends SupportAppClient implements SupportApp {} +createAggregatedClient(commands, SupportApp); diff --git a/clients/client-support/src/Support.ts b/clients/client-support/src/Support.ts index 79efbd974cde..090eb75c3aea 100644 --- a/clients/client-support/src/Support.ts +++ b/clients/client-support/src/Support.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -63,848 +64,293 @@ import { RefreshTrustedAdvisorCheckCommandOutput, } from "./commands/RefreshTrustedAdvisorCheckCommand"; import { ResolveCaseCommand, ResolveCaseCommandInput, ResolveCaseCommandOutput } from "./commands/ResolveCaseCommand"; -import { SupportClient } from "./SupportClient"; +import { SupportClient, SupportClientConfig } from "./SupportClient"; -/** - * @public - * Amazon Web Services Support - *

The Amazon Web Services Support API Reference is intended for programmers who need detailed - * information about the Amazon Web Services Support operations and data types. You can use the API to manage - * your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return - * results in JSON format.

- * - *
    - *
  • - *

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support - * API.

    - *
  • - *
  • - *

    If you call the Amazon Web Services Support API from an account that doesn't have a - * Business, Enterprise On-Ramp, or Enterprise Support plan, the - * SubscriptionRequiredException error message appears. For - * information about changing your support plan, see Amazon Web Services Support.

    - *
  • - *
- *
- *

You can also use the Amazon Web Services Support API to access features for Trusted Advisor. You can return a list of - * checks and their descriptions, get check results, specify checks to refresh, and get the - * refresh status of checks.

- *

You can manage your support cases with the following Amazon Web Services Support API operations:

- * - *

You can also use the Amazon Web Services Support API to call the Trusted Advisor operations. For more - * information, see Trusted Advisor in the - * Amazon Web Services Support User Guide.

- *

For authentication of requests, Amazon Web Services Support uses Signature Version 4 Signing - * Process.

- *

For more information about this service and the endpoints to use, see About the - * Amazon Web Services Support API in the Amazon Web Services Support User Guide.

- */ -export class Support extends SupportClient { +const commands = { + AddAttachmentsToSetCommand, + AddCommunicationToCaseCommand, + CreateCaseCommand, + DescribeAttachmentCommand, + DescribeCasesCommand, + DescribeCommunicationsCommand, + DescribeServicesCommand, + DescribeSeverityLevelsCommand, + DescribeTrustedAdvisorCheckRefreshStatusesCommand, + DescribeTrustedAdvisorCheckResultCommand, + DescribeTrustedAdvisorChecksCommand, + DescribeTrustedAdvisorCheckSummariesCommand, + RefreshTrustedAdvisorCheckCommand, + ResolveCaseCommand, +}; + +export interface Support { /** - * @public - *

Adds one or more attachments to an attachment set.

- *

An attachment set is a temporary container for attachments that you add to a case or - * case communication. The set is available for 1 hour after it's created. The - * expiryTime returned in the response is when the set expires.

- * - *
    - *
  • - *

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support - * API.

    - *
  • - *
  • - *

    If you call the Amazon Web Services Support API from an account that doesn't have a - * Business, Enterprise On-Ramp, or Enterprise Support plan, the - * SubscriptionRequiredException error message appears. For - * information about changing your support plan, see Amazon Web Services Support.

    - *
  • - *
- *
+ * @see {@link AddAttachmentsToSetCommand} */ - public addAttachmentsToSet( + addAttachmentsToSet( args: AddAttachmentsToSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public addAttachmentsToSet( + addAttachmentsToSet( args: AddAttachmentsToSetCommandInput, cb: (err: any, data?: AddAttachmentsToSetCommandOutput) => void ): void; - public addAttachmentsToSet( + addAttachmentsToSet( args: AddAttachmentsToSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddAttachmentsToSetCommandOutput) => void ): void; - public addAttachmentsToSet( - args: AddAttachmentsToSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddAttachmentsToSetCommandOutput) => void), - cb?: (err: any, data?: AddAttachmentsToSetCommandOutput) => void - ): Promise | void { - const command = new AddAttachmentsToSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds additional customer communication to an Amazon Web Services Support case. Use the caseId - * parameter to identify the case to which to add communication. You can list a set of - * email addresses to copy on the communication by using the ccEmailAddresses - * parameter. The communicationBody value contains the text of the - * communication.

- * - *
    - *
  • - *

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support - * API.

    - *
  • - *
  • - *

    If you call the Amazon Web Services Support API from an account that doesn't have a - * Business, Enterprise On-Ramp, or Enterprise Support plan, the - * SubscriptionRequiredException error message appears. For - * information about changing your support plan, see Amazon Web Services Support.

    - *
  • - *
- *
+ * @see {@link AddCommunicationToCaseCommand} */ - public addCommunicationToCase( + addCommunicationToCase( args: AddCommunicationToCaseCommandInput, options?: __HttpHandlerOptions ): Promise; - public addCommunicationToCase( + addCommunicationToCase( args: AddCommunicationToCaseCommandInput, cb: (err: any, data?: AddCommunicationToCaseCommandOutput) => void ): void; - public addCommunicationToCase( + addCommunicationToCase( args: AddCommunicationToCaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddCommunicationToCaseCommandOutput) => void ): void; - public addCommunicationToCase( - args: AddCommunicationToCaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddCommunicationToCaseCommandOutput) => void), - cb?: (err: any, data?: AddCommunicationToCaseCommandOutput) => void - ): Promise | void { - const command = new AddCommunicationToCaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case - * in the Amazon Web Services Support Center Create - * Case page.

- *

The Amazon Web Services Support API doesn't support requesting service limit increases. You can submit a - * service limit increase in the following ways:

- * - *

A successful CreateCase request returns an Amazon Web Services Support case number. You can use - * the DescribeCases operation and specify the case number to get - * existing Amazon Web Services Support cases. After you create a case, use the AddCommunicationToCase operation to add additional communication or - * attachments to an existing case.

- *

The caseId is separate from the displayId that appears in - * the Amazon Web Services Support Center. Use the DescribeCases operation to get the displayId.

- * - *
    - *
  • - *

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support - * API.

    - *
  • - *
  • - *

    If you call the Amazon Web Services Support API from an account that doesn't have a - * Business, Enterprise On-Ramp, or Enterprise Support plan, the - * SubscriptionRequiredException error message appears. For - * information about changing your support plan, see Amazon Web Services Support.

    - *
  • - *
- *
+ * @see {@link CreateCaseCommand} */ - public createCase(args: CreateCaseCommandInput, options?: __HttpHandlerOptions): Promise; - public createCase(args: CreateCaseCommandInput, cb: (err: any, data?: CreateCaseCommandOutput) => void): void; - public createCase( + createCase(args: CreateCaseCommandInput, options?: __HttpHandlerOptions): Promise; + createCase(args: CreateCaseCommandInput, cb: (err: any, data?: CreateCaseCommandOutput) => void): void; + createCase( args: CreateCaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCaseCommandOutput) => void ): void; - public createCase( - args: CreateCaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCaseCommandOutput) => void), - cb?: (err: any, data?: CreateCaseCommandOutput) => void - ): Promise | void { - const command = new CreateCaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the attachment that has the specified ID. Attachments can include screenshots, - * error logs, or other files that describe your issue. Attachment IDs are generated by the - * case management system when you add an attachment to a case or case communication. - * Attachment IDs are returned in the AttachmentDetails objects that are - * returned by the DescribeCommunications operation.

- * - *
    - *
  • - *

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support - * API.

    - *
  • - *
  • - *

    If you call the Amazon Web Services Support API from an account that doesn't have a - * Business, Enterprise On-Ramp, or Enterprise Support plan, the - * SubscriptionRequiredException error message appears. For - * information about changing your support plan, see Amazon Web Services Support.

    - *
  • - *
- *
+ * @see {@link DescribeAttachmentCommand} */ - public describeAttachment( + describeAttachment( args: DescribeAttachmentCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAttachment( + describeAttachment( args: DescribeAttachmentCommandInput, cb: (err: any, data?: DescribeAttachmentCommandOutput) => void ): void; - public describeAttachment( + describeAttachment( args: DescribeAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAttachmentCommandOutput) => void ): void; - public describeAttachment( - args: DescribeAttachmentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAttachmentCommandOutput) => void), - cb?: (err: any, data?: DescribeAttachmentCommandOutput) => void - ): Promise | void { - const command = new DescribeAttachmentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of cases that you specify by passing one or more case IDs. You can use - * the afterTime and beforeTime parameters to filter the cases by - * date. You can set values for the includeResolvedCases and - * includeCommunications parameters to specify how much information to - * return.

- *

The response returns the following in JSON format:

- *
    - *
  • - *

    One or more CaseDetails data types.

    - *
  • - *
  • - *

    One or more nextToken values, which specify where to paginate the - * returned records represented by the CaseDetails objects.

    - *
  • - *
- *

Case data is available for 12 months after creation. If a case was created more than - * 12 months ago, a request might return an error.

- * - *
    - *
  • - *

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support - * API.

    - *
  • - *
  • - *

    If you call the Amazon Web Services Support API from an account that doesn't have a - * Business, Enterprise On-Ramp, or Enterprise Support plan, the - * SubscriptionRequiredException error message appears. For - * information about changing your support plan, see Amazon Web Services Support.

    - *
  • - *
- *
+ * @see {@link DescribeCasesCommand} */ - public describeCases( - args: DescribeCasesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeCases( - args: DescribeCasesCommandInput, - cb: (err: any, data?: DescribeCasesCommandOutput) => void - ): void; - public describeCases( + describeCases(args: DescribeCasesCommandInput, options?: __HttpHandlerOptions): Promise; + describeCases(args: DescribeCasesCommandInput, cb: (err: any, data?: DescribeCasesCommandOutput) => void): void; + describeCases( args: DescribeCasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCasesCommandOutput) => void ): void; - public describeCases( - args: DescribeCasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCasesCommandOutput) => void), - cb?: (err: any, data?: DescribeCasesCommandOutput) => void - ): Promise | void { - const command = new DescribeCasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns communications and attachments for one or more support cases. Use the - * afterTime and beforeTime parameters to filter by date. You - * can use the caseId parameter to restrict the results to a specific - * case.

- *

Case data is available for 12 months after creation. If a case was created more than - * 12 months ago, a request for data might cause an error.

- *

You can use the maxResults and nextToken parameters to - * control the pagination of the results. Set maxResults to the number of - * cases that you want to display on each page, and use nextToken to specify - * the resumption of pagination.

- * - *
    - *
  • - *

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support - * API.

    - *
  • - *
  • - *

    If you call the Amazon Web Services Support API from an account that doesn't have a - * Business, Enterprise On-Ramp, or Enterprise Support plan, the - * SubscriptionRequiredException error message appears. For - * information about changing your support plan, see Amazon Web Services Support.

    - *
  • - *
- *
+ * @see {@link DescribeCommunicationsCommand} */ - public describeCommunications( + describeCommunications( args: DescribeCommunicationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCommunications( + describeCommunications( args: DescribeCommunicationsCommandInput, cb: (err: any, data?: DescribeCommunicationsCommandOutput) => void ): void; - public describeCommunications( + describeCommunications( args: DescribeCommunicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCommunicationsCommandOutput) => void ): void; - public describeCommunications( - args: DescribeCommunicationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCommunicationsCommandOutput) => void), - cb?: (err: any, data?: DescribeCommunicationsCommandOutput) => void - ): Promise | void { - const command = new DescribeCommunicationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the current list of Amazon Web Services services and a list of service categories for each - * service. You then use service names and categories in your CreateCase - * requests. Each Amazon Web Services service has its own set of categories.

- *

The service codes and category codes correspond to the values that appear in the - * Service and Category lists on the Amazon Web Services Support Center Create Case page. The values in those fields - * don't necessarily match the service codes and categories returned by the - * DescribeServices operation. Always use the service codes and categories - * that the DescribeServices operation returns, so that you have the most - * recent set of service and category codes.

- * - *
    - *
  • - *

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support - * API.

    - *
  • - *
  • - *

    If you call the Amazon Web Services Support API from an account that doesn't have a - * Business, Enterprise On-Ramp, or Enterprise Support plan, the - * SubscriptionRequiredException error message appears. For - * information about changing your support plan, see Amazon Web Services Support.

    - *
  • - *
- *
+ * @see {@link DescribeServicesCommand} */ - public describeServices( + describeServices( args: DescribeServicesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeServices( + describeServices( args: DescribeServicesCommandInput, cb: (err: any, data?: DescribeServicesCommandOutput) => void ): void; - public describeServices( + describeServices( args: DescribeServicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeServicesCommandOutput) => void ): void; - public describeServices( - args: DescribeServicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeServicesCommandOutput) => void), - cb?: (err: any, data?: DescribeServicesCommandOutput) => void - ): Promise | void { - const command = new DescribeServicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the list of severity levels that you can assign to a support case. The - * severity level for a case is also a field in the CaseDetails data type - * that you include for a CreateCase request.

- * - *
    - *
  • - *

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support - * API.

    - *
  • - *
  • - *

    If you call the Amazon Web Services Support API from an account that doesn't have a - * Business, Enterprise On-Ramp, or Enterprise Support plan, the - * SubscriptionRequiredException error message appears. For - * information about changing your support plan, see Amazon Web Services Support.

    - *
  • - *
- *
+ * @see {@link DescribeSeverityLevelsCommand} */ - public describeSeverityLevels( + describeSeverityLevels( args: DescribeSeverityLevelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSeverityLevels( + describeSeverityLevels( args: DescribeSeverityLevelsCommandInput, cb: (err: any, data?: DescribeSeverityLevelsCommandOutput) => void ): void; - public describeSeverityLevels( + describeSeverityLevels( args: DescribeSeverityLevelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSeverityLevelsCommandOutput) => void ): void; - public describeSeverityLevels( - args: DescribeSeverityLevelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSeverityLevelsCommandOutput) => void), - cb?: (err: any, data?: DescribeSeverityLevelsCommandOutput) => void - ): Promise | void { - const command = new DescribeSeverityLevelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the refresh status of the Trusted Advisor checks that have the specified check - * IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

- *

Some checks are refreshed automatically, and you can't return their refresh statuses - * by using the DescribeTrustedAdvisorCheckRefreshStatuses operation. If you - * call this operation for these checks, you might see an - * InvalidParameterValue error.

- * - *
    - *
  • - *

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support - * API.

    - *
  • - *
  • - *

    If you call the Amazon Web Services Support API from an account that doesn't have a - * Business, Enterprise On-Ramp, or Enterprise Support plan, the - * SubscriptionRequiredException error message appears. For - * information about changing your support plan, see Amazon Web Services Support.

    - *
  • - *
- *
- *

To call the Trusted Advisor operations in - * the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) - * endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support - * API in the Amazon Web Services Support User Guide.

+ * @see {@link DescribeTrustedAdvisorCheckRefreshStatusesCommand} */ - public describeTrustedAdvisorCheckRefreshStatuses( + describeTrustedAdvisorCheckRefreshStatuses( args: DescribeTrustedAdvisorCheckRefreshStatusesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTrustedAdvisorCheckRefreshStatuses( + describeTrustedAdvisorCheckRefreshStatuses( args: DescribeTrustedAdvisorCheckRefreshStatusesCommandInput, cb: (err: any, data?: DescribeTrustedAdvisorCheckRefreshStatusesCommandOutput) => void ): void; - public describeTrustedAdvisorCheckRefreshStatuses( + describeTrustedAdvisorCheckRefreshStatuses( args: DescribeTrustedAdvisorCheckRefreshStatusesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrustedAdvisorCheckRefreshStatusesCommandOutput) => void ): void; - public describeTrustedAdvisorCheckRefreshStatuses( - args: DescribeTrustedAdvisorCheckRefreshStatusesCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeTrustedAdvisorCheckRefreshStatusesCommandOutput) => void), - cb?: (err: any, data?: DescribeTrustedAdvisorCheckRefreshStatusesCommandOutput) => void - ): Promise | void { - const command = new DescribeTrustedAdvisorCheckRefreshStatusesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the results of the Trusted Advisor check that has the specified check ID. You - * can get the check IDs by calling the DescribeTrustedAdvisorChecks - * operation.

- *

The response contains a TrustedAdvisorCheckResult object, which - * contains these three objects:

- * - *

In addition, the response contains these fields:

- *
    - *
  • - *

    - * status - The alert status of the check - * can be ok (green), warning (yellow), - * error (red), or not_available.

    - *
  • - *
  • - *

    - * timestamp - The time of the last refresh - * of the check.

    - *
  • - *
  • - *

    - * checkId - The unique identifier for the - * check.

    - *
  • - *
- * - *
    - *
  • - *

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support - * API.

    - *
  • - *
  • - *

    If you call the Amazon Web Services Support API from an account that doesn't have a - * Business, Enterprise On-Ramp, or Enterprise Support plan, the - * SubscriptionRequiredException error message appears. For - * information about changing your support plan, see Amazon Web Services Support.

    - *
  • - *
- *
- *

To call the Trusted Advisor operations in - * the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) - * endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support - * API in the Amazon Web Services Support User Guide.

+ * @see {@link DescribeTrustedAdvisorCheckResultCommand} */ - public describeTrustedAdvisorCheckResult( + describeTrustedAdvisorCheckResult( args: DescribeTrustedAdvisorCheckResultCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTrustedAdvisorCheckResult( + describeTrustedAdvisorCheckResult( args: DescribeTrustedAdvisorCheckResultCommandInput, cb: (err: any, data?: DescribeTrustedAdvisorCheckResultCommandOutput) => void ): void; - public describeTrustedAdvisorCheckResult( + describeTrustedAdvisorCheckResult( args: DescribeTrustedAdvisorCheckResultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrustedAdvisorCheckResultCommandOutput) => void ): void; - public describeTrustedAdvisorCheckResult( - args: DescribeTrustedAdvisorCheckResultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTrustedAdvisorCheckResultCommandOutput) => void), - cb?: (err: any, data?: DescribeTrustedAdvisorCheckResultCommandOutput) => void - ): Promise | void { - const command = new DescribeTrustedAdvisorCheckResultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about all available Trusted Advisor checks, including the name, ID, - * category, description, and metadata. You must specify a language code.

- *

The response contains a TrustedAdvisorCheckDescription object for - * each check. You must set the Amazon Web Services Region to us-east-1.

- * - *
    - *
  • - *

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

    - *
  • - *
  • - *

    If you call the Amazon Web Services Support API from an account that doesn't have a - * Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error - * message appears. For information about changing your support plan, see - * Amazon Web Services Support.

    - *
  • - *
  • - *

    The names and descriptions for Trusted Advisor checks are subject to change. We - * recommend that you specify the check ID in your code to uniquely identify a - * check.

    - *
  • - *
- *
- *

To call the Trusted Advisor operations in - * the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) - * endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support - * API in the Amazon Web Services Support User Guide.

+ * @see {@link DescribeTrustedAdvisorChecksCommand} */ - public describeTrustedAdvisorChecks( + describeTrustedAdvisorChecks( args: DescribeTrustedAdvisorChecksCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTrustedAdvisorChecks( + describeTrustedAdvisorChecks( args: DescribeTrustedAdvisorChecksCommandInput, cb: (err: any, data?: DescribeTrustedAdvisorChecksCommandOutput) => void ): void; - public describeTrustedAdvisorChecks( + describeTrustedAdvisorChecks( args: DescribeTrustedAdvisorChecksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrustedAdvisorChecksCommandOutput) => void ): void; - public describeTrustedAdvisorChecks( - args: DescribeTrustedAdvisorChecksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTrustedAdvisorChecksCommandOutput) => void), - cb?: (err: any, data?: DescribeTrustedAdvisorChecksCommandOutput) => void - ): Promise | void { - const command = new DescribeTrustedAdvisorChecksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the results for the Trusted Advisor check summaries for the check IDs that you - * specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

- *

The response contains an array of TrustedAdvisorCheckSummary - * objects.

- * - *
    - *
  • - *

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support - * API.

    - *
  • - *
  • - *

    If you call the Amazon Web Services Support API from an account that doesn't have a - * Business, Enterprise On-Ramp, or Enterprise Support plan, the - * SubscriptionRequiredException error message appears. For - * information about changing your support plan, see Amazon Web Services Support.

    - *
  • - *
- *
- *

To call the Trusted Advisor operations in - * the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) - * endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support - * API in the Amazon Web Services Support User Guide.

+ * @see {@link DescribeTrustedAdvisorCheckSummariesCommand} */ - public describeTrustedAdvisorCheckSummaries( + describeTrustedAdvisorCheckSummaries( args: DescribeTrustedAdvisorCheckSummariesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTrustedAdvisorCheckSummaries( + describeTrustedAdvisorCheckSummaries( args: DescribeTrustedAdvisorCheckSummariesCommandInput, cb: (err: any, data?: DescribeTrustedAdvisorCheckSummariesCommandOutput) => void ): void; - public describeTrustedAdvisorCheckSummaries( + describeTrustedAdvisorCheckSummaries( args: DescribeTrustedAdvisorCheckSummariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrustedAdvisorCheckSummariesCommandOutput) => void ): void; - public describeTrustedAdvisorCheckSummaries( - args: DescribeTrustedAdvisorCheckSummariesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTrustedAdvisorCheckSummariesCommandOutput) => void), - cb?: (err: any, data?: DescribeTrustedAdvisorCheckSummariesCommandOutput) => void - ): Promise | void { - const command = new DescribeTrustedAdvisorCheckSummariesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Refreshes the Trusted Advisor check that you specify using the check ID. You can get the - * check IDs by calling the DescribeTrustedAdvisorChecks - * operation.

- *

Some checks are refreshed automatically. If you call the - * RefreshTrustedAdvisorCheck operation to refresh them, you might see - * the InvalidParameterValue error.

- *

The response contains a TrustedAdvisorCheckRefreshStatus - * object.

- * - *
    - *
  • - *

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support - * API.

    - *
  • - *
  • - *

    If you call the Amazon Web Services Support API from an account that doesn't have a - * Business, Enterprise On-Ramp, or Enterprise Support plan, the - * SubscriptionRequiredException error message appears. For - * information about changing your support plan, see Amazon Web Services Support.

    - *
  • - *
- *
- *

To call the Trusted Advisor operations in - * the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) - * endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support - * API in the Amazon Web Services Support User Guide.

+ * @see {@link RefreshTrustedAdvisorCheckCommand} */ - public refreshTrustedAdvisorCheck( + refreshTrustedAdvisorCheck( args: RefreshTrustedAdvisorCheckCommandInput, options?: __HttpHandlerOptions ): Promise; - public refreshTrustedAdvisorCheck( + refreshTrustedAdvisorCheck( args: RefreshTrustedAdvisorCheckCommandInput, cb: (err: any, data?: RefreshTrustedAdvisorCheckCommandOutput) => void ): void; - public refreshTrustedAdvisorCheck( + refreshTrustedAdvisorCheck( args: RefreshTrustedAdvisorCheckCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RefreshTrustedAdvisorCheckCommandOutput) => void ): void; - public refreshTrustedAdvisorCheck( - args: RefreshTrustedAdvisorCheckCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RefreshTrustedAdvisorCheckCommandOutput) => void), - cb?: (err: any, data?: RefreshTrustedAdvisorCheckCommandOutput) => void - ): Promise | void { - const command = new RefreshTrustedAdvisorCheckCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Resolves a support case. This operation takes a caseId and returns the - * initial and final state of the case.

- * - *
    - *
  • - *

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support - * API.

    - *
  • - *
  • - *

    If you call the Amazon Web Services Support API from an account that doesn't have a - * Business, Enterprise On-Ramp, or Enterprise Support plan, the - * SubscriptionRequiredException error message appears. For - * information about changing your support plan, see Amazon Web Services Support.

    - *
  • - *
- *
+ * @see {@link ResolveCaseCommand} */ - public resolveCase(args: ResolveCaseCommandInput, options?: __HttpHandlerOptions): Promise; - public resolveCase(args: ResolveCaseCommandInput, cb: (err: any, data?: ResolveCaseCommandOutput) => void): void; - public resolveCase( + resolveCase(args: ResolveCaseCommandInput, options?: __HttpHandlerOptions): Promise; + resolveCase(args: ResolveCaseCommandInput, cb: (err: any, data?: ResolveCaseCommandOutput) => void): void; + resolveCase( args: ResolveCaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResolveCaseCommandOutput) => void ): void; - public resolveCase( - args: ResolveCaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResolveCaseCommandOutput) => void), - cb?: (err: any, data?: ResolveCaseCommandOutput) => void - ): Promise | void { - const command = new ResolveCaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Web Services Support + *

The Amazon Web Services Support API Reference is intended for programmers who need detailed + * information about the Amazon Web Services Support operations and data types. You can use the API to manage + * your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return + * results in JSON format.

+ * + *
    + *
  • + *

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support + * API.

    + *
  • + *
  • + *

    If you call the Amazon Web Services Support API from an account that doesn't have a + * Business, Enterprise On-Ramp, or Enterprise Support plan, the + * SubscriptionRequiredException error message appears. For + * information about changing your support plan, see Amazon Web Services Support.

    + *
  • + *
+ *
+ *

You can also use the Amazon Web Services Support API to access features for Trusted Advisor. You can return a list of + * checks and their descriptions, get check results, specify checks to refresh, and get the + * refresh status of checks.

+ *

You can manage your support cases with the following Amazon Web Services Support API operations:

+ * + *

You can also use the Amazon Web Services Support API to call the Trusted Advisor operations. For more + * information, see Trusted Advisor in the + * Amazon Web Services Support User Guide.

+ *

For authentication of requests, Amazon Web Services Support uses Signature Version 4 Signing + * Process.

+ *

For more information about this service and the endpoints to use, see About the + * Amazon Web Services Support API in the Amazon Web Services Support User Guide.

+ */ +export class Support extends SupportClient implements Support {} +createAggregatedClient(commands, Support); diff --git a/clients/client-swf/src/SWF.ts b/clients/client-swf/src/SWF.ts index 52323cdf5189..d34b55c6b2c6 100644 --- a/clients/client-swf/src/SWF.ts +++ b/clients/client-swf/src/SWF.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -178,2502 +179,670 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; -import { SWFClient } from "./SWFClient"; +import { SWFClient, SWFClientConfig } from "./SWFClient"; -/** - * @public - * Amazon Simple Workflow Service - * - *

The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to - * coordinate work across distributed components. In Amazon SWF, a task - * represents a logical unit of work that is performed by a component of your workflow. - * Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and - * concurrency in accordance with the logical flow of the application.

- * - *

Amazon SWF gives you full control over implementing tasks and coordinating them without - * worrying about underlying complexities such as tracking their progress and maintaining their - * state.

- * - *

This documentation serves as reference only. For a broader overview of the Amazon SWF - * programming model, see the - * Amazon SWF Developer Guide - * .

- */ -export class SWF extends SWFClient { +const commands = { + CountClosedWorkflowExecutionsCommand, + CountOpenWorkflowExecutionsCommand, + CountPendingActivityTasksCommand, + CountPendingDecisionTasksCommand, + DeprecateActivityTypeCommand, + DeprecateDomainCommand, + DeprecateWorkflowTypeCommand, + DescribeActivityTypeCommand, + DescribeDomainCommand, + DescribeWorkflowExecutionCommand, + DescribeWorkflowTypeCommand, + GetWorkflowExecutionHistoryCommand, + ListActivityTypesCommand, + ListClosedWorkflowExecutionsCommand, + ListDomainsCommand, + ListOpenWorkflowExecutionsCommand, + ListTagsForResourceCommand, + ListWorkflowTypesCommand, + PollForActivityTaskCommand, + PollForDecisionTaskCommand, + RecordActivityTaskHeartbeatCommand, + RegisterActivityTypeCommand, + RegisterDomainCommand, + RegisterWorkflowTypeCommand, + RequestCancelWorkflowExecutionCommand, + RespondActivityTaskCanceledCommand, + RespondActivityTaskCompletedCommand, + RespondActivityTaskFailedCommand, + RespondDecisionTaskCompletedCommand, + SignalWorkflowExecutionCommand, + StartWorkflowExecutionCommand, + TagResourceCommand, + TerminateWorkflowExecutionCommand, + UndeprecateActivityTypeCommand, + UndeprecateDomainCommand, + UndeprecateWorkflowTypeCommand, + UntagResourceCommand, +}; + +export interface SWF { /** - * @public - *

Returns the number of closed workflow executions within the given domain that meet the - * specified filtering criteria.

- * - *

This operation is eventually consistent. The results are best effort and may not - * exactly reflect recent updates and changes.

- *
- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    Constrain the following parameters by using a Condition element with - * the appropriate keys.

    - *
      - *
    • - *

      - * tagFilter.tag: String constraint. The key is - * swf:tagFilter.tag.

      - *
    • - *
    • - *

      - * typeFilter.name: String constraint. The key is - * swf:typeFilter.name.

      - *
    • - *
    • - *

      - * typeFilter.version: String constraint. The key is - * swf:typeFilter.version.

      - *
    • - *
    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link CountClosedWorkflowExecutionsCommand} */ - public countClosedWorkflowExecutions( + countClosedWorkflowExecutions( args: CountClosedWorkflowExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public countClosedWorkflowExecutions( + countClosedWorkflowExecutions( args: CountClosedWorkflowExecutionsCommandInput, cb: (err: any, data?: CountClosedWorkflowExecutionsCommandOutput) => void ): void; - public countClosedWorkflowExecutions( + countClosedWorkflowExecutions( args: CountClosedWorkflowExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CountClosedWorkflowExecutionsCommandOutput) => void ): void; - public countClosedWorkflowExecutions( - args: CountClosedWorkflowExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CountClosedWorkflowExecutionsCommandOutput) => void), - cb?: (err: any, data?: CountClosedWorkflowExecutionsCommandOutput) => void - ): Promise | void { - const command = new CountClosedWorkflowExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the number of open workflow executions within the given domain that meet the - * specified filtering criteria.

- * - *

This operation is eventually consistent. The results are best effort and may not - * exactly reflect recent updates and changes.

- *
- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    Constrain the following parameters by using a Condition element with - * the appropriate keys.

    - *
      - *
    • - *

      - * tagFilter.tag: String constraint. The key is - * swf:tagFilter.tag.

      - *
    • - *
    • - *

      - * typeFilter.name: String constraint. The key is - * swf:typeFilter.name.

      - *
    • - *
    • - *

      - * typeFilter.version: String constraint. The key is - * swf:typeFilter.version.

      - *
    • - *
    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link CountOpenWorkflowExecutionsCommand} */ - public countOpenWorkflowExecutions( + countOpenWorkflowExecutions( args: CountOpenWorkflowExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public countOpenWorkflowExecutions( + countOpenWorkflowExecutions( args: CountOpenWorkflowExecutionsCommandInput, cb: (err: any, data?: CountOpenWorkflowExecutionsCommandOutput) => void ): void; - public countOpenWorkflowExecutions( + countOpenWorkflowExecutions( args: CountOpenWorkflowExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CountOpenWorkflowExecutionsCommandOutput) => void ): void; - public countOpenWorkflowExecutions( - args: CountOpenWorkflowExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CountOpenWorkflowExecutionsCommandOutput) => void), - cb?: (err: any, data?: CountOpenWorkflowExecutionsCommandOutput) => void - ): Promise | void { - const command = new CountOpenWorkflowExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the estimated number of activity tasks in the specified task list. The count - * returned is an approximation and isn't guaranteed to be exact. If you specify a task list that - * no activity task was ever scheduled in then 0 is returned.

- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    Constrain the taskList.name parameter by using a - * Condition element with the swf:taskList.name key to allow the - * action to access only certain task lists.

    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link CountPendingActivityTasksCommand} */ - public countPendingActivityTasks( + countPendingActivityTasks( args: CountPendingActivityTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public countPendingActivityTasks( + countPendingActivityTasks( args: CountPendingActivityTasksCommandInput, cb: (err: any, data?: CountPendingActivityTasksCommandOutput) => void ): void; - public countPendingActivityTasks( + countPendingActivityTasks( args: CountPendingActivityTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CountPendingActivityTasksCommandOutput) => void ): void; - public countPendingActivityTasks( - args: CountPendingActivityTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CountPendingActivityTasksCommandOutput) => void), - cb?: (err: any, data?: CountPendingActivityTasksCommandOutput) => void - ): Promise | void { - const command = new CountPendingActivityTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the estimated number of decision tasks in the specified task list. The count - * returned is an approximation and isn't guaranteed to be exact. If you specify a task list that - * no decision task was ever scheduled in then 0 is returned.

- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    Constrain the taskList.name parameter by using a - * Condition element with the swf:taskList.name key to allow the - * action to access only certain task lists.

    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link CountPendingDecisionTasksCommand} */ - public countPendingDecisionTasks( + countPendingDecisionTasks( args: CountPendingDecisionTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public countPendingDecisionTasks( + countPendingDecisionTasks( args: CountPendingDecisionTasksCommandInput, cb: (err: any, data?: CountPendingDecisionTasksCommandOutput) => void ): void; - public countPendingDecisionTasks( + countPendingDecisionTasks( args: CountPendingDecisionTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CountPendingDecisionTasksCommandOutput) => void ): void; - public countPendingDecisionTasks( - args: CountPendingDecisionTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CountPendingDecisionTasksCommandOutput) => void), - cb?: (err: any, data?: CountPendingDecisionTasksCommandOutput) => void - ): Promise | void { - const command = new CountPendingDecisionTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deprecates the specified activity type. After an activity type has - * been deprecated, you cannot create new tasks of that activity type. Tasks of this type that - * were scheduled before the type was deprecated continue to run.

- * - *

This operation is eventually consistent. The results are best effort and may not - * exactly reflect recent updates and changes.

- *
- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    Constrain the following parameters by using a Condition element with - * the appropriate keys.

    - *
      - *
    • - *

      - * activityType.name: String constraint. The key is - * swf:activityType.name.

      - *
    • - *
    • - *

      - * activityType.version: String constraint. The key is - * swf:activityType.version.

      - *
    • - *
    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link DeprecateActivityTypeCommand} */ - public deprecateActivityType( + deprecateActivityType( args: DeprecateActivityTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deprecateActivityType( + deprecateActivityType( args: DeprecateActivityTypeCommandInput, cb: (err: any, data?: DeprecateActivityTypeCommandOutput) => void ): void; - public deprecateActivityType( + deprecateActivityType( args: DeprecateActivityTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeprecateActivityTypeCommandOutput) => void ): void; - public deprecateActivityType( - args: DeprecateActivityTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeprecateActivityTypeCommandOutput) => void), - cb?: (err: any, data?: DeprecateActivityTypeCommandOutput) => void - ): Promise | void { - const command = new DeprecateActivityTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deprecates the specified domain. After a domain has been deprecated it cannot be used - * to create new workflow executions or register new types. However, you can still use visibility - * actions on this domain. Deprecating a domain also deprecates all activity and workflow types - * registered in the domain. Executions that were started before the domain was deprecated - * continues to run.

- * - *

This operation is eventually consistent. The results are best effort and may not - * exactly reflect recent updates and changes.

- *
- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    You cannot use an IAM policy to constrain this action's parameters.

    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link DeprecateDomainCommand} */ - public deprecateDomain( + deprecateDomain( args: DeprecateDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public deprecateDomain( - args: DeprecateDomainCommandInput, - cb: (err: any, data?: DeprecateDomainCommandOutput) => void - ): void; - public deprecateDomain( + deprecateDomain(args: DeprecateDomainCommandInput, cb: (err: any, data?: DeprecateDomainCommandOutput) => void): void; + deprecateDomain( args: DeprecateDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeprecateDomainCommandOutput) => void ): void; - public deprecateDomain( - args: DeprecateDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeprecateDomainCommandOutput) => void), - cb?: (err: any, data?: DeprecateDomainCommandOutput) => void - ): Promise | void { - const command = new DeprecateDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deprecates the specified workflow type. After a workflow type has - * been deprecated, you cannot create new executions of that type. Executions that were started - * before the type was deprecated continues to run. A deprecated workflow type may still be used - * when calling visibility actions.

- * - *

This operation is eventually consistent. The results are best effort and may not - * exactly reflect recent updates and changes.

- *
- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    Constrain the following parameters by using a Condition element with - * the appropriate keys.

    - *
      - *
    • - *

      - * workflowType.name: String constraint. The key is - * swf:workflowType.name.

      - *
    • - *
    • - *

      - * workflowType.version: String constraint. The key is - * swf:workflowType.version.

      - *
    • - *
    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link DeprecateWorkflowTypeCommand} */ - public deprecateWorkflowType( + deprecateWorkflowType( args: DeprecateWorkflowTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public deprecateWorkflowType( + deprecateWorkflowType( args: DeprecateWorkflowTypeCommandInput, cb: (err: any, data?: DeprecateWorkflowTypeCommandOutput) => void ): void; - public deprecateWorkflowType( + deprecateWorkflowType( args: DeprecateWorkflowTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeprecateWorkflowTypeCommandOutput) => void ): void; - public deprecateWorkflowType( - args: DeprecateWorkflowTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeprecateWorkflowTypeCommandOutput) => void), - cb?: (err: any, data?: DeprecateWorkflowTypeCommandOutput) => void - ): Promise | void { - const command = new DeprecateWorkflowTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the specified activity type. This includes configuration - * settings provided when the type was registered and other general information about the - * type.

- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    Constrain the following parameters by using a Condition element with - * the appropriate keys.

    - *
      - *
    • - *

      - * activityType.name: String constraint. The key is - * swf:activityType.name.

      - *
    • - *
    • - *

      - * activityType.version: String constraint. The key is - * swf:activityType.version.

      - *
    • - *
    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link DescribeActivityTypeCommand} */ - public describeActivityType( + describeActivityType( args: DescribeActivityTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeActivityType( + describeActivityType( args: DescribeActivityTypeCommandInput, cb: (err: any, data?: DescribeActivityTypeCommandOutput) => void ): void; - public describeActivityType( + describeActivityType( args: DescribeActivityTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeActivityTypeCommandOutput) => void ): void; - public describeActivityType( - args: DescribeActivityTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeActivityTypeCommandOutput) => void), - cb?: (err: any, data?: DescribeActivityTypeCommandOutput) => void - ): Promise | void { - const command = new DescribeActivityTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the specified domain, including description and - * status.

- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    You cannot use an IAM policy to constrain this action's parameters.

    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link DescribeDomainCommand} */ - public describeDomain( + describeDomain( args: DescribeDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDomain( - args: DescribeDomainCommandInput, - cb: (err: any, data?: DescribeDomainCommandOutput) => void - ): void; - public describeDomain( + describeDomain(args: DescribeDomainCommandInput, cb: (err: any, data?: DescribeDomainCommandOutput) => void): void; + describeDomain( args: DescribeDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDomainCommandOutput) => void ): void; - public describeDomain( - args: DescribeDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDomainCommandOutput) => void), - cb?: (err: any, data?: DescribeDomainCommandOutput) => void - ): Promise | void { - const command = new DescribeDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the specified workflow execution including its type and some - * statistics.

- * - *

This operation is eventually consistent. The results are best effort and may not - * exactly reflect recent updates and changes.

- *
- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    You cannot use an IAM policy to constrain this action's parameters.

    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link DescribeWorkflowExecutionCommand} */ - public describeWorkflowExecution( + describeWorkflowExecution( args: DescribeWorkflowExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWorkflowExecution( + describeWorkflowExecution( args: DescribeWorkflowExecutionCommandInput, cb: (err: any, data?: DescribeWorkflowExecutionCommandOutput) => void ): void; - public describeWorkflowExecution( + describeWorkflowExecution( args: DescribeWorkflowExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkflowExecutionCommandOutput) => void ): void; - public describeWorkflowExecution( - args: DescribeWorkflowExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWorkflowExecutionCommandOutput) => void), - cb?: (err: any, data?: DescribeWorkflowExecutionCommandOutput) => void - ): Promise | void { - const command = new DescribeWorkflowExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the specified workflow type. This - * includes configuration settings specified when the type was registered and other information - * such as creation date, current status, etc.

- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    Constrain the following parameters by using a Condition element with - * the appropriate keys.

    - *
      - *
    • - *

      - * workflowType.name: String constraint. The key is - * swf:workflowType.name.

      - *
    • - *
    • - *

      - * workflowType.version: String constraint. The key is - * swf:workflowType.version.

      - *
    • - *
    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link DescribeWorkflowTypeCommand} */ - public describeWorkflowType( + describeWorkflowType( args: DescribeWorkflowTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWorkflowType( + describeWorkflowType( args: DescribeWorkflowTypeCommandInput, cb: (err: any, data?: DescribeWorkflowTypeCommandOutput) => void ): void; - public describeWorkflowType( + describeWorkflowType( args: DescribeWorkflowTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkflowTypeCommandOutput) => void ): void; - public describeWorkflowType( - args: DescribeWorkflowTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWorkflowTypeCommandOutput) => void), - cb?: (err: any, data?: DescribeWorkflowTypeCommandOutput) => void - ): Promise | void { - const command = new DescribeWorkflowTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the history of the specified workflow execution. The results may be split into - * multiple pages. To retrieve subsequent pages, make the call again using the - * nextPageToken returned by the initial call.

- * - *

This operation is eventually consistent. The results are best effort and may not - * exactly reflect recent updates and changes.

- *
- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    You cannot use an IAM policy to constrain this action's parameters.

    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link GetWorkflowExecutionHistoryCommand} */ - public getWorkflowExecutionHistory( + getWorkflowExecutionHistory( args: GetWorkflowExecutionHistoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWorkflowExecutionHistory( + getWorkflowExecutionHistory( args: GetWorkflowExecutionHistoryCommandInput, cb: (err: any, data?: GetWorkflowExecutionHistoryCommandOutput) => void ): void; - public getWorkflowExecutionHistory( + getWorkflowExecutionHistory( args: GetWorkflowExecutionHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkflowExecutionHistoryCommandOutput) => void ): void; - public getWorkflowExecutionHistory( - args: GetWorkflowExecutionHistoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkflowExecutionHistoryCommandOutput) => void), - cb?: (err: any, data?: GetWorkflowExecutionHistoryCommandOutput) => void - ): Promise | void { - const command = new GetWorkflowExecutionHistoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about all activities registered in the specified domain that match - * the specified name and registration status. The result includes information like creation - * date, current status of the activity, etc. The results may be split into multiple pages. To - * retrieve subsequent pages, make the call again using the nextPageToken returned - * by the initial call.

- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    You cannot use an IAM policy to constrain this action's parameters.

    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link ListActivityTypesCommand} */ - public listActivityTypes( + listActivityTypes( args: ListActivityTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listActivityTypes( + listActivityTypes( args: ListActivityTypesCommandInput, cb: (err: any, data?: ListActivityTypesCommandOutput) => void ): void; - public listActivityTypes( + listActivityTypes( args: ListActivityTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListActivityTypesCommandOutput) => void ): void; - public listActivityTypes( - args: ListActivityTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListActivityTypesCommandOutput) => void), - cb?: (err: any, data?: ListActivityTypesCommandOutput) => void - ): Promise | void { - const command = new ListActivityTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of closed workflow executions in the specified domain that meet the - * filtering criteria. The results may be split into multiple pages. To retrieve subsequent - * pages, make the call again using the nextPageToken returned by the initial call.

- * - *

This operation is eventually consistent. The results are best effort and may not - * exactly reflect recent updates and changes.

- *
- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    Constrain the following parameters by using a Condition element with - * the appropriate keys.

    - *
      - *
    • - *

      - * tagFilter.tag: String constraint. The key is - * swf:tagFilter.tag.

      - *
    • - *
    • - *

      - * typeFilter.name: String constraint. The key is - * swf:typeFilter.name.

      - *
    • - *
    • - *

      - * typeFilter.version: String constraint. The key is - * swf:typeFilter.version.

      - *
    • - *
    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link ListClosedWorkflowExecutionsCommand} */ - public listClosedWorkflowExecutions( + listClosedWorkflowExecutions( args: ListClosedWorkflowExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listClosedWorkflowExecutions( + listClosedWorkflowExecutions( args: ListClosedWorkflowExecutionsCommandInput, cb: (err: any, data?: ListClosedWorkflowExecutionsCommandOutput) => void ): void; - public listClosedWorkflowExecutions( + listClosedWorkflowExecutions( args: ListClosedWorkflowExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListClosedWorkflowExecutionsCommandOutput) => void ): void; - public listClosedWorkflowExecutions( - args: ListClosedWorkflowExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListClosedWorkflowExecutionsCommandOutput) => void), - cb?: (err: any, data?: ListClosedWorkflowExecutionsCommandOutput) => void - ): Promise | void { - const command = new ListClosedWorkflowExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the list of domains registered in the account. The results may be split into - * multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken - * returned by the initial call.

- * - *

This operation is eventually consistent. The results are best effort and may not - * exactly reflect recent updates and changes.

- *
- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains. The element must be set to - * arn:aws:swf::AccountID:domain/*, where AccountID is - * the account ID, with no dashes.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    You cannot use an IAM policy to constrain this action's parameters.

    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link ListDomainsCommand} */ - public listDomains(args: ListDomainsCommandInput, options?: __HttpHandlerOptions): Promise; - public listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void; - public listDomains( + listDomains(args: ListDomainsCommandInput, options?: __HttpHandlerOptions): Promise; + listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void; + listDomains( args: ListDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainsCommandOutput) => void ): void; - public listDomains( - args: ListDomainsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDomainsCommandOutput) => void), - cb?: (err: any, data?: ListDomainsCommandOutput) => void - ): Promise | void { - const command = new ListDomainsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of open workflow executions in the specified domain that meet the - * filtering criteria. The results may be split into multiple pages. To retrieve subsequent - * pages, make the call again using the nextPageToken returned by the initial call.

- * - *

This operation is eventually consistent. The results are best effort and may not - * exactly reflect recent updates and changes.

- *
- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    Constrain the following parameters by using a Condition element with - * the appropriate keys.

    - *
      - *
    • - *

      - * tagFilter.tag: String constraint. The key is - * swf:tagFilter.tag.

      - *
    • - *
    • - *

      - * typeFilter.name: String constraint. The key is - * swf:typeFilter.name.

      - *
    • - *
    • - *

      - * typeFilter.version: String constraint. The key is - * swf:typeFilter.version.

      - *
    • - *
    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link ListOpenWorkflowExecutionsCommand} */ - public listOpenWorkflowExecutions( + listOpenWorkflowExecutions( args: ListOpenWorkflowExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOpenWorkflowExecutions( + listOpenWorkflowExecutions( args: ListOpenWorkflowExecutionsCommandInput, cb: (err: any, data?: ListOpenWorkflowExecutionsCommandOutput) => void ): void; - public listOpenWorkflowExecutions( + listOpenWorkflowExecutions( args: ListOpenWorkflowExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOpenWorkflowExecutionsCommandOutput) => void ): void; - public listOpenWorkflowExecutions( - args: ListOpenWorkflowExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOpenWorkflowExecutionsCommandOutput) => void), - cb?: (err: any, data?: ListOpenWorkflowExecutionsCommandOutput) => void - ): Promise | void { - const command = new ListOpenWorkflowExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List tags for a given domain.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about workflow types in the specified domain. The results may be - * split into multiple pages that can be retrieved by making the call repeatedly.

- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    You cannot use an IAM policy to constrain this action's parameters.

    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link ListWorkflowTypesCommand} */ - public listWorkflowTypes( + listWorkflowTypes( args: ListWorkflowTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWorkflowTypes( + listWorkflowTypes( args: ListWorkflowTypesCommandInput, cb: (err: any, data?: ListWorkflowTypesCommandOutput) => void ): void; - public listWorkflowTypes( + listWorkflowTypes( args: ListWorkflowTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkflowTypesCommandOutput) => void ): void; - public listWorkflowTypes( - args: ListWorkflowTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkflowTypesCommandOutput) => void), - cb?: (err: any, data?: ListWorkflowTypesCommandOutput) => void - ): Promise | void { - const command = new ListWorkflowTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used by workers to get an ActivityTask from the specified activity - * taskList. This initiates a long poll, where the service holds the HTTP - * connection open and responds as soon as a task becomes available. The maximum time the service - * holds on to the request before responding is 60 seconds. If no task is available within 60 - * seconds, the poll returns an empty result. An empty result, in this context, means that an - * ActivityTask is returned, but that the value of taskToken is an empty string. If a task is - * returned, the worker should use its type to identify and process it correctly.

- * - *

Workers should set their client side socket timeout to at least 70 seconds (10 - * seconds higher than the maximum time service may hold the poll request).

- *
- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    Constrain the taskList.name parameter by using a - * Condition element with the swf:taskList.name key to allow the - * action to access only certain task lists.

    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link PollForActivityTaskCommand} */ - public pollForActivityTask( + pollForActivityTask( args: PollForActivityTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public pollForActivityTask( + pollForActivityTask( args: PollForActivityTaskCommandInput, cb: (err: any, data?: PollForActivityTaskCommandOutput) => void ): void; - public pollForActivityTask( + pollForActivityTask( args: PollForActivityTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PollForActivityTaskCommandOutput) => void ): void; - public pollForActivityTask( - args: PollForActivityTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PollForActivityTaskCommandOutput) => void), - cb?: (err: any, data?: PollForActivityTaskCommandOutput) => void - ): Promise | void { - const command = new PollForActivityTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used by deciders to get a DecisionTask from the specified decision - * taskList. A decision task may be returned for any open workflow execution that - * is using the specified task list. The task includes a paginated view of the history of the - * workflow execution. The decider should use the workflow type and the history to determine how - * to properly handle the task.

- *

This action initiates a long poll, where the service holds the HTTP connection open and - * responds as soon a task becomes available. If no decision task is available in the specified - * task list before the timeout of 60 seconds expires, an empty result is returned. An empty - * result, in this context, means that a DecisionTask is returned, but that the value of - * taskToken is an empty string.

- * - *

Deciders should set their client side socket timeout to at least 70 seconds (10 - * seconds higher than the timeout).

- *
- * - *

Because the number of workflow history events for a single workflow execution might - * be very large, the result returned might be split up across a number of pages. To retrieve - * subsequent pages, make additional calls to PollForDecisionTask using the - * nextPageToken returned by the initial call. Note that you do - * not call GetWorkflowExecutionHistory with this - * nextPageToken. Instead, call PollForDecisionTask - * again.

- *
- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    Constrain the taskList.name parameter by using a - * Condition element with the swf:taskList.name key to allow the - * action to access only certain task lists.

    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link PollForDecisionTaskCommand} */ - public pollForDecisionTask( + pollForDecisionTask( args: PollForDecisionTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public pollForDecisionTask( + pollForDecisionTask( args: PollForDecisionTaskCommandInput, cb: (err: any, data?: PollForDecisionTaskCommandOutput) => void ): void; - public pollForDecisionTask( + pollForDecisionTask( args: PollForDecisionTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PollForDecisionTaskCommandOutput) => void ): void; - public pollForDecisionTask( - args: PollForDecisionTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PollForDecisionTaskCommandOutput) => void), - cb?: (err: any, data?: PollForDecisionTaskCommandOutput) => void - ): Promise | void { - const command = new PollForDecisionTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker - * can also specify details of the progress, for example percent complete, using the - * details parameter. This action can also be used by the worker as a mechanism to - * check if cancellation is being requested for the activity task. If a cancellation is being - * attempted for the specified task, then the boolean cancelRequested flag returned - * by the service is set to true.

- *

This action resets the taskHeartbeatTimeout clock. The - * taskHeartbeatTimeout is specified in RegisterActivityType.

- *

This action doesn't in itself create an event in the workflow execution history. - * However, if the task times out, the workflow execution history contains a - * ActivityTaskTimedOut event that contains the information from the last - * heartbeat generated by the activity worker.

- * - *

The taskStartToCloseTimeout of an activity type is the maximum duration - * of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType.

- *
- * - *

This operation is only useful for long-lived activities to report liveliness of the - * task and to determine if a cancellation is being attempted.

- *
- * - *

If the cancelRequested flag returns true, a cancellation is - * being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation - * request.

- *
- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    You cannot use an IAM policy to constrain this action's parameters.

    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link RecordActivityTaskHeartbeatCommand} */ - public recordActivityTaskHeartbeat( + recordActivityTaskHeartbeat( args: RecordActivityTaskHeartbeatCommandInput, options?: __HttpHandlerOptions ): Promise; - public recordActivityTaskHeartbeat( + recordActivityTaskHeartbeat( args: RecordActivityTaskHeartbeatCommandInput, cb: (err: any, data?: RecordActivityTaskHeartbeatCommandOutput) => void ): void; - public recordActivityTaskHeartbeat( + recordActivityTaskHeartbeat( args: RecordActivityTaskHeartbeatCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RecordActivityTaskHeartbeatCommandOutput) => void ): void; - public recordActivityTaskHeartbeat( - args: RecordActivityTaskHeartbeatCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RecordActivityTaskHeartbeatCommandOutput) => void), - cb?: (err: any, data?: RecordActivityTaskHeartbeatCommandOutput) => void - ): Promise | void { - const command = new RecordActivityTaskHeartbeatCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers a new activity type along with its configuration - * settings in the specified domain.

- * - *

A TypeAlreadyExists fault is returned if the type already exists in the - * domain. You cannot change any configuration settings of the type after its registration, and - * it must be registered as a new version.

- *
- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    Constrain the following parameters by using a Condition element with - * the appropriate keys.

    - *
      - *
    • - *

      - * defaultTaskList.name: String constraint. The key is - * swf:defaultTaskList.name.

      - *
    • - *
    • - *

      - * name: String constraint. The key is swf:name.

      - *
    • - *
    • - *

      - * version: String constraint. The key is - * swf:version.

      - *
    • - *
    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link RegisterActivityTypeCommand} */ - public registerActivityType( + registerActivityType( args: RegisterActivityTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerActivityType( + registerActivityType( args: RegisterActivityTypeCommandInput, cb: (err: any, data?: RegisterActivityTypeCommandOutput) => void ): void; - public registerActivityType( + registerActivityType( args: RegisterActivityTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterActivityTypeCommandOutput) => void ): void; - public registerActivityType( - args: RegisterActivityTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterActivityTypeCommandOutput) => void), - cb?: (err: any, data?: RegisterActivityTypeCommandOutput) => void - ): Promise | void { - const command = new RegisterActivityTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers a new domain.

- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    You cannot use an IAM policy to control domain access for this action. The name of - * the domain being registered is available as the resource of this action.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    You cannot use an IAM policy to constrain this action's parameters.

    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link RegisterDomainCommand} */ - public registerDomain( + registerDomain( args: RegisterDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerDomain( - args: RegisterDomainCommandInput, - cb: (err: any, data?: RegisterDomainCommandOutput) => void - ): void; - public registerDomain( + registerDomain(args: RegisterDomainCommandInput, cb: (err: any, data?: RegisterDomainCommandOutput) => void): void; + registerDomain( args: RegisterDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterDomainCommandOutput) => void ): void; - public registerDomain( - args: RegisterDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterDomainCommandOutput) => void), - cb?: (err: any, data?: RegisterDomainCommandOutput) => void - ): Promise | void { - const command = new RegisterDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers a new workflow type and its configuration settings in - * the specified domain.

- *

The retention period for the workflow history is set by the RegisterDomain action.

- * - *

If the type already exists, then a TypeAlreadyExists fault is returned. - * You cannot change the configuration settings of a workflow type once it is registered and it - * must be registered as a new version.

- *
- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    Constrain the following parameters by using a Condition element with - * the appropriate keys.

    - *
      - *
    • - *

      - * defaultTaskList.name: String constraint. The key is - * swf:defaultTaskList.name.

      - *
    • - *
    • - *

      - * name: String constraint. The key is swf:name.

      - *
    • - *
    • - *

      - * version: String constraint. The key is - * swf:version.

      - *
    • - *
    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link RegisterWorkflowTypeCommand} */ - public registerWorkflowType( + registerWorkflowType( args: RegisterWorkflowTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerWorkflowType( + registerWorkflowType( args: RegisterWorkflowTypeCommandInput, cb: (err: any, data?: RegisterWorkflowTypeCommandOutput) => void ): void; - public registerWorkflowType( + registerWorkflowType( args: RegisterWorkflowTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterWorkflowTypeCommandOutput) => void ): void; - public registerWorkflowType( - args: RegisterWorkflowTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterWorkflowTypeCommandOutput) => void), - cb?: (err: any, data?: RegisterWorkflowTypeCommandOutput) => void - ): Promise | void { - const command = new RegisterWorkflowTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Records a WorkflowExecutionCancelRequested event in the currently running - * workflow execution identified by the given domain, workflowId, and runId. This logically - * requests the cancellation of the workflow execution as a whole. It is up to the decider to - * take appropriate actions when it receives an execution history with this event.

- * - * - *

If the runId isn't specified, the WorkflowExecutionCancelRequested event - * is recorded in the history of the current open workflow execution with the specified - * workflowId in the domain.

- *
- * - * - *

Because this action allows the workflow to properly clean up and gracefully close, it - * should be used instead of TerminateWorkflowExecution when - * possible.

- *
- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    You cannot use an IAM policy to constrain this action's parameters.

    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link RequestCancelWorkflowExecutionCommand} */ - public requestCancelWorkflowExecution( + requestCancelWorkflowExecution( args: RequestCancelWorkflowExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public requestCancelWorkflowExecution( + requestCancelWorkflowExecution( args: RequestCancelWorkflowExecutionCommandInput, cb: (err: any, data?: RequestCancelWorkflowExecutionCommandOutput) => void ): void; - public requestCancelWorkflowExecution( + requestCancelWorkflowExecution( args: RequestCancelWorkflowExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RequestCancelWorkflowExecutionCommandOutput) => void ): void; - public requestCancelWorkflowExecution( - args: RequestCancelWorkflowExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RequestCancelWorkflowExecutionCommandOutput) => void), - cb?: (err: any, data?: RequestCancelWorkflowExecutionCommandOutput) => void - ): Promise | void { - const command = new RequestCancelWorkflowExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used by workers to tell the service that the ActivityTask identified - * by the taskToken was successfully canceled. Additional details can - * be provided using the details argument.

- * - *

These details (if provided) appear in the - * ActivityTaskCanceled event added to the workflow history.

- * - * - *

Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the - * activity can be safely undone or abandoned.

- *
- * - *

A task is considered open from the time that it is scheduled until it is closed. - * Therefore a task is reported as open while a worker is processing it. A task is closed after - * it has been specified in a call to RespondActivityTaskCompleted, - * RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has - * timed - * out.

- * - *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    You cannot use an IAM policy to constrain this action's parameters.

    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link RespondActivityTaskCanceledCommand} */ - public respondActivityTaskCanceled( + respondActivityTaskCanceled( args: RespondActivityTaskCanceledCommandInput, options?: __HttpHandlerOptions ): Promise; - public respondActivityTaskCanceled( + respondActivityTaskCanceled( args: RespondActivityTaskCanceledCommandInput, cb: (err: any, data?: RespondActivityTaskCanceledCommandOutput) => void ): void; - public respondActivityTaskCanceled( + respondActivityTaskCanceled( args: RespondActivityTaskCanceledCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RespondActivityTaskCanceledCommandOutput) => void ): void; - public respondActivityTaskCanceled( - args: RespondActivityTaskCanceledCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RespondActivityTaskCanceledCommandOutput) => void), - cb?: (err: any, data?: RespondActivityTaskCanceledCommandOutput) => void - ): Promise | void { - const command = new RespondActivityTaskCanceledCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used by workers to tell the service that the ActivityTask identified - * by the taskToken completed successfully with a result (if provided). - * The result appears in the ActivityTaskCompleted event in the - * workflow history.

- * - * - *

If the requested task doesn't complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is - * canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call - * RespondActivityTaskCanceled.

- *
- * - *

A task is considered open from the time that it is scheduled until it is closed. - * Therefore a task is reported as open while a worker is processing it. A task is closed after - * it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the - * task has timed - * out.

- * - *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    You cannot use an IAM policy to constrain this action's parameters.

    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link RespondActivityTaskCompletedCommand} */ - public respondActivityTaskCompleted( + respondActivityTaskCompleted( args: RespondActivityTaskCompletedCommandInput, options?: __HttpHandlerOptions ): Promise; - public respondActivityTaskCompleted( + respondActivityTaskCompleted( args: RespondActivityTaskCompletedCommandInput, cb: (err: any, data?: RespondActivityTaskCompletedCommandOutput) => void ): void; - public respondActivityTaskCompleted( + respondActivityTaskCompleted( args: RespondActivityTaskCompletedCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RespondActivityTaskCompletedCommandOutput) => void ): void; - public respondActivityTaskCompleted( - args: RespondActivityTaskCompletedCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RespondActivityTaskCompletedCommandOutput) => void), - cb?: (err: any, data?: RespondActivityTaskCompletedCommandOutput) => void - ): Promise | void { - const command = new RespondActivityTaskCompletedCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used by workers to tell the service that the ActivityTask identified - * by the taskToken has failed with reason (if specified). The - * reason and details appear in the ActivityTaskFailed - * event added to the workflow history.

- * - *

A task is considered open from the time that it is scheduled until it is closed. - * Therefore a task is reported as open while a worker is processing it. A task is closed after - * it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed - * out.

- * - *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    You cannot use an IAM policy to constrain this action's parameters.

    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link RespondActivityTaskFailedCommand} */ - public respondActivityTaskFailed( + respondActivityTaskFailed( args: RespondActivityTaskFailedCommandInput, options?: __HttpHandlerOptions ): Promise; - public respondActivityTaskFailed( + respondActivityTaskFailed( args: RespondActivityTaskFailedCommandInput, cb: (err: any, data?: RespondActivityTaskFailedCommandOutput) => void ): void; - public respondActivityTaskFailed( + respondActivityTaskFailed( args: RespondActivityTaskFailedCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RespondActivityTaskFailedCommandOutput) => void ): void; - public respondActivityTaskFailed( - args: RespondActivityTaskFailedCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RespondActivityTaskFailedCommandOutput) => void), - cb?: (err: any, data?: RespondActivityTaskFailedCommandOutput) => void - ): Promise | void { - const command = new RespondActivityTaskFailedCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used by deciders to tell the service that the DecisionTask identified - * by the taskToken has successfully completed. The decisions argument - * specifies the list of decisions made while processing the task.

- * - *

A DecisionTaskCompleted event is added to the workflow history. The - * executionContext specified is attached to the event in the workflow execution - * history.

- * - *

- * Access Control - *

- * - *

If an IAM policy grants permission to use RespondDecisionTaskCompleted, it - * can express permissions for the list of decisions in the decisions parameter. - * Each of the decisions has one or more parameters, much like a regular API call. To allow for - * policies to be as readable as possible, you can express permissions on decisions as if they - * were actual API calls, including applying conditions to some parameters. For more information, - * see Using - * IAM to Manage Access to Amazon SWF Workflows in the - * Amazon SWF Developer Guide.

+ * @see {@link RespondDecisionTaskCompletedCommand} */ - public respondDecisionTaskCompleted( + respondDecisionTaskCompleted( args: RespondDecisionTaskCompletedCommandInput, options?: __HttpHandlerOptions ): Promise; - public respondDecisionTaskCompleted( + respondDecisionTaskCompleted( args: RespondDecisionTaskCompletedCommandInput, cb: (err: any, data?: RespondDecisionTaskCompletedCommandOutput) => void ): void; - public respondDecisionTaskCompleted( + respondDecisionTaskCompleted( args: RespondDecisionTaskCompletedCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RespondDecisionTaskCompletedCommandOutput) => void ): void; - public respondDecisionTaskCompleted( - args: RespondDecisionTaskCompletedCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RespondDecisionTaskCompletedCommandOutput) => void), - cb?: (err: any, data?: RespondDecisionTaskCompletedCommandOutput) => void - ): Promise | void { - const command = new RespondDecisionTaskCompletedCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Records a WorkflowExecutionSignaled event in the workflow execution - * history and creates a decision task for the workflow execution identified by the given domain, - * workflowId and runId. The event is recorded with the specified user defined signalName and - * input (if provided).

- * - * - *

If a runId isn't specified, then the WorkflowExecutionSignaled event is - * recorded in the history of the current open workflow with the matching workflowId in the - * domain.

- *
- * - * - *

If the specified workflow execution isn't open, this method fails with - * UnknownResource.

- *
- * - *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    You cannot use an IAM policy to constrain this action's parameters.

    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link SignalWorkflowExecutionCommand} */ - public signalWorkflowExecution( + signalWorkflowExecution( args: SignalWorkflowExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public signalWorkflowExecution( + signalWorkflowExecution( args: SignalWorkflowExecutionCommandInput, cb: (err: any, data?: SignalWorkflowExecutionCommandOutput) => void ): void; - public signalWorkflowExecution( + signalWorkflowExecution( args: SignalWorkflowExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SignalWorkflowExecutionCommandOutput) => void ): void; - public signalWorkflowExecution( - args: SignalWorkflowExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SignalWorkflowExecutionCommandOutput) => void), - cb?: (err: any, data?: SignalWorkflowExecutionCommandOutput) => void - ): Promise | void { - const command = new SignalWorkflowExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts an execution of the workflow type in the specified domain using the provided - * workflowId and input data.

- * - *

This action returns the newly started workflow execution.

- * - *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    Constrain the following parameters by using a Condition element with - * the appropriate keys.

    - *
      - *
    • - *

      - * tagList.member.0: The key is swf:tagList.member.0.

      - *
    • - *
    • - *

      - * tagList.member.1: The key is swf:tagList.member.1.

      - *
    • - *
    • - *

      - * tagList.member.2: The key is swf:tagList.member.2.

      - *
    • - *
    • - *

      - * tagList.member.3: The key is swf:tagList.member.3.

      - *
    • - *
    • - *

      - * tagList.member.4: The key is swf:tagList.member.4.

      - *
    • - *
    • - *

      - * taskList: String constraint. The key is - * swf:taskList.name.

      - *
    • - *
    • - *

      - * workflowType.name: String constraint. The key is - * swf:workflowType.name.

      - *
    • - *
    • - *

      - * workflowType.version: String constraint. The key is - * swf:workflowType.version.

      - *
    • - *
    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link StartWorkflowExecutionCommand} */ - public startWorkflowExecution( + startWorkflowExecution( args: StartWorkflowExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startWorkflowExecution( + startWorkflowExecution( args: StartWorkflowExecutionCommandInput, cb: (err: any, data?: StartWorkflowExecutionCommandOutput) => void ): void; - public startWorkflowExecution( + startWorkflowExecution( args: StartWorkflowExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartWorkflowExecutionCommandOutput) => void ): void; - public startWorkflowExecution( - args: StartWorkflowExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartWorkflowExecutionCommandOutput) => void), - cb?: (err: any, data?: StartWorkflowExecutionCommandOutput) => void - ): Promise | void { - const command = new StartWorkflowExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Add a tag to a Amazon SWF domain.

- * - *

Amazon SWF supports a maximum of 50 tags per resource.

- *
+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Records a WorkflowExecutionTerminated event and forces closure of the - * workflow execution identified by the given domain, runId, and workflowId. The child policy, - * registered with the workflow type or specified when starting this execution, is applied to any - * open child workflow executions of this workflow execution.

- * - * - *

If the identified workflow execution was in progress, it is terminated - * immediately.

- *
- * - * - *

If a runId isn't specified, then the WorkflowExecutionTerminated event - * is recorded in the history of the current open workflow with the matching workflowId in the - * domain.

- *
- * - * - *

You should consider using RequestCancelWorkflowExecution action - * instead because it allows the workflow to gracefully close while TerminateWorkflowExecution doesn't.

- *
- * - *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    You cannot use an IAM policy to constrain this action's parameters.

    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link TerminateWorkflowExecutionCommand} */ - public terminateWorkflowExecution( + terminateWorkflowExecution( args: TerminateWorkflowExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public terminateWorkflowExecution( + terminateWorkflowExecution( args: TerminateWorkflowExecutionCommandInput, cb: (err: any, data?: TerminateWorkflowExecutionCommandOutput) => void ): void; - public terminateWorkflowExecution( + terminateWorkflowExecution( args: TerminateWorkflowExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TerminateWorkflowExecutionCommandOutput) => void ): void; - public terminateWorkflowExecution( - args: TerminateWorkflowExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TerminateWorkflowExecutionCommandOutput) => void), - cb?: (err: any, data?: TerminateWorkflowExecutionCommandOutput) => void - ): Promise | void { - const command = new TerminateWorkflowExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Undeprecates a previously deprecated activity type. After an activity type has - * been undeprecated, you can create new tasks of that activity type.

- * - *

This operation is eventually consistent. The results are best effort and may not - * exactly reflect recent updates and changes.

- *
- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    Constrain the following parameters by using a Condition element with - * the appropriate keys.

    - *
      - *
    • - *

      - * activityType.name: String constraint. The key is - * swf:activityType.name.

      - *
    • - *
    • - *

      - * activityType.version: String constraint. The key is - * swf:activityType.version.

      - *
    • - *
    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link UndeprecateActivityTypeCommand} */ - public undeprecateActivityType( + undeprecateActivityType( args: UndeprecateActivityTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public undeprecateActivityType( + undeprecateActivityType( args: UndeprecateActivityTypeCommandInput, cb: (err: any, data?: UndeprecateActivityTypeCommandOutput) => void ): void; - public undeprecateActivityType( + undeprecateActivityType( args: UndeprecateActivityTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UndeprecateActivityTypeCommandOutput) => void ): void; - public undeprecateActivityType( - args: UndeprecateActivityTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UndeprecateActivityTypeCommandOutput) => void), - cb?: (err: any, data?: UndeprecateActivityTypeCommandOutput) => void - ): Promise | void { - const command = new UndeprecateActivityTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Undeprecates a previously deprecated domain. After a domain has been undeprecated it can be used - * to create new workflow executions or register new types.

- * - *

This operation is eventually consistent. The results are best effort and may not - * exactly reflect recent updates and changes.

- *
- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    You cannot use an IAM policy to constrain this action's parameters.

    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link UndeprecateDomainCommand} */ - public undeprecateDomain( + undeprecateDomain( args: UndeprecateDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public undeprecateDomain( + undeprecateDomain( args: UndeprecateDomainCommandInput, cb: (err: any, data?: UndeprecateDomainCommandOutput) => void ): void; - public undeprecateDomain( + undeprecateDomain( args: UndeprecateDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UndeprecateDomainCommandOutput) => void ): void; - public undeprecateDomain( - args: UndeprecateDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UndeprecateDomainCommandOutput) => void), - cb?: (err: any, data?: UndeprecateDomainCommandOutput) => void - ): Promise | void { - const command = new UndeprecateDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Undeprecates a previously deprecated workflow type. After a workflow type has - * been undeprecated, you can create new executions of that type.

- * - *

This operation is eventually consistent. The results are best effort and may not - * exactly reflect recent updates and changes.

- *
- *

- * Access Control - *

- *

You can use IAM policies to control this action's access to Amazon SWF resources as - * follows:

- *
    - *
  • - *

    Use a Resource element with the domain name to limit the action to - * only specified domains.

    - *
  • - *
  • - *

    Use an Action element to allow or deny permission to call this - * action.

    - *
  • - *
  • - *

    Constrain the following parameters by using a Condition element with - * the appropriate keys.

    - *
      - *
    • - *

      - * workflowType.name: String constraint. The key is - * swf:workflowType.name.

      - *
    • - *
    • - *

      - * workflowType.version: String constraint. The key is - * swf:workflowType.version.

      - *
    • - *
    - *
  • - *
- *

If the caller doesn't have sufficient permissions to invoke the action, or the - * parameter values fall outside the specified constraints, the action fails. The associated - * event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. - * For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF - * Workflows in the Amazon SWF Developer Guide.

+ * @see {@link UndeprecateWorkflowTypeCommand} */ - public undeprecateWorkflowType( + undeprecateWorkflowType( args: UndeprecateWorkflowTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public undeprecateWorkflowType( + undeprecateWorkflowType( args: UndeprecateWorkflowTypeCommandInput, cb: (err: any, data?: UndeprecateWorkflowTypeCommandOutput) => void ): void; - public undeprecateWorkflowType( + undeprecateWorkflowType( args: UndeprecateWorkflowTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UndeprecateWorkflowTypeCommandOutput) => void ): void; - public undeprecateWorkflowType( - args: UndeprecateWorkflowTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UndeprecateWorkflowTypeCommandOutput) => void), - cb?: (err: any, data?: UndeprecateWorkflowTypeCommandOutput) => void - ): Promise | void { - const command = new UndeprecateWorkflowTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Remove a tag from a Amazon SWF domain.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Simple Workflow Service + * + *

The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to + * coordinate work across distributed components. In Amazon SWF, a task + * represents a logical unit of work that is performed by a component of your workflow. + * Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and + * concurrency in accordance with the logical flow of the application.

+ * + *

Amazon SWF gives you full control over implementing tasks and coordinating them without + * worrying about underlying complexities such as tracking their progress and maintaining their + * state.

+ * + *

This documentation serves as reference only. For a broader overview of the Amazon SWF + * programming model, see the + * Amazon SWF Developer Guide + * .

+ */ +export class SWF extends SWFClient implements SWF {} +createAggregatedClient(commands, SWF); diff --git a/clients/client-synthetics/src/Synthetics.ts b/clients/client-synthetics/src/Synthetics.ts index 8fa81b1895f5..b2de18c214ca 100644 --- a/clients/client-synthetics/src/Synthetics.ts +++ b/clients/client-synthetics/src/Synthetics.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -74,771 +75,331 @@ import { UpdateCanaryCommandInput, UpdateCanaryCommandOutput, } from "./commands/UpdateCanaryCommand"; -import { SyntheticsClient } from "./SyntheticsClient"; +import { SyntheticsClient, SyntheticsClientConfig } from "./SyntheticsClient"; -/** - * @public - * Amazon CloudWatch Synthetics - *

You can use Amazon CloudWatch Synthetics to continually monitor your services. You can - * create and manage canaries, which are modular, lightweight scripts - * that monitor your endpoints and APIs - * from the outside-in. You can set up your canaries to run - * 24 hours a day, once per minute. The canaries help you check the availability and latency - * of your web services and troubleshoot anomalies by investigating load time data, - * screenshots of the UI, logs, and metrics. The canaries seamlessly integrate with CloudWatch - * ServiceLens to help you trace the causes of impacted nodes in your applications. For more - * information, see Using ServiceLens to Monitor - * the Health of Your Applications in the Amazon CloudWatch User - * Guide.

- * - *

Before you create and manage canaries, be aware of the security considerations. For more - * information, see Security - * Considerations for Synthetics Canaries.

- */ -export class Synthetics extends SyntheticsClient { +const commands = { + AssociateResourceCommand, + CreateCanaryCommand, + CreateGroupCommand, + DeleteCanaryCommand, + DeleteGroupCommand, + DescribeCanariesCommand, + DescribeCanariesLastRunCommand, + DescribeRuntimeVersionsCommand, + DisassociateResourceCommand, + GetCanaryCommand, + GetCanaryRunsCommand, + GetGroupCommand, + ListAssociatedGroupsCommand, + ListGroupResourcesCommand, + ListGroupsCommand, + ListTagsForResourceCommand, + StartCanaryCommand, + StopCanaryCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateCanaryCommand, +}; + +export interface Synthetics { /** - * @public - *

Associates a canary with a group. Using groups can help you with - * managing and automating your canaries, and you can also view aggregated run results and statistics - * for all canaries in a group.

- *

You must run this operation in the Region where the canary exists.

+ * @see {@link AssociateResourceCommand} */ - public associateResource( + associateResource( args: AssociateResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateResource( + associateResource( args: AssociateResourceCommandInput, cb: (err: any, data?: AssociateResourceCommandOutput) => void ): void; - public associateResource( + associateResource( args: AssociateResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateResourceCommandOutput) => void ): void; - public associateResource( - args: AssociateResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateResourceCommandOutput) => void), - cb?: (err: any, data?: AssociateResourceCommandOutput) => void - ): Promise | void { - const command = new AssociateResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the - * outside-in. Canaries help you check the availability and latency of your web services and - * troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and - * metrics. You can set up a canary to run continuously or just once.

- *

Do not use CreateCanary to modify an existing canary. Use UpdateCanary instead.

- *

To create canaries, you must have the CloudWatchSyntheticsFullAccess policy. - * If you are creating a new IAM role for the canary, you also need the - * iam:CreateRole, iam:CreatePolicy and - * iam:AttachRolePolicy permissions. For more information, see Necessary - * Roles and Permissions.

- *

Do not include secrets or proprietary information in your canary names. The canary name - * makes up part of the Amazon Resource Name (ARN) for the canary, and the ARN is included in - * outbound calls over the internet. For more information, see Security - * Considerations for Synthetics Canaries.

+ * @see {@link CreateCanaryCommand} */ - public createCanary( - args: CreateCanaryCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createCanary(args: CreateCanaryCommandInput, cb: (err: any, data?: CreateCanaryCommandOutput) => void): void; - public createCanary( + createCanary(args: CreateCanaryCommandInput, options?: __HttpHandlerOptions): Promise; + createCanary(args: CreateCanaryCommandInput, cb: (err: any, data?: CreateCanaryCommandOutput) => void): void; + createCanary( args: CreateCanaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCanaryCommandOutput) => void ): void; - public createCanary( - args: CreateCanaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCanaryCommandOutput) => void), - cb?: (err: any, data?: CreateCanaryCommandOutput) => void - ): Promise | void { - const command = new CreateCanaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a group which you can use to associate canaries with each other, including cross-Region - * canaries. Using groups can help you with - * managing and automating your canaries, and you can also view aggregated run results and statistics - * for all canaries in a group.

- *

Groups are global resources. When you create a group, it is replicated across Amazon Web Services Regions, and - * you can view it and add canaries to it from any Region. - * Although the group ARN format reflects the Region name where it was created, a group is not constrained to any Region. - * This means that you can put canaries from multiple Regions into the same group, and then use - * that group to view and manage all of those canaries in a single view.

- *

Groups are supported in all Regions except the Regions that are disabled by default. For more information - * about these Regions, see Enabling a Region.

- *

Each group can contain as many as 10 canaries. You can have as many as 20 groups in your account. Any single canary - * can be a member of up to 10 groups.

+ * @see {@link CreateGroupCommand} */ - public createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void; - public createGroup( + createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise; + createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void; + createGroup( args: CreateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupCommandOutput) => void ): void; - public createGroup( - args: CreateGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGroupCommandOutput) => void), - cb?: (err: any, data?: CreateGroupCommandOutput) => void - ): Promise | void { - const command = new CreateGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Permanently deletes the specified canary.

- *

If you specify DeleteLambda to true, CloudWatch Synthetics also deletes - * the Lambda functions and layers that are used by the canary.

- *

Other resources used and created by the canary are not automatically deleted. - * After you delete a canary that you do not intend to - * use again, you - * should also delete the following:

- *
    - *
  • - *

    The CloudWatch alarms created for this canary. These alarms have a name of - * Synthetics-SharpDrop-Alarm-MyCanaryName - * .

    - *
  • - *
  • - *

    Amazon S3 objects and buckets, such as the canary's artifact location.

    - *
  • - *
  • - *

    IAM roles created for the canary. If they were created in the console, these roles - * have the name - * role/service-role/CloudWatchSyntheticsRole-MyCanaryName - * .

    - *
  • - *
  • - *

    CloudWatch Logs log groups created for the canary. These logs groups have the name - * /aws/lambda/cwsyn-MyCanaryName - * .

    - *
  • - *
- * - *

Before you delete a canary, you might want to use GetCanary to display - * the information about this canary. Make - * note of the information returned by this operation so that you can delete these resources - * after you delete the canary.

+ * @see {@link DeleteCanaryCommand} */ - public deleteCanary( - args: DeleteCanaryCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteCanary(args: DeleteCanaryCommandInput, cb: (err: any, data?: DeleteCanaryCommandOutput) => void): void; - public deleteCanary( + deleteCanary(args: DeleteCanaryCommandInput, options?: __HttpHandlerOptions): Promise; + deleteCanary(args: DeleteCanaryCommandInput, cb: (err: any, data?: DeleteCanaryCommandOutput) => void): void; + deleteCanary( args: DeleteCanaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCanaryCommandOutput) => void ): void; - public deleteCanary( - args: DeleteCanaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCanaryCommandOutput) => void), - cb?: (err: any, data?: DeleteCanaryCommandOutput) => void - ): Promise | void { - const command = new DeleteCanaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a group. The group doesn't need to be empty to be deleted. If there are canaries in the group, - * they are not deleted when you delete the group. - *

- *

Groups are a global resource that appear in all Regions, but the request to delete a group - * must be made from its home Region. You can find the home Region of a group within its ARN.

+ * @see {@link DeleteGroupCommand} */ - public deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void; - public deleteGroup( + deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise; + deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void; + deleteGroup( args: DeleteGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupCommandOutput) => void ): void; - public deleteGroup( - args: DeleteGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation returns a list of the canaries in your account, along with full details - * about each canary.

- *

This operation supports resource-level authorization using an IAM policy and - * the Names parameter. If you specify the Names parameter, the operation is successful only if you have authorization to view - * all the canaries that you specify in your request. If you do not have permission to view any of - * the canaries, the request fails with a 403 response.

- *

You are required to use the Names parameter if you are logged on to a user or role that has an - * IAM policy that restricts which canaries that you are allowed to view. For more information, - * see - * Limiting a user to viewing specific canaries.

+ * @see {@link DescribeCanariesCommand} */ - public describeCanaries( + describeCanaries( args: DescribeCanariesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCanaries( + describeCanaries( args: DescribeCanariesCommandInput, cb: (err: any, data?: DescribeCanariesCommandOutput) => void ): void; - public describeCanaries( + describeCanaries( args: DescribeCanariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCanariesCommandOutput) => void ): void; - public describeCanaries( - args: DescribeCanariesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCanariesCommandOutput) => void), - cb?: (err: any, data?: DescribeCanariesCommandOutput) => void - ): Promise | void { - const command = new DescribeCanariesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this operation to see information from the most recent run of each canary that you have created.

- * - *

This operation supports resource-level authorization using an IAM policy and - * the Names parameter. If you specify the Names parameter, the operation is successful only if you have authorization to view - * all the canaries that you specify in your request. If you do not have permission to view any of - * the canaries, the request fails with a 403 response.

- *

You are required to use the Names parameter if you are logged on to a user or role that has an - * IAM policy that restricts which canaries that you are allowed to view. For more information, - * see - * Limiting a user to viewing specific canaries.

+ * @see {@link DescribeCanariesLastRunCommand} */ - public describeCanariesLastRun( + describeCanariesLastRun( args: DescribeCanariesLastRunCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCanariesLastRun( + describeCanariesLastRun( args: DescribeCanariesLastRunCommandInput, cb: (err: any, data?: DescribeCanariesLastRunCommandOutput) => void ): void; - public describeCanariesLastRun( + describeCanariesLastRun( args: DescribeCanariesLastRunCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCanariesLastRunCommandOutput) => void ): void; - public describeCanariesLastRun( - args: DescribeCanariesLastRunCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCanariesLastRunCommandOutput) => void), - cb?: (err: any, data?: DescribeCanariesLastRunCommandOutput) => void - ): Promise | void { - const command = new DescribeCanariesLastRunCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of Synthetics canary runtime versions. For more information, - * see - * Canary Runtime Versions.

+ * @see {@link DescribeRuntimeVersionsCommand} */ - public describeRuntimeVersions( + describeRuntimeVersions( args: DescribeRuntimeVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRuntimeVersions( + describeRuntimeVersions( args: DescribeRuntimeVersionsCommandInput, cb: (err: any, data?: DescribeRuntimeVersionsCommandOutput) => void ): void; - public describeRuntimeVersions( + describeRuntimeVersions( args: DescribeRuntimeVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRuntimeVersionsCommandOutput) => void ): void; - public describeRuntimeVersions( - args: DescribeRuntimeVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRuntimeVersionsCommandOutput) => void), - cb?: (err: any, data?: DescribeRuntimeVersionsCommandOutput) => void - ): Promise | void { - const command = new DescribeRuntimeVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a canary from a group. You must run this operation in the Region where the canary exists.

+ * @see {@link DisassociateResourceCommand} */ - public disassociateResource( + disassociateResource( args: DisassociateResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateResource( + disassociateResource( args: DisassociateResourceCommandInput, cb: (err: any, data?: DisassociateResourceCommandOutput) => void ): void; - public disassociateResource( + disassociateResource( args: DisassociateResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateResourceCommandOutput) => void ): void; - public disassociateResource( - args: DisassociateResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateResourceCommandOutput) => void), - cb?: (err: any, data?: DisassociateResourceCommandOutput) => void - ): Promise | void { - const command = new DisassociateResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves complete information about one canary. You must specify - * the name of the canary that you want. To get a list of canaries - * and their names, use DescribeCanaries.

+ * @see {@link GetCanaryCommand} */ - public getCanary(args: GetCanaryCommandInput, options?: __HttpHandlerOptions): Promise; - public getCanary(args: GetCanaryCommandInput, cb: (err: any, data?: GetCanaryCommandOutput) => void): void; - public getCanary( + getCanary(args: GetCanaryCommandInput, options?: __HttpHandlerOptions): Promise; + getCanary(args: GetCanaryCommandInput, cb: (err: any, data?: GetCanaryCommandOutput) => void): void; + getCanary( args: GetCanaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCanaryCommandOutput) => void ): void; - public getCanary( - args: GetCanaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCanaryCommandOutput) => void), - cb?: (err: any, data?: GetCanaryCommandOutput) => void - ): Promise | void { - const command = new GetCanaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of runs for a specified canary.

+ * @see {@link GetCanaryRunsCommand} */ - public getCanaryRuns( - args: GetCanaryRunsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getCanaryRuns( - args: GetCanaryRunsCommandInput, - cb: (err: any, data?: GetCanaryRunsCommandOutput) => void - ): void; - public getCanaryRuns( + getCanaryRuns(args: GetCanaryRunsCommandInput, options?: __HttpHandlerOptions): Promise; + getCanaryRuns(args: GetCanaryRunsCommandInput, cb: (err: any, data?: GetCanaryRunsCommandOutput) => void): void; + getCanaryRuns( args: GetCanaryRunsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCanaryRunsCommandOutput) => void ): void; - public getCanaryRuns( - args: GetCanaryRunsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCanaryRunsCommandOutput) => void), - cb?: (err: any, data?: GetCanaryRunsCommandOutput) => void - ): Promise | void { - const command = new GetCanaryRunsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about one group. Groups are a global resource, so you can use this operation from - * any Region.

+ * @see {@link GetGroupCommand} */ - public getGroup(args: GetGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public getGroup(args: GetGroupCommandInput, cb: (err: any, data?: GetGroupCommandOutput) => void): void; - public getGroup( + getGroup(args: GetGroupCommandInput, options?: __HttpHandlerOptions): Promise; + getGroup(args: GetGroupCommandInput, cb: (err: any, data?: GetGroupCommandOutput) => void): void; + getGroup( args: GetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupCommandOutput) => void ): void; - public getGroup( - args: GetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGroupCommandOutput) => void), - cb?: (err: any, data?: GetGroupCommandOutput) => void - ): Promise | void { - const command = new GetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the groups that the specified canary is associated with. The canary - * that you specify must be in the current Region.

+ * @see {@link ListAssociatedGroupsCommand} */ - public listAssociatedGroups( + listAssociatedGroups( args: ListAssociatedGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssociatedGroups( + listAssociatedGroups( args: ListAssociatedGroupsCommandInput, cb: (err: any, data?: ListAssociatedGroupsCommandOutput) => void ): void; - public listAssociatedGroups( + listAssociatedGroups( args: ListAssociatedGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssociatedGroupsCommandOutput) => void ): void; - public listAssociatedGroups( - args: ListAssociatedGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssociatedGroupsCommandOutput) => void), - cb?: (err: any, data?: ListAssociatedGroupsCommandOutput) => void - ): Promise | void { - const command = new ListAssociatedGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

This operation returns a list of the ARNs of the canaries that are associated with the specified group.

+ * @see {@link ListGroupResourcesCommand} */ - public listGroupResources( + listGroupResources( args: ListGroupResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGroupResources( + listGroupResources( args: ListGroupResourcesCommandInput, cb: (err: any, data?: ListGroupResourcesCommandOutput) => void ): void; - public listGroupResources( + listGroupResources( args: ListGroupResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupResourcesCommandOutput) => void ): void; - public listGroupResources( - args: ListGroupResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGroupResourcesCommandOutput) => void), - cb?: (err: any, data?: ListGroupResourcesCommandOutput) => void - ): Promise | void { - const command = new ListGroupResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups - * from all Regions are returned.

+ * @see {@link ListGroupsCommand} */ - public listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise; - public listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void; - public listGroups( + listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise; + listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void; + listGroups( args: ListGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsCommandOutput) => void ): void; - public listGroups( - args: ListGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGroupsCommandOutput) => void), - cb?: (err: any, data?: ListGroupsCommandOutput) => void - ): Promise | void { - const command = new ListGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Displays the tags associated with a canary or group.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Use this operation to run a canary that has already been created. - * The frequency of the canary runs is determined by the value of the canary's Schedule. To see a canary's schedule, - * use GetCanary.

+ * @see {@link StartCanaryCommand} */ - public startCanary(args: StartCanaryCommandInput, options?: __HttpHandlerOptions): Promise; - public startCanary(args: StartCanaryCommandInput, cb: (err: any, data?: StartCanaryCommandOutput) => void): void; - public startCanary( + startCanary(args: StartCanaryCommandInput, options?: __HttpHandlerOptions): Promise; + startCanary(args: StartCanaryCommandInput, cb: (err: any, data?: StartCanaryCommandOutput) => void): void; + startCanary( args: StartCanaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCanaryCommandOutput) => void ): void; - public startCanary( - args: StartCanaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartCanaryCommandOutput) => void), - cb?: (err: any, data?: StartCanaryCommandOutput) => void - ): Promise | void { - const command = new StartCanaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops the canary to prevent all future runs. If the canary is currently running,the - * run that is in progress completes on its own, publishes metrics, and uploads artifacts, but - * it is not recorded in Synthetics as a completed run.

- *

You can use StartCanary to start it running again - * with the canary’s current schedule at any point in the future.

+ * @see {@link StopCanaryCommand} */ - public stopCanary(args: StopCanaryCommandInput, options?: __HttpHandlerOptions): Promise; - public stopCanary(args: StopCanaryCommandInput, cb: (err: any, data?: StopCanaryCommandOutput) => void): void; - public stopCanary( + stopCanary(args: StopCanaryCommandInput, options?: __HttpHandlerOptions): Promise; + stopCanary(args: StopCanaryCommandInput, cb: (err: any, data?: StopCanaryCommandOutput) => void): void; + stopCanary( args: StopCanaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopCanaryCommandOutput) => void ): void; - public stopCanary( - args: StopCanaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopCanaryCommandOutput) => void), - cb?: (err: any, data?: StopCanaryCommandOutput) => void - ): Promise | void { - const command = new StopCanaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns one or more tags (key-value pairs) to the specified canary or group.

- *

Tags can help you organize and categorize your - * resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with - * certain tag values.

- *

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

- *

You can use the TagResource action with a resource that already has tags. If you specify a new - * tag key for the resource, - * this tag is appended to the list of tags associated - * with the resource. If you specify a tag key that is already associated with the resource, the new tag - * value that you specify replaces - * the previous value for that tag.

- *

You can associate as many as 50 tags with a canary or group.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from the specified resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the configuration of a canary that has - * already been created.

- *

You can't use this operation to update the tags of an existing canary. To - * change the tags of an existing canary, use - * TagResource.

+ * @see {@link UpdateCanaryCommand} */ - public updateCanary( - args: UpdateCanaryCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateCanary(args: UpdateCanaryCommandInput, cb: (err: any, data?: UpdateCanaryCommandOutput) => void): void; - public updateCanary( + updateCanary(args: UpdateCanaryCommandInput, options?: __HttpHandlerOptions): Promise; + updateCanary(args: UpdateCanaryCommandInput, cb: (err: any, data?: UpdateCanaryCommandOutput) => void): void; + updateCanary( args: UpdateCanaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCanaryCommandOutput) => void ): void; - public updateCanary( - args: UpdateCanaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCanaryCommandOutput) => void), - cb?: (err: any, data?: UpdateCanaryCommandOutput) => void - ): Promise | void { - const command = new UpdateCanaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon CloudWatch Synthetics + *

You can use Amazon CloudWatch Synthetics to continually monitor your services. You can + * create and manage canaries, which are modular, lightweight scripts + * that monitor your endpoints and APIs + * from the outside-in. You can set up your canaries to run + * 24 hours a day, once per minute. The canaries help you check the availability and latency + * of your web services and troubleshoot anomalies by investigating load time data, + * screenshots of the UI, logs, and metrics. The canaries seamlessly integrate with CloudWatch + * ServiceLens to help you trace the causes of impacted nodes in your applications. For more + * information, see Using ServiceLens to Monitor + * the Health of Your Applications in the Amazon CloudWatch User + * Guide.

+ * + *

Before you create and manage canaries, be aware of the security considerations. For more + * information, see Security + * Considerations for Synthetics Canaries.

+ */ +export class Synthetics extends SyntheticsClient implements Synthetics {} +createAggregatedClient(commands, Synthetics); diff --git a/clients/client-textract/src/Textract.ts b/clients/client-textract/src/Textract.ts index e516940fd6ad..90140cb06b15 100644 --- a/clients/client-textract/src/Textract.ts +++ b/clients/client-textract/src/Textract.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -62,707 +63,240 @@ import { StartLendingAnalysisCommandInput, StartLendingAnalysisCommandOutput, } from "./commands/StartLendingAnalysisCommand"; -import { TextractClient } from "./TextractClient"; +import { TextractClient, TextractClientConfig } from "./TextractClient"; -/** - * @public - *

Amazon Textract detects and analyzes text in documents and converts it - * into machine-readable text. This is the API reference documentation for - * Amazon Textract.

- */ -export class Textract extends TextractClient { +const commands = { + AnalyzeDocumentCommand, + AnalyzeExpenseCommand, + AnalyzeIDCommand, + DetectDocumentTextCommand, + GetDocumentAnalysisCommand, + GetDocumentTextDetectionCommand, + GetExpenseAnalysisCommand, + GetLendingAnalysisCommand, + GetLendingAnalysisSummaryCommand, + StartDocumentAnalysisCommand, + StartDocumentTextDetectionCommand, + StartExpenseAnalysisCommand, + StartLendingAnalysisCommand, +}; + +export interface Textract { /** - * @public - *

Analyzes an input document for relationships between detected items.

- *

The types of information returned are as follows:

- *
    - *
  • - *

    Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY - * Block object and a VALUE Block object. For example, - * Name: Ana Silva Carolina contains a key and value. - * Name: is the key. Ana Silva Carolina is - * the value.

    - *
  • - *
  • - *

    Table and table cell data. A TABLE Block object contains information - * about a detected table. A CELL Block object is returned for each cell in - * a table.

    - *
  • - *
  • - *

    Lines and words of text. A LINE Block object contains one or more - * WORD Block objects. All lines and words that are detected in the - * document are returned (including text that doesn't have a relationship with the value - * of FeatureTypes).

    - *
  • - *
  • - *

    Signatures. A SIGNATURE Block object contains the location information - * of a signature in a document. If used in conjunction with forms or tables, a signature - * can be given a Key-Value pairing or be detected in the cell of a table.

    - *
  • - *
  • - *

    Query. A QUERY Block object contains the query text, alias and link to the - * associated Query results block object.

    - *
  • - *
  • - *

    Query Result. A QUERY_RESULT Block object contains the answer to the query and an - * ID that connects it to the query asked. This Block also contains a confidence - * score.

    - *
  • - *
- *

Selection elements such as check boxes and option buttons (radio buttons) can be - * detected in form data and in tables. A SELECTION_ELEMENT Block object contains - * information about a selection element, including the selection status.

- *

You can choose which type of analysis to perform by specifying the - * FeatureTypes list.

- *

The output is returned in a list of Block objects.

- *

- * AnalyzeDocument is a synchronous operation. To analyze documents - * asynchronously, use StartDocumentAnalysis.

- *

For more information, see Document Text - * Analysis.

+ * @see {@link AnalyzeDocumentCommand} */ - public analyzeDocument( + analyzeDocument( args: AnalyzeDocumentCommandInput, options?: __HttpHandlerOptions ): Promise; - public analyzeDocument( - args: AnalyzeDocumentCommandInput, - cb: (err: any, data?: AnalyzeDocumentCommandOutput) => void - ): void; - public analyzeDocument( + analyzeDocument(args: AnalyzeDocumentCommandInput, cb: (err: any, data?: AnalyzeDocumentCommandOutput) => void): void; + analyzeDocument( args: AnalyzeDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AnalyzeDocumentCommandOutput) => void ): void; - public analyzeDocument( - args: AnalyzeDocumentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AnalyzeDocumentCommandOutput) => void), - cb?: (err: any, data?: AnalyzeDocumentCommandOutput) => void - ): Promise | void { - const command = new AnalyzeDocumentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * AnalyzeExpense synchronously analyzes an input document for financially - * related relationships between text.

- *

Information is returned as ExpenseDocuments and seperated as - * follows:

- *
    - *
  • - *

    - * LineItemGroups- A data set containing LineItems which - * store information about the lines of text, such as an item purchased and its price on - * a receipt.

    - *
  • - *
  • - *

    - * SummaryFields- Contains all other information a receipt, such as - * header information or the vendors name.

    - *
  • - *
+ * @see {@link AnalyzeExpenseCommand} */ - public analyzeExpense( + analyzeExpense( args: AnalyzeExpenseCommandInput, options?: __HttpHandlerOptions ): Promise; - public analyzeExpense( - args: AnalyzeExpenseCommandInput, - cb: (err: any, data?: AnalyzeExpenseCommandOutput) => void - ): void; - public analyzeExpense( + analyzeExpense(args: AnalyzeExpenseCommandInput, cb: (err: any, data?: AnalyzeExpenseCommandOutput) => void): void; + analyzeExpense( args: AnalyzeExpenseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AnalyzeExpenseCommandOutput) => void ): void; - public analyzeExpense( - args: AnalyzeExpenseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AnalyzeExpenseCommandOutput) => void), - cb?: (err: any, data?: AnalyzeExpenseCommandOutput) => void - ): Promise | void { - const command = new AnalyzeExpenseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Analyzes identity documents for relevant information. This information is extracted and - * returned as IdentityDocumentFields, which records both the normalized field - * and value of the extracted text. Unlike other Amazon Textract operations, - * AnalyzeID doesn't return any Geometry data.

+ * @see {@link AnalyzeIDCommand} */ - public analyzeID(args: AnalyzeIDCommandInput, options?: __HttpHandlerOptions): Promise; - public analyzeID(args: AnalyzeIDCommandInput, cb: (err: any, data?: AnalyzeIDCommandOutput) => void): void; - public analyzeID( + analyzeID(args: AnalyzeIDCommandInput, options?: __HttpHandlerOptions): Promise; + analyzeID(args: AnalyzeIDCommandInput, cb: (err: any, data?: AnalyzeIDCommandOutput) => void): void; + analyzeID( args: AnalyzeIDCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AnalyzeIDCommandOutput) => void ): void; - public analyzeID( - args: AnalyzeIDCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AnalyzeIDCommandOutput) => void), - cb?: (err: any, data?: AnalyzeIDCommandOutput) => void - ): Promise | void { - const command = new AnalyzeIDCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Detects text in the input document. Amazon Textract can detect lines of text and the - * words that make up a line of text. The input document must be in one of the following image - * formats: JPEG, PNG, PDF, or TIFF. DetectDocumentText returns the detected - * text in an array of Block objects.

- *

Each document page has as an associated Block of type PAGE. Each PAGE Block object - * is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is - * a parent for each word that makes up the line. Words are represented by Block objects of type WORD.

- *

- * DetectDocumentText is a synchronous operation. To analyze documents - * asynchronously, use StartDocumentTextDetection.

- *

For more information, see Document Text Detection.

+ * @see {@link DetectDocumentTextCommand} */ - public detectDocumentText( + detectDocumentText( args: DetectDocumentTextCommandInput, options?: __HttpHandlerOptions ): Promise; - public detectDocumentText( + detectDocumentText( args: DetectDocumentTextCommandInput, cb: (err: any, data?: DetectDocumentTextCommandOutput) => void ): void; - public detectDocumentText( + detectDocumentText( args: DetectDocumentTextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectDocumentTextCommandOutput) => void ): void; - public detectDocumentText( - args: DetectDocumentTextCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectDocumentTextCommandOutput) => void), - cb?: (err: any, data?: DetectDocumentTextCommandOutput) => void - ): Promise | void { - const command = new DetectDocumentTextCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the results for an Amazon Textract asynchronous operation that analyzes text in a - * document.

- *

You start asynchronous text analysis by calling StartDocumentAnalysis, - * which returns a job identifier (JobId). When the text analysis operation - * finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic - * that's registered in the initial call to StartDocumentAnalysis. To get the - * results of the text-detection operation, first check that the status value published to the - * Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and - * pass the job identifier (JobId) from the initial call to - * StartDocumentAnalysis.

- *

- * GetDocumentAnalysis returns an array of Block objects. - * The following types of information are returned:

- *
    - *
  • - *

    Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY - * Block object and a VALUE Block object. For example, - * Name: Ana Silva Carolina contains a key and value. - * Name: is the key. Ana Silva Carolina is - * the value.

    - *
  • - *
  • - *

    Table and table cell data. A TABLE Block object contains information - * about a detected table. A CELL Block object is returned for each cell in - * a table.

    - *
  • - *
  • - *

    Lines and words of text. A LINE Block object contains one or more - * WORD Block objects. All lines and words that are detected in the - * document are returned (including text that doesn't have a relationship with the value - * of the StartDocumentAnalysis - * FeatureTypes input parameter).

    - *
  • - *
  • - *

    Query. A QUERY Block object contains the query text, alias and link to the - * associated Query results block object.

    - *
  • - *
  • - *

    Query Results. A QUERY_RESULT Block object contains the answer to the query and an - * ID that connects it to the query asked. This Block also contains a confidence - * score.

    - *
  • - *
- * - *

While processing a document with queries, look out for - * INVALID_REQUEST_PARAMETERS output. This indicates that either the per - * page query limit has been exceeded or that the operation is trying to query a page in - * the document which doesn’t exist.

- *
- *

Selection elements such as check boxes and option buttons (radio buttons) can be - * detected in form data and in tables. A SELECTION_ELEMENT Block object contains - * information about a selection element, including the selection status.

- *

Use the MaxResults parameter to limit the number of blocks that are - * returned. If there are more results than specified in MaxResults, the value of - * NextToken in the operation response contains a pagination token for getting - * the next set of results. To get the next page of results, call - * GetDocumentAnalysis, and populate the NextToken request - * parameter with the token value that's returned from the previous call to - * GetDocumentAnalysis.

- *

For more information, see Document Text - * Analysis.

+ * @see {@link GetDocumentAnalysisCommand} */ - public getDocumentAnalysis( + getDocumentAnalysis( args: GetDocumentAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDocumentAnalysis( + getDocumentAnalysis( args: GetDocumentAnalysisCommandInput, cb: (err: any, data?: GetDocumentAnalysisCommandOutput) => void ): void; - public getDocumentAnalysis( + getDocumentAnalysis( args: GetDocumentAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentAnalysisCommandOutput) => void ): void; - public getDocumentAnalysis( - args: GetDocumentAnalysisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDocumentAnalysisCommandOutput) => void), - cb?: (err: any, data?: GetDocumentAnalysisCommandOutput) => void - ): Promise | void { - const command = new GetDocumentAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the results for an Amazon Textract asynchronous operation that detects text in a document. - * Amazon Textract can detect lines of text and the words that make up a line of text.

- *

You start asynchronous text detection by calling StartDocumentTextDetection, which returns a job identifier - * (JobId). When the text detection operation finishes, Amazon Textract publishes a - * completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to - * StartDocumentTextDetection. To get the results of the text-detection - * operation, first check that the status value published to the Amazon SNS topic is - * SUCCEEDED. If so, call GetDocumentTextDetection, and pass the - * job identifier (JobId) from the initial call to - * StartDocumentTextDetection.

- *

- * GetDocumentTextDetection returns an array of Block - * objects.

- *

Each document page has as an associated Block of type PAGE. Each PAGE Block object - * is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is - * a parent for each word that makes up the line. Words are represented by Block objects of type WORD.

- *

Use the MaxResults parameter to limit the number of blocks that are returned. If there - * are more results than specified in MaxResults, the value of - * NextToken in the operation response contains a pagination token for getting - * the next set of results. To get the next page of results, call - * GetDocumentTextDetection, and populate the NextToken request - * parameter with the token value that's returned from the previous call to - * GetDocumentTextDetection.

- *

For more information, see Document Text Detection.

+ * @see {@link GetDocumentTextDetectionCommand} */ - public getDocumentTextDetection( + getDocumentTextDetection( args: GetDocumentTextDetectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDocumentTextDetection( + getDocumentTextDetection( args: GetDocumentTextDetectionCommandInput, cb: (err: any, data?: GetDocumentTextDetectionCommandOutput) => void ): void; - public getDocumentTextDetection( + getDocumentTextDetection( args: GetDocumentTextDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentTextDetectionCommandOutput) => void ): void; - public getDocumentTextDetection( - args: GetDocumentTextDetectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDocumentTextDetectionCommandOutput) => void), - cb?: (err: any, data?: GetDocumentTextDetectionCommandOutput) => void - ): Promise | void { - const command = new GetDocumentTextDetectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and - * receipts. Amazon Textract finds contact information, items purchased, and vendor name, from input - * invoices and receipts.

- *

You start asynchronous invoice/receipt analysis by calling StartExpenseAnalysis, which returns a job identifier (JobId). Upon - * completion of the invoice/receipt analysis, Amazon Textract publishes the completion status to the - * Amazon Simple Notification Service (Amazon SNS) topic. This topic must be registered in the initial call to - * StartExpenseAnalysis. To get the results of the invoice/receipt analysis operation, - * first ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, - * call GetExpenseAnalysis, and pass the job identifier (JobId) from the - * initial call to StartExpenseAnalysis.

- *

Use the MaxResults parameter to limit the number of blocks that are returned. If there are - * more results than specified in MaxResults, the value of NextToken in - * the operation response contains a pagination token for getting the next set of results. To get - * the next page of results, call GetExpenseAnalysis, and populate the - * NextToken request parameter with the token value that's returned from the previous - * call to GetExpenseAnalysis.

- *

For more information, see Analyzing Invoices and Receipts.

+ * @see {@link GetExpenseAnalysisCommand} */ - public getExpenseAnalysis( + getExpenseAnalysis( args: GetExpenseAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public getExpenseAnalysis( + getExpenseAnalysis( args: GetExpenseAnalysisCommandInput, cb: (err: any, data?: GetExpenseAnalysisCommandOutput) => void ): void; - public getExpenseAnalysis( + getExpenseAnalysis( args: GetExpenseAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExpenseAnalysisCommandOutput) => void ): void; - public getExpenseAnalysis( - args: GetExpenseAnalysisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetExpenseAnalysisCommandOutput) => void), - cb?: (err: any, data?: GetExpenseAnalysisCommandOutput) => void - ): Promise | void { - const command = new GetExpenseAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the results for an Amazon Textract asynchronous operation that analyzes text in a - * lending document.

- *

You start asynchronous text analysis by calling StartLendingAnalysis, - * which returns a job identifier (JobId). When the text analysis operation - * finishes, Amazon Textract publishes a completion status to the Amazon Simple - * Notification Service (Amazon SNS) topic that's registered in the initial call to - * StartLendingAnalysis.

- *

To get the results of the text analysis operation, first check that the status value - * published to the Amazon SNS topic is SUCCEEDED. If so, call GetLendingAnalysis, and pass - * the job identifier (JobId) from the initial call to - * StartLendingAnalysis.

+ * @see {@link GetLendingAnalysisCommand} */ - public getLendingAnalysis( + getLendingAnalysis( args: GetLendingAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLendingAnalysis( + getLendingAnalysis( args: GetLendingAnalysisCommandInput, cb: (err: any, data?: GetLendingAnalysisCommandOutput) => void ): void; - public getLendingAnalysis( + getLendingAnalysis( args: GetLendingAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLendingAnalysisCommandOutput) => void ): void; - public getLendingAnalysis( - args: GetLendingAnalysisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLendingAnalysisCommandOutput) => void), - cb?: (err: any, data?: GetLendingAnalysisCommandOutput) => void - ): Promise | void { - const command = new GetLendingAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets summarized results for the StartLendingAnalysis operation, which analyzes - * text in a lending document. The returned summary consists of information about documents grouped - * together by a common document type. Information like detected signatures, page numbers, and split - * documents is returned with respect to the type of grouped document.

- *

You start asynchronous text analysis by calling StartLendingAnalysis, which - * returns a job identifier (JobId). When the text analysis operation finishes, Amazon - * Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) - * topic that's registered in the initial call to StartLendingAnalysis.

- *

To get the results of the text analysis operation, first check that the status value - * published to the Amazon SNS topic is SUCCEEDED. If so, call - * GetLendingAnalysisSummary, and pass the job identifier (JobId) from - * the initial call to StartLendingAnalysis.

+ * @see {@link GetLendingAnalysisSummaryCommand} */ - public getLendingAnalysisSummary( + getLendingAnalysisSummary( args: GetLendingAnalysisSummaryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLendingAnalysisSummary( + getLendingAnalysisSummary( args: GetLendingAnalysisSummaryCommandInput, cb: (err: any, data?: GetLendingAnalysisSummaryCommandOutput) => void ): void; - public getLendingAnalysisSummary( + getLendingAnalysisSummary( args: GetLendingAnalysisSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLendingAnalysisSummaryCommandOutput) => void ): void; - public getLendingAnalysisSummary( - args: GetLendingAnalysisSummaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLendingAnalysisSummaryCommandOutput) => void), - cb?: (err: any, data?: GetLendingAnalysisSummaryCommandOutput) => void - ): Promise | void { - const command = new GetLendingAnalysisSummaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts the asynchronous analysis of an input document for relationships between detected - * items such as key-value pairs, tables, and selection elements.

- *

- * StartDocumentAnalysis can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The - * documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name - * of the document. - *

- *

- * StartDocumentAnalysis returns a job identifier - * (JobId) that you use to get the results of the operation. When text - * analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) - * topic that you specify in NotificationChannel. To get the results of the text - * analysis operation, first check that the status value published to the Amazon SNS topic is - * SUCCEEDED. If so, call GetDocumentAnalysis, and pass - * the job identifier (JobId) from the initial call to - * StartDocumentAnalysis.

- *

For more information, see Document Text Analysis.

+ * @see {@link StartDocumentAnalysisCommand} */ - public startDocumentAnalysis( + startDocumentAnalysis( args: StartDocumentAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDocumentAnalysis( + startDocumentAnalysis( args: StartDocumentAnalysisCommandInput, cb: (err: any, data?: StartDocumentAnalysisCommandOutput) => void ): void; - public startDocumentAnalysis( + startDocumentAnalysis( args: StartDocumentAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDocumentAnalysisCommandOutput) => void ): void; - public startDocumentAnalysis( - args: StartDocumentAnalysisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDocumentAnalysisCommandOutput) => void), - cb?: (err: any, data?: StartDocumentAnalysisCommandOutput) => void - ): Promise | void { - const command = new StartDocumentAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of - * text and the words that make up a line of text.

- *

- * StartDocumentTextDetection can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The - * documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name - * of the document. - *

- *

- * StartTextDetection returns a job identifier - * (JobId) that you use to get the results of the operation. When text - * detection is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) - * topic that you specify in NotificationChannel. To get the results of the text - * detection operation, first check that the status value published to the Amazon SNS topic is - * SUCCEEDED. If so, call GetDocumentTextDetection, and - * pass the job identifier (JobId) from the initial call to - * StartDocumentTextDetection.

- *

For more information, see Document Text Detection.

+ * @see {@link StartDocumentTextDetectionCommand} */ - public startDocumentTextDetection( + startDocumentTextDetection( args: StartDocumentTextDetectionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startDocumentTextDetection( + startDocumentTextDetection( args: StartDocumentTextDetectionCommandInput, cb: (err: any, data?: StartDocumentTextDetectionCommandOutput) => void ): void; - public startDocumentTextDetection( + startDocumentTextDetection( args: StartDocumentTextDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDocumentTextDetectionCommandOutput) => void ): void; - public startDocumentTextDetection( - args: StartDocumentTextDetectionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDocumentTextDetectionCommandOutput) => void), - cb?: (err: any, data?: StartDocumentTextDetectionCommandOutput) => void - ): Promise | void { - const command = new StartDocumentTextDetectionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts the asynchronous analysis of invoices or receipts for data like contact information, - * items purchased, and vendor names.

- *

- * StartExpenseAnalysis can analyze text in documents that are in JPEG, PNG, and - * PDF format. The documents must be stored in an Amazon S3 bucket. Use the DocumentLocation parameter to specify the name of your S3 bucket and the name of the - * document in that bucket.

- *

- * StartExpenseAnalysis returns a job identifier (JobId) that you - * will provide to GetExpenseAnalysis to retrieve the results of the operation. When - * the analysis of the input invoices/receipts is finished, Amazon Textract publishes a completion - * status to the Amazon Simple Notification Service (Amazon SNS) topic that you provide to the NotificationChannel. - * To obtain the results of the invoice and receipt analysis operation, ensure that the status value - * published to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job identifier (JobId) that was - * returned by your call to StartExpenseAnalysis.

- *

For more information, see Analyzing Invoices and Receipts.

+ * @see {@link StartExpenseAnalysisCommand} */ - public startExpenseAnalysis( + startExpenseAnalysis( args: StartExpenseAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public startExpenseAnalysis( + startExpenseAnalysis( args: StartExpenseAnalysisCommandInput, cb: (err: any, data?: StartExpenseAnalysisCommandOutput) => void ): void; - public startExpenseAnalysis( + startExpenseAnalysis( args: StartExpenseAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartExpenseAnalysisCommandOutput) => void ): void; - public startExpenseAnalysis( - args: StartExpenseAnalysisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartExpenseAnalysisCommandOutput) => void), - cb?: (err: any, data?: StartExpenseAnalysisCommandOutput) => void - ): Promise | void { - const command = new StartExpenseAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts the classification and analysis of an input document. - * StartLendingAnalysis initiates the classification and analysis of a packet of - * lending documents. StartLendingAnalysis operates on a document file located in an - * Amazon S3 bucket.

- *

- * StartLendingAnalysis can analyze text in documents that are in one of the - * following formats: JPEG, PNG, TIFF, PDF. Use DocumentLocation to specify the bucket - * name and the file name of the document.

- *

- * StartLendingAnalysis returns a job identifier (JobId) that you use - * to get the results of the operation. When the text analysis is finished, Amazon Textract - * publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that - * you specify in NotificationChannel. To get the results of the text analysis - * operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If - * the status is SUCCEEDED you can call either GetLendingAnalysis or - * GetLendingAnalysisSummary and provide the JobId to obtain the results - * of the analysis.

- *

If using OutputConfig to specify an Amazon S3 bucket, the output will be contained - * within the specified prefix in a directory labeled with the job-id. In the directory there are 3 - * sub-directories:

- *
    - *
  • - *

    detailedResponse (contains the GetLendingAnalysis response)

    - *
  • - *
  • - *

    summaryResponse (for the GetLendingAnalysisSummary response)

    - *
  • - *
  • - *

    splitDocuments (documents split across logical boundaries)

    - *
  • - *
+ * @see {@link StartLendingAnalysisCommand} */ - public startLendingAnalysis( + startLendingAnalysis( args: StartLendingAnalysisCommandInput, options?: __HttpHandlerOptions ): Promise; - public startLendingAnalysis( + startLendingAnalysis( args: StartLendingAnalysisCommandInput, cb: (err: any, data?: StartLendingAnalysisCommandOutput) => void ): void; - public startLendingAnalysis( + startLendingAnalysis( args: StartLendingAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartLendingAnalysisCommandOutput) => void ): void; - public startLendingAnalysis( - args: StartLendingAnalysisCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartLendingAnalysisCommandOutput) => void), - cb?: (err: any, data?: StartLendingAnalysisCommandOutput) => void - ): Promise | void { - const command = new StartLendingAnalysisCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Textract detects and analyzes text in documents and converts it + * into machine-readable text. This is the API reference documentation for + * Amazon Textract.

+ */ +export class Textract extends TextractClient implements Textract {} +createAggregatedClient(commands, Textract); diff --git a/clients/client-timestream-query/src/TimestreamQuery.ts b/clients/client-timestream-query/src/TimestreamQuery.ts index 6f0a85456426..23b6c15198bf 100644 --- a/clients/client-timestream-query/src/TimestreamQuery.ts +++ b/clients/client-timestream-query/src/TimestreamQuery.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { CancelQueryCommand, CancelQueryCommandInput, CancelQueryCommandOutput } from "./commands/CancelQueryCommand"; @@ -54,483 +55,222 @@ import { UpdateScheduledQueryCommandInput, UpdateScheduledQueryCommandOutput, } from "./commands/UpdateScheduledQueryCommand"; -import { TimestreamQueryClient } from "./TimestreamQueryClient"; +import { TimestreamQueryClient, TimestreamQueryClientConfig } from "./TimestreamQueryClient"; -/** - * @public - * Amazon Timestream Query - * - *

- */ -export class TimestreamQuery extends TimestreamQueryClient { +const commands = { + CancelQueryCommand, + CreateScheduledQueryCommand, + DeleteScheduledQueryCommand, + DescribeEndpointsCommand, + DescribeScheduledQueryCommand, + ExecuteScheduledQueryCommand, + ListScheduledQueriesCommand, + ListTagsForResourceCommand, + PrepareQueryCommand, + QueryCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateScheduledQueryCommand, +}; + +export interface TimestreamQuery { /** - * @public - *

Cancels a query that has been issued. Cancellation is provided only if the query has - * not completed running before the cancellation request was issued. Because cancellation - * is an idempotent operation, subsequent cancellation requests will return a - * CancellationMessage, indicating that the query has already been - * canceled. See code - * sample for details.

+ * @see {@link CancelQueryCommand} */ - public cancelQuery(args: CancelQueryCommandInput, options?: __HttpHandlerOptions): Promise; - public cancelQuery(args: CancelQueryCommandInput, cb: (err: any, data?: CancelQueryCommandOutput) => void): void; - public cancelQuery( + cancelQuery(args: CancelQueryCommandInput, options?: __HttpHandlerOptions): Promise; + cancelQuery(args: CancelQueryCommandInput, cb: (err: any, data?: CancelQueryCommandOutput) => void): void; + cancelQuery( args: CancelQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelQueryCommandOutput) => void ): void; - public cancelQuery( - args: CancelQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelQueryCommandOutput) => void), - cb?: (err: any, data?: CancelQueryCommandOutput) => void - ): Promise | void { - const command = new CancelQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create a scheduled query that will be run on your behalf at the configured schedule. - * Timestream assumes the execution role provided as part of the - * ScheduledQueryExecutionRoleArn parameter to run the query. You can use - * the NotificationConfiguration parameter to configure notification for your - * scheduled query operations.

+ * @see {@link CreateScheduledQueryCommand} */ - public createScheduledQuery( + createScheduledQuery( args: CreateScheduledQueryCommandInput, options?: __HttpHandlerOptions ): Promise; - public createScheduledQuery( + createScheduledQuery( args: CreateScheduledQueryCommandInput, cb: (err: any, data?: CreateScheduledQueryCommandOutput) => void ): void; - public createScheduledQuery( + createScheduledQuery( args: CreateScheduledQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateScheduledQueryCommandOutput) => void ): void; - public createScheduledQuery( - args: CreateScheduledQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateScheduledQueryCommandOutput) => void), - cb?: (err: any, data?: CreateScheduledQueryCommandOutput) => void - ): Promise | void { - const command = new CreateScheduledQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a given scheduled query. This is an irreversible operation.

+ * @see {@link DeleteScheduledQueryCommand} */ - public deleteScheduledQuery( + deleteScheduledQuery( args: DeleteScheduledQueryCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteScheduledQuery( + deleteScheduledQuery( args: DeleteScheduledQueryCommandInput, cb: (err: any, data?: DeleteScheduledQueryCommandOutput) => void ): void; - public deleteScheduledQuery( + deleteScheduledQuery( args: DeleteScheduledQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteScheduledQueryCommandOutput) => void ): void; - public deleteScheduledQuery( - args: DeleteScheduledQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteScheduledQueryCommandOutput) => void), - cb?: (err: any, data?: DeleteScheduledQueryCommandOutput) => void - ): Promise | void { - const command = new DeleteScheduledQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

DescribeEndpoints returns a list of available endpoints to make Timestream - * API calls against. This API is available through both Write and Query.

- *

Because the Timestream SDKs are designed to transparently work with the - * service’s architecture, including the management and mapping of the service endpoints, - * it is not recommended that you use this API unless:

- * - *

For detailed information on how and when to use and implement DescribeEndpoints, see - * The Endpoint Discovery Pattern.

+ * @see {@link DescribeEndpointsCommand} */ - public describeEndpoints( + describeEndpoints( args: DescribeEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEndpoints( + describeEndpoints( args: DescribeEndpointsCommandInput, cb: (err: any, data?: DescribeEndpointsCommandOutput) => void ): void; - public describeEndpoints( + describeEndpoints( args: DescribeEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEndpointsCommandOutput) => void ): void; - public describeEndpoints( - args: DescribeEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEndpointsCommandOutput) => void), - cb?: (err: any, data?: DescribeEndpointsCommandOutput) => void - ): Promise | void { - const command = new DescribeEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides detailed information about a scheduled query.

+ * @see {@link DescribeScheduledQueryCommand} */ - public describeScheduledQuery( + describeScheduledQuery( args: DescribeScheduledQueryCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeScheduledQuery( + describeScheduledQuery( args: DescribeScheduledQueryCommandInput, cb: (err: any, data?: DescribeScheduledQueryCommandOutput) => void ): void; - public describeScheduledQuery( + describeScheduledQuery( args: DescribeScheduledQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScheduledQueryCommandOutput) => void ): void; - public describeScheduledQuery( - args: DescribeScheduledQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeScheduledQueryCommandOutput) => void), - cb?: (err: any, data?: DescribeScheduledQueryCommandOutput) => void - ): Promise | void { - const command = new DescribeScheduledQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

You can use this API to run a scheduled query manually.

+ * @see {@link ExecuteScheduledQueryCommand} */ - public executeScheduledQuery( + executeScheduledQuery( args: ExecuteScheduledQueryCommandInput, options?: __HttpHandlerOptions ): Promise; - public executeScheduledQuery( + executeScheduledQuery( args: ExecuteScheduledQueryCommandInput, cb: (err: any, data?: ExecuteScheduledQueryCommandOutput) => void ): void; - public executeScheduledQuery( + executeScheduledQuery( args: ExecuteScheduledQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteScheduledQueryCommandOutput) => void ): void; - public executeScheduledQuery( - args: ExecuteScheduledQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExecuteScheduledQueryCommandOutput) => void), - cb?: (err: any, data?: ExecuteScheduledQueryCommandOutput) => void - ): Promise | void { - const command = new ExecuteScheduledQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries is eventually consistent.

+ * @see {@link ListScheduledQueriesCommand} */ - public listScheduledQueries( + listScheduledQueries( args: ListScheduledQueriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listScheduledQueries( + listScheduledQueries( args: ListScheduledQueriesCommandInput, cb: (err: any, data?: ListScheduledQueriesCommandOutput) => void ): void; - public listScheduledQueries( + listScheduledQueries( args: ListScheduledQueriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListScheduledQueriesCommandOutput) => void ): void; - public listScheduledQueries( - args: ListScheduledQueriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListScheduledQueriesCommandOutput) => void), - cb?: (err: any, data?: ListScheduledQueriesCommandOutput) => void - ): Promise | void { - const command = new ListScheduledQueriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all tags on a Timestream query resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A synchronous operation that allows you to submit a query with parameters to be stored - * by Timestream for later running. Timestream only supports using this operation with the - * PrepareQueryRequest$ValidateOnly set to true.

+ * @see {@link PrepareQueryCommand} */ - public prepareQuery( - args: PrepareQueryCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public prepareQuery(args: PrepareQueryCommandInput, cb: (err: any, data?: PrepareQueryCommandOutput) => void): void; - public prepareQuery( + prepareQuery(args: PrepareQueryCommandInput, options?: __HttpHandlerOptions): Promise; + prepareQuery(args: PrepareQueryCommandInput, cb: (err: any, data?: PrepareQueryCommandOutput) => void): void; + prepareQuery( args: PrepareQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PrepareQueryCommandOutput) => void ): void; - public prepareQuery( - args: PrepareQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PrepareQueryCommandOutput) => void), - cb?: (err: any, data?: PrepareQueryCommandOutput) => void - ): Promise | void { - const command = new PrepareQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Query is a synchronous operation that enables you to run a query against - * your Amazon Timestream data. Query will time out after 60 seconds. - * You must update the default timeout in the SDK to support a timeout of 60 seconds. See - * the code - * sample for details.

- *

Your query request will fail in the following cases:

- *
    - *
  • - *

    If you submit a Query request with the same client token outside - * of the 5-minute idempotency window.

    - *
  • - *
  • - *

    If you submit a Query request with the same client token, but - * change other parameters, within the 5-minute idempotency window.

    - *
  • - *
  • - *

    If the size of the row (including the query metadata) exceeds 1 MB, then the - * query will fail with the following error message:

    - *

    - * Query aborted as max page response size has been exceeded by the output - * result row - *

    - *
  • - *
  • - *

    If the IAM principal of the query initiator and the result reader are not the - * same and/or the query initiator and the result reader do not have the same query - * string in the query requests, the query will fail with an Invalid - * pagination token error.

    - *
  • - *
+ * @see {@link QueryCommand} */ - public query(args: QueryCommandInput, options?: __HttpHandlerOptions): Promise; - public query(args: QueryCommandInput, cb: (err: any, data?: QueryCommandOutput) => void): void; - public query( + query(args: QueryCommandInput, options?: __HttpHandlerOptions): Promise; + query(args: QueryCommandInput, cb: (err: any, data?: QueryCommandOutput) => void): void; + query( args: QueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryCommandOutput) => void ): void; - public query( - args: QueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryCommandOutput) => void), - cb?: (err: any, data?: QueryCommandOutput) => void - ): Promise | void { - const command = new QueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associate a set of tags with a Timestream resource. You can then activate these - * user-defined tags so that they appear on the Billing and Cost Management console for - * cost allocation tracking.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the association of tags from a Timestream query resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update a scheduled query.

+ * @see {@link UpdateScheduledQueryCommand} */ - public updateScheduledQuery( + updateScheduledQuery( args: UpdateScheduledQueryCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateScheduledQuery( + updateScheduledQuery( args: UpdateScheduledQueryCommandInput, cb: (err: any, data?: UpdateScheduledQueryCommandOutput) => void ): void; - public updateScheduledQuery( + updateScheduledQuery( args: UpdateScheduledQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateScheduledQueryCommandOutput) => void ): void; - public updateScheduledQuery( - args: UpdateScheduledQueryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateScheduledQueryCommandOutput) => void), - cb?: (err: any, data?: UpdateScheduledQueryCommandOutput) => void - ): Promise | void { - const command = new UpdateScheduledQueryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Timestream Query + * + *

+ */ +export class TimestreamQuery extends TimestreamQueryClient implements TimestreamQuery {} +createAggregatedClient(commands, TimestreamQuery); diff --git a/clients/client-timestream-write/src/TimestreamWrite.ts b/clients/client-timestream-write/src/TimestreamWrite.ts index 675376a57330..32dccb8c8f5c 100644 --- a/clients/client-timestream-write/src/TimestreamWrite.ts +++ b/clients/client-timestream-write/src/TimestreamWrite.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -76,736 +77,307 @@ import { WriteRecordsCommandInput, WriteRecordsCommandOutput, } from "./commands/WriteRecordsCommand"; -import { TimestreamWriteClient } from "./TimestreamWriteClient"; +import { TimestreamWriteClient, TimestreamWriteClientConfig } from "./TimestreamWriteClient"; -/** - * @public - * Amazon Timestream Write - *

Amazon Timestream is a fast, scalable, fully managed time-series database service - * that makes it easy to store and analyze trillions of time-series data points per day. With - * Timestream, you can easily store and analyze IoT sensor data to derive insights - * from your IoT applications. You can analyze industrial telemetry to streamline equipment - * management and maintenance. You can also store and analyze log data and metrics to improve - * the performance and availability of your applications.

- *

Timestream is built from the ground up to effectively ingest, process, and - * store time-series data. It organizes data to optimize query processing. It automatically - * scales based on the volume of data ingested and on the query volume to ensure you receive - * optimal performance while inserting and querying data. As your data grows over time, - * Timestream’s adaptive query processing engine spans across storage tiers to - * provide fast analysis while reducing costs.

- */ -export class TimestreamWrite extends TimestreamWriteClient { +const commands = { + CreateBatchLoadTaskCommand, + CreateDatabaseCommand, + CreateTableCommand, + DeleteDatabaseCommand, + DeleteTableCommand, + DescribeBatchLoadTaskCommand, + DescribeDatabaseCommand, + DescribeEndpointsCommand, + DescribeTableCommand, + ListBatchLoadTasksCommand, + ListDatabasesCommand, + ListTablesCommand, + ListTagsForResourceCommand, + ResumeBatchLoadTaskCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateDatabaseCommand, + UpdateTableCommand, + WriteRecordsCommand, +}; + +export interface TimestreamWrite { /** - * @public - *

Creates a new Timestream batch load task. A batch load task processes data from - * a CSV source in an S3 location and writes to a Timestream table. A mapping from - * source to target is defined in a batch load task. Errors and events are written to a report - * at an S3 location. For the report, if the KMS key is not specified, the - * batch load task will be encrypted with a Timestream managed KMS key - * located in your account. For more information, see Amazon Web Services managed - * keys. Service quotas apply. For - * details, see code - * sample.

+ * @see {@link CreateBatchLoadTaskCommand} */ - public createBatchLoadTask( + createBatchLoadTask( args: CreateBatchLoadTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBatchLoadTask( + createBatchLoadTask( args: CreateBatchLoadTaskCommandInput, cb: (err: any, data?: CreateBatchLoadTaskCommandOutput) => void ): void; - public createBatchLoadTask( + createBatchLoadTask( args: CreateBatchLoadTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBatchLoadTaskCommandOutput) => void ): void; - public createBatchLoadTask( - args: CreateBatchLoadTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBatchLoadTaskCommandOutput) => void), - cb?: (err: any, data?: CreateBatchLoadTaskCommandOutput) => void - ): Promise | void { - const command = new CreateBatchLoadTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new Timestream database. If the KMS key is not - * specified, the database will be encrypted with a Timestream managed KMS key located in your account. For more information, see Amazon Web Services managed keys. Service quotas apply. For - * details, see code sample. - *

+ * @see {@link CreateDatabaseCommand} */ - public createDatabase( + createDatabase( args: CreateDatabaseCommandInput, options?: __HttpHandlerOptions ): Promise; - public createDatabase( - args: CreateDatabaseCommandInput, - cb: (err: any, data?: CreateDatabaseCommandOutput) => void - ): void; - public createDatabase( + createDatabase(args: CreateDatabaseCommandInput, cb: (err: any, data?: CreateDatabaseCommandOutput) => void): void; + createDatabase( args: CreateDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatabaseCommandOutput) => void ): void; - public createDatabase( - args: CreateDatabaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDatabaseCommandOutput) => void), - cb?: (err: any, data?: CreateDatabaseCommandOutput) => void - ): Promise | void { - const command = new CreateDatabaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a new table to an existing database in your account. In an Amazon Web Services account, table names must be at least unique within each Region if they are in the same - * database. You might have identical table names in the same Region if the tables are in - * separate databases. While creating the table, you must specify the table name, database - * name, and the retention properties. Service quotas apply. See - * code - * sample for details.

+ * @see {@link CreateTableCommand} */ - public createTable(args: CreateTableCommandInput, options?: __HttpHandlerOptions): Promise; - public createTable(args: CreateTableCommandInput, cb: (err: any, data?: CreateTableCommandOutput) => void): void; - public createTable( + createTable(args: CreateTableCommandInput, options?: __HttpHandlerOptions): Promise; + createTable(args: CreateTableCommandInput, cb: (err: any, data?: CreateTableCommandOutput) => void): void; + createTable( args: CreateTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTableCommandOutput) => void ): void; - public createTable( - args: CreateTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTableCommandOutput) => void), - cb?: (err: any, data?: CreateTableCommandOutput) => void - ): Promise | void { - const command = new CreateTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a given Timestream database. This is an irreversible - * operation. After a database is deleted, the time-series data from its tables cannot be - * recovered. - *

- * - *

All tables in the database must be deleted first, or a ValidationException error will - * be thrown.

- *

Due to the nature of distributed retries, the operation can return either success or - * a ResourceNotFoundException. Clients should consider them equivalent.

- *
- *

See code sample - * for details.

+ * @see {@link DeleteDatabaseCommand} */ - public deleteDatabase( + deleteDatabase( args: DeleteDatabaseCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDatabase( - args: DeleteDatabaseCommandInput, - cb: (err: any, data?: DeleteDatabaseCommandOutput) => void - ): void; - public deleteDatabase( + deleteDatabase(args: DeleteDatabaseCommandInput, cb: (err: any, data?: DeleteDatabaseCommandOutput) => void): void; + deleteDatabase( args: DeleteDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatabaseCommandOutput) => void ): void; - public deleteDatabase( - args: DeleteDatabaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDatabaseCommandOutput) => void), - cb?: (err: any, data?: DeleteDatabaseCommandOutput) => void - ): Promise | void { - const command = new DeleteDatabaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a given Timestream table. This is an irreversible operation. After a - * Timestream database table is deleted, the time-series data stored in the table - * cannot be recovered.

- * - *

Due to the nature of distributed retries, the operation can return either success or - * a ResourceNotFoundException. Clients should consider them equivalent.

- *
- *

See code - * sample for details.

+ * @see {@link DeleteTableCommand} */ - public deleteTable(args: DeleteTableCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteTable(args: DeleteTableCommandInput, cb: (err: any, data?: DeleteTableCommandOutput) => void): void; - public deleteTable( + deleteTable(args: DeleteTableCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTable(args: DeleteTableCommandInput, cb: (err: any, data?: DeleteTableCommandOutput) => void): void; + deleteTable( args: DeleteTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTableCommandOutput) => void ): void; - public deleteTable( - args: DeleteTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTableCommandOutput) => void), - cb?: (err: any, data?: DeleteTableCommandOutput) => void - ): Promise | void { - const command = new DeleteTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the batch load task, including configurations, mappings, - * progress, and other details. Service quotas apply. See - * code - * sample for details.

+ * @see {@link DescribeBatchLoadTaskCommand} */ - public describeBatchLoadTask( + describeBatchLoadTask( args: DescribeBatchLoadTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeBatchLoadTask( + describeBatchLoadTask( args: DescribeBatchLoadTaskCommandInput, cb: (err: any, data?: DescribeBatchLoadTaskCommandOutput) => void ): void; - public describeBatchLoadTask( + describeBatchLoadTask( args: DescribeBatchLoadTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBatchLoadTaskCommandOutput) => void ): void; - public describeBatchLoadTask( - args: DescribeBatchLoadTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeBatchLoadTaskCommandOutput) => void), - cb?: (err: any, data?: DescribeBatchLoadTaskCommandOutput) => void - ): Promise | void { - const command = new DescribeBatchLoadTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the database, including the database name, time that the - * database was created, and the total number of tables found within the database. Service - * quotas apply. See code sample - * for details.

+ * @see {@link DescribeDatabaseCommand} */ - public describeDatabase( + describeDatabase( args: DescribeDatabaseCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDatabase( + describeDatabase( args: DescribeDatabaseCommandInput, cb: (err: any, data?: DescribeDatabaseCommandOutput) => void ): void; - public describeDatabase( + describeDatabase( args: DescribeDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatabaseCommandOutput) => void ): void; - public describeDatabase( - args: DescribeDatabaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDatabaseCommandOutput) => void), - cb?: (err: any, data?: DescribeDatabaseCommandOutput) => void - ): Promise | void { - const command = new DescribeDatabaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of available endpoints to make Timestream API calls against. - * This API operation is available through both the Write and Query APIs.

- *

Because the Timestream SDKs are designed to transparently work with the - * service’s architecture, including the management and mapping of the service endpoints, - * we don't recommend that you use this API operation unless:

- * - *

For detailed information on how and when to use and implement DescribeEndpoints, see - * The - * Endpoint Discovery Pattern.

+ * @see {@link DescribeEndpointsCommand} */ - public describeEndpoints( + describeEndpoints( args: DescribeEndpointsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEndpoints( + describeEndpoints( args: DescribeEndpointsCommandInput, cb: (err: any, data?: DescribeEndpointsCommandOutput) => void ): void; - public describeEndpoints( + describeEndpoints( args: DescribeEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEndpointsCommandOutput) => void ): void; - public describeEndpoints( - args: DescribeEndpointsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEndpointsCommandOutput) => void), - cb?: (err: any, data?: DescribeEndpointsCommandOutput) => void - ): Promise | void { - const command = new DescribeEndpointsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns information about the table, including the table name, database name, retention - * duration of the memory store and the magnetic store. Service quotas apply. See - * code - * sample for details.

+ * @see {@link DescribeTableCommand} */ - public describeTable( - args: DescribeTableCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeTable( - args: DescribeTableCommandInput, - cb: (err: any, data?: DescribeTableCommandOutput) => void - ): void; - public describeTable( + describeTable(args: DescribeTableCommandInput, options?: __HttpHandlerOptions): Promise; + describeTable(args: DescribeTableCommandInput, cb: (err: any, data?: DescribeTableCommandOutput) => void): void; + describeTable( args: DescribeTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTableCommandOutput) => void ): void; - public describeTable( - args: DescribeTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTableCommandOutput) => void), - cb?: (err: any, data?: DescribeTableCommandOutput) => void - ): Promise | void { - const command = new DescribeTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a list of batch load tasks, along with the name, status, when the task is - * resumable until, and other details. See code - * sample for details.

+ * @see {@link ListBatchLoadTasksCommand} */ - public listBatchLoadTasks( + listBatchLoadTasks( args: ListBatchLoadTasksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBatchLoadTasks( + listBatchLoadTasks( args: ListBatchLoadTasksCommandInput, cb: (err: any, data?: ListBatchLoadTasksCommandOutput) => void ): void; - public listBatchLoadTasks( + listBatchLoadTasks( args: ListBatchLoadTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBatchLoadTasksCommandOutput) => void ): void; - public listBatchLoadTasks( - args: ListBatchLoadTasksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBatchLoadTasksCommandOutput) => void), - cb?: (err: any, data?: ListBatchLoadTasksCommandOutput) => void - ): Promise | void { - const command = new ListBatchLoadTasksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of your Timestream databases. Service quotas apply. See - * code sample for - * details.

+ * @see {@link ListDatabasesCommand} */ - public listDatabases( - args: ListDatabasesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listDatabases( - args: ListDatabasesCommandInput, - cb: (err: any, data?: ListDatabasesCommandOutput) => void - ): void; - public listDatabases( + listDatabases(args: ListDatabasesCommandInput, options?: __HttpHandlerOptions): Promise; + listDatabases(args: ListDatabasesCommandInput, cb: (err: any, data?: ListDatabasesCommandOutput) => void): void; + listDatabases( args: ListDatabasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatabasesCommandOutput) => void ): void; - public listDatabases( - args: ListDatabasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDatabasesCommandOutput) => void), - cb?: (err: any, data?: ListDatabasesCommandOutput) => void - ): Promise | void { - const command = new ListDatabasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a list of tables, along with the name, status, and retention properties of each - * table. See code sample - * for details.

+ * @see {@link ListTablesCommand} */ - public listTables(args: ListTablesCommandInput, options?: __HttpHandlerOptions): Promise; - public listTables(args: ListTablesCommandInput, cb: (err: any, data?: ListTablesCommandOutput) => void): void; - public listTables( + listTables(args: ListTablesCommandInput, options?: __HttpHandlerOptions): Promise; + listTables(args: ListTablesCommandInput, cb: (err: any, data?: ListTablesCommandOutput) => void): void; + listTables( args: ListTablesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTablesCommandOutput) => void ): void; - public listTables( - args: ListTablesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTablesCommandOutput) => void), - cb?: (err: any, data?: ListTablesCommandOutput) => void - ): Promise | void { - const command = new ListTablesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all tags on a Timestream resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- *

+ * @see {@link ResumeBatchLoadTaskCommand} */ - public resumeBatchLoadTask( + resumeBatchLoadTask( args: ResumeBatchLoadTaskCommandInput, options?: __HttpHandlerOptions ): Promise; - public resumeBatchLoadTask( + resumeBatchLoadTask( args: ResumeBatchLoadTaskCommandInput, cb: (err: any, data?: ResumeBatchLoadTaskCommandOutput) => void ): void; - public resumeBatchLoadTask( + resumeBatchLoadTask( args: ResumeBatchLoadTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResumeBatchLoadTaskCommandOutput) => void ): void; - public resumeBatchLoadTask( - args: ResumeBatchLoadTaskCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResumeBatchLoadTaskCommandOutput) => void), - cb?: (err: any, data?: ResumeBatchLoadTaskCommandOutput) => void - ): Promise | void { - const command = new ResumeBatchLoadTaskCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a set of tags with a Timestream resource. You can then activate - * these user-defined tags so that they appear on the Billing and Cost Management console for - * cost allocation tracking.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the association of tags from a Timestream resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the KMS key for an existing database. While updating the - * database, you must specify the database name and the identifier of the new KMS key to be used (KmsKeyId). If there are any concurrent - * UpdateDatabase requests, first writer wins.

- *

See code sample - * for details.

+ * @see {@link UpdateDatabaseCommand} */ - public updateDatabase( + updateDatabase( args: UpdateDatabaseCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDatabase( - args: UpdateDatabaseCommandInput, - cb: (err: any, data?: UpdateDatabaseCommandOutput) => void - ): void; - public updateDatabase( + updateDatabase(args: UpdateDatabaseCommandInput, cb: (err: any, data?: UpdateDatabaseCommandOutput) => void): void; + updateDatabase( args: UpdateDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDatabaseCommandOutput) => void ): void; - public updateDatabase( - args: UpdateDatabaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDatabaseCommandOutput) => void), - cb?: (err: any, data?: UpdateDatabaseCommandOutput) => void - ): Promise | void { - const command = new UpdateDatabaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies the retention duration of the memory store and magnetic store for your Timestream table. Note that the change in retention duration takes effect immediately. - * For example, if the retention period of the memory store was initially set to 2 hours and - * then changed to 24 hours, the memory store will be capable of holding 24 hours of data, but - * will be populated with 24 hours of data 22 hours after this change was made. Timestream does not retrieve data from the magnetic store to populate the memory store.

- *

See code - * sample for details.

+ * @see {@link UpdateTableCommand} */ - public updateTable(args: UpdateTableCommandInput, options?: __HttpHandlerOptions): Promise; - public updateTable(args: UpdateTableCommandInput, cb: (err: any, data?: UpdateTableCommandOutput) => void): void; - public updateTable( + updateTable(args: UpdateTableCommandInput, options?: __HttpHandlerOptions): Promise; + updateTable(args: UpdateTableCommandInput, cb: (err: any, data?: UpdateTableCommandOutput) => void): void; + updateTable( args: UpdateTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTableCommandOutput) => void ): void; - public updateTable( - args: UpdateTableCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTableCommandOutput) => void), - cb?: (err: any, data?: UpdateTableCommandOutput) => void - ): Promise | void { - const command = new UpdateTableCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables you to write your time-series data into Timestream. You can specify a - * single data point or a batch of data points to be inserted into the system. Timestream offers you a flexible schema that auto detects the column names and data - * types for your Timestream tables based on the dimension names and data types of - * the data points you specify when invoking writes into the database.

- *

Timestream supports eventual consistency read semantics. This means that when - * you query data immediately after writing a batch of data into Timestream, the - * query results might not reflect the results of a recently completed write operation. The - * results may also include some stale data. If you repeat the query request after a short - * time, the results should return the latest data. Service quotas apply.

- *

See code sample for - * details.

- *

- * Upserts - *

- *

You can use the Version parameter in a WriteRecords request to - * update data points. Timestream tracks a version number with each record. - * Version defaults to 1 when it's not specified for the record - * in the request. Timestream updates an existing record’s measure value along with - * its Version when it receives a write request with a higher - * Version number for that record. When it receives an update request where - * the measure value is the same as that of the existing record, Timestream still - * updates Version, if it is greater than the existing value of - * Version. You can update a data point as many times as desired, as long as - * the value of Version continuously increases.

- *

For example, suppose you write a new record without indicating Version in - * the request. Timestream stores this record, and set Version to - * 1. Now, suppose you try to update this record with a - * WriteRecords request of the same record with a different measure value but, - * like before, do not provide Version. In this case, Timestream will - * reject this update with a RejectedRecordsException since the updated record’s - * version is not greater than the existing value of Version.

- *

However, if you were to resend the update request with Version set to - * 2, Timestream would then succeed in updating the record’s value, - * and the Version would be set to 2. Next, suppose you sent a - * WriteRecords request with this same record and an identical measure value, - * but with Version set to 3. In this case, Timestream - * would only update Version to 3. Any further updates would need to - * send a version number greater than 3, or the update requests would receive a - * RejectedRecordsException.

+ * @see {@link WriteRecordsCommand} */ - public writeRecords( - args: WriteRecordsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public writeRecords(args: WriteRecordsCommandInput, cb: (err: any, data?: WriteRecordsCommandOutput) => void): void; - public writeRecords( + writeRecords(args: WriteRecordsCommandInput, options?: __HttpHandlerOptions): Promise; + writeRecords(args: WriteRecordsCommandInput, cb: (err: any, data?: WriteRecordsCommandOutput) => void): void; + writeRecords( args: WriteRecordsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: WriteRecordsCommandOutput) => void ): void; - public writeRecords( - args: WriteRecordsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: WriteRecordsCommandOutput) => void), - cb?: (err: any, data?: WriteRecordsCommandOutput) => void - ): Promise | void { - const command = new WriteRecordsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon Timestream Write + *

Amazon Timestream is a fast, scalable, fully managed time-series database service + * that makes it easy to store and analyze trillions of time-series data points per day. With + * Timestream, you can easily store and analyze IoT sensor data to derive insights + * from your IoT applications. You can analyze industrial telemetry to streamline equipment + * management and maintenance. You can also store and analyze log data and metrics to improve + * the performance and availability of your applications.

+ *

Timestream is built from the ground up to effectively ingest, process, and + * store time-series data. It organizes data to optimize query processing. It automatically + * scales based on the volume of data ingested and on the query volume to ensure you receive + * optimal performance while inserting and querying data. As your data grows over time, + * Timestream’s adaptive query processing engine spans across storage tiers to + * provide fast analysis while reducing costs.

+ */ +export class TimestreamWrite extends TimestreamWriteClient implements TimestreamWrite {} +createAggregatedClient(commands, TimestreamWrite); diff --git a/clients/client-tnb/src/Tnb.ts b/clients/client-tnb/src/Tnb.ts index 7615a4fcea8b..c49c4963e630 100644 --- a/clients/client-tnb/src/Tnb.ts +++ b/clients/client-tnb/src/Tnb.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -162,1139 +163,598 @@ import { ValidateSolNetworkPackageContentCommandInput, ValidateSolNetworkPackageContentCommandOutput, } from "./commands/ValidateSolNetworkPackageContentCommand"; -import { TnbClient } from "./TnbClient"; +import { TnbClient, TnbClientConfig } from "./TnbClient"; -/** - * @public - *

Amazon Web Services Telco Network Builder (TNB) is a network automation service that helps you deploy and manage telecom networks. AWS TNB helps you with the lifecycle management of your telecommunication network functions throughout planning, deployment, and post-deployment activities.

- */ -export class Tnb extends TnbClient { +const commands = { + CancelSolNetworkOperationCommand, + CreateSolFunctionPackageCommand, + CreateSolNetworkInstanceCommand, + CreateSolNetworkPackageCommand, + DeleteSolFunctionPackageCommand, + DeleteSolNetworkInstanceCommand, + DeleteSolNetworkPackageCommand, + GetSolFunctionInstanceCommand, + GetSolFunctionPackageCommand, + GetSolFunctionPackageContentCommand, + GetSolFunctionPackageDescriptorCommand, + GetSolNetworkInstanceCommand, + GetSolNetworkOperationCommand, + GetSolNetworkPackageCommand, + GetSolNetworkPackageContentCommand, + GetSolNetworkPackageDescriptorCommand, + InstantiateSolNetworkInstanceCommand, + ListSolFunctionInstancesCommand, + ListSolFunctionPackagesCommand, + ListSolNetworkInstancesCommand, + ListSolNetworkOperationsCommand, + ListSolNetworkPackagesCommand, + ListTagsForResourceCommand, + PutSolFunctionPackageContentCommand, + PutSolNetworkPackageContentCommand, + TagResourceCommand, + TerminateSolNetworkInstanceCommand, + UntagResourceCommand, + UpdateSolFunctionPackageCommand, + UpdateSolNetworkInstanceCommand, + UpdateSolNetworkPackageCommand, + ValidateSolFunctionPackageContentCommand, + ValidateSolNetworkPackageContentCommand, +}; + +export interface Tnb { /** - * @public - *

Cancels a network operation.

- *

A network operation is any operation that is done to your network, such as network instance instantiation or termination.

+ * @see {@link CancelSolNetworkOperationCommand} */ - public cancelSolNetworkOperation( + cancelSolNetworkOperation( args: CancelSolNetworkOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelSolNetworkOperation( + cancelSolNetworkOperation( args: CancelSolNetworkOperationCommandInput, cb: (err: any, data?: CancelSolNetworkOperationCommandOutput) => void ): void; - public cancelSolNetworkOperation( + cancelSolNetworkOperation( args: CancelSolNetworkOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelSolNetworkOperationCommandOutput) => void ): void; - public cancelSolNetworkOperation( - args: CancelSolNetworkOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelSolNetworkOperationCommandOutput) => void), - cb?: (err: any, data?: CancelSolNetworkOperationCommandOutput) => void - ): Promise | void { - const command = new CancelSolNetworkOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a function package.

- *

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. For more information, see Function packages in the Amazon Web Services Telco Network Builder User Guide. - *

- *

Creating a function package is the first step for creating a network in AWS TNB. This request creates an empty container with an ID. The next step is to upload the actual CSAR zip file into that empty container. To upload function package content, see PutSolFunctionPackageContent.

+ * @see {@link CreateSolFunctionPackageCommand} */ - public createSolFunctionPackage( + createSolFunctionPackage( args: CreateSolFunctionPackageCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSolFunctionPackage( + createSolFunctionPackage( args: CreateSolFunctionPackageCommandInput, cb: (err: any, data?: CreateSolFunctionPackageCommandOutput) => void ): void; - public createSolFunctionPackage( + createSolFunctionPackage( args: CreateSolFunctionPackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSolFunctionPackageCommandOutput) => void ): void; - public createSolFunctionPackage( - args: CreateSolFunctionPackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSolFunctionPackageCommandOutput) => void), - cb?: (err: any, data?: CreateSolFunctionPackageCommandOutput) => void - ): Promise | void { - const command = new CreateSolFunctionPackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a network instance.

- *

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. Creating a network instance is the third step after creating a network package. For more information about network instances, Network instances in the Amazon Web Services Telco Network Builder User Guide.

- *

Once you create a network instance, you can instantiate it. To instantiate a network, see InstantiateSolNetworkInstance.

+ * @see {@link CreateSolNetworkInstanceCommand} */ - public createSolNetworkInstance( + createSolNetworkInstance( args: CreateSolNetworkInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSolNetworkInstance( + createSolNetworkInstance( args: CreateSolNetworkInstanceCommandInput, cb: (err: any, data?: CreateSolNetworkInstanceCommandOutput) => void ): void; - public createSolNetworkInstance( + createSolNetworkInstance( args: CreateSolNetworkInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSolNetworkInstanceCommandOutput) => void ): void; - public createSolNetworkInstance( - args: CreateSolNetworkInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSolNetworkInstanceCommandOutput) => void), - cb?: (err: any, data?: CreateSolNetworkInstanceCommandOutput) => void - ): Promise | void { - const command = new CreateSolNetworkInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a network package.

- *

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on. For more information, see Network instances in the Amazon Web Services Telco Network Builder User Guide. - *

- *

A network package consists of a network service descriptor (NSD) file (required) and any additional files (optional), such as scripts specific to your needs. For example, if you have multiple function packages in your network package, you can use the NSD to define which network functions should run in certain VPCs, subnets, or EKS clusters.

- *

This request creates an empty network package container with an ID. Once you create a network package, you can upload the network package content using PutSolNetworkPackageContent.

+ * @see {@link CreateSolNetworkPackageCommand} */ - public createSolNetworkPackage( + createSolNetworkPackage( args: CreateSolNetworkPackageCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSolNetworkPackage( + createSolNetworkPackage( args: CreateSolNetworkPackageCommandInput, cb: (err: any, data?: CreateSolNetworkPackageCommandOutput) => void ): void; - public createSolNetworkPackage( + createSolNetworkPackage( args: CreateSolNetworkPackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSolNetworkPackageCommandOutput) => void ): void; - public createSolNetworkPackage( - args: CreateSolNetworkPackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSolNetworkPackageCommandOutput) => void), - cb?: (err: any, data?: CreateSolNetworkPackageCommandOutput) => void - ): Promise | void { - const command = new CreateSolNetworkPackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a function package.

- *

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

- *

To delete a function package, the package must be in a disabled state. To disable a function package, see UpdateSolFunctionPackage. - *

+ * @see {@link DeleteSolFunctionPackageCommand} */ - public deleteSolFunctionPackage( + deleteSolFunctionPackage( args: DeleteSolFunctionPackageCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSolFunctionPackage( + deleteSolFunctionPackage( args: DeleteSolFunctionPackageCommandInput, cb: (err: any, data?: DeleteSolFunctionPackageCommandOutput) => void ): void; - public deleteSolFunctionPackage( + deleteSolFunctionPackage( args: DeleteSolFunctionPackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSolFunctionPackageCommandOutput) => void ): void; - public deleteSolFunctionPackage( - args: DeleteSolFunctionPackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSolFunctionPackageCommandOutput) => void), - cb?: (err: any, data?: DeleteSolFunctionPackageCommandOutput) => void - ): Promise | void { - const command = new DeleteSolFunctionPackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a network instance.

- *

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

- *

To delete a network instance, the instance must be in a stopped or terminated state. To terminate a network instance, see TerminateSolNetworkInstance.

+ * @see {@link DeleteSolNetworkInstanceCommand} */ - public deleteSolNetworkInstance( + deleteSolNetworkInstance( args: DeleteSolNetworkInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSolNetworkInstance( + deleteSolNetworkInstance( args: DeleteSolNetworkInstanceCommandInput, cb: (err: any, data?: DeleteSolNetworkInstanceCommandOutput) => void ): void; - public deleteSolNetworkInstance( + deleteSolNetworkInstance( args: DeleteSolNetworkInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSolNetworkInstanceCommandOutput) => void ): void; - public deleteSolNetworkInstance( - args: DeleteSolNetworkInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSolNetworkInstanceCommandOutput) => void), - cb?: (err: any, data?: DeleteSolNetworkInstanceCommandOutput) => void - ): Promise | void { - const command = new DeleteSolNetworkInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes network package.

- *

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

- *

To delete a network package, the package must be in a disable state. To disable a network package, see UpdateSolNetworkPackage.

+ * @see {@link DeleteSolNetworkPackageCommand} */ - public deleteSolNetworkPackage( + deleteSolNetworkPackage( args: DeleteSolNetworkPackageCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSolNetworkPackage( + deleteSolNetworkPackage( args: DeleteSolNetworkPackageCommandInput, cb: (err: any, data?: DeleteSolNetworkPackageCommandOutput) => void ): void; - public deleteSolNetworkPackage( + deleteSolNetworkPackage( args: DeleteSolNetworkPackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSolNetworkPackageCommandOutput) => void ): void; - public deleteSolNetworkPackage( - args: DeleteSolNetworkPackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSolNetworkPackageCommandOutput) => void), - cb?: (err: any, data?: DeleteSolNetworkPackageCommandOutput) => void - ): Promise | void { - const command = new DeleteSolNetworkPackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the details of a network function instance, including the instantation state and metadata from the function package descriptor in the network function package.

- *

A network function instance is a function in a function package .

+ * @see {@link GetSolFunctionInstanceCommand} */ - public getSolFunctionInstance( + getSolFunctionInstance( args: GetSolFunctionInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSolFunctionInstance( + getSolFunctionInstance( args: GetSolFunctionInstanceCommandInput, cb: (err: any, data?: GetSolFunctionInstanceCommandOutput) => void ): void; - public getSolFunctionInstance( + getSolFunctionInstance( args: GetSolFunctionInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSolFunctionInstanceCommandOutput) => void ): void; - public getSolFunctionInstance( - args: GetSolFunctionInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSolFunctionInstanceCommandOutput) => void), - cb?: (err: any, data?: GetSolFunctionInstanceCommandOutput) => void - ): Promise | void { - const command = new GetSolFunctionInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the details of an individual function package, such as the operational state and whether the package is in use.

- *

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network..

+ * @see {@link GetSolFunctionPackageCommand} */ - public getSolFunctionPackage( + getSolFunctionPackage( args: GetSolFunctionPackageCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSolFunctionPackage( + getSolFunctionPackage( args: GetSolFunctionPackageCommandInput, cb: (err: any, data?: GetSolFunctionPackageCommandOutput) => void ): void; - public getSolFunctionPackage( + getSolFunctionPackage( args: GetSolFunctionPackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSolFunctionPackageCommandOutput) => void ): void; - public getSolFunctionPackage( - args: GetSolFunctionPackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSolFunctionPackageCommandOutput) => void), - cb?: (err: any, data?: GetSolFunctionPackageCommandOutput) => void - ): Promise | void { - const command = new GetSolFunctionPackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the contents of a function package.

- *

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

+ * @see {@link GetSolFunctionPackageContentCommand} */ - public getSolFunctionPackageContent( + getSolFunctionPackageContent( args: GetSolFunctionPackageContentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSolFunctionPackageContent( + getSolFunctionPackageContent( args: GetSolFunctionPackageContentCommandInput, cb: (err: any, data?: GetSolFunctionPackageContentCommandOutput) => void ): void; - public getSolFunctionPackageContent( + getSolFunctionPackageContent( args: GetSolFunctionPackageContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSolFunctionPackageContentCommandOutput) => void ): void; - public getSolFunctionPackageContent( - args: GetSolFunctionPackageContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSolFunctionPackageContentCommandOutput) => void), - cb?: (err: any, data?: GetSolFunctionPackageContentCommandOutput) => void - ): Promise | void { - const command = new GetSolFunctionPackageContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a function package descriptor in a function package.

- *

A function package descriptor is a .yaml file in a function package that uses the TOSCA standard to describe how the network function in the function package should run on your network.

- *

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

+ * @see {@link GetSolFunctionPackageDescriptorCommand} */ - public getSolFunctionPackageDescriptor( + getSolFunctionPackageDescriptor( args: GetSolFunctionPackageDescriptorCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSolFunctionPackageDescriptor( + getSolFunctionPackageDescriptor( args: GetSolFunctionPackageDescriptorCommandInput, cb: (err: any, data?: GetSolFunctionPackageDescriptorCommandOutput) => void ): void; - public getSolFunctionPackageDescriptor( + getSolFunctionPackageDescriptor( args: GetSolFunctionPackageDescriptorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSolFunctionPackageDescriptorCommandOutput) => void ): void; - public getSolFunctionPackageDescriptor( - args: GetSolFunctionPackageDescriptorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSolFunctionPackageDescriptorCommandOutput) => void), - cb?: (err: any, data?: GetSolFunctionPackageDescriptorCommandOutput) => void - ): Promise | void { - const command = new GetSolFunctionPackageDescriptorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the details of the network instance.

- *

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

+ * @see {@link GetSolNetworkInstanceCommand} */ - public getSolNetworkInstance( + getSolNetworkInstance( args: GetSolNetworkInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSolNetworkInstance( + getSolNetworkInstance( args: GetSolNetworkInstanceCommandInput, cb: (err: any, data?: GetSolNetworkInstanceCommandOutput) => void ): void; - public getSolNetworkInstance( + getSolNetworkInstance( args: GetSolNetworkInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSolNetworkInstanceCommandOutput) => void ): void; - public getSolNetworkInstance( - args: GetSolNetworkInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSolNetworkInstanceCommandOutput) => void), - cb?: (err: any, data?: GetSolNetworkInstanceCommandOutput) => void - ): Promise | void { - const command = new GetSolNetworkInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the details of a network operation, including the tasks involved in the network operation and the status of the tasks.

- *

A network operation is any operation that is done to your network, such as network instance instantiation or termination.

+ * @see {@link GetSolNetworkOperationCommand} */ - public getSolNetworkOperation( + getSolNetworkOperation( args: GetSolNetworkOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSolNetworkOperation( + getSolNetworkOperation( args: GetSolNetworkOperationCommandInput, cb: (err: any, data?: GetSolNetworkOperationCommandOutput) => void ): void; - public getSolNetworkOperation( + getSolNetworkOperation( args: GetSolNetworkOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSolNetworkOperationCommandOutput) => void ): void; - public getSolNetworkOperation( - args: GetSolNetworkOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSolNetworkOperationCommandOutput) => void), - cb?: (err: any, data?: GetSolNetworkOperationCommandOutput) => void - ): Promise | void { - const command = new GetSolNetworkOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the details of a network package.

- *

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

+ * @see {@link GetSolNetworkPackageCommand} */ - public getSolNetworkPackage( + getSolNetworkPackage( args: GetSolNetworkPackageCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSolNetworkPackage( + getSolNetworkPackage( args: GetSolNetworkPackageCommandInput, cb: (err: any, data?: GetSolNetworkPackageCommandOutput) => void ): void; - public getSolNetworkPackage( + getSolNetworkPackage( args: GetSolNetworkPackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSolNetworkPackageCommandOutput) => void ): void; - public getSolNetworkPackage( - args: GetSolNetworkPackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSolNetworkPackageCommandOutput) => void), - cb?: (err: any, data?: GetSolNetworkPackageCommandOutput) => void - ): Promise | void { - const command = new GetSolNetworkPackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the contents of a network package.

- *

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

+ * @see {@link GetSolNetworkPackageContentCommand} */ - public getSolNetworkPackageContent( + getSolNetworkPackageContent( args: GetSolNetworkPackageContentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSolNetworkPackageContent( + getSolNetworkPackageContent( args: GetSolNetworkPackageContentCommandInput, cb: (err: any, data?: GetSolNetworkPackageContentCommandOutput) => void ): void; - public getSolNetworkPackageContent( + getSolNetworkPackageContent( args: GetSolNetworkPackageContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSolNetworkPackageContentCommandOutput) => void ): void; - public getSolNetworkPackageContent( - args: GetSolNetworkPackageContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSolNetworkPackageContentCommandOutput) => void), - cb?: (err: any, data?: GetSolNetworkPackageContentCommandOutput) => void - ): Promise | void { - const command = new GetSolNetworkPackageContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the content of the network service descriptor.

- *

A network service descriptor is a .yaml file in a network package that uses the TOSCA standard to describe the network functions you want to deploy and the Amazon Web Services infrastructure you want to deploy the network functions on.

+ * @see {@link GetSolNetworkPackageDescriptorCommand} */ - public getSolNetworkPackageDescriptor( + getSolNetworkPackageDescriptor( args: GetSolNetworkPackageDescriptorCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSolNetworkPackageDescriptor( + getSolNetworkPackageDescriptor( args: GetSolNetworkPackageDescriptorCommandInput, cb: (err: any, data?: GetSolNetworkPackageDescriptorCommandOutput) => void ): void; - public getSolNetworkPackageDescriptor( + getSolNetworkPackageDescriptor( args: GetSolNetworkPackageDescriptorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSolNetworkPackageDescriptorCommandOutput) => void ): void; - public getSolNetworkPackageDescriptor( - args: GetSolNetworkPackageDescriptorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSolNetworkPackageDescriptorCommandOutput) => void), - cb?: (err: any, data?: GetSolNetworkPackageDescriptorCommandOutput) => void - ): Promise | void { - const command = new GetSolNetworkPackageDescriptorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Instantiates a network instance.

- *

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

- *

Before you can instantiate a network instance, you have to create a network instance. For more information, see CreateSolNetworkInstance.

+ * @see {@link InstantiateSolNetworkInstanceCommand} */ - public instantiateSolNetworkInstance( + instantiateSolNetworkInstance( args: InstantiateSolNetworkInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public instantiateSolNetworkInstance( + instantiateSolNetworkInstance( args: InstantiateSolNetworkInstanceCommandInput, cb: (err: any, data?: InstantiateSolNetworkInstanceCommandOutput) => void ): void; - public instantiateSolNetworkInstance( + instantiateSolNetworkInstance( args: InstantiateSolNetworkInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InstantiateSolNetworkInstanceCommandOutput) => void ): void; - public instantiateSolNetworkInstance( - args: InstantiateSolNetworkInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InstantiateSolNetworkInstanceCommandOutput) => void), - cb?: (err: any, data?: InstantiateSolNetworkInstanceCommandOutput) => void - ): Promise | void { - const command = new InstantiateSolNetworkInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists network function instances.

- *

A network function instance is a function in a function package .

+ * @see {@link ListSolFunctionInstancesCommand} */ - public listSolFunctionInstances( + listSolFunctionInstances( args: ListSolFunctionInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSolFunctionInstances( + listSolFunctionInstances( args: ListSolFunctionInstancesCommandInput, cb: (err: any, data?: ListSolFunctionInstancesCommandOutput) => void ): void; - public listSolFunctionInstances( + listSolFunctionInstances( args: ListSolFunctionInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSolFunctionInstancesCommandOutput) => void ): void; - public listSolFunctionInstances( - args: ListSolFunctionInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSolFunctionInstancesCommandOutput) => void), - cb?: (err: any, data?: ListSolFunctionInstancesCommandOutput) => void - ): Promise | void { - const command = new ListSolFunctionInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists information about function packages.

- *

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

+ * @see {@link ListSolFunctionPackagesCommand} */ - public listSolFunctionPackages( + listSolFunctionPackages( args: ListSolFunctionPackagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSolFunctionPackages( + listSolFunctionPackages( args: ListSolFunctionPackagesCommandInput, cb: (err: any, data?: ListSolFunctionPackagesCommandOutput) => void ): void; - public listSolFunctionPackages( + listSolFunctionPackages( args: ListSolFunctionPackagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSolFunctionPackagesCommandOutput) => void ): void; - public listSolFunctionPackages( - args: ListSolFunctionPackagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSolFunctionPackagesCommandOutput) => void), - cb?: (err: any, data?: ListSolFunctionPackagesCommandOutput) => void - ): Promise | void { - const command = new ListSolFunctionPackagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists your network instances.

- *

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

+ * @see {@link ListSolNetworkInstancesCommand} */ - public listSolNetworkInstances( + listSolNetworkInstances( args: ListSolNetworkInstancesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSolNetworkInstances( + listSolNetworkInstances( args: ListSolNetworkInstancesCommandInput, cb: (err: any, data?: ListSolNetworkInstancesCommandOutput) => void ): void; - public listSolNetworkInstances( + listSolNetworkInstances( args: ListSolNetworkInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSolNetworkInstancesCommandOutput) => void ): void; - public listSolNetworkInstances( - args: ListSolNetworkInstancesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSolNetworkInstancesCommandOutput) => void), - cb?: (err: any, data?: ListSolNetworkInstancesCommandOutput) => void - ): Promise | void { - const command = new ListSolNetworkInstancesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists details for a network operation, including when the operation started and the status of the operation.

- *

A network operation is any operation that is done to your network, such as network instance instantiation or termination.

+ * @see {@link ListSolNetworkOperationsCommand} */ - public listSolNetworkOperations( + listSolNetworkOperations( args: ListSolNetworkOperationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSolNetworkOperations( + listSolNetworkOperations( args: ListSolNetworkOperationsCommandInput, cb: (err: any, data?: ListSolNetworkOperationsCommandOutput) => void ): void; - public listSolNetworkOperations( + listSolNetworkOperations( args: ListSolNetworkOperationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSolNetworkOperationsCommandOutput) => void ): void; - public listSolNetworkOperations( - args: ListSolNetworkOperationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSolNetworkOperationsCommandOutput) => void), - cb?: (err: any, data?: ListSolNetworkOperationsCommandOutput) => void - ): Promise | void { - const command = new ListSolNetworkOperationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists network packages.

- *

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

+ * @see {@link ListSolNetworkPackagesCommand} */ - public listSolNetworkPackages( + listSolNetworkPackages( args: ListSolNetworkPackagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSolNetworkPackages( + listSolNetworkPackages( args: ListSolNetworkPackagesCommandInput, cb: (err: any, data?: ListSolNetworkPackagesCommandOutput) => void ): void; - public listSolNetworkPackages( + listSolNetworkPackages( args: ListSolNetworkPackagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSolNetworkPackagesCommandOutput) => void ): void; - public listSolNetworkPackages( - args: ListSolNetworkPackagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSolNetworkPackagesCommandOutput) => void), - cb?: (err: any, data?: ListSolNetworkPackagesCommandOutput) => void - ): Promise | void { - const command = new ListSolNetworkPackagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists tags for AWS TNB resources.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Uploads the contents of a function package.

- *

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

+ * @see {@link PutSolFunctionPackageContentCommand} */ - public putSolFunctionPackageContent( + putSolFunctionPackageContent( args: PutSolFunctionPackageContentCommandInput, options?: __HttpHandlerOptions ): Promise; - public putSolFunctionPackageContent( + putSolFunctionPackageContent( args: PutSolFunctionPackageContentCommandInput, cb: (err: any, data?: PutSolFunctionPackageContentCommandOutput) => void ): void; - public putSolFunctionPackageContent( + putSolFunctionPackageContent( args: PutSolFunctionPackageContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSolFunctionPackageContentCommandOutput) => void ): void; - public putSolFunctionPackageContent( - args: PutSolFunctionPackageContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutSolFunctionPackageContentCommandOutput) => void), - cb?: (err: any, data?: PutSolFunctionPackageContentCommandOutput) => void - ): Promise | void { - const command = new PutSolFunctionPackageContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Uploads the contents of a network package.

- *

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

+ * @see {@link PutSolNetworkPackageContentCommand} */ - public putSolNetworkPackageContent( + putSolNetworkPackageContent( args: PutSolNetworkPackageContentCommandInput, options?: __HttpHandlerOptions ): Promise; - public putSolNetworkPackageContent( + putSolNetworkPackageContent( args: PutSolNetworkPackageContentCommandInput, cb: (err: any, data?: PutSolNetworkPackageContentCommandOutput) => void ): void; - public putSolNetworkPackageContent( + putSolNetworkPackageContent( args: PutSolNetworkPackageContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSolNetworkPackageContentCommandOutput) => void ): void; - public putSolNetworkPackageContent( - args: PutSolNetworkPackageContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutSolNetworkPackageContentCommandOutput) => void), - cb?: (err: any, data?: PutSolNetworkPackageContentCommandOutput) => void - ): Promise | void { - const command = new PutSolNetworkPackageContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Tags an AWS TNB resource.

- *

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Terminates a network instance.

- *

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

- *

You must terminate a network instance before you can delete it.

+ * @see {@link TerminateSolNetworkInstanceCommand} */ - public terminateSolNetworkInstance( + terminateSolNetworkInstance( args: TerminateSolNetworkInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public terminateSolNetworkInstance( + terminateSolNetworkInstance( args: TerminateSolNetworkInstanceCommandInput, cb: (err: any, data?: TerminateSolNetworkInstanceCommandOutput) => void ): void; - public terminateSolNetworkInstance( + terminateSolNetworkInstance( args: TerminateSolNetworkInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TerminateSolNetworkInstanceCommandOutput) => void ): void; - public terminateSolNetworkInstance( - args: TerminateSolNetworkInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TerminateSolNetworkInstanceCommandOutput) => void), - cb?: (err: any, data?: TerminateSolNetworkInstanceCommandOutput) => void - ): Promise | void { - const command = new TerminateSolNetworkInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Untags an AWS TNB resource.

- *

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the operational state of function package.

- *

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

+ * @see {@link UpdateSolFunctionPackageCommand} */ - public updateSolFunctionPackage( + updateSolFunctionPackage( args: UpdateSolFunctionPackageCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSolFunctionPackage( + updateSolFunctionPackage( args: UpdateSolFunctionPackageCommandInput, cb: (err: any, data?: UpdateSolFunctionPackageCommandOutput) => void ): void; - public updateSolFunctionPackage( + updateSolFunctionPackage( args: UpdateSolFunctionPackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSolFunctionPackageCommandOutput) => void ): void; - public updateSolFunctionPackage( - args: UpdateSolFunctionPackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSolFunctionPackageCommandOutput) => void), - cb?: (err: any, data?: UpdateSolFunctionPackageCommandOutput) => void - ): Promise | void { - const command = new UpdateSolFunctionPackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update a network instance.

- *

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

+ * @see {@link UpdateSolNetworkInstanceCommand} */ - public updateSolNetworkInstance( + updateSolNetworkInstance( args: UpdateSolNetworkInstanceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSolNetworkInstance( + updateSolNetworkInstance( args: UpdateSolNetworkInstanceCommandInput, cb: (err: any, data?: UpdateSolNetworkInstanceCommandOutput) => void ): void; - public updateSolNetworkInstance( + updateSolNetworkInstance( args: UpdateSolNetworkInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSolNetworkInstanceCommandOutput) => void ): void; - public updateSolNetworkInstance( - args: UpdateSolNetworkInstanceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSolNetworkInstanceCommandOutput) => void), - cb?: (err: any, data?: UpdateSolNetworkInstanceCommandOutput) => void - ): Promise | void { - const command = new UpdateSolNetworkInstanceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the operational state of a network package.

- *

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

- *

A network service descriptor is a .yaml file in a network package that uses the TOSCA standard to describe the network functions you want to deploy and the Amazon Web Services infrastructure you want to deploy the network functions on.

+ * @see {@link UpdateSolNetworkPackageCommand} */ - public updateSolNetworkPackage( + updateSolNetworkPackage( args: UpdateSolNetworkPackageCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSolNetworkPackage( + updateSolNetworkPackage( args: UpdateSolNetworkPackageCommandInput, cb: (err: any, data?: UpdateSolNetworkPackageCommandOutput) => void ): void; - public updateSolNetworkPackage( + updateSolNetworkPackage( args: UpdateSolNetworkPackageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSolNetworkPackageCommandOutput) => void ): void; - public updateSolNetworkPackage( - args: UpdateSolNetworkPackageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSolNetworkPackageCommandOutput) => void), - cb?: (err: any, data?: UpdateSolNetworkPackageCommandOutput) => void - ): Promise | void { - const command = new UpdateSolNetworkPackageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Validates function package content. This can be used as a dry run before uploading function package content with PutSolFunctionPackageContent.

- *

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

+ * @see {@link ValidateSolFunctionPackageContentCommand} */ - public validateSolFunctionPackageContent( + validateSolFunctionPackageContent( args: ValidateSolFunctionPackageContentCommandInput, options?: __HttpHandlerOptions ): Promise; - public validateSolFunctionPackageContent( + validateSolFunctionPackageContent( args: ValidateSolFunctionPackageContentCommandInput, cb: (err: any, data?: ValidateSolFunctionPackageContentCommandOutput) => void ): void; - public validateSolFunctionPackageContent( + validateSolFunctionPackageContent( args: ValidateSolFunctionPackageContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidateSolFunctionPackageContentCommandOutput) => void ): void; - public validateSolFunctionPackageContent( - args: ValidateSolFunctionPackageContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ValidateSolFunctionPackageContentCommandOutput) => void), - cb?: (err: any, data?: ValidateSolFunctionPackageContentCommandOutput) => void - ): Promise | void { - const command = new ValidateSolFunctionPackageContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Validates network package content. This can be used as a dry run before uploading network package content with PutSolNetworkPackageContent.

- *

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

+ * @see {@link ValidateSolNetworkPackageContentCommand} */ - public validateSolNetworkPackageContent( + validateSolNetworkPackageContent( args: ValidateSolNetworkPackageContentCommandInput, options?: __HttpHandlerOptions ): Promise; - public validateSolNetworkPackageContent( + validateSolNetworkPackageContent( args: ValidateSolNetworkPackageContentCommandInput, cb: (err: any, data?: ValidateSolNetworkPackageContentCommandOutput) => void ): void; - public validateSolNetworkPackageContent( + validateSolNetworkPackageContent( args: ValidateSolNetworkPackageContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidateSolNetworkPackageContentCommandOutput) => void ): void; - public validateSolNetworkPackageContent( - args: ValidateSolNetworkPackageContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ValidateSolNetworkPackageContentCommandOutput) => void), - cb?: (err: any, data?: ValidateSolNetworkPackageContentCommandOutput) => void - ): Promise | void { - const command = new ValidateSolNetworkPackageContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Web Services Telco Network Builder (TNB) is a network automation service that helps you deploy and manage telecom networks. AWS TNB helps you with the lifecycle management of your telecommunication network functions throughout planning, deployment, and post-deployment activities.

+ */ +export class Tnb extends TnbClient implements Tnb {} +createAggregatedClient(commands, Tnb); diff --git a/clients/client-transcribe-streaming/src/TranscribeStreaming.ts b/clients/client-transcribe-streaming/src/TranscribeStreaming.ts index defd0abf96e6..9cf6fa51e4c8 100644 --- a/clients/client-transcribe-streaming/src/TranscribeStreaming.ts +++ b/clients/client-transcribe-streaming/src/TranscribeStreaming.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -16,197 +17,92 @@ import { StartStreamTranscriptionCommandInput, StartStreamTranscriptionCommandOutput, } from "./commands/StartStreamTranscriptionCommand"; -import { TranscribeStreamingClient } from "./TranscribeStreamingClient"; +import { TranscribeStreamingClient, TranscribeStreamingClientConfig } from "./TranscribeStreamingClient"; -/** - * @public - *

Amazon Transcribe streaming offers three main types of real-time transcription: - * Standard, Medical, and - * Call Analytics.

- *
    - *
  • - *

    - * Standard transcriptions are the most common option. Refer - * to for details.

    - *
  • - *
  • - *

    - * Medical transcriptions are tailored to medical professionals - * and incorporate medical terms. A common use case for this service is transcribing doctor-patient - * dialogue in real time, so doctors can focus on their patient instead of taking notes. Refer to - * for details.

    - *
  • - *
  • - *

    - * Call Analytics transcriptions are designed for use with call - * center audio on two different channels; if you're looking for insight into customer service calls, use this - * option. Refer to for details.

    - *
  • - *
- */ -export class TranscribeStreaming extends TranscribeStreamingClient { +const commands = { + StartCallAnalyticsStreamTranscriptionCommand, + StartMedicalStreamTranscriptionCommand, + StartStreamTranscriptionCommand, +}; + +export interface TranscribeStreaming { /** - * @public - *

Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to - * Amazon Transcribe and the transcription results are streamed to your application. Use this operation - * for Call Analytics transcriptions.

- *

The following parameters are required:

- *
    - *
  • - *

    - * language-code - *

    - *
  • - *
  • - *

    - * media-encoding - *

    - *
  • - *
  • - *

    - * sample-rate - *

    - *
  • - *
- *

For more information on streaming with Amazon Transcribe, see Transcribing streaming audio.

+ * @see {@link StartCallAnalyticsStreamTranscriptionCommand} */ - public startCallAnalyticsStreamTranscription( + startCallAnalyticsStreamTranscription( args: StartCallAnalyticsStreamTranscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startCallAnalyticsStreamTranscription( + startCallAnalyticsStreamTranscription( args: StartCallAnalyticsStreamTranscriptionCommandInput, cb: (err: any, data?: StartCallAnalyticsStreamTranscriptionCommandOutput) => void ): void; - public startCallAnalyticsStreamTranscription( + startCallAnalyticsStreamTranscription( args: StartCallAnalyticsStreamTranscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCallAnalyticsStreamTranscriptionCommandOutput) => void ): void; - public startCallAnalyticsStreamTranscription( - args: StartCallAnalyticsStreamTranscriptionCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: StartCallAnalyticsStreamTranscriptionCommandOutput) => void), - cb?: (err: any, data?: StartCallAnalyticsStreamTranscriptionCommandOutput) => void - ): Promise | void { - const command = new StartCallAnalyticsStreamTranscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to - * Amazon Transcribe Medical and the transcription results are streamed to your - * application.

- *

The following parameters are required:

- *
    - *
  • - *

    - * language-code - *

    - *
  • - *
  • - *

    - * media-encoding - *

    - *
  • - *
  • - *

    - * sample-rate - *

    - *
  • - *
- *

For more information on streaming with Amazon Transcribe Medical, see - * Transcribing - * streaming audio.

+ * @see {@link StartMedicalStreamTranscriptionCommand} */ - public startMedicalStreamTranscription( + startMedicalStreamTranscription( args: StartMedicalStreamTranscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startMedicalStreamTranscription( + startMedicalStreamTranscription( args: StartMedicalStreamTranscriptionCommandInput, cb: (err: any, data?: StartMedicalStreamTranscriptionCommandOutput) => void ): void; - public startMedicalStreamTranscription( + startMedicalStreamTranscription( args: StartMedicalStreamTranscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMedicalStreamTranscriptionCommandOutput) => void ): void; - public startMedicalStreamTranscription( - args: StartMedicalStreamTranscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartMedicalStreamTranscriptionCommandOutput) => void), - cb?: (err: any, data?: StartMedicalStreamTranscriptionCommandOutput) => void - ): Promise | void { - const command = new StartMedicalStreamTranscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to - * Amazon Transcribe and the transcription results are streamed to your application.

- *

The following parameters are required:

- *
    - *
  • - *

    - * language-code or identify-language - *

    - *
  • - *
  • - *

    - * media-encoding - *

    - *
  • - *
  • - *

    - * sample-rate - *

    - *
  • - *
- *

For more information on streaming with Amazon Transcribe, see Transcribing streaming audio.

+ * @see {@link StartStreamTranscriptionCommand} */ - public startStreamTranscription( + startStreamTranscription( args: StartStreamTranscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public startStreamTranscription( + startStreamTranscription( args: StartStreamTranscriptionCommandInput, cb: (err: any, data?: StartStreamTranscriptionCommandOutput) => void ): void; - public startStreamTranscription( + startStreamTranscription( args: StartStreamTranscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartStreamTranscriptionCommandOutput) => void ): void; - public startStreamTranscription( - args: StartStreamTranscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartStreamTranscriptionCommandOutput) => void), - cb?: (err: any, data?: StartStreamTranscriptionCommandOutput) => void - ): Promise | void { - const command = new StartStreamTranscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Transcribe streaming offers three main types of real-time transcription: + * Standard, Medical, and + * Call Analytics.

+ *
    + *
  • + *

    + * Standard transcriptions are the most common option. Refer + * to for details.

    + *
  • + *
  • + *

    + * Medical transcriptions are tailored to medical professionals + * and incorporate medical terms. A common use case for this service is transcribing doctor-patient + * dialogue in real time, so doctors can focus on their patient instead of taking notes. Refer to + * for details.

    + *
  • + *
  • + *

    + * Call Analytics transcriptions are designed for use with call + * center audio on two different channels; if you're looking for insight into customer service calls, use this + * option. Refer to for details.

    + *
  • + *
+ */ +export class TranscribeStreaming extends TranscribeStreamingClient implements TranscribeStreaming {} +createAggregatedClient(commands, TranscribeStreaming); diff --git a/clients/client-transcribe/src/Transcribe.ts b/clients/client-transcribe/src/Transcribe.ts index 648061d5aa79..dc9385270cf5 100644 --- a/clients/client-transcribe/src/Transcribe.ts +++ b/clients/client-transcribe/src/Transcribe.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -192,1602 +193,721 @@ import { UpdateVocabularyFilterCommandInput, UpdateVocabularyFilterCommandOutput, } from "./commands/UpdateVocabularyFilterCommand"; -import { TranscribeClient } from "./TranscribeClient"; +import { TranscribeClient, TranscribeClientConfig } from "./TranscribeClient"; -/** - * @public - *

Amazon Transcribe offers three main types of batch transcription: Standard, Medical, and - * Call Analytics.

- *
    - *
  • - *

    - * Standard transcriptions are the most common - * option. Refer to for details.

    - *
  • - *
  • - *

    - * Medical transcriptions are tailored to - * medical professionals and incorporate medical terms. A common use case for this - * service is transcribing doctor-patient dialogue into after-visit notes. Refer to - * for details.

    - *
  • - *
  • - *

    - * Call Analytics transcriptions are designed - * for use with call center audio on two different channels; if you're looking for - * insight into customer service calls, use this option. Refer to for details.

    - *
  • - *
- */ -export class Transcribe extends TranscribeClient { +const commands = { + CreateCallAnalyticsCategoryCommand, + CreateLanguageModelCommand, + CreateMedicalVocabularyCommand, + CreateVocabularyCommand, + CreateVocabularyFilterCommand, + DeleteCallAnalyticsCategoryCommand, + DeleteCallAnalyticsJobCommand, + DeleteLanguageModelCommand, + DeleteMedicalTranscriptionJobCommand, + DeleteMedicalVocabularyCommand, + DeleteTranscriptionJobCommand, + DeleteVocabularyCommand, + DeleteVocabularyFilterCommand, + DescribeLanguageModelCommand, + GetCallAnalyticsCategoryCommand, + GetCallAnalyticsJobCommand, + GetMedicalTranscriptionJobCommand, + GetMedicalVocabularyCommand, + GetTranscriptionJobCommand, + GetVocabularyCommand, + GetVocabularyFilterCommand, + ListCallAnalyticsCategoriesCommand, + ListCallAnalyticsJobsCommand, + ListLanguageModelsCommand, + ListMedicalTranscriptionJobsCommand, + ListMedicalVocabulariesCommand, + ListTagsForResourceCommand, + ListTranscriptionJobsCommand, + ListVocabulariesCommand, + ListVocabularyFiltersCommand, + StartCallAnalyticsJobCommand, + StartMedicalTranscriptionJobCommand, + StartTranscriptionJobCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateCallAnalyticsCategoryCommand, + UpdateMedicalVocabularyCommand, + UpdateVocabularyCommand, + UpdateVocabularyFilterCommand, +}; + +export interface Transcribe { /** - * @public - *

Creates a new Call Analytics category.

- *

All categories are automatically applied to your Call Analytics transcriptions. Note that in - * order to apply categories to your transcriptions, you must create them before submitting your - * transcription request, as categories cannot be applied retroactively.

- *

When creating a new category, you can use the InputType parameter to - * label the category as a POST_CALL or a REAL_TIME category. - * POST_CALL categories can only be applied to post-call transcriptions and - * REAL_TIME categories can only be applied to real-time transcriptions. If you - * do not include InputType, your category is created as a - * POST_CALL category by default.

- *

Call Analytics categories are composed of rules. For each category, you must create - * between 1 and 20 rules. Rules can include these parameters: , , , and .

- *

To update an existing category, see .

- *

To learn more about Call Analytics categories, see Creating categories for post-call - * transcriptions and Creating categories for - * real-time transcriptions.

+ * @see {@link CreateCallAnalyticsCategoryCommand} */ - public createCallAnalyticsCategory( + createCallAnalyticsCategory( args: CreateCallAnalyticsCategoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCallAnalyticsCategory( + createCallAnalyticsCategory( args: CreateCallAnalyticsCategoryCommandInput, cb: (err: any, data?: CreateCallAnalyticsCategoryCommandOutput) => void ): void; - public createCallAnalyticsCategory( + createCallAnalyticsCategory( args: CreateCallAnalyticsCategoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCallAnalyticsCategoryCommandOutput) => void ): void; - public createCallAnalyticsCategory( - args: CreateCallAnalyticsCategoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCallAnalyticsCategoryCommandOutput) => void), - cb?: (err: any, data?: CreateCallAnalyticsCategoryCommandOutput) => void - ): Promise | void { - const command = new CreateCallAnalyticsCategoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new custom language model.

- *

When creating a new custom language model, you must specify:

- *
    - *
  • - *

    If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband - * (audio sample rates under 16,000 Hz) base model

    - *
  • - *
  • - *

    The location of your training and tuning files (this must be an Amazon S3 URI)

    - *
  • - *
  • - *

    The language of your model

    - *
  • - *
  • - *

    A unique name for your model

    - *
  • - *
+ * @see {@link CreateLanguageModelCommand} */ - public createLanguageModel( + createLanguageModel( args: CreateLanguageModelCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLanguageModel( + createLanguageModel( args: CreateLanguageModelCommandInput, cb: (err: any, data?: CreateLanguageModelCommandOutput) => void ): void; - public createLanguageModel( + createLanguageModel( args: CreateLanguageModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLanguageModelCommandOutput) => void ): void; - public createLanguageModel( - args: CreateLanguageModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLanguageModelCommandOutput) => void), - cb?: (err: any, data?: CreateLanguageModelCommandOutput) => void - ): Promise | void { - const command = new CreateLanguageModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new custom medical vocabulary.

- *

Before creating a new custom medical vocabulary, you must first upload a text file - * that contains your vocabulary table into an Amazon S3 bucket. - * Note that this differs from , where you can - * include a list of terms within your request using the Phrases flag; - * CreateMedicalVocabulary does not support the Phrases - * flag and only accepts vocabularies in table format.

- *

Each language has a character set that contains all allowed characters for that - * specific language. If you use unsupported characters, your custom vocabulary request - * fails. Refer to Character Sets for Custom Vocabularies to get the character set for your - * language.

- *

For more information, see Custom - * vocabularies.

+ * @see {@link CreateMedicalVocabularyCommand} */ - public createMedicalVocabulary( + createMedicalVocabulary( args: CreateMedicalVocabularyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMedicalVocabulary( + createMedicalVocabulary( args: CreateMedicalVocabularyCommandInput, cb: (err: any, data?: CreateMedicalVocabularyCommandOutput) => void ): void; - public createMedicalVocabulary( + createMedicalVocabulary( args: CreateMedicalVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMedicalVocabularyCommandOutput) => void ): void; - public createMedicalVocabulary( - args: CreateMedicalVocabularyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMedicalVocabularyCommandOutput) => void), - cb?: (err: any, data?: CreateMedicalVocabularyCommandOutput) => void - ): Promise | void { - const command = new CreateMedicalVocabularyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new custom vocabulary.

- *

When creating a new custom vocabulary, you can either upload a text file that contains - * your new entries, phrases, and terms into an Amazon S3 bucket and include the - * URI in your request. Or you can include a list of terms directly in your request using - * the Phrases flag.

- *

Each language has a character set that contains all allowed characters for that - * specific language. If you use unsupported characters, your custom vocabulary request - * fails. Refer to Character Sets for Custom Vocabularies to get the character set for your - * language.

- *

For more information, see Custom - * vocabularies.

+ * @see {@link CreateVocabularyCommand} */ - public createVocabulary( + createVocabulary( args: CreateVocabularyCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVocabulary( + createVocabulary( args: CreateVocabularyCommandInput, cb: (err: any, data?: CreateVocabularyCommandOutput) => void ): void; - public createVocabulary( + createVocabulary( args: CreateVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVocabularyCommandOutput) => void ): void; - public createVocabulary( - args: CreateVocabularyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVocabularyCommandOutput) => void), - cb?: (err: any, data?: CreateVocabularyCommandOutput) => void - ): Promise | void { - const command = new CreateVocabularyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new custom vocabulary filter.

- *

You can use custom vocabulary filters to mask, delete, or flag specific words from - * your transcript. Custom vocabulary filters are commonly used to mask profanity in - * transcripts.

- *

Each language has a character set that contains all allowed characters for that - * specific language. If you use unsupported characters, your custom vocabulary filter - * request fails. Refer to Character Sets for Custom - * Vocabularies to get the character set for your language.

- *

For more information, see Vocabulary - * filtering.

+ * @see {@link CreateVocabularyFilterCommand} */ - public createVocabularyFilter( + createVocabularyFilter( args: CreateVocabularyFilterCommandInput, options?: __HttpHandlerOptions ): Promise; - public createVocabularyFilter( + createVocabularyFilter( args: CreateVocabularyFilterCommandInput, cb: (err: any, data?: CreateVocabularyFilterCommandOutput) => void ): void; - public createVocabularyFilter( + createVocabularyFilter( args: CreateVocabularyFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVocabularyFilterCommandOutput) => void ): void; - public createVocabularyFilter( - args: CreateVocabularyFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateVocabularyFilterCommandOutput) => void), - cb?: (err: any, data?: CreateVocabularyFilterCommandOutput) => void - ): Promise | void { - const command = new CreateVocabularyFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Call Analytics category. To use this operation, specify the name of the - * category you want to delete using CategoryName. Category names are case - * sensitive.

+ * @see {@link DeleteCallAnalyticsCategoryCommand} */ - public deleteCallAnalyticsCategory( + deleteCallAnalyticsCategory( args: DeleteCallAnalyticsCategoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCallAnalyticsCategory( + deleteCallAnalyticsCategory( args: DeleteCallAnalyticsCategoryCommandInput, cb: (err: any, data?: DeleteCallAnalyticsCategoryCommandOutput) => void ): void; - public deleteCallAnalyticsCategory( + deleteCallAnalyticsCategory( args: DeleteCallAnalyticsCategoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCallAnalyticsCategoryCommandOutput) => void ): void; - public deleteCallAnalyticsCategory( - args: DeleteCallAnalyticsCategoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCallAnalyticsCategoryCommandOutput) => void), - cb?: (err: any, data?: DeleteCallAnalyticsCategoryCommandOutput) => void - ): Promise | void { - const command = new DeleteCallAnalyticsCategoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a Call Analytics job. To use this operation, specify the name of the job you - * want to delete using CallAnalyticsJobName. Job names are case - * sensitive.

+ * @see {@link DeleteCallAnalyticsJobCommand} */ - public deleteCallAnalyticsJob( + deleteCallAnalyticsJob( args: DeleteCallAnalyticsJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCallAnalyticsJob( + deleteCallAnalyticsJob( args: DeleteCallAnalyticsJobCommandInput, cb: (err: any, data?: DeleteCallAnalyticsJobCommandOutput) => void ): void; - public deleteCallAnalyticsJob( + deleteCallAnalyticsJob( args: DeleteCallAnalyticsJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCallAnalyticsJobCommandOutput) => void ): void; - public deleteCallAnalyticsJob( - args: DeleteCallAnalyticsJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCallAnalyticsJobCommandOutput) => void), - cb?: (err: any, data?: DeleteCallAnalyticsJobCommandOutput) => void - ): Promise | void { - const command = new DeleteCallAnalyticsJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a custom language model. To use this operation, specify the name of the - * language model you want to delete using ModelName. custom language model - * names are case sensitive.

+ * @see {@link DeleteLanguageModelCommand} */ - public deleteLanguageModel( + deleteLanguageModel( args: DeleteLanguageModelCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLanguageModel( + deleteLanguageModel( args: DeleteLanguageModelCommandInput, cb: (err: any, data?: DeleteLanguageModelCommandOutput) => void ): void; - public deleteLanguageModel( + deleteLanguageModel( args: DeleteLanguageModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLanguageModelCommandOutput) => void ): void; - public deleteLanguageModel( - args: DeleteLanguageModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLanguageModelCommandOutput) => void), - cb?: (err: any, data?: DeleteLanguageModelCommandOutput) => void - ): Promise | void { - const command = new DeleteLanguageModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a medical transcription job. To use this operation, specify the name of the - * job you want to delete using MedicalTranscriptionJobName. Job names are - * case sensitive.

+ * @see {@link DeleteMedicalTranscriptionJobCommand} */ - public deleteMedicalTranscriptionJob( + deleteMedicalTranscriptionJob( args: DeleteMedicalTranscriptionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMedicalTranscriptionJob( + deleteMedicalTranscriptionJob( args: DeleteMedicalTranscriptionJobCommandInput, cb: (err: any, data?: DeleteMedicalTranscriptionJobCommandOutput) => void ): void; - public deleteMedicalTranscriptionJob( + deleteMedicalTranscriptionJob( args: DeleteMedicalTranscriptionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMedicalTranscriptionJobCommandOutput) => void ): void; - public deleteMedicalTranscriptionJob( - args: DeleteMedicalTranscriptionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMedicalTranscriptionJobCommandOutput) => void), - cb?: (err: any, data?: DeleteMedicalTranscriptionJobCommandOutput) => void - ): Promise | void { - const command = new DeleteMedicalTranscriptionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a custom medical vocabulary. To use this operation, specify the name of the - * custom vocabulary you want to delete using VocabularyName. Custom - * vocabulary names are case sensitive.

+ * @see {@link DeleteMedicalVocabularyCommand} */ - public deleteMedicalVocabulary( + deleteMedicalVocabulary( args: DeleteMedicalVocabularyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMedicalVocabulary( + deleteMedicalVocabulary( args: DeleteMedicalVocabularyCommandInput, cb: (err: any, data?: DeleteMedicalVocabularyCommandOutput) => void ): void; - public deleteMedicalVocabulary( + deleteMedicalVocabulary( args: DeleteMedicalVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMedicalVocabularyCommandOutput) => void ): void; - public deleteMedicalVocabulary( - args: DeleteMedicalVocabularyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMedicalVocabularyCommandOutput) => void), - cb?: (err: any, data?: DeleteMedicalVocabularyCommandOutput) => void - ): Promise | void { - const command = new DeleteMedicalVocabularyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a transcription job. To use this operation, specify the name of the job you - * want to delete using TranscriptionJobName. Job names are case - * sensitive.

+ * @see {@link DeleteTranscriptionJobCommand} */ - public deleteTranscriptionJob( + deleteTranscriptionJob( args: DeleteTranscriptionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTranscriptionJob( + deleteTranscriptionJob( args: DeleteTranscriptionJobCommandInput, cb: (err: any, data?: DeleteTranscriptionJobCommandOutput) => void ): void; - public deleteTranscriptionJob( + deleteTranscriptionJob( args: DeleteTranscriptionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTranscriptionJobCommandOutput) => void ): void; - public deleteTranscriptionJob( - args: DeleteTranscriptionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTranscriptionJobCommandOutput) => void), - cb?: (err: any, data?: DeleteTranscriptionJobCommandOutput) => void - ): Promise | void { - const command = new DeleteTranscriptionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a custom vocabulary. To use this operation, specify the name of the custom - * vocabulary you want to delete using VocabularyName. Custom vocabulary names - * are case sensitive.

+ * @see {@link DeleteVocabularyCommand} */ - public deleteVocabulary( + deleteVocabulary( args: DeleteVocabularyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVocabulary( + deleteVocabulary( args: DeleteVocabularyCommandInput, cb: (err: any, data?: DeleteVocabularyCommandOutput) => void ): void; - public deleteVocabulary( + deleteVocabulary( args: DeleteVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVocabularyCommandOutput) => void ): void; - public deleteVocabulary( - args: DeleteVocabularyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVocabularyCommandOutput) => void), - cb?: (err: any, data?: DeleteVocabularyCommandOutput) => void - ): Promise | void { - const command = new DeleteVocabularyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a custom vocabulary filter. To use this operation, specify the name of the - * custom vocabulary filter you want to delete using VocabularyFilterName. - * Custom vocabulary filter names are case sensitive.

+ * @see {@link DeleteVocabularyFilterCommand} */ - public deleteVocabularyFilter( + deleteVocabularyFilter( args: DeleteVocabularyFilterCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteVocabularyFilter( + deleteVocabularyFilter( args: DeleteVocabularyFilterCommandInput, cb: (err: any, data?: DeleteVocabularyFilterCommandOutput) => void ): void; - public deleteVocabularyFilter( + deleteVocabularyFilter( args: DeleteVocabularyFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVocabularyFilterCommandOutput) => void ): void; - public deleteVocabularyFilter( - args: DeleteVocabularyFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteVocabularyFilterCommandOutput) => void), - cb?: (err: any, data?: DeleteVocabularyFilterCommandOutput) => void - ): Promise | void { - const command = new DeleteVocabularyFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides information about the specified custom language model.

- *

This operation also shows if the base language model that you used to create your - * custom language model has been updated. If Amazon Transcribe has updated the base - * model, you can create a new custom language model using the updated base model.

- *

If you tried to create a new custom language model and the request wasn't successful, - * you can use DescribeLanguageModel to help identify the reason for this - * failure.

+ * @see {@link DescribeLanguageModelCommand} */ - public describeLanguageModel( + describeLanguageModel( args: DescribeLanguageModelCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeLanguageModel( + describeLanguageModel( args: DescribeLanguageModelCommandInput, cb: (err: any, data?: DescribeLanguageModelCommandOutput) => void ): void; - public describeLanguageModel( + describeLanguageModel( args: DescribeLanguageModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLanguageModelCommandOutput) => void ): void; - public describeLanguageModel( - args: DescribeLanguageModelCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeLanguageModelCommandOutput) => void), - cb?: (err: any, data?: DescribeLanguageModelCommandOutput) => void - ): Promise | void { - const command = new DescribeLanguageModelCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides information about the specified Call Analytics category.

- *

To get a list of your Call Analytics categories, use the operation.

+ * @see {@link GetCallAnalyticsCategoryCommand} */ - public getCallAnalyticsCategory( + getCallAnalyticsCategory( args: GetCallAnalyticsCategoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCallAnalyticsCategory( + getCallAnalyticsCategory( args: GetCallAnalyticsCategoryCommandInput, cb: (err: any, data?: GetCallAnalyticsCategoryCommandOutput) => void ): void; - public getCallAnalyticsCategory( + getCallAnalyticsCategory( args: GetCallAnalyticsCategoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCallAnalyticsCategoryCommandOutput) => void ): void; - public getCallAnalyticsCategory( - args: GetCallAnalyticsCategoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCallAnalyticsCategoryCommandOutput) => void), - cb?: (err: any, data?: GetCallAnalyticsCategoryCommandOutput) => void - ): Promise | void { - const command = new GetCallAnalyticsCategoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides information about the specified Call Analytics job.

- *

To view the job's status, refer to CallAnalyticsJobStatus. If the status - * is COMPLETED, the job is finished. You can find your completed transcript - * at the URI specified in TranscriptFileUri. If the status is - * FAILED, FailureReason provides details on why your - * transcription job failed.

- *

If you enabled personally identifiable information (PII) redaction, the redacted - * transcript appears at the location specified in - * RedactedTranscriptFileUri.

- *

If you chose to redact the audio in your media file, you can find your redacted media - * file at the location specified in RedactedMediaFileUri.

- *

To get a list of your Call Analytics jobs, use the operation.

+ * @see {@link GetCallAnalyticsJobCommand} */ - public getCallAnalyticsJob( + getCallAnalyticsJob( args: GetCallAnalyticsJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCallAnalyticsJob( + getCallAnalyticsJob( args: GetCallAnalyticsJobCommandInput, cb: (err: any, data?: GetCallAnalyticsJobCommandOutput) => void ): void; - public getCallAnalyticsJob( + getCallAnalyticsJob( args: GetCallAnalyticsJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCallAnalyticsJobCommandOutput) => void ): void; - public getCallAnalyticsJob( - args: GetCallAnalyticsJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCallAnalyticsJobCommandOutput) => void), - cb?: (err: any, data?: GetCallAnalyticsJobCommandOutput) => void - ): Promise | void { - const command = new GetCallAnalyticsJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides information about the specified medical transcription job.

- *

To view the status of the specified medical transcription job, check the - * TranscriptionJobStatus field. If the status is COMPLETED, - * the job is finished. You can find the results at the location specified in - * TranscriptFileUri. If the status is FAILED, - * FailureReason provides details on why your transcription job - * failed.

- *

To get a list of your medical transcription jobs, use the operation.

+ * @see {@link GetMedicalTranscriptionJobCommand} */ - public getMedicalTranscriptionJob( + getMedicalTranscriptionJob( args: GetMedicalTranscriptionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMedicalTranscriptionJob( + getMedicalTranscriptionJob( args: GetMedicalTranscriptionJobCommandInput, cb: (err: any, data?: GetMedicalTranscriptionJobCommandOutput) => void ): void; - public getMedicalTranscriptionJob( + getMedicalTranscriptionJob( args: GetMedicalTranscriptionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMedicalTranscriptionJobCommandOutput) => void ): void; - public getMedicalTranscriptionJob( - args: GetMedicalTranscriptionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMedicalTranscriptionJobCommandOutput) => void), - cb?: (err: any, data?: GetMedicalTranscriptionJobCommandOutput) => void - ): Promise | void { - const command = new GetMedicalTranscriptionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides information about the specified custom medical vocabulary.

- *

To view the status of the specified custom medical vocabulary, check the - * VocabularyState field. If the status is READY, your custom - * vocabulary is available to use. If the status is FAILED, - * FailureReason provides details on why your vocabulary failed.

- *

To get a list of your custom medical vocabularies, use the operation.

+ * @see {@link GetMedicalVocabularyCommand} */ - public getMedicalVocabulary( + getMedicalVocabulary( args: GetMedicalVocabularyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMedicalVocabulary( + getMedicalVocabulary( args: GetMedicalVocabularyCommandInput, cb: (err: any, data?: GetMedicalVocabularyCommandOutput) => void ): void; - public getMedicalVocabulary( + getMedicalVocabulary( args: GetMedicalVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMedicalVocabularyCommandOutput) => void ): void; - public getMedicalVocabulary( - args: GetMedicalVocabularyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMedicalVocabularyCommandOutput) => void), - cb?: (err: any, data?: GetMedicalVocabularyCommandOutput) => void - ): Promise | void { - const command = new GetMedicalVocabularyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides information about the specified transcription job.

- *

To view the status of the specified transcription job, check the - * TranscriptionJobStatus field. If the status is COMPLETED, - * the job is finished. You can find the results at the location specified in - * TranscriptFileUri. If the status is FAILED, - * FailureReason provides details on why your transcription job - * failed.

- *

If you enabled content redaction, the redacted transcript can be found at the location - * specified in RedactedTranscriptFileUri.

- *

To get a list of your transcription jobs, use the operation.

+ * @see {@link GetTranscriptionJobCommand} */ - public getTranscriptionJob( + getTranscriptionJob( args: GetTranscriptionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTranscriptionJob( + getTranscriptionJob( args: GetTranscriptionJobCommandInput, cb: (err: any, data?: GetTranscriptionJobCommandOutput) => void ): void; - public getTranscriptionJob( + getTranscriptionJob( args: GetTranscriptionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTranscriptionJobCommandOutput) => void ): void; - public getTranscriptionJob( - args: GetTranscriptionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTranscriptionJobCommandOutput) => void), - cb?: (err: any, data?: GetTranscriptionJobCommandOutput) => void - ): Promise | void { - const command = new GetTranscriptionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides information about the specified custom vocabulary.

- *

To view the status of the specified custom vocabulary, check the - * VocabularyState field. If the status is READY, your custom - * vocabulary is available to use. If the status is FAILED, - * FailureReason provides details on why your custom vocabulary - * failed.

- *

To get a list of your custom vocabularies, use the operation.

+ * @see {@link GetVocabularyCommand} */ - public getVocabulary( - args: GetVocabularyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getVocabulary( - args: GetVocabularyCommandInput, - cb: (err: any, data?: GetVocabularyCommandOutput) => void - ): void; - public getVocabulary( + getVocabulary(args: GetVocabularyCommandInput, options?: __HttpHandlerOptions): Promise; + getVocabulary(args: GetVocabularyCommandInput, cb: (err: any, data?: GetVocabularyCommandOutput) => void): void; + getVocabulary( args: GetVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVocabularyCommandOutput) => void ): void; - public getVocabulary( - args: GetVocabularyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVocabularyCommandOutput) => void), - cb?: (err: any, data?: GetVocabularyCommandOutput) => void - ): Promise | void { - const command = new GetVocabularyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides information about the specified custom vocabulary filter.

- *

To get a list of your custom vocabulary filters, use the operation.

+ * @see {@link GetVocabularyFilterCommand} */ - public getVocabularyFilter( + getVocabularyFilter( args: GetVocabularyFilterCommandInput, options?: __HttpHandlerOptions ): Promise; - public getVocabularyFilter( + getVocabularyFilter( args: GetVocabularyFilterCommandInput, cb: (err: any, data?: GetVocabularyFilterCommandOutput) => void ): void; - public getVocabularyFilter( + getVocabularyFilter( args: GetVocabularyFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVocabularyFilterCommandOutput) => void ): void; - public getVocabularyFilter( - args: GetVocabularyFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVocabularyFilterCommandOutput) => void), - cb?: (err: any, data?: GetVocabularyFilterCommandOutput) => void - ): Promise | void { - const command = new GetVocabularyFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a list of Call Analytics categories, including all rules that make up each - * category.

- *

To get detailed information about a specific Call Analytics category, use the operation.

+ * @see {@link ListCallAnalyticsCategoriesCommand} */ - public listCallAnalyticsCategories( + listCallAnalyticsCategories( args: ListCallAnalyticsCategoriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCallAnalyticsCategories( + listCallAnalyticsCategories( args: ListCallAnalyticsCategoriesCommandInput, cb: (err: any, data?: ListCallAnalyticsCategoriesCommandOutput) => void ): void; - public listCallAnalyticsCategories( + listCallAnalyticsCategories( args: ListCallAnalyticsCategoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCallAnalyticsCategoriesCommandOutput) => void ): void; - public listCallAnalyticsCategories( - args: ListCallAnalyticsCategoriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCallAnalyticsCategoriesCommandOutput) => void), - cb?: (err: any, data?: ListCallAnalyticsCategoriesCommandOutput) => void - ): Promise | void { - const command = new ListCallAnalyticsCategoriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a list of Call Analytics jobs that match the specified criteria. If no - * criteria are specified, all Call Analytics jobs are returned.

- *

To get detailed information about a specific Call Analytics job, use the operation.

+ * @see {@link ListCallAnalyticsJobsCommand} */ - public listCallAnalyticsJobs( + listCallAnalyticsJobs( args: ListCallAnalyticsJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCallAnalyticsJobs( + listCallAnalyticsJobs( args: ListCallAnalyticsJobsCommandInput, cb: (err: any, data?: ListCallAnalyticsJobsCommandOutput) => void ): void; - public listCallAnalyticsJobs( + listCallAnalyticsJobs( args: ListCallAnalyticsJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCallAnalyticsJobsCommandOutput) => void ): void; - public listCallAnalyticsJobs( - args: ListCallAnalyticsJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCallAnalyticsJobsCommandOutput) => void), - cb?: (err: any, data?: ListCallAnalyticsJobsCommandOutput) => void - ): Promise | void { - const command = new ListCallAnalyticsJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a list of custom language models that match the specified criteria. If no - * criteria are specified, all custom language models are returned.

- *

To get detailed information about a specific custom language model, use the operation.

+ * @see {@link ListLanguageModelsCommand} */ - public listLanguageModels( + listLanguageModels( args: ListLanguageModelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLanguageModels( + listLanguageModels( args: ListLanguageModelsCommandInput, cb: (err: any, data?: ListLanguageModelsCommandOutput) => void ): void; - public listLanguageModels( + listLanguageModels( args: ListLanguageModelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLanguageModelsCommandOutput) => void ): void; - public listLanguageModels( - args: ListLanguageModelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLanguageModelsCommandOutput) => void), - cb?: (err: any, data?: ListLanguageModelsCommandOutput) => void - ): Promise | void { - const command = new ListLanguageModelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a list of medical transcription jobs that match the specified criteria. If no - * criteria are specified, all medical transcription jobs are returned.

- *

To get detailed information about a specific medical transcription job, use the operation.

+ * @see {@link ListMedicalTranscriptionJobsCommand} */ - public listMedicalTranscriptionJobs( + listMedicalTranscriptionJobs( args: ListMedicalTranscriptionJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMedicalTranscriptionJobs( + listMedicalTranscriptionJobs( args: ListMedicalTranscriptionJobsCommandInput, cb: (err: any, data?: ListMedicalTranscriptionJobsCommandOutput) => void ): void; - public listMedicalTranscriptionJobs( + listMedicalTranscriptionJobs( args: ListMedicalTranscriptionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMedicalTranscriptionJobsCommandOutput) => void ): void; - public listMedicalTranscriptionJobs( - args: ListMedicalTranscriptionJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMedicalTranscriptionJobsCommandOutput) => void), - cb?: (err: any, data?: ListMedicalTranscriptionJobsCommandOutput) => void - ): Promise | void { - const command = new ListMedicalTranscriptionJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a list of custom medical vocabularies that match the specified criteria. If - * no criteria are specified, all custom medical vocabularies are returned.

- *

To get detailed information about a specific custom medical vocabulary, use the operation.

+ * @see {@link ListMedicalVocabulariesCommand} */ - public listMedicalVocabularies( + listMedicalVocabularies( args: ListMedicalVocabulariesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMedicalVocabularies( + listMedicalVocabularies( args: ListMedicalVocabulariesCommandInput, cb: (err: any, data?: ListMedicalVocabulariesCommandOutput) => void ): void; - public listMedicalVocabularies( + listMedicalVocabularies( args: ListMedicalVocabulariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMedicalVocabulariesCommandOutput) => void ): void; - public listMedicalVocabularies( - args: ListMedicalVocabulariesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMedicalVocabulariesCommandOutput) => void), - cb?: (err: any, data?: ListMedicalVocabulariesCommandOutput) => void - ): Promise | void { - const command = new ListMedicalVocabulariesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all tags associated with the specified transcription job, vocabulary, model, or - * resource.

- *

To learn more about using tags with Amazon Transcribe, refer to Tagging - * resources.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a list of transcription jobs that match the specified criteria. If no - * criteria are specified, all transcription jobs are returned.

- *

To get detailed information about a specific transcription job, use the operation.

+ * @see {@link ListTranscriptionJobsCommand} */ - public listTranscriptionJobs( + listTranscriptionJobs( args: ListTranscriptionJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTranscriptionJobs( + listTranscriptionJobs( args: ListTranscriptionJobsCommandInput, cb: (err: any, data?: ListTranscriptionJobsCommandOutput) => void ): void; - public listTranscriptionJobs( + listTranscriptionJobs( args: ListTranscriptionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTranscriptionJobsCommandOutput) => void ): void; - public listTranscriptionJobs( - args: ListTranscriptionJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTranscriptionJobsCommandOutput) => void), - cb?: (err: any, data?: ListTranscriptionJobsCommandOutput) => void - ): Promise | void { - const command = new ListTranscriptionJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a list of custom vocabularies that match the specified criteria. If no - * criteria are specified, all custom vocabularies are returned.

- *

To get detailed information about a specific custom vocabulary, use the operation.

+ * @see {@link ListVocabulariesCommand} */ - public listVocabularies( + listVocabularies( args: ListVocabulariesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVocabularies( + listVocabularies( args: ListVocabulariesCommandInput, cb: (err: any, data?: ListVocabulariesCommandOutput) => void ): void; - public listVocabularies( + listVocabularies( args: ListVocabulariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVocabulariesCommandOutput) => void ): void; - public listVocabularies( - args: ListVocabulariesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVocabulariesCommandOutput) => void), - cb?: (err: any, data?: ListVocabulariesCommandOutput) => void - ): Promise | void { - const command = new ListVocabulariesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a list of custom vocabulary filters that match the specified criteria. If no - * criteria are specified, all custom vocabularies are returned.

- *

To get detailed information about a specific custom vocabulary filter, use the operation.

+ * @see {@link ListVocabularyFiltersCommand} */ - public listVocabularyFilters( + listVocabularyFilters( args: ListVocabularyFiltersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listVocabularyFilters( + listVocabularyFilters( args: ListVocabularyFiltersCommandInput, cb: (err: any, data?: ListVocabularyFiltersCommandOutput) => void ): void; - public listVocabularyFilters( + listVocabularyFilters( args: ListVocabularyFiltersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVocabularyFiltersCommandOutput) => void ): void; - public listVocabularyFilters( - args: ListVocabularyFiltersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListVocabularyFiltersCommandOutput) => void), - cb?: (err: any, data?: ListVocabularyFiltersCommandOutput) => void - ): Promise | void { - const command = new ListVocabularyFiltersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Transcribes the audio from a customer service call and applies any additional Request - * Parameters you choose to include in your request.

- *

In addition to many standard transcription features, Call Analytics provides you with - * call characteristics, call summarization, speaker sentiment, and optional redaction of - * your text transcript and your audio file. You can also apply custom categories to flag - * specified conditions. To learn more about these features and insights, refer to Analyzing call - * center audio with Call Analytics.

- *

If you want to apply categories to your Call Analytics job, you must create them - * before submitting your job request. Categories cannot be retroactively applied to a job. - * To create a new category, use the - * operation. To learn more about Call Analytics categories, see Creating categories for post-call - * transcriptions and Creating categories for - * real-time transcriptions.

- *

To make a StartCallAnalyticsJob request, you must first upload your media - * file into an Amazon S3 bucket; you can then specify the Amazon S3 - * location of the file using the Media parameter.

- *

Note that job queuing is enabled by default for Call Analytics jobs.

- *

You must include the following parameters in your StartCallAnalyticsJob - * request:

- *
    - *
  • - *

    - * region: The Amazon Web Services Region where you are making your - * request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and - * quotas.

    - *
  • - *
  • - *

    - * CallAnalyticsJobName: A custom name that you create for your - * transcription job that's unique within your Amazon Web Services account.

    - *
  • - *
  • - *

    - * DataAccessRoleArn: The Amazon Resource Name (ARN) of an IAM role - * that has permissions to access the Amazon S3 bucket that contains your - * input files.

    - *
  • - *
  • - *

    - * Media (MediaFileUri or - * RedactedMediaFileUri): The Amazon S3 location of your - * media file.

    - *
  • - *
- * - *

With Call Analytics, you can redact the audio contained in your media file by - * including RedactedMediaFileUri, instead of MediaFileUri, - * to specify the location of your input audio. If you choose to redact your audio, you - * can find your redacted media at the location specified in the - * RedactedMediaFileUri field of your response.

- *
+ * @see {@link StartCallAnalyticsJobCommand} */ - public startCallAnalyticsJob( + startCallAnalyticsJob( args: StartCallAnalyticsJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startCallAnalyticsJob( + startCallAnalyticsJob( args: StartCallAnalyticsJobCommandInput, cb: (err: any, data?: StartCallAnalyticsJobCommandOutput) => void ): void; - public startCallAnalyticsJob( + startCallAnalyticsJob( args: StartCallAnalyticsJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCallAnalyticsJobCommandOutput) => void ): void; - public startCallAnalyticsJob( - args: StartCallAnalyticsJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartCallAnalyticsJobCommandOutput) => void), - cb?: (err: any, data?: StartCallAnalyticsJobCommandOutput) => void - ): Promise | void { - const command = new StartCallAnalyticsJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Transcribes the audio from a medical dictation or conversation and applies any - * additional Request Parameters you choose to include in your request.

- *

In addition to many standard transcription features, Amazon Transcribe Medical - * provides you with a robust medical vocabulary and, optionally, content identification, - * which adds flags to personal health information (PHI). To learn more about these - * features, refer to How Amazon Transcribe Medical - * works.

- *

To make a StartMedicalTranscriptionJob request, you must first upload - * your media file into an Amazon S3 bucket; you can then specify the S3 location - * of the file using the Media parameter.

- *

You must include the following parameters in your - * StartMedicalTranscriptionJob request:

- *
    - *
  • - *

    - * region: The Amazon Web Services Region where you are making your - * request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and - * quotas.

    - *
  • - *
  • - *

    - * MedicalTranscriptionJobName: A custom name you create for your - * transcription job that is unique within your Amazon Web Services account.

    - *
  • - *
  • - *

    - * Media (MediaFileUri): The Amazon S3 location - * of your media file.

    - *
  • - *
  • - *

    - * LanguageCode: This must be en-US.

    - *
  • - *
  • - *

    - * OutputBucketName: The Amazon S3 bucket where you want - * your transcript stored. If you want your output stored in a sub-folder of this - * bucket, you must also include OutputKey.

    - *
  • - *
  • - *

    - * Specialty: This must be PRIMARYCARE.

    - *
  • - *
  • - *

    - * Type: Choose whether your audio is a conversation or a - * dictation.

    - *
  • - *
+ * @see {@link StartMedicalTranscriptionJobCommand} */ - public startMedicalTranscriptionJob( + startMedicalTranscriptionJob( args: StartMedicalTranscriptionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startMedicalTranscriptionJob( + startMedicalTranscriptionJob( args: StartMedicalTranscriptionJobCommandInput, cb: (err: any, data?: StartMedicalTranscriptionJobCommandOutput) => void ): void; - public startMedicalTranscriptionJob( + startMedicalTranscriptionJob( args: StartMedicalTranscriptionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMedicalTranscriptionJobCommandOutput) => void ): void; - public startMedicalTranscriptionJob( - args: StartMedicalTranscriptionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartMedicalTranscriptionJobCommandOutput) => void), - cb?: (err: any, data?: StartMedicalTranscriptionJobCommandOutput) => void - ): Promise | void { - const command = new StartMedicalTranscriptionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Transcribes the audio from a media file and applies any additional Request Parameters - * you choose to include in your request.

- *

To make a StartTranscriptionJob request, you must first upload your media - * file into an Amazon S3 bucket; you can then specify the Amazon S3 - * location of the file using the Media parameter.

- *

You must include the following parameters in your StartTranscriptionJob - * request:

- *
    - *
  • - *

    - * region: The Amazon Web Services Region where you are making your - * request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and - * quotas.

    - *
  • - *
  • - *

    - * TranscriptionJobName: A custom name you create for your - * transcription job that is unique within your Amazon Web Services account.

    - *
  • - *
  • - *

    - * Media (MediaFileUri): The Amazon S3 location - * of your media file.

    - *
  • - *
  • - *

    One of LanguageCode, IdentifyLanguage, or - * IdentifyMultipleLanguages: If you know the language of your - * media file, specify it using the LanguageCode parameter; you can - * find all valid language codes in the Supported - * languages table. If you don't know the languages spoken in your - * media, use either IdentifyLanguage or - * IdentifyMultipleLanguages and let Amazon Transcribe identify - * the languages for you.

    - *
  • - *
+ * @see {@link StartTranscriptionJobCommand} */ - public startTranscriptionJob( + startTranscriptionJob( args: StartTranscriptionJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startTranscriptionJob( + startTranscriptionJob( args: StartTranscriptionJobCommandInput, cb: (err: any, data?: StartTranscriptionJobCommandOutput) => void ): void; - public startTranscriptionJob( + startTranscriptionJob( args: StartTranscriptionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTranscriptionJobCommandOutput) => void ): void; - public startTranscriptionJob( - args: StartTranscriptionJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartTranscriptionJobCommandOutput) => void), - cb?: (err: any, data?: StartTranscriptionJobCommandOutput) => void - ): Promise | void { - const command = new StartTranscriptionJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more custom tags, each in the form of a key:value pair, to the specified - * resource.

- *

To learn more about using tags with Amazon Transcribe, refer to Tagging - * resources.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified tags from the specified Amazon Transcribe resource.

- *

If you include UntagResource in your request, you must also include - * ResourceArn and TagKeys.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified Call Analytics category with new rules. Note that the - * UpdateCallAnalyticsCategory operation overwrites all existing rules - * contained in the specified category. You cannot append additional rules onto an existing - * category.

- *

To create a new category, see .

+ * @see {@link UpdateCallAnalyticsCategoryCommand} */ - public updateCallAnalyticsCategory( + updateCallAnalyticsCategory( args: UpdateCallAnalyticsCategoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCallAnalyticsCategory( + updateCallAnalyticsCategory( args: UpdateCallAnalyticsCategoryCommandInput, cb: (err: any, data?: UpdateCallAnalyticsCategoryCommandOutput) => void ): void; - public updateCallAnalyticsCategory( + updateCallAnalyticsCategory( args: UpdateCallAnalyticsCategoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCallAnalyticsCategoryCommandOutput) => void ): void; - public updateCallAnalyticsCategory( - args: UpdateCallAnalyticsCategoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCallAnalyticsCategoryCommandOutput) => void), - cb?: (err: any, data?: UpdateCallAnalyticsCategoryCommandOutput) => void - ): Promise | void { - const command = new UpdateCallAnalyticsCategoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing custom medical vocabulary with new values. This operation - * overwrites all existing information with your new values; you cannot append new terms - * onto an existing custom vocabulary.

+ * @see {@link UpdateMedicalVocabularyCommand} */ - public updateMedicalVocabulary( + updateMedicalVocabulary( args: UpdateMedicalVocabularyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMedicalVocabulary( + updateMedicalVocabulary( args: UpdateMedicalVocabularyCommandInput, cb: (err: any, data?: UpdateMedicalVocabularyCommandOutput) => void ): void; - public updateMedicalVocabulary( + updateMedicalVocabulary( args: UpdateMedicalVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMedicalVocabularyCommandOutput) => void ): void; - public updateMedicalVocabulary( - args: UpdateMedicalVocabularyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMedicalVocabularyCommandOutput) => void), - cb?: (err: any, data?: UpdateMedicalVocabularyCommandOutput) => void - ): Promise | void { - const command = new UpdateMedicalVocabularyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing custom vocabulary with new values. This operation overwrites all - * existing information with your new values; you cannot append new terms onto an existing - * custom vocabulary.

+ * @see {@link UpdateVocabularyCommand} */ - public updateVocabulary( + updateVocabulary( args: UpdateVocabularyCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVocabulary( + updateVocabulary( args: UpdateVocabularyCommandInput, cb: (err: any, data?: UpdateVocabularyCommandOutput) => void ): void; - public updateVocabulary( + updateVocabulary( args: UpdateVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVocabularyCommandOutput) => void ): void; - public updateVocabulary( - args: UpdateVocabularyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVocabularyCommandOutput) => void), - cb?: (err: any, data?: UpdateVocabularyCommandOutput) => void - ): Promise | void { - const command = new UpdateVocabularyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates an existing custom vocabulary filter with a new list of words. The new list - * you provide overwrites all previous entries; you cannot append new terms onto an - * existing custom vocabulary filter.

+ * @see {@link UpdateVocabularyFilterCommand} */ - public updateVocabularyFilter( + updateVocabularyFilter( args: UpdateVocabularyFilterCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateVocabularyFilter( + updateVocabularyFilter( args: UpdateVocabularyFilterCommandInput, cb: (err: any, data?: UpdateVocabularyFilterCommandOutput) => void ): void; - public updateVocabularyFilter( + updateVocabularyFilter( args: UpdateVocabularyFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVocabularyFilterCommandOutput) => void ): void; - public updateVocabularyFilter( - args: UpdateVocabularyFilterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateVocabularyFilterCommandOutput) => void), - cb?: (err: any, data?: UpdateVocabularyFilterCommandOutput) => void - ): Promise | void { - const command = new UpdateVocabularyFilterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Transcribe offers three main types of batch transcription: Standard, Medical, and + * Call Analytics.

+ *
    + *
  • + *

    + * Standard transcriptions are the most common + * option. Refer to for details.

    + *
  • + *
  • + *

    + * Medical transcriptions are tailored to + * medical professionals and incorporate medical terms. A common use case for this + * service is transcribing doctor-patient dialogue into after-visit notes. Refer to + * for details.

    + *
  • + *
  • + *

    + * Call Analytics transcriptions are designed + * for use with call center audio on two different channels; if you're looking for + * insight into customer service calls, use this option. Refer to for details.

    + *
  • + *
+ */ +export class Transcribe extends TranscribeClient implements Transcribe {} +createAggregatedClient(commands, Transcribe); diff --git a/clients/client-transfer/src/Transfer.ts b/clients/client-transfer/src/Transfer.ts index 5e71a3fbae01..32fa6cb1ce51 100644 --- a/clients/client-transfer/src/Transfer.ts +++ b/clients/client-transfer/src/Transfer.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -259,2003 +260,868 @@ import { UpdateServerCommandOutput, } from "./commands/UpdateServerCommand"; import { UpdateUserCommand, UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand"; -import { TransferClient } from "./TransferClient"; +import { TransferClient, TransferClientConfig } from "./TransferClient"; -/** - * @public - *

Transfer Family is a fully managed service that enables the transfer of files over the File - * Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File - * Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS. - * Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3. - * Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating - * with existing authentication systems, and providing DNS routing with Amazon Route 53 so - * nothing changes for your customers and partners, or their applications. With your data in - * Amazon S3, you can use it with Amazon Web Services for processing, analytics, machine learning, and - * archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and - * set up.

- */ -export class Transfer extends TransferClient { +const commands = { + CreateAccessCommand, + CreateAgreementCommand, + CreateConnectorCommand, + CreateProfileCommand, + CreateServerCommand, + CreateUserCommand, + CreateWorkflowCommand, + DeleteAccessCommand, + DeleteAgreementCommand, + DeleteCertificateCommand, + DeleteConnectorCommand, + DeleteHostKeyCommand, + DeleteProfileCommand, + DeleteServerCommand, + DeleteSshPublicKeyCommand, + DeleteUserCommand, + DeleteWorkflowCommand, + DescribeAccessCommand, + DescribeAgreementCommand, + DescribeCertificateCommand, + DescribeConnectorCommand, + DescribeExecutionCommand, + DescribeHostKeyCommand, + DescribeProfileCommand, + DescribeSecurityPolicyCommand, + DescribeServerCommand, + DescribeUserCommand, + DescribeWorkflowCommand, + ImportCertificateCommand, + ImportHostKeyCommand, + ImportSshPublicKeyCommand, + ListAccessesCommand, + ListAgreementsCommand, + ListCertificatesCommand, + ListConnectorsCommand, + ListExecutionsCommand, + ListHostKeysCommand, + ListProfilesCommand, + ListSecurityPoliciesCommand, + ListServersCommand, + ListTagsForResourceCommand, + ListUsersCommand, + ListWorkflowsCommand, + SendWorkflowStepStateCommand, + StartFileTransferCommand, + StartServerCommand, + StopServerCommand, + TagResourceCommand, + TestIdentityProviderCommand, + UntagResourceCommand, + UpdateAccessCommand, + UpdateAgreementCommand, + UpdateCertificateCommand, + UpdateConnectorCommand, + UpdateHostKeyCommand, + UpdateProfileCommand, + UpdateServerCommand, + UpdateUserCommand, +}; + +export interface Transfer { /** - * @public - *

Used by administrators to choose which groups in the directory should have access to - * upload and download files over the enabled protocols using Transfer Family. For example, a - * Microsoft Active Directory might contain 50,000 users, but only a small fraction might need - * the ability to transfer files to the server. An administrator can use - * CreateAccess to limit the access to the correct set of users who need this - * ability.

+ * @see {@link CreateAccessCommand} */ - public createAccess( - args: CreateAccessCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createAccess(args: CreateAccessCommandInput, cb: (err: any, data?: CreateAccessCommandOutput) => void): void; - public createAccess( + createAccess(args: CreateAccessCommandInput, options?: __HttpHandlerOptions): Promise; + createAccess(args: CreateAccessCommandInput, cb: (err: any, data?: CreateAccessCommandOutput) => void): void; + createAccess( args: CreateAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessCommandOutput) => void ): void; - public createAccess( - args: CreateAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAccessCommandOutput) => void), - cb?: (err: any, data?: CreateAccessCommandOutput) => void - ): Promise | void { - const command = new CreateAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, - * between an Transfer Family server and an AS2 process. The agreement defines the file and message - * transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family - * combines a server, local profile, partner profile, certificate, and other - * attributes.

- *

The partner is identified with the PartnerProfileId, and the AS2 process is identified with the LocalProfileId.

+ * @see {@link CreateAgreementCommand} */ - public createAgreement( + createAgreement( args: CreateAgreementCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAgreement( - args: CreateAgreementCommandInput, - cb: (err: any, data?: CreateAgreementCommandOutput) => void - ): void; - public createAgreement( + createAgreement(args: CreateAgreementCommandInput, cb: (err: any, data?: CreateAgreementCommandOutput) => void): void; + createAgreement( args: CreateAgreementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAgreementCommandOutput) => void ): void; - public createAgreement( - args: CreateAgreementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAgreementCommandOutput) => void), - cb?: (err: any, data?: CreateAgreementCommandOutput) => void - ): Promise | void { - const command = new CreateAgreementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates the connector, which captures the parameters for an outbound connection for the - * AS2 protocol. The connector is required for sending files to an externally hosted AS2 server. - * For more details about connectors, see Create AS2 connectors.

+ * @see {@link CreateConnectorCommand} */ - public createConnector( + createConnector( args: CreateConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConnector( - args: CreateConnectorCommandInput, - cb: (err: any, data?: CreateConnectorCommandOutput) => void - ): void; - public createConnector( + createConnector(args: CreateConnectorCommandInput, cb: (err: any, data?: CreateConnectorCommandOutput) => void): void; + createConnector( args: CreateConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectorCommandOutput) => void ): void; - public createConnector( - args: CreateConnectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConnectorCommandOutput) => void), - cb?: (err: any, data?: CreateConnectorCommandOutput) => void - ): Promise | void { - const command = new CreateConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates the local or partner profile to use for AS2 transfers.

+ * @see {@link CreateProfileCommand} */ - public createProfile( - args: CreateProfileCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createProfile( - args: CreateProfileCommandInput, - cb: (err: any, data?: CreateProfileCommandOutput) => void - ): void; - public createProfile( + createProfile(args: CreateProfileCommandInput, options?: __HttpHandlerOptions): Promise; + createProfile(args: CreateProfileCommandInput, cb: (err: any, data?: CreateProfileCommandOutput) => void): void; + createProfile( args: CreateProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProfileCommandOutput) => void ): void; - public createProfile( - args: CreateProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateProfileCommandOutput) => void), - cb?: (err: any, data?: CreateProfileCommandOutput) => void - ): Promise | void { - const command = new CreateProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Instantiates an auto-scaling virtual server based on the selected file transfer protocol - * in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work - * with users, use the service-generated ServerId property that is assigned to the - * newly created server.

+ * @see {@link CreateServerCommand} */ - public createServer( - args: CreateServerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createServer(args: CreateServerCommandInput, cb: (err: any, data?: CreateServerCommandOutput) => void): void; - public createServer( + createServer(args: CreateServerCommandInput, options?: __HttpHandlerOptions): Promise; + createServer(args: CreateServerCommandInput, cb: (err: any, data?: CreateServerCommandOutput) => void): void; + createServer( args: CreateServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServerCommandOutput) => void ): void; - public createServer( - args: CreateServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateServerCommandOutput) => void), - cb?: (err: any, data?: CreateServerCommandOutput) => void - ): Promise | void { - const command = new CreateServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a user and associates them with an existing file transfer protocol-enabled server. - * You can only create and associate users with servers that have the - * IdentityProviderType set to SERVICE_MANAGED. Using parameters for - * CreateUser, you can specify the user name, set the home directory, store the - * user's public key, and assign the user's Identity and Access Management (IAM) - * role. You can also optionally add a session policy, and assign metadata with tags that can - * be used to group and search for users.

+ * @see {@link CreateUserCommand} */ - public createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; - public createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; - public createUser( + createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; + createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; + createUser( args: CreateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserCommandOutput) => void ): void; - public createUser( - args: CreateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserCommandOutput) => void), - cb?: (err: any, data?: CreateUserCommandOutput) => void - ): Promise | void { - const command = new CreateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes. - * After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations. - *

+ * @see {@link CreateWorkflowCommand} */ - public createWorkflow( + createWorkflow( args: CreateWorkflowCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorkflow( - args: CreateWorkflowCommandInput, - cb: (err: any, data?: CreateWorkflowCommandOutput) => void - ): void; - public createWorkflow( + createWorkflow(args: CreateWorkflowCommandInput, cb: (err: any, data?: CreateWorkflowCommandOutput) => void): void; + createWorkflow( args: CreateWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkflowCommandOutput) => void ): void; - public createWorkflow( - args: CreateWorkflowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorkflowCommandOutput) => void), - cb?: (err: any, data?: CreateWorkflowCommandOutput) => void - ): Promise | void { - const command = new CreateWorkflowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows you to delete the access specified in the ServerID and - * ExternalID parameters.

+ * @see {@link DeleteAccessCommand} */ - public deleteAccess( - args: DeleteAccessCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteAccess(args: DeleteAccessCommandInput, cb: (err: any, data?: DeleteAccessCommandOutput) => void): void; - public deleteAccess( + deleteAccess(args: DeleteAccessCommandInput, options?: __HttpHandlerOptions): Promise; + deleteAccess(args: DeleteAccessCommandInput, cb: (err: any, data?: DeleteAccessCommandOutput) => void): void; + deleteAccess( args: DeleteAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessCommandOutput) => void ): void; - public deleteAccess( - args: DeleteAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAccessCommandOutput) => void), - cb?: (err: any, data?: DeleteAccessCommandOutput) => void - ): Promise | void { - const command = new DeleteAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete the agreement that's specified in the provided AgreementId.

+ * @see {@link DeleteAgreementCommand} */ - public deleteAgreement( + deleteAgreement( args: DeleteAgreementCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAgreement( - args: DeleteAgreementCommandInput, - cb: (err: any, data?: DeleteAgreementCommandOutput) => void - ): void; - public deleteAgreement( + deleteAgreement(args: DeleteAgreementCommandInput, cb: (err: any, data?: DeleteAgreementCommandOutput) => void): void; + deleteAgreement( args: DeleteAgreementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAgreementCommandOutput) => void ): void; - public deleteAgreement( - args: DeleteAgreementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAgreementCommandOutput) => void), - cb?: (err: any, data?: DeleteAgreementCommandOutput) => void - ): Promise | void { - const command = new DeleteAgreementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the certificate that's specified in the CertificateId - * parameter.

+ * @see {@link DeleteCertificateCommand} */ - public deleteCertificate( + deleteCertificate( args: DeleteCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCertificate( + deleteCertificate( args: DeleteCertificateCommandInput, cb: (err: any, data?: DeleteCertificateCommandOutput) => void ): void; - public deleteCertificate( + deleteCertificate( args: DeleteCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCertificateCommandOutput) => void ): void; - public deleteCertificate( - args: DeleteCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCertificateCommandOutput) => void), - cb?: (err: any, data?: DeleteCertificateCommandOutput) => void - ): Promise | void { - const command = new DeleteCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the agreement that's specified in the provided ConnectorId.

+ * @see {@link DeleteConnectorCommand} */ - public deleteConnector( + deleteConnector( args: DeleteConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConnector( - args: DeleteConnectorCommandInput, - cb: (err: any, data?: DeleteConnectorCommandOutput) => void - ): void; - public deleteConnector( + deleteConnector(args: DeleteConnectorCommandInput, cb: (err: any, data?: DeleteConnectorCommandOutput) => void): void; + deleteConnector( args: DeleteConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectorCommandOutput) => void ): void; - public deleteConnector( - args: DeleteConnectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConnectorCommandOutput) => void), - cb?: (err: any, data?: DeleteConnectorCommandOutput) => void - ): Promise | void { - const command = new DeleteConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the host key that's specified in the HoskKeyId parameter.

+ * @see {@link DeleteHostKeyCommand} */ - public deleteHostKey( - args: DeleteHostKeyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteHostKey( - args: DeleteHostKeyCommandInput, - cb: (err: any, data?: DeleteHostKeyCommandOutput) => void - ): void; - public deleteHostKey( + deleteHostKey(args: DeleteHostKeyCommandInput, options?: __HttpHandlerOptions): Promise; + deleteHostKey(args: DeleteHostKeyCommandInput, cb: (err: any, data?: DeleteHostKeyCommandOutput) => void): void; + deleteHostKey( args: DeleteHostKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHostKeyCommandOutput) => void ): void; - public deleteHostKey( - args: DeleteHostKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteHostKeyCommandOutput) => void), - cb?: (err: any, data?: DeleteHostKeyCommandOutput) => void - ): Promise | void { - const command = new DeleteHostKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the profile that's specified in the ProfileId parameter.

+ * @see {@link DeleteProfileCommand} */ - public deleteProfile( - args: DeleteProfileCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteProfile( - args: DeleteProfileCommandInput, - cb: (err: any, data?: DeleteProfileCommandOutput) => void - ): void; - public deleteProfile( + deleteProfile(args: DeleteProfileCommandInput, options?: __HttpHandlerOptions): Promise; + deleteProfile(args: DeleteProfileCommandInput, cb: (err: any, data?: DeleteProfileCommandOutput) => void): void; + deleteProfile( args: DeleteProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProfileCommandOutput) => void ): void; - public deleteProfile( - args: DeleteProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteProfileCommandOutput) => void), - cb?: (err: any, data?: DeleteProfileCommandOutput) => void - ): Promise | void { - const command = new DeleteProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the file transfer protocol-enabled server that you specify.

- *

No response returns from this operation.

+ * @see {@link DeleteServerCommand} */ - public deleteServer( - args: DeleteServerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteServer(args: DeleteServerCommandInput, cb: (err: any, data?: DeleteServerCommandOutput) => void): void; - public deleteServer( + deleteServer(args: DeleteServerCommandInput, options?: __HttpHandlerOptions): Promise; + deleteServer(args: DeleteServerCommandInput, cb: (err: any, data?: DeleteServerCommandOutput) => void): void; + deleteServer( args: DeleteServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServerCommandOutput) => void ): void; - public deleteServer( - args: DeleteServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteServerCommandOutput) => void), - cb?: (err: any, data?: DeleteServerCommandOutput) => void - ): Promise | void { - const command = new DeleteServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a user's Secure Shell (SSH) public key.

+ * @see {@link DeleteSshPublicKeyCommand} */ - public deleteSshPublicKey( + deleteSshPublicKey( args: DeleteSshPublicKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSshPublicKey( + deleteSshPublicKey( args: DeleteSshPublicKeyCommandInput, cb: (err: any, data?: DeleteSshPublicKeyCommandOutput) => void ): void; - public deleteSshPublicKey( + deleteSshPublicKey( args: DeleteSshPublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSshPublicKeyCommandOutput) => void ): void; - public deleteSshPublicKey( - args: DeleteSshPublicKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSshPublicKeyCommandOutput) => void), - cb?: (err: any, data?: DeleteSshPublicKeyCommandOutput) => void - ): Promise | void { - const command = new DeleteSshPublicKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the user belonging to a file transfer protocol-enabled server you specify.

- *

No response returns from this operation.

- * - *

When you delete a user from a server, the user's information is lost.

- *
+ * @see {@link DeleteUserCommand} */ - public deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; - public deleteUser( + deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; + deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; + deleteUser( args: DeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserCommandOutput) => void ): void; - public deleteUser( - args: DeleteUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserCommandOutput) => void), - cb?: (err: any, data?: DeleteUserCommandOutput) => void - ): Promise | void { - const command = new DeleteUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified workflow.

+ * @see {@link DeleteWorkflowCommand} */ - public deleteWorkflow( + deleteWorkflow( args: DeleteWorkflowCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWorkflow( - args: DeleteWorkflowCommandInput, - cb: (err: any, data?: DeleteWorkflowCommandOutput) => void - ): void; - public deleteWorkflow( + deleteWorkflow(args: DeleteWorkflowCommandInput, cb: (err: any, data?: DeleteWorkflowCommandOutput) => void): void; + deleteWorkflow( args: DeleteWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkflowCommandOutput) => void ): void; - public deleteWorkflow( - args: DeleteWorkflowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorkflowCommandOutput) => void), - cb?: (err: any, data?: DeleteWorkflowCommandOutput) => void - ): Promise | void { - const command = new DeleteWorkflowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the access that is assigned to the specific file transfer protocol-enabled - * server, as identified by its ServerId property and its - * ExternalId.

- *

The response from this call returns the properties of the access that is associated with - * the ServerId value that was specified.

+ * @see {@link DescribeAccessCommand} */ - public describeAccess( + describeAccess( args: DescribeAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccess( - args: DescribeAccessCommandInput, - cb: (err: any, data?: DescribeAccessCommandOutput) => void - ): void; - public describeAccess( + describeAccess(args: DescribeAccessCommandInput, cb: (err: any, data?: DescribeAccessCommandOutput) => void): void; + describeAccess( args: DescribeAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccessCommandOutput) => void ): void; - public describeAccess( - args: DescribeAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccessCommandOutput) => void), - cb?: (err: any, data?: DescribeAccessCommandOutput) => void - ): Promise | void { - const command = new DescribeAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the agreement that's identified by the AgreementId.

+ * @see {@link DescribeAgreementCommand} */ - public describeAgreement( + describeAgreement( args: DescribeAgreementCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAgreement( + describeAgreement( args: DescribeAgreementCommandInput, cb: (err: any, data?: DescribeAgreementCommandOutput) => void ): void; - public describeAgreement( + describeAgreement( args: DescribeAgreementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAgreementCommandOutput) => void ): void; - public describeAgreement( - args: DescribeAgreementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAgreementCommandOutput) => void), - cb?: (err: any, data?: DescribeAgreementCommandOutput) => void - ): Promise | void { - const command = new DescribeAgreementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the certificate that's identified by the CertificateId.

+ * @see {@link DescribeCertificateCommand} */ - public describeCertificate( + describeCertificate( args: DescribeCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCertificate( + describeCertificate( args: DescribeCertificateCommandInput, cb: (err: any, data?: DescribeCertificateCommandOutput) => void ): void; - public describeCertificate( + describeCertificate( args: DescribeCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCertificateCommandOutput) => void ): void; - public describeCertificate( - args: DescribeCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCertificateCommandOutput) => void), - cb?: (err: any, data?: DescribeCertificateCommandOutput) => void - ): Promise | void { - const command = new DescribeCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the connector that's identified by the ConnectorId. - *

+ * @see {@link DescribeConnectorCommand} */ - public describeConnector( + describeConnector( args: DescribeConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConnector( + describeConnector( args: DescribeConnectorCommandInput, cb: (err: any, data?: DescribeConnectorCommandOutput) => void ): void; - public describeConnector( + describeConnector( args: DescribeConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectorCommandOutput) => void ): void; - public describeConnector( - args: DescribeConnectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConnectorCommandOutput) => void), - cb?: (err: any, data?: DescribeConnectorCommandOutput) => void - ): Promise | void { - const command = new DescribeConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

You can use DescribeExecution to check the details of the execution of the specified workflow.

+ * @see {@link DescribeExecutionCommand} */ - public describeExecution( + describeExecution( args: DescribeExecutionCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeExecution( + describeExecution( args: DescribeExecutionCommandInput, cb: (err: any, data?: DescribeExecutionCommandOutput) => void ): void; - public describeExecution( + describeExecution( args: DescribeExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExecutionCommandOutput) => void ): void; - public describeExecution( - args: DescribeExecutionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeExecutionCommandOutput) => void), - cb?: (err: any, data?: DescribeExecutionCommandOutput) => void - ): Promise | void { - const command = new DescribeExecutionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the details of the host key that's specified by the HostKeyId and ServerId.

+ * @see {@link DescribeHostKeyCommand} */ - public describeHostKey( + describeHostKey( args: DescribeHostKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeHostKey( - args: DescribeHostKeyCommandInput, - cb: (err: any, data?: DescribeHostKeyCommandOutput) => void - ): void; - public describeHostKey( + describeHostKey(args: DescribeHostKeyCommandInput, cb: (err: any, data?: DescribeHostKeyCommandOutput) => void): void; + describeHostKey( args: DescribeHostKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHostKeyCommandOutput) => void ): void; - public describeHostKey( - args: DescribeHostKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeHostKeyCommandOutput) => void), - cb?: (err: any, data?: DescribeHostKeyCommandOutput) => void - ): Promise | void { - const command = new DescribeHostKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the details of the profile that's specified by the ProfileId.

+ * @see {@link DescribeProfileCommand} */ - public describeProfile( + describeProfile( args: DescribeProfileCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeProfile( - args: DescribeProfileCommandInput, - cb: (err: any, data?: DescribeProfileCommandOutput) => void - ): void; - public describeProfile( + describeProfile(args: DescribeProfileCommandInput, cb: (err: any, data?: DescribeProfileCommandOutput) => void): void; + describeProfile( args: DescribeProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProfileCommandOutput) => void ): void; - public describeProfile( - args: DescribeProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeProfileCommandOutput) => void), - cb?: (err: any, data?: DescribeProfileCommandOutput) => void - ): Promise | void { - const command = new DescribeProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the security policy that is attached to your file transfer protocol-enabled - * server. The response contains a description of the security policy's properties. For more - * information about security policies, see Working with security - * policies.

+ * @see {@link DescribeSecurityPolicyCommand} */ - public describeSecurityPolicy( + describeSecurityPolicy( args: DescribeSecurityPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSecurityPolicy( + describeSecurityPolicy( args: DescribeSecurityPolicyCommandInput, cb: (err: any, data?: DescribeSecurityPolicyCommandOutput) => void ): void; - public describeSecurityPolicy( + describeSecurityPolicy( args: DescribeSecurityPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSecurityPolicyCommandOutput) => void ): void; - public describeSecurityPolicy( - args: DescribeSecurityPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSecurityPolicyCommandOutput) => void), - cb?: (err: any, data?: DescribeSecurityPolicyCommandOutput) => void - ): Promise | void { - const command = new DescribeSecurityPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes a file transfer protocol-enabled server that you specify by passing the - * ServerId parameter.

- *

The response contains a description of a server's properties. When you set - * EndpointType to VPC, the response will contain the - * EndpointDetails.

+ * @see {@link DescribeServerCommand} */ - public describeServer( + describeServer( args: DescribeServerCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeServer( - args: DescribeServerCommandInput, - cb: (err: any, data?: DescribeServerCommandOutput) => void - ): void; - public describeServer( + describeServer(args: DescribeServerCommandInput, cb: (err: any, data?: DescribeServerCommandOutput) => void): void; + describeServer( args: DescribeServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeServerCommandOutput) => void ): void; - public describeServer( - args: DescribeServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeServerCommandOutput) => void), - cb?: (err: any, data?: DescribeServerCommandOutput) => void - ): Promise | void { - const command = new DescribeServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the user assigned to the specific file transfer protocol-enabled server, as - * identified by its ServerId property.

- *

The response from this call returns the properties of the user associated with the - * ServerId value that was specified.

+ * @see {@link DescribeUserCommand} */ - public describeUser( - args: DescribeUserCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeUser(args: DescribeUserCommandInput, cb: (err: any, data?: DescribeUserCommandOutput) => void): void; - public describeUser( + describeUser(args: DescribeUserCommandInput, options?: __HttpHandlerOptions): Promise; + describeUser(args: DescribeUserCommandInput, cb: (err: any, data?: DescribeUserCommandOutput) => void): void; + describeUser( args: DescribeUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserCommandOutput) => void ): void; - public describeUser( - args: DescribeUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUserCommandOutput) => void), - cb?: (err: any, data?: DescribeUserCommandOutput) => void - ): Promise | void { - const command = new DescribeUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified workflow.

+ * @see {@link DescribeWorkflowCommand} */ - public describeWorkflow( + describeWorkflow( args: DescribeWorkflowCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWorkflow( + describeWorkflow( args: DescribeWorkflowCommandInput, cb: (err: any, data?: DescribeWorkflowCommandOutput) => void ): void; - public describeWorkflow( + describeWorkflow( args: DescribeWorkflowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkflowCommandOutput) => void ): void; - public describeWorkflow( - args: DescribeWorkflowCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWorkflowCommandOutput) => void), - cb?: (err: any, data?: DescribeWorkflowCommandOutput) => void - ): Promise | void { - const command = new DescribeWorkflowCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Imports the signing and encryption certificates that you need to create local (AS2) - * profiles and partner - * profiles.

+ * @see {@link ImportCertificateCommand} */ - public importCertificate( + importCertificate( args: ImportCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public importCertificate( + importCertificate( args: ImportCertificateCommandInput, cb: (err: any, data?: ImportCertificateCommandOutput) => void ): void; - public importCertificate( + importCertificate( args: ImportCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportCertificateCommandOutput) => void ): void; - public importCertificate( - args: ImportCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportCertificateCommandOutput) => void), - cb?: (err: any, data?: ImportCertificateCommandOutput) => void - ): Promise | void { - const command = new ImportCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a host key to the server that's specified by the ServerId - * parameter.

+ * @see {@link ImportHostKeyCommand} */ - public importHostKey( - args: ImportHostKeyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public importHostKey( - args: ImportHostKeyCommandInput, - cb: (err: any, data?: ImportHostKeyCommandOutput) => void - ): void; - public importHostKey( + importHostKey(args: ImportHostKeyCommandInput, options?: __HttpHandlerOptions): Promise; + importHostKey(args: ImportHostKeyCommandInput, cb: (err: any, data?: ImportHostKeyCommandOutput) => void): void; + importHostKey( args: ImportHostKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportHostKeyCommandOutput) => void ): void; - public importHostKey( - args: ImportHostKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportHostKeyCommandOutput) => void), - cb?: (err: any, data?: ImportHostKeyCommandOutput) => void - ): Promise | void { - const command = new ImportHostKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a Secure Shell (SSH) public key to a user account identified by a - * UserName value assigned to the specific file transfer protocol-enabled server, - * identified by ServerId.

- *

The response returns the UserName value, the ServerId value, and - * the name of the SshPublicKeyId.

+ * @see {@link ImportSshPublicKeyCommand} */ - public importSshPublicKey( + importSshPublicKey( args: ImportSshPublicKeyCommandInput, options?: __HttpHandlerOptions ): Promise; - public importSshPublicKey( + importSshPublicKey( args: ImportSshPublicKeyCommandInput, cb: (err: any, data?: ImportSshPublicKeyCommandOutput) => void ): void; - public importSshPublicKey( + importSshPublicKey( args: ImportSshPublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportSshPublicKeyCommandOutput) => void ): void; - public importSshPublicKey( - args: ImportSshPublicKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportSshPublicKeyCommandOutput) => void), - cb?: (err: any, data?: ImportSshPublicKeyCommandOutput) => void - ): Promise | void { - const command = new ImportSshPublicKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the details for all the accesses you have on your server.

+ * @see {@link ListAccessesCommand} */ - public listAccesses( - args: ListAccessesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listAccesses(args: ListAccessesCommandInput, cb: (err: any, data?: ListAccessesCommandOutput) => void): void; - public listAccesses( + listAccesses(args: ListAccessesCommandInput, options?: __HttpHandlerOptions): Promise; + listAccesses(args: ListAccessesCommandInput, cb: (err: any, data?: ListAccessesCommandOutput) => void): void; + listAccesses( args: ListAccessesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessesCommandOutput) => void ): void; - public listAccesses( - args: ListAccessesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccessesCommandOutput) => void), - cb?: (err: any, data?: ListAccessesCommandOutput) => void - ): Promise | void { - const command = new ListAccessesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the agreements for the server that's identified by the - * ServerId that you supply. If you want to limit the results to a certain number, - * supply a value for the MaxResults parameter. If you ran the command previously - * and received a value for NextToken, you can supply that value to continue listing - * agreements from where you left off.

+ * @see {@link ListAgreementsCommand} */ - public listAgreements( + listAgreements( args: ListAgreementsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAgreements( - args: ListAgreementsCommandInput, - cb: (err: any, data?: ListAgreementsCommandOutput) => void - ): void; - public listAgreements( + listAgreements(args: ListAgreementsCommandInput, cb: (err: any, data?: ListAgreementsCommandOutput) => void): void; + listAgreements( args: ListAgreementsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAgreementsCommandOutput) => void ): void; - public listAgreements( - args: ListAgreementsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAgreementsCommandOutput) => void), - cb?: (err: any, data?: ListAgreementsCommandOutput) => void - ): Promise | void { - const command = new ListAgreementsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the current certificates that have been imported into Transfer Family. If you want to - * limit the results to a certain number, supply a value for the MaxResults - * parameter. If you ran the command previously and received a value for the - * NextToken parameter, you can supply that value to continue listing certificates - * from where you left off.

+ * @see {@link ListCertificatesCommand} */ - public listCertificates( + listCertificates( args: ListCertificatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCertificates( + listCertificates( args: ListCertificatesCommandInput, cb: (err: any, data?: ListCertificatesCommandOutput) => void ): void; - public listCertificates( + listCertificates( args: ListCertificatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCertificatesCommandOutput) => void ): void; - public listCertificates( - args: ListCertificatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCertificatesCommandOutput) => void), - cb?: (err: any, data?: ListCertificatesCommandOutput) => void - ): Promise | void { - const command = new ListCertificatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the connectors for the specified Region.

+ * @see {@link ListConnectorsCommand} */ - public listConnectors( + listConnectors( args: ListConnectorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listConnectors( - args: ListConnectorsCommandInput, - cb: (err: any, data?: ListConnectorsCommandOutput) => void - ): void; - public listConnectors( + listConnectors(args: ListConnectorsCommandInput, cb: (err: any, data?: ListConnectorsCommandOutput) => void): void; + listConnectors( args: ListConnectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConnectorsCommandOutput) => void ): void; - public listConnectors( - args: ListConnectorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConnectorsCommandOutput) => void), - cb?: (err: any, data?: ListConnectorsCommandOutput) => void - ): Promise | void { - const command = new ListConnectorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all executions for the specified workflow.

+ * @see {@link ListExecutionsCommand} */ - public listExecutions( + listExecutions( args: ListExecutionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listExecutions( - args: ListExecutionsCommandInput, - cb: (err: any, data?: ListExecutionsCommandOutput) => void - ): void; - public listExecutions( + listExecutions(args: ListExecutionsCommandInput, cb: (err: any, data?: ListExecutionsCommandOutput) => void): void; + listExecutions( args: ListExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExecutionsCommandOutput) => void ): void; - public listExecutions( - args: ListExecutionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListExecutionsCommandOutput) => void), - cb?: (err: any, data?: ListExecutionsCommandOutput) => void - ): Promise | void { - const command = new ListExecutionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of host keys for the server that's specified by the ServerId - * parameter.

+ * @see {@link ListHostKeysCommand} */ - public listHostKeys( - args: ListHostKeysCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listHostKeys(args: ListHostKeysCommandInput, cb: (err: any, data?: ListHostKeysCommandOutput) => void): void; - public listHostKeys( + listHostKeys(args: ListHostKeysCommandInput, options?: __HttpHandlerOptions): Promise; + listHostKeys(args: ListHostKeysCommandInput, cb: (err: any, data?: ListHostKeysCommandOutput) => void): void; + listHostKeys( args: ListHostKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHostKeysCommandOutput) => void ): void; - public listHostKeys( - args: ListHostKeysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListHostKeysCommandOutput) => void), - cb?: (err: any, data?: ListHostKeysCommandOutput) => void - ): Promise | void { - const command = new ListHostKeysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the profiles for your system. If you want to limit the results to a - * certain number, supply a value for the MaxResults parameter. If you ran the - * command previously and received a value for NextToken, you can supply that value - * to continue listing profiles from where you left off.

+ * @see {@link ListProfilesCommand} */ - public listProfiles( - args: ListProfilesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listProfiles(args: ListProfilesCommandInput, cb: (err: any, data?: ListProfilesCommandOutput) => void): void; - public listProfiles( + listProfiles(args: ListProfilesCommandInput, options?: __HttpHandlerOptions): Promise; + listProfiles(args: ListProfilesCommandInput, cb: (err: any, data?: ListProfilesCommandOutput) => void): void; + listProfiles( args: ListProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProfilesCommandOutput) => void ): void; - public listProfiles( - args: ListProfilesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListProfilesCommandOutput) => void), - cb?: (err: any, data?: ListProfilesCommandOutput) => void - ): Promise | void { - const command = new ListProfilesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the security policies that are attached to your file transfer protocol-enabled - * servers.

+ * @see {@link ListSecurityPoliciesCommand} */ - public listSecurityPolicies( + listSecurityPolicies( args: ListSecurityPoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSecurityPolicies( + listSecurityPolicies( args: ListSecurityPoliciesCommandInput, cb: (err: any, data?: ListSecurityPoliciesCommandOutput) => void ): void; - public listSecurityPolicies( + listSecurityPolicies( args: ListSecurityPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSecurityPoliciesCommandOutput) => void ): void; - public listSecurityPolicies( - args: ListSecurityPoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSecurityPoliciesCommandOutput) => void), - cb?: (err: any, data?: ListSecurityPoliciesCommandOutput) => void - ): Promise | void { - const command = new ListSecurityPoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services - * account.

+ * @see {@link ListServersCommand} */ - public listServers(args: ListServersCommandInput, options?: __HttpHandlerOptions): Promise; - public listServers(args: ListServersCommandInput, cb: (err: any, data?: ListServersCommandOutput) => void): void; - public listServers( + listServers(args: ListServersCommandInput, options?: __HttpHandlerOptions): Promise; + listServers(args: ListServersCommandInput, cb: (err: any, data?: ListServersCommandOutput) => void): void; + listServers( args: ListServersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServersCommandOutput) => void ): void; - public listServers( - args: ListServersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServersCommandOutput) => void), - cb?: (err: any, data?: ListServersCommandOutput) => void - ): Promise | void { - const command = new ListServersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The - * resource can be a user, server, or role.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the users for a file transfer protocol-enabled server that you specify by passing - * the ServerId parameter.

+ * @see {@link ListUsersCommand} */ - public listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise; - public listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void; - public listUsers( + listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise; + listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void; + listUsers( args: ListUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersCommandOutput) => void ): void; - public listUsers( - args: ListUsersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUsersCommandOutput) => void), - cb?: (err: any, data?: ListUsersCommandOutput) => void - ): Promise | void { - const command = new ListUsersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all of your workflows.

+ * @see {@link ListWorkflowsCommand} */ - public listWorkflows( - args: ListWorkflowsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listWorkflows( - args: ListWorkflowsCommandInput, - cb: (err: any, data?: ListWorkflowsCommandOutput) => void - ): void; - public listWorkflows( + listWorkflows(args: ListWorkflowsCommandInput, options?: __HttpHandlerOptions): Promise; + listWorkflows(args: ListWorkflowsCommandInput, cb: (err: any, data?: ListWorkflowsCommandOutput) => void): void; + listWorkflows( args: ListWorkflowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkflowsCommandOutput) => void ): void; - public listWorkflows( - args: ListWorkflowsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkflowsCommandOutput) => void), - cb?: (err: any, data?: ListWorkflowsCommandOutput) => void - ): Promise | void { - const command = new ListWorkflowsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Sends a callback for asynchronous custom steps.

- *

- * The ExecutionId, WorkflowId, and Token are passed to the target resource during execution of a custom step of a workflow. - * You must include those with their callback as well as providing a status. - *

+ * @see {@link SendWorkflowStepStateCommand} */ - public sendWorkflowStepState( + sendWorkflowStepState( args: SendWorkflowStepStateCommandInput, options?: __HttpHandlerOptions ): Promise; - public sendWorkflowStepState( + sendWorkflowStepState( args: SendWorkflowStepStateCommandInput, cb: (err: any, data?: SendWorkflowStepStateCommandOutput) => void ): void; - public sendWorkflowStepState( + sendWorkflowStepState( args: SendWorkflowStepStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendWorkflowStepStateCommandOutput) => void ): void; - public sendWorkflowStepState( - args: SendWorkflowStepStateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SendWorkflowStepStateCommandOutput) => void), - cb?: (err: any, data?: SendWorkflowStepStateCommandOutput) => void - ): Promise | void { - const command = new SendWorkflowStepStateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Begins an outbound file transfer to a remote AS2 server. You specify the ConnectorId and the file - * paths for where to send the files.

+ * @see {@link StartFileTransferCommand} */ - public startFileTransfer( + startFileTransfer( args: StartFileTransferCommandInput, options?: __HttpHandlerOptions ): Promise; - public startFileTransfer( + startFileTransfer( args: StartFileTransferCommandInput, cb: (err: any, data?: StartFileTransferCommandOutput) => void ): void; - public startFileTransfer( + startFileTransfer( args: StartFileTransferCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFileTransferCommandOutput) => void ): void; - public startFileTransfer( - args: StartFileTransferCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartFileTransferCommandOutput) => void), - cb?: (err: any, data?: StartFileTransferCommandOutput) => void - ): Promise | void { - const command = new StartFileTransferCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes the state of a file transfer protocol-enabled server from OFFLINE to - * ONLINE. It has no impact on a server that is already ONLINE. An - * ONLINE server can accept and process file transfer jobs.

- *

The state of STARTING indicates that the server is in an intermediate state, - * either not fully able to respond, or not fully online. The values of START_FAILED - * can indicate an error condition.

- *

No response is returned from this call.

+ * @see {@link StartServerCommand} */ - public startServer(args: StartServerCommandInput, options?: __HttpHandlerOptions): Promise; - public startServer(args: StartServerCommandInput, cb: (err: any, data?: StartServerCommandOutput) => void): void; - public startServer( + startServer(args: StartServerCommandInput, options?: __HttpHandlerOptions): Promise; + startServer(args: StartServerCommandInput, cb: (err: any, data?: StartServerCommandOutput) => void): void; + startServer( args: StartServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartServerCommandOutput) => void ): void; - public startServer( - args: StartServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartServerCommandOutput) => void), - cb?: (err: any, data?: StartServerCommandOutput) => void - ): Promise | void { - const command = new StartServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes the state of a file transfer protocol-enabled server from ONLINE to - * OFFLINE. An OFFLINE server cannot accept and process file transfer - * jobs. Information tied to your server, such as server and user properties, are not affected by - * stopping your server.

- * - *

Stopping the server does not reduce or impact your file transfer protocol endpoint - * billing; you must delete the server to stop being billed.

- *
- *

The state of STOPPING indicates that the server is in an intermediate state, - * either not fully able to respond, or not fully offline. The values of STOP_FAILED - * can indicate an error condition.

- *

No response is returned from this call.

+ * @see {@link StopServerCommand} */ - public stopServer(args: StopServerCommandInput, options?: __HttpHandlerOptions): Promise; - public stopServer(args: StopServerCommandInput, cb: (err: any, data?: StopServerCommandOutput) => void): void; - public stopServer( + stopServer(args: StopServerCommandInput, options?: __HttpHandlerOptions): Promise; + stopServer(args: StopServerCommandInput, cb: (err: any, data?: StopServerCommandOutput) => void): void; + stopServer( args: StopServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopServerCommandOutput) => void ): void; - public stopServer( - args: StopServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopServerCommandOutput) => void), - cb?: (err: any, data?: StopServerCommandOutput) => void - ): Promise | void { - const command = new StopServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). - * Resources are users, servers, roles, and other entities.

- *

There is no response returned from this call.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

If the IdentityProviderType of a file transfer protocol-enabled server is - * AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity - * provider is set up successfully. We highly recommend that you call this operation to test your - * authentication method as soon as you create your server. By doing so, you can troubleshoot - * issues with the identity provider integration to ensure that your users can successfully use - * the service.

- *

- * The ServerId and UserName parameters are required. The ServerProtocol, SourceIp, and UserPassword are all optional. - *

- * - *

- * You cannot use TestIdentityProvider if the IdentityProviderType of your server is SERVICE_MANAGED. - *

- *
- *
    - *
  • - *

    - * If you provide any incorrect values for any parameters, the Response field is empty. - *

    - *
  • - *
  • - *

    - * If you provide a server ID for a server that uses service-managed users, you get an error: - *

    - *

    - * - * An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth - * - *

    - *
  • - *
  • - *

    - * If you enter a Server ID for the --server-id parameter that does not identify an actual Transfer server, you receive the following error: - *

    - *

    - * An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server - *

    - *
  • - *
+ * @see {@link TestIdentityProviderCommand} */ - public testIdentityProvider( + testIdentityProvider( args: TestIdentityProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public testIdentityProvider( + testIdentityProvider( args: TestIdentityProviderCommandInput, cb: (err: any, data?: TestIdentityProviderCommandOutput) => void ): void; - public testIdentityProvider( + testIdentityProvider( args: TestIdentityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestIdentityProviderCommandOutput) => void ): void; - public testIdentityProvider( - args: TestIdentityProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestIdentityProviderCommandOutput) => void), - cb?: (err: any, data?: TestIdentityProviderCommandOutput) => void - ): Promise | void { - const command = new TestIdentityProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name - * (ARN). Resources are users, servers, roles, and other entities.

- *

No response is returned from this call.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Allows you to update parameters for the access specified in the ServerID and - * ExternalID parameters.

+ * @see {@link UpdateAccessCommand} */ - public updateAccess( - args: UpdateAccessCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateAccess(args: UpdateAccessCommandInput, cb: (err: any, data?: UpdateAccessCommandOutput) => void): void; - public updateAccess( + updateAccess(args: UpdateAccessCommandInput, options?: __HttpHandlerOptions): Promise; + updateAccess(args: UpdateAccessCommandInput, cb: (err: any, data?: UpdateAccessCommandOutput) => void): void; + updateAccess( args: UpdateAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccessCommandOutput) => void ): void; - public updateAccess( - args: UpdateAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAccessCommandOutput) => void), - cb?: (err: any, data?: UpdateAccessCommandOutput) => void - ): Promise | void { - const command = new UpdateAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates some of the parameters for an existing agreement. Provide the - * AgreementId and the ServerId for the agreement that you want to - * update, along with the new values for the parameters to update.

+ * @see {@link UpdateAgreementCommand} */ - public updateAgreement( + updateAgreement( args: UpdateAgreementCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAgreement( - args: UpdateAgreementCommandInput, - cb: (err: any, data?: UpdateAgreementCommandOutput) => void - ): void; - public updateAgreement( + updateAgreement(args: UpdateAgreementCommandInput, cb: (err: any, data?: UpdateAgreementCommandOutput) => void): void; + updateAgreement( args: UpdateAgreementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAgreementCommandOutput) => void ): void; - public updateAgreement( - args: UpdateAgreementCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAgreementCommandOutput) => void), - cb?: (err: any, data?: UpdateAgreementCommandOutput) => void - ): Promise | void { - const command = new UpdateAgreementCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the active and inactive dates for a certificate.

+ * @see {@link UpdateCertificateCommand} */ - public updateCertificate( + updateCertificate( args: UpdateCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCertificate( + updateCertificate( args: UpdateCertificateCommandInput, cb: (err: any, data?: UpdateCertificateCommandOutput) => void ): void; - public updateCertificate( + updateCertificate( args: UpdateCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCertificateCommandOutput) => void ): void; - public updateCertificate( - args: UpdateCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCertificateCommandOutput) => void), - cb?: (err: any, data?: UpdateCertificateCommandOutput) => void - ): Promise | void { - const command = new UpdateCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates some of the parameters for an existing connector. Provide the - * ConnectorId for the connector that you want to update, along with the new - * values for the parameters to update.

+ * @see {@link UpdateConnectorCommand} */ - public updateConnector( + updateConnector( args: UpdateConnectorCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConnector( - args: UpdateConnectorCommandInput, - cb: (err: any, data?: UpdateConnectorCommandOutput) => void - ): void; - public updateConnector( + updateConnector(args: UpdateConnectorCommandInput, cb: (err: any, data?: UpdateConnectorCommandOutput) => void): void; + updateConnector( args: UpdateConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectorCommandOutput) => void ): void; - public updateConnector( - args: UpdateConnectorCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConnectorCommandOutput) => void), - cb?: (err: any, data?: UpdateConnectorCommandOutput) => void - ): Promise | void { - const command = new UpdateConnectorCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the description for the host key that's specified by the ServerId and - * HostKeyId parameters.

+ * @see {@link UpdateHostKeyCommand} */ - public updateHostKey( - args: UpdateHostKeyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateHostKey( - args: UpdateHostKeyCommandInput, - cb: (err: any, data?: UpdateHostKeyCommandOutput) => void - ): void; - public updateHostKey( + updateHostKey(args: UpdateHostKeyCommandInput, options?: __HttpHandlerOptions): Promise; + updateHostKey(args: UpdateHostKeyCommandInput, cb: (err: any, data?: UpdateHostKeyCommandOutput) => void): void; + updateHostKey( args: UpdateHostKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateHostKeyCommandOutput) => void ): void; - public updateHostKey( - args: UpdateHostKeyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateHostKeyCommandOutput) => void), - cb?: (err: any, data?: UpdateHostKeyCommandOutput) => void - ): Promise | void { - const command = new UpdateHostKeyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates some of the parameters for an existing profile. Provide the ProfileId - * for the profile that you want to update, along with the new values for the parameters to - * update.

+ * @see {@link UpdateProfileCommand} */ - public updateProfile( - args: UpdateProfileCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateProfile( - args: UpdateProfileCommandInput, - cb: (err: any, data?: UpdateProfileCommandOutput) => void - ): void; - public updateProfile( + updateProfile(args: UpdateProfileCommandInput, options?: __HttpHandlerOptions): Promise; + updateProfile(args: UpdateProfileCommandInput, cb: (err: any, data?: UpdateProfileCommandOutput) => void): void; + updateProfile( args: UpdateProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProfileCommandOutput) => void ): void; - public updateProfile( - args: UpdateProfileCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateProfileCommandOutput) => void), - cb?: (err: any, data?: UpdateProfileCommandOutput) => void - ): Promise | void { - const command = new UpdateProfileCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the file transfer protocol-enabled server's properties after that server has - * been created.

- *

The UpdateServer call returns the ServerId of the server you - * updated.

+ * @see {@link UpdateServerCommand} */ - public updateServer( - args: UpdateServerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateServer(args: UpdateServerCommandInput, cb: (err: any, data?: UpdateServerCommandOutput) => void): void; - public updateServer( + updateServer(args: UpdateServerCommandInput, options?: __HttpHandlerOptions): Promise; + updateServer(args: UpdateServerCommandInput, cb: (err: any, data?: UpdateServerCommandOutput) => void): void; + updateServer( args: UpdateServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServerCommandOutput) => void ): void; - public updateServer( - args: UpdateServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServerCommandOutput) => void), - cb?: (err: any, data?: UpdateServerCommandOutput) => void - ): Promise | void { - const command = new UpdateServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Assigns new properties to a user. Parameters you pass modify any or all of the following: - * the home directory, role, and policy for the UserName and ServerId - * you specify.

- *

The response returns the ServerId and the UserName for the - * updated user.

+ * @see {@link UpdateUserCommand} */ - public updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise; - public updateUser(args: UpdateUserCommandInput, cb: (err: any, data?: UpdateUserCommandOutput) => void): void; - public updateUser( + updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise; + updateUser(args: UpdateUserCommandInput, cb: (err: any, data?: UpdateUserCommandOutput) => void): void; + updateUser( args: UpdateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserCommandOutput) => void ): void; - public updateUser( - args: UpdateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserCommandOutput) => void), - cb?: (err: any, data?: UpdateUserCommandOutput) => void - ): Promise | void { - const command = new UpdateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Transfer Family is a fully managed service that enables the transfer of files over the File + * Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File + * Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS. + * Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3. + * Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating + * with existing authentication systems, and providing DNS routing with Amazon Route 53 so + * nothing changes for your customers and partners, or their applications. With your data in + * Amazon S3, you can use it with Amazon Web Services for processing, analytics, machine learning, and + * archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and + * set up.

+ */ +export class Transfer extends TransferClient implements Transfer {} +createAggregatedClient(commands, Transfer); diff --git a/clients/client-translate/src/Translate.ts b/clients/client-translate/src/Translate.ts index 087d164c59da..908398916150 100644 --- a/clients/client-translate/src/Translate.ts +++ b/clients/client-translate/src/Translate.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -87,632 +88,310 @@ import { UpdateParallelDataCommandInput, UpdateParallelDataCommandOutput, } from "./commands/UpdateParallelDataCommand"; -import { TranslateClient } from "./TranslateClient"; +import { TranslateClient, TranslateClientConfig } from "./TranslateClient"; -/** - * @public - *

Provides translation of the input content from the source language to the target language.

- */ -export class Translate extends TranslateClient { +const commands = { + CreateParallelDataCommand, + DeleteParallelDataCommand, + DeleteTerminologyCommand, + DescribeTextTranslationJobCommand, + GetParallelDataCommand, + GetTerminologyCommand, + ImportTerminologyCommand, + ListLanguagesCommand, + ListParallelDataCommand, + ListTagsForResourceCommand, + ListTerminologiesCommand, + ListTextTranslationJobsCommand, + StartTextTranslationJobCommand, + StopTextTranslationJobCommand, + TagResourceCommand, + TranslateTextCommand, + UntagResourceCommand, + UpdateParallelDataCommand, +}; + +export interface Translate { /** - * @public - *

Creates a parallel data resource in Amazon Translate by importing an input file from - * Amazon S3. Parallel data files contain examples that show how you want segments of text to be - * translated. By adding parallel data, you can influence the style, tone, and word choice in - * your translation output.

+ * @see {@link CreateParallelDataCommand} */ - public createParallelData( + createParallelData( args: CreateParallelDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public createParallelData( + createParallelData( args: CreateParallelDataCommandInput, cb: (err: any, data?: CreateParallelDataCommandOutput) => void ): void; - public createParallelData( + createParallelData( args: CreateParallelDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateParallelDataCommandOutput) => void ): void; - public createParallelData( - args: CreateParallelDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateParallelDataCommandOutput) => void), - cb?: (err: any, data?: CreateParallelDataCommandOutput) => void - ): Promise | void { - const command = new CreateParallelDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a parallel data resource in Amazon Translate.

+ * @see {@link DeleteParallelDataCommand} */ - public deleteParallelData( + deleteParallelData( args: DeleteParallelDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteParallelData( + deleteParallelData( args: DeleteParallelDataCommandInput, cb: (err: any, data?: DeleteParallelDataCommandOutput) => void ): void; - public deleteParallelData( + deleteParallelData( args: DeleteParallelDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteParallelDataCommandOutput) => void ): void; - public deleteParallelData( - args: DeleteParallelDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteParallelDataCommandOutput) => void), - cb?: (err: any, data?: DeleteParallelDataCommandOutput) => void - ): Promise | void { - const command = new DeleteParallelDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

A synchronous action that deletes a custom terminology.

+ * @see {@link DeleteTerminologyCommand} */ - public deleteTerminology( + deleteTerminology( args: DeleteTerminologyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTerminology( + deleteTerminology( args: DeleteTerminologyCommandInput, cb: (err: any, data?: DeleteTerminologyCommandOutput) => void ): void; - public deleteTerminology( + deleteTerminology( args: DeleteTerminologyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTerminologyCommandOutput) => void ): void; - public deleteTerminology( - args: DeleteTerminologyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTerminologyCommandOutput) => void), - cb?: (err: any, data?: DeleteTerminologyCommandOutput) => void - ): Promise | void { - const command = new DeleteTerminologyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the properties associated with an asynchronous batch translation job including name, - * ID, status, source and target languages, input/output S3 buckets, and so on.

+ * @see {@link DescribeTextTranslationJobCommand} */ - public describeTextTranslationJob( + describeTextTranslationJob( args: DescribeTextTranslationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeTextTranslationJob( + describeTextTranslationJob( args: DescribeTextTranslationJobCommandInput, cb: (err: any, data?: DescribeTextTranslationJobCommandOutput) => void ): void; - public describeTextTranslationJob( + describeTextTranslationJob( args: DescribeTextTranslationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTextTranslationJobCommandOutput) => void ): void; - public describeTextTranslationJob( - args: DescribeTextTranslationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTextTranslationJobCommandOutput) => void), - cb?: (err: any, data?: DescribeTextTranslationJobCommandOutput) => void - ): Promise | void { - const command = new DescribeTextTranslationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides information about a parallel data resource.

+ * @see {@link GetParallelDataCommand} */ - public getParallelData( + getParallelData( args: GetParallelDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getParallelData( - args: GetParallelDataCommandInput, - cb: (err: any, data?: GetParallelDataCommandOutput) => void - ): void; - public getParallelData( + getParallelData(args: GetParallelDataCommandInput, cb: (err: any, data?: GetParallelDataCommandOutput) => void): void; + getParallelData( args: GetParallelDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetParallelDataCommandOutput) => void ): void; - public getParallelData( - args: GetParallelDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetParallelDataCommandOutput) => void), - cb?: (err: any, data?: GetParallelDataCommandOutput) => void - ): Promise | void { - const command = new GetParallelDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a custom terminology.

+ * @see {@link GetTerminologyCommand} */ - public getTerminology( + getTerminology( args: GetTerminologyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTerminology( - args: GetTerminologyCommandInput, - cb: (err: any, data?: GetTerminologyCommandOutput) => void - ): void; - public getTerminology( + getTerminology(args: GetTerminologyCommandInput, cb: (err: any, data?: GetTerminologyCommandOutput) => void): void; + getTerminology( args: GetTerminologyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTerminologyCommandOutput) => void ): void; - public getTerminology( - args: GetTerminologyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTerminologyCommandOutput) => void), - cb?: (err: any, data?: GetTerminologyCommandOutput) => void - ): Promise | void { - const command = new GetTerminologyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates a custom terminology, depending on whether one already exists for the - * given terminology name. Importing a terminology with the same name as an existing one will - * merge the terminologies based on the chosen merge strategy. The only supported merge strategy - * is OVERWRITE, where the imported terminology overwrites the existing terminology of the same - * name.

- *

If you import a terminology that overwrites an existing one, the new terminology takes up - * to 10 minutes to fully propagate. After that, translations have access to the new - * terminology.

+ * @see {@link ImportTerminologyCommand} */ - public importTerminology( + importTerminology( args: ImportTerminologyCommandInput, options?: __HttpHandlerOptions ): Promise; - public importTerminology( + importTerminology( args: ImportTerminologyCommandInput, cb: (err: any, data?: ImportTerminologyCommandOutput) => void ): void; - public importTerminology( + importTerminology( args: ImportTerminologyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportTerminologyCommandOutput) => void ): void; - public importTerminology( - args: ImportTerminologyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportTerminologyCommandOutput) => void), - cb?: (err: any, data?: ImportTerminologyCommandOutput) => void - ): Promise | void { - const command = new ImportTerminologyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a list of languages (RFC-5646 codes and names) that Amazon Translate supports.

+ * @see {@link ListLanguagesCommand} */ - public listLanguages( - args: ListLanguagesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listLanguages( - args: ListLanguagesCommandInput, - cb: (err: any, data?: ListLanguagesCommandOutput) => void - ): void; - public listLanguages( + listLanguages(args: ListLanguagesCommandInput, options?: __HttpHandlerOptions): Promise; + listLanguages(args: ListLanguagesCommandInput, cb: (err: any, data?: ListLanguagesCommandOutput) => void): void; + listLanguages( args: ListLanguagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLanguagesCommandOutput) => void ): void; - public listLanguages( - args: ListLanguagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLanguagesCommandOutput) => void), - cb?: (err: any, data?: ListLanguagesCommandOutput) => void - ): Promise | void { - const command = new ListLanguagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a list of your parallel data resources in Amazon Translate.

+ * @see {@link ListParallelDataCommand} */ - public listParallelData( + listParallelData( args: ListParallelDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public listParallelData( + listParallelData( args: ListParallelDataCommandInput, cb: (err: any, data?: ListParallelDataCommandOutput) => void ): void; - public listParallelData( + listParallelData( args: ListParallelDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListParallelDataCommandOutput) => void ): void; - public listParallelData( - args: ListParallelDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListParallelDataCommandOutput) => void), - cb?: (err: any, data?: ListParallelDataCommandOutput) => void - ): Promise | void { - const command = new ListParallelDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all tags associated with a given Amazon Translate resource. - * For more information, see - * Tagging your resources.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides a list of custom terminologies associated with your account.

+ * @see {@link ListTerminologiesCommand} */ - public listTerminologies( + listTerminologies( args: ListTerminologiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTerminologies( + listTerminologies( args: ListTerminologiesCommandInput, cb: (err: any, data?: ListTerminologiesCommandOutput) => void ): void; - public listTerminologies( + listTerminologies( args: ListTerminologiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTerminologiesCommandOutput) => void ): void; - public listTerminologies( - args: ListTerminologiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTerminologiesCommandOutput) => void), - cb?: (err: any, data?: ListTerminologiesCommandOutput) => void - ): Promise | void { - const command = new ListTerminologiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets a list of the batch translation jobs that you have submitted.

+ * @see {@link ListTextTranslationJobsCommand} */ - public listTextTranslationJobs( + listTextTranslationJobs( args: ListTextTranslationJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTextTranslationJobs( + listTextTranslationJobs( args: ListTextTranslationJobsCommandInput, cb: (err: any, data?: ListTextTranslationJobsCommandOutput) => void ): void; - public listTextTranslationJobs( + listTextTranslationJobs( args: ListTextTranslationJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTextTranslationJobsCommandOutput) => void ): void; - public listTextTranslationJobs( - args: ListTextTranslationJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTextTranslationJobsCommandOutput) => void), - cb?: (err: any, data?: ListTextTranslationJobsCommandOutput) => void - ): Promise | void { - const command = new ListTextTranslationJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts an asynchronous batch translation job. Use batch translation jobs to - * translate large volumes of text across multiple documents at once. - * For batch translation, you can input documents with different source languages (specify auto - * as the source language). You can specify one - * or more target languages. Batch translation translates each input document into each of the target languages. - * For more information, see - * Asynchronous batch processing.

- * - *

Batch translation jobs can be described with the DescribeTextTranslationJob operation, listed with the ListTextTranslationJobs operation, and stopped with the StopTextTranslationJob operation.

+ * @see {@link StartTextTranslationJobCommand} */ - public startTextTranslationJob( + startTextTranslationJob( args: StartTextTranslationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startTextTranslationJob( + startTextTranslationJob( args: StartTextTranslationJobCommandInput, cb: (err: any, data?: StartTextTranslationJobCommandOutput) => void ): void; - public startTextTranslationJob( + startTextTranslationJob( args: StartTextTranslationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTextTranslationJobCommandOutput) => void ): void; - public startTextTranslationJob( - args: StartTextTranslationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartTextTranslationJobCommandOutput) => void), - cb?: (err: any, data?: StartTextTranslationJobCommandOutput) => void - ): Promise | void { - const command = new StartTextTranslationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Stops an asynchronous batch translation job that is in progress.

- *

If the job's state is IN_PROGRESS, the job will be marked for termination and - * put into the STOP_REQUESTED state. If the job completes before it can be stopped, - * it is put into the COMPLETED state. Otherwise, the job is put into the - * STOPPED state.

- *

Asynchronous batch translation jobs are started with the StartTextTranslationJob operation. You can use the DescribeTextTranslationJob or ListTextTranslationJobs - * operations to get a batch translation job's JobId.

+ * @see {@link StopTextTranslationJobCommand} */ - public stopTextTranslationJob( + stopTextTranslationJob( args: StopTextTranslationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopTextTranslationJob( + stopTextTranslationJob( args: StopTextTranslationJobCommandInput, cb: (err: any, data?: StopTextTranslationJobCommandOutput) => void ): void; - public stopTextTranslationJob( + stopTextTranslationJob( args: StopTextTranslationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopTextTranslationJobCommandOutput) => void ): void; - public stopTextTranslationJob( - args: StopTextTranslationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopTextTranslationJobCommandOutput) => void), - cb?: (err: any, data?: StopTextTranslationJobCommandOutput) => void - ): Promise | void { - const command = new StopTextTranslationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a specific tag with a resource. A tag is a key-value pair - * that adds as a metadata to a resource. - * For more information, see - * Tagging your resources.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Translates input text from the source language to the target language. For a list of - * available languages and language codes, see Supported languages.

+ * @see {@link TranslateTextCommand} */ - public translateText( - args: TranslateTextCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public translateText( - args: TranslateTextCommandInput, - cb: (err: any, data?: TranslateTextCommandOutput) => void - ): void; - public translateText( + translateText(args: TranslateTextCommandInput, options?: __HttpHandlerOptions): Promise; + translateText(args: TranslateTextCommandInput, cb: (err: any, data?: TranslateTextCommandOutput) => void): void; + translateText( args: TranslateTextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TranslateTextCommandOutput) => void ): void; - public translateText( - args: TranslateTextCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TranslateTextCommandOutput) => void), - cb?: (err: any, data?: TranslateTextCommandOutput) => void - ): Promise | void { - const command = new TranslateTextCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a specific tag associated with an Amazon Translate resource. - * For more information, see - * Tagging your resources.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a previously created parallel data resource by importing a new input file from - * Amazon S3.

+ * @see {@link UpdateParallelDataCommand} */ - public updateParallelData( + updateParallelData( args: UpdateParallelDataCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateParallelData( + updateParallelData( args: UpdateParallelDataCommandInput, cb: (err: any, data?: UpdateParallelDataCommandOutput) => void ): void; - public updateParallelData( + updateParallelData( args: UpdateParallelDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateParallelDataCommandOutput) => void ): void; - public updateParallelData( - args: UpdateParallelDataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateParallelDataCommandOutput) => void), - cb?: (err: any, data?: UpdateParallelDataCommandOutput) => void - ): Promise | void { - const command = new UpdateParallelDataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Provides translation of the input content from the source language to the target language.

+ */ +export class Translate extends TranslateClient implements Translate {} +createAggregatedClient(commands, Translate); diff --git a/clients/client-voice-id/src/VoiceID.ts b/clients/client-voice-id/src/VoiceID.ts index eeec9a2b372e..e74f58e27bb5 100644 --- a/clients/client-voice-id/src/VoiceID.ts +++ b/clients/client-voice-id/src/VoiceID.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -138,963 +139,458 @@ import { UpdateWatchlistCommandInput, UpdateWatchlistCommandOutput, } from "./commands/UpdateWatchlistCommand"; -import { VoiceIDClient } from "./VoiceIDClient"; +import { VoiceIDClient, VoiceIDClientConfig } from "./VoiceIDClient"; -/** - * @public - *

Amazon Connect Voice ID provides real-time caller authentication and fraud risk detection, which - * make voice interactions in contact centers more secure and efficient.

- */ -export class VoiceID extends VoiceIDClient { +const commands = { + AssociateFraudsterCommand, + CreateDomainCommand, + CreateWatchlistCommand, + DeleteDomainCommand, + DeleteFraudsterCommand, + DeleteSpeakerCommand, + DeleteWatchlistCommand, + DescribeDomainCommand, + DescribeFraudsterCommand, + DescribeFraudsterRegistrationJobCommand, + DescribeSpeakerCommand, + DescribeSpeakerEnrollmentJobCommand, + DescribeWatchlistCommand, + DisassociateFraudsterCommand, + EvaluateSessionCommand, + ListDomainsCommand, + ListFraudsterRegistrationJobsCommand, + ListFraudstersCommand, + ListSpeakerEnrollmentJobsCommand, + ListSpeakersCommand, + ListTagsForResourceCommand, + ListWatchlistsCommand, + OptOutSpeakerCommand, + StartFraudsterRegistrationJobCommand, + StartSpeakerEnrollmentJobCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateDomainCommand, + UpdateWatchlistCommand, +}; + +export interface VoiceID { /** - * @public - *

Associates the fraudsters with the watchlist specified in the same domain.

+ * @see {@link AssociateFraudsterCommand} */ - public associateFraudster( + associateFraudster( args: AssociateFraudsterCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateFraudster( + associateFraudster( args: AssociateFraudsterCommandInput, cb: (err: any, data?: AssociateFraudsterCommandOutput) => void ): void; - public associateFraudster( + associateFraudster( args: AssociateFraudsterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateFraudsterCommandOutput) => void ): void; - public associateFraudster( - args: AssociateFraudsterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateFraudsterCommandOutput) => void), - cb?: (err: any, data?: AssociateFraudsterCommandOutput) => void - ): Promise | void { - const command = new AssociateFraudsterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, - * customer audio, and voiceprints. Every domain is created with a default watchlist that fraudsters can be a part of.

+ * @see {@link CreateDomainCommand} */ - public createDomain( - args: CreateDomainCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createDomain(args: CreateDomainCommandInput, cb: (err: any, data?: CreateDomainCommandOutput) => void): void; - public createDomain( + createDomain(args: CreateDomainCommandInput, options?: __HttpHandlerOptions): Promise; + createDomain(args: CreateDomainCommandInput, cb: (err: any, data?: CreateDomainCommandOutput) => void): void; + createDomain( args: CreateDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDomainCommandOutput) => void ): void; - public createDomain( - args: CreateDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateDomainCommandOutput) => void), - cb?: (err: any, data?: CreateDomainCommandOutput) => void - ): Promise | void { - const command = new CreateDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a watchlist that fraudsters can be a part of.

+ * @see {@link CreateWatchlistCommand} */ - public createWatchlist( + createWatchlist( args: CreateWatchlistCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWatchlist( - args: CreateWatchlistCommandInput, - cb: (err: any, data?: CreateWatchlistCommandOutput) => void - ): void; - public createWatchlist( + createWatchlist(args: CreateWatchlistCommandInput, cb: (err: any, data?: CreateWatchlistCommandOutput) => void): void; + createWatchlist( args: CreateWatchlistCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWatchlistCommandOutput) => void ): void; - public createWatchlist( - args: CreateWatchlistCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWatchlistCommandOutput) => void), - cb?: (err: any, data?: CreateWatchlistCommandOutput) => void - ): Promise | void { - const command = new CreateWatchlistCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified domain from Voice ID.

+ * @see {@link DeleteDomainCommand} */ - public deleteDomain( - args: DeleteDomainCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteDomain(args: DeleteDomainCommandInput, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void; - public deleteDomain( + deleteDomain(args: DeleteDomainCommandInput, options?: __HttpHandlerOptions): Promise; + deleteDomain(args: DeleteDomainCommandInput, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void; + deleteDomain( args: DeleteDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDomainCommandOutput) => void ): void; - public deleteDomain( - args: DeleteDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDomainCommandOutput) => void), - cb?: (err: any, data?: DeleteDomainCommandOutput) => void - ): Promise | void { - const command = new DeleteDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is a part of.

+ * @see {@link DeleteFraudsterCommand} */ - public deleteFraudster( + deleteFraudster( args: DeleteFraudsterCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFraudster( - args: DeleteFraudsterCommandInput, - cb: (err: any, data?: DeleteFraudsterCommandOutput) => void - ): void; - public deleteFraudster( + deleteFraudster(args: DeleteFraudsterCommandInput, cb: (err: any, data?: DeleteFraudsterCommandOutput) => void): void; + deleteFraudster( args: DeleteFraudsterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFraudsterCommandOutput) => void ): void; - public deleteFraudster( - args: DeleteFraudsterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFraudsterCommandOutput) => void), - cb?: (err: any, data?: DeleteFraudsterCommandOutput) => void - ): Promise | void { - const command = new DeleteFraudsterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified speaker from Voice ID.

+ * @see {@link DeleteSpeakerCommand} */ - public deleteSpeaker( - args: DeleteSpeakerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteSpeaker( - args: DeleteSpeakerCommandInput, - cb: (err: any, data?: DeleteSpeakerCommandOutput) => void - ): void; - public deleteSpeaker( + deleteSpeaker(args: DeleteSpeakerCommandInput, options?: __HttpHandlerOptions): Promise; + deleteSpeaker(args: DeleteSpeakerCommandInput, cb: (err: any, data?: DeleteSpeakerCommandOutput) => void): void; + deleteSpeaker( args: DeleteSpeakerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSpeakerCommandOutput) => void ): void; - public deleteSpeaker( - args: DeleteSpeakerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSpeakerCommandOutput) => void), - cb?: (err: any, data?: DeleteSpeakerCommandOutput) => void - ): Promise | void { - const command = new DeleteSpeakerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified watchlist from Voice ID. This API throws an exception when - * there are fraudsters in the watchlist that you are trying to delete. You must delete the - * fraudsters, and then delete the watchlist. Every domain has a default watchlist which cannot be deleted.

+ * @see {@link DeleteWatchlistCommand} */ - public deleteWatchlist( + deleteWatchlist( args: DeleteWatchlistCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWatchlist( - args: DeleteWatchlistCommandInput, - cb: (err: any, data?: DeleteWatchlistCommandOutput) => void - ): void; - public deleteWatchlist( + deleteWatchlist(args: DeleteWatchlistCommandInput, cb: (err: any, data?: DeleteWatchlistCommandOutput) => void): void; + deleteWatchlist( args: DeleteWatchlistCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWatchlistCommandOutput) => void ): void; - public deleteWatchlist( - args: DeleteWatchlistCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWatchlistCommandOutput) => void), - cb?: (err: any, data?: DeleteWatchlistCommandOutput) => void - ): Promise | void { - const command = new DeleteWatchlistCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified domain.

+ * @see {@link DescribeDomainCommand} */ - public describeDomain( + describeDomain( args: DescribeDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDomain( - args: DescribeDomainCommandInput, - cb: (err: any, data?: DescribeDomainCommandOutput) => void - ): void; - public describeDomain( + describeDomain(args: DescribeDomainCommandInput, cb: (err: any, data?: DescribeDomainCommandOutput) => void): void; + describeDomain( args: DescribeDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDomainCommandOutput) => void ): void; - public describeDomain( - args: DescribeDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDomainCommandOutput) => void), - cb?: (err: any, data?: DescribeDomainCommandOutput) => void - ): Promise | void { - const command = new DescribeDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified fraudster.

+ * @see {@link DescribeFraudsterCommand} */ - public describeFraudster( + describeFraudster( args: DescribeFraudsterCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFraudster( + describeFraudster( args: DescribeFraudsterCommandInput, cb: (err: any, data?: DescribeFraudsterCommandOutput) => void ): void; - public describeFraudster( + describeFraudster( args: DescribeFraudsterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFraudsterCommandOutput) => void ): void; - public describeFraudster( - args: DescribeFraudsterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFraudsterCommandOutput) => void), - cb?: (err: any, data?: DescribeFraudsterCommandOutput) => void - ): Promise | void { - const command = new DescribeFraudsterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified fraudster registration job.

+ * @see {@link DescribeFraudsterRegistrationJobCommand} */ - public describeFraudsterRegistrationJob( + describeFraudsterRegistrationJob( args: DescribeFraudsterRegistrationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFraudsterRegistrationJob( + describeFraudsterRegistrationJob( args: DescribeFraudsterRegistrationJobCommandInput, cb: (err: any, data?: DescribeFraudsterRegistrationJobCommandOutput) => void ): void; - public describeFraudsterRegistrationJob( + describeFraudsterRegistrationJob( args: DescribeFraudsterRegistrationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFraudsterRegistrationJobCommandOutput) => void ): void; - public describeFraudsterRegistrationJob( - args: DescribeFraudsterRegistrationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFraudsterRegistrationJobCommandOutput) => void), - cb?: (err: any, data?: DescribeFraudsterRegistrationJobCommandOutput) => void - ): Promise | void { - const command = new DescribeFraudsterRegistrationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified speaker.

+ * @see {@link DescribeSpeakerCommand} */ - public describeSpeaker( + describeSpeaker( args: DescribeSpeakerCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSpeaker( - args: DescribeSpeakerCommandInput, - cb: (err: any, data?: DescribeSpeakerCommandOutput) => void - ): void; - public describeSpeaker( + describeSpeaker(args: DescribeSpeakerCommandInput, cb: (err: any, data?: DescribeSpeakerCommandOutput) => void): void; + describeSpeaker( args: DescribeSpeakerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSpeakerCommandOutput) => void ): void; - public describeSpeaker( - args: DescribeSpeakerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSpeakerCommandOutput) => void), - cb?: (err: any, data?: DescribeSpeakerCommandOutput) => void - ): Promise | void { - const command = new DescribeSpeakerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified speaker enrollment job.

+ * @see {@link DescribeSpeakerEnrollmentJobCommand} */ - public describeSpeakerEnrollmentJob( + describeSpeakerEnrollmentJob( args: DescribeSpeakerEnrollmentJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeSpeakerEnrollmentJob( + describeSpeakerEnrollmentJob( args: DescribeSpeakerEnrollmentJobCommandInput, cb: (err: any, data?: DescribeSpeakerEnrollmentJobCommandOutput) => void ): void; - public describeSpeakerEnrollmentJob( + describeSpeakerEnrollmentJob( args: DescribeSpeakerEnrollmentJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSpeakerEnrollmentJobCommandOutput) => void ): void; - public describeSpeakerEnrollmentJob( - args: DescribeSpeakerEnrollmentJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeSpeakerEnrollmentJobCommandOutput) => void), - cb?: (err: any, data?: DescribeSpeakerEnrollmentJobCommandOutput) => void - ): Promise | void { - const command = new DescribeSpeakerEnrollmentJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified watchlist.

+ * @see {@link DescribeWatchlistCommand} */ - public describeWatchlist( + describeWatchlist( args: DescribeWatchlistCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWatchlist( + describeWatchlist( args: DescribeWatchlistCommandInput, cb: (err: any, data?: DescribeWatchlistCommandOutput) => void ): void; - public describeWatchlist( + describeWatchlist( args: DescribeWatchlistCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWatchlistCommandOutput) => void ): void; - public describeWatchlist( - args: DescribeWatchlistCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWatchlistCommandOutput) => void), - cb?: (err: any, data?: DescribeWatchlistCommandOutput) => void - ): Promise | void { - const command = new DescribeWatchlistCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates the fraudsters from the watchlist specified. Voice ID always expects a - * fraudster to be a part of at least one watchlist. If - * you try to disassociate a fraudster from its only watchlist, a ValidationException is thrown. - *

+ * @see {@link DisassociateFraudsterCommand} */ - public disassociateFraudster( + disassociateFraudster( args: DisassociateFraudsterCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateFraudster( + disassociateFraudster( args: DisassociateFraudsterCommandInput, cb: (err: any, data?: DisassociateFraudsterCommandOutput) => void ): void; - public disassociateFraudster( + disassociateFraudster( args: DisassociateFraudsterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateFraudsterCommandOutput) => void ): void; - public disassociateFraudster( - args: DisassociateFraudsterCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateFraudsterCommandOutput) => void), - cb?: (err: any, data?: DisassociateFraudsterCommandOutput) => void - ): Promise | void { - const command = new DisassociateFraudsterCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Evaluates a specified session based on audio data accumulated during a streaming - * Amazon Connect Voice ID call.

+ * @see {@link EvaluateSessionCommand} */ - public evaluateSession( + evaluateSession( args: EvaluateSessionCommandInput, options?: __HttpHandlerOptions ): Promise; - public evaluateSession( - args: EvaluateSessionCommandInput, - cb: (err: any, data?: EvaluateSessionCommandOutput) => void - ): void; - public evaluateSession( + evaluateSession(args: EvaluateSessionCommandInput, cb: (err: any, data?: EvaluateSessionCommandOutput) => void): void; + evaluateSession( args: EvaluateSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EvaluateSessionCommandOutput) => void ): void; - public evaluateSession( - args: EvaluateSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EvaluateSessionCommandOutput) => void), - cb?: (err: any, data?: EvaluateSessionCommandOutput) => void - ): Promise | void { - const command = new EvaluateSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the domains in the Amazon Web Services account.

+ * @see {@link ListDomainsCommand} */ - public listDomains(args: ListDomainsCommandInput, options?: __HttpHandlerOptions): Promise; - public listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void; - public listDomains( + listDomains(args: ListDomainsCommandInput, options?: __HttpHandlerOptions): Promise; + listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void; + listDomains( args: ListDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainsCommandOutput) => void ): void; - public listDomains( - args: ListDomainsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDomainsCommandOutput) => void), - cb?: (err: any, data?: ListDomainsCommandOutput) => void - ): Promise | void { - const command = new ListDomainsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the fraudster registration jobs in the domain with the given - * JobStatus. If JobStatus is not provided, this lists all - * fraudster registration jobs in the given domain.

+ * @see {@link ListFraudsterRegistrationJobsCommand} */ - public listFraudsterRegistrationJobs( + listFraudsterRegistrationJobs( args: ListFraudsterRegistrationJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFraudsterRegistrationJobs( + listFraudsterRegistrationJobs( args: ListFraudsterRegistrationJobsCommandInput, cb: (err: any, data?: ListFraudsterRegistrationJobsCommandOutput) => void ): void; - public listFraudsterRegistrationJobs( + listFraudsterRegistrationJobs( args: ListFraudsterRegistrationJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFraudsterRegistrationJobsCommandOutput) => void ): void; - public listFraudsterRegistrationJobs( - args: ListFraudsterRegistrationJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFraudsterRegistrationJobsCommandOutput) => void), - cb?: (err: any, data?: ListFraudsterRegistrationJobsCommandOutput) => void - ): Promise | void { - const command = new ListFraudsterRegistrationJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all fraudsters in a specified watchlist or domain.

+ * @see {@link ListFraudstersCommand} */ - public listFraudsters( + listFraudsters( args: ListFraudstersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listFraudsters( - args: ListFraudstersCommandInput, - cb: (err: any, data?: ListFraudstersCommandOutput) => void - ): void; - public listFraudsters( + listFraudsters(args: ListFraudstersCommandInput, cb: (err: any, data?: ListFraudstersCommandOutput) => void): void; + listFraudsters( args: ListFraudstersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFraudstersCommandOutput) => void ): void; - public listFraudsters( - args: ListFraudstersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFraudstersCommandOutput) => void), - cb?: (err: any, data?: ListFraudstersCommandOutput) => void - ): Promise | void { - const command = new ListFraudstersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all the speaker enrollment jobs in the domain with the specified - * JobStatus. If JobStatus is not provided, this lists all - * jobs with all possible speaker enrollment job statuses.

+ * @see {@link ListSpeakerEnrollmentJobsCommand} */ - public listSpeakerEnrollmentJobs( + listSpeakerEnrollmentJobs( args: ListSpeakerEnrollmentJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSpeakerEnrollmentJobs( + listSpeakerEnrollmentJobs( args: ListSpeakerEnrollmentJobsCommandInput, cb: (err: any, data?: ListSpeakerEnrollmentJobsCommandOutput) => void ): void; - public listSpeakerEnrollmentJobs( + listSpeakerEnrollmentJobs( args: ListSpeakerEnrollmentJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSpeakerEnrollmentJobsCommandOutput) => void ): void; - public listSpeakerEnrollmentJobs( - args: ListSpeakerEnrollmentJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSpeakerEnrollmentJobsCommandOutput) => void), - cb?: (err: any, data?: ListSpeakerEnrollmentJobsCommandOutput) => void - ): Promise | void { - const command = new ListSpeakerEnrollmentJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all speakers in a specified domain.

+ * @see {@link ListSpeakersCommand} */ - public listSpeakers( - args: ListSpeakersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listSpeakers(args: ListSpeakersCommandInput, cb: (err: any, data?: ListSpeakersCommandOutput) => void): void; - public listSpeakers( + listSpeakers(args: ListSpeakersCommandInput, options?: __HttpHandlerOptions): Promise; + listSpeakers(args: ListSpeakersCommandInput, cb: (err: any, data?: ListSpeakersCommandOutput) => void): void; + listSpeakers( args: ListSpeakersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSpeakersCommandOutput) => void ): void; - public listSpeakers( - args: ListSpeakersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSpeakersCommandOutput) => void), - cb?: (err: any, data?: ListSpeakersCommandOutput) => void - ): Promise | void { - const command = new ListSpeakersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all tags associated with a specified Voice ID resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all watchlists in a specified domain.

+ * @see {@link ListWatchlistsCommand} */ - public listWatchlists( + listWatchlists( args: ListWatchlistsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWatchlists( - args: ListWatchlistsCommandInput, - cb: (err: any, data?: ListWatchlistsCommandOutput) => void - ): void; - public listWatchlists( + listWatchlists(args: ListWatchlistsCommandInput, cb: (err: any, data?: ListWatchlistsCommandOutput) => void): void; + listWatchlists( args: ListWatchlistsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWatchlistsCommandOutput) => void ): void; - public listWatchlists( - args: ListWatchlistsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWatchlistsCommandOutput) => void), - cb?: (err: any, data?: ListWatchlistsCommandOutput) => void - ): Promise | void { - const command = new ListWatchlistsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Opts out a speaker from Voice ID. A speaker can be opted out regardless of whether or - * not they already exist in Voice ID. If they don't yet exist, a new speaker is created - * in an opted out state. If they already exist, their existing status is overridden and - * they are opted out. Enrollment and evaluation authentication requests are rejected for - * opted out speakers, and opted out speakers have no voice embeddings stored in - * Voice ID.

+ * @see {@link OptOutSpeakerCommand} */ - public optOutSpeaker( - args: OptOutSpeakerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public optOutSpeaker( - args: OptOutSpeakerCommandInput, - cb: (err: any, data?: OptOutSpeakerCommandOutput) => void - ): void; - public optOutSpeaker( + optOutSpeaker(args: OptOutSpeakerCommandInput, options?: __HttpHandlerOptions): Promise; + optOutSpeaker(args: OptOutSpeakerCommandInput, cb: (err: any, data?: OptOutSpeakerCommandOutput) => void): void; + optOutSpeaker( args: OptOutSpeakerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: OptOutSpeakerCommandOutput) => void ): void; - public optOutSpeaker( - args: OptOutSpeakerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: OptOutSpeakerCommandOutput) => void), - cb?: (err: any, data?: OptOutSpeakerCommandOutput) => void - ): Promise | void { - const command = new OptOutSpeakerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a new batch fraudster registration job using provided details.

+ * @see {@link StartFraudsterRegistrationJobCommand} */ - public startFraudsterRegistrationJob( + startFraudsterRegistrationJob( args: StartFraudsterRegistrationJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startFraudsterRegistrationJob( + startFraudsterRegistrationJob( args: StartFraudsterRegistrationJobCommandInput, cb: (err: any, data?: StartFraudsterRegistrationJobCommandOutput) => void ): void; - public startFraudsterRegistrationJob( + startFraudsterRegistrationJob( args: StartFraudsterRegistrationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFraudsterRegistrationJobCommandOutput) => void ): void; - public startFraudsterRegistrationJob( - args: StartFraudsterRegistrationJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartFraudsterRegistrationJobCommandOutput) => void), - cb?: (err: any, data?: StartFraudsterRegistrationJobCommandOutput) => void - ): Promise | void { - const command = new StartFraudsterRegistrationJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Starts a new batch speaker enrollment job using specified details.

+ * @see {@link StartSpeakerEnrollmentJobCommand} */ - public startSpeakerEnrollmentJob( + startSpeakerEnrollmentJob( args: StartSpeakerEnrollmentJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startSpeakerEnrollmentJob( + startSpeakerEnrollmentJob( args: StartSpeakerEnrollmentJobCommandInput, cb: (err: any, data?: StartSpeakerEnrollmentJobCommandOutput) => void ): void; - public startSpeakerEnrollmentJob( + startSpeakerEnrollmentJob( args: StartSpeakerEnrollmentJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSpeakerEnrollmentJobCommandOutput) => void ): void; - public startSpeakerEnrollmentJob( - args: StartSpeakerEnrollmentJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartSpeakerEnrollmentJobCommandOutput) => void), - cb?: (err: any, data?: StartSpeakerEnrollmentJobCommandOutput) => void - ): Promise | void { - const command = new StartSpeakerEnrollmentJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Tags a Voice ID resource with the provided list of tags.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes specified tags from a specified Amazon Connect Voice ID resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified domain. This API has clobber behavior, and clears and replaces - * all attributes. If an optional field, such as 'Description' is not provided, it is - * removed from the domain.

+ * @see {@link UpdateDomainCommand} */ - public updateDomain( - args: UpdateDomainCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateDomain(args: UpdateDomainCommandInput, cb: (err: any, data?: UpdateDomainCommandOutput) => void): void; - public updateDomain( + updateDomain(args: UpdateDomainCommandInput, options?: __HttpHandlerOptions): Promise; + updateDomain(args: UpdateDomainCommandInput, cb: (err: any, data?: UpdateDomainCommandOutput) => void): void; + updateDomain( args: UpdateDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDomainCommandOutput) => void ): void; - public updateDomain( - args: UpdateDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDomainCommandOutput) => void), - cb?: (err: any, data?: UpdateDomainCommandOutput) => void - ): Promise | void { - const command = new UpdateDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified watchlist. Every domain has a default watchlist which cannot be updated. - *

+ * @see {@link UpdateWatchlistCommand} */ - public updateWatchlist( + updateWatchlist( args: UpdateWatchlistCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWatchlist( - args: UpdateWatchlistCommandInput, - cb: (err: any, data?: UpdateWatchlistCommandOutput) => void - ): void; - public updateWatchlist( + updateWatchlist(args: UpdateWatchlistCommandInput, cb: (err: any, data?: UpdateWatchlistCommandOutput) => void): void; + updateWatchlist( args: UpdateWatchlistCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWatchlistCommandOutput) => void ): void; - public updateWatchlist( - args: UpdateWatchlistCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWatchlistCommandOutput) => void), - cb?: (err: any, data?: UpdateWatchlistCommandOutput) => void - ): Promise | void { - const command = new UpdateWatchlistCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Connect Voice ID provides real-time caller authentication and fraud risk detection, which + * make voice interactions in contact centers more secure and efficient.

+ */ +export class VoiceID extends VoiceIDClient implements VoiceID {} +createAggregatedClient(commands, VoiceID); diff --git a/clients/client-vpc-lattice/src/VPCLattice.ts b/clients/client-vpc-lattice/src/VPCLattice.ts index 67a1ac0fd4db..bb5813644a65 100644 --- a/clients/client-vpc-lattice/src/VPCLattice.ts +++ b/clients/client-vpc-lattice/src/VPCLattice.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -225,1761 +226,836 @@ import { UpdateTargetGroupCommandInput, UpdateTargetGroupCommandOutput, } from "./commands/UpdateTargetGroupCommand"; -import { VPCLatticeClient } from "./VPCLatticeClient"; +import { VPCLatticeClient, VPCLatticeClientConfig } from "./VPCLatticeClient"; -/** - * @public - *

Amazon VPC Lattice is a fully managed application networking service that you use to connect, secure, - * and monitor all of your services across multiple accounts and virtual private clouds (VPCs). - * Amazon VPC Lattice interconnects your microservices and legacy services within a logical boundary, so that - * you can discover and manage them more efficiently. For more information, see the Amazon VPC Lattice User Guide - *

- */ -export class VPCLattice extends VPCLatticeClient { +const commands = { + BatchUpdateRuleCommand, + CreateAccessLogSubscriptionCommand, + CreateListenerCommand, + CreateRuleCommand, + CreateServiceCommand, + CreateServiceNetworkCommand, + CreateServiceNetworkServiceAssociationCommand, + CreateServiceNetworkVpcAssociationCommand, + CreateTargetGroupCommand, + DeleteAccessLogSubscriptionCommand, + DeleteAuthPolicyCommand, + DeleteListenerCommand, + DeleteResourcePolicyCommand, + DeleteRuleCommand, + DeleteServiceCommand, + DeleteServiceNetworkCommand, + DeleteServiceNetworkServiceAssociationCommand, + DeleteServiceNetworkVpcAssociationCommand, + DeleteTargetGroupCommand, + DeregisterTargetsCommand, + GetAccessLogSubscriptionCommand, + GetAuthPolicyCommand, + GetListenerCommand, + GetResourcePolicyCommand, + GetRuleCommand, + GetServiceCommand, + GetServiceNetworkCommand, + GetServiceNetworkServiceAssociationCommand, + GetServiceNetworkVpcAssociationCommand, + GetTargetGroupCommand, + ListAccessLogSubscriptionsCommand, + ListListenersCommand, + ListRulesCommand, + ListServiceNetworksCommand, + ListServiceNetworkServiceAssociationsCommand, + ListServiceNetworkVpcAssociationsCommand, + ListServicesCommand, + ListTagsForResourceCommand, + ListTargetGroupsCommand, + ListTargetsCommand, + PutAuthPolicyCommand, + PutResourcePolicyCommand, + RegisterTargetsCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAccessLogSubscriptionCommand, + UpdateListenerCommand, + UpdateRuleCommand, + UpdateServiceCommand, + UpdateServiceNetworkCommand, + UpdateServiceNetworkVpcAssociationCommand, + UpdateTargetGroupCommand, +}; + +export interface VPCLattice { /** - * @public - *

Updates the listener rules in a batch. You can use this operation to change the priority of - * listener rules. This can be useful when bulk updating or swapping rule priority.

+ * @see {@link BatchUpdateRuleCommand} */ - public batchUpdateRule( + batchUpdateRule( args: BatchUpdateRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchUpdateRule( - args: BatchUpdateRuleCommandInput, - cb: (err: any, data?: BatchUpdateRuleCommandOutput) => void - ): void; - public batchUpdateRule( + batchUpdateRule(args: BatchUpdateRuleCommandInput, cb: (err: any, data?: BatchUpdateRuleCommandOutput) => void): void; + batchUpdateRule( args: BatchUpdateRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchUpdateRuleCommandOutput) => void ): void; - public batchUpdateRule( - args: BatchUpdateRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchUpdateRuleCommandOutput) => void), - cb?: (err: any, data?: BatchUpdateRuleCommandOutput) => void - ): Promise | void { - const command = new BatchUpdateRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner - * can use the access logs to audit the services in the network. The service network owner will only - * see access logs from clients and services that are associated with their service network. Access - * log entries represent traffic originated from VPCs associated with that network. For more - * information, see Access logs in the - * Amazon VPC Lattice User Guide.

+ * @see {@link CreateAccessLogSubscriptionCommand} */ - public createAccessLogSubscription( + createAccessLogSubscription( args: CreateAccessLogSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAccessLogSubscription( + createAccessLogSubscription( args: CreateAccessLogSubscriptionCommandInput, cb: (err: any, data?: CreateAccessLogSubscriptionCommandOutput) => void ): void; - public createAccessLogSubscription( + createAccessLogSubscription( args: CreateAccessLogSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessLogSubscriptionCommandOutput) => void ): void; - public createAccessLogSubscription( - args: CreateAccessLogSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAccessLogSubscriptionCommandOutput) => void), - cb?: (err: any, data?: CreateAccessLogSubscriptionCommandOutput) => void - ): Promise | void { - const command = new CreateAccessLogSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a listener for a service. Before you start using your Amazon VPC Lattice service, you must - * add one or more listeners. A listener is a process that checks for connection requests to your - * services. For more information, see Listeners in the - * Amazon VPC Lattice User Guide.

+ * @see {@link CreateListenerCommand} */ - public createListener( + createListener( args: CreateListenerCommandInput, options?: __HttpHandlerOptions ): Promise; - public createListener( - args: CreateListenerCommandInput, - cb: (err: any, data?: CreateListenerCommandOutput) => void - ): void; - public createListener( + createListener(args: CreateListenerCommandInput, cb: (err: any, data?: CreateListenerCommandOutput) => void): void; + createListener( args: CreateListenerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateListenerCommandOutput) => void ): void; - public createListener( - args: CreateListenerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateListenerCommandOutput) => void), - cb?: (err: any, data?: CreateListenerCommandOutput) => void - ): Promise | void { - const command = new CreateListenerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a listener rule. Each listener has a default rule for checking connection requests, - * but you can define additional rules. Each rule consists of a priority, one or more actions, and - * one or more conditions. For more information, see Listener rules in the - * Amazon VPC Lattice User Guide.

+ * @see {@link CreateRuleCommand} */ - public createRule(args: CreateRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public createRule(args: CreateRuleCommandInput, cb: (err: any, data?: CreateRuleCommandOutput) => void): void; - public createRule( + createRule(args: CreateRuleCommandInput, options?: __HttpHandlerOptions): Promise; + createRule(args: CreateRuleCommandInput, cb: (err: any, data?: CreateRuleCommandOutput) => void): void; + createRule( args: CreateRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRuleCommandOutput) => void ): void; - public createRule( - args: CreateRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRuleCommandOutput) => void), - cb?: (err: any, data?: CreateRuleCommandOutput) => void - ): Promise | void { - const command = new CreateRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a service. A service is any software application that can run on instances - * containers, or serverless functions within an account or virtual private cloud (VPC).

- *

For more information, see Services in the - * Amazon VPC Lattice User Guide.

+ * @see {@link CreateServiceCommand} */ - public createService( - args: CreateServiceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createService( - args: CreateServiceCommandInput, - cb: (err: any, data?: CreateServiceCommandOutput) => void - ): void; - public createService( + createService(args: CreateServiceCommandInput, options?: __HttpHandlerOptions): Promise; + createService(args: CreateServiceCommandInput, cb: (err: any, data?: CreateServiceCommandOutput) => void): void; + createService( args: CreateServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceCommandOutput) => void ): void; - public createService( - args: CreateServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateServiceCommandOutput) => void), - cb?: (err: any, data?: CreateServiceCommandOutput) => void - ): Promise | void { - const command = new CreateServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a service network. A service network is a logical boundary for a collection of - * services. You can associate services and VPCs with a service network.

- *

For more information, see Service networks in the - * Amazon VPC Lattice User Guide.

+ * @see {@link CreateServiceNetworkCommand} */ - public createServiceNetwork( + createServiceNetwork( args: CreateServiceNetworkCommandInput, options?: __HttpHandlerOptions ): Promise; - public createServiceNetwork( + createServiceNetwork( args: CreateServiceNetworkCommandInput, cb: (err: any, data?: CreateServiceNetworkCommandOutput) => void ): void; - public createServiceNetwork( + createServiceNetwork( args: CreateServiceNetworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceNetworkCommandOutput) => void ): void; - public createServiceNetwork( - args: CreateServiceNetworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateServiceNetworkCommandOutput) => void), - cb?: (err: any, data?: CreateServiceNetworkCommandOutput) => void - ): Promise | void { - const command = new CreateServiceNetworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a service with a service network.

- *

You can't use this operation if the service and service network are already associated or if - * there is a disassociation or deletion in progress. If the association fails, you can retry the - * operation by deleting the association and recreating it.

- *

You cannot associate a service and service network that are shared with a caller. The caller - * must own either the service or the service network.

- *

As a result of this operation, the association is created in the service network account and - * the association owner account.

+ * @see {@link CreateServiceNetworkServiceAssociationCommand} */ - public createServiceNetworkServiceAssociation( + createServiceNetworkServiceAssociation( args: CreateServiceNetworkServiceAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createServiceNetworkServiceAssociation( + createServiceNetworkServiceAssociation( args: CreateServiceNetworkServiceAssociationCommandInput, cb: (err: any, data?: CreateServiceNetworkServiceAssociationCommandOutput) => void ): void; - public createServiceNetworkServiceAssociation( + createServiceNetworkServiceAssociation( args: CreateServiceNetworkServiceAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceNetworkServiceAssociationCommandOutput) => void ): void; - public createServiceNetworkServiceAssociation( - args: CreateServiceNetworkServiceAssociationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: CreateServiceNetworkServiceAssociationCommandOutput) => void), - cb?: (err: any, data?: CreateServiceNetworkServiceAssociationCommandOutput) => void - ): Promise | void { - const command = new CreateServiceNetworkServiceAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a VPC with a service network. When you associate a VPC with the service network, - * it enables all the resources within that VPC to be clients and communicate with other services in - * the service network. For more information, see Manage VPC associations in the Amazon VPC Lattice User Guide.

- *

You can't use this operation if there is a disassociation in progress. If the association - * fails, retry by deleting the association and recreating it.

- *

As a result of this operation, the association gets created in the service network account - * and the VPC owner account.

- *

If you add a security group to the service network and VPC association, the association must - * continue to always have at least one security group. You can add or edit security groups at any - * time. However, to remove all security groups, you must first delete the association and recreate - * it without security groups.

+ * @see {@link CreateServiceNetworkVpcAssociationCommand} */ - public createServiceNetworkVpcAssociation( + createServiceNetworkVpcAssociation( args: CreateServiceNetworkVpcAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createServiceNetworkVpcAssociation( + createServiceNetworkVpcAssociation( args: CreateServiceNetworkVpcAssociationCommandInput, cb: (err: any, data?: CreateServiceNetworkVpcAssociationCommandOutput) => void ): void; - public createServiceNetworkVpcAssociation( + createServiceNetworkVpcAssociation( args: CreateServiceNetworkVpcAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceNetworkVpcAssociationCommandOutput) => void ): void; - public createServiceNetworkVpcAssociation( - args: CreateServiceNetworkVpcAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateServiceNetworkVpcAssociationCommandOutput) => void), - cb?: (err: any, data?: CreateServiceNetworkVpcAssociationCommandOutput) => void - ): Promise | void { - const command = new CreateServiceNetworkVpcAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a target group. A target group is a collection of targets, or compute resources, - * that run your application or service. A target group can only be used by a single service.

- *

For more information, see Target groups in the - * Amazon VPC Lattice User Guide.

+ * @see {@link CreateTargetGroupCommand} */ - public createTargetGroup( + createTargetGroup( args: CreateTargetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTargetGroup( + createTargetGroup( args: CreateTargetGroupCommandInput, cb: (err: any, data?: CreateTargetGroupCommandOutput) => void ): void; - public createTargetGroup( + createTargetGroup( args: CreateTargetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTargetGroupCommandOutput) => void ): void; - public createTargetGroup( - args: CreateTargetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTargetGroupCommandOutput) => void), - cb?: (err: any, data?: CreateTargetGroupCommandOutput) => void - ): Promise | void { - const command = new CreateTargetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified access log subscription.

+ * @see {@link DeleteAccessLogSubscriptionCommand} */ - public deleteAccessLogSubscription( + deleteAccessLogSubscription( args: DeleteAccessLogSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAccessLogSubscription( + deleteAccessLogSubscription( args: DeleteAccessLogSubscriptionCommandInput, cb: (err: any, data?: DeleteAccessLogSubscriptionCommandOutput) => void ): void; - public deleteAccessLogSubscription( + deleteAccessLogSubscription( args: DeleteAccessLogSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessLogSubscriptionCommandOutput) => void ): void; - public deleteAccessLogSubscription( - args: DeleteAccessLogSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAccessLogSubscriptionCommandOutput) => void), - cb?: (err: any, data?: DeleteAccessLogSubscriptionCommandOutput) => void - ): Promise | void { - const command = new DeleteAccessLogSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified auth policy. If an auth is set to AWS_IAM - * and the auth policy is deleted, all requests will be denied by default. If you are trying to - * remove the auth policy completely, you must set the auth_type to NONE. If auth is - * enabled on the resource, but no auth policy is set, all requests will be denied.

+ * @see {@link DeleteAuthPolicyCommand} */ - public deleteAuthPolicy( + deleteAuthPolicy( args: DeleteAuthPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAuthPolicy( + deleteAuthPolicy( args: DeleteAuthPolicyCommandInput, cb: (err: any, data?: DeleteAuthPolicyCommandOutput) => void ): void; - public deleteAuthPolicy( + deleteAuthPolicy( args: DeleteAuthPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAuthPolicyCommandOutput) => void ): void; - public deleteAuthPolicy( - args: DeleteAuthPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAuthPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteAuthPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteAuthPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified listener.

+ * @see {@link DeleteListenerCommand} */ - public deleteListener( + deleteListener( args: DeleteListenerCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteListener( - args: DeleteListenerCommandInput, - cb: (err: any, data?: DeleteListenerCommandOutput) => void - ): void; - public deleteListener( + deleteListener(args: DeleteListenerCommandInput, cb: (err: any, data?: DeleteListenerCommandOutput) => void): void; + deleteListener( args: DeleteListenerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteListenerCommandOutput) => void ): void; - public deleteListener( - args: DeleteListenerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteListenerCommandOutput) => void), - cb?: (err: any, data?: DeleteListenerCommandOutput) => void - ): Promise | void { - const command = new DeleteListenerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified resource policy.

+ * @see {@link DeleteResourcePolicyCommand} */ - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( - args: DeleteResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a listener rule. Each listener has a default rule for checking connection requests, - * but you can define additional rules. Each rule consists of a priority, one or more actions, and - * one or more conditions. You can delete additional listener rules, but you cannot delete the - * default rule.

- *

For more information, see Listener rules in the - * Amazon VPC Lattice User Guide.

+ * @see {@link DeleteRuleCommand} */ - public deleteRule(args: DeleteRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteRule(args: DeleteRuleCommandInput, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void; - public deleteRule( + deleteRule(args: DeleteRuleCommandInput, options?: __HttpHandlerOptions): Promise; + deleteRule(args: DeleteRuleCommandInput, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void; + deleteRule( args: DeleteRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRuleCommandOutput) => void ): void; - public deleteRule( - args: DeleteRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a service. A service can't be deleted if it's associated with a service network. If - * you delete a service, all resources related to the service, such as the resource policy, auth - * policy, listeners, listener rules, and access log subscriptions, are also deleted. For more - * information, see Delete a service in the - * Amazon VPC Lattice User Guide.

+ * @see {@link DeleteServiceCommand} */ - public deleteService( - args: DeleteServiceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteService( - args: DeleteServiceCommandInput, - cb: (err: any, data?: DeleteServiceCommandOutput) => void - ): void; - public deleteService( + deleteService(args: DeleteServiceCommandInput, options?: __HttpHandlerOptions): Promise; + deleteService(args: DeleteServiceCommandInput, cb: (err: any, data?: DeleteServiceCommandOutput) => void): void; + deleteService( args: DeleteServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceCommandOutput) => void ): void; - public deleteService( - args: DeleteServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteServiceCommandOutput) => void), - cb?: (err: any, data?: DeleteServiceCommandOutput) => void - ): Promise | void { - const command = new DeleteServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a service network. You can only delete the service network if there is no service or - * VPC associated with it. If you delete a service network, all resources related to the service - * network, such as the resource policy, auth policy, and access log subscriptions, are also - * deleted. For more information, see Delete a service - * network in the Amazon VPC Lattice User Guide.

+ * @see {@link DeleteServiceNetworkCommand} */ - public deleteServiceNetwork( + deleteServiceNetwork( args: DeleteServiceNetworkCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteServiceNetwork( + deleteServiceNetwork( args: DeleteServiceNetworkCommandInput, cb: (err: any, data?: DeleteServiceNetworkCommandOutput) => void ): void; - public deleteServiceNetwork( + deleteServiceNetwork( args: DeleteServiceNetworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceNetworkCommandOutput) => void ): void; - public deleteServiceNetwork( - args: DeleteServiceNetworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteServiceNetworkCommandOutput) => void), - cb?: (err: any, data?: DeleteServiceNetworkCommandOutput) => void - ): Promise | void { - const command = new DeleteServiceNetworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the association between a specified service and the specific service network. This - * request will fail if an association is still in progress.

+ * @see {@link DeleteServiceNetworkServiceAssociationCommand} */ - public deleteServiceNetworkServiceAssociation( + deleteServiceNetworkServiceAssociation( args: DeleteServiceNetworkServiceAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteServiceNetworkServiceAssociation( + deleteServiceNetworkServiceAssociation( args: DeleteServiceNetworkServiceAssociationCommandInput, cb: (err: any, data?: DeleteServiceNetworkServiceAssociationCommandOutput) => void ): void; - public deleteServiceNetworkServiceAssociation( + deleteServiceNetworkServiceAssociation( args: DeleteServiceNetworkServiceAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceNetworkServiceAssociationCommandOutput) => void ): void; - public deleteServiceNetworkServiceAssociation( - args: DeleteServiceNetworkServiceAssociationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DeleteServiceNetworkServiceAssociationCommandOutput) => void), - cb?: (err: any, data?: DeleteServiceNetworkServiceAssociationCommandOutput) => void - ): Promise | void { - const command = new DeleteServiceNetworkServiceAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates the VPC from the service network. You can't disassociate the VPC if there is a - * create or update association in progress.

+ * @see {@link DeleteServiceNetworkVpcAssociationCommand} */ - public deleteServiceNetworkVpcAssociation( + deleteServiceNetworkVpcAssociation( args: DeleteServiceNetworkVpcAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteServiceNetworkVpcAssociation( + deleteServiceNetworkVpcAssociation( args: DeleteServiceNetworkVpcAssociationCommandInput, cb: (err: any, data?: DeleteServiceNetworkVpcAssociationCommandOutput) => void ): void; - public deleteServiceNetworkVpcAssociation( + deleteServiceNetworkVpcAssociation( args: DeleteServiceNetworkVpcAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceNetworkVpcAssociationCommandOutput) => void ): void; - public deleteServiceNetworkVpcAssociation( - args: DeleteServiceNetworkVpcAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteServiceNetworkVpcAssociationCommandOutput) => void), - cb?: (err: any, data?: DeleteServiceNetworkVpcAssociationCommandOutput) => void - ): Promise | void { - const command = new DeleteServiceNetworkVpcAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a target group. You can't delete a target group if it is used in a listener rule or - * if the target group creation is in progress.

+ * @see {@link DeleteTargetGroupCommand} */ - public deleteTargetGroup( + deleteTargetGroup( args: DeleteTargetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTargetGroup( + deleteTargetGroup( args: DeleteTargetGroupCommandInput, cb: (err: any, data?: DeleteTargetGroupCommandOutput) => void ): void; - public deleteTargetGroup( + deleteTargetGroup( args: DeleteTargetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTargetGroupCommandOutput) => void ): void; - public deleteTargetGroup( - args: DeleteTargetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTargetGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteTargetGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteTargetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deregisters the specified targets from the specified target group.

+ * @see {@link DeregisterTargetsCommand} */ - public deregisterTargets( + deregisterTargets( args: DeregisterTargetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterTargets( + deregisterTargets( args: DeregisterTargetsCommandInput, cb: (err: any, data?: DeregisterTargetsCommandOutput) => void ): void; - public deregisterTargets( + deregisterTargets( args: DeregisterTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterTargetsCommandOutput) => void ): void; - public deregisterTargets( - args: DeregisterTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterTargetsCommandOutput) => void), - cb?: (err: any, data?: DeregisterTargetsCommandOutput) => void - ): Promise | void { - const command = new DeregisterTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the specified access log subscription.

+ * @see {@link GetAccessLogSubscriptionCommand} */ - public getAccessLogSubscription( + getAccessLogSubscription( args: GetAccessLogSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccessLogSubscription( + getAccessLogSubscription( args: GetAccessLogSubscriptionCommandInput, cb: (err: any, data?: GetAccessLogSubscriptionCommandOutput) => void ): void; - public getAccessLogSubscription( + getAccessLogSubscription( args: GetAccessLogSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessLogSubscriptionCommandOutput) => void ): void; - public getAccessLogSubscription( - args: GetAccessLogSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccessLogSubscriptionCommandOutput) => void), - cb?: (err: any, data?: GetAccessLogSubscriptionCommandOutput) => void - ): Promise | void { - const command = new GetAccessLogSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the auth policy for the specified service or service - * network.

+ * @see {@link GetAuthPolicyCommand} */ - public getAuthPolicy( - args: GetAuthPolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getAuthPolicy( - args: GetAuthPolicyCommandInput, - cb: (err: any, data?: GetAuthPolicyCommandOutput) => void - ): void; - public getAuthPolicy( + getAuthPolicy(args: GetAuthPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + getAuthPolicy(args: GetAuthPolicyCommandInput, cb: (err: any, data?: GetAuthPolicyCommandOutput) => void): void; + getAuthPolicy( args: GetAuthPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAuthPolicyCommandOutput) => void ): void; - public getAuthPolicy( - args: GetAuthPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAuthPolicyCommandOutput) => void), - cb?: (err: any, data?: GetAuthPolicyCommandOutput) => void - ): Promise | void { - const command = new GetAuthPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the specified listener for the specified service.

+ * @see {@link GetListenerCommand} */ - public getListener(args: GetListenerCommandInput, options?: __HttpHandlerOptions): Promise; - public getListener(args: GetListenerCommandInput, cb: (err: any, data?: GetListenerCommandOutput) => void): void; - public getListener( + getListener(args: GetListenerCommandInput, options?: __HttpHandlerOptions): Promise; + getListener(args: GetListenerCommandInput, cb: (err: any, data?: GetListenerCommandOutput) => void): void; + getListener( args: GetListenerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetListenerCommandOutput) => void ): void; - public getListener( - args: GetListenerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetListenerCommandOutput) => void), - cb?: (err: any, data?: GetListenerCommandOutput) => void - ): Promise | void { - const command = new GetListenerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the resource policy. The resource policy is an IAM policy - * created on behalf of the resource owner when they share a resource.

+ * @see {@link GetResourcePolicyCommand} */ - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void ): void; - public getResourcePolicy( + getResourcePolicy( args: GetResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void ): void; - public getResourcePolicy( - args: GetResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: GetResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new GetResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about listener rules. You can also retrieve information about the - * default listener rule. For more information, see Listener rules in the - * Amazon VPC Lattice User Guide.

+ * @see {@link GetRuleCommand} */ - public getRule(args: GetRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public getRule(args: GetRuleCommandInput, cb: (err: any, data?: GetRuleCommandOutput) => void): void; - public getRule( + getRule(args: GetRuleCommandInput, options?: __HttpHandlerOptions): Promise; + getRule(args: GetRuleCommandInput, cb: (err: any, data?: GetRuleCommandOutput) => void): void; + getRule( args: GetRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRuleCommandOutput) => void ): void; - public getRule( - args: GetRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRuleCommandOutput) => void), - cb?: (err: any, data?: GetRuleCommandOutput) => void - ): Promise | void { - const command = new GetRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the specified service.

+ * @see {@link GetServiceCommand} */ - public getService(args: GetServiceCommandInput, options?: __HttpHandlerOptions): Promise; - public getService(args: GetServiceCommandInput, cb: (err: any, data?: GetServiceCommandOutput) => void): void; - public getService( + getService(args: GetServiceCommandInput, options?: __HttpHandlerOptions): Promise; + getService(args: GetServiceCommandInput, cb: (err: any, data?: GetServiceCommandOutput) => void): void; + getService( args: GetServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceCommandOutput) => void ): void; - public getService( - args: GetServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceCommandOutput) => void), - cb?: (err: any, data?: GetServiceCommandOutput) => void - ): Promise | void { - const command = new GetServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the specified service network.

+ * @see {@link GetServiceNetworkCommand} */ - public getServiceNetwork( + getServiceNetwork( args: GetServiceNetworkCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServiceNetwork( + getServiceNetwork( args: GetServiceNetworkCommandInput, cb: (err: any, data?: GetServiceNetworkCommandOutput) => void ): void; - public getServiceNetwork( + getServiceNetwork( args: GetServiceNetworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceNetworkCommandOutput) => void ): void; - public getServiceNetwork( - args: GetServiceNetworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceNetworkCommandOutput) => void), - cb?: (err: any, data?: GetServiceNetworkCommandOutput) => void - ): Promise | void { - const command = new GetServiceNetworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the specified association between a service network and a - * service.

+ * @see {@link GetServiceNetworkServiceAssociationCommand} */ - public getServiceNetworkServiceAssociation( + getServiceNetworkServiceAssociation( args: GetServiceNetworkServiceAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServiceNetworkServiceAssociation( + getServiceNetworkServiceAssociation( args: GetServiceNetworkServiceAssociationCommandInput, cb: (err: any, data?: GetServiceNetworkServiceAssociationCommandOutput) => void ): void; - public getServiceNetworkServiceAssociation( + getServiceNetworkServiceAssociation( args: GetServiceNetworkServiceAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceNetworkServiceAssociationCommandOutput) => void ): void; - public getServiceNetworkServiceAssociation( - args: GetServiceNetworkServiceAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceNetworkServiceAssociationCommandOutput) => void), - cb?: (err: any, data?: GetServiceNetworkServiceAssociationCommandOutput) => void - ): Promise | void { - const command = new GetServiceNetworkServiceAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the association between a service network and a VPC.

+ * @see {@link GetServiceNetworkVpcAssociationCommand} */ - public getServiceNetworkVpcAssociation( + getServiceNetworkVpcAssociation( args: GetServiceNetworkVpcAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServiceNetworkVpcAssociation( + getServiceNetworkVpcAssociation( args: GetServiceNetworkVpcAssociationCommandInput, cb: (err: any, data?: GetServiceNetworkVpcAssociationCommandOutput) => void ): void; - public getServiceNetworkVpcAssociation( + getServiceNetworkVpcAssociation( args: GetServiceNetworkVpcAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceNetworkVpcAssociationCommandOutput) => void ): void; - public getServiceNetworkVpcAssociation( - args: GetServiceNetworkVpcAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceNetworkVpcAssociationCommandOutput) => void), - cb?: (err: any, data?: GetServiceNetworkVpcAssociationCommandOutput) => void - ): Promise | void { - const command = new GetServiceNetworkVpcAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the specified target group.

+ * @see {@link GetTargetGroupCommand} */ - public getTargetGroup( + getTargetGroup( args: GetTargetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTargetGroup( - args: GetTargetGroupCommandInput, - cb: (err: any, data?: GetTargetGroupCommandOutput) => void - ): void; - public getTargetGroup( + getTargetGroup(args: GetTargetGroupCommandInput, cb: (err: any, data?: GetTargetGroupCommandOutput) => void): void; + getTargetGroup( args: GetTargetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTargetGroupCommandOutput) => void ): void; - public getTargetGroup( - args: GetTargetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTargetGroupCommandOutput) => void), - cb?: (err: any, data?: GetTargetGroupCommandOutput) => void - ): Promise | void { - const command = new GetTargetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists all access log subscriptions for the specified service network or service.

+ * @see {@link ListAccessLogSubscriptionsCommand} */ - public listAccessLogSubscriptions( + listAccessLogSubscriptions( args: ListAccessLogSubscriptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAccessLogSubscriptions( + listAccessLogSubscriptions( args: ListAccessLogSubscriptionsCommandInput, cb: (err: any, data?: ListAccessLogSubscriptionsCommandOutput) => void ): void; - public listAccessLogSubscriptions( + listAccessLogSubscriptions( args: ListAccessLogSubscriptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessLogSubscriptionsCommandOutput) => void ): void; - public listAccessLogSubscriptions( - args: ListAccessLogSubscriptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccessLogSubscriptionsCommandOutput) => void), - cb?: (err: any, data?: ListAccessLogSubscriptionsCommandOutput) => void - ): Promise | void { - const command = new ListAccessLogSubscriptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the listeners for the specified service.

+ * @see {@link ListListenersCommand} */ - public listListeners( - args: ListListenersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listListeners( - args: ListListenersCommandInput, - cb: (err: any, data?: ListListenersCommandOutput) => void - ): void; - public listListeners( + listListeners(args: ListListenersCommandInput, options?: __HttpHandlerOptions): Promise; + listListeners(args: ListListenersCommandInput, cb: (err: any, data?: ListListenersCommandOutput) => void): void; + listListeners( args: ListListenersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListListenersCommandOutput) => void ): void; - public listListeners( - args: ListListenersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListListenersCommandOutput) => void), - cb?: (err: any, data?: ListListenersCommandOutput) => void - ): Promise | void { - const command = new ListListenersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the rules for the listener.

+ * @see {@link ListRulesCommand} */ - public listRules(args: ListRulesCommandInput, options?: __HttpHandlerOptions): Promise; - public listRules(args: ListRulesCommandInput, cb: (err: any, data?: ListRulesCommandOutput) => void): void; - public listRules( + listRules(args: ListRulesCommandInput, options?: __HttpHandlerOptions): Promise; + listRules(args: ListRulesCommandInput, cb: (err: any, data?: ListRulesCommandOutput) => void): void; + listRules( args: ListRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRulesCommandOutput) => void ): void; - public listRules( - args: ListRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRulesCommandOutput) => void), - cb?: (err: any, data?: ListRulesCommandOutput) => void - ): Promise | void { - const command = new ListRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the service networks owned by the caller account or shared with the caller account. - * Also includes the account ID in the ARN to show which account owns the service network.

+ * @see {@link ListServiceNetworksCommand} */ - public listServiceNetworks( + listServiceNetworks( args: ListServiceNetworksCommandInput, options?: __HttpHandlerOptions ): Promise; - public listServiceNetworks( + listServiceNetworks( args: ListServiceNetworksCommandInput, cb: (err: any, data?: ListServiceNetworksCommandOutput) => void ): void; - public listServiceNetworks( + listServiceNetworks( args: ListServiceNetworksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceNetworksCommandOutput) => void ): void; - public listServiceNetworks( - args: ListServiceNetworksCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServiceNetworksCommandOutput) => void), - cb?: (err: any, data?: ListServiceNetworksCommandOutput) => void - ): Promise | void { - const command = new ListServiceNetworksCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the associations between the service network and the service. You can filter the list - * either by service or service network. You must provide either the service network identifier or - * the service identifier.

- *

Every association in Amazon VPC Lattice is given a unique Amazon Resource Name (ARN), such as when a - * service network is associated with a VPC or when a service is associated with a service network. - * If the association is for a resource that is shared with another account, the association will - * include the local account ID as the prefix in the ARN for each account the resource is shared - * with.

+ * @see {@link ListServiceNetworkServiceAssociationsCommand} */ - public listServiceNetworkServiceAssociations( + listServiceNetworkServiceAssociations( args: ListServiceNetworkServiceAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listServiceNetworkServiceAssociations( + listServiceNetworkServiceAssociations( args: ListServiceNetworkServiceAssociationsCommandInput, cb: (err: any, data?: ListServiceNetworkServiceAssociationsCommandOutput) => void ): void; - public listServiceNetworkServiceAssociations( + listServiceNetworkServiceAssociations( args: ListServiceNetworkServiceAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceNetworkServiceAssociationsCommandOutput) => void ): void; - public listServiceNetworkServiceAssociations( - args: ListServiceNetworkServiceAssociationsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListServiceNetworkServiceAssociationsCommandOutput) => void), - cb?: (err: any, data?: ListServiceNetworkServiceAssociationsCommandOutput) => void - ): Promise | void { - const command = new ListServiceNetworkServiceAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the service network and VPC associations. You can filter the list either by VPC or - * service network. You must provide either the service network identifier or the VPC - * identifier.

+ * @see {@link ListServiceNetworkVpcAssociationsCommand} */ - public listServiceNetworkVpcAssociations( + listServiceNetworkVpcAssociations( args: ListServiceNetworkVpcAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listServiceNetworkVpcAssociations( + listServiceNetworkVpcAssociations( args: ListServiceNetworkVpcAssociationsCommandInput, cb: (err: any, data?: ListServiceNetworkVpcAssociationsCommandOutput) => void ): void; - public listServiceNetworkVpcAssociations( + listServiceNetworkVpcAssociations( args: ListServiceNetworkVpcAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceNetworkVpcAssociationsCommandOutput) => void ): void; - public listServiceNetworkVpcAssociations( - args: ListServiceNetworkVpcAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServiceNetworkVpcAssociationsCommandOutput) => void), - cb?: (err: any, data?: ListServiceNetworkVpcAssociationsCommandOutput) => void - ): Promise | void { - const command = new ListServiceNetworkVpcAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the services owned by the caller account or shared with the caller account.

+ * @see {@link ListServicesCommand} */ - public listServices( - args: ListServicesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listServices(args: ListServicesCommandInput, cb: (err: any, data?: ListServicesCommandOutput) => void): void; - public listServices( + listServices(args: ListServicesCommandInput, options?: __HttpHandlerOptions): Promise; + listServices(args: ListServicesCommandInput, cb: (err: any, data?: ListServicesCommandOutput) => void): void; + listServices( args: ListServicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServicesCommandOutput) => void ): void; - public listServices( - args: ListServicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListServicesCommandOutput) => void), - cb?: (err: any, data?: ListServicesCommandOutput) => void - ): Promise | void { - const command = new ListServicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags for the specified resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists your target groups. You can narrow your search by using the filters below in your - * request.

+ * @see {@link ListTargetGroupsCommand} */ - public listTargetGroups( + listTargetGroups( args: ListTargetGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTargetGroups( + listTargetGroups( args: ListTargetGroupsCommandInput, cb: (err: any, data?: ListTargetGroupsCommandOutput) => void ): void; - public listTargetGroups( + listTargetGroups( args: ListTargetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTargetGroupsCommandOutput) => void ): void; - public listTargetGroups( - args: ListTargetGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTargetGroupsCommandOutput) => void), - cb?: (err: any, data?: ListTargetGroupsCommandOutput) => void - ): Promise | void { - const command = new ListTargetGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the targets for the target group. By default, all targets are included. You can use - * this API to check the health status of targets. You can also filter the results by target.

+ * @see {@link ListTargetsCommand} */ - public listTargets(args: ListTargetsCommandInput, options?: __HttpHandlerOptions): Promise; - public listTargets(args: ListTargetsCommandInput, cb: (err: any, data?: ListTargetsCommandOutput) => void): void; - public listTargets( + listTargets(args: ListTargetsCommandInput, options?: __HttpHandlerOptions): Promise; + listTargets(args: ListTargetsCommandInput, cb: (err: any, data?: ListTargetsCommandOutput) => void): void; + listTargets( args: ListTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTargetsCommandOutput) => void ): void; - public listTargets( - args: ListTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTargetsCommandOutput) => void), - cb?: (err: any, data?: ListTargetsCommandOutput) => void - ): Promise | void { - const command = new ListTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates or updates the auth policy. The policy string in JSON must not contain newlines or - * blank lines.

+ * @see {@link PutAuthPolicyCommand} */ - public putAuthPolicy( - args: PutAuthPolicyCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public putAuthPolicy( - args: PutAuthPolicyCommandInput, - cb: (err: any, data?: PutAuthPolicyCommandOutput) => void - ): void; - public putAuthPolicy( + putAuthPolicy(args: PutAuthPolicyCommandInput, options?: __HttpHandlerOptions): Promise; + putAuthPolicy(args: PutAuthPolicyCommandInput, cb: (err: any, data?: PutAuthPolicyCommandOutput) => void): void; + putAuthPolicy( args: PutAuthPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAuthPolicyCommandOutput) => void ): void; - public putAuthPolicy( - args: PutAuthPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAuthPolicyCommandOutput) => void), - cb?: (err: any, data?: PutAuthPolicyCommandOutput) => void - ): Promise | void { - const command = new PutAuthPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Attaches a resource-based permission policy to a service or service network. The policy must - * contain the same actions and condition statements as the Amazon Web Services Resource Access - * Manager permission for sharing services and service networks.

+ * @see {@link PutResourcePolicyCommand} */ - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( - args: PutResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: PutResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new PutResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Registers the targets with the target group. If it's a Lambda target, you can only have one - * target in a target group.

+ * @see {@link RegisterTargetsCommand} */ - public registerTargets( + registerTargets( args: RegisterTargetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerTargets( - args: RegisterTargetsCommandInput, - cb: (err: any, data?: RegisterTargetsCommandOutput) => void - ): void; - public registerTargets( + registerTargets(args: RegisterTargetsCommandInput, cb: (err: any, data?: RegisterTargetsCommandOutput) => void): void; + registerTargets( args: RegisterTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterTargetsCommandOutput) => void ): void; - public registerTargets( - args: RegisterTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterTargetsCommandOutput) => void), - cb?: (err: any, data?: RegisterTargetsCommandOutput) => void - ): Promise | void { - const command = new RegisterTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds the specified tags to the specified resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified tags from the specified resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified access log subscription.

+ * @see {@link UpdateAccessLogSubscriptionCommand} */ - public updateAccessLogSubscription( + updateAccessLogSubscription( args: UpdateAccessLogSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAccessLogSubscription( + updateAccessLogSubscription( args: UpdateAccessLogSubscriptionCommandInput, cb: (err: any, data?: UpdateAccessLogSubscriptionCommandOutput) => void ): void; - public updateAccessLogSubscription( + updateAccessLogSubscription( args: UpdateAccessLogSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccessLogSubscriptionCommandOutput) => void ): void; - public updateAccessLogSubscription( - args: UpdateAccessLogSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAccessLogSubscriptionCommandOutput) => void), - cb?: (err: any, data?: UpdateAccessLogSubscriptionCommandOutput) => void - ): Promise | void { - const command = new UpdateAccessLogSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified listener for the specified service.

+ * @see {@link UpdateListenerCommand} */ - public updateListener( + updateListener( args: UpdateListenerCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateListener( - args: UpdateListenerCommandInput, - cb: (err: any, data?: UpdateListenerCommandOutput) => void - ): void; - public updateListener( + updateListener(args: UpdateListenerCommandInput, cb: (err: any, data?: UpdateListenerCommandOutput) => void): void; + updateListener( args: UpdateListenerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateListenerCommandOutput) => void ): void; - public updateListener( - args: UpdateListenerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateListenerCommandOutput) => void), - cb?: (err: any, data?: UpdateListenerCommandOutput) => void - ): Promise | void { - const command = new UpdateListenerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a rule for the listener. You can't modify a default listener rule. To modify a - * default listener rule, use UpdateListener.

+ * @see {@link UpdateRuleCommand} */ - public updateRule(args: UpdateRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public updateRule(args: UpdateRuleCommandInput, cb: (err: any, data?: UpdateRuleCommandOutput) => void): void; - public updateRule( + updateRule(args: UpdateRuleCommandInput, options?: __HttpHandlerOptions): Promise; + updateRule(args: UpdateRuleCommandInput, cb: (err: any, data?: UpdateRuleCommandOutput) => void): void; + updateRule( args: UpdateRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRuleCommandOutput) => void ): void; - public updateRule( - args: UpdateRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRuleCommandOutput) => void), - cb?: (err: any, data?: UpdateRuleCommandOutput) => void - ): Promise | void { - const command = new UpdateRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified service.

+ * @see {@link UpdateServiceCommand} */ - public updateService( - args: UpdateServiceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateService( - args: UpdateServiceCommandInput, - cb: (err: any, data?: UpdateServiceCommandOutput) => void - ): void; - public updateService( + updateService(args: UpdateServiceCommandInput, options?: __HttpHandlerOptions): Promise; + updateService(args: UpdateServiceCommandInput, cb: (err: any, data?: UpdateServiceCommandOutput) => void): void; + updateService( args: UpdateServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceCommandOutput) => void ): void; - public updateService( - args: UpdateServiceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServiceCommandOutput) => void), - cb?: (err: any, data?: UpdateServiceCommandOutput) => void - ): Promise | void { - const command = new UpdateServiceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified service network.

+ * @see {@link UpdateServiceNetworkCommand} */ - public updateServiceNetwork( + updateServiceNetwork( args: UpdateServiceNetworkCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateServiceNetwork( + updateServiceNetwork( args: UpdateServiceNetworkCommandInput, cb: (err: any, data?: UpdateServiceNetworkCommandOutput) => void ): void; - public updateServiceNetwork( + updateServiceNetwork( args: UpdateServiceNetworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceNetworkCommandOutput) => void ): void; - public updateServiceNetwork( - args: UpdateServiceNetworkCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServiceNetworkCommandOutput) => void), - cb?: (err: any, data?: UpdateServiceNetworkCommandOutput) => void - ): Promise | void { - const command = new UpdateServiceNetworkCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the service network and VPC association. If you add a security group to the service - * network and VPC association, the association must continue to always have at least one security - * group. You can add or edit security groups at any time. However, to remove all security groups, - * you must first delete the association and recreate it without security groups.

+ * @see {@link UpdateServiceNetworkVpcAssociationCommand} */ - public updateServiceNetworkVpcAssociation( + updateServiceNetworkVpcAssociation( args: UpdateServiceNetworkVpcAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateServiceNetworkVpcAssociation( + updateServiceNetworkVpcAssociation( args: UpdateServiceNetworkVpcAssociationCommandInput, cb: (err: any, data?: UpdateServiceNetworkVpcAssociationCommandOutput) => void ): void; - public updateServiceNetworkVpcAssociation( + updateServiceNetworkVpcAssociation( args: UpdateServiceNetworkVpcAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceNetworkVpcAssociationCommandOutput) => void ): void; - public updateServiceNetworkVpcAssociation( - args: UpdateServiceNetworkVpcAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateServiceNetworkVpcAssociationCommandOutput) => void), - cb?: (err: any, data?: UpdateServiceNetworkVpcAssociationCommandOutput) => void - ): Promise | void { - const command = new UpdateServiceNetworkVpcAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified target group.

+ * @see {@link UpdateTargetGroupCommand} */ - public updateTargetGroup( + updateTargetGroup( args: UpdateTargetGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTargetGroup( + updateTargetGroup( args: UpdateTargetGroupCommandInput, cb: (err: any, data?: UpdateTargetGroupCommandOutput) => void ): void; - public updateTargetGroup( + updateTargetGroup( args: UpdateTargetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTargetGroupCommandOutput) => void ): void; - public updateTargetGroup( - args: UpdateTargetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTargetGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateTargetGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateTargetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon VPC Lattice is a fully managed application networking service that you use to connect, secure, + * and monitor all of your services across multiple accounts and virtual private clouds (VPCs). + * Amazon VPC Lattice interconnects your microservices and legacy services within a logical boundary, so that + * you can discover and manage them more efficiently. For more information, see the Amazon VPC Lattice User Guide + *

+ */ +export class VPCLattice extends VPCLatticeClient implements VPCLattice {} +createAggregatedClient(commands, VPCLattice); diff --git a/clients/client-waf-regional/src/WAFRegional.ts b/clients/client-waf-regional/src/WAFRegional.ts index ac63c6bcacda..0f12031dc622 100644 --- a/clients/client-waf-regional/src/WAFRegional.ts +++ b/clients/client-waf-regional/src/WAFRegional.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -354,4366 +355,1349 @@ import { UpdateXssMatchSetCommandInput, UpdateXssMatchSetCommandOutput, } from "./commands/UpdateXssMatchSetCommand"; -import { WAFRegionalClient } from "./WAFRegionalClient"; +import { WAFRegionalClient, WAFRegionalClientConfig } from "./WAFRegionalClient"; -/** - * @public - * - *

This is AWS WAF Classic Regional documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

This is the AWS WAF Regional Classic API Reference for using AWS WAF Classic with the AWS resources, Elastic Load Balancing (ELB) Application Load Balancers and API Gateway APIs. The AWS WAF Classic actions and data types listed in the reference are available for protecting Elastic Load Balancing (ELB) Application Load Balancers and API Gateway APIs. You can use these actions and data types by means of the endpoints listed in AWS Regions and Endpoints. This guide is for developers who need detailed information about the AWS WAF Classic API actions, data types, and errors. For detailed information about AWS WAF Classic features and an overview of how to use the AWS WAF Classic API, see the - * AWS - * WAF Classic in the developer guide.

- */ -export class WAFRegional extends WAFRegionalClient { +const commands = { + AssociateWebACLCommand, + CreateByteMatchSetCommand, + CreateGeoMatchSetCommand, + CreateIPSetCommand, + CreateRateBasedRuleCommand, + CreateRegexMatchSetCommand, + CreateRegexPatternSetCommand, + CreateRuleCommand, + CreateRuleGroupCommand, + CreateSizeConstraintSetCommand, + CreateSqlInjectionMatchSetCommand, + CreateWebACLCommand, + CreateWebACLMigrationStackCommand, + CreateXssMatchSetCommand, + DeleteByteMatchSetCommand, + DeleteGeoMatchSetCommand, + DeleteIPSetCommand, + DeleteLoggingConfigurationCommand, + DeletePermissionPolicyCommand, + DeleteRateBasedRuleCommand, + DeleteRegexMatchSetCommand, + DeleteRegexPatternSetCommand, + DeleteRuleCommand, + DeleteRuleGroupCommand, + DeleteSizeConstraintSetCommand, + DeleteSqlInjectionMatchSetCommand, + DeleteWebACLCommand, + DeleteXssMatchSetCommand, + DisassociateWebACLCommand, + GetByteMatchSetCommand, + GetChangeTokenCommand, + GetChangeTokenStatusCommand, + GetGeoMatchSetCommand, + GetIPSetCommand, + GetLoggingConfigurationCommand, + GetPermissionPolicyCommand, + GetRateBasedRuleCommand, + GetRateBasedRuleManagedKeysCommand, + GetRegexMatchSetCommand, + GetRegexPatternSetCommand, + GetRuleCommand, + GetRuleGroupCommand, + GetSampledRequestsCommand, + GetSizeConstraintSetCommand, + GetSqlInjectionMatchSetCommand, + GetWebACLCommand, + GetWebACLForResourceCommand, + GetXssMatchSetCommand, + ListActivatedRulesInRuleGroupCommand, + ListByteMatchSetsCommand, + ListGeoMatchSetsCommand, + ListIPSetsCommand, + ListLoggingConfigurationsCommand, + ListRateBasedRulesCommand, + ListRegexMatchSetsCommand, + ListRegexPatternSetsCommand, + ListResourcesForWebACLCommand, + ListRuleGroupsCommand, + ListRulesCommand, + ListSizeConstraintSetsCommand, + ListSqlInjectionMatchSetsCommand, + ListSubscribedRuleGroupsCommand, + ListTagsForResourceCommand, + ListWebACLsCommand, + ListXssMatchSetsCommand, + PutLoggingConfigurationCommand, + PutPermissionPolicyCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateByteMatchSetCommand, + UpdateGeoMatchSetCommand, + UpdateIPSetCommand, + UpdateRateBasedRuleCommand, + UpdateRegexMatchSetCommand, + UpdateRegexPatternSetCommand, + UpdateRuleCommand, + UpdateRuleGroupCommand, + UpdateSizeConstraintSetCommand, + UpdateSqlInjectionMatchSetCommand, + UpdateWebACLCommand, + UpdateXssMatchSetCommand, +}; + +export interface WAFRegional { /** - * @public - * - *

This is AWS WAF Classic Regional documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Associates a web ACL with a resource, either an application load balancer or Amazon API Gateway stage.

+ * @see {@link AssociateWebACLCommand} */ - public associateWebACL( + associateWebACL( args: AssociateWebACLCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateWebACL( - args: AssociateWebACLCommandInput, - cb: (err: any, data?: AssociateWebACLCommandOutput) => void - ): void; - public associateWebACL( + associateWebACL(args: AssociateWebACLCommandInput, cb: (err: any, data?: AssociateWebACLCommandOutput) => void): void; + associateWebACL( args: AssociateWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateWebACLCommandOutput) => void ): void; - public associateWebACL( - args: AssociateWebACLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateWebACLCommandOutput) => void), - cb?: (err: any, data?: AssociateWebACLCommandOutput) => void - ): Promise | void { - const command = new AssociateWebACLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a - * web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. - * For example, you can create a ByteMatchSet that matches any requests with User-Agent headers - * that contain the string BadBot. You can then configure AWS WAF to reject those requests.

- *

To create and configure a ByteMatchSet, perform the following steps:

- *
    - *
  1. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * CreateByteMatchSet request.

    - *
  2. - *
  3. - *

    Submit a CreateByteMatchSet request.

    - *
  4. - *
  5. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateByteMatchSet request.

    - *
  6. - *
  7. - *

    Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect - * (for example, the header or the URI) and the value that you want AWS WAF to watch for.

    - *
  8. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link CreateByteMatchSetCommand} */ - public createByteMatchSet( + createByteMatchSet( args: CreateByteMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createByteMatchSet( + createByteMatchSet( args: CreateByteMatchSetCommandInput, cb: (err: any, data?: CreateByteMatchSetCommandOutput) => void ): void; - public createByteMatchSet( + createByteMatchSet( args: CreateByteMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateByteMatchSetCommandOutput) => void ): void; - public createByteMatchSet( - args: CreateByteMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateByteMatchSetCommandOutput) => void), - cb?: (err: any, data?: CreateByteMatchSetCommandOutput) => void - ): Promise | void { - const command = new CreateByteMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country - * that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an GeoMatchSet that contains those countries and then configure AWS WAF to block the requests.

- *

To create and configure a GeoMatchSet, perform the following steps:

- *
    - *
  1. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * CreateGeoMatchSet request.

    - *
  2. - *
  3. - *

    Submit a CreateGeoMatchSet request.

    - *
  4. - *
  5. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateGeoMatchSet request.

    - *
  6. - *
  7. - *

    Submit an UpdateGeoMatchSetSet request to specify the countries that you want AWS WAF to watch for.

    - *
  8. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link CreateGeoMatchSetCommand} */ - public createGeoMatchSet( + createGeoMatchSet( args: CreateGeoMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createGeoMatchSet( + createGeoMatchSet( args: CreateGeoMatchSetCommandInput, cb: (err: any, data?: CreateGeoMatchSetCommandOutput) => void ): void; - public createGeoMatchSet( + createGeoMatchSet( args: CreateGeoMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGeoMatchSetCommandOutput) => void ): void; - public createGeoMatchSet( - args: CreateGeoMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGeoMatchSetCommandOutput) => void), - cb?: (err: any, data?: CreateGeoMatchSetCommandOutput) => void - ): Promise | void { - const command = new CreateGeoMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates an IPSet, which you use to specify which web requests - * that - * you want to allow or block based on the IP addresses that the requests - * originate from. For example, if you're receiving a lot of requests from one or more - * individual IP addresses or one or more ranges of IP addresses and you want to block the - * requests, you can create an IPSet that contains those IP addresses and then - * configure AWS WAF to block the requests.

- *

To create and configure an IPSet, perform the following steps:

- *
    - *
  1. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * CreateIPSet request.

    - *
  2. - *
  3. - *

    Submit a CreateIPSet request.

    - *
  4. - *
  5. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateIPSet request.

    - *
  6. - *
  7. - *

    Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.

    - *
  8. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link CreateIPSetCommand} */ - public createIPSet(args: CreateIPSetCommandInput, options?: __HttpHandlerOptions): Promise; - public createIPSet(args: CreateIPSetCommandInput, cb: (err: any, data?: CreateIPSetCommandOutput) => void): void; - public createIPSet( + createIPSet(args: CreateIPSetCommandInput, options?: __HttpHandlerOptions): Promise; + createIPSet(args: CreateIPSetCommandInput, cb: (err: any, data?: CreateIPSetCommandOutput) => void): void; + createIPSet( args: CreateIPSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIPSetCommandOutput) => void ): void; - public createIPSet( - args: CreateIPSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIPSetCommandOutput) => void), - cb?: (err: any, data?: CreateIPSetCommandOutput) => void - ): Promise | void { - const command = new CreateIPSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates a RateBasedRule. The RateBasedRule contains a - * RateLimit, which specifies the maximum number of requests that AWS WAF allows - * from a specified IP address in a five-minute period. - * The RateBasedRule also - * contains the IPSet objects, ByteMatchSet objects, and other - * predicates that identify the requests that you want to count or block if these requests - * exceed the RateLimit.

- *

If you add more than one predicate to a RateBasedRule, a request not - * only must exceed the RateLimit, but it also must match all the - * conditions to be counted or blocked. For example, suppose you add the following to a - * RateBasedRule:

- *
    - *
  • - *

    An IPSet that matches the IP address 192.0.2.44/32 - *

    - *
  • - *
  • - *

    A ByteMatchSet that matches BadBot in the - * User-Agent header

    - *
  • - *
- *

Further, you specify a RateLimit of 1,000.

- *

You then add the RateBasedRule to a WebACL and specify that - * you want to block requests that meet the conditions in the rule. For a request to be - * blocked, it must come from the IP address 192.0.2.44 and the - * User-Agent header in the request must contain the value - * BadBot. Further, requests that match these two conditions must be received at - * a rate of more than 1,000 requests every five minutes. If both conditions are met and the - * rate is exceeded, AWS WAF blocks the requests. If the rate drops below 1,000 for a - * five-minute period, AWS WAF no longer blocks the requests.

- * - *

As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a - * RateBasedRule:

- * - * - *
    - *
  • - *

    A ByteMatchSet with FieldToMatch of URI - *

    - *
  • - *
  • - *

    A PositionalConstraint of STARTS_WITH - *

    - *
  • - *
  • - *

    A TargetString of login - *

    - *
  • - *
- *

Further, you specify a RateLimit of 1,000.

- *

By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site.

- * - * - *

To create and configure a RateBasedRule, perform the following - * steps:

- *
    - *
  1. - *

    Create and update the predicates that you want to include in the rule. For more - * information, see CreateByteMatchSet, CreateIPSet, - * and CreateSqlInjectionMatchSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide - * in the ChangeToken parameter of a CreateRule - * request.

    - *
  4. - *
  5. - *

    Submit a CreateRateBasedRule request.

    - *
  6. - *
  7. - *

    Use GetChangeToken to get the change token that you provide in the - * ChangeToken parameter of an UpdateRule - * request.

    - *
  8. - *
  9. - *

    Submit an UpdateRateBasedRule request to specify the predicates - * that you want to include in the rule.

    - *
  10. - *
  11. - *

    Create and update a WebACL that contains the - * RateBasedRule. For more information, see CreateWebACL.

    - *
  12. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, - * see the AWS WAF Developer - * Guide.

+ * @see {@link CreateRateBasedRuleCommand} */ - public createRateBasedRule( + createRateBasedRule( args: CreateRateBasedRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRateBasedRule( + createRateBasedRule( args: CreateRateBasedRuleCommandInput, cb: (err: any, data?: CreateRateBasedRuleCommandOutput) => void ): void; - public createRateBasedRule( + createRateBasedRule( args: CreateRateBasedRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRateBasedRuleCommandOutput) => void ): void; - public createRateBasedRule( - args: CreateRateBasedRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRateBasedRuleCommandOutput) => void), - cb?: (err: any, data?: CreateRateBasedRuleCommandOutput) => void - ): Promise | void { - const command = new CreateRateBasedRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a - * web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. - * For example, you can create a RegexMatchSet that contains a RegexMatchTuple that looks for any requests with User-Agent headers - * that match a RegexPatternSet with pattern B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

- *

To create and configure a RegexMatchSet, perform the following steps:

- *
    - *
  1. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * CreateRegexMatchSet request.

    - *
  2. - *
  3. - *

    Submit a CreateRegexMatchSet request.

    - *
  4. - *
  5. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateRegexMatchSet request.

    - *
  6. - *
  7. - *

    Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect - * (for example, the header or the URI) and the value, using a RegexPatternSet, that you want AWS WAF to watch for.

    - *
  8. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link CreateRegexMatchSetCommand} */ - public createRegexMatchSet( + createRegexMatchSet( args: CreateRegexMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRegexMatchSet( + createRegexMatchSet( args: CreateRegexMatchSetCommandInput, cb: (err: any, data?: CreateRegexMatchSetCommandOutput) => void ): void; - public createRegexMatchSet( + createRegexMatchSet( args: CreateRegexMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRegexMatchSetCommandOutput) => void ): void; - public createRegexMatchSet( - args: CreateRegexMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRegexMatchSetCommandOutput) => void), - cb?: (err: any, data?: CreateRegexMatchSetCommandOutput) => void - ): Promise | void { - const command = new CreateRegexMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates a RegexPatternSet. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

- *

To create and configure a RegexPatternSet, perform the following steps:

- *
    - *
  1. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * CreateRegexPatternSet request.

    - *
  2. - *
  3. - *

    Submit a CreateRegexPatternSet request.

    - *
  4. - *
  5. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateRegexPatternSet request.

    - *
  6. - *
  7. - *

    Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for.

    - *
  8. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link CreateRegexPatternSetCommand} */ - public createRegexPatternSet( + createRegexPatternSet( args: CreateRegexPatternSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRegexPatternSet( + createRegexPatternSet( args: CreateRegexPatternSetCommandInput, cb: (err: any, data?: CreateRegexPatternSetCommandOutput) => void ): void; - public createRegexPatternSet( + createRegexPatternSet( args: CreateRegexPatternSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRegexPatternSetCommandOutput) => void ): void; - public createRegexPatternSet( - args: CreateRegexPatternSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRegexPatternSetCommandOutput) => void), - cb?: (err: any, data?: CreateRegexPatternSetCommandOutput) => void - ): Promise | void { - const command = new CreateRegexPatternSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates a Rule, which contains the IPSet objects, - * ByteMatchSet objects, and other predicates that identify the requests that - * you want to block. If you add more than one predicate to a Rule, a request - * must match all of the specifications to be allowed or blocked. For example, suppose - * that - * you add the following to a Rule:

- *
    - *
  • - *

    An IPSet that matches the IP address 192.0.2.44/32 - *

    - *
  • - *
  • - *

    A ByteMatchSet that matches BadBot in the User-Agent header

    - *
  • - *
- *

You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. - * For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request - * must contain the value BadBot.

- *

To create and configure a Rule, perform the following steps:

- *
    - *
  1. - *

    Create and update the predicates that you want to include in the Rule. For more information, see - * CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * CreateRule request.

    - *
  4. - *
  5. - *

    Submit a CreateRule request.

    - *
  6. - *
  7. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateRule request.

    - *
  8. - *
  9. - *

    Submit an UpdateRule request to specify the predicates that you want to include in the Rule.

    - *
  10. - *
  11. - *

    Create and update a WebACL that contains the Rule. For more information, see CreateWebACL.

    - *
  12. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link CreateRuleCommand} */ - public createRule(args: CreateRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public createRule(args: CreateRuleCommandInput, cb: (err: any, data?: CreateRuleCommandOutput) => void): void; - public createRule( + createRule(args: CreateRuleCommandInput, options?: __HttpHandlerOptions): Promise; + createRule(args: CreateRuleCommandInput, cb: (err: any, data?: CreateRuleCommandOutput) => void): void; + createRule( args: CreateRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRuleCommandOutput) => void ): void; - public createRule( - args: CreateRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRuleCommandOutput) => void), - cb?: (err: any, data?: CreateRuleCommandOutput) => void - ): Promise | void { - const command = new CreateRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates a RuleGroup. A rule group is a collection of predefined rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group.

- *

Rule groups are subject to the following limits:

- *
    - *
  • - *

    Three rule groups per account. You can request an increase to this limit by contacting customer support.

    - *
  • - *
  • - *

    One rule group per web ACL.

    - *
  • - *
  • - *

    Ten rules per rule group.

    - *
  • - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link CreateRuleGroupCommand} */ - public createRuleGroup( + createRuleGroup( args: CreateRuleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRuleGroup( - args: CreateRuleGroupCommandInput, - cb: (err: any, data?: CreateRuleGroupCommandOutput) => void - ): void; - public createRuleGroup( + createRuleGroup(args: CreateRuleGroupCommandInput, cb: (err: any, data?: CreateRuleGroupCommandOutput) => void): void; + createRuleGroup( args: CreateRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRuleGroupCommandOutput) => void ): void; - public createRuleGroup( - args: CreateRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRuleGroupCommandOutput) => void), - cb?: (err: any, data?: CreateRuleGroupCommandOutput) => void - ): Promise | void { - const command = new CreateRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a - * web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. - * For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. - * You can then configure AWS WAF to reject those requests.

- *

To create and configure a SizeConstraintSet, perform the following steps:

- *
    - *
  1. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * CreateSizeConstraintSet request.

    - *
  2. - *
  3. - *

    Submit a CreateSizeConstraintSet request.

    - *
  4. - *
  5. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateSizeConstraintSet request.

    - *
  6. - *
  7. - *

    Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect - * (for example, the header or the URI) and the value that you want AWS WAF to watch for.

    - *
  8. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link CreateSizeConstraintSetCommand} */ - public createSizeConstraintSet( + createSizeConstraintSet( args: CreateSizeConstraintSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSizeConstraintSet( + createSizeConstraintSet( args: CreateSizeConstraintSetCommandInput, cb: (err: any, data?: CreateSizeConstraintSetCommandOutput) => void ): void; - public createSizeConstraintSet( + createSizeConstraintSet( args: CreateSizeConstraintSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSizeConstraintSetCommandOutput) => void ): void; - public createSizeConstraintSet( - args: CreateSizeConstraintSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSizeConstraintSetCommandOutput) => void), - cb?: (err: any, data?: CreateSizeConstraintSetCommandOutput) => void - ): Promise | void { - const command = new CreateSizeConstraintSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a - * specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

- *

To create and configure a SqlInjectionMatchSet, perform the following steps:

- *
    - *
  1. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * CreateSqlInjectionMatchSet request.

    - *
  2. - *
  3. - *

    Submit a CreateSqlInjectionMatchSet request.

    - *
  4. - *
  5. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateSqlInjectionMatchSet request.

    - *
  6. - *
  7. - *

    Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to - * allow, block, or count malicious SQL code.

    - *
  8. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link CreateSqlInjectionMatchSetCommand} */ - public createSqlInjectionMatchSet( + createSqlInjectionMatchSet( args: CreateSqlInjectionMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSqlInjectionMatchSet( + createSqlInjectionMatchSet( args: CreateSqlInjectionMatchSetCommandInput, cb: (err: any, data?: CreateSqlInjectionMatchSetCommandOutput) => void ): void; - public createSqlInjectionMatchSet( + createSqlInjectionMatchSet( args: CreateSqlInjectionMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSqlInjectionMatchSetCommandOutput) => void ): void; - public createSqlInjectionMatchSet( - args: CreateSqlInjectionMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSqlInjectionMatchSetCommandOutput) => void), - cb?: (err: any, data?: CreateSqlInjectionMatchSetCommandOutput) => void - ): Promise | void { - const command = new CreateSqlInjectionMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count. - * AWS WAF evaluates Rules in order based on the value of Priority for each Rule.

- *

You also specify a default action, either ALLOW or BLOCK. If a web request doesn't match - * any of the Rules in a WebACL, AWS WAF responds to the request with the default action.

- *

To create and configure a WebACL, perform the following steps:

- *
    - *
  1. - *

    Create and update the ByteMatchSet objects and other predicates that you want to include in Rules. - * For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, - * CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.

    - *
  2. - *
  3. - *

    Create and update the Rules that you want to include in the WebACL. For more information, see - * CreateRule and UpdateRule.

    - *
  4. - *
  5. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * CreateWebACL request.

    - *
  6. - *
  7. - *

    Submit a CreateWebACL request.

    - *
  8. - *
  9. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateWebACL request.

    - *
  10. - *
  11. - *

    Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, - * to specify the default action, and to associate the WebACL with a CloudFront distribution.

    - *
  12. - *
- *

For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.

+ * @see {@link CreateWebACLCommand} */ - public createWebACL( - args: CreateWebACLCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createWebACL(args: CreateWebACLCommandInput, cb: (err: any, data?: CreateWebACLCommandOutput) => void): void; - public createWebACL( + createWebACL(args: CreateWebACLCommandInput, options?: __HttpHandlerOptions): Promise; + createWebACL(args: CreateWebACLCommandInput, cb: (err: any, data?: CreateWebACLCommandOutput) => void): void; + createWebACL( args: CreateWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWebACLCommandOutput) => void ): void; - public createWebACL( - args: CreateWebACLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWebACLCommandOutput) => void), - cb?: (err: any, data?: CreateWebACLCommandOutput) => void - ): Promise | void { - const command = new CreateWebACLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the specified Amazon S3 bucket. - * Then, in CloudFormation, you create a stack from the template, to create the web ACL and its resources in AWS WAFV2. - * Use this to migrate your AWS WAF Classic web ACL to the latest version of AWS WAF.

- *

This is part of a larger migration procedure for web ACLs from AWS WAF Classic to the latest version of AWS WAF. - * For the full procedure, including caveats and manual steps to complete - * the migration and switch over to the new web ACL, see - * Migrating your AWS WAF Classic resources to AWS WAF in the AWS WAF - * Developer Guide.

+ * @see {@link CreateWebACLMigrationStackCommand} */ - public createWebACLMigrationStack( + createWebACLMigrationStack( args: CreateWebACLMigrationStackCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWebACLMigrationStack( + createWebACLMigrationStack( args: CreateWebACLMigrationStackCommandInput, cb: (err: any, data?: CreateWebACLMigrationStackCommandOutput) => void ): void; - public createWebACLMigrationStack( + createWebACLMigrationStack( args: CreateWebACLMigrationStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWebACLMigrationStackCommandOutput) => void ): void; - public createWebACLMigrationStack( - args: CreateWebACLMigrationStackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWebACLMigrationStackCommandOutput) => void), - cb?: (err: any, data?: CreateWebACLMigrationStackCommandOutput) => void - ): Promise | void { - const command = new CreateWebACLMigrationStackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks - * in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

- *

To create and configure an XssMatchSet, perform the following steps:

- *
    - *
  1. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * CreateXssMatchSet request.

    - *
  2. - *
  3. - *

    Submit a CreateXssMatchSet request.

    - *
  4. - *
  5. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateXssMatchSet request.

    - *
  6. - *
  7. - *

    Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to - * allow, block, or count cross-site scripting attacks.

    - *
  8. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link CreateXssMatchSetCommand} */ - public createXssMatchSet( + createXssMatchSet( args: CreateXssMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createXssMatchSet( + createXssMatchSet( args: CreateXssMatchSetCommandInput, cb: (err: any, data?: CreateXssMatchSetCommandOutput) => void ): void; - public createXssMatchSet( + createXssMatchSet( args: CreateXssMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateXssMatchSetCommandOutput) => void ): void; - public createXssMatchSet( - args: CreateXssMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateXssMatchSetCommandOutput) => void), - cb?: (err: any, data?: CreateXssMatchSetCommandOutput) => void - ): Promise | void { - const command = new CreateXssMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules - * or if it still includes any ByteMatchTuple objects (any filters).

- *

If you just want to remove a ByteMatchSet from a Rule, use UpdateRule.

- *

To permanently delete a ByteMatchSet, perform the following steps:

- *
    - *
  1. - *

    Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * DeleteByteMatchSet request.

    - *
  4. - *
  5. - *

    Submit a DeleteByteMatchSet request.

    - *
  6. - *
+ * @see {@link DeleteByteMatchSetCommand} */ - public deleteByteMatchSet( + deleteByteMatchSet( args: DeleteByteMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteByteMatchSet( + deleteByteMatchSet( args: DeleteByteMatchSetCommandInput, cb: (err: any, data?: DeleteByteMatchSetCommandOutput) => void ): void; - public deleteByteMatchSet( + deleteByteMatchSet( args: DeleteByteMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteByteMatchSetCommandOutput) => void ): void; - public deleteByteMatchSet( - args: DeleteByteMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteByteMatchSetCommandOutput) => void), - cb?: (err: any, data?: DeleteByteMatchSetCommandOutput) => void - ): Promise | void { - const command = new DeleteByteMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes a GeoMatchSet. You can't delete a GeoMatchSet if it's still used in any Rules or - * if it still includes any countries.

- *

If you just want to remove a GeoMatchSet from a Rule, use UpdateRule.

- *

To permanently delete a GeoMatchSet from AWS WAF, perform the following steps:

- *
    - *
  1. - *

    Update the GeoMatchSet to remove any countries. For more information, see UpdateGeoMatchSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * DeleteGeoMatchSet request.

    - *
  4. - *
  5. - *

    Submit a DeleteGeoMatchSet request.

    - *
  6. - *
+ * @see {@link DeleteGeoMatchSetCommand} */ - public deleteGeoMatchSet( + deleteGeoMatchSet( args: DeleteGeoMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteGeoMatchSet( + deleteGeoMatchSet( args: DeleteGeoMatchSetCommandInput, cb: (err: any, data?: DeleteGeoMatchSetCommandOutput) => void ): void; - public deleteGeoMatchSet( + deleteGeoMatchSet( args: DeleteGeoMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGeoMatchSetCommandOutput) => void ): void; - public deleteGeoMatchSet( - args: DeleteGeoMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGeoMatchSetCommandOutput) => void), - cb?: (err: any, data?: DeleteGeoMatchSetCommandOutput) => void - ): Promise | void { - const command = new DeleteGeoMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes an IPSet. You can't delete an IPSet if it's still used in any Rules or - * if it still includes any IP addresses.

- *

If you just want to remove an IPSet from a Rule, use UpdateRule.

- *

To permanently delete an IPSet from AWS WAF, perform the following steps:

- *
    - *
  1. - *

    Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * DeleteIPSet request.

    - *
  4. - *
  5. - *

    Submit a DeleteIPSet request.

    - *
  6. - *
+ * @see {@link DeleteIPSetCommand} */ - public deleteIPSet(args: DeleteIPSetCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteIPSet(args: DeleteIPSetCommandInput, cb: (err: any, data?: DeleteIPSetCommandOutput) => void): void; - public deleteIPSet( + deleteIPSet(args: DeleteIPSetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteIPSet(args: DeleteIPSetCommandInput, cb: (err: any, data?: DeleteIPSetCommandOutput) => void): void; + deleteIPSet( args: DeleteIPSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIPSetCommandOutput) => void ): void; - public deleteIPSet( - args: DeleteIPSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIPSetCommandOutput) => void), - cb?: (err: any, data?: DeleteIPSetCommandOutput) => void - ): Promise | void { - const command = new DeleteIPSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes the LoggingConfiguration from the specified web - * ACL.

+ * @see {@link DeleteLoggingConfigurationCommand} */ - public deleteLoggingConfiguration( + deleteLoggingConfiguration( args: DeleteLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLoggingConfiguration( + deleteLoggingConfiguration( args: DeleteLoggingConfigurationCommandInput, cb: (err: any, data?: DeleteLoggingConfigurationCommandOutput) => void ): void; - public deleteLoggingConfiguration( + deleteLoggingConfiguration( args: DeleteLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLoggingConfigurationCommandOutput) => void ): void; - public deleteLoggingConfiguration( - args: DeleteLoggingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes an IAM policy from the specified RuleGroup.

- *

The user making the request must be the owner of the RuleGroup.

+ * @see {@link DeletePermissionPolicyCommand} */ - public deletePermissionPolicy( + deletePermissionPolicy( args: DeletePermissionPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePermissionPolicy( + deletePermissionPolicy( args: DeletePermissionPolicyCommandInput, cb: (err: any, data?: DeletePermissionPolicyCommandOutput) => void ): void; - public deletePermissionPolicy( + deletePermissionPolicy( args: DeletePermissionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePermissionPolicyCommandOutput) => void ): void; - public deletePermissionPolicy( - args: DeletePermissionPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePermissionPolicyCommandOutput) => void), - cb?: (err: any, data?: DeletePermissionPolicyCommandOutput) => void - ): Promise | void { - const command = new DeletePermissionPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes a RateBasedRule. You can't delete a rule if - * it's still used in any WebACL objects or if it still includes any predicates, - * such as ByteMatchSet objects.

- *

If you just want to remove a rule from a WebACL, use UpdateWebACL.

- *

To permanently delete a RateBasedRule from AWS WAF, perform the following - * steps:

- *
    - *
  1. - *

    Update the RateBasedRule to remove predicates, if any. For more - * information, see UpdateRateBasedRule.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide - * in the ChangeToken parameter of a DeleteRateBasedRule - * request.

    - *
  4. - *
  5. - *

    Submit a DeleteRateBasedRule request.

    - *
  6. - *
+ * @see {@link DeleteRateBasedRuleCommand} */ - public deleteRateBasedRule( + deleteRateBasedRule( args: DeleteRateBasedRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRateBasedRule( + deleteRateBasedRule( args: DeleteRateBasedRuleCommandInput, cb: (err: any, data?: DeleteRateBasedRuleCommandOutput) => void ): void; - public deleteRateBasedRule( + deleteRateBasedRule( args: DeleteRateBasedRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRateBasedRuleCommandOutput) => void ): void; - public deleteRateBasedRule( - args: DeleteRateBasedRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRateBasedRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteRateBasedRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteRateBasedRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes a RegexMatchSet. You can't delete a RegexMatchSet if it's still used in any Rules - * or if it still includes any RegexMatchTuples objects (any filters).

- *

If you just want to remove a RegexMatchSet from a Rule, use UpdateRule.

- *

To permanently delete a RegexMatchSet, perform the following steps:

- *
    - *
  1. - *

    Update the RegexMatchSet to remove filters, if any. For more information, see UpdateRegexMatchSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * DeleteRegexMatchSet request.

    - *
  4. - *
  5. - *

    Submit a DeleteRegexMatchSet request.

    - *
  6. - *
+ * @see {@link DeleteRegexMatchSetCommand} */ - public deleteRegexMatchSet( + deleteRegexMatchSet( args: DeleteRegexMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRegexMatchSet( + deleteRegexMatchSet( args: DeleteRegexMatchSetCommandInput, cb: (err: any, data?: DeleteRegexMatchSetCommandOutput) => void ): void; - public deleteRegexMatchSet( + deleteRegexMatchSet( args: DeleteRegexMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRegexMatchSetCommandOutput) => void ): void; - public deleteRegexMatchSet( - args: DeleteRegexMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRegexMatchSetCommandOutput) => void), - cb?: (err: any, data?: DeleteRegexMatchSetCommandOutput) => void - ): Promise | void { - const command = new DeleteRegexMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes a RegexPatternSet. You can't delete a RegexPatternSet if it's still used in any RegexMatchSet - * or if the RegexPatternSet is not empty.

+ * @see {@link DeleteRegexPatternSetCommand} */ - public deleteRegexPatternSet( + deleteRegexPatternSet( args: DeleteRegexPatternSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRegexPatternSet( + deleteRegexPatternSet( args: DeleteRegexPatternSetCommandInput, cb: (err: any, data?: DeleteRegexPatternSetCommandOutput) => void ): void; - public deleteRegexPatternSet( + deleteRegexPatternSet( args: DeleteRegexPatternSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRegexPatternSetCommandOutput) => void ): void; - public deleteRegexPatternSet( - args: DeleteRegexPatternSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRegexPatternSetCommandOutput) => void), - cb?: (err: any, data?: DeleteRegexPatternSetCommandOutput) => void - ): Promise | void { - const command = new DeleteRegexPatternSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL - * objects or if it still includes any predicates, such as ByteMatchSet objects.

- *

If you just want to remove a Rule from a WebACL, use UpdateWebACL.

- *

To permanently delete a Rule from AWS WAF, perform the following steps:

- *
    - *
  1. - *

    Update the Rule to remove predicates, if any. For more information, see UpdateRule.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * DeleteRule request.

    - *
  4. - *
  5. - *

    Submit a DeleteRule request.

    - *
  6. - *
+ * @see {@link DeleteRuleCommand} */ - public deleteRule(args: DeleteRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteRule(args: DeleteRuleCommandInput, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void; - public deleteRule( + deleteRule(args: DeleteRuleCommandInput, options?: __HttpHandlerOptions): Promise; + deleteRule(args: DeleteRuleCommandInput, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void; + deleteRule( args: DeleteRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRuleCommandOutput) => void ): void; - public deleteRule( - args: DeleteRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes a RuleGroup. You can't delete a RuleGroup if it's still used in any WebACL - * objects or if it still includes any rules.

- *

If you just want to remove a RuleGroup from a WebACL, use UpdateWebACL.

- *

To permanently delete a RuleGroup from AWS WAF, perform the following steps:

- *
    - *
  1. - *

    Update the RuleGroup to remove rules, if any. For more information, see UpdateRuleGroup.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * DeleteRuleGroup request.

    - *
  4. - *
  5. - *

    Submit a DeleteRuleGroup request.

    - *
  6. - *
+ * @see {@link DeleteRuleGroupCommand} */ - public deleteRuleGroup( + deleteRuleGroup( args: DeleteRuleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRuleGroup( - args: DeleteRuleGroupCommandInput, - cb: (err: any, data?: DeleteRuleGroupCommandOutput) => void - ): void; - public deleteRuleGroup( + deleteRuleGroup(args: DeleteRuleGroupCommandInput, cb: (err: any, data?: DeleteRuleGroupCommandOutput) => void): void; + deleteRuleGroup( args: DeleteRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRuleGroupCommandOutput) => void ): void; - public deleteRuleGroup( - args: DeleteRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRuleGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteRuleGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules - * or if it still includes any SizeConstraint objects (any filters).

- *

If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule.

- *

To permanently delete a SizeConstraintSet, perform the following steps:

- *
    - *
  1. - *

    Update the SizeConstraintSet to remove filters, if any. For more information, see UpdateSizeConstraintSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * DeleteSizeConstraintSet request.

    - *
  4. - *
  5. - *

    Submit a DeleteSizeConstraintSet request.

    - *
  6. - *
+ * @see {@link DeleteSizeConstraintSetCommand} */ - public deleteSizeConstraintSet( + deleteSizeConstraintSet( args: DeleteSizeConstraintSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSizeConstraintSet( + deleteSizeConstraintSet( args: DeleteSizeConstraintSetCommandInput, cb: (err: any, data?: DeleteSizeConstraintSetCommandOutput) => void ): void; - public deleteSizeConstraintSet( + deleteSizeConstraintSet( args: DeleteSizeConstraintSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSizeConstraintSetCommandOutput) => void ): void; - public deleteSizeConstraintSet( - args: DeleteSizeConstraintSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSizeConstraintSetCommandOutput) => void), - cb?: (err: any, data?: DeleteSizeConstraintSetCommandOutput) => void - ): Promise | void { - const command = new DeleteSizeConstraintSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet if it's - * still used in any Rules or if it still contains any SqlInjectionMatchTuple objects.

- *

If you just want to remove a SqlInjectionMatchSet from a Rule, use UpdateRule.

- *

To permanently delete a SqlInjectionMatchSet from AWS WAF, perform the following steps:

- *
    - *
  1. - *

    Update the SqlInjectionMatchSet to remove filters, if any. For more information, see - * UpdateSqlInjectionMatchSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * DeleteSqlInjectionMatchSet request.

    - *
  4. - *
  5. - *

    Submit a DeleteSqlInjectionMatchSet request.

    - *
  6. - *
+ * @see {@link DeleteSqlInjectionMatchSetCommand} */ - public deleteSqlInjectionMatchSet( + deleteSqlInjectionMatchSet( args: DeleteSqlInjectionMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSqlInjectionMatchSet( + deleteSqlInjectionMatchSet( args: DeleteSqlInjectionMatchSetCommandInput, cb: (err: any, data?: DeleteSqlInjectionMatchSetCommandOutput) => void ): void; - public deleteSqlInjectionMatchSet( + deleteSqlInjectionMatchSet( args: DeleteSqlInjectionMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSqlInjectionMatchSetCommandOutput) => void ): void; - public deleteSqlInjectionMatchSet( - args: DeleteSqlInjectionMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSqlInjectionMatchSetCommandOutput) => void), - cb?: (err: any, data?: DeleteSqlInjectionMatchSetCommandOutput) => void - ): Promise | void { - const command = new DeleteSqlInjectionMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules.

- *

To delete a WebACL, perform the following steps:

- *
    - *
  1. - *

    Update the WebACL to remove Rules, if any. For more information, see UpdateWebACL.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * DeleteWebACL request.

    - *
  4. - *
  5. - *

    Submit a DeleteWebACL request.

    - *
  6. - *
+ * @see {@link DeleteWebACLCommand} */ - public deleteWebACL( - args: DeleteWebACLCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteWebACL(args: DeleteWebACLCommandInput, cb: (err: any, data?: DeleteWebACLCommandOutput) => void): void; - public deleteWebACL( + deleteWebACL(args: DeleteWebACLCommandInput, options?: __HttpHandlerOptions): Promise; + deleteWebACL(args: DeleteWebACLCommandInput, cb: (err: any, data?: DeleteWebACLCommandOutput) => void): void; + deleteWebACL( args: DeleteWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWebACLCommandOutput) => void ): void; - public deleteWebACL( - args: DeleteWebACLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWebACLCommandOutput) => void), - cb?: (err: any, data?: DeleteWebACLCommandOutput) => void - ): Promise | void { - const command = new DeleteWebACLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes an XssMatchSet. You can't delete an XssMatchSet if it's - * still used in any Rules or if it still contains any XssMatchTuple objects.

- *

If you just want to remove an XssMatchSet from a Rule, use UpdateRule.

- *

To permanently delete an XssMatchSet from AWS WAF, perform the following steps:

- *
    - *
  1. - *

    Update the XssMatchSet to remove filters, if any. For more information, see - * UpdateXssMatchSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * DeleteXssMatchSet request.

    - *
  4. - *
  5. - *

    Submit a DeleteXssMatchSet request.

    - *
  6. - *
+ * @see {@link DeleteXssMatchSetCommand} */ - public deleteXssMatchSet( + deleteXssMatchSet( args: DeleteXssMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteXssMatchSet( + deleteXssMatchSet( args: DeleteXssMatchSetCommandInput, cb: (err: any, data?: DeleteXssMatchSetCommandOutput) => void ): void; - public deleteXssMatchSet( + deleteXssMatchSet( args: DeleteXssMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteXssMatchSetCommandOutput) => void ): void; - public deleteXssMatchSet( - args: DeleteXssMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteXssMatchSetCommandOutput) => void), - cb?: (err: any, data?: DeleteXssMatchSetCommandOutput) => void - ): Promise | void { - const command = new DeleteXssMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic Regional documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Removes a web ACL from the specified resource, either an application load balancer or Amazon API Gateway stage.

+ * @see {@link DisassociateWebACLCommand} */ - public disassociateWebACL( + disassociateWebACL( args: DisassociateWebACLCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateWebACL( + disassociateWebACL( args: DisassociateWebACLCommandInput, cb: (err: any, data?: DisassociateWebACLCommandOutput) => void ): void; - public disassociateWebACL( + disassociateWebACL( args: DisassociateWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateWebACLCommandOutput) => void ): void; - public disassociateWebACL( - args: DisassociateWebACLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateWebACLCommandOutput) => void), - cb?: (err: any, data?: DisassociateWebACLCommandOutput) => void - ): Promise | void { - const command = new DisassociateWebACLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the ByteMatchSet specified by ByteMatchSetId.

+ * @see {@link GetByteMatchSetCommand} */ - public getByteMatchSet( + getByteMatchSet( args: GetByteMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getByteMatchSet( - args: GetByteMatchSetCommandInput, - cb: (err: any, data?: GetByteMatchSetCommandOutput) => void - ): void; - public getByteMatchSet( + getByteMatchSet(args: GetByteMatchSetCommandInput, cb: (err: any, data?: GetByteMatchSetCommandOutput) => void): void; + getByteMatchSet( args: GetByteMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetByteMatchSetCommandOutput) => void ): void; - public getByteMatchSet( - args: GetByteMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetByteMatchSetCommandOutput) => void), - cb?: (err: any, data?: GetByteMatchSetCommandOutput) => void - ): Promise | void { - const command = new GetByteMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.

- *

Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request - * and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second - * GetChangeToken request returns the same value as the first GetChangeToken request.

- *

When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, - * which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the - * status of your change token.

+ * @see {@link GetChangeTokenCommand} */ - public getChangeToken( + getChangeToken( args: GetChangeTokenCommandInput, options?: __HttpHandlerOptions ): Promise; - public getChangeToken( - args: GetChangeTokenCommandInput, - cb: (err: any, data?: GetChangeTokenCommandOutput) => void - ): void; - public getChangeToken( + getChangeToken(args: GetChangeTokenCommandInput, cb: (err: any, data?: GetChangeTokenCommandOutput) => void): void; + getChangeToken( args: GetChangeTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChangeTokenCommandOutput) => void ): void; - public getChangeToken( - args: GetChangeTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetChangeTokenCommandOutput) => void), - cb?: (err: any, data?: GetChangeTokenCommandOutput) => void - ): Promise | void { - const command = new GetChangeTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is - * one of the following values:

- *
    - *
  • - *

    - * PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet - * in a call to create, update, or delete an AWS WAF object.

    - *
  • - *
  • - *

    - * PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers.

    - *
  • - *
  • - *

    - * INSYNC: Propagation is complete.

    - *
  • - *
+ * @see {@link GetChangeTokenStatusCommand} */ - public getChangeTokenStatus( + getChangeTokenStatus( args: GetChangeTokenStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getChangeTokenStatus( + getChangeTokenStatus( args: GetChangeTokenStatusCommandInput, cb: (err: any, data?: GetChangeTokenStatusCommandOutput) => void ): void; - public getChangeTokenStatus( + getChangeTokenStatus( args: GetChangeTokenStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChangeTokenStatusCommandOutput) => void ): void; - public getChangeTokenStatus( - args: GetChangeTokenStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetChangeTokenStatusCommandOutput) => void), - cb?: (err: any, data?: GetChangeTokenStatusCommandOutput) => void - ): Promise | void { - const command = new GetChangeTokenStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the GeoMatchSet that is specified by GeoMatchSetId.

+ * @see {@link GetGeoMatchSetCommand} */ - public getGeoMatchSet( + getGeoMatchSet( args: GetGeoMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getGeoMatchSet( - args: GetGeoMatchSetCommandInput, - cb: (err: any, data?: GetGeoMatchSetCommandOutput) => void - ): void; - public getGeoMatchSet( + getGeoMatchSet(args: GetGeoMatchSetCommandInput, cb: (err: any, data?: GetGeoMatchSetCommandOutput) => void): void; + getGeoMatchSet( args: GetGeoMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGeoMatchSetCommandOutput) => void ): void; - public getGeoMatchSet( - args: GetGeoMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGeoMatchSetCommandOutput) => void), - cb?: (err: any, data?: GetGeoMatchSetCommandOutput) => void - ): Promise | void { - const command = new GetGeoMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the IPSet that is specified by IPSetId.

+ * @see {@link GetIPSetCommand} */ - public getIPSet(args: GetIPSetCommandInput, options?: __HttpHandlerOptions): Promise; - public getIPSet(args: GetIPSetCommandInput, cb: (err: any, data?: GetIPSetCommandOutput) => void): void; - public getIPSet( + getIPSet(args: GetIPSetCommandInput, options?: __HttpHandlerOptions): Promise; + getIPSet(args: GetIPSetCommandInput, cb: (err: any, data?: GetIPSetCommandOutput) => void): void; + getIPSet( args: GetIPSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIPSetCommandOutput) => void ): void; - public getIPSet( - args: GetIPSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIPSetCommandOutput) => void), - cb?: (err: any, data?: GetIPSetCommandOutput) => void - ): Promise | void { - const command = new GetIPSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the LoggingConfiguration for the specified web ACL.

+ * @see {@link GetLoggingConfigurationCommand} */ - public getLoggingConfiguration( + getLoggingConfiguration( args: GetLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLoggingConfiguration( + getLoggingConfiguration( args: GetLoggingConfigurationCommandInput, cb: (err: any, data?: GetLoggingConfigurationCommandOutput) => void ): void; - public getLoggingConfiguration( + getLoggingConfiguration( args: GetLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLoggingConfigurationCommandOutput) => void ): void; - public getLoggingConfiguration( - args: GetLoggingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the IAM policy attached to the RuleGroup.

+ * @see {@link GetPermissionPolicyCommand} */ - public getPermissionPolicy( + getPermissionPolicy( args: GetPermissionPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPermissionPolicy( + getPermissionPolicy( args: GetPermissionPolicyCommandInput, cb: (err: any, data?: GetPermissionPolicyCommandOutput) => void ): void; - public getPermissionPolicy( + getPermissionPolicy( args: GetPermissionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPermissionPolicyCommandOutput) => void ): void; - public getPermissionPolicy( - args: GetPermissionPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPermissionPolicyCommandOutput) => void), - cb?: (err: any, data?: GetPermissionPolicyCommandOutput) => void - ): Promise | void { - const command = new GetPermissionPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the RateBasedRule that is specified by the - * RuleId that you included in the GetRateBasedRule - * request.

+ * @see {@link GetRateBasedRuleCommand} */ - public getRateBasedRule( + getRateBasedRule( args: GetRateBasedRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRateBasedRule( + getRateBasedRule( args: GetRateBasedRuleCommandInput, cb: (err: any, data?: GetRateBasedRuleCommandOutput) => void ): void; - public getRateBasedRule( + getRateBasedRule( args: GetRateBasedRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRateBasedRuleCommandOutput) => void ): void; - public getRateBasedRule( - args: GetRateBasedRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRateBasedRuleCommandOutput) => void), - cb?: (err: any, data?: GetRateBasedRuleCommandOutput) => void - ): Promise | void { - const command = new GetRateBasedRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the RuleId. The maximum - * number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed - * the rate limit, the 10,000 addresses with the highest rates will be blocked.

+ * @see {@link GetRateBasedRuleManagedKeysCommand} */ - public getRateBasedRuleManagedKeys( + getRateBasedRuleManagedKeys( args: GetRateBasedRuleManagedKeysCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRateBasedRuleManagedKeys( + getRateBasedRuleManagedKeys( args: GetRateBasedRuleManagedKeysCommandInput, cb: (err: any, data?: GetRateBasedRuleManagedKeysCommandOutput) => void ): void; - public getRateBasedRuleManagedKeys( + getRateBasedRuleManagedKeys( args: GetRateBasedRuleManagedKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRateBasedRuleManagedKeysCommandOutput) => void ): void; - public getRateBasedRuleManagedKeys( - args: GetRateBasedRuleManagedKeysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRateBasedRuleManagedKeysCommandOutput) => void), - cb?: (err: any, data?: GetRateBasedRuleManagedKeysCommandOutput) => void - ): Promise | void { - const command = new GetRateBasedRuleManagedKeysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the RegexMatchSet specified by RegexMatchSetId.

+ * @see {@link GetRegexMatchSetCommand} */ - public getRegexMatchSet( + getRegexMatchSet( args: GetRegexMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRegexMatchSet( + getRegexMatchSet( args: GetRegexMatchSetCommandInput, cb: (err: any, data?: GetRegexMatchSetCommandOutput) => void ): void; - public getRegexMatchSet( + getRegexMatchSet( args: GetRegexMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRegexMatchSetCommandOutput) => void ): void; - public getRegexMatchSet( - args: GetRegexMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRegexMatchSetCommandOutput) => void), - cb?: (err: any, data?: GetRegexMatchSetCommandOutput) => void - ): Promise | void { - const command = new GetRegexMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the RegexPatternSet specified by RegexPatternSetId.

+ * @see {@link GetRegexPatternSetCommand} */ - public getRegexPatternSet( + getRegexPatternSet( args: GetRegexPatternSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRegexPatternSet( + getRegexPatternSet( args: GetRegexPatternSetCommandInput, cb: (err: any, data?: GetRegexPatternSetCommandOutput) => void ): void; - public getRegexPatternSet( + getRegexPatternSet( args: GetRegexPatternSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRegexPatternSetCommandOutput) => void ): void; - public getRegexPatternSet( - args: GetRegexPatternSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRegexPatternSetCommandOutput) => void), - cb?: (err: any, data?: GetRegexPatternSetCommandOutput) => void - ): Promise | void { - const command = new GetRegexPatternSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the Rule that is specified by the RuleId that you included in the GetRule request.

+ * @see {@link GetRuleCommand} */ - public getRule(args: GetRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public getRule(args: GetRuleCommandInput, cb: (err: any, data?: GetRuleCommandOutput) => void): void; - public getRule( + getRule(args: GetRuleCommandInput, options?: __HttpHandlerOptions): Promise; + getRule(args: GetRuleCommandInput, cb: (err: any, data?: GetRuleCommandOutput) => void): void; + getRule( args: GetRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRuleCommandOutput) => void ): void; - public getRule( - args: GetRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRuleCommandOutput) => void), - cb?: (err: any, data?: GetRuleCommandOutput) => void - ): Promise | void { - const command = new GetRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the RuleGroup that is specified by the RuleGroupId that you included in the GetRuleGroup request.

- *

To view the rules in a rule group, use ListActivatedRulesInRuleGroup.

+ * @see {@link GetRuleGroupCommand} */ - public getRuleGroup( - args: GetRuleGroupCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getRuleGroup(args: GetRuleGroupCommandInput, cb: (err: any, data?: GetRuleGroupCommandOutput) => void): void; - public getRuleGroup( + getRuleGroup(args: GetRuleGroupCommandInput, options?: __HttpHandlerOptions): Promise; + getRuleGroup(args: GetRuleGroupCommandInput, cb: (err: any, data?: GetRuleGroupCommandOutput) => void): void; + getRuleGroup( args: GetRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRuleGroupCommandOutput) => void ): void; - public getRuleGroup( - args: GetRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRuleGroupCommandOutput) => void), - cb?: (err: any, data?: GetRuleGroupCommandOutput) => void - ): Promise | void { - const command = new GetRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.

- *

- * GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource - * (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests - * returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.

+ * @see {@link GetSampledRequestsCommand} */ - public getSampledRequests( + getSampledRequests( args: GetSampledRequestsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSampledRequests( + getSampledRequests( args: GetSampledRequestsCommandInput, cb: (err: any, data?: GetSampledRequestsCommandOutput) => void ): void; - public getSampledRequests( + getSampledRequests( args: GetSampledRequestsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSampledRequestsCommandOutput) => void ): void; - public getSampledRequests( - args: GetSampledRequestsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSampledRequestsCommandOutput) => void), - cb?: (err: any, data?: GetSampledRequestsCommandOutput) => void - ): Promise | void { - const command = new GetSampledRequestsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the SizeConstraintSet specified by SizeConstraintSetId.

+ * @see {@link GetSizeConstraintSetCommand} */ - public getSizeConstraintSet( + getSizeConstraintSet( args: GetSizeConstraintSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSizeConstraintSet( + getSizeConstraintSet( args: GetSizeConstraintSetCommandInput, cb: (err: any, data?: GetSizeConstraintSetCommandOutput) => void ): void; - public getSizeConstraintSet( + getSizeConstraintSet( args: GetSizeConstraintSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSizeConstraintSetCommandOutput) => void ): void; - public getSizeConstraintSet( - args: GetSizeConstraintSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSizeConstraintSetCommandOutput) => void), - cb?: (err: any, data?: GetSizeConstraintSetCommandOutput) => void - ): Promise | void { - const command = new GetSizeConstraintSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.

+ * @see {@link GetSqlInjectionMatchSetCommand} */ - public getSqlInjectionMatchSet( + getSqlInjectionMatchSet( args: GetSqlInjectionMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSqlInjectionMatchSet( + getSqlInjectionMatchSet( args: GetSqlInjectionMatchSetCommandInput, cb: (err: any, data?: GetSqlInjectionMatchSetCommandOutput) => void ): void; - public getSqlInjectionMatchSet( + getSqlInjectionMatchSet( args: GetSqlInjectionMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSqlInjectionMatchSetCommandOutput) => void ): void; - public getSqlInjectionMatchSet( - args: GetSqlInjectionMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSqlInjectionMatchSetCommandOutput) => void), - cb?: (err: any, data?: GetSqlInjectionMatchSetCommandOutput) => void - ): Promise | void { - const command = new GetSqlInjectionMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the WebACL that is specified by WebACLId.

+ * @see {@link GetWebACLCommand} */ - public getWebACL(args: GetWebACLCommandInput, options?: __HttpHandlerOptions): Promise; - public getWebACL(args: GetWebACLCommandInput, cb: (err: any, data?: GetWebACLCommandOutput) => void): void; - public getWebACL( + getWebACL(args: GetWebACLCommandInput, options?: __HttpHandlerOptions): Promise; + getWebACL(args: GetWebACLCommandInput, cb: (err: any, data?: GetWebACLCommandOutput) => void): void; + getWebACL( args: GetWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWebACLCommandOutput) => void ): void; - public getWebACL( - args: GetWebACLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWebACLCommandOutput) => void), - cb?: (err: any, data?: GetWebACLCommandOutput) => void - ): Promise | void { - const command = new GetWebACLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic Regional documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the web ACL for the specified resource, either an application load balancer or Amazon API Gateway stage.

+ * @see {@link GetWebACLForResourceCommand} */ - public getWebACLForResource( + getWebACLForResource( args: GetWebACLForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWebACLForResource( + getWebACLForResource( args: GetWebACLForResourceCommandInput, cb: (err: any, data?: GetWebACLForResourceCommandOutput) => void ): void; - public getWebACLForResource( + getWebACLForResource( args: GetWebACLForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWebACLForResourceCommandOutput) => void ): void; - public getWebACLForResource( - args: GetWebACLForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWebACLForResourceCommandOutput) => void), - cb?: (err: any, data?: GetWebACLForResourceCommandOutput) => void - ): Promise | void { - const command = new GetWebACLForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the XssMatchSet that is specified by XssMatchSetId.

+ * @see {@link GetXssMatchSetCommand} */ - public getXssMatchSet( + getXssMatchSet( args: GetXssMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getXssMatchSet( - args: GetXssMatchSetCommandInput, - cb: (err: any, data?: GetXssMatchSetCommandOutput) => void - ): void; - public getXssMatchSet( + getXssMatchSet(args: GetXssMatchSetCommandInput, cb: (err: any, data?: GetXssMatchSetCommandOutput) => void): void; + getXssMatchSet( args: GetXssMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetXssMatchSetCommandOutput) => void ): void; - public getXssMatchSet( - args: GetXssMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetXssMatchSetCommandOutput) => void), - cb?: (err: any, data?: GetXssMatchSetCommandOutput) => void - ): Promise | void { - const command = new GetXssMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of ActivatedRule objects.

+ * @see {@link ListActivatedRulesInRuleGroupCommand} */ - public listActivatedRulesInRuleGroup( + listActivatedRulesInRuleGroup( args: ListActivatedRulesInRuleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public listActivatedRulesInRuleGroup( + listActivatedRulesInRuleGroup( args: ListActivatedRulesInRuleGroupCommandInput, cb: (err: any, data?: ListActivatedRulesInRuleGroupCommandOutput) => void ): void; - public listActivatedRulesInRuleGroup( + listActivatedRulesInRuleGroup( args: ListActivatedRulesInRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListActivatedRulesInRuleGroupCommandOutput) => void ): void; - public listActivatedRulesInRuleGroup( - args: ListActivatedRulesInRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListActivatedRulesInRuleGroupCommandOutput) => void), - cb?: (err: any, data?: ListActivatedRulesInRuleGroupCommandOutput) => void - ): Promise | void { - const command = new ListActivatedRulesInRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of ByteMatchSetSummary objects.

+ * @see {@link ListByteMatchSetsCommand} */ - public listByteMatchSets( + listByteMatchSets( args: ListByteMatchSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listByteMatchSets( + listByteMatchSets( args: ListByteMatchSetsCommandInput, cb: (err: any, data?: ListByteMatchSetsCommandOutput) => void ): void; - public listByteMatchSets( + listByteMatchSets( args: ListByteMatchSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListByteMatchSetsCommandOutput) => void ): void; - public listByteMatchSets( - args: ListByteMatchSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListByteMatchSetsCommandOutput) => void), - cb?: (err: any, data?: ListByteMatchSetsCommandOutput) => void - ): Promise | void { - const command = new ListByteMatchSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of GeoMatchSetSummary objects in the response.

+ * @see {@link ListGeoMatchSetsCommand} */ - public listGeoMatchSets( + listGeoMatchSets( args: ListGeoMatchSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGeoMatchSets( + listGeoMatchSets( args: ListGeoMatchSetsCommandInput, cb: (err: any, data?: ListGeoMatchSetsCommandOutput) => void ): void; - public listGeoMatchSets( + listGeoMatchSets( args: ListGeoMatchSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGeoMatchSetsCommandOutput) => void ): void; - public listGeoMatchSets( - args: ListGeoMatchSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGeoMatchSetsCommandOutput) => void), - cb?: (err: any, data?: ListGeoMatchSetsCommandOutput) => void - ): Promise | void { - const command = new ListGeoMatchSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of IPSetSummary objects in the response.

+ * @see {@link ListIPSetsCommand} */ - public listIPSets(args: ListIPSetsCommandInput, options?: __HttpHandlerOptions): Promise; - public listIPSets(args: ListIPSetsCommandInput, cb: (err: any, data?: ListIPSetsCommandOutput) => void): void; - public listIPSets( + listIPSets(args: ListIPSetsCommandInput, options?: __HttpHandlerOptions): Promise; + listIPSets(args: ListIPSetsCommandInput, cb: (err: any, data?: ListIPSetsCommandOutput) => void): void; + listIPSets( args: ListIPSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIPSetsCommandOutput) => void ): void; - public listIPSets( - args: ListIPSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIPSetsCommandOutput) => void), - cb?: (err: any, data?: ListIPSetsCommandOutput) => void - ): Promise | void { - const command = new ListIPSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of LoggingConfiguration objects.

+ * @see {@link ListLoggingConfigurationsCommand} */ - public listLoggingConfigurations( + listLoggingConfigurations( args: ListLoggingConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLoggingConfigurations( + listLoggingConfigurations( args: ListLoggingConfigurationsCommandInput, cb: (err: any, data?: ListLoggingConfigurationsCommandOutput) => void ): void; - public listLoggingConfigurations( + listLoggingConfigurations( args: ListLoggingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLoggingConfigurationsCommandOutput) => void ): void; - public listLoggingConfigurations( - args: ListLoggingConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLoggingConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListLoggingConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListLoggingConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of RuleSummary objects.

+ * @see {@link ListRateBasedRulesCommand} */ - public listRateBasedRules( + listRateBasedRules( args: ListRateBasedRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRateBasedRules( + listRateBasedRules( args: ListRateBasedRulesCommandInput, cb: (err: any, data?: ListRateBasedRulesCommandOutput) => void ): void; - public listRateBasedRules( + listRateBasedRules( args: ListRateBasedRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRateBasedRulesCommandOutput) => void ): void; - public listRateBasedRules( - args: ListRateBasedRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRateBasedRulesCommandOutput) => void), - cb?: (err: any, data?: ListRateBasedRulesCommandOutput) => void - ): Promise | void { - const command = new ListRateBasedRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of RegexMatchSetSummary objects.

+ * @see {@link ListRegexMatchSetsCommand} */ - public listRegexMatchSets( + listRegexMatchSets( args: ListRegexMatchSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRegexMatchSets( + listRegexMatchSets( args: ListRegexMatchSetsCommandInput, cb: (err: any, data?: ListRegexMatchSetsCommandOutput) => void ): void; - public listRegexMatchSets( + listRegexMatchSets( args: ListRegexMatchSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRegexMatchSetsCommandOutput) => void ): void; - public listRegexMatchSets( - args: ListRegexMatchSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRegexMatchSetsCommandOutput) => void), - cb?: (err: any, data?: ListRegexMatchSetsCommandOutput) => void - ): Promise | void { - const command = new ListRegexMatchSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of RegexPatternSetSummary objects.

+ * @see {@link ListRegexPatternSetsCommand} */ - public listRegexPatternSets( + listRegexPatternSets( args: ListRegexPatternSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRegexPatternSets( + listRegexPatternSets( args: ListRegexPatternSetsCommandInput, cb: (err: any, data?: ListRegexPatternSetsCommandOutput) => void ): void; - public listRegexPatternSets( + listRegexPatternSets( args: ListRegexPatternSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRegexPatternSetsCommandOutput) => void ): void; - public listRegexPatternSets( - args: ListRegexPatternSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRegexPatternSetsCommandOutput) => void), - cb?: (err: any, data?: ListRegexPatternSetsCommandOutput) => void - ): Promise | void { - const command = new ListRegexPatternSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic Regional documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of resources associated with the specified web ACL.

+ * @see {@link ListResourcesForWebACLCommand} */ - public listResourcesForWebACL( + listResourcesForWebACL( args: ListResourcesForWebACLCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourcesForWebACL( + listResourcesForWebACL( args: ListResourcesForWebACLCommandInput, cb: (err: any, data?: ListResourcesForWebACLCommandOutput) => void ): void; - public listResourcesForWebACL( + listResourcesForWebACL( args: ListResourcesForWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourcesForWebACLCommandOutput) => void ): void; - public listResourcesForWebACL( - args: ListResourcesForWebACLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourcesForWebACLCommandOutput) => void), - cb?: (err: any, data?: ListResourcesForWebACLCommandOutput) => void - ): Promise | void { - const command = new ListResourcesForWebACLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of RuleGroup objects.

+ * @see {@link ListRuleGroupsCommand} */ - public listRuleGroups( + listRuleGroups( args: ListRuleGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRuleGroups( - args: ListRuleGroupsCommandInput, - cb: (err: any, data?: ListRuleGroupsCommandOutput) => void - ): void; - public listRuleGroups( + listRuleGroups(args: ListRuleGroupsCommandInput, cb: (err: any, data?: ListRuleGroupsCommandOutput) => void): void; + listRuleGroups( args: ListRuleGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRuleGroupsCommandOutput) => void ): void; - public listRuleGroups( - args: ListRuleGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRuleGroupsCommandOutput) => void), - cb?: (err: any, data?: ListRuleGroupsCommandOutput) => void - ): Promise | void { - const command = new ListRuleGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of RuleSummary objects.

+ * @see {@link ListRulesCommand} */ - public listRules(args: ListRulesCommandInput, options?: __HttpHandlerOptions): Promise; - public listRules(args: ListRulesCommandInput, cb: (err: any, data?: ListRulesCommandOutput) => void): void; - public listRules( + listRules(args: ListRulesCommandInput, options?: __HttpHandlerOptions): Promise; + listRules(args: ListRulesCommandInput, cb: (err: any, data?: ListRulesCommandOutput) => void): void; + listRules( args: ListRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRulesCommandOutput) => void ): void; - public listRules( - args: ListRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRulesCommandOutput) => void), - cb?: (err: any, data?: ListRulesCommandOutput) => void - ): Promise | void { - const command = new ListRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of SizeConstraintSetSummary objects.

+ * @see {@link ListSizeConstraintSetsCommand} */ - public listSizeConstraintSets( + listSizeConstraintSets( args: ListSizeConstraintSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSizeConstraintSets( + listSizeConstraintSets( args: ListSizeConstraintSetsCommandInput, cb: (err: any, data?: ListSizeConstraintSetsCommandOutput) => void ): void; - public listSizeConstraintSets( + listSizeConstraintSets( args: ListSizeConstraintSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSizeConstraintSetsCommandOutput) => void ): void; - public listSizeConstraintSets( - args: ListSizeConstraintSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSizeConstraintSetsCommandOutput) => void), - cb?: (err: any, data?: ListSizeConstraintSetsCommandOutput) => void - ): Promise | void { - const command = new ListSizeConstraintSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of SqlInjectionMatchSet objects.

+ * @see {@link ListSqlInjectionMatchSetsCommand} */ - public listSqlInjectionMatchSets( + listSqlInjectionMatchSets( args: ListSqlInjectionMatchSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSqlInjectionMatchSets( + listSqlInjectionMatchSets( args: ListSqlInjectionMatchSetsCommandInput, cb: (err: any, data?: ListSqlInjectionMatchSetsCommandOutput) => void ): void; - public listSqlInjectionMatchSets( + listSqlInjectionMatchSets( args: ListSqlInjectionMatchSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSqlInjectionMatchSetsCommandOutput) => void ): void; - public listSqlInjectionMatchSets( - args: ListSqlInjectionMatchSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSqlInjectionMatchSetsCommandOutput) => void), - cb?: (err: any, data?: ListSqlInjectionMatchSetsCommandOutput) => void - ): Promise | void { - const command = new ListSqlInjectionMatchSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of RuleGroup objects that you are subscribed to.

+ * @see {@link ListSubscribedRuleGroupsCommand} */ - public listSubscribedRuleGroups( + listSubscribedRuleGroups( args: ListSubscribedRuleGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSubscribedRuleGroups( + listSubscribedRuleGroups( args: ListSubscribedRuleGroupsCommandInput, cb: (err: any, data?: ListSubscribedRuleGroupsCommandOutput) => void ): void; - public listSubscribedRuleGroups( + listSubscribedRuleGroups( args: ListSubscribedRuleGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSubscribedRuleGroupsCommandOutput) => void ): void; - public listSubscribedRuleGroups( - args: ListSubscribedRuleGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSubscribedRuleGroupsCommandOutput) => void), - cb?: (err: any, data?: ListSubscribedRuleGroupsCommandOutput) => void - ): Promise | void { - const command = new ListSubscribedRuleGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Retrieves the tags associated with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

- *

Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of WebACLSummary objects in the response.

+ * @see {@link ListWebACLsCommand} */ - public listWebACLs(args: ListWebACLsCommandInput, options?: __HttpHandlerOptions): Promise; - public listWebACLs(args: ListWebACLsCommandInput, cb: (err: any, data?: ListWebACLsCommandOutput) => void): void; - public listWebACLs( + listWebACLs(args: ListWebACLsCommandInput, options?: __HttpHandlerOptions): Promise; + listWebACLs(args: ListWebACLsCommandInput, cb: (err: any, data?: ListWebACLsCommandOutput) => void): void; + listWebACLs( args: ListWebACLsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWebACLsCommandOutput) => void ): void; - public listWebACLs( - args: ListWebACLsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWebACLsCommandOutput) => void), - cb?: (err: any, data?: ListWebACLsCommandOutput) => void - ): Promise | void { - const command = new ListWebACLsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of XssMatchSet objects.

+ * @see {@link ListXssMatchSetsCommand} */ - public listXssMatchSets( + listXssMatchSets( args: ListXssMatchSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listXssMatchSets( + listXssMatchSets( args: ListXssMatchSetsCommandInput, cb: (err: any, data?: ListXssMatchSetsCommandOutput) => void ): void; - public listXssMatchSets( + listXssMatchSets( args: ListXssMatchSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListXssMatchSetsCommandOutput) => void ): void; - public listXssMatchSets( - args: ListXssMatchSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListXssMatchSetsCommandOutput) => void), - cb?: (err: any, data?: ListXssMatchSetsCommandOutput) => void - ): Promise | void { - const command = new ListXssMatchSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Associates a LoggingConfiguration with a specified web ACL.

- *

You can access information about all traffic that AWS WAF inspects using the following - * steps:

- *
    - *
  1. - *

    Create an Amazon Kinesis Data - * Firehose.

    - *

    Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).

    - * - *

    Do not create the data firehose using a Kinesis stream as your source.

    - *
    - *
  2. - *
  3. - *

    Associate that firehose to your web ACL using a PutLoggingConfiguration request.

    - *
  4. - *
- * - *

When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.

+ * @see {@link PutLoggingConfigurationCommand} */ - public putLoggingConfiguration( + putLoggingConfiguration( args: PutLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putLoggingConfiguration( + putLoggingConfiguration( args: PutLoggingConfigurationCommandInput, cb: (err: any, data?: PutLoggingConfigurationCommandOutput) => void ): void; - public putLoggingConfiguration( + putLoggingConfiguration( args: PutLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLoggingConfigurationCommandOutput) => void ): void; - public putLoggingConfiguration( - args: PutLoggingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Attaches an IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts.

- *

The PutPermissionPolicy is subject to the following restrictions:

- *
    - *
  • - *

    You can attach only one policy with each PutPermissionPolicy request.

    - *
  • - *
  • - *

    The policy must include an Effect, Action and Principal.

    - *
  • - *
  • - * - *

    - * Effect must specify Allow.

    - *
  • - *
  • - *

    The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected.

    - *
  • - *
  • - *

    The policy cannot include a Resource parameter.

    - *
  • - *
  • - *

    The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.

    - *
  • - *
  • - *

    The user making the request must be the owner of the RuleGroup.

    - *
  • - *
  • - *

    Your policy must be composed using IAM Policy version 2012-10-17.

    - *
  • - *
- *

For more information, see IAM Policies.

- * - *

An example of a valid policy parameter is shown in the Examples section below.

+ * @see {@link PutPermissionPolicyCommand} */ - public putPermissionPolicy( + putPermissionPolicy( args: PutPermissionPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putPermissionPolicy( + putPermissionPolicy( args: PutPermissionPolicyCommandInput, cb: (err: any, data?: PutPermissionPolicyCommandOutput) => void ): void; - public putPermissionPolicy( + putPermissionPolicy( args: PutPermissionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPermissionPolicyCommandOutput) => void ): void; - public putPermissionPolicy( - args: PutPermissionPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutPermissionPolicyCommandOutput) => void), - cb?: (err: any, data?: PutPermissionPolicyCommandOutput) => void - ): Promise | void { - const command = new PutPermissionPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Associates tags with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

- *

Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can use this action to tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, - * you specify the following values:

- *
    - *
  • - *

    Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, - * you delete the existing object and add a new one.

    - *
  • - *
  • - *

    The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

    - *
  • - *
  • - *

    The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify - * the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type.

    - *
  • - *
  • - *

    Where to look, such as at the beginning or the end of a query string.

    - *
  • - *
  • - *

    Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

    - *
  • - *
- *

For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain - * the string BadBot. You can then configure AWS WAF to block those requests.

- *

To create and configure a ByteMatchSet, perform the following steps:

- *
    - *
  1. - *

    Create a ByteMatchSet. For more information, see CreateByteMatchSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateByteMatchSet request.

    - *
  4. - *
  5. - *

    Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect - * (for example, the header or the URI) and the value that you want AWS WAF to watch for.

    - *
  6. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link UpdateByteMatchSetCommand} */ - public updateByteMatchSet( + updateByteMatchSet( args: UpdateByteMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateByteMatchSet( + updateByteMatchSet( args: UpdateByteMatchSetCommandInput, cb: (err: any, data?: UpdateByteMatchSetCommandOutput) => void ): void; - public updateByteMatchSet( + updateByteMatchSet( args: UpdateByteMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateByteMatchSetCommandOutput) => void ): void; - public updateByteMatchSet( - args: UpdateByteMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateByteMatchSetCommandOutput) => void), - cb?: (err: any, data?: UpdateByteMatchSetCommandOutput) => void - ): Promise | void { - const command = new UpdateByteMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet. For each GeoMatchConstraint object, - * you specify the following values:

- *
    - *
  • - *

    Whether to insert or delete the object from the array. If you want to change an GeoMatchConstraint object, you delete the existing object and add a new one.

    - *
  • - *
  • - *

    The Type. The only valid value for Type is Country.

    - *
  • - *
  • - *

    The Value, which is a two character code for the country to add to the GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraint$Value.

    - *
  • - *
- * - *

To create and configure an GeoMatchSet, perform the following steps:

- *
    - *
  1. - *

    Submit a CreateGeoMatchSet request.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateGeoMatchSet request.

    - *
  4. - *
  5. - *

    Submit an UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch for.

    - *
  6. - *
- *

When you update an GeoMatchSet, you specify the country that you want to add and/or the country that you want to delete. - * If you want to change a country, you delete the existing country and add the new one.

- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link UpdateGeoMatchSetCommand} */ - public updateGeoMatchSet( + updateGeoMatchSet( args: UpdateGeoMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGeoMatchSet( + updateGeoMatchSet( args: UpdateGeoMatchSetCommandInput, cb: (err: any, data?: UpdateGeoMatchSetCommandOutput) => void ): void; - public updateGeoMatchSet( + updateGeoMatchSet( args: UpdateGeoMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGeoMatchSetCommandOutput) => void ): void; - public updateGeoMatchSet( - args: UpdateGeoMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGeoMatchSetCommandOutput) => void), - cb?: (err: any, data?: UpdateGeoMatchSetCommandOutput) => void - ): Promise | void { - const command = new UpdateGeoMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes IPSetDescriptor objects in an - * IPSet. For each IPSetDescriptor object, you specify the following - * values:

- *
    - *
  • - *

    Whether to insert or delete the object from the array. If you want to change an - * IPSetDescriptor object, you delete the existing object and add a new - * one.

    - *
  • - *
  • - *

    The IP address version, IPv4 or IPv6.

    - *
  • - *
  • - *

    The IP address in CIDR notation, for example, 192.0.2.0/24 (for - * the range of IP addresses from 192.0.2.0 to 192.0.2.255) or - * 192.0.2.44/32 (for the individual IP address - * 192.0.2.44).

    - *
  • - *
- *

AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS - * WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more - * information about CIDR notation, see the Wikipedia entry Classless - * Inter-Domain Routing.

- *

IPv6 addresses can be represented using any of the following formats:

- *
    - *
  • - *

    1111:0000:0000:0000:0000:0000:0000:0111/128

    - *
  • - *
  • - *

    1111:0:0:0:0:0:0:0111/128

    - *
  • - *
  • - *

    1111::0111/128

    - *
  • - *
  • - *

    1111::111/128

    - *
  • - *
- *

You use an IPSet to specify which web requests you want to allow or - * block based on the IP addresses that the requests originated from. For example, if you're - * receiving a lot of requests from one or a small number of IP addresses and you want to - * block the requests, you can create an IPSet that specifies those IP addresses, - * and then configure AWS WAF to block the requests.

- *

To create and configure an IPSet, perform the following steps:

- *
    - *
  1. - *

    Submit a CreateIPSet request.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide - * in the ChangeToken parameter of an UpdateIPSet - * request.

    - *
  4. - *
  5. - *

    Submit an UpdateIPSet request to specify the IP addresses that you - * want AWS WAF to watch for.

    - *
  6. - *
- *

When you update an IPSet, you specify the IP addresses that you want to - * add and/or the IP addresses that you want to delete. If you want to change an IP address, - * you delete the existing IP address and add the new one.

- *

You can insert a maximum of 1000 addresses in a single - * request.

- *

For more information about how to use the AWS WAF API to allow or block HTTP - * requests, see the AWS WAF - * Developer Guide.

+ * @see {@link UpdateIPSetCommand} */ - public updateIPSet(args: UpdateIPSetCommandInput, options?: __HttpHandlerOptions): Promise; - public updateIPSet(args: UpdateIPSetCommandInput, cb: (err: any, data?: UpdateIPSetCommandOutput) => void): void; - public updateIPSet( + updateIPSet(args: UpdateIPSetCommandInput, options?: __HttpHandlerOptions): Promise; + updateIPSet(args: UpdateIPSetCommandInput, cb: (err: any, data?: UpdateIPSetCommandOutput) => void): void; + updateIPSet( args: UpdateIPSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIPSetCommandOutput) => void ): void; - public updateIPSet( - args: UpdateIPSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateIPSetCommandOutput) => void), - cb?: (err: any, data?: UpdateIPSetCommandOutput) => void - ): Promise | void { - const command = new UpdateIPSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes Predicate objects in a rule and updates the - * RateLimit in the rule.

- *

Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests - * that you want to block or count. The RateLimit specifies the number of - * requests every five minutes that triggers the rule.

- *

If you add more than one predicate to a RateBasedRule, a request must - * match all the predicates and exceed the RateLimit to be counted or blocked. - * For example, suppose you add the following to a RateBasedRule:

- *
    - *
  • - *

    An IPSet that matches the IP address 192.0.2.44/32 - *

    - *
  • - *
  • - *

    A ByteMatchSet that matches BadBot in the - * User-Agent header

    - *
  • - *
- *

Further, you specify a - * RateLimit of 1,000.

- *

You then add the RateBasedRule to a WebACL and specify that - * you want to block requests that satisfy the rule. For a request to be blocked, it must come - * from the IP address 192.0.2.44 and the User-Agent header - * in the request must contain the value BadBot. Further, requests that match - * these two conditions much be received at a rate of more than 1,000 every five minutes. If - * the rate drops below this limit, AWS WAF no longer blocks the requests.

- * - *

As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a - * RateBasedRule:

- * - * - *
    - *
  • - *

    A ByteMatchSet with FieldToMatch of URI - *

    - *
  • - *
  • - *

    A PositionalConstraint of STARTS_WITH - *

    - *
  • - *
  • - *

    A TargetString of login - *

    - *
  • - *
- *

Further, you specify a RateLimit of 1,000.

- *

By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site.

+ * @see {@link UpdateRateBasedRuleCommand} */ - public updateRateBasedRule( + updateRateBasedRule( args: UpdateRateBasedRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRateBasedRule( + updateRateBasedRule( args: UpdateRateBasedRuleCommandInput, cb: (err: any, data?: UpdateRateBasedRuleCommandOutput) => void ): void; - public updateRateBasedRule( + updateRateBasedRule( args: UpdateRateBasedRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRateBasedRuleCommandOutput) => void ): void; - public updateRateBasedRule( - args: UpdateRateBasedRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRateBasedRuleCommandOutput) => void), - cb?: (err: any, data?: UpdateRateBasedRuleCommandOutput) => void - ): Promise | void { - const command = new UpdateRateBasedRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each RegexMatchSetUpdate object, - * you specify the following values:

- *
    - *
  • - *

    Whether to insert or delete the object from the array. If you want to change a RegexMatchSetUpdate object, - * you delete the existing object and add a new one.

    - *
  • - *
  • - *

    The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the User-Agent header.

    - *
  • - *
  • - *

    The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

    - *
  • - *
  • - *

    Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

    - *
  • - *
- *

For example, you can create a RegexPatternSet that matches any requests with User-Agent headers - * that contain the string B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

- *

To create and configure a RegexMatchSet, perform the following steps:

- *
    - *
  1. - *

    Create a RegexMatchSet. For more information, see CreateRegexMatchSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateRegexMatchSet request.

    - *
  4. - *
  5. - *

    Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect - * (for example, the header or the URI) and the identifier of the RegexPatternSet that contain the regular expression patters you want AWS WAF to watch for.

    - *
  6. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link UpdateRegexMatchSetCommand} */ - public updateRegexMatchSet( + updateRegexMatchSet( args: UpdateRegexMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRegexMatchSet( + updateRegexMatchSet( args: UpdateRegexMatchSetCommandInput, cb: (err: any, data?: UpdateRegexMatchSetCommandOutput) => void ): void; - public updateRegexMatchSet( + updateRegexMatchSet( args: UpdateRegexMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRegexMatchSetCommandOutput) => void ): void; - public updateRegexMatchSet( - args: UpdateRegexMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRegexMatchSetCommandOutput) => void), - cb?: (err: any, data?: UpdateRegexMatchSetCommandOutput) => void - ): Promise | void { - const command = new UpdateRegexMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes RegexPatternString objects in a RegexPatternSet. For each RegexPatternString object, - * you specify the following values:

- *
    - *
  • - *

    Whether to insert or delete the RegexPatternString.

    - *
  • - *
  • - *

    The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet.

    - *
  • - *
- *

For example, you can create a RegexPatternString such as B[a@]dB[o0]t. AWS WAF will match this RegexPatternString to:

- *
    - *
  • - *

    BadBot

    - *
  • - *
  • - *

    BadB0t

    - *
  • - *
  • - *

    B@dBot

    - *
  • - *
  • - *

    B@dB0t

    - *
  • - *
- *

To create and configure a RegexPatternSet, perform the following steps:

- *
    - *
  1. - *

    Create a RegexPatternSet. For more information, see CreateRegexPatternSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateRegexPatternSet request.

    - *
  4. - *
  5. - *

    Submit an UpdateRegexPatternSet request to specify the regular expression pattern that you want AWS WAF to watch for.

    - *
  6. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link UpdateRegexPatternSetCommand} */ - public updateRegexPatternSet( + updateRegexPatternSet( args: UpdateRegexPatternSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRegexPatternSet( + updateRegexPatternSet( args: UpdateRegexPatternSetCommandInput, cb: (err: any, data?: UpdateRegexPatternSetCommandOutput) => void ): void; - public updateRegexPatternSet( + updateRegexPatternSet( args: UpdateRegexPatternSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRegexPatternSetCommandOutput) => void ): void; - public updateRegexPatternSet( - args: UpdateRegexPatternSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRegexPatternSetCommandOutput) => void), - cb?: (err: any, data?: UpdateRegexPatternSetCommandOutput) => void - ): Promise | void { - const command = new UpdateRegexPatternSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes Predicate objects in a Rule. Each - * Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests - * that you want to allow, block, or count. If you add more than one predicate to a - * Rule, a request must match all of the specifications to be allowed, - * blocked, or counted. For example, suppose - * that - * you add the following to a Rule:

- *
    - *
  • - *

    A ByteMatchSet that matches the value BadBot in the User-Agent header

    - *
  • - *
  • - *

    An IPSet that matches the IP address 192.0.2.44 - *

    - *
  • - *
- *

You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. - * For a request to be blocked, the User-Agent header in the request must contain the value BadBot - * and the request must originate from the IP address 192.0.2.44.

- *

To create and configure a Rule, perform the following steps:

- *
    - *
  1. - *

    Create and update the predicates that you want to include in the Rule.

    - *
  2. - *
  3. - *

    Create the Rule. See CreateRule.

    - *
  4. - *
  5. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateRule request.

    - *
  6. - *
  7. - *

    Submit an UpdateRule request to add predicates to the Rule.

    - *
  8. - *
  9. - *

    Create and update a WebACL that contains the Rule. See CreateWebACL.

    - *
  10. - *
- *

If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and - * add the new one.

- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link UpdateRuleCommand} */ - public updateRule(args: UpdateRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public updateRule(args: UpdateRuleCommandInput, cb: (err: any, data?: UpdateRuleCommandOutput) => void): void; - public updateRule( + updateRule(args: UpdateRuleCommandInput, options?: __HttpHandlerOptions): Promise; + updateRule(args: UpdateRuleCommandInput, cb: (err: any, data?: UpdateRuleCommandOutput) => void): void; + updateRule( args: UpdateRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRuleCommandOutput) => void ): void; - public updateRule( - args: UpdateRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRuleCommandOutput) => void), - cb?: (err: any, data?: UpdateRuleCommandOutput) => void - ): Promise | void { - const command = new UpdateRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes ActivatedRule objects in a RuleGroup.

- *

You can only insert REGULAR rules into a rule group.

- *

You can have a maximum of ten rules per rule group.

- * - * - *

To create and configure a RuleGroup, perform the following steps:

- *
    - *
  1. - *

    Create and update the Rules that you want to include in the RuleGroup. See CreateRule.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateRuleGroup request.

    - *
  4. - *
  5. - *

    Submit an UpdateRuleGroup request to add Rules to the RuleGroup.

    - *
  6. - *
  7. - *

    Create and update a WebACL that contains the RuleGroup. See CreateWebACL.

    - *
  8. - *
- *

If you want to replace one Rule with another, you delete the existing one and - * add the new one.

- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link UpdateRuleGroupCommand} */ - public updateRuleGroup( + updateRuleGroup( args: UpdateRuleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRuleGroup( - args: UpdateRuleGroupCommandInput, - cb: (err: any, data?: UpdateRuleGroupCommandOutput) => void - ): void; - public updateRuleGroup( + updateRuleGroup(args: UpdateRuleGroupCommandInput, cb: (err: any, data?: UpdateRuleGroupCommandOutput) => void): void; + updateRuleGroup( args: UpdateRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRuleGroupCommandOutput) => void ): void; - public updateRuleGroup( - args: UpdateRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRuleGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateRuleGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, - * you specify the following values:

- *
    - *
  • - *

    Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, - * you delete the existing object and add a new one.

    - *
  • - *
  • - *

    The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the - * User-Agent header.

    - *
  • - *
  • - *

    Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. - * Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes - * of your request to AWS WAF.

    - *

    You can only specify a single type of TextTransformation.

    - *
  • - *
  • - *

    A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as - * equals, greater than, less than, and so on.

    - *
  • - *
  • - *

    The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation.

    - *
  • - *
- *

For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the - * User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests.

- *

To create and configure a SizeConstraintSet, perform the following steps:

- *
    - *
  1. - *

    Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateSizeConstraintSet request.

    - *
  4. - *
  5. - *

    Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect - * (for example, the header or the URI) and the value that you want AWS WAF to watch for.

    - *
  6. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link UpdateSizeConstraintSetCommand} */ - public updateSizeConstraintSet( + updateSizeConstraintSet( args: UpdateSizeConstraintSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSizeConstraintSet( + updateSizeConstraintSet( args: UpdateSizeConstraintSetCommandInput, cb: (err: any, data?: UpdateSizeConstraintSetCommandOutput) => void ): void; - public updateSizeConstraintSet( + updateSizeConstraintSet( args: UpdateSizeConstraintSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSizeConstraintSetCommandOutput) => void ): void; - public updateSizeConstraintSet( - args: UpdateSizeConstraintSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSizeConstraintSetCommandOutput) => void), - cb?: (err: any, data?: UpdateSizeConstraintSetCommandOutput) => void - ): Promise | void { - const command = new UpdateSizeConstraintSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. - * For each SqlInjectionMatchTuple object, you specify the following values:

- *
    - *
  • - *

    - * Action: Whether to insert the object into or delete the object from the array. To change a - * SqlInjectionMatchTuple, you delete the existing object and add a new one.

    - *
  • - *
  • - *

    - * FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, - * the name of the header or parameter.

    - *
  • - *
  • - *

    - * TextTransformation: Which text transformation, if any, to perform on the web request before - * inspecting the request for snippets of malicious SQL code.

    - *

    You can only specify a single type of TextTransformation.

    - *
  • - *
- *

You use SqlInjectionMatchSet objects to specify which CloudFront - * requests that - * you want to allow, block, or count. For example, if you're receiving - * requests that contain snippets of SQL code in the query string and you want to block the - * requests, you can create a SqlInjectionMatchSet with the applicable settings, - * and then configure AWS WAF to block the requests.

- *

To create and configure a SqlInjectionMatchSet, perform the following steps:

- *
    - *
  1. - *

    Submit a CreateSqlInjectionMatchSet request.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateIPSet request.

    - *
  4. - *
  5. - *

    Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to - * inspect for snippets of SQL code.

    - *
  6. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link UpdateSqlInjectionMatchSetCommand} */ - public updateSqlInjectionMatchSet( + updateSqlInjectionMatchSet( args: UpdateSqlInjectionMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSqlInjectionMatchSet( + updateSqlInjectionMatchSet( args: UpdateSqlInjectionMatchSetCommandInput, cb: (err: any, data?: UpdateSqlInjectionMatchSetCommandOutput) => void ): void; - public updateSqlInjectionMatchSet( + updateSqlInjectionMatchSet( args: UpdateSqlInjectionMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSqlInjectionMatchSetCommandOutput) => void ): void; - public updateSqlInjectionMatchSet( - args: UpdateSqlInjectionMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSqlInjectionMatchSetCommandOutput) => void), - cb?: (err: any, data?: UpdateSqlInjectionMatchSetCommandOutput) => void - ): Promise | void { - const command = new UpdateSqlInjectionMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies - * web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values:

- *
    - *
  • - *

    A default action for the WebACL, either ALLOW or BLOCK. - * AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL.

    - *
  • - *
  • - *

    The Rules that you want to add - * or - * delete. If you want to replace one Rule with another, you delete the - * existing Rule and add the new one.

    - *
  • - *
  • - *

    For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match - * the conditions in the Rule.

    - *
  • - *
  • - *

    The order in which you want AWS WAF to evaluate the Rules in a - * WebACL. If you add more than one Rule to a - * WebACL, AWS WAF evaluates each request against the Rules - * in order based on the value of Priority. (The Rule that has - * the lowest value for Priority is evaluated first.) When a web request - * matches all - * the - * predicates (such as ByteMatchSets and IPSets) in a - * Rule, AWS WAF immediately takes the corresponding action, allow or - * block, and doesn't evaluate the request against the remaining Rules in - * the WebACL, if any.

    - *
  • - *
- * - *

To create and configure a WebACL, perform the following steps:

- *
    - *
  1. - *

    Create and update the predicates that you want to include in Rules. - * For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, - * CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.

    - *
  2. - *
  3. - *

    Create and update the Rules that you want to include in the WebACL. For more information, see - * CreateRule and UpdateRule.

    - *
  4. - *
  5. - *

    Create a WebACL. See CreateWebACL.

    - *
  6. - *
  7. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateWebACL request.

    - *
  8. - *
  9. - *

    Submit an UpdateWebACL request to specify the Rules - * that you want to include in the WebACL, to specify the default action, - * and to associate the WebACL with a CloudFront distribution.

    - *

    The ActivatedRule can be a rule group. If you specify a rule group - * as your - * ActivatedRule - * , - * you can exclude specific rules from that rule group.

    - *

    If you already have a rule group associated with a web ACL and want to submit - * an UpdateWebACL request to exclude certain rules from that rule group, - * you must first remove the rule group from the web ACL, the re-insert it again, - * specifying the excluded rules. - * For details, - * see - * ActivatedRule$ExcludedRules - * . - *

    - *
  10. - *
- *

Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist.

- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

+ * @see {@link UpdateWebACLCommand} */ - public updateWebACL( - args: UpdateWebACLCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateWebACL(args: UpdateWebACLCommandInput, cb: (err: any, data?: UpdateWebACLCommandOutput) => void): void; - public updateWebACL( + updateWebACL(args: UpdateWebACLCommandInput, options?: __HttpHandlerOptions): Promise; + updateWebACL(args: UpdateWebACLCommandInput, cb: (err: any, data?: UpdateWebACLCommandOutput) => void): void; + updateWebACL( args: UpdateWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWebACLCommandOutput) => void ): void; - public updateWebACL( - args: UpdateWebACLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWebACLCommandOutput) => void), - cb?: (err: any, data?: UpdateWebACLCommandOutput) => void - ): Promise | void { - const command = new UpdateWebACLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. - * For each XssMatchTuple object, you specify the following values:

- *
    - *
  • - *

    - * Action: Whether to insert the object into or delete the object from the - * array. To change an - * XssMatchTuple, you delete the existing object and add a new - * one.

    - *
  • - *
  • - *

    - * FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, - * the name of the header or parameter.

    - *
  • - *
  • - *

    - * TextTransformation: Which text transformation, if any, to perform on the web request before - * inspecting the request for cross-site scripting attacks.

    - *

    You can only specify a single type of TextTransformation.

    - *
  • - *
- *

You use XssMatchSet objects to specify which CloudFront requests - * that - * you want to allow, block, or count. For example, if you're receiving - * requests that contain cross-site scripting attacks in the request body and you want to - * block the requests, you can create an XssMatchSet with the applicable - * settings, and then configure AWS WAF to block the requests.

- *

To create and configure an XssMatchSet, perform the following steps:

- *
    - *
  1. - *

    Submit a CreateXssMatchSet request.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateIPSet request.

    - *
  4. - *
  5. - *

    Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to - * inspect for cross-site scripting attacks.

    - *
  6. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link UpdateXssMatchSetCommand} */ - public updateXssMatchSet( + updateXssMatchSet( args: UpdateXssMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateXssMatchSet( + updateXssMatchSet( args: UpdateXssMatchSetCommandInput, cb: (err: any, data?: UpdateXssMatchSetCommandOutput) => void ): void; - public updateXssMatchSet( + updateXssMatchSet( args: UpdateXssMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateXssMatchSetCommandOutput) => void ): void; - public updateXssMatchSet( - args: UpdateXssMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateXssMatchSetCommandOutput) => void), - cb?: (err: any, data?: UpdateXssMatchSetCommandOutput) => void - ): Promise | void { - const command = new UpdateXssMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * + *

This is AWS WAF Classic Regional documentation. For + * more information, see AWS + * WAF Classic in the developer guide.

+ *

+ * For the latest version of AWS + * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

+ *
+ *

This is the AWS WAF Regional Classic API Reference for using AWS WAF Classic with the AWS resources, Elastic Load Balancing (ELB) Application Load Balancers and API Gateway APIs. The AWS WAF Classic actions and data types listed in the reference are available for protecting Elastic Load Balancing (ELB) Application Load Balancers and API Gateway APIs. You can use these actions and data types by means of the endpoints listed in AWS Regions and Endpoints. This guide is for developers who need detailed information about the AWS WAF Classic API actions, data types, and errors. For detailed information about AWS WAF Classic features and an overview of how to use the AWS WAF Classic API, see the + * AWS + * WAF Classic in the developer guide.

+ */ +export class WAFRegional extends WAFRegionalClient implements WAFRegional {} +createAggregatedClient(commands, WAFRegional); diff --git a/clients/client-waf/src/WAF.ts b/clients/client-waf/src/WAF.ts index 5cb0ac042feb..5f0c173da3fa 100644 --- a/clients/client-waf/src/WAF.ts +++ b/clients/client-waf/src/WAF.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -334,4202 +335,1280 @@ import { UpdateXssMatchSetCommandInput, UpdateXssMatchSetCommandOutput, } from "./commands/UpdateXssMatchSetCommand"; -import { WAFClient } from "./WAFClient"; +import { WAFClient, WAFClientConfig } from "./WAFClient"; -/** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

This is the AWS WAF Classic API Reference for using AWS WAF Classic with Amazon CloudFront. The AWS WAF Classic actions and data types listed in the reference are available for protecting Amazon CloudFront distributions. You can use these actions and data types via the endpoint waf.amazonaws.com. This guide is for developers who need detailed information about the AWS WAF Classic API actions, - * data types, and errors. For detailed information about AWS WAF Classic features and an overview of how to use the AWS WAF Classic API, see the - * AWS WAF Classic in the developer guide.

- */ -export class WAF extends WAFClient { +const commands = { + CreateByteMatchSetCommand, + CreateGeoMatchSetCommand, + CreateIPSetCommand, + CreateRateBasedRuleCommand, + CreateRegexMatchSetCommand, + CreateRegexPatternSetCommand, + CreateRuleCommand, + CreateRuleGroupCommand, + CreateSizeConstraintSetCommand, + CreateSqlInjectionMatchSetCommand, + CreateWebACLCommand, + CreateWebACLMigrationStackCommand, + CreateXssMatchSetCommand, + DeleteByteMatchSetCommand, + DeleteGeoMatchSetCommand, + DeleteIPSetCommand, + DeleteLoggingConfigurationCommand, + DeletePermissionPolicyCommand, + DeleteRateBasedRuleCommand, + DeleteRegexMatchSetCommand, + DeleteRegexPatternSetCommand, + DeleteRuleCommand, + DeleteRuleGroupCommand, + DeleteSizeConstraintSetCommand, + DeleteSqlInjectionMatchSetCommand, + DeleteWebACLCommand, + DeleteXssMatchSetCommand, + GetByteMatchSetCommand, + GetChangeTokenCommand, + GetChangeTokenStatusCommand, + GetGeoMatchSetCommand, + GetIPSetCommand, + GetLoggingConfigurationCommand, + GetPermissionPolicyCommand, + GetRateBasedRuleCommand, + GetRateBasedRuleManagedKeysCommand, + GetRegexMatchSetCommand, + GetRegexPatternSetCommand, + GetRuleCommand, + GetRuleGroupCommand, + GetSampledRequestsCommand, + GetSizeConstraintSetCommand, + GetSqlInjectionMatchSetCommand, + GetWebACLCommand, + GetXssMatchSetCommand, + ListActivatedRulesInRuleGroupCommand, + ListByteMatchSetsCommand, + ListGeoMatchSetsCommand, + ListIPSetsCommand, + ListLoggingConfigurationsCommand, + ListRateBasedRulesCommand, + ListRegexMatchSetsCommand, + ListRegexPatternSetsCommand, + ListRuleGroupsCommand, + ListRulesCommand, + ListSizeConstraintSetsCommand, + ListSqlInjectionMatchSetsCommand, + ListSubscribedRuleGroupsCommand, + ListTagsForResourceCommand, + ListWebACLsCommand, + ListXssMatchSetsCommand, + PutLoggingConfigurationCommand, + PutPermissionPolicyCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateByteMatchSetCommand, + UpdateGeoMatchSetCommand, + UpdateIPSetCommand, + UpdateRateBasedRuleCommand, + UpdateRegexMatchSetCommand, + UpdateRegexPatternSetCommand, + UpdateRuleCommand, + UpdateRuleGroupCommand, + UpdateSizeConstraintSetCommand, + UpdateSqlInjectionMatchSetCommand, + UpdateWebACLCommand, + UpdateXssMatchSetCommand, +}; + +export interface WAF { /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a - * web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. - * For example, you can create a ByteMatchSet that matches any requests with User-Agent headers - * that contain the string BadBot. You can then configure AWS WAF to reject those requests.

- *

To create and configure a ByteMatchSet, perform the following steps:

- *
    - *
  1. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * CreateByteMatchSet request.

    - *
  2. - *
  3. - *

    Submit a CreateByteMatchSet request.

    - *
  4. - *
  5. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateByteMatchSet request.

    - *
  6. - *
  7. - *

    Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect - * (for example, the header or the URI) and the value that you want AWS WAF to watch for.

    - *
  8. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link CreateByteMatchSetCommand} */ - public createByteMatchSet( + createByteMatchSet( args: CreateByteMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createByteMatchSet( + createByteMatchSet( args: CreateByteMatchSetCommandInput, cb: (err: any, data?: CreateByteMatchSetCommandOutput) => void ): void; - public createByteMatchSet( + createByteMatchSet( args: CreateByteMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateByteMatchSetCommandOutput) => void ): void; - public createByteMatchSet( - args: CreateByteMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateByteMatchSetCommandOutput) => void), - cb?: (err: any, data?: CreateByteMatchSetCommandOutput) => void - ): Promise | void { - const command = new CreateByteMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country - * that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an GeoMatchSet that contains those countries and then configure AWS WAF to block the requests.

- *

To create and configure a GeoMatchSet, perform the following steps:

- *
    - *
  1. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * CreateGeoMatchSet request.

    - *
  2. - *
  3. - *

    Submit a CreateGeoMatchSet request.

    - *
  4. - *
  5. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateGeoMatchSet request.

    - *
  6. - *
  7. - *

    Submit an UpdateGeoMatchSetSet request to specify the countries that you want AWS WAF to watch for.

    - *
  8. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link CreateGeoMatchSetCommand} */ - public createGeoMatchSet( + createGeoMatchSet( args: CreateGeoMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createGeoMatchSet( + createGeoMatchSet( args: CreateGeoMatchSetCommandInput, cb: (err: any, data?: CreateGeoMatchSetCommandOutput) => void ): void; - public createGeoMatchSet( + createGeoMatchSet( args: CreateGeoMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGeoMatchSetCommandOutput) => void ): void; - public createGeoMatchSet( - args: CreateGeoMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGeoMatchSetCommandOutput) => void), - cb?: (err: any, data?: CreateGeoMatchSetCommandOutput) => void - ): Promise | void { - const command = new CreateGeoMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates an IPSet, which you use to specify which web requests - * that - * you want to allow or block based on the IP addresses that the requests - * originate from. For example, if you're receiving a lot of requests from one or more - * individual IP addresses or one or more ranges of IP addresses and you want to block the - * requests, you can create an IPSet that contains those IP addresses and then - * configure AWS WAF to block the requests.

- *

To create and configure an IPSet, perform the following steps:

- *
    - *
  1. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * CreateIPSet request.

    - *
  2. - *
  3. - *

    Submit a CreateIPSet request.

    - *
  4. - *
  5. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateIPSet request.

    - *
  6. - *
  7. - *

    Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.

    - *
  8. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link CreateIPSetCommand} */ - public createIPSet(args: CreateIPSetCommandInput, options?: __HttpHandlerOptions): Promise; - public createIPSet(args: CreateIPSetCommandInput, cb: (err: any, data?: CreateIPSetCommandOutput) => void): void; - public createIPSet( + createIPSet(args: CreateIPSetCommandInput, options?: __HttpHandlerOptions): Promise; + createIPSet(args: CreateIPSetCommandInput, cb: (err: any, data?: CreateIPSetCommandOutput) => void): void; + createIPSet( args: CreateIPSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIPSetCommandOutput) => void ): void; - public createIPSet( - args: CreateIPSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIPSetCommandOutput) => void), - cb?: (err: any, data?: CreateIPSetCommandOutput) => void - ): Promise | void { - const command = new CreateIPSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates a RateBasedRule. The RateBasedRule contains a - * RateLimit, which specifies the maximum number of requests that AWS WAF allows - * from a specified IP address in a five-minute period. - * The RateBasedRule also - * contains the IPSet objects, ByteMatchSet objects, and other - * predicates that identify the requests that you want to count or block if these requests - * exceed the RateLimit.

- *

If you add more than one predicate to a RateBasedRule, a request not - * only must exceed the RateLimit, but it also must match all the - * conditions to be counted or blocked. For example, suppose you add the following to a - * RateBasedRule:

- *
    - *
  • - *

    An IPSet that matches the IP address 192.0.2.44/32 - *

    - *
  • - *
  • - *

    A ByteMatchSet that matches BadBot in the - * User-Agent header

    - *
  • - *
- *

Further, you specify a RateLimit of 1,000.

- *

You then add the RateBasedRule to a WebACL and specify that - * you want to block requests that meet the conditions in the rule. For a request to be - * blocked, it must come from the IP address 192.0.2.44 and the - * User-Agent header in the request must contain the value - * BadBot. Further, requests that match these two conditions must be received at - * a rate of more than 1,000 requests every five minutes. If both conditions are met and the - * rate is exceeded, AWS WAF blocks the requests. If the rate drops below 1,000 for a - * five-minute period, AWS WAF no longer blocks the requests.

- * - *

As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a - * RateBasedRule:

- * - * - *
    - *
  • - *

    A ByteMatchSet with FieldToMatch of URI - *

    - *
  • - *
  • - *

    A PositionalConstraint of STARTS_WITH - *

    - *
  • - *
  • - *

    A TargetString of login - *

    - *
  • - *
- *

Further, you specify a RateLimit of 1,000.

- *

By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site.

- * - * - *

To create and configure a RateBasedRule, perform the following - * steps:

- *
    - *
  1. - *

    Create and update the predicates that you want to include in the rule. For more - * information, see CreateByteMatchSet, CreateIPSet, - * and CreateSqlInjectionMatchSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide - * in the ChangeToken parameter of a CreateRule - * request.

    - *
  4. - *
  5. - *

    Submit a CreateRateBasedRule request.

    - *
  6. - *
  7. - *

    Use GetChangeToken to get the change token that you provide in the - * ChangeToken parameter of an UpdateRule - * request.

    - *
  8. - *
  9. - *

    Submit an UpdateRateBasedRule request to specify the predicates - * that you want to include in the rule.

    - *
  10. - *
  11. - *

    Create and update a WebACL that contains the - * RateBasedRule. For more information, see CreateWebACL.

    - *
  12. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, - * see the AWS WAF Developer - * Guide.

+ * @see {@link CreateRateBasedRuleCommand} */ - public createRateBasedRule( + createRateBasedRule( args: CreateRateBasedRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRateBasedRule( + createRateBasedRule( args: CreateRateBasedRuleCommandInput, cb: (err: any, data?: CreateRateBasedRuleCommandOutput) => void ): void; - public createRateBasedRule( + createRateBasedRule( args: CreateRateBasedRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRateBasedRuleCommandOutput) => void ): void; - public createRateBasedRule( - args: CreateRateBasedRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRateBasedRuleCommandOutput) => void), - cb?: (err: any, data?: CreateRateBasedRuleCommandOutput) => void - ): Promise | void { - const command = new CreateRateBasedRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a - * web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. - * For example, you can create a RegexMatchSet that contains a RegexMatchTuple that looks for any requests with User-Agent headers - * that match a RegexPatternSet with pattern B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

- *

To create and configure a RegexMatchSet, perform the following steps:

- *
    - *
  1. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * CreateRegexMatchSet request.

    - *
  2. - *
  3. - *

    Submit a CreateRegexMatchSet request.

    - *
  4. - *
  5. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateRegexMatchSet request.

    - *
  6. - *
  7. - *

    Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect - * (for example, the header or the URI) and the value, using a RegexPatternSet, that you want AWS WAF to watch for.

    - *
  8. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link CreateRegexMatchSetCommand} */ - public createRegexMatchSet( + createRegexMatchSet( args: CreateRegexMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRegexMatchSet( + createRegexMatchSet( args: CreateRegexMatchSetCommandInput, cb: (err: any, data?: CreateRegexMatchSetCommandOutput) => void ): void; - public createRegexMatchSet( + createRegexMatchSet( args: CreateRegexMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRegexMatchSetCommandOutput) => void ): void; - public createRegexMatchSet( - args: CreateRegexMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRegexMatchSetCommandOutput) => void), - cb?: (err: any, data?: CreateRegexMatchSetCommandOutput) => void - ): Promise | void { - const command = new CreateRegexMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates a RegexPatternSet. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

- *

To create and configure a RegexPatternSet, perform the following steps:

- *
    - *
  1. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * CreateRegexPatternSet request.

    - *
  2. - *
  3. - *

    Submit a CreateRegexPatternSet request.

    - *
  4. - *
  5. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateRegexPatternSet request.

    - *
  6. - *
  7. - *

    Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for.

    - *
  8. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link CreateRegexPatternSetCommand} */ - public createRegexPatternSet( + createRegexPatternSet( args: CreateRegexPatternSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRegexPatternSet( + createRegexPatternSet( args: CreateRegexPatternSetCommandInput, cb: (err: any, data?: CreateRegexPatternSetCommandOutput) => void ): void; - public createRegexPatternSet( + createRegexPatternSet( args: CreateRegexPatternSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRegexPatternSetCommandOutput) => void ): void; - public createRegexPatternSet( - args: CreateRegexPatternSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRegexPatternSetCommandOutput) => void), - cb?: (err: any, data?: CreateRegexPatternSetCommandOutput) => void - ): Promise | void { - const command = new CreateRegexPatternSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates a Rule, which contains the IPSet objects, - * ByteMatchSet objects, and other predicates that identify the requests that - * you want to block. If you add more than one predicate to a Rule, a request - * must match all of the specifications to be allowed or blocked. For example, suppose - * that - * you add the following to a Rule:

- *
    - *
  • - *

    An IPSet that matches the IP address 192.0.2.44/32 - *

    - *
  • - *
  • - *

    A ByteMatchSet that matches BadBot in the User-Agent header

    - *
  • - *
- *

You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. - * For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request - * must contain the value BadBot.

- *

To create and configure a Rule, perform the following steps:

- *
    - *
  1. - *

    Create and update the predicates that you want to include in the Rule. For more information, see - * CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * CreateRule request.

    - *
  4. - *
  5. - *

    Submit a CreateRule request.

    - *
  6. - *
  7. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateRule request.

    - *
  8. - *
  9. - *

    Submit an UpdateRule request to specify the predicates that you want to include in the Rule.

    - *
  10. - *
  11. - *

    Create and update a WebACL that contains the Rule. For more information, see CreateWebACL.

    - *
  12. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link CreateRuleCommand} */ - public createRule(args: CreateRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public createRule(args: CreateRuleCommandInput, cb: (err: any, data?: CreateRuleCommandOutput) => void): void; - public createRule( + createRule(args: CreateRuleCommandInput, options?: __HttpHandlerOptions): Promise; + createRule(args: CreateRuleCommandInput, cb: (err: any, data?: CreateRuleCommandOutput) => void): void; + createRule( args: CreateRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRuleCommandOutput) => void ): void; - public createRule( - args: CreateRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRuleCommandOutput) => void), - cb?: (err: any, data?: CreateRuleCommandOutput) => void - ): Promise | void { - const command = new CreateRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates a RuleGroup. A rule group is a collection of predefined rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group.

- *

Rule groups are subject to the following limits:

- *
    - *
  • - *

    Three rule groups per account. You can request an increase to this limit by contacting customer support.

    - *
  • - *
  • - *

    One rule group per web ACL.

    - *
  • - *
  • - *

    Ten rules per rule group.

    - *
  • - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link CreateRuleGroupCommand} */ - public createRuleGroup( + createRuleGroup( args: CreateRuleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRuleGroup( - args: CreateRuleGroupCommandInput, - cb: (err: any, data?: CreateRuleGroupCommandOutput) => void - ): void; - public createRuleGroup( + createRuleGroup(args: CreateRuleGroupCommandInput, cb: (err: any, data?: CreateRuleGroupCommandOutput) => void): void; + createRuleGroup( args: CreateRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRuleGroupCommandOutput) => void ): void; - public createRuleGroup( - args: CreateRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRuleGroupCommandOutput) => void), - cb?: (err: any, data?: CreateRuleGroupCommandOutput) => void - ): Promise | void { - const command = new CreateRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a - * web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. - * For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. - * You can then configure AWS WAF to reject those requests.

- *

To create and configure a SizeConstraintSet, perform the following steps:

- *
    - *
  1. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * CreateSizeConstraintSet request.

    - *
  2. - *
  3. - *

    Submit a CreateSizeConstraintSet request.

    - *
  4. - *
  5. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateSizeConstraintSet request.

    - *
  6. - *
  7. - *

    Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect - * (for example, the header or the URI) and the value that you want AWS WAF to watch for.

    - *
  8. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link CreateSizeConstraintSetCommand} */ - public createSizeConstraintSet( + createSizeConstraintSet( args: CreateSizeConstraintSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSizeConstraintSet( + createSizeConstraintSet( args: CreateSizeConstraintSetCommandInput, cb: (err: any, data?: CreateSizeConstraintSetCommandOutput) => void ): void; - public createSizeConstraintSet( + createSizeConstraintSet( args: CreateSizeConstraintSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSizeConstraintSetCommandOutput) => void ): void; - public createSizeConstraintSet( - args: CreateSizeConstraintSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSizeConstraintSetCommandOutput) => void), - cb?: (err: any, data?: CreateSizeConstraintSetCommandOutput) => void - ): Promise | void { - const command = new CreateSizeConstraintSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a - * specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

- *

To create and configure a SqlInjectionMatchSet, perform the following steps:

- *
    - *
  1. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * CreateSqlInjectionMatchSet request.

    - *
  2. - *
  3. - *

    Submit a CreateSqlInjectionMatchSet request.

    - *
  4. - *
  5. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateSqlInjectionMatchSet request.

    - *
  6. - *
  7. - *

    Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to - * allow, block, or count malicious SQL code.

    - *
  8. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link CreateSqlInjectionMatchSetCommand} */ - public createSqlInjectionMatchSet( + createSqlInjectionMatchSet( args: CreateSqlInjectionMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSqlInjectionMatchSet( + createSqlInjectionMatchSet( args: CreateSqlInjectionMatchSetCommandInput, cb: (err: any, data?: CreateSqlInjectionMatchSetCommandOutput) => void ): void; - public createSqlInjectionMatchSet( + createSqlInjectionMatchSet( args: CreateSqlInjectionMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSqlInjectionMatchSetCommandOutput) => void ): void; - public createSqlInjectionMatchSet( - args: CreateSqlInjectionMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSqlInjectionMatchSetCommandOutput) => void), - cb?: (err: any, data?: CreateSqlInjectionMatchSetCommandOutput) => void - ): Promise | void { - const command = new CreateSqlInjectionMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count. - * AWS WAF evaluates Rules in order based on the value of Priority for each Rule.

- *

You also specify a default action, either ALLOW or BLOCK. If a web request doesn't match - * any of the Rules in a WebACL, AWS WAF responds to the request with the default action.

- *

To create and configure a WebACL, perform the following steps:

- *
    - *
  1. - *

    Create and update the ByteMatchSet objects and other predicates that you want to include in Rules. - * For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, - * CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.

    - *
  2. - *
  3. - *

    Create and update the Rules that you want to include in the WebACL. For more information, see - * CreateRule and UpdateRule.

    - *
  4. - *
  5. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * CreateWebACL request.

    - *
  6. - *
  7. - *

    Submit a CreateWebACL request.

    - *
  8. - *
  9. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateWebACL request.

    - *
  10. - *
  11. - *

    Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, - * to specify the default action, and to associate the WebACL with a CloudFront distribution.

    - *
  12. - *
- *

For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.

+ * @see {@link CreateWebACLCommand} */ - public createWebACL( - args: CreateWebACLCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createWebACL(args: CreateWebACLCommandInput, cb: (err: any, data?: CreateWebACLCommandOutput) => void): void; - public createWebACL( + createWebACL(args: CreateWebACLCommandInput, options?: __HttpHandlerOptions): Promise; + createWebACL(args: CreateWebACLCommandInput, cb: (err: any, data?: CreateWebACLCommandOutput) => void): void; + createWebACL( args: CreateWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWebACLCommandOutput) => void ): void; - public createWebACL( - args: CreateWebACLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWebACLCommandOutput) => void), - cb?: (err: any, data?: CreateWebACLCommandOutput) => void - ): Promise | void { - const command = new CreateWebACLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the specified Amazon S3 bucket. - * Then, in CloudFormation, you create a stack from the template, to create the web ACL and its resources in AWS WAFV2. - * Use this to migrate your AWS WAF Classic web ACL to the latest version of AWS WAF.

- *

This is part of a larger migration procedure for web ACLs from AWS WAF Classic to the latest version of AWS WAF. - * For the full procedure, including caveats and manual steps to complete - * the migration and switch over to the new web ACL, see - * Migrating your AWS WAF Classic resources to AWS WAF in the AWS WAF - * Developer Guide.

+ * @see {@link CreateWebACLMigrationStackCommand} */ - public createWebACLMigrationStack( + createWebACLMigrationStack( args: CreateWebACLMigrationStackCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWebACLMigrationStack( + createWebACLMigrationStack( args: CreateWebACLMigrationStackCommandInput, cb: (err: any, data?: CreateWebACLMigrationStackCommandOutput) => void ): void; - public createWebACLMigrationStack( + createWebACLMigrationStack( args: CreateWebACLMigrationStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWebACLMigrationStackCommandOutput) => void ): void; - public createWebACLMigrationStack( - args: CreateWebACLMigrationStackCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWebACLMigrationStackCommandOutput) => void), - cb?: (err: any, data?: CreateWebACLMigrationStackCommandOutput) => void - ): Promise | void { - const command = new CreateWebACLMigrationStackCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks - * in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

- *

To create and configure an XssMatchSet, perform the following steps:

- *
    - *
  1. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * CreateXssMatchSet request.

    - *
  2. - *
  3. - *

    Submit a CreateXssMatchSet request.

    - *
  4. - *
  5. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateXssMatchSet request.

    - *
  6. - *
  7. - *

    Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to - * allow, block, or count cross-site scripting attacks.

    - *
  8. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link CreateXssMatchSetCommand} */ - public createXssMatchSet( + createXssMatchSet( args: CreateXssMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createXssMatchSet( + createXssMatchSet( args: CreateXssMatchSetCommandInput, cb: (err: any, data?: CreateXssMatchSetCommandOutput) => void ): void; - public createXssMatchSet( + createXssMatchSet( args: CreateXssMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateXssMatchSetCommandOutput) => void ): void; - public createXssMatchSet( - args: CreateXssMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateXssMatchSetCommandOutput) => void), - cb?: (err: any, data?: CreateXssMatchSetCommandOutput) => void - ): Promise | void { - const command = new CreateXssMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules - * or if it still includes any ByteMatchTuple objects (any filters).

- *

If you just want to remove a ByteMatchSet from a Rule, use UpdateRule.

- *

To permanently delete a ByteMatchSet, perform the following steps:

- *
    - *
  1. - *

    Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * DeleteByteMatchSet request.

    - *
  4. - *
  5. - *

    Submit a DeleteByteMatchSet request.

    - *
  6. - *
+ * @see {@link DeleteByteMatchSetCommand} */ - public deleteByteMatchSet( + deleteByteMatchSet( args: DeleteByteMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteByteMatchSet( + deleteByteMatchSet( args: DeleteByteMatchSetCommandInput, cb: (err: any, data?: DeleteByteMatchSetCommandOutput) => void ): void; - public deleteByteMatchSet( + deleteByteMatchSet( args: DeleteByteMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteByteMatchSetCommandOutput) => void ): void; - public deleteByteMatchSet( - args: DeleteByteMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteByteMatchSetCommandOutput) => void), - cb?: (err: any, data?: DeleteByteMatchSetCommandOutput) => void - ): Promise | void { - const command = new DeleteByteMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes a GeoMatchSet. You can't delete a GeoMatchSet if it's still used in any Rules or - * if it still includes any countries.

- *

If you just want to remove a GeoMatchSet from a Rule, use UpdateRule.

- *

To permanently delete a GeoMatchSet from AWS WAF, perform the following steps:

- *
    - *
  1. - *

    Update the GeoMatchSet to remove any countries. For more information, see UpdateGeoMatchSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * DeleteGeoMatchSet request.

    - *
  4. - *
  5. - *

    Submit a DeleteGeoMatchSet request.

    - *
  6. - *
+ * @see {@link DeleteGeoMatchSetCommand} */ - public deleteGeoMatchSet( + deleteGeoMatchSet( args: DeleteGeoMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteGeoMatchSet( + deleteGeoMatchSet( args: DeleteGeoMatchSetCommandInput, cb: (err: any, data?: DeleteGeoMatchSetCommandOutput) => void ): void; - public deleteGeoMatchSet( + deleteGeoMatchSet( args: DeleteGeoMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGeoMatchSetCommandOutput) => void ): void; - public deleteGeoMatchSet( - args: DeleteGeoMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGeoMatchSetCommandOutput) => void), - cb?: (err: any, data?: DeleteGeoMatchSetCommandOutput) => void - ): Promise | void { - const command = new DeleteGeoMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes an IPSet. You can't delete an IPSet if it's still used in any Rules or - * if it still includes any IP addresses.

- *

If you just want to remove an IPSet from a Rule, use UpdateRule.

- *

To permanently delete an IPSet from AWS WAF, perform the following steps:

- *
    - *
  1. - *

    Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * DeleteIPSet request.

    - *
  4. - *
  5. - *

    Submit a DeleteIPSet request.

    - *
  6. - *
+ * @see {@link DeleteIPSetCommand} */ - public deleteIPSet(args: DeleteIPSetCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteIPSet(args: DeleteIPSetCommandInput, cb: (err: any, data?: DeleteIPSetCommandOutput) => void): void; - public deleteIPSet( + deleteIPSet(args: DeleteIPSetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteIPSet(args: DeleteIPSetCommandInput, cb: (err: any, data?: DeleteIPSetCommandOutput) => void): void; + deleteIPSet( args: DeleteIPSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIPSetCommandOutput) => void ): void; - public deleteIPSet( - args: DeleteIPSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIPSetCommandOutput) => void), - cb?: (err: any, data?: DeleteIPSetCommandOutput) => void - ): Promise | void { - const command = new DeleteIPSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes the LoggingConfiguration from the specified web - * ACL.

+ * @see {@link DeleteLoggingConfigurationCommand} */ - public deleteLoggingConfiguration( + deleteLoggingConfiguration( args: DeleteLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLoggingConfiguration( + deleteLoggingConfiguration( args: DeleteLoggingConfigurationCommandInput, cb: (err: any, data?: DeleteLoggingConfigurationCommandOutput) => void ): void; - public deleteLoggingConfiguration( + deleteLoggingConfiguration( args: DeleteLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLoggingConfigurationCommandOutput) => void ): void; - public deleteLoggingConfiguration( - args: DeleteLoggingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes an IAM policy from the specified RuleGroup.

- *

The user making the request must be the owner of the RuleGroup.

+ * @see {@link DeletePermissionPolicyCommand} */ - public deletePermissionPolicy( + deletePermissionPolicy( args: DeletePermissionPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePermissionPolicy( + deletePermissionPolicy( args: DeletePermissionPolicyCommandInput, cb: (err: any, data?: DeletePermissionPolicyCommandOutput) => void ): void; - public deletePermissionPolicy( + deletePermissionPolicy( args: DeletePermissionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePermissionPolicyCommandOutput) => void ): void; - public deletePermissionPolicy( - args: DeletePermissionPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePermissionPolicyCommandOutput) => void), - cb?: (err: any, data?: DeletePermissionPolicyCommandOutput) => void - ): Promise | void { - const command = new DeletePermissionPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes a RateBasedRule. You can't delete a rule if - * it's still used in any WebACL objects or if it still includes any predicates, - * such as ByteMatchSet objects.

- *

If you just want to remove a rule from a WebACL, use UpdateWebACL.

- *

To permanently delete a RateBasedRule from AWS WAF, perform the following - * steps:

- *
    - *
  1. - *

    Update the RateBasedRule to remove predicates, if any. For more - * information, see UpdateRateBasedRule.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide - * in the ChangeToken parameter of a DeleteRateBasedRule - * request.

    - *
  4. - *
  5. - *

    Submit a DeleteRateBasedRule request.

    - *
  6. - *
+ * @see {@link DeleteRateBasedRuleCommand} */ - public deleteRateBasedRule( + deleteRateBasedRule( args: DeleteRateBasedRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRateBasedRule( + deleteRateBasedRule( args: DeleteRateBasedRuleCommandInput, cb: (err: any, data?: DeleteRateBasedRuleCommandOutput) => void ): void; - public deleteRateBasedRule( + deleteRateBasedRule( args: DeleteRateBasedRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRateBasedRuleCommandOutput) => void ): void; - public deleteRateBasedRule( - args: DeleteRateBasedRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRateBasedRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteRateBasedRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteRateBasedRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes a RegexMatchSet. You can't delete a RegexMatchSet if it's still used in any Rules - * or if it still includes any RegexMatchTuples objects (any filters).

- *

If you just want to remove a RegexMatchSet from a Rule, use UpdateRule.

- *

To permanently delete a RegexMatchSet, perform the following steps:

- *
    - *
  1. - *

    Update the RegexMatchSet to remove filters, if any. For more information, see UpdateRegexMatchSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * DeleteRegexMatchSet request.

    - *
  4. - *
  5. - *

    Submit a DeleteRegexMatchSet request.

    - *
  6. - *
+ * @see {@link DeleteRegexMatchSetCommand} */ - public deleteRegexMatchSet( + deleteRegexMatchSet( args: DeleteRegexMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRegexMatchSet( + deleteRegexMatchSet( args: DeleteRegexMatchSetCommandInput, cb: (err: any, data?: DeleteRegexMatchSetCommandOutput) => void ): void; - public deleteRegexMatchSet( + deleteRegexMatchSet( args: DeleteRegexMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRegexMatchSetCommandOutput) => void ): void; - public deleteRegexMatchSet( - args: DeleteRegexMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRegexMatchSetCommandOutput) => void), - cb?: (err: any, data?: DeleteRegexMatchSetCommandOutput) => void - ): Promise | void { - const command = new DeleteRegexMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes a RegexPatternSet. You can't delete a RegexPatternSet if it's still used in any RegexMatchSet - * or if the RegexPatternSet is not empty.

+ * @see {@link DeleteRegexPatternSetCommand} */ - public deleteRegexPatternSet( + deleteRegexPatternSet( args: DeleteRegexPatternSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRegexPatternSet( + deleteRegexPatternSet( args: DeleteRegexPatternSetCommandInput, cb: (err: any, data?: DeleteRegexPatternSetCommandOutput) => void ): void; - public deleteRegexPatternSet( + deleteRegexPatternSet( args: DeleteRegexPatternSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRegexPatternSetCommandOutput) => void ): void; - public deleteRegexPatternSet( - args: DeleteRegexPatternSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRegexPatternSetCommandOutput) => void), - cb?: (err: any, data?: DeleteRegexPatternSetCommandOutput) => void - ): Promise | void { - const command = new DeleteRegexPatternSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL - * objects or if it still includes any predicates, such as ByteMatchSet objects.

- *

If you just want to remove a Rule from a WebACL, use UpdateWebACL.

- *

To permanently delete a Rule from AWS WAF, perform the following steps:

- *
    - *
  1. - *

    Update the Rule to remove predicates, if any. For more information, see UpdateRule.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * DeleteRule request.

    - *
  4. - *
  5. - *

    Submit a DeleteRule request.

    - *
  6. - *
+ * @see {@link DeleteRuleCommand} */ - public deleteRule(args: DeleteRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteRule(args: DeleteRuleCommandInput, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void; - public deleteRule( + deleteRule(args: DeleteRuleCommandInput, options?: __HttpHandlerOptions): Promise; + deleteRule(args: DeleteRuleCommandInput, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void; + deleteRule( args: DeleteRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRuleCommandOutput) => void ): void; - public deleteRule( - args: DeleteRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes a RuleGroup. You can't delete a RuleGroup if it's still used in any WebACL - * objects or if it still includes any rules.

- *

If you just want to remove a RuleGroup from a WebACL, use UpdateWebACL.

- *

To permanently delete a RuleGroup from AWS WAF, perform the following steps:

- *
    - *
  1. - *

    Update the RuleGroup to remove rules, if any. For more information, see UpdateRuleGroup.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * DeleteRuleGroup request.

    - *
  4. - *
  5. - *

    Submit a DeleteRuleGroup request.

    - *
  6. - *
+ * @see {@link DeleteRuleGroupCommand} */ - public deleteRuleGroup( + deleteRuleGroup( args: DeleteRuleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRuleGroup( - args: DeleteRuleGroupCommandInput, - cb: (err: any, data?: DeleteRuleGroupCommandOutput) => void - ): void; - public deleteRuleGroup( + deleteRuleGroup(args: DeleteRuleGroupCommandInput, cb: (err: any, data?: DeleteRuleGroupCommandOutput) => void): void; + deleteRuleGroup( args: DeleteRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRuleGroupCommandOutput) => void ): void; - public deleteRuleGroup( - args: DeleteRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRuleGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteRuleGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules - * or if it still includes any SizeConstraint objects (any filters).

- *

If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule.

- *

To permanently delete a SizeConstraintSet, perform the following steps:

- *
    - *
  1. - *

    Update the SizeConstraintSet to remove filters, if any. For more information, see UpdateSizeConstraintSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * DeleteSizeConstraintSet request.

    - *
  4. - *
  5. - *

    Submit a DeleteSizeConstraintSet request.

    - *
  6. - *
+ * @see {@link DeleteSizeConstraintSetCommand} */ - public deleteSizeConstraintSet( + deleteSizeConstraintSet( args: DeleteSizeConstraintSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSizeConstraintSet( + deleteSizeConstraintSet( args: DeleteSizeConstraintSetCommandInput, cb: (err: any, data?: DeleteSizeConstraintSetCommandOutput) => void ): void; - public deleteSizeConstraintSet( + deleteSizeConstraintSet( args: DeleteSizeConstraintSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSizeConstraintSetCommandOutput) => void ): void; - public deleteSizeConstraintSet( - args: DeleteSizeConstraintSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSizeConstraintSetCommandOutput) => void), - cb?: (err: any, data?: DeleteSizeConstraintSetCommandOutput) => void - ): Promise | void { - const command = new DeleteSizeConstraintSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet if it's - * still used in any Rules or if it still contains any SqlInjectionMatchTuple objects.

- *

If you just want to remove a SqlInjectionMatchSet from a Rule, use UpdateRule.

- *

To permanently delete a SqlInjectionMatchSet from AWS WAF, perform the following steps:

- *
    - *
  1. - *

    Update the SqlInjectionMatchSet to remove filters, if any. For more information, see - * UpdateSqlInjectionMatchSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * DeleteSqlInjectionMatchSet request.

    - *
  4. - *
  5. - *

    Submit a DeleteSqlInjectionMatchSet request.

    - *
  6. - *
+ * @see {@link DeleteSqlInjectionMatchSetCommand} */ - public deleteSqlInjectionMatchSet( + deleteSqlInjectionMatchSet( args: DeleteSqlInjectionMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSqlInjectionMatchSet( + deleteSqlInjectionMatchSet( args: DeleteSqlInjectionMatchSetCommandInput, cb: (err: any, data?: DeleteSqlInjectionMatchSetCommandOutput) => void ): void; - public deleteSqlInjectionMatchSet( + deleteSqlInjectionMatchSet( args: DeleteSqlInjectionMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSqlInjectionMatchSetCommandOutput) => void ): void; - public deleteSqlInjectionMatchSet( - args: DeleteSqlInjectionMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSqlInjectionMatchSetCommandOutput) => void), - cb?: (err: any, data?: DeleteSqlInjectionMatchSetCommandOutput) => void - ): Promise | void { - const command = new DeleteSqlInjectionMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules.

- *

To delete a WebACL, perform the following steps:

- *
    - *
  1. - *

    Update the WebACL to remove Rules, if any. For more information, see UpdateWebACL.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * DeleteWebACL request.

    - *
  4. - *
  5. - *

    Submit a DeleteWebACL request.

    - *
  6. - *
+ * @see {@link DeleteWebACLCommand} */ - public deleteWebACL( - args: DeleteWebACLCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteWebACL(args: DeleteWebACLCommandInput, cb: (err: any, data?: DeleteWebACLCommandOutput) => void): void; - public deleteWebACL( + deleteWebACL(args: DeleteWebACLCommandInput, options?: __HttpHandlerOptions): Promise; + deleteWebACL(args: DeleteWebACLCommandInput, cb: (err: any, data?: DeleteWebACLCommandOutput) => void): void; + deleteWebACL( args: DeleteWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWebACLCommandOutput) => void ): void; - public deleteWebACL( - args: DeleteWebACLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWebACLCommandOutput) => void), - cb?: (err: any, data?: DeleteWebACLCommandOutput) => void - ): Promise | void { - const command = new DeleteWebACLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Permanently deletes an XssMatchSet. You can't delete an XssMatchSet if it's - * still used in any Rules or if it still contains any XssMatchTuple objects.

- *

If you just want to remove an XssMatchSet from a Rule, use UpdateRule.

- *

To permanently delete an XssMatchSet from AWS WAF, perform the following steps:

- *
    - *
  1. - *

    Update the XssMatchSet to remove filters, if any. For more information, see - * UpdateXssMatchSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a - * DeleteXssMatchSet request.

    - *
  4. - *
  5. - *

    Submit a DeleteXssMatchSet request.

    - *
  6. - *
+ * @see {@link DeleteXssMatchSetCommand} */ - public deleteXssMatchSet( + deleteXssMatchSet( args: DeleteXssMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteXssMatchSet( + deleteXssMatchSet( args: DeleteXssMatchSetCommandInput, cb: (err: any, data?: DeleteXssMatchSetCommandOutput) => void ): void; - public deleteXssMatchSet( + deleteXssMatchSet( args: DeleteXssMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteXssMatchSetCommandOutput) => void ): void; - public deleteXssMatchSet( - args: DeleteXssMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteXssMatchSetCommandOutput) => void), - cb?: (err: any, data?: DeleteXssMatchSetCommandOutput) => void - ): Promise | void { - const command = new DeleteXssMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the ByteMatchSet specified by ByteMatchSetId.

+ * @see {@link GetByteMatchSetCommand} */ - public getByteMatchSet( + getByteMatchSet( args: GetByteMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getByteMatchSet( - args: GetByteMatchSetCommandInput, - cb: (err: any, data?: GetByteMatchSetCommandOutput) => void - ): void; - public getByteMatchSet( + getByteMatchSet(args: GetByteMatchSetCommandInput, cb: (err: any, data?: GetByteMatchSetCommandOutput) => void): void; + getByteMatchSet( args: GetByteMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetByteMatchSetCommandOutput) => void ): void; - public getByteMatchSet( - args: GetByteMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetByteMatchSetCommandOutput) => void), - cb?: (err: any, data?: GetByteMatchSetCommandOutput) => void - ): Promise | void { - const command = new GetByteMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.

- *

Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request - * and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second - * GetChangeToken request returns the same value as the first GetChangeToken request.

- *

When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, - * which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the - * status of your change token.

+ * @see {@link GetChangeTokenCommand} */ - public getChangeToken( + getChangeToken( args: GetChangeTokenCommandInput, options?: __HttpHandlerOptions ): Promise; - public getChangeToken( - args: GetChangeTokenCommandInput, - cb: (err: any, data?: GetChangeTokenCommandOutput) => void - ): void; - public getChangeToken( + getChangeToken(args: GetChangeTokenCommandInput, cb: (err: any, data?: GetChangeTokenCommandOutput) => void): void; + getChangeToken( args: GetChangeTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChangeTokenCommandOutput) => void ): void; - public getChangeToken( - args: GetChangeTokenCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetChangeTokenCommandOutput) => void), - cb?: (err: any, data?: GetChangeTokenCommandOutput) => void - ): Promise | void { - const command = new GetChangeTokenCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is - * one of the following values:

- *
    - *
  • - *

    - * PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet - * in a call to create, update, or delete an AWS WAF object.

    - *
  • - *
  • - *

    - * PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers.

    - *
  • - *
  • - *

    - * INSYNC: Propagation is complete.

    - *
  • - *
+ * @see {@link GetChangeTokenStatusCommand} */ - public getChangeTokenStatus( + getChangeTokenStatus( args: GetChangeTokenStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public getChangeTokenStatus( + getChangeTokenStatus( args: GetChangeTokenStatusCommandInput, cb: (err: any, data?: GetChangeTokenStatusCommandOutput) => void ): void; - public getChangeTokenStatus( + getChangeTokenStatus( args: GetChangeTokenStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChangeTokenStatusCommandOutput) => void ): void; - public getChangeTokenStatus( - args: GetChangeTokenStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetChangeTokenStatusCommandOutput) => void), - cb?: (err: any, data?: GetChangeTokenStatusCommandOutput) => void - ): Promise | void { - const command = new GetChangeTokenStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the GeoMatchSet that is specified by GeoMatchSetId.

+ * @see {@link GetGeoMatchSetCommand} */ - public getGeoMatchSet( + getGeoMatchSet( args: GetGeoMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getGeoMatchSet( - args: GetGeoMatchSetCommandInput, - cb: (err: any, data?: GetGeoMatchSetCommandOutput) => void - ): void; - public getGeoMatchSet( + getGeoMatchSet(args: GetGeoMatchSetCommandInput, cb: (err: any, data?: GetGeoMatchSetCommandOutput) => void): void; + getGeoMatchSet( args: GetGeoMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGeoMatchSetCommandOutput) => void ): void; - public getGeoMatchSet( - args: GetGeoMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGeoMatchSetCommandOutput) => void), - cb?: (err: any, data?: GetGeoMatchSetCommandOutput) => void - ): Promise | void { - const command = new GetGeoMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the IPSet that is specified by IPSetId.

+ * @see {@link GetIPSetCommand} */ - public getIPSet(args: GetIPSetCommandInput, options?: __HttpHandlerOptions): Promise; - public getIPSet(args: GetIPSetCommandInput, cb: (err: any, data?: GetIPSetCommandOutput) => void): void; - public getIPSet( + getIPSet(args: GetIPSetCommandInput, options?: __HttpHandlerOptions): Promise; + getIPSet(args: GetIPSetCommandInput, cb: (err: any, data?: GetIPSetCommandOutput) => void): void; + getIPSet( args: GetIPSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIPSetCommandOutput) => void ): void; - public getIPSet( - args: GetIPSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIPSetCommandOutput) => void), - cb?: (err: any, data?: GetIPSetCommandOutput) => void - ): Promise | void { - const command = new GetIPSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the LoggingConfiguration for the specified web ACL.

+ * @see {@link GetLoggingConfigurationCommand} */ - public getLoggingConfiguration( + getLoggingConfiguration( args: GetLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLoggingConfiguration( + getLoggingConfiguration( args: GetLoggingConfigurationCommandInput, cb: (err: any, data?: GetLoggingConfigurationCommandOutput) => void ): void; - public getLoggingConfiguration( + getLoggingConfiguration( args: GetLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLoggingConfigurationCommandOutput) => void ): void; - public getLoggingConfiguration( - args: GetLoggingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the IAM policy attached to the RuleGroup.

+ * @see {@link GetPermissionPolicyCommand} */ - public getPermissionPolicy( + getPermissionPolicy( args: GetPermissionPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPermissionPolicy( + getPermissionPolicy( args: GetPermissionPolicyCommandInput, cb: (err: any, data?: GetPermissionPolicyCommandOutput) => void ): void; - public getPermissionPolicy( + getPermissionPolicy( args: GetPermissionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPermissionPolicyCommandOutput) => void ): void; - public getPermissionPolicy( - args: GetPermissionPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPermissionPolicyCommandOutput) => void), - cb?: (err: any, data?: GetPermissionPolicyCommandOutput) => void - ): Promise | void { - const command = new GetPermissionPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the RateBasedRule that is specified by the - * RuleId that you included in the GetRateBasedRule - * request.

+ * @see {@link GetRateBasedRuleCommand} */ - public getRateBasedRule( + getRateBasedRule( args: GetRateBasedRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRateBasedRule( + getRateBasedRule( args: GetRateBasedRuleCommandInput, cb: (err: any, data?: GetRateBasedRuleCommandOutput) => void ): void; - public getRateBasedRule( + getRateBasedRule( args: GetRateBasedRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRateBasedRuleCommandOutput) => void ): void; - public getRateBasedRule( - args: GetRateBasedRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRateBasedRuleCommandOutput) => void), - cb?: (err: any, data?: GetRateBasedRuleCommandOutput) => void - ): Promise | void { - const command = new GetRateBasedRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the RuleId. The maximum - * number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed - * the rate limit, the 10,000 addresses with the highest rates will be blocked.

+ * @see {@link GetRateBasedRuleManagedKeysCommand} */ - public getRateBasedRuleManagedKeys( + getRateBasedRuleManagedKeys( args: GetRateBasedRuleManagedKeysCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRateBasedRuleManagedKeys( + getRateBasedRuleManagedKeys( args: GetRateBasedRuleManagedKeysCommandInput, cb: (err: any, data?: GetRateBasedRuleManagedKeysCommandOutput) => void ): void; - public getRateBasedRuleManagedKeys( + getRateBasedRuleManagedKeys( args: GetRateBasedRuleManagedKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRateBasedRuleManagedKeysCommandOutput) => void ): void; - public getRateBasedRuleManagedKeys( - args: GetRateBasedRuleManagedKeysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRateBasedRuleManagedKeysCommandOutput) => void), - cb?: (err: any, data?: GetRateBasedRuleManagedKeysCommandOutput) => void - ): Promise | void { - const command = new GetRateBasedRuleManagedKeysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the RegexMatchSet specified by RegexMatchSetId.

+ * @see {@link GetRegexMatchSetCommand} */ - public getRegexMatchSet( + getRegexMatchSet( args: GetRegexMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRegexMatchSet( + getRegexMatchSet( args: GetRegexMatchSetCommandInput, cb: (err: any, data?: GetRegexMatchSetCommandOutput) => void ): void; - public getRegexMatchSet( + getRegexMatchSet( args: GetRegexMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRegexMatchSetCommandOutput) => void ): void; - public getRegexMatchSet( - args: GetRegexMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRegexMatchSetCommandOutput) => void), - cb?: (err: any, data?: GetRegexMatchSetCommandOutput) => void - ): Promise | void { - const command = new GetRegexMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the RegexPatternSet specified by RegexPatternSetId.

+ * @see {@link GetRegexPatternSetCommand} */ - public getRegexPatternSet( + getRegexPatternSet( args: GetRegexPatternSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRegexPatternSet( + getRegexPatternSet( args: GetRegexPatternSetCommandInput, cb: (err: any, data?: GetRegexPatternSetCommandOutput) => void ): void; - public getRegexPatternSet( + getRegexPatternSet( args: GetRegexPatternSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRegexPatternSetCommandOutput) => void ): void; - public getRegexPatternSet( - args: GetRegexPatternSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRegexPatternSetCommandOutput) => void), - cb?: (err: any, data?: GetRegexPatternSetCommandOutput) => void - ): Promise | void { - const command = new GetRegexPatternSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the Rule that is specified by the RuleId that you included in the GetRule request.

+ * @see {@link GetRuleCommand} */ - public getRule(args: GetRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public getRule(args: GetRuleCommandInput, cb: (err: any, data?: GetRuleCommandOutput) => void): void; - public getRule( + getRule(args: GetRuleCommandInput, options?: __HttpHandlerOptions): Promise; + getRule(args: GetRuleCommandInput, cb: (err: any, data?: GetRuleCommandOutput) => void): void; + getRule( args: GetRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRuleCommandOutput) => void ): void; - public getRule( - args: GetRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRuleCommandOutput) => void), - cb?: (err: any, data?: GetRuleCommandOutput) => void - ): Promise | void { - const command = new GetRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the RuleGroup that is specified by the RuleGroupId that you included in the GetRuleGroup request.

- *

To view the rules in a rule group, use ListActivatedRulesInRuleGroup.

+ * @see {@link GetRuleGroupCommand} */ - public getRuleGroup( - args: GetRuleGroupCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getRuleGroup(args: GetRuleGroupCommandInput, cb: (err: any, data?: GetRuleGroupCommandOutput) => void): void; - public getRuleGroup( + getRuleGroup(args: GetRuleGroupCommandInput, options?: __HttpHandlerOptions): Promise; + getRuleGroup(args: GetRuleGroupCommandInput, cb: (err: any, data?: GetRuleGroupCommandOutput) => void): void; + getRuleGroup( args: GetRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRuleGroupCommandOutput) => void ): void; - public getRuleGroup( - args: GetRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRuleGroupCommandOutput) => void), - cb?: (err: any, data?: GetRuleGroupCommandOutput) => void - ): Promise | void { - const command = new GetRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.

- *

- * GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource - * (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests - * returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.

+ * @see {@link GetSampledRequestsCommand} */ - public getSampledRequests( + getSampledRequests( args: GetSampledRequestsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSampledRequests( + getSampledRequests( args: GetSampledRequestsCommandInput, cb: (err: any, data?: GetSampledRequestsCommandOutput) => void ): void; - public getSampledRequests( + getSampledRequests( args: GetSampledRequestsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSampledRequestsCommandOutput) => void ): void; - public getSampledRequests( - args: GetSampledRequestsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSampledRequestsCommandOutput) => void), - cb?: (err: any, data?: GetSampledRequestsCommandOutput) => void - ): Promise | void { - const command = new GetSampledRequestsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the SizeConstraintSet specified by SizeConstraintSetId.

+ * @see {@link GetSizeConstraintSetCommand} */ - public getSizeConstraintSet( + getSizeConstraintSet( args: GetSizeConstraintSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSizeConstraintSet( + getSizeConstraintSet( args: GetSizeConstraintSetCommandInput, cb: (err: any, data?: GetSizeConstraintSetCommandOutput) => void ): void; - public getSizeConstraintSet( + getSizeConstraintSet( args: GetSizeConstraintSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSizeConstraintSetCommandOutput) => void ): void; - public getSizeConstraintSet( - args: GetSizeConstraintSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSizeConstraintSetCommandOutput) => void), - cb?: (err: any, data?: GetSizeConstraintSetCommandOutput) => void - ): Promise | void { - const command = new GetSizeConstraintSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.

+ * @see {@link GetSqlInjectionMatchSetCommand} */ - public getSqlInjectionMatchSet( + getSqlInjectionMatchSet( args: GetSqlInjectionMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSqlInjectionMatchSet( + getSqlInjectionMatchSet( args: GetSqlInjectionMatchSetCommandInput, cb: (err: any, data?: GetSqlInjectionMatchSetCommandOutput) => void ): void; - public getSqlInjectionMatchSet( + getSqlInjectionMatchSet( args: GetSqlInjectionMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSqlInjectionMatchSetCommandOutput) => void ): void; - public getSqlInjectionMatchSet( - args: GetSqlInjectionMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSqlInjectionMatchSetCommandOutput) => void), - cb?: (err: any, data?: GetSqlInjectionMatchSetCommandOutput) => void - ): Promise | void { - const command = new GetSqlInjectionMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the WebACL that is specified by WebACLId.

+ * @see {@link GetWebACLCommand} */ - public getWebACL(args: GetWebACLCommandInput, options?: __HttpHandlerOptions): Promise; - public getWebACL(args: GetWebACLCommandInput, cb: (err: any, data?: GetWebACLCommandOutput) => void): void; - public getWebACL( + getWebACL(args: GetWebACLCommandInput, options?: __HttpHandlerOptions): Promise; + getWebACL(args: GetWebACLCommandInput, cb: (err: any, data?: GetWebACLCommandOutput) => void): void; + getWebACL( args: GetWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWebACLCommandOutput) => void ): void; - public getWebACL( - args: GetWebACLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWebACLCommandOutput) => void), - cb?: (err: any, data?: GetWebACLCommandOutput) => void - ): Promise | void { - const command = new GetWebACLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns the XssMatchSet that is specified by XssMatchSetId.

+ * @see {@link GetXssMatchSetCommand} */ - public getXssMatchSet( + getXssMatchSet( args: GetXssMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getXssMatchSet( - args: GetXssMatchSetCommandInput, - cb: (err: any, data?: GetXssMatchSetCommandOutput) => void - ): void; - public getXssMatchSet( + getXssMatchSet(args: GetXssMatchSetCommandInput, cb: (err: any, data?: GetXssMatchSetCommandOutput) => void): void; + getXssMatchSet( args: GetXssMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetXssMatchSetCommandOutput) => void ): void; - public getXssMatchSet( - args: GetXssMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetXssMatchSetCommandOutput) => void), - cb?: (err: any, data?: GetXssMatchSetCommandOutput) => void - ): Promise | void { - const command = new GetXssMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of ActivatedRule objects.

+ * @see {@link ListActivatedRulesInRuleGroupCommand} */ - public listActivatedRulesInRuleGroup( + listActivatedRulesInRuleGroup( args: ListActivatedRulesInRuleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public listActivatedRulesInRuleGroup( + listActivatedRulesInRuleGroup( args: ListActivatedRulesInRuleGroupCommandInput, cb: (err: any, data?: ListActivatedRulesInRuleGroupCommandOutput) => void ): void; - public listActivatedRulesInRuleGroup( + listActivatedRulesInRuleGroup( args: ListActivatedRulesInRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListActivatedRulesInRuleGroupCommandOutput) => void ): void; - public listActivatedRulesInRuleGroup( - args: ListActivatedRulesInRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListActivatedRulesInRuleGroupCommandOutput) => void), - cb?: (err: any, data?: ListActivatedRulesInRuleGroupCommandOutput) => void - ): Promise | void { - const command = new ListActivatedRulesInRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of ByteMatchSetSummary objects.

+ * @see {@link ListByteMatchSetsCommand} */ - public listByteMatchSets( + listByteMatchSets( args: ListByteMatchSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listByteMatchSets( + listByteMatchSets( args: ListByteMatchSetsCommandInput, cb: (err: any, data?: ListByteMatchSetsCommandOutput) => void ): void; - public listByteMatchSets( + listByteMatchSets( args: ListByteMatchSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListByteMatchSetsCommandOutput) => void ): void; - public listByteMatchSets( - args: ListByteMatchSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListByteMatchSetsCommandOutput) => void), - cb?: (err: any, data?: ListByteMatchSetsCommandOutput) => void - ): Promise | void { - const command = new ListByteMatchSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of GeoMatchSetSummary objects in the response.

+ * @see {@link ListGeoMatchSetsCommand} */ - public listGeoMatchSets( + listGeoMatchSets( args: ListGeoMatchSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGeoMatchSets( + listGeoMatchSets( args: ListGeoMatchSetsCommandInput, cb: (err: any, data?: ListGeoMatchSetsCommandOutput) => void ): void; - public listGeoMatchSets( + listGeoMatchSets( args: ListGeoMatchSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGeoMatchSetsCommandOutput) => void ): void; - public listGeoMatchSets( - args: ListGeoMatchSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGeoMatchSetsCommandOutput) => void), - cb?: (err: any, data?: ListGeoMatchSetsCommandOutput) => void - ): Promise | void { - const command = new ListGeoMatchSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of IPSetSummary objects in the response.

+ * @see {@link ListIPSetsCommand} */ - public listIPSets(args: ListIPSetsCommandInput, options?: __HttpHandlerOptions): Promise; - public listIPSets(args: ListIPSetsCommandInput, cb: (err: any, data?: ListIPSetsCommandOutput) => void): void; - public listIPSets( + listIPSets(args: ListIPSetsCommandInput, options?: __HttpHandlerOptions): Promise; + listIPSets(args: ListIPSetsCommandInput, cb: (err: any, data?: ListIPSetsCommandOutput) => void): void; + listIPSets( args: ListIPSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIPSetsCommandOutput) => void ): void; - public listIPSets( - args: ListIPSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIPSetsCommandOutput) => void), - cb?: (err: any, data?: ListIPSetsCommandOutput) => void - ): Promise | void { - const command = new ListIPSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of LoggingConfiguration objects.

+ * @see {@link ListLoggingConfigurationsCommand} */ - public listLoggingConfigurations( + listLoggingConfigurations( args: ListLoggingConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLoggingConfigurations( + listLoggingConfigurations( args: ListLoggingConfigurationsCommandInput, cb: (err: any, data?: ListLoggingConfigurationsCommandOutput) => void ): void; - public listLoggingConfigurations( + listLoggingConfigurations( args: ListLoggingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLoggingConfigurationsCommandOutput) => void ): void; - public listLoggingConfigurations( - args: ListLoggingConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLoggingConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListLoggingConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListLoggingConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of RuleSummary objects.

+ * @see {@link ListRateBasedRulesCommand} */ - public listRateBasedRules( + listRateBasedRules( args: ListRateBasedRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRateBasedRules( + listRateBasedRules( args: ListRateBasedRulesCommandInput, cb: (err: any, data?: ListRateBasedRulesCommandOutput) => void ): void; - public listRateBasedRules( + listRateBasedRules( args: ListRateBasedRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRateBasedRulesCommandOutput) => void ): void; - public listRateBasedRules( - args: ListRateBasedRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRateBasedRulesCommandOutput) => void), - cb?: (err: any, data?: ListRateBasedRulesCommandOutput) => void - ): Promise | void { - const command = new ListRateBasedRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of RegexMatchSetSummary objects.

+ * @see {@link ListRegexMatchSetsCommand} */ - public listRegexMatchSets( + listRegexMatchSets( args: ListRegexMatchSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRegexMatchSets( + listRegexMatchSets( args: ListRegexMatchSetsCommandInput, cb: (err: any, data?: ListRegexMatchSetsCommandOutput) => void ): void; - public listRegexMatchSets( + listRegexMatchSets( args: ListRegexMatchSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRegexMatchSetsCommandOutput) => void ): void; - public listRegexMatchSets( - args: ListRegexMatchSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRegexMatchSetsCommandOutput) => void), - cb?: (err: any, data?: ListRegexMatchSetsCommandOutput) => void - ): Promise | void { - const command = new ListRegexMatchSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of RegexPatternSetSummary objects.

+ * @see {@link ListRegexPatternSetsCommand} */ - public listRegexPatternSets( + listRegexPatternSets( args: ListRegexPatternSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRegexPatternSets( + listRegexPatternSets( args: ListRegexPatternSetsCommandInput, cb: (err: any, data?: ListRegexPatternSetsCommandOutput) => void ): void; - public listRegexPatternSets( + listRegexPatternSets( args: ListRegexPatternSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRegexPatternSetsCommandOutput) => void ): void; - public listRegexPatternSets( - args: ListRegexPatternSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRegexPatternSetsCommandOutput) => void), - cb?: (err: any, data?: ListRegexPatternSetsCommandOutput) => void - ): Promise | void { - const command = new ListRegexPatternSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of RuleGroup objects.

+ * @see {@link ListRuleGroupsCommand} */ - public listRuleGroups( + listRuleGroups( args: ListRuleGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRuleGroups( - args: ListRuleGroupsCommandInput, - cb: (err: any, data?: ListRuleGroupsCommandOutput) => void - ): void; - public listRuleGroups( + listRuleGroups(args: ListRuleGroupsCommandInput, cb: (err: any, data?: ListRuleGroupsCommandOutput) => void): void; + listRuleGroups( args: ListRuleGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRuleGroupsCommandOutput) => void ): void; - public listRuleGroups( - args: ListRuleGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRuleGroupsCommandOutput) => void), - cb?: (err: any, data?: ListRuleGroupsCommandOutput) => void - ): Promise | void { - const command = new ListRuleGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of RuleSummary objects.

+ * @see {@link ListRulesCommand} */ - public listRules(args: ListRulesCommandInput, options?: __HttpHandlerOptions): Promise; - public listRules(args: ListRulesCommandInput, cb: (err: any, data?: ListRulesCommandOutput) => void): void; - public listRules( + listRules(args: ListRulesCommandInput, options?: __HttpHandlerOptions): Promise; + listRules(args: ListRulesCommandInput, cb: (err: any, data?: ListRulesCommandOutput) => void): void; + listRules( args: ListRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRulesCommandOutput) => void ): void; - public listRules( - args: ListRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRulesCommandOutput) => void), - cb?: (err: any, data?: ListRulesCommandOutput) => void - ): Promise | void { - const command = new ListRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of SizeConstraintSetSummary objects.

+ * @see {@link ListSizeConstraintSetsCommand} */ - public listSizeConstraintSets( + listSizeConstraintSets( args: ListSizeConstraintSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSizeConstraintSets( + listSizeConstraintSets( args: ListSizeConstraintSetsCommandInput, cb: (err: any, data?: ListSizeConstraintSetsCommandOutput) => void ): void; - public listSizeConstraintSets( + listSizeConstraintSets( args: ListSizeConstraintSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSizeConstraintSetsCommandOutput) => void ): void; - public listSizeConstraintSets( - args: ListSizeConstraintSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSizeConstraintSetsCommandOutput) => void), - cb?: (err: any, data?: ListSizeConstraintSetsCommandOutput) => void - ): Promise | void { - const command = new ListSizeConstraintSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of SqlInjectionMatchSet objects.

+ * @see {@link ListSqlInjectionMatchSetsCommand} */ - public listSqlInjectionMatchSets( + listSqlInjectionMatchSets( args: ListSqlInjectionMatchSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSqlInjectionMatchSets( + listSqlInjectionMatchSets( args: ListSqlInjectionMatchSetsCommandInput, cb: (err: any, data?: ListSqlInjectionMatchSetsCommandOutput) => void ): void; - public listSqlInjectionMatchSets( + listSqlInjectionMatchSets( args: ListSqlInjectionMatchSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSqlInjectionMatchSetsCommandOutput) => void ): void; - public listSqlInjectionMatchSets( - args: ListSqlInjectionMatchSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSqlInjectionMatchSetsCommandOutput) => void), - cb?: (err: any, data?: ListSqlInjectionMatchSetsCommandOutput) => void - ): Promise | void { - const command = new ListSqlInjectionMatchSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of RuleGroup objects that you are subscribed to.

+ * @see {@link ListSubscribedRuleGroupsCommand} */ - public listSubscribedRuleGroups( + listSubscribedRuleGroups( args: ListSubscribedRuleGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listSubscribedRuleGroups( + listSubscribedRuleGroups( args: ListSubscribedRuleGroupsCommandInput, cb: (err: any, data?: ListSubscribedRuleGroupsCommandOutput) => void ): void; - public listSubscribedRuleGroups( + listSubscribedRuleGroups( args: ListSubscribedRuleGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSubscribedRuleGroupsCommandOutput) => void ): void; - public listSubscribedRuleGroups( - args: ListSubscribedRuleGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListSubscribedRuleGroupsCommandOutput) => void), - cb?: (err: any, data?: ListSubscribedRuleGroupsCommandOutput) => void - ): Promise | void { - const command = new ListSubscribedRuleGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Retrieves the tags associated with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

- *

Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of WebACLSummary objects in the response.

+ * @see {@link ListWebACLsCommand} */ - public listWebACLs(args: ListWebACLsCommandInput, options?: __HttpHandlerOptions): Promise; - public listWebACLs(args: ListWebACLsCommandInput, cb: (err: any, data?: ListWebACLsCommandOutput) => void): void; - public listWebACLs( + listWebACLs(args: ListWebACLsCommandInput, options?: __HttpHandlerOptions): Promise; + listWebACLs(args: ListWebACLsCommandInput, cb: (err: any, data?: ListWebACLsCommandOutput) => void): void; + listWebACLs( args: ListWebACLsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWebACLsCommandOutput) => void ): void; - public listWebACLs( - args: ListWebACLsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWebACLsCommandOutput) => void), - cb?: (err: any, data?: ListWebACLsCommandOutput) => void - ): Promise | void { - const command = new ListWebACLsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Returns an array of XssMatchSet objects.

+ * @see {@link ListXssMatchSetsCommand} */ - public listXssMatchSets( + listXssMatchSets( args: ListXssMatchSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listXssMatchSets( + listXssMatchSets( args: ListXssMatchSetsCommandInput, cb: (err: any, data?: ListXssMatchSetsCommandOutput) => void ): void; - public listXssMatchSets( + listXssMatchSets( args: ListXssMatchSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListXssMatchSetsCommandOutput) => void ): void; - public listXssMatchSets( - args: ListXssMatchSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListXssMatchSetsCommandOutput) => void), - cb?: (err: any, data?: ListXssMatchSetsCommandOutput) => void - ): Promise | void { - const command = new ListXssMatchSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Associates a LoggingConfiguration with a specified web ACL.

- *

You can access information about all traffic that AWS WAF inspects using the following - * steps:

- *
    - *
  1. - *

    Create an Amazon Kinesis Data - * Firehose.

    - *

    Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).

    - * - *

    Do not create the data firehose using a Kinesis stream as your source.

    - *
    - *
  2. - *
  3. - *

    Associate that firehose to your web ACL using a PutLoggingConfiguration request.

    - *
  4. - *
- * - *

When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.

+ * @see {@link PutLoggingConfigurationCommand} */ - public putLoggingConfiguration( + putLoggingConfiguration( args: PutLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putLoggingConfiguration( + putLoggingConfiguration( args: PutLoggingConfigurationCommandInput, cb: (err: any, data?: PutLoggingConfigurationCommandOutput) => void ): void; - public putLoggingConfiguration( + putLoggingConfiguration( args: PutLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLoggingConfigurationCommandOutput) => void ): void; - public putLoggingConfiguration( - args: PutLoggingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Attaches an IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts.

- *

The PutPermissionPolicy is subject to the following restrictions:

- *
    - *
  • - *

    You can attach only one policy with each PutPermissionPolicy request.

    - *
  • - *
  • - *

    The policy must include an Effect, Action and Principal.

    - *
  • - *
  • - * - *

    - * Effect must specify Allow.

    - *
  • - *
  • - *

    The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected.

    - *
  • - *
  • - *

    The policy cannot include a Resource parameter.

    - *
  • - *
  • - *

    The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.

    - *
  • - *
  • - *

    The user making the request must be the owner of the RuleGroup.

    - *
  • - *
  • - *

    Your policy must be composed using IAM Policy version 2012-10-17.

    - *
  • - *
- *

For more information, see IAM Policies.

- * - *

An example of a valid policy parameter is shown in the Examples section below.

+ * @see {@link PutPermissionPolicyCommand} */ - public putPermissionPolicy( + putPermissionPolicy( args: PutPermissionPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putPermissionPolicy( + putPermissionPolicy( args: PutPermissionPolicyCommandInput, cb: (err: any, data?: PutPermissionPolicyCommandOutput) => void ): void; - public putPermissionPolicy( + putPermissionPolicy( args: PutPermissionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPermissionPolicyCommandOutput) => void ): void; - public putPermissionPolicy( - args: PutPermissionPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutPermissionPolicyCommandOutput) => void), - cb?: (err: any, data?: PutPermissionPolicyCommandOutput) => void - ): Promise | void { - const command = new PutPermissionPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Associates tags with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

- *

Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can use this action to tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, - * you specify the following values:

- *
    - *
  • - *

    Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, - * you delete the existing object and add a new one.

    - *
  • - *
  • - *

    The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

    - *
  • - *
  • - *

    The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify - * the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type.

    - *
  • - *
  • - *

    Where to look, such as at the beginning or the end of a query string.

    - *
  • - *
  • - *

    Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

    - *
  • - *
- *

For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain - * the string BadBot. You can then configure AWS WAF to block those requests.

- *

To create and configure a ByteMatchSet, perform the following steps:

- *
    - *
  1. - *

    Create a ByteMatchSet. For more information, see CreateByteMatchSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateByteMatchSet request.

    - *
  4. - *
  5. - *

    Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect - * (for example, the header or the URI) and the value that you want AWS WAF to watch for.

    - *
  6. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link UpdateByteMatchSetCommand} */ - public updateByteMatchSet( + updateByteMatchSet( args: UpdateByteMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateByteMatchSet( + updateByteMatchSet( args: UpdateByteMatchSetCommandInput, cb: (err: any, data?: UpdateByteMatchSetCommandOutput) => void ): void; - public updateByteMatchSet( + updateByteMatchSet( args: UpdateByteMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateByteMatchSetCommandOutput) => void ): void; - public updateByteMatchSet( - args: UpdateByteMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateByteMatchSetCommandOutput) => void), - cb?: (err: any, data?: UpdateByteMatchSetCommandOutput) => void - ): Promise | void { - const command = new UpdateByteMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet. For each GeoMatchConstraint object, - * you specify the following values:

- *
    - *
  • - *

    Whether to insert or delete the object from the array. If you want to change an GeoMatchConstraint object, you delete the existing object and add a new one.

    - *
  • - *
  • - *

    The Type. The only valid value for Type is Country.

    - *
  • - *
  • - *

    The Value, which is a two character code for the country to add to the GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraint$Value.

    - *
  • - *
- * - *

To create and configure an GeoMatchSet, perform the following steps:

- *
    - *
  1. - *

    Submit a CreateGeoMatchSet request.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateGeoMatchSet request.

    - *
  4. - *
  5. - *

    Submit an UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch for.

    - *
  6. - *
- *

When you update an GeoMatchSet, you specify the country that you want to add and/or the country that you want to delete. - * If you want to change a country, you delete the existing country and add the new one.

- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link UpdateGeoMatchSetCommand} */ - public updateGeoMatchSet( + updateGeoMatchSet( args: UpdateGeoMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGeoMatchSet( + updateGeoMatchSet( args: UpdateGeoMatchSetCommandInput, cb: (err: any, data?: UpdateGeoMatchSetCommandOutput) => void ): void; - public updateGeoMatchSet( + updateGeoMatchSet( args: UpdateGeoMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGeoMatchSetCommandOutput) => void ): void; - public updateGeoMatchSet( - args: UpdateGeoMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGeoMatchSetCommandOutput) => void), - cb?: (err: any, data?: UpdateGeoMatchSetCommandOutput) => void - ): Promise | void { - const command = new UpdateGeoMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes IPSetDescriptor objects in an - * IPSet. For each IPSetDescriptor object, you specify the following - * values:

- *
    - *
  • - *

    Whether to insert or delete the object from the array. If you want to change an - * IPSetDescriptor object, you delete the existing object and add a new - * one.

    - *
  • - *
  • - *

    The IP address version, IPv4 or IPv6.

    - *
  • - *
  • - *

    The IP address in CIDR notation, for example, 192.0.2.0/24 (for - * the range of IP addresses from 192.0.2.0 to 192.0.2.255) or - * 192.0.2.44/32 (for the individual IP address - * 192.0.2.44).

    - *
  • - *
- *

AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS - * WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more - * information about CIDR notation, see the Wikipedia entry Classless - * Inter-Domain Routing.

- *

IPv6 addresses can be represented using any of the following formats:

- *
    - *
  • - *

    1111:0000:0000:0000:0000:0000:0000:0111/128

    - *
  • - *
  • - *

    1111:0:0:0:0:0:0:0111/128

    - *
  • - *
  • - *

    1111::0111/128

    - *
  • - *
  • - *

    1111::111/128

    - *
  • - *
- *

You use an IPSet to specify which web requests you want to allow or - * block based on the IP addresses that the requests originated from. For example, if you're - * receiving a lot of requests from one or a small number of IP addresses and you want to - * block the requests, you can create an IPSet that specifies those IP addresses, - * and then configure AWS WAF to block the requests.

- *

To create and configure an IPSet, perform the following steps:

- *
    - *
  1. - *

    Submit a CreateIPSet request.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide - * in the ChangeToken parameter of an UpdateIPSet - * request.

    - *
  4. - *
  5. - *

    Submit an UpdateIPSet request to specify the IP addresses that you - * want AWS WAF to watch for.

    - *
  6. - *
- *

When you update an IPSet, you specify the IP addresses that you want to - * add and/or the IP addresses that you want to delete. If you want to change an IP address, - * you delete the existing IP address and add the new one.

- *

You can insert a maximum of 1000 addresses in a single - * request.

- *

For more information about how to use the AWS WAF API to allow or block HTTP - * requests, see the AWS WAF - * Developer Guide.

+ * @see {@link UpdateIPSetCommand} */ - public updateIPSet(args: UpdateIPSetCommandInput, options?: __HttpHandlerOptions): Promise; - public updateIPSet(args: UpdateIPSetCommandInput, cb: (err: any, data?: UpdateIPSetCommandOutput) => void): void; - public updateIPSet( + updateIPSet(args: UpdateIPSetCommandInput, options?: __HttpHandlerOptions): Promise; + updateIPSet(args: UpdateIPSetCommandInput, cb: (err: any, data?: UpdateIPSetCommandOutput) => void): void; + updateIPSet( args: UpdateIPSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIPSetCommandOutput) => void ): void; - public updateIPSet( - args: UpdateIPSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateIPSetCommandOutput) => void), - cb?: (err: any, data?: UpdateIPSetCommandOutput) => void - ): Promise | void { - const command = new UpdateIPSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes Predicate objects in a rule and updates the - * RateLimit in the rule.

- *

Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests - * that you want to block or count. The RateLimit specifies the number of - * requests every five minutes that triggers the rule.

- *

If you add more than one predicate to a RateBasedRule, a request must - * match all the predicates and exceed the RateLimit to be counted or blocked. - * For example, suppose you add the following to a RateBasedRule:

- *
    - *
  • - *

    An IPSet that matches the IP address 192.0.2.44/32 - *

    - *
  • - *
  • - *

    A ByteMatchSet that matches BadBot in the - * User-Agent header

    - *
  • - *
- *

Further, you specify a - * RateLimit of 1,000.

- *

You then add the RateBasedRule to a WebACL and specify that - * you want to block requests that satisfy the rule. For a request to be blocked, it must come - * from the IP address 192.0.2.44 and the User-Agent header - * in the request must contain the value BadBot. Further, requests that match - * these two conditions much be received at a rate of more than 1,000 every five minutes. If - * the rate drops below this limit, AWS WAF no longer blocks the requests.

- * - *

As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a - * RateBasedRule:

- * - * - *
    - *
  • - *

    A ByteMatchSet with FieldToMatch of URI - *

    - *
  • - *
  • - *

    A PositionalConstraint of STARTS_WITH - *

    - *
  • - *
  • - *

    A TargetString of login - *

    - *
  • - *
- *

Further, you specify a RateLimit of 1,000.

- *

By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site.

+ * @see {@link UpdateRateBasedRuleCommand} */ - public updateRateBasedRule( + updateRateBasedRule( args: UpdateRateBasedRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRateBasedRule( + updateRateBasedRule( args: UpdateRateBasedRuleCommandInput, cb: (err: any, data?: UpdateRateBasedRuleCommandOutput) => void ): void; - public updateRateBasedRule( + updateRateBasedRule( args: UpdateRateBasedRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRateBasedRuleCommandOutput) => void ): void; - public updateRateBasedRule( - args: UpdateRateBasedRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRateBasedRuleCommandOutput) => void), - cb?: (err: any, data?: UpdateRateBasedRuleCommandOutput) => void - ): Promise | void { - const command = new UpdateRateBasedRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each RegexMatchSetUpdate object, - * you specify the following values:

- *
    - *
  • - *

    Whether to insert or delete the object from the array. If you want to change a RegexMatchSetUpdate object, - * you delete the existing object and add a new one.

    - *
  • - *
  • - *

    The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the User-Agent header.

    - *
  • - *
  • - *

    The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

    - *
  • - *
  • - *

    Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

    - *
  • - *
- *

For example, you can create a RegexPatternSet that matches any requests with User-Agent headers - * that contain the string B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

- *

To create and configure a RegexMatchSet, perform the following steps:

- *
    - *
  1. - *

    Create a RegexMatchSet. For more information, see CreateRegexMatchSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateRegexMatchSet request.

    - *
  4. - *
  5. - *

    Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect - * (for example, the header or the URI) and the identifier of the RegexPatternSet that contain the regular expression patters you want AWS WAF to watch for.

    - *
  6. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link UpdateRegexMatchSetCommand} */ - public updateRegexMatchSet( + updateRegexMatchSet( args: UpdateRegexMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRegexMatchSet( + updateRegexMatchSet( args: UpdateRegexMatchSetCommandInput, cb: (err: any, data?: UpdateRegexMatchSetCommandOutput) => void ): void; - public updateRegexMatchSet( + updateRegexMatchSet( args: UpdateRegexMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRegexMatchSetCommandOutput) => void ): void; - public updateRegexMatchSet( - args: UpdateRegexMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRegexMatchSetCommandOutput) => void), - cb?: (err: any, data?: UpdateRegexMatchSetCommandOutput) => void - ): Promise | void { - const command = new UpdateRegexMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes RegexPatternString objects in a RegexPatternSet. For each RegexPatternString object, - * you specify the following values:

- *
    - *
  • - *

    Whether to insert or delete the RegexPatternString.

    - *
  • - *
  • - *

    The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet.

    - *
  • - *
- *

For example, you can create a RegexPatternString such as B[a@]dB[o0]t. AWS WAF will match this RegexPatternString to:

- *
    - *
  • - *

    BadBot

    - *
  • - *
  • - *

    BadB0t

    - *
  • - *
  • - *

    B@dBot

    - *
  • - *
  • - *

    B@dB0t

    - *
  • - *
- *

To create and configure a RegexPatternSet, perform the following steps:

- *
    - *
  1. - *

    Create a RegexPatternSet. For more information, see CreateRegexPatternSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateRegexPatternSet request.

    - *
  4. - *
  5. - *

    Submit an UpdateRegexPatternSet request to specify the regular expression pattern that you want AWS WAF to watch for.

    - *
  6. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link UpdateRegexPatternSetCommand} */ - public updateRegexPatternSet( + updateRegexPatternSet( args: UpdateRegexPatternSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRegexPatternSet( + updateRegexPatternSet( args: UpdateRegexPatternSetCommandInput, cb: (err: any, data?: UpdateRegexPatternSetCommandOutput) => void ): void; - public updateRegexPatternSet( + updateRegexPatternSet( args: UpdateRegexPatternSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRegexPatternSetCommandOutput) => void ): void; - public updateRegexPatternSet( - args: UpdateRegexPatternSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRegexPatternSetCommandOutput) => void), - cb?: (err: any, data?: UpdateRegexPatternSetCommandOutput) => void - ): Promise | void { - const command = new UpdateRegexPatternSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes Predicate objects in a Rule. Each - * Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests - * that you want to allow, block, or count. If you add more than one predicate to a - * Rule, a request must match all of the specifications to be allowed, - * blocked, or counted. For example, suppose - * that - * you add the following to a Rule:

- *
    - *
  • - *

    A ByteMatchSet that matches the value BadBot in the User-Agent header

    - *
  • - *
  • - *

    An IPSet that matches the IP address 192.0.2.44 - *

    - *
  • - *
- *

You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. - * For a request to be blocked, the User-Agent header in the request must contain the value BadBot - * and the request must originate from the IP address 192.0.2.44.

- *

To create and configure a Rule, perform the following steps:

- *
    - *
  1. - *

    Create and update the predicates that you want to include in the Rule.

    - *
  2. - *
  3. - *

    Create the Rule. See CreateRule.

    - *
  4. - *
  5. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateRule request.

    - *
  6. - *
  7. - *

    Submit an UpdateRule request to add predicates to the Rule.

    - *
  8. - *
  9. - *

    Create and update a WebACL that contains the Rule. See CreateWebACL.

    - *
  10. - *
- *

If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and - * add the new one.

- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link UpdateRuleCommand} */ - public updateRule(args: UpdateRuleCommandInput, options?: __HttpHandlerOptions): Promise; - public updateRule(args: UpdateRuleCommandInput, cb: (err: any, data?: UpdateRuleCommandOutput) => void): void; - public updateRule( + updateRule(args: UpdateRuleCommandInput, options?: __HttpHandlerOptions): Promise; + updateRule(args: UpdateRuleCommandInput, cb: (err: any, data?: UpdateRuleCommandOutput) => void): void; + updateRule( args: UpdateRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRuleCommandOutput) => void ): void; - public updateRule( - args: UpdateRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRuleCommandOutput) => void), - cb?: (err: any, data?: UpdateRuleCommandOutput) => void - ): Promise | void { - const command = new UpdateRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes ActivatedRule objects in a RuleGroup.

- *

You can only insert REGULAR rules into a rule group.

- *

You can have a maximum of ten rules per rule group.

- * - * - *

To create and configure a RuleGroup, perform the following steps:

- *
    - *
  1. - *

    Create and update the Rules that you want to include in the RuleGroup. See CreateRule.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateRuleGroup request.

    - *
  4. - *
  5. - *

    Submit an UpdateRuleGroup request to add Rules to the RuleGroup.

    - *
  6. - *
  7. - *

    Create and update a WebACL that contains the RuleGroup. See CreateWebACL.

    - *
  8. - *
- *

If you want to replace one Rule with another, you delete the existing one and - * add the new one.

- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link UpdateRuleGroupCommand} */ - public updateRuleGroup( + updateRuleGroup( args: UpdateRuleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRuleGroup( - args: UpdateRuleGroupCommandInput, - cb: (err: any, data?: UpdateRuleGroupCommandOutput) => void - ): void; - public updateRuleGroup( + updateRuleGroup(args: UpdateRuleGroupCommandInput, cb: (err: any, data?: UpdateRuleGroupCommandOutput) => void): void; + updateRuleGroup( args: UpdateRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRuleGroupCommandOutput) => void ): void; - public updateRuleGroup( - args: UpdateRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRuleGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateRuleGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, - * you specify the following values:

- *
    - *
  • - *

    Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, - * you delete the existing object and add a new one.

    - *
  • - *
  • - *

    The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the - * User-Agent header.

    - *
  • - *
  • - *

    Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. - * Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes - * of your request to AWS WAF.

    - *

    You can only specify a single type of TextTransformation.

    - *
  • - *
  • - *

    A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as - * equals, greater than, less than, and so on.

    - *
  • - *
  • - *

    The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation.

    - *
  • - *
- *

For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the - * User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests.

- *

To create and configure a SizeConstraintSet, perform the following steps:

- *
    - *
  1. - *

    Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateSizeConstraintSet request.

    - *
  4. - *
  5. - *

    Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect - * (for example, the header or the URI) and the value that you want AWS WAF to watch for.

    - *
  6. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link UpdateSizeConstraintSetCommand} */ - public updateSizeConstraintSet( + updateSizeConstraintSet( args: UpdateSizeConstraintSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSizeConstraintSet( + updateSizeConstraintSet( args: UpdateSizeConstraintSetCommandInput, cb: (err: any, data?: UpdateSizeConstraintSetCommandOutput) => void ): void; - public updateSizeConstraintSet( + updateSizeConstraintSet( args: UpdateSizeConstraintSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSizeConstraintSetCommandOutput) => void ): void; - public updateSizeConstraintSet( - args: UpdateSizeConstraintSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSizeConstraintSetCommandOutput) => void), - cb?: (err: any, data?: UpdateSizeConstraintSetCommandOutput) => void - ): Promise | void { - const command = new UpdateSizeConstraintSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. - * For each SqlInjectionMatchTuple object, you specify the following values:

- *
    - *
  • - *

    - * Action: Whether to insert the object into or delete the object from the array. To change a - * SqlInjectionMatchTuple, you delete the existing object and add a new one.

    - *
  • - *
  • - *

    - * FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, - * the name of the header or parameter.

    - *
  • - *
  • - *

    - * TextTransformation: Which text transformation, if any, to perform on the web request before - * inspecting the request for snippets of malicious SQL code.

    - *

    You can only specify a single type of TextTransformation.

    - *
  • - *
- *

You use SqlInjectionMatchSet objects to specify which CloudFront - * requests that - * you want to allow, block, or count. For example, if you're receiving - * requests that contain snippets of SQL code in the query string and you want to block the - * requests, you can create a SqlInjectionMatchSet with the applicable settings, - * and then configure AWS WAF to block the requests.

- *

To create and configure a SqlInjectionMatchSet, perform the following steps:

- *
    - *
  1. - *

    Submit a CreateSqlInjectionMatchSet request.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateIPSet request.

    - *
  4. - *
  5. - *

    Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to - * inspect for snippets of SQL code.

    - *
  6. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link UpdateSqlInjectionMatchSetCommand} */ - public updateSqlInjectionMatchSet( + updateSqlInjectionMatchSet( args: UpdateSqlInjectionMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSqlInjectionMatchSet( + updateSqlInjectionMatchSet( args: UpdateSqlInjectionMatchSetCommandInput, cb: (err: any, data?: UpdateSqlInjectionMatchSetCommandOutput) => void ): void; - public updateSqlInjectionMatchSet( + updateSqlInjectionMatchSet( args: UpdateSqlInjectionMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSqlInjectionMatchSetCommandOutput) => void ): void; - public updateSqlInjectionMatchSet( - args: UpdateSqlInjectionMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSqlInjectionMatchSetCommandOutput) => void), - cb?: (err: any, data?: UpdateSqlInjectionMatchSetCommandOutput) => void - ): Promise | void { - const command = new UpdateSqlInjectionMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies - * web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values:

- *
    - *
  • - *

    A default action for the WebACL, either ALLOW or BLOCK. - * AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL.

    - *
  • - *
  • - *

    The Rules that you want to add - * or - * delete. If you want to replace one Rule with another, you delete the - * existing Rule and add the new one.

    - *
  • - *
  • - *

    For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match - * the conditions in the Rule.

    - *
  • - *
  • - *

    The order in which you want AWS WAF to evaluate the Rules in a - * WebACL. If you add more than one Rule to a - * WebACL, AWS WAF evaluates each request against the Rules - * in order based on the value of Priority. (The Rule that has - * the lowest value for Priority is evaluated first.) When a web request - * matches all - * the - * predicates (such as ByteMatchSets and IPSets) in a - * Rule, AWS WAF immediately takes the corresponding action, allow or - * block, and doesn't evaluate the request against the remaining Rules in - * the WebACL, if any.

    - *
  • - *
- * - *

To create and configure a WebACL, perform the following steps:

- *
    - *
  1. - *

    Create and update the predicates that you want to include in Rules. - * For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, - * CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.

    - *
  2. - *
  3. - *

    Create and update the Rules that you want to include in the WebACL. For more information, see - * CreateRule and UpdateRule.

    - *
  4. - *
  5. - *

    Create a WebACL. See CreateWebACL.

    - *
  6. - *
  7. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateWebACL request.

    - *
  8. - *
  9. - *

    Submit an UpdateWebACL request to specify the Rules - * that you want to include in the WebACL, to specify the default action, - * and to associate the WebACL with a CloudFront distribution.

    - *

    The ActivatedRule can be a rule group. If you specify a rule group - * as your - * ActivatedRule - * , - * you can exclude specific rules from that rule group.

    - *

    If you already have a rule group associated with a web ACL and want to submit - * an UpdateWebACL request to exclude certain rules from that rule group, - * you must first remove the rule group from the web ACL, the re-insert it again, - * specifying the excluded rules. - * For details, - * see - * ActivatedRule$ExcludedRules - * . - *

    - *
  10. - *
- *

Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist.

- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

+ * @see {@link UpdateWebACLCommand} */ - public updateWebACL( - args: UpdateWebACLCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateWebACL(args: UpdateWebACLCommandInput, cb: (err: any, data?: UpdateWebACLCommandOutput) => void): void; - public updateWebACL( + updateWebACL(args: UpdateWebACLCommandInput, options?: __HttpHandlerOptions): Promise; + updateWebACL(args: UpdateWebACLCommandInput, cb: (err: any, data?: UpdateWebACLCommandOutput) => void): void; + updateWebACL( args: UpdateWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWebACLCommandOutput) => void ): void; - public updateWebACL( - args: UpdateWebACLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWebACLCommandOutput) => void), - cb?: (err: any, data?: UpdateWebACLCommandOutput) => void - ): Promise | void { - const command = new UpdateWebACLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * - *

This is AWS WAF Classic documentation. For - * more information, see AWS - * WAF Classic in the developer guide.

- *

- * For the latest version of AWS - * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

- *
- *

Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. - * For each XssMatchTuple object, you specify the following values:

- *
    - *
  • - *

    - * Action: Whether to insert the object into or delete the object from the - * array. To change an - * XssMatchTuple, you delete the existing object and add a new - * one.

    - *
  • - *
  • - *

    - * FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, - * the name of the header or parameter.

    - *
  • - *
  • - *

    - * TextTransformation: Which text transformation, if any, to perform on the web request before - * inspecting the request for cross-site scripting attacks.

    - *

    You can only specify a single type of TextTransformation.

    - *
  • - *
- *

You use XssMatchSet objects to specify which CloudFront requests - * that - * you want to allow, block, or count. For example, if you're receiving - * requests that contain cross-site scripting attacks in the request body and you want to - * block the requests, you can create an XssMatchSet with the applicable - * settings, and then configure AWS WAF to block the requests.

- *

To create and configure an XssMatchSet, perform the following steps:

- *
    - *
  1. - *

    Submit a CreateXssMatchSet request.

    - *
  2. - *
  3. - *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an - * UpdateIPSet request.

    - *
  4. - *
  5. - *

    Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to - * inspect for cross-site scripting attacks.

    - *
  6. - *
- *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the - * AWS WAF Developer Guide.

+ * @see {@link UpdateXssMatchSetCommand} */ - public updateXssMatchSet( + updateXssMatchSet( args: UpdateXssMatchSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateXssMatchSet( + updateXssMatchSet( args: UpdateXssMatchSetCommandInput, cb: (err: any, data?: UpdateXssMatchSetCommandOutput) => void ): void; - public updateXssMatchSet( + updateXssMatchSet( args: UpdateXssMatchSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateXssMatchSetCommandOutput) => void ): void; - public updateXssMatchSet( - args: UpdateXssMatchSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateXssMatchSetCommandOutput) => void), - cb?: (err: any, data?: UpdateXssMatchSetCommandOutput) => void - ): Promise | void { - const command = new UpdateXssMatchSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * + *

This is AWS WAF Classic documentation. For + * more information, see AWS + * WAF Classic in the developer guide.

+ *

+ * For the latest version of AWS + * WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

+ *
+ *

This is the AWS WAF Classic API Reference for using AWS WAF Classic with Amazon CloudFront. The AWS WAF Classic actions and data types listed in the reference are available for protecting Amazon CloudFront distributions. You can use these actions and data types via the endpoint waf.amazonaws.com. This guide is for developers who need detailed information about the AWS WAF Classic API actions, + * data types, and errors. For detailed information about AWS WAF Classic features and an overview of how to use the AWS WAF Classic API, see the + * AWS WAF Classic in the developer guide.

+ */ +export class WAF extends WAFClient implements WAF {} +createAggregatedClient(commands, WAF); diff --git a/clients/client-wafv2/src/WAFV2.ts b/clients/client-wafv2/src/WAFV2.ts index d7783e61b1a5..258b0f1c0f51 100644 --- a/clients/client-wafv2/src/WAFV2.ts +++ b/clients/client-wafv2/src/WAFV2.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -209,1869 +210,838 @@ import { UpdateWebACLCommandInput, UpdateWebACLCommandOutput, } from "./commands/UpdateWebACLCommand"; -import { WAFV2Client } from "./WAFV2Client"; +import { WAFV2Client, WAFV2ClientConfig } from "./WAFV2Client"; -/** - * @public - * WAF - * - *

This is the latest version of the WAF API, - * released in November, 2019. The names of the entities that you use to access this API, - * like endpoints and namespaces, all have the versioning information added, like "V2" or - * "v2", to distinguish from the prior version. We recommend migrating your resources to - * this version, because it has a number of significant improvements.

- *

If you used WAF prior to this release, you can't use this WAFV2 API to access any - * WAF resources that you created before. You can access your old rules, web ACLs, and - * other WAF resources only through the WAF Classic APIs. The WAF Classic APIs - * have retained the prior names, endpoints, and namespaces.

- *

For information, including how to migrate your WAF resources to this version, - * see the WAF Developer Guide.

- *
- *

WAF is a web application firewall that lets you monitor the HTTP and HTTPS - * requests that are forwarded to an Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync - * GraphQL API, Amazon Cognito user pool, or App Runner service. WAF also lets you control access to your content, - * to protect the Amazon Web Services resource that WAF is monitoring. Based on conditions that - * you specify, such as the IP addresses that requests originate from or the values of query - * strings, the protected resource responds to requests with either the requested content, an HTTP 403 status code - * (Forbidden), or with a custom response.

- *

This API guide is for developers who need detailed information about WAF API actions, - * data types, and errors. For detailed information about WAF features and guidance for configuring and using - * WAF, see the WAF Developer - * Guide.

- *

You can make calls using the endpoints listed in WAF endpoints and quotas.

- *
    - *
  • - *

    For regional applications, you can use any of the endpoints in the list. - * A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

    - *
  • - *
  • - *

    For Amazon CloudFront applications, you must use the API endpoint listed for - * US East (N. Virginia): us-east-1.

    - *
  • - *
- *

Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the - * programming language or platform that you're using. For more information, see Amazon Web Services SDKs.

- *

We currently provide two versions of the WAF API: this API and the prior versions, - * the classic WAF APIs. This new API provides the same functionality as the older versions, - * with the following major improvements:

- *
    - *
  • - *

    You use one API for both global and regional applications. Where you need to - * distinguish the scope, you specify a Scope parameter and set it to - * CLOUDFRONT or REGIONAL.

    - *
  • - *
  • - *

    You can define a web ACL or rule group with a single call, and update it with a - * single call. You define all rule specifications in JSON format, and pass them to your - * rule group or web ACL calls.

    - *
  • - *
  • - *

    The limits WAF places on the use of rules more closely reflects the cost of - * running each type of rule. Rule groups include capacity settings, so you know the - * maximum cost of a rule group when you use it.

    - *
  • - *
- */ -export class WAFV2 extends WAFV2Client { +const commands = { + AssociateWebACLCommand, + CheckCapacityCommand, + CreateIPSetCommand, + CreateRegexPatternSetCommand, + CreateRuleGroupCommand, + CreateWebACLCommand, + DeleteFirewallManagerRuleGroupsCommand, + DeleteIPSetCommand, + DeleteLoggingConfigurationCommand, + DeletePermissionPolicyCommand, + DeleteRegexPatternSetCommand, + DeleteRuleGroupCommand, + DeleteWebACLCommand, + DescribeManagedRuleGroupCommand, + DisassociateWebACLCommand, + GenerateMobileSdkReleaseUrlCommand, + GetIPSetCommand, + GetLoggingConfigurationCommand, + GetManagedRuleSetCommand, + GetMobileSdkReleaseCommand, + GetPermissionPolicyCommand, + GetRateBasedStatementManagedKeysCommand, + GetRegexPatternSetCommand, + GetRuleGroupCommand, + GetSampledRequestsCommand, + GetWebACLCommand, + GetWebACLForResourceCommand, + ListAvailableManagedRuleGroupsCommand, + ListAvailableManagedRuleGroupVersionsCommand, + ListIPSetsCommand, + ListLoggingConfigurationsCommand, + ListManagedRuleSetsCommand, + ListMobileSdkReleasesCommand, + ListRegexPatternSetsCommand, + ListResourcesForWebACLCommand, + ListRuleGroupsCommand, + ListTagsForResourceCommand, + ListWebACLsCommand, + PutLoggingConfigurationCommand, + PutManagedRuleSetVersionsCommand, + PutPermissionPolicyCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateIPSetCommand, + UpdateManagedRuleSetVersionExpiryDateCommand, + UpdateRegexPatternSetCommand, + UpdateRuleGroupCommand, + UpdateWebACLCommand, +}; + +export interface WAFV2 { /** - * @public - *

Associates a web ACL with a regional application resource, to protect the resource. - * A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

- *

For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To - * associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID - * to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution in the Amazon CloudFront Developer Guide.

- *

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

+ * @see {@link AssociateWebACLCommand} */ - public associateWebACL( + associateWebACL( args: AssociateWebACLCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateWebACL( - args: AssociateWebACLCommandInput, - cb: (err: any, data?: AssociateWebACLCommandOutput) => void - ): void; - public associateWebACL( + associateWebACL(args: AssociateWebACLCommandInput, cb: (err: any, data?: AssociateWebACLCommandOutput) => void): void; + associateWebACL( args: AssociateWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateWebACLCommandOutput) => void ): void; - public associateWebACL( - args: AssociateWebACLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateWebACLCommandOutput) => void), - cb?: (err: any, data?: AssociateWebACLCommandOutput) => void - ): Promise | void { - const command = new AssociateWebACLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. - * You can use this to check the capacity requirements for the rules you want to use in a - * RuleGroup or WebACL. - *

- *

WAF uses WCUs to calculate and control the operating - * resources that are used to run your rules, rule groups, and web ACLs. WAF - * calculates capacity differently for each rule type, to reflect the relative cost of each rule. - * Simple rules that cost little to run use fewer WCUs than more complex rules - * that use more processing power. - * Rule group capacity is fixed at creation, which helps users plan their - * web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) - * in the WAF Developer Guide.

+ * @see {@link CheckCapacityCommand} */ - public checkCapacity( - args: CheckCapacityCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public checkCapacity( - args: CheckCapacityCommandInput, - cb: (err: any, data?: CheckCapacityCommandOutput) => void - ): void; - public checkCapacity( + checkCapacity(args: CheckCapacityCommandInput, options?: __HttpHandlerOptions): Promise; + checkCapacity(args: CheckCapacityCommandInput, cb: (err: any, data?: CheckCapacityCommandOutput) => void): void; + checkCapacity( args: CheckCapacityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CheckCapacityCommandOutput) => void ): void; - public checkCapacity( - args: CheckCapacityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CheckCapacityCommandOutput) => void), - cb?: (err: any, data?: CheckCapacityCommandOutput) => void - ): Promise | void { - const command = new CheckCapacityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an IPSet, which you use to identify web requests that - * originate from specific IP addresses or ranges of IP addresses. For example, if you're - * receiving a lot of requests from a ranges of IP addresses, you can configure WAF to - * block them using an IPSet that lists those IP addresses.

+ * @see {@link CreateIPSetCommand} */ - public createIPSet(args: CreateIPSetCommandInput, options?: __HttpHandlerOptions): Promise; - public createIPSet(args: CreateIPSetCommandInput, cb: (err: any, data?: CreateIPSetCommandOutput) => void): void; - public createIPSet( + createIPSet(args: CreateIPSetCommandInput, options?: __HttpHandlerOptions): Promise; + createIPSet(args: CreateIPSetCommandInput, cb: (err: any, data?: CreateIPSetCommandOutput) => void): void; + createIPSet( args: CreateIPSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIPSetCommandOutput) => void ): void; - public createIPSet( - args: CreateIPSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIPSetCommandOutput) => void), - cb?: (err: any, data?: CreateIPSetCommandOutput) => void - ): Promise | void { - const command = new CreateIPSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request - * component for the specified patterns.

+ * @see {@link CreateRegexPatternSetCommand} */ - public createRegexPatternSet( + createRegexPatternSet( args: CreateRegexPatternSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRegexPatternSet( + createRegexPatternSet( args: CreateRegexPatternSetCommandInput, cb: (err: any, data?: CreateRegexPatternSetCommandOutput) => void ): void; - public createRegexPatternSet( + createRegexPatternSet( args: CreateRegexPatternSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRegexPatternSetCommandOutput) => void ): void; - public createRegexPatternSet( - args: CreateRegexPatternSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRegexPatternSetCommandOutput) => void), - cb?: (err: any, data?: CreateRegexPatternSetCommandOutput) => void - ): Promise | void { - const command = new CreateRegexPatternSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a RuleGroup per the specifications provided.

- *

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

+ * @see {@link CreateRuleGroupCommand} */ - public createRuleGroup( + createRuleGroup( args: CreateRuleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public createRuleGroup( - args: CreateRuleGroupCommandInput, - cb: (err: any, data?: CreateRuleGroupCommandOutput) => void - ): void; - public createRuleGroup( + createRuleGroup(args: CreateRuleGroupCommandInput, cb: (err: any, data?: CreateRuleGroupCommandOutput) => void): void; + createRuleGroup( args: CreateRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRuleGroupCommandOutput) => void ): void; - public createRuleGroup( - args: CreateRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateRuleGroupCommandOutput) => void), - cb?: (err: any, data?: CreateRuleGroupCommandOutput) => void - ): Promise | void { - const command = new CreateRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a WebACL per the specifications provided.

- *

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

+ * @see {@link CreateWebACLCommand} */ - public createWebACL( - args: CreateWebACLCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createWebACL(args: CreateWebACLCommandInput, cb: (err: any, data?: CreateWebACLCommandOutput) => void): void; - public createWebACL( + createWebACL(args: CreateWebACLCommandInput, options?: __HttpHandlerOptions): Promise; + createWebACL(args: CreateWebACLCommandInput, cb: (err: any, data?: CreateWebACLCommandOutput) => void): void; + createWebACL( args: CreateWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWebACLCommandOutput) => void ): void; - public createWebACL( - args: CreateWebACLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWebACLCommandOutput) => void), - cb?: (err: any, data?: CreateWebACLCommandOutput) => void - ): Promise | void { - const command = new CreateWebACLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.

- *

You can only use this if ManagedByFirewallManager is false in the specified - * WebACL.

+ * @see {@link DeleteFirewallManagerRuleGroupsCommand} */ - public deleteFirewallManagerRuleGroups( + deleteFirewallManagerRuleGroups( args: DeleteFirewallManagerRuleGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFirewallManagerRuleGroups( + deleteFirewallManagerRuleGroups( args: DeleteFirewallManagerRuleGroupsCommandInput, cb: (err: any, data?: DeleteFirewallManagerRuleGroupsCommandOutput) => void ): void; - public deleteFirewallManagerRuleGroups( + deleteFirewallManagerRuleGroups( args: DeleteFirewallManagerRuleGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFirewallManagerRuleGroupsCommandOutput) => void ): void; - public deleteFirewallManagerRuleGroups( - args: DeleteFirewallManagerRuleGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFirewallManagerRuleGroupsCommandOutput) => void), - cb?: (err: any, data?: DeleteFirewallManagerRuleGroupsCommandOutput) => void - ): Promise | void { - const command = new DeleteFirewallManagerRuleGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified IPSet.

+ * @see {@link DeleteIPSetCommand} */ - public deleteIPSet(args: DeleteIPSetCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteIPSet(args: DeleteIPSetCommandInput, cb: (err: any, data?: DeleteIPSetCommandOutput) => void): void; - public deleteIPSet( + deleteIPSet(args: DeleteIPSetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteIPSet(args: DeleteIPSetCommandInput, cb: (err: any, data?: DeleteIPSetCommandOutput) => void): void; + deleteIPSet( args: DeleteIPSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIPSetCommandOutput) => void ): void; - public deleteIPSet( - args: DeleteIPSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIPSetCommandOutput) => void), - cb?: (err: any, data?: DeleteIPSetCommandOutput) => void - ): Promise | void { - const command = new DeleteIPSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the LoggingConfiguration from the specified web ACL.

+ * @see {@link DeleteLoggingConfigurationCommand} */ - public deleteLoggingConfiguration( + deleteLoggingConfiguration( args: DeleteLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLoggingConfiguration( + deleteLoggingConfiguration( args: DeleteLoggingConfigurationCommandInput, cb: (err: any, data?: DeleteLoggingConfigurationCommandOutput) => void ): void; - public deleteLoggingConfiguration( + deleteLoggingConfiguration( args: DeleteLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLoggingConfigurationCommandOutput) => void ): void; - public deleteLoggingConfiguration( - args: DeleteLoggingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Permanently deletes an IAM policy from the specified rule group.

- *

You must be the owner of the rule group to perform this operation.

+ * @see {@link DeletePermissionPolicyCommand} */ - public deletePermissionPolicy( + deletePermissionPolicy( args: DeletePermissionPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deletePermissionPolicy( + deletePermissionPolicy( args: DeletePermissionPolicyCommandInput, cb: (err: any, data?: DeletePermissionPolicyCommandOutput) => void ): void; - public deletePermissionPolicy( + deletePermissionPolicy( args: DeletePermissionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePermissionPolicyCommandOutput) => void ): void; - public deletePermissionPolicy( - args: DeletePermissionPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePermissionPolicyCommandOutput) => void), - cb?: (err: any, data?: DeletePermissionPolicyCommandOutput) => void - ): Promise | void { - const command = new DeletePermissionPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified RegexPatternSet.

+ * @see {@link DeleteRegexPatternSetCommand} */ - public deleteRegexPatternSet( + deleteRegexPatternSet( args: DeleteRegexPatternSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRegexPatternSet( + deleteRegexPatternSet( args: DeleteRegexPatternSetCommandInput, cb: (err: any, data?: DeleteRegexPatternSetCommandOutput) => void ): void; - public deleteRegexPatternSet( + deleteRegexPatternSet( args: DeleteRegexPatternSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRegexPatternSetCommandOutput) => void ): void; - public deleteRegexPatternSet( - args: DeleteRegexPatternSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRegexPatternSetCommandOutput) => void), - cb?: (err: any, data?: DeleteRegexPatternSetCommandOutput) => void - ): Promise | void { - const command = new DeleteRegexPatternSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified RuleGroup.

+ * @see {@link DeleteRuleGroupCommand} */ - public deleteRuleGroup( + deleteRuleGroup( args: DeleteRuleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRuleGroup( - args: DeleteRuleGroupCommandInput, - cb: (err: any, data?: DeleteRuleGroupCommandOutput) => void - ): void; - public deleteRuleGroup( + deleteRuleGroup(args: DeleteRuleGroupCommandInput, cb: (err: any, data?: DeleteRuleGroupCommandOutput) => void): void; + deleteRuleGroup( args: DeleteRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRuleGroupCommandOutput) => void ): void; - public deleteRuleGroup( - args: DeleteRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRuleGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteRuleGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified WebACL.

- *

You can only use this if ManagedByFirewallManager is false in the specified - * WebACL.

- * - *

Before deleting any web ACL, first disassociate it from all resources.

- *
    - *
  • - *

    To retrieve a list of the resources that are associated with a web ACL, use the - * following calls:

    - *
      - *
    • - *

      For regional resources, call ListResourcesForWebACL.

      - *
    • - *
    • - *

      For Amazon CloudFront distributions, use the CloudFront call - * ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId - * in the Amazon CloudFront API Reference.

      - *
    • - *
    - *
  • - *
  • - *

    To disassociate a resource from a web ACL, use the following calls:

    - *
      - *
    • - *

      For regional resources, call DisassociateWebACL.

      - *
    • - *
    • - *

      For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call - * UpdateDistribution. For information, see UpdateDistribution - * in the Amazon CloudFront API Reference.

      - *
    • - *
    - *
  • - *
- *
+ * @see {@link DeleteWebACLCommand} */ - public deleteWebACL( - args: DeleteWebACLCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteWebACL(args: DeleteWebACLCommandInput, cb: (err: any, data?: DeleteWebACLCommandOutput) => void): void; - public deleteWebACL( + deleteWebACL(args: DeleteWebACLCommandInput, options?: __HttpHandlerOptions): Promise; + deleteWebACL(args: DeleteWebACLCommandInput, cb: (err: any, data?: DeleteWebACLCommandOutput) => void): void; + deleteWebACL( args: DeleteWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWebACLCommandOutput) => void ): void; - public deleteWebACL( - args: DeleteWebACLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWebACLCommandOutput) => void), - cb?: (err: any, data?: DeleteWebACLCommandOutput) => void - ): Promise | void { - const command = new DeleteWebACLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Provides high-level information for a managed rule group, including descriptions of the - * rules.

+ * @see {@link DescribeManagedRuleGroupCommand} */ - public describeManagedRuleGroup( + describeManagedRuleGroup( args: DescribeManagedRuleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeManagedRuleGroup( + describeManagedRuleGroup( args: DescribeManagedRuleGroupCommandInput, cb: (err: any, data?: DescribeManagedRuleGroupCommandOutput) => void ): void; - public describeManagedRuleGroup( + describeManagedRuleGroup( args: DescribeManagedRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeManagedRuleGroupCommandOutput) => void ): void; - public describeManagedRuleGroup( - args: DescribeManagedRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeManagedRuleGroupCommandOutput) => void), - cb?: (err: any, data?: DescribeManagedRuleGroupCommandOutput) => void - ): Promise | void { - const command = new DescribeManagedRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates the specified regional application resource from any existing web ACL - * association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

- *

For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To - * disassociate a web ACL, provide an empty web ACL ID in the CloudFront call - * UpdateDistribution. For information, see UpdateDistribution in the Amazon CloudFront API Reference.

+ * @see {@link DisassociateWebACLCommand} */ - public disassociateWebACL( + disassociateWebACL( args: DisassociateWebACLCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateWebACL( + disassociateWebACL( args: DisassociateWebACLCommandInput, cb: (err: any, data?: DisassociateWebACLCommandOutput) => void ): void; - public disassociateWebACL( + disassociateWebACL( args: DisassociateWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateWebACLCommandOutput) => void ): void; - public disassociateWebACL( - args: DisassociateWebACLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateWebACLCommandOutput) => void), - cb?: (err: any, data?: DisassociateWebACLCommandOutput) => void - ): Promise | void { - const command = new DisassociateWebACLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Generates a presigned download URL for the specified release of the mobile SDK.

- *

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see - * WAF client application integration in the WAF Developer Guide.

+ * @see {@link GenerateMobileSdkReleaseUrlCommand} */ - public generateMobileSdkReleaseUrl( + generateMobileSdkReleaseUrl( args: GenerateMobileSdkReleaseUrlCommandInput, options?: __HttpHandlerOptions ): Promise; - public generateMobileSdkReleaseUrl( + generateMobileSdkReleaseUrl( args: GenerateMobileSdkReleaseUrlCommandInput, cb: (err: any, data?: GenerateMobileSdkReleaseUrlCommandOutput) => void ): void; - public generateMobileSdkReleaseUrl( + generateMobileSdkReleaseUrl( args: GenerateMobileSdkReleaseUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateMobileSdkReleaseUrlCommandOutput) => void ): void; - public generateMobileSdkReleaseUrl( - args: GenerateMobileSdkReleaseUrlCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GenerateMobileSdkReleaseUrlCommandOutput) => void), - cb?: (err: any, data?: GenerateMobileSdkReleaseUrlCommandOutput) => void - ): Promise | void { - const command = new GenerateMobileSdkReleaseUrlCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the specified IPSet.

+ * @see {@link GetIPSetCommand} */ - public getIPSet(args: GetIPSetCommandInput, options?: __HttpHandlerOptions): Promise; - public getIPSet(args: GetIPSetCommandInput, cb: (err: any, data?: GetIPSetCommandOutput) => void): void; - public getIPSet( + getIPSet(args: GetIPSetCommandInput, options?: __HttpHandlerOptions): Promise; + getIPSet(args: GetIPSetCommandInput, cb: (err: any, data?: GetIPSetCommandOutput) => void): void; + getIPSet( args: GetIPSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIPSetCommandOutput) => void ): void; - public getIPSet( - args: GetIPSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIPSetCommandOutput) => void), - cb?: (err: any, data?: GetIPSetCommandOutput) => void - ): Promise | void { - const command = new GetIPSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the LoggingConfiguration for the specified web ACL.

+ * @see {@link GetLoggingConfigurationCommand} */ - public getLoggingConfiguration( + getLoggingConfiguration( args: GetLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLoggingConfiguration( + getLoggingConfiguration( args: GetLoggingConfigurationCommandInput, cb: (err: any, data?: GetLoggingConfigurationCommandOutput) => void ): void; - public getLoggingConfiguration( + getLoggingConfiguration( args: GetLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLoggingConfigurationCommandOutput) => void ): void; - public getLoggingConfiguration( - args: GetLoggingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: GetLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new GetLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the specified managed rule set.

- * - *

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

- *

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

- *
+ * @see {@link GetManagedRuleSetCommand} */ - public getManagedRuleSet( + getManagedRuleSet( args: GetManagedRuleSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getManagedRuleSet( + getManagedRuleSet( args: GetManagedRuleSetCommandInput, cb: (err: any, data?: GetManagedRuleSetCommandOutput) => void ): void; - public getManagedRuleSet( + getManagedRuleSet( args: GetManagedRuleSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetManagedRuleSetCommandOutput) => void ): void; - public getManagedRuleSet( - args: GetManagedRuleSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetManagedRuleSetCommandOutput) => void), - cb?: (err: any, data?: GetManagedRuleSetCommandOutput) => void - ): Promise | void { - const command = new GetManagedRuleSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information for the specified mobile SDK release, including release notes and - * tags.

- *

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see - * WAF client application integration in the WAF Developer Guide.

+ * @see {@link GetMobileSdkReleaseCommand} */ - public getMobileSdkRelease( + getMobileSdkRelease( args: GetMobileSdkReleaseCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMobileSdkRelease( + getMobileSdkRelease( args: GetMobileSdkReleaseCommandInput, cb: (err: any, data?: GetMobileSdkReleaseCommandOutput) => void ): void; - public getMobileSdkRelease( + getMobileSdkRelease( args: GetMobileSdkReleaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMobileSdkReleaseCommandOutput) => void ): void; - public getMobileSdkRelease( - args: GetMobileSdkReleaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMobileSdkReleaseCommandOutput) => void), - cb?: (err: any, data?: GetMobileSdkReleaseCommandOutput) => void - ): Promise | void { - const command = new GetMobileSdkReleaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the IAM policy that is attached to the specified rule group.

- *

You must be the owner of the rule group to perform this operation.

+ * @see {@link GetPermissionPolicyCommand} */ - public getPermissionPolicy( + getPermissionPolicy( args: GetPermissionPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPermissionPolicy( + getPermissionPolicy( args: GetPermissionPolicyCommandInput, cb: (err: any, data?: GetPermissionPolicyCommandOutput) => void ): void; - public getPermissionPolicy( + getPermissionPolicy( args: GetPermissionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPermissionPolicyCommandOutput) => void ): void; - public getPermissionPolicy( - args: GetPermissionPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPermissionPolicyCommandOutput) => void), - cb?: (err: any, data?: GetPermissionPolicyCommandOutput) => void - ): Promise | void { - const command = new GetPermissionPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the keys that are currently blocked by a rate-based rule instance. The maximum - * number of managed keys that can be blocked for a single rate-based rule instance is 10,000. - * If more than 10,000 addresses exceed the rate limit, those with the highest rates are - * blocked.

- *

For a rate-based rule that you've defined inside a rule group, provide the name of the - * rule group reference statement in your request, in addition to the rate-based rule name and - * the web ACL name.

- *

WAF monitors web requests and manages keys independently for each unique combination - * of web ACL, optional rule group, and rate-based rule. For example, if you define a - * rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF - * monitors web requests and manages keys for that web ACL, rule group reference statement, - * and rate-based rule instance. If you use the same rule group in a second web ACL, WAF - * monitors web requests and manages keys for this second usage completely independent of your - * first.

+ * @see {@link GetRateBasedStatementManagedKeysCommand} */ - public getRateBasedStatementManagedKeys( + getRateBasedStatementManagedKeys( args: GetRateBasedStatementManagedKeysCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRateBasedStatementManagedKeys( + getRateBasedStatementManagedKeys( args: GetRateBasedStatementManagedKeysCommandInput, cb: (err: any, data?: GetRateBasedStatementManagedKeysCommandOutput) => void ): void; - public getRateBasedStatementManagedKeys( + getRateBasedStatementManagedKeys( args: GetRateBasedStatementManagedKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRateBasedStatementManagedKeysCommandOutput) => void ): void; - public getRateBasedStatementManagedKeys( - args: GetRateBasedStatementManagedKeysCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRateBasedStatementManagedKeysCommandOutput) => void), - cb?: (err: any, data?: GetRateBasedStatementManagedKeysCommandOutput) => void - ): Promise | void { - const command = new GetRateBasedStatementManagedKeysCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the specified RegexPatternSet.

+ * @see {@link GetRegexPatternSetCommand} */ - public getRegexPatternSet( + getRegexPatternSet( args: GetRegexPatternSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRegexPatternSet( + getRegexPatternSet( args: GetRegexPatternSetCommandInput, cb: (err: any, data?: GetRegexPatternSetCommandOutput) => void ): void; - public getRegexPatternSet( + getRegexPatternSet( args: GetRegexPatternSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRegexPatternSetCommandOutput) => void ): void; - public getRegexPatternSet( - args: GetRegexPatternSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRegexPatternSetCommandOutput) => void), - cb?: (err: any, data?: GetRegexPatternSetCommandOutput) => void - ): Promise | void { - const command = new GetRegexPatternSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the specified RuleGroup.

+ * @see {@link GetRuleGroupCommand} */ - public getRuleGroup( - args: GetRuleGroupCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getRuleGroup(args: GetRuleGroupCommandInput, cb: (err: any, data?: GetRuleGroupCommandOutput) => void): void; - public getRuleGroup( + getRuleGroup(args: GetRuleGroupCommandInput, options?: __HttpHandlerOptions): Promise; + getRuleGroup(args: GetRuleGroupCommandInput, cb: (err: any, data?: GetRuleGroupCommandOutput) => void): void; + getRuleGroup( args: GetRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRuleGroupCommandOutput) => void ): void; - public getRuleGroup( - args: GetRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRuleGroupCommandOutput) => void), - cb?: (err: any, data?: GetRuleGroupCommandOutput) => void - ): Promise | void { - const command = new GetRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets detailed information about a specified number of requests--a sample--that WAF - * randomly selects from among the first 5,000 requests that your Amazon Web Services resource received - * during a time range that you choose. You can specify a sample size of up to 500 requests, - * and you can specify any time range in the previous three hours.

- *

- * GetSampledRequests returns a time range, which is usually the time range that - * you specified. However, if your resource (such as a CloudFront distribution) received 5,000 - * requests before the specified time range elapsed, GetSampledRequests returns - * an updated time range. This new time range indicates the actual period during which WAF - * selected the requests in the sample.

+ * @see {@link GetSampledRequestsCommand} */ - public getSampledRequests( + getSampledRequests( args: GetSampledRequestsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSampledRequests( + getSampledRequests( args: GetSampledRequestsCommandInput, cb: (err: any, data?: GetSampledRequestsCommandOutput) => void ): void; - public getSampledRequests( + getSampledRequests( args: GetSampledRequestsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSampledRequestsCommandOutput) => void ): void; - public getSampledRequests( - args: GetSampledRequestsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSampledRequestsCommandOutput) => void), - cb?: (err: any, data?: GetSampledRequestsCommandOutput) => void - ): Promise | void { - const command = new GetSampledRequestsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the specified WebACL.

+ * @see {@link GetWebACLCommand} */ - public getWebACL(args: GetWebACLCommandInput, options?: __HttpHandlerOptions): Promise; - public getWebACL(args: GetWebACLCommandInput, cb: (err: any, data?: GetWebACLCommandOutput) => void): void; - public getWebACL( + getWebACL(args: GetWebACLCommandInput, options?: __HttpHandlerOptions): Promise; + getWebACL(args: GetWebACLCommandInput, cb: (err: any, data?: GetWebACLCommandOutput) => void): void; + getWebACL( args: GetWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWebACLCommandOutput) => void ): void; - public getWebACL( - args: GetWebACLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWebACLCommandOutput) => void), - cb?: (err: any, data?: GetWebACLCommandOutput) => void - ): Promise | void { - const command = new GetWebACLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the WebACL for the specified resource.

+ * @see {@link GetWebACLForResourceCommand} */ - public getWebACLForResource( + getWebACLForResource( args: GetWebACLForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public getWebACLForResource( + getWebACLForResource( args: GetWebACLForResourceCommandInput, cb: (err: any, data?: GetWebACLForResourceCommandOutput) => void ): void; - public getWebACLForResource( + getWebACLForResource( args: GetWebACLForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWebACLForResourceCommandOutput) => void ): void; - public getWebACLForResource( - args: GetWebACLForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWebACLForResourceCommandOutput) => void), - cb?: (err: any, data?: GetWebACLForResourceCommandOutput) => void - ): Promise | void { - const command = new GetWebACLForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves an array of managed rule groups that are available for you to use. This list - * includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're - * subscribed to.

+ * @see {@link ListAvailableManagedRuleGroupsCommand} */ - public listAvailableManagedRuleGroups( + listAvailableManagedRuleGroups( args: ListAvailableManagedRuleGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAvailableManagedRuleGroups( + listAvailableManagedRuleGroups( args: ListAvailableManagedRuleGroupsCommandInput, cb: (err: any, data?: ListAvailableManagedRuleGroupsCommandOutput) => void ): void; - public listAvailableManagedRuleGroups( + listAvailableManagedRuleGroups( args: ListAvailableManagedRuleGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAvailableManagedRuleGroupsCommandOutput) => void ): void; - public listAvailableManagedRuleGroups( - args: ListAvailableManagedRuleGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAvailableManagedRuleGroupsCommandOutput) => void), - cb?: (err: any, data?: ListAvailableManagedRuleGroupsCommandOutput) => void - ): Promise | void { - const command = new ListAvailableManagedRuleGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of the available versions for the specified managed rule group.

+ * @see {@link ListAvailableManagedRuleGroupVersionsCommand} */ - public listAvailableManagedRuleGroupVersions( + listAvailableManagedRuleGroupVersions( args: ListAvailableManagedRuleGroupVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAvailableManagedRuleGroupVersions( + listAvailableManagedRuleGroupVersions( args: ListAvailableManagedRuleGroupVersionsCommandInput, cb: (err: any, data?: ListAvailableManagedRuleGroupVersionsCommandOutput) => void ): void; - public listAvailableManagedRuleGroupVersions( + listAvailableManagedRuleGroupVersions( args: ListAvailableManagedRuleGroupVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAvailableManagedRuleGroupVersionsCommandOutput) => void ): void; - public listAvailableManagedRuleGroupVersions( - args: ListAvailableManagedRuleGroupVersionsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: ListAvailableManagedRuleGroupVersionsCommandOutput) => void), - cb?: (err: any, data?: ListAvailableManagedRuleGroupVersionsCommandOutput) => void - ): Promise | void { - const command = new ListAvailableManagedRuleGroupVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves an array of IPSetSummary objects for the IP sets that you - * manage.

+ * @see {@link ListIPSetsCommand} */ - public listIPSets(args: ListIPSetsCommandInput, options?: __HttpHandlerOptions): Promise; - public listIPSets(args: ListIPSetsCommandInput, cb: (err: any, data?: ListIPSetsCommandOutput) => void): void; - public listIPSets( + listIPSets(args: ListIPSetsCommandInput, options?: __HttpHandlerOptions): Promise; + listIPSets(args: ListIPSetsCommandInput, cb: (err: any, data?: ListIPSetsCommandOutput) => void): void; + listIPSets( args: ListIPSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIPSetsCommandOutput) => void ): void; - public listIPSets( - args: ListIPSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIPSetsCommandOutput) => void), - cb?: (err: any, data?: ListIPSetsCommandOutput) => void - ): Promise | void { - const command = new ListIPSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves an array of your LoggingConfiguration objects.

+ * @see {@link ListLoggingConfigurationsCommand} */ - public listLoggingConfigurations( + listLoggingConfigurations( args: ListLoggingConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLoggingConfigurations( + listLoggingConfigurations( args: ListLoggingConfigurationsCommandInput, cb: (err: any, data?: ListLoggingConfigurationsCommandOutput) => void ): void; - public listLoggingConfigurations( + listLoggingConfigurations( args: ListLoggingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLoggingConfigurationsCommandOutput) => void ): void; - public listLoggingConfigurations( - args: ListLoggingConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLoggingConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListLoggingConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListLoggingConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the managed rule sets that you own.

- * - *

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

- *

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

- *
+ * @see {@link ListManagedRuleSetsCommand} */ - public listManagedRuleSets( + listManagedRuleSets( args: ListManagedRuleSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listManagedRuleSets( + listManagedRuleSets( args: ListManagedRuleSetsCommandInput, cb: (err: any, data?: ListManagedRuleSetsCommandOutput) => void ): void; - public listManagedRuleSets( + listManagedRuleSets( args: ListManagedRuleSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListManagedRuleSetsCommandOutput) => void ): void; - public listManagedRuleSets( - args: ListManagedRuleSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListManagedRuleSetsCommandOutput) => void), - cb?: (err: any, data?: ListManagedRuleSetsCommandOutput) => void - ): Promise | void { - const command = new ListManagedRuleSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of the available releases for the mobile SDK and the specified device - * platform.

- *

The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see - * WAF client application integration in the WAF Developer Guide.

+ * @see {@link ListMobileSdkReleasesCommand} */ - public listMobileSdkReleases( + listMobileSdkReleases( args: ListMobileSdkReleasesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMobileSdkReleases( + listMobileSdkReleases( args: ListMobileSdkReleasesCommandInput, cb: (err: any, data?: ListMobileSdkReleasesCommandOutput) => void ): void; - public listMobileSdkReleases( + listMobileSdkReleases( args: ListMobileSdkReleasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMobileSdkReleasesCommandOutput) => void ): void; - public listMobileSdkReleases( - args: ListMobileSdkReleasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMobileSdkReleasesCommandOutput) => void), - cb?: (err: any, data?: ListMobileSdkReleasesCommandOutput) => void - ): Promise | void { - const command = new ListMobileSdkReleasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves an array of RegexPatternSetSummary objects for the regex - * pattern sets that you manage.

+ * @see {@link ListRegexPatternSetsCommand} */ - public listRegexPatternSets( + listRegexPatternSets( args: ListRegexPatternSetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRegexPatternSets( + listRegexPatternSets( args: ListRegexPatternSetsCommandInput, cb: (err: any, data?: ListRegexPatternSetsCommandOutput) => void ): void; - public listRegexPatternSets( + listRegexPatternSets( args: ListRegexPatternSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRegexPatternSetsCommandOutput) => void ): void; - public listRegexPatternSets( - args: ListRegexPatternSetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRegexPatternSetsCommandOutput) => void), - cb?: (err: any, data?: ListRegexPatternSetsCommandOutput) => void - ): Promise | void { - const command = new ListRegexPatternSetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that - * are associated with the specified web ACL. If you want the list of Amazon CloudFront resources, use - * the CloudFront call ListDistributionsByWebACLId.

+ * @see {@link ListResourcesForWebACLCommand} */ - public listResourcesForWebACL( + listResourcesForWebACL( args: ListResourcesForWebACLCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourcesForWebACL( + listResourcesForWebACL( args: ListResourcesForWebACLCommandInput, cb: (err: any, data?: ListResourcesForWebACLCommandOutput) => void ): void; - public listResourcesForWebACL( + listResourcesForWebACL( args: ListResourcesForWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourcesForWebACLCommandOutput) => void ): void; - public listResourcesForWebACL( - args: ListResourcesForWebACLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourcesForWebACLCommandOutput) => void), - cb?: (err: any, data?: ListResourcesForWebACLCommandOutput) => void - ): Promise | void { - const command = new ListResourcesForWebACLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves an array of RuleGroupSummary objects for the rule groups - * that you manage.

+ * @see {@link ListRuleGroupsCommand} */ - public listRuleGroups( + listRuleGroups( args: ListRuleGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listRuleGroups( - args: ListRuleGroupsCommandInput, - cb: (err: any, data?: ListRuleGroupsCommandOutput) => void - ): void; - public listRuleGroups( + listRuleGroups(args: ListRuleGroupsCommandInput, cb: (err: any, data?: ListRuleGroupsCommandOutput) => void): void; + listRuleGroups( args: ListRuleGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRuleGroupsCommandOutput) => void ): void; - public listRuleGroups( - args: ListRuleGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListRuleGroupsCommandOutput) => void), - cb?: (err: any, data?: ListRuleGroupsCommandOutput) => void - ): Promise | void { - const command = new ListRuleGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the TagInfoForResource for the specified resource. Tags are - * key:value pairs that you can use to categorize and manage your resources, for purposes like - * billing. For example, you might set the tag key to "customer" and the value to the customer - * name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags - * for a resource.

- *

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule - * groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF - * console.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves an array of WebACLSummary objects for the web ACLs that you - * manage.

+ * @see {@link ListWebACLsCommand} */ - public listWebACLs(args: ListWebACLsCommandInput, options?: __HttpHandlerOptions): Promise; - public listWebACLs(args: ListWebACLsCommandInput, cb: (err: any, data?: ListWebACLsCommandOutput) => void): void; - public listWebACLs( + listWebACLs(args: ListWebACLsCommandInput, options?: __HttpHandlerOptions): Promise; + listWebACLs(args: ListWebACLsCommandInput, cb: (err: any, data?: ListWebACLsCommandOutput) => void): void; + listWebACLs( args: ListWebACLsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWebACLsCommandOutput) => void ): void; - public listWebACLs( - args: ListWebACLsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWebACLsCommandOutput) => void), - cb?: (err: any, data?: ListWebACLsCommandOutput) => void - ): Promise | void { - const command = new ListWebACLsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Enables the specified LoggingConfiguration, to start logging from a - * web ACL, according to the configuration provided.

- * - *

This operation completely replaces any mutable specifications that you already have for a logging configuration with the ones that you provide to this call.

- *

To modify an existing logging configuration, do the following:

- *
    - *
  1. - *

    Retrieve it by calling GetLoggingConfiguration - *

    - *
  2. - *
  3. - *

    Update its settings as needed

    - *
  4. - *
  5. - *

    Provide the complete logging configuration specification to this call

    - *
  6. - *
- *
- * - *

You can define one logging destination per web ACL.

- *
- *

You can access information about the traffic that WAF inspects using the following - * steps:

- *
    - *
  1. - *

    Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.

    - *

    The name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to configure additional settings or permissions.

    - *

    For configuration requirements and pricing information for each destination type, see - * Logging web ACL traffic - * in the WAF Developer Guide.

    - *
  2. - *
  3. - *

    Associate your logging destination to your web ACL using a - * PutLoggingConfiguration request.

    - *
  4. - *
- *

When you successfully enable logging using a PutLoggingConfiguration - * request, WAF creates an additional role or policy that is required to write - * logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. - * For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.

- *

For additional information about web ACL logging, see - * Logging web ACL traffic information - * in the WAF Developer Guide.

+ * @see {@link PutLoggingConfigurationCommand} */ - public putLoggingConfiguration( + putLoggingConfiguration( args: PutLoggingConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putLoggingConfiguration( + putLoggingConfiguration( args: PutLoggingConfigurationCommandInput, cb: (err: any, data?: PutLoggingConfigurationCommandOutput) => void ): void; - public putLoggingConfiguration( + putLoggingConfiguration( args: PutLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLoggingConfigurationCommandOutput) => void ): void; - public putLoggingConfiguration( - args: PutLoggingConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutLoggingConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutLoggingConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutLoggingConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Defines the versions of your managed rule set that you are offering to the customers. - * Customers see your offerings as managed rule groups with versioning.

- * - *

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

- *

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

- *
- *

Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your - * managed rule set is the name the customer sees for the corresponding managed rule group. - * Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group - * specification for each version. For each managed rule set, you must specify a version that - * you recommend using.

- *

To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate.

+ * @see {@link PutManagedRuleSetVersionsCommand} */ - public putManagedRuleSetVersions( + putManagedRuleSetVersions( args: PutManagedRuleSetVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putManagedRuleSetVersions( + putManagedRuleSetVersions( args: PutManagedRuleSetVersionsCommandInput, cb: (err: any, data?: PutManagedRuleSetVersionsCommandOutput) => void ): void; - public putManagedRuleSetVersions( + putManagedRuleSetVersions( args: PutManagedRuleSetVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutManagedRuleSetVersionsCommandOutput) => void ): void; - public putManagedRuleSetVersions( - args: PutManagedRuleSetVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutManagedRuleSetVersionsCommandOutput) => void), - cb?: (err: any, data?: PutManagedRuleSetVersionsCommandOutput) => void - ): Promise | void { - const command = new PutManagedRuleSetVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Attaches an IAM policy to the specified resource. Use this to share a rule group across - * accounts.

- *

You must be the owner of the rule group to perform this operation.

- *

This action is subject to the following restrictions:

- *
    - *
  • - *

    You can attach only one policy with each PutPermissionPolicy - * request.

    - *
  • - *
  • - *

    The ARN in the request must be a valid WAF RuleGroup ARN and the - * rule group must exist in the same Region.

    - *
  • - *
  • - *

    The user making the request must be the owner of the rule group.

    - *
  • - *
+ * @see {@link PutPermissionPolicyCommand} */ - public putPermissionPolicy( + putPermissionPolicy( args: PutPermissionPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putPermissionPolicy( + putPermissionPolicy( args: PutPermissionPolicyCommandInput, cb: (err: any, data?: PutPermissionPolicyCommandOutput) => void ): void; - public putPermissionPolicy( + putPermissionPolicy( args: PutPermissionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPermissionPolicyCommandOutput) => void ): void; - public putPermissionPolicy( - args: PutPermissionPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutPermissionPolicyCommandOutput) => void), - cb?: (err: any, data?: PutPermissionPolicyCommandOutput) => void - ): Promise | void { - const command = new PutPermissionPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can - * use to categorize and manage your resources, for purposes like billing. For example, you - * might set the tag key to "customer" and the value to the customer name or ID. You can - * specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a - * resource.

- *

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule - * groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF - * console.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can - * associate with Amazon Web Services resources. For example, the tag key might be "customer" and the tag - * value might be "companyA." You can specify one or more tags to add to each container. You - * can add up to 50 tags to each Amazon Web Services resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified IPSet.

- * - *

This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call.

- *

To modify an IP set, do the following:

- *
    - *
  1. - *

    Retrieve it by calling GetIPSet - *

    - *
  2. - *
  3. - *

    Update its settings as needed

    - *
  4. - *
  5. - *

    Provide the complete IP set specification to this call

    - *
  6. - *
- *
- *

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

+ * @see {@link UpdateIPSetCommand} */ - public updateIPSet(args: UpdateIPSetCommandInput, options?: __HttpHandlerOptions): Promise; - public updateIPSet(args: UpdateIPSetCommandInput, cb: (err: any, data?: UpdateIPSetCommandOutput) => void): void; - public updateIPSet( + updateIPSet(args: UpdateIPSetCommandInput, options?: __HttpHandlerOptions): Promise; + updateIPSet(args: UpdateIPSetCommandInput, cb: (err: any, data?: UpdateIPSetCommandOutput) => void): void; + updateIPSet( args: UpdateIPSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIPSetCommandOutput) => void ): void; - public updateIPSet( - args: UpdateIPSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateIPSetCommandOutput) => void), - cb?: (err: any, data?: UpdateIPSetCommandOutput) => void - ): Promise | void { - const command = new UpdateIPSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the expiration information for your managed rule set. Use this to initiate the - * expiration of a managed rule group version. After you initiate expiration for a version, - * WAF excludes it from the response to ListAvailableManagedRuleGroupVersions for the managed rule group.

- * - *

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

- *

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

- *
+ * @see {@link UpdateManagedRuleSetVersionExpiryDateCommand} */ - public updateManagedRuleSetVersionExpiryDate( + updateManagedRuleSetVersionExpiryDate( args: UpdateManagedRuleSetVersionExpiryDateCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateManagedRuleSetVersionExpiryDate( + updateManagedRuleSetVersionExpiryDate( args: UpdateManagedRuleSetVersionExpiryDateCommandInput, cb: (err: any, data?: UpdateManagedRuleSetVersionExpiryDateCommandOutput) => void ): void; - public updateManagedRuleSetVersionExpiryDate( + updateManagedRuleSetVersionExpiryDate( args: UpdateManagedRuleSetVersionExpiryDateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateManagedRuleSetVersionExpiryDateCommandOutput) => void ): void; - public updateManagedRuleSetVersionExpiryDate( - args: UpdateManagedRuleSetVersionExpiryDateCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: UpdateManagedRuleSetVersionExpiryDateCommandOutput) => void), - cb?: (err: any, data?: UpdateManagedRuleSetVersionExpiryDateCommandOutput) => void - ): Promise | void { - const command = new UpdateManagedRuleSetVersionExpiryDateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified RegexPatternSet.

- * - *

This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call.

- *

To modify a regex pattern set, do the following:

- *
    - *
  1. - *

    Retrieve it by calling GetRegexPatternSet - *

    - *
  2. - *
  3. - *

    Update its settings as needed

    - *
  4. - *
  5. - *

    Provide the complete regex pattern set specification to this call

    - *
  6. - *
- *
- *

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

+ * @see {@link UpdateRegexPatternSetCommand} */ - public updateRegexPatternSet( + updateRegexPatternSet( args: UpdateRegexPatternSetCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRegexPatternSet( + updateRegexPatternSet( args: UpdateRegexPatternSetCommandInput, cb: (err: any, data?: UpdateRegexPatternSetCommandOutput) => void ): void; - public updateRegexPatternSet( + updateRegexPatternSet( args: UpdateRegexPatternSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRegexPatternSetCommandOutput) => void ): void; - public updateRegexPatternSet( - args: UpdateRegexPatternSetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRegexPatternSetCommandOutput) => void), - cb?: (err: any, data?: UpdateRegexPatternSetCommandOutput) => void - ): Promise | void { - const command = new UpdateRegexPatternSetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified RuleGroup.

- * - *

This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call.

- *

To modify a rule group, do the following:

- *
    - *
  1. - *

    Retrieve it by calling GetRuleGroup - *

    - *
  2. - *
  3. - *

    Update its settings as needed

    - *
  4. - *
  5. - *

    Provide the complete rule group specification to this call

    - *
  6. - *
- *
- *

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

- *

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

+ * @see {@link UpdateRuleGroupCommand} */ - public updateRuleGroup( + updateRuleGroup( args: UpdateRuleGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRuleGroup( - args: UpdateRuleGroupCommandInput, - cb: (err: any, data?: UpdateRuleGroupCommandOutput) => void - ): void; - public updateRuleGroup( + updateRuleGroup(args: UpdateRuleGroupCommandInput, cb: (err: any, data?: UpdateRuleGroupCommandOutput) => void): void; + updateRuleGroup( args: UpdateRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRuleGroupCommandOutput) => void ): void; - public updateRuleGroup( - args: UpdateRuleGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRuleGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateRuleGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateRuleGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified WebACL. While updating a web ACL, WAF provides - * continuous coverage to the resources that you have associated with the web ACL.

- * - *

This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call.

- *

To modify a web ACL, do the following:

- *
    - *
  1. - *

    Retrieve it by calling GetWebACL - *

    - *
  2. - *
  3. - *

    Update its settings as needed

    - *
  4. - *
  5. - *

    Provide the complete web ACL specification to this call

    - *
  6. - *
- *
- *

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

- *

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

+ * @see {@link UpdateWebACLCommand} */ - public updateWebACL( - args: UpdateWebACLCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateWebACL(args: UpdateWebACLCommandInput, cb: (err: any, data?: UpdateWebACLCommandOutput) => void): void; - public updateWebACL( + updateWebACL(args: UpdateWebACLCommandInput, options?: __HttpHandlerOptions): Promise; + updateWebACL(args: UpdateWebACLCommandInput, cb: (err: any, data?: UpdateWebACLCommandOutput) => void): void; + updateWebACL( args: UpdateWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWebACLCommandOutput) => void ): void; - public updateWebACL( - args: UpdateWebACLCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWebACLCommandOutput) => void), - cb?: (err: any, data?: UpdateWebACLCommandOutput) => void - ): Promise | void { - const command = new UpdateWebACLCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * WAF + * + *

This is the latest version of the WAF API, + * released in November, 2019. The names of the entities that you use to access this API, + * like endpoints and namespaces, all have the versioning information added, like "V2" or + * "v2", to distinguish from the prior version. We recommend migrating your resources to + * this version, because it has a number of significant improvements.

+ *

If you used WAF prior to this release, you can't use this WAFV2 API to access any + * WAF resources that you created before. You can access your old rules, web ACLs, and + * other WAF resources only through the WAF Classic APIs. The WAF Classic APIs + * have retained the prior names, endpoints, and namespaces.

+ *

For information, including how to migrate your WAF resources to this version, + * see the WAF Developer Guide.

+ *
+ *

WAF is a web application firewall that lets you monitor the HTTP and HTTPS + * requests that are forwarded to an Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync + * GraphQL API, Amazon Cognito user pool, or App Runner service. WAF also lets you control access to your content, + * to protect the Amazon Web Services resource that WAF is monitoring. Based on conditions that + * you specify, such as the IP addresses that requests originate from or the values of query + * strings, the protected resource responds to requests with either the requested content, an HTTP 403 status code + * (Forbidden), or with a custom response.

+ *

This API guide is for developers who need detailed information about WAF API actions, + * data types, and errors. For detailed information about WAF features and guidance for configuring and using + * WAF, see the WAF Developer + * Guide.

+ *

You can make calls using the endpoints listed in WAF endpoints and quotas.

+ *
    + *
  • + *

    For regional applications, you can use any of the endpoints in the list. + * A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service.

    + *
  • + *
  • + *

    For Amazon CloudFront applications, you must use the API endpoint listed for + * US East (N. Virginia): us-east-1.

    + *
  • + *
+ *

Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the + * programming language or platform that you're using. For more information, see Amazon Web Services SDKs.

+ *

We currently provide two versions of the WAF API: this API and the prior versions, + * the classic WAF APIs. This new API provides the same functionality as the older versions, + * with the following major improvements:

+ *
    + *
  • + *

    You use one API for both global and regional applications. Where you need to + * distinguish the scope, you specify a Scope parameter and set it to + * CLOUDFRONT or REGIONAL.

    + *
  • + *
  • + *

    You can define a web ACL or rule group with a single call, and update it with a + * single call. You define all rule specifications in JSON format, and pass them to your + * rule group or web ACL calls.

    + *
  • + *
  • + *

    The limits WAF places on the use of rules more closely reflects the cost of + * running each type of rule. Rule groups include capacity settings, so you know the + * maximum cost of a rule group when you use it.

    + *
  • + *
+ */ +export class WAFV2 extends WAFV2Client implements WAFV2 {} +createAggregatedClient(commands, WAFV2); diff --git a/clients/client-wellarchitected/src/WellArchitected.ts b/clients/client-wellarchitected/src/WellArchitected.ts index 2b5cb7175434..cfde59c38b00 100644 --- a/clients/client-wellarchitected/src/WellArchitected.ts +++ b/clients/client-wellarchitected/src/WellArchitected.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -180,1513 +181,681 @@ import { UpgradeLensReviewCommandInput, UpgradeLensReviewCommandOutput, } from "./commands/UpgradeLensReviewCommand"; -import { WellArchitectedClient } from "./WellArchitectedClient"; +import { WellArchitectedClient, WellArchitectedClientConfig } from "./WellArchitectedClient"; -/** - * @public - * Well-Architected Tool - *

This is the Well-Architected Tool API Reference. The WA Tool API provides programmatic access to the - * Well-Architected Tool in the - * Amazon Web Services Management Console. For information - * about the Well-Architected Tool, see the - * Well-Architected Tool User Guide.

- */ -export class WellArchitected extends WellArchitectedClient { +const commands = { + AssociateLensesCommand, + CreateLensShareCommand, + CreateLensVersionCommand, + CreateMilestoneCommand, + CreateWorkloadCommand, + CreateWorkloadShareCommand, + DeleteLensCommand, + DeleteLensShareCommand, + DeleteWorkloadCommand, + DeleteWorkloadShareCommand, + DisassociateLensesCommand, + ExportLensCommand, + GetAnswerCommand, + GetConsolidatedReportCommand, + GetLensCommand, + GetLensReviewCommand, + GetLensReviewReportCommand, + GetLensVersionDifferenceCommand, + GetMilestoneCommand, + GetWorkloadCommand, + ImportLensCommand, + ListAnswersCommand, + ListCheckDetailsCommand, + ListCheckSummariesCommand, + ListLensesCommand, + ListLensReviewImprovementsCommand, + ListLensReviewsCommand, + ListLensSharesCommand, + ListMilestonesCommand, + ListNotificationsCommand, + ListShareInvitationsCommand, + ListTagsForResourceCommand, + ListWorkloadsCommand, + ListWorkloadSharesCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAnswerCommand, + UpdateGlobalSettingsCommand, + UpdateLensReviewCommand, + UpdateShareInvitationCommand, + UpdateWorkloadCommand, + UpdateWorkloadShareCommand, + UpgradeLensReviewCommand, +}; + +export interface WellArchitected { /** - * @public - *

Associate a lens to a workload.

- *

Up to 10 lenses can be associated with a workload in a single API operation. A - * maximum of 20 lenses can be associated with a workload.

- * - *

- * Disclaimer - *

- *

By accessing and/or applying custom lenses created by another Amazon Web Services user or account, - * you acknowledge that custom lenses created by other users and shared with you are - * Third Party Content as defined in the Amazon Web Services Customer Agreement.

- *
+ * @see {@link AssociateLensesCommand} */ - public associateLenses( + associateLenses( args: AssociateLensesCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateLenses( - args: AssociateLensesCommandInput, - cb: (err: any, data?: AssociateLensesCommandOutput) => void - ): void; - public associateLenses( + associateLenses(args: AssociateLensesCommandInput, cb: (err: any, data?: AssociateLensesCommandOutput) => void): void; + associateLenses( args: AssociateLensesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateLensesCommandOutput) => void ): void; - public associateLenses( - args: AssociateLensesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateLensesCommandOutput) => void), - cb?: (err: any, data?: AssociateLensesCommandOutput) => void - ): Promise | void { - const command = new AssociateLensesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create a lens share.

- *

The owner of a lens can share it with other Amazon Web Services accounts, users, an organization, - * and organizational units (OUs) in the same Amazon Web Services Region. - * Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be shared.

- *

- * Shared access to a lens is not removed until the lens invitation is deleted.

- *

If you share a lens with an organization or OU, all accounts in the organization or OU - * are granted access to the lens.

- *

For more information, see Sharing a custom lens in the - * Well-Architected Tool User Guide.

- * - *

- * Disclaimer - *

- *

By sharing your custom lenses with other Amazon Web Services accounts, - * you acknowledge that Amazon Web Services will make your custom lenses available to those - * other accounts. Those other accounts may continue to access and use your - * shared custom lenses even if you delete the custom lenses - * from your own Amazon Web Services account or terminate - * your Amazon Web Services account.

- *
+ * @see {@link CreateLensShareCommand} */ - public createLensShare( + createLensShare( args: CreateLensShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLensShare( - args: CreateLensShareCommandInput, - cb: (err: any, data?: CreateLensShareCommandOutput) => void - ): void; - public createLensShare( + createLensShare(args: CreateLensShareCommandInput, cb: (err: any, data?: CreateLensShareCommandOutput) => void): void; + createLensShare( args: CreateLensShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLensShareCommandOutput) => void ): void; - public createLensShare( - args: CreateLensShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLensShareCommandOutput) => void), - cb?: (err: any, data?: CreateLensShareCommandOutput) => void - ): Promise | void { - const command = new CreateLensShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create a new lens version.

- *

A lens can have up to 100 versions.

- *

Use this operation to publish a new lens version after you have imported a lens. The LensAlias - * is used to identify the lens to be published. - * The owner of a lens can share the lens with other - * Amazon Web Services accounts and users in the same Amazon Web Services Region. Only the owner of a lens can delete it. - *

+ * @see {@link CreateLensVersionCommand} */ - public createLensVersion( + createLensVersion( args: CreateLensVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createLensVersion( + createLensVersion( args: CreateLensVersionCommandInput, cb: (err: any, data?: CreateLensVersionCommandOutput) => void ): void; - public createLensVersion( + createLensVersion( args: CreateLensVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLensVersionCommandOutput) => void ): void; - public createLensVersion( - args: CreateLensVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLensVersionCommandOutput) => void), - cb?: (err: any, data?: CreateLensVersionCommandOutput) => void - ): Promise | void { - const command = new CreateLensVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create a milestone for an existing workload.

+ * @see {@link CreateMilestoneCommand} */ - public createMilestone( + createMilestone( args: CreateMilestoneCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMilestone( - args: CreateMilestoneCommandInput, - cb: (err: any, data?: CreateMilestoneCommandOutput) => void - ): void; - public createMilestone( + createMilestone(args: CreateMilestoneCommandInput, cb: (err: any, data?: CreateMilestoneCommandOutput) => void): void; + createMilestone( args: CreateMilestoneCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMilestoneCommandOutput) => void ): void; - public createMilestone( - args: CreateMilestoneCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMilestoneCommandOutput) => void), - cb?: (err: any, data?: CreateMilestoneCommandOutput) => void - ): Promise | void { - const command = new CreateMilestoneCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create a new workload.

- *

The owner of a workload can share the workload with other Amazon Web Services accounts, users, - * an organization, and organizational units (OUs) - * in the same Amazon Web Services Region. Only the owner of a workload can delete it.

- *

For more information, see Defining a Workload in the - * Well-Architected Tool User Guide.

- * - *

Either AwsRegions, NonAwsRegions, or both must be specified when - * creating a workload.

- *

You also must specify ReviewOwner, even though the - * parameter is listed as not being required in the following section. - *

- *
+ * @see {@link CreateWorkloadCommand} */ - public createWorkload( + createWorkload( args: CreateWorkloadCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorkload( - args: CreateWorkloadCommandInput, - cb: (err: any, data?: CreateWorkloadCommandOutput) => void - ): void; - public createWorkload( + createWorkload(args: CreateWorkloadCommandInput, cb: (err: any, data?: CreateWorkloadCommandOutput) => void): void; + createWorkload( args: CreateWorkloadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkloadCommandOutput) => void ): void; - public createWorkload( - args: CreateWorkloadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorkloadCommandOutput) => void), - cb?: (err: any, data?: CreateWorkloadCommandOutput) => void - ): Promise | void { - const command = new CreateWorkloadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Create a workload share.

- *

The owner of a workload can share it with other Amazon Web Services accounts and users in the same - * Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is - * deleted.

- *

If you share a workload with an organization or OU, all accounts in the organization or OU - * are granted access to the workload.

- *

For more information, see Sharing a workload in the - * Well-Architected Tool User Guide.

+ * @see {@link CreateWorkloadShareCommand} */ - public createWorkloadShare( + createWorkloadShare( args: CreateWorkloadShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorkloadShare( + createWorkloadShare( args: CreateWorkloadShareCommandInput, cb: (err: any, data?: CreateWorkloadShareCommandOutput) => void ): void; - public createWorkloadShare( + createWorkloadShare( args: CreateWorkloadShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkloadShareCommandOutput) => void ): void; - public createWorkloadShare( - args: CreateWorkloadShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorkloadShareCommandOutput) => void), - cb?: (err: any, data?: CreateWorkloadShareCommandOutput) => void - ): Promise | void { - const command = new CreateWorkloadShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete an existing lens.

- *

Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and users - * that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads. - *

- * - *

- * Disclaimer - *

- *

By sharing your custom lenses with other Amazon Web Services accounts, - * you acknowledge that Amazon Web Services will make your custom lenses available to those - * other accounts. Those other accounts may continue to access and use your - * shared custom lenses even if you delete the custom lenses - * from your own Amazon Web Services account or terminate - * your Amazon Web Services account.

- *
+ * @see {@link DeleteLensCommand} */ - public deleteLens(args: DeleteLensCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteLens(args: DeleteLensCommandInput, cb: (err: any, data?: DeleteLensCommandOutput) => void): void; - public deleteLens( + deleteLens(args: DeleteLensCommandInput, options?: __HttpHandlerOptions): Promise; + deleteLens(args: DeleteLensCommandInput, cb: (err: any, data?: DeleteLensCommandOutput) => void): void; + deleteLens( args: DeleteLensCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLensCommandOutput) => void ): void; - public deleteLens( - args: DeleteLensCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLensCommandOutput) => void), - cb?: (err: any, data?: DeleteLensCommandOutput) => void - ): Promise | void { - const command = new DeleteLensCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete a lens share.

- *

After the lens share is deleted, Amazon Web Services accounts, users, organizations, - * and organizational units (OUs) - * that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.

- * - *

- * Disclaimer - *

- *

By sharing your custom lenses with other Amazon Web Services accounts, - * you acknowledge that Amazon Web Services will make your custom lenses available to those - * other accounts. Those other accounts may continue to access and use your - * shared custom lenses even if you delete the custom lenses - * from your own Amazon Web Services account or terminate - * your Amazon Web Services account.

- *
+ * @see {@link DeleteLensShareCommand} */ - public deleteLensShare( + deleteLensShare( args: DeleteLensShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteLensShare( - args: DeleteLensShareCommandInput, - cb: (err: any, data?: DeleteLensShareCommandOutput) => void - ): void; - public deleteLensShare( + deleteLensShare(args: DeleteLensShareCommandInput, cb: (err: any, data?: DeleteLensShareCommandOutput) => void): void; + deleteLensShare( args: DeleteLensShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLensShareCommandOutput) => void ): void; - public deleteLensShare( - args: DeleteLensShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLensShareCommandOutput) => void), - cb?: (err: any, data?: DeleteLensShareCommandOutput) => void - ): Promise | void { - const command = new DeleteLensShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete an existing workload.

+ * @see {@link DeleteWorkloadCommand} */ - public deleteWorkload( + deleteWorkload( args: DeleteWorkloadCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWorkload( - args: DeleteWorkloadCommandInput, - cb: (err: any, data?: DeleteWorkloadCommandOutput) => void - ): void; - public deleteWorkload( + deleteWorkload(args: DeleteWorkloadCommandInput, cb: (err: any, data?: DeleteWorkloadCommandOutput) => void): void; + deleteWorkload( args: DeleteWorkloadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkloadCommandOutput) => void ): void; - public deleteWorkload( - args: DeleteWorkloadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorkloadCommandOutput) => void), - cb?: (err: any, data?: DeleteWorkloadCommandOutput) => void - ): Promise | void { - const command = new DeleteWorkloadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Delete a workload share.

+ * @see {@link DeleteWorkloadShareCommand} */ - public deleteWorkloadShare( + deleteWorkloadShare( args: DeleteWorkloadShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWorkloadShare( + deleteWorkloadShare( args: DeleteWorkloadShareCommandInput, cb: (err: any, data?: DeleteWorkloadShareCommandOutput) => void ): void; - public deleteWorkloadShare( + deleteWorkloadShare( args: DeleteWorkloadShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkloadShareCommandOutput) => void ): void; - public deleteWorkloadShare( - args: DeleteWorkloadShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorkloadShareCommandOutput) => void), - cb?: (err: any, data?: DeleteWorkloadShareCommandOutput) => void - ): Promise | void { - const command = new DeleteWorkloadShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociate a lens from a workload.

- *

Up to 10 lenses can be disassociated from a workload in a single API operation.

- * - *

The Amazon Web Services Well-Architected Framework lens (wellarchitected) cannot be - * removed from a workload.

- *
+ * @see {@link DisassociateLensesCommand} */ - public disassociateLenses( + disassociateLenses( args: DisassociateLensesCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateLenses( + disassociateLenses( args: DisassociateLensesCommandInput, cb: (err: any, data?: DisassociateLensesCommandOutput) => void ): void; - public disassociateLenses( + disassociateLenses( args: DisassociateLensesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateLensesCommandOutput) => void ): void; - public disassociateLenses( - args: DisassociateLensesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateLensesCommandOutput) => void), - cb?: (err: any, data?: DisassociateLensesCommandOutput) => void - ): Promise | void { - const command = new DisassociateLensesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Export an existing lens.

- *

Only the owner of a lens can export it. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) - * cannot be exported.

- *

Lenses are defined in JSON. For more information, see JSON format specification - * in the Well-Architected Tool User Guide.

- * - *

- * Disclaimer - *

- *

Do not include or gather personal identifiable information (PII) of end users or - * other identifiable individuals in or via your custom lenses. If your custom - * lens or those shared with you and used in your account do include or collect - * PII you are responsible for: ensuring that the included PII is processed in accordance - * with applicable law, providing adequate privacy notices, and obtaining necessary - * consents for processing such data.

- *
+ * @see {@link ExportLensCommand} */ - public exportLens(args: ExportLensCommandInput, options?: __HttpHandlerOptions): Promise; - public exportLens(args: ExportLensCommandInput, cb: (err: any, data?: ExportLensCommandOutput) => void): void; - public exportLens( + exportLens(args: ExportLensCommandInput, options?: __HttpHandlerOptions): Promise; + exportLens(args: ExportLensCommandInput, cb: (err: any, data?: ExportLensCommandOutput) => void): void; + exportLens( args: ExportLensCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExportLensCommandOutput) => void ): void; - public exportLens( - args: ExportLensCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ExportLensCommandOutput) => void), - cb?: (err: any, data?: ExportLensCommandOutput) => void - ): Promise | void { - const command = new ExportLensCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get the answer to a specific question in a workload review.

+ * @see {@link GetAnswerCommand} */ - public getAnswer(args: GetAnswerCommandInput, options?: __HttpHandlerOptions): Promise; - public getAnswer(args: GetAnswerCommandInput, cb: (err: any, data?: GetAnswerCommandOutput) => void): void; - public getAnswer( + getAnswer(args: GetAnswerCommandInput, options?: __HttpHandlerOptions): Promise; + getAnswer(args: GetAnswerCommandInput, cb: (err: any, data?: GetAnswerCommandOutput) => void): void; + getAnswer( args: GetAnswerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAnswerCommandOutput) => void ): void; - public getAnswer( - args: GetAnswerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAnswerCommandOutput) => void), - cb?: (err: any, data?: GetAnswerCommandOutput) => void - ): Promise | void { - const command = new GetAnswerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get a consolidated report of your workloads.

- *

You can optionally choose to include workloads that have been shared with you.

+ * @see {@link GetConsolidatedReportCommand} */ - public getConsolidatedReport( + getConsolidatedReport( args: GetConsolidatedReportCommandInput, options?: __HttpHandlerOptions ): Promise; - public getConsolidatedReport( + getConsolidatedReport( args: GetConsolidatedReportCommandInput, cb: (err: any, data?: GetConsolidatedReportCommandOutput) => void ): void; - public getConsolidatedReport( + getConsolidatedReport( args: GetConsolidatedReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConsolidatedReportCommandOutput) => void ): void; - public getConsolidatedReport( - args: GetConsolidatedReportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetConsolidatedReportCommandOutput) => void), - cb?: (err: any, data?: GetConsolidatedReportCommandOutput) => void - ): Promise | void { - const command = new GetConsolidatedReportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get an existing lens.

+ * @see {@link GetLensCommand} */ - public getLens(args: GetLensCommandInput, options?: __HttpHandlerOptions): Promise; - public getLens(args: GetLensCommandInput, cb: (err: any, data?: GetLensCommandOutput) => void): void; - public getLens( + getLens(args: GetLensCommandInput, options?: __HttpHandlerOptions): Promise; + getLens(args: GetLensCommandInput, cb: (err: any, data?: GetLensCommandOutput) => void): void; + getLens( args: GetLensCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLensCommandOutput) => void ): void; - public getLens( - args: GetLensCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLensCommandOutput) => void), - cb?: (err: any, data?: GetLensCommandOutput) => void - ): Promise | void { - const command = new GetLensCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get lens review.

+ * @see {@link GetLensReviewCommand} */ - public getLensReview( - args: GetLensReviewCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getLensReview( - args: GetLensReviewCommandInput, - cb: (err: any, data?: GetLensReviewCommandOutput) => void - ): void; - public getLensReview( + getLensReview(args: GetLensReviewCommandInput, options?: __HttpHandlerOptions): Promise; + getLensReview(args: GetLensReviewCommandInput, cb: (err: any, data?: GetLensReviewCommandOutput) => void): void; + getLensReview( args: GetLensReviewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLensReviewCommandOutput) => void ): void; - public getLensReview( - args: GetLensReviewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLensReviewCommandOutput) => void), - cb?: (err: any, data?: GetLensReviewCommandOutput) => void - ): Promise | void { - const command = new GetLensReviewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get lens review report.

+ * @see {@link GetLensReviewReportCommand} */ - public getLensReviewReport( + getLensReviewReport( args: GetLensReviewReportCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLensReviewReport( + getLensReviewReport( args: GetLensReviewReportCommandInput, cb: (err: any, data?: GetLensReviewReportCommandOutput) => void ): void; - public getLensReviewReport( + getLensReviewReport( args: GetLensReviewReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLensReviewReportCommandOutput) => void ): void; - public getLensReviewReport( - args: GetLensReviewReportCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLensReviewReportCommandOutput) => void), - cb?: (err: any, data?: GetLensReviewReportCommandOutput) => void - ): Promise | void { - const command = new GetLensReviewReportCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get lens version differences.

+ * @see {@link GetLensVersionDifferenceCommand} */ - public getLensVersionDifference( + getLensVersionDifference( args: GetLensVersionDifferenceCommandInput, options?: __HttpHandlerOptions ): Promise; - public getLensVersionDifference( + getLensVersionDifference( args: GetLensVersionDifferenceCommandInput, cb: (err: any, data?: GetLensVersionDifferenceCommandOutput) => void ): void; - public getLensVersionDifference( + getLensVersionDifference( args: GetLensVersionDifferenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLensVersionDifferenceCommandOutput) => void ): void; - public getLensVersionDifference( - args: GetLensVersionDifferenceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetLensVersionDifferenceCommandOutput) => void), - cb?: (err: any, data?: GetLensVersionDifferenceCommandOutput) => void - ): Promise | void { - const command = new GetLensVersionDifferenceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get a milestone for an existing workload.

+ * @see {@link GetMilestoneCommand} */ - public getMilestone( - args: GetMilestoneCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getMilestone(args: GetMilestoneCommandInput, cb: (err: any, data?: GetMilestoneCommandOutput) => void): void; - public getMilestone( + getMilestone(args: GetMilestoneCommandInput, options?: __HttpHandlerOptions): Promise; + getMilestone(args: GetMilestoneCommandInput, cb: (err: any, data?: GetMilestoneCommandOutput) => void): void; + getMilestone( args: GetMilestoneCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMilestoneCommandOutput) => void ): void; - public getMilestone( - args: GetMilestoneCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMilestoneCommandOutput) => void), - cb?: (err: any, data?: GetMilestoneCommandOutput) => void - ): Promise | void { - const command = new GetMilestoneCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get an existing workload.

+ * @see {@link GetWorkloadCommand} */ - public getWorkload(args: GetWorkloadCommandInput, options?: __HttpHandlerOptions): Promise; - public getWorkload(args: GetWorkloadCommandInput, cb: (err: any, data?: GetWorkloadCommandOutput) => void): void; - public getWorkload( + getWorkload(args: GetWorkloadCommandInput, options?: __HttpHandlerOptions): Promise; + getWorkload(args: GetWorkloadCommandInput, cb: (err: any, data?: GetWorkloadCommandOutput) => void): void; + getWorkload( args: GetWorkloadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkloadCommandOutput) => void ): void; - public getWorkload( - args: GetWorkloadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetWorkloadCommandOutput) => void), - cb?: (err: any, data?: GetWorkloadCommandOutput) => void - ): Promise | void { - const command = new GetWorkloadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Import a new custom lens or update an existing custom lens.

- *

To update an existing custom lens, specify its ARN as the LensAlias. If - * no ARN is specified, a new custom lens is created.

- *

The new or updated lens will have a status of DRAFT. The lens cannot be - * applied to workloads or shared with other Amazon Web Services accounts until it's - * published with CreateLensVersion.

- *

Lenses are defined in JSON. For more information, see JSON format specification - * in the Well-Architected Tool User Guide.

- *

A custom lens cannot exceed 500 KB in size.

- * - *

- * Disclaimer - *

- *

Do not include or gather personal identifiable information (PII) of end users or - * other identifiable individuals in or via your custom lenses. If your custom - * lens or those shared with you and used in your account do include or collect - * PII you are responsible for: ensuring that the included PII is processed in accordance - * with applicable law, providing adequate privacy notices, and obtaining necessary - * consents for processing such data.

- *
+ * @see {@link ImportLensCommand} */ - public importLens(args: ImportLensCommandInput, options?: __HttpHandlerOptions): Promise; - public importLens(args: ImportLensCommandInput, cb: (err: any, data?: ImportLensCommandOutput) => void): void; - public importLens( + importLens(args: ImportLensCommandInput, options?: __HttpHandlerOptions): Promise; + importLens(args: ImportLensCommandInput, cb: (err: any, data?: ImportLensCommandOutput) => void): void; + importLens( args: ImportLensCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportLensCommandOutput) => void ): void; - public importLens( - args: ImportLensCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportLensCommandOutput) => void), - cb?: (err: any, data?: ImportLensCommandOutput) => void - ): Promise | void { - const command = new ImportLensCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List of answers for a particular workload and lens.

+ * @see {@link ListAnswersCommand} */ - public listAnswers(args: ListAnswersCommandInput, options?: __HttpHandlerOptions): Promise; - public listAnswers(args: ListAnswersCommandInput, cb: (err: any, data?: ListAnswersCommandOutput) => void): void; - public listAnswers( + listAnswers(args: ListAnswersCommandInput, options?: __HttpHandlerOptions): Promise; + listAnswers(args: ListAnswersCommandInput, cb: (err: any, data?: ListAnswersCommandOutput) => void): void; + listAnswers( args: ListAnswersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAnswersCommandOutput) => void ): void; - public listAnswers( - args: ListAnswersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAnswersCommandOutput) => void), - cb?: (err: any, data?: ListAnswersCommandOutput) => void - ): Promise | void { - const command = new ListAnswersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List of Trusted Advisor check details by account related to the workload.

+ * @see {@link ListCheckDetailsCommand} */ - public listCheckDetails( + listCheckDetails( args: ListCheckDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCheckDetails( + listCheckDetails( args: ListCheckDetailsCommandInput, cb: (err: any, data?: ListCheckDetailsCommandOutput) => void ): void; - public listCheckDetails( + listCheckDetails( args: ListCheckDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCheckDetailsCommandOutput) => void ): void; - public listCheckDetails( - args: ListCheckDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCheckDetailsCommandOutput) => void), - cb?: (err: any, data?: ListCheckDetailsCommandOutput) => void - ): Promise | void { - const command = new ListCheckDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List of Trusted Advisor checks summarized for all accounts related to the workload.

+ * @see {@link ListCheckSummariesCommand} */ - public listCheckSummaries( + listCheckSummaries( args: ListCheckSummariesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listCheckSummaries( + listCheckSummaries( args: ListCheckSummariesCommandInput, cb: (err: any, data?: ListCheckSummariesCommandOutput) => void ): void; - public listCheckSummaries( + listCheckSummaries( args: ListCheckSummariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCheckSummariesCommandOutput) => void ): void; - public listCheckSummaries( - args: ListCheckSummariesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListCheckSummariesCommandOutput) => void), - cb?: (err: any, data?: ListCheckSummariesCommandOutput) => void - ): Promise | void { - const command = new ListCheckSummariesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the available lenses.

+ * @see {@link ListLensesCommand} */ - public listLenses(args: ListLensesCommandInput, options?: __HttpHandlerOptions): Promise; - public listLenses(args: ListLensesCommandInput, cb: (err: any, data?: ListLensesCommandOutput) => void): void; - public listLenses( + listLenses(args: ListLensesCommandInput, options?: __HttpHandlerOptions): Promise; + listLenses(args: ListLensesCommandInput, cb: (err: any, data?: ListLensesCommandOutput) => void): void; + listLenses( args: ListLensesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLensesCommandOutput) => void ): void; - public listLenses( - args: ListLensesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLensesCommandOutput) => void), - cb?: (err: any, data?: ListLensesCommandOutput) => void - ): Promise | void { - const command = new ListLensesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List lens review improvements.

+ * @see {@link ListLensReviewImprovementsCommand} */ - public listLensReviewImprovements( + listLensReviewImprovements( args: ListLensReviewImprovementsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLensReviewImprovements( + listLensReviewImprovements( args: ListLensReviewImprovementsCommandInput, cb: (err: any, data?: ListLensReviewImprovementsCommandOutput) => void ): void; - public listLensReviewImprovements( + listLensReviewImprovements( args: ListLensReviewImprovementsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLensReviewImprovementsCommandOutput) => void ): void; - public listLensReviewImprovements( - args: ListLensReviewImprovementsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLensReviewImprovementsCommandOutput) => void), - cb?: (err: any, data?: ListLensReviewImprovementsCommandOutput) => void - ): Promise | void { - const command = new ListLensReviewImprovementsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List lens reviews for a particular workload.

+ * @see {@link ListLensReviewsCommand} */ - public listLensReviews( + listLensReviews( args: ListLensReviewsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLensReviews( - args: ListLensReviewsCommandInput, - cb: (err: any, data?: ListLensReviewsCommandOutput) => void - ): void; - public listLensReviews( + listLensReviews(args: ListLensReviewsCommandInput, cb: (err: any, data?: ListLensReviewsCommandOutput) => void): void; + listLensReviews( args: ListLensReviewsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLensReviewsCommandOutput) => void ): void; - public listLensReviews( - args: ListLensReviewsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLensReviewsCommandOutput) => void), - cb?: (err: any, data?: ListLensReviewsCommandOutput) => void - ): Promise | void { - const command = new ListLensReviewsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the lens shares associated with the lens.

+ * @see {@link ListLensSharesCommand} */ - public listLensShares( + listLensShares( args: ListLensSharesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listLensShares( - args: ListLensSharesCommandInput, - cb: (err: any, data?: ListLensSharesCommandOutput) => void - ): void; - public listLensShares( + listLensShares(args: ListLensSharesCommandInput, cb: (err: any, data?: ListLensSharesCommandOutput) => void): void; + listLensShares( args: ListLensSharesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLensSharesCommandOutput) => void ): void; - public listLensShares( - args: ListLensSharesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListLensSharesCommandOutput) => void), - cb?: (err: any, data?: ListLensSharesCommandOutput) => void - ): Promise | void { - const command = new ListLensSharesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all milestones for an existing workload.

+ * @see {@link ListMilestonesCommand} */ - public listMilestones( + listMilestones( args: ListMilestonesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMilestones( - args: ListMilestonesCommandInput, - cb: (err: any, data?: ListMilestonesCommandOutput) => void - ): void; - public listMilestones( + listMilestones(args: ListMilestonesCommandInput, cb: (err: any, data?: ListMilestonesCommandOutput) => void): void; + listMilestones( args: ListMilestonesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMilestonesCommandOutput) => void ): void; - public listMilestones( - args: ListMilestonesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMilestonesCommandOutput) => void), - cb?: (err: any, data?: ListMilestonesCommandOutput) => void - ): Promise | void { - const command = new ListMilestonesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List lens notifications.

+ * @see {@link ListNotificationsCommand} */ - public listNotifications( + listNotifications( args: ListNotificationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listNotifications( + listNotifications( args: ListNotificationsCommandInput, cb: (err: any, data?: ListNotificationsCommandOutput) => void ): void; - public listNotifications( + listNotifications( args: ListNotificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNotificationsCommandOutput) => void ): void; - public listNotifications( - args: ListNotificationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNotificationsCommandOutput) => void), - cb?: (err: any, data?: ListNotificationsCommandOutput) => void - ): Promise | void { - const command = new ListNotificationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the workload invitations.

+ * @see {@link ListShareInvitationsCommand} */ - public listShareInvitations( + listShareInvitations( args: ListShareInvitationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listShareInvitations( + listShareInvitations( args: ListShareInvitationsCommandInput, cb: (err: any, data?: ListShareInvitationsCommandOutput) => void ): void; - public listShareInvitations( + listShareInvitations( args: ListShareInvitationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListShareInvitationsCommandOutput) => void ): void; - public listShareInvitations( - args: ListShareInvitationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListShareInvitationsCommandOutput) => void), - cb?: (err: any, data?: ListShareInvitationsCommandOutput) => void - ): Promise | void { - const command = new ListShareInvitationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the tags for a resource.

- * - *

The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.

- *
+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Paginated list of workloads.

+ * @see {@link ListWorkloadsCommand} */ - public listWorkloads( - args: ListWorkloadsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listWorkloads( - args: ListWorkloadsCommandInput, - cb: (err: any, data?: ListWorkloadsCommandOutput) => void - ): void; - public listWorkloads( + listWorkloads(args: ListWorkloadsCommandInput, options?: __HttpHandlerOptions): Promise; + listWorkloads(args: ListWorkloadsCommandInput, cb: (err: any, data?: ListWorkloadsCommandOutput) => void): void; + listWorkloads( args: ListWorkloadsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkloadsCommandOutput) => void ): void; - public listWorkloads( - args: ListWorkloadsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkloadsCommandOutput) => void), - cb?: (err: any, data?: ListWorkloadsCommandOutput) => void - ): Promise | void { - const command = new ListWorkloadsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List the workload shares associated with the workload.

+ * @see {@link ListWorkloadSharesCommand} */ - public listWorkloadShares( + listWorkloadShares( args: ListWorkloadSharesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWorkloadShares( + listWorkloadShares( args: ListWorkloadSharesCommandInput, cb: (err: any, data?: ListWorkloadSharesCommandOutput) => void ): void; - public listWorkloadShares( + listWorkloadShares( args: ListWorkloadSharesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkloadSharesCommandOutput) => void ): void; - public listWorkloadShares( - args: ListWorkloadSharesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWorkloadSharesCommandOutput) => void), - cb?: (err: any, data?: ListWorkloadSharesCommandOutput) => void - ): Promise | void { - const command = new ListWorkloadSharesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more tags to the specified resource.

- * - *

The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.

- *
+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes specified tags from a resource.

- * - *

The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.

- *
- *

To specify multiple tags, use separate tagKeys parameters, for example:

- *

- * DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2 - *

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update the answer to a specific question in a workload review.

+ * @see {@link UpdateAnswerCommand} */ - public updateAnswer( - args: UpdateAnswerCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateAnswer(args: UpdateAnswerCommandInput, cb: (err: any, data?: UpdateAnswerCommandOutput) => void): void; - public updateAnswer( + updateAnswer(args: UpdateAnswerCommandInput, options?: __HttpHandlerOptions): Promise; + updateAnswer(args: UpdateAnswerCommandInput, cb: (err: any, data?: UpdateAnswerCommandOutput) => void): void; + updateAnswer( args: UpdateAnswerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAnswerCommandOutput) => void ): void; - public updateAnswer( - args: UpdateAnswerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAnswerCommandOutput) => void), - cb?: (err: any, data?: UpdateAnswerCommandOutput) => void - ): Promise | void { - const command = new UpdateAnswerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates whether the Amazon Web Services account is opted into organization sharing features.

+ * @see {@link UpdateGlobalSettingsCommand} */ - public updateGlobalSettings( + updateGlobalSettings( args: UpdateGlobalSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateGlobalSettings( + updateGlobalSettings( args: UpdateGlobalSettingsCommandInput, cb: (err: any, data?: UpdateGlobalSettingsCommandOutput) => void ): void; - public updateGlobalSettings( + updateGlobalSettings( args: UpdateGlobalSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGlobalSettingsCommandOutput) => void ): void; - public updateGlobalSettings( - args: UpdateGlobalSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGlobalSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateGlobalSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateGlobalSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update lens review for a particular workload.

+ * @see {@link UpdateLensReviewCommand} */ - public updateLensReview( + updateLensReview( args: UpdateLensReviewCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateLensReview( + updateLensReview( args: UpdateLensReviewCommandInput, cb: (err: any, data?: UpdateLensReviewCommandOutput) => void ): void; - public updateLensReview( + updateLensReview( args: UpdateLensReviewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLensReviewCommandOutput) => void ): void; - public updateLensReview( - args: UpdateLensReviewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateLensReviewCommandOutput) => void), - cb?: (err: any, data?: UpdateLensReviewCommandOutput) => void - ): Promise | void { - const command = new UpdateLensReviewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update a workload or custom lens share invitation.

- * - *

This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.

- *
+ * @see {@link UpdateShareInvitationCommand} */ - public updateShareInvitation( + updateShareInvitation( args: UpdateShareInvitationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateShareInvitation( + updateShareInvitation( args: UpdateShareInvitationCommandInput, cb: (err: any, data?: UpdateShareInvitationCommandOutput) => void ): void; - public updateShareInvitation( + updateShareInvitation( args: UpdateShareInvitationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateShareInvitationCommandOutput) => void ): void; - public updateShareInvitation( - args: UpdateShareInvitationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateShareInvitationCommandOutput) => void), - cb?: (err: any, data?: UpdateShareInvitationCommandOutput) => void - ): Promise | void { - const command = new UpdateShareInvitationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update an existing workload.

+ * @see {@link UpdateWorkloadCommand} */ - public updateWorkload( + updateWorkload( args: UpdateWorkloadCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWorkload( - args: UpdateWorkloadCommandInput, - cb: (err: any, data?: UpdateWorkloadCommandOutput) => void - ): void; - public updateWorkload( + updateWorkload(args: UpdateWorkloadCommandInput, cb: (err: any, data?: UpdateWorkloadCommandOutput) => void): void; + updateWorkload( args: UpdateWorkloadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkloadCommandOutput) => void ): void; - public updateWorkload( - args: UpdateWorkloadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWorkloadCommandOutput) => void), - cb?: (err: any, data?: UpdateWorkloadCommandOutput) => void - ): Promise | void { - const command = new UpdateWorkloadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Update a workload share.

+ * @see {@link UpdateWorkloadShareCommand} */ - public updateWorkloadShare( + updateWorkloadShare( args: UpdateWorkloadShareCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWorkloadShare( + updateWorkloadShare( args: UpdateWorkloadShareCommandInput, cb: (err: any, data?: UpdateWorkloadShareCommandOutput) => void ): void; - public updateWorkloadShare( + updateWorkloadShare( args: UpdateWorkloadShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkloadShareCommandOutput) => void ): void; - public updateWorkloadShare( - args: UpdateWorkloadShareCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWorkloadShareCommandOutput) => void), - cb?: (err: any, data?: UpdateWorkloadShareCommandOutput) => void - ): Promise | void { - const command = new UpdateWorkloadShareCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Upgrade lens review for a particular workload.

+ * @see {@link UpgradeLensReviewCommand} */ - public upgradeLensReview( + upgradeLensReview( args: UpgradeLensReviewCommandInput, options?: __HttpHandlerOptions ): Promise; - public upgradeLensReview( + upgradeLensReview( args: UpgradeLensReviewCommandInput, cb: (err: any, data?: UpgradeLensReviewCommandOutput) => void ): void; - public upgradeLensReview( + upgradeLensReview( args: UpgradeLensReviewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpgradeLensReviewCommandOutput) => void ): void; - public upgradeLensReview( - args: UpgradeLensReviewCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpgradeLensReviewCommandOutput) => void), - cb?: (err: any, data?: UpgradeLensReviewCommandOutput) => void - ): Promise | void { - const command = new UpgradeLensReviewCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Well-Architected Tool + *

This is the Well-Architected Tool API Reference. The WA Tool API provides programmatic access to the + * Well-Architected Tool in the + * Amazon Web Services Management Console. For information + * about the Well-Architected Tool, see the + * Well-Architected Tool User Guide.

+ */ +export class WellArchitected extends WellArchitectedClient implements WellArchitected {} +createAggregatedClient(commands, WellArchitected); diff --git a/clients/client-wisdom/src/Wisdom.ts b/clients/client-wisdom/src/Wisdom.ts index 460a8437a293..0049164c2528 100644 --- a/clients/client-wisdom/src/Wisdom.ts +++ b/clients/client-wisdom/src/Wisdom.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -144,1064 +145,496 @@ import { UpdateKnowledgeBaseTemplateUriCommandInput, UpdateKnowledgeBaseTemplateUriCommandOutput, } from "./commands/UpdateKnowledgeBaseTemplateUriCommand"; -import { WisdomClient } from "./WisdomClient"; +import { WisdomClient, WisdomClientConfig } from "./WisdomClient"; -/** - * @public - *

Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're - * actively speaking with customers. Agents can search across connected repositories from within - * their agent desktop to find answers quickly. Use Amazon Connect Wisdom to create an assistant and a - * knowledge base, for example, or manage content by uploading custom files.

- */ -export class Wisdom extends WisdomClient { +const commands = { + CreateAssistantCommand, + CreateAssistantAssociationCommand, + CreateContentCommand, + CreateKnowledgeBaseCommand, + CreateSessionCommand, + DeleteAssistantCommand, + DeleteAssistantAssociationCommand, + DeleteContentCommand, + DeleteKnowledgeBaseCommand, + GetAssistantCommand, + GetAssistantAssociationCommand, + GetContentCommand, + GetContentSummaryCommand, + GetKnowledgeBaseCommand, + GetRecommendationsCommand, + GetSessionCommand, + ListAssistantAssociationsCommand, + ListAssistantsCommand, + ListContentsCommand, + ListKnowledgeBasesCommand, + ListTagsForResourceCommand, + NotifyRecommendationsReceivedCommand, + QueryAssistantCommand, + RemoveKnowledgeBaseTemplateUriCommand, + SearchContentCommand, + SearchSessionsCommand, + StartContentUploadCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateContentCommand, + UpdateKnowledgeBaseTemplateUriCommand, +}; + +export interface Wisdom { /** - * @public - *

Creates an Amazon Connect Wisdom assistant.

+ * @see {@link CreateAssistantCommand} */ - public createAssistant( + createAssistant( args: CreateAssistantCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAssistant( - args: CreateAssistantCommandInput, - cb: (err: any, data?: CreateAssistantCommandOutput) => void - ): void; - public createAssistant( + createAssistant(args: CreateAssistantCommandInput, cb: (err: any, data?: CreateAssistantCommandOutput) => void): void; + createAssistant( args: CreateAssistantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAssistantCommandOutput) => void ): void; - public createAssistant( - args: CreateAssistantCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAssistantCommandOutput) => void), - cb?: (err: any, data?: CreateAssistantCommandOutput) => void - ): Promise | void { - const command = new CreateAssistantCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an association between an Amazon Connect Wisdom assistant and another resource. Currently, the - * only supported association is with a knowledge base. An assistant can have only a single - * association.

+ * @see {@link CreateAssistantAssociationCommand} */ - public createAssistantAssociation( + createAssistantAssociation( args: CreateAssistantAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAssistantAssociation( + createAssistantAssociation( args: CreateAssistantAssociationCommandInput, cb: (err: any, data?: CreateAssistantAssociationCommandOutput) => void ): void; - public createAssistantAssociation( + createAssistantAssociation( args: CreateAssistantAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAssistantAssociationCommandOutput) => void ): void; - public createAssistantAssociation( - args: CreateAssistantAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAssistantAssociationCommandOutput) => void), - cb?: (err: any, data?: CreateAssistantAssociationCommandOutput) => void - ): Promise | void { - const command = new CreateAssistantAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates Wisdom content. Before to calling this API, use StartContentUpload to - * upload an asset.

+ * @see {@link CreateContentCommand} */ - public createContent( - args: CreateContentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createContent( - args: CreateContentCommandInput, - cb: (err: any, data?: CreateContentCommandOutput) => void - ): void; - public createContent( + createContent(args: CreateContentCommandInput, options?: __HttpHandlerOptions): Promise; + createContent(args: CreateContentCommandInput, cb: (err: any, data?: CreateContentCommandOutput) => void): void; + createContent( args: CreateContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateContentCommandOutput) => void ): void; - public createContent( - args: CreateContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateContentCommandOutput) => void), - cb?: (err: any, data?: CreateContentCommandOutput) => void - ): Promise | void { - const command = new CreateContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a knowledge base.

- * - *

When using this API, you cannot reuse Amazon AppIntegrations - * DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, - * you'll get an InvalidRequestException error.

- *

For example, you're programmatically managing your external knowledge base, and you want - * to add or remove one of the fields that is being ingested from Salesforce. Do the - * following:

- *
    - *
  1. - *

    Call DeleteKnowledgeBase.

    - *
  2. - *
  3. - *

    Call DeleteDataIntegration.

    - *
  4. - *
  5. - *

    Call CreateDataIntegration to recreate the DataIntegration or a create different - * one.

    - *
  6. - *
  7. - *

    Call CreateKnowledgeBase.

    - *
  8. - *
- *
+ * @see {@link CreateKnowledgeBaseCommand} */ - public createKnowledgeBase( + createKnowledgeBase( args: CreateKnowledgeBaseCommandInput, options?: __HttpHandlerOptions ): Promise; - public createKnowledgeBase( + createKnowledgeBase( args: CreateKnowledgeBaseCommandInput, cb: (err: any, data?: CreateKnowledgeBaseCommandOutput) => void ): void; - public createKnowledgeBase( + createKnowledgeBase( args: CreateKnowledgeBaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateKnowledgeBaseCommandOutput) => void ): void; - public createKnowledgeBase( - args: CreateKnowledgeBaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateKnowledgeBaseCommandOutput) => void), - cb?: (err: any, data?: CreateKnowledgeBaseCommandOutput) => void - ): Promise | void { - const command = new CreateKnowledgeBaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a session. A session is a contextual container used for generating - * recommendations. Amazon Connect creates a new Wisdom session for each contact on which - * Wisdom is enabled.

+ * @see {@link CreateSessionCommand} */ - public createSession( - args: CreateSessionCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createSession( - args: CreateSessionCommandInput, - cb: (err: any, data?: CreateSessionCommandOutput) => void - ): void; - public createSession( + createSession(args: CreateSessionCommandInput, options?: __HttpHandlerOptions): Promise; + createSession(args: CreateSessionCommandInput, cb: (err: any, data?: CreateSessionCommandOutput) => void): void; + createSession( args: CreateSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSessionCommandOutput) => void ): void; - public createSession( - args: CreateSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSessionCommandOutput) => void), - cb?: (err: any, data?: CreateSessionCommandOutput) => void - ): Promise | void { - const command = new CreateSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an assistant.

+ * @see {@link DeleteAssistantCommand} */ - public deleteAssistant( + deleteAssistant( args: DeleteAssistantCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAssistant( - args: DeleteAssistantCommandInput, - cb: (err: any, data?: DeleteAssistantCommandOutput) => void - ): void; - public deleteAssistant( + deleteAssistant(args: DeleteAssistantCommandInput, cb: (err: any, data?: DeleteAssistantCommandOutput) => void): void; + deleteAssistant( args: DeleteAssistantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAssistantCommandOutput) => void ): void; - public deleteAssistant( - args: DeleteAssistantCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAssistantCommandOutput) => void), - cb?: (err: any, data?: DeleteAssistantCommandOutput) => void - ): Promise | void { - const command = new DeleteAssistantCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes an assistant association.

+ * @see {@link DeleteAssistantAssociationCommand} */ - public deleteAssistantAssociation( + deleteAssistantAssociation( args: DeleteAssistantAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAssistantAssociation( + deleteAssistantAssociation( args: DeleteAssistantAssociationCommandInput, cb: (err: any, data?: DeleteAssistantAssociationCommandOutput) => void ): void; - public deleteAssistantAssociation( + deleteAssistantAssociation( args: DeleteAssistantAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAssistantAssociationCommandOutput) => void ): void; - public deleteAssistantAssociation( - args: DeleteAssistantAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAssistantAssociationCommandOutput) => void), - cb?: (err: any, data?: DeleteAssistantAssociationCommandOutput) => void - ): Promise | void { - const command = new DeleteAssistantAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the content.

+ * @see {@link DeleteContentCommand} */ - public deleteContent( - args: DeleteContentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteContent( - args: DeleteContentCommandInput, - cb: (err: any, data?: DeleteContentCommandOutput) => void - ): void; - public deleteContent( + deleteContent(args: DeleteContentCommandInput, options?: __HttpHandlerOptions): Promise; + deleteContent(args: DeleteContentCommandInput, cb: (err: any, data?: DeleteContentCommandOutput) => void): void; + deleteContent( args: DeleteContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteContentCommandOutput) => void ): void; - public deleteContent( - args: DeleteContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteContentCommandOutput) => void), - cb?: (err: any, data?: DeleteContentCommandOutput) => void - ): Promise | void { - const command = new DeleteContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the knowledge base.

- * - *

When you use this API to delete an external knowledge base such as Salesforce or - * ServiceNow, you must also delete the Amazon AppIntegrations - * DataIntegration. This is because you can't reuse the DataIntegration after it's been - * associated with an external knowledge base. However, you can delete and recreate it. See - * DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API - * Reference.

- *
+ * @see {@link DeleteKnowledgeBaseCommand} */ - public deleteKnowledgeBase( + deleteKnowledgeBase( args: DeleteKnowledgeBaseCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteKnowledgeBase( + deleteKnowledgeBase( args: DeleteKnowledgeBaseCommandInput, cb: (err: any, data?: DeleteKnowledgeBaseCommandOutput) => void ): void; - public deleteKnowledgeBase( + deleteKnowledgeBase( args: DeleteKnowledgeBaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteKnowledgeBaseCommandOutput) => void ): void; - public deleteKnowledgeBase( - args: DeleteKnowledgeBaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteKnowledgeBaseCommandOutput) => void), - cb?: (err: any, data?: DeleteKnowledgeBaseCommandOutput) => void - ): Promise | void { - const command = new DeleteKnowledgeBaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about an assistant.

+ * @see {@link GetAssistantCommand} */ - public getAssistant( - args: GetAssistantCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getAssistant(args: GetAssistantCommandInput, cb: (err: any, data?: GetAssistantCommandOutput) => void): void; - public getAssistant( + getAssistant(args: GetAssistantCommandInput, options?: __HttpHandlerOptions): Promise; + getAssistant(args: GetAssistantCommandInput, cb: (err: any, data?: GetAssistantCommandOutput) => void): void; + getAssistant( args: GetAssistantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAssistantCommandOutput) => void ): void; - public getAssistant( - args: GetAssistantCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAssistantCommandOutput) => void), - cb?: (err: any, data?: GetAssistantCommandOutput) => void - ): Promise | void { - const command = new GetAssistantCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about an assistant association.

+ * @see {@link GetAssistantAssociationCommand} */ - public getAssistantAssociation( + getAssistantAssociation( args: GetAssistantAssociationCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAssistantAssociation( + getAssistantAssociation( args: GetAssistantAssociationCommandInput, cb: (err: any, data?: GetAssistantAssociationCommandOutput) => void ): void; - public getAssistantAssociation( + getAssistantAssociation( args: GetAssistantAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAssistantAssociationCommandOutput) => void ): void; - public getAssistantAssociation( - args: GetAssistantAssociationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAssistantAssociationCommandOutput) => void), - cb?: (err: any, data?: GetAssistantAssociationCommandOutput) => void - ): Promise | void { - const command = new GetAssistantAssociationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves content, including a pre-signed URL to download the content.

+ * @see {@link GetContentCommand} */ - public getContent(args: GetContentCommandInput, options?: __HttpHandlerOptions): Promise; - public getContent(args: GetContentCommandInput, cb: (err: any, data?: GetContentCommandOutput) => void): void; - public getContent( + getContent(args: GetContentCommandInput, options?: __HttpHandlerOptions): Promise; + getContent(args: GetContentCommandInput, cb: (err: any, data?: GetContentCommandOutput) => void): void; + getContent( args: GetContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContentCommandOutput) => void ): void; - public getContent( - args: GetContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContentCommandOutput) => void), - cb?: (err: any, data?: GetContentCommandOutput) => void - ): Promise | void { - const command = new GetContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves summary information about the content.

+ * @see {@link GetContentSummaryCommand} */ - public getContentSummary( + getContentSummary( args: GetContentSummaryCommandInput, options?: __HttpHandlerOptions ): Promise; - public getContentSummary( + getContentSummary( args: GetContentSummaryCommandInput, cb: (err: any, data?: GetContentSummaryCommandOutput) => void ): void; - public getContentSummary( + getContentSummary( args: GetContentSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContentSummaryCommandOutput) => void ): void; - public getContentSummary( - args: GetContentSummaryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetContentSummaryCommandOutput) => void), - cb?: (err: any, data?: GetContentSummaryCommandOutput) => void - ): Promise | void { - const command = new GetContentSummaryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about the knowledge base.

+ * @see {@link GetKnowledgeBaseCommand} */ - public getKnowledgeBase( + getKnowledgeBase( args: GetKnowledgeBaseCommandInput, options?: __HttpHandlerOptions ): Promise; - public getKnowledgeBase( + getKnowledgeBase( args: GetKnowledgeBaseCommandInput, cb: (err: any, data?: GetKnowledgeBaseCommandOutput) => void ): void; - public getKnowledgeBase( + getKnowledgeBase( args: GetKnowledgeBaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetKnowledgeBaseCommandOutput) => void ): void; - public getKnowledgeBase( - args: GetKnowledgeBaseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetKnowledgeBaseCommandOutput) => void), - cb?: (err: any, data?: GetKnowledgeBaseCommandOutput) => void - ): Promise | void { - const command = new GetKnowledgeBaseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves recommendations for the specified session. To avoid retrieving the same - * recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the - * waitTimeSeconds parameter. Short poll is the default behavior and only returns - * recommendations already available. To perform a manual query against an assistant, use QueryAssistant.

+ * @see {@link GetRecommendationsCommand} */ - public getRecommendations( + getRecommendations( args: GetRecommendationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRecommendations( + getRecommendations( args: GetRecommendationsCommandInput, cb: (err: any, data?: GetRecommendationsCommandOutput) => void ): void; - public getRecommendations( + getRecommendations( args: GetRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRecommendationsCommandOutput) => void ): void; - public getRecommendations( - args: GetRecommendationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRecommendationsCommandOutput) => void), - cb?: (err: any, data?: GetRecommendationsCommandOutput) => void - ): Promise | void { - const command = new GetRecommendationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information for a specified session.

+ * @see {@link GetSessionCommand} */ - public getSession(args: GetSessionCommandInput, options?: __HttpHandlerOptions): Promise; - public getSession(args: GetSessionCommandInput, cb: (err: any, data?: GetSessionCommandOutput) => void): void; - public getSession( + getSession(args: GetSessionCommandInput, options?: __HttpHandlerOptions): Promise; + getSession(args: GetSessionCommandInput, cb: (err: any, data?: GetSessionCommandOutput) => void): void; + getSession( args: GetSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSessionCommandOutput) => void ): void; - public getSession( - args: GetSessionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSessionCommandOutput) => void), - cb?: (err: any, data?: GetSessionCommandOutput) => void - ): Promise | void { - const command = new GetSessionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists information about assistant associations.

+ * @see {@link ListAssistantAssociationsCommand} */ - public listAssistantAssociations( + listAssistantAssociations( args: ListAssistantAssociationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssistantAssociations( + listAssistantAssociations( args: ListAssistantAssociationsCommandInput, cb: (err: any, data?: ListAssistantAssociationsCommandOutput) => void ): void; - public listAssistantAssociations( + listAssistantAssociations( args: ListAssistantAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssistantAssociationsCommandOutput) => void ): void; - public listAssistantAssociations( - args: ListAssistantAssociationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssistantAssociationsCommandOutput) => void), - cb?: (err: any, data?: ListAssistantAssociationsCommandOutput) => void - ): Promise | void { - const command = new ListAssistantAssociationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists information about assistants.

+ * @see {@link ListAssistantsCommand} */ - public listAssistants( + listAssistants( args: ListAssistantsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAssistants( - args: ListAssistantsCommandInput, - cb: (err: any, data?: ListAssistantsCommandOutput) => void - ): void; - public listAssistants( + listAssistants(args: ListAssistantsCommandInput, cb: (err: any, data?: ListAssistantsCommandOutput) => void): void; + listAssistants( args: ListAssistantsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssistantsCommandOutput) => void ): void; - public listAssistants( - args: ListAssistantsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssistantsCommandOutput) => void), - cb?: (err: any, data?: ListAssistantsCommandOutput) => void - ): Promise | void { - const command = new ListAssistantsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the content.

+ * @see {@link ListContentsCommand} */ - public listContents( - args: ListContentsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listContents(args: ListContentsCommandInput, cb: (err: any, data?: ListContentsCommandOutput) => void): void; - public listContents( + listContents(args: ListContentsCommandInput, options?: __HttpHandlerOptions): Promise; + listContents(args: ListContentsCommandInput, cb: (err: any, data?: ListContentsCommandOutput) => void): void; + listContents( args: ListContentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListContentsCommandOutput) => void ): void; - public listContents( - args: ListContentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListContentsCommandOutput) => void), - cb?: (err: any, data?: ListContentsCommandOutput) => void - ): Promise | void { - const command = new ListContentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the knowledge bases.

+ * @see {@link ListKnowledgeBasesCommand} */ - public listKnowledgeBases( + listKnowledgeBases( args: ListKnowledgeBasesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listKnowledgeBases( + listKnowledgeBases( args: ListKnowledgeBasesCommandInput, cb: (err: any, data?: ListKnowledgeBasesCommandOutput) => void ): void; - public listKnowledgeBases( + listKnowledgeBases( args: ListKnowledgeBasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKnowledgeBasesCommandOutput) => void ): void; - public listKnowledgeBases( - args: ListKnowledgeBasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListKnowledgeBasesCommandOutput) => void), - cb?: (err: any, data?: ListKnowledgeBasesCommandOutput) => void - ): Promise | void { - const command = new ListKnowledgeBasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the tags for the specified resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified recommendations from the specified assistant's queue of newly - * available recommendations. You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling - * behavior and avoiding duplicate recommendations.

+ * @see {@link NotifyRecommendationsReceivedCommand} */ - public notifyRecommendationsReceived( + notifyRecommendationsReceived( args: NotifyRecommendationsReceivedCommandInput, options?: __HttpHandlerOptions ): Promise; - public notifyRecommendationsReceived( + notifyRecommendationsReceived( args: NotifyRecommendationsReceivedCommandInput, cb: (err: any, data?: NotifyRecommendationsReceivedCommandOutput) => void ): void; - public notifyRecommendationsReceived( + notifyRecommendationsReceived( args: NotifyRecommendationsReceivedCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NotifyRecommendationsReceivedCommandOutput) => void ): void; - public notifyRecommendationsReceived( - args: NotifyRecommendationsReceivedCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NotifyRecommendationsReceivedCommandOutput) => void), - cb?: (err: any, data?: NotifyRecommendationsReceivedCommandOutput) => void - ): Promise | void { - const command = new NotifyRecommendationsReceivedCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Performs a manual search against the specified assistant. To retrieve recommendations for - * an assistant, use GetRecommendations. - *

+ * @see {@link QueryAssistantCommand} */ - public queryAssistant( + queryAssistant( args: QueryAssistantCommandInput, options?: __HttpHandlerOptions ): Promise; - public queryAssistant( - args: QueryAssistantCommandInput, - cb: (err: any, data?: QueryAssistantCommandOutput) => void - ): void; - public queryAssistant( + queryAssistant(args: QueryAssistantCommandInput, cb: (err: any, data?: QueryAssistantCommandOutput) => void): void; + queryAssistant( args: QueryAssistantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryAssistantCommandOutput) => void ): void; - public queryAssistant( - args: QueryAssistantCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryAssistantCommandOutput) => void), - cb?: (err: any, data?: QueryAssistantCommandOutput) => void - ): Promise | void { - const command = new QueryAssistantCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes a URI template from a knowledge base.

+ * @see {@link RemoveKnowledgeBaseTemplateUriCommand} */ - public removeKnowledgeBaseTemplateUri( + removeKnowledgeBaseTemplateUri( args: RemoveKnowledgeBaseTemplateUriCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeKnowledgeBaseTemplateUri( + removeKnowledgeBaseTemplateUri( args: RemoveKnowledgeBaseTemplateUriCommandInput, cb: (err: any, data?: RemoveKnowledgeBaseTemplateUriCommandOutput) => void ): void; - public removeKnowledgeBaseTemplateUri( + removeKnowledgeBaseTemplateUri( args: RemoveKnowledgeBaseTemplateUriCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveKnowledgeBaseTemplateUriCommandOutput) => void ): void; - public removeKnowledgeBaseTemplateUri( - args: RemoveKnowledgeBaseTemplateUriCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveKnowledgeBaseTemplateUriCommandOutput) => void), - cb?: (err: any, data?: RemoveKnowledgeBaseTemplateUriCommandOutput) => void - ): Promise | void { - const command = new RemoveKnowledgeBaseTemplateUriCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Searches for content in a specified knowledge base. Can be used to get a specific content - * resource by its name.

+ * @see {@link SearchContentCommand} */ - public searchContent( - args: SearchContentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public searchContent( - args: SearchContentCommandInput, - cb: (err: any, data?: SearchContentCommandOutput) => void - ): void; - public searchContent( + searchContent(args: SearchContentCommandInput, options?: __HttpHandlerOptions): Promise; + searchContent(args: SearchContentCommandInput, cb: (err: any, data?: SearchContentCommandOutput) => void): void; + searchContent( args: SearchContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchContentCommandOutput) => void ): void; - public searchContent( - args: SearchContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchContentCommandOutput) => void), - cb?: (err: any, data?: SearchContentCommandOutput) => void - ): Promise | void { - const command = new SearchContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Searches for sessions.

+ * @see {@link SearchSessionsCommand} */ - public searchSessions( + searchSessions( args: SearchSessionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchSessions( - args: SearchSessionsCommandInput, - cb: (err: any, data?: SearchSessionsCommandOutput) => void - ): void; - public searchSessions( + searchSessions(args: SearchSessionsCommandInput, cb: (err: any, data?: SearchSessionsCommandOutput) => void): void; + searchSessions( args: SearchSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchSessionsCommandOutput) => void ): void; - public searchSessions( - args: SearchSessionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchSessionsCommandOutput) => void), - cb?: (err: any, data?: SearchSessionsCommandOutput) => void - ): Promise | void { - const command = new SearchSessionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get a URL to upload content to a knowledge base. To upload content, first make a PUT - * request to the returned URL with your file, making sure to include the required headers. Then - * use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a - * knowledge base of type CUSTOM.

+ * @see {@link StartContentUploadCommand} */ - public startContentUpload( + startContentUpload( args: StartContentUploadCommandInput, options?: __HttpHandlerOptions ): Promise; - public startContentUpload( + startContentUpload( args: StartContentUploadCommandInput, cb: (err: any, data?: StartContentUploadCommandOutput) => void ): void; - public startContentUpload( + startContentUpload( args: StartContentUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartContentUploadCommandOutput) => void ): void; - public startContentUpload( - args: StartContentUploadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartContentUploadCommandOutput) => void), - cb?: (err: any, data?: StartContentUploadCommandOutput) => void - ): Promise | void { - const command = new StartContentUploadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds the specified tags to the specified resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the specified tags from the specified resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates information about the content.

+ * @see {@link UpdateContentCommand} */ - public updateContent( - args: UpdateContentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateContent( - args: UpdateContentCommandInput, - cb: (err: any, data?: UpdateContentCommandOutput) => void - ): void; - public updateContent( + updateContent(args: UpdateContentCommandInput, options?: __HttpHandlerOptions): Promise; + updateContent(args: UpdateContentCommandInput, cb: (err: any, data?: UpdateContentCommandOutput) => void): void; + updateContent( args: UpdateContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContentCommandOutput) => void ): void; - public updateContent( - args: UpdateContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateContentCommandOutput) => void), - cb?: (err: any, data?: UpdateContentCommandOutput) => void - ): Promise | void { - const command = new UpdateContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the template URI of a knowledge base. This is only supported for knowledge bases - * of type EXTERNAL. Include a single variable in $\{variable\} format; this - * interpolated by Wisdom using ingested content. For example, if you ingest a Salesforce - * article, it has an Id value, and you can set the template URI to - * https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*$\{Id\}*\/view. - *

+ * @see {@link UpdateKnowledgeBaseTemplateUriCommand} */ - public updateKnowledgeBaseTemplateUri( + updateKnowledgeBaseTemplateUri( args: UpdateKnowledgeBaseTemplateUriCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateKnowledgeBaseTemplateUri( + updateKnowledgeBaseTemplateUri( args: UpdateKnowledgeBaseTemplateUriCommandInput, cb: (err: any, data?: UpdateKnowledgeBaseTemplateUriCommandOutput) => void ): void; - public updateKnowledgeBaseTemplateUri( + updateKnowledgeBaseTemplateUri( args: UpdateKnowledgeBaseTemplateUriCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateKnowledgeBaseTemplateUriCommandOutput) => void ): void; - public updateKnowledgeBaseTemplateUri( - args: UpdateKnowledgeBaseTemplateUriCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateKnowledgeBaseTemplateUriCommandOutput) => void), - cb?: (err: any, data?: UpdateKnowledgeBaseTemplateUriCommandOutput) => void - ): Promise | void { - const command = new UpdateKnowledgeBaseTemplateUriCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're + * actively speaking with customers. Agents can search across connected repositories from within + * their agent desktop to find answers quickly. Use Amazon Connect Wisdom to create an assistant and a + * knowledge base, for example, or manage content by uploading custom files.

+ */ +export class Wisdom extends WisdomClient implements Wisdom {} +createAggregatedClient(commands, Wisdom); diff --git a/clients/client-workdocs/src/WorkDocs.ts b/clients/client-workdocs/src/WorkDocs.ts index 92a700cfc99f..cddbc4db5f71 100644 --- a/clients/client-workdocs/src/WorkDocs.ts +++ b/clients/client-workdocs/src/WorkDocs.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -201,1533 +202,749 @@ import { UpdateFolderCommandOutput, } from "./commands/UpdateFolderCommand"; import { UpdateUserCommand, UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand"; -import { WorkDocsClient } from "./WorkDocsClient"; +import { WorkDocsClient, WorkDocsClientConfig } from "./WorkDocsClient"; -/** - * @public - *

The Amazon WorkDocs API is designed for the following use cases:

- *
    - *
  • - *

    File Migration: File migration applications are supported for users who - * want to migrate their files from an on-premises or off-premises file system or - * service. Users can insert files into a user directory structure, as well as - * allow for basic metadata changes, such as modifications to the permissions of - * files.

    - *
  • - *
  • - *

    Security: Support security applications are supported for users who have - * additional security needs, such as antivirus or data loss prevention. The API - * actions, along with CloudTrail, allow these applications to detect when - * changes occur in Amazon WorkDocs. Then, the application can take the necessary - * actions and replace the target file. If the target file violates the policy, the - * application can also choose to email the user.

    - *
  • - *
  • - *

    eDiscovery/Analytics: General administrative applications are supported, - * such as eDiscovery and analytics. These applications can choose to mimic or - * record the actions in an Amazon WorkDocs site, along with CloudTrail, to - * replicate data for eDiscovery, backup, or analytical applications.

    - *
  • - *
- *

All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed. - * They not only require the use of the Amazon Web Services SDK, but also allow for the exclusive use of - * IAM users and roles to help facilitate access, trust, and permission policies. By - * creating a role and allowing an IAM user to access the Amazon WorkDocs site, the - * IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as - * set in the IAM policy). This includes, but is not limited to, the ability to modify file - * permissions and upload any file to any user. This allows developers to perform the three - * use cases above, as well as give users the ability to grant access on a selective basis - * using the IAM model.

- * - *

The pricing for Amazon WorkDocs APIs varies depending on the API call type for these actions:

- *
    - *
  • - *

    - * READ (Get*) - *

    - *
  • - *
  • - *

    - * WRITE (Activate*, Add*, Create*, Deactivate*, Initiate*, Update*) - *

    - *
  • - *
  • - *

    - * LIST (Describe*) - *

    - *
  • - *
  • - *

    - * DELETE*, CANCEL - *

    - *
  • - *
- *

For information about Amazon WorkDocs API pricing, see Amazon WorkDocs Pricing.

- *
- */ -export class WorkDocs extends WorkDocsClient { +const commands = { + AbortDocumentVersionUploadCommand, + ActivateUserCommand, + AddResourcePermissionsCommand, + CreateCommentCommand, + CreateCustomMetadataCommand, + CreateFolderCommand, + CreateLabelsCommand, + CreateNotificationSubscriptionCommand, + CreateUserCommand, + DeactivateUserCommand, + DeleteCommentCommand, + DeleteCustomMetadataCommand, + DeleteDocumentCommand, + DeleteDocumentVersionCommand, + DeleteFolderCommand, + DeleteFolderContentsCommand, + DeleteLabelsCommand, + DeleteNotificationSubscriptionCommand, + DeleteUserCommand, + DescribeActivitiesCommand, + DescribeCommentsCommand, + DescribeDocumentVersionsCommand, + DescribeFolderContentsCommand, + DescribeGroupsCommand, + DescribeNotificationSubscriptionsCommand, + DescribeResourcePermissionsCommand, + DescribeRootFoldersCommand, + DescribeUsersCommand, + GetCurrentUserCommand, + GetDocumentCommand, + GetDocumentPathCommand, + GetDocumentVersionCommand, + GetFolderCommand, + GetFolderPathCommand, + GetResourcesCommand, + InitiateDocumentVersionUploadCommand, + RemoveAllResourcePermissionsCommand, + RemoveResourcePermissionCommand, + RestoreDocumentVersionsCommand, + SearchResourcesCommand, + UpdateDocumentCommand, + UpdateDocumentVersionCommand, + UpdateFolderCommand, + UpdateUserCommand, +}; + +export interface WorkDocs { /** - * @public - *

Aborts the upload of the specified document version that was previously initiated - * by InitiateDocumentVersionUpload. The client should make this call - * only when it no longer intends to upload the document version, or fails to do - * so.

+ * @see {@link AbortDocumentVersionUploadCommand} */ - public abortDocumentVersionUpload( + abortDocumentVersionUpload( args: AbortDocumentVersionUploadCommandInput, options?: __HttpHandlerOptions ): Promise; - public abortDocumentVersionUpload( + abortDocumentVersionUpload( args: AbortDocumentVersionUploadCommandInput, cb: (err: any, data?: AbortDocumentVersionUploadCommandOutput) => void ): void; - public abortDocumentVersionUpload( + abortDocumentVersionUpload( args: AbortDocumentVersionUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AbortDocumentVersionUploadCommandOutput) => void ): void; - public abortDocumentVersionUpload( - args: AbortDocumentVersionUploadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AbortDocumentVersionUploadCommandOutput) => void), - cb?: (err: any, data?: AbortDocumentVersionUploadCommandOutput) => void - ): Promise | void { - const command = new AbortDocumentVersionUploadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Activates the specified user. Only active users can access Amazon - * WorkDocs.

+ * @see {@link ActivateUserCommand} */ - public activateUser( - args: ActivateUserCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public activateUser(args: ActivateUserCommandInput, cb: (err: any, data?: ActivateUserCommandOutput) => void): void; - public activateUser( + activateUser(args: ActivateUserCommandInput, options?: __HttpHandlerOptions): Promise; + activateUser(args: ActivateUserCommandInput, cb: (err: any, data?: ActivateUserCommandOutput) => void): void; + activateUser( args: ActivateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ActivateUserCommandOutput) => void ): void; - public activateUser( - args: ActivateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ActivateUserCommandOutput) => void), - cb?: (err: any, data?: ActivateUserCommandOutput) => void - ): Promise | void { - const command = new ActivateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a set of permissions for the specified folder or document. The resource - * permissions are overwritten if the principals already have different - * permissions.

+ * @see {@link AddResourcePermissionsCommand} */ - public addResourcePermissions( + addResourcePermissions( args: AddResourcePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public addResourcePermissions( + addResourcePermissions( args: AddResourcePermissionsCommandInput, cb: (err: any, data?: AddResourcePermissionsCommandOutput) => void ): void; - public addResourcePermissions( + addResourcePermissions( args: AddResourcePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddResourcePermissionsCommandOutput) => void ): void; - public addResourcePermissions( - args: AddResourcePermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AddResourcePermissionsCommandOutput) => void), - cb?: (err: any, data?: AddResourcePermissionsCommandOutput) => void - ): Promise | void { - const command = new AddResourcePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds a new comment to the specified document version.

+ * @see {@link CreateCommentCommand} */ - public createComment( - args: CreateCommentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createComment( - args: CreateCommentCommandInput, - cb: (err: any, data?: CreateCommentCommandOutput) => void - ): void; - public createComment( + createComment(args: CreateCommentCommandInput, options?: __HttpHandlerOptions): Promise; + createComment(args: CreateCommentCommandInput, cb: (err: any, data?: CreateCommentCommandOutput) => void): void; + createComment( args: CreateCommentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCommentCommandOutput) => void ): void; - public createComment( - args: CreateCommentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCommentCommandOutput) => void), - cb?: (err: any, data?: CreateCommentCommandOutput) => void - ): Promise | void { - const command = new CreateCommentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds one or more custom properties to the specified resource (a folder, document, - * or version).

+ * @see {@link CreateCustomMetadataCommand} */ - public createCustomMetadata( + createCustomMetadata( args: CreateCustomMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public createCustomMetadata( + createCustomMetadata( args: CreateCustomMetadataCommandInput, cb: (err: any, data?: CreateCustomMetadataCommandOutput) => void ): void; - public createCustomMetadata( + createCustomMetadata( args: CreateCustomMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomMetadataCommandOutput) => void ): void; - public createCustomMetadata( - args: CreateCustomMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateCustomMetadataCommandOutput) => void), - cb?: (err: any, data?: CreateCustomMetadataCommandOutput) => void - ): Promise | void { - const command = new CreateCustomMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a folder with the specified name and parent folder.

+ * @see {@link CreateFolderCommand} */ - public createFolder( - args: CreateFolderCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createFolder(args: CreateFolderCommandInput, cb: (err: any, data?: CreateFolderCommandOutput) => void): void; - public createFolder( + createFolder(args: CreateFolderCommandInput, options?: __HttpHandlerOptions): Promise; + createFolder(args: CreateFolderCommandInput, cb: (err: any, data?: CreateFolderCommandOutput) => void): void; + createFolder( args: CreateFolderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFolderCommandOutput) => void ): void; - public createFolder( - args: CreateFolderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFolderCommandOutput) => void), - cb?: (err: any, data?: CreateFolderCommandOutput) => void - ): Promise | void { - const command = new CreateFolderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds the specified list of labels to the given resource (a document or - * folder)

+ * @see {@link CreateLabelsCommand} */ - public createLabels( - args: CreateLabelsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createLabels(args: CreateLabelsCommandInput, cb: (err: any, data?: CreateLabelsCommandOutput) => void): void; - public createLabels( + createLabels(args: CreateLabelsCommandInput, options?: __HttpHandlerOptions): Promise; + createLabels(args: CreateLabelsCommandInput, cb: (err: any, data?: CreateLabelsCommandOutput) => void): void; + createLabels( args: CreateLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLabelsCommandOutput) => void ): void; - public createLabels( - args: CreateLabelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateLabelsCommandOutput) => void), - cb?: (err: any, data?: CreateLabelsCommandOutput) => void - ): Promise | void { - const command = new CreateLabelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a - * confirmation message, and must confirm the subscription.

- *

For more information, see Setting up notifications for an IAM user or role in the Amazon WorkDocs Developer - * Guide.

+ * @see {@link CreateNotificationSubscriptionCommand} */ - public createNotificationSubscription( + createNotificationSubscription( args: CreateNotificationSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNotificationSubscription( + createNotificationSubscription( args: CreateNotificationSubscriptionCommandInput, cb: (err: any, data?: CreateNotificationSubscriptionCommandOutput) => void ): void; - public createNotificationSubscription( + createNotificationSubscription( args: CreateNotificationSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNotificationSubscriptionCommandOutput) => void ): void; - public createNotificationSubscription( - args: CreateNotificationSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNotificationSubscriptionCommandOutput) => void), - cb?: (err: any, data?: CreateNotificationSubscriptionCommandOutput) => void - ): Promise | void { - const command = new CreateNotificationSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a user in a Simple AD or Microsoft AD directory. The status of a newly - * created user is "ACTIVE". New users can access Amazon WorkDocs.

+ * @see {@link CreateUserCommand} */ - public createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; - public createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; - public createUser( + createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; + createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; + createUser( args: CreateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserCommandOutput) => void ): void; - public createUser( - args: CreateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserCommandOutput) => void), - cb?: (err: any, data?: CreateUserCommandOutput) => void - ): Promise | void { - const command = new CreateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deactivates the specified user, which revokes the user's access to Amazon - * WorkDocs.

+ * @see {@link DeactivateUserCommand} */ - public deactivateUser( + deactivateUser( args: DeactivateUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public deactivateUser( - args: DeactivateUserCommandInput, - cb: (err: any, data?: DeactivateUserCommandOutput) => void - ): void; - public deactivateUser( + deactivateUser(args: DeactivateUserCommandInput, cb: (err: any, data?: DeactivateUserCommandOutput) => void): void; + deactivateUser( args: DeactivateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeactivateUserCommandOutput) => void ): void; - public deactivateUser( - args: DeactivateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeactivateUserCommandOutput) => void), - cb?: (err: any, data?: DeactivateUserCommandOutput) => void - ): Promise | void { - const command = new DeactivateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified comment from the document version.

+ * @see {@link DeleteCommentCommand} */ - public deleteComment( - args: DeleteCommentCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteComment( - args: DeleteCommentCommandInput, - cb: (err: any, data?: DeleteCommentCommandOutput) => void - ): void; - public deleteComment( + deleteComment(args: DeleteCommentCommandInput, options?: __HttpHandlerOptions): Promise; + deleteComment(args: DeleteCommentCommandInput, cb: (err: any, data?: DeleteCommentCommandOutput) => void): void; + deleteComment( args: DeleteCommentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCommentCommandOutput) => void ): void; - public deleteComment( - args: DeleteCommentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCommentCommandOutput) => void), - cb?: (err: any, data?: DeleteCommentCommandOutput) => void - ): Promise | void { - const command = new DeleteCommentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes custom metadata from the specified resource.

+ * @see {@link DeleteCustomMetadataCommand} */ - public deleteCustomMetadata( + deleteCustomMetadata( args: DeleteCustomMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteCustomMetadata( + deleteCustomMetadata( args: DeleteCustomMetadataCommandInput, cb: (err: any, data?: DeleteCustomMetadataCommandOutput) => void ): void; - public deleteCustomMetadata( + deleteCustomMetadata( args: DeleteCustomMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomMetadataCommandOutput) => void ): void; - public deleteCustomMetadata( - args: DeleteCustomMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteCustomMetadataCommandOutput) => void), - cb?: (err: any, data?: DeleteCustomMetadataCommandOutput) => void - ): Promise | void { - const command = new DeleteCustomMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Permanently deletes the specified document and its associated metadata.

+ * @see {@link DeleteDocumentCommand} */ - public deleteDocument( + deleteDocument( args: DeleteDocumentCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDocument( - args: DeleteDocumentCommandInput, - cb: (err: any, data?: DeleteDocumentCommandOutput) => void - ): void; - public deleteDocument( + deleteDocument(args: DeleteDocumentCommandInput, cb: (err: any, data?: DeleteDocumentCommandOutput) => void): void; + deleteDocument( args: DeleteDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDocumentCommandOutput) => void ): void; - public deleteDocument( - args: DeleteDocumentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDocumentCommandOutput) => void), - cb?: (err: any, data?: DeleteDocumentCommandOutput) => void - ): Promise | void { - const command = new DeleteDocumentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a specific version of a document.

+ * @see {@link DeleteDocumentVersionCommand} */ - public deleteDocumentVersion( + deleteDocumentVersion( args: DeleteDocumentVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteDocumentVersion( + deleteDocumentVersion( args: DeleteDocumentVersionCommandInput, cb: (err: any, data?: DeleteDocumentVersionCommandOutput) => void ): void; - public deleteDocumentVersion( + deleteDocumentVersion( args: DeleteDocumentVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDocumentVersionCommandOutput) => void ): void; - public deleteDocumentVersion( - args: DeleteDocumentVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteDocumentVersionCommandOutput) => void), - cb?: (err: any, data?: DeleteDocumentVersionCommandOutput) => void - ): Promise | void { - const command = new DeleteDocumentVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Permanently deletes the specified folder and its contents.

+ * @see {@link DeleteFolderCommand} */ - public deleteFolder( - args: DeleteFolderCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteFolder(args: DeleteFolderCommandInput, cb: (err: any, data?: DeleteFolderCommandOutput) => void): void; - public deleteFolder( + deleteFolder(args: DeleteFolderCommandInput, options?: __HttpHandlerOptions): Promise; + deleteFolder(args: DeleteFolderCommandInput, cb: (err: any, data?: DeleteFolderCommandOutput) => void): void; + deleteFolder( args: DeleteFolderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFolderCommandOutput) => void ): void; - public deleteFolder( - args: DeleteFolderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFolderCommandOutput) => void), - cb?: (err: any, data?: DeleteFolderCommandOutput) => void - ): Promise | void { - const command = new DeleteFolderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the contents of the specified folder.

+ * @see {@link DeleteFolderContentsCommand} */ - public deleteFolderContents( + deleteFolderContents( args: DeleteFolderContentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteFolderContents( + deleteFolderContents( args: DeleteFolderContentsCommandInput, cb: (err: any, data?: DeleteFolderContentsCommandOutput) => void ): void; - public deleteFolderContents( + deleteFolderContents( args: DeleteFolderContentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFolderContentsCommandOutput) => void ): void; - public deleteFolderContents( - args: DeleteFolderContentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFolderContentsCommandOutput) => void), - cb?: (err: any, data?: DeleteFolderContentsCommandOutput) => void - ): Promise | void { - const command = new DeleteFolderContentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified list of labels from a resource.

+ * @see {@link DeleteLabelsCommand} */ - public deleteLabels( - args: DeleteLabelsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteLabels(args: DeleteLabelsCommandInput, cb: (err: any, data?: DeleteLabelsCommandOutput) => void): void; - public deleteLabels( + deleteLabels(args: DeleteLabelsCommandInput, options?: __HttpHandlerOptions): Promise; + deleteLabels(args: DeleteLabelsCommandInput, cb: (err: any, data?: DeleteLabelsCommandOutput) => void): void; + deleteLabels( args: DeleteLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLabelsCommandOutput) => void ): void; - public deleteLabels( - args: DeleteLabelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteLabelsCommandOutput) => void), - cb?: (err: any, data?: DeleteLabelsCommandOutput) => void - ): Promise | void { - const command = new DeleteLabelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified subscription from the specified organization.

+ * @see {@link DeleteNotificationSubscriptionCommand} */ - public deleteNotificationSubscription( + deleteNotificationSubscription( args: DeleteNotificationSubscriptionCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNotificationSubscription( + deleteNotificationSubscription( args: DeleteNotificationSubscriptionCommandInput, cb: (err: any, data?: DeleteNotificationSubscriptionCommandOutput) => void ): void; - public deleteNotificationSubscription( + deleteNotificationSubscription( args: DeleteNotificationSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNotificationSubscriptionCommandOutput) => void ): void; - public deleteNotificationSubscription( - args: DeleteNotificationSubscriptionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNotificationSubscriptionCommandOutput) => void), - cb?: (err: any, data?: DeleteNotificationSubscriptionCommandOutput) => void - ): Promise | void { - const command = new DeleteNotificationSubscriptionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the specified user from a Simple AD or Microsoft AD directory.

- * - *

Deleting a user immediately and permanently deletes all content in that user's folder structure. Site retention policies do NOT apply to this type of deletion.

- *
+ * @see {@link DeleteUserCommand} */ - public deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; - public deleteUser( + deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; + deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; + deleteUser( args: DeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserCommandOutput) => void ): void; - public deleteUser( - args: DeleteUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserCommandOutput) => void), - cb?: (err: any, data?: DeleteUserCommandOutput) => void - ): Promise | void { - const command = new DeleteUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the user activities in a specified time period.

+ * @see {@link DescribeActivitiesCommand} */ - public describeActivities( + describeActivities( args: DescribeActivitiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeActivities( + describeActivities( args: DescribeActivitiesCommandInput, cb: (err: any, data?: DescribeActivitiesCommandOutput) => void ): void; - public describeActivities( + describeActivities( args: DescribeActivitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeActivitiesCommandOutput) => void ): void; - public describeActivities( - args: DescribeActivitiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeActivitiesCommandOutput) => void), - cb?: (err: any, data?: DescribeActivitiesCommandOutput) => void - ): Promise | void { - const command = new DescribeActivitiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

List all the comments for the specified document version.

+ * @see {@link DescribeCommentsCommand} */ - public describeComments( + describeComments( args: DescribeCommentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeComments( + describeComments( args: DescribeCommentsCommandInput, cb: (err: any, data?: DescribeCommentsCommandOutput) => void ): void; - public describeComments( + describeComments( args: DescribeCommentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCommentsCommandOutput) => void ): void; - public describeComments( - args: DescribeCommentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCommentsCommandOutput) => void), - cb?: (err: any, data?: DescribeCommentsCommandOutput) => void - ): Promise | void { - const command = new DescribeCommentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the document versions for the specified document.

- *

By default, only active versions are returned.

+ * @see {@link DescribeDocumentVersionsCommand} */ - public describeDocumentVersions( + describeDocumentVersions( args: DescribeDocumentVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDocumentVersions( + describeDocumentVersions( args: DescribeDocumentVersionsCommandInput, cb: (err: any, data?: DescribeDocumentVersionsCommandOutput) => void ): void; - public describeDocumentVersions( + describeDocumentVersions( args: DescribeDocumentVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDocumentVersionsCommandOutput) => void ): void; - public describeDocumentVersions( - args: DescribeDocumentVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDocumentVersionsCommandOutput) => void), - cb?: (err: any, data?: DescribeDocumentVersionsCommandOutput) => void - ): Promise | void { - const command = new DescribeDocumentVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the contents of the specified folder, including its documents and - * subfolders.

- *

By default, Amazon WorkDocs returns the first 100 active document and folder - * metadata items. If there are more results, the response includes a marker that you can - * use to request the next set of results. You can also request initialized - * documents.

+ * @see {@link DescribeFolderContentsCommand} */ - public describeFolderContents( + describeFolderContents( args: DescribeFolderContentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFolderContents( + describeFolderContents( args: DescribeFolderContentsCommandInput, cb: (err: any, data?: DescribeFolderContentsCommandOutput) => void ): void; - public describeFolderContents( + describeFolderContents( args: DescribeFolderContentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFolderContentsCommandOutput) => void ): void; - public describeFolderContents( - args: DescribeFolderContentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFolderContentsCommandOutput) => void), - cb?: (err: any, data?: DescribeFolderContentsCommandOutput) => void - ): Promise | void { - const command = new DescribeFolderContentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the groups specified by the query. Groups are defined by the underlying - * Active Directory.

+ * @see {@link DescribeGroupsCommand} */ - public describeGroups( + describeGroups( args: DescribeGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeGroups( - args: DescribeGroupsCommandInput, - cb: (err: any, data?: DescribeGroupsCommandOutput) => void - ): void; - public describeGroups( + describeGroups(args: DescribeGroupsCommandInput, cb: (err: any, data?: DescribeGroupsCommandOutput) => void): void; + describeGroups( args: DescribeGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGroupsCommandOutput) => void ): void; - public describeGroups( - args: DescribeGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Lists the specified notification subscriptions.

+ * @see {@link DescribeNotificationSubscriptionsCommand} */ - public describeNotificationSubscriptions( + describeNotificationSubscriptions( args: DescribeNotificationSubscriptionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeNotificationSubscriptions( + describeNotificationSubscriptions( args: DescribeNotificationSubscriptionsCommandInput, cb: (err: any, data?: DescribeNotificationSubscriptionsCommandOutput) => void ): void; - public describeNotificationSubscriptions( + describeNotificationSubscriptions( args: DescribeNotificationSubscriptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNotificationSubscriptionsCommandOutput) => void ): void; - public describeNotificationSubscriptions( - args: DescribeNotificationSubscriptionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeNotificationSubscriptionsCommandOutput) => void), - cb?: (err: any, data?: DescribeNotificationSubscriptionsCommandOutput) => void - ): Promise | void { - const command = new DescribeNotificationSubscriptionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the permissions of a specified resource.

+ * @see {@link DescribeResourcePermissionsCommand} */ - public describeResourcePermissions( + describeResourcePermissions( args: DescribeResourcePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeResourcePermissions( + describeResourcePermissions( args: DescribeResourcePermissionsCommandInput, cb: (err: any, data?: DescribeResourcePermissionsCommandOutput) => void ): void; - public describeResourcePermissions( + describeResourcePermissions( args: DescribeResourcePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeResourcePermissionsCommandOutput) => void ): void; - public describeResourcePermissions( - args: DescribeResourcePermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeResourcePermissionsCommandOutput) => void), - cb?: (err: any, data?: DescribeResourcePermissionsCommandOutput) => void - ): Promise | void { - const command = new DescribeResourcePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the current user's special folders; the RootFolder and the - * RecycleBin. RootFolder is the root of user's files and - * folders and RecycleBin is the root of recycled items. This is not a valid - * action for SigV4 (administrative API) clients.

- *

This action requires an authentication token. To get an authentication token, - * register an application with Amazon WorkDocs. For more information, see Authentication and Access - * Control for User Applications in the - * Amazon - * WorkDocs Developer Guide.

+ * @see {@link DescribeRootFoldersCommand} */ - public describeRootFolders( + describeRootFolders( args: DescribeRootFoldersCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeRootFolders( + describeRootFolders( args: DescribeRootFoldersCommandInput, cb: (err: any, data?: DescribeRootFoldersCommandOutput) => void ): void; - public describeRootFolders( + describeRootFolders( args: DescribeRootFoldersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRootFoldersCommandOutput) => void ): void; - public describeRootFolders( - args: DescribeRootFoldersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeRootFoldersCommandOutput) => void), - cb?: (err: any, data?: DescribeRootFoldersCommandOutput) => void - ): Promise | void { - const command = new DescribeRootFoldersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Describes the specified users. You can describe all users or filter the results - * (for example, by status or organization).

- *

By default, Amazon WorkDocs returns the first 24 active or pending users. If there - * are more results, the response includes a marker that you can use to request the next - * set of results.

+ * @see {@link DescribeUsersCommand} */ - public describeUsers( - args: DescribeUsersCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeUsers( - args: DescribeUsersCommandInput, - cb: (err: any, data?: DescribeUsersCommandOutput) => void - ): void; - public describeUsers( + describeUsers(args: DescribeUsersCommandInput, options?: __HttpHandlerOptions): Promise; + describeUsers(args: DescribeUsersCommandInput, cb: (err: any, data?: DescribeUsersCommandOutput) => void): void; + describeUsers( args: DescribeUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUsersCommandOutput) => void ): void; - public describeUsers( - args: DescribeUsersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUsersCommandOutput) => void), - cb?: (err: any, data?: DescribeUsersCommandOutput) => void - ): Promise | void { - const command = new DescribeUsersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves details of the current user for whom the authentication token was - * generated. This is not a valid action for SigV4 (administrative API) clients.

- *

This action requires an authentication token. To get an authentication token, - * register an application with Amazon WorkDocs. For more information, see Authentication and Access - * Control for User Applications in the - * Amazon - * WorkDocs Developer Guide.

+ * @see {@link GetCurrentUserCommand} */ - public getCurrentUser( + getCurrentUser( args: GetCurrentUserCommandInput, options?: __HttpHandlerOptions ): Promise; - public getCurrentUser( - args: GetCurrentUserCommandInput, - cb: (err: any, data?: GetCurrentUserCommandOutput) => void - ): void; - public getCurrentUser( + getCurrentUser(args: GetCurrentUserCommandInput, cb: (err: any, data?: GetCurrentUserCommandOutput) => void): void; + getCurrentUser( args: GetCurrentUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCurrentUserCommandOutput) => void ): void; - public getCurrentUser( - args: GetCurrentUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetCurrentUserCommandOutput) => void), - cb?: (err: any, data?: GetCurrentUserCommandOutput) => void - ): Promise | void { - const command = new GetCurrentUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves details of a document.

+ * @see {@link GetDocumentCommand} */ - public getDocument(args: GetDocumentCommandInput, options?: __HttpHandlerOptions): Promise; - public getDocument(args: GetDocumentCommandInput, cb: (err: any, data?: GetDocumentCommandOutput) => void): void; - public getDocument( + getDocument(args: GetDocumentCommandInput, options?: __HttpHandlerOptions): Promise; + getDocument(args: GetDocumentCommandInput, cb: (err: any, data?: GetDocumentCommandOutput) => void): void; + getDocument( args: GetDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentCommandOutput) => void ): void; - public getDocument( - args: GetDocumentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDocumentCommandOutput) => void), - cb?: (err: any, data?: GetDocumentCommandOutput) => void - ): Promise | void { - const command = new GetDocumentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the path information (the hierarchy from the root folder) for the - * requested document.

- *

By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the - * requested document and only includes the IDs of the parent folders in the path. You can - * limit the maximum number of levels. You can also request the names of the parent - * folders.

+ * @see {@link GetDocumentPathCommand} */ - public getDocumentPath( + getDocumentPath( args: GetDocumentPathCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDocumentPath( - args: GetDocumentPathCommandInput, - cb: (err: any, data?: GetDocumentPathCommandOutput) => void - ): void; - public getDocumentPath( + getDocumentPath(args: GetDocumentPathCommandInput, cb: (err: any, data?: GetDocumentPathCommandOutput) => void): void; + getDocumentPath( args: GetDocumentPathCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentPathCommandOutput) => void ): void; - public getDocumentPath( - args: GetDocumentPathCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDocumentPathCommandOutput) => void), - cb?: (err: any, data?: GetDocumentPathCommandOutput) => void - ): Promise | void { - const command = new GetDocumentPathCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves version metadata for the specified document.

+ * @see {@link GetDocumentVersionCommand} */ - public getDocumentVersion( + getDocumentVersion( args: GetDocumentVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDocumentVersion( + getDocumentVersion( args: GetDocumentVersionCommandInput, cb: (err: any, data?: GetDocumentVersionCommandOutput) => void ): void; - public getDocumentVersion( + getDocumentVersion( args: GetDocumentVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentVersionCommandOutput) => void ): void; - public getDocumentVersion( - args: GetDocumentVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDocumentVersionCommandOutput) => void), - cb?: (err: any, data?: GetDocumentVersionCommandOutput) => void - ): Promise | void { - const command = new GetDocumentVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the metadata of the specified folder.

+ * @see {@link GetFolderCommand} */ - public getFolder(args: GetFolderCommandInput, options?: __HttpHandlerOptions): Promise; - public getFolder(args: GetFolderCommandInput, cb: (err: any, data?: GetFolderCommandOutput) => void): void; - public getFolder( + getFolder(args: GetFolderCommandInput, options?: __HttpHandlerOptions): Promise; + getFolder(args: GetFolderCommandInput, cb: (err: any, data?: GetFolderCommandOutput) => void): void; + getFolder( args: GetFolderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFolderCommandOutput) => void ): void; - public getFolder( - args: GetFolderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFolderCommandOutput) => void), - cb?: (err: any, data?: GetFolderCommandOutput) => void - ): Promise | void { - const command = new GetFolderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the path information (the hierarchy from the root folder) for the - * specified folder.

- *

By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the - * requested folder and only includes the IDs of the parent folders in the path. You can - * limit the maximum number of levels. You can also request the parent folder - * names.

+ * @see {@link GetFolderPathCommand} */ - public getFolderPath( - args: GetFolderPathCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getFolderPath( - args: GetFolderPathCommandInput, - cb: (err: any, data?: GetFolderPathCommandOutput) => void - ): void; - public getFolderPath( + getFolderPath(args: GetFolderPathCommandInput, options?: __HttpHandlerOptions): Promise; + getFolderPath(args: GetFolderPathCommandInput, cb: (err: any, data?: GetFolderPathCommandOutput) => void): void; + getFolderPath( args: GetFolderPathCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFolderPathCommandOutput) => void ): void; - public getFolderPath( - args: GetFolderPathCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetFolderPathCommandOutput) => void), - cb?: (err: any, data?: GetFolderPathCommandOutput) => void - ): Promise | void { - const command = new GetFolderPathCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a collection of resources, including folders and documents. The only - * CollectionType supported is SHARED_WITH_ME.

+ * @see {@link GetResourcesCommand} */ - public getResources( - args: GetResourcesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getResources(args: GetResourcesCommandInput, cb: (err: any, data?: GetResourcesCommandOutput) => void): void; - public getResources( + getResources(args: GetResourcesCommandInput, options?: __HttpHandlerOptions): Promise; + getResources(args: GetResourcesCommandInput, cb: (err: any, data?: GetResourcesCommandOutput) => void): void; + getResources( args: GetResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcesCommandOutput) => void ): void; - public getResources( - args: GetResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourcesCommandOutput) => void), - cb?: (err: any, data?: GetResourcesCommandOutput) => void - ): Promise | void { - const command = new GetResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a new document object and version object.

- *

The client specifies the parent folder ID and name of the document to upload. The - * ID is optionally specified when creating a new version of an existing document. This is - * the first step to upload a document. Next, upload the document to the URL returned from - * the call, and then call UpdateDocumentVersion.

- *

To cancel the document upload, call AbortDocumentVersionUpload.

+ * @see {@link InitiateDocumentVersionUploadCommand} */ - public initiateDocumentVersionUpload( + initiateDocumentVersionUpload( args: InitiateDocumentVersionUploadCommandInput, options?: __HttpHandlerOptions ): Promise; - public initiateDocumentVersionUpload( + initiateDocumentVersionUpload( args: InitiateDocumentVersionUploadCommandInput, cb: (err: any, data?: InitiateDocumentVersionUploadCommandOutput) => void ): void; - public initiateDocumentVersionUpload( + initiateDocumentVersionUpload( args: InitiateDocumentVersionUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InitiateDocumentVersionUploadCommandOutput) => void ): void; - public initiateDocumentVersionUpload( - args: InitiateDocumentVersionUploadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InitiateDocumentVersionUploadCommandOutput) => void), - cb?: (err: any, data?: InitiateDocumentVersionUploadCommandOutput) => void - ): Promise | void { - const command = new InitiateDocumentVersionUploadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes all the permissions from the specified resource.

+ * @see {@link RemoveAllResourcePermissionsCommand} */ - public removeAllResourcePermissions( + removeAllResourcePermissions( args: RemoveAllResourcePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeAllResourcePermissions( + removeAllResourcePermissions( args: RemoveAllResourcePermissionsCommandInput, cb: (err: any, data?: RemoveAllResourcePermissionsCommandOutput) => void ): void; - public removeAllResourcePermissions( + removeAllResourcePermissions( args: RemoveAllResourcePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveAllResourcePermissionsCommandOutput) => void ): void; - public removeAllResourcePermissions( - args: RemoveAllResourcePermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveAllResourcePermissionsCommandOutput) => void), - cb?: (err: any, data?: RemoveAllResourcePermissionsCommandOutput) => void - ): Promise | void { - const command = new RemoveAllResourcePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes the permission for the specified principal from the specified - * resource.

+ * @see {@link RemoveResourcePermissionCommand} */ - public removeResourcePermission( + removeResourcePermission( args: RemoveResourcePermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public removeResourcePermission( + removeResourcePermission( args: RemoveResourcePermissionCommandInput, cb: (err: any, data?: RemoveResourcePermissionCommandOutput) => void ): void; - public removeResourcePermission( + removeResourcePermission( args: RemoveResourcePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveResourcePermissionCommandOutput) => void ): void; - public removeResourcePermission( - args: RemoveResourcePermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RemoveResourcePermissionCommandOutput) => void), - cb?: (err: any, data?: RemoveResourcePermissionCommandOutput) => void - ): Promise | void { - const command = new RemoveResourcePermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Recovers a deleted version of an Amazon WorkDocs document.

+ * @see {@link RestoreDocumentVersionsCommand} */ - public restoreDocumentVersions( + restoreDocumentVersions( args: RestoreDocumentVersionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreDocumentVersions( + restoreDocumentVersions( args: RestoreDocumentVersionsCommandInput, cb: (err: any, data?: RestoreDocumentVersionsCommandOutput) => void ): void; - public restoreDocumentVersions( + restoreDocumentVersions( args: RestoreDocumentVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreDocumentVersionsCommandOutput) => void ): void; - public restoreDocumentVersions( - args: RestoreDocumentVersionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreDocumentVersionsCommandOutput) => void), - cb?: (err: any, data?: RestoreDocumentVersionsCommandOutput) => void - ): Promise | void { - const command = new RestoreDocumentVersionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Searches metadata and the content of folders, documents, document versions, and comments.

+ * @see {@link SearchResourcesCommand} */ - public searchResources( + searchResources( args: SearchResourcesCommandInput, options?: __HttpHandlerOptions ): Promise; - public searchResources( - args: SearchResourcesCommandInput, - cb: (err: any, data?: SearchResourcesCommandOutput) => void - ): void; - public searchResources( + searchResources(args: SearchResourcesCommandInput, cb: (err: any, data?: SearchResourcesCommandOutput) => void): void; + searchResources( args: SearchResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchResourcesCommandOutput) => void ): void; - public searchResources( - args: SearchResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SearchResourcesCommandOutput) => void), - cb?: (err: any, data?: SearchResourcesCommandOutput) => void - ): Promise | void { - const command = new SearchResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified attributes of a document. The user must have access to both - * the document and its parent folder, if applicable.

+ * @see {@link UpdateDocumentCommand} */ - public updateDocument( + updateDocument( args: UpdateDocumentCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDocument( - args: UpdateDocumentCommandInput, - cb: (err: any, data?: UpdateDocumentCommandOutput) => void - ): void; - public updateDocument( + updateDocument(args: UpdateDocumentCommandInput, cb: (err: any, data?: UpdateDocumentCommandOutput) => void): void; + updateDocument( args: UpdateDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDocumentCommandOutput) => void ): void; - public updateDocument( - args: UpdateDocumentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDocumentCommandOutput) => void), - cb?: (err: any, data?: UpdateDocumentCommandOutput) => void - ): Promise | void { - const command = new UpdateDocumentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Changes the status of the document version to ACTIVE.

- *

Amazon WorkDocs also sets its document container to ACTIVE. This is the last step - * in a document upload, after the client uploads the document to an S3-presigned URL - * returned by InitiateDocumentVersionUpload.

+ * @see {@link UpdateDocumentVersionCommand} */ - public updateDocumentVersion( + updateDocumentVersion( args: UpdateDocumentVersionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDocumentVersion( + updateDocumentVersion( args: UpdateDocumentVersionCommandInput, cb: (err: any, data?: UpdateDocumentVersionCommandOutput) => void ): void; - public updateDocumentVersion( + updateDocumentVersion( args: UpdateDocumentVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDocumentVersionCommandOutput) => void ): void; - public updateDocumentVersion( - args: UpdateDocumentVersionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDocumentVersionCommandOutput) => void), - cb?: (err: any, data?: UpdateDocumentVersionCommandOutput) => void - ): Promise | void { - const command = new UpdateDocumentVersionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified attributes of the specified folder. The user must have access - * to both the folder and its parent folder, if applicable.

+ * @see {@link UpdateFolderCommand} */ - public updateFolder( - args: UpdateFolderCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updateFolder(args: UpdateFolderCommandInput, cb: (err: any, data?: UpdateFolderCommandOutput) => void): void; - public updateFolder( + updateFolder(args: UpdateFolderCommandInput, options?: __HttpHandlerOptions): Promise; + updateFolder(args: UpdateFolderCommandInput, cb: (err: any, data?: UpdateFolderCommandOutput) => void): void; + updateFolder( args: UpdateFolderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFolderCommandOutput) => void ): void; - public updateFolder( - args: UpdateFolderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFolderCommandOutput) => void), - cb?: (err: any, data?: UpdateFolderCommandOutput) => void - ): Promise | void { - const command = new UpdateFolderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the specified attributes of the specified user, and grants or revokes - * administrative privileges to the Amazon WorkDocs site.

+ * @see {@link UpdateUserCommand} */ - public updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise; - public updateUser(args: UpdateUserCommandInput, cb: (err: any, data?: UpdateUserCommandOutput) => void): void; - public updateUser( + updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise; + updateUser(args: UpdateUserCommandInput, cb: (err: any, data?: UpdateUserCommandOutput) => void): void; + updateUser( args: UpdateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserCommandOutput) => void ): void; - public updateUser( - args: UpdateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserCommandOutput) => void), - cb?: (err: any, data?: UpdateUserCommandOutput) => void - ): Promise | void { - const command = new UpdateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The Amazon WorkDocs API is designed for the following use cases:

+ *
    + *
  • + *

    File Migration: File migration applications are supported for users who + * want to migrate their files from an on-premises or off-premises file system or + * service. Users can insert files into a user directory structure, as well as + * allow for basic metadata changes, such as modifications to the permissions of + * files.

    + *
  • + *
  • + *

    Security: Support security applications are supported for users who have + * additional security needs, such as antivirus or data loss prevention. The API + * actions, along with CloudTrail, allow these applications to detect when + * changes occur in Amazon WorkDocs. Then, the application can take the necessary + * actions and replace the target file. If the target file violates the policy, the + * application can also choose to email the user.

    + *
  • + *
  • + *

    eDiscovery/Analytics: General administrative applications are supported, + * such as eDiscovery and analytics. These applications can choose to mimic or + * record the actions in an Amazon WorkDocs site, along with CloudTrail, to + * replicate data for eDiscovery, backup, or analytical applications.

    + *
  • + *
+ *

All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed. + * They not only require the use of the Amazon Web Services SDK, but also allow for the exclusive use of + * IAM users and roles to help facilitate access, trust, and permission policies. By + * creating a role and allowing an IAM user to access the Amazon WorkDocs site, the + * IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as + * set in the IAM policy). This includes, but is not limited to, the ability to modify file + * permissions and upload any file to any user. This allows developers to perform the three + * use cases above, as well as give users the ability to grant access on a selective basis + * using the IAM model.

+ * + *

The pricing for Amazon WorkDocs APIs varies depending on the API call type for these actions:

+ *
    + *
  • + *

    + * READ (Get*) + *

    + *
  • + *
  • + *

    + * WRITE (Activate*, Add*, Create*, Deactivate*, Initiate*, Update*) + *

    + *
  • + *
  • + *

    + * LIST (Describe*) + *

    + *
  • + *
  • + *

    + * DELETE*, CANCEL + *

    + *
  • + *
+ *

For information about Amazon WorkDocs API pricing, see Amazon WorkDocs Pricing.

+ *
+ */ +export class WorkDocs extends WorkDocsClient implements WorkDocs {} +createAggregatedClient(commands, WorkDocs); diff --git a/clients/client-worklink/src/WorkLink.ts b/clients/client-worklink/src/WorkLink.ts index 287d6e7c8e9e..9b8a265ce09d 100644 --- a/clients/client-worklink/src/WorkLink.ts +++ b/clients/client-worklink/src/WorkLink.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -138,1145 +139,559 @@ import { UpdateIdentityProviderConfigurationCommandInput, UpdateIdentityProviderConfigurationCommandOutput, } from "./commands/UpdateIdentityProviderConfigurationCommand"; -import { WorkLinkClient } from "./WorkLinkClient"; +import { WorkLinkClient, WorkLinkClientConfig } from "./WorkLinkClient"; -/** - * @public - *

Amazon WorkLink is a cloud-based service that provides secure access - * to internal websites and web apps from iOS and Android phones. In a single step, your users, such as - * employees, can access internal websites as efficiently as they access any other public website. - * They enter a URL in their web browser, or choose a link to an internal website in an email. Amazon WorkLink - * authenticates the user's access and securely renders authorized internal web content in a secure - * rendering service in the AWS cloud. Amazon WorkLink doesn't download or store any internal web content on - * mobile devices.

- */ -export class WorkLink extends WorkLinkClient { +const commands = { + AssociateDomainCommand, + AssociateWebsiteAuthorizationProviderCommand, + AssociateWebsiteCertificateAuthorityCommand, + CreateFleetCommand, + DeleteFleetCommand, + DescribeAuditStreamConfigurationCommand, + DescribeCompanyNetworkConfigurationCommand, + DescribeDeviceCommand, + DescribeDevicePolicyConfigurationCommand, + DescribeDomainCommand, + DescribeFleetMetadataCommand, + DescribeIdentityProviderConfigurationCommand, + DescribeWebsiteCertificateAuthorityCommand, + DisassociateDomainCommand, + DisassociateWebsiteAuthorizationProviderCommand, + DisassociateWebsiteCertificateAuthorityCommand, + ListDevicesCommand, + ListDomainsCommand, + ListFleetsCommand, + ListTagsForResourceCommand, + ListWebsiteAuthorizationProvidersCommand, + ListWebsiteCertificateAuthoritiesCommand, + RestoreDomainAccessCommand, + RevokeDomainAccessCommand, + SignOutUserCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateAuditStreamConfigurationCommand, + UpdateCompanyNetworkConfigurationCommand, + UpdateDevicePolicyConfigurationCommand, + UpdateDomainMetadataCommand, + UpdateFleetMetadataCommand, + UpdateIdentityProviderConfigurationCommand, +}; + +export interface WorkLink { /** - * @public - * @deprecated - * - *

Specifies a domain to be associated to Amazon WorkLink.

+ * @see {@link AssociateDomainCommand} */ - public associateDomain( + associateDomain( args: AssociateDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateDomain( - args: AssociateDomainCommandInput, - cb: (err: any, data?: AssociateDomainCommandOutput) => void - ): void; - public associateDomain( + associateDomain(args: AssociateDomainCommandInput, cb: (err: any, data?: AssociateDomainCommandOutput) => void): void; + associateDomain( args: AssociateDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateDomainCommandOutput) => void ): void; - public associateDomain( - args: AssociateDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateDomainCommandOutput) => void), - cb?: (err: any, data?: AssociateDomainCommandOutput) => void - ): Promise | void { - const command = new AssociateDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network.

+ * @see {@link AssociateWebsiteAuthorizationProviderCommand} */ - public associateWebsiteAuthorizationProvider( + associateWebsiteAuthorizationProvider( args: AssociateWebsiteAuthorizationProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateWebsiteAuthorizationProvider( + associateWebsiteAuthorizationProvider( args: AssociateWebsiteAuthorizationProviderCommandInput, cb: (err: any, data?: AssociateWebsiteAuthorizationProviderCommandOutput) => void ): void; - public associateWebsiteAuthorizationProvider( + associateWebsiteAuthorizationProvider( args: AssociateWebsiteAuthorizationProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateWebsiteAuthorizationProviderCommandOutput) => void ): void; - public associateWebsiteAuthorizationProvider( - args: AssociateWebsiteAuthorizationProviderCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: AssociateWebsiteAuthorizationProviderCommandOutput) => void), - cb?: (err: any, data?: AssociateWebsiteAuthorizationProviderCommandOutput) => void - ): Promise | void { - const command = new AssociateWebsiteAuthorizationProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Imports the root certificate of a certificate authority (CA) used to obtain TLS - * certificates used by associated websites within the company network.

+ * @see {@link AssociateWebsiteCertificateAuthorityCommand} */ - public associateWebsiteCertificateAuthority( + associateWebsiteCertificateAuthority( args: AssociateWebsiteCertificateAuthorityCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateWebsiteCertificateAuthority( + associateWebsiteCertificateAuthority( args: AssociateWebsiteCertificateAuthorityCommandInput, cb: (err: any, data?: AssociateWebsiteCertificateAuthorityCommandOutput) => void ): void; - public associateWebsiteCertificateAuthority( + associateWebsiteCertificateAuthority( args: AssociateWebsiteCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateWebsiteCertificateAuthorityCommandOutput) => void ): void; - public associateWebsiteCertificateAuthority( - args: AssociateWebsiteCertificateAuthorityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateWebsiteCertificateAuthorityCommandOutput) => void), - cb?: (err: any, data?: AssociateWebsiteCertificateAuthorityCommandOutput) => void - ): Promise | void { - const command = new AssociateWebsiteCertificateAuthorityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Creates a fleet. A fleet consists of resources and the configuration that delivers - * associated websites to authorized users who download and set up the Amazon WorkLink app.

+ * @see {@link CreateFleetCommand} */ - public createFleet(args: CreateFleetCommandInput, options?: __HttpHandlerOptions): Promise; - public createFleet(args: CreateFleetCommandInput, cb: (err: any, data?: CreateFleetCommandOutput) => void): void; - public createFleet( + createFleet(args: CreateFleetCommandInput, options?: __HttpHandlerOptions): Promise; + createFleet(args: CreateFleetCommandInput, cb: (err: any, data?: CreateFleetCommandOutput) => void): void; + createFleet( args: CreateFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFleetCommandOutput) => void ): void; - public createFleet( - args: CreateFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateFleetCommandOutput) => void), - cb?: (err: any, data?: CreateFleetCommandOutput) => void - ): Promise | void { - const command = new CreateFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Deletes a fleet. Prevents users from accessing previously associated websites.

+ * @see {@link DeleteFleetCommand} */ - public deleteFleet(args: DeleteFleetCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteFleet(args: DeleteFleetCommandInput, cb: (err: any, data?: DeleteFleetCommandOutput) => void): void; - public deleteFleet( + deleteFleet(args: DeleteFleetCommandInput, options?: __HttpHandlerOptions): Promise; + deleteFleet(args: DeleteFleetCommandInput, cb: (err: any, data?: DeleteFleetCommandOutput) => void): void; + deleteFleet( args: DeleteFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFleetCommandOutput) => void ): void; - public deleteFleet( - args: DeleteFleetCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteFleetCommandOutput) => void), - cb?: (err: any, data?: DeleteFleetCommandOutput) => void - ): Promise | void { - const command = new DeleteFleetCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Describes the configuration for delivering audit streams to the customer account.

+ * @see {@link DescribeAuditStreamConfigurationCommand} */ - public describeAuditStreamConfiguration( + describeAuditStreamConfiguration( args: DescribeAuditStreamConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAuditStreamConfiguration( + describeAuditStreamConfiguration( args: DescribeAuditStreamConfigurationCommandInput, cb: (err: any, data?: DescribeAuditStreamConfigurationCommandOutput) => void ): void; - public describeAuditStreamConfiguration( + describeAuditStreamConfiguration( args: DescribeAuditStreamConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAuditStreamConfigurationCommandOutput) => void ): void; - public describeAuditStreamConfiguration( - args: DescribeAuditStreamConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAuditStreamConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeAuditStreamConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeAuditStreamConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Describes the networking configuration to access the internal websites associated with - * the specified fleet.

+ * @see {@link DescribeCompanyNetworkConfigurationCommand} */ - public describeCompanyNetworkConfiguration( + describeCompanyNetworkConfiguration( args: DescribeCompanyNetworkConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeCompanyNetworkConfiguration( + describeCompanyNetworkConfiguration( args: DescribeCompanyNetworkConfigurationCommandInput, cb: (err: any, data?: DescribeCompanyNetworkConfigurationCommandOutput) => void ): void; - public describeCompanyNetworkConfiguration( + describeCompanyNetworkConfiguration( args: DescribeCompanyNetworkConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCompanyNetworkConfigurationCommandOutput) => void ): void; - public describeCompanyNetworkConfiguration( - args: DescribeCompanyNetworkConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeCompanyNetworkConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeCompanyNetworkConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeCompanyNetworkConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Provides information about a user's device.

+ * @see {@link DescribeDeviceCommand} */ - public describeDevice( + describeDevice( args: DescribeDeviceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDevice( - args: DescribeDeviceCommandInput, - cb: (err: any, data?: DescribeDeviceCommandOutput) => void - ): void; - public describeDevice( + describeDevice(args: DescribeDeviceCommandInput, cb: (err: any, data?: DescribeDeviceCommandOutput) => void): void; + describeDevice( args: DescribeDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDeviceCommandOutput) => void ): void; - public describeDevice( - args: DescribeDeviceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDeviceCommandOutput) => void), - cb?: (err: any, data?: DescribeDeviceCommandOutput) => void - ): Promise | void { - const command = new DescribeDeviceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Describes the device policy configuration for the specified fleet.

+ * @see {@link DescribeDevicePolicyConfigurationCommand} */ - public describeDevicePolicyConfiguration( + describeDevicePolicyConfiguration( args: DescribeDevicePolicyConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDevicePolicyConfiguration( + describeDevicePolicyConfiguration( args: DescribeDevicePolicyConfigurationCommandInput, cb: (err: any, data?: DescribeDevicePolicyConfigurationCommandOutput) => void ): void; - public describeDevicePolicyConfiguration( + describeDevicePolicyConfiguration( args: DescribeDevicePolicyConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDevicePolicyConfigurationCommandOutput) => void ): void; - public describeDevicePolicyConfiguration( - args: DescribeDevicePolicyConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDevicePolicyConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeDevicePolicyConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeDevicePolicyConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Provides information about the domain.

+ * @see {@link DescribeDomainCommand} */ - public describeDomain( + describeDomain( args: DescribeDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeDomain( - args: DescribeDomainCommandInput, - cb: (err: any, data?: DescribeDomainCommandOutput) => void - ): void; - public describeDomain( + describeDomain(args: DescribeDomainCommandInput, cb: (err: any, data?: DescribeDomainCommandOutput) => void): void; + describeDomain( args: DescribeDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDomainCommandOutput) => void ): void; - public describeDomain( - args: DescribeDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDomainCommandOutput) => void), - cb?: (err: any, data?: DescribeDomainCommandOutput) => void - ): Promise | void { - const command = new DescribeDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Provides basic information for the specified fleet, excluding identity provider, - * networking, and device configuration details.

+ * @see {@link DescribeFleetMetadataCommand} */ - public describeFleetMetadata( + describeFleetMetadata( args: DescribeFleetMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeFleetMetadata( + describeFleetMetadata( args: DescribeFleetMetadataCommandInput, cb: (err: any, data?: DescribeFleetMetadataCommandOutput) => void ): void; - public describeFleetMetadata( + describeFleetMetadata( args: DescribeFleetMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetMetadataCommandOutput) => void ): void; - public describeFleetMetadata( - args: DescribeFleetMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeFleetMetadataCommandOutput) => void), - cb?: (err: any, data?: DescribeFleetMetadataCommandOutput) => void - ): Promise | void { - const command = new DescribeFleetMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Describes the identity provider configuration of the specified fleet.

+ * @see {@link DescribeIdentityProviderConfigurationCommand} */ - public describeIdentityProviderConfiguration( + describeIdentityProviderConfiguration( args: DescribeIdentityProviderConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeIdentityProviderConfiguration( + describeIdentityProviderConfiguration( args: DescribeIdentityProviderConfigurationCommandInput, cb: (err: any, data?: DescribeIdentityProviderConfigurationCommandOutput) => void ): void; - public describeIdentityProviderConfiguration( + describeIdentityProviderConfiguration( args: DescribeIdentityProviderConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIdentityProviderConfigurationCommandOutput) => void ): void; - public describeIdentityProviderConfiguration( - args: DescribeIdentityProviderConfigurationCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DescribeIdentityProviderConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeIdentityProviderConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeIdentityProviderConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Provides information about the certificate authority.

+ * @see {@link DescribeWebsiteCertificateAuthorityCommand} */ - public describeWebsiteCertificateAuthority( + describeWebsiteCertificateAuthority( args: DescribeWebsiteCertificateAuthorityCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWebsiteCertificateAuthority( + describeWebsiteCertificateAuthority( args: DescribeWebsiteCertificateAuthorityCommandInput, cb: (err: any, data?: DescribeWebsiteCertificateAuthorityCommandOutput) => void ): void; - public describeWebsiteCertificateAuthority( + describeWebsiteCertificateAuthority( args: DescribeWebsiteCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWebsiteCertificateAuthorityCommandOutput) => void ): void; - public describeWebsiteCertificateAuthority( - args: DescribeWebsiteCertificateAuthorityCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWebsiteCertificateAuthorityCommandOutput) => void), - cb?: (err: any, data?: DescribeWebsiteCertificateAuthorityCommandOutput) => void - ): Promise | void { - const command = new DescribeWebsiteCertificateAuthorityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink.

+ * @see {@link DisassociateDomainCommand} */ - public disassociateDomain( + disassociateDomain( args: DisassociateDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateDomain( + disassociateDomain( args: DisassociateDomainCommandInput, cb: (err: any, data?: DisassociateDomainCommandOutput) => void ): void; - public disassociateDomain( + disassociateDomain( args: DisassociateDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateDomainCommandOutput) => void ): void; - public disassociateDomain( - args: DisassociateDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateDomainCommandOutput) => void), - cb?: (err: any, data?: DisassociateDomainCommandOutput) => void - ): Promise | void { - const command = new DisassociateDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Disassociates a website authorization provider from a specified fleet. After the - * disassociation, users can't load any associated websites that require this authorization - * provider.

+ * @see {@link DisassociateWebsiteAuthorizationProviderCommand} */ - public disassociateWebsiteAuthorizationProvider( + disassociateWebsiteAuthorizationProvider( args: DisassociateWebsiteAuthorizationProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateWebsiteAuthorizationProvider( + disassociateWebsiteAuthorizationProvider( args: DisassociateWebsiteAuthorizationProviderCommandInput, cb: (err: any, data?: DisassociateWebsiteAuthorizationProviderCommandOutput) => void ): void; - public disassociateWebsiteAuthorizationProvider( + disassociateWebsiteAuthorizationProvider( args: DisassociateWebsiteAuthorizationProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateWebsiteAuthorizationProviderCommandOutput) => void ): void; - public disassociateWebsiteAuthorizationProvider( - args: DisassociateWebsiteAuthorizationProviderCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociateWebsiteAuthorizationProviderCommandOutput) => void), - cb?: (err: any, data?: DisassociateWebsiteAuthorizationProviderCommandOutput) => void - ): Promise | void { - const command = new DisassociateWebsiteAuthorizationProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Removes a certificate authority (CA).

+ * @see {@link DisassociateWebsiteCertificateAuthorityCommand} */ - public disassociateWebsiteCertificateAuthority( + disassociateWebsiteCertificateAuthority( args: DisassociateWebsiteCertificateAuthorityCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateWebsiteCertificateAuthority( + disassociateWebsiteCertificateAuthority( args: DisassociateWebsiteCertificateAuthorityCommandInput, cb: (err: any, data?: DisassociateWebsiteCertificateAuthorityCommandOutput) => void ): void; - public disassociateWebsiteCertificateAuthority( + disassociateWebsiteCertificateAuthority( args: DisassociateWebsiteCertificateAuthorityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateWebsiteCertificateAuthorityCommandOutput) => void ): void; - public disassociateWebsiteCertificateAuthority( - args: DisassociateWebsiteCertificateAuthorityCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociateWebsiteCertificateAuthorityCommandOutput) => void), - cb?: (err: any, data?: DisassociateWebsiteCertificateAuthorityCommandOutput) => void - ): Promise | void { - const command = new DisassociateWebsiteCertificateAuthorityCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Retrieves a list of devices registered with the specified fleet.

+ * @see {@link ListDevicesCommand} */ - public listDevices(args: ListDevicesCommandInput, options?: __HttpHandlerOptions): Promise; - public listDevices(args: ListDevicesCommandInput, cb: (err: any, data?: ListDevicesCommandOutput) => void): void; - public listDevices( + listDevices(args: ListDevicesCommandInput, options?: __HttpHandlerOptions): Promise; + listDevices(args: ListDevicesCommandInput, cb: (err: any, data?: ListDevicesCommandOutput) => void): void; + listDevices( args: ListDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDevicesCommandOutput) => void ): void; - public listDevices( - args: ListDevicesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDevicesCommandOutput) => void), - cb?: (err: any, data?: ListDevicesCommandOutput) => void - ): Promise | void { - const command = new ListDevicesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Retrieves a list of domains associated to a specified fleet.

+ * @see {@link ListDomainsCommand} */ - public listDomains(args: ListDomainsCommandInput, options?: __HttpHandlerOptions): Promise; - public listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void; - public listDomains( + listDomains(args: ListDomainsCommandInput, options?: __HttpHandlerOptions): Promise; + listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void; + listDomains( args: ListDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainsCommandOutput) => void ): void; - public listDomains( - args: ListDomainsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListDomainsCommandOutput) => void), - cb?: (err: any, data?: ListDomainsCommandOutput) => void - ): Promise | void { - const command = new ListDomainsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Retrieves a list of fleets for the current account and Region.

+ * @see {@link ListFleetsCommand} */ - public listFleets(args: ListFleetsCommandInput, options?: __HttpHandlerOptions): Promise; - public listFleets(args: ListFleetsCommandInput, cb: (err: any, data?: ListFleetsCommandOutput) => void): void; - public listFleets( + listFleets(args: ListFleetsCommandInput, options?: __HttpHandlerOptions): Promise; + listFleets(args: ListFleetsCommandInput, cb: (err: any, data?: ListFleetsCommandOutput) => void): void; + listFleets( args: ListFleetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFleetsCommandOutput) => void ): void; - public listFleets( - args: ListFleetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListFleetsCommandOutput) => void), - cb?: (err: any, data?: ListFleetsCommandOutput) => void - ): Promise | void { - const command = new ListFleetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Retrieves a list of tags for the specified resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Retrieves a list of website authorization providers associated with a specified fleet.

+ * @see {@link ListWebsiteAuthorizationProvidersCommand} */ - public listWebsiteAuthorizationProviders( + listWebsiteAuthorizationProviders( args: ListWebsiteAuthorizationProvidersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWebsiteAuthorizationProviders( + listWebsiteAuthorizationProviders( args: ListWebsiteAuthorizationProvidersCommandInput, cb: (err: any, data?: ListWebsiteAuthorizationProvidersCommandOutput) => void ): void; - public listWebsiteAuthorizationProviders( + listWebsiteAuthorizationProviders( args: ListWebsiteAuthorizationProvidersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWebsiteAuthorizationProvidersCommandOutput) => void ): void; - public listWebsiteAuthorizationProviders( - args: ListWebsiteAuthorizationProvidersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWebsiteAuthorizationProvidersCommandOutput) => void), - cb?: (err: any, data?: ListWebsiteAuthorizationProvidersCommandOutput) => void - ): Promise | void { - const command = new ListWebsiteAuthorizationProvidersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Retrieves a list of certificate authorities added for the current account and - * Region.

+ * @see {@link ListWebsiteCertificateAuthoritiesCommand} */ - public listWebsiteCertificateAuthorities( + listWebsiteCertificateAuthorities( args: ListWebsiteCertificateAuthoritiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listWebsiteCertificateAuthorities( + listWebsiteCertificateAuthorities( args: ListWebsiteCertificateAuthoritiesCommandInput, cb: (err: any, data?: ListWebsiteCertificateAuthoritiesCommandOutput) => void ): void; - public listWebsiteCertificateAuthorities( + listWebsiteCertificateAuthorities( args: ListWebsiteCertificateAuthoritiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWebsiteCertificateAuthoritiesCommandOutput) => void ): void; - public listWebsiteCertificateAuthorities( - args: ListWebsiteCertificateAuthoritiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListWebsiteCertificateAuthoritiesCommandOutput) => void), - cb?: (err: any, data?: ListWebsiteCertificateAuthoritiesCommandOutput) => void - ): Promise | void { - const command = new ListWebsiteCertificateAuthoritiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Moves a domain to ACTIVE status if it was in the INACTIVE status.

+ * @see {@link RestoreDomainAccessCommand} */ - public restoreDomainAccess( + restoreDomainAccess( args: RestoreDomainAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreDomainAccess( + restoreDomainAccess( args: RestoreDomainAccessCommandInput, cb: (err: any, data?: RestoreDomainAccessCommandOutput) => void ): void; - public restoreDomainAccess( + restoreDomainAccess( args: RestoreDomainAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreDomainAccessCommandOutput) => void ): void; - public restoreDomainAccess( - args: RestoreDomainAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreDomainAccessCommandOutput) => void), - cb?: (err: any, data?: RestoreDomainAccessCommandOutput) => void - ): Promise | void { - const command = new RestoreDomainAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Moves a domain to INACTIVE status if it was in the ACTIVE status.

+ * @see {@link RevokeDomainAccessCommand} */ - public revokeDomainAccess( + revokeDomainAccess( args: RevokeDomainAccessCommandInput, options?: __HttpHandlerOptions ): Promise; - public revokeDomainAccess( + revokeDomainAccess( args: RevokeDomainAccessCommandInput, cb: (err: any, data?: RevokeDomainAccessCommandOutput) => void ): void; - public revokeDomainAccess( + revokeDomainAccess( args: RevokeDomainAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeDomainAccessCommandOutput) => void ): void; - public revokeDomainAccess( - args: RevokeDomainAccessCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RevokeDomainAccessCommandOutput) => void), - cb?: (err: any, data?: RevokeDomainAccessCommandOutput) => void - ): Promise | void { - const command = new RevokeDomainAccessCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Signs the user out from all of their devices. The user can sign in again if they have - * valid credentials.

+ * @see {@link SignOutUserCommand} */ - public signOutUser(args: SignOutUserCommandInput, options?: __HttpHandlerOptions): Promise; - public signOutUser(args: SignOutUserCommandInput, cb: (err: any, data?: SignOutUserCommandOutput) => void): void; - public signOutUser( + signOutUser(args: SignOutUserCommandInput, options?: __HttpHandlerOptions): Promise; + signOutUser(args: SignOutUserCommandInput, cb: (err: any, data?: SignOutUserCommandOutput) => void): void; + signOutUser( args: SignOutUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SignOutUserCommandOutput) => void ): void; - public signOutUser( - args: SignOutUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SignOutUserCommandOutput) => void), - cb?: (err: any, data?: SignOutUserCommandOutput) => void - ): Promise | void { - const command = new SignOutUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Adds or overwrites one or more tags for the specified resource, such as a fleet. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Removes one or more tags from the specified resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Updates the audit stream configuration for the fleet.

+ * @see {@link UpdateAuditStreamConfigurationCommand} */ - public updateAuditStreamConfiguration( + updateAuditStreamConfiguration( args: UpdateAuditStreamConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAuditStreamConfiguration( + updateAuditStreamConfiguration( args: UpdateAuditStreamConfigurationCommandInput, cb: (err: any, data?: UpdateAuditStreamConfigurationCommandOutput) => void ): void; - public updateAuditStreamConfiguration( + updateAuditStreamConfiguration( args: UpdateAuditStreamConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAuditStreamConfigurationCommandOutput) => void ): void; - public updateAuditStreamConfiguration( - args: UpdateAuditStreamConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAuditStreamConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateAuditStreamConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateAuditStreamConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Updates the company network configuration for the fleet.

+ * @see {@link UpdateCompanyNetworkConfigurationCommand} */ - public updateCompanyNetworkConfiguration( + updateCompanyNetworkConfiguration( args: UpdateCompanyNetworkConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateCompanyNetworkConfiguration( + updateCompanyNetworkConfiguration( args: UpdateCompanyNetworkConfigurationCommandInput, cb: (err: any, data?: UpdateCompanyNetworkConfigurationCommandOutput) => void ): void; - public updateCompanyNetworkConfiguration( + updateCompanyNetworkConfiguration( args: UpdateCompanyNetworkConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCompanyNetworkConfigurationCommandOutput) => void ): void; - public updateCompanyNetworkConfiguration( - args: UpdateCompanyNetworkConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateCompanyNetworkConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateCompanyNetworkConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateCompanyNetworkConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Updates the device policy configuration for the fleet.

+ * @see {@link UpdateDevicePolicyConfigurationCommand} */ - public updateDevicePolicyConfiguration( + updateDevicePolicyConfiguration( args: UpdateDevicePolicyConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDevicePolicyConfiguration( + updateDevicePolicyConfiguration( args: UpdateDevicePolicyConfigurationCommandInput, cb: (err: any, data?: UpdateDevicePolicyConfigurationCommandOutput) => void ): void; - public updateDevicePolicyConfiguration( + updateDevicePolicyConfiguration( args: UpdateDevicePolicyConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDevicePolicyConfigurationCommandOutput) => void ): void; - public updateDevicePolicyConfiguration( - args: UpdateDevicePolicyConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDevicePolicyConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateDevicePolicyConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateDevicePolicyConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Updates domain metadata, such as DisplayName.

+ * @see {@link UpdateDomainMetadataCommand} */ - public updateDomainMetadata( + updateDomainMetadata( args: UpdateDomainMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDomainMetadata( + updateDomainMetadata( args: UpdateDomainMetadataCommandInput, cb: (err: any, data?: UpdateDomainMetadataCommandOutput) => void ): void; - public updateDomainMetadata( + updateDomainMetadata( args: UpdateDomainMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDomainMetadataCommandOutput) => void ): void; - public updateDomainMetadata( - args: UpdateDomainMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDomainMetadataCommandOutput) => void), - cb?: (err: any, data?: UpdateDomainMetadataCommandOutput) => void - ): Promise | void { - const command = new UpdateDomainMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Updates fleet metadata, such as DisplayName.

+ * @see {@link UpdateFleetMetadataCommand} */ - public updateFleetMetadata( + updateFleetMetadata( args: UpdateFleetMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateFleetMetadata( + updateFleetMetadata( args: UpdateFleetMetadataCommandInput, cb: (err: any, data?: UpdateFleetMetadataCommandOutput) => void ): void; - public updateFleetMetadata( + updateFleetMetadata( args: UpdateFleetMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFleetMetadataCommandOutput) => void ): void; - public updateFleetMetadata( - args: UpdateFleetMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateFleetMetadataCommandOutput) => void), - cb?: (err: any, data?: UpdateFleetMetadataCommandOutput) => void - ): Promise | void { - const command = new UpdateFleetMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * @deprecated - * - *

Updates the identity provider configuration for the fleet.

+ * @see {@link UpdateIdentityProviderConfigurationCommand} */ - public updateIdentityProviderConfiguration( + updateIdentityProviderConfiguration( args: UpdateIdentityProviderConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateIdentityProviderConfiguration( + updateIdentityProviderConfiguration( args: UpdateIdentityProviderConfigurationCommandInput, cb: (err: any, data?: UpdateIdentityProviderConfigurationCommandOutput) => void ): void; - public updateIdentityProviderConfiguration( + updateIdentityProviderConfiguration( args: UpdateIdentityProviderConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIdentityProviderConfigurationCommandOutput) => void ): void; - public updateIdentityProviderConfiguration( - args: UpdateIdentityProviderConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateIdentityProviderConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateIdentityProviderConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateIdentityProviderConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon WorkLink is a cloud-based service that provides secure access + * to internal websites and web apps from iOS and Android phones. In a single step, your users, such as + * employees, can access internal websites as efficiently as they access any other public website. + * They enter a URL in their web browser, or choose a link to an internal website in an email. Amazon WorkLink + * authenticates the user's access and securely renders authorized internal web content in a secure + * rendering service in the AWS cloud. Amazon WorkLink doesn't download or store any internal web content on + * mobile devices.

+ */ +export class WorkLink extends WorkLinkClient implements WorkLink {} +createAggregatedClient(commands, WorkLink); diff --git a/clients/client-workmail/src/WorkMail.ts b/clients/client-workmail/src/WorkMail.ts index f52a94ea6a04..e50091100b81 100644 --- a/clients/client-workmail/src/WorkMail.ts +++ b/clients/client-workmail/src/WorkMail.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -361,2695 +362,1383 @@ import { UpdateResourceCommandInput, UpdateResourceCommandOutput, } from "./commands/UpdateResourceCommand"; -import { WorkMailClient } from "./WorkMailClient"; +import { WorkMailClient, WorkMailClientConfig } from "./WorkMailClient"; -/** - * @public - *

WorkMail is a secure, managed business email and calendaring service with support for - * existing desktop and mobile email clients. You can access your email, contacts, and - * calendars using Microsoft Outlook, your browser, or other native iOS and Android email - * applications. You can integrate WorkMail with your existing corporate directory and control - * both the keys that encrypt your data and the location in which your data is - * stored.

- *

The WorkMail API is designed for the following scenarios:

- *
    - *
  • - *

    Listing and describing organizations

    - *
  • - *
- *
    - *
  • - *

    Managing users

    - *
  • - *
- *
    - *
  • - *

    Managing groups

    - *
  • - *
- *
    - *
  • - *

    Managing resources

    - *
  • - *
- *

All WorkMail API operations are Amazon-authenticated and certificate-signed. They not - * only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management - * users and roles to help facilitate access, trust, and permission policies. By creating a - * role and allowing an IAM user to access the WorkMail site, the IAM user gains full - * administrative visibility into the entire WorkMail organization (or as set in the IAM - * policy). This includes, but is not limited to, the ability to create, update, and delete - * users, groups, and resources. This allows developers to perform the scenarios listed above, - * as well as give users the ability to grant access on a selective basis using the IAM - * model.

- */ -export class WorkMail extends WorkMailClient { +const commands = { + AssociateDelegateToResourceCommand, + AssociateMemberToGroupCommand, + AssumeImpersonationRoleCommand, + CancelMailboxExportJobCommand, + CreateAliasCommand, + CreateAvailabilityConfigurationCommand, + CreateGroupCommand, + CreateImpersonationRoleCommand, + CreateMobileDeviceAccessRuleCommand, + CreateOrganizationCommand, + CreateResourceCommand, + CreateUserCommand, + DeleteAccessControlRuleCommand, + DeleteAliasCommand, + DeleteAvailabilityConfigurationCommand, + DeleteEmailMonitoringConfigurationCommand, + DeleteGroupCommand, + DeleteImpersonationRoleCommand, + DeleteMailboxPermissionsCommand, + DeleteMobileDeviceAccessOverrideCommand, + DeleteMobileDeviceAccessRuleCommand, + DeleteOrganizationCommand, + DeleteResourceCommand, + DeleteRetentionPolicyCommand, + DeleteUserCommand, + DeregisterFromWorkMailCommand, + DeregisterMailDomainCommand, + DescribeEmailMonitoringConfigurationCommand, + DescribeGroupCommand, + DescribeInboundDmarcSettingsCommand, + DescribeMailboxExportJobCommand, + DescribeOrganizationCommand, + DescribeResourceCommand, + DescribeUserCommand, + DisassociateDelegateFromResourceCommand, + DisassociateMemberFromGroupCommand, + GetAccessControlEffectCommand, + GetDefaultRetentionPolicyCommand, + GetImpersonationRoleCommand, + GetImpersonationRoleEffectCommand, + GetMailboxDetailsCommand, + GetMailDomainCommand, + GetMobileDeviceAccessEffectCommand, + GetMobileDeviceAccessOverrideCommand, + ListAccessControlRulesCommand, + ListAliasesCommand, + ListAvailabilityConfigurationsCommand, + ListGroupMembersCommand, + ListGroupsCommand, + ListImpersonationRolesCommand, + ListMailboxExportJobsCommand, + ListMailboxPermissionsCommand, + ListMailDomainsCommand, + ListMobileDeviceAccessOverridesCommand, + ListMobileDeviceAccessRulesCommand, + ListOrganizationsCommand, + ListResourceDelegatesCommand, + ListResourcesCommand, + ListTagsForResourceCommand, + ListUsersCommand, + PutAccessControlRuleCommand, + PutEmailMonitoringConfigurationCommand, + PutInboundDmarcSettingsCommand, + PutMailboxPermissionsCommand, + PutMobileDeviceAccessOverrideCommand, + PutRetentionPolicyCommand, + RegisterMailDomainCommand, + RegisterToWorkMailCommand, + ResetPasswordCommand, + StartMailboxExportJobCommand, + TagResourceCommand, + TestAvailabilityConfigurationCommand, + UntagResourceCommand, + UpdateAvailabilityConfigurationCommand, + UpdateDefaultMailDomainCommand, + UpdateImpersonationRoleCommand, + UpdateMailboxQuotaCommand, + UpdateMobileDeviceAccessRuleCommand, + UpdatePrimaryEmailAddressCommand, + UpdateResourceCommand, +}; + +export interface WorkMail { /** - * @public - *

Adds a member (user or group) to the resource's set of delegates.

+ * @see {@link AssociateDelegateToResourceCommand} */ - public associateDelegateToResource( + associateDelegateToResource( args: AssociateDelegateToResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateDelegateToResource( + associateDelegateToResource( args: AssociateDelegateToResourceCommandInput, cb: (err: any, data?: AssociateDelegateToResourceCommandOutput) => void ): void; - public associateDelegateToResource( + associateDelegateToResource( args: AssociateDelegateToResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateDelegateToResourceCommandOutput) => void ): void; - public associateDelegateToResource( - args: AssociateDelegateToResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateDelegateToResourceCommandOutput) => void), - cb?: (err: any, data?: AssociateDelegateToResourceCommandOutput) => void - ): Promise | void { - const command = new AssociateDelegateToResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds a member (user or group) to the group's set.

- */ - public associateMemberToGroup( + + /** + * @see {@link AssociateMemberToGroupCommand} + */ + associateMemberToGroup( args: AssociateMemberToGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateMemberToGroup( + associateMemberToGroup( args: AssociateMemberToGroupCommandInput, cb: (err: any, data?: AssociateMemberToGroupCommandOutput) => void ): void; - public associateMemberToGroup( + associateMemberToGroup( args: AssociateMemberToGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateMemberToGroupCommandOutput) => void ): void; - public associateMemberToGroup( - args: AssociateMemberToGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateMemberToGroupCommandOutput) => void), - cb?: (err: any, data?: AssociateMemberToGroupCommandOutput) => void - ): Promise | void { - const command = new AssociateMemberToGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Assumes an impersonation role for the given WorkMail organization. This method returns an - * authentication token you can use to make impersonated calls.

- */ - public assumeImpersonationRole( + + /** + * @see {@link AssumeImpersonationRoleCommand} + */ + assumeImpersonationRole( args: AssumeImpersonationRoleCommandInput, options?: __HttpHandlerOptions ): Promise; - public assumeImpersonationRole( + assumeImpersonationRole( args: AssumeImpersonationRoleCommandInput, cb: (err: any, data?: AssumeImpersonationRoleCommandOutput) => void ): void; - public assumeImpersonationRole( + assumeImpersonationRole( args: AssumeImpersonationRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssumeImpersonationRoleCommandOutput) => void ): void; - public assumeImpersonationRole( - args: AssumeImpersonationRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssumeImpersonationRoleCommandOutput) => void), - cb?: (err: any, data?: AssumeImpersonationRoleCommandOutput) => void - ): Promise | void { - const command = new AssumeImpersonationRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Cancels a mailbox export job.

- * - *

If the mailbox export job is near completion, it might not be possible to cancel - * it.

- *
- */ - public cancelMailboxExportJob( + + /** + * @see {@link CancelMailboxExportJobCommand} + */ + cancelMailboxExportJob( args: CancelMailboxExportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public cancelMailboxExportJob( + cancelMailboxExportJob( args: CancelMailboxExportJobCommandInput, cb: (err: any, data?: CancelMailboxExportJobCommandOutput) => void ): void; - public cancelMailboxExportJob( + cancelMailboxExportJob( args: CancelMailboxExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelMailboxExportJobCommandOutput) => void ): void; - public cancelMailboxExportJob( - args: CancelMailboxExportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CancelMailboxExportJobCommandOutput) => void), - cb?: (err: any, data?: CancelMailboxExportJobCommandOutput) => void - ): Promise | void { - const command = new CancelMailboxExportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds an alias to the set of a given member (user or group) of WorkMail.

- */ - public createAlias(args: CreateAliasCommandInput, options?: __HttpHandlerOptions): Promise; - public createAlias(args: CreateAliasCommandInput, cb: (err: any, data?: CreateAliasCommandOutput) => void): void; - public createAlias( + + /** + * @see {@link CreateAliasCommand} + */ + createAlias(args: CreateAliasCommandInput, options?: __HttpHandlerOptions): Promise; + createAlias(args: CreateAliasCommandInput, cb: (err: any, data?: CreateAliasCommandOutput) => void): void; + createAlias( args: CreateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAliasCommandOutput) => void ): void; - public createAlias( - args: CreateAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAliasCommandOutput) => void), - cb?: (err: any, data?: CreateAliasCommandOutput) => void - ): Promise | void { - const command = new CreateAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an AvailabilityConfiguration for the given WorkMail organization and domain.

- */ - public createAvailabilityConfiguration( + + /** + * @see {@link CreateAvailabilityConfigurationCommand} + */ + createAvailabilityConfiguration( args: CreateAvailabilityConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createAvailabilityConfiguration( + createAvailabilityConfiguration( args: CreateAvailabilityConfigurationCommandInput, cb: (err: any, data?: CreateAvailabilityConfigurationCommandOutput) => void ): void; - public createAvailabilityConfiguration( + createAvailabilityConfiguration( args: CreateAvailabilityConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAvailabilityConfigurationCommandOutput) => void ): void; - public createAvailabilityConfiguration( - args: CreateAvailabilityConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateAvailabilityConfigurationCommandOutput) => void), - cb?: (err: any, data?: CreateAvailabilityConfigurationCommandOutput) => void - ): Promise | void { - const command = new CreateAvailabilityConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.

- */ - public createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void; - public createGroup( + + /** + * @see {@link CreateGroupCommand} + */ + createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise; + createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void; + createGroup( args: CreateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupCommandOutput) => void ): void; - public createGroup( - args: CreateGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGroupCommandOutput) => void), - cb?: (err: any, data?: CreateGroupCommandOutput) => void - ): Promise | void { - const command = new CreateGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an impersonation role for the given WorkMail organization.

- *

- * Idempotency ensures that an API request completes no more than one - * time. With an idempotent request, if the original request completes successfully, any - * subsequent retries also complete successfully without performing any further - * actions.

- */ - public createImpersonationRole( + + /** + * @see {@link CreateImpersonationRoleCommand} + */ + createImpersonationRole( args: CreateImpersonationRoleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createImpersonationRole( + createImpersonationRole( args: CreateImpersonationRoleCommandInput, cb: (err: any, data?: CreateImpersonationRoleCommandOutput) => void ): void; - public createImpersonationRole( + createImpersonationRole( args: CreateImpersonationRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateImpersonationRoleCommandOutput) => void ): void; - public createImpersonationRole( - args: CreateImpersonationRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateImpersonationRoleCommandOutput) => void), - cb?: (err: any, data?: CreateImpersonationRoleCommandOutput) => void - ): Promise | void { - const command = new CreateImpersonationRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new mobile device access rule for the specified WorkMail organization.

- */ - public createMobileDeviceAccessRule( + + /** + * @see {@link CreateMobileDeviceAccessRuleCommand} + */ + createMobileDeviceAccessRule( args: CreateMobileDeviceAccessRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createMobileDeviceAccessRule( + createMobileDeviceAccessRule( args: CreateMobileDeviceAccessRuleCommandInput, cb: (err: any, data?: CreateMobileDeviceAccessRuleCommandOutput) => void ): void; - public createMobileDeviceAccessRule( + createMobileDeviceAccessRule( args: CreateMobileDeviceAccessRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMobileDeviceAccessRuleCommandOutput) => void ): void; - public createMobileDeviceAccessRule( - args: CreateMobileDeviceAccessRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateMobileDeviceAccessRuleCommandOutput) => void), - cb?: (err: any, data?: CreateMobileDeviceAccessRuleCommandOutput) => void - ): Promise | void { - const command = new CreateMobileDeviceAccessRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new WorkMail directory for you. For more information, see Adding an organization in the WorkMail Administrator Guide.

- *

You can associate multiple email domains with an organization, then choose your - * default email domain from the WorkMail console. You can also associate a domain that is managed - * in an Amazon Route 53 public hosted zone. For more information, see Adding a - * domain and Choosing the default domain - * in the WorkMail Administrator Guide.

- *

Optionally, you can use a customer managed key from AWS Key Management Service (AWS - * KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, WorkMail - * creates a default, AWS managed key for you.

- */ - public createOrganization( + + /** + * @see {@link CreateOrganizationCommand} + */ + createOrganization( args: CreateOrganizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public createOrganization( + createOrganization( args: CreateOrganizationCommandInput, cb: (err: any, data?: CreateOrganizationCommandOutput) => void ): void; - public createOrganization( + createOrganization( args: CreateOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateOrganizationCommandOutput) => void ): void; - public createOrganization( - args: CreateOrganizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateOrganizationCommandOutput) => void), - cb?: (err: any, data?: CreateOrganizationCommandOutput) => void - ): Promise | void { - const command = new CreateOrganizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new WorkMail resource.

- */ - public createResource( + + /** + * @see {@link CreateResourceCommand} + */ + createResource( args: CreateResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public createResource( - args: CreateResourceCommandInput, - cb: (err: any, data?: CreateResourceCommandOutput) => void - ): void; - public createResource( + createResource(args: CreateResourceCommandInput, cb: (err: any, data?: CreateResourceCommandOutput) => void): void; + createResource( args: CreateResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResourceCommandOutput) => void ): void; - public createResource( - args: CreateResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateResourceCommandOutput) => void), - cb?: (err: any, data?: CreateResourceCommandOutput) => void - ): Promise | void { - const command = new CreateResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.

- */ - public createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; - public createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; - public createUser( + + /** + * @see {@link CreateUserCommand} + */ + createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise; + createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void; + createUser( args: CreateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserCommandOutput) => void ): void; - public createUser( - args: CreateUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserCommandOutput) => void), - cb?: (err: any, data?: CreateUserCommandOutput) => void - ): Promise | void { - const command = new CreateUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an access control rule for the specified WorkMail organization.

- * - *

Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

- *
- */ - public deleteAccessControlRule( + + /** + * @see {@link DeleteAccessControlRuleCommand} + */ + deleteAccessControlRule( args: DeleteAccessControlRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAccessControlRule( + deleteAccessControlRule( args: DeleteAccessControlRuleCommandInput, cb: (err: any, data?: DeleteAccessControlRuleCommandOutput) => void ): void; - public deleteAccessControlRule( + deleteAccessControlRule( args: DeleteAccessControlRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessControlRuleCommandOutput) => void ): void; - public deleteAccessControlRule( - args: DeleteAccessControlRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAccessControlRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteAccessControlRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteAccessControlRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Remove one or more specified aliases from a set of aliases for a given - * user.

- */ - public deleteAlias(args: DeleteAliasCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteAlias(args: DeleteAliasCommandInput, cb: (err: any, data?: DeleteAliasCommandOutput) => void): void; - public deleteAlias( + + /** + * @see {@link DeleteAliasCommand} + */ + deleteAlias(args: DeleteAliasCommandInput, options?: __HttpHandlerOptions): Promise; + deleteAlias(args: DeleteAliasCommandInput, cb: (err: any, data?: DeleteAliasCommandOutput) => void): void; + deleteAlias( args: DeleteAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAliasCommandOutput) => void ): void; - public deleteAlias( - args: DeleteAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAliasCommandOutput) => void), - cb?: (err: any, data?: DeleteAliasCommandOutput) => void - ): Promise | void { - const command = new DeleteAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.

- */ - public deleteAvailabilityConfiguration( + + /** + * @see {@link DeleteAvailabilityConfigurationCommand} + */ + deleteAvailabilityConfiguration( args: DeleteAvailabilityConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteAvailabilityConfiguration( + deleteAvailabilityConfiguration( args: DeleteAvailabilityConfigurationCommandInput, cb: (err: any, data?: DeleteAvailabilityConfigurationCommandOutput) => void ): void; - public deleteAvailabilityConfiguration( + deleteAvailabilityConfiguration( args: DeleteAvailabilityConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAvailabilityConfigurationCommandOutput) => void ): void; - public deleteAvailabilityConfiguration( - args: DeleteAvailabilityConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteAvailabilityConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteAvailabilityConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteAvailabilityConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the email monitoring configuration for a specified organization.

- */ - public deleteEmailMonitoringConfiguration( + + /** + * @see {@link DeleteEmailMonitoringConfigurationCommand} + */ + deleteEmailMonitoringConfiguration( args: DeleteEmailMonitoringConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteEmailMonitoringConfiguration( + deleteEmailMonitoringConfiguration( args: DeleteEmailMonitoringConfigurationCommandInput, cb: (err: any, data?: DeleteEmailMonitoringConfigurationCommandOutput) => void ): void; - public deleteEmailMonitoringConfiguration( + deleteEmailMonitoringConfiguration( args: DeleteEmailMonitoringConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEmailMonitoringConfigurationCommandOutput) => void ): void; - public deleteEmailMonitoringConfiguration( - args: DeleteEmailMonitoringConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteEmailMonitoringConfigurationCommandOutput) => void), - cb?: (err: any, data?: DeleteEmailMonitoringConfigurationCommandOutput) => void - ): Promise | void { - const command = new DeleteEmailMonitoringConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a group from WorkMail.

- */ - public deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void; - public deleteGroup( + + /** + * @see {@link DeleteGroupCommand} + */ + deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise; + deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void; + deleteGroup( args: DeleteGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupCommandOutput) => void ): void; - public deleteGroup( - args: DeleteGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an impersonation role for the given WorkMail organization.

- */ - public deleteImpersonationRole( + + /** + * @see {@link DeleteImpersonationRoleCommand} + */ + deleteImpersonationRole( args: DeleteImpersonationRoleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteImpersonationRole( + deleteImpersonationRole( args: DeleteImpersonationRoleCommandInput, cb: (err: any, data?: DeleteImpersonationRoleCommandOutput) => void ): void; - public deleteImpersonationRole( + deleteImpersonationRole( args: DeleteImpersonationRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteImpersonationRoleCommandOutput) => void ): void; - public deleteImpersonationRole( - args: DeleteImpersonationRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteImpersonationRoleCommandOutput) => void), - cb?: (err: any, data?: DeleteImpersonationRoleCommandOutput) => void - ): Promise | void { - const command = new DeleteImpersonationRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes permissions granted to a member (user or group).

- */ - public deleteMailboxPermissions( + + /** + * @see {@link DeleteMailboxPermissionsCommand} + */ + deleteMailboxPermissions( args: DeleteMailboxPermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMailboxPermissions( + deleteMailboxPermissions( args: DeleteMailboxPermissionsCommandInput, cb: (err: any, data?: DeleteMailboxPermissionsCommandOutput) => void ): void; - public deleteMailboxPermissions( + deleteMailboxPermissions( args: DeleteMailboxPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMailboxPermissionsCommandOutput) => void ): void; - public deleteMailboxPermissions( - args: DeleteMailboxPermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMailboxPermissionsCommandOutput) => void), - cb?: (err: any, data?: DeleteMailboxPermissionsCommandOutput) => void - ): Promise | void { - const command = new DeleteMailboxPermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the mobile device access override for the given WorkMail organization, user, and device.

- * - *

Deleting already deleted and non-existing overrides does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

- *
- */ - public deleteMobileDeviceAccessOverride( + + /** + * @see {@link DeleteMobileDeviceAccessOverrideCommand} + */ + deleteMobileDeviceAccessOverride( args: DeleteMobileDeviceAccessOverrideCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMobileDeviceAccessOverride( + deleteMobileDeviceAccessOverride( args: DeleteMobileDeviceAccessOverrideCommandInput, cb: (err: any, data?: DeleteMobileDeviceAccessOverrideCommandOutput) => void ): void; - public deleteMobileDeviceAccessOverride( + deleteMobileDeviceAccessOverride( args: DeleteMobileDeviceAccessOverrideCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMobileDeviceAccessOverrideCommandOutput) => void ): void; - public deleteMobileDeviceAccessOverride( - args: DeleteMobileDeviceAccessOverrideCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMobileDeviceAccessOverrideCommandOutput) => void), - cb?: (err: any, data?: DeleteMobileDeviceAccessOverrideCommandOutput) => void - ): Promise | void { - const command = new DeleteMobileDeviceAccessOverrideCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a mobile device access rule for the specified WorkMail organization.

- * - *

Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.

- *
- */ - public deleteMobileDeviceAccessRule( + + /** + * @see {@link DeleteMobileDeviceAccessRuleCommand} + */ + deleteMobileDeviceAccessRule( args: DeleteMobileDeviceAccessRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteMobileDeviceAccessRule( + deleteMobileDeviceAccessRule( args: DeleteMobileDeviceAccessRuleCommandInput, cb: (err: any, data?: DeleteMobileDeviceAccessRuleCommandOutput) => void ): void; - public deleteMobileDeviceAccessRule( + deleteMobileDeviceAccessRule( args: DeleteMobileDeviceAccessRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMobileDeviceAccessRuleCommandOutput) => void ): void; - public deleteMobileDeviceAccessRule( - args: DeleteMobileDeviceAccessRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteMobileDeviceAccessRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteMobileDeviceAccessRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteMobileDeviceAccessRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the WorkMail Administrator Guide.

- */ - public deleteOrganization( + + /** + * @see {@link DeleteOrganizationCommand} + */ + deleteOrganization( args: DeleteOrganizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteOrganization( + deleteOrganization( args: DeleteOrganizationCommandInput, cb: (err: any, data?: DeleteOrganizationCommandOutput) => void ): void; - public deleteOrganization( + deleteOrganization( args: DeleteOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOrganizationCommandOutput) => void ): void; - public deleteOrganization( - args: DeleteOrganizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteOrganizationCommandOutput) => void), - cb?: (err: any, data?: DeleteOrganizationCommandOutput) => void - ): Promise | void { - const command = new DeleteOrganizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified resource.

- */ - public deleteResource( + + /** + * @see {@link DeleteResourceCommand} + */ + deleteResource( args: DeleteResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResource( - args: DeleteResourceCommandInput, - cb: (err: any, data?: DeleteResourceCommandOutput) => void - ): void; - public deleteResource( + deleteResource(args: DeleteResourceCommandInput, cb: (err: any, data?: DeleteResourceCommandOutput) => void): void; + deleteResource( args: DeleteResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourceCommandOutput) => void ): void; - public deleteResource( - args: DeleteResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourceCommandOutput) => void), - cb?: (err: any, data?: DeleteResourceCommandOutput) => void - ): Promise | void { - const command = new DeleteResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified retention policy from the specified organization.

- */ - public deleteRetentionPolicy( + + /** + * @see {@link DeleteRetentionPolicyCommand} + */ + deleteRetentionPolicy( args: DeleteRetentionPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteRetentionPolicy( + deleteRetentionPolicy( args: DeleteRetentionPolicyCommandInput, cb: (err: any, data?: DeleteRetentionPolicyCommandOutput) => void ): void; - public deleteRetentionPolicy( + deleteRetentionPolicy( args: DeleteRetentionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRetentionPolicyCommandOutput) => void ): void; - public deleteRetentionPolicy( - args: DeleteRetentionPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteRetentionPolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteRetentionPolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteRetentionPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a user from WorkMail and all subsequent systems. Before you can delete a - * user, the user state must be DISABLED. Use the DescribeUser - * action to confirm the user state.

- *

Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for - * 30 days before they are permanently removed.

- */ - public deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; - public deleteUser( + + /** + * @see {@link DeleteUserCommand} + */ + deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise; + deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void; + deleteUser( args: DeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserCommandOutput) => void ): void; - public deleteUser( - args: DeleteUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserCommandOutput) => void), - cb?: (err: any, data?: DeleteUserCommandOutput) => void - ): Promise | void { - const command = new DeleteUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Mark a user, group, or resource as no longer used in WorkMail. This action - * disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days - * before they are permanently removed. The functionality in the console is - * Disable.

- */ - public deregisterFromWorkMail( + + /** + * @see {@link DeregisterFromWorkMailCommand} + */ + deregisterFromWorkMail( args: DeregisterFromWorkMailCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterFromWorkMail( + deregisterFromWorkMail( args: DeregisterFromWorkMailCommandInput, cb: (err: any, data?: DeregisterFromWorkMailCommandOutput) => void ): void; - public deregisterFromWorkMail( + deregisterFromWorkMail( args: DeregisterFromWorkMailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterFromWorkMailCommandOutput) => void ): void; - public deregisterFromWorkMail( - args: DeregisterFromWorkMailCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterFromWorkMailCommandOutput) => void), - cb?: (err: any, data?: DeregisterFromWorkMailCommandOutput) => void - ): Promise | void { - const command = new DeregisterFromWorkMailCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use. SES keeps the domain because other applications may use it. You must first - * remove any email address used by WorkMail entities before you remove the domain.

- */ - public deregisterMailDomain( + + /** + * @see {@link DeregisterMailDomainCommand} + */ + deregisterMailDomain( args: DeregisterMailDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterMailDomain( + deregisterMailDomain( args: DeregisterMailDomainCommandInput, cb: (err: any, data?: DeregisterMailDomainCommandOutput) => void ): void; - public deregisterMailDomain( + deregisterMailDomain( args: DeregisterMailDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterMailDomainCommandOutput) => void ): void; - public deregisterMailDomain( - args: DeregisterMailDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterMailDomainCommandOutput) => void), - cb?: (err: any, data?: DeregisterMailDomainCommandOutput) => void - ): Promise | void { - const command = new DeregisterMailDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the current email monitoring configuration for a specified organization.

- */ - public describeEmailMonitoringConfiguration( + + /** + * @see {@link DescribeEmailMonitoringConfigurationCommand} + */ + describeEmailMonitoringConfiguration( args: DescribeEmailMonitoringConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeEmailMonitoringConfiguration( + describeEmailMonitoringConfiguration( args: DescribeEmailMonitoringConfigurationCommandInput, cb: (err: any, data?: DescribeEmailMonitoringConfigurationCommandOutput) => void ): void; - public describeEmailMonitoringConfiguration( + describeEmailMonitoringConfiguration( args: DescribeEmailMonitoringConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEmailMonitoringConfigurationCommandOutput) => void ): void; - public describeEmailMonitoringConfiguration( - args: DescribeEmailMonitoringConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeEmailMonitoringConfigurationCommandOutput) => void), - cb?: (err: any, data?: DescribeEmailMonitoringConfigurationCommandOutput) => void - ): Promise | void { - const command = new DescribeEmailMonitoringConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the data available for the group.

- */ - public describeGroup( - args: DescribeGroupCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeGroup( - args: DescribeGroupCommandInput, - cb: (err: any, data?: DescribeGroupCommandOutput) => void - ): void; - public describeGroup( + + /** + * @see {@link DescribeGroupCommand} + */ + describeGroup(args: DescribeGroupCommandInput, options?: __HttpHandlerOptions): Promise; + describeGroup(args: DescribeGroupCommandInput, cb: (err: any, data?: DescribeGroupCommandOutput) => void): void; + describeGroup( args: DescribeGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGroupCommandOutput) => void ): void; - public describeGroup( - args: DescribeGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeGroupCommandOutput) => void), - cb?: (err: any, data?: DescribeGroupCommandOutput) => void - ): Promise | void { - const command = new DescribeGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the settings in a DMARC policy for a specified organization.

- */ - public describeInboundDmarcSettings( + + /** + * @see {@link DescribeInboundDmarcSettingsCommand} + */ + describeInboundDmarcSettings( args: DescribeInboundDmarcSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeInboundDmarcSettings( + describeInboundDmarcSettings( args: DescribeInboundDmarcSettingsCommandInput, cb: (err: any, data?: DescribeInboundDmarcSettingsCommandOutput) => void ): void; - public describeInboundDmarcSettings( + describeInboundDmarcSettings( args: DescribeInboundDmarcSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInboundDmarcSettingsCommandOutput) => void ): void; - public describeInboundDmarcSettings( - args: DescribeInboundDmarcSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeInboundDmarcSettingsCommandOutput) => void), - cb?: (err: any, data?: DescribeInboundDmarcSettingsCommandOutput) => void - ): Promise | void { - const command = new DescribeInboundDmarcSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the current status of a mailbox export job.

- */ - public describeMailboxExportJob( + + /** + * @see {@link DescribeMailboxExportJobCommand} + */ + describeMailboxExportJob( args: DescribeMailboxExportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeMailboxExportJob( + describeMailboxExportJob( args: DescribeMailboxExportJobCommandInput, cb: (err: any, data?: DescribeMailboxExportJobCommandOutput) => void ): void; - public describeMailboxExportJob( + describeMailboxExportJob( args: DescribeMailboxExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMailboxExportJobCommandOutput) => void ): void; - public describeMailboxExportJob( - args: DescribeMailboxExportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeMailboxExportJobCommandOutput) => void), - cb?: (err: any, data?: DescribeMailboxExportJobCommandOutput) => void - ): Promise | void { - const command = new DescribeMailboxExportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides more information regarding a given organization based on its - * identifier.

- */ - public describeOrganization( + + /** + * @see {@link DescribeOrganizationCommand} + */ + describeOrganization( args: DescribeOrganizationCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeOrganization( + describeOrganization( args: DescribeOrganizationCommandInput, cb: (err: any, data?: DescribeOrganizationCommandOutput) => void ): void; - public describeOrganization( + describeOrganization( args: DescribeOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrganizationCommandOutput) => void ): void; - public describeOrganization( - args: DescribeOrganizationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeOrganizationCommandOutput) => void), - cb?: (err: any, data?: DescribeOrganizationCommandOutput) => void - ): Promise | void { - const command = new DescribeOrganizationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns the data available for the resource.

- */ - public describeResource( + + /** + * @see {@link DescribeResourceCommand} + */ + describeResource( args: DescribeResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeResource( + describeResource( args: DescribeResourceCommandInput, cb: (err: any, data?: DescribeResourceCommandOutput) => void ): void; - public describeResource( + describeResource( args: DescribeResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeResourceCommandOutput) => void ): void; - public describeResource( - args: DescribeResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeResourceCommandOutput) => void), - cb?: (err: any, data?: DescribeResourceCommandOutput) => void - ): Promise | void { - const command = new DescribeResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Provides information regarding the user.

- */ - public describeUser( - args: DescribeUserCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeUser(args: DescribeUserCommandInput, cb: (err: any, data?: DescribeUserCommandOutput) => void): void; - public describeUser( + + /** + * @see {@link DescribeUserCommand} + */ + describeUser(args: DescribeUserCommandInput, options?: __HttpHandlerOptions): Promise; + describeUser(args: DescribeUserCommandInput, cb: (err: any, data?: DescribeUserCommandOutput) => void): void; + describeUser( args: DescribeUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserCommandOutput) => void ): void; - public describeUser( - args: DescribeUserCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeUserCommandOutput) => void), - cb?: (err: any, data?: DescribeUserCommandOutput) => void - ): Promise | void { - const command = new DescribeUserCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a member from the resource's set of delegates.

- */ - public disassociateDelegateFromResource( + + /** + * @see {@link DisassociateDelegateFromResourceCommand} + */ + disassociateDelegateFromResource( args: DisassociateDelegateFromResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateDelegateFromResource( + disassociateDelegateFromResource( args: DisassociateDelegateFromResourceCommandInput, cb: (err: any, data?: DisassociateDelegateFromResourceCommandOutput) => void ): void; - public disassociateDelegateFromResource( + disassociateDelegateFromResource( args: DisassociateDelegateFromResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateDelegateFromResourceCommandOutput) => void ): void; - public disassociateDelegateFromResource( - args: DisassociateDelegateFromResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateDelegateFromResourceCommandOutput) => void), - cb?: (err: any, data?: DisassociateDelegateFromResourceCommandOutput) => void - ): Promise | void { - const command = new DisassociateDelegateFromResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes a member from a group.

- */ - public disassociateMemberFromGroup( + + /** + * @see {@link DisassociateMemberFromGroupCommand} + */ + disassociateMemberFromGroup( args: DisassociateMemberFromGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateMemberFromGroup( + disassociateMemberFromGroup( args: DisassociateMemberFromGroupCommandInput, cb: (err: any, data?: DisassociateMemberFromGroupCommandOutput) => void ): void; - public disassociateMemberFromGroup( + disassociateMemberFromGroup( args: DisassociateMemberFromGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateMemberFromGroupCommandOutput) => void ): void; - public disassociateMemberFromGroup( - args: DisassociateMemberFromGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateMemberFromGroupCommandOutput) => void), - cb?: (err: any, data?: DisassociateMemberFromGroupCommandOutput) => void - ): Promise | void { - const command = new DisassociateMemberFromGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the effects of an organization's access control rules as they apply to a - * specified IPv4 address, access protocol action, and user ID or impersonation role ID. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS.

- */ - public getAccessControlEffect( + + /** + * @see {@link GetAccessControlEffectCommand} + */ + getAccessControlEffect( args: GetAccessControlEffectCommandInput, options?: __HttpHandlerOptions ): Promise; - public getAccessControlEffect( + getAccessControlEffect( args: GetAccessControlEffectCommandInput, cb: (err: any, data?: GetAccessControlEffectCommandOutput) => void ): void; - public getAccessControlEffect( + getAccessControlEffect( args: GetAccessControlEffectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessControlEffectCommandOutput) => void ): void; - public getAccessControlEffect( - args: GetAccessControlEffectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetAccessControlEffectCommandOutput) => void), - cb?: (err: any, data?: GetAccessControlEffectCommandOutput) => void - ): Promise | void { - const command = new GetAccessControlEffectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the default retention policy details for the specified organization.

- */ - public getDefaultRetentionPolicy( + + /** + * @see {@link GetDefaultRetentionPolicyCommand} + */ + getDefaultRetentionPolicy( args: GetDefaultRetentionPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public getDefaultRetentionPolicy( + getDefaultRetentionPolicy( args: GetDefaultRetentionPolicyCommandInput, cb: (err: any, data?: GetDefaultRetentionPolicyCommandOutput) => void ): void; - public getDefaultRetentionPolicy( + getDefaultRetentionPolicy( args: GetDefaultRetentionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDefaultRetentionPolicyCommandOutput) => void ): void; - public getDefaultRetentionPolicy( - args: GetDefaultRetentionPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDefaultRetentionPolicyCommandOutput) => void), - cb?: (err: any, data?: GetDefaultRetentionPolicyCommandOutput) => void - ): Promise | void { - const command = new GetDefaultRetentionPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the impersonation role details for the given WorkMail organization.

- */ - public getImpersonationRole( + + /** + * @see {@link GetImpersonationRoleCommand} + */ + getImpersonationRole( args: GetImpersonationRoleCommandInput, options?: __HttpHandlerOptions ): Promise; - public getImpersonationRole( + getImpersonationRole( args: GetImpersonationRoleCommandInput, cb: (err: any, data?: GetImpersonationRoleCommandOutput) => void ): void; - public getImpersonationRole( + getImpersonationRole( args: GetImpersonationRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetImpersonationRoleCommandOutput) => void ): void; - public getImpersonationRole( - args: GetImpersonationRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetImpersonationRoleCommandOutput) => void), - cb?: (err: any, data?: GetImpersonationRoleCommandOutput) => void - ): Promise | void { - const command = new GetImpersonationRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Tests whether the given impersonation role can impersonate a target user.

- */ - public getImpersonationRoleEffect( + + /** + * @see {@link GetImpersonationRoleEffectCommand} + */ + getImpersonationRoleEffect( args: GetImpersonationRoleEffectCommandInput, options?: __HttpHandlerOptions ): Promise; - public getImpersonationRoleEffect( + getImpersonationRoleEffect( args: GetImpersonationRoleEffectCommandInput, cb: (err: any, data?: GetImpersonationRoleEffectCommandOutput) => void ): void; - public getImpersonationRoleEffect( + getImpersonationRoleEffect( args: GetImpersonationRoleEffectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetImpersonationRoleEffectCommandOutput) => void ): void; - public getImpersonationRoleEffect( - args: GetImpersonationRoleEffectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetImpersonationRoleEffectCommandOutput) => void), - cb?: (err: any, data?: GetImpersonationRoleEffectCommandOutput) => void - ): Promise | void { - const command = new GetImpersonationRoleEffectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Requests a user's mailbox details for a specified organization and user.

- */ - public getMailboxDetails( + + /** + * @see {@link GetMailboxDetailsCommand} + */ + getMailboxDetails( args: GetMailboxDetailsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMailboxDetails( + getMailboxDetails( args: GetMailboxDetailsCommandInput, cb: (err: any, data?: GetMailboxDetailsCommandOutput) => void ): void; - public getMailboxDetails( + getMailboxDetails( args: GetMailboxDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMailboxDetailsCommandOutput) => void ): void; - public getMailboxDetails( - args: GetMailboxDetailsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMailboxDetailsCommandOutput) => void), - cb?: (err: any, data?: GetMailboxDetailsCommandOutput) => void - ): Promise | void { - const command = new GetMailboxDetailsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets details for a mail domain, including domain records required to configure your domain with recommended security.

- */ - public getMailDomain( - args: GetMailDomainCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getMailDomain( - args: GetMailDomainCommandInput, - cb: (err: any, data?: GetMailDomainCommandOutput) => void - ): void; - public getMailDomain( + + /** + * @see {@link GetMailDomainCommand} + */ + getMailDomain(args: GetMailDomainCommandInput, options?: __HttpHandlerOptions): Promise; + getMailDomain(args: GetMailDomainCommandInput, cb: (err: any, data?: GetMailDomainCommandOutput) => void): void; + getMailDomain( args: GetMailDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMailDomainCommandOutput) => void ): void; - public getMailDomain( - args: GetMailDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMailDomainCommandOutput) => void), - cb?: (err: any, data?: GetMailDomainCommandOutput) => void - ): Promise | void { - const command = new GetMailDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access - * rules for the WorkMail organization for a particular user's attributes.

- */ - public getMobileDeviceAccessEffect( + + /** + * @see {@link GetMobileDeviceAccessEffectCommand} + */ + getMobileDeviceAccessEffect( args: GetMobileDeviceAccessEffectCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMobileDeviceAccessEffect( + getMobileDeviceAccessEffect( args: GetMobileDeviceAccessEffectCommandInput, cb: (err: any, data?: GetMobileDeviceAccessEffectCommandOutput) => void ): void; - public getMobileDeviceAccessEffect( + getMobileDeviceAccessEffect( args: GetMobileDeviceAccessEffectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMobileDeviceAccessEffectCommandOutput) => void ): void; - public getMobileDeviceAccessEffect( - args: GetMobileDeviceAccessEffectCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMobileDeviceAccessEffectCommandOutput) => void), - cb?: (err: any, data?: GetMobileDeviceAccessEffectCommandOutput) => void - ): Promise | void { - const command = new GetMobileDeviceAccessEffectCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Gets the mobile device access override for the given WorkMail organization, user, and device.

- */ - public getMobileDeviceAccessOverride( + + /** + * @see {@link GetMobileDeviceAccessOverrideCommand} + */ + getMobileDeviceAccessOverride( args: GetMobileDeviceAccessOverrideCommandInput, options?: __HttpHandlerOptions ): Promise; - public getMobileDeviceAccessOverride( + getMobileDeviceAccessOverride( args: GetMobileDeviceAccessOverrideCommandInput, cb: (err: any, data?: GetMobileDeviceAccessOverrideCommandOutput) => void ): void; - public getMobileDeviceAccessOverride( + getMobileDeviceAccessOverride( args: GetMobileDeviceAccessOverrideCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMobileDeviceAccessOverrideCommandOutput) => void ): void; - public getMobileDeviceAccessOverride( - args: GetMobileDeviceAccessOverrideCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetMobileDeviceAccessOverrideCommandOutput) => void), - cb?: (err: any, data?: GetMobileDeviceAccessOverrideCommandOutput) => void - ): Promise | void { - const command = new GetMobileDeviceAccessOverrideCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the access control rules for the specified organization.

- */ - public listAccessControlRules( + + /** + * @see {@link ListAccessControlRulesCommand} + */ + listAccessControlRules( args: ListAccessControlRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAccessControlRules( + listAccessControlRules( args: ListAccessControlRulesCommandInput, cb: (err: any, data?: ListAccessControlRulesCommandOutput) => void ): void; - public listAccessControlRules( + listAccessControlRules( args: ListAccessControlRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessControlRulesCommandOutput) => void ): void; - public listAccessControlRules( - args: ListAccessControlRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAccessControlRulesCommandOutput) => void), - cb?: (err: any, data?: ListAccessControlRulesCommandOutput) => void - ): Promise | void { - const command = new ListAccessControlRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a paginated call to list the aliases associated with a given - * entity.

- */ - public listAliases(args: ListAliasesCommandInput, options?: __HttpHandlerOptions): Promise; - public listAliases(args: ListAliasesCommandInput, cb: (err: any, data?: ListAliasesCommandOutput) => void): void; - public listAliases( + + /** + * @see {@link ListAliasesCommand} + */ + listAliases(args: ListAliasesCommandInput, options?: __HttpHandlerOptions): Promise; + listAliases(args: ListAliasesCommandInput, cb: (err: any, data?: ListAliasesCommandOutput) => void): void; + listAliases( args: ListAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAliasesCommandOutput) => void ): void; - public listAliases( - args: ListAliasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAliasesCommandOutput) => void), - cb?: (err: any, data?: ListAliasesCommandOutput) => void - ): Promise | void { - const command = new ListAliasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

List all the AvailabilityConfiguration's for the given WorkMail organization.

- */ - public listAvailabilityConfigurations( + + /** + * @see {@link ListAvailabilityConfigurationsCommand} + */ + listAvailabilityConfigurations( args: ListAvailabilityConfigurationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAvailabilityConfigurations( + listAvailabilityConfigurations( args: ListAvailabilityConfigurationsCommandInput, cb: (err: any, data?: ListAvailabilityConfigurationsCommandOutput) => void ): void; - public listAvailabilityConfigurations( + listAvailabilityConfigurations( args: ListAvailabilityConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAvailabilityConfigurationsCommandOutput) => void ): void; - public listAvailabilityConfigurations( - args: ListAvailabilityConfigurationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAvailabilityConfigurationsCommandOutput) => void), - cb?: (err: any, data?: ListAvailabilityConfigurationsCommandOutput) => void - ): Promise | void { - const command = new ListAvailabilityConfigurationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns an overview of the members of a group. Users and groups can be members of a - * group.

- */ - public listGroupMembers( + + /** + * @see {@link ListGroupMembersCommand} + */ + listGroupMembers( args: ListGroupMembersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listGroupMembers( + listGroupMembers( args: ListGroupMembersCommandInput, cb: (err: any, data?: ListGroupMembersCommandOutput) => void ): void; - public listGroupMembers( + listGroupMembers( args: ListGroupMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupMembersCommandOutput) => void ): void; - public listGroupMembers( - args: ListGroupMembersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGroupMembersCommandOutput) => void), - cb?: (err: any, data?: ListGroupMembersCommandOutput) => void - ): Promise | void { - const command = new ListGroupMembersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns summaries of the organization's groups.

- */ - public listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise; - public listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void; - public listGroups( + + /** + * @see {@link ListGroupsCommand} + */ + listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise; + listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void; + listGroups( args: ListGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsCommandOutput) => void ): void; - public listGroups( - args: ListGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListGroupsCommandOutput) => void), - cb?: (err: any, data?: ListGroupsCommandOutput) => void - ): Promise | void { - const command = new ListGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all the impersonation roles for the given WorkMail organization.

- */ - public listImpersonationRoles( + + /** + * @see {@link ListImpersonationRolesCommand} + */ + listImpersonationRoles( args: ListImpersonationRolesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listImpersonationRoles( + listImpersonationRoles( args: ListImpersonationRolesCommandInput, cb: (err: any, data?: ListImpersonationRolesCommandOutput) => void ): void; - public listImpersonationRoles( + listImpersonationRoles( args: ListImpersonationRolesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImpersonationRolesCommandOutput) => void ): void; - public listImpersonationRoles( - args: ListImpersonationRolesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListImpersonationRolesCommandOutput) => void), - cb?: (err: any, data?: ListImpersonationRolesCommandOutput) => void - ): Promise | void { - const command = new ListImpersonationRolesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the mailbox export jobs started for the specified organization within the last - * seven days.

- */ - public listMailboxExportJobs( + + /** + * @see {@link ListMailboxExportJobsCommand} + */ + listMailboxExportJobs( args: ListMailboxExportJobsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMailboxExportJobs( + listMailboxExportJobs( args: ListMailboxExportJobsCommandInput, cb: (err: any, data?: ListMailboxExportJobsCommandOutput) => void ): void; - public listMailboxExportJobs( + listMailboxExportJobs( args: ListMailboxExportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMailboxExportJobsCommandOutput) => void ): void; - public listMailboxExportJobs( - args: ListMailboxExportJobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMailboxExportJobsCommandOutput) => void), - cb?: (err: any, data?: ListMailboxExportJobsCommandOutput) => void - ): Promise | void { - const command = new ListMailboxExportJobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the mailbox permissions associated with a user, group, or resource - * mailbox.

- */ - public listMailboxPermissions( + + /** + * @see {@link ListMailboxPermissionsCommand} + */ + listMailboxPermissions( args: ListMailboxPermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMailboxPermissions( + listMailboxPermissions( args: ListMailboxPermissionsCommandInput, cb: (err: any, data?: ListMailboxPermissionsCommandOutput) => void ): void; - public listMailboxPermissions( + listMailboxPermissions( args: ListMailboxPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMailboxPermissionsCommandOutput) => void ): void; - public listMailboxPermissions( - args: ListMailboxPermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMailboxPermissionsCommandOutput) => void), - cb?: (err: any, data?: ListMailboxPermissionsCommandOutput) => void - ): Promise | void { - const command = new ListMailboxPermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the mail domains in a given WorkMail organization.

- */ - public listMailDomains( + + /** + * @see {@link ListMailDomainsCommand} + */ + listMailDomains( args: ListMailDomainsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMailDomains( - args: ListMailDomainsCommandInput, - cb: (err: any, data?: ListMailDomainsCommandOutput) => void - ): void; - public listMailDomains( + listMailDomains(args: ListMailDomainsCommandInput, cb: (err: any, data?: ListMailDomainsCommandOutput) => void): void; + listMailDomains( args: ListMailDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMailDomainsCommandOutput) => void ): void; - public listMailDomains( - args: ListMailDomainsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMailDomainsCommandOutput) => void), - cb?: (err: any, data?: ListMailDomainsCommandOutput) => void - ): Promise | void { - const command = new ListMailDomainsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.

- */ - public listMobileDeviceAccessOverrides( + + /** + * @see {@link ListMobileDeviceAccessOverridesCommand} + */ + listMobileDeviceAccessOverrides( args: ListMobileDeviceAccessOverridesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMobileDeviceAccessOverrides( + listMobileDeviceAccessOverrides( args: ListMobileDeviceAccessOverridesCommandInput, cb: (err: any, data?: ListMobileDeviceAccessOverridesCommandOutput) => void ): void; - public listMobileDeviceAccessOverrides( + listMobileDeviceAccessOverrides( args: ListMobileDeviceAccessOverridesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMobileDeviceAccessOverridesCommandOutput) => void ): void; - public listMobileDeviceAccessOverrides( - args: ListMobileDeviceAccessOverridesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMobileDeviceAccessOverridesCommandOutput) => void), - cb?: (err: any, data?: ListMobileDeviceAccessOverridesCommandOutput) => void - ): Promise | void { - const command = new ListMobileDeviceAccessOverridesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the mobile device access rules for the specified WorkMail organization.

- */ - public listMobileDeviceAccessRules( + + /** + * @see {@link ListMobileDeviceAccessRulesCommand} + */ + listMobileDeviceAccessRules( args: ListMobileDeviceAccessRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listMobileDeviceAccessRules( + listMobileDeviceAccessRules( args: ListMobileDeviceAccessRulesCommandInput, cb: (err: any, data?: ListMobileDeviceAccessRulesCommandOutput) => void ): void; - public listMobileDeviceAccessRules( + listMobileDeviceAccessRules( args: ListMobileDeviceAccessRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMobileDeviceAccessRulesCommandOutput) => void ): void; - public listMobileDeviceAccessRules( - args: ListMobileDeviceAccessRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListMobileDeviceAccessRulesCommandOutput) => void), - cb?: (err: any, data?: ListMobileDeviceAccessRulesCommandOutput) => void - ): Promise | void { - const command = new ListMobileDeviceAccessRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns summaries of the customer's organizations.

- */ - public listOrganizations( + + /** + * @see {@link ListOrganizationsCommand} + */ + listOrganizations( args: ListOrganizationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listOrganizations( + listOrganizations( args: ListOrganizationsCommandInput, cb: (err: any, data?: ListOrganizationsCommandOutput) => void ): void; - public listOrganizations( + listOrganizations( args: ListOrganizationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOrganizationsCommandOutput) => void ): void; - public listOrganizations( - args: ListOrganizationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListOrganizationsCommandOutput) => void), - cb?: (err: any, data?: ListOrganizationsCommandOutput) => void - ): Promise | void { - const command = new ListOrganizationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the delegates associated with a resource. Users and groups can be resource - * delegates and answer requests on behalf of the resource.

- */ - public listResourceDelegates( + + /** + * @see {@link ListResourceDelegatesCommand} + */ + listResourceDelegates( args: ListResourceDelegatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourceDelegates( + listResourceDelegates( args: ListResourceDelegatesCommandInput, cb: (err: any, data?: ListResourceDelegatesCommandOutput) => void ): void; - public listResourceDelegates( + listResourceDelegates( args: ListResourceDelegatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceDelegatesCommandOutput) => void ): void; - public listResourceDelegates( - args: ListResourceDelegatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourceDelegatesCommandOutput) => void), - cb?: (err: any, data?: ListResourceDelegatesCommandOutput) => void - ): Promise | void { - const command = new ListResourceDelegatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns summaries of the organization's resources.

- */ - public listResources( - args: ListResourcesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public listResources( - args: ListResourcesCommandInput, - cb: (err: any, data?: ListResourcesCommandOutput) => void - ): void; - public listResources( + + /** + * @see {@link ListResourcesCommand} + */ + listResources(args: ListResourcesCommandInput, options?: __HttpHandlerOptions): Promise; + listResources(args: ListResourcesCommandInput, cb: (err: any, data?: ListResourcesCommandOutput) => void): void; + listResources( args: ListResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourcesCommandOutput) => void ): void; - public listResources( - args: ListResourcesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourcesCommandOutput) => void), - cb?: (err: any, data?: ListResourcesCommandOutput) => void - ): Promise | void { - const command = new ListResourcesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Lists the tags applied to an WorkMail organization resource.

- */ - public listTagsForResource( + + /** + * @see {@link ListTagsForResourceCommand} + */ + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Returns summaries of the organization's users.

- */ - public listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise; - public listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void; - public listUsers( + + /** + * @see {@link ListUsersCommand} + */ + listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise; + listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void; + listUsers( args: ListUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersCommandOutput) => void ): void; - public listUsers( - args: ListUsersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUsersCommandOutput) => void), - cb?: (err: any, data?: ListUsersCommandOutput) => void - ): Promise | void { - const command = new ListUsersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds a new access control rule for the specified organization. The rule allows or - * denies access to the organization for the specified IPv4 addresses, access protocol - * actions, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces - * the older rule.

- */ - public putAccessControlRule( + + /** + * @see {@link PutAccessControlRuleCommand} + */ + putAccessControlRule( args: PutAccessControlRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAccessControlRule( + putAccessControlRule( args: PutAccessControlRuleCommandInput, cb: (err: any, data?: PutAccessControlRuleCommandOutput) => void ): void; - public putAccessControlRule( + putAccessControlRule( args: PutAccessControlRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccessControlRuleCommandOutput) => void ): void; - public putAccessControlRule( - args: PutAccessControlRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAccessControlRuleCommandOutput) => void), - cb?: (err: any, data?: PutAccessControlRuleCommandOutput) => void - ): Promise | void { - const command = new PutAccessControlRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or updates the email monitoring configuration for a specified organization.

- */ - public putEmailMonitoringConfiguration( + + /** + * @see {@link PutEmailMonitoringConfigurationCommand} + */ + putEmailMonitoringConfiguration( args: PutEmailMonitoringConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public putEmailMonitoringConfiguration( + putEmailMonitoringConfiguration( args: PutEmailMonitoringConfigurationCommandInput, cb: (err: any, data?: PutEmailMonitoringConfigurationCommandOutput) => void ): void; - public putEmailMonitoringConfiguration( + putEmailMonitoringConfiguration( args: PutEmailMonitoringConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEmailMonitoringConfigurationCommandOutput) => void ): void; - public putEmailMonitoringConfiguration( - args: PutEmailMonitoringConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutEmailMonitoringConfigurationCommandOutput) => void), - cb?: (err: any, data?: PutEmailMonitoringConfigurationCommandOutput) => void - ): Promise | void { - const command = new PutEmailMonitoringConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Enables or disables a DMARC policy for a given organization.

- */ - public putInboundDmarcSettings( + + /** + * @see {@link PutInboundDmarcSettingsCommand} + */ + putInboundDmarcSettings( args: PutInboundDmarcSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putInboundDmarcSettings( + putInboundDmarcSettings( args: PutInboundDmarcSettingsCommandInput, cb: (err: any, data?: PutInboundDmarcSettingsCommandOutput) => void ): void; - public putInboundDmarcSettings( + putInboundDmarcSettings( args: PutInboundDmarcSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutInboundDmarcSettingsCommandOutput) => void ): void; - public putInboundDmarcSettings( - args: PutInboundDmarcSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutInboundDmarcSettingsCommandOutput) => void), - cb?: (err: any, data?: PutInboundDmarcSettingsCommandOutput) => void - ): Promise | void { - const command = new PutInboundDmarcSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets permissions for a user, group, or resource. This replaces any pre-existing - * permissions.

- */ - public putMailboxPermissions( + + /** + * @see {@link PutMailboxPermissionsCommand} + */ + putMailboxPermissions( args: PutMailboxPermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putMailboxPermissions( + putMailboxPermissions( args: PutMailboxPermissionsCommandInput, cb: (err: any, data?: PutMailboxPermissionsCommandOutput) => void ): void; - public putMailboxPermissions( + putMailboxPermissions( args: PutMailboxPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMailboxPermissionsCommandOutput) => void ): void; - public putMailboxPermissions( - args: PutMailboxPermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutMailboxPermissionsCommandOutput) => void), - cb?: (err: any, data?: PutMailboxPermissionsCommandOutput) => void - ): Promise | void { - const command = new PutMailboxPermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates or updates a mobile device access override for the given WorkMail organization, user, and device.

- */ - public putMobileDeviceAccessOverride( + + /** + * @see {@link PutMobileDeviceAccessOverrideCommand} + */ + putMobileDeviceAccessOverride( args: PutMobileDeviceAccessOverrideCommandInput, options?: __HttpHandlerOptions ): Promise; - public putMobileDeviceAccessOverride( + putMobileDeviceAccessOverride( args: PutMobileDeviceAccessOverrideCommandInput, cb: (err: any, data?: PutMobileDeviceAccessOverrideCommandOutput) => void ): void; - public putMobileDeviceAccessOverride( + putMobileDeviceAccessOverride( args: PutMobileDeviceAccessOverrideCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMobileDeviceAccessOverrideCommandOutput) => void ): void; - public putMobileDeviceAccessOverride( - args: PutMobileDeviceAccessOverrideCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutMobileDeviceAccessOverrideCommandOutput) => void), - cb?: (err: any, data?: PutMobileDeviceAccessOverrideCommandOutput) => void - ): Promise | void { - const command = new PutMobileDeviceAccessOverrideCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Puts a retention policy to the specified organization.

- */ - public putRetentionPolicy( + + /** + * @see {@link PutRetentionPolicyCommand} + */ + putRetentionPolicy( args: PutRetentionPolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putRetentionPolicy( + putRetentionPolicy( args: PutRetentionPolicyCommandInput, cb: (err: any, data?: PutRetentionPolicyCommandOutput) => void ): void; - public putRetentionPolicy( + putRetentionPolicy( args: PutRetentionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRetentionPolicyCommandOutput) => void ): void; - public putRetentionPolicy( - args: PutRetentionPolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRetentionPolicyCommandOutput) => void), - cb?: (err: any, data?: PutRetentionPolicyCommandOutput) => void - ): Promise | void { - const command = new PutRetentionPolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail organization, and WorkMail has - * permanent permission to use the specified domain for sending your users' emails.

- */ - public registerMailDomain( + + /** + * @see {@link RegisterMailDomainCommand} + */ + registerMailDomain( args: RegisterMailDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerMailDomain( + registerMailDomain( args: RegisterMailDomainCommandInput, cb: (err: any, data?: RegisterMailDomainCommandOutput) => void ): void; - public registerMailDomain( + registerMailDomain( args: RegisterMailDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterMailDomainCommandOutput) => void ): void; - public registerMailDomain( - args: RegisterMailDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterMailDomainCommandOutput) => void), - cb?: (err: any, data?: RegisterMailDomainCommandOutput) => void - ): Promise | void { - const command = new RegisterMailDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers an existing and disabled user, group, or resource for WorkMail use by - * associating a mailbox and calendaring capabilities. It performs no change if the user, - * group, or resource is enabled and fails if the user, group, or resource is deleted. This - * operation results in the accumulation of costs. For more information, see Pricing. The equivalent console - * functionality for this operation is Enable.

- *

Users can either be created by calling the CreateUser API operation - * or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.

- */ - public registerToWorkMail( + + /** + * @see {@link RegisterToWorkMailCommand} + */ + registerToWorkMail( args: RegisterToWorkMailCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerToWorkMail( + registerToWorkMail( args: RegisterToWorkMailCommandInput, cb: (err: any, data?: RegisterToWorkMailCommandOutput) => void ): void; - public registerToWorkMail( + registerToWorkMail( args: RegisterToWorkMailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterToWorkMailCommandOutput) => void ): void; - public registerToWorkMail( - args: RegisterToWorkMailCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterToWorkMailCommandOutput) => void), - cb?: (err: any, data?: RegisterToWorkMailCommandOutput) => void - ): Promise | void { - const command = new RegisterToWorkMailCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Allows the administrator to reset the password for a user.

- */ - public resetPassword( - args: ResetPasswordCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public resetPassword( - args: ResetPasswordCommandInput, - cb: (err: any, data?: ResetPasswordCommandOutput) => void - ): void; - public resetPassword( + + /** + * @see {@link ResetPasswordCommand} + */ + resetPassword(args: ResetPasswordCommandInput, options?: __HttpHandlerOptions): Promise; + resetPassword(args: ResetPasswordCommandInput, cb: (err: any, data?: ResetPasswordCommandOutput) => void): void; + resetPassword( args: ResetPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetPasswordCommandOutput) => void ): void; - public resetPassword( - args: ResetPasswordCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ResetPasswordCommandOutput) => void), - cb?: (err: any, data?: ResetPasswordCommandOutput) => void - ): Promise | void { - const command = new ResetPasswordCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts a mailbox export job to export MIME-format email messages and calendar items - * from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) - * bucket. For more information, see Exporting mailbox content in - * the WorkMail Administrator Guide.

- */ - public startMailboxExportJob( + + /** + * @see {@link StartMailboxExportJobCommand} + */ + startMailboxExportJob( args: StartMailboxExportJobCommandInput, options?: __HttpHandlerOptions ): Promise; - public startMailboxExportJob( + startMailboxExportJob( args: StartMailboxExportJobCommandInput, cb: (err: any, data?: StartMailboxExportJobCommandOutput) => void ): void; - public startMailboxExportJob( + startMailboxExportJob( args: StartMailboxExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMailboxExportJobCommandOutput) => void ): void; - public startMailboxExportJob( - args: StartMailboxExportJobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartMailboxExportJobCommandOutput) => void), - cb?: (err: any, data?: StartMailboxExportJobCommandOutput) => void - ): Promise | void { - const command = new StartMailboxExportJobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Applies the specified tags to the specified WorkMailorganization - * resource.

- */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + + /** + * @see {@link TagResourceCommand} + */ + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked and that the resource access - * policy was configured to deny anonymous access. An anonymous invocation is one done without providing either a SourceArn or SourceAccount header.

- * - *

The request must contain either one provider definition (EwsProvider or - * LambdaProvider) or the DomainName parameter. If the - * DomainName parameter is provided, the configuration stored under the - * DomainName will be tested.

- *
- */ - public testAvailabilityConfiguration( + + /** + * @see {@link TestAvailabilityConfigurationCommand} + */ + testAvailabilityConfiguration( args: TestAvailabilityConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public testAvailabilityConfiguration( + testAvailabilityConfiguration( args: TestAvailabilityConfigurationCommandInput, cb: (err: any, data?: TestAvailabilityConfigurationCommandOutput) => void ): void; - public testAvailabilityConfiguration( + testAvailabilityConfiguration( args: TestAvailabilityConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestAvailabilityConfigurationCommandOutput) => void ): void; - public testAvailabilityConfiguration( - args: TestAvailabilityConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestAvailabilityConfigurationCommandOutput) => void), - cb?: (err: any, data?: TestAvailabilityConfigurationCommandOutput) => void - ): Promise | void { - const command = new TestAvailabilityConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Untags the specified tags from the specified WorkMail organization - * resource.

- */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + + /** + * @see {@link UntagResourceCommand} + */ + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an existing AvailabilityConfiguration for the given WorkMail - * organization and domain.

- */ - public updateAvailabilityConfiguration( + + /** + * @see {@link UpdateAvailabilityConfigurationCommand} + */ + updateAvailabilityConfiguration( args: UpdateAvailabilityConfigurationCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateAvailabilityConfiguration( + updateAvailabilityConfiguration( args: UpdateAvailabilityConfigurationCommandInput, cb: (err: any, data?: UpdateAvailabilityConfigurationCommandOutput) => void ): void; - public updateAvailabilityConfiguration( + updateAvailabilityConfiguration( args: UpdateAvailabilityConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAvailabilityConfigurationCommandOutput) => void ): void; - public updateAvailabilityConfiguration( - args: UpdateAvailabilityConfigurationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateAvailabilityConfigurationCommandOutput) => void), - cb?: (err: any, data?: UpdateAvailabilityConfigurationCommandOutput) => void - ): Promise | void { - const command = new UpdateAvailabilityConfigurationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain.

- */ - public updateDefaultMailDomain( + + /** + * @see {@link UpdateDefaultMailDomainCommand} + */ + updateDefaultMailDomain( args: UpdateDefaultMailDomainCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateDefaultMailDomain( + updateDefaultMailDomain( args: UpdateDefaultMailDomainCommandInput, cb: (err: any, data?: UpdateDefaultMailDomainCommandOutput) => void ): void; - public updateDefaultMailDomain( + updateDefaultMailDomain( args: UpdateDefaultMailDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDefaultMailDomainCommandOutput) => void ): void; - public updateDefaultMailDomain( - args: UpdateDefaultMailDomainCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateDefaultMailDomainCommandOutput) => void), - cb?: (err: any, data?: UpdateDefaultMailDomainCommandOutput) => void - ): Promise | void { - const command = new UpdateDefaultMailDomainCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates an impersonation role for the given WorkMail organization.

- */ - public updateImpersonationRole( + + /** + * @see {@link UpdateImpersonationRoleCommand} + */ + updateImpersonationRole( args: UpdateImpersonationRoleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateImpersonationRole( + updateImpersonationRole( args: UpdateImpersonationRoleCommandInput, cb: (err: any, data?: UpdateImpersonationRoleCommandOutput) => void ): void; - public updateImpersonationRole( + updateImpersonationRole( args: UpdateImpersonationRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateImpersonationRoleCommandOutput) => void ): void; - public updateImpersonationRole( - args: UpdateImpersonationRoleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateImpersonationRoleCommandOutput) => void), - cb?: (err: any, data?: UpdateImpersonationRoleCommandOutput) => void - ): Promise | void { - const command = new UpdateImpersonationRoleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a user's current mailbox quota for a specified organization and - * user.

- */ - public updateMailboxQuota( + + /** + * @see {@link UpdateMailboxQuotaCommand} + */ + updateMailboxQuota( args: UpdateMailboxQuotaCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMailboxQuota( + updateMailboxQuota( args: UpdateMailboxQuotaCommandInput, cb: (err: any, data?: UpdateMailboxQuotaCommandOutput) => void ): void; - public updateMailboxQuota( + updateMailboxQuota( args: UpdateMailboxQuotaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMailboxQuotaCommandOutput) => void ): void; - public updateMailboxQuota( - args: UpdateMailboxQuotaCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMailboxQuotaCommandOutput) => void), - cb?: (err: any, data?: UpdateMailboxQuotaCommandOutput) => void - ): Promise | void { - const command = new UpdateMailboxQuotaCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a mobile device access rule for the specified WorkMail organization.

- */ - public updateMobileDeviceAccessRule( + + /** + * @see {@link UpdateMobileDeviceAccessRuleCommand} + */ + updateMobileDeviceAccessRule( args: UpdateMobileDeviceAccessRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateMobileDeviceAccessRule( + updateMobileDeviceAccessRule( args: UpdateMobileDeviceAccessRuleCommandInput, cb: (err: any, data?: UpdateMobileDeviceAccessRuleCommandOutput) => void ): void; - public updateMobileDeviceAccessRule( + updateMobileDeviceAccessRule( args: UpdateMobileDeviceAccessRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMobileDeviceAccessRuleCommandOutput) => void ): void; - public updateMobileDeviceAccessRule( - args: UpdateMobileDeviceAccessRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateMobileDeviceAccessRuleCommandOutput) => void), - cb?: (err: any, data?: UpdateMobileDeviceAccessRuleCommandOutput) => void - ): Promise | void { - const command = new UpdateMobileDeviceAccessRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates the primary email for a user, group, or resource. The current email is moved - * into the list of aliases (or swapped between an existing alias and the current primary - * email), and the email provided in the input is promoted as the primary.

- */ - public updatePrimaryEmailAddress( + + /** + * @see {@link UpdatePrimaryEmailAddressCommand} + */ + updatePrimaryEmailAddress( args: UpdatePrimaryEmailAddressCommandInput, options?: __HttpHandlerOptions ): Promise; - public updatePrimaryEmailAddress( + updatePrimaryEmailAddress( args: UpdatePrimaryEmailAddressCommandInput, cb: (err: any, data?: UpdatePrimaryEmailAddressCommandOutput) => void ): void; - public updatePrimaryEmailAddress( + updatePrimaryEmailAddress( args: UpdatePrimaryEmailAddressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePrimaryEmailAddressCommandOutput) => void ): void; - public updatePrimaryEmailAddress( - args: UpdatePrimaryEmailAddressCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePrimaryEmailAddressCommandOutput) => void), - cb?: (err: any, data?: UpdatePrimaryEmailAddressCommandOutput) => void - ): Promise | void { - const command = new UpdatePrimaryEmailAddressCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates data for the resource. To have the latest information, it must be preceded by - * a DescribeResource call. The dataset in the request should be the one - * expected when performing another DescribeResource call.

- */ - public updateResource( + + /** + * @see {@link UpdateResourceCommand} + */ + updateResource( args: UpdateResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateResource( - args: UpdateResourceCommandInput, - cb: (err: any, data?: UpdateResourceCommandOutput) => void - ): void; - public updateResource( + updateResource(args: UpdateResourceCommandInput, cb: (err: any, data?: UpdateResourceCommandOutput) => void): void; + updateResource( args: UpdateResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResourceCommandOutput) => void ): void; - public updateResource( - args: UpdateResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResourceCommandOutput) => void), - cb?: (err: any, data?: UpdateResourceCommandOutput) => void - ): Promise | void { - const command = new UpdateResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

WorkMail is a secure, managed business email and calendaring service with support for + * existing desktop and mobile email clients. You can access your email, contacts, and + * calendars using Microsoft Outlook, your browser, or other native iOS and Android email + * applications. You can integrate WorkMail with your existing corporate directory and control + * both the keys that encrypt your data and the location in which your data is + * stored.

+ *

The WorkMail API is designed for the following scenarios:

+ *
    + *
  • + *

    Listing and describing organizations

    + *
  • + *
+ *
    + *
  • + *

    Managing users

    + *
  • + *
+ *
    + *
  • + *

    Managing groups

    + *
  • + *
+ *
    + *
  • + *

    Managing resources

    + *
  • + *
+ *

All WorkMail API operations are Amazon-authenticated and certificate-signed. They not + * only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management + * users and roles to help facilitate access, trust, and permission policies. By creating a + * role and allowing an IAM user to access the WorkMail site, the IAM user gains full + * administrative visibility into the entire WorkMail organization (or as set in the IAM + * policy). This includes, but is not limited to, the ability to create, update, and delete + * users, groups, and resources. This allows developers to perform the scenarios listed above, + * as well as give users the ability to grant access on a selective basis using the IAM + * model.

+ */ +export class WorkMail extends WorkMailClient implements WorkMail {} +createAggregatedClient(commands, WorkMail); diff --git a/clients/client-workmailmessageflow/src/WorkMailMessageFlow.ts b/clients/client-workmailmessageflow/src/WorkMailMessageFlow.ts index a4e5c5d47dda..11ce476537dd 100644 --- a/clients/client-workmailmessageflow/src/WorkMailMessageFlow.ts +++ b/clients/client-workmailmessageflow/src/WorkMailMessageFlow.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -11,93 +12,56 @@ import { PutRawMessageContentCommandInput, PutRawMessageContentCommandOutput, } from "./commands/PutRawMessageContentCommand"; -import { WorkMailMessageFlowClient } from "./WorkMailMessageFlowClient"; +import { WorkMailMessageFlowClient, WorkMailMessageFlowClientConfig } from "./WorkMailMessageFlowClient"; -/** - * @public - *

The WorkMail Message Flow API provides access to email messages as they are - * being - * sent and received by - * a - * WorkMail organization.

- */ -export class WorkMailMessageFlow extends WorkMailMessageFlowClient { +const commands = { + GetRawMessageContentCommand, + PutRawMessageContentCommand, +}; + +export interface WorkMailMessageFlow { /** - * @public - *

Retrieves the raw content of an in-transit email message, in MIME format.

+ * @see {@link GetRawMessageContentCommand} */ - public getRawMessageContent( + getRawMessageContent( args: GetRawMessageContentCommandInput, options?: __HttpHandlerOptions ): Promise; - public getRawMessageContent( + getRawMessageContent( args: GetRawMessageContentCommandInput, cb: (err: any, data?: GetRawMessageContentCommandOutput) => void ): void; - public getRawMessageContent( + getRawMessageContent( args: GetRawMessageContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRawMessageContentCommandOutput) => void ): void; - public getRawMessageContent( - args: GetRawMessageContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetRawMessageContentCommandOutput) => void), - cb?: (err: any, data?: GetRawMessageContentCommandOutput) => void - ): Promise | void { - const command = new GetRawMessageContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the raw content of an in-transit email message, in MIME format.

- *

This example describes how to update in-transit email message. For more information and examples for using this API, see - * - * Updating message content with AWS Lambda.

- * - * - * - *

Updates to an in-transit message only appear when you call PutRawMessageContent from an AWS Lambda function - * configured with a synchronous - * Run Lambda rule. If you call PutRawMessageContent on a delivered or sent message, the message remains unchanged, - * even though GetRawMessageContent returns an updated - * message. - *

- *
+ * @see {@link PutRawMessageContentCommand} */ - public putRawMessageContent( + putRawMessageContent( args: PutRawMessageContentCommandInput, options?: __HttpHandlerOptions ): Promise; - public putRawMessageContent( + putRawMessageContent( args: PutRawMessageContentCommandInput, cb: (err: any, data?: PutRawMessageContentCommandOutput) => void ): void; - public putRawMessageContent( + putRawMessageContent( args: PutRawMessageContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRawMessageContentCommandOutput) => void ): void; - public putRawMessageContent( - args: PutRawMessageContentCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutRawMessageContentCommandOutput) => void), - cb?: (err: any, data?: PutRawMessageContentCommandOutput) => void - ): Promise | void { - const command = new PutRawMessageContentCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

The WorkMail Message Flow API provides access to email messages as they are + * being + * sent and received by + * a + * WorkMail organization.

+ */ +export class WorkMailMessageFlow extends WorkMailMessageFlowClient implements WorkMailMessageFlow {} +createAggregatedClient(commands, WorkMailMessageFlow); diff --git a/clients/client-workspaces-web/src/WorkSpacesWeb.ts b/clients/client-workspaces-web/src/WorkSpacesWeb.ts index 58571f6e1f37..d99017c485dd 100644 --- a/clients/client-workspaces-web/src/WorkSpacesWeb.ts +++ b/clients/client-workspaces-web/src/WorkSpacesWeb.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -244,1683 +245,885 @@ import { UpdateUserSettingsCommandInput, UpdateUserSettingsCommandOutput, } from "./commands/UpdateUserSettingsCommand"; -import { WorkSpacesWebClient } from "./WorkSpacesWebClient"; +import { WorkSpacesWebClient, WorkSpacesWebClientConfig } from "./WorkSpacesWebClient"; -/** - * @public - *

WorkSpaces Web is a low cost, fully managed WorkSpace built specifically to facilitate - * secure, web-based workloads. WorkSpaces Web makes it easy for customers to safely provide - * their employees with access to internal websites and SaaS web applications without the - * administrative burden of appliances or specialized client software. WorkSpaces Web provides - * simple policy tools tailored for user interactions, while offloading common tasks like - * capacity management, scaling, and maintaining browser images.

- */ -export class WorkSpacesWeb extends WorkSpacesWebClient { +const commands = { + AssociateBrowserSettingsCommand, + AssociateNetworkSettingsCommand, + AssociateTrustStoreCommand, + AssociateUserAccessLoggingSettingsCommand, + AssociateUserSettingsCommand, + CreateBrowserSettingsCommand, + CreateIdentityProviderCommand, + CreateNetworkSettingsCommand, + CreatePortalCommand, + CreateTrustStoreCommand, + CreateUserAccessLoggingSettingsCommand, + CreateUserSettingsCommand, + DeleteBrowserSettingsCommand, + DeleteIdentityProviderCommand, + DeleteNetworkSettingsCommand, + DeletePortalCommand, + DeleteTrustStoreCommand, + DeleteUserAccessLoggingSettingsCommand, + DeleteUserSettingsCommand, + DisassociateBrowserSettingsCommand, + DisassociateNetworkSettingsCommand, + DisassociateTrustStoreCommand, + DisassociateUserAccessLoggingSettingsCommand, + DisassociateUserSettingsCommand, + GetBrowserSettingsCommand, + GetIdentityProviderCommand, + GetNetworkSettingsCommand, + GetPortalCommand, + GetPortalServiceProviderMetadataCommand, + GetTrustStoreCommand, + GetTrustStoreCertificateCommand, + GetUserAccessLoggingSettingsCommand, + GetUserSettingsCommand, + ListBrowserSettingsCommand, + ListIdentityProvidersCommand, + ListNetworkSettingsCommand, + ListPortalsCommand, + ListTagsForResourceCommand, + ListTrustStoreCertificatesCommand, + ListTrustStoresCommand, + ListUserAccessLoggingSettingsCommand, + ListUserSettingsCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateBrowserSettingsCommand, + UpdateIdentityProviderCommand, + UpdateNetworkSettingsCommand, + UpdatePortalCommand, + UpdateTrustStoreCommand, + UpdateUserAccessLoggingSettingsCommand, + UpdateUserSettingsCommand, +}; + +export interface WorkSpacesWeb { /** - * @public - *

Associates a browser settings resource with a web portal.

+ * @see {@link AssociateBrowserSettingsCommand} */ - public associateBrowserSettings( + associateBrowserSettings( args: AssociateBrowserSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateBrowserSettings( + associateBrowserSettings( args: AssociateBrowserSettingsCommandInput, cb: (err: any, data?: AssociateBrowserSettingsCommandOutput) => void ): void; - public associateBrowserSettings( + associateBrowserSettings( args: AssociateBrowserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateBrowserSettingsCommandOutput) => void ): void; - public associateBrowserSettings( - args: AssociateBrowserSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateBrowserSettingsCommandOutput) => void), - cb?: (err: any, data?: AssociateBrowserSettingsCommandOutput) => void - ): Promise | void { - const command = new AssociateBrowserSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a network settings resource with a web portal.

+ * @see {@link AssociateNetworkSettingsCommand} */ - public associateNetworkSettings( + associateNetworkSettings( args: AssociateNetworkSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateNetworkSettings( + associateNetworkSettings( args: AssociateNetworkSettingsCommandInput, cb: (err: any, data?: AssociateNetworkSettingsCommandOutput) => void ): void; - public associateNetworkSettings( + associateNetworkSettings( args: AssociateNetworkSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateNetworkSettingsCommandOutput) => void ): void; - public associateNetworkSettings( - args: AssociateNetworkSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateNetworkSettingsCommandOutput) => void), - cb?: (err: any, data?: AssociateNetworkSettingsCommandOutput) => void - ): Promise | void { - const command = new AssociateNetworkSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a trust store with a web portal.

+ * @see {@link AssociateTrustStoreCommand} */ - public associateTrustStore( + associateTrustStore( args: AssociateTrustStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateTrustStore( + associateTrustStore( args: AssociateTrustStoreCommandInput, cb: (err: any, data?: AssociateTrustStoreCommandOutput) => void ): void; - public associateTrustStore( + associateTrustStore( args: AssociateTrustStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateTrustStoreCommandOutput) => void ): void; - public associateTrustStore( - args: AssociateTrustStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateTrustStoreCommandOutput) => void), - cb?: (err: any, data?: AssociateTrustStoreCommandOutput) => void - ): Promise | void { - const command = new AssociateTrustStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a user access logging settings resource with a web portal.

+ * @see {@link AssociateUserAccessLoggingSettingsCommand} */ - public associateUserAccessLoggingSettings( + associateUserAccessLoggingSettings( args: AssociateUserAccessLoggingSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateUserAccessLoggingSettings( + associateUserAccessLoggingSettings( args: AssociateUserAccessLoggingSettingsCommandInput, cb: (err: any, data?: AssociateUserAccessLoggingSettingsCommandOutput) => void ): void; - public associateUserAccessLoggingSettings( + associateUserAccessLoggingSettings( args: AssociateUserAccessLoggingSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateUserAccessLoggingSettingsCommandOutput) => void ): void; - public associateUserAccessLoggingSettings( - args: AssociateUserAccessLoggingSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateUserAccessLoggingSettingsCommandOutput) => void), - cb?: (err: any, data?: AssociateUserAccessLoggingSettingsCommandOutput) => void - ): Promise | void { - const command = new AssociateUserAccessLoggingSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Associates a user settings resource with a web portal.

+ * @see {@link AssociateUserSettingsCommand} */ - public associateUserSettings( + associateUserSettings( args: AssociateUserSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateUserSettings( + associateUserSettings( args: AssociateUserSettingsCommandInput, cb: (err: any, data?: AssociateUserSettingsCommandOutput) => void ): void; - public associateUserSettings( + associateUserSettings( args: AssociateUserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateUserSettingsCommandOutput) => void ): void; - public associateUserSettings( - args: AssociateUserSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateUserSettingsCommandOutput) => void), - cb?: (err: any, data?: AssociateUserSettingsCommandOutput) => void - ): Promise | void { - const command = new AssociateUserSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a browser settings resource that can be associated with a web portal. Once - * associated with a web portal, browser settings control how the browser will behave once a - * user starts a streaming session for the web portal.

+ * @see {@link CreateBrowserSettingsCommand} */ - public createBrowserSettings( + createBrowserSettings( args: CreateBrowserSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public createBrowserSettings( + createBrowserSettings( args: CreateBrowserSettingsCommandInput, cb: (err: any, data?: CreateBrowserSettingsCommandOutput) => void ): void; - public createBrowserSettings( + createBrowserSettings( args: CreateBrowserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBrowserSettingsCommandOutput) => void ): void; - public createBrowserSettings( - args: CreateBrowserSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateBrowserSettingsCommandOutput) => void), - cb?: (err: any, data?: CreateBrowserSettingsCommandOutput) => void - ): Promise | void { - const command = new CreateBrowserSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates an identity provider resource that is then associated with a web portal.

+ * @see {@link CreateIdentityProviderCommand} */ - public createIdentityProvider( + createIdentityProvider( args: CreateIdentityProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public createIdentityProvider( + createIdentityProvider( args: CreateIdentityProviderCommandInput, cb: (err: any, data?: CreateIdentityProviderCommandOutput) => void ): void; - public createIdentityProvider( + createIdentityProvider( args: CreateIdentityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIdentityProviderCommandOutput) => void ): void; - public createIdentityProvider( - args: CreateIdentityProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIdentityProviderCommandOutput) => void), - cb?: (err: any, data?: CreateIdentityProviderCommandOutput) => void - ): Promise | void { - const command = new CreateIdentityProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a network settings resource that can be associated with a web portal. Once - * associated with a web portal, network settings define how streaming instances will connect - * with your specified VPC.

+ * @see {@link CreateNetworkSettingsCommand} */ - public createNetworkSettings( + createNetworkSettings( args: CreateNetworkSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public createNetworkSettings( + createNetworkSettings( args: CreateNetworkSettingsCommandInput, cb: (err: any, data?: CreateNetworkSettingsCommandOutput) => void ): void; - public createNetworkSettings( + createNetworkSettings( args: CreateNetworkSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNetworkSettingsCommandOutput) => void ): void; - public createNetworkSettings( - args: CreateNetworkSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateNetworkSettingsCommandOutput) => void), - cb?: (err: any, data?: CreateNetworkSettingsCommandOutput) => void - ): Promise | void { - const command = new CreateNetworkSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a web portal.

+ * @see {@link CreatePortalCommand} */ - public createPortal( - args: CreatePortalCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createPortal(args: CreatePortalCommandInput, cb: (err: any, data?: CreatePortalCommandOutput) => void): void; - public createPortal( + createPortal(args: CreatePortalCommandInput, options?: __HttpHandlerOptions): Promise; + createPortal(args: CreatePortalCommandInput, cb: (err: any, data?: CreatePortalCommandOutput) => void): void; + createPortal( args: CreatePortalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePortalCommandOutput) => void ): void; - public createPortal( - args: CreatePortalCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreatePortalCommandOutput) => void), - cb?: (err: any, data?: CreatePortalCommandOutput) => void - ): Promise | void { - const command = new CreatePortalCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a trust store that can be associated with a web portal. A trust store contains - * certificate authority (CA) certificates. Once associated with a web portal, the browser in - * a streaming session will recognize certificates that have been issued using any of the CAs - * in the trust store. If your organization has internal websites that use certificates issued - * by private CAs, you should add the private CA certificate to the trust store.

+ * @see {@link CreateTrustStoreCommand} */ - public createTrustStore( + createTrustStore( args: CreateTrustStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public createTrustStore( + createTrustStore( args: CreateTrustStoreCommandInput, cb: (err: any, data?: CreateTrustStoreCommandOutput) => void ): void; - public createTrustStore( + createTrustStore( args: CreateTrustStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTrustStoreCommandOutput) => void ): void; - public createTrustStore( - args: CreateTrustStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTrustStoreCommandOutput) => void), - cb?: (err: any, data?: CreateTrustStoreCommandOutput) => void - ): Promise | void { - const command = new CreateTrustStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a user access logging settings resource that can be associated with a web portal.

+ * @see {@link CreateUserAccessLoggingSettingsCommand} */ - public createUserAccessLoggingSettings( + createUserAccessLoggingSettings( args: CreateUserAccessLoggingSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public createUserAccessLoggingSettings( + createUserAccessLoggingSettings( args: CreateUserAccessLoggingSettingsCommandInput, cb: (err: any, data?: CreateUserAccessLoggingSettingsCommandOutput) => void ): void; - public createUserAccessLoggingSettings( + createUserAccessLoggingSettings( args: CreateUserAccessLoggingSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserAccessLoggingSettingsCommandOutput) => void ): void; - public createUserAccessLoggingSettings( - args: CreateUserAccessLoggingSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserAccessLoggingSettingsCommandOutput) => void), - cb?: (err: any, data?: CreateUserAccessLoggingSettingsCommandOutput) => void - ): Promise | void { - const command = new CreateUserAccessLoggingSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a user settings resource that can be associated with a web portal. Once - * associated with a web portal, user settings control how users can transfer data between a - * streaming session and the their local devices.

+ * @see {@link CreateUserSettingsCommand} */ - public createUserSettings( + createUserSettings( args: CreateUserSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public createUserSettings( + createUserSettings( args: CreateUserSettingsCommandInput, cb: (err: any, data?: CreateUserSettingsCommandOutput) => void ): void; - public createUserSettings( + createUserSettings( args: CreateUserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserSettingsCommandOutput) => void ): void; - public createUserSettings( - args: CreateUserSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUserSettingsCommandOutput) => void), - cb?: (err: any, data?: CreateUserSettingsCommandOutput) => void - ): Promise | void { - const command = new CreateUserSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes browser settings.

+ * @see {@link DeleteBrowserSettingsCommand} */ - public deleteBrowserSettings( + deleteBrowserSettings( args: DeleteBrowserSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteBrowserSettings( + deleteBrowserSettings( args: DeleteBrowserSettingsCommandInput, cb: (err: any, data?: DeleteBrowserSettingsCommandOutput) => void ): void; - public deleteBrowserSettings( + deleteBrowserSettings( args: DeleteBrowserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBrowserSettingsCommandOutput) => void ): void; - public deleteBrowserSettings( - args: DeleteBrowserSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteBrowserSettingsCommandOutput) => void), - cb?: (err: any, data?: DeleteBrowserSettingsCommandOutput) => void - ): Promise | void { - const command = new DeleteBrowserSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the identity provider.

+ * @see {@link DeleteIdentityProviderCommand} */ - public deleteIdentityProvider( + deleteIdentityProvider( args: DeleteIdentityProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteIdentityProvider( + deleteIdentityProvider( args: DeleteIdentityProviderCommandInput, cb: (err: any, data?: DeleteIdentityProviderCommandOutput) => void ): void; - public deleteIdentityProvider( + deleteIdentityProvider( args: DeleteIdentityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIdentityProviderCommandOutput) => void ): void; - public deleteIdentityProvider( - args: DeleteIdentityProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIdentityProviderCommandOutput) => void), - cb?: (err: any, data?: DeleteIdentityProviderCommandOutput) => void - ): Promise | void { - const command = new DeleteIdentityProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes network settings.

+ * @see {@link DeleteNetworkSettingsCommand} */ - public deleteNetworkSettings( + deleteNetworkSettings( args: DeleteNetworkSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteNetworkSettings( + deleteNetworkSettings( args: DeleteNetworkSettingsCommandInput, cb: (err: any, data?: DeleteNetworkSettingsCommandOutput) => void ): void; - public deleteNetworkSettings( + deleteNetworkSettings( args: DeleteNetworkSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNetworkSettingsCommandOutput) => void ): void; - public deleteNetworkSettings( - args: DeleteNetworkSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteNetworkSettingsCommandOutput) => void), - cb?: (err: any, data?: DeleteNetworkSettingsCommandOutput) => void - ): Promise | void { - const command = new DeleteNetworkSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a web portal.

+ * @see {@link DeletePortalCommand} */ - public deletePortal( - args: DeletePortalCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deletePortal(args: DeletePortalCommandInput, cb: (err: any, data?: DeletePortalCommandOutput) => void): void; - public deletePortal( + deletePortal(args: DeletePortalCommandInput, options?: __HttpHandlerOptions): Promise; + deletePortal(args: DeletePortalCommandInput, cb: (err: any, data?: DeletePortalCommandOutput) => void): void; + deletePortal( args: DeletePortalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePortalCommandOutput) => void ): void; - public deletePortal( - args: DeletePortalCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeletePortalCommandOutput) => void), - cb?: (err: any, data?: DeletePortalCommandOutput) => void - ): Promise | void { - const command = new DeletePortalCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes the trust store.

+ * @see {@link DeleteTrustStoreCommand} */ - public deleteTrustStore( + deleteTrustStore( args: DeleteTrustStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteTrustStore( + deleteTrustStore( args: DeleteTrustStoreCommandInput, cb: (err: any, data?: DeleteTrustStoreCommandOutput) => void ): void; - public deleteTrustStore( + deleteTrustStore( args: DeleteTrustStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTrustStoreCommandOutput) => void ): void; - public deleteTrustStore( - args: DeleteTrustStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTrustStoreCommandOutput) => void), - cb?: (err: any, data?: DeleteTrustStoreCommandOutput) => void - ): Promise | void { - const command = new DeleteTrustStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes user access logging settings.

+ * @see {@link DeleteUserAccessLoggingSettingsCommand} */ - public deleteUserAccessLoggingSettings( + deleteUserAccessLoggingSettings( args: DeleteUserAccessLoggingSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteUserAccessLoggingSettings( + deleteUserAccessLoggingSettings( args: DeleteUserAccessLoggingSettingsCommandInput, cb: (err: any, data?: DeleteUserAccessLoggingSettingsCommandOutput) => void ): void; - public deleteUserAccessLoggingSettings( + deleteUserAccessLoggingSettings( args: DeleteUserAccessLoggingSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserAccessLoggingSettingsCommandOutput) => void ): void; - public deleteUserAccessLoggingSettings( - args: DeleteUserAccessLoggingSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserAccessLoggingSettingsCommandOutput) => void), - cb?: (err: any, data?: DeleteUserAccessLoggingSettingsCommandOutput) => void - ): Promise | void { - const command = new DeleteUserAccessLoggingSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes user settings.

+ * @see {@link DeleteUserSettingsCommand} */ - public deleteUserSettings( + deleteUserSettings( args: DeleteUserSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteUserSettings( + deleteUserSettings( args: DeleteUserSettingsCommandInput, cb: (err: any, data?: DeleteUserSettingsCommandOutput) => void ): void; - public deleteUserSettings( + deleteUserSettings( args: DeleteUserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserSettingsCommandOutput) => void ): void; - public deleteUserSettings( - args: DeleteUserSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteUserSettingsCommandOutput) => void), - cb?: (err: any, data?: DeleteUserSettingsCommandOutput) => void - ): Promise | void { - const command = new DeleteUserSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates browser settings from a web portal.

+ * @see {@link DisassociateBrowserSettingsCommand} */ - public disassociateBrowserSettings( + disassociateBrowserSettings( args: DisassociateBrowserSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateBrowserSettings( + disassociateBrowserSettings( args: DisassociateBrowserSettingsCommandInput, cb: (err: any, data?: DisassociateBrowserSettingsCommandOutput) => void ): void; - public disassociateBrowserSettings( + disassociateBrowserSettings( args: DisassociateBrowserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateBrowserSettingsCommandOutput) => void ): void; - public disassociateBrowserSettings( - args: DisassociateBrowserSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateBrowserSettingsCommandOutput) => void), - cb?: (err: any, data?: DisassociateBrowserSettingsCommandOutput) => void - ): Promise | void { - const command = new DisassociateBrowserSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates network settings from a web portal.

+ * @see {@link DisassociateNetworkSettingsCommand} */ - public disassociateNetworkSettings( + disassociateNetworkSettings( args: DisassociateNetworkSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateNetworkSettings( + disassociateNetworkSettings( args: DisassociateNetworkSettingsCommandInput, cb: (err: any, data?: DisassociateNetworkSettingsCommandOutput) => void ): void; - public disassociateNetworkSettings( + disassociateNetworkSettings( args: DisassociateNetworkSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateNetworkSettingsCommandOutput) => void ): void; - public disassociateNetworkSettings( - args: DisassociateNetworkSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateNetworkSettingsCommandOutput) => void), - cb?: (err: any, data?: DisassociateNetworkSettingsCommandOutput) => void - ): Promise | void { - const command = new DisassociateNetworkSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates a trust store from a web portal.

+ * @see {@link DisassociateTrustStoreCommand} */ - public disassociateTrustStore( + disassociateTrustStore( args: DisassociateTrustStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateTrustStore( + disassociateTrustStore( args: DisassociateTrustStoreCommandInput, cb: (err: any, data?: DisassociateTrustStoreCommandOutput) => void ): void; - public disassociateTrustStore( + disassociateTrustStore( args: DisassociateTrustStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateTrustStoreCommandOutput) => void ): void; - public disassociateTrustStore( - args: DisassociateTrustStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateTrustStoreCommandOutput) => void), - cb?: (err: any, data?: DisassociateTrustStoreCommandOutput) => void - ): Promise | void { - const command = new DisassociateTrustStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates user access logging settings from a web portal.

+ * @see {@link DisassociateUserAccessLoggingSettingsCommand} */ - public disassociateUserAccessLoggingSettings( + disassociateUserAccessLoggingSettings( args: DisassociateUserAccessLoggingSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateUserAccessLoggingSettings( + disassociateUserAccessLoggingSettings( args: DisassociateUserAccessLoggingSettingsCommandInput, cb: (err: any, data?: DisassociateUserAccessLoggingSettingsCommandOutput) => void ): void; - public disassociateUserAccessLoggingSettings( + disassociateUserAccessLoggingSettings( args: DisassociateUserAccessLoggingSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateUserAccessLoggingSettingsCommandOutput) => void ): void; - public disassociateUserAccessLoggingSettings( - args: DisassociateUserAccessLoggingSettingsCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: DisassociateUserAccessLoggingSettingsCommandOutput) => void), - cb?: (err: any, data?: DisassociateUserAccessLoggingSettingsCommandOutput) => void - ): Promise | void { - const command = new DisassociateUserAccessLoggingSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Disassociates user settings from a web portal.

+ * @see {@link DisassociateUserSettingsCommand} */ - public disassociateUserSettings( + disassociateUserSettings( args: DisassociateUserSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateUserSettings( + disassociateUserSettings( args: DisassociateUserSettingsCommandInput, cb: (err: any, data?: DisassociateUserSettingsCommandOutput) => void ): void; - public disassociateUserSettings( + disassociateUserSettings( args: DisassociateUserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateUserSettingsCommandOutput) => void ): void; - public disassociateUserSettings( - args: DisassociateUserSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateUserSettingsCommandOutput) => void), - cb?: (err: any, data?: DisassociateUserSettingsCommandOutput) => void - ): Promise | void { - const command = new DisassociateUserSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets browser settings.

+ * @see {@link GetBrowserSettingsCommand} */ - public getBrowserSettings( + getBrowserSettings( args: GetBrowserSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getBrowserSettings( + getBrowserSettings( args: GetBrowserSettingsCommandInput, cb: (err: any, data?: GetBrowserSettingsCommandOutput) => void ): void; - public getBrowserSettings( + getBrowserSettings( args: GetBrowserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBrowserSettingsCommandOutput) => void ): void; - public getBrowserSettings( - args: GetBrowserSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetBrowserSettingsCommandOutput) => void), - cb?: (err: any, data?: GetBrowserSettingsCommandOutput) => void - ): Promise | void { - const command = new GetBrowserSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the identity provider.

+ * @see {@link GetIdentityProviderCommand} */ - public getIdentityProvider( + getIdentityProvider( args: GetIdentityProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public getIdentityProvider( + getIdentityProvider( args: GetIdentityProviderCommandInput, cb: (err: any, data?: GetIdentityProviderCommandOutput) => void ): void; - public getIdentityProvider( + getIdentityProvider( args: GetIdentityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIdentityProviderCommandOutput) => void ): void; - public getIdentityProvider( - args: GetIdentityProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetIdentityProviderCommandOutput) => void), - cb?: (err: any, data?: GetIdentityProviderCommandOutput) => void - ): Promise | void { - const command = new GetIdentityProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the network settings.

+ * @see {@link GetNetworkSettingsCommand} */ - public getNetworkSettings( + getNetworkSettings( args: GetNetworkSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getNetworkSettings( + getNetworkSettings( args: GetNetworkSettingsCommandInput, cb: (err: any, data?: GetNetworkSettingsCommandOutput) => void ): void; - public getNetworkSettings( + getNetworkSettings( args: GetNetworkSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNetworkSettingsCommandOutput) => void ): void; - public getNetworkSettings( - args: GetNetworkSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetNetworkSettingsCommandOutput) => void), - cb?: (err: any, data?: GetNetworkSettingsCommandOutput) => void - ): Promise | void { - const command = new GetNetworkSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the web portal.

+ * @see {@link GetPortalCommand} */ - public getPortal(args: GetPortalCommandInput, options?: __HttpHandlerOptions): Promise; - public getPortal(args: GetPortalCommandInput, cb: (err: any, data?: GetPortalCommandOutput) => void): void; - public getPortal( + getPortal(args: GetPortalCommandInput, options?: __HttpHandlerOptions): Promise; + getPortal(args: GetPortalCommandInput, cb: (err: any, data?: GetPortalCommandOutput) => void): void; + getPortal( args: GetPortalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPortalCommandOutput) => void ): void; - public getPortal( - args: GetPortalCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPortalCommandOutput) => void), - cb?: (err: any, data?: GetPortalCommandOutput) => void - ): Promise | void { - const command = new GetPortalCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the service provider metadata.

+ * @see {@link GetPortalServiceProviderMetadataCommand} */ - public getPortalServiceProviderMetadata( + getPortalServiceProviderMetadata( args: GetPortalServiceProviderMetadataCommandInput, options?: __HttpHandlerOptions ): Promise; - public getPortalServiceProviderMetadata( + getPortalServiceProviderMetadata( args: GetPortalServiceProviderMetadataCommandInput, cb: (err: any, data?: GetPortalServiceProviderMetadataCommandOutput) => void ): void; - public getPortalServiceProviderMetadata( + getPortalServiceProviderMetadata( args: GetPortalServiceProviderMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPortalServiceProviderMetadataCommandOutput) => void ): void; - public getPortalServiceProviderMetadata( - args: GetPortalServiceProviderMetadataCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPortalServiceProviderMetadataCommandOutput) => void), - cb?: (err: any, data?: GetPortalServiceProviderMetadataCommandOutput) => void - ): Promise | void { - const command = new GetPortalServiceProviderMetadataCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the trust store.

+ * @see {@link GetTrustStoreCommand} */ - public getTrustStore( - args: GetTrustStoreCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getTrustStore( - args: GetTrustStoreCommandInput, - cb: (err: any, data?: GetTrustStoreCommandOutput) => void - ): void; - public getTrustStore( + getTrustStore(args: GetTrustStoreCommandInput, options?: __HttpHandlerOptions): Promise; + getTrustStore(args: GetTrustStoreCommandInput, cb: (err: any, data?: GetTrustStoreCommandOutput) => void): void; + getTrustStore( args: GetTrustStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTrustStoreCommandOutput) => void ): void; - public getTrustStore( - args: GetTrustStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTrustStoreCommandOutput) => void), - cb?: (err: any, data?: GetTrustStoreCommandOutput) => void - ): Promise | void { - const command = new GetTrustStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets the trust store certificate.

+ * @see {@link GetTrustStoreCertificateCommand} */ - public getTrustStoreCertificate( + getTrustStoreCertificate( args: GetTrustStoreCertificateCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTrustStoreCertificate( + getTrustStoreCertificate( args: GetTrustStoreCertificateCommandInput, cb: (err: any, data?: GetTrustStoreCertificateCommandOutput) => void ): void; - public getTrustStoreCertificate( + getTrustStoreCertificate( args: GetTrustStoreCertificateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTrustStoreCertificateCommandOutput) => void ): void; - public getTrustStoreCertificate( - args: GetTrustStoreCertificateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTrustStoreCertificateCommandOutput) => void), - cb?: (err: any, data?: GetTrustStoreCertificateCommandOutput) => void - ): Promise | void { - const command = new GetTrustStoreCertificateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets user access logging settings.

+ * @see {@link GetUserAccessLoggingSettingsCommand} */ - public getUserAccessLoggingSettings( + getUserAccessLoggingSettings( args: GetUserAccessLoggingSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUserAccessLoggingSettings( + getUserAccessLoggingSettings( args: GetUserAccessLoggingSettingsCommandInput, cb: (err: any, data?: GetUserAccessLoggingSettingsCommandOutput) => void ): void; - public getUserAccessLoggingSettings( + getUserAccessLoggingSettings( args: GetUserAccessLoggingSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserAccessLoggingSettingsCommandOutput) => void ): void; - public getUserAccessLoggingSettings( - args: GetUserAccessLoggingSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUserAccessLoggingSettingsCommandOutput) => void), - cb?: (err: any, data?: GetUserAccessLoggingSettingsCommandOutput) => void - ): Promise | void { - const command = new GetUserAccessLoggingSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Gets user settings.

+ * @see {@link GetUserSettingsCommand} */ - public getUserSettings( + getUserSettings( args: GetUserSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getUserSettings( - args: GetUserSettingsCommandInput, - cb: (err: any, data?: GetUserSettingsCommandOutput) => void - ): void; - public getUserSettings( + getUserSettings(args: GetUserSettingsCommandInput, cb: (err: any, data?: GetUserSettingsCommandOutput) => void): void; + getUserSettings( args: GetUserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserSettingsCommandOutput) => void ): void; - public getUserSettings( - args: GetUserSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetUserSettingsCommandOutput) => void), - cb?: (err: any, data?: GetUserSettingsCommandOutput) => void - ): Promise | void { - const command = new GetUserSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of browser settings.

+ * @see {@link ListBrowserSettingsCommand} */ - public listBrowserSettings( + listBrowserSettings( args: ListBrowserSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listBrowserSettings( + listBrowserSettings( args: ListBrowserSettingsCommandInput, cb: (err: any, data?: ListBrowserSettingsCommandOutput) => void ): void; - public listBrowserSettings( + listBrowserSettings( args: ListBrowserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBrowserSettingsCommandOutput) => void ): void; - public listBrowserSettings( - args: ListBrowserSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListBrowserSettingsCommandOutput) => void), - cb?: (err: any, data?: ListBrowserSettingsCommandOutput) => void - ): Promise | void { - const command = new ListBrowserSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of identity providers for a specific web portal.

+ * @see {@link ListIdentityProvidersCommand} */ - public listIdentityProviders( + listIdentityProviders( args: ListIdentityProvidersCommandInput, options?: __HttpHandlerOptions ): Promise; - public listIdentityProviders( + listIdentityProviders( args: ListIdentityProvidersCommandInput, cb: (err: any, data?: ListIdentityProvidersCommandOutput) => void ): void; - public listIdentityProviders( + listIdentityProviders( args: ListIdentityProvidersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIdentityProvidersCommandOutput) => void ): void; - public listIdentityProviders( - args: ListIdentityProvidersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListIdentityProvidersCommandOutput) => void), - cb?: (err: any, data?: ListIdentityProvidersCommandOutput) => void - ): Promise | void { - const command = new ListIdentityProvidersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of network settings.

+ * @see {@link ListNetworkSettingsCommand} */ - public listNetworkSettings( + listNetworkSettings( args: ListNetworkSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listNetworkSettings( + listNetworkSettings( args: ListNetworkSettingsCommandInput, cb: (err: any, data?: ListNetworkSettingsCommandOutput) => void ): void; - public listNetworkSettings( + listNetworkSettings( args: ListNetworkSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNetworkSettingsCommandOutput) => void ): void; - public listNetworkSettings( - args: ListNetworkSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListNetworkSettingsCommandOutput) => void), - cb?: (err: any, data?: ListNetworkSettingsCommandOutput) => void - ): Promise | void { - const command = new ListNetworkSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list or web portals.

+ * @see {@link ListPortalsCommand} */ - public listPortals(args: ListPortalsCommandInput, options?: __HttpHandlerOptions): Promise; - public listPortals(args: ListPortalsCommandInput, cb: (err: any, data?: ListPortalsCommandOutput) => void): void; - public listPortals( + listPortals(args: ListPortalsCommandInput, options?: __HttpHandlerOptions): Promise; + listPortals(args: ListPortalsCommandInput, cb: (err: any, data?: ListPortalsCommandOutput) => void): void; + listPortals( args: ListPortalsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPortalsCommandOutput) => void ): void; - public listPortals( - args: ListPortalsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPortalsCommandOutput) => void), - cb?: (err: any, data?: ListPortalsCommandOutput) => void - ): Promise | void { - const command = new ListPortalsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of tags for a resource.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of trust store certificates.

+ * @see {@link ListTrustStoreCertificatesCommand} */ - public listTrustStoreCertificates( + listTrustStoreCertificates( args: ListTrustStoreCertificatesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTrustStoreCertificates( + listTrustStoreCertificates( args: ListTrustStoreCertificatesCommandInput, cb: (err: any, data?: ListTrustStoreCertificatesCommandOutput) => void ): void; - public listTrustStoreCertificates( + listTrustStoreCertificates( args: ListTrustStoreCertificatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTrustStoreCertificatesCommandOutput) => void ): void; - public listTrustStoreCertificates( - args: ListTrustStoreCertificatesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTrustStoreCertificatesCommandOutput) => void), - cb?: (err: any, data?: ListTrustStoreCertificatesCommandOutput) => void - ): Promise | void { - const command = new ListTrustStoreCertificatesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of trust stores.

+ * @see {@link ListTrustStoresCommand} */ - public listTrustStores( + listTrustStores( args: ListTrustStoresCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTrustStores( - args: ListTrustStoresCommandInput, - cb: (err: any, data?: ListTrustStoresCommandOutput) => void - ): void; - public listTrustStores( + listTrustStores(args: ListTrustStoresCommandInput, cb: (err: any, data?: ListTrustStoresCommandOutput) => void): void; + listTrustStores( args: ListTrustStoresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTrustStoresCommandOutput) => void ): void; - public listTrustStores( - args: ListTrustStoresCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTrustStoresCommandOutput) => void), - cb?: (err: any, data?: ListTrustStoresCommandOutput) => void - ): Promise | void { - const command = new ListTrustStoresCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of user access logging settings.

+ * @see {@link ListUserAccessLoggingSettingsCommand} */ - public listUserAccessLoggingSettings( + listUserAccessLoggingSettings( args: ListUserAccessLoggingSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listUserAccessLoggingSettings( + listUserAccessLoggingSettings( args: ListUserAccessLoggingSettingsCommandInput, cb: (err: any, data?: ListUserAccessLoggingSettingsCommandOutput) => void ): void; - public listUserAccessLoggingSettings( + listUserAccessLoggingSettings( args: ListUserAccessLoggingSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUserAccessLoggingSettingsCommandOutput) => void ): void; - public listUserAccessLoggingSettings( - args: ListUserAccessLoggingSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUserAccessLoggingSettingsCommandOutput) => void), - cb?: (err: any, data?: ListUserAccessLoggingSettingsCommandOutput) => void - ): Promise | void { - const command = new ListUserAccessLoggingSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a list of user settings.

+ * @see {@link ListUserSettingsCommand} */ - public listUserSettings( + listUserSettings( args: ListUserSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public listUserSettings( + listUserSettings( args: ListUserSettingsCommandInput, cb: (err: any, data?: ListUserSettingsCommandOutput) => void ): void; - public listUserSettings( + listUserSettings( args: ListUserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUserSettingsCommandOutput) => void ): void; - public listUserSettings( - args: ListUserSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUserSettingsCommandOutput) => void), - cb?: (err: any, data?: ListUserSettingsCommandOutput) => void - ): Promise | void { - const command = new ListUserSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Adds or overwrites one or more tags for the specified resource.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes one or more tags from the specified resource.

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates browser settings.

+ * @see {@link UpdateBrowserSettingsCommand} */ - public updateBrowserSettings( + updateBrowserSettings( args: UpdateBrowserSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateBrowserSettings( + updateBrowserSettings( args: UpdateBrowserSettingsCommandInput, cb: (err: any, data?: UpdateBrowserSettingsCommandOutput) => void ): void; - public updateBrowserSettings( + updateBrowserSettings( args: UpdateBrowserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBrowserSettingsCommandOutput) => void ): void; - public updateBrowserSettings( - args: UpdateBrowserSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateBrowserSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateBrowserSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateBrowserSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the identity provider.

+ * @see {@link UpdateIdentityProviderCommand} */ - public updateIdentityProvider( + updateIdentityProvider( args: UpdateIdentityProviderCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateIdentityProvider( + updateIdentityProvider( args: UpdateIdentityProviderCommandInput, cb: (err: any, data?: UpdateIdentityProviderCommandOutput) => void ): void; - public updateIdentityProvider( + updateIdentityProvider( args: UpdateIdentityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIdentityProviderCommandOutput) => void ): void; - public updateIdentityProvider( - args: UpdateIdentityProviderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateIdentityProviderCommandOutput) => void), - cb?: (err: any, data?: UpdateIdentityProviderCommandOutput) => void - ): Promise | void { - const command = new UpdateIdentityProviderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates network settings.

+ * @see {@link UpdateNetworkSettingsCommand} */ - public updateNetworkSettings( + updateNetworkSettings( args: UpdateNetworkSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateNetworkSettings( + updateNetworkSettings( args: UpdateNetworkSettingsCommandInput, cb: (err: any, data?: UpdateNetworkSettingsCommandOutput) => void ): void; - public updateNetworkSettings( + updateNetworkSettings( args: UpdateNetworkSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNetworkSettingsCommandOutput) => void ): void; - public updateNetworkSettings( - args: UpdateNetworkSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateNetworkSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateNetworkSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateNetworkSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a web portal.

+ * @see {@link UpdatePortalCommand} */ - public updatePortal( - args: UpdatePortalCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public updatePortal(args: UpdatePortalCommandInput, cb: (err: any, data?: UpdatePortalCommandOutput) => void): void; - public updatePortal( + updatePortal(args: UpdatePortalCommandInput, options?: __HttpHandlerOptions): Promise; + updatePortal(args: UpdatePortalCommandInput, cb: (err: any, data?: UpdatePortalCommandOutput) => void): void; + updatePortal( args: UpdatePortalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePortalCommandOutput) => void ): void; - public updatePortal( - args: UpdatePortalCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdatePortalCommandOutput) => void), - cb?: (err: any, data?: UpdatePortalCommandOutput) => void - ): Promise | void { - const command = new UpdatePortalCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the trust store.

+ * @see {@link UpdateTrustStoreCommand} */ - public updateTrustStore( + updateTrustStore( args: UpdateTrustStoreCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateTrustStore( + updateTrustStore( args: UpdateTrustStoreCommandInput, cb: (err: any, data?: UpdateTrustStoreCommandOutput) => void ): void; - public updateTrustStore( + updateTrustStore( args: UpdateTrustStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTrustStoreCommandOutput) => void ): void; - public updateTrustStore( - args: UpdateTrustStoreCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateTrustStoreCommandOutput) => void), - cb?: (err: any, data?: UpdateTrustStoreCommandOutput) => void - ): Promise | void { - const command = new UpdateTrustStoreCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the user access logging settings.

+ * @see {@link UpdateUserAccessLoggingSettingsCommand} */ - public updateUserAccessLoggingSettings( + updateUserAccessLoggingSettings( args: UpdateUserAccessLoggingSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateUserAccessLoggingSettings( + updateUserAccessLoggingSettings( args: UpdateUserAccessLoggingSettingsCommandInput, cb: (err: any, data?: UpdateUserAccessLoggingSettingsCommandOutput) => void ): void; - public updateUserAccessLoggingSettings( + updateUserAccessLoggingSettings( args: UpdateUserAccessLoggingSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserAccessLoggingSettingsCommandOutput) => void ): void; - public updateUserAccessLoggingSettings( - args: UpdateUserAccessLoggingSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserAccessLoggingSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateUserAccessLoggingSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateUserAccessLoggingSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the user settings.

+ * @see {@link UpdateUserSettingsCommand} */ - public updateUserSettings( + updateUserSettings( args: UpdateUserSettingsCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateUserSettings( + updateUserSettings( args: UpdateUserSettingsCommandInput, cb: (err: any, data?: UpdateUserSettingsCommandOutput) => void ): void; - public updateUserSettings( + updateUserSettings( args: UpdateUserSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserSettingsCommandOutput) => void ): void; - public updateUserSettings( - args: UpdateUserSettingsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateUserSettingsCommandOutput) => void), - cb?: (err: any, data?: UpdateUserSettingsCommandOutput) => void - ): Promise | void { - const command = new UpdateUserSettingsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

WorkSpaces Web is a low cost, fully managed WorkSpace built specifically to facilitate + * secure, web-based workloads. WorkSpaces Web makes it easy for customers to safely provide + * their employees with access to internal websites and SaaS web applications without the + * administrative burden of appliances or specialized client software. WorkSpaces Web provides + * simple policy tools tailored for user interactions, while offloading common tasks like + * capacity management, scaling, and maintaining browser images.

+ */ +export class WorkSpacesWeb extends WorkSpacesWebClient implements WorkSpacesWeb {} +createAggregatedClient(commands, WorkSpacesWeb); diff --git a/clients/client-workspaces/src/WorkSpaces.ts b/clients/client-workspaces/src/WorkSpaces.ts index 71ea421a927a..e23eba8abd96 100644 --- a/clients/client-workspaces/src/WorkSpaces.ts +++ b/clients/client-workspaces/src/WorkSpaces.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -318,2452 +319,1151 @@ import { UpdateWorkspaceImagePermissionCommandInput, UpdateWorkspaceImagePermissionCommandOutput, } from "./commands/UpdateWorkspaceImagePermissionCommand"; -import { WorkSpacesClient } from "./WorkSpacesClient"; +import { WorkSpacesClient, WorkSpacesClientConfig } from "./WorkSpacesClient"; -/** - * @public - * Amazon WorkSpaces Service - *

Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows - * or Amazon Linux desktops for your users, known as WorkSpaces. - * WorkSpaces eliminates the need to procure and deploy hardware or install complex - * software. You can quickly add or remove users as your needs change. Users can access their - * virtual desktops from multiple devices or web browsers.

- *

This API Reference provides detailed information about the actions, data types, - * parameters, and errors of the WorkSpaces service. For more information about the - * supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas in the Amazon Web Services - * General Reference.

- *

You can also manage your WorkSpaces resources using the WorkSpaces - * console, Command Line Interface (CLI), and SDKs. For more information about - * administering WorkSpaces, see the Amazon WorkSpaces Administration Guide. - * For more information about using the Amazon WorkSpaces client application or web - * browser to access provisioned WorkSpaces, see the Amazon WorkSpaces User Guide. For more - * information about using the CLI to manage your WorkSpaces resources, - * see the WorkSpaces section of the CLI Reference.

- */ -export class WorkSpaces extends WorkSpacesClient { - /** - * @public - *

Associates the specified connection alias with the specified directory to enable - * cross-Region redirection. For more information, see Cross-Region - * Redirection for Amazon WorkSpaces.

- * - *

Before performing this operation, call - * DescribeConnectionAliases to make sure that the current state of the - * connection alias is CREATED.

- *
- */ - public associateConnectionAlias( +const commands = { + AssociateConnectionAliasCommand, + AssociateIpGroupsCommand, + AuthorizeIpRulesCommand, + CopyWorkspaceImageCommand, + CreateConnectClientAddInCommand, + CreateConnectionAliasCommand, + CreateIpGroupCommand, + CreateStandbyWorkspacesCommand, + CreateTagsCommand, + CreateUpdatedWorkspaceImageCommand, + CreateWorkspaceBundleCommand, + CreateWorkspaceImageCommand, + CreateWorkspacesCommand, + DeleteClientBrandingCommand, + DeleteConnectClientAddInCommand, + DeleteConnectionAliasCommand, + DeleteIpGroupCommand, + DeleteTagsCommand, + DeleteWorkspaceBundleCommand, + DeleteWorkspaceImageCommand, + DeregisterWorkspaceDirectoryCommand, + DescribeAccountCommand, + DescribeAccountModificationsCommand, + DescribeClientBrandingCommand, + DescribeClientPropertiesCommand, + DescribeConnectClientAddInsCommand, + DescribeConnectionAliasesCommand, + DescribeConnectionAliasPermissionsCommand, + DescribeIpGroupsCommand, + DescribeTagsCommand, + DescribeWorkspaceBundlesCommand, + DescribeWorkspaceDirectoriesCommand, + DescribeWorkspaceImagePermissionsCommand, + DescribeWorkspaceImagesCommand, + DescribeWorkspacesCommand, + DescribeWorkspacesConnectionStatusCommand, + DescribeWorkspaceSnapshotsCommand, + DisassociateConnectionAliasCommand, + DisassociateIpGroupsCommand, + ImportClientBrandingCommand, + ImportWorkspaceImageCommand, + ListAvailableManagementCidrRangesCommand, + MigrateWorkspaceCommand, + ModifyAccountCommand, + ModifyCertificateBasedAuthPropertiesCommand, + ModifyClientPropertiesCommand, + ModifySamlPropertiesCommand, + ModifySelfservicePermissionsCommand, + ModifyWorkspaceAccessPropertiesCommand, + ModifyWorkspaceCreationPropertiesCommand, + ModifyWorkspacePropertiesCommand, + ModifyWorkspaceStateCommand, + RebootWorkspacesCommand, + RebuildWorkspacesCommand, + RegisterWorkspaceDirectoryCommand, + RestoreWorkspaceCommand, + RevokeIpRulesCommand, + StartWorkspacesCommand, + StopWorkspacesCommand, + TerminateWorkspacesCommand, + UpdateConnectClientAddInCommand, + UpdateConnectionAliasPermissionCommand, + UpdateRulesOfIpGroupCommand, + UpdateWorkspaceBundleCommand, + UpdateWorkspaceImagePermissionCommand, +}; + +export interface WorkSpaces { + /** + * @see {@link AssociateConnectionAliasCommand} + */ + associateConnectionAlias( args: AssociateConnectionAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateConnectionAlias( + associateConnectionAlias( args: AssociateConnectionAliasCommandInput, cb: (err: any, data?: AssociateConnectionAliasCommandOutput) => void ): void; - public associateConnectionAlias( + associateConnectionAlias( args: AssociateConnectionAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateConnectionAliasCommandOutput) => void ): void; - public associateConnectionAlias( - args: AssociateConnectionAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateConnectionAliasCommandOutput) => void), - cb?: (err: any, data?: AssociateConnectionAliasCommandOutput) => void - ): Promise | void { - const command = new AssociateConnectionAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Associates the specified IP access control group with the specified directory.

- */ - public associateIpGroups( + + /** + * @see {@link AssociateIpGroupsCommand} + */ + associateIpGroups( args: AssociateIpGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public associateIpGroups( + associateIpGroups( args: AssociateIpGroupsCommandInput, cb: (err: any, data?: AssociateIpGroupsCommandOutput) => void ): void; - public associateIpGroups( + associateIpGroups( args: AssociateIpGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateIpGroupsCommandOutput) => void ): void; - public associateIpGroups( - args: AssociateIpGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateIpGroupsCommandOutput) => void), - cb?: (err: any, data?: AssociateIpGroupsCommandOutput) => void - ): Promise | void { - const command = new AssociateIpGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Adds one or more rules to the specified IP access control group.

- *

This action gives users permission to access their WorkSpaces from the CIDR address - * ranges specified in the rules.

- */ - public authorizeIpRules( + + /** + * @see {@link AuthorizeIpRulesCommand} + */ + authorizeIpRules( args: AuthorizeIpRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public authorizeIpRules( + authorizeIpRules( args: AuthorizeIpRulesCommandInput, cb: (err: any, data?: AuthorizeIpRulesCommandOutput) => void ): void; - public authorizeIpRules( + authorizeIpRules( args: AuthorizeIpRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AuthorizeIpRulesCommandOutput) => void ): void; - public authorizeIpRules( - args: AuthorizeIpRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AuthorizeIpRulesCommandOutput) => void), - cb?: (err: any, data?: AuthorizeIpRulesCommandOutput) => void - ): Promise | void { - const command = new AuthorizeIpRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Copies the specified image from the specified Region to the current Region. For more - * information about copying images, see Copy a Custom WorkSpaces - * Image.

- *

In the China (Ningxia) Region, you can copy images only within the same Region.

- *

In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.

- * - *

Before copying a shared image, be sure to verify that it has been shared from the - * correct Amazon Web Services account. To determine if an image has been shared and to see - * the ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.

- *
- */ - public copyWorkspaceImage( + + /** + * @see {@link CopyWorkspaceImageCommand} + */ + copyWorkspaceImage( args: CopyWorkspaceImageCommandInput, options?: __HttpHandlerOptions ): Promise; - public copyWorkspaceImage( + copyWorkspaceImage( args: CopyWorkspaceImageCommandInput, cb: (err: any, data?: CopyWorkspaceImageCommandOutput) => void ): void; - public copyWorkspaceImage( + copyWorkspaceImage( args: CopyWorkspaceImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyWorkspaceImageCommandOutput) => void ): void; - public copyWorkspaceImage( - args: CopyWorkspaceImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CopyWorkspaceImageCommandOutput) => void), - cb?: (err: any, data?: CopyWorkspaceImageCommandOutput) => void - ): Promise | void { - const command = new CopyWorkspaceImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a client-add-in for Amazon Connect within a directory. You can create only - * one Amazon Connect client add-in within a directory.

- *

This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.

- */ - public createConnectClientAddIn( + + /** + * @see {@link CreateConnectClientAddInCommand} + */ + createConnectClientAddIn( args: CreateConnectClientAddInCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConnectClientAddIn( + createConnectClientAddIn( args: CreateConnectClientAddInCommandInput, cb: (err: any, data?: CreateConnectClientAddInCommandOutput) => void ): void; - public createConnectClientAddIn( + createConnectClientAddIn( args: CreateConnectClientAddInCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectClientAddInCommandOutput) => void ): void; - public createConnectClientAddIn( - args: CreateConnectClientAddInCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConnectClientAddInCommandOutput) => void), - cb?: (err: any, data?: CreateConnectClientAddInCommandOutput) => void - ): Promise | void { - const command = new CreateConnectClientAddInCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates the specified connection alias for use with cross-Region redirection. For more - * information, see Cross-Region - * Redirection for Amazon WorkSpaces.

- */ - public createConnectionAlias( + + /** + * @see {@link CreateConnectionAliasCommand} + */ + createConnectionAlias( args: CreateConnectionAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public createConnectionAlias( + createConnectionAlias( args: CreateConnectionAliasCommandInput, cb: (err: any, data?: CreateConnectionAliasCommandOutput) => void ): void; - public createConnectionAlias( + createConnectionAlias( args: CreateConnectionAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectionAliasCommandOutput) => void ): void; - public createConnectionAlias( - args: CreateConnectionAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateConnectionAliasCommandOutput) => void), - cb?: (err: any, data?: CreateConnectionAliasCommandOutput) => void - ): Promise | void { - const command = new CreateConnectionAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates an IP access control group.

- *

An IP access control group provides you with the ability to control the IP addresses - * from which users are allowed to access their WorkSpaces. To specify the CIDR address - * ranges, add rules to your IP access control group and then associate the group with your - * directory. You can add rules when you create the group or at any time using AuthorizeIpRules.

- *

There is a default IP access control group associated with your directory. If you don't - * associate an IP access control group with your directory, the default group is used. The - * default group includes a default rule that allows users to access their WorkSpaces from - * anywhere. You cannot modify the default IP access control group for your directory.

- */ - public createIpGroup( - args: CreateIpGroupCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public createIpGroup( - args: CreateIpGroupCommandInput, - cb: (err: any, data?: CreateIpGroupCommandOutput) => void - ): void; - public createIpGroup( + + /** + * @see {@link CreateIpGroupCommand} + */ + createIpGroup(args: CreateIpGroupCommandInput, options?: __HttpHandlerOptions): Promise; + createIpGroup(args: CreateIpGroupCommandInput, cb: (err: any, data?: CreateIpGroupCommandOutput) => void): void; + createIpGroup( args: CreateIpGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIpGroupCommandOutput) => void ): void; - public createIpGroup( - args: CreateIpGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateIpGroupCommandOutput) => void), - cb?: (err: any, data?: CreateIpGroupCommandOutput) => void - ): Promise | void { - const command = new CreateIpGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a standby WorkSpace in a secondary Region.

- */ - public createStandbyWorkspaces( + + /** + * @see {@link CreateStandbyWorkspacesCommand} + */ + createStandbyWorkspaces( args: CreateStandbyWorkspacesCommandInput, options?: __HttpHandlerOptions ): Promise; - public createStandbyWorkspaces( + createStandbyWorkspaces( args: CreateStandbyWorkspacesCommandInput, cb: (err: any, data?: CreateStandbyWorkspacesCommandOutput) => void ): void; - public createStandbyWorkspaces( + createStandbyWorkspaces( args: CreateStandbyWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStandbyWorkspacesCommandOutput) => void ): void; - public createStandbyWorkspaces( - args: CreateStandbyWorkspacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateStandbyWorkspacesCommandOutput) => void), - cb?: (err: any, data?: CreateStandbyWorkspacesCommandOutput) => void - ): Promise | void { - const command = new CreateStandbyWorkspacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates the specified tags for the specified WorkSpaces resource.

- */ - public createTags(args: CreateTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public createTags(args: CreateTagsCommandInput, cb: (err: any, data?: CreateTagsCommandOutput) => void): void; - public createTags( + + /** + * @see {@link CreateTagsCommand} + */ + createTags(args: CreateTagsCommandInput, options?: __HttpHandlerOptions): Promise; + createTags(args: CreateTagsCommandInput, cb: (err: any, data?: CreateTagsCommandOutput) => void): void; + createTags( args: CreateTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTagsCommandOutput) => void ): void; - public createTags( - args: CreateTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateTagsCommandOutput) => void), - cb?: (err: any, data?: CreateTagsCommandOutput) => void - ): Promise | void { - const command = new CreateTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new updated WorkSpace image based on the specified source image. The new - * updated WorkSpace image has the latest drivers and other updates required by the - * Amazon WorkSpaces components.

- *

To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces - * requirements, use - * DescribeWorkspaceImages.

- * - *
    - *
  • - *

    Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images - * can be programmatically updated at this time.

    - *
  • - *
  • - *

    Microsoft Windows updates and other application updates are not included in the - * update process.

    - *
  • - *
  • - *

    The source WorkSpace image is not deleted. You can delete the source image - * after you've verified your new updated image and created a new bundle.

    - *
  • - *
- *
- */ - public createUpdatedWorkspaceImage( + + /** + * @see {@link CreateUpdatedWorkspaceImageCommand} + */ + createUpdatedWorkspaceImage( args: CreateUpdatedWorkspaceImageCommandInput, options?: __HttpHandlerOptions ): Promise; - public createUpdatedWorkspaceImage( + createUpdatedWorkspaceImage( args: CreateUpdatedWorkspaceImageCommandInput, cb: (err: any, data?: CreateUpdatedWorkspaceImageCommandOutput) => void ): void; - public createUpdatedWorkspaceImage( + createUpdatedWorkspaceImage( args: CreateUpdatedWorkspaceImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUpdatedWorkspaceImageCommandOutput) => void ): void; - public createUpdatedWorkspaceImage( - args: CreateUpdatedWorkspaceImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateUpdatedWorkspaceImageCommandOutput) => void), - cb?: (err: any, data?: CreateUpdatedWorkspaceImageCommandOutput) => void - ): Promise | void { - const command = new CreateUpdatedWorkspaceImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see - * - * Create a Custom WorkSpaces Image and Bundle.

- */ - public createWorkspaceBundle( + + /** + * @see {@link CreateWorkspaceBundleCommand} + */ + createWorkspaceBundle( args: CreateWorkspaceBundleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorkspaceBundle( + createWorkspaceBundle( args: CreateWorkspaceBundleCommandInput, cb: (err: any, data?: CreateWorkspaceBundleCommandOutput) => void ): void; - public createWorkspaceBundle( + createWorkspaceBundle( args: CreateWorkspaceBundleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkspaceBundleCommandOutput) => void ): void; - public createWorkspaceBundle( - args: CreateWorkspaceBundleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorkspaceBundleCommandOutput) => void), - cb?: (err: any, data?: CreateWorkspaceBundleCommandOutput) => void - ): Promise | void { - const command = new CreateWorkspaceBundleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates a new WorkSpace image from an existing WorkSpace.

- */ - public createWorkspaceImage( + + /** + * @see {@link CreateWorkspaceImageCommand} + */ + createWorkspaceImage( args: CreateWorkspaceImageCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorkspaceImage( + createWorkspaceImage( args: CreateWorkspaceImageCommandInput, cb: (err: any, data?: CreateWorkspaceImageCommandOutput) => void ): void; - public createWorkspaceImage( + createWorkspaceImage( args: CreateWorkspaceImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkspaceImageCommandOutput) => void ): void; - public createWorkspaceImage( - args: CreateWorkspaceImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorkspaceImageCommandOutput) => void), - cb?: (err: any, data?: CreateWorkspaceImageCommandOutput) => void - ): Promise | void { - const command = new CreateWorkspaceImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Creates one or more WorkSpaces.

- *

This operation is asynchronous and returns before the WorkSpaces are created.

- * - *

The MANUAL running mode value is only supported by Amazon WorkSpaces - * Core. Contact your account team to be allow-listed to use this value. For more - * information, see Amazon WorkSpaces - * Core.

- *
- */ - public createWorkspaces( + + /** + * @see {@link CreateWorkspacesCommand} + */ + createWorkspaces( args: CreateWorkspacesCommandInput, options?: __HttpHandlerOptions ): Promise; - public createWorkspaces( + createWorkspaces( args: CreateWorkspacesCommandInput, cb: (err: any, data?: CreateWorkspacesCommandOutput) => void ): void; - public createWorkspaces( + createWorkspaces( args: CreateWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkspacesCommandOutput) => void ): void; - public createWorkspaces( - args: CreateWorkspacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateWorkspacesCommandOutput) => void), - cb?: (err: any, data?: CreateWorkspacesCommandOutput) => void - ): Promise | void { - const command = new CreateWorkspacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes customized client branding. Client branding allows you to customize your - * WorkSpace's client login portal. You can tailor your login portal company logo, the support - * email address, support link, link to reset password, and a custom message for users trying - * to sign in.

- *

After you delete your customized client branding, your login portal reverts to the - * default client branding.

- */ - public deleteClientBranding( + + /** + * @see {@link DeleteClientBrandingCommand} + */ + deleteClientBranding( args: DeleteClientBrandingCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteClientBranding( + deleteClientBranding( args: DeleteClientBrandingCommandInput, cb: (err: any, data?: DeleteClientBrandingCommandOutput) => void ): void; - public deleteClientBranding( + deleteClientBranding( args: DeleteClientBrandingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClientBrandingCommandOutput) => void ): void; - public deleteClientBranding( - args: DeleteClientBrandingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteClientBrandingCommandOutput) => void), - cb?: (err: any, data?: DeleteClientBrandingCommandOutput) => void - ): Promise | void { - const command = new DeleteClientBrandingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes a client-add-in for Amazon Connect that is configured within a - * directory.

- */ - public deleteConnectClientAddIn( + + /** + * @see {@link DeleteConnectClientAddInCommand} + */ + deleteConnectClientAddIn( args: DeleteConnectClientAddInCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConnectClientAddIn( + deleteConnectClientAddIn( args: DeleteConnectClientAddInCommandInput, cb: (err: any, data?: DeleteConnectClientAddInCommandOutput) => void ): void; - public deleteConnectClientAddIn( + deleteConnectClientAddIn( args: DeleteConnectClientAddInCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectClientAddInCommandOutput) => void ): void; - public deleteConnectClientAddIn( - args: DeleteConnectClientAddInCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConnectClientAddInCommandOutput) => void), - cb?: (err: any, data?: DeleteConnectClientAddInCommandOutput) => void - ): Promise | void { - const command = new DeleteConnectClientAddInCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified connection alias. For more information, see - * Cross-Region Redirection for Amazon WorkSpaces.

- * - *

- * If you will no longer be using a fully qualified domain name - * (FQDN) as the registration code for your WorkSpaces users, you must take certain - * precautions to prevent potential security issues. For more information, - * see Security Considerations if You Stop Using Cross-Region Redirection.

- *
- * - *

To delete a connection alias that has been shared, the shared account must first - * disassociate the connection alias from any directories it has been associated with. Then - * you must unshare the connection alias from the account it has been shared with. You can - * delete a connection alias only after it is no longer shared with any accounts or - * associated with any directories.

- *
- */ - public deleteConnectionAlias( + + /** + * @see {@link DeleteConnectionAliasCommand} + */ + deleteConnectionAlias( args: DeleteConnectionAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteConnectionAlias( + deleteConnectionAlias( args: DeleteConnectionAliasCommandInput, cb: (err: any, data?: DeleteConnectionAliasCommandOutput) => void ): void; - public deleteConnectionAlias( + deleteConnectionAlias( args: DeleteConnectionAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectionAliasCommandOutput) => void ): void; - public deleteConnectionAlias( - args: DeleteConnectionAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteConnectionAliasCommandOutput) => void), - cb?: (err: any, data?: DeleteConnectionAliasCommandOutput) => void - ): Promise | void { - const command = new DeleteConnectionAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified IP access control group.

- *

You cannot delete an IP access control group that is associated with a directory.

- */ - public deleteIpGroup( - args: DeleteIpGroupCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public deleteIpGroup( - args: DeleteIpGroupCommandInput, - cb: (err: any, data?: DeleteIpGroupCommandOutput) => void - ): void; - public deleteIpGroup( + + /** + * @see {@link DeleteIpGroupCommand} + */ + deleteIpGroup(args: DeleteIpGroupCommandInput, options?: __HttpHandlerOptions): Promise; + deleteIpGroup(args: DeleteIpGroupCommandInput, cb: (err: any, data?: DeleteIpGroupCommandOutput) => void): void; + deleteIpGroup( args: DeleteIpGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIpGroupCommandOutput) => void ): void; - public deleteIpGroup( - args: DeleteIpGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteIpGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteIpGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteIpGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified tags from the specified WorkSpaces resource.

- */ - public deleteTags(args: DeleteTagsCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteTags(args: DeleteTagsCommandInput, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void; - public deleteTags( + + /** + * @see {@link DeleteTagsCommand} + */ + deleteTags(args: DeleteTagsCommandInput, options?: __HttpHandlerOptions): Promise; + deleteTags(args: DeleteTagsCommandInput, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void; + deleteTags( args: DeleteTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTagsCommandOutput) => void ): void; - public deleteTags( - args: DeleteTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteTagsCommandOutput) => void), - cb?: (err: any, data?: DeleteTagsCommandOutput) => void - ): Promise | void { - const command = new DeleteTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see - * - * Delete a Custom WorkSpaces Bundle or Image.

- */ - public deleteWorkspaceBundle( + + /** + * @see {@link DeleteWorkspaceBundleCommand} + */ + deleteWorkspaceBundle( args: DeleteWorkspaceBundleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWorkspaceBundle( + deleteWorkspaceBundle( args: DeleteWorkspaceBundleCommandInput, cb: (err: any, data?: DeleteWorkspaceBundleCommandOutput) => void ): void; - public deleteWorkspaceBundle( + deleteWorkspaceBundle( args: DeleteWorkspaceBundleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkspaceBundleCommandOutput) => void ): void; - public deleteWorkspaceBundle( - args: DeleteWorkspaceBundleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorkspaceBundleCommandOutput) => void), - cb?: (err: any, data?: DeleteWorkspaceBundleCommandOutput) => void - ): Promise | void { - const command = new DeleteWorkspaceBundleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deletes the specified image from your account. To delete an image, you must first delete - * any bundles that are associated with the image and unshare the image if it is shared with - * other accounts.

- */ - public deleteWorkspaceImage( + + /** + * @see {@link DeleteWorkspaceImageCommand} + */ + deleteWorkspaceImage( args: DeleteWorkspaceImageCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteWorkspaceImage( + deleteWorkspaceImage( args: DeleteWorkspaceImageCommandInput, cb: (err: any, data?: DeleteWorkspaceImageCommandOutput) => void ): void; - public deleteWorkspaceImage( + deleteWorkspaceImage( args: DeleteWorkspaceImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWorkspaceImageCommandOutput) => void ): void; - public deleteWorkspaceImage( - args: DeleteWorkspaceImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteWorkspaceImageCommandOutput) => void), - cb?: (err: any, data?: DeleteWorkspaceImageCommandOutput) => void - ): Promise | void { - const command = new DeleteWorkspaceImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Deregisters the specified directory. This operation is asynchronous and returns before - * the WorkSpace directory is deregistered. If any WorkSpaces are registered to this - * directory, you must remove them before you can deregister the directory.

- * - *

Simple AD and AD Connector are made available to you free of charge to use with - * WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector - * directory for 30 consecutive days, this directory will be automatically deregistered for - * use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing - * terms.

- *

To delete empty directories, see Delete the - * Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector - * directory, you can always create a new one when you want to start using WorkSpaces - * again.

- *
- */ - public deregisterWorkspaceDirectory( + + /** + * @see {@link DeregisterWorkspaceDirectoryCommand} + */ + deregisterWorkspaceDirectory( args: DeregisterWorkspaceDirectoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public deregisterWorkspaceDirectory( + deregisterWorkspaceDirectory( args: DeregisterWorkspaceDirectoryCommandInput, cb: (err: any, data?: DeregisterWorkspaceDirectoryCommandOutput) => void ): void; - public deregisterWorkspaceDirectory( + deregisterWorkspaceDirectory( args: DeregisterWorkspaceDirectoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterWorkspaceDirectoryCommandOutput) => void ): void; - public deregisterWorkspaceDirectory( - args: DeregisterWorkspaceDirectoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeregisterWorkspaceDirectoryCommandOutput) => void), - cb?: (err: any, data?: DeregisterWorkspaceDirectoryCommandOutput) => void - ): Promise | void { - const command = new DeregisterWorkspaceDirectoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for - * the specified account.

- */ - public describeAccount( + + /** + * @see {@link DescribeAccountCommand} + */ + describeAccount( args: DescribeAccountCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccount( - args: DescribeAccountCommandInput, - cb: (err: any, data?: DescribeAccountCommandOutput) => void - ): void; - public describeAccount( + describeAccount(args: DescribeAccountCommandInput, cb: (err: any, data?: DescribeAccountCommandOutput) => void): void; + describeAccount( args: DescribeAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountCommandOutput) => void ): void; - public describeAccount( - args: DescribeAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccountCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list that describes modifications to the configuration of Bring Your Own - * License (BYOL) for the specified account.

- */ - public describeAccountModifications( + + /** + * @see {@link DescribeAccountModificationsCommand} + */ + describeAccountModifications( args: DescribeAccountModificationsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeAccountModifications( + describeAccountModifications( args: DescribeAccountModificationsCommandInput, cb: (err: any, data?: DescribeAccountModificationsCommandOutput) => void ): void; - public describeAccountModifications( + describeAccountModifications( args: DescribeAccountModificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountModificationsCommandOutput) => void ): void; - public describeAccountModifications( - args: DescribeAccountModificationsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeAccountModificationsCommandOutput) => void), - cb?: (err: any, data?: DescribeAccountModificationsCommandOutput) => void - ): Promise | void { - const command = new DescribeAccountModificationsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified client branding. Client branding allows you to customize the log - * in page of various device types for your users. You can add your company logo, the support - * email address, support link, link to reset password, and a custom message for users trying - * to sign in.

- * - *

Only device types that have branding information configured will be shown in the - * response.

- *
- */ - public describeClientBranding( + + /** + * @see {@link DescribeClientBrandingCommand} + */ + describeClientBranding( args: DescribeClientBrandingCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClientBranding( + describeClientBranding( args: DescribeClientBrandingCommandInput, cb: (err: any, data?: DescribeClientBrandingCommandOutput) => void ): void; - public describeClientBranding( + describeClientBranding( args: DescribeClientBrandingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClientBrandingCommandOutput) => void ): void; - public describeClientBranding( - args: DescribeClientBrandingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClientBrandingCommandOutput) => void), - cb?: (err: any, data?: DescribeClientBrandingCommandOutput) => void - ): Promise | void { - const command = new DescribeClientBrandingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list that describes one or more specified Amazon WorkSpaces clients.

- */ - public describeClientProperties( + + /** + * @see {@link DescribeClientPropertiesCommand} + */ + describeClientProperties( args: DescribeClientPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeClientProperties( + describeClientProperties( args: DescribeClientPropertiesCommandInput, cb: (err: any, data?: DescribeClientPropertiesCommandOutput) => void ): void; - public describeClientProperties( + describeClientProperties( args: DescribeClientPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClientPropertiesCommandOutput) => void ): void; - public describeClientProperties( - args: DescribeClientPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClientPropertiesCommandOutput) => void), - cb?: (err: any, data?: DescribeClientPropertiesCommandOutput) => void - ): Promise | void { - const command = new DescribeClientPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of Amazon Connect client add-ins that have been created.

- */ - public describeConnectClientAddIns( + + /** + * @see {@link DescribeConnectClientAddInsCommand} + */ + describeConnectClientAddIns( args: DescribeConnectClientAddInsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConnectClientAddIns( + describeConnectClientAddIns( args: DescribeConnectClientAddInsCommandInput, cb: (err: any, data?: DescribeConnectClientAddInsCommandOutput) => void ): void; - public describeConnectClientAddIns( + describeConnectClientAddIns( args: DescribeConnectClientAddInsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectClientAddInsCommandOutput) => void ): void; - public describeConnectClientAddIns( - args: DescribeConnectClientAddInsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConnectClientAddInsCommandOutput) => void), - cb?: (err: any, data?: DescribeConnectClientAddInsCommandOutput) => void - ): Promise | void { - const command = new DescribeConnectClientAddInsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list that describes the connection aliases used for cross-Region - * redirection. For more information, see Cross-Region - * Redirection for Amazon WorkSpaces.

- */ - public describeConnectionAliases( + + /** + * @see {@link DescribeConnectionAliasesCommand} + */ + describeConnectionAliases( args: DescribeConnectionAliasesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConnectionAliases( + describeConnectionAliases( args: DescribeConnectionAliasesCommandInput, cb: (err: any, data?: DescribeConnectionAliasesCommandOutput) => void ): void; - public describeConnectionAliases( + describeConnectionAliases( args: DescribeConnectionAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectionAliasesCommandOutput) => void ): void; - public describeConnectionAliases( - args: DescribeConnectionAliasesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConnectionAliasesCommandOutput) => void), - cb?: (err: any, data?: DescribeConnectionAliasesCommandOutput) => void - ): Promise | void { - const command = new DescribeConnectionAliasesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the permissions that the owner of a connection alias has granted to another - * Amazon Web Services account for the specified connection alias. For more information, see - * Cross-Region - * Redirection for Amazon WorkSpaces.

- */ - public describeConnectionAliasPermissions( + + /** + * @see {@link DescribeConnectionAliasPermissionsCommand} + */ + describeConnectionAliasPermissions( args: DescribeConnectionAliasPermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeConnectionAliasPermissions( + describeConnectionAliasPermissions( args: DescribeConnectionAliasPermissionsCommandInput, cb: (err: any, data?: DescribeConnectionAliasPermissionsCommandOutput) => void ): void; - public describeConnectionAliasPermissions( + describeConnectionAliasPermissions( args: DescribeConnectionAliasPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectionAliasPermissionsCommandOutput) => void ): void; - public describeConnectionAliasPermissions( - args: DescribeConnectionAliasPermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConnectionAliasPermissionsCommandOutput) => void), - cb?: (err: any, data?: DescribeConnectionAliasPermissionsCommandOutput) => void - ): Promise | void { - const command = new DescribeConnectionAliasPermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes one or more of your IP access control groups.

- */ - public describeIpGroups( + + /** + * @see {@link DescribeIpGroupsCommand} + */ + describeIpGroups( args: DescribeIpGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeIpGroups( + describeIpGroups( args: DescribeIpGroupsCommandInput, cb: (err: any, data?: DescribeIpGroupsCommandOutput) => void ): void; - public describeIpGroups( + describeIpGroups( args: DescribeIpGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIpGroupsCommandOutput) => void ): void; - public describeIpGroups( - args: DescribeIpGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeIpGroupsCommandOutput) => void), - cb?: (err: any, data?: DescribeIpGroupsCommandOutput) => void - ): Promise | void { - const command = new DescribeIpGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified tags for the specified WorkSpaces resource.

- */ - public describeTags( - args: DescribeTagsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public describeTags(args: DescribeTagsCommandInput, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void; - public describeTags( + + /** + * @see {@link DescribeTagsCommand} + */ + describeTags(args: DescribeTagsCommandInput, options?: __HttpHandlerOptions): Promise; + describeTags(args: DescribeTagsCommandInput, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void; + describeTags( args: DescribeTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTagsCommandOutput) => void ): void; - public describeTags( - args: DescribeTagsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeTagsCommandOutput) => void), - cb?: (err: any, data?: DescribeTagsCommandOutput) => void - ): Promise | void { - const command = new DescribeTagsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list that describes the available WorkSpace bundles.

- *

You can filter the results using either bundle ID or owner, but not both.

- */ - public describeWorkspaceBundles( + + /** + * @see {@link DescribeWorkspaceBundlesCommand} + */ + describeWorkspaceBundles( args: DescribeWorkspaceBundlesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWorkspaceBundles( + describeWorkspaceBundles( args: DescribeWorkspaceBundlesCommandInput, cb: (err: any, data?: DescribeWorkspaceBundlesCommandOutput) => void ): void; - public describeWorkspaceBundles( + describeWorkspaceBundles( args: DescribeWorkspaceBundlesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspaceBundlesCommandOutput) => void ): void; - public describeWorkspaceBundles( - args: DescribeWorkspaceBundlesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWorkspaceBundlesCommandOutput) => void), - cb?: (err: any, data?: DescribeWorkspaceBundlesCommandOutput) => void - ): Promise | void { - const command = new DescribeWorkspaceBundlesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the available directories that are registered with Amazon WorkSpaces.

- */ - public describeWorkspaceDirectories( + + /** + * @see {@link DescribeWorkspaceDirectoriesCommand} + */ + describeWorkspaceDirectories( args: DescribeWorkspaceDirectoriesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWorkspaceDirectories( + describeWorkspaceDirectories( args: DescribeWorkspaceDirectoriesCommandInput, cb: (err: any, data?: DescribeWorkspaceDirectoriesCommandOutput) => void ): void; - public describeWorkspaceDirectories( + describeWorkspaceDirectories( args: DescribeWorkspaceDirectoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspaceDirectoriesCommandOutput) => void ): void; - public describeWorkspaceDirectories( - args: DescribeWorkspaceDirectoriesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWorkspaceDirectoriesCommandOutput) => void), - cb?: (err: any, data?: DescribeWorkspaceDirectoriesCommandOutput) => void - ): Promise | void { - const command = new DescribeWorkspaceDirectoriesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.

- */ - public describeWorkspaceImagePermissions( + + /** + * @see {@link DescribeWorkspaceImagePermissionsCommand} + */ + describeWorkspaceImagePermissions( args: DescribeWorkspaceImagePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWorkspaceImagePermissions( + describeWorkspaceImagePermissions( args: DescribeWorkspaceImagePermissionsCommandInput, cb: (err: any, data?: DescribeWorkspaceImagePermissionsCommandOutput) => void ): void; - public describeWorkspaceImagePermissions( + describeWorkspaceImagePermissions( args: DescribeWorkspaceImagePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspaceImagePermissionsCommandOutput) => void ): void; - public describeWorkspaceImagePermissions( - args: DescribeWorkspaceImagePermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWorkspaceImagePermissionsCommandOutput) => void), - cb?: (err: any, data?: DescribeWorkspaceImagePermissionsCommandOutput) => void - ): Promise | void { - const command = new DescribeWorkspaceImagePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list that describes one or more specified images, if the image identifiers - * are provided. Otherwise, all images in the account are described.

- */ - public describeWorkspaceImages( + + /** + * @see {@link DescribeWorkspaceImagesCommand} + */ + describeWorkspaceImages( args: DescribeWorkspaceImagesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWorkspaceImages( + describeWorkspaceImages( args: DescribeWorkspaceImagesCommandInput, cb: (err: any, data?: DescribeWorkspaceImagesCommandOutput) => void ): void; - public describeWorkspaceImages( + describeWorkspaceImages( args: DescribeWorkspaceImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspaceImagesCommandOutput) => void ): void; - public describeWorkspaceImages( - args: DescribeWorkspaceImagesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWorkspaceImagesCommandOutput) => void), - cb?: (err: any, data?: DescribeWorkspaceImagesCommandOutput) => void - ): Promise | void { - const command = new DescribeWorkspaceImagesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the specified WorkSpaces.

- *

You can filter the results by using the bundle identifier, directory identifier, or - * owner, but you can specify only one filter at a time.

- */ - public describeWorkspaces( + + /** + * @see {@link DescribeWorkspacesCommand} + */ + describeWorkspaces( args: DescribeWorkspacesCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWorkspaces( + describeWorkspaces( args: DescribeWorkspacesCommandInput, cb: (err: any, data?: DescribeWorkspacesCommandOutput) => void ): void; - public describeWorkspaces( + describeWorkspaces( args: DescribeWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspacesCommandOutput) => void ): void; - public describeWorkspaces( - args: DescribeWorkspacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWorkspacesCommandOutput) => void), - cb?: (err: any, data?: DescribeWorkspacesCommandOutput) => void - ): Promise | void { - const command = new DescribeWorkspacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the connection status of the specified WorkSpaces.

- */ - public describeWorkspacesConnectionStatus( + + /** + * @see {@link DescribeWorkspacesConnectionStatusCommand} + */ + describeWorkspacesConnectionStatus( args: DescribeWorkspacesConnectionStatusCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWorkspacesConnectionStatus( + describeWorkspacesConnectionStatus( args: DescribeWorkspacesConnectionStatusCommandInput, cb: (err: any, data?: DescribeWorkspacesConnectionStatusCommandOutput) => void ): void; - public describeWorkspacesConnectionStatus( + describeWorkspacesConnectionStatus( args: DescribeWorkspacesConnectionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspacesConnectionStatusCommandOutput) => void ): void; - public describeWorkspacesConnectionStatus( - args: DescribeWorkspacesConnectionStatusCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWorkspacesConnectionStatusCommandOutput) => void), - cb?: (err: any, data?: DescribeWorkspacesConnectionStatusCommandOutput) => void - ): Promise | void { - const command = new DescribeWorkspacesConnectionStatusCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Describes the snapshots for the specified WorkSpace.

- */ - public describeWorkspaceSnapshots( + + /** + * @see {@link DescribeWorkspaceSnapshotsCommand} + */ + describeWorkspaceSnapshots( args: DescribeWorkspaceSnapshotsCommandInput, options?: __HttpHandlerOptions ): Promise; - public describeWorkspaceSnapshots( + describeWorkspaceSnapshots( args: DescribeWorkspaceSnapshotsCommandInput, cb: (err: any, data?: DescribeWorkspaceSnapshotsCommandOutput) => void ): void; - public describeWorkspaceSnapshots( + describeWorkspaceSnapshots( args: DescribeWorkspaceSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkspaceSnapshotsCommandOutput) => void ): void; - public describeWorkspaceSnapshots( - args: DescribeWorkspaceSnapshotsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeWorkspaceSnapshotsCommandOutput) => void), - cb?: (err: any, data?: DescribeWorkspaceSnapshotsCommandOutput) => void - ): Promise | void { - const command = new DescribeWorkspaceSnapshotsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates a connection alias from a directory. Disassociating a connection alias - * disables cross-Region redirection between two directories in different Regions. For more - * information, see Cross-Region - * Redirection for Amazon WorkSpaces.

- * - *

Before performing this operation, call - * DescribeConnectionAliases to make sure that the current state of the - * connection alias is CREATED.

- *
- */ - public disassociateConnectionAlias( + + /** + * @see {@link DisassociateConnectionAliasCommand} + */ + disassociateConnectionAlias( args: DisassociateConnectionAliasCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateConnectionAlias( + disassociateConnectionAlias( args: DisassociateConnectionAliasCommandInput, cb: (err: any, data?: DisassociateConnectionAliasCommandOutput) => void ): void; - public disassociateConnectionAlias( + disassociateConnectionAlias( args: DisassociateConnectionAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateConnectionAliasCommandOutput) => void ): void; - public disassociateConnectionAlias( - args: DisassociateConnectionAliasCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateConnectionAliasCommandOutput) => void), - cb?: (err: any, data?: DisassociateConnectionAliasCommandOutput) => void - ): Promise | void { - const command = new DisassociateConnectionAliasCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Disassociates the specified IP access control group from the specified directory.

- */ - public disassociateIpGroups( + + /** + * @see {@link DisassociateIpGroupsCommand} + */ + disassociateIpGroups( args: DisassociateIpGroupsCommandInput, options?: __HttpHandlerOptions ): Promise; - public disassociateIpGroups( + disassociateIpGroups( args: DisassociateIpGroupsCommandInput, cb: (err: any, data?: DisassociateIpGroupsCommandOutput) => void ): void; - public disassociateIpGroups( + disassociateIpGroups( args: DisassociateIpGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateIpGroupsCommandOutput) => void ): void; - public disassociateIpGroups( - args: DisassociateIpGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateIpGroupsCommandOutput) => void), - cb?: (err: any, data?: DisassociateIpGroupsCommandOutput) => void - ): Promise | void { - const command = new DisassociateIpGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Imports client branding. Client branding allows you to customize your WorkSpace's client - * login portal. You can tailor your login portal company logo, the support email address, - * support link, link to reset password, and a custom message for users trying to sign - * in.

- *

After you import client branding, the default branding experience for the specified - * platform type is replaced with the imported experience

- * - *
    - *
  • - *

    You must specify at least one platform type when importing client - * branding.

    - *
  • - *
  • - *

    You can import up to 6 MB of data with each request. If your request exceeds - * this limit, you can import client branding for different platform types using - * separate requests.

    - *
  • - *
  • - *

    In each platform type, the SupportEmail and - * SupportLink parameters are mutually exclusive. You can specify - * only one parameter for each platform type, but not both.

    - *
  • - *
  • - *

    Imported data can take up to a minute to appear in the WorkSpaces - * client.

    - *
  • - *
- *
- */ - public importClientBranding( + + /** + * @see {@link ImportClientBrandingCommand} + */ + importClientBranding( args: ImportClientBrandingCommandInput, options?: __HttpHandlerOptions ): Promise; - public importClientBranding( + importClientBranding( args: ImportClientBrandingCommandInput, cb: (err: any, data?: ImportClientBrandingCommandOutput) => void ): void; - public importClientBranding( + importClientBranding( args: ImportClientBrandingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportClientBrandingCommandOutput) => void ): void; - public importClientBranding( - args: ImportClientBrandingCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportClientBrandingCommandOutput) => void), - cb?: (err: any, data?: ImportClientBrandingCommandOutput) => void - ): Promise | void { - const command = new ImportClientBrandingCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Imports the specified Windows 10 Bring Your Own License (BYOL) - * image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is - * in your Amazon Web Services account, and you must own the image. For more information about - * creating BYOL images, see Bring Your Own Windows - * Desktop Licenses.

- */ - public importWorkspaceImage( + + /** + * @see {@link ImportWorkspaceImageCommand} + */ + importWorkspaceImage( args: ImportWorkspaceImageCommandInput, options?: __HttpHandlerOptions ): Promise; - public importWorkspaceImage( + importWorkspaceImage( args: ImportWorkspaceImageCommandInput, cb: (err: any, data?: ImportWorkspaceImageCommandOutput) => void ): void; - public importWorkspaceImage( + importWorkspaceImage( args: ImportWorkspaceImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportWorkspaceImageCommandOutput) => void ): void; - public importWorkspaceImage( - args: ImportWorkspaceImageCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportWorkspaceImageCommandOutput) => void), - cb?: (err: any, data?: ImportWorkspaceImageCommandOutput) => void - ): Promise | void { - const command = new ImportWorkspaceImageCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use - * for the network management interface when you enable Bring Your Own License (BYOL).

- *

This operation can be run only by Amazon Web Services accounts that are enabled for BYOL. - * If your account isn't enabled for BYOL, you'll receive an - * AccessDeniedException error.

- *

The management network interface is connected to a secure Amazon WorkSpaces management - * network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces - * clients, and to allow Amazon WorkSpaces to manage the WorkSpace.

- */ - public listAvailableManagementCidrRanges( + + /** + * @see {@link ListAvailableManagementCidrRangesCommand} + */ + listAvailableManagementCidrRanges( args: ListAvailableManagementCidrRangesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listAvailableManagementCidrRanges( + listAvailableManagementCidrRanges( args: ListAvailableManagementCidrRangesCommandInput, cb: (err: any, data?: ListAvailableManagementCidrRangesCommandOutput) => void ): void; - public listAvailableManagementCidrRanges( + listAvailableManagementCidrRanges( args: ListAvailableManagementCidrRangesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAvailableManagementCidrRangesCommandOutput) => void ): void; - public listAvailableManagementCidrRanges( - args: ListAvailableManagementCidrRangesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAvailableManagementCidrRangesCommandOutput) => void), - cb?: (err: any, data?: ListAvailableManagementCidrRangesCommandOutput) => void - ): Promise | void { - const command = new ListAvailableManagementCidrRangesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Migrates a WorkSpace from one operating system or bundle type to another, while - * retaining the data on the user volume.

- *

The migration process recreates the WorkSpace by using a new root volume from the target - * bundle image and the user volume from the last available snapshot of the original - * WorkSpace. During migration, the original D:\Users\%USERNAME% user profile - * folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new - * D:\Users\%USERNAME%\ folder is generated by the new OS. Certain files in - * the old user profile are moved to the new user profile.

- *

For available migration scenarios, details about what happens during migration, and best - * practices, see Migrate a - * WorkSpace.

- */ - public migrateWorkspace( + + /** + * @see {@link MigrateWorkspaceCommand} + */ + migrateWorkspace( args: MigrateWorkspaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public migrateWorkspace( + migrateWorkspace( args: MigrateWorkspaceCommandInput, cb: (err: any, data?: MigrateWorkspaceCommandOutput) => void ): void; - public migrateWorkspace( + migrateWorkspace( args: MigrateWorkspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MigrateWorkspaceCommandOutput) => void ): void; - public migrateWorkspace( - args: MigrateWorkspaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MigrateWorkspaceCommandOutput) => void), - cb?: (err: any, data?: MigrateWorkspaceCommandOutput) => void - ): Promise | void { - const command = new MigrateWorkspaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the configuration of Bring Your Own License (BYOL) for the specified - * account.

- */ - public modifyAccount( - args: ModifyAccountCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public modifyAccount( - args: ModifyAccountCommandInput, - cb: (err: any, data?: ModifyAccountCommandOutput) => void - ): void; - public modifyAccount( + + /** + * @see {@link ModifyAccountCommand} + */ + modifyAccount(args: ModifyAccountCommandInput, options?: __HttpHandlerOptions): Promise; + modifyAccount(args: ModifyAccountCommandInput, cb: (err: any, data?: ModifyAccountCommandOutput) => void): void; + modifyAccount( args: ModifyAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyAccountCommandOutput) => void ): void; - public modifyAccount( - args: ModifyAccountCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyAccountCommandOutput) => void), - cb?: (err: any, data?: ModifyAccountCommandOutput) => void - ): Promise | void { - const command = new ModifyAccountCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the properties of the certificate-based authentication you want - * to use with your WorkSpaces.

- */ - public modifyCertificateBasedAuthProperties( + + /** + * @see {@link ModifyCertificateBasedAuthPropertiesCommand} + */ + modifyCertificateBasedAuthProperties( args: ModifyCertificateBasedAuthPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyCertificateBasedAuthProperties( + modifyCertificateBasedAuthProperties( args: ModifyCertificateBasedAuthPropertiesCommandInput, cb: (err: any, data?: ModifyCertificateBasedAuthPropertiesCommandOutput) => void ): void; - public modifyCertificateBasedAuthProperties( + modifyCertificateBasedAuthProperties( args: ModifyCertificateBasedAuthPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyCertificateBasedAuthPropertiesCommandOutput) => void ): void; - public modifyCertificateBasedAuthProperties( - args: ModifyCertificateBasedAuthPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyCertificateBasedAuthPropertiesCommandOutput) => void), - cb?: (err: any, data?: ModifyCertificateBasedAuthPropertiesCommandOutput) => void - ): Promise | void { - const command = new ModifyCertificateBasedAuthPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the properties of the specified Amazon WorkSpaces clients.

- */ - public modifyClientProperties( + + /** + * @see {@link ModifyClientPropertiesCommand} + */ + modifyClientProperties( args: ModifyClientPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyClientProperties( + modifyClientProperties( args: ModifyClientPropertiesCommandInput, cb: (err: any, data?: ModifyClientPropertiesCommandOutput) => void ): void; - public modifyClientProperties( + modifyClientProperties( args: ModifyClientPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyClientPropertiesCommandOutput) => void ): void; - public modifyClientProperties( - args: ModifyClientPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyClientPropertiesCommandOutput) => void), - cb?: (err: any, data?: ModifyClientPropertiesCommandOutput) => void - ): Promise | void { - const command = new ModifyClientPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, - * user access URL, and relay state parameter name that are used for configuring federation with an - * SAML 2.0 identity provider.

- */ - public modifySamlProperties( + + /** + * @see {@link ModifySamlPropertiesCommand} + */ + modifySamlProperties( args: ModifySamlPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifySamlProperties( + modifySamlProperties( args: ModifySamlPropertiesCommandInput, cb: (err: any, data?: ModifySamlPropertiesCommandOutput) => void ): void; - public modifySamlProperties( + modifySamlProperties( args: ModifySamlPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifySamlPropertiesCommandOutput) => void ): void; - public modifySamlProperties( - args: ModifySamlPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifySamlPropertiesCommandOutput) => void), - cb?: (err: any, data?: ModifySamlPropertiesCommandOutput) => void - ): Promise | void { - const command = new ModifySamlPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the self-service WorkSpace management capabilities for your users. For more - * information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.

- */ - public modifySelfservicePermissions( + + /** + * @see {@link ModifySelfservicePermissionsCommand} + */ + modifySelfservicePermissions( args: ModifySelfservicePermissionsCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifySelfservicePermissions( + modifySelfservicePermissions( args: ModifySelfservicePermissionsCommandInput, cb: (err: any, data?: ModifySelfservicePermissionsCommandOutput) => void ): void; - public modifySelfservicePermissions( + modifySelfservicePermissions( args: ModifySelfservicePermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifySelfservicePermissionsCommandOutput) => void ): void; - public modifySelfservicePermissions( - args: ModifySelfservicePermissionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifySelfservicePermissionsCommandOutput) => void), - cb?: (err: any, data?: ModifySelfservicePermissionsCommandOutput) => void - ): Promise | void { - const command = new ModifySelfservicePermissionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Specifies which devices and operating systems users can use to access their WorkSpaces. - * For more information, see - * Control Device Access.

- */ - public modifyWorkspaceAccessProperties( + + /** + * @see {@link ModifyWorkspaceAccessPropertiesCommand} + */ + modifyWorkspaceAccessProperties( args: ModifyWorkspaceAccessPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyWorkspaceAccessProperties( + modifyWorkspaceAccessProperties( args: ModifyWorkspaceAccessPropertiesCommandInput, cb: (err: any, data?: ModifyWorkspaceAccessPropertiesCommandOutput) => void ): void; - public modifyWorkspaceAccessProperties( + modifyWorkspaceAccessProperties( args: ModifyWorkspaceAccessPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyWorkspaceAccessPropertiesCommandOutput) => void ): void; - public modifyWorkspaceAccessProperties( - args: ModifyWorkspaceAccessPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyWorkspaceAccessPropertiesCommandOutput) => void), - cb?: (err: any, data?: ModifyWorkspaceAccessPropertiesCommandOutput) => void - ): Promise | void { - const command = new ModifyWorkspaceAccessPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modify the default properties used to create WorkSpaces.

- */ - public modifyWorkspaceCreationProperties( + + /** + * @see {@link ModifyWorkspaceCreationPropertiesCommand} + */ + modifyWorkspaceCreationProperties( args: ModifyWorkspaceCreationPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyWorkspaceCreationProperties( + modifyWorkspaceCreationProperties( args: ModifyWorkspaceCreationPropertiesCommandInput, cb: (err: any, data?: ModifyWorkspaceCreationPropertiesCommandOutput) => void ): void; - public modifyWorkspaceCreationProperties( + modifyWorkspaceCreationProperties( args: ModifyWorkspaceCreationPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyWorkspaceCreationPropertiesCommandOutput) => void ): void; - public modifyWorkspaceCreationProperties( - args: ModifyWorkspaceCreationPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyWorkspaceCreationPropertiesCommandOutput) => void), - cb?: (err: any, data?: ModifyWorkspaceCreationPropertiesCommandOutput) => void - ): Promise | void { - const command = new ModifyWorkspaceCreationPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Modifies the specified WorkSpace properties. For important information about how to - * modify the size of the root and user volumes, see Modify a WorkSpace. - *

- * - *

The MANUAL running mode value is only supported by Amazon WorkSpaces - * Core. Contact your account team to be allow-listed to use this value. For more - * information, see Amazon WorkSpaces - * Core.

- *
- */ - public modifyWorkspaceProperties( + + /** + * @see {@link ModifyWorkspacePropertiesCommand} + */ + modifyWorkspaceProperties( args: ModifyWorkspacePropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyWorkspaceProperties( + modifyWorkspaceProperties( args: ModifyWorkspacePropertiesCommandInput, cb: (err: any, data?: ModifyWorkspacePropertiesCommandOutput) => void ): void; - public modifyWorkspaceProperties( + modifyWorkspaceProperties( args: ModifyWorkspacePropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyWorkspacePropertiesCommandOutput) => void ): void; - public modifyWorkspaceProperties( - args: ModifyWorkspacePropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyWorkspacePropertiesCommandOutput) => void), - cb?: (err: any, data?: ModifyWorkspacePropertiesCommandOutput) => void - ): Promise | void { - const command = new ModifyWorkspacePropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Sets the state of the specified WorkSpace.

- *

To maintain a WorkSpace without being interrupted, set the WorkSpace state to - * ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to - * reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not - * stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE - * state.

- */ - public modifyWorkspaceState( + + /** + * @see {@link ModifyWorkspaceStateCommand} + */ + modifyWorkspaceState( args: ModifyWorkspaceStateCommandInput, options?: __HttpHandlerOptions ): Promise; - public modifyWorkspaceState( + modifyWorkspaceState( args: ModifyWorkspaceStateCommandInput, cb: (err: any, data?: ModifyWorkspaceStateCommandOutput) => void ): void; - public modifyWorkspaceState( + modifyWorkspaceState( args: ModifyWorkspaceStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyWorkspaceStateCommandOutput) => void ): void; - public modifyWorkspaceState( - args: ModifyWorkspaceStateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ModifyWorkspaceStateCommandOutput) => void), - cb?: (err: any, data?: ModifyWorkspaceStateCommandOutput) => void - ): Promise | void { - const command = new ModifyWorkspaceStateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Reboots the specified WorkSpaces.

- *

You cannot reboot a WorkSpace unless its state is AVAILABLE or - * UNHEALTHY.

- *

This operation is asynchronous and returns before the WorkSpaces have rebooted.

- */ - public rebootWorkspaces( + + /** + * @see {@link RebootWorkspacesCommand} + */ + rebootWorkspaces( args: RebootWorkspacesCommandInput, options?: __HttpHandlerOptions ): Promise; - public rebootWorkspaces( + rebootWorkspaces( args: RebootWorkspacesCommandInput, cb: (err: any, data?: RebootWorkspacesCommandOutput) => void ): void; - public rebootWorkspaces( + rebootWorkspaces( args: RebootWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebootWorkspacesCommandOutput) => void ): void; - public rebootWorkspaces( - args: RebootWorkspacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RebootWorkspacesCommandOutput) => void), - cb?: (err: any, data?: RebootWorkspacesCommandOutput) => void - ): Promise | void { - const command = new RebootWorkspacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Rebuilds the specified WorkSpace.

- *

You cannot rebuild a WorkSpace unless its state is AVAILABLE, - * ERROR, UNHEALTHY, STOPPED, or - * REBOOTING.

- *

Rebuilding a WorkSpace is a potentially destructive action that can result in the loss - * of data. For more information, see Rebuild a - * WorkSpace.

- *

This operation is asynchronous and returns before the WorkSpaces have been completely - * rebuilt.

- */ - public rebuildWorkspaces( + + /** + * @see {@link RebuildWorkspacesCommand} + */ + rebuildWorkspaces( args: RebuildWorkspacesCommandInput, options?: __HttpHandlerOptions ): Promise; - public rebuildWorkspaces( + rebuildWorkspaces( args: RebuildWorkspacesCommandInput, cb: (err: any, data?: RebuildWorkspacesCommandOutput) => void ): void; - public rebuildWorkspaces( + rebuildWorkspaces( args: RebuildWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebuildWorkspacesCommandOutput) => void ): void; - public rebuildWorkspaces( - args: RebuildWorkspacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RebuildWorkspacesCommandOutput) => void), - cb?: (err: any, data?: RebuildWorkspacesCommandOutput) => void - ): Promise | void { - const command = new RebuildWorkspacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Registers the specified directory. This operation is asynchronous and returns before the - * WorkSpace directory is registered. If this is the first time you are registering a - * directory, you will need to create the workspaces_DefaultRole role before you can register - * a directory. For more information, see - * Creating the workspaces_DefaultRole Role.

- */ - public registerWorkspaceDirectory( + + /** + * @see {@link RegisterWorkspaceDirectoryCommand} + */ + registerWorkspaceDirectory( args: RegisterWorkspaceDirectoryCommandInput, options?: __HttpHandlerOptions ): Promise; - public registerWorkspaceDirectory( + registerWorkspaceDirectory( args: RegisterWorkspaceDirectoryCommandInput, cb: (err: any, data?: RegisterWorkspaceDirectoryCommandOutput) => void ): void; - public registerWorkspaceDirectory( + registerWorkspaceDirectory( args: RegisterWorkspaceDirectoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterWorkspaceDirectoryCommandOutput) => void ): void; - public registerWorkspaceDirectory( - args: RegisterWorkspaceDirectoryCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterWorkspaceDirectoryCommandOutput) => void), - cb?: (err: any, data?: RegisterWorkspaceDirectoryCommandOutput) => void - ): Promise | void { - const command = new RegisterWorkspaceDirectoryCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Restores the specified WorkSpace to its last known healthy state.

- *

You cannot restore a WorkSpace unless its state is AVAILABLE, - * ERROR, UNHEALTHY, or STOPPED.

- *

Restoring a WorkSpace is a potentially destructive action that can result in the loss of - * data. For more information, see Restore a - * WorkSpace.

- *

This operation is asynchronous and returns before the WorkSpace is completely - * restored.

- */ - public restoreWorkspace( + + /** + * @see {@link RestoreWorkspaceCommand} + */ + restoreWorkspace( args: RestoreWorkspaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public restoreWorkspace( + restoreWorkspace( args: RestoreWorkspaceCommandInput, cb: (err: any, data?: RestoreWorkspaceCommandOutput) => void ): void; - public restoreWorkspace( + restoreWorkspace( args: RestoreWorkspaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreWorkspaceCommandOutput) => void ): void; - public restoreWorkspace( - args: RestoreWorkspaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreWorkspaceCommandOutput) => void), - cb?: (err: any, data?: RestoreWorkspaceCommandOutput) => void - ): Promise | void { - const command = new RestoreWorkspaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Removes one or more rules from the specified IP access control group.

- */ - public revokeIpRules( - args: RevokeIpRulesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public revokeIpRules( - args: RevokeIpRulesCommandInput, - cb: (err: any, data?: RevokeIpRulesCommandOutput) => void - ): void; - public revokeIpRules( + + /** + * @see {@link RevokeIpRulesCommand} + */ + revokeIpRules(args: RevokeIpRulesCommandInput, options?: __HttpHandlerOptions): Promise; + revokeIpRules(args: RevokeIpRulesCommandInput, cb: (err: any, data?: RevokeIpRulesCommandOutput) => void): void; + revokeIpRules( args: RevokeIpRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeIpRulesCommandOutput) => void ): void; - public revokeIpRules( - args: RevokeIpRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RevokeIpRulesCommandOutput) => void), - cb?: (err: any, data?: RevokeIpRulesCommandOutput) => void - ): Promise | void { - const command = new RevokeIpRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Starts the specified WorkSpaces.

- *

You cannot start a WorkSpace unless it has a running mode of AutoStop and a - * state of STOPPED.

- */ - public startWorkspaces( + + /** + * @see {@link StartWorkspacesCommand} + */ + startWorkspaces( args: StartWorkspacesCommandInput, options?: __HttpHandlerOptions ): Promise; - public startWorkspaces( - args: StartWorkspacesCommandInput, - cb: (err: any, data?: StartWorkspacesCommandOutput) => void - ): void; - public startWorkspaces( + startWorkspaces(args: StartWorkspacesCommandInput, cb: (err: any, data?: StartWorkspacesCommandOutput) => void): void; + startWorkspaces( args: StartWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartWorkspacesCommandOutput) => void ): void; - public startWorkspaces( - args: StartWorkspacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartWorkspacesCommandOutput) => void), - cb?: (err: any, data?: StartWorkspacesCommandOutput) => void - ): Promise | void { - const command = new StartWorkspacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Stops the specified WorkSpaces.

- *

You cannot stop a WorkSpace unless it has a running mode of AutoStop and a - * state of AVAILABLE, IMPAIRED, UNHEALTHY, or - * ERROR.

- */ - public stopWorkspaces( + + /** + * @see {@link StopWorkspacesCommand} + */ + stopWorkspaces( args: StopWorkspacesCommandInput, options?: __HttpHandlerOptions ): Promise; - public stopWorkspaces( - args: StopWorkspacesCommandInput, - cb: (err: any, data?: StopWorkspacesCommandOutput) => void - ): void; - public stopWorkspaces( + stopWorkspaces(args: StopWorkspacesCommandInput, cb: (err: any, data?: StopWorkspacesCommandOutput) => void): void; + stopWorkspaces( args: StopWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopWorkspacesCommandOutput) => void ): void; - public stopWorkspaces( - args: StopWorkspacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StopWorkspacesCommandOutput) => void), - cb?: (err: any, data?: StopWorkspacesCommandOutput) => void - ): Promise | void { - const command = new StopWorkspacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Terminates the specified WorkSpaces.

- * - *

Terminating a WorkSpace is a permanent action and cannot be undone. The user's data - * is destroyed. If you need to archive any user data, contact Amazon Web Services Support before - * terminating the WorkSpace.

- *
- *

You can terminate a WorkSpace that is in any state except SUSPENDED.

- *

This operation is asynchronous and returns before the WorkSpaces have been completely - * terminated. After a WorkSpace is terminated, the TERMINATED state is returned - * only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely - * returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using - * - * DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has - * been successfully terminated.

- * - *

Simple AD and AD Connector are made available to you free of charge to use with - * WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector - * directory for 30 consecutive days, this directory will be automatically deregistered for - * use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing - * terms.

- *

To delete empty directories, see Delete the - * Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector - * directory, you can always create a new one when you want to start using WorkSpaces - * again.

- *
- */ - public terminateWorkspaces( + + /** + * @see {@link TerminateWorkspacesCommand} + */ + terminateWorkspaces( args: TerminateWorkspacesCommandInput, options?: __HttpHandlerOptions ): Promise; - public terminateWorkspaces( + terminateWorkspaces( args: TerminateWorkspacesCommandInput, cb: (err: any, data?: TerminateWorkspacesCommandOutput) => void ): void; - public terminateWorkspaces( + terminateWorkspaces( args: TerminateWorkspacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TerminateWorkspacesCommandOutput) => void ): void; - public terminateWorkspaces( - args: TerminateWorkspacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TerminateWorkspacesCommandOutput) => void), - cb?: (err: any, data?: TerminateWorkspacesCommandOutput) => void - ): Promise | void { - const command = new TerminateWorkspacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a Amazon Connect client add-in. Use this action to update the name and - * endpoint URL of a Amazon Connect client add-in.

- */ - public updateConnectClientAddIn( + + /** + * @see {@link UpdateConnectClientAddInCommand} + */ + updateConnectClientAddIn( args: UpdateConnectClientAddInCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConnectClientAddIn( + updateConnectClientAddIn( args: UpdateConnectClientAddInCommandInput, cb: (err: any, data?: UpdateConnectClientAddInCommandOutput) => void ): void; - public updateConnectClientAddIn( + updateConnectClientAddIn( args: UpdateConnectClientAddInCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectClientAddInCommandOutput) => void ): void; - public updateConnectClientAddIn( - args: UpdateConnectClientAddInCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConnectClientAddInCommandOutput) => void), - cb?: (err: any, data?: UpdateConnectClientAddInCommandOutput) => void - ): Promise | void { - const command = new UpdateConnectClientAddInCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Shares or unshares a connection alias with one account by specifying whether that - * account has permission to associate the connection alias with a directory. If the - * association permission is granted, the connection alias is shared with that account. If the - * association permission is revoked, the connection alias is unshared with the account. For - * more information, see Cross-Region - * Redirection for Amazon WorkSpaces.

- * - *
    - *
  • - *

    Before performing this operation, call - * DescribeConnectionAliases to make sure that the current state of the - * connection alias is CREATED.

    - *
  • - *
  • - *

    To delete a connection alias that has been shared, the shared account must - * first disassociate the connection alias from any directories it has been - * associated with. Then you must unshare the connection alias from the account it - * has been shared with. You can delete a connection alias only after it is no longer - * shared with any accounts or associated with any directories.

    - *
  • - *
- *
- */ - public updateConnectionAliasPermission( + + /** + * @see {@link UpdateConnectionAliasPermissionCommand} + */ + updateConnectionAliasPermission( args: UpdateConnectionAliasPermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateConnectionAliasPermission( + updateConnectionAliasPermission( args: UpdateConnectionAliasPermissionCommandInput, cb: (err: any, data?: UpdateConnectionAliasPermissionCommandOutput) => void ): void; - public updateConnectionAliasPermission( + updateConnectionAliasPermission( args: UpdateConnectionAliasPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateConnectionAliasPermissionCommandOutput) => void ): void; - public updateConnectionAliasPermission( - args: UpdateConnectionAliasPermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateConnectionAliasPermissionCommandOutput) => void), - cb?: (err: any, data?: UpdateConnectionAliasPermissionCommandOutput) => void - ): Promise | void { - const command = new UpdateConnectionAliasPermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Replaces the current rules of the specified IP access control group with the specified - * rules.

- */ - public updateRulesOfIpGroup( + + /** + * @see {@link UpdateRulesOfIpGroupCommand} + */ + updateRulesOfIpGroup( args: UpdateRulesOfIpGroupCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateRulesOfIpGroup( + updateRulesOfIpGroup( args: UpdateRulesOfIpGroupCommandInput, cb: (err: any, data?: UpdateRulesOfIpGroupCommandOutput) => void ): void; - public updateRulesOfIpGroup( + updateRulesOfIpGroup( args: UpdateRulesOfIpGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRulesOfIpGroupCommandOutput) => void ): void; - public updateRulesOfIpGroup( - args: UpdateRulesOfIpGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRulesOfIpGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateRulesOfIpGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateRulesOfIpGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see - * - * Update a Custom WorkSpaces Bundle.

- * - *

Existing WorkSpaces aren't automatically updated when you update the bundle that they're - * based on. To update existing WorkSpaces that are based on a bundle that you've updated, you - * must either rebuild the WorkSpaces or delete and recreate them.

- *
- */ - public updateWorkspaceBundle( + + /** + * @see {@link UpdateWorkspaceBundleCommand} + */ + updateWorkspaceBundle( args: UpdateWorkspaceBundleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWorkspaceBundle( + updateWorkspaceBundle( args: UpdateWorkspaceBundleCommandInput, cb: (err: any, data?: UpdateWorkspaceBundleCommandOutput) => void ): void; - public updateWorkspaceBundle( + updateWorkspaceBundle( args: UpdateWorkspaceBundleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkspaceBundleCommandOutput) => void ): void; - public updateWorkspaceBundle( - args: UpdateWorkspaceBundleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWorkspaceBundleCommandOutput) => void), - cb?: (err: any, data?: UpdateWorkspaceBundleCommandOutput) => void - ): Promise | void { - const command = new UpdateWorkspaceBundleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - *

Shares or unshares an image with one account in the same Amazon Web Services Region by - * specifying whether that account has permission to copy the image. If the copy image - * permission is granted, the image is shared with that account. If the copy image permission - * is revoked, the image is unshared with the account.

- *

After an image has been shared, the recipient account can copy the image to other - * Regions as needed.

- *

In the China (Ningxia) Region, you can copy images only within the same Region.

- *

In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.

- *

For more information about sharing images, see Share or Unshare a Custom - * WorkSpaces Image.

- * - *
    - *
  • - *

    To delete an image that has been shared, you must unshare the image before you - * delete it.

    - *
  • - *
  • - *

    Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts - * isn't supported at this time in Amazon Web Services GovCloud (US). To share BYOL images - * across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.

    - *
  • - *
- *
- */ - public updateWorkspaceImagePermission( + + /** + * @see {@link UpdateWorkspaceImagePermissionCommand} + */ + updateWorkspaceImagePermission( args: UpdateWorkspaceImagePermissionCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateWorkspaceImagePermission( + updateWorkspaceImagePermission( args: UpdateWorkspaceImagePermissionCommandInput, cb: (err: any, data?: UpdateWorkspaceImagePermissionCommandOutput) => void ): void; - public updateWorkspaceImagePermission( + updateWorkspaceImagePermission( args: UpdateWorkspaceImagePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkspaceImagePermissionCommandOutput) => void ): void; - public updateWorkspaceImagePermission( - args: UpdateWorkspaceImagePermissionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateWorkspaceImagePermissionCommandOutput) => void), - cb?: (err: any, data?: UpdateWorkspaceImagePermissionCommandOutput) => void - ): Promise | void { - const command = new UpdateWorkspaceImagePermissionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * Amazon WorkSpaces Service + *

Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows + * or Amazon Linux desktops for your users, known as WorkSpaces. + * WorkSpaces eliminates the need to procure and deploy hardware or install complex + * software. You can quickly add or remove users as your needs change. Users can access their + * virtual desktops from multiple devices or web browsers.

+ *

This API Reference provides detailed information about the actions, data types, + * parameters, and errors of the WorkSpaces service. For more information about the + * supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas in the Amazon Web Services + * General Reference.

+ *

You can also manage your WorkSpaces resources using the WorkSpaces + * console, Command Line Interface (CLI), and SDKs. For more information about + * administering WorkSpaces, see the Amazon WorkSpaces Administration Guide. + * For more information about using the Amazon WorkSpaces client application or web + * browser to access provisioned WorkSpaces, see the Amazon WorkSpaces User Guide. For more + * information about using the CLI to manage your WorkSpaces resources, + * see the WorkSpaces section of the CLI Reference.

+ */ +export class WorkSpaces extends WorkSpacesClient implements WorkSpaces {} +createAggregatedClient(commands, WorkSpaces); diff --git a/clients/client-xray/src/XRay.ts b/clients/client-xray/src/XRay.ts index 2ed15034fd8a..a01e86afe25d 100644 --- a/clients/client-xray/src/XRay.ts +++ b/clients/client-xray/src/XRay.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -123,1062 +124,497 @@ import { UpdateSamplingRuleCommandInput, UpdateSamplingRuleCommandOutput, } from "./commands/UpdateSamplingRuleCommand"; -import { XRayClient } from "./XRayClient"; +import { XRayClient, XRayClientConfig } from "./XRayClient"; -/** - * @public - *

Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps - * and other data created by processing those traces.

- */ -export class XRay extends XRayClient { +const commands = { + BatchGetTracesCommand, + CreateGroupCommand, + CreateSamplingRuleCommand, + DeleteGroupCommand, + DeleteResourcePolicyCommand, + DeleteSamplingRuleCommand, + GetEncryptionConfigCommand, + GetGroupCommand, + GetGroupsCommand, + GetInsightCommand, + GetInsightEventsCommand, + GetInsightImpactGraphCommand, + GetInsightSummariesCommand, + GetSamplingRulesCommand, + GetSamplingStatisticSummariesCommand, + GetSamplingTargetsCommand, + GetServiceGraphCommand, + GetTimeSeriesServiceStatisticsCommand, + GetTraceGraphCommand, + GetTraceSummariesCommand, + ListResourcePoliciesCommand, + ListTagsForResourceCommand, + PutEncryptionConfigCommand, + PutResourcePolicyCommand, + PutTelemetryRecordsCommand, + PutTraceSegmentsCommand, + TagResourceCommand, + UntagResourceCommand, + UpdateGroupCommand, + UpdateSamplingRuleCommand, +}; + +export interface XRay { /** - * @public - *

Retrieves a list of traces specified by ID. Each trace is a collection of segment - * documents that originates from a single request. Use GetTraceSummaries to get a - * list of trace IDs.

+ * @see {@link BatchGetTracesCommand} */ - public batchGetTraces( + batchGetTraces( args: BatchGetTracesCommandInput, options?: __HttpHandlerOptions ): Promise; - public batchGetTraces( - args: BatchGetTracesCommandInput, - cb: (err: any, data?: BatchGetTracesCommandOutput) => void - ): void; - public batchGetTraces( + batchGetTraces(args: BatchGetTracesCommandInput, cb: (err: any, data?: BatchGetTracesCommandOutput) => void): void; + batchGetTraces( args: BatchGetTracesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetTracesCommandOutput) => void ): void; - public batchGetTraces( - args: BatchGetTracesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BatchGetTracesCommandOutput) => void), - cb?: (err: any, data?: BatchGetTracesCommandOutput) => void - ): Promise | void { - const command = new BatchGetTracesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a group resource with a name and a filter expression.

+ * @see {@link CreateGroupCommand} */ - public createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void; - public createGroup( + createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise; + createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void; + createGroup( args: CreateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupCommandOutput) => void ): void; - public createGroup( - args: CreateGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateGroupCommandOutput) => void), - cb?: (err: any, data?: CreateGroupCommandOutput) => void - ): Promise | void { - const command = new CreateGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Creates a rule to control sampling behavior for instrumented applications. Services - * retrieve rules with GetSamplingRules, and evaluate each rule in ascending - * order of priority for each request. If a rule matches, the service - * records a trace, borrowing it from the reservoir size. After 10 seconds, the service - * reports back to X-Ray with GetSamplingTargets to get updated versions of - * each in-use rule. The updated rule contains a trace quota that the service can use instead - * of borrowing from the reservoir.

+ * @see {@link CreateSamplingRuleCommand} */ - public createSamplingRule( + createSamplingRule( args: CreateSamplingRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public createSamplingRule( + createSamplingRule( args: CreateSamplingRuleCommandInput, cb: (err: any, data?: CreateSamplingRuleCommandOutput) => void ): void; - public createSamplingRule( + createSamplingRule( args: CreateSamplingRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSamplingRuleCommandOutput) => void ): void; - public createSamplingRule( - args: CreateSamplingRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: CreateSamplingRuleCommandOutput) => void), - cb?: (err: any, data?: CreateSamplingRuleCommandOutput) => void - ): Promise | void { - const command = new CreateSamplingRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a group resource.

+ * @see {@link DeleteGroupCommand} */ - public deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void; - public deleteGroup( + deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise; + deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void; + deleteGroup( args: DeleteGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupCommandOutput) => void ): void; - public deleteGroup( - args: DeleteGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteGroupCommandOutput) => void), - cb?: (err: any, data?: DeleteGroupCommandOutput) => void - ): Promise | void { - const command = new DeleteGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a resource policy from the target Amazon Web Services account.

+ * @see {@link DeleteResourcePolicyCommand} */ - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( + deleteResourcePolicy( args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void ): void; - public deleteResourcePolicy( - args: DeleteResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: DeleteResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new DeleteResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Deletes a sampling rule.

+ * @see {@link DeleteSamplingRuleCommand} */ - public deleteSamplingRule( + deleteSamplingRule( args: DeleteSamplingRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public deleteSamplingRule( + deleteSamplingRule( args: DeleteSamplingRuleCommandInput, cb: (err: any, data?: DeleteSamplingRuleCommandOutput) => void ): void; - public deleteSamplingRule( + deleteSamplingRule( args: DeleteSamplingRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSamplingRuleCommandOutput) => void ): void; - public deleteSamplingRule( - args: DeleteSamplingRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteSamplingRuleCommandOutput) => void), - cb?: (err: any, data?: DeleteSamplingRuleCommandOutput) => void - ): Promise | void { - const command = new DeleteSamplingRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the current encryption configuration for X-Ray data.

+ * @see {@link GetEncryptionConfigCommand} */ - public getEncryptionConfig( + getEncryptionConfig( args: GetEncryptionConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public getEncryptionConfig( + getEncryptionConfig( args: GetEncryptionConfigCommandInput, cb: (err: any, data?: GetEncryptionConfigCommandOutput) => void ): void; - public getEncryptionConfig( + getEncryptionConfig( args: GetEncryptionConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEncryptionConfigCommandOutput) => void ): void; - public getEncryptionConfig( - args: GetEncryptionConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetEncryptionConfigCommandOutput) => void), - cb?: (err: any, data?: GetEncryptionConfigCommandOutput) => void - ): Promise | void { - const command = new GetEncryptionConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves group resource details.

+ * @see {@link GetGroupCommand} */ - public getGroup(args: GetGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public getGroup(args: GetGroupCommandInput, cb: (err: any, data?: GetGroupCommandOutput) => void): void; - public getGroup( + getGroup(args: GetGroupCommandInput, options?: __HttpHandlerOptions): Promise; + getGroup(args: GetGroupCommandInput, cb: (err: any, data?: GetGroupCommandOutput) => void): void; + getGroup( args: GetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupCommandOutput) => void ): void; - public getGroup( - args: GetGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGroupCommandOutput) => void), - cb?: (err: any, data?: GetGroupCommandOutput) => void - ): Promise | void { - const command = new GetGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves all active group details.

+ * @see {@link GetGroupsCommand} */ - public getGroups(args: GetGroupsCommandInput, options?: __HttpHandlerOptions): Promise; - public getGroups(args: GetGroupsCommandInput, cb: (err: any, data?: GetGroupsCommandOutput) => void): void; - public getGroups( + getGroups(args: GetGroupsCommandInput, options?: __HttpHandlerOptions): Promise; + getGroups(args: GetGroupsCommandInput, cb: (err: any, data?: GetGroupsCommandOutput) => void): void; + getGroups( args: GetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupsCommandOutput) => void ): void; - public getGroups( - args: GetGroupsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetGroupsCommandOutput) => void), - cb?: (err: any, data?: GetGroupsCommandOutput) => void - ): Promise | void { - const command = new GetGroupsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the summary information of an insight. This includes impact to clients and - * root cause services, the top anomalous services, the category, the state of the insight, - * and the start and end time of the insight.

+ * @see {@link GetInsightCommand} */ - public getInsight(args: GetInsightCommandInput, options?: __HttpHandlerOptions): Promise; - public getInsight(args: GetInsightCommandInput, cb: (err: any, data?: GetInsightCommandOutput) => void): void; - public getInsight( + getInsight(args: GetInsightCommandInput, options?: __HttpHandlerOptions): Promise; + getInsight(args: GetInsightCommandInput, cb: (err: any, data?: GetInsightCommandOutput) => void): void; + getInsight( args: GetInsightCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInsightCommandOutput) => void ): void; - public getInsight( - args: GetInsightCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInsightCommandOutput) => void), - cb?: (err: any, data?: GetInsightCommandOutput) => void - ): Promise | void { - const command = new GetInsightCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an - * event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray - * console.

+ * @see {@link GetInsightEventsCommand} */ - public getInsightEvents( + getInsightEvents( args: GetInsightEventsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInsightEvents( + getInsightEvents( args: GetInsightEventsCommandInput, cb: (err: any, data?: GetInsightEventsCommandOutput) => void ): void; - public getInsightEvents( + getInsightEvents( args: GetInsightEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInsightEventsCommandOutput) => void ): void; - public getInsightEvents( - args: GetInsightEventsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInsightEventsCommandOutput) => void), - cb?: (err: any, data?: GetInsightEventsCommandOutput) => void - ): Promise | void { - const command = new GetInsightEventsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only - * structural information. For a complete service graph, use this API with the GetServiceGraph API.

+ * @see {@link GetInsightImpactGraphCommand} */ - public getInsightImpactGraph( + getInsightImpactGraph( args: GetInsightImpactGraphCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInsightImpactGraph( + getInsightImpactGraph( args: GetInsightImpactGraphCommandInput, cb: (err: any, data?: GetInsightImpactGraphCommandOutput) => void ): void; - public getInsightImpactGraph( + getInsightImpactGraph( args: GetInsightImpactGraphCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInsightImpactGraphCommandOutput) => void ): void; - public getInsightImpactGraph( - args: GetInsightImpactGraphCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInsightImpactGraphCommandOutput) => void), - cb?: (err: any, data?: GetInsightImpactGraphCommandOutput) => void - ): Promise | void { - const command = new GetInsightImpactGraphCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves the summaries of all insights in the specified group matching the provided filter values.

+ * @see {@link GetInsightSummariesCommand} */ - public getInsightSummaries( + getInsightSummaries( args: GetInsightSummariesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getInsightSummaries( + getInsightSummaries( args: GetInsightSummariesCommandInput, cb: (err: any, data?: GetInsightSummariesCommandOutput) => void ): void; - public getInsightSummaries( + getInsightSummaries( args: GetInsightSummariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInsightSummariesCommandOutput) => void ): void; - public getInsightSummaries( - args: GetInsightSummariesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetInsightSummariesCommandOutput) => void), - cb?: (err: any, data?: GetInsightSummariesCommandOutput) => void - ): Promise | void { - const command = new GetInsightSummariesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves all sampling rules.

+ * @see {@link GetSamplingRulesCommand} */ - public getSamplingRules( + getSamplingRules( args: GetSamplingRulesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSamplingRules( + getSamplingRules( args: GetSamplingRulesCommandInput, cb: (err: any, data?: GetSamplingRulesCommandOutput) => void ): void; - public getSamplingRules( + getSamplingRules( args: GetSamplingRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSamplingRulesCommandOutput) => void ): void; - public getSamplingRules( - args: GetSamplingRulesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSamplingRulesCommandOutput) => void), - cb?: (err: any, data?: GetSamplingRulesCommandOutput) => void - ): Promise | void { - const command = new GetSamplingRulesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves information about recent sampling results for all sampling rules.

+ * @see {@link GetSamplingStatisticSummariesCommand} */ - public getSamplingStatisticSummaries( + getSamplingStatisticSummaries( args: GetSamplingStatisticSummariesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSamplingStatisticSummaries( + getSamplingStatisticSummaries( args: GetSamplingStatisticSummariesCommandInput, cb: (err: any, data?: GetSamplingStatisticSummariesCommandOutput) => void ): void; - public getSamplingStatisticSummaries( + getSamplingStatisticSummaries( args: GetSamplingStatisticSummariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSamplingStatisticSummariesCommandOutput) => void ): void; - public getSamplingStatisticSummaries( - args: GetSamplingStatisticSummariesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSamplingStatisticSummariesCommandOutput) => void), - cb?: (err: any, data?: GetSamplingStatisticSummariesCommandOutput) => void - ): Promise | void { - const command = new GetSamplingStatisticSummariesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Requests a sampling quota for rules that the service is using to sample requests. - *

+ * @see {@link GetSamplingTargetsCommand} */ - public getSamplingTargets( + getSamplingTargets( args: GetSamplingTargetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getSamplingTargets( + getSamplingTargets( args: GetSamplingTargetsCommandInput, cb: (err: any, data?: GetSamplingTargetsCommandOutput) => void ): void; - public getSamplingTargets( + getSamplingTargets( args: GetSamplingTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSamplingTargetsCommandOutput) => void ): void; - public getSamplingTargets( - args: GetSamplingTargetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetSamplingTargetsCommandOutput) => void), - cb?: (err: any, data?: GetSamplingTargetsCommandOutput) => void - ): Promise | void { - const command = new GetSamplingTargetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a document that describes services that process incoming requests, and - * downstream services that they call as a result. Root services process incoming requests and - * make calls to downstream services. Root services are applications that use the Amazon Web Services X-Ray SDK. - * Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL - * databases.

+ * @see {@link GetServiceGraphCommand} */ - public getServiceGraph( + getServiceGraph( args: GetServiceGraphCommandInput, options?: __HttpHandlerOptions ): Promise; - public getServiceGraph( - args: GetServiceGraphCommandInput, - cb: (err: any, data?: GetServiceGraphCommandOutput) => void - ): void; - public getServiceGraph( + getServiceGraph(args: GetServiceGraphCommandInput, cb: (err: any, data?: GetServiceGraphCommandOutput) => void): void; + getServiceGraph( args: GetServiceGraphCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceGraphCommandOutput) => void ): void; - public getServiceGraph( - args: GetServiceGraphCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetServiceGraphCommandOutput) => void), - cb?: (err: any, data?: GetServiceGraphCommandOutput) => void - ): Promise | void { - const command = new GetServiceGraphCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Get an aggregation of service statistics defined by a specific time - * range.

+ * @see {@link GetTimeSeriesServiceStatisticsCommand} */ - public getTimeSeriesServiceStatistics( + getTimeSeriesServiceStatistics( args: GetTimeSeriesServiceStatisticsCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTimeSeriesServiceStatistics( + getTimeSeriesServiceStatistics( args: GetTimeSeriesServiceStatisticsCommandInput, cb: (err: any, data?: GetTimeSeriesServiceStatisticsCommandOutput) => void ): void; - public getTimeSeriesServiceStatistics( + getTimeSeriesServiceStatistics( args: GetTimeSeriesServiceStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTimeSeriesServiceStatisticsCommandOutput) => void ): void; - public getTimeSeriesServiceStatistics( - args: GetTimeSeriesServiceStatisticsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTimeSeriesServiceStatisticsCommandOutput) => void), - cb?: (err: any, data?: GetTimeSeriesServiceStatisticsCommandOutput) => void - ): Promise | void { - const command = new GetTimeSeriesServiceStatisticsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves a service graph for one or more specific trace IDs.

+ * @see {@link GetTraceGraphCommand} */ - public getTraceGraph( - args: GetTraceGraphCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public getTraceGraph( - args: GetTraceGraphCommandInput, - cb: (err: any, data?: GetTraceGraphCommandOutput) => void - ): void; - public getTraceGraph( + getTraceGraph(args: GetTraceGraphCommandInput, options?: __HttpHandlerOptions): Promise; + getTraceGraph(args: GetTraceGraphCommandInput, cb: (err: any, data?: GetTraceGraphCommandOutput) => void): void; + getTraceGraph( args: GetTraceGraphCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTraceGraphCommandOutput) => void ): void; - public getTraceGraph( - args: GetTraceGraphCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTraceGraphCommandOutput) => void), - cb?: (err: any, data?: GetTraceGraphCommandOutput) => void - ): Promise | void { - const command = new GetTraceGraphCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Retrieves IDs and annotations for traces available for a specified time frame using an - * optional filter. To get the full traces, pass the trace IDs to - * BatchGetTraces.

- *

A filter expression can target traced requests that hit specific service nodes or - * edges, have errors, or come from a known user. For example, the following filter expression - * targets traces that pass through api.example.com:

- *

- * service("api.example.com") - *

- *

This filter expression finds traces that have an annotation named account - * with the value 12345:

- *

- * annotation.account = "12345" - *

- *

For a full list of indexed fields and keywords that you can use in filter expressions, - * see Using Filter - * Expressions in the Amazon Web Services X-Ray Developer Guide.

+ * @see {@link GetTraceSummariesCommand} */ - public getTraceSummaries( + getTraceSummaries( args: GetTraceSummariesCommandInput, options?: __HttpHandlerOptions ): Promise; - public getTraceSummaries( + getTraceSummaries( args: GetTraceSummariesCommandInput, cb: (err: any, data?: GetTraceSummariesCommandOutput) => void ): void; - public getTraceSummaries( + getTraceSummaries( args: GetTraceSummariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTraceSummariesCommandOutput) => void ): void; - public getTraceSummaries( - args: GetTraceSummariesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTraceSummariesCommandOutput) => void), - cb?: (err: any, data?: GetTraceSummariesCommandOutput) => void - ): Promise | void { - const command = new GetTraceSummariesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns the list of resource policies in the target Amazon Web Services account.

+ * @see {@link ListResourcePoliciesCommand} */ - public listResourcePolicies( + listResourcePolicies( args: ListResourcePoliciesCommandInput, options?: __HttpHandlerOptions ): Promise; - public listResourcePolicies( + listResourcePolicies( args: ListResourcePoliciesCommandInput, cb: (err: any, data?: ListResourcePoliciesCommandOutput) => void ): void; - public listResourcePolicies( + listResourcePolicies( args: ListResourcePoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourcePoliciesCommandOutput) => void ): void; - public listResourcePolicies( - args: ListResourcePoliciesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourcePoliciesCommandOutput) => void), - cb?: (err: any, data?: ListResourcePoliciesCommandOutput) => void - ): Promise | void { - const command = new ListResourcePoliciesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.

+ * @see {@link ListTagsForResourceCommand} */ - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions ): Promise; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( + listTagsForResource( args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void ): void; - public listTagsForResource( - args: ListTagsForResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTagsForResourceCommandOutput) => void), - cb?: (err: any, data?: ListTagsForResourceCommandOutput) => void - ): Promise | void { - const command = new ListTagsForResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates the encryption configuration for X-Ray data.

+ * @see {@link PutEncryptionConfigCommand} */ - public putEncryptionConfig( + putEncryptionConfig( args: PutEncryptionConfigCommandInput, options?: __HttpHandlerOptions ): Promise; - public putEncryptionConfig( + putEncryptionConfig( args: PutEncryptionConfigCommandInput, cb: (err: any, data?: PutEncryptionConfigCommandOutput) => void ): void; - public putEncryptionConfig( + putEncryptionConfig( args: PutEncryptionConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEncryptionConfigCommandOutput) => void ): void; - public putEncryptionConfig( - args: PutEncryptionConfigCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutEncryptionConfigCommandOutput) => void), - cb?: (err: any, data?: PutEncryptionConfigCommandOutput) => void - ): Promise | void { - const command = new PutEncryptionConfigCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

- * Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to - * access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account. - * Each Amazon Web Services account can have a maximum of 5 resource policies, and each policy name must be - * unique within that account. The maximum size of each resource policy is 5KB. - *

+ * @see {@link PutResourcePolicyCommand} */ - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions ): Promise; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( + putResourcePolicy( args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void ): void; - public putResourcePolicy( - args: PutResourcePolicyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourcePolicyCommandOutput) => void), - cb?: (err: any, data?: PutResourcePolicyCommandOutput) => void - ): Promise | void { - const command = new PutResourcePolicyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Used by the Amazon Web Services X-Ray daemon to upload telemetry.

+ * @see {@link PutTelemetryRecordsCommand} */ - public putTelemetryRecords( + putTelemetryRecords( args: PutTelemetryRecordsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putTelemetryRecords( + putTelemetryRecords( args: PutTelemetryRecordsCommandInput, cb: (err: any, data?: PutTelemetryRecordsCommandOutput) => void ): void; - public putTelemetryRecords( + putTelemetryRecords( args: PutTelemetryRecordsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutTelemetryRecordsCommandOutput) => void ): void; - public putTelemetryRecords( - args: PutTelemetryRecordsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutTelemetryRecordsCommandOutput) => void), - cb?: (err: any, data?: PutTelemetryRecordsCommandOutput) => void - ): Promise | void { - const command = new PutTelemetryRecordsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Uploads segment documents to Amazon Web Services X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray daemon, which uploads them in - * batches. A segment document can be a completed segment, an in-progress segment, or an array of - * subsegments.

- *

Segments must include the following fields. For the full segment document schema, see - * Amazon Web Services X-Ray - * Segment Documents in the Amazon Web Services X-Ray Developer Guide.

- *

- * Required segment document fields - *

- *
    - *
  • - *

    - * name - The name of the service that handled the request.

    - *
  • - *
  • - *

    - * id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 - * hexadecimal digits.

    - *
  • - *
  • - *

    - * trace_id - A unique identifier that connects all segments and subsegments originating from - * a single client request.

    - *
  • - *
  • - *

    - * start_time - Time the segment or subsegment was created, in floating point seconds in - * epoch time, accurate to milliseconds. For example, 1480615200.010 or - * 1.480615200010E9.

    - *
  • - *
  • - *

    - * end_time - Time the segment or subsegment was closed. For example, - * 1480615200.090 or 1.480615200090E9. Specify either an end_time or - * in_progress.

    - *
  • - *
  • - *

    - * in_progress - Set to true instead of specifying an end_time to - * record that a segment has been started, but is not complete. Send an in-progress segment when your application - * receives a request that will take a long time to serve, to trace that the request was received. When the - * response is sent, send the complete segment to overwrite the in-progress segment.

    - *
  • - *
- *

A trace_id consists of three numbers separated by hyphens. For example, - * 1-58406520-a006649127e371903a2de979. This includes:

- *

- * Trace ID Format - *

- *
    - *
  • - *

    The version number, for instance, 1.

    - *
  • - *
  • - *

    The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For - * example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200 seconds, - * or 58406520 in hexadecimal.

    - *
  • - *
  • - *

    A 96-bit identifier for the trace, globally unique, in 24 hexadecimal - * digits.

    - *
  • - *
+ * @see {@link PutTraceSegmentsCommand} */ - public putTraceSegments( + putTraceSegments( args: PutTraceSegmentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putTraceSegments( + putTraceSegments( args: PutTraceSegmentsCommandInput, cb: (err: any, data?: PutTraceSegmentsCommandOutput) => void ): void; - public putTraceSegments( + putTraceSegments( args: PutTraceSegmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutTraceSegmentsCommandOutput) => void ): void; - public putTraceSegments( - args: PutTraceSegmentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutTraceSegmentsCommandOutput) => void), - cb?: (err: any, data?: PutTraceSegmentsCommandOutput) => void - ): Promise | void { - const command = new PutTraceSegmentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.

+ * @see {@link TagResourceCommand} */ - public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; - public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; - public tagResource( + tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; + tagResource( args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void ): void; - public tagResource( - args: TagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TagResourceCommandOutput) => void), - cb?: (err: any, data?: TagResourceCommandOutput) => void - ): Promise | void { - const command = new TagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system - * tags (those with an aws: prefix).

+ * @see {@link UntagResourceCommand} */ - public untagResource( - args: UntagResourceCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public untagResource( - args: UntagResourceCommandInput, - cb: (err: any, data?: UntagResourceCommandOutput) => void - ): void; - public untagResource( + untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; + untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; + untagResource( args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; - public untagResource( - args: UntagResourceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UntagResourceCommandOutput) => void), - cb?: (err: any, data?: UntagResourceCommandOutput) => void - ): Promise | void { - const command = new UntagResourceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Updates a group resource.

+ * @see {@link UpdateGroupCommand} */ - public updateGroup(args: UpdateGroupCommandInput, options?: __HttpHandlerOptions): Promise; - public updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void; - public updateGroup( + updateGroup(args: UpdateGroupCommandInput, options?: __HttpHandlerOptions): Promise; + updateGroup(args: UpdateGroupCommandInput, cb: (err: any, data?: UpdateGroupCommandOutput) => void): void; + updateGroup( args: UpdateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGroupCommandOutput) => void ): void; - public updateGroup( - args: UpdateGroupCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateGroupCommandOutput) => void), - cb?: (err: any, data?: UpdateGroupCommandOutput) => void - ): Promise | void { - const command = new UpdateGroupCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - *

Modifies a sampling rule's configuration.

+ * @see {@link UpdateSamplingRuleCommand} */ - public updateSamplingRule( + updateSamplingRule( args: UpdateSamplingRuleCommandInput, options?: __HttpHandlerOptions ): Promise; - public updateSamplingRule( + updateSamplingRule( args: UpdateSamplingRuleCommandInput, cb: (err: any, data?: UpdateSamplingRuleCommandOutput) => void ): void; - public updateSamplingRule( + updateSamplingRule( args: UpdateSamplingRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSamplingRuleCommandOutput) => void ): void; - public updateSamplingRule( - args: UpdateSamplingRuleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateSamplingRuleCommandOutput) => void), - cb?: (err: any, data?: UpdateSamplingRuleCommandOutput) => void - ): Promise | void { - const command = new UpdateSamplingRuleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + *

Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps + * and other data created by processing those traces.

+ */ +export class XRay extends XRayClient implements XRay {} +createAggregatedClient(commands, XRay); diff --git a/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/JsonShapeDeserVisitor.java b/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/JsonShapeDeserVisitor.java index 6afd053be8b7..006db0ee7ec0 100644 --- a/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/JsonShapeDeserVisitor.java +++ b/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/JsonShapeDeserVisitor.java @@ -300,4 +300,4 @@ protected void deserializeUnion(GenerationContext context, UnionShape shape) { // Or write to the unknown member the element in the output. writer.write("return { $$unknown: Object.entries(output)[0] };"); } -} \ No newline at end of file +} diff --git a/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/JsonShapeSerVisitor.java b/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/JsonShapeSerVisitor.java index 23f954988658..482286f5b87f 100644 --- a/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/JsonShapeSerVisitor.java +++ b/codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/JsonShapeSerVisitor.java @@ -165,7 +165,8 @@ public void serializeStructure(GenerationContext context, StructureShape shape) if (valueProvider.equals("_ => _")) { writer.write("'$L': [,,`$L`],", wireName, memberName); } else if (isUnaryCall) { - writer.write("'$L': [,$L,`$L`],", wireName, UnaryFunctionCall.toRef(valueExpression), memberName); + writer.write("'$L': [,$L,`$L`],", wireName, + UnaryFunctionCall.toRef(valueExpression), memberName); } else { writer.write("'$L': [,$L,`$L`],", wireName, valueProvider, memberName); } diff --git a/packages/smithy-client/src/create-aggregated-client.spec.ts b/packages/smithy-client/src/create-aggregated-client.spec.ts new file mode 100644 index 000000000000..b0ea19c6eaea --- /dev/null +++ b/packages/smithy-client/src/create-aggregated-client.spec.ts @@ -0,0 +1,61 @@ +import { createAggregatedClient } from "./create-aggregated-client"; + +class BaseClient { + send = jest.fn() as any; +} +class AggregatedClient extends BaseClient { + constructor(commands) { + super(); + createAggregatedClient(commands, AggregatedClient as any); + } +} +class UserClient extends AggregatedClient {} + +describe(createAggregatedClient.name, () => { + it("extends its base client", async () => { + const commands = { + ActionCommand: jest.fn(), + }; + + const aggregatedClient: any = new AggregatedClient(commands); + + expect(aggregatedClient).toBeInstanceOf(BaseClient); + expect(aggregatedClient).toBeInstanceOf(AggregatedClient); + }); + + it("is extensible", async () => { + const commands = { + ActionCommand: jest.fn(), + }; + + const aggregatedClient: any = new UserClient(commands); + + expect(aggregatedClient).toBeInstanceOf(UserClient); + expect(aggregatedClient).toBeInstanceOf(AggregatedClient); + expect(aggregatedClient).toBeInstanceOf(BaseClient); + }); + + it("should dispatch using the command lookup", async () => { + const commands = { + ActionCommand: jest.fn(), + }; + const aggregatedClient: any = new AggregatedClient(commands); + + expect(() => aggregatedClient.nonExistentMethod()).toThrow(); + expect(() => aggregatedClient.action()).not.toThrow(); + + expect(typeof aggregatedClient.action).toBe("function"); + }); + + it("should call send with the matching command", async () => { + const commands = { + ActionCommand: jest.fn(), + }; + const aggregatedClient: any = new AggregatedClient(commands); + + await aggregatedClient.action({ a: "a" }); + + expect(commands.ActionCommand).toHaveBeenCalledWith({ a: "a" }); + expect(aggregatedClient.send).toHaveBeenCalled(); + }); +}); diff --git a/packages/smithy-client/src/create-aggregated-client.ts b/packages/smithy-client/src/create-aggregated-client.ts new file mode 100644 index 000000000000..4b38851ea68b --- /dev/null +++ b/packages/smithy-client/src/create-aggregated-client.ts @@ -0,0 +1,30 @@ +import { Client } from "./client"; + +/** + * @internal + * + * @param commands - command lookup container. + * @param client - client instance on which to add aggregated methods. + * @returns an aggregated client with dynamically created methods. + */ +export const createAggregatedClient = ( + commands: Record, + Client: { new (...args: any): Client } +): void => { + for (const command of Object.keys(commands)) { + const CommandCtor = commands[command]; + const methodImpl = async function (this: InstanceType, args: any, optionsOrCb: any, cb: any) { + const command: any = new CommandCtor(args); + if (typeof optionsOrCb === "function") { + this.send(command, optionsOrCb); + } else if (typeof cb === "function") { + if (typeof optionsOrCb !== "object") throw new Error(`Expected http options but got ${typeof optionsOrCb}`); + this.send(command, optionsOrCb || {}, cb); + } else { + return this.send(command, optionsOrCb); + } + }; + const methodName = (command[0].toLowerCase() + command.slice(1)).replace(/Command$/, ""); + Client.prototype[methodName] = methodImpl; + } +}; diff --git a/packages/smithy-client/src/index.ts b/packages/smithy-client/src/index.ts index 7828236d3647..344c64f9d147 100644 --- a/packages/smithy-client/src/index.ts +++ b/packages/smithy-client/src/index.ts @@ -2,6 +2,7 @@ export * from "./NoOpLogger"; export * from "./client"; export * from "./command"; export * from "./constants"; +export * from "./create-aggregated-client"; export * from "./date-utils"; export * from "./default-error-handler"; export * from "./defaults-mode"; diff --git a/private/aws-echo-service/src/EchoService.ts b/private/aws-echo-service/src/EchoService.ts index 36383c282b99..4a6d8fce1535 100644 --- a/private/aws-echo-service/src/EchoService.ts +++ b/private/aws-echo-service/src/EchoService.ts @@ -1,62 +1,37 @@ // smithy-typescript generated code -import { EchoServiceClient } from "./EchoServiceClient"; +import { EchoServiceClient, EchoServiceClientConfig } from "./EchoServiceClient"; import { EchoCommand, EchoCommandInput, EchoCommandOutput } from "./commands/EchoCommand"; import { LengthCommand, LengthCommandInput, LengthCommandOutput } from "./commands/LengthCommand"; +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; -/** - * @public - */ -export class EchoService extends EchoServiceClient { +const commands = { + EchoCommand, + LengthCommand, +}; + +export interface EchoService { /** - * @public + * @see {@link EchoCommand} */ - public echo(args: EchoCommandInput, options?: __HttpHandlerOptions): Promise; - public echo(args: EchoCommandInput, cb: (err: any, data?: EchoCommandOutput) => void): void; - public echo( - args: EchoCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: EchoCommandOutput) => void - ): void; - public echo( - args: EchoCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EchoCommandOutput) => void), - cb?: (err: any, data?: EchoCommandOutput) => void - ): Promise | void { - const command = new EchoCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } + echo(args: EchoCommandInput, options?: __HttpHandlerOptions): Promise; + echo(args: EchoCommandInput, cb: (err: any, data?: EchoCommandOutput) => void): void; + echo(args: EchoCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EchoCommandOutput) => void): void; /** - * @public + * @see {@link LengthCommand} */ - public length(args: LengthCommandInput, options?: __HttpHandlerOptions): Promise; - public length(args: LengthCommandInput, cb: (err: any, data?: LengthCommandOutput) => void): void; - public length( + length(args: LengthCommandInput, options?: __HttpHandlerOptions): Promise; + length(args: LengthCommandInput, cb: (err: any, data?: LengthCommandOutput) => void): void; + length( args: LengthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: LengthCommandOutput) => void ): void; - public length( - args: LengthCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: LengthCommandOutput) => void), - cb?: (err: any, data?: LengthCommandOutput) => void - ): Promise | void { - const command = new LengthCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + */ +export class EchoService extends EchoServiceClient implements EchoService {} +createAggregatedClient(commands, EchoService); diff --git a/private/aws-protocoltests-ec2/src/EC2Protocol.ts b/private/aws-protocoltests-ec2/src/EC2Protocol.ts index 010d4e9c4b50..3d3c2e618011 100644 --- a/private/aws-protocoltests-ec2/src/EC2Protocol.ts +++ b/private/aws-protocoltests-ec2/src/EC2Protocol.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -101,791 +102,388 @@ import { XmlTimestampsCommandInput, XmlTimestampsCommandOutput, } from "./commands/XmlTimestampsCommand"; -import { EC2ProtocolClient } from "./EC2ProtocolClient"; +import { EC2ProtocolClient, EC2ProtocolClientConfig } from "./EC2ProtocolClient"; -/** - * @public - * An EC2 query service that sends query requests and XML responses. - */ -export class EC2Protocol extends EC2ProtocolClient { +const commands = { + DatetimeOffsetsCommand, + EmptyInputAndEmptyOutputCommand, + EndpointOperationCommand, + EndpointWithHostLabelOperationCommand, + FractionalSecondsCommand, + GreetingWithErrorsCommand, + HostWithPathOperationCommand, + IgnoresWrappingXmlNameCommand, + NestedStructuresCommand, + NoInputAndOutputCommand, + QueryIdempotencyTokenAutoFillCommand, + QueryListsCommand, + QueryTimestampsCommand, + RecursiveXmlShapesCommand, + SimpleInputParamsCommand, + SimpleScalarXmlPropertiesCommand, + XmlBlobsCommand, + XmlEmptyBlobsCommand, + XmlEmptyListsCommand, + XmlEnumsCommand, + XmlIntEnumsCommand, + XmlListsCommand, + XmlNamespacesCommand, + XmlTimestampsCommand, +}; + +export interface EC2Protocol { /** - * @public + * @see {@link DatetimeOffsetsCommand} */ - public datetimeOffsets( + datetimeOffsets( args: DatetimeOffsetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public datetimeOffsets( - args: DatetimeOffsetsCommandInput, - cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void - ): void; - public datetimeOffsets( + datetimeOffsets(args: DatetimeOffsetsCommandInput, cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void): void; + datetimeOffsets( args: DatetimeOffsetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void ): void; - public datetimeOffsets( - args: DatetimeOffsetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DatetimeOffsetsCommandOutput) => void), - cb?: (err: any, data?: DatetimeOffsetsCommandOutput) => void - ): Promise | void { - const command = new DatetimeOffsetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response members. - * - * While this should be rare, code generators must support this. + * @see {@link EmptyInputAndEmptyOutputCommand} */ - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, cb: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void ): void; - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void ): void; - public emptyInputAndEmptyOutput( - args: EmptyInputAndEmptyOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void), - cb?: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void - ): Promise | void { - const command = new EmptyInputAndEmptyOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointOperationCommand} */ - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( - args: EndpointOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointWithHostLabelOperationCommand} */ - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( - args: EndpointWithHostLabelOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointWithHostLabelOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link FractionalSecondsCommand} */ - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, options?: __HttpHandlerOptions ): Promise; - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, cb: (err: any, data?: FractionalSecondsCommandOutput) => void ): void; - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FractionalSecondsCommandOutput) => void ): void; - public fractionalSeconds( - args: FractionalSecondsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FractionalSecondsCommandOutput) => void), - cb?: (err: any, data?: FractionalSecondsCommandOutput) => void - ): Promise | void { - const command = new FractionalSecondsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This operation has three possible return values: - * - * 1. A successful response in the form of GreetingWithErrorsOutput - * 2. An InvalidGreeting error. - * 3. A BadRequest error. + * @see {@link GreetingWithErrorsCommand} */ - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( - args: GreetingWithErrorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GreetingWithErrorsCommandOutput) => void), - cb?: (err: any, data?: GreetingWithErrorsCommandOutput) => void - ): Promise | void { - const command = new GreetingWithErrorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link HostWithPathOperationCommand} */ - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, cb: (err: any, data?: HostWithPathOperationCommandOutput) => void ): void; - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HostWithPathOperationCommandOutput) => void ): void; - public hostWithPathOperation( - args: HostWithPathOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HostWithPathOperationCommandOutput) => void), - cb?: (err: any, data?: HostWithPathOperationCommandOutput) => void - ): Promise | void { - const command = new HostWithPathOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The xmlName trait on the output structure is ignored in AWS Query. - * - * The wrapping element is always operation name + "Response". + * @see {@link IgnoresWrappingXmlNameCommand} */ - public ignoresWrappingXmlName( + ignoresWrappingXmlName( args: IgnoresWrappingXmlNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public ignoresWrappingXmlName( + ignoresWrappingXmlName( args: IgnoresWrappingXmlNameCommandInput, cb: (err: any, data?: IgnoresWrappingXmlNameCommandOutput) => void ): void; - public ignoresWrappingXmlName( + ignoresWrappingXmlName( args: IgnoresWrappingXmlNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IgnoresWrappingXmlNameCommandOutput) => void ): void; - public ignoresWrappingXmlName( - args: IgnoresWrappingXmlNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: IgnoresWrappingXmlNameCommandOutput) => void), - cb?: (err: any, data?: IgnoresWrappingXmlNameCommandOutput) => void - ): Promise | void { - const command = new IgnoresWrappingXmlNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test serializes nested and recursive structure members. + * @see {@link NestedStructuresCommand} */ - public nestedStructures( + nestedStructures( args: NestedStructuresCommandInput, options?: __HttpHandlerOptions ): Promise; - public nestedStructures( + nestedStructures( args: NestedStructuresCommandInput, cb: (err: any, data?: NestedStructuresCommandOutput) => void ): void; - public nestedStructures( + nestedStructures( args: NestedStructuresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NestedStructuresCommandOutput) => void ): void; - public nestedStructures( - args: NestedStructuresCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NestedStructuresCommandOutput) => void), - cb?: (err: any, data?: NestedStructuresCommandOutput) => void - ): Promise | void { - const command = new NestedStructuresCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there's - * no request payload or response members. - * - * While this should be rare, code generators must support this. + * @see {@link NoInputAndOutputCommand} */ - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, cb: (err: any, data?: NoInputAndOutputCommandOutput) => void ): void; - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NoInputAndOutputCommandOutput) => void ): void; - public noInputAndOutput( - args: NoInputAndOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NoInputAndOutputCommandOutput) => void), - cb?: (err: any, data?: NoInputAndOutputCommandOutput) => void - ): Promise | void { - const command = new NoInputAndOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Automatically adds idempotency tokens. + * @see {@link QueryIdempotencyTokenAutoFillCommand} */ - public queryIdempotencyTokenAutoFill( + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, options?: __HttpHandlerOptions ): Promise; - public queryIdempotencyTokenAutoFill( + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, cb: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void ): void; - public queryIdempotencyTokenAutoFill( + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void ): void; - public queryIdempotencyTokenAutoFill( - args: QueryIdempotencyTokenAutoFillCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void), - cb?: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void - ): Promise | void { - const command = new QueryIdempotencyTokenAutoFillCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test serializes simple and complex lists. + * @see {@link QueryListsCommand} */ - public queryLists(args: QueryListsCommandInput, options?: __HttpHandlerOptions): Promise; - public queryLists(args: QueryListsCommandInput, cb: (err: any, data?: QueryListsCommandOutput) => void): void; - public queryLists( + queryLists(args: QueryListsCommandInput, options?: __HttpHandlerOptions): Promise; + queryLists(args: QueryListsCommandInput, cb: (err: any, data?: QueryListsCommandOutput) => void): void; + queryLists( args: QueryListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryListsCommandOutput) => void ): void; - public queryLists( - args: QueryListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryListsCommandOutput) => void), - cb?: (err: any, data?: QueryListsCommandOutput) => void - ): Promise | void { - const command = new QueryListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test serializes timestamps. - * - * 1. Timestamps are serialized as RFC 3339 date-time values by default. - * 2. A timestampFormat trait on a member changes the format. - * 3. A timestampFormat trait on the shape targeted by the member changes the format. + * @see {@link QueryTimestampsCommand} */ - public queryTimestamps( + queryTimestamps( args: QueryTimestampsCommandInput, options?: __HttpHandlerOptions ): Promise; - public queryTimestamps( - args: QueryTimestampsCommandInput, - cb: (err: any, data?: QueryTimestampsCommandOutput) => void - ): void; - public queryTimestamps( + queryTimestamps(args: QueryTimestampsCommandInput, cb: (err: any, data?: QueryTimestampsCommandOutput) => void): void; + queryTimestamps( args: QueryTimestampsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryTimestampsCommandOutput) => void ): void; - public queryTimestamps( - args: QueryTimestampsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryTimestampsCommandOutput) => void), - cb?: (err: any, data?: QueryTimestampsCommandOutput) => void - ): Promise | void { - const command = new QueryTimestampsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Recursive shapes + * @see {@link RecursiveXmlShapesCommand} */ - public recursiveXmlShapes( + recursiveXmlShapes( args: RecursiveXmlShapesCommandInput, options?: __HttpHandlerOptions ): Promise; - public recursiveXmlShapes( + recursiveXmlShapes( args: RecursiveXmlShapesCommandInput, cb: (err: any, data?: RecursiveXmlShapesCommandOutput) => void ): void; - public recursiveXmlShapes( + recursiveXmlShapes( args: RecursiveXmlShapesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RecursiveXmlShapesCommandOutput) => void ): void; - public recursiveXmlShapes( - args: RecursiveXmlShapesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RecursiveXmlShapesCommandOutput) => void), - cb?: (err: any, data?: RecursiveXmlShapesCommandOutput) => void - ): Promise | void { - const command = new RecursiveXmlShapesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test serializes strings, numbers, and boolean values. + * @see {@link SimpleInputParamsCommand} */ - public simpleInputParams( + simpleInputParams( args: SimpleInputParamsCommandInput, options?: __HttpHandlerOptions ): Promise; - public simpleInputParams( + simpleInputParams( args: SimpleInputParamsCommandInput, cb: (err: any, data?: SimpleInputParamsCommandOutput) => void ): void; - public simpleInputParams( + simpleInputParams( args: SimpleInputParamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SimpleInputParamsCommandOutput) => void ): void; - public simpleInputParams( - args: SimpleInputParamsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SimpleInputParamsCommandOutput) => void), - cb?: (err: any, data?: SimpleInputParamsCommandOutput) => void - ): Promise | void { - const command = new SimpleInputParamsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link SimpleScalarXmlPropertiesCommand} */ - public simpleScalarXmlProperties( + simpleScalarXmlProperties( args: SimpleScalarXmlPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public simpleScalarXmlProperties( + simpleScalarXmlProperties( args: SimpleScalarXmlPropertiesCommandInput, cb: (err: any, data?: SimpleScalarXmlPropertiesCommandOutput) => void ): void; - public simpleScalarXmlProperties( + simpleScalarXmlProperties( args: SimpleScalarXmlPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SimpleScalarXmlPropertiesCommandOutput) => void ): void; - public simpleScalarXmlProperties( - args: SimpleScalarXmlPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SimpleScalarXmlPropertiesCommandOutput) => void), - cb?: (err: any, data?: SimpleScalarXmlPropertiesCommandOutput) => void - ): Promise | void { - const command = new SimpleScalarXmlPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Blobs are base64 encoded + * @see {@link XmlBlobsCommand} */ - public xmlBlobs(args: XmlBlobsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlBlobs(args: XmlBlobsCommandInput, cb: (err: any, data?: XmlBlobsCommandOutput) => void): void; - public xmlBlobs( + xmlBlobs(args: XmlBlobsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlBlobs(args: XmlBlobsCommandInput, cb: (err: any, data?: XmlBlobsCommandOutput) => void): void; + xmlBlobs( args: XmlBlobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlBlobsCommandOutput) => void ): void; - public xmlBlobs( - args: XmlBlobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlBlobsCommandOutput) => void), - cb?: (err: any, data?: XmlBlobsCommandOutput) => void - ): Promise | void { - const command = new XmlBlobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlEmptyBlobsCommand} */ - public xmlEmptyBlobs( - args: XmlEmptyBlobsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlEmptyBlobs( - args: XmlEmptyBlobsCommandInput, - cb: (err: any, data?: XmlEmptyBlobsCommandOutput) => void - ): void; - public xmlEmptyBlobs( + xmlEmptyBlobs(args: XmlEmptyBlobsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlEmptyBlobs(args: XmlEmptyBlobsCommandInput, cb: (err: any, data?: XmlEmptyBlobsCommandOutput) => void): void; + xmlEmptyBlobs( args: XmlEmptyBlobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEmptyBlobsCommandOutput) => void ): void; - public xmlEmptyBlobs( - args: XmlEmptyBlobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEmptyBlobsCommandOutput) => void), - cb?: (err: any, data?: XmlEmptyBlobsCommandOutput) => void - ): Promise | void { - const command = new XmlEmptyBlobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlEmptyListsCommand} */ - public xmlEmptyLists( - args: XmlEmptyListsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlEmptyLists( - args: XmlEmptyListsCommandInput, - cb: (err: any, data?: XmlEmptyListsCommandOutput) => void - ): void; - public xmlEmptyLists( + xmlEmptyLists(args: XmlEmptyListsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlEmptyLists(args: XmlEmptyListsCommandInput, cb: (err: any, data?: XmlEmptyListsCommandOutput) => void): void; + xmlEmptyLists( args: XmlEmptyListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEmptyListsCommandOutput) => void ): void; - public xmlEmptyLists( - args: XmlEmptyListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEmptyListsCommandOutput) => void), - cb?: (err: any, data?: XmlEmptyListsCommandOutput) => void - ): Promise | void { - const command = new XmlEmptyListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes enums as top level properties, in lists, sets, and maps. + * @see {@link XmlEnumsCommand} */ - public xmlEnums(args: XmlEnumsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlEnums(args: XmlEnumsCommandInput, cb: (err: any, data?: XmlEnumsCommandOutput) => void): void; - public xmlEnums( + xmlEnums(args: XmlEnumsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlEnums(args: XmlEnumsCommandInput, cb: (err: any, data?: XmlEnumsCommandOutput) => void): void; + xmlEnums( args: XmlEnumsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEnumsCommandOutput) => void ): void; - public xmlEnums( - args: XmlEnumsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEnumsCommandOutput) => void), - cb?: (err: any, data?: XmlEnumsCommandOutput) => void - ): Promise | void { - const command = new XmlEnumsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes intEnums as top level properties, in lists, sets, and maps. + * @see {@link XmlIntEnumsCommand} */ - public xmlIntEnums(args: XmlIntEnumsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlIntEnums(args: XmlIntEnumsCommandInput, cb: (err: any, data?: XmlIntEnumsCommandOutput) => void): void; - public xmlIntEnums( + xmlIntEnums(args: XmlIntEnumsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlIntEnums(args: XmlIntEnumsCommandInput, cb: (err: any, data?: XmlIntEnumsCommandOutput) => void): void; + xmlIntEnums( args: XmlIntEnumsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlIntEnumsCommandOutput) => void ): void; - public xmlIntEnums( - args: XmlIntEnumsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlIntEnumsCommandOutput) => void), - cb?: (err: any, data?: XmlIntEnumsCommandOutput) => void - ): Promise | void { - const command = new XmlIntEnumsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test case serializes XML lists for the following cases for both - * input and output: - * - * 1. Normal XML lists. - * 2. Normal XML sets. - * 3. XML lists of lists. - * 4. XML lists with @xmlName on its members - * 5. Flattened XML lists. - * 6. Flattened XML lists with @xmlName. - * 7. Flattened XML lists with @xmlNamespace. - * 8. Lists of structures. + * @see {@link XmlListsCommand} */ - public xmlLists(args: XmlListsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlLists(args: XmlListsCommandInput, cb: (err: any, data?: XmlListsCommandOutput) => void): void; - public xmlLists( + xmlLists(args: XmlListsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlLists(args: XmlListsCommandInput, cb: (err: any, data?: XmlListsCommandOutput) => void): void; + xmlLists( args: XmlListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlListsCommandOutput) => void ): void; - public xmlLists( - args: XmlListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlListsCommandOutput) => void), - cb?: (err: any, data?: XmlListsCommandOutput) => void - ): Promise | void { - const command = new XmlListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlNamespacesCommand} */ - public xmlNamespaces( - args: XmlNamespacesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlNamespaces( - args: XmlNamespacesCommandInput, - cb: (err: any, data?: XmlNamespacesCommandOutput) => void - ): void; - public xmlNamespaces( + xmlNamespaces(args: XmlNamespacesCommandInput, options?: __HttpHandlerOptions): Promise; + xmlNamespaces(args: XmlNamespacesCommandInput, cb: (err: any, data?: XmlNamespacesCommandOutput) => void): void; + xmlNamespaces( args: XmlNamespacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlNamespacesCommandOutput) => void ): void; - public xmlNamespaces( - args: XmlNamespacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlNamespacesCommandOutput) => void), - cb?: (err: any, data?: XmlNamespacesCommandOutput) => void - ): Promise | void { - const command = new XmlNamespacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This tests how timestamps are serialized, including using the - * default format of date-time and various @timestampFormat trait - * values. + * @see {@link XmlTimestampsCommand} */ - public xmlTimestamps( - args: XmlTimestampsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlTimestamps( - args: XmlTimestampsCommandInput, - cb: (err: any, data?: XmlTimestampsCommandOutput) => void - ): void; - public xmlTimestamps( + xmlTimestamps(args: XmlTimestampsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlTimestamps(args: XmlTimestampsCommandInput, cb: (err: any, data?: XmlTimestampsCommandOutput) => void): void; + xmlTimestamps( args: XmlTimestampsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlTimestampsCommandOutput) => void ): void; - public xmlTimestamps( - args: XmlTimestampsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlTimestampsCommandOutput) => void), - cb?: (err: any, data?: XmlTimestampsCommandOutput) => void - ): Promise | void { - const command = new XmlTimestampsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * An EC2 query service that sends query requests and XML responses. + */ +export class EC2Protocol extends EC2ProtocolClient implements EC2Protocol {} +createAggregatedClient(commands, EC2Protocol); diff --git a/private/aws-protocoltests-json-10/src/JSONRPC10.ts b/private/aws-protocoltests-json-10/src/JSONRPC10.ts index 6a6987ab65b8..0f14fe0fec58 100644 --- a/private/aws-protocoltests-json-10/src/JSONRPC10.ts +++ b/private/aws-protocoltests-json-10/src/JSONRPC10.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -42,311 +43,171 @@ import { SimpleScalarPropertiesCommandInput, SimpleScalarPropertiesCommandOutput, } from "./commands/SimpleScalarPropertiesCommand"; -import { JSONRPC10Client } from "./JSONRPC10Client"; +import { JSONRPC10Client, JSONRPC10ClientConfig } from "./JSONRPC10Client"; -/** - * @public - */ -export class JSONRPC10 extends JSONRPC10Client { +const commands = { + EmptyInputAndEmptyOutputCommand, + EndpointOperationCommand, + EndpointWithHostLabelOperationCommand, + GreetingWithErrorsCommand, + HostWithPathOperationCommand, + JsonUnionsCommand, + NoInputAndNoOutputCommand, + NoInputAndOutputCommand, + SimpleScalarPropertiesCommand, +}; + +export interface JSONRPC10 { /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response payload because the operation has an empty input - * and empty output structure that reuses the same shape. While this should - * be rare, code generators must support this. + * @see {@link EmptyInputAndEmptyOutputCommand} */ - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, cb: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void ): void; - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void ): void; - public emptyInputAndEmptyOutput( - args: EmptyInputAndEmptyOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void), - cb?: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void - ): Promise | void { - const command = new EmptyInputAndEmptyOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointOperationCommand} */ - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( - args: EndpointOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointWithHostLabelOperationCommand} */ - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( - args: EndpointWithHostLabelOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointWithHostLabelOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This operation has three possible return values: - * - * 1. A successful response in the form of GreetingWithErrorsOutput - * 2. An InvalidGreeting error. - * 3. A ComplexError error. - * - * Implementations must be able to successfully take a response and - * properly deserialize successful and error responses. + * @see {@link GreetingWithErrorsCommand} */ - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( - args: GreetingWithErrorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GreetingWithErrorsCommandOutput) => void), - cb?: (err: any, data?: GreetingWithErrorsCommandOutput) => void - ): Promise | void { - const command = new GreetingWithErrorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link HostWithPathOperationCommand} */ - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, cb: (err: any, data?: HostWithPathOperationCommandOutput) => void ): void; - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HostWithPathOperationCommandOutput) => void ): void; - public hostWithPathOperation( - args: HostWithPathOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HostWithPathOperationCommandOutput) => void), - cb?: (err: any, data?: HostWithPathOperationCommandOutput) => void - ): Promise | void { - const command = new HostWithPathOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This operation uses unions for inputs and outputs. + * @see {@link JsonUnionsCommand} */ - public jsonUnions(args: JsonUnionsCommandInput, options?: __HttpHandlerOptions): Promise; - public jsonUnions(args: JsonUnionsCommandInput, cb: (err: any, data?: JsonUnionsCommandOutput) => void): void; - public jsonUnions( + jsonUnions(args: JsonUnionsCommandInput, options?: __HttpHandlerOptions): Promise; + jsonUnions(args: JsonUnionsCommandInput, cb: (err: any, data?: JsonUnionsCommandOutput) => void): void; + jsonUnions( args: JsonUnionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JsonUnionsCommandOutput) => void ): void; - public jsonUnions( - args: JsonUnionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: JsonUnionsCommandOutput) => void), - cb?: (err: any, data?: JsonUnionsCommandOutput) => void - ): Promise | void { - const command = new JsonUnionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response payload because the operation has no input or output. - * While this should be rare, code generators must support this. + * @see {@link NoInputAndNoOutputCommand} */ - public noInputAndNoOutput( + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public noInputAndNoOutput( + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, cb: (err: any, data?: NoInputAndNoOutputCommandOutput) => void ): void; - public noInputAndNoOutput( + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NoInputAndNoOutputCommandOutput) => void ): void; - public noInputAndNoOutput( - args: NoInputAndNoOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NoInputAndNoOutputCommandOutput) => void), - cb?: (err: any, data?: NoInputAndNoOutputCommandOutput) => void - ): Promise | void { - const command = new NoInputAndNoOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response payload because the operation has no input and the - * output is empty. While this should be rare, code generators must support - * this. + * @see {@link NoInputAndOutputCommand} */ - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, cb: (err: any, data?: NoInputAndOutputCommandOutput) => void ): void; - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NoInputAndOutputCommandOutput) => void ): void; - public noInputAndOutput( - args: NoInputAndOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NoInputAndOutputCommandOutput) => void), - cb?: (err: any, data?: NoInputAndOutputCommandOutput) => void - ): Promise | void { - const command = new NoInputAndOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link SimpleScalarPropertiesCommand} */ - public simpleScalarProperties( + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public simpleScalarProperties( + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, cb: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void ): void; - public simpleScalarProperties( + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void ): void; - public simpleScalarProperties( - args: SimpleScalarPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SimpleScalarPropertiesCommandOutput) => void), - cb?: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void - ): Promise | void { - const command = new SimpleScalarPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + */ +export class JSONRPC10 extends JSONRPC10Client implements JSONRPC10 {} +createAggregatedClient(commands, JSONRPC10); diff --git a/private/aws-protocoltests-json/src/JsonProtocol.ts b/private/aws-protocoltests-json/src/JsonProtocol.ts index b6521901ea48..b934bff31efa 100644 --- a/private/aws-protocoltests-json/src/JsonProtocol.ts +++ b/private/aws-protocoltests-json/src/JsonProtocol.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -63,456 +64,243 @@ import { SimpleScalarPropertiesCommandInput, SimpleScalarPropertiesCommandOutput, } from "./commands/SimpleScalarPropertiesCommand"; -import { JsonProtocolClient } from "./JsonProtocolClient"; +import { JsonProtocolClient, JsonProtocolClientConfig } from "./JsonProtocolClient"; -/** - * @public - */ -export class JsonProtocol extends JsonProtocolClient { +const commands = { + DatetimeOffsetsCommand, + EmptyOperationCommand, + EndpointOperationCommand, + EndpointWithHostLabelOperationCommand, + FractionalSecondsCommand, + GreetingWithErrorsCommand, + HostWithPathOperationCommand, + JsonEnumsCommand, + JsonUnionsCommand, + KitchenSinkOperationCommand, + NullOperationCommand, + OperationWithOptionalInputOutputCommand, + PutAndGetInlineDocumentsCommand, + SimpleScalarPropertiesCommand, +}; + +export interface JsonProtocol { /** - * @public + * @see {@link DatetimeOffsetsCommand} */ - public datetimeOffsets( + datetimeOffsets( args: DatetimeOffsetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public datetimeOffsets( - args: DatetimeOffsetsCommandInput, - cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void - ): void; - public datetimeOffsets( + datetimeOffsets(args: DatetimeOffsetsCommandInput, cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void): void; + datetimeOffsets( args: DatetimeOffsetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void ): void; - public datetimeOffsets( - args: DatetimeOffsetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DatetimeOffsetsCommandOutput) => void), - cb?: (err: any, data?: DatetimeOffsetsCommandOutput) => void - ): Promise | void { - const command = new DatetimeOffsetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EmptyOperationCommand} */ - public emptyOperation( + emptyOperation( args: EmptyOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public emptyOperation( - args: EmptyOperationCommandInput, - cb: (err: any, data?: EmptyOperationCommandOutput) => void - ): void; - public emptyOperation( + emptyOperation(args: EmptyOperationCommandInput, cb: (err: any, data?: EmptyOperationCommandOutput) => void): void; + emptyOperation( args: EmptyOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EmptyOperationCommandOutput) => void ): void; - public emptyOperation( - args: EmptyOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EmptyOperationCommandOutput) => void), - cb?: (err: any, data?: EmptyOperationCommandOutput) => void - ): Promise | void { - const command = new EmptyOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointOperationCommand} */ - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( - args: EndpointOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointWithHostLabelOperationCommand} */ - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( - args: EndpointWithHostLabelOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointWithHostLabelOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link FractionalSecondsCommand} */ - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, options?: __HttpHandlerOptions ): Promise; - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, cb: (err: any, data?: FractionalSecondsCommandOutput) => void ): void; - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FractionalSecondsCommandOutput) => void ): void; - public fractionalSeconds( - args: FractionalSecondsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FractionalSecondsCommandOutput) => void), - cb?: (err: any, data?: FractionalSecondsCommandOutput) => void - ): Promise | void { - const command = new FractionalSecondsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This operation has three possible return values: - * - * 1. A successful response in the form of GreetingWithErrorsOutput - * 2. An InvalidGreeting error. - * 3. A ComplexError error. - * - * Implementations must be able to successfully take a response and - * properly deserialize successful and error responses. + * @see {@link GreetingWithErrorsCommand} */ - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( - args: GreetingWithErrorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GreetingWithErrorsCommandOutput) => void), - cb?: (err: any, data?: GreetingWithErrorsCommandOutput) => void - ): Promise | void { - const command = new GreetingWithErrorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link HostWithPathOperationCommand} */ - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, cb: (err: any, data?: HostWithPathOperationCommandOutput) => void ): void; - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HostWithPathOperationCommandOutput) => void ): void; - public hostWithPathOperation( - args: HostWithPathOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HostWithPathOperationCommandOutput) => void), - cb?: (err: any, data?: HostWithPathOperationCommandOutput) => void - ): Promise | void { - const command = new HostWithPathOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes enums as top level properties, in lists, sets, and maps. + * @see {@link JsonEnumsCommand} */ - public jsonEnums(args: JsonEnumsCommandInput, options?: __HttpHandlerOptions): Promise; - public jsonEnums(args: JsonEnumsCommandInput, cb: (err: any, data?: JsonEnumsCommandOutput) => void): void; - public jsonEnums( + jsonEnums(args: JsonEnumsCommandInput, options?: __HttpHandlerOptions): Promise; + jsonEnums(args: JsonEnumsCommandInput, cb: (err: any, data?: JsonEnumsCommandOutput) => void): void; + jsonEnums( args: JsonEnumsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JsonEnumsCommandOutput) => void ): void; - public jsonEnums( - args: JsonEnumsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: JsonEnumsCommandOutput) => void), - cb?: (err: any, data?: JsonEnumsCommandOutput) => void - ): Promise | void { - const command = new JsonEnumsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This operation uses unions for inputs and outputs. + * @see {@link JsonUnionsCommand} */ - public jsonUnions(args: JsonUnionsCommandInput, options?: __HttpHandlerOptions): Promise; - public jsonUnions(args: JsonUnionsCommandInput, cb: (err: any, data?: JsonUnionsCommandOutput) => void): void; - public jsonUnions( + jsonUnions(args: JsonUnionsCommandInput, options?: __HttpHandlerOptions): Promise; + jsonUnions(args: JsonUnionsCommandInput, cb: (err: any, data?: JsonUnionsCommandOutput) => void): void; + jsonUnions( args: JsonUnionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JsonUnionsCommandOutput) => void ): void; - public jsonUnions( - args: JsonUnionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: JsonUnionsCommandOutput) => void), - cb?: (err: any, data?: JsonUnionsCommandOutput) => void - ): Promise | void { - const command = new JsonUnionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link KitchenSinkOperationCommand} */ - public kitchenSinkOperation( + kitchenSinkOperation( args: KitchenSinkOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public kitchenSinkOperation( + kitchenSinkOperation( args: KitchenSinkOperationCommandInput, cb: (err: any, data?: KitchenSinkOperationCommandOutput) => void ): void; - public kitchenSinkOperation( + kitchenSinkOperation( args: KitchenSinkOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: KitchenSinkOperationCommandOutput) => void ): void; - public kitchenSinkOperation( - args: KitchenSinkOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: KitchenSinkOperationCommandOutput) => void), - cb?: (err: any, data?: KitchenSinkOperationCommandOutput) => void - ): Promise | void { - const command = new KitchenSinkOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link NullOperationCommand} */ - public nullOperation( - args: NullOperationCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public nullOperation( - args: NullOperationCommandInput, - cb: (err: any, data?: NullOperationCommandOutput) => void - ): void; - public nullOperation( + nullOperation(args: NullOperationCommandInput, options?: __HttpHandlerOptions): Promise; + nullOperation(args: NullOperationCommandInput, cb: (err: any, data?: NullOperationCommandOutput) => void): void; + nullOperation( args: NullOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NullOperationCommandOutput) => void ): void; - public nullOperation( - args: NullOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NullOperationCommandOutput) => void), - cb?: (err: any, data?: NullOperationCommandOutput) => void - ): Promise | void { - const command = new NullOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link OperationWithOptionalInputOutputCommand} */ - public operationWithOptionalInputOutput( + operationWithOptionalInputOutput( args: OperationWithOptionalInputOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public operationWithOptionalInputOutput( + operationWithOptionalInputOutput( args: OperationWithOptionalInputOutputCommandInput, cb: (err: any, data?: OperationWithOptionalInputOutputCommandOutput) => void ): void; - public operationWithOptionalInputOutput( + operationWithOptionalInputOutput( args: OperationWithOptionalInputOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: OperationWithOptionalInputOutputCommandOutput) => void ): void; - public operationWithOptionalInputOutput( - args: OperationWithOptionalInputOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: OperationWithOptionalInputOutputCommandOutput) => void), - cb?: (err: any, data?: OperationWithOptionalInputOutputCommandOutput) => void - ): Promise | void { - const command = new OperationWithOptionalInputOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes an inline document as part of the payload. + * @see {@link PutAndGetInlineDocumentsCommand} */ - public putAndGetInlineDocuments( + putAndGetInlineDocuments( args: PutAndGetInlineDocumentsCommandInput, options?: __HttpHandlerOptions ): Promise; - public putAndGetInlineDocuments( + putAndGetInlineDocuments( args: PutAndGetInlineDocumentsCommandInput, cb: (err: any, data?: PutAndGetInlineDocumentsCommandOutput) => void ): void; - public putAndGetInlineDocuments( + putAndGetInlineDocuments( args: PutAndGetInlineDocumentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAndGetInlineDocumentsCommandOutput) => void ): void; - public putAndGetInlineDocuments( - args: PutAndGetInlineDocumentsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutAndGetInlineDocumentsCommandOutput) => void), - cb?: (err: any, data?: PutAndGetInlineDocumentsCommandOutput) => void - ): Promise | void { - const command = new PutAndGetInlineDocumentsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link SimpleScalarPropertiesCommand} */ - public simpleScalarProperties( + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public simpleScalarProperties( + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, cb: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void ): void; - public simpleScalarProperties( + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void ): void; - public simpleScalarProperties( - args: SimpleScalarPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SimpleScalarPropertiesCommandOutput) => void), - cb?: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void - ): Promise | void { - const command = new SimpleScalarPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + */ +export class JsonProtocol extends JsonProtocolClient implements JsonProtocol {} +createAggregatedClient(commands, JsonProtocol); diff --git a/private/aws-protocoltests-query/src/QueryProtocol.ts b/private/aws-protocoltests-query/src/QueryProtocol.ts index 279731cc8457..1e3b90a7fa0b 100644 --- a/private/aws-protocoltests-query/src/QueryProtocol.ts +++ b/private/aws-protocoltests-query/src/QueryProtocol.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -133,1041 +134,508 @@ import { XmlTimestampsCommandInput, XmlTimestampsCommandOutput, } from "./commands/XmlTimestampsCommand"; -import { QueryProtocolClient } from "./QueryProtocolClient"; +import { QueryProtocolClient, QueryProtocolClientConfig } from "./QueryProtocolClient"; -/** - * @public - * A query service that sends query requests and XML responses. - */ -export class QueryProtocol extends QueryProtocolClient { +const commands = { + DatetimeOffsetsCommand, + EmptyInputAndEmptyOutputCommand, + EndpointOperationCommand, + EndpointWithHostLabelOperationCommand, + FlattenedXmlMapCommand, + FlattenedXmlMapWithXmlNameCommand, + FlattenedXmlMapWithXmlNamespaceCommand, + FractionalSecondsCommand, + GreetingWithErrorsCommand, + HostWithPathOperationCommand, + IgnoresWrappingXmlNameCommand, + NestedStructuresCommand, + NoInputAndNoOutputCommand, + NoInputAndOutputCommand, + QueryIdempotencyTokenAutoFillCommand, + QueryListsCommand, + QueryMapsCommand, + QueryTimestampsCommand, + RecursiveXmlShapesCommand, + SimpleInputParamsCommand, + SimpleScalarXmlPropertiesCommand, + XmlBlobsCommand, + XmlEmptyBlobsCommand, + XmlEmptyListsCommand, + XmlEmptyMapsCommand, + XmlEnumsCommand, + XmlIntEnumsCommand, + XmlListsCommand, + XmlMapsCommand, + XmlMapsXmlNameCommand, + XmlNamespacesCommand, + XmlTimestampsCommand, +}; + +export interface QueryProtocol { /** - * @public + * @see {@link DatetimeOffsetsCommand} */ - public datetimeOffsets( + datetimeOffsets( args: DatetimeOffsetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public datetimeOffsets( - args: DatetimeOffsetsCommandInput, - cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void - ): void; - public datetimeOffsets( + datetimeOffsets(args: DatetimeOffsetsCommandInput, cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void): void; + datetimeOffsets( args: DatetimeOffsetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void ): void; - public datetimeOffsets( - args: DatetimeOffsetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DatetimeOffsetsCommandOutput) => void), - cb?: (err: any, data?: DatetimeOffsetsCommandOutput) => void - ): Promise | void { - const command = new DatetimeOffsetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response members. - * - * While this should be rare, code generators must support this. + * @see {@link EmptyInputAndEmptyOutputCommand} */ - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, cb: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void ): void; - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void ): void; - public emptyInputAndEmptyOutput( - args: EmptyInputAndEmptyOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void), - cb?: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void - ): Promise | void { - const command = new EmptyInputAndEmptyOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointOperationCommand} */ - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( - args: EndpointOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointWithHostLabelOperationCommand} */ - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( - args: EndpointWithHostLabelOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointWithHostLabelOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Flattened maps + * @see {@link FlattenedXmlMapCommand} */ - public flattenedXmlMap( + flattenedXmlMap( args: FlattenedXmlMapCommandInput, options?: __HttpHandlerOptions ): Promise; - public flattenedXmlMap( - args: FlattenedXmlMapCommandInput, - cb: (err: any, data?: FlattenedXmlMapCommandOutput) => void - ): void; - public flattenedXmlMap( + flattenedXmlMap(args: FlattenedXmlMapCommandInput, cb: (err: any, data?: FlattenedXmlMapCommandOutput) => void): void; + flattenedXmlMap( args: FlattenedXmlMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FlattenedXmlMapCommandOutput) => void ): void; - public flattenedXmlMap( - args: FlattenedXmlMapCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FlattenedXmlMapCommandOutput) => void), - cb?: (err: any, data?: FlattenedXmlMapCommandOutput) => void - ): Promise | void { - const command = new FlattenedXmlMapCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Flattened maps with @xmlName + * @see {@link FlattenedXmlMapWithXmlNameCommand} */ - public flattenedXmlMapWithXmlName( + flattenedXmlMapWithXmlName( args: FlattenedXmlMapWithXmlNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public flattenedXmlMapWithXmlName( + flattenedXmlMapWithXmlName( args: FlattenedXmlMapWithXmlNameCommandInput, cb: (err: any, data?: FlattenedXmlMapWithXmlNameCommandOutput) => void ): void; - public flattenedXmlMapWithXmlName( + flattenedXmlMapWithXmlName( args: FlattenedXmlMapWithXmlNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FlattenedXmlMapWithXmlNameCommandOutput) => void ): void; - public flattenedXmlMapWithXmlName( - args: FlattenedXmlMapWithXmlNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FlattenedXmlMapWithXmlNameCommandOutput) => void), - cb?: (err: any, data?: FlattenedXmlMapWithXmlNameCommandOutput) => void - ): Promise | void { - const command = new FlattenedXmlMapWithXmlNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Flattened maps with @xmlNamespace and @xmlName + * @see {@link FlattenedXmlMapWithXmlNamespaceCommand} */ - public flattenedXmlMapWithXmlNamespace( + flattenedXmlMapWithXmlNamespace( args: FlattenedXmlMapWithXmlNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public flattenedXmlMapWithXmlNamespace( + flattenedXmlMapWithXmlNamespace( args: FlattenedXmlMapWithXmlNamespaceCommandInput, cb: (err: any, data?: FlattenedXmlMapWithXmlNamespaceCommandOutput) => void ): void; - public flattenedXmlMapWithXmlNamespace( + flattenedXmlMapWithXmlNamespace( args: FlattenedXmlMapWithXmlNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FlattenedXmlMapWithXmlNamespaceCommandOutput) => void ): void; - public flattenedXmlMapWithXmlNamespace( - args: FlattenedXmlMapWithXmlNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FlattenedXmlMapWithXmlNamespaceCommandOutput) => void), - cb?: (err: any, data?: FlattenedXmlMapWithXmlNamespaceCommandOutput) => void - ): Promise | void { - const command = new FlattenedXmlMapWithXmlNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link FractionalSecondsCommand} */ - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, options?: __HttpHandlerOptions ): Promise; - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, cb: (err: any, data?: FractionalSecondsCommandOutput) => void ): void; - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FractionalSecondsCommandOutput) => void ): void; - public fractionalSeconds( - args: FractionalSecondsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FractionalSecondsCommandOutput) => void), - cb?: (err: any, data?: FractionalSecondsCommandOutput) => void - ): Promise | void { - const command = new FractionalSecondsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This operation has three possible return values: - * - * 1. A successful response in the form of GreetingWithErrorsOutput - * 2. An InvalidGreeting error. - * 3. A BadRequest error. + * @see {@link GreetingWithErrorsCommand} */ - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( - args: GreetingWithErrorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GreetingWithErrorsCommandOutput) => void), - cb?: (err: any, data?: GreetingWithErrorsCommandOutput) => void - ): Promise | void { - const command = new GreetingWithErrorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link HostWithPathOperationCommand} */ - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, cb: (err: any, data?: HostWithPathOperationCommandOutput) => void ): void; - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HostWithPathOperationCommandOutput) => void ): void; - public hostWithPathOperation( - args: HostWithPathOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HostWithPathOperationCommandOutput) => void), - cb?: (err: any, data?: HostWithPathOperationCommandOutput) => void - ): Promise | void { - const command = new HostWithPathOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The xmlName trait on the output structure is ignored in AWS Query. - * - * The wrapping element is always operation name + "Response", and - * inside of that wrapper is another wrapper named operation name + "Result". + * @see {@link IgnoresWrappingXmlNameCommand} */ - public ignoresWrappingXmlName( + ignoresWrappingXmlName( args: IgnoresWrappingXmlNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public ignoresWrappingXmlName( + ignoresWrappingXmlName( args: IgnoresWrappingXmlNameCommandInput, cb: (err: any, data?: IgnoresWrappingXmlNameCommandOutput) => void ): void; - public ignoresWrappingXmlName( + ignoresWrappingXmlName( args: IgnoresWrappingXmlNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IgnoresWrappingXmlNameCommandOutput) => void ): void; - public ignoresWrappingXmlName( - args: IgnoresWrappingXmlNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: IgnoresWrappingXmlNameCommandOutput) => void), - cb?: (err: any, data?: IgnoresWrappingXmlNameCommandOutput) => void - ): Promise | void { - const command = new IgnoresWrappingXmlNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test serializes nested and recursive structure members. + * @see {@link NestedStructuresCommand} */ - public nestedStructures( + nestedStructures( args: NestedStructuresCommandInput, options?: __HttpHandlerOptions ): Promise; - public nestedStructures( + nestedStructures( args: NestedStructuresCommandInput, cb: (err: any, data?: NestedStructuresCommandOutput) => void ): void; - public nestedStructures( + nestedStructures( args: NestedStructuresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NestedStructuresCommandOutput) => void ): void; - public nestedStructures( - args: NestedStructuresCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NestedStructuresCommandOutput) => void), - cb?: (err: any, data?: NestedStructuresCommandOutput) => void - ): Promise | void { - const command = new NestedStructuresCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response payload because the operation has no input or output. - * - * While this should be rare, code generators must support this. + * @see {@link NoInputAndNoOutputCommand} */ - public noInputAndNoOutput( + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public noInputAndNoOutput( + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, cb: (err: any, data?: NoInputAndNoOutputCommandOutput) => void ): void; - public noInputAndNoOutput( + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NoInputAndNoOutputCommandOutput) => void ): void; - public noInputAndNoOutput( - args: NoInputAndNoOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NoInputAndNoOutputCommandOutput) => void), - cb?: (err: any, data?: NoInputAndNoOutputCommandOutput) => void - ): Promise | void { - const command = new NoInputAndNoOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there's - * no request payload or response members. - * - * While this should be rare, code generators must support this. + * @see {@link NoInputAndOutputCommand} */ - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, cb: (err: any, data?: NoInputAndOutputCommandOutput) => void ): void; - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NoInputAndOutputCommandOutput) => void ): void; - public noInputAndOutput( - args: NoInputAndOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NoInputAndOutputCommandOutput) => void), - cb?: (err: any, data?: NoInputAndOutputCommandOutput) => void - ): Promise | void { - const command = new NoInputAndOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Automatically adds idempotency tokens. + * @see {@link QueryIdempotencyTokenAutoFillCommand} */ - public queryIdempotencyTokenAutoFill( + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, options?: __HttpHandlerOptions ): Promise; - public queryIdempotencyTokenAutoFill( + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, cb: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void ): void; - public queryIdempotencyTokenAutoFill( + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void ): void; - public queryIdempotencyTokenAutoFill( - args: QueryIdempotencyTokenAutoFillCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void), - cb?: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void - ): Promise | void { - const command = new QueryIdempotencyTokenAutoFillCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test serializes simple and complex lists. + * @see {@link QueryListsCommand} */ - public queryLists(args: QueryListsCommandInput, options?: __HttpHandlerOptions): Promise; - public queryLists(args: QueryListsCommandInput, cb: (err: any, data?: QueryListsCommandOutput) => void): void; - public queryLists( + queryLists(args: QueryListsCommandInput, options?: __HttpHandlerOptions): Promise; + queryLists(args: QueryListsCommandInput, cb: (err: any, data?: QueryListsCommandOutput) => void): void; + queryLists( args: QueryListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryListsCommandOutput) => void ): void; - public queryLists( - args: QueryListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryListsCommandOutput) => void), - cb?: (err: any, data?: QueryListsCommandOutput) => void - ): Promise | void { - const command = new QueryListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test serializes simple and complex maps. + * @see {@link QueryMapsCommand} */ - public queryMaps(args: QueryMapsCommandInput, options?: __HttpHandlerOptions): Promise; - public queryMaps(args: QueryMapsCommandInput, cb: (err: any, data?: QueryMapsCommandOutput) => void): void; - public queryMaps( + queryMaps(args: QueryMapsCommandInput, options?: __HttpHandlerOptions): Promise; + queryMaps(args: QueryMapsCommandInput, cb: (err: any, data?: QueryMapsCommandOutput) => void): void; + queryMaps( args: QueryMapsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryMapsCommandOutput) => void ): void; - public queryMaps( - args: QueryMapsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryMapsCommandOutput) => void), - cb?: (err: any, data?: QueryMapsCommandOutput) => void - ): Promise | void { - const command = new QueryMapsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test serializes timestamps. - * - * 1. Timestamps are serialized as RFC 3339 date-time values by default. - * 2. A timestampFormat trait on a member changes the format. - * 3. A timestampFormat trait on the shape targeted by the member changes the format. + * @see {@link QueryTimestampsCommand} */ - public queryTimestamps( + queryTimestamps( args: QueryTimestampsCommandInput, options?: __HttpHandlerOptions ): Promise; - public queryTimestamps( - args: QueryTimestampsCommandInput, - cb: (err: any, data?: QueryTimestampsCommandOutput) => void - ): void; - public queryTimestamps( + queryTimestamps(args: QueryTimestampsCommandInput, cb: (err: any, data?: QueryTimestampsCommandOutput) => void): void; + queryTimestamps( args: QueryTimestampsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryTimestampsCommandOutput) => void ): void; - public queryTimestamps( - args: QueryTimestampsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryTimestampsCommandOutput) => void), - cb?: (err: any, data?: QueryTimestampsCommandOutput) => void - ): Promise | void { - const command = new QueryTimestampsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Recursive shapes + * @see {@link RecursiveXmlShapesCommand} */ - public recursiveXmlShapes( + recursiveXmlShapes( args: RecursiveXmlShapesCommandInput, options?: __HttpHandlerOptions ): Promise; - public recursiveXmlShapes( + recursiveXmlShapes( args: RecursiveXmlShapesCommandInput, cb: (err: any, data?: RecursiveXmlShapesCommandOutput) => void ): void; - public recursiveXmlShapes( + recursiveXmlShapes( args: RecursiveXmlShapesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RecursiveXmlShapesCommandOutput) => void ): void; - public recursiveXmlShapes( - args: RecursiveXmlShapesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RecursiveXmlShapesCommandOutput) => void), - cb?: (err: any, data?: RecursiveXmlShapesCommandOutput) => void - ): Promise | void { - const command = new RecursiveXmlShapesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test serializes strings, numbers, and boolean values. + * @see {@link SimpleInputParamsCommand} */ - public simpleInputParams( + simpleInputParams( args: SimpleInputParamsCommandInput, options?: __HttpHandlerOptions ): Promise; - public simpleInputParams( + simpleInputParams( args: SimpleInputParamsCommandInput, cb: (err: any, data?: SimpleInputParamsCommandOutput) => void ): void; - public simpleInputParams( + simpleInputParams( args: SimpleInputParamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SimpleInputParamsCommandOutput) => void ): void; - public simpleInputParams( - args: SimpleInputParamsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SimpleInputParamsCommandOutput) => void), - cb?: (err: any, data?: SimpleInputParamsCommandOutput) => void - ): Promise | void { - const command = new SimpleInputParamsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link SimpleScalarXmlPropertiesCommand} */ - public simpleScalarXmlProperties( + simpleScalarXmlProperties( args: SimpleScalarXmlPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public simpleScalarXmlProperties( + simpleScalarXmlProperties( args: SimpleScalarXmlPropertiesCommandInput, cb: (err: any, data?: SimpleScalarXmlPropertiesCommandOutput) => void ): void; - public simpleScalarXmlProperties( + simpleScalarXmlProperties( args: SimpleScalarXmlPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SimpleScalarXmlPropertiesCommandOutput) => void ): void; - public simpleScalarXmlProperties( - args: SimpleScalarXmlPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SimpleScalarXmlPropertiesCommandOutput) => void), - cb?: (err: any, data?: SimpleScalarXmlPropertiesCommandOutput) => void - ): Promise | void { - const command = new SimpleScalarXmlPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Blobs are base64 encoded + * @see {@link XmlBlobsCommand} */ - public xmlBlobs(args: XmlBlobsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlBlobs(args: XmlBlobsCommandInput, cb: (err: any, data?: XmlBlobsCommandOutput) => void): void; - public xmlBlobs( + xmlBlobs(args: XmlBlobsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlBlobs(args: XmlBlobsCommandInput, cb: (err: any, data?: XmlBlobsCommandOutput) => void): void; + xmlBlobs( args: XmlBlobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlBlobsCommandOutput) => void ): void; - public xmlBlobs( - args: XmlBlobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlBlobsCommandOutput) => void), - cb?: (err: any, data?: XmlBlobsCommandOutput) => void - ): Promise | void { - const command = new XmlBlobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlEmptyBlobsCommand} */ - public xmlEmptyBlobs( - args: XmlEmptyBlobsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlEmptyBlobs( - args: XmlEmptyBlobsCommandInput, - cb: (err: any, data?: XmlEmptyBlobsCommandOutput) => void - ): void; - public xmlEmptyBlobs( + xmlEmptyBlobs(args: XmlEmptyBlobsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlEmptyBlobs(args: XmlEmptyBlobsCommandInput, cb: (err: any, data?: XmlEmptyBlobsCommandOutput) => void): void; + xmlEmptyBlobs( args: XmlEmptyBlobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEmptyBlobsCommandOutput) => void ): void; - public xmlEmptyBlobs( - args: XmlEmptyBlobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEmptyBlobsCommandOutput) => void), - cb?: (err: any, data?: XmlEmptyBlobsCommandOutput) => void - ): Promise | void { - const command = new XmlEmptyBlobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlEmptyListsCommand} */ - public xmlEmptyLists( - args: XmlEmptyListsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlEmptyLists( - args: XmlEmptyListsCommandInput, - cb: (err: any, data?: XmlEmptyListsCommandOutput) => void - ): void; - public xmlEmptyLists( + xmlEmptyLists(args: XmlEmptyListsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlEmptyLists(args: XmlEmptyListsCommandInput, cb: (err: any, data?: XmlEmptyListsCommandOutput) => void): void; + xmlEmptyLists( args: XmlEmptyListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEmptyListsCommandOutput) => void ): void; - public xmlEmptyLists( - args: XmlEmptyListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEmptyListsCommandOutput) => void), - cb?: (err: any, data?: XmlEmptyListsCommandOutput) => void - ): Promise | void { - const command = new XmlEmptyListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlEmptyMapsCommand} */ - public xmlEmptyMaps( - args: XmlEmptyMapsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlEmptyMaps(args: XmlEmptyMapsCommandInput, cb: (err: any, data?: XmlEmptyMapsCommandOutput) => void): void; - public xmlEmptyMaps( + xmlEmptyMaps(args: XmlEmptyMapsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlEmptyMaps(args: XmlEmptyMapsCommandInput, cb: (err: any, data?: XmlEmptyMapsCommandOutput) => void): void; + xmlEmptyMaps( args: XmlEmptyMapsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEmptyMapsCommandOutput) => void ): void; - public xmlEmptyMaps( - args: XmlEmptyMapsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEmptyMapsCommandOutput) => void), - cb?: (err: any, data?: XmlEmptyMapsCommandOutput) => void - ): Promise | void { - const command = new XmlEmptyMapsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes enums as top level properties, in lists, sets, and maps. + * @see {@link XmlEnumsCommand} */ - public xmlEnums(args: XmlEnumsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlEnums(args: XmlEnumsCommandInput, cb: (err: any, data?: XmlEnumsCommandOutput) => void): void; - public xmlEnums( + xmlEnums(args: XmlEnumsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlEnums(args: XmlEnumsCommandInput, cb: (err: any, data?: XmlEnumsCommandOutput) => void): void; + xmlEnums( args: XmlEnumsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEnumsCommandOutput) => void ): void; - public xmlEnums( - args: XmlEnumsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEnumsCommandOutput) => void), - cb?: (err: any, data?: XmlEnumsCommandOutput) => void - ): Promise | void { - const command = new XmlEnumsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes enums as top level properties, in lists, sets, and maps. + * @see {@link XmlIntEnumsCommand} */ - public xmlIntEnums(args: XmlIntEnumsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlIntEnums(args: XmlIntEnumsCommandInput, cb: (err: any, data?: XmlIntEnumsCommandOutput) => void): void; - public xmlIntEnums( + xmlIntEnums(args: XmlIntEnumsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlIntEnums(args: XmlIntEnumsCommandInput, cb: (err: any, data?: XmlIntEnumsCommandOutput) => void): void; + xmlIntEnums( args: XmlIntEnumsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlIntEnumsCommandOutput) => void ): void; - public xmlIntEnums( - args: XmlIntEnumsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlIntEnumsCommandOutput) => void), - cb?: (err: any, data?: XmlIntEnumsCommandOutput) => void - ): Promise | void { - const command = new XmlIntEnumsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test case serializes XML lists for the following cases for both - * input and output: - * - * 1. Normal XML lists. - * 2. Normal XML sets. - * 3. XML lists of lists. - * 4. XML lists with @xmlName on its members - * 5. Flattened XML lists. - * 6. Flattened XML lists with @xmlName. - * 7. Lists of structures. + * @see {@link XmlListsCommand} */ - public xmlLists(args: XmlListsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlLists(args: XmlListsCommandInput, cb: (err: any, data?: XmlListsCommandOutput) => void): void; - public xmlLists( + xmlLists(args: XmlListsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlLists(args: XmlListsCommandInput, cb: (err: any, data?: XmlListsCommandOutput) => void): void; + xmlLists( args: XmlListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlListsCommandOutput) => void ): void; - public xmlLists( - args: XmlListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlListsCommandOutput) => void), - cb?: (err: any, data?: XmlListsCommandOutput) => void - ): Promise | void { - const command = new XmlListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests basic map serialization. + * @see {@link XmlMapsCommand} */ - public xmlMaps(args: XmlMapsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlMaps(args: XmlMapsCommandInput, cb: (err: any, data?: XmlMapsCommandOutput) => void): void; - public xmlMaps( + xmlMaps(args: XmlMapsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlMaps(args: XmlMapsCommandInput, cb: (err: any, data?: XmlMapsCommandOutput) => void): void; + xmlMaps( args: XmlMapsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlMapsCommandOutput) => void ): void; - public xmlMaps( - args: XmlMapsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlMapsCommandOutput) => void), - cb?: (err: any, data?: XmlMapsCommandOutput) => void - ): Promise | void { - const command = new XmlMapsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlMapsXmlNameCommand} */ - public xmlMapsXmlName( + xmlMapsXmlName( args: XmlMapsXmlNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public xmlMapsXmlName( - args: XmlMapsXmlNameCommandInput, - cb: (err: any, data?: XmlMapsXmlNameCommandOutput) => void - ): void; - public xmlMapsXmlName( + xmlMapsXmlName(args: XmlMapsXmlNameCommandInput, cb: (err: any, data?: XmlMapsXmlNameCommandOutput) => void): void; + xmlMapsXmlName( args: XmlMapsXmlNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlMapsXmlNameCommandOutput) => void ): void; - public xmlMapsXmlName( - args: XmlMapsXmlNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlMapsXmlNameCommandOutput) => void), - cb?: (err: any, data?: XmlMapsXmlNameCommandOutput) => void - ): Promise | void { - const command = new XmlMapsXmlNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlNamespacesCommand} */ - public xmlNamespaces( - args: XmlNamespacesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlNamespaces( - args: XmlNamespacesCommandInput, - cb: (err: any, data?: XmlNamespacesCommandOutput) => void - ): void; - public xmlNamespaces( + xmlNamespaces(args: XmlNamespacesCommandInput, options?: __HttpHandlerOptions): Promise; + xmlNamespaces(args: XmlNamespacesCommandInput, cb: (err: any, data?: XmlNamespacesCommandOutput) => void): void; + xmlNamespaces( args: XmlNamespacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlNamespacesCommandOutput) => void ): void; - public xmlNamespaces( - args: XmlNamespacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlNamespacesCommandOutput) => void), - cb?: (err: any, data?: XmlNamespacesCommandOutput) => void - ): Promise | void { - const command = new XmlNamespacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This tests how timestamps are serialized, including using the - * default format of date-time and various @timestampFormat trait - * values. + * @see {@link XmlTimestampsCommand} */ - public xmlTimestamps( - args: XmlTimestampsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlTimestamps( - args: XmlTimestampsCommandInput, - cb: (err: any, data?: XmlTimestampsCommandOutput) => void - ): void; - public xmlTimestamps( + xmlTimestamps(args: XmlTimestampsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlTimestamps(args: XmlTimestampsCommandInput, cb: (err: any, data?: XmlTimestampsCommandOutput) => void): void; + xmlTimestamps( args: XmlTimestampsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlTimestampsCommandOutput) => void ): void; - public xmlTimestamps( - args: XmlTimestampsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlTimestampsCommandOutput) => void), - cb?: (err: any, data?: XmlTimestampsCommandOutput) => void - ): Promise | void { - const command = new XmlTimestampsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * A query service that sends query requests and XML responses. + */ +export class QueryProtocol extends QueryProtocolClient implements QueryProtocol {} +createAggregatedClient(commands, QueryProtocol); diff --git a/private/aws-protocoltests-restjson/src/RestJsonProtocol.ts b/private/aws-protocoltests-restjson/src/RestJsonProtocol.ts index d33e3f2edd83..9e12166ca492 100644 --- a/private/aws-protocoltests-restjson/src/RestJsonProtocol.ts +++ b/private/aws-protocoltests-restjson/src/RestJsonProtocol.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -431,2974 +432,1519 @@ import { UnitInputAndOutputCommandInput, UnitInputAndOutputCommandOutput, } from "./commands/UnitInputAndOutputCommand"; -import { RestJsonProtocolClient } from "./RestJsonProtocolClient"; +import { RestJsonProtocolClient, RestJsonProtocolClientConfig } from "./RestJsonProtocolClient"; -/** - * @public - * A REST JSON service that sends JSON requests and responses. - */ -export class RestJsonProtocol extends RestJsonProtocolClient { +const commands = { + AllQueryStringTypesCommand, + ConstantAndVariableQueryStringCommand, + ConstantQueryStringCommand, + DatetimeOffsetsCommand, + DocumentTypeCommand, + DocumentTypeAsPayloadCommand, + EmptyInputAndEmptyOutputCommand, + EndpointOperationCommand, + EndpointWithHostLabelOperationCommand, + FractionalSecondsCommand, + GreetingWithErrorsCommand, + HostWithPathOperationCommand, + HttpChecksumRequiredCommand, + HttpEnumPayloadCommand, + HttpPayloadTraitsCommand, + HttpPayloadTraitsWithMediaTypeCommand, + HttpPayloadWithStructureCommand, + HttpPrefixHeadersCommand, + HttpPrefixHeadersInResponseCommand, + HttpRequestWithFloatLabelsCommand, + HttpRequestWithGreedyLabelInPathCommand, + HttpRequestWithLabelsCommand, + HttpRequestWithLabelsAndTimestampFormatCommand, + HttpRequestWithRegexLiteralCommand, + HttpResponseCodeCommand, + HttpStringPayloadCommand, + IgnoreQueryParamsInResponseCommand, + InputAndOutputWithHeadersCommand, + JsonBlobsCommand, + JsonEnumsCommand, + JsonIntEnumsCommand, + JsonListsCommand, + JsonMapsCommand, + JsonTimestampsCommand, + JsonUnionsCommand, + MalformedAcceptWithBodyCommand, + MalformedAcceptWithGenericStringCommand, + MalformedAcceptWithPayloadCommand, + MalformedBlobCommand, + MalformedBooleanCommand, + MalformedByteCommand, + MalformedContentTypeWithBodyCommand, + MalformedContentTypeWithGenericStringCommand, + MalformedContentTypeWithoutBodyCommand, + MalformedContentTypeWithPayloadCommand, + MalformedDoubleCommand, + MalformedFloatCommand, + MalformedIntegerCommand, + MalformedListCommand, + MalformedLongCommand, + MalformedMapCommand, + MalformedRequestBodyCommand, + MalformedShortCommand, + MalformedStringCommand, + MalformedTimestampBodyDateTimeCommand, + MalformedTimestampBodyDefaultCommand, + MalformedTimestampBodyHttpDateCommand, + MalformedTimestampHeaderDateTimeCommand, + MalformedTimestampHeaderDefaultCommand, + MalformedTimestampHeaderEpochCommand, + MalformedTimestampPathDefaultCommand, + MalformedTimestampPathEpochCommand, + MalformedTimestampPathHttpDateCommand, + MalformedTimestampQueryDefaultCommand, + MalformedTimestampQueryEpochCommand, + MalformedTimestampQueryHttpDateCommand, + MalformedUnionCommand, + MediaTypeHeaderCommand, + NoInputAndNoOutputCommand, + NoInputAndOutputCommand, + NullAndEmptyHeadersClientCommand, + NullAndEmptyHeadersServerCommand, + OmitsNullSerializesEmptyStringCommand, + OmitsSerializingEmptyListsCommand, + PostPlayerActionCommand, + PostUnionWithJsonNameCommand, + QueryIdempotencyTokenAutoFillCommand, + QueryParamsAsStringListMapCommand, + QueryPrecedenceCommand, + RecursiveShapesCommand, + SimpleScalarPropertiesCommand, + StreamingTraitsCommand, + StreamingTraitsRequireLengthCommand, + StreamingTraitsWithMediaTypeCommand, + TestBodyStructureCommand, + TestNoPayloadCommand, + TestPayloadBlobCommand, + TestPayloadStructureCommand, + TimestampFormatHeadersCommand, + UnitInputAndOutputCommand, +}; + +export interface RestJsonProtocol { /** - * @public - * This example uses all query string types. + * @see {@link AllQueryStringTypesCommand} */ - public allQueryStringTypes( + allQueryStringTypes( args: AllQueryStringTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public allQueryStringTypes( + allQueryStringTypes( args: AllQueryStringTypesCommandInput, cb: (err: any, data?: AllQueryStringTypesCommandOutput) => void ): void; - public allQueryStringTypes( + allQueryStringTypes( args: AllQueryStringTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AllQueryStringTypesCommandOutput) => void ): void; - public allQueryStringTypes( - args: AllQueryStringTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AllQueryStringTypesCommandOutput) => void), - cb?: (err: any, data?: AllQueryStringTypesCommandOutput) => void - ): Promise | void { - const command = new AllQueryStringTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This example uses fixed query string params and variable query string params. - * The fixed query string parameters and variable parameters must both be - * serialized (implementations may need to merge them together). - */ - public constantAndVariableQueryString( + + /** + * @see {@link ConstantAndVariableQueryStringCommand} + */ + constantAndVariableQueryString( args: ConstantAndVariableQueryStringCommandInput, options?: __HttpHandlerOptions ): Promise; - public constantAndVariableQueryString( + constantAndVariableQueryString( args: ConstantAndVariableQueryStringCommandInput, cb: (err: any, data?: ConstantAndVariableQueryStringCommandOutput) => void ): void; - public constantAndVariableQueryString( + constantAndVariableQueryString( args: ConstantAndVariableQueryStringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConstantAndVariableQueryStringCommandOutput) => void ): void; - public constantAndVariableQueryString( - args: ConstantAndVariableQueryStringCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConstantAndVariableQueryStringCommandOutput) => void), - cb?: (err: any, data?: ConstantAndVariableQueryStringCommandOutput) => void - ): Promise | void { - const command = new ConstantAndVariableQueryStringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This example uses a constant query string parameters and a label. - * This simply tests that labels and query string parameters are - * compatible. The fixed query string parameter named "hello" should - * in no way conflict with the label, `\{hello\}`. - */ - public constantQueryString( + + /** + * @see {@link ConstantQueryStringCommand} + */ + constantQueryString( args: ConstantQueryStringCommandInput, options?: __HttpHandlerOptions ): Promise; - public constantQueryString( + constantQueryString( args: ConstantQueryStringCommandInput, cb: (err: any, data?: ConstantQueryStringCommandOutput) => void ): void; - public constantQueryString( + constantQueryString( args: ConstantQueryStringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConstantQueryStringCommandOutput) => void ): void; - public constantQueryString( - args: ConstantQueryStringCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConstantQueryStringCommandOutput) => void), - cb?: (err: any, data?: ConstantQueryStringCommandOutput) => void - ): Promise | void { - const command = new ConstantQueryStringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public datetimeOffsets( + + /** + * @see {@link DatetimeOffsetsCommand} + */ + datetimeOffsets( args: DatetimeOffsetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public datetimeOffsets( - args: DatetimeOffsetsCommandInput, - cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void - ): void; - public datetimeOffsets( + datetimeOffsets(args: DatetimeOffsetsCommandInput, cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void): void; + datetimeOffsets( args: DatetimeOffsetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void ): void; - public datetimeOffsets( - args: DatetimeOffsetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DatetimeOffsetsCommandOutput) => void), - cb?: (err: any, data?: DatetimeOffsetsCommandOutput) => void - ): Promise | void { - const command = new DatetimeOffsetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This example serializes a document as part of the payload. - */ - public documentType( - args: DocumentTypeCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public documentType(args: DocumentTypeCommandInput, cb: (err: any, data?: DocumentTypeCommandOutput) => void): void; - public documentType( + + /** + * @see {@link DocumentTypeCommand} + */ + documentType(args: DocumentTypeCommandInput, options?: __HttpHandlerOptions): Promise; + documentType(args: DocumentTypeCommandInput, cb: (err: any, data?: DocumentTypeCommandOutput) => void): void; + documentType( args: DocumentTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DocumentTypeCommandOutput) => void ): void; - public documentType( - args: DocumentTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DocumentTypeCommandOutput) => void), - cb?: (err: any, data?: DocumentTypeCommandOutput) => void - ): Promise | void { - const command = new DocumentTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This example serializes a document as the entire HTTP payload. - */ - public documentTypeAsPayload( + + /** + * @see {@link DocumentTypeAsPayloadCommand} + */ + documentTypeAsPayload( args: DocumentTypeAsPayloadCommandInput, options?: __HttpHandlerOptions ): Promise; - public documentTypeAsPayload( + documentTypeAsPayload( args: DocumentTypeAsPayloadCommandInput, cb: (err: any, data?: DocumentTypeAsPayloadCommandOutput) => void ): void; - public documentTypeAsPayload( + documentTypeAsPayload( args: DocumentTypeAsPayloadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DocumentTypeAsPayloadCommandOutput) => void ): void; - public documentTypeAsPayload( - args: DocumentTypeAsPayloadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DocumentTypeAsPayloadCommandOutput) => void), - cb?: (err: any, data?: DocumentTypeAsPayloadCommandOutput) => void - ): Promise | void { - const command = new DocumentTypeAsPayloadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response payload because the operation has an empty input - * and empty output structure that reuses the same shape. While this should - * be rare, code generators must support this. - */ - public emptyInputAndEmptyOutput( + + /** + * @see {@link EmptyInputAndEmptyOutputCommand} + */ + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, cb: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void ): void; - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void ): void; - public emptyInputAndEmptyOutput( - args: EmptyInputAndEmptyOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void), - cb?: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void - ): Promise | void { - const command = new EmptyInputAndEmptyOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public endpointOperation( + + /** + * @see {@link EndpointOperationCommand} + */ + endpointOperation( args: EndpointOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( - args: EndpointOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public endpointWithHostLabelOperation( + + /** + * @see {@link EndpointWithHostLabelOperationCommand} + */ + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( - args: EndpointWithHostLabelOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointWithHostLabelOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public fractionalSeconds( + + /** + * @see {@link FractionalSecondsCommand} + */ + fractionalSeconds( args: FractionalSecondsCommandInput, options?: __HttpHandlerOptions ): Promise; - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, cb: (err: any, data?: FractionalSecondsCommandOutput) => void ): void; - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FractionalSecondsCommandOutput) => void ): void; - public fractionalSeconds( - args: FractionalSecondsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FractionalSecondsCommandOutput) => void), - cb?: (err: any, data?: FractionalSecondsCommandOutput) => void - ): Promise | void { - const command = new FractionalSecondsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This operation has four possible return values: - * - * 1. A successful response in the form of GreetingWithErrorsOutput - * 2. An InvalidGreeting error. - * 3. A BadRequest error. - * 4. A FooError. - * - * Implementations must be able to successfully take a response and - * properly (de)serialize successful and error responses based on the - * the presence of the - */ - public greetingWithErrors( + + /** + * @see {@link GreetingWithErrorsCommand} + */ + greetingWithErrors( args: GreetingWithErrorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( - args: GreetingWithErrorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GreetingWithErrorsCommandOutput) => void), - cb?: (err: any, data?: GreetingWithErrorsCommandOutput) => void - ): Promise | void { - const command = new GreetingWithErrorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public hostWithPathOperation( + + /** + * @see {@link HostWithPathOperationCommand} + */ + hostWithPathOperation( args: HostWithPathOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, cb: (err: any, data?: HostWithPathOperationCommandOutput) => void ): void; - public hostWithPathOperation( + hostWithPathOperation( args: HostWithPathOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HostWithPathOperationCommandOutput) => void ): void; - public hostWithPathOperation( - args: HostWithPathOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HostWithPathOperationCommandOutput) => void), - cb?: (err: any, data?: HostWithPathOperationCommandOutput) => void - ): Promise | void { - const command = new HostWithPathOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This example tests httpChecksumRequired trait - */ - public httpChecksumRequired( + + /** + * @see {@link HttpChecksumRequiredCommand} + */ + httpChecksumRequired( args: HttpChecksumRequiredCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpChecksumRequired( + httpChecksumRequired( args: HttpChecksumRequiredCommandInput, cb: (err: any, data?: HttpChecksumRequiredCommandOutput) => void ): void; - public httpChecksumRequired( + httpChecksumRequired( args: HttpChecksumRequiredCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpChecksumRequiredCommandOutput) => void ): void; - public httpChecksumRequired( - args: HttpChecksumRequiredCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpChecksumRequiredCommandOutput) => void), - cb?: (err: any, data?: HttpChecksumRequiredCommandOutput) => void - ): Promise | void { - const command = new HttpChecksumRequiredCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public httpEnumPayload( + + /** + * @see {@link HttpEnumPayloadCommand} + */ + httpEnumPayload( args: HttpEnumPayloadCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpEnumPayload( - args: HttpEnumPayloadCommandInput, - cb: (err: any, data?: HttpEnumPayloadCommandOutput) => void - ): void; - public httpEnumPayload( + httpEnumPayload(args: HttpEnumPayloadCommandInput, cb: (err: any, data?: HttpEnumPayloadCommandOutput) => void): void; + httpEnumPayload( args: HttpEnumPayloadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpEnumPayloadCommandOutput) => void ): void; - public httpEnumPayload( - args: HttpEnumPayloadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpEnumPayloadCommandOutput) => void), - cb?: (err: any, data?: HttpEnumPayloadCommandOutput) => void - ): Promise | void { - const command = new HttpEnumPayloadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This examples serializes a blob shape in the payload. - * - * In this example, no JSON document is synthesized because the payload is - * not a structure or a union type. - */ - public httpPayloadTraits( + + /** + * @see {@link HttpPayloadTraitsCommand} + */ + httpPayloadTraits( args: HttpPayloadTraitsCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPayloadTraits( + httpPayloadTraits( args: HttpPayloadTraitsCommandInput, cb: (err: any, data?: HttpPayloadTraitsCommandOutput) => void ): void; - public httpPayloadTraits( + httpPayloadTraits( args: HttpPayloadTraitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPayloadTraitsCommandOutput) => void ): void; - public httpPayloadTraits( - args: HttpPayloadTraitsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPayloadTraitsCommandOutput) => void), - cb?: (err: any, data?: HttpPayloadTraitsCommandOutput) => void - ): Promise | void { - const command = new HttpPayloadTraitsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This examples uses a `@mediaType` trait on the payload to force a custom - * content-type to be serialized. - */ - public httpPayloadTraitsWithMediaType( + + /** + * @see {@link HttpPayloadTraitsWithMediaTypeCommand} + */ + httpPayloadTraitsWithMediaType( args: HttpPayloadTraitsWithMediaTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPayloadTraitsWithMediaType( + httpPayloadTraitsWithMediaType( args: HttpPayloadTraitsWithMediaTypeCommandInput, cb: (err: any, data?: HttpPayloadTraitsWithMediaTypeCommandOutput) => void ): void; - public httpPayloadTraitsWithMediaType( + httpPayloadTraitsWithMediaType( args: HttpPayloadTraitsWithMediaTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPayloadTraitsWithMediaTypeCommandOutput) => void ): void; - public httpPayloadTraitsWithMediaType( - args: HttpPayloadTraitsWithMediaTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPayloadTraitsWithMediaTypeCommandOutput) => void), - cb?: (err: any, data?: HttpPayloadTraitsWithMediaTypeCommandOutput) => void - ): Promise | void { - const command = new HttpPayloadTraitsWithMediaTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This examples serializes a structure in the payload. - * - * Note that serializing a structure changes the wrapper element name - * to match the targeted structure. - */ - public httpPayloadWithStructure( + + /** + * @see {@link HttpPayloadWithStructureCommand} + */ + httpPayloadWithStructure( args: HttpPayloadWithStructureCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPayloadWithStructure( + httpPayloadWithStructure( args: HttpPayloadWithStructureCommandInput, cb: (err: any, data?: HttpPayloadWithStructureCommandOutput) => void ): void; - public httpPayloadWithStructure( + httpPayloadWithStructure( args: HttpPayloadWithStructureCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPayloadWithStructureCommandOutput) => void ): void; - public httpPayloadWithStructure( - args: HttpPayloadWithStructureCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPayloadWithStructureCommandOutput) => void), - cb?: (err: any, data?: HttpPayloadWithStructureCommandOutput) => void - ): Promise | void { - const command = new HttpPayloadWithStructureCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This examples adds headers to the input of a request and response by prefix. - */ - public httpPrefixHeaders( + + /** + * @see {@link HttpPrefixHeadersCommand} + */ + httpPrefixHeaders( args: HttpPrefixHeadersCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPrefixHeaders( + httpPrefixHeaders( args: HttpPrefixHeadersCommandInput, cb: (err: any, data?: HttpPrefixHeadersCommandOutput) => void ): void; - public httpPrefixHeaders( + httpPrefixHeaders( args: HttpPrefixHeadersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPrefixHeadersCommandOutput) => void ): void; - public httpPrefixHeaders( - args: HttpPrefixHeadersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPrefixHeadersCommandOutput) => void), - cb?: (err: any, data?: HttpPrefixHeadersCommandOutput) => void - ): Promise | void { - const command = new HttpPrefixHeadersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Clients that perform this test extract all headers from the response. - */ - public httpPrefixHeadersInResponse( + + /** + * @see {@link HttpPrefixHeadersInResponseCommand} + */ + httpPrefixHeadersInResponse( args: HttpPrefixHeadersInResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPrefixHeadersInResponse( + httpPrefixHeadersInResponse( args: HttpPrefixHeadersInResponseCommandInput, cb: (err: any, data?: HttpPrefixHeadersInResponseCommandOutput) => void ): void; - public httpPrefixHeadersInResponse( + httpPrefixHeadersInResponse( args: HttpPrefixHeadersInResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPrefixHeadersInResponseCommandOutput) => void ): void; - public httpPrefixHeadersInResponse( - args: HttpPrefixHeadersInResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPrefixHeadersInResponseCommandOutput) => void), - cb?: (err: any, data?: HttpPrefixHeadersInResponseCommandOutput) => void - ): Promise | void { - const command = new HttpPrefixHeadersInResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public httpRequestWithFloatLabels( + + /** + * @see {@link HttpRequestWithFloatLabelsCommand} + */ + httpRequestWithFloatLabels( args: HttpRequestWithFloatLabelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpRequestWithFloatLabels( + httpRequestWithFloatLabels( args: HttpRequestWithFloatLabelsCommandInput, cb: (err: any, data?: HttpRequestWithFloatLabelsCommandOutput) => void ): void; - public httpRequestWithFloatLabels( + httpRequestWithFloatLabels( args: HttpRequestWithFloatLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpRequestWithFloatLabelsCommandOutput) => void ): void; - public httpRequestWithFloatLabels( - args: HttpRequestWithFloatLabelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpRequestWithFloatLabelsCommandOutput) => void), - cb?: (err: any, data?: HttpRequestWithFloatLabelsCommandOutput) => void - ): Promise | void { - const command = new HttpRequestWithFloatLabelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public httpRequestWithGreedyLabelInPath( + + /** + * @see {@link HttpRequestWithGreedyLabelInPathCommand} + */ + httpRequestWithGreedyLabelInPath( args: HttpRequestWithGreedyLabelInPathCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpRequestWithGreedyLabelInPath( + httpRequestWithGreedyLabelInPath( args: HttpRequestWithGreedyLabelInPathCommandInput, cb: (err: any, data?: HttpRequestWithGreedyLabelInPathCommandOutput) => void ): void; - public httpRequestWithGreedyLabelInPath( + httpRequestWithGreedyLabelInPath( args: HttpRequestWithGreedyLabelInPathCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpRequestWithGreedyLabelInPathCommandOutput) => void ): void; - public httpRequestWithGreedyLabelInPath( - args: HttpRequestWithGreedyLabelInPathCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpRequestWithGreedyLabelInPathCommandOutput) => void), - cb?: (err: any, data?: HttpRequestWithGreedyLabelInPathCommandOutput) => void - ): Promise | void { - const command = new HttpRequestWithGreedyLabelInPathCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * The example tests how requests are serialized when there's no input - * payload but there are HTTP labels. - */ - public httpRequestWithLabels( + + /** + * @see {@link HttpRequestWithLabelsCommand} + */ + httpRequestWithLabels( args: HttpRequestWithLabelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpRequestWithLabels( + httpRequestWithLabels( args: HttpRequestWithLabelsCommandInput, cb: (err: any, data?: HttpRequestWithLabelsCommandOutput) => void ): void; - public httpRequestWithLabels( + httpRequestWithLabels( args: HttpRequestWithLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpRequestWithLabelsCommandOutput) => void ): void; - public httpRequestWithLabels( - args: HttpRequestWithLabelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpRequestWithLabelsCommandOutput) => void), - cb?: (err: any, data?: HttpRequestWithLabelsCommandOutput) => void - ): Promise | void { - const command = new HttpRequestWithLabelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * The example tests how requests serialize different timestamp formats in the - * URI path. - */ - public httpRequestWithLabelsAndTimestampFormat( + + /** + * @see {@link HttpRequestWithLabelsAndTimestampFormatCommand} + */ + httpRequestWithLabelsAndTimestampFormat( args: HttpRequestWithLabelsAndTimestampFormatCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpRequestWithLabelsAndTimestampFormat( + httpRequestWithLabelsAndTimestampFormat( args: HttpRequestWithLabelsAndTimestampFormatCommandInput, cb: (err: any, data?: HttpRequestWithLabelsAndTimestampFormatCommandOutput) => void ): void; - public httpRequestWithLabelsAndTimestampFormat( + httpRequestWithLabelsAndTimestampFormat( args: HttpRequestWithLabelsAndTimestampFormatCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpRequestWithLabelsAndTimestampFormatCommandOutput) => void ): void; - public httpRequestWithLabelsAndTimestampFormat( - args: HttpRequestWithLabelsAndTimestampFormatCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: HttpRequestWithLabelsAndTimestampFormatCommandOutput) => void), - cb?: (err: any, data?: HttpRequestWithLabelsAndTimestampFormatCommandOutput) => void - ): Promise | void { - const command = new HttpRequestWithLabelsAndTimestampFormatCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public httpRequestWithRegexLiteral( + + /** + * @see {@link HttpRequestWithRegexLiteralCommand} + */ + httpRequestWithRegexLiteral( args: HttpRequestWithRegexLiteralCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpRequestWithRegexLiteral( + httpRequestWithRegexLiteral( args: HttpRequestWithRegexLiteralCommandInput, cb: (err: any, data?: HttpRequestWithRegexLiteralCommandOutput) => void ): void; - public httpRequestWithRegexLiteral( + httpRequestWithRegexLiteral( args: HttpRequestWithRegexLiteralCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpRequestWithRegexLiteralCommandOutput) => void ): void; - public httpRequestWithRegexLiteral( - args: HttpRequestWithRegexLiteralCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpRequestWithRegexLiteralCommandOutput) => void), - cb?: (err: any, data?: HttpRequestWithRegexLiteralCommandOutput) => void - ): Promise | void { - const command = new HttpRequestWithRegexLiteralCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public httpResponseCode( + + /** + * @see {@link HttpResponseCodeCommand} + */ + httpResponseCode( args: HttpResponseCodeCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpResponseCode( + httpResponseCode( args: HttpResponseCodeCommandInput, cb: (err: any, data?: HttpResponseCodeCommandOutput) => void ): void; - public httpResponseCode( + httpResponseCode( args: HttpResponseCodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpResponseCodeCommandOutput) => void ): void; - public httpResponseCode( - args: HttpResponseCodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpResponseCodeCommandOutput) => void), - cb?: (err: any, data?: HttpResponseCodeCommandOutput) => void - ): Promise | void { - const command = new HttpResponseCodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public httpStringPayload( + + /** + * @see {@link HttpStringPayloadCommand} + */ + httpStringPayload( args: HttpStringPayloadCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpStringPayload( + httpStringPayload( args: HttpStringPayloadCommandInput, cb: (err: any, data?: HttpStringPayloadCommandOutput) => void ): void; - public httpStringPayload( + httpStringPayload( args: HttpStringPayloadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpStringPayloadCommandOutput) => void ): void; - public httpStringPayload( - args: HttpStringPayloadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpStringPayloadCommandOutput) => void), - cb?: (err: any, data?: HttpStringPayloadCommandOutput) => void - ): Promise | void { - const command = new HttpStringPayloadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This example ensures that query string bound request parameters are - * serialized in the body of responses if the structure is used in both - * the request and response. - */ - public ignoreQueryParamsInResponse( + + /** + * @see {@link IgnoreQueryParamsInResponseCommand} + */ + ignoreQueryParamsInResponse( args: IgnoreQueryParamsInResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public ignoreQueryParamsInResponse( + ignoreQueryParamsInResponse( args: IgnoreQueryParamsInResponseCommandInput, cb: (err: any, data?: IgnoreQueryParamsInResponseCommandOutput) => void ): void; - public ignoreQueryParamsInResponse( + ignoreQueryParamsInResponse( args: IgnoreQueryParamsInResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IgnoreQueryParamsInResponseCommandOutput) => void ): void; - public ignoreQueryParamsInResponse( - args: IgnoreQueryParamsInResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: IgnoreQueryParamsInResponseCommandOutput) => void), - cb?: (err: any, data?: IgnoreQueryParamsInResponseCommandOutput) => void - ): Promise | void { - const command = new IgnoreQueryParamsInResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * The example tests how requests and responses are serialized when there is - * no input or output payload but there are HTTP header bindings. - */ - public inputAndOutputWithHeaders( + + /** + * @see {@link InputAndOutputWithHeadersCommand} + */ + inputAndOutputWithHeaders( args: InputAndOutputWithHeadersCommandInput, options?: __HttpHandlerOptions ): Promise; - public inputAndOutputWithHeaders( + inputAndOutputWithHeaders( args: InputAndOutputWithHeadersCommandInput, cb: (err: any, data?: InputAndOutputWithHeadersCommandOutput) => void ): void; - public inputAndOutputWithHeaders( + inputAndOutputWithHeaders( args: InputAndOutputWithHeadersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InputAndOutputWithHeadersCommandOutput) => void ): void; - public inputAndOutputWithHeaders( - args: InputAndOutputWithHeadersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InputAndOutputWithHeadersCommandOutput) => void), - cb?: (err: any, data?: InputAndOutputWithHeadersCommandOutput) => void - ): Promise | void { - const command = new InputAndOutputWithHeadersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Blobs are base64 encoded - */ - public jsonBlobs(args: JsonBlobsCommandInput, options?: __HttpHandlerOptions): Promise; - public jsonBlobs(args: JsonBlobsCommandInput, cb: (err: any, data?: JsonBlobsCommandOutput) => void): void; - public jsonBlobs( + + /** + * @see {@link JsonBlobsCommand} + */ + jsonBlobs(args: JsonBlobsCommandInput, options?: __HttpHandlerOptions): Promise; + jsonBlobs(args: JsonBlobsCommandInput, cb: (err: any, data?: JsonBlobsCommandOutput) => void): void; + jsonBlobs( args: JsonBlobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JsonBlobsCommandOutput) => void ): void; - public jsonBlobs( - args: JsonBlobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: JsonBlobsCommandOutput) => void), - cb?: (err: any, data?: JsonBlobsCommandOutput) => void - ): Promise | void { - const command = new JsonBlobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This example serializes enums as top level properties, in lists, sets, and maps. - */ - public jsonEnums(args: JsonEnumsCommandInput, options?: __HttpHandlerOptions): Promise; - public jsonEnums(args: JsonEnumsCommandInput, cb: (err: any, data?: JsonEnumsCommandOutput) => void): void; - public jsonEnums( + + /** + * @see {@link JsonEnumsCommand} + */ + jsonEnums(args: JsonEnumsCommandInput, options?: __HttpHandlerOptions): Promise; + jsonEnums(args: JsonEnumsCommandInput, cb: (err: any, data?: JsonEnumsCommandOutput) => void): void; + jsonEnums( args: JsonEnumsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JsonEnumsCommandOutput) => void ): void; - public jsonEnums( - args: JsonEnumsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: JsonEnumsCommandOutput) => void), - cb?: (err: any, data?: JsonEnumsCommandOutput) => void - ): Promise | void { - const command = new JsonEnumsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This example serializes intEnums as top level properties, in lists, sets, and maps. - */ - public jsonIntEnums( - args: JsonIntEnumsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public jsonIntEnums(args: JsonIntEnumsCommandInput, cb: (err: any, data?: JsonIntEnumsCommandOutput) => void): void; - public jsonIntEnums( + + /** + * @see {@link JsonIntEnumsCommand} + */ + jsonIntEnums(args: JsonIntEnumsCommandInput, options?: __HttpHandlerOptions): Promise; + jsonIntEnums(args: JsonIntEnumsCommandInput, cb: (err: any, data?: JsonIntEnumsCommandOutput) => void): void; + jsonIntEnums( args: JsonIntEnumsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JsonIntEnumsCommandOutput) => void ): void; - public jsonIntEnums( - args: JsonIntEnumsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: JsonIntEnumsCommandOutput) => void), - cb?: (err: any, data?: JsonIntEnumsCommandOutput) => void - ): Promise | void { - const command = new JsonIntEnumsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This test case serializes JSON lists for the following cases for both - * input and output: - * - * 1. Normal JSON lists. - * 2. Normal JSON sets. - * 3. JSON lists of lists. - * 4. Lists of structures. - */ - public jsonLists(args: JsonListsCommandInput, options?: __HttpHandlerOptions): Promise; - public jsonLists(args: JsonListsCommandInput, cb: (err: any, data?: JsonListsCommandOutput) => void): void; - public jsonLists( + + /** + * @see {@link JsonListsCommand} + */ + jsonLists(args: JsonListsCommandInput, options?: __HttpHandlerOptions): Promise; + jsonLists(args: JsonListsCommandInput, cb: (err: any, data?: JsonListsCommandOutput) => void): void; + jsonLists( args: JsonListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JsonListsCommandOutput) => void ): void; - public jsonLists( - args: JsonListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: JsonListsCommandOutput) => void), - cb?: (err: any, data?: JsonListsCommandOutput) => void - ): Promise | void { - const command = new JsonListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * The example tests basic map serialization. - */ - public jsonMaps(args: JsonMapsCommandInput, options?: __HttpHandlerOptions): Promise; - public jsonMaps(args: JsonMapsCommandInput, cb: (err: any, data?: JsonMapsCommandOutput) => void): void; - public jsonMaps( + + /** + * @see {@link JsonMapsCommand} + */ + jsonMaps(args: JsonMapsCommandInput, options?: __HttpHandlerOptions): Promise; + jsonMaps(args: JsonMapsCommandInput, cb: (err: any, data?: JsonMapsCommandOutput) => void): void; + jsonMaps( args: JsonMapsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JsonMapsCommandOutput) => void ): void; - public jsonMaps( - args: JsonMapsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: JsonMapsCommandOutput) => void), - cb?: (err: any, data?: JsonMapsCommandOutput) => void - ): Promise | void { - const command = new JsonMapsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This tests how timestamps are serialized, including using the - * default format of date-time and various @timestampFormat trait - * values. - */ - public jsonTimestamps( + + /** + * @see {@link JsonTimestampsCommand} + */ + jsonTimestamps( args: JsonTimestampsCommandInput, options?: __HttpHandlerOptions ): Promise; - public jsonTimestamps( - args: JsonTimestampsCommandInput, - cb: (err: any, data?: JsonTimestampsCommandOutput) => void - ): void; - public jsonTimestamps( + jsonTimestamps(args: JsonTimestampsCommandInput, cb: (err: any, data?: JsonTimestampsCommandOutput) => void): void; + jsonTimestamps( args: JsonTimestampsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JsonTimestampsCommandOutput) => void ): void; - public jsonTimestamps( - args: JsonTimestampsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: JsonTimestampsCommandOutput) => void), - cb?: (err: any, data?: JsonTimestampsCommandOutput) => void - ): Promise | void { - const command = new JsonTimestampsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This operation uses unions for inputs and outputs. - */ - public jsonUnions(args: JsonUnionsCommandInput, options?: __HttpHandlerOptions): Promise; - public jsonUnions(args: JsonUnionsCommandInput, cb: (err: any, data?: JsonUnionsCommandOutput) => void): void; - public jsonUnions( + + /** + * @see {@link JsonUnionsCommand} + */ + jsonUnions(args: JsonUnionsCommandInput, options?: __HttpHandlerOptions): Promise; + jsonUnions(args: JsonUnionsCommandInput, cb: (err: any, data?: JsonUnionsCommandOutput) => void): void; + jsonUnions( args: JsonUnionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JsonUnionsCommandOutput) => void ): void; - public jsonUnions( - args: JsonUnionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: JsonUnionsCommandOutput) => void), - cb?: (err: any, data?: JsonUnionsCommandOutput) => void - ): Promise | void { - const command = new JsonUnionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedAcceptWithBody( + + /** + * @see {@link MalformedAcceptWithBodyCommand} + */ + malformedAcceptWithBody( args: MalformedAcceptWithBodyCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedAcceptWithBody( + malformedAcceptWithBody( args: MalformedAcceptWithBodyCommandInput, cb: (err: any, data?: MalformedAcceptWithBodyCommandOutput) => void ): void; - public malformedAcceptWithBody( + malformedAcceptWithBody( args: MalformedAcceptWithBodyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedAcceptWithBodyCommandOutput) => void ): void; - public malformedAcceptWithBody( - args: MalformedAcceptWithBodyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedAcceptWithBodyCommandOutput) => void), - cb?: (err: any, data?: MalformedAcceptWithBodyCommandOutput) => void - ): Promise | void { - const command = new MalformedAcceptWithBodyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedAcceptWithGenericString( + + /** + * @see {@link MalformedAcceptWithGenericStringCommand} + */ + malformedAcceptWithGenericString( args: MalformedAcceptWithGenericStringCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedAcceptWithGenericString( + malformedAcceptWithGenericString( args: MalformedAcceptWithGenericStringCommandInput, cb: (err: any, data?: MalformedAcceptWithGenericStringCommandOutput) => void ): void; - public malformedAcceptWithGenericString( + malformedAcceptWithGenericString( args: MalformedAcceptWithGenericStringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedAcceptWithGenericStringCommandOutput) => void ): void; - public malformedAcceptWithGenericString( - args: MalformedAcceptWithGenericStringCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedAcceptWithGenericStringCommandOutput) => void), - cb?: (err: any, data?: MalformedAcceptWithGenericStringCommandOutput) => void - ): Promise | void { - const command = new MalformedAcceptWithGenericStringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedAcceptWithPayload( + + /** + * @see {@link MalformedAcceptWithPayloadCommand} + */ + malformedAcceptWithPayload( args: MalformedAcceptWithPayloadCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedAcceptWithPayload( + malformedAcceptWithPayload( args: MalformedAcceptWithPayloadCommandInput, cb: (err: any, data?: MalformedAcceptWithPayloadCommandOutput) => void ): void; - public malformedAcceptWithPayload( + malformedAcceptWithPayload( args: MalformedAcceptWithPayloadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedAcceptWithPayloadCommandOutput) => void ): void; - public malformedAcceptWithPayload( - args: MalformedAcceptWithPayloadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedAcceptWithPayloadCommandOutput) => void), - cb?: (err: any, data?: MalformedAcceptWithPayloadCommandOutput) => void - ): Promise | void { - const command = new MalformedAcceptWithPayloadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedBlob( - args: MalformedBlobCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public malformedBlob( - args: MalformedBlobCommandInput, - cb: (err: any, data?: MalformedBlobCommandOutput) => void - ): void; - public malformedBlob( + + /** + * @see {@link MalformedBlobCommand} + */ + malformedBlob(args: MalformedBlobCommandInput, options?: __HttpHandlerOptions): Promise; + malformedBlob(args: MalformedBlobCommandInput, cb: (err: any, data?: MalformedBlobCommandOutput) => void): void; + malformedBlob( args: MalformedBlobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedBlobCommandOutput) => void ): void; - public malformedBlob( - args: MalformedBlobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedBlobCommandOutput) => void), - cb?: (err: any, data?: MalformedBlobCommandOutput) => void - ): Promise | void { - const command = new MalformedBlobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedBoolean( + + /** + * @see {@link MalformedBooleanCommand} + */ + malformedBoolean( args: MalformedBooleanCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedBoolean( + malformedBoolean( args: MalformedBooleanCommandInput, cb: (err: any, data?: MalformedBooleanCommandOutput) => void ): void; - public malformedBoolean( - args: MalformedBooleanCommandInput, - options: __HttpHandlerOptions, - cb: (err: any, data?: MalformedBooleanCommandOutput) => void - ): void; - public malformedBoolean( - args: MalformedBooleanCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedBooleanCommandOutput) => void), - cb?: (err: any, data?: MalformedBooleanCommandOutput) => void - ): Promise | void { - const command = new MalformedBooleanCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedByte( - args: MalformedByteCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public malformedByte( - args: MalformedByteCommandInput, - cb: (err: any, data?: MalformedByteCommandOutput) => void - ): void; - public malformedByte( + malformedBoolean( + args: MalformedBooleanCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: MalformedBooleanCommandOutput) => void + ): void; + + /** + * @see {@link MalformedByteCommand} + */ + malformedByte(args: MalformedByteCommandInput, options?: __HttpHandlerOptions): Promise; + malformedByte(args: MalformedByteCommandInput, cb: (err: any, data?: MalformedByteCommandOutput) => void): void; + malformedByte( args: MalformedByteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedByteCommandOutput) => void ): void; - public malformedByte( - args: MalformedByteCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedByteCommandOutput) => void), - cb?: (err: any, data?: MalformedByteCommandOutput) => void - ): Promise | void { - const command = new MalformedByteCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedContentTypeWithBody( + + /** + * @see {@link MalformedContentTypeWithBodyCommand} + */ + malformedContentTypeWithBody( args: MalformedContentTypeWithBodyCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedContentTypeWithBody( + malformedContentTypeWithBody( args: MalformedContentTypeWithBodyCommandInput, cb: (err: any, data?: MalformedContentTypeWithBodyCommandOutput) => void ): void; - public malformedContentTypeWithBody( + malformedContentTypeWithBody( args: MalformedContentTypeWithBodyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedContentTypeWithBodyCommandOutput) => void ): void; - public malformedContentTypeWithBody( - args: MalformedContentTypeWithBodyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedContentTypeWithBodyCommandOutput) => void), - cb?: (err: any, data?: MalformedContentTypeWithBodyCommandOutput) => void - ): Promise | void { - const command = new MalformedContentTypeWithBodyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedContentTypeWithGenericString( + + /** + * @see {@link MalformedContentTypeWithGenericStringCommand} + */ + malformedContentTypeWithGenericString( args: MalformedContentTypeWithGenericStringCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedContentTypeWithGenericString( + malformedContentTypeWithGenericString( args: MalformedContentTypeWithGenericStringCommandInput, cb: (err: any, data?: MalformedContentTypeWithGenericStringCommandOutput) => void ): void; - public malformedContentTypeWithGenericString( + malformedContentTypeWithGenericString( args: MalformedContentTypeWithGenericStringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedContentTypeWithGenericStringCommandOutput) => void ): void; - public malformedContentTypeWithGenericString( - args: MalformedContentTypeWithGenericStringCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: MalformedContentTypeWithGenericStringCommandOutput) => void), - cb?: (err: any, data?: MalformedContentTypeWithGenericStringCommandOutput) => void - ): Promise | void { - const command = new MalformedContentTypeWithGenericStringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedContentTypeWithoutBody( + + /** + * @see {@link MalformedContentTypeWithoutBodyCommand} + */ + malformedContentTypeWithoutBody( args: MalformedContentTypeWithoutBodyCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedContentTypeWithoutBody( + malformedContentTypeWithoutBody( args: MalformedContentTypeWithoutBodyCommandInput, cb: (err: any, data?: MalformedContentTypeWithoutBodyCommandOutput) => void ): void; - public malformedContentTypeWithoutBody( + malformedContentTypeWithoutBody( args: MalformedContentTypeWithoutBodyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedContentTypeWithoutBodyCommandOutput) => void ): void; - public malformedContentTypeWithoutBody( - args: MalformedContentTypeWithoutBodyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedContentTypeWithoutBodyCommandOutput) => void), - cb?: (err: any, data?: MalformedContentTypeWithoutBodyCommandOutput) => void - ): Promise | void { - const command = new MalformedContentTypeWithoutBodyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedContentTypeWithPayload( + + /** + * @see {@link MalformedContentTypeWithPayloadCommand} + */ + malformedContentTypeWithPayload( args: MalformedContentTypeWithPayloadCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedContentTypeWithPayload( + malformedContentTypeWithPayload( args: MalformedContentTypeWithPayloadCommandInput, cb: (err: any, data?: MalformedContentTypeWithPayloadCommandOutput) => void ): void; - public malformedContentTypeWithPayload( + malformedContentTypeWithPayload( args: MalformedContentTypeWithPayloadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedContentTypeWithPayloadCommandOutput) => void ): void; - public malformedContentTypeWithPayload( - args: MalformedContentTypeWithPayloadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedContentTypeWithPayloadCommandOutput) => void), - cb?: (err: any, data?: MalformedContentTypeWithPayloadCommandOutput) => void - ): Promise | void { - const command = new MalformedContentTypeWithPayloadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedDouble( + + /** + * @see {@link MalformedDoubleCommand} + */ + malformedDouble( args: MalformedDoubleCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedDouble( - args: MalformedDoubleCommandInput, - cb: (err: any, data?: MalformedDoubleCommandOutput) => void - ): void; - public malformedDouble( + malformedDouble(args: MalformedDoubleCommandInput, cb: (err: any, data?: MalformedDoubleCommandOutput) => void): void; + malformedDouble( args: MalformedDoubleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedDoubleCommandOutput) => void ): void; - public malformedDouble( - args: MalformedDoubleCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedDoubleCommandOutput) => void), - cb?: (err: any, data?: MalformedDoubleCommandOutput) => void - ): Promise | void { - const command = new MalformedDoubleCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedFloat( + + /** + * @see {@link MalformedFloatCommand} + */ + malformedFloat( args: MalformedFloatCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedFloat( - args: MalformedFloatCommandInput, - cb: (err: any, data?: MalformedFloatCommandOutput) => void - ): void; - public malformedFloat( + malformedFloat(args: MalformedFloatCommandInput, cb: (err: any, data?: MalformedFloatCommandOutput) => void): void; + malformedFloat( args: MalformedFloatCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedFloatCommandOutput) => void ): void; - public malformedFloat( - args: MalformedFloatCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedFloatCommandOutput) => void), - cb?: (err: any, data?: MalformedFloatCommandOutput) => void - ): Promise | void { - const command = new MalformedFloatCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedInteger( + + /** + * @see {@link MalformedIntegerCommand} + */ + malformedInteger( args: MalformedIntegerCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedInteger( + malformedInteger( args: MalformedIntegerCommandInput, cb: (err: any, data?: MalformedIntegerCommandOutput) => void ): void; - public malformedInteger( + malformedInteger( args: MalformedIntegerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedIntegerCommandOutput) => void ): void; - public malformedInteger( - args: MalformedIntegerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedIntegerCommandOutput) => void), - cb?: (err: any, data?: MalformedIntegerCommandOutput) => void - ): Promise | void { - const command = new MalformedIntegerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedList( - args: MalformedListCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public malformedList( - args: MalformedListCommandInput, - cb: (err: any, data?: MalformedListCommandOutput) => void - ): void; - public malformedList( + + /** + * @see {@link MalformedListCommand} + */ + malformedList(args: MalformedListCommandInput, options?: __HttpHandlerOptions): Promise; + malformedList(args: MalformedListCommandInput, cb: (err: any, data?: MalformedListCommandOutput) => void): void; + malformedList( args: MalformedListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedListCommandOutput) => void ): void; - public malformedList( - args: MalformedListCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedListCommandOutput) => void), - cb?: (err: any, data?: MalformedListCommandOutput) => void - ): Promise | void { - const command = new MalformedListCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedLong( - args: MalformedLongCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public malformedLong( - args: MalformedLongCommandInput, - cb: (err: any, data?: MalformedLongCommandOutput) => void - ): void; - public malformedLong( + + /** + * @see {@link MalformedLongCommand} + */ + malformedLong(args: MalformedLongCommandInput, options?: __HttpHandlerOptions): Promise; + malformedLong(args: MalformedLongCommandInput, cb: (err: any, data?: MalformedLongCommandOutput) => void): void; + malformedLong( args: MalformedLongCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedLongCommandOutput) => void ): void; - public malformedLong( - args: MalformedLongCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedLongCommandOutput) => void), - cb?: (err: any, data?: MalformedLongCommandOutput) => void - ): Promise | void { - const command = new MalformedLongCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedMap( - args: MalformedMapCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public malformedMap(args: MalformedMapCommandInput, cb: (err: any, data?: MalformedMapCommandOutput) => void): void; - public malformedMap( + + /** + * @see {@link MalformedMapCommand} + */ + malformedMap(args: MalformedMapCommandInput, options?: __HttpHandlerOptions): Promise; + malformedMap(args: MalformedMapCommandInput, cb: (err: any, data?: MalformedMapCommandOutput) => void): void; + malformedMap( args: MalformedMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedMapCommandOutput) => void ): void; - public malformedMap( - args: MalformedMapCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedMapCommandOutput) => void), - cb?: (err: any, data?: MalformedMapCommandOutput) => void - ): Promise | void { - const command = new MalformedMapCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedRequestBody( + + /** + * @see {@link MalformedRequestBodyCommand} + */ + malformedRequestBody( args: MalformedRequestBodyCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedRequestBody( + malformedRequestBody( args: MalformedRequestBodyCommandInput, cb: (err: any, data?: MalformedRequestBodyCommandOutput) => void ): void; - public malformedRequestBody( + malformedRequestBody( args: MalformedRequestBodyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedRequestBodyCommandOutput) => void ): void; - public malformedRequestBody( - args: MalformedRequestBodyCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedRequestBodyCommandOutput) => void), - cb?: (err: any, data?: MalformedRequestBodyCommandOutput) => void - ): Promise | void { - const command = new MalformedRequestBodyCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedShort( + + /** + * @see {@link MalformedShortCommand} + */ + malformedShort( args: MalformedShortCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedShort( - args: MalformedShortCommandInput, - cb: (err: any, data?: MalformedShortCommandOutput) => void - ): void; - public malformedShort( + malformedShort(args: MalformedShortCommandInput, cb: (err: any, data?: MalformedShortCommandOutput) => void): void; + malformedShort( args: MalformedShortCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedShortCommandOutput) => void ): void; - public malformedShort( - args: MalformedShortCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedShortCommandOutput) => void), - cb?: (err: any, data?: MalformedShortCommandOutput) => void - ): Promise | void { - const command = new MalformedShortCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedString( + + /** + * @see {@link MalformedStringCommand} + */ + malformedString( args: MalformedStringCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedString( - args: MalformedStringCommandInput, - cb: (err: any, data?: MalformedStringCommandOutput) => void - ): void; - public malformedString( + malformedString(args: MalformedStringCommandInput, cb: (err: any, data?: MalformedStringCommandOutput) => void): void; + malformedString( args: MalformedStringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedStringCommandOutput) => void ): void; - public malformedString( - args: MalformedStringCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedStringCommandOutput) => void), - cb?: (err: any, data?: MalformedStringCommandOutput) => void - ): Promise | void { - const command = new MalformedStringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedTimestampBodyDateTime( + + /** + * @see {@link MalformedTimestampBodyDateTimeCommand} + */ + malformedTimestampBodyDateTime( args: MalformedTimestampBodyDateTimeCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampBodyDateTime( + malformedTimestampBodyDateTime( args: MalformedTimestampBodyDateTimeCommandInput, cb: (err: any, data?: MalformedTimestampBodyDateTimeCommandOutput) => void ): void; - public malformedTimestampBodyDateTime( + malformedTimestampBodyDateTime( args: MalformedTimestampBodyDateTimeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampBodyDateTimeCommandOutput) => void ): void; - public malformedTimestampBodyDateTime( - args: MalformedTimestampBodyDateTimeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampBodyDateTimeCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampBodyDateTimeCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampBodyDateTimeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedTimestampBodyDefault( + + /** + * @see {@link MalformedTimestampBodyDefaultCommand} + */ + malformedTimestampBodyDefault( args: MalformedTimestampBodyDefaultCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampBodyDefault( + malformedTimestampBodyDefault( args: MalformedTimestampBodyDefaultCommandInput, cb: (err: any, data?: MalformedTimestampBodyDefaultCommandOutput) => void ): void; - public malformedTimestampBodyDefault( + malformedTimestampBodyDefault( args: MalformedTimestampBodyDefaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampBodyDefaultCommandOutput) => void ): void; - public malformedTimestampBodyDefault( - args: MalformedTimestampBodyDefaultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampBodyDefaultCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampBodyDefaultCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampBodyDefaultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedTimestampBodyHttpDate( + + /** + * @see {@link MalformedTimestampBodyHttpDateCommand} + */ + malformedTimestampBodyHttpDate( args: MalformedTimestampBodyHttpDateCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampBodyHttpDate( + malformedTimestampBodyHttpDate( args: MalformedTimestampBodyHttpDateCommandInput, cb: (err: any, data?: MalformedTimestampBodyHttpDateCommandOutput) => void ): void; - public malformedTimestampBodyHttpDate( + malformedTimestampBodyHttpDate( args: MalformedTimestampBodyHttpDateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampBodyHttpDateCommandOutput) => void ): void; - public malformedTimestampBodyHttpDate( - args: MalformedTimestampBodyHttpDateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampBodyHttpDateCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampBodyHttpDateCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampBodyHttpDateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedTimestampHeaderDateTime( + + /** + * @see {@link MalformedTimestampHeaderDateTimeCommand} + */ + malformedTimestampHeaderDateTime( args: MalformedTimestampHeaderDateTimeCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampHeaderDateTime( + malformedTimestampHeaderDateTime( args: MalformedTimestampHeaderDateTimeCommandInput, cb: (err: any, data?: MalformedTimestampHeaderDateTimeCommandOutput) => void ): void; - public malformedTimestampHeaderDateTime( + malformedTimestampHeaderDateTime( args: MalformedTimestampHeaderDateTimeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampHeaderDateTimeCommandOutput) => void ): void; - public malformedTimestampHeaderDateTime( - args: MalformedTimestampHeaderDateTimeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampHeaderDateTimeCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampHeaderDateTimeCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampHeaderDateTimeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedTimestampHeaderDefault( + + /** + * @see {@link MalformedTimestampHeaderDefaultCommand} + */ + malformedTimestampHeaderDefault( args: MalformedTimestampHeaderDefaultCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampHeaderDefault( + malformedTimestampHeaderDefault( args: MalformedTimestampHeaderDefaultCommandInput, cb: (err: any, data?: MalformedTimestampHeaderDefaultCommandOutput) => void ): void; - public malformedTimestampHeaderDefault( + malformedTimestampHeaderDefault( args: MalformedTimestampHeaderDefaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampHeaderDefaultCommandOutput) => void ): void; - public malformedTimestampHeaderDefault( - args: MalformedTimestampHeaderDefaultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampHeaderDefaultCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampHeaderDefaultCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampHeaderDefaultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedTimestampHeaderEpoch( + + /** + * @see {@link MalformedTimestampHeaderEpochCommand} + */ + malformedTimestampHeaderEpoch( args: MalformedTimestampHeaderEpochCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampHeaderEpoch( + malformedTimestampHeaderEpoch( args: MalformedTimestampHeaderEpochCommandInput, cb: (err: any, data?: MalformedTimestampHeaderEpochCommandOutput) => void ): void; - public malformedTimestampHeaderEpoch( + malformedTimestampHeaderEpoch( args: MalformedTimestampHeaderEpochCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampHeaderEpochCommandOutput) => void ): void; - public malformedTimestampHeaderEpoch( - args: MalformedTimestampHeaderEpochCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampHeaderEpochCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampHeaderEpochCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampHeaderEpochCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedTimestampPathDefault( + + /** + * @see {@link MalformedTimestampPathDefaultCommand} + */ + malformedTimestampPathDefault( args: MalformedTimestampPathDefaultCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampPathDefault( + malformedTimestampPathDefault( args: MalformedTimestampPathDefaultCommandInput, cb: (err: any, data?: MalformedTimestampPathDefaultCommandOutput) => void ): void; - public malformedTimestampPathDefault( + malformedTimestampPathDefault( args: MalformedTimestampPathDefaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampPathDefaultCommandOutput) => void ): void; - public malformedTimestampPathDefault( - args: MalformedTimestampPathDefaultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampPathDefaultCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampPathDefaultCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampPathDefaultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedTimestampPathEpoch( + + /** + * @see {@link MalformedTimestampPathEpochCommand} + */ + malformedTimestampPathEpoch( args: MalformedTimestampPathEpochCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampPathEpoch( + malformedTimestampPathEpoch( args: MalformedTimestampPathEpochCommandInput, cb: (err: any, data?: MalformedTimestampPathEpochCommandOutput) => void ): void; - public malformedTimestampPathEpoch( + malformedTimestampPathEpoch( args: MalformedTimestampPathEpochCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampPathEpochCommandOutput) => void ): void; - public malformedTimestampPathEpoch( - args: MalformedTimestampPathEpochCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampPathEpochCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampPathEpochCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampPathEpochCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedTimestampPathHttpDate( + + /** + * @see {@link MalformedTimestampPathHttpDateCommand} + */ + malformedTimestampPathHttpDate( args: MalformedTimestampPathHttpDateCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampPathHttpDate( + malformedTimestampPathHttpDate( args: MalformedTimestampPathHttpDateCommandInput, cb: (err: any, data?: MalformedTimestampPathHttpDateCommandOutput) => void ): void; - public malformedTimestampPathHttpDate( + malformedTimestampPathHttpDate( args: MalformedTimestampPathHttpDateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampPathHttpDateCommandOutput) => void ): void; - public malformedTimestampPathHttpDate( - args: MalformedTimestampPathHttpDateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampPathHttpDateCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampPathHttpDateCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampPathHttpDateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedTimestampQueryDefault( + + /** + * @see {@link MalformedTimestampQueryDefaultCommand} + */ + malformedTimestampQueryDefault( args: MalformedTimestampQueryDefaultCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampQueryDefault( + malformedTimestampQueryDefault( args: MalformedTimestampQueryDefaultCommandInput, cb: (err: any, data?: MalformedTimestampQueryDefaultCommandOutput) => void ): void; - public malformedTimestampQueryDefault( + malformedTimestampQueryDefault( args: MalformedTimestampQueryDefaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampQueryDefaultCommandOutput) => void ): void; - public malformedTimestampQueryDefault( - args: MalformedTimestampQueryDefaultCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampQueryDefaultCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampQueryDefaultCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampQueryDefaultCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedTimestampQueryEpoch( + + /** + * @see {@link MalformedTimestampQueryEpochCommand} + */ + malformedTimestampQueryEpoch( args: MalformedTimestampQueryEpochCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampQueryEpoch( + malformedTimestampQueryEpoch( args: MalformedTimestampQueryEpochCommandInput, cb: (err: any, data?: MalformedTimestampQueryEpochCommandOutput) => void ): void; - public malformedTimestampQueryEpoch( + malformedTimestampQueryEpoch( args: MalformedTimestampQueryEpochCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampQueryEpochCommandOutput) => void ): void; - public malformedTimestampQueryEpoch( - args: MalformedTimestampQueryEpochCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampQueryEpochCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampQueryEpochCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampQueryEpochCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedTimestampQueryHttpDate( + + /** + * @see {@link MalformedTimestampQueryHttpDateCommand} + */ + malformedTimestampQueryHttpDate( args: MalformedTimestampQueryHttpDateCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedTimestampQueryHttpDate( + malformedTimestampQueryHttpDate( args: MalformedTimestampQueryHttpDateCommandInput, cb: (err: any, data?: MalformedTimestampQueryHttpDateCommandOutput) => void ): void; - public malformedTimestampQueryHttpDate( + malformedTimestampQueryHttpDate( args: MalformedTimestampQueryHttpDateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedTimestampQueryHttpDateCommandOutput) => void ): void; - public malformedTimestampQueryHttpDate( - args: MalformedTimestampQueryHttpDateCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedTimestampQueryHttpDateCommandOutput) => void), - cb?: (err: any, data?: MalformedTimestampQueryHttpDateCommandOutput) => void - ): Promise | void { - const command = new MalformedTimestampQueryHttpDateCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public malformedUnion( + + /** + * @see {@link MalformedUnionCommand} + */ + malformedUnion( args: MalformedUnionCommandInput, options?: __HttpHandlerOptions ): Promise; - public malformedUnion( - args: MalformedUnionCommandInput, - cb: (err: any, data?: MalformedUnionCommandOutput) => void - ): void; - public malformedUnion( + malformedUnion(args: MalformedUnionCommandInput, cb: (err: any, data?: MalformedUnionCommandOutput) => void): void; + malformedUnion( args: MalformedUnionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MalformedUnionCommandOutput) => void ): void; - public malformedUnion( - args: MalformedUnionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MalformedUnionCommandOutput) => void), - cb?: (err: any, data?: MalformedUnionCommandOutput) => void - ): Promise | void { - const command = new MalformedUnionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This example ensures that mediaType strings are base64 encoded in headers. - */ - public mediaTypeHeader( + + /** + * @see {@link MediaTypeHeaderCommand} + */ + mediaTypeHeader( args: MediaTypeHeaderCommandInput, options?: __HttpHandlerOptions ): Promise; - public mediaTypeHeader( - args: MediaTypeHeaderCommandInput, - cb: (err: any, data?: MediaTypeHeaderCommandOutput) => void - ): void; - public mediaTypeHeader( + mediaTypeHeader(args: MediaTypeHeaderCommandInput, cb: (err: any, data?: MediaTypeHeaderCommandOutput) => void): void; + mediaTypeHeader( args: MediaTypeHeaderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MediaTypeHeaderCommandOutput) => void ): void; - public mediaTypeHeader( - args: MediaTypeHeaderCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MediaTypeHeaderCommandOutput) => void), - cb?: (err: any, data?: MediaTypeHeaderCommandOutput) => void - ): Promise | void { - const command = new MediaTypeHeaderCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response payload because the operation has no input or output. - * While this should be rare, code generators must support this. - */ - public noInputAndNoOutput( + + /** + * @see {@link NoInputAndNoOutputCommand} + */ + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public noInputAndNoOutput( + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, cb: (err: any, data?: NoInputAndNoOutputCommandOutput) => void ): void; - public noInputAndNoOutput( + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NoInputAndNoOutputCommandOutput) => void ): void; - public noInputAndNoOutput( - args: NoInputAndNoOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NoInputAndNoOutputCommandOutput) => void), - cb?: (err: any, data?: NoInputAndNoOutputCommandOutput) => void - ): Promise | void { - const command = new NoInputAndNoOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response payload because the operation has no input and the - * output is empty. While this should be rare, code generators must support - * this. - */ - public noInputAndOutput( + + /** + * @see {@link NoInputAndOutputCommand} + */ + noInputAndOutput( args: NoInputAndOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, cb: (err: any, data?: NoInputAndOutputCommandOutput) => void ): void; - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NoInputAndOutputCommandOutput) => void ): void; - public noInputAndOutput( - args: NoInputAndOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NoInputAndOutputCommandOutput) => void), - cb?: (err: any, data?: NoInputAndOutputCommandOutput) => void - ): Promise | void { - const command = new NoInputAndOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Null and empty headers are not sent over the wire. - */ - public nullAndEmptyHeadersClient( + + /** + * @see {@link NullAndEmptyHeadersClientCommand} + */ + nullAndEmptyHeadersClient( args: NullAndEmptyHeadersClientCommandInput, options?: __HttpHandlerOptions ): Promise; - public nullAndEmptyHeadersClient( + nullAndEmptyHeadersClient( args: NullAndEmptyHeadersClientCommandInput, cb: (err: any, data?: NullAndEmptyHeadersClientCommandOutput) => void ): void; - public nullAndEmptyHeadersClient( + nullAndEmptyHeadersClient( args: NullAndEmptyHeadersClientCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NullAndEmptyHeadersClientCommandOutput) => void ): void; - public nullAndEmptyHeadersClient( - args: NullAndEmptyHeadersClientCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NullAndEmptyHeadersClientCommandOutput) => void), - cb?: (err: any, data?: NullAndEmptyHeadersClientCommandOutput) => void - ): Promise | void { - const command = new NullAndEmptyHeadersClientCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Null and empty headers are not sent over the wire. - */ - public nullAndEmptyHeadersServer( + + /** + * @see {@link NullAndEmptyHeadersServerCommand} + */ + nullAndEmptyHeadersServer( args: NullAndEmptyHeadersServerCommandInput, options?: __HttpHandlerOptions ): Promise; - public nullAndEmptyHeadersServer( + nullAndEmptyHeadersServer( args: NullAndEmptyHeadersServerCommandInput, cb: (err: any, data?: NullAndEmptyHeadersServerCommandOutput) => void ): void; - public nullAndEmptyHeadersServer( + nullAndEmptyHeadersServer( args: NullAndEmptyHeadersServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NullAndEmptyHeadersServerCommandOutput) => void ): void; - public nullAndEmptyHeadersServer( - args: NullAndEmptyHeadersServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NullAndEmptyHeadersServerCommandOutput) => void), - cb?: (err: any, data?: NullAndEmptyHeadersServerCommandOutput) => void - ): Promise | void { - const command = new NullAndEmptyHeadersServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Omits null, but serializes empty string value. - */ - public omitsNullSerializesEmptyString( + + /** + * @see {@link OmitsNullSerializesEmptyStringCommand} + */ + omitsNullSerializesEmptyString( args: OmitsNullSerializesEmptyStringCommandInput, options?: __HttpHandlerOptions ): Promise; - public omitsNullSerializesEmptyString( + omitsNullSerializesEmptyString( args: OmitsNullSerializesEmptyStringCommandInput, cb: (err: any, data?: OmitsNullSerializesEmptyStringCommandOutput) => void ): void; - public omitsNullSerializesEmptyString( + omitsNullSerializesEmptyString( args: OmitsNullSerializesEmptyStringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: OmitsNullSerializesEmptyStringCommandOutput) => void ): void; - public omitsNullSerializesEmptyString( - args: OmitsNullSerializesEmptyStringCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: OmitsNullSerializesEmptyStringCommandOutput) => void), - cb?: (err: any, data?: OmitsNullSerializesEmptyStringCommandOutput) => void - ): Promise | void { - const command = new OmitsNullSerializesEmptyStringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Omits serializing empty lists. Because empty strings are serilized as - * `Foo=`, empty lists cannot also be serialized as `Foo=` and instead - * must be omitted. - */ - public omitsSerializingEmptyLists( + + /** + * @see {@link OmitsSerializingEmptyListsCommand} + */ + omitsSerializingEmptyLists( args: OmitsSerializingEmptyListsCommandInput, options?: __HttpHandlerOptions ): Promise; - public omitsSerializingEmptyLists( + omitsSerializingEmptyLists( args: OmitsSerializingEmptyListsCommandInput, cb: (err: any, data?: OmitsSerializingEmptyListsCommandOutput) => void ): void; - public omitsSerializingEmptyLists( + omitsSerializingEmptyLists( args: OmitsSerializingEmptyListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: OmitsSerializingEmptyListsCommandOutput) => void ): void; - public omitsSerializingEmptyLists( - args: OmitsSerializingEmptyListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: OmitsSerializingEmptyListsCommandOutput) => void), - cb?: (err: any, data?: OmitsSerializingEmptyListsCommandOutput) => void - ): Promise | void { - const command = new OmitsSerializingEmptyListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This operation defines a union with a Unit member. - */ - public postPlayerAction( + + /** + * @see {@link PostPlayerActionCommand} + */ + postPlayerAction( args: PostPlayerActionCommandInput, options?: __HttpHandlerOptions ): Promise; - public postPlayerAction( + postPlayerAction( args: PostPlayerActionCommandInput, cb: (err: any, data?: PostPlayerActionCommandOutput) => void ): void; - public postPlayerAction( + postPlayerAction( args: PostPlayerActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PostPlayerActionCommandOutput) => void ): void; - public postPlayerAction( - args: PostPlayerActionCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PostPlayerActionCommandOutput) => void), - cb?: (err: any, data?: PostPlayerActionCommandOutput) => void - ): Promise | void { - const command = new PostPlayerActionCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This operation defines a union that uses jsonName on some members. - */ - public postUnionWithJsonName( + + /** + * @see {@link PostUnionWithJsonNameCommand} + */ + postUnionWithJsonName( args: PostUnionWithJsonNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public postUnionWithJsonName( + postUnionWithJsonName( args: PostUnionWithJsonNameCommandInput, cb: (err: any, data?: PostUnionWithJsonNameCommandOutput) => void ): void; - public postUnionWithJsonName( + postUnionWithJsonName( args: PostUnionWithJsonNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PostUnionWithJsonNameCommandOutput) => void ): void; - public postUnionWithJsonName( - args: PostUnionWithJsonNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PostUnionWithJsonNameCommandOutput) => void), - cb?: (err: any, data?: PostUnionWithJsonNameCommandOutput) => void - ): Promise | void { - const command = new PostUnionWithJsonNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Automatically adds idempotency tokens. - */ - public queryIdempotencyTokenAutoFill( + + /** + * @see {@link QueryIdempotencyTokenAutoFillCommand} + */ + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, options?: __HttpHandlerOptions ): Promise; - public queryIdempotencyTokenAutoFill( + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, cb: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void ): void; - public queryIdempotencyTokenAutoFill( + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void ): void; - public queryIdempotencyTokenAutoFill( - args: QueryIdempotencyTokenAutoFillCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void), - cb?: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void - ): Promise | void { - const command = new QueryIdempotencyTokenAutoFillCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public queryParamsAsStringListMap( + + /** + * @see {@link QueryParamsAsStringListMapCommand} + */ + queryParamsAsStringListMap( args: QueryParamsAsStringListMapCommandInput, options?: __HttpHandlerOptions ): Promise; - public queryParamsAsStringListMap( + queryParamsAsStringListMap( args: QueryParamsAsStringListMapCommandInput, cb: (err: any, data?: QueryParamsAsStringListMapCommandOutput) => void ): void; - public queryParamsAsStringListMap( + queryParamsAsStringListMap( args: QueryParamsAsStringListMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryParamsAsStringListMapCommandOutput) => void ): void; - public queryParamsAsStringListMap( - args: QueryParamsAsStringListMapCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryParamsAsStringListMapCommandOutput) => void), - cb?: (err: any, data?: QueryParamsAsStringListMapCommandOutput) => void - ): Promise | void { - const command = new QueryParamsAsStringListMapCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public queryPrecedence( + + /** + * @see {@link QueryPrecedenceCommand} + */ + queryPrecedence( args: QueryPrecedenceCommandInput, options?: __HttpHandlerOptions ): Promise; - public queryPrecedence( - args: QueryPrecedenceCommandInput, - cb: (err: any, data?: QueryPrecedenceCommandOutput) => void - ): void; - public queryPrecedence( + queryPrecedence(args: QueryPrecedenceCommandInput, cb: (err: any, data?: QueryPrecedenceCommandOutput) => void): void; + queryPrecedence( args: QueryPrecedenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryPrecedenceCommandOutput) => void ): void; - public queryPrecedence( - args: QueryPrecedenceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryPrecedenceCommandOutput) => void), - cb?: (err: any, data?: QueryPrecedenceCommandOutput) => void - ): Promise | void { - const command = new QueryPrecedenceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * Recursive shapes - */ - public recursiveShapes( + + /** + * @see {@link RecursiveShapesCommand} + */ + recursiveShapes( args: RecursiveShapesCommandInput, options?: __HttpHandlerOptions ): Promise; - public recursiveShapes( - args: RecursiveShapesCommandInput, - cb: (err: any, data?: RecursiveShapesCommandOutput) => void - ): void; - public recursiveShapes( + recursiveShapes(args: RecursiveShapesCommandInput, cb: (err: any, data?: RecursiveShapesCommandOutput) => void): void; + recursiveShapes( args: RecursiveShapesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RecursiveShapesCommandOutput) => void ): void; - public recursiveShapes( - args: RecursiveShapesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RecursiveShapesCommandOutput) => void), - cb?: (err: any, data?: RecursiveShapesCommandOutput) => void - ): Promise | void { - const command = new RecursiveShapesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - */ - public simpleScalarProperties( + + /** + * @see {@link SimpleScalarPropertiesCommand} + */ + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public simpleScalarProperties( + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, cb: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void ): void; - public simpleScalarProperties( + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void ): void; - public simpleScalarProperties( - args: SimpleScalarPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SimpleScalarPropertiesCommandOutput) => void), - cb?: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void - ): Promise | void { - const command = new SimpleScalarPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This examples serializes a streaming blob shape in the request body. - * - * In this example, no JSON document is synthesized because the payload is - * not a structure or a union type. - */ - public streamingTraits( + + /** + * @see {@link StreamingTraitsCommand} + */ + streamingTraits( args: StreamingTraitsCommandInput, options?: __HttpHandlerOptions ): Promise; - public streamingTraits( - args: StreamingTraitsCommandInput, - cb: (err: any, data?: StreamingTraitsCommandOutput) => void - ): void; - public streamingTraits( + streamingTraits(args: StreamingTraitsCommandInput, cb: (err: any, data?: StreamingTraitsCommandOutput) => void): void; + streamingTraits( args: StreamingTraitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StreamingTraitsCommandOutput) => void ): void; - public streamingTraits( - args: StreamingTraitsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StreamingTraitsCommandOutput) => void), - cb?: (err: any, data?: StreamingTraitsCommandOutput) => void - ): Promise | void { - const command = new StreamingTraitsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This examples serializes a streaming blob shape with a required content - * length in the request body. - * - * In this example, no JSON document is synthesized because the payload is - * not a structure or a union type. - */ - public streamingTraitsRequireLength( + + /** + * @see {@link StreamingTraitsRequireLengthCommand} + */ + streamingTraitsRequireLength( args: StreamingTraitsRequireLengthCommandInput, options?: __HttpHandlerOptions ): Promise; - public streamingTraitsRequireLength( + streamingTraitsRequireLength( args: StreamingTraitsRequireLengthCommandInput, cb: (err: any, data?: StreamingTraitsRequireLengthCommandOutput) => void ): void; - public streamingTraitsRequireLength( + streamingTraitsRequireLength( args: StreamingTraitsRequireLengthCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StreamingTraitsRequireLengthCommandOutput) => void ): void; - public streamingTraitsRequireLength( - args: StreamingTraitsRequireLengthCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StreamingTraitsRequireLengthCommandOutput) => void), - cb?: (err: any, data?: StreamingTraitsRequireLengthCommandOutput) => void - ): Promise | void { - const command = new StreamingTraitsRequireLengthCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This examples serializes a streaming media-typed blob shape in the request body. - * - * This examples uses a `@mediaType` trait on the payload to force a custom - * content-type to be serialized. - */ - public streamingTraitsWithMediaType( + + /** + * @see {@link StreamingTraitsWithMediaTypeCommand} + */ + streamingTraitsWithMediaType( args: StreamingTraitsWithMediaTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public streamingTraitsWithMediaType( + streamingTraitsWithMediaType( args: StreamingTraitsWithMediaTypeCommandInput, cb: (err: any, data?: StreamingTraitsWithMediaTypeCommandOutput) => void ): void; - public streamingTraitsWithMediaType( + streamingTraitsWithMediaType( args: StreamingTraitsWithMediaTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StreamingTraitsWithMediaTypeCommandOutput) => void ): void; - public streamingTraitsWithMediaType( - args: StreamingTraitsWithMediaTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StreamingTraitsWithMediaTypeCommandOutput) => void), - cb?: (err: any, data?: StreamingTraitsWithMediaTypeCommandOutput) => void - ): Promise | void { - const command = new StreamingTraitsWithMediaTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This example operation serializes a structure in the HTTP body. - * - * It should ensure Content-Type: application/json is - * used in all requests and that an "empty" body is - * an empty JSON document (\{\}). - * - */ - public testBodyStructure( + + /** + * @see {@link TestBodyStructureCommand} + */ + testBodyStructure( args: TestBodyStructureCommandInput, options?: __HttpHandlerOptions ): Promise; - public testBodyStructure( + testBodyStructure( args: TestBodyStructureCommandInput, cb: (err: any, data?: TestBodyStructureCommandOutput) => void ): void; - public testBodyStructure( + testBodyStructure( args: TestBodyStructureCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestBodyStructureCommandOutput) => void ): void; - public testBodyStructure( - args: TestBodyStructureCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestBodyStructureCommandOutput) => void), - cb?: (err: any, data?: TestBodyStructureCommandOutput) => void - ): Promise | void { - const command = new TestBodyStructureCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This example operation serializes a request without an HTTP body. - * - * These tests are to ensure we do not attach a body or related headers - * (Content-Length, Content-Type) to operations that semantically - * cannot produce an HTTP body. - * - */ - public testNoPayload( - args: TestNoPayloadCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public testNoPayload( - args: TestNoPayloadCommandInput, - cb: (err: any, data?: TestNoPayloadCommandOutput) => void - ): void; - public testNoPayload( + + /** + * @see {@link TestNoPayloadCommand} + */ + testNoPayload(args: TestNoPayloadCommandInput, options?: __HttpHandlerOptions): Promise; + testNoPayload(args: TestNoPayloadCommandInput, cb: (err: any, data?: TestNoPayloadCommandOutput) => void): void; + testNoPayload( args: TestNoPayloadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestNoPayloadCommandOutput) => void ): void; - public testNoPayload( - args: TestNoPayloadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestNoPayloadCommandOutput) => void), - cb?: (err: any, data?: TestNoPayloadCommandOutput) => void - ): Promise | void { - const command = new TestNoPayloadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This example operation serializes a payload targeting a blob. - * - * The Blob shape is not structured content and we cannot - * make assumptions about what data will be sent. This test ensures - * only a generic "Content-Type: application/octet-stream" header - * is used, and that we are not treating an empty body as an - * empty JSON document. - * - */ - public testPayloadBlob( + + /** + * @see {@link TestPayloadBlobCommand} + */ + testPayloadBlob( args: TestPayloadBlobCommandInput, options?: __HttpHandlerOptions ): Promise; - public testPayloadBlob( - args: TestPayloadBlobCommandInput, - cb: (err: any, data?: TestPayloadBlobCommandOutput) => void - ): void; - public testPayloadBlob( + testPayloadBlob(args: TestPayloadBlobCommandInput, cb: (err: any, data?: TestPayloadBlobCommandOutput) => void): void; + testPayloadBlob( args: TestPayloadBlobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestPayloadBlobCommandOutput) => void ): void; - public testPayloadBlob( - args: TestPayloadBlobCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestPayloadBlobCommandOutput) => void), - cb?: (err: any, data?: TestPayloadBlobCommandOutput) => void - ): Promise | void { - const command = new TestPayloadBlobCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This example operation serializes a payload targeting a structure. - * - * This enforces the same requirements as TestBodyStructure - * but with the body specified by the @httpPayload trait. - * - */ - public testPayloadStructure( + + /** + * @see {@link TestPayloadStructureCommand} + */ + testPayloadStructure( args: TestPayloadStructureCommandInput, options?: __HttpHandlerOptions ): Promise; - public testPayloadStructure( + testPayloadStructure( args: TestPayloadStructureCommandInput, cb: (err: any, data?: TestPayloadStructureCommandOutput) => void ): void; - public testPayloadStructure( + testPayloadStructure( args: TestPayloadStructureCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestPayloadStructureCommandOutput) => void ): void; - public testPayloadStructure( - args: TestPayloadStructureCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TestPayloadStructureCommandOutput) => void), - cb?: (err: any, data?: TestPayloadStructureCommandOutput) => void - ): Promise | void { - const command = new TestPayloadStructureCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This example tests how timestamp request and response headers are serialized. - */ - public timestampFormatHeaders( + + /** + * @see {@link TimestampFormatHeadersCommand} + */ + timestampFormatHeaders( args: TimestampFormatHeadersCommandInput, options?: __HttpHandlerOptions ): Promise; - public timestampFormatHeaders( + timestampFormatHeaders( args: TimestampFormatHeadersCommandInput, cb: (err: any, data?: TimestampFormatHeadersCommandOutput) => void ): void; - public timestampFormatHeaders( + timestampFormatHeaders( args: TimestampFormatHeadersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TimestampFormatHeadersCommandOutput) => void ): void; - public timestampFormatHeaders( - args: TimestampFormatHeadersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TimestampFormatHeadersCommandOutput) => void), - cb?: (err: any, data?: TimestampFormatHeadersCommandOutput) => void - ): Promise | void { - const command = new TimestampFormatHeadersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } - - /** - * @public - * This test is similar to NoInputAndNoOutput, but uses explicit Unit types. - */ - public unitInputAndOutput( + + /** + * @see {@link UnitInputAndOutputCommand} + */ + unitInputAndOutput( args: UnitInputAndOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public unitInputAndOutput( + unitInputAndOutput( args: UnitInputAndOutputCommandInput, cb: (err: any, data?: UnitInputAndOutputCommandOutput) => void ): void; - public unitInputAndOutput( + unitInputAndOutput( args: UnitInputAndOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnitInputAndOutputCommandOutput) => void ): void; - public unitInputAndOutput( - args: UnitInputAndOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnitInputAndOutputCommandOutput) => void), - cb?: (err: any, data?: UnitInputAndOutputCommandOutput) => void - ): Promise | void { - const command = new UnitInputAndOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * A REST JSON service that sends JSON requests and responses. + */ +export class RestJsonProtocol extends RestJsonProtocolClient implements RestJsonProtocol {} +createAggregatedClient(commands, RestJsonProtocol); diff --git a/private/aws-protocoltests-restxml/src/RestXmlProtocol.ts b/private/aws-protocoltests-restxml/src/RestXmlProtocol.ts index 28a4c46cb64a..bb35919e1a8c 100644 --- a/private/aws-protocoltests-restxml/src/RestXmlProtocol.ts +++ b/private/aws-protocoltests-restxml/src/RestXmlProtocol.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { createAggregatedClient } from "@aws-sdk/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; import { @@ -257,1852 +258,925 @@ import { XmlTimestampsCommandOutput, } from "./commands/XmlTimestampsCommand"; import { XmlUnionsCommand, XmlUnionsCommandInput, XmlUnionsCommandOutput } from "./commands/XmlUnionsCommand"; -import { RestXmlProtocolClient } from "./RestXmlProtocolClient"; +import { RestXmlProtocolClient, RestXmlProtocolClientConfig } from "./RestXmlProtocolClient"; -/** - * @public - * A REST XML service that sends XML requests and responses. - */ -export class RestXmlProtocol extends RestXmlProtocolClient { +const commands = { + AllQueryStringTypesCommand, + BodyWithXmlNameCommand, + ConstantAndVariableQueryStringCommand, + ConstantQueryStringCommand, + DatetimeOffsetsCommand, + EmptyInputAndEmptyOutputCommand, + EndpointOperationCommand, + EndpointWithHostLabelHeaderOperationCommand, + EndpointWithHostLabelOperationCommand, + FlattenedXmlMapCommand, + FlattenedXmlMapWithXmlNameCommand, + FlattenedXmlMapWithXmlNamespaceCommand, + FractionalSecondsCommand, + GreetingWithErrorsCommand, + HttpPayloadTraitsCommand, + HttpPayloadTraitsWithMediaTypeCommand, + HttpPayloadWithMemberXmlNameCommand, + HttpPayloadWithStructureCommand, + HttpPayloadWithXmlNameCommand, + HttpPayloadWithXmlNamespaceCommand, + HttpPayloadWithXmlNamespaceAndPrefixCommand, + HttpPrefixHeadersCommand, + HttpRequestWithFloatLabelsCommand, + HttpRequestWithGreedyLabelInPathCommand, + HttpRequestWithLabelsCommand, + HttpRequestWithLabelsAndTimestampFormatCommand, + HttpResponseCodeCommand, + IgnoreQueryParamsInResponseCommand, + InputAndOutputWithHeadersCommand, + NestedXmlMapsCommand, + NoInputAndNoOutputCommand, + NoInputAndOutputCommand, + NullAndEmptyHeadersClientCommand, + NullAndEmptyHeadersServerCommand, + OmitsNullSerializesEmptyStringCommand, + QueryIdempotencyTokenAutoFillCommand, + QueryParamsAsStringListMapCommand, + QueryPrecedenceCommand, + RecursiveShapesCommand, + SimpleScalarPropertiesCommand, + TimestampFormatHeadersCommand, + XmlAttributesCommand, + XmlAttributesOnPayloadCommand, + XmlBlobsCommand, + XmlEmptyBlobsCommand, + XmlEmptyListsCommand, + XmlEmptyMapsCommand, + XmlEmptyStringsCommand, + XmlEnumsCommand, + XmlIntEnumsCommand, + XmlListsCommand, + XmlMapsCommand, + XmlMapsXmlNameCommand, + XmlNamespacesCommand, + XmlTimestampsCommand, + XmlUnionsCommand, +}; + +export interface RestXmlProtocol { /** - * @public - * This example uses all query string types. + * @see {@link AllQueryStringTypesCommand} */ - public allQueryStringTypes( + allQueryStringTypes( args: AllQueryStringTypesCommandInput, options?: __HttpHandlerOptions ): Promise; - public allQueryStringTypes( + allQueryStringTypes( args: AllQueryStringTypesCommandInput, cb: (err: any, data?: AllQueryStringTypesCommandOutput) => void ): void; - public allQueryStringTypes( + allQueryStringTypes( args: AllQueryStringTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AllQueryStringTypesCommandOutput) => void ): void; - public allQueryStringTypes( - args: AllQueryStringTypesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AllQueryStringTypesCommandOutput) => void), - cb?: (err: any, data?: AllQueryStringTypesCommandOutput) => void - ): Promise | void { - const command = new AllQueryStringTypesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The following example serializes a body that uses an XML name, - * changing the wrapper name. + * @see {@link BodyWithXmlNameCommand} */ - public bodyWithXmlName( + bodyWithXmlName( args: BodyWithXmlNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public bodyWithXmlName( - args: BodyWithXmlNameCommandInput, - cb: (err: any, data?: BodyWithXmlNameCommandOutput) => void - ): void; - public bodyWithXmlName( + bodyWithXmlName(args: BodyWithXmlNameCommandInput, cb: (err: any, data?: BodyWithXmlNameCommandOutput) => void): void; + bodyWithXmlName( args: BodyWithXmlNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BodyWithXmlNameCommandOutput) => void ): void; - public bodyWithXmlName( - args: BodyWithXmlNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: BodyWithXmlNameCommandOutput) => void), - cb?: (err: any, data?: BodyWithXmlNameCommandOutput) => void - ): Promise | void { - const command = new BodyWithXmlNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example uses fixed query string params and variable query string params. - * The fixed query string parameters and variable parameters must both be - * serialized (implementations may need to merge them together). + * @see {@link ConstantAndVariableQueryStringCommand} */ - public constantAndVariableQueryString( + constantAndVariableQueryString( args: ConstantAndVariableQueryStringCommandInput, options?: __HttpHandlerOptions ): Promise; - public constantAndVariableQueryString( + constantAndVariableQueryString( args: ConstantAndVariableQueryStringCommandInput, cb: (err: any, data?: ConstantAndVariableQueryStringCommandOutput) => void ): void; - public constantAndVariableQueryString( + constantAndVariableQueryString( args: ConstantAndVariableQueryStringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConstantAndVariableQueryStringCommandOutput) => void ): void; - public constantAndVariableQueryString( - args: ConstantAndVariableQueryStringCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConstantAndVariableQueryStringCommandOutput) => void), - cb?: (err: any, data?: ConstantAndVariableQueryStringCommandOutput) => void - ): Promise | void { - const command = new ConstantAndVariableQueryStringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example uses a constant query string parameters and a label. - * This simply tests that labels and query string parameters are - * compatible. The fixed query string parameter named "hello" should - * in no way conflict with the label, `\{hello\}`. + * @see {@link ConstantQueryStringCommand} */ - public constantQueryString( + constantQueryString( args: ConstantQueryStringCommandInput, options?: __HttpHandlerOptions ): Promise; - public constantQueryString( + constantQueryString( args: ConstantQueryStringCommandInput, cb: (err: any, data?: ConstantQueryStringCommandOutput) => void ): void; - public constantQueryString( + constantQueryString( args: ConstantQueryStringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConstantQueryStringCommandOutput) => void ): void; - public constantQueryString( - args: ConstantQueryStringCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ConstantQueryStringCommandOutput) => void), - cb?: (err: any, data?: ConstantQueryStringCommandOutput) => void - ): Promise | void { - const command = new ConstantQueryStringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link DatetimeOffsetsCommand} */ - public datetimeOffsets( + datetimeOffsets( args: DatetimeOffsetsCommandInput, options?: __HttpHandlerOptions ): Promise; - public datetimeOffsets( - args: DatetimeOffsetsCommandInput, - cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void - ): void; - public datetimeOffsets( + datetimeOffsets(args: DatetimeOffsetsCommandInput, cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void): void; + datetimeOffsets( args: DatetimeOffsetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DatetimeOffsetsCommandOutput) => void ): void; - public datetimeOffsets( - args: DatetimeOffsetsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DatetimeOffsetsCommandOutput) => void), - cb?: (err: any, data?: DatetimeOffsetsCommandOutput) => void - ): Promise | void { - const command = new DatetimeOffsetsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response payload because the operation has an empty input - * and empty output structure that reuses the same shape. While this should - * be rare, code generators must support this. + * @see {@link EmptyInputAndEmptyOutputCommand} */ - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, cb: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void ): void; - public emptyInputAndEmptyOutput( + emptyInputAndEmptyOutput( args: EmptyInputAndEmptyOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void ): void; - public emptyInputAndEmptyOutput( - args: EmptyInputAndEmptyOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void), - cb?: (err: any, data?: EmptyInputAndEmptyOutputCommandOutput) => void - ): Promise | void { - const command = new EmptyInputAndEmptyOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointOperationCommand} */ - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( + endpointOperation( args: EndpointOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointOperationCommandOutput) => void ): void; - public endpointOperation( - args: EndpointOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointWithHostLabelHeaderOperationCommand} */ - public endpointWithHostLabelHeaderOperation( + endpointWithHostLabelHeaderOperation( args: EndpointWithHostLabelHeaderOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointWithHostLabelHeaderOperation( + endpointWithHostLabelHeaderOperation( args: EndpointWithHostLabelHeaderOperationCommandInput, cb: (err: any, data?: EndpointWithHostLabelHeaderOperationCommandOutput) => void ): void; - public endpointWithHostLabelHeaderOperation( + endpointWithHostLabelHeaderOperation( args: EndpointWithHostLabelHeaderOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointWithHostLabelHeaderOperationCommandOutput) => void ): void; - public endpointWithHostLabelHeaderOperation( - args: EndpointWithHostLabelHeaderOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointWithHostLabelHeaderOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointWithHostLabelHeaderOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointWithHostLabelHeaderOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link EndpointWithHostLabelOperationCommand} */ - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options?: __HttpHandlerOptions ): Promise; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( + endpointWithHostLabelOperation( args: EndpointWithHostLabelOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void ): void; - public endpointWithHostLabelOperation( - args: EndpointWithHostLabelOperationCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void), - cb?: (err: any, data?: EndpointWithHostLabelOperationCommandOutput) => void - ): Promise | void { - const command = new EndpointWithHostLabelOperationCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Flattened maps + * @see {@link FlattenedXmlMapCommand} */ - public flattenedXmlMap( + flattenedXmlMap( args: FlattenedXmlMapCommandInput, options?: __HttpHandlerOptions ): Promise; - public flattenedXmlMap( - args: FlattenedXmlMapCommandInput, - cb: (err: any, data?: FlattenedXmlMapCommandOutput) => void - ): void; - public flattenedXmlMap( + flattenedXmlMap(args: FlattenedXmlMapCommandInput, cb: (err: any, data?: FlattenedXmlMapCommandOutput) => void): void; + flattenedXmlMap( args: FlattenedXmlMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FlattenedXmlMapCommandOutput) => void ): void; - public flattenedXmlMap( - args: FlattenedXmlMapCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FlattenedXmlMapCommandOutput) => void), - cb?: (err: any, data?: FlattenedXmlMapCommandOutput) => void - ): Promise | void { - const command = new FlattenedXmlMapCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Flattened maps with @xmlName + * @see {@link FlattenedXmlMapWithXmlNameCommand} */ - public flattenedXmlMapWithXmlName( + flattenedXmlMapWithXmlName( args: FlattenedXmlMapWithXmlNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public flattenedXmlMapWithXmlName( + flattenedXmlMapWithXmlName( args: FlattenedXmlMapWithXmlNameCommandInput, cb: (err: any, data?: FlattenedXmlMapWithXmlNameCommandOutput) => void ): void; - public flattenedXmlMapWithXmlName( + flattenedXmlMapWithXmlName( args: FlattenedXmlMapWithXmlNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FlattenedXmlMapWithXmlNameCommandOutput) => void ): void; - public flattenedXmlMapWithXmlName( - args: FlattenedXmlMapWithXmlNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FlattenedXmlMapWithXmlNameCommandOutput) => void), - cb?: (err: any, data?: FlattenedXmlMapWithXmlNameCommandOutput) => void - ): Promise | void { - const command = new FlattenedXmlMapWithXmlNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Flattened maps with @xmlNamespace and @xmlName + * @see {@link FlattenedXmlMapWithXmlNamespaceCommand} */ - public flattenedXmlMapWithXmlNamespace( + flattenedXmlMapWithXmlNamespace( args: FlattenedXmlMapWithXmlNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public flattenedXmlMapWithXmlNamespace( + flattenedXmlMapWithXmlNamespace( args: FlattenedXmlMapWithXmlNamespaceCommandInput, cb: (err: any, data?: FlattenedXmlMapWithXmlNamespaceCommandOutput) => void ): void; - public flattenedXmlMapWithXmlNamespace( + flattenedXmlMapWithXmlNamespace( args: FlattenedXmlMapWithXmlNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FlattenedXmlMapWithXmlNamespaceCommandOutput) => void ): void; - public flattenedXmlMapWithXmlNamespace( - args: FlattenedXmlMapWithXmlNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FlattenedXmlMapWithXmlNamespaceCommandOutput) => void), - cb?: (err: any, data?: FlattenedXmlMapWithXmlNamespaceCommandOutput) => void - ): Promise | void { - const command = new FlattenedXmlMapWithXmlNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link FractionalSecondsCommand} */ - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, options?: __HttpHandlerOptions ): Promise; - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, cb: (err: any, data?: FractionalSecondsCommandOutput) => void ): void; - public fractionalSeconds( + fractionalSeconds( args: FractionalSecondsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FractionalSecondsCommandOutput) => void ): void; - public fractionalSeconds( - args: FractionalSecondsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: FractionalSecondsCommandOutput) => void), - cb?: (err: any, data?: FractionalSecondsCommandOutput) => void - ): Promise | void { - const command = new FractionalSecondsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This operation has three possible return values: - * - * 1. A successful response in the form of GreetingWithErrorsOutput - * 2. An InvalidGreeting error. - * 3. A BadRequest error. - * - * Implementations must be able to successfully take a response and - * properly (de)serialize successful and error responses based on the - * the presence of the + * @see {@link GreetingWithErrorsCommand} */ - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, options?: __HttpHandlerOptions ): Promise; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( + greetingWithErrors( args: GreetingWithErrorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GreetingWithErrorsCommandOutput) => void ): void; - public greetingWithErrors( - args: GreetingWithErrorsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GreetingWithErrorsCommandOutput) => void), - cb?: (err: any, data?: GreetingWithErrorsCommandOutput) => void - ): Promise | void { - const command = new GreetingWithErrorsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This examples serializes a blob shape in the payload. - * - * In this example, no XML document is synthesized because the payload is - * not a structure or a union type. + * @see {@link HttpPayloadTraitsCommand} */ - public httpPayloadTraits( + httpPayloadTraits( args: HttpPayloadTraitsCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPayloadTraits( + httpPayloadTraits( args: HttpPayloadTraitsCommandInput, cb: (err: any, data?: HttpPayloadTraitsCommandOutput) => void ): void; - public httpPayloadTraits( + httpPayloadTraits( args: HttpPayloadTraitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPayloadTraitsCommandOutput) => void ): void; - public httpPayloadTraits( - args: HttpPayloadTraitsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPayloadTraitsCommandOutput) => void), - cb?: (err: any, data?: HttpPayloadTraitsCommandOutput) => void - ): Promise | void { - const command = new HttpPayloadTraitsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This examples uses a `@mediaType` trait on the payload to force a custom - * content-type to be serialized. + * @see {@link HttpPayloadTraitsWithMediaTypeCommand} */ - public httpPayloadTraitsWithMediaType( + httpPayloadTraitsWithMediaType( args: HttpPayloadTraitsWithMediaTypeCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPayloadTraitsWithMediaType( + httpPayloadTraitsWithMediaType( args: HttpPayloadTraitsWithMediaTypeCommandInput, cb: (err: any, data?: HttpPayloadTraitsWithMediaTypeCommandOutput) => void ): void; - public httpPayloadTraitsWithMediaType( + httpPayloadTraitsWithMediaType( args: HttpPayloadTraitsWithMediaTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPayloadTraitsWithMediaTypeCommandOutput) => void ): void; - public httpPayloadTraitsWithMediaType( - args: HttpPayloadTraitsWithMediaTypeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPayloadTraitsWithMediaTypeCommandOutput) => void), - cb?: (err: any, data?: HttpPayloadTraitsWithMediaTypeCommandOutput) => void - ): Promise | void { - const command = new HttpPayloadTraitsWithMediaTypeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The following example serializes a payload that uses an XML name - * on the member, changing the wrapper name. + * @see {@link HttpPayloadWithMemberXmlNameCommand} */ - public httpPayloadWithMemberXmlName( + httpPayloadWithMemberXmlName( args: HttpPayloadWithMemberXmlNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPayloadWithMemberXmlName( + httpPayloadWithMemberXmlName( args: HttpPayloadWithMemberXmlNameCommandInput, cb: (err: any, data?: HttpPayloadWithMemberXmlNameCommandOutput) => void ): void; - public httpPayloadWithMemberXmlName( + httpPayloadWithMemberXmlName( args: HttpPayloadWithMemberXmlNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPayloadWithMemberXmlNameCommandOutput) => void ): void; - public httpPayloadWithMemberXmlName( - args: HttpPayloadWithMemberXmlNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPayloadWithMemberXmlNameCommandOutput) => void), - cb?: (err: any, data?: HttpPayloadWithMemberXmlNameCommandOutput) => void - ): Promise | void { - const command = new HttpPayloadWithMemberXmlNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This examples serializes a structure in the payload. - * - * Note that serializing a structure changes the wrapper element name - * to match the targeted structure. + * @see {@link HttpPayloadWithStructureCommand} */ - public httpPayloadWithStructure( + httpPayloadWithStructure( args: HttpPayloadWithStructureCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPayloadWithStructure( + httpPayloadWithStructure( args: HttpPayloadWithStructureCommandInput, cb: (err: any, data?: HttpPayloadWithStructureCommandOutput) => void ): void; - public httpPayloadWithStructure( + httpPayloadWithStructure( args: HttpPayloadWithStructureCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPayloadWithStructureCommandOutput) => void ): void; - public httpPayloadWithStructure( - args: HttpPayloadWithStructureCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPayloadWithStructureCommandOutput) => void), - cb?: (err: any, data?: HttpPayloadWithStructureCommandOutput) => void - ): Promise | void { - const command = new HttpPayloadWithStructureCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The following example serializes a payload that uses an XML name, - * changing the wrapper name. + * @see {@link HttpPayloadWithXmlNameCommand} */ - public httpPayloadWithXmlName( + httpPayloadWithXmlName( args: HttpPayloadWithXmlNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPayloadWithXmlName( + httpPayloadWithXmlName( args: HttpPayloadWithXmlNameCommandInput, cb: (err: any, data?: HttpPayloadWithXmlNameCommandOutput) => void ): void; - public httpPayloadWithXmlName( + httpPayloadWithXmlName( args: HttpPayloadWithXmlNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPayloadWithXmlNameCommandOutput) => void ): void; - public httpPayloadWithXmlName( - args: HttpPayloadWithXmlNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPayloadWithXmlNameCommandOutput) => void), - cb?: (err: any, data?: HttpPayloadWithXmlNameCommandOutput) => void - ): Promise | void { - const command = new HttpPayloadWithXmlNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The following example serializes a payload that uses an XML namespace. + * @see {@link HttpPayloadWithXmlNamespaceCommand} */ - public httpPayloadWithXmlNamespace( + httpPayloadWithXmlNamespace( args: HttpPayloadWithXmlNamespaceCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPayloadWithXmlNamespace( + httpPayloadWithXmlNamespace( args: HttpPayloadWithXmlNamespaceCommandInput, cb: (err: any, data?: HttpPayloadWithXmlNamespaceCommandOutput) => void ): void; - public httpPayloadWithXmlNamespace( + httpPayloadWithXmlNamespace( args: HttpPayloadWithXmlNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPayloadWithXmlNamespaceCommandOutput) => void ): void; - public httpPayloadWithXmlNamespace( - args: HttpPayloadWithXmlNamespaceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPayloadWithXmlNamespaceCommandOutput) => void), - cb?: (err: any, data?: HttpPayloadWithXmlNamespaceCommandOutput) => void - ): Promise | void { - const command = new HttpPayloadWithXmlNamespaceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The following example serializes a payload that uses an XML namespace. + * @see {@link HttpPayloadWithXmlNamespaceAndPrefixCommand} */ - public httpPayloadWithXmlNamespaceAndPrefix( + httpPayloadWithXmlNamespaceAndPrefix( args: HttpPayloadWithXmlNamespaceAndPrefixCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPayloadWithXmlNamespaceAndPrefix( + httpPayloadWithXmlNamespaceAndPrefix( args: HttpPayloadWithXmlNamespaceAndPrefixCommandInput, cb: (err: any, data?: HttpPayloadWithXmlNamespaceAndPrefixCommandOutput) => void ): void; - public httpPayloadWithXmlNamespaceAndPrefix( + httpPayloadWithXmlNamespaceAndPrefix( args: HttpPayloadWithXmlNamespaceAndPrefixCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPayloadWithXmlNamespaceAndPrefixCommandOutput) => void ): void; - public httpPayloadWithXmlNamespaceAndPrefix( - args: HttpPayloadWithXmlNamespaceAndPrefixCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPayloadWithXmlNamespaceAndPrefixCommandOutput) => void), - cb?: (err: any, data?: HttpPayloadWithXmlNamespaceAndPrefixCommandOutput) => void - ): Promise | void { - const command = new HttpPayloadWithXmlNamespaceAndPrefixCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This examples adds headers to the input of a request and response by prefix. + * @see {@link HttpPrefixHeadersCommand} */ - public httpPrefixHeaders( + httpPrefixHeaders( args: HttpPrefixHeadersCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpPrefixHeaders( + httpPrefixHeaders( args: HttpPrefixHeadersCommandInput, cb: (err: any, data?: HttpPrefixHeadersCommandOutput) => void ): void; - public httpPrefixHeaders( + httpPrefixHeaders( args: HttpPrefixHeadersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpPrefixHeadersCommandOutput) => void ): void; - public httpPrefixHeaders( - args: HttpPrefixHeadersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpPrefixHeadersCommandOutput) => void), - cb?: (err: any, data?: HttpPrefixHeadersCommandOutput) => void - ): Promise | void { - const command = new HttpPrefixHeadersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link HttpRequestWithFloatLabelsCommand} */ - public httpRequestWithFloatLabels( + httpRequestWithFloatLabels( args: HttpRequestWithFloatLabelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpRequestWithFloatLabels( + httpRequestWithFloatLabels( args: HttpRequestWithFloatLabelsCommandInput, cb: (err: any, data?: HttpRequestWithFloatLabelsCommandOutput) => void ): void; - public httpRequestWithFloatLabels( + httpRequestWithFloatLabels( args: HttpRequestWithFloatLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpRequestWithFloatLabelsCommandOutput) => void ): void; - public httpRequestWithFloatLabels( - args: HttpRequestWithFloatLabelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpRequestWithFloatLabelsCommandOutput) => void), - cb?: (err: any, data?: HttpRequestWithFloatLabelsCommandOutput) => void - ): Promise | void { - const command = new HttpRequestWithFloatLabelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link HttpRequestWithGreedyLabelInPathCommand} */ - public httpRequestWithGreedyLabelInPath( + httpRequestWithGreedyLabelInPath( args: HttpRequestWithGreedyLabelInPathCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpRequestWithGreedyLabelInPath( + httpRequestWithGreedyLabelInPath( args: HttpRequestWithGreedyLabelInPathCommandInput, cb: (err: any, data?: HttpRequestWithGreedyLabelInPathCommandOutput) => void ): void; - public httpRequestWithGreedyLabelInPath( + httpRequestWithGreedyLabelInPath( args: HttpRequestWithGreedyLabelInPathCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpRequestWithGreedyLabelInPathCommandOutput) => void ): void; - public httpRequestWithGreedyLabelInPath( - args: HttpRequestWithGreedyLabelInPathCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpRequestWithGreedyLabelInPathCommandOutput) => void), - cb?: (err: any, data?: HttpRequestWithGreedyLabelInPathCommandOutput) => void - ): Promise | void { - const command = new HttpRequestWithGreedyLabelInPathCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests are serialized when there's no input - * payload but there are HTTP labels. + * @see {@link HttpRequestWithLabelsCommand} */ - public httpRequestWithLabels( + httpRequestWithLabels( args: HttpRequestWithLabelsCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpRequestWithLabels( + httpRequestWithLabels( args: HttpRequestWithLabelsCommandInput, cb: (err: any, data?: HttpRequestWithLabelsCommandOutput) => void ): void; - public httpRequestWithLabels( + httpRequestWithLabels( args: HttpRequestWithLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpRequestWithLabelsCommandOutput) => void ): void; - public httpRequestWithLabels( - args: HttpRequestWithLabelsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpRequestWithLabelsCommandOutput) => void), - cb?: (err: any, data?: HttpRequestWithLabelsCommandOutput) => void - ): Promise | void { - const command = new HttpRequestWithLabelsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests serialize different timestamp formats in the - * URI path. + * @see {@link HttpRequestWithLabelsAndTimestampFormatCommand} */ - public httpRequestWithLabelsAndTimestampFormat( + httpRequestWithLabelsAndTimestampFormat( args: HttpRequestWithLabelsAndTimestampFormatCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpRequestWithLabelsAndTimestampFormat( + httpRequestWithLabelsAndTimestampFormat( args: HttpRequestWithLabelsAndTimestampFormatCommandInput, cb: (err: any, data?: HttpRequestWithLabelsAndTimestampFormatCommandOutput) => void ): void; - public httpRequestWithLabelsAndTimestampFormat( + httpRequestWithLabelsAndTimestampFormat( args: HttpRequestWithLabelsAndTimestampFormatCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpRequestWithLabelsAndTimestampFormatCommandOutput) => void ): void; - public httpRequestWithLabelsAndTimestampFormat( - args: HttpRequestWithLabelsAndTimestampFormatCommandInput, - optionsOrCb?: - | __HttpHandlerOptions - | ((err: any, data?: HttpRequestWithLabelsAndTimestampFormatCommandOutput) => void), - cb?: (err: any, data?: HttpRequestWithLabelsAndTimestampFormatCommandOutput) => void - ): Promise | void { - const command = new HttpRequestWithLabelsAndTimestampFormatCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link HttpResponseCodeCommand} */ - public httpResponseCode( + httpResponseCode( args: HttpResponseCodeCommandInput, options?: __HttpHandlerOptions ): Promise; - public httpResponseCode( + httpResponseCode( args: HttpResponseCodeCommandInput, cb: (err: any, data?: HttpResponseCodeCommandOutput) => void ): void; - public httpResponseCode( + httpResponseCode( args: HttpResponseCodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HttpResponseCodeCommandOutput) => void ): void; - public httpResponseCode( - args: HttpResponseCodeCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: HttpResponseCodeCommandOutput) => void), - cb?: (err: any, data?: HttpResponseCodeCommandOutput) => void - ): Promise | void { - const command = new HttpResponseCodeCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example ensures that query string bound request parameters are - * serialized in the body of responses if the structure is used in both - * the request and response. + * @see {@link IgnoreQueryParamsInResponseCommand} */ - public ignoreQueryParamsInResponse( + ignoreQueryParamsInResponse( args: IgnoreQueryParamsInResponseCommandInput, options?: __HttpHandlerOptions ): Promise; - public ignoreQueryParamsInResponse( + ignoreQueryParamsInResponse( args: IgnoreQueryParamsInResponseCommandInput, cb: (err: any, data?: IgnoreQueryParamsInResponseCommandOutput) => void ): void; - public ignoreQueryParamsInResponse( + ignoreQueryParamsInResponse( args: IgnoreQueryParamsInResponseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IgnoreQueryParamsInResponseCommandOutput) => void ): void; - public ignoreQueryParamsInResponse( - args: IgnoreQueryParamsInResponseCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: IgnoreQueryParamsInResponseCommandOutput) => void), - cb?: (err: any, data?: IgnoreQueryParamsInResponseCommandOutput) => void - ): Promise | void { - const command = new IgnoreQueryParamsInResponseCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there is - * no input or output payload but there are HTTP header bindings. + * @see {@link InputAndOutputWithHeadersCommand} */ - public inputAndOutputWithHeaders( + inputAndOutputWithHeaders( args: InputAndOutputWithHeadersCommandInput, options?: __HttpHandlerOptions ): Promise; - public inputAndOutputWithHeaders( + inputAndOutputWithHeaders( args: InputAndOutputWithHeadersCommandInput, cb: (err: any, data?: InputAndOutputWithHeadersCommandOutput) => void ): void; - public inputAndOutputWithHeaders( + inputAndOutputWithHeaders( args: InputAndOutputWithHeadersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InputAndOutputWithHeadersCommandOutput) => void ): void; - public inputAndOutputWithHeaders( - args: InputAndOutputWithHeadersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: InputAndOutputWithHeadersCommandOutput) => void), - cb?: (err: any, data?: InputAndOutputWithHeadersCommandOutput) => void - ): Promise | void { - const command = new InputAndOutputWithHeadersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link NestedXmlMapsCommand} */ - public nestedXmlMaps( - args: NestedXmlMapsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public nestedXmlMaps( - args: NestedXmlMapsCommandInput, - cb: (err: any, data?: NestedXmlMapsCommandOutput) => void - ): void; - public nestedXmlMaps( + nestedXmlMaps(args: NestedXmlMapsCommandInput, options?: __HttpHandlerOptions): Promise; + nestedXmlMaps(args: NestedXmlMapsCommandInput, cb: (err: any, data?: NestedXmlMapsCommandOutput) => void): void; + nestedXmlMaps( args: NestedXmlMapsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NestedXmlMapsCommandOutput) => void ): void; - public nestedXmlMaps( - args: NestedXmlMapsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NestedXmlMapsCommandOutput) => void), - cb?: (err: any, data?: NestedXmlMapsCommandOutput) => void - ): Promise | void { - const command = new NestedXmlMapsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response payload because the operation has no input or output. - * While this should be rare, code generators must support this. + * @see {@link NoInputAndNoOutputCommand} */ - public noInputAndNoOutput( + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public noInputAndNoOutput( + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, cb: (err: any, data?: NoInputAndNoOutputCommandOutput) => void ): void; - public noInputAndNoOutput( + noInputAndNoOutput( args: NoInputAndNoOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NoInputAndNoOutputCommandOutput) => void ): void; - public noInputAndNoOutput( - args: NoInputAndNoOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NoInputAndNoOutputCommandOutput) => void), - cb?: (err: any, data?: NoInputAndNoOutputCommandOutput) => void - ): Promise | void { - const command = new NoInputAndNoOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how requests and responses are serialized when there's - * no request or response payload because the operation has no input and the - * output is empty. While this should be rare, code generators must support - * this. + * @see {@link NoInputAndOutputCommand} */ - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, options?: __HttpHandlerOptions ): Promise; - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, cb: (err: any, data?: NoInputAndOutputCommandOutput) => void ): void; - public noInputAndOutput( + noInputAndOutput( args: NoInputAndOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NoInputAndOutputCommandOutput) => void ): void; - public noInputAndOutput( - args: NoInputAndOutputCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NoInputAndOutputCommandOutput) => void), - cb?: (err: any, data?: NoInputAndOutputCommandOutput) => void - ): Promise | void { - const command = new NoInputAndOutputCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Null and empty headers are not sent over the wire. + * @see {@link NullAndEmptyHeadersClientCommand} */ - public nullAndEmptyHeadersClient( + nullAndEmptyHeadersClient( args: NullAndEmptyHeadersClientCommandInput, options?: __HttpHandlerOptions ): Promise; - public nullAndEmptyHeadersClient( + nullAndEmptyHeadersClient( args: NullAndEmptyHeadersClientCommandInput, cb: (err: any, data?: NullAndEmptyHeadersClientCommandOutput) => void ): void; - public nullAndEmptyHeadersClient( + nullAndEmptyHeadersClient( args: NullAndEmptyHeadersClientCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NullAndEmptyHeadersClientCommandOutput) => void ): void; - public nullAndEmptyHeadersClient( - args: NullAndEmptyHeadersClientCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NullAndEmptyHeadersClientCommandOutput) => void), - cb?: (err: any, data?: NullAndEmptyHeadersClientCommandOutput) => void - ): Promise | void { - const command = new NullAndEmptyHeadersClientCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Null and empty headers are not sent over the wire. + * @see {@link NullAndEmptyHeadersServerCommand} */ - public nullAndEmptyHeadersServer( + nullAndEmptyHeadersServer( args: NullAndEmptyHeadersServerCommandInput, options?: __HttpHandlerOptions ): Promise; - public nullAndEmptyHeadersServer( + nullAndEmptyHeadersServer( args: NullAndEmptyHeadersServerCommandInput, cb: (err: any, data?: NullAndEmptyHeadersServerCommandOutput) => void ): void; - public nullAndEmptyHeadersServer( + nullAndEmptyHeadersServer( args: NullAndEmptyHeadersServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NullAndEmptyHeadersServerCommandOutput) => void ): void; - public nullAndEmptyHeadersServer( - args: NullAndEmptyHeadersServerCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: NullAndEmptyHeadersServerCommandOutput) => void), - cb?: (err: any, data?: NullAndEmptyHeadersServerCommandOutput) => void - ): Promise | void { - const command = new NullAndEmptyHeadersServerCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Omits null, but serializes empty string value. + * @see {@link OmitsNullSerializesEmptyStringCommand} */ - public omitsNullSerializesEmptyString( + omitsNullSerializesEmptyString( args: OmitsNullSerializesEmptyStringCommandInput, options?: __HttpHandlerOptions ): Promise; - public omitsNullSerializesEmptyString( + omitsNullSerializesEmptyString( args: OmitsNullSerializesEmptyStringCommandInput, cb: (err: any, data?: OmitsNullSerializesEmptyStringCommandOutput) => void ): void; - public omitsNullSerializesEmptyString( + omitsNullSerializesEmptyString( args: OmitsNullSerializesEmptyStringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: OmitsNullSerializesEmptyStringCommandOutput) => void ): void; - public omitsNullSerializesEmptyString( - args: OmitsNullSerializesEmptyStringCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: OmitsNullSerializesEmptyStringCommandOutput) => void), - cb?: (err: any, data?: OmitsNullSerializesEmptyStringCommandOutput) => void - ): Promise | void { - const command = new OmitsNullSerializesEmptyStringCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Automatically adds idempotency tokens. + * @see {@link QueryIdempotencyTokenAutoFillCommand} */ - public queryIdempotencyTokenAutoFill( + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, options?: __HttpHandlerOptions ): Promise; - public queryIdempotencyTokenAutoFill( + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, cb: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void ): void; - public queryIdempotencyTokenAutoFill( + queryIdempotencyTokenAutoFill( args: QueryIdempotencyTokenAutoFillCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void ): void; - public queryIdempotencyTokenAutoFill( - args: QueryIdempotencyTokenAutoFillCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void), - cb?: (err: any, data?: QueryIdempotencyTokenAutoFillCommandOutput) => void - ): Promise | void { - const command = new QueryIdempotencyTokenAutoFillCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link QueryParamsAsStringListMapCommand} */ - public queryParamsAsStringListMap( + queryParamsAsStringListMap( args: QueryParamsAsStringListMapCommandInput, options?: __HttpHandlerOptions ): Promise; - public queryParamsAsStringListMap( + queryParamsAsStringListMap( args: QueryParamsAsStringListMapCommandInput, cb: (err: any, data?: QueryParamsAsStringListMapCommandOutput) => void ): void; - public queryParamsAsStringListMap( + queryParamsAsStringListMap( args: QueryParamsAsStringListMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryParamsAsStringListMapCommandOutput) => void ): void; - public queryParamsAsStringListMap( - args: QueryParamsAsStringListMapCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryParamsAsStringListMapCommandOutput) => void), - cb?: (err: any, data?: QueryParamsAsStringListMapCommandOutput) => void - ): Promise | void { - const command = new QueryParamsAsStringListMapCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link QueryPrecedenceCommand} */ - public queryPrecedence( + queryPrecedence( args: QueryPrecedenceCommandInput, options?: __HttpHandlerOptions ): Promise; - public queryPrecedence( - args: QueryPrecedenceCommandInput, - cb: (err: any, data?: QueryPrecedenceCommandOutput) => void - ): void; - public queryPrecedence( + queryPrecedence(args: QueryPrecedenceCommandInput, cb: (err: any, data?: QueryPrecedenceCommandOutput) => void): void; + queryPrecedence( args: QueryPrecedenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryPrecedenceCommandOutput) => void ): void; - public queryPrecedence( - args: QueryPrecedenceCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: QueryPrecedenceCommandOutput) => void), - cb?: (err: any, data?: QueryPrecedenceCommandOutput) => void - ): Promise | void { - const command = new QueryPrecedenceCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Recursive shapes + * @see {@link RecursiveShapesCommand} */ - public recursiveShapes( + recursiveShapes( args: RecursiveShapesCommandInput, options?: __HttpHandlerOptions ): Promise; - public recursiveShapes( - args: RecursiveShapesCommandInput, - cb: (err: any, data?: RecursiveShapesCommandOutput) => void - ): void; - public recursiveShapes( + recursiveShapes(args: RecursiveShapesCommandInput, cb: (err: any, data?: RecursiveShapesCommandOutput) => void): void; + recursiveShapes( args: RecursiveShapesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RecursiveShapesCommandOutput) => void ): void; - public recursiveShapes( - args: RecursiveShapesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RecursiveShapesCommandOutput) => void), - cb?: (err: any, data?: RecursiveShapesCommandOutput) => void - ): Promise | void { - const command = new RecursiveShapesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link SimpleScalarPropertiesCommand} */ - public simpleScalarProperties( + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, options?: __HttpHandlerOptions ): Promise; - public simpleScalarProperties( + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, cb: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void ): void; - public simpleScalarProperties( + simpleScalarProperties( args: SimpleScalarPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void ): void; - public simpleScalarProperties( - args: SimpleScalarPropertiesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: SimpleScalarPropertiesCommandOutput) => void), - cb?: (err: any, data?: SimpleScalarPropertiesCommandOutput) => void - ): Promise | void { - const command = new SimpleScalarPropertiesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests how timestamp request and response headers are serialized. + * @see {@link TimestampFormatHeadersCommand} */ - public timestampFormatHeaders( + timestampFormatHeaders( args: TimestampFormatHeadersCommandInput, options?: __HttpHandlerOptions ): Promise; - public timestampFormatHeaders( + timestampFormatHeaders( args: TimestampFormatHeadersCommandInput, cb: (err: any, data?: TimestampFormatHeadersCommandOutput) => void ): void; - public timestampFormatHeaders( + timestampFormatHeaders( args: TimestampFormatHeadersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TimestampFormatHeadersCommandOutput) => void ): void; - public timestampFormatHeaders( - args: TimestampFormatHeadersCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: TimestampFormatHeadersCommandOutput) => void), - cb?: (err: any, data?: TimestampFormatHeadersCommandOutput) => void - ): Promise | void { - const command = new TimestampFormatHeadersCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes an XML attributes on synthesized document. + * @see {@link XmlAttributesCommand} */ - public xmlAttributes( - args: XmlAttributesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlAttributes( - args: XmlAttributesCommandInput, - cb: (err: any, data?: XmlAttributesCommandOutput) => void - ): void; - public xmlAttributes( + xmlAttributes(args: XmlAttributesCommandInput, options?: __HttpHandlerOptions): Promise; + xmlAttributes(args: XmlAttributesCommandInput, cb: (err: any, data?: XmlAttributesCommandOutput) => void): void; + xmlAttributes( args: XmlAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlAttributesCommandOutput) => void ): void; - public xmlAttributes( - args: XmlAttributesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlAttributesCommandOutput) => void), - cb?: (err: any, data?: XmlAttributesCommandOutput) => void - ): Promise | void { - const command = new XmlAttributesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes an XML attributes on a document targeted by httpPayload. + * @see {@link XmlAttributesOnPayloadCommand} */ - public xmlAttributesOnPayload( + xmlAttributesOnPayload( args: XmlAttributesOnPayloadCommandInput, options?: __HttpHandlerOptions ): Promise; - public xmlAttributesOnPayload( + xmlAttributesOnPayload( args: XmlAttributesOnPayloadCommandInput, cb: (err: any, data?: XmlAttributesOnPayloadCommandOutput) => void ): void; - public xmlAttributesOnPayload( + xmlAttributesOnPayload( args: XmlAttributesOnPayloadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlAttributesOnPayloadCommandOutput) => void ): void; - public xmlAttributesOnPayload( - args: XmlAttributesOnPayloadCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlAttributesOnPayloadCommandOutput) => void), - cb?: (err: any, data?: XmlAttributesOnPayloadCommandOutput) => void - ): Promise | void { - const command = new XmlAttributesOnPayloadCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Blobs are base64 encoded + * @see {@link XmlBlobsCommand} */ - public xmlBlobs(args: XmlBlobsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlBlobs(args: XmlBlobsCommandInput, cb: (err: any, data?: XmlBlobsCommandOutput) => void): void; - public xmlBlobs( + xmlBlobs(args: XmlBlobsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlBlobs(args: XmlBlobsCommandInput, cb: (err: any, data?: XmlBlobsCommandOutput) => void): void; + xmlBlobs( args: XmlBlobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlBlobsCommandOutput) => void ): void; - public xmlBlobs( - args: XmlBlobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlBlobsCommandOutput) => void), - cb?: (err: any, data?: XmlBlobsCommandOutput) => void - ): Promise | void { - const command = new XmlBlobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * Blobs are base64 encoded + * @see {@link XmlEmptyBlobsCommand} */ - public xmlEmptyBlobs( - args: XmlEmptyBlobsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlEmptyBlobs( - args: XmlEmptyBlobsCommandInput, - cb: (err: any, data?: XmlEmptyBlobsCommandOutput) => void - ): void; - public xmlEmptyBlobs( + xmlEmptyBlobs(args: XmlEmptyBlobsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlEmptyBlobs(args: XmlEmptyBlobsCommandInput, cb: (err: any, data?: XmlEmptyBlobsCommandOutput) => void): void; + xmlEmptyBlobs( args: XmlEmptyBlobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEmptyBlobsCommandOutput) => void ): void; - public xmlEmptyBlobs( - args: XmlEmptyBlobsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEmptyBlobsCommandOutput) => void), - cb?: (err: any, data?: XmlEmptyBlobsCommandOutput) => void - ): Promise | void { - const command = new XmlEmptyBlobsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlEmptyListsCommand} */ - public xmlEmptyLists( - args: XmlEmptyListsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlEmptyLists( - args: XmlEmptyListsCommandInput, - cb: (err: any, data?: XmlEmptyListsCommandOutput) => void - ): void; - public xmlEmptyLists( + xmlEmptyLists(args: XmlEmptyListsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlEmptyLists(args: XmlEmptyListsCommandInput, cb: (err: any, data?: XmlEmptyListsCommandOutput) => void): void; + xmlEmptyLists( args: XmlEmptyListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEmptyListsCommandOutput) => void ): void; - public xmlEmptyLists( - args: XmlEmptyListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEmptyListsCommandOutput) => void), - cb?: (err: any, data?: XmlEmptyListsCommandOutput) => void - ): Promise | void { - const command = new XmlEmptyListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlEmptyMapsCommand} */ - public xmlEmptyMaps( - args: XmlEmptyMapsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlEmptyMaps(args: XmlEmptyMapsCommandInput, cb: (err: any, data?: XmlEmptyMapsCommandOutput) => void): void; - public xmlEmptyMaps( + xmlEmptyMaps(args: XmlEmptyMapsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlEmptyMaps(args: XmlEmptyMapsCommandInput, cb: (err: any, data?: XmlEmptyMapsCommandOutput) => void): void; + xmlEmptyMaps( args: XmlEmptyMapsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEmptyMapsCommandOutput) => void ): void; - public xmlEmptyMaps( - args: XmlEmptyMapsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEmptyMapsCommandOutput) => void), - cb?: (err: any, data?: XmlEmptyMapsCommandOutput) => void - ): Promise | void { - const command = new XmlEmptyMapsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlEmptyStringsCommand} */ - public xmlEmptyStrings( + xmlEmptyStrings( args: XmlEmptyStringsCommandInput, options?: __HttpHandlerOptions ): Promise; - public xmlEmptyStrings( - args: XmlEmptyStringsCommandInput, - cb: (err: any, data?: XmlEmptyStringsCommandOutput) => void - ): void; - public xmlEmptyStrings( + xmlEmptyStrings(args: XmlEmptyStringsCommandInput, cb: (err: any, data?: XmlEmptyStringsCommandOutput) => void): void; + xmlEmptyStrings( args: XmlEmptyStringsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEmptyStringsCommandOutput) => void ): void; - public xmlEmptyStrings( - args: XmlEmptyStringsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEmptyStringsCommandOutput) => void), - cb?: (err: any, data?: XmlEmptyStringsCommandOutput) => void - ): Promise | void { - const command = new XmlEmptyStringsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes enums as top level properties, in lists, sets, and maps. + * @see {@link XmlEnumsCommand} */ - public xmlEnums(args: XmlEnumsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlEnums(args: XmlEnumsCommandInput, cb: (err: any, data?: XmlEnumsCommandOutput) => void): void; - public xmlEnums( + xmlEnums(args: XmlEnumsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlEnums(args: XmlEnumsCommandInput, cb: (err: any, data?: XmlEnumsCommandOutput) => void): void; + xmlEnums( args: XmlEnumsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlEnumsCommandOutput) => void ): void; - public xmlEnums( - args: XmlEnumsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlEnumsCommandOutput) => void), - cb?: (err: any, data?: XmlEnumsCommandOutput) => void - ): Promise | void { - const command = new XmlEnumsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This example serializes enums as top level properties, in lists, sets, and maps. + * @see {@link XmlIntEnumsCommand} */ - public xmlIntEnums(args: XmlIntEnumsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlIntEnums(args: XmlIntEnumsCommandInput, cb: (err: any, data?: XmlIntEnumsCommandOutput) => void): void; - public xmlIntEnums( + xmlIntEnums(args: XmlIntEnumsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlIntEnums(args: XmlIntEnumsCommandInput, cb: (err: any, data?: XmlIntEnumsCommandOutput) => void): void; + xmlIntEnums( args: XmlIntEnumsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlIntEnumsCommandOutput) => void ): void; - public xmlIntEnums( - args: XmlIntEnumsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlIntEnumsCommandOutput) => void), - cb?: (err: any, data?: XmlIntEnumsCommandOutput) => void - ): Promise | void { - const command = new XmlIntEnumsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This test case serializes XML lists for the following cases for both - * input and output: - * - * 1. Normal XML lists. - * 2. Normal XML sets. - * 3. XML lists of lists. - * 4. XML lists with @xmlName on its members - * 5. Flattened XML lists. - * 6. Flattened XML lists with @xmlName. - * 7. Flattened XML lists with @xmlNamespace. - * 8. Lists of structures. - * 9. Flattened XML list of structures + * @see {@link XmlListsCommand} */ - public xmlLists(args: XmlListsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlLists(args: XmlListsCommandInput, cb: (err: any, data?: XmlListsCommandOutput) => void): void; - public xmlLists( + xmlLists(args: XmlListsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlLists(args: XmlListsCommandInput, cb: (err: any, data?: XmlListsCommandOutput) => void): void; + xmlLists( args: XmlListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlListsCommandOutput) => void ): void; - public xmlLists( - args: XmlListsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlListsCommandOutput) => void), - cb?: (err: any, data?: XmlListsCommandOutput) => void - ): Promise | void { - const command = new XmlListsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * The example tests basic map serialization. + * @see {@link XmlMapsCommand} */ - public xmlMaps(args: XmlMapsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlMaps(args: XmlMapsCommandInput, cb: (err: any, data?: XmlMapsCommandOutput) => void): void; - public xmlMaps( + xmlMaps(args: XmlMapsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlMaps(args: XmlMapsCommandInput, cb: (err: any, data?: XmlMapsCommandOutput) => void): void; + xmlMaps( args: XmlMapsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlMapsCommandOutput) => void ): void; - public xmlMaps( - args: XmlMapsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlMapsCommandOutput) => void), - cb?: (err: any, data?: XmlMapsCommandOutput) => void - ): Promise | void { - const command = new XmlMapsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlMapsXmlNameCommand} */ - public xmlMapsXmlName( + xmlMapsXmlName( args: XmlMapsXmlNameCommandInput, options?: __HttpHandlerOptions ): Promise; - public xmlMapsXmlName( - args: XmlMapsXmlNameCommandInput, - cb: (err: any, data?: XmlMapsXmlNameCommandOutput) => void - ): void; - public xmlMapsXmlName( + xmlMapsXmlName(args: XmlMapsXmlNameCommandInput, cb: (err: any, data?: XmlMapsXmlNameCommandOutput) => void): void; + xmlMapsXmlName( args: XmlMapsXmlNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlMapsXmlNameCommandOutput) => void ): void; - public xmlMapsXmlName( - args: XmlMapsXmlNameCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlMapsXmlNameCommandOutput) => void), - cb?: (err: any, data?: XmlMapsXmlNameCommandOutput) => void - ): Promise | void { - const command = new XmlMapsXmlNameCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlNamespacesCommand} */ - public xmlNamespaces( - args: XmlNamespacesCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlNamespaces( - args: XmlNamespacesCommandInput, - cb: (err: any, data?: XmlNamespacesCommandOutput) => void - ): void; - public xmlNamespaces( + xmlNamespaces(args: XmlNamespacesCommandInput, options?: __HttpHandlerOptions): Promise; + xmlNamespaces(args: XmlNamespacesCommandInput, cb: (err: any, data?: XmlNamespacesCommandOutput) => void): void; + xmlNamespaces( args: XmlNamespacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlNamespacesCommandOutput) => void ): void; - public xmlNamespaces( - args: XmlNamespacesCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlNamespacesCommandOutput) => void), - cb?: (err: any, data?: XmlNamespacesCommandOutput) => void - ): Promise | void { - const command = new XmlNamespacesCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public - * This tests how timestamps are serialized, including using the - * default format of date-time and various @timestampFormat trait - * values. + * @see {@link XmlTimestampsCommand} */ - public xmlTimestamps( - args: XmlTimestampsCommandInput, - options?: __HttpHandlerOptions - ): Promise; - public xmlTimestamps( - args: XmlTimestampsCommandInput, - cb: (err: any, data?: XmlTimestampsCommandOutput) => void - ): void; - public xmlTimestamps( + xmlTimestamps(args: XmlTimestampsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlTimestamps(args: XmlTimestampsCommandInput, cb: (err: any, data?: XmlTimestampsCommandOutput) => void): void; + xmlTimestamps( args: XmlTimestampsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlTimestampsCommandOutput) => void ): void; - public xmlTimestamps( - args: XmlTimestampsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlTimestampsCommandOutput) => void), - cb?: (err: any, data?: XmlTimestampsCommandOutput) => void - ): Promise | void { - const command = new XmlTimestampsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } /** - * @public + * @see {@link XmlUnionsCommand} */ - public xmlUnions(args: XmlUnionsCommandInput, options?: __HttpHandlerOptions): Promise; - public xmlUnions(args: XmlUnionsCommandInput, cb: (err: any, data?: XmlUnionsCommandOutput) => void): void; - public xmlUnions( + xmlUnions(args: XmlUnionsCommandInput, options?: __HttpHandlerOptions): Promise; + xmlUnions(args: XmlUnionsCommandInput, cb: (err: any, data?: XmlUnionsCommandOutput) => void): void; + xmlUnions( args: XmlUnionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: XmlUnionsCommandOutput) => void ): void; - public xmlUnions( - args: XmlUnionsCommandInput, - optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: XmlUnionsCommandOutput) => void), - cb?: (err: any, data?: XmlUnionsCommandOutput) => void - ): Promise | void { - const command = new XmlUnionsCommand(args); - if (typeof optionsOrCb === "function") { - this.send(command, optionsOrCb); - } else if (typeof cb === "function") { - if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); - this.send(command, optionsOrCb || {}, cb); - } else { - return this.send(command, optionsOrCb); - } - } } + +/** + * @public + * A REST XML service that sends XML requests and responses. + */ +export class RestXmlProtocol extends RestXmlProtocolClient implements RestXmlProtocol {} +createAggregatedClient(commands, RestXmlProtocol); diff --git a/scripts/byte-count/get-cjs-byte-count.js b/scripts/byte-count/get-cjs-byte-count.js index 4ed5eeedb533..da207121f810 100644 --- a/scripts/byte-count/get-cjs-byte-count.js +++ b/scripts/byte-count/get-cjs-byte-count.js @@ -1,8 +1,7 @@ #!/usr/bin/env node const { join } = require("path"); -const { readdirSync, statSync, rmSync } = require("fs"); -const { removeSync } = require("fs-extra"); +const { readdirSync, statSync, rmSync, writeFileSync } = require("fs"); const { spawnProcess } = require("../utils/spawn-process"); const walk = require("../utils/walk"); const assert = require("assert"); @@ -23,12 +22,25 @@ locations.clients = join(locations.root, "clients"); for await (const clientFolderName of readdirSync(locations.clients)) { const clientLocation = join(locations.clients, clientFolderName); - removeSync(join(clientLocation, "dist-types")); - removeSync(join(clientLocation, "dist-es")); + const clientPkgJsonLocation = join(clientLocation, "package.json"); + const pkg = require(clientPkgJsonLocation); + + if (packs.length >= 20) { + await Promise.all(packs); + packs.length = 0; + } packs.push( - spawnProcess("npm", ["pack"], { - cwd: clientLocation, + (async () => { + writeFileSync(clientPkgJsonLocation, JSON.stringify({ ...pkg, files: ["dist-cjs"] }, null, 2), "utf-8"); + + await spawnProcess("npm", ["pack"], { + cwd: clientLocation, + }); + + writeFileSync(clientPkgJsonLocation, JSON.stringify(pkg, null, 2), "utf-8"); + })().catch((e) => { + console.error("error in " + clientFolderName, e); }) ); } @@ -45,12 +57,12 @@ locations.clients = join(locations.root, "clients"); } } + for (const packFile of packFiles) { + rmSync(packFile); + } + assert(6_000_000 < bytes, "byte count expected to be more than 6 million"); assert(bytes < 20_000_000, "byte count expected to be less than 20 million"); console.log("all clients dist-cjs total bytes:", bytes); - - for (const packFile of packFiles) { - rmSync(packFile); - } })();